From cd95ade50a81ad364fbca882a8f9921128c2988b Mon Sep 17 00:00:00 2001 From: James Woolfenden Date: Mon, 23 Sep 2024 14:24:53 +0100 Subject: [PATCH] refresh cf --- .github/workflows/codeql-analysis.yml | 6 +- schema/alexa-ask-skill.json | 178 +- schema/aws-accessanalyzer-analyzer.json | 434 +- schema/aws-acmpca-certificate.json | 1056 +- schema/aws-acmpca-certificateauthority.json | 952 +- ...acmpca-certificateauthorityactivation.json | 152 +- schema/aws-acmpca-permission.json | 134 +- schema/aws-amazonmq-broker.json | 664 +- schema/aws-amazonmq-configuration.json | 156 +- ...aws-amazonmq-configurationassociation.json | 94 +- schema/aws-amplify-app.json | 709 +- schema/aws-amplify-branch.json | 518 +- schema/aws-amplify-domain.json | 394 +- schema/aws-amplifyuibuilder-component.json | 1166 +- schema/aws-amplifyuibuilder-form.json | 1194 +- schema/aws-amplifyuibuilder-theme.json | 316 +- schema/aws-apigateway-account.json | 102 +- schema/aws-apigateway-apikey.json | 302 +- schema/aws-apigateway-authorizer.json | 236 +- schema/aws-apigateway-basepathmapping.json | 162 +- schema/aws-apigateway-clientcertificate.json | 186 +- schema/aws-apigateway-deployment.json | 660 +- schema/aws-apigateway-documentationpart.json | 250 +- .../aws-apigateway-documentationversion.json | 154 +- schema/aws-apigateway-domainname.json | 262 +- schema/aws-apigateway-gatewayresponse.json | 202 +- schema/aws-apigateway-method.json | 644 +- schema/aws-apigateway-model.json | 172 +- schema/aws-apigateway-requestvalidator.json | 168 +- schema/aws-apigateway-resource.json | 164 +- schema/aws-apigateway-restapi.json | 476 +- schema/aws-apigateway-stage.json | 532 +- schema/aws-apigateway-usageplan.json | 370 +- schema/aws-apigateway-usageplankey.json | 160 +- schema/aws-apigateway-vpclink.json | 260 +- schema/aws-apigatewayv2-api.json | 458 +- ...igatewayv2-apigatewaymanagedoverrides.json | 272 +- schema/aws-apigatewayv2-apimapping.json | 156 +- schema/aws-apigatewayv2-authorizer.json | 288 +- schema/aws-apigatewayv2-deployment.json | 174 +- schema/aws-apigatewayv2-domainname.json | 276 +- schema/aws-apigatewayv2-integration.json | 312 +- .../aws-apigatewayv2-integrationresponse.json | 180 +- schema/aws-apigatewayv2-model.json | 180 +- schema/aws-apigatewayv2-route.json | 286 +- schema/aws-apigatewayv2-routeresponse.json | 224 +- schema/aws-apigatewayv2-stage.json | 190 +- schema/aws-apigatewayv2-vpclink.json | 220 +- schema/aws-appconfig-application.json | 210 +- .../aws-appconfig-configurationprofile.json | 374 +- schema/aws-appconfig-deployment.json | 196 +- schema/aws-appconfig-deploymentstrategy.json | 136 +- schema/aws-appconfig-environment.json | 346 +- schema/aws-appconfig-extension.json | 418 +- .../aws-appconfig-extensionassociation.json | 268 +- ...-appconfig-hostedconfigurationversion.json | 234 +- schema/aws-appflow-connector.json | 228 +- schema/aws-appflow-connectorprofile.json | 2530 +- schema/aws-appflow-flow.json | 3540 +-- schema/aws-appintegrations-application.json | 375 +- .../aws-appintegrations-dataintegration.json | 564 +- .../aws-appintegrations-eventintegration.json | 336 +- ...applicationautoscaling-scalabletarget.json | 424 +- ...-applicationautoscaling-scalingpolicy.json | 732 +- .../aws-applicationinsights-application.json | 1534 +- ...licationsignals-servicelevelobjective.json | 917 +- schema/aws-appmesh-gatewayroute.json | 878 +- schema/aws-appmesh-mesh.json | 198 +- schema/aws-appmesh-route.json | 1082 +- schema/aws-appmesh-virtualgateway.json | 1074 +- schema/aws-appmesh-virtualnode.json | 1504 +- schema/aws-appmesh-virtualrouter.json | 236 +- schema/aws-appmesh-virtualservice.json | 240 +- ...ws-apprunner-autoscalingconfiguration.json | 226 +- ...-apprunner-observabilityconfiguration.json | 240 +- schema/aws-apprunner-service.json | 1098 +- schema/aws-apprunner-vpcconnector.json | 238 +- .../aws-apprunner-vpcingressconnection.json | 302 +- schema/aws-appstream-appblock.json | 360 +- schema/aws-appstream-appblockbuilder.json | 394 +- schema/aws-appstream-application.json | 386 +- ...eam-applicationentitlementassociation.json | 110 +- ...appstream-applicationfleetassociation.json | 106 +- schema/aws-appstream-directoryconfig.json | 254 +- schema/aws-appstream-entitlement.json | 190 +- schema/aws-appstream-fleet.json | 352 +- schema/aws-appstream-imagebuilder.json | 396 +- schema/aws-appstream-stack.json | 368 +- .../aws-appstream-stackfleetassociation.json | 52 +- .../aws-appstream-stackuserassociation.json | 78 +- schema/aws-appstream-user.json | 84 +- schema/aws-appsync-apicache.json | 92 +- schema/aws-appsync-apikey.json | 78 +- schema/aws-appsync-datasource.json | 508 +- schema/aws-appsync-domainname.json | 164 +- .../aws-appsync-domainnameapiassociation.json | 126 +- schema/aws-appsync-functionconfiguration.json | 380 +- schema/aws-appsync-graphqlapi.json | 500 +- schema/aws-appsync-graphqlschema.json | 62 +- schema/aws-appsync-resolver.json | 490 +- schema/aws-appsync-sourceapiassociation.json | 342 +- schema/aws-apptest-testcase.json | 1426 +- schema/aws-aps-rulegroupsnamespace.json | 260 +- schema/aws-aps-scraper.json | 508 +- schema/aws-aps-workspace.json | 352 +- ...t-autoshiftobservernotificationstatus.json | 152 +- ...onalshift-zonalautoshiftconfiguration.json | 340 +- schema/aws-athena-capacityreservation.json | 412 +- schema/aws-athena-datacatalog.json | 234 +- schema/aws-athena-namedquery.json | 164 +- schema/aws-athena-preparedstatement.json | 170 +- schema/aws-athena-workgroup.json | 824 +- schema/aws-auditmanager-assessment.json | 742 +- schema/aws-autoscaling-autoscalinggroup.json | 1650 +- .../aws-autoscaling-launchconfiguration.json | 510 +- schema/aws-autoscaling-lifecyclehook.json | 184 +- schema/aws-autoscaling-scalingpolicy.json | 976 +- schema/aws-autoscaling-scheduledaction.json | 178 +- schema/aws-autoscaling-warmpool.json | 140 +- schema/aws-autoscalingplans-scalingplan.json | 542 +- schema/aws-b2bi-capability.json | 656 +- schema/aws-b2bi-partnership.json | 306 +- schema/aws-b2bi-profile.json | 322 +- schema/aws-b2bi-transformer.json | 556 +- schema/aws-backup-backupplan.json | 418 +- schema/aws-backup-backupselection.json | 358 +- schema/aws-backup-backupvault.json | 312 +- schema/aws-backup-framework.json | 406 +- schema/aws-backup-reportplan.json | 378 +- schema/aws-backup-restoretestingplan.json | 354 +- .../aws-backup-restoretestingselection.json | 284 +- schema/aws-backupgateway-hypervisor.json | 324 +- schema/aws-batch-computeenvironment.json | 597 +- schema/aws-batch-jobdefinition.json | 1944 +- schema/aws-batch-jobqueue.json | 330 +- schema/aws-batch-schedulingpolicy.json | 250 +- schema/aws-bcmdataexports-export.json | 592 +- schema/aws-bedrock-agent.json | 1364 +- schema/aws-bedrock-agentalias.json | 434 +- schema/aws-bedrock-datasource.json | 1237 +- schema/aws-bedrock-flow.json | 2026 +- schema/aws-bedrock-flowalias.json | 344 +- schema/aws-bedrock-flowversion.json | 1765 +- schema/aws-bedrock-guardrail.json | 1276 +- schema/aws-bedrock-guardrailversion.json | 164 +- schema/aws-bedrock-knowledgebase.json | 1244 +- schema/aws-bedrock-prompt.json | 692 +- schema/aws-bedrock-promptversion.json | 615 +- schema/aws-billingconductor-billinggroup.json | 398 +- .../aws-billingconductor-customlineitem.json | 596 +- schema/aws-billingconductor-pricingplan.json | 278 +- schema/aws-billingconductor-pricingrule.json | 420 +- schema/aws-budgets-budget.json | 492 +- schema/aws-budgets-budgetsaction.json | 560 +- schema/aws-cassandra-keyspace.json | 312 +- schema/aws-cassandra-table.json | 850 +- schema/aws-ce-anomalymonitor.json | 306 +- schema/aws-ce-anomalysubscription.json | 350 +- schema/aws-ce-costcategory.json | 184 +- schema/aws-certificatemanager-account.json | 126 +- .../aws-certificatemanager-certificate.json | 198 +- ...ot-microsoftteamschannelconfiguration.json | 324 +- ...aws-chatbot-slackchannelconfiguration.json | 304 +- schema/aws-cleanrooms-analysistemplate.json | 539 +- schema/aws-cleanrooms-collaboration.json | 542 +- schema/aws-cleanrooms-configuredtable.json | 1193 +- ...cleanrooms-configuredtableassociation.json | 475 +- schema/aws-cleanrooms-idmappingtable.json | 241 + ...aws-cleanrooms-idnamespaceassociation.json | 238 + schema/aws-cleanrooms-membership.json | 523 +- .../aws-cleanrooms-privacybudgettemplate.json | 367 +- schema/aws-cleanroomsml-trainingdataset.json | 518 +- schema/aws-cloud9-environmentec2.json | 210 +- schema/aws-cloudformation-customresource.json | 50 +- ...aws-cloudformation-hookdefaultversion.json | 170 +- schema/aws-cloudformation-hooktypeconfig.json | 208 +- schema/aws-cloudformation-hookversion.json | 290 +- schema/aws-cloudformation-macro.json | 76 +- ...s-cloudformation-moduledefaultversion.json | 148 +- schema/aws-cloudformation-moduleversion.json | 212 +- .../aws-cloudformation-publictypeversion.json | 224 +- schema/aws-cloudformation-publisher.json | 178 +- ...cloudformation-resourcedefaultversion.json | 158 +- .../aws-cloudformation-resourceversion.json | 276 +- schema/aws-cloudformation-stack.json | 486 +- schema/aws-cloudformation-stackset.json | 860 +- schema/aws-cloudformation-typeactivation.json | 314 +- schema/aws-cloudformation-waitcondition.json | 58 +- ...ws-cloudformation-waitconditionhandle.json | 32 +- schema/aws-cloudfront-cachepolicy.json | 374 +- ...dfront-cloudfrontoriginaccessidentity.json | 150 +- ...cloudfront-continuousdeploymentpolicy.json | 440 +- schema/aws-cloudfront-distribution.json | 2056 +- schema/aws-cloudfront-function.json | 258 +- schema/aws-cloudfront-keygroup.json | 172 +- schema/aws-cloudfront-keyvaluestore.json | 198 +- ...aws-cloudfront-monitoringsubscription.json | 146 +- .../aws-cloudfront-originaccesscontrol.json | 178 +- .../aws-cloudfront-originrequestpolicy.json | 300 +- schema/aws-cloudfront-publickey.json | 172 +- schema/aws-cloudfront-realtimelogconfig.json | 242 +- .../aws-cloudfront-responseheaderspolicy.json | 812 +- .../aws-cloudfront-streamingdistribution.json | 288 +- schema/aws-cloudtrail-channel.json | 330 +- schema/aws-cloudtrail-eventdatastore.json | 676 +- schema/aws-cloudtrail-resourcepolicy.json | 112 +- schema/aws-cloudtrail-trail.json | 796 +- schema/aws-cloudwatch-alarm.json | 630 +- schema/aws-cloudwatch-anomalydetector.json | 452 +- schema/aws-cloudwatch-compositealarm.json | 356 +- schema/aws-cloudwatch-dashboard.json | 120 +- schema/aws-cloudwatch-insightrule.json | 92 +- schema/aws-cloudwatch-metricstream.json | 564 +- schema/aws-codeartifact-domain.json | 280 +- schema/aws-codeartifact-packagegroup.json | 432 +- schema/aws-codeartifact-repository.json | 337 +- schema/aws-codebuild-fleet.json | 314 +- schema/aws-codebuild-project.json | 1098 +- schema/aws-codebuild-reportgroup.json | 214 +- schema/aws-codebuild-sourcecredential.json | 72 +- schema/aws-codecommit-repository.json | 294 +- schema/aws-codeconnections-connection.json | 262 +- schema/aws-codedeploy-application.json | 176 +- schema/aws-codedeploy-deploymentconfig.json | 338 +- schema/aws-codedeploy-deploymentgroup.json | 996 +- .../aws-codeguruprofiler-profilinggroup.json | 354 +- ...odegurureviewer-repositoryassociation.json | 298 +- schema/aws-codepipeline-customactiontype.json | 442 +- schema/aws-codepipeline-pipeline.json | 1398 +- schema/aws-codepipeline-webhook.json | 176 +- schema/aws-codestar-githubrepository.json | 154 +- .../aws-codestarconnections-connection.json | 262 +- ...ws-codestarconnections-repositorylink.json | 313 +- ...codestarconnections-syncconfiguration.json | 258 +- ...odestarnotifications-notificationrule.json | 288 +- schema/aws-cognito-identitypool.json | 380 +- .../aws-cognito-identitypoolprincipaltag.json | 164 +- ...ws-cognito-identitypoolroleattachment.json | 318 +- .../aws-cognito-logdeliveryconfiguration.json | 283 +- schema/aws-cognito-userpool.json | 1054 +- schema/aws-cognito-userpoolclient.json | 448 +- schema/aws-cognito-userpooldomain.json | 96 +- schema/aws-cognito-userpoolgroup.json | 178 +- .../aws-cognito-userpoolidentityprovider.json | 96 +- .../aws-cognito-userpoolresourceserver.json | 202 +- ...o-userpoolriskconfigurationattachment.json | 430 +- ...ito-userpooluicustomizationattachment.json | 124 +- schema/aws-cognito-userpooluser.json | 254 +- ...cognito-userpoolusertogroupattachment.json | 118 +- schema/aws-comprehend-documentclassifier.json | 730 +- schema/aws-comprehend-flywheel.json | 570 +- .../aws-config-aggregationauthorization.json | 233 +- schema/aws-config-configrule.json | 460 +- .../aws-config-configurationaggregator.json | 341 +- schema/aws-config-configurationrecorder.json | 262 +- schema/aws-config-conformancepack.json | 316 +- schema/aws-config-deliverychannel.json | 102 +- schema/aws-config-organizationconfigrule.json | 360 +- ...ws-config-organizationconformancepack.json | 320 +- .../aws-config-remediationconfiguration.json | 154 +- schema/aws-config-storedquery.json | 254 +- schema/aws-connect-agentstatus.json | 160 + schema/aws-connect-approvedorigin.json | 146 +- schema/aws-connect-contactflow.json | 322 +- schema/aws-connect-contactflowmodule.json | 294 +- schema/aws-connect-evaluationform.json | 1090 +- schema/aws-connect-hoursofoperation.json | 390 +- schema/aws-connect-instance.json | 476 +- schema/aws-connect-instancestorageconfig.json | 524 +- .../aws-connect-integrationassociation.json | 318 +- schema/aws-connect-phonenumber.json | 312 +- schema/aws-connect-predefinedattribute.json | 226 +- schema/aws-connect-prompt.json | 268 +- schema/aws-connect-queue.json | 443 +- schema/aws-connect-quickconnect.json | 474 +- schema/aws-connect-routingprofile.json | 552 +- schema/aws-connect-rule.json | 1088 +- schema/aws-connect-securitykey.json | 170 +- schema/aws-connect-securityprofile.json | 488 +- schema/aws-connect-tasktemplate.json | 674 +- .../aws-connect-trafficdistributiongroup.json | 280 +- schema/aws-connect-user.json | 620 +- schema/aws-connect-userhierarchygroup.json | 256 +- .../aws-connect-userhierarchystructure.json | 190 + schema/aws-connect-view.json | 324 +- schema/aws-connect-viewversion.json | 198 +- schema/aws-connectcampaigns-campaign.json | 542 +- schema/aws-controltower-enabledbaseline.json | 474 +- schema/aws-controltower-enabledcontrol.json | 422 +- schema/aws-controltower-landingzone.json | 410 +- schema/aws-cur-reportdefinition.json | 364 +- ...rofiles-calculatedattributedefinition.json | 649 +- schema/aws-customerprofiles-domain.json | 931 +- schema/aws-customerprofiles-eventstream.json | 371 +- schema/aws-customerprofiles-integration.json | 1409 +- schema/aws-customerprofiles-objecttype.json | 559 +- schema/aws-databrew-dataset.json | 934 +- schema/aws-databrew-job.json | 1264 +- schema/aws-databrew-project.json | 274 +- schema/aws-databrew-recipe.json | 1178 +- schema/aws-databrew-ruleset.json | 501 +- schema/aws-databrew-schedule.json | 222 +- schema/aws-datapipeline-pipeline.json | 510 +- schema/aws-datasync-agent.json | 322 +- schema/aws-datasync-locationazureblob.json | 376 +- schema/aws-datasync-locationefs.json | 380 +- schema/aws-datasync-locationfsxlustre.json | 292 +- schema/aws-datasync-locationfsxontap.json | 502 +- schema/aws-datasync-locationfsxopenzfs.json | 382 +- schema/aws-datasync-locationfsxwindows.json | 332 +- schema/aws-datasync-locationhdfs.json | 500 +- schema/aws-datasync-locationnfs.json | 352 +- .../aws-datasync-locationobjectstorage.json | 366 +- schema/aws-datasync-locations3.json | 334 +- schema/aws-datasync-locationsmb.json | 368 +- schema/aws-datasync-storagesystem.json | 428 +- schema/aws-datasync-task.json | 1212 +- schema/aws-datazone-datasource.json | 1086 +- schema/aws-datazone-domain.json | 424 +- schema/aws-datazone-environment.json | 495 +- schema/aws-datazone-environmentactions.json | 156 + ...one-environmentblueprintconfiguration.json | 318 +- schema/aws-datazone-environmentprofile.json | 372 +- schema/aws-datazone-groupprofile.json | 258 +- schema/aws-datazone-project.json | 266 +- schema/aws-datazone-projectmembership.json | 276 +- schema/aws-datazone-subscriptiontarget.json | 424 +- schema/aws-datazone-userprofile.json | 454 +- schema/aws-dax-cluster.json | 204 +- schema/aws-dax-parametergroup.json | 56 +- schema/aws-dax-subnetgroup.json | 70 +- schema/aws-deadline-farm.json | 294 +- schema/aws-deadline-fleet.json | 1184 +- schema/aws-deadline-licenseendpoint.json | 330 +- schema/aws-deadline-meteredproduct.json | 178 +- schema/aws-deadline-monitor.json | 208 +- schema/aws-deadline-queue.json | 569 +- schema/aws-deadline-queueenvironment.json | 236 +- .../aws-deadline-queuefleetassociation.json | 160 +- schema/aws-deadline-storageprofile.json | 279 +- schema/aws-detective-graph.json | 178 +- schema/aws-detective-memberinvitation.json | 156 +- schema/aws-detective-organizationadmin.json | 140 +- ...psguru-loganomalydetectionintegration.json | 124 +- .../aws-devopsguru-notificationchannel.json | 276 +- schema/aws-devopsguru-resourcecollection.json | 258 +- schema/aws-directoryservice-microsoftad.json | 168 +- schema/aws-directoryservice-simplead.json | 330 +- schema/aws-dlm-lifecyclepolicy.json | 1154 +- schema/aws-dms-certificate.json | 60 +- schema/aws-dms-dataprovider.json | 636 +- schema/aws-dms-endpoint.json | 1896 +- schema/aws-dms-eventsubscription.json | 148 +- schema/aws-dms-instanceprofile.json | 343 +- schema/aws-dms-migrationproject.json | 426 +- schema/aws-dms-replicationconfig.json | 414 +- schema/aws-dms-replicationinstance.json | 208 +- schema/aws-dms-replicationsubnetgroup.json | 122 +- schema/aws-dms-replicationtask.json | 180 +- schema/aws-docdb-dbcluster.json | 288 +- schema/aws-docdb-dbclusterparametergroup.json | 126 +- schema/aws-docdb-dbinstance.json | 170 +- schema/aws-docdb-dbsubnetgroup.json | 122 +- schema/aws-docdb-eventsubscription.json | 98 +- schema/aws-docdbelastic-cluster.json | 420 +- schema/aws-dynamodb-globaltable.json | 1358 +- schema/aws-dynamodb-table.json | 1356 +- schema/aws-ec2-capacityreservation.json | 317 +- schema/aws-ec2-capacityreservationfleet.json | 382 +- schema/aws-ec2-carriergateway.json | 204 +- .../aws-ec2-clientvpnauthorizationrule.json | 84 +- schema/aws-ec2-clientvpnendpoint.json | 476 +- schema/aws-ec2-clientvpnroute.json | 78 +- ...ec2-clientvpntargetnetworkassociation.json | 60 +- schema/aws-ec2-customergateway.json | 259 +- schema/aws-ec2-dhcpoptions.json | 268 +- schema/aws-ec2-ec2fleet.json | 1426 +- schema/aws-ec2-egressonlyinternetgateway.json | 118 +- schema/aws-ec2-eip.json | 260 +- schema/aws-ec2-eipassociation.json | 152 +- ...-enclavecertificateiamroleassociation.json | 146 +- schema/aws-ec2-flowlog.json | 372 +- .../aws-ec2-gatewayroutetableassociation.json | 128 +- schema/aws-ec2-host.json | 180 +- schema/aws-ec2-instance.json | 1642 +- schema/aws-ec2-instanceconnectendpoint.json | 248 +- schema/aws-ec2-internetgateway.json | 184 +- schema/aws-ec2-ipam.json | 334 +- schema/aws-ec2-ipamallocation.json | 182 +- schema/aws-ec2-ipampool.json | 564 +- schema/aws-ec2-ipampoolcidr.json | 168 +- schema/aws-ec2-ipamresourcediscovery.json | 292 +- ...-ec2-ipamresourcediscoveryassociation.json | 286 +- schema/aws-ec2-ipamscope.json | 270 +- schema/aws-ec2-keypair.json | 274 +- schema/aws-ec2-launchtemplate.json | 2296 +- schema/aws-ec2-localgatewayroute.json | 194 +- schema/aws-ec2-localgatewayroutetable.json | 255 +- ...tablevirtualinterfacegroupassociation.json | 252 +- ...-localgatewayroutetablevpcassociation.json | 235 +- schema/aws-ec2-natgateway.json | 288 +- schema/aws-ec2-networkacl.json | 198 +- schema/aws-ec2-networkaclentry.json | 227 +- .../aws-ec2-networkinsightsaccessscope.json | 472 +- ...c2-networkinsightsaccessscopeanalysis.json | 262 +- schema/aws-ec2-networkinsightsanalysis.json | 1412 +- schema/aws-ec2-networkinsightspath.json | 362 +- schema/aws-ec2-networkinterface.json | 556 +- .../aws-ec2-networkinterfaceattachment.json | 234 +- .../aws-ec2-networkinterfacepermission.json | 70 +- ...-networkperformancemetricsubscription.json | 140 +- schema/aws-ec2-placementgroup.json | 204 +- schema/aws-ec2-prefixlist.json | 307 +- schema/aws-ec2-route.json | 266 +- schema/aws-ec2-routetable.json | 194 +- schema/aws-ec2-securitygroup.json | 445 +- schema/aws-ec2-securitygroupegress.json | 218 +- schema/aws-ec2-securitygroupingress.json | 246 +- schema/aws-ec2-snapshotblockpublicaccess.json | 124 +- schema/aws-ec2-spotfleet.json | 1958 +- schema/aws-ec2-subnet.json | 415 +- schema/aws-ec2-subnetcidrblock.json | 178 +- .../aws-ec2-subnetnetworkaclassociation.json | 128 +- .../aws-ec2-subnetroutetableassociation.json | 136 +- schema/aws-ec2-trafficmirrorfilter.json | 108 +- schema/aws-ec2-trafficmirrorfilterrule.json | 196 +- schema/aws-ec2-trafficmirrorsession.json | 142 +- schema/aws-ec2-trafficmirrortarget.json | 118 +- schema/aws-ec2-transitgateway.json | 308 +- schema/aws-ec2-transitgatewayattachment.json | 322 +- schema/aws-ec2-transitgatewayconnect.json | 237 +- ...aws-ec2-transitgatewaymulticastdomain.json | 245 +- ...nsitgatewaymulticastdomainassociation.json | 158 +- ...c2-transitgatewaymulticastgroupmember.json | 213 +- ...c2-transitgatewaymulticastgroupsource.json | 213 +- ...s-ec2-transitgatewaypeeringattachment.json | 267 +- schema/aws-ec2-transitgatewayroute.json | 160 +- schema/aws-ec2-transitgatewayroutetable.json | 182 +- ...2-transitgatewayroutetableassociation.json | 140 +- ...2-transitgatewayroutetablepropagation.json | 138 +- .../aws-ec2-transitgatewayvpcattachment.json | 356 +- schema/aws-ec2-verifiedaccessendpoint.json | 846 +- schema/aws-ec2-verifiedaccessgroup.json | 370 +- schema/aws-ec2-verifiedaccessinstance.json | 586 +- .../aws-ec2-verifiedaccesstrustprovider.json | 472 +- schema/aws-ec2-volume.json | 300 +- schema/aws-ec2-volumeattachment.json | 162 +- schema/aws-ec2-vpc.json | 322 +- schema/aws-ec2-vpccidrblock.json | 236 +- schema/aws-ec2-vpcdhcpoptionsassociation.json | 124 +- schema/aws-ec2-vpcendpoint.json | 318 +- ...ec2-vpcendpointconnectionnotification.json | 162 +- schema/aws-ec2-vpcendpointservice.json | 184 +- ...aws-ec2-vpcendpointservicepermissions.json | 148 +- schema/aws-ec2-vpcgatewayattachment.json | 168 +- schema/aws-ec2-vpcpeeringconnection.json | 246 +- schema/aws-ec2-vpnconnection.json | 325 +- schema/aws-ec2-vpnconnectionroute.json | 110 +- schema/aws-ec2-vpngateway.json | 211 +- .../aws-ec2-vpngatewayroutepropagation.json | 90 +- schema/aws-ecr-publicrepository.json | 364 +- schema/aws-ecr-pullthroughcacherule.json | 276 +- schema/aws-ecr-registrypolicy.json | 132 +- schema/aws-ecr-replicationconfiguration.json | 330 +- schema/aws-ecr-repository.json | 485 +- .../aws-ecr-repositorycreationtemplate.json | 386 +- schema/aws-ecs-capacityprovider.json | 282 +- schema/aws-ecs-cluster.json | 521 +- ...s-clustercapacityproviderassociations.json | 256 +- schema/aws-ecs-primarytaskset.json | 118 +- schema/aws-ecs-service.json | 1479 +- schema/aws-ecs-taskdefinition.json | 2295 +- schema/aws-ecs-taskset.json | 484 +- schema/aws-efs-accesspoint.json | 390 +- schema/aws-efs-filesystem.json | 578 +- schema/aws-efs-mounttarget.json | 190 +- schema/aws-eks-accessentry.json | 402 +- schema/aws-eks-addon.json | 392 +- schema/aws-eks-cluster.json | 956 +- schema/aws-eks-fargateprofile.json | 376 +- schema/aws-eks-identityproviderconfig.json | 398 +- schema/aws-eks-nodegroup.json | 626 +- schema/aws-eks-podidentityassociation.json | 286 +- schema/aws-elasticache-cachecluster.json | 446 +- ...ws-elasticache-globalreplicationgroup.json | 358 +- schema/aws-elasticache-parametergroup.json | 228 +- schema/aws-elasticache-replicationgroup.json | 662 +- schema/aws-elasticache-securitygroup.json | 94 +- .../aws-elasticache-securitygroupingress.json | 58 +- schema/aws-elasticache-serverlesscache.json | 554 +- schema/aws-elasticache-subnetgroup.json | 208 +- schema/aws-elasticache-user.json | 362 +- schema/aws-elasticache-usergroup.json | 272 +- schema/aws-elasticbeanstalk-application.json | 252 +- ...s-elasticbeanstalk-applicationversion.json | 188 +- ...lasticbeanstalk-configurationtemplate.json | 292 +- schema/aws-elasticbeanstalk-environment.json | 420 +- ...aws-elasticloadbalancing-loadbalancer.json | 642 +- .../aws-elasticloadbalancingv2-listener.json | 974 +- ...icloadbalancingv2-listenercertificate.json | 88 +- ...s-elasticloadbalancingv2-listenerrule.json | 1106 +- ...s-elasticloadbalancingv2-loadbalancer.json | 439 +- ...ws-elasticloadbalancingv2-targetgroup.json | 514 +- ...aws-elasticloadbalancingv2-truststore.json | 297 +- ...cloadbalancingv2-truststorerevocation.json | 286 +- schema/aws-elasticsearch-domain.json | 634 +- schema/aws-emr-cluster.json | 1718 +- schema/aws-emr-instancefleetconfig.json | 422 +- schema/aws-emr-instancegroupconfig.json | 624 +- schema/aws-emr-securityconfiguration.json | 108 +- schema/aws-emr-step.json | 204 +- schema/aws-emr-studio.json | 472 +- schema/aws-emr-studiosessionmapping.json | 228 +- schema/aws-emr-walworkspace.json | 186 +- schema/aws-emrcontainers-virtualcluster.json | 314 +- schema/aws-emrserverless-application.json | 1354 +- ...ws-entityresolution-idmappingworkflow.json | 718 +- schema/aws-entityresolution-idnamespace.json | 612 +- ...aws-entityresolution-matchingworkflow.json | 788 +- .../aws-entityresolution-policystatement.json | 266 +- .../aws-entityresolution-schemamapping.json | 450 +- schema/aws-events-apidestination.json | 184 +- schema/aws-events-archive.json | 140 +- schema/aws-events-connection.json | 504 +- schema/aws-events-endpoint.json | 476 +- schema/aws-events-eventbus.json | 287 +- schema/aws-events-eventbuspolicy.json | 116 +- schema/aws-events-rule.json | 1178 +- schema/aws-eventschemas-discoverer.json | 246 +- schema/aws-eventschemas-registry.json | 190 +- schema/aws-eventschemas-registrypolicy.json | 116 +- schema/aws-eventschemas-schema.json | 282 +- schema/aws-evidently-experiment.json | 628 +- schema/aws-evidently-feature.json | 426 +- schema/aws-evidently-launch.json | 630 +- schema/aws-evidently-project.json | 444 +- schema/aws-evidently-segment.json | 218 +- schema/aws-finspace-environment.json | 568 +- schema/aws-fis-experimenttemplate.json | 821 +- .../aws-fis-targetaccountconfiguration.json | 194 +- schema/aws-fms-notificationchannel.json | 118 +- schema/aws-fms-policy.json | 1006 +- schema/aws-fms-resourceset.json | 294 +- schema/aws-forecast-dataset.json | 366 +- schema/aws-forecast-datasetgroup.json | 270 +- schema/aws-frauddetector-detector.json | 1224 +- schema/aws-frauddetector-entitytype.json | 232 +- schema/aws-frauddetector-eventtype.json | 730 +- schema/aws-frauddetector-label.json | 232 +- schema/aws-frauddetector-list.json | 310 +- schema/aws-frauddetector-outcome.json | 232 +- schema/aws-frauddetector-variable.json | 356 +- schema/aws-fsx-datarepositoryassociation.json | 428 +- schema/aws-fsx-filesystem.json | 918 +- schema/aws-fsx-snapshot.json | 116 +- schema/aws-fsx-storagevirtualmachine.json | 226 +- schema/aws-fsx-volume.json | 700 +- schema/aws-gamelift-alias.json | 214 +- schema/aws-gamelift-build.json | 240 +- ...aws-gamelift-containergroupdefinition.json | 909 +- schema/aws-gamelift-fleet.json | 1332 +- schema/aws-gamelift-gameservergroup.json | 890 +- schema/aws-gamelift-gamesessionqueue.json | 494 +- schema/aws-gamelift-location.json | 210 +- ...aws-gamelift-matchmakingconfiguration.json | 460 +- schema/aws-gamelift-matchmakingruleset.json | 244 +- schema/aws-gamelift-script.json | 336 +- schema/aws-globalaccelerator-accelerator.json | 316 +- ...balaccelerator-crossaccountattachment.json | 264 +- .../aws-globalaccelerator-endpointgroup.json | 368 +- schema/aws-globalaccelerator-listener.json | 230 +- schema/aws-glue-classifier.json | 254 +- schema/aws-glue-connection.json | 162 +- schema/aws-glue-crawler.json | 632 +- schema/aws-glue-customentitytype.json | 64 +- schema/aws-glue-database.json | 308 +- ...ws-glue-datacatalogencryptionsettings.json | 140 +- schema/aws-glue-dataqualityruleset.json | 96 +- schema/aws-glue-devendpoint.json | 150 +- schema/aws-glue-job.json | 277 +- schema/aws-glue-mltransform.json | 326 +- schema/aws-glue-partition.json | 442 +- schema/aws-glue-registry.json | 210 +- schema/aws-glue-schema.json | 380 +- schema/aws-glue-schemaversion.json | 194 +- schema/aws-glue-schemaversionmetadata.json | 144 +- schema/aws-glue-securityconfiguration.json | 148 +- schema/aws-glue-table.json | 568 +- schema/aws-glue-tableoptimizer.json | 124 +- schema/aws-glue-trigger.json | 430 +- schema/aws-glue-workflow.json | 68 +- schema/aws-grafana-workspace.json | 990 +- .../aws-greengrass-connectordefinition.json | 152 +- ...greengrass-connectordefinitionversion.json | 110 +- schema/aws-greengrass-coredefinition.json | 160 +- .../aws-greengrass-coredefinitionversion.json | 118 +- schema/aws-greengrass-devicedefinition.json | 160 +- ...ws-greengrass-devicedefinitionversion.json | 118 +- schema/aws-greengrass-functiondefinition.json | 360 +- ...-greengrass-functiondefinitionversion.json | 320 +- schema/aws-greengrass-group.json | 150 +- schema/aws-greengrass-groupversion.json | 106 +- schema/aws-greengrass-loggerdefinition.json | 168 +- ...ws-greengrass-loggerdefinitionversion.json | 126 +- schema/aws-greengrass-resourcedefinition.json | 440 +- ...-greengrass-resourcedefinitionversion.json | 398 +- ...aws-greengrass-subscriptiondefinition.json | 162 +- ...engrass-subscriptiondefinitionversion.json | 120 +- schema/aws-greengrassv2-componentversion.json | 682 +- schema/aws-greengrassv2-deployment.json | 786 +- schema/aws-groundstation-config.json | 684 +- ...s-groundstation-dataflowendpointgroup.json | 546 +- schema/aws-groundstation-missionprofile.json | 354 +- schema/aws-guardduty-detector.json | 434 +- schema/aws-guardduty-filter.json | 392 +- schema/aws-guardduty-ipset.json | 256 +- .../aws-guardduty-malwareprotectionplan.json | 366 +- schema/aws-guardduty-master.json | 146 +- schema/aws-guardduty-member.json | 178 +- schema/aws-guardduty-threatintelset.json | 256 +- schema/aws-healthimaging-datastore.json | 310 +- schema/aws-healthlake-fhirdatastore.json | 590 +- schema/aws-iam-accesskey.json | 72 +- schema/aws-iam-group.json | 246 +- schema/aws-iam-grouppolicy.json | 126 +- schema/aws-iam-instanceprofile.json | 154 +- schema/aws-iam-managedpolicy.json | 325 +- schema/aws-iam-oidcprovider.json | 244 +- schema/aws-iam-policy.json | 194 +- schema/aws-iam-role.json | 378 +- schema/aws-iam-rolepolicy.json | 126 +- schema/aws-iam-samlprovider.json | 218 +- schema/aws-iam-servercertificate.json | 264 +- schema/aws-iam-servicelinkedrole.json | 140 +- schema/aws-iam-user.json | 420 +- schema/aws-iam-userpolicy.json | 126 +- schema/aws-iam-usertogroupaddition.json | 60 +- schema/aws-iam-virtualmfadevice.json | 218 +- schema/aws-identitystore-group.json | 192 +- schema/aws-identitystore-groupmembership.json | 228 +- schema/aws-imagebuilder-component.json | 344 +- schema/aws-imagebuilder-containerrecipe.json | 686 +- ...magebuilder-distributionconfiguration.json | 680 +- schema/aws-imagebuilder-image.json | 526 +- schema/aws-imagebuilder-imagepipeline.json | 554 +- schema/aws-imagebuilder-imagerecipe.json | 524 +- ...gebuilder-infrastructureconfiguration.json | 408 +- schema/aws-imagebuilder-lifecyclepolicy.json | 686 +- schema/aws-imagebuilder-workflow.json | 296 +- schema/aws-inspector-assessmenttarget.json | 112 +- schema/aws-inspector-assessmenttemplate.json | 188 +- schema/aws-inspector-resourcegroup.json | 130 +- .../aws-inspectorv2-cisscanconfiguration.json | 484 +- schema/aws-inspectorv2-filter.json | 744 +- schema/aws-internetmonitor-monitor.json | 586 +- schema/aws-iot-accountauditconfiguration.json | 342 +- schema/aws-iot-authorizer.json | 258 +- schema/aws-iot-billinggroup.json | 240 +- schema/aws-iot-cacertificate.json | 360 +- schema/aws-iot-certificate.json | 208 +- schema/aws-iot-certificateprovider.json | 260 +- schema/aws-iot-custommetric.json | 234 +- schema/aws-iot-dimension.json | 242 +- schema/aws-iot-domainconfiguration.json | 450 +- schema/aws-iot-fleetmetric.json | 346 +- schema/aws-iot-jobtemplate.json | 806 +- schema/aws-iot-logging.json | 156 +- schema/aws-iot-mitigationaction.json | 518 +- schema/aws-iot-policy.json | 222 +- schema/aws-iot-policyprincipalattachment.json | 60 +- schema/aws-iot-provisioningtemplate.json | 284 +- schema/aws-iot-resourcespecificlogging.json | 184 +- schema/aws-iot-rolealias.json | 256 +- schema/aws-iot-scheduledaudit.json | 282 +- schema/aws-iot-securityprofile.json | 854 +- schema/aws-iot-softwarepackage.json | 236 +- schema/aws-iot-softwarepackageversion.json | 308 +- schema/aws-iot-thing.json | 170 +- schema/aws-iot-thinggroup.json | 306 +- schema/aws-iot-thingprincipalattachment.json | 60 +- schema/aws-iot-thingtype.json | 276 +- schema/aws-iot-topicrule.json | 2010 +- schema/aws-iot-topicruledestination.json | 246 +- schema/aws-iot1click-device.json | 60 +- schema/aws-iot1click-placement.json | 72 +- schema/aws-iot1click-project.json | 98 +- schema/aws-iotanalytics-channel.json | 302 +- schema/aws-iotanalytics-dataset.json | 1046 +- schema/aws-iotanalytics-datastore.json | 610 +- schema/aws-iotanalytics-pipeline.json | 886 +- ...-iotcoredeviceadvisor-suitedefinition.json | 392 +- schema/aws-iotevents-alarmmodel.json | 1122 +- schema/aws-iotevents-detectormodel.json | 1454 +- schema/aws-iotevents-input.json | 276 +- schema/aws-iotfleethub-application.json | 312 +- schema/aws-iotfleetwise-campaign.json | 1076 +- schema/aws-iotfleetwise-decodermanifest.json | 987 +- schema/aws-iotfleetwise-fleet.json | 255 +- schema/aws-iotfleetwise-modelmanifest.json | 299 +- schema/aws-iotfleetwise-signalcatalog.json | 742 +- schema/aws-iotfleetwise-vehicle.json | 305 +- schema/aws-iotsitewise-accesspolicy.json | 312 +- schema/aws-iotsitewise-asset.json | 474 +- schema/aws-iotsitewise-assetmodel.json | 1132 +- schema/aws-iotsitewise-dashboard.json | 250 +- schema/aws-iotsitewise-gateway.json | 438 +- schema/aws-iotsitewise-portal.json | 320 +- schema/aws-iotsitewise-project.json | 250 +- schema/aws-iotthingsgraph-flowtemplate.json | 86 +- schema/aws-iottwinmaker-componenttype.json | 1116 +- schema/aws-iottwinmaker-entity.json | 1200 +- schema/aws-iottwinmaker-scene.json | 378 +- schema/aws-iottwinmaker-syncjob.json | 282 +- schema/aws-iottwinmaker-workspace.json | 254 +- schema/aws-iotwireless-destination.json | 240 +- schema/aws-iotwireless-deviceprofile.json | 372 +- schema/aws-iotwireless-fuotatask.json | 340 +- schema/aws-iotwireless-multicastgroup.json | 304 +- ...wireless-networkanalyzerconfiguration.json | 314 +- schema/aws-iotwireless-partneraccount.json | 332 +- schema/aws-iotwireless-serviceprofile.json | 336 +- schema/aws-iotwireless-taskdefinition.json | 364 +- schema/aws-iotwireless-wirelessdevice.json | 717 +- ...-iotwireless-wirelessdeviceimporttask.json | 430 +- schema/aws-iotwireless-wirelessgateway.json | 270 +- schema/aws-ivs-channel.json | 326 +- schema/aws-ivs-encoderconfiguration.json | 301 +- schema/aws-ivs-playbackkeypair.json | 237 +- schema/aws-ivs-playbackrestrictionpolicy.json | 271 +- schema/aws-ivs-publickey.json | 119 + schema/aws-ivs-recordingconfiguration.json | 547 +- schema/aws-ivs-stage.json | 265 +- schema/aws-ivs-storageconfiguration.json | 281 +- schema/aws-ivs-streamkey.json | 249 +- schema/aws-ivschat-loggingconfiguration.json | 450 +- schema/aws-ivschat-room.json | 339 +- schema/aws-kafkaconnect-connector.json | 1148 +- schema/aws-kafkaconnect-customplugin.json | 398 +- .../aws-kafkaconnect-workerconfiguration.json | 252 +- schema/aws-kendra-datasource.json | 3566 +-- schema/aws-kendra-faq.json | 416 +- schema/aws-kendra-index.json | 888 +- schema/aws-kendraranking-executionplan.json | 312 +- schema/aws-kinesis-stream.json | 390 +- schema/aws-kinesis-streamconsumer.json | 84 +- schema/aws-kinesisanalytics-application.json | 462 +- ...ws-kinesisanalytics-applicationoutput.json | 224 +- ...lytics-applicationreferencedatasource.json | 332 +- .../aws-kinesisanalyticsv2-application.json | 2002 +- ...v2-applicationcloudwatchloggingoption.json | 86 +- ...-kinesisanalyticsv2-applicationoutput.json | 200 +- ...ticsv2-applicationreferencedatasource.json | 324 +- .../aws-kinesisfirehose-deliverystream.json | 3464 +-- schema/aws-kinesisvideo-signalingchannel.json | 206 +- schema/aws-kinesisvideo-stream.json | 236 +- schema/aws-kms-alias.json | 122 +- schema/aws-kms-key.json | 398 +- schema/aws-kms-replicakey.json | 283 +- schema/aws-lakeformation-datacellsfilter.json | 266 +- .../aws-lakeformation-datalakesettings.json | 144 +- schema/aws-lakeformation-permissions.json | 314 +- ...ws-lakeformation-principalpermissions.json | 1036 +- schema/aws-lakeformation-resource.json | 76 +- schema/aws-lakeformation-tag.json | 180 +- schema/aws-lakeformation-tagassociation.json | 482 +- schema/aws-lambda-alias.json | 320 +- schema/aws-lambda-codesigningconfig.json | 264 +- schema/aws-lambda-eventinvokeconfig.json | 274 +- schema/aws-lambda-eventsourcemapping.json | 874 +- schema/aws-lambda-function.json | 1146 +- schema/aws-lambda-layerversion.json | 240 +- schema/aws-lambda-layerversionpermission.json | 148 +- schema/aws-lambda-permission.json | 276 +- schema/aws-lambda-url.json | 382 +- schema/aws-lambda-version.json | 334 +- schema/aws-launchwizard-deployment.json | 498 +- schema/aws-lex-bot.json | 4678 ++-- schema/aws-lex-botalias.json | 820 +- schema/aws-lex-botversion.json | 256 +- schema/aws-lex-resourcepolicy.json | 180 +- schema/aws-licensemanager-grant.json | 182 +- schema/aws-licensemanager-license.json | 482 +- schema/aws-lightsail-alarm.json | 242 +- schema/aws-lightsail-bucket.json | 322 +- schema/aws-lightsail-certificate.json | 230 +- schema/aws-lightsail-container.json | 646 +- schema/aws-lightsail-database.json | 462 +- schema/aws-lightsail-disk.json | 464 +- schema/aws-lightsail-distribution.json | 620 +- schema/aws-lightsail-instance.json | 942 +- schema/aws-lightsail-loadbalancer.json | 286 +- ...-lightsail-loadbalancertlscertificate.json | 206 +- schema/aws-lightsail-staticip.json | 164 +- schema/aws-location-apikey.json | 468 +- schema/aws-location-geofencecollection.json | 354 +- schema/aws-location-map.json | 388 +- schema/aws-location-placeindex.json | 360 +- schema/aws-location-routecalculator.json | 326 +- schema/aws-location-tracker.json | 388 +- schema/aws-location-trackerconsumer.json | 120 +- schema/aws-logs-accountpolicy.json | 256 +- schema/aws-logs-delivery.json | 282 +- schema/aws-logs-deliverydestination.json | 330 +- schema/aws-logs-deliverysource.json | 300 +- schema/aws-logs-destination.json | 166 +- schema/aws-logs-loganomalydetector.json | 222 +- schema/aws-logs-loggroup.json | 354 +- schema/aws-logs-logstream.json | 126 +- schema/aws-logs-metricfilter.json | 394 +- schema/aws-logs-querydefinition.json | 166 +- schema/aws-logs-resourcepolicy.json | 130 +- schema/aws-logs-subscriptionfilter.json | 196 +- ...s-lookoutequipment-inferencescheduler.json | 506 +- schema/aws-lookoutmetrics-alert.json | 278 +- .../aws-lookoutmetrics-anomalydetector.json | 1094 +- schema/aws-lookoutvision-project.json | 138 +- schema/aws-m2-application.json | 340 +- schema/aws-m2-environment.json | 558 +- schema/aws-macie-allowlist.json | 360 +- schema/aws-macie-customdataidentifier.json | 272 +- schema/aws-macie-findingsfilter.json | 390 +- schema/aws-macie-session.json | 154 +- schema/aws-managedblockchain-accessor.json | 314 +- schema/aws-managedblockchain-member.json | 302 +- schema/aws-managedblockchain-node.json | 102 +- schema/aws-mediaconnect-bridge.json | 662 +- schema/aws-mediaconnect-bridgeoutput.json | 208 +- schema/aws-mediaconnect-bridgesource.json | 264 +- schema/aws-mediaconnect-flow.json | 1284 +- schema/aws-mediaconnect-flowentitlement.json | 306 +- schema/aws-mediaconnect-flowoutput.json | 574 +- schema/aws-mediaconnect-flowsource.json | 470 +- schema/aws-mediaconnect-flowvpcinterface.json | 176 +- schema/aws-mediaconnect-gateway.json | 226 +- schema/aws-mediaconvert-jobtemplate.json | 178 +- schema/aws-mediaconvert-preset.json | 82 +- schema/aws-mediaconvert-queue.json | 76 +- schema/aws-medialive-channel.json | 6542 ++--- .../aws-medialive-channelplacementgroup.json | 145 + ...aws-medialive-cloudwatchalarmtemplate.json | 229 + ...edialive-cloudwatchalarmtemplategroup.json | 118 + schema/aws-medialive-cluster.json | 198 + ...aws-medialive-eventbridgeruletemplate.json | 185 + ...edialive-eventbridgeruletemplategroup.json | 118 + schema/aws-medialive-input.json | 325 +- schema/aws-medialive-inputsecuritygroup.json | 82 +- schema/aws-medialive-multiplex.json | 396 +- schema/aws-medialive-multiplexprogram.json | 587 +- schema/aws-medialive-network.json | 165 + schema/aws-medialive-sdisource.json | 140 + schema/aws-medialive-signalmap.json | 424 + schema/aws-mediapackage-asset.json | 274 +- schema/aws-mediapackage-channel.json | 350 +- schema/aws-mediapackage-originendpoint.json | 1384 +- ...s-mediapackage-packagingconfiguration.json | 1002 +- schema/aws-mediapackage-packaginggroup.json | 294 +- schema/aws-mediapackagev2-channel.json | 351 +- schema/aws-mediapackagev2-channelgroup.json | 241 +- schema/aws-mediapackagev2-channelpolicy.json | 140 +- schema/aws-mediapackagev2-originendpoint.json | 1423 +- ...s-mediapackagev2-originendpointpolicy.json | 158 +- schema/aws-mediastore-container.json | 290 +- schema/aws-mediatailor-channel.json | 542 +- schema/aws-mediatailor-channelpolicy.json | 116 +- schema/aws-mediatailor-livesource.json | 296 +- ...aws-mediatailor-playbackconfiguration.json | 600 +- schema/aws-mediatailor-sourcelocation.json | 394 +- schema/aws-mediatailor-vodsource.json | 296 +- schema/aws-memorydb-acl.json | 238 +- schema/aws-memorydb-cluster.json | 506 +- schema/aws-memorydb-parametergroup.json | 242 +- schema/aws-memorydb-subnetgroup.json | 234 +- schema/aws-memorydb-user.json | 284 +- schema/aws-msk-batchscramsecret.json | 186 +- schema/aws-msk-cluster.json | 1234 +- schema/aws-msk-clusterpolicy.json | 158 +- schema/aws-msk-configuration.json | 210 +- schema/aws-msk-replicator.json | 793 +- schema/aws-msk-serverlesscluster.json | 316 +- schema/aws-msk-vpcconnection.json | 322 +- schema/aws-mwaa-environment.json | 1038 +- schema/aws-neptune-dbcluster.json | 674 +- .../aws-neptune-dbclusterparametergroup.json | 126 +- schema/aws-neptune-dbinstance.json | 178 +- schema/aws-neptune-dbparametergroup.json | 126 +- schema/aws-neptune-dbsubnetgroup.json | 122 +- schema/aws-neptune-eventsubscription.json | 84 +- schema/aws-neptunegraph-graph.json | 380 +- ...aws-neptunegraph-privategraphendpoint.json | 264 +- schema/aws-networkfirewall-firewall.json | 403 +- .../aws-networkfirewall-firewallpolicy.json | 747 +- ...-networkfirewall-loggingconfiguration.json | 303 +- schema/aws-networkfirewall-rulegroup.json | 1443 +- ...rkfirewall-tlsinspectionconfiguration.json | 583 +- .../aws-networkmanager-connectattachment.json | 443 +- schema/aws-networkmanager-connectpeer.json | 479 +- schema/aws-networkmanager-corenetwork.json | 482 +- ...orkmanager-customergatewayassociation.json | 156 +- schema/aws-networkmanager-device.json | 397 +- schema/aws-networkmanager-globalnetwork.json | 229 +- schema/aws-networkmanager-link.json | 341 +- .../aws-networkmanager-linkassociation.json | 148 +- schema/aws-networkmanager-site.json | 319 +- ...etworkmanager-sitetositevpnattachment.json | 423 +- ...-networkmanager-transitgatewaypeering.json | 319 +- ...orkmanager-transitgatewayregistration.json | 140 +- ...er-transitgatewayroutetableattachment.json | 421 +- schema/aws-networkmanager-vpcattachment.json | 492 +- schema/aws-nimblestudio-launchprofile.json | 694 +- schema/aws-nimblestudio-streamingimage.json | 354 +- schema/aws-nimblestudio-studio.json | 334 +- schema/aws-nimblestudio-studiocomponent.json | 786 +- schema/aws-oam-link.json | 312 +- schema/aws-oam-sink.json | 184 +- schema/aws-omics-annotationstore.json | 586 +- schema/aws-omics-referencestore.json | 269 +- schema/aws-omics-rungroup.json | 228 +- schema/aws-omics-sequencestore.json | 283 +- schema/aws-omics-variantstore.json | 366 +- schema/aws-omics-workflow.json | 440 +- ...aws-opensearchserverless-accesspolicy.json | 198 +- .../aws-opensearchserverless-collection.json | 322 +- ...-opensearchserverless-lifecyclepolicy.json | 194 +- ...s-opensearchserverless-securityconfig.json | 278 +- ...s-opensearchserverless-securitypolicy.json | 210 +- .../aws-opensearchserverless-vpcendpoint.json | 318 +- schema/aws-opensearchservice-domain.json | 1095 +- schema/aws-opsworks-app.json | 306 +- ...psworks-elasticloadbalancerattachment.json | 52 +- schema/aws-opsworks-instance.json | 462 +- schema/aws-opsworks-layer.json | 506 +- schema/aws-opsworks-stack.json | 450 +- schema/aws-opsworks-userprofile.json | 68 +- schema/aws-opsworks-volume.json | 72 +- schema/aws-opsworkscm-server.json | 472 +- schema/aws-organizations-account.json | 346 +- schema/aws-organizations-organization.json | 192 +- .../aws-organizations-organizationalunit.json | 270 +- schema/aws-organizations-policy.json | 354 +- schema/aws-organizations-resourcepolicy.json | 230 +- schema/aws-osis-pipeline.json | 614 +- schema/aws-panorama-applicationinstance.json | 619 +- schema/aws-panorama-package.json | 367 +- schema/aws-panorama-packageversion.json | 348 +- schema/aws-paymentcryptography-alias.json | 116 +- schema/aws-paymentcryptography-key.json | 522 +- schema/aws-pcaconnectorad-connector.json | 264 +- ...-pcaconnectorad-directoryregistration.json | 182 +- ...s-pcaconnectorad-serviceprincipalname.json | 140 +- schema/aws-pcaconnectorad-template.json | 2074 +- ...torad-templategroupaccesscontrolentry.json | 220 +- schema/aws-pcaconnectorscep-challenge.json | 105 + schema/aws-pcaconnectorscep-connector.json | 183 + schema/aws-personalize-dataset.json | 300 +- schema/aws-personalize-datasetgroup.json | 164 +- schema/aws-personalize-schema.json | 146 +- schema/aws-personalize-solution.json | 608 +- schema/aws-pinpoint-admchannel.json | 72 +- schema/aws-pinpoint-apnschannel.json | 98 +- schema/aws-pinpoint-apnssandboxchannel.json | 98 +- schema/aws-pinpoint-apnsvoipchannel.json | 98 +- .../aws-pinpoint-apnsvoipsandboxchannel.json | 98 +- schema/aws-pinpoint-app.json | 64 +- schema/aws-pinpoint-applicationsettings.json | 176 +- schema/aws-pinpoint-baiduchannel.json | 72 +- schema/aws-pinpoint-campaign.json | 1074 +- schema/aws-pinpoint-emailchannel.json | 90 +- schema/aws-pinpoint-emailtemplate.json | 96 +- schema/aws-pinpoint-eventstream.json | 66 +- schema/aws-pinpoint-gcmchannel.json | 74 +- schema/aws-pinpoint-inapptemplate.json | 426 +- schema/aws-pinpoint-pushtemplate.json | 260 +- schema/aws-pinpoint-segment.json | 468 +- schema/aws-pinpoint-smschannel.json | 68 +- schema/aws-pinpoint-smstemplate.json | 84 +- schema/aws-pinpoint-voicechannel.json | 56 +- .../aws-pinpointemail-configurationset.json | 188 +- ...mail-configurationseteventdestination.json | 272 +- schema/aws-pinpointemail-dedicatedippool.json | 86 +- schema/aws-pinpointemail-identity.json | 182 +- schema/aws-pipes-pipe.json | 3835 +-- ...s-proton-environmentaccountconnection.json | 330 +- schema/aws-proton-environmenttemplate.json | 288 +- schema/aws-proton-servicetemplate.json | 296 +- schema/aws-qbusiness-application.json | 556 +- schema/aws-qbusiness-datasource.json | 856 +- schema/aws-qbusiness-index.json | 504 +- schema/aws-qbusiness-plugin.json | 728 +- schema/aws-qbusiness-retriever.json | 466 +- schema/aws-qbusiness-webexperience.json | 450 +- schema/aws-qldb-ledger.json | 118 +- schema/aws-qldb-stream.json | 302 +- schema/aws-quicksight-analysis.json | 22796 +++++++-------- schema/aws-quicksight-dashboard.json | 23287 ++++++++-------- schema/aws-quicksight-dataset.json | 3135 +-- schema/aws-quicksight-datasource.json | 2187 +- schema/aws-quicksight-refreshschedule.json | 346 +- schema/aws-quicksight-template.json | 22733 +++++++-------- schema/aws-quicksight-theme.json | 1052 +- schema/aws-quicksight-topic.json | 2044 +- schema/aws-quicksight-vpcconnection.json | 522 +- schema/aws-ram-permission.json | 258 +- schema/aws-ram-resourceshare.json | 164 +- schema/aws-rds-customdbengineversion.json | 396 +- schema/aws-rds-dbcluster.json | 1107 +- schema/aws-rds-dbclusterparametergroup.json | 257 +- schema/aws-rds-dbinstance.json | 1346 +- schema/aws-rds-dbparametergroup.json | 249 +- schema/aws-rds-dbproxy.json | 408 +- schema/aws-rds-dbproxyendpoint.json | 296 +- schema/aws-rds-dbproxytargetgroup.json | 264 +- schema/aws-rds-dbsecuritygroup.json | 160 +- schema/aws-rds-dbsecuritygroupingress.json | 68 +- schema/aws-rds-dbsubnetgroup.json | 226 +- schema/aws-rds-eventsubscription.json | 271 +- schema/aws-rds-globalcluster.json | 216 +- schema/aws-rds-integration.json | 348 +- schema/aws-rds-optiongroup.json | 383 +- schema/aws-redshift-cluster.json | 979 +- .../aws-redshift-clusterparametergroup.json | 316 +- schema/aws-redshift-clustersecuritygroup.json | 100 +- ...-redshift-clustersecuritygroupingress.json | 74 +- schema/aws-redshift-clustersubnetgroup.json | 340 +- schema/aws-redshift-endpointaccess.json | 498 +- .../aws-redshift-endpointauthorization.json | 296 +- schema/aws-redshift-eventsubscription.json | 398 +- schema/aws-redshift-scheduledaction.json | 448 +- schema/aws-redshiftserverless-namespace.json | 706 +- schema/aws-redshiftserverless-workgroup.json | 778 +- schema/aws-refactorspaces-application.json | 494 +- schema/aws-refactorspaces-environment.json | 326 +- schema/aws-refactorspaces-route.json | 606 +- schema/aws-refactorspaces-service.json | 464 +- schema/aws-rekognition-collection.json | 229 +- schema/aws-rekognition-project.json | 142 +- schema/aws-rekognition-streamprocessor.json | 801 +- schema/aws-resiliencehub-app.json | 616 +- .../aws-resiliencehub-resiliencypolicy.json | 318 +- ...ourceexplorer2-defaultviewassociation.json | 104 +- schema/aws-resourceexplorer2-index.json | 204 +- schema/aws-resourceexplorer2-view.json | 242 +- schema/aws-resourcegroups-group.json | 426 +- schema/aws-robomaker-fleet.json | 156 +- schema/aws-robomaker-robot.json | 214 +- schema/aws-robomaker-robotapplication.json | 350 +- ...aws-robomaker-robotapplicationversion.json | 138 +- .../aws-robomaker-simulationapplication.json | 488 +- ...obomaker-simulationapplicationversion.json | 138 +- schema/aws-rolesanywhere-crl.json | 214 +- schema/aws-rolesanywhere-profile.json | 373 +- schema/aws-rolesanywhere-trustanchor.json | 416 +- schema/aws-route53-cidrcollection.json | 215 +- schema/aws-route53-dnssec.json | 114 +- schema/aws-route53-healthcheck.json | 430 +- schema/aws-route53-hostedzone.json | 389 +- schema/aws-route53-keysigningkey.json | 184 +- schema/aws-route53-recordset.json | 332 +- schema/aws-route53-recordsetgroup.json | 368 +- schema/aws-route53profiles-profile.json | 242 +- ...ws-route53profiles-profileassociation.json | 248 +- ...53profiles-profileresourceassociation.json | 210 +- .../aws-route53recoverycontrol-cluster.json | 272 +- ...s-route53recoverycontrol-controlpanel.json | 268 +- ...route53recoverycontrol-routingcontrol.json | 204 +- ...aws-route53recoverycontrol-safetyrule.json | 500 +- schema/aws-route53recoveryreadiness-cell.json | 222 +- ...ute53recoveryreadiness-readinesscheck.json | 206 +- ...oute53recoveryreadiness-recoverygroup.json | 212 +- ...-route53recoveryreadiness-resourceset.json | 436 +- ...ws-route53resolver-firewalldomainlist.json | 410 +- ...aws-route53resolver-firewallrulegroup.json | 540 +- ...resolver-firewallrulegroupassociation.json | 406 +- .../aws-route53resolver-outpostresolver.json | 358 +- .../aws-route53resolver-resolverconfig.json | 180 +- ...-route53resolver-resolverdnssecconfig.json | 158 +- .../aws-route53resolver-resolverendpoint.json | 236 +- ...53resolver-resolverqueryloggingconfig.json | 260 +- ...resolverqueryloggingconfigassociation.json | 204 +- schema/aws-route53resolver-resolverrule.json | 358 +- ...ute53resolver-resolverruleassociation.json | 128 +- schema/aws-rum-appmonitor.json | 848 +- schema/aws-s3-accessgrant.json | 364 +- schema/aws-s3-accessgrantsinstance.json | 216 +- schema/aws-s3-accessgrantslocation.json | 220 +- schema/aws-s3-accesspoint.json | 304 +- schema/aws-s3-bucket.json | 3570 ++- schema/aws-s3-bucketpolicy.json | 130 +- schema/aws-s3-multiregionaccesspoint.json | 252 +- .../aws-s3-multiregionaccesspointpolicy.json | 158 +- schema/aws-s3-storagelens.json | 978 +- schema/aws-s3-storagelensgroup.json | 504 +- schema/aws-s3express-bucketpolicy.json | 130 +- schema/aws-s3express-directorybucket.json | 186 +- schema/aws-s3objectlambda-accesspoint.json | 486 +- .../aws-s3objectlambda-accesspointpolicy.json | 114 +- schema/aws-s3outposts-accesspoint.json | 216 +- schema/aws-s3outposts-bucket.json | 626 +- schema/aws-s3outposts-bucketpolicy.json | 122 +- schema/aws-s3outposts-endpoint.json | 350 +- schema/aws-sagemaker-app.json | 454 +- schema/aws-sagemaker-appimageconfig.json | 552 +- schema/aws-sagemaker-cluster.json | 401 + schema/aws-sagemaker-coderepository.json | 142 +- ...ws-sagemaker-dataqualityjobdefinition.json | 1182 +- schema/aws-sagemaker-device.json | 226 +- schema/aws-sagemaker-devicefleet.json | 248 +- schema/aws-sagemaker-domain.json | 1912 +- schema/aws-sagemaker-endpoint.json | 396 +- schema/aws-sagemaker-endpointconfig.json | 952 +- schema/aws-sagemaker-featuregroup.json | 718 +- schema/aws-sagemaker-image.json | 304 +- schema/aws-sagemaker-imageversion.json | 458 +- schema/aws-sagemaker-inferencecomponent.json | 702 +- schema/aws-sagemaker-inferenceexperiment.json | 880 +- .../aws-sagemaker-mlflowtrackingserver.json | 330 +- schema/aws-sagemaker-model.json | 490 +- .../aws-sagemaker-modelbiasjobdefinition.json | 1254 +- schema/aws-sagemaker-modelcard.json | 2060 +- ...aker-modelexplainabilityjobdefinition.json | 1162 +- schema/aws-sagemaker-modelpackage.json | 2368 +- schema/aws-sagemaker-modelpackagegroup.json | 300 +- ...s-sagemaker-modelqualityjobdefinition.json | 1306 +- schema/aws-sagemaker-monitoringschedule.json | 1482 +- schema/aws-sagemaker-notebookinstance.json | 244 +- ...maker-notebookinstancelifecycleconfig.json | 94 +- schema/aws-sagemaker-pipeline.json | 354 +- schema/aws-sagemaker-project.json | 484 +- schema/aws-sagemaker-space.json | 1021 +- .../aws-sagemaker-studiolifecycleconfig.json | 130 + schema/aws-sagemaker-userprofile.json | 1396 +- schema/aws-sagemaker-workteam.json | 248 +- schema/aws-scheduler-schedule.json | 1182 +- schema/aws-scheduler-schedulegroup.json | 267 +- schema/aws-sdb-domain.json | 38 +- schema/aws-secretsmanager-resourcepolicy.json | 156 +- .../aws-secretsmanager-rotationschedule.json | 192 +- schema/aws-secretsmanager-secret.json | 394 +- ...secretsmanager-secrettargetattachment.json | 60 +- schema/aws-securityhub-automationrule.json | 1665 +- .../aws-securityhub-configurationpolicy.json | 600 +- schema/aws-securityhub-delegatedadmin.json | 148 +- schema/aws-securityhub-findingaggregator.json | 166 +- schema/aws-securityhub-hub.json | 202 +- schema/aws-securityhub-insight.json | 2574 +- ...securityhub-organizationconfiguration.json | 198 +- schema/aws-securityhub-policyassociation.json | 216 +- .../aws-securityhub-productsubscription.json | 120 +- schema/aws-securityhub-securitycontrol.json | 441 +- schema/aws-securityhub-standard.json | 212 +- schema/aws-securitylake-awslogsource.json | 192 +- schema/aws-securitylake-datalake.json | 450 +- schema/aws-securitylake-subscriber.json | 614 +- ...s-securitylake-subscribernotification.json | 412 +- ...servicecatalog-acceptedportfolioshare.json | 58 +- ...-servicecatalog-cloudformationproduct.json | 340 +- ...alog-cloudformationprovisionedproduct.json | 460 +- ...ecatalog-launchnotificationconstraint.json | 88 +- ...s-servicecatalog-launchroleconstraint.json | 84 +- ...rvicecatalog-launchtemplateconstraint.json | 80 +- schema/aws-servicecatalog-portfolio.json | 122 +- ...catalog-portfolioprincipalassociation.json | 78 +- ...cecatalog-portfolioproductassociation.json | 76 +- schema/aws-servicecatalog-portfolioshare.json | 74 +- ...rvicecatalog-resourceupdateconstraint.json | 80 +- schema/aws-servicecatalog-serviceaction.json | 216 +- ...rvicecatalog-serviceactionassociation.json | 158 +- ...aws-servicecatalog-stacksetconstraint.json | 130 +- schema/aws-servicecatalog-tagoption.json | 66 +- ...s-servicecatalog-tagoptionassociation.json | 60 +- ...servicecatalogappregistry-application.json | 244 +- ...vicecatalogappregistry-attributegroup.json | 204 +- ...appregistry-attributegroupassociation.json | 170 +- ...atalogappregistry-resourceassociation.json | 188 +- .../aws-servicediscovery-httpnamespace.json | 114 +- schema/aws-servicediscovery-instance.json | 60 +- ...-servicediscovery-privatednsnamespace.json | 192 +- ...s-servicediscovery-publicdnsnamespace.json | 182 +- schema/aws-servicediscovery-service.json | 274 +- schema/aws-ses-configurationset.json | 371 +- ...-ses-configurationseteventdestination.json | 402 +- schema/aws-ses-contactlist.json | 252 +- schema/aws-ses-dedicatedippool.json | 116 +- schema/aws-ses-emailidentity.json | 346 +- schema/aws-ses-mailmanageraddoninstance.json | 236 +- .../aws-ses-mailmanageraddonsubscription.json | 222 +- schema/aws-ses-mailmanagerarchive.json | 340 +- schema/aws-ses-mailmanageringresspoint.json | 412 +- schema/aws-ses-mailmanagerrelay.json | 326 +- schema/aws-ses-mailmanagerruleset.json | 1770 +- schema/aws-ses-mailmanagertrafficpolicy.json | 870 +- schema/aws-ses-receiptfilter.json | 116 +- schema/aws-ses-receiptrule.json | 435 +- schema/aws-ses-receiptruleset.json | 44 +- schema/aws-ses-template.json | 180 +- schema/aws-ses-vdmattributes.json | 162 +- schema/aws-shield-drtaccess.json | 184 +- schema/aws-shield-proactiveengagement.json | 230 +- schema/aws-shield-protection.json | 400 +- schema/aws-shield-protectiongroup.json | 304 +- schema/aws-signer-profilepermission.json | 154 +- schema/aws-signer-signingprofile.json | 304 +- schema/aws-simspaceweaver-simulation.json | 266 +- schema/aws-sns-subscription.json | 185 +- schema/aws-sns-topic.json | 494 +- schema/aws-sns-topicinlinepolicy.json | 114 +- schema/aws-sns-topicpolicy.json | 122 +- schema/aws-sqs-queue.json | 334 +- schema/aws-sqs-queueinlinepolicy.json | 120 +- schema/aws-sqs-queuepolicy.json | 150 +- schema/aws-ssm-association.json | 562 +- schema/aws-ssm-document.json | 472 +- schema/aws-ssm-maintenancewindow.json | 156 +- schema/aws-ssm-maintenancewindowtarget.json | 136 +- schema/aws-ssm-maintenancewindowtask.json | 486 +- schema/aws-ssm-parameter.json | 240 +- schema/aws-ssm-patchbaseline.json | 740 +- schema/aws-ssm-resourcedatasync.json | 374 +- schema/aws-ssm-resourcepolicy.json | 144 +- schema/aws-ssmcontacts-contact.json | 392 +- schema/aws-ssmcontacts-contactchannel.json | 192 +- schema/aws-ssmcontacts-plan.json | 360 +- schema/aws-ssmcontacts-rotation.json | 624 +- schema/aws-ssmincidents-replicationset.json | 328 +- schema/aws-ssmincidents-responseplan.json | 922 +- ...ws-ssmquicksetup-configurationmanager.json | 325 + schema/aws-sso-application.json | 400 +- schema/aws-sso-applicationassignment.json | 160 +- schema/aws-sso-assignment.json | 230 +- schema/aws-sso-instance.json | 266 +- ...ceaccesscontrolattributeconfiguration.json | 268 +- schema/aws-sso-permissionset.json | 464 +- schema/aws-stepfunctions-activity.json | 265 +- schema/aws-stepfunctions-statemachine.json | 587 +- .../aws-stepfunctions-statemachinealias.json | 372 +- ...aws-stepfunctions-statemachineversion.json | 166 +- schema/aws-supportapp-accountalias.json | 122 +- ...-supportapp-slackchannelconfiguration.json | 202 +- ...upportapp-slackworkspaceconfiguration.json | 134 +- schema/aws-synthetics-canary.json | 816 +- schema/aws-synthetics-group.json | 236 +- schema/aws-systemsmanagersap-application.json | 348 +- schema/aws-timestream-database.json | 198 +- schema/aws-timestream-influxdbinstance.json | 628 +- schema/aws-timestream-scheduledquery.json | 1092 +- schema/aws-timestream-table.json | 480 +- schema/aws-transfer-agreement.json | 346 +- schema/aws-transfer-certificate.json | 388 +- schema/aws-transfer-connector.json | 508 +- schema/aws-transfer-profile.json | 274 +- schema/aws-transfer-server.json | 470 +- schema/aws-transfer-user.json | 270 +- schema/aws-transfer-workflow.json | 800 +- ...ws-verifiedpermissions-identitysource.json | 690 +- schema/aws-verifiedpermissions-policy.json | 378 +- .../aws-verifiedpermissions-policystore.json | 238 +- ...ws-verifiedpermissions-policytemplate.json | 182 +- schema/aws-voiceid-domain.json | 284 +- .../aws-vpclattice-accesslogsubscription.json | 404 +- schema/aws-vpclattice-authpolicy.json | 128 +- schema/aws-vpclattice-listener.json | 491 +- schema/aws-vpclattice-resourcepolicy.json | 108 +- schema/aws-vpclattice-rule.json | 723 +- schema/aws-vpclattice-service.json | 358 +- schema/aws-vpclattice-servicenetwork.json | 273 +- ...tice-servicenetworkserviceassociation.json | 446 +- ...clattice-servicenetworkvpcassociation.json | 418 +- schema/aws-vpclattice-targetgroup.json | 679 +- schema/aws-waf-bytematchset.json | 150 +- schema/aws-waf-ipset.json | 100 +- schema/aws-waf-rule.json | 118 +- schema/aws-waf-sizeconstraintset.json | 148 +- schema/aws-waf-sqlinjectionmatchset.json | 130 +- schema/aws-waf-webacl.json | 148 +- schema/aws-waf-xssmatchset.json | 132 +- schema/aws-wafregional-bytematchset.json | 150 +- schema/aws-wafregional-geomatchset.json | 100 +- schema/aws-wafregional-ipset.json | 100 +- schema/aws-wafregional-ratebasedrule.json | 136 +- schema/aws-wafregional-regexpatternset.json | 66 +- schema/aws-wafregional-rule.json | 118 +- schema/aws-wafregional-sizeconstraintset.json | 146 +- .../aws-wafregional-sqlinjectionmatchset.json | 130 +- schema/aws-wafregional-webacl.json | 150 +- schema/aws-wafregional-webaclassociation.json | 60 +- schema/aws-wafregional-xssmatchset.json | 130 +- schema/aws-wafv2-ipset.json | 332 +- schema/aws-wafv2-loggingconfiguration.json | 476 +- schema/aws-wafv2-regexpatternset.json | 264 +- schema/aws-wafv2-rulegroup.json | 2928 +- schema/aws-wafv2-webacl.json | 4004 +-- schema/aws-wafv2-webaclassociation.json | 250 +- schema/aws-wisdom-assistant.json | 268 +- schema/aws-wisdom-assistantassociation.json | 292 +- schema/aws-wisdom-knowledgebase.json | 412 +- schema/aws-workspaces-connectionalias.json | 246 +- schema/aws-workspaces-workspace.json | 182 +- schema/aws-workspaces-workspacespool.json | 386 +- .../aws-workspacesthinclient-environment.json | 638 +- schema/aws-workspacesweb-browsersettings.json | 310 +- .../aws-workspacesweb-identityprovider.json | 256 +- .../aws-workspacesweb-ipaccesssettings.json | 400 +- schema/aws-workspacesweb-networksettings.json | 284 +- schema/aws-workspacesweb-portal.json | 624 +- schema/aws-workspacesweb-truststore.json | 248 +- ...rkspacesweb-useraccessloggingsettings.json | 236 +- schema/aws-workspacesweb-usersettings.json | 502 +- schema/aws-xray-group.json | 246 +- schema/aws-xray-resourcepolicy.json | 146 +- schema/aws-xray-samplingrule.json | 586 +- schema/update.ps1 | 16 + 1310 files changed, 314385 insertions(+), 305759 deletions(-) create mode 100644 schema/aws-cleanrooms-idmappingtable.json create mode 100644 schema/aws-cleanrooms-idnamespaceassociation.json create mode 100644 schema/aws-connect-agentstatus.json create mode 100644 schema/aws-connect-userhierarchystructure.json create mode 100644 schema/aws-datazone-environmentactions.json create mode 100644 schema/aws-ivs-publickey.json create mode 100644 schema/aws-medialive-channelplacementgroup.json create mode 100644 schema/aws-medialive-cloudwatchalarmtemplate.json create mode 100644 schema/aws-medialive-cloudwatchalarmtemplategroup.json create mode 100644 schema/aws-medialive-cluster.json create mode 100644 schema/aws-medialive-eventbridgeruletemplate.json create mode 100644 schema/aws-medialive-eventbridgeruletemplategroup.json create mode 100644 schema/aws-medialive-network.json create mode 100644 schema/aws-medialive-sdisource.json create mode 100644 schema/aws-medialive-signalmap.json create mode 100644 schema/aws-pcaconnectorscep-challenge.json create mode 100644 schema/aws-pcaconnectorscep-connector.json create mode 100644 schema/aws-sagemaker-cluster.json create mode 100644 schema/aws-sagemaker-studiolifecycleconfig.json create mode 100644 schema/aws-ssmquicksetup-configurationmanager.json create mode 100644 schema/update.ps1 diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index b950b4c..e5fc6b5 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -43,7 +43,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@5c02493ebfd65b28fd3b082c65e5af2cd745d91f # codeql-bundle-v2.18.2 + uses: github/codeql-action/init@5618c9fc1e675841ca52c1c6b1304f5255a905a0 # codeql-bundle-v2.19.0 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -53,7 +53,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild - uses: github/codeql-action/autobuild@5c02493ebfd65b28fd3b082c65e5af2cd745d91f # codeql-bundle-v2.18.2 + uses: github/codeql-action/autobuild@5618c9fc1e675841ca52c1c6b1304f5255a905a0 # codeql-bundle-v2.19.0 # ℹ️ Command-line programs to run using the OS shell. # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun @@ -66,4 +66,4 @@ jobs: # ./location_of_script_within_repo/buildscript.sh - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@5c02493ebfd65b28fd3b082c65e5af2cd745d91f # codeql-bundle-v2.18.2 + uses: github/codeql-action/analyze@5618c9fc1e675841ca52c1c6b1304f5255a905a0 # codeql-bundle-v2.19.0 diff --git a/schema/alexa-ask-skill.json b/schema/alexa-ask-skill.json index 529be4f..fa3d128 100644 --- a/schema/alexa-ask-skill.json +++ b/schema/alexa-ask-skill.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VendorId" - ], - "definitions": { - "AuthenticationConfiguration": { - "additionalProperties": false, - "properties": { - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "RefreshToken": { - "type": "string" - } - }, - "required": [ - "RefreshToken", - "ClientSecret", - "ClientId" - ], - "type": "object" - }, - "Overrides": { - "additionalProperties": false, - "properties": { - "Manifest": { - "type": "object" - } - }, - "type": "object" - }, - "SkillPackage": { - "additionalProperties": false, - "properties": { - "Overrides": { - "$ref": "#/definitions/Overrides" - }, - "S3Bucket": { - "type": "string" - }, - "S3BucketRole": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for Alexa::ASK::Skill", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AuthenticationConfiguration": { - "$ref": "#/definitions/AuthenticationConfiguration" - }, - "Id": { - "type": "string" - }, - "SkillPackage": { - "$ref": "#/definitions/SkillPackage" - }, - "VendorId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "AuthenticationConfiguration", - "VendorId", - "SkillPackage" - ], - "typeName": "Alexa::ASK::Skill" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VendorId" + ], + "definitions": { + "AuthenticationConfiguration": { + "additionalProperties": false, + "properties": { + "ClientId": { + "type": "string" + }, + "ClientSecret": { + "type": "string" + }, + "RefreshToken": { + "type": "string" + } + }, + "required": [ + "RefreshToken", + "ClientSecret", + "ClientId" + ], + "type": "object" + }, + "Overrides": { + "additionalProperties": false, + "properties": { + "Manifest": { + "type": "object" + } + }, + "type": "object" + }, + "SkillPackage": { + "additionalProperties": false, + "properties": { + "Overrides": { + "$ref": "#/definitions/Overrides" + }, + "S3Bucket": { + "type": "string" + }, + "S3BucketRole": { + "type": "string" + }, + "S3Key": { + "type": "string" + }, + "S3ObjectVersion": { + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Alexa::ASK::Skill", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AuthenticationConfiguration": { + "$ref": "#/definitions/AuthenticationConfiguration" + }, + "Id": { + "type": "string" + }, + "SkillPackage": { + "$ref": "#/definitions/SkillPackage" + }, + "VendorId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "AuthenticationConfiguration", + "VendorId", + "SkillPackage" + ], + "typeName": "Alexa::ASK::Skill" +} diff --git a/schema/aws-accessanalyzer-analyzer.json b/schema/aws-accessanalyzer-analyzer.json index 9962d49..fdfe460 100644 --- a/schema/aws-accessanalyzer-analyzer.json +++ b/schema/aws-accessanalyzer-analyzer.json @@ -1,215 +1,219 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AnalyzerName", - "/properties/Type", - "/properties/AnalyzerConfiguration" - ], - "definitions": { - "ArchiveRule": { - "additionalProperties": false, - "description": "An Access Analyzer archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.", - "properties": { - "Filter": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Filter" - }, - "minItems": 1, - "type": "array" - }, - "RuleName": { - "description": "The archive rule name", - "type": "string" - } - }, - "required": [ - "Filter", - "RuleName" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "Contains": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Eq": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Exists": { - "type": "boolean" - }, - "Neq": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Property": { - "type": "string" - } - }, - "required": [ - "Property" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UnusedAccessConfiguration": { - "additionalProperties": false, - "description": "The Configuration for Unused Access Analyzer", - "properties": { - "UnusedAccessAge": { - "description": "The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days.", - "maximum": 180, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account", - "handlers": { - "create": { - "permissions": [ - "access-analyzer:CreateAnalyzer", - "access-analyzer:TagResource", - "iam:CreateServiceLinkedRole", - "organizations:ListAWSServiceAccessForOrganization", - "organizations:ListDelegatedAdministrators" - ] - }, - "delete": { - "permissions": [ - "access-analyzer:DeleteAnalyzer" - ] - }, - "list": { - "permissions": [ - "access-analyzer:ListAnalyzers" - ] - }, - "read": { - "permissions": [ - "access-analyzer:ListAnalyzers", - "access-analyzer:GetAnalyzer", - "access-analyzer:ListArchiveRules" - ] - }, - "update": { - "permissions": [ - "access-analyzer:CreateArchiveRule", - "access-analyzer:DeleteArchiveRule", - "access-analyzer:ListAnalyzers", - "access-analyzer:TagResource", - "access-analyzer:UntagResource", - "access-analyzer:UpdateArchiveRule" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AnalyzerConfiguration": { - "additionalProperties": false, - "description": "The configuration for the analyzer", - "properties": { - "UnusedAccessConfiguration": { - "$ref": "#/definitions/UnusedAccessConfiguration" - } - }, - "type": "object" - }, - "AnalyzerName": { - "description": "Analyzer name", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "ArchiveRules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ArchiveRule" - }, - "type": "array" - }, - "Arn": { - "description": "Amazon Resource Name (ARN) of the analyzer", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS", - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Type" - ], - "resourceLink": { - "mappings": { - "AnalyzerName": "/AnalyzerName" - }, - "templateUri": "/access-analyzer/home?region=${awsRegion}#/analyzer/${AnalyzerName}" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-accessanalyzer.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AccessAnalyzer::Analyzer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AnalyzerName", + "/properties/Type", + "/properties/AnalyzerConfiguration" + ], + "definitions": { + "ArchiveRule": { + "additionalProperties": false, + "description": "An Access Analyzer archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.", + "properties": { + "Filter": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Filter" + }, + "minItems": 1, + "type": "array" + }, + "RuleName": { + "description": "The archive rule name", + "type": "string" + } + }, + "required": [ + "Filter", + "RuleName" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "Contains": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Eq": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Exists": { + "type": "boolean" + }, + "Neq": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Property": { + "type": "string" + } + }, + "required": [ + "Property" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UnusedAccessConfiguration": { + "additionalProperties": false, + "description": "The Configuration for Unused Access Analyzer", + "properties": { + "UnusedAccessAge": { + "description": "The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days.", + "maximum": 180, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account", + "handlers": { + "create": { + "permissions": [ + "access-analyzer:CreateAnalyzer", + "access-analyzer:TagResource", + "iam:CreateServiceLinkedRole", + "organizations:ListAWSServiceAccessForOrganization", + "organizations:ListDelegatedAdministrators" + ] + }, + "delete": { + "permissions": [ + "access-analyzer:DeleteAnalyzer" + ] + }, + "list": { + "permissions": [ + "access-analyzer:ListAnalyzers" + ] + }, + "read": { + "permissions": [ + "access-analyzer:ListAnalyzers", + "access-analyzer:GetAnalyzer", + "access-analyzer:ListArchiveRules" + ] + }, + "update": { + "permissions": [ + "access-analyzer:CreateArchiveRule", + "access-analyzer:DeleteArchiveRule", + "access-analyzer:ListAnalyzers", + "access-analyzer:TagResource", + "access-analyzer:UntagResource", + "access-analyzer:UpdateArchiveRule" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AnalyzerConfiguration": { + "additionalProperties": false, + "description": "The configuration for the analyzer", + "properties": { + "UnusedAccessConfiguration": { + "$ref": "#/definitions/UnusedAccessConfiguration" + } + }, + "type": "object" + }, + "AnalyzerName": { + "description": "Analyzer name", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "ArchiveRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ArchiveRule" + }, + "type": "array" + }, + "Arn": { + "description": "Amazon Resource Name (ARN) of the analyzer", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS", + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Type" + ], + "resourceLink": { + "mappings": { + "AnalyzerName": "/AnalyzerName" + }, + "templateUri": "/access-analyzer/home?region=${awsRegion}#/analyzer/${AnalyzerName}" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-accessanalyzer.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "access-analyzer:UntagResource", + "access-analyzer:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AccessAnalyzer::Analyzer" +} diff --git a/schema/aws-acmpca-certificate.json b/schema/aws-acmpca-certificate.json index dcfbf81..0923b76 100644 --- a/schema/aws-acmpca-certificate.json +++ b/schema/aws-acmpca-certificate.json @@ -1,528 +1,528 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiPassthrough", - "/properties/CertificateAuthorityArn", - "/properties/CertificateSigningRequest", - "/properties/SigningAlgorithm", - "/properties/TemplateArn", - "/properties/Validity", - "/properties/ValidityNotBefore" - ], - "definitions": { - "ApiPassthrough": { - "additionalProperties": false, - "description": "Contains X.509 certificate information to be placed in an issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored. \n If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.", - "properties": { - "Extensions": { - "$ref": "#/definitions/Extensions", - "description": "Specifies X.509 extension information for a certificate." - }, - "Subject": { - "$ref": "#/definitions/Subject", - "description": "Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate." - } - }, - "type": "object" - }, - "Arn": { - "type": "string" - }, - "CertificatePolicyList": { - "items": { - "$ref": "#/definitions/PolicyInformation" - }, - "type": "array" - }, - "CustomAttribute": { - "additionalProperties": false, - "description": "Defines the X.500 relative distinguished name (RDN).", - "properties": { - "ObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN)." - }, - "Value": { - "description": "Specifies the attribute value of relative distinguished name (RDN).", - "type": "string" - } - }, - "required": [ - "ObjectIdentifier", - "Value" - ], - "type": "object" - }, - "CustomAttributeList": { - "description": "Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.", - "items": { - "$ref": "#/definitions/CustomAttribute" - }, - "type": "array" - }, - "CustomExtension": { - "additionalProperties": false, - "description": "Specifies the X.509 extension information for a certificate.\n Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough`` [template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).", - "properties": { - "Critical": { - "description": "Specifies the critical flag of the X.509 extension.", - "type": "boolean" - }, - "ObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)" - }, - "Value": { - "description": "Specifies the base64-encoded value of the X.509 extension.", - "type": "string" - } - }, - "required": [ - "ObjectIdentifier", - "Value" - ], - "type": "object" - }, - "CustomExtensionList": { - "description": "Array of X.509 extensions for a certificate.", - "items": { - "$ref": "#/definitions/CustomExtension" - }, - "type": "array" - }, - "CustomObjectIdentifier": { - "description": "String that contains X.509 ObjectIdentifier information.", - "type": "string" - }, - "DnsName": { - "description": "String that contains X.509 DnsName information.", - "type": "string" - }, - "EdiPartyName": { - "additionalProperties": false, - "description": "Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.", - "properties": { - "NameAssigner": { - "description": "Specifies the name assigner.", - "type": "string" - }, - "PartyName": { - "description": "Specifies the party name.", - "type": "string" - } - }, - "required": [ - "PartyName", - "NameAssigner" - ], - "type": "object" - }, - "ExtendedKeyUsage": { - "additionalProperties": false, - "description": "Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.", - "properties": { - "ExtendedKeyUsageObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID)." - }, - "ExtendedKeyUsageType": { - "description": "Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).", - "type": "string" - } - }, - "type": "object" - }, - "ExtendedKeyUsageList": { - "items": { - "$ref": "#/definitions/ExtendedKeyUsage" - }, - "type": "array" - }, - "Extensions": { - "additionalProperties": false, - "description": "Contains X.509 extension information for a certificate.", - "properties": { - "CertificatePolicies": { - "$ref": "#/definitions/CertificatePolicyList", - "description": "Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate." - }, - "CustomExtensions": { - "$ref": "#/definitions/CustomExtensionList", - "description": "Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)" - }, - "ExtendedKeyUsage": { - "$ref": "#/definitions/ExtendedKeyUsageList", - "description": "Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension." - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage", - "description": "Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false." - }, - "SubjectAlternativeNames": { - "$ref": "#/definitions/GeneralNameList", - "description": "The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate." - } - }, - "type": "object" - }, - "GeneralName": { - "additionalProperties": false, - "description": "Describes an ASN.1 X.400 ``GeneralName`` as defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280). Only one of the following naming options should be provided. Providing more than one option results in an ``InvalidArgsException`` error.", - "properties": { - "DirectoryName": { - "$ref": "#/definitions/Subject", - "description": "Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity." - }, - "DnsName": { - "$ref": "#/definitions/DnsName", - "description": "Represents ``GeneralName`` as a DNS name." - }, - "EdiPartyName": { - "$ref": "#/definitions/EdiPartyName", - "description": "Represents ``GeneralName`` as an ``EdiPartyName`` object." - }, - "IpAddress": { - "$ref": "#/definitions/IpAddress", - "description": "Represents ``GeneralName`` as an IPv4 or IPv6 address." - }, - "OtherName": { - "$ref": "#/definitions/OtherName", - "description": "Represents ``GeneralName`` using an ``OtherName`` object." - }, - "RegisteredId": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Represents ``GeneralName`` as an object identifier (OID)." - }, - "Rfc822Name": { - "$ref": "#/definitions/Rfc822Name", - "description": "Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address." - }, - "UniformResourceIdentifier": { - "$ref": "#/definitions/UniformResourceIdentifier", - "description": "Represents ``GeneralName`` as a URI." - } - }, - "type": "object" - }, - "GeneralNameList": { - "items": { - "$ref": "#/definitions/GeneralName" - }, - "type": "array" - }, - "IpAddress": { - "description": "String that contains X.509 IpAddress information.", - "type": "string" - }, - "KeyUsage": { - "additionalProperties": false, - "description": "Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.", - "properties": { - "CRLSign": { - "default": false, - "description": "Key can be used to sign CRLs.", - "type": "boolean" - }, - "DataEncipherment": { - "default": false, - "description": "Key can be used to decipher data.", - "type": "boolean" - }, - "DecipherOnly": { - "default": false, - "description": "Key can be used only to decipher data.", - "type": "boolean" - }, - "DigitalSignature": { - "default": false, - "description": "Key can be used for digital signing.", - "type": "boolean" - }, - "EncipherOnly": { - "default": false, - "description": "Key can be used only to encipher data.", - "type": "boolean" - }, - "KeyAgreement": { - "default": false, - "description": "Key can be used in a key-agreement protocol.", - "type": "boolean" - }, - "KeyCertSign": { - "default": false, - "description": "Key can be used to sign certificates.", - "type": "boolean" - }, - "KeyEncipherment": { - "default": false, - "description": "Key can be used to encipher data.", - "type": "boolean" - }, - "NonRepudiation": { - "default": false, - "description": "Key can be used for non-repudiation.", - "type": "boolean" - } - }, - "type": "object" - }, - "OtherName": { - "additionalProperties": false, - "description": "Defines a custom ASN.1 X.400 ``GeneralName`` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).", - "properties": { - "TypeId": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Specifies an OID." - }, - "Value": { - "description": "Specifies an OID value.", - "type": "string" - } - }, - "required": [ - "TypeId", - "Value" - ], - "type": "object" - }, - "PolicyInformation": { - "additionalProperties": false, - "description": "Defines the X.509 ``CertificatePolicies`` extension.", - "properties": { - "CertPolicyId": { - "$ref": "#/definitions/CustomObjectIdentifier", - "description": "Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier)." - }, - "PolicyQualifiers": { - "$ref": "#/definitions/PolicyQualifierInfoList", - "description": "Modifies the given ``CertPolicyId`` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier." - } - }, - "required": [ - "CertPolicyId" - ], - "type": "object" - }, - "PolicyQualifierInfo": { - "additionalProperties": false, - "description": "Modifies the ``CertPolicyId`` of a ``PolicyInformation`` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.", - "properties": { - "PolicyQualifierId": { - "description": "Identifies the qualifier modifying a ``CertPolicyId``.", - "type": "string" - }, - "Qualifier": { - "$ref": "#/definitions/Qualifier", - "description": "Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field." - } - }, - "required": [ - "PolicyQualifierId", - "Qualifier" - ], - "type": "object" - }, - "PolicyQualifierInfoList": { - "items": { - "$ref": "#/definitions/PolicyQualifierInfo" - }, - "type": "array" - }, - "Qualifier": { - "additionalProperties": false, - "description": "Defines a ``PolicyInformation`` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.", - "properties": { - "CpsUri": { - "description": "Contains a pointer to a certification practice statement (CPS) published by the CA.", - "type": "string" - } - }, - "required": [ - "CpsUri" - ], - "type": "object" - }, - "Rfc822Name": { - "description": "String that contains X.509 Rfc822Name information.", - "type": "string" - }, - "Subject": { - "additionalProperties": false, - "description": "Contains information about the certificate subject. The ``Subject`` field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The ``Subject``must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.", - "properties": { - "CommonName": { - "description": "For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.\n Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.", - "type": "string" - }, - "Country": { - "description": "Two-digit code that specifies the country in which the certificate subject located.", - "type": "string" - }, - "CustomAttributes": { - "$ref": "#/definitions/CustomAttributeList", - "description": "Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST\u2019s definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n Custom attributes cannot be used in combination with standard attributes." - }, - "DistinguishedNameQualifier": { - "description": "Disambiguating information for the certificate subject.", - "type": "string" - }, - "GenerationQualifier": { - "description": "Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.", - "type": "string" - }, - "GivenName": { - "description": "First name.", - "type": "string" - }, - "Initials": { - "description": "Concatenation that typically contains the first letter of the *GivenName*, the first letter of the middle name if one exists, and the first letter of the *Surname*.", - "type": "string" - }, - "Locality": { - "description": "The locality (such as a city or town) in which the certificate subject is located.", - "type": "string" - }, - "Organization": { - "description": "Legal name of the organization with which the certificate subject is affiliated.", - "type": "string" - }, - "OrganizationalUnit": { - "description": "A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.", - "type": "string" - }, - "Pseudonym": { - "description": "Typically a shortened version of a longer *GivenName*. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.", - "type": "string" - }, - "SerialNumber": { - "description": "The certificate serial number.", - "type": "string" - }, - "State": { - "description": "State in which the subject of the certificate is located.", - "type": "string" - }, - "Surname": { - "description": "Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.", - "type": "string" - }, - "Title": { - "description": "A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.", - "type": "string" - } - }, - "type": "object" - }, - "UniformResourceIdentifier": { - "description": "String that contains X.509 UniformResourceIdentifier information.", - "type": "string" - }, - "Validity": { - "additionalProperties": false, - "description": "Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the ``IssueCertificate`` operation.", - "properties": { - "Type": { - "description": "Specifies whether the ``Value`` parameter represents days, months, or years.", - "type": "string" - }, - "Value": { - "description": "A long integer interpreted according to the value of ``Type``, below.", - "type": "number" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - } - }, - "description": "The ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.", - "handlers": { - "create": { - "permissions": [ - "acm-pca:IssueCertificate", - "acm-pca:GetCertificate" - ] - }, - "delete": { - "permissions": [ - "acm-pca:GetCertificate" - ] - }, - "read": { - "permissions": [ - "acm-pca:GetCertificate" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn", - "/properties/CertificateAuthorityArn" - ], - "properties": { - "ApiPassthrough": { - "$ref": "#/definitions/ApiPassthrough", - "description": "Specifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored." - }, - "Arn": { - "$ref": "#/definitions/Arn", - "description": "" - }, - "Certificate": { - "description": "", - "type": "string" - }, - "CertificateAuthorityArn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) for the private CA issues the certificate." - }, - "CertificateSigningRequest": { - "description": "The certificate signing request (CSR) for the certificate.", - "minLength": 1, - "type": "string" - }, - "SigningAlgorithm": { - "description": "The name of the algorithm that will be used to sign the certificate to be issued. \n This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.\n The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.", - "type": "string" - }, - "TemplateArn": { - "$ref": "#/definitions/Arn", - "description": "Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html)." - }, - "Validity": { - "$ref": "#/definitions/Validity", - "description": "The period of time during which the certificate will be valid." - }, - "ValidityNotBefore": { - "$ref": "#/definitions/Validity", - "description": "Information describing the start of the validity period of the certificate. This parameter sets the \u201cNot Before\" date for the certificate.\n By default, when issuing a certificate, PCAshort sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the \u201cNot Before\u201d value. \n Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.\n The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``." - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Certificate" - ], - "required": [ - "CertificateAuthorityArn", - "CertificateSigningRequest", - "SigningAlgorithm", - "Validity" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ACMPCA::Certificate", - "writeOnlyProperties": [ - "/properties/ApiPassthrough", - "/properties/CertificateSigningRequest", - "/properties/SigningAlgorithm", - "/properties/TemplateArn", - "/properties/Validity", - "/properties/ValidityNotBefore" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiPassthrough", + "/properties/CertificateAuthorityArn", + "/properties/CertificateSigningRequest", + "/properties/SigningAlgorithm", + "/properties/TemplateArn", + "/properties/Validity", + "/properties/ValidityNotBefore" + ], + "definitions": { + "ApiPassthrough": { + "additionalProperties": false, + "description": "Contains X.509 certificate information to be placed in an issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored. \n If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.", + "properties": { + "Extensions": { + "$ref": "#/definitions/Extensions", + "description": "Specifies X.509 extension information for a certificate." + }, + "Subject": { + "$ref": "#/definitions/Subject", + "description": "Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate." + } + }, + "type": "object" + }, + "Arn": { + "type": "string" + }, + "CertificatePolicyList": { + "items": { + "$ref": "#/definitions/PolicyInformation" + }, + "type": "array" + }, + "CustomAttribute": { + "additionalProperties": false, + "description": "Defines the X.500 relative distinguished name (RDN).", + "properties": { + "ObjectIdentifier": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN)." + }, + "Value": { + "description": "Specifies the attribute value of relative distinguished name (RDN).", + "type": "string" + } + }, + "required": [ + "ObjectIdentifier", + "Value" + ], + "type": "object" + }, + "CustomAttributeList": { + "description": "Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.", + "items": { + "$ref": "#/definitions/CustomAttribute" + }, + "type": "array" + }, + "CustomExtension": { + "additionalProperties": false, + "description": "Specifies the X.509 extension information for a certificate.\n Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough`` [template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).", + "properties": { + "Critical": { + "description": "Specifies the critical flag of the X.509 extension.", + "type": "boolean" + }, + "ObjectIdentifier": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)" + }, + "Value": { + "description": "Specifies the base64-encoded value of the X.509 extension.", + "type": "string" + } + }, + "required": [ + "ObjectIdentifier", + "Value" + ], + "type": "object" + }, + "CustomExtensionList": { + "description": "Array of X.509 extensions for a certificate.", + "items": { + "$ref": "#/definitions/CustomExtension" + }, + "type": "array" + }, + "CustomObjectIdentifier": { + "description": "String that contains X.509 ObjectIdentifier information.", + "type": "string" + }, + "DnsName": { + "description": "String that contains X.509 DnsName information.", + "type": "string" + }, + "EdiPartyName": { + "additionalProperties": false, + "description": "Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.", + "properties": { + "NameAssigner": { + "description": "Specifies the name assigner.", + "type": "string" + }, + "PartyName": { + "description": "Specifies the party name.", + "type": "string" + } + }, + "required": [ + "PartyName", + "NameAssigner" + ], + "type": "object" + }, + "ExtendedKeyUsage": { + "additionalProperties": false, + "description": "Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.", + "properties": { + "ExtendedKeyUsageObjectIdentifier": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID)." + }, + "ExtendedKeyUsageType": { + "description": "Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).", + "type": "string" + } + }, + "type": "object" + }, + "ExtendedKeyUsageList": { + "items": { + "$ref": "#/definitions/ExtendedKeyUsage" + }, + "type": "array" + }, + "Extensions": { + "additionalProperties": false, + "description": "Contains X.509 extension information for a certificate.", + "properties": { + "CertificatePolicies": { + "$ref": "#/definitions/CertificatePolicyList", + "description": "Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate." + }, + "CustomExtensions": { + "$ref": "#/definitions/CustomExtensionList", + "description": "Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)" + }, + "ExtendedKeyUsage": { + "$ref": "#/definitions/ExtendedKeyUsageList", + "description": "Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension." + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage", + "description": "Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false." + }, + "SubjectAlternativeNames": { + "$ref": "#/definitions/GeneralNameList", + "description": "The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate." + } + }, + "type": "object" + }, + "GeneralName": { + "additionalProperties": false, + "description": "Describes an ASN.1 X.400 ``GeneralName`` as defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280). Only one of the following naming options should be provided. Providing more than one option results in an ``InvalidArgsException`` error.", + "properties": { + "DirectoryName": { + "$ref": "#/definitions/Subject", + "description": "Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity." + }, + "DnsName": { + "$ref": "#/definitions/DnsName", + "description": "Represents ``GeneralName`` as a DNS name." + }, + "EdiPartyName": { + "$ref": "#/definitions/EdiPartyName", + "description": "Represents ``GeneralName`` as an ``EdiPartyName`` object." + }, + "IpAddress": { + "$ref": "#/definitions/IpAddress", + "description": "Represents ``GeneralName`` as an IPv4 or IPv6 address." + }, + "OtherName": { + "$ref": "#/definitions/OtherName", + "description": "Represents ``GeneralName`` using an ``OtherName`` object." + }, + "RegisteredId": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Represents ``GeneralName`` as an object identifier (OID)." + }, + "Rfc822Name": { + "$ref": "#/definitions/Rfc822Name", + "description": "Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address." + }, + "UniformResourceIdentifier": { + "$ref": "#/definitions/UniformResourceIdentifier", + "description": "Represents ``GeneralName`` as a URI." + } + }, + "type": "object" + }, + "GeneralNameList": { + "items": { + "$ref": "#/definitions/GeneralName" + }, + "type": "array" + }, + "IpAddress": { + "description": "String that contains X.509 IpAddress information.", + "type": "string" + }, + "KeyUsage": { + "additionalProperties": false, + "description": "Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.", + "properties": { + "CRLSign": { + "default": false, + "description": "Key can be used to sign CRLs.", + "type": "boolean" + }, + "DataEncipherment": { + "default": false, + "description": "Key can be used to decipher data.", + "type": "boolean" + }, + "DecipherOnly": { + "default": false, + "description": "Key can be used only to decipher data.", + "type": "boolean" + }, + "DigitalSignature": { + "default": false, + "description": "Key can be used for digital signing.", + "type": "boolean" + }, + "EncipherOnly": { + "default": false, + "description": "Key can be used only to encipher data.", + "type": "boolean" + }, + "KeyAgreement": { + "default": false, + "description": "Key can be used in a key-agreement protocol.", + "type": "boolean" + }, + "KeyCertSign": { + "default": false, + "description": "Key can be used to sign certificates.", + "type": "boolean" + }, + "KeyEncipherment": { + "default": false, + "description": "Key can be used to encipher data.", + "type": "boolean" + }, + "NonRepudiation": { + "default": false, + "description": "Key can be used for non-repudiation.", + "type": "boolean" + } + }, + "type": "object" + }, + "OtherName": { + "additionalProperties": false, + "description": "Defines a custom ASN.1 X.400 ``GeneralName`` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).", + "properties": { + "TypeId": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Specifies an OID." + }, + "Value": { + "description": "Specifies an OID value.", + "type": "string" + } + }, + "required": [ + "TypeId", + "Value" + ], + "type": "object" + }, + "PolicyInformation": { + "additionalProperties": false, + "description": "Defines the X.509 ``CertificatePolicies`` extension.", + "properties": { + "CertPolicyId": { + "$ref": "#/definitions/CustomObjectIdentifier", + "description": "Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier)." + }, + "PolicyQualifiers": { + "$ref": "#/definitions/PolicyQualifierInfoList", + "description": "Modifies the given ``CertPolicyId`` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier." + } + }, + "required": [ + "CertPolicyId" + ], + "type": "object" + }, + "PolicyQualifierInfo": { + "additionalProperties": false, + "description": "Modifies the ``CertPolicyId`` of a ``PolicyInformation`` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.", + "properties": { + "PolicyQualifierId": { + "description": "Identifies the qualifier modifying a ``CertPolicyId``.", + "type": "string" + }, + "Qualifier": { + "$ref": "#/definitions/Qualifier", + "description": "Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field." + } + }, + "required": [ + "PolicyQualifierId", + "Qualifier" + ], + "type": "object" + }, + "PolicyQualifierInfoList": { + "items": { + "$ref": "#/definitions/PolicyQualifierInfo" + }, + "type": "array" + }, + "Qualifier": { + "additionalProperties": false, + "description": "Defines a ``PolicyInformation`` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.", + "properties": { + "CpsUri": { + "description": "Contains a pointer to a certification practice statement (CPS) published by the CA.", + "type": "string" + } + }, + "required": [ + "CpsUri" + ], + "type": "object" + }, + "Rfc822Name": { + "description": "String that contains X.509 Rfc822Name information.", + "type": "string" + }, + "Subject": { + "additionalProperties": false, + "description": "Contains information about the certificate subject. The ``Subject`` field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The ``Subject``must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.", + "properties": { + "CommonName": { + "description": "For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.\n Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.", + "type": "string" + }, + "Country": { + "description": "Two-digit code that specifies the country in which the certificate subject located.", + "type": "string" + }, + "CustomAttributes": { + "$ref": "#/definitions/CustomAttributeList", + "description": "Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST\u2019s definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n Custom attributes cannot be used in combination with standard attributes." + }, + "DistinguishedNameQualifier": { + "description": "Disambiguating information for the certificate subject.", + "type": "string" + }, + "GenerationQualifier": { + "description": "Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.", + "type": "string" + }, + "GivenName": { + "description": "First name.", + "type": "string" + }, + "Initials": { + "description": "Concatenation that typically contains the first letter of the *GivenName*, the first letter of the middle name if one exists, and the first letter of the *Surname*.", + "type": "string" + }, + "Locality": { + "description": "The locality (such as a city or town) in which the certificate subject is located.", + "type": "string" + }, + "Organization": { + "description": "Legal name of the organization with which the certificate subject is affiliated.", + "type": "string" + }, + "OrganizationalUnit": { + "description": "A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.", + "type": "string" + }, + "Pseudonym": { + "description": "Typically a shortened version of a longer *GivenName*. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.", + "type": "string" + }, + "SerialNumber": { + "description": "The certificate serial number.", + "type": "string" + }, + "State": { + "description": "State in which the subject of the certificate is located.", + "type": "string" + }, + "Surname": { + "description": "Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.", + "type": "string" + }, + "Title": { + "description": "A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.", + "type": "string" + } + }, + "type": "object" + }, + "UniformResourceIdentifier": { + "description": "String that contains X.509 UniformResourceIdentifier information.", + "type": "string" + }, + "Validity": { + "additionalProperties": false, + "description": "Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the ``IssueCertificate`` operation.", + "properties": { + "Type": { + "description": "Specifies whether the ``Value`` parameter represents days, months, or years.", + "type": "string" + }, + "Value": { + "description": "A long integer interpreted according to the value of ``Type``, below.", + "type": "number" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + } + }, + "description": "The ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.", + "handlers": { + "create": { + "permissions": [ + "acm-pca:IssueCertificate", + "acm-pca:GetCertificate" + ] + }, + "delete": { + "permissions": [ + "acm-pca:GetCertificate" + ] + }, + "read": { + "permissions": [ + "acm-pca:GetCertificate" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn", + "/properties/CertificateAuthorityArn" + ], + "properties": { + "ApiPassthrough": { + "$ref": "#/definitions/ApiPassthrough", + "description": "Specifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored." + }, + "Arn": { + "$ref": "#/definitions/Arn", + "description": "" + }, + "Certificate": { + "description": "", + "type": "string" + }, + "CertificateAuthorityArn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) for the private CA issues the certificate." + }, + "CertificateSigningRequest": { + "description": "The certificate signing request (CSR) for the certificate.", + "minLength": 1, + "type": "string" + }, + "SigningAlgorithm": { + "description": "The name of the algorithm that will be used to sign the certificate to be issued. \n This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.\n The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.", + "type": "string" + }, + "TemplateArn": { + "$ref": "#/definitions/Arn", + "description": "Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html)." + }, + "Validity": { + "$ref": "#/definitions/Validity", + "description": "The period of time during which the certificate will be valid." + }, + "ValidityNotBefore": { + "$ref": "#/definitions/Validity", + "description": "Information describing the start of the validity period of the certificate. This parameter sets the \u201cNot Before\" date for the certificate.\n By default, when issuing a certificate, PCAshort sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the \u201cNot Before\u201d value. \n Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.\n The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``." + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Certificate" + ], + "required": [ + "CertificateAuthorityArn", + "CertificateSigningRequest", + "SigningAlgorithm", + "Validity" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ACMPCA::Certificate", + "writeOnlyProperties": [ + "/properties/ApiPassthrough", + "/properties/CertificateSigningRequest", + "/properties/SigningAlgorithm", + "/properties/TemplateArn", + "/properties/Validity", + "/properties/ValidityNotBefore" + ] +} diff --git a/schema/aws-acmpca-certificateauthority.json b/schema/aws-acmpca-certificateauthority.json index b6dd23a..73be4c9 100644 --- a/schema/aws-acmpca-certificateauthority.json +++ b/schema/aws-acmpca-certificateauthority.json @@ -1,476 +1,476 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/KeyAlgorithm", - "/properties/SigningAlgorithm", - "/properties/Subject", - "/properties/CsrExtensions", - "/properties/KeyStorageSecurityStandard", - "/properties/UsageMode" - ], - "definitions": { - "AccessDescription": { - "additionalProperties": false, - "description": "Structure that contains X.509 AccessDescription information.", - "properties": { - "AccessLocation": { - "$ref": "#/definitions/GeneralName" - }, - "AccessMethod": { - "$ref": "#/definitions/AccessMethod" - } - }, - "required": [ - "AccessMethod", - "AccessLocation" - ], - "type": "object" - }, - "AccessMethod": { - "additionalProperties": false, - "description": "Structure that contains X.509 AccessMethod information. Assign one and ONLY one field.", - "properties": { - "AccessMethodType": { - "$ref": "#/definitions/AccessMethodType" - }, - "CustomObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier" - } - }, - "type": "object" - }, - "AccessMethodType": { - "description": "Pre-defined enum string for X.509 AccessMethod ObjectIdentifiers.", - "type": "string" - }, - "Arn": { - "type": "string" - }, - "CrlConfiguration": { - "additionalProperties": false, - "description": "Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.", - "properties": { - "CrlDistributionPointExtensionConfiguration": { - "$ref": "#/definitions/CrlDistributionPointExtensionConfiguration" - }, - "CustomCname": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "ExpirationInDays": { - "type": "integer" - }, - "S3BucketName": { - "type": "string" - }, - "S3ObjectAcl": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "CrlDistributionPointExtensionConfiguration": { - "additionalProperties": false, - "description": "Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority", - "properties": { - "OmitExtension": { - "type": "boolean" - } - }, - "required": [ - "OmitExtension" - ], - "type": "object" - }, - "CsrExtensions": { - "additionalProperties": false, - "description": "Structure that contains CSR pass though extensions information.", - "properties": { - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - }, - "SubjectInformationAccess": { - "$ref": "#/definitions/SubjectInformationAccess" - } - }, - "type": "object" - }, - "CustomAttribute": { - "additionalProperties": false, - "description": "Structure that contains X.500 attribute type and value.", - "properties": { - "ObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "ObjectIdentifier", - "Value" - ], - "type": "object" - }, - "CustomAttributeList": { - "description": "Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.", - "items": { - "$ref": "#/definitions/CustomAttribute" - }, - "type": "array" - }, - "CustomObjectIdentifier": { - "description": "String that contains X.509 ObjectIdentifier information.", - "type": "string" - }, - "DnsName": { - "description": "String that contains X.509 DnsName information.", - "type": "string" - }, - "EdiPartyName": { - "additionalProperties": false, - "description": "Structure that contains X.509 EdiPartyName information.", - "properties": { - "NameAssigner": { - "type": "string" - }, - "PartyName": { - "type": "string" - } - }, - "required": [ - "PartyName" - ], - "type": "object" - }, - "GeneralName": { - "additionalProperties": false, - "description": "Structure that contains X.509 GeneralName information. Assign one and ONLY one field.", - "properties": { - "DirectoryName": { - "$ref": "#/definitions/Subject" - }, - "DnsName": { - "$ref": "#/definitions/DnsName" - }, - "EdiPartyName": { - "$ref": "#/definitions/EdiPartyName" - }, - "IpAddress": { - "$ref": "#/definitions/IpAddress" - }, - "OtherName": { - "$ref": "#/definitions/OtherName" - }, - "RegisteredId": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Rfc822Name": { - "$ref": "#/definitions/Rfc822Name" - }, - "UniformResourceIdentifier": { - "$ref": "#/definitions/UniformResourceIdentifier" - } - }, - "type": "object" - }, - "IpAddress": { - "description": "String that contains X.509 IpAddress information.", - "type": "string" - }, - "KeyUsage": { - "additionalProperties": false, - "description": "Structure that contains X.509 KeyUsage information.", - "properties": { - "CRLSign": { - "default": false, - "type": "boolean" - }, - "DataEncipherment": { - "default": false, - "type": "boolean" - }, - "DecipherOnly": { - "default": false, - "type": "boolean" - }, - "DigitalSignature": { - "default": false, - "type": "boolean" - }, - "EncipherOnly": { - "default": false, - "type": "boolean" - }, - "KeyAgreement": { - "default": false, - "type": "boolean" - }, - "KeyCertSign": { - "default": false, - "type": "boolean" - }, - "KeyEncipherment": { - "default": false, - "type": "boolean" - }, - "NonRepudiation": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "OcspConfiguration": { - "additionalProperties": false, - "description": "Helps to configure online certificate status protocol (OCSP) responder for your certificate authority", - "properties": { - "Enabled": { - "type": "boolean" - }, - "OcspCustomCname": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "OtherName": { - "additionalProperties": false, - "description": "Structure that contains X.509 OtherName information.", - "properties": { - "TypeId": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "TypeId", - "Value" - ], - "type": "object" - }, - "RevocationConfiguration": { - "additionalProperties": false, - "description": "Certificate Authority revocation information.", - "properties": { - "CrlConfiguration": { - "$ref": "#/definitions/CrlConfiguration" - }, - "OcspConfiguration": { - "$ref": "#/definitions/OcspConfiguration" - } - }, - "type": "object" - }, - "Rfc822Name": { - "description": "String that contains X.509 Rfc822Name information.", - "type": "string" - }, - "Subject": { - "additionalProperties": false, - "description": "Structure that contains X.500 distinguished name information for your CA.", - "properties": { - "CommonName": { - "type": "string" - }, - "Country": { - "type": "string" - }, - "CustomAttributes": { - "$ref": "#/definitions/CustomAttributeList" - }, - "DistinguishedNameQualifier": { - "type": "string" - }, - "GenerationQualifier": { - "type": "string" - }, - "GivenName": { - "type": "string" - }, - "Initials": { - "type": "string" - }, - "Locality": { - "type": "string" - }, - "Organization": { - "type": "string" - }, - "OrganizationalUnit": { - "type": "string" - }, - "Pseudonym": { - "type": "string" - }, - "SerialNumber": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Surname": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "SubjectInformationAccess": { - "description": "Array of X.509 AccessDescription.", - "items": { - "$ref": "#/definitions/AccessDescription" - }, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "UniformResourceIdentifier": { - "description": "String that contains X.509 UniformResourceIdentifier information.", - "type": "string" - } - }, - "description": "Private certificate authority.", - "handlers": { - "create": { - "permissions": [ - "acm-pca:CreateCertificateAuthority", - "acm-pca:DescribeCertificateAuthority", - "acm-pca:GetCertificateAuthorityCsr" - ] - }, - "delete": { - "permissions": [ - "acm-pca:DeleteCertificateAuthority", - "acm-pca:DescribeCertificateAuthority" - ] - }, - "list": { - "permissions": [ - "acm-pca:DescribeCertificateAuthority", - "acm-pca:GetCertificateAuthorityCsr", - "acm-pca:ListCertificateAuthorities", - "acm-pca:ListTags" - ] - }, - "read": { - "permissions": [ - "acm-pca:DescribeCertificateAuthority", - "acm-pca:GetCertificateAuthorityCsr", - "acm-pca:ListTags" - ] - }, - "update": { - "permissions": [ - "acm-pca:ListTags", - "acm-pca:TagCertificateAuthority", - "acm-pca:UntagCertificateAuthority", - "acm-pca:UpdateCertificateAuthority" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the certificate authority." - }, - "CertificateSigningRequest": { - "description": "The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.", - "type": "string" - }, - "CsrExtensions": { - "$ref": "#/definitions/CsrExtensions", - "description": "Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action." - }, - "KeyAlgorithm": { - "description": "Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.", - "type": "string" - }, - "KeyStorageSecurityStandard": { - "description": "KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.", - "type": "string" - }, - "RevocationConfiguration": { - "$ref": "#/definitions/RevocationConfiguration", - "description": "Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions." - }, - "SigningAlgorithm": { - "description": "Algorithm your CA uses to sign certificate requests.", - "type": "string" - }, - "Subject": { - "$ref": "#/definitions/Subject", - "description": "Structure that contains X.500 distinguished name information for your CA." - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "description": "The type of the certificate authority.", - "type": "string" - }, - "UsageMode": { - "description": "Usage mode of the ceritificate authority.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CertificateSigningRequest" - ], - "required": [ - "Type", - "KeyAlgorithm", - "SigningAlgorithm", - "Subject" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ACMPCA::CertificateAuthority", - "writeOnlyProperties": [ - "/properties/Subject", - "/properties/Subject", - "/properties/CsrExtensions", - "/properties/Tags", - "/properties/RevocationConfiguration", - "/properties/KeyStorageSecurityStandard" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/KeyAlgorithm", + "/properties/SigningAlgorithm", + "/properties/Subject", + "/properties/CsrExtensions", + "/properties/KeyStorageSecurityStandard", + "/properties/UsageMode" + ], + "definitions": { + "AccessDescription": { + "additionalProperties": false, + "description": "Structure that contains X.509 AccessDescription information.", + "properties": { + "AccessLocation": { + "$ref": "#/definitions/GeneralName" + }, + "AccessMethod": { + "$ref": "#/definitions/AccessMethod" + } + }, + "required": [ + "AccessMethod", + "AccessLocation" + ], + "type": "object" + }, + "AccessMethod": { + "additionalProperties": false, + "description": "Structure that contains X.509 AccessMethod information. Assign one and ONLY one field.", + "properties": { + "AccessMethodType": { + "$ref": "#/definitions/AccessMethodType" + }, + "CustomObjectIdentifier": { + "$ref": "#/definitions/CustomObjectIdentifier" + } + }, + "type": "object" + }, + "AccessMethodType": { + "description": "Pre-defined enum string for X.509 AccessMethod ObjectIdentifiers.", + "type": "string" + }, + "Arn": { + "type": "string" + }, + "CrlConfiguration": { + "additionalProperties": false, + "description": "Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.", + "properties": { + "CrlDistributionPointExtensionConfiguration": { + "$ref": "#/definitions/CrlDistributionPointExtensionConfiguration" + }, + "CustomCname": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "ExpirationInDays": { + "type": "integer" + }, + "S3BucketName": { + "type": "string" + }, + "S3ObjectAcl": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "CrlDistributionPointExtensionConfiguration": { + "additionalProperties": false, + "description": "Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority", + "properties": { + "OmitExtension": { + "type": "boolean" + } + }, + "required": [ + "OmitExtension" + ], + "type": "object" + }, + "CsrExtensions": { + "additionalProperties": false, + "description": "Structure that contains CSR pass though extensions information.", + "properties": { + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + }, + "SubjectInformationAccess": { + "$ref": "#/definitions/SubjectInformationAccess" + } + }, + "type": "object" + }, + "CustomAttribute": { + "additionalProperties": false, + "description": "Structure that contains X.500 attribute type and value.", + "properties": { + "ObjectIdentifier": { + "$ref": "#/definitions/CustomObjectIdentifier" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "ObjectIdentifier", + "Value" + ], + "type": "object" + }, + "CustomAttributeList": { + "description": "Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.", + "items": { + "$ref": "#/definitions/CustomAttribute" + }, + "type": "array" + }, + "CustomObjectIdentifier": { + "description": "String that contains X.509 ObjectIdentifier information.", + "type": "string" + }, + "DnsName": { + "description": "String that contains X.509 DnsName information.", + "type": "string" + }, + "EdiPartyName": { + "additionalProperties": false, + "description": "Structure that contains X.509 EdiPartyName information.", + "properties": { + "NameAssigner": { + "type": "string" + }, + "PartyName": { + "type": "string" + } + }, + "required": [ + "PartyName" + ], + "type": "object" + }, + "GeneralName": { + "additionalProperties": false, + "description": "Structure that contains X.509 GeneralName information. Assign one and ONLY one field.", + "properties": { + "DirectoryName": { + "$ref": "#/definitions/Subject" + }, + "DnsName": { + "$ref": "#/definitions/DnsName" + }, + "EdiPartyName": { + "$ref": "#/definitions/EdiPartyName" + }, + "IpAddress": { + "$ref": "#/definitions/IpAddress" + }, + "OtherName": { + "$ref": "#/definitions/OtherName" + }, + "RegisteredId": { + "$ref": "#/definitions/CustomObjectIdentifier" + }, + "Rfc822Name": { + "$ref": "#/definitions/Rfc822Name" + }, + "UniformResourceIdentifier": { + "$ref": "#/definitions/UniformResourceIdentifier" + } + }, + "type": "object" + }, + "IpAddress": { + "description": "String that contains X.509 IpAddress information.", + "type": "string" + }, + "KeyUsage": { + "additionalProperties": false, + "description": "Structure that contains X.509 KeyUsage information.", + "properties": { + "CRLSign": { + "default": false, + "type": "boolean" + }, + "DataEncipherment": { + "default": false, + "type": "boolean" + }, + "DecipherOnly": { + "default": false, + "type": "boolean" + }, + "DigitalSignature": { + "default": false, + "type": "boolean" + }, + "EncipherOnly": { + "default": false, + "type": "boolean" + }, + "KeyAgreement": { + "default": false, + "type": "boolean" + }, + "KeyCertSign": { + "default": false, + "type": "boolean" + }, + "KeyEncipherment": { + "default": false, + "type": "boolean" + }, + "NonRepudiation": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "OcspConfiguration": { + "additionalProperties": false, + "description": "Helps to configure online certificate status protocol (OCSP) responder for your certificate authority", + "properties": { + "Enabled": { + "type": "boolean" + }, + "OcspCustomCname": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "OtherName": { + "additionalProperties": false, + "description": "Structure that contains X.509 OtherName information.", + "properties": { + "TypeId": { + "$ref": "#/definitions/CustomObjectIdentifier" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "TypeId", + "Value" + ], + "type": "object" + }, + "RevocationConfiguration": { + "additionalProperties": false, + "description": "Certificate Authority revocation information.", + "properties": { + "CrlConfiguration": { + "$ref": "#/definitions/CrlConfiguration" + }, + "OcspConfiguration": { + "$ref": "#/definitions/OcspConfiguration" + } + }, + "type": "object" + }, + "Rfc822Name": { + "description": "String that contains X.509 Rfc822Name information.", + "type": "string" + }, + "Subject": { + "additionalProperties": false, + "description": "Structure that contains X.500 distinguished name information for your CA.", + "properties": { + "CommonName": { + "type": "string" + }, + "Country": { + "type": "string" + }, + "CustomAttributes": { + "$ref": "#/definitions/CustomAttributeList" + }, + "DistinguishedNameQualifier": { + "type": "string" + }, + "GenerationQualifier": { + "type": "string" + }, + "GivenName": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Locality": { + "type": "string" + }, + "Organization": { + "type": "string" + }, + "OrganizationalUnit": { + "type": "string" + }, + "Pseudonym": { + "type": "string" + }, + "SerialNumber": { + "type": "string" + }, + "State": { + "type": "string" + }, + "Surname": { + "type": "string" + }, + "Title": { + "type": "string" + } + }, + "type": "object" + }, + "SubjectInformationAccess": { + "description": "Array of X.509 AccessDescription.", + "items": { + "$ref": "#/definitions/AccessDescription" + }, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "UniformResourceIdentifier": { + "description": "String that contains X.509 UniformResourceIdentifier information.", + "type": "string" + } + }, + "description": "Private certificate authority.", + "handlers": { + "create": { + "permissions": [ + "acm-pca:CreateCertificateAuthority", + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificateAuthorityCsr" + ] + }, + "delete": { + "permissions": [ + "acm-pca:DeleteCertificateAuthority", + "acm-pca:DescribeCertificateAuthority" + ] + }, + "list": { + "permissions": [ + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificateAuthorityCsr", + "acm-pca:ListCertificateAuthorities", + "acm-pca:ListTags" + ] + }, + "read": { + "permissions": [ + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificateAuthorityCsr", + "acm-pca:ListTags" + ] + }, + "update": { + "permissions": [ + "acm-pca:ListTags", + "acm-pca:TagCertificateAuthority", + "acm-pca:UntagCertificateAuthority", + "acm-pca:UpdateCertificateAuthority" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the certificate authority." + }, + "CertificateSigningRequest": { + "description": "The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.", + "type": "string" + }, + "CsrExtensions": { + "$ref": "#/definitions/CsrExtensions", + "description": "Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action." + }, + "KeyAlgorithm": { + "description": "Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.", + "type": "string" + }, + "KeyStorageSecurityStandard": { + "description": "KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.", + "type": "string" + }, + "RevocationConfiguration": { + "$ref": "#/definitions/RevocationConfiguration", + "description": "Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions." + }, + "SigningAlgorithm": { + "description": "Algorithm your CA uses to sign certificate requests.", + "type": "string" + }, + "Subject": { + "$ref": "#/definitions/Subject", + "description": "Structure that contains X.500 distinguished name information for your CA." + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Type": { + "description": "The type of the certificate authority.", + "type": "string" + }, + "UsageMode": { + "description": "Usage mode of the ceritificate authority.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CertificateSigningRequest" + ], + "required": [ + "Type", + "KeyAlgorithm", + "SigningAlgorithm", + "Subject" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ACMPCA::CertificateAuthority", + "writeOnlyProperties": [ + "/properties/Subject", + "/properties/Subject", + "/properties/CsrExtensions", + "/properties/Tags", + "/properties/RevocationConfiguration", + "/properties/KeyStorageSecurityStandard" + ] +} diff --git a/schema/aws-acmpca-certificateauthorityactivation.json b/schema/aws-acmpca-certificateauthorityactivation.json index 014d4b9..f99f0ed 100644 --- a/schema/aws-acmpca-certificateauthorityactivation.json +++ b/schema/aws-acmpca-certificateauthorityactivation.json @@ -1,76 +1,76 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateAuthorityArn" - ], - "description": "Used to install the certificate authority certificate and update the certificate authority status.", - "handlers": { - "create": { - "permissions": [ - "acm-pca:ImportCertificateAuthorityCertificate", - "acm-pca:UpdateCertificateAuthority" - ] - }, - "delete": { - "permissions": [ - "acm-pca:UpdateCertificateAuthority" - ] - }, - "read": { - "permissions": [ - "acm-pca:GetCertificateAuthorityCertificate", - "acm-pca:DescribeCertificateAuthority" - ] - }, - "update": { - "permissions": [ - "acm-pca:ImportCertificateAuthorityCertificate", - "acm-pca:UpdateCertificateAuthority" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateAuthorityArn" - ], - "properties": { - "Certificate": { - "description": "Certificate Authority certificate that will be installed in the Certificate Authority.", - "type": "string" - }, - "CertificateAuthorityArn": { - "description": "Arn of the Certificate Authority.", - "type": "string" - }, - "CertificateChain": { - "description": "Certificate chain for the Certificate Authority certificate.", - "type": "string" - }, - "CompleteCertificateChain": { - "description": "The complete certificate chain, including the Certificate Authority certificate.", - "type": "string" - }, - "Status": { - "description": "The status of the Certificate Authority.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CompleteCertificateChain" - ], - "required": [ - "CertificateAuthorityArn", - "Certificate" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ACMPCA::CertificateAuthorityActivation", - "writeOnlyProperties": [ - "/properties/Certificate", - "/properties/CertificateChain" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateAuthorityArn" + ], + "description": "Used to install the certificate authority certificate and update the certificate authority status.", + "handlers": { + "create": { + "permissions": [ + "acm-pca:ImportCertificateAuthorityCertificate", + "acm-pca:UpdateCertificateAuthority" + ] + }, + "delete": { + "permissions": [ + "acm-pca:UpdateCertificateAuthority" + ] + }, + "read": { + "permissions": [ + "acm-pca:GetCertificateAuthorityCertificate", + "acm-pca:DescribeCertificateAuthority" + ] + }, + "update": { + "permissions": [ + "acm-pca:ImportCertificateAuthorityCertificate", + "acm-pca:UpdateCertificateAuthority" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateAuthorityArn" + ], + "properties": { + "Certificate": { + "description": "Certificate Authority certificate that will be installed in the Certificate Authority.", + "type": "string" + }, + "CertificateAuthorityArn": { + "description": "Arn of the Certificate Authority.", + "type": "string" + }, + "CertificateChain": { + "description": "Certificate chain for the Certificate Authority certificate.", + "type": "string" + }, + "CompleteCertificateChain": { + "description": "The complete certificate chain, including the Certificate Authority certificate.", + "type": "string" + }, + "Status": { + "description": "The status of the Certificate Authority.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CompleteCertificateChain" + ], + "required": [ + "CertificateAuthorityArn", + "Certificate" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ACMPCA::CertificateAuthorityActivation", + "writeOnlyProperties": [ + "/properties/Certificate", + "/properties/CertificateChain" + ] +} diff --git a/schema/aws-acmpca-permission.json b/schema/aws-acmpca-permission.json index b821363..3906fed 100644 --- a/schema/aws-acmpca-permission.json +++ b/schema/aws-acmpca-permission.json @@ -1,67 +1,67 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Actions", - "/properties/CertificateAuthorityArn", - "/properties/Principal", - "/properties/SourceAccount" - ], - "description": "Permission set on private certificate authority", - "handlers": { - "create": { - "permissions": [ - "acm-pca:CreatePermission", - "acm-pca:ListPermissions" - ] - }, - "delete": { - "permissions": [ - "acm-pca:DeletePermission" - ] - }, - "read": { - "permissions": [ - "acm-pca:ListPermissions" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateAuthorityArn", - "/properties/Principal" - ], - "properties": { - "Actions": { - "description": "The actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "CertificateAuthorityArn": { - "description": "The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.", - "type": "string" - }, - "Principal": { - "description": "The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.", - "type": "string" - }, - "SourceAccount": { - "description": "The ID of the calling account.", - "type": "string" - } - }, - "required": [ - "Actions", - "CertificateAuthorityArn", - "Principal" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ACMPCA::Permission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Actions", + "/properties/CertificateAuthorityArn", + "/properties/Principal", + "/properties/SourceAccount" + ], + "description": "Permission set on private certificate authority", + "handlers": { + "create": { + "permissions": [ + "acm-pca:CreatePermission", + "acm-pca:ListPermissions" + ] + }, + "delete": { + "permissions": [ + "acm-pca:DeletePermission" + ] + }, + "read": { + "permissions": [ + "acm-pca:ListPermissions" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateAuthorityArn", + "/properties/Principal" + ], + "properties": { + "Actions": { + "description": "The actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "CertificateAuthorityArn": { + "description": "The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.", + "type": "string" + }, + "Principal": { + "description": "The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.", + "type": "string" + }, + "SourceAccount": { + "description": "The ID of the calling account.", + "type": "string" + } + }, + "required": [ + "Actions", + "CertificateAuthorityArn", + "Principal" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ACMPCA::Permission" +} diff --git a/schema/aws-amazonmq-broker.json b/schema/aws-amazonmq-broker.json index 1c0c334..9e38032 100644 --- a/schema/aws-amazonmq-broker.json +++ b/schema/aws-amazonmq-broker.json @@ -1,332 +1,332 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BrokerName", - "/properties/StorageType", - "/properties/DeploymentMode", - "/properties/EngineType", - "/properties/SubnetIds", - "/properties/AuthenticationStrategy", - "/properties/EncryptionOptions", - "/properties/PubliclyAccessible" - ], - "definitions": { - "ConfigurationId": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Revision": { - "type": "integer" - } - }, - "required": [ - "Revision", - "Id" - ], - "type": "object" - }, - "EncryptionOptions": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "UseAwsOwnedKey": { - "type": "boolean" - } - }, - "required": [ - "UseAwsOwnedKey" - ], - "type": "object" - }, - "LdapServerMetadata": { - "additionalProperties": false, - "properties": { - "Hosts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RoleBase": { - "type": "string" - }, - "RoleName": { - "type": "string" - }, - "RoleSearchMatching": { - "type": "string" - }, - "RoleSearchSubtree": { - "type": "boolean" - }, - "ServiceAccountPassword": { - "type": "string" - }, - "ServiceAccountUsername": { - "type": "string" - }, - "UserBase": { - "type": "string" - }, - "UserRoleName": { - "type": "string" - }, - "UserSearchMatching": { - "type": "string" - }, - "UserSearchSubtree": { - "type": "boolean" - } - }, - "required": [ - "Hosts", - "UserSearchMatching", - "UserBase", - "RoleSearchMatching", - "ServiceAccountUsername", - "RoleBase", - "ServiceAccountPassword" - ], - "type": "object" - }, - "LogList": { - "additionalProperties": false, - "properties": { - "Audit": { - "type": "boolean" - }, - "General": { - "type": "boolean" - } - }, - "type": "object" - }, - "MaintenanceWindow": { - "additionalProperties": false, - "properties": { - "DayOfWeek": { - "type": "string" - }, - "TimeOfDay": { - "type": "string" - }, - "TimeZone": { - "type": "string" - } - }, - "required": [ - "DayOfWeek", - "TimeOfDay", - "TimeZone" - ], - "type": "object" - }, - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "User": { - "additionalProperties": false, - "properties": { - "ConsoleAccess": { - "type": "boolean" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Password": { - "type": "string" - }, - "ReplicationUser": { - "type": "boolean" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AmazonMQ::Broker", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AmqpEndpoints": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Arn": { - "type": "string" - }, - "AuthenticationStrategy": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "BrokerName": { - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/ConfigurationId" - }, - "ConfigurationId": { - "type": "string" - }, - "ConfigurationRevision": { - "type": "integer" - }, - "DataReplicationMode": { - "type": "string" - }, - "DataReplicationPrimaryBrokerArn": { - "type": "string" - }, - "DeploymentMode": { - "type": "string" - }, - "EncryptionOptions": { - "$ref": "#/definitions/EncryptionOptions" - }, - "EngineType": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "HostInstanceType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IpAddresses": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LdapServerMetadata": { - "$ref": "#/definitions/LdapServerMetadata" - }, - "Logs": { - "$ref": "#/definitions/LogList" - }, - "MaintenanceWindowStartTime": { - "$ref": "#/definitions/MaintenanceWindow" - }, - "MqttEndpoints": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "OpenWireEndpoints": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StompEndpoints": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StorageType": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - }, - "Users": { - "items": { - "$ref": "#/definitions/User" - }, - "type": "array", - "uniqueItems": false - }, - "WssEndpoints": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/IpAddresses", - "/properties/Id", - "/properties/MqttEndpoints", - "/properties/OpenWireEndpoints", - "/properties/ConfigurationId", - "/properties/ConfigurationRevision", - "/properties/StompEndpoints", - "/properties/WssEndpoints", - "/properties/AmqpEndpoints", - "/properties/Arn" - ], - "required": [ - "DeploymentMode", - "HostInstanceType", - "EngineType", - "Users", - "PubliclyAccessible", - "BrokerName" - ], - "typeName": "AWS::AmazonMQ::Broker" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BrokerName", + "/properties/StorageType", + "/properties/DeploymentMode", + "/properties/EngineType", + "/properties/SubnetIds", + "/properties/AuthenticationStrategy", + "/properties/EncryptionOptions", + "/properties/PubliclyAccessible" + ], + "definitions": { + "ConfigurationId": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Revision": { + "type": "integer" + } + }, + "required": [ + "Revision", + "Id" + ], + "type": "object" + }, + "EncryptionOptions": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "type": "string" + }, + "UseAwsOwnedKey": { + "type": "boolean" + } + }, + "required": [ + "UseAwsOwnedKey" + ], + "type": "object" + }, + "LdapServerMetadata": { + "additionalProperties": false, + "properties": { + "Hosts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RoleBase": { + "type": "string" + }, + "RoleName": { + "type": "string" + }, + "RoleSearchMatching": { + "type": "string" + }, + "RoleSearchSubtree": { + "type": "boolean" + }, + "ServiceAccountPassword": { + "type": "string" + }, + "ServiceAccountUsername": { + "type": "string" + }, + "UserBase": { + "type": "string" + }, + "UserRoleName": { + "type": "string" + }, + "UserSearchMatching": { + "type": "string" + }, + "UserSearchSubtree": { + "type": "boolean" + } + }, + "required": [ + "Hosts", + "UserSearchMatching", + "UserBase", + "RoleSearchMatching", + "ServiceAccountUsername", + "RoleBase", + "ServiceAccountPassword" + ], + "type": "object" + }, + "LogList": { + "additionalProperties": false, + "properties": { + "Audit": { + "type": "boolean" + }, + "General": { + "type": "boolean" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "additionalProperties": false, + "properties": { + "DayOfWeek": { + "type": "string" + }, + "TimeOfDay": { + "type": "string" + }, + "TimeZone": { + "type": "string" + } + }, + "required": [ + "DayOfWeek", + "TimeOfDay", + "TimeZone" + ], + "type": "object" + }, + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "User": { + "additionalProperties": false, + "properties": { + "ConsoleAccess": { + "type": "boolean" + }, + "Groups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Password": { + "type": "string" + }, + "ReplicationUser": { + "type": "boolean" + }, + "Username": { + "type": "string" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AmazonMQ::Broker", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AmqpEndpoints": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Arn": { + "type": "string" + }, + "AuthenticationStrategy": { + "type": "string" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "BrokerName": { + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/ConfigurationId" + }, + "ConfigurationId": { + "type": "string" + }, + "ConfigurationRevision": { + "type": "integer" + }, + "DataReplicationMode": { + "type": "string" + }, + "DataReplicationPrimaryBrokerArn": { + "type": "string" + }, + "DeploymentMode": { + "type": "string" + }, + "EncryptionOptions": { + "$ref": "#/definitions/EncryptionOptions" + }, + "EngineType": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "HostInstanceType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IpAddresses": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LdapServerMetadata": { + "$ref": "#/definitions/LdapServerMetadata" + }, + "Logs": { + "$ref": "#/definitions/LogList" + }, + "MaintenanceWindowStartTime": { + "$ref": "#/definitions/MaintenanceWindow" + }, + "MqttEndpoints": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "OpenWireEndpoints": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "SecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StompEndpoints": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StorageType": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + }, + "Users": { + "items": { + "$ref": "#/definitions/User" + }, + "type": "array", + "uniqueItems": false + }, + "WssEndpoints": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/IpAddresses", + "/properties/Id", + "/properties/MqttEndpoints", + "/properties/OpenWireEndpoints", + "/properties/ConfigurationId", + "/properties/ConfigurationRevision", + "/properties/StompEndpoints", + "/properties/WssEndpoints", + "/properties/AmqpEndpoints", + "/properties/Arn" + ], + "required": [ + "DeploymentMode", + "HostInstanceType", + "EngineType", + "Users", + "PubliclyAccessible", + "BrokerName" + ], + "typeName": "AWS::AmazonMQ::Broker" +} diff --git a/schema/aws-amazonmq-configuration.json b/schema/aws-amazonmq-configuration.json index b6b88b1..02591b4 100644 --- a/schema/aws-amazonmq-configuration.json +++ b/schema/aws-amazonmq-configuration.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EngineType", - "/properties/Name", - "/properties/AuthenticationStrategy", - "/properties/EngineVersion" - ], - "definitions": { - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AmazonMQ::Configuration", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AuthenticationStrategy": { - "type": "string" - }, - "Data": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EngineType": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Revision": { - "type": "integer" - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Revision", - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "EngineType", - "Data", - "Name" - ], - "typeName": "AWS::AmazonMQ::Configuration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EngineType", + "/properties/Name", + "/properties/AuthenticationStrategy", + "/properties/EngineVersion" + ], + "definitions": { + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AmazonMQ::Configuration", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AuthenticationStrategy": { + "type": "string" + }, + "Data": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "EngineType": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Revision": { + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Revision", + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "EngineType", + "Data", + "Name" + ], + "typeName": "AWS::AmazonMQ::Configuration" +} diff --git a/schema/aws-amazonmq-configurationassociation.json b/schema/aws-amazonmq-configurationassociation.json index ccbb199..d657619 100644 --- a/schema/aws-amazonmq-configurationassociation.json +++ b/schema/aws-amazonmq-configurationassociation.json @@ -1,47 +1,47 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Broker" - ], - "definitions": { - "ConfigurationId": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Revision": { - "type": "integer" - } - }, - "required": [ - "Revision", - "Id" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AmazonMQ::ConfigurationAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Broker": { - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/ConfigurationId" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Configuration", - "Broker" - ], - "typeName": "AWS::AmazonMQ::ConfigurationAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Broker" + ], + "definitions": { + "ConfigurationId": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Revision": { + "type": "integer" + } + }, + "required": [ + "Revision", + "Id" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AmazonMQ::ConfigurationAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Broker": { + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/ConfigurationId" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Configuration", + "Broker" + ], + "typeName": "AWS::AmazonMQ::ConfigurationAssociation" +} diff --git a/schema/aws-amplify-app.json b/schema/aws-amplify-app.json index 12cd3e0..cf8d490 100644 --- a/schema/aws-amplify-app.json +++ b/schema/aws-amplify-app.json @@ -1,346 +1,363 @@ -{ - "additionalProperties": false, - "definitions": { - "AutoBranchCreationConfig": { - "additionalProperties": false, - "properties": { - "AutoBranchCreationPatterns": { - "items": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BasicAuthConfig": { - "$ref": "#/definitions/BasicAuthConfig" - }, - "BuildSpec": { - "maxLength": 25000, - "minLength": 1, - "type": "string" - }, - "EnableAutoBranchCreation": { - "type": "boolean" - }, - "EnableAutoBuild": { - "type": "boolean" - }, - "EnablePerformanceMode": { - "type": "boolean" - }, - "EnablePullRequestPreview": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Framework": { - "maxLength": 255, - "pattern": "(?s).*", - "type": "string" - }, - "PullRequestEnvironmentName": { - "maxLength": 20, - "pattern": "(?s).*", - "type": "string" - }, - "Stage": { - "enum": [ - "EXPERIMENTAL", - "BETA", - "PULL_REQUEST", - "PRODUCTION", - "DEVELOPMENT" - ], - "type": "string" - } - }, - "type": "object" - }, - "BasicAuthConfig": { - "additionalProperties": false, - "properties": { - "EnableBasicAuth": { - "type": "boolean" - }, - "Password": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Username": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "CustomRule": { - "additionalProperties": false, - "properties": { - "Condition": { - "maxLength": 2048, - "minLength": 0, - "pattern": "(?s).*", - "type": "string" - }, - "Source": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "Status": { - "maxLength": 7, - "minLength": 3, - "pattern": ".{3,7}", - "type": "string" - }, - "Target": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - } - }, - "required": [ - "Target", - "Source" - ], - "type": "object" - }, - "EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 255, - "pattern": "(?s).*", - "type": "string" - }, - "Value": { - "maxLength": 5500, - "pattern": "(?s).*", - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "insertionOrder": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.", - "handlers": { - "create": { - "permissions": [ - "amplify:GetApp", - "amplify:CreateApp", - "amplify:TagResource", - "codecommit:GetRepository", - "codecommit:PutRepositoryTriggers", - "codecommit:GetRepositoryTriggers", - "sns:CreateTopic", - "sns:Subscribe", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "amplify:GetApp", - "amplify:DeleteApp", - "codecommit:GetRepository", - "codecommit:GetRepositoryTriggers", - "codecommit:PutRepositoryTriggers", - "sns:Unsubscribe", - "iam:PassRole" - ] - }, - "list": { - "permissions": [ - "amplify:GetApp", - "amplify:ListApps", - "amplify:ListTagsForResource", - "iam:PassRole" - ] - }, - "read": { - "permissions": [ - "amplify:GetApp", - "amplify:ListTagsForResource", - "codecommit:GetRepository", - "codecommit:GetRepositoryTriggers", - "iam:PassRole" - ] - }, - "update": { - "permissions": [ - "amplify:GetApp", - "amplify:UpdateApp", - "amplify:ListTagsForResource", - "amplify:TagResource", - "amplify:UntagResource", - "codecommit:GetRepository", - "codecommit:PutRepositoryTriggers", - "codecommit:GetRepositoryTriggers", - "sns:CreateTopic", - "sns:Subscribe", - "sns:Unsubscribe", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AccessToken": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "AppId": { - "maxLength": 20, - "minLength": 1, - "pattern": "d[a-z0-9]+", - "type": "string" - }, - "AppName": { - "maxLength": 255, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "Arn": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "AutoBranchCreationConfig": { - "$ref": "#/definitions/AutoBranchCreationConfig" - }, - "BasicAuthConfig": { - "$ref": "#/definitions/BasicAuthConfig" - }, - "BuildSpec": { - "maxLength": 25000, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "CustomHeaders": { - "maxLength": 25000, - "minLength": 0, - "pattern": "(?s).*", - "type": "string" - }, - "CustomRules": { - "items": { - "$ref": "#/definitions/CustomRule" - }, - "type": "array", - "uniqueItems": false - }, - "DefaultDomain": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "Description": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "EnableBranchAutoDeletion": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "IAMServiceRole": { - "maxLength": 1000, - "minLength": 1, - "pattern": "(?s).*", - "type": "string" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "OauthToken": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "Platform": { - "enum": [ - "WEB", - "WEB_DYNAMIC", - "WEB_COMPUTE" - ], - "type": "string" - }, - "Repository": { - "pattern": "(?s).*", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/AppId", - "/properties/AppName", - "/properties/Arn", - "/properties/DefaultDomain" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Amplify::App", - "writeOnlyProperties": [ - "/properties/AccessToken", - "/properties/BasicAuthConfig", - "/properties/OauthToken", - "/properties/AutoBranchCreationConfig" - ] -} +{ + "additionalProperties": false, + "definitions": { + "AutoBranchCreationConfig": { + "additionalProperties": false, + "properties": { + "AutoBranchCreationPatterns": { + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BasicAuthConfig": { + "$ref": "#/definitions/BasicAuthConfig" + }, + "BuildSpec": { + "maxLength": 25000, + "minLength": 1, + "type": "string" + }, + "EnableAutoBranchCreation": { + "type": "boolean" + }, + "EnableAutoBuild": { + "type": "boolean" + }, + "EnablePerformanceMode": { + "type": "boolean" + }, + "EnablePullRequestPreview": { + "type": "boolean" + }, + "EnvironmentVariables": { + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "Framework": { + "maxLength": 255, + "pattern": "(?s).*", + "type": "string" + }, + "PullRequestEnvironmentName": { + "maxLength": 20, + "pattern": "(?s).*", + "type": "string" + }, + "Stage": { + "enum": [ + "EXPERIMENTAL", + "BETA", + "PULL_REQUEST", + "PRODUCTION", + "DEVELOPMENT" + ], + "type": "string" + } + }, + "type": "object" + }, + "BasicAuthConfig": { + "additionalProperties": false, + "properties": { + "EnableBasicAuth": { + "type": "boolean" + }, + "Password": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Username": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "CacheConfig": { + "additionalProperties": false, + "properties": { + "Type": { + "enum": [ + "AMPLIFY_MANAGED", + "AMPLIFY_MANAGED_NO_COOKIES" + ], + "type": "string" + } + }, + "type": "object" + }, + "CustomRule": { + "additionalProperties": false, + "properties": { + "Condition": { + "maxLength": 2048, + "minLength": 0, + "pattern": "(?s).*", + "type": "string" + }, + "Source": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "Status": { + "maxLength": 7, + "minLength": 3, + "pattern": ".{3,7}", + "type": "string" + }, + "Target": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + } + }, + "required": [ + "Target", + "Source" + ], + "type": "object" + }, + "EnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 255, + "pattern": "(?s).*", + "type": "string" + }, + "Value": { + "maxLength": 5500, + "pattern": "(?s).*", + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "insertionOrder": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.", + "handlers": { + "create": { + "permissions": [ + "amplify:GetApp", + "amplify:CreateApp", + "amplify:TagResource", + "codecommit:GetRepository", + "codecommit:PutRepositoryTriggers", + "codecommit:GetRepositoryTriggers", + "sns:CreateTopic", + "sns:Subscribe", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "amplify:GetApp", + "amplify:DeleteApp", + "codecommit:GetRepository", + "codecommit:GetRepositoryTriggers", + "codecommit:PutRepositoryTriggers", + "sns:Unsubscribe", + "iam:PassRole" + ] + }, + "list": { + "permissions": [ + "amplify:GetApp", + "amplify:ListApps", + "amplify:ListTagsForResource", + "iam:PassRole" + ] + }, + "read": { + "permissions": [ + "amplify:GetApp", + "amplify:ListTagsForResource", + "codecommit:GetRepository", + "codecommit:GetRepositoryTriggers", + "iam:PassRole" + ] + }, + "update": { + "permissions": [ + "amplify:GetApp", + "amplify:UpdateApp", + "amplify:ListTagsForResource", + "amplify:TagResource", + "amplify:UntagResource", + "codecommit:GetRepository", + "codecommit:PutRepositoryTriggers", + "codecommit:GetRepositoryTriggers", + "sns:CreateTopic", + "sns:Subscribe", + "sns:Unsubscribe", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AccessToken": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "AppId": { + "maxLength": 20, + "minLength": 1, + "pattern": "d[a-z0-9]+", + "type": "string" + }, + "AppName": { + "maxLength": 255, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "Arn": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "AutoBranchCreationConfig": { + "$ref": "#/definitions/AutoBranchCreationConfig" + }, + "BasicAuthConfig": { + "$ref": "#/definitions/BasicAuthConfig" + }, + "BuildSpec": { + "maxLength": 25000, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "CacheConfig": { + "$ref": "#/definitions/CacheConfig" + }, + "CustomHeaders": { + "maxLength": 25000, + "minLength": 0, + "pattern": "(?s).*", + "type": "string" + }, + "CustomRules": { + "items": { + "$ref": "#/definitions/CustomRule" + }, + "type": "array", + "uniqueItems": false + }, + "DefaultDomain": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "Description": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "EnableBranchAutoDeletion": { + "type": "boolean" + }, + "EnvironmentVariables": { + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "IAMServiceRole": { + "maxLength": 1000, + "minLength": 1, + "pattern": "(?s).*", + "type": "string" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "OauthToken": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "Platform": { + "enum": [ + "WEB", + "WEB_DYNAMIC", + "WEB_COMPUTE" + ], + "type": "string" + }, + "Repository": { + "pattern": "(?s).*", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/AppId", + "/properties/AppName", + "/properties/Arn", + "/properties/DefaultDomain" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplify", + "typeName": "AWS::Amplify::App", + "writeOnlyProperties": [ + "/properties/AccessToken", + "/properties/BasicAuthConfig", + "/properties/OauthToken", + "/properties/AutoBranchCreationConfig" + ] +} diff --git a/schema/aws-amplify-branch.json b/schema/aws-amplify-branch.json index 7192a8d..37dba59 100644 --- a/schema/aws-amplify-branch.json +++ b/schema/aws-amplify-branch.json @@ -1,259 +1,259 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppId", - "/properties/BranchName" - ], - "definitions": { - "Backend": { - "additionalProperties": false, - "properties": { - "StackArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "type": "object" - }, - "BasicAuthConfig": { - "additionalProperties": false, - "properties": { - "EnableBasicAuth": { - "type": "boolean" - }, - "Password": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Username": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 255, - "pattern": "(?s).*", - "type": "string" - }, - "Value": { - "maxLength": 5500, - "pattern": "(?s).*", - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "insertionOrder": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::Amplify::Branch resource creates a new branch within an app.", - "handlers": { - "create": { - "permissions": [ - "amplify:GetBranch", - "amplify:CreateBranch", - "amplify:TagResource", - "codecommit:GetRepository", - "codecommit:PutRepositoryTriggers", - "codecommit:GetRepositoryTriggers", - "s3:GetObject", - "s3:GetObjectAcl", - "s3:PutObject", - "s3:PutObjectAcl", - "sns:CreateTopic", - "sns:Subscribe", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "amplify:GetBranch", - "amplify:DeleteBranch", - "codecommit:GetRepository", - "codecommit:GetRepositoryTriggers", - "sns:Unsubscribe", - "iam:PassRole" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AppId": { - "$ref": "resource-schema.json#/properties/AppId" - } - }, - "required": [ - "AppId" - ] - }, - "permissions": [ - "amplify:GetBranch", - "amplify:ListBranches", - "amplify:ListTagsForResource", - "iam:PassRole" - ] - }, - "read": { - "permissions": [ - "amplify:GetBranch", - "amplify:ListTagsForResource", - "codecommit:GetRepository", - "codecommit:GetRepositoryTriggers", - "s3:GetObject", - "s3:GetObjectAcl", - "iam:PassRole" - ] - }, - "update": { - "permissions": [ - "amplify:GetBranch", - "amplify:UpdateBranch", - "amplify:ListTagsForResource", - "amplify:TagResource", - "amplify:UntagResource", - "codecommit:GetRepository", - "codecommit:PutRepositoryTriggers", - "codecommit:GetRepositoryTriggers", - "s3:GetObject", - "s3:GetObjectAcl", - "s3:PutObject", - "s3:PutObjectAcl", - "sns:CreateTopic", - "sns:Subscribe", - "sns:Unsubscribe", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AppId": { - "maxLength": 20, - "minLength": 1, - "pattern": "d[a-z0-9]+", - "type": "string" - }, - "Arn": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "Backend": { - "$ref": "#/definitions/Backend" - }, - "BasicAuthConfig": { - "$ref": "#/definitions/BasicAuthConfig" - }, - "BranchName": { - "maxLength": 255, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "BuildSpec": { - "maxLength": 25000, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "Description": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "EnableAutoBuild": { - "type": "boolean" - }, - "EnablePerformanceMode": { - "type": "boolean" - }, - "EnablePullRequestPreview": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Framework": { - "maxLength": 255, - "pattern": "(?s).*", - "type": "string" - }, - "PullRequestEnvironmentName": { - "maxLength": 20, - "pattern": "(?s).*", - "type": "string" - }, - "Stage": { - "enum": [ - "EXPERIMENTAL", - "BETA", - "PULL_REQUEST", - "PRODUCTION", - "DEVELOPMENT" - ], - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AppId", - "BranchName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplify", - "typeName": "AWS::Amplify::Branch", - "writeOnlyProperties": [ - "/properties/BasicAuthConfig" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppId", + "/properties/BranchName" + ], + "definitions": { + "Backend": { + "additionalProperties": false, + "properties": { + "StackArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "type": "object" + }, + "BasicAuthConfig": { + "additionalProperties": false, + "properties": { + "EnableBasicAuth": { + "type": "boolean" + }, + "Password": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Username": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "EnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 255, + "pattern": "(?s).*", + "type": "string" + }, + "Value": { + "maxLength": 5500, + "pattern": "(?s).*", + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "insertionOrder": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::Amplify::Branch resource creates a new branch within an app.", + "handlers": { + "create": { + "permissions": [ + "amplify:GetBranch", + "amplify:CreateBranch", + "amplify:TagResource", + "codecommit:GetRepository", + "codecommit:PutRepositoryTriggers", + "codecommit:GetRepositoryTriggers", + "s3:GetObject", + "s3:GetObjectAcl", + "s3:PutObject", + "s3:PutObjectAcl", + "sns:CreateTopic", + "sns:Subscribe", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "amplify:GetBranch", + "amplify:DeleteBranch", + "codecommit:GetRepository", + "codecommit:GetRepositoryTriggers", + "sns:Unsubscribe", + "iam:PassRole" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AppId": { + "$ref": "resource-schema.json#/properties/AppId" + } + }, + "required": [ + "AppId" + ] + }, + "permissions": [ + "amplify:GetBranch", + "amplify:ListBranches", + "amplify:ListTagsForResource", + "iam:PassRole" + ] + }, + "read": { + "permissions": [ + "amplify:GetBranch", + "amplify:ListTagsForResource", + "codecommit:GetRepository", + "codecommit:GetRepositoryTriggers", + "s3:GetObject", + "s3:GetObjectAcl", + "iam:PassRole" + ] + }, + "update": { + "permissions": [ + "amplify:GetBranch", + "amplify:UpdateBranch", + "amplify:ListTagsForResource", + "amplify:TagResource", + "amplify:UntagResource", + "codecommit:GetRepository", + "codecommit:PutRepositoryTriggers", + "codecommit:GetRepositoryTriggers", + "s3:GetObject", + "s3:GetObjectAcl", + "s3:PutObject", + "s3:PutObjectAcl", + "sns:CreateTopic", + "sns:Subscribe", + "sns:Unsubscribe", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AppId": { + "maxLength": 20, + "minLength": 1, + "pattern": "d[a-z0-9]+", + "type": "string" + }, + "Arn": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "Backend": { + "$ref": "#/definitions/Backend" + }, + "BasicAuthConfig": { + "$ref": "#/definitions/BasicAuthConfig" + }, + "BranchName": { + "maxLength": 255, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "BuildSpec": { + "maxLength": 25000, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "EnableAutoBuild": { + "type": "boolean" + }, + "EnablePerformanceMode": { + "type": "boolean" + }, + "EnablePullRequestPreview": { + "type": "boolean" + }, + "EnvironmentVariables": { + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "Framework": { + "maxLength": 255, + "pattern": "(?s).*", + "type": "string" + }, + "PullRequestEnvironmentName": { + "maxLength": 20, + "pattern": "(?s).*", + "type": "string" + }, + "Stage": { + "enum": [ + "EXPERIMENTAL", + "BETA", + "PULL_REQUEST", + "PRODUCTION", + "DEVELOPMENT" + ], + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AppId", + "BranchName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplify", + "typeName": "AWS::Amplify::Branch", + "writeOnlyProperties": [ + "/properties/BasicAuthConfig" + ] +} diff --git a/schema/aws-amplify-domain.json b/schema/aws-amplify-domain.json index 65427d6..3910d28 100644 --- a/schema/aws-amplify-domain.json +++ b/schema/aws-amplify-domain.json @@ -1,197 +1,197 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppId", - "/properties/DomainName" - ], - "definitions": { - "Certificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "pattern": "\"^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$\"", - "type": "string" - }, - "CertificateType": { - "enum": [ - "AMPLIFY_MANAGED", - "CUSTOM" - ], - "type": "string" - }, - "CertificateVerificationDNSRecord": { - "maxLength": 1000, - "type": "string" - } - }, - "type": "object" - }, - "CertificateSettings": { - "additionalProperties": false, - "properties": { - "CertificateType": { - "enum": [ - "AMPLIFY_MANAGED", - "CUSTOM" - ], - "type": "string" - }, - "CustomCertificateArn": { - "pattern": "^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$", - "type": "string" - } - }, - "type": "object" - }, - "SubDomainSetting": { - "additionalProperties": false, - "properties": { - "BranchName": { - "maxLength": 255, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "Prefix": { - "maxLength": 255, - "pattern": "(?s).*", - "type": "string" - } - }, - "required": [ - "Prefix", - "BranchName" - ], - "type": "object" - } - }, - "description": "The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.", - "handlers": { - "create": { - "permissions": [ - "amplify:CreateDomainAssociation", - "route53:ListHostedZones", - "route53:ChangeResourceRecordSets", - "iam:PassRole", - "amplify:TagResource" - ] - }, - "delete": { - "permissions": [ - "amplify:DeleteDomainAssociation", - "iam:PassRole", - "amplify:DeleteDomainAssociation" - ] - }, - "list": { - "permissions": [ - "amplify:ListDomainAssociations", - "iam:PassRole", - "amplify:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "amplify:GetDomainAssociation", - "route53:ListHostedZones", - "iam:PassRole", - "amplify:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "amplify:UpdateDomainAssociation", - "route53:ListHostedZones", - "route53:ChangeResourceRecordSets", - "iam:PassRole", - "amplify:ListTagsForResource", - "amplify:TagResource", - "amplify:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AppId": { - "maxLength": 20, - "minLength": 1, - "pattern": "d[a-z0-9]+", - "type": "string" - }, - "Arn": { - "maxLength": 1000, - "pattern": "(?s).*", - "type": "string" - }, - "AutoSubDomainCreationPatterns": { - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(?s).+", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AutoSubDomainIAMRole": { - "maxLength": 1000, - "pattern": "^$|^arn:.+:iam::\\d{12}:role.+", - "type": "string" - }, - "Certificate": { - "$ref": "#/definitions/Certificate" - }, - "CertificateRecord": { - "maxLength": 1000, - "type": "string" - }, - "CertificateSettings": { - "$ref": "#/definitions/CertificateSettings" - }, - "DomainName": { - "maxLength": 255, - "pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$", - "type": "string" - }, - "DomainStatus": { - "type": "string" - }, - "EnableAutoSubDomain": { - "type": "boolean" - }, - "StatusReason": { - "maxLength": 1000, - "type": "string" - }, - "SubDomainSettings": { - "items": { - "$ref": "#/definitions/SubDomainSetting" - }, - "maxItems": 255, - "type": "array", - "uniqueItems": false - }, - "UpdateStatus": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DomainStatus", - "/properties/StatusReason", - "/properties/CertificateRecord", - "/properties/Certificate", - "/properties/UpdateStatus" - ], - "required": [ - "AppId", - "DomainName", - "SubDomainSettings" - ], - "typeName": "AWS::Amplify::Domain", - "writeOnlyProperties": [ - "/properties/CertificateSettings" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppId", + "/properties/DomainName" + ], + "definitions": { + "Certificate": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "pattern": "\"^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$\"", + "type": "string" + }, + "CertificateType": { + "enum": [ + "AMPLIFY_MANAGED", + "CUSTOM" + ], + "type": "string" + }, + "CertificateVerificationDNSRecord": { + "maxLength": 1000, + "type": "string" + } + }, + "type": "object" + }, + "CertificateSettings": { + "additionalProperties": false, + "properties": { + "CertificateType": { + "enum": [ + "AMPLIFY_MANAGED", + "CUSTOM" + ], + "type": "string" + }, + "CustomCertificateArn": { + "pattern": "^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$", + "type": "string" + } + }, + "type": "object" + }, + "SubDomainSetting": { + "additionalProperties": false, + "properties": { + "BranchName": { + "maxLength": 255, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "Prefix": { + "maxLength": 255, + "pattern": "(?s).*", + "type": "string" + } + }, + "required": [ + "Prefix", + "BranchName" + ], + "type": "object" + } + }, + "description": "The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.", + "handlers": { + "create": { + "permissions": [ + "amplify:CreateDomainAssociation", + "route53:ListHostedZones", + "route53:ChangeResourceRecordSets", + "iam:PassRole", + "amplify:TagResource" + ] + }, + "delete": { + "permissions": [ + "amplify:DeleteDomainAssociation", + "iam:PassRole", + "amplify:DeleteDomainAssociation" + ] + }, + "list": { + "permissions": [ + "amplify:ListDomainAssociations", + "iam:PassRole", + "amplify:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "amplify:GetDomainAssociation", + "route53:ListHostedZones", + "iam:PassRole", + "amplify:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "amplify:UpdateDomainAssociation", + "route53:ListHostedZones", + "route53:ChangeResourceRecordSets", + "iam:PassRole", + "amplify:ListTagsForResource", + "amplify:TagResource", + "amplify:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AppId": { + "maxLength": 20, + "minLength": 1, + "pattern": "d[a-z0-9]+", + "type": "string" + }, + "Arn": { + "maxLength": 1000, + "pattern": "(?s).*", + "type": "string" + }, + "AutoSubDomainCreationPatterns": { + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(?s).+", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AutoSubDomainIAMRole": { + "maxLength": 1000, + "pattern": "^$|^arn:.+:iam::\\d{12}:role.+", + "type": "string" + }, + "Certificate": { + "$ref": "#/definitions/Certificate" + }, + "CertificateRecord": { + "maxLength": 1000, + "type": "string" + }, + "CertificateSettings": { + "$ref": "#/definitions/CertificateSettings" + }, + "DomainName": { + "maxLength": 255, + "pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$", + "type": "string" + }, + "DomainStatus": { + "type": "string" + }, + "EnableAutoSubDomain": { + "type": "boolean" + }, + "StatusReason": { + "maxLength": 1000, + "type": "string" + }, + "SubDomainSettings": { + "items": { + "$ref": "#/definitions/SubDomainSetting" + }, + "maxItems": 255, + "type": "array", + "uniqueItems": false + }, + "UpdateStatus": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DomainStatus", + "/properties/StatusReason", + "/properties/CertificateRecord", + "/properties/Certificate", + "/properties/UpdateStatus" + ], + "required": [ + "AppId", + "DomainName", + "SubDomainSettings" + ], + "typeName": "AWS::Amplify::Domain", + "writeOnlyProperties": [ + "/properties/CertificateSettings" + ] +} diff --git a/schema/aws-amplifyuibuilder-component.json b/schema/aws-amplifyuibuilder-component.json index cbc3d08..b674ceb 100644 --- a/schema/aws-amplifyuibuilder-component.json +++ b/schema/aws-amplifyuibuilder-component.json @@ -1,583 +1,583 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppId", - "/properties/EnvironmentName" - ], - "definitions": { - "ActionParameters": { - "additionalProperties": false, - "properties": { - "Anchor": { - "$ref": "#/definitions/ComponentProperty" - }, - "Fields": { - "$ref": "#/definitions/ComponentProperties" - }, - "Global": { - "$ref": "#/definitions/ComponentProperty" - }, - "Id": { - "$ref": "#/definitions/ComponentProperty" - }, - "Model": { - "type": "string" - }, - "State": { - "$ref": "#/definitions/MutationActionSetStateParameter" - }, - "Target": { - "$ref": "#/definitions/ComponentProperty" - }, - "Type": { - "$ref": "#/definitions/ComponentProperty" - }, - "Url": { - "$ref": "#/definitions/ComponentProperty" - } - }, - "type": "object" - }, - "ComponentBindingProperties": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentBindingPropertiesValue" - } - }, - "type": "object" - }, - "ComponentBindingPropertiesValue": { - "additionalProperties": false, - "properties": { - "BindingProperties": { - "$ref": "#/definitions/ComponentBindingPropertiesValueProperties" - }, - "DefaultValue": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "ComponentBindingPropertiesValueProperties": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "DefaultValue": { - "type": "string" - }, - "Field": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Model": { - "type": "string" - }, - "Predicates": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array" - }, - "SlotName": { - "type": "string" - }, - "UserAttribute": { - "type": "string" - } - }, - "type": "object" - }, - "ComponentChild": { - "additionalProperties": false, - "properties": { - "Children": { - "items": { - "$ref": "#/definitions/ComponentChild" - }, - "type": "array" - }, - "ComponentType": { - "type": "string" - }, - "Events": { - "$ref": "#/definitions/ComponentEvents" - }, - "Name": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/ComponentProperties" - }, - "SourceId": { - "type": "string" - } - }, - "required": [ - "ComponentType", - "Name", - "Properties" - ], - "type": "object" - }, - "ComponentCollectionProperties": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentDataConfiguration" - } - }, - "type": "object" - }, - "ComponentConditionProperty": { - "additionalProperties": false, - "properties": { - "Else": { - "$ref": "#/definitions/ComponentProperty" - }, - "Field": { - "type": "string" - }, - "Operand": { - "type": "string" - }, - "OperandType": { - "type": "string" - }, - "Operator": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "Then": { - "$ref": "#/definitions/ComponentProperty" - } - }, - "type": "object" - }, - "ComponentDataConfiguration": { - "additionalProperties": false, - "properties": { - "Identifiers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Model": { - "type": "string" - }, - "Predicate": { - "$ref": "#/definitions/Predicate" - }, - "Sort": { - "items": { - "$ref": "#/definitions/SortProperty" - }, - "type": "array" - } - }, - "required": [ - "Model" - ], - "type": "object" - }, - "ComponentEvent": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "BindingEvent": { - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/ActionParameters" - } - }, - "type": "object" - }, - "ComponentEvents": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentEvent" - } - }, - "type": "object" - }, - "ComponentOverrides": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentOverridesValue" - } - }, - "type": "object" - }, - "ComponentOverridesValue": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "ComponentProperties": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentProperty" - } - }, - "type": "object" - }, - "ComponentProperty": { - "additionalProperties": false, - "properties": { - "BindingProperties": { - "$ref": "#/definitions/ComponentPropertyBindingProperties" - }, - "Bindings": { - "$ref": "#/definitions/FormBindings" - }, - "CollectionBindingProperties": { - "$ref": "#/definitions/ComponentPropertyBindingProperties" - }, - "ComponentName": { - "type": "string" - }, - "Concat": { - "items": { - "$ref": "#/definitions/ComponentProperty" - }, - "type": "array" - }, - "Condition": { - "$ref": "#/definitions/ComponentConditionProperty" - }, - "Configured": { - "type": "boolean" - }, - "DefaultValue": { - "type": "string" - }, - "Event": { - "type": "string" - }, - "ImportedValue": { - "type": "string" - }, - "Model": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "UserAttribute": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "ComponentPropertyBindingProperties": { - "additionalProperties": false, - "properties": { - "Field": { - "type": "string" - }, - "Property": { - "type": "string" - } - }, - "required": [ - "Property" - ], - "type": "object" - }, - "ComponentVariant": { - "additionalProperties": false, - "properties": { - "Overrides": { - "$ref": "#/definitions/ComponentOverrides" - }, - "VariantValues": { - "$ref": "#/definitions/ComponentVariantValues" - } - }, - "type": "object" - }, - "ComponentVariantValues": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "FormBindingElement": { - "additionalProperties": false, - "properties": { - "Element": { - "type": "string" - }, - "Property": { - "type": "string" - } - }, - "required": [ - "Element", - "Property" - ], - "type": "object" - }, - "FormBindings": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/FormBindingElement" - } - }, - "type": "object" - }, - "MutationActionSetStateParameter": { - "additionalProperties": false, - "properties": { - "ComponentName": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "Set": { - "$ref": "#/definitions/ComponentProperty" - } - }, - "required": [ - "ComponentName", - "Property", - "Set" - ], - "type": "object" - }, - "Predicate": { - "additionalProperties": false, - "properties": { - "And": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array" - }, - "Field": { - "type": "string" - }, - "Operand": { - "type": "string" - }, - "OperandType": { - "pattern": "^boolean|string|number$", - "type": "string" - }, - "Operator": { - "type": "string" - }, - "Or": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array" - } - }, - "type": "object" - }, - "SortDirection": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "SortProperty": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "Field": { - "type": "string" - } - }, - "required": [ - "Direction", - "Field" - ], - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - "^(?!aws:)[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::AmplifyUIBuilder::Component Resource Type", - "handlers": { - "create": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:CreateComponent", - "amplifyuibuilder:GetComponent", - "amplifyuibuilder:TagResource" - ] - }, - "delete": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:DeleteComponent", - "amplifyuibuilder:GetComponent", - "amplifyuibuilder:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AppId": { - "$ref": "resource-schema.json#/properties/AppId" - }, - "EnvironmentName": { - "$ref": "resource-schema.json#/properties/EnvironmentName" - } - }, - "required": [ - "AppId", - "EnvironmentName" - ] - }, - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:ListComponents" - ] - }, - "read": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetComponent" - ] - }, - "update": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetComponent", - "amplifyuibuilder:TagResource", - "amplifyuibuilder:UntagResource", - "amplifyuibuilder:UpdateComponent" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppId", - "/properties/EnvironmentName", - "/properties/Id" - ], - "properties": { - "AppId": { - "type": "string" - }, - "BindingProperties": { - "$ref": "#/definitions/ComponentBindingProperties" - }, - "Children": { - "items": { - "$ref": "#/definitions/ComponentChild" - }, - "type": "array" - }, - "CollectionProperties": { - "$ref": "#/definitions/ComponentCollectionProperties" - }, - "ComponentType": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "EnvironmentName": { - "type": "string" - }, - "Events": { - "$ref": "#/definitions/ComponentEvents" - }, - "Id": { - "type": "string" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Overrides": { - "$ref": "#/definitions/ComponentOverrides" - }, - "Properties": { - "$ref": "#/definitions/ComponentProperties" - }, - "SchemaVersion": { - "type": "string" - }, - "SourceId": { - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "Variants": { - "items": { - "$ref": "#/definitions/ComponentVariant" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/Id", - "/properties/ModifiedAt" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AmplifyUIBuilder::Component" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppId", + "/properties/EnvironmentName" + ], + "definitions": { + "ActionParameters": { + "additionalProperties": false, + "properties": { + "Anchor": { + "$ref": "#/definitions/ComponentProperty" + }, + "Fields": { + "$ref": "#/definitions/ComponentProperties" + }, + "Global": { + "$ref": "#/definitions/ComponentProperty" + }, + "Id": { + "$ref": "#/definitions/ComponentProperty" + }, + "Model": { + "type": "string" + }, + "State": { + "$ref": "#/definitions/MutationActionSetStateParameter" + }, + "Target": { + "$ref": "#/definitions/ComponentProperty" + }, + "Type": { + "$ref": "#/definitions/ComponentProperty" + }, + "Url": { + "$ref": "#/definitions/ComponentProperty" + } + }, + "type": "object" + }, + "ComponentBindingProperties": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentBindingPropertiesValue" + } + }, + "type": "object" + }, + "ComponentBindingPropertiesValue": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/ComponentBindingPropertiesValueProperties" + }, + "DefaultValue": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentBindingPropertiesValueProperties": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "DefaultValue": { + "type": "string" + }, + "Field": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "Model": { + "type": "string" + }, + "Predicates": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array" + }, + "SlotName": { + "type": "string" + }, + "UserAttribute": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentChild": { + "additionalProperties": false, + "properties": { + "Children": { + "items": { + "$ref": "#/definitions/ComponentChild" + }, + "type": "array" + }, + "ComponentType": { + "type": "string" + }, + "Events": { + "$ref": "#/definitions/ComponentEvents" + }, + "Name": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/ComponentProperties" + }, + "SourceId": { + "type": "string" + } + }, + "required": [ + "ComponentType", + "Name", + "Properties" + ], + "type": "object" + }, + "ComponentCollectionProperties": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentDataConfiguration" + } + }, + "type": "object" + }, + "ComponentConditionProperty": { + "additionalProperties": false, + "properties": { + "Else": { + "$ref": "#/definitions/ComponentProperty" + }, + "Field": { + "type": "string" + }, + "Operand": { + "type": "string" + }, + "OperandType": { + "type": "string" + }, + "Operator": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "Then": { + "$ref": "#/definitions/ComponentProperty" + } + }, + "type": "object" + }, + "ComponentDataConfiguration": { + "additionalProperties": false, + "properties": { + "Identifiers": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Model": { + "type": "string" + }, + "Predicate": { + "$ref": "#/definitions/Predicate" + }, + "Sort": { + "items": { + "$ref": "#/definitions/SortProperty" + }, + "type": "array" + } + }, + "required": [ + "Model" + ], + "type": "object" + }, + "ComponentEvent": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "BindingEvent": { + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/ActionParameters" + } + }, + "type": "object" + }, + "ComponentEvents": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentEvent" + } + }, + "type": "object" + }, + "ComponentOverrides": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentOverridesValue" + } + }, + "type": "object" + }, + "ComponentOverridesValue": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentProperties": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentProperty" + } + }, + "type": "object" + }, + "ComponentProperty": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/ComponentPropertyBindingProperties" + }, + "Bindings": { + "$ref": "#/definitions/FormBindings" + }, + "CollectionBindingProperties": { + "$ref": "#/definitions/ComponentPropertyBindingProperties" + }, + "ComponentName": { + "type": "string" + }, + "Concat": { + "items": { + "$ref": "#/definitions/ComponentProperty" + }, + "type": "array" + }, + "Condition": { + "$ref": "#/definitions/ComponentConditionProperty" + }, + "Configured": { + "type": "boolean" + }, + "DefaultValue": { + "type": "string" + }, + "Event": { + "type": "string" + }, + "ImportedValue": { + "type": "string" + }, + "Model": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "UserAttribute": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentPropertyBindingProperties": { + "additionalProperties": false, + "properties": { + "Field": { + "type": "string" + }, + "Property": { + "type": "string" + } + }, + "required": [ + "Property" + ], + "type": "object" + }, + "ComponentVariant": { + "additionalProperties": false, + "properties": { + "Overrides": { + "$ref": "#/definitions/ComponentOverrides" + }, + "VariantValues": { + "$ref": "#/definitions/ComponentVariantValues" + } + }, + "type": "object" + }, + "ComponentVariantValues": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "FormBindingElement": { + "additionalProperties": false, + "properties": { + "Element": { + "type": "string" + }, + "Property": { + "type": "string" + } + }, + "required": [ + "Element", + "Property" + ], + "type": "object" + }, + "FormBindings": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/FormBindingElement" + } + }, + "type": "object" + }, + "MutationActionSetStateParameter": { + "additionalProperties": false, + "properties": { + "ComponentName": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "Set": { + "$ref": "#/definitions/ComponentProperty" + } + }, + "required": [ + "ComponentName", + "Property", + "Set" + ], + "type": "object" + }, + "Predicate": { + "additionalProperties": false, + "properties": { + "And": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array" + }, + "Field": { + "type": "string" + }, + "Operand": { + "type": "string" + }, + "OperandType": { + "pattern": "^boolean|string|number$", + "type": "string" + }, + "Operator": { + "type": "string" + }, + "Or": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array" + } + }, + "type": "object" + }, + "SortDirection": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "SortProperty": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "Field": { + "type": "string" + } + }, + "required": [ + "Direction", + "Field" + ], + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + "^(?!aws:)[a-zA-Z+-=._:/]+$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::AmplifyUIBuilder::Component Resource Type", + "handlers": { + "create": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:CreateComponent", + "amplifyuibuilder:GetComponent", + "amplifyuibuilder:TagResource" + ] + }, + "delete": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:DeleteComponent", + "amplifyuibuilder:GetComponent", + "amplifyuibuilder:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AppId": { + "$ref": "resource-schema.json#/properties/AppId" + }, + "EnvironmentName": { + "$ref": "resource-schema.json#/properties/EnvironmentName" + } + }, + "required": [ + "AppId", + "EnvironmentName" + ] + }, + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:ListComponents" + ] + }, + "read": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetComponent" + ] + }, + "update": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetComponent", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateComponent" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppId", + "/properties/EnvironmentName", + "/properties/Id" + ], + "properties": { + "AppId": { + "type": "string" + }, + "BindingProperties": { + "$ref": "#/definitions/ComponentBindingProperties" + }, + "Children": { + "items": { + "$ref": "#/definitions/ComponentChild" + }, + "type": "array" + }, + "CollectionProperties": { + "$ref": "#/definitions/ComponentCollectionProperties" + }, + "ComponentType": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "EnvironmentName": { + "type": "string" + }, + "Events": { + "$ref": "#/definitions/ComponentEvents" + }, + "Id": { + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Overrides": { + "$ref": "#/definitions/ComponentOverrides" + }, + "Properties": { + "$ref": "#/definitions/ComponentProperties" + }, + "SchemaVersion": { + "type": "string" + }, + "SourceId": { + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "Variants": { + "items": { + "$ref": "#/definitions/ComponentVariant" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/Id", + "/properties/ModifiedAt" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AmplifyUIBuilder::Component" +} diff --git a/schema/aws-amplifyuibuilder-form.json b/schema/aws-amplifyuibuilder-form.json index 0b76f10..3aff00a 100644 --- a/schema/aws-amplifyuibuilder-form.json +++ b/schema/aws-amplifyuibuilder-form.json @@ -1,597 +1,597 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppId", - "/properties/EnvironmentName" - ], - "definitions": { - "FieldConfig": { - "additionalProperties": false, - "properties": { - "Excluded": { - "type": "boolean" - }, - "InputType": { - "$ref": "#/definitions/FieldInputConfig" - }, - "Label": { - "type": "string" - }, - "Position": { - "$ref": "#/definitions/FieldPosition" - }, - "Validations": { - "items": { - "$ref": "#/definitions/FieldValidationConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "FieldInputConfig": { - "additionalProperties": false, - "properties": { - "DefaultChecked": { - "type": "boolean" - }, - "DefaultCountryCode": { - "type": "string" - }, - "DefaultValue": { - "type": "string" - }, - "DescriptiveText": { - "type": "string" - }, - "FileUploaderConfig": { - "$ref": "#/definitions/FileUploaderFieldConfig" - }, - "IsArray": { - "type": "boolean" - }, - "MaxValue": { - "type": "number" - }, - "MinValue": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Placeholder": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "Required": { - "type": "boolean" - }, - "Step": { - "type": "number" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - }, - "ValueMappings": { - "$ref": "#/definitions/ValueMappings" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "FieldPosition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Fixed": { - "$ref": "#/definitions/FixedPosition" - } - }, - "required": [ - "Fixed" - ], - "title": "Fixed", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "RightOf": { - "type": "string" - } - }, - "required": [ - "RightOf" - ], - "title": "RightOf", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Below": { - "type": "string" - } - }, - "required": [ - "Below" - ], - "title": "Below", - "type": "object" - } - ] - }, - "FieldValidationConfiguration": { - "additionalProperties": false, - "properties": { - "NumValues": { - "items": { - "type": "number" - }, - "type": "array" - }, - "StrValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Type": { - "type": "string" - }, - "ValidationMessage": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "FieldsMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/FieldConfig" - } - }, - "type": "object" - }, - "FileUploaderFieldConfig": { - "additionalProperties": false, - "properties": { - "AcceptedFileTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AccessLevel": { - "$ref": "#/definitions/StorageAccessLevel" - }, - "IsResumable": { - "type": "boolean" - }, - "MaxFileCount": { - "type": "number" - }, - "MaxSize": { - "type": "number" - }, - "ShowThumbnails": { - "type": "boolean" - } - }, - "required": [ - "AcceptedFileTypes", - "AccessLevel" - ], - "type": "object" - }, - "FixedPosition": { - "enum": [ - "first" - ], - "type": "string" - }, - "FormActionType": { - "enum": [ - "create", - "update" - ], - "type": "string" - }, - "FormButton": { - "additionalProperties": false, - "properties": { - "Children": { - "type": "string" - }, - "Excluded": { - "type": "boolean" - }, - "Position": { - "$ref": "#/definitions/FieldPosition" - } - }, - "type": "object" - }, - "FormButtonsPosition": { - "enum": [ - "top", - "bottom", - "top_and_bottom" - ], - "type": "string" - }, - "FormCTA": { - "additionalProperties": false, - "properties": { - "Cancel": { - "$ref": "#/definitions/FormButton" - }, - "Clear": { - "$ref": "#/definitions/FormButton" - }, - "Position": { - "$ref": "#/definitions/FormButtonsPosition" - }, - "Submit": { - "$ref": "#/definitions/FormButton" - } - }, - "type": "object" - }, - "FormDataSourceType": { - "enum": [ - "DataStore", - "Custom" - ], - "type": "string" - }, - "FormDataTypeConfig": { - "additionalProperties": false, - "properties": { - "DataSourceType": { - "$ref": "#/definitions/FormDataSourceType" - }, - "DataTypeName": { - "type": "string" - } - }, - "required": [ - "DataSourceType", - "DataTypeName" - ], - "type": "object" - }, - "FormInputBindingProperties": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/FormInputBindingPropertiesValue" - } - }, - "type": "object" - }, - "FormInputBindingPropertiesValue": { - "additionalProperties": false, - "properties": { - "BindingProperties": { - "$ref": "#/definitions/FormInputBindingPropertiesValueProperties" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "FormInputBindingPropertiesValueProperties": { - "additionalProperties": false, - "properties": { - "Model": { - "type": "string" - } - }, - "type": "object" - }, - "FormInputValueProperty": { - "additionalProperties": false, - "properties": { - "BindingProperties": { - "$ref": "#/definitions/FormInputValuePropertyBindingProperties" - }, - "Concat": { - "items": { - "$ref": "#/definitions/FormInputValueProperty" - }, - "type": "array" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "FormInputValuePropertyBindingProperties": { - "additionalProperties": false, - "properties": { - "Field": { - "type": "string" - }, - "Property": { - "type": "string" - } - }, - "required": [ - "Property" - ], - "type": "object" - }, - "FormStyle": { - "additionalProperties": false, - "properties": { - "HorizontalGap": { - "$ref": "#/definitions/FormStyleConfig" - }, - "OuterPadding": { - "$ref": "#/definitions/FormStyleConfig" - }, - "VerticalGap": { - "$ref": "#/definitions/FormStyleConfig" - } - }, - "type": "object" - }, - "FormStyleConfig": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "TokenReference": { - "type": "string" - } - }, - "required": [ - "TokenReference" - ], - "title": "TokenReference", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - } - }, - "required": [ - "Value" - ], - "title": "Value", - "type": "object" - } - ] - }, - "LabelDecorator": { - "enum": [ - "required", - "optional", - "none" - ], - "type": "string" - }, - "SectionalElement": { - "additionalProperties": false, - "properties": { - "Excluded": { - "type": "boolean" - }, - "Level": { - "type": "number" - }, - "Orientation": { - "type": "string" - }, - "Position": { - "$ref": "#/definitions/FieldPosition" - }, - "Text": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SectionalElementMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/SectionalElement" - } - }, - "type": "object" - }, - "StorageAccessLevel": { - "enum": [ - "public", - "protected", - "private" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - "^(?!aws:)[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ValueMapping": { - "additionalProperties": false, - "properties": { - "DisplayValue": { - "$ref": "#/definitions/FormInputValueProperty" - }, - "Value": { - "$ref": "#/definitions/FormInputValueProperty" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "ValueMappings": { - "additionalProperties": false, - "properties": { - "BindingProperties": { - "$ref": "#/definitions/FormInputBindingProperties" - }, - "Values": { - "items": { - "$ref": "#/definitions/ValueMapping" - }, - "type": "array" - } - }, - "required": [ - "Values" - ], - "type": "object" - } - }, - "description": "Definition of AWS::AmplifyUIBuilder::Form Resource Type", - "handlers": { - "create": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:CreateForm", - "amplifyuibuilder:GetForm", - "amplifyuibuilder:TagResource", - "amplifyuibuilder:UntagResource" - ] - }, - "delete": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:DeleteForm", - "amplifyuibuilder:TagResource", - "amplifyuibuilder:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AppId": { - "$ref": "resource-schema.json#/properties/AppId" - }, - "EnvironmentName": { - "$ref": "resource-schema.json#/properties/EnvironmentName" - } - }, - "required": [ - "AppId", - "EnvironmentName" - ] - }, - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:ListForms" - ] - }, - "read": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetForm", - "amplifyuibuilder:TagResource" - ] - }, - "update": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetForm", - "amplifyuibuilder:TagResource", - "amplifyuibuilder:UntagResource", - "amplifyuibuilder:UpdateForm" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppId", - "/properties/EnvironmentName", - "/properties/Id" - ], - "properties": { - "AppId": { - "type": "string" - }, - "Cta": { - "$ref": "#/definitions/FormCTA" - }, - "DataType": { - "$ref": "#/definitions/FormDataTypeConfig" - }, - "EnvironmentName": { - "type": "string" - }, - "Fields": { - "$ref": "#/definitions/FieldsMap" - }, - "FormActionType": { - "$ref": "#/definitions/FormActionType" - }, - "Id": { - "type": "string" - }, - "LabelDecorator": { - "$ref": "#/definitions/LabelDecorator" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "SchemaVersion": { - "type": "string" - }, - "SectionalElements": { - "$ref": "#/definitions/SectionalElementMap" - }, - "Style": { - "$ref": "#/definitions/FormStyle" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AmplifyUIBuilder::Form" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppId", + "/properties/EnvironmentName" + ], + "definitions": { + "FieldConfig": { + "additionalProperties": false, + "properties": { + "Excluded": { + "type": "boolean" + }, + "InputType": { + "$ref": "#/definitions/FieldInputConfig" + }, + "Label": { + "type": "string" + }, + "Position": { + "$ref": "#/definitions/FieldPosition" + }, + "Validations": { + "items": { + "$ref": "#/definitions/FieldValidationConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "FieldInputConfig": { + "additionalProperties": false, + "properties": { + "DefaultChecked": { + "type": "boolean" + }, + "DefaultCountryCode": { + "type": "string" + }, + "DefaultValue": { + "type": "string" + }, + "DescriptiveText": { + "type": "string" + }, + "FileUploaderConfig": { + "$ref": "#/definitions/FileUploaderFieldConfig" + }, + "IsArray": { + "type": "boolean" + }, + "MaxValue": { + "type": "number" + }, + "MinValue": { + "type": "number" + }, + "Name": { + "type": "string" + }, + "Placeholder": { + "type": "string" + }, + "ReadOnly": { + "type": "boolean" + }, + "Required": { + "type": "boolean" + }, + "Step": { + "type": "number" + }, + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + }, + "ValueMappings": { + "$ref": "#/definitions/ValueMappings" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "FieldPosition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Fixed": { + "$ref": "#/definitions/FixedPosition" + } + }, + "required": [ + "Fixed" + ], + "title": "Fixed", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "RightOf": { + "type": "string" + } + }, + "required": [ + "RightOf" + ], + "title": "RightOf", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Below": { + "type": "string" + } + }, + "required": [ + "Below" + ], + "title": "Below", + "type": "object" + } + ] + }, + "FieldValidationConfiguration": { + "additionalProperties": false, + "properties": { + "NumValues": { + "items": { + "type": "number" + }, + "type": "array" + }, + "StrValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "type": "string" + }, + "ValidationMessage": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "FieldsMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/FieldConfig" + } + }, + "type": "object" + }, + "FileUploaderFieldConfig": { + "additionalProperties": false, + "properties": { + "AcceptedFileTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "AccessLevel": { + "$ref": "#/definitions/StorageAccessLevel" + }, + "IsResumable": { + "type": "boolean" + }, + "MaxFileCount": { + "type": "number" + }, + "MaxSize": { + "type": "number" + }, + "ShowThumbnails": { + "type": "boolean" + } + }, + "required": [ + "AcceptedFileTypes", + "AccessLevel" + ], + "type": "object" + }, + "FixedPosition": { + "enum": [ + "first" + ], + "type": "string" + }, + "FormActionType": { + "enum": [ + "create", + "update" + ], + "type": "string" + }, + "FormButton": { + "additionalProperties": false, + "properties": { + "Children": { + "type": "string" + }, + "Excluded": { + "type": "boolean" + }, + "Position": { + "$ref": "#/definitions/FieldPosition" + } + }, + "type": "object" + }, + "FormButtonsPosition": { + "enum": [ + "top", + "bottom", + "top_and_bottom" + ], + "type": "string" + }, + "FormCTA": { + "additionalProperties": false, + "properties": { + "Cancel": { + "$ref": "#/definitions/FormButton" + }, + "Clear": { + "$ref": "#/definitions/FormButton" + }, + "Position": { + "$ref": "#/definitions/FormButtonsPosition" + }, + "Submit": { + "$ref": "#/definitions/FormButton" + } + }, + "type": "object" + }, + "FormDataSourceType": { + "enum": [ + "DataStore", + "Custom" + ], + "type": "string" + }, + "FormDataTypeConfig": { + "additionalProperties": false, + "properties": { + "DataSourceType": { + "$ref": "#/definitions/FormDataSourceType" + }, + "DataTypeName": { + "type": "string" + } + }, + "required": [ + "DataSourceType", + "DataTypeName" + ], + "type": "object" + }, + "FormInputBindingProperties": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/FormInputBindingPropertiesValue" + } + }, + "type": "object" + }, + "FormInputBindingPropertiesValue": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputBindingPropertiesValueProperties" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "FormInputBindingPropertiesValueProperties": { + "additionalProperties": false, + "properties": { + "Model": { + "type": "string" + } + }, + "type": "object" + }, + "FormInputValueProperty": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputValuePropertyBindingProperties" + }, + "Concat": { + "items": { + "$ref": "#/definitions/FormInputValueProperty" + }, + "type": "array" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "FormInputValuePropertyBindingProperties": { + "additionalProperties": false, + "properties": { + "Field": { + "type": "string" + }, + "Property": { + "type": "string" + } + }, + "required": [ + "Property" + ], + "type": "object" + }, + "FormStyle": { + "additionalProperties": false, + "properties": { + "HorizontalGap": { + "$ref": "#/definitions/FormStyleConfig" + }, + "OuterPadding": { + "$ref": "#/definitions/FormStyleConfig" + }, + "VerticalGap": { + "$ref": "#/definitions/FormStyleConfig" + } + }, + "type": "object" + }, + "FormStyleConfig": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "TokenReference": { + "type": "string" + } + }, + "required": [ + "TokenReference" + ], + "title": "TokenReference", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Value": { + "type": "string" + } + }, + "required": [ + "Value" + ], + "title": "Value", + "type": "object" + } + ] + }, + "LabelDecorator": { + "enum": [ + "required", + "optional", + "none" + ], + "type": "string" + }, + "SectionalElement": { + "additionalProperties": false, + "properties": { + "Excluded": { + "type": "boolean" + }, + "Level": { + "type": "number" + }, + "Orientation": { + "type": "string" + }, + "Position": { + "$ref": "#/definitions/FieldPosition" + }, + "Text": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SectionalElementMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/SectionalElement" + } + }, + "type": "object" + }, + "StorageAccessLevel": { + "enum": [ + "public", + "protected", + "private" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + "^(?!aws:)[a-zA-Z+-=._:/]+$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ValueMapping": { + "additionalProperties": false, + "properties": { + "DisplayValue": { + "$ref": "#/definitions/FormInputValueProperty" + }, + "Value": { + "$ref": "#/definitions/FormInputValueProperty" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "ValueMappings": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputBindingProperties" + }, + "Values": { + "items": { + "$ref": "#/definitions/ValueMapping" + }, + "type": "array" + } + }, + "required": [ + "Values" + ], + "type": "object" + } + }, + "description": "Definition of AWS::AmplifyUIBuilder::Form Resource Type", + "handlers": { + "create": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:CreateForm", + "amplifyuibuilder:GetForm", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource" + ] + }, + "delete": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:DeleteForm", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AppId": { + "$ref": "resource-schema.json#/properties/AppId" + }, + "EnvironmentName": { + "$ref": "resource-schema.json#/properties/EnvironmentName" + } + }, + "required": [ + "AppId", + "EnvironmentName" + ] + }, + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:ListForms" + ] + }, + "read": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetForm", + "amplifyuibuilder:TagResource" + ] + }, + "update": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetForm", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateForm" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppId", + "/properties/EnvironmentName", + "/properties/Id" + ], + "properties": { + "AppId": { + "type": "string" + }, + "Cta": { + "$ref": "#/definitions/FormCTA" + }, + "DataType": { + "$ref": "#/definitions/FormDataTypeConfig" + }, + "EnvironmentName": { + "type": "string" + }, + "Fields": { + "$ref": "#/definitions/FieldsMap" + }, + "FormActionType": { + "$ref": "#/definitions/FormActionType" + }, + "Id": { + "type": "string" + }, + "LabelDecorator": { + "$ref": "#/definitions/LabelDecorator" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SchemaVersion": { + "type": "string" + }, + "SectionalElements": { + "$ref": "#/definitions/SectionalElementMap" + }, + "Style": { + "$ref": "#/definitions/FormStyle" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AmplifyUIBuilder::Form" +} diff --git a/schema/aws-amplifyuibuilder-theme.json b/schema/aws-amplifyuibuilder-theme.json index 2e30b98..04b8937 100644 --- a/schema/aws-amplifyuibuilder-theme.json +++ b/schema/aws-amplifyuibuilder-theme.json @@ -1,158 +1,158 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppId", - "/properties/EnvironmentName" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "patternProperties": { - "^(?!aws:)[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ThemeValue": { - "additionalProperties": false, - "properties": { - "Children": { - "items": { - "$ref": "#/definitions/ThemeValues" - }, - "type": "array" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "ThemeValues": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/ThemeValue" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::AmplifyUIBuilder::Theme Resource Type", - "handlers": { - "create": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:CreateTheme", - "amplifyuibuilder:GetTheme", - "amplifyuibuilder:TagResource" - ] - }, - "delete": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:DeleteTheme", - "amplifyuibuilder:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AppId": { - "$ref": "resource-schema.json#/properties/AppId" - }, - "EnvironmentName": { - "$ref": "resource-schema.json#/properties/EnvironmentName" - } - }, - "required": [ - "AppId", - "EnvironmentName" - ] - }, - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:ListThemes" - ] - }, - "read": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetTheme" - ] - }, - "update": { - "permissions": [ - "amplify:GetApp", - "amplifyuibuilder:GetTheme", - "amplifyuibuilder:TagResource", - "amplifyuibuilder:UntagResource", - "amplifyuibuilder:UpdateTheme" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppId", - "/properties/EnvironmentName", - "/properties/Id" - ], - "properties": { - "AppId": { - "type": "string" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "EnvironmentName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/ThemeValues" - }, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "Values": { - "items": { - "$ref": "#/definitions/ThemeValues" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/Id", - "/properties/ModifiedAt" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AmplifyUIBuilder::Theme" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppId", + "/properties/EnvironmentName" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "patternProperties": { + "^(?!aws:)[a-zA-Z+-=._:/]+$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ThemeValue": { + "additionalProperties": false, + "properties": { + "Children": { + "items": { + "$ref": "#/definitions/ThemeValues" + }, + "type": "array" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "ThemeValues": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "$ref": "#/definitions/ThemeValue" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::AmplifyUIBuilder::Theme Resource Type", + "handlers": { + "create": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:CreateTheme", + "amplifyuibuilder:GetTheme", + "amplifyuibuilder:TagResource" + ] + }, + "delete": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:DeleteTheme", + "amplifyuibuilder:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AppId": { + "$ref": "resource-schema.json#/properties/AppId" + }, + "EnvironmentName": { + "$ref": "resource-schema.json#/properties/EnvironmentName" + } + }, + "required": [ + "AppId", + "EnvironmentName" + ] + }, + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:ListThemes" + ] + }, + "read": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetTheme" + ] + }, + "update": { + "permissions": [ + "amplify:GetApp", + "amplifyuibuilder:GetTheme", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateTheme" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppId", + "/properties/EnvironmentName", + "/properties/Id" + ], + "properties": { + "AppId": { + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "EnvironmentName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Overrides": { + "items": { + "$ref": "#/definitions/ThemeValues" + }, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "Values": { + "items": { + "$ref": "#/definitions/ThemeValues" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/Id", + "/properties/ModifiedAt" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AmplifyUIBuilder::Theme" +} diff --git a/schema/aws-apigateway-account.json b/schema/aws-apigateway-account.json index a3ef206..d1e3145 100644 --- a/schema/aws-apigateway-account.json +++ b/schema/aws-apigateway-account.json @@ -1,51 +1,51 @@ -{ - "additionalProperties": false, - "description": "The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.", - "handlers": { - "create": { - "permissions": [ - "apigateway:PATCH", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "apigateway:PATCH" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "iam:GetRole", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CloudWatchRoleArn": { - "description": "The ARN of an Amazon CloudWatch role for the current Account.", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::Account" -} +{ + "additionalProperties": false, + "description": "The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.", + "handlers": { + "create": { + "permissions": [ + "apigateway:PATCH", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "apigateway:PATCH" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "iam:GetRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CloudWatchRoleArn": { + "description": "The ARN of an Amazon CloudWatch role for the current Account.", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::Account" +} diff --git a/schema/aws-apigateway-apikey.json b/schema/aws-apigateway-apikey.json index f2d0744..bfd4af4 100644 --- a/schema/aws-apigateway-apikey.json +++ b/schema/aws-apigateway-apikey.json @@ -1,151 +1,151 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GenerateDistinctId", - "/properties/Name", - "/properties/Value" - ], - "definitions": { - "StageKey": { - "additionalProperties": false, - "description": "``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.", - "properties": { - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "StageName": { - "description": "The stage name associated with the stage key.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET", - "apigateway:PUT" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE", - "apigateway:GET" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:DELETE" - ] - } - }, - "primaryIdentifier": [ - "/properties/APIKeyId" - ], - "properties": { - "APIKeyId": { - "description": "", - "type": "string" - }, - "CustomerId": { - "description": "An MKT customer identifier, when integrating with the AWS SaaS Marketplace.", - "type": "string" - }, - "Description": { - "description": "The description of the ApiKey.", - "type": "string" - }, - "Enabled": { - "default": false, - "description": "Specifies whether the ApiKey can be used by callers.", - "type": "boolean" - }, - "GenerateDistinctId": { - "description": "Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.", - "type": "boolean" - }, - "Name": { - "description": "A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "StageKeys": { - "description": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.", - "items": { - "$ref": "#/definitions/StageKey" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Value": { - "description": "Specifies a value of the API key.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/APIKeyId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:GET" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::ApiKey", - "writeOnlyProperties": [ - "/properties/GenerateDistinctId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GenerateDistinctId", + "/properties/Name", + "/properties/Value" + ], + "definitions": { + "StageKey": { + "additionalProperties": false, + "description": "``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.", + "properties": { + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "StageName": { + "description": "The stage name associated with the stage key.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET", + "apigateway:PUT" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE", + "apigateway:GET" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:DELETE" + ] + } + }, + "primaryIdentifier": [ + "/properties/APIKeyId" + ], + "properties": { + "APIKeyId": { + "description": "", + "type": "string" + }, + "CustomerId": { + "description": "An MKT customer identifier, when integrating with the AWS SaaS Marketplace.", + "type": "string" + }, + "Description": { + "description": "The description of the ApiKey.", + "type": "string" + }, + "Enabled": { + "default": false, + "description": "Specifies whether the ApiKey can be used by callers.", + "type": "boolean" + }, + "GenerateDistinctId": { + "description": "Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.", + "type": "boolean" + }, + "Name": { + "description": "A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "StageKeys": { + "description": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.", + "items": { + "$ref": "#/definitions/StageKey" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Value": { + "description": "Specifies a value of the API key.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/APIKeyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::ApiKey", + "writeOnlyProperties": [ + "/properties/GenerateDistinctId" + ] +} diff --git a/schema/aws-apigateway-authorizer.json b/schema/aws-apigateway-authorizer.json index 906ceda..0e85281 100644 --- a/schema/aws-apigateway-authorizer.json +++ b/schema/aws-apigateway-authorizer.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RestApiId" - ], - "description": "The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/AuthorizerId" - ], - "properties": { - "AuthType": { - "description": "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.", - "type": "string" - }, - "AuthorizerCredentials": { - "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.", - "type": "string" - }, - "AuthorizerId": { - "description": "", - "type": "string" - }, - "AuthorizerResultTtlInSeconds": { - "description": "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.", - "type": "integer" - }, - "AuthorizerUri": { - "description": "Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.", - "type": "string" - }, - "IdentitySource": { - "description": "The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.", - "type": "string" - }, - "IdentityValidationExpression": { - "description": "A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.", - "type": "string" - }, - "Name": { - "description": "The name of the authorizer.", - "type": "string" - }, - "ProviderARNs": { - "description": "A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "Type": { - "description": "The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AuthorizerId" - ], - "required": [ - "RestApiId", - "Type", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGateway::Authorizer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/AuthorizerId" + ], + "properties": { + "AuthType": { + "description": "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.", + "type": "string" + }, + "AuthorizerCredentials": { + "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.", + "type": "string" + }, + "AuthorizerId": { + "description": "", + "type": "string" + }, + "AuthorizerResultTtlInSeconds": { + "description": "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.", + "type": "integer" + }, + "AuthorizerUri": { + "description": "Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.", + "type": "string" + }, + "IdentitySource": { + "description": "The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.", + "type": "string" + }, + "IdentityValidationExpression": { + "description": "A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.", + "type": "string" + }, + "Name": { + "description": "The name of the authorizer.", + "type": "string" + }, + "ProviderARNs": { + "description": "A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "Type": { + "description": "The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AuthorizerId" + ], + "required": [ + "RestApiId", + "Type", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGateway::Authorizer" +} diff --git a/schema/aws-apigateway-basepathmapping.json b/schema/aws-apigateway-basepathmapping.json index 7718f4e..86f315b 100644 --- a/schema/aws-apigateway-basepathmapping.json +++ b/schema/aws-apigateway-basepathmapping.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/BasePath" - ], - "description": "The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "apigateway:PATCH" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName", - "/properties/BasePath" - ], - "properties": { - "BasePath": { - "description": "The base path name that callers of the API must provide as part of the URL after the domain name.", - "type": "string" - }, - "DomainName": { - "description": "The domain name of the BasePathMapping resource to be described.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "Stage": { - "description": "The name of the associated stage.", - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGateway::BasePathMapping" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/BasePath" + ], + "description": "The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "apigateway:PATCH" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName", + "/properties/BasePath" + ], + "properties": { + "BasePath": { + "description": "The base path name that callers of the API must provide as part of the URL after the domain name.", + "type": "string" + }, + "DomainName": { + "description": "The domain name of the BasePathMapping resource to be described.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "Stage": { + "description": "The name of the associated stage.", + "type": "string" + } + }, + "required": [ + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGateway::BasePathMapping" +} diff --git a/schema/aws-apigateway-clientcertificate.json b/schema/aws-apigateway-clientcertificate.json index 27216b9..800f489 100644 --- a/schema/aws-apigateway-clientcertificate.json +++ b/schema/aws-apigateway-clientcertificate.json @@ -1,93 +1,93 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET", - "apigateway:PUT" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:DELETE" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClientCertificateId" - ], - "properties": { - "ClientCertificateId": { - "description": "", - "type": "string" - }, - "Description": { - "description": "The description of the client certificate.", - "type": "string" - }, - "Tags": { - "description": "The collection of tags. Each tag element is associated with a given resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ClientCertificateId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:GET" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::ClientCertificate" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET", + "apigateway:PUT" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:DELETE" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClientCertificateId" + ], + "properties": { + "ClientCertificateId": { + "description": "", + "type": "string" + }, + "Description": { + "description": "The description of the client certificate.", + "type": "string" + }, + "Tags": { + "description": "The collection of tags. Each tag element is associated with a given resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ClientCertificateId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::ClientCertificate" +} diff --git a/schema/aws-apigateway-deployment.json b/schema/aws-apigateway-deployment.json index 26f315e..7b3937f 100644 --- a/schema/aws-apigateway-deployment.json +++ b/schema/aws-apigateway-deployment.json @@ -1,330 +1,330 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeploymentCanarySettings", - "/properties/RestApiId" - ], - "definitions": { - "AccessLogSetting": { - "additionalProperties": false, - "description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", - "properties": { - "DestinationArn": { - "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``.", - "type": "string" - }, - "Format": { - "description": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``.", - "type": "string" - } - }, - "type": "object" - }, - "CanarySetting": { - "additionalProperties": false, - "description": "The ``CanarySetting`` property type specifies settings for the canary deployment in this stage.\n ``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", - "properties": { - "PercentTraffic": { - "description": "The percent (0-100) of traffic diverted to a canary deployment.", - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": false, - "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.", - "type": "boolean" - } - }, - "type": "object" - }, - "DeploymentCanarySettings": { - "additionalProperties": false, - "description": "The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.", - "properties": { - "PercentTraffic": { - "description": "The percentage (0.0-100.0) of traffic routed to the canary deployment.", - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": false, - "description": "A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "description": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.", - "type": "boolean" - } - }, - "type": "object" - }, - "MethodSetting": { - "additionalProperties": false, - "description": "The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.", - "properties": { - "CacheDataEncrypted": { - "description": "Specifies whether the cached responses are encrypted.", - "type": "boolean" - }, - "CacheTtlInSeconds": { - "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.", - "type": "integer" - }, - "CachingEnabled": { - "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.", - "type": "boolean" - }, - "DataTraceEnabled": { - "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.", - "type": "boolean" - }, - "HttpMethod": { - "description": "The HTTP method.", - "type": "string" - }, - "LoggingLevel": { - "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.", - "type": "string" - }, - "MetricsEnabled": { - "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method.", - "type": "boolean" - }, - "ResourcePath": { - "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``).", - "type": "string" - }, - "ThrottlingBurstLimit": { - "description": "Specifies the throttling burst limit.", - "type": "integer" - }, - "ThrottlingRateLimit": { - "description": "Specifies the throttling rate limit.", - "type": "number" - } - }, - "type": "object" - }, - "StageDescription": { - "additionalProperties": false, - "description": "``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.", - "properties": { - "AccessLogSetting": { - "$ref": "#/definitions/AccessLogSetting", - "description": "Specifies settings for logging access in this stage." - }, - "CacheClusterEnabled": { - "description": "Specifies whether a cache cluster is enabled for the stage.", - "type": "boolean" - }, - "CacheClusterSize": { - "description": "The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.", - "type": "string" - }, - "CacheDataEncrypted": { - "description": "Indicates whether the cached responses are encrypted.", - "type": "boolean" - }, - "CacheTtlInSeconds": { - "description": "The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.", - "type": "integer" - }, - "CachingEnabled": { - "description": "Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.", - "type": "boolean" - }, - "CanarySetting": { - "$ref": "#/definitions/CanarySetting", - "description": "Specifies settings for the canary deployment in this stage." - }, - "ClientCertificateId": { - "description": "The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.", - "type": "string" - }, - "DataTraceEnabled": { - "description": "Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.", - "type": "boolean" - }, - "Description": { - "description": "A description of the purpose of the stage.", - "type": "string" - }, - "DocumentationVersion": { - "description": "The version identifier of the API documentation snapshot.", - "type": "string" - }, - "LoggingLevel": { - "description": "The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.", - "type": "string" - }, - "MethodSettings": { - "description": "Configures settings for all of the stage's methods.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MethodSetting" - }, - "type": "array", - "uniqueItems": true - }, - "MetricsEnabled": { - "description": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.", - "type": "boolean" - }, - "Tags": { - "description": "An array of arbitrary tags (key-value pairs) to associate with the stage.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "ThrottlingBurstLimit": { - "description": "The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.", - "type": "integer" - }, - "ThrottlingRateLimit": { - "description": "The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.", - "type": "number" - }, - "TracingEnabled": { - "description": "Specifies whether active tracing with X-ray is enabled for this stage.\n For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.", - "type": "boolean" - }, - "Variables": { - "additionalProperties": false, - "description": "A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "The key name of the tag", - "type": "string" - }, - "Value": { - "description": "The value for the tag", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT", - "apigateway:DELETE" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeploymentId", - "/properties/RestApiId" - ], - "properties": { - "DeploymentCanarySettings": { - "$ref": "#/definitions/DeploymentCanarySettings", - "description": "The input configuration for a canary deployment." - }, - "DeploymentId": { - "description": "", - "type": "string" - }, - "Description": { - "description": "The description for the Deployment resource to create.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "StageDescription": { - "$ref": "#/definitions/StageDescription", - "description": "The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name." - }, - "StageName": { - "description": "The name of the Stage resource for the Deployment resource to create.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DeploymentId" - ], - "required": [ - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::Deployment", - "writeOnlyProperties": [ - "/properties/StageName", - "/properties/StageDescription", - "/properties/DeploymentCanarySettings" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeploymentCanarySettings", + "/properties/RestApiId" + ], + "definitions": { + "AccessLogSetting": { + "additionalProperties": false, + "description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", + "properties": { + "DestinationArn": { + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``.", + "type": "string" + }, + "Format": { + "description": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``.", + "type": "string" + } + }, + "type": "object" + }, + "CanarySetting": { + "additionalProperties": false, + "description": "The ``CanarySetting`` property type specifies settings for the canary deployment in this stage.\n ``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", + "properties": { + "PercentTraffic": { + "description": "The percent (0-100) of traffic diverted to a canary deployment.", + "type": "number" + }, + "StageVariableOverrides": { + "additionalProperties": false, + "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "UseStageCache": { + "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "DeploymentCanarySettings": { + "additionalProperties": false, + "description": "The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.", + "properties": { + "PercentTraffic": { + "description": "The percentage (0.0-100.0) of traffic routed to the canary deployment.", + "type": "number" + }, + "StageVariableOverrides": { + "additionalProperties": false, + "description": "A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "UseStageCache": { + "description": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "MethodSetting": { + "additionalProperties": false, + "description": "The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.", + "properties": { + "CacheDataEncrypted": { + "description": "Specifies whether the cached responses are encrypted.", + "type": "boolean" + }, + "CacheTtlInSeconds": { + "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.", + "type": "integer" + }, + "CachingEnabled": { + "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.", + "type": "boolean" + }, + "DataTraceEnabled": { + "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.", + "type": "boolean" + }, + "HttpMethod": { + "description": "The HTTP method.", + "type": "string" + }, + "LoggingLevel": { + "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.", + "type": "string" + }, + "MetricsEnabled": { + "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method.", + "type": "boolean" + }, + "ResourcePath": { + "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``).", + "type": "string" + }, + "ThrottlingBurstLimit": { + "description": "Specifies the throttling burst limit.", + "type": "integer" + }, + "ThrottlingRateLimit": { + "description": "Specifies the throttling rate limit.", + "type": "number" + } + }, + "type": "object" + }, + "StageDescription": { + "additionalProperties": false, + "description": "``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.", + "properties": { + "AccessLogSetting": { + "$ref": "#/definitions/AccessLogSetting", + "description": "Specifies settings for logging access in this stage." + }, + "CacheClusterEnabled": { + "description": "Specifies whether a cache cluster is enabled for the stage.", + "type": "boolean" + }, + "CacheClusterSize": { + "description": "The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.", + "type": "string" + }, + "CacheDataEncrypted": { + "description": "Indicates whether the cached responses are encrypted.", + "type": "boolean" + }, + "CacheTtlInSeconds": { + "description": "The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.", + "type": "integer" + }, + "CachingEnabled": { + "description": "Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.", + "type": "boolean" + }, + "CanarySetting": { + "$ref": "#/definitions/CanarySetting", + "description": "Specifies settings for the canary deployment in this stage." + }, + "ClientCertificateId": { + "description": "The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.", + "type": "string" + }, + "DataTraceEnabled": { + "description": "Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.", + "type": "boolean" + }, + "Description": { + "description": "A description of the purpose of the stage.", + "type": "string" + }, + "DocumentationVersion": { + "description": "The version identifier of the API documentation snapshot.", + "type": "string" + }, + "LoggingLevel": { + "description": "The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.", + "type": "string" + }, + "MethodSettings": { + "description": "Configures settings for all of the stage's methods.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MethodSetting" + }, + "type": "array", + "uniqueItems": true + }, + "MetricsEnabled": { + "description": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.", + "type": "boolean" + }, + "Tags": { + "description": "An array of arbitrary tags (key-value pairs) to associate with the stage.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "ThrottlingBurstLimit": { + "description": "The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.", + "type": "integer" + }, + "ThrottlingRateLimit": { + "description": "The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.", + "type": "number" + }, + "TracingEnabled": { + "description": "Specifies whether active tracing with X-ray is enabled for this stage.\n For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.", + "type": "boolean" + }, + "Variables": { + "additionalProperties": false, + "description": "A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag", + "type": "string" + }, + "Value": { + "description": "The value for the tag", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT", + "apigateway:DELETE" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeploymentId", + "/properties/RestApiId" + ], + "properties": { + "DeploymentCanarySettings": { + "$ref": "#/definitions/DeploymentCanarySettings", + "description": "The input configuration for a canary deployment." + }, + "DeploymentId": { + "description": "", + "type": "string" + }, + "Description": { + "description": "The description for the Deployment resource to create.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "StageDescription": { + "$ref": "#/definitions/StageDescription", + "description": "The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name." + }, + "StageName": { + "description": "The name of the Stage resource for the Deployment resource to create.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DeploymentId" + ], + "required": [ + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::Deployment", + "writeOnlyProperties": [ + "/properties/StageName", + "/properties/StageDescription", + "/properties/DeploymentCanarySettings" + ] +} diff --git a/schema/aws-apigateway-documentationpart.json b/schema/aws-apigateway-documentationpart.json index 366a7f2..400f4c3 100644 --- a/schema/aws-apigateway-documentationpart.json +++ b/schema/aws-apigateway-documentationpart.json @@ -1,125 +1,125 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Location", - "/properties/RestApiId" - ], - "definitions": { - "Location": { - "additionalProperties": false, - "description": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.", - "properties": { - "Method": { - "description": "The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly.", - "type": "string" - }, - "Name": { - "description": "The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type.", - "type": "string" - }, - "Path": { - "description": "The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly.", - "type": "string" - }, - "Type": { - "description": "The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type.", - "enum": [ - "API", - "AUTHORIZER", - "MODEL", - "RESOURCE", - "METHOD", - "PATH_PARAMETER", - "QUERY_PARAMETER", - "REQUEST_HEADER", - "REQUEST_BODY", - "RESPONSE", - "RESPONSE_HEADER", - "RESPONSE_BODY" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:GET", - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH" - ] - } - }, - "primaryIdentifier": [ - "/properties/DocumentationPartId", - "/properties/RestApiId" - ], - "properties": { - "DocumentationPartId": { - "description": "", - "type": "string" - }, - "Location": { - "$ref": "#/definitions/Location", - "description": "The location of the targeted API entity of the to-be-created documentation part." - }, - "Properties": { - "description": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DocumentationPartId" - ], - "required": [ - "Location", - "Properties", - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::DocumentationPart" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Location", + "/properties/RestApiId" + ], + "definitions": { + "Location": { + "additionalProperties": false, + "description": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.", + "properties": { + "Method": { + "description": "The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly.", + "type": "string" + }, + "Name": { + "description": "The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type.", + "type": "string" + }, + "Path": { + "description": "The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly.", + "type": "string" + }, + "Type": { + "description": "The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type.", + "enum": [ + "API", + "AUTHORIZER", + "MODEL", + "RESOURCE", + "METHOD", + "PATH_PARAMETER", + "QUERY_PARAMETER", + "REQUEST_HEADER", + "REQUEST_BODY", + "RESPONSE", + "RESPONSE_HEADER", + "RESPONSE_BODY" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:GET", + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH" + ] + } + }, + "primaryIdentifier": [ + "/properties/DocumentationPartId", + "/properties/RestApiId" + ], + "properties": { + "DocumentationPartId": { + "description": "", + "type": "string" + }, + "Location": { + "$ref": "#/definitions/Location", + "description": "The location of the targeted API entity of the to-be-created documentation part." + }, + "Properties": { + "description": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DocumentationPartId" + ], + "required": [ + "Location", + "Properties", + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::DocumentationPart" +} diff --git a/schema/aws-apigateway-documentationversion.json b/schema/aws-apigateway-documentationversion.json index e95eade..a842dc2 100644 --- a/schema/aws-apigateway-documentationversion.json +++ b/schema/aws-apigateway-documentationversion.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DocumentationVersion", - "/properties/RestApiId" - ], - "definitions": {}, - "description": "The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:GET", - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH" - ] - } - }, - "primaryIdentifier": [ - "/properties/DocumentationVersion", - "/properties/RestApiId" - ], - "properties": { - "Description": { - "description": "A description about the new documentation snapshot.", - "type": "string" - }, - "DocumentationVersion": { - "description": "The version identifier of the to-be-updated documentation version.", - "minLength": 1, - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DocumentationVersion", - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::DocumentationVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DocumentationVersion", + "/properties/RestApiId" + ], + "definitions": {}, + "description": "The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:GET", + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH" + ] + } + }, + "primaryIdentifier": [ + "/properties/DocumentationVersion", + "/properties/RestApiId" + ], + "properties": { + "Description": { + "description": "A description about the new documentation snapshot.", + "type": "string" + }, + "DocumentationVersion": { + "description": "The version identifier of the to-be-updated documentation version.", + "minLength": 1, + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DocumentationVersion", + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::DocumentationVersion" +} diff --git a/schema/aws-apigateway-domainname.json b/schema/aws-apigateway-domainname.json index 9e880a0..605ada0 100644 --- a/schema/aws-apigateway-domainname.json +++ b/schema/aws-apigateway-domainname.json @@ -1,131 +1,131 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "definitions": { - "EndpointConfiguration": { - "additionalProperties": false, - "properties": { - "Types": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "MutualTlsAuthentication": { - "additionalProperties": false, - "properties": { - "TruststoreUri": { - "type": "string" - }, - "TruststoreVersion": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ApiGateway::DomainName.", - "handlers": { - "create": { - "permissions": [ - "apigateway:*" - ] - }, - "delete": { - "permissions": [ - "apigateway:*" - ] - }, - "list": { - "permissions": [ - "apigateway:*" - ] - }, - "read": { - "permissions": [ - "apigateway:*" - ] - }, - "update": { - "permissions": [ - "apigateway:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName" - ], - "properties": { - "CertificateArn": { - "type": "string" - }, - "DistributionDomainName": { - "type": "string" - }, - "DistributionHostedZoneId": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/EndpointConfiguration" - }, - "MutualTlsAuthentication": { - "$ref": "#/definitions/MutualTlsAuthentication" - }, - "OwnershipVerificationCertificateArn": { - "type": "string" - }, - "RegionalCertificateArn": { - "type": "string" - }, - "RegionalDomainName": { - "type": "string" - }, - "RegionalHostedZoneId": { - "type": "string" - }, - "SecurityPolicy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RegionalHostedZoneId", - "/properties/DistributionDomainName", - "/properties/RegionalDomainName", - "/properties/DistributionHostedZoneId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::DomainName" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "definitions": { + "EndpointConfiguration": { + "additionalProperties": false, + "properties": { + "Types": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "MutualTlsAuthentication": { + "additionalProperties": false, + "properties": { + "TruststoreUri": { + "type": "string" + }, + "TruststoreVersion": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ApiGateway::DomainName.", + "handlers": { + "create": { + "permissions": [ + "apigateway:*" + ] + }, + "delete": { + "permissions": [ + "apigateway:*" + ] + }, + "list": { + "permissions": [ + "apigateway:*" + ] + }, + "read": { + "permissions": [ + "apigateway:*" + ] + }, + "update": { + "permissions": [ + "apigateway:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName" + ], + "properties": { + "CertificateArn": { + "type": "string" + }, + "DistributionDomainName": { + "type": "string" + }, + "DistributionHostedZoneId": { + "type": "string" + }, + "DomainName": { + "type": "string" + }, + "EndpointConfiguration": { + "$ref": "#/definitions/EndpointConfiguration" + }, + "MutualTlsAuthentication": { + "$ref": "#/definitions/MutualTlsAuthentication" + }, + "OwnershipVerificationCertificateArn": { + "type": "string" + }, + "RegionalCertificateArn": { + "type": "string" + }, + "RegionalDomainName": { + "type": "string" + }, + "RegionalHostedZoneId": { + "type": "string" + }, + "SecurityPolicy": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RegionalHostedZoneId", + "/properties/DistributionDomainName", + "/properties/RegionalDomainName", + "/properties/DistributionHostedZoneId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::DomainName" +} diff --git a/schema/aws-apigateway-gatewayresponse.json b/schema/aws-apigateway-gatewayresponse.json index 019a99c..9e882a9 100644 --- a/schema/aws-apigateway-gatewayresponse.json +++ b/schema/aws-apigateway-gatewayresponse.json @@ -1,101 +1,101 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResponseType", - "/properties/RestApiId" - ], - "description": "The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:PUT", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "ResponseParameters": { - "additionalProperties": false, - "description": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseTemplates": { - "additionalProperties": false, - "description": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseType": { - "description": "The response type of the associated GatewayResponse.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP status code for this GatewayResponse.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResponseType", - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::GatewayResponse" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResponseType", + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:PUT", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "ResponseParameters": { + "additionalProperties": false, + "description": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseTemplates": { + "additionalProperties": false, + "description": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseType": { + "description": "The response type of the associated GatewayResponse.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP status code for this GatewayResponse.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResponseType", + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::GatewayResponse" +} diff --git a/schema/aws-apigateway-method.json b/schema/aws-apigateway-method.json index 9d030bd..5c18070 100644 --- a/schema/aws-apigateway-method.json +++ b/schema/aws-apigateway-method.json @@ -1,322 +1,322 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RestApiId", - "/properties/ResourceId", - "/properties/HttpMethod" - ], - "definitions": { - "Integration": { - "additionalProperties": false, - "description": "``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.", - "properties": { - "CacheKeyParameters": { - "description": "A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CacheNamespace": { - "description": "Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources.", - "type": "string" - }, - "ConnectionId": { - "description": "The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise.", - "type": "string" - }, - "ConnectionType": { - "description": "The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``.", - "enum": [ - "INTERNET", - "VPC_LINK" - ], - "type": "string" - }, - "ContentHandling": { - "description": "Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the ``passthroughBehavior`` is configured to support payload pass-through.", - "enum": [ - "CONVERT_TO_BINARY", - "CONVERT_TO_TEXT" - ], - "type": "string" - }, - "Credentials": { - "description": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\\*:user/\\*``. To use resource-based permissions on supported AWS services, specify null.", - "type": "string" - }, - "IntegrationHttpMethod": { - "description": "Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property.", - "type": "string" - }, - "IntegrationResponses": { - "description": "Specifies the integration's responses.", - "items": { - "$ref": "#/definitions/IntegrationResponse" - }, - "type": "array", - "uniqueItems": true - }, - "PassthroughBehavior": { - "description": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.", - "enum": [ - "WHEN_NO_MATCH", - "WHEN_NO_TEMPLATES", - "NEVER" - ], - "type": "string" - }, - "RequestParameters": { - "additionalProperties": false, - "description": "A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "RequestTemplates": { - "additionalProperties": false, - "description": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "TimeoutInMillis": { - "description": "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.", - "minimum": 50, - "type": "integer" - }, - "Type": { - "description": "Specifies an API method integration type. The valid value is one of the following:\n For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a ``connectionType`` of ``VPC_LINK`` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.", - "enum": [ - "AWS", - "AWS_PROXY", - "HTTP", - "HTTP_PROXY", - "MOCK" - ], - "type": "string" - }, - "Uri": { - "description": "Specifies Uniform Resource Identifier (URI) of the integration endpoint.\n For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "IntegrationResponse": { - "additionalProperties": false, - "description": "``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.", - "properties": { - "ContentHandling": { - "description": "Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.", - "enum": [ - "CONVERT_TO_BINARY", - "CONVERT_TO_TEXT" - ], - "type": "string" - }, - "ResponseParameters": { - "additionalProperties": false, - "description": "A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseTemplates": { - "additionalProperties": false, - "description": "Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "SelectionPattern": { - "description": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.", - "type": "string" - }, - "StatusCode": { - "description": "Specifies the status code that is used to map the integration response to an existing MethodResponse.", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "MethodResponse": { - "additionalProperties": false, - "description": "Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.", - "properties": { - "ResponseModels": { - "additionalProperties": false, - "description": "Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseParameters": { - "additionalProperties": false, - "description": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.)", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": [ - "boolean", - "string" - ] - } - }, - "type": "object" - }, - "StatusCode": { - "description": "The method response's status code.", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.", - "handlers": { - "create": { - "permissions": [ - "apigateway:PUT", - "apigateway:GET", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "apigateway:PUT", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/ResourceId", - "/properties/HttpMethod" - ], - "properties": { - "ApiKeyRequired": { - "description": "A boolean flag specifying whether a valid ApiKey is required to invoke this method.", - "type": "boolean" - }, - "AuthorizationScopes": { - "description": "A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.", - "items": { - "type": "string" - }, - "type": "array" - }, - "AuthorizationType": { - "description": "The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.\n If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.", - "type": "string" - }, - "AuthorizerId": { - "description": "The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.", - "type": "string" - }, - "HttpMethod": { - "description": "The method's HTTP verb.", - "type": "string" - }, - "Integration": { - "$ref": "#/definitions/Integration", - "description": "Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration." - }, - "MethodResponses": { - "description": "Gets a method response associated with a given HTTP status code.", - "items": { - "$ref": "#/definitions/MethodResponse" - }, - "type": "array", - "uniqueItems": true - }, - "OperationName": { - "description": "A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example.", - "type": "string" - }, - "RequestModels": { - "additionalProperties": false, - "description": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "RequestParameters": { - "additionalProperties": false, - "description": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": [ - "boolean", - "string" - ] - } - }, - "type": "object" - }, - "RequestValidatorId": { - "description": "The identifier of a RequestValidator for request validation.", - "type": "string" - }, - "ResourceId": { - "description": "The Resource identifier for the MethodResponse resource.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - } - }, - "required": [ - "RestApiId", - "ResourceId", - "HttpMethod" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGateway::Method" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RestApiId", + "/properties/ResourceId", + "/properties/HttpMethod" + ], + "definitions": { + "Integration": { + "additionalProperties": false, + "description": "``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.", + "properties": { + "CacheKeyParameters": { + "description": "A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CacheNamespace": { + "description": "Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources.", + "type": "string" + }, + "ConnectionId": { + "description": "The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise.", + "type": "string" + }, + "ConnectionType": { + "description": "The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``.", + "enum": [ + "INTERNET", + "VPC_LINK" + ], + "type": "string" + }, + "ContentHandling": { + "description": "Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the ``passthroughBehavior`` is configured to support payload pass-through.", + "enum": [ + "CONVERT_TO_BINARY", + "CONVERT_TO_TEXT" + ], + "type": "string" + }, + "Credentials": { + "description": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\\*:user/\\*``. To use resource-based permissions on supported AWS services, specify null.", + "type": "string" + }, + "IntegrationHttpMethod": { + "description": "Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property.", + "type": "string" + }, + "IntegrationResponses": { + "description": "Specifies the integration's responses.", + "items": { + "$ref": "#/definitions/IntegrationResponse" + }, + "type": "array", + "uniqueItems": true + }, + "PassthroughBehavior": { + "description": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.", + "enum": [ + "WHEN_NO_MATCH", + "WHEN_NO_TEMPLATES", + "NEVER" + ], + "type": "string" + }, + "RequestParameters": { + "additionalProperties": false, + "description": "A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "RequestTemplates": { + "additionalProperties": false, + "description": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "TimeoutInMillis": { + "description": "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.", + "minimum": 50, + "type": "integer" + }, + "Type": { + "description": "Specifies an API method integration type. The valid value is one of the following:\n For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a ``connectionType`` of ``VPC_LINK`` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.", + "enum": [ + "AWS", + "AWS_PROXY", + "HTTP", + "HTTP_PROXY", + "MOCK" + ], + "type": "string" + }, + "Uri": { + "description": "Specifies Uniform Resource Identifier (URI) of the integration endpoint.\n For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "IntegrationResponse": { + "additionalProperties": false, + "description": "``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.", + "properties": { + "ContentHandling": { + "description": "Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.", + "enum": [ + "CONVERT_TO_BINARY", + "CONVERT_TO_TEXT" + ], + "type": "string" + }, + "ResponseParameters": { + "additionalProperties": false, + "description": "A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseTemplates": { + "additionalProperties": false, + "description": "Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "SelectionPattern": { + "description": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.", + "type": "string" + }, + "StatusCode": { + "description": "Specifies the status code that is used to map the integration response to an existing MethodResponse.", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "MethodResponse": { + "additionalProperties": false, + "description": "Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.", + "properties": { + "ResponseModels": { + "additionalProperties": false, + "description": "Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseParameters": { + "additionalProperties": false, + "description": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.)", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "StatusCode": { + "description": "The method response's status code.", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.", + "handlers": { + "create": { + "permissions": [ + "apigateway:PUT", + "apigateway:GET", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "apigateway:PUT", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/ResourceId", + "/properties/HttpMethod" + ], + "properties": { + "ApiKeyRequired": { + "description": "A boolean flag specifying whether a valid ApiKey is required to invoke this method.", + "type": "boolean" + }, + "AuthorizationScopes": { + "description": "A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "AuthorizationType": { + "description": "The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.\n If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.", + "type": "string" + }, + "AuthorizerId": { + "description": "The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.", + "type": "string" + }, + "HttpMethod": { + "description": "The method's HTTP verb.", + "type": "string" + }, + "Integration": { + "$ref": "#/definitions/Integration", + "description": "Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration." + }, + "MethodResponses": { + "description": "Gets a method response associated with a given HTTP status code.", + "items": { + "$ref": "#/definitions/MethodResponse" + }, + "type": "array", + "uniqueItems": true + }, + "OperationName": { + "description": "A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example.", + "type": "string" + }, + "RequestModels": { + "additionalProperties": false, + "description": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "RequestParameters": { + "additionalProperties": false, + "description": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "RequestValidatorId": { + "description": "The identifier of a RequestValidator for request validation.", + "type": "string" + }, + "ResourceId": { + "description": "The Resource identifier for the MethodResponse resource.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + } + }, + "required": [ + "RestApiId", + "ResourceId", + "HttpMethod" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGateway::Method" +} diff --git a/schema/aws-apigateway-model.json b/schema/aws-apigateway-model.json index fe20c30..ff4e106 100644 --- a/schema/aws-apigateway-model.json +++ b/schema/aws-apigateway-model.json @@ -1,86 +1,86 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContentType", - "/properties/Name", - "/properties/RestApiId" - ], - "description": "The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/Name" - ], - "properties": { - "ContentType": { - "description": "The content-type for the model.", - "type": "string" - }, - "Description": { - "description": "The description of the model.", - "type": "string" - }, - "Name": { - "description": "A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "Schema": { - "description": "The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::Model" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContentType", + "/properties/Name", + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/Name" + ], + "properties": { + "ContentType": { + "description": "The content-type for the model.", + "type": "string" + }, + "Description": { + "description": "The description of the model.", + "type": "string" + }, + "Name": { + "description": "A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "Schema": { + "description": "The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::Model" +} diff --git a/schema/aws-apigateway-requestvalidator.json b/schema/aws-apigateway-requestvalidator.json index e81a5b2..87a5b93 100644 --- a/schema/aws-apigateway-requestvalidator.json +++ b/schema/aws-apigateway-requestvalidator.json @@ -1,84 +1,84 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/RestApiId" - ], - "description": "The ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/RequestValidatorId" - ], - "properties": { - "Name": { - "description": "The name of this RequestValidator", - "type": "string" - }, - "RequestValidatorId": { - "description": "", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "ValidateRequestBody": { - "description": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema.", - "type": "boolean" - }, - "ValidateRequestParameters": { - "description": "A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).", - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/RequestValidatorId" - ], - "required": [ - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::RequestValidator" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/RequestValidatorId" + ], + "properties": { + "Name": { + "description": "The name of this RequestValidator", + "type": "string" + }, + "RequestValidatorId": { + "description": "", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "ValidateRequestBody": { + "description": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema.", + "type": "boolean" + }, + "ValidateRequestParameters": { + "description": "A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).", + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/RequestValidatorId" + ], + "required": [ + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::RequestValidator" +} diff --git a/schema/aws-apigateway-resource.json b/schema/aws-apigateway-resource.json index c3b76a9..7df6363 100644 --- a/schema/aws-apigateway-resource.json +++ b/schema/aws-apigateway-resource.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PathPart", - "/properties/ParentId", - "/properties/RestApiId" - ], - "description": "The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/ResourceId" - ], - "properties": { - "ParentId": { - "description": "The parent resource's identifier.", - "type": "string" - }, - "PathPart": { - "description": "The last path segment for this resource.", - "type": "string" - }, - "ResourceId": { - "description": "", - "type": "string" - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceId" - ], - "required": [ - "ParentId", - "PathPart", - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::Resource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PathPart", + "/properties/ParentId", + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/ResourceId" + ], + "properties": { + "ParentId": { + "description": "The parent resource's identifier.", + "type": "string" + }, + "PathPart": { + "description": "The last path segment for this resource.", + "type": "string" + }, + "ResourceId": { + "description": "", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceId" + ], + "required": [ + "ParentId", + "PathPart", + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::Resource" +} diff --git a/schema/aws-apigateway-restapi.json b/schema/aws-apigateway-restapi.json index ff7d41d..41f9791 100644 --- a/schema/aws-apigateway-restapi.json +++ b/schema/aws-apigateway-restapi.json @@ -1,238 +1,238 @@ -{ - "additionalProperties": false, - "definitions": { - "EndpointConfiguration": { - "additionalProperties": false, - "description": "The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API.\n ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.", - "properties": { - "Types": { - "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``\"EDGE\"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "VpcEndpointIds": { - "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.", - "items": { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::VPCEndpoint" - }, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "description": "``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.\n On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.", - "properties": { - "Bucket": { - "description": "The name of the S3 bucket where the OpenAPI file is stored.", - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "ETag": { - "description": "The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.", - "type": "string" - }, - "Key": { - "description": "The file name of the OpenAPI file (Amazon S3 object name).", - "type": "string" - }, - "Version": { - "description": "For versioning-enabled buckets, a specific version of the OpenAPI file.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.\n On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.", - "handlers": { - "create": { - "permissions": [ - "apigateway:GET", - "apigateway:POST", - "apigateway:PUT", - "apigateway:PATCH", - "apigateway:UpdateRestApiPolicy", - "s3:GetObject", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:UpdateRestApiPolicy", - "s3:GetObject", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId" - ], - "properties": { - "ApiKeySourceType": { - "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.", - "type": "string" - }, - "BinaryMediaTypes": { - "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Body": { - "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.", - "type": [ - "object", - "string" - ] - }, - "BodyS3Location": { - "$ref": "#/definitions/S3Location", - "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format." - }, - "CloneFrom": { - "description": "The ID of the RestApi that you want to clone from.", - "type": "string" - }, - "Description": { - "description": "The description of the RestApi.", - "type": "string" - }, - "DisableExecuteApiEndpoint": { - "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint", - "type": "boolean" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/EndpointConfiguration", - "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property." - }, - "FailOnWarnings": { - "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.", - "type": "boolean" - }, - "MinimumCompressionSize": { - "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.", - "type": "integer" - }, - "Mode": { - "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.\n Valid values are ``overwrite`` or ``merge``. \n For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.\n For ``merge``, the new API definition is merged with the existing API.\n If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. \n Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.", - "type": "string" - }, - "Name": { - "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.", - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": [ - "object", - "string" - ] - }, - "Policy": { - "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``\"\"`` as delimiter and values of ``\"execute-api:/\"`` and ``\"*\"``.", - "type": [ - "object", - "string" - ] - }, - "RestApiId": { - "description": "", - "type": "string" - }, - "RootResourceId": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/RestApiId", - "/properties/RootResourceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:GET" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::RestApi", - "writeOnlyProperties": [ - "/properties/Body", - "/properties/BodyS3Location", - "/properties/CloneFrom", - "/properties/FailOnWarnings", - "/properties/Mode", - "/properties/Parameters" - ] -} +{ + "additionalProperties": false, + "definitions": { + "EndpointConfiguration": { + "additionalProperties": false, + "description": "The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API.\n ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.", + "properties": { + "Types": { + "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``\"EDGE\"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "VpcEndpointIds": { + "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.", + "items": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::VPCEndpoint" + }, + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.\n On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.", + "properties": { + "Bucket": { + "description": "The name of the S3 bucket where the OpenAPI file is stored.", + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "ETag": { + "description": "The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.", + "type": "string" + }, + "Key": { + "description": "The file name of the OpenAPI file (Amazon S3 object name).", + "type": "string" + }, + "Version": { + "description": "For versioning-enabled buckets, a specific version of the OpenAPI file.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.\n On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.", + "handlers": { + "create": { + "permissions": [ + "apigateway:GET", + "apigateway:POST", + "apigateway:PUT", + "apigateway:PATCH", + "apigateway:UpdateRestApiPolicy", + "s3:GetObject", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:UpdateRestApiPolicy", + "s3:GetObject", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId" + ], + "properties": { + "ApiKeySourceType": { + "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.", + "type": "string" + }, + "BinaryMediaTypes": { + "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Body": { + "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.", + "type": [ + "object", + "string" + ] + }, + "BodyS3Location": { + "$ref": "#/definitions/S3Location", + "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format." + }, + "CloneFrom": { + "description": "The ID of the RestApi that you want to clone from.", + "type": "string" + }, + "Description": { + "description": "The description of the RestApi.", + "type": "string" + }, + "DisableExecuteApiEndpoint": { + "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint", + "type": "boolean" + }, + "EndpointConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property." + }, + "FailOnWarnings": { + "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.", + "type": "boolean" + }, + "MinimumCompressionSize": { + "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.", + "type": "integer" + }, + "Mode": { + "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.\n Valid values are ``overwrite`` or ``merge``. \n For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.\n For ``merge``, the new API definition is merged with the existing API.\n If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. \n Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.", + "type": "string" + }, + "Name": { + "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.", + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "Policy": { + "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``\"\"`` as delimiter and values of ``\"execute-api:/\"`` and ``\"*\"``.", + "type": [ + "object", + "string" + ] + }, + "RestApiId": { + "description": "", + "type": "string" + }, + "RootResourceId": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/RestApiId", + "/properties/RootResourceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::RestApi", + "writeOnlyProperties": [ + "/properties/Body", + "/properties/BodyS3Location", + "/properties/CloneFrom", + "/properties/FailOnWarnings", + "/properties/Mode", + "/properties/Parameters" + ] +} diff --git a/schema/aws-apigateway-stage.json b/schema/aws-apigateway-stage.json index 4eabc44..8c476a3 100644 --- a/schema/aws-apigateway-stage.json +++ b/schema/aws-apigateway-stage.json @@ -1,266 +1,266 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RestApiId", - "/properties/StageName" - ], - "definitions": { - "AccessLogSetting": { - "additionalProperties": false, - "description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.", - "properties": { - "DestinationArn": { - "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging.", - "type": "string" - }, - "Format": { - "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging.", - "type": "string" - } - }, - "type": "object" - }, - "CanarySetting": { - "additionalProperties": false, - "description": "Configuration settings of a canary deployment.", - "properties": { - "DeploymentId": { - "description": "The ID of the canary deployment.", - "type": "string" - }, - "PercentTraffic": { - "description": "The percent (0-100) of traffic diverted to a canary deployment.", - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": false, - "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.", - "type": "boolean" - } - }, - "type": "object" - }, - "MethodSetting": { - "additionalProperties": false, - "description": "The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.", - "properties": { - "CacheDataEncrypted": { - "description": "Specifies whether the cached responses are encrypted.", - "type": "boolean" - }, - "CacheTtlInSeconds": { - "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.", - "type": "integer" - }, - "CachingEnabled": { - "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.", - "type": "boolean" - }, - "DataTraceEnabled": { - "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.", - "type": "boolean" - }, - "HttpMethod": { - "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.", - "type": "string" - }, - "LoggingLevel": { - "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.", - "type": "string" - }, - "MetricsEnabled": { - "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method.", - "type": "boolean" - }, - "ResourcePath": { - "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.", - "type": "string" - }, - "ThrottlingBurstLimit": { - "description": "Specifies the throttling burst limit.", - "minimum": 0, - "type": "integer" - }, - "ThrottlingRateLimit": { - "description": "Specifies the throttling rate limit.", - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RestApiId": { - "$ref": "resource-schema.json#/properties/RestApiId" - } - }, - "required": [ - "RestApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:DELETE" - ] - } - }, - "primaryIdentifier": [ - "/properties/RestApiId", - "/properties/StageName" - ], - "properties": { - "AccessLogSetting": { - "$ref": "#/definitions/AccessLogSetting", - "description": "Access log settings, including the access log format and access log destination ARN." - }, - "CacheClusterEnabled": { - "description": "Specifies whether a cache cluster is enabled for the stage.", - "type": "boolean" - }, - "CacheClusterSize": { - "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).", - "type": "string" - }, - "CanarySetting": { - "$ref": "#/definitions/CanarySetting", - "description": "Settings for the canary deployment in this stage." - }, - "ClientCertificateId": { - "description": "The identifier of a client certificate for an API stage.", - "type": "string" - }, - "DeploymentId": { - "description": "The identifier of the Deployment that the stage points to.", - "type": "string" - }, - "Description": { - "description": "The stage's description.", - "type": "string" - }, - "DocumentationVersion": { - "description": "The version of the associated API documentation.", - "type": "string" - }, - "MethodSettings": { - "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MethodSetting" - }, - "type": "array", - "uniqueItems": true - }, - "RestApiId": { - "description": "The string identifier of the associated RestApi.", - "type": "string" - }, - "StageName": { - "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.", - "type": "string" - }, - "Tags": { - "description": "The collection of tags. Each tag element is associated with a given resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TracingEnabled": { - "description": "Specifies whether active tracing with X-ray is enabled for the Stage.", - "type": "boolean" - }, - "Variables": { - "additionalProperties": false, - "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "RestApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:GET" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::Stage" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RestApiId", + "/properties/StageName" + ], + "definitions": { + "AccessLogSetting": { + "additionalProperties": false, + "description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.", + "properties": { + "DestinationArn": { + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging.", + "type": "string" + }, + "Format": { + "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging.", + "type": "string" + } + }, + "type": "object" + }, + "CanarySetting": { + "additionalProperties": false, + "description": "Configuration settings of a canary deployment.", + "properties": { + "DeploymentId": { + "description": "The ID of the canary deployment.", + "type": "string" + }, + "PercentTraffic": { + "description": "The percent (0-100) of traffic diverted to a canary deployment.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "StageVariableOverrides": { + "additionalProperties": false, + "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "UseStageCache": { + "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "MethodSetting": { + "additionalProperties": false, + "description": "The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.", + "properties": { + "CacheDataEncrypted": { + "description": "Specifies whether the cached responses are encrypted.", + "type": "boolean" + }, + "CacheTtlInSeconds": { + "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.", + "type": "integer" + }, + "CachingEnabled": { + "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.", + "type": "boolean" + }, + "DataTraceEnabled": { + "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.", + "type": "boolean" + }, + "HttpMethod": { + "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.", + "type": "string" + }, + "LoggingLevel": { + "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.", + "type": "string" + }, + "MetricsEnabled": { + "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method.", + "type": "boolean" + }, + "ResourcePath": { + "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.", + "type": "string" + }, + "ThrottlingBurstLimit": { + "description": "Specifies the throttling burst limit.", + "minimum": 0, + "type": "integer" + }, + "ThrottlingRateLimit": { + "description": "Specifies the throttling rate limit.", + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:DELETE" + ] + } + }, + "primaryIdentifier": [ + "/properties/RestApiId", + "/properties/StageName" + ], + "properties": { + "AccessLogSetting": { + "$ref": "#/definitions/AccessLogSetting", + "description": "Access log settings, including the access log format and access log destination ARN." + }, + "CacheClusterEnabled": { + "description": "Specifies whether a cache cluster is enabled for the stage.", + "type": "boolean" + }, + "CacheClusterSize": { + "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).", + "type": "string" + }, + "CanarySetting": { + "$ref": "#/definitions/CanarySetting", + "description": "Settings for the canary deployment in this stage." + }, + "ClientCertificateId": { + "description": "The identifier of a client certificate for an API stage.", + "type": "string" + }, + "DeploymentId": { + "description": "The identifier of the Deployment that the stage points to.", + "type": "string" + }, + "Description": { + "description": "The stage's description.", + "type": "string" + }, + "DocumentationVersion": { + "description": "The version of the associated API documentation.", + "type": "string" + }, + "MethodSettings": { + "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MethodSetting" + }, + "type": "array", + "uniqueItems": true + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "StageName": { + "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.", + "type": "string" + }, + "Tags": { + "description": "The collection of tags. Each tag element is associated with a given resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TracingEnabled": { + "description": "Specifies whether active tracing with X-ray is enabled for the Stage.", + "type": "boolean" + }, + "Variables": { + "additionalProperties": false, + "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::Stage" +} diff --git a/schema/aws-apigateway-usageplan.json b/schema/aws-apigateway-usageplan.json index 01660ba..38a1312 100644 --- a/schema/aws-apigateway-usageplan.json +++ b/schema/aws-apigateway-usageplan.json @@ -1,185 +1,185 @@ -{ - "additionalProperties": false, - "definitions": { - "ApiStage": { - "additionalProperties": false, - "description": "API stage name of the associated API stage in a usage plan.", - "properties": { - "ApiId": { - "description": "API Id of the associated API stage in a usage plan.", - "type": "string" - }, - "Stage": { - "description": "API stage name of the associated API stage in a usage plan.", - "type": "string" - }, - "Throttle": { - "additionalProperties": false, - "description": "Map containing method level throttling information for API stage in a usage plan.", - "patternProperties": { - ".*": { - "$ref": "#/definitions/ThrottleSettings" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "QuotaSettings": { - "additionalProperties": false, - "description": "``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.\n In some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", - "properties": { - "Limit": { - "description": "The target maximum number of requests that can be made in a given time period.", - "minimum": 0, - "type": "integer" - }, - "Offset": { - "description": "The number of requests subtracted from the given limit in the initial time period.", - "minimum": 0, - "type": "integer" - }, - "Period": { - "description": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ThrottleSettings": { - "additionalProperties": false, - "description": "``ThrottleSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.", - "properties": { - "BurstLimit": { - "description": "The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.", - "minimum": 0, - "type": "integer" - }, - "RateLimit": { - "description": "The API target request rate limit.", - "minimum": 0, - "type": "number" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.\n In some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET", - "apigateway:PUT" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE", - "apigateway:GET", - "apigateway:PATCH" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "apigateway:PATCH", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiStages": { - "description": "The associated API stages of a usage plan.", - "items": { - "$ref": "#/definitions/ApiStage" - }, - "type": "array", - "uniqueItems": true - }, - "Description": { - "description": "The description of a usage plan.", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "Quota": { - "$ref": "#/definitions/QuotaSettings", - "description": "The target maximum number of permitted requests per a given unit time interval." - }, - "Tags": { - "description": "The collection of tags. Each tag element is associated with a given resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Throttle": { - "$ref": "#/definitions/ThrottleSettings", - "description": "A map containing method level throttling information for API stage in a usage plan." - }, - "UsagePlanName": { - "description": "The name of a usage plan.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:GET" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::UsagePlan" -} +{ + "additionalProperties": false, + "definitions": { + "ApiStage": { + "additionalProperties": false, + "description": "API stage name of the associated API stage in a usage plan.", + "properties": { + "ApiId": { + "description": "API Id of the associated API stage in a usage plan.", + "type": "string" + }, + "Stage": { + "description": "API stage name of the associated API stage in a usage plan.", + "type": "string" + }, + "Throttle": { + "additionalProperties": false, + "description": "Map containing method level throttling information for API stage in a usage plan.", + "patternProperties": { + ".*": { + "$ref": "#/definitions/ThrottleSettings" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "QuotaSettings": { + "additionalProperties": false, + "description": "``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.\n In some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", + "properties": { + "Limit": { + "description": "The target maximum number of requests that can be made in a given time period.", + "minimum": 0, + "type": "integer" + }, + "Offset": { + "description": "The number of requests subtracted from the given limit in the initial time period.", + "minimum": 0, + "type": "integer" + }, + "Period": { + "description": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ThrottleSettings": { + "additionalProperties": false, + "description": "``ThrottleSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.", + "properties": { + "BurstLimit": { + "description": "The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.", + "minimum": 0, + "type": "integer" + }, + "RateLimit": { + "description": "The API target request rate limit.", + "minimum": 0, + "type": "number" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.\n In some cases clients can exceed the targets that you set. Don\u2019t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET", + "apigateway:PUT" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE", + "apigateway:GET", + "apigateway:PATCH" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "apigateway:PATCH", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiStages": { + "description": "The associated API stages of a usage plan.", + "items": { + "$ref": "#/definitions/ApiStage" + }, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "The description of a usage plan.", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "Quota": { + "$ref": "#/definitions/QuotaSettings", + "description": "The target maximum number of permitted requests per a given unit time interval." + }, + "Tags": { + "description": "The collection of tags. Each tag element is associated with a given resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Throttle": { + "$ref": "#/definitions/ThrottleSettings", + "description": "A map containing method level throttling information for API stage in a usage plan." + }, + "UsagePlanName": { + "description": "The name of a usage plan.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::UsagePlan" +} diff --git a/schema/aws-apigateway-usageplankey.json b/schema/aws-apigateway-usageplankey.json index c38e993..74cf3f2 100644 --- a/schema/aws-apigateway-usageplankey.json +++ b/schema/aws-apigateway-usageplankey.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KeyId", - "/properties/UsagePlanId", - "/properties/KeyType" - ], - "description": "The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE", - "apigateway:GET" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "UsagePlanId": { - "$ref": "resource-schema.json#/properties/UsagePlanId" - } - }, - "required": [ - "UsagePlanId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "KeyId": { - "description": "The Id of the UsagePlanKey resource.", - "type": "string" - }, - "KeyType": { - "description": "The type of a UsagePlanKey resource for a plan customer.", - "enum": [ - "API_KEY" - ], - "type": "string" - }, - "UsagePlanId": { - "description": "The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "KeyType", - "UsagePlanId", - "KeyId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGateway::UsagePlanKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KeyId", + "/properties/UsagePlanId", + "/properties/KeyType" + ], + "description": "The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE", + "apigateway:GET" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "UsagePlanId": { + "$ref": "resource-schema.json#/properties/UsagePlanId" + } + }, + "required": [ + "UsagePlanId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "KeyId": { + "description": "The Id of the UsagePlanKey resource.", + "type": "string" + }, + "KeyType": { + "description": "The type of a UsagePlanKey resource for a plan customer.", + "enum": [ + "API_KEY" + ], + "type": "string" + }, + "UsagePlanId": { + "description": "The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "KeyType", + "UsagePlanId", + "KeyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::UsagePlanKey" +} diff --git a/schema/aws-apigateway-vpclink.json b/schema/aws-apigateway-vpclink.json index 5662f39..746a11d 100644 --- a/schema/aws-apigateway-vpclink.json +++ b/schema/aws-apigateway-vpclink.json @@ -1,130 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetArns" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGateway::VpcLink`` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the ``Amazon API Gateway REST API Reference``.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:PUT", - "apigateway:GET", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "apigateway:PUT", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions" - ] - }, - "list": { - "permissions": [ - "apigateway:GET", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions" - ] - }, - "read": { - "permissions": [ - "apigateway:GET", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpcLinkId" - ], - "properties": { - "Description": { - "description": "The description of the VPC link.", - "type": "string" - }, - "Name": { - "description": "The name used to label and identify the VPC link.", - "type": "string" - }, - "Tags": { - "description": "An array of arbitrary tags (key-value pairs) to associate with the VPC link.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TargetArns": { - "description": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VpcLinkId": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VpcLinkId" - ], - "required": [ - "Name", - "TargetArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGateway::VpcLink" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetArns" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGateway::VpcLink`` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the ``Amazon API Gateway REST API Reference``.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:PUT", + "apigateway:GET", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "apigateway:PUT", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions" + ] + }, + "list": { + "permissions": [ + "apigateway:GET", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions" + ] + }, + "read": { + "permissions": [ + "apigateway:GET", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpcLinkId" + ], + "properties": { + "Description": { + "description": "The description of the VPC link.", + "type": "string" + }, + "Name": { + "description": "The name used to label and identify the VPC link.", + "type": "string" + }, + "Tags": { + "description": "An array of arbitrary tags (key-value pairs) to associate with the VPC link.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TargetArns": { + "description": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VpcLinkId": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VpcLinkId" + ], + "required": [ + "Name", + "TargetArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGateway::VpcLink" +} diff --git a/schema/aws-apigatewayv2-api.json b/schema/aws-apigatewayv2-api.json index 6bff540..634af84 100644 --- a/schema/aws-apigatewayv2-api.json +++ b/schema/aws-apigatewayv2-api.json @@ -1,229 +1,229 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProtocolType" - ], - "definitions": { - "BodyS3Location": { - "additionalProperties": false, - "description": "The ``BodyS3Location`` property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.", - "properties": { - "Bucket": { - "description": "The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API.", - "type": "string" - }, - "Etag": { - "description": "The Etag of the S3 object.", - "type": "string" - }, - "Key": { - "description": "The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API.", - "type": "string" - }, - "Version": { - "description": "The version of the S3 object.", - "type": "string" - } - }, - "type": "object" - }, - "Cors": { - "additionalProperties": false, - "description": "The ``Cors`` property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.", - "properties": { - "AllowCredentials": { - "description": "Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.", - "type": "boolean" - }, - "AllowHeaders": { - "description": "Represents a collection of allowed headers. Supported only for HTTP APIs.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowMethods": { - "description": "Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowOrigins": { - "description": "Represents a collection of allowed origins. Supported only for HTTP APIs.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ExposeHeaders": { - "description": "Represents a collection of exposed headers. Supported only for HTTP APIs.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxAge": { - "description": "The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:PUT", - "s3:getObject" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "s3:getObject" - ] - }, - "list": { - "permissions": [ - "apigateway:GET", - "s3:getObject" - ] - }, - "read": { - "permissions": [ - "apigateway:GET", - "s3:getObject" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT", - "apigateway:POST", - "s3:getObject" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId" - ], - "properties": { - "ApiEndpoint": { - "description": "", - "type": "string" - }, - "ApiId": { - "description": "", - "type": "string" - }, - "ApiKeySelectionExpression": { - "description": "An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).", - "type": "string" - }, - "BasePath": { - "description": "Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.", - "type": "string" - }, - "Body": { - "description": "The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.", - "type": "object" - }, - "BodyS3Location": { - "$ref": "#/definitions/BodyS3Location", - "description": "The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources." - }, - "CorsConfiguration": { - "$ref": "#/definitions/Cors", - "description": "A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information." - }, - "CredentialsArn": { - "description": "This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.", - "type": "string" - }, - "Description": { - "description": "The description of the API.", - "type": "string" - }, - "DisableExecuteApiEndpoint": { - "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.", - "type": "boolean" - }, - "DisableSchemaValidation": { - "description": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.", - "type": "boolean" - }, - "FailOnWarnings": { - "description": "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.", - "type": "boolean" - }, - "Name": { - "description": "The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.", - "type": "string" - }, - "ProtocolType": { - "description": "The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.", - "type": "string" - }, - "RouteKey": { - "description": "This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.", - "type": "string" - }, - "RouteSelectionExpression": { - "description": "The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The collection of tags. Each tag element is associated with a given resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "Target": { - "description": "This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.", - "type": "string" - }, - "Version": { - "description": "A version identifier for the API.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApiId", - "/properties/ApiEndpoint" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGatewayV2::Api", - "writeOnlyProperties": [ - "/properties/BasePath", - "/properties/Body", - "/properties/BodyS3Location", - "/properties/BodyS3Location/Etag", - "/properties/BodyS3Location/Bucket", - "/properties/BodyS3Location/Version", - "/properties/BodyS3Location/Key", - "/properties/CredentialsArn", - "/properties/FailOnWarnings", - "/properties/RouteKey", - "/properties/Target", - "/properties/DisableSchemaValidation" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProtocolType" + ], + "definitions": { + "BodyS3Location": { + "additionalProperties": false, + "description": "The ``BodyS3Location`` property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.", + "properties": { + "Bucket": { + "description": "The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API.", + "type": "string" + }, + "Etag": { + "description": "The Etag of the S3 object.", + "type": "string" + }, + "Key": { + "description": "The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API.", + "type": "string" + }, + "Version": { + "description": "The version of the S3 object.", + "type": "string" + } + }, + "type": "object" + }, + "Cors": { + "additionalProperties": false, + "description": "The ``Cors`` property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.", + "properties": { + "AllowCredentials": { + "description": "Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.", + "type": "boolean" + }, + "AllowHeaders": { + "description": "Represents a collection of allowed headers. Supported only for HTTP APIs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowMethods": { + "description": "Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowOrigins": { + "description": "Represents a collection of allowed origins. Supported only for HTTP APIs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ExposeHeaders": { + "description": "Represents a collection of exposed headers. Supported only for HTTP APIs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxAge": { + "description": "The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:PUT", + "s3:getObject" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "s3:getObject" + ] + }, + "list": { + "permissions": [ + "apigateway:GET", + "s3:getObject" + ] + }, + "read": { + "permissions": [ + "apigateway:GET", + "s3:getObject" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT", + "apigateway:POST", + "s3:getObject" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId" + ], + "properties": { + "ApiEndpoint": { + "description": "", + "type": "string" + }, + "ApiId": { + "description": "", + "type": "string" + }, + "ApiKeySelectionExpression": { + "description": "An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).", + "type": "string" + }, + "BasePath": { + "description": "Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.", + "type": "string" + }, + "Body": { + "description": "The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.", + "type": "object" + }, + "BodyS3Location": { + "$ref": "#/definitions/BodyS3Location", + "description": "The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources." + }, + "CorsConfiguration": { + "$ref": "#/definitions/Cors", + "description": "A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information." + }, + "CredentialsArn": { + "description": "This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.", + "type": "string" + }, + "Description": { + "description": "The description of the API.", + "type": "string" + }, + "DisableExecuteApiEndpoint": { + "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.", + "type": "boolean" + }, + "DisableSchemaValidation": { + "description": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.", + "type": "boolean" + }, + "FailOnWarnings": { + "description": "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.", + "type": "boolean" + }, + "Name": { + "description": "The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.", + "type": "string" + }, + "ProtocolType": { + "description": "The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.", + "type": "string" + }, + "RouteKey": { + "description": "This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.", + "type": "string" + }, + "RouteSelectionExpression": { + "description": "The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The collection of tags. Each tag element is associated with a given resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "Target": { + "description": "This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.", + "type": "string" + }, + "Version": { + "description": "A version identifier for the API.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApiId", + "/properties/ApiEndpoint" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGatewayV2::Api", + "writeOnlyProperties": [ + "/properties/BasePath", + "/properties/Body", + "/properties/BodyS3Location", + "/properties/BodyS3Location/Etag", + "/properties/BodyS3Location/Bucket", + "/properties/BodyS3Location/Version", + "/properties/BodyS3Location/Key", + "/properties/CredentialsArn", + "/properties/FailOnWarnings", + "/properties/RouteKey", + "/properties/Target", + "/properties/DisableSchemaValidation" + ] +} diff --git a/schema/aws-apigatewayv2-apigatewaymanagedoverrides.json b/schema/aws-apigatewayv2-apigatewaymanagedoverrides.json index be84bc1..dbe47e0 100644 --- a/schema/aws-apigatewayv2-apigatewaymanagedoverrides.json +++ b/schema/aws-apigatewayv2-apigatewaymanagedoverrides.json @@ -1,136 +1,136 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "definitions": { - "AccessLogSettings": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "IntegrationOverrides": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "IntegrationMethod": { - "type": "string" - }, - "PayloadFormatVersion": { - "type": "string" - }, - "TimeoutInMillis": { - "type": "integer" - } - }, - "type": "object" - }, - "RouteOverrides": { - "additionalProperties": false, - "properties": { - "AuthorizationScopes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AuthorizationType": { - "type": "string" - }, - "AuthorizerId": { - "type": "string" - }, - "OperationName": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "type": "object" - }, - "RouteSettings": { - "additionalProperties": false, - "properties": { - "DataTraceEnabled": { - "type": "boolean" - }, - "DetailedMetricsEnabled": { - "type": "boolean" - }, - "LoggingLevel": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "integer" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "StageOverrides": { - "additionalProperties": false, - "properties": { - "AccessLogSettings": { - "$ref": "#/definitions/AccessLogSettings" - }, - "AutoDeploy": { - "type": "boolean" - }, - "DefaultRouteSettings": { - "$ref": "#/definitions/RouteSettings" - }, - "Description": { - "type": "string" - }, - "RouteSettings": { - "type": "object" - }, - "StageVariables": { - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ApiGatewayV2::ApiGatewayManagedOverrides", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Integration": { - "$ref": "#/definitions/IntegrationOverrides" - }, - "Route": { - "$ref": "#/definitions/RouteOverrides" - }, - "Stage": { - "$ref": "#/definitions/StageOverrides" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApiId" - ], - "typeName": "AWS::ApiGatewayV2::ApiGatewayManagedOverrides" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "AccessLogSettings": { + "additionalProperties": false, + "properties": { + "DestinationArn": { + "type": "string" + }, + "Format": { + "type": "string" + } + }, + "type": "object" + }, + "IntegrationOverrides": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "IntegrationMethod": { + "type": "string" + }, + "PayloadFormatVersion": { + "type": "string" + }, + "TimeoutInMillis": { + "type": "integer" + } + }, + "type": "object" + }, + "RouteOverrides": { + "additionalProperties": false, + "properties": { + "AuthorizationScopes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AuthorizationType": { + "type": "string" + }, + "AuthorizerId": { + "type": "string" + }, + "OperationName": { + "type": "string" + }, + "Target": { + "type": "string" + } + }, + "type": "object" + }, + "RouteSettings": { + "additionalProperties": false, + "properties": { + "DataTraceEnabled": { + "type": "boolean" + }, + "DetailedMetricsEnabled": { + "type": "boolean" + }, + "LoggingLevel": { + "type": "string" + }, + "ThrottlingBurstLimit": { + "type": "integer" + }, + "ThrottlingRateLimit": { + "type": "number" + } + }, + "type": "object" + }, + "StageOverrides": { + "additionalProperties": false, + "properties": { + "AccessLogSettings": { + "$ref": "#/definitions/AccessLogSettings" + }, + "AutoDeploy": { + "type": "boolean" + }, + "DefaultRouteSettings": { + "$ref": "#/definitions/RouteSettings" + }, + "Description": { + "type": "string" + }, + "RouteSettings": { + "type": "object" + }, + "StageVariables": { + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ApiGatewayV2::ApiGatewayManagedOverrides", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Integration": { + "$ref": "#/definitions/IntegrationOverrides" + }, + "Route": { + "$ref": "#/definitions/RouteOverrides" + }, + "Stage": { + "$ref": "#/definitions/StageOverrides" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApiId" + ], + "typeName": "AWS::ApiGatewayV2::ApiGatewayManagedOverrides" +} diff --git a/schema/aws-apigatewayv2-apimapping.json b/schema/aws-apigatewayv2-apimapping.json index cc7fd72..ad82fc2 100644 --- a/schema/aws-apigatewayv2-apimapping.json +++ b/schema/aws-apigatewayv2-apimapping.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "description": "The ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiMappingId", - "/properties/DomainName" - ], - "properties": { - "ApiId": { - "description": "The identifier of the API.", - "type": "string" - }, - "ApiMappingId": { - "description": "", - "type": "string" - }, - "ApiMappingKey": { - "description": "The API mapping key.", - "type": "string" - }, - "DomainName": { - "description": "The domain name.", - "type": "string" - }, - "Stage": { - "description": "The API stage.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApiMappingId" - ], - "required": [ - "DomainName", - "Stage", - "ApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::ApiMapping" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "description": "The ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiMappingId", + "/properties/DomainName" + ], + "properties": { + "ApiId": { + "description": "The identifier of the API.", + "type": "string" + }, + "ApiMappingId": { + "description": "", + "type": "string" + }, + "ApiMappingKey": { + "description": "The API mapping key.", + "type": "string" + }, + "DomainName": { + "description": "The domain name.", + "type": "string" + }, + "Stage": { + "description": "The API stage.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApiMappingId" + ], + "required": [ + "DomainName", + "Stage", + "ApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::ApiMapping" +} diff --git a/schema/aws-apigatewayv2-authorizer.json b/schema/aws-apigatewayv2-authorizer.json index 15ba39c..f81d456 100644 --- a/schema/aws-apigatewayv2-authorizer.json +++ b/schema/aws-apigatewayv2-authorizer.json @@ -1,144 +1,144 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "definitions": { - "JWTConfiguration": { - "additionalProperties": false, - "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", - "properties": { - "Audience": { - "description": "A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Issuer": { - "description": "The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - } - }, - "required": [ - "ApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AuthorizerId", - "/properties/ApiId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "AuthorizerCredentialsArn": { - "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.", - "type": "string" - }, - "AuthorizerId": { - "description": "", - "type": "string" - }, - "AuthorizerPayloadFormatVersion": { - "description": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", - "type": "string" - }, - "AuthorizerResultTtlInSeconds": { - "description": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.", - "type": "integer" - }, - "AuthorizerType": { - "description": "The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).", - "type": "string" - }, - "AuthorizerUri": { - "description": "The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.", - "type": "string" - }, - "EnableSimpleResponses": { - "description": "Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", - "type": "boolean" - }, - "IdentitySource": { - "description": "The identity source for which authorization is requested.\n For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).\n For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "IdentityValidationExpression": { - "description": "This parameter is not used.", - "type": "string" - }, - "JwtConfiguration": { - "$ref": "#/definitions/JWTConfiguration", - "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." - }, - "Name": { - "description": "The name of the authorizer.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AuthorizerId" - ], - "required": [ - "AuthorizerType", - "ApiId", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::Authorizer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "JWTConfiguration": { + "additionalProperties": false, + "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", + "properties": { + "Audience": { + "description": "A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Issuer": { + "description": "The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AuthorizerId", + "/properties/ApiId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "AuthorizerCredentialsArn": { + "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.", + "type": "string" + }, + "AuthorizerId": { + "description": "", + "type": "string" + }, + "AuthorizerPayloadFormatVersion": { + "description": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", + "type": "string" + }, + "AuthorizerResultTtlInSeconds": { + "description": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.", + "type": "integer" + }, + "AuthorizerType": { + "description": "The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).", + "type": "string" + }, + "AuthorizerUri": { + "description": "The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.", + "type": "string" + }, + "EnableSimpleResponses": { + "description": "Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", + "type": "boolean" + }, + "IdentitySource": { + "description": "The identity source for which authorization is requested.\n For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).\n For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "IdentityValidationExpression": { + "description": "This parameter is not used.", + "type": "string" + }, + "JwtConfiguration": { + "$ref": "#/definitions/JWTConfiguration", + "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." + }, + "Name": { + "description": "The name of the authorizer.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AuthorizerId" + ], + "required": [ + "AuthorizerType", + "ApiId", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::Authorizer" +} diff --git a/schema/aws-apigatewayv2-deployment.json b/schema/aws-apigatewayv2-deployment.json index db020b3..13943a1 100644 --- a/schema/aws-apigatewayv2-deployment.json +++ b/schema/aws-apigatewayv2-deployment.json @@ -1,87 +1,87 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "description": "The ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - } - }, - "required": [ - "ApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId", - "/properties/DeploymentId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "DeploymentId": { - "description": "", - "type": "string" - }, - "Description": { - "description": "The description for the deployment resource.", - "type": "string" - }, - "StageName": { - "description": "The name of an existing stage to associate with the deployment.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DeploymentId" - ], - "required": [ - "ApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::Deployment", - "writeOnlyProperties": [ - "/properties/StageName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "description": "The ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/DeploymentId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "DeploymentId": { + "description": "", + "type": "string" + }, + "Description": { + "description": "The description for the deployment resource.", + "type": "string" + }, + "StageName": { + "description": "The name of an existing stage to associate with the deployment.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DeploymentId" + ], + "required": [ + "ApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::Deployment", + "writeOnlyProperties": [ + "/properties/StageName" + ] +} diff --git a/schema/aws-apigatewayv2-domainname.json b/schema/aws-apigatewayv2-domainname.json index 7842267..6d7a387 100644 --- a/schema/aws-apigatewayv2-domainname.json +++ b/schema/aws-apigatewayv2-domainname.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "definitions": { - "DomainNameConfiguration": { - "additionalProperties": false, - "description": "The ``DomainNameConfiguration`` property type specifies the configuration for an API's domain name.\n ``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.", - "properties": { - "CertificateArn": { - "description": "An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.", - "type": "string" - }, - "CertificateName": { - "description": "The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.", - "type": "string" - }, - "EndpointType": { - "description": "The endpoint type.", - "type": "string" - }, - "OwnershipVerificationCertificateArn": { - "description": "The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.", - "type": "string" - }, - "SecurityPolicy": { - "description": "The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``.", - "type": "string" - } - }, - "type": "object" - }, - "MutualTlsAuthentication": { - "additionalProperties": false, - "description": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.", - "properties": { - "TruststoreUri": { - "description": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.", - "type": "string" - }, - "TruststoreVersion": { - "description": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). \n You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET", - "apigateway:PUT" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName" - ], - "properties": { - "DomainName": { - "description": "The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.", - "type": "string" - }, - "DomainNameConfigurations": { - "description": "The domain name configurations.", - "items": { - "$ref": "#/definitions/DomainNameConfiguration" - }, - "type": "array", - "uniqueItems": false - }, - "MutualTlsAuthentication": { - "$ref": "#/definitions/MutualTlsAuthentication", - "description": "The mutual TLS authentication configuration for a custom domain name." - }, - "RegionalDomainName": { - "description": "", - "type": "string" - }, - "RegionalHostedZoneId": { - "description": "", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The collection of tags associated with a domain name.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/RegionalDomainName", - "/properties/RegionalHostedZoneId" - ], - "required": [ - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::ApiGatewayV2::DomainName" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "definitions": { + "DomainNameConfiguration": { + "additionalProperties": false, + "description": "The ``DomainNameConfiguration`` property type specifies the configuration for an API's domain name.\n ``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.", + "properties": { + "CertificateArn": { + "description": "An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.", + "type": "string" + }, + "CertificateName": { + "description": "The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.", + "type": "string" + }, + "EndpointType": { + "description": "The endpoint type.", + "type": "string" + }, + "OwnershipVerificationCertificateArn": { + "description": "The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.", + "type": "string" + }, + "SecurityPolicy": { + "description": "The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``.", + "type": "string" + } + }, + "type": "object" + }, + "MutualTlsAuthentication": { + "additionalProperties": false, + "description": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.", + "properties": { + "TruststoreUri": { + "description": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.", + "type": "string" + }, + "TruststoreVersion": { + "description": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). \n You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET", + "apigateway:PUT" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName" + ], + "properties": { + "DomainName": { + "description": "The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.", + "type": "string" + }, + "DomainNameConfigurations": { + "description": "The domain name configurations.", + "items": { + "$ref": "#/definitions/DomainNameConfiguration" + }, + "type": "array", + "uniqueItems": false + }, + "MutualTlsAuthentication": { + "$ref": "#/definitions/MutualTlsAuthentication", + "description": "The mutual TLS authentication configuration for a custom domain name." + }, + "RegionalDomainName": { + "description": "", + "type": "string" + }, + "RegionalHostedZoneId": { + "description": "", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The collection of tags associated with a domain name.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/RegionalDomainName", + "/properties/RegionalHostedZoneId" + ], + "required": [ + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::ApiGatewayV2::DomainName" +} diff --git a/schema/aws-apigatewayv2-integration.json b/schema/aws-apigatewayv2-integration.json index 7a644c3..fbbd30d 100644 --- a/schema/aws-apigatewayv2-integration.json +++ b/schema/aws-apigatewayv2-integration.json @@ -1,88 +1,224 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "definitions": { - "TlsConfig": { - "additionalProperties": false, - "properties": { - "ServerNameToVerify": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ApiGatewayV2::Integration", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiId": { - "type": "string" - }, - "ConnectionId": { - "type": "string" - }, - "ConnectionType": { - "type": "string" - }, - "ContentHandlingStrategy": { - "type": "string" - }, - "CredentialsArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IntegrationMethod": { - "type": "string" - }, - "IntegrationSubtype": { - "type": "string" - }, - "IntegrationType": { - "type": "string" - }, - "IntegrationUri": { - "type": "string" - }, - "PassthroughBehavior": { - "type": "string" - }, - "PayloadFormatVersion": { - "type": "string" - }, - "RequestParameters": { - "type": "object" - }, - "RequestTemplates": { - "type": "object" - }, - "ResponseParameters": { - "type": "object" - }, - "TemplateSelectionExpression": { - "type": "string" - }, - "TimeoutInMillis": { - "type": "integer" - }, - "TlsConfig": { - "$ref": "#/definitions/TlsConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApiId", - "IntegrationType" - ], - "typeName": "AWS::ApiGatewayV2::Integration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "ResponseParameter": { + "additionalProperties": false, + "description": "response parameter", + "properties": { + "Destination": { + "type": "string" + }, + "Source": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseParameterList": { + "description": "list of response parameters", + "items": { + "$ref": "#/definitions/ResponseParameter" + }, + "type": "array" + }, + "ResponseParameterMap": { + "additionalProperties": false, + "description": "map of response parameter lists", + "properties": { + "ResponseParameters": { + "$ref": "#/definitions/ResponseParameterList" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TlsConfig": { + "additionalProperties": false, + "description": "The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs.", + "properties": { + "ServerNameToVerify": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/IntegrationId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "ConnectionId": { + "description": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.", + "type": "string" + }, + "ConnectionType": { + "description": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.", + "type": "string" + }, + "ContentHandlingStrategy": { + "description": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT.", + "type": "string" + }, + "CredentialsArn": { + "description": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter.", + "type": "string" + }, + "Description": { + "description": "The description of the integration.", + "type": "string" + }, + "IntegrationId": { + "description": "The integration ID.", + "type": "string" + }, + "IntegrationMethod": { + "description": "Specifies the integration's HTTP method type.", + "type": "string" + }, + "IntegrationSubtype": { + "description": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.", + "type": "string" + }, + "IntegrationType": { + "description": "The integration type of an integration.", + "type": "string" + }, + "IntegrationUri": { + "description": "For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service.", + "type": "string" + }, + "PassthroughBehavior": { + "description": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.", + "type": "string" + }, + "PayloadFormatVersion": { + "description": "Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value.", + "type": "string" + }, + "RequestParameters": { + "additionalProperties": false, + "description": "A key-value map specifying parameters.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "RequestTemplates": { + "additionalProperties": false, + "description": "A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseParameters": { + "additionalProperties": false, + "description": "Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "$ref": "#/definitions/ResponseParameterMap" + } + }, + "type": "object" + }, + "TemplateSelectionExpression": { + "description": "The template selection expression for the integration. Supported only for WebSocket APIs.", + "type": "string" + }, + "TimeoutInMillis": { + "description": "Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.", + "type": "integer" + }, + "TlsConfig": { + "$ref": "#/definitions/TlsConfig", + "description": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs." + } + }, + "readOnlyProperties": [ + "/properties/IntegrationId" + ], + "required": [ + "ApiId", + "IntegrationType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::Integration" +} diff --git a/schema/aws-apigatewayv2-integrationresponse.json b/schema/aws-apigatewayv2-integrationresponse.json index 22f580f..7be8418 100644 --- a/schema/aws-apigatewayv2-integrationresponse.json +++ b/schema/aws-apigatewayv2-integrationresponse.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId", - "/properties/IntegrationId" - ], - "description": "The ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:PUT", - "apigateway:GET" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId", - "/properties/IntegrationId", - "/properties/IntegrationResponseId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "ContentHandlingStrategy": { - "description": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.\n ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.\n If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.", - "type": "string" - }, - "IntegrationId": { - "description": "The integration ID.", - "type": "string" - }, - "IntegrationResponseId": { - "description": "", - "type": "string" - }, - "IntegrationResponseKey": { - "description": "The integration response key.", - "type": "string" - }, - "ResponseParameters": { - "description": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.", - "type": "object" - }, - "ResponseTemplates": { - "description": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.", - "type": "object" - }, - "TemplateSelectionExpression": { - "description": "The template selection expression for the integration response. Supported only for WebSocket APIs.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IntegrationResponseId" - ], - "required": [ - "ApiId", - "IntegrationId", - "IntegrationResponseKey" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::IntegrationResponse" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId", + "/properties/IntegrationId" + ], + "description": "The ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:PUT", + "apigateway:GET" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/IntegrationId", + "/properties/IntegrationResponseId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "ContentHandlingStrategy": { + "description": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.\n ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.\n If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.", + "type": "string" + }, + "IntegrationId": { + "description": "The integration ID.", + "type": "string" + }, + "IntegrationResponseId": { + "description": "", + "type": "string" + }, + "IntegrationResponseKey": { + "description": "The integration response key.", + "type": "string" + }, + "ResponseParameters": { + "description": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.", + "type": "object" + }, + "ResponseTemplates": { + "description": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.", + "type": "object" + }, + "TemplateSelectionExpression": { + "description": "The template selection expression for the integration response. Supported only for WebSocket APIs.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IntegrationResponseId" + ], + "required": [ + "ApiId", + "IntegrationId", + "IntegrationResponseKey" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::IntegrationResponse" +} diff --git a/schema/aws-apigatewayv2-model.json b/schema/aws-apigatewayv2-model.json index 19f28b5..5d49721 100644 --- a/schema/aws-apigatewayv2-model.json +++ b/schema/aws-apigatewayv2-model.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "description": "The ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - } - }, - "required": [ - "ApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId", - "/properties/ModelId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "ContentType": { - "description": "The content-type for the model, for example, \"application/json\".", - "type": "string" - }, - "Description": { - "description": "The description of the model.", - "type": "string" - }, - "ModelId": { - "description": "", - "type": "string" - }, - "Name": { - "description": "The name of the model.", - "type": "string" - }, - "Schema": { - "description": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.", - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/ModelId" - ], - "required": [ - "ApiId", - "Schema", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::Model" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "description": "The ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/ModelId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "ContentType": { + "description": "The content-type for the model, for example, \"application/json\".", + "type": "string" + }, + "Description": { + "description": "The description of the model.", + "type": "string" + }, + "ModelId": { + "description": "", + "type": "string" + }, + "Name": { + "description": "The name of the model.", + "type": "string" + }, + "Schema": { + "description": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.", + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/ModelId" + ], + "required": [ + "ApiId", + "Schema", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::Model" +} diff --git a/schema/aws-apigatewayv2-route.json b/schema/aws-apigatewayv2-route.json index e20454c..2d12366 100644 --- a/schema/aws-apigatewayv2-route.json +++ b/schema/aws-apigatewayv2-route.json @@ -1,143 +1,143 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "definitions": { - "ParameterConstraints": { - "additionalProperties": false, - "description": "", - "properties": { - "Required": { - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - } - }, - "required": [ - "ApiId" - ] - }, - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId", - "/properties/RouteId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "ApiKeyRequired": { - "description": "Specifies whether an API key is required for the route. Supported only for WebSocket APIs.", - "type": "boolean" - }, - "AuthorizationScopes": { - "description": "The authorization scopes supported by this route.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AuthorizationType": { - "description": "The authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer.", - "type": "string" - }, - "AuthorizerId": { - "description": "The identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.", - "type": "string" - }, - "ModelSelectionExpression": { - "description": "The model selection expression for the route. Supported only for WebSocket APIs.", - "type": "string" - }, - "OperationName": { - "description": "The operation name for the route.", - "type": "string" - }, - "RequestModels": { - "description": "The request models for the route. Supported only for WebSocket APIs.", - "type": "object" - }, - "RequestParameters": { - "description": "The request parameters for the route. Supported only for WebSocket APIs.", - "items": { - "$ref": "#/definitions/ParameterConstraints" - }, - "type": "object" - }, - "RouteId": { - "description": "", - "type": "string" - }, - "RouteKey": { - "description": "The route key for the route. For HTTP APIs, the route key can be either ``$default``, or a combination of an HTTP method and resource path, for example, ``GET /pets``.", - "type": "string" - }, - "RouteResponseSelectionExpression": { - "description": "The route response selection expression for the route. Supported only for WebSocket APIs.", - "type": "string" - }, - "Target": { - "description": "The target for the route.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RouteId" - ], - "required": [ - "RouteKey", - "ApiId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::Route", - "writeOnlyProperties": [ - "/properties/AuthorizerId", - "/properties/RequestParameters" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "ParameterConstraints": { + "additionalProperties": false, + "description": "", + "properties": { + "Required": { + "type": "boolean" + } + }, + "required": [ + "Required" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/RouteId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "ApiKeyRequired": { + "description": "Specifies whether an API key is required for the route. Supported only for WebSocket APIs.", + "type": "boolean" + }, + "AuthorizationScopes": { + "description": "The authorization scopes supported by this route.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AuthorizationType": { + "description": "The authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer.", + "type": "string" + }, + "AuthorizerId": { + "description": "The identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.", + "type": "string" + }, + "ModelSelectionExpression": { + "description": "The model selection expression for the route. Supported only for WebSocket APIs.", + "type": "string" + }, + "OperationName": { + "description": "The operation name for the route.", + "type": "string" + }, + "RequestModels": { + "description": "The request models for the route. Supported only for WebSocket APIs.", + "type": "object" + }, + "RequestParameters": { + "description": "The request parameters for the route. Supported only for WebSocket APIs.", + "items": { + "$ref": "#/definitions/ParameterConstraints" + }, + "type": "object" + }, + "RouteId": { + "description": "", + "type": "string" + }, + "RouteKey": { + "description": "The route key for the route. For HTTP APIs, the route key can be either ``$default``, or a combination of an HTTP method and resource path, for example, ``GET /pets``.", + "type": "string" + }, + "RouteResponseSelectionExpression": { + "description": "The route response selection expression for the route. Supported only for WebSocket APIs.", + "type": "string" + }, + "Target": { + "description": "The target for the route.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RouteId" + ], + "required": [ + "RouteKey", + "ApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigatewayv2", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::Route", + "writeOnlyProperties": [ + "/properties/AuthorizerId", + "/properties/RequestParameters" + ] +} diff --git a/schema/aws-apigatewayv2-routeresponse.json b/schema/aws-apigatewayv2-routeresponse.json index 4ed4572..4664168 100644 --- a/schema/aws-apigatewayv2-routeresponse.json +++ b/schema/aws-apigatewayv2-routeresponse.json @@ -1,112 +1,112 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId", - "/properties/RouteId" - ], - "definitions": { - "ParameterConstraints": { - "additionalProperties": false, - "description": "Specifies whether the parameter is required.", - "properties": { - "Required": { - "description": "Specifies whether the parameter is required.", - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, - "RouteParameters": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/ParameterConstraints" - } - } - } - }, - "description": "The ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE" - ] - }, - "list": { - "permissions": [ - "apigateway:GET" - ] - }, - "read": { - "permissions": [ - "apigateway:GET" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:PUT" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiId", - "/properties/RouteId", - "/properties/RouteResponseId" - ], - "properties": { - "ApiId": { - "description": "The API identifier.", - "type": "string" - }, - "ModelSelectionExpression": { - "description": "The model selection expression for the route response. Supported only for WebSocket APIs.", - "type": "string" - }, - "ResponseModels": { - "description": "The response models for the route response.", - "type": "object" - }, - "ResponseParameters": { - "$ref": "#/definitions/RouteParameters", - "description": "The route response parameters." - }, - "RouteId": { - "description": "The route ID.", - "type": "string" - }, - "RouteResponseId": { - "description": "", - "type": "string" - }, - "RouteResponseKey": { - "description": "The route response key.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RouteResponseId" - ], - "required": [ - "RouteResponseKey", - "RouteId", - "ApiId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApiGatewayV2::RouteResponse" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId", + "/properties/RouteId" + ], + "definitions": { + "ParameterConstraints": { + "additionalProperties": false, + "description": "Specifies whether the parameter is required.", + "properties": { + "Required": { + "description": "Specifies whether the parameter is required.", + "type": "boolean" + } + }, + "required": [ + "Required" + ], + "type": "object" + }, + "RouteParameters": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/ParameterConstraints" + } + } + } + }, + "description": "The ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiId", + "/properties/RouteId", + "/properties/RouteResponseId" + ], + "properties": { + "ApiId": { + "description": "The API identifier.", + "type": "string" + }, + "ModelSelectionExpression": { + "description": "The model selection expression for the route response. Supported only for WebSocket APIs.", + "type": "string" + }, + "ResponseModels": { + "description": "The response models for the route response.", + "type": "object" + }, + "ResponseParameters": { + "$ref": "#/definitions/RouteParameters", + "description": "The route response parameters." + }, + "RouteId": { + "description": "The route ID.", + "type": "string" + }, + "RouteResponseId": { + "description": "", + "type": "string" + }, + "RouteResponseKey": { + "description": "The route response key.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RouteResponseId" + ], + "required": [ + "RouteResponseKey", + "RouteId", + "ApiId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApiGatewayV2::RouteResponse" +} diff --git a/schema/aws-apigatewayv2-stage.json b/schema/aws-apigatewayv2-stage.json index 86fec06..d275adb 100644 --- a/schema/aws-apigatewayv2-stage.json +++ b/schema/aws-apigatewayv2-stage.json @@ -1,95 +1,95 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StageName", - "/properties/ApiId" - ], - "definitions": { - "AccessLogSettings": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "RouteSettings": { - "additionalProperties": false, - "properties": { - "DataTraceEnabled": { - "type": "boolean" - }, - "DetailedMetricsEnabled": { - "type": "boolean" - }, - "LoggingLevel": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "integer" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ApiGatewayV2::Stage", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessLogSettings": { - "$ref": "#/definitions/AccessLogSettings" - }, - "AccessPolicyId": { - "type": "string" - }, - "ApiId": { - "type": "string" - }, - "AutoDeploy": { - "type": "boolean" - }, - "ClientCertificateId": { - "type": "string" - }, - "DefaultRouteSettings": { - "$ref": "#/definitions/RouteSettings" - }, - "DeploymentId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "RouteSettings": { - "type": "object" - }, - "StageName": { - "type": "string" - }, - "StageVariables": { - "type": "object" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "StageName", - "ApiId" - ], - "typeName": "AWS::ApiGatewayV2::Stage" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StageName", + "/properties/ApiId" + ], + "definitions": { + "AccessLogSettings": { + "additionalProperties": false, + "properties": { + "DestinationArn": { + "type": "string" + }, + "Format": { + "type": "string" + } + }, + "type": "object" + }, + "RouteSettings": { + "additionalProperties": false, + "properties": { + "DataTraceEnabled": { + "type": "boolean" + }, + "DetailedMetricsEnabled": { + "type": "boolean" + }, + "LoggingLevel": { + "type": "string" + }, + "ThrottlingBurstLimit": { + "type": "integer" + }, + "ThrottlingRateLimit": { + "type": "number" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ApiGatewayV2::Stage", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessLogSettings": { + "$ref": "#/definitions/AccessLogSettings" + }, + "AccessPolicyId": { + "type": "string" + }, + "ApiId": { + "type": "string" + }, + "AutoDeploy": { + "type": "boolean" + }, + "ClientCertificateId": { + "type": "string" + }, + "DefaultRouteSettings": { + "$ref": "#/definitions/RouteSettings" + }, + "DeploymentId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "RouteSettings": { + "type": "object" + }, + "StageName": { + "type": "string" + }, + "StageVariables": { + "type": "object" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "StageName", + "ApiId" + ], + "typeName": "AWS::ApiGatewayV2::Stage" +} diff --git a/schema/aws-apigatewayv2-vpclink.json b/schema/aws-apigatewayv2-vpclink.json index 8a63eae..ef22360 100644 --- a/schema/aws-apigatewayv2-vpclink.json +++ b/schema/aws-apigatewayv2-vpclink.json @@ -1,110 +1,110 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SecurityGroupIds", - "/properties/SubnetIds" - ], - "description": "The ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "apigateway:POST", - "apigateway:GET", - "apigateway:TagResource", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "delete": { - "permissions": [ - "apigateway:GET", - "apigateway:DELETE", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "list": { - "permissions": [ - "apigateway:GET", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "read": { - "permissions": [ - "apigateway:GET", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "update": { - "permissions": [ - "apigateway:PATCH", - "apigateway:GET", - "apigateway:TagResource", - "apigateway:unTagResource", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpcLinkId" - ], - "properties": { - "Name": { - "description": "The name of the VPC link.", - "type": "string" - }, - "SecurityGroupIds": { - "description": "A list of security group IDs for the VPC link.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "description": "A list of subnet IDs to include in the VPC link.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "additionalProperties": false, - "description": "The collection of tags. Each tag element is associated with a given resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "VpcLinkId": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VpcLinkId" - ], - "required": [ - "SubnetIds", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApiGatewayV2::VpcLink" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SecurityGroupIds", + "/properties/SubnetIds" + ], + "description": "The ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:POST", + "apigateway:GET", + "apigateway:TagResource", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "list": { + "permissions": [ + "apigateway:GET", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "read": { + "permissions": [ + "apigateway:GET", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "update": { + "permissions": [ + "apigateway:PATCH", + "apigateway:GET", + "apigateway:TagResource", + "apigateway:unTagResource", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpcLinkId" + ], + "properties": { + "Name": { + "description": "The name of the VPC link.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "A list of security group IDs for the VPC link.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "description": "A list of subnet IDs to include in the VPC link.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "additionalProperties": false, + "description": "The collection of tags. Each tag element is associated with a given resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "VpcLinkId": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VpcLinkId" + ], + "required": [ + "SubnetIds", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApiGatewayV2::VpcLink" +} diff --git a/schema/aws-appconfig-application.json b/schema/aws-appconfig-application.json index 94b6831..c1afd91 100644 --- a/schema/aws-appconfig-application.json +++ b/schema/aws-appconfig-application.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "definitions": { - "Tags": { - "additionalProperties": false, - "description": "Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "properties": { - "Key": { - "description": "The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:.)[a-zA-Z1-9+=._:/-]*$", - "type": "string" - }, - "Value": { - "description": "The tag value can be up to 256 characters.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppConfig::Application", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateApplication", - "appconfig:GetApplication", - "appconfig:ListTagsForResource", - "appconfig:TagResource" - ] - }, - "delete": { - "permissions": [ - "appconfig:GetApplication", - "appconfig:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "appconfig:ListApplications" - ] - }, - "read": { - "permissions": [ - "appconfig:GetApplication", - "appconfig:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "appconfig:UpdateApplication", - "appconfig:TagResource", - "appconfig:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId" - ], - "properties": { - "ApplicationId": { - "description": "The application Id", - "type": "string" - }, - "Description": { - "description": "A description of the application.", - "type": "string" - }, - "Name": { - "description": "A name for the application.", - "type": "string" - }, - "Tags": { - "description": "Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ApplicationId" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppConfig::Application" -} +{ + "additionalProperties": false, + "definitions": { + "Tags": { + "additionalProperties": false, + "description": "Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "properties": { + "Key": { + "description": "The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:.)[a-zA-Z1-9+=._:/-]*$", + "type": "string" + }, + "Value": { + "description": "The tag value can be up to 256 characters.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::Application", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateApplication", + "appconfig:GetApplication", + "appconfig:ListTagsForResource", + "appconfig:TagResource" + ] + }, + "delete": { + "permissions": [ + "appconfig:GetApplication", + "appconfig:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "appconfig:ListApplications" + ] + }, + "read": { + "permissions": [ + "appconfig:GetApplication", + "appconfig:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateApplication", + "appconfig:TagResource", + "appconfig:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId" + ], + "properties": { + "ApplicationId": { + "description": "The application Id", + "type": "string" + }, + "Description": { + "description": "A description of the application.", + "type": "string" + }, + "Name": { + "description": "A name for the application.", + "type": "string" + }, + "Tags": { + "description": "Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ApplicationId" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::Application" +} diff --git a/schema/aws-appconfig-configurationprofile.json b/schema/aws-appconfig-configurationprofile.json index a65a7bd..40e847c 100644 --- a/schema/aws-appconfig-configurationprofile.json +++ b/schema/aws-appconfig-configurationprofile.json @@ -1,187 +1,187 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocationUri", - "/properties/Type", - "/properties/ApplicationId" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "description": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "properties": { - "Key": { - "description": "The key-value string map. The tag key can be up to 128 characters and must not start with aws:.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:.)[a-zA-Z0-9 +=._:/-]*$", - "type": "string" - }, - "Value": { - "description": "The tag value can be up to 256 characters.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Validators": { - "additionalProperties": false, - "description": "A list of methods for validating the configuration.", - "properties": { - "Content": { - "description": "Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.", - "maxLength": 32768, - "minLength": 0, - "type": "string" - }, - "Type": { - "description": "AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateConfigurationProfile", - "appconfig:GetConfigurationProfile", - "appconfig:TagResource", - "appconfig:ListTagsForResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "appconfig:DeleteConfigurationProfile" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "appconfig:ListConfigurationProfiles" - ] - }, - "read": { - "permissions": [ - "appconfig:GetConfigurationProfile", - "appconfig:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "appconfig:UpdateConfigurationProfile", - "appconfig:TagResource", - "appconfig:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/ConfigurationProfileId" - ], - "properties": { - "ApplicationId": { - "description": "The application ID.", - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "ConfigurationProfileId": { - "description": "The configuration profile ID", - "type": "string" - }, - "Description": { - "description": "A description of the configuration profile.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "KmsKeyArn": { - "description": "The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+", - "type": "string" - }, - "KmsKeyIdentifier": { - "description": "The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.", - "pattern": "^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$", - "type": "string" - }, - "LocationUri": { - "description": "A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "A name for the configuration profile.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "RetrievalRoleArn": { - "description": "The ARN of an IAM role with permission to access the configuration at the specified LocationUri.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$", - "type": "string" - }, - "Tags": { - "description": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform", - "pattern": "^[a-zA-Z\\.]+", - "type": "string" - }, - "Validators": { - "description": "A list of methods for validating the configuration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Validators" - }, - "maxItems": 2, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ConfigurationProfileId", - "/properties/KmsKeyArn" - ], - "required": [ - "LocationUri", - "ApplicationId", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppConfig::ConfigurationProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocationUri", + "/properties/Type", + "/properties/ApplicationId" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "description": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "properties": { + "Key": { + "description": "The key-value string map. The tag key can be up to 128 characters and must not start with aws:.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:.)[a-zA-Z0-9 +=._:/-]*$", + "type": "string" + }, + "Value": { + "description": "The tag value can be up to 256 characters.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Validators": { + "additionalProperties": false, + "description": "A list of methods for validating the configuration.", + "properties": { + "Content": { + "description": "Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.", + "maxLength": 32768, + "minLength": 0, + "type": "string" + }, + "Type": { + "description": "AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateConfigurationProfile", + "appconfig:GetConfigurationProfile", + "appconfig:TagResource", + "appconfig:ListTagsForResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "appconfig:DeleteConfigurationProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "appconfig:ListConfigurationProfiles" + ] + }, + "read": { + "permissions": [ + "appconfig:GetConfigurationProfile", + "appconfig:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateConfigurationProfile", + "appconfig:TagResource", + "appconfig:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/ConfigurationProfileId" + ], + "properties": { + "ApplicationId": { + "description": "The application ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "ConfigurationProfileId": { + "description": "The configuration profile ID", + "type": "string" + }, + "Description": { + "description": "A description of the configuration profile.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "KmsKeyArn": { + "description": "The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+", + "type": "string" + }, + "KmsKeyIdentifier": { + "description": "The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.", + "pattern": "^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$", + "type": "string" + }, + "LocationUri": { + "description": "A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "A name for the configuration profile.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "RetrievalRoleArn": { + "description": "The ARN of an IAM role with permission to access the configuration at the specified LocationUri.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$", + "type": "string" + }, + "Tags": { + "description": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform", + "pattern": "^[a-zA-Z\\.]+", + "type": "string" + }, + "Validators": { + "description": "A list of methods for validating the configuration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Validators" + }, + "maxItems": 2, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ConfigurationProfileId", + "/properties/KmsKeyArn" + ], + "required": [ + "LocationUri", + "ApplicationId", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::ConfigurationProfile" +} diff --git a/schema/aws-appconfig-deployment.json b/schema/aws-appconfig-deployment.json index 8e7f2d1..2d2831a 100644 --- a/schema/aws-appconfig-deployment.json +++ b/schema/aws-appconfig-deployment.json @@ -1,98 +1,98 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyIdentifier", - "/properties/DeploymentStrategyId", - "/properties/ConfigurationVersion", - "/properties/ApplicationId", - "/properties/ConfigurationProfileId", - "/properties/Tags", - "/properties/EnvironmentId", - "/properties/Description", - "/properties/DynamicExtensionParameters" - ], - "definitions": { - "DynamicExtensionParameters": { - "additionalProperties": false, - "properties": { - "ExtensionReference": { - "type": "string" - }, - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppConfig::Deployment", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "ConfigurationProfileId": { - "type": "string" - }, - "ConfigurationVersion": { - "type": "string" - }, - "DeploymentStrategyId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DynamicExtensionParameters": { - "items": { - "$ref": "#/definitions/DynamicExtensionParameters" - }, - "type": "array", - "uniqueItems": false - }, - "EnvironmentId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "KmsKeyIdentifier": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DeploymentStrategyId", - "ConfigurationProfileId", - "EnvironmentId", - "ConfigurationVersion", - "ApplicationId" - ], - "typeName": "AWS::AppConfig::Deployment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyIdentifier", + "/properties/DeploymentStrategyId", + "/properties/ConfigurationVersion", + "/properties/ApplicationId", + "/properties/ConfigurationProfileId", + "/properties/Tags", + "/properties/EnvironmentId", + "/properties/Description", + "/properties/DynamicExtensionParameters" + ], + "definitions": { + "DynamicExtensionParameters": { + "additionalProperties": false, + "properties": { + "ExtensionReference": { + "type": "string" + }, + "ParameterName": { + "type": "string" + }, + "ParameterValue": { + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::Deployment", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "ConfigurationProfileId": { + "type": "string" + }, + "ConfigurationVersion": { + "type": "string" + }, + "DeploymentStrategyId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DynamicExtensionParameters": { + "items": { + "$ref": "#/definitions/DynamicExtensionParameters" + }, + "type": "array", + "uniqueItems": false + }, + "EnvironmentId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "KmsKeyIdentifier": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DeploymentStrategyId", + "ConfigurationProfileId", + "EnvironmentId", + "ConfigurationVersion", + "ApplicationId" + ], + "typeName": "AWS::AppConfig::Deployment" +} diff --git a/schema/aws-appconfig-deploymentstrategy.json b/schema/aws-appconfig-deploymentstrategy.json index 9dc2661..3249598 100644 --- a/schema/aws-appconfig-deploymentstrategy.json +++ b/schema/aws-appconfig-deploymentstrategy.json @@ -1,68 +1,68 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/ReplicateTo" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppConfig::DeploymentStrategy", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeploymentDurationInMinutes": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "FinalBakeTimeInMinutes": { - "type": "number" - }, - "GrowthFactor": { - "type": "number" - }, - "GrowthType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReplicateTo": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ReplicateTo", - "DeploymentDurationInMinutes", - "GrowthFactor", - "Name" - ], - "typeName": "AWS::AppConfig::DeploymentStrategy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ReplicateTo" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::DeploymentStrategy", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeploymentDurationInMinutes": { + "type": "number" + }, + "Description": { + "type": "string" + }, + "FinalBakeTimeInMinutes": { + "type": "number" + }, + "GrowthFactor": { + "type": "number" + }, + "GrowthType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ReplicateTo": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ReplicateTo", + "DeploymentDurationInMinutes", + "GrowthFactor", + "Name" + ], + "typeName": "AWS::AppConfig::DeploymentStrategy" +} diff --git a/schema/aws-appconfig-environment.json b/schema/aws-appconfig-environment.json index 95aef1a..5c2b5f3 100644 --- a/schema/aws-appconfig-environment.json +++ b/schema/aws-appconfig-environment.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "definitions": { - "Monitor": { - "additionalProperties": false, - "description": "Amazon CloudWatch alarm to monitor during the deployment process.", - "properties": { - "AlarmArn": { - "description": "Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.", - "maxLength": 2048, - "minLength": 1, - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::CloudWatch::Alarm" - }, - "type": "string" - }, - "AlarmRoleArn": { - "description": "ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - } - }, - "required": [ - "AlarmArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "properties": { - "Key": { - "description": "The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:.)[a-zA-Z1-9+=._:/-]*$", - "type": "string" - }, - "Value": { - "description": "The tag value can be up to 256 characters.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppConfig::Environment", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateEnvironment", - "appconfig:GetEnvironment", - "appconfig:ListTagsForResource", - "appconfig:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "appconfig:GetEnvironment", - "appconfig:DeleteEnvironment" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "appconfig:ListEnvironments" - ] - }, - "read": { - "permissions": [ - "appconfig:GetEnvironment", - "appconfig:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "appconfig:UpdateEnvironment", - "appconfig:TagResource", - "appconfig:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/EnvironmentId" - ], - "properties": { - "ApplicationId": { - "description": "The application ID.", - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "Description": { - "description": "A description of the environment.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "EnvironmentId": { - "description": "The environment ID.", - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "Monitors": { - "description": "Amazon CloudWatch alarms to monitor during the deployment process.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Monitor" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Name": { - "description": "A name for the environment.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/EnvironmentId" - ], - "required": [ - "Name", - "ApplicationId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppConfig::Environment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "Monitor": { + "additionalProperties": false, + "description": "Amazon CloudWatch alarm to monitor during the deployment process.", + "properties": { + "AlarmArn": { + "description": "Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.", + "maxLength": 2048, + "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::CloudWatch::Alarm" + }, + "type": "string" + }, + "AlarmRoleArn": { + "description": "ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + } + }, + "required": [ + "AlarmArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "properties": { + "Key": { + "description": "The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:.)[a-zA-Z1-9+=._:/-]*$", + "type": "string" + }, + "Value": { + "description": "The tag value can be up to 256 characters.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::Environment", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateEnvironment", + "appconfig:GetEnvironment", + "appconfig:ListTagsForResource", + "appconfig:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "appconfig:GetEnvironment", + "appconfig:DeleteEnvironment" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "appconfig:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "appconfig:GetEnvironment", + "appconfig:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateEnvironment", + "appconfig:TagResource", + "appconfig:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/EnvironmentId" + ], + "properties": { + "ApplicationId": { + "description": "The application ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "Description": { + "description": "A description of the environment.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "EnvironmentId": { + "description": "The environment ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "Monitors": { + "description": "Amazon CloudWatch alarms to monitor during the deployment process.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Monitor" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "A name for the environment.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/EnvironmentId" + ], + "required": [ + "Name", + "ApplicationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::Environment" +} diff --git a/schema/aws-appconfig-extension.json b/schema/aws-appconfig-extension.json index e668da3..cb2d15b 100644 --- a/schema/aws-appconfig-extension.json +++ b/schema/aws-appconfig-extension.json @@ -1,209 +1,209 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "An action for an extension to take at a specific action point.", - "properties": { - "Description": { - "description": "The description of the extension Action.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "The name of the extension action.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role for invoking the extension action.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "Uri": { - "description": "The URI of the extension action.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name", - "Uri" - ], - "type": "object" - }, - "Actions": { - "description": "A list of actions for an extension to take at a specific action point.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": true - }, - "Parameter": { - "additionalProperties": false, - "description": "A parameter for the extension to send to a specific action.", - "properties": { - "Description": { - "description": "The description of the extension Parameter.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Dynamic": { - "type": "boolean" - }, - "Required": { - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppConfig::Extension", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateExtension", - "appconfig:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "appconfig:DeleteExtension", - "appconfig:UntagResource" - ] - }, - "list": { - "permissions": [ - "appconfig:ListExtensions" - ] - }, - "read": { - "permissions": [ - "appconfig:GetExtension" - ] - }, - "update": { - "permissions": [ - "appconfig:UpdateExtension", - "appconfig:TagResource", - "appconfig:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Actions": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/Actions" - } - }, - "type": "object" - }, - "Arn": { - "type": "string" - }, - "Description": { - "description": "Description of the extension.", - "type": "string" - }, - "Id": { - "type": "string" - }, - "LatestVersionNumber": { - "type": "integer" - }, - "Name": { - "description": "Name of the extension.", - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/Parameter" - } - }, - "type": "object" - }, - "Tags": { - "description": "An array of key-value tags to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VersionNumber": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/VersionNumber" - ], - "required": [ - "Name", - "Actions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppConfig::Extension", - "writeOnlyProperties": [ - "/properties/LatestVersionNumber", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "An action for an extension to take at a specific action point.", + "properties": { + "Description": { + "description": "The description of the extension Action.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "The name of the extension action.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role for invoking the extension action.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "Uri": { + "description": "The URI of the extension action.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name", + "Uri" + ], + "type": "object" + }, + "Actions": { + "description": "A list of actions for an extension to take at a specific action point.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": true + }, + "Parameter": { + "additionalProperties": false, + "description": "A parameter for the extension to send to a specific action.", + "properties": { + "Description": { + "description": "The description of the extension Parameter.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Dynamic": { + "type": "boolean" + }, + "Required": { + "type": "boolean" + } + }, + "required": [ + "Required" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::Extension", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateExtension", + "appconfig:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "appconfig:DeleteExtension", + "appconfig:UntagResource" + ] + }, + "list": { + "permissions": [ + "appconfig:ListExtensions" + ] + }, + "read": { + "permissions": [ + "appconfig:GetExtension" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateExtension", + "appconfig:TagResource", + "appconfig:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Actions": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/Actions" + } + }, + "type": "object" + }, + "Arn": { + "type": "string" + }, + "Description": { + "description": "Description of the extension.", + "type": "string" + }, + "Id": { + "type": "string" + }, + "LatestVersionNumber": { + "type": "integer" + }, + "Name": { + "description": "Name of the extension.", + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/Parameter" + } + }, + "type": "object" + }, + "Tags": { + "description": "An array of key-value tags to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VersionNumber": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/VersionNumber" + ], + "required": [ + "Name", + "Actions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::Extension", + "writeOnlyProperties": [ + "/properties/LatestVersionNumber", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-appconfig-extensionassociation.json b/schema/aws-appconfig-extensionassociation.json index 6833dfe..d4926f7 100644 --- a/schema/aws-appconfig-extensionassociation.json +++ b/schema/aws-appconfig-extensionassociation.json @@ -1,134 +1,134 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ExtensionIdentifier", - "/properties/ResourceIdentifier", - "/properties/ExtensionVersionNumber", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateExtensionAssociation", - "appconfig:TagResource" - ] - }, - "delete": { - "permissions": [ - "appconfig:DeleteExtensionAssociation", - "appconfig:UntagResource" - ] - }, - "list": { - "permissions": [ - "appconfig:ListExtensionAssociations" - ] - }, - "read": { - "permissions": [ - "appconfig:GetExtensionAssociation" - ] - }, - "update": { - "permissions": [ - "appconfig:UpdateExtensionAssociation", - "appconfig:TagResource", - "appconfig:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ExtensionArn": { - "type": "string" - }, - "ExtensionIdentifier": { - "type": "string" - }, - "ExtensionVersionNumber": { - "type": "integer" - }, - "Id": { - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "ResourceArn": { - "type": "string" - }, - "ResourceIdentifier": { - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/ResourceArn", - "/properties/ExtensionArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppConfig::ExtensionAssociation", - "writeOnlyProperties": [ - "/properties/ExtensionIdentifier", - "/properties/ResourceIdentifier", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ExtensionIdentifier", + "/properties/ResourceIdentifier", + "/properties/ExtensionVersionNumber", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateExtensionAssociation", + "appconfig:TagResource" + ] + }, + "delete": { + "permissions": [ + "appconfig:DeleteExtensionAssociation", + "appconfig:UntagResource" + ] + }, + "list": { + "permissions": [ + "appconfig:ListExtensionAssociations" + ] + }, + "read": { + "permissions": [ + "appconfig:GetExtensionAssociation" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateExtensionAssociation", + "appconfig:TagResource", + "appconfig:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ExtensionArn": { + "type": "string" + }, + "ExtensionIdentifier": { + "type": "string" + }, + "ExtensionVersionNumber": { + "type": "integer" + }, + "Id": { + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "ResourceArn": { + "type": "string" + }, + "ResourceIdentifier": { + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/ResourceArn", + "/properties/ExtensionArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::ExtensionAssociation", + "writeOnlyProperties": [ + "/properties/ExtensionIdentifier", + "/properties/ResourceIdentifier", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-appconfig-hostedconfigurationversion.json b/schema/aws-appconfig-hostedconfigurationversion.json index e1cf9a2..b6f65fa 100644 --- a/schema/aws-appconfig-hostedconfigurationversion.json +++ b/schema/aws-appconfig-hostedconfigurationversion.json @@ -1,117 +1,117 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId", - "/properties/ConfigurationProfileId", - "/properties/Description", - "/properties/Content", - "/properties/ContentType", - "/properties/LatestVersionNumber", - "/properties/VersionLabel" - ], - "description": "Resource Type definition for AWS::AppConfig::HostedConfigurationVersion", - "handlers": { - "create": { - "permissions": [ - "appconfig:CreateHostedConfigurationVersion" - ] - }, - "delete": { - "permissions": [ - "appconfig:DeleteHostedConfigurationVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - }, - "ConfigurationProfileId": { - "$ref": "resource-schema.json#/properties/ConfigurationProfileId" - } - }, - "required": [ - "ApplicationId", - "ConfigurationProfileId" - ] - }, - "permissions": [ - "appconfig:ListHostedConfigurationVersions" - ] - }, - "read": { - "permissions": [ - "appconfig:GetHostedConfigurationVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/ConfigurationProfileId", - "/properties/VersionNumber" - ], - "properties": { - "ApplicationId": { - "description": "The application ID.", - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "ConfigurationProfileId": { - "description": "The configuration profile ID.", - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "Content": { - "description": "The content of the configuration or the configuration data.", - "type": "string" - }, - "ContentType": { - "description": "A standard MIME type describing the format of the configuration content.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "A description of the hosted configuration version.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "LatestVersionNumber": { - "description": "An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.", - "type": "integer" - }, - "VersionLabel": { - "description": "A user-defined label for an AWS AppConfig hosted configuration version.", - "maxLength": 64, - "minLength": 0, - "pattern": "^$|.*[^0-9].*", - "type": "string" - }, - "VersionNumber": { - "description": "Current version number of hosted configuration version.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VersionNumber" - ], - "required": [ - "ApplicationId", - "ConfigurationProfileId", - "Content", - "ContentType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppConfig::HostedConfigurationVersion", - "writeOnlyProperties": [ - "/properties/LatestVersionNumber" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/ConfigurationProfileId", + "/properties/Description", + "/properties/Content", + "/properties/ContentType", + "/properties/LatestVersionNumber", + "/properties/VersionLabel" + ], + "description": "Resource Type definition for AWS::AppConfig::HostedConfigurationVersion", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateHostedConfigurationVersion" + ] + }, + "delete": { + "permissions": [ + "appconfig:DeleteHostedConfigurationVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + }, + "ConfigurationProfileId": { + "$ref": "resource-schema.json#/properties/ConfigurationProfileId" + } + }, + "required": [ + "ApplicationId", + "ConfigurationProfileId" + ] + }, + "permissions": [ + "appconfig:ListHostedConfigurationVersions" + ] + }, + "read": { + "permissions": [ + "appconfig:GetHostedConfigurationVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/ConfigurationProfileId", + "/properties/VersionNumber" + ], + "properties": { + "ApplicationId": { + "description": "The application ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "ConfigurationProfileId": { + "description": "The configuration profile ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "Content": { + "description": "The content of the configuration or the configuration data.", + "type": "string" + }, + "ContentType": { + "description": "A standard MIME type describing the format of the configuration content.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "A description of the hosted configuration version.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "LatestVersionNumber": { + "description": "An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.", + "type": "integer" + }, + "VersionLabel": { + "description": "A user-defined label for an AWS AppConfig hosted configuration version.", + "maxLength": 64, + "minLength": 0, + "pattern": "^$|.*[^0-9].*", + "type": "string" + }, + "VersionNumber": { + "description": "Current version number of hosted configuration version.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VersionNumber" + ], + "required": [ + "ApplicationId", + "ConfigurationProfileId", + "Content", + "ContentType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppConfig::HostedConfigurationVersion", + "writeOnlyProperties": [ + "/properties/LatestVersionNumber" + ] +} diff --git a/schema/aws-appflow-connector.json b/schema/aws-appflow-connector.json index 426abfa..aee7916 100644 --- a/schema/aws-appflow-connector.json +++ b/schema/aws-appflow-connector.json @@ -1,114 +1,114 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorLabel" - ], - "definitions": { - "ConnectorProvisioningConfig": { - "additionalProperties": false, - "description": "Contains information about the configuration of the connector being registered.", - "properties": { - "Lambda": { - "$ref": "#/definitions/LambdaConnectorProvisioningConfig", - "description": "Contains information about the configuration of the lambda which is being registered as the connector." - } - }, - "type": "object" - }, - "LambdaConnectorProvisioningConfig": { - "additionalProperties": false, - "description": "Contains information about the configuration of the lambda which is being registered as the connector.", - "properties": { - "LambdaArn": { - "description": "Lambda ARN of the connector being registered.", - "maxLength": 512, - "pattern": "arn:*:.*:.*:[0-9]+:.*", - "type": "string" - } - }, - "required": [ - "LambdaArn" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::AppFlow::Connector", - "handlers": { - "create": { - "permissions": [ - "appflow:RegisterConnector", - "lambda:InvokeFunction" - ] - }, - "delete": { - "permissions": [ - "appflow:UnRegisterConnector" - ] - }, - "list": { - "permissions": [ - "appflow:ListConnectors" - ] - }, - "read": { - "permissions": [ - "appflow:DescribeConnector" - ] - }, - "update": { - "permissions": [ - "appflow:UpdateConnectorRegistration", - "lambda:InvokeFunction" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorLabel" - ], - "properties": { - "ConnectorArn": { - "description": " The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.", - "maxLength": 512, - "pattern": "arn:*:appflow:.*:[0-9]+:.*", - "type": "string" - }, - "ConnectorLabel": { - "description": " The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.", - "maxLength": 512, - "pattern": "[a-zA-Z0-9][\\w!@#.-]+", - "type": "string" - }, - "ConnectorProvisioningConfig": { - "$ref": "#/definitions/ConnectorProvisioningConfig", - "description": "Contains information about the configuration of the connector being registered." - }, - "ConnectorProvisioningType": { - "description": "The provisioning type of the connector. Currently the only supported value is LAMBDA. ", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9][\\w!@#.-]+", - "type": "string" - }, - "Description": { - "description": "A description about the connector that's being registered.", - "maxLength": 2048, - "pattern": "[\\s\\w/!@#+=.-]*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ConnectorArn" - ], - "required": [ - "ConnectorProvisioningType", - "ConnectorProvisioningConfig" - ], - "sourceUrl": "https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppFlow::Connector" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorLabel" + ], + "definitions": { + "ConnectorProvisioningConfig": { + "additionalProperties": false, + "description": "Contains information about the configuration of the connector being registered.", + "properties": { + "Lambda": { + "$ref": "#/definitions/LambdaConnectorProvisioningConfig", + "description": "Contains information about the configuration of the lambda which is being registered as the connector." + } + }, + "type": "object" + }, + "LambdaConnectorProvisioningConfig": { + "additionalProperties": false, + "description": "Contains information about the configuration of the lambda which is being registered as the connector.", + "properties": { + "LambdaArn": { + "description": "Lambda ARN of the connector being registered.", + "maxLength": 512, + "pattern": "arn:*:.*:.*:[0-9]+:.*", + "type": "string" + } + }, + "required": [ + "LambdaArn" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::AppFlow::Connector", + "handlers": { + "create": { + "permissions": [ + "appflow:RegisterConnector", + "lambda:InvokeFunction" + ] + }, + "delete": { + "permissions": [ + "appflow:UnRegisterConnector" + ] + }, + "list": { + "permissions": [ + "appflow:ListConnectors" + ] + }, + "read": { + "permissions": [ + "appflow:DescribeConnector" + ] + }, + "update": { + "permissions": [ + "appflow:UpdateConnectorRegistration", + "lambda:InvokeFunction" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorLabel" + ], + "properties": { + "ConnectorArn": { + "description": " The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.", + "maxLength": 512, + "pattern": "arn:*:appflow:.*:[0-9]+:.*", + "type": "string" + }, + "ConnectorLabel": { + "description": " The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.", + "maxLength": 512, + "pattern": "[a-zA-Z0-9][\\w!@#.-]+", + "type": "string" + }, + "ConnectorProvisioningConfig": { + "$ref": "#/definitions/ConnectorProvisioningConfig", + "description": "Contains information about the configuration of the connector being registered." + }, + "ConnectorProvisioningType": { + "description": "The provisioning type of the connector. Currently the only supported value is LAMBDA. ", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9][\\w!@#.-]+", + "type": "string" + }, + "Description": { + "description": "A description about the connector that's being registered.", + "maxLength": 2048, + "pattern": "[\\s\\w/!@#+=.-]*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ConnectorArn" + ], + "required": [ + "ConnectorProvisioningType", + "ConnectorProvisioningConfig" + ], + "sourceUrl": "https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppFlow::Connector" +} diff --git a/schema/aws-appflow-connectorprofile.json b/schema/aws-appflow-connectorprofile.json index 185b252..9d768d1 100644 --- a/schema/aws-appflow-connectorprofile.json +++ b/schema/aws-appflow-connectorprofile.json @@ -1,1265 +1,1265 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorProfileName", - "/properties/ConnectorType", - "/properties/ConnectorLabel" - ], - "definitions": { - "AccessKeyId": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "AccessToken": { - "maxLength": 4096, - "pattern": "\\S+", - "type": "string" - }, - "AccountName": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "AmplitudeConnectorProfileCredentials": { - "properties": { - "ApiKey": { - "$ref": "#/definitions/ApiKey", - "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." - }, - "SecretKey": { - "$ref": "#/definitions/SecretKey" - } - }, - "required": [ - "ApiKey", - "SecretKey" - ], - "type": "object" - }, - "ApiKey": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "ApiKeyCredentials": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "$ref": "#/definitions/ApiKey" - }, - "ApiSecretKey": { - "$ref": "#/definitions/ApiSecretKey" - } - }, - "required": [ - "ApiKey" - ], - "type": "object" - }, - "ApiSecretKey": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "ApiToken": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "ApplicationHostUrl": { - "maxLength": 256, - "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", - "type": "string" - }, - "ApplicationKey": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ApplicationServicePath": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "AuthCode": { - "maxLength": 4096, - "pattern": "\\S+", - "type": "string" - }, - "AuthenticationType": { - "enum": [ - "OAUTH2", - "APIKEY", - "BASIC", - "CUSTOM" - ], - "type": "string" - }, - "BasicAuthCredentials": { - "additionalProperties": false, - "properties": { - "Password": { - "$ref": "#/definitions/Password" - }, - "Username": { - "$ref": "#/definitions/Username" - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "\\S+", - "type": "string" - }, - "BucketPrefix": { - "maxLength": 128, - "type": "string" - }, - "BusinessUnitId": { - "maxLength": 18, - "pattern": "\\S+", - "type": "string" - }, - "ClientCredentialsArn": { - "maxLength": 2048, - "pattern": "arn:aws:secretsmanager:.*:[0-9]+:.*", - "type": "string" - }, - "ClientId": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ClientNumber": { - "maxLength": 3, - "minLength": 3, - "pattern": "^\\d{3}$", - "type": "string" - }, - "ClientSecret": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ClusterIdentifier": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ConnectorOAuthRequest": { - "properties": { - "AuthCode": { - "description": "The code provided by the connector when it has been authenticated via the connected app.", - "type": "string" - }, - "RedirectUri": { - "description": "The URL to which the authentication server redirects the browser after authorization has been\ngranted.", - "type": "string" - } - }, - "type": "object" - }, - "ConnectorProfileConfig": { - "description": "Connector specific configurations needed to create connector profile", - "properties": { - "ConnectorProfileCredentials": { - "$ref": "#/definitions/ConnectorProfileCredentials" - }, - "ConnectorProfileProperties": { - "$ref": "#/definitions/ConnectorProfileProperties" - } - }, - "type": "object" - }, - "ConnectorProfileCredentials": { - "description": "Connector specific configuration needed to create connector profile based on Authentication mechanism", - "properties": { - "Amplitude": { - "$ref": "#/definitions/AmplitudeConnectorProfileCredentials" - }, - "CustomConnector": { - "$ref": "#/definitions/CustomConnectorProfileCredentials" - }, - "Datadog": { - "$ref": "#/definitions/DatadogConnectorProfileCredentials" - }, - "Dynatrace": { - "$ref": "#/definitions/DynatraceConnectorProfileCredentials" - }, - "GoogleAnalytics": { - "$ref": "#/definitions/GoogleAnalyticsConnectorProfileCredentials" - }, - "InforNexus": { - "$ref": "#/definitions/InforNexusConnectorProfileCredentials" - }, - "Marketo": { - "$ref": "#/definitions/MarketoConnectorProfileCredentials" - }, - "Pardot": { - "$ref": "#/definitions/PardotConnectorProfileCredentials" - }, - "Redshift": { - "$ref": "#/definitions/RedshiftConnectorProfileCredentials" - }, - "SAPOData": { - "$ref": "#/definitions/SAPODataConnectorProfileCredentials" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceConnectorProfileCredentials" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowConnectorProfileCredentials" - }, - "Singular": { - "$ref": "#/definitions/SingularConnectorProfileCredentials" - }, - "Slack": { - "$ref": "#/definitions/SlackConnectorProfileCredentials" - }, - "Snowflake": { - "$ref": "#/definitions/SnowflakeConnectorProfileCredentials" - }, - "Trendmicro": { - "$ref": "#/definitions/TrendmicroConnectorProfileCredentials" - }, - "Veeva": { - "$ref": "#/definitions/VeevaConnectorProfileCredentials" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskConnectorProfileCredentials" - } - }, - "type": "object" - }, - "ConnectorProfileProperties": { - "description": "Connector specific properties needed to create connector profile - currently not needed for Amplitude, Trendmicro, Googleanalytics and Singular", - "properties": { - "CustomConnector": { - "$ref": "#/definitions/CustomConnectorProfileProperties" - }, - "Datadog": { - "$ref": "#/definitions/DatadogConnectorProfileProperties" - }, - "Dynatrace": { - "$ref": "#/definitions/DynatraceConnectorProfileProperties" - }, - "InforNexus": { - "$ref": "#/definitions/InforNexusConnectorProfileProperties" - }, - "Marketo": { - "$ref": "#/definitions/MarketoConnectorProfileProperties" - }, - "Pardot": { - "$ref": "#/definitions/PardotConnectorProfileProperties" - }, - "Redshift": { - "$ref": "#/definitions/RedshiftConnectorProfileProperties" - }, - "SAPOData": { - "$ref": "#/definitions/SAPODataConnectorProfileProperties" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceConnectorProfileProperties" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowConnectorProfileProperties" - }, - "Slack": { - "$ref": "#/definitions/SlackConnectorProfileProperties" - }, - "Snowflake": { - "$ref": "#/definitions/SnowflakeConnectorProfileProperties" - }, - "Veeva": { - "$ref": "#/definitions/VeevaConnectorProfileProperties" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskConnectorProfileProperties" - } - }, - "type": "object" - }, - "ConnectorType": { - "enum": [ - "Salesforce", - "Pardot", - "Singular", - "Slack", - "Redshift", - "Marketo", - "Googleanalytics", - "Zendesk", - "Servicenow", - "SAPOData", - "Datadog", - "Trendmicro", - "Snowflake", - "Dynatrace", - "Infornexus", - "Amplitude", - "Veeva", - "CustomConnector" - ], - "type": "string" - }, - "CredentialsMap": { - "additionalProperties": false, - "description": "A map for properties for custom authentication.", - "patternProperties": { - "^[\\w]{1,128}$": { - "description": "A string containing the value for the property", - "maxLength": 2048, - "minLength": 1, - "pattern": "\\S+", - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "CustomAuthCredentials": { - "additionalProperties": false, - "properties": { - "CredentialsMap": { - "$ref": "#/definitions/CredentialsMap" - }, - "CustomAuthenticationType": { - "$ref": "#/definitions/CustomAuthenticationType" - } - }, - "required": [ - "CustomAuthenticationType" - ], - "type": "object" - }, - "CustomAuthenticationType": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "CustomConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "$ref": "#/definitions/ApiKeyCredentials" - }, - "AuthenticationType": { - "$ref": "#/definitions/AuthenticationType" - }, - "Basic": { - "$ref": "#/definitions/BasicAuthCredentials" - }, - "Custom": { - "$ref": "#/definitions/CustomAuthCredentials" - }, - "Oauth2": { - "$ref": "#/definitions/OAuth2Credentials" - } - }, - "required": [ - "AuthenticationType" - ], - "type": "object" - }, - "CustomConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "OAuth2Properties": { - "$ref": "#/definitions/OAuth2Properties" - }, - "ProfileProperties": { - "$ref": "#/definitions/ProfileProperties" - } - }, - "type": "object" - }, - "DataApiRoleArn": { - "maxLength": 512, - "pattern": "arn:aws:iam:.*:[0-9]+:.*", - "type": "string" - }, - "DatabaseName": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "DatabaseUrl": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "DatadogConnectorProfileCredentials": { - "properties": { - "ApiKey": { - "$ref": "#/definitions/ApiKey", - "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." - }, - "ApplicationKey": { - "$ref": "#/definitions/ApplicationKey", - "description": "Application keys, in conjunction with your API key, give you full access to Datadog\u2019s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API." - } - }, - "required": [ - "ApiKey", - "ApplicationKey" - ], - "type": "object" - }, - "DatadogConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Datadog resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "DynatraceConnectorProfileCredentials": { - "properties": { - "ApiToken": { - "$ref": "#/definitions/ApiToken", - "description": "The API tokens used by Dynatrace API to authenticate various API calls." - } - }, - "required": [ - "ApiToken" - ], - "type": "object" - }, - "DynatraceConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Dynatrace resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "GoogleAnalyticsConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientId": { - "$ref": "#/definitions/ClientId", - "description": "The identi\ufb01er for the desired client." - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret", - "description": "The client secret used by the oauth client to authenticate to the authorization server." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - }, - "RefreshToken": { - "$ref": "#/definitions/RefreshToken", - "description": "The credentials used to acquire new access tokens." - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "InforNexusConnectorProfileCredentials": { - "properties": { - "AccessKeyId": { - "$ref": "#/definitions/AccessKeyId", - "description": "The Access Key portion of the credentials." - }, - "Datakey": { - "$ref": "#/definitions/Key", - "description": "The encryption keys used to encrypt data." - }, - "SecretAccessKey": { - "$ref": "#/definitions/Key", - "description": "The secret key used to sign requests." - }, - "UserId": { - "$ref": "#/definitions/Username", - "description": "The identi\ufb01er for the user." - } - }, - "required": [ - "AccessKeyId", - "UserId", - "SecretAccessKey", - "Datakey" - ], - "type": "object" - }, - "InforNexusConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the InforNexus resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "InstanceUrl": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "JwtToken": { - "maxLength": 8000, - "pattern": "^[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_.+/=]*$", - "type": "string" - }, - "Key": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "LogonLanguage": { - "maxLength": 2, - "pattern": "^[a-zA-Z0-9_]*$", - "type": "string" - }, - "MarketoConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientId": { - "$ref": "#/definitions/ClientId", - "description": "The identi\ufb01er for the desired client." - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret", - "description": "The client secret used by the oauth client to authenticate to the authorization server." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "MarketoConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Marketo resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "OAuth2Credentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken" - }, - "ClientId": { - "$ref": "#/definitions/ClientId" - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret" - }, - "OAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest" - }, - "RefreshToken": { - "$ref": "#/definitions/RefreshToken" - } - }, - "type": "object" - }, - "OAuth2GrantType": { - "enum": [ - "CLIENT_CREDENTIALS", - "AUTHORIZATION_CODE", - "JWT_BEARER" - ], - "type": "string" - }, - "OAuth2Properties": { - "additionalProperties": false, - "properties": { - "OAuth2GrantType": { - "$ref": "#/definitions/OAuth2GrantType" - }, - "TokenUrl": { - "maxLength": 256, - "minLength": 0, - "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", - "type": "string" - }, - "TokenUrlCustomProperties": { - "$ref": "#/definitions/TokenUrlCustomProperties" - } - }, - "type": "object" - }, - "OAuthProperties": { - "properties": { - "AuthCodeUrl": { - "maxLength": 256, - "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", - "type": "string" - }, - "OAuthScopes": { - "items": { - "maxLength": 128, - "pattern": "[/\\w]*", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "TokenUrl": { - "maxLength": 256, - "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", - "type": "string" - } - }, - "type": "object" - }, - "PardotConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientCredentialsArn": { - "$ref": "#/definitions/ClientCredentialsArn", - "description": "The client credentials to fetch access token and refresh token." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - }, - "RefreshToken": { - "$ref": "#/definitions/RefreshToken", - "description": "The credentials used to acquire new access tokens." - } - }, - "type": "object" - }, - "PardotConnectorProfileProperties": { - "properties": { - "BusinessUnitId": { - "$ref": "#/definitions/BusinessUnitId", - "description": "The Business unit id of Salesforce Pardot instance to be connected" - }, - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Salesforce Pardot resource" - }, - "IsSandboxEnvironment": { - "description": "Indicates whether the connector profile applies to a demo or production environment", - "type": "boolean" - } - }, - "required": [ - "BusinessUnitId" - ], - "type": "object" - }, - "Password": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "PortNumber": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "PrivateLinkServiceName": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ProfileProperties": { - "additionalProperties": false, - "description": "A map for properties for custom connector.", - "patternProperties": { - "^[\\w]{1,256}$": { - "description": "A string containing the value for the property", - "maxLength": 2048, - "minLength": 1, - "pattern": "\\S+", - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "RedshiftConnectorProfileCredentials": { - "properties": { - "Password": { - "$ref": "#/definitions/Password", - "description": "The password that corresponds to the username." - }, - "Username": { - "$ref": "#/definitions/Username", - "description": "The name of the user." - } - }, - "type": "object" - }, - "RedshiftConnectorProfileProperties": { - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName", - "description": "The name of the Amazon S3 bucket associated with Redshift." - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix", - "description": "The object key for the destination bucket in which Amazon AppFlow will place the \ufb01les." - }, - "ClusterIdentifier": { - "$ref": "#/definitions/ClusterIdentifier", - "description": "The unique identifier of the Amazon Redshift cluster." - }, - "DataApiRoleArn": { - "$ref": "#/definitions/DataApiRoleArn", - "description": "The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API." - }, - "DatabaseName": { - "$ref": "#/definitions/DatabaseName", - "description": "The name of the Amazon Redshift database that will store the transferred data." - }, - "DatabaseUrl": { - "$ref": "#/definitions/DatabaseUrl", - "description": "The JDBC URL of the Amazon Redshift cluster." - }, - "IsRedshiftServerless": { - "description": "If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster.", - "type": "boolean" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn", - "description": "The Amazon Resource Name (ARN) of the IAM role." - }, - "WorkgroupName": { - "$ref": "#/definitions/WorkgroupName", - "description": "The name of the Amazon Redshift serverless workgroup" - } - }, - "required": [ - "BucketName", - "RoleArn" - ], - "type": "object" - }, - "RefreshToken": { - "maxLength": 4096, - "pattern": "\\S+", - "type": "string" - }, - "Region": { - "maxLength": 64, - "pattern": "\\S+", - "type": "string" - }, - "RoleArn": { - "maxLength": 512, - "pattern": "arn:aws:iam:.*:[0-9]+:.*", - "type": "string" - }, - "SAPODataConnectorProfileCredentials": { - "properties": { - "BasicAuthCredentials": { - "$ref": "#/definitions/BasicAuthCredentials" - }, - "OAuthCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken" - }, - "ClientId": { - "$ref": "#/definitions/ClientId" - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest" - }, - "RefreshToken": { - "$ref": "#/definitions/RefreshToken" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "SAPODataConnectorProfileProperties": { - "properties": { - "ApplicationHostUrl": { - "$ref": "#/definitions/ApplicationHostUrl" - }, - "ApplicationServicePath": { - "$ref": "#/definitions/ApplicationServicePath" - }, - "ClientNumber": { - "$ref": "#/definitions/ClientNumber" - }, - "DisableSSO": { - "description": "If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.", - "type": "boolean" - }, - "LogonLanguage": { - "$ref": "#/definitions/LogonLanguage" - }, - "OAuthProperties": { - "$ref": "#/definitions/OAuthProperties" - }, - "PortNumber": { - "$ref": "#/definitions/PortNumber" - }, - "PrivateLinkServiceName": { - "$ref": "#/definitions/PrivateLinkServiceName" - } - }, - "type": "object" - }, - "SalesforceConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientCredentialsArn": { - "$ref": "#/definitions/ClientCredentialsArn", - "description": "The client credentials to fetch access token and refresh token." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - }, - "JwtToken": { - "$ref": "#/definitions/JwtToken", - "description": "The credentials used to access your Salesforce records" - }, - "OAuth2GrantType": { - "$ref": "#/definitions/OAuth2GrantType", - "description": "The grant types to fetch an access token" - }, - "RefreshToken": { - "$ref": "#/definitions/RefreshToken", - "description": "The credentials used to acquire new access tokens." - } - }, - "type": "object" - }, - "SalesforceConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Salesforce resource" - }, - "isSandboxEnvironment": { - "description": "Indicates whether the connector profile applies to a sandbox or production environment", - "type": "boolean" - }, - "usePrivateLinkForMetadataAndAuthorization": { - "description": "Indicates whether to make Metadata And Authorization calls over Pivate Network", - "type": "boolean" - } - }, - "type": "object" - }, - "SecretKey": { - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "ServiceNowConnectorProfileCredentials": { - "properties": { - "OAuth2Credentials": { - "$ref": "#/definitions/OAuth2Credentials", - "description": "The OAuth 2.0 credentials required to authenticate the user." - }, - "Password": { - "$ref": "#/definitions/Password", - "description": "The password that corresponds to the username." - }, - "Username": { - "$ref": "#/definitions/Username", - "description": "The name of the user." - } - }, - "type": "object" - }, - "ServiceNowConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the ServiceNow resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "SingularConnectorProfileCredentials": { - "properties": { - "ApiKey": { - "$ref": "#/definitions/ApiKey", - "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." - } - }, - "required": [ - "ApiKey" - ], - "type": "object" - }, - "SlackConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientId": { - "$ref": "#/definitions/ClientId", - "description": "The identi\ufb01er for the desired client." - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret", - "description": "The client secret used by the oauth client to authenticate to the authorization server." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "SlackConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Slack resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "SnowflakeConnectorProfileCredentials": { - "properties": { - "Password": { - "$ref": "#/definitions/Password", - "description": "The password that corresponds to the username." - }, - "Username": { - "$ref": "#/definitions/Username", - "description": "The name of the user." - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "SnowflakeConnectorProfileProperties": { - "properties": { - "AccountName": { - "$ref": "#/definitions/AccountName", - "description": "The name of the account." - }, - "BucketName": { - "$ref": "#/definitions/BucketName", - "description": "The name of the Amazon S3 bucket associated with Snow\ufb02ake." - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix", - "description": "The bucket prefix that refers to the Amazon S3 bucket associated with Snow\ufb02ake." - }, - "PrivateLinkServiceName": { - "$ref": "#/definitions/PrivateLinkServiceName", - "description": "The Snow\ufb02ake Private Link service name to be used for private data transfers." - }, - "Region": { - "$ref": "#/definitions/Region", - "description": "The region of the Snow\ufb02ake account." - }, - "Stage": { - "$ref": "#/definitions/Stage", - "description": "The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the\nSnow\ufb02ake account. This is written in the following format: < Database>< Schema>." - }, - "Warehouse": { - "$ref": "#/definitions/Warehouse", - "description": "The name of the Snow\ufb02ake warehouse." - } - }, - "required": [ - "Warehouse", - "Stage", - "BucketName" - ], - "type": "object" - }, - "Stage": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "TokenUrlCustomProperties": { - "additionalProperties": false, - "description": "A map for properties for custom connector Token Url.", - "patternProperties": { - "^[\\w]{1,128}$": { - "description": "A string containing the value for the property", - "maxLength": 2048, - "minLength": 1, - "pattern": "\\S+", - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "TrendmicroConnectorProfileCredentials": { - "properties": { - "ApiSecretKey": { - "$ref": "#/definitions/ApiSecretKey", - "description": "The Secret Access Key portion of the credentials." - } - }, - "required": [ - "ApiSecretKey" - ], - "type": "object" - }, - "Username": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "VeevaConnectorProfileCredentials": { - "properties": { - "Password": { - "$ref": "#/definitions/Password", - "description": "The password that corresponds to the username." - }, - "Username": { - "$ref": "#/definitions/Username", - "description": "The name of the user." - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "VeevaConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Veeva resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "Warehouse": { - "maxLength": 512, - "pattern": "[\\s\\w/!@#+=.-]*", - "type": "string" - }, - "WorkgroupName": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ZendeskConnectorProfileCredentials": { - "properties": { - "AccessToken": { - "$ref": "#/definitions/AccessToken", - "description": "The credentials used to access protected resources." - }, - "ClientId": { - "$ref": "#/definitions/ClientId", - "description": "The identi\ufb01er for the desired client." - }, - "ClientSecret": { - "$ref": "#/definitions/ClientSecret", - "description": "The client secret used by the oauth client to authenticate to the authorization server." - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/ConnectorOAuthRequest", - "description": "The oauth needed to request security tokens from the connector endpoint." - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "ZendeskConnectorProfileProperties": { - "properties": { - "InstanceUrl": { - "$ref": "#/definitions/InstanceUrl", - "description": "The location of the Zendesk resource" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppFlow::ConnectorProfile", - "handlers": { - "create": { - "permissions": [ - "appflow:CreateConnectorProfile", - "kms:ListKeys", - "kms:DescribeKey", - "kms:ListAliases", - "kms:CreateGrant", - "kms:ListGrants", - "iam:PassRole", - "secretsmanager:CreateSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "appflow:DeleteConnectorProfile" - ] - }, - "list": { - "permissions": [ - "appflow:DescribeConnectorProfiles" - ] - }, - "read": { - "permissions": [ - "appflow:DescribeConnectorProfiles" - ] - }, - "update": { - "permissions": [ - "appflow:UpdateConnectorProfile", - "kms:ListKeys", - "kms:DescribeKey", - "kms:ListAliases", - "kms:CreateGrant", - "kms:ListGrants", - "iam:PassRole", - "secretsmanager:CreateSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:PutResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorProfileName" - ], - "properties": { - "ConnectionMode": { - "description": "Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular", - "enum": [ - "Public", - "Private" - ], - "type": "string" - }, - "ConnectorLabel": { - "description": "The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.", - "maxLength": 256, - "pattern": "[\\w!@#.-]+", - "type": "string" - }, - "ConnectorProfileArn": { - "description": "Unique identifier for connector profile resources", - "maxLength": 512, - "pattern": "arn:aws:appflow:.*:[0-9]+:.*", - "type": "string" - }, - "ConnectorProfileConfig": { - "$ref": "#/definitions/ConnectorProfileConfig", - "description": "Connector specific configurations needed to create connector profile" - }, - "ConnectorProfileName": { - "description": "The maximum number of items to retrieve in a single batch.", - "maxLength": 256, - "pattern": "[\\w/!@#+=.-]+", - "type": "string" - }, - "ConnectorType": { - "$ref": "#/definitions/ConnectorType", - "description": "List of Saas providers that need connector profile to be created" - }, - "CredentialsArn": { - "description": "A unique Arn for Connector-Profile resource", - "maxLength": 512, - "pattern": "arn:aws:.*:.*:[0-9]+:.*", - "type": "string" - }, - "KMSArn": { - "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws:kms:.*:[0-9]+:.*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ConnectorProfileArn", - "/properties/CredentialsArn" - ], - "required": [ - "ConnectorProfileName", - "ConnectionMode", - "ConnectorType" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppFlow::ConnectorProfile", - "writeOnlyProperties": [ - "/properties/ConnectorProfileConfig", - "/properties/KMSArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorProfileName", + "/properties/ConnectorType", + "/properties/ConnectorLabel" + ], + "definitions": { + "AccessKeyId": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "AccessToken": { + "maxLength": 4096, + "pattern": "\\S+", + "type": "string" + }, + "AccountName": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "AmplitudeConnectorProfileCredentials": { + "properties": { + "ApiKey": { + "$ref": "#/definitions/ApiKey", + "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." + }, + "SecretKey": { + "$ref": "#/definitions/SecretKey" + } + }, + "required": [ + "ApiKey", + "SecretKey" + ], + "type": "object" + }, + "ApiKey": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "ApiKeyCredentials": { + "additionalProperties": false, + "properties": { + "ApiKey": { + "$ref": "#/definitions/ApiKey" + }, + "ApiSecretKey": { + "$ref": "#/definitions/ApiSecretKey" + } + }, + "required": [ + "ApiKey" + ], + "type": "object" + }, + "ApiSecretKey": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "ApiToken": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "ApplicationHostUrl": { + "maxLength": 256, + "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", + "type": "string" + }, + "ApplicationKey": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ApplicationServicePath": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "AuthCode": { + "maxLength": 4096, + "pattern": "\\S+", + "type": "string" + }, + "AuthenticationType": { + "enum": [ + "OAUTH2", + "APIKEY", + "BASIC", + "CUSTOM" + ], + "type": "string" + }, + "BasicAuthCredentials": { + "additionalProperties": false, + "properties": { + "Password": { + "$ref": "#/definitions/Password" + }, + "Username": { + "$ref": "#/definitions/Username" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "\\S+", + "type": "string" + }, + "BucketPrefix": { + "maxLength": 128, + "type": "string" + }, + "BusinessUnitId": { + "maxLength": 18, + "pattern": "\\S+", + "type": "string" + }, + "ClientCredentialsArn": { + "maxLength": 2048, + "pattern": "arn:aws:secretsmanager:.*:[0-9]+:.*", + "type": "string" + }, + "ClientId": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ClientNumber": { + "maxLength": 3, + "minLength": 3, + "pattern": "^\\d{3}$", + "type": "string" + }, + "ClientSecret": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ClusterIdentifier": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ConnectorOAuthRequest": { + "properties": { + "AuthCode": { + "description": "The code provided by the connector when it has been authenticated via the connected app.", + "type": "string" + }, + "RedirectUri": { + "description": "The URL to which the authentication server redirects the browser after authorization has been\ngranted.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectorProfileConfig": { + "description": "Connector specific configurations needed to create connector profile", + "properties": { + "ConnectorProfileCredentials": { + "$ref": "#/definitions/ConnectorProfileCredentials" + }, + "ConnectorProfileProperties": { + "$ref": "#/definitions/ConnectorProfileProperties" + } + }, + "type": "object" + }, + "ConnectorProfileCredentials": { + "description": "Connector specific configuration needed to create connector profile based on Authentication mechanism", + "properties": { + "Amplitude": { + "$ref": "#/definitions/AmplitudeConnectorProfileCredentials" + }, + "CustomConnector": { + "$ref": "#/definitions/CustomConnectorProfileCredentials" + }, + "Datadog": { + "$ref": "#/definitions/DatadogConnectorProfileCredentials" + }, + "Dynatrace": { + "$ref": "#/definitions/DynatraceConnectorProfileCredentials" + }, + "GoogleAnalytics": { + "$ref": "#/definitions/GoogleAnalyticsConnectorProfileCredentials" + }, + "InforNexus": { + "$ref": "#/definitions/InforNexusConnectorProfileCredentials" + }, + "Marketo": { + "$ref": "#/definitions/MarketoConnectorProfileCredentials" + }, + "Pardot": { + "$ref": "#/definitions/PardotConnectorProfileCredentials" + }, + "Redshift": { + "$ref": "#/definitions/RedshiftConnectorProfileCredentials" + }, + "SAPOData": { + "$ref": "#/definitions/SAPODataConnectorProfileCredentials" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceConnectorProfileCredentials" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowConnectorProfileCredentials" + }, + "Singular": { + "$ref": "#/definitions/SingularConnectorProfileCredentials" + }, + "Slack": { + "$ref": "#/definitions/SlackConnectorProfileCredentials" + }, + "Snowflake": { + "$ref": "#/definitions/SnowflakeConnectorProfileCredentials" + }, + "Trendmicro": { + "$ref": "#/definitions/TrendmicroConnectorProfileCredentials" + }, + "Veeva": { + "$ref": "#/definitions/VeevaConnectorProfileCredentials" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskConnectorProfileCredentials" + } + }, + "type": "object" + }, + "ConnectorProfileProperties": { + "description": "Connector specific properties needed to create connector profile - currently not needed for Amplitude, Trendmicro, Googleanalytics and Singular", + "properties": { + "CustomConnector": { + "$ref": "#/definitions/CustomConnectorProfileProperties" + }, + "Datadog": { + "$ref": "#/definitions/DatadogConnectorProfileProperties" + }, + "Dynatrace": { + "$ref": "#/definitions/DynatraceConnectorProfileProperties" + }, + "InforNexus": { + "$ref": "#/definitions/InforNexusConnectorProfileProperties" + }, + "Marketo": { + "$ref": "#/definitions/MarketoConnectorProfileProperties" + }, + "Pardot": { + "$ref": "#/definitions/PardotConnectorProfileProperties" + }, + "Redshift": { + "$ref": "#/definitions/RedshiftConnectorProfileProperties" + }, + "SAPOData": { + "$ref": "#/definitions/SAPODataConnectorProfileProperties" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceConnectorProfileProperties" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowConnectorProfileProperties" + }, + "Slack": { + "$ref": "#/definitions/SlackConnectorProfileProperties" + }, + "Snowflake": { + "$ref": "#/definitions/SnowflakeConnectorProfileProperties" + }, + "Veeva": { + "$ref": "#/definitions/VeevaConnectorProfileProperties" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskConnectorProfileProperties" + } + }, + "type": "object" + }, + "ConnectorType": { + "enum": [ + "Salesforce", + "Pardot", + "Singular", + "Slack", + "Redshift", + "Marketo", + "Googleanalytics", + "Zendesk", + "Servicenow", + "SAPOData", + "Datadog", + "Trendmicro", + "Snowflake", + "Dynatrace", + "Infornexus", + "Amplitude", + "Veeva", + "CustomConnector" + ], + "type": "string" + }, + "CredentialsMap": { + "additionalProperties": false, + "description": "A map for properties for custom authentication.", + "patternProperties": { + "^[\\w]{1,128}$": { + "description": "A string containing the value for the property", + "maxLength": 2048, + "minLength": 1, + "pattern": "\\S+", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "CustomAuthCredentials": { + "additionalProperties": false, + "properties": { + "CredentialsMap": { + "$ref": "#/definitions/CredentialsMap" + }, + "CustomAuthenticationType": { + "$ref": "#/definitions/CustomAuthenticationType" + } + }, + "required": [ + "CustomAuthenticationType" + ], + "type": "object" + }, + "CustomAuthenticationType": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "CustomConnectorProfileCredentials": { + "additionalProperties": false, + "properties": { + "ApiKey": { + "$ref": "#/definitions/ApiKeyCredentials" + }, + "AuthenticationType": { + "$ref": "#/definitions/AuthenticationType" + }, + "Basic": { + "$ref": "#/definitions/BasicAuthCredentials" + }, + "Custom": { + "$ref": "#/definitions/CustomAuthCredentials" + }, + "Oauth2": { + "$ref": "#/definitions/OAuth2Credentials" + } + }, + "required": [ + "AuthenticationType" + ], + "type": "object" + }, + "CustomConnectorProfileProperties": { + "additionalProperties": false, + "properties": { + "OAuth2Properties": { + "$ref": "#/definitions/OAuth2Properties" + }, + "ProfileProperties": { + "$ref": "#/definitions/ProfileProperties" + } + }, + "type": "object" + }, + "DataApiRoleArn": { + "maxLength": 512, + "pattern": "arn:aws:iam:.*:[0-9]+:.*", + "type": "string" + }, + "DatabaseName": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "DatabaseUrl": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "DatadogConnectorProfileCredentials": { + "properties": { + "ApiKey": { + "$ref": "#/definitions/ApiKey", + "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." + }, + "ApplicationKey": { + "$ref": "#/definitions/ApplicationKey", + "description": "Application keys, in conjunction with your API key, give you full access to Datadog\u2019s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API." + } + }, + "required": [ + "ApiKey", + "ApplicationKey" + ], + "type": "object" + }, + "DatadogConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Datadog resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "DynatraceConnectorProfileCredentials": { + "properties": { + "ApiToken": { + "$ref": "#/definitions/ApiToken", + "description": "The API tokens used by Dynatrace API to authenticate various API calls." + } + }, + "required": [ + "ApiToken" + ], + "type": "object" + }, + "DynatraceConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Dynatrace resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "GoogleAnalyticsConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "$ref": "#/definitions/ClientId", + "description": "The identi\ufb01er for the desired client." + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret", + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "RefreshToken": { + "$ref": "#/definitions/RefreshToken", + "description": "The credentials used to acquire new access tokens." + } + }, + "required": [ + "ClientId", + "ClientSecret" + ], + "type": "object" + }, + "InforNexusConnectorProfileCredentials": { + "properties": { + "AccessKeyId": { + "$ref": "#/definitions/AccessKeyId", + "description": "The Access Key portion of the credentials." + }, + "Datakey": { + "$ref": "#/definitions/Key", + "description": "The encryption keys used to encrypt data." + }, + "SecretAccessKey": { + "$ref": "#/definitions/Key", + "description": "The secret key used to sign requests." + }, + "UserId": { + "$ref": "#/definitions/Username", + "description": "The identi\ufb01er for the user." + } + }, + "required": [ + "AccessKeyId", + "UserId", + "SecretAccessKey", + "Datakey" + ], + "type": "object" + }, + "InforNexusConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the InforNexus resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "InstanceUrl": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "JwtToken": { + "maxLength": 8000, + "pattern": "^[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_.+/=]*$", + "type": "string" + }, + "Key": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "LogonLanguage": { + "maxLength": 2, + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string" + }, + "MarketoConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "$ref": "#/definitions/ClientId", + "description": "The identi\ufb01er for the desired client." + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret", + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + } + }, + "required": [ + "ClientId", + "ClientSecret" + ], + "type": "object" + }, + "MarketoConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Marketo resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "OAuth2Credentials": { + "additionalProperties": false, + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken" + }, + "ClientId": { + "$ref": "#/definitions/ClientId" + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret" + }, + "OAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest" + }, + "RefreshToken": { + "$ref": "#/definitions/RefreshToken" + } + }, + "type": "object" + }, + "OAuth2GrantType": { + "enum": [ + "CLIENT_CREDENTIALS", + "AUTHORIZATION_CODE", + "JWT_BEARER" + ], + "type": "string" + }, + "OAuth2Properties": { + "additionalProperties": false, + "properties": { + "OAuth2GrantType": { + "$ref": "#/definitions/OAuth2GrantType" + }, + "TokenUrl": { + "maxLength": 256, + "minLength": 0, + "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", + "type": "string" + }, + "TokenUrlCustomProperties": { + "$ref": "#/definitions/TokenUrlCustomProperties" + } + }, + "type": "object" + }, + "OAuthProperties": { + "properties": { + "AuthCodeUrl": { + "maxLength": 256, + "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", + "type": "string" + }, + "OAuthScopes": { + "items": { + "maxLength": 128, + "pattern": "[/\\w]*", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "TokenUrl": { + "maxLength": 256, + "pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]", + "type": "string" + } + }, + "type": "object" + }, + "PardotConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientCredentialsArn": { + "$ref": "#/definitions/ClientCredentialsArn", + "description": "The client credentials to fetch access token and refresh token." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "RefreshToken": { + "$ref": "#/definitions/RefreshToken", + "description": "The credentials used to acquire new access tokens." + } + }, + "type": "object" + }, + "PardotConnectorProfileProperties": { + "properties": { + "BusinessUnitId": { + "$ref": "#/definitions/BusinessUnitId", + "description": "The Business unit id of Salesforce Pardot instance to be connected" + }, + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Salesforce Pardot resource" + }, + "IsSandboxEnvironment": { + "description": "Indicates whether the connector profile applies to a demo or production environment", + "type": "boolean" + } + }, + "required": [ + "BusinessUnitId" + ], + "type": "object" + }, + "Password": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "PortNumber": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "PrivateLinkServiceName": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ProfileProperties": { + "additionalProperties": false, + "description": "A map for properties for custom connector.", + "patternProperties": { + "^[\\w]{1,256}$": { + "description": "A string containing the value for the property", + "maxLength": 2048, + "minLength": 1, + "pattern": "\\S+", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "RedshiftConnectorProfileCredentials": { + "properties": { + "Password": { + "$ref": "#/definitions/Password", + "description": "The password that corresponds to the username." + }, + "Username": { + "$ref": "#/definitions/Username", + "description": "The name of the user." + } + }, + "type": "object" + }, + "RedshiftConnectorProfileProperties": { + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName", + "description": "The name of the Amazon S3 bucket associated with Redshift." + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix", + "description": "The object key for the destination bucket in which Amazon AppFlow will place the \ufb01les." + }, + "ClusterIdentifier": { + "$ref": "#/definitions/ClusterIdentifier", + "description": "The unique identifier of the Amazon Redshift cluster." + }, + "DataApiRoleArn": { + "$ref": "#/definitions/DataApiRoleArn", + "description": "The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API." + }, + "DatabaseName": { + "$ref": "#/definitions/DatabaseName", + "description": "The name of the Amazon Redshift database that will store the transferred data." + }, + "DatabaseUrl": { + "$ref": "#/definitions/DatabaseUrl", + "description": "The JDBC URL of the Amazon Redshift cluster." + }, + "IsRedshiftServerless": { + "description": "If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster.", + "type": "boolean" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn", + "description": "The Amazon Resource Name (ARN) of the IAM role." + }, + "WorkgroupName": { + "$ref": "#/definitions/WorkgroupName", + "description": "The name of the Amazon Redshift serverless workgroup" + } + }, + "required": [ + "BucketName", + "RoleArn" + ], + "type": "object" + }, + "RefreshToken": { + "maxLength": 4096, + "pattern": "\\S+", + "type": "string" + }, + "Region": { + "maxLength": 64, + "pattern": "\\S+", + "type": "string" + }, + "RoleArn": { + "maxLength": 512, + "pattern": "arn:aws:iam:.*:[0-9]+:.*", + "type": "string" + }, + "SAPODataConnectorProfileCredentials": { + "properties": { + "BasicAuthCredentials": { + "$ref": "#/definitions/BasicAuthCredentials" + }, + "OAuthCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken" + }, + "ClientId": { + "$ref": "#/definitions/ClientId" + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret" + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest" + }, + "RefreshToken": { + "$ref": "#/definitions/RefreshToken" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "SAPODataConnectorProfileProperties": { + "properties": { + "ApplicationHostUrl": { + "$ref": "#/definitions/ApplicationHostUrl" + }, + "ApplicationServicePath": { + "$ref": "#/definitions/ApplicationServicePath" + }, + "ClientNumber": { + "$ref": "#/definitions/ClientNumber" + }, + "DisableSSO": { + "description": "If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.", + "type": "boolean" + }, + "LogonLanguage": { + "$ref": "#/definitions/LogonLanguage" + }, + "OAuthProperties": { + "$ref": "#/definitions/OAuthProperties" + }, + "PortNumber": { + "$ref": "#/definitions/PortNumber" + }, + "PrivateLinkServiceName": { + "$ref": "#/definitions/PrivateLinkServiceName" + } + }, + "type": "object" + }, + "SalesforceConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientCredentialsArn": { + "$ref": "#/definitions/ClientCredentialsArn", + "description": "The client credentials to fetch access token and refresh token." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "JwtToken": { + "$ref": "#/definitions/JwtToken", + "description": "The credentials used to access your Salesforce records" + }, + "OAuth2GrantType": { + "$ref": "#/definitions/OAuth2GrantType", + "description": "The grant types to fetch an access token" + }, + "RefreshToken": { + "$ref": "#/definitions/RefreshToken", + "description": "The credentials used to acquire new access tokens." + } + }, + "type": "object" + }, + "SalesforceConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Salesforce resource" + }, + "isSandboxEnvironment": { + "description": "Indicates whether the connector profile applies to a sandbox or production environment", + "type": "boolean" + }, + "usePrivateLinkForMetadataAndAuthorization": { + "description": "Indicates whether to make Metadata And Authorization calls over Pivate Network", + "type": "boolean" + } + }, + "type": "object" + }, + "SecretKey": { + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "ServiceNowConnectorProfileCredentials": { + "properties": { + "OAuth2Credentials": { + "$ref": "#/definitions/OAuth2Credentials", + "description": "The OAuth 2.0 credentials required to authenticate the user." + }, + "Password": { + "$ref": "#/definitions/Password", + "description": "The password that corresponds to the username." + }, + "Username": { + "$ref": "#/definitions/Username", + "description": "The name of the user." + } + }, + "type": "object" + }, + "ServiceNowConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the ServiceNow resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "SingularConnectorProfileCredentials": { + "properties": { + "ApiKey": { + "$ref": "#/definitions/ApiKey", + "description": "A unique alphanumeric identi\ufb01er used to authenticate a user, developer, or calling program to your API." + } + }, + "required": [ + "ApiKey" + ], + "type": "object" + }, + "SlackConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "$ref": "#/definitions/ClientId", + "description": "The identi\ufb01er for the desired client." + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret", + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + } + }, + "required": [ + "ClientId", + "ClientSecret" + ], + "type": "object" + }, + "SlackConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Slack resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "SnowflakeConnectorProfileCredentials": { + "properties": { + "Password": { + "$ref": "#/definitions/Password", + "description": "The password that corresponds to the username." + }, + "Username": { + "$ref": "#/definitions/Username", + "description": "The name of the user." + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "SnowflakeConnectorProfileProperties": { + "properties": { + "AccountName": { + "$ref": "#/definitions/AccountName", + "description": "The name of the account." + }, + "BucketName": { + "$ref": "#/definitions/BucketName", + "description": "The name of the Amazon S3 bucket associated with Snow\ufb02ake." + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix", + "description": "The bucket prefix that refers to the Amazon S3 bucket associated with Snow\ufb02ake." + }, + "PrivateLinkServiceName": { + "$ref": "#/definitions/PrivateLinkServiceName", + "description": "The Snow\ufb02ake Private Link service name to be used for private data transfers." + }, + "Region": { + "$ref": "#/definitions/Region", + "description": "The region of the Snow\ufb02ake account." + }, + "Stage": { + "$ref": "#/definitions/Stage", + "description": "The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the\nSnow\ufb02ake account. This is written in the following format: < Database>< Schema>." + }, + "Warehouse": { + "$ref": "#/definitions/Warehouse", + "description": "The name of the Snow\ufb02ake warehouse." + } + }, + "required": [ + "Warehouse", + "Stage", + "BucketName" + ], + "type": "object" + }, + "Stage": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "TokenUrlCustomProperties": { + "additionalProperties": false, + "description": "A map for properties for custom connector Token Url.", + "patternProperties": { + "^[\\w]{1,128}$": { + "description": "A string containing the value for the property", + "maxLength": 2048, + "minLength": 1, + "pattern": "\\S+", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "TrendmicroConnectorProfileCredentials": { + "properties": { + "ApiSecretKey": { + "$ref": "#/definitions/ApiSecretKey", + "description": "The Secret Access Key portion of the credentials." + } + }, + "required": [ + "ApiSecretKey" + ], + "type": "object" + }, + "Username": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "VeevaConnectorProfileCredentials": { + "properties": { + "Password": { + "$ref": "#/definitions/Password", + "description": "The password that corresponds to the username." + }, + "Username": { + "$ref": "#/definitions/Username", + "description": "The name of the user." + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "VeevaConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Veeva resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + }, + "Warehouse": { + "maxLength": 512, + "pattern": "[\\s\\w/!@#+=.-]*", + "type": "string" + }, + "WorkgroupName": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ZendeskConnectorProfileCredentials": { + "properties": { + "AccessToken": { + "$ref": "#/definitions/AccessToken", + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "$ref": "#/definitions/ClientId", + "description": "The identi\ufb01er for the desired client." + }, + "ClientSecret": { + "$ref": "#/definitions/ClientSecret", + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "$ref": "#/definitions/ConnectorOAuthRequest", + "description": "The oauth needed to request security tokens from the connector endpoint." + } + }, + "required": [ + "ClientId", + "ClientSecret" + ], + "type": "object" + }, + "ZendeskConnectorProfileProperties": { + "properties": { + "InstanceUrl": { + "$ref": "#/definitions/InstanceUrl", + "description": "The location of the Zendesk resource" + } + }, + "required": [ + "InstanceUrl" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppFlow::ConnectorProfile", + "handlers": { + "create": { + "permissions": [ + "appflow:CreateConnectorProfile", + "kms:ListKeys", + "kms:DescribeKey", + "kms:ListAliases", + "kms:CreateGrant", + "kms:ListGrants", + "iam:PassRole", + "secretsmanager:CreateSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "appflow:DeleteConnectorProfile" + ] + }, + "list": { + "permissions": [ + "appflow:DescribeConnectorProfiles" + ] + }, + "read": { + "permissions": [ + "appflow:DescribeConnectorProfiles" + ] + }, + "update": { + "permissions": [ + "appflow:UpdateConnectorProfile", + "kms:ListKeys", + "kms:DescribeKey", + "kms:ListAliases", + "kms:CreateGrant", + "kms:ListGrants", + "iam:PassRole", + "secretsmanager:CreateSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:PutResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorProfileName" + ], + "properties": { + "ConnectionMode": { + "description": "Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular", + "enum": [ + "Public", + "Private" + ], + "type": "string" + }, + "ConnectorLabel": { + "description": "The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.", + "maxLength": 256, + "pattern": "[\\w!@#.-]+", + "type": "string" + }, + "ConnectorProfileArn": { + "description": "Unique identifier for connector profile resources", + "maxLength": 512, + "pattern": "arn:aws:appflow:.*:[0-9]+:.*", + "type": "string" + }, + "ConnectorProfileConfig": { + "$ref": "#/definitions/ConnectorProfileConfig", + "description": "Connector specific configurations needed to create connector profile" + }, + "ConnectorProfileName": { + "description": "The maximum number of items to retrieve in a single batch.", + "maxLength": 256, + "pattern": "[\\w/!@#+=.-]+", + "type": "string" + }, + "ConnectorType": { + "$ref": "#/definitions/ConnectorType", + "description": "List of Saas providers that need connector profile to be created" + }, + "CredentialsArn": { + "description": "A unique Arn for Connector-Profile resource", + "maxLength": 512, + "pattern": "arn:aws:.*:.*:[0-9]+:.*", + "type": "string" + }, + "KMSArn": { + "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws:kms:.*:[0-9]+:.*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ConnectorProfileArn", + "/properties/CredentialsArn" + ], + "required": [ + "ConnectorProfileName", + "ConnectionMode", + "ConnectorType" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppFlow::ConnectorProfile", + "writeOnlyProperties": [ + "/properties/ConnectorProfileConfig", + "/properties/KMSArn" + ] +} diff --git a/schema/aws-appflow-flow.json b/schema/aws-appflow-flow.json index 9f8ed44..46e5471 100644 --- a/schema/aws-appflow-flow.json +++ b/schema/aws-appflow-flow.json @@ -1,1770 +1,1770 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FlowName", - "/properties/KMSArn" - ], - "definitions": { - "AggregationConfig": { - "properties": { - "AggregationType": { - "$ref": "#/definitions/AggregationType" - }, - "TargetFileSize": { - "$ref": "#/definitions/TargetFileSize" - } - }, - "type": "object" - }, - "AggregationType": { - "enum": [ - "None", - "SingleFile" - ], - "type": "string" - }, - "AmplitudeConnectorOperator": { - "enum": [ - "BETWEEN" - ], - "type": "string" - }, - "AmplitudeSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "ApiVersion": { - "description": "The API version that the connector will use.", - "maxLength": 256, - "pattern": "\\S+", - "type": "string" - }, - "BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "\\S+", - "type": "string" - }, - "BucketPrefix": { - "maxLength": 512, - "type": "string" - }, - "ConnectorOperator": { - "description": "Operation to be performed on provided source fields", - "properties": { - "Amplitude": { - "$ref": "#/definitions/AmplitudeConnectorOperator" - }, - "CustomConnector": { - "$ref": "#/definitions/Operator" - }, - "Datadog": { - "$ref": "#/definitions/DatadogConnectorOperator" - }, - "Dynatrace": { - "$ref": "#/definitions/DynatraceConnectorOperator" - }, - "GoogleAnalytics": { - "$ref": "#/definitions/GoogleAnalyticsConnectorOperator" - }, - "InforNexus": { - "$ref": "#/definitions/InforNexusConnectorOperator" - }, - "Marketo": { - "$ref": "#/definitions/MarketoConnectorOperator" - }, - "Pardot": { - "$ref": "#/definitions/PardotConnectorOperator" - }, - "S3": { - "$ref": "#/definitions/S3ConnectorOperator" - }, - "SAPOData": { - "$ref": "#/definitions/SAPODataConnectorOperator" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceConnectorOperator" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowConnectorOperator" - }, - "Singular": { - "$ref": "#/definitions/SingularConnectorOperator" - }, - "Slack": { - "$ref": "#/definitions/SlackConnectorOperator" - }, - "Trendmicro": { - "$ref": "#/definitions/TrendmicroConnectorOperator" - }, - "Veeva": { - "$ref": "#/definitions/VeevaConnectorOperator" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskConnectorOperator" - } - }, - "type": "object" - }, - "ConnectorProfileName": { - "description": "Name of connector profile", - "maxLength": 256, - "pattern": "[\\w/!@#+=.-]+", - "type": "string" - }, - "ConnectorType": { - "enum": [ - "SAPOData", - "Salesforce", - "Pardot", - "Singular", - "Slack", - "Redshift", - "S3", - "Marketo", - "Googleanalytics", - "Zendesk", - "Servicenow", - "Datadog", - "Trendmicro", - "Snowflake", - "Dynatrace", - "Infornexus", - "Amplitude", - "Veeva", - "CustomConnector", - "EventBridge", - "Upsolver", - "LookoutMetrics" - ], - "type": "string" - }, - "CustomConnectorDestinationProperties": { - "additionalProperties": false, - "properties": { - "CustomProperties": { - "$ref": "#/definitions/CustomProperties" - }, - "EntityName": { - "$ref": "#/definitions/EntityName" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IdFieldNames": { - "description": "List of fields used as ID when performing a write operation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "WriteOperationType": { - "$ref": "#/definitions/WriteOperationType" - } - }, - "required": [ - "EntityName" - ], - "type": "object" - }, - "CustomConnectorSourceProperties": { - "additionalProperties": false, - "properties": { - "CustomProperties": { - "$ref": "#/definitions/CustomProperties" - }, - "DataTransferApi": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 64, - "pattern": "[\\w/-]+", - "type": "string" - }, - "Type": { - "enum": [ - "SYNC", - "ASYNC", - "AUTOMATIC" - ], - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "EntityName": { - "$ref": "#/definitions/EntityName" - } - }, - "required": [ - "EntityName" - ], - "type": "object" - }, - "CustomProperties": { - "additionalProperties": false, - "description": "A map for properties for custom connector.", - "patternProperties": { - "^[\\w]{1,2048}$": { - "description": "A string containing the value for the property", - "maxLength": 2048, - "minLength": 1, - "pattern": "\\S+", - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "DataTransferApi": { - "enum": [ - "AUTOMATIC", - "BULKV2", - "REST_SYNC" - ], - "type": "string" - }, - "DatadogConnectorOperator": { - "enum": [ - "PROJECTION", - "BETWEEN", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "DatadogSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "DatetimeTypeFieldName": { - "description": "Name of the datetime/timestamp data type field to be used for importing incremental records from the source", - "maxLength": 256, - "type": "string" - }, - "DestinationConnectorProperties": { - "description": "Destination connector details", - "properties": { - "CustomConnector": { - "$ref": "#/definitions/CustomConnectorDestinationProperties" - }, - "EventBridge": { - "$ref": "#/definitions/EventBridgeDestinationProperties" - }, - "LookoutMetrics": { - "$ref": "#/definitions/LookoutMetricsDestinationProperties" - }, - "Marketo": { - "$ref": "#/definitions/MarketoDestinationProperties" - }, - "Redshift": { - "$ref": "#/definitions/RedshiftDestinationProperties" - }, - "S3": { - "$ref": "#/definitions/S3DestinationProperties" - }, - "SAPOData": { - "$ref": "#/definitions/SAPODataDestinationProperties" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceDestinationProperties" - }, - "Snowflake": { - "$ref": "#/definitions/SnowflakeDestinationProperties" - }, - "Upsolver": { - "$ref": "#/definitions/UpsolverDestinationProperties" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskDestinationProperties" - } - }, - "type": "object" - }, - "DestinationFlowConfig": { - "additionalProperties": false, - "description": "Configurations of destination connector.", - "properties": { - "ApiVersion": { - "$ref": "#/definitions/ApiVersion", - "description": "The API version that the destination connector uses." - }, - "ConnectorProfileName": { - "$ref": "#/definitions/ConnectorProfileName", - "description": "Name of destination connector profile" - }, - "ConnectorType": { - "$ref": "#/definitions/ConnectorType", - "description": "Destination connector type" - }, - "DestinationConnectorProperties": { - "$ref": "#/definitions/DestinationConnectorProperties", - "description": "Destination connector details" - } - }, - "required": [ - "ConnectorType", - "DestinationConnectorProperties" - ], - "type": "object" - }, - "DocumentType": { - "maxLength": 512, - "pattern": "[\\s\\w_-]+", - "type": "string" - }, - "DynatraceConnectorOperator": { - "enum": [ - "PROJECTION", - "BETWEEN", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "DynatraceSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "EnableDynamicFieldUpdate": { - "type": "boolean" - }, - "EntityName": { - "maxLength": 1024, - "pattern": "\\S+", - "type": "string" - }, - "ErrorHandlingConfig": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "FailOnFirstError": { - "type": "boolean" - } - }, - "type": "object" - }, - "EventBridgeDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "FileType": { - "enum": [ - "CSV", - "JSON", - "PARQUET" - ], - "type": "string" - }, - "GlueDataCatalog": { - "additionalProperties": false, - "description": "Trigger settings of the flow.", - "properties": { - "DatabaseName": { - "description": "A string containing the value for the tag", - "maxLength": 255, - "minLength": 0, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*", - "type": "string" - }, - "RoleArn": { - "description": "A string containing the value for the tag", - "maxLength": 512, - "minLength": 0, - "pattern": "arn:aws:iam:.*:[0-9]+:.*", - "type": "string" - }, - "TablePrefix": { - "description": "A string containing the value for the tag", - "maxLength": 128, - "minLength": 0, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*", - "type": "string" - } - }, - "required": [ - "RoleArn", - "DatabaseName", - "TablePrefix" - ], - "type": "object" - }, - "GoogleAnalyticsConnectorOperator": { - "enum": [ - "PROJECTION", - "BETWEEN" - ], - "type": "string" - }, - "GoogleAnalyticsSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "IncludeAllVersions": { - "type": "boolean" - }, - "IncludeDeletedRecords": { - "type": "boolean" - }, - "IncludeRenditions": { - "type": "boolean" - }, - "IncludeSourceFiles": { - "type": "boolean" - }, - "IncrementalPullConfig": { - "description": "Configuration for scheduled incremental data pull", - "properties": { - "DatetimeTypeFieldName": { - "$ref": "#/definitions/DatetimeTypeFieldName" - } - }, - "type": "object" - }, - "InforNexusConnectorOperator": { - "enum": [ - "PROJECTION", - "BETWEEN", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "InforNexusSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "LookoutMetricsDestinationProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "type": "object" - }, - "MarketoConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "BETWEEN", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "MarketoDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "MarketoSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "MetadataCatalogConfig": { - "additionalProperties": false, - "description": "Configurations of metadata catalog of the flow.", - "properties": { - "GlueDataCatalog": { - "$ref": "#/definitions/GlueDataCatalog", - "description": "Configurations of glue data catalog of the flow." - } - }, - "type": "object" - }, - "Name": { - "maxLength": 128, - "pattern": "\\S+", - "type": "string" - }, - "Object": { - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "Operator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "CONTAINS", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "OperatorPropertiesKeys": { - "enum": [ - "VALUE", - "VALUES", - "DATA_TYPE", - "UPPER_BOUND", - "LOWER_BOUND", - "SOURCE_DATA_TYPE", - "DESTINATION_DATA_TYPE", - "VALIDATION_ACTION", - "MASK_VALUE", - "MASK_LENGTH", - "TRUNCATE_LENGTH", - "MATH_OPERATION_FIELDS_ORDER", - "CONCAT_FORMAT", - "SUBFIELD_CATEGORY_MAP", - "EXCLUDE_SOURCE_FIELDS_LIST", - "INCLUDE_NEW_FIELDS", - "ORDERED_PARTITION_KEYS_LIST" - ], - "type": "string" - }, - "PardotConnectorOperator": { - "enum": [ - "PROJECTION", - "EQUAL_TO", - "NO_OP", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC" - ], - "type": "string" - }, - "PardotSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "PathPrefix": { - "enum": [ - "EXECUTION_ID", - "SCHEMA_VERSION" - ], - "type": "string" - }, - "PathPrefixHierarchy": { - "items": { - "$ref": "#/definitions/PathPrefix" - }, - "type": "array" - }, - "PrefixConfig": { - "additionalProperties": false, - "properties": { - "PathPrefixHierarchy": { - "$ref": "#/definitions/PathPrefixHierarchy" - }, - "PrefixFormat": { - "$ref": "#/definitions/PrefixFormat" - }, - "PrefixType": { - "$ref": "#/definitions/PrefixType" - } - }, - "type": "object" - }, - "PrefixFormat": { - "enum": [ - "YEAR", - "MONTH", - "DAY", - "HOUR", - "MINUTE" - ], - "type": "string" - }, - "PrefixType": { - "enum": [ - "FILENAME", - "PATH", - "PATH_AND_FILENAME" - ], - "type": "string" - }, - "PreserveSourceDataTyping": { - "type": "boolean" - }, - "RedshiftDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IntermediateBucketName": { - "$ref": "#/definitions/BucketName" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object", - "IntermediateBucketName" - ], - "type": "object" - }, - "S3ConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "S3DestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "S3OutputFormatConfig": { - "$ref": "#/definitions/S3OutputFormatConfig" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "S3InputFormatConfig": { - "properties": { - "S3InputFileType": { - "enum": [ - "CSV", - "JSON" - ], - "type": "string" - } - }, - "type": "object" - }, - "S3OutputFormatConfig": { - "additionalProperties": false, - "properties": { - "AggregationConfig": { - "$ref": "#/definitions/AggregationConfig" - }, - "FileType": { - "$ref": "#/definitions/FileType" - }, - "PrefixConfig": { - "$ref": "#/definitions/PrefixConfig" - }, - "PreserveSourceDataTyping": { - "$ref": "#/definitions/PreserveSourceDataTyping" - } - }, - "type": "object" - }, - "S3SourceProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "S3InputFormatConfig": { - "$ref": "#/definitions/S3InputFormatConfig" - } - }, - "required": [ - "BucketName", - "BucketPrefix" - ], - "type": "object" - }, - "SAPODataConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "CONTAINS", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "SAPODataDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IdFieldNames": { - "description": "List of fields used as ID when performing a write operation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ObjectPath": { - "$ref": "#/definitions/Object" - }, - "SuccessResponseHandlingConfig": { - "$ref": "#/definitions/SuccessResponseHandlingConfig" - }, - "WriteOperationType": { - "$ref": "#/definitions/WriteOperationType" - } - }, - "required": [ - "ObjectPath" - ], - "type": "object" - }, - "SAPODataMaxPageSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "SAPODataMaxParallelism": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "SAPODataPaginationConfig": { - "additionalProperties": false, - "description": "SAP Source connector page size", - "properties": { - "maxPageSize": { - "$ref": "#/definitions/SAPODataMaxPageSize" - } - }, - "required": [ - "maxPageSize" - ], - "type": "object" - }, - "SAPODataParallelismConfig": { - "additionalProperties": false, - "description": "SAP Source connector parallelism factor", - "properties": { - "maxParallelism": { - "$ref": "#/definitions/SAPODataMaxParallelism" - } - }, - "required": [ - "maxParallelism" - ], - "type": "object" - }, - "SAPODataSourceProperties": { - "additionalProperties": false, - "properties": { - "ObjectPath": { - "$ref": "#/definitions/Object" - }, - "paginationConfig": { - "$ref": "#/definitions/SAPODataPaginationConfig" - }, - "parallelismConfig": { - "$ref": "#/definitions/SAPODataParallelismConfig" - } - }, - "required": [ - "ObjectPath" - ], - "type": "object" - }, - "SalesforceConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "CONTAINS", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "SalesforceDestinationProperties": { - "additionalProperties": false, - "properties": { - "DataTransferApi": { - "$ref": "#/definitions/DataTransferApi" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IdFieldNames": { - "description": "List of fields used as ID when performing a write operation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Object": { - "$ref": "#/definitions/Object" - }, - "WriteOperationType": { - "$ref": "#/definitions/WriteOperationType" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "SalesforceSourceProperties": { - "additionalProperties": false, - "properties": { - "DataTransferApi": { - "$ref": "#/definitions/DataTransferApi" - }, - "EnableDynamicFieldUpdate": { - "$ref": "#/definitions/EnableDynamicFieldUpdate" - }, - "IncludeDeletedRecords": { - "$ref": "#/definitions/IncludeDeletedRecords" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "ScheduledTriggerProperties": { - "additionalProperties": false, - "description": "Details required for scheduled trigger type", - "properties": { - "DataPullMode": { - "enum": [ - "Incremental", - "Complete" - ], - "type": "string" - }, - "FirstExecutionFrom": { - "type": "number" - }, - "FlowErrorDeactivationThreshold": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "ScheduleEndTime": { - "type": "number" - }, - "ScheduleExpression": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ScheduleOffset": { - "maximum": 36000, - "minimum": 0, - "type": "number" - }, - "ScheduleStartTime": { - "type": "number" - }, - "TimeZone": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "ServiceNowConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "CONTAINS", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "ServiceNowSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "SingularConnectorOperator": { - "enum": [ - "PROJECTION", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "SingularSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "SlackConnectorOperator": { - "enum": [ - "PROJECTION", - "BETWEEN", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "SlackSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "SnowflakeDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IntermediateBucketName": { - "$ref": "#/definitions/BucketName" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object", - "IntermediateBucketName" - ], - "type": "object" - }, - "SourceConnectorProperties": { - "description": "Source connector details required to query a connector", - "properties": { - "Amplitude": { - "$ref": "#/definitions/AmplitudeSourceProperties" - }, - "CustomConnector": { - "$ref": "#/definitions/CustomConnectorSourceProperties" - }, - "Datadog": { - "$ref": "#/definitions/DatadogSourceProperties" - }, - "Dynatrace": { - "$ref": "#/definitions/DynatraceSourceProperties" - }, - "GoogleAnalytics": { - "$ref": "#/definitions/GoogleAnalyticsSourceProperties" - }, - "InforNexus": { - "$ref": "#/definitions/InforNexusSourceProperties" - }, - "Marketo": { - "$ref": "#/definitions/MarketoSourceProperties" - }, - "Pardot": { - "$ref": "#/definitions/PardotSourceProperties" - }, - "S3": { - "$ref": "#/definitions/S3SourceProperties" - }, - "SAPOData": { - "$ref": "#/definitions/SAPODataSourceProperties" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceSourceProperties" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowSourceProperties" - }, - "Singular": { - "$ref": "#/definitions/SingularSourceProperties" - }, - "Slack": { - "$ref": "#/definitions/SlackSourceProperties" - }, - "Trendmicro": { - "$ref": "#/definitions/TrendmicroSourceProperties" - }, - "Veeva": { - "$ref": "#/definitions/VeevaSourceProperties" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskSourceProperties" - } - }, - "type": "object" - }, - "SourceFlowConfig": { - "additionalProperties": false, - "description": "Configurations of Source connector of the flow.", - "properties": { - "ApiVersion": { - "$ref": "#/definitions/ApiVersion", - "description": "The API version that the destination connector uses." - }, - "ConnectorProfileName": { - "$ref": "#/definitions/ConnectorProfileName", - "description": "Name of source connector profile" - }, - "ConnectorType": { - "$ref": "#/definitions/ConnectorType", - "description": "Type of source connector" - }, - "IncrementalPullConfig": { - "$ref": "#/definitions/IncrementalPullConfig", - "description": "Configuration for scheduled incremental data pull" - }, - "SourceConnectorProperties": { - "$ref": "#/definitions/SourceConnectorProperties", - "description": "Source connector details required to query a connector" - } - }, - "required": [ - "ConnectorType", - "SourceConnectorProperties" - ], - "type": "object" - }, - "Status": { - "enum": [ - "Active", - "Draft", - "Errored", - "Suspended" - ], - "type": "string" - }, - "SuccessResponseHandlingConfig": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging AppFlow resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TargetFileSize": { - "type": "integer" - }, - "Task": { - "additionalProperties": false, - "properties": { - "ConnectorOperator": { - "$ref": "#/definitions/ConnectorOperator", - "description": "Operation to be performed on provided source fields" - }, - "DestinationField": { - "description": "A field value on which source field should be validated", - "maxLength": 256, - "type": "string" - }, - "SourceFields": { - "description": "Source fields on which particular task will be applied", - "items": { - "type": "string" - }, - "type": "array" - }, - "TaskProperties": { - "description": "A Map used to store task related info", - "items": { - "$ref": "#/definitions/TaskPropertiesObject" - }, - "type": "array" - }, - "TaskType": { - "$ref": "#/definitions/TaskType", - "description": "Type of task" - } - }, - "required": [ - "SourceFields", - "TaskType" - ], - "type": "object" - }, - "TaskPropertiesObject": { - "additionalProperties": false, - "description": "An object used to store task related info", - "properties": { - "Key": { - "$ref": "#/definitions/OperatorPropertiesKeys" - }, - "Value": { - "maxLength": 2048, - "pattern": ".+", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TaskType": { - "enum": [ - "Arithmetic", - "Filter", - "Map", - "Map_all", - "Mask", - "Merge", - "Passthrough", - "Truncate", - "Validate", - "Partition" - ], - "type": "string" - }, - "TrendmicroConnectorOperator": { - "enum": [ - "PROJECTION", - "EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "TrendmicroSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "TriggerConfig": { - "additionalProperties": false, - "description": "Trigger settings of the flow.", - "properties": { - "TriggerProperties": { - "$ref": "#/definitions/ScheduledTriggerProperties", - "description": "Details required based on the type of trigger" - }, - "TriggerType": { - "$ref": "#/definitions/TriggerType", - "description": "Trigger type of the flow" - } - }, - "required": [ - "TriggerType" - ], - "type": "object" - }, - "TriggerType": { - "enum": [ - "Scheduled", - "Event", - "OnDemand" - ], - "type": "string" - }, - "UpsolverBucketName": { - "maxLength": 63, - "minLength": 16, - "pattern": "^(upsolver-appflow)\\S*", - "type": "string" - }, - "UpsolverDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/UpsolverBucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/BucketPrefix" - }, - "S3OutputFormatConfig": { - "$ref": "#/definitions/UpsolverS3OutputFormatConfig" - } - }, - "required": [ - "BucketName", - "S3OutputFormatConfig" - ], - "type": "object" - }, - "UpsolverS3OutputFormatConfig": { - "additionalProperties": false, - "properties": { - "AggregationConfig": { - "$ref": "#/definitions/AggregationConfig" - }, - "FileType": { - "$ref": "#/definitions/FileType" - }, - "PrefixConfig": { - "$ref": "#/definitions/PrefixConfig" - } - }, - "required": [ - "PrefixConfig" - ], - "type": "object" - }, - "VeevaConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "VeevaSourceProperties": { - "additionalProperties": false, - "properties": { - "DocumentType": { - "$ref": "#/definitions/DocumentType" - }, - "IncludeAllVersions": { - "$ref": "#/definitions/IncludeAllVersions" - }, - "IncludeRenditions": { - "$ref": "#/definitions/IncludeRenditions" - }, - "IncludeSourceFiles": { - "$ref": "#/definitions/IncludeSourceFiles" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "WriteOperationType": { - "enum": [ - "INSERT", - "UPSERT", - "UPDATE", - "DELETE" - ], - "type": "string" - }, - "ZendeskConnectorOperator": { - "enum": [ - "PROJECTION", - "GREATER_THAN", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "ZendeskDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/ErrorHandlingConfig" - }, - "IdFieldNames": { - "description": "List of fields used as ID when performing a write operation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Object": { - "$ref": "#/definitions/Object" - }, - "WriteOperationType": { - "$ref": "#/definitions/WriteOperationType" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "ZendeskSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::AppFlow::Flow.", - "handlers": { - "create": { - "permissions": [ - "appflow:CreateFlow", - "appflow:StartFlow", - "appflow:TagResource", - "appflow:ListTagsForResource", - "appflow:UseConnectorProfile", - "iam:PassRole", - "s3:ListAllMyBuckets", - "s3:GetBucketLocation", - "s3:GetBucketPolicy", - "kms:ListGrants", - "kms:ListKeys", - "kms:DescribeKey", - "kms:ListAliases", - "kms:CreateGrant", - "secretsmanager:CreateSecret", - "secretsmanager:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "appflow:DeleteFlow" - ] - }, - "list": { - "permissions": [ - "appflow:ListFlows" - ] - }, - "read": { - "permissions": [ - "appflow:DescribeFlow", - "appflow:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "appflow:UpdateFlow", - "appflow:StartFlow", - "appflow:StopFlow", - "appflow:TagResource", - "appflow:UntagResource", - "appflow:ListTagsForResource", - "appflow:UseConnectorProfile", - "iam:PassRole", - "s3:ListAllMyBuckets", - "s3:GetBucketLocation", - "s3:GetBucketPolicy", - "kms:ListGrants", - "secretsmanager:CreateSecret", - "secretsmanager:PutResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/FlowName" - ], - "properties": { - "Description": { - "description": "Description of the flow.", - "maxLength": 2048, - "pattern": "[\\w!@#\\-.?,\\s]*", - "type": "string" - }, - "DestinationFlowConfigList": { - "description": "List of Destination connectors of the flow.", - "items": { - "$ref": "#/definitions/DestinationFlowConfig" - }, - "type": "array" - }, - "FlowArn": { - "description": "ARN identifier of the flow.", - "maxLength": 512, - "pattern": "arn:aws:appflow:.*:[0-9]+:.*", - "type": "string" - }, - "FlowName": { - "description": "Name of the flow.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9][\\w!@#.-]+", - "type": "string" - }, - "FlowStatus": { - "description": "Flow activation status for Scheduled- and Event-triggered flows", - "enum": [ - "Active", - "Suspended", - "Draft" - ], - "type": "string" - }, - "KMSArn": { - "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws:kms:.*:[0-9]+:.*", - "type": "string" - }, - "MetadataCatalogConfig": { - "$ref": "#/definitions/MetadataCatalogConfig", - "description": "Configurations of metadata catalog of the flow." - }, - "SourceFlowConfig": { - "$ref": "#/definitions/SourceFlowConfig", - "description": "Configurations of Source connector of the flow." - }, - "Tags": { - "description": "List of Tags.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Tasks": { - "description": "List of tasks for the flow.", - "items": { - "$ref": "#/definitions/Task" - }, - "type": "array" - }, - "TriggerConfig": { - "$ref": "#/definitions/TriggerConfig", - "description": "Trigger settings of the flow." - } - }, - "readOnlyProperties": [ - "/properties/FlowArn" - ], - "required": [ - "FlowName", - "Tasks", - "SourceFlowConfig", - "DestinationFlowConfigList", - "TriggerConfig" - ], - "sourceUrl": "https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppFlow::Flow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FlowName", + "/properties/KMSArn" + ], + "definitions": { + "AggregationConfig": { + "properties": { + "AggregationType": { + "$ref": "#/definitions/AggregationType" + }, + "TargetFileSize": { + "$ref": "#/definitions/TargetFileSize" + } + }, + "type": "object" + }, + "AggregationType": { + "enum": [ + "None", + "SingleFile" + ], + "type": "string" + }, + "AmplitudeConnectorOperator": { + "enum": [ + "BETWEEN" + ], + "type": "string" + }, + "AmplitudeSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "ApiVersion": { + "description": "The API version that the connector will use.", + "maxLength": 256, + "pattern": "\\S+", + "type": "string" + }, + "BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "\\S+", + "type": "string" + }, + "BucketPrefix": { + "maxLength": 512, + "type": "string" + }, + "ConnectorOperator": { + "description": "Operation to be performed on provided source fields", + "properties": { + "Amplitude": { + "$ref": "#/definitions/AmplitudeConnectorOperator" + }, + "CustomConnector": { + "$ref": "#/definitions/Operator" + }, + "Datadog": { + "$ref": "#/definitions/DatadogConnectorOperator" + }, + "Dynatrace": { + "$ref": "#/definitions/DynatraceConnectorOperator" + }, + "GoogleAnalytics": { + "$ref": "#/definitions/GoogleAnalyticsConnectorOperator" + }, + "InforNexus": { + "$ref": "#/definitions/InforNexusConnectorOperator" + }, + "Marketo": { + "$ref": "#/definitions/MarketoConnectorOperator" + }, + "Pardot": { + "$ref": "#/definitions/PardotConnectorOperator" + }, + "S3": { + "$ref": "#/definitions/S3ConnectorOperator" + }, + "SAPOData": { + "$ref": "#/definitions/SAPODataConnectorOperator" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceConnectorOperator" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowConnectorOperator" + }, + "Singular": { + "$ref": "#/definitions/SingularConnectorOperator" + }, + "Slack": { + "$ref": "#/definitions/SlackConnectorOperator" + }, + "Trendmicro": { + "$ref": "#/definitions/TrendmicroConnectorOperator" + }, + "Veeva": { + "$ref": "#/definitions/VeevaConnectorOperator" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskConnectorOperator" + } + }, + "type": "object" + }, + "ConnectorProfileName": { + "description": "Name of connector profile", + "maxLength": 256, + "pattern": "[\\w/!@#+=.-]+", + "type": "string" + }, + "ConnectorType": { + "enum": [ + "SAPOData", + "Salesforce", + "Pardot", + "Singular", + "Slack", + "Redshift", + "S3", + "Marketo", + "Googleanalytics", + "Zendesk", + "Servicenow", + "Datadog", + "Trendmicro", + "Snowflake", + "Dynatrace", + "Infornexus", + "Amplitude", + "Veeva", + "CustomConnector", + "EventBridge", + "Upsolver", + "LookoutMetrics" + ], + "type": "string" + }, + "CustomConnectorDestinationProperties": { + "additionalProperties": false, + "properties": { + "CustomProperties": { + "$ref": "#/definitions/CustomProperties" + }, + "EntityName": { + "$ref": "#/definitions/EntityName" + }, + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IdFieldNames": { + "description": "List of fields used as ID when performing a write operation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "WriteOperationType": { + "$ref": "#/definitions/WriteOperationType" + } + }, + "required": [ + "EntityName" + ], + "type": "object" + }, + "CustomConnectorSourceProperties": { + "additionalProperties": false, + "properties": { + "CustomProperties": { + "$ref": "#/definitions/CustomProperties" + }, + "DataTransferApi": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 64, + "pattern": "[\\w/-]+", + "type": "string" + }, + "Type": { + "enum": [ + "SYNC", + "ASYNC", + "AUTOMATIC" + ], + "type": "string" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "EntityName": { + "$ref": "#/definitions/EntityName" + } + }, + "required": [ + "EntityName" + ], + "type": "object" + }, + "CustomProperties": { + "additionalProperties": false, + "description": "A map for properties for custom connector.", + "patternProperties": { + "^[\\w]{1,2048}$": { + "description": "A string containing the value for the property", + "maxLength": 2048, + "minLength": 1, + "pattern": "\\S+", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "DataTransferApi": { + "enum": [ + "AUTOMATIC", + "BULKV2", + "REST_SYNC" + ], + "type": "string" + }, + "DatadogConnectorOperator": { + "enum": [ + "PROJECTION", + "BETWEEN", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "DatadogSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "DatetimeTypeFieldName": { + "description": "Name of the datetime/timestamp data type field to be used for importing incremental records from the source", + "maxLength": 256, + "type": "string" + }, + "DestinationConnectorProperties": { + "description": "Destination connector details", + "properties": { + "CustomConnector": { + "$ref": "#/definitions/CustomConnectorDestinationProperties" + }, + "EventBridge": { + "$ref": "#/definitions/EventBridgeDestinationProperties" + }, + "LookoutMetrics": { + "$ref": "#/definitions/LookoutMetricsDestinationProperties" + }, + "Marketo": { + "$ref": "#/definitions/MarketoDestinationProperties" + }, + "Redshift": { + "$ref": "#/definitions/RedshiftDestinationProperties" + }, + "S3": { + "$ref": "#/definitions/S3DestinationProperties" + }, + "SAPOData": { + "$ref": "#/definitions/SAPODataDestinationProperties" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceDestinationProperties" + }, + "Snowflake": { + "$ref": "#/definitions/SnowflakeDestinationProperties" + }, + "Upsolver": { + "$ref": "#/definitions/UpsolverDestinationProperties" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskDestinationProperties" + } + }, + "type": "object" + }, + "DestinationFlowConfig": { + "additionalProperties": false, + "description": "Configurations of destination connector.", + "properties": { + "ApiVersion": { + "$ref": "#/definitions/ApiVersion", + "description": "The API version that the destination connector uses." + }, + "ConnectorProfileName": { + "$ref": "#/definitions/ConnectorProfileName", + "description": "Name of destination connector profile" + }, + "ConnectorType": { + "$ref": "#/definitions/ConnectorType", + "description": "Destination connector type" + }, + "DestinationConnectorProperties": { + "$ref": "#/definitions/DestinationConnectorProperties", + "description": "Destination connector details" + } + }, + "required": [ + "ConnectorType", + "DestinationConnectorProperties" + ], + "type": "object" + }, + "DocumentType": { + "maxLength": 512, + "pattern": "[\\s\\w_-]+", + "type": "string" + }, + "DynatraceConnectorOperator": { + "enum": [ + "PROJECTION", + "BETWEEN", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "DynatraceSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "EnableDynamicFieldUpdate": { + "type": "boolean" + }, + "EntityName": { + "maxLength": 1024, + "pattern": "\\S+", + "type": "string" + }, + "ErrorHandlingConfig": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "FailOnFirstError": { + "type": "boolean" + } + }, + "type": "object" + }, + "EventBridgeDestinationProperties": { + "additionalProperties": false, + "properties": { + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "FileType": { + "enum": [ + "CSV", + "JSON", + "PARQUET" + ], + "type": "string" + }, + "GlueDataCatalog": { + "additionalProperties": false, + "description": "Trigger settings of the flow.", + "properties": { + "DatabaseName": { + "description": "A string containing the value for the tag", + "maxLength": 255, + "minLength": 0, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*", + "type": "string" + }, + "RoleArn": { + "description": "A string containing the value for the tag", + "maxLength": 512, + "minLength": 0, + "pattern": "arn:aws:iam:.*:[0-9]+:.*", + "type": "string" + }, + "TablePrefix": { + "description": "A string containing the value for the tag", + "maxLength": 128, + "minLength": 0, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*", + "type": "string" + } + }, + "required": [ + "RoleArn", + "DatabaseName", + "TablePrefix" + ], + "type": "object" + }, + "GoogleAnalyticsConnectorOperator": { + "enum": [ + "PROJECTION", + "BETWEEN" + ], + "type": "string" + }, + "GoogleAnalyticsSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "IncludeAllVersions": { + "type": "boolean" + }, + "IncludeDeletedRecords": { + "type": "boolean" + }, + "IncludeRenditions": { + "type": "boolean" + }, + "IncludeSourceFiles": { + "type": "boolean" + }, + "IncrementalPullConfig": { + "description": "Configuration for scheduled incremental data pull", + "properties": { + "DatetimeTypeFieldName": { + "$ref": "#/definitions/DatetimeTypeFieldName" + } + }, + "type": "object" + }, + "InforNexusConnectorOperator": { + "enum": [ + "PROJECTION", + "BETWEEN", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "InforNexusSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "LookoutMetricsDestinationProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "type": "object" + }, + "MarketoConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "BETWEEN", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "MarketoDestinationProperties": { + "additionalProperties": false, + "properties": { + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "MarketoSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "MetadataCatalogConfig": { + "additionalProperties": false, + "description": "Configurations of metadata catalog of the flow.", + "properties": { + "GlueDataCatalog": { + "$ref": "#/definitions/GlueDataCatalog", + "description": "Configurations of glue data catalog of the flow." + } + }, + "type": "object" + }, + "Name": { + "maxLength": 128, + "pattern": "\\S+", + "type": "string" + }, + "Object": { + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "Operator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "CONTAINS", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "OperatorPropertiesKeys": { + "enum": [ + "VALUE", + "VALUES", + "DATA_TYPE", + "UPPER_BOUND", + "LOWER_BOUND", + "SOURCE_DATA_TYPE", + "DESTINATION_DATA_TYPE", + "VALIDATION_ACTION", + "MASK_VALUE", + "MASK_LENGTH", + "TRUNCATE_LENGTH", + "MATH_OPERATION_FIELDS_ORDER", + "CONCAT_FORMAT", + "SUBFIELD_CATEGORY_MAP", + "EXCLUDE_SOURCE_FIELDS_LIST", + "INCLUDE_NEW_FIELDS", + "ORDERED_PARTITION_KEYS_LIST" + ], + "type": "string" + }, + "PardotConnectorOperator": { + "enum": [ + "PROJECTION", + "EQUAL_TO", + "NO_OP", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC" + ], + "type": "string" + }, + "PardotSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "PathPrefix": { + "enum": [ + "EXECUTION_ID", + "SCHEMA_VERSION" + ], + "type": "string" + }, + "PathPrefixHierarchy": { + "items": { + "$ref": "#/definitions/PathPrefix" + }, + "type": "array" + }, + "PrefixConfig": { + "additionalProperties": false, + "properties": { + "PathPrefixHierarchy": { + "$ref": "#/definitions/PathPrefixHierarchy" + }, + "PrefixFormat": { + "$ref": "#/definitions/PrefixFormat" + }, + "PrefixType": { + "$ref": "#/definitions/PrefixType" + } + }, + "type": "object" + }, + "PrefixFormat": { + "enum": [ + "YEAR", + "MONTH", + "DAY", + "HOUR", + "MINUTE" + ], + "type": "string" + }, + "PrefixType": { + "enum": [ + "FILENAME", + "PATH", + "PATH_AND_FILENAME" + ], + "type": "string" + }, + "PreserveSourceDataTyping": { + "type": "boolean" + }, + "RedshiftDestinationProperties": { + "additionalProperties": false, + "properties": { + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IntermediateBucketName": { + "$ref": "#/definitions/BucketName" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object", + "IntermediateBucketName" + ], + "type": "object" + }, + "S3ConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "S3DestinationProperties": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "S3OutputFormatConfig": { + "$ref": "#/definitions/S3OutputFormatConfig" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "S3InputFormatConfig": { + "properties": { + "S3InputFileType": { + "enum": [ + "CSV", + "JSON" + ], + "type": "string" + } + }, + "type": "object" + }, + "S3OutputFormatConfig": { + "additionalProperties": false, + "properties": { + "AggregationConfig": { + "$ref": "#/definitions/AggregationConfig" + }, + "FileType": { + "$ref": "#/definitions/FileType" + }, + "PrefixConfig": { + "$ref": "#/definitions/PrefixConfig" + }, + "PreserveSourceDataTyping": { + "$ref": "#/definitions/PreserveSourceDataTyping" + } + }, + "type": "object" + }, + "S3SourceProperties": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "S3InputFormatConfig": { + "$ref": "#/definitions/S3InputFormatConfig" + } + }, + "required": [ + "BucketName", + "BucketPrefix" + ], + "type": "object" + }, + "SAPODataConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "CONTAINS", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "SAPODataDestinationProperties": { + "additionalProperties": false, + "properties": { + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IdFieldNames": { + "description": "List of fields used as ID when performing a write operation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ObjectPath": { + "$ref": "#/definitions/Object" + }, + "SuccessResponseHandlingConfig": { + "$ref": "#/definitions/SuccessResponseHandlingConfig" + }, + "WriteOperationType": { + "$ref": "#/definitions/WriteOperationType" + } + }, + "required": [ + "ObjectPath" + ], + "type": "object" + }, + "SAPODataMaxPageSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "SAPODataMaxParallelism": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "SAPODataPaginationConfig": { + "additionalProperties": false, + "description": "SAP Source connector page size", + "properties": { + "maxPageSize": { + "$ref": "#/definitions/SAPODataMaxPageSize" + } + }, + "required": [ + "maxPageSize" + ], + "type": "object" + }, + "SAPODataParallelismConfig": { + "additionalProperties": false, + "description": "SAP Source connector parallelism factor", + "properties": { + "maxParallelism": { + "$ref": "#/definitions/SAPODataMaxParallelism" + } + }, + "required": [ + "maxParallelism" + ], + "type": "object" + }, + "SAPODataSourceProperties": { + "additionalProperties": false, + "properties": { + "ObjectPath": { + "$ref": "#/definitions/Object" + }, + "paginationConfig": { + "$ref": "#/definitions/SAPODataPaginationConfig" + }, + "parallelismConfig": { + "$ref": "#/definitions/SAPODataParallelismConfig" + } + }, + "required": [ + "ObjectPath" + ], + "type": "object" + }, + "SalesforceConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "CONTAINS", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "SalesforceDestinationProperties": { + "additionalProperties": false, + "properties": { + "DataTransferApi": { + "$ref": "#/definitions/DataTransferApi" + }, + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IdFieldNames": { + "description": "List of fields used as ID when performing a write operation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Object": { + "$ref": "#/definitions/Object" + }, + "WriteOperationType": { + "$ref": "#/definitions/WriteOperationType" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "SalesforceSourceProperties": { + "additionalProperties": false, + "properties": { + "DataTransferApi": { + "$ref": "#/definitions/DataTransferApi" + }, + "EnableDynamicFieldUpdate": { + "$ref": "#/definitions/EnableDynamicFieldUpdate" + }, + "IncludeDeletedRecords": { + "$ref": "#/definitions/IncludeDeletedRecords" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "ScheduledTriggerProperties": { + "additionalProperties": false, + "description": "Details required for scheduled trigger type", + "properties": { + "DataPullMode": { + "enum": [ + "Incremental", + "Complete" + ], + "type": "string" + }, + "FirstExecutionFrom": { + "type": "number" + }, + "FlowErrorDeactivationThreshold": { + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "ScheduleEndTime": { + "type": "number" + }, + "ScheduleExpression": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ScheduleOffset": { + "maximum": 36000, + "minimum": 0, + "type": "number" + }, + "ScheduleStartTime": { + "type": "number" + }, + "TimeZone": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "ScheduleExpression" + ], + "type": "object" + }, + "ServiceNowConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "CONTAINS", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "ServiceNowSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "SingularConnectorOperator": { + "enum": [ + "PROJECTION", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "SingularSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "SlackConnectorOperator": { + "enum": [ + "PROJECTION", + "BETWEEN", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "SlackSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "SnowflakeDestinationProperties": { + "additionalProperties": false, + "properties": { + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IntermediateBucketName": { + "$ref": "#/definitions/BucketName" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object", + "IntermediateBucketName" + ], + "type": "object" + }, + "SourceConnectorProperties": { + "description": "Source connector details required to query a connector", + "properties": { + "Amplitude": { + "$ref": "#/definitions/AmplitudeSourceProperties" + }, + "CustomConnector": { + "$ref": "#/definitions/CustomConnectorSourceProperties" + }, + "Datadog": { + "$ref": "#/definitions/DatadogSourceProperties" + }, + "Dynatrace": { + "$ref": "#/definitions/DynatraceSourceProperties" + }, + "GoogleAnalytics": { + "$ref": "#/definitions/GoogleAnalyticsSourceProperties" + }, + "InforNexus": { + "$ref": "#/definitions/InforNexusSourceProperties" + }, + "Marketo": { + "$ref": "#/definitions/MarketoSourceProperties" + }, + "Pardot": { + "$ref": "#/definitions/PardotSourceProperties" + }, + "S3": { + "$ref": "#/definitions/S3SourceProperties" + }, + "SAPOData": { + "$ref": "#/definitions/SAPODataSourceProperties" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceSourceProperties" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowSourceProperties" + }, + "Singular": { + "$ref": "#/definitions/SingularSourceProperties" + }, + "Slack": { + "$ref": "#/definitions/SlackSourceProperties" + }, + "Trendmicro": { + "$ref": "#/definitions/TrendmicroSourceProperties" + }, + "Veeva": { + "$ref": "#/definitions/VeevaSourceProperties" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskSourceProperties" + } + }, + "type": "object" + }, + "SourceFlowConfig": { + "additionalProperties": false, + "description": "Configurations of Source connector of the flow.", + "properties": { + "ApiVersion": { + "$ref": "#/definitions/ApiVersion", + "description": "The API version that the destination connector uses." + }, + "ConnectorProfileName": { + "$ref": "#/definitions/ConnectorProfileName", + "description": "Name of source connector profile" + }, + "ConnectorType": { + "$ref": "#/definitions/ConnectorType", + "description": "Type of source connector" + }, + "IncrementalPullConfig": { + "$ref": "#/definitions/IncrementalPullConfig", + "description": "Configuration for scheduled incremental data pull" + }, + "SourceConnectorProperties": { + "$ref": "#/definitions/SourceConnectorProperties", + "description": "Source connector details required to query a connector" + } + }, + "required": [ + "ConnectorType", + "SourceConnectorProperties" + ], + "type": "object" + }, + "Status": { + "enum": [ + "Active", + "Draft", + "Errored", + "Suspended" + ], + "type": "string" + }, + "SuccessResponseHandlingConfig": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging AppFlow resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TargetFileSize": { + "type": "integer" + }, + "Task": { + "additionalProperties": false, + "properties": { + "ConnectorOperator": { + "$ref": "#/definitions/ConnectorOperator", + "description": "Operation to be performed on provided source fields" + }, + "DestinationField": { + "description": "A field value on which source field should be validated", + "maxLength": 256, + "type": "string" + }, + "SourceFields": { + "description": "Source fields on which particular task will be applied", + "items": { + "type": "string" + }, + "type": "array" + }, + "TaskProperties": { + "description": "A Map used to store task related info", + "items": { + "$ref": "#/definitions/TaskPropertiesObject" + }, + "type": "array" + }, + "TaskType": { + "$ref": "#/definitions/TaskType", + "description": "Type of task" + } + }, + "required": [ + "SourceFields", + "TaskType" + ], + "type": "object" + }, + "TaskPropertiesObject": { + "additionalProperties": false, + "description": "An object used to store task related info", + "properties": { + "Key": { + "$ref": "#/definitions/OperatorPropertiesKeys" + }, + "Value": { + "maxLength": 2048, + "pattern": ".+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TaskType": { + "enum": [ + "Arithmetic", + "Filter", + "Map", + "Map_all", + "Mask", + "Merge", + "Passthrough", + "Truncate", + "Validate", + "Partition" + ], + "type": "string" + }, + "TrendmicroConnectorOperator": { + "enum": [ + "PROJECTION", + "EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "TrendmicroSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "TriggerConfig": { + "additionalProperties": false, + "description": "Trigger settings of the flow.", + "properties": { + "TriggerProperties": { + "$ref": "#/definitions/ScheduledTriggerProperties", + "description": "Details required based on the type of trigger" + }, + "TriggerType": { + "$ref": "#/definitions/TriggerType", + "description": "Trigger type of the flow" + } + }, + "required": [ + "TriggerType" + ], + "type": "object" + }, + "TriggerType": { + "enum": [ + "Scheduled", + "Event", + "OnDemand" + ], + "type": "string" + }, + "UpsolverBucketName": { + "maxLength": 63, + "minLength": 16, + "pattern": "^(upsolver-appflow)\\S*", + "type": "string" + }, + "UpsolverDestinationProperties": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/UpsolverBucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/BucketPrefix" + }, + "S3OutputFormatConfig": { + "$ref": "#/definitions/UpsolverS3OutputFormatConfig" + } + }, + "required": [ + "BucketName", + "S3OutputFormatConfig" + ], + "type": "object" + }, + "UpsolverS3OutputFormatConfig": { + "additionalProperties": false, + "properties": { + "AggregationConfig": { + "$ref": "#/definitions/AggregationConfig" + }, + "FileType": { + "$ref": "#/definitions/FileType" + }, + "PrefixConfig": { + "$ref": "#/definitions/PrefixConfig" + } + }, + "required": [ + "PrefixConfig" + ], + "type": "object" + }, + "VeevaConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "VeevaSourceProperties": { + "additionalProperties": false, + "properties": { + "DocumentType": { + "$ref": "#/definitions/DocumentType" + }, + "IncludeAllVersions": { + "$ref": "#/definitions/IncludeAllVersions" + }, + "IncludeRenditions": { + "$ref": "#/definitions/IncludeRenditions" + }, + "IncludeSourceFiles": { + "$ref": "#/definitions/IncludeSourceFiles" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "WriteOperationType": { + "enum": [ + "INSERT", + "UPSERT", + "UPDATE", + "DELETE" + ], + "type": "string" + }, + "ZendeskConnectorOperator": { + "enum": [ + "PROJECTION", + "GREATER_THAN", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "ZendeskDestinationProperties": { + "additionalProperties": false, + "properties": { + "ErrorHandlingConfig": { + "$ref": "#/definitions/ErrorHandlingConfig" + }, + "IdFieldNames": { + "description": "List of fields used as ID when performing a write operation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Object": { + "$ref": "#/definitions/Object" + }, + "WriteOperationType": { + "$ref": "#/definitions/WriteOperationType" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "ZendeskSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::AppFlow::Flow.", + "handlers": { + "create": { + "permissions": [ + "appflow:CreateFlow", + "appflow:StartFlow", + "appflow:TagResource", + "appflow:ListTagsForResource", + "appflow:UseConnectorProfile", + "iam:PassRole", + "s3:ListAllMyBuckets", + "s3:GetBucketLocation", + "s3:GetBucketPolicy", + "kms:ListGrants", + "kms:ListKeys", + "kms:DescribeKey", + "kms:ListAliases", + "kms:CreateGrant", + "secretsmanager:CreateSecret", + "secretsmanager:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "appflow:DeleteFlow" + ] + }, + "list": { + "permissions": [ + "appflow:ListFlows" + ] + }, + "read": { + "permissions": [ + "appflow:DescribeFlow", + "appflow:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "appflow:UpdateFlow", + "appflow:StartFlow", + "appflow:StopFlow", + "appflow:TagResource", + "appflow:UntagResource", + "appflow:ListTagsForResource", + "appflow:UseConnectorProfile", + "iam:PassRole", + "s3:ListAllMyBuckets", + "s3:GetBucketLocation", + "s3:GetBucketPolicy", + "kms:ListGrants", + "secretsmanager:CreateSecret", + "secretsmanager:PutResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/FlowName" + ], + "properties": { + "Description": { + "description": "Description of the flow.", + "maxLength": 2048, + "pattern": "[\\w!@#\\-.?,\\s]*", + "type": "string" + }, + "DestinationFlowConfigList": { + "description": "List of Destination connectors of the flow.", + "items": { + "$ref": "#/definitions/DestinationFlowConfig" + }, + "type": "array" + }, + "FlowArn": { + "description": "ARN identifier of the flow.", + "maxLength": 512, + "pattern": "arn:aws:appflow:.*:[0-9]+:.*", + "type": "string" + }, + "FlowName": { + "description": "Name of the flow.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9][\\w!@#.-]+", + "type": "string" + }, + "FlowStatus": { + "description": "Flow activation status for Scheduled- and Event-triggered flows", + "enum": [ + "Active", + "Suspended", + "Draft" + ], + "type": "string" + }, + "KMSArn": { + "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws:kms:.*:[0-9]+:.*", + "type": "string" + }, + "MetadataCatalogConfig": { + "$ref": "#/definitions/MetadataCatalogConfig", + "description": "Configurations of metadata catalog of the flow." + }, + "SourceFlowConfig": { + "$ref": "#/definitions/SourceFlowConfig", + "description": "Configurations of Source connector of the flow." + }, + "Tags": { + "description": "List of Tags.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Tasks": { + "description": "List of tasks for the flow.", + "items": { + "$ref": "#/definitions/Task" + }, + "type": "array" + }, + "TriggerConfig": { + "$ref": "#/definitions/TriggerConfig", + "description": "Trigger settings of the flow." + } + }, + "readOnlyProperties": [ + "/properties/FlowArn" + ], + "required": [ + "FlowName", + "Tasks", + "SourceFlowConfig", + "DestinationFlowConfigList", + "TriggerConfig" + ], + "sourceUrl": "https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppFlow::Flow" +} diff --git a/schema/aws-appintegrations-application.json b/schema/aws-appintegrations-application.json index add288a..49d8781 100644 --- a/schema/aws-appintegrations-application.json +++ b/schema/aws-appintegrations-application.json @@ -1,187 +1,188 @@ -{ - "additionalProperties": false, - "definitions": { - "ApprovedOrigins": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^\\w+\\:\\/\\/.*$", - "type": "string" - }, - "ExternalUrlConfig": { - "additionalProperties": false, - "properties": { - "AccessUrl": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^\\w+\\:\\/\\/.*$", - "type": "string" - }, - "ApprovedOrigins": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ApprovedOrigins" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "AccessUrl" - ], - "type": "object" - }, - "Permissions": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\/\\._\\-\\*]+$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Application resources", - "properties": { - "Key": { - "description": "A key to identify the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "Corresponding tag value for the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS:AppIntegrations::Application", - "handlers": { - "create": { - "permissions": [ - "app-integrations:CreateApplication", - "app-integrations:TagResource" - ] - }, - "delete": { - "permissions": [ - "app-integrations:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "app-integrations:ListApplications", - "app-integrations:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "app-integrations:GetApplication" - ] - }, - "update": { - "permissions": [ - "app-integrations:GetApplication", - "app-integrations:UpdateApplication", - "app-integrations:TagResource", - "app-integrations:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn" - ], - "properties": { - "ApplicationArn": { - "description": "The Amazon Resource Name (ARN) of the application.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:app-integrations:[-a-z0-9]*:[0-9]{12}:application/[-a-zA-Z0-9]*", - "type": "string" - }, - "ApplicationSourceConfig": { - "additionalProperties": false, - "description": "Application source config", - "properties": { - "ExternalUrlConfig": { - "$ref": "#/definitions/ExternalUrlConfig" - } - }, - "required": [ - "ExternalUrlConfig" - ], - "type": "object" - }, - "Description": { - "description": "The application description.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "The id of the application.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "Name": { - "description": "The name of the application.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\/\\._ \\-]+$", - "type": "string" - }, - "Namespace": { - "description": "The namespace of the application.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "Permissions": { - "description": "The configuration of events or requests that the application has access to.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Permissions" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Tags": { - "description": "The tags (keys and values) associated with the application.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/Id" - ], - "required": [ - "Name", - "Description", - "ApplicationSourceConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppIntegrations::Application" -} +{ + "additionalProperties": false, + "definitions": { + "ApprovedOrigins": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^\\w+\\:\\/\\/.*$", + "type": "string" + }, + "ExternalUrlConfig": { + "additionalProperties": false, + "properties": { + "AccessUrl": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^\\w+\\:\\/\\/.*$", + "type": "string" + }, + "ApprovedOrigins": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ApprovedOrigins" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "AccessUrl" + ], + "type": "object" + }, + "Permissions": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\/\\._\\-\\*]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Application resources", + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS:AppIntegrations::Application", + "handlers": { + "create": { + "permissions": [ + "app-integrations:CreateApplication", + "app-integrations:TagResource" + ] + }, + "delete": { + "permissions": [ + "app-integrations:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "app-integrations:ListApplications", + "app-integrations:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "app-integrations:GetApplication" + ] + }, + "update": { + "permissions": [ + "app-integrations:GetApplication", + "app-integrations:UpdateApplication", + "app-integrations:TagResource", + "app-integrations:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "description": "The Amazon Resource Name (ARN) of the application.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:app-integrations:[-a-z0-9]*:[0-9]{12}:application/[-a-zA-Z0-9]*", + "type": "string" + }, + "ApplicationSourceConfig": { + "additionalProperties": false, + "description": "Application source config", + "properties": { + "ExternalUrlConfig": { + "$ref": "#/definitions/ExternalUrlConfig" + } + }, + "required": [ + "ExternalUrlConfig" + ], + "type": "object" + }, + "Description": { + "description": "The application description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The id of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "Name": { + "description": "The name of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\/\\._ \\-]+$", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "Permissions": { + "description": "The configuration of events or requests that the application has access to.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Permissions" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Tags": { + "description": "The tags (keys and values) associated with the application.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/Id" + ], + "required": [ + "Name", + "Namespace", + "Description", + "ApplicationSourceConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppIntegrations::Application" +} diff --git a/schema/aws-appintegrations-dataintegration.json b/schema/aws-appintegrations-dataintegration.json index 8e0bfd5..73b5d6d 100644 --- a/schema/aws-appintegrations-dataintegration.json +++ b/schema/aws-appintegrations-dataintegration.json @@ -1,282 +1,282 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKey", - "/properties/ScheduleConfig", - "/properties/SourceURI" - ], - "definitions": { - "FileConfiguration": { - "additionalProperties": false, - "description": "The configuration for what files should be pulled from the source.", - "properties": { - "Filters": { - "additionalProperties": false, - "description": "Restrictions for what files should be pulled from the source.", - "patternProperties": { - "^[A-Za-z]": { - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Folders": { - "description": "Identifiers for the source folders to pull all files from recursively.", - "items": { - "maxLength": 200, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Folders" - ], - "type": "object" - }, - "ObjectConfiguration": { - "additionalProperties": false, - "description": "The configuration for what data should be pulled from the source.", - "patternProperties": { - "^.+$": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z]": { - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ScheduleConfig": { - "additionalProperties": false, - "properties": { - "FirstExecutionFrom": { - "description": "The start date for objects to import in the first flow run. Epoch or ISO timestamp format is supported.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "Object": { - "description": "The name of the object to pull from the data source.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "ScheduleExpression": { - "description": "How often the data should be pulled from data source.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging DataIntegration resources", - "properties": { - "Key": { - "description": "A key to identify the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "Corresponding tag value for the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppIntegrations::DataIntegration", - "handlers": { - "create": { - "permissions": [ - "app-integrations:CreateDataIntegration", - "app-integrations:TagResource", - "appflow:DescribeConnectorProfiles", - "appflow:CreateFlow", - "appflow:DeleteFlow", - "appflow:DescribeConnectorEntity", - "appflow:UseConnectorProfile", - "appflow:TagResource", - "appflow:UntagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:ListGrants", - "kms:ListKeys", - "s3:GetBucketNotification", - "s3:PutBucketNotification", - "s3:GetEncryptionConfiguration" - ] - }, - "delete": { - "permissions": [ - "app-integrations:DeleteDataIntegration", - "app-integrations:UntagResource", - "appflow:CreateFlow", - "appflow:DeleteFlow", - "appflow:DescribeConnectorEntity", - "appflow:UseConnectorProfile", - "appflow:TagResource", - "appflow:UntagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:ListGrants", - "kms:ListKeys" - ] - }, - "list": { - "permissions": [ - "app-integrations:ListDataIntegrations" - ] - }, - "read": { - "permissions": [ - "app-integrations:GetDataIntegration", - "app-integrations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "app-integrations:GetDataIntegration", - "app-integrations:UpdateDataIntegration", - "app-integrations:TagResource", - "app-integrations:UntagResource", - "appflow:DescribeConnectorProfiles", - "appflow:DeleteFlow", - "appflow:DescribeConnectorEntity", - "appflow:UseConnectorProfile", - "appflow:TagResource", - "appflow:UntagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:ListGrants", - "kms:ListKeys" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DataIntegrationArn": { - "description": "The Amazon Resource Name (ARN) of the data integration.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "Description": { - "description": "The data integration description.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "FileConfiguration": { - "$ref": "#/definitions/FileConfiguration", - "description": "The configuration for what files should be pulled from the source." - }, - "Id": { - "description": "The unique identifer of the data integration.", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", - "type": "string" - }, - "KmsKey": { - "description": "The KMS key of the data integration.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "Name": { - "description": "The name of the data integration.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "ObjectConfiguration": { - "$ref": "#/definitions/ObjectConfiguration", - "description": "The configuration for what data should be pulled from the source." - }, - "ScheduleConfig": { - "$ref": "#/definitions/ScheduleConfig", - "description": "The name of the data and how often it should be pulled from the source." - }, - "SourceURI": { - "description": "The URI of the data source.", - "maxLength": 1000, - "minLength": 1, - "pattern": "^(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+$)|(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+[\\w/!@#+=.-]+[\\w/!@#+=.,-]+$)", - "type": "string" - }, - "Tags": { - "description": "The tags (keys and values) associated with the data integration.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/DataIntegrationArn" - ], - "required": [ - "Name", - "KmsKey", - "SourceURI" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppIntegrations::DataIntegration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKey", + "/properties/ScheduleConfig", + "/properties/SourceURI" + ], + "definitions": { + "FileConfiguration": { + "additionalProperties": false, + "description": "The configuration for what files should be pulled from the source.", + "properties": { + "Filters": { + "additionalProperties": false, + "description": "Restrictions for what files should be pulled from the source.", + "patternProperties": { + "^[A-Za-z]": { + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Folders": { + "description": "Identifiers for the source folders to pull all files from recursively.", + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Folders" + ], + "type": "object" + }, + "ObjectConfiguration": { + "additionalProperties": false, + "description": "The configuration for what data should be pulled from the source.", + "patternProperties": { + "^.+$": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z]": { + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ScheduleConfig": { + "additionalProperties": false, + "properties": { + "FirstExecutionFrom": { + "description": "The start date for objects to import in the first flow run. Epoch or ISO timestamp format is supported.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "Object": { + "description": "The name of the object to pull from the data source.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "ScheduleExpression": { + "description": "How often the data should be pulled from data source.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + } + }, + "required": [ + "ScheduleExpression" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging DataIntegration resources", + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppIntegrations::DataIntegration", + "handlers": { + "create": { + "permissions": [ + "app-integrations:CreateDataIntegration", + "app-integrations:TagResource", + "appflow:DescribeConnectorProfiles", + "appflow:CreateFlow", + "appflow:DeleteFlow", + "appflow:DescribeConnectorEntity", + "appflow:UseConnectorProfile", + "appflow:TagResource", + "appflow:UntagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:ListGrants", + "kms:ListKeys", + "s3:GetBucketNotification", + "s3:PutBucketNotification", + "s3:GetEncryptionConfiguration" + ] + }, + "delete": { + "permissions": [ + "app-integrations:DeleteDataIntegration", + "app-integrations:UntagResource", + "appflow:CreateFlow", + "appflow:DeleteFlow", + "appflow:DescribeConnectorEntity", + "appflow:UseConnectorProfile", + "appflow:TagResource", + "appflow:UntagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:ListGrants", + "kms:ListKeys" + ] + }, + "list": { + "permissions": [ + "app-integrations:ListDataIntegrations" + ] + }, + "read": { + "permissions": [ + "app-integrations:GetDataIntegration", + "app-integrations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "app-integrations:GetDataIntegration", + "app-integrations:UpdateDataIntegration", + "app-integrations:TagResource", + "app-integrations:UntagResource", + "appflow:DescribeConnectorProfiles", + "appflow:DeleteFlow", + "appflow:DescribeConnectorEntity", + "appflow:UseConnectorProfile", + "appflow:TagResource", + "appflow:UntagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:ListGrants", + "kms:ListKeys" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DataIntegrationArn": { + "description": "The Amazon Resource Name (ARN) of the data integration.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "Description": { + "description": "The data integration description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "FileConfiguration": { + "$ref": "#/definitions/FileConfiguration", + "description": "The configuration for what files should be pulled from the source." + }, + "Id": { + "description": "The unique identifer of the data integration.", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", + "type": "string" + }, + "KmsKey": { + "description": "The KMS key of the data integration.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "Name": { + "description": "The name of the data integration.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "ObjectConfiguration": { + "$ref": "#/definitions/ObjectConfiguration", + "description": "The configuration for what data should be pulled from the source." + }, + "ScheduleConfig": { + "$ref": "#/definitions/ScheduleConfig", + "description": "The name of the data and how often it should be pulled from the source." + }, + "SourceURI": { + "description": "The URI of the data source.", + "maxLength": 1000, + "minLength": 1, + "pattern": "^(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+$)|(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+[\\w/!@#+=.-]+[\\w/!@#+=.,-]+$)", + "type": "string" + }, + "Tags": { + "description": "The tags (keys and values) associated with the data integration.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/DataIntegrationArn" + ], + "required": [ + "Name", + "KmsKey", + "SourceURI" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppIntegrations::DataIntegration" +} diff --git a/schema/aws-appintegrations-eventintegration.json b/schema/aws-appintegrations-eventintegration.json index af31dad..bbfc5f2 100644 --- a/schema/aws-appintegrations-eventintegration.json +++ b/schema/aws-appintegrations-eventintegration.json @@ -1,168 +1,168 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/EventBridgeBus", - "/properties/EventFilter" - ], - "definitions": { - "EventFilter": { - "additionalProperties": false, - "properties": { - "Source": { - "description": "The source of the events.", - "maxLength": 256, - "minLength": 1, - "pattern": "^aws\\.partner\\/.*$", - "type": "string" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "Metadata": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A key to identify the metadata.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "Value": { - "description": "Corresponding metadata value for the key.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A key to identify the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "Corresponding tag value for the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppIntegrations::EventIntegration", - "handlers": { - "create": { - "permissions": [ - "app-integrations:CreateEventIntegration", - "app-integrations:TagResource" - ] - }, - "delete": { - "permissions": [ - "app-integrations:DeleteEventIntegration" - ] - }, - "list": { - "permissions": [ - "app-integrations:ListEventIntegrations" - ] - }, - "read": { - "permissions": [ - "app-integrations:GetEventIntegration", - "app-integrations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "app-integrations:GetEventIntegration", - "app-integrations:UpdateEventIntegration", - "app-integrations:TagResource", - "app-integrations:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Description": { - "description": "The event integration description.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "EventBridgeBus": { - "description": "The Amazon Eventbridge bus for the event integration.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "EventFilter": { - "$ref": "#/definitions/EventFilter", - "description": "The EventFilter (source) associated with the event integration." - }, - "EventIntegrationArn": { - "description": "The Amazon Resource Name (ARN) of the event integration.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "Name": { - "description": "The name of the event integration.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/\\._\\-]+$", - "type": "string" - }, - "Tags": { - "description": "The tags (keys and values) associated with the event integration.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/EventIntegrationArn" - ], - "required": [ - "Name", - "EventBridgeBus", - "EventFilter" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppIntegrations::EventIntegration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/EventBridgeBus", + "/properties/EventFilter" + ], + "definitions": { + "EventFilter": { + "additionalProperties": false, + "properties": { + "Source": { + "description": "The source of the events.", + "maxLength": 256, + "minLength": 1, + "pattern": "^aws\\.partner\\/.*$", + "type": "string" + } + }, + "required": [ + "Source" + ], + "type": "object" + }, + "Metadata": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A key to identify the metadata.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "Value": { + "description": "Corresponding metadata value for the key.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppIntegrations::EventIntegration", + "handlers": { + "create": { + "permissions": [ + "app-integrations:CreateEventIntegration", + "app-integrations:TagResource" + ] + }, + "delete": { + "permissions": [ + "app-integrations:DeleteEventIntegration" + ] + }, + "list": { + "permissions": [ + "app-integrations:ListEventIntegrations" + ] + }, + "read": { + "permissions": [ + "app-integrations:GetEventIntegration", + "app-integrations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "app-integrations:GetEventIntegration", + "app-integrations:UpdateEventIntegration", + "app-integrations:TagResource", + "app-integrations:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Description": { + "description": "The event integration description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "EventBridgeBus": { + "description": "The Amazon Eventbridge bus for the event integration.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "EventFilter": { + "$ref": "#/definitions/EventFilter", + "description": "The EventFilter (source) associated with the event integration." + }, + "EventIntegrationArn": { + "description": "The Amazon Resource Name (ARN) of the event integration.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "Name": { + "description": "The name of the event integration.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "Tags": { + "description": "The tags (keys and values) associated with the event integration.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/EventIntegrationArn" + ], + "required": [ + "Name", + "EventBridgeBus", + "EventFilter" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppIntegrations::EventIntegration" +} diff --git a/schema/aws-applicationautoscaling-scalabletarget.json b/schema/aws-applicationautoscaling-scalabletarget.json index d492174..29359ad 100644 --- a/schema/aws-applicationautoscaling-scalabletarget.json +++ b/schema/aws-applicationautoscaling-scalabletarget.json @@ -1,212 +1,212 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceId", - "/properties/ScalableDimension", - "/properties/ServiceNamespace" - ], - "definitions": { - "ScalableTargetAction": { - "additionalProperties": false, - "description": "``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.", - "properties": { - "MaxCapacity": { - "description": "The maximum capacity.", - "type": "integer" - }, - "MinCapacity": { - "description": "The minimum capacity.", - "type": "integer" - } - }, - "type": "object" - }, - "ScheduledAction": { - "additionalProperties": false, - "description": "``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. \n For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*.", - "properties": { - "EndTime": { - "description": "The date and time that the action is scheduled to end, in UTC.", - "type": "string" - }, - "ScalableTargetAction": { - "$ref": "#/definitions/ScalableTargetAction", - "description": "The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity." - }, - "Schedule": { - "description": "The schedule for this action. The following formats are supported:\n + At expressions - \"``at(yyyy-mm-ddThh:mm:ss)``\"\n + Rate expressions - \"``rate(value unit)``\"\n + Cron expressions - \"``cron(fields)``\"\n \n At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.\n At and cron expressions use Universal Coordinated Time (UTC) by default.\n The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].\n For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``.", - "type": "string" - }, - "ScheduledActionName": { - "description": "The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.", - "type": "string" - }, - "StartTime": { - "description": "The date and time that the action is scheduled to begin, in UTC.", - "type": "string" - }, - "Timezone": { - "description": "The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.", - "type": "string" - } - }, - "required": [ - "ScheduledActionName", - "Schedule" - ], - "type": "object" - }, - "SuspendedState": { - "additionalProperties": false, - "description": "``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.\n For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*.", - "properties": { - "DynamicScalingInSuspended": { - "description": "Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``.", - "type": "boolean" - }, - "DynamicScalingOutSuspended": { - "description": "Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``.", - "type": "boolean" - }, - "ScheduledScalingSuspended": { - "description": "Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``.", - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ApplicationAutoScaling::ScalableTarget`` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.\n For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.\n If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.", - "handlers": { - "create": { - "permissions": [ - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:DescribeScheduledActions", - "application-autoscaling:PutScheduledAction", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "cloudwatch:PutMetricAlarm", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:DeleteProvisionedConcurrencyConfig" - ] - }, - "delete": { - "permissions": [ - "application-autoscaling:DeregisterScalableTarget" - ] - }, - "list": { - "permissions": [ - "application-autoscaling:DescribeScalableTargets" - ] - }, - "read": { - "permissions": [ - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScheduledActions" - ] - }, - "update": { - "permissions": [ - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScheduledActions", - "application-autoscaling:DeleteScheduledAction", - "application-autoscaling:PutScheduledAction", - "cloudwatch:PutMetricAlarm", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:DeleteProvisionedConcurrencyConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceId", - "/properties/ScalableDimension", - "/properties/ServiceNamespace" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "MaxCapacity": { - "description": "The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.", - "type": "integer" - }, - "MinCapacity": { - "description": "The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.", - "type": "integer" - }, - "ResourceId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::MSK::Cluster" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/ServiceArn", - "typeName": "AWS::ECS::Service" - } - } - ], - "description": "The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.\n + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``.\n + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``.\n + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``.\n + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).\n + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``.\n + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``.\n + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``.\n + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``.\n + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``.\n + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``.\n + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.", - "type": "string" - }, - "RoleARN": { - "description": "Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.\n To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page.", - "type": "string" - }, - "ScalableDimension": { - "description": "The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The desired task count of an ECS service.\n + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group.\n + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet.\n + ``appstream:fleet:DesiredCapacity`` - The desired capacity of an AppStream 2.0 fleet.\n + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table.\n + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table.\n + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index.\n + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index.\n + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant.\n + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service.\n + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint.\n + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function.\n + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table.\n + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table.\n + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group.\n + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group.\n + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster.\n + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint.\n + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.", - "type": "string" - }, - "ScheduledActions": { - "description": "The scheduled actions for the scalable target. Duplicates aren't allowed.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ScheduledAction" - }, - "type": "array", - "uniqueItems": true - }, - "ServiceNamespace": { - "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``.", - "type": "string" - }, - "SuspendedState": { - "$ref": "#/definitions/SuspendedState", - "description": "An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. \n *Suspension Outcomes* \n + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.\n + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.\n + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended." - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResourceId", - "ServiceNamespace", - "ScalableDimension", - "MinCapacity", - "MaxCapacity" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApplicationAutoScaling::ScalableTarget", - "writeOnlyProperties": [ - "/properties/RoleARN" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceId", + "/properties/ScalableDimension", + "/properties/ServiceNamespace" + ], + "definitions": { + "ScalableTargetAction": { + "additionalProperties": false, + "description": "``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.", + "properties": { + "MaxCapacity": { + "description": "The maximum capacity.", + "type": "integer" + }, + "MinCapacity": { + "description": "The minimum capacity.", + "type": "integer" + } + }, + "type": "object" + }, + "ScheduledAction": { + "additionalProperties": false, + "description": "``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. \n For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*.", + "properties": { + "EndTime": { + "description": "The date and time that the action is scheduled to end, in UTC.", + "type": "string" + }, + "ScalableTargetAction": { + "$ref": "#/definitions/ScalableTargetAction", + "description": "The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity." + }, + "Schedule": { + "description": "The schedule for this action. The following formats are supported:\n + At expressions - \"``at(yyyy-mm-ddThh:mm:ss)``\"\n + Rate expressions - \"``rate(value unit)``\"\n + Cron expressions - \"``cron(fields)``\"\n \n At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.\n At and cron expressions use Universal Coordinated Time (UTC) by default.\n The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].\n For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``.", + "type": "string" + }, + "ScheduledActionName": { + "description": "The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.", + "type": "string" + }, + "StartTime": { + "description": "The date and time that the action is scheduled to begin, in UTC.", + "type": "string" + }, + "Timezone": { + "description": "The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.", + "type": "string" + } + }, + "required": [ + "ScheduledActionName", + "Schedule" + ], + "type": "object" + }, + "SuspendedState": { + "additionalProperties": false, + "description": "``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.\n For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*.", + "properties": { + "DynamicScalingInSuspended": { + "description": "Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``.", + "type": "boolean" + }, + "DynamicScalingOutSuspended": { + "description": "Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``.", + "type": "boolean" + }, + "ScheduledScalingSuspended": { + "description": "Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ApplicationAutoScaling::ScalableTarget`` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.\n For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.\n If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.", + "handlers": { + "create": { + "permissions": [ + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:DescribeScheduledActions", + "application-autoscaling:PutScheduledAction", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "cloudwatch:PutMetricAlarm", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "lambda:GetProvisionedConcurrencyConfig", + "lambda:PutProvisionedConcurrencyConfig", + "lambda:DeleteProvisionedConcurrencyConfig" + ] + }, + "delete": { + "permissions": [ + "application-autoscaling:DeregisterScalableTarget" + ] + }, + "list": { + "permissions": [ + "application-autoscaling:DescribeScalableTargets" + ] + }, + "read": { + "permissions": [ + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScheduledActions" + ] + }, + "update": { + "permissions": [ + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScheduledActions", + "application-autoscaling:DeleteScheduledAction", + "application-autoscaling:PutScheduledAction", + "cloudwatch:PutMetricAlarm", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "lambda:GetProvisionedConcurrencyConfig", + "lambda:PutProvisionedConcurrencyConfig", + "lambda:DeleteProvisionedConcurrencyConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceId", + "/properties/ScalableDimension", + "/properties/ServiceNamespace" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "MaxCapacity": { + "description": "The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.", + "type": "integer" + }, + "MinCapacity": { + "description": "The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.", + "type": "integer" + }, + "ResourceId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::MSK::Cluster" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/ServiceArn", + "typeName": "AWS::ECS::Service" + } + } + ], + "description": "The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.\n + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``.\n + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``.\n + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``.\n + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).\n + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``.\n + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``.\n + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``.\n + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``.\n + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``.\n + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``.\n + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.", + "type": "string" + }, + "RoleARN": { + "description": "Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.\n To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page.", + "type": "string" + }, + "ScalableDimension": { + "description": "The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The desired task count of an ECS service.\n + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group.\n + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet.\n + ``appstream:fleet:DesiredCapacity`` - The desired capacity of an AppStream 2.0 fleet.\n + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table.\n + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table.\n + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index.\n + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index.\n + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant.\n + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service.\n + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint.\n + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function.\n + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table.\n + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table.\n + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group.\n + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group.\n + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster.\n + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint.\n + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.", + "type": "string" + }, + "ScheduledActions": { + "description": "The scheduled actions for the scalable target. Duplicates aren't allowed.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ScheduledAction" + }, + "type": "array", + "uniqueItems": true + }, + "ServiceNamespace": { + "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``.", + "type": "string" + }, + "SuspendedState": { + "$ref": "#/definitions/SuspendedState", + "description": "An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. \n *Suspension Outcomes* \n + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.\n + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.\n + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended." + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceId", + "ServiceNamespace", + "ScalableDimension", + "MinCapacity", + "MaxCapacity" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApplicationAutoScaling::ScalableTarget", + "writeOnlyProperties": [ + "/properties/RoleARN" + ] +} diff --git a/schema/aws-applicationautoscaling-scalingpolicy.json b/schema/aws-applicationautoscaling-scalingpolicy.json index 68ceb40..85cf881 100644 --- a/schema/aws-applicationautoscaling-scalingpolicy.json +++ b/schema/aws-applicationautoscaling-scalingpolicy.json @@ -1,366 +1,366 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/ServiceNamespace", - "/properties/ResourceId", - "/properties/ScalableDimension", - "/properties/ScalingTargetId" - ], - "definitions": { - "CustomizedMetricSpecification": { - "additionalProperties": false, - "description": "Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling. \n For information about the available metrics for a service, see [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.\n To create your customized metric specification:\n + Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.\n + Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases. \n \n For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide*. This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). \n ``CustomizedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.", - "properties": { - "Dimensions": { - "description": "The dimensions of the metric. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "description": "The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).", - "type": "string" - }, - "Metrics": { - "description": "The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetTrackingMetricDataQuery" - }, - "type": "array", - "uniqueItems": false - }, - "Namespace": { - "description": "The namespace of the metric.", - "type": "string" - }, - "Statistic": { - "description": "The statistic of the metric.", - "type": "string" - }, - "Unit": { - "description": "The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.", - "type": "string" - } - }, - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "description": "``MetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.", - "properties": { - "Name": { - "description": "The name of the dimension.", - "type": "string" - }, - "Value": { - "description": "The value of the dimension.", - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "PredefinedMetricSpecification": { - "additionalProperties": false, - "description": "Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.\n ``PredefinedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.", - "properties": { - "PredefinedMetricType": { - "description": "The metric type. The ``ALBRequestCountPerTarget`` metric type applies only to Spot fleet requests and ECS services.", - "type": "string" - }, - "ResourceLabel": { - "description": "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ``ALBRequestCountPerTarget`` and there is a target group attached to the Spot Fleet or ECS service.\n You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n ``app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff``.\n Where:\n + app// is the final portion of the load balancer ARN\n + targetgroup// is the final portion of the target group ARN.\n \n To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.", - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "StepAdjustment": { - "additionalProperties": false, - "description": "``StepAdjustment`` specifies a step adjustment for the ``StepAdjustments`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type. \n For the following examples, suppose that you have an alarm with a breach threshold of 50: \n + To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. \n + To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. \n \n For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide*.\n You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the ``AWS::ApplicationAutoScaling::ScalingPolicy`` documentation.", - "properties": { - "MetricIntervalLowerBound": { - "description": "The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.\n You must specify at least one upper or lower bound.", - "type": "number" - }, - "MetricIntervalUpperBound": { - "description": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.\n You must specify at least one upper or lower bound.", - "type": "number" - }, - "ScalingAdjustment": { - "description": "The amount by which to scale. The adjustment is based on the value that you specified in the ``AdjustmentType`` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.", - "type": "integer" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "StepScalingPolicyConfiguration": { - "additionalProperties": false, - "description": "``StepScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling. \n For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.", - "properties": { - "AdjustmentType": { - "description": "Specifies whether the ``ScalingAdjustment`` value in the ``StepAdjustment`` property is an absolute number or a percentage of the current capacity.", - "type": "string" - }, - "Cooldown": { - "description": "The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide*.", - "type": "integer" - }, - "MetricAggregationType": { - "description": "The aggregation type for the CloudWatch metrics. Valid values are ``Minimum``, ``Maximum``, and ``Average``. If the aggregation type is null, the value is treated as ``Average``.", - "type": "string" - }, - "MinAdjustmentMagnitude": { - "description": "The minimum value to scale by when the adjustment type is ``PercentChangeInCapacity``. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a ``MinAdjustmentMagnitude`` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a ``MinAdjustmentMagnitude`` of 2, Application Auto Scaling scales out the service by 2 tasks.", - "type": "integer" - }, - "StepAdjustments": { - "description": "A set of adjustments that enable you to scale based on the size of the alarm breach.\n At least one step adjustment is required if you are adding a new step scaling policy configuration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StepAdjustment" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "TargetTrackingMetric": { - "additionalProperties": false, - "description": "Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.\n Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type.", - "properties": { - "Dimensions": { - "description": "The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetTrackingMetricDimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "description": "The name of the metric.", - "type": "string" - }, - "Namespace": { - "description": "The namespace of the metric. For more information, see the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "TargetTrackingMetricDataQuery": { - "additionalProperties": false, - "description": "The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.\n You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.\n For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*.\n ``TargetTrackingMetricDataQuery`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type.", - "properties": { - "Expression": { - "description": "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. \n Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.", - "type": "string" - }, - "Id": { - "description": "A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.", - "type": "string" - }, - "Label": { - "description": "A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.", - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/TargetTrackingMetricStat", - "description": "Information about the metric data to return.\n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both." - }, - "ReturnData": { - "description": "Indicates whether to return the timestamps and raw data values of this metric. \n If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification.\n If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``).", - "type": "boolean" - } - }, - "type": "object" - }, - "TargetTrackingMetricDimension": { - "additionalProperties": false, - "description": "``TargetTrackingMetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.", - "properties": { - "Name": { - "description": "The name of the dimension.", - "type": "string" - }, - "Value": { - "description": "The value of the dimension.", - "type": "string" - } - }, - "type": "object" - }, - "TargetTrackingMetricStat": { - "additionalProperties": false, - "description": "This structure defines the CloudWatch metric to return, along with the statistic and unit.\n ``TargetTrackingMetricStat`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.", - "properties": { - "Metric": { - "$ref": "#/definitions/TargetTrackingMetric", - "description": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)." - }, - "Stat": { - "description": "The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\n The most commonly used metric for scaling is ``Average``.", - "type": "string" - }, - "Unit": { - "description": "The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.", - "type": "string" - } - }, - "type": "object" - }, - "TargetTrackingScalingPolicyConfiguration": { - "additionalProperties": false, - "description": "``TargetTrackingScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. \n For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide*.", - "properties": { - "CustomizedMetricSpecification": { - "$ref": "#/definitions/CustomizedMetricSpecification", - "description": "A customized metric. You can specify either a predefined metric or a customized metric." - }, - "DisableScaleIn": { - "description": "Indicates whether scale in by the target tracking scaling policy is disabled. If the value is ``true``, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is ``false``.", - "type": "boolean" - }, - "PredefinedMetricSpecification": { - "$ref": "#/definitions/PredefinedMetricSpecification", - "description": "A predefined metric. You can specify either a predefined metric or a customized metric." - }, - "ScaleInCooldown": { - "description": "The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.", - "type": "integer" - }, - "ScaleOutCooldown": { - "description": "The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.", - "type": "integer" - }, - "TargetValue": { - "description": "The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.", - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - } - }, - "description": "The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target. \n For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.", - "handlers": { - "create": { - "permissions": [ - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:PutScalingPolicy" - ] - }, - "delete": { - "permissions": [ - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeleteScalingPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ServiceNamespace": { - "description": "The name of the service", - "type": "string" - } - }, - "required": [ - "ServiceNamespace" - ] - }, - "permissions": [ - "application-autoscaling:DescribeScalingPolicies" - ] - }, - "read": { - "permissions": [ - "application-autoscaling:DescribeScalingPolicies" - ] - }, - "update": { - "permissions": [ - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:PutScalingPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn", - "/properties/ScalableDimension" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "PolicyName": { - "description": "The name of the scaling policy.\n Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.", - "type": "string" - }, - "PolicyType": { - "description": "The scaling policy type.\n The following policy types are supported: \n ``TargetTrackingScaling``\u2014Not supported for Amazon EMR\n ``StepScaling``\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.", - "type": "string" - }, - "ResourceId": { - "description": "The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.\n + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``.\n + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``.\n + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``.\n + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).\n + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``.\n + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``.\n + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``.\n + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``.\n + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``.\n + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``.\n + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.\n + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``.", - "type": "string" - }, - "ScalableDimension": { - "description": "The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The task count of an ECS service.\n + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group.\n + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet.\n + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet.\n + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table.\n + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table.\n + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index.\n + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index.\n + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant.\n + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service.\n + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint.\n + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function.\n + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table.\n + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table.\n + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group.\n + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group.\n + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster.\n + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint.\n + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.\n + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.", - "type": "string" - }, - "ScalingTargetId": { - "description": "The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource.\n You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both.", - "type": "string" - }, - "ServiceNamespace": { - "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``.", - "type": "string" - }, - "StepScalingPolicyConfiguration": { - "$ref": "#/definitions/StepScalingPolicyConfiguration", - "description": "A step scaling policy." - }, - "TargetTrackingScalingPolicyConfiguration": { - "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration", - "description": "A target tracking scaling policy." - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "PolicyName", - "PolicyType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ApplicationAutoScaling::ScalingPolicy", - "writeOnlyProperties": [ - "/properties/TargetTrackingScalingPolicyConfiguration/PredefinedMetricSpecification/ResourceLabel", - "/properties/ScalingTargetId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/ServiceNamespace", + "/properties/ResourceId", + "/properties/ScalableDimension", + "/properties/ScalingTargetId" + ], + "definitions": { + "CustomizedMetricSpecification": { + "additionalProperties": false, + "description": "Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling. \n For information about the available metrics for a service, see [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.\n To create your customized metric specification:\n + Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.\n + Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases. \n \n For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide*. This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). \n ``CustomizedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.", + "properties": { + "Dimensions": { + "description": "The dimensions of the metric. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).", + "type": "string" + }, + "Metrics": { + "description": "The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetTrackingMetricDataQuery" + }, + "type": "array", + "uniqueItems": false + }, + "Namespace": { + "description": "The namespace of the metric.", + "type": "string" + }, + "Statistic": { + "description": "The statistic of the metric.", + "type": "string" + }, + "Unit": { + "description": "The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.", + "type": "string" + } + }, + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "description": "``MetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.", + "properties": { + "Name": { + "description": "The name of the dimension.", + "type": "string" + }, + "Value": { + "description": "The value of the dimension.", + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "PredefinedMetricSpecification": { + "additionalProperties": false, + "description": "Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.\n ``PredefinedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.", + "properties": { + "PredefinedMetricType": { + "description": "The metric type. The ``ALBRequestCountPerTarget`` metric type applies only to Spot fleet requests and ECS services.", + "type": "string" + }, + "ResourceLabel": { + "description": "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ``ALBRequestCountPerTarget`` and there is a target group attached to the Spot Fleet or ECS service.\n You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n ``app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff``.\n Where:\n + app// is the final portion of the load balancer ARN\n + targetgroup// is the final portion of the target group ARN.\n \n To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.", + "type": "string" + } + }, + "required": [ + "PredefinedMetricType" + ], + "type": "object" + }, + "StepAdjustment": { + "additionalProperties": false, + "description": "``StepAdjustment`` specifies a step adjustment for the ``StepAdjustments`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type. \n For the following examples, suppose that you have an alarm with a breach threshold of 50: \n + To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. \n + To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. \n \n For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide*.\n You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the ``AWS::ApplicationAutoScaling::ScalingPolicy`` documentation.", + "properties": { + "MetricIntervalLowerBound": { + "description": "The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.\n You must specify at least one upper or lower bound.", + "type": "number" + }, + "MetricIntervalUpperBound": { + "description": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.\n You must specify at least one upper or lower bound.", + "type": "number" + }, + "ScalingAdjustment": { + "description": "The amount by which to scale. The adjustment is based on the value that you specified in the ``AdjustmentType`` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.", + "type": "integer" + } + }, + "required": [ + "ScalingAdjustment" + ], + "type": "object" + }, + "StepScalingPolicyConfiguration": { + "additionalProperties": false, + "description": "``StepScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling. \n For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.", + "properties": { + "AdjustmentType": { + "description": "Specifies whether the ``ScalingAdjustment`` value in the ``StepAdjustment`` property is an absolute number or a percentage of the current capacity.", + "type": "string" + }, + "Cooldown": { + "description": "The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide*.", + "type": "integer" + }, + "MetricAggregationType": { + "description": "The aggregation type for the CloudWatch metrics. Valid values are ``Minimum``, ``Maximum``, and ``Average``. If the aggregation type is null, the value is treated as ``Average``.", + "type": "string" + }, + "MinAdjustmentMagnitude": { + "description": "The minimum value to scale by when the adjustment type is ``PercentChangeInCapacity``. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a ``MinAdjustmentMagnitude`` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a ``MinAdjustmentMagnitude`` of 2, Application Auto Scaling scales out the service by 2 tasks.", + "type": "integer" + }, + "StepAdjustments": { + "description": "A set of adjustments that enable you to scale based on the size of the alarm breach.\n At least one step adjustment is required if you are adding a new step scaling policy configuration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StepAdjustment" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TargetTrackingMetric": { + "additionalProperties": false, + "description": "Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.\n Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type.", + "properties": { + "Dimensions": { + "description": "The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetTrackingMetricDimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric.", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the metric. For more information, see the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "TargetTrackingMetricDataQuery": { + "additionalProperties": false, + "description": "The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.\n You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.\n For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*.\n ``TargetTrackingMetricDataQuery`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type.", + "properties": { + "Expression": { + "description": "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. \n Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.", + "type": "string" + }, + "Id": { + "description": "A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.", + "type": "string" + }, + "Label": { + "description": "A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.", + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/TargetTrackingMetricStat", + "description": "Information about the metric data to return.\n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both." + }, + "ReturnData": { + "description": "Indicates whether to return the timestamps and raw data values of this metric. \n If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification.\n If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``).", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetTrackingMetricDimension": { + "additionalProperties": false, + "description": "``TargetTrackingMetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.", + "properties": { + "Name": { + "description": "The name of the dimension.", + "type": "string" + }, + "Value": { + "description": "The value of the dimension.", + "type": "string" + } + }, + "type": "object" + }, + "TargetTrackingMetricStat": { + "additionalProperties": false, + "description": "This structure defines the CloudWatch metric to return, along with the statistic and unit.\n ``TargetTrackingMetricStat`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.", + "properties": { + "Metric": { + "$ref": "#/definitions/TargetTrackingMetric", + "description": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)." + }, + "Stat": { + "description": "The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\n The most commonly used metric for scaling is ``Average``.", + "type": "string" + }, + "Unit": { + "description": "The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.", + "type": "string" + } + }, + "type": "object" + }, + "TargetTrackingScalingPolicyConfiguration": { + "additionalProperties": false, + "description": "``TargetTrackingScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. \n For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide*.", + "properties": { + "CustomizedMetricSpecification": { + "$ref": "#/definitions/CustomizedMetricSpecification", + "description": "A customized metric. You can specify either a predefined metric or a customized metric." + }, + "DisableScaleIn": { + "description": "Indicates whether scale in by the target tracking scaling policy is disabled. If the value is ``true``, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is ``false``.", + "type": "boolean" + }, + "PredefinedMetricSpecification": { + "$ref": "#/definitions/PredefinedMetricSpecification", + "description": "A predefined metric. You can specify either a predefined metric or a customized metric." + }, + "ScaleInCooldown": { + "description": "The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.", + "type": "integer" + }, + "ScaleOutCooldown": { + "description": "The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*.", + "type": "integer" + }, + "TargetValue": { + "description": "The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.", + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + } + }, + "description": "The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target. \n For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.", + "handlers": { + "create": { + "permissions": [ + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:PutScalingPolicy" + ] + }, + "delete": { + "permissions": [ + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeleteScalingPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ServiceNamespace": { + "description": "The name of the service", + "type": "string" + } + }, + "required": [ + "ServiceNamespace" + ] + }, + "permissions": [ + "application-autoscaling:DescribeScalingPolicies" + ] + }, + "read": { + "permissions": [ + "application-autoscaling:DescribeScalingPolicies" + ] + }, + "update": { + "permissions": [ + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:PutScalingPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn", + "/properties/ScalableDimension" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "PolicyName": { + "description": "The name of the scaling policy.\n Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.", + "type": "string" + }, + "PolicyType": { + "description": "The scaling policy type.\n The following policy types are supported: \n ``TargetTrackingScaling``\u2014Not supported for Amazon EMR\n ``StepScaling``\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.", + "type": "string" + }, + "ResourceId": { + "description": "The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.\n + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``.\n + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``.\n + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``.\n + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).\n + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``.\n + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``.\n + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``.\n + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``.\n + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``.\n + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``.\n + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``.\n + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.\n + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``.", + "type": "string" + }, + "ScalableDimension": { + "description": "The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The task count of an ECS service.\n + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group.\n + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet.\n + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet.\n + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table.\n + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table.\n + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index.\n + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index.\n + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.\n + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant.\n + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service.\n + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint.\n + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.\n + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function.\n + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table.\n + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table.\n + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.\n + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group.\n + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group.\n + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster.\n + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint.\n + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.\n + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.", + "type": "string" + }, + "ScalingTargetId": { + "description": "The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource.\n You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both.", + "type": "string" + }, + "ServiceNamespace": { + "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``.", + "type": "string" + }, + "StepScalingPolicyConfiguration": { + "$ref": "#/definitions/StepScalingPolicyConfiguration", + "description": "A step scaling policy." + }, + "TargetTrackingScalingPolicyConfiguration": { + "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration", + "description": "A target tracking scaling policy." + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "PolicyName", + "PolicyType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ApplicationAutoScaling::ScalingPolicy", + "writeOnlyProperties": [ + "/properties/TargetTrackingScalingPolicyConfiguration/PredefinedMetricSpecification/ResourceLabel", + "/properties/ScalingTargetId" + ] +} diff --git a/schema/aws-applicationinsights-application.json b/schema/aws-applicationinsights-application.json index 8de4645..3311ec1 100644 --- a/schema/aws-applicationinsights-application.json +++ b/schema/aws-applicationinsights-application.json @@ -1,729 +1,805 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceGroupName", - "/properties/GroupingType" - ], - "definitions": { - "Alarm": { - "additionalProperties": false, - "description": "A CloudWatch alarm to be monitored for the component.", - "properties": { - "AlarmName": { - "description": "The name of the CloudWatch alarm to be monitored for the component.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Severity": { - "description": "Indicates the degree of outage when the alarm goes off.", - "enum": [ - "HIGH", - "MEDIUM", - "LOW" - ], - "type": "string" - } - }, - "required": [ - "AlarmName" - ], - "type": "object" - }, - "AlarmMetric": { - "additionalProperties": false, - "description": "A metric to be monitored for the component.", - "properties": { - "AlarmMetricName": { - "description": "The name of the metric to be monitored for the component.", - "type": "string" - } - }, - "required": [ - "AlarmMetricName" - ], - "type": "object" - }, - "ComponentConfiguration": { - "additionalProperties": false, - "description": "The configuration settings of the component.", - "properties": { - "ConfigurationDetails": { - "$ref": "#/definitions/ConfigurationDetails", - "description": "The configuration settings" - }, - "SubComponentTypeConfigurations": { - "description": "Sub component configurations of the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SubComponentTypeConfiguration" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "ComponentMonitoringSetting": { - "additionalProperties": false, - "description": "The monitoring setting of the component.", - "oneOf": [ - { - "required": [ - "ComponentName" - ] - }, - { - "required": [ - "ComponentARN" - ] - } - ], - "properties": { - "ComponentARN": { - "description": "The ARN of the compnonent.", - "maxLength": 300, - "minLength": 20, - "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", - "type": "string" - }, - "ComponentConfigurationMode": { - "description": "The component monitoring configuration mode.", - "enum": [ - "DEFAULT", - "DEFAULT_WITH_OVERWRITE", - "CUSTOM" - ], - "type": "string" - }, - "ComponentName": { - "description": "The name of the component.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\d\\w\\-_.+]*$", - "type": "string" - }, - "CustomComponentConfiguration": { - "$ref": "#/definitions/ComponentConfiguration", - "description": "The monitoring configuration of the component." - }, - "DefaultOverwriteComponentConfiguration": { - "$ref": "#/definitions/ComponentConfiguration", - "description": "The overwritten settings on default component monitoring configuration." - }, - "Tier": { - "description": "The tier of the application component.", - "pattern": "^[A-Z][[A-Z]_]*$", - "type": "string" - } - }, - "required": [ - "Tier", - "ComponentConfigurationMode" - ], - "type": "object" - }, - "ConfigurationDetails": { - "additionalProperties": false, - "description": "The configuration settings.", - "properties": { - "AlarmMetrics": { - "description": "A list of metrics to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AlarmMetric" - }, - "type": "array" - }, - "Alarms": { - "description": "A list of alarms to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Alarm" - }, - "type": "array" - }, - "HAClusterPrometheusExporter": { - "$ref": "#/definitions/HAClusterPrometheusExporter", - "description": "The HA cluster Prometheus Exporter settings." - }, - "HANAPrometheusExporter": { - "$ref": "#/definitions/HANAPrometheusExporter", - "description": "The HANA DB Prometheus Exporter settings." - }, - "JMXPrometheusExporter": { - "$ref": "#/definitions/JMXPrometheusExporter", - "description": "The JMX Prometheus Exporter settings." - }, - "Logs": { - "description": "A list of logs to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Log" - }, - "type": "array" - }, - "NetWeaverPrometheusExporter": { - "$ref": "#/definitions/NetWeaverPrometheusExporter", - "description": "The NetWeaver Prometheus Exporter settings." - }, - "Processes": { - "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Process" - }, - "type": "array" - }, - "SQLServerPrometheusExporter": { - "$ref": "#/definitions/SQLServerPrometheusExporter", - "description": "The SQL Prometheus Exporter settings." - }, - "WindowsEvents": { - "description": "A list of Windows Events to log.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WindowsEvent" - }, - "type": "array" - } - }, - "type": "object" - }, - "CustomComponent": { - "additionalProperties": false, - "description": "The custom grouped component.", - "properties": { - "ComponentName": { - "description": "The name of the component.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\d\\w\\-_.+]*$", - "type": "string" - }, - "ResourceList": { - "description": "The list of resource ARNs that belong to the component.", - "insertionOrder": true, - "items": { - "maxLength": 300, - "minLength": 20, - "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ComponentName", - "ResourceList" - ], - "type": "object" - }, - "EventLevel": { - "description": "The level of event to log.", - "enum": [ - "INFORMATION", - "WARNING", - "ERROR", - "CRITICAL", - "VERBOSE" - ], - "type": "string" - }, - "HAClusterPrometheusExporter": { - "additionalProperties": false, - "description": "The HA cluster Prometheus Exporter settings.", - "properties": { - "PrometheusPort": { - "description": "Prometheus exporter port.", - "type": "string" - } - }, - "type": "object" - }, - "HANAPrometheusExporter": { - "additionalProperties": false, - "description": "The HANA DB Prometheus Exporter settings.", - "properties": { - "AgreeToInstallHANADBClient": { - "description": "A flag which indicates agreeing to install SAP HANA DB client.", - "type": "boolean" - }, - "HANAPort": { - "description": "The HANA DB port.", - "type": "string" - }, - "HANASID": { - "description": "HANA DB SID.", - "type": "string" - }, - "HANASecretName": { - "description": "The secret name which manages the HANA DB credentials e.g. {\n \"username\": \"<>\",\n \"password\": \"<>\"\n}.", - "type": "string" - }, - "PrometheusPort": { - "description": "Prometheus exporter port.", - "type": "string" - } - }, - "required": [ - "HANASID", - "HANAPort", - "HANASecretName", - "AgreeToInstallHANADBClient" - ], - "type": "object" - }, - "JMXPrometheusExporter": { - "additionalProperties": false, - "description": "The JMX Prometheus Exporter settings.", - "properties": { - "HostPort": { - "description": "Java agent host port", - "type": "string" - }, - "JMXURL": { - "description": "JMX service URL.", - "type": "string" - }, - "PrometheusPort": { - "description": "Prometheus exporter port.", - "type": "string" - } - }, - "type": "object" - }, - "Log": { - "additionalProperties": false, - "description": "A log to be monitored for the component.", - "properties": { - "Encoding": { - "description": "The type of encoding of the logs to be monitored.", - "enum": [ - "utf-8", - "utf-16", - "ascii" - ], - "type": "string" - }, - "LogGroupName": { - "description": "The CloudWatch log group name to be associated to the monitored log.", - "maxLength": 512, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - }, - "LogPath": { - "description": "The path of the logs to be monitored.", - "maxLength": 260, - "minLength": 1, - "pattern": "^([a-zA-Z]:\\\\[\\\\\\S|*\\S]?.*|/[^\"']*)$", - "type": "string" - }, - "LogType": { - "description": "The log type decides the log patterns against which Application Insights analyzes the log.", - "pattern": "^[A-Z][[A-Z]_]*$", - "type": "string" - }, - "PatternSet": { - "description": "The name of the log pattern set.", - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9.-_]*", - "type": "string" - } - }, - "required": [ - "LogType" - ], - "type": "object" - }, - "LogPattern": { - "additionalProperties": false, - "description": "The log pattern.", - "properties": { - "Pattern": { - "description": "The log pattern.", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "PatternName": { - "description": "The name of the log pattern.", - "maxLength": 50, - "minLength": 1, - "pattern": "[a-zA-Z0-9.-_]*", - "type": "string" - }, - "Rank": { - "description": "Rank of the log pattern.", - "type": "integer" - } - }, - "required": [ - "PatternName", - "Pattern", - "Rank" - ], - "type": "object" - }, - "LogPatternSet": { - "additionalProperties": false, - "description": "The log pattern set.", - "properties": { - "LogPatterns": { - "description": "The log patterns of a set.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LogPattern" - }, - "minItems": 1, - "type": "array" - }, - "PatternSetName": { - "description": "The name of the log pattern set.", - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9.-_]*", - "type": "string" - } - }, - "required": [ - "PatternSetName", - "LogPatterns" - ], - "type": "object" - }, - "NetWeaverPrometheusExporter": { - "additionalProperties": false, - "description": "The NetWeaver Prometheus Exporter Settings.", - "properties": { - "InstanceNumbers": { - "description": "SAP instance numbers for ASCS, ERS, and App Servers.", - "items": { - "maxLength": 2, - "minLength": 1, - "pattern": "\\b([0-9]|[0-9][0-9])\\b", - "type": "string" - }, - "type": "array" - }, - "PrometheusPort": { - "description": "Prometheus exporter port.", - "type": "string" - }, - "SAPSID": { - "description": "SAP NetWeaver SID.", - "type": "string" - } - }, - "required": [ - "SAPSID", - "InstanceNumbers" - ], - "type": "object" - }, - "Process": { - "additionalProperties": false, - "description": "A process to be monitored for the component.", - "properties": { - "AlarmMetrics": { - "description": "A list of metrics to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AlarmMetric" - }, - "type": "array" - }, - "ProcessName": { - "description": "The name of the process to be monitored for the component.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_,-]+$", - "type": "string" - } - }, - "required": [ - "ProcessName", - "AlarmMetrics" - ], - "type": "object" - }, - "SQLServerPrometheusExporter": { - "additionalProperties": false, - "description": "The SQL prometheus exporter settings.", - "properties": { - "PrometheusPort": { - "description": "Prometheus exporter port.", - "type": "string" - }, - "SQLSecretName": { - "description": "Secret name which managers SQL exporter connection. e.g. {\"data_source_name\": \"sqlserver://:@localhost:1433\"}", - "type": "string" - } - }, - "required": [ - "PrometheusPort", - "SQLSecretName" - ], - "type": "object" - }, - "SubComponentConfigurationDetails": { - "additionalProperties": false, - "description": "The configuration settings of sub components.", - "properties": { - "AlarmMetrics": { - "description": "A list of metrics to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AlarmMetric" - }, - "type": "array" - }, - "Logs": { - "description": "A list of logs to monitor for the component.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Log" - }, - "type": "array" - }, - "Processes": { - "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Process" - }, - "type": "array" - }, - "WindowsEvents": { - "description": "A list of Windows Events to log.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WindowsEvent" - }, - "type": "array" - } - }, - "type": "object" - }, - "SubComponentTypeConfiguration": { - "additionalProperties": false, - "description": "One type sub component configurations for the component.", - "properties": { - "SubComponentConfigurationDetails": { - "$ref": "#/definitions/SubComponentConfigurationDetails", - "description": "The configuration settings of sub components." - }, - "SubComponentType": { - "description": "The sub component type.", - "enum": [ - "AWS::EC2::Instance", - "AWS::EC2::Volume" - ], - "type": "string" - } - }, - "required": [ - "SubComponentType", - "SubComponentConfigurationDetails" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WindowsEvent": { - "additionalProperties": false, - "description": "A Windows Event to be monitored for the component.", - "properties": { - "EventLevels": { - "description": "The levels of event to log. ", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EventLevel" - }, - "minItems": 1, - "type": "array" - }, - "EventName": { - "description": "The type of Windows Events to log.", - "maxLength": 260, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_ \\\\/-]+$", - "type": "string" - }, - "LogGroupName": { - "description": "The CloudWatch log group name to be associated to the monitored log.", - "maxLength": 512, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - }, - "PatternSet": { - "description": "The name of the log pattern set.", - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9.-_]*", - "type": "string" - } - }, - "required": [ - "LogGroupName", - "EventName", - "EventLevels" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::ApplicationInsights::Application", - "handlers": { - "create": { - "permissions": [ - "*" - ], - "timeoutInMinutes": 600 - }, - "delete": { - "permissions": [ - "*" - ] - }, - "list": { - "permissions": [ - "*" - ] - }, - "read": { - "permissions": [ - "*" - ] - }, - "update": { - "permissions": [ - "*" - ], - "timeoutInMinutes": 600 - } - }, - "primaryIdentifier": [ - "/properties/ApplicationARN" - ], - "properties": { - "ApplicationARN": { - "description": "The ARN of the ApplicationInsights application.", - "type": "string" - }, - "AttachMissingPermission": { - "description": "If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing", - "type": "boolean" - }, - "AutoConfigurationEnabled": { - "description": "If set to true, application will be configured with recommended monitoring configuration.", - "type": "boolean" - }, - "CWEMonitorEnabled": { - "description": "Indicates whether Application Insights can listen to CloudWatch events for the application resources.", - "type": "boolean" - }, - "ComponentMonitoringSettings": { - "description": "The monitoring settings of the components.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ComponentMonitoringSetting" - }, - "minItems": 1, - "type": "array" - }, - "CustomComponents": { - "description": "The custom grouped components.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CustomComponent" - }, - "minItems": 1, - "type": "array" - }, - "GroupingType": { - "description": "The grouping type of the application", - "enum": [ - "ACCOUNT_BASED" - ], - "type": "string" - }, - "LogPatternSets": { - "description": "The log pattern sets.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LogPatternSet" - }, - "minItems": 1, - "type": "array" - }, - "OpsCenterEnabled": { - "description": "When set to true, creates opsItems for any problems detected on an application.", - "type": "boolean" - }, - "OpsItemSNSTopicArn": { - "description": "The SNS topic provided to Application Insights that is associated to the created opsItem.", - "maxLength": 300, - "minLength": 20, - "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", - "type": "string" - }, - "ResourceGroupName": { - "description": "The name of the resource group.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9.-_]*", - "type": "string" - }, - "Tags": { - "description": "The tags of Application Insights application.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationARN" - ], - "required": [ - "ResourceGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationinsights.git", - "taggable": true, - "typeName": "AWS::ApplicationInsights::Application", - "writeOnlyProperties": [ - "/properties/ComponentMonitoringSettings", - "/properties/LogPatternSets", - "/properties/CustomComponents", - "/properties/GroupingType", - "/properties/OpsItemSNSTopicArn", - "/properties/AttachMissingPermission" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceGroupName", + "/properties/GroupingType" + ], + "definitions": { + "Alarm": { + "additionalProperties": false, + "description": "A CloudWatch alarm to be monitored for the component.", + "properties": { + "AlarmName": { + "description": "The name of the CloudWatch alarm to be monitored for the component.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Severity": { + "description": "Indicates the degree of outage when the alarm goes off.", + "enum": [ + "HIGH", + "MEDIUM", + "LOW" + ], + "type": "string" + } + }, + "required": [ + "AlarmName" + ], + "type": "object" + }, + "AlarmMetric": { + "additionalProperties": false, + "description": "A metric to be monitored for the component.", + "properties": { + "AlarmMetricName": { + "description": "The name of the metric to be monitored for the component.", + "type": "string" + } + }, + "required": [ + "AlarmMetricName" + ], + "type": "object" + }, + "ComponentConfiguration": { + "additionalProperties": false, + "description": "The configuration settings of the component.", + "properties": { + "ConfigurationDetails": { + "$ref": "#/definitions/ConfigurationDetails", + "description": "The configuration settings" + }, + "SubComponentTypeConfigurations": { + "description": "Sub component configurations of the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SubComponentTypeConfiguration" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ComponentMonitoringSetting": { + "additionalProperties": false, + "description": "The monitoring setting of the component.", + "oneOf": [ + { + "required": [ + "ComponentName" + ] + }, + { + "required": [ + "ComponentARN" + ] + } + ], + "properties": { + "ComponentARN": { + "description": "The ARN of the compnonent.", + "maxLength": 300, + "minLength": 20, + "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", + "type": "string" + }, + "ComponentConfigurationMode": { + "description": "The component monitoring configuration mode.", + "enum": [ + "DEFAULT", + "DEFAULT_WITH_OVERWRITE", + "CUSTOM" + ], + "type": "string" + }, + "ComponentName": { + "description": "The name of the component.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\d\\w\\-_.+]*$", + "type": "string" + }, + "CustomComponentConfiguration": { + "$ref": "#/definitions/ComponentConfiguration", + "description": "The monitoring configuration of the component." + }, + "DefaultOverwriteComponentConfiguration": { + "$ref": "#/definitions/ComponentConfiguration", + "description": "The overwritten settings on default component monitoring configuration." + }, + "Tier": { + "description": "The tier of the application component.", + "pattern": "^[A-Z][[A-Z]_]*$", + "type": "string" + } + }, + "required": [ + "Tier", + "ComponentConfigurationMode" + ], + "type": "object" + }, + "ConfigurationDetails": { + "additionalProperties": false, + "description": "The configuration settings.", + "properties": { + "AlarmMetrics": { + "description": "A list of metrics to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AlarmMetric" + }, + "type": "array" + }, + "Alarms": { + "description": "A list of alarms to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Alarm" + }, + "type": "array" + }, + "HAClusterPrometheusExporter": { + "$ref": "#/definitions/HAClusterPrometheusExporter", + "description": "The HA cluster Prometheus Exporter settings." + }, + "HANAPrometheusExporter": { + "$ref": "#/definitions/HANAPrometheusExporter", + "description": "The HANA DB Prometheus Exporter settings." + }, + "JMXPrometheusExporter": { + "$ref": "#/definitions/JMXPrometheusExporter", + "description": "The JMX Prometheus Exporter settings." + }, + "Logs": { + "description": "A list of logs to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Log" + }, + "type": "array" + }, + "NetWeaverPrometheusExporter": { + "$ref": "#/definitions/NetWeaverPrometheusExporter", + "description": "The NetWeaver Prometheus Exporter settings." + }, + "Processes": { + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Process" + }, + "type": "array" + }, + "SQLServerPrometheusExporter": { + "$ref": "#/definitions/SQLServerPrometheusExporter", + "description": "The SQL Prometheus Exporter settings." + }, + "WindowsEvents": { + "description": "A list of Windows Events to log.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WindowsEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomComponent": { + "additionalProperties": false, + "description": "The custom grouped component.", + "properties": { + "ComponentName": { + "description": "The name of the component.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\d\\w\\-_.+]*$", + "type": "string" + }, + "ResourceList": { + "description": "The list of resource ARNs that belong to the component.", + "insertionOrder": true, + "items": { + "maxLength": 300, + "minLength": 20, + "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ComponentName", + "ResourceList" + ], + "type": "object" + }, + "EventLevel": { + "description": "The level of event to log.", + "enum": [ + "INFORMATION", + "WARNING", + "ERROR", + "CRITICAL", + "VERBOSE" + ], + "type": "string" + }, + "HAClusterPrometheusExporter": { + "additionalProperties": false, + "description": "The HA cluster Prometheus Exporter settings.", + "properties": { + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + } + }, + "type": "object" + }, + "HANAPrometheusExporter": { + "additionalProperties": false, + "description": "The HANA DB Prometheus Exporter settings.", + "properties": { + "AgreeToInstallHANADBClient": { + "description": "A flag which indicates agreeing to install SAP HANA DB client.", + "type": "boolean" + }, + "HANAPort": { + "description": "The HANA DB port.", + "type": "string" + }, + "HANASID": { + "description": "HANA DB SID.", + "type": "string" + }, + "HANASecretName": { + "description": "The secret name which manages the HANA DB credentials e.g. {\n \"username\": \"<>\",\n \"password\": \"<>\"\n}.", + "type": "string" + }, + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + } + }, + "required": [ + "HANASID", + "HANAPort", + "HANASecretName", + "AgreeToInstallHANADBClient" + ], + "type": "object" + }, + "JMXPrometheusExporter": { + "additionalProperties": false, + "description": "The JMX Prometheus Exporter settings.", + "properties": { + "HostPort": { + "description": "Java agent host port", + "type": "string" + }, + "JMXURL": { + "description": "JMX service URL.", + "type": "string" + }, + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + } + }, + "type": "object" + }, + "Log": { + "additionalProperties": false, + "description": "A log to be monitored for the component.", + "properties": { + "Encoding": { + "description": "The type of encoding of the logs to be monitored.", + "enum": [ + "utf-8", + "utf-16", + "ascii" + ], + "type": "string" + }, + "LogGroupName": { + "description": "The CloudWatch log group name to be associated to the monitored log.", + "maxLength": 512, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + }, + "LogPath": { + "description": "The path of the logs to be monitored.", + "maxLength": 260, + "minLength": 1, + "pattern": "^([a-zA-Z]:\\\\[\\\\\\S|*\\S]?.*|/[^\"']*)$", + "type": "string" + }, + "LogType": { + "description": "The log type decides the log patterns against which Application Insights analyzes the log.", + "pattern": "^[A-Z][[A-Z]_]*$", + "type": "string" + }, + "PatternSet": { + "description": "The name of the log pattern set.", + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9.-_]*", + "type": "string" + } + }, + "required": [ + "LogType" + ], + "type": "object" + }, + "LogPattern": { + "additionalProperties": false, + "description": "The log pattern.", + "properties": { + "Pattern": { + "description": "The log pattern.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "PatternName": { + "description": "The name of the log pattern.", + "maxLength": 50, + "minLength": 1, + "pattern": "[a-zA-Z0-9.-_]*", + "type": "string" + }, + "Rank": { + "description": "Rank of the log pattern.", + "type": "integer" + } + }, + "required": [ + "PatternName", + "Pattern", + "Rank" + ], + "type": "object" + }, + "LogPatternSet": { + "additionalProperties": false, + "description": "The log pattern set.", + "properties": { + "LogPatterns": { + "description": "The log patterns of a set.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LogPattern" + }, + "minItems": 1, + "type": "array" + }, + "PatternSetName": { + "description": "The name of the log pattern set.", + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9.-_]*", + "type": "string" + } + }, + "required": [ + "PatternSetName", + "LogPatterns" + ], + "type": "object" + }, + "NetWeaverPrometheusExporter": { + "additionalProperties": false, + "description": "The NetWeaver Prometheus Exporter Settings.", + "properties": { + "InstanceNumbers": { + "description": "SAP instance numbers for ASCS, ERS, and App Servers.", + "items": { + "maxLength": 2, + "minLength": 1, + "pattern": "\\b([0-9]|[0-9][0-9])\\b", + "type": "string" + }, + "type": "array" + }, + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + }, + "SAPSID": { + "description": "SAP NetWeaver SID.", + "type": "string" + } + }, + "required": [ + "SAPSID", + "InstanceNumbers" + ], + "type": "object" + }, + "Process": { + "additionalProperties": false, + "description": "A process to be monitored for the component.", + "properties": { + "AlarmMetrics": { + "description": "A list of metrics to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AlarmMetric" + }, + "type": "array" + }, + "ProcessName": { + "description": "The name of the process to be monitored for the component.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_,-]+$", + "type": "string" + } + }, + "required": [ + "ProcessName", + "AlarmMetrics" + ], + "type": "object" + }, + "SQLServerPrometheusExporter": { + "additionalProperties": false, + "description": "The SQL prometheus exporter settings.", + "properties": { + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + }, + "SQLSecretName": { + "description": "Secret name which managers SQL exporter connection. e.g. {\"data_source_name\": \"sqlserver://:@localhost:1433\"}", + "type": "string" + } + }, + "required": [ + "PrometheusPort", + "SQLSecretName" + ], + "type": "object" + }, + "SubComponentConfigurationDetails": { + "additionalProperties": false, + "description": "The configuration settings of sub components.", + "properties": { + "AlarmMetrics": { + "description": "A list of metrics to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AlarmMetric" + }, + "type": "array" + }, + "Logs": { + "description": "A list of logs to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Log" + }, + "type": "array" + }, + "Processes": { + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Process" + }, + "type": "array" + }, + "WindowsEvents": { + "description": "A list of Windows Events to log.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WindowsEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubComponentTypeConfiguration": { + "additionalProperties": false, + "description": "One type sub component configurations for the component.", + "properties": { + "SubComponentConfigurationDetails": { + "$ref": "#/definitions/SubComponentConfigurationDetails", + "description": "The configuration settings of sub components." + }, + "SubComponentType": { + "description": "The sub component type.", + "enum": [ + "AWS::EC2::Instance", + "AWS::EC2::Volume" + ], + "type": "string" + } + }, + "required": [ + "SubComponentType", + "SubComponentConfigurationDetails" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WindowsEvent": { + "additionalProperties": false, + "description": "A Windows Event to be monitored for the component.", + "properties": { + "EventLevels": { + "description": "The levels of event to log. ", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EventLevel" + }, + "minItems": 1, + "type": "array" + }, + "EventName": { + "description": "The type of Windows Events to log.", + "maxLength": 260, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_ \\\\/-]+$", + "type": "string" + }, + "LogGroupName": { + "description": "The CloudWatch log group name to be associated to the monitored log.", + "maxLength": 512, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + }, + "PatternSet": { + "description": "The name of the log pattern set.", + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9.-_]*", + "type": "string" + } + }, + "required": [ + "LogGroupName", + "EventName", + "EventLevels" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::ApplicationInsights::Application", + "handlers": { + "create": { + "permissions": [ + "applicationinsights:CreateApplication", + "applicationinsights:DescribeApplication", + "applicationinsights:CreateComponent", + "applicationinsights:DescribeComponent", + "applicationinsights:CreateLogPattern", + "applicationinsights:DescribeLogPattern", + "applicationinsights:DescribeComponentConfigurationRecommendation", + "applicationinsights:UpdateComponentConfiguration", + "applicationinsights:ListComponents", + "applicationinsights:TagResource", + "ec2:DescribeInstances", + "ec2:DescribeVolumes", + "rds:DescribeDBInstances", + "rds:DescribeDBClusters", + "sqs:ListQueues", + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:DescribeTargetHealth", + "autoscaling:DescribeAutoScalingGroups", + "lambda:ListFunctions", + "dynamodb:ListTables", + "s3:ListAllMyBuckets", + "sns:ListTopics", + "states:ListStateMachines", + "apigateway:GET", + "ecs:ListClusters", + "ecs:DescribeTaskDefinition", + "ecs:ListServices", + "ecs:ListTasks", + "eks:ListClusters", + "eks:ListNodegroups", + "fsx:DescribeFileSystems", + "logs:DescribeLogGroups", + "elasticfilesystem:DescribeFileSystems" + ], + "timeoutInMinutes": 600 + }, + "delete": { + "permissions": [ + "applicationinsights:DeleteApplication", + "applicationinsights:DescribeApplication" + ] + }, + "list": { + "permissions": [ + "applicationinsights:ListApplications", + "applicationinsights:DescribeApplication", + "applicationinsights:ListTagsForResource", + "applicationinsights:DescribeComponent", + "applicationinsights:ListComponents", + "applicationinsights:DescribeLogPattern", + "applicationinsights:ListLogPatterns", + "applicationinsights:ListLogPatternSets" + ] + }, + "read": { + "permissions": [ + "applicationinsights:DescribeApplication", + "applicationinsights:ListTagsForResource", + "applicationinsights:DescribeComponent", + "applicationinsights:ListComponents", + "applicationinsights:DescribeLogPattern", + "applicationinsights:ListLogPatterns", + "applicationinsights:ListLogPatternSets" + ] + }, + "update": { + "permissions": [ + "applicationinsights:CreateApplication", + "applicationinsights:DescribeApplication", + "applicationinsights:UpdateApplication", + "applicationinsights:TagResource", + "applicationinsights:UntagResource", + "applicationinsights:ListTagsForResource", + "applicationinsights:CreateComponent", + "applicationinsights:DescribeComponent", + "applicationinsights:DeleteComponent", + "applicationinsights:ListComponents", + "applicationinsights:CreateLogPattern", + "applicationinsights:DeleteLogPattern", + "applicationinsights:DescribeLogPattern", + "applicationinsights:ListLogPatterns", + "applicationinsights:ListLogPatternSets", + "applicationinsights:UpdateLogPattern", + "applicationinsights:DescribeComponentConfiguration", + "applicationinsights:DescribeComponentConfigurationRecommendation", + "applicationinsights:UpdateComponentConfiguration" + ], + "timeoutInMinutes": 600 + } + }, + "primaryIdentifier": [ + "/properties/ApplicationARN" + ], + "properties": { + "ApplicationARN": { + "description": "The ARN of the ApplicationInsights application.", + "type": "string" + }, + "AttachMissingPermission": { + "description": "If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing", + "type": "boolean" + }, + "AutoConfigurationEnabled": { + "description": "If set to true, application will be configured with recommended monitoring configuration.", + "type": "boolean" + }, + "CWEMonitorEnabled": { + "description": "Indicates whether Application Insights can listen to CloudWatch events for the application resources.", + "type": "boolean" + }, + "ComponentMonitoringSettings": { + "description": "The monitoring settings of the components.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ComponentMonitoringSetting" + }, + "minItems": 1, + "type": "array" + }, + "CustomComponents": { + "description": "The custom grouped components.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CustomComponent" + }, + "minItems": 1, + "type": "array" + }, + "GroupingType": { + "description": "The grouping type of the application", + "enum": [ + "ACCOUNT_BASED" + ], + "type": "string" + }, + "LogPatternSets": { + "description": "The log pattern sets.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LogPatternSet" + }, + "minItems": 1, + "type": "array" + }, + "OpsCenterEnabled": { + "description": "When set to true, creates opsItems for any problems detected on an application.", + "type": "boolean" + }, + "OpsItemSNSTopicArn": { + "description": "The SNS topic provided to Application Insights that is associated to the created opsItem.", + "maxLength": 300, + "minLength": 20, + "pattern": "^arn:aws(-[\\w]+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$", + "type": "string" + }, + "ResourceGroupName": { + "description": "The name of the resource group.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9.-_]*", + "type": "string" + }, + "Tags": { + "description": "The tags of Application Insights application.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationARN" + ], + "required": [ + "ResourceGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationinsights.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "applicationinsights:ListTagsForResource", + "applicationinsights:TagResource", + "applicationinsights:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApplicationInsights::Application", + "writeOnlyProperties": [ + "/properties/ComponentMonitoringSettings", + "/properties/LogPatternSets", + "/properties/CustomComponents", + "/properties/GroupingType", + "/properties/OpsItemSNSTopicArn", + "/properties/AttachMissingPermission" + ] +} diff --git a/schema/aws-applicationsignals-servicelevelobjective.json b/schema/aws-applicationsignals-servicelevelobjective.json index a7f44cf..fb854df 100644 --- a/schema/aws-applicationsignals-servicelevelobjective.json +++ b/schema/aws-applicationsignals-servicelevelobjective.json @@ -1,414 +1,503 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "CalendarInterval": { - "additionalProperties": false, - "description": "If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.", - "properties": { - "Duration": { - "$ref": "#/definitions/Duration" - }, - "DurationUnit": { - "$ref": "#/definitions/DurationUnit" - }, - "StartTime": { - "description": "Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nAs soon as one calendar interval ends, another automatically begins.", - "minimum": 946684800, - "type": "integer" - } - }, - "required": [ - "StartTime", - "DurationUnit", - "Duration" - ], - "type": "object" - }, - "Dimension": { - "additionalProperties": false, - "description": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric.", - "properties": { - "Name": { - "description": "The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.", - "type": "string" - }, - "Value": { - "description": "The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values", - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "Duration": { - "description": "Specifies the duration of each calendar interval. For example, if `Duration` is 1 and `DurationUnit` is `MONTH`, each interval is one month, aligned with the calendar.", - "minimum": 1, - "type": "integer" - }, - "DurationUnit": { - "description": "Specifies the calendar interval unit.", - "enum": [ - "DAY", - "MONTH" - ], - "type": "string" - }, - "Goal": { - "additionalProperties": false, - "description": "A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.", - "properties": { - "AttainmentGoal": { - "description": "The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.\nIf you omit this parameter, 99 is used to represent 99% as the attainment goal.", - "type": "number" - }, - "Interval": { - "$ref": "#/definitions/Interval" - }, - "WarningThreshold": { - "description": "The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.", - "type": "number" - } - }, - "type": "object" - }, - "Interval": { - "additionalProperties": false, - "description": "The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\nIf you omit this parameter, a rolling interval of 7 days is used.", - "properties": { - "CalendarInterval": { - "$ref": "#/definitions/CalendarInterval" - }, - "RollingInterval": { - "$ref": "#/definitions/RollingInterval" - } - }, - "type": "object" - }, - "KeyAttributes": { - "additionalProperties": false, - "description": "This is a string-to-string map that contains information about the type of object that this SLO is related to.", - "patternProperties": { - "^.+$": { - "type": "string" - } - } - }, - "Metric": { - "additionalProperties": false, - "description": "This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.", - "properties": { - "Dimensions": { - "description": "An array of one or more dimensions to use to define the metric that you want to use.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "description": "The name of the metric to use.", - "type": "string" - }, - "Namespace": { - "description": "The namespace of the metric.", - "type": "string" - } - }, - "type": "object" - }, - "MetricDataQueries": { - "description": "If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": false - }, - "MetricDataQuery": { - "additionalProperties": false, - "description": "Use this structure to define a metric or metric math expression that you want to use as for a service level objective.\nEach `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.", - "properties": { - "AccountId": { - "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", - "type": "string" - }, - "Expression": { - "description": "The math expression to be performed on the returned data.", - "type": "string" - }, - "Id": { - "description": "A short name used to tie this object to the results in the response.", - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/MetricStat", - "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both." - }, - "ReturnData": { - "description": "This option indicates whether to return the timestamps and raw data values of this metric.", - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "MetricStat": { - "additionalProperties": false, - "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.", - "properties": { - "Metric": { - "$ref": "#/definitions/Metric" - }, - "Period": { - "description": "The granularity, in seconds, to be used for the metric.", - "type": "integer" - }, - "Stat": { - "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.", - "type": "string" - }, - "Unit": { - "description": "If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.", - "type": "string" - } - }, - "required": [ - "Stat", - "Period", - "Metric" - ], - "type": "object" - }, - "RollingInterval": { - "additionalProperties": false, - "description": "If the interval is a calendar interval, this structure contains the interval specifications.", - "properties": { - "Duration": { - "$ref": "#/definitions/Duration" - }, - "DurationUnit": { - "$ref": "#/definitions/DurationUnit" - } - }, - "required": [ - "DurationUnit", - "Duration" - ], - "type": "object" - }, - "Sli": { - "additionalProperties": false, - "description": "This structure contains information about the performance metric that an SLO monitors.", - "properties": { - "ComparisonOperator": { - "description": "The arithmetic operation used when comparing the specified metric to the threshold.", - "enum": [ - "GreaterThanOrEqualTo", - "LessThanOrEqualTo", - "LessThan", - "GreaterThan" - ], - "type": "string" - }, - "MetricThreshold": { - "description": "The value that the SLI metric is compared to.", - "type": "number" - }, - "SliMetric": { - "$ref": "#/definitions/SliMetric" - } - }, - "required": [ - "SliMetric", - "MetricThreshold", - "ComparisonOperator" - ], - "type": "object" - }, - "SliMetric": { - "additionalProperties": false, - "description": "A structure that contains information about the metric that the SLO monitors.", - "properties": { - "KeyAttributes": { - "$ref": "#/definitions/KeyAttributes" - }, - "MetricDataQueries": { - "$ref": "#/definitions/MetricDataQueries" - }, - "MetricType": { - "description": "If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.", - "enum": [ - "LATENCY", - "AVAILABILITY" - ], - "type": "string" - }, - "OperationName": { - "description": "If the SLO monitors a specific operation of the service, this field displays that operation name.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "PeriodSeconds": { - "description": "The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.", - "maximum": 900, - "minimum": 60, - "type": "integer" - }, - "Statistic": { - "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic", - "maxLength": 20, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the specified tag key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "The list of tag keys and values associated with the resource you specified", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "description": "Resource Type definition for AWS::ApplicationSignals::ServiceLevelObjective", - "handlers": { - "create": { - "permissions": [ - "application-signals:CreateServiceLevelObjective", - "cloudwatch:GetMetricData", - "application-signals:TagResource", - "application-signals:GetServiceLevelObjective", - "application-signals:ListTagsForResource", - "iam:GetRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "application-signals:DeleteServiceLevelObjective", - "application-signals:UntagResource", - "application-signals:GetServiceLevelObjective" - ] - }, - "list": { - "permissions": [ - "application-signals:ListServiceLevelObjectives", - "application-signals:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "application-signals:GetServiceLevelObjective", - "application-signals:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "application-signals:UpdateServiceLevelObjective", - "cloudwatch:GetMetricData", - "application-signals:TagResource", - "application-signals:UntagResource", - "application-signals:GetServiceLevelObjective", - "application-signals:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of this SLO.", - "pattern": "^arn:[^:]*:application-signals:[^:]*:[^:]*:slo\\/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", - "type": "string" - }, - "CreatedTime": { - "description": "Epoch time in seconds of the time that this SLO was created", - "minimum": 946684800, - "type": "integer" - }, - "Description": { - "default": "No description", - "description": "An optional description for this SLO. Default is 'No description'", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Goal": { - "$ref": "#/definitions/Goal" - }, - "LastUpdatedTime": { - "description": "Epoch time in seconds of the time that this SLO was most recently updated", - "minimum": 946684800, - "type": "integer" - }, - "Name": { - "description": "The name of this SLO.", - "pattern": "^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", - "type": "string" - }, - "Sli": { - "$ref": "#/definitions/Sli" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "Name", - "Sli" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationsignals", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ApplicationSignals::ServiceLevelObjective" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "CalendarInterval": { + "additionalProperties": false, + "description": "If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.", + "properties": { + "Duration": { + "$ref": "#/definitions/Duration" + }, + "DurationUnit": { + "$ref": "#/definitions/DurationUnit" + }, + "StartTime": { + "description": "Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nAs soon as one calendar interval ends, another automatically begins.", + "minimum": 946684800, + "type": "integer" + } + }, + "required": [ + "StartTime", + "DurationUnit", + "Duration" + ], + "type": "object" + }, + "Dimension": { + "additionalProperties": false, + "description": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric.", + "properties": { + "Name": { + "description": "The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.", + "type": "string" + }, + "Value": { + "description": "The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values", + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "Duration": { + "description": "Specifies the duration of each calendar interval. For example, if `Duration` is 1 and `DurationUnit` is `MONTH`, each interval is one month, aligned with the calendar.", + "minimum": 1, + "type": "integer" + }, + "DurationUnit": { + "description": "Specifies the calendar interval unit.", + "enum": [ + "DAY", + "MONTH" + ], + "type": "string" + }, + "Goal": { + "additionalProperties": false, + "description": "A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.", + "properties": { + "AttainmentGoal": { + "description": "The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.\nIf you omit this parameter, 99 is used to represent 99% as the attainment goal.", + "type": "number" + }, + "Interval": { + "$ref": "#/definitions/Interval" + }, + "WarningThreshold": { + "description": "The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.", + "type": "number" + } + }, + "type": "object" + }, + "Interval": { + "additionalProperties": false, + "description": "The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\nIf you omit this parameter, a rolling interval of 7 days is used.", + "properties": { + "CalendarInterval": { + "$ref": "#/definitions/CalendarInterval" + }, + "RollingInterval": { + "$ref": "#/definitions/RollingInterval" + } + }, + "type": "object" + }, + "KeyAttributes": { + "additionalProperties": false, + "description": "This is a string-to-string map that contains information about the type of object that this SLO is related to.", + "patternProperties": { + "^.+$": { + "type": "string" + } + } + }, + "Metric": { + "additionalProperties": false, + "description": "This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.", + "properties": { + "Dimensions": { + "description": "An array of one or more dimensions to use to define the metric that you want to use.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric to use.", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the metric.", + "type": "string" + } + }, + "type": "object" + }, + "MetricDataQueries": { + "description": "If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": false + }, + "MetricDataQuery": { + "additionalProperties": false, + "description": "Use this structure to define a metric or metric math expression that you want to use as for a service level objective.\nEach `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.", + "properties": { + "AccountId": { + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", + "type": "string" + }, + "Expression": { + "description": "The math expression to be performed on the returned data.", + "type": "string" + }, + "Id": { + "description": "A short name used to tie this object to the results in the response.", + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/MetricStat", + "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both." + }, + "ReturnData": { + "description": "This option indicates whether to return the timestamps and raw data values of this metric.", + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "MetricStat": { + "additionalProperties": false, + "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.", + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Period": { + "description": "The granularity, in seconds, to be used for the metric.", + "type": "integer" + }, + "Stat": { + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.", + "type": "string" + }, + "Unit": { + "description": "If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.", + "type": "string" + } + }, + "required": [ + "Stat", + "Period", + "Metric" + ], + "type": "object" + }, + "MonitoredRequestCountMetric": { + "additionalProperties": false, + "description": "This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in `TotalRequestCountMetric` is divided by the number found for `MonitoredRequestCountMetric` to determine the percentage of successful requests that this SLO tracks.", + "properties": { + "BadCountMetric": { + "$ref": "#/definitions/MetricDataQueries", + "description": "If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure." + }, + "GoodCountMetric": { + "$ref": "#/definitions/MetricDataQueries", + "description": "If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure." + } + }, + "type": "object" + }, + "RequestBasedSli": { + "additionalProperties": false, + "description": "This structure contains information about the performance metric that a request-based SLO monitors.", + "properties": { + "ComparisonOperator": { + "description": "The arithmetic operation used when comparing the specified metric to the threshold.", + "enum": [ + "GreaterThanOrEqualTo", + "LessThanOrEqualTo", + "LessThan", + "GreaterThan" + ], + "type": "string" + }, + "MetricThreshold": { + "description": "The value that the SLI metric is compared to.", + "type": "number" + }, + "RequestBasedSliMetric": { + "$ref": "#/definitions/RequestBasedSliMetric" + } + }, + "required": [ + "RequestBasedSliMetric" + ], + "type": "object" + }, + "RequestBasedSliMetric": { + "additionalProperties": false, + "description": "This structure contains the information about the metric that is used for a request-based SLO.", + "properties": { + "KeyAttributes": { + "$ref": "#/definitions/KeyAttributes" + }, + "MetricType": { + "description": "If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.", + "enum": [ + "LATENCY", + "AVAILABILITY" + ], + "type": "string" + }, + "MonitoredRequestCountMetric": { + "$ref": "#/definitions/MonitoredRequestCountMetric" + }, + "OperationName": { + "description": "If the SLO monitors a specific operation of the service, this field displays that operation name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "TotalRequestCountMetric": { + "$ref": "#/definitions/MetricDataQueries", + "description": "This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is observed for the metric defined in `MonitoredRequestCountMetric`." + } + }, + "type": "object" + }, + "RollingInterval": { + "additionalProperties": false, + "description": "If the interval is a calendar interval, this structure contains the interval specifications.", + "properties": { + "Duration": { + "$ref": "#/definitions/Duration" + }, + "DurationUnit": { + "$ref": "#/definitions/DurationUnit" + } + }, + "required": [ + "DurationUnit", + "Duration" + ], + "type": "object" + }, + "Sli": { + "additionalProperties": false, + "description": "This structure contains information about the performance metric that an SLO monitors.", + "properties": { + "ComparisonOperator": { + "description": "The arithmetic operation used when comparing the specified metric to the threshold.", + "enum": [ + "GreaterThanOrEqualTo", + "LessThanOrEqualTo", + "LessThan", + "GreaterThan" + ], + "type": "string" + }, + "MetricThreshold": { + "description": "The value that the SLI metric is compared to.", + "type": "number" + }, + "SliMetric": { + "$ref": "#/definitions/SliMetric" + } + }, + "required": [ + "SliMetric", + "MetricThreshold", + "ComparisonOperator" + ], + "type": "object" + }, + "SliMetric": { + "additionalProperties": false, + "description": "A structure that contains information about the metric that the SLO monitors.", + "properties": { + "KeyAttributes": { + "$ref": "#/definitions/KeyAttributes" + }, + "MetricDataQueries": { + "$ref": "#/definitions/MetricDataQueries" + }, + "MetricType": { + "description": "If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.", + "enum": [ + "LATENCY", + "AVAILABILITY" + ], + "type": "string" + }, + "OperationName": { + "description": "If the SLO monitors a specific operation of the service, this field displays that operation name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PeriodSeconds": { + "description": "The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.", + "maximum": 900, + "minimum": 60, + "type": "integer" + }, + "Statistic": { + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic", + "maxLength": 20, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "The list of tag keys and values associated with the resource you specified", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "description": "Resource Type definition for AWS::ApplicationSignals::ServiceLevelObjective", + "handlers": { + "create": { + "permissions": [ + "application-signals:CreateServiceLevelObjective", + "cloudwatch:GetMetricData", + "application-signals:TagResource", + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource", + "iam:GetRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "application-signals:DeleteServiceLevelObjective", + "application-signals:UntagResource", + "application-signals:GetServiceLevelObjective" + ] + }, + "list": { + "permissions": [ + "application-signals:ListServiceLevelObjectives", + "application-signals:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "application-signals:UpdateServiceLevelObjective", + "cloudwatch:GetMetricData", + "application-signals:TagResource", + "application-signals:UntagResource", + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of this SLO.", + "pattern": "^arn:[^:]*:application-signals:[^:]*:[^:]*:slo\\/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", + "type": "string" + }, + "CreatedTime": { + "description": "Epoch time in seconds of the time that this SLO was created", + "minimum": 946684800, + "type": "integer" + }, + "Description": { + "default": "No description", + "description": "An optional description for this SLO. Default is 'No description'", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "EvaluationType": { + "description": "Displays whether this is a period-based SLO or a request-based SLO.", + "enum": [ + "PeriodBased", + "RequestBased" + ], + "type": "string" + }, + "Goal": { + "$ref": "#/definitions/Goal" + }, + "LastUpdatedTime": { + "description": "Epoch time in seconds of the time that this SLO was most recently updated", + "minimum": 946684800, + "type": "integer" + }, + "Name": { + "description": "The name of this SLO.", + "pattern": "^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", + "type": "string" + }, + "RequestBasedSli": { + "$ref": "#/definitions/RequestBasedSli" + }, + "Sli": { + "$ref": "#/definitions/Sli" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/EvaluationType" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationsignals", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "application-signals:ListTagsForResource", + "application-signals:TagResource", + "application-signals:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApplicationSignals::ServiceLevelObjective" +} diff --git a/schema/aws-appmesh-gatewayroute.json b/schema/aws-appmesh-gatewayroute.json index 0d69845..a3fe4e3 100644 --- a/schema/aws-appmesh-gatewayroute.json +++ b/schema/aws-appmesh-gatewayroute.json @@ -1,439 +1,439 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualGatewayName", - "/properties/MeshOwner", - "/properties/GatewayRouteName" - ], - "definitions": { - "GatewayRouteHostnameMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "GatewayRouteHostnameRewrite": { - "additionalProperties": false, - "properties": { - "DefaultTargetHostname": { - "type": "string" - } - }, - "type": "object" - }, - "GatewayRouteMetadataMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/GatewayRouteRangeMatch" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "GatewayRouteRangeMatch": { - "additionalProperties": false, - "properties": { - "End": { - "type": "integer" - }, - "Start": { - "type": "integer" - } - }, - "required": [ - "Start", - "End" - ], - "type": "object" - }, - "GatewayRouteSpec": { - "additionalProperties": false, - "properties": { - "GrpcRoute": { - "$ref": "#/definitions/GrpcGatewayRoute" - }, - "Http2Route": { - "$ref": "#/definitions/HttpGatewayRoute" - }, - "HttpRoute": { - "$ref": "#/definitions/HttpGatewayRoute" - }, - "Priority": { - "type": "integer" - } - }, - "type": "object" - }, - "GatewayRouteTarget": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - }, - "VirtualService": { - "$ref": "#/definitions/GatewayRouteVirtualService" - } - }, - "required": [ - "VirtualService" - ], - "type": "object" - }, - "GatewayRouteVirtualService": { - "additionalProperties": false, - "properties": { - "VirtualServiceName": { - "type": "string" - } - }, - "required": [ - "VirtualServiceName" - ], - "type": "object" - }, - "GrpcGatewayRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/GrpcGatewayRouteAction" - }, - "Match": { - "$ref": "#/definitions/GrpcGatewayRouteMatch" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "GrpcGatewayRouteAction": { - "additionalProperties": false, - "properties": { - "Rewrite": { - "$ref": "#/definitions/GrpcGatewayRouteRewrite" - }, - "Target": { - "$ref": "#/definitions/GatewayRouteTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "GrpcGatewayRouteMatch": { - "additionalProperties": false, - "properties": { - "Hostname": { - "$ref": "#/definitions/GatewayRouteHostnameMatch" - }, - "Metadata": { - "items": { - "$ref": "#/definitions/GrpcGatewayRouteMetadata" - }, - "type": "array", - "uniqueItems": false - }, - "Port": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "GrpcGatewayRouteMetadata": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/GatewayRouteMetadataMatch" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "GrpcGatewayRouteRewrite": { - "additionalProperties": false, - "properties": { - "Hostname": { - "$ref": "#/definitions/GatewayRouteHostnameRewrite" - } - }, - "type": "object" - }, - "HttpGatewayRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/HttpGatewayRouteAction" - }, - "Match": { - "$ref": "#/definitions/HttpGatewayRouteMatch" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "HttpGatewayRouteAction": { - "additionalProperties": false, - "properties": { - "Rewrite": { - "$ref": "#/definitions/HttpGatewayRouteRewrite" - }, - "Target": { - "$ref": "#/definitions/GatewayRouteTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "HttpGatewayRouteHeader": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/HttpGatewayRouteHeaderMatch" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "HttpGatewayRouteHeaderMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/GatewayRouteRangeMatch" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "HttpGatewayRouteMatch": { - "additionalProperties": false, - "properties": { - "Headers": { - "items": { - "$ref": "#/definitions/HttpGatewayRouteHeader" - }, - "type": "array", - "uniqueItems": false - }, - "Hostname": { - "$ref": "#/definitions/GatewayRouteHostnameMatch" - }, - "Method": { - "type": "string" - }, - "Path": { - "$ref": "#/definitions/HttpPathMatch" - }, - "Port": { - "type": "integer" - }, - "Prefix": { - "type": "string" - }, - "QueryParameters": { - "items": { - "$ref": "#/definitions/QueryParameter" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "HttpGatewayRoutePathRewrite": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - } - }, - "type": "object" - }, - "HttpGatewayRoutePrefixRewrite": { - "additionalProperties": false, - "properties": { - "DefaultPrefix": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "HttpGatewayRouteRewrite": { - "additionalProperties": false, - "properties": { - "Hostname": { - "$ref": "#/definitions/GatewayRouteHostnameRewrite" - }, - "Path": { - "$ref": "#/definitions/HttpGatewayRoutePathRewrite" - }, - "Prefix": { - "$ref": "#/definitions/HttpGatewayRoutePrefixRewrite" - } - }, - "type": "object" - }, - "HttpPathMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Regex": { - "type": "string" - } - }, - "type": "object" - }, - "HttpQueryParameterMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - } - }, - "type": "object" - }, - "QueryParameter": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/HttpQueryParameterMatch" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::GatewayRoute", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "GatewayRouteName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/GatewayRouteSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualGatewayName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "VirtualGatewayName", - "Spec" - ], - "typeName": "AWS::AppMesh::GatewayRoute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualGatewayName", + "/properties/MeshOwner", + "/properties/GatewayRouteName" + ], + "definitions": { + "GatewayRouteHostnameMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Suffix": { + "type": "string" + } + }, + "type": "object" + }, + "GatewayRouteHostnameRewrite": { + "additionalProperties": false, + "properties": { + "DefaultTargetHostname": { + "type": "string" + } + }, + "type": "object" + }, + "GatewayRouteMetadataMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Range": { + "$ref": "#/definitions/GatewayRouteRangeMatch" + }, + "Regex": { + "type": "string" + }, + "Suffix": { + "type": "string" + } + }, + "type": "object" + }, + "GatewayRouteRangeMatch": { + "additionalProperties": false, + "properties": { + "End": { + "type": "integer" + }, + "Start": { + "type": "integer" + } + }, + "required": [ + "Start", + "End" + ], + "type": "object" + }, + "GatewayRouteSpec": { + "additionalProperties": false, + "properties": { + "GrpcRoute": { + "$ref": "#/definitions/GrpcGatewayRoute" + }, + "Http2Route": { + "$ref": "#/definitions/HttpGatewayRoute" + }, + "HttpRoute": { + "$ref": "#/definitions/HttpGatewayRoute" + }, + "Priority": { + "type": "integer" + } + }, + "type": "object" + }, + "GatewayRouteTarget": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + }, + "VirtualService": { + "$ref": "#/definitions/GatewayRouteVirtualService" + } + }, + "required": [ + "VirtualService" + ], + "type": "object" + }, + "GatewayRouteVirtualService": { + "additionalProperties": false, + "properties": { + "VirtualServiceName": { + "type": "string" + } + }, + "required": [ + "VirtualServiceName" + ], + "type": "object" + }, + "GrpcGatewayRoute": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/GrpcGatewayRouteAction" + }, + "Match": { + "$ref": "#/definitions/GrpcGatewayRouteMatch" + } + }, + "required": [ + "Action", + "Match" + ], + "type": "object" + }, + "GrpcGatewayRouteAction": { + "additionalProperties": false, + "properties": { + "Rewrite": { + "$ref": "#/definitions/GrpcGatewayRouteRewrite" + }, + "Target": { + "$ref": "#/definitions/GatewayRouteTarget" + } + }, + "required": [ + "Target" + ], + "type": "object" + }, + "GrpcGatewayRouteMatch": { + "additionalProperties": false, + "properties": { + "Hostname": { + "$ref": "#/definitions/GatewayRouteHostnameMatch" + }, + "Metadata": { + "items": { + "$ref": "#/definitions/GrpcGatewayRouteMetadata" + }, + "type": "array", + "uniqueItems": false + }, + "Port": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + } + }, + "type": "object" + }, + "GrpcGatewayRouteMetadata": { + "additionalProperties": false, + "properties": { + "Invert": { + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/GatewayRouteMetadataMatch" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "GrpcGatewayRouteRewrite": { + "additionalProperties": false, + "properties": { + "Hostname": { + "$ref": "#/definitions/GatewayRouteHostnameRewrite" + } + }, + "type": "object" + }, + "HttpGatewayRoute": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/HttpGatewayRouteAction" + }, + "Match": { + "$ref": "#/definitions/HttpGatewayRouteMatch" + } + }, + "required": [ + "Action", + "Match" + ], + "type": "object" + }, + "HttpGatewayRouteAction": { + "additionalProperties": false, + "properties": { + "Rewrite": { + "$ref": "#/definitions/HttpGatewayRouteRewrite" + }, + "Target": { + "$ref": "#/definitions/GatewayRouteTarget" + } + }, + "required": [ + "Target" + ], + "type": "object" + }, + "HttpGatewayRouteHeader": { + "additionalProperties": false, + "properties": { + "Invert": { + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/HttpGatewayRouteHeaderMatch" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "HttpGatewayRouteHeaderMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Range": { + "$ref": "#/definitions/GatewayRouteRangeMatch" + }, + "Regex": { + "type": "string" + }, + "Suffix": { + "type": "string" + } + }, + "type": "object" + }, + "HttpGatewayRouteMatch": { + "additionalProperties": false, + "properties": { + "Headers": { + "items": { + "$ref": "#/definitions/HttpGatewayRouteHeader" + }, + "type": "array", + "uniqueItems": false + }, + "Hostname": { + "$ref": "#/definitions/GatewayRouteHostnameMatch" + }, + "Method": { + "type": "string" + }, + "Path": { + "$ref": "#/definitions/HttpPathMatch" + }, + "Port": { + "type": "integer" + }, + "Prefix": { + "type": "string" + }, + "QueryParameters": { + "items": { + "$ref": "#/definitions/QueryParameter" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "HttpGatewayRoutePathRewrite": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + } + }, + "type": "object" + }, + "HttpGatewayRoutePrefixRewrite": { + "additionalProperties": false, + "properties": { + "DefaultPrefix": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "HttpGatewayRouteRewrite": { + "additionalProperties": false, + "properties": { + "Hostname": { + "$ref": "#/definitions/GatewayRouteHostnameRewrite" + }, + "Path": { + "$ref": "#/definitions/HttpGatewayRoutePathRewrite" + }, + "Prefix": { + "$ref": "#/definitions/HttpGatewayRoutePrefixRewrite" + } + }, + "type": "object" + }, + "HttpPathMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Regex": { + "type": "string" + } + }, + "type": "object" + }, + "HttpQueryParameterMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + } + }, + "type": "object" + }, + "QueryParameter": { + "additionalProperties": false, + "properties": { + "Match": { + "$ref": "#/definitions/HttpQueryParameterMatch" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::GatewayRoute", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "GatewayRouteName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/GatewayRouteSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualGatewayName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "VirtualGatewayName", + "Spec" + ], + "typeName": "AWS::AppMesh::GatewayRoute" +} diff --git a/schema/aws-appmesh-mesh.json b/schema/aws-appmesh-mesh.json index ebe470e..a465b70 100644 --- a/schema/aws-appmesh-mesh.json +++ b/schema/aws-appmesh-mesh.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName" - ], - "definitions": { - "EgressFilter": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "MeshServiceDiscovery": { - "additionalProperties": false, - "properties": { - "IpPreference": { - "type": "string" - } - }, - "type": "object" - }, - "MeshSpec": { - "additionalProperties": false, - "properties": { - "EgressFilter": { - "$ref": "#/definitions/EgressFilter" - }, - "ServiceDiscovery": { - "$ref": "#/definitions/MeshServiceDiscovery" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::Mesh", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/MeshSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/MeshOwner", - "/properties/Arn", - "/properties/Uid" - ], - "typeName": "AWS::AppMesh::Mesh" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName" + ], + "definitions": { + "EgressFilter": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "MeshServiceDiscovery": { + "additionalProperties": false, + "properties": { + "IpPreference": { + "type": "string" + } + }, + "type": "object" + }, + "MeshSpec": { + "additionalProperties": false, + "properties": { + "EgressFilter": { + "$ref": "#/definitions/EgressFilter" + }, + "ServiceDiscovery": { + "$ref": "#/definitions/MeshServiceDiscovery" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::Mesh", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/MeshSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/MeshOwner", + "/properties/Arn", + "/properties/Uid" + ], + "typeName": "AWS::AppMesh::Mesh" +} diff --git a/schema/aws-appmesh-route.json b/schema/aws-appmesh-route.json index 62e45df..5a1cbd5 100644 --- a/schema/aws-appmesh-route.json +++ b/schema/aws-appmesh-route.json @@ -1,541 +1,541 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualRouterName", - "/properties/RouteName", - "/properties/MeshOwner" - ], - "definitions": { - "Duration": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Value", - "Unit" - ], - "type": "object" - }, - "GrpcRetryPolicy": { - "additionalProperties": false, - "properties": { - "GrpcRetryEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "HttpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxRetries": { - "type": "integer" - }, - "PerRetryTimeout": { - "$ref": "#/definitions/Duration" - }, - "TcpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "MaxRetries", - "PerRetryTimeout" - ], - "type": "object" - }, - "GrpcRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/GrpcRouteAction" - }, - "Match": { - "$ref": "#/definitions/GrpcRouteMatch" - }, - "RetryPolicy": { - "$ref": "#/definitions/GrpcRetryPolicy" - }, - "Timeout": { - "$ref": "#/definitions/GrpcTimeout" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "GrpcRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/WeightedTarget" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "GrpcRouteMatch": { - "additionalProperties": false, - "properties": { - "Metadata": { - "items": { - "$ref": "#/definitions/GrpcRouteMetadata" - }, - "type": "array", - "uniqueItems": false - }, - "MethodName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "GrpcRouteMetadata": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/GrpcRouteMetadataMatchMethod" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "GrpcRouteMetadataMatchMethod": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/MatchRange" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "GrpcTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - }, - "PerRequest": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "HeaderMatchMethod": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/MatchRange" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "HttpPathMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Regex": { - "type": "string" - } - }, - "type": "object" - }, - "HttpQueryParameterMatch": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - } - }, - "type": "object" - }, - "HttpRetryPolicy": { - "additionalProperties": false, - "properties": { - "HttpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxRetries": { - "type": "integer" - }, - "PerRetryTimeout": { - "$ref": "#/definitions/Duration" - }, - "TcpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "MaxRetries", - "PerRetryTimeout" - ], - "type": "object" - }, - "HttpRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/HttpRouteAction" - }, - "Match": { - "$ref": "#/definitions/HttpRouteMatch" - }, - "RetryPolicy": { - "$ref": "#/definitions/HttpRetryPolicy" - }, - "Timeout": { - "$ref": "#/definitions/HttpTimeout" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "HttpRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/WeightedTarget" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "HttpRouteHeader": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/HeaderMatchMethod" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "HttpRouteMatch": { - "additionalProperties": false, - "properties": { - "Headers": { - "items": { - "$ref": "#/definitions/HttpRouteHeader" - }, - "type": "array", - "uniqueItems": false - }, - "Method": { - "type": "string" - }, - "Path": { - "$ref": "#/definitions/HttpPathMatch" - }, - "Port": { - "type": "integer" - }, - "Prefix": { - "type": "string" - }, - "QueryParameters": { - "items": { - "$ref": "#/definitions/QueryParameter" - }, - "type": "array", - "uniqueItems": false - }, - "Scheme": { - "type": "string" - } - }, - "type": "object" - }, - "HttpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - }, - "PerRequest": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "MatchRange": { - "additionalProperties": false, - "properties": { - "End": { - "type": "integer" - }, - "Start": { - "type": "integer" - } - }, - "required": [ - "Start", - "End" - ], - "type": "object" - }, - "QueryParameter": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/HttpQueryParameterMatch" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "RouteSpec": { - "additionalProperties": false, - "properties": { - "GrpcRoute": { - "$ref": "#/definitions/GrpcRoute" - }, - "Http2Route": { - "$ref": "#/definitions/HttpRoute" - }, - "HttpRoute": { - "$ref": "#/definitions/HttpRoute" - }, - "Priority": { - "type": "integer" - }, - "TcpRoute": { - "$ref": "#/definitions/TcpRoute" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TcpRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/TcpRouteAction" - }, - "Match": { - "$ref": "#/definitions/TcpRouteMatch" - }, - "Timeout": { - "$ref": "#/definitions/TcpTimeout" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "TcpRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/WeightedTarget" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "TcpRouteMatch": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - } - }, - "type": "object" - }, - "TcpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "WeightedTarget": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - }, - "VirtualNode": { - "type": "string" - }, - "Weight": { - "type": "integer" - } - }, - "required": [ - "VirtualNode", - "Weight" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::Route", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "RouteName": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/RouteSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualRouterName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "VirtualRouterName", - "Spec" - ], - "typeName": "AWS::AppMesh::Route" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualRouterName", + "/properties/RouteName", + "/properties/MeshOwner" + ], + "definitions": { + "Duration": { + "additionalProperties": false, + "properties": { + "Unit": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Value", + "Unit" + ], + "type": "object" + }, + "GrpcRetryPolicy": { + "additionalProperties": false, + "properties": { + "GrpcRetryEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "HttpRetryEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxRetries": { + "type": "integer" + }, + "PerRetryTimeout": { + "$ref": "#/definitions/Duration" + }, + "TcpRetryEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "MaxRetries", + "PerRetryTimeout" + ], + "type": "object" + }, + "GrpcRoute": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/GrpcRouteAction" + }, + "Match": { + "$ref": "#/definitions/GrpcRouteMatch" + }, + "RetryPolicy": { + "$ref": "#/definitions/GrpcRetryPolicy" + }, + "Timeout": { + "$ref": "#/definitions/GrpcTimeout" + } + }, + "required": [ + "Action", + "Match" + ], + "type": "object" + }, + "GrpcRouteAction": { + "additionalProperties": false, + "properties": { + "WeightedTargets": { + "items": { + "$ref": "#/definitions/WeightedTarget" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "WeightedTargets" + ], + "type": "object" + }, + "GrpcRouteMatch": { + "additionalProperties": false, + "properties": { + "Metadata": { + "items": { + "$ref": "#/definitions/GrpcRouteMetadata" + }, + "type": "array", + "uniqueItems": false + }, + "MethodName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + } + }, + "type": "object" + }, + "GrpcRouteMetadata": { + "additionalProperties": false, + "properties": { + "Invert": { + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/GrpcRouteMetadataMatchMethod" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "GrpcRouteMetadataMatchMethod": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Range": { + "$ref": "#/definitions/MatchRange" + }, + "Regex": { + "type": "string" + }, + "Suffix": { + "type": "string" + } + }, + "type": "object" + }, + "GrpcTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + }, + "PerRequest": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "HeaderMatchMethod": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Range": { + "$ref": "#/definitions/MatchRange" + }, + "Regex": { + "type": "string" + }, + "Suffix": { + "type": "string" + } + }, + "type": "object" + }, + "HttpPathMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + }, + "Regex": { + "type": "string" + } + }, + "type": "object" + }, + "HttpQueryParameterMatch": { + "additionalProperties": false, + "properties": { + "Exact": { + "type": "string" + } + }, + "type": "object" + }, + "HttpRetryPolicy": { + "additionalProperties": false, + "properties": { + "HttpRetryEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxRetries": { + "type": "integer" + }, + "PerRetryTimeout": { + "$ref": "#/definitions/Duration" + }, + "TcpRetryEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "MaxRetries", + "PerRetryTimeout" + ], + "type": "object" + }, + "HttpRoute": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/HttpRouteAction" + }, + "Match": { + "$ref": "#/definitions/HttpRouteMatch" + }, + "RetryPolicy": { + "$ref": "#/definitions/HttpRetryPolicy" + }, + "Timeout": { + "$ref": "#/definitions/HttpTimeout" + } + }, + "required": [ + "Action", + "Match" + ], + "type": "object" + }, + "HttpRouteAction": { + "additionalProperties": false, + "properties": { + "WeightedTargets": { + "items": { + "$ref": "#/definitions/WeightedTarget" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "WeightedTargets" + ], + "type": "object" + }, + "HttpRouteHeader": { + "additionalProperties": false, + "properties": { + "Invert": { + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/HeaderMatchMethod" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "HttpRouteMatch": { + "additionalProperties": false, + "properties": { + "Headers": { + "items": { + "$ref": "#/definitions/HttpRouteHeader" + }, + "type": "array", + "uniqueItems": false + }, + "Method": { + "type": "string" + }, + "Path": { + "$ref": "#/definitions/HttpPathMatch" + }, + "Port": { + "type": "integer" + }, + "Prefix": { + "type": "string" + }, + "QueryParameters": { + "items": { + "$ref": "#/definitions/QueryParameter" + }, + "type": "array", + "uniqueItems": false + }, + "Scheme": { + "type": "string" + } + }, + "type": "object" + }, + "HttpTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + }, + "PerRequest": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "MatchRange": { + "additionalProperties": false, + "properties": { + "End": { + "type": "integer" + }, + "Start": { + "type": "integer" + } + }, + "required": [ + "Start", + "End" + ], + "type": "object" + }, + "QueryParameter": { + "additionalProperties": false, + "properties": { + "Match": { + "$ref": "#/definitions/HttpQueryParameterMatch" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "RouteSpec": { + "additionalProperties": false, + "properties": { + "GrpcRoute": { + "$ref": "#/definitions/GrpcRoute" + }, + "Http2Route": { + "$ref": "#/definitions/HttpRoute" + }, + "HttpRoute": { + "$ref": "#/definitions/HttpRoute" + }, + "Priority": { + "type": "integer" + }, + "TcpRoute": { + "$ref": "#/definitions/TcpRoute" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TcpRoute": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/TcpRouteAction" + }, + "Match": { + "$ref": "#/definitions/TcpRouteMatch" + }, + "Timeout": { + "$ref": "#/definitions/TcpTimeout" + } + }, + "required": [ + "Action" + ], + "type": "object" + }, + "TcpRouteAction": { + "additionalProperties": false, + "properties": { + "WeightedTargets": { + "items": { + "$ref": "#/definitions/WeightedTarget" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "WeightedTargets" + ], + "type": "object" + }, + "TcpRouteMatch": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + } + }, + "type": "object" + }, + "TcpTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "WeightedTarget": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + }, + "VirtualNode": { + "type": "string" + }, + "Weight": { + "type": "integer" + } + }, + "required": [ + "VirtualNode", + "Weight" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::Route", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "RouteName": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/RouteSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualRouterName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "VirtualRouterName", + "Spec" + ], + "typeName": "AWS::AppMesh::Route" +} diff --git a/schema/aws-appmesh-virtualgateway.json b/schema/aws-appmesh-virtualgateway.json index 304b999..25becac 100644 --- a/schema/aws-appmesh-virtualgateway.json +++ b/schema/aws-appmesh-virtualgateway.json @@ -1,537 +1,537 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualGatewayName", - "/properties/MeshOwner" - ], - "definitions": { - "JsonFormatRef": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "LoggingFormat": { - "additionalProperties": false, - "properties": { - "Json": { - "items": { - "$ref": "#/definitions/JsonFormatRef" - }, - "type": "array", - "uniqueItems": false - }, - "Text": { - "type": "string" - } - }, - "type": "object" - }, - "SubjectAlternativeNameMatchers": { - "additionalProperties": false, - "properties": { - "Exact": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SubjectAlternativeNames": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/SubjectAlternativeNameMatchers" - } - }, - "required": [ - "Match" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VirtualGatewayAccessLog": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/VirtualGatewayFileAccessLog" - } - }, - "type": "object" - }, - "VirtualGatewayBackendDefaults": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/VirtualGatewayClientPolicy" - } - }, - "type": "object" - }, - "VirtualGatewayClientPolicy": { - "additionalProperties": false, - "properties": { - "TLS": { - "$ref": "#/definitions/VirtualGatewayClientPolicyTls" - } - }, - "type": "object" - }, - "VirtualGatewayClientPolicyTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/VirtualGatewayClientTlsCertificate" - }, - "Enforce": { - "type": "boolean" - }, - "Ports": { - "items": { - "type": "integer" - }, - "type": "array", - "uniqueItems": false - }, - "Validation": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContext" - } - }, - "required": [ - "Validation" - ], - "type": "object" - }, - "VirtualGatewayClientTlsCertificate": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/VirtualGatewayListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/VirtualGatewayListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "VirtualGatewayConnectionPool": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/VirtualGatewayGrpcConnectionPool" - }, - "HTTP": { - "$ref": "#/definitions/VirtualGatewayHttpConnectionPool" - }, - "HTTP2": { - "$ref": "#/definitions/VirtualGatewayHttp2ConnectionPool" - } - }, - "type": "object" - }, - "VirtualGatewayFileAccessLog": { - "additionalProperties": false, - "properties": { - "Format": { - "$ref": "#/definitions/LoggingFormat" - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "VirtualGatewayGrpcConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "integer" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "VirtualGatewayHealthCheckPolicy": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "integer" - }, - "IntervalMillis": { - "type": "integer" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "Protocol": { - "type": "string" - }, - "TimeoutMillis": { - "type": "integer" - }, - "UnhealthyThreshold": { - "type": "integer" - } - }, - "required": [ - "UnhealthyThreshold", - "HealthyThreshold", - "TimeoutMillis", - "Protocol", - "IntervalMillis" - ], - "type": "object" - }, - "VirtualGatewayHttp2ConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "integer" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "VirtualGatewayHttpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "integer" - }, - "MaxPendingRequests": { - "type": "integer" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "VirtualGatewayListener": { - "additionalProperties": false, - "properties": { - "ConnectionPool": { - "$ref": "#/definitions/VirtualGatewayConnectionPool" - }, - "HealthCheck": { - "$ref": "#/definitions/VirtualGatewayHealthCheckPolicy" - }, - "PortMapping": { - "$ref": "#/definitions/VirtualGatewayPortMapping" - }, - "TLS": { - "$ref": "#/definitions/VirtualGatewayListenerTls" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "VirtualGatewayListenerTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/VirtualGatewayListenerTlsCertificate" - }, - "Mode": { - "type": "string" - }, - "Validation": { - "$ref": "#/definitions/VirtualGatewayListenerTlsValidationContext" - } - }, - "required": [ - "Mode", - "Certificate" - ], - "type": "object" - }, - "VirtualGatewayListenerTlsAcmCertificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn" - ], - "type": "object" - }, - "VirtualGatewayListenerTlsCertificate": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/VirtualGatewayListenerTlsAcmCertificate" - }, - "File": { - "$ref": "#/definitions/VirtualGatewayListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/VirtualGatewayListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "VirtualGatewayListenerTlsFileCertificate": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "required": [ - "PrivateKey", - "CertificateChain" - ], - "type": "object" - }, - "VirtualGatewayListenerTlsSdsCertificate": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "VirtualGatewayListenerTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/VirtualGatewayListenerTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "VirtualGatewayListenerTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "VirtualGatewayLogging": { - "additionalProperties": false, - "properties": { - "AccessLog": { - "$ref": "#/definitions/VirtualGatewayAccessLog" - } - }, - "type": "object" - }, - "VirtualGatewayPortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "VirtualGatewaySpec": { - "additionalProperties": false, - "properties": { - "BackendDefaults": { - "$ref": "#/definitions/VirtualGatewayBackendDefaults" - }, - "Listeners": { - "items": { - "$ref": "#/definitions/VirtualGatewayListener" - }, - "type": "array", - "uniqueItems": false - }, - "Logging": { - "$ref": "#/definitions/VirtualGatewayLogging" - } - }, - "required": [ - "Listeners" - ], - "type": "object" - }, - "VirtualGatewayTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "VirtualGatewayTlsValidationContextAcmTrust": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "CertificateAuthorityArns" - ], - "type": "object" - }, - "VirtualGatewayTlsValidationContextFileTrust": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - } - }, - "required": [ - "CertificateChain" - ], - "type": "object" - }, - "VirtualGatewayTlsValidationContextSdsTrust": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "VirtualGatewayTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextAcmTrust" - }, - "File": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/VirtualGatewayTlsValidationContextSdsTrust" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::VirtualGateway", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/VirtualGatewaySpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualGatewayName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "Spec" - ], - "typeName": "AWS::AppMesh::VirtualGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualGatewayName", + "/properties/MeshOwner" + ], + "definitions": { + "JsonFormatRef": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "LoggingFormat": { + "additionalProperties": false, + "properties": { + "Json": { + "items": { + "$ref": "#/definitions/JsonFormatRef" + }, + "type": "array", + "uniqueItems": false + }, + "Text": { + "type": "string" + } + }, + "type": "object" + }, + "SubjectAlternativeNameMatchers": { + "additionalProperties": false, + "properties": { + "Exact": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SubjectAlternativeNames": { + "additionalProperties": false, + "properties": { + "Match": { + "$ref": "#/definitions/SubjectAlternativeNameMatchers" + } + }, + "required": [ + "Match" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VirtualGatewayAccessLog": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/VirtualGatewayFileAccessLog" + } + }, + "type": "object" + }, + "VirtualGatewayBackendDefaults": { + "additionalProperties": false, + "properties": { + "ClientPolicy": { + "$ref": "#/definitions/VirtualGatewayClientPolicy" + } + }, + "type": "object" + }, + "VirtualGatewayClientPolicy": { + "additionalProperties": false, + "properties": { + "TLS": { + "$ref": "#/definitions/VirtualGatewayClientPolicyTls" + } + }, + "type": "object" + }, + "VirtualGatewayClientPolicyTls": { + "additionalProperties": false, + "properties": { + "Certificate": { + "$ref": "#/definitions/VirtualGatewayClientTlsCertificate" + }, + "Enforce": { + "type": "boolean" + }, + "Ports": { + "items": { + "type": "integer" + }, + "type": "array", + "uniqueItems": false + }, + "Validation": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContext" + } + }, + "required": [ + "Validation" + ], + "type": "object" + }, + "VirtualGatewayClientTlsCertificate": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/VirtualGatewayListenerTlsFileCertificate" + }, + "SDS": { + "$ref": "#/definitions/VirtualGatewayListenerTlsSdsCertificate" + } + }, + "type": "object" + }, + "VirtualGatewayConnectionPool": { + "additionalProperties": false, + "properties": { + "GRPC": { + "$ref": "#/definitions/VirtualGatewayGrpcConnectionPool" + }, + "HTTP": { + "$ref": "#/definitions/VirtualGatewayHttpConnectionPool" + }, + "HTTP2": { + "$ref": "#/definitions/VirtualGatewayHttp2ConnectionPool" + } + }, + "type": "object" + }, + "VirtualGatewayFileAccessLog": { + "additionalProperties": false, + "properties": { + "Format": { + "$ref": "#/definitions/LoggingFormat" + }, + "Path": { + "type": "string" + } + }, + "required": [ + "Path" + ], + "type": "object" + }, + "VirtualGatewayGrpcConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxRequests": { + "type": "integer" + } + }, + "required": [ + "MaxRequests" + ], + "type": "object" + }, + "VirtualGatewayHealthCheckPolicy": { + "additionalProperties": false, + "properties": { + "HealthyThreshold": { + "type": "integer" + }, + "IntervalMillis": { + "type": "integer" + }, + "Path": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "Protocol": { + "type": "string" + }, + "TimeoutMillis": { + "type": "integer" + }, + "UnhealthyThreshold": { + "type": "integer" + } + }, + "required": [ + "UnhealthyThreshold", + "HealthyThreshold", + "TimeoutMillis", + "Protocol", + "IntervalMillis" + ], + "type": "object" + }, + "VirtualGatewayHttp2ConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxRequests": { + "type": "integer" + } + }, + "required": [ + "MaxRequests" + ], + "type": "object" + }, + "VirtualGatewayHttpConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxConnections": { + "type": "integer" + }, + "MaxPendingRequests": { + "type": "integer" + } + }, + "required": [ + "MaxConnections" + ], + "type": "object" + }, + "VirtualGatewayListener": { + "additionalProperties": false, + "properties": { + "ConnectionPool": { + "$ref": "#/definitions/VirtualGatewayConnectionPool" + }, + "HealthCheck": { + "$ref": "#/definitions/VirtualGatewayHealthCheckPolicy" + }, + "PortMapping": { + "$ref": "#/definitions/VirtualGatewayPortMapping" + }, + "TLS": { + "$ref": "#/definitions/VirtualGatewayListenerTls" + } + }, + "required": [ + "PortMapping" + ], + "type": "object" + }, + "VirtualGatewayListenerTls": { + "additionalProperties": false, + "properties": { + "Certificate": { + "$ref": "#/definitions/VirtualGatewayListenerTlsCertificate" + }, + "Mode": { + "type": "string" + }, + "Validation": { + "$ref": "#/definitions/VirtualGatewayListenerTlsValidationContext" + } + }, + "required": [ + "Mode", + "Certificate" + ], + "type": "object" + }, + "VirtualGatewayListenerTlsAcmCertificate": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + } + }, + "required": [ + "CertificateArn" + ], + "type": "object" + }, + "VirtualGatewayListenerTlsCertificate": { + "additionalProperties": false, + "properties": { + "ACM": { + "$ref": "#/definitions/VirtualGatewayListenerTlsAcmCertificate" + }, + "File": { + "$ref": "#/definitions/VirtualGatewayListenerTlsFileCertificate" + }, + "SDS": { + "$ref": "#/definitions/VirtualGatewayListenerTlsSdsCertificate" + } + }, + "type": "object" + }, + "VirtualGatewayListenerTlsFileCertificate": { + "additionalProperties": false, + "properties": { + "CertificateChain": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + } + }, + "required": [ + "PrivateKey", + "CertificateChain" + ], + "type": "object" + }, + "VirtualGatewayListenerTlsSdsCertificate": { + "additionalProperties": false, + "properties": { + "SecretName": { + "type": "string" + } + }, + "required": [ + "SecretName" + ], + "type": "object" + }, + "VirtualGatewayListenerTlsValidationContext": { + "additionalProperties": false, + "properties": { + "SubjectAlternativeNames": { + "$ref": "#/definitions/SubjectAlternativeNames" + }, + "Trust": { + "$ref": "#/definitions/VirtualGatewayListenerTlsValidationContextTrust" + } + }, + "required": [ + "Trust" + ], + "type": "object" + }, + "VirtualGatewayListenerTlsValidationContextTrust": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextFileTrust" + }, + "SDS": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextSdsTrust" + } + }, + "type": "object" + }, + "VirtualGatewayLogging": { + "additionalProperties": false, + "properties": { + "AccessLog": { + "$ref": "#/definitions/VirtualGatewayAccessLog" + } + }, + "type": "object" + }, + "VirtualGatewayPortMapping": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "Port", + "Protocol" + ], + "type": "object" + }, + "VirtualGatewaySpec": { + "additionalProperties": false, + "properties": { + "BackendDefaults": { + "$ref": "#/definitions/VirtualGatewayBackendDefaults" + }, + "Listeners": { + "items": { + "$ref": "#/definitions/VirtualGatewayListener" + }, + "type": "array", + "uniqueItems": false + }, + "Logging": { + "$ref": "#/definitions/VirtualGatewayLogging" + } + }, + "required": [ + "Listeners" + ], + "type": "object" + }, + "VirtualGatewayTlsValidationContext": { + "additionalProperties": false, + "properties": { + "SubjectAlternativeNames": { + "$ref": "#/definitions/SubjectAlternativeNames" + }, + "Trust": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextTrust" + } + }, + "required": [ + "Trust" + ], + "type": "object" + }, + "VirtualGatewayTlsValidationContextAcmTrust": { + "additionalProperties": false, + "properties": { + "CertificateAuthorityArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "CertificateAuthorityArns" + ], + "type": "object" + }, + "VirtualGatewayTlsValidationContextFileTrust": { + "additionalProperties": false, + "properties": { + "CertificateChain": { + "type": "string" + } + }, + "required": [ + "CertificateChain" + ], + "type": "object" + }, + "VirtualGatewayTlsValidationContextSdsTrust": { + "additionalProperties": false, + "properties": { + "SecretName": { + "type": "string" + } + }, + "required": [ + "SecretName" + ], + "type": "object" + }, + "VirtualGatewayTlsValidationContextTrust": { + "additionalProperties": false, + "properties": { + "ACM": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextAcmTrust" + }, + "File": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextFileTrust" + }, + "SDS": { + "$ref": "#/definitions/VirtualGatewayTlsValidationContextSdsTrust" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::VirtualGateway", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/VirtualGatewaySpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualGatewayName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "Spec" + ], + "typeName": "AWS::AppMesh::VirtualGateway" +} diff --git a/schema/aws-appmesh-virtualnode.json b/schema/aws-appmesh-virtualnode.json index 6aacab2..21cd9cc 100644 --- a/schema/aws-appmesh-virtualnode.json +++ b/schema/aws-appmesh-virtualnode.json @@ -1,752 +1,752 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualNodeName", - "/properties/MeshOwner" - ], - "definitions": { - "AccessLog": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/FileAccessLog" - } - }, - "type": "object" - }, - "AwsCloudMapInstanceAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "AwsCloudMapServiceDiscovery": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "$ref": "#/definitions/AwsCloudMapInstanceAttribute" - }, - "type": "array", - "uniqueItems": false - }, - "IpPreference": { - "type": "string" - }, - "NamespaceName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - } - }, - "required": [ - "NamespaceName", - "ServiceName" - ], - "type": "object" - }, - "Backend": { - "additionalProperties": false, - "properties": { - "VirtualService": { - "$ref": "#/definitions/VirtualServiceBackend" - } - }, - "type": "object" - }, - "BackendDefaults": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/ClientPolicy" - } - }, - "type": "object" - }, - "ClientPolicy": { - "additionalProperties": false, - "properties": { - "TLS": { - "$ref": "#/definitions/ClientPolicyTls" - } - }, - "type": "object" - }, - "ClientPolicyTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/ClientTlsCertificate" - }, - "Enforce": { - "type": "boolean" - }, - "Ports": { - "items": { - "type": "integer" - }, - "type": "array", - "uniqueItems": false - }, - "Validation": { - "$ref": "#/definitions/TlsValidationContext" - } - }, - "required": [ - "Validation" - ], - "type": "object" - }, - "ClientTlsCertificate": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/ListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/ListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "DnsServiceDiscovery": { - "additionalProperties": false, - "properties": { - "Hostname": { - "type": "string" - }, - "IpPreference": { - "type": "string" - }, - "ResponseType": { - "type": "string" - } - }, - "required": [ - "Hostname" - ], - "type": "object" - }, - "Duration": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Value", - "Unit" - ], - "type": "object" - }, - "FileAccessLog": { - "additionalProperties": false, - "properties": { - "Format": { - "$ref": "#/definitions/LoggingFormat" - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "GrpcTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - }, - "PerRequest": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "HealthCheck": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "integer" - }, - "IntervalMillis": { - "type": "integer" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "Protocol": { - "type": "string" - }, - "TimeoutMillis": { - "type": "integer" - }, - "UnhealthyThreshold": { - "type": "integer" - } - }, - "required": [ - "UnhealthyThreshold", - "HealthyThreshold", - "TimeoutMillis", - "Protocol", - "IntervalMillis" - ], - "type": "object" - }, - "HttpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - }, - "PerRequest": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "JsonFormatRef": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Listener": { - "additionalProperties": false, - "properties": { - "ConnectionPool": { - "$ref": "#/definitions/VirtualNodeConnectionPool" - }, - "HealthCheck": { - "$ref": "#/definitions/HealthCheck" - }, - "OutlierDetection": { - "$ref": "#/definitions/OutlierDetection" - }, - "PortMapping": { - "$ref": "#/definitions/PortMapping" - }, - "TLS": { - "$ref": "#/definitions/ListenerTls" - }, - "Timeout": { - "$ref": "#/definitions/ListenerTimeout" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "ListenerTimeout": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/GrpcTimeout" - }, - "HTTP": { - "$ref": "#/definitions/HttpTimeout" - }, - "HTTP2": { - "$ref": "#/definitions/HttpTimeout" - }, - "TCP": { - "$ref": "#/definitions/TcpTimeout" - } - }, - "type": "object" - }, - "ListenerTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/ListenerTlsCertificate" - }, - "Mode": { - "type": "string" - }, - "Validation": { - "$ref": "#/definitions/ListenerTlsValidationContext" - } - }, - "required": [ - "Mode", - "Certificate" - ], - "type": "object" - }, - "ListenerTlsAcmCertificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn" - ], - "type": "object" - }, - "ListenerTlsCertificate": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/ListenerTlsAcmCertificate" - }, - "File": { - "$ref": "#/definitions/ListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/ListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "ListenerTlsFileCertificate": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "required": [ - "PrivateKey", - "CertificateChain" - ], - "type": "object" - }, - "ListenerTlsSdsCertificate": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "ListenerTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/ListenerTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "ListenerTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/TlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/TlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "Logging": { - "additionalProperties": false, - "properties": { - "AccessLog": { - "$ref": "#/definitions/AccessLog" - } - }, - "type": "object" - }, - "LoggingFormat": { - "additionalProperties": false, - "properties": { - "Json": { - "items": { - "$ref": "#/definitions/JsonFormatRef" - }, - "type": "array", - "uniqueItems": false - }, - "Text": { - "type": "string" - } - }, - "type": "object" - }, - "OutlierDetection": { - "additionalProperties": false, - "properties": { - "BaseEjectionDuration": { - "$ref": "#/definitions/Duration" - }, - "Interval": { - "$ref": "#/definitions/Duration" - }, - "MaxEjectionPercent": { - "type": "integer" - }, - "MaxServerErrors": { - "type": "integer" - } - }, - "required": [ - "MaxEjectionPercent", - "BaseEjectionDuration", - "MaxServerErrors", - "Interval" - ], - "type": "object" - }, - "PortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "ServiceDiscovery": { - "additionalProperties": false, - "properties": { - "AWSCloudMap": { - "$ref": "#/definitions/AwsCloudMapServiceDiscovery" - }, - "DNS": { - "$ref": "#/definitions/DnsServiceDiscovery" - } - }, - "type": "object" - }, - "SubjectAlternativeNameMatchers": { - "additionalProperties": false, - "properties": { - "Exact": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SubjectAlternativeNames": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/SubjectAlternativeNameMatchers" - } - }, - "required": [ - "Match" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TcpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/Duration" - } - }, - "type": "object" - }, - "TlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/TlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "TlsValidationContextAcmTrust": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "CertificateAuthorityArns" - ], - "type": "object" - }, - "TlsValidationContextFileTrust": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - } - }, - "required": [ - "CertificateChain" - ], - "type": "object" - }, - "TlsValidationContextSdsTrust": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "TlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/TlsValidationContextAcmTrust" - }, - "File": { - "$ref": "#/definitions/TlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/TlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "VirtualNodeConnectionPool": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/VirtualNodeGrpcConnectionPool" - }, - "HTTP": { - "$ref": "#/definitions/VirtualNodeHttpConnectionPool" - }, - "HTTP2": { - "$ref": "#/definitions/VirtualNodeHttp2ConnectionPool" - }, - "TCP": { - "$ref": "#/definitions/VirtualNodeTcpConnectionPool" - } - }, - "type": "object" - }, - "VirtualNodeGrpcConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "integer" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "VirtualNodeHttp2ConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "integer" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "VirtualNodeHttpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "integer" - }, - "MaxPendingRequests": { - "type": "integer" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "VirtualNodeSpec": { - "additionalProperties": false, - "properties": { - "BackendDefaults": { - "$ref": "#/definitions/BackendDefaults" - }, - "Backends": { - "items": { - "$ref": "#/definitions/Backend" - }, - "type": "array", - "uniqueItems": false - }, - "Listeners": { - "items": { - "$ref": "#/definitions/Listener" - }, - "type": "array", - "uniqueItems": false - }, - "Logging": { - "$ref": "#/definitions/Logging" - }, - "ServiceDiscovery": { - "$ref": "#/definitions/ServiceDiscovery" - } - }, - "type": "object" - }, - "VirtualNodeTcpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "integer" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "VirtualServiceBackend": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/ClientPolicy" - }, - "VirtualServiceName": { - "type": "string" - } - }, - "required": [ - "VirtualServiceName" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::VirtualNode", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/VirtualNodeSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualNodeName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "Spec" - ], - "typeName": "AWS::AppMesh::VirtualNode" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualNodeName", + "/properties/MeshOwner" + ], + "definitions": { + "AccessLog": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/FileAccessLog" + } + }, + "type": "object" + }, + "AwsCloudMapInstanceAttribute": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "AwsCloudMapServiceDiscovery": { + "additionalProperties": false, + "properties": { + "Attributes": { + "items": { + "$ref": "#/definitions/AwsCloudMapInstanceAttribute" + }, + "type": "array", + "uniqueItems": false + }, + "IpPreference": { + "type": "string" + }, + "NamespaceName": { + "type": "string" + }, + "ServiceName": { + "type": "string" + } + }, + "required": [ + "NamespaceName", + "ServiceName" + ], + "type": "object" + }, + "Backend": { + "additionalProperties": false, + "properties": { + "VirtualService": { + "$ref": "#/definitions/VirtualServiceBackend" + } + }, + "type": "object" + }, + "BackendDefaults": { + "additionalProperties": false, + "properties": { + "ClientPolicy": { + "$ref": "#/definitions/ClientPolicy" + } + }, + "type": "object" + }, + "ClientPolicy": { + "additionalProperties": false, + "properties": { + "TLS": { + "$ref": "#/definitions/ClientPolicyTls" + } + }, + "type": "object" + }, + "ClientPolicyTls": { + "additionalProperties": false, + "properties": { + "Certificate": { + "$ref": "#/definitions/ClientTlsCertificate" + }, + "Enforce": { + "type": "boolean" + }, + "Ports": { + "items": { + "type": "integer" + }, + "type": "array", + "uniqueItems": false + }, + "Validation": { + "$ref": "#/definitions/TlsValidationContext" + } + }, + "required": [ + "Validation" + ], + "type": "object" + }, + "ClientTlsCertificate": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/ListenerTlsFileCertificate" + }, + "SDS": { + "$ref": "#/definitions/ListenerTlsSdsCertificate" + } + }, + "type": "object" + }, + "DnsServiceDiscovery": { + "additionalProperties": false, + "properties": { + "Hostname": { + "type": "string" + }, + "IpPreference": { + "type": "string" + }, + "ResponseType": { + "type": "string" + } + }, + "required": [ + "Hostname" + ], + "type": "object" + }, + "Duration": { + "additionalProperties": false, + "properties": { + "Unit": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Value", + "Unit" + ], + "type": "object" + }, + "FileAccessLog": { + "additionalProperties": false, + "properties": { + "Format": { + "$ref": "#/definitions/LoggingFormat" + }, + "Path": { + "type": "string" + } + }, + "required": [ + "Path" + ], + "type": "object" + }, + "GrpcTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + }, + "PerRequest": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "HealthCheck": { + "additionalProperties": false, + "properties": { + "HealthyThreshold": { + "type": "integer" + }, + "IntervalMillis": { + "type": "integer" + }, + "Path": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "Protocol": { + "type": "string" + }, + "TimeoutMillis": { + "type": "integer" + }, + "UnhealthyThreshold": { + "type": "integer" + } + }, + "required": [ + "UnhealthyThreshold", + "HealthyThreshold", + "TimeoutMillis", + "Protocol", + "IntervalMillis" + ], + "type": "object" + }, + "HttpTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + }, + "PerRequest": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "JsonFormatRef": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Listener": { + "additionalProperties": false, + "properties": { + "ConnectionPool": { + "$ref": "#/definitions/VirtualNodeConnectionPool" + }, + "HealthCheck": { + "$ref": "#/definitions/HealthCheck" + }, + "OutlierDetection": { + "$ref": "#/definitions/OutlierDetection" + }, + "PortMapping": { + "$ref": "#/definitions/PortMapping" + }, + "TLS": { + "$ref": "#/definitions/ListenerTls" + }, + "Timeout": { + "$ref": "#/definitions/ListenerTimeout" + } + }, + "required": [ + "PortMapping" + ], + "type": "object" + }, + "ListenerTimeout": { + "additionalProperties": false, + "properties": { + "GRPC": { + "$ref": "#/definitions/GrpcTimeout" + }, + "HTTP": { + "$ref": "#/definitions/HttpTimeout" + }, + "HTTP2": { + "$ref": "#/definitions/HttpTimeout" + }, + "TCP": { + "$ref": "#/definitions/TcpTimeout" + } + }, + "type": "object" + }, + "ListenerTls": { + "additionalProperties": false, + "properties": { + "Certificate": { + "$ref": "#/definitions/ListenerTlsCertificate" + }, + "Mode": { + "type": "string" + }, + "Validation": { + "$ref": "#/definitions/ListenerTlsValidationContext" + } + }, + "required": [ + "Mode", + "Certificate" + ], + "type": "object" + }, + "ListenerTlsAcmCertificate": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + } + }, + "required": [ + "CertificateArn" + ], + "type": "object" + }, + "ListenerTlsCertificate": { + "additionalProperties": false, + "properties": { + "ACM": { + "$ref": "#/definitions/ListenerTlsAcmCertificate" + }, + "File": { + "$ref": "#/definitions/ListenerTlsFileCertificate" + }, + "SDS": { + "$ref": "#/definitions/ListenerTlsSdsCertificate" + } + }, + "type": "object" + }, + "ListenerTlsFileCertificate": { + "additionalProperties": false, + "properties": { + "CertificateChain": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + } + }, + "required": [ + "PrivateKey", + "CertificateChain" + ], + "type": "object" + }, + "ListenerTlsSdsCertificate": { + "additionalProperties": false, + "properties": { + "SecretName": { + "type": "string" + } + }, + "required": [ + "SecretName" + ], + "type": "object" + }, + "ListenerTlsValidationContext": { + "additionalProperties": false, + "properties": { + "SubjectAlternativeNames": { + "$ref": "#/definitions/SubjectAlternativeNames" + }, + "Trust": { + "$ref": "#/definitions/ListenerTlsValidationContextTrust" + } + }, + "required": [ + "Trust" + ], + "type": "object" + }, + "ListenerTlsValidationContextTrust": { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/TlsValidationContextFileTrust" + }, + "SDS": { + "$ref": "#/definitions/TlsValidationContextSdsTrust" + } + }, + "type": "object" + }, + "Logging": { + "additionalProperties": false, + "properties": { + "AccessLog": { + "$ref": "#/definitions/AccessLog" + } + }, + "type": "object" + }, + "LoggingFormat": { + "additionalProperties": false, + "properties": { + "Json": { + "items": { + "$ref": "#/definitions/JsonFormatRef" + }, + "type": "array", + "uniqueItems": false + }, + "Text": { + "type": "string" + } + }, + "type": "object" + }, + "OutlierDetection": { + "additionalProperties": false, + "properties": { + "BaseEjectionDuration": { + "$ref": "#/definitions/Duration" + }, + "Interval": { + "$ref": "#/definitions/Duration" + }, + "MaxEjectionPercent": { + "type": "integer" + }, + "MaxServerErrors": { + "type": "integer" + } + }, + "required": [ + "MaxEjectionPercent", + "BaseEjectionDuration", + "MaxServerErrors", + "Interval" + ], + "type": "object" + }, + "PortMapping": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "Port", + "Protocol" + ], + "type": "object" + }, + "ServiceDiscovery": { + "additionalProperties": false, + "properties": { + "AWSCloudMap": { + "$ref": "#/definitions/AwsCloudMapServiceDiscovery" + }, + "DNS": { + "$ref": "#/definitions/DnsServiceDiscovery" + } + }, + "type": "object" + }, + "SubjectAlternativeNameMatchers": { + "additionalProperties": false, + "properties": { + "Exact": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SubjectAlternativeNames": { + "additionalProperties": false, + "properties": { + "Match": { + "$ref": "#/definitions/SubjectAlternativeNameMatchers" + } + }, + "required": [ + "Match" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TcpTimeout": { + "additionalProperties": false, + "properties": { + "Idle": { + "$ref": "#/definitions/Duration" + } + }, + "type": "object" + }, + "TlsValidationContext": { + "additionalProperties": false, + "properties": { + "SubjectAlternativeNames": { + "$ref": "#/definitions/SubjectAlternativeNames" + }, + "Trust": { + "$ref": "#/definitions/TlsValidationContextTrust" + } + }, + "required": [ + "Trust" + ], + "type": "object" + }, + "TlsValidationContextAcmTrust": { + "additionalProperties": false, + "properties": { + "CertificateAuthorityArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "CertificateAuthorityArns" + ], + "type": "object" + }, + "TlsValidationContextFileTrust": { + "additionalProperties": false, + "properties": { + "CertificateChain": { + "type": "string" + } + }, + "required": [ + "CertificateChain" + ], + "type": "object" + }, + "TlsValidationContextSdsTrust": { + "additionalProperties": false, + "properties": { + "SecretName": { + "type": "string" + } + }, + "required": [ + "SecretName" + ], + "type": "object" + }, + "TlsValidationContextTrust": { + "additionalProperties": false, + "properties": { + "ACM": { + "$ref": "#/definitions/TlsValidationContextAcmTrust" + }, + "File": { + "$ref": "#/definitions/TlsValidationContextFileTrust" + }, + "SDS": { + "$ref": "#/definitions/TlsValidationContextSdsTrust" + } + }, + "type": "object" + }, + "VirtualNodeConnectionPool": { + "additionalProperties": false, + "properties": { + "GRPC": { + "$ref": "#/definitions/VirtualNodeGrpcConnectionPool" + }, + "HTTP": { + "$ref": "#/definitions/VirtualNodeHttpConnectionPool" + }, + "HTTP2": { + "$ref": "#/definitions/VirtualNodeHttp2ConnectionPool" + }, + "TCP": { + "$ref": "#/definitions/VirtualNodeTcpConnectionPool" + } + }, + "type": "object" + }, + "VirtualNodeGrpcConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxRequests": { + "type": "integer" + } + }, + "required": [ + "MaxRequests" + ], + "type": "object" + }, + "VirtualNodeHttp2ConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxRequests": { + "type": "integer" + } + }, + "required": [ + "MaxRequests" + ], + "type": "object" + }, + "VirtualNodeHttpConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxConnections": { + "type": "integer" + }, + "MaxPendingRequests": { + "type": "integer" + } + }, + "required": [ + "MaxConnections" + ], + "type": "object" + }, + "VirtualNodeSpec": { + "additionalProperties": false, + "properties": { + "BackendDefaults": { + "$ref": "#/definitions/BackendDefaults" + }, + "Backends": { + "items": { + "$ref": "#/definitions/Backend" + }, + "type": "array", + "uniqueItems": false + }, + "Listeners": { + "items": { + "$ref": "#/definitions/Listener" + }, + "type": "array", + "uniqueItems": false + }, + "Logging": { + "$ref": "#/definitions/Logging" + }, + "ServiceDiscovery": { + "$ref": "#/definitions/ServiceDiscovery" + } + }, + "type": "object" + }, + "VirtualNodeTcpConnectionPool": { + "additionalProperties": false, + "properties": { + "MaxConnections": { + "type": "integer" + } + }, + "required": [ + "MaxConnections" + ], + "type": "object" + }, + "VirtualServiceBackend": { + "additionalProperties": false, + "properties": { + "ClientPolicy": { + "$ref": "#/definitions/ClientPolicy" + }, + "VirtualServiceName": { + "type": "string" + } + }, + "required": [ + "VirtualServiceName" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::VirtualNode", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/VirtualNodeSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualNodeName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "Spec" + ], + "typeName": "AWS::AppMesh::VirtualNode" +} diff --git a/schema/aws-appmesh-virtualrouter.json b/schema/aws-appmesh-virtualrouter.json index 36271de..e97aab4 100644 --- a/schema/aws-appmesh-virtualrouter.json +++ b/schema/aws-appmesh-virtualrouter.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualRouterName", - "/properties/MeshOwner" - ], - "definitions": { - "PortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "integer" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VirtualRouterListener": { - "additionalProperties": false, - "properties": { - "PortMapping": { - "$ref": "#/definitions/PortMapping" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "VirtualRouterSpec": { - "additionalProperties": false, - "properties": { - "Listeners": { - "items": { - "$ref": "#/definitions/VirtualRouterListener" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Listeners" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::VirtualRouter", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/VirtualRouterSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualRouterName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "Spec" - ], - "typeName": "AWS::AppMesh::VirtualRouter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualRouterName", + "/properties/MeshOwner" + ], + "definitions": { + "PortMapping": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "integer" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "Port", + "Protocol" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VirtualRouterListener": { + "additionalProperties": false, + "properties": { + "PortMapping": { + "$ref": "#/definitions/PortMapping" + } + }, + "required": [ + "PortMapping" + ], + "type": "object" + }, + "VirtualRouterSpec": { + "additionalProperties": false, + "properties": { + "Listeners": { + "items": { + "$ref": "#/definitions/VirtualRouterListener" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Listeners" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::VirtualRouter", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/VirtualRouterSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualRouterName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "Spec" + ], + "typeName": "AWS::AppMesh::VirtualRouter" +} diff --git a/schema/aws-appmesh-virtualservice.json b/schema/aws-appmesh-virtualservice.json index 67f5550..09312c0 100644 --- a/schema/aws-appmesh-virtualservice.json +++ b/schema/aws-appmesh-virtualservice.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MeshName", - "/properties/VirtualServiceName", - "/properties/MeshOwner" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VirtualNodeServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualNodeName": { - "type": "string" - } - }, - "required": [ - "VirtualNodeName" - ], - "type": "object" - }, - "VirtualRouterServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualRouterName": { - "type": "string" - } - }, - "required": [ - "VirtualRouterName" - ], - "type": "object" - }, - "VirtualServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualNode": { - "$ref": "#/definitions/VirtualNodeServiceProvider" - }, - "VirtualRouter": { - "$ref": "#/definitions/VirtualRouterServiceProvider" - } - }, - "type": "object" - }, - "VirtualServiceSpec": { - "additionalProperties": false, - "properties": { - "Provider": { - "$ref": "#/definitions/VirtualServiceProvider" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppMesh::VirtualService", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/VirtualServiceSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "string" - }, - "VirtualServiceName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceOwner", - "/properties/Arn", - "/properties/Uid" - ], - "required": [ - "MeshName", - "VirtualServiceName", - "Spec" - ], - "typeName": "AWS::AppMesh::VirtualService" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MeshName", + "/properties/VirtualServiceName", + "/properties/MeshOwner" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VirtualNodeServiceProvider": { + "additionalProperties": false, + "properties": { + "VirtualNodeName": { + "type": "string" + } + }, + "required": [ + "VirtualNodeName" + ], + "type": "object" + }, + "VirtualRouterServiceProvider": { + "additionalProperties": false, + "properties": { + "VirtualRouterName": { + "type": "string" + } + }, + "required": [ + "VirtualRouterName" + ], + "type": "object" + }, + "VirtualServiceProvider": { + "additionalProperties": false, + "properties": { + "VirtualNode": { + "$ref": "#/definitions/VirtualNodeServiceProvider" + }, + "VirtualRouter": { + "$ref": "#/definitions/VirtualRouterServiceProvider" + } + }, + "type": "object" + }, + "VirtualServiceSpec": { + "additionalProperties": false, + "properties": { + "Provider": { + "$ref": "#/definitions/VirtualServiceProvider" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppMesh::VirtualService", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MeshName": { + "type": "string" + }, + "MeshOwner": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "Spec": { + "$ref": "#/definitions/VirtualServiceSpec" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "string" + }, + "VirtualServiceName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceOwner", + "/properties/Arn", + "/properties/Uid" + ], + "required": [ + "MeshName", + "VirtualServiceName", + "Spec" + ], + "typeName": "AWS::AppMesh::VirtualService" +} diff --git a/schema/aws-apprunner-autoscalingconfiguration.json b/schema/aws-apprunner-autoscalingconfiguration.json index e60c375..e83a5af 100644 --- a/schema/aws-apprunner-autoscalingconfiguration.json +++ b/schema/aws-apprunner-autoscalingconfiguration.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingConfigurationName", - "/properties/MaxConcurrency", - "/properties/MaxSize", - "/properties/MinSize", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Describes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.", - "handlers": { - "create": { - "permissions": [ - "apprunner:CreateAutoScalingConfiguration", - "apprunner:DescribeAutoScalingConfiguration", - "apprunner:TagResource" - ] - }, - "delete": { - "permissions": [ - "apprunner:DeleteAutoScalingConfiguration" - ] - }, - "list": { - "permissions": [ - "apprunner:ListAutoScalingConfiguration" - ] - }, - "read": { - "permissions": [ - "apprunner:DescribeAutoScalingConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/AutoScalingConfigurationArn" - ], - "properties": { - "AutoScalingConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of this auto scaling configuration.", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", - "type": "string" - }, - "AutoScalingConfigurationName": { - "description": "The customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.", - "maxLength": 32, - "minLength": 4, - "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}", - "type": "string" - }, - "AutoScalingConfigurationRevision": { - "description": "The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same AutoScalingConfigurationName.", - "type": "integer" - }, - "Latest": { - "description": "It's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.", - "type": "boolean" - }, - "MaxConcurrency": { - "description": "The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.", - "type": "integer" - }, - "MaxSize": { - "description": "The maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.", - "type": "integer" - }, - "MinSize": { - "description": "The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.", - "type": "integer" - }, - "Tags": { - "description": "A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AutoScalingConfigurationArn", - "/properties/AutoScalingConfigurationRevision", - "/properties/Latest" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppRunner::AutoScalingConfiguration", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingConfigurationName", + "/properties/MaxConcurrency", + "/properties/MaxSize", + "/properties/MinSize", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Describes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.", + "handlers": { + "create": { + "permissions": [ + "apprunner:CreateAutoScalingConfiguration", + "apprunner:DescribeAutoScalingConfiguration", + "apprunner:TagResource" + ] + }, + "delete": { + "permissions": [ + "apprunner:DeleteAutoScalingConfiguration" + ] + }, + "list": { + "permissions": [ + "apprunner:ListAutoScalingConfiguration" + ] + }, + "read": { + "permissions": [ + "apprunner:DescribeAutoScalingConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/AutoScalingConfigurationArn" + ], + "properties": { + "AutoScalingConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of this auto scaling configuration.", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", + "type": "string" + }, + "AutoScalingConfigurationName": { + "description": "The customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.", + "maxLength": 32, + "minLength": 4, + "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}", + "type": "string" + }, + "AutoScalingConfigurationRevision": { + "description": "The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same AutoScalingConfigurationName.", + "type": "integer" + }, + "Latest": { + "description": "It's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.", + "type": "boolean" + }, + "MaxConcurrency": { + "description": "The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.", + "type": "integer" + }, + "MaxSize": { + "description": "The maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.", + "type": "integer" + }, + "MinSize": { + "description": "The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.", + "type": "integer" + }, + "Tags": { + "description": "A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AutoScalingConfigurationArn", + "/properties/AutoScalingConfigurationRevision", + "/properties/Latest" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppRunner::AutoScalingConfiguration", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-apprunner-observabilityconfiguration.json b/schema/aws-apprunner-observabilityconfiguration.json index c1d34ee..84ee22d 100644 --- a/schema/aws-apprunner-observabilityconfiguration.json +++ b/schema/aws-apprunner-observabilityconfiguration.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ObservabilityConfigurationName", - "/properties/TraceConfiguration", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "TraceConfiguration": { - "additionalProperties": false, - "description": "Describes the configuration of the tracing feature within an AWS App Runner observability configuration.", - "properties": { - "Vendor": { - "description": "The implementation provider chosen for tracing App Runner services.", - "enum": [ - "AWSXRAY" - ], - "type": "string" - } - }, - "required": [ - "Vendor" - ], - "type": "object" - } - }, - "description": "The AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration", - "handlers": { - "create": { - "permissions": [ - "apprunner:CreateObservabilityConfiguration", - "apprunner:DescribeObservabilityConfiguration", - "apprunner:TagResource" - ] - }, - "delete": { - "permissions": [ - "apprunner:DeleteObservabilityConfiguration" - ] - }, - "list": { - "permissions": [ - "apprunner:ListObservabilityConfigurations" - ] - }, - "read": { - "permissions": [ - "apprunner:DescribeObservabilityConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/ObservabilityConfigurationArn" - ], - "properties": { - "Latest": { - "description": "It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.", - "type": "boolean" - }, - "ObservabilityConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of this ObservabilityConfiguration", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", - "type": "string" - }, - "ObservabilityConfigurationName": { - "description": "A name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.", - "maxLength": 32, - "minLength": 4, - "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}", - "type": "string" - }, - "ObservabilityConfigurationRevision": { - "description": "The revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.", - "type": "integer" - }, - "Tags": { - "description": "A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TraceConfiguration": { - "$ref": "#/definitions/TraceConfiguration", - "description": "The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing." - } - }, - "readOnlyProperties": [ - "/properties/ObservabilityConfigurationArn", - "/properties/ObservabilityConfigurationRevision", - "/properties/Latest" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppRunner::ObservabilityConfiguration", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ObservabilityConfigurationName", + "/properties/TraceConfiguration", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "TraceConfiguration": { + "additionalProperties": false, + "description": "Describes the configuration of the tracing feature within an AWS App Runner observability configuration.", + "properties": { + "Vendor": { + "description": "The implementation provider chosen for tracing App Runner services.", + "enum": [ + "AWSXRAY" + ], + "type": "string" + } + }, + "required": [ + "Vendor" + ], + "type": "object" + } + }, + "description": "The AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration", + "handlers": { + "create": { + "permissions": [ + "apprunner:CreateObservabilityConfiguration", + "apprunner:DescribeObservabilityConfiguration", + "apprunner:TagResource" + ] + }, + "delete": { + "permissions": [ + "apprunner:DeleteObservabilityConfiguration" + ] + }, + "list": { + "permissions": [ + "apprunner:ListObservabilityConfigurations" + ] + }, + "read": { + "permissions": [ + "apprunner:DescribeObservabilityConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/ObservabilityConfigurationArn" + ], + "properties": { + "Latest": { + "description": "It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.", + "type": "boolean" + }, + "ObservabilityConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of this ObservabilityConfiguration", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", + "type": "string" + }, + "ObservabilityConfigurationName": { + "description": "A name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.", + "maxLength": 32, + "minLength": 4, + "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}", + "type": "string" + }, + "ObservabilityConfigurationRevision": { + "description": "The revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.", + "type": "integer" + }, + "Tags": { + "description": "A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TraceConfiguration": { + "$ref": "#/definitions/TraceConfiguration", + "description": "The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing." + } + }, + "readOnlyProperties": [ + "/properties/ObservabilityConfigurationArn", + "/properties/ObservabilityConfigurationRevision", + "/properties/Latest" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppRunner::ObservabilityConfiguration", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-apprunner-service.json b/schema/aws-apprunner-service.json index ef3f705..60a8679 100644 --- a/schema/aws-apprunner-service.json +++ b/schema/aws-apprunner-service.json @@ -1,549 +1,549 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceName", - "/properties/EncryptionConfiguration", - "/properties/Tags" - ], - "definitions": { - "AuthenticationConfiguration": { - "additionalProperties": false, - "description": "Authentication Configuration", - "properties": { - "AccessRoleArn": { - "$ref": "#/definitions/RoleArn", - "description": "Access Role Arn" - }, - "ConnectionArn": { - "description": "Connection Arn", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", - "type": "string" - } - }, - "type": "object" - }, - "CodeConfiguration": { - "additionalProperties": false, - "description": "Code Configuration", - "properties": { - "CodeConfigurationValues": { - "$ref": "#/definitions/CodeConfigurationValues" - }, - "ConfigurationSource": { - "description": "Configuration Source", - "enum": [ - "REPOSITORY", - "API" - ], - "type": "string" - } - }, - "required": [ - "ConfigurationSource" - ], - "type": "object" - }, - "CodeConfigurationValues": { - "additionalProperties": false, - "description": "Code Configuration Values", - "properties": { - "BuildCommand": { - "description": "Build Command", - "type": "string" - }, - "Port": { - "description": "Port", - "type": "string" - }, - "Runtime": { - "description": "Runtime", - "enum": [ - "PYTHON_3", - "NODEJS_12", - "NODEJS_14", - "CORRETTO_8", - "CORRETTO_11", - "NODEJS_16", - "GO_1", - "DOTNET_6", - "PHP_81", - "RUBY_31", - "PYTHON_311", - "NODEJS_18" - ], - "type": "string" - }, - "RuntimeEnvironmentSecrets": { - "description": "The secrets and parameters that get referenced by your service as environment variables", - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array" - }, - "RuntimeEnvironmentVariables": { - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array" - }, - "StartCommand": { - "description": "Start Command", - "type": "string" - } - }, - "required": [ - "Runtime" - ], - "type": "object" - }, - "CodeRepository": { - "additionalProperties": false, - "description": "Source Code Repository", - "properties": { - "CodeConfiguration": { - "$ref": "#/definitions/CodeConfiguration" - }, - "RepositoryUrl": { - "description": "Repository Url", - "type": "string" - }, - "SourceCodeVersion": { - "$ref": "#/definitions/SourceCodeVersion" - }, - "SourceDirectory": { - "description": "Source Directory", - "maxLength": 4096, - "minLength": 1, - "pattern": "[^\\x00]+", - "type": "string" - } - }, - "required": [ - "RepositoryUrl", - "SourceCodeVersion" - ], - "type": "object" - }, - "EgressConfiguration": { - "additionalProperties": false, - "description": "Network egress configuration", - "properties": { - "EgressType": { - "description": "Network egress type.", - "enum": [ - "DEFAULT", - "VPC" - ], - "type": "string" - }, - "VpcConnectorArn": { - "description": "The Amazon Resource Name (ARN) of the App Runner VpcConnector.", - "maxLength": 1011, - "minLength": 44, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", - "type": "string" - } - }, - "required": [ - "EgressType" - ], - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "Encryption configuration (KMS key)", - "properties": { - "KmsKey": { - "description": "The KMS Key", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:kms:[a-z\\-]+-[0-9]{1}:[0-9]{12}:key\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - } - }, - "required": [ - "KmsKey" - ], - "type": "object" - }, - "HealthCheckConfiguration": { - "additionalProperties": false, - "description": "Health check configuration", - "properties": { - "HealthyThreshold": { - "description": "Health check Healthy Threshold", - "maximum": 20, - "minimum": 1, - "type": "integer" - }, - "Interval": { - "description": "Health check Interval", - "type": "integer" - }, - "Path": { - "description": "Health check Path", - "type": "string" - }, - "Protocol": { - "description": "Health Check Protocol", - "enum": [ - "TCP", - "HTTP" - ], - "type": "string" - }, - "Timeout": { - "description": "Health check Timeout", - "maximum": 20, - "minimum": 1, - "type": "integer" - }, - "UnhealthyThreshold": { - "description": "Health check Unhealthy Threshold", - "maximum": 20, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "ImageConfiguration": { - "additionalProperties": false, - "description": "Image Configuration", - "properties": { - "Port": { - "description": "Port", - "type": "string" - }, - "RuntimeEnvironmentSecrets": { - "description": "The secrets and parameters that get referenced by your service as environment variables", - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array" - }, - "RuntimeEnvironmentVariables": { - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array" - }, - "StartCommand": { - "description": "Start Command", - "type": "string" - } - }, - "type": "object" - }, - "ImageRepository": { - "additionalProperties": false, - "description": "Image Repository", - "properties": { - "ImageConfiguration": { - "$ref": "#/definitions/ImageConfiguration" - }, - "ImageIdentifier": { - "description": "Image Identifier", - "maxLength": 1024, - "minLength": 1, - "pattern": "([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/.*)|(^public\\.ecr\\.aws\\/.+\\/.+)", - "type": "string" - }, - "ImageRepositoryType": { - "description": "Image Repository Type", - "enum": [ - "ECR", - "ECR_PUBLIC" - ], - "type": "string" - } - }, - "required": [ - "ImageIdentifier", - "ImageRepositoryType" - ], - "type": "object" - }, - "IngressConfiguration": { - "additionalProperties": false, - "description": "Network ingress configuration", - "properties": { - "IsPubliclyAccessible": { - "description": "It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.", - "type": "boolean" - } - }, - "required": [ - "IsPubliclyAccessible" - ], - "type": "object" - }, - "InstanceConfiguration": { - "additionalProperties": false, - "description": "Instance Configuration", - "properties": { - "Cpu": { - "description": "CPU", - "maxLength": 9, - "minLength": 3, - "pattern": "256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU", - "type": "string" - }, - "InstanceRoleArn": { - "$ref": "#/definitions/RoleArn", - "description": "Instance Role Arn" - }, - "Memory": { - "description": "Memory", - "maxLength": 6, - "minLength": 3, - "pattern": "512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB", - "type": "string" - } - }, - "type": "object" - }, - "KeyValuePair": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "description": "Network configuration", - "properties": { - "EgressConfiguration": { - "$ref": "#/definitions/EgressConfiguration" - }, - "IngressConfiguration": { - "$ref": "#/definitions/IngressConfiguration" - }, - "IpAddressType": { - "description": "App Runner service endpoint IP address type", - "enum": [ - "IPV4", - "DUAL_STACK" - ], - "type": "string" - } - }, - "type": "object" - }, - "RoleArn": { - "maxLength": 1024, - "minLength": 29, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[\\w+=,.@-]{1,64}", - "type": "string" - }, - "ServiceObservabilityConfiguration": { - "additionalProperties": false, - "description": "Service observability configuration", - "properties": { - "ObservabilityConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", - "type": "string" - }, - "ObservabilityEnabled": { - "description": "Observability enabled", - "type": "boolean" - } - }, - "required": [ - "ObservabilityEnabled" - ], - "type": "object" - }, - "SourceCodeVersion": { - "additionalProperties": false, - "description": "Source Code Version", - "properties": { - "Type": { - "description": "Source Code Version Type", - "enum": [ - "BRANCH" - ], - "type": "string" - }, - "Value": { - "description": "Source Code Version Value", - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "SourceConfiguration": { - "additionalProperties": false, - "description": "Source Code configuration", - "properties": { - "AuthenticationConfiguration": { - "$ref": "#/definitions/AuthenticationConfiguration" - }, - "AutoDeploymentsEnabled": { - "description": "Auto Deployment enabled", - "type": "boolean" - }, - "CodeRepository": { - "$ref": "#/definitions/CodeRepository" - }, - "ImageRepository": { - "$ref": "#/definitions/ImageRepository" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::AppRunner::Service resource specifies an AppRunner Service.", - "handlers": { - "create": { - "permissions": [ - "apprunner:CreateService", - "apprunner:TagResource", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "logs:CreateLogGroup", - "logs:PutRetentionPolicy", - "logs:CreateLogStream", - "logs:PutLogEvents", - "logs:DescribeLogStreams", - "events:PutRule", - "events:PutTargets" - ] - }, - "delete": { - "permissions": [ - "apprunner:DeleteService" - ] - }, - "list": { - "permissions": [ - "apprunner:ListServices", - "iam:PassRole" - ] - }, - "read": { - "permissions": [ - "apprunner:DescribeService" - ] - }, - "update": { - "permissions": [ - "apprunner:UpdateService", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServiceArn" - ], - "properties": { - "AutoScalingConfigurationArn": { - "description": "Autoscaling configuration ARN", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "HealthCheckConfiguration": { - "$ref": "#/definitions/HealthCheckConfiguration" - }, - "InstanceConfiguration": { - "$ref": "#/definitions/InstanceConfiguration" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "ObservabilityConfiguration": { - "$ref": "#/definitions/ServiceObservabilityConfiguration" - }, - "ServiceArn": { - "description": "The Amazon Resource Name (ARN) of the AppRunner Service.", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", - "type": "string" - }, - "ServiceId": { - "description": "The AppRunner Service Id", - "maxLength": 32, - "minLength": 32, - "type": "string" - }, - "ServiceName": { - "description": "The AppRunner Service Name.", - "maxLength": 40, - "minLength": 4, - "pattern": "[A-Za-z0-9][A-Za-z0-9-_]{3,39}", - "type": "string" - }, - "ServiceUrl": { - "description": "The Service Url of the AppRunner Service.", - "type": "string" - }, - "SourceConfiguration": { - "$ref": "#/definitions/SourceConfiguration" - }, - "Status": { - "description": "AppRunner Service status.", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ServiceArn", - "/properties/ServiceId", - "/properties/ServiceUrl", - "/properties/Status" - ], - "required": [ - "SourceConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppRunner::Service", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/AutoScalingConfigurationArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceName", + "/properties/EncryptionConfiguration", + "/properties/Tags" + ], + "definitions": { + "AuthenticationConfiguration": { + "additionalProperties": false, + "description": "Authentication Configuration", + "properties": { + "AccessRoleArn": { + "$ref": "#/definitions/RoleArn", + "description": "Access Role Arn" + }, + "ConnectionArn": { + "description": "Connection Arn", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", + "type": "string" + } + }, + "type": "object" + }, + "CodeConfiguration": { + "additionalProperties": false, + "description": "Code Configuration", + "properties": { + "CodeConfigurationValues": { + "$ref": "#/definitions/CodeConfigurationValues" + }, + "ConfigurationSource": { + "description": "Configuration Source", + "enum": [ + "REPOSITORY", + "API" + ], + "type": "string" + } + }, + "required": [ + "ConfigurationSource" + ], + "type": "object" + }, + "CodeConfigurationValues": { + "additionalProperties": false, + "description": "Code Configuration Values", + "properties": { + "BuildCommand": { + "description": "Build Command", + "type": "string" + }, + "Port": { + "description": "Port", + "type": "string" + }, + "Runtime": { + "description": "Runtime", + "enum": [ + "PYTHON_3", + "NODEJS_12", + "NODEJS_14", + "CORRETTO_8", + "CORRETTO_11", + "NODEJS_16", + "GO_1", + "DOTNET_6", + "PHP_81", + "RUBY_31", + "PYTHON_311", + "NODEJS_18" + ], + "type": "string" + }, + "RuntimeEnvironmentSecrets": { + "description": "The secrets and parameters that get referenced by your service as environment variables", + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array" + }, + "RuntimeEnvironmentVariables": { + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array" + }, + "StartCommand": { + "description": "Start Command", + "type": "string" + } + }, + "required": [ + "Runtime" + ], + "type": "object" + }, + "CodeRepository": { + "additionalProperties": false, + "description": "Source Code Repository", + "properties": { + "CodeConfiguration": { + "$ref": "#/definitions/CodeConfiguration" + }, + "RepositoryUrl": { + "description": "Repository Url", + "type": "string" + }, + "SourceCodeVersion": { + "$ref": "#/definitions/SourceCodeVersion" + }, + "SourceDirectory": { + "description": "Source Directory", + "maxLength": 4096, + "minLength": 1, + "pattern": "[^\\x00]+", + "type": "string" + } + }, + "required": [ + "RepositoryUrl", + "SourceCodeVersion" + ], + "type": "object" + }, + "EgressConfiguration": { + "additionalProperties": false, + "description": "Network egress configuration", + "properties": { + "EgressType": { + "description": "Network egress type.", + "enum": [ + "DEFAULT", + "VPC" + ], + "type": "string" + }, + "VpcConnectorArn": { + "description": "The Amazon Resource Name (ARN) of the App Runner VpcConnector.", + "maxLength": 1011, + "minLength": 44, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", + "type": "string" + } + }, + "required": [ + "EgressType" + ], + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "Encryption configuration (KMS key)", + "properties": { + "KmsKey": { + "description": "The KMS Key", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:kms:[a-z\\-]+-[0-9]{1}:[0-9]{12}:key\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + } + }, + "required": [ + "KmsKey" + ], + "type": "object" + }, + "HealthCheckConfiguration": { + "additionalProperties": false, + "description": "Health check configuration", + "properties": { + "HealthyThreshold": { + "description": "Health check Healthy Threshold", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "Interval": { + "description": "Health check Interval", + "type": "integer" + }, + "Path": { + "description": "Health check Path", + "type": "string" + }, + "Protocol": { + "description": "Health Check Protocol", + "enum": [ + "TCP", + "HTTP" + ], + "type": "string" + }, + "Timeout": { + "description": "Health check Timeout", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "UnhealthyThreshold": { + "description": "Health check Unhealthy Threshold", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "ImageConfiguration": { + "additionalProperties": false, + "description": "Image Configuration", + "properties": { + "Port": { + "description": "Port", + "type": "string" + }, + "RuntimeEnvironmentSecrets": { + "description": "The secrets and parameters that get referenced by your service as environment variables", + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array" + }, + "RuntimeEnvironmentVariables": { + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array" + }, + "StartCommand": { + "description": "Start Command", + "type": "string" + } + }, + "type": "object" + }, + "ImageRepository": { + "additionalProperties": false, + "description": "Image Repository", + "properties": { + "ImageConfiguration": { + "$ref": "#/definitions/ImageConfiguration" + }, + "ImageIdentifier": { + "description": "Image Identifier", + "maxLength": 1024, + "minLength": 1, + "pattern": "([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/.*)|(^public\\.ecr\\.aws\\/.+\\/.+)", + "type": "string" + }, + "ImageRepositoryType": { + "description": "Image Repository Type", + "enum": [ + "ECR", + "ECR_PUBLIC" + ], + "type": "string" + } + }, + "required": [ + "ImageIdentifier", + "ImageRepositoryType" + ], + "type": "object" + }, + "IngressConfiguration": { + "additionalProperties": false, + "description": "Network ingress configuration", + "properties": { + "IsPubliclyAccessible": { + "description": "It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.", + "type": "boolean" + } + }, + "required": [ + "IsPubliclyAccessible" + ], + "type": "object" + }, + "InstanceConfiguration": { + "additionalProperties": false, + "description": "Instance Configuration", + "properties": { + "Cpu": { + "description": "CPU", + "maxLength": 9, + "minLength": 3, + "pattern": "256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU", + "type": "string" + }, + "InstanceRoleArn": { + "$ref": "#/definitions/RoleArn", + "description": "Instance Role Arn" + }, + "Memory": { + "description": "Memory", + "maxLength": 6, + "minLength": 3, + "pattern": "512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB", + "type": "string" + } + }, + "type": "object" + }, + "KeyValuePair": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "description": "Network configuration", + "properties": { + "EgressConfiguration": { + "$ref": "#/definitions/EgressConfiguration" + }, + "IngressConfiguration": { + "$ref": "#/definitions/IngressConfiguration" + }, + "IpAddressType": { + "description": "App Runner service endpoint IP address type", + "enum": [ + "IPV4", + "DUAL_STACK" + ], + "type": "string" + } + }, + "type": "object" + }, + "RoleArn": { + "maxLength": 1024, + "minLength": 29, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[\\w+=,.@-]{1,64}", + "type": "string" + }, + "ServiceObservabilityConfiguration": { + "additionalProperties": false, + "description": "Service observability configuration", + "properties": { + "ObservabilityConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", + "type": "string" + }, + "ObservabilityEnabled": { + "description": "Observability enabled", + "type": "boolean" + } + }, + "required": [ + "ObservabilityEnabled" + ], + "type": "object" + }, + "SourceCodeVersion": { + "additionalProperties": false, + "description": "Source Code Version", + "properties": { + "Type": { + "description": "Source Code Version Type", + "enum": [ + "BRANCH" + ], + "type": "string" + }, + "Value": { + "description": "Source Code Version Value", + "type": "string" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "SourceConfiguration": { + "additionalProperties": false, + "description": "Source Code configuration", + "properties": { + "AuthenticationConfiguration": { + "$ref": "#/definitions/AuthenticationConfiguration" + }, + "AutoDeploymentsEnabled": { + "description": "Auto Deployment enabled", + "type": "boolean" + }, + "CodeRepository": { + "$ref": "#/definitions/CodeRepository" + }, + "ImageRepository": { + "$ref": "#/definitions/ImageRepository" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::AppRunner::Service resource specifies an AppRunner Service.", + "handlers": { + "create": { + "permissions": [ + "apprunner:CreateService", + "apprunner:TagResource", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "logs:CreateLogGroup", + "logs:PutRetentionPolicy", + "logs:CreateLogStream", + "logs:PutLogEvents", + "logs:DescribeLogStreams", + "events:PutRule", + "events:PutTargets" + ] + }, + "delete": { + "permissions": [ + "apprunner:DeleteService" + ] + }, + "list": { + "permissions": [ + "apprunner:ListServices", + "iam:PassRole" + ] + }, + "read": { + "permissions": [ + "apprunner:DescribeService" + ] + }, + "update": { + "permissions": [ + "apprunner:UpdateService", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServiceArn" + ], + "properties": { + "AutoScalingConfigurationArn": { + "description": "Autoscaling configuration ARN", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "HealthCheckConfiguration": { + "$ref": "#/definitions/HealthCheckConfiguration" + }, + "InstanceConfiguration": { + "$ref": "#/definitions/InstanceConfiguration" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "ObservabilityConfiguration": { + "$ref": "#/definitions/ServiceObservabilityConfiguration" + }, + "ServiceArn": { + "description": "The Amazon Resource Name (ARN) of the AppRunner Service.", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", + "type": "string" + }, + "ServiceId": { + "description": "The AppRunner Service Id", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "ServiceName": { + "description": "The AppRunner Service Name.", + "maxLength": 40, + "minLength": 4, + "pattern": "[A-Za-z0-9][A-Za-z0-9-_]{3,39}", + "type": "string" + }, + "ServiceUrl": { + "description": "The Service Url of the AppRunner Service.", + "type": "string" + }, + "SourceConfiguration": { + "$ref": "#/definitions/SourceConfiguration" + }, + "Status": { + "description": "AppRunner Service status.", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ServiceArn", + "/properties/ServiceId", + "/properties/ServiceUrl", + "/properties/Status" + ], + "required": [ + "SourceConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppRunner::Service", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/AutoScalingConfigurationArn" + ] +} diff --git a/schema/aws-apprunner-vpcconnector.json b/schema/aws-apprunner-vpcconnector.json index a21a85b..3301b04 100644 --- a/schema/aws-apprunner-vpcconnector.json +++ b/schema/aws-apprunner-vpcconnector.json @@ -1,119 +1,119 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcConnectorName", - "/properties/Subnets", - "/properties/SecurityGroups", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "apprunner:CreateVpcConnector", - "apprunner:DescribeVpcConnector", - "apprunner:TagResource", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "apprunner:DeleteVpcConnector" - ] - }, - "list": { - "permissions": [ - "apprunner:ListVpcConnectors" - ] - }, - "read": { - "permissions": [ - "apprunner:DescribeVpcConnector" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpcConnectorArn" - ], - "properties": { - "SecurityGroups": { - "description": "A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "description": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcConnectorArn": { - "description": "The Amazon Resource Name (ARN) of this VPC connector.", - "maxLength": 1011, - "minLength": 44, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", - "type": "string" - }, - "VpcConnectorName": { - "description": "A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.", - "maxLength": 40, - "minLength": 4, - "pattern": "^[A-Za-z0-9][A-Za-z0-9-\\\\_]{3,39}$", - "type": "string" - }, - "VpcConnectorRevision": { - "description": "The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same Name.", - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/VpcConnectorArn", - "/properties/VpcConnectorRevision" - ], - "required": [ - "Subnets" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppRunner::VpcConnector", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcConnectorName", + "/properties/Subnets", + "/properties/SecurityGroups", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "apprunner:CreateVpcConnector", + "apprunner:DescribeVpcConnector", + "apprunner:TagResource", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "apprunner:DeleteVpcConnector" + ] + }, + "list": { + "permissions": [ + "apprunner:ListVpcConnectors" + ] + }, + "read": { + "permissions": [ + "apprunner:DescribeVpcConnector" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpcConnectorArn" + ], + "properties": { + "SecurityGroups": { + "description": "A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "description": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "VpcConnectorArn": { + "description": "The Amazon Resource Name (ARN) of this VPC connector.", + "maxLength": 1011, + "minLength": 44, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}", + "type": "string" + }, + "VpcConnectorName": { + "description": "A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.", + "maxLength": 40, + "minLength": 4, + "pattern": "^[A-Za-z0-9][A-Za-z0-9-\\\\_]{3,39}$", + "type": "string" + }, + "VpcConnectorRevision": { + "description": "The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same Name.", + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/VpcConnectorArn", + "/properties/VpcConnectorRevision" + ], + "required": [ + "Subnets" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppRunner::VpcConnector", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-apprunner-vpcingressconnection.json b/schema/aws-apprunner-vpcingressconnection.json index 3a99b5e..89017c0 100644 --- a/schema/aws-apprunner-vpcingressconnection.json +++ b/schema/aws-apprunner-vpcingressconnection.json @@ -1,151 +1,151 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcIngressConnectionName", - "/properties/ServiceArn", - "/properties/Tags" - ], - "definitions": { - "IngressVpcConfiguration": { - "additionalProperties": false, - "description": "The configuration of customer\u2019s VPC and related VPC endpoint", - "properties": { - "VpcEndpointId": { - "description": "The ID of the VPC endpoint that your App Runner service connects to.", - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC that the VPC endpoint is used in.", - "type": "string" - } - }, - "required": [ - "VpcId", - "VpcEndpointId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.", - "handlers": { - "create": { - "permissions": [ - "apprunner:CreateVpcIngressConnection", - "apprunner:DescribeVpcIngressConnection", - "ec2:DescribeVpcs", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeSubnets", - "apprunner:TagResource" - ] - }, - "delete": { - "permissions": [ - "apprunner:DeleteVpcIngressConnection" - ] - }, - "list": { - "permissions": [ - "apprunner:ListVpcIngressConnections" - ] - }, - "read": { - "permissions": [ - "apprunner:DescribeVpcIngressConnection" - ] - }, - "update": { - "permissions": [ - "apprunner:UpdateVpcIngressConnection" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpcIngressConnectionArn" - ], - "properties": { - "DomainName": { - "description": "The Domain name associated with the VPC Ingress Connection.", - "maxLength": 255, - "minLength": 1, - "pattern": "[A-Za-z0-9*.-]{1,255}", - "type": "string" - }, - "IngressVpcConfiguration": { - "$ref": "#/definitions/IngressVpcConfiguration" - }, - "ServiceArn": { - "description": "The Amazon Resource Name (ARN) of the service.", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", - "type": "string" - }, - "Status": { - "description": "The current status of the VpcIngressConnection.", - "enum": [ - "AVAILABLE", - "PENDING_CREATION", - "PENDING_UPDATE", - "PENDING_DELETION", - "FAILED_CREATION", - "FAILED_UPDATE", - "FAILED_DELETION", - "DELETED" - ], - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcIngressConnectionArn": { - "description": "The Amazon Resource Name (ARN) of the VpcIngressConnection.", - "maxLength": 1011, - "minLength": 1, - "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", - "type": "string" - }, - "VpcIngressConnectionName": { - "description": "The customer-provided Vpc Ingress Connection name.", - "maxLength": 40, - "minLength": 4, - "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VpcIngressConnectionArn", - "/properties/DomainName", - "/properties/Status" - ], - "required": [ - "ServiceArn", - "IngressVpcConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppRunner::VpcIngressConnection", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcIngressConnectionName", + "/properties/ServiceArn", + "/properties/Tags" + ], + "definitions": { + "IngressVpcConfiguration": { + "additionalProperties": false, + "description": "The configuration of customer\u2019s VPC and related VPC endpoint", + "properties": { + "VpcEndpointId": { + "description": "The ID of the VPC endpoint that your App Runner service connects to.", + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC that the VPC endpoint is used in.", + "type": "string" + } + }, + "required": [ + "VpcId", + "VpcEndpointId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.", + "handlers": { + "create": { + "permissions": [ + "apprunner:CreateVpcIngressConnection", + "apprunner:DescribeVpcIngressConnection", + "ec2:DescribeVpcs", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeSubnets", + "apprunner:TagResource" + ] + }, + "delete": { + "permissions": [ + "apprunner:DeleteVpcIngressConnection" + ] + }, + "list": { + "permissions": [ + "apprunner:ListVpcIngressConnections" + ] + }, + "read": { + "permissions": [ + "apprunner:DescribeVpcIngressConnection" + ] + }, + "update": { + "permissions": [ + "apprunner:UpdateVpcIngressConnection" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpcIngressConnectionArn" + ], + "properties": { + "DomainName": { + "description": "The Domain name associated with the VPC Ingress Connection.", + "maxLength": 255, + "minLength": 1, + "pattern": "[A-Za-z0-9*.-]{1,255}", + "type": "string" + }, + "IngressVpcConfiguration": { + "$ref": "#/definitions/IngressVpcConfiguration" + }, + "ServiceArn": { + "description": "The Amazon Resource Name (ARN) of the service.", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", + "type": "string" + }, + "Status": { + "description": "The current status of the VpcIngressConnection.", + "enum": [ + "AVAILABLE", + "PENDING_CREATION", + "PENDING_UPDATE", + "PENDING_DELETION", + "FAILED_CREATION", + "FAILED_UPDATE", + "FAILED_DELETION", + "DELETED" + ], + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "VpcIngressConnectionArn": { + "description": "The Amazon Resource Name (ARN) of the VpcIngressConnection.", + "maxLength": 1011, + "minLength": 1, + "pattern": "arn:aws(-[\\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\\w|/|-){1,1011}", + "type": "string" + }, + "VpcIngressConnectionName": { + "description": "The customer-provided Vpc Ingress Connection name.", + "maxLength": 40, + "minLength": 4, + "pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VpcIngressConnectionArn", + "/properties/DomainName", + "/properties/Status" + ], + "required": [ + "ServiceArn", + "IngressVpcConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppRunner::VpcIngressConnection", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-appstream-appblock.json b/schema/aws-appstream-appblock.json index 4c0c13e..57d487e 100644 --- a/schema/aws-appstream-appblock.json +++ b/schema/aws-appstream-appblock.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/DisplayName", - "/properties/Description", - "/properties/SourceS3Location", - "/properties/SetupScriptDetails", - "/properties/PackagingType", - "/properties/PostSetupScriptDetails" - ], - "definitions": { - "Arn": { - "type": "string" - }, - "PackagingType": { - "type": "string" - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "S3Bucket" - ], - "type": "object" - }, - "ScriptDetails": { - "additionalProperties": false, - "properties": { - "ExecutableParameters": { - "type": "string" - }, - "ExecutablePath": { - "type": "string" - }, - "ScriptS3Location": { - "$ref": "#/definitions/S3Location" - }, - "TimeoutInSeconds": { - "type": "integer" - } - }, - "required": [ - "ScriptS3Location", - "ExecutablePath", - "TimeoutInSeconds" - ], - "type": "object" - }, - "Tag": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TagKey": { - "type": "string" - }, - "TagValue": { - "type": "string" - } - }, - "required": [ - "TagKey", - "TagValue" - ], - "type": "object" - } - ] - } - }, - "deprecatedProperties": [ - "/properties/Tags/TagKey", - "/properties/Tags/TagValue" - ], - "description": "Resource Type definition for AWS::AppStream::AppBlock", - "handlers": { - "create": { - "permissions": [ - "appstream:CreateAppBlock", - "appstream:TagResource", - "s3:GetObject", - "s3:ListBucket", - "s3:GetBucketOwnershipControls" - ] - }, - "delete": { - "permissions": [ - "appstream:DeleteAppBlock" - ] - }, - "read": { - "permissions": [ - "appstream:DescribeAppBlocks" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CreatedTime": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "PackagingType": { - "$ref": "#/definitions/PackagingType" - }, - "PostSetupScriptDetails": { - "$ref": "#/definitions/ScriptDetails" - }, - "SetupScriptDetails": { - "$ref": "#/definitions/ScriptDetails" - }, - "SourceS3Location": { - "$ref": "#/definitions/S3Location" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime" - ], - "required": [ - "Name", - "SourceS3Location" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppStream::AppBlock", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/DisplayName", + "/properties/Description", + "/properties/SourceS3Location", + "/properties/SetupScriptDetails", + "/properties/PackagingType", + "/properties/PostSetupScriptDetails" + ], + "definitions": { + "Arn": { + "type": "string" + }, + "PackagingType": { + "type": "string" + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "type": "string" + }, + "S3Key": { + "type": "string" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "ScriptDetails": { + "additionalProperties": false, + "properties": { + "ExecutableParameters": { + "type": "string" + }, + "ExecutablePath": { + "type": "string" + }, + "ScriptS3Location": { + "$ref": "#/definitions/S3Location" + }, + "TimeoutInSeconds": { + "type": "integer" + } + }, + "required": [ + "ScriptS3Location", + "ExecutablePath", + "TimeoutInSeconds" + ], + "type": "object" + }, + "Tag": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TagKey": { + "type": "string" + }, + "TagValue": { + "type": "string" + } + }, + "required": [ + "TagKey", + "TagValue" + ], + "type": "object" + } + ] + } + }, + "deprecatedProperties": [ + "/properties/Tags/TagKey", + "/properties/Tags/TagValue" + ], + "description": "Resource Type definition for AWS::AppStream::AppBlock", + "handlers": { + "create": { + "permissions": [ + "appstream:CreateAppBlock", + "appstream:TagResource", + "s3:GetObject", + "s3:ListBucket", + "s3:GetBucketOwnershipControls" + ] + }, + "delete": { + "permissions": [ + "appstream:DeleteAppBlock" + ] + }, + "read": { + "permissions": [ + "appstream:DescribeAppBlocks" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CreatedTime": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "PackagingType": { + "$ref": "#/definitions/PackagingType" + }, + "PostSetupScriptDetails": { + "$ref": "#/definitions/ScriptDetails" + }, + "SetupScriptDetails": { + "$ref": "#/definitions/ScriptDetails" + }, + "SourceS3Location": { + "$ref": "#/definitions/S3Location" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime" + ], + "required": [ + "Name", + "SourceS3Location" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppStream::AppBlock", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-appstream-appblockbuilder.json b/schema/aws-appstream-appblockbuilder.json index 2976365..22a0011 100644 --- a/schema/aws-appstream-appblockbuilder.json +++ b/schema/aws-appstream-appblockbuilder.json @@ -1,197 +1,197 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AccessEndpoint": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "type": "string" - }, - "VpceId": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "VpceId" - ], - "type": "object" - }, - "Arn": { - "type": "string" - }, - "PlatformType": { - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::AppBlockBuilder.", - "handlers": { - "create": { - "permissions": [ - "appstream:CreateAppBlockBuilder", - "appstream:DescribeAppBlockBuilders", - "appstream:StartAppBlockBuilder", - "appstream:AssociateAppBlockBuilderAppBlock", - "appstream:DescribeAppBlockBuilderAppBlockAssociations", - "appstream:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "appstream:DescribeAppBlockBuilders", - "appstream:DeleteAppBlockBuilder", - "appstream:DisassociateAppBlockBuilderAppBlock", - "appstream:DescribeAppBlockBuilderAppBlockAssociations" - ] - }, - "list": { - "permissions": [ - "appstream:DescribeAppBlockBuilders" - ] - }, - "read": { - "permissions": [ - "appstream:DescribeAppBlockBuilders" - ] - }, - "update": { - "permissions": [ - "appstream:UpdateAppBlockBuilder", - "appstream:DescribeAppBlockBuilders", - "appstream:StartAppBlockBuilder", - "appstream:StopAppBlockBuilder", - "appstream:AssociateAppBlockBuilderAppBlock", - "appstream:DisassociateAppBlockBuilderAppBlock", - "appstream:DescribeAppBlockBuilderAppBlockAssociations", - "appstream:ListTagsForResource", - "appstream:TagResource", - "appstream:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AccessEndpoints": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AccessEndpoint" - }, - "type": "array", - "uniqueItems": true - }, - "AppBlockArns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CreatedTime": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "EnableDefaultInternetAccess": { - "type": "boolean" - }, - "IamRoleArn": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Platform": { - "$ref": "#/definitions/PlatformType" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime" - ], - "required": [ - "Name", - "Platform", - "InstanceType", - "VpcConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppStream::AppBlockBuilder", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/AppBlockArns" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AccessEndpoint": { + "additionalProperties": false, + "properties": { + "EndpointType": { + "type": "string" + }, + "VpceId": { + "type": "string" + } + }, + "required": [ + "EndpointType", + "VpceId" + ], + "type": "object" + }, + "Arn": { + "type": "string" + }, + "PlatformType": { + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::AppBlockBuilder.", + "handlers": { + "create": { + "permissions": [ + "appstream:CreateAppBlockBuilder", + "appstream:DescribeAppBlockBuilders", + "appstream:StartAppBlockBuilder", + "appstream:AssociateAppBlockBuilderAppBlock", + "appstream:DescribeAppBlockBuilderAppBlockAssociations", + "appstream:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "appstream:DescribeAppBlockBuilders", + "appstream:DeleteAppBlockBuilder", + "appstream:DisassociateAppBlockBuilderAppBlock", + "appstream:DescribeAppBlockBuilderAppBlockAssociations" + ] + }, + "list": { + "permissions": [ + "appstream:DescribeAppBlockBuilders" + ] + }, + "read": { + "permissions": [ + "appstream:DescribeAppBlockBuilders" + ] + }, + "update": { + "permissions": [ + "appstream:UpdateAppBlockBuilder", + "appstream:DescribeAppBlockBuilders", + "appstream:StartAppBlockBuilder", + "appstream:StopAppBlockBuilder", + "appstream:AssociateAppBlockBuilderAppBlock", + "appstream:DisassociateAppBlockBuilderAppBlock", + "appstream:DescribeAppBlockBuilderAppBlockAssociations", + "appstream:ListTagsForResource", + "appstream:TagResource", + "appstream:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AccessEndpoints": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AccessEndpoint" + }, + "type": "array", + "uniqueItems": true + }, + "AppBlockArns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CreatedTime": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "IamRoleArn": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Platform": { + "$ref": "#/definitions/PlatformType" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime" + ], + "required": [ + "Name", + "Platform", + "InstanceType", + "VpcConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppStream::AppBlockBuilder", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/AppBlockArns" + ] +} diff --git a/schema/aws-appstream-application.json b/schema/aws-appstream-application.json index a01d804..2201b32 100644 --- a/schema/aws-appstream-application.json +++ b/schema/aws-appstream-application.json @@ -1,193 +1,193 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/InstanceFamilies", - "/properties/Platforms" - ], - "definitions": { - "ApplicationAttribute": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "PlatformType": { - "type": "string" - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "Tag": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TagKey": { - "type": "string" - }, - "TagValue": { - "type": "string" - } - }, - "required": [ - "TagKey", - "TagValue" - ], - "type": "object" - } - ] - } - }, - "deprecatedProperties": [ - "/properties/Tags/TagKey", - "/properties/Tags/TagValue" - ], - "description": "Resource Type definition for AWS::AppStream::Application", - "handlers": { - "create": { - "permissions": [ - "s3:GetObject", - "appstream:CreateApplication", - "appstream:TagResource" - ] - }, - "delete": { - "permissions": [ - "appstream:DeleteApplication" - ] - }, - "read": { - "permissions": [ - "appstream:DescribeApplications" - ] - }, - "update": { - "permissions": [ - "appstream:UpdateApplication", - "s3:GetObject" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AppBlockArn": { - "$ref": "#/definitions/Arn" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "AttributesToDelete": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ApplicationAttribute" - }, - "type": "array", - "uniqueItems": true - }, - "CreatedTime": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "IconS3Location": { - "$ref": "#/definitions/S3Location" - }, - "InstanceFamilies": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LaunchParameters": { - "type": "string" - }, - "LaunchPath": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Platforms": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PlatformType" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "WorkingDirectory": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime" - ], - "required": [ - "Name", - "IconS3Location", - "LaunchPath", - "Platforms", - "InstanceFamilies", - "AppBlockArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::AppStream::Application", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/AttributesToDelete" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/InstanceFamilies", + "/properties/Platforms" + ], + "definitions": { + "ApplicationAttribute": { + "type": "string" + }, + "Arn": { + "type": "string" + }, + "PlatformType": { + "type": "string" + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "type": "string" + }, + "S3Key": { + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key" + ], + "type": "object" + }, + "Tag": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TagKey": { + "type": "string" + }, + "TagValue": { + "type": "string" + } + }, + "required": [ + "TagKey", + "TagValue" + ], + "type": "object" + } + ] + } + }, + "deprecatedProperties": [ + "/properties/Tags/TagKey", + "/properties/Tags/TagValue" + ], + "description": "Resource Type definition for AWS::AppStream::Application", + "handlers": { + "create": { + "permissions": [ + "s3:GetObject", + "appstream:CreateApplication", + "appstream:TagResource" + ] + }, + "delete": { + "permissions": [ + "appstream:DeleteApplication" + ] + }, + "read": { + "permissions": [ + "appstream:DescribeApplications" + ] + }, + "update": { + "permissions": [ + "appstream:UpdateApplication", + "s3:GetObject" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AppBlockArn": { + "$ref": "#/definitions/Arn" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "AttributesToDelete": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ApplicationAttribute" + }, + "type": "array", + "uniqueItems": true + }, + "CreatedTime": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "IconS3Location": { + "$ref": "#/definitions/S3Location" + }, + "InstanceFamilies": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LaunchParameters": { + "type": "string" + }, + "LaunchPath": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Platforms": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PlatformType" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WorkingDirectory": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime" + ], + "required": [ + "Name", + "IconS3Location", + "LaunchPath", + "Platforms", + "InstanceFamilies", + "AppBlockArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::AppStream::Application", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/AttributesToDelete" + ] +} diff --git a/schema/aws-appstream-applicationentitlementassociation.json b/schema/aws-appstream-applicationentitlementassociation.json index 076cdf1..8bf420f 100644 --- a/schema/aws-appstream-applicationentitlementassociation.json +++ b/schema/aws-appstream-applicationentitlementassociation.json @@ -1,55 +1,55 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StackName", - "/properties/EntitlementName", - "/properties/ApplicationIdentifier" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::AppStream::ApplicationEntitlementAssociation", - "handlers": { - "create": { - "permissions": [ - "appstream:AssociateApplicationToEntitlement", - "appstream:ListEntitledApplications" - ] - }, - "delete": { - "permissions": [ - "appstream:DisassociateApplicationFromEntitlement", - "appstream:ListEntitledApplications" - ] - }, - "read": { - "permissions": [ - "appstream:ListEntitledApplications" - ] - } - }, - "primaryIdentifier": [ - "/properties/StackName", - "/properties/EntitlementName", - "/properties/ApplicationIdentifier" - ], - "properties": { - "ApplicationIdentifier": { - "type": "string" - }, - "EntitlementName": { - "type": "string" - }, - "StackName": { - "type": "string" - } - }, - "required": [ - "StackName", - "EntitlementName", - "ApplicationIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AppStream::ApplicationEntitlementAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StackName", + "/properties/EntitlementName", + "/properties/ApplicationIdentifier" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::AppStream::ApplicationEntitlementAssociation", + "handlers": { + "create": { + "permissions": [ + "appstream:AssociateApplicationToEntitlement", + "appstream:ListEntitledApplications" + ] + }, + "delete": { + "permissions": [ + "appstream:DisassociateApplicationFromEntitlement", + "appstream:ListEntitledApplications" + ] + }, + "read": { + "permissions": [ + "appstream:ListEntitledApplications" + ] + } + }, + "primaryIdentifier": [ + "/properties/StackName", + "/properties/EntitlementName", + "/properties/ApplicationIdentifier" + ], + "properties": { + "ApplicationIdentifier": { + "type": "string" + }, + "EntitlementName": { + "type": "string" + }, + "StackName": { + "type": "string" + } + }, + "required": [ + "StackName", + "EntitlementName", + "ApplicationIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AppStream::ApplicationEntitlementAssociation" +} diff --git a/schema/aws-appstream-applicationfleetassociation.json b/schema/aws-appstream-applicationfleetassociation.json index bef91ec..a4e3a1b 100644 --- a/schema/aws-appstream-applicationfleetassociation.json +++ b/schema/aws-appstream-applicationfleetassociation.json @@ -1,53 +1,53 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FleetName", - "/properties/ApplicationArn" - ], - "definitions": { - "Arn": { - "type": "string" - } - }, - "description": "Resource Type definition for AWS::AppStream::ApplicationFleetAssociation", - "handlers": { - "create": { - "permissions": [ - "appstream:AssociateApplicationFleet", - "appstream:DescribeApplicationFleetAssociations" - ] - }, - "delete": { - "permissions": [ - "appstream:DisassociateApplicationFleet", - "appstream:DescribeApplicationFleetAssociations" - ] - }, - "read": { - "permissions": [ - "appstream:DescribeApplicationFleetAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/FleetName", - "/properties/ApplicationArn" - ], - "properties": { - "ApplicationArn": { - "$ref": "#/definitions/Arn" - }, - "FleetName": { - "type": "string" - } - }, - "required": [ - "FleetName", - "ApplicationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AppStream::ApplicationFleetAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FleetName", + "/properties/ApplicationArn" + ], + "definitions": { + "Arn": { + "type": "string" + } + }, + "description": "Resource Type definition for AWS::AppStream::ApplicationFleetAssociation", + "handlers": { + "create": { + "permissions": [ + "appstream:AssociateApplicationFleet", + "appstream:DescribeApplicationFleetAssociations" + ] + }, + "delete": { + "permissions": [ + "appstream:DisassociateApplicationFleet", + "appstream:DescribeApplicationFleetAssociations" + ] + }, + "read": { + "permissions": [ + "appstream:DescribeApplicationFleetAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/FleetName", + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "$ref": "#/definitions/Arn" + }, + "FleetName": { + "type": "string" + } + }, + "required": [ + "FleetName", + "ApplicationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AppStream::ApplicationFleetAssociation" +} diff --git a/schema/aws-appstream-directoryconfig.json b/schema/aws-appstream-directoryconfig.json index 8536235..eed1f07 100644 --- a/schema/aws-appstream-directoryconfig.json +++ b/schema/aws-appstream-directoryconfig.json @@ -1,127 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DirectoryName" - ], - "definitions": { - "CertificateBasedAuthProperties": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArn": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "ServiceAccountCredentials": { - "additionalProperties": false, - "properties": { - "AccountName": { - "type": "string" - }, - "AccountPassword": { - "type": "string" - } - }, - "required": [ - "AccountName", - "AccountPassword" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::DirectoryConfig", - "handlers": { - "create": { - "permissions": [ - "appstream:CreateDirectoryConfig", - "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfigs", - "appstream:UpdateDirectoryConfig", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "delete": { - "permissions": [ - "appstream:CreateDirectoryConfig", - "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfigs", - "appstream:UpdateDirectoryConfig", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "list": { - "permissions": [ - "appstream:CreateDirectoryConfig", - "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfigs", - "appstream:UpdateDirectoryConfig", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "read": { - "permissions": [ - "appstream:CreateDirectoryConfig", - "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfigs", - "appstream:UpdateDirectoryConfig", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "update": { - "permissions": [ - "appstream:CreateDirectoryConfig", - "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfigs", - "appstream:UpdateDirectoryConfig", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - } - }, - "primaryIdentifier": [ - "/properties/DirectoryName" - ], - "properties": { - "CertificateBasedAuthProperties": { - "$ref": "#/definitions/CertificateBasedAuthProperties" - }, - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ServiceAccountCredentials": { - "$ref": "#/definitions/ServiceAccountCredentials" - } - }, - "required": [ - "DirectoryName", - "OrganizationalUnitDistinguishedNames", - "ServiceAccountCredentials" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::AppStream::DirectoryConfig", - "writeOnlyProperties": [ - "/properties/ServiceAccountCredentials/AccountPassword" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DirectoryName" + ], + "definitions": { + "CertificateBasedAuthProperties": { + "additionalProperties": false, + "properties": { + "CertificateAuthorityArn": { + "type": "string" + }, + "Status": { + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccountCredentials": { + "additionalProperties": false, + "properties": { + "AccountName": { + "type": "string" + }, + "AccountPassword": { + "type": "string" + } + }, + "required": [ + "AccountName", + "AccountPassword" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::DirectoryConfig", + "handlers": { + "create": { + "permissions": [ + "appstream:CreateDirectoryConfig", + "appstream:DeleteDirectoryConfig", + "appstream:DescribeDirectoryConfigs", + "appstream:UpdateDirectoryConfig", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "delete": { + "permissions": [ + "appstream:CreateDirectoryConfig", + "appstream:DeleteDirectoryConfig", + "appstream:DescribeDirectoryConfigs", + "appstream:UpdateDirectoryConfig", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "list": { + "permissions": [ + "appstream:CreateDirectoryConfig", + "appstream:DeleteDirectoryConfig", + "appstream:DescribeDirectoryConfigs", + "appstream:UpdateDirectoryConfig", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "read": { + "permissions": [ + "appstream:CreateDirectoryConfig", + "appstream:DeleteDirectoryConfig", + "appstream:DescribeDirectoryConfigs", + "appstream:UpdateDirectoryConfig", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "update": { + "permissions": [ + "appstream:CreateDirectoryConfig", + "appstream:DeleteDirectoryConfig", + "appstream:DescribeDirectoryConfigs", + "appstream:UpdateDirectoryConfig", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + } + }, + "primaryIdentifier": [ + "/properties/DirectoryName" + ], + "properties": { + "CertificateBasedAuthProperties": { + "$ref": "#/definitions/CertificateBasedAuthProperties" + }, + "DirectoryName": { + "type": "string" + }, + "OrganizationalUnitDistinguishedNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ServiceAccountCredentials": { + "$ref": "#/definitions/ServiceAccountCredentials" + } + }, + "required": [ + "DirectoryName", + "OrganizationalUnitDistinguishedNames", + "ServiceAccountCredentials" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::AppStream::DirectoryConfig", + "writeOnlyProperties": [ + "/properties/ServiceAccountCredentials/AccountPassword" + ] +} diff --git a/schema/aws-appstream-entitlement.json b/schema/aws-appstream-entitlement.json index 92a9ce9..7cdfa98 100644 --- a/schema/aws-appstream-entitlement.json +++ b/schema/aws-appstream-entitlement.json @@ -1,95 +1,95 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/StackName" - ], - "definitions": { - "Attribute": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::Entitlement", - "handlers": { - "create": { - "permissions": [ - "appstream:CreateEntitlement" - ] - }, - "delete": { - "permissions": [ - "appstream:DeleteEntitlement" - ] - }, - "read": { - "permissions": [ - "appstream:DescribeEntitlements" - ] - }, - "update": { - "permissions": [ - "appstream:UpdateEntitlement" - ] - } - }, - "primaryIdentifier": [ - "/properties/StackName", - "/properties/Name" - ], - "properties": { - "AppVisibility": { - "type": "string" - }, - "Attributes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Attribute" - }, - "type": "array", - "uniqueItems": true - }, - "CreatedTime": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "StackName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedTime", - "/properties/LastModifiedTime" - ], - "required": [ - "Name", - "StackName", - "AppVisibility", - "Attributes" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AppStream::Entitlement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/StackName" + ], + "definitions": { + "Attribute": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::Entitlement", + "handlers": { + "create": { + "permissions": [ + "appstream:CreateEntitlement" + ] + }, + "delete": { + "permissions": [ + "appstream:DeleteEntitlement" + ] + }, + "read": { + "permissions": [ + "appstream:DescribeEntitlements" + ] + }, + "update": { + "permissions": [ + "appstream:UpdateEntitlement" + ] + } + }, + "primaryIdentifier": [ + "/properties/StackName", + "/properties/Name" + ], + "properties": { + "AppVisibility": { + "type": "string" + }, + "Attributes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Attribute" + }, + "type": "array", + "uniqueItems": true + }, + "CreatedTime": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "LastModifiedTime": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "StackName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedTime", + "/properties/LastModifiedTime" + ], + "required": [ + "Name", + "StackName", + "AppVisibility", + "Attributes" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AppStream::Entitlement" +} diff --git a/schema/aws-appstream-fleet.json b/schema/aws-appstream-fleet.json index 295fc03..a057053 100644 --- a/schema/aws-appstream-fleet.json +++ b/schema/aws-appstream-fleet.json @@ -1,176 +1,176 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/FleetType" - ], - "definitions": { - "ComputeCapacity": { - "additionalProperties": false, - "properties": { - "DesiredInstances": { - "type": "integer" - }, - "DesiredSessions": { - "type": "integer" - } - }, - "type": "object" - }, - "DomainJoinInfo": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - } - }, - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::Fleet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ComputeCapacity": { - "$ref": "#/definitions/ComputeCapacity" - }, - "Description": { - "type": "string" - }, - "DisconnectTimeoutInSeconds": { - "type": "integer" - }, - "DisplayName": { - "type": "string" - }, - "DomainJoinInfo": { - "$ref": "#/definitions/DomainJoinInfo" - }, - "EnableDefaultInternetAccess": { - "type": "boolean" - }, - "FleetType": { - "type": "string" - }, - "IamRoleArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IdleDisconnectTimeoutInSeconds": { - "type": "integer" - }, - "ImageArn": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "MaxConcurrentSessions": { - "type": "integer" - }, - "MaxSessionsPerInstance": { - "type": "integer" - }, - "MaxUserDurationInSeconds": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "Platform": { - "type": "string" - }, - "SessionScriptS3Location": { - "$ref": "#/definitions/S3Location" - }, - "StreamView": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UsbDeviceFilterStrings": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "InstanceType", - "Name" - ], - "typeName": "AWS::AppStream::Fleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/FleetType" + ], + "definitions": { + "ComputeCapacity": { + "additionalProperties": false, + "properties": { + "DesiredInstances": { + "type": "integer" + }, + "DesiredSessions": { + "type": "integer" + } + }, + "type": "object" + }, + "DomainJoinInfo": { + "additionalProperties": false, + "properties": { + "DirectoryName": { + "type": "string" + }, + "OrganizationalUnitDistinguishedName": { + "type": "string" + } + }, + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "type": "string" + }, + "S3Key": { + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::Fleet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ComputeCapacity": { + "$ref": "#/definitions/ComputeCapacity" + }, + "Description": { + "type": "string" + }, + "DisconnectTimeoutInSeconds": { + "type": "integer" + }, + "DisplayName": { + "type": "string" + }, + "DomainJoinInfo": { + "$ref": "#/definitions/DomainJoinInfo" + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "FleetType": { + "type": "string" + }, + "IamRoleArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IdleDisconnectTimeoutInSeconds": { + "type": "integer" + }, + "ImageArn": { + "type": "string" + }, + "ImageName": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "MaxConcurrentSessions": { + "type": "integer" + }, + "MaxSessionsPerInstance": { + "type": "integer" + }, + "MaxUserDurationInSeconds": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "Platform": { + "type": "string" + }, + "SessionScriptS3Location": { + "$ref": "#/definitions/S3Location" + }, + "StreamView": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UsbDeviceFilterStrings": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "InstanceType", + "Name" + ], + "typeName": "AWS::AppStream::Fleet" +} diff --git a/schema/aws-appstream-imagebuilder.json b/schema/aws-appstream-imagebuilder.json index ad9f691..5742510 100644 --- a/schema/aws-appstream-imagebuilder.json +++ b/schema/aws-appstream-imagebuilder.json @@ -1,198 +1,198 @@ -{ - "additionalProperties": false, - "definitions": { - "AccessEndpoint": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "type": "string" - }, - "VpceId": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "VpceId" - ], - "type": "object" - }, - "DomainJoinInfo": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::ImageBuilder", - "handlers": { - "create": { - "permissions": [ - "appstream:CreateImageBuilder", - "appstream:CreateImageBuilderStreamingURL", - "appstream:CreateStreamingURL", - "appstream:DeleteImageBuilder", - "appstream:DescribeImageBuilders", - "appstream:StartImageBuilder", - "appstream:StopImageBuilder", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "delete": { - "permissions": [ - "appstream:CreateImageBuilder", - "appstream:CreateImageBuilderStreamingURL", - "appstream:CreateStreamingURL", - "appstream:DeleteImageBuilder", - "appstream:DescribeImageBuilders", - "appstream:StartImageBuilder", - "appstream:StopImageBuilder", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "list": { - "permissions": [ - "appstream:CreateImageBuilder", - "appstream:CreateImageBuilderStreamingURL", - "appstream:CreateStreamingURL", - "appstream:DeleteImageBuilder", - "appstream:DescribeImageBuilders", - "appstream:StartImageBuilder", - "appstream:StopImageBuilder", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "read": { - "permissions": [ - "appstream:CreateImageBuilder", - "appstream:CreateImageBuilderStreamingURL", - "appstream:CreateStreamingURL", - "appstream:DeleteImageBuilder", - "appstream:DescribeImageBuilders", - "appstream:StartImageBuilder", - "appstream:StopImageBuilder", - "iam:CreateServiceLinkedRole", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AccessEndpoints": { - "items": { - "$ref": "#/definitions/AccessEndpoint" - }, - "type": "array", - "uniqueItems": false - }, - "AppstreamAgentVersion": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "DomainJoinInfo": { - "$ref": "#/definitions/DomainJoinInfo" - }, - "EnableDefaultInternetAccess": { - "type": "boolean" - }, - "IamRoleArn": { - "type": "string" - }, - "ImageArn": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "StreamingUrl": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/StreamingUrl" - ], - "required": [ - "InstanceType", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppStream::ImageBuilder" -} +{ + "additionalProperties": false, + "definitions": { + "AccessEndpoint": { + "additionalProperties": false, + "properties": { + "EndpointType": { + "type": "string" + }, + "VpceId": { + "type": "string" + } + }, + "required": [ + "EndpointType", + "VpceId" + ], + "type": "object" + }, + "DomainJoinInfo": { + "additionalProperties": false, + "properties": { + "DirectoryName": { + "type": "string" + }, + "OrganizationalUnitDistinguishedName": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::ImageBuilder", + "handlers": { + "create": { + "permissions": [ + "appstream:CreateImageBuilder", + "appstream:CreateImageBuilderStreamingURL", + "appstream:CreateStreamingURL", + "appstream:DeleteImageBuilder", + "appstream:DescribeImageBuilders", + "appstream:StartImageBuilder", + "appstream:StopImageBuilder", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "delete": { + "permissions": [ + "appstream:CreateImageBuilder", + "appstream:CreateImageBuilderStreamingURL", + "appstream:CreateStreamingURL", + "appstream:DeleteImageBuilder", + "appstream:DescribeImageBuilders", + "appstream:StartImageBuilder", + "appstream:StopImageBuilder", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "list": { + "permissions": [ + "appstream:CreateImageBuilder", + "appstream:CreateImageBuilderStreamingURL", + "appstream:CreateStreamingURL", + "appstream:DeleteImageBuilder", + "appstream:DescribeImageBuilders", + "appstream:StartImageBuilder", + "appstream:StopImageBuilder", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "read": { + "permissions": [ + "appstream:CreateImageBuilder", + "appstream:CreateImageBuilderStreamingURL", + "appstream:CreateStreamingURL", + "appstream:DeleteImageBuilder", + "appstream:DescribeImageBuilders", + "appstream:StartImageBuilder", + "appstream:StopImageBuilder", + "iam:CreateServiceLinkedRole", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AccessEndpoints": { + "items": { + "$ref": "#/definitions/AccessEndpoint" + }, + "type": "array", + "uniqueItems": false + }, + "AppstreamAgentVersion": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "DomainJoinInfo": { + "$ref": "#/definitions/DomainJoinInfo" + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "IamRoleArn": { + "type": "string" + }, + "ImageArn": { + "type": "string" + }, + "ImageName": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "StreamingUrl": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/StreamingUrl" + ], + "required": [ + "InstanceType", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppStream::ImageBuilder" +} diff --git a/schema/aws-appstream-stack.json b/schema/aws-appstream-stack.json index dea24ab..00b89f4 100644 --- a/schema/aws-appstream-stack.json +++ b/schema/aws-appstream-stack.json @@ -1,184 +1,184 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AccessEndpoint": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "type": "string" - }, - "VpceId": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "VpceId" - ], - "type": "object" - }, - "ApplicationSettings": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "SettingsGroup": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "StorageConnector": { - "additionalProperties": false, - "properties": { - "ConnectorType": { - "type": "string" - }, - "Domains": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ResourceIdentifier": { - "type": "string" - } - }, - "required": [ - "ConnectorType" - ], - "type": "object" - }, - "StreamingExperienceSettings": { - "additionalProperties": false, - "properties": { - "PreferredProtocol": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "UserSetting": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "MaximumLength": { - "type": "integer" - }, - "Permission": { - "type": "string" - } - }, - "required": [ - "Action", - "Permission" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppStream::Stack", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessEndpoints": { - "items": { - "$ref": "#/definitions/AccessEndpoint" - }, - "type": "array", - "uniqueItems": false - }, - "ApplicationSettings": { - "$ref": "#/definitions/ApplicationSettings" - }, - "AttributesToDelete": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "DeleteStorageConnectors": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "EmbedHostDomains": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "FeedbackURL": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RedirectURL": { - "type": "string" - }, - "StorageConnectors": { - "items": { - "$ref": "#/definitions/StorageConnector" - }, - "type": "array", - "uniqueItems": false - }, - "StreamingExperienceSettings": { - "$ref": "#/definitions/StreamingExperienceSettings" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserSettings": { - "items": { - "$ref": "#/definitions/UserSetting" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::AppStream::Stack" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AccessEndpoint": { + "additionalProperties": false, + "properties": { + "EndpointType": { + "type": "string" + }, + "VpceId": { + "type": "string" + } + }, + "required": [ + "EndpointType", + "VpceId" + ], + "type": "object" + }, + "ApplicationSettings": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "SettingsGroup": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "StorageConnector": { + "additionalProperties": false, + "properties": { + "ConnectorType": { + "type": "string" + }, + "Domains": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ResourceIdentifier": { + "type": "string" + } + }, + "required": [ + "ConnectorType" + ], + "type": "object" + }, + "StreamingExperienceSettings": { + "additionalProperties": false, + "properties": { + "PreferredProtocol": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "UserSetting": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "MaximumLength": { + "type": "integer" + }, + "Permission": { + "type": "string" + } + }, + "required": [ + "Action", + "Permission" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppStream::Stack", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessEndpoints": { + "items": { + "$ref": "#/definitions/AccessEndpoint" + }, + "type": "array", + "uniqueItems": false + }, + "ApplicationSettings": { + "$ref": "#/definitions/ApplicationSettings" + }, + "AttributesToDelete": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "DeleteStorageConnectors": { + "type": "boolean" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "EmbedHostDomains": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "FeedbackURL": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RedirectURL": { + "type": "string" + }, + "StorageConnectors": { + "items": { + "$ref": "#/definitions/StorageConnector" + }, + "type": "array", + "uniqueItems": false + }, + "StreamingExperienceSettings": { + "$ref": "#/definitions/StreamingExperienceSettings" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserSettings": { + "items": { + "$ref": "#/definitions/UserSetting" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::AppStream::Stack" +} diff --git a/schema/aws-appstream-stackfleetassociation.json b/schema/aws-appstream-stackfleetassociation.json index 8bb349c..30ef38b 100644 --- a/schema/aws-appstream-stackfleetassociation.json +++ b/schema/aws-appstream-stackfleetassociation.json @@ -1,26 +1,26 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::AppStream::StackFleetAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "FleetName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "StackName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FleetName", - "StackName" - ], - "typeName": "AWS::AppStream::StackFleetAssociation" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::AppStream::StackFleetAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "FleetName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "StackName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FleetName", + "StackName" + ], + "typeName": "AWS::AppStream::StackFleetAssociation" +} diff --git a/schema/aws-appstream-stackuserassociation.json b/schema/aws-appstream-stackuserassociation.json index 47f0181..a2c8a5d 100644 --- a/schema/aws-appstream-stackuserassociation.json +++ b/schema/aws-appstream-stackuserassociation.json @@ -1,39 +1,39 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StackName", - "/properties/AuthenticationType", - "/properties/SendEmailNotification", - "/properties/UserName" - ], - "description": "Resource Type definition for AWS::AppStream::StackUserAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AuthenticationType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SendEmailNotification": { - "type": "boolean" - }, - "StackName": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "StackName", - "UserName", - "AuthenticationType" - ], - "typeName": "AWS::AppStream::StackUserAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StackName", + "/properties/AuthenticationType", + "/properties/SendEmailNotification", + "/properties/UserName" + ], + "description": "Resource Type definition for AWS::AppStream::StackUserAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AuthenticationType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SendEmailNotification": { + "type": "boolean" + }, + "StackName": { + "type": "string" + }, + "UserName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "StackName", + "UserName", + "AuthenticationType" + ], + "typeName": "AWS::AppStream::StackUserAssociation" +} diff --git a/schema/aws-appstream-user.json b/schema/aws-appstream-user.json index 5156a6b..01b0221 100644 --- a/schema/aws-appstream-user.json +++ b/schema/aws-appstream-user.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FirstName", - "/properties/MessageAction", - "/properties/LastName", - "/properties/AuthenticationType", - "/properties/UserName" - ], - "description": "Resource Type definition for AWS::AppStream::User", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AuthenticationType": { - "type": "string" - }, - "FirstName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LastName": { - "type": "string" - }, - "MessageAction": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "UserName", - "AuthenticationType" - ], - "typeName": "AWS::AppStream::User" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FirstName", + "/properties/MessageAction", + "/properties/LastName", + "/properties/AuthenticationType", + "/properties/UserName" + ], + "description": "Resource Type definition for AWS::AppStream::User", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AuthenticationType": { + "type": "string" + }, + "FirstName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LastName": { + "type": "string" + }, + "MessageAction": { + "type": "string" + }, + "UserName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "UserName", + "AuthenticationType" + ], + "typeName": "AWS::AppStream::User" +} diff --git a/schema/aws-appsync-apicache.json b/schema/aws-appsync-apicache.json index 664fa02..20655c0 100644 --- a/schema/aws-appsync-apicache.json +++ b/schema/aws-appsync-apicache.json @@ -1,46 +1,46 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "description": "Resource Type definition for AWS::AppSync::ApiCache", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiCachingBehavior": { - "type": "string" - }, - "ApiId": { - "type": "string" - }, - "AtRestEncryptionEnabled": { - "type": "boolean" - }, - "HealthMetricsConfig": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "TransitEncryptionEnabled": { - "type": "boolean" - }, - "Ttl": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Type", - "ApiId", - "ApiCachingBehavior", - "Ttl" - ], - "typeName": "AWS::AppSync::ApiCache" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "description": "Resource Type definition for AWS::AppSync::ApiCache", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiCachingBehavior": { + "type": "string" + }, + "ApiId": { + "type": "string" + }, + "AtRestEncryptionEnabled": { + "type": "boolean" + }, + "HealthMetricsConfig": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "Ttl": { + "type": "number" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Type", + "ApiId", + "ApiCachingBehavior", + "Ttl" + ], + "typeName": "AWS::AppSync::ApiCache" +} diff --git a/schema/aws-appsync-apikey.json b/schema/aws-appsync-apikey.json index 71a6bbd..94eb103 100644 --- a/schema/aws-appsync-apikey.json +++ b/schema/aws-appsync-apikey.json @@ -1,39 +1,39 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "description": "Resource Type definition for AWS::AppSync::ApiKey", - "primaryIdentifier": [ - "/properties/ApiKeyId" - ], - "properties": { - "ApiId": { - "type": "string" - }, - "ApiKey": { - "type": "string" - }, - "ApiKeyId": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Expires": { - "type": "number" - } - }, - "readOnlyProperties": [ - "/properties/ApiKeyId", - "/properties/ApiKey", - "/properties/Arn" - ], - "required": [ - "ApiId" - ], - "typeName": "AWS::AppSync::ApiKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "description": "Resource Type definition for AWS::AppSync::ApiKey", + "primaryIdentifier": [ + "/properties/ApiKeyId" + ], + "properties": { + "ApiId": { + "type": "string" + }, + "ApiKey": { + "type": "string" + }, + "ApiKeyId": { + "type": "string" + }, + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Expires": { + "type": "number" + } + }, + "readOnlyProperties": [ + "/properties/ApiKeyId", + "/properties/ApiKey", + "/properties/Arn" + ], + "required": [ + "ApiId" + ], + "typeName": "AWS::AppSync::ApiKey" +} diff --git a/schema/aws-appsync-datasource.json b/schema/aws-appsync-datasource.json index f6a87a7..73bfea8 100644 --- a/schema/aws-appsync-datasource.json +++ b/schema/aws-appsync-datasource.json @@ -1,254 +1,254 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId", - "/properties/Name" - ], - "definitions": { - "AuthorizationConfig": { - "additionalProperties": false, - "properties": { - "AuthorizationType": { - "type": "string" - }, - "AwsIamConfig": { - "$ref": "#/definitions/AwsIamConfig" - } - }, - "required": [ - "AuthorizationType" - ], - "type": "object" - }, - "AwsIamConfig": { - "additionalProperties": false, - "properties": { - "SigningRegion": { - "type": "string" - }, - "SigningServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "DeltaSyncConfig": { - "additionalProperties": false, - "properties": { - "BaseTableTTL": { - "type": "string" - }, - "DeltaSyncTableName": { - "type": "string" - }, - "DeltaSyncTableTTL": { - "type": "string" - } - }, - "required": [ - "BaseTableTTL", - "DeltaSyncTableTTL", - "DeltaSyncTableName" - ], - "type": "object" - }, - "DynamoDBConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "DeltaSyncConfig": { - "$ref": "#/definitions/DeltaSyncConfig" - }, - "TableName": { - "type": "string" - }, - "UseCallerCredentials": { - "type": "boolean" - }, - "Versioned": { - "type": "boolean" - } - }, - "required": [ - "TableName", - "AwsRegion" - ], - "type": "object" - }, - "ElasticsearchConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "Endpoint": { - "type": "string" - } - }, - "required": [ - "AwsRegion", - "Endpoint" - ], - "type": "object" - }, - "EventBridgeConfig": { - "additionalProperties": false, - "properties": { - "EventBusArn": { - "type": "string" - } - }, - "required": [ - "EventBusArn" - ], - "type": "object" - }, - "HttpConfig": { - "additionalProperties": false, - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/AuthorizationConfig" - }, - "Endpoint": { - "type": "string" - } - }, - "required": [ - "Endpoint" - ], - "type": "object" - }, - "LambdaConfig": { - "additionalProperties": false, - "properties": { - "LambdaFunctionArn": { - "type": "string" - } - }, - "required": [ - "LambdaFunctionArn" - ], - "type": "object" - }, - "OpenSearchServiceConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "Endpoint": { - "type": "string" - } - }, - "required": [ - "AwsRegion", - "Endpoint" - ], - "type": "object" - }, - "RdsHttpEndpointConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "AwsSecretStoreArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DbClusterIdentifier": { - "type": "string" - }, - "Schema": { - "type": "string" - } - }, - "required": [ - "AwsRegion", - "DbClusterIdentifier", - "AwsSecretStoreArn" - ], - "type": "object" - }, - "RelationalDatabaseConfig": { - "additionalProperties": false, - "properties": { - "RdsHttpEndpointConfig": { - "$ref": "#/definitions/RdsHttpEndpointConfig" - }, - "RelationalDatabaseSourceType": { - "type": "string" - } - }, - "required": [ - "RelationalDatabaseSourceType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppSync::DataSource", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiId": { - "type": "string" - }, - "DataSourceArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DynamoDBConfig": { - "$ref": "#/definitions/DynamoDBConfig" - }, - "ElasticsearchConfig": { - "$ref": "#/definitions/ElasticsearchConfig" - }, - "EventBridgeConfig": { - "$ref": "#/definitions/EventBridgeConfig" - }, - "HttpConfig": { - "$ref": "#/definitions/HttpConfig" - }, - "Id": { - "type": "string" - }, - "LambdaConfig": { - "$ref": "#/definitions/LambdaConfig" - }, - "MetricsConfig": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OpenSearchServiceConfig": { - "$ref": "#/definitions/OpenSearchServiceConfig" - }, - "RelationalDatabaseConfig": { - "$ref": "#/definitions/RelationalDatabaseConfig" - }, - "ServiceRoleArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/DataSourceArn" - ], - "required": [ - "Type", - "ApiId", - "Name" - ], - "typeName": "AWS::AppSync::DataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId", + "/properties/Name" + ], + "definitions": { + "AuthorizationConfig": { + "additionalProperties": false, + "properties": { + "AuthorizationType": { + "type": "string" + }, + "AwsIamConfig": { + "$ref": "#/definitions/AwsIamConfig" + } + }, + "required": [ + "AuthorizationType" + ], + "type": "object" + }, + "AwsIamConfig": { + "additionalProperties": false, + "properties": { + "SigningRegion": { + "type": "string" + }, + "SigningServiceName": { + "type": "string" + } + }, + "type": "object" + }, + "DeltaSyncConfig": { + "additionalProperties": false, + "properties": { + "BaseTableTTL": { + "type": "string" + }, + "DeltaSyncTableName": { + "type": "string" + }, + "DeltaSyncTableTTL": { + "type": "string" + } + }, + "required": [ + "BaseTableTTL", + "DeltaSyncTableTTL", + "DeltaSyncTableName" + ], + "type": "object" + }, + "DynamoDBConfig": { + "additionalProperties": false, + "properties": { + "AwsRegion": { + "type": "string" + }, + "DeltaSyncConfig": { + "$ref": "#/definitions/DeltaSyncConfig" + }, + "TableName": { + "type": "string" + }, + "UseCallerCredentials": { + "type": "boolean" + }, + "Versioned": { + "type": "boolean" + } + }, + "required": [ + "TableName", + "AwsRegion" + ], + "type": "object" + }, + "ElasticsearchConfig": { + "additionalProperties": false, + "properties": { + "AwsRegion": { + "type": "string" + }, + "Endpoint": { + "type": "string" + } + }, + "required": [ + "AwsRegion", + "Endpoint" + ], + "type": "object" + }, + "EventBridgeConfig": { + "additionalProperties": false, + "properties": { + "EventBusArn": { + "type": "string" + } + }, + "required": [ + "EventBusArn" + ], + "type": "object" + }, + "HttpConfig": { + "additionalProperties": false, + "properties": { + "AuthorizationConfig": { + "$ref": "#/definitions/AuthorizationConfig" + }, + "Endpoint": { + "type": "string" + } + }, + "required": [ + "Endpoint" + ], + "type": "object" + }, + "LambdaConfig": { + "additionalProperties": false, + "properties": { + "LambdaFunctionArn": { + "type": "string" + } + }, + "required": [ + "LambdaFunctionArn" + ], + "type": "object" + }, + "OpenSearchServiceConfig": { + "additionalProperties": false, + "properties": { + "AwsRegion": { + "type": "string" + }, + "Endpoint": { + "type": "string" + } + }, + "required": [ + "AwsRegion", + "Endpoint" + ], + "type": "object" + }, + "RdsHttpEndpointConfig": { + "additionalProperties": false, + "properties": { + "AwsRegion": { + "type": "string" + }, + "AwsSecretStoreArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "DbClusterIdentifier": { + "type": "string" + }, + "Schema": { + "type": "string" + } + }, + "required": [ + "AwsRegion", + "DbClusterIdentifier", + "AwsSecretStoreArn" + ], + "type": "object" + }, + "RelationalDatabaseConfig": { + "additionalProperties": false, + "properties": { + "RdsHttpEndpointConfig": { + "$ref": "#/definitions/RdsHttpEndpointConfig" + }, + "RelationalDatabaseSourceType": { + "type": "string" + } + }, + "required": [ + "RelationalDatabaseSourceType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppSync::DataSource", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiId": { + "type": "string" + }, + "DataSourceArn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DynamoDBConfig": { + "$ref": "#/definitions/DynamoDBConfig" + }, + "ElasticsearchConfig": { + "$ref": "#/definitions/ElasticsearchConfig" + }, + "EventBridgeConfig": { + "$ref": "#/definitions/EventBridgeConfig" + }, + "HttpConfig": { + "$ref": "#/definitions/HttpConfig" + }, + "Id": { + "type": "string" + }, + "LambdaConfig": { + "$ref": "#/definitions/LambdaConfig" + }, + "MetricsConfig": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OpenSearchServiceConfig": { + "$ref": "#/definitions/OpenSearchServiceConfig" + }, + "RelationalDatabaseConfig": { + "$ref": "#/definitions/RelationalDatabaseConfig" + }, + "ServiceRoleArn": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/DataSourceArn" + ], + "required": [ + "Type", + "ApiId", + "Name" + ], + "typeName": "AWS::AppSync::DataSource" +} diff --git a/schema/aws-appsync-domainname.json b/schema/aws-appsync-domainname.json index b2614a5..37e88dd 100644 --- a/schema/aws-appsync-domainname.json +++ b/schema/aws-appsync-domainname.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/CertificateArn" - ], - "description": "Resource Type definition for AWS::AppSync::DomainName", - "handlers": { - "create": { - "permissions": [ - "appsync:CreateDomainName", - "appsync:GetDomainName", - "acm:DescribeCertificate", - "cloudfront:UpdateDistribution" - ] - }, - "delete": { - "permissions": [ - "appsync:GetDomainName", - "appsync:DeleteDomainName" - ] - }, - "list": { - "permissions": [ - "appsync:ListDomainNames" - ] - }, - "read": { - "permissions": [ - "appsync:GetDomainName" - ] - }, - "update": { - "permissions": [ - "appsync:UpdateDomainName" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName" - ], - "properties": { - "AppSyncDomainName": { - "type": "string" - }, - "CertificateArn": { - "maxLength": 2048, - "minLength": 3, - "pattern": "^arn:[a-z-]*:acm:[a-z0-9-]*:\\d{12}:certificate/[0-9A-Za-z_/-]*$", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "DomainName": { - "maxLength": 253, - "minLength": 1, - "pattern": "^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$", - "type": "string" - }, - "HostedZoneId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AppSyncDomainName", - "/properties/HostedZoneId" - ], - "required": [ - "DomainName", - "CertificateArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppSync::DomainName" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/CertificateArn" + ], + "description": "Resource Type definition for AWS::AppSync::DomainName", + "handlers": { + "create": { + "permissions": [ + "appsync:CreateDomainName", + "appsync:GetDomainName", + "acm:DescribeCertificate", + "cloudfront:UpdateDistribution" + ] + }, + "delete": { + "permissions": [ + "appsync:GetDomainName", + "appsync:DeleteDomainName" + ] + }, + "list": { + "permissions": [ + "appsync:ListDomainNames" + ] + }, + "read": { + "permissions": [ + "appsync:GetDomainName" + ] + }, + "update": { + "permissions": [ + "appsync:UpdateDomainName" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName" + ], + "properties": { + "AppSyncDomainName": { + "type": "string" + }, + "CertificateArn": { + "maxLength": 2048, + "minLength": 3, + "pattern": "^arn:[a-z-]*:acm:[a-z0-9-]*:\\d{12}:certificate/[0-9A-Za-z_/-]*$", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "DomainName": { + "maxLength": 253, + "minLength": 1, + "pattern": "^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$", + "type": "string" + }, + "HostedZoneId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AppSyncDomainName", + "/properties/HostedZoneId" + ], + "required": [ + "DomainName", + "CertificateArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppSync::DomainName" +} diff --git a/schema/aws-appsync-domainnameapiassociation.json b/schema/aws-appsync-domainnameapiassociation.json index 14d225a..1c3979a 100644 --- a/schema/aws-appsync-domainnameapiassociation.json +++ b/schema/aws-appsync-domainnameapiassociation.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "description": "Resource Type definition for AWS::AppSync::DomainNameApiAssociation", - "handlers": { - "create": { - "permissions": [ - "appsync:AssociateApi", - "appsync:GetApiAssociation" - ] - }, - "delete": { - "permissions": [ - "appsync:DisassociateApi", - "appsync:GetApiAssociation" - ] - }, - "read": { - "permissions": [ - "appsync:GetApiAssociation" - ] - }, - "update": { - "permissions": [ - "appsync:AssociateApi", - "appsync:GetApiAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApiAssociationIdentifier" - ], - "properties": { - "ApiAssociationIdentifier": { - "type": "string" - }, - "ApiId": { - "type": "string" - }, - "DomainName": { - "maxLength": 253, - "minLength": 1, - "pattern": "^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApiAssociationIdentifier" - ], - "required": [ - "DomainName", - "ApiId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppSync::DomainNameApiAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "description": "Resource Type definition for AWS::AppSync::DomainNameApiAssociation", + "handlers": { + "create": { + "permissions": [ + "appsync:AssociateApi", + "appsync:GetApiAssociation" + ] + }, + "delete": { + "permissions": [ + "appsync:DisassociateApi", + "appsync:GetApiAssociation" + ] + }, + "read": { + "permissions": [ + "appsync:GetApiAssociation" + ] + }, + "update": { + "permissions": [ + "appsync:AssociateApi", + "appsync:GetApiAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApiAssociationIdentifier" + ], + "properties": { + "ApiAssociationIdentifier": { + "type": "string" + }, + "ApiId": { + "type": "string" + }, + "DomainName": { + "maxLength": 253, + "minLength": 1, + "pattern": "^(\\*[a-z\\d-]*\\.)?([a-z\\d-]+\\.)+[a-z\\d-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApiAssociationIdentifier" + ], + "required": [ + "DomainName", + "ApiId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppSync::DomainNameApiAssociation" +} diff --git a/schema/aws-appsync-functionconfiguration.json b/schema/aws-appsync-functionconfiguration.json index 75143a4..36ec501 100644 --- a/schema/aws-appsync-functionconfiguration.json +++ b/schema/aws-appsync-functionconfiguration.json @@ -1,190 +1,190 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "definitions": { - "AppSyncRuntime": { - "additionalProperties": false, - "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.", - "properties": { - "Name": { - "description": "The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.", - "type": "string" - }, - "RuntimeVersion": { - "description": "The version of the runtime to use. Currently, the only allowed version is 1.0.0.", - "type": "string" - } - }, - "required": [ - "Name", - "RuntimeVersion" - ], - "type": "object" - }, - "LambdaConflictHandlerConfig": { - "additionalProperties": false, - "description": "The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.", - "properties": { - "LambdaConflictHandlerArn": { - "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.", - "type": "string" - } - }, - "type": "object" - }, - "SyncConfig": { - "additionalProperties": false, - "description": "Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.", - "properties": { - "ConflictDetection": { - "description": "The Conflict Detection strategy to use.", - "type": "string" - }, - "ConflictHandler": { - "description": "The Conflict Resolution strategy to perform in the event of a conflict.", - "type": "string" - }, - "LambdaConflictHandlerConfig": { - "$ref": "#/definitions/LambdaConflictHandlerConfig" - } - }, - "required": [ - "ConflictDetection" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "s3:GetObject", - "appsync:CreateFunction" - ] - }, - "delete": { - "permissions": [ - "appsync:DeleteFunction" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - } - }, - "required": [ - "ApiId" - ] - }, - "permissions": [ - "appsync:ListFunctions" - ] - }, - "read": { - "permissions": [ - "appsync:GetFunction" - ] - }, - "update": { - "permissions": [ - "s3:GetObject", - "appsync:UpdateFunction" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionArn" - ], - "properties": { - "ApiId": { - "description": "The AWS AppSync GraphQL API that you want to attach using this function.", - "type": "string" - }, - "Code": { - "description": "The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.", - "type": "string" - }, - "CodeS3Location": { - "description": "The Amazon S3 endpoint (where the code is located??).", - "type": "string" - }, - "DataSourceName": { - "description": "The name of data source this function will attach.", - "type": "string" - }, - "Description": { - "description": "The function description.", - "type": "string" - }, - "FunctionArn": { - "description": "The ARN for the function generated by the service", - "type": "string" - }, - "FunctionId": { - "description": "The unique identifier for the function generated by the service", - "type": "string" - }, - "FunctionVersion": { - "description": "The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.", - "type": "string" - }, - "MaxBatchSize": { - "description": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.", - "type": "integer" - }, - "Name": { - "description": "The name of the function.", - "type": "string" - }, - "RequestMappingTemplate": { - "description": "The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.", - "type": "string" - }, - "RequestMappingTemplateS3Location": { - "description": "Describes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.", - "type": "string" - }, - "ResponseMappingTemplate": { - "description": "The Function response mapping template.", - "type": "string" - }, - "ResponseMappingTemplateS3Location": { - "description": "The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.", - "type": "string" - }, - "Runtime": { - "$ref": "#/definitions/AppSyncRuntime", - "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." - }, - "SyncConfig": { - "$ref": "#/definitions/SyncConfig", - "description": "Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked." - } - }, - "readOnlyProperties": [ - "/properties/FunctionArn", - "/properties/FunctionId" - ], - "required": [ - "ApiId", - "DataSourceName", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppSync::FunctionConfiguration", - "writeOnlyProperties": [ - "/properties/CodeS3Location", - "/properties/ResponseMappingTemplateS3Location", - "/properties/RequestMappingTemplateS3Location" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "AppSyncRuntime": { + "additionalProperties": false, + "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.", + "properties": { + "Name": { + "description": "The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.", + "type": "string" + }, + "RuntimeVersion": { + "description": "The version of the runtime to use. Currently, the only allowed version is 1.0.0.", + "type": "string" + } + }, + "required": [ + "Name", + "RuntimeVersion" + ], + "type": "object" + }, + "LambdaConflictHandlerConfig": { + "additionalProperties": false, + "description": "The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.", + "properties": { + "LambdaConflictHandlerArn": { + "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.", + "type": "string" + } + }, + "type": "object" + }, + "SyncConfig": { + "additionalProperties": false, + "description": "Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.", + "properties": { + "ConflictDetection": { + "description": "The Conflict Detection strategy to use.", + "type": "string" + }, + "ConflictHandler": { + "description": "The Conflict Resolution strategy to perform in the event of a conflict.", + "type": "string" + }, + "LambdaConflictHandlerConfig": { + "$ref": "#/definitions/LambdaConflictHandlerConfig" + } + }, + "required": [ + "ConflictDetection" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "s3:GetObject", + "appsync:CreateFunction" + ] + }, + "delete": { + "permissions": [ + "appsync:DeleteFunction" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + } + }, + "required": [ + "ApiId" + ] + }, + "permissions": [ + "appsync:ListFunctions" + ] + }, + "read": { + "permissions": [ + "appsync:GetFunction" + ] + }, + "update": { + "permissions": [ + "s3:GetObject", + "appsync:UpdateFunction" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionArn" + ], + "properties": { + "ApiId": { + "description": "The AWS AppSync GraphQL API that you want to attach using this function.", + "type": "string" + }, + "Code": { + "description": "The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.", + "type": "string" + }, + "CodeS3Location": { + "description": "The Amazon S3 endpoint (where the code is located??).", + "type": "string" + }, + "DataSourceName": { + "description": "The name of data source this function will attach.", + "type": "string" + }, + "Description": { + "description": "The function description.", + "type": "string" + }, + "FunctionArn": { + "description": "The ARN for the function generated by the service", + "type": "string" + }, + "FunctionId": { + "description": "The unique identifier for the function generated by the service", + "type": "string" + }, + "FunctionVersion": { + "description": "The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.", + "type": "string" + }, + "MaxBatchSize": { + "description": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.", + "type": "integer" + }, + "Name": { + "description": "The name of the function.", + "type": "string" + }, + "RequestMappingTemplate": { + "description": "The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.", + "type": "string" + }, + "RequestMappingTemplateS3Location": { + "description": "Describes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.", + "type": "string" + }, + "ResponseMappingTemplate": { + "description": "The Function response mapping template.", + "type": "string" + }, + "ResponseMappingTemplateS3Location": { + "description": "The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.", + "type": "string" + }, + "Runtime": { + "$ref": "#/definitions/AppSyncRuntime", + "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." + }, + "SyncConfig": { + "$ref": "#/definitions/SyncConfig", + "description": "Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked." + } + }, + "readOnlyProperties": [ + "/properties/FunctionArn", + "/properties/FunctionId" + ], + "required": [ + "ApiId", + "DataSourceName", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppSync::FunctionConfiguration", + "writeOnlyProperties": [ + "/properties/CodeS3Location", + "/properties/ResponseMappingTemplateS3Location", + "/properties/RequestMappingTemplateS3Location" + ] +} diff --git a/schema/aws-appsync-graphqlapi.json b/schema/aws-appsync-graphqlapi.json index b2ac3db..757454b 100644 --- a/schema/aws-appsync-graphqlapi.json +++ b/schema/aws-appsync-graphqlapi.json @@ -1,250 +1,250 @@ -{ - "additionalProperties": false, - "definitions": { - "AdditionalAuthenticationProvider": { - "additionalProperties": false, - "properties": { - "AuthenticationType": { - "type": "string" - }, - "LambdaAuthorizerConfig": { - "$ref": "#/definitions/LambdaAuthorizerConfig" - }, - "OpenIDConnectConfig": { - "$ref": "#/definitions/OpenIDConnectConfig" - }, - "UserPoolConfig": { - "$ref": "#/definitions/CognitoUserPoolConfig" - } - }, - "required": [ - "AuthenticationType" - ], - "type": "object" - }, - "CognitoUserPoolConfig": { - "additionalProperties": false, - "properties": { - "AppIdClientRegex": { - "type": "string" - }, - "AwsRegion": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "EnhancedMetricsConfig": { - "additionalProperties": false, - "properties": { - "DataSourceLevelMetricsBehavior": { - "type": "string" - }, - "OperationLevelMetricsConfig": { - "type": "string" - }, - "ResolverLevelMetricsBehavior": { - "type": "string" - } - }, - "required": [ - "OperationLevelMetricsConfig", - "ResolverLevelMetricsBehavior", - "DataSourceLevelMetricsBehavior" - ], - "type": "object" - }, - "LambdaAuthorizerConfig": { - "additionalProperties": false, - "properties": { - "AuthorizerResultTtlInSeconds": { - "type": "number" - }, - "AuthorizerUri": { - "type": "string" - }, - "IdentityValidationExpression": { - "type": "string" - } - }, - "type": "object" - }, - "LogConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsRoleArn": { - "type": "string" - }, - "ExcludeVerboseContent": { - "type": "boolean" - }, - "FieldLogLevel": { - "type": "string" - } - }, - "type": "object" - }, - "OpenIDConnectConfig": { - "additionalProperties": false, - "properties": { - "AuthTTL": { - "type": "number" - }, - "ClientId": { - "type": "string" - }, - "IatTTL": { - "type": "number" - }, - "Issuer": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "UserPoolConfig": { - "additionalProperties": false, - "properties": { - "AppIdClientRegex": { - "type": "string" - }, - "AwsRegion": { - "type": "string" - }, - "DefaultAction": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AppSync::GraphQLApi", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AdditionalAuthenticationProviders": { - "items": { - "$ref": "#/definitions/AdditionalAuthenticationProvider" - }, - "type": "array", - "uniqueItems": false - }, - "ApiId": { - "type": "string" - }, - "ApiType": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "AuthenticationType": { - "type": "string" - }, - "EnhancedMetricsConfig": { - "$ref": "#/definitions/EnhancedMetricsConfig" - }, - "EnvironmentVariables": { - "type": "object" - }, - "GraphQLDns": { - "type": "string" - }, - "GraphQLEndpointArn": { - "type": "string" - }, - "GraphQLUrl": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IntrospectionConfig": { - "type": "string" - }, - "LambdaAuthorizerConfig": { - "$ref": "#/definitions/LambdaAuthorizerConfig" - }, - "LogConfig": { - "$ref": "#/definitions/LogConfig" - }, - "MergedApiExecutionRoleArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OpenIDConnectConfig": { - "$ref": "#/definitions/OpenIDConnectConfig" - }, - "OwnerContact": { - "type": "string" - }, - "QueryDepthLimit": { - "type": "integer" - }, - "RealtimeDns": { - "type": "string" - }, - "RealtimeUrl": { - "type": "string" - }, - "ResolverCountLimit": { - "type": "integer" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserPoolConfig": { - "$ref": "#/definitions/UserPoolConfig" - }, - "Visibility": { - "type": "string" - }, - "XrayEnabled": { - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/ApiId", - "/properties/GraphQLEndpointArn", - "/properties/Id", - "/properties/GraphQLDns", - "/properties/GraphQLUrl", - "/properties/RealtimeDns", - "/properties/RealtimeUrl", - "/properties/Arn" - ], - "required": [ - "Name", - "AuthenticationType" - ], - "typeName": "AWS::AppSync::GraphQLApi" -} +{ + "additionalProperties": false, + "definitions": { + "AdditionalAuthenticationProvider": { + "additionalProperties": false, + "properties": { + "AuthenticationType": { + "type": "string" + }, + "LambdaAuthorizerConfig": { + "$ref": "#/definitions/LambdaAuthorizerConfig" + }, + "OpenIDConnectConfig": { + "$ref": "#/definitions/OpenIDConnectConfig" + }, + "UserPoolConfig": { + "$ref": "#/definitions/CognitoUserPoolConfig" + } + }, + "required": [ + "AuthenticationType" + ], + "type": "object" + }, + "CognitoUserPoolConfig": { + "additionalProperties": false, + "properties": { + "AppIdClientRegex": { + "type": "string" + }, + "AwsRegion": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "type": "object" + }, + "EnhancedMetricsConfig": { + "additionalProperties": false, + "properties": { + "DataSourceLevelMetricsBehavior": { + "type": "string" + }, + "OperationLevelMetricsConfig": { + "type": "string" + }, + "ResolverLevelMetricsBehavior": { + "type": "string" + } + }, + "required": [ + "OperationLevelMetricsConfig", + "ResolverLevelMetricsBehavior", + "DataSourceLevelMetricsBehavior" + ], + "type": "object" + }, + "LambdaAuthorizerConfig": { + "additionalProperties": false, + "properties": { + "AuthorizerResultTtlInSeconds": { + "type": "number" + }, + "AuthorizerUri": { + "type": "string" + }, + "IdentityValidationExpression": { + "type": "string" + } + }, + "type": "object" + }, + "LogConfig": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsRoleArn": { + "type": "string" + }, + "ExcludeVerboseContent": { + "type": "boolean" + }, + "FieldLogLevel": { + "type": "string" + } + }, + "type": "object" + }, + "OpenIDConnectConfig": { + "additionalProperties": false, + "properties": { + "AuthTTL": { + "type": "number" + }, + "ClientId": { + "type": "string" + }, + "IatTTL": { + "type": "number" + }, + "Issuer": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "UserPoolConfig": { + "additionalProperties": false, + "properties": { + "AppIdClientRegex": { + "type": "string" + }, + "AwsRegion": { + "type": "string" + }, + "DefaultAction": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppSync::GraphQLApi", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AdditionalAuthenticationProviders": { + "items": { + "$ref": "#/definitions/AdditionalAuthenticationProvider" + }, + "type": "array", + "uniqueItems": false + }, + "ApiId": { + "type": "string" + }, + "ApiType": { + "type": "string" + }, + "Arn": { + "type": "string" + }, + "AuthenticationType": { + "type": "string" + }, + "EnhancedMetricsConfig": { + "$ref": "#/definitions/EnhancedMetricsConfig" + }, + "EnvironmentVariables": { + "type": "object" + }, + "GraphQLDns": { + "type": "string" + }, + "GraphQLEndpointArn": { + "type": "string" + }, + "GraphQLUrl": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IntrospectionConfig": { + "type": "string" + }, + "LambdaAuthorizerConfig": { + "$ref": "#/definitions/LambdaAuthorizerConfig" + }, + "LogConfig": { + "$ref": "#/definitions/LogConfig" + }, + "MergedApiExecutionRoleArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OpenIDConnectConfig": { + "$ref": "#/definitions/OpenIDConnectConfig" + }, + "OwnerContact": { + "type": "string" + }, + "QueryDepthLimit": { + "type": "integer" + }, + "RealtimeDns": { + "type": "string" + }, + "RealtimeUrl": { + "type": "string" + }, + "ResolverCountLimit": { + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserPoolConfig": { + "$ref": "#/definitions/UserPoolConfig" + }, + "Visibility": { + "type": "string" + }, + "XrayEnabled": { + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/ApiId", + "/properties/GraphQLEndpointArn", + "/properties/Id", + "/properties/GraphQLDns", + "/properties/GraphQLUrl", + "/properties/RealtimeDns", + "/properties/RealtimeUrl", + "/properties/Arn" + ], + "required": [ + "Name", + "AuthenticationType" + ], + "typeName": "AWS::AppSync::GraphQLApi" +} diff --git a/schema/aws-appsync-graphqlschema.json b/schema/aws-appsync-graphqlschema.json index 98879e0..ae18514 100644 --- a/schema/aws-appsync-graphqlschema.json +++ b/schema/aws-appsync-graphqlschema.json @@ -1,31 +1,31 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId" - ], - "description": "Resource Type definition for AWS::AppSync::GraphQLSchema", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiId": { - "type": "string" - }, - "Definition": { - "type": "string" - }, - "DefinitionS3Location": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApiId" - ], - "typeName": "AWS::AppSync::GraphQLSchema" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "description": "Resource Type definition for AWS::AppSync::GraphQLSchema", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiId": { + "type": "string" + }, + "Definition": { + "type": "string" + }, + "DefinitionS3Location": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApiId" + ], + "typeName": "AWS::AppSync::GraphQLSchema" +} diff --git a/schema/aws-appsync-resolver.json b/schema/aws-appsync-resolver.json index 957cf92..28e44c2 100644 --- a/schema/aws-appsync-resolver.json +++ b/schema/aws-appsync-resolver.json @@ -1,245 +1,245 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiId", - "/properties/FieldName", - "/properties/TypeName" - ], - "definitions": { - "AppSyncRuntime": { - "additionalProperties": false, - "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.", - "properties": { - "Name": { - "description": "The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``.", - "type": "string" - }, - "RuntimeVersion": { - "description": "The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``.", - "type": "string" - } - }, - "required": [ - "RuntimeVersion", - "Name" - ], - "type": "object" - }, - "CachingConfig": { - "additionalProperties": false, - "description": "The caching configuration for a resolver that has caching activated.", - "properties": { - "CachingKeys": { - "description": "The caching keys for a resolver that has caching activated.\n Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Ttl": { - "description": "The TTL in seconds for a resolver that has caching activated.\n Valid values are 1\u20133,600 seconds.", - "type": "number" - } - }, - "required": [ - "Ttl" - ], - "type": "object" - }, - "LambdaConflictHandlerConfig": { - "additionalProperties": false, - "description": "The ``LambdaConflictHandlerConfig`` when configuring LAMBDA as the Conflict Handler.", - "properties": { - "LambdaConflictHandlerArn": { - "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.", - "type": "string" - } - }, - "type": "object" - }, - "PipelineConfig": { - "additionalProperties": false, - "description": "Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver.\n ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.", - "properties": { - "Functions": { - "description": "A list of ``Function`` objects.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SyncConfig": { - "additionalProperties": false, - "description": "Describes a Sync configuration for a resolver.\n Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.", - "properties": { - "ConflictDetection": { - "description": "The Conflict Detection strategy to use.\n + *VERSION*: Detect conflicts based on object versions for this resolver.\n + *NONE*: Do not detect conflicts when invoking this resolver.", - "type": "string" - }, - "ConflictHandler": { - "description": "The Conflict Resolution strategy to perform in the event of a conflict.\n + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.\n + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.\n + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``.", - "type": "string" - }, - "LambdaConflictHandlerConfig": { - "$ref": "#/definitions/LambdaConflictHandlerConfig", - "description": "The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler." - } - }, - "required": [ - "ConflictDetection" - ], - "type": "object" - } - }, - "description": "The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).\n When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.\n See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "s3:GetObject", - "appsync:CreateResolver", - "appsync:GetResolver" - ] - }, - "delete": { - "permissions": [ - "appsync:DeleteResolver" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApiId": { - "$ref": "resource-schema.json#/properties/ApiId" - }, - "TypeName": { - "$ref": "resource-schema.json#/properties/TypeName" - } - }, - "required": [ - "ApiId", - "TypeName" - ] - }, - "permissions": [ - "appsync:ListResolvers" - ] - }, - "read": { - "permissions": [ - "appsync:GetResolver" - ] - }, - "update": { - "permissions": [ - "s3:GetObject", - "appsync:UpdateResolver" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResolverArn" - ], - "properties": { - "ApiId": { - "description": "The APSYlong GraphQL API to which you want to attach this resolver.", - "type": "string" - }, - "CachingConfig": { - "$ref": "#/definitions/CachingConfig", - "description": "The caching configuration for the resolver." - }, - "Code": { - "description": "The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.", - "type": "string" - }, - "CodeS3Location": { - "description": "The Amazon S3 endpoint.", - "type": "string" - }, - "DataSourceName": { - "description": "The resolver data source name.", - "type": "string" - }, - "FieldName": { - "description": "The GraphQL field on a type that invokes the resolver.", - "type": "string" - }, - "Kind": { - "description": "The resolver type.\n + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.", - "type": "string" - }, - "MaxBatchSize": { - "description": "The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.", - "type": "integer" - }, - "MetricsConfig": { - "description": "Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "PipelineConfig": { - "$ref": "#/definitions/PipelineConfig", - "description": "Functions linked with the pipeline resolver." - }, - "RequestMappingTemplate": { - "description": "The request mapping template.\n Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.", - "type": "string" - }, - "RequestMappingTemplateS3Location": { - "description": "The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", - "type": "string" - }, - "ResolverArn": { - "description": "", - "type": "string" - }, - "ResponseMappingTemplate": { - "description": "The response mapping template.", - "type": "string" - }, - "ResponseMappingTemplateS3Location": { - "description": "The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", - "type": "string" - }, - "Runtime": { - "$ref": "#/definitions/AppSyncRuntime", - "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." - }, - "SyncConfig": { - "$ref": "#/definitions/SyncConfig", - "description": "The ``SyncConfig`` for a resolver attached to a versioned data source." - }, - "TypeName": { - "description": "The GraphQL type that invokes this resolver.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResolverArn" - ], - "required": [ - "TypeName", - "ApiId", - "FieldName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appsync.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AppSync::Resolver", - "writeOnlyProperties": [ - "/properties/RequestMappingTemplateS3Location", - "/properties/ResponseMappingTemplateS3Location", - "/properties/CodeS3Location" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId", + "/properties/FieldName", + "/properties/TypeName" + ], + "definitions": { + "AppSyncRuntime": { + "additionalProperties": false, + "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.", + "properties": { + "Name": { + "description": "The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``.", + "type": "string" + }, + "RuntimeVersion": { + "description": "The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``.", + "type": "string" + } + }, + "required": [ + "RuntimeVersion", + "Name" + ], + "type": "object" + }, + "CachingConfig": { + "additionalProperties": false, + "description": "The caching configuration for a resolver that has caching activated.", + "properties": { + "CachingKeys": { + "description": "The caching keys for a resolver that has caching activated.\n Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Ttl": { + "description": "The TTL in seconds for a resolver that has caching activated.\n Valid values are 1\u20133,600 seconds.", + "type": "number" + } + }, + "required": [ + "Ttl" + ], + "type": "object" + }, + "LambdaConflictHandlerConfig": { + "additionalProperties": false, + "description": "The ``LambdaConflictHandlerConfig`` when configuring LAMBDA as the Conflict Handler.", + "properties": { + "LambdaConflictHandlerArn": { + "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.", + "type": "string" + } + }, + "type": "object" + }, + "PipelineConfig": { + "additionalProperties": false, + "description": "Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver.\n ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.", + "properties": { + "Functions": { + "description": "A list of ``Function`` objects.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SyncConfig": { + "additionalProperties": false, + "description": "Describes a Sync configuration for a resolver.\n Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.", + "properties": { + "ConflictDetection": { + "description": "The Conflict Detection strategy to use.\n + *VERSION*: Detect conflicts based on object versions for this resolver.\n + *NONE*: Do not detect conflicts when invoking this resolver.", + "type": "string" + }, + "ConflictHandler": { + "description": "The Conflict Resolution strategy to perform in the event of a conflict.\n + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.\n + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.\n + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``.", + "type": "string" + }, + "LambdaConflictHandlerConfig": { + "$ref": "#/definitions/LambdaConflictHandlerConfig", + "description": "The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler." + } + }, + "required": [ + "ConflictDetection" + ], + "type": "object" + } + }, + "description": "The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).\n When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.\n See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "s3:GetObject", + "appsync:CreateResolver", + "appsync:GetResolver" + ] + }, + "delete": { + "permissions": [ + "appsync:DeleteResolver" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApiId": { + "$ref": "resource-schema.json#/properties/ApiId" + }, + "TypeName": { + "$ref": "resource-schema.json#/properties/TypeName" + } + }, + "required": [ + "ApiId", + "TypeName" + ] + }, + "permissions": [ + "appsync:ListResolvers" + ] + }, + "read": { + "permissions": [ + "appsync:GetResolver" + ] + }, + "update": { + "permissions": [ + "s3:GetObject", + "appsync:UpdateResolver" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResolverArn" + ], + "properties": { + "ApiId": { + "description": "The APSYlong GraphQL API to which you want to attach this resolver.", + "type": "string" + }, + "CachingConfig": { + "$ref": "#/definitions/CachingConfig", + "description": "The caching configuration for the resolver." + }, + "Code": { + "description": "The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.", + "type": "string" + }, + "CodeS3Location": { + "description": "The Amazon S3 endpoint.", + "type": "string" + }, + "DataSourceName": { + "description": "The resolver data source name.", + "type": "string" + }, + "FieldName": { + "description": "The GraphQL field on a type that invokes the resolver.", + "type": "string" + }, + "Kind": { + "description": "The resolver type.\n + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.", + "type": "string" + }, + "MaxBatchSize": { + "description": "The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.", + "type": "integer" + }, + "MetricsConfig": { + "description": "Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "PipelineConfig": { + "$ref": "#/definitions/PipelineConfig", + "description": "Functions linked with the pipeline resolver." + }, + "RequestMappingTemplate": { + "description": "The request mapping template.\n Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.", + "type": "string" + }, + "RequestMappingTemplateS3Location": { + "description": "The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", + "type": "string" + }, + "ResolverArn": { + "description": "", + "type": "string" + }, + "ResponseMappingTemplate": { + "description": "The response mapping template.", + "type": "string" + }, + "ResponseMappingTemplateS3Location": { + "description": "The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", + "type": "string" + }, + "Runtime": { + "$ref": "#/definitions/AppSyncRuntime", + "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." + }, + "SyncConfig": { + "$ref": "#/definitions/SyncConfig", + "description": "The ``SyncConfig`` for a resolver attached to a versioned data source." + }, + "TypeName": { + "description": "The GraphQL type that invokes this resolver.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResolverArn" + ], + "required": [ + "TypeName", + "ApiId", + "FieldName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appsync.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AppSync::Resolver", + "writeOnlyProperties": [ + "/properties/RequestMappingTemplateS3Location", + "/properties/ResponseMappingTemplateS3Location", + "/properties/CodeS3Location" + ] +} diff --git a/schema/aws-appsync-sourceapiassociation.json b/schema/aws-appsync-sourceapiassociation.json index c88f39c..8171120 100644 --- a/schema/aws-appsync-sourceapiassociation.json +++ b/schema/aws-appsync-sourceapiassociation.json @@ -1,171 +1,171 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/SourceApiIdentifier", - "/properties/MergedApiIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceApiIdentifier", - "/properties/MergedApiIdentifier" - ], - "definitions": { - "SourceApiAssociationConfig": { - "additionalProperties": false, - "properties": { - "MergeType": { - "description": "Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.", - "enum": [ - "AUTO_MERGE", - "MANUAL_MERGE" - ], - "type": "string" - } - } - } - }, - "description": "Resource Type definition for AWS::AppSync::SourceApiAssociation", - "handlers": { - "create": { - "permissions": [ - "appsync:AssociateSourceGraphqlApi", - "appsync:AssociateMergedGraphqlApi", - "appsync:GetSourceApiAssociation" - ] - }, - "delete": { - "permissions": [ - "appsync:GetSourceApiAssociation", - "appsync:DisassociateSourceGraphqlApi", - "appsync:DisassociateMergedGraphqlApi", - "appsync:ListSourceApiAssociations" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "MergedApiIdentifier": { - "$ref": "resource-schema.json#/properties/MergedApiIdentifier" - }, - "SourceApiIdentifier": { - "$ref": "resource-schema.json#/properties/SourceApiIdentifier" - } - }, - "required": [ - "SourceApiIdentifier", - "MergedApiIdentifier" - ] - }, - "permissions": [ - "appsync:ListSourceApiAssociations" - ] - }, - "read": { - "permissions": [ - "appsync:GetSourceApiAssociation", - "appsync:ListSourceApiAssociations" - ] - }, - "update": { - "permissions": [ - "appsync:GetSourceApiAssociation", - "appsync:UpdateSourceApiAssociation", - "appsync:GetSourceApiAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationArn" - ], - "properties": { - "AssociationArn": { - "description": "ARN of the SourceApiAssociation.", - "type": "string" - }, - "AssociationId": { - "description": "Id of the SourceApiAssociation.", - "type": "string" - }, - "Description": { - "description": "Description of the SourceApiAssociation.", - "type": "string" - }, - "LastSuccessfulMergeDate": { - "description": "Date of last schema successful merge.", - "format": "date-time", - "type": "string" - }, - "MergedApiArn": { - "description": "ARN of the Merged API in the association.", - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "MergedApiId": { - "description": "GraphQLApiId of the Merged API in the association.", - "type": "string" - }, - "MergedApiIdentifier": { - "description": "Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN", - "type": "string" - }, - "SourceApiArn": { - "description": "ARN of the source API in the association.", - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "SourceApiAssociationConfig": { - "$ref": "#/definitions/SourceApiAssociationConfig", - "description": "Customized configuration for SourceApiAssociation." - }, - "SourceApiAssociationStatus": { - "description": "Current status of SourceApiAssociation.", - "enum": [ - "MERGE_SCHEDULED", - "MERGE_FAILED", - "MERGE_SUCCESS", - "MERGE_IN_PROGRESS", - "AUTO_MERGE_SCHEDULE_FAILED", - "DELETION_SCHEDULED", - "DELETION_IN_PROGRESS", - "DELETION_FAILED" - ], - "type": "string" - }, - "SourceApiAssociationStatusDetail": { - "description": "Current SourceApiAssociation status details.", - "type": "string" - }, - "SourceApiId": { - "description": "GraphQLApiId of the source API in the association.", - "type": "string" - }, - "SourceApiIdentifier": { - "description": "Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId", - "/properties/AssociationArn", - "/properties/SourceApiId", - "/properties/SourceApiArn", - "/properties/MergedApiId", - "/properties/MergedApiArn", - "/properties/SourceApiAssociationStatus", - "/properties/SourceApiAssociationStatusDetail", - "/properties/LastSuccessfulMergeDate" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appsync", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AppSync::SourceApiAssociation", - "writeOnlyProperties": [ - "/properties/SourceApiIdentifier", - "/properties/MergedApiIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/SourceApiIdentifier", + "/properties/MergedApiIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceApiIdentifier", + "/properties/MergedApiIdentifier" + ], + "definitions": { + "SourceApiAssociationConfig": { + "additionalProperties": false, + "properties": { + "MergeType": { + "description": "Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.", + "enum": [ + "AUTO_MERGE", + "MANUAL_MERGE" + ], + "type": "string" + } + } + } + }, + "description": "Resource Type definition for AWS::AppSync::SourceApiAssociation", + "handlers": { + "create": { + "permissions": [ + "appsync:AssociateSourceGraphqlApi", + "appsync:AssociateMergedGraphqlApi", + "appsync:GetSourceApiAssociation" + ] + }, + "delete": { + "permissions": [ + "appsync:GetSourceApiAssociation", + "appsync:DisassociateSourceGraphqlApi", + "appsync:DisassociateMergedGraphqlApi", + "appsync:ListSourceApiAssociations" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MergedApiIdentifier": { + "$ref": "resource-schema.json#/properties/MergedApiIdentifier" + }, + "SourceApiIdentifier": { + "$ref": "resource-schema.json#/properties/SourceApiIdentifier" + } + }, + "required": [ + "SourceApiIdentifier", + "MergedApiIdentifier" + ] + }, + "permissions": [ + "appsync:ListSourceApiAssociations" + ] + }, + "read": { + "permissions": [ + "appsync:GetSourceApiAssociation", + "appsync:ListSourceApiAssociations" + ] + }, + "update": { + "permissions": [ + "appsync:GetSourceApiAssociation", + "appsync:UpdateSourceApiAssociation", + "appsync:GetSourceApiAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationArn" + ], + "properties": { + "AssociationArn": { + "description": "ARN of the SourceApiAssociation.", + "type": "string" + }, + "AssociationId": { + "description": "Id of the SourceApiAssociation.", + "type": "string" + }, + "Description": { + "description": "Description of the SourceApiAssociation.", + "type": "string" + }, + "LastSuccessfulMergeDate": { + "description": "Date of last schema successful merge.", + "format": "date-time", + "type": "string" + }, + "MergedApiArn": { + "description": "ARN of the Merged API in the association.", + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "MergedApiId": { + "description": "GraphQLApiId of the Merged API in the association.", + "type": "string" + }, + "MergedApiIdentifier": { + "description": "Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN", + "type": "string" + }, + "SourceApiArn": { + "description": "ARN of the source API in the association.", + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "SourceApiAssociationConfig": { + "$ref": "#/definitions/SourceApiAssociationConfig", + "description": "Customized configuration for SourceApiAssociation." + }, + "SourceApiAssociationStatus": { + "description": "Current status of SourceApiAssociation.", + "enum": [ + "MERGE_SCHEDULED", + "MERGE_FAILED", + "MERGE_SUCCESS", + "MERGE_IN_PROGRESS", + "AUTO_MERGE_SCHEDULE_FAILED", + "DELETION_SCHEDULED", + "DELETION_IN_PROGRESS", + "DELETION_FAILED" + ], + "type": "string" + }, + "SourceApiAssociationStatusDetail": { + "description": "Current SourceApiAssociation status details.", + "type": "string" + }, + "SourceApiId": { + "description": "GraphQLApiId of the source API in the association.", + "type": "string" + }, + "SourceApiIdentifier": { + "description": "Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId", + "/properties/AssociationArn", + "/properties/SourceApiId", + "/properties/SourceApiArn", + "/properties/MergedApiId", + "/properties/MergedApiArn", + "/properties/SourceApiAssociationStatus", + "/properties/SourceApiAssociationStatusDetail", + "/properties/LastSuccessfulMergeDate" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appsync", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AppSync::SourceApiAssociation", + "writeOnlyProperties": [ + "/properties/SourceApiIdentifier", + "/properties/MergedApiIdentifier" + ] +} diff --git a/schema/aws-apptest-testcase.json b/schema/aws-apptest-testcase.json index 3431cca..b00397a 100644 --- a/schema/aws-apptest-testcase.json +++ b/schema/aws-apptest-testcase.json @@ -1,713 +1,713 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Batch": { - "additionalProperties": false, - "properties": { - "BatchJobName": { - "pattern": "^\\S{1,1000}$", - "type": "string" - }, - "BatchJobParameters": { - "$ref": "#/definitions/BatchJobParameters" - }, - "ExportDataSetNames": { - "items": { - "pattern": "^\\S{1,100}$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "BatchJobName" - ], - "type": "object" - }, - "BatchJobParameters": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "CaptureTool": { - "enum": [ - "Precisely", - "AWS DMS" - ], - "type": "string" - }, - "CloudFormationAction": { - "additionalProperties": false, - "properties": { - "ActionType": { - "$ref": "#/definitions/CloudFormationActionType" - }, - "Resource": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "required": [ - "Resource" - ], - "type": "object" - }, - "CloudFormationActionType": { - "enum": [ - "Create", - "Delete" - ], - "type": "string" - }, - "CompareAction": { - "additionalProperties": false, - "properties": { - "Input": { - "$ref": "#/definitions/Input" - }, - "Output": { - "$ref": "#/definitions/Output" - } - }, - "required": [ - "Input" - ], - "type": "object" - }, - "DataSet": { - "additionalProperties": false, - "properties": { - "Ccsid": { - "pattern": "^\\S{1,50}$", - "type": "string" - }, - "Format": { - "$ref": "#/definitions/Format" - }, - "Length": { - "type": "number" - }, - "Name": { - "pattern": "^\\S{1,100}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/DataSetType" - } - }, - "required": [ - "Ccsid", - "Format", - "Length", - "Name", - "Type" - ], - "type": "object" - }, - "DataSetType": { - "enum": [ - "PS" - ], - "type": "string" - }, - "DatabaseCDC": { - "additionalProperties": false, - "properties": { - "SourceMetadata": { - "$ref": "#/definitions/SourceDatabaseMetadata" - }, - "TargetMetadata": { - "$ref": "#/definitions/TargetDatabaseMetadata" - } - }, - "required": [ - "SourceMetadata", - "TargetMetadata" - ], - "type": "object" - }, - "FileMetadata": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "DataSets": { - "items": { - "$ref": "#/definitions/DataSet" - }, - "type": "array" - } - }, - "required": [ - "DataSets" - ], - "title": "DataSets", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "DatabaseCDC": { - "$ref": "#/definitions/DatabaseCDC" - } - }, - "required": [ - "DatabaseCDC" - ], - "title": "DatabaseCDC", - "type": "object" - } - ] - }, - "Format": { - "enum": [ - "FIXED", - "VARIABLE", - "LINE_SEQUENTIAL" - ], - "type": "string" - }, - "Input": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/InputFile" - } - }, - "required": [ - "File" - ], - "title": "File", - "type": "object" - } - ] - }, - "InputFile": { - "additionalProperties": false, - "properties": { - "FileMetadata": { - "$ref": "#/definitions/FileMetadata" - }, - "SourceLocation": { - "pattern": "^\\S{1,1000}$", - "type": "string" - }, - "TargetLocation": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "required": [ - "FileMetadata", - "SourceLocation", - "TargetLocation" - ], - "type": "object" - }, - "M2ManagedActionProperties": { - "additionalProperties": false, - "properties": { - "ForceStop": { - "type": "boolean" - }, - "ImportDataSetLocation": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "type": "object" - }, - "M2ManagedActionType": { - "enum": [ - "Configure", - "Deconfigure" - ], - "type": "string" - }, - "M2ManagedApplicationAction": { - "additionalProperties": false, - "properties": { - "ActionType": { - "$ref": "#/definitions/M2ManagedActionType" - }, - "Properties": { - "$ref": "#/definitions/M2ManagedActionProperties" - }, - "Resource": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "required": [ - "ActionType", - "Resource" - ], - "type": "object" - }, - "M2NonManagedActionType": { - "enum": [ - "Configure", - "Deconfigure" - ], - "type": "string" - }, - "M2NonManagedApplicationAction": { - "additionalProperties": false, - "properties": { - "ActionType": { - "$ref": "#/definitions/M2NonManagedActionType" - }, - "Resource": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "required": [ - "ActionType", - "Resource" - ], - "type": "object" - }, - "MainframeAction": { - "additionalProperties": false, - "properties": { - "ActionType": { - "$ref": "#/definitions/MainframeActionType" - }, - "Properties": { - "$ref": "#/definitions/MainframeActionProperties" - }, - "Resource": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "required": [ - "ActionType", - "Resource" - ], - "type": "object" - }, - "MainframeActionProperties": { - "additionalProperties": false, - "properties": { - "DmsTaskArn": { - "pattern": "^\\S{1,1000}$", - "type": "string" - } - }, - "type": "object" - }, - "MainframeActionType": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Batch": { - "$ref": "#/definitions/Batch" - } - }, - "required": [ - "Batch" - ], - "title": "Batch", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Tn3270": { - "$ref": "#/definitions/TN3270" - } - }, - "required": [ - "Tn3270" - ], - "title": "Tn3270", - "type": "object" - } - ] - }, - "Output": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/OutputFile" - } - }, - "required": [ - "File" - ], - "title": "File", - "type": "object" - } - ] - }, - "OutputFile": { - "additionalProperties": false, - "properties": { - "FileLocation": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "ResourceAction": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "M2ManagedApplicationAction": { - "$ref": "#/definitions/M2ManagedApplicationAction" - } - }, - "required": [ - "M2ManagedApplicationAction" - ], - "title": "M2ManagedApplicationAction", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "M2NonManagedApplicationAction": { - "$ref": "#/definitions/M2NonManagedApplicationAction" - } - }, - "required": [ - "M2NonManagedApplicationAction" - ], - "title": "M2NonManagedApplicationAction", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "CloudFormationAction": { - "$ref": "#/definitions/CloudFormationAction" - } - }, - "required": [ - "CloudFormationAction" - ], - "title": "CloudFormationAction", - "type": "object" - } - ] - }, - "Script": { - "additionalProperties": false, - "properties": { - "ScriptLocation": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/ScriptType" - } - }, - "required": [ - "ScriptLocation", - "Type" - ], - "type": "object" - }, - "ScriptType": { - "enum": [ - "Selenium" - ], - "type": "string" - }, - "SourceDatabase": { - "enum": [ - "z/OS-DB2" - ], - "type": "string" - }, - "SourceDatabaseMetadata": { - "additionalProperties": false, - "properties": { - "CaptureTool": { - "$ref": "#/definitions/CaptureTool" - }, - "Type": { - "$ref": "#/definitions/SourceDatabase" - } - }, - "required": [ - "CaptureTool", - "Type" - ], - "type": "object" - }, - "Step": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/StepAction" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "Name": { - "pattern": "^[A-Za-z][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - } - }, - "required": [ - "Action", - "Name" - ], - "type": "object" - }, - "StepAction": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "ResourceAction": { - "$ref": "#/definitions/ResourceAction" - } - }, - "required": [ - "ResourceAction" - ], - "title": "ResourceAction", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "MainframeAction": { - "$ref": "#/definitions/MainframeAction" - } - }, - "required": [ - "MainframeAction" - ], - "title": "MainframeAction", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "CompareAction": { - "$ref": "#/definitions/CompareAction" - } - }, - "required": [ - "CompareAction" - ], - "title": "CompareAction", - "type": "object" - } - ] - }, - "TN3270": { - "additionalProperties": false, - "properties": { - "ExportDataSetNames": { - "items": { - "pattern": "^\\S{1,100}$", - "type": "string" - }, - "type": "array" - }, - "Script": { - "$ref": "#/definitions/Script" - } - }, - "required": [ - "Script" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 200, - "minProperties": 0, - "patternProperties": { - "^(?!aws:).+$": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TargetDatabase": { - "enum": [ - "PostgreSQL" - ], - "type": "string" - }, - "TargetDatabaseMetadata": { - "additionalProperties": false, - "properties": { - "CaptureTool": { - "$ref": "#/definitions/CaptureTool" - }, - "Type": { - "$ref": "#/definitions/TargetDatabase" - } - }, - "required": [ - "CaptureTool", - "Type" - ], - "type": "object" - }, - "TestCaseLatestVersion": { - "additionalProperties": false, - "properties": { - "Status": { - "$ref": "#/definitions/TestCaseLifecycle" - }, - "Version": { - "type": "number" - } - }, - "required": [ - "Status", - "Version" - ], - "type": "object" - }, - "TestCaseLifecycle": { - "enum": [ - "Active", - "Deleting" - ], - "type": "string" - } - }, - "description": "Represents a Test Case that can be captured and executed", - "handlers": { - "create": { - "permissions": [ - "apptest:CreateTestCase", - "apptest:GetTestCase", - "apptest:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "apptest:GetTestCase", - "apptest:ListTagsForResource", - "apptest:DeleteTestCase" - ] - }, - "list": { - "permissions": [ - "apptest:ListTestCases" - ] - }, - "read": { - "permissions": [ - "apptest:GetTestCase", - "apptest:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "apptest:UpdateTestCase", - "apptest:GetTestCase", - "apptest:TagResource", - "apptest:UnTagResource", - "apptest:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/TestCaseId" - ], - "properties": { - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "LastUpdateTime": { - "format": "date-time", - "type": "string" - }, - "LatestVersion": { - "$ref": "#/definitions/TestCaseLatestVersion" - }, - "Name": { - "pattern": "^[A-Za-z][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/TestCaseLifecycle" - }, - "Steps": { - "items": { - "$ref": "#/definitions/Step" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "TestCaseArn": { - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "TestCaseId": { - "pattern": "^[A-Za-z0-9:/\\-]{1,100}$", - "type": "string" - }, - "TestCaseVersion": { - "type": "number" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/LastUpdateTime", - "/properties/LatestVersion", - "/properties/Status", - "/properties/TestCaseArn", - "/properties/TestCaseId", - "/properties/TestCaseVersion" - ], - "required": [ - "Name", - "Steps" - ], - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "apptest:TagResource", - "apptest:UntagResource", - "apptest:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AppTest::TestCase" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Batch": { + "additionalProperties": false, + "properties": { + "BatchJobName": { + "pattern": "^\\S{1,1000}$", + "type": "string" + }, + "BatchJobParameters": { + "$ref": "#/definitions/BatchJobParameters" + }, + "ExportDataSetNames": { + "items": { + "pattern": "^\\S{1,100}$", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "BatchJobName" + ], + "type": "object" + }, + "BatchJobParameters": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "CaptureTool": { + "enum": [ + "Precisely", + "AWS DMS" + ], + "type": "string" + }, + "CloudFormationAction": { + "additionalProperties": false, + "properties": { + "ActionType": { + "$ref": "#/definitions/CloudFormationActionType" + }, + "Resource": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "required": [ + "Resource" + ], + "type": "object" + }, + "CloudFormationActionType": { + "enum": [ + "Create", + "Delete" + ], + "type": "string" + }, + "CompareAction": { + "additionalProperties": false, + "properties": { + "Input": { + "$ref": "#/definitions/Input" + }, + "Output": { + "$ref": "#/definitions/Output" + } + }, + "required": [ + "Input" + ], + "type": "object" + }, + "DataSet": { + "additionalProperties": false, + "properties": { + "Ccsid": { + "pattern": "^\\S{1,50}$", + "type": "string" + }, + "Format": { + "$ref": "#/definitions/Format" + }, + "Length": { + "type": "number" + }, + "Name": { + "pattern": "^\\S{1,100}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/DataSetType" + } + }, + "required": [ + "Ccsid", + "Format", + "Length", + "Name", + "Type" + ], + "type": "object" + }, + "DataSetType": { + "enum": [ + "PS" + ], + "type": "string" + }, + "DatabaseCDC": { + "additionalProperties": false, + "properties": { + "SourceMetadata": { + "$ref": "#/definitions/SourceDatabaseMetadata" + }, + "TargetMetadata": { + "$ref": "#/definitions/TargetDatabaseMetadata" + } + }, + "required": [ + "SourceMetadata", + "TargetMetadata" + ], + "type": "object" + }, + "FileMetadata": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "DataSets": { + "items": { + "$ref": "#/definitions/DataSet" + }, + "type": "array" + } + }, + "required": [ + "DataSets" + ], + "title": "DataSets", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "DatabaseCDC": { + "$ref": "#/definitions/DatabaseCDC" + } + }, + "required": [ + "DatabaseCDC" + ], + "title": "DatabaseCDC", + "type": "object" + } + ] + }, + "Format": { + "enum": [ + "FIXED", + "VARIABLE", + "LINE_SEQUENTIAL" + ], + "type": "string" + }, + "Input": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/InputFile" + } + }, + "required": [ + "File" + ], + "title": "File", + "type": "object" + } + ] + }, + "InputFile": { + "additionalProperties": false, + "properties": { + "FileMetadata": { + "$ref": "#/definitions/FileMetadata" + }, + "SourceLocation": { + "pattern": "^\\S{1,1000}$", + "type": "string" + }, + "TargetLocation": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "required": [ + "FileMetadata", + "SourceLocation", + "TargetLocation" + ], + "type": "object" + }, + "M2ManagedActionProperties": { + "additionalProperties": false, + "properties": { + "ForceStop": { + "type": "boolean" + }, + "ImportDataSetLocation": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "type": "object" + }, + "M2ManagedActionType": { + "enum": [ + "Configure", + "Deconfigure" + ], + "type": "string" + }, + "M2ManagedApplicationAction": { + "additionalProperties": false, + "properties": { + "ActionType": { + "$ref": "#/definitions/M2ManagedActionType" + }, + "Properties": { + "$ref": "#/definitions/M2ManagedActionProperties" + }, + "Resource": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "required": [ + "ActionType", + "Resource" + ], + "type": "object" + }, + "M2NonManagedActionType": { + "enum": [ + "Configure", + "Deconfigure" + ], + "type": "string" + }, + "M2NonManagedApplicationAction": { + "additionalProperties": false, + "properties": { + "ActionType": { + "$ref": "#/definitions/M2NonManagedActionType" + }, + "Resource": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "required": [ + "ActionType", + "Resource" + ], + "type": "object" + }, + "MainframeAction": { + "additionalProperties": false, + "properties": { + "ActionType": { + "$ref": "#/definitions/MainframeActionType" + }, + "Properties": { + "$ref": "#/definitions/MainframeActionProperties" + }, + "Resource": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "required": [ + "ActionType", + "Resource" + ], + "type": "object" + }, + "MainframeActionProperties": { + "additionalProperties": false, + "properties": { + "DmsTaskArn": { + "pattern": "^\\S{1,1000}$", + "type": "string" + } + }, + "type": "object" + }, + "MainframeActionType": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Batch": { + "$ref": "#/definitions/Batch" + } + }, + "required": [ + "Batch" + ], + "title": "Batch", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Tn3270": { + "$ref": "#/definitions/TN3270" + } + }, + "required": [ + "Tn3270" + ], + "title": "Tn3270", + "type": "object" + } + ] + }, + "Output": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "File": { + "$ref": "#/definitions/OutputFile" + } + }, + "required": [ + "File" + ], + "title": "File", + "type": "object" + } + ] + }, + "OutputFile": { + "additionalProperties": false, + "properties": { + "FileLocation": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "ResourceAction": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "M2ManagedApplicationAction": { + "$ref": "#/definitions/M2ManagedApplicationAction" + } + }, + "required": [ + "M2ManagedApplicationAction" + ], + "title": "M2ManagedApplicationAction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "M2NonManagedApplicationAction": { + "$ref": "#/definitions/M2NonManagedApplicationAction" + } + }, + "required": [ + "M2NonManagedApplicationAction" + ], + "title": "M2NonManagedApplicationAction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "CloudFormationAction": { + "$ref": "#/definitions/CloudFormationAction" + } + }, + "required": [ + "CloudFormationAction" + ], + "title": "CloudFormationAction", + "type": "object" + } + ] + }, + "Script": { + "additionalProperties": false, + "properties": { + "ScriptLocation": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/ScriptType" + } + }, + "required": [ + "ScriptLocation", + "Type" + ], + "type": "object" + }, + "ScriptType": { + "enum": [ + "Selenium" + ], + "type": "string" + }, + "SourceDatabase": { + "enum": [ + "z/OS-DB2" + ], + "type": "string" + }, + "SourceDatabaseMetadata": { + "additionalProperties": false, + "properties": { + "CaptureTool": { + "$ref": "#/definitions/CaptureTool" + }, + "Type": { + "$ref": "#/definitions/SourceDatabase" + } + }, + "required": [ + "CaptureTool", + "Type" + ], + "type": "object" + }, + "Step": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/StepAction" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "Name": { + "pattern": "^[A-Za-z][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + } + }, + "required": [ + "Action", + "Name" + ], + "type": "object" + }, + "StepAction": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "ResourceAction": { + "$ref": "#/definitions/ResourceAction" + } + }, + "required": [ + "ResourceAction" + ], + "title": "ResourceAction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "MainframeAction": { + "$ref": "#/definitions/MainframeAction" + } + }, + "required": [ + "MainframeAction" + ], + "title": "MainframeAction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "CompareAction": { + "$ref": "#/definitions/CompareAction" + } + }, + "required": [ + "CompareAction" + ], + "title": "CompareAction", + "type": "object" + } + ] + }, + "TN3270": { + "additionalProperties": false, + "properties": { + "ExportDataSetNames": { + "items": { + "pattern": "^\\S{1,100}$", + "type": "string" + }, + "type": "array" + }, + "Script": { + "$ref": "#/definitions/Script" + } + }, + "required": [ + "Script" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 200, + "minProperties": 0, + "patternProperties": { + "^(?!aws:).+$": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TargetDatabase": { + "enum": [ + "PostgreSQL" + ], + "type": "string" + }, + "TargetDatabaseMetadata": { + "additionalProperties": false, + "properties": { + "CaptureTool": { + "$ref": "#/definitions/CaptureTool" + }, + "Type": { + "$ref": "#/definitions/TargetDatabase" + } + }, + "required": [ + "CaptureTool", + "Type" + ], + "type": "object" + }, + "TestCaseLatestVersion": { + "additionalProperties": false, + "properties": { + "Status": { + "$ref": "#/definitions/TestCaseLifecycle" + }, + "Version": { + "type": "number" + } + }, + "required": [ + "Status", + "Version" + ], + "type": "object" + }, + "TestCaseLifecycle": { + "enum": [ + "Active", + "Deleting" + ], + "type": "string" + } + }, + "description": "Represents a Test Case that can be captured and executed", + "handlers": { + "create": { + "permissions": [ + "apptest:CreateTestCase", + "apptest:GetTestCase", + "apptest:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "apptest:GetTestCase", + "apptest:ListTagsForResource", + "apptest:DeleteTestCase" + ] + }, + "list": { + "permissions": [ + "apptest:ListTestCases" + ] + }, + "read": { + "permissions": [ + "apptest:GetTestCase", + "apptest:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "apptest:UpdateTestCase", + "apptest:GetTestCase", + "apptest:TagResource", + "apptest:UnTagResource", + "apptest:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TestCaseId" + ], + "properties": { + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "LastUpdateTime": { + "format": "date-time", + "type": "string" + }, + "LatestVersion": { + "$ref": "#/definitions/TestCaseLatestVersion" + }, + "Name": { + "pattern": "^[A-Za-z][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/TestCaseLifecycle" + }, + "Steps": { + "items": { + "$ref": "#/definitions/Step" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "TestCaseArn": { + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "TestCaseId": { + "pattern": "^[A-Za-z0-9:/\\-]{1,100}$", + "type": "string" + }, + "TestCaseVersion": { + "type": "number" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/LastUpdateTime", + "/properties/LatestVersion", + "/properties/Status", + "/properties/TestCaseArn", + "/properties/TestCaseId", + "/properties/TestCaseVersion" + ], + "required": [ + "Name", + "Steps" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "apptest:TagResource", + "apptest:UntagResource", + "apptest:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppTest::TestCase" +} diff --git a/schema/aws-aps-rulegroupsnamespace.json b/schema/aws-aps-rulegroupsnamespace.json index dbcf916..e8b5e49 100644 --- a/schema/aws-aps-rulegroupsnamespace.json +++ b/schema/aws-aps-rulegroupsnamespace.json @@ -1,130 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Workspace" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "RuleGroupsNamespace schema for cloudformation.", - "handlers": { - "create": { - "permissions": [ - "aps:CreateRuleGroupsNamespace", - "aps:DescribeRuleGroupsNamespace", - "aps:TagResource" - ] - }, - "delete": { - "permissions": [ - "aps:DeleteRuleGroupsNamespace", - "aps:DescribeRuleGroupsNamespace" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/Workspace" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "aps:ListRuleGroupsNamespaces", - "aps:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "aps:DescribeRuleGroupsNamespace", - "aps:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "aps:PutRuleGroupsNamespace", - "aps:DescribeRuleGroupsNamespace", - "aps:TagResource", - "aps:UntagResource", - "aps:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The RuleGroupsNamespace ARN.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:rulegroupsnamespace/[a-zA-Z0-9-]+/[0-9A-Za-z][-.0-9A-Z_a-z]*$", - "type": "string" - }, - "Data": { - "description": "The RuleGroupsNamespace data.", - "type": "string" - }, - "Name": { - "description": "The RuleGroupsNamespace name.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Workspace": { - "description": "Required to identify a specific APS Workspace associated with this RuleGroupsNamespace.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Workspace", - "Data", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::APS::RuleGroupsNamespace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Workspace" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "RuleGroupsNamespace schema for cloudformation.", + "handlers": { + "create": { + "permissions": [ + "aps:CreateRuleGroupsNamespace", + "aps:DescribeRuleGroupsNamespace", + "aps:TagResource" + ] + }, + "delete": { + "permissions": [ + "aps:DeleteRuleGroupsNamespace", + "aps:DescribeRuleGroupsNamespace" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Workspace" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "aps:ListRuleGroupsNamespaces", + "aps:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "aps:DescribeRuleGroupsNamespace", + "aps:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "aps:PutRuleGroupsNamespace", + "aps:DescribeRuleGroupsNamespace", + "aps:TagResource", + "aps:UntagResource", + "aps:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The RuleGroupsNamespace ARN.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:rulegroupsnamespace/[a-zA-Z0-9-]+/[0-9A-Za-z][-.0-9A-Z_a-z]*$", + "type": "string" + }, + "Data": { + "description": "The RuleGroupsNamespace data.", + "type": "string" + }, + "Name": { + "description": "The RuleGroupsNamespace name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Workspace": { + "description": "Required to identify a specific APS Workspace associated with this RuleGroupsNamespace.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Workspace", + "Data", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::APS::RuleGroupsNamespace" +} diff --git a/schema/aws-aps-scraper.json b/schema/aws-aps-scraper.json index 6b6a108..9323139 100644 --- a/schema/aws-aps-scraper.json +++ b/schema/aws-aps-scraper.json @@ -1,254 +1,254 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ScrapeConfiguration", - "/properties/Source", - "/properties/Destination", - "/properties/Alias" - ], - "definitions": { - "Destination": { - "additionalProperties": false, - "description": "Scraper metrics destination", - "oneOf": [ - { - "required": [ - "AmpConfiguration" - ] - } - ], - "properties": { - "AmpConfiguration": { - "additionalProperties": false, - "description": "Configuration for Amazon Managed Prometheus metrics destination", - "properties": { - "WorkspaceArn": { - "description": "ARN of an Amazon Managed Prometheus workspace", - "pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$", - "type": "string" - } - }, - "required": [ - "WorkspaceArn" - ], - "type": "object" - } - }, - "type": "object" - }, - "ScrapeConfiguration": { - "additionalProperties": false, - "description": "Scraper configuration", - "oneOf": [ - { - "required": [ - "ConfigurationBlob" - ] - } - ], - "properties": { - "ConfigurationBlob": { - "description": "Prometheus compatible scrape configuration in base64 encoded blob format", - "type": "string" - } - }, - "type": "object" - }, - "SecurityGroupId": { - "description": "ID of a security group", - "pattern": "^sg-[0-9a-z]+$", - "type": "string" - }, - "Source": { - "additionalProperties": false, - "description": "Scraper metrics source", - "oneOf": [ - { - "required": [ - "EksConfiguration" - ] - } - ], - "properties": { - "EksConfiguration": { - "additionalProperties": false, - "description": "Configuration for EKS metrics source", - "properties": { - "ClusterArn": { - "description": "ARN of an EKS cluster", - "pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$", - "type": "string" - }, - "SecurityGroupIds": { - "description": "List of security group IDs", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "type": "array" - }, - "SubnetIds": { - "description": "List of subnet IDs", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetId" - }, - "type": "array" - } - }, - "required": [ - "ClusterArn", - "SubnetIds" - ], - "type": "object" - } - }, - "type": "object" - }, - "SubnetId": { - "description": "ID of a subnet", - "pattern": "^subnet-[0-9a-z]+$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::APS::Scraper", - "handlers": { - "create": { - "permissions": [ - "aps:CreateScraper", - "aps:DescribeScraper", - "aps:DescribeWorkspace", - "aps:TagResource", - "eks:CreateAccessEntry", - "eks:AssociateAccessPolicy", - "eks:DescribeCluster", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "aps:DeleteScraper", - "aps:DescribeScraper", - "aps:DescribeWorkspace", - "eks:AssociateAccessPolicy", - "eks:DescribeCluster", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "iam:DeleteServiceLinkedRole" - ] - }, - "list": { - "permissions": [ - "aps:ListScrapers", - "aps:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "aps:DescribeScraper", - "aps:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "aps:DescribeScraper", - "aps:TagResource", - "aps:UntagResource", - "aps:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Alias": { - "description": "Scraper alias.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$", - "type": "string" - }, - "Arn": { - "description": "Scraper ARN.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]+:[0-9]+:scraper/s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", - "type": "string" - }, - "Destination": { - "$ref": "#/definitions/Destination" - }, - "RoleArn": { - "description": "IAM role ARN for the scraper.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::[0-9]{12}:role/[a-zA-Z0-9-]+$", - "type": "string" - }, - "ScrapeConfiguration": { - "$ref": "#/definitions/ScrapeConfiguration" - }, - "ScraperId": { - "description": "Required to identify a specific scraper.", - "maxLength": 64, - "minLength": 1, - "pattern": "^s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", - "type": "string" - }, - "Source": { - "$ref": "#/definitions/Source" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ScraperId", - "/properties/Arn", - "/properties/RoleArn" - ], - "required": [ - "ScrapeConfiguration", - "Source", - "Destination" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::APS::Scraper" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ScrapeConfiguration", + "/properties/Source", + "/properties/Destination", + "/properties/Alias" + ], + "definitions": { + "Destination": { + "additionalProperties": false, + "description": "Scraper metrics destination", + "oneOf": [ + { + "required": [ + "AmpConfiguration" + ] + } + ], + "properties": { + "AmpConfiguration": { + "additionalProperties": false, + "description": "Configuration for Amazon Managed Prometheus metrics destination", + "properties": { + "WorkspaceArn": { + "description": "ARN of an Amazon Managed Prometheus workspace", + "pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$", + "type": "string" + } + }, + "required": [ + "WorkspaceArn" + ], + "type": "object" + } + }, + "type": "object" + }, + "ScrapeConfiguration": { + "additionalProperties": false, + "description": "Scraper configuration", + "oneOf": [ + { + "required": [ + "ConfigurationBlob" + ] + } + ], + "properties": { + "ConfigurationBlob": { + "description": "Prometheus compatible scrape configuration in base64 encoded blob format", + "type": "string" + } + }, + "type": "object" + }, + "SecurityGroupId": { + "description": "ID of a security group", + "pattern": "^sg-[0-9a-z]+$", + "type": "string" + }, + "Source": { + "additionalProperties": false, + "description": "Scraper metrics source", + "oneOf": [ + { + "required": [ + "EksConfiguration" + ] + } + ], + "properties": { + "EksConfiguration": { + "additionalProperties": false, + "description": "Configuration for EKS metrics source", + "properties": { + "ClusterArn": { + "description": "ARN of an EKS cluster", + "pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$", + "type": "string" + }, + "SecurityGroupIds": { + "description": "List of security group IDs", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "type": "array" + }, + "SubnetIds": { + "description": "List of subnet IDs", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetId" + }, + "type": "array" + } + }, + "required": [ + "ClusterArn", + "SubnetIds" + ], + "type": "object" + } + }, + "type": "object" + }, + "SubnetId": { + "description": "ID of a subnet", + "pattern": "^subnet-[0-9a-z]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::APS::Scraper", + "handlers": { + "create": { + "permissions": [ + "aps:CreateScraper", + "aps:DescribeScraper", + "aps:DescribeWorkspace", + "aps:TagResource", + "eks:CreateAccessEntry", + "eks:AssociateAccessPolicy", + "eks:DescribeCluster", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "aps:DeleteScraper", + "aps:DescribeScraper", + "aps:DescribeWorkspace", + "eks:AssociateAccessPolicy", + "eks:DescribeCluster", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "iam:DeleteServiceLinkedRole" + ] + }, + "list": { + "permissions": [ + "aps:ListScrapers", + "aps:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "aps:DescribeScraper", + "aps:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "aps:DescribeScraper", + "aps:TagResource", + "aps:UntagResource", + "aps:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Alias": { + "description": "Scraper alias.", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$", + "type": "string" + }, + "Arn": { + "description": "Scraper ARN.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]+:[0-9]+:scraper/s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", + "type": "string" + }, + "Destination": { + "$ref": "#/definitions/Destination" + }, + "RoleArn": { + "description": "IAM role ARN for the scraper.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::[0-9]{12}:role/[a-zA-Z0-9-]+$", + "type": "string" + }, + "ScrapeConfiguration": { + "$ref": "#/definitions/ScrapeConfiguration" + }, + "ScraperId": { + "description": "Required to identify a specific scraper.", + "maxLength": 64, + "minLength": 1, + "pattern": "^s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", + "type": "string" + }, + "Source": { + "$ref": "#/definitions/Source" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ScraperId", + "/properties/Arn", + "/properties/RoleArn" + ], + "required": [ + "ScrapeConfiguration", + "Source", + "Destination" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::APS::Scraper" +} diff --git a/schema/aws-aps-workspace.json b/schema/aws-aps-workspace.json index a2dd22a..2742ede 100644 --- a/schema/aws-aps-workspace.json +++ b/schema/aws-aps-workspace.json @@ -1,176 +1,176 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyArn" - ], - "definitions": { - "LoggingConfiguration": { - "additionalProperties": false, - "description": "Logging configuration", - "properties": { - "LogGroupArn": { - "description": "CloudWatch log group ARN", - "maxLength": 512, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::APS::Workspace", - "handlers": { - "create": { - "permissions": [ - "aps:CreateWorkspace", - "aps:DescribeWorkspace", - "aps:TagResource", - "aps:CreateAlertManagerDefinition", - "aps:DescribeAlertManagerDefinition", - "aps:CreateLoggingConfiguration", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "kms:CreateGrant", - "kms:Decrypt", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "aps:DeleteWorkspace", - "aps:DescribeWorkspace", - "aps:DeleteAlertManagerDefinition", - "aps:DeleteLoggingConfiguration", - "logs:DeleteLogDelivery" - ] - }, - "list": { - "permissions": [ - "aps:ListWorkspaces", - "aps:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "aps:DescribeWorkspace", - "aps:ListTagsForResource", - "aps:DescribeAlertManagerDefinition", - "aps:DescribeLoggingConfiguration" - ] - }, - "update": { - "permissions": [ - "aps:UpdateWorkspaceAlias", - "aps:DescribeWorkspace", - "aps:TagResource", - "aps:UntagResource", - "aps:ListTagsForResource", - "aps:CreateAlertManagerDefinition", - "aps:PutAlertManagerDefinition", - "aps:DeleteAlertManagerDefinition", - "aps:CreateLoggingConfiguration", - "aps:DescribeLoggingConfiguration", - "aps:UpdateLoggingConfiguration", - "aps:DeleteLoggingConfiguration", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:ListLogDeliveries", - "logs:DeleteLogDelivery", - "logs:PutResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AlertManagerDefinition": { - "description": "The AMP Workspace alert manager definition data", - "type": "string" - }, - "Alias": { - "description": "AMP Workspace alias.", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "Arn": { - "description": "Workspace arn.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$", - "type": "string" - }, - "KmsKeyArn": { - "description": "KMS Key ARN used to encrypt and decrypt AMP workspace data.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$", - "type": "string" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/LoggingConfiguration" - }, - "PrometheusEndpoint": { - "description": "AMP Workspace prometheus endpoint", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "WorkspaceId": { - "description": "Required to identify a specific APS Workspace.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/WorkspaceId", - "/properties/Arn", - "/properties/PrometheusEndpoint" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::APS::Workspace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn" + ], + "definitions": { + "LoggingConfiguration": { + "additionalProperties": false, + "description": "Logging configuration", + "properties": { + "LogGroupArn": { + "description": "CloudWatch log group ARN", + "maxLength": 512, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::APS::Workspace", + "handlers": { + "create": { + "permissions": [ + "aps:CreateWorkspace", + "aps:DescribeWorkspace", + "aps:TagResource", + "aps:CreateAlertManagerDefinition", + "aps:DescribeAlertManagerDefinition", + "aps:CreateLoggingConfiguration", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "kms:CreateGrant", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "aps:DeleteWorkspace", + "aps:DescribeWorkspace", + "aps:DeleteAlertManagerDefinition", + "aps:DeleteLoggingConfiguration", + "logs:DeleteLogDelivery" + ] + }, + "list": { + "permissions": [ + "aps:ListWorkspaces", + "aps:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "aps:DescribeWorkspace", + "aps:ListTagsForResource", + "aps:DescribeAlertManagerDefinition", + "aps:DescribeLoggingConfiguration" + ] + }, + "update": { + "permissions": [ + "aps:UpdateWorkspaceAlias", + "aps:DescribeWorkspace", + "aps:TagResource", + "aps:UntagResource", + "aps:ListTagsForResource", + "aps:CreateAlertManagerDefinition", + "aps:PutAlertManagerDefinition", + "aps:DeleteAlertManagerDefinition", + "aps:CreateLoggingConfiguration", + "aps:DescribeLoggingConfiguration", + "aps:UpdateLoggingConfiguration", + "aps:DeleteLoggingConfiguration", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:ListLogDeliveries", + "logs:DeleteLogDelivery", + "logs:PutResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AlertManagerDefinition": { + "description": "The AMP Workspace alert manager definition data", + "type": "string" + }, + "Alias": { + "description": "AMP Workspace alias.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "Arn": { + "description": "Workspace arn.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$", + "type": "string" + }, + "KmsKeyArn": { + "description": "KMS Key ARN used to encrypt and decrypt AMP workspace data.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$", + "type": "string" + }, + "LoggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration" + }, + "PrometheusEndpoint": { + "description": "AMP Workspace prometheus endpoint", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WorkspaceId": { + "description": "Required to identify a specific APS Workspace.", + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/WorkspaceId", + "/properties/Arn", + "/properties/PrometheusEndpoint" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::APS::Workspace" +} diff --git a/schema/aws-arczonalshift-autoshiftobservernotificationstatus.json b/schema/aws-arczonalshift-autoshiftobservernotificationstatus.json index a1b720c..dd360b0 100644 --- a/schema/aws-arczonalshift-autoshiftobservernotificationstatus.json +++ b/schema/aws-arczonalshift-autoshiftobservernotificationstatus.json @@ -1,76 +1,76 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Status" - ], - "definitions": { - "AccountId": { - "description": "User account id, used as part of the primary identifier for the resource", - "pattern": "^\\d{12}$", - "type": "string" - }, - "AutoshiftObserverNotificationStatus": { - "enum": [ - "ENABLED" - ], - "type": "string" - }, - "Region": { - "description": "Region, used as part of the primary identifier for the resource", - "maxLength": 30, - "minLength": 5, - "pattern": "^[a-z0-9-]*$", - "type": "string" - } - }, - "description": "Definition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type", - "handlers": { - "create": { - "permissions": [ - "arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus" - ] - }, - "delete": { - "permissions": [ - "arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus", - "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" - ] - }, - "list": { - "permissions": [ - "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" - ] - }, - "read": { - "permissions": [ - "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId", - "/properties/Region" - ], - "properties": { - "AccountId": { - "$ref": "#/definitions/AccountId" - }, - "Region": { - "$ref": "#/definitions/Region" - }, - "Status": { - "$ref": "#/definitions/AutoshiftObserverNotificationStatus" - } - }, - "readOnlyProperties": [ - "/properties/AccountId", - "/properties/Region" - ], - "required": [ - "Status" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::ARCZonalShift::AutoshiftObserverNotificationStatus" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Status" + ], + "definitions": { + "AccountId": { + "description": "User account id, used as part of the primary identifier for the resource", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AutoshiftObserverNotificationStatus": { + "enum": [ + "ENABLED" + ], + "type": "string" + }, + "Region": { + "description": "Region, used as part of the primary identifier for the resource", + "maxLength": 30, + "minLength": 5, + "pattern": "^[a-z0-9-]*$", + "type": "string" + } + }, + "description": "Definition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type", + "handlers": { + "create": { + "permissions": [ + "arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus" + ] + }, + "delete": { + "permissions": [ + "arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus", + "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" + ] + }, + "list": { + "permissions": [ + "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" + ] + }, + "read": { + "permissions": [ + "arc-zonal-shift:GetAutoshiftObserverNotificationStatus" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId", + "/properties/Region" + ], + "properties": { + "AccountId": { + "$ref": "#/definitions/AccountId" + }, + "Region": { + "$ref": "#/definitions/Region" + }, + "Status": { + "$ref": "#/definitions/AutoshiftObserverNotificationStatus" + } + }, + "readOnlyProperties": [ + "/properties/AccountId", + "/properties/Region" + ], + "required": [ + "Status" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::ARCZonalShift::AutoshiftObserverNotificationStatus" +} diff --git a/schema/aws-arczonalshift-zonalautoshiftconfiguration.json b/schema/aws-arczonalshift-zonalautoshiftconfiguration.json index 836bf40..c697263 100644 --- a/schema/aws-arczonalshift-zonalautoshiftconfiguration.json +++ b/schema/aws-arczonalshift-zonalautoshiftconfiguration.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "allOf": [ - { - "allOf": [ - { - "required": [ - "ResourceIdentifier" - ] - } - ], - "anyOf": [ - { - "required": [ - "ZonalAutoshiftStatus" - ] - }, - { - "required": [ - "PracticeRunConfiguration" - ] - } - ] - } - ], - "createOnlyProperties": [ - "/properties/ResourceIdentifier" - ], - "definitions": { - "ControlCondition": { - "additionalProperties": false, - "properties": { - "AlarmIdentifier": { - "maxLength": 1024, - "minLength": 8, - "pattern": "^.*$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/ControlConditionType" - } - }, - "required": [ - "AlarmIdentifier", - "Type" - ], - "type": "object" - }, - "ControlConditionType": { - "maxLength": 10, - "minLength": 8, - "pattern": "^[a-zA-Z]*$", - "type": "string" - }, - "PracticeRunConfiguration": { - "additionalProperties": false, - "properties": { - "BlockedDates": { - "insertionOrder": false, - "items": { - "maxLength": 10, - "minLength": 10, - "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", - "type": "string" - }, - "maxItems": 15, - "minItems": 0, - "type": "array" - }, - "BlockedWindows": { - "insertionOrder": false, - "items": { - "maxLength": 19, - "minLength": 19, - "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$", - "type": "string" - }, - "maxItems": 15, - "minItems": 0, - "type": "array" - }, - "BlockingAlarms": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ControlCondition" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "OutcomeAlarms": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ControlCondition" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "OutcomeAlarms" - ], - "type": "object" - }, - "ZonalAutoshiftStatus": { - "enum": [ - "ENABLED" - ], - "type": "string" - } - }, - "description": "Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type", - "handlers": { - "create": { - "permissions": [ - "arc-zonal-shift:CreatePracticeRunConfiguration", - "arc-zonal-shift:GetManagedResource", - "arc-zonal-shift:UpdateZonalAutoshiftConfiguration", - "cloudwatch:DescribeAlarms", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "arc-zonal-shift:DeletePracticeRunConfiguration", - "arc-zonal-shift:GetManagedResource", - "arc-zonal-shift:UpdateZonalAutoshiftConfiguration" - ] - }, - "list": { - "permissions": [ - "arc-zonal-shift:ListManagedResources" - ] - }, - "read": { - "permissions": [ - "arc-zonal-shift:GetManagedResource" - ] - }, - "update": { - "permissions": [ - "arc-zonal-shift:GetManagedResource", - "arc-zonal-shift:UpdatePracticeRunConfiguration", - "arc-zonal-shift:UpdateZonalAutoshiftConfiguration", - "cloudwatch:DescribeAlarms" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceIdentifier" - ], - "properties": { - "PracticeRunConfiguration": { - "$ref": "#/definitions/PracticeRunConfiguration" - }, - "ResourceIdentifier": { - "maxLength": 1024, - "minLength": 8, - "type": "string" - }, - "ZonalAutoshiftStatus": { - "$ref": "#/definitions/ZonalAutoshiftStatus" - } - }, - "tagging": { - "taggable": false - }, - "typeName": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration" -} +{ + "additionalProperties": false, + "allOf": [ + { + "allOf": [ + { + "required": [ + "ResourceIdentifier" + ] + } + ], + "anyOf": [ + { + "required": [ + "ZonalAutoshiftStatus" + ] + }, + { + "required": [ + "PracticeRunConfiguration" + ] + } + ] + } + ], + "createOnlyProperties": [ + "/properties/ResourceIdentifier" + ], + "definitions": { + "ControlCondition": { + "additionalProperties": false, + "properties": { + "AlarmIdentifier": { + "maxLength": 1024, + "minLength": 8, + "pattern": "^.*$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/ControlConditionType" + } + }, + "required": [ + "AlarmIdentifier", + "Type" + ], + "type": "object" + }, + "ControlConditionType": { + "maxLength": 10, + "minLength": 8, + "pattern": "^[a-zA-Z]*$", + "type": "string" + }, + "PracticeRunConfiguration": { + "additionalProperties": false, + "properties": { + "BlockedDates": { + "insertionOrder": false, + "items": { + "maxLength": 10, + "minLength": 10, + "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", + "type": "string" + }, + "maxItems": 15, + "minItems": 0, + "type": "array" + }, + "BlockedWindows": { + "insertionOrder": false, + "items": { + "maxLength": 19, + "minLength": 19, + "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$", + "type": "string" + }, + "maxItems": 15, + "minItems": 0, + "type": "array" + }, + "BlockingAlarms": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ControlCondition" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "OutcomeAlarms": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ControlCondition" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "OutcomeAlarms" + ], + "type": "object" + }, + "ZonalAutoshiftStatus": { + "enum": [ + "ENABLED" + ], + "type": "string" + } + }, + "description": "Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type", + "handlers": { + "create": { + "permissions": [ + "arc-zonal-shift:CreatePracticeRunConfiguration", + "arc-zonal-shift:GetManagedResource", + "arc-zonal-shift:UpdateZonalAutoshiftConfiguration", + "cloudwatch:DescribeAlarms", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "arc-zonal-shift:DeletePracticeRunConfiguration", + "arc-zonal-shift:GetManagedResource", + "arc-zonal-shift:UpdateZonalAutoshiftConfiguration" + ] + }, + "list": { + "permissions": [ + "arc-zonal-shift:ListManagedResources" + ] + }, + "read": { + "permissions": [ + "arc-zonal-shift:GetManagedResource" + ] + }, + "update": { + "permissions": [ + "arc-zonal-shift:GetManagedResource", + "arc-zonal-shift:UpdatePracticeRunConfiguration", + "arc-zonal-shift:UpdateZonalAutoshiftConfiguration", + "cloudwatch:DescribeAlarms" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceIdentifier" + ], + "properties": { + "PracticeRunConfiguration": { + "$ref": "#/definitions/PracticeRunConfiguration" + }, + "ResourceIdentifier": { + "maxLength": 1024, + "minLength": 8, + "type": "string" + }, + "ZonalAutoshiftStatus": { + "$ref": "#/definitions/ZonalAutoshiftStatus" + } + }, + "tagging": { + "taggable": false + }, + "typeName": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration" +} diff --git a/schema/aws-athena-capacityreservation.json b/schema/aws-athena-capacityreservation.json index de44f91..fbb92d1 100644 --- a/schema/aws-athena-capacityreservation.json +++ b/schema/aws-athena-capacityreservation.json @@ -1,206 +1,206 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the specified capacity reservation", - "type": "string" - }, - "CapacityAssignment": { - "additionalProperties": false, - "properties": { - "WorkgroupNames": { - "$ref": "#/definitions/WorkgroupNames" - } - }, - "required": [ - "WorkgroupNames" - ], - "type": "object" - }, - "CapacityAssignmentConfiguration": { - "additionalProperties": false, - "description": "Assignment configuration to assign workgroups to a reservation", - "properties": { - "CapacityAssignments": { - "$ref": "#/definitions/CapacityAssignments" - } - }, - "required": [ - "CapacityAssignments" - ], - "type": "object" - }, - "CapacityAssignments": { - "description": "List of capacity assignments", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CapacityAssignment" - }, - "type": "array" - }, - "CapacityReservationStatus": { - "enum": [ - "PENDING", - "ACTIVE", - "CANCELLING", - "CANCELLED", - "FAILED", - "UPDATE_PENDING" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WorkgroupName": { - "pattern": "[a-zA-Z0-9._-]{1,128}", - "type": "string" - }, - "WorkgroupNames": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WorkgroupName" - }, - "type": "array" - } - }, - "description": "Resource schema for AWS::Athena::CapacityReservation", - "handlers": { - "create": { - "permissions": [ - "athena:CreateCapacityReservation", - "athena:PutCapacityAssignmentConfiguration", - "athena:GetCapacityReservation", - "athena:TagResource" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "athena:CancelCapacityReservation", - "athena:GetCapacityReservation", - "athena:DeleteCapacityReservation" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "athena:ListCapacityReservations", - "athena:GetCapacityReservation" - ], - "timeoutInMinutes": 60 - }, - "read": { - "permissions": [ - "athena:GetCapacityReservation", - "athena:GetCapacityAssignmentConfiguration", - "athena:ListTagsForResource" - ], - "timeoutInMinutes": 60 - }, - "update": { - "permissions": [ - "athena:UpdateCapacityReservation", - "athena:PutCapacityAssignmentConfiguration", - "athena:GetCapacityReservation", - "athena:TagResource", - "athena:UntagResource" - ], - "timeoutInMinutes": 60 - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AllocatedDpus": { - "description": "The number of DPUs Athena has provisioned and allocated for the reservation", - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CapacityAssignmentConfiguration": { - "$ref": "#/definitions/CapacityAssignmentConfiguration" - }, - "CreationTime": { - "description": "The date and time the reservation was created.", - "type": "string" - }, - "LastSuccessfulAllocationTime": { - "description": "The timestamp when the last successful allocated was made", - "type": "string" - }, - "Name": { - "description": "The reservation name.", - "pattern": "[a-zA-Z0-9._-]{1,128}", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/CapacityReservationStatus", - "description": "The status of the reservation." - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TargetDpus": { - "description": "The number of DPUs to request to be allocated to the reservation.", - "format": "int64", - "minimum": 1, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Status", - "/properties/AllocatedDpus", - "/properties/CreationTime", - "/properties/LastSuccessfulAllocationTime" - ], - "required": [ - "Name", - "TargetDpus" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Athena::CapacityReservation" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the specified capacity reservation", + "type": "string" + }, + "CapacityAssignment": { + "additionalProperties": false, + "properties": { + "WorkgroupNames": { + "$ref": "#/definitions/WorkgroupNames" + } + }, + "required": [ + "WorkgroupNames" + ], + "type": "object" + }, + "CapacityAssignmentConfiguration": { + "additionalProperties": false, + "description": "Assignment configuration to assign workgroups to a reservation", + "properties": { + "CapacityAssignments": { + "$ref": "#/definitions/CapacityAssignments" + } + }, + "required": [ + "CapacityAssignments" + ], + "type": "object" + }, + "CapacityAssignments": { + "description": "List of capacity assignments", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CapacityAssignment" + }, + "type": "array" + }, + "CapacityReservationStatus": { + "enum": [ + "PENDING", + "ACTIVE", + "CANCELLING", + "CANCELLED", + "FAILED", + "UPDATE_PENDING" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WorkgroupName": { + "pattern": "[a-zA-Z0-9._-]{1,128}", + "type": "string" + }, + "WorkgroupNames": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WorkgroupName" + }, + "type": "array" + } + }, + "description": "Resource schema for AWS::Athena::CapacityReservation", + "handlers": { + "create": { + "permissions": [ + "athena:CreateCapacityReservation", + "athena:PutCapacityAssignmentConfiguration", + "athena:GetCapacityReservation", + "athena:TagResource" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "athena:CancelCapacityReservation", + "athena:GetCapacityReservation", + "athena:DeleteCapacityReservation" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "athena:ListCapacityReservations", + "athena:GetCapacityReservation" + ], + "timeoutInMinutes": 60 + }, + "read": { + "permissions": [ + "athena:GetCapacityReservation", + "athena:GetCapacityAssignmentConfiguration", + "athena:ListTagsForResource" + ], + "timeoutInMinutes": 60 + }, + "update": { + "permissions": [ + "athena:UpdateCapacityReservation", + "athena:PutCapacityAssignmentConfiguration", + "athena:GetCapacityReservation", + "athena:TagResource", + "athena:UntagResource" + ], + "timeoutInMinutes": 60 + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AllocatedDpus": { + "description": "The number of DPUs Athena has provisioned and allocated for the reservation", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CapacityAssignmentConfiguration": { + "$ref": "#/definitions/CapacityAssignmentConfiguration" + }, + "CreationTime": { + "description": "The date and time the reservation was created.", + "type": "string" + }, + "LastSuccessfulAllocationTime": { + "description": "The timestamp when the last successful allocated was made", + "type": "string" + }, + "Name": { + "description": "The reservation name.", + "pattern": "[a-zA-Z0-9._-]{1,128}", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/CapacityReservationStatus", + "description": "The status of the reservation." + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TargetDpus": { + "description": "The number of DPUs to request to be allocated to the reservation.", + "format": "int64", + "minimum": 1, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Status", + "/properties/AllocatedDpus", + "/properties/CreationTime", + "/properties/LastSuccessfulAllocationTime" + ], + "required": [ + "Name", + "TargetDpus" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Athena::CapacityReservation" +} diff --git a/schema/aws-athena-datacatalog.json b/schema/aws-athena-datacatalog.json index d3fc2aa..1adfb14 100644 --- a/schema/aws-athena-datacatalog.json +++ b/schema/aws-athena-datacatalog.json @@ -1,117 +1,117 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "description": "Resource schema for AWS::Athena::DataCatalog", - "handlers": { - "create": { - "permissions": [ - "athena:CreateDataCatalog", - "athena:TagResource" - ] - }, - "delete": { - "permissions": [ - "athena:DeleteDataCatalog" - ] - }, - "list": { - "permissions": [ - "athena:ListDataCatalog" - ] - }, - "read": { - "permissions": [ - "athena:GetDataCatalog", - "athena:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "athena:UpdateDataCatalog", - "athena:TagResource", - "athena:GetDataCatalog", - "athena:UntagResource", - "athena:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Description": { - "description": "A description of the data catalog to be created. ", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "description": "Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. ", - "patternProperties": { - ".*": { - "maxLength": 51200, - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "A list of comma separated tags to add to the data catalog that is created. " - }, - "Type": { - "description": "The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. ", - "enum": [ - "LAMBDA", - "GLUE", - "HIVE" - ], - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", - "taggable": true, - "typeName": "AWS::Athena::DataCatalog" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "description": "Resource schema for AWS::Athena::DataCatalog", + "handlers": { + "create": { + "permissions": [ + "athena:CreateDataCatalog", + "athena:TagResource" + ] + }, + "delete": { + "permissions": [ + "athena:DeleteDataCatalog" + ] + }, + "list": { + "permissions": [ + "athena:ListDataCatalog" + ] + }, + "read": { + "permissions": [ + "athena:GetDataCatalog", + "athena:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "athena:UpdateDataCatalog", + "athena:TagResource", + "athena:GetDataCatalog", + "athena:UntagResource", + "athena:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Description": { + "description": "A description of the data catalog to be created. ", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "description": "Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. ", + "patternProperties": { + ".*": { + "maxLength": 51200, + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "A list of comma separated tags to add to the data catalog that is created. " + }, + "Type": { + "description": "The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. ", + "enum": [ + "LAMBDA", + "GLUE", + "HIVE" + ], + "type": "string" + } + }, + "required": [ + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", + "taggable": true, + "typeName": "AWS::Athena::DataCatalog" +} diff --git a/schema/aws-athena-namedquery.json b/schema/aws-athena-namedquery.json index 83e7689..e7872a9 100644 --- a/schema/aws-athena-namedquery.json +++ b/schema/aws-athena-namedquery.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Database", - "/properties/Description", - "/properties/QueryString", - "/properties/WorkGroup" - ], - "description": "Resource schema for AWS::Athena::NamedQuery", - "handlers": { - "create": { - "permissions": [ - "athena:CreateNamedQuery" - ] - }, - "delete": { - "permissions": [ - "athena:DeleteNamedQuery" - ] - }, - "list": { - "permissions": [ - "athena:ListNamedQueries" - ] - }, - "read": { - "permissions": [ - "athena:GetNamedQuery" - ] - } - }, - "primaryIdentifier": [ - "/properties/NamedQueryId" - ], - "properties": { - "Database": { - "description": "The database to which the query belongs.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The query description.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The query name.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NamedQueryId": { - "description": "The unique ID of the query.", - "type": "string" - }, - "QueryString": { - "description": "The contents of the query with all query statements.", - "maxLength": 262144, - "minLength": 1, - "type": "string" - }, - "WorkGroup": { - "description": "The name of the workgroup that contains the named query.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NamedQueryId" - ], - "required": [ - "Database", - "QueryString" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", - "taggable": false, - "typeName": "AWS::Athena::NamedQuery" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Database", + "/properties/Description", + "/properties/QueryString", + "/properties/WorkGroup" + ], + "description": "Resource schema for AWS::Athena::NamedQuery", + "handlers": { + "create": { + "permissions": [ + "athena:CreateNamedQuery" + ] + }, + "delete": { + "permissions": [ + "athena:DeleteNamedQuery" + ] + }, + "list": { + "permissions": [ + "athena:ListNamedQueries" + ] + }, + "read": { + "permissions": [ + "athena:GetNamedQuery" + ] + } + }, + "primaryIdentifier": [ + "/properties/NamedQueryId" + ], + "properties": { + "Database": { + "description": "The database to which the query belongs.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The query description.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The query name.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NamedQueryId": { + "description": "The unique ID of the query.", + "type": "string" + }, + "QueryString": { + "description": "The contents of the query with all query statements.", + "maxLength": 262144, + "minLength": 1, + "type": "string" + }, + "WorkGroup": { + "description": "The name of the workgroup that contains the named query.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NamedQueryId" + ], + "required": [ + "Database", + "QueryString" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", + "taggable": false, + "typeName": "AWS::Athena::NamedQuery" +} diff --git a/schema/aws-athena-preparedstatement.json b/schema/aws-athena-preparedstatement.json index 31ff0b4..4d430ba 100644 --- a/schema/aws-athena-preparedstatement.json +++ b/schema/aws-athena-preparedstatement.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StatementName", - "/properties/WorkGroup" - ], - "description": "Resource schema for AWS::Athena::PreparedStatement", - "handlers": { - "create": { - "permissions": [ - "athena:CreatePreparedStatement", - "athena:GetPreparedStatement" - ] - }, - "delete": { - "permissions": [ - "athena:DeletePreparedStatement", - "athena:GetPreparedStatement" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "WorkGroup": { - "$ref": "resource-schema.json#/properties/WorkGroup" - } - }, - "required": [ - "WorkGroup" - ] - }, - "permissions": [ - "athena:ListPreparedStatements" - ] - }, - "read": { - "permissions": [ - "athena:GetPreparedStatement" - ] - }, - "update": { - "permissions": [ - "athena:UpdatePreparedStatement" - ] - } - }, - "primaryIdentifier": [ - "/properties/StatementName", - "/properties/WorkGroup" - ], - "properties": { - "Description": { - "description": "The description of the prepared statement.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "QueryStatement": { - "description": "The query string for the prepared statement.", - "maxLength": 262144, - "minLength": 1, - "type": "string" - }, - "StatementName": { - "description": "The name of the prepared statement.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "WorkGroup": { - "description": "The name of the workgroup to which the prepared statement belongs.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "StatementName", - "WorkGroup", - "QueryStatement" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", - "taggable": false, - "typeName": "AWS::Athena::PreparedStatement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StatementName", + "/properties/WorkGroup" + ], + "description": "Resource schema for AWS::Athena::PreparedStatement", + "handlers": { + "create": { + "permissions": [ + "athena:CreatePreparedStatement", + "athena:GetPreparedStatement" + ] + }, + "delete": { + "permissions": [ + "athena:DeletePreparedStatement", + "athena:GetPreparedStatement" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "WorkGroup": { + "$ref": "resource-schema.json#/properties/WorkGroup" + } + }, + "required": [ + "WorkGroup" + ] + }, + "permissions": [ + "athena:ListPreparedStatements" + ] + }, + "read": { + "permissions": [ + "athena:GetPreparedStatement" + ] + }, + "update": { + "permissions": [ + "athena:UpdatePreparedStatement" + ] + } + }, + "primaryIdentifier": [ + "/properties/StatementName", + "/properties/WorkGroup" + ], + "properties": { + "Description": { + "description": "The description of the prepared statement.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "QueryStatement": { + "description": "The query string for the prepared statement.", + "maxLength": 262144, + "minLength": 1, + "type": "string" + }, + "StatementName": { + "description": "The name of the prepared statement.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "WorkGroup": { + "description": "The name of the workgroup to which the prepared statement belongs.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "StatementName", + "WorkGroup", + "QueryStatement" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", + "taggable": false, + "typeName": "AWS::Athena::PreparedStatement" +} diff --git a/schema/aws-athena-workgroup.json b/schema/aws-athena-workgroup.json index 7521c2d..3b5221a 100644 --- a/schema/aws-athena-workgroup.json +++ b/schema/aws-athena-workgroup.json @@ -1,412 +1,412 @@ -{ - "$comment": "Resource Schema for AWS::Athena::WorkGroup. Any changes made to SDK model for WorkGroup should be reflected here.", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AclConfiguration": { - "additionalProperties": false, - "description": "Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results", - "properties": { - "S3AclOption": { - "$ref": "#/definitions/S3AclOption" - } - }, - "required": [ - "S3AclOption" - ], - "type": "object" - }, - "AdditionalConfiguration": { - "description": "Additional Configuration that are passed to Athena Spark Calculations running in this workgroup", - "type": "string" - }, - "BytesScannedCutoffPerQuery": { - "description": "The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.", - "format": "int64", - "minimum": 10000000, - "type": "integer" - }, - "CustomerContentEncryptionConfiguration": { - "additionalProperties": false, - "description": "Indicates the KMS key for encrypting notebook content.", - "properties": { - "KmsKey": { - "$ref": "#/definitions/KmsKey" - } - }, - "required": [ - "KmsKey" - ], - "type": "object" - }, - "EffectiveEngineVersion": { - "description": "Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.", - "type": "string" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.", - "properties": { - "EncryptionOption": { - "$ref": "#/definitions/EncryptionOption" - }, - "KmsKey": { - "$ref": "#/definitions/KmsKey" - } - }, - "required": [ - "EncryptionOption" - ], - "type": "object" - }, - "EncryptionOption": { - "description": "Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.", - "enum": [ - "SSE_S3", - "SSE_KMS", - "CSE_KMS" - ], - "type": "string" - }, - "EnforceWorkGroupConfiguration": { - "description": "If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used", - "type": "boolean" - }, - "EngineVersion": { - "additionalProperties": false, - "description": "The Athena engine version for running queries.", - "properties": { - "EffectiveEngineVersion": { - "$ref": "#/definitions/EffectiveEngineVersion" - }, - "SelectedEngineVersion": { - "$ref": "#/definitions/SelectedEngineVersion" - } - }, - "type": "object" - }, - "ExecutionRole": { - "description": "Execution Role ARN required to run Athena Spark Calculations", - "type": "string" - }, - "ExpectedBucketOwner": { - "description": "The AWS account ID of the owner of S3 bucket where query results are stored", - "type": "string" - }, - "KmsKey": { - "description": "For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. ", - "type": "string" - }, - "OutputLocation": { - "description": "The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration", - "type": "string" - }, - "PublishCloudWatchMetricsEnabled": { - "description": "Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.", - "type": "boolean" - }, - "RemoveAclConfiguration": { - "type": "boolean" - }, - "RemoveBytesScannedCutoffPerQuery": { - "description": "Indicates that the data usage control limit per query is removed.", - "type": "boolean" - }, - "RemoveCustomerContentEncryptionConfiguration": { - "type": "boolean" - }, - "RemoveEncryptionConfiguration": { - "type": "boolean" - }, - "RemoveExpectedBucketOwner": { - "type": "boolean" - }, - "RemoveOutputLocation": { - "type": "boolean" - }, - "RequesterPaysEnabled": { - "description": "If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. ", - "type": "boolean" - }, - "ResultConfiguration": { - "additionalProperties": false, - "description": "The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.\n", - "properties": { - "AclConfiguration": { - "$ref": "#/definitions/AclConfiguration" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "ExpectedBucketOwner": { - "$ref": "#/definitions/ExpectedBucketOwner" - }, - "OutputLocation": { - "$ref": "#/definitions/OutputLocation" - } - }, - "type": "object" - }, - "ResultConfigurationUpdates": { - "additionalProperties": false, - "description": "The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results. ", - "properties": { - "AclConfiguration": { - "$ref": "#/definitions/AclConfiguration" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "ExpectedBucketOwner": { - "$ref": "#/definitions/ExpectedBucketOwner" - }, - "OutputLocation": { - "$ref": "#/definitions/OutputLocation" - }, - "RemoveAclConfiguration": { - "$ref": "#/definitions/RemoveAclConfiguration" - }, - "RemoveEncryptionConfiguration": { - "$ref": "#/definitions/RemoveEncryptionConfiguration" - }, - "RemoveExpectedBucketOwner": { - "$ref": "#/definitions/RemoveExpectedBucketOwner" - }, - "RemoveOutputLocation": { - "$ref": "#/definitions/RemoveOutputLocation" - } - }, - "type": "object" - }, - "S3AclOption": { - "description": "The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL", - "enum": [ - "BUCKET_OWNER_FULL_CONTROL" - ], - "type": "string" - }, - "SelectedEngineVersion": { - "description": "The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "WorkGroupConfiguration": { - "additionalProperties": false, - "properties": { - "AdditionalConfiguration": { - "$ref": "#/definitions/AdditionalConfiguration" - }, - "BytesScannedCutoffPerQuery": { - "$ref": "#/definitions/BytesScannedCutoffPerQuery" - }, - "CustomerContentEncryptionConfiguration": { - "$ref": "#/definitions/CustomerContentEncryptionConfiguration" - }, - "EnforceWorkGroupConfiguration": { - "$ref": "#/definitions/EnforceWorkGroupConfiguration" - }, - "EngineVersion": { - "$ref": "#/definitions/EngineVersion" - }, - "ExecutionRole": { - "$ref": "#/definitions/ExecutionRole" - }, - "PublishCloudWatchMetricsEnabled": { - "$ref": "#/definitions/PublishCloudWatchMetricsEnabled" - }, - "RequesterPaysEnabled": { - "$ref": "#/definitions/RequesterPaysEnabled" - }, - "ResultConfiguration": { - "$ref": "#/definitions/ResultConfiguration" - } - }, - "type": "object" - }, - "WorkGroupConfigurationUpdates": { - "additionalProperties": false, - "description": "The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified. ", - "properties": { - "AdditionalConfiguration": { - "$ref": "#/definitions/AdditionalConfiguration" - }, - "BytesScannedCutoffPerQuery": { - "$ref": "#/definitions/BytesScannedCutoffPerQuery" - }, - "CustomerContentEncryptionConfiguration": { - "$ref": "#/definitions/CustomerContentEncryptionConfiguration" - }, - "EnforceWorkGroupConfiguration": { - "$ref": "#/definitions/EnforceWorkGroupConfiguration" - }, - "EngineVersion": { - "$ref": "#/definitions/EngineVersion" - }, - "ExecutionRole": { - "$ref": "#/definitions/ExecutionRole" - }, - "PublishCloudWatchMetricsEnabled": { - "$ref": "#/definitions/PublishCloudWatchMetricsEnabled" - }, - "RemoveBytesScannedCutoffPerQuery": { - "$ref": "#/definitions/RemoveBytesScannedCutoffPerQuery" - }, - "RemoveCustomerContentEncryptionConfiguration": { - "$ref": "#/definitions/RemoveCustomerContentEncryptionConfiguration" - }, - "RequesterPaysEnabled": { - "$ref": "#/definitions/RequesterPaysEnabled" - }, - "ResultConfigurationUpdates": { - "$ref": "#/definitions/ResultConfigurationUpdates" - } - }, - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/WorkGroupConfigurationUpdates" - ], - "description": "Resource schema for AWS::Athena::WorkGroup", - "handlers": { - "create": { - "permissions": [ - "athena:CreateWorkGroup", - "athena:TagResource", - "iam:PassRole", - "s3:GetBucketLocation", - "s3:GetObject", - "s3:ListBucket", - "s3:ListBucketMultipartUploads", - "s3:AbortMultipartUpload", - "s3:PutObject", - "s3:ListMultipartUploadParts", - "kms:Decrypt", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "athena:DeleteWorkGroup", - "athena:GetWorkGroup", - "athena:UntagResource" - ] - }, - "list": { - "permissions": [ - "athena:ListWorkGroups" - ] - }, - "read": { - "permissions": [ - "athena:GetWorkGroup", - "athena:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "athena:UpdateWorkGroup", - "athena:TagResource", - "athena:UntagResource", - "iam:PassRole", - "s3:GetBucketLocation", - "s3:GetObject", - "s3:ListBucket", - "s3:ListBucketMultipartUploads", - "s3:AbortMultipartUpload", - "s3:PutObject", - "s3:ListMultipartUploadParts", - "kms:Decrypt", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "CreationTime": { - "description": "The date and time the workgroup was created.", - "type": "string" - }, - "Description": { - "description": "The workgroup description.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "The workGroup name.", - "pattern": "[a-zA-Z0-9._-]{1,128}", - "type": "string" - }, - "RecursiveDeleteOption": { - "description": "The option to delete the workgroup and its contents even if the workgroup contains any named queries.", - "type": "boolean" - }, - "State": { - "description": "The state of the workgroup: ENABLED or DISABLED.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "One or more tags, separated by commas, that you want to attach to the workgroup as you create it" - }, - "WorkGroupConfiguration": { - "$ref": "#/definitions/WorkGroupConfiguration", - "description": "The workgroup configuration" - }, - "WorkGroupConfigurationUpdates": { - "$ref": "#/definitions/WorkGroupConfigurationUpdates", - "description": "The workgroup configuration update object" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/WorkGroupConfiguration/EngineVersion/EffectiveEngineVersion", - "/properties/WorkGroupConfigurationUpdates/EngineVersion/EffectiveEngineVersion" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", - "taggable": true, - "typeName": "AWS::Athena::WorkGroup", - "writeOnlyProperties": [ - "/properties/WorkGroupConfigurationUpdates", - "/properties/RecursiveDeleteOption", - "/properties/WorkGroupConfiguration/AdditionalConfiguration" - ] -} +{ + "$comment": "Resource Schema for AWS::Athena::WorkGroup. Any changes made to SDK model for WorkGroup should be reflected here.", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AclConfiguration": { + "additionalProperties": false, + "description": "Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results", + "properties": { + "S3AclOption": { + "$ref": "#/definitions/S3AclOption" + } + }, + "required": [ + "S3AclOption" + ], + "type": "object" + }, + "AdditionalConfiguration": { + "description": "Additional Configuration that are passed to Athena Spark Calculations running in this workgroup", + "type": "string" + }, + "BytesScannedCutoffPerQuery": { + "description": "The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.", + "format": "int64", + "minimum": 10000000, + "type": "integer" + }, + "CustomerContentEncryptionConfiguration": { + "additionalProperties": false, + "description": "Indicates the KMS key for encrypting notebook content.", + "properties": { + "KmsKey": { + "$ref": "#/definitions/KmsKey" + } + }, + "required": [ + "KmsKey" + ], + "type": "object" + }, + "EffectiveEngineVersion": { + "description": "Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.", + "type": "string" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.", + "properties": { + "EncryptionOption": { + "$ref": "#/definitions/EncryptionOption" + }, + "KmsKey": { + "$ref": "#/definitions/KmsKey" + } + }, + "required": [ + "EncryptionOption" + ], + "type": "object" + }, + "EncryptionOption": { + "description": "Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.", + "enum": [ + "SSE_S3", + "SSE_KMS", + "CSE_KMS" + ], + "type": "string" + }, + "EnforceWorkGroupConfiguration": { + "description": "If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used", + "type": "boolean" + }, + "EngineVersion": { + "additionalProperties": false, + "description": "The Athena engine version for running queries.", + "properties": { + "EffectiveEngineVersion": { + "$ref": "#/definitions/EffectiveEngineVersion" + }, + "SelectedEngineVersion": { + "$ref": "#/definitions/SelectedEngineVersion" + } + }, + "type": "object" + }, + "ExecutionRole": { + "description": "Execution Role ARN required to run Athena Spark Calculations", + "type": "string" + }, + "ExpectedBucketOwner": { + "description": "The AWS account ID of the owner of S3 bucket where query results are stored", + "type": "string" + }, + "KmsKey": { + "description": "For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. ", + "type": "string" + }, + "OutputLocation": { + "description": "The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration", + "type": "string" + }, + "PublishCloudWatchMetricsEnabled": { + "description": "Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.", + "type": "boolean" + }, + "RemoveAclConfiguration": { + "type": "boolean" + }, + "RemoveBytesScannedCutoffPerQuery": { + "description": "Indicates that the data usage control limit per query is removed.", + "type": "boolean" + }, + "RemoveCustomerContentEncryptionConfiguration": { + "type": "boolean" + }, + "RemoveEncryptionConfiguration": { + "type": "boolean" + }, + "RemoveExpectedBucketOwner": { + "type": "boolean" + }, + "RemoveOutputLocation": { + "type": "boolean" + }, + "RequesterPaysEnabled": { + "description": "If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. ", + "type": "boolean" + }, + "ResultConfiguration": { + "additionalProperties": false, + "description": "The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.\n", + "properties": { + "AclConfiguration": { + "$ref": "#/definitions/AclConfiguration" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ExpectedBucketOwner": { + "$ref": "#/definitions/ExpectedBucketOwner" + }, + "OutputLocation": { + "$ref": "#/definitions/OutputLocation" + } + }, + "type": "object" + }, + "ResultConfigurationUpdates": { + "additionalProperties": false, + "description": "The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results. ", + "properties": { + "AclConfiguration": { + "$ref": "#/definitions/AclConfiguration" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ExpectedBucketOwner": { + "$ref": "#/definitions/ExpectedBucketOwner" + }, + "OutputLocation": { + "$ref": "#/definitions/OutputLocation" + }, + "RemoveAclConfiguration": { + "$ref": "#/definitions/RemoveAclConfiguration" + }, + "RemoveEncryptionConfiguration": { + "$ref": "#/definitions/RemoveEncryptionConfiguration" + }, + "RemoveExpectedBucketOwner": { + "$ref": "#/definitions/RemoveExpectedBucketOwner" + }, + "RemoveOutputLocation": { + "$ref": "#/definitions/RemoveOutputLocation" + } + }, + "type": "object" + }, + "S3AclOption": { + "description": "The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL", + "enum": [ + "BUCKET_OWNER_FULL_CONTROL" + ], + "type": "string" + }, + "SelectedEngineVersion": { + "description": "The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "WorkGroupConfiguration": { + "additionalProperties": false, + "properties": { + "AdditionalConfiguration": { + "$ref": "#/definitions/AdditionalConfiguration" + }, + "BytesScannedCutoffPerQuery": { + "$ref": "#/definitions/BytesScannedCutoffPerQuery" + }, + "CustomerContentEncryptionConfiguration": { + "$ref": "#/definitions/CustomerContentEncryptionConfiguration" + }, + "EnforceWorkGroupConfiguration": { + "$ref": "#/definitions/EnforceWorkGroupConfiguration" + }, + "EngineVersion": { + "$ref": "#/definitions/EngineVersion" + }, + "ExecutionRole": { + "$ref": "#/definitions/ExecutionRole" + }, + "PublishCloudWatchMetricsEnabled": { + "$ref": "#/definitions/PublishCloudWatchMetricsEnabled" + }, + "RequesterPaysEnabled": { + "$ref": "#/definitions/RequesterPaysEnabled" + }, + "ResultConfiguration": { + "$ref": "#/definitions/ResultConfiguration" + } + }, + "type": "object" + }, + "WorkGroupConfigurationUpdates": { + "additionalProperties": false, + "description": "The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified. ", + "properties": { + "AdditionalConfiguration": { + "$ref": "#/definitions/AdditionalConfiguration" + }, + "BytesScannedCutoffPerQuery": { + "$ref": "#/definitions/BytesScannedCutoffPerQuery" + }, + "CustomerContentEncryptionConfiguration": { + "$ref": "#/definitions/CustomerContentEncryptionConfiguration" + }, + "EnforceWorkGroupConfiguration": { + "$ref": "#/definitions/EnforceWorkGroupConfiguration" + }, + "EngineVersion": { + "$ref": "#/definitions/EngineVersion" + }, + "ExecutionRole": { + "$ref": "#/definitions/ExecutionRole" + }, + "PublishCloudWatchMetricsEnabled": { + "$ref": "#/definitions/PublishCloudWatchMetricsEnabled" + }, + "RemoveBytesScannedCutoffPerQuery": { + "$ref": "#/definitions/RemoveBytesScannedCutoffPerQuery" + }, + "RemoveCustomerContentEncryptionConfiguration": { + "$ref": "#/definitions/RemoveCustomerContentEncryptionConfiguration" + }, + "RequesterPaysEnabled": { + "$ref": "#/definitions/RequesterPaysEnabled" + }, + "ResultConfigurationUpdates": { + "$ref": "#/definitions/ResultConfigurationUpdates" + } + }, + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/WorkGroupConfigurationUpdates" + ], + "description": "Resource schema for AWS::Athena::WorkGroup", + "handlers": { + "create": { + "permissions": [ + "athena:CreateWorkGroup", + "athena:TagResource", + "iam:PassRole", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListBucket", + "s3:ListBucketMultipartUploads", + "s3:AbortMultipartUpload", + "s3:PutObject", + "s3:ListMultipartUploadParts", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "athena:DeleteWorkGroup", + "athena:GetWorkGroup", + "athena:UntagResource" + ] + }, + "list": { + "permissions": [ + "athena:ListWorkGroups" + ] + }, + "read": { + "permissions": [ + "athena:GetWorkGroup", + "athena:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "athena:UpdateWorkGroup", + "athena:TagResource", + "athena:UntagResource", + "iam:PassRole", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListBucket", + "s3:ListBucketMultipartUploads", + "s3:AbortMultipartUpload", + "s3:PutObject", + "s3:ListMultipartUploadParts", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "CreationTime": { + "description": "The date and time the workgroup was created.", + "type": "string" + }, + "Description": { + "description": "The workgroup description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "The workGroup name.", + "pattern": "[a-zA-Z0-9._-]{1,128}", + "type": "string" + }, + "RecursiveDeleteOption": { + "description": "The option to delete the workgroup and its contents even if the workgroup contains any named queries.", + "type": "boolean" + }, + "State": { + "description": "The state of the workgroup: ENABLED or DISABLED.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "One or more tags, separated by commas, that you want to attach to the workgroup as you create it" + }, + "WorkGroupConfiguration": { + "$ref": "#/definitions/WorkGroupConfiguration", + "description": "The workgroup configuration" + }, + "WorkGroupConfigurationUpdates": { + "$ref": "#/definitions/WorkGroupConfigurationUpdates", + "description": "The workgroup configuration update object" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/WorkGroupConfiguration/EngineVersion/EffectiveEngineVersion", + "/properties/WorkGroupConfigurationUpdates/EngineVersion/EffectiveEngineVersion" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-athena.git", + "taggable": true, + "typeName": "AWS::Athena::WorkGroup", + "writeOnlyProperties": [ + "/properties/WorkGroupConfigurationUpdates", + "/properties/RecursiveDeleteOption", + "/properties/WorkGroupConfiguration/AdditionalConfiguration" + ] +} diff --git a/schema/aws-auditmanager-assessment.json b/schema/aws-auditmanager-assessment.json index 0d402de..2d8e6a1 100644 --- a/schema/aws-auditmanager-assessment.json +++ b/schema/aws-auditmanager-assessment.json @@ -1,371 +1,371 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FrameworkId", - "/properties/AwsAccount" - ], - "definitions": { - "AWSAccount": { - "additionalProperties": false, - "description": "The AWS account associated with the assessment.", - "properties": { - "EmailAddress": { - "$ref": "#/definitions/EmailAddress" - }, - "Id": { - "$ref": "#/definitions/AccountId" - }, - "Name": { - "$ref": "#/definitions/AccountName" - } - }, - "type": "object" - }, - "AWSService": { - "additionalProperties": false, - "description": "An AWS service such as Amazon S3, AWS CloudTrail, and so on.", - "properties": { - "ServiceName": { - "$ref": "#/definitions/AWSServiceName" - } - }, - "type": "object" - }, - "AWSServiceName": { - "description": "The name of the AWS service.", - "type": "string" - }, - "AccountId": { - "description": "The identifier for the specified AWS account.", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "AccountName": { - "description": "The name of the specified AWS account.", - "maxLength": 50, - "minLength": 1, - "pattern": "^[\\u0020-\\u007E]+$", - "type": "string" - }, - "AssessmentArn": { - "description": "The Amazon Resource Name (ARN) of the assessment.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:.*:auditmanager:.*", - "type": "string" - }, - "AssessmentDescription": { - "description": "The description of the specified assessment.", - "type": "string" - }, - "AssessmentName": { - "description": "The name of the related assessment.", - "maxLength": 127, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_\\.]+$", - "type": "string" - }, - "AssessmentReportDestinationType": { - "description": "The destination type, such as Amazon S3.", - "enum": [ - "S3" - ], - "type": "string" - }, - "AssessmentReportsDestination": { - "additionalProperties": false, - "description": "The destination in which evidence reports are stored for the specified assessment.", - "properties": { - "Destination": { - "$ref": "#/definitions/S3Url" - }, - "DestinationType": { - "$ref": "#/definitions/AssessmentReportDestinationType" - } - }, - "type": "object" - }, - "AssessmentStatus": { - "description": "The status of the specified assessment. ", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "ControlSetId": { - "description": "The identifier for the specified control set.", - "maxLength": 300, - "minLength": 1, - "pattern": "^[\\w\\W\\s\\S]*$", - "type": "string" - }, - "CreatedBy": { - "description": "The IAM user or role that performed the action.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:.*:*:.*", - "type": "string" - }, - "Delegation": { - "additionalProperties": false, - "description": "The assignment of a control set to a delegate for review.", - "properties": { - "AssessmentId": { - "$ref": "#/definitions/UUID" - }, - "AssessmentName": { - "$ref": "#/definitions/AssessmentName" - }, - "Comment": { - "$ref": "#/definitions/DelegationComment" - }, - "ControlSetId": { - "$ref": "#/definitions/ControlSetId" - }, - "CreatedBy": { - "$ref": "#/definitions/CreatedBy" - }, - "CreationTime": { - "$ref": "#/definitions/Timestamp" - }, - "Id": { - "$ref": "#/definitions/UUID" - }, - "LastUpdated": { - "$ref": "#/definitions/Timestamp" - }, - "RoleArn": { - "$ref": "#/definitions/IamArn" - }, - "RoleType": { - "$ref": "#/definitions/RoleType" - }, - "Status": { - "$ref": "#/definitions/DelegationStatus" - } - }, - "type": "object" - }, - "DelegationComment": { - "description": "The comment related to the delegation.", - "maxLength": 350, - "pattern": "^[\\w\\W\\s\\S]*$", - "type": "string" - }, - "DelegationStatus": { - "description": "The status of the delegation.", - "enum": [ - "IN_PROGRESS", - "UNDER_REVIEW", - "COMPLETE" - ], - "type": "string" - }, - "EmailAddress": { - "description": "The unique identifier for the email account.", - "maxLength": 320, - "minLength": 1, - "pattern": "^.*@.*$", - "type": "string" - }, - "FrameworkId": { - "description": "The identifier for the specified framework.", - "maxLength": 36, - "minLength": 32, - "pattern": "^([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|.*\\S.*)$", - "type": "string" - }, - "IamArn": { - "description": "The Amazon Resource Name (ARN) of the IAM user or role.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:.*:iam:.*", - "type": "string" - }, - "Role": { - "additionalProperties": false, - "description": "The wrapper that contains AWS Audit Manager role information, such as the role type and IAM ARN.", - "properties": { - "RoleArn": { - "$ref": "#/definitions/IamArn" - }, - "RoleType": { - "$ref": "#/definitions/RoleType" - } - }, - "type": "object" - }, - "RoleType": { - "description": " The IAM role type.", - "enum": [ - "PROCESS_OWNER", - "RESOURCE_OWNER" - ], - "type": "string" - }, - "S3Url": { - "description": "The URL of the specified Amazon S3 bucket.", - "type": "string" - }, - "Scope": { - "additionalProperties": false, - "description": "The wrapper that contains the AWS accounts and AWS services in scope for the assessment.", - "properties": { - "AwsAccounts": { - "description": "The AWS accounts included in scope.", - "items": { - "$ref": "#/definitions/AWSAccount" - }, - "type": "array" - }, - "AwsServices": { - "description": "The AWS services included in scope.", - "items": { - "$ref": "#/definitions/AWSService" - }, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Timestamp": { - "description": "The sequence of characters that identifies when the event occurred.", - "type": "number" - }, - "UUID": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - } - }, - "description": "An entity that defines the scope of audit evidence collected by AWS Audit Manager.", - "handlers": { - "create": { - "permissions": [ - "auditmanager:CreateAssessment", - "auditmanager:TagResource", - "auditmanager:ListTagsForResource", - "auditmanager:BatchCreateDelegationByAssessment", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "auditmanager:DeleteAssessment" - ] - }, - "list": { - "permissions": [ - "auditmanager:ListAssessments" - ] - }, - "read": { - "permissions": [ - "auditmanager:GetAssessment" - ] - }, - "update": { - "permissions": [ - "auditmanager:UpdateAssessment", - "auditmanager:UpdateAssessmentStatus", - "auditmanager:BatchCreateDelegationByAssessment", - "auditmanager:BatchDeleteDelegationByAssessment" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssessmentId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/AssessmentArn" - }, - "AssessmentId": { - "$ref": "#/definitions/UUID" - }, - "AssessmentReportsDestination": { - "$ref": "#/definitions/AssessmentReportsDestination" - }, - "AwsAccount": { - "$ref": "#/definitions/AWSAccount" - }, - "CreationTime": { - "$ref": "#/definitions/Timestamp" - }, - "Delegations": { - "description": "The list of delegations.", - "items": { - "$ref": "#/definitions/Delegation" - }, - "type": "array" - }, - "Description": { - "$ref": "#/definitions/AssessmentDescription" - }, - "FrameworkId": { - "$ref": "#/definitions/FrameworkId" - }, - "Name": { - "$ref": "#/definitions/AssessmentName" - }, - "Roles": { - "description": "The list of roles for the specified assessment.", - "items": { - "$ref": "#/definitions/Role" - }, - "type": "array" - }, - "Scope": { - "$ref": "#/definitions/Scope" - }, - "Status": { - "$ref": "#/definitions/AssessmentStatus" - }, - "Tags": { - "description": "The tags associated with the assessment.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AssessmentId", - "/properties/Arn", - "/properties/CreationTime" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::AuditManager::Assessment", - "writeOnlyProperties": [ - "/properties/Name", - "/properties/Description" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FrameworkId", + "/properties/AwsAccount" + ], + "definitions": { + "AWSAccount": { + "additionalProperties": false, + "description": "The AWS account associated with the assessment.", + "properties": { + "EmailAddress": { + "$ref": "#/definitions/EmailAddress" + }, + "Id": { + "$ref": "#/definitions/AccountId" + }, + "Name": { + "$ref": "#/definitions/AccountName" + } + }, + "type": "object" + }, + "AWSService": { + "additionalProperties": false, + "description": "An AWS service such as Amazon S3, AWS CloudTrail, and so on.", + "properties": { + "ServiceName": { + "$ref": "#/definitions/AWSServiceName" + } + }, + "type": "object" + }, + "AWSServiceName": { + "description": "The name of the AWS service.", + "type": "string" + }, + "AccountId": { + "description": "The identifier for the specified AWS account.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "AccountName": { + "description": "The name of the specified AWS account.", + "maxLength": 50, + "minLength": 1, + "pattern": "^[\\u0020-\\u007E]+$", + "type": "string" + }, + "AssessmentArn": { + "description": "The Amazon Resource Name (ARN) of the assessment.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:.*:auditmanager:.*", + "type": "string" + }, + "AssessmentDescription": { + "description": "The description of the specified assessment.", + "type": "string" + }, + "AssessmentName": { + "description": "The name of the related assessment.", + "maxLength": 127, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_\\.]+$", + "type": "string" + }, + "AssessmentReportDestinationType": { + "description": "The destination type, such as Amazon S3.", + "enum": [ + "S3" + ], + "type": "string" + }, + "AssessmentReportsDestination": { + "additionalProperties": false, + "description": "The destination in which evidence reports are stored for the specified assessment.", + "properties": { + "Destination": { + "$ref": "#/definitions/S3Url" + }, + "DestinationType": { + "$ref": "#/definitions/AssessmentReportDestinationType" + } + }, + "type": "object" + }, + "AssessmentStatus": { + "description": "The status of the specified assessment. ", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "ControlSetId": { + "description": "The identifier for the specified control set.", + "maxLength": 300, + "minLength": 1, + "pattern": "^[\\w\\W\\s\\S]*$", + "type": "string" + }, + "CreatedBy": { + "description": "The IAM user or role that performed the action.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:.*:*:.*", + "type": "string" + }, + "Delegation": { + "additionalProperties": false, + "description": "The assignment of a control set to a delegate for review.", + "properties": { + "AssessmentId": { + "$ref": "#/definitions/UUID" + }, + "AssessmentName": { + "$ref": "#/definitions/AssessmentName" + }, + "Comment": { + "$ref": "#/definitions/DelegationComment" + }, + "ControlSetId": { + "$ref": "#/definitions/ControlSetId" + }, + "CreatedBy": { + "$ref": "#/definitions/CreatedBy" + }, + "CreationTime": { + "$ref": "#/definitions/Timestamp" + }, + "Id": { + "$ref": "#/definitions/UUID" + }, + "LastUpdated": { + "$ref": "#/definitions/Timestamp" + }, + "RoleArn": { + "$ref": "#/definitions/IamArn" + }, + "RoleType": { + "$ref": "#/definitions/RoleType" + }, + "Status": { + "$ref": "#/definitions/DelegationStatus" + } + }, + "type": "object" + }, + "DelegationComment": { + "description": "The comment related to the delegation.", + "maxLength": 350, + "pattern": "^[\\w\\W\\s\\S]*$", + "type": "string" + }, + "DelegationStatus": { + "description": "The status of the delegation.", + "enum": [ + "IN_PROGRESS", + "UNDER_REVIEW", + "COMPLETE" + ], + "type": "string" + }, + "EmailAddress": { + "description": "The unique identifier for the email account.", + "maxLength": 320, + "minLength": 1, + "pattern": "^.*@.*$", + "type": "string" + }, + "FrameworkId": { + "description": "The identifier for the specified framework.", + "maxLength": 36, + "minLength": 32, + "pattern": "^([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|.*\\S.*)$", + "type": "string" + }, + "IamArn": { + "description": "The Amazon Resource Name (ARN) of the IAM user or role.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:.*:iam:.*", + "type": "string" + }, + "Role": { + "additionalProperties": false, + "description": "The wrapper that contains AWS Audit Manager role information, such as the role type and IAM ARN.", + "properties": { + "RoleArn": { + "$ref": "#/definitions/IamArn" + }, + "RoleType": { + "$ref": "#/definitions/RoleType" + } + }, + "type": "object" + }, + "RoleType": { + "description": " The IAM role type.", + "enum": [ + "PROCESS_OWNER", + "RESOURCE_OWNER" + ], + "type": "string" + }, + "S3Url": { + "description": "The URL of the specified Amazon S3 bucket.", + "type": "string" + }, + "Scope": { + "additionalProperties": false, + "description": "The wrapper that contains the AWS accounts and AWS services in scope for the assessment.", + "properties": { + "AwsAccounts": { + "description": "The AWS accounts included in scope.", + "items": { + "$ref": "#/definitions/AWSAccount" + }, + "type": "array" + }, + "AwsServices": { + "description": "The AWS services included in scope.", + "items": { + "$ref": "#/definitions/AWSService" + }, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Timestamp": { + "description": "The sequence of characters that identifies when the event occurred.", + "type": "number" + }, + "UUID": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + } + }, + "description": "An entity that defines the scope of audit evidence collected by AWS Audit Manager.", + "handlers": { + "create": { + "permissions": [ + "auditmanager:CreateAssessment", + "auditmanager:TagResource", + "auditmanager:ListTagsForResource", + "auditmanager:BatchCreateDelegationByAssessment", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "auditmanager:DeleteAssessment" + ] + }, + "list": { + "permissions": [ + "auditmanager:ListAssessments" + ] + }, + "read": { + "permissions": [ + "auditmanager:GetAssessment" + ] + }, + "update": { + "permissions": [ + "auditmanager:UpdateAssessment", + "auditmanager:UpdateAssessmentStatus", + "auditmanager:BatchCreateDelegationByAssessment", + "auditmanager:BatchDeleteDelegationByAssessment" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssessmentId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/AssessmentArn" + }, + "AssessmentId": { + "$ref": "#/definitions/UUID" + }, + "AssessmentReportsDestination": { + "$ref": "#/definitions/AssessmentReportsDestination" + }, + "AwsAccount": { + "$ref": "#/definitions/AWSAccount" + }, + "CreationTime": { + "$ref": "#/definitions/Timestamp" + }, + "Delegations": { + "description": "The list of delegations.", + "items": { + "$ref": "#/definitions/Delegation" + }, + "type": "array" + }, + "Description": { + "$ref": "#/definitions/AssessmentDescription" + }, + "FrameworkId": { + "$ref": "#/definitions/FrameworkId" + }, + "Name": { + "$ref": "#/definitions/AssessmentName" + }, + "Roles": { + "description": "The list of roles for the specified assessment.", + "items": { + "$ref": "#/definitions/Role" + }, + "type": "array" + }, + "Scope": { + "$ref": "#/definitions/Scope" + }, + "Status": { + "$ref": "#/definitions/AssessmentStatus" + }, + "Tags": { + "description": "The tags associated with the assessment.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AssessmentId", + "/properties/Arn", + "/properties/CreationTime" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::AuditManager::Assessment", + "writeOnlyProperties": [ + "/properties/Name", + "/properties/Description" + ] +} diff --git a/schema/aws-autoscaling-autoscalinggroup.json b/schema/aws-autoscaling-autoscalinggroup.json index d4290ea..0213a17 100644 --- a/schema/aws-autoscaling-autoscalinggroup.json +++ b/schema/aws-autoscaling-autoscalinggroup.json @@ -1,825 +1,825 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/LaunchConfigurationName", - "/properties/VPCZoneIdentifier", - "/properties/PlacementGroup", - "/properties/LaunchTemplate", - "/properties/MixedInstancesPolicy" - ], - "createOnlyProperties": [ - "/properties/InstanceId", - "/properties/AutoScalingGroupName" - ], - "definitions": { - "AcceleratorCountRequest": { - "additionalProperties": false, - "description": "``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.", - "properties": { - "Max": { - "description": "The maximum value.", - "type": "integer" - }, - "Min": { - "description": "The minimum value.", - "type": "integer" - } - }, - "type": "object" - }, - "AcceleratorTotalMemoryMiBRequest": { - "additionalProperties": false, - "description": "``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.", - "properties": { - "Max": { - "description": "The memory maximum in MiB.", - "type": "integer" - }, - "Min": { - "description": "The memory minimum in MiB.", - "type": "integer" - } - }, - "type": "object" - }, - "BaselineEbsBandwidthMbpsRequest": { - "additionalProperties": false, - "description": "``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.", - "properties": { - "Max": { - "description": "The maximum value in Mbps.", - "type": "integer" - }, - "Min": { - "description": "The minimum value in Mbps.", - "type": "integer" - } - }, - "type": "object" - }, - "InstanceMaintenancePolicy": { - "additionalProperties": false, - "dependencies": { - "MaxHealthyPercentage": [ - "MinHealthyPercentage" - ], - "MinHealthyPercentage": [ - "MaxHealthyPercentage" - ] - }, - "description": "``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "properties": { - "MaxHealthyPercentage": { - "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.\n Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.", - "type": "integer" - }, - "MinHealthyPercentage": { - "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``.", - "type": "integer" - } - }, - "type": "object" - }, - "InstanceRequirements": { - "additionalProperties": false, - "description": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*.\n ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.", - "properties": { - "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCountRequest", - "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" - }, - "AcceleratorManufacturers": { - "description": "Indicates whether instance types must have accelerators by specific manufacturers.\n + For instance types with NVIDIA devices, specify ``nvidia``.\n + For instance types with AMD devices, specify ``amd``.\n + For instance types with AWS devices, specify ``amazon-web-services``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AcceleratorNames": { - "description": "Lists the accelerators that must be on an instance type.\n + For instance types with NVIDIA A100 GPUs, specify ``a100``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\n + For instance types with NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA M60 GPUs, specify ``m60``.\n + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n \n Default: Any accelerator", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest", - "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB.\n Default: No minimum or maximum limits" - }, - "AcceleratorTypes": { - "description": "Lists the accelerator types that must be on an instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AllowedInstanceTypes": { - "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "BareMetal": { - "description": "Indicates whether bare metal instance types are included, excluded, or required.\n Default: ``excluded``", - "type": "string" - }, - "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest", - "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: No minimum or maximum limits" - }, - "BurstablePerformance": { - "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``excluded``", - "type": "string" - }, - "CpuManufacturers": { - "description": "Lists which specific CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n Default: Any manufacturer", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ExcludedInstanceTypes": { - "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. \n For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "InstanceGenerations": { - "description": "Indicates whether current or previous generation instance types are included.\n + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n + For previous generation instance types, specify ``previous``.\n \n Default: Any current or previous generation", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LocalStorage": { - "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``included``", - "type": "string" - }, - "LocalStorageTypes": { - "description": "Indicates the type of local storage that is required.\n + For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n + For instance types with solid state drive (SSD) storage, specify ``ssd``.\n \n Default: Any local storage type", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { - "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", - "type": "integer" - }, - "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpuRequest", - "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.\n Default: No minimum or maximum limits" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRequest", - "description": "The minimum and maximum instance memory size for an instance type, in MiB." - }, - "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbpsRequest", - "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" - }, - "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCountRequest", - "description": "The minimum and maximum number of network interfaces for an instance type.\n Default: No minimum or maximum limits" - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. \n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. \n Default: ``20``", - "type": "integer" - }, - "RequireHibernateSupport": { - "description": "Indicates whether instance types must provide On-Demand Instance hibernation support.\n Default: ``false``", - "type": "boolean" - }, - "SpotMaxPricePercentageOverLowestPrice": { - "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", - "type": "integer" - }, - "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGBRequest", - "description": "The minimum and maximum total local storage size for an instance type, in GB.\n Default: No minimum or maximum limits" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCountRequest", - "description": "The minimum and maximum number of vCPUs for an instance type." - } - }, - "required": [ - "MemoryMiB", - "VCpuCount" - ], - "type": "object" - }, - "InstancesDistribution": { - "additionalProperties": false, - "description": "Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.\n For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.", - "properties": { - "OnDemandAllocationStrategy": { - "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.", - "type": "string" - }, - "OnDemandBaseCapacity": { - "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.\n Default: 0\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", - "type": "integer" - }, - "OnDemandPercentageAboveBaseCapacity": { - "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n Default: 100\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", - "type": "integer" - }, - "SpotAllocationStrategy": { - "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.", - "type": "string" - }, - "SpotInstancePools": { - "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1\u201320.\n Default: 2", - "type": "integer" - }, - "SpotMaxPrice": { - "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (\"\") for the value.\n If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.\n Valid Range: Minimum value of 0.001", - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplate": { - "additionalProperties": false, - "description": "Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.\n ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.", - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/LaunchTemplateSpecification", - "description": "The launch template." - }, - "Overrides": { - "description": "Any properties that you specify override the same properties in the launch template.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LaunchTemplateOverrides" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "LaunchTemplateSpecification" - ], - "type": "object" - }, - "LaunchTemplateOverrides": { - "additionalProperties": false, - "description": "Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:\n + Override the instance type that is specified in the launch template.\n + Use multiple instance types.\n \n Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.\n After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.\n ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.", - "properties": { - "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirements", - "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``." - }, - "InstanceType": { - "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n You can specify up to 40 instance types per Auto Scaling group.", - "type": "string" - }, - "LaunchTemplateSpecification": { - "$ref": "#/definitions/LaunchTemplateSpecification", - "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. \n You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit." - }, - "WeightedCapacity": { - "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. \n If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.\n Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.", - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplateSpecification": { - "additionalProperties": false, - "description": "Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.\n You must specify the following:\n + The ID or the name of the launch template, but not both.\n + The version of the launch template.\n \n ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\n For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html).", - "properties": { - "LaunchTemplateId": { - "description": "The ID of the launch template.\n You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.", - "type": "string" - }, - "LaunchTemplateName": { - "description": "The name of the launch template.\n You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.", - "type": "string" - }, - "Version": { - "description": "The version number of the launch template.\n Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.", - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "LifecycleHookSpecification": { - "additionalProperties": false, - "description": "``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. \n For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource.", - "properties": { - "DefaultResult": { - "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.\n Valid values: ``CONTINUE`` | ``ABANDON``", - "type": "string" - }, - "HeartbeatTimeout": { - "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).", - "type": "integer" - }, - "LifecycleHookName": { - "description": "The name of the lifecycle hook.", - "type": "string" - }, - "LifecycleTransition": { - "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.\n + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.", - "type": "string" - }, - "NotificationMetadata": { - "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.", - "type": "string" - }, - "NotificationTargetARN": { - "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.", - "type": "string" - }, - "RoleARN": { - "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.", - "type": "string" - } - }, - "required": [ - "LifecycleHookName", - "LifecycleTransition" - ], - "type": "object" - }, - "MemoryGiBPerVCpuRequest": { - "additionalProperties": false, - "description": "``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.", - "properties": { - "Max": { - "description": "The memory maximum in GiB.", - "type": "number" - }, - "Min": { - "description": "The memory minimum in GiB.", - "type": "number" - } - }, - "type": "object" - }, - "MemoryMiBRequest": { - "additionalProperties": false, - "description": "``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.", - "properties": { - "Max": { - "description": "The memory maximum in MiB.", - "type": "integer" - }, - "Min": { - "description": "The memory minimum in MiB.", - "type": "integer" - } - }, - "type": "object" - }, - "MetricsCollection": { - "additionalProperties": false, - "description": "``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. \n For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.", - "properties": { - "Granularity": { - "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.", - "type": "string" - }, - "Metrics": { - "description": "Identifies the metrics to enable.\n You can specify one or more of the following metrics:\n + ``GroupMinSize`` \n + ``GroupMaxSize`` \n + ``GroupDesiredCapacity`` \n + ``GroupInServiceInstances`` \n + ``GroupPendingInstances`` \n + ``GroupStandbyInstances`` \n + ``GroupTerminatingInstances`` \n + ``GroupTotalInstances`` \n + ``GroupInServiceCapacity`` \n + ``GroupPendingCapacity`` \n + ``GroupStandbyCapacity`` \n + ``GroupTerminatingCapacity`` \n + ``GroupTotalCapacity`` \n + ``WarmPoolDesiredCapacity`` \n + ``WarmPoolWarmedCapacity`` \n + ``WarmPoolPendingCapacity`` \n + ``WarmPoolTerminatingCapacity`` \n + ``WarmPoolTotalCapacity`` \n + ``GroupAndWarmPoolDesiredCapacity`` \n + ``GroupAndWarmPoolTotalCapacity`` \n \n If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.\n For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Granularity" - ], - "type": "object" - }, - "MixedInstancesPolicy": { - "additionalProperties": false, - "description": "Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.\n A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.\n There are key differences between Spot Instances and On-Demand Instances:\n + The price for Spot Instances varies based on demand\n + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes\n \n When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. \n ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.", - "properties": { - "InstancesDistribution": { - "$ref": "#/definitions/InstancesDistribution", - "description": "The instances distribution." - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplate", - "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities." - } - }, - "required": [ - "LaunchTemplate" - ], - "type": "object" - }, - "NetworkBandwidthGbpsRequest": { - "additionalProperties": false, - "description": "``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.", - "properties": { - "Max": { - "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps).", - "type": "number" - }, - "Min": { - "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps).", - "type": "number" - } - }, - "type": "object" - }, - "NetworkInterfaceCountRequest": { - "additionalProperties": false, - "description": "``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.", - "properties": { - "Max": { - "description": "The maximum number of network interfaces.", - "type": "integer" - }, - "Min": { - "description": "The minimum number of network interfaces.", - "type": "integer" - } - }, - "type": "object" - }, - "NotificationConfiguration": { - "additionalProperties": false, - "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "properties": { - "NotificationTypes": { - "description": "A list of event types that send a notification. Event types can include any of the following types. \n *Allowed values*:\n + ``autoscaling:EC2_INSTANCE_LAUNCH`` \n + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` \n + ``autoscaling:EC2_INSTANCE_TERMINATE`` \n + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` \n + ``autoscaling:TEST_NOTIFICATION``", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TopicARN": { - "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic.", - "items": { - "type": "string" - }, - "type": [ - "string", - "array" - ] - } - }, - "required": [ - "TopicARN" - ], - "type": "object" - }, - "TagProperty": { - "additionalProperties": false, - "description": "A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.\n CloudFormation adds the following tags to all Auto Scaling groups and associated instances: \n + aws:cloudformation:stack-name\n + aws:cloudformation:stack-id\n + aws:cloudformation:logical-id", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "PropagateAtLaunch": { - "description": "Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.", - "type": "boolean" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key", - "PropagateAtLaunch" - ], - "type": "object" - }, - "TotalLocalStorageGBRequest": { - "additionalProperties": false, - "description": "``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.", - "properties": { - "Max": { - "description": "The storage maximum in GB.", - "type": "number" - }, - "Min": { - "description": "The storage minimum in GB.", - "type": "number" - } - }, - "type": "object" - }, - "VCpuCountRequest": { - "additionalProperties": false, - "description": "``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.", - "properties": { - "Max": { - "description": "The maximum number of vCPUs.", - "type": "integer" - }, - "Min": { - "description": "The minimum number of vCPUs.", - "type": "integer" - } - }, - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/NotificationConfiguration" - ], - "description": "The ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. \n For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). \n Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:CreateAutoScalingGroup", - "autoscaling:UpdateAutoScalingGroup", - "autoscaling:CreateOrUpdateTags", - "autoscaling:Describe*", - "autoscaling:EnableMetricsCollection", - "autoscaling:PutNotificationConfiguration", - "cloudwatch:PutMetricAlarm", - "ec2:Describe*", - "ec2:Get*", - "ec2:RunInstances", - "elasticloadbalancing:Describe*", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "managed-fleets:Get*", - "managed-fleets:CreateAutoScalingGroup", - "managed-fleets:UpdateAutoScalingGroup", - "ssm:Get*" - ], - "timeoutInMinutes": 360 - }, - "delete": { - "permissions": [ - "autoscaling:DeleteAutoScalingGroup", - "autoscaling:UpdateAutoScalingGroup", - "autoscaling:Describe*", - "managed-fleets:Get*", - "managed-fleets:DeleteAutoScalingGroup" - ], - "timeoutInMinutes": 240 - }, - "list": { - "permissions": [ - "autoscaling:Describe*" - ] - }, - "read": { - "permissions": [ - "autoscaling:Describe*", - "managed-fleets:Get*" - ] - }, - "update": { - "permissions": [ - "autoscaling:UpdateAutoScalingGroup", - "autoscaling:CreateOrUpdateTags", - "autoscaling:DeleteTags", - "autoscaling:Describe*", - "autoscaling:EnableMetricsCollection", - "autoscaling:DisableMetricsCollection", - "autoscaling:PutNotificationConfiguration", - "autoscaling:DeleteNotificationConfiguration", - "autoscaling:DetachLoadBalancerTargetGroups", - "autoscaling:AttachLoadBalancerTargetGroups", - "autoscaling:AttachLoadBalancers", - "autoscaling:DetachLoadBalancers", - "autoscaling:AttachTrafficSources", - "autoscaling:DetachTrafficSources", - "autoscaling:DeleteLifecycleHook", - "autoscaling:PutLifecycleHook", - "cloudwatch:PutMetricAlarm", - "ec2:Describe*", - "ec2:Get*", - "ec2:RunInstances", - "elasticloadbalancing:Describe*", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "managed-fleets:Get*", - "managed-fleets:RegisterAutoScalingGroup", - "managed-fleets:DeregisterAutoScalingGroup", - "managed-fleets:UpdateAutoScalingGroup", - "ssm:Get*" - ], - "timeoutInMinutes": 660 - } - }, - "primaryIdentifier": [ - "/properties/AutoScalingGroupName" - ], - "properties": { - "AutoScalingGroupName": { - "description": "The name of the Auto Scaling group. This name must be unique per Region per account.\n The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use a colon (:) in the name.", - "type": "string" - }, - "AvailabilityZones": { - "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CapacityRebalance": { - "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.", - "type": "boolean" - }, - "Context": { - "description": "Reserved.", - "type": "string" - }, - "Cooldown": { - "description": "*Only needed if you use simple scaling policies.* \n The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``300`` seconds", - "type": "string" - }, - "DefaultInstanceWarmup": { - "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. \n During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.\n To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.\n Default: None", - "type": "integer" - }, - "DesiredCapacity": { - "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.", - "pattern": "^[0-9]+$", - "type": "string" - }, - "DesiredCapacityType": { - "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.\n By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.\n Valid values: ``units`` | ``vcpu`` | ``memory-mib``", - "type": "string" - }, - "HealthCheckGracePeriod": { - "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``0`` seconds", - "type": "integer" - }, - "HealthCheckType": { - "description": "A comma-separated value string of one or more health check types.\n The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Only specify ``EC2`` if you must clear a value that was previously set.", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.\n If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.", - "type": "string" - }, - "InstanceMaintenancePolicy": { - "$ref": "#/definitions/InstanceMaintenancePolicy", - "description": "An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*." - }, - "LaunchConfigurationName": { - "description": "The name of the launch configuration to use to launch instances.\n Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.", - "type": "string" - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification", - "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``." - }, - "LifecycleHookSpecificationList": { - "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LifecycleHookSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "LoadBalancerNames": { - "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxInstanceLifetime": { - "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "type": "integer" - }, - "MaxSize": { - "description": "The maximum size of the group.\n With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).", - "pattern": "^[0-9]+$", - "type": "string" - }, - "MetricsCollection": { - "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricsCollection" - }, - "type": "array", - "uniqueItems": false - }, - "MinSize": { - "description": "The minimum size of the group.", - "pattern": "^[0-9]+$", - "type": "string" - }, - "MixedInstancesPolicy": { - "$ref": "#/definitions/MixedInstancesPolicy", - "description": "An embedded object that specifies a mixed instances policy.\n The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information\u2014the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.\n For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*." - }, - "NewInstancesProtectedFromScaleIn": { - "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "type": "boolean" - }, - "NotificationConfiguration": { - "$ref": "#/definitions/NotificationConfiguration", - "description": "" - }, - "NotificationConfigurations": { - "description": "Configures an Auto Scaling group to send notifications when specified events take place.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NotificationConfiguration" - }, - "type": "array", - "uniqueItems": false - }, - "PlacementGroup": { - "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.\n A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.", - "type": "string" - }, - "ServiceLinkedRoleARN": { - "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "type": "string" - }, - "Tags": { - "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagProperty" - }, - "type": "array" - }, - "TargetGroupARNs": { - "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TerminationPolicies": { - "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VPCZoneIdentifier": { - "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.\n If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).\n When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).\n Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "propertyTransform": { - "/properties/LaunchConfigurationName": "InstanceId? AutoScalingGroupName : LaunchConfigurationName" - }, - "required": [ - "MinSize", - "MaxSize" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::AutoScaling::AutoScalingGroup", - "writeOnlyProperties": [ - "/properties/InstanceId" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/LaunchConfigurationName", + "/properties/VPCZoneIdentifier", + "/properties/PlacementGroup", + "/properties/LaunchTemplate", + "/properties/MixedInstancesPolicy" + ], + "createOnlyProperties": [ + "/properties/InstanceId", + "/properties/AutoScalingGroupName" + ], + "definitions": { + "AcceleratorCountRequest": { + "additionalProperties": false, + "description": "``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.", + "properties": { + "Max": { + "description": "The maximum value.", + "type": "integer" + }, + "Min": { + "description": "The minimum value.", + "type": "integer" + } + }, + "type": "object" + }, + "AcceleratorTotalMemoryMiBRequest": { + "additionalProperties": false, + "description": "``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.", + "properties": { + "Max": { + "description": "The memory maximum in MiB.", + "type": "integer" + }, + "Min": { + "description": "The memory minimum in MiB.", + "type": "integer" + } + }, + "type": "object" + }, + "BaselineEbsBandwidthMbpsRequest": { + "additionalProperties": false, + "description": "``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.", + "properties": { + "Max": { + "description": "The maximum value in Mbps.", + "type": "integer" + }, + "Min": { + "description": "The minimum value in Mbps.", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceMaintenancePolicy": { + "additionalProperties": false, + "dependencies": { + "MaxHealthyPercentage": [ + "MinHealthyPercentage" + ], + "MinHealthyPercentage": [ + "MaxHealthyPercentage" + ] + }, + "description": "``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "properties": { + "MaxHealthyPercentage": { + "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.\n Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.", + "type": "integer" + }, + "MinHealthyPercentage": { + "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``.", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceRequirements": { + "additionalProperties": false, + "description": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*.\n ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.", + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRequest", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" + }, + "AcceleratorManufacturers": { + "description": "Indicates whether instance types must have accelerators by specific manufacturers.\n + For instance types with NVIDIA devices, specify ``nvidia``.\n + For instance types with AMD devices, specify ``amd``.\n + For instance types with AWS devices, specify ``amazon-web-services``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AcceleratorNames": { + "description": "Lists the accelerators that must be on an instance type.\n + For instance types with NVIDIA A100 GPUs, specify ``a100``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\n + For instance types with NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA M60 GPUs, specify ``m60``.\n + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n \n Default: Any accelerator", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest", + "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB.\n Default: No minimum or maximum limits" + }, + "AcceleratorTypes": { + "description": "Lists the accelerator types that must be on an instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AllowedInstanceTypes": { + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "BareMetal": { + "description": "Indicates whether bare metal instance types are included, excluded, or required.\n Default: ``excluded``", + "type": "string" + }, + "BaselineEbsBandwidthMbps": { + "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest", + "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: No minimum or maximum limits" + }, + "BurstablePerformance": { + "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``excluded``", + "type": "string" + }, + "CpuManufacturers": { + "description": "Lists which specific CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n Default: Any manufacturer", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ExcludedInstanceTypes": { + "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. \n For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "InstanceGenerations": { + "description": "Indicates whether current or previous generation instance types are included.\n + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n + For previous generation instance types, specify ``previous``.\n \n Default: Any current or previous generation", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LocalStorage": { + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``included``", + "type": "string" + }, + "LocalStorageTypes": { + "description": "Indicates the type of local storage that is required.\n + For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n + For instance types with solid state drive (SSD) storage, specify ``ssd``.\n \n Default: Any local storage type", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", + "type": "integer" + }, + "MemoryGiBPerVCpu": { + "$ref": "#/definitions/MemoryGiBPerVCpuRequest", + "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.\n Default: No minimum or maximum limits" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRequest", + "description": "The minimum and maximum instance memory size for an instance type, in MiB." + }, + "NetworkBandwidthGbps": { + "$ref": "#/definitions/NetworkBandwidthGbpsRequest", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" + }, + "NetworkInterfaceCount": { + "$ref": "#/definitions/NetworkInterfaceCountRequest", + "description": "The minimum and maximum number of network interfaces for an instance type.\n Default: No minimum or maximum limits" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. \n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. \n Default: ``20``", + "type": "integer" + }, + "RequireHibernateSupport": { + "description": "Indicates whether instance types must provide On-Demand Instance hibernation support.\n Default: ``false``", + "type": "boolean" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", + "type": "integer" + }, + "TotalLocalStorageGB": { + "$ref": "#/definitions/TotalLocalStorageGBRequest", + "description": "The minimum and maximum total local storage size for an instance type, in GB.\n Default: No minimum or maximum limits" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRequest", + "description": "The minimum and maximum number of vCPUs for an instance type." + } + }, + "required": [ + "MemoryMiB", + "VCpuCount" + ], + "type": "object" + }, + "InstancesDistribution": { + "additionalProperties": false, + "description": "Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.\n For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.", + "properties": { + "OnDemandAllocationStrategy": { + "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.", + "type": "string" + }, + "OnDemandBaseCapacity": { + "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.\n Default: 0\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", + "type": "integer" + }, + "OnDemandPercentageAboveBaseCapacity": { + "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n Default: 100\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", + "type": "integer" + }, + "SpotAllocationStrategy": { + "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.", + "type": "string" + }, + "SpotInstancePools": { + "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1\u201320.\n Default: 2", + "type": "integer" + }, + "SpotMaxPrice": { + "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (\"\") for the value.\n If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.\n Valid Range: Minimum value of 0.001", + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplate": { + "additionalProperties": false, + "description": "Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.\n ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.", + "properties": { + "LaunchTemplateSpecification": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "The launch template." + }, + "Overrides": { + "description": "Any properties that you specify override the same properties in the launch template.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LaunchTemplateOverrides" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "LaunchTemplateSpecification" + ], + "type": "object" + }, + "LaunchTemplateOverrides": { + "additionalProperties": false, + "description": "Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:\n + Override the instance type that is specified in the launch template.\n + Use multiple instance types.\n \n Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.\n After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.\n ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.", + "properties": { + "InstanceRequirements": { + "$ref": "#/definitions/InstanceRequirements", + "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``." + }, + "InstanceType": { + "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n You can specify up to 40 instance types per Auto Scaling group.", + "type": "string" + }, + "LaunchTemplateSpecification": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. \n You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit." + }, + "WeightedCapacity": { + "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. \n If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.\n Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.", + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplateSpecification": { + "additionalProperties": false, + "description": "Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.\n You must specify the following:\n + The ID or the name of the launch template, but not both.\n + The version of the launch template.\n \n ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\n For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html).", + "properties": { + "LaunchTemplateId": { + "description": "The ID of the launch template.\n You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.", + "type": "string" + }, + "LaunchTemplateName": { + "description": "The name of the launch template.\n You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.", + "type": "string" + }, + "Version": { + "description": "The version number of the launch template.\n Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.", + "type": "string" + } + }, + "required": [ + "Version" + ], + "type": "object" + }, + "LifecycleHookSpecification": { + "additionalProperties": false, + "description": "``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. \n For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource.", + "properties": { + "DefaultResult": { + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.\n Valid values: ``CONTINUE`` | ``ABANDON``", + "type": "string" + }, + "HeartbeatTimeout": { + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).", + "type": "integer" + }, + "LifecycleHookName": { + "description": "The name of the lifecycle hook.", + "type": "string" + }, + "LifecycleTransition": { + "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.\n + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.", + "type": "string" + }, + "NotificationMetadata": { + "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.", + "type": "string" + }, + "NotificationTargetARN": { + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.", + "type": "string" + }, + "RoleARN": { + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.", + "type": "string" + } + }, + "required": [ + "LifecycleHookName", + "LifecycleTransition" + ], + "type": "object" + }, + "MemoryGiBPerVCpuRequest": { + "additionalProperties": false, + "description": "``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.", + "properties": { + "Max": { + "description": "The memory maximum in GiB.", + "type": "number" + }, + "Min": { + "description": "The memory minimum in GiB.", + "type": "number" + } + }, + "type": "object" + }, + "MemoryMiBRequest": { + "additionalProperties": false, + "description": "``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.", + "properties": { + "Max": { + "description": "The memory maximum in MiB.", + "type": "integer" + }, + "Min": { + "description": "The memory minimum in MiB.", + "type": "integer" + } + }, + "type": "object" + }, + "MetricsCollection": { + "additionalProperties": false, + "description": "``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. \n For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.", + "properties": { + "Granularity": { + "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.", + "type": "string" + }, + "Metrics": { + "description": "Identifies the metrics to enable.\n You can specify one or more of the following metrics:\n + ``GroupMinSize`` \n + ``GroupMaxSize`` \n + ``GroupDesiredCapacity`` \n + ``GroupInServiceInstances`` \n + ``GroupPendingInstances`` \n + ``GroupStandbyInstances`` \n + ``GroupTerminatingInstances`` \n + ``GroupTotalInstances`` \n + ``GroupInServiceCapacity`` \n + ``GroupPendingCapacity`` \n + ``GroupStandbyCapacity`` \n + ``GroupTerminatingCapacity`` \n + ``GroupTotalCapacity`` \n + ``WarmPoolDesiredCapacity`` \n + ``WarmPoolWarmedCapacity`` \n + ``WarmPoolPendingCapacity`` \n + ``WarmPoolTerminatingCapacity`` \n + ``WarmPoolTotalCapacity`` \n + ``GroupAndWarmPoolDesiredCapacity`` \n + ``GroupAndWarmPoolTotalCapacity`` \n \n If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.\n For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Granularity" + ], + "type": "object" + }, + "MixedInstancesPolicy": { + "additionalProperties": false, + "description": "Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.\n A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.\n There are key differences between Spot Instances and On-Demand Instances:\n + The price for Spot Instances varies based on demand\n + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes\n \n When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. \n ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.", + "properties": { + "InstancesDistribution": { + "$ref": "#/definitions/InstancesDistribution", + "description": "The instances distribution." + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplate", + "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities." + } + }, + "required": [ + "LaunchTemplate" + ], + "type": "object" + }, + "NetworkBandwidthGbpsRequest": { + "additionalProperties": false, + "description": "``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.", + "properties": { + "Max": { + "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps).", + "type": "number" + }, + "Min": { + "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps).", + "type": "number" + } + }, + "type": "object" + }, + "NetworkInterfaceCountRequest": { + "additionalProperties": false, + "description": "``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.", + "properties": { + "Max": { + "description": "The maximum number of network interfaces.", + "type": "integer" + }, + "Min": { + "description": "The minimum number of network interfaces.", + "type": "integer" + } + }, + "type": "object" + }, + "NotificationConfiguration": { + "additionalProperties": false, + "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "properties": { + "NotificationTypes": { + "description": "A list of event types that send a notification. Event types can include any of the following types. \n *Allowed values*:\n + ``autoscaling:EC2_INSTANCE_LAUNCH`` \n + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` \n + ``autoscaling:EC2_INSTANCE_TERMINATE`` \n + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` \n + ``autoscaling:TEST_NOTIFICATION``", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TopicARN": { + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic.", + "items": { + "type": "string" + }, + "type": [ + "string", + "array" + ] + } + }, + "required": [ + "TopicARN" + ], + "type": "object" + }, + "TagProperty": { + "additionalProperties": false, + "description": "A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.\n CloudFormation adds the following tags to all Auto Scaling groups and associated instances: \n + aws:cloudformation:stack-name\n + aws:cloudformation:stack-id\n + aws:cloudformation:logical-id", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "PropagateAtLaunch": { + "description": "Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.", + "type": "boolean" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key", + "PropagateAtLaunch" + ], + "type": "object" + }, + "TotalLocalStorageGBRequest": { + "additionalProperties": false, + "description": "``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.", + "properties": { + "Max": { + "description": "The storage maximum in GB.", + "type": "number" + }, + "Min": { + "description": "The storage minimum in GB.", + "type": "number" + } + }, + "type": "object" + }, + "VCpuCountRequest": { + "additionalProperties": false, + "description": "``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.", + "properties": { + "Max": { + "description": "The maximum number of vCPUs.", + "type": "integer" + }, + "Min": { + "description": "The minimum number of vCPUs.", + "type": "integer" + } + }, + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/NotificationConfiguration" + ], + "description": "The ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. \n For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). \n Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:CreateAutoScalingGroup", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:CreateOrUpdateTags", + "autoscaling:Describe*", + "autoscaling:EnableMetricsCollection", + "autoscaling:PutNotificationConfiguration", + "cloudwatch:PutMetricAlarm", + "ec2:Describe*", + "ec2:Get*", + "ec2:RunInstances", + "elasticloadbalancing:Describe*", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "managed-fleets:Get*", + "managed-fleets:CreateAutoScalingGroup", + "managed-fleets:UpdateAutoScalingGroup", + "ssm:Get*" + ], + "timeoutInMinutes": 360 + }, + "delete": { + "permissions": [ + "autoscaling:DeleteAutoScalingGroup", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:Describe*", + "managed-fleets:Get*", + "managed-fleets:DeleteAutoScalingGroup" + ], + "timeoutInMinutes": 240 + }, + "list": { + "permissions": [ + "autoscaling:Describe*" + ] + }, + "read": { + "permissions": [ + "autoscaling:Describe*", + "managed-fleets:Get*" + ] + }, + "update": { + "permissions": [ + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:CreateOrUpdateTags", + "autoscaling:DeleteTags", + "autoscaling:Describe*", + "autoscaling:EnableMetricsCollection", + "autoscaling:DisableMetricsCollection", + "autoscaling:PutNotificationConfiguration", + "autoscaling:DeleteNotificationConfiguration", + "autoscaling:DetachLoadBalancerTargetGroups", + "autoscaling:AttachLoadBalancerTargetGroups", + "autoscaling:AttachLoadBalancers", + "autoscaling:DetachLoadBalancers", + "autoscaling:AttachTrafficSources", + "autoscaling:DetachTrafficSources", + "autoscaling:DeleteLifecycleHook", + "autoscaling:PutLifecycleHook", + "cloudwatch:PutMetricAlarm", + "ec2:Describe*", + "ec2:Get*", + "ec2:RunInstances", + "elasticloadbalancing:Describe*", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "managed-fleets:Get*", + "managed-fleets:RegisterAutoScalingGroup", + "managed-fleets:DeregisterAutoScalingGroup", + "managed-fleets:UpdateAutoScalingGroup", + "ssm:Get*" + ], + "timeoutInMinutes": 660 + } + }, + "primaryIdentifier": [ + "/properties/AutoScalingGroupName" + ], + "properties": { + "AutoScalingGroupName": { + "description": "The name of the Auto Scaling group. This name must be unique per Region per account.\n The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use a colon (:) in the name.", + "type": "string" + }, + "AvailabilityZones": { + "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CapacityRebalance": { + "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.", + "type": "boolean" + }, + "Context": { + "description": "Reserved.", + "type": "string" + }, + "Cooldown": { + "description": "*Only needed if you use simple scaling policies.* \n The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``300`` seconds", + "type": "string" + }, + "DefaultInstanceWarmup": { + "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. \n During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.\n To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.\n Default: None", + "type": "integer" + }, + "DesiredCapacity": { + "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.", + "pattern": "^[0-9]+$", + "type": "string" + }, + "DesiredCapacityType": { + "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.\n By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.\n Valid values: ``units`` | ``vcpu`` | ``memory-mib``", + "type": "string" + }, + "HealthCheckGracePeriod": { + "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``0`` seconds", + "type": "integer" + }, + "HealthCheckType": { + "description": "A comma-separated value string of one or more health check types.\n The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Only specify ``EC2`` if you must clear a value that was previously set.", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.\n If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.", + "type": "string" + }, + "InstanceMaintenancePolicy": { + "$ref": "#/definitions/InstanceMaintenancePolicy", + "description": "An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "LaunchConfigurationName": { + "description": "The name of the launch configuration to use to launch instances.\n Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.", + "type": "string" + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``." + }, + "LifecycleHookSpecificationList": { + "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LifecycleHookSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "LoadBalancerNames": { + "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxInstanceLifetime": { + "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "type": "integer" + }, + "MaxSize": { + "description": "The maximum size of the group.\n With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).", + "pattern": "^[0-9]+$", + "type": "string" + }, + "MetricsCollection": { + "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricsCollection" + }, + "type": "array", + "uniqueItems": false + }, + "MinSize": { + "description": "The minimum size of the group.", + "pattern": "^[0-9]+$", + "type": "string" + }, + "MixedInstancesPolicy": { + "$ref": "#/definitions/MixedInstancesPolicy", + "description": "An embedded object that specifies a mixed instances policy.\n The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information\u2014the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.\n For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "NewInstancesProtectedFromScaleIn": { + "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "type": "boolean" + }, + "NotificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration", + "description": "" + }, + "NotificationConfigurations": { + "description": "Configures an Auto Scaling group to send notifications when specified events take place.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NotificationConfiguration" + }, + "type": "array", + "uniqueItems": false + }, + "PlacementGroup": { + "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.\n A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.", + "type": "string" + }, + "ServiceLinkedRoleARN": { + "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "type": "string" + }, + "Tags": { + "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagProperty" + }, + "type": "array" + }, + "TargetGroupARNs": { + "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TerminationPolicies": { + "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VPCZoneIdentifier": { + "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.\n If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).\n When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).\n Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "propertyTransform": { + "/properties/LaunchConfigurationName": "InstanceId? AutoScalingGroupName : LaunchConfigurationName" + }, + "required": [ + "MinSize", + "MaxSize" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AutoScaling::AutoScalingGroup", + "writeOnlyProperties": [ + "/properties/InstanceId" + ] +} diff --git a/schema/aws-autoscaling-launchconfiguration.json b/schema/aws-autoscaling-launchconfiguration.json index e0dde6c..783347d 100644 --- a/schema/aws-autoscaling-launchconfiguration.json +++ b/schema/aws-autoscaling-launchconfiguration.json @@ -1,255 +1,255 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AssociatePublicIpAddress", - "/properties/BlockDeviceMappings", - "/properties/ClassicLinkVPCId", - "/properties/ClassicLinkVPCSecurityGroups", - "/properties/EbsOptimized", - "/properties/IamInstanceProfile", - "/properties/ImageId", - "/properties/InstanceId", - "/properties/InstanceMonitoring", - "/properties/InstanceType", - "/properties/KernelId", - "/properties/KeyName", - "/properties/LaunchConfigurationName", - "/properties/MetadataOptions", - "/properties/PlacementTenancy", - "/properties/RamDiskId", - "/properties/SecurityGroups", - "/properties/SpotPrice", - "/properties/UserData" - ], - "definitions": { - "BlockDevice": { - "additionalProperties": false, - "description": "BlockDevice is a subproperty of BlockDeviceMapping that describes an Amazon EBS volume.", - "properties": { - "DeleteOnTermination": { - "description": "Indicates whether the volume is deleted on instance termination. ", - "type": "boolean" - }, - "Encrypted": { - "description": "Specifies whether the volume should be encrypted. ", - "type": "boolean" - }, - "Iops": { - "description": "The number of input/output (I/O) operations per second (IOPS) to provision for the volume. ", - "type": "integer" - }, - "SnapshotId": { - "description": "The snapshot ID of the volume to use.", - "type": "string" - }, - "Throughput": { - "description": "The throughput (MiBps) to provision for a gp3 volume.", - "type": "integer" - }, - "VolumeSize": { - "description": "The volume size, in GiBs.", - "type": "integer" - }, - "VolumeType": { - "description": "The volume type.", - "type": "string" - } - }, - "type": "object" - }, - "BlockDeviceMapping": { - "additionalProperties": false, - "description": "BlockDeviceMapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group.", - "properties": { - "DeviceName": { - "description": "The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). ", - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/BlockDevice", - "description": "Parameters used to automatically set up EBS volumes when an instance is launched." - }, - "NoDevice": { - "description": "Setting this value to true suppresses the specified device included in the block device mapping of the AMI.", - "type": "boolean" - }, - "VirtualName": { - "description": "The name of the virtual device.", - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "MetadataOptions": { - "additionalProperties": false, - "description": "MetadataOptions is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances.", - "properties": { - "HttpEndpoint": { - "description": "This parameter enables or disables the HTTP metadata endpoint on your instances.", - "type": "string" - }, - "HttpPutResponseHopLimit": { - "description": "The desired HTTP PUT response hop limit for instance metadata requests.", - "type": "integer" - }, - "HttpTokens": { - "description": "The state of token usage for your instance metadata requests.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:CreateLaunchConfiguration", - "autoscaling:DescribeLaunchConfigurations", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "autoscaling:DeleteLaunchConfiguration", - "autoscaling:DescribeLaunchConfigurations" - ] - }, - "list": { - "permissions": [ - "autoscaling:DescribeLaunchConfigurations" - ] - }, - "read": { - "permissions": [ - "autoscaling:DescribeLaunchConfigurations" - ] - } - }, - "primaryIdentifier": [ - "/properties/LaunchConfigurationName" - ], - "properties": { - "AssociatePublicIpAddress": { - "description": "For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.", - "type": "boolean" - }, - "BlockDeviceMappings": { - "description": "Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BlockDeviceMapping" - }, - "type": "array", - "uniqueItems": true - }, - "ClassicLinkVPCId": { - "description": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.", - "type": "string" - }, - "ClassicLinkVPCSecurityGroups": { - "description": "The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "EbsOptimized": { - "description": "Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false).", - "type": "boolean" - }, - "IamInstanceProfile": { - "description": "Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.", - "type": "string" - }, - "ImageId": { - "description": "Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the Amazon EC2 instance you want to use to create the launch configuration.", - "type": "string" - }, - "InstanceMonitoring": { - "description": "Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.", - "type": "boolean" - }, - "InstanceType": { - "description": "Specifies the instance type of the EC2 instance.", - "type": "string" - }, - "KernelId": { - "description": "Provides the ID of the kernel associated with the EC2 AMI.", - "type": "string" - }, - "KeyName": { - "description": "Provides the name of the EC2 key pair.", - "type": "string" - }, - "LaunchConfigurationName": { - "description": "The name of the launch configuration. This name must be unique per Region per account.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "MetadataOptions": { - "$ref": "#/definitions/MetadataOptions", - "description": "The metadata options for the instances." - }, - "PlacementTenancy": { - "description": "The tenancy of the instance, either default or dedicated.", - "type": "string" - }, - "RamDiskId": { - "description": "The ID of the RAM disk to select.", - "type": "string" - }, - "SecurityGroups": { - "description": "A list that contains the security groups to assign to the instances in the Auto Scaling group.", - "insertionOrder": false, - "items": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/GroupId", - "typeName": "AWS::EC2::SecurityGroup" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::SecurityGroup" - } - } - ], - "type": "string" - }, - "type": "array" - }, - "SpotPrice": { - "description": "The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.", - "type": "string" - }, - "UserData": { - "description": "The Base64-encoded user data to make available to the launched EC2 instances.", - "maxLength": 21847, - "type": "string" - } - }, - "required": [ - "ImageId", - "InstanceType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AutoScaling::LaunchConfiguration", - "writeOnlyProperties": [ - "/properties/InstanceId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AssociatePublicIpAddress", + "/properties/BlockDeviceMappings", + "/properties/ClassicLinkVPCId", + "/properties/ClassicLinkVPCSecurityGroups", + "/properties/EbsOptimized", + "/properties/IamInstanceProfile", + "/properties/ImageId", + "/properties/InstanceId", + "/properties/InstanceMonitoring", + "/properties/InstanceType", + "/properties/KernelId", + "/properties/KeyName", + "/properties/LaunchConfigurationName", + "/properties/MetadataOptions", + "/properties/PlacementTenancy", + "/properties/RamDiskId", + "/properties/SecurityGroups", + "/properties/SpotPrice", + "/properties/UserData" + ], + "definitions": { + "BlockDevice": { + "additionalProperties": false, + "description": "BlockDevice is a subproperty of BlockDeviceMapping that describes an Amazon EBS volume.", + "properties": { + "DeleteOnTermination": { + "description": "Indicates whether the volume is deleted on instance termination. ", + "type": "boolean" + }, + "Encrypted": { + "description": "Specifies whether the volume should be encrypted. ", + "type": "boolean" + }, + "Iops": { + "description": "The number of input/output (I/O) operations per second (IOPS) to provision for the volume. ", + "type": "integer" + }, + "SnapshotId": { + "description": "The snapshot ID of the volume to use.", + "type": "string" + }, + "Throughput": { + "description": "The throughput (MiBps) to provision for a gp3 volume.", + "type": "integer" + }, + "VolumeSize": { + "description": "The volume size, in GiBs.", + "type": "integer" + }, + "VolumeType": { + "description": "The volume type.", + "type": "string" + } + }, + "type": "object" + }, + "BlockDeviceMapping": { + "additionalProperties": false, + "description": "BlockDeviceMapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group.", + "properties": { + "DeviceName": { + "description": "The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). ", + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/BlockDevice", + "description": "Parameters used to automatically set up EBS volumes when an instance is launched." + }, + "NoDevice": { + "description": "Setting this value to true suppresses the specified device included in the block device mapping of the AMI.", + "type": "boolean" + }, + "VirtualName": { + "description": "The name of the virtual device.", + "type": "string" + } + }, + "required": [ + "DeviceName" + ], + "type": "object" + }, + "MetadataOptions": { + "additionalProperties": false, + "description": "MetadataOptions is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances.", + "properties": { + "HttpEndpoint": { + "description": "This parameter enables or disables the HTTP metadata endpoint on your instances.", + "type": "string" + }, + "HttpPutResponseHopLimit": { + "description": "The desired HTTP PUT response hop limit for instance metadata requests.", + "type": "integer" + }, + "HttpTokens": { + "description": "The state of token usage for your instance metadata requests.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:CreateLaunchConfiguration", + "autoscaling:DescribeLaunchConfigurations", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "autoscaling:DeleteLaunchConfiguration", + "autoscaling:DescribeLaunchConfigurations" + ] + }, + "list": { + "permissions": [ + "autoscaling:DescribeLaunchConfigurations" + ] + }, + "read": { + "permissions": [ + "autoscaling:DescribeLaunchConfigurations" + ] + } + }, + "primaryIdentifier": [ + "/properties/LaunchConfigurationName" + ], + "properties": { + "AssociatePublicIpAddress": { + "description": "For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.", + "type": "boolean" + }, + "BlockDeviceMappings": { + "description": "Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "type": "array", + "uniqueItems": true + }, + "ClassicLinkVPCId": { + "description": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.", + "type": "string" + }, + "ClassicLinkVPCSecurityGroups": { + "description": "The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "EbsOptimized": { + "description": "Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false).", + "type": "boolean" + }, + "IamInstanceProfile": { + "description": "Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.", + "type": "string" + }, + "ImageId": { + "description": "Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the Amazon EC2 instance you want to use to create the launch configuration.", + "type": "string" + }, + "InstanceMonitoring": { + "description": "Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.", + "type": "boolean" + }, + "InstanceType": { + "description": "Specifies the instance type of the EC2 instance.", + "type": "string" + }, + "KernelId": { + "description": "Provides the ID of the kernel associated with the EC2 AMI.", + "type": "string" + }, + "KeyName": { + "description": "Provides the name of the EC2 key pair.", + "type": "string" + }, + "LaunchConfigurationName": { + "description": "The name of the launch configuration. This name must be unique per Region per account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "MetadataOptions": { + "$ref": "#/definitions/MetadataOptions", + "description": "The metadata options for the instances." + }, + "PlacementTenancy": { + "description": "The tenancy of the instance, either default or dedicated.", + "type": "string" + }, + "RamDiskId": { + "description": "The ID of the RAM disk to select.", + "type": "string" + }, + "SecurityGroups": { + "description": "A list that contains the security groups to assign to the instances in the Auto Scaling group.", + "insertionOrder": false, + "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/GroupId", + "typeName": "AWS::EC2::SecurityGroup" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + } + } + ], + "type": "string" + }, + "type": "array" + }, + "SpotPrice": { + "description": "The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.", + "type": "string" + }, + "UserData": { + "description": "The Base64-encoded user data to make available to the launched EC2 instances.", + "maxLength": 21847, + "type": "string" + } + }, + "required": [ + "ImageId", + "InstanceType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AutoScaling::LaunchConfiguration", + "writeOnlyProperties": [ + "/properties/InstanceId" + ] +} diff --git a/schema/aws-autoscaling-lifecyclehook.json b/schema/aws-autoscaling-lifecyclehook.json index 2f6494a..0b43afd 100644 --- a/schema/aws-autoscaling-lifecyclehook.json +++ b/schema/aws-autoscaling-lifecyclehook.json @@ -1,92 +1,92 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingGroupName", - "/properties/LifecycleHookName" - ], - "description": "Resource Type definition for AWS::AutoScaling::LifecycleHook", - "handlers": { - "create": { - "permissions": [ - "autoscaling:PutLifecycleHook", - "autoscaling:DescribeLifecycleHooks", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "autoscaling:DeleteLifecycleHook", - "autoscaling:DescribeLifecycleHooks" - ] - }, - "list": { - "permissions": [ - "autoscaling:DescribeLifecycleHooks" - ] - }, - "read": { - "permissions": [ - "autoscaling:DescribeLifecycleHooks" - ] - }, - "update": { - "permissions": [ - "autoscaling:PutLifecycleHook", - "autoscaling:DescribeLifecycleHooks", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AutoScalingGroupName", - "/properties/LifecycleHookName" - ], - "properties": { - "AutoScalingGroupName": { - "description": "The name of the Auto Scaling group for the lifecycle hook.", - "type": "string" - }, - "DefaultResult": { - "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).", - "type": "string" - }, - "HeartbeatTimeout": { - "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.", - "type": "integer" - }, - "LifecycleHookName": { - "description": "The name of the lifecycle hook.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "LifecycleTransition": { - "description": "The instance state to which you want to attach the lifecycle hook.", - "type": "string" - }, - "NotificationMetadata": { - "description": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.", - "maxLength": 1023, - "minLength": 1, - "type": "string" - }, - "NotificationTargetARN": { - "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.", - "type": "string" - }, - "RoleARN": { - "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.", - "type": "string" - } - }, - "required": [ - "LifecycleTransition", - "AutoScalingGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AutoScaling::LifecycleHook" -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingGroupName", + "/properties/LifecycleHookName" + ], + "description": "Resource Type definition for AWS::AutoScaling::LifecycleHook", + "handlers": { + "create": { + "permissions": [ + "autoscaling:PutLifecycleHook", + "autoscaling:DescribeLifecycleHooks", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "autoscaling:DeleteLifecycleHook", + "autoscaling:DescribeLifecycleHooks" + ] + }, + "list": { + "permissions": [ + "autoscaling:DescribeLifecycleHooks" + ] + }, + "read": { + "permissions": [ + "autoscaling:DescribeLifecycleHooks" + ] + }, + "update": { + "permissions": [ + "autoscaling:PutLifecycleHook", + "autoscaling:DescribeLifecycleHooks", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AutoScalingGroupName", + "/properties/LifecycleHookName" + ], + "properties": { + "AutoScalingGroupName": { + "description": "The name of the Auto Scaling group for the lifecycle hook.", + "type": "string" + }, + "DefaultResult": { + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).", + "type": "string" + }, + "HeartbeatTimeout": { + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.", + "type": "integer" + }, + "LifecycleHookName": { + "description": "The name of the lifecycle hook.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "LifecycleTransition": { + "description": "The instance state to which you want to attach the lifecycle hook.", + "type": "string" + }, + "NotificationMetadata": { + "description": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.", + "maxLength": 1023, + "minLength": 1, + "type": "string" + }, + "NotificationTargetARN": { + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.", + "type": "string" + }, + "RoleARN": { + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.", + "type": "string" + } + }, + "required": [ + "LifecycleTransition", + "AutoScalingGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AutoScaling::LifecycleHook" +} diff --git a/schema/aws-autoscaling-scalingpolicy.json b/schema/aws-autoscaling-scalingpolicy.json index 9437289..6b90f13 100644 --- a/schema/aws-autoscaling-scalingpolicy.json +++ b/schema/aws-autoscaling-scalingpolicy.json @@ -1,488 +1,488 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingGroupName" - ], - "definitions": { - "CustomizedMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": true - }, - "MetricName": { - "type": "string" - }, - "Metrics": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetTrackingMetricDataQuery" - }, - "type": "array", - "uniqueItems": true - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "Metric": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": true - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace" - ], - "type": "object" - }, - "MetricDataQuery": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Label": { - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/MetricStat" - }, - "ReturnData": { - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "MetricStat": { - "additionalProperties": false, - "properties": { - "Metric": { - "$ref": "#/definitions/Metric" - }, - "Stat": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Stat", - "Metric" - ], - "type": "object" - }, - "PredefinedMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "PredictiveScalingConfiguration": { - "additionalProperties": false, - "properties": { - "MaxCapacityBreachBehavior": { - "type": "string" - }, - "MaxCapacityBuffer": { - "type": "integer" - }, - "MetricSpecifications": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PredictiveScalingMetricSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "Mode": { - "type": "string" - }, - "SchedulingBufferTime": { - "type": "integer" - } - }, - "required": [ - "MetricSpecifications" - ], - "type": "object" - }, - "PredictiveScalingCustomizedCapacityMetric": { - "additionalProperties": false, - "properties": { - "MetricDataQueries": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "MetricDataQueries" - ], - "type": "object" - }, - "PredictiveScalingCustomizedLoadMetric": { - "additionalProperties": false, - "properties": { - "MetricDataQueries": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "MetricDataQueries" - ], - "type": "object" - }, - "PredictiveScalingCustomizedScalingMetric": { - "additionalProperties": false, - "properties": { - "MetricDataQueries": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "MetricDataQueries" - ], - "type": "object" - }, - "PredictiveScalingMetricSpecification": { - "additionalProperties": false, - "properties": { - "CustomizedCapacityMetricSpecification": { - "$ref": "#/definitions/PredictiveScalingCustomizedCapacityMetric" - }, - "CustomizedLoadMetricSpecification": { - "$ref": "#/definitions/PredictiveScalingCustomizedLoadMetric" - }, - "CustomizedScalingMetricSpecification": { - "$ref": "#/definitions/PredictiveScalingCustomizedScalingMetric" - }, - "PredefinedLoadMetricSpecification": { - "$ref": "#/definitions/PredictiveScalingPredefinedLoadMetric" - }, - "PredefinedMetricPairSpecification": { - "$ref": "#/definitions/PredictiveScalingPredefinedMetricPair" - }, - "PredefinedScalingMetricSpecification": { - "$ref": "#/definitions/PredictiveScalingPredefinedScalingMetric" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "PredictiveScalingPredefinedLoadMetric": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "PredictiveScalingPredefinedMetricPair": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "PredictiveScalingPredefinedScalingMetric": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "StepAdjustment": { - "additionalProperties": false, - "insertionOrder": false, - "properties": { - "MetricIntervalLowerBound": { - "type": "number" - }, - "MetricIntervalUpperBound": { - "type": "number" - }, - "ScalingAdjustment": { - "type": "integer" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "TargetTrackingConfiguration": { - "additionalProperties": false, - "properties": { - "CustomizedMetricSpecification": { - "$ref": "#/definitions/CustomizedMetricSpecification" - }, - "DisableScaleIn": { - "type": "boolean" - }, - "PredefinedMetricSpecification": { - "$ref": "#/definitions/PredefinedMetricSpecification" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "TargetTrackingMetricDataQuery": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Label": { - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/TargetTrackingMetricStat" - }, - "ReturnData": { - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "TargetTrackingMetricStat": { - "additionalProperties": false, - "properties": { - "Metric": { - "$ref": "#/definitions/Metric" - }, - "Stat": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Stat", - "Metric" - ], - "type": "object" - } - }, - "description": "The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:DescribePolicies", - "autoscaling:PutScalingPolicy", - "cloudwatch:GetMetricData" - ] - }, - "delete": { - "permissions": [ - "autoscaling:DeletePolicy", - "autoscaling:DescribePolicies" - ] - }, - "list": { - "permissions": [ - "autoscaling:DescribePolicies" - ] - }, - "read": { - "permissions": [ - "autoscaling:DescribePolicies" - ] - }, - "update": { - "permissions": [ - "autoscaling:DescribePolicies", - "autoscaling:PutScalingPolicy", - "cloudwatch:GetMetricData" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AdjustmentType": { - "description": "Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.", - "type": "string" - }, - "Arn": { - "description": "The ARN of the AutoScaling scaling policy", - "type": "string" - }, - "AutoScalingGroupName": { - "description": "The name of the Auto Scaling group.", - "type": "string" - }, - "Cooldown": { - "description": "The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.", - "type": "string" - }, - "EstimatedInstanceWarmup": { - "description": "The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.", - "type": "integer" - }, - "MetricAggregationType": { - "description": "The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.", - "type": "string" - }, - "MinAdjustmentMagnitude": { - "description": "The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.", - "type": "integer" - }, - "PolicyName": { - "type": "string" - }, - "PolicyType": { - "description": "One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling", - "type": "string" - }, - "PredictiveScalingConfiguration": { - "$ref": "#/definitions/PredictiveScalingConfiguration", - "description": "A predictive scaling policy. Includes support for predefined metrics only." - }, - "ScalingAdjustment": { - "description": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)", - "type": "integer" - }, - "StepAdjustments": { - "description": "A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StepAdjustment" - }, - "type": "array", - "uniqueItems": true - }, - "TargetTrackingConfiguration": { - "$ref": "#/definitions/TargetTrackingConfiguration", - "description": "A target tracking scaling policy. Includes support for predefined or customized metrics." - } - }, - "readOnlyProperties": [ - "/properties/PolicyName", - "/properties/Arn" - ], - "required": [ - "AutoScalingGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::AutoScaling::ScalingPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingGroupName" + ], + "definitions": { + "CustomizedMetricSpecification": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": true + }, + "MetricName": { + "type": "string" + }, + "Metrics": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetTrackingMetricDataQuery" + }, + "type": "array", + "uniqueItems": true + }, + "Namespace": { + "type": "string" + }, + "Statistic": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "Metric": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": true + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + } + }, + "required": [ + "MetricName", + "Namespace" + ], + "type": "object" + }, + "MetricDataQuery": { + "additionalProperties": false, + "properties": { + "Expression": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Label": { + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/MetricStat" + }, + "ReturnData": { + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "MetricStat": { + "additionalProperties": false, + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Stat": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "Stat", + "Metric" + ], + "type": "object" + }, + "PredefinedMetricSpecification": { + "additionalProperties": false, + "properties": { + "PredefinedMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedMetricType" + ], + "type": "object" + }, + "PredictiveScalingConfiguration": { + "additionalProperties": false, + "properties": { + "MaxCapacityBreachBehavior": { + "type": "string" + }, + "MaxCapacityBuffer": { + "type": "integer" + }, + "MetricSpecifications": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PredictiveScalingMetricSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "Mode": { + "type": "string" + }, + "SchedulingBufferTime": { + "type": "integer" + } + }, + "required": [ + "MetricSpecifications" + ], + "type": "object" + }, + "PredictiveScalingCustomizedCapacityMetric": { + "additionalProperties": false, + "properties": { + "MetricDataQueries": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "MetricDataQueries" + ], + "type": "object" + }, + "PredictiveScalingCustomizedLoadMetric": { + "additionalProperties": false, + "properties": { + "MetricDataQueries": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "MetricDataQueries" + ], + "type": "object" + }, + "PredictiveScalingCustomizedScalingMetric": { + "additionalProperties": false, + "properties": { + "MetricDataQueries": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "MetricDataQueries" + ], + "type": "object" + }, + "PredictiveScalingMetricSpecification": { + "additionalProperties": false, + "properties": { + "CustomizedCapacityMetricSpecification": { + "$ref": "#/definitions/PredictiveScalingCustomizedCapacityMetric" + }, + "CustomizedLoadMetricSpecification": { + "$ref": "#/definitions/PredictiveScalingCustomizedLoadMetric" + }, + "CustomizedScalingMetricSpecification": { + "$ref": "#/definitions/PredictiveScalingCustomizedScalingMetric" + }, + "PredefinedLoadMetricSpecification": { + "$ref": "#/definitions/PredictiveScalingPredefinedLoadMetric" + }, + "PredefinedMetricPairSpecification": { + "$ref": "#/definitions/PredictiveScalingPredefinedMetricPair" + }, + "PredefinedScalingMetricSpecification": { + "$ref": "#/definitions/PredictiveScalingPredefinedScalingMetric" + }, + "TargetValue": { + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + }, + "PredictiveScalingPredefinedLoadMetric": { + "additionalProperties": false, + "properties": { + "PredefinedMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedMetricType" + ], + "type": "object" + }, + "PredictiveScalingPredefinedMetricPair": { + "additionalProperties": false, + "properties": { + "PredefinedMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedMetricType" + ], + "type": "object" + }, + "PredictiveScalingPredefinedScalingMetric": { + "additionalProperties": false, + "properties": { + "PredefinedMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedMetricType" + ], + "type": "object" + }, + "StepAdjustment": { + "additionalProperties": false, + "insertionOrder": false, + "properties": { + "MetricIntervalLowerBound": { + "type": "number" + }, + "MetricIntervalUpperBound": { + "type": "number" + }, + "ScalingAdjustment": { + "type": "integer" + } + }, + "required": [ + "ScalingAdjustment" + ], + "type": "object" + }, + "TargetTrackingConfiguration": { + "additionalProperties": false, + "properties": { + "CustomizedMetricSpecification": { + "$ref": "#/definitions/CustomizedMetricSpecification" + }, + "DisableScaleIn": { + "type": "boolean" + }, + "PredefinedMetricSpecification": { + "$ref": "#/definitions/PredefinedMetricSpecification" + }, + "TargetValue": { + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + }, + "TargetTrackingMetricDataQuery": { + "additionalProperties": false, + "properties": { + "Expression": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Label": { + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/TargetTrackingMetricStat" + }, + "ReturnData": { + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "TargetTrackingMetricStat": { + "additionalProperties": false, + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Stat": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "Stat", + "Metric" + ], + "type": "object" + } + }, + "description": "The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:DescribePolicies", + "autoscaling:PutScalingPolicy", + "cloudwatch:GetMetricData" + ] + }, + "delete": { + "permissions": [ + "autoscaling:DeletePolicy", + "autoscaling:DescribePolicies" + ] + }, + "list": { + "permissions": [ + "autoscaling:DescribePolicies" + ] + }, + "read": { + "permissions": [ + "autoscaling:DescribePolicies" + ] + }, + "update": { + "permissions": [ + "autoscaling:DescribePolicies", + "autoscaling:PutScalingPolicy", + "cloudwatch:GetMetricData" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AdjustmentType": { + "description": "Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.", + "type": "string" + }, + "Arn": { + "description": "The ARN of the AutoScaling scaling policy", + "type": "string" + }, + "AutoScalingGroupName": { + "description": "The name of the Auto Scaling group.", + "type": "string" + }, + "Cooldown": { + "description": "The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.", + "type": "string" + }, + "EstimatedInstanceWarmup": { + "description": "The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.", + "type": "integer" + }, + "MetricAggregationType": { + "description": "The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.", + "type": "string" + }, + "MinAdjustmentMagnitude": { + "description": "The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.", + "type": "integer" + }, + "PolicyName": { + "type": "string" + }, + "PolicyType": { + "description": "One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling", + "type": "string" + }, + "PredictiveScalingConfiguration": { + "$ref": "#/definitions/PredictiveScalingConfiguration", + "description": "A predictive scaling policy. Includes support for predefined metrics only." + }, + "ScalingAdjustment": { + "description": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)", + "type": "integer" + }, + "StepAdjustments": { + "description": "A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StepAdjustment" + }, + "type": "array", + "uniqueItems": true + }, + "TargetTrackingConfiguration": { + "$ref": "#/definitions/TargetTrackingConfiguration", + "description": "A target tracking scaling policy. Includes support for predefined or customized metrics." + } + }, + "readOnlyProperties": [ + "/properties/PolicyName", + "/properties/Arn" + ], + "required": [ + "AutoScalingGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::AutoScaling::ScalingPolicy" +} diff --git a/schema/aws-autoscaling-scheduledaction.json b/schema/aws-autoscaling-scheduledaction.json index 3a6cb13..6a270f5 100644 --- a/schema/aws-autoscaling-scheduledaction.json +++ b/schema/aws-autoscaling-scheduledaction.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingGroupName" - ], - "description": "The AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:PutScheduledUpdateGroupAction", - "autoscaling:DescribeScheduledActions" - ] - }, - "delete": { - "permissions": [ - "autoscaling:DeleteScheduledAction", - "autoscaling:DescribeScheduledActions" - ] - }, - "list": { - "permissions": [ - "autoscaling:DescribeScheduledActions" - ] - }, - "read": { - "permissions": [ - "autoscaling:DescribeScheduledActions" - ] - }, - "update": { - "permissions": [ - "autoscaling:PutScheduledUpdateGroupAction" - ] - } - }, - "primaryIdentifier": [ - "/properties/ScheduledActionName", - "/properties/AutoScalingGroupName" - ], - "properties": { - "AutoScalingGroupName": { - "description": "The name of the Auto Scaling group.", - "type": "string" - }, - "DesiredCapacity": { - "description": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.", - "type": "integer" - }, - "EndTime": { - "description": "The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.", - "type": "string" - }, - "MaxSize": { - "description": "The minimum size of the Auto Scaling group.", - "type": "integer" - }, - "MinSize": { - "description": "The minimum size of the Auto Scaling group.", - "type": "integer" - }, - "Recurrence": { - "description": "The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.", - "type": "string" - }, - "ScheduledActionName": { - "description": "Auto-generated unique identifier", - "type": "string" - }, - "StartTime": { - "description": "The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.", - "type": "string" - }, - "TimeZone": { - "description": "The time zone for the cron expression.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ScheduledActionName" - ], - "required": [ - "AutoScalingGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::AutoScaling::ScheduledAction" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingGroupName" + ], + "description": "The AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:PutScheduledUpdateGroupAction", + "autoscaling:DescribeScheduledActions" + ] + }, + "delete": { + "permissions": [ + "autoscaling:DeleteScheduledAction", + "autoscaling:DescribeScheduledActions" + ] + }, + "list": { + "permissions": [ + "autoscaling:DescribeScheduledActions" + ] + }, + "read": { + "permissions": [ + "autoscaling:DescribeScheduledActions" + ] + }, + "update": { + "permissions": [ + "autoscaling:PutScheduledUpdateGroupAction" + ] + } + }, + "primaryIdentifier": [ + "/properties/ScheduledActionName", + "/properties/AutoScalingGroupName" + ], + "properties": { + "AutoScalingGroupName": { + "description": "The name of the Auto Scaling group.", + "type": "string" + }, + "DesiredCapacity": { + "description": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.", + "type": "integer" + }, + "EndTime": { + "description": "The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.", + "type": "string" + }, + "MaxSize": { + "description": "The minimum size of the Auto Scaling group.", + "type": "integer" + }, + "MinSize": { + "description": "The minimum size of the Auto Scaling group.", + "type": "integer" + }, + "Recurrence": { + "description": "The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.", + "type": "string" + }, + "ScheduledActionName": { + "description": "Auto-generated unique identifier", + "type": "string" + }, + "StartTime": { + "description": "The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.", + "type": "string" + }, + "TimeZone": { + "description": "The time zone for the cron expression.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ScheduledActionName" + ], + "required": [ + "AutoScalingGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::AutoScaling::ScheduledAction" +} diff --git a/schema/aws-autoscaling-warmpool.json b/schema/aws-autoscaling-warmpool.json index d80d584..064f51f 100644 --- a/schema/aws-autoscaling-warmpool.json +++ b/schema/aws-autoscaling-warmpool.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingGroupName" - ], - "definitions": { - "InstanceReusePolicy": { - "additionalProperties": false, - "properties": { - "ReuseOnScaleIn": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::AutoScaling::WarmPool.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:PutWarmPool", - "autoscaling:DescribeWarmPool", - "autoscaling:DescribeAutoScalingGroups" - ] - }, - "delete": { - "permissions": [ - "autoscaling:DeleteWarmPool", - "autoscaling:DescribeWarmPool" - ] - }, - "read": { - "permissions": [ - "autoscaling:DescribeWarmPool" - ] - }, - "update": { - "permissions": [ - "autoscaling:PutWarmPool", - "autoscaling:DescribeWarmPool", - "autoscaling:DescribeAutoScalingGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/AutoScalingGroupName" - ], - "properties": { - "AutoScalingGroupName": { - "type": "string" - }, - "InstanceReusePolicy": { - "$ref": "#/definitions/InstanceReusePolicy" - }, - "MaxGroupPreparedCapacity": { - "type": "integer" - }, - "MinSize": { - "type": "integer" - }, - "PoolState": { - "type": "string" - } - }, - "required": [ - "AutoScalingGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling", - "typeName": "AWS::AutoScaling::WarmPool" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingGroupName" + ], + "definitions": { + "InstanceReusePolicy": { + "additionalProperties": false, + "properties": { + "ReuseOnScaleIn": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::AutoScaling::WarmPool.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:PutWarmPool", + "autoscaling:DescribeWarmPool", + "autoscaling:DescribeAutoScalingGroups" + ] + }, + "delete": { + "permissions": [ + "autoscaling:DeleteWarmPool", + "autoscaling:DescribeWarmPool" + ] + }, + "read": { + "permissions": [ + "autoscaling:DescribeWarmPool" + ] + }, + "update": { + "permissions": [ + "autoscaling:PutWarmPool", + "autoscaling:DescribeWarmPool", + "autoscaling:DescribeAutoScalingGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/AutoScalingGroupName" + ], + "properties": { + "AutoScalingGroupName": { + "type": "string" + }, + "InstanceReusePolicy": { + "$ref": "#/definitions/InstanceReusePolicy" + }, + "MaxGroupPreparedCapacity": { + "type": "integer" + }, + "MinSize": { + "type": "integer" + }, + "PoolState": { + "type": "string" + } + }, + "required": [ + "AutoScalingGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-autoscaling", + "typeName": "AWS::AutoScaling::WarmPool" +} diff --git a/schema/aws-autoscalingplans-scalingplan.json b/schema/aws-autoscalingplans-scalingplan.json index fc4a146..b4887f0 100644 --- a/schema/aws-autoscalingplans-scalingplan.json +++ b/schema/aws-autoscalingplans-scalingplan.json @@ -1,271 +1,271 @@ -{ - "additionalProperties": false, - "definitions": { - "ApplicationSource": { - "additionalProperties": false, - "properties": { - "CloudFormationStackARN": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "CustomizedLoadMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Statistic", - "Namespace" - ], - "type": "object" - }, - "CustomizedScalingMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Statistic", - "Namespace" - ], - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "PredefinedLoadMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedLoadMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedLoadMetricType" - ], - "type": "object" - }, - "PredefinedScalingMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedScalingMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedScalingMetricType" - ], - "type": "object" - }, - "ScalingInstruction": { - "additionalProperties": false, - "properties": { - "CustomizedLoadMetricSpecification": { - "$ref": "#/definitions/CustomizedLoadMetricSpecification" - }, - "DisableDynamicScaling": { - "type": "boolean" - }, - "MaxCapacity": { - "type": "integer" - }, - "MinCapacity": { - "type": "integer" - }, - "PredefinedLoadMetricSpecification": { - "$ref": "#/definitions/PredefinedLoadMetricSpecification" - }, - "PredictiveScalingMaxCapacityBehavior": { - "type": "string" - }, - "PredictiveScalingMaxCapacityBuffer": { - "type": "integer" - }, - "PredictiveScalingMode": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "ScalableDimension": { - "type": "string" - }, - "ScalingPolicyUpdateBehavior": { - "type": "string" - }, - "ScheduledActionBufferTime": { - "type": "integer" - }, - "ServiceNamespace": { - "type": "string" - }, - "TargetTrackingConfigurations": { - "items": { - "$ref": "#/definitions/TargetTrackingConfiguration" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ResourceId", - "ServiceNamespace", - "ScalableDimension", - "MinCapacity", - "TargetTrackingConfigurations", - "MaxCapacity" - ], - "type": "object" - }, - "TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "TargetTrackingConfiguration": { - "additionalProperties": false, - "properties": { - "CustomizedScalingMetricSpecification": { - "$ref": "#/definitions/CustomizedScalingMetricSpecification" - }, - "DisableScaleIn": { - "type": "boolean" - }, - "EstimatedInstanceWarmup": { - "type": "integer" - }, - "PredefinedScalingMetricSpecification": { - "$ref": "#/definitions/PredefinedScalingMetricSpecification" - }, - "ScaleInCooldown": { - "type": "integer" - }, - "ScaleOutCooldown": { - "type": "integer" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::AutoScalingPlans::ScalingPlan", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationSource": { - "$ref": "#/definitions/ApplicationSource" - }, - "Id": { - "type": "string" - }, - "ScalingInstructions": { - "items": { - "$ref": "#/definitions/ScalingInstruction" - }, - "type": "array", - "uniqueItems": false - }, - "ScalingPlanName": { - "type": "string" - }, - "ScalingPlanVersion": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ScalingPlanVersion", - "/properties/ScalingPlanName", - "/properties/Id" - ], - "required": [ - "ScalingInstructions", - "ApplicationSource" - ], - "typeName": "AWS::AutoScalingPlans::ScalingPlan" -} +{ + "additionalProperties": false, + "definitions": { + "ApplicationSource": { + "additionalProperties": false, + "properties": { + "CloudFormationStackARN": { + "type": "string" + }, + "TagFilters": { + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CustomizedLoadMetricSpecification": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "Statistic": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "MetricName", + "Statistic", + "Namespace" + ], + "type": "object" + }, + "CustomizedScalingMetricSpecification": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "Statistic": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "MetricName", + "Statistic", + "Namespace" + ], + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "PredefinedLoadMetricSpecification": { + "additionalProperties": false, + "properties": { + "PredefinedLoadMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedLoadMetricType" + ], + "type": "object" + }, + "PredefinedScalingMetricSpecification": { + "additionalProperties": false, + "properties": { + "PredefinedScalingMetricType": { + "type": "string" + }, + "ResourceLabel": { + "type": "string" + } + }, + "required": [ + "PredefinedScalingMetricType" + ], + "type": "object" + }, + "ScalingInstruction": { + "additionalProperties": false, + "properties": { + "CustomizedLoadMetricSpecification": { + "$ref": "#/definitions/CustomizedLoadMetricSpecification" + }, + "DisableDynamicScaling": { + "type": "boolean" + }, + "MaxCapacity": { + "type": "integer" + }, + "MinCapacity": { + "type": "integer" + }, + "PredefinedLoadMetricSpecification": { + "$ref": "#/definitions/PredefinedLoadMetricSpecification" + }, + "PredictiveScalingMaxCapacityBehavior": { + "type": "string" + }, + "PredictiveScalingMaxCapacityBuffer": { + "type": "integer" + }, + "PredictiveScalingMode": { + "type": "string" + }, + "ResourceId": { + "type": "string" + }, + "ScalableDimension": { + "type": "string" + }, + "ScalingPolicyUpdateBehavior": { + "type": "string" + }, + "ScheduledActionBufferTime": { + "type": "integer" + }, + "ServiceNamespace": { + "type": "string" + }, + "TargetTrackingConfigurations": { + "items": { + "$ref": "#/definitions/TargetTrackingConfiguration" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ResourceId", + "ServiceNamespace", + "ScalableDimension", + "MinCapacity", + "TargetTrackingConfigurations", + "MaxCapacity" + ], + "type": "object" + }, + "TagFilter": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "TargetTrackingConfiguration": { + "additionalProperties": false, + "properties": { + "CustomizedScalingMetricSpecification": { + "$ref": "#/definitions/CustomizedScalingMetricSpecification" + }, + "DisableScaleIn": { + "type": "boolean" + }, + "EstimatedInstanceWarmup": { + "type": "integer" + }, + "PredefinedScalingMetricSpecification": { + "$ref": "#/definitions/PredefinedScalingMetricSpecification" + }, + "ScaleInCooldown": { + "type": "integer" + }, + "ScaleOutCooldown": { + "type": "integer" + }, + "TargetValue": { + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AutoScalingPlans::ScalingPlan", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationSource": { + "$ref": "#/definitions/ApplicationSource" + }, + "Id": { + "type": "string" + }, + "ScalingInstructions": { + "items": { + "$ref": "#/definitions/ScalingInstruction" + }, + "type": "array", + "uniqueItems": false + }, + "ScalingPlanName": { + "type": "string" + }, + "ScalingPlanVersion": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ScalingPlanVersion", + "/properties/ScalingPlanName", + "/properties/Id" + ], + "required": [ + "ScalingInstructions", + "ApplicationSource" + ], + "typeName": "AWS::AutoScalingPlans::ScalingPlan" +} diff --git a/schema/aws-b2bi-capability.json b/schema/aws-b2bi-capability.json index 3ca9931..dc73ed5 100644 --- a/schema/aws-b2bi-capability.json +++ b/schema/aws-b2bi-capability.json @@ -1,328 +1,328 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type" - ], - "definitions": { - "CapabilityConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Edi": { - "$ref": "#/definitions/EdiConfiguration" - } - }, - "required": [ - "Edi" - ], - "title": "Edi", - "type": "object" - } - ] - }, - "CapabilityType": { - "enum": [ - "edi" - ], - "type": "string" - }, - "EdiConfiguration": { - "additionalProperties": false, - "properties": { - "InputLocation": { - "$ref": "#/definitions/S3Location" - }, - "OutputLocation": { - "$ref": "#/definitions/S3Location" - }, - "TransformerId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/EdiType" - } - }, - "required": [ - "InputLocation", - "OutputLocation", - "TransformerId", - "Type" - ], - "type": "object" - }, - "EdiType": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "X12Details": { - "$ref": "#/definitions/X12Details" - } - }, - "required": [ - "X12Details" - ], - "title": "X12Details", - "type": "object" - } - ] - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "BucketName": { - "maxLength": 63, - "minLength": 3, - "type": "string" - }, - "Key": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "X12Details": { - "additionalProperties": false, - "properties": { - "TransactionSet": { - "$ref": "#/definitions/X12TransactionSet" - }, - "Version": { - "$ref": "#/definitions/X12Version" - } - }, - "type": "object" - }, - "X12TransactionSet": { - "enum": [ - "X12_110", - "X12_180", - "X12_204", - "X12_210", - "X12_211", - "X12_214", - "X12_215", - "X12_259", - "X12_260", - "X12_266", - "X12_269", - "X12_270", - "X12_271", - "X12_274", - "X12_275", - "X12_276", - "X12_277", - "X12_278", - "X12_310", - "X12_315", - "X12_322", - "X12_404", - "X12_410", - "X12_417", - "X12_421", - "X12_426", - "X12_810", - "X12_820", - "X12_824", - "X12_830", - "X12_832", - "X12_834", - "X12_835", - "X12_837", - "X12_844", - "X12_846", - "X12_849", - "X12_850", - "X12_852", - "X12_855", - "X12_856", - "X12_860", - "X12_861", - "X12_864", - "X12_865", - "X12_869", - "X12_870", - "X12_940", - "X12_945", - "X12_990", - "X12_997", - "X12_999", - "X12_270_X279", - "X12_271_X279", - "X12_275_X210", - "X12_275_X211", - "X12_276_X212", - "X12_277_X212", - "X12_277_X214", - "X12_277_X364", - "X12_278_X217", - "X12_820_X218", - "X12_820_X306", - "X12_824_X186", - "X12_834_X220", - "X12_834_X307", - "X12_834_X318", - "X12_835_X221", - "X12_837_X222", - "X12_837_X223", - "X12_837_X224", - "X12_837_X291", - "X12_837_X292", - "X12_837_X298", - "X12_999_X231" - ], - "type": "string" - }, - "X12Version": { - "enum": [ - "VERSION_4010", - "VERSION_4030", - "VERSION_5010", - "VERSION_5010_HIPAA" - ], - "type": "string" - } - }, - "description": "Definition of AWS::B2BI::Capability Resource Type", - "handlers": { - "create": { - "permissions": [ - "b2bi:CreateCapability", - "b2bi:TagResource", - "events:ListRules", - "events:PutRule", - "events:PutTargets", - "logs:CreateLogDelivery", - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:DescribeLogGroups", - "logs:DescribeLogStreams", - "logs:DescribeResourcePolicies", - "logs:ListLogDeliveries", - "logs:PutLogEvents", - "logs:PutResourcePolicy", - "s3:GetObject", - "s3:ListBucket" - ] - }, - "delete": { - "permissions": [ - "b2bi:DeleteCapability" - ] - }, - "list": { - "permissions": [ - "b2bi:ListCapabilities" - ] - }, - "read": { - "permissions": [ - "b2bi:GetCapability", - "b2bi:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "b2bi:TagResource", - "b2bi:UntagResource", - "b2bi:UpdateCapability" - ] - } - }, - "primaryIdentifier": [ - "/properties/CapabilityId" - ], - "properties": { - "CapabilityArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "CapabilityId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/CapabilityConfiguration" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "InstructionsDocuments": { - "items": { - "$ref": "#/definitions/S3Location" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 254, - "minLength": 1, - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/CapabilityType" - } - }, - "readOnlyProperties": [ - "/properties/CapabilityArn", - "/properties/CapabilityId", - "/properties/CreatedAt", - "/properties/ModifiedAt" - ], - "required": [ - "Configuration", - "Name", - "Type" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::B2BI::Capability" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type" + ], + "definitions": { + "CapabilityConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Edi": { + "$ref": "#/definitions/EdiConfiguration" + } + }, + "required": [ + "Edi" + ], + "title": "Edi", + "type": "object" + } + ] + }, + "CapabilityType": { + "enum": [ + "edi" + ], + "type": "string" + }, + "EdiConfiguration": { + "additionalProperties": false, + "properties": { + "InputLocation": { + "$ref": "#/definitions/S3Location" + }, + "OutputLocation": { + "$ref": "#/definitions/S3Location" + }, + "TransformerId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/EdiType" + } + }, + "required": [ + "InputLocation", + "OutputLocation", + "TransformerId", + "Type" + ], + "type": "object" + }, + "EdiType": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "X12Details": { + "$ref": "#/definitions/X12Details" + } + }, + "required": [ + "X12Details" + ], + "title": "X12Details", + "type": "object" + } + ] + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "BucketName": { + "maxLength": 63, + "minLength": 3, + "type": "string" + }, + "Key": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "X12Details": { + "additionalProperties": false, + "properties": { + "TransactionSet": { + "$ref": "#/definitions/X12TransactionSet" + }, + "Version": { + "$ref": "#/definitions/X12Version" + } + }, + "type": "object" + }, + "X12TransactionSet": { + "enum": [ + "X12_110", + "X12_180", + "X12_204", + "X12_210", + "X12_211", + "X12_214", + "X12_215", + "X12_259", + "X12_260", + "X12_266", + "X12_269", + "X12_270", + "X12_271", + "X12_274", + "X12_275", + "X12_276", + "X12_277", + "X12_278", + "X12_310", + "X12_315", + "X12_322", + "X12_404", + "X12_410", + "X12_417", + "X12_421", + "X12_426", + "X12_810", + "X12_820", + "X12_824", + "X12_830", + "X12_832", + "X12_834", + "X12_835", + "X12_837", + "X12_844", + "X12_846", + "X12_849", + "X12_850", + "X12_852", + "X12_855", + "X12_856", + "X12_860", + "X12_861", + "X12_864", + "X12_865", + "X12_869", + "X12_870", + "X12_940", + "X12_945", + "X12_990", + "X12_997", + "X12_999", + "X12_270_X279", + "X12_271_X279", + "X12_275_X210", + "X12_275_X211", + "X12_276_X212", + "X12_277_X212", + "X12_277_X214", + "X12_277_X364", + "X12_278_X217", + "X12_820_X218", + "X12_820_X306", + "X12_824_X186", + "X12_834_X220", + "X12_834_X307", + "X12_834_X318", + "X12_835_X221", + "X12_837_X222", + "X12_837_X223", + "X12_837_X224", + "X12_837_X291", + "X12_837_X292", + "X12_837_X298", + "X12_999_X231" + ], + "type": "string" + }, + "X12Version": { + "enum": [ + "VERSION_4010", + "VERSION_4030", + "VERSION_5010", + "VERSION_5010_HIPAA" + ], + "type": "string" + } + }, + "description": "Definition of AWS::B2BI::Capability Resource Type", + "handlers": { + "create": { + "permissions": [ + "b2bi:CreateCapability", + "b2bi:TagResource", + "events:ListRules", + "events:PutRule", + "events:PutTargets", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy", + "s3:GetObject", + "s3:ListBucket" + ] + }, + "delete": { + "permissions": [ + "b2bi:DeleteCapability" + ] + }, + "list": { + "permissions": [ + "b2bi:ListCapabilities" + ] + }, + "read": { + "permissions": [ + "b2bi:GetCapability", + "b2bi:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "b2bi:TagResource", + "b2bi:UntagResource", + "b2bi:UpdateCapability" + ] + } + }, + "primaryIdentifier": [ + "/properties/CapabilityId" + ], + "properties": { + "CapabilityArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "CapabilityId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/CapabilityConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "InstructionsDocuments": { + "items": { + "$ref": "#/definitions/S3Location" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/CapabilityType" + } + }, + "readOnlyProperties": [ + "/properties/CapabilityArn", + "/properties/CapabilityId", + "/properties/CreatedAt", + "/properties/ModifiedAt" + ], + "required": [ + "Configuration", + "Name", + "Type" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::B2BI::Capability" +} diff --git a/schema/aws-b2bi-partnership.json b/schema/aws-b2bi-partnership.json index c219761..7076145 100644 --- a/schema/aws-b2bi-partnership.json +++ b/schema/aws-b2bi-partnership.json @@ -1,153 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Email", - "/properties/Phone", - "/properties/ProfileId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::B2BI::Partnership Resource Type", - "handlers": { - "create": { - "permissions": [ - "b2bi:CreatePartnership", - "b2bi:TagResource", - "s3:PutObject" - ] - }, - "delete": { - "permissions": [ - "b2bi:DeletePartnership" - ] - }, - "list": { - "permissions": [ - "b2bi:ListPartnerships" - ] - }, - "read": { - "permissions": [ - "b2bi:GetPartnership", - "b2bi:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "b2bi:TagResource", - "b2bi:UntagResource", - "b2bi:UpdatePartnership" - ] - } - }, - "primaryIdentifier": [ - "/properties/PartnershipId" - ], - "properties": { - "Capabilities": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "type": "array" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "Email": { - "maxLength": 254, - "minLength": 5, - "pattern": "^[\\w\\.\\-]+@[\\w\\.\\-]+$", - "type": "string" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 254, - "minLength": 1, - "type": "string" - }, - "PartnershipArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "PartnershipId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Phone": { - "maxLength": 22, - "minLength": 7, - "pattern": "^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$", - "type": "string" - }, - "ProfileId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TradingPartnerId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/ModifiedAt", - "/properties/PartnershipArn", - "/properties/PartnershipId", - "/properties/TradingPartnerId" - ], - "required": [ - "Email", - "Name", - "ProfileId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::B2BI::Partnership" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Email", + "/properties/Phone", + "/properties/ProfileId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::B2BI::Partnership Resource Type", + "handlers": { + "create": { + "permissions": [ + "b2bi:CreatePartnership", + "b2bi:TagResource", + "s3:PutObject" + ] + }, + "delete": { + "permissions": [ + "b2bi:DeletePartnership" + ] + }, + "list": { + "permissions": [ + "b2bi:ListPartnerships" + ] + }, + "read": { + "permissions": [ + "b2bi:GetPartnership", + "b2bi:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "b2bi:TagResource", + "b2bi:UntagResource", + "b2bi:UpdatePartnership" + ] + } + }, + "primaryIdentifier": [ + "/properties/PartnershipId" + ], + "properties": { + "Capabilities": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "type": "array" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Email": { + "maxLength": 254, + "minLength": 5, + "pattern": "^[\\w\\.\\-]+@[\\w\\.\\-]+$", + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "PartnershipArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PartnershipId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Phone": { + "maxLength": 22, + "minLength": 7, + "pattern": "^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$", + "type": "string" + }, + "ProfileId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TradingPartnerId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/ModifiedAt", + "/properties/PartnershipArn", + "/properties/PartnershipId", + "/properties/TradingPartnerId" + ], + "required": [ + "Email", + "Name", + "ProfileId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::B2BI::Partnership" +} diff --git a/schema/aws-b2bi-profile.json b/schema/aws-b2bi-profile.json index a58963a..31f77c3 100644 --- a/schema/aws-b2bi-profile.json +++ b/schema/aws-b2bi-profile.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Logging" - ], - "definitions": { - "Logging": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::B2BI::Profile Resource Type", - "handlers": { - "create": { - "permissions": [ - "b2bi:CreateProfile", - "b2bi:TagResource", - "logs:CreateLogDelivery", - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:DescribeLogGroups", - "logs:DescribeLogStreams", - "logs:DescribeResourcePolicies", - "logs:ListLogDeliveries", - "logs:PutLogEvents", - "logs:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "b2bi:DeleteProfile", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "list": { - "permissions": [ - "b2bi:ListProfiles" - ] - }, - "read": { - "permissions": [ - "b2bi:GetProfile", - "b2bi:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "b2bi:TagResource", - "b2bi:UntagResource", - "b2bi:UpdateProfile" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProfileId" - ], - "properties": { - "BusinessName": { - "maxLength": 254, - "minLength": 1, - "type": "string" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "Email": { - "maxLength": 254, - "minLength": 5, - "pattern": "^[\\w\\.\\-]+@[\\w\\.\\-]+$", - "type": "string" - }, - "LogGroupName": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Logging": { - "$ref": "#/definitions/Logging" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 254, - "minLength": 1, - "type": "string" - }, - "Phone": { - "maxLength": 22, - "minLength": 7, - "pattern": "^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$", - "type": "string" - }, - "ProfileArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "ProfileId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/LogGroupName", - "/properties/ModifiedAt", - "/properties/ProfileArn", - "/properties/ProfileId" - ], - "required": [ - "BusinessName", - "Logging", - "Name", - "Phone" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::B2BI::Profile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Logging" + ], + "definitions": { + "Logging": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::B2BI::Profile Resource Type", + "handlers": { + "create": { + "permissions": [ + "b2bi:CreateProfile", + "b2bi:TagResource", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "b2bi:DeleteProfile", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries" + ] + }, + "list": { + "permissions": [ + "b2bi:ListProfiles" + ] + }, + "read": { + "permissions": [ + "b2bi:GetProfile", + "b2bi:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "b2bi:TagResource", + "b2bi:UntagResource", + "b2bi:UpdateProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProfileId" + ], + "properties": { + "BusinessName": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Email": { + "maxLength": 254, + "minLength": 5, + "pattern": "^[\\w\\.\\-]+@[\\w\\.\\-]+$", + "type": "string" + }, + "LogGroupName": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Logging": { + "$ref": "#/definitions/Logging" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "Phone": { + "maxLength": 22, + "minLength": 7, + "pattern": "^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$", + "type": "string" + }, + "ProfileArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ProfileId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/LogGroupName", + "/properties/ModifiedAt", + "/properties/ProfileArn", + "/properties/ProfileId" + ], + "required": [ + "BusinessName", + "Logging", + "Name", + "Phone" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::B2BI::Profile" +} diff --git a/schema/aws-b2bi-transformer.json b/schema/aws-b2bi-transformer.json index 7c8e75a..53b7b31 100644 --- a/schema/aws-b2bi-transformer.json +++ b/schema/aws-b2bi-transformer.json @@ -1,278 +1,278 @@ -{ - "additionalProperties": false, - "definitions": { - "EdiType": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "X12Details": { - "$ref": "#/definitions/X12Details" - } - }, - "required": [ - "X12Details" - ], - "title": "X12Details", - "type": "object" - } - ] - }, - "FileFormat": { - "enum": [ - "XML", - "JSON" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TransformerStatus": { - "enum": [ - "active", - "inactive" - ], - "type": "string" - }, - "X12Details": { - "additionalProperties": false, - "properties": { - "TransactionSet": { - "$ref": "#/definitions/X12TransactionSet" - }, - "Version": { - "$ref": "#/definitions/X12Version" - } - }, - "type": "object" - }, - "X12TransactionSet": { - "enum": [ - "X12_110", - "X12_180", - "X12_204", - "X12_210", - "X12_211", - "X12_214", - "X12_215", - "X12_259", - "X12_260", - "X12_266", - "X12_269", - "X12_270", - "X12_271", - "X12_274", - "X12_275", - "X12_276", - "X12_277", - "X12_278", - "X12_310", - "X12_315", - "X12_322", - "X12_404", - "X12_410", - "X12_417", - "X12_421", - "X12_426", - "X12_810", - "X12_820", - "X12_824", - "X12_830", - "X12_832", - "X12_834", - "X12_835", - "X12_837", - "X12_844", - "X12_846", - "X12_849", - "X12_850", - "X12_852", - "X12_855", - "X12_856", - "X12_860", - "X12_861", - "X12_864", - "X12_865", - "X12_869", - "X12_870", - "X12_940", - "X12_945", - "X12_990", - "X12_997", - "X12_999", - "X12_270_X279", - "X12_271_X279", - "X12_275_X210", - "X12_275_X211", - "X12_276_X212", - "X12_277_X212", - "X12_277_X214", - "X12_277_X364", - "X12_278_X217", - "X12_820_X218", - "X12_820_X306", - "X12_824_X186", - "X12_834_X220", - "X12_834_X307", - "X12_834_X318", - "X12_835_X221", - "X12_837_X222", - "X12_837_X223", - "X12_837_X224", - "X12_837_X291", - "X12_837_X292", - "X12_837_X298", - "X12_999_X231" - ], - "type": "string" - }, - "X12Version": { - "enum": [ - "VERSION_4010", - "VERSION_4030", - "VERSION_5010", - "VERSION_5010_HIPAA" - ], - "type": "string" - } - }, - "description": "Definition of AWS::B2BI::Transformer Resource Type", - "handlers": { - "create": { - "permissions": [ - "b2bi:CreateTransformer", - "b2bi:TagResource", - "b2bi:UpdateTransformer", - "logs:CreateLogDelivery", - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:DescribeLogGroups", - "logs:DescribeLogStreams", - "logs:DescribeResourcePolicies", - "logs:ListLogDeliveries", - "logs:PutLogEvents", - "logs:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "b2bi:DeleteTransformer", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "list": { - "permissions": [ - "b2bi:ListTransformers" - ] - }, - "read": { - "permissions": [ - "b2bi:GetTransformer", - "b2bi:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "b2bi:TagResource", - "b2bi:UntagResource", - "b2bi:UpdateTransformer" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransformerId" - ], - "properties": { - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "EdiType": { - "$ref": "#/definitions/EdiType" - }, - "FileFormat": { - "$ref": "#/definitions/FileFormat" - }, - "MappingTemplate": { - "maxLength": 350000, - "minLength": 0, - "type": "string" - }, - "ModifiedAt": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 254, - "minLength": 1, - "type": "string" - }, - "SampleDocument": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/TransformerStatus" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TransformerArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "TransformerId": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/ModifiedAt", - "/properties/TransformerArn", - "/properties/TransformerId" - ], - "required": [ - "EdiType", - "FileFormat", - "MappingTemplate", - "Name", - "Status" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::B2BI::Transformer" -} +{ + "additionalProperties": false, + "definitions": { + "EdiType": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "X12Details": { + "$ref": "#/definitions/X12Details" + } + }, + "required": [ + "X12Details" + ], + "title": "X12Details", + "type": "object" + } + ] + }, + "FileFormat": { + "enum": [ + "XML", + "JSON" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TransformerStatus": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "X12Details": { + "additionalProperties": false, + "properties": { + "TransactionSet": { + "$ref": "#/definitions/X12TransactionSet" + }, + "Version": { + "$ref": "#/definitions/X12Version" + } + }, + "type": "object" + }, + "X12TransactionSet": { + "enum": [ + "X12_110", + "X12_180", + "X12_204", + "X12_210", + "X12_211", + "X12_214", + "X12_215", + "X12_259", + "X12_260", + "X12_266", + "X12_269", + "X12_270", + "X12_271", + "X12_274", + "X12_275", + "X12_276", + "X12_277", + "X12_278", + "X12_310", + "X12_315", + "X12_322", + "X12_404", + "X12_410", + "X12_417", + "X12_421", + "X12_426", + "X12_810", + "X12_820", + "X12_824", + "X12_830", + "X12_832", + "X12_834", + "X12_835", + "X12_837", + "X12_844", + "X12_846", + "X12_849", + "X12_850", + "X12_852", + "X12_855", + "X12_856", + "X12_860", + "X12_861", + "X12_864", + "X12_865", + "X12_869", + "X12_870", + "X12_940", + "X12_945", + "X12_990", + "X12_997", + "X12_999", + "X12_270_X279", + "X12_271_X279", + "X12_275_X210", + "X12_275_X211", + "X12_276_X212", + "X12_277_X212", + "X12_277_X214", + "X12_277_X364", + "X12_278_X217", + "X12_820_X218", + "X12_820_X306", + "X12_824_X186", + "X12_834_X220", + "X12_834_X307", + "X12_834_X318", + "X12_835_X221", + "X12_837_X222", + "X12_837_X223", + "X12_837_X224", + "X12_837_X291", + "X12_837_X292", + "X12_837_X298", + "X12_999_X231" + ], + "type": "string" + }, + "X12Version": { + "enum": [ + "VERSION_4010", + "VERSION_4030", + "VERSION_5010", + "VERSION_5010_HIPAA" + ], + "type": "string" + } + }, + "description": "Definition of AWS::B2BI::Transformer Resource Type", + "handlers": { + "create": { + "permissions": [ + "b2bi:CreateTransformer", + "b2bi:TagResource", + "b2bi:UpdateTransformer", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "b2bi:DeleteTransformer", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries" + ] + }, + "list": { + "permissions": [ + "b2bi:ListTransformers" + ] + }, + "read": { + "permissions": [ + "b2bi:GetTransformer", + "b2bi:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "b2bi:TagResource", + "b2bi:UntagResource", + "b2bi:UpdateTransformer" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransformerId" + ], + "properties": { + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "EdiType": { + "$ref": "#/definitions/EdiType" + }, + "FileFormat": { + "$ref": "#/definitions/FileFormat" + }, + "MappingTemplate": { + "maxLength": 350000, + "minLength": 0, + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "SampleDocument": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/TransformerStatus" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TransformerArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "TransformerId": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/ModifiedAt", + "/properties/TransformerArn", + "/properties/TransformerId" + ], + "required": [ + "EdiType", + "FileFormat", + "MappingTemplate", + "Name", + "Status" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::B2BI::Transformer" +} diff --git a/schema/aws-backup-backupplan.json b/schema/aws-backup-backupplan.json index 5ec7f14..d59c3ae 100644 --- a/schema/aws-backup-backupplan.json +++ b/schema/aws-backup-backupplan.json @@ -1,209 +1,209 @@ -{ - "additionalProperties": false, - "definitions": { - "AdvancedBackupSettingResourceType": { - "additionalProperties": false, - "properties": { - "BackupOptions": { - "type": "object" - }, - "ResourceType": { - "type": "string" - } - }, - "required": [ - "BackupOptions", - "ResourceType" - ], - "type": "object" - }, - "BackupPlanResourceType": { - "additionalProperties": false, - "properties": { - "AdvancedBackupSettings": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AdvancedBackupSettingResourceType" - }, - "type": "array", - "uniqueItems": false - }, - "BackupPlanName": { - "type": "string" - }, - "BackupPlanRule": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/BackupRuleResourceType" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "BackupPlanName", - "BackupPlanRule" - ], - "type": "object" - }, - "BackupRuleResourceType": { - "additionalProperties": false, - "properties": { - "CompletionWindowMinutes": { - "type": "number" - }, - "CopyActions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CopyActionResourceType" - }, - "type": "array", - "uniqueItems": false - }, - "EnableContinuousBackup": { - "type": "boolean" - }, - "Lifecycle": { - "$ref": "#/definitions/LifecycleResourceType" - }, - "RecoveryPointTags": { - "additionalProperties": false, - "patternProperties": { - "^.{1,128}$": { - "type": "string" - } - }, - "type": "object" - }, - "RuleName": { - "type": "string" - }, - "ScheduleExpression": { - "type": "string" - }, - "ScheduleExpressionTimezone": { - "type": "string" - }, - "StartWindowMinutes": { - "type": "number" - }, - "TargetBackupVault": { - "type": "string" - } - }, - "required": [ - "TargetBackupVault", - "RuleName" - ], - "type": "object" - }, - "CopyActionResourceType": { - "additionalProperties": false, - "properties": { - "DestinationBackupVaultArn": { - "type": "string" - }, - "Lifecycle": { - "$ref": "#/definitions/LifecycleResourceType" - } - }, - "required": [ - "DestinationBackupVaultArn" - ], - "type": "object" - }, - "LifecycleResourceType": { - "additionalProperties": false, - "properties": { - "DeleteAfterDays": { - "type": "number" - }, - "MoveToColdStorageAfterDays": { - "type": "number" - }, - "OptInToArchiveForSupportedResources": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Backup::BackupPlan", - "handlers": { - "create": { - "permissions": [ - "backup:GetBackupPlan", - "backup:TagResource", - "backup:CreateBackupPlan" - ] - }, - "delete": { - "permissions": [ - "backup:GetBackupPlan", - "backup:DeleteBackupPlan" - ] - }, - "list": { - "permissions": [ - "backup:ListBackupPlans" - ] - }, - "read": { - "permissions": [ - "backup:GetBackupPlan", - "backup:ListTags" - ] - }, - "update": { - "permissions": [ - "backup:UpdateBackupPlan", - "backup:ListTags", - "backup:TagResource", - "backup:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/BackupPlanId" - ], - "properties": { - "BackupPlan": { - "$ref": "#/definitions/BackupPlanResourceType" - }, - "BackupPlanArn": { - "type": "string" - }, - "BackupPlanId": { - "type": "string" - }, - "BackupPlanTags": { - "additionalProperties": false, - "patternProperties": { - "^.{1,128}$": { - "type": "string" - } - }, - "type": "object" - }, - "VersionId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/BackupPlanId", - "/properties/VersionId", - "/properties/BackupPlanArn" - ], - "required": [ - "BackupPlan" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/BackupPlanTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Backup::BackupPlan" -} +{ + "additionalProperties": false, + "definitions": { + "AdvancedBackupSettingResourceType": { + "additionalProperties": false, + "properties": { + "BackupOptions": { + "type": "object" + }, + "ResourceType": { + "type": "string" + } + }, + "required": [ + "BackupOptions", + "ResourceType" + ], + "type": "object" + }, + "BackupPlanResourceType": { + "additionalProperties": false, + "properties": { + "AdvancedBackupSettings": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AdvancedBackupSettingResourceType" + }, + "type": "array", + "uniqueItems": false + }, + "BackupPlanName": { + "type": "string" + }, + "BackupPlanRule": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/BackupRuleResourceType" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "BackupPlanName", + "BackupPlanRule" + ], + "type": "object" + }, + "BackupRuleResourceType": { + "additionalProperties": false, + "properties": { + "CompletionWindowMinutes": { + "type": "number" + }, + "CopyActions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CopyActionResourceType" + }, + "type": "array", + "uniqueItems": false + }, + "EnableContinuousBackup": { + "type": "boolean" + }, + "Lifecycle": { + "$ref": "#/definitions/LifecycleResourceType" + }, + "RecoveryPointTags": { + "additionalProperties": false, + "patternProperties": { + "^.{1,128}$": { + "type": "string" + } + }, + "type": "object" + }, + "RuleName": { + "type": "string" + }, + "ScheduleExpression": { + "type": "string" + }, + "ScheduleExpressionTimezone": { + "type": "string" + }, + "StartWindowMinutes": { + "type": "number" + }, + "TargetBackupVault": { + "type": "string" + } + }, + "required": [ + "TargetBackupVault", + "RuleName" + ], + "type": "object" + }, + "CopyActionResourceType": { + "additionalProperties": false, + "properties": { + "DestinationBackupVaultArn": { + "type": "string" + }, + "Lifecycle": { + "$ref": "#/definitions/LifecycleResourceType" + } + }, + "required": [ + "DestinationBackupVaultArn" + ], + "type": "object" + }, + "LifecycleResourceType": { + "additionalProperties": false, + "properties": { + "DeleteAfterDays": { + "type": "number" + }, + "MoveToColdStorageAfterDays": { + "type": "number" + }, + "OptInToArchiveForSupportedResources": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Backup::BackupPlan", + "handlers": { + "create": { + "permissions": [ + "backup:GetBackupPlan", + "backup:TagResource", + "backup:CreateBackupPlan" + ] + }, + "delete": { + "permissions": [ + "backup:GetBackupPlan", + "backup:DeleteBackupPlan" + ] + }, + "list": { + "permissions": [ + "backup:ListBackupPlans" + ] + }, + "read": { + "permissions": [ + "backup:GetBackupPlan", + "backup:ListTags" + ] + }, + "update": { + "permissions": [ + "backup:UpdateBackupPlan", + "backup:ListTags", + "backup:TagResource", + "backup:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/BackupPlanId" + ], + "properties": { + "BackupPlan": { + "$ref": "#/definitions/BackupPlanResourceType" + }, + "BackupPlanArn": { + "type": "string" + }, + "BackupPlanId": { + "type": "string" + }, + "BackupPlanTags": { + "additionalProperties": false, + "patternProperties": { + "^.{1,128}$": { + "type": "string" + } + }, + "type": "object" + }, + "VersionId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BackupPlanId", + "/properties/VersionId", + "/properties/BackupPlanArn" + ], + "required": [ + "BackupPlan" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/BackupPlanTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Backup::BackupPlan" +} diff --git a/schema/aws-backup-backupselection.json b/schema/aws-backup-backupselection.json index 6020061..f4117f4 100644 --- a/schema/aws-backup-backupselection.json +++ b/schema/aws-backup-backupselection.json @@ -1,179 +1,179 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BackupSelection", - "/properties/BackupPlanId" - ], - "definitions": { - "BackupSelectionResourceType": { - "additionalProperties": false, - "properties": { - "Conditions": { - "additionalProperties": false, - "properties": { - "StringEquals": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConditionParameter" - }, - "type": "array", - "uniqueItems": false - }, - "StringLike": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConditionParameter" - }, - "type": "array", - "uniqueItems": false - }, - "StringNotEquals": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConditionParameter" - }, - "type": "array", - "uniqueItems": false - }, - "StringNotLike": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConditionParameter" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "IamRoleArn": { - "type": "string" - }, - "ListOfTags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConditionResourceType" - }, - "type": "array", - "uniqueItems": false - }, - "NotResources": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Resources": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SelectionName": { - "type": "string" - } - }, - "required": [ - "SelectionName", - "IamRoleArn" - ], - "type": "object" - }, - "ConditionParameter": { - "additionalProperties": false, - "properties": { - "ConditionKey": { - "type": "string" - }, - "ConditionValue": { - "type": "string" - } - }, - "type": "object" - }, - "ConditionResourceType": { - "additionalProperties": false, - "properties": { - "ConditionKey": { - "type": "string" - }, - "ConditionType": { - "type": "string" - }, - "ConditionValue": { - "type": "string" - } - }, - "required": [ - "ConditionValue", - "ConditionKey", - "ConditionType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Backup::BackupSelection", - "handlers": { - "create": { - "permissions": [ - "backup:CreateBackupSelection", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "backup:GetBackupSelection", - "backup:DeleteBackupSelection" - ] - }, - "list": { - "permissions": [ - "backup:ListBackupSelections" - ] - }, - "read": { - "permissions": [ - "backup:GetBackupSelection" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "BackupPlanId": { - "type": "string" - }, - "BackupSelection": { - "$ref": "#/definitions/BackupSelectionResourceType" - }, - "Id": { - "type": "string" - }, - "SelectionId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SelectionId", - "/properties/Id" - ], - "required": [ - "BackupSelection", - "BackupPlanId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Backup::BackupSelection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BackupSelection", + "/properties/BackupPlanId" + ], + "definitions": { + "BackupSelectionResourceType": { + "additionalProperties": false, + "properties": { + "Conditions": { + "additionalProperties": false, + "properties": { + "StringEquals": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConditionParameter" + }, + "type": "array", + "uniqueItems": false + }, + "StringLike": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConditionParameter" + }, + "type": "array", + "uniqueItems": false + }, + "StringNotEquals": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConditionParameter" + }, + "type": "array", + "uniqueItems": false + }, + "StringNotLike": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConditionParameter" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "IamRoleArn": { + "type": "string" + }, + "ListOfTags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConditionResourceType" + }, + "type": "array", + "uniqueItems": false + }, + "NotResources": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Resources": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SelectionName": { + "type": "string" + } + }, + "required": [ + "SelectionName", + "IamRoleArn" + ], + "type": "object" + }, + "ConditionParameter": { + "additionalProperties": false, + "properties": { + "ConditionKey": { + "type": "string" + }, + "ConditionValue": { + "type": "string" + } + }, + "type": "object" + }, + "ConditionResourceType": { + "additionalProperties": false, + "properties": { + "ConditionKey": { + "type": "string" + }, + "ConditionType": { + "type": "string" + }, + "ConditionValue": { + "type": "string" + } + }, + "required": [ + "ConditionValue", + "ConditionKey", + "ConditionType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Backup::BackupSelection", + "handlers": { + "create": { + "permissions": [ + "backup:CreateBackupSelection", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "backup:GetBackupSelection", + "backup:DeleteBackupSelection" + ] + }, + "list": { + "permissions": [ + "backup:ListBackupSelections" + ] + }, + "read": { + "permissions": [ + "backup:GetBackupSelection" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "BackupPlanId": { + "type": "string" + }, + "BackupSelection": { + "$ref": "#/definitions/BackupSelectionResourceType" + }, + "Id": { + "type": "string" + }, + "SelectionId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SelectionId", + "/properties/Id" + ], + "required": [ + "BackupSelection", + "BackupPlanId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Backup::BackupSelection" +} diff --git a/schema/aws-backup-backupvault.json b/schema/aws-backup-backupvault.json index f0ca64f..e54034c 100644 --- a/schema/aws-backup-backupvault.json +++ b/schema/aws-backup-backupvault.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BackupVaultName", - "/properties/EncryptionKeyArn" - ], - "definitions": { - "BackupVaultNamePattern": { - "pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$", - "type": "string" - }, - "LockConfigurationType": { - "additionalProperties": false, - "properties": { - "ChangeableForDays": { - "type": "integer" - }, - "MaxRetentionDays": { - "type": "integer" - }, - "MinRetentionDays": { - "type": "integer" - } - }, - "required": [ - "MinRetentionDays" - ], - "type": "object" - }, - "NotificationObjectType": { - "additionalProperties": false, - "properties": { - "BackupVaultEvents": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SNSTopicArn": { - "type": "string" - } - }, - "required": [ - "SNSTopicArn", - "BackupVaultEvents" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Backup::BackupVault", - "handlers": { - "create": { - "permissions": [ - "backup:TagResource", - "backup:CreateBackupVault", - "backup:PutBackupVaultAccessPolicy", - "backup:PutBackupVaultNotifications", - "backup:PutBackupVaultLockConfiguration", - "backup-storage:Mount", - "backup-storage:MountCapsule", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "kms:RetireGrant", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "backup:DeleteBackupVault" - ] - }, - "list": { - "permissions": [ - "backup:ListBackupVaults" - ] - }, - "read": { - "permissions": [ - "backup:DescribeBackupVault", - "backup:GetBackupVaultNotifications", - "backup:GetBackupVaultAccessPolicy", - "backup:ListTags" - ] - }, - "update": { - "permissions": [ - "backup:DescribeBackupVault", - "backup:DeleteBackupVaultAccessPolicy", - "backup:DeleteBackupVaultNotifications", - "backup:DeleteBackupVaultLockConfiguration", - "backup:ListTags", - "backup:TagResource", - "backup:UntagResource", - "backup:PutBackupVaultAccessPolicy", - "backup:PutBackupVaultNotifications", - "backup:PutBackupVaultLockConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/BackupVaultName" - ], - "properties": { - "AccessPolicy": { - "type": [ - "object", - "string" - ] - }, - "BackupVaultArn": { - "type": "string" - }, - "BackupVaultName": { - "$ref": "#/definitions/BackupVaultNamePattern" - }, - "BackupVaultTags": { - "additionalProperties": false, - "patternProperties": { - "^.{1,128}$": { - "type": "string" - } - }, - "type": "object" - }, - "EncryptionKeyArn": { - "type": "string" - }, - "LockConfiguration": { - "$ref": "#/definitions/LockConfigurationType" - }, - "Notifications": { - "$ref": "#/definitions/NotificationObjectType" - } - }, - "readOnlyProperties": [ - "/properties/BackupVaultArn" - ], - "required": [ - "BackupVaultName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/BackupVaultTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Backup::BackupVault", - "writeOnlyProperties": [ - "/properties/LockConfiguration/ChangeableForDays" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BackupVaultName", + "/properties/EncryptionKeyArn" + ], + "definitions": { + "BackupVaultNamePattern": { + "pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$", + "type": "string" + }, + "LockConfigurationType": { + "additionalProperties": false, + "properties": { + "ChangeableForDays": { + "type": "integer" + }, + "MaxRetentionDays": { + "type": "integer" + }, + "MinRetentionDays": { + "type": "integer" + } + }, + "required": [ + "MinRetentionDays" + ], + "type": "object" + }, + "NotificationObjectType": { + "additionalProperties": false, + "properties": { + "BackupVaultEvents": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SNSTopicArn": { + "type": "string" + } + }, + "required": [ + "SNSTopicArn", + "BackupVaultEvents" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Backup::BackupVault", + "handlers": { + "create": { + "permissions": [ + "backup:TagResource", + "backup:CreateBackupVault", + "backup:PutBackupVaultAccessPolicy", + "backup:PutBackupVaultNotifications", + "backup:PutBackupVaultLockConfiguration", + "backup-storage:Mount", + "backup-storage:MountCapsule", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "kms:RetireGrant", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "backup:DeleteBackupVault" + ] + }, + "list": { + "permissions": [ + "backup:ListBackupVaults" + ] + }, + "read": { + "permissions": [ + "backup:DescribeBackupVault", + "backup:GetBackupVaultNotifications", + "backup:GetBackupVaultAccessPolicy", + "backup:ListTags" + ] + }, + "update": { + "permissions": [ + "backup:DescribeBackupVault", + "backup:DeleteBackupVaultAccessPolicy", + "backup:DeleteBackupVaultNotifications", + "backup:DeleteBackupVaultLockConfiguration", + "backup:ListTags", + "backup:TagResource", + "backup:UntagResource", + "backup:PutBackupVaultAccessPolicy", + "backup:PutBackupVaultNotifications", + "backup:PutBackupVaultLockConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/BackupVaultName" + ], + "properties": { + "AccessPolicy": { + "type": [ + "object", + "string" + ] + }, + "BackupVaultArn": { + "type": "string" + }, + "BackupVaultName": { + "$ref": "#/definitions/BackupVaultNamePattern" + }, + "BackupVaultTags": { + "additionalProperties": false, + "patternProperties": { + "^.{1,128}$": { + "type": "string" + } + }, + "type": "object" + }, + "EncryptionKeyArn": { + "type": "string" + }, + "LockConfiguration": { + "$ref": "#/definitions/LockConfigurationType" + }, + "Notifications": { + "$ref": "#/definitions/NotificationObjectType" + } + }, + "readOnlyProperties": [ + "/properties/BackupVaultArn" + ], + "required": [ + "BackupVaultName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/BackupVaultTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Backup::BackupVault", + "writeOnlyProperties": [ + "/properties/LockConfiguration/ChangeableForDays" + ] +} diff --git a/schema/aws-backup-framework.json b/schema/aws-backup-framework.json index 99f4ee3..196e1b7 100644 --- a/schema/aws-backup-framework.json +++ b/schema/aws-backup-framework.json @@ -1,203 +1,203 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FrameworkName" - ], - "definitions": { - "ControlInputParameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "FrameworkControl": { - "additionalProperties": false, - "properties": { - "ControlInputParameters": { - "description": "A list of ParameterName and ParameterValue pairs.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ControlInputParameter" - }, - "type": "array", - "uniqueItems": true - }, - "ControlName": { - "description": "The name of a control. This name is between 1 and 256 characters.", - "type": "string" - }, - "ControlScope": { - "additionalProperties": false, - "description": "The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.", - "properties": { - "ComplianceResourceIds": { - "description": "The ID of the only AWS resource that you want your control scope to contain.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "ComplianceResourceTypes": { - "description": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "required": [ - "ControlName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.", - "handlers": { - "create": { - "permissions": [ - "backup:CreateFramework", - "backup:DescribeFramework", - "backup:ListTags", - "backup:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "backup:DeleteFramework", - "backup:DescribeFramework" - ] - }, - "list": { - "permissions": [ - "backup:ListFrameworks" - ] - }, - "read": { - "permissions": [ - "backup:DescribeFramework", - "backup:ListTags" - ] - }, - "update": { - "permissions": [ - "backup:DescribeFramework", - "backup:UpdateFramework", - "backup:ListTags", - "backup:TagResource", - "backup:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/FrameworkArn" - ], - "properties": { - "CreationTime": { - "description": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.", - "type": "string" - }, - "DeploymentStatus": { - "description": "The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`", - "type": "string" - }, - "FrameworkArn": { - "description": "An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource", - "type": "string" - }, - "FrameworkControls": { - "description": "Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FrameworkControl" - }, - "type": "array", - "uniqueItems": true - }, - "FrameworkDescription": { - "description": "An optional description of the framework with a maximum 1,024 characters.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "FrameworkName": { - "description": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z][_a-zA-Z0-9]*", - "type": "string" - }, - "FrameworkStatus": { - "description": "A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:\n\n`ACTIVE` when recording is turned on for all resources governed by the framework.\n\n`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.\n\n`INACTIVE` when recording is turned off for all resources governed by the framework.\n\n`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.", - "type": "string" - }, - "FrameworkTags": { - "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/FrameworkArn", - "/properties/CreationTime", - "/properties/FrameworkStatus", - "/properties/DeploymentStatus" - ], - "required": [ - "FrameworkControls" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/FrameworkTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Backup::Framework" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FrameworkName" + ], + "definitions": { + "ControlInputParameter": { + "additionalProperties": false, + "properties": { + "ParameterName": { + "type": "string" + }, + "ParameterValue": { + "type": "string" + } + }, + "required": [ + "ParameterName", + "ParameterValue" + ], + "type": "object" + }, + "FrameworkControl": { + "additionalProperties": false, + "properties": { + "ControlInputParameters": { + "description": "A list of ParameterName and ParameterValue pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ControlInputParameter" + }, + "type": "array", + "uniqueItems": true + }, + "ControlName": { + "description": "The name of a control. This name is between 1 and 256 characters.", + "type": "string" + }, + "ControlScope": { + "additionalProperties": false, + "description": "The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.", + "properties": { + "ComplianceResourceIds": { + "description": "The ID of the only AWS resource that you want your control scope to contain.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "ComplianceResourceTypes": { + "description": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "required": [ + "ControlName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.", + "handlers": { + "create": { + "permissions": [ + "backup:CreateFramework", + "backup:DescribeFramework", + "backup:ListTags", + "backup:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "backup:DeleteFramework", + "backup:DescribeFramework" + ] + }, + "list": { + "permissions": [ + "backup:ListFrameworks" + ] + }, + "read": { + "permissions": [ + "backup:DescribeFramework", + "backup:ListTags" + ] + }, + "update": { + "permissions": [ + "backup:DescribeFramework", + "backup:UpdateFramework", + "backup:ListTags", + "backup:TagResource", + "backup:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/FrameworkArn" + ], + "properties": { + "CreationTime": { + "description": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.", + "type": "string" + }, + "DeploymentStatus": { + "description": "The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`", + "type": "string" + }, + "FrameworkArn": { + "description": "An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource", + "type": "string" + }, + "FrameworkControls": { + "description": "Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FrameworkControl" + }, + "type": "array", + "uniqueItems": true + }, + "FrameworkDescription": { + "description": "An optional description of the framework with a maximum 1,024 characters.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "FrameworkName": { + "description": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z][_a-zA-Z0-9]*", + "type": "string" + }, + "FrameworkStatus": { + "description": "A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:\n\n`ACTIVE` when recording is turned on for all resources governed by the framework.\n\n`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.\n\n`INACTIVE` when recording is turned off for all resources governed by the framework.\n\n`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.", + "type": "string" + }, + "FrameworkTags": { + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/FrameworkArn", + "/properties/CreationTime", + "/properties/FrameworkStatus", + "/properties/DeploymentStatus" + ], + "required": [ + "FrameworkControls" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/FrameworkTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Backup::Framework" +} diff --git a/schema/aws-backup-reportplan.json b/schema/aws-backup-reportplan.json index ed137ef..3c8f853 100644 --- a/schema/aws-backup-reportplan.json +++ b/schema/aws-backup-reportplan.json @@ -1,189 +1,189 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReportPlanName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Contains detailed information about a report plan in AWS Backup Audit Manager.", - "handlers": { - "create": { - "permissions": [ - "backup:CreateReportPlan", - "backup:DescribeReportPlan", - "backup:ListTags", - "backup:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "backup:DeleteReportPlan", - "backup:DescribeReportPlan" - ] - }, - "list": { - "permissions": [ - "backup:ListReportPlans" - ] - }, - "read": { - "permissions": [ - "backup:DescribeReportPlan", - "backup:ListTags" - ] - }, - "update": { - "permissions": [ - "backup:DescribeReportPlan", - "backup:UpdateReportPlan", - "backup:ListTags", - "backup:UntagResource", - "backup:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReportPlanArn" - ], - "properties": { - "ReportDeliveryChannel": { - "additionalProperties": false, - "description": "A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.", - "properties": { - "Formats": { - "description": "A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "S3BucketName": { - "description": "The unique name of the S3 bucket that receives your reports.", - "type": "string" - }, - "S3KeyPrefix": { - "description": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.", - "type": "string" - } - }, - "required": [ - "S3BucketName" - ], - "type": "object" - }, - "ReportPlanArn": { - "description": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.", - "type": "string" - }, - "ReportPlanDescription": { - "description": "An optional description of the report plan with a maximum of 1,024 characters.", - "maxLength": 1024, - "minLength": 0, - "pattern": ".*\\S.*", - "type": "string" - }, - "ReportPlanName": { - "description": "The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z][_a-zA-Z0-9]*", - "type": "string" - }, - "ReportPlanTags": { - "description": "Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ReportSetting": { - "additionalProperties": false, - "description": "Identifies the report template for the report. Reports are built using a report template.", - "properties": { - "Accounts": { - "description": "The list of AWS accounts that a report covers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "FrameworkArns": { - "description": "The Amazon Resource Names (ARNs) of the frameworks a report covers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "OrganizationUnits": { - "description": "The list of AWS organization units that a report covers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Regions": { - "description": "The list of AWS regions that a report covers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ReportTemplate": { - "description": "Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`", - "type": "string" - } - }, - "required": [ - "ReportTemplate" - ], - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/ReportPlanArn" - ], - "required": [ - "ReportDeliveryChannel", - "ReportSetting" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/ReportPlanTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Backup::ReportPlan" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReportPlanName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Contains detailed information about a report plan in AWS Backup Audit Manager.", + "handlers": { + "create": { + "permissions": [ + "backup:CreateReportPlan", + "backup:DescribeReportPlan", + "backup:ListTags", + "backup:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "backup:DeleteReportPlan", + "backup:DescribeReportPlan" + ] + }, + "list": { + "permissions": [ + "backup:ListReportPlans" + ] + }, + "read": { + "permissions": [ + "backup:DescribeReportPlan", + "backup:ListTags" + ] + }, + "update": { + "permissions": [ + "backup:DescribeReportPlan", + "backup:UpdateReportPlan", + "backup:ListTags", + "backup:UntagResource", + "backup:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReportPlanArn" + ], + "properties": { + "ReportDeliveryChannel": { + "additionalProperties": false, + "description": "A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.", + "properties": { + "Formats": { + "description": "A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "S3BucketName": { + "description": "The unique name of the S3 bucket that receives your reports.", + "type": "string" + }, + "S3KeyPrefix": { + "description": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.", + "type": "string" + } + }, + "required": [ + "S3BucketName" + ], + "type": "object" + }, + "ReportPlanArn": { + "description": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.", + "type": "string" + }, + "ReportPlanDescription": { + "description": "An optional description of the report plan with a maximum of 1,024 characters.", + "maxLength": 1024, + "minLength": 0, + "pattern": ".*\\S.*", + "type": "string" + }, + "ReportPlanName": { + "description": "The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z][_a-zA-Z0-9]*", + "type": "string" + }, + "ReportPlanTags": { + "description": "Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "ReportSetting": { + "additionalProperties": false, + "description": "Identifies the report template for the report. Reports are built using a report template.", + "properties": { + "Accounts": { + "description": "The list of AWS accounts that a report covers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "FrameworkArns": { + "description": "The Amazon Resource Names (ARNs) of the frameworks a report covers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "OrganizationUnits": { + "description": "The list of AWS organization units that a report covers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Regions": { + "description": "The list of AWS regions that a report covers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ReportTemplate": { + "description": "Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`", + "type": "string" + } + }, + "required": [ + "ReportTemplate" + ], + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/ReportPlanArn" + ], + "required": [ + "ReportDeliveryChannel", + "ReportSetting" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/ReportPlanTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Backup::ReportPlan" +} diff --git a/schema/aws-backup-restoretestingplan.json b/schema/aws-backup-restoretestingplan.json index b2da7b7..77fc148 100644 --- a/schema/aws-backup-restoretestingplan.json +++ b/schema/aws-backup-restoretestingplan.json @@ -1,171 +1,183 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RestoreTestingPlanName" - ], - "definitions": { - "RestoreTestingRecoveryPointSelection": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "$ref": "#/definitions/RestoreTestingRecoveryPointSelectionAlgorithm" - }, - "ExcludeVaults": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "IncludeVaults": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "RecoveryPointTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RestoreTestingRecoveryPointType" - }, - "type": "array" - }, - "SelectionWindowDays": { - "type": "integer" - } - }, - "required": [ - "Algorithm", - "RecoveryPointTypes", - "IncludeVaults" - ], - "type": "object" - }, - "RestoreTestingRecoveryPointSelectionAlgorithm": { - "enum": [ - "LATEST_WITHIN_WINDOW", - "RANDOM_WITHIN_WINDOW" - ], - "type": "string" - }, - "RestoreTestingRecoveryPointType": { - "enum": [ - "SNAPSHOT", - "CONTINUOUS" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Backup::RestoreTestingPlan Resource Type", - "handlers": { - "create": { - "permissions": [ - "backup:CreateRestoreTestingPlan", - "backup:TagResource", - "backup:GetRestoreTestingPlan", - "backup:ListTags" - ], - "timeoutInMinutes": 5 - }, - "delete": { - "permissions": [ - "backup:DeleteRestoreTestingPlan", - "backup:GetRestoreTestingPlan" - ], - "timeoutInMinutes": 5 - }, - "list": { - "permissions": [ - "backup:ListRestoreTestingPlans" - ], - "timeoutInMinutes": 5 - }, - "read": { - "permissions": [ - "backup:GetRestoreTestingPlan", - "backup:ListTags" - ], - "timeoutInMinutes": 5 - }, - "update": { - "permissions": [ - "backup:UpdateRestoreTestingPlan", - "backup:TagResource", - "backup:UntagResource", - "backup:GetRestoreTestingPlan", - "backup:ListTags" - ], - "timeoutInMinutes": 5 - } - }, - "primaryIdentifier": [ - "/properties/RestoreTestingPlanName" - ], - "properties": { - "RecoveryPointSelection": { - "$ref": "#/definitions/RestoreTestingRecoveryPointSelection" - }, - "RestoreTestingPlanArn": { - "type": "string" - }, - "RestoreTestingPlanName": { - "type": "string" - }, - "ScheduleExpression": { - "type": "string" - }, - "ScheduleExpressionTimezone": { - "type": "string" - }, - "StartWindowHours": { - "type": "integer" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/RestoreTestingPlanArn" - ], - "required": [ - "RecoveryPointSelection", - "ScheduleExpression", - "RestoreTestingPlanName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Backup::RestoreTestingPlan" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RestoreTestingPlanName" + ], + "definitions": { + "RestoreTestingRecoveryPointSelection": { + "additionalProperties": false, + "properties": { + "Algorithm": { + "$ref": "#/definitions/RestoreTestingRecoveryPointSelectionAlgorithm" + }, + "ExcludeVaults": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "IncludeVaults": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "RecoveryPointTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RestoreTestingRecoveryPointType" + }, + "type": "array" + }, + "SelectionWindowDays": { + "type": "integer" + } + }, + "required": [ + "Algorithm", + "RecoveryPointTypes", + "IncludeVaults" + ], + "type": "object" + }, + "RestoreTestingRecoveryPointSelectionAlgorithm": { + "enum": [ + "LATEST_WITHIN_WINDOW", + "RANDOM_WITHIN_WINDOW" + ], + "type": "string" + }, + "RestoreTestingRecoveryPointType": { + "enum": [ + "SNAPSHOT", + "CONTINUOUS" + ], + "type": "string" + }, + "RestoreTestingScheduleStatus": { + "enum": [ + "ACTIVE", + "SUSPENDED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Backup::RestoreTestingPlan Resource Type", + "handlers": { + "create": { + "permissions": [ + "backup:CreateRestoreTestingPlan", + "backup:UpdateRestoreTestingPlanScheduleStatus", + "backup:TagResource", + "backup:GetRestoreTestingPlan", + "backup:ListTags" + ], + "timeoutInMinutes": 5 + }, + "delete": { + "permissions": [ + "backup:DeleteRestoreTestingPlan", + "backup:GetRestoreTestingPlan" + ], + "timeoutInMinutes": 5 + }, + "list": { + "permissions": [ + "backup:ListRestoreTestingPlans" + ], + "timeoutInMinutes": 5 + }, + "read": { + "permissions": [ + "backup:GetRestoreTestingPlan", + "backup:ListTags" + ], + "timeoutInMinutes": 5 + }, + "update": { + "permissions": [ + "backup:UpdateRestoreTestingPlan", + "backup:UpdateRestoreTestingPlanScheduleStatus", + "backup:TagResource", + "backup:UntagResource", + "backup:GetRestoreTestingPlan", + "backup:ListTags" + ], + "timeoutInMinutes": 5 + } + }, + "primaryIdentifier": [ + "/properties/RestoreTestingPlanName" + ], + "properties": { + "RecoveryPointSelection": { + "$ref": "#/definitions/RestoreTestingRecoveryPointSelection" + }, + "RestoreTestingPlanArn": { + "type": "string" + }, + "RestoreTestingPlanName": { + "type": "string" + }, + "ScheduleExpression": { + "type": "string" + }, + "ScheduleExpressionTimezone": { + "type": "string" + }, + "ScheduleStatus": { + "$ref": "#/definitions/RestoreTestingScheduleStatus" + }, + "StartWindowHours": { + "type": "integer" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/RestoreTestingPlanArn" + ], + "required": [ + "RecoveryPointSelection", + "ScheduleExpression", + "RestoreTestingPlanName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Backup::RestoreTestingPlan" +} diff --git a/schema/aws-backup-restoretestingselection.json b/schema/aws-backup-restoretestingselection.json index 0367459..a55c038 100644 --- a/schema/aws-backup-restoretestingselection.json +++ b/schema/aws-backup-restoretestingselection.json @@ -1,142 +1,142 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProtectedResourceType", - "/properties/RestoreTestingPlanName", - "/properties/RestoreTestingSelectionName" - ], - "definitions": { - "KeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "ProtectedResourceConditions": { - "additionalProperties": false, - "properties": { - "StringEquals": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KeyValue" - }, - "type": "array" - }, - "StringNotEquals": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KeyValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "SensitiveStringMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Backup::RestoreTestingSelection", - "handlers": { - "create": { - "permissions": [ - "backup:CreateRestoreTestingSelection", - "backup:GetRestoreTestingSelection", - "iam:PassRole" - ], - "timeoutInMinutes": 5 - }, - "delete": { - "permissions": [ - "backup:DeleteRestoreTestingSelection", - "backup:GetRestoreTestingSelection" - ], - "timeoutInMinutes": 5 - }, - "list": { - "permissions": [ - "backup:ListRestoreTestingSelections" - ], - "timeoutInMinutes": 5 - }, - "read": { - "permissions": [ - "backup:GetRestoreTestingSelection" - ], - "timeoutInMinutes": 5 - }, - "update": { - "permissions": [ - "backup:UpdateRestoreTestingSelection", - "backup:GetRestoreTestingSelection", - "iam:PassRole" - ], - "timeoutInMinutes": 5 - } - }, - "primaryIdentifier": [ - "/properties/RestoreTestingPlanName", - "/properties/RestoreTestingSelectionName" - ], - "properties": { - "IamRoleArn": { - "type": "string" - }, - "ProtectedResourceArns": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "ProtectedResourceConditions": { - "$ref": "#/definitions/ProtectedResourceConditions" - }, - "ProtectedResourceType": { - "type": "string" - }, - "RestoreMetadataOverrides": { - "$ref": "#/definitions/SensitiveStringMap" - }, - "RestoreTestingPlanName": { - "type": "string" - }, - "RestoreTestingSelectionName": { - "type": "string" - }, - "ValidationWindowHours": { - "type": "integer" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "IamRoleArn", - "ProtectedResourceType", - "RestoreTestingPlanName", - "RestoreTestingSelectionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Backup::RestoreTestingSelection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProtectedResourceType", + "/properties/RestoreTestingPlanName", + "/properties/RestoreTestingSelectionName" + ], + "definitions": { + "KeyValue": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "ProtectedResourceConditions": { + "additionalProperties": false, + "properties": { + "StringEquals": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KeyValue" + }, + "type": "array" + }, + "StringNotEquals": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KeyValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "SensitiveStringMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Backup::RestoreTestingSelection", + "handlers": { + "create": { + "permissions": [ + "backup:CreateRestoreTestingSelection", + "backup:GetRestoreTestingSelection", + "iam:PassRole" + ], + "timeoutInMinutes": 5 + }, + "delete": { + "permissions": [ + "backup:DeleteRestoreTestingSelection", + "backup:GetRestoreTestingSelection" + ], + "timeoutInMinutes": 5 + }, + "list": { + "permissions": [ + "backup:ListRestoreTestingSelections" + ], + "timeoutInMinutes": 5 + }, + "read": { + "permissions": [ + "backup:GetRestoreTestingSelection" + ], + "timeoutInMinutes": 5 + }, + "update": { + "permissions": [ + "backup:UpdateRestoreTestingSelection", + "backup:GetRestoreTestingSelection", + "iam:PassRole" + ], + "timeoutInMinutes": 5 + } + }, + "primaryIdentifier": [ + "/properties/RestoreTestingPlanName", + "/properties/RestoreTestingSelectionName" + ], + "properties": { + "IamRoleArn": { + "type": "string" + }, + "ProtectedResourceArns": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "ProtectedResourceConditions": { + "$ref": "#/definitions/ProtectedResourceConditions" + }, + "ProtectedResourceType": { + "type": "string" + }, + "RestoreMetadataOverrides": { + "$ref": "#/definitions/SensitiveStringMap" + }, + "RestoreTestingPlanName": { + "type": "string" + }, + "RestoreTestingSelectionName": { + "type": "string" + }, + "ValidationWindowHours": { + "type": "integer" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "IamRoleArn", + "ProtectedResourceType", + "RestoreTestingPlanName", + "RestoreTestingSelectionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Backup::RestoreTestingSelection" +} diff --git a/schema/aws-backupgateway-hypervisor.json b/schema/aws-backupgateway-hypervisor.json index 1723261..ed4e3e7 100644 --- a/schema/aws-backupgateway-hypervisor.json +++ b/schema/aws-backupgateway-hypervisor.json @@ -1,162 +1,162 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyArn", - "/properties/Tags" - ], - "definitions": { - "HypervisorState": { - "enum": [ - "PENDING", - "ONLINE", - "OFFLINE", - "ERROR" - ], - "type": "string" - }, - "SyncMetadataStatus": { - "enum": [ - "PENDING", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[^\\x00]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::BackupGateway::Hypervisor Resource Type", - "handlers": { - "create": { - "permissions": [ - "backup-gateway:ImportHypervisorConfiguration", - "backup-gateway:GetHypervisor", - "backup-gateway:ListHypervisors", - "backup-gateway:TagResource", - "kms:CreateGrant", - "kms:Encrypt", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "backup-gateway:DeleteHypervisor", - "backup-gateway:GetHypervisor", - "backup-gateway:ListHypervisors" - ] - }, - "list": { - "permissions": [ - "backup-gateway:ListHypervisors" - ] - }, - "read": { - "permissions": [ - "backup-gateway:GetHypervisor", - "backup-gateway:ListHypervisors" - ] - }, - "update": { - "permissions": [ - "backup-gateway:UpdateHypervisor", - "backup-gateway:GetHypervisor", - "backup-gateway:ListHypervisors", - "backup-gateway:ImportHypervisorConfiguration", - "backup-gateway:DeleteHypervisor" - ] - } - }, - "primaryIdentifier": [ - "/properties/HypervisorArn" - ], - "properties": { - "Host": { - "maxLength": 128, - "minLength": 3, - "pattern": "^.+$", - "type": "string" - }, - "HypervisorArn": { - "maxLength": 500, - "minLength": 50, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$", - "type": "string" - }, - "KmsKeyArn": { - "maxLength": 500, - "minLength": 50, - "pattern": "^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$", - "type": "string" - }, - "LogGroupArn": { - "maxLength": 2048, - "minLength": 0, - "pattern": "^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\\-\\/\\.]+:\\*$", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "Password": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[ -~]+$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Username": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/HypervisorArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::BackupGateway::Hypervisor", - "writeOnlyProperties": [ - "/properties/KmsKeyArn", - "/properties/LogGroupArn", - "/properties/Name", - "/properties/Password", - "/properties/Tags", - "/properties/Username" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn", + "/properties/Tags" + ], + "definitions": { + "HypervisorState": { + "enum": [ + "PENDING", + "ONLINE", + "OFFLINE", + "ERROR" + ], + "type": "string" + }, + "SyncMetadataStatus": { + "enum": [ + "PENDING", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[^\\x00]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::BackupGateway::Hypervisor Resource Type", + "handlers": { + "create": { + "permissions": [ + "backup-gateway:ImportHypervisorConfiguration", + "backup-gateway:GetHypervisor", + "backup-gateway:ListHypervisors", + "backup-gateway:TagResource", + "kms:CreateGrant", + "kms:Encrypt", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "backup-gateway:DeleteHypervisor", + "backup-gateway:GetHypervisor", + "backup-gateway:ListHypervisors" + ] + }, + "list": { + "permissions": [ + "backup-gateway:ListHypervisors" + ] + }, + "read": { + "permissions": [ + "backup-gateway:GetHypervisor", + "backup-gateway:ListHypervisors" + ] + }, + "update": { + "permissions": [ + "backup-gateway:UpdateHypervisor", + "backup-gateway:GetHypervisor", + "backup-gateway:ListHypervisors", + "backup-gateway:ImportHypervisorConfiguration", + "backup-gateway:DeleteHypervisor" + ] + } + }, + "primaryIdentifier": [ + "/properties/HypervisorArn" + ], + "properties": { + "Host": { + "maxLength": 128, + "minLength": 3, + "pattern": "^.+$", + "type": "string" + }, + "HypervisorArn": { + "maxLength": 500, + "minLength": 50, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$", + "type": "string" + }, + "KmsKeyArn": { + "maxLength": 500, + "minLength": 50, + "pattern": "^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$", + "type": "string" + }, + "LogGroupArn": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\\-\\/\\.]+:\\*$", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "Password": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[ -~]+$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Username": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/HypervisorArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::BackupGateway::Hypervisor", + "writeOnlyProperties": [ + "/properties/KmsKeyArn", + "/properties/LogGroupArn", + "/properties/Name", + "/properties/Password", + "/properties/Tags", + "/properties/Username" + ] +} diff --git a/schema/aws-batch-computeenvironment.json b/schema/aws-batch-computeenvironment.json index 57222a9..596a2d5 100644 --- a/schema/aws-batch-computeenvironment.json +++ b/schema/aws-batch-computeenvironment.json @@ -1,297 +1,300 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ComputeEnvironmentName" - ] - ], - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/ComputeResources/AllocationStrategy", - "/properties/ComputeResources/BidPercentage", - "/properties/ComputeResources/Ec2Configuration", - "/properties/ComputeResources/Ec2KeyPair", - "/properties/ComputeResources/ImageId", - "/properties/ComputeResources/InstanceRole", - "/properties/ComputeResources/InstanceTypes", - "/properties/ComputeResources/LaunchTemplate", - "/properties/ComputeResources/PlacementGroup", - "/properties/ComputeResources/SecurityGroupIds", - "/properties/ComputeResources/Subnets", - "/properties/ComputeResources/Tags", - "/properties/ComputeResources/Type" - ], - "createOnlyProperties": [ - "/properties/ComputeResources/SpotIamFleetRole", - "/properties/ComputeEnvironmentName", - "/properties/Tags", - "/properties/Type", - "/properties/EksConfiguration" - ], - "definitions": { - "ComputeResources": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BidPercentage": { - "type": "integer" - }, - "DesiredvCpus": { - "type": "integer" - }, - "Ec2Configuration": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ec2ConfigurationObject" - }, - "type": "array", - "uniqueItems": false - }, - "Ec2KeyPair": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceRole": { - "type": "string" - }, - "InstanceTypes": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification" - }, - "MaxvCpus": { - "type": "integer" - }, - "MinvCpus": { - "type": "integer" - }, - "PlacementGroup": { - "type": "string" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SpotIamFleetRole": { - "type": "string" - }, - "Subnets": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "type": "string" - }, - "UpdateToLatestImageVersion": { - "default": false, - "type": "boolean" - } - }, - "required": [ - "Subnets", - "Type", - "MaxvCpus" - ], - "type": "object" - }, - "Ec2ConfigurationObject": { - "additionalProperties": false, - "properties": { - "ImageIdOverride": { - "type": "string" - }, - "ImageKubernetesVersion": { - "type": "string" - }, - "ImageType": { - "type": "string" - } - }, - "required": [ - "ImageType" - ], - "type": "object" - }, - "EksConfiguration": { - "additionalProperties": false, - "properties": { - "EksClusterArn": { - "default": false, - "type": "string" - }, - "KubernetesNamespace": { - "default": false, - "type": "string" - } - }, - "required": [ - "EksClusterArn", - "KubernetesNamespace" - ], - "type": "object" - }, - "LaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "UpdatePolicy": { - "additionalProperties": false, - "properties": { - "JobExecutionTimeoutMinutes": { - "default": 30, - "type": "integer" - }, - "TerminateJobsOnUpdate": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Batch::ComputeEnvironment", - "handlers": { - "create": { - "permissions": [ - "Batch:CreateComputeEnvironment", - "Batch:TagResource", - "Batch:DescribeComputeEnvironments", - "iam:CreateServiceLinkedRole", - "Iam:PassRole", - "Eks:DescribeCluster" - ] - }, - "delete": { - "permissions": [ - "Batch:DeleteComputeEnvironment", - "Batch:DescribeComputeEnvironments", - "Batch:UpdateComputeEnvironment", - "Iam:PassRole", - "Eks:DescribeCluster" - ] - }, - "list": { - "permissions": [ - "Batch:DescribeComputeEnvironments" - ] - }, - "read": { - "permissions": [ - "Batch:DescribeComputeEnvironments" - ] - }, - "update": { - "permissions": [ - "Batch:UpdateComputeEnvironment", - "Batch:DescribeComputeEnvironments", - "Batch:TagResource", - "Batch:UnTagResource", - "Iam:PassRole", - "Eks:DescribeCluster" - ] - } - }, - "primaryIdentifier": [ - "/properties/ComputeEnvironmentArn" - ], - "properties": { - "ComputeEnvironmentArn": { - "type": "string" - }, - "ComputeEnvironmentName": { - "type": "string" - }, - "ComputeResources": { - "$ref": "#/definitions/ComputeResources" - }, - "EksConfiguration": { - "$ref": "#/definitions/EksConfiguration" - }, - "ReplaceComputeEnvironment": { - "default": true, - "type": "boolean" - }, - "ServiceRole": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "type": "string" - }, - "UnmanagedvCpus": { - "type": "integer" - }, - "UpdatePolicy": { - "$ref": "#/definitions/UpdatePolicy" - } - }, - "readOnlyProperties": [ - "/properties/ComputeEnvironmentArn" - ], - "required": [ - "Type" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Batch::ComputeEnvironment", - "writeOnlyProperties": [ - "/properties/ComputeResources/UpdateToLatestImageVersion", - "/properties/ReplaceComputeEnvironment", - "/properties/UpdatePolicy" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ComputeEnvironmentName" + ] + ], + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/ComputeResources/AllocationStrategy", + "/properties/ComputeResources/BidPercentage", + "/properties/ComputeResources/Ec2Configuration", + "/properties/ComputeResources/Ec2KeyPair", + "/properties/ComputeResources/ImageId", + "/properties/ComputeResources/InstanceRole", + "/properties/ComputeResources/InstanceTypes", + "/properties/ComputeResources/LaunchTemplate", + "/properties/ComputeResources/PlacementGroup", + "/properties/ComputeResources/SecurityGroupIds", + "/properties/ComputeResources/Subnets", + "/properties/ComputeResources/Tags", + "/properties/ComputeResources/Type" + ], + "createOnlyProperties": [ + "/properties/ComputeResources/SpotIamFleetRole", + "/properties/ComputeEnvironmentName", + "/properties/Tags", + "/properties/Type", + "/properties/EksConfiguration" + ], + "definitions": { + "ComputeResources": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + }, + "BidPercentage": { + "type": "integer" + }, + "DesiredvCpus": { + "type": "integer" + }, + "Ec2Configuration": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Ec2ConfigurationObject" + }, + "type": "array", + "uniqueItems": false + }, + "Ec2KeyPair": { + "type": "string" + }, + "ImageId": { + "type": "string" + }, + "InstanceRole": { + "type": "string" + }, + "InstanceTypes": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification" + }, + "MaxvCpus": { + "type": "integer" + }, + "MinvCpus": { + "type": "integer" + }, + "PlacementGroup": { + "type": "string" + }, + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SpotIamFleetRole": { + "type": "string" + }, + "Subnets": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "type": "string" + }, + "UpdateToLatestImageVersion": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "Subnets", + "Type", + "MaxvCpus" + ], + "type": "object" + }, + "Ec2ConfigurationObject": { + "additionalProperties": false, + "properties": { + "ImageIdOverride": { + "type": "string" + }, + "ImageKubernetesVersion": { + "type": "string" + }, + "ImageType": { + "type": "string" + } + }, + "required": [ + "ImageType" + ], + "type": "object" + }, + "EksConfiguration": { + "additionalProperties": false, + "properties": { + "EksClusterArn": { + "default": false, + "type": "string" + }, + "KubernetesNamespace": { + "default": false, + "type": "string" + } + }, + "required": [ + "EksClusterArn", + "KubernetesNamespace" + ], + "type": "object" + }, + "LaunchTemplateSpecification": { + "additionalProperties": false, + "properties": { + "LaunchTemplateId": { + "type": "string" + }, + "LaunchTemplateName": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "type": "object" + }, + "UpdatePolicy": { + "additionalProperties": false, + "properties": { + "JobExecutionTimeoutMinutes": { + "default": 30, + "type": "integer" + }, + "TerminateJobsOnUpdate": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Batch::ComputeEnvironment", + "handlers": { + "create": { + "permissions": [ + "Batch:CreateComputeEnvironment", + "Batch:TagResource", + "Batch:DescribeComputeEnvironments", + "iam:CreateServiceLinkedRole", + "Iam:PassRole", + "Eks:DescribeCluster" + ] + }, + "delete": { + "permissions": [ + "Batch:DeleteComputeEnvironment", + "Batch:DescribeComputeEnvironments", + "Batch:UpdateComputeEnvironment", + "Iam:PassRole", + "Eks:DescribeCluster" + ] + }, + "list": { + "permissions": [ + "Batch:DescribeComputeEnvironments" + ] + }, + "read": { + "permissions": [ + "Batch:DescribeComputeEnvironments" + ] + }, + "update": { + "permissions": [ + "Batch:UpdateComputeEnvironment", + "Batch:DescribeComputeEnvironments", + "Batch:TagResource", + "Batch:UnTagResource", + "Iam:PassRole", + "Eks:DescribeCluster" + ] + } + }, + "primaryIdentifier": [ + "/properties/ComputeEnvironmentArn" + ], + "properties": { + "ComputeEnvironmentArn": { + "type": "string" + }, + "ComputeEnvironmentName": { + "type": "string" + }, + "ComputeResources": { + "$ref": "#/definitions/ComputeResources" + }, + "Context": { + "type": "string" + }, + "EksConfiguration": { + "$ref": "#/definitions/EksConfiguration" + }, + "ReplaceComputeEnvironment": { + "default": true, + "type": "boolean" + }, + "ServiceRole": { + "type": "string" + }, + "State": { + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "type": "string" + }, + "UnmanagedvCpus": { + "type": "integer" + }, + "UpdatePolicy": { + "$ref": "#/definitions/UpdatePolicy" + } + }, + "readOnlyProperties": [ + "/properties/ComputeEnvironmentArn" + ], + "required": [ + "Type" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Batch::ComputeEnvironment", + "writeOnlyProperties": [ + "/properties/ComputeResources/UpdateToLatestImageVersion", + "/properties/ReplaceComputeEnvironment", + "/properties/UpdatePolicy" + ] +} diff --git a/schema/aws-batch-jobdefinition.json b/schema/aws-batch-jobdefinition.json index 2ca78ea..962e6f9 100644 --- a/schema/aws-batch-jobdefinition.json +++ b/schema/aws-batch-jobdefinition.json @@ -1,972 +1,972 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags", - "/properties/JobDefinitionName" - ], - "definitions": { - "AuthorizationConfig": { - "additionalProperties": false, - "properties": { - "AccessPointId": { - "type": "string" - }, - "Iam": { - "type": "string" - } - }, - "type": "object" - }, - "ContainerProperties": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Environment": { - "items": { - "$ref": "#/definitions/Environment" - }, - "type": "array", - "uniqueItems": false - }, - "EphemeralStorage": { - "$ref": "#/definitions/EphemeralStorage" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "FargatePlatformConfiguration": { - "$ref": "#/definitions/FargatePlatformConfiguration" - }, - "Image": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "JobRoleArn": { - "type": "string" - }, - "LinuxParameters": { - "$ref": "#/definitions/LinuxParameters" - }, - "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration" - }, - "Memory": { - "type": "integer" - }, - "MountPoints": { - "items": { - "$ref": "#/definitions/MountPoints" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "Privileged": { - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "type": "boolean" - }, - "RepositoryCredentials": { - "$ref": "#/definitions/RepositoryCredentials" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/ResourceRequirement" - }, - "type": "array", - "uniqueItems": false - }, - "RuntimePlatform": { - "$ref": "#/definitions/RuntimePlatform" - }, - "Secrets": { - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array", - "uniqueItems": false - }, - "Ulimits": { - "items": { - "$ref": "#/definitions/Ulimit" - }, - "type": "array", - "uniqueItems": false - }, - "User": { - "type": "string" - }, - "Vcpus": { - "type": "integer" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/Volumes" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "Device": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "HostPath": { - "type": "string" - }, - "Permissions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EcsProperties": { - "additionalProperties": false, - "properties": { - "TaskProperties": { - "items": { - "$ref": "#/definitions/EcsTaskProperties" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "TaskProperties" - ], - "type": "object" - }, - "EcsTaskProperties": { - "additionalProperties": false, - "properties": { - "Containers": { - "items": { - "$ref": "#/definitions/TaskContainerProperties" - }, - "type": "array", - "uniqueItems": false - }, - "EphemeralStorage": { - "$ref": "#/definitions/EphemeralStorage" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "IpcMode": { - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "PidMode": { - "type": "string" - }, - "PlatformVersion": { - "type": "string" - }, - "RuntimePlatform": { - "$ref": "#/definitions/RuntimePlatform" - }, - "TaskRoleArn": { - "type": "string" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/Volumes" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EfsVolumeConfiguration": { - "additionalProperties": false, - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/AuthorizationConfig" - }, - "FileSystemId": { - "type": "string" - }, - "RootDirectory": { - "type": "string" - }, - "TransitEncryption": { - "type": "string" - }, - "TransitEncryptionPort": { - "type": "integer" - } - }, - "required": [ - "FileSystemId" - ], - "type": "object" - }, - "EksContainer": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Command": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Env": { - "items": { - "$ref": "#/definitions/EksContainerEnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Image": { - "type": "string" - }, - "ImagePullPolicy": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Resources": { - "$ref": "#/definitions/EksContainerResourceRequirements" - }, - "SecurityContext": { - "$ref": "#/definitions/EksContainerSecurityContext" - }, - "VolumeMounts": { - "items": { - "$ref": "#/definitions/EksContainerVolumeMount" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "EksContainerEnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "EksContainerResourceRequirements": { - "additionalProperties": false, - "properties": { - "Limits": { - "type": "object" - }, - "Requests": { - "type": "object" - } - }, - "type": "object" - }, - "EksContainerSecurityContext": { - "additionalProperties": false, - "properties": { - "AllowPrivilegeEscalation": { - "type": "boolean" - }, - "Privileged": { - "type": "boolean" - }, - "ReadOnlyRootFilesystem": { - "type": "boolean" - }, - "RunAsGroup": { - "type": "integer" - }, - "RunAsNonRoot": { - "type": "boolean" - }, - "RunAsUser": { - "type": "integer" - } - }, - "type": "object" - }, - "EksContainerVolumeMount": { - "additionalProperties": false, - "properties": { - "MountPath": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - } - }, - "type": "object" - }, - "EksEmptyDir": { - "additionalProperties": false, - "properties": { - "Medium": { - "type": "string" - }, - "SizeLimit": { - "type": "string" - } - }, - "type": "object" - }, - "EksHostPath": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "EksProperties": { - "additionalProperties": false, - "properties": { - "PodProperties": { - "$ref": "#/definitions/PodProperties" - } - }, - "type": "object" - }, - "EksSecret": { - "additionalProperties": false, - "properties": { - "Optional": { - "type": "boolean" - }, - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "EksVolume": { - "additionalProperties": false, - "properties": { - "EmptyDir": { - "$ref": "#/definitions/EksEmptyDir" - }, - "HostPath": { - "$ref": "#/definitions/EksHostPath" - }, - "Name": { - "type": "string" - }, - "Secret": { - "$ref": "#/definitions/EksSecret" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "EphemeralStorage": { - "additionalProperties": false, - "properties": { - "SizeInGiB": { - "type": "integer" - } - }, - "required": [ - "SizeInGiB" - ], - "type": "object" - }, - "EvaluateOnExit": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "OnExitCode": { - "type": "string" - }, - "OnReason": { - "type": "string" - }, - "OnStatusReason": { - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "FargatePlatformConfiguration": { - "additionalProperties": false, - "properties": { - "PlatformVersion": { - "type": "string" - } - }, - "type": "object" - }, - "ImagePullSecret": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "LinuxParameters": { - "additionalProperties": false, - "properties": { - "Devices": { - "items": { - "$ref": "#/definitions/Device" - }, - "type": "array", - "uniqueItems": false - }, - "InitProcessEnabled": { - "type": "boolean" - }, - "MaxSwap": { - "type": "integer" - }, - "SharedMemorySize": { - "type": "integer" - }, - "Swappiness": { - "type": "integer" - }, - "Tmpfs": { - "items": { - "$ref": "#/definitions/Tmpfs" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogDriver": { - "type": "string" - }, - "Options": { - "type": "object" - }, - "SecretOptions": { - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "LogDriver" - ], - "type": "object" - }, - "Metadata": { - "additionalProperties": false, - "properties": { - "Labels": { - "type": "object" - } - }, - "type": "object" - }, - "MountPoints": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "SourceVolume": { - "type": "string" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - } - }, - "type": "object" - }, - "NodeProperties": { - "additionalProperties": false, - "properties": { - "MainNode": { - "type": "integer" - }, - "NodeRangeProperties": { - "items": { - "$ref": "#/definitions/NodeRangeProperty" - }, - "type": "array", - "uniqueItems": false - }, - "NumNodes": { - "type": "integer" - } - }, - "required": [ - "MainNode", - "NodeRangeProperties", - "NumNodes" - ], - "type": "object" - }, - "NodeRangeProperty": { - "additionalProperties": false, - "properties": { - "Container": { - "$ref": "#/definitions/ContainerProperties" - }, - "EcsProperties": { - "$ref": "#/definitions/EcsProperties" - }, - "EksProperties": { - "$ref": "#/definitions/EksProperties" - }, - "InstanceTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TargetNodes": { - "type": "string" - } - }, - "required": [ - "TargetNodes" - ], - "type": "object" - }, - "PodProperties": { - "additionalProperties": false, - "properties": { - "Containers": { - "items": { - "$ref": "#/definitions/EksContainer" - }, - "type": "array", - "uniqueItems": false - }, - "DnsPolicy": { - "type": "string" - }, - "HostNetwork": { - "type": "boolean" - }, - "ImagePullSecrets": { - "items": { - "$ref": "#/definitions/ImagePullSecret" - }, - "type": "array", - "uniqueItems": false - }, - "InitContainers": { - "items": { - "$ref": "#/definitions/EksContainer" - }, - "type": "array", - "uniqueItems": false - }, - "Metadata": { - "$ref": "#/definitions/Metadata" - }, - "ServiceAccountName": { - "type": "string" - }, - "ShareProcessNamespace": { - "type": "boolean" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/EksVolume" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "RepositoryCredentials": { - "additionalProperties": false, - "properties": { - "CredentialsParameter": { - "type": "string" - } - }, - "required": [ - "CredentialsParameter" - ], - "type": "object" - }, - "ResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "RetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "type": "integer" - }, - "EvaluateOnExit": { - "items": { - "$ref": "#/definitions/EvaluateOnExit" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "RuntimePlatform": { - "additionalProperties": false, - "properties": { - "CpuArchitecture": { - "type": "string" - }, - "OperatingSystemFamily": { - "type": "string" - } - }, - "type": "object" - }, - "Secret": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ValueFrom": { - "type": "string" - } - }, - "required": [ - "ValueFrom", - "Name" - ], - "type": "object" - }, - "TaskContainerDependency": { - "additionalProperties": false, - "properties": { - "Condition": { - "type": "string" - }, - "ContainerName": { - "type": "string" - } - }, - "required": [ - "Condition", - "ContainerName" - ], - "type": "object" - }, - "TaskContainerProperties": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "DependsOn": { - "items": { - "$ref": "#/definitions/TaskContainerDependency" - }, - "type": "array", - "uniqueItems": false - }, - "Environment": { - "items": { - "$ref": "#/definitions/Environment" - }, - "type": "array", - "uniqueItems": false - }, - "Essential": { - "type": "boolean" - }, - "Image": { - "type": "string" - }, - "LinuxParameters": { - "$ref": "#/definitions/LinuxParameters" - }, - "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration" - }, - "MountPoints": { - "items": { - "$ref": "#/definitions/MountPoints" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "Privileged": { - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "type": "boolean" - }, - "RepositoryCredentials": { - "$ref": "#/definitions/RepositoryCredentials" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/ResourceRequirement" - }, - "type": "array", - "uniqueItems": false - }, - "Secrets": { - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array", - "uniqueItems": false - }, - "Ulimits": { - "items": { - "$ref": "#/definitions/Ulimit" - }, - "type": "array", - "uniqueItems": false - }, - "User": { - "type": "string" - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "Timeout": { - "additionalProperties": false, - "properties": { - "AttemptDurationSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "Tmpfs": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "MountOptions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Size": { - "type": "integer" - } - }, - "required": [ - "Size", - "ContainerPath" - ], - "type": "object" - }, - "Ulimit": { - "additionalProperties": false, - "properties": { - "HardLimit": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "SoftLimit": { - "type": "integer" - } - }, - "required": [ - "SoftLimit", - "HardLimit", - "Name" - ], - "type": "object" - }, - "Volumes": { - "additionalProperties": false, - "properties": { - "EfsVolumeConfiguration": { - "$ref": "#/definitions/EfsVolumeConfiguration" - }, - "Host": { - "$ref": "#/definitions/VolumesHost" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "VolumesHost": { - "additionalProperties": false, - "properties": { - "SourcePath": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Batch::JobDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ContainerProperties": { - "$ref": "#/definitions/ContainerProperties" - }, - "EcsProperties": { - "$ref": "#/definitions/EcsProperties" - }, - "EksProperties": { - "$ref": "#/definitions/EksProperties" - }, - "Id": { - "type": "string" - }, - "JobDefinitionName": { - "type": "string" - }, - "NodeProperties": { - "$ref": "#/definitions/NodeProperties" - }, - "Parameters": { - "type": "object" - }, - "PlatformCapabilities": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PropagateTags": { - "type": "boolean" - }, - "RetryStrategy": { - "$ref": "#/definitions/RetryStrategy" - }, - "SchedulingPriority": { - "type": "integer" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "$ref": "#/definitions/Timeout" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Type" - ], - "typeName": "AWS::Batch::JobDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags", + "/properties/JobDefinitionName" + ], + "definitions": { + "AuthorizationConfig": { + "additionalProperties": false, + "properties": { + "AccessPointId": { + "type": "string" + }, + "Iam": { + "type": "string" + } + }, + "type": "object" + }, + "ContainerProperties": { + "additionalProperties": false, + "properties": { + "Command": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Environment": { + "items": { + "$ref": "#/definitions/Environment" + }, + "type": "array", + "uniqueItems": false + }, + "EphemeralStorage": { + "$ref": "#/definitions/EphemeralStorage" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "FargatePlatformConfiguration": { + "$ref": "#/definitions/FargatePlatformConfiguration" + }, + "Image": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "JobRoleArn": { + "type": "string" + }, + "LinuxParameters": { + "$ref": "#/definitions/LinuxParameters" + }, + "LogConfiguration": { + "$ref": "#/definitions/LogConfiguration" + }, + "Memory": { + "type": "integer" + }, + "MountPoints": { + "items": { + "$ref": "#/definitions/MountPoints" + }, + "type": "array", + "uniqueItems": false + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "Privileged": { + "type": "boolean" + }, + "ReadonlyRootFilesystem": { + "type": "boolean" + }, + "RepositoryCredentials": { + "$ref": "#/definitions/RepositoryCredentials" + }, + "ResourceRequirements": { + "items": { + "$ref": "#/definitions/ResourceRequirement" + }, + "type": "array", + "uniqueItems": false + }, + "RuntimePlatform": { + "$ref": "#/definitions/RuntimePlatform" + }, + "Secrets": { + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array", + "uniqueItems": false + }, + "Ulimits": { + "items": { + "$ref": "#/definitions/Ulimit" + }, + "type": "array", + "uniqueItems": false + }, + "User": { + "type": "string" + }, + "Vcpus": { + "type": "integer" + }, + "Volumes": { + "items": { + "$ref": "#/definitions/Volumes" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Image" + ], + "type": "object" + }, + "Device": { + "additionalProperties": false, + "properties": { + "ContainerPath": { + "type": "string" + }, + "HostPath": { + "type": "string" + }, + "Permissions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EcsProperties": { + "additionalProperties": false, + "properties": { + "TaskProperties": { + "items": { + "$ref": "#/definitions/EcsTaskProperties" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "TaskProperties" + ], + "type": "object" + }, + "EcsTaskProperties": { + "additionalProperties": false, + "properties": { + "Containers": { + "items": { + "$ref": "#/definitions/TaskContainerProperties" + }, + "type": "array", + "uniqueItems": false + }, + "EphemeralStorage": { + "$ref": "#/definitions/EphemeralStorage" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "IpcMode": { + "type": "string" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "PidMode": { + "type": "string" + }, + "PlatformVersion": { + "type": "string" + }, + "RuntimePlatform": { + "$ref": "#/definitions/RuntimePlatform" + }, + "TaskRoleArn": { + "type": "string" + }, + "Volumes": { + "items": { + "$ref": "#/definitions/Volumes" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EfsVolumeConfiguration": { + "additionalProperties": false, + "properties": { + "AuthorizationConfig": { + "$ref": "#/definitions/AuthorizationConfig" + }, + "FileSystemId": { + "type": "string" + }, + "RootDirectory": { + "type": "string" + }, + "TransitEncryption": { + "type": "string" + }, + "TransitEncryptionPort": { + "type": "integer" + } + }, + "required": [ + "FileSystemId" + ], + "type": "object" + }, + "EksContainer": { + "additionalProperties": false, + "properties": { + "Args": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Command": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Env": { + "items": { + "$ref": "#/definitions/EksContainerEnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "Image": { + "type": "string" + }, + "ImagePullPolicy": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Resources": { + "$ref": "#/definitions/EksContainerResourceRequirements" + }, + "SecurityContext": { + "$ref": "#/definitions/EksContainerSecurityContext" + }, + "VolumeMounts": { + "items": { + "$ref": "#/definitions/EksContainerVolumeMount" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Image" + ], + "type": "object" + }, + "EksContainerEnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "EksContainerResourceRequirements": { + "additionalProperties": false, + "properties": { + "Limits": { + "type": "object" + }, + "Requests": { + "type": "object" + } + }, + "type": "object" + }, + "EksContainerSecurityContext": { + "additionalProperties": false, + "properties": { + "AllowPrivilegeEscalation": { + "type": "boolean" + }, + "Privileged": { + "type": "boolean" + }, + "ReadOnlyRootFilesystem": { + "type": "boolean" + }, + "RunAsGroup": { + "type": "integer" + }, + "RunAsNonRoot": { + "type": "boolean" + }, + "RunAsUser": { + "type": "integer" + } + }, + "type": "object" + }, + "EksContainerVolumeMount": { + "additionalProperties": false, + "properties": { + "MountPath": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ReadOnly": { + "type": "boolean" + } + }, + "type": "object" + }, + "EksEmptyDir": { + "additionalProperties": false, + "properties": { + "Medium": { + "type": "string" + }, + "SizeLimit": { + "type": "string" + } + }, + "type": "object" + }, + "EksHostPath": { + "additionalProperties": false, + "properties": { + "Path": { + "type": "string" + } + }, + "type": "object" + }, + "EksProperties": { + "additionalProperties": false, + "properties": { + "PodProperties": { + "$ref": "#/definitions/PodProperties" + } + }, + "type": "object" + }, + "EksSecret": { + "additionalProperties": false, + "properties": { + "Optional": { + "type": "boolean" + }, + "SecretName": { + "type": "string" + } + }, + "required": [ + "SecretName" + ], + "type": "object" + }, + "EksVolume": { + "additionalProperties": false, + "properties": { + "EmptyDir": { + "$ref": "#/definitions/EksEmptyDir" + }, + "HostPath": { + "$ref": "#/definitions/EksHostPath" + }, + "Name": { + "type": "string" + }, + "Secret": { + "$ref": "#/definitions/EksSecret" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Environment": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "EphemeralStorage": { + "additionalProperties": false, + "properties": { + "SizeInGiB": { + "type": "integer" + } + }, + "required": [ + "SizeInGiB" + ], + "type": "object" + }, + "EvaluateOnExit": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "OnExitCode": { + "type": "string" + }, + "OnReason": { + "type": "string" + }, + "OnStatusReason": { + "type": "string" + } + }, + "required": [ + "Action" + ], + "type": "object" + }, + "FargatePlatformConfiguration": { + "additionalProperties": false, + "properties": { + "PlatformVersion": { + "type": "string" + } + }, + "type": "object" + }, + "ImagePullSecret": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LinuxParameters": { + "additionalProperties": false, + "properties": { + "Devices": { + "items": { + "$ref": "#/definitions/Device" + }, + "type": "array", + "uniqueItems": false + }, + "InitProcessEnabled": { + "type": "boolean" + }, + "MaxSwap": { + "type": "integer" + }, + "SharedMemorySize": { + "type": "integer" + }, + "Swappiness": { + "type": "integer" + }, + "Tmpfs": { + "items": { + "$ref": "#/definitions/Tmpfs" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "properties": { + "LogDriver": { + "type": "string" + }, + "Options": { + "type": "object" + }, + "SecretOptions": { + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "LogDriver" + ], + "type": "object" + }, + "Metadata": { + "additionalProperties": false, + "properties": { + "Labels": { + "type": "object" + } + }, + "type": "object" + }, + "MountPoints": { + "additionalProperties": false, + "properties": { + "ContainerPath": { + "type": "string" + }, + "ReadOnly": { + "type": "boolean" + }, + "SourceVolume": { + "type": "string" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "properties": { + "AssignPublicIp": { + "type": "string" + } + }, + "type": "object" + }, + "NodeProperties": { + "additionalProperties": false, + "properties": { + "MainNode": { + "type": "integer" + }, + "NodeRangeProperties": { + "items": { + "$ref": "#/definitions/NodeRangeProperty" + }, + "type": "array", + "uniqueItems": false + }, + "NumNodes": { + "type": "integer" + } + }, + "required": [ + "MainNode", + "NodeRangeProperties", + "NumNodes" + ], + "type": "object" + }, + "NodeRangeProperty": { + "additionalProperties": false, + "properties": { + "Container": { + "$ref": "#/definitions/ContainerProperties" + }, + "EcsProperties": { + "$ref": "#/definitions/EcsProperties" + }, + "EksProperties": { + "$ref": "#/definitions/EksProperties" + }, + "InstanceTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TargetNodes": { + "type": "string" + } + }, + "required": [ + "TargetNodes" + ], + "type": "object" + }, + "PodProperties": { + "additionalProperties": false, + "properties": { + "Containers": { + "items": { + "$ref": "#/definitions/EksContainer" + }, + "type": "array", + "uniqueItems": false + }, + "DnsPolicy": { + "type": "string" + }, + "HostNetwork": { + "type": "boolean" + }, + "ImagePullSecrets": { + "items": { + "$ref": "#/definitions/ImagePullSecret" + }, + "type": "array", + "uniqueItems": false + }, + "InitContainers": { + "items": { + "$ref": "#/definitions/EksContainer" + }, + "type": "array", + "uniqueItems": false + }, + "Metadata": { + "$ref": "#/definitions/Metadata" + }, + "ServiceAccountName": { + "type": "string" + }, + "ShareProcessNamespace": { + "type": "boolean" + }, + "Volumes": { + "items": { + "$ref": "#/definitions/EksVolume" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "RepositoryCredentials": { + "additionalProperties": false, + "properties": { + "CredentialsParameter": { + "type": "string" + } + }, + "required": [ + "CredentialsParameter" + ], + "type": "object" + }, + "ResourceRequirement": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "RetryStrategy": { + "additionalProperties": false, + "properties": { + "Attempts": { + "type": "integer" + }, + "EvaluateOnExit": { + "items": { + "$ref": "#/definitions/EvaluateOnExit" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "RuntimePlatform": { + "additionalProperties": false, + "properties": { + "CpuArchitecture": { + "type": "string" + }, + "OperatingSystemFamily": { + "type": "string" + } + }, + "type": "object" + }, + "Secret": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "ValueFrom": { + "type": "string" + } + }, + "required": [ + "ValueFrom", + "Name" + ], + "type": "object" + }, + "TaskContainerDependency": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "ContainerName": { + "type": "string" + } + }, + "required": [ + "Condition", + "ContainerName" + ], + "type": "object" + }, + "TaskContainerProperties": { + "additionalProperties": false, + "properties": { + "Command": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "DependsOn": { + "items": { + "$ref": "#/definitions/TaskContainerDependency" + }, + "type": "array", + "uniqueItems": false + }, + "Environment": { + "items": { + "$ref": "#/definitions/Environment" + }, + "type": "array", + "uniqueItems": false + }, + "Essential": { + "type": "boolean" + }, + "Image": { + "type": "string" + }, + "LinuxParameters": { + "$ref": "#/definitions/LinuxParameters" + }, + "LogConfiguration": { + "$ref": "#/definitions/LogConfiguration" + }, + "MountPoints": { + "items": { + "$ref": "#/definitions/MountPoints" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "Privileged": { + "type": "boolean" + }, + "ReadonlyRootFilesystem": { + "type": "boolean" + }, + "RepositoryCredentials": { + "$ref": "#/definitions/RepositoryCredentials" + }, + "ResourceRequirements": { + "items": { + "$ref": "#/definitions/ResourceRequirement" + }, + "type": "array", + "uniqueItems": false + }, + "Secrets": { + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array", + "uniqueItems": false + }, + "Ulimits": { + "items": { + "$ref": "#/definitions/Ulimit" + }, + "type": "array", + "uniqueItems": false + }, + "User": { + "type": "string" + } + }, + "required": [ + "Image" + ], + "type": "object" + }, + "Timeout": { + "additionalProperties": false, + "properties": { + "AttemptDurationSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "Tmpfs": { + "additionalProperties": false, + "properties": { + "ContainerPath": { + "type": "string" + }, + "MountOptions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Size": { + "type": "integer" + } + }, + "required": [ + "Size", + "ContainerPath" + ], + "type": "object" + }, + "Ulimit": { + "additionalProperties": false, + "properties": { + "HardLimit": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "SoftLimit": { + "type": "integer" + } + }, + "required": [ + "SoftLimit", + "HardLimit", + "Name" + ], + "type": "object" + }, + "Volumes": { + "additionalProperties": false, + "properties": { + "EfsVolumeConfiguration": { + "$ref": "#/definitions/EfsVolumeConfiguration" + }, + "Host": { + "$ref": "#/definitions/VolumesHost" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "VolumesHost": { + "additionalProperties": false, + "properties": { + "SourcePath": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Batch::JobDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ContainerProperties": { + "$ref": "#/definitions/ContainerProperties" + }, + "EcsProperties": { + "$ref": "#/definitions/EcsProperties" + }, + "EksProperties": { + "$ref": "#/definitions/EksProperties" + }, + "Id": { + "type": "string" + }, + "JobDefinitionName": { + "type": "string" + }, + "NodeProperties": { + "$ref": "#/definitions/NodeProperties" + }, + "Parameters": { + "type": "object" + }, + "PlatformCapabilities": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PropagateTags": { + "type": "boolean" + }, + "RetryStrategy": { + "$ref": "#/definitions/RetryStrategy" + }, + "SchedulingPriority": { + "type": "integer" + }, + "Tags": { + "type": "object" + }, + "Timeout": { + "$ref": "#/definitions/Timeout" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Type" + ], + "typeName": "AWS::Batch::JobDefinition" +} diff --git a/schema/aws-batch-jobqueue.json b/schema/aws-batch-jobqueue.json index be83ed3..ddb280c 100644 --- a/schema/aws-batch-jobqueue.json +++ b/schema/aws-batch-jobqueue.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags", - "/properties/JobQueueName" - ], - "definitions": { - "ComputeEnvironmentOrder": { - "additionalProperties": false, - "properties": { - "ComputeEnvironment": { - "type": "string" - }, - "Order": { - "type": "integer" - } - }, - "required": [ - "ComputeEnvironment", - "Order" - ], - "type": "object" - }, - "JobStateTimeLimitAction": { - "additionalProperties": false, - "properties": { - "Action": { - "enum": [ - "CANCEL" - ], - "type": "string" - }, - "MaxTimeSeconds": { - "maximum": 86400, - "minimum": 600, - "type": "integer" - }, - "Reason": { - "type": "string" - }, - "State": { - "enum": [ - "RUNNABLE" - ], - "type": "string" - } - }, - "required": [ - "Action", - "MaxTimeSeconds", - "Reason", - "State" - ], - "type": "object" - }, - "ResourceArn": { - "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Batch::JobQueue", - "handlers": { - "create": { - "permissions": [ - "Batch:CreateJobQueue", - "Batch:TagResource", - "Batch:DescribeJobQueues" - ] - }, - "delete": { - "permissions": [ - "Batch:UpdateJobQueue", - "Batch:DescribeJobQueues", - "Batch:DeleteJobQueue" - ] - }, - "list": { - "permissions": [ - "Batch:DescribeJobQueues" - ] - }, - "read": { - "permissions": [ - "Batch:DescribeJobQueues" - ] - }, - "update": { - "permissions": [ - "Batch:DescribeJobQueues", - "Batch:UpdateJobQueue", - "Batch:TagResource", - "Batch:UnTagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobQueueArn" - ], - "properties": { - "ComputeEnvironmentOrder": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ComputeEnvironmentOrder" - }, - "type": "array", - "uniqueItems": false - }, - "JobQueueArn": { - "$ref": "#/definitions/ResourceArn" - }, - "JobQueueName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "JobStateTimeLimitActions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/JobStateTimeLimitAction" - }, - "type": "array", - "uniqueItems": false - }, - "Priority": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - }, - "SchedulingPolicyArn": { - "$ref": "#/definitions/ResourceArn" - }, - "State": { - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/JobQueueArn" - ], - "required": [ - "ComputeEnvironmentOrder", - "Priority" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Batch::JobQueue" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags", + "/properties/JobQueueName" + ], + "definitions": { + "ComputeEnvironmentOrder": { + "additionalProperties": false, + "properties": { + "ComputeEnvironment": { + "type": "string" + }, + "Order": { + "type": "integer" + } + }, + "required": [ + "ComputeEnvironment", + "Order" + ], + "type": "object" + }, + "JobStateTimeLimitAction": { + "additionalProperties": false, + "properties": { + "Action": { + "enum": [ + "CANCEL" + ], + "type": "string" + }, + "MaxTimeSeconds": { + "maximum": 86400, + "minimum": 600, + "type": "integer" + }, + "Reason": { + "type": "string" + }, + "State": { + "enum": [ + "RUNNABLE" + ], + "type": "string" + } + }, + "required": [ + "Action", + "MaxTimeSeconds", + "Reason", + "State" + ], + "type": "object" + }, + "ResourceArn": { + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Batch::JobQueue", + "handlers": { + "create": { + "permissions": [ + "Batch:CreateJobQueue", + "Batch:TagResource", + "Batch:DescribeJobQueues" + ] + }, + "delete": { + "permissions": [ + "Batch:UpdateJobQueue", + "Batch:DescribeJobQueues", + "Batch:DeleteJobQueue" + ] + }, + "list": { + "permissions": [ + "Batch:DescribeJobQueues" + ] + }, + "read": { + "permissions": [ + "Batch:DescribeJobQueues" + ] + }, + "update": { + "permissions": [ + "Batch:DescribeJobQueues", + "Batch:UpdateJobQueue", + "Batch:TagResource", + "Batch:UnTagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/JobQueueArn" + ], + "properties": { + "ComputeEnvironmentOrder": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ComputeEnvironmentOrder" + }, + "type": "array", + "uniqueItems": false + }, + "JobQueueArn": { + "$ref": "#/definitions/ResourceArn" + }, + "JobQueueName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "JobStateTimeLimitActions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/JobStateTimeLimitAction" + }, + "type": "array", + "uniqueItems": false + }, + "Priority": { + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "SchedulingPolicyArn": { + "$ref": "#/definitions/ResourceArn" + }, + "State": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/JobQueueArn" + ], + "required": [ + "ComputeEnvironmentOrder", + "Priority" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Batch::JobQueue" +} diff --git a/schema/aws-batch-schedulingpolicy.json b/schema/aws-batch-schedulingpolicy.json index 951d5d1..e7902d6 100644 --- a/schema/aws-batch-schedulingpolicy.json +++ b/schema/aws-batch-schedulingpolicy.json @@ -1,125 +1,125 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "FairsharePolicy": { - "additionalProperties": false, - "description": "Fair Share Policy for the Job Queue.", - "properties": { - "ComputeReservation": { - "maximum": 99, - "minimum": 0, - "type": "number" - }, - "ShareDecaySeconds": { - "maximum": 604800, - "minimum": 0, - "type": "number" - }, - "ShareDistribution": { - "description": "List of Share Attributes", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ShareAttributes" - }, - "type": "array" - } - }, - "required": [], - "type": "object" - }, - "ResourceArn": { - "description": "ARN of the Scheduling Policy.", - "type": "string" - }, - "ShareAttributes": { - "additionalProperties": false, - "properties": { - "ShareIdentifier": { - "type": "string" - }, - "WeightFactor": { - "maximum": 1000, - "minimum": 0, - "type": "number" - } - }, - "required": [], - "type": "object" - } - }, - "description": "Resource Type schema for AWS::Batch::SchedulingPolicy", - "handlers": { - "create": { - "permissions": [ - "Batch:CreateSchedulingPolicy", - "Batch:TagResource" - ] - }, - "delete": { - "permissions": [ - "Batch:DescribeSchedulingPolicies", - "Batch:DeleteSchedulingPolicy" - ] - }, - "list": { - "permissions": [ - "Batch:ListSchedulingPolicies", - "Batch:DescribeSchedulingPolicies" - ] - }, - "read": { - "permissions": [ - "Batch:DescribeSchedulingPolicies" - ] - }, - "update": { - "permissions": [ - "Batch:UpdateSchedulingPolicy", - "Batch:TagResource", - "Batch:UnTagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "FairsharePolicy": { - "$ref": "#/definitions/FairsharePolicy" - }, - "Name": { - "description": "Name of Scheduling Policy.", - "pattern": "", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-batch.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Batch::SchedulingPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "FairsharePolicy": { + "additionalProperties": false, + "description": "Fair Share Policy for the Job Queue.", + "properties": { + "ComputeReservation": { + "maximum": 99, + "minimum": 0, + "type": "number" + }, + "ShareDecaySeconds": { + "maximum": 604800, + "minimum": 0, + "type": "number" + }, + "ShareDistribution": { + "description": "List of Share Attributes", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ShareAttributes" + }, + "type": "array" + } + }, + "required": [], + "type": "object" + }, + "ResourceArn": { + "description": "ARN of the Scheduling Policy.", + "type": "string" + }, + "ShareAttributes": { + "additionalProperties": false, + "properties": { + "ShareIdentifier": { + "type": "string" + }, + "WeightFactor": { + "maximum": 1000, + "minimum": 0, + "type": "number" + } + }, + "required": [], + "type": "object" + } + }, + "description": "Resource Type schema for AWS::Batch::SchedulingPolicy", + "handlers": { + "create": { + "permissions": [ + "Batch:CreateSchedulingPolicy", + "Batch:TagResource" + ] + }, + "delete": { + "permissions": [ + "Batch:DescribeSchedulingPolicies", + "Batch:DeleteSchedulingPolicy" + ] + }, + "list": { + "permissions": [ + "Batch:ListSchedulingPolicies", + "Batch:DescribeSchedulingPolicies" + ] + }, + "read": { + "permissions": [ + "Batch:DescribeSchedulingPolicies" + ] + }, + "update": { + "permissions": [ + "Batch:UpdateSchedulingPolicy", + "Batch:TagResource", + "Batch:UnTagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "FairsharePolicy": { + "$ref": "#/definitions/FairsharePolicy" + }, + "Name": { + "description": "Name of Scheduling Policy.", + "pattern": "", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-batch.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Batch::SchedulingPolicy" +} diff --git a/schema/aws-bcmdataexports-export.json b/schema/aws-bcmdataexports-export.json index a028d4d..8190a2d 100644 --- a/schema/aws-bcmdataexports-export.json +++ b/schema/aws-bcmdataexports-export.json @@ -1,296 +1,296 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Export/Name", - "/properties/Export/DataQuery/TableConfigurations", - "/properties/Export/RefreshCadence" - ], - "definitions": { - "CompressionOption": { - "enum": [ - "GZIP", - "PARQUET" - ], - "type": "string" - }, - "DataQuery": { - "additionalProperties": false, - "properties": { - "QueryStatement": { - "maxLength": 36000, - "minLength": 1, - "pattern": "^[\\S\\s]*$", - "type": "string" - }, - "TableConfigurations": { - "$ref": "#/definitions/TableConfigurations" - } - }, - "required": [ - "QueryStatement" - ], - "type": "object" - }, - "DestinationConfigurations": { - "additionalProperties": false, - "properties": { - "S3Destination": { - "$ref": "#/definitions/S3Destination" - } - }, - "required": [ - "S3Destination" - ], - "type": "object" - }, - "Export": { - "additionalProperties": false, - "properties": { - "DataQuery": { - "$ref": "#/definitions/DataQuery" - }, - "Description": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[\\S\\s]*$", - "type": "string" - }, - "DestinationConfigurations": { - "$ref": "#/definitions/DestinationConfigurations" - }, - "ExportArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[0-9A-Za-z\\-_]+$", - "type": "string" - }, - "RefreshCadence": { - "$ref": "#/definitions/RefreshCadence" - } - }, - "required": [ - "DataQuery", - "DestinationConfigurations", - "Name", - "RefreshCadence" - ], - "type": "object" - }, - "FormatOption": { - "enum": [ - "TEXT_OR_CSV", - "PARQUET" - ], - "type": "string" - }, - "FrequencyOption": { - "enum": [ - "SYNCHRONOUS" - ], - "type": "string" - }, - "OverwriteOption": { - "enum": [ - "CREATE_NEW_REPORT", - "OVERWRITE_REPORT" - ], - "type": "string" - }, - "RefreshCadence": { - "additionalProperties": false, - "properties": { - "Frequency": { - "$ref": "#/definitions/FrequencyOption" - } - }, - "required": [ - "Frequency" - ], - "type": "object" - }, - "ResourceTag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "S3Destination": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[\\S\\s]*$", - "type": "string" - }, - "S3OutputConfigurations": { - "$ref": "#/definitions/S3OutputConfigurations" - }, - "S3Prefix": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[\\S\\s]*$", - "type": "string" - }, - "S3Region": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[\\S\\s]*$", - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3OutputConfigurations", - "S3Prefix", - "S3Region" - ], - "type": "object" - }, - "S3OutputConfigurations": { - "additionalProperties": false, - "properties": { - "Compression": { - "$ref": "#/definitions/CompressionOption" - }, - "Format": { - "$ref": "#/definitions/FormatOption" - }, - "OutputType": { - "$ref": "#/definitions/S3OutputType" - }, - "Overwrite": { - "$ref": "#/definitions/OverwriteOption" - } - }, - "required": [ - "Compression", - "Format", - "OutputType", - "Overwrite" - ], - "type": "object" - }, - "S3OutputType": { - "enum": [ - "CUSTOM" - ], - "type": "string" - }, - "TableConfigurations": { - "additionalProperties": false, - "patternProperties": { - "^[\\S\\s]*$": { - "$ref": "#/definitions/TableProperties" - } - }, - "type": "object" - }, - "TableProperties": { - "additionalProperties": false, - "patternProperties": { - "^[\\S\\s]*$": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[\\S\\s]*$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::BCMDataExports::Export Resource Type", - "documentationUrl": "https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DataExports_CreateExport.html#API_DataExports_CreateExport_RequestSyntax", - "handlers": { - "create": { - "permissions": [ - "bcm-data-exports:CreateExport", - "bcm-data-exports:GetExport", - "bcm-data-exports:ListTagsForResource", - "bcm-data-exports:TagResource", - "cur:PutReportDefinition" - ] - }, - "delete": { - "permissions": [ - "bcm-data-exports:DeleteExport" - ] - }, - "list": { - "permissions": [ - "bcm-data-exports:ListExports" - ] - }, - "read": { - "permissions": [ - "bcm-data-exports:GetExport", - "bcm-data-exports:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "bcm-data-exports:UpdateExport", - "bcm-data-exports:TagResource", - "bcm-data-exports:UntagResource", - "bcm-data-exports:GetExport", - "bcm-data-exports:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ExportArn" - ], - "properties": { - "Export": { - "$ref": "#/definitions/Export" - }, - "ExportArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ExportArn" - ], - "required": [ - "Export" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::BCMDataExports::Export" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Export/Name", + "/properties/Export/DataQuery/TableConfigurations", + "/properties/Export/RefreshCadence" + ], + "definitions": { + "CompressionOption": { + "enum": [ + "GZIP", + "PARQUET" + ], + "type": "string" + }, + "DataQuery": { + "additionalProperties": false, + "properties": { + "QueryStatement": { + "maxLength": 36000, + "minLength": 1, + "pattern": "^[\\S\\s]*$", + "type": "string" + }, + "TableConfigurations": { + "$ref": "#/definitions/TableConfigurations" + } + }, + "required": [ + "QueryStatement" + ], + "type": "object" + }, + "DestinationConfigurations": { + "additionalProperties": false, + "properties": { + "S3Destination": { + "$ref": "#/definitions/S3Destination" + } + }, + "required": [ + "S3Destination" + ], + "type": "object" + }, + "Export": { + "additionalProperties": false, + "properties": { + "DataQuery": { + "$ref": "#/definitions/DataQuery" + }, + "Description": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[\\S\\s]*$", + "type": "string" + }, + "DestinationConfigurations": { + "$ref": "#/definitions/DestinationConfigurations" + }, + "ExportArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[0-9A-Za-z\\-_]+$", + "type": "string" + }, + "RefreshCadence": { + "$ref": "#/definitions/RefreshCadence" + } + }, + "required": [ + "DataQuery", + "DestinationConfigurations", + "Name", + "RefreshCadence" + ], + "type": "object" + }, + "FormatOption": { + "enum": [ + "TEXT_OR_CSV", + "PARQUET" + ], + "type": "string" + }, + "FrequencyOption": { + "enum": [ + "SYNCHRONOUS" + ], + "type": "string" + }, + "OverwriteOption": { + "enum": [ + "CREATE_NEW_REPORT", + "OVERWRITE_REPORT" + ], + "type": "string" + }, + "RefreshCadence": { + "additionalProperties": false, + "properties": { + "Frequency": { + "$ref": "#/definitions/FrequencyOption" + } + }, + "required": [ + "Frequency" + ], + "type": "object" + }, + "ResourceTag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "S3Destination": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[\\S\\s]*$", + "type": "string" + }, + "S3OutputConfigurations": { + "$ref": "#/definitions/S3OutputConfigurations" + }, + "S3Prefix": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[\\S\\s]*$", + "type": "string" + }, + "S3Region": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[\\S\\s]*$", + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3OutputConfigurations", + "S3Prefix", + "S3Region" + ], + "type": "object" + }, + "S3OutputConfigurations": { + "additionalProperties": false, + "properties": { + "Compression": { + "$ref": "#/definitions/CompressionOption" + }, + "Format": { + "$ref": "#/definitions/FormatOption" + }, + "OutputType": { + "$ref": "#/definitions/S3OutputType" + }, + "Overwrite": { + "$ref": "#/definitions/OverwriteOption" + } + }, + "required": [ + "Compression", + "Format", + "OutputType", + "Overwrite" + ], + "type": "object" + }, + "S3OutputType": { + "enum": [ + "CUSTOM" + ], + "type": "string" + }, + "TableConfigurations": { + "additionalProperties": false, + "patternProperties": { + "^[\\S\\s]*$": { + "$ref": "#/definitions/TableProperties" + } + }, + "type": "object" + }, + "TableProperties": { + "additionalProperties": false, + "patternProperties": { + "^[\\S\\s]*$": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[\\S\\s]*$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::BCMDataExports::Export Resource Type", + "documentationUrl": "https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DataExports_CreateExport.html#API_DataExports_CreateExport_RequestSyntax", + "handlers": { + "create": { + "permissions": [ + "bcm-data-exports:CreateExport", + "bcm-data-exports:GetExport", + "bcm-data-exports:ListTagsForResource", + "bcm-data-exports:TagResource", + "cur:PutReportDefinition" + ] + }, + "delete": { + "permissions": [ + "bcm-data-exports:DeleteExport" + ] + }, + "list": { + "permissions": [ + "bcm-data-exports:ListExports" + ] + }, + "read": { + "permissions": [ + "bcm-data-exports:GetExport", + "bcm-data-exports:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bcm-data-exports:UpdateExport", + "bcm-data-exports:TagResource", + "bcm-data-exports:UntagResource", + "bcm-data-exports:GetExport", + "bcm-data-exports:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ExportArn" + ], + "properties": { + "Export": { + "$ref": "#/definitions/Export" + }, + "ExportArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ExportArn" + ], + "required": [ + "Export" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::BCMDataExports::Export" +} diff --git a/schema/aws-bedrock-agent.json b/schema/aws-bedrock-agent.json index 441664a..26afef7 100644 --- a/schema/aws-bedrock-agent.json +++ b/schema/aws-bedrock-agent.json @@ -1,682 +1,682 @@ -{ - "additionalProperties": false, - "definitions": { - "APISchema": { - "description": "Contains information about the API Schema for the Action Group", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "S3": { - "$ref": "#/definitions/S3Identifier" - } - }, - "required": [ - "S3" - ], - "title": "S3", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Payload": { - "description": "String OpenAPI Payload", - "type": "string" - } - }, - "required": [ - "Payload" - ], - "title": "Payload", - "type": "object" - } - ] - }, - "ActionGroupExecutor": { - "description": "Type of Executors for an Action Group", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Lambda": { - "description": "ARN of a Lambda.", - "maxLength": 2048, - "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "Lambda" - ], - "title": "Lambda", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "CustomControl": { - "$ref": "#/definitions/CustomControlMethod" - } - }, - "required": [ - "CustomControl" - ], - "title": "CustomControl", - "type": "object" - } - ] - }, - "ActionGroupSignature": { - "description": "Action Group Signature for a BuiltIn Action", - "enum": [ - "AMAZON.UserInput" - ], - "type": "string" - }, - "ActionGroupState": { - "description": "State of the action group", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "AgentActionGroup": { - "additionalProperties": false, - "description": "Contains the information of an Agent Action Group", - "properties": { - "ActionGroupExecutor": { - "$ref": "#/definitions/ActionGroupExecutor" - }, - "ActionGroupName": { - "description": "Name of the action group", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "ActionGroupState": { - "$ref": "#/definitions/ActionGroupState" - }, - "ApiSchema": { - "$ref": "#/definitions/APISchema" - }, - "Description": { - "description": "Description of action group", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FunctionSchema": { - "$ref": "#/definitions/FunctionSchema" - }, - "ParentActionGroupSignature": { - "$ref": "#/definitions/ActionGroupSignature" - }, - "SkipResourceInUseCheckOnDelete": { - "default": false, - "description": "Specifies whether to allow deleting action group while it is in use.", - "type": "boolean" - } - }, - "required": [ - "ActionGroupName" - ], - "type": "object" - }, - "AgentKnowledgeBase": { - "additionalProperties": false, - "description": "Agent Knowledge Base", - "properties": { - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "KnowledgeBaseId": { - "description": "Identifier for a resource.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "KnowledgeBaseState": { - "$ref": "#/definitions/KnowledgeBaseState" - } - }, - "required": [ - "KnowledgeBaseId", - "Description" - ], - "type": "object" - }, - "AgentStatus": { - "description": "Schema Type for Action APIs.", - "enum": [ - "CREATING", - "PREPARING", - "PREPARED", - "NOT_PREPARED", - "DELETING", - "FAILED", - "VERSIONING", - "UPDATING" - ], - "type": "string" - }, - "CreationMode": { - "description": "Creation Mode for Prompt Configuration.", - "enum": [ - "DEFAULT", - "OVERRIDDEN" - ], - "type": "string" - }, - "CustomControlMethod": { - "description": "Custom control of action execution", - "enum": [ - "RETURN_CONTROL" - ], - "type": "string" - }, - "Function": { - "additionalProperties": false, - "description": "Function definition", - "properties": { - "Description": { - "description": "Description of function", - "maxLength": 1200, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name for a resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/ParameterMap" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "FunctionSchema": { - "additionalProperties": false, - "description": "Schema of Functions", - "properties": { - "Functions": { - "description": "List of Function definitions", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Function" - }, - "type": "array" - } - }, - "required": [ - "Functions" - ], - "title": "Functions", - "type": "object" - }, - "GuardrailConfiguration": { - "additionalProperties": false, - "description": "Configuration for a guardrail.", - "properties": { - "GuardrailIdentifier": { - "description": "Identifier for the guardrail, could be the id or the arn", - "maxLength": 2048, - "pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$", - "type": "string" - }, - "GuardrailVersion": { - "description": "Version of the guardrail", - "pattern": "^(([0-9]{1,8})|(DRAFT))$", - "type": "string" - } - }, - "type": "object" - }, - "InferenceConfiguration": { - "additionalProperties": false, - "description": "Configuration for inference in prompt configuration", - "properties": { - "MaximumLength": { - "description": "Maximum length of output", - "maximum": 4096, - "minimum": 0, - "type": "number" - }, - "StopSequences": { - "description": "List of stop sequences", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array" - }, - "Temperature": { - "description": "Controls randomness, higher values increase diversity", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "TopK": { - "description": "Sample from the k most likely next tokens", - "maximum": 500, - "minimum": 0, - "type": "number" - }, - "TopP": { - "description": "Cumulative probability cutoff for token selection", - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "KnowledgeBaseState": { - "description": "State of the knowledge base; whether it is enabled or disabled", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "ParameterDetail": { - "additionalProperties": false, - "description": "Parameter detail", - "properties": { - "Description": { - "description": "Description of function parameter.", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "Required": { - "description": "Information about if a parameter is required for function call. Default to false.", - "type": "boolean" - }, - "Type": { - "$ref": "#/definitions/Type" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ParameterMap": { - "additionalProperties": false, - "description": "A map of parameter name and detail", - "patternProperties": { - "^([0-9a-zA-Z][_-]?){1,100}$": { - "$ref": "#/definitions/ParameterDetail" - } - }, - "type": "object" - }, - "PromptConfiguration": { - "additionalProperties": false, - "description": "BasePromptConfiguration per Prompt Type.", - "properties": { - "BasePromptTemplate": { - "description": "Base Prompt Template.", - "maxLength": 100000, - "minLength": 1, - "type": "string" - }, - "InferenceConfiguration": { - "$ref": "#/definitions/InferenceConfiguration" - }, - "ParserMode": { - "$ref": "#/definitions/CreationMode" - }, - "PromptCreationMode": { - "$ref": "#/definitions/CreationMode" - }, - "PromptState": { - "$ref": "#/definitions/PromptState" - }, - "PromptType": { - "$ref": "#/definitions/PromptType" - } - }, - "type": "object" - }, - "PromptOverrideConfiguration": { - "additionalProperties": false, - "description": "Configuration for prompt override.", - "properties": { - "OverrideLambda": { - "description": "ARN of a Lambda.", - "maxLength": 2048, - "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - }, - "PromptConfigurations": { - "description": "List of BasePromptConfiguration", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PromptConfiguration" - }, - "maxItems": 10, - "type": "array" - } - }, - "required": [ - "PromptConfigurations" - ], - "type": "object" - }, - "PromptState": { - "description": "Prompt State.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "PromptType": { - "description": "Prompt Type.", - "enum": [ - "PRE_PROCESSING", - "ORCHESTRATION", - "POST_PROCESSING", - "KNOWLEDGE_BASE_RESPONSE_GENERATION" - ], - "type": "string" - }, - "S3Identifier": { - "additionalProperties": false, - "description": "The identifier for the S3 resource.", - "properties": { - "S3BucketName": { - "description": "A bucket in S3.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "S3ObjectKey": { - "description": "A object key in S3.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$", - "type": "string" - } - }, - "type": "object" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "description": "Parameter Type", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Bedrock::Agent Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateAgent", - "bedrock:GetAgent", - "bedrock:PrepareAgent", - "bedrock:GetAgentKnowledgeBase", - "bedrock:AssociateAgentKnowledgeBase", - "bedrock:ListAgentKnowledgeBases", - "bedrock:CreateAgentActionGroup", - "bedrock:GetAgentActionGroup", - "bedrock:ListAgentActionGroups", - "bedrock:TagResource", - "bedrock:ListTagsForResource", - "bedrock:CreateGuardrail", - "bedrock:CreateGuardrailVersion", - "bedrock:GetGuardrail", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "bedrock:GetAgent", - "bedrock:DeleteAgent", - "bedrock:DeleteGuardrail", - "bedrock:GetGuardrail" - ] - }, - "list": { - "permissions": [ - "bedrock:ListAgents", - "bedrock:ListGuardrails" - ] - }, - "read": { - "permissions": [ - "bedrock:GetAgent", - "bedrock:GetAgentActionGroup", - "bedrock:ListAgentActionGroups", - "bedrock:GetAgentKnowledgeBase", - "bedrock:ListAgentKnowledgeBases", - "bedrock:ListTagsForResource", - "bedrock:GetGuardrail", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "bedrock:GetAgent", - "bedrock:UpdateAgent", - "bedrock:PrepareAgent", - "bedrock:GetAgentKnowledgeBase", - "bedrock:UpdateAgentKnowledgeBase", - "bedrock:AssociateAgentKnowledgeBase", - "bedrock:DisassociateAgentKnowledgeBase", - "bedrock:ListAgentKnowledgeBases", - "bedrock:CreateAgentActionGroup", - "bedrock:GetAgentActionGroup", - "bedrock:UpdateAgentActionGroup", - "bedrock:DeleteAgentActionGroup", - "bedrock:ListAgentActionGroups", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource", - "bedrock:UpdateGuardrail", - "bedrock:GetGuardrail", - "kms:Decrypt", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AgentId" - ], - "properties": { - "ActionGroups": { - "description": "List of ActionGroups", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AgentActionGroup" - }, - "type": "array" - }, - "AgentArn": { - "description": "Arn representation of the Agent.", - "maxLength": 2048, - "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "AgentId": { - "description": "Identifier for a resource.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "AgentName": { - "description": "Name for a resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "AgentResourceRoleArn": { - "description": "ARN of a IAM role.", - "maxLength": 2048, - "type": "string" - }, - "AgentStatus": { - "$ref": "#/definitions/AgentStatus" - }, - "AgentVersion": { - "description": "Draft Agent Version.", - "maxLength": 5, - "minLength": 5, - "pattern": "^DRAFT$", - "type": "string" - }, - "AutoPrepare": { - "default": false, - "description": "Specifies whether to automatically prepare after creating or updating the agent.", - "type": "boolean" - }, - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "CustomerEncryptionKeyArn": { - "description": "A KMS key ARN", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - }, - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FailureReasons": { - "description": "Failure Reasons for Error.", - "insertionOrder": false, - "items": { - "description": "Failure Reason for Error.", - "maxLength": 2048, - "type": "string" - }, - "maxItems": 2048, - "type": "array" - }, - "FoundationModel": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - }, - "GuardrailConfiguration": { - "$ref": "#/definitions/GuardrailConfiguration" - }, - "IdleSessionTTLInSeconds": { - "description": "Max Session Time.", - "maximum": 3600, - "minimum": 60, - "type": "number" - }, - "Instruction": { - "description": "Instruction for the agent.", - "minLength": 40, - "type": "string" - }, - "KnowledgeBases": { - "description": "List of Agent Knowledge Bases", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AgentKnowledgeBase" - }, - "type": "array" - }, - "PreparedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "PromptOverrideConfiguration": { - "$ref": "#/definitions/PromptOverrideConfiguration" - }, - "RecommendedActions": { - "description": "The recommended actions users can take to resolve an error in failureReasons.", - "insertionOrder": false, - "items": { - "description": "The recommended action users can take to resolve an error in failureReasons.", - "maxLength": 2048, - "type": "string" - }, - "maxItems": 2048, - "type": "array" - }, - "SkipResourceInUseCheckOnDelete": { - "default": false, - "description": "Specifies whether to allow deleting agent while it is in use.", - "type": "boolean" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "TestAliasTags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AgentArn", - "/properties/AgentId", - "/properties/AgentStatus", - "/properties/AgentVersion", - "/properties/CreatedAt", - "/properties/FailureReasons", - "/properties/PreparedAt", - "/properties/RecommendedActions", - "/properties/UpdatedAt" - ], - "required": [ - "AgentName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::Agent", - "writeOnlyProperties": [ - "/properties/AutoPrepare", - "/properties/SkipResourceInUseCheckOnDelete", - "/properties/ActionGroups/*/SkipResourceInUseCheckOnDelete" - ] -} +{ + "additionalProperties": false, + "definitions": { + "APISchema": { + "description": "Contains information about the API Schema for the Action Group", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/S3Identifier" + } + }, + "required": [ + "S3" + ], + "title": "S3", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Payload": { + "description": "String OpenAPI Payload", + "type": "string" + } + }, + "required": [ + "Payload" + ], + "title": "Payload", + "type": "object" + } + ] + }, + "ActionGroupExecutor": { + "description": "Type of Executors for an Action Group", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Lambda": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "Lambda" + ], + "title": "Lambda", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "CustomControl": { + "$ref": "#/definitions/CustomControlMethod" + } + }, + "required": [ + "CustomControl" + ], + "title": "CustomControl", + "type": "object" + } + ] + }, + "ActionGroupSignature": { + "description": "Action Group Signature for a BuiltIn Action", + "enum": [ + "AMAZON.UserInput" + ], + "type": "string" + }, + "ActionGroupState": { + "description": "State of the action group", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "AgentActionGroup": { + "additionalProperties": false, + "description": "Contains the information of an Agent Action Group", + "properties": { + "ActionGroupExecutor": { + "$ref": "#/definitions/ActionGroupExecutor" + }, + "ActionGroupName": { + "description": "Name of the action group", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "ActionGroupState": { + "$ref": "#/definitions/ActionGroupState" + }, + "ApiSchema": { + "$ref": "#/definitions/APISchema" + }, + "Description": { + "description": "Description of action group", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FunctionSchema": { + "$ref": "#/definitions/FunctionSchema" + }, + "ParentActionGroupSignature": { + "$ref": "#/definitions/ActionGroupSignature" + }, + "SkipResourceInUseCheckOnDelete": { + "default": false, + "description": "Specifies whether to allow deleting action group while it is in use.", + "type": "boolean" + } + }, + "required": [ + "ActionGroupName" + ], + "type": "object" + }, + "AgentKnowledgeBase": { + "additionalProperties": false, + "description": "Agent Knowledge Base", + "properties": { + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "KnowledgeBaseId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "KnowledgeBaseState": { + "$ref": "#/definitions/KnowledgeBaseState" + } + }, + "required": [ + "KnowledgeBaseId", + "Description" + ], + "type": "object" + }, + "AgentStatus": { + "description": "Schema Type for Action APIs.", + "enum": [ + "CREATING", + "PREPARING", + "PREPARED", + "NOT_PREPARED", + "DELETING", + "FAILED", + "VERSIONING", + "UPDATING" + ], + "type": "string" + }, + "CreationMode": { + "description": "Creation Mode for Prompt Configuration.", + "enum": [ + "DEFAULT", + "OVERRIDDEN" + ], + "type": "string" + }, + "CustomControlMethod": { + "description": "Custom control of action execution", + "enum": [ + "RETURN_CONTROL" + ], + "type": "string" + }, + "Function": { + "additionalProperties": false, + "description": "Function definition", + "properties": { + "Description": { + "description": "Description of function", + "maxLength": 1200, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/ParameterMap" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "FunctionSchema": { + "additionalProperties": false, + "description": "Schema of Functions", + "properties": { + "Functions": { + "description": "List of Function definitions", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Function" + }, + "type": "array" + } + }, + "required": [ + "Functions" + ], + "title": "Functions", + "type": "object" + }, + "GuardrailConfiguration": { + "additionalProperties": false, + "description": "Configuration for a guardrail.", + "properties": { + "GuardrailIdentifier": { + "description": "Identifier for the guardrail, could be the id or the arn", + "maxLength": 2048, + "pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$", + "type": "string" + }, + "GuardrailVersion": { + "description": "Version of the guardrail", + "pattern": "^(([0-9]{1,8})|(DRAFT))$", + "type": "string" + } + }, + "type": "object" + }, + "InferenceConfiguration": { + "additionalProperties": false, + "description": "Configuration for inference in prompt configuration", + "properties": { + "MaximumLength": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "KnowledgeBaseState": { + "description": "State of the knowledge base; whether it is enabled or disabled", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "ParameterDetail": { + "additionalProperties": false, + "description": "Parameter detail", + "properties": { + "Description": { + "description": "Description of function parameter.", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "Required": { + "description": "Information about if a parameter is required for function call. Default to false.", + "type": "boolean" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ParameterMap": { + "additionalProperties": false, + "description": "A map of parameter name and detail", + "patternProperties": { + "^([0-9a-zA-Z][_-]?){1,100}$": { + "$ref": "#/definitions/ParameterDetail" + } + }, + "type": "object" + }, + "PromptConfiguration": { + "additionalProperties": false, + "description": "BasePromptConfiguration per Prompt Type.", + "properties": { + "BasePromptTemplate": { + "description": "Base Prompt Template.", + "maxLength": 100000, + "minLength": 1, + "type": "string" + }, + "InferenceConfiguration": { + "$ref": "#/definitions/InferenceConfiguration" + }, + "ParserMode": { + "$ref": "#/definitions/CreationMode" + }, + "PromptCreationMode": { + "$ref": "#/definitions/CreationMode" + }, + "PromptState": { + "$ref": "#/definitions/PromptState" + }, + "PromptType": { + "$ref": "#/definitions/PromptType" + } + }, + "type": "object" + }, + "PromptOverrideConfiguration": { + "additionalProperties": false, + "description": "Configuration for prompt override.", + "properties": { + "OverrideLambda": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + }, + "PromptConfigurations": { + "description": "List of BasePromptConfiguration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PromptConfiguration" + }, + "maxItems": 10, + "type": "array" + } + }, + "required": [ + "PromptConfigurations" + ], + "type": "object" + }, + "PromptState": { + "description": "Prompt State.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "PromptType": { + "description": "Prompt Type.", + "enum": [ + "PRE_PROCESSING", + "ORCHESTRATION", + "POST_PROCESSING", + "KNOWLEDGE_BASE_RESPONSE_GENERATION" + ], + "type": "string" + }, + "S3Identifier": { + "additionalProperties": false, + "description": "The identifier for the S3 resource.", + "properties": { + "S3BucketName": { + "description": "A bucket in S3.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "S3ObjectKey": { + "description": "A object key in S3.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$", + "type": "string" + } + }, + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "description": "Parameter Type", + "enum": [ + "string", + "number", + "integer", + "boolean", + "array" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Bedrock::Agent Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateAgent", + "bedrock:GetAgent", + "bedrock:PrepareAgent", + "bedrock:GetAgentKnowledgeBase", + "bedrock:AssociateAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:CreateAgentActionGroup", + "bedrock:GetAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "bedrock:CreateGuardrail", + "bedrock:CreateGuardrailVersion", + "bedrock:GetGuardrail", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:DeleteAgent", + "bedrock:DeleteGuardrail", + "bedrock:GetGuardrail" + ] + }, + "list": { + "permissions": [ + "bedrock:ListAgents", + "bedrock:ListGuardrails" + ] + }, + "read": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:GetAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:GetAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:ListTagsForResource", + "bedrock:GetGuardrail", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:UpdateAgent", + "bedrock:PrepareAgent", + "bedrock:GetAgentKnowledgeBase", + "bedrock:UpdateAgentKnowledgeBase", + "bedrock:AssociateAgentKnowledgeBase", + "bedrock:DisassociateAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:CreateAgentActionGroup", + "bedrock:GetAgentActionGroup", + "bedrock:UpdateAgentActionGroup", + "bedrock:DeleteAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "bedrock:UpdateGuardrail", + "bedrock:GetGuardrail", + "kms:Decrypt", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentId" + ], + "properties": { + "ActionGroups": { + "description": "List of ActionGroups", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentActionGroup" + }, + "type": "array" + }, + "AgentArn": { + "description": "Arn representation of the Agent.", + "maxLength": 2048, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentName": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "AgentResourceRoleArn": { + "description": "ARN of a IAM role.", + "maxLength": 2048, + "type": "string" + }, + "AgentStatus": { + "$ref": "#/definitions/AgentStatus" + }, + "AgentVersion": { + "description": "Draft Agent Version.", + "maxLength": 5, + "minLength": 5, + "pattern": "^DRAFT$", + "type": "string" + }, + "AutoPrepare": { + "default": false, + "description": "Specifies whether to automatically prepare after creating or updating the agent.", + "type": "boolean" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "Failure Reasons for Error.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "FoundationModel": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + }, + "GuardrailConfiguration": { + "$ref": "#/definitions/GuardrailConfiguration" + }, + "IdleSessionTTLInSeconds": { + "description": "Max Session Time.", + "maximum": 3600, + "minimum": 60, + "type": "number" + }, + "Instruction": { + "description": "Instruction for the agent.", + "minLength": 40, + "type": "string" + }, + "KnowledgeBases": { + "description": "List of Agent Knowledge Bases", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentKnowledgeBase" + }, + "type": "array" + }, + "PreparedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "PromptOverrideConfiguration": { + "$ref": "#/definitions/PromptOverrideConfiguration" + }, + "RecommendedActions": { + "description": "The recommended actions users can take to resolve an error in failureReasons.", + "insertionOrder": false, + "items": { + "description": "The recommended action users can take to resolve an error in failureReasons.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "SkipResourceInUseCheckOnDelete": { + "default": false, + "description": "Specifies whether to allow deleting agent while it is in use.", + "type": "boolean" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "TestAliasTags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentArn", + "/properties/AgentId", + "/properties/AgentStatus", + "/properties/AgentVersion", + "/properties/CreatedAt", + "/properties/FailureReasons", + "/properties/PreparedAt", + "/properties/RecommendedActions", + "/properties/UpdatedAt" + ], + "required": [ + "AgentName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Agent", + "writeOnlyProperties": [ + "/properties/AutoPrepare", + "/properties/SkipResourceInUseCheckOnDelete", + "/properties/ActionGroups/*/SkipResourceInUseCheckOnDelete" + ] +} diff --git a/schema/aws-bedrock-agentalias.json b/schema/aws-bedrock-agentalias.json index 26ac30f..00a8e5b 100644 --- a/schema/aws-bedrock-agentalias.json +++ b/schema/aws-bedrock-agentalias.json @@ -1,217 +1,217 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/AgentAliasArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AgentId" - ], - "definitions": { - "AgentAliasHistoryEvent": { - "additionalProperties": false, - "description": "History event for an alias for an Agent.", - "properties": { - "EndDate": { - "description": "Time Stamp.", - "type": "string" - }, - "RoutingConfiguration": { - "description": "Routing configuration for an Agent alias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" - }, - "maxItems": 1, - "type": "array" - }, - "StartDate": { - "description": "Time Stamp.", - "type": "string" - } - }, - "type": "object" - }, - "AgentAliasRoutingConfigurationListItem": { - "additionalProperties": false, - "description": "Details about the routing configuration for an Agent alias.", - "properties": { - "AgentVersion": { - "description": "Agent Version.", - "maxLength": 5, - "minLength": 1, - "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", - "type": "string" - } - }, - "required": [ - "AgentVersion" - ], - "type": "object" - }, - "AgentAliasStatus": { - "description": "The statuses an Agent Alias can be in.", - "enum": [ - "CREATING", - "PREPARED", - "FAILED", - "UPDATING", - "DELETING" - ], - "type": "string" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::AgentAlias Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:PrepareAgent", - "bedrock:GetAgent", - "bedrock:CreateAgentAlias", - "bedrock:TagResource", - "bedrock:GetAgentAlias", - "bedrock:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteAgentAlias" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AgentId": { - "$ref": "resource-schema.json#/properties/AgentId" - } - }, - "required": [ - "AgentId" - ] - }, - "permissions": [ - "bedrock:ListAgentAliases" - ] - }, - "read": { - "permissions": [ - "bedrock:GetAgentAlias", - "bedrock:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "bedrock:PrepareAgent", - "bedrock:GetAgent", - "bedrock:UpdateAgentAlias", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:GetAgentAlias", - "bedrock:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AgentId", - "/properties/AgentAliasId" - ], - "properties": { - "AgentAliasArn": { - "description": "Arn representation of the Agent Alias.", - "maxLength": 2048, - "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "AgentAliasHistoryEvents": { - "description": "The list of history events for an alias for an Agent.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AgentAliasHistoryEvent" - }, - "maxItems": 10, - "type": "array" - }, - "AgentAliasId": { - "description": "Id for an Agent Alias generated at the server side.", - "maxLength": 10, - "minLength": 10, - "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$", - "type": "string" - }, - "AgentAliasName": { - "description": "Name for a resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "AgentAliasStatus": { - "$ref": "#/definitions/AgentAliasStatus" - }, - "AgentId": { - "description": "Identifier for a resource.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "CreatedAt": { - "description": "Time Stamp.", - "type": "string" - }, - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "RoutingConfiguration": { - "description": "Routing configuration for an Agent alias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" - }, - "maxItems": 1, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AgentAliasArn", - "/properties/AgentAliasHistoryEvents", - "/properties/AgentAliasId", - "/properties/AgentAliasStatus", - "/properties/CreatedAt", - "/properties/UpdatedAt" - ], - "required": [ - "AgentAliasName", - "AgentId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-agents", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::AgentAlias" -} +{ + "additionalIdentifiers": [ + [ + "/properties/AgentAliasArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AgentId" + ], + "definitions": { + "AgentAliasHistoryEvent": { + "additionalProperties": false, + "description": "History event for an alias for an Agent.", + "properties": { + "EndDate": { + "description": "Time Stamp.", + "type": "string" + }, + "RoutingConfiguration": { + "description": "Routing configuration for an Agent alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" + }, + "maxItems": 1, + "type": "array" + }, + "StartDate": { + "description": "Time Stamp.", + "type": "string" + } + }, + "type": "object" + }, + "AgentAliasRoutingConfigurationListItem": { + "additionalProperties": false, + "description": "Details about the routing configuration for an Agent alias.", + "properties": { + "AgentVersion": { + "description": "Agent Version.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", + "type": "string" + } + }, + "required": [ + "AgentVersion" + ], + "type": "object" + }, + "AgentAliasStatus": { + "description": "The statuses an Agent Alias can be in.", + "enum": [ + "CREATING", + "PREPARED", + "FAILED", + "UPDATING", + "DELETING" + ], + "type": "string" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::AgentAlias Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:PrepareAgent", + "bedrock:GetAgent", + "bedrock:CreateAgentAlias", + "bedrock:TagResource", + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteAgentAlias" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AgentId": { + "$ref": "resource-schema.json#/properties/AgentId" + } + }, + "required": [ + "AgentId" + ] + }, + "permissions": [ + "bedrock:ListAgentAliases" + ] + }, + "read": { + "permissions": [ + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:PrepareAgent", + "bedrock:GetAgent", + "bedrock:UpdateAgentAlias", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentId", + "/properties/AgentAliasId" + ], + "properties": { + "AgentAliasArn": { + "description": "Arn representation of the Agent Alias.", + "maxLength": 2048, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentAliasHistoryEvents": { + "description": "The list of history events for an alias for an Agent.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasHistoryEvent" + }, + "maxItems": 10, + "type": "array" + }, + "AgentAliasId": { + "description": "Id for an Agent Alias generated at the server side.", + "maxLength": 10, + "minLength": 10, + "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$", + "type": "string" + }, + "AgentAliasName": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "AgentAliasStatus": { + "$ref": "#/definitions/AgentAliasStatus" + }, + "AgentId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "RoutingConfiguration": { + "description": "Routing configuration for an Agent alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" + }, + "maxItems": 1, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentAliasArn", + "/properties/AgentAliasHistoryEvents", + "/properties/AgentAliasId", + "/properties/AgentAliasStatus", + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "AgentAliasName", + "AgentId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-agents", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::AgentAlias" +} diff --git a/schema/aws-bedrock-datasource.json b/schema/aws-bedrock-datasource.json index 46ec899..67054b8 100644 --- a/schema/aws-bedrock-datasource.json +++ b/schema/aws-bedrock-datasource.json @@ -1,278 +1,959 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KnowledgeBaseId", - "/properties/VectorIngestionConfiguration" - ], - "definitions": { - "ChunkingConfiguration": { - "additionalProperties": false, - "description": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.", - "properties": { - "ChunkingStrategy": { - "$ref": "#/definitions/ChunkingStrategy" - }, - "FixedSizeChunkingConfiguration": { - "$ref": "#/definitions/FixedSizeChunkingConfiguration" - } - }, - "required": [ - "ChunkingStrategy" - ], - "type": "object" - }, - "ChunkingStrategy": { - "description": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.", - "enum": [ - "FIXED_SIZE", - "NONE" - ], - "type": "string" - }, - "DataDeletionPolicy": { - "description": "The deletion policy for the data source.", - "enum": [ - "RETAIN", - "DELETE" - ], - "type": "string" - }, - "DataSourceConfiguration": { - "additionalProperties": false, - "description": "Specifies a raw data source location to ingest.", - "properties": { - "S3Configuration": { - "$ref": "#/definitions/S3DataSourceConfiguration" - }, - "Type": { - "$ref": "#/definitions/DataSourceType" - } - }, - "required": [ - "Type", - "S3Configuration" - ], - "type": "object" - }, - "DataSourceStatus": { - "description": "The status of a data source.", - "enum": [ - "AVAILABLE", - "DELETING", - "DELETE_UNSUCCESSFUL" - ], - "type": "string" - }, - "DataSourceType": { - "description": "The type of the data source location.", - "enum": [ - "S3" - ], - "type": "string" - }, - "FixedSizeChunkingConfiguration": { - "additionalProperties": false, - "description": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.", - "properties": { - "MaxTokens": { - "description": "The maximum number of tokens to include in a chunk.", - "minimum": 1, - "type": "integer" - }, - "OverlapPercentage": { - "description": "The percentage of overlap between adjacent chunks of a data source.", - "maximum": 99, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "MaxTokens", - "OverlapPercentage" - ], - "type": "object" - }, - "S3DataSourceConfiguration": { - "additionalProperties": false, - "description": "Contains information about the S3 configuration of the data source.", - "properties": { - "BucketArn": { - "description": "The ARN of the bucket that contains the data source.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$", - "type": "string" - }, - "BucketOwnerAccountId": { - "description": "The account ID for the owner of the S3 bucket.", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "InclusionPrefixes": { - "description": "A list of S3 prefixes that define the object containing the data sources.", - "insertionOrder": false, - "items": { - "description": "Prefix for s3 object.", - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "BucketArn" - ], - "type": "object" - }, - "ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "description": "Contains details about the server-side encryption for the data source.", - "properties": { - "KmsKeyArn": { - "description": "The ARN of the AWS KMS key used to encrypt the resource.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - } - }, - "type": "object" - }, - "VectorIngestionConfiguration": { - "additionalProperties": false, - "description": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.", - "properties": { - "ChunkingConfiguration": { - "$ref": "#/definitions/ChunkingConfiguration" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::DataSource Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateDataSource", - "bedrock:GetDataSource", - "bedrock:GetKnowledgeBase" - ] - }, - "delete": { - "permissions": [ - "bedrock:GetDataSource", - "bedrock:DeleteDataSource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "KnowledgeBaseId": { - "$ref": "resource-schema.json#/properties/KnowledgeBaseId" - } - }, - "required": [ - "KnowledgeBaseId" - ] - }, - "permissions": [ - "bedrock:ListDataSources" - ] - }, - "read": { - "permissions": [ - "bedrock:GetDataSource" - ] - }, - "update": { - "permissions": [ - "bedrock:GetDataSource", - "bedrock:UpdateDataSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/KnowledgeBaseId", - "/properties/DataSourceId" - ], - "properties": { - "CreatedAt": { - "description": "The time at which the data source was created.", - "type": "string" - }, - "DataDeletionPolicy": { - "$ref": "#/definitions/DataDeletionPolicy" - }, - "DataSourceConfiguration": { - "$ref": "#/definitions/DataSourceConfiguration" - }, - "DataSourceId": { - "description": "Identifier for a resource.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "DataSourceStatus": { - "$ref": "#/definitions/DataSourceStatus" - }, - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FailureReasons": { - "description": "The details of the failure reasons related to the data source.", - "insertionOrder": false, - "items": { - "description": "Failure Reason for Error.", - "maxLength": 2048, - "type": "string" - }, - "maxItems": 2048, - "type": "array" - }, - "KnowledgeBaseId": { - "description": "The unique identifier of the knowledge base to which to add the data source.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Name": { - "description": "The name of the data source.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/ServerSideEncryptionConfiguration" - }, - "UpdatedAt": { - "description": "The time at which the knowledge base was last updated.", - "type": "string" - }, - "VectorIngestionConfiguration": { - "$ref": "#/definitions/VectorIngestionConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/DataSourceId", - "/properties/DataSourceStatus", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/FailureReasons" - ], - "required": [ - "DataSourceConfiguration", - "Name", - "KnowledgeBaseId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", - "tagging": { - "cloudFormationSystemTags": false, - "taggable": false - }, - "typeName": "AWS::Bedrock::DataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KnowledgeBaseId", + "/properties/VectorIngestionConfiguration/ChunkingConfiguration", + "/properties/VectorIngestionConfiguration/ParsingConfiguration", + "/properties/DataSourceConfiguration/Type" + ], + "definitions": { + "BedrockFoundationModelConfiguration": { + "additionalProperties": false, + "description": "Settings for a foundation model used to parse documents for a data source.", + "properties": { + "ModelArn": { + "description": "The model's ARN.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$", + "type": "string" + }, + "ParsingPrompt": { + "$ref": "#/definitions/ParsingPrompt" + } + }, + "required": [ + "ModelArn" + ], + "type": "object" + }, + "ChunkingConfiguration": { + "additionalProperties": false, + "description": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.", + "properties": { + "ChunkingStrategy": { + "$ref": "#/definitions/ChunkingStrategy" + }, + "FixedSizeChunkingConfiguration": { + "$ref": "#/definitions/FixedSizeChunkingConfiguration" + }, + "HierarchicalChunkingConfiguration": { + "$ref": "#/definitions/HierarchicalChunkingConfiguration" + }, + "SemanticChunkingConfiguration": { + "$ref": "#/definitions/SemanticChunkingConfiguration" + } + }, + "required": [ + "ChunkingStrategy" + ], + "type": "object" + }, + "ChunkingStrategy": { + "description": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.", + "enum": [ + "FIXED_SIZE", + "NONE", + "HIERARCHICAL", + "SEMANTIC" + ], + "type": "string" + }, + "ConfluenceCrawlerConfiguration": { + "additionalProperties": false, + "description": "The configuration of the Confluence content. For example, configuring specific types of Confluence content.", + "properties": { + "FilterConfiguration": { + "$ref": "#/definitions/CrawlFilterConfiguration" + } + }, + "type": "object" + }, + "ConfluenceDataSourceConfiguration": { + "additionalProperties": false, + "description": "The configuration information to connect to Confluence as your data source.", + "properties": { + "CrawlerConfiguration": { + "$ref": "#/definitions/ConfluenceCrawlerConfiguration" + }, + "SourceConfiguration": { + "$ref": "#/definitions/ConfluenceSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "ConfluenceSourceConfiguration": { + "additionalProperties": false, + "description": "The endpoint information to connect to your Confluence data source.", + "properties": { + "AuthType": { + "description": "The supported authentication type to authenticate and connect to your Confluence instance.", + "enum": [ + "BASIC", + "OAUTH2_CLIENT_CREDENTIALS" + ], + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "HostType": { + "description": "The supported host type, whether online/cloud or server/on-premises.", + "enum": [ + "SAAS" + ], + "type": "string" + }, + "HostUrl": { + "description": "The Confluence host URL or instance URL.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^https://[A-Za-z0-9][^\\s]*$", + "type": "string" + } + }, + "required": [ + "HostUrl", + "HostType", + "AuthType", + "CredentialsSecretArn" + ], + "type": "object" + }, + "CrawlFilterConfiguration": { + "additionalProperties": false, + "description": "The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.", + "properties": { + "PatternObjectFilter": { + "$ref": "#/definitions/PatternObjectFilterConfiguration" + }, + "Type": { + "description": "The crawl filter type.", + "enum": [ + "PATTERN" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "CustomTransformationConfiguration": { + "additionalProperties": false, + "description": "Settings for customizing steps in the data source content ingestion pipeline.", + "properties": { + "IntermediateStorage": { + "$ref": "#/definitions/IntermediateStorage" + }, + "Transformations": { + "description": "A list of Lambda functions that process documents.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Transformation" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "IntermediateStorage", + "Transformations" + ], + "type": "object" + }, + "DataDeletionPolicy": { + "description": "The deletion policy for the data source.", + "enum": [ + "RETAIN", + "DELETE" + ], + "type": "string" + }, + "DataSourceConfiguration": { + "additionalProperties": false, + "description": "Specifies a raw data source location to ingest.", + "oneOf": [ + { + "required": [ + "S3Configuration" + ] + }, + { + "required": [ + "ConfluenceConfiguration" + ] + }, + { + "required": [ + "SalesforceConfiguration" + ] + }, + { + "required": [ + "SharePointConfiguration" + ] + }, + { + "required": [ + "WebConfiguration" + ] + } + ], + "properties": { + "ConfluenceConfiguration": { + "$ref": "#/definitions/ConfluenceDataSourceConfiguration" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DataSourceConfiguration" + }, + "SalesforceConfiguration": { + "$ref": "#/definitions/SalesforceDataSourceConfiguration" + }, + "SharePointConfiguration": { + "$ref": "#/definitions/SharePointDataSourceConfiguration" + }, + "Type": { + "$ref": "#/definitions/DataSourceType" + }, + "WebConfiguration": { + "$ref": "#/definitions/WebDataSourceConfiguration" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "DataSourceStatus": { + "description": "The status of a data source.", + "enum": [ + "AVAILABLE", + "DELETING", + "DELETE_UNSUCCESSFUL" + ], + "type": "string" + }, + "DataSourceType": { + "description": "The type of the data source location.", + "enum": [ + "S3", + "CONFLUENCE", + "SALESFORCE", + "SHAREPOINT", + "WEB" + ], + "type": "string" + }, + "FilterList": { + "description": "A set of regular expression filter patterns for a type of object.", + "insertionOrder": false, + "items": { + "description": "A list of one or more inclusion/exclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn't crawled.", + "maxLength": 1000, + "type": "string" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + }, + "FixedSizeChunkingConfiguration": { + "additionalProperties": false, + "description": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.", + "properties": { + "MaxTokens": { + "description": "The maximum number of tokens to include in a chunk.", + "minimum": 1, + "type": "integer" + }, + "OverlapPercentage": { + "description": "The percentage of overlap between adjacent chunks of a data source.", + "maximum": 99, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxTokens", + "OverlapPercentage" + ], + "type": "object" + }, + "HierarchicalChunkingConfiguration": { + "additionalProperties": false, + "description": "Configurations for when you choose hierarchical chunking. If you set the chunkingStrategy as NONE, exclude this field.", + "properties": { + "LevelConfigurations": { + "description": "Token settings for each layer.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HierarchicalChunkingLevelConfiguration" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + }, + "OverlapTokens": { + "description": "The number of tokens to repeat across chunks in the same layer.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "LevelConfigurations", + "OverlapTokens" + ], + "type": "object" + }, + "HierarchicalChunkingLevelConfiguration": { + "additionalProperties": false, + "description": "Token settings for a layer in a hierarchical chunking configuration.", + "properties": { + "MaxTokens": { + "description": "The maximum number of tokens that a chunk can contain in this layer.", + "maximum": 8192, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxTokens" + ], + "type": "object" + }, + "IntermediateStorage": { + "additionalProperties": false, + "description": "A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.", + "properties": { + "S3Location": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "S3Location" + ], + "type": "object" + }, + "ParsingConfiguration": { + "additionalProperties": false, + "description": "Settings for parsing document contents", + "properties": { + "BedrockFoundationModelConfiguration": { + "$ref": "#/definitions/BedrockFoundationModelConfiguration" + }, + "ParsingStrategy": { + "$ref": "#/definitions/ParsingStrategy" + } + }, + "required": [ + "ParsingStrategy" + ], + "type": "object" + }, + "ParsingPrompt": { + "additionalProperties": false, + "description": "Instructions for interpreting the contents of a document.", + "properties": { + "ParsingPromptText": { + "description": "Instructions for interpreting the contents of a document.", + "maxLength": 10000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParsingPromptText" + ], + "type": "object" + }, + "ParsingStrategy": { + "description": "The parsing strategy for the data source.", + "enum": [ + "BEDROCK_FOUNDATION_MODEL" + ], + "type": "string" + }, + "PatternObjectFilter": { + "additionalProperties": false, + "description": "The specific filters applied to your data source content. You can filter out or include certain content.", + "properties": { + "ExclusionFilters": { + "$ref": "#/definitions/FilterList" + }, + "InclusionFilters": { + "$ref": "#/definitions/FilterList" + }, + "ObjectType": { + "description": "The supported object type or content type of the data source.", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ObjectType" + ], + "type": "object" + }, + "PatternObjectFilterConfiguration": { + "additionalProperties": false, + "description": "The configuration of specific filters applied to your data source content. You can filter out or include certain content.", + "properties": { + "Filters": { + "$ref": "#/definitions/PatternObjectFilterList" + } + }, + "required": [ + "Filters" + ], + "type": "object" + }, + "PatternObjectFilterList": { + "description": "Contains information", + "items": { + "$ref": "#/definitions/PatternObjectFilter" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + }, + "S3DataSourceConfiguration": { + "additionalProperties": false, + "description": "The configuration information to connect to Amazon S3 as your data source.", + "properties": { + "BucketArn": { + "description": "The ARN of the bucket that contains the data source.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$", + "type": "string" + }, + "BucketOwnerAccountId": { + "description": "The account ID for the owner of the S3 bucket.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "InclusionPrefixes": { + "description": "A list of S3 prefixes that define the object containing the data sources.", + "insertionOrder": false, + "items": { + "description": "Prefix for s3 object.", + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "BucketArn" + ], + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "An Amazon S3 location.", + "properties": { + "URI": { + "description": "The location's URI", + "maxLength": 2048, + "minLength": 1, + "pattern": "^s3://.{1,128}$", + "type": "string" + } + }, + "required": [ + "URI" + ], + "type": "object" + }, + "SalesforceCrawlerConfiguration": { + "additionalProperties": false, + "description": "The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.", + "properties": { + "FilterConfiguration": { + "$ref": "#/definitions/CrawlFilterConfiguration" + } + }, + "type": "object" + }, + "SalesforceDataSourceConfiguration": { + "additionalProperties": false, + "description": "The configuration information to connect to Salesforce as your data source.", + "properties": { + "CrawlerConfiguration": { + "$ref": "#/definitions/SalesforceCrawlerConfiguration" + }, + "SourceConfiguration": { + "$ref": "#/definitions/SalesforceSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "SalesforceSourceConfiguration": { + "additionalProperties": false, + "description": "The endpoint information to connect to your Salesforce data source.", + "properties": { + "AuthType": { + "description": "The supported authentication type to authenticate and connect to your Salesforce instance.", + "enum": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "HostUrl": { + "description": "The Salesforce host URL or instance URL.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^https://[A-Za-z0-9][^\\s]*$", + "type": "string" + } + }, + "required": [ + "HostUrl", + "AuthType", + "CredentialsSecretArn" + ], + "type": "object" + }, + "SeedUrl": { + "additionalProperties": false, + "description": "A seed url object.", + "properties": { + "Url": { + "description": "A web url.", + "pattern": "^https?://[A-Za-z0-9][^\\s]*$", + "type": "string" + } + }, + "required": [ + "Url" + ], + "type": "object" + }, + "SeedUrls": { + "description": "A list of web urls.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SeedUrl" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "SemanticChunkingConfiguration": { + "additionalProperties": false, + "description": "Configurations for when you choose semantic chunking. If you set the chunkingStrategy as NONE, exclude this field.", + "properties": { + "BreakpointPercentileThreshold": { + "description": "The dissimilarity threshold for splitting chunks.", + "maximum": 99, + "minimum": 50, + "type": "integer" + }, + "BufferSize": { + "description": "The buffer size.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "MaxTokens": { + "description": "The maximum number of tokens that a chunk can contain.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "BreakpointPercentileThreshold", + "BufferSize", + "MaxTokens" + ], + "type": "object" + }, + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "description": "Contains details about the server-side encryption for the data source.", + "properties": { + "KmsKeyArn": { + "description": "The ARN of the AWS KMS key used to encrypt the resource.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + } + }, + "type": "object" + }, + "SharePointCrawlerConfiguration": { + "additionalProperties": false, + "description": "The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.", + "properties": { + "FilterConfiguration": { + "$ref": "#/definitions/CrawlFilterConfiguration" + } + }, + "type": "object" + }, + "SharePointDataSourceConfiguration": { + "additionalProperties": false, + "description": "The configuration information to connect to SharePoint as your data source.", + "properties": { + "CrawlerConfiguration": { + "$ref": "#/definitions/SharePointCrawlerConfiguration" + }, + "SourceConfiguration": { + "$ref": "#/definitions/SharePointSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "SharePointSourceConfiguration": { + "additionalProperties": false, + "description": "The endpoint information to connect to your SharePoint data source.", + "properties": { + "AuthType": { + "description": "The supported authentication type to authenticate and connect to your SharePoint site/sites.", + "enum": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "Domain": { + "description": "The domain of your SharePoint instance or site URL/URLs.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "HostType": { + "description": "The supported host type, whether online/cloud or server/on-premises.", + "enum": [ + "ONLINE" + ], + "type": "string" + }, + "SiteUrls": { + "description": "A list of one or more SharePoint site URLs.", + "insertionOrder": false, + "items": { + "description": "A forced-HTTPS web url.", + "pattern": "^https://[A-Za-z0-9][^\\s]*$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "TenantId": { + "description": "The identifier of your Microsoft 365 tenant.", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + } + }, + "required": [ + "Domain", + "SiteUrls", + "HostType", + "AuthType", + "CredentialsSecretArn" + ], + "type": "object" + }, + "Transformation": { + "additionalProperties": false, + "description": "A Lambda function that processes documents.", + "properties": { + "StepToApply": { + "description": "When the service applies the transformation.", + "enum": [ + "POST_CHUNKING" + ], + "type": "string" + }, + "TransformationFunction": { + "$ref": "#/definitions/TransformationFunction" + } + }, + "required": [ + "StepToApply", + "TransformationFunction" + ], + "type": "object" + }, + "TransformationFunction": { + "additionalProperties": false, + "description": "A Lambda function that processes documents.", + "properties": { + "TransformationLambdaConfiguration": { + "$ref": "#/definitions/TransformationLambdaConfiguration" + } + }, + "required": [ + "TransformationLambdaConfiguration" + ], + "type": "object" + }, + "TransformationLambdaConfiguration": { + "additionalProperties": false, + "description": "A Lambda function that processes documents.", + "properties": { + "LambdaArn": { + "description": "The function's ARN identifier.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "LambdaArn" + ], + "type": "object" + }, + "UrlConfiguration": { + "additionalProperties": false, + "description": "A url configuration.", + "properties": { + "SeedUrls": { + "$ref": "#/definitions/SeedUrls" + } + }, + "required": [ + "SeedUrls" + ], + "type": "object" + }, + "VectorIngestionConfiguration": { + "additionalProperties": false, + "description": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.", + "properties": { + "ChunkingConfiguration": { + "$ref": "#/definitions/ChunkingConfiguration" + }, + "CustomTransformationConfiguration": { + "$ref": "#/definitions/CustomTransformationConfiguration" + }, + "ParsingConfiguration": { + "$ref": "#/definitions/ParsingConfiguration" + } + }, + "type": "object" + }, + "WebCrawlerConfiguration": { + "additionalProperties": false, + "description": "Configuration for the web crawler.", + "properties": { + "CrawlerLimits": { + "$ref": "#/definitions/WebCrawlerLimits" + }, + "ExclusionFilters": { + "$ref": "#/definitions/FilterList" + }, + "InclusionFilters": { + "$ref": "#/definitions/FilterList" + }, + "Scope": { + "$ref": "#/definitions/WebScopeType" + } + }, + "type": "object" + }, + "WebCrawlerLimits": { + "additionalProperties": false, + "description": "Limit settings for the web crawler.", + "properties": { + "RateLimit": { + "description": "Rate of web URLs retrieved per minute.", + "maximum": 300, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "WebDataSourceConfiguration": { + "additionalProperties": false, + "description": "Configures a web data source location.", + "properties": { + "CrawlerConfiguration": { + "$ref": "#/definitions/WebCrawlerConfiguration" + }, + "SourceConfiguration": { + "$ref": "#/definitions/WebSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "WebScopeType": { + "description": "The scope that a web crawl job will be restricted to.", + "enum": [ + "HOST_ONLY", + "SUBDOMAINS" + ], + "type": "string" + }, + "WebSourceConfiguration": { + "additionalProperties": false, + "description": "A web source configuration.", + "properties": { + "UrlConfiguration": { + "$ref": "#/definitions/UrlConfiguration" + } + }, + "required": [ + "UrlConfiguration" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::DataSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateDataSource", + "bedrock:GetDataSource", + "bedrock:GetKnowledgeBase" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetDataSource", + "bedrock:DeleteDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "KnowledgeBaseId": { + "$ref": "resource-schema.json#/properties/KnowledgeBaseId" + } + }, + "required": [ + "KnowledgeBaseId" + ] + }, + "permissions": [ + "bedrock:ListDataSources" + ] + }, + "read": { + "permissions": [ + "bedrock:GetDataSource" + ] + }, + "update": { + "permissions": [ + "bedrock:GetDataSource", + "bedrock:UpdateDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/KnowledgeBaseId", + "/properties/DataSourceId" + ], + "properties": { + "CreatedAt": { + "description": "The time at which the data source was created.", + "type": "string" + }, + "DataDeletionPolicy": { + "$ref": "#/definitions/DataDeletionPolicy" + }, + "DataSourceConfiguration": { + "$ref": "#/definitions/DataSourceConfiguration" + }, + "DataSourceId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "DataSourceStatus": { + "$ref": "#/definitions/DataSourceStatus" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "The details of the failure reasons related to the data source.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "KnowledgeBaseId": { + "description": "The unique identifier of the knowledge base to which to add the data source.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "The name of the data source.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration" + }, + "UpdatedAt": { + "description": "The time at which the knowledge base was last updated.", + "type": "string" + }, + "VectorIngestionConfiguration": { + "$ref": "#/definitions/VectorIngestionConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/DataSourceId", + "/properties/DataSourceStatus", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/FailureReasons" + ], + "required": [ + "DataSourceConfiguration", + "Name", + "KnowledgeBaseId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", + "tagging": { + "cloudFormationSystemTags": false, + "taggable": false + }, + "typeName": "AWS::Bedrock::DataSource" +} diff --git a/schema/aws-bedrock-flow.json b/schema/aws-bedrock-flow.json index ef77f1d..77d3687 100644 --- a/schema/aws-bedrock-flow.json +++ b/schema/aws-bedrock-flow.json @@ -1,909 +1,1117 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ] - ], - "additionalProperties": false, - "definitions": { - "ConditionFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Condition flow node configuration", - "properties": { - "Conditions": { - "description": "List of conditions in a condition node", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowCondition" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Conditions" - ], - "type": "object" - }, - "DefinitionSubstitutions": { - "additionalProperties": false, - "description": "When supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map", - "maxProperties": 500, - "minProperties": 1, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "boolean" - } - ] - } - }, - "type": "object" - }, - "FlowCondition": { - "additionalProperties": false, - "description": "Condition branch for a condition node", - "properties": { - "Expression": { - "description": "Expression for a condition in a flow", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of a condition in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "FlowConditionalConnectionConfiguration": { - "additionalProperties": false, - "description": "Conditional connection configuration", - "properties": { - "Condition": { - "description": "Name of a condition in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "Condition" - ], - "type": "object" - }, - "FlowConnection": { - "additionalProperties": false, - "description": "Flow connection", - "properties": { - "Configuration": { - "$ref": "#/definitions/FlowConnectionConfiguration" - }, - "Name": { - "description": "Name of a connection in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$", - "type": "string" - }, - "Source": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Target": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowConnectionType" - } - }, - "required": [ - "Name", - "Source", - "Target", - "Type" - ], - "type": "object" - }, - "FlowConnectionConfiguration": { - "description": "Connection configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Data": { - "$ref": "#/definitions/FlowDataConnectionConfiguration" - } - }, - "required": [ - "Data" - ], - "title": "Data", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Conditional": { - "$ref": "#/definitions/FlowConditionalConnectionConfiguration" - } - }, - "required": [ - "Conditional" - ], - "title": "Conditional", - "type": "object" - } - ] - }, - "FlowConnectionType": { - "description": "Connection type", - "enum": [ - "Data", - "Conditional" - ], - "type": "string" - }, - "FlowDataConnectionConfiguration": { - "additionalProperties": false, - "description": "Data connection configuration", - "properties": { - "SourceOutput": { - "description": "Name of a node output in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "TargetInput": { - "description": "Name of a node input in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "SourceOutput", - "TargetInput" - ], - "type": "object" - }, - "FlowDefinition": { - "additionalProperties": false, - "description": "Flow definition", - "properties": { - "Connections": { - "description": "List of connections", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowConnection" - }, - "maxItems": 20, - "type": "array" - }, - "Nodes": { - "description": "List of nodes in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNode" - }, - "maxItems": 20, - "type": "array" - } - }, - "type": "object" - }, - "FlowNode": { - "additionalProperties": false, - "description": "Internal mixin for flow node", - "properties": { - "Configuration": { - "$ref": "#/definitions/FlowNodeConfiguration" - }, - "Inputs": { - "description": "List of node inputs in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNodeInput" - }, - "maxItems": 5, - "type": "array" - }, - "Name": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Outputs": { - "description": "List of node outputs in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNodeOutput" - }, - "maxItems": 5, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/FlowNodeType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeConfiguration": { - "description": "Node configuration in a flow", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Input": { - "$ref": "#/definitions/InputFlowNodeConfiguration" - } - }, - "required": [ - "Input" - ], - "title": "Input", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Output": { - "$ref": "#/definitions/OutputFlowNodeConfiguration" - } - }, - "required": [ - "Output" - ], - "title": "Output", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "KnowledgeBase": { - "$ref": "#/definitions/KnowledgeBaseFlowNodeConfiguration" - } - }, - "required": [ - "KnowledgeBase" - ], - "title": "KnowledgeBase", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Condition": { - "$ref": "#/definitions/ConditionFlowNodeConfiguration" - } - }, - "required": [ - "Condition" - ], - "title": "Condition", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Lex": { - "$ref": "#/definitions/LexFlowNodeConfiguration" - } - }, - "required": [ - "Lex" - ], - "title": "Lex", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Prompt": { - "$ref": "#/definitions/PromptFlowNodeConfiguration" - } - }, - "required": [ - "Prompt" - ], - "title": "Prompt", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "LambdaFunction": { - "$ref": "#/definitions/LambdaFunctionFlowNodeConfiguration" - } - }, - "required": [ - "LambdaFunction" - ], - "title": "LambdaFunction", - "type": "object" - } - ] - }, - "FlowNodeIODataType": { - "description": "Type of input/output for a node in a flow", - "enum": [ - "String", - "Number", - "Boolean", - "Object", - "Array" - ], - "type": "string" - }, - "FlowNodeInput": { - "additionalProperties": false, - "description": "Input to a node in a flow", - "properties": { - "Expression": { - "description": "Expression for a node input in a flow", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of a node input in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowNodeIODataType" - } - }, - "required": [ - "Expression", - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeOutput": { - "additionalProperties": false, - "description": "Output of a node in a flow", - "properties": { - "Name": { - "description": "Name of a node output in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowNodeIODataType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeType": { - "description": "Flow node types", - "enum": [ - "Input", - "Output", - "KnowledgeBase", - "Condition", - "Lex", - "Prompt", - "LambdaFunction" - ], - "type": "string" - }, - "FlowStatus": { - "description": "Schema Type for Flow APIs", - "enum": [ - "Failed", - "Prepared", - "Preparing", - "NotPrepared" - ], - "type": "string" - }, - "InputFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Input flow node configuration", - "type": "object" - }, - "KnowledgeBaseFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Knowledge base flow node configuration", - "properties": { - "KnowledgeBaseId": { - "description": "Identifier of the KnowledgeBase", - "maxLength": 10, - "pattern": "^[0-9a-zA-Z]+$", - "type": "string" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - } - }, - "required": [ - "KnowledgeBaseId" - ], - "type": "object" - }, - "LambdaFunctionFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Lambda function flow node configuration", - "properties": { - "LambdaArn": { - "description": "ARN of a Lambda.", - "maxLength": 2048, - "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "LambdaArn" - ], - "type": "object" - }, - "LexFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Lex flow node configuration", - "properties": { - "BotAliasArn": { - "description": "ARN of a Lex bot alias", - "maxLength": 78, - "pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$", - "type": "string" - }, - "LocaleId": { - "description": "Lex bot locale id", - "maxLength": 10, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "BotAliasArn", - "LocaleId" - ], - "type": "object" - }, - "OutputFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Output flow node configuration", - "type": "object" - }, - "PromptFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Prompt flow node configuration", - "properties": { - "SourceConfiguration": { - "$ref": "#/definitions/PromptFlowNodeSourceConfiguration" - } - }, - "required": [ - "SourceConfiguration" - ], - "type": "object" - }, - "PromptFlowNodeInlineConfiguration": { - "additionalProperties": false, - "description": "Inline prompt configuration for prompt node", - "properties": { - "InferenceConfiguration": { - "$ref": "#/definitions/PromptInferenceConfiguration" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/PromptTemplateConfiguration" - }, - "TemplateType": { - "$ref": "#/definitions/PromptTemplateType" - } - }, - "required": [ - "ModelId", - "TemplateConfiguration", - "TemplateType" - ], - "type": "object" - }, - "PromptFlowNodeResourceConfiguration": { - "additionalProperties": false, - "description": "Resource prompt configuration for prompt node", - "properties": { - "PromptArn": { - "description": "ARN of a prompt resource possibly with a version", - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$", - "type": "string" - } - }, - "required": [ - "PromptArn" - ], - "type": "object" - }, - "PromptFlowNodeSourceConfiguration": { - "description": "Prompt source configuration for prompt node", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Resource": { - "$ref": "#/definitions/PromptFlowNodeResourceConfiguration" - } - }, - "required": [ - "Resource" - ], - "title": "Resource", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Inline": { - "$ref": "#/definitions/PromptFlowNodeInlineConfiguration" - } - }, - "required": [ - "Inline" - ], - "title": "Inline", - "type": "object" - } - ] - }, - "PromptInferenceConfiguration": { - "description": "Model inference configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/PromptModelInferenceConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptInputVariable": { - "additionalProperties": false, - "description": "Input variable", - "properties": { - "Name": { - "description": "Name for an input variable", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - } - }, - "type": "object" - }, - "PromptModelInferenceConfiguration": { - "additionalProperties": false, - "description": "Prompt model inference configuration", - "properties": { - "MaxTokens": { - "description": "Maximum length of output", - "maximum": 4096, - "minimum": 0, - "type": "number" - }, - "StopSequences": { - "description": "List of stop sequences", - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array" - }, - "Temperature": { - "description": "Controls randomness, higher values increase diversity", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "TopK": { - "description": "Sample from the k most likely next tokens", - "maximum": 500, - "minimum": 0, - "type": "number" - }, - "TopP": { - "description": "Cumulative probability cutoff for token selection", - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PromptTemplateConfiguration": { - "description": "Prompt template configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/TextPromptTemplateConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptTemplateType": { - "description": "Prompt template type", - "enum": [ - "TEXT" - ], - "type": "string" - }, - "S3Location": { - "additionalProperties": false, - "description": "A bucket, key and optional version pointing to an S3 object containing a UTF-8 encoded JSON string Definition with the same schema as the Definition property of this resource", - "properties": { - "Bucket": { - "description": "A bucket in S3", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "Key": { - "description": "A object key in S3", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Version": { - "description": "The version of the the S3 object to use", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - }, - "TextPromptTemplateConfiguration": { - "additionalProperties": false, - "description": "Configuration for text prompt template", - "properties": { - "InputVariables": { - "description": "List of input variables", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptInputVariable" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Text": { - "description": "Prompt content for String prompt template", - "maxLength": 200000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Text" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::Flow Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateFlow", - "bedrock:GetFlow", - "bedrock:PrepareFlow", - "iam:PassRole", - "s3:GetObject", - "s3:GetObjectVersion", - "bedrock:TagResource", - "bedrock:ListTagsForResource", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteFlow", - "bedrock:GetFlow" - ] - }, - "list": { - "permissions": [ - "bedrock:ListFlows" - ] - }, - "read": { - "permissions": [ - "bedrock:GetFlow", - "bedrock:ListTagsForResource", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "bedrock:UpdateFlow", - "bedrock:GetFlow", - "bedrock:PrepareFlow", - "iam:PassRole", - "s3:GetObject", - "s3:GetObjectVersion", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Arn representation of the Flow", - "maxLength": 1011, - "minLength": 20, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "CustomerEncryptionKeyArn": { - "description": "A KMS key ARN", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/FlowDefinition" - }, - "DefinitionS3Location": { - "$ref": "#/definitions/S3Location" - }, - "DefinitionString": { - "description": "A JSON string containing a Definition with the same schema as the Definition property of this resource", - "maxLength": 512000, - "type": "string" - }, - "DefinitionSubstitutions": { - "$ref": "#/definitions/DefinitionSubstitutions" - }, - "Description": { - "description": "Description of the flow", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "ExecutionRoleArn": { - "description": "ARN of a IAM role", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$", - "type": "string" - }, - "Id": { - "description": "Identifier for a Flow", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Name": { - "description": "Name for the flow", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/FlowStatus" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "TestAliasTags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "Version": { - "description": "Draft Version.", - "maxLength": 5, - "minLength": 5, - "pattern": "^DRAFT$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/Status", - "/properties/UpdatedAt", - "/properties/Version" - ], - "required": [ - "ExecutionRoleArn", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::Flow", - "writeOnlyProperties": [ - "/properties/DefinitionString", - "/properties/DefinitionS3Location", - "/properties/DefinitionSubstitutions" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ] + ], + "additionalProperties": false, + "definitions": { + "AgentFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Agent flow node configuration", + "properties": { + "AgentAliasArn": { + "description": "Arn representation of the Agent Alias.", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$", + "type": "string" + } + }, + "required": [ + "AgentAliasArn" + ], + "type": "object" + }, + "CollectorFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Collector flow node configuration", + "type": "object" + }, + "ConditionFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Condition flow node configuration", + "properties": { + "Conditions": { + "description": "List of conditions in a condition node", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowCondition" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Conditions" + ], + "type": "object" + }, + "DefinitionSubstitutions": { + "additionalProperties": false, + "description": "When supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map", + "maxProperties": 500, + "minProperties": 1, + "patternProperties": { + "^[a-zA-Z0-9]+$": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "boolean" + } + ] + } + }, + "type": "object" + }, + "FlowCondition": { + "additionalProperties": false, + "description": "Condition branch for a condition node", + "properties": { + "Expression": { + "description": "Expression for a condition in a flow", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of a condition in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "FlowConditionalConnectionConfiguration": { + "additionalProperties": false, + "description": "Conditional connection configuration", + "properties": { + "Condition": { + "description": "Name of a condition in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "Condition" + ], + "type": "object" + }, + "FlowConnection": { + "additionalProperties": false, + "description": "Flow connection", + "properties": { + "Configuration": { + "$ref": "#/definitions/FlowConnectionConfiguration" + }, + "Name": { + "description": "Name of a connection in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$", + "type": "string" + }, + "Source": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Target": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowConnectionType" + } + }, + "required": [ + "Name", + "Source", + "Target", + "Type" + ], + "type": "object" + }, + "FlowConnectionConfiguration": { + "description": "Connection configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Data": { + "$ref": "#/definitions/FlowDataConnectionConfiguration" + } + }, + "required": [ + "Data" + ], + "title": "Data", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Conditional": { + "$ref": "#/definitions/FlowConditionalConnectionConfiguration" + } + }, + "required": [ + "Conditional" + ], + "title": "Conditional", + "type": "object" + } + ] + }, + "FlowConnectionType": { + "description": "Connection type", + "enum": [ + "Data", + "Conditional" + ], + "type": "string" + }, + "FlowDataConnectionConfiguration": { + "additionalProperties": false, + "description": "Data connection configuration", + "properties": { + "SourceOutput": { + "description": "Name of a node output in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "TargetInput": { + "description": "Name of a node input in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "SourceOutput", + "TargetInput" + ], + "type": "object" + }, + "FlowDefinition": { + "additionalProperties": false, + "description": "Flow definition", + "properties": { + "Connections": { + "description": "List of connections", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowConnection" + }, + "maxItems": 20, + "type": "array" + }, + "Nodes": { + "description": "List of nodes in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNode" + }, + "maxItems": 20, + "type": "array" + } + }, + "type": "object" + }, + "FlowNode": { + "additionalProperties": false, + "description": "Internal mixin for flow node", + "properties": { + "Configuration": { + "$ref": "#/definitions/FlowNodeConfiguration" + }, + "Inputs": { + "description": "List of node inputs in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNodeInput" + }, + "maxItems": 5, + "type": "array" + }, + "Name": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Outputs": { + "description": "List of node outputs in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNodeOutput" + }, + "maxItems": 5, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/FlowNodeType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeConfiguration": { + "description": "Node configuration in a flow", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Input": { + "$ref": "#/definitions/InputFlowNodeConfiguration" + } + }, + "required": [ + "Input" + ], + "title": "Input", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Output": { + "$ref": "#/definitions/OutputFlowNodeConfiguration" + } + }, + "required": [ + "Output" + ], + "title": "Output", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "KnowledgeBase": { + "$ref": "#/definitions/KnowledgeBaseFlowNodeConfiguration" + } + }, + "required": [ + "KnowledgeBase" + ], + "title": "KnowledgeBase", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Condition": { + "$ref": "#/definitions/ConditionFlowNodeConfiguration" + } + }, + "required": [ + "Condition" + ], + "title": "Condition", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Lex": { + "$ref": "#/definitions/LexFlowNodeConfiguration" + } + }, + "required": [ + "Lex" + ], + "title": "Lex", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Prompt": { + "$ref": "#/definitions/PromptFlowNodeConfiguration" + } + }, + "required": [ + "Prompt" + ], + "title": "Prompt", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "LambdaFunction": { + "$ref": "#/definitions/LambdaFunctionFlowNodeConfiguration" + } + }, + "required": [ + "LambdaFunction" + ], + "title": "LambdaFunction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Agent": { + "$ref": "#/definitions/AgentFlowNodeConfiguration" + } + }, + "required": [ + "Agent" + ], + "title": "Agent", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Storage": { + "$ref": "#/definitions/StorageFlowNodeConfiguration" + } + }, + "required": [ + "Storage" + ], + "title": "Storage", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Iterator": { + "$ref": "#/definitions/IteratorFlowNodeConfiguration" + } + }, + "required": [ + "Iterator" + ], + "title": "Iterator", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Collector": { + "$ref": "#/definitions/CollectorFlowNodeConfiguration" + } + }, + "required": [ + "Collector" + ], + "title": "Collector", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Retrieval": { + "$ref": "#/definitions/RetrievalFlowNodeConfiguration" + } + }, + "required": [ + "Retrieval" + ], + "title": "Retrieval", + "type": "object" + } + ] + }, + "FlowNodeIODataType": { + "description": "Type of input/output for a node in a flow", + "enum": [ + "String", + "Number", + "Boolean", + "Object", + "Array" + ], + "type": "string" + }, + "FlowNodeInput": { + "additionalProperties": false, + "description": "Input to a node in a flow", + "properties": { + "Expression": { + "description": "Expression for a node input in a flow", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of a node input in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowNodeIODataType" + } + }, + "required": [ + "Expression", + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeOutput": { + "additionalProperties": false, + "description": "Output of a node in a flow", + "properties": { + "Name": { + "description": "Name of a node output in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowNodeIODataType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeType": { + "description": "Flow node types", + "enum": [ + "Input", + "Output", + "KnowledgeBase", + "Condition", + "Lex", + "Prompt", + "LambdaFunction", + "Agent", + "Storage", + "Retrieval", + "Iterator", + "Collector" + ], + "type": "string" + }, + "FlowStatus": { + "description": "Schema Type for Flow APIs", + "enum": [ + "Failed", + "Prepared", + "Preparing", + "NotPrepared" + ], + "type": "string" + }, + "FlowValidation": { + "additionalProperties": false, + "description": "Validation for Flow", + "properties": { + "Message": { + "description": "validation message", + "type": "string" + } + }, + "required": [ + "Message" + ], + "type": "object" + }, + "FlowValidations": { + "description": "List of flow validations", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FlowValidation" + }, + "type": "array" + }, + "InputFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Input flow node configuration", + "type": "object" + }, + "IteratorFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Iterator flow node configuration", + "type": "object" + }, + "KnowledgeBaseFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Knowledge base flow node configuration", + "properties": { + "KnowledgeBaseId": { + "description": "Identifier of the KnowledgeBase", + "maxLength": 10, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + } + }, + "required": [ + "KnowledgeBaseId" + ], + "type": "object" + }, + "LambdaFunctionFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Lambda function flow node configuration", + "properties": { + "LambdaArn": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "LambdaArn" + ], + "type": "object" + }, + "LexFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Lex flow node configuration", + "properties": { + "BotAliasArn": { + "description": "ARN of a Lex bot alias", + "maxLength": 78, + "pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$", + "type": "string" + }, + "LocaleId": { + "description": "Lex bot locale id", + "maxLength": 10, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "BotAliasArn", + "LocaleId" + ], + "type": "object" + }, + "OutputFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Output flow node configuration", + "type": "object" + }, + "PromptFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Prompt flow node configuration", + "properties": { + "SourceConfiguration": { + "$ref": "#/definitions/PromptFlowNodeSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "PromptFlowNodeInlineConfiguration": { + "additionalProperties": false, + "description": "Inline prompt configuration for prompt node", + "properties": { + "InferenceConfiguration": { + "$ref": "#/definitions/PromptInferenceConfiguration" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/PromptTemplateConfiguration" + }, + "TemplateType": { + "$ref": "#/definitions/PromptTemplateType" + } + }, + "required": [ + "ModelId", + "TemplateConfiguration", + "TemplateType" + ], + "type": "object" + }, + "PromptFlowNodeResourceConfiguration": { + "additionalProperties": false, + "description": "Resource prompt configuration for prompt node", + "properties": { + "PromptArn": { + "description": "ARN of a prompt resource possibly with a version", + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$", + "type": "string" + } + }, + "required": [ + "PromptArn" + ], + "type": "object" + }, + "PromptFlowNodeSourceConfiguration": { + "description": "Prompt source configuration for prompt node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Resource": { + "$ref": "#/definitions/PromptFlowNodeResourceConfiguration" + } + }, + "required": [ + "Resource" + ], + "title": "Resource", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Inline": { + "$ref": "#/definitions/PromptFlowNodeInlineConfiguration" + } + }, + "required": [ + "Inline" + ], + "title": "Inline", + "type": "object" + } + ] + }, + "PromptInferenceConfiguration": { + "description": "Model inference configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/PromptModelInferenceConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptInputVariable": { + "additionalProperties": false, + "description": "Input variable", + "properties": { + "Name": { + "description": "Name for an input variable", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + } + }, + "type": "object" + }, + "PromptModelInferenceConfiguration": { + "additionalProperties": false, + "description": "Prompt model inference configuration", + "properties": { + "MaxTokens": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PromptTemplateConfiguration": { + "description": "Prompt template configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/TextPromptTemplateConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptTemplateType": { + "description": "Prompt template type", + "enum": [ + "TEXT" + ], + "type": "string" + }, + "RetrievalFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Retrieval flow node configuration", + "properties": { + "ServiceConfiguration": { + "$ref": "#/definitions/RetrievalFlowNodeServiceConfiguration" + } + }, + "required": [ + "ServiceConfiguration" + ], + "type": "object" + }, + "RetrievalFlowNodeS3Configuration": { + "additionalProperties": false, + "description": "s3 Retrieval configuration for Retrieval node", + "properties": { + "BucketName": { + "description": "bucket name of an s3 that will be used for Retrieval flow node configuration", + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "RetrievalFlowNodeServiceConfiguration": { + "description": "Retrieval service configuration for Retrieval node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/RetrievalFlowNodeS3Configuration" + } + }, + "title": "S3", + "type": "object" + } + ] + }, + "S3Location": { + "additionalProperties": false, + "description": "A bucket, key and optional version pointing to an S3 object containing a UTF-8 encoded JSON string Definition with the same schema as the Definition property of this resource", + "properties": { + "Bucket": { + "description": "A bucket in S3", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "Key": { + "description": "A object key in S3", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Version": { + "description": "The version of the the S3 object to use", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "StorageFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Storage flow node configuration", + "properties": { + "ServiceConfiguration": { + "$ref": "#/definitions/StorageFlowNodeServiceConfiguration" + } + }, + "required": [ + "ServiceConfiguration" + ], + "type": "object" + }, + "StorageFlowNodeS3Configuration": { + "additionalProperties": false, + "description": "s3 storage configuration for storage node", + "properties": { + "BucketName": { + "description": "bucket name of an s3 that will be used for storage flow node configuration", + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "StorageFlowNodeServiceConfiguration": { + "description": "storage service configuration for storage node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/StorageFlowNodeS3Configuration" + } + }, + "title": "S3", + "type": "object" + } + ] + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "TextPromptTemplateConfiguration": { + "additionalProperties": false, + "description": "Configuration for text prompt template", + "properties": { + "InputVariables": { + "description": "List of input variables", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptInputVariable" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Text": { + "description": "Prompt content for String prompt template", + "maxLength": 200000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::Flow Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateFlow", + "bedrock:GetFlow", + "bedrock:PrepareFlow", + "iam:PassRole", + "s3:GetObject", + "s3:GetObjectVersion", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteFlow", + "bedrock:GetFlow" + ] + }, + "list": { + "permissions": [ + "bedrock:ListFlows" + ] + }, + "read": { + "permissions": [ + "bedrock:GetFlow", + "bedrock:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "bedrock:UpdateFlow", + "bedrock:GetFlow", + "bedrock:PrepareFlow", + "iam:PassRole", + "s3:GetObject", + "s3:GetObjectVersion", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Arn representation of the Flow", + "maxLength": 1011, + "minLength": 20, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/FlowDefinition" + }, + "DefinitionS3Location": { + "$ref": "#/definitions/S3Location" + }, + "DefinitionString": { + "description": "A JSON string containing a Definition with the same schema as the Definition property of this resource", + "maxLength": 512000, + "type": "string" + }, + "DefinitionSubstitutions": { + "$ref": "#/definitions/DefinitionSubstitutions" + }, + "Description": { + "description": "Description of the flow", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "ExecutionRoleArn": { + "description": "ARN of a IAM role", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$", + "type": "string" + }, + "Id": { + "description": "Identifier for a Flow", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "Name for the flow", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/FlowStatus" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "TestAliasTags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "Validations": { + "$ref": "#/definitions/FlowValidations" + }, + "Version": { + "description": "Draft Version.", + "maxLength": 5, + "minLength": 5, + "pattern": "^DRAFT$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/Status", + "/properties/UpdatedAt", + "/properties/Version", + "/properties/Validations" + ], + "required": [ + "ExecutionRoleArn", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Flow", + "writeOnlyProperties": [ + "/properties/DefinitionString", + "/properties/DefinitionS3Location", + "/properties/DefinitionSubstitutions" + ] +} diff --git a/schema/aws-bedrock-flowalias.json b/schema/aws-bedrock-flowalias.json index c8f4747..f30b9e7 100644 --- a/schema/aws-bedrock-flowalias.json +++ b/schema/aws-bedrock-flowalias.json @@ -1,172 +1,172 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FlowArn" - ], - "definitions": { - "FlowAliasRoutingConfigurationListItem": { - "additionalProperties": false, - "description": "Details about the routing configuration for a Flow alias.", - "properties": { - "FlowVersion": { - "description": "Version.", - "maxLength": 1, - "minLength": 1, - "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", - "type": "string" - } - }, - "type": "object" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::FlowAlias Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateFlowAlias", - "bedrock:GetFlowAlias", - "bedrock:TagResource", - "bedrock:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteFlowAlias" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FlowArn": { - "$ref": "resource-schema.json#/properties/FlowArn" - } - }, - "required": [ - "FlowArn" - ] - }, - "permissions": [ - "bedrock:ListFlowAliases" - ] - }, - "read": { - "permissions": [ - "bedrock:GetFlowAlias", - "bedrock:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "bedrock:UpdateFlowAlias", - "bedrock:GetFlowAlias", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn", - "/properties/FlowArn" - ], - "properties": { - "Arn": { - "description": "Arn of the Flow Alias", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FlowArn": { - "description": "Arn representation of the Flow", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "FlowId": { - "description": "Identifier for a flow resource.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Id": { - "description": "Id for a Flow Alias generated at the server side.", - "maxLength": 10, - "minLength": 10, - "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$", - "type": "string" - }, - "Name": { - "description": "Name for a resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "RoutingConfiguration": { - "description": "Routing configuration for a Flow alias.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowAliasRoutingConfigurationListItem" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/FlowId", - "/properties/Id", - "/properties/UpdatedAt" - ], - "required": [ - "Name", - "FlowArn", - "RoutingConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::FlowAlias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FlowArn" + ], + "definitions": { + "FlowAliasRoutingConfigurationListItem": { + "additionalProperties": false, + "description": "Details about the routing configuration for a Flow alias.", + "properties": { + "FlowVersion": { + "description": "Version.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", + "type": "string" + } + }, + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::FlowAlias Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateFlowAlias", + "bedrock:GetFlowAlias", + "bedrock:TagResource", + "bedrock:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteFlowAlias" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FlowArn": { + "$ref": "resource-schema.json#/properties/FlowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "permissions": [ + "bedrock:ListFlowAliases" + ] + }, + "read": { + "permissions": [ + "bedrock:GetFlowAlias", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:UpdateFlowAlias", + "bedrock:GetFlowAlias", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn", + "/properties/FlowArn" + ], + "properties": { + "Arn": { + "description": "Arn of the Flow Alias", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FlowArn": { + "description": "Arn representation of the Flow", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "FlowId": { + "description": "Identifier for a flow resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Id": { + "description": "Id for a Flow Alias generated at the server side.", + "maxLength": 10, + "minLength": 10, + "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$", + "type": "string" + }, + "Name": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "RoutingConfiguration": { + "description": "Routing configuration for a Flow alias.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowAliasRoutingConfigurationListItem" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/FlowId", + "/properties/Id", + "/properties/UpdatedAt" + ], + "required": [ + "Name", + "FlowArn", + "RoutingConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::FlowAlias" +} diff --git a/schema/aws-bedrock-flowversion.json b/schema/aws-bedrock-flowversion.json index 83a33c5..9c34d8a 100644 --- a/schema/aws-bedrock-flowversion.json +++ b/schema/aws-bedrock-flowversion.json @@ -1,786 +1,979 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/FlowArn" - ], - "definitions": { - "ConditionFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Condition flow node configuration", - "properties": { - "Conditions": { - "description": "List of conditions in a condition node", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowCondition" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Conditions" - ], - "type": "object" - }, - "FlowCondition": { - "additionalProperties": false, - "description": "Condition branch for a condition node", - "properties": { - "Expression": { - "description": "Expression for a condition in a flow", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of a condition in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "FlowConditionalConnectionConfiguration": { - "additionalProperties": false, - "description": "Conditional connection configuration", - "properties": { - "Condition": { - "description": "Name of a condition in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "Condition" - ], - "type": "object" - }, - "FlowConnection": { - "additionalProperties": false, - "description": "Flow connection", - "properties": { - "Configuration": { - "$ref": "#/definitions/FlowConnectionConfiguration" - }, - "Name": { - "description": "Name of a connection in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$", - "type": "string" - }, - "Source": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Target": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowConnectionType" - } - }, - "required": [ - "Name", - "Source", - "Target", - "Type" - ], - "type": "object" - }, - "FlowConnectionConfiguration": { - "description": "Connection configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Data": { - "$ref": "#/definitions/FlowDataConnectionConfiguration" - } - }, - "required": [ - "Data" - ], - "title": "Data", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Conditional": { - "$ref": "#/definitions/FlowConditionalConnectionConfiguration" - } - }, - "required": [ - "Conditional" - ], - "title": "Conditional", - "type": "object" - } - ] - }, - "FlowConnectionType": { - "description": "Connection type", - "enum": [ - "Data", - "Conditional" - ], - "type": "string" - }, - "FlowDataConnectionConfiguration": { - "additionalProperties": false, - "description": "Data connection configuration", - "properties": { - "SourceOutput": { - "description": "Name of a node output in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "TargetInput": { - "description": "Name of a node input in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - } - }, - "required": [ - "SourceOutput", - "TargetInput" - ], - "type": "object" - }, - "FlowDefinition": { - "additionalProperties": false, - "description": "Flow definition", - "properties": { - "Connections": { - "description": "List of connections", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowConnection" - }, - "maxItems": 20, - "type": "array" - }, - "Nodes": { - "description": "List of nodes in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNode" - }, - "maxItems": 20, - "type": "array" - } - }, - "type": "object" - }, - "FlowNode": { - "additionalProperties": false, - "description": "Internal mixin for flow node", - "properties": { - "Configuration": { - "$ref": "#/definitions/FlowNodeConfiguration" - }, - "Inputs": { - "description": "List of node inputs in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNodeInput" - }, - "maxItems": 5, - "type": "array" - }, - "Name": { - "description": "Name of a node in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Outputs": { - "description": "List of node outputs in a flow", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FlowNodeOutput" - }, - "maxItems": 5, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/FlowNodeType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeConfiguration": { - "description": "Node configuration in a flow", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Input": { - "$ref": "#/definitions/InputFlowNodeConfiguration" - } - }, - "required": [ - "Input" - ], - "title": "Input", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Output": { - "$ref": "#/definitions/OutputFlowNodeConfiguration" - } - }, - "required": [ - "Output" - ], - "title": "Output", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "KnowledgeBase": { - "$ref": "#/definitions/KnowledgeBaseFlowNodeConfiguration" - } - }, - "required": [ - "KnowledgeBase" - ], - "title": "KnowledgeBase", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Condition": { - "$ref": "#/definitions/ConditionFlowNodeConfiguration" - } - }, - "required": [ - "Condition" - ], - "title": "Condition", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Lex": { - "$ref": "#/definitions/LexFlowNodeConfiguration" - } - }, - "required": [ - "Lex" - ], - "title": "Lex", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Prompt": { - "$ref": "#/definitions/PromptFlowNodeConfiguration" - } - }, - "required": [ - "Prompt" - ], - "title": "Prompt", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "LambdaFunction": { - "$ref": "#/definitions/LambdaFunctionFlowNodeConfiguration" - } - }, - "required": [ - "LambdaFunction" - ], - "title": "LambdaFunction", - "type": "object" - } - ] - }, - "FlowNodeIODataType": { - "description": "Type of input/output for a node in a flow", - "enum": [ - "String", - "Number", - "Boolean", - "Object", - "Array" - ], - "type": "string" - }, - "FlowNodeInput": { - "additionalProperties": false, - "description": "Input to a node in a flow", - "properties": { - "Expression": { - "description": "Expression for a node input in a flow", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of a node input in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowNodeIODataType" - } - }, - "required": [ - "Expression", - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeOutput": { - "additionalProperties": false, - "description": "Output of a node in a flow", - "properties": { - "Name": { - "description": "Name of a node output in a flow", - "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FlowNodeIODataType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "FlowNodeType": { - "description": "Flow node types", - "enum": [ - "Input", - "Output", - "KnowledgeBase", - "Condition", - "Lex", - "Prompt", - "LambdaFunction" - ], - "type": "string" - }, - "FlowStatus": { - "description": "Schema Type for Flow APIs", - "enum": [ - "Failed", - "Prepared", - "Preparing", - "NotPrepared" - ], - "type": "string" - }, - "InputFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Input flow node configuration", - "type": "object" - }, - "KnowledgeBaseFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Knowledge base flow node configuration", - "properties": { - "KnowledgeBaseId": { - "description": "Identifier of the KnowledgeBase", - "maxLength": 10, - "pattern": "^[0-9a-zA-Z]+$", - "type": "string" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - } - }, - "required": [ - "KnowledgeBaseId" - ], - "type": "object" - }, - "LambdaFunctionFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Lambda function flow node configuration", - "properties": { - "LambdaArn": { - "description": "ARN of a Lambda.", - "maxLength": 2048, - "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "LambdaArn" - ], - "type": "object" - }, - "LexFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Lex flow node configuration", - "properties": { - "BotAliasArn": { - "description": "ARN of a Lex bot alias", - "maxLength": 78, - "pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$", - "type": "string" - }, - "LocaleId": { - "description": "Lex bot locale id", - "maxLength": 10, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "BotAliasArn", - "LocaleId" - ], - "type": "object" - }, - "OutputFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Output flow node configuration", - "type": "object" - }, - "PromptFlowNodeConfiguration": { - "additionalProperties": false, - "description": "Prompt flow node configuration", - "properties": { - "SourceConfiguration": { - "$ref": "#/definitions/PromptFlowNodeSourceConfiguration" - } - }, - "required": [ - "SourceConfiguration" - ], - "type": "object" - }, - "PromptFlowNodeInlineConfiguration": { - "additionalProperties": false, - "description": "Inline prompt configuration for prompt node", - "properties": { - "InferenceConfiguration": { - "$ref": "#/definitions/PromptInferenceConfiguration" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/PromptTemplateConfiguration" - }, - "TemplateType": { - "$ref": "#/definitions/PromptTemplateType" - } - }, - "required": [ - "ModelId", - "TemplateConfiguration", - "TemplateType" - ], - "type": "object" - }, - "PromptFlowNodeResourceConfiguration": { - "additionalProperties": false, - "description": "Resource prompt configuration for prompt node", - "properties": { - "PromptArn": { - "description": "ARN of a prompt resource possibly with a version", - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$", - "type": "string" - } - }, - "required": [ - "PromptArn" - ], - "type": "object" - }, - "PromptFlowNodeSourceConfiguration": { - "description": "Prompt source configuration for prompt node", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Resource": { - "$ref": "#/definitions/PromptFlowNodeResourceConfiguration" - } - }, - "required": [ - "Resource" - ], - "title": "Resource", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Inline": { - "$ref": "#/definitions/PromptFlowNodeInlineConfiguration" - } - }, - "required": [ - "Inline" - ], - "title": "Inline", - "type": "object" - } - ] - }, - "PromptInferenceConfiguration": { - "description": "Model inference configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/PromptModelInferenceConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptInputVariable": { - "additionalProperties": false, - "description": "Input variable", - "properties": { - "Name": { - "description": "Name for an input variable", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - } - }, - "type": "object" - }, - "PromptModelInferenceConfiguration": { - "additionalProperties": false, - "description": "Prompt model inference configuration", - "properties": { - "MaxTokens": { - "description": "Maximum length of output", - "maximum": 4096, - "minimum": 0, - "type": "number" - }, - "StopSequences": { - "description": "List of stop sequences", - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array" - }, - "Temperature": { - "description": "Controls randomness, higher values increase diversity", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "TopK": { - "description": "Sample from the k most likely next tokens", - "maximum": 500, - "minimum": 0, - "type": "number" - }, - "TopP": { - "description": "Cumulative probability cutoff for token selection", - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PromptTemplateConfiguration": { - "description": "Prompt template configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/TextPromptTemplateConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptTemplateType": { - "description": "Prompt template type", - "enum": [ - "TEXT" - ], - "type": "string" - }, - "TextPromptTemplateConfiguration": { - "additionalProperties": false, - "description": "Configuration for text prompt template", - "properties": { - "InputVariables": { - "description": "List of input variables", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptInputVariable" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Text": { - "description": "Prompt content for String prompt template", - "maxLength": 200000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Text" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::FlowVersion Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateFlowVersion", - "bedrock:GetFlowVersion" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteFlowVersion", - "bedrock:GetFlowVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FlowArn": { - "$ref": "resource-schema.json#/properties/FlowArn" - } - }, - "required": [ - "FlowArn" - ] - }, - "permissions": [ - "bedrock:ListFlowVersions" - ] - }, - "read": { - "permissions": [ - "bedrock:GetFlowVersion" - ] - }, - "update": { - "permissions": [ - "noservice:NoAction" - ] - } - }, - "primaryIdentifier": [ - "/properties/FlowArn", - "/properties/Version" - ], - "properties": { - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/FlowDefinition" - }, - "Description": { - "description": "Description of the flow version", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "ExecutionRoleArn": { - "description": "ARN of a IAM role", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$", - "type": "string" - }, - "FlowArn": { - "description": "Arn representation of the Flow", - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", - "type": "string" - }, - "FlowId": { - "description": "Identifier for a Flow", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Name": { - "description": "Name for the flow", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/FlowStatus" - }, - "Version": { - "description": "Numerical Version.", - "pattern": "^[0-9]{1,5}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/Definition", - "/properties/ExecutionRoleArn", - "/properties/FlowId", - "/properties/Name", - "/properties/Status", - "/properties/Version" - ], - "required": [ - "FlowArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Bedrock::FlowVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/FlowArn" + ], + "definitions": { + "AgentFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Agent flow node configuration", + "properties": { + "AgentAliasArn": { + "description": "Arn representation of the Agent Alias.", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$", + "type": "string" + } + }, + "required": [ + "AgentAliasArn" + ], + "type": "object" + }, + "CollectorFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Collector flow node configuration", + "type": "object" + }, + "ConditionFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Condition flow node configuration", + "properties": { + "Conditions": { + "description": "List of conditions in a condition node", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowCondition" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Conditions" + ], + "type": "object" + }, + "FlowCondition": { + "additionalProperties": false, + "description": "Condition branch for a condition node", + "properties": { + "Expression": { + "description": "Expression for a condition in a flow", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of a condition in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "FlowConditionalConnectionConfiguration": { + "additionalProperties": false, + "description": "Conditional connection configuration", + "properties": { + "Condition": { + "description": "Name of a condition in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "Condition" + ], + "type": "object" + }, + "FlowConnection": { + "additionalProperties": false, + "description": "Flow connection", + "properties": { + "Configuration": { + "$ref": "#/definitions/FlowConnectionConfiguration" + }, + "Name": { + "description": "Name of a connection in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$", + "type": "string" + }, + "Source": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Target": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowConnectionType" + } + }, + "required": [ + "Name", + "Source", + "Target", + "Type" + ], + "type": "object" + }, + "FlowConnectionConfiguration": { + "description": "Connection configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Data": { + "$ref": "#/definitions/FlowDataConnectionConfiguration" + } + }, + "required": [ + "Data" + ], + "title": "Data", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Conditional": { + "$ref": "#/definitions/FlowConditionalConnectionConfiguration" + } + }, + "required": [ + "Conditional" + ], + "title": "Conditional", + "type": "object" + } + ] + }, + "FlowConnectionType": { + "description": "Connection type", + "enum": [ + "Data", + "Conditional" + ], + "type": "string" + }, + "FlowDataConnectionConfiguration": { + "additionalProperties": false, + "description": "Data connection configuration", + "properties": { + "SourceOutput": { + "description": "Name of a node output in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "TargetInput": { + "description": "Name of a node input in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + } + }, + "required": [ + "SourceOutput", + "TargetInput" + ], + "type": "object" + }, + "FlowDefinition": { + "additionalProperties": false, + "description": "Flow definition", + "properties": { + "Connections": { + "description": "List of connections", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowConnection" + }, + "maxItems": 20, + "type": "array" + }, + "Nodes": { + "description": "List of nodes in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNode" + }, + "maxItems": 20, + "type": "array" + } + }, + "type": "object" + }, + "FlowNode": { + "additionalProperties": false, + "description": "Internal mixin for flow node", + "properties": { + "Configuration": { + "$ref": "#/definitions/FlowNodeConfiguration" + }, + "Inputs": { + "description": "List of node inputs in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNodeInput" + }, + "maxItems": 5, + "type": "array" + }, + "Name": { + "description": "Name of a node in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Outputs": { + "description": "List of node outputs in a flow", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FlowNodeOutput" + }, + "maxItems": 5, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/FlowNodeType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeConfiguration": { + "description": "Node configuration in a flow", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Input": { + "$ref": "#/definitions/InputFlowNodeConfiguration" + } + }, + "required": [ + "Input" + ], + "title": "Input", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Output": { + "$ref": "#/definitions/OutputFlowNodeConfiguration" + } + }, + "required": [ + "Output" + ], + "title": "Output", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "KnowledgeBase": { + "$ref": "#/definitions/KnowledgeBaseFlowNodeConfiguration" + } + }, + "required": [ + "KnowledgeBase" + ], + "title": "KnowledgeBase", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Condition": { + "$ref": "#/definitions/ConditionFlowNodeConfiguration" + } + }, + "required": [ + "Condition" + ], + "title": "Condition", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Lex": { + "$ref": "#/definitions/LexFlowNodeConfiguration" + } + }, + "required": [ + "Lex" + ], + "title": "Lex", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Prompt": { + "$ref": "#/definitions/PromptFlowNodeConfiguration" + } + }, + "required": [ + "Prompt" + ], + "title": "Prompt", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "LambdaFunction": { + "$ref": "#/definitions/LambdaFunctionFlowNodeConfiguration" + } + }, + "required": [ + "LambdaFunction" + ], + "title": "LambdaFunction", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Agent": { + "$ref": "#/definitions/AgentFlowNodeConfiguration" + } + }, + "required": [ + "Agent" + ], + "title": "Agent", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Storage": { + "$ref": "#/definitions/StorageFlowNodeConfiguration" + } + }, + "required": [ + "Storage" + ], + "title": "Storage", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Retrieval": { + "$ref": "#/definitions/RetrievalFlowNodeConfiguration" + } + }, + "required": [ + "Retrieval" + ], + "title": "Retrieval", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Iterator": { + "$ref": "#/definitions/IteratorFlowNodeConfiguration" + } + }, + "required": [ + "Iterator" + ], + "title": "Iterator", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Collector": { + "$ref": "#/definitions/CollectorFlowNodeConfiguration" + } + }, + "required": [ + "Collector" + ], + "title": "Collector", + "type": "object" + } + ] + }, + "FlowNodeIODataType": { + "description": "Type of input/output for a node in a flow", + "enum": [ + "String", + "Number", + "Boolean", + "Object", + "Array" + ], + "type": "string" + }, + "FlowNodeInput": { + "additionalProperties": false, + "description": "Input to a node in a flow", + "properties": { + "Expression": { + "description": "Expression for a node input in a flow", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of a node input in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowNodeIODataType" + } + }, + "required": [ + "Expression", + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeOutput": { + "additionalProperties": false, + "description": "Output of a node in a flow", + "properties": { + "Name": { + "description": "Name of a node output in a flow", + "pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FlowNodeIODataType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "FlowNodeType": { + "description": "Flow node types", + "enum": [ + "Input", + "Output", + "KnowledgeBase", + "Condition", + "Lex", + "Prompt", + "LambdaFunction", + "Agent", + "Iterator", + "Collector", + "Storage", + "Retrieval" + ], + "type": "string" + }, + "FlowStatus": { + "description": "Schema Type for Flow APIs", + "enum": [ + "Failed", + "Prepared", + "Preparing", + "NotPrepared" + ], + "type": "string" + }, + "InputFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Input flow node configuration", + "type": "object" + }, + "IteratorFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Iterator flow node configuration", + "type": "object" + }, + "KnowledgeBaseFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Knowledge base flow node configuration", + "properties": { + "KnowledgeBaseId": { + "description": "Identifier of the KnowledgeBase", + "maxLength": 10, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + } + }, + "required": [ + "KnowledgeBaseId" + ], + "type": "object" + }, + "LambdaFunctionFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Lambda function flow node configuration", + "properties": { + "LambdaArn": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "LambdaArn" + ], + "type": "object" + }, + "LexFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Lex flow node configuration", + "properties": { + "BotAliasArn": { + "description": "ARN of a Lex bot alias", + "maxLength": 78, + "pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$", + "type": "string" + }, + "LocaleId": { + "description": "Lex bot locale id", + "maxLength": 10, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "BotAliasArn", + "LocaleId" + ], + "type": "object" + }, + "OutputFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Output flow node configuration", + "type": "object" + }, + "PromptFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Prompt flow node configuration", + "properties": { + "SourceConfiguration": { + "$ref": "#/definitions/PromptFlowNodeSourceConfiguration" + } + }, + "required": [ + "SourceConfiguration" + ], + "type": "object" + }, + "PromptFlowNodeInlineConfiguration": { + "additionalProperties": false, + "description": "Inline prompt configuration for prompt node", + "properties": { + "InferenceConfiguration": { + "$ref": "#/definitions/PromptInferenceConfiguration" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/PromptTemplateConfiguration" + }, + "TemplateType": { + "$ref": "#/definitions/PromptTemplateType" + } + }, + "required": [ + "ModelId", + "TemplateConfiguration", + "TemplateType" + ], + "type": "object" + }, + "PromptFlowNodeResourceConfiguration": { + "additionalProperties": false, + "description": "Resource prompt configuration for prompt node", + "properties": { + "PromptArn": { + "description": "ARN of a prompt resource possibly with a version", + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$", + "type": "string" + } + }, + "required": [ + "PromptArn" + ], + "type": "object" + }, + "PromptFlowNodeSourceConfiguration": { + "description": "Prompt source configuration for prompt node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Resource": { + "$ref": "#/definitions/PromptFlowNodeResourceConfiguration" + } + }, + "required": [ + "Resource" + ], + "title": "Resource", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Inline": { + "$ref": "#/definitions/PromptFlowNodeInlineConfiguration" + } + }, + "required": [ + "Inline" + ], + "title": "Inline", + "type": "object" + } + ] + }, + "PromptInferenceConfiguration": { + "description": "Model inference configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/PromptModelInferenceConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptInputVariable": { + "additionalProperties": false, + "description": "Input variable", + "properties": { + "Name": { + "description": "Name for an input variable", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + } + }, + "type": "object" + }, + "PromptModelInferenceConfiguration": { + "additionalProperties": false, + "description": "Prompt model inference configuration", + "properties": { + "MaxTokens": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PromptTemplateConfiguration": { + "description": "Prompt template configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/TextPromptTemplateConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptTemplateType": { + "description": "Prompt template type", + "enum": [ + "TEXT" + ], + "type": "string" + }, + "RetrievalFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Retrieval flow node configuration", + "properties": { + "ServiceConfiguration": { + "$ref": "#/definitions/RetrievalFlowNodeServiceConfiguration" + } + }, + "required": [ + "ServiceConfiguration" + ], + "type": "object" + }, + "RetrievalFlowNodeS3Configuration": { + "additionalProperties": false, + "description": "s3 Retrieval configuration for Retrieval node", + "properties": { + "BucketName": { + "description": "bucket name of an s3 that will be used for Retrieval flow node configuration", + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "RetrievalFlowNodeServiceConfiguration": { + "description": "Retrieval service configuration for Retrieval node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/RetrievalFlowNodeS3Configuration" + } + }, + "title": "S3", + "type": "object" + } + ] + }, + "StorageFlowNodeConfiguration": { + "additionalProperties": false, + "description": "Storage flow node configuration", + "properties": { + "ServiceConfiguration": { + "$ref": "#/definitions/StorageFlowNodeServiceConfiguration" + } + }, + "required": [ + "ServiceConfiguration" + ], + "type": "object" + }, + "StorageFlowNodeS3Configuration": { + "additionalProperties": false, + "description": "s3 storage configuration for storage node", + "properties": { + "BucketName": { + "description": "bucket name of an s3 that will be used for storage flow node configuration", + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "StorageFlowNodeServiceConfiguration": { + "description": "storage service configuration for storage node", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/StorageFlowNodeS3Configuration" + } + }, + "title": "S3", + "type": "object" + } + ] + }, + "TextPromptTemplateConfiguration": { + "additionalProperties": false, + "description": "Configuration for text prompt template", + "properties": { + "InputVariables": { + "description": "List of input variables", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptInputVariable" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Text": { + "description": "Prompt content for String prompt template", + "maxLength": 200000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::FlowVersion Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateFlowVersion", + "bedrock:GetFlowVersion", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteFlowVersion", + "bedrock:GetFlowVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FlowArn": { + "$ref": "resource-schema.json#/properties/FlowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "permissions": [ + "bedrock:ListFlowVersions" + ] + }, + "read": { + "permissions": [ + "bedrock:GetFlowVersion", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "noservice:NoAction" + ] + } + }, + "primaryIdentifier": [ + "/properties/FlowArn", + "/properties/Version" + ], + "properties": { + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/FlowDefinition" + }, + "Description": { + "description": "Description of the flow version", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "ExecutionRoleArn": { + "description": "ARN of a IAM role", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$", + "type": "string" + }, + "FlowArn": { + "description": "Arn representation of the Flow", + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "FlowId": { + "description": "Identifier for a Flow", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "Name for the flow", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/FlowStatus" + }, + "Version": { + "description": "Numerical Version.", + "pattern": "^[0-9]{1,5}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/Definition", + "/properties/ExecutionRoleArn", + "/properties/FlowId", + "/properties/Name", + "/properties/Status", + "/properties/Version", + "/properties/CustomerEncryptionKeyArn" + ], + "required": [ + "FlowArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-flows", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Bedrock::FlowVersion" +} diff --git a/schema/aws-bedrock-guardrail.json b/schema/aws-bedrock-guardrail.json index 39196a8..f42c60a 100644 --- a/schema/aws-bedrock-guardrail.json +++ b/schema/aws-bedrock-guardrail.json @@ -1,614 +1,662 @@ -{ - "additionalProperties": false, - "definitions": { - "ContentFilter": { - "additionalProperties": false, - "description": "Content filter in content policy.", - "properties": { - "InputStrength": { - "$ref": "#/definitions/FilterStrength" - }, - "OutputStrength": { - "$ref": "#/definitions/FilterStrength" - }, - "Type": { - "$ref": "#/definitions/ContentFilterType" - } - }, - "required": [ - "InputStrength", - "OutputStrength", - "Type" - ], - "type": "object" - }, - "ContentFilterConfig": { - "additionalProperties": false, - "description": "Content filter config in content policy.", - "properties": { - "InputStrength": { - "$ref": "#/definitions/FilterStrength" - }, - "OutputStrength": { - "$ref": "#/definitions/FilterStrength" - }, - "Type": { - "$ref": "#/definitions/ContentFilterType" - } - }, - "required": [ - "InputStrength", - "OutputStrength", - "Type" - ], - "type": "object" - }, - "ContentFilterType": { - "description": "Type of filter in content policy", - "enum": [ - "SEXUAL", - "VIOLENCE", - "HATE", - "INSULTS", - "MISCONDUCT", - "PROMPT_ATTACK" - ], - "type": "string" - }, - "ContentPolicyConfig": { - "additionalProperties": false, - "description": "Content policy config for a guardrail.", - "properties": { - "FiltersConfig": { - "description": "List of content filter configs in content policy.", - "items": { - "$ref": "#/definitions/ContentFilterConfig" - }, - "maxItems": 6, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "FiltersConfig" - ], - "type": "object" - }, - "FilterStrength": { - "description": "Strength for filters", - "enum": [ - "NONE", - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - }, - "GuardrailStatus": { - "description": "Status of the guardrail", - "enum": [ - "CREATING", - "UPDATING", - "VERSIONING", - "READY", - "FAILED", - "DELETING" - ], - "type": "string" - }, - "ManagedWords": { - "additionalProperties": false, - "description": "A managed words definition.", - "properties": { - "Type": { - "$ref": "#/definitions/ManagedWordsType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ManagedWordsConfig": { - "additionalProperties": false, - "description": "A managed words config.", - "properties": { - "Type": { - "$ref": "#/definitions/ManagedWordsType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ManagedWordsType": { - "description": "Options for managed words.", - "enum": [ - "PROFANITY" - ], - "type": "string" - }, - "PiiEntity": { - "additionalProperties": false, - "description": "Entity name and behavior.", - "properties": { - "Action": { - "$ref": "#/definitions/SensitiveInformationAction" - }, - "Type": { - "$ref": "#/definitions/PiiEntityType" - } - }, - "required": [ - "Action", - "Type" - ], - "type": "object" - }, - "PiiEntityConfig": { - "additionalProperties": false, - "description": "Pii entity configuration.", - "properties": { - "Action": { - "$ref": "#/definitions/SensitiveInformationAction" - }, - "Type": { - "$ref": "#/definitions/PiiEntityType" - } - }, - "required": [ - "Action", - "Type" - ], - "type": "object" - }, - "PiiEntityType": { - "description": "The currently supported PII entities", - "enum": [ - "ADDRESS", - "AGE", - "AWS_ACCESS_KEY", - "AWS_SECRET_KEY", - "CA_HEALTH_NUMBER", - "CA_SOCIAL_INSURANCE_NUMBER", - "CREDIT_DEBIT_CARD_CVV", - "CREDIT_DEBIT_CARD_EXPIRY", - "CREDIT_DEBIT_CARD_NUMBER", - "DRIVER_ID", - "EMAIL", - "INTERNATIONAL_BANK_ACCOUNT_NUMBER", - "IP_ADDRESS", - "LICENSE_PLATE", - "MAC_ADDRESS", - "NAME", - "PASSWORD", - "PHONE", - "PIN", - "SWIFT_CODE", - "UK_NATIONAL_HEALTH_SERVICE_NUMBER", - "UK_NATIONAL_INSURANCE_NUMBER", - "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", - "URL", - "USERNAME", - "US_BANK_ACCOUNT_NUMBER", - "US_BANK_ROUTING_NUMBER", - "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", - "US_PASSPORT_NUMBER", - "US_SOCIAL_SECURITY_NUMBER", - "VEHICLE_IDENTIFICATION_NUMBER" - ], - "type": "string" - }, - "RegexConfig": { - "additionalProperties": false, - "description": "A regex configuration.", - "properties": { - "Action": { - "$ref": "#/definitions/SensitiveInformationAction" - }, - "Description": { - "description": "The regex description.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The regex name.", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Pattern": { - "description": "The regex pattern.", - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Action", - "Name", - "Pattern" - ], - "type": "object" - }, - "SensitiveInformationAction": { - "description": "Options for sensitive information action.", - "enum": [ - "BLOCK", - "ANONYMIZE" - ], - "type": "string" - }, - "SensitiveInformationPolicyConfig": { - "additionalProperties": false, - "description": "Sensitive information policy config for a guardrail.", - "properties": { - "PiiEntitiesConfig": { - "description": "List of entities.", - "items": { - "$ref": "#/definitions/PiiEntityConfig" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "RegexesConfig": { - "description": "List of regex.", - "items": { - "$ref": "#/definitions/RegexConfig" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Definition of the key/value pair for a tag", - "properties": { - "Key": { - "description": "Tag Key", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - }, - "Value": { - "description": "Tag Value", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Topic": { - "additionalProperties": false, - "description": "Topic in topic policy.", - "properties": { - "Definition": { - "description": "Definition of topic in topic policy", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "Examples": { - "description": "List of text examples", - "items": { - "description": "Text example in topic policy", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "minItems": 0, - "type": "array" - }, - "Name": { - "description": "Name of topic in topic policy", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-_ !?.]+$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/TopicType" - } - }, - "required": [ - "Definition", - "Name", - "Type" - ], - "type": "object" - }, - "TopicConfig": { - "additionalProperties": false, - "description": "Topic config in topic policy.", - "properties": { - "Definition": { - "description": "Definition of topic in topic policy", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "Examples": { - "description": "List of text examples", - "items": { - "description": "Text example in topic policy", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "minItems": 0, - "type": "array" - }, - "Name": { - "description": "Name of topic in topic policy", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-_ !?.]+$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/TopicType" - } - }, - "required": [ - "Definition", - "Name", - "Type" - ], - "type": "object" - }, - "TopicPolicyConfig": { - "additionalProperties": false, - "description": "Topic policy config for a guardrail.", - "properties": { - "TopicsConfig": { - "description": "List of topic configs in topic policy.", - "items": { - "$ref": "#/definitions/TopicConfig" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "TopicsConfig" - ], - "type": "object" - }, - "TopicType": { - "description": "Type of topic in a policy", - "enum": [ - "DENY" - ], - "type": "string" - }, - "WordConfig": { - "additionalProperties": false, - "description": "A custom word config.", - "properties": { - "Text": { - "description": "The custom word text.", - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Text" - ], - "type": "object" - }, - "WordPolicyConfig": { - "additionalProperties": false, - "description": "Word policy config for a guardrail.", - "properties": { - "ManagedWordListsConfig": { - "description": "A config for the list of managed words.", - "items": { - "$ref": "#/definitions/ManagedWordsConfig" - }, - "type": "array" - }, - "WordsConfig": { - "description": "List of custom word configs.", - "items": { - "$ref": "#/definitions/WordConfig" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::Guardrail Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateGuardrail", - "bedrock:GetGuardrail", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "bedrock:TagResource", - "bedrock:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteGuardrail", - "bedrock:GetGuardrail", - "kms:Decrypt", - "kms:RetireGrant" - ] - }, - "list": { - "permissions": [ - "bedrock:ListGuardrails" - ] - }, - "read": { - "permissions": [ - "bedrock:GetGuardrail", - "kms:Decrypt", - "bedrock:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "bedrock:UpdateGuardrail", - "bedrock:GetGuardrail", - "bedrock:ListTagsForResource", - "bedrock:TagResource", - "bedrock:UntagResource", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/GuardrailArn" - ], - "properties": { - "BlockedInputMessaging": { - "description": "Messaging for when violations are detected in text", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "BlockedOutputsMessaging": { - "description": "Messaging for when violations are detected in text", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "ContentPolicyConfig": { - "$ref": "#/definitions/ContentPolicyConfig" - }, - "CreatedAt": { - "description": "Time Stamp", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "Description of the guardrail or its version", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FailureRecommendations": { - "description": "List of failure recommendations", - "items": { - "description": "Recommendation for guardrail failure status", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "type": "array" - }, - "GuardrailArn": { - "description": "Arn representation for the guardrail", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$", - "type": "string" - }, - "GuardrailId": { - "description": "Unique id for the guardrail", - "maxLength": 64, - "pattern": "^[a-z0-9]+$", - "type": "string" - }, - "KmsKeyArn": { - "description": "The KMS key with which the guardrail was encrypted at rest", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - }, - "Name": { - "description": "Name of the guardrail", - "maxLength": 50, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-_]+$", - "type": "string" - }, - "SensitiveInformationPolicyConfig": { - "$ref": "#/definitions/SensitiveInformationPolicyConfig" - }, - "Status": { - "$ref": "#/definitions/GuardrailStatus" - }, - "StatusReasons": { - "description": "List of status reasons", - "items": { - "description": "Reason for guardrail status", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "type": "array" - }, - "Tags": { - "description": "List of Tags", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TopicPolicyConfig": { - "$ref": "#/definitions/TopicPolicyConfig" - }, - "UpdatedAt": { - "description": "Time Stamp", - "format": "date-time", - "type": "string" - }, - "Version": { - "description": "Guardrail version", - "pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", - "type": "string" - }, - "WordPolicyConfig": { - "$ref": "#/definitions/WordPolicyConfig" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/FailureRecommendations", - "/properties/GuardrailArn", - "/properties/GuardrailId", - "/properties/Status", - "/properties/StatusReasons", - "/properties/UpdatedAt", - "/properties/Version" - ], - "required": [ - "Name", - "BlockedInputMessaging", - "BlockedOutputsMessaging" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::Guardrail" -} +{ + "additionalProperties": false, + "definitions": { + "ContentFilter": { + "additionalProperties": false, + "description": "Content filter in content policy.", + "properties": { + "InputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "OutputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "Type": { + "$ref": "#/definitions/ContentFilterType" + } + }, + "required": [ + "InputStrength", + "OutputStrength", + "Type" + ], + "type": "object" + }, + "ContentFilterConfig": { + "additionalProperties": false, + "description": "Content filter config in content policy.", + "properties": { + "InputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "OutputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "Type": { + "$ref": "#/definitions/ContentFilterType" + } + }, + "required": [ + "InputStrength", + "OutputStrength", + "Type" + ], + "type": "object" + }, + "ContentFilterType": { + "description": "Type of filter in content policy", + "enum": [ + "SEXUAL", + "VIOLENCE", + "HATE", + "INSULTS", + "MISCONDUCT", + "PROMPT_ATTACK" + ], + "type": "string" + }, + "ContentPolicyConfig": { + "additionalProperties": false, + "description": "Content policy config for a guardrail.", + "properties": { + "FiltersConfig": { + "description": "List of content filter configs in content policy.", + "items": { + "$ref": "#/definitions/ContentFilterConfig" + }, + "maxItems": 6, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "FiltersConfig" + ], + "type": "object" + }, + "ContextualGroundingFilterConfig": { + "additionalProperties": false, + "description": "A config for grounding filter.", + "properties": { + "Threshold": { + "description": "The threshold for this filter.", + "minimum": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/ContextualGroundingFilterType" + } + }, + "required": [ + "Threshold", + "Type" + ], + "type": "object" + }, + "ContextualGroundingFilterType": { + "description": "Type of contextual grounding filter", + "enum": [ + "GROUNDING", + "RELEVANCE" + ], + "type": "string" + }, + "ContextualGroundingPolicyConfig": { + "additionalProperties": false, + "description": "Contextual grounding policy config for a guardrail.", + "properties": { + "FiltersConfig": { + "description": "List of contextual grounding filter configs.", + "items": { + "$ref": "#/definitions/ContextualGroundingFilterConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "FiltersConfig" + ], + "type": "object" + }, + "FilterStrength": { + "description": "Strength for filters", + "enum": [ + "NONE", + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + }, + "GuardrailStatus": { + "description": "Status of the guardrail", + "enum": [ + "CREATING", + "UPDATING", + "VERSIONING", + "READY", + "FAILED", + "DELETING" + ], + "type": "string" + }, + "ManagedWords": { + "additionalProperties": false, + "description": "A managed words definition.", + "properties": { + "Type": { + "$ref": "#/definitions/ManagedWordsType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ManagedWordsConfig": { + "additionalProperties": false, + "description": "A managed words config.", + "properties": { + "Type": { + "$ref": "#/definitions/ManagedWordsType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ManagedWordsType": { + "description": "Options for managed words.", + "enum": [ + "PROFANITY" + ], + "type": "string" + }, + "PiiEntity": { + "additionalProperties": false, + "description": "Entity name and behavior.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Type": { + "$ref": "#/definitions/PiiEntityType" + } + }, + "required": [ + "Action", + "Type" + ], + "type": "object" + }, + "PiiEntityConfig": { + "additionalProperties": false, + "description": "Pii entity configuration.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Type": { + "$ref": "#/definitions/PiiEntityType" + } + }, + "required": [ + "Action", + "Type" + ], + "type": "object" + }, + "PiiEntityType": { + "description": "The currently supported PII entities", + "enum": [ + "ADDRESS", + "AGE", + "AWS_ACCESS_KEY", + "AWS_SECRET_KEY", + "CA_HEALTH_NUMBER", + "CA_SOCIAL_INSURANCE_NUMBER", + "CREDIT_DEBIT_CARD_CVV", + "CREDIT_DEBIT_CARD_EXPIRY", + "CREDIT_DEBIT_CARD_NUMBER", + "DRIVER_ID", + "EMAIL", + "INTERNATIONAL_BANK_ACCOUNT_NUMBER", + "IP_ADDRESS", + "LICENSE_PLATE", + "MAC_ADDRESS", + "NAME", + "PASSWORD", + "PHONE", + "PIN", + "SWIFT_CODE", + "UK_NATIONAL_HEALTH_SERVICE_NUMBER", + "UK_NATIONAL_INSURANCE_NUMBER", + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", + "URL", + "USERNAME", + "US_BANK_ACCOUNT_NUMBER", + "US_BANK_ROUTING_NUMBER", + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", + "US_PASSPORT_NUMBER", + "US_SOCIAL_SECURITY_NUMBER", + "VEHICLE_IDENTIFICATION_NUMBER" + ], + "type": "string" + }, + "RegexConfig": { + "additionalProperties": false, + "description": "A regex configuration.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Description": { + "description": "The regex description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The regex name.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Pattern": { + "description": "The regex pattern.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Action", + "Name", + "Pattern" + ], + "type": "object" + }, + "SensitiveInformationAction": { + "description": "Options for sensitive information action.", + "enum": [ + "BLOCK", + "ANONYMIZE" + ], + "type": "string" + }, + "SensitiveInformationPolicyConfig": { + "additionalProperties": false, + "description": "Sensitive information policy config for a guardrail.", + "properties": { + "PiiEntitiesConfig": { + "description": "List of entities.", + "items": { + "$ref": "#/definitions/PiiEntityConfig" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RegexesConfig": { + "description": "List of regex.", + "items": { + "$ref": "#/definitions/RegexConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Definition of the key/value pair for a tag", + "properties": { + "Key": { + "description": "Tag Key", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + }, + "Value": { + "description": "Tag Value", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Topic": { + "additionalProperties": false, + "description": "Topic in topic policy.", + "properties": { + "Definition": { + "description": "Definition of topic in topic policy", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Examples": { + "description": "List of text examples", + "items": { + "description": "Text example in topic policy", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "Name of topic in topic policy", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_ !?.]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/TopicType" + } + }, + "required": [ + "Definition", + "Name", + "Type" + ], + "type": "object" + }, + "TopicConfig": { + "additionalProperties": false, + "description": "Topic config in topic policy.", + "properties": { + "Definition": { + "description": "Definition of topic in topic policy", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Examples": { + "description": "List of text examples", + "items": { + "description": "Text example in topic policy", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "Name of topic in topic policy", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_ !?.]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/TopicType" + } + }, + "required": [ + "Definition", + "Name", + "Type" + ], + "type": "object" + }, + "TopicPolicyConfig": { + "additionalProperties": false, + "description": "Topic policy config for a guardrail.", + "properties": { + "TopicsConfig": { + "description": "List of topic configs in topic policy.", + "items": { + "$ref": "#/definitions/TopicConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "TopicsConfig" + ], + "type": "object" + }, + "TopicType": { + "description": "Type of topic in a policy", + "enum": [ + "DENY" + ], + "type": "string" + }, + "WordConfig": { + "additionalProperties": false, + "description": "A custom word config.", + "properties": { + "Text": { + "description": "The custom word text.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + }, + "WordPolicyConfig": { + "additionalProperties": false, + "description": "Word policy config for a guardrail.", + "properties": { + "ManagedWordListsConfig": { + "description": "A config for the list of managed words.", + "items": { + "$ref": "#/definitions/ManagedWordsConfig" + }, + "type": "array" + }, + "WordsConfig": { + "description": "List of custom word configs.", + "items": { + "$ref": "#/definitions/WordConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::Guardrail Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateGuardrail", + "bedrock:GetGuardrail", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "bedrock:TagResource", + "bedrock:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteGuardrail", + "bedrock:GetGuardrail", + "kms:Decrypt", + "kms:RetireGrant" + ] + }, + "list": { + "permissions": [ + "bedrock:ListGuardrails" + ] + }, + "read": { + "permissions": [ + "bedrock:GetGuardrail", + "kms:Decrypt", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:UpdateGuardrail", + "bedrock:GetGuardrail", + "bedrock:ListTagsForResource", + "bedrock:TagResource", + "bedrock:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/GuardrailArn" + ], + "properties": { + "BlockedInputMessaging": { + "description": "Messaging for when violations are detected in text", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "BlockedOutputsMessaging": { + "description": "Messaging for when violations are detected in text", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "ContentPolicyConfig": { + "$ref": "#/definitions/ContentPolicyConfig" + }, + "ContextualGroundingPolicyConfig": { + "$ref": "#/definitions/ContextualGroundingPolicyConfig" + }, + "CreatedAt": { + "description": "Time Stamp", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "Description of the guardrail or its version", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureRecommendations": { + "description": "List of failure recommendations", + "items": { + "description": "Recommendation for guardrail failure status", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "GuardrailArn": { + "description": "Arn representation for the guardrail", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$", + "type": "string" + }, + "GuardrailId": { + "description": "Unique id for the guardrail", + "maxLength": 64, + "pattern": "^[a-z0-9]+$", + "type": "string" + }, + "KmsKeyArn": { + "description": "The KMS key with which the guardrail was encrypted at rest", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Name": { + "description": "Name of the guardrail", + "maxLength": 50, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_]+$", + "type": "string" + }, + "SensitiveInformationPolicyConfig": { + "$ref": "#/definitions/SensitiveInformationPolicyConfig" + }, + "Status": { + "$ref": "#/definitions/GuardrailStatus" + }, + "StatusReasons": { + "description": "List of status reasons", + "items": { + "description": "Reason for guardrail status", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "Tags": { + "description": "List of Tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TopicPolicyConfig": { + "$ref": "#/definitions/TopicPolicyConfig" + }, + "UpdatedAt": { + "description": "Time Stamp", + "format": "date-time", + "type": "string" + }, + "Version": { + "description": "Guardrail version", + "pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", + "type": "string" + }, + "WordPolicyConfig": { + "$ref": "#/definitions/WordPolicyConfig" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/FailureRecommendations", + "/properties/GuardrailArn", + "/properties/GuardrailId", + "/properties/Status", + "/properties/StatusReasons", + "/properties/UpdatedAt", + "/properties/Version" + ], + "required": [ + "Name", + "BlockedInputMessaging", + "BlockedOutputsMessaging" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Guardrail" +} diff --git a/schema/aws-bedrock-guardrailversion.json b/schema/aws-bedrock-guardrailversion.json index 984e211..f5fc84b 100644 --- a/schema/aws-bedrock-guardrailversion.json +++ b/schema/aws-bedrock-guardrailversion.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/GuardrailIdentifier" - ], - "definitions": {}, - "description": "Definition of AWS::Bedrock::GuardrailVersion Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateGuardrailVersion", - "bedrock:GetGuardrail", - "kms:CreateGrant", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeleteGuardrail", - "bedrock:GetGuardrail", - "kms:RetireGrant" - ] - }, - "read": { - "permissions": [ - "bedrock:GetGuardrail", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/GuardrailId", - "/properties/Version" - ], - "properties": { - "Description": { - "description": "Description of the Guardrail version", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "GuardrailArn": { - "description": "Arn representation for the guardrail", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$", - "type": "string" - }, - "GuardrailId": { - "description": "Unique id for the guardrail", - "maxLength": 64, - "pattern": "^[a-z0-9]+$", - "type": "string" - }, - "GuardrailIdentifier": { - "description": "Identifier (GuardrailId or GuardrailArn) for the guardrail", - "maxLength": 2048, - "pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$", - "type": "string" - }, - "Version": { - "description": "Guardrail version", - "pattern": "^[1-9][0-9]{0,7}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/GuardrailArn", - "/properties/GuardrailId", - "/properties/Version" - ], - "required": [ - "GuardrailIdentifier" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Bedrock::GuardrailVersion", - "writeOnlyProperties": [ - "/properties/GuardrailIdentifier" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/GuardrailIdentifier" + ], + "definitions": {}, + "description": "Definition of AWS::Bedrock::GuardrailVersion Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateGuardrailVersion", + "bedrock:GetGuardrail", + "kms:CreateGrant", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteGuardrail", + "bedrock:GetGuardrail", + "kms:RetireGrant" + ] + }, + "read": { + "permissions": [ + "bedrock:GetGuardrail", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/GuardrailId", + "/properties/Version" + ], + "properties": { + "Description": { + "description": "Description of the Guardrail version", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "GuardrailArn": { + "description": "Arn representation for the guardrail", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$", + "type": "string" + }, + "GuardrailId": { + "description": "Unique id for the guardrail", + "maxLength": 64, + "pattern": "^[a-z0-9]+$", + "type": "string" + }, + "GuardrailIdentifier": { + "description": "Identifier (GuardrailId or GuardrailArn) for the guardrail", + "maxLength": 2048, + "pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$", + "type": "string" + }, + "Version": { + "description": "Guardrail version", + "pattern": "^[1-9][0-9]{0,7}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/GuardrailArn", + "/properties/GuardrailId", + "/properties/Version" + ], + "required": [ + "GuardrailIdentifier" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Bedrock::GuardrailVersion", + "writeOnlyProperties": [ + "/properties/GuardrailIdentifier" + ] +} diff --git a/schema/aws-bedrock-knowledgebase.json b/schema/aws-bedrock-knowledgebase.json index 4f6a2b8..acb52c7 100644 --- a/schema/aws-bedrock-knowledgebase.json +++ b/schema/aws-bedrock-knowledgebase.json @@ -1,622 +1,622 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StorageConfiguration", - "/properties/KnowledgeBaseConfiguration" - ], - "definitions": { - "BedrockEmbeddingModelConfiguration": { - "additionalProperties": false, - "description": "The vector configuration details for the Bedrock embeddings model.", - "properties": { - "Dimensions": { - "description": "The dimensions details for the vector configuration used on the Bedrock embeddings model.", - "maximum": 4096, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "EmbeddingModelConfiguration": { - "additionalProperties": false, - "description": "The embeddings model configuration details for the vector model used in Knowledge Base.", - "properties": { - "BedrockEmbeddingModelConfiguration": { - "$ref": "#/definitions/BedrockEmbeddingModelConfiguration" - } - }, - "type": "object" - }, - "KnowledgeBaseConfiguration": { - "additionalProperties": false, - "description": "Contains details about the embeddings model used for the knowledge base.", - "properties": { - "Type": { - "$ref": "#/definitions/KnowledgeBaseType" - }, - "VectorKnowledgeBaseConfiguration": { - "$ref": "#/definitions/VectorKnowledgeBaseConfiguration" - } - }, - "required": [ - "Type", - "VectorKnowledgeBaseConfiguration" - ], - "type": "object" - }, - "KnowledgeBaseStatus": { - "description": "The status of a knowledge base.", - "enum": [ - "CREATING", - "ACTIVE", - "DELETING", - "UPDATING", - "FAILED", - "DELETE_UNSUCCESSFUL" - ], - "type": "string" - }, - "KnowledgeBaseStorageType": { - "description": "The storage type of a knowledge base.", - "enum": [ - "OPENSEARCH_SERVERLESS", - "PINECONE", - "RDS", - "MONGO_DB_ATLAS" - ], - "type": "string" - }, - "KnowledgeBaseType": { - "description": "The type of a knowledge base.", - "enum": [ - "VECTOR" - ], - "type": "string" - }, - "MongoDbAtlasConfiguration": { - "additionalProperties": false, - "description": "Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.", - "properties": { - "CollectionName": { - "description": "Name of the collection within MongoDB Atlas.", - "maxLength": 63, - "pattern": "^.*$", - "type": "string" - }, - "CredentialsSecretArn": { - "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.", - "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", - "type": "string" - }, - "DatabaseName": { - "description": "Name of the database within MongoDB Atlas.", - "maxLength": 63, - "pattern": "^.*$", - "type": "string" - }, - "Endpoint": { - "description": "MongoDB Atlas endpoint.", - "maxLength": 2048, - "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]+\\.mongodb\\.net$", - "type": "string" - }, - "EndpointServiceName": { - "description": "MongoDB Atlas endpoint service name.", - "maxLength": 255, - "pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$", - "type": "string" - }, - "FieldMapping": { - "$ref": "#/definitions/MongoDbAtlasFieldMapping" - }, - "VectorIndexName": { - "description": "Name of a MongoDB Atlas index.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Endpoint", - "CredentialsSecretArn", - "DatabaseName", - "CollectionName", - "VectorIndexName", - "FieldMapping" - ], - "type": "object" - }, - "MongoDbAtlasFieldMapping": { - "additionalProperties": false, - "description": "Contains the names of the fields to which to map information about the vector store.", - "properties": { - "MetadataField": { - "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "TextField": { - "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "VectorField": { - "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "VectorField", - "MetadataField", - "TextField" - ], - "type": "object" - }, - "OpenSearchServerlessConfiguration": { - "additionalProperties": false, - "description": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.", - "properties": { - "CollectionArn": { - "description": "The ARN of the OpenSearch Service vector store.", - "maxLength": 2048, - "pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$", - "type": "string" - }, - "FieldMapping": { - "$ref": "#/definitions/OpenSearchServerlessFieldMapping" - }, - "VectorIndexName": { - "description": "The name of the vector store.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "CollectionArn", - "FieldMapping", - "VectorIndexName" - ], - "type": "object" - }, - "OpenSearchServerlessFieldMapping": { - "additionalProperties": false, - "description": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names", - "properties": { - "MetadataField": { - "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "TextField": { - "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "VectorField": { - "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "MetadataField", - "TextField", - "VectorField" - ], - "type": "object" - }, - "PineconeConfiguration": { - "additionalProperties": false, - "description": "Contains the storage configuration of the knowledge base in Pinecone.", - "properties": { - "ConnectionString": { - "description": "The endpoint URL for your index management page.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "CredentialsSecretArn": { - "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.", - "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", - "type": "string" - }, - "FieldMapping": { - "$ref": "#/definitions/PineconeFieldMapping" - }, - "Namespace": { - "description": "The namespace to be used to write new data to your database.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "ConnectionString", - "CredentialsSecretArn", - "FieldMapping" - ], - "type": "object" - }, - "PineconeFieldMapping": { - "additionalProperties": false, - "description": "Contains the names of the fields to which to map information about the vector store.", - "properties": { - "MetadataField": { - "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "TextField": { - "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "MetadataField", - "TextField" - ], - "type": "object" - }, - "RdsConfiguration": { - "additionalProperties": false, - "description": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.", - "properties": { - "CredentialsSecretArn": { - "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.", - "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", - "type": "string" - }, - "DatabaseName": { - "description": "The name of your Amazon RDS database.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\-]+$", - "type": "string" - }, - "FieldMapping": { - "$ref": "#/definitions/RdsFieldMapping" - }, - "ResourceArn": { - "description": "The ARN of the vector store.", - "pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$", - "type": "string" - }, - "TableName": { - "description": "The name of the table in the database.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\.\\-]+$", - "type": "string" - } - }, - "required": [ - "CredentialsSecretArn", - "DatabaseName", - "FieldMapping", - "ResourceArn", - "TableName" - ], - "type": "object" - }, - "RdsFieldMapping": { - "additionalProperties": false, - "description": "Contains the names of the fields to which to map information about the vector store.", - "properties": { - "MetadataField": { - "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\-]+$", - "type": "string" - }, - "PrimaryKeyField": { - "description": "The name of the field in which Amazon Bedrock stores the ID for each entry.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\-]+$", - "type": "string" - }, - "TextField": { - "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\-]+$", - "type": "string" - }, - "VectorField": { - "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9_\\-]+$", - "type": "string" - } - }, - "required": [ - "MetadataField", - "PrimaryKeyField", - "TextField", - "VectorField" - ], - "type": "object" - }, - "RedisEnterpriseCloudConfiguration": { - "additionalProperties": false, - "description": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.", - "properties": { - "CredentialsSecretArn": { - "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.", - "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", - "type": "string" - }, - "Endpoint": { - "description": "The endpoint URL of the Redis Enterprise Cloud database.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "FieldMapping": { - "$ref": "#/definitions/RedisEnterpriseCloudFieldMapping" - }, - "VectorIndexName": { - "description": "The name of the vector index.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "CredentialsSecretArn", - "Endpoint", - "FieldMapping", - "VectorIndexName" - ], - "type": "object" - }, - "RedisEnterpriseCloudFieldMapping": { - "additionalProperties": false, - "description": "Contains the names of the fields to which to map information about the vector store.", - "properties": { - "MetadataField": { - "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "TextField": { - "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - }, - "VectorField": { - "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", - "maxLength": 2048, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "MetadataField", - "TextField", - "VectorField" - ], - "type": "object" - }, - "StorageConfiguration": { - "additionalProperties": false, - "description": "The vector store service in which the knowledge base is stored.", - "oneOf": [ - { - "required": [ - "OpensearchServerlessConfiguration" - ] - }, - { - "required": [ - "PineconeConfiguration" - ] - }, - { - "required": [ - "RdsConfiguration" - ] - }, - { - "required": [ - "MongoDbAtlasConfiguration" - ] - } - ], - "properties": { - "MongoDbAtlasConfiguration": { - "$ref": "#/definitions/MongoDbAtlasConfiguration" - }, - "OpensearchServerlessConfiguration": { - "$ref": "#/definitions/OpenSearchServerlessConfiguration" - }, - "PineconeConfiguration": { - "$ref": "#/definitions/PineconeConfiguration" - }, - "RdsConfiguration": { - "$ref": "#/definitions/RdsConfiguration" - }, - "Type": { - "$ref": "#/definitions/KnowledgeBaseStorageType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - }, - "VectorKnowledgeBaseConfiguration": { - "additionalProperties": false, - "description": "Contains details about the model used to create vector embeddings for the knowledge base.", - "properties": { - "EmbeddingModelArn": { - "description": "The ARN of the model used to create vector embeddings for the knowledge base.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$", - "type": "string" - }, - "EmbeddingModelConfiguration": { - "$ref": "#/definitions/EmbeddingModelConfiguration" - } - }, - "required": [ - "EmbeddingModelArn" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::KnowledgeBase Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreateKnowledgeBase", - "bedrock:GetKnowledgeBase", - "bedrock:TagResource", - "bedrock:ListTagsForResource", - "bedrock:AssociateThirdPartyKnowledgeBase", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "bedrock:GetKnowledgeBase", - "bedrock:DeleteKnowledgeBase", - "bedrock:ListDataSources" - ] - }, - "list": { - "permissions": [ - "bedrock:ListKnowledgeBases" - ] - }, - "read": { - "permissions": [ - "bedrock:GetKnowledgeBase", - "bedrock:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "bedrock:GetKnowledgeBase", - "bedrock:UpdateKnowledgeBase", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource", - "bedrock:AssociateThirdPartyKnowledgeBase", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/KnowledgeBaseId" - ], - "properties": { - "CreatedAt": { - "description": "The time at which the knowledge base was created.", - "type": "string" - }, - "Description": { - "description": "Description of the Resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "FailureReasons": { - "description": "A list of reasons that the API operation on the knowledge base failed.", - "insertionOrder": false, - "items": { - "description": "Failure Reason for Error.", - "maxLength": 2048, - "type": "string" - }, - "maxItems": 2048, - "type": "array" - }, - "KnowledgeBaseArn": { - "description": "The ARN of the knowledge base.", - "maxLength": 128, - "minLength": 0, - "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$", - "type": "string" - }, - "KnowledgeBaseConfiguration": { - "$ref": "#/definitions/KnowledgeBaseConfiguration" - }, - "KnowledgeBaseId": { - "description": "The unique identifier of the knowledge base.", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Name": { - "description": "The name of the knowledge base.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_", - "maxLength": 2048, - "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/KnowledgeBaseStatus" - }, - "StorageConfiguration": { - "$ref": "#/definitions/StorageConfiguration" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "The time at which the knowledge base was last updated.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/KnowledgeBaseId", - "/properties/KnowledgeBaseArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/FailureReasons", - "/properties/Status" - ], - "required": [ - "KnowledgeBaseConfiguration", - "Name", - "RoleArn", - "StorageConfiguration" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::KnowledgeBase" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StorageConfiguration", + "/properties/KnowledgeBaseConfiguration" + ], + "definitions": { + "BedrockEmbeddingModelConfiguration": { + "additionalProperties": false, + "description": "The vector configuration details for the Bedrock embeddings model.", + "properties": { + "Dimensions": { + "description": "The dimensions details for the vector configuration used on the Bedrock embeddings model.", + "maximum": 4096, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "EmbeddingModelConfiguration": { + "additionalProperties": false, + "description": "The embeddings model configuration details for the vector model used in Knowledge Base.", + "properties": { + "BedrockEmbeddingModelConfiguration": { + "$ref": "#/definitions/BedrockEmbeddingModelConfiguration" + } + }, + "type": "object" + }, + "KnowledgeBaseConfiguration": { + "additionalProperties": false, + "description": "Contains details about the embeddings model used for the knowledge base.", + "properties": { + "Type": { + "$ref": "#/definitions/KnowledgeBaseType" + }, + "VectorKnowledgeBaseConfiguration": { + "$ref": "#/definitions/VectorKnowledgeBaseConfiguration" + } + }, + "required": [ + "Type", + "VectorKnowledgeBaseConfiguration" + ], + "type": "object" + }, + "KnowledgeBaseStatus": { + "description": "The status of a knowledge base.", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING", + "FAILED", + "DELETE_UNSUCCESSFUL" + ], + "type": "string" + }, + "KnowledgeBaseStorageType": { + "description": "The storage type of a knowledge base.", + "enum": [ + "OPENSEARCH_SERVERLESS", + "PINECONE", + "RDS", + "MONGO_DB_ATLAS" + ], + "type": "string" + }, + "KnowledgeBaseType": { + "description": "The type of a knowledge base.", + "enum": [ + "VECTOR" + ], + "type": "string" + }, + "MongoDbAtlasConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.", + "properties": { + "CollectionName": { + "description": "Name of the collection within MongoDB Atlas.", + "maxLength": 63, + "pattern": "^.*$", + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "DatabaseName": { + "description": "Name of the database within MongoDB Atlas.", + "maxLength": 63, + "pattern": "^.*$", + "type": "string" + }, + "Endpoint": { + "description": "MongoDB Atlas endpoint.", + "maxLength": 2048, + "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]+\\.mongodb\\.net$", + "type": "string" + }, + "EndpointServiceName": { + "description": "MongoDB Atlas endpoint service name.", + "maxLength": 255, + "pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/MongoDbAtlasFieldMapping" + }, + "VectorIndexName": { + "description": "Name of a MongoDB Atlas index.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Endpoint", + "CredentialsSecretArn", + "DatabaseName", + "CollectionName", + "VectorIndexName", + "FieldMapping" + ], + "type": "object" + }, + "MongoDbAtlasFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "VectorField", + "MetadataField", + "TextField" + ], + "type": "object" + }, + "OpenSearchServerlessConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.", + "properties": { + "CollectionArn": { + "description": "The ARN of the OpenSearch Service vector store.", + "maxLength": 2048, + "pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/OpenSearchServerlessFieldMapping" + }, + "VectorIndexName": { + "description": "The name of the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "CollectionArn", + "FieldMapping", + "VectorIndexName" + ], + "type": "object" + }, + "OpenSearchServerlessFieldMapping": { + "additionalProperties": false, + "description": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "PineconeConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Pinecone.", + "properties": { + "ConnectionString": { + "description": "The endpoint URL for your index management page.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/PineconeFieldMapping" + }, + "Namespace": { + "description": "The namespace to be used to write new data to your database.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "ConnectionString", + "CredentialsSecretArn", + "FieldMapping" + ], + "type": "object" + }, + "PineconeFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField" + ], + "type": "object" + }, + "RdsConfiguration": { + "additionalProperties": false, + "description": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.", + "properties": { + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "DatabaseName": { + "description": "The name of your Amazon RDS database.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/RdsFieldMapping" + }, + "ResourceArn": { + "description": "The ARN of the vector store.", + "pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$", + "type": "string" + }, + "TableName": { + "description": "The name of the table in the database.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\.\\-]+$", + "type": "string" + } + }, + "required": [ + "CredentialsSecretArn", + "DatabaseName", + "FieldMapping", + "ResourceArn", + "TableName" + ], + "type": "object" + }, + "RdsFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "PrimaryKeyField": { + "description": "The name of the field in which Amazon Bedrock stores the ID for each entry.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "TextField": { + "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "PrimaryKeyField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "RedisEnterpriseCloudConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.", + "properties": { + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "Endpoint": { + "description": "The endpoint URL of the Redis Enterprise Cloud database.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/RedisEnterpriseCloudFieldMapping" + }, + "VectorIndexName": { + "description": "The name of the vector index.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "CredentialsSecretArn", + "Endpoint", + "FieldMapping", + "VectorIndexName" + ], + "type": "object" + }, + "RedisEnterpriseCloudFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "StorageConfiguration": { + "additionalProperties": false, + "description": "The vector store service in which the knowledge base is stored.", + "oneOf": [ + { + "required": [ + "OpensearchServerlessConfiguration" + ] + }, + { + "required": [ + "PineconeConfiguration" + ] + }, + { + "required": [ + "RdsConfiguration" + ] + }, + { + "required": [ + "MongoDbAtlasConfiguration" + ] + } + ], + "properties": { + "MongoDbAtlasConfiguration": { + "$ref": "#/definitions/MongoDbAtlasConfiguration" + }, + "OpensearchServerlessConfiguration": { + "$ref": "#/definitions/OpenSearchServerlessConfiguration" + }, + "PineconeConfiguration": { + "$ref": "#/definitions/PineconeConfiguration" + }, + "RdsConfiguration": { + "$ref": "#/definitions/RdsConfiguration" + }, + "Type": { + "$ref": "#/definitions/KnowledgeBaseStorageType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "VectorKnowledgeBaseConfiguration": { + "additionalProperties": false, + "description": "Contains details about the model used to create vector embeddings for the knowledge base.", + "properties": { + "EmbeddingModelArn": { + "description": "The ARN of the model used to create vector embeddings for the knowledge base.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$", + "type": "string" + }, + "EmbeddingModelConfiguration": { + "$ref": "#/definitions/EmbeddingModelConfiguration" + } + }, + "required": [ + "EmbeddingModelArn" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::KnowledgeBase Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateKnowledgeBase", + "bedrock:GetKnowledgeBase", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "bedrock:AssociateThirdPartyKnowledgeBase", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:DeleteKnowledgeBase", + "bedrock:ListDataSources" + ] + }, + "list": { + "permissions": [ + "bedrock:ListKnowledgeBases" + ] + }, + "read": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:UpdateKnowledgeBase", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "bedrock:AssociateThirdPartyKnowledgeBase", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/KnowledgeBaseId" + ], + "properties": { + "CreatedAt": { + "description": "The time at which the knowledge base was created.", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "A list of reasons that the API operation on the knowledge base failed.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "KnowledgeBaseArn": { + "description": "The ARN of the knowledge base.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$", + "type": "string" + }, + "KnowledgeBaseConfiguration": { + "$ref": "#/definitions/KnowledgeBaseConfiguration" + }, + "KnowledgeBaseId": { + "description": "The unique identifier of the knowledge base.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "The name of the knowledge base.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/KnowledgeBaseStatus" + }, + "StorageConfiguration": { + "$ref": "#/definitions/StorageConfiguration" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "The time at which the knowledge base was last updated.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/KnowledgeBaseId", + "/properties/KnowledgeBaseArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/FailureReasons", + "/properties/Status" + ], + "required": [ + "KnowledgeBaseConfiguration", + "Name", + "RoleArn", + "StorageConfiguration" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::KnowledgeBase" +} diff --git a/schema/aws-bedrock-prompt.json b/schema/aws-bedrock-prompt.json index e486572..7f7a60b 100644 --- a/schema/aws-bedrock-prompt.json +++ b/schema/aws-bedrock-prompt.json @@ -1,346 +1,346 @@ -{ - "additionalProperties": false, - "definitions": { - "PromptInferenceConfiguration": { - "description": "Model inference configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/PromptModelInferenceConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptInputVariable": { - "additionalProperties": false, - "description": "Input variable", - "properties": { - "Name": { - "description": "Name for an input variable", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - } - }, - "type": "object" - }, - "PromptModelInferenceConfiguration": { - "additionalProperties": false, - "description": "Prompt model inference configuration", - "properties": { - "MaxTokens": { - "description": "Maximum length of output", - "maximum": 4096, - "minimum": 0, - "type": "number" - }, - "StopSequences": { - "description": "List of stop sequences", - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array" - }, - "Temperature": { - "description": "Controls randomness, higher values increase diversity", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "TopK": { - "description": "Sample from the k most likely next tokens", - "maximum": 500, - "minimum": 0, - "type": "number" - }, - "TopP": { - "description": "Cumulative probability cutoff for token selection", - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PromptTemplateConfiguration": { - "description": "Prompt template configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/TextPromptTemplateConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptTemplateType": { - "description": "Prompt template type", - "enum": [ - "TEXT" - ], - "type": "string" - }, - "PromptVariant": { - "additionalProperties": false, - "description": "Prompt variant", - "properties": { - "InferenceConfiguration": { - "$ref": "#/definitions/PromptInferenceConfiguration" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - }, - "Name": { - "description": "Name for a variant.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/PromptTemplateConfiguration" - }, - "TemplateType": { - "$ref": "#/definitions/PromptTemplateType" - } - }, - "required": [ - "Name", - "TemplateType" - ], - "type": "object" - }, - "TagsMap": { - "additionalProperties": false, - "description": "A map of tag keys and values", - "patternProperties": { - "^[a-zA-Z0-9\\s._:/=+@-]*$": { - "description": "Value of a tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "type": "string" - } - }, - "type": "object" - }, - "TextPromptTemplateConfiguration": { - "additionalProperties": false, - "description": "Configuration for text prompt template", - "properties": { - "InputVariables": { - "description": "List of input variables", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptInputVariable" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Text": { - "description": "Prompt content for String prompt template", - "maxLength": 200000, - "minLength": 1, - "type": "string" - }, - "TextS3Location": { - "$ref": "#/definitions/TextS3Location" - } - }, - "required": [], - "type": "object" - }, - "TextS3Location": { - "additionalProperties": false, - "description": "The identifier for the S3 resource.", - "properties": { - "Bucket": { - "description": "A bucket in S3", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "Key": { - "description": "A object key in S3", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Version": { - "description": "The version of the the S3 object to use", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::Prompt Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreatePrompt", - "bedrock:GetPrompt", - "s3:GetObject", - "s3:GetObjectVersion", - "bedrock:TagResource", - "bedrock:ListTagsForResource", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeletePrompt", - "bedrock:GetPrompt" - ] - }, - "list": { - "permissions": [ - "bedrock:ListPrompts" - ] - }, - "read": { - "permissions": [ - "bedrock:GetPrompt", - "bedrock:ListTagsForResource", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "bedrock:UpdatePrompt", - "bedrock:GetPrompt", - "s3:GetObject", - "s3:GetObjectVersion", - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "ARN of a prompt resource possibly with a version", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$", - "type": "string" - }, - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "CustomerEncryptionKeyArn": { - "description": "A KMS key ARN", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - }, - "DefaultVariant": { - "description": "Name for a variant.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Description": { - "description": "Name for a prompt resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "Identifier for a Prompt", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "Name": { - "description": "Name for a prompt resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagsMap" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "Variants": { - "description": "List of prompt variants", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptVariant" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "Version": { - "description": "Draft Version.", - "maxLength": 5, - "minLength": 5, - "pattern": "^DRAFT$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/UpdatedAt", - "/properties/Version" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "bedrock:TagResource", - "bedrock:UntagResource", - "bedrock:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Bedrock::Prompt", - "writeOnlyProperties": [ - "/properties/Variants/*/TemplateConfiguration/Text/TextS3Location" - ] -} +{ + "additionalProperties": false, + "definitions": { + "PromptInferenceConfiguration": { + "description": "Model inference configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/PromptModelInferenceConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptInputVariable": { + "additionalProperties": false, + "description": "Input variable", + "properties": { + "Name": { + "description": "Name for an input variable", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + } + }, + "type": "object" + }, + "PromptModelInferenceConfiguration": { + "additionalProperties": false, + "description": "Prompt model inference configuration", + "properties": { + "MaxTokens": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PromptTemplateConfiguration": { + "description": "Prompt template configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/TextPromptTemplateConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptTemplateType": { + "description": "Prompt template type", + "enum": [ + "TEXT" + ], + "type": "string" + }, + "PromptVariant": { + "additionalProperties": false, + "description": "Prompt variant", + "properties": { + "InferenceConfiguration": { + "$ref": "#/definitions/PromptInferenceConfiguration" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + }, + "Name": { + "description": "Name for a variant.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/PromptTemplateConfiguration" + }, + "TemplateType": { + "$ref": "#/definitions/PromptTemplateType" + } + }, + "required": [ + "Name", + "TemplateType" + ], + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "TextPromptTemplateConfiguration": { + "additionalProperties": false, + "description": "Configuration for text prompt template", + "properties": { + "InputVariables": { + "description": "List of input variables", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptInputVariable" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Text": { + "description": "Prompt content for String prompt template", + "maxLength": 200000, + "minLength": 1, + "type": "string" + }, + "TextS3Location": { + "$ref": "#/definitions/TextS3Location" + } + }, + "required": [], + "type": "object" + }, + "TextS3Location": { + "additionalProperties": false, + "description": "The identifier for the S3 resource.", + "properties": { + "Bucket": { + "description": "A bucket in S3", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "Key": { + "description": "A object key in S3", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Version": { + "description": "The version of the the S3 object to use", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::Prompt Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreatePrompt", + "bedrock:GetPrompt", + "s3:GetObject", + "s3:GetObjectVersion", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeletePrompt", + "bedrock:GetPrompt" + ] + }, + "list": { + "permissions": [ + "bedrock:ListPrompts" + ] + }, + "read": { + "permissions": [ + "bedrock:GetPrompt", + "bedrock:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "bedrock:UpdatePrompt", + "bedrock:GetPrompt", + "s3:GetObject", + "s3:GetObjectVersion", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "ARN of a prompt resource possibly with a version", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "DefaultVariant": { + "description": "Name for a variant.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Description": { + "description": "Name for a prompt resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "Identifier for a Prompt", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "Name for a prompt resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "Variants": { + "description": "List of prompt variants", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptVariant" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "Version": { + "description": "Draft Version.", + "maxLength": 5, + "minLength": 5, + "pattern": "^DRAFT$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/UpdatedAt", + "/properties/Version" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Prompt", + "writeOnlyProperties": [ + "/properties/Variants/*/TemplateConfiguration/Text/TextS3Location" + ] +} diff --git a/schema/aws-bedrock-promptversion.json b/schema/aws-bedrock-promptversion.json index 0311d8e..8c71ce2 100644 --- a/schema/aws-bedrock-promptversion.json +++ b/schema/aws-bedrock-promptversion.json @@ -1,288 +1,327 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PromptArn", - "/properties/Description" - ], - "definitions": { - "PromptInferenceConfiguration": { - "description": "Model inference configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/PromptModelInferenceConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptInputVariable": { - "additionalProperties": false, - "description": "Input variable", - "properties": { - "Name": { - "description": "Name for an input variable", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - } - }, - "type": "object" - }, - "PromptModelInferenceConfiguration": { - "additionalProperties": false, - "description": "Prompt model inference configuration", - "properties": { - "MaxTokens": { - "description": "Maximum length of output", - "maximum": 4096, - "minimum": 0, - "type": "number" - }, - "StopSequences": { - "description": "List of stop sequences", - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array" - }, - "Temperature": { - "description": "Controls randomness, higher values increase diversity", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "TopK": { - "description": "Sample from the k most likely next tokens", - "maximum": 500, - "minimum": 0, - "type": "number" - }, - "TopP": { - "description": "Cumulative probability cutoff for token selection", - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PromptTemplateConfiguration": { - "description": "Prompt template configuration", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Text": { - "$ref": "#/definitions/TextPromptTemplateConfiguration" - } - }, - "required": [ - "Text" - ], - "title": "Text", - "type": "object" - } - ] - }, - "PromptTemplateType": { - "description": "Prompt template type", - "enum": [ - "TEXT" - ], - "type": "string" - }, - "PromptVariant": { - "additionalProperties": false, - "description": "Prompt variant", - "properties": { - "InferenceConfiguration": { - "$ref": "#/definitions/PromptInferenceConfiguration" - }, - "ModelId": { - "description": "ARN or name of a Bedrock model.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", - "type": "string" - }, - "Name": { - "description": "Name for a variant.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/PromptTemplateConfiguration" - }, - "TemplateType": { - "$ref": "#/definitions/PromptTemplateType" - } - }, - "required": [ - "Name", - "TemplateType" - ], - "type": "object" - }, - "TextPromptTemplateConfiguration": { - "additionalProperties": false, - "description": "Configuration for text prompt template", - "properties": { - "InputVariables": { - "description": "List of input variables", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptInputVariable" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Text": { - "description": "Prompt content for String prompt template", - "maxLength": 200000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Text" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Bedrock::PromptVersion Resource Type", - "handlers": { - "create": { - "permissions": [ - "bedrock:CreatePromptVersion", - "bedrock:GetPrompt" - ] - }, - "delete": { - "permissions": [ - "bedrock:DeletePrompt", - "bedrock:GetPrompt" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PromptArn": { - "$ref": "resource-schema.json#/properties/PromptArn" - } - }, - "required": [ - "PromptArn" - ] - }, - "permissions": [ - "bedrock:ListPrompts" - ] - }, - "read": { - "permissions": [ - "bedrock:GetPrompt" - ] - }, - "update": { - "permissions": [ - "noservice:NoAction" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "ARN of a prompt version resource", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}:[0-9]{1,20})$", - "type": "string" - }, - "CreatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "DefaultVariant": { - "description": "Name for a variant.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "Description": { - "description": "Description for a prompt version resource.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name for a prompt resource.", - "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", - "type": "string" - }, - "PromptArn": { - "description": "ARN of a prompt resource possibly with a version", - "maxLength": 2048, - "minLength": 1, - "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$", - "type": "string" - }, - "PromptId": { - "description": "Identifier for a Prompt", - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "UpdatedAt": { - "description": "Time Stamp.", - "format": "date-time", - "type": "string" - }, - "Variants": { - "description": "List of prompt variants", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PromptVariant" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - }, - "Version": { - "description": "Version.", - "maxLength": 5, - "minLength": 1, - "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/PromptId", - "/properties/UpdatedAt", - "/properties/Version", - "/properties/Name", - "/properties/DefaultVariant", - "/properties/Variants" - ], - "required": [ - "PromptArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-prompts", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Bedrock::PromptVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PromptArn", + "/properties/Description" + ], + "definitions": { + "PromptInferenceConfiguration": { + "description": "Model inference configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/PromptModelInferenceConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptInputVariable": { + "additionalProperties": false, + "description": "Input variable", + "properties": { + "Name": { + "description": "Name for an input variable", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + } + }, + "type": "object" + }, + "PromptModelInferenceConfiguration": { + "additionalProperties": false, + "description": "Prompt model inference configuration", + "properties": { + "MaxTokens": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PromptTemplateConfiguration": { + "description": "Prompt template configuration", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Text": { + "$ref": "#/definitions/TextPromptTemplateConfiguration" + } + }, + "required": [ + "Text" + ], + "title": "Text", + "type": "object" + } + ] + }, + "PromptTemplateType": { + "description": "Prompt template type", + "enum": [ + "TEXT" + ], + "type": "string" + }, + "PromptVariant": { + "additionalProperties": false, + "description": "Prompt variant", + "properties": { + "InferenceConfiguration": { + "$ref": "#/definitions/PromptInferenceConfiguration" + }, + "ModelId": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + }, + "Name": { + "description": "Name for a variant.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/PromptTemplateConfiguration" + }, + "TemplateType": { + "$ref": "#/definitions/PromptTemplateType" + } + }, + "required": [ + "Name", + "TemplateType" + ], + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "TextPromptTemplateConfiguration": { + "additionalProperties": false, + "description": "Configuration for text prompt template", + "properties": { + "InputVariables": { + "description": "List of input variables", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptInputVariable" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Text": { + "description": "Prompt content for String prompt template", + "maxLength": 200000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::PromptVersion Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreatePromptVersion", + "bedrock:GetPrompt", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeletePrompt", + "bedrock:GetPrompt" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PromptArn": { + "$ref": "resource-schema.json#/properties/PromptArn" + } + }, + "required": [ + "PromptArn" + ] + }, + "permissions": [ + "bedrock:ListPrompts" + ] + }, + "read": { + "permissions": [ + "bedrock:GetPrompt", + "bedrock:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "noservice:NoAction" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "ARN of a prompt version resource", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}:[0-9]{1,20})$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "DefaultVariant": { + "description": "Name for a variant.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Description": { + "description": "Description for a prompt version resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name for a prompt resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "PromptArn": { + "description": "ARN of a prompt resource possibly with a version", + "maxLength": 2048, + "minLength": 1, + "pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$", + "type": "string" + }, + "PromptId": { + "description": "Identifier for a Prompt", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "Variants": { + "description": "List of prompt variants", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PromptVariant" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + }, + "Version": { + "description": "Version.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/PromptId", + "/properties/UpdatedAt", + "/properties/Version", + "/properties/Name", + "/properties/DefaultVariant", + "/properties/Variants", + "/properties/CustomerEncryptionKeyArn" + ], + "required": [ + "PromptArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-prompts", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "bedrock:TagResource", + "bedrock:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Bedrock::PromptVersion" +} diff --git a/schema/aws-billingconductor-billinggroup.json b/schema/aws-billingconductor-billinggroup.json index 34d54f5..9712902 100644 --- a/schema/aws-billingconductor-billinggroup.json +++ b/schema/aws-billingconductor-billinggroup.json @@ -1,199 +1,199 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PrimaryAccountId" - ], - "definitions": { - "AccountGrouping": { - "additionalProperties": false, - "properties": { - "AutoAssociate": { - "type": "boolean" - }, - "LinkedAccountIds": { - "insertionOrder": false, - "items": { - "pattern": "[0-9]{12}", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "LinkedAccountIds" - ], - "type": "object" - }, - "BillingGroupStatus": { - "enum": [ - "ACTIVE", - "PRIMARY_ACCOUNT_MISSING" - ], - "type": "string" - }, - "ComputationPreference": { - "additionalProperties": false, - "properties": { - "PricingPlanArn": { - "description": "ARN of the attached pricing plan", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}", - "type": "string" - } - }, - "required": [ - "PricingPlanArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.", - "handlers": { - "create": { - "permissions": [ - "billingconductor:CreateBillingGroup", - "billingconductor:AssociateAccounts", - "billingconductor:ListBillingGroups", - "billingconductor:TagResource", - "billingconductor:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "billingconductor:DeleteBillingGroup", - "billingconductor:ListBillingGroups", - "billingconductor:UntagResource", - "billingconductor:UpdateBillingGroup" - ] - }, - "list": { - "permissions": [ - "billingconductor:ListBillingGroups", - "billingconductor:ListAccountAssociations", - "organizations:ListAccounts", - "billingconductor:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "billingconductor:ListBillingGroups", - "billingconductor:ListAccountAssociations", - "organizations:ListAccounts", - "billingconductor:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "billingconductor:UpdateBillingGroup", - "billingconductor:ListAccountAssociations", - "organizations:ListAccounts", - "billingconductor:AssociateAccounts", - "billingconductor:DisassociateAccounts", - "billingconductor:ListBillingGroups", - "billingconductor:TagResource", - "billingconductor:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AccountGrouping": { - "$ref": "#/definitions/AccountGrouping" - }, - "Arn": { - "description": "Billing Group ARN", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}", - "type": "string" - }, - "ComputationPreference": { - "$ref": "#/definitions/ComputationPreference" - }, - "CreationTime": { - "description": "Creation timestamp in UNIX epoch time format", - "type": "integer" - }, - "Description": { - "maxLength": 1024, - "type": "string" - }, - "LastModifiedTime": { - "description": "Latest modified timestamp in UNIX epoch time format", - "type": "integer" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", - "type": "string" - }, - "PrimaryAccountId": { - "description": "This account will act as a virtual payer account of the billing group", - "pattern": "[0-9]{12}", - "type": "string" - }, - "Size": { - "description": "Number of accounts in the billing group", - "type": "integer" - }, - "Status": { - "$ref": "#/definitions/BillingGroupStatus" - }, - "StatusReason": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Size", - "/properties/Status", - "/properties/StatusReason", - "/properties/CreationTime", - "/properties/LastModifiedTime" - ], - "required": [ - "Name", - "AccountGrouping", - "PrimaryAccountId", - "ComputationPreference" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::BillingConductor::BillingGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PrimaryAccountId" + ], + "definitions": { + "AccountGrouping": { + "additionalProperties": false, + "properties": { + "AutoAssociate": { + "type": "boolean" + }, + "LinkedAccountIds": { + "insertionOrder": false, + "items": { + "pattern": "[0-9]{12}", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "LinkedAccountIds" + ], + "type": "object" + }, + "BillingGroupStatus": { + "enum": [ + "ACTIVE", + "PRIMARY_ACCOUNT_MISSING" + ], + "type": "string" + }, + "ComputationPreference": { + "additionalProperties": false, + "properties": { + "PricingPlanArn": { + "description": "ARN of the attached pricing plan", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}", + "type": "string" + } + }, + "required": [ + "PricingPlanArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.", + "handlers": { + "create": { + "permissions": [ + "billingconductor:CreateBillingGroup", + "billingconductor:AssociateAccounts", + "billingconductor:ListBillingGroups", + "billingconductor:TagResource", + "billingconductor:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "billingconductor:DeleteBillingGroup", + "billingconductor:ListBillingGroups", + "billingconductor:UntagResource", + "billingconductor:UpdateBillingGroup" + ] + }, + "list": { + "permissions": [ + "billingconductor:ListBillingGroups", + "billingconductor:ListAccountAssociations", + "organizations:ListAccounts", + "billingconductor:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "billingconductor:ListBillingGroups", + "billingconductor:ListAccountAssociations", + "organizations:ListAccounts", + "billingconductor:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "billingconductor:UpdateBillingGroup", + "billingconductor:ListAccountAssociations", + "organizations:ListAccounts", + "billingconductor:AssociateAccounts", + "billingconductor:DisassociateAccounts", + "billingconductor:ListBillingGroups", + "billingconductor:TagResource", + "billingconductor:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AccountGrouping": { + "$ref": "#/definitions/AccountGrouping" + }, + "Arn": { + "description": "Billing Group ARN", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}", + "type": "string" + }, + "ComputationPreference": { + "$ref": "#/definitions/ComputationPreference" + }, + "CreationTime": { + "description": "Creation timestamp in UNIX epoch time format", + "type": "integer" + }, + "Description": { + "maxLength": 1024, + "type": "string" + }, + "LastModifiedTime": { + "description": "Latest modified timestamp in UNIX epoch time format", + "type": "integer" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", + "type": "string" + }, + "PrimaryAccountId": { + "description": "This account will act as a virtual payer account of the billing group", + "pattern": "[0-9]{12}", + "type": "string" + }, + "Size": { + "description": "Number of accounts in the billing group", + "type": "integer" + }, + "Status": { + "$ref": "#/definitions/BillingGroupStatus" + }, + "StatusReason": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Size", + "/properties/Status", + "/properties/StatusReason", + "/properties/CreationTime", + "/properties/LastModifiedTime" + ], + "required": [ + "Name", + "AccountGrouping", + "PrimaryAccountId", + "ComputationPreference" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::BillingConductor::BillingGroup" +} diff --git a/schema/aws-billingconductor-customlineitem.json b/schema/aws-billingconductor-customlineitem.json index b59134e..5086a29 100644 --- a/schema/aws-billingconductor-customlineitem.json +++ b/schema/aws-billingconductor-customlineitem.json @@ -1,298 +1,298 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BillingGroupArn", - "/properties/AccountId", - "/properties/BillingPeriodRange/InclusiveStartBillingPeriod", - "/properties/BillingPeriodRange/ExclusiveEndBillingPeriod", - "/properties/CustomLineItemChargeDetails/Type" - ], - "definitions": { - "BillingPeriodRange": { - "additionalProperties": false, - "properties": { - "ExclusiveEndBillingPeriod": { - "$ref": "#/definitions/ExclusiveEndBillingPeriod" - }, - "InclusiveStartBillingPeriod": { - "$ref": "#/definitions/InclusiveStartBillingPeriod" - } - }, - "type": "object" - }, - "CustomLineItemChargeDetails": { - "additionalProperties": false, - "properties": { - "Flat": { - "$ref": "#/definitions/CustomLineItemFlatChargeDetails" - }, - "LineItemFilters": { - "$ref": "#/definitions/LineItemFilters" - }, - "Percentage": { - "$ref": "#/definitions/CustomLineItemPercentageChargeDetails" - }, - "Type": { - "$ref": "#/definitions/Type" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "CustomLineItemFlatChargeDetails": { - "additionalProperties": false, - "properties": { - "ChargeValue": { - "maximum": 1000000, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "ChargeValue" - ], - "type": "object" - }, - "CustomLineItemPercentageChargeDetails": { - "additionalProperties": false, - "properties": { - "ChildAssociatedResources": { - "insertionOrder": false, - "items": { - "pattern": "(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "PercentageValue": { - "maximum": 10000, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "PercentageValue" - ], - "type": "object" - }, - "ExclusiveEndBillingPeriod": { - "pattern": "\\d{4}-(0?[1-9]|1[012])", - "type": "string" - }, - "InclusiveStartBillingPeriod": { - "pattern": "\\d{4}-(0?[1-9]|1[012])", - "type": "string" - }, - "LineItemFilter": { - "additionalProperties": false, - "properties": { - "Attribute": { - "enum": [ - "LINE_ITEM_TYPE" - ], - "type": "string" - }, - "MatchOption": { - "enum": [ - "NOT_EQUAL" - ], - "type": "string" - }, - "Values": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LineItemFilterValue" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Attribute", - "MatchOption", - "Values" - ], - "type": "object" - }, - "LineItemFilterValue": { - "enum": [ - "SAVINGS_PLAN_NEGATION" - ], - "type": "string" - }, - "LineItemFilters": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LineItemFilter" - }, - "type": "array", - "uniqueItems": true - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Type": { - "enum": [ - "FEE", - "CREDIT" - ], - "type": "string" - } - }, - "description": "A custom line item is an one time charge that is applied to a specific billing group's bill.", - "handlers": { - "create": { - "permissions": [ - "billingconductor:CreateCustomLineItem", - "billingconductor:BatchAssociateResourcesToCustomLineItem", - "billingconductor:ListCustomLineItems", - "billingconductor:TagResource", - "billingconductor:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "billingconductor:DeleteCustomLineItem", - "billingconductor:ListCustomLineItems", - "billingconductor:BatchDisassociateResourcesFromCustomLineItem", - "billingconductor:ListResourcesAssociatedToCustomLineItem", - "billingconductor:UntagResource" - ] - }, - "list": { - "permissions": [ - "billingconductor:ListCustomLineItems", - "billingconductor:ListResourcesAssociatedToCustomLineItem", - "billingconductor:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "billingconductor:ListCustomLineItems", - "billingconductor:ListCustomLineItemVersions", - "billingconductor:ListResourcesAssociatedToCustomLineItem", - "billingconductor:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "billingconductor:UpdateCustomLineItem", - "billingconductor:ListCustomLineItems", - "billingconductor:ListResourcesAssociatedToCustomLineItem", - "billingconductor:BatchAssociateResourcesToCustomLineItem", - "billingconductor:BatchDisassociateResourcesFromCustomLineItem", - "billingconductor:TagResource", - "billingconductor:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AccountId": { - "description": "The account which this custom line item will be charged to", - "pattern": "[0-9]{12}", - "type": "string" - }, - "Arn": { - "description": "ARN", - "pattern": "(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}", - "type": "string" - }, - "AssociationSize": { - "description": "Number of source values associated to this custom line item", - "type": "integer" - }, - "BillingGroupArn": { - "description": "Billing Group ARN", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}", - "type": "string" - }, - "BillingPeriodRange": { - "$ref": "#/definitions/BillingPeriodRange" - }, - "CreationTime": { - "description": "Creation timestamp in UNIX epoch time format", - "type": "integer" - }, - "CurrencyCode": { - "enum": [ - "USD", - "CNY" - ], - "type": "string" - }, - "CustomLineItemChargeDetails": { - "$ref": "#/definitions/CustomLineItemChargeDetails" - }, - "Description": { - "maxLength": 255, - "type": "string" - }, - "LastModifiedTime": { - "description": "Latest modified timestamp in UNIX epoch time format", - "type": "integer" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", - "type": "string" - }, - "ProductCode": { - "maxLength": 29, - "minLength": 1, - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModifiedTime", - "/properties/AssociationSize", - "/properties/CurrencyCode", - "/properties/ProductCode" - ], - "required": [ - "Name", - "BillingGroupArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::BillingConductor::CustomLineItem" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BillingGroupArn", + "/properties/AccountId", + "/properties/BillingPeriodRange/InclusiveStartBillingPeriod", + "/properties/BillingPeriodRange/ExclusiveEndBillingPeriod", + "/properties/CustomLineItemChargeDetails/Type" + ], + "definitions": { + "BillingPeriodRange": { + "additionalProperties": false, + "properties": { + "ExclusiveEndBillingPeriod": { + "$ref": "#/definitions/ExclusiveEndBillingPeriod" + }, + "InclusiveStartBillingPeriod": { + "$ref": "#/definitions/InclusiveStartBillingPeriod" + } + }, + "type": "object" + }, + "CustomLineItemChargeDetails": { + "additionalProperties": false, + "properties": { + "Flat": { + "$ref": "#/definitions/CustomLineItemFlatChargeDetails" + }, + "LineItemFilters": { + "$ref": "#/definitions/LineItemFilters" + }, + "Percentage": { + "$ref": "#/definitions/CustomLineItemPercentageChargeDetails" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "CustomLineItemFlatChargeDetails": { + "additionalProperties": false, + "properties": { + "ChargeValue": { + "maximum": 1000000, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "ChargeValue" + ], + "type": "object" + }, + "CustomLineItemPercentageChargeDetails": { + "additionalProperties": false, + "properties": { + "ChildAssociatedResources": { + "insertionOrder": false, + "items": { + "pattern": "(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "PercentageValue": { + "maximum": 10000, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "PercentageValue" + ], + "type": "object" + }, + "ExclusiveEndBillingPeriod": { + "pattern": "\\d{4}-(0?[1-9]|1[012])", + "type": "string" + }, + "InclusiveStartBillingPeriod": { + "pattern": "\\d{4}-(0?[1-9]|1[012])", + "type": "string" + }, + "LineItemFilter": { + "additionalProperties": false, + "properties": { + "Attribute": { + "enum": [ + "LINE_ITEM_TYPE" + ], + "type": "string" + }, + "MatchOption": { + "enum": [ + "NOT_EQUAL" + ], + "type": "string" + }, + "Values": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LineItemFilterValue" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Attribute", + "MatchOption", + "Values" + ], + "type": "object" + }, + "LineItemFilterValue": { + "enum": [ + "SAVINGS_PLAN_NEGATION" + ], + "type": "string" + }, + "LineItemFilters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LineItemFilter" + }, + "type": "array", + "uniqueItems": true + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Type": { + "enum": [ + "FEE", + "CREDIT" + ], + "type": "string" + } + }, + "description": "A custom line item is an one time charge that is applied to a specific billing group's bill.", + "handlers": { + "create": { + "permissions": [ + "billingconductor:CreateCustomLineItem", + "billingconductor:BatchAssociateResourcesToCustomLineItem", + "billingconductor:ListCustomLineItems", + "billingconductor:TagResource", + "billingconductor:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "billingconductor:DeleteCustomLineItem", + "billingconductor:ListCustomLineItems", + "billingconductor:BatchDisassociateResourcesFromCustomLineItem", + "billingconductor:ListResourcesAssociatedToCustomLineItem", + "billingconductor:UntagResource" + ] + }, + "list": { + "permissions": [ + "billingconductor:ListCustomLineItems", + "billingconductor:ListResourcesAssociatedToCustomLineItem", + "billingconductor:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "billingconductor:ListCustomLineItems", + "billingconductor:ListCustomLineItemVersions", + "billingconductor:ListResourcesAssociatedToCustomLineItem", + "billingconductor:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "billingconductor:UpdateCustomLineItem", + "billingconductor:ListCustomLineItems", + "billingconductor:ListResourcesAssociatedToCustomLineItem", + "billingconductor:BatchAssociateResourcesToCustomLineItem", + "billingconductor:BatchDisassociateResourcesFromCustomLineItem", + "billingconductor:TagResource", + "billingconductor:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AccountId": { + "description": "The account which this custom line item will be charged to", + "pattern": "[0-9]{12}", + "type": "string" + }, + "Arn": { + "description": "ARN", + "pattern": "(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}", + "type": "string" + }, + "AssociationSize": { + "description": "Number of source values associated to this custom line item", + "type": "integer" + }, + "BillingGroupArn": { + "description": "Billing Group ARN", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}", + "type": "string" + }, + "BillingPeriodRange": { + "$ref": "#/definitions/BillingPeriodRange" + }, + "CreationTime": { + "description": "Creation timestamp in UNIX epoch time format", + "type": "integer" + }, + "CurrencyCode": { + "enum": [ + "USD", + "CNY" + ], + "type": "string" + }, + "CustomLineItemChargeDetails": { + "$ref": "#/definitions/CustomLineItemChargeDetails" + }, + "Description": { + "maxLength": 255, + "type": "string" + }, + "LastModifiedTime": { + "description": "Latest modified timestamp in UNIX epoch time format", + "type": "integer" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", + "type": "string" + }, + "ProductCode": { + "maxLength": 29, + "minLength": 1, + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModifiedTime", + "/properties/AssociationSize", + "/properties/CurrencyCode", + "/properties/ProductCode" + ], + "required": [ + "Name", + "BillingGroupArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::BillingConductor::CustomLineItem" +} diff --git a/schema/aws-billingconductor-pricingplan.json b/schema/aws-billingconductor-pricingplan.json index 5d8f7f2..407fc5a 100644 --- a/schema/aws-billingconductor-pricingplan.json +++ b/schema/aws-billingconductor-pricingplan.json @@ -1,139 +1,139 @@ -{ - "additionalProperties": false, - "definitions": { - "PricingRuleArn": { - "description": "Pricing Rule ARN", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Pricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.", - "handlers": { - "create": { - "permissions": [ - "billingconductor:CreatePricingPlan", - "billingconductor:AssociatePricingRules", - "billingconductor:ListPricingPlans", - "billingconductor:TagResource", - "billingconductor:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "billingconductor:ListPricingPlans", - "billingconductor:DeletePricingPlan", - "billingconductor:UntagResource" - ] - }, - "list": { - "permissions": [ - "billingconductor:ListPricingPlans", - "billingconductor:ListPricingRulesAssociatedToPricingPlan", - "billingconductor:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "billingconductor:ListPricingPlans", - "billingconductor:ListPricingRulesAssociatedToPricingPlan", - "billingconductor:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "billingconductor:ListPricingPlans", - "billingconductor:UpdatePricingPlan", - "billingconductor:ListPricingRulesAssociatedToPricingPlan", - "billingconductor:AssociatePricingRules", - "billingconductor:DisassociatePricingRules", - "billingconductor:TagResource", - "billingconductor:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Pricing Plan ARN", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}", - "type": "string" - }, - "CreationTime": { - "description": "Creation timestamp in UNIX epoch time format", - "type": "integer" - }, - "Description": { - "maxLength": 1024, - "type": "string" - }, - "LastModifiedTime": { - "description": "Latest modified timestamp in UNIX epoch time format", - "type": "integer" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", - "type": "string" - }, - "PricingRuleArns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PricingRuleArn" - }, - "type": "array" - }, - "Size": { - "description": "Number of associated pricing rules", - "type": "integer" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Size", - "/properties/CreationTime", - "/properties/LastModifiedTime" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::BillingConductor::PricingPlan" -} +{ + "additionalProperties": false, + "definitions": { + "PricingRuleArn": { + "description": "Pricing Rule ARN", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Pricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.", + "handlers": { + "create": { + "permissions": [ + "billingconductor:CreatePricingPlan", + "billingconductor:AssociatePricingRules", + "billingconductor:ListPricingPlans", + "billingconductor:TagResource", + "billingconductor:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "billingconductor:ListPricingPlans", + "billingconductor:DeletePricingPlan", + "billingconductor:UntagResource" + ] + }, + "list": { + "permissions": [ + "billingconductor:ListPricingPlans", + "billingconductor:ListPricingRulesAssociatedToPricingPlan", + "billingconductor:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "billingconductor:ListPricingPlans", + "billingconductor:ListPricingRulesAssociatedToPricingPlan", + "billingconductor:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "billingconductor:ListPricingPlans", + "billingconductor:UpdatePricingPlan", + "billingconductor:ListPricingRulesAssociatedToPricingPlan", + "billingconductor:AssociatePricingRules", + "billingconductor:DisassociatePricingRules", + "billingconductor:TagResource", + "billingconductor:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Pricing Plan ARN", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}", + "type": "string" + }, + "CreationTime": { + "description": "Creation timestamp in UNIX epoch time format", + "type": "integer" + }, + "Description": { + "maxLength": 1024, + "type": "string" + }, + "LastModifiedTime": { + "description": "Latest modified timestamp in UNIX epoch time format", + "type": "integer" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", + "type": "string" + }, + "PricingRuleArns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PricingRuleArn" + }, + "type": "array" + }, + "Size": { + "description": "Number of associated pricing rules", + "type": "integer" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Size", + "/properties/CreationTime", + "/properties/LastModifiedTime" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::BillingConductor::PricingPlan" +} diff --git a/schema/aws-billingconductor-pricingrule.json b/schema/aws-billingconductor-pricingrule.json index d6e8834..9359481 100644 --- a/schema/aws-billingconductor-pricingrule.json +++ b/schema/aws-billingconductor-pricingrule.json @@ -1,210 +1,210 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Scope", - "/properties/Service", - "/properties/BillingEntity", - "/properties/UsageType", - "/properties/Operation" - ], - "definitions": { - "FreeTier": { - "additionalProperties": false, - "description": "The possible customizable free tier configurations.", - "properties": { - "Activated": { - "type": "boolean" - } - }, - "required": [ - "Activated" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.", - "handlers": { - "create": { - "permissions": [ - "billingconductor:CreatePricingRule", - "billingconductor:ListPricingRules", - "billingconductor:TagResource", - "billingconductor:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "billingconductor:DeletePricingRule", - "billingconductor:ListPricingRules", - "billingconductor:UntagResource" - ] - }, - "list": { - "permissions": [ - "billingconductor:ListPricingRules", - "billingconductor:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "billingconductor:ListPricingRules", - "billingconductor:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "billingconductor:UpdatePricingRule", - "billingconductor:ListPricingRules", - "billingconductor:TagResource", - "billingconductor:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Pricing rule ARN", - "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}", - "type": "string" - }, - "AssociatedPricingPlanCount": { - "description": "The number of pricing plans associated with pricing rule", - "minimum": 0, - "type": "integer" - }, - "BillingEntity": { - "description": "The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.", - "enum": [ - "AWS", - "AWS Marketplace", - "AISPL" - ], - "type": "string" - }, - "CreationTime": { - "description": "Creation timestamp in UNIX epoch time format", - "type": "integer" - }, - "Description": { - "description": "Pricing rule description", - "maxLength": 1024, - "type": "string" - }, - "LastModifiedTime": { - "description": "Latest modified timestamp in UNIX epoch time format", - "type": "integer" - }, - "ModifierPercentage": { - "description": "Pricing rule modifier percentage", - "minimum": 0, - "type": "number" - }, - "Name": { - "description": "Pricing rule name", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", - "type": "string" - }, - "Operation": { - "description": "The Operation which a SKU pricing rule is modifying", - "maxLength": 256, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - }, - "Scope": { - "description": "A term used to categorize the granularity of a Pricing Rule.", - "enum": [ - "GLOBAL", - "SERVICE", - "BILLING_ENTITY", - "SKU" - ], - "type": "string" - }, - "Service": { - "description": "The service which a pricing rule is applied on", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\.\\-]+", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Tiering": { - "additionalProperties": false, - "description": "The set of tiering configurations for the pricing rule.", - "properties": { - "FreeTier": { - "$ref": "#/definitions/FreeTier" - } - }, - "type": "object" - }, - "Type": { - "description": "One of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.", - "enum": [ - "MARKUP", - "DISCOUNT", - "TIERING" - ], - "type": "string" - }, - "UsageType": { - "description": "The UsageType which a SKU pricing rule is modifying", - "maxLength": 256, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/AssociatedPricingPlanCount", - "/properties/CreationTime", - "/properties/LastModifiedTime" - ], - "required": [ - "Name", - "Scope", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::BillingConductor::PricingRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Scope", + "/properties/Service", + "/properties/BillingEntity", + "/properties/UsageType", + "/properties/Operation" + ], + "definitions": { + "FreeTier": { + "additionalProperties": false, + "description": "The possible customizable free tier configurations.", + "properties": { + "Activated": { + "type": "boolean" + } + }, + "required": [ + "Activated" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.", + "handlers": { + "create": { + "permissions": [ + "billingconductor:CreatePricingRule", + "billingconductor:ListPricingRules", + "billingconductor:TagResource", + "billingconductor:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "billingconductor:DeletePricingRule", + "billingconductor:ListPricingRules", + "billingconductor:UntagResource" + ] + }, + "list": { + "permissions": [ + "billingconductor:ListPricingRules", + "billingconductor:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "billingconductor:ListPricingRules", + "billingconductor:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "billingconductor:UpdatePricingRule", + "billingconductor:ListPricingRules", + "billingconductor:TagResource", + "billingconductor:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Pricing rule ARN", + "pattern": "arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}", + "type": "string" + }, + "AssociatedPricingPlanCount": { + "description": "The number of pricing plans associated with pricing rule", + "minimum": 0, + "type": "integer" + }, + "BillingEntity": { + "description": "The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.", + "enum": [ + "AWS", + "AWS Marketplace", + "AISPL" + ], + "type": "string" + }, + "CreationTime": { + "description": "Creation timestamp in UNIX epoch time format", + "type": "integer" + }, + "Description": { + "description": "Pricing rule description", + "maxLength": 1024, + "type": "string" + }, + "LastModifiedTime": { + "description": "Latest modified timestamp in UNIX epoch time format", + "type": "integer" + }, + "ModifierPercentage": { + "description": "Pricing rule modifier percentage", + "minimum": 0, + "type": "number" + }, + "Name": { + "description": "Pricing rule name", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\+=\\.\\-@]+", + "type": "string" + }, + "Operation": { + "description": "The Operation which a SKU pricing rule is modifying", + "maxLength": 256, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + }, + "Scope": { + "description": "A term used to categorize the granularity of a Pricing Rule.", + "enum": [ + "GLOBAL", + "SERVICE", + "BILLING_ENTITY", + "SKU" + ], + "type": "string" + }, + "Service": { + "description": "The service which a pricing rule is applied on", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\.\\-]+", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Tiering": { + "additionalProperties": false, + "description": "The set of tiering configurations for the pricing rule.", + "properties": { + "FreeTier": { + "$ref": "#/definitions/FreeTier" + } + }, + "type": "object" + }, + "Type": { + "description": "One of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.", + "enum": [ + "MARKUP", + "DISCOUNT", + "TIERING" + ], + "type": "string" + }, + "UsageType": { + "description": "The UsageType which a SKU pricing rule is modifying", + "maxLength": 256, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/AssociatedPricingPlanCount", + "/properties/CreationTime", + "/properties/LastModifiedTime" + ], + "required": [ + "Name", + "Scope", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-billing-conductor.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::BillingConductor::PricingRule" +} diff --git a/schema/aws-budgets-budget.json b/schema/aws-budgets-budget.json index 08005a6..ba0281a 100644 --- a/schema/aws-budgets-budget.json +++ b/schema/aws-budgets-budget.json @@ -1,246 +1,246 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NotificationsWithSubscribers" - ], - "definitions": { - "AutoAdjustData": { - "additionalProperties": false, - "properties": { - "AutoAdjustType": { - "type": "string" - }, - "HistoricalOptions": { - "$ref": "#/definitions/HistoricalOptions" - } - }, - "required": [ - "AutoAdjustType" - ], - "type": "object" - }, - "BudgetData": { - "additionalProperties": false, - "properties": { - "AutoAdjustData": { - "$ref": "#/definitions/AutoAdjustData" - }, - "BudgetLimit": { - "$ref": "#/definitions/Spend" - }, - "BudgetName": { - "type": "string" - }, - "BudgetType": { - "type": "string" - }, - "CostFilters": { - "type": "object" - }, - "CostTypes": { - "$ref": "#/definitions/CostTypes" - }, - "PlannedBudgetLimits": { - "type": "object" - }, - "TimePeriod": { - "$ref": "#/definitions/TimePeriod" - }, - "TimeUnit": { - "type": "string" - } - }, - "required": [ - "TimeUnit", - "BudgetType" - ], - "type": "object" - }, - "CostTypes": { - "additionalProperties": false, - "properties": { - "IncludeCredit": { - "type": "boolean" - }, - "IncludeDiscount": { - "type": "boolean" - }, - "IncludeOtherSubscription": { - "type": "boolean" - }, - "IncludeRecurring": { - "type": "boolean" - }, - "IncludeRefund": { - "type": "boolean" - }, - "IncludeSubscription": { - "type": "boolean" - }, - "IncludeSupport": { - "type": "boolean" - }, - "IncludeTax": { - "type": "boolean" - }, - "IncludeUpfront": { - "type": "boolean" - }, - "UseAmortized": { - "type": "boolean" - }, - "UseBlended": { - "type": "boolean" - } - }, - "type": "object" - }, - "HistoricalOptions": { - "additionalProperties": false, - "properties": { - "BudgetAdjustmentPeriod": { - "type": "integer" - } - }, - "required": [ - "BudgetAdjustmentPeriod" - ], - "type": "object" - }, - "Notification": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "NotificationType": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "ThresholdType": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "NotificationType", - "Threshold" - ], - "type": "object" - }, - "NotificationWithSubscribers": { - "additionalProperties": false, - "properties": { - "Notification": { - "$ref": "#/definitions/Notification" - }, - "Subscribers": { - "items": { - "$ref": "#/definitions/Subscriber" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Subscribers", - "Notification" - ], - "type": "object" - }, - "ResourceTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "Spend": { - "additionalProperties": false, - "properties": { - "Amount": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Amount", - "Unit" - ], - "type": "object" - }, - "Subscriber": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "SubscriptionType": { - "type": "string" - } - }, - "required": [ - "SubscriptionType", - "Address" - ], - "type": "object" - }, - "TimePeriod": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Budgets::Budget", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Budget": { - "$ref": "#/definitions/BudgetData" - }, - "Id": { - "type": "string" - }, - "NotificationsWithSubscribers": { - "items": { - "$ref": "#/definitions/NotificationWithSubscribers" - }, - "type": "array", - "uniqueItems": false - }, - "ResourceTags": { - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Budget" - ], - "typeName": "AWS::Budgets::Budget" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NotificationsWithSubscribers" + ], + "definitions": { + "AutoAdjustData": { + "additionalProperties": false, + "properties": { + "AutoAdjustType": { + "type": "string" + }, + "HistoricalOptions": { + "$ref": "#/definitions/HistoricalOptions" + } + }, + "required": [ + "AutoAdjustType" + ], + "type": "object" + }, + "BudgetData": { + "additionalProperties": false, + "properties": { + "AutoAdjustData": { + "$ref": "#/definitions/AutoAdjustData" + }, + "BudgetLimit": { + "$ref": "#/definitions/Spend" + }, + "BudgetName": { + "type": "string" + }, + "BudgetType": { + "type": "string" + }, + "CostFilters": { + "type": "object" + }, + "CostTypes": { + "$ref": "#/definitions/CostTypes" + }, + "PlannedBudgetLimits": { + "type": "object" + }, + "TimePeriod": { + "$ref": "#/definitions/TimePeriod" + }, + "TimeUnit": { + "type": "string" + } + }, + "required": [ + "TimeUnit", + "BudgetType" + ], + "type": "object" + }, + "CostTypes": { + "additionalProperties": false, + "properties": { + "IncludeCredit": { + "type": "boolean" + }, + "IncludeDiscount": { + "type": "boolean" + }, + "IncludeOtherSubscription": { + "type": "boolean" + }, + "IncludeRecurring": { + "type": "boolean" + }, + "IncludeRefund": { + "type": "boolean" + }, + "IncludeSubscription": { + "type": "boolean" + }, + "IncludeSupport": { + "type": "boolean" + }, + "IncludeTax": { + "type": "boolean" + }, + "IncludeUpfront": { + "type": "boolean" + }, + "UseAmortized": { + "type": "boolean" + }, + "UseBlended": { + "type": "boolean" + } + }, + "type": "object" + }, + "HistoricalOptions": { + "additionalProperties": false, + "properties": { + "BudgetAdjustmentPeriod": { + "type": "integer" + } + }, + "required": [ + "BudgetAdjustmentPeriod" + ], + "type": "object" + }, + "Notification": { + "additionalProperties": false, + "properties": { + "ComparisonOperator": { + "type": "string" + }, + "NotificationType": { + "type": "string" + }, + "Threshold": { + "type": "number" + }, + "ThresholdType": { + "type": "string" + } + }, + "required": [ + "ComparisonOperator", + "NotificationType", + "Threshold" + ], + "type": "object" + }, + "NotificationWithSubscribers": { + "additionalProperties": false, + "properties": { + "Notification": { + "$ref": "#/definitions/Notification" + }, + "Subscribers": { + "items": { + "$ref": "#/definitions/Subscriber" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Subscribers", + "Notification" + ], + "type": "object" + }, + "ResourceTag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Spend": { + "additionalProperties": false, + "properties": { + "Amount": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "Amount", + "Unit" + ], + "type": "object" + }, + "Subscriber": { + "additionalProperties": false, + "properties": { + "Address": { + "type": "string" + }, + "SubscriptionType": { + "type": "string" + } + }, + "required": [ + "SubscriptionType", + "Address" + ], + "type": "object" + }, + "TimePeriod": { + "additionalProperties": false, + "properties": { + "End": { + "type": "string" + }, + "Start": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Budgets::Budget", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Budget": { + "$ref": "#/definitions/BudgetData" + }, + "Id": { + "type": "string" + }, + "NotificationsWithSubscribers": { + "items": { + "$ref": "#/definitions/NotificationWithSubscribers" + }, + "type": "array", + "uniqueItems": false + }, + "ResourceTags": { + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Budget" + ], + "typeName": "AWS::Budgets::Budget" +} diff --git a/schema/aws-budgets-budgetsaction.json b/schema/aws-budgets-budgetsaction.json index 4291664..bea8fa8 100644 --- a/schema/aws-budgets-budgetsaction.json +++ b/schema/aws-budgets-budgetsaction.json @@ -1,280 +1,280 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ActionType", - "/properties/BudgetName" - ], - "definitions": { - "ActionThreshold": { - "additionalProperties": false, - "properties": { - "Type": { - "enum": [ - "PERCENTAGE", - "ABSOLUTE_VALUE" - ], - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - }, - "Definition": { - "additionalProperties": false, - "properties": { - "IamActionDefinition": { - "$ref": "#/definitions/IamActionDefinition" - }, - "ScpActionDefinition": { - "$ref": "#/definitions/ScpActionDefinition" - }, - "SsmActionDefinition": { - "$ref": "#/definitions/SsmActionDefinition" - } - }, - "type": "object" - }, - "IamActionDefinition": { - "additionalProperties": false, - "properties": { - "Groups": { - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "PolicyArn": { - "type": "string" - }, - "Roles": { - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "Users": { - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "PolicyArn" - ], - "type": "object" - }, - "ResourceTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "ScpActionDefinition": { - "additionalProperties": false, - "properties": { - "PolicyId": { - "type": "string" - }, - "TargetIds": { - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "PolicyId", - "TargetIds" - ], - "type": "object" - }, - "SsmActionDefinition": { - "additionalProperties": false, - "properties": { - "InstanceIds": { - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "Region": { - "type": "string" - }, - "Subtype": { - "enum": [ - "STOP_EC2_INSTANCES", - "STOP_RDS_INSTANCES" - ], - "type": "string" - } - }, - "required": [ - "Subtype", - "Region", - "InstanceIds" - ], - "type": "object" - }, - "Subscriber": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Type": { - "enum": [ - "SNS", - "EMAIL" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Address" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "budgets:CreateBudgetAction", - "iam:PassRole", - "budgets:TagResource" - ] - }, - "delete": { - "permissions": [ - "budgets:DeleteBudgetAction" - ] - }, - "list": { - "permissions": [ - "budgets:DescribeBudgetActionsForAccount", - "budgets:DescribeBudgetActionsForBudget" - ] - }, - "read": { - "permissions": [ - "budgets:DescribeBudgetAction", - "budgets:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "budgets:UpdateBudgetAction", - "iam:PassRole", - "budgets:TagResource", - "budgets:UntagResource", - "budgets:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ActionId", - "/properties/BudgetName" - ], - "properties": { - "ActionId": { - "type": "string" - }, - "ActionThreshold": { - "$ref": "#/definitions/ActionThreshold" - }, - "ActionType": { - "enum": [ - "APPLY_IAM_POLICY", - "APPLY_SCP_POLICY", - "RUN_SSM_DOCUMENTS" - ], - "type": "string" - }, - "ApprovalModel": { - "enum": [ - "AUTOMATIC", - "MANUAL" - ], - "type": "string" - }, - "BudgetName": { - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/Definition" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "NotificationType": { - "enum": [ - "ACTUAL", - "FORECASTED" - ], - "type": "string" - }, - "ResourceTags": { - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "type": "array" - }, - "Subscribers": { - "items": { - "$ref": "#/definitions/Subscriber" - }, - "maxItems": 11, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ActionId" - ], - "required": [ - "BudgetName", - "NotificationType", - "ActionType", - "ActionThreshold", - "ExecutionRoleArn", - "Definition", - "Subscribers" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/ResourceTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Budgets::BudgetsAction" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ActionType", + "/properties/BudgetName" + ], + "definitions": { + "ActionThreshold": { + "additionalProperties": false, + "properties": { + "Type": { + "enum": [ + "PERCENTAGE", + "ABSOLUTE_VALUE" + ], + "type": "string" + }, + "Value": { + "type": "number" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + }, + "Definition": { + "additionalProperties": false, + "properties": { + "IamActionDefinition": { + "$ref": "#/definitions/IamActionDefinition" + }, + "ScpActionDefinition": { + "$ref": "#/definitions/ScpActionDefinition" + }, + "SsmActionDefinition": { + "$ref": "#/definitions/SsmActionDefinition" + } + }, + "type": "object" + }, + "IamActionDefinition": { + "additionalProperties": false, + "properties": { + "Groups": { + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "PolicyArn": { + "type": "string" + }, + "Roles": { + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "Users": { + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "PolicyArn" + ], + "type": "object" + }, + "ResourceTag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "ScpActionDefinition": { + "additionalProperties": false, + "properties": { + "PolicyId": { + "type": "string" + }, + "TargetIds": { + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "PolicyId", + "TargetIds" + ], + "type": "object" + }, + "SsmActionDefinition": { + "additionalProperties": false, + "properties": { + "InstanceIds": { + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "Region": { + "type": "string" + }, + "Subtype": { + "enum": [ + "STOP_EC2_INSTANCES", + "STOP_RDS_INSTANCES" + ], + "type": "string" + } + }, + "required": [ + "Subtype", + "Region", + "InstanceIds" + ], + "type": "object" + }, + "Subscriber": { + "additionalProperties": false, + "properties": { + "Address": { + "type": "string" + }, + "Type": { + "enum": [ + "SNS", + "EMAIL" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Address" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "budgets:CreateBudgetAction", + "iam:PassRole", + "budgets:TagResource" + ] + }, + "delete": { + "permissions": [ + "budgets:DeleteBudgetAction" + ] + }, + "list": { + "permissions": [ + "budgets:DescribeBudgetActionsForAccount", + "budgets:DescribeBudgetActionsForBudget" + ] + }, + "read": { + "permissions": [ + "budgets:DescribeBudgetAction", + "budgets:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "budgets:UpdateBudgetAction", + "iam:PassRole", + "budgets:TagResource", + "budgets:UntagResource", + "budgets:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ActionId", + "/properties/BudgetName" + ], + "properties": { + "ActionId": { + "type": "string" + }, + "ActionThreshold": { + "$ref": "#/definitions/ActionThreshold" + }, + "ActionType": { + "enum": [ + "APPLY_IAM_POLICY", + "APPLY_SCP_POLICY", + "RUN_SSM_DOCUMENTS" + ], + "type": "string" + }, + "ApprovalModel": { + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "type": "string" + }, + "BudgetName": { + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/Definition" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "NotificationType": { + "enum": [ + "ACTUAL", + "FORECASTED" + ], + "type": "string" + }, + "ResourceTags": { + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "type": "array" + }, + "Subscribers": { + "items": { + "$ref": "#/definitions/Subscriber" + }, + "maxItems": 11, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ActionId" + ], + "required": [ + "BudgetName", + "NotificationType", + "ActionType", + "ActionThreshold", + "ExecutionRoleArn", + "Definition", + "Subscribers" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/ResourceTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Budgets::BudgetsAction" +} diff --git a/schema/aws-cassandra-keyspace.json b/schema/aws-cassandra-keyspace.json index 5cc178e..40cec97 100644 --- a/schema/aws-cassandra-keyspace.json +++ b/schema/aws-cassandra-keyspace.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReplicationSpecification", - "/properties/KeyspaceName" - ], - "definitions": { - "RegionList": { - "insertionOrder": false, - "items": { - "enum": [ - "ap-northeast-1", - "ap-northeast-2", - "ap-south-1", - "ap-southeast-1", - "ap-southeast-2", - "ca-central-1", - "eu-central-1", - "eu-north-1", - "eu-west-1", - "eu-west-2", - "eu-west-3", - "sa-east-1", - "us-east-1", - "us-east-2", - "us-west-1", - "us-west-2" - ], - "type": "string" - }, - "maxItems": 6, - "minItems": 2, - "type": "array", - "uniqueItems": true - }, - "ReplicationSpecification": { - "additionalProperties": false, - "default": { - "properties": { - "ReplicationStrategy": { - "const": "SINGLE_REGION", - "type": "string" - } - } - }, - "dependencies": { - "RegionList": [ - "ReplicationStrategy" - ] - }, - "properties": { - "RegionList": { - "$ref": "#/definitions/RegionList" - }, - "ReplicationStrategy": { - "enum": [ - "SINGLE_REGION", - "MULTI_REGION" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Cassandra::Keyspace", - "handlers": { - "create": { - "permissions": [ - "cassandra:Create", - "cassandra:CreateMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "cassandra:TagResource", - "cassandra:TagMultiRegionResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "cassandra:Drop", - "cassandra:DropMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource" - ] - }, - "list": { - "permissions": [ - "cassandra:Select", - "cassandra:SelectMultiRegionResource" - ] - }, - "read": { - "permissions": [ - "cassandra:Select", - "cassandra:SelectMultiRegionResource" - ] - }, - "update": { - "permissions": [ - "cassandra:Alter", - "cassandra:AlterMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "cassandra:TagResource", - "cassandra:TagMultiRegionResource", - "cassandra:UntagResource", - "cassandra:UntagMultiRegionResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyspaceName" - ], - "properties": { - "KeyspaceName": { - "description": "Name for Cassandra keyspace", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", - "type": "string" - }, - "ReplicationSpecification": { - "$ref": "#/definitions/ReplicationSpecification" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "required": [], - "typeName": "AWS::Cassandra::Keyspace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReplicationSpecification", + "/properties/KeyspaceName" + ], + "definitions": { + "RegionList": { + "insertionOrder": false, + "items": { + "enum": [ + "ap-northeast-1", + "ap-northeast-2", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ca-central-1", + "eu-central-1", + "eu-north-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "sa-east-1", + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2" + ], + "type": "string" + }, + "maxItems": 6, + "minItems": 2, + "type": "array", + "uniqueItems": true + }, + "ReplicationSpecification": { + "additionalProperties": false, + "default": { + "properties": { + "ReplicationStrategy": { + "const": "SINGLE_REGION", + "type": "string" + } + } + }, + "dependencies": { + "RegionList": [ + "ReplicationStrategy" + ] + }, + "properties": { + "RegionList": { + "$ref": "#/definitions/RegionList" + }, + "ReplicationStrategy": { + "enum": [ + "SINGLE_REGION", + "MULTI_REGION" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Cassandra::Keyspace", + "handlers": { + "create": { + "permissions": [ + "cassandra:Create", + "cassandra:CreateMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "cassandra:TagResource", + "cassandra:TagMultiRegionResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "cassandra:Drop", + "cassandra:DropMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource" + ] + }, + "list": { + "permissions": [ + "cassandra:Select", + "cassandra:SelectMultiRegionResource" + ] + }, + "read": { + "permissions": [ + "cassandra:Select", + "cassandra:SelectMultiRegionResource" + ] + }, + "update": { + "permissions": [ + "cassandra:Alter", + "cassandra:AlterMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "cassandra:TagResource", + "cassandra:TagMultiRegionResource", + "cassandra:UntagResource", + "cassandra:UntagMultiRegionResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyspaceName" + ], + "properties": { + "KeyspaceName": { + "description": "Name for Cassandra keyspace", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", + "type": "string" + }, + "ReplicationSpecification": { + "$ref": "#/definitions/ReplicationSpecification" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [], + "typeName": "AWS::Cassandra::Keyspace" +} diff --git a/schema/aws-cassandra-table.json b/schema/aws-cassandra-table.json index 4b62acb..ba37d97 100644 --- a/schema/aws-cassandra-table.json +++ b/schema/aws-cassandra-table.json @@ -1,425 +1,425 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KeyspaceName", - "/properties/TableName", - "/properties/PartitionKeyColumns", - "/properties/ClusteringKeyColumns", - "/properties/ClientSideTimestampsEnabled" - ], - "definitions": { - "AutoScalingSetting": { - "additionalProperties": false, - "description": "Represents configuration for auto scaling.", - "properties": { - "AutoScalingDisabled": { - "default": false, - "type": "boolean" - }, - "MaximumUnits": { - "minimum": 1, - "type": "integer" - }, - "MinimumUnits": { - "minimum": 1, - "type": "integer" - }, - "ScalingPolicy": { - "$ref": "#/definitions/ScalingPolicy" - } - }, - "type": "object" - }, - "AutoScalingSpecification": { - "additionalProperties": false, - "description": "Represents the read and write settings used for AutoScaling.", - "properties": { - "ReadCapacityAutoScaling": { - "$ref": "#/definitions/AutoScalingSetting" - }, - "WriteCapacityAutoScaling": { - "$ref": "#/definitions/AutoScalingSetting" - } - }, - "type": "object" - }, - "BillingMode": { - "additionalProperties": false, - "properties": { - "Mode": { - "$ref": "#/definitions/Mode" - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "ClusteringKeyColumn": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/Column" - }, - "OrderBy": { - "default": "ASC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "Column": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", - "type": "string" - }, - "ColumnType": { - "type": "string" - } - }, - "required": [ - "ColumnName", - "ColumnType" - ], - "type": "object" - }, - "EncryptionSpecification": { - "additionalProperties": false, - "description": "Represents the settings used to enable server-side encryption", - "properties": { - "EncryptionType": { - "$ref": "#/definitions/EncryptionType" - }, - "KmsKeyIdentifier": { - "$ref": "#/definitions/KmsKeyIdentifier" - } - }, - "required": [ - "EncryptionType" - ], - "type": "object" - }, - "EncryptionType": { - "default": "AWS_OWNED_KMS_KEY", - "description": "Server-side encryption type", - "enum": [ - "AWS_OWNED_KMS_KEY", - "CUSTOMER_MANAGED_KMS_KEY" - ], - "type": "string" - }, - "KmsKeyIdentifier": { - "description": "The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. ", - "type": "string" - }, - "Mode": { - "default": "ON_DEMAND", - "description": "Capacity mode for the specified table", - "enum": [ - "PROVISIONED", - "ON_DEMAND" - ], - "type": "string" - }, - "ProvisionedThroughput": { - "additionalProperties": false, - "description": "Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits", - "properties": { - "ReadCapacityUnits": { - "minimum": 1, - "type": "integer" - }, - "WriteCapacityUnits": { - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "ReadCapacityUnits", - "WriteCapacityUnits" - ], - "type": "object" - }, - "ReplicaSpecification": { - "additionalProperties": false, - "description": "Represents replica specifications.", - "properties": { - "ReadCapacityAutoScaling": { - "$ref": "#/definitions/AutoScalingSetting" - }, - "ReadCapacityUnits": { - "type": "integer" - }, - "Region": { - "maxLength": 25, - "minLength": 2, - "type": "string" - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "ScalingPolicy": { - "additionalProperties": false, - "description": "Represents scaling policy.", - "properties": { - "TargetTrackingScalingPolicyConfiguration": { - "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to apply to the resource", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetTrackingScalingPolicyConfiguration": { - "additionalProperties": false, - "description": "Represents configuration for target tracking scaling policy.", - "properties": { - "DisableScaleIn": { - "default": "false", - "type": "boolean" - }, - "ScaleInCooldown": { - "default": 0, - "type": "integer" - }, - "ScaleOutCooldown": { - "default": 0, - "type": "integer" - }, - "TargetValue": { - "type": "integer" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Cassandra::Table", - "handlers": { - "create": { - "permissions": [ - "cassandra:Create", - "cassandra:CreateMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "cassandra:TagResource", - "cassandra:TagMultiRegionResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:Encrypt", - "kms:Decrypt", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:PutScalingPolicy", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "cloudwatch:GetMetricData", - "cloudwatch:PutMetricAlarm" - ] - }, - "delete": { - "permissions": [ - "cassandra:Drop", - "cassandra:DropMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:PutScalingPolicy", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "cloudwatch:GetMetricData", - "cloudwatch:PutMetricAlarm" - ] - }, - "list": { - "permissions": [ - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:PutScalingPolicy", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "cloudwatch:GetMetricData", - "cloudwatch:PutMetricAlarm" - ] - }, - "read": { - "permissions": [ - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:PutScalingPolicy", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "cloudwatch:GetMetricData", - "cloudwatch:PutMetricAlarm" - ] - }, - "update": { - "permissions": [ - "cassandra:Alter", - "cassandra:AlterMultiRegionResource", - "cassandra:Select", - "cassandra:SelectMultiRegionResource", - "cassandra:TagResource", - "cassandra:TagMultiRegionResource", - "cassandra:UntagResource", - "cassandra:UntagMultiRegionResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:Encrypt", - "kms:Decrypt", - "application-autoscaling:DescribeScalableTargets", - "application-autoscaling:DescribeScalingPolicies", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:RegisterScalableTarget", - "application-autoscaling:PutScalingPolicy", - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms", - "cloudwatch:GetMetricData", - "cloudwatch:PutMetricAlarm" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyspaceName", - "/properties/TableName" - ], - "properties": { - "AutoScalingSpecifications": { - "$ref": "#/definitions/AutoScalingSpecification" - }, - "BillingMode": { - "$ref": "#/definitions/BillingMode" - }, - "ClientSideTimestampsEnabled": { - "description": "Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.", - "type": "boolean" - }, - "ClusteringKeyColumns": { - "description": "Clustering key columns of the table", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ClusteringKeyColumn" - }, - "type": "array", - "uniqueItems": true - }, - "DefaultTimeToLive": { - "description": "Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.", - "minimum": 0, - "type": "integer" - }, - "EncryptionSpecification": { - "$ref": "#/definitions/EncryptionSpecification" - }, - "KeyspaceName": { - "description": "Name for Cassandra keyspace", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", - "type": "string" - }, - "PartitionKeyColumns": { - "description": "Partition key columns of the table", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Column" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "PointInTimeRecoveryEnabled": { - "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table", - "type": "boolean" - }, - "RegularColumns": { - "description": "Non-key columns of the table", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Column" - }, - "type": "array", - "uniqueItems": true - }, - "ReplicaSpecifications": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ReplicaSpecification" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TableName": { - "description": "Name for Cassandra table", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "KeyspaceName", - "PartitionKeyColumns" - ], - "typeName": "AWS::Cassandra::Table", - "writeOnlyProperties": [ - "/properties/AutoScalingSpecifications", - "/properties/ReplicaSpecifications" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KeyspaceName", + "/properties/TableName", + "/properties/PartitionKeyColumns", + "/properties/ClusteringKeyColumns", + "/properties/ClientSideTimestampsEnabled" + ], + "definitions": { + "AutoScalingSetting": { + "additionalProperties": false, + "description": "Represents configuration for auto scaling.", + "properties": { + "AutoScalingDisabled": { + "default": false, + "type": "boolean" + }, + "MaximumUnits": { + "minimum": 1, + "type": "integer" + }, + "MinimumUnits": { + "minimum": 1, + "type": "integer" + }, + "ScalingPolicy": { + "$ref": "#/definitions/ScalingPolicy" + } + }, + "type": "object" + }, + "AutoScalingSpecification": { + "additionalProperties": false, + "description": "Represents the read and write settings used for AutoScaling.", + "properties": { + "ReadCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + }, + "WriteCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + } + }, + "type": "object" + }, + "BillingMode": { + "additionalProperties": false, + "properties": { + "Mode": { + "$ref": "#/definitions/Mode" + }, + "ProvisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "ClusteringKeyColumn": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/Column" + }, + "OrderBy": { + "default": "ASC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "Column": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", + "type": "string" + }, + "ColumnType": { + "type": "string" + } + }, + "required": [ + "ColumnName", + "ColumnType" + ], + "type": "object" + }, + "EncryptionSpecification": { + "additionalProperties": false, + "description": "Represents the settings used to enable server-side encryption", + "properties": { + "EncryptionType": { + "$ref": "#/definitions/EncryptionType" + }, + "KmsKeyIdentifier": { + "$ref": "#/definitions/KmsKeyIdentifier" + } + }, + "required": [ + "EncryptionType" + ], + "type": "object" + }, + "EncryptionType": { + "default": "AWS_OWNED_KMS_KEY", + "description": "Server-side encryption type", + "enum": [ + "AWS_OWNED_KMS_KEY", + "CUSTOMER_MANAGED_KMS_KEY" + ], + "type": "string" + }, + "KmsKeyIdentifier": { + "description": "The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. ", + "type": "string" + }, + "Mode": { + "default": "ON_DEMAND", + "description": "Capacity mode for the specified table", + "enum": [ + "PROVISIONED", + "ON_DEMAND" + ], + "type": "string" + }, + "ProvisionedThroughput": { + "additionalProperties": false, + "description": "Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits", + "properties": { + "ReadCapacityUnits": { + "minimum": 1, + "type": "integer" + }, + "WriteCapacityUnits": { + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "type": "object" + }, + "ReplicaSpecification": { + "additionalProperties": false, + "description": "Represents replica specifications.", + "properties": { + "ReadCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + }, + "ReadCapacityUnits": { + "type": "integer" + }, + "Region": { + "maxLength": 25, + "minLength": 2, + "type": "string" + } + }, + "required": [ + "Region" + ], + "type": "object" + }, + "ScalingPolicy": { + "additionalProperties": false, + "description": "Represents scaling policy.", + "properties": { + "TargetTrackingScalingPolicyConfiguration": { + "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to apply to the resource", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetTrackingScalingPolicyConfiguration": { + "additionalProperties": false, + "description": "Represents configuration for target tracking scaling policy.", + "properties": { + "DisableScaleIn": { + "default": "false", + "type": "boolean" + }, + "ScaleInCooldown": { + "default": 0, + "type": "integer" + }, + "ScaleOutCooldown": { + "default": 0, + "type": "integer" + }, + "TargetValue": { + "type": "integer" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Cassandra::Table", + "handlers": { + "create": { + "permissions": [ + "cassandra:Create", + "cassandra:CreateMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "cassandra:TagResource", + "cassandra:TagMultiRegionResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:Encrypt", + "kms:Decrypt", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" + ] + }, + "delete": { + "permissions": [ + "cassandra:Drop", + "cassandra:DropMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" + ] + }, + "list": { + "permissions": [ + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" + ] + }, + "read": { + "permissions": [ + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" + ] + }, + "update": { + "permissions": [ + "cassandra:Alter", + "cassandra:AlterMultiRegionResource", + "cassandra:Select", + "cassandra:SelectMultiRegionResource", + "cassandra:TagResource", + "cassandra:TagMultiRegionResource", + "cassandra:UntagResource", + "cassandra:UntagMultiRegionResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:Encrypt", + "kms:Decrypt", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyspaceName", + "/properties/TableName" + ], + "properties": { + "AutoScalingSpecifications": { + "$ref": "#/definitions/AutoScalingSpecification" + }, + "BillingMode": { + "$ref": "#/definitions/BillingMode" + }, + "ClientSideTimestampsEnabled": { + "description": "Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.", + "type": "boolean" + }, + "ClusteringKeyColumns": { + "description": "Clustering key columns of the table", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ClusteringKeyColumn" + }, + "type": "array", + "uniqueItems": true + }, + "DefaultTimeToLive": { + "description": "Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.", + "minimum": 0, + "type": "integer" + }, + "EncryptionSpecification": { + "$ref": "#/definitions/EncryptionSpecification" + }, + "KeyspaceName": { + "description": "Name for Cassandra keyspace", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", + "type": "string" + }, + "PartitionKeyColumns": { + "description": "Partition key columns of the table", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Column" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "PointInTimeRecoveryEnabled": { + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table", + "type": "boolean" + }, + "RegularColumns": { + "description": "Non-key columns of the table", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Column" + }, + "type": "array", + "uniqueItems": true + }, + "ReplicaSpecifications": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ReplicaSpecification" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TableName": { + "description": "Name for Cassandra table", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "KeyspaceName", + "PartitionKeyColumns" + ], + "typeName": "AWS::Cassandra::Table", + "writeOnlyProperties": [ + "/properties/AutoScalingSpecifications", + "/properties/ReplicaSpecifications" + ] +} diff --git a/schema/aws-ce-anomalymonitor.json b/schema/aws-ce-anomalymonitor.json index 7f75034..126b660 100644 --- a/schema/aws-ce-anomalymonitor.json +++ b/schema/aws-ce-anomalymonitor.json @@ -1,153 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MonitorType", - "/properties/MonitorDimension", - "/properties/MonitorSpecification", - "/properties/ResourceTags" - ], - "definitions": { - "Arn": { - "description": "Monitor ARN", - "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", - "type": "string" - }, - "ResourceTag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name for the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.", - "handlers": { - "create": { - "permissions": [ - "ce:CreateAnomalyMonitor", - "ce:TagResource" - ] - }, - "delete": { - "permissions": [ - "ce:DeleteAnomalyMonitor" - ] - }, - "list": { - "permissions": [ - "ce:GetAnomalyMonitors" - ] - }, - "read": { - "permissions": [ - "ce:GetAnomalyMonitors" - ] - }, - "update": { - "permissions": [ - "ce:UpdateAnomalyMonitor" - ] - } - }, - "primaryIdentifier": [ - "/properties/MonitorArn" - ], - "properties": { - "CreationDate": { - "description": "The date when the monitor was created. ", - "maxLength": 40, - "minLength": 0, - "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?", - "type": "string" - }, - "DimensionalValueCount": { - "description": "The value for evaluated dimensions.", - "minimum": 0, - "type": "integer" - }, - "LastEvaluatedDate": { - "description": "The date when the monitor last evaluated for anomalies.", - "maxLength": 40, - "minLength": 0, - "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?|(NOT_EVALUATED_YET)", - "type": "string" - }, - "LastUpdatedDate": { - "description": "The date when the monitor was last updated.", - "maxLength": 40, - "minLength": 0, - "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?", - "type": "string" - }, - "MonitorArn": { - "$ref": "#/definitions/Arn" - }, - "MonitorDimension": { - "description": "The dimensions to evaluate", - "enum": [ - "SERVICE" - ], - "type": "string" - }, - "MonitorName": { - "description": "The name of the monitor.", - "maxLength": 1024, - "minLength": 0, - "pattern": "[\\S\\s]*", - "type": "string" - }, - "MonitorSpecification": { - "type": "string" - }, - "MonitorType": { - "enum": [ - "DIMENSIONAL", - "CUSTOM" - ], - "type": "string" - }, - "ResourceTags": { - "description": "Tags to assign to monitor.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/MonitorArn", - "/properties/CreationDate", - "/properties/LastEvaluatedDate", - "/properties/LastUpdatedDate", - "/properties/DimensionalValueCount" - ], - "required": [ - "MonitorName", - "MonitorType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::CE::AnomalyMonitor", - "writeOnlyProperties": [ - "/properties/ResourceTags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MonitorType", + "/properties/MonitorDimension", + "/properties/MonitorSpecification", + "/properties/ResourceTags" + ], + "definitions": { + "Arn": { + "description": "Monitor ARN", + "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", + "type": "string" + }, + "ResourceTag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name for the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.", + "handlers": { + "create": { + "permissions": [ + "ce:CreateAnomalyMonitor", + "ce:TagResource" + ] + }, + "delete": { + "permissions": [ + "ce:DeleteAnomalyMonitor" + ] + }, + "list": { + "permissions": [ + "ce:GetAnomalyMonitors" + ] + }, + "read": { + "permissions": [ + "ce:GetAnomalyMonitors" + ] + }, + "update": { + "permissions": [ + "ce:UpdateAnomalyMonitor" + ] + } + }, + "primaryIdentifier": [ + "/properties/MonitorArn" + ], + "properties": { + "CreationDate": { + "description": "The date when the monitor was created. ", + "maxLength": 40, + "minLength": 0, + "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?", + "type": "string" + }, + "DimensionalValueCount": { + "description": "The value for evaluated dimensions.", + "minimum": 0, + "type": "integer" + }, + "LastEvaluatedDate": { + "description": "The date when the monitor last evaluated for anomalies.", + "maxLength": 40, + "minLength": 0, + "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?|(NOT_EVALUATED_YET)", + "type": "string" + }, + "LastUpdatedDate": { + "description": "The date when the monitor was last updated.", + "maxLength": 40, + "minLength": 0, + "pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?", + "type": "string" + }, + "MonitorArn": { + "$ref": "#/definitions/Arn" + }, + "MonitorDimension": { + "description": "The dimensions to evaluate", + "enum": [ + "SERVICE" + ], + "type": "string" + }, + "MonitorName": { + "description": "The name of the monitor.", + "maxLength": 1024, + "minLength": 0, + "pattern": "[\\S\\s]*", + "type": "string" + }, + "MonitorSpecification": { + "type": "string" + }, + "MonitorType": { + "enum": [ + "DIMENSIONAL", + "CUSTOM" + ], + "type": "string" + }, + "ResourceTags": { + "description": "Tags to assign to monitor.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/MonitorArn", + "/properties/CreationDate", + "/properties/LastEvaluatedDate", + "/properties/LastUpdatedDate", + "/properties/DimensionalValueCount" + ], + "required": [ + "MonitorName", + "MonitorType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::CE::AnomalyMonitor", + "writeOnlyProperties": [ + "/properties/ResourceTags" + ] +} diff --git a/schema/aws-ce-anomalysubscription.json b/schema/aws-ce-anomalysubscription.json index e754b70..8718593 100644 --- a/schema/aws-ce-anomalysubscription.json +++ b/schema/aws-ce-anomalysubscription.json @@ -1,175 +1,175 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceTags" - ], - "definitions": { - "Arn": { - "description": "Subscription ARN", - "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", - "type": "string" - }, - "ResourceTag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name for the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Subscriber": { - "additionalProperties": false, - "properties": { - "Address": { - "pattern": "(^[a-zA-Z0-9.!#$%&'*+=?^_\u2018{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)", - "type": "string" - }, - "Status": { - "enum": [ - "CONFIRMED", - "DECLINED" - ], - "type": "string" - }, - "Type": { - "enum": [ - "EMAIL", - "SNS" - ], - "type": "string" - } - }, - "required": [ - "Address", - "Type" - ], - "type": "object" - } - }, - "description": "AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified", - "handlers": { - "create": { - "permissions": [ - "ce:CreateAnomalySubscription", - "ce:TagResource" - ] - }, - "delete": { - "permissions": [ - "ce:DeleteAnomalySubscription" - ] - }, - "list": { - "permissions": [ - "ce:GetAnomalySubscriptions" - ] - }, - "read": { - "permissions": [ - "ce:GetAnomalySubscriptions" - ] - }, - "update": { - "permissions": [ - "ce:UpdateAnomalySubscription" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubscriptionArn" - ], - "properties": { - "AccountId": { - "description": "The accountId", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Frequency": { - "description": "The frequency at which anomaly reports are sent over email. ", - "enum": [ - "DAILY", - "IMMEDIATE", - "WEEKLY" - ], - "type": "string" - }, - "MonitorArnList": { - "description": "A list of cost anomaly monitors.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array" - }, - "ResourceTags": { - "description": "Tags to assign to subscription.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Subscribers": { - "description": "A list of subscriber", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Subscriber" - }, - "type": "array" - }, - "SubscriptionArn": { - "$ref": "#/definitions/Arn" - }, - "SubscriptionName": { - "description": "The name of the subscription.", - "maxLength": 1024, - "minLength": 0, - "pattern": "[\\S\\s]*", - "type": "string" - }, - "Threshold": { - "description": "The dollar value that triggers a notification if the threshold is exceeded. ", - "minimum": 0, - "type": "number" - }, - "ThresholdExpression": { - "description": "An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SubscriptionArn", - "/properties/AccountId", - "/properties/Subscribers/*/Status" - ], - "required": [ - "MonitorArnList", - "Subscribers", - "Frequency", - "SubscriptionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::CE::AnomalySubscription", - "writeOnlyProperties": [ - "/properties/ResourceTags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceTags" + ], + "definitions": { + "Arn": { + "description": "Subscription ARN", + "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", + "type": "string" + }, + "ResourceTag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name for the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Subscriber": { + "additionalProperties": false, + "properties": { + "Address": { + "pattern": "(^[a-zA-Z0-9.!#$%&'*+=?^_\u2018{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)", + "type": "string" + }, + "Status": { + "enum": [ + "CONFIRMED", + "DECLINED" + ], + "type": "string" + }, + "Type": { + "enum": [ + "EMAIL", + "SNS" + ], + "type": "string" + } + }, + "required": [ + "Address", + "Type" + ], + "type": "object" + } + }, + "description": "AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified", + "handlers": { + "create": { + "permissions": [ + "ce:CreateAnomalySubscription", + "ce:TagResource" + ] + }, + "delete": { + "permissions": [ + "ce:DeleteAnomalySubscription" + ] + }, + "list": { + "permissions": [ + "ce:GetAnomalySubscriptions" + ] + }, + "read": { + "permissions": [ + "ce:GetAnomalySubscriptions" + ] + }, + "update": { + "permissions": [ + "ce:UpdateAnomalySubscription" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriptionArn" + ], + "properties": { + "AccountId": { + "description": "The accountId", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Frequency": { + "description": "The frequency at which anomaly reports are sent over email. ", + "enum": [ + "DAILY", + "IMMEDIATE", + "WEEKLY" + ], + "type": "string" + }, + "MonitorArnList": { + "description": "A list of cost anomaly monitors.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array" + }, + "ResourceTags": { + "description": "Tags to assign to subscription.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Subscribers": { + "description": "A list of subscriber", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Subscriber" + }, + "type": "array" + }, + "SubscriptionArn": { + "$ref": "#/definitions/Arn" + }, + "SubscriptionName": { + "description": "The name of the subscription.", + "maxLength": 1024, + "minLength": 0, + "pattern": "[\\S\\s]*", + "type": "string" + }, + "Threshold": { + "description": "The dollar value that triggers a notification if the threshold is exceeded. ", + "minimum": 0, + "type": "number" + }, + "ThresholdExpression": { + "description": "An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SubscriptionArn", + "/properties/AccountId", + "/properties/Subscribers/*/Status" + ], + "required": [ + "MonitorArnList", + "Subscribers", + "Frequency", + "SubscriptionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::CE::AnomalySubscription", + "writeOnlyProperties": [ + "/properties/ResourceTags" + ] +} diff --git a/schema/aws-ce-costcategory.json b/schema/aws-ce-costcategory.json index c6e4e41..18cddd6 100644 --- a/schema/aws-ce-costcategory.json +++ b/schema/aws-ce-costcategory.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ZonedDateTime": { - "description": "ISO 8601 date time with offset format", - "maxLength": 25, - "minLength": 20, - "pattern": "^\\d{4}-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(([+-]\\d\\d:\\d\\d)|Z)$", - "type": "string" - } - }, - "description": "Cost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.", - "handlers": { - "create": { - "permissions": [ - "ce:CreateCostCategoryDefinition" - ] - }, - "delete": { - "permissions": [ - "ce:DeleteCostCategoryDefinition" - ] - }, - "list": { - "permissions": [ - "ce:ListCostCategoryDefinitions" - ] - }, - "read": { - "permissions": [ - "ce:DescribeCostCategoryDefinition" - ] - }, - "update": { - "permissions": [ - "ce:UpdateCostCategoryDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Cost category ARN", - "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", - "type": "string" - }, - "DefaultValue": { - "description": "The default value for the cost category", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "EffectiveStart": { - "$ref": "#/definitions/ZonedDateTime" - }, - "Name": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "RuleVersion": { - "enum": [ - "CostCategoryExpression.v1" - ], - "type": "string" - }, - "Rules": { - "description": "JSON array format of Expression in Billing and Cost Management API", - "type": "string" - }, - "SplitChargeRules": { - "description": "Json array format of CostCategorySplitChargeRule in Billing and Cost Management API", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/EffectiveStart" - ], - "required": [ - "Name", - "RuleVersion", - "Rules" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cost-explorer.git", - "typeName": "AWS::CE::CostCategory" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ZonedDateTime": { + "description": "ISO 8601 date time with offset format", + "maxLength": 25, + "minLength": 20, + "pattern": "^\\d{4}-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(([+-]\\d\\d:\\d\\d)|Z)$", + "type": "string" + } + }, + "description": "Cost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.", + "handlers": { + "create": { + "permissions": [ + "ce:CreateCostCategoryDefinition" + ] + }, + "delete": { + "permissions": [ + "ce:DeleteCostCategoryDefinition" + ] + }, + "list": { + "permissions": [ + "ce:ListCostCategoryDefinitions" + ] + }, + "read": { + "permissions": [ + "ce:DescribeCostCategoryDefinition" + ] + }, + "update": { + "permissions": [ + "ce:UpdateCostCategoryDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Cost category ARN", + "pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$", + "type": "string" + }, + "DefaultValue": { + "description": "The default value for the cost category", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "EffectiveStart": { + "$ref": "#/definitions/ZonedDateTime" + }, + "Name": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "RuleVersion": { + "enum": [ + "CostCategoryExpression.v1" + ], + "type": "string" + }, + "Rules": { + "description": "JSON array format of Expression in Billing and Cost Management API", + "type": "string" + }, + "SplitChargeRules": { + "description": "Json array format of CostCategorySplitChargeRule in Billing and Cost Management API", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/EffectiveStart" + ], + "required": [ + "Name", + "RuleVersion", + "Rules" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cost-explorer.git", + "typeName": "AWS::CE::CostCategory" +} diff --git a/schema/aws-certificatemanager-account.json b/schema/aws-certificatemanager-account.json index 5668a32..6dfa9dd 100644 --- a/schema/aws-certificatemanager-account.json +++ b/schema/aws-certificatemanager-account.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "definitions": { - "AccountId": { - "type": "string" - }, - "ExpiryEventsConfiguration": { - "additionalProperties": false, - "properties": { - "DaysBeforeExpiry": { - "maximum": 45, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::CertificateManager::Account.", - "handlers": { - "create": { - "permissions": [ - "acm:GetAccountConfiguration", - "acm:PutAccountConfiguration" - ] - }, - "delete": { - "permissions": [ - "acm:GetAccountConfiguration", - "acm:PutAccountConfiguration" - ] - }, - "read": { - "permissions": [ - "acm:GetAccountConfiguration" - ] - }, - "update": { - "permissions": [ - "acm:GetAccountConfiguration", - "acm:PutAccountConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "$ref": "#/definitions/AccountId" - }, - "ExpiryEventsConfiguration": { - "$ref": "#/definitions/ExpiryEventsConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "required": [ - "ExpiryEventsConfiguration" - ], - "typeName": "AWS::CertificateManager::Account" -} +{ + "additionalProperties": false, + "definitions": { + "AccountId": { + "type": "string" + }, + "ExpiryEventsConfiguration": { + "additionalProperties": false, + "properties": { + "DaysBeforeExpiry": { + "maximum": 45, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::CertificateManager::Account.", + "handlers": { + "create": { + "permissions": [ + "acm:GetAccountConfiguration", + "acm:PutAccountConfiguration" + ] + }, + "delete": { + "permissions": [ + "acm:GetAccountConfiguration", + "acm:PutAccountConfiguration" + ] + }, + "read": { + "permissions": [ + "acm:GetAccountConfiguration" + ] + }, + "update": { + "permissions": [ + "acm:GetAccountConfiguration", + "acm:PutAccountConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "$ref": "#/definitions/AccountId" + }, + "ExpiryEventsConfiguration": { + "$ref": "#/definitions/ExpiryEventsConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "required": [ + "ExpiryEventsConfiguration" + ], + "typeName": "AWS::CertificateManager::Account" +} diff --git a/schema/aws-certificatemanager-certificate.json b/schema/aws-certificatemanager-certificate.json index 0150d91..4dfb149 100644 --- a/schema/aws-certificatemanager-certificate.json +++ b/schema/aws-certificatemanager-certificate.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubjectAlternativeNames", - "/properties/DomainValidationOptions", - "/properties/ValidationMethod", - "/properties/KeyAlgorithm", - "/properties/DomainName", - "/properties/CertificateAuthorityArn" - ], - "definitions": { - "DomainValidationOption": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "ValidationDomain": { - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CertificateManager::Certificate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CertificateAuthorityArn": { - "type": "string" - }, - "CertificateTransparencyLoggingPreference": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "DomainValidationOptions": { - "items": { - "$ref": "#/definitions/DomainValidationOption" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "type": "string" - }, - "KeyAlgorithm": { - "type": "string" - }, - "SubjectAlternativeNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "ValidationMethod": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DomainName" - ], - "typeName": "AWS::CertificateManager::Certificate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubjectAlternativeNames", + "/properties/DomainValidationOptions", + "/properties/ValidationMethod", + "/properties/KeyAlgorithm", + "/properties/DomainName", + "/properties/CertificateAuthorityArn" + ], + "definitions": { + "DomainValidationOption": { + "additionalProperties": false, + "properties": { + "DomainName": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "ValidationDomain": { + "type": "string" + } + }, + "required": [ + "DomainName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CertificateManager::Certificate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CertificateAuthorityArn": { + "type": "string" + }, + "CertificateTransparencyLoggingPreference": { + "type": "string" + }, + "DomainName": { + "type": "string" + }, + "DomainValidationOptions": { + "items": { + "$ref": "#/definitions/DomainValidationOption" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "type": "string" + }, + "KeyAlgorithm": { + "type": "string" + }, + "SubjectAlternativeNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "ValidationMethod": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DomainName" + ], + "typeName": "AWS::CertificateManager::Certificate" +} diff --git a/schema/aws-chatbot-microsoftteamschannelconfiguration.json b/schema/aws-chatbot-microsoftteamschannelconfiguration.json index bca7708..824630b 100644 --- a/schema/aws-chatbot-microsoftteamschannelconfiguration.json +++ b/schema/aws-chatbot-microsoftteamschannelconfiguration.json @@ -1,162 +1,162 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TeamId", - "/properties/TeamsTenantId", - "/properties/ConfigurationName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.", - "handlers": { - "create": { - "permissions": [ - "chatbot:CreateMicrosoftTeamsChannelConfiguration", - "chatbot:TagResource", - "iam:PassRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "chatbot:GetMicrosoftTeamsChannelConfiguration", - "chatbot:DeleteMicrosoftTeamsChannelConfiguration" - ] - }, - "list": { - "permissions": [ - "chatbot:ListMicrosoftTeamsChannelConfigurations" - ] - }, - "read": { - "permissions": [ - "chatbot:GetMicrosoftTeamsChannelConfiguration" - ] - }, - "update": { - "permissions": [ - "chatbot:UpdateMicrosoftTeamsChannelConfiguration", - "chatbot:TagResource", - "chatbot:UntagResource", - "chatbot:ListTagsForResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN) of the configuration", - "pattern": "^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "ConfigurationName": { - "description": "The name of the configuration", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9-_]+$", - "type": "string" - }, - "GuardrailPolicies": { - "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.", - "insertionOrder": false, - "items": { - "pattern": "^(^$|arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$", - "type": "string" - }, - "type": "array" - }, - "IamRoleArn": { - "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot", - "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "LoggingLevel": { - "default": "NONE", - "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs", - "pattern": "^(ERROR|INFO|NONE)$", - "type": "string" - }, - "SnsTopicArns": { - "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.", - "insertionOrder": false, - "items": { - "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "The tags to add to the configuration", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TeamId": { - "description": "The id of the Microsoft Teams team", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$", - "type": "string" - }, - "TeamsChannelId": { - "description": "The id of the Microsoft Teams channel", - "maxLength": 256, - "minLength": 1, - "pattern": "^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$", - "type": "string" - }, - "TeamsTenantId": { - "description": "The id of the Microsoft Teams tenant", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$", - "type": "string" - }, - "UserRoleRequired": { - "default": false, - "description": "Enables use of a user role requirement in your chat configuration", - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "TeamId", - "TeamsChannelId", - "TeamsTenantId", - "ConfigurationName", - "IamRoleArn" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TeamId", + "/properties/TeamsTenantId", + "/properties/ConfigurationName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.", + "handlers": { + "create": { + "permissions": [ + "chatbot:CreateMicrosoftTeamsChannelConfiguration", + "chatbot:TagResource", + "iam:PassRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "chatbot:GetMicrosoftTeamsChannelConfiguration", + "chatbot:DeleteMicrosoftTeamsChannelConfiguration" + ] + }, + "list": { + "permissions": [ + "chatbot:ListMicrosoftTeamsChannelConfigurations" + ] + }, + "read": { + "permissions": [ + "chatbot:GetMicrosoftTeamsChannelConfiguration" + ] + }, + "update": { + "permissions": [ + "chatbot:UpdateMicrosoftTeamsChannelConfiguration", + "chatbot:TagResource", + "chatbot:UntagResource", + "chatbot:ListTagsForResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN) of the configuration", + "pattern": "^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "ConfigurationName": { + "description": "The name of the configuration", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9-_]+$", + "type": "string" + }, + "GuardrailPolicies": { + "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.", + "insertionOrder": false, + "items": { + "pattern": "^(^$|arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$", + "type": "string" + }, + "type": "array" + }, + "IamRoleArn": { + "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot", + "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "LoggingLevel": { + "default": "NONE", + "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs", + "pattern": "^(ERROR|INFO|NONE)$", + "type": "string" + }, + "SnsTopicArns": { + "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.", + "insertionOrder": false, + "items": { + "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "The tags to add to the configuration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TeamId": { + "description": "The id of the Microsoft Teams team", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$", + "type": "string" + }, + "TeamsChannelId": { + "description": "The id of the Microsoft Teams channel", + "maxLength": 256, + "minLength": 1, + "pattern": "^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$", + "type": "string" + }, + "TeamsTenantId": { + "description": "The id of the Microsoft Teams tenant", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$", + "type": "string" + }, + "UserRoleRequired": { + "default": false, + "description": "Enables use of a user role requirement in your chat configuration", + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "TeamId", + "TeamsChannelId", + "TeamsTenantId", + "ConfigurationName", + "IamRoleArn" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" +} diff --git a/schema/aws-chatbot-slackchannelconfiguration.json b/schema/aws-chatbot-slackchannelconfiguration.json index 7c6b9fb..1aa7f58 100644 --- a/schema/aws-chatbot-slackchannelconfiguration.json +++ b/schema/aws-chatbot-slackchannelconfiguration.json @@ -1,152 +1,152 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SlackWorkspaceId", - "/properties/ConfigurationName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Chatbot::SlackChannelConfiguration.", - "handlers": { - "create": { - "permissions": [ - "chatbot:CreateSlackChannelConfiguration", - "chatbot:TagResource", - "iam:PassRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "chatbot:DeleteSlackChannelConfiguration" - ] - }, - "list": { - "permissions": [ - "chatbot:DescribeSlackChannelConfigurations" - ] - }, - "read": { - "permissions": [ - "chatbot:DescribeSlackChannelConfigurations" - ] - }, - "update": { - "permissions": [ - "chatbot:UpdateSlackChannelConfiguration", - "chatbot:TagResource", - "chatbot:UntagResource", - "chatbot:ListTagsForResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN) of the configuration", - "pattern": "^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "ConfigurationName": { - "description": "The name of the configuration", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9-_]+$", - "type": "string" - }, - "GuardrailPolicies": { - "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.", - "insertionOrder": false, - "items": { - "pattern": "^(^$|arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$", - "type": "string" - }, - "type": "array" - }, - "IamRoleArn": { - "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot", - "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "LoggingLevel": { - "default": "NONE", - "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs", - "pattern": "^(ERROR|INFO|NONE)$", - "type": "string" - }, - "SlackChannelId": { - "description": "The id of the Slack channel", - "maxLength": 256, - "minLength": 1, - "pattern": "^[A-Za-z0-9]+$", - "type": "string" - }, - "SlackWorkspaceId": { - "description": "The id of the Slack workspace", - "maxLength": 256, - "minLength": 1, - "pattern": "^[0-9A-Z]{1,255}$", - "type": "string" - }, - "SnsTopicArns": { - "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.", - "insertionOrder": false, - "items": { - "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "The tags to add to the configuration", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserRoleRequired": { - "default": false, - "description": "Enables use of a user role requirement in your chat configuration", - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "SlackWorkspaceId", - "SlackChannelId", - "ConfigurationName", - "IamRoleArn" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Chatbot::SlackChannelConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SlackWorkspaceId", + "/properties/ConfigurationName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Chatbot::SlackChannelConfiguration.", + "handlers": { + "create": { + "permissions": [ + "chatbot:CreateSlackChannelConfiguration", + "chatbot:TagResource", + "iam:PassRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "chatbot:DeleteSlackChannelConfiguration" + ] + }, + "list": { + "permissions": [ + "chatbot:DescribeSlackChannelConfigurations" + ] + }, + "read": { + "permissions": [ + "chatbot:DescribeSlackChannelConfigurations" + ] + }, + "update": { + "permissions": [ + "chatbot:UpdateSlackChannelConfiguration", + "chatbot:TagResource", + "chatbot:UntagResource", + "chatbot:ListTagsForResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN) of the configuration", + "pattern": "^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "ConfigurationName": { + "description": "The name of the configuration", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9-_]+$", + "type": "string" + }, + "GuardrailPolicies": { + "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.", + "insertionOrder": false, + "items": { + "pattern": "^(^$|arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$", + "type": "string" + }, + "type": "array" + }, + "IamRoleArn": { + "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot", + "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "LoggingLevel": { + "default": "NONE", + "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs", + "pattern": "^(ERROR|INFO|NONE)$", + "type": "string" + }, + "SlackChannelId": { + "description": "The id of the Slack channel", + "maxLength": 256, + "minLength": 1, + "pattern": "^[A-Za-z0-9]+$", + "type": "string" + }, + "SlackWorkspaceId": { + "description": "The id of the Slack workspace", + "maxLength": 256, + "minLength": 1, + "pattern": "^[0-9A-Z]{1,255}$", + "type": "string" + }, + "SnsTopicArns": { + "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.", + "insertionOrder": false, + "items": { + "pattern": "^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "The tags to add to the configuration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserRoleRequired": { + "default": false, + "description": "Enables use of a user role requirement in your chat configuration", + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "SlackWorkspaceId", + "SlackChannelId", + "ConfigurationName", + "IamRoleArn" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Chatbot::SlackChannelConfiguration" +} diff --git a/schema/aws-cleanrooms-analysistemplate.json b/schema/aws-cleanrooms-analysistemplate.json index c65b94c..c37cfb3 100644 --- a/schema/aws-cleanrooms-analysistemplate.json +++ b/schema/aws-cleanrooms-analysistemplate.json @@ -1,267 +1,272 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/MembershipIdentifier", - "/properties/Source", - "/properties/Source/Text", - "/properties/Format", - "/properties/AnalysisParameters", - "/properties/AnalysisParameters/Name", - "/properties/AnalysisParameters/Type", - "/properties/AnalysisParameters/DefaultValue" - ], - "definitions": { - "AnalysisParameter": { - "additionalProperties": false, - "properties": { - "DefaultValue": { - "maxLength": 250, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "[0-9a-zA-Z_]+", - "type": "string" - }, - "Type": { - "enum": [ - "SMALLINT", - "INTEGER", - "BIGINT", - "DECIMAL", - "REAL", - "DOUBLE_PRECISION", - "BOOLEAN", - "CHAR", - "VARCHAR", - "DATE", - "TIMESTAMP", - "TIMESTAMPTZ", - "TIME", - "TIMETZ", - "VARBYTE" - ], - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AnalysisSchema": { - "additionalProperties": false, - "properties": { - "ReferencedTables": { - "$ref": "#/definitions/ReferencedTables" - } - }, - "required": [ - "ReferencedTables" - ], - "type": "object" - }, - "AnalysisSource": { - "additionalProperties": false, - "properties": { - "Text": { - "maxLength": 15000, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Text" - ], - "type": "object" - }, - "ReferencedTables": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TableName" - }, - "minItems": 0, - "type": "array" - }, - "TableName": { - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents a stored analysis within a collaboration", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreateAnalysisTemplate", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:GetAnalysisTemplate", - "cleanrooms:ListAnalysisTemplates" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeleteAnalysisTemplate", - "cleanrooms:GetAnalysisTemplate", - "cleanrooms:ListAnalysisTemplates", - "cleanrooms:ListTagsForResource", - "cleanrooms:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "MembershipIdentifier": { - "$ref": "resource-schema.json#/properties/MembershipIdentifier" - } - }, - "required": [ - "MembershipIdentifier" - ] - }, - "permissions": [ - "cleanrooms:ListAnalysisTemplates" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetAnalysisTemplate", - "cleanrooms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdateAnalysisTemplate", - "cleanrooms:GetAnalysisTemplate", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AnalysisTemplateIdentifier", - "/properties/MembershipIdentifier" - ], - "properties": { - "AnalysisParameters": { - "description": "The member who can query can provide this placeholder for a literal data value in an analysis template", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisParameter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "AnalysisTemplateIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Arn": { - "maxLength": 200, - "type": "string" - }, - "CollaborationArn": { - "maxLength": 100, - "type": "string" - }, - "CollaborationIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Description": { - "maxLength": 255, - "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", - "type": "string" - }, - "Format": { - "enum": [ - "SQL" - ], - "type": "string" - }, - "MembershipArn": { - "maxLength": 100, - "type": "string" - }, - "MembershipIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Name": { - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - }, - "Schema": { - "$ref": "#/definitions/AnalysisSchema" - }, - "Source": { - "$ref": "#/definitions/AnalysisSource" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CollaborationArn", - "/properties/CollaborationIdentifier", - "/properties/AnalysisTemplateIdentifier", - "/properties/Schema", - "/properties/Arn", - "/properties/MembershipArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Source", - "Format", - "Name", - "MembershipIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::AnalysisTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/MembershipIdentifier", + "/properties/Source", + "/properties/Source/Text", + "/properties/Format", + "/properties/AnalysisParameters", + "/properties/AnalysisParameters/Name", + "/properties/AnalysisParameters/Type", + "/properties/AnalysisParameters/DefaultValue" + ], + "definitions": { + "AnalysisParameter": { + "additionalProperties": false, + "properties": { + "DefaultValue": { + "maxLength": 250, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "[0-9a-zA-Z_]+", + "type": "string" + }, + "Type": { + "enum": [ + "SMALLINT", + "INTEGER", + "BIGINT", + "DECIMAL", + "REAL", + "DOUBLE_PRECISION", + "BOOLEAN", + "CHAR", + "VARCHAR", + "DATE", + "TIMESTAMP", + "TIMESTAMPTZ", + "TIME", + "TIMETZ", + "VARBYTE" + ], + "type": "string" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "AnalysisSchema": { + "additionalProperties": false, + "properties": { + "ReferencedTables": { + "$ref": "#/definitions/ReferencedTables" + } + }, + "required": [ + "ReferencedTables" + ], + "type": "object" + }, + "AnalysisSource": { + "additionalProperties": false, + "properties": { + "Text": { + "maxLength": 15000, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + }, + "ReferencedTables": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TableName" + }, + "minItems": 0, + "type": "array" + }, + "TableName": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a stored analysis within a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateAnalysisTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetAnalysisTemplate", + "cleanrooms:ListAnalysisTemplates" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteAnalysisTemplate", + "cleanrooms:GetAnalysisTemplate", + "cleanrooms:ListAnalysisTemplates", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListAnalysisTemplates" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetAnalysisTemplate", + "cleanrooms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateAnalysisTemplate", + "cleanrooms:GetAnalysisTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AnalysisTemplateIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "AnalysisParameters": { + "description": "The member who can query can provide this placeholder for a literal data value in an analysis template", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisParameter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "AnalysisTemplateIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Arn": { + "maxLength": 200, + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "Format": { + "enum": [ + "SQL" + ], + "type": "string" + }, + "MembershipArn": { + "maxLength": 100, + "type": "string" + }, + "MembershipIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Name": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "Schema": { + "$ref": "#/definitions/AnalysisSchema" + }, + "Source": { + "$ref": "#/definitions/AnalysisSource" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CollaborationArn", + "/properties/CollaborationIdentifier", + "/properties/AnalysisTemplateIdentifier", + "/properties/Schema", + "/properties/Arn", + "/properties/MembershipArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Source", + "Format", + "Name", + "MembershipIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::AnalysisTemplate" +} diff --git a/schema/aws-cleanrooms-collaboration.json b/schema/aws-cleanrooms-collaboration.json index 3508674..caf3be0 100644 --- a/schema/aws-cleanrooms-collaboration.json +++ b/schema/aws-cleanrooms-collaboration.json @@ -1,271 +1,271 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CreatorDisplayName", - "/properties/CreatorMemberAbilities", - "/properties/DataEncryptionMetadata", - "/properties/QueryLogStatus", - "/properties/Members", - "/properties/CreatorPaymentConfiguration" - ], - "definitions": { - "CollaborationQueryLogStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "DataEncryptionMetadata": { - "additionalProperties": false, - "properties": { - "AllowCleartext": { - "type": "boolean" - }, - "AllowDuplicates": { - "type": "boolean" - }, - "AllowJoinsOnColumnsWithDifferentNames": { - "type": "boolean" - }, - "PreserveNulls": { - "type": "boolean" - } - }, - "required": [ - "AllowCleartext", - "AllowDuplicates", - "AllowJoinsOnColumnsWithDifferentNames", - "PreserveNulls" - ], - "type": "object" - }, - "MemberAbilities": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MemberAbility" - }, - "type": "array", - "uniqueItems": true - }, - "MemberAbility": { - "enum": [ - "CAN_QUERY", - "CAN_RECEIVE_RESULTS" - ], - "type": "string" - }, - "MemberSpecification": { - "additionalProperties": false, - "properties": { - "AccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d+$", - "type": "string" - }, - "DisplayName": { - "$ref": "#/definitions/Name" - }, - "MemberAbilities": { - "$ref": "#/definitions/MemberAbilities" - }, - "PaymentConfiguration": { - "$ref": "#/definitions/PaymentConfiguration" - } - }, - "required": [ - "AccountId", - "DisplayName", - "MemberAbilities" - ], - "type": "object" - }, - "MemberStatus": { - "enum": [ - "INVITED", - "ACTIVE", - "LEFT", - "REMOVED" - ], - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", - "type": "string" - }, - "PaymentConfiguration": { - "additionalProperties": false, - "properties": { - "QueryCompute": { - "$ref": "#/definitions/QueryComputePaymentConfig" - } - }, - "required": [ - "QueryCompute" - ], - "type": "object" - }, - "QueryComputePaymentConfig": { - "additionalProperties": false, - "properties": { - "IsResponsible": { - "type": "boolean" - } - }, - "required": [ - "IsResponsible" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents a collaboration between AWS accounts that allows for secure data collaboration", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreateCollaboration", - "cleanrooms:GetCollaboration", - "cleanrooms:ListMembers", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:GetCollaboration", - "cleanrooms:ListCollaborations" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeleteCollaboration", - "cleanrooms:GetCollaboration", - "cleanrooms:ListTagsForResource", - "cleanrooms:UntagResource", - "cleanrooms:ListMembers", - "cleanrooms:ListCollaborations" - ] - }, - "list": { - "permissions": [ - "cleanrooms:ListCollaborations" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetCollaboration", - "cleanrooms:ListMembers", - "cleanrooms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdateCollaboration", - "cleanrooms:GetCollaboration", - "cleanrooms:ListMembers", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CollaborationIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 100, - "type": "string" - }, - "CollaborationIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "CreatorDisplayName": { - "$ref": "#/definitions/Name" - }, - "CreatorMemberAbilities": { - "$ref": "#/definitions/MemberAbilities" - }, - "CreatorPaymentConfiguration": { - "$ref": "#/definitions/PaymentConfiguration" - }, - "DataEncryptionMetadata": { - "$ref": "#/definitions/DataEncryptionMetadata" - }, - "Description": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", - "type": "string" - }, - "Members": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MemberSpecification" - }, - "maxItems": 9, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", - "type": "string" - }, - "QueryLogStatus": { - "$ref": "#/definitions/CollaborationQueryLogStatus" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CollaborationIdentifier" - ], - "required": [ - "CreatorDisplayName", - "CreatorMemberAbilities", - "Members", - "Name", - "Description", - "QueryLogStatus" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::Collaboration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CreatorDisplayName", + "/properties/CreatorMemberAbilities", + "/properties/DataEncryptionMetadata", + "/properties/QueryLogStatus", + "/properties/Members", + "/properties/CreatorPaymentConfiguration" + ], + "definitions": { + "CollaborationQueryLogStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "DataEncryptionMetadata": { + "additionalProperties": false, + "properties": { + "AllowCleartext": { + "type": "boolean" + }, + "AllowDuplicates": { + "type": "boolean" + }, + "AllowJoinsOnColumnsWithDifferentNames": { + "type": "boolean" + }, + "PreserveNulls": { + "type": "boolean" + } + }, + "required": [ + "AllowCleartext", + "AllowDuplicates", + "AllowJoinsOnColumnsWithDifferentNames", + "PreserveNulls" + ], + "type": "object" + }, + "MemberAbilities": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MemberAbility" + }, + "type": "array", + "uniqueItems": true + }, + "MemberAbility": { + "enum": [ + "CAN_QUERY", + "CAN_RECEIVE_RESULTS" + ], + "type": "string" + }, + "MemberSpecification": { + "additionalProperties": false, + "properties": { + "AccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d+$", + "type": "string" + }, + "DisplayName": { + "$ref": "#/definitions/Name" + }, + "MemberAbilities": { + "$ref": "#/definitions/MemberAbilities" + }, + "PaymentConfiguration": { + "$ref": "#/definitions/PaymentConfiguration" + } + }, + "required": [ + "AccountId", + "DisplayName", + "MemberAbilities" + ], + "type": "object" + }, + "MemberStatus": { + "enum": [ + "INVITED", + "ACTIVE", + "LEFT", + "REMOVED" + ], + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "PaymentConfiguration": { + "additionalProperties": false, + "properties": { + "QueryCompute": { + "$ref": "#/definitions/QueryComputePaymentConfig" + } + }, + "required": [ + "QueryCompute" + ], + "type": "object" + }, + "QueryComputePaymentConfig": { + "additionalProperties": false, + "properties": { + "IsResponsible": { + "type": "boolean" + } + }, + "required": [ + "IsResponsible" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a collaboration between AWS accounts that allows for secure data collaboration", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateCollaboration", + "cleanrooms:GetCollaboration", + "cleanrooms:ListMembers", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetCollaboration", + "cleanrooms:ListCollaborations" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteCollaboration", + "cleanrooms:GetCollaboration", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:ListMembers", + "cleanrooms:ListCollaborations" + ] + }, + "list": { + "permissions": [ + "cleanrooms:ListCollaborations" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetCollaboration", + "cleanrooms:ListMembers", + "cleanrooms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateCollaboration", + "cleanrooms:GetCollaboration", + "cleanrooms:ListMembers", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CollaborationIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "CreatorDisplayName": { + "$ref": "#/definitions/Name" + }, + "CreatorMemberAbilities": { + "$ref": "#/definitions/MemberAbilities" + }, + "CreatorPaymentConfiguration": { + "$ref": "#/definitions/PaymentConfiguration" + }, + "DataEncryptionMetadata": { + "$ref": "#/definitions/DataEncryptionMetadata" + }, + "Description": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "Members": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MemberSpecification" + }, + "maxItems": 9, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "QueryLogStatus": { + "$ref": "#/definitions/CollaborationQueryLogStatus" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CollaborationIdentifier" + ], + "required": [ + "CreatorDisplayName", + "CreatorMemberAbilities", + "Members", + "Name", + "Description", + "QueryLogStatus" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::Collaboration" +} diff --git a/schema/aws-cleanrooms-configuredtable.json b/schema/aws-cleanrooms-configuredtable.json index e28b496..7c93f41 100644 --- a/schema/aws-cleanrooms-configuredtable.json +++ b/schema/aws-cleanrooms-configuredtable.json @@ -1,580 +1,613 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AllowedColumns", - "/properties/AnalysisMethod", - "/properties/TableReference" - ], - "definitions": { - "AggregateColumn": { - "additionalProperties": false, - "properties": { - "ColumnNames": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "minItems": 1, - "type": "array" - }, - "Function": { - "$ref": "#/definitions/AggregateFunctionName" - } - }, - "required": [ - "ColumnNames", - "Function" - ], - "type": "object" - }, - "AggregateFunctionName": { - "enum": [ - "SUM", - "SUM_DISTINCT", - "COUNT", - "COUNT_DISTINCT", - "AVG" - ], - "type": "string" - }, - "AggregationConstraint": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "Minimum": { - "maximum": 100000, - "minimum": 2, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/AggregationType" - } - }, - "required": [ - "ColumnName", - "Minimum", - "Type" - ], - "type": "object" - }, - "AggregationType": { - "enum": [ - "COUNT_DISTINCT" - ], - "type": "string" - }, - "AllowedAnalyses": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AllowedAnalysis" - }, - "minItems": 0, - "type": "array" - }, - "AllowedAnalysis": { - "maxLength": 200, - "minLength": 0, - "pattern": "(ANY_QUERY|arn:[\\w]{3}:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)", - "type": "string" - }, - "AllowedAnalysisProvider": { - "maxLength": 12, - "minLength": 12, - "pattern": "\\d+", - "type": "string" - }, - "AllowedAnalysisProviders": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AllowedAnalysisProvider" - }, - "minItems": 0, - "type": "array" - }, - "AnalysisMethod": { - "enum": [ - "DIRECT_QUERY" - ], - "type": "string" - }, - "AnalysisRule": { - "additionalProperties": false, - "properties": { - "Policy": { - "$ref": "#/definitions/ConfiguredTableAnalysisRulePolicy" - }, - "Type": { - "$ref": "#/definitions/ConfiguredTableAnalysisRuleType" - } - }, - "required": [ - "Type", - "Policy" - ], - "type": "object" - }, - "AnalysisRuleAggregation": { - "additionalProperties": false, - "properties": { - "AggregateColumns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AggregateColumn" - }, - "minItems": 1, - "type": "array" - }, - "AllowedJoinOperators": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/JoinOperator" - }, - "maxItems": 2, - "type": "array" - }, - "DimensionColumns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "type": "array" - }, - "JoinColumns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "type": "array" - }, - "JoinRequired": { - "$ref": "#/definitions/JoinRequiredOption" - }, - "OutputConstraints": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AggregationConstraint" - }, - "minItems": 1, - "type": "array" - }, - "ScalarFunctions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ScalarFunctions" - }, - "type": "array" - } - }, - "required": [ - "AggregateColumns", - "JoinColumns", - "DimensionColumns", - "ScalarFunctions", - "OutputConstraints" - ], - "type": "object" - }, - "AnalysisRuleColumnName": { - "maxLength": 127, - "minLength": 1, - "pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$", - "type": "string" - }, - "AnalysisRuleCustom": { - "additionalProperties": false, - "properties": { - "AllowedAnalyses": { - "$ref": "#/definitions/AllowedAnalyses" - }, - "AllowedAnalysisProviders": { - "$ref": "#/definitions/AllowedAnalysisProviders" - }, - "DifferentialPrivacy": { - "$ref": "#/definitions/DifferentialPrivacy" - } - }, - "required": [ - "AllowedAnalyses" - ], - "type": "object" - }, - "AnalysisRuleList": { - "additionalProperties": false, - "properties": { - "AllowedJoinOperators": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/JoinOperator" - }, - "maxItems": 2, - "type": "array" - }, - "JoinColumns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "minItems": 1, - "type": "array" - }, - "ListColumns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRuleColumnName" - }, - "type": "array" - } - }, - "required": [ - "JoinColumns", - "ListColumns" - ], - "type": "object" - }, - "ConfiguredTableAnalysisRulePolicy": { - "additionalProperties": false, - "properties": { - "V1": { - "$ref": "#/definitions/ConfiguredTableAnalysisRulePolicyV1" - } - }, - "required": [ - "V1" - ], - "title": "V1", - "type": "object" - }, - "ConfiguredTableAnalysisRulePolicyV1": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "List": { - "$ref": "#/definitions/AnalysisRuleList" - } - }, - "required": [ - "List" - ], - "title": "List", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/AnalysisRuleAggregation" - } - }, - "required": [ - "Aggregation" - ], - "title": "Aggregation", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Custom": { - "$ref": "#/definitions/AnalysisRuleCustom" - } - }, - "required": [ - "Custom" - ], - "title": "Custom", - "type": "object" - } - ] - }, - "ConfiguredTableAnalysisRuleType": { - "enum": [ - "AGGREGATION", - "LIST", - "CUSTOM" - ], - "type": "string" - }, - "DifferentialPrivacy": { - "additionalProperties": false, - "properties": { - "Columns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DifferentialPrivacyColumn" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Columns" - ], - "type": "object" - }, - "DifferentialPrivacyColumn": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "GlueTableReference": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - }, - "TableName": { - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - } - }, - "required": [ - "DatabaseName", - "TableName" - ], - "type": "object" - }, - "JoinOperator": { - "enum": [ - "OR", - "AND" - ], - "type": "string" - }, - "JoinRequiredOption": { - "enum": [ - "QUERY_RUNNER" - ], - "type": "string" - }, - "ScalarFunctions": { - "enum": [ - "TRUNC", - "ABS", - "CEILING", - "FLOOR", - "LN", - "LOG", - "ROUND", - "SQRT", - "CAST", - "LOWER", - "RTRIM", - "UPPER", - "COALESCE", - "CONVERT", - "CURRENT_DATE", - "DATEADD", - "EXTRACT", - "GETDATE", - "SUBSTRING", - "TO_CHAR", - "TO_DATE", - "TO_NUMBER", - "TO_TIMESTAMP", - "TRIM" - ], - "type": "string" - }, - "TableReference": { - "additionalProperties": false, - "properties": { - "Glue": { - "$ref": "#/definitions/GlueTableReference" - } - }, - "required": [ - "Glue" - ], - "title": "Glue", - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents a table that can be associated with collaborations", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreateConfiguredTable", - "cleanrooms:DeleteConfiguredTable", - "cleanrooms:DeleteConfiguredTableAnalysisRule", - "cleanrooms:CreateConfiguredTableAnalysisRule", - "cleanrooms:GetConfiguredTable", - "cleanrooms:GetConfiguredTableAnalysisRule", - "glue:GetDatabase", - "glue:GetDatabases", - "glue:GetTable", - "glue:GetTables", - "glue:GetPartition", - "glue:GetPartitions", - "glue:BatchGetPartition", - "glue:GetSchemaVersion", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:ListConfiguredTables" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeleteConfiguredTable", - "cleanrooms:GetConfiguredTable", - "cleanrooms:ListConfiguredTables", - "cleanrooms:GetConfiguredTableAnalysisRule", - "cleanrooms:DeleteConfiguredTableAnalysisRule", - "cleanrooms:ListTagsForResource", - "cleanrooms:UntagResource", - "glue:GetDatabase", - "glue:GetDatabases", - "glue:GetTable", - "glue:GetTables", - "glue:GetPartition", - "glue:GetPartitions", - "glue:BatchGetPartition", - "glue:GetSchemaVersion" - ] - }, - "list": { - "permissions": [ - "cleanrooms:ListConfiguredTables" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetConfiguredTable", - "cleanrooms:GetConfiguredTableAnalysisRule", - "cleanrooms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdateConfiguredTable", - "cleanrooms:GetConfiguredTable", - "cleanrooms:CreateConfiguredTableAnalysisRule", - "cleanrooms:UpdateConfiguredTableAnalysisRule", - "cleanrooms:GetConfiguredTableAnalysisRule", - "cleanrooms:DeleteConfiguredTableAnalysisRule", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource", - "glue:GetDatabase", - "glue:GetDatabases", - "glue:GetTable", - "glue:GetTables", - "glue:GetPartition", - "glue:GetPartitions", - "glue:BatchGetPartition", - "glue:GetSchemaVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConfiguredTableIdentifier" - ], - "properties": { - "AllowedColumns": { - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "AnalysisMethod": { - "$ref": "#/definitions/AnalysisMethod" - }, - "AnalysisRules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AnalysisRule" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Arn": { - "maxLength": 100, - "type": "string" - }, - "ConfiguredTableIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Description": { - "maxLength": 255, - "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", - "type": "string" - }, - "TableReference": { - "$ref": "#/definitions/TableReference" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ConfiguredTableIdentifier" - ], - "required": [ - "AllowedColumns", - "AnalysisMethod", - "Name", - "TableReference" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::ConfiguredTable" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AllowedColumns", + "/properties/AnalysisMethod", + "/properties/TableReference" + ], + "definitions": { + "AdditionalAnalyses": { + "enum": [ + "ALLOWED", + "REQUIRED", + "NOT_ALLOWED" + ], + "type": "string" + }, + "AggregateColumn": { + "additionalProperties": false, + "properties": { + "ColumnNames": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "minItems": 1, + "type": "array" + }, + "Function": { + "$ref": "#/definitions/AggregateFunctionName" + } + }, + "required": [ + "ColumnNames", + "Function" + ], + "type": "object" + }, + "AggregateFunctionName": { + "enum": [ + "SUM", + "SUM_DISTINCT", + "COUNT", + "COUNT_DISTINCT", + "AVG" + ], + "type": "string" + }, + "AggregationConstraint": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "Minimum": { + "maximum": 100000, + "minimum": 2, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/AggregationType" + } + }, + "required": [ + "ColumnName", + "Minimum", + "Type" + ], + "type": "object" + }, + "AggregationType": { + "enum": [ + "COUNT_DISTINCT" + ], + "type": "string" + }, + "AllowedAnalyses": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AllowedAnalysis" + }, + "minItems": 0, + "type": "array" + }, + "AllowedAnalysis": { + "maxLength": 200, + "minLength": 0, + "pattern": "(ANY_QUERY|arn:[\\w]{3}:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)", + "type": "string" + }, + "AllowedAnalysisProvider": { + "maxLength": 12, + "minLength": 12, + "pattern": "\\d+", + "type": "string" + }, + "AllowedAnalysisProviders": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AllowedAnalysisProvider" + }, + "minItems": 0, + "type": "array" + }, + "AnalysisMethod": { + "enum": [ + "DIRECT_QUERY" + ], + "type": "string" + }, + "AnalysisRule": { + "additionalProperties": false, + "properties": { + "Policy": { + "$ref": "#/definitions/ConfiguredTableAnalysisRulePolicy" + }, + "Type": { + "$ref": "#/definitions/ConfiguredTableAnalysisRuleType" + } + }, + "required": [ + "Type", + "Policy" + ], + "type": "object" + }, + "AnalysisRuleAggregation": { + "additionalProperties": false, + "properties": { + "AdditionalAnalyses": { + "$ref": "#/definitions/AdditionalAnalyses" + }, + "AggregateColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AggregateColumn" + }, + "minItems": 1, + "type": "array" + }, + "AllowedJoinOperators": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/JoinOperator" + }, + "maxItems": 2, + "type": "array" + }, + "DimensionColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "type": "array" + }, + "JoinColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "type": "array" + }, + "JoinRequired": { + "$ref": "#/definitions/JoinRequiredOption" + }, + "OutputConstraints": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AggregationConstraint" + }, + "minItems": 1, + "type": "array" + }, + "ScalarFunctions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ScalarFunctions" + }, + "type": "array" + } + }, + "required": [ + "AggregateColumns", + "JoinColumns", + "DimensionColumns", + "ScalarFunctions", + "OutputConstraints" + ], + "type": "object" + }, + "AnalysisRuleColumnName": { + "maxLength": 127, + "minLength": 1, + "pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$", + "type": "string" + }, + "AnalysisRuleCustom": { + "additionalProperties": false, + "properties": { + "AdditionalAnalyses": { + "$ref": "#/definitions/AdditionalAnalyses" + }, + "AllowedAnalyses": { + "$ref": "#/definitions/AllowedAnalyses" + }, + "AllowedAnalysisProviders": { + "$ref": "#/definitions/AllowedAnalysisProviders" + }, + "DifferentialPrivacy": { + "$ref": "#/definitions/DifferentialPrivacy" + }, + "DisallowedOutputColumns": { + "$ref": "#/definitions/DisallowedOutputColumns" + } + }, + "required": [ + "AllowedAnalyses" + ], + "type": "object" + }, + "AnalysisRuleList": { + "additionalProperties": false, + "properties": { + "AdditionalAnalyses": { + "$ref": "#/definitions/AdditionalAnalyses" + }, + "AllowedJoinOperators": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/JoinOperator" + }, + "maxItems": 2, + "type": "array" + }, + "JoinColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "minItems": 1, + "type": "array" + }, + "ListColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "type": "array" + } + }, + "required": [ + "JoinColumns", + "ListColumns" + ], + "type": "object" + }, + "ConfiguredTableAnalysisRulePolicy": { + "additionalProperties": false, + "properties": { + "V1": { + "$ref": "#/definitions/ConfiguredTableAnalysisRulePolicyV1" + } + }, + "required": [ + "V1" + ], + "title": "V1", + "type": "object" + }, + "ConfiguredTableAnalysisRulePolicyV1": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "List": { + "$ref": "#/definitions/AnalysisRuleList" + } + }, + "required": [ + "List" + ], + "title": "List", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/AnalysisRuleAggregation" + } + }, + "required": [ + "Aggregation" + ], + "title": "Aggregation", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Custom": { + "$ref": "#/definitions/AnalysisRuleCustom" + } + }, + "required": [ + "Custom" + ], + "title": "Custom", + "type": "object" + } + ] + }, + "ConfiguredTableAnalysisRuleType": { + "enum": [ + "AGGREGATION", + "LIST", + "CUSTOM" + ], + "type": "string" + }, + "DifferentialPrivacy": { + "additionalProperties": false, + "properties": { + "Columns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DifferentialPrivacyColumn" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Columns" + ], + "type": "object" + }, + "DifferentialPrivacyColumn": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "DisallowedOutputColumns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRuleColumnName" + }, + "minItems": 0, + "type": "array" + }, + "GlueTableReference": { + "additionalProperties": false, + "properties": { + "DatabaseName": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "TableName": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + } + }, + "required": [ + "DatabaseName", + "TableName" + ], + "type": "object" + }, + "JoinOperator": { + "enum": [ + "OR", + "AND" + ], + "type": "string" + }, + "JoinRequiredOption": { + "enum": [ + "QUERY_RUNNER" + ], + "type": "string" + }, + "ScalarFunctions": { + "enum": [ + "TRUNC", + "ABS", + "CEILING", + "FLOOR", + "LN", + "LOG", + "ROUND", + "SQRT", + "CAST", + "LOWER", + "RTRIM", + "UPPER", + "COALESCE", + "CONVERT", + "CURRENT_DATE", + "DATEADD", + "EXTRACT", + "GETDATE", + "SUBSTRING", + "TO_CHAR", + "TO_DATE", + "TO_NUMBER", + "TO_TIMESTAMP", + "TRIM" + ], + "type": "string" + }, + "TableReference": { + "additionalProperties": false, + "properties": { + "Glue": { + "$ref": "#/definitions/GlueTableReference" + } + }, + "required": [ + "Glue" + ], + "title": "Glue", + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a table that can be associated with collaborations", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateConfiguredTable", + "cleanrooms:DeleteConfiguredTable", + "cleanrooms:DeleteConfiguredTableAnalysisRule", + "cleanrooms:CreateConfiguredTableAnalysisRule", + "cleanrooms:GetConfiguredTable", + "cleanrooms:GetConfiguredTableAnalysisRule", + "glue:GetDatabase", + "glue:GetDatabases", + "glue:GetTable", + "glue:GetTables", + "glue:GetPartition", + "glue:GetPartitions", + "glue:BatchGetPartition", + "glue:GetSchemaVersion", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:ListConfiguredTables" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteConfiguredTable", + "cleanrooms:GetConfiguredTable", + "cleanrooms:ListConfiguredTables", + "cleanrooms:GetConfiguredTableAnalysisRule", + "cleanrooms:DeleteConfiguredTableAnalysisRule", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "glue:GetDatabase", + "glue:GetDatabases", + "glue:GetTable", + "glue:GetTables", + "glue:GetPartition", + "glue:GetPartitions", + "glue:BatchGetPartition", + "glue:GetSchemaVersion" + ] + }, + "list": { + "permissions": [ + "cleanrooms:ListConfiguredTables" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetConfiguredTable", + "cleanrooms:GetConfiguredTableAnalysisRule", + "cleanrooms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateConfiguredTable", + "cleanrooms:GetConfiguredTable", + "cleanrooms:CreateConfiguredTableAnalysisRule", + "cleanrooms:UpdateConfiguredTableAnalysisRule", + "cleanrooms:GetConfiguredTableAnalysisRule", + "cleanrooms:DeleteConfiguredTableAnalysisRule", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource", + "glue:GetDatabase", + "glue:GetDatabases", + "glue:GetTable", + "glue:GetTables", + "glue:GetPartition", + "glue:GetPartitions", + "glue:BatchGetPartition", + "glue:GetSchemaVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConfiguredTableIdentifier" + ], + "properties": { + "AllowedColumns": { + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "AnalysisMethod": { + "$ref": "#/definitions/AnalysisMethod" + }, + "AnalysisRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AnalysisRule" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Arn": { + "maxLength": 100, + "type": "string" + }, + "ConfiguredTableIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "TableReference": { + "$ref": "#/definitions/TableReference" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ConfiguredTableIdentifier" + ], + "required": [ + "AllowedColumns", + "AnalysisMethod", + "Name", + "TableReference" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::ConfiguredTable" +} diff --git a/schema/aws-cleanrooms-configuredtableassociation.json b/schema/aws-cleanrooms-configuredtableassociation.json index b85fb0e..0513371 100644 --- a/schema/aws-cleanrooms-configuredtableassociation.json +++ b/schema/aws-cleanrooms-configuredtableassociation.json @@ -1,153 +1,322 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfiguredTableIdentifier", - "/properties/Name", - "/properties/MembershipIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents a table that can be queried within a collaboration", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreateConfiguredTableAssociation", - "iam:PassRole", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:GetConfiguredTableAssociation", - "cleanrooms:ListConfiguredTableAssociations" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeleteConfiguredTableAssociation", - "cleanrooms:GetConfiguredTableAssociation", - "cleanrooms:ListConfiguredTableAssociations", - "cleanrooms:ListTagsForResource", - "cleanrooms:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "MembershipIdentifier": { - "$ref": "resource-schema.json#/properties/MembershipIdentifier" - } - }, - "required": [ - "MembershipIdentifier" - ] - }, - "permissions": [ - "cleanrooms:ListConfiguredTableAssociations" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetConfiguredTableAssociation", - "cleanrooms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdateConfiguredTableAssociation", - "cleanrooms:GetConfiguredTableAssociation", - "iam:PassRole", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConfiguredTableAssociationIdentifier", - "/properties/MembershipIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 100, - "type": "string" - }, - "ConfiguredTableAssociationIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "ConfiguredTableIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Description": { - "maxLength": 255, - "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", - "type": "string" - }, - "MembershipIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Name": { - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - }, - "RoleArn": { - "maxLength": 512, - "minLength": 32, - "type": "string" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ConfiguredTableAssociationIdentifier", - "/properties/Arn" - ], - "required": [ - "ConfiguredTableIdentifier", - "Name", - "RoleArn", - "MembershipIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::ConfiguredTableAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfiguredTableIdentifier", + "/properties/Name", + "/properties/MembershipIdentifier" + ], + "definitions": { + "AllowedAdditionalAnalyses": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AllowedAdditionalAnalysis" + }, + "maxItems": 25, + "minItems": 0, + "type": "array" + }, + "AllowedAdditionalAnalysis": { + "maxLength": 256, + "type": "string" + }, + "AllowedResultReceiver": { + "maxLength": 12, + "minLength": 12, + "pattern": "\\d+", + "type": "string" + }, + "AllowedResultReceivers": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AllowedResultReceiver" + }, + "minItems": 0, + "type": "array" + }, + "ConfiguredTableAssociationAnalysisRule": { + "additionalProperties": false, + "properties": { + "Policy": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRulePolicy" + }, + "Type": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRuleType" + } + }, + "required": [ + "Type", + "Policy" + ], + "type": "object" + }, + "ConfiguredTableAssociationAnalysisRuleAggregation": { + "additionalProperties": false, + "properties": { + "AllowedAdditionalAnalyses": { + "$ref": "#/definitions/AllowedAdditionalAnalyses" + }, + "AllowedResultReceivers": { + "$ref": "#/definitions/AllowedResultReceivers" + } + }, + "type": "object" + }, + "ConfiguredTableAssociationAnalysisRuleCustom": { + "additionalProperties": false, + "properties": { + "AllowedAdditionalAnalyses": { + "$ref": "#/definitions/AllowedAdditionalAnalyses" + }, + "AllowedResultReceivers": { + "$ref": "#/definitions/AllowedResultReceivers" + } + }, + "type": "object" + }, + "ConfiguredTableAssociationAnalysisRuleList": { + "additionalProperties": false, + "properties": { + "AllowedAdditionalAnalyses": { + "$ref": "#/definitions/AllowedAdditionalAnalyses" + }, + "AllowedResultReceivers": { + "$ref": "#/definitions/AllowedResultReceivers" + } + }, + "type": "object" + }, + "ConfiguredTableAssociationAnalysisRulePolicy": { + "additionalProperties": false, + "properties": { + "V1": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRulePolicyV1" + } + }, + "required": [ + "V1" + ], + "title": "V1", + "type": "object" + }, + "ConfiguredTableAssociationAnalysisRulePolicyV1": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "List": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRuleList" + } + }, + "required": [ + "List" + ], + "title": "List", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRuleAggregation" + } + }, + "required": [ + "Aggregation" + ], + "title": "Aggregation", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Custom": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRuleCustom" + } + }, + "required": [ + "Custom" + ], + "title": "Custom", + "type": "object" + } + ] + }, + "ConfiguredTableAssociationAnalysisRuleType": { + "enum": [ + "AGGREGATION", + "LIST", + "CUSTOM" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a table that can be queried within a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateConfiguredTableAssociation", + "iam:PassRole", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetConfiguredTableAssociation", + "cleanrooms:ListConfiguredTableAssociations", + "cleanrooms:DeleteConfiguredTableAssociation", + "cleanrooms:DeleteConfiguredTableAssociationAnalysisRule", + "cleanrooms:CreateConfiguredTableAssociationAnalysisRule", + "cleanrooms:GetConfiguredTableAssociationAnalysisRule" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteConfiguredTableAssociation", + "cleanrooms:GetConfiguredTableAssociation", + "cleanrooms:ListConfiguredTableAssociations", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:DeleteConfiguredTableAssociationAnalysisRule", + "cleanrooms:GetConfiguredTableAssociationAnalysisRule" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListConfiguredTableAssociations" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetConfiguredTableAssociation", + "cleanrooms:ListTagsForResource", + "cleanrooms:GetConfiguredTableAssociationAnalysisRule" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateConfiguredTableAssociation", + "cleanrooms:GetConfiguredTableAssociation", + "iam:PassRole", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource", + "cleanrooms:DeleteConfiguredTableAssociationAnalysisRule", + "cleanrooms:CreateConfiguredTableAssociationAnalysisRule", + "cleanrooms:GetConfiguredTableAssociationAnalysisRule", + "cleanrooms:UpdateConfiguredTableAssociationAnalysisRule" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConfiguredTableAssociationIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 100, + "type": "string" + }, + "ConfiguredTableAssociationAnalysisRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfiguredTableAssociationAnalysisRule" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "ConfiguredTableAssociationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "ConfiguredTableIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "MembershipIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Name": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "RoleArn": { + "maxLength": 512, + "minLength": 32, + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ConfiguredTableAssociationIdentifier", + "/properties/Arn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "ConfiguredTableIdentifier", + "Name", + "RoleArn", + "MembershipIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::ConfiguredTableAssociation" +} diff --git a/schema/aws-cleanrooms-idmappingtable.json b/schema/aws-cleanrooms-idmappingtable.json new file mode 100644 index 0000000..65d5418 --- /dev/null +++ b/schema/aws-cleanrooms-idmappingtable.json @@ -0,0 +1,241 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MembershipIdentifier", + "/properties/Name", + "/properties/InputReferenceConfig" + ], + "definitions": { + "IdMappingTableInputReferenceConfig": { + "additionalProperties": false, + "properties": { + "InputReferenceArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ManageResourcePolicies": { + "type": "boolean" + } + }, + "required": [ + "InputReferenceArn", + "ManageResourcePolicies" + ], + "type": "object" + }, + "IdMappingTableInputReferenceProperties": { + "additionalProperties": false, + "properties": { + "IdMappingTableInputSource": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdMappingTableInputSource" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + } + }, + "required": [ + "IdMappingTableInputSource" + ], + "type": "object" + }, + "IdMappingTableInputSource": { + "additionalProperties": false, + "properties": { + "IdNamespaceAssociationId": { + "type": "string" + }, + "Type": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + } + }, + "required": [ + "IdNamespaceAssociationId", + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UUID": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + } + }, + "description": "Represents an association between an ID mapping workflow and a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateIdMappingTable", + "cleanrooms:GetIdMappingTable", + "cleanrooms:ListIdMappingTables", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration", + "entityresolution:GetIdMappingWorkflow", + "entityresolution:AddPolicyStatement" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteIdMappingTable", + "cleanrooms:GetIdMappingTable", + "cleanrooms:ListIdMappingTables", + "cleanrooms:GetMembership", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "entityresolution:GetIdMappingWorkflow", + "entityresolution:AddPolicyStatement", + "entityresolution:DeletePolicyStatement" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListIdMappingTables", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetIdMappingTable", + "cleanrooms:ListTagsForResource", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateIdMappingTable", + "cleanrooms:GetIdMappingTable", + "cleanrooms:GetMembership", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource", + "entityresolution:GetIdMappingWorkflow", + "entityresolution:AddPolicyStatement" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdMappingTableIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 200, + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "$ref": "#/definitions/UUID" + }, + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "IdMappingTableIdentifier": { + "$ref": "#/definitions/UUID" + }, + "InputReferenceConfig": { + "$ref": "#/definitions/IdMappingTableInputReferenceConfig" + }, + "InputReferenceProperties": { + "$ref": "#/definitions/IdMappingTableInputReferenceProperties" + }, + "KmsKeyArn": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "MembershipArn": { + "maxLength": 100, + "type": "string" + }, + "MembershipIdentifier": { + "$ref": "#/definitions/UUID" + }, + "Name": { + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/IdMappingTableIdentifier", + "/properties/Arn", + "/properties/MembershipArn", + "/properties/CollaborationIdentifier", + "/properties/CollaborationArn", + "/properties/InputReferenceProperties" + ], + "required": [ + "MembershipIdentifier", + "Name", + "InputReferenceConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::IdMappingTable" +} diff --git a/schema/aws-cleanrooms-idnamespaceassociation.json b/schema/aws-cleanrooms-idnamespaceassociation.json new file mode 100644 index 0000000..25226d7 --- /dev/null +++ b/schema/aws-cleanrooms-idnamespaceassociation.json @@ -0,0 +1,238 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MembershipIdentifier", + "/properties/InputReferenceConfig" + ], + "definitions": { + "Document": { + "type": "object" + }, + "IdMappingConfig": { + "additionalProperties": false, + "properties": { + "AllowUseAsDimensionColumn": { + "type": "boolean" + } + }, + "required": [ + "AllowUseAsDimensionColumn" + ], + "type": "object" + }, + "IdNamespaceAssociationInputReferenceConfig": { + "additionalProperties": false, + "properties": { + "InputReferenceArn": { + "maxLength": 256, + "type": "string" + }, + "ManageResourcePolicies": { + "type": "boolean" + } + }, + "required": [ + "InputReferenceArn", + "ManageResourcePolicies" + ], + "type": "object" + }, + "IdNamespaceAssociationInputReferenceProperties": { + "additionalProperties": false, + "properties": { + "IdMappingWorkflowsSupported": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Document" + }, + "type": "array" + }, + "IdNamespaceType": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UUID": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + } + }, + "description": "Represents an association between an ID namespace and a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateIdNamespaceAssociation", + "cleanrooms:GetIdNamespaceAssociation", + "cleanrooms:ListIdNamespaceAssociations", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration", + "entityresolution:GetIdNamespace", + "entityresolution:AddPolicyStatement" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteIdNamespaceAssociation", + "cleanrooms:GetIdNamespaceAssociation", + "cleanrooms:ListIdNamespaceAssociations", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "entityresolution:GetIdNamespace", + "entityresolution:DeletePolicyStatement" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListIdNamespaceAssociations", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetIdNamespaceAssociation", + "cleanrooms:ListTagsForResource", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration", + "entityresolution:GetIdNamespace" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateIdNamespaceAssociation", + "cleanrooms:GetIdNamespaceAssociation", + "cleanrooms:GetMembership", + "cleanrooms:GetCollaboration", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource", + "entityresolution:GetIdNamespace", + "entityresolution:AddPolicyStatement" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdNamespaceAssociationIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 256, + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "$ref": "#/definitions/UUID" + }, + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "IdMappingConfig": { + "$ref": "#/definitions/IdMappingConfig" + }, + "IdNamespaceAssociationIdentifier": { + "$ref": "#/definitions/UUID" + }, + "InputReferenceConfig": { + "$ref": "#/definitions/IdNamespaceAssociationInputReferenceConfig" + }, + "InputReferenceProperties": { + "$ref": "#/definitions/IdNamespaceAssociationInputReferenceProperties" + }, + "MembershipArn": { + "maxLength": 100, + "type": "string" + }, + "MembershipIdentifier": { + "$ref": "#/definitions/UUID" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/IdNamespaceAssociationIdentifier", + "/properties/Arn", + "/properties/MembershipArn", + "/properties/CollaborationIdentifier", + "/properties/CollaborationArn", + "/properties/InputReferenceProperties" + ], + "required": [ + "MembershipIdentifier", + "InputReferenceConfig", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::IdNamespaceAssociation" +} diff --git a/schema/aws-cleanrooms-membership.json b/schema/aws-cleanrooms-membership.json index 3ab13dc..ce3b37c 100644 --- a/schema/aws-cleanrooms-membership.json +++ b/schema/aws-cleanrooms-membership.json @@ -1,259 +1,264 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CollaborationIdentifier" - ], - "definitions": { - "MembershipPaymentConfiguration": { - "additionalProperties": false, - "properties": { - "QueryCompute": { - "$ref": "#/definitions/MembershipQueryComputePaymentConfig" - } - }, - "required": [ - "QueryCompute" - ], - "type": "object" - }, - "MembershipProtectedQueryOutputConfiguration": { - "additionalProperties": false, - "properties": { - "S3": { - "$ref": "#/definitions/ProtectedQueryS3OutputConfiguration" - } - }, - "required": [ - "S3" - ], - "type": "object" - }, - "MembershipProtectedQueryResultConfiguration": { - "additionalProperties": false, - "properties": { - "OutputConfiguration": { - "$ref": "#/definitions/MembershipProtectedQueryOutputConfiguration" - }, - "RoleArn": { - "maxLength": 512, - "minLength": 32, - "type": "string" - } - }, - "required": [ - "OutputConfiguration" - ], - "type": "object" - }, - "MembershipQueryComputePaymentConfig": { - "additionalProperties": false, - "properties": { - "IsResponsible": { - "type": "boolean" - } - }, - "required": [ - "IsResponsible" - ], - "type": "object" - }, - "MembershipQueryLogStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "MembershipStatus": { - "enum": [ - "ACTIVE", - "REMOVED", - "COLLABORATION_DELETED" - ], - "type": "string" - }, - "ProtectedQueryS3OutputConfiguration": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 63, - "minLength": 3, - "type": "string" - }, - "KeyPrefix": { - "type": "string" - }, - "ResultFormat": { - "$ref": "#/definitions/ResultFormat" - } - }, - "required": [ - "ResultFormat", - "Bucket" - ], - "type": "object" - }, - "ResultFormat": { - "enum": [ - "CSV", - "PARQUET" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents an AWS account that is a part of a collaboration", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreateMembership", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:DescribeLogGroups", - "logs:DescribeResourcePolicies", - "logs:PutResourcePolicy", - "logs:CreateLogGroup", - "cleanrooms:GetMembership", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:ListMemberships", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeleteMembership", - "cleanrooms:GetMembership", - "cleanrooms:ListMemberships", - "cleanrooms:ListTagsForResource", - "logs:ListLogDeliveries", - "logs:DescribeLogGroups", - "logs:DescribeResourcePolicies", - "logs:GetLogDelivery" - ] - }, - "list": { - "permissions": [ - "cleanrooms:ListMemberships" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetMembership", - "cleanrooms:ListTagsForResource", - "logs:ListLogDeliveries", - "logs:DescribeLogGroups", - "logs:DescribeResourcePolicies", - "logs:GetLogDelivery" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdateMembership", - "cleanrooms:GetMembership", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:DescribeLogGroups", - "logs:DescribeResourcePolicies", - "logs:PutResourcePolicy", - "logs:CreateLogGroup", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/MembershipIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 100, - "type": "string" - }, - "CollaborationArn": { - "maxLength": 100, - "type": "string" - }, - "CollaborationCreatorAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d+$", - "type": "string" - }, - "CollaborationIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "DefaultResultConfiguration": { - "$ref": "#/definitions/MembershipProtectedQueryResultConfiguration" - }, - "MembershipIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "PaymentConfiguration": { - "$ref": "#/definitions/MembershipPaymentConfiguration" - }, - "QueryLogStatus": { - "$ref": "#/definitions/MembershipQueryLogStatus" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms membership.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CollaborationArn", - "/properties/CollaborationCreatorAccountId", - "/properties/MembershipIdentifier" - ], - "required": [ - "CollaborationIdentifier", - "QueryLogStatus" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::Membership" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CollaborationIdentifier" + ], + "definitions": { + "MembershipPaymentConfiguration": { + "additionalProperties": false, + "properties": { + "QueryCompute": { + "$ref": "#/definitions/MembershipQueryComputePaymentConfig" + } + }, + "required": [ + "QueryCompute" + ], + "type": "object" + }, + "MembershipProtectedQueryOutputConfiguration": { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/ProtectedQueryS3OutputConfiguration" + } + }, + "required": [ + "S3" + ], + "type": "object" + }, + "MembershipProtectedQueryResultConfiguration": { + "additionalProperties": false, + "properties": { + "OutputConfiguration": { + "$ref": "#/definitions/MembershipProtectedQueryOutputConfiguration" + }, + "RoleArn": { + "maxLength": 512, + "minLength": 32, + "type": "string" + } + }, + "required": [ + "OutputConfiguration" + ], + "type": "object" + }, + "MembershipQueryComputePaymentConfig": { + "additionalProperties": false, + "properties": { + "IsResponsible": { + "type": "boolean" + } + }, + "required": [ + "IsResponsible" + ], + "type": "object" + }, + "MembershipQueryLogStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "MembershipStatus": { + "enum": [ + "ACTIVE", + "REMOVED", + "COLLABORATION_DELETED" + ], + "type": "string" + }, + "ProtectedQueryS3OutputConfiguration": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 63, + "minLength": 3, + "type": "string" + }, + "KeyPrefix": { + "type": "string" + }, + "ResultFormat": { + "$ref": "#/definitions/ResultFormat" + } + }, + "required": [ + "ResultFormat", + "Bucket" + ], + "type": "object" + }, + "ResultFormat": { + "enum": [ + "CSV", + "PARQUET" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents an AWS account that is a part of a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreateMembership", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:DescribeLogGroups", + "logs:DescribeResourcePolicies", + "logs:PutResourcePolicy", + "logs:CreateLogGroup", + "cleanrooms:GetMembership", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:ListMemberships", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeleteMembership", + "cleanrooms:GetMembership", + "cleanrooms:ListMemberships", + "cleanrooms:ListTagsForResource", + "logs:ListLogDeliveries", + "logs:DescribeLogGroups", + "logs:DescribeResourcePolicies", + "logs:GetLogDelivery" + ] + }, + "list": { + "permissions": [ + "cleanrooms:ListMemberships" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetMembership", + "cleanrooms:ListTagsForResource", + "logs:ListLogDeliveries", + "logs:DescribeLogGroups", + "logs:DescribeResourcePolicies", + "logs:GetLogDelivery" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdateMembership", + "cleanrooms:GetMembership", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:DescribeLogGroups", + "logs:DescribeResourcePolicies", + "logs:PutResourcePolicy", + "logs:CreateLogGroup", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationCreatorAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d+$", + "type": "string" + }, + "CollaborationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "DefaultResultConfiguration": { + "$ref": "#/definitions/MembershipProtectedQueryResultConfiguration" + }, + "MembershipIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "PaymentConfiguration": { + "$ref": "#/definitions/MembershipPaymentConfiguration" + }, + "QueryLogStatus": { + "$ref": "#/definitions/MembershipQueryLogStatus" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms membership.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CollaborationArn", + "/properties/CollaborationCreatorAccountId", + "/properties/MembershipIdentifier" + ], + "required": [ + "CollaborationIdentifier", + "QueryLogStatus" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::Membership" +} diff --git a/schema/aws-cleanrooms-privacybudgettemplate.json b/schema/aws-cleanrooms-privacybudgettemplate.json index 68fd4b3..02ec1e0 100644 --- a/schema/aws-cleanrooms-privacybudgettemplate.json +++ b/schema/aws-cleanrooms-privacybudgettemplate.json @@ -1,181 +1,186 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MembershipIdentifier", - "/properties/PrivacyBudgetType", - "/properties/AutoRefresh" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Represents a privacy budget within a collaboration", - "handlers": { - "create": { - "permissions": [ - "cleanrooms:CreatePrivacyBudgetTemplate", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:GetPrivacyBudgetTemplate", - "cleanrooms:ListPrivacyBudgetTemplates" - ] - }, - "delete": { - "permissions": [ - "cleanrooms:DeletePrivacyBudgetTemplate", - "cleanrooms:GetPrivacyBudgetTemplate", - "cleanrooms:ListPrivacyBudgetTemplates", - "cleanrooms:ListTagsForResource", - "cleanrooms:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "MembershipIdentifier": { - "$ref": "resource-schema.json#/properties/MembershipIdentifier" - } - }, - "required": [ - "MembershipIdentifier" - ] - }, - "permissions": [ - "cleanrooms:ListPrivacyBudgetTemplates" - ] - }, - "read": { - "permissions": [ - "cleanrooms:GetPrivacyBudgetTemplate", - "cleanrooms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cleanrooms:UpdatePrivacyBudgetTemplate", - "cleanrooms:GetPrivacyBudgetTemplate", - "cleanrooms:ListTagsForResource", - "cleanrooms:TagResource", - "cleanrooms:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PrivacyBudgetTemplateIdentifier", - "/properties/MembershipIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 200, - "type": "string" - }, - "AutoRefresh": { - "enum": [ - "CALENDAR_MONTH", - "NONE" - ], - "type": "string" - }, - "CollaborationArn": { - "maxLength": 100, - "type": "string" - }, - "CollaborationIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "MembershipArn": { - "maxLength": 100, - "type": "string" - }, - "MembershipIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "properties": { - "Epsilon": { - "maximum": 20, - "minimum": 1, - "type": "integer" - }, - "UsersNoisePerQuery": { - "maximum": 100, - "minimum": 10, - "type": "integer" - } - }, - "required": [ - "Epsilon", - "UsersNoisePerQuery" - ], - "type": "object" - }, - "PrivacyBudgetTemplateIdentifier": { - "maxLength": 36, - "minLength": 36, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "type": "string" - }, - "PrivacyBudgetType": { - "enum": [ - "DIFFERENTIAL_PRIVACY" - ], - "type": "string" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CollaborationArn", - "/properties/CollaborationIdentifier", - "/properties/PrivacyBudgetTemplateIdentifier", - "/properties/Arn", - "/properties/MembershipArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "AutoRefresh", - "PrivacyBudgetType", - "Parameters", - "MembershipIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRooms::PrivacyBudgetTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MembershipIdentifier", + "/properties/PrivacyBudgetType", + "/properties/AutoRefresh" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a privacy budget within a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreatePrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListPrivacyBudgetTemplates" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeletePrivacyBudgetTemplate", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListPrivacyBudgetTemplates", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListPrivacyBudgetTemplates" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdatePrivacyBudgetTemplate", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PrivacyBudgetTemplateIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 200, + "type": "string" + }, + "AutoRefresh": { + "enum": [ + "CALENDAR_MONTH", + "NONE" + ], + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "MembershipArn": { + "maxLength": 100, + "type": "string" + }, + "MembershipIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "properties": { + "Epsilon": { + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "UsersNoisePerQuery": { + "maximum": 100, + "minimum": 10, + "type": "integer" + } + }, + "required": [ + "Epsilon", + "UsersNoisePerQuery" + ], + "type": "object" + }, + "PrivacyBudgetTemplateIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "PrivacyBudgetType": { + "enum": [ + "DIFFERENTIAL_PRIVACY" + ], + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CollaborationArn", + "/properties/CollaborationIdentifier", + "/properties/PrivacyBudgetTemplateIdentifier", + "/properties/Arn", + "/properties/MembershipArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "AutoRefresh", + "PrivacyBudgetType", + "Parameters", + "MembershipIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource", + "cleanrooms:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::PrivacyBudgetTemplate" +} diff --git a/schema/aws-cleanroomsml-trainingdataset.json b/schema/aws-cleanroomsml-trainingdataset.json index 07beb44..781c616 100644 --- a/schema/aws-cleanroomsml-trainingdataset.json +++ b/schema/aws-cleanroomsml-trainingdataset.json @@ -1,259 +1,259 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/RoleArn", - "/properties/TrainingData" - ], - "definitions": { - "ColumnSchema": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - }, - "ColumnTypes": { - "items": { - "$ref": "#/definitions/ColumnType" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ColumnName", - "ColumnTypes" - ], - "type": "object" - }, - "ColumnType": { - "enum": [ - "USER_ID", - "ITEM_ID", - "TIMESTAMP", - "CATEGORICAL_FEATURE", - "NUMERICAL_FEATURE" - ], - "type": "string" - }, - "DataSource": { - "additionalProperties": false, - "properties": { - "GlueDataSource": { - "$ref": "#/definitions/GlueDataSource" - } - }, - "required": [ - "GlueDataSource" - ], - "type": "object" - }, - "Dataset": { - "additionalProperties": false, - "properties": { - "InputConfig": { - "$ref": "#/definitions/DatasetInputConfig" - }, - "Type": { - "$ref": "#/definitions/DatasetType" - } - }, - "required": [ - "InputConfig", - "Type" - ], - "type": "object" - }, - "DatasetInputConfig": { - "additionalProperties": false, - "properties": { - "DataSource": { - "$ref": "#/definitions/DataSource" - }, - "Schema": { - "items": { - "$ref": "#/definitions/ColumnSchema" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "DataSource", - "Schema" - ], - "type": "object" - }, - "DatasetType": { - "enum": [ - "INTERACTIONS" - ], - "type": "string" - }, - "GlueDataSource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "DatabaseName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$", - "type": "string" - }, - "TableName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", - "type": "string" - } - }, - "required": [ - "DatabaseName", - "TableName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TrainingDatasetStatus": { - "enum": [ - "ACTIVE" - ], - "type": "string" - }, - "Unit": { - "additionalProperties": false, - "type": "object" - } - }, - "description": "Definition of AWS::CleanRoomsML::TrainingDataset Resource Type", - "handlers": { - "create": { - "permissions": [ - "cleanrooms-ml:CreateTrainingDataset", - "cleanrooms-ml:GetTrainingDataset", - "cleanrooms-ml:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cleanrooms-ml:DeleteTrainingDataset" - ] - }, - "list": { - "permissions": [ - "cleanrooms-ml:ListTrainingDatasets" - ] - }, - "read": { - "permissions": [ - "cleanrooms-ml:GetTrainingDataset" - ] - }, - "update": { - "permissions": [ - "cleanrooms-ml:TagResource", - "cleanrooms-ml:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrainingDatasetArn" - ], - "properties": { - "Description": { - "maxLength": 255, - "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", - "type": "string" - }, - "Name": { - "maxLength": 63, - "minLength": 1, - "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/TrainingDatasetStatus" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TrainingData": { - "items": { - "$ref": "#/definitions/Dataset" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "TrainingDatasetArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/TrainingDatasetArn" - ], - "required": [ - "Name", - "RoleArn", - "TrainingData" - ], - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "cleanrooms-ml:TagResource", - "cleanrooms-ml:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CleanRoomsML::TrainingDataset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/RoleArn", + "/properties/TrainingData" + ], + "definitions": { + "ColumnSchema": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "ColumnTypes": { + "items": { + "$ref": "#/definitions/ColumnType" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ColumnName", + "ColumnTypes" + ], + "type": "object" + }, + "ColumnType": { + "enum": [ + "USER_ID", + "ITEM_ID", + "TIMESTAMP", + "CATEGORICAL_FEATURE", + "NUMERICAL_FEATURE" + ], + "type": "string" + }, + "DataSource": { + "additionalProperties": false, + "properties": { + "GlueDataSource": { + "$ref": "#/definitions/GlueDataSource" + } + }, + "required": [ + "GlueDataSource" + ], + "type": "object" + }, + "Dataset": { + "additionalProperties": false, + "properties": { + "InputConfig": { + "$ref": "#/definitions/DatasetInputConfig" + }, + "Type": { + "$ref": "#/definitions/DatasetType" + } + }, + "required": [ + "InputConfig", + "Type" + ], + "type": "object" + }, + "DatasetInputConfig": { + "additionalProperties": false, + "properties": { + "DataSource": { + "$ref": "#/definitions/DataSource" + }, + "Schema": { + "items": { + "$ref": "#/definitions/ColumnSchema" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "DataSource", + "Schema" + ], + "type": "object" + }, + "DatasetType": { + "enum": [ + "INTERACTIONS" + ], + "type": "string" + }, + "GlueDataSource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DatabaseName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$", + "type": "string" + }, + "TableName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + } + }, + "required": [ + "DatabaseName", + "TableName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TrainingDatasetStatus": { + "enum": [ + "ACTIVE" + ], + "type": "string" + }, + "Unit": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Definition of AWS::CleanRoomsML::TrainingDataset Resource Type", + "handlers": { + "create": { + "permissions": [ + "cleanrooms-ml:CreateTrainingDataset", + "cleanrooms-ml:GetTrainingDataset", + "cleanrooms-ml:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cleanrooms-ml:DeleteTrainingDataset" + ] + }, + "list": { + "permissions": [ + "cleanrooms-ml:ListTrainingDatasets" + ] + }, + "read": { + "permissions": [ + "cleanrooms-ml:GetTrainingDataset" + ] + }, + "update": { + "permissions": [ + "cleanrooms-ml:TagResource", + "cleanrooms-ml:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrainingDatasetArn" + ], + "properties": { + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/TrainingDatasetStatus" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TrainingData": { + "items": { + "$ref": "#/definitions/Dataset" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "TrainingDatasetArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/TrainingDatasetArn" + ], + "required": [ + "Name", + "RoleArn", + "TrainingData" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "cleanrooms-ml:TagResource", + "cleanrooms-ml:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRoomsML::TrainingDataset" +} diff --git a/schema/aws-cloud9-environmentec2.json b/schema/aws-cloud9-environmentec2.json index 477042a..788528f 100644 --- a/schema/aws-cloud9-environmentec2.json +++ b/schema/aws-cloud9-environmentec2.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutomaticStopTimeMinutes", - "/properties/OwnerArn", - "/properties/ConnectionType", - "/properties/InstanceType", - "/properties/ImageId", - "/properties/SubnetId", - "/properties/Repositories" - ], - "definitions": { - "Repository": { - "additionalProperties": false, - "properties": { - "PathComponent": { - "type": "string" - }, - "RepositoryUrl": { - "type": "string" - } - }, - "required": [ - "PathComponent", - "RepositoryUrl" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cloud9::EnvironmentEC2", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AutomaticStopTimeMinutes": { - "type": "integer" - }, - "ConnectionType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OwnerArn": { - "type": "string" - }, - "Repositories": { - "items": { - "$ref": "#/definitions/Repository" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "ImageId", - "InstanceType" - ], - "typeName": "AWS::Cloud9::EnvironmentEC2" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutomaticStopTimeMinutes", + "/properties/OwnerArn", + "/properties/ConnectionType", + "/properties/InstanceType", + "/properties/ImageId", + "/properties/SubnetId", + "/properties/Repositories" + ], + "definitions": { + "Repository": { + "additionalProperties": false, + "properties": { + "PathComponent": { + "type": "string" + }, + "RepositoryUrl": { + "type": "string" + } + }, + "required": [ + "PathComponent", + "RepositoryUrl" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cloud9::EnvironmentEC2", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AutomaticStopTimeMinutes": { + "type": "integer" + }, + "ConnectionType": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ImageId": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OwnerArn": { + "type": "string" + }, + "Repositories": { + "items": { + "$ref": "#/definitions/Repository" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "ImageId", + "InstanceType" + ], + "typeName": "AWS::Cloud9::EnvironmentEC2" +} diff --git a/schema/aws-cloudformation-customresource.json b/schema/aws-cloudformation-customresource.json index ac0fb70..5d8a7e0 100644 --- a/schema/aws-cloudformation-customresource.json +++ b/schema/aws-cloudformation-customresource.json @@ -1,25 +1,25 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceToken" - ], - "description": "Resource Type definition for AWS::CloudFormation::CustomResource", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "ServiceToken": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ServiceToken" - ], - "typeName": "AWS::CloudFormation::CustomResource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceToken" + ], + "description": "Resource Type definition for AWS::CloudFormation::CustomResource", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "ServiceToken": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ServiceToken" + ], + "typeName": "AWS::CloudFormation::CustomResource" +} diff --git a/schema/aws-cloudformation-hookdefaultversion.json b/schema/aws-cloudformation-hookdefaultversion.json index 61d5163..8031768 100644 --- a/schema/aws-cloudformation-hookdefaultversion.json +++ b/schema/aws-cloudformation-hookdefaultversion.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "description": "Set a version as default version for a hook in CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:SetTypeDefaultVersion" - ] - }, - "delete": { - "permissions": [] - }, - "list": { - "handlerSchema": { - "properties": { - "TypeName": { - "$ref": "resource-schema.json#/properties/TypeName" - } - } - }, - "permissions": [ - "cloudformation:ListTypes" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - }, - "update": { - "permissions": [ - "cloudformation:SetTypeDefaultVersion" - ] - } - }, - "oneOf": [ - { - "required": [ - "TypeVersionArn" - ] - }, - { - "required": [ - "TypeName", - "VersionId" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", - "type": "string" - }, - "TypeVersionArn": { - "description": "The Amazon Resource Name (ARN) of the type version.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", - "type": "string" - }, - "VersionId": { - "description": "The ID of an existing version of the hook to set as the default.", - "pattern": "^[A-Za-z0-9-]{1,128}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFormation::HookDefaultVersion" -} +{ + "additionalProperties": false, + "description": "Set a version as default version for a hook in CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:SetTypeDefaultVersion" + ] + }, + "delete": { + "permissions": [] + }, + "list": { + "handlerSchema": { + "properties": { + "TypeName": { + "$ref": "resource-schema.json#/properties/TypeName" + } + } + }, + "permissions": [ + "cloudformation:ListTypes" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + }, + "update": { + "permissions": [ + "cloudformation:SetTypeDefaultVersion" + ] + } + }, + "oneOf": [ + { + "required": [ + "TypeVersionArn" + ] + }, + { + "required": [ + "TypeName", + "VersionId" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", + "type": "string" + }, + "TypeVersionArn": { + "description": "The Amazon Resource Name (ARN) of the type version.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", + "type": "string" + }, + "VersionId": { + "description": "The ID of an existing version of the hook to set as the default.", + "pattern": "^[A-Za-z0-9-]{1,128}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFormation::HookDefaultVersion" +} diff --git a/schema/aws-cloudformation-hooktypeconfig.json b/schema/aws-cloudformation-hooktypeconfig.json index 7ac619d..8c6dac4 100644 --- a/schema/aws-cloudformation-hooktypeconfig.json +++ b/schema/aws-cloudformation-hooktypeconfig.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigurationAlias" - ], - "description": "Specifies the configuration data for a registered hook in CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:SetTypeConfiguration" - ] - }, - "delete": { - "permissions": [ - "cloudformation:SetTypeConfiguration" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TypeArn": { - "$ref": "resource-schema.json#/properties/TypeArn" - }, - "TypeName": { - "$ref": "resource-schema.json#/properties/TypeName" - } - } - }, - "permissions": [ - "cloudformation:ListTypes", - "cloudformation:BatchDescribeTypeConfigurations" - ] - }, - "read": { - "permissions": [ - "cloudformation:BatchDescribeTypeConfigurations" - ] - }, - "update": { - "permissions": [ - "cloudformation:SetTypeConfiguration" - ] - } - }, - "oneOf": [ - { - "required": [ - "TypeArn", - "Configuration" - ] - }, - { - "required": [ - "TypeName", - "Configuration" - ] - } - ], - "primaryIdentifier": [ - "/properties/ConfigurationArn" - ], - "properties": { - "Configuration": { - "description": "The configuration data for the extension, in this account and region.", - "pattern": "[\\s\\S]+", - "type": "string" - }, - "ConfigurationAlias": { - "default": "default", - "description": "An alias by which to refer to this extension configuration data.", - "enum": [ - "default" - ], - "pattern": "^[a-zA-Z0-9]{1,256}$", - "type": "string" - }, - "ConfigurationArn": { - "description": "The Amazon Resource Name (ARN) for the configuration data, in this account and region.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type(-configuration)?/hook/.+$", - "type": "string" - }, - "TypeArn": { - "description": "The Amazon Resource Name (ARN) of the type without version number.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ConfigurationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFormation::HookTypeConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigurationAlias" + ], + "description": "Specifies the configuration data for a registered hook in CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:SetTypeConfiguration" + ] + }, + "delete": { + "permissions": [ + "cloudformation:SetTypeConfiguration" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TypeArn": { + "$ref": "resource-schema.json#/properties/TypeArn" + }, + "TypeName": { + "$ref": "resource-schema.json#/properties/TypeName" + } + } + }, + "permissions": [ + "cloudformation:ListTypes", + "cloudformation:BatchDescribeTypeConfigurations" + ] + }, + "read": { + "permissions": [ + "cloudformation:BatchDescribeTypeConfigurations" + ] + }, + "update": { + "permissions": [ + "cloudformation:SetTypeConfiguration" + ] + } + }, + "oneOf": [ + { + "required": [ + "TypeArn", + "Configuration" + ] + }, + { + "required": [ + "TypeName", + "Configuration" + ] + } + ], + "primaryIdentifier": [ + "/properties/ConfigurationArn" + ], + "properties": { + "Configuration": { + "description": "The configuration data for the extension, in this account and region.", + "pattern": "[\\s\\S]+", + "type": "string" + }, + "ConfigurationAlias": { + "default": "default", + "description": "An alias by which to refer to this extension configuration data.", + "enum": [ + "default" + ], + "pattern": "^[a-zA-Z0-9]{1,256}$", + "type": "string" + }, + "ConfigurationArn": { + "description": "The Amazon Resource Name (ARN) for the configuration data, in this account and region.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type(-configuration)?/hook/.+$", + "type": "string" + }, + "TypeArn": { + "description": "The Amazon Resource Name (ARN) of the type without version number.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ConfigurationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFormation::HookTypeConfig" +} diff --git a/schema/aws-cloudformation-hookversion.json b/schema/aws-cloudformation-hookversion.json index e249990..4abb2d4 100644 --- a/schema/aws-cloudformation-hookversion.json +++ b/schema/aws-cloudformation-hookversion.json @@ -1,145 +1,145 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ExecutionRoleArn", - "/properties/LoggingConfig", - "/properties/SchemaHandlerPackage", - "/properties/TypeName" - ], - "definitions": { - "LoggingConfig": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", - "type": "string" - }, - "LogRoleArn": { - "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Publishes new or first hook version to AWS CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeType", - "cloudformation:DescribeTypeRegistration", - "cloudformation:RegisterType", - "iam:PassRole", - "s3:GetObject", - "s3:ListBucket", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "cloudformation:DeregisterType", - "cloudformation:DescribeType" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TypeArn": { - "$ref": "resource-schema.json#/properties/TypeArn" - }, - "TypeName": { - "$ref": "resource-schema.json#/properties/TypeName" - } - } - }, - "permissions": [ - "cloudformation:ListTypes", - "cloudformation:ListTypeVersions" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", - "type": "string" - }, - "ExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", - "maxLength": 256, - "pattern": "arn:.+:iam::[0-9]{12}:role/.+", - "type": "string" - }, - "IsDefaultVersion": { - "description": "Indicates if this type version is the current default version", - "type": "boolean" - }, - "LoggingConfig": { - "$ref": "#/definitions/LoggingConfig", - "description": "Specifies logging configuration information for a type." - }, - "SchemaHandlerPackage": { - "description": "A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.\n\nFor information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.", - "maxLength": 4096, - "type": "string" - }, - "TypeArn": { - "description": "The Amazon Resource Name (ARN) of the type without the versionID.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", - "type": "string" - }, - "VersionId": { - "description": "The ID of the version of the type represented by this hook instance.", - "pattern": "^[A-Za-z0-9-]{1,128}$", - "type": "string" - }, - "Visibility": { - "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.", - "enum": [ - "PUBLIC", - "PRIVATE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/IsDefaultVersion", - "/properties/Visibility", - "/properties/VersionId", - "/properties/TypeArn" - ], - "required": [ - "SchemaHandlerPackage", - "TypeName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFormation::HookVersion", - "writeOnlyProperties": [ - "/properties/SchemaHandlerPackage" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ExecutionRoleArn", + "/properties/LoggingConfig", + "/properties/SchemaHandlerPackage", + "/properties/TypeName" + ], + "definitions": { + "LoggingConfig": { + "additionalProperties": false, + "properties": { + "LogGroupName": { + "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + }, + "LogRoleArn": { + "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Publishes new or first hook version to AWS CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeType", + "cloudformation:DescribeTypeRegistration", + "cloudformation:RegisterType", + "iam:PassRole", + "s3:GetObject", + "s3:ListBucket", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "cloudformation:DeregisterType", + "cloudformation:DescribeType" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TypeArn": { + "$ref": "resource-schema.json#/properties/TypeArn" + }, + "TypeName": { + "$ref": "resource-schema.json#/properties/TypeName" + } + } + }, + "permissions": [ + "cloudformation:ListTypes", + "cloudformation:ListTypeVersions" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", + "type": "string" + }, + "ExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", + "maxLength": 256, + "pattern": "arn:.+:iam::[0-9]{12}:role/.+", + "type": "string" + }, + "IsDefaultVersion": { + "description": "Indicates if this type version is the current default version", + "type": "boolean" + }, + "LoggingConfig": { + "$ref": "#/definitions/LoggingConfig", + "description": "Specifies logging configuration information for a type." + }, + "SchemaHandlerPackage": { + "description": "A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.\n\nFor information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.", + "maxLength": 4096, + "type": "string" + }, + "TypeArn": { + "description": "The Amazon Resource Name (ARN) of the type without the versionID.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$", + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", + "type": "string" + }, + "VersionId": { + "description": "The ID of the version of the type represented by this hook instance.", + "pattern": "^[A-Za-z0-9-]{1,128}$", + "type": "string" + }, + "Visibility": { + "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.", + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/IsDefaultVersion", + "/properties/Visibility", + "/properties/VersionId", + "/properties/TypeArn" + ], + "required": [ + "SchemaHandlerPackage", + "TypeName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFormation::HookVersion", + "writeOnlyProperties": [ + "/properties/SchemaHandlerPackage" + ] +} diff --git a/schema/aws-cloudformation-macro.json b/schema/aws-cloudformation-macro.json index a1d9ca2..085cb42 100644 --- a/schema/aws-cloudformation-macro.json +++ b/schema/aws-cloudformation-macro.json @@ -1,38 +1,38 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::CloudFormation::Macro", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "LogRoleARN": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FunctionName", - "Name" - ], - "typeName": "AWS::CloudFormation::Macro" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::CloudFormation::Macro", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "FunctionName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LogGroupName": { + "type": "string" + }, + "LogRoleARN": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FunctionName", + "Name" + ], + "typeName": "AWS::CloudFormation::Macro" +} diff --git a/schema/aws-cloudformation-moduledefaultversion.json b/schema/aws-cloudformation-moduledefaultversion.json index 05ae93a..14a7706 100644 --- a/schema/aws-cloudformation-moduledefaultversion.json +++ b/schema/aws-cloudformation-moduledefaultversion.json @@ -1,74 +1,74 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ModuleName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Arn", - "/properties/ModuleName", - "/properties/VersionId" - ], - "description": "A module that has been registered in the CloudFormation registry as the default version", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeType", - "cloudformation:SetTypeDefaultVersion" - ] - }, - "delete": { - "permissions": [] - }, - "list": { - "permissions": [ - "cloudformation:ListTypes" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - } - }, - "oneOf": [ - { - "required": [ - "Arn" - ] - }, - { - "required": [ - "ModuleName", - "VersionId" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the module version to set as the default version.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+/[0-9]{8}$", - "type": "string" - }, - "ModuleName": { - "description": "The name of a module existing in the registry.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE", - "type": "string" - }, - "VersionId": { - "description": "The ID of an existing version of the named module to set as the default.", - "pattern": "^[0-9]{8}$", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::ModuleDefaultVersion", - "writeOnlyProperties": [ - "/properties/ModuleName", - "/properties/VersionId" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ModuleName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Arn", + "/properties/ModuleName", + "/properties/VersionId" + ], + "description": "A module that has been registered in the CloudFormation registry as the default version", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeType", + "cloudformation:SetTypeDefaultVersion" + ] + }, + "delete": { + "permissions": [] + }, + "list": { + "permissions": [ + "cloudformation:ListTypes" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + } + }, + "oneOf": [ + { + "required": [ + "Arn" + ] + }, + { + "required": [ + "ModuleName", + "VersionId" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the module version to set as the default version.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+/[0-9]{8}$", + "type": "string" + }, + "ModuleName": { + "description": "The name of a module existing in the registry.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE", + "type": "string" + }, + "VersionId": { + "description": "The ID of an existing version of the named module to set as the default.", + "pattern": "^[0-9]{8}$", + "type": "string" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::ModuleDefaultVersion", + "writeOnlyProperties": [ + "/properties/ModuleName", + "/properties/VersionId" + ] +} diff --git a/schema/aws-cloudformation-moduleversion.json b/schema/aws-cloudformation-moduleversion.json index 92e9c55..ae65ff6 100644 --- a/schema/aws-cloudformation-moduleversion.json +++ b/schema/aws-cloudformation-moduleversion.json @@ -1,106 +1,106 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ModuleName", - "/properties/ModulePackage" - ], - "description": "A module that has been registered in the CloudFormation registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeType", - "cloudformation:DescribeTypeRegistration", - "cloudformation:ListTypeVersions", - "cloudformation:RegisterType", - "s3:GetObject", - "s3:ListBucket" - ] - }, - "delete": { - "permissions": [ - "cloudformation:DeregisterType", - "cloudformation:DescribeType" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the module.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+$", - "type": "string" - }, - "Description": { - "description": "The description of the registered module.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "DocumentationUrl": { - "description": "The URL of a page providing detailed documentation for this module.", - "maxLength": 4096, - "type": "string" - }, - "IsDefaultVersion": { - "description": "Indicator of whether this module version is the current default version", - "type": "boolean" - }, - "ModuleName": { - "description": "The name of the module being registered.\n\nRecommended module naming pattern: company_or_organization::service::type::MODULE.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE", - "type": "string" - }, - "ModulePackage": { - "description": "The url to the S3 bucket containing the schema and template fragment for the module you want to register.", - "type": "string" - }, - "Schema": { - "description": "The schema defining input parameters to and resources generated by the module.", - "maxLength": 16777216, - "minLength": 1, - "type": "string" - }, - "TimeCreated": { - "description": "The time that the specified module version was registered.", - "type": "string" - }, - "VersionId": { - "description": "The version ID of the module represented by this module instance.", - "pattern": "^[0-9]{8}$", - "type": "string" - }, - "Visibility": { - "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nThe only allowed value at present is:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.", - "enum": [ - "PRIVATE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Description", - "/properties/DocumentationUrl", - "/properties/IsDefaultVersion", - "/properties/Schema", - "/properties/TimeCreated", - "/properties/VersionId", - "/properties/Visibility" - ], - "required": [ - "ModuleName", - "ModulePackage" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::ModuleVersion", - "writeOnlyProperties": [ - "/properties/ModulePackage" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ModuleName", + "/properties/ModulePackage" + ], + "description": "A module that has been registered in the CloudFormation registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeType", + "cloudformation:DescribeTypeRegistration", + "cloudformation:ListTypeVersions", + "cloudformation:RegisterType", + "s3:GetObject", + "s3:ListBucket" + ] + }, + "delete": { + "permissions": [ + "cloudformation:DeregisterType", + "cloudformation:DescribeType" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the module.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+$", + "type": "string" + }, + "Description": { + "description": "The description of the registered module.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "DocumentationUrl": { + "description": "The URL of a page providing detailed documentation for this module.", + "maxLength": 4096, + "type": "string" + }, + "IsDefaultVersion": { + "description": "Indicator of whether this module version is the current default version", + "type": "boolean" + }, + "ModuleName": { + "description": "The name of the module being registered.\n\nRecommended module naming pattern: company_or_organization::service::type::MODULE.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE", + "type": "string" + }, + "ModulePackage": { + "description": "The url to the S3 bucket containing the schema and template fragment for the module you want to register.", + "type": "string" + }, + "Schema": { + "description": "The schema defining input parameters to and resources generated by the module.", + "maxLength": 16777216, + "minLength": 1, + "type": "string" + }, + "TimeCreated": { + "description": "The time that the specified module version was registered.", + "type": "string" + }, + "VersionId": { + "description": "The version ID of the module represented by this module instance.", + "pattern": "^[0-9]{8}$", + "type": "string" + }, + "Visibility": { + "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nThe only allowed value at present is:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.", + "enum": [ + "PRIVATE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Description", + "/properties/DocumentationUrl", + "/properties/IsDefaultVersion", + "/properties/Schema", + "/properties/TimeCreated", + "/properties/VersionId", + "/properties/Visibility" + ], + "required": [ + "ModuleName", + "ModulePackage" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::ModuleVersion", + "writeOnlyProperties": [ + "/properties/ModulePackage" + ] +} diff --git a/schema/aws-cloudformation-publictypeversion.json b/schema/aws-cloudformation-publictypeversion.json index cf68564..333db58 100644 --- a/schema/aws-cloudformation-publictypeversion.json +++ b/schema/aws-cloudformation-publictypeversion.json @@ -1,112 +1,112 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LogDeliveryBucket", - "/properties/PublicVersionNumber", - "/properties/TypeName", - "/properties/Type", - "/properties/Arn" - ], - "description": "Test and Publish a resource that has been registered in the CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:TestType", - "cloudformation:DescribeType", - "cloudformation:PublishType", - "cloudformation:DescribePublisher", - "s3:GetObject", - "s3:PutObject" - ] - }, - "delete": { - "permissions": [] - }, - "list": { - "permissions": [ - "cloudformation:ListTypes" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType", - "cloudformation:DescribePublisher" - ] - } - }, - "oneOf": [ - { - "required": [ - "TypeName", - "Type" - ] - }, - { - "required": [ - "Arn" - ] - } - ], - "primaryIdentifier": [ - "/properties/PublicTypeArn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Number (ARN) of the extension.", - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+", - "type": "string" - }, - "LogDeliveryBucket": { - "description": "A url to the S3 bucket where logs for the testType run will be available", - "type": "string" - }, - "PublicTypeArn": { - "description": "The Amazon Resource Number (ARN) assigned to the public extension upon publication", - "maxLength": 1024, - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", - "type": "string" - }, - "PublicVersionNumber": { - "description": "The version number of a public third-party extension", - "maxLength": 64, - "minLength": 5, - "type": "string" - }, - "PublisherId": { - "description": "The publisher id assigned by CloudFormation for publishing in this region.", - "maxLength": 40, - "minLength": 1, - "pattern": "[0-9a-zA-Z]{40}", - "type": "string" - }, - "Type": { - "description": "The kind of extension", - "enum": [ - "RESOURCE", - "MODULE", - "HOOK" - ], - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", - "type": "string" - }, - "TypeVersionArn": { - "description": "The Amazon Resource Number (ARN) of the extension with the versionId.", - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PublicTypeArn", - "/properties/TypeVersionArn", - "/properties/PublisherId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::PublicTypeVersion", - "writeOnlyProperties": [ - "/properties/Arn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LogDeliveryBucket", + "/properties/PublicVersionNumber", + "/properties/TypeName", + "/properties/Type", + "/properties/Arn" + ], + "description": "Test and Publish a resource that has been registered in the CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:TestType", + "cloudformation:DescribeType", + "cloudformation:PublishType", + "cloudformation:DescribePublisher", + "s3:GetObject", + "s3:PutObject" + ] + }, + "delete": { + "permissions": [] + }, + "list": { + "permissions": [ + "cloudformation:ListTypes" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType", + "cloudformation:DescribePublisher" + ] + } + }, + "oneOf": [ + { + "required": [ + "TypeName", + "Type" + ] + }, + { + "required": [ + "Arn" + ] + } + ], + "primaryIdentifier": [ + "/properties/PublicTypeArn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Number (ARN) of the extension.", + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+", + "type": "string" + }, + "LogDeliveryBucket": { + "description": "A url to the S3 bucket where logs for the testType run will be available", + "type": "string" + }, + "PublicTypeArn": { + "description": "The Amazon Resource Number (ARN) assigned to the public extension upon publication", + "maxLength": 1024, + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", + "type": "string" + }, + "PublicVersionNumber": { + "description": "The version number of a public third-party extension", + "maxLength": 64, + "minLength": 5, + "type": "string" + }, + "PublisherId": { + "description": "The publisher id assigned by CloudFormation for publishing in this region.", + "maxLength": 40, + "minLength": 1, + "pattern": "[0-9a-zA-Z]{40}", + "type": "string" + }, + "Type": { + "description": "The kind of extension", + "enum": [ + "RESOURCE", + "MODULE", + "HOOK" + ], + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", + "type": "string" + }, + "TypeVersionArn": { + "description": "The Amazon Resource Number (ARN) of the extension with the versionId.", + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PublicTypeArn", + "/properties/TypeVersionArn", + "/properties/PublisherId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::PublicTypeVersion", + "writeOnlyProperties": [ + "/properties/Arn" + ] +} diff --git a/schema/aws-cloudformation-publisher.json b/schema/aws-cloudformation-publisher.json index 153c748..dc43228 100644 --- a/schema/aws-cloudformation-publisher.json +++ b/schema/aws-cloudformation-publisher.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AcceptTermsAndConditions", - "/properties/ConnectionArn" - ], - "description": "Register as a publisher in the CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:RegisterPublisher", - "cloudformation:DescribePublisher", - "codestar-connections:GetConnection", - "codestar-connections:UseConnection" - ] - }, - "delete": { - "permissions": [] - }, - "list": { - "permissions": [ - "cloudformation:DescribePublisher" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribePublisher" - ] - } - }, - "primaryIdentifier": [ - "/properties/PublisherId" - ], - "properties": { - "AcceptTermsAndConditions": { - "description": "Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf", - "type": "boolean" - }, - "ConnectionArn": { - "description": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.", - "pattern": "arn:aws(-[w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "IdentityProvider": { - "description": "The type of account used as the identity provider when registering this publisher with CloudFormation.", - "enum": [ - "AWS_Marketplace", - "GitHub", - "Bitbucket" - ], - "type": "string" - }, - "PublisherId": { - "description": "The publisher id assigned by CloudFormation for publishing in this region.", - "maxLength": 40, - "minLength": 1, - "pattern": "[0-9a-zA-Z]{40}", - "type": "string" - }, - "PublisherProfile": { - "description": "The URL to the publisher's profile with the identity provider.", - "maxLength": 1024, - "pattern": "(http:|https:)+[^s]+[w]", - "type": "string" - }, - "PublisherStatus": { - "description": "Whether the publisher is verified.", - "enum": [ - "VERIFIED", - "UNVERIFIED" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PublisherId", - "/properties/PublisherStatus", - "/properties/PublisherProfile", - "/properties/IdentityProvider" - ], - "required": [ - "AcceptTermsAndConditions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::Publisher", - "writeOnlyProperties": [ - "/properties/ConnectionArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AcceptTermsAndConditions", + "/properties/ConnectionArn" + ], + "description": "Register as a publisher in the CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:RegisterPublisher", + "cloudformation:DescribePublisher", + "codestar-connections:GetConnection", + "codestar-connections:UseConnection" + ] + }, + "delete": { + "permissions": [] + }, + "list": { + "permissions": [ + "cloudformation:DescribePublisher" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribePublisher" + ] + } + }, + "primaryIdentifier": [ + "/properties/PublisherId" + ], + "properties": { + "AcceptTermsAndConditions": { + "description": "Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf", + "type": "boolean" + }, + "ConnectionArn": { + "description": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.", + "pattern": "arn:aws(-[w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "IdentityProvider": { + "description": "The type of account used as the identity provider when registering this publisher with CloudFormation.", + "enum": [ + "AWS_Marketplace", + "GitHub", + "Bitbucket" + ], + "type": "string" + }, + "PublisherId": { + "description": "The publisher id assigned by CloudFormation for publishing in this region.", + "maxLength": 40, + "minLength": 1, + "pattern": "[0-9a-zA-Z]{40}", + "type": "string" + }, + "PublisherProfile": { + "description": "The URL to the publisher's profile with the identity provider.", + "maxLength": 1024, + "pattern": "(http:|https:)+[^s]+[w]", + "type": "string" + }, + "PublisherStatus": { + "description": "Whether the publisher is verified.", + "enum": [ + "VERIFIED", + "UNVERIFIED" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PublisherId", + "/properties/PublisherStatus", + "/properties/PublisherProfile", + "/properties/IdentityProvider" + ], + "required": [ + "AcceptTermsAndConditions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::Publisher", + "writeOnlyProperties": [ + "/properties/ConnectionArn" + ] +} diff --git a/schema/aws-cloudformation-resourcedefaultversion.json b/schema/aws-cloudformation-resourcedefaultversion.json index d66c49d..99086ee 100644 --- a/schema/aws-cloudformation-resourcedefaultversion.json +++ b/schema/aws-cloudformation-resourcedefaultversion.json @@ -1,79 +1,79 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/TypeName" - ] - ], - "additionalProperties": false, - "description": "The default version of a resource that has been registered in the CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:SetTypeDefaultVersion" - ] - }, - "delete": { - "permissions": [ - "" - ] - }, - "list": { - "permissions": [ - "cloudformation:ListTypeVersions" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - }, - "update": { - "permissions": [ - "cloudformation:SetTypeDefaultVersion" - ] - } - }, - "oneOf": [ - { - "required": [ - "TypeVersionArn" - ] - }, - { - "required": [ - "TypeName", - "VersionId" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", - "type": "string" - }, - "TypeVersionArn": { - "description": "The Amazon Resource Name (ARN) of the type version.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", - "type": "string" - }, - "VersionId": { - "description": "The ID of an existing version of the resource to set as the default.", - "pattern": "^[A-Za-z0-9-]{1,128}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::ResourceDefaultVersion" -} +{ + "additionalIdentifiers": [ + [ + "/properties/TypeName" + ] + ], + "additionalProperties": false, + "description": "The default version of a resource that has been registered in the CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:SetTypeDefaultVersion" + ] + }, + "delete": { + "permissions": [ + "" + ] + }, + "list": { + "permissions": [ + "cloudformation:ListTypeVersions" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + }, + "update": { + "permissions": [ + "cloudformation:SetTypeDefaultVersion" + ] + } + }, + "oneOf": [ + { + "required": [ + "TypeVersionArn" + ] + }, + { + "required": [ + "TypeName", + "VersionId" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", + "type": "string" + }, + "TypeVersionArn": { + "description": "The Amazon Resource Name (ARN) of the type version.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", + "type": "string" + }, + "VersionId": { + "description": "The ID of an existing version of the resource to set as the default.", + "pattern": "^[A-Za-z0-9-]{1,128}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::ResourceDefaultVersion" +} diff --git a/schema/aws-cloudformation-resourceversion.json b/schema/aws-cloudformation-resourceversion.json index bc3915e..fc6edea 100644 --- a/schema/aws-cloudformation-resourceversion.json +++ b/schema/aws-cloudformation-resourceversion.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ExecutionRoleArn", - "/properties/LoggingConfig", - "/properties/SchemaHandlerPackage", - "/properties/TypeName" - ], - "definitions": { - "LoggingConfig": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", - "type": "string" - }, - "LogRoleArn": { - "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "A resource that has been registered in the CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeTypeRegistration", - "cloudformation:RegisterType", - "iam:PassRole", - "s3:GetObject", - "s3:ListBucket", - "kms:Decrypt", - "cloudformation:ListTypeVersions", - "cloudformation:DeregisterType", - "cloudformation:DescribeType" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "cloudformation:DeregisterType", - "cloudformation:DescribeType" - ] - }, - "list": { - "permissions": [ - "cloudformation:ListTypes" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", - "type": "string" - }, - "ExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", - "type": "string" - }, - "IsDefaultVersion": { - "description": "Indicates if this type version is the current default version", - "type": "boolean" - }, - "LoggingConfig": { - "$ref": "#/definitions/LoggingConfig", - "description": "Specifies logging configuration information for a type." - }, - "ProvisioningType": { - "description": "The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.", - "enum": [ - "NON_PROVISIONABLE", - "IMMUTABLE", - "FULLY_MUTABLE" - ], - "type": "string" - }, - "SchemaHandlerPackage": { - "description": "A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.\n\nFor information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.", - "type": "string" - }, - "TypeArn": { - "description": "The Amazon Resource Name (ARN) of the type without the versionID.", - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", - "type": "string" - }, - "VersionId": { - "description": "The ID of the version of the type represented by this resource instance.", - "pattern": "^[A-Za-z0-9-]{1,128}$", - "type": "string" - }, - "Visibility": { - "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.", - "enum": [ - "PUBLIC", - "PRIVATE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/IsDefaultVersion", - "/properties/ProvisioningType", - "/properties/Visibility", - "/properties/VersionId", - "/properties/TypeArn" - ], - "required": [ - "SchemaHandlerPackage", - "TypeName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::ResourceVersion", - "writeOnlyProperties": [ - "/properties/SchemaHandlerPackage" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ExecutionRoleArn", + "/properties/LoggingConfig", + "/properties/SchemaHandlerPackage", + "/properties/TypeName" + ], + "definitions": { + "LoggingConfig": { + "additionalProperties": false, + "properties": { + "LogGroupName": { + "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + }, + "LogRoleArn": { + "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "A resource that has been registered in the CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeTypeRegistration", + "cloudformation:RegisterType", + "iam:PassRole", + "s3:GetObject", + "s3:ListBucket", + "kms:Decrypt", + "cloudformation:ListTypeVersions", + "cloudformation:DeregisterType", + "cloudformation:DescribeType" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "cloudformation:DeregisterType", + "cloudformation:DescribeType" + ] + }, + "list": { + "permissions": [ + "cloudformation:ListTypes" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", + "type": "string" + }, + "ExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", + "type": "string" + }, + "IsDefaultVersion": { + "description": "Indicates if this type version is the current default version", + "type": "boolean" + }, + "LoggingConfig": { + "$ref": "#/definitions/LoggingConfig", + "description": "Specifies logging configuration information for a type." + }, + "ProvisioningType": { + "description": "The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.", + "enum": [ + "NON_PROVISIONABLE", + "IMMUTABLE", + "FULLY_MUTABLE" + ], + "type": "string" + }, + "SchemaHandlerPackage": { + "description": "A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.\n\nFor information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.", + "type": "string" + }, + "TypeArn": { + "description": "The Amazon Resource Name (ARN) of the type without the versionID.", + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$", + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$", + "type": "string" + }, + "VersionId": { + "description": "The ID of the version of the type represented by this resource instance.", + "pattern": "^[A-Za-z0-9-]{1,128}$", + "type": "string" + }, + "Visibility": { + "description": "The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.", + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/IsDefaultVersion", + "/properties/ProvisioningType", + "/properties/Visibility", + "/properties/VersionId", + "/properties/TypeArn" + ], + "required": [ + "SchemaHandlerPackage", + "TypeName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::ResourceVersion", + "writeOnlyProperties": [ + "/properties/SchemaHandlerPackage" + ] +} diff --git a/schema/aws-cloudformation-stack.json b/schema/aws-cloudformation-stack.json index 7d18c37..0ac6d08 100644 --- a/schema/aws-cloudformation-stack.json +++ b/schema/aws-cloudformation-stack.json @@ -1,243 +1,243 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/StackName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StackName" - ], - "definitions": { - "Output": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "ExportName": { - "type": "string" - }, - "OutputKey": { - "type": "string" - }, - "OutputValue": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:CreateStack", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:DeleteStack" - ] - }, - "list": { - "permissions": [ - "cloudformation:ListStacks" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:GetStackPolicy", - "cloudformation:GetTemplate" - ] - }, - "update": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:UpdateStack", - "cloudformation:UpdateTerminationProtection", - "cloudformation:SetStackPolicy", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/StackId" - ], - "properties": { - "Capabilities": { - "items": { - "enum": [ - "CAPABILITY_IAM", - "CAPABILITY_NAMED_IAM", - "CAPABILITY_AUTO_EXPAND" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ChangeSetId": { - "type": "string" - }, - "CreationTime": { - "type": "string" - }, - "Description": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "DisableRollback": { - "type": "boolean" - }, - "EnableTerminationProtection": { - "type": "boolean" - }, - "LastUpdateTime": { - "type": "string" - }, - "NotificationARNs": { - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array", - "uniqueItems": false - }, - "Outputs": { - "items": { - "$ref": "#/definitions/Output" - }, - "type": "array", - "uniqueItems": false - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ParentId": { - "type": "string" - }, - "RoleARN": { - "type": "string" - }, - "RootId": { - "type": "string" - }, - "StackId": { - "type": "string" - }, - "StackName": { - "type": "string" - }, - "StackPolicyBody": { - "type": "object" - }, - "StackPolicyURL": { - "type": "string" - }, - "StackStatus": { - "enum": [ - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "CREATE_COMPLETE", - "ROLLBACK_IN_PROGRESS", - "ROLLBACK_FAILED", - "ROLLBACK_COMPLETE", - "DELETE_IN_PROGRESS", - "DELETE_FAILED", - "DELETE_COMPLETE", - "UPDATE_IN_PROGRESS", - "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", - "UPDATE_COMPLETE", - "UPDATE_FAILED", - "UPDATE_ROLLBACK_IN_PROGRESS", - "UPDATE_ROLLBACK_FAILED", - "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", - "UPDATE_ROLLBACK_COMPLETE", - "REVIEW_IN_PROGRESS", - "IMPORT_IN_PROGRESS", - "IMPORT_COMPLETE", - "IMPORT_ROLLBACK_IN_PROGRESS", - "IMPORT_ROLLBACK_FAILED", - "IMPORT_ROLLBACK_COMPLETE" - ], - "type": "string" - }, - "StackStatusReason": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "TemplateBody": { - "type": "object" - }, - "TemplateURL": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "TimeoutInMinutes": { - "minimum": 1, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/StackId", - "/properties/StackStatus", - "/properties/CreationTime", - "/properties/RootId", - "/properties/ParentId", - "/properties/ChangeSetId", - "/properties/Outputs", - "/properties/LastUpdateTime" - ], - "required": [ - "StackName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CloudFormation::Stack", - "writeOnlyProperties": [ - "/properties/TemplateURL", - "/properties/StackPolicyURL" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/StackName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StackName" + ], + "definitions": { + "Output": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "ExportName": { + "type": "string" + }, + "OutputKey": { + "type": "string" + }, + "OutputValue": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:CreateStack", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:DeleteStack" + ] + }, + "list": { + "permissions": [ + "cloudformation:ListStacks" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:GetStackPolicy", + "cloudformation:GetTemplate" + ] + }, + "update": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:UpdateStack", + "cloudformation:UpdateTerminationProtection", + "cloudformation:SetStackPolicy", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/StackId" + ], + "properties": { + "Capabilities": { + "items": { + "enum": [ + "CAPABILITY_IAM", + "CAPABILITY_NAMED_IAM", + "CAPABILITY_AUTO_EXPAND" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ChangeSetId": { + "type": "string" + }, + "CreationTime": { + "type": "string" + }, + "Description": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "DisableRollback": { + "type": "boolean" + }, + "EnableTerminationProtection": { + "type": "boolean" + }, + "LastUpdateTime": { + "type": "string" + }, + "NotificationARNs": { + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array", + "uniqueItems": false + }, + "Outputs": { + "items": { + "$ref": "#/definitions/Output" + }, + "type": "array", + "uniqueItems": false + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ParentId": { + "type": "string" + }, + "RoleARN": { + "type": "string" + }, + "RootId": { + "type": "string" + }, + "StackId": { + "type": "string" + }, + "StackName": { + "type": "string" + }, + "StackPolicyBody": { + "type": "object" + }, + "StackPolicyURL": { + "type": "string" + }, + "StackStatus": { + "enum": [ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATE_COMPLETE", + "ROLLBACK_IN_PROGRESS", + "ROLLBACK_FAILED", + "ROLLBACK_COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETE_COMPLETE", + "UPDATE_IN_PROGRESS", + "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_COMPLETE", + "UPDATE_FAILED", + "UPDATE_ROLLBACK_IN_PROGRESS", + "UPDATE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_ROLLBACK_COMPLETE", + "REVIEW_IN_PROGRESS", + "IMPORT_IN_PROGRESS", + "IMPORT_COMPLETE", + "IMPORT_ROLLBACK_IN_PROGRESS", + "IMPORT_ROLLBACK_FAILED", + "IMPORT_ROLLBACK_COMPLETE" + ], + "type": "string" + }, + "StackStatusReason": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "TemplateBody": { + "type": "object" + }, + "TemplateURL": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "TimeoutInMinutes": { + "minimum": 1, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/StackId", + "/properties/StackStatus", + "/properties/CreationTime", + "/properties/RootId", + "/properties/ParentId", + "/properties/ChangeSetId", + "/properties/Outputs", + "/properties/LastUpdateTime" + ], + "required": [ + "StackName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CloudFormation::Stack", + "writeOnlyProperties": [ + "/properties/TemplateURL", + "/properties/StackPolicyURL" + ] +} diff --git a/schema/aws-cloudformation-stackset.json b/schema/aws-cloudformation-stackset.json index d135ab6..d01f73a 100644 --- a/schema/aws-cloudformation-stackset.json +++ b/schema/aws-cloudformation-stackset.json @@ -1,430 +1,430 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/StackSetName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PermissionModel", - "/properties/StackSetName" - ], - "definitions": { - "Account": { - "description": "AWS account that you want to create stack instances in the specified Region(s) for.", - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "Active": { - "description": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.", - "type": "boolean" - }, - "AutoDeployment": { - "additionalProperties": false, - "properties": { - "Enabled": { - "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.", - "type": "boolean" - }, - "RetainStacksOnAccountRemoval": { - "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.", - "type": "boolean" - } - }, - "type": "object" - }, - "Capability": { - "enum": [ - "CAPABILITY_IAM", - "CAPABILITY_NAMED_IAM", - "CAPABILITY_AUTO_EXPAND" - ], - "type": "string" - }, - "ConcurrencyMode": { - "description": "Specifies how the concurrency level behaves during the operation execution.", - "enum": [ - "STRICT_FAILURE_TOLERANCE", - "SOFT_FAILURE_TOLERANCE" - ], - "type": "string" - }, - "DeploymentTargets": { - "additionalProperties": false, - "description": " The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.", - "properties": { - "AccountFilterType": { - "description": "The filter type you want to apply on organizational units and accounts.", - "enum": [ - "NONE", - "UNION", - "INTERSECTION", - "DIFFERENCE" - ], - "type": "string" - }, - "Accounts": { - "description": "AWS accounts that you want to create stack instances in the specified Region(s) for.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Account" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "AccountsUrl": { - "description": "Returns the value of the AccountsUrl property.", - "maxLength": 5120, - "minLength": 1, - "pattern": "(s3://|http(s?)://).+", - "type": "string" - }, - "OrganizationalUnitIds": { - "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OrganizationalUnitId" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "OperationPreferences": { - "additionalProperties": false, - "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation.", - "properties": { - "ConcurrencyMode": { - "$ref": "#/definitions/ConcurrencyMode" - }, - "FailureToleranceCount": { - "minimum": 0, - "type": "integer" - }, - "FailureTolerancePercentage": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "MaxConcurrentCount": { - "minimum": 1, - "type": "integer" - }, - "MaxConcurrentPercentage": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "RegionConcurrencyType": { - "$ref": "#/definitions/RegionConcurrencyType" - }, - "RegionOrder": { - "items": { - "$ref": "#/definitions/Region" - }, - "type": "array" - } - }, - "type": "object" - }, - "OrganizationalUnitId": { - "pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$", - "type": "string" - }, - "Parameter": { - "additionalProperties": false, - "properties": { - "ParameterKey": { - "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.", - "type": "string" - }, - "ParameterValue": { - "description": "The input value associated with the parameter.", - "type": "string" - } - }, - "required": [ - "ParameterKey", - "ParameterValue" - ], - "type": "object" - }, - "Region": { - "pattern": "^[a-zA-Z0-9-]{1,128}$", - "type": "string" - }, - "RegionConcurrencyType": { - "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time", - "enum": [ - "SEQUENTIAL", - "PARALLEL" - ], - "type": "string" - }, - "StackInstances": { - "additionalProperties": false, - "description": "Stack instances in some specific accounts and Regions.", - "properties": { - "DeploymentTargets": { - "$ref": "#/definitions/DeploymentTargets" - }, - "ParameterOverrides": { - "description": "A list of stack set parameters whose values you want to override in the selected stack instances.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array", - "uniqueItems": true - }, - "Regions": { - "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Region" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "DeploymentTargets", - "Regions" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation StackSet.", - "properties": { - "Key": { - "description": "A string used to identify this tag. You can specify a maximum of 127 characters for a tag key.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\:\\_\\.\\/\\=\\+\\-]+$", - "type": "string" - }, - "Value": { - "description": "A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances", - "handlers": { - "create": { - "permissions": [ - "cloudformation:GetTemplateSummary", - "cloudformation:CreateStackSet", - "cloudformation:CreateStackInstances", - "cloudformation:DescribeStackSetOperation", - "cloudformation:ListStackSetOperationResults", - "cloudformation:TagResource", - "iam:PassRole" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "cloudformation:DeleteStackSet", - "cloudformation:DeleteStackInstances", - "cloudformation:DescribeStackSet", - "cloudformation:DescribeStackSetOperation", - "cloudformation:ListStackSetOperationResults", - "cloudformation:UntagResource" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "cloudformation:ListStackSets", - "cloudformation:DescribeStackSet", - "cloudformation:ListStackInstances", - "cloudformation:DescribeStackInstance" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeStackSet", - "cloudformation:ListStackInstances", - "cloudformation:DescribeStackInstance" - ] - }, - "update": { - "permissions": [ - "cloudformation:GetTemplateSummary", - "cloudformation:UpdateStackSet", - "cloudformation:CreateStackInstances", - "cloudformation:DeleteStackInstances", - "cloudformation:UpdateStackInstances", - "cloudformation:DescribeStackSet", - "cloudformation:DescribeStackSetOperation", - "cloudformation:ListStackSetOperationResults", - "cloudformation:TagResource", - "cloudformation:UntagResource", - "iam:PassRole" - ], - "timeoutInMinutes": 2160 - } - }, - "oneOf": [ - { - "required": [ - "TemplateURL" - ] - }, - { - "required": [ - "TemplateBody" - ] - } - ], - "primaryIdentifier": [ - "/properties/StackSetId" - ], - "properties": { - "AdministrationRoleARN": { - "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "AutoDeployment": { - "$ref": "#/definitions/AutoDeployment", - "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." - }, - "CallAs": { - "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.", - "enum": [ - "SELF", - "DELEGATED_ADMIN" - ], - "type": "string" - }, - "Capabilities": { - "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Capability" - }, - "type": "array", - "uniqueItems": true - }, - "Description": { - "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "ExecutionRoleName": { - "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ManagedExecution": { - "additionalProperties": false, - "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.", - "properties": { - "Active": { - "$ref": "#/definitions/Active" - } - }, - "type": "object" - }, - "OperationPreferences": { - "$ref": "#/definitions/OperationPreferences" - }, - "Parameters": { - "description": "The input parameters for the stack set template.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array", - "uniqueItems": true - }, - "PermissionModel": { - "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.", - "enum": [ - "SERVICE_MANAGED", - "SELF_MANAGED" - ], - "type": "string" - }, - "StackInstancesGroup": { - "description": "A group of stack instances with parameters in some specific accounts and regions.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StackInstances" - }, - "type": "array", - "uniqueItems": true - }, - "StackSetId": { - "description": "The ID of the stack set that you're creating.", - "type": "string" - }, - "StackSetName": { - "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set.", - "maxLength": 128, - "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,127}$", - "type": "string" - }, - "Tags": { - "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TemplateBody": { - "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.", - "maxLength": 51200, - "minLength": 1, - "type": "string" - }, - "TemplateURL": { - "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.", - "maxLength": 5120, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/StackSetId" - ], - "required": [ - "StackSetName", - "PermissionModel" - ], - "resourceLink": { - "mappings": { - "StackSetId": "/StackSetId" - }, - "templateUri": "/cloudformation/home?region=${awsRegion}#/stacksets/${StackSetId}" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation.git", - "typeName": "AWS::CloudFormation::StackSet", - "writeOnlyProperties": [ - "/properties/TemplateURL", - "/properties/OperationPreferences", - "/properties/StackInstancesGroup", - "/properties/CallAs" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/StackSetName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PermissionModel", + "/properties/StackSetName" + ], + "definitions": { + "Account": { + "description": "AWS account that you want to create stack instances in the specified Region(s) for.", + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "Active": { + "description": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.", + "type": "boolean" + }, + "AutoDeployment": { + "additionalProperties": false, + "properties": { + "Enabled": { + "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.", + "type": "boolean" + }, + "RetainStacksOnAccountRemoval": { + "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.", + "type": "boolean" + } + }, + "type": "object" + }, + "Capability": { + "enum": [ + "CAPABILITY_IAM", + "CAPABILITY_NAMED_IAM", + "CAPABILITY_AUTO_EXPAND" + ], + "type": "string" + }, + "ConcurrencyMode": { + "description": "Specifies how the concurrency level behaves during the operation execution.", + "enum": [ + "STRICT_FAILURE_TOLERANCE", + "SOFT_FAILURE_TOLERANCE" + ], + "type": "string" + }, + "DeploymentTargets": { + "additionalProperties": false, + "description": " The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.", + "properties": { + "AccountFilterType": { + "description": "The filter type you want to apply on organizational units and accounts.", + "enum": [ + "NONE", + "UNION", + "INTERSECTION", + "DIFFERENCE" + ], + "type": "string" + }, + "Accounts": { + "description": "AWS accounts that you want to create stack instances in the specified Region(s) for.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Account" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "AccountsUrl": { + "description": "Returns the value of the AccountsUrl property.", + "maxLength": 5120, + "minLength": 1, + "pattern": "(s3://|http(s?)://).+", + "type": "string" + }, + "OrganizationalUnitIds": { + "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OrganizationalUnitId" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "OperationPreferences": { + "additionalProperties": false, + "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation.", + "properties": { + "ConcurrencyMode": { + "$ref": "#/definitions/ConcurrencyMode" + }, + "FailureToleranceCount": { + "minimum": 0, + "type": "integer" + }, + "FailureTolerancePercentage": { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "MaxConcurrentCount": { + "minimum": 1, + "type": "integer" + }, + "MaxConcurrentPercentage": { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "RegionConcurrencyType": { + "$ref": "#/definitions/RegionConcurrencyType" + }, + "RegionOrder": { + "items": { + "$ref": "#/definitions/Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "OrganizationalUnitId": { + "pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$", + "type": "string" + }, + "Parameter": { + "additionalProperties": false, + "properties": { + "ParameterKey": { + "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.", + "type": "string" + }, + "ParameterValue": { + "description": "The input value associated with the parameter.", + "type": "string" + } + }, + "required": [ + "ParameterKey", + "ParameterValue" + ], + "type": "object" + }, + "Region": { + "pattern": "^[a-zA-Z0-9-]{1,128}$", + "type": "string" + }, + "RegionConcurrencyType": { + "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time", + "enum": [ + "SEQUENTIAL", + "PARALLEL" + ], + "type": "string" + }, + "StackInstances": { + "additionalProperties": false, + "description": "Stack instances in some specific accounts and Regions.", + "properties": { + "DeploymentTargets": { + "$ref": "#/definitions/DeploymentTargets" + }, + "ParameterOverrides": { + "description": "A list of stack set parameters whose values you want to override in the selected stack instances.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array", + "uniqueItems": true + }, + "Regions": { + "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Region" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "DeploymentTargets", + "Regions" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation StackSet.", + "properties": { + "Key": { + "description": "A string used to identify this tag. You can specify a maximum of 127 characters for a tag key.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\:\\_\\.\\/\\=\\+\\-]+$", + "type": "string" + }, + "Value": { + "description": "A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances", + "handlers": { + "create": { + "permissions": [ + "cloudformation:GetTemplateSummary", + "cloudformation:CreateStackSet", + "cloudformation:CreateStackInstances", + "cloudformation:DescribeStackSetOperation", + "cloudformation:ListStackSetOperationResults", + "cloudformation:TagResource", + "iam:PassRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "cloudformation:DeleteStackSet", + "cloudformation:DeleteStackInstances", + "cloudformation:DescribeStackSet", + "cloudformation:DescribeStackSetOperation", + "cloudformation:ListStackSetOperationResults", + "cloudformation:UntagResource" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "cloudformation:ListStackSets", + "cloudformation:DescribeStackSet", + "cloudformation:ListStackInstances", + "cloudformation:DescribeStackInstance" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeStackSet", + "cloudformation:ListStackInstances", + "cloudformation:DescribeStackInstance" + ] + }, + "update": { + "permissions": [ + "cloudformation:GetTemplateSummary", + "cloudformation:UpdateStackSet", + "cloudformation:CreateStackInstances", + "cloudformation:DeleteStackInstances", + "cloudformation:UpdateStackInstances", + "cloudformation:DescribeStackSet", + "cloudformation:DescribeStackSetOperation", + "cloudformation:ListStackSetOperationResults", + "cloudformation:TagResource", + "cloudformation:UntagResource", + "iam:PassRole" + ], + "timeoutInMinutes": 2160 + } + }, + "oneOf": [ + { + "required": [ + "TemplateURL" + ] + }, + { + "required": [ + "TemplateBody" + ] + } + ], + "primaryIdentifier": [ + "/properties/StackSetId" + ], + "properties": { + "AdministrationRoleARN": { + "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "AutoDeployment": { + "$ref": "#/definitions/AutoDeployment", + "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." + }, + "CallAs": { + "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.", + "enum": [ + "SELF", + "DELEGATED_ADMIN" + ], + "type": "string" + }, + "Capabilities": { + "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Capability" + }, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "ExecutionRoleName": { + "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ManagedExecution": { + "additionalProperties": false, + "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.", + "properties": { + "Active": { + "$ref": "#/definitions/Active" + } + }, + "type": "object" + }, + "OperationPreferences": { + "$ref": "#/definitions/OperationPreferences" + }, + "Parameters": { + "description": "The input parameters for the stack set template.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array", + "uniqueItems": true + }, + "PermissionModel": { + "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.", + "enum": [ + "SERVICE_MANAGED", + "SELF_MANAGED" + ], + "type": "string" + }, + "StackInstancesGroup": { + "description": "A group of stack instances with parameters in some specific accounts and regions.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StackInstances" + }, + "type": "array", + "uniqueItems": true + }, + "StackSetId": { + "description": "The ID of the stack set that you're creating.", + "type": "string" + }, + "StackSetName": { + "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set.", + "maxLength": 128, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,127}$", + "type": "string" + }, + "Tags": { + "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TemplateBody": { + "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.", + "maxLength": 51200, + "minLength": 1, + "type": "string" + }, + "TemplateURL": { + "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.", + "maxLength": 5120, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StackSetId" + ], + "required": [ + "StackSetName", + "PermissionModel" + ], + "resourceLink": { + "mappings": { + "StackSetId": "/StackSetId" + }, + "templateUri": "/cloudformation/home?region=${awsRegion}#/stacksets/${StackSetId}" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation.git", + "typeName": "AWS::CloudFormation::StackSet", + "writeOnlyProperties": [ + "/properties/TemplateURL", + "/properties/OperationPreferences", + "/properties/StackInstancesGroup", + "/properties/CallAs" + ] +} diff --git a/schema/aws-cloudformation-typeactivation.json b/schema/aws-cloudformation-typeactivation.json index 094e6f4..916f14a 100644 --- a/schema/aws-cloudformation-typeactivation.json +++ b/schema/aws-cloudformation-typeactivation.json @@ -1,157 +1,157 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoggingConfig" - ], - "definitions": { - "LoggingConfig": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", - "type": "string" - }, - "LogRoleArn": { - "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Enable a resource that has been published in the CloudFormation Registry.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:ActivateType", - "cloudformation:DescribeType", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cloudformation:DeactivateType", - "cloudformation:DescribeType" - ] - }, - "list": { - "permissions": [ - "cloudformation:ListTypes" - ] - }, - "read": { - "permissions": [ - "cloudformation:DescribeType" - ] - }, - "update": { - "permissions": [ - "cloudformation:ActivateType", - "cloudformation:DescribeType", - "iam:PassRole" - ] - } - }, - "oneOf": [ - { - "required": [ - "TypeName", - "PublisherId", - "Type" - ] - }, - { - "required": [ - "PublicTypeArn" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the extension.", - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", - "type": "string" - }, - "AutoUpdate": { - "description": "Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.", - "type": "boolean" - }, - "ExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", - "type": "string" - }, - "LoggingConfig": { - "$ref": "#/definitions/LoggingConfig", - "description": "Specifies logging configuration information for a type." - }, - "MajorVersion": { - "description": "The Major Version of the type you want to enable", - "maxLength": 100000, - "minLength": 1, - "type": "string" - }, - "PublicTypeArn": { - "description": "The Amazon Resource Number (ARN) assigned to the public extension upon publication", - "maxLength": 1024, - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", - "type": "string" - }, - "PublisherId": { - "description": "The publisher id assigned by CloudFormation for publishing in this region.", - "maxLength": 40, - "minLength": 1, - "pattern": "[0-9a-zA-Z]{40}", - "type": "string" - }, - "Type": { - "description": "The kind of extension", - "enum": [ - "RESOURCE", - "MODULE", - "HOOK" - ], - "type": "string" - }, - "TypeName": { - "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", - "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", - "type": "string" - }, - "TypeNameAlias": { - "description": "An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.", - "maxLength": 204, - "minLength": 10, - "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", - "type": "string" - }, - "VersionBump": { - "description": "Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled", - "enum": [ - "MAJOR", - "MINOR" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", - "typeName": "AWS::CloudFormation::TypeActivation", - "writeOnlyProperties": [ - "/properties/ExecutionRoleArn", - "/properties/Type", - "/properties/LoggingConfig", - "/properties/VersionBump", - "/properties/AutoUpdate", - "/properties/MajorVersion" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoggingConfig" + ], + "definitions": { + "LoggingConfig": { + "additionalProperties": false, + "properties": { + "LogGroupName": { + "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + }, + "LogRoleArn": { + "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Enable a resource that has been published in the CloudFormation Registry.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:ActivateType", + "cloudformation:DescribeType", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cloudformation:DeactivateType", + "cloudformation:DescribeType" + ] + }, + "list": { + "permissions": [ + "cloudformation:ListTypes" + ] + }, + "read": { + "permissions": [ + "cloudformation:DescribeType" + ] + }, + "update": { + "permissions": [ + "cloudformation:ActivateType", + "cloudformation:DescribeType", + "iam:PassRole" + ] + } + }, + "oneOf": [ + { + "required": [ + "TypeName", + "PublisherId", + "Type" + ] + }, + { + "required": [ + "PublicTypeArn" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the extension.", + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", + "type": "string" + }, + "AutoUpdate": { + "description": "Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.", + "type": "boolean" + }, + "ExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.", + "type": "string" + }, + "LoggingConfig": { + "$ref": "#/definitions/LoggingConfig", + "description": "Specifies logging configuration information for a type." + }, + "MajorVersion": { + "description": "The Major Version of the type you want to enable", + "maxLength": 100000, + "minLength": 1, + "type": "string" + }, + "PublicTypeArn": { + "description": "The Amazon Resource Number (ARN) assigned to the public extension upon publication", + "maxLength": 1024, + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+", + "type": "string" + }, + "PublisherId": { + "description": "The publisher id assigned by CloudFormation for publishing in this region.", + "maxLength": 40, + "minLength": 1, + "pattern": "[0-9a-zA-Z]{40}", + "type": "string" + }, + "Type": { + "description": "The kind of extension", + "enum": [ + "RESOURCE", + "MODULE", + "HOOK" + ], + "type": "string" + }, + "TypeName": { + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type.", + "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", + "type": "string" + }, + "TypeNameAlias": { + "description": "An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.", + "maxLength": 204, + "minLength": 10, + "pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}", + "type": "string" + }, + "VersionBump": { + "description": "Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled", + "enum": [ + "MAJOR", + "MINOR" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation", + "typeName": "AWS::CloudFormation::TypeActivation", + "writeOnlyProperties": [ + "/properties/ExecutionRoleArn", + "/properties/Type", + "/properties/LoggingConfig", + "/properties/VersionBump", + "/properties/AutoUpdate", + "/properties/MajorVersion" + ] +} diff --git a/schema/aws-cloudformation-waitcondition.json b/schema/aws-cloudformation-waitcondition.json index 08f31f2..5418b3d 100644 --- a/schema/aws-cloudformation-waitcondition.json +++ b/schema/aws-cloudformation-waitcondition.json @@ -1,29 +1,29 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::CloudFormation::WaitCondition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Count": { - "type": "integer" - }, - "Data": { - "type": "object" - }, - "Handle": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Timeout": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Data", - "/properties/Id" - ], - "typeName": "AWS::CloudFormation::WaitCondition" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::CloudFormation::WaitCondition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Count": { + "type": "integer" + }, + "Data": { + "type": "object" + }, + "Handle": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Timeout": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Data", + "/properties/Id" + ], + "typeName": "AWS::CloudFormation::WaitCondition" +} diff --git a/schema/aws-cloudformation-waitconditionhandle.json b/schema/aws-cloudformation-waitconditionhandle.json index a8dcd31..13a87d4 100644 --- a/schema/aws-cloudformation-waitconditionhandle.json +++ b/schema/aws-cloudformation-waitconditionhandle.json @@ -1,16 +1,16 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::CloudFormation::WaitConditionHandle", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::CloudFormation::WaitConditionHandle" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::CloudFormation::WaitConditionHandle", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::CloudFormation::WaitConditionHandle" +} diff --git a/schema/aws-cloudfront-cachepolicy.json b/schema/aws-cloudfront-cachepolicy.json index d0ff128..1bae84e 100644 --- a/schema/aws-cloudfront-cachepolicy.json +++ b/schema/aws-cloudfront-cachepolicy.json @@ -1,187 +1,187 @@ -{ - "additionalProperties": false, - "definitions": { - "CachePolicyConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "DefaultTTL": { - "minimum": 0, - "multipleOf": 1.0, - "type": "number" - }, - "MaxTTL": { - "minimum": 0, - "multipleOf": 1.0, - "type": "number" - }, - "MinTTL": { - "minimum": 0, - "multipleOf": 1.0, - "type": "number" - }, - "Name": { - "type": "string" - }, - "ParametersInCacheKeyAndForwardedToOrigin": { - "$ref": "#/definitions/ParametersInCacheKeyAndForwardedToOrigin" - } - }, - "required": [ - "Name", - "MinTTL", - "MaxTTL", - "DefaultTTL", - "ParametersInCacheKeyAndForwardedToOrigin" - ], - "type": "object" - }, - "CookiesConfig": { - "additionalProperties": false, - "properties": { - "CookieBehavior": { - "pattern": "^(none|whitelist|allExcept|all)$", - "type": "string" - }, - "Cookies": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "CookieBehavior" - ], - "type": "object" - }, - "HeadersConfig": { - "additionalProperties": false, - "properties": { - "HeaderBehavior": { - "pattern": "^(none|whitelist)$", - "type": "string" - }, - "Headers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "HeaderBehavior" - ], - "type": "object" - }, - "ParametersInCacheKeyAndForwardedToOrigin": { - "additionalProperties": false, - "properties": { - "CookiesConfig": { - "$ref": "#/definitions/CookiesConfig" - }, - "EnableAcceptEncodingBrotli": { - "type": "boolean" - }, - "EnableAcceptEncodingGzip": { - "type": "boolean" - }, - "HeadersConfig": { - "$ref": "#/definitions/HeadersConfig" - }, - "QueryStringsConfig": { - "$ref": "#/definitions/QueryStringsConfig" - } - }, - "required": [ - "EnableAcceptEncodingGzip", - "HeadersConfig", - "CookiesConfig", - "QueryStringsConfig" - ], - "type": "object" - }, - "QueryStringsConfig": { - "additionalProperties": false, - "properties": { - "QueryStringBehavior": { - "pattern": "^(none|whitelist|allExcept|all)$", - "type": "string" - }, - "QueryStrings": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "QueryStringBehavior" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::CachePolicy", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateCachePolicy" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteCachePolicy", - "cloudfront:GetCachePolicy" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListCachePolicies" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetCachePolicy" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateCachePolicy", - "cloudfront:GetCachePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CachePolicyConfig": { - "$ref": "#/definitions/CachePolicyConfig" - }, - "Id": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/LastModifiedTime" - ], - "required": [ - "CachePolicyConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::CachePolicy" -} +{ + "additionalProperties": false, + "definitions": { + "CachePolicyConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "DefaultTTL": { + "minimum": 0, + "multipleOf": 1.0, + "type": "number" + }, + "MaxTTL": { + "minimum": 0, + "multipleOf": 1.0, + "type": "number" + }, + "MinTTL": { + "minimum": 0, + "multipleOf": 1.0, + "type": "number" + }, + "Name": { + "type": "string" + }, + "ParametersInCacheKeyAndForwardedToOrigin": { + "$ref": "#/definitions/ParametersInCacheKeyAndForwardedToOrigin" + } + }, + "required": [ + "Name", + "MinTTL", + "MaxTTL", + "DefaultTTL", + "ParametersInCacheKeyAndForwardedToOrigin" + ], + "type": "object" + }, + "CookiesConfig": { + "additionalProperties": false, + "properties": { + "CookieBehavior": { + "pattern": "^(none|whitelist|allExcept|all)$", + "type": "string" + }, + "Cookies": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "CookieBehavior" + ], + "type": "object" + }, + "HeadersConfig": { + "additionalProperties": false, + "properties": { + "HeaderBehavior": { + "pattern": "^(none|whitelist)$", + "type": "string" + }, + "Headers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "HeaderBehavior" + ], + "type": "object" + }, + "ParametersInCacheKeyAndForwardedToOrigin": { + "additionalProperties": false, + "properties": { + "CookiesConfig": { + "$ref": "#/definitions/CookiesConfig" + }, + "EnableAcceptEncodingBrotli": { + "type": "boolean" + }, + "EnableAcceptEncodingGzip": { + "type": "boolean" + }, + "HeadersConfig": { + "$ref": "#/definitions/HeadersConfig" + }, + "QueryStringsConfig": { + "$ref": "#/definitions/QueryStringsConfig" + } + }, + "required": [ + "EnableAcceptEncodingGzip", + "HeadersConfig", + "CookiesConfig", + "QueryStringsConfig" + ], + "type": "object" + }, + "QueryStringsConfig": { + "additionalProperties": false, + "properties": { + "QueryStringBehavior": { + "pattern": "^(none|whitelist|allExcept|all)$", + "type": "string" + }, + "QueryStrings": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "QueryStringBehavior" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::CachePolicy", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateCachePolicy" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteCachePolicy", + "cloudfront:GetCachePolicy" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListCachePolicies" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetCachePolicy" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateCachePolicy", + "cloudfront:GetCachePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CachePolicyConfig": { + "$ref": "#/definitions/CachePolicyConfig" + }, + "Id": { + "type": "string" + }, + "LastModifiedTime": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/LastModifiedTime" + ], + "required": [ + "CachePolicyConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::CachePolicy" +} diff --git a/schema/aws-cloudfront-cloudfrontoriginaccessidentity.json b/schema/aws-cloudfront-cloudfrontoriginaccessidentity.json index a7b3051..dd993e7 100644 --- a/schema/aws-cloudfront-cloudfrontoriginaccessidentity.json +++ b/schema/aws-cloudfront-cloudfrontoriginaccessidentity.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "definitions": { - "CloudFrontOriginAccessIdentityConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - } - }, - "required": [ - "Comment" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateCloudFrontOriginAccessIdentity" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteCloudFrontOriginAccessIdentity", - "cloudfront:GetCloudFrontOriginAccessIdentity" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListCloudFrontOriginAccessIdentities" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetCloudFrontOriginAccessIdentity" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateCloudFrontOriginAccessIdentity", - "cloudfront:GetCloudFrontOriginAccessIdentity" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CloudFrontOriginAccessIdentityConfig": { - "$ref": "#/definitions/CloudFrontOriginAccessIdentityConfig" - }, - "Id": { - "type": "string" - }, - "S3CanonicalUserId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/S3CanonicalUserId" - ], - "required": [ - "CloudFrontOriginAccessIdentityConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::CloudFrontOriginAccessIdentity" -} +{ + "additionalProperties": false, + "definitions": { + "CloudFrontOriginAccessIdentityConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + } + }, + "required": [ + "Comment" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateCloudFrontOriginAccessIdentity" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteCloudFrontOriginAccessIdentity", + "cloudfront:GetCloudFrontOriginAccessIdentity" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListCloudFrontOriginAccessIdentities" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetCloudFrontOriginAccessIdentity" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateCloudFrontOriginAccessIdentity", + "cloudfront:GetCloudFrontOriginAccessIdentity" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CloudFrontOriginAccessIdentityConfig": { + "$ref": "#/definitions/CloudFrontOriginAccessIdentityConfig" + }, + "Id": { + "type": "string" + }, + "S3CanonicalUserId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/S3CanonicalUserId" + ], + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::CloudFrontOriginAccessIdentity" +} diff --git a/schema/aws-cloudfront-continuousdeploymentpolicy.json b/schema/aws-cloudfront-continuousdeploymentpolicy.json index 1b082aa..ee8e528 100644 --- a/schema/aws-cloudfront-continuousdeploymentpolicy.json +++ b/schema/aws-cloudfront-continuousdeploymentpolicy.json @@ -1,220 +1,220 @@ -{ - "additionalProperties": false, - "definitions": { - "ContinuousDeploymentPolicyConfig": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "SingleHeaderPolicyConfig": { - "additionalProperties": false, - "properties": { - "Header": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 1783, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Header", - "Value" - ], - "type": "object" - }, - "SingleWeightPolicyConfig": { - "additionalProperties": false, - "properties": { - "SessionStickinessConfig": { - "$ref": "#/definitions/SessionStickinessConfig" - }, - "Weight": { - "maximum": 1, - "minimum": 0, - "multipleOf": 0.01, - "type": "number" - } - }, - "required": [ - "Weight" - ], - "type": "object" - }, - "StagingDistributionDnsNames": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TrafficConfig": { - "$ref": "#/definitions/TrafficConfig" - }, - "Type": { - "enum": [ - "SingleWeight", - "SingleHeader" - ], - "type": "string" - } - }, - "required": [ - "Enabled", - "StagingDistributionDnsNames" - ], - "type": "object" - }, - "SessionStickinessConfig": { - "additionalProperties": false, - "properties": { - "IdleTTL": { - "maximum": 3600, - "minimum": 300, - "multipleOf": 1, - "type": "integer" - }, - "MaximumTTL": { - "maximum": 3600, - "minimum": 300, - "multipleOf": 1, - "type": "integer" - } - }, - "required": [ - "IdleTTL", - "MaximumTTL" - ], - "type": "object" - }, - "SingleHeaderConfig": { - "additionalProperties": false, - "properties": { - "Header": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 1783, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Header", - "Value" - ], - "type": "object" - }, - "SingleWeightConfig": { - "additionalProperties": false, - "properties": { - "SessionStickinessConfig": { - "$ref": "#/definitions/SessionStickinessConfig" - }, - "Weight": { - "maximum": 1, - "minimum": 0, - "multipleOf": 0.01, - "type": "number" - } - }, - "required": [ - "Weight" - ], - "type": "object" - }, - "TrafficConfig": { - "additionalProperties": false, - "properties": { - "SingleHeaderConfig": { - "$ref": "#/definitions/SingleHeaderConfig" - }, - "SingleWeightConfig": { - "$ref": "#/definitions/SingleWeightConfig" - }, - "Type": { - "enum": [ - "SingleWeight", - "SingleHeader" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/definitions/ContinuousDeploymentPolicyConfig/properties/Type", - "/definitions/ContinuousDeploymentPolicyConfig/properties/SingleHeaderPolicyConfig", - "/definitions/ContinuousDeploymentPolicyConfig/properties/SingleWeightPolicyConfig" - ], - "description": "Resource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateContinuousDeploymentPolicy" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteContinuousDeploymentPolicy", - "cloudfront:GetContinuousDeploymentPolicy" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListContinuousDeploymentPolicies" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetContinuousDeploymentPolicy" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateContinuousDeploymentPolicy", - "cloudfront:GetContinuousDeploymentPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ContinuousDeploymentPolicyConfig": { - "$ref": "#/definitions/ContinuousDeploymentPolicyConfig" - }, - "Id": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/LastModifiedTime" - ], - "required": [ - "ContinuousDeploymentPolicyConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::ContinuousDeploymentPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "ContinuousDeploymentPolicyConfig": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "SingleHeaderPolicyConfig": { + "additionalProperties": false, + "properties": { + "Header": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 1783, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Header", + "Value" + ], + "type": "object" + }, + "SingleWeightPolicyConfig": { + "additionalProperties": false, + "properties": { + "SessionStickinessConfig": { + "$ref": "#/definitions/SessionStickinessConfig" + }, + "Weight": { + "maximum": 1, + "minimum": 0, + "multipleOf": 0.01, + "type": "number" + } + }, + "required": [ + "Weight" + ], + "type": "object" + }, + "StagingDistributionDnsNames": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TrafficConfig": { + "$ref": "#/definitions/TrafficConfig" + }, + "Type": { + "enum": [ + "SingleWeight", + "SingleHeader" + ], + "type": "string" + } + }, + "required": [ + "Enabled", + "StagingDistributionDnsNames" + ], + "type": "object" + }, + "SessionStickinessConfig": { + "additionalProperties": false, + "properties": { + "IdleTTL": { + "maximum": 3600, + "minimum": 300, + "multipleOf": 1, + "type": "integer" + }, + "MaximumTTL": { + "maximum": 3600, + "minimum": 300, + "multipleOf": 1, + "type": "integer" + } + }, + "required": [ + "IdleTTL", + "MaximumTTL" + ], + "type": "object" + }, + "SingleHeaderConfig": { + "additionalProperties": false, + "properties": { + "Header": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 1783, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Header", + "Value" + ], + "type": "object" + }, + "SingleWeightConfig": { + "additionalProperties": false, + "properties": { + "SessionStickinessConfig": { + "$ref": "#/definitions/SessionStickinessConfig" + }, + "Weight": { + "maximum": 1, + "minimum": 0, + "multipleOf": 0.01, + "type": "number" + } + }, + "required": [ + "Weight" + ], + "type": "object" + }, + "TrafficConfig": { + "additionalProperties": false, + "properties": { + "SingleHeaderConfig": { + "$ref": "#/definitions/SingleHeaderConfig" + }, + "SingleWeightConfig": { + "$ref": "#/definitions/SingleWeightConfig" + }, + "Type": { + "enum": [ + "SingleWeight", + "SingleHeader" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/definitions/ContinuousDeploymentPolicyConfig/properties/Type", + "/definitions/ContinuousDeploymentPolicyConfig/properties/SingleHeaderPolicyConfig", + "/definitions/ContinuousDeploymentPolicyConfig/properties/SingleWeightPolicyConfig" + ], + "description": "Resource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateContinuousDeploymentPolicy" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteContinuousDeploymentPolicy", + "cloudfront:GetContinuousDeploymentPolicy" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListContinuousDeploymentPolicies" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetContinuousDeploymentPolicy" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateContinuousDeploymentPolicy", + "cloudfront:GetContinuousDeploymentPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ContinuousDeploymentPolicyConfig": { + "$ref": "#/definitions/ContinuousDeploymentPolicyConfig" + }, + "Id": { + "type": "string" + }, + "LastModifiedTime": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/LastModifiedTime" + ], + "required": [ + "ContinuousDeploymentPolicyConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::ContinuousDeploymentPolicy" +} diff --git a/schema/aws-cloudfront-distribution.json b/schema/aws-cloudfront-distribution.json index 294ac15..d10b65c 100644 --- a/schema/aws-cloudfront-distribution.json +++ b/schema/aws-cloudfront-distribution.json @@ -1,1028 +1,1028 @@ -{ - "additionalProperties": false, - "definitions": { - "CacheBehavior": { - "additionalProperties": false, - "description": "A complex type that describes how CloudFront processes requests.\n You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.\n For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.\n If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't include an empty ``CacheBehavior`` element because this is invalid.\n To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element.\n To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.\n For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.", - "properties": { - "AllowedMethods": { - "default": [ - "GET", - "HEAD" - ], - "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CachePolicyId": { - "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", - "type": "string" - }, - "CachedMethods": { - "default": [ - "GET", - "HEAD" - ], - "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Compress": { - "default": false, - "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", - "type": "boolean" - }, - "DefaultTTL": { - "default": 86400, - "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "number" - }, - "FieldLevelEncryptionId": { - "default": "", - "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.", - "type": "string" - }, - "ForwardedValues": { - "$ref": "#/definitions/ForwardedValues", - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." - }, - "FunctionAssociations": { - "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", - "items": { - "$ref": "#/definitions/FunctionAssociation" - }, - "type": "array", - "uniqueItems": false - }, - "LambdaFunctionAssociations": { - "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", - "items": { - "$ref": "#/definitions/LambdaFunctionAssociation" - }, - "type": "array", - "uniqueItems": false - }, - "MaxTTL": { - "default": 31536000, - "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "number" - }, - "MinTTL": { - "default": 0, - "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", - "type": "number" - }, - "OriginRequestPolicyId": { - "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "PathPattern": { - "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.\n You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``.\n The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.\n For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "RealtimeLogConfigArn": { - "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "ResponseHeadersPolicyId": { - "description": "The identifier for a response headers policy.", - "type": "string" - }, - "SmoothStreaming": { - "default": false, - "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", - "type": "boolean" - }, - "TargetOriginId": { - "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior.", - "type": "string" - }, - "TrustedKeyGroups": { - "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TrustedSigners": { - "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ViewerProtocolPolicy": { - "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - } - }, - "required": [ - "PathPattern", - "TargetOriginId", - "ViewerProtocolPolicy" - ], - "type": "object" - }, - "Cookies": { - "additionalProperties": false, - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.", - "properties": { - "Forward": { - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type.\n Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element.", - "type": "string" - }, - "WhitelistedNames": { - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.\n If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically.\n For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Forward" - ], - "type": "object" - }, - "CustomErrorResponse": { - "additionalProperties": false, - "description": "A complex type that controls:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", - "properties": { - "ErrorCachingMinTTL": { - "default": 300, - "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.\n For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", - "type": "number" - }, - "ErrorCode": { - "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration.", - "type": "integer" - }, - "ResponseCode": { - "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted.\n + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors.\n + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down.\n \n If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``.", - "type": "integer" - }, - "ResponsePagePath": { - "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:\n + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``.\n + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages.\n \n If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``.\n We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.", - "type": "string" - } - }, - "required": [ - "ErrorCode" - ], - "type": "object" - }, - "CustomOriginConfig": { - "additionalProperties": false, - "description": "A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.", - "properties": { - "HTTPPort": { - "default": 80, - "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.", - "type": "integer" - }, - "HTTPSPort": { - "default": 443, - "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.", - "type": "integer" - }, - "OriginKeepaliveTimeout": { - "default": 5, - "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.", - "type": "integer" - }, - "OriginProtocolPolicy": { - "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:\n + ``http-only`` \u2013 CloudFront always uses HTTP to connect to the origin.\n + ``match-viewer`` \u2013 CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.\n + ``https-only`` \u2013 CloudFront always uses HTTPS to connect to the origin.", - "type": "string" - }, - "OriginReadTimeout": { - "default": 30, - "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.", - "type": "integer" - }, - "OriginSSLProtocols": { - "default": [ - "TLSv1", - "SSLv3" - ], - "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "OriginProtocolPolicy" - ], - "type": "object" - }, - "DefaultCacheBehavior": { - "additionalProperties": false, - "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.", - "properties": { - "AllowedMethods": { - "default": [ - "GET", - "HEAD" - ], - "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CachePolicyId": { - "default": "", - "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", - "type": "string" - }, - "CachedMethods": { - "default": [ - "GET", - "HEAD" - ], - "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Compress": { - "default": false, - "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", - "type": "boolean" - }, - "DefaultTTL": { - "default": 86400, - "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "number" - }, - "FieldLevelEncryptionId": { - "default": "", - "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.", - "type": "string" - }, - "ForwardedValues": { - "$ref": "#/definitions/ForwardedValues", - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." - }, - "FunctionAssociations": { - "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", - "items": { - "$ref": "#/definitions/FunctionAssociation" - }, - "type": "array", - "uniqueItems": false - }, - "LambdaFunctionAssociations": { - "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", - "items": { - "$ref": "#/definitions/LambdaFunctionAssociation" - }, - "type": "array", - "uniqueItems": false - }, - "MaxTTL": { - "default": 31536000, - "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "number" - }, - "MinTTL": { - "default": 0, - "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", - "type": "number" - }, - "OriginRequestPolicyId": { - "default": "", - "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "RealtimeLogConfigArn": { - "default": "", - "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "ResponseHeadersPolicyId": { - "default": "", - "description": "The identifier for a response headers policy.", - "type": "string" - }, - "SmoothStreaming": { - "default": false, - "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", - "type": "boolean" - }, - "TargetOriginId": { - "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior.", - "type": "string" - }, - "TrustedKeyGroups": { - "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TrustedSigners": { - "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ViewerProtocolPolicy": { - "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - } - }, - "required": [ - "TargetOriginId", - "ViewerProtocolPolicy" - ], - "type": "object" - }, - "DistributionConfig": { - "additionalProperties": false, - "description": "A distribution configuration.", - "properties": { - "Aliases": { - "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CNAMEs": { - "description": "", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CacheBehaviors": { - "description": "A complex type that contains zero or more ``CacheBehavior`` elements.", - "items": { - "$ref": "#/definitions/CacheBehavior" - }, - "type": "array", - "uniqueItems": false - }, - "Comment": { - "default": "", - "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters.", - "type": "string" - }, - "ContinuousDeploymentPolicyId": { - "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``.", - "type": "string" - }, - "CustomErrorResponses": { - "description": "A complex type that controls the following:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "$ref": "#/definitions/CustomErrorResponse" - }, - "type": "array", - "uniqueItems": false - }, - "CustomOrigin": { - "$ref": "#/definitions/LegacyCustomOrigin", - "description": "" - }, - "DefaultCacheBehavior": { - "$ref": "#/definitions/DefaultCacheBehavior", - "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." - }, - "DefaultRootObject": { - "default": "", - "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution.\n Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name.\n If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element.\n To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element.\n To replace the default root object, update the distribution configuration and specify the new object.\n For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "Enabled": { - "description": "From this field, you can enable or disable the selected distribution.", - "type": "boolean" - }, - "HttpVersion": { - "default": "http1.1", - "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.\n For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).\n For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", - "type": "string" - }, - "IPV6Enabled": { - "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.\n In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.\n If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:\n + You enable IPv6 for the distribution\n + You're using alternate domain names in the URLs for your objects\n \n For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*.\n If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.", - "type": "boolean" - }, - "Logging": { - "$ref": "#/definitions/Logging", - "description": "A complex type that controls whether access logs are written for the distribution.\n For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*." - }, - "OriginGroups": { - "$ref": "#/definitions/OriginGroups", - "description": "A complex type that contains information about origin groups for this distribution." - }, - "Origins": { - "description": "A complex type that contains information about origins for this distribution.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Origin" - }, - "type": "array", - "uniqueItems": false - }, - "PriceClass": { - "default": "PriceClass_All", - "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.\n If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.\n For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/).", - "type": "string" - }, - "Restrictions": { - "$ref": "#/definitions/Restrictions", - "default": { - "GeoRestriction": { - "RestrictionType": "none" - } - }, - "description": "A complex type that identifies ways in which you want to restrict distribution of your content." - }, - "S3Origin": { - "$ref": "#/definitions/LegacyS3Origin", - "description": "" - }, - "Staging": { - "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution.", - "type": "boolean" - }, - "ViewerCertificate": { - "$ref": "#/definitions/ViewerCertificate", - "default": { - "CloudFrontDefaultCertificate": true - }, - "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers." - }, - "WebACLId": { - "default": "", - "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``.\n WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).", - "type": "string" - } - }, - "required": [ - "Enabled", - "DefaultCacheBehavior" - ], - "type": "object" - }, - "ForwardedValues": { - "additionalProperties": false, - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.", - "properties": { - "Cookies": { - "$ref": "#/definitions/Cookies", - "default": { - "Forward": "none" - }, - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." - }, - "Headers": { - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.\n For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "QueryString": { - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any:\n If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.\n If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.\n If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.\n For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*.", - "type": "boolean" - }, - "QueryStringCacheKeys": { - "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "QueryString" - ], - "type": "object" - }, - "FunctionAssociation": { - "additionalProperties": false, - "description": "A CloudFront function that is associated with a cache behavior in a CloudFront distribution.", - "properties": { - "EventType": { - "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function.", - "type": "string" - }, - "FunctionARN": { - "description": "The Amazon Resource Name (ARN) of the function.", - "type": "string" - } - }, - "type": "object" - }, - "GeoRestriction": { - "additionalProperties": false, - "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.", - "properties": { - "Locations": { - "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``).\n The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country.\n CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RestrictionType": { - "description": "The method that you want to use to restrict distribution of your content by country:\n + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location.\n + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content.", - "type": "string" - } - }, - "required": [ - "RestrictionType" - ], - "type": "object" - }, - "LambdaFunctionAssociation": { - "additionalProperties": false, - "description": "A complex type that contains a Lambda@Edge function association.", - "properties": { - "EventType": { - "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:\n + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.\n + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.\n + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.\n + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.\n If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.", - "type": "string" - }, - "IncludeBody": { - "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide.", - "type": "boolean" - }, - "LambdaFunctionARN": { - "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.", - "type": "string" - } - }, - "type": "object" - }, - "LegacyCustomOrigin": { - "additionalProperties": false, - "description": "", - "properties": { - "DNSName": { - "description": "", - "type": "string" - }, - "HTTPPort": { - "default": 80, - "description": "", - "type": "integer" - }, - "HTTPSPort": { - "default": 443, - "description": "", - "type": "integer" - }, - "OriginProtocolPolicy": { - "description": "", - "type": "string" - }, - "OriginSSLProtocols": { - "description": "", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "DNSName", - "OriginProtocolPolicy", - "OriginSSLProtocols" - ], - "type": "object" - }, - "LegacyS3Origin": { - "additionalProperties": false, - "description": "", - "properties": { - "DNSName": { - "description": "", - "type": "string" - }, - "OriginAccessIdentity": { - "default": "", - "description": "", - "type": "string" - } - }, - "required": [ - "DNSName" - ], - "type": "object" - }, - "Logging": { - "additionalProperties": false, - "description": "A complex type that controls whether access logs are written for the distribution.", - "properties": { - "Bucket": { - "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``.", - "type": "string" - }, - "IncludeCookies": { - "default": false, - "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``.", - "type": "boolean" - }, - "Prefix": { - "default": "", - "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element.", - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "Origin": { - "additionalProperties": false, - "description": "An origin.\n An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:\n + Use ``S3OriginConfig`` to specify an Amazon S3 bucket that is not configured with static website hosting.\n + Use ``CustomOriginConfig`` to specify all other kinds of origins, including:\n + An Amazon S3 bucket that is configured with static website hosting\n + An Elastic Load Balancing load balancer\n + An EMPlong endpoint\n + An EMSlong container\n + Any other HTTP server, running on an Amazon EC2 instance or any other kind of host\n \n \n For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).", - "properties": { - "ConnectionAttempts": { - "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.\n For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).\n For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*.", - "type": "integer" - }, - "ConnectionTimeout": { - "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.\n For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*.", - "type": "integer" - }, - "CustomOriginConfig": { - "$ref": "#/definitions/CustomOriginConfig", - "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead." - }, - "DomainName": { - "description": "The domain name for the origin.\n For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "Id": { - "description": "A unique identifier for the origin. This value must be unique within the distribution.\n Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``.", - "type": "string" - }, - "OriginAccessControlId": { - "description": "The unique identifier of an origin access control for this origin.\n For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "OriginCustomHeaders": { - "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.\n For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", - "items": { - "$ref": "#/definitions/OriginCustomHeader" - }, - "type": "array", - "uniqueItems": false - }, - "OriginPath": { - "default": "", - "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.\n For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "OriginShield": { - "$ref": "#/definitions/OriginShield", - "description": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.\n For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*." - }, - "S3OriginConfig": { - "$ref": "#/definitions/S3OriginConfig", - "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead." - } - }, - "required": [ - "DomainName", - "Id" - ], - "type": "object" - }, - "OriginCustomHeader": { - "additionalProperties": false, - "description": "A complex type that contains ``HeaderName`` and ``HeaderValue`` elements, if any, for this distribution.", - "properties": { - "HeaderName": { - "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - }, - "HeaderValue": { - "description": "The value for the header that you specified in the ``HeaderName`` field.", - "type": "string" - } - }, - "required": [ - "HeaderValue", - "HeaderName" - ], - "type": "object" - }, - "OriginGroup": { - "additionalProperties": false, - "description": "An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.", - "properties": { - "FailoverCriteria": { - "$ref": "#/definitions/OriginGroupFailoverCriteria", - "description": "A complex type that contains information about the failover criteria for an origin group." - }, - "Id": { - "description": "The origin group's ID.", - "type": "string" - }, - "Members": { - "$ref": "#/definitions/OriginGroupMembers", - "description": "A complex type that contains information about the origins in an origin group." - } - }, - "required": [ - "Id", - "FailoverCriteria", - "Members" - ], - "type": "object" - }, - "OriginGroupFailoverCriteria": { - "additionalProperties": false, - "description": "A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.", - "properties": { - "StatusCodes": { - "$ref": "#/definitions/StatusCodes", - "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin." - } - }, - "required": [ - "StatusCodes" - ], - "type": "object" - }, - "OriginGroupMember": { - "additionalProperties": false, - "description": "An origin in an origin group.", - "properties": { - "OriginId": { - "description": "The ID for an origin in an origin group.", - "type": "string" - } - }, - "required": [ - "OriginId" - ], - "type": "object" - }, - "OriginGroupMembers": { - "additionalProperties": false, - "description": "A complex data type for the origins included in an origin group.", - "properties": { - "Items": { - "description": "Items (origins) in an origin group.", - "items": { - "$ref": "#/definitions/OriginGroupMember" - }, - "type": "array", - "uniqueItems": false - }, - "Quantity": { - "description": "The number of origins in an origin group.", - "type": "integer" - } - }, - "required": [ - "Quantity", - "Items" - ], - "type": "object" - }, - "OriginGroups": { - "additionalProperties": false, - "description": "A complex data type for the origin groups specified for a distribution.", - "properties": { - "Items": { - "description": "The items (origin groups) in a distribution.", - "items": { - "$ref": "#/definitions/OriginGroup" - }, - "type": "array", - "uniqueItems": false - }, - "Quantity": { - "description": "The number of origin groups.", - "type": "integer" - } - }, - "required": [ - "Quantity" - ], - "type": "object" - }, - "OriginShield": { - "additionalProperties": false, - "description": "CloudFront Origin Shield.\n Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.", - "properties": { - "Enabled": { - "description": "A flag that specifies whether Origin Shield is enabled.\n When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.", - "type": "boolean" - }, - "OriginShieldRegion": { - "description": "The AWS-Region for Origin Shield.\n Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``.\n When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "Restrictions": { - "additionalProperties": false, - "description": "A complex type that identifies ways in which you want to restrict distribution of your content.", - "properties": { - "GeoRestriction": { - "$ref": "#/definitions/GeoRestriction", - "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." - } - }, - "required": [ - "GeoRestriction" - ], - "type": "object" - }, - "S3OriginConfig": { - "additionalProperties": false, - "description": "A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead.", - "properties": { - "OriginAccessIdentity": { - "default": "", - "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:\n origin-access-identity/cloudfront/*ID-of-origin-access-identity* \n where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.\n If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.\n To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.\n To replace the origin access identity, update the distribution configuration and specify the new origin access identity.\n For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "StatusCodes": { - "additionalProperties": false, - "description": "A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.", - "properties": { - "Items": { - "description": "The items (status codes) for an origin group.", - "items": { - "type": "integer" - }, - "type": "array", - "uniqueItems": false - }, - "Quantity": { - "description": "The number of status codes.", - "type": "integer" - } - }, - "required": [ - "Quantity", - "Items" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A complex type that contains ``Tag`` key and ``Tag`` value.", - "properties": { - "Key": { - "description": "A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", - "type": "string" - }, - "Value": { - "description": "A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ViewerCertificate": { - "additionalProperties": false, - "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.\n If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)\u2014that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``\u2014set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:\n + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI.\n + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n \n + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*.\n + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both):\n + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.)\n + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.)\n \n \n All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``.\n For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*.", - "properties": { - "AcmCertificateArn": { - "description": "In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``).\n If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", - "type": "string" - }, - "CloudFrontDefaultCertificate": { - "description": "If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields:\n + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) \n + ``MinimumProtocolVersion`` \n + ``SslSupportMethod``", - "type": "boolean" - }, - "IamCertificateId": { - "description": "In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.\n If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", - "type": "string" - }, - "MinimumProtocolVersion": { - "description": "If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:\n + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.\n + The ciphers that CloudFront can use to encrypt the content that it returns to viewers.\n \n For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*.\n On the CloudFront console, this setting is called *Security Policy*.\n When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here.", - "type": "string" - }, - "SslSupportMethod": { - "description": "In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.\n + ``sni-only`` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI.\n + ``vip`` \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.\n + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home).\n \n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field.", - "type": "string" - } - }, - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/DistributionConfig/properties/CustomOrigin", - "/properties/DistributionConfig/properties/S3Origin" - ], - "description": "A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateDistribution", - "cloudfront:CreateDistributionWithTags", - "cloudfront:GetDistribution", - "cloudfront:GetDistributionConfig", - "cloudfront:TagResource" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteDistribution", - "cloudfront:GetDistribution", - "cloudfront:GetDistributionConfig" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListDistributions" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetDistribution", - "cloudfront:GetDistributionConfig" - ] - }, - "update": { - "permissions": [ - "cloudfront:GetDistribution", - "cloudfront:GetDistributionConfig", - "cloudfront:UpdateDistribution", - "cloudfront:UpdateDistributionWithStagingConfig", - "cloudfront:ListTagsForResource", - "cloudfront:TagResource", - "cloudfront:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DistributionConfig": { - "$ref": "#/definitions/DistributionConfig", - "description": "The distribution's configuration." - }, - "DomainName": { - "description": "", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "A complex type that contains zero or more ``Tag`` elements.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/DomainName" - ], - "required": [ - "DistributionConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::Distribution" -} +{ + "additionalProperties": false, + "definitions": { + "CacheBehavior": { + "additionalProperties": false, + "description": "A complex type that describes how CloudFront processes requests.\n You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.\n For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.\n If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't include an empty ``CacheBehavior`` element because this is invalid.\n To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element.\n To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.\n For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.", + "properties": { + "AllowedMethods": { + "default": [ + "GET", + "HEAD" + ], + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CachePolicyId": { + "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", + "type": "string" + }, + "CachedMethods": { + "default": [ + "GET", + "HEAD" + ], + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Compress": { + "default": false, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", + "type": "boolean" + }, + "DefaultTTL": { + "default": 86400, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "number" + }, + "FieldLevelEncryptionId": { + "default": "", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.", + "type": "string" + }, + "ForwardedValues": { + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "FunctionAssociations": { + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", + "items": { + "$ref": "#/definitions/FunctionAssociation" + }, + "type": "array", + "uniqueItems": false + }, + "LambdaFunctionAssociations": { + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", + "items": { + "$ref": "#/definitions/LambdaFunctionAssociation" + }, + "type": "array", + "uniqueItems": false + }, + "MaxTTL": { + "default": 31536000, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "number" + }, + "MinTTL": { + "default": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", + "type": "number" + }, + "OriginRequestPolicyId": { + "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "PathPattern": { + "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.\n You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``.\n The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.\n For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "RealtimeLogConfigArn": { + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "ResponseHeadersPolicyId": { + "description": "The identifier for a response headers policy.", + "type": "string" + }, + "SmoothStreaming": { + "default": false, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", + "type": "boolean" + }, + "TargetOriginId": { + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior.", + "type": "string" + }, + "TrustedKeyGroups": { + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TrustedSigners": { + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ViewerProtocolPolicy": { + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + } + }, + "required": [ + "PathPattern", + "TargetOriginId", + "ViewerProtocolPolicy" + ], + "type": "object" + }, + "Cookies": { + "additionalProperties": false, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.", + "properties": { + "Forward": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type.\n Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element.", + "type": "string" + }, + "WhitelistedNames": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.\n If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically.\n For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Forward" + ], + "type": "object" + }, + "CustomErrorResponse": { + "additionalProperties": false, + "description": "A complex type that controls:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", + "properties": { + "ErrorCachingMinTTL": { + "default": 300, + "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.\n For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", + "type": "number" + }, + "ErrorCode": { + "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration.", + "type": "integer" + }, + "ResponseCode": { + "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted.\n + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors.\n + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down.\n \n If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``.", + "type": "integer" + }, + "ResponsePagePath": { + "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:\n + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``.\n + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages.\n \n If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``.\n We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.", + "type": "string" + } + }, + "required": [ + "ErrorCode" + ], + "type": "object" + }, + "CustomOriginConfig": { + "additionalProperties": false, + "description": "A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.", + "properties": { + "HTTPPort": { + "default": 80, + "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.", + "type": "integer" + }, + "HTTPSPort": { + "default": 443, + "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.", + "type": "integer" + }, + "OriginKeepaliveTimeout": { + "default": 5, + "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.", + "type": "integer" + }, + "OriginProtocolPolicy": { + "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:\n + ``http-only`` \u2013 CloudFront always uses HTTP to connect to the origin.\n + ``match-viewer`` \u2013 CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.\n + ``https-only`` \u2013 CloudFront always uses HTTPS to connect to the origin.", + "type": "string" + }, + "OriginReadTimeout": { + "default": 30, + "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.", + "type": "integer" + }, + "OriginSSLProtocols": { + "default": [ + "TLSv1", + "SSLv3" + ], + "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "OriginProtocolPolicy" + ], + "type": "object" + }, + "DefaultCacheBehavior": { + "additionalProperties": false, + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.", + "properties": { + "AllowedMethods": { + "default": [ + "GET", + "HEAD" + ], + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CachePolicyId": { + "default": "", + "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", + "type": "string" + }, + "CachedMethods": { + "default": [ + "GET", + "HEAD" + ], + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Compress": { + "default": false, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", + "type": "boolean" + }, + "DefaultTTL": { + "default": 86400, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "number" + }, + "FieldLevelEncryptionId": { + "default": "", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.", + "type": "string" + }, + "ForwardedValues": { + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "FunctionAssociations": { + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", + "items": { + "$ref": "#/definitions/FunctionAssociation" + }, + "type": "array", + "uniqueItems": false + }, + "LambdaFunctionAssociations": { + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", + "items": { + "$ref": "#/definitions/LambdaFunctionAssociation" + }, + "type": "array", + "uniqueItems": false + }, + "MaxTTL": { + "default": 31536000, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "number" + }, + "MinTTL": { + "default": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", + "type": "number" + }, + "OriginRequestPolicyId": { + "default": "", + "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "RealtimeLogConfigArn": { + "default": "", + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "ResponseHeadersPolicyId": { + "default": "", + "description": "The identifier for a response headers policy.", + "type": "string" + }, + "SmoothStreaming": { + "default": false, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", + "type": "boolean" + }, + "TargetOriginId": { + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior.", + "type": "string" + }, + "TrustedKeyGroups": { + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TrustedSigners": { + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ViewerProtocolPolicy": { + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + } + }, + "required": [ + "TargetOriginId", + "ViewerProtocolPolicy" + ], + "type": "object" + }, + "DistributionConfig": { + "additionalProperties": false, + "description": "A distribution configuration.", + "properties": { + "Aliases": { + "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CNAMEs": { + "description": "", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CacheBehaviors": { + "description": "A complex type that contains zero or more ``CacheBehavior`` elements.", + "items": { + "$ref": "#/definitions/CacheBehavior" + }, + "type": "array", + "uniqueItems": false + }, + "Comment": { + "default": "", + "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters.", + "type": "string" + }, + "ContinuousDeploymentPolicyId": { + "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``.", + "type": "string" + }, + "CustomErrorResponses": { + "description": "A complex type that controls the following:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "$ref": "#/definitions/CustomErrorResponse" + }, + "type": "array", + "uniqueItems": false + }, + "CustomOrigin": { + "$ref": "#/definitions/LegacyCustomOrigin", + "description": "" + }, + "DefaultCacheBehavior": { + "$ref": "#/definitions/DefaultCacheBehavior", + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." + }, + "DefaultRootObject": { + "default": "", + "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution.\n Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name.\n If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element.\n To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element.\n To replace the default root object, update the distribution configuration and specify the new object.\n For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "Enabled": { + "description": "From this field, you can enable or disable the selected distribution.", + "type": "boolean" + }, + "HttpVersion": { + "default": "http1.1", + "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.\n For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).\n For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", + "type": "string" + }, + "IPV6Enabled": { + "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.\n In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.\n If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:\n + You enable IPv6 for the distribution\n + You're using alternate domain names in the URLs for your objects\n \n For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*.\n If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.", + "type": "boolean" + }, + "Logging": { + "$ref": "#/definitions/Logging", + "description": "A complex type that controls whether access logs are written for the distribution.\n For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*." + }, + "OriginGroups": { + "$ref": "#/definitions/OriginGroups", + "description": "A complex type that contains information about origin groups for this distribution." + }, + "Origins": { + "description": "A complex type that contains information about origins for this distribution.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Origin" + }, + "type": "array", + "uniqueItems": false + }, + "PriceClass": { + "default": "PriceClass_All", + "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.\n If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.\n For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/).", + "type": "string" + }, + "Restrictions": { + "$ref": "#/definitions/Restrictions", + "default": { + "GeoRestriction": { + "RestrictionType": "none" + } + }, + "description": "A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin": { + "$ref": "#/definitions/LegacyS3Origin", + "description": "" + }, + "Staging": { + "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution.", + "type": "boolean" + }, + "ViewerCertificate": { + "$ref": "#/definitions/ViewerCertificate", + "default": { + "CloudFrontDefaultCertificate": true + }, + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers." + }, + "WebACLId": { + "default": "", + "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``.\n WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).", + "type": "string" + } + }, + "required": [ + "Enabled", + "DefaultCacheBehavior" + ], + "type": "object" + }, + "ForwardedValues": { + "additionalProperties": false, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.", + "properties": { + "Cookies": { + "$ref": "#/definitions/Cookies", + "default": { + "Forward": "none" + }, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." + }, + "Headers": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.\n For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "QueryString": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any:\n If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.\n If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.\n If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.\n For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*.", + "type": "boolean" + }, + "QueryStringCacheKeys": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "QueryString" + ], + "type": "object" + }, + "FunctionAssociation": { + "additionalProperties": false, + "description": "A CloudFront function that is associated with a cache behavior in a CloudFront distribution.", + "properties": { + "EventType": { + "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function.", + "type": "string" + }, + "FunctionARN": { + "description": "The Amazon Resource Name (ARN) of the function.", + "type": "string" + } + }, + "type": "object" + }, + "GeoRestriction": { + "additionalProperties": false, + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.", + "properties": { + "Locations": { + "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``).\n The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country.\n CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RestrictionType": { + "description": "The method that you want to use to restrict distribution of your content by country:\n + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location.\n + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content.", + "type": "string" + } + }, + "required": [ + "RestrictionType" + ], + "type": "object" + }, + "LambdaFunctionAssociation": { + "additionalProperties": false, + "description": "A complex type that contains a Lambda@Edge function association.", + "properties": { + "EventType": { + "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:\n + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.\n + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.\n + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.\n + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.\n If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.", + "type": "string" + }, + "IncludeBody": { + "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide.", + "type": "boolean" + }, + "LambdaFunctionARN": { + "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.", + "type": "string" + } + }, + "type": "object" + }, + "LegacyCustomOrigin": { + "additionalProperties": false, + "description": "", + "properties": { + "DNSName": { + "description": "", + "type": "string" + }, + "HTTPPort": { + "default": 80, + "description": "", + "type": "integer" + }, + "HTTPSPort": { + "default": 443, + "description": "", + "type": "integer" + }, + "OriginProtocolPolicy": { + "description": "", + "type": "string" + }, + "OriginSSLProtocols": { + "description": "", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "DNSName", + "OriginProtocolPolicy", + "OriginSSLProtocols" + ], + "type": "object" + }, + "LegacyS3Origin": { + "additionalProperties": false, + "description": "", + "properties": { + "DNSName": { + "description": "", + "type": "string" + }, + "OriginAccessIdentity": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": [ + "DNSName" + ], + "type": "object" + }, + "Logging": { + "additionalProperties": false, + "description": "A complex type that controls whether access logs are written for the distribution.", + "properties": { + "Bucket": { + "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``.", + "type": "string" + }, + "IncludeCookies": { + "default": false, + "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``.", + "type": "boolean" + }, + "Prefix": { + "default": "", + "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element.", + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "Origin": { + "additionalProperties": false, + "description": "An origin.\n An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:\n + Use ``S3OriginConfig`` to specify an Amazon S3 bucket that is not configured with static website hosting.\n + Use ``CustomOriginConfig`` to specify all other kinds of origins, including:\n + An Amazon S3 bucket that is configured with static website hosting\n + An Elastic Load Balancing load balancer\n + An EMPlong endpoint\n + An EMSlong container\n + Any other HTTP server, running on an Amazon EC2 instance or any other kind of host\n \n \n For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).", + "properties": { + "ConnectionAttempts": { + "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.\n For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).\n For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*.", + "type": "integer" + }, + "ConnectionTimeout": { + "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.\n For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*.", + "type": "integer" + }, + "CustomOriginConfig": { + "$ref": "#/definitions/CustomOriginConfig", + "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead." + }, + "DomainName": { + "description": "The domain name for the origin.\n For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "Id": { + "description": "A unique identifier for the origin. This value must be unique within the distribution.\n Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``.", + "type": "string" + }, + "OriginAccessControlId": { + "description": "The unique identifier of an origin access control for this origin.\n For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "OriginCustomHeaders": { + "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.\n For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "$ref": "#/definitions/OriginCustomHeader" + }, + "type": "array", + "uniqueItems": false + }, + "OriginPath": { + "default": "", + "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.\n For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "OriginShield": { + "$ref": "#/definitions/OriginShield", + "description": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.\n For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*." + }, + "S3OriginConfig": { + "$ref": "#/definitions/S3OriginConfig", + "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead." + } + }, + "required": [ + "DomainName", + "Id" + ], + "type": "object" + }, + "OriginCustomHeader": { + "additionalProperties": false, + "description": "A complex type that contains ``HeaderName`` and ``HeaderValue`` elements, if any, for this distribution.", + "properties": { + "HeaderName": { + "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + }, + "HeaderValue": { + "description": "The value for the header that you specified in the ``HeaderName`` field.", + "type": "string" + } + }, + "required": [ + "HeaderValue", + "HeaderName" + ], + "type": "object" + }, + "OriginGroup": { + "additionalProperties": false, + "description": "An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.", + "properties": { + "FailoverCriteria": { + "$ref": "#/definitions/OriginGroupFailoverCriteria", + "description": "A complex type that contains information about the failover criteria for an origin group." + }, + "Id": { + "description": "The origin group's ID.", + "type": "string" + }, + "Members": { + "$ref": "#/definitions/OriginGroupMembers", + "description": "A complex type that contains information about the origins in an origin group." + } + }, + "required": [ + "Id", + "FailoverCriteria", + "Members" + ], + "type": "object" + }, + "OriginGroupFailoverCriteria": { + "additionalProperties": false, + "description": "A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.", + "properties": { + "StatusCodes": { + "$ref": "#/definitions/StatusCodes", + "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin." + } + }, + "required": [ + "StatusCodes" + ], + "type": "object" + }, + "OriginGroupMember": { + "additionalProperties": false, + "description": "An origin in an origin group.", + "properties": { + "OriginId": { + "description": "The ID for an origin in an origin group.", + "type": "string" + } + }, + "required": [ + "OriginId" + ], + "type": "object" + }, + "OriginGroupMembers": { + "additionalProperties": false, + "description": "A complex data type for the origins included in an origin group.", + "properties": { + "Items": { + "description": "Items (origins) in an origin group.", + "items": { + "$ref": "#/definitions/OriginGroupMember" + }, + "type": "array", + "uniqueItems": false + }, + "Quantity": { + "description": "The number of origins in an origin group.", + "type": "integer" + } + }, + "required": [ + "Quantity", + "Items" + ], + "type": "object" + }, + "OriginGroups": { + "additionalProperties": false, + "description": "A complex data type for the origin groups specified for a distribution.", + "properties": { + "Items": { + "description": "The items (origin groups) in a distribution.", + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "type": "array", + "uniqueItems": false + }, + "Quantity": { + "description": "The number of origin groups.", + "type": "integer" + } + }, + "required": [ + "Quantity" + ], + "type": "object" + }, + "OriginShield": { + "additionalProperties": false, + "description": "CloudFront Origin Shield.\n Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.", + "properties": { + "Enabled": { + "description": "A flag that specifies whether Origin Shield is enabled.\n When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.", + "type": "boolean" + }, + "OriginShieldRegion": { + "description": "The AWS-Region for Origin Shield.\n Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``.\n When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "Restrictions": { + "additionalProperties": false, + "description": "A complex type that identifies ways in which you want to restrict distribution of your content.", + "properties": { + "GeoRestriction": { + "$ref": "#/definitions/GeoRestriction", + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." + } + }, + "required": [ + "GeoRestriction" + ], + "type": "object" + }, + "S3OriginConfig": { + "additionalProperties": false, + "description": "A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead.", + "properties": { + "OriginAccessIdentity": { + "default": "", + "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:\n origin-access-identity/cloudfront/*ID-of-origin-access-identity* \n where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.\n If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.\n To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.\n To replace the origin access identity, update the distribution configuration and specify the new origin access identity.\n For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "StatusCodes": { + "additionalProperties": false, + "description": "A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.", + "properties": { + "Items": { + "description": "The items (status codes) for an origin group.", + "items": { + "type": "integer" + }, + "type": "array", + "uniqueItems": false + }, + "Quantity": { + "description": "The number of status codes.", + "type": "integer" + } + }, + "required": [ + "Quantity", + "Items" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A complex type that contains ``Tag`` key and ``Tag`` value.", + "properties": { + "Key": { + "description": "A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", + "type": "string" + }, + "Value": { + "description": "A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ViewerCertificate": { + "additionalProperties": false, + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.\n If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)\u2014that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``\u2014set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:\n + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI.\n + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n \n + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*.\n + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both):\n + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.)\n + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.)\n \n \n All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``.\n For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*.", + "properties": { + "AcmCertificateArn": { + "description": "In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``).\n If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", + "type": "string" + }, + "CloudFrontDefaultCertificate": { + "description": "If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields:\n + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) \n + ``MinimumProtocolVersion`` \n + ``SslSupportMethod``", + "type": "boolean" + }, + "IamCertificateId": { + "description": "In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.\n If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", + "type": "string" + }, + "MinimumProtocolVersion": { + "description": "If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:\n + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.\n + The ciphers that CloudFront can use to encrypt the content that it returns to viewers.\n \n For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*.\n On the CloudFront console, this setting is called *Security Policy*.\n When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here.", + "type": "string" + }, + "SslSupportMethod": { + "description": "In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.\n + ``sni-only`` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI.\n + ``vip`` \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.\n + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home).\n \n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field.", + "type": "string" + } + }, + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/DistributionConfig/properties/CustomOrigin", + "/properties/DistributionConfig/properties/S3Origin" + ], + "description": "A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateDistribution", + "cloudfront:CreateDistributionWithTags", + "cloudfront:GetDistribution", + "cloudfront:GetDistributionConfig", + "cloudfront:TagResource" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteDistribution", + "cloudfront:GetDistribution", + "cloudfront:GetDistributionConfig" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListDistributions" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetDistribution", + "cloudfront:GetDistributionConfig" + ] + }, + "update": { + "permissions": [ + "cloudfront:GetDistribution", + "cloudfront:GetDistributionConfig", + "cloudfront:UpdateDistribution", + "cloudfront:UpdateDistributionWithStagingConfig", + "cloudfront:ListTagsForResource", + "cloudfront:TagResource", + "cloudfront:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DistributionConfig": { + "$ref": "#/definitions/DistributionConfig", + "description": "The distribution's configuration." + }, + "DomainName": { + "description": "", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "A complex type that contains zero or more ``Tag`` elements.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/DomainName" + ], + "required": [ + "DistributionConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::Distribution" +} diff --git a/schema/aws-cloudfront-function.json b/schema/aws-cloudfront-function.json index 8f7565a..04f2fe0 100644 --- a/schema/aws-cloudfront-function.json +++ b/schema/aws-cloudfront-function.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "definitions": { - "FunctionConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "KeyValueStoreAssociations": { - "items": { - "$ref": "#/definitions/KeyValueStoreAssociation" - }, - "type": "array", - "uniqueItems": true - }, - "Runtime": { - "type": "string" - } - }, - "required": [ - "Comment", - "Runtime" - ], - "type": "object" - }, - "FunctionMetadata": { - "additionalProperties": false, - "properties": { - "FunctionARN": { - "type": "string" - } - }, - "type": "object" - }, - "KeyValueStoreAssociation": { - "additionalProperties": false, - "properties": { - "KeyValueStoreARN": { - "type": "string" - } - }, - "required": [ - "KeyValueStoreARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::Function", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateFunction", - "cloudfront:PublishFunction", - "cloudfront:DescribeFunction" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteFunction", - "cloudfront:DescribeFunction" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListFunctions" - ] - }, - "read": { - "permissions": [ - "cloudfront:DescribeFunction", - "cloudfront:GetFunction" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateFunction", - "cloudfront:PublishFunction", - "cloudfront:DescribeFunction" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionARN" - ], - "properties": { - "AutoPublish": { - "type": "boolean" - }, - "FunctionARN": { - "type": "string" - }, - "FunctionCode": { - "type": "string" - }, - "FunctionConfig": { - "$ref": "#/definitions/FunctionConfig" - }, - "FunctionMetadata": { - "$ref": "#/definitions/FunctionMetadata" - }, - "Name": { - "type": "string" - }, - "Stage": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/FunctionARN", - "/properties/FunctionMetadata/FunctionARN", - "/properties/Stage" - ], - "required": [ - "Name", - "FunctionConfig", - "FunctionCode" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::Function", - "writeOnlyProperties": [ - "/properties/AutoPublish" - ] -} +{ + "additionalProperties": false, + "definitions": { + "FunctionConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "KeyValueStoreAssociations": { + "items": { + "$ref": "#/definitions/KeyValueStoreAssociation" + }, + "type": "array", + "uniqueItems": true + }, + "Runtime": { + "type": "string" + } + }, + "required": [ + "Comment", + "Runtime" + ], + "type": "object" + }, + "FunctionMetadata": { + "additionalProperties": false, + "properties": { + "FunctionARN": { + "type": "string" + } + }, + "type": "object" + }, + "KeyValueStoreAssociation": { + "additionalProperties": false, + "properties": { + "KeyValueStoreARN": { + "type": "string" + } + }, + "required": [ + "KeyValueStoreARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::Function", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateFunction", + "cloudfront:PublishFunction", + "cloudfront:DescribeFunction" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteFunction", + "cloudfront:DescribeFunction" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListFunctions" + ] + }, + "read": { + "permissions": [ + "cloudfront:DescribeFunction", + "cloudfront:GetFunction" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateFunction", + "cloudfront:PublishFunction", + "cloudfront:DescribeFunction" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionARN" + ], + "properties": { + "AutoPublish": { + "type": "boolean" + }, + "FunctionARN": { + "type": "string" + }, + "FunctionCode": { + "type": "string" + }, + "FunctionConfig": { + "$ref": "#/definitions/FunctionConfig" + }, + "FunctionMetadata": { + "$ref": "#/definitions/FunctionMetadata" + }, + "Name": { + "type": "string" + }, + "Stage": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/FunctionARN", + "/properties/FunctionMetadata/FunctionARN", + "/properties/Stage" + ], + "required": [ + "Name", + "FunctionConfig", + "FunctionCode" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::Function", + "writeOnlyProperties": [ + "/properties/AutoPublish" + ] +} diff --git a/schema/aws-cloudfront-keygroup.json b/schema/aws-cloudfront-keygroup.json index 6a5b1ba..979b512 100644 --- a/schema/aws-cloudfront-keygroup.json +++ b/schema/aws-cloudfront-keygroup.json @@ -1,86 +1,86 @@ -{ - "additionalProperties": false, - "definitions": { - "KeyGroupConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Items": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name", - "Items" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::KeyGroup", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateKeyGroup" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteKeyGroup", - "cloudfront:GetKeyGroup" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListKeyGroups" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetKeyGroup" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateKeyGroup", - "cloudfront:GetKeyGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "KeyGroupConfig": { - "$ref": "#/definitions/KeyGroupConfig" - }, - "LastModifiedTime": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/LastModifiedTime" - ], - "required": [ - "KeyGroupConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::KeyGroup" -} +{ + "additionalProperties": false, + "definitions": { + "KeyGroupConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "Items": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name", + "Items" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::KeyGroup", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateKeyGroup" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteKeyGroup", + "cloudfront:GetKeyGroup" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListKeyGroups" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetKeyGroup" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateKeyGroup", + "cloudfront:GetKeyGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "KeyGroupConfig": { + "$ref": "#/definitions/KeyGroupConfig" + }, + "LastModifiedTime": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/LastModifiedTime" + ], + "required": [ + "KeyGroupConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::KeyGroup" +} diff --git a/schema/aws-cloudfront-keyvaluestore.json b/schema/aws-cloudfront-keyvaluestore.json index 30d10b8..0ba38df 100644 --- a/schema/aws-cloudfront-keyvaluestore.json +++ b/schema/aws-cloudfront-keyvaluestore.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ImportSource": { - "additionalProperties": false, - "properties": { - "SourceArn": { - "type": "string" - }, - "SourceType": { - "type": "string" - } - }, - "required": [ - "SourceType", - "SourceArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::KeyValueStore", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateKeyValueStore", - "cloudfront:DescribeKeyValueStore", - "s3:GetObject", - "s3:HeadObject", - "s3:GetBucketLocation" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteKeyValueStore", - "cloudfront:DescribeKeyValueStore" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListKeyValueStores" - ] - }, - "read": { - "permissions": [ - "cloudfront:DescribeKeyValueStore" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateKeyValueStore", - "cloudfront:DescribeKeyValueStore" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Comment": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ImportSource": { - "$ref": "#/definitions/ImportSource" - }, - "Name": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/Status" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::KeyValueStore", - "writeOnlyProperties": [ - "/properties/ImportSource" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ImportSource": { + "additionalProperties": false, + "properties": { + "SourceArn": { + "type": "string" + }, + "SourceType": { + "type": "string" + } + }, + "required": [ + "SourceType", + "SourceArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::KeyValueStore", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateKeyValueStore", + "cloudfront:DescribeKeyValueStore", + "s3:GetObject", + "s3:HeadObject", + "s3:GetBucketLocation" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteKeyValueStore", + "cloudfront:DescribeKeyValueStore" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListKeyValueStores" + ] + }, + "read": { + "permissions": [ + "cloudfront:DescribeKeyValueStore" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateKeyValueStore", + "cloudfront:DescribeKeyValueStore" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Comment": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ImportSource": { + "$ref": "#/definitions/ImportSource" + }, + "Name": { + "type": "string" + }, + "Status": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/Status" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::KeyValueStore", + "writeOnlyProperties": [ + "/properties/ImportSource" + ] +} diff --git a/schema/aws-cloudfront-monitoringsubscription.json b/schema/aws-cloudfront-monitoringsubscription.json index b1acd3f..1d7dffb 100644 --- a/schema/aws-cloudfront-monitoringsubscription.json +++ b/schema/aws-cloudfront-monitoringsubscription.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DistributionId" - ], - "definitions": { - "MonitoringSubscription": { - "additionalProperties": false, - "properties": { - "RealtimeMetricsSubscriptionConfig": { - "$ref": "#/definitions/RealtimeMetricsSubscriptionConfig" - } - }, - "type": "object" - }, - "RealtimeMetricsSubscriptionConfig": { - "additionalProperties": false, - "properties": { - "RealtimeMetricsSubscriptionStatus": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string" - } - }, - "required": [ - "RealtimeMetricsSubscriptionStatus" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::MonitoringSubscription", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateMonitoringSubscription" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteMonitoringSubscription" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetMonitoringSubscription" - ] - } - }, - "primaryIdentifier": [ - "/properties/DistributionId" - ], - "properties": { - "DistributionId": { - "type": "string" - }, - "MonitoringSubscription": { - "$ref": "#/definitions/MonitoringSubscription" - } - }, - "required": [ - "DistributionId", - "MonitoringSubscription" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::MonitoringSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DistributionId" + ], + "definitions": { + "MonitoringSubscription": { + "additionalProperties": false, + "properties": { + "RealtimeMetricsSubscriptionConfig": { + "$ref": "#/definitions/RealtimeMetricsSubscriptionConfig" + } + }, + "type": "object" + }, + "RealtimeMetricsSubscriptionConfig": { + "additionalProperties": false, + "properties": { + "RealtimeMetricsSubscriptionStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string" + } + }, + "required": [ + "RealtimeMetricsSubscriptionStatus" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::MonitoringSubscription", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateMonitoringSubscription" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteMonitoringSubscription" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetMonitoringSubscription" + ] + } + }, + "primaryIdentifier": [ + "/properties/DistributionId" + ], + "properties": { + "DistributionId": { + "type": "string" + }, + "MonitoringSubscription": { + "$ref": "#/definitions/MonitoringSubscription" + } + }, + "required": [ + "DistributionId", + "MonitoringSubscription" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::MonitoringSubscription" +} diff --git a/schema/aws-cloudfront-originaccesscontrol.json b/schema/aws-cloudfront-originaccesscontrol.json index 3589c26..3cc45a2 100644 --- a/schema/aws-cloudfront-originaccesscontrol.json +++ b/schema/aws-cloudfront-originaccesscontrol.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "definitions": { - "OriginAccessControlConfig": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OriginAccessControlOriginType": { - "pattern": "^(s3|mediastore|lambda|mediapackagev2)$", - "type": "string" - }, - "SigningBehavior": { - "pattern": "^(never|no-override|always)$", - "type": "string" - }, - "SigningProtocol": { - "pattern": "^(sigv4)$", - "type": "string" - } - }, - "required": [ - "Name", - "SigningProtocol", - "SigningBehavior", - "OriginAccessControlOriginType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::OriginAccessControl", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateOriginAccessControl" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteOriginAccessControl", - "cloudfront:GetOriginAccessControl" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListOriginAccessControls" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetOriginAccessControl" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateOriginAccessControl", - "cloudfront:GetOriginAccessControl" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "OriginAccessControlConfig": { - "$ref": "#/definitions/OriginAccessControlConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "OriginAccessControlConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::OriginAccessControl" -} +{ + "additionalProperties": false, + "definitions": { + "OriginAccessControlConfig": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OriginAccessControlOriginType": { + "pattern": "^(s3|mediastore|lambda|mediapackagev2)$", + "type": "string" + }, + "SigningBehavior": { + "pattern": "^(never|no-override|always)$", + "type": "string" + }, + "SigningProtocol": { + "pattern": "^(sigv4)$", + "type": "string" + } + }, + "required": [ + "Name", + "SigningProtocol", + "SigningBehavior", + "OriginAccessControlOriginType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::OriginAccessControl", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateOriginAccessControl" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteOriginAccessControl", + "cloudfront:GetOriginAccessControl" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListOriginAccessControls" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetOriginAccessControl" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateOriginAccessControl", + "cloudfront:GetOriginAccessControl" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "OriginAccessControlConfig": { + "$ref": "#/definitions/OriginAccessControlConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "OriginAccessControlConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::OriginAccessControl" +} diff --git a/schema/aws-cloudfront-originrequestpolicy.json b/schema/aws-cloudfront-originrequestpolicy.json index 23d6b56..7fb9a02 100644 --- a/schema/aws-cloudfront-originrequestpolicy.json +++ b/schema/aws-cloudfront-originrequestpolicy.json @@ -1,150 +1,150 @@ -{ - "additionalProperties": false, - "definitions": { - "CookiesConfig": { - "additionalProperties": false, - "properties": { - "CookieBehavior": { - "pattern": "^(none|whitelist|all|allExcept)$", - "type": "string" - }, - "Cookies": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "CookieBehavior" - ], - "type": "object" - }, - "HeadersConfig": { - "additionalProperties": false, - "properties": { - "HeaderBehavior": { - "pattern": "^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$", - "type": "string" - }, - "Headers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "HeaderBehavior" - ], - "type": "object" - }, - "OriginRequestPolicyConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "CookiesConfig": { - "$ref": "#/definitions/CookiesConfig" - }, - "HeadersConfig": { - "$ref": "#/definitions/HeadersConfig" - }, - "Name": { - "type": "string" - }, - "QueryStringsConfig": { - "$ref": "#/definitions/QueryStringsConfig" - } - }, - "required": [ - "Name", - "HeadersConfig", - "CookiesConfig", - "QueryStringsConfig" - ], - "type": "object" - }, - "QueryStringsConfig": { - "additionalProperties": false, - "properties": { - "QueryStringBehavior": { - "pattern": "^(none|whitelist|all|allExcept)$", - "type": "string" - }, - "QueryStrings": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "QueryStringBehavior" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::OriginRequestPolicy", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateOriginRequestPolicy" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteOriginRequestPolicy", - "cloudfront:GetOriginRequestPolicy" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListOriginRequestPolicies" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetOriginRequestPolicy" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateOriginRequestPolicy", - "cloudfront:GetOriginRequestPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - }, - "OriginRequestPolicyConfig": { - "$ref": "#/definitions/OriginRequestPolicyConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/LastModifiedTime" - ], - "required": [ - "OriginRequestPolicyConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::OriginRequestPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "CookiesConfig": { + "additionalProperties": false, + "properties": { + "CookieBehavior": { + "pattern": "^(none|whitelist|all|allExcept)$", + "type": "string" + }, + "Cookies": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "CookieBehavior" + ], + "type": "object" + }, + "HeadersConfig": { + "additionalProperties": false, + "properties": { + "HeaderBehavior": { + "pattern": "^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$", + "type": "string" + }, + "Headers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "HeaderBehavior" + ], + "type": "object" + }, + "OriginRequestPolicyConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "CookiesConfig": { + "$ref": "#/definitions/CookiesConfig" + }, + "HeadersConfig": { + "$ref": "#/definitions/HeadersConfig" + }, + "Name": { + "type": "string" + }, + "QueryStringsConfig": { + "$ref": "#/definitions/QueryStringsConfig" + } + }, + "required": [ + "Name", + "HeadersConfig", + "CookiesConfig", + "QueryStringsConfig" + ], + "type": "object" + }, + "QueryStringsConfig": { + "additionalProperties": false, + "properties": { + "QueryStringBehavior": { + "pattern": "^(none|whitelist|all|allExcept)$", + "type": "string" + }, + "QueryStrings": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "QueryStringBehavior" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::OriginRequestPolicy", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateOriginRequestPolicy" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteOriginRequestPolicy", + "cloudfront:GetOriginRequestPolicy" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListOriginRequestPolicies" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetOriginRequestPolicy" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateOriginRequestPolicy", + "cloudfront:GetOriginRequestPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "LastModifiedTime": { + "type": "string" + }, + "OriginRequestPolicyConfig": { + "$ref": "#/definitions/OriginRequestPolicyConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/LastModifiedTime" + ], + "required": [ + "OriginRequestPolicyConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::OriginRequestPolicy" +} diff --git a/schema/aws-cloudfront-publickey.json b/schema/aws-cloudfront-publickey.json index b2e5267..675bfbc 100644 --- a/schema/aws-cloudfront-publickey.json +++ b/schema/aws-cloudfront-publickey.json @@ -1,86 +1,86 @@ -{ - "additionalProperties": false, - "definitions": { - "PublicKeyConfig": { - "additionalProperties": false, - "properties": { - "CallerReference": { - "type": "string" - }, - "Comment": { - "type": "string" - }, - "EncodedKey": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "CallerReference", - "Name", - "EncodedKey" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::PublicKey", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreatePublicKey" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeletePublicKey", - "cloudfront:GetPublicKey" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListPublicKeys" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetPublicKey" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdatePublicKey", - "cloudfront:GetPublicKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CreatedTime": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PublicKeyConfig": { - "$ref": "#/definitions/PublicKeyConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/CreatedTime" - ], - "required": [ - "PublicKeyConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::PublicKey" -} +{ + "additionalProperties": false, + "definitions": { + "PublicKeyConfig": { + "additionalProperties": false, + "properties": { + "CallerReference": { + "type": "string" + }, + "Comment": { + "type": "string" + }, + "EncodedKey": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "CallerReference", + "Name", + "EncodedKey" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::PublicKey", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreatePublicKey" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeletePublicKey", + "cloudfront:GetPublicKey" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListPublicKeys" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetPublicKey" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdatePublicKey", + "cloudfront:GetPublicKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CreatedTime": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PublicKeyConfig": { + "$ref": "#/definitions/PublicKeyConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CreatedTime" + ], + "required": [ + "PublicKeyConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::PublicKey" +} diff --git a/schema/aws-cloudfront-realtimelogconfig.json b/schema/aws-cloudfront-realtimelogconfig.json index c31243f..8d8e20c 100644 --- a/schema/aws-cloudfront-realtimelogconfig.json +++ b/schema/aws-cloudfront-realtimelogconfig.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "EndPoint": { - "additionalProperties": false, - "properties": { - "KinesisStreamConfig": { - "$ref": "#/definitions/KinesisStreamConfig" - }, - "StreamType": { - "type": "string" - } - }, - "required": [ - "KinesisStreamConfig", - "StreamType" - ], - "type": "object" - }, - "KinesisStreamConfig": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "StreamArn": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "StreamArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::RealtimeLogConfig", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateRealtimeLogConfig", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteRealtimeLogConfig", - "cloudfront:GetRealtimeLogConfig" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListRealtimeLogConfigs" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetRealtimeLogConfig" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateRealtimeLogConfig", - "cloudfront:GetRealtimeLogConfig", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "EndPoints": { - "items": { - "$ref": "#/definitions/EndPoint" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Fields": { - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "SamplingRate": { - "maximum": 100, - "minimum": 1, - "multipleOf": 1.0, - "type": "number" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "EndPoints", - "Fields", - "SamplingRate" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::RealtimeLogConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "EndPoint": { + "additionalProperties": false, + "properties": { + "KinesisStreamConfig": { + "$ref": "#/definitions/KinesisStreamConfig" + }, + "StreamType": { + "type": "string" + } + }, + "required": [ + "KinesisStreamConfig", + "StreamType" + ], + "type": "object" + }, + "KinesisStreamConfig": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "type": "string" + }, + "StreamArn": { + "type": "string" + } + }, + "required": [ + "RoleArn", + "StreamArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::RealtimeLogConfig", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateRealtimeLogConfig", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteRealtimeLogConfig", + "cloudfront:GetRealtimeLogConfig" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListRealtimeLogConfigs" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetRealtimeLogConfig" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateRealtimeLogConfig", + "cloudfront:GetRealtimeLogConfig", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "EndPoints": { + "items": { + "$ref": "#/definitions/EndPoint" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Fields": { + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "SamplingRate": { + "maximum": 100, + "minimum": 1, + "multipleOf": 1.0, + "type": "number" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "EndPoints", + "Fields", + "SamplingRate" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::RealtimeLogConfig" +} diff --git a/schema/aws-cloudfront-responseheaderspolicy.json b/schema/aws-cloudfront-responseheaderspolicy.json index bb45f47..842949d 100644 --- a/schema/aws-cloudfront-responseheaderspolicy.json +++ b/schema/aws-cloudfront-responseheaderspolicy.json @@ -1,406 +1,406 @@ -{ - "additionalProperties": false, - "definitions": { - "AccessControlAllowHeaders": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "AccessControlAllowMethods": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "AccessControlAllowOrigins": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "AccessControlExposeHeaders": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "ContentSecurityPolicy": { - "additionalProperties": false, - "properties": { - "ContentSecurityPolicy": { - "type": "string" - }, - "Override": { - "type": "boolean" - } - }, - "required": [ - "Override", - "ContentSecurityPolicy" - ], - "type": "object" - }, - "ContentTypeOptions": { - "additionalProperties": false, - "properties": { - "Override": { - "type": "boolean" - } - }, - "required": [ - "Override" - ], - "type": "object" - }, - "CorsConfig": { - "additionalProperties": false, - "properties": { - "AccessControlAllowCredentials": { - "type": "boolean" - }, - "AccessControlAllowHeaders": { - "$ref": "#/definitions/AccessControlAllowHeaders" - }, - "AccessControlAllowMethods": { - "$ref": "#/definitions/AccessControlAllowMethods" - }, - "AccessControlAllowOrigins": { - "$ref": "#/definitions/AccessControlAllowOrigins" - }, - "AccessControlExposeHeaders": { - "$ref": "#/definitions/AccessControlExposeHeaders" - }, - "AccessControlMaxAgeSec": { - "type": "integer" - }, - "OriginOverride": { - "type": "boolean" - } - }, - "required": [ - "AccessControlAllowOrigins", - "AccessControlAllowHeaders", - "AccessControlAllowMethods", - "AccessControlAllowCredentials", - "OriginOverride" - ], - "type": "object" - }, - "CustomHeader": { - "additionalProperties": false, - "properties": { - "Header": { - "type": "string" - }, - "Override": { - "type": "boolean" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Header", - "Value", - "Override" - ], - "type": "object" - }, - "CustomHeadersConfig": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomHeader" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "FrameOptions": { - "additionalProperties": false, - "properties": { - "FrameOption": { - "pattern": "^(DENY|SAMEORIGIN)$", - "type": "string" - }, - "Override": { - "type": "boolean" - } - }, - "required": [ - "Override", - "FrameOption" - ], - "type": "object" - }, - "ReferrerPolicy": { - "additionalProperties": false, - "properties": { - "Override": { - "type": "boolean" - }, - "ReferrerPolicy": { - "pattern": "^(no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url)$", - "type": "string" - } - }, - "required": [ - "Override", - "ReferrerPolicy" - ], - "type": "object" - }, - "RemoveHeader": { - "additionalProperties": false, - "properties": { - "Header": { - "type": "string" - } - }, - "required": [ - "Header" - ], - "type": "object" - }, - "RemoveHeadersConfig": { - "additionalProperties": false, - "properties": { - "Items": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RemoveHeader" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Items" - ], - "type": "object" - }, - "ResponseHeadersPolicyConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "CorsConfig": { - "$ref": "#/definitions/CorsConfig" - }, - "CustomHeadersConfig": { - "$ref": "#/definitions/CustomHeadersConfig" - }, - "Name": { - "type": "string" - }, - "RemoveHeadersConfig": { - "$ref": "#/definitions/RemoveHeadersConfig" - }, - "SecurityHeadersConfig": { - "$ref": "#/definitions/SecurityHeadersConfig" - }, - "ServerTimingHeadersConfig": { - "$ref": "#/definitions/ServerTimingHeadersConfig" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SecurityHeadersConfig": { - "additionalProperties": false, - "properties": { - "ContentSecurityPolicy": { - "$ref": "#/definitions/ContentSecurityPolicy" - }, - "ContentTypeOptions": { - "$ref": "#/definitions/ContentTypeOptions" - }, - "FrameOptions": { - "$ref": "#/definitions/FrameOptions" - }, - "ReferrerPolicy": { - "$ref": "#/definitions/ReferrerPolicy" - }, - "StrictTransportSecurity": { - "$ref": "#/definitions/StrictTransportSecurity" - }, - "XSSProtection": { - "$ref": "#/definitions/XSSProtection" - } - }, - "required": [], - "type": "object" - }, - "ServerTimingHeadersConfig": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "SamplingRate": { - "maximum": 100, - "minimum": 0, - "multipleOf": 0.0001, - "type": "number" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "StrictTransportSecurity": { - "additionalProperties": false, - "properties": { - "AccessControlMaxAgeSec": { - "type": "integer" - }, - "IncludeSubdomains": { - "type": "boolean" - }, - "Override": { - "type": "boolean" - }, - "Preload": { - "type": "boolean" - } - }, - "required": [ - "Override", - "AccessControlMaxAgeSec" - ], - "type": "object" - }, - "XSSProtection": { - "additionalProperties": false, - "properties": { - "ModeBlock": { - "type": "boolean" - }, - "Override": { - "type": "boolean" - }, - "Protection": { - "type": "boolean" - }, - "ReportUri": { - "type": "string" - } - }, - "required": [ - "Override", - "Protection" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::ResponseHeadersPolicy", - "handlers": { - "create": { - "permissions": [ - "cloudfront:CreateResponseHeadersPolicy" - ] - }, - "delete": { - "permissions": [ - "cloudfront:DeleteResponseHeadersPolicy", - "cloudfront:GetResponseHeadersPolicy" - ] - }, - "list": { - "permissions": [ - "cloudfront:ListResponseHeadersPolicies" - ] - }, - "read": { - "permissions": [ - "cloudfront:GetResponseHeadersPolicy" - ] - }, - "update": { - "permissions": [ - "cloudfront:UpdateResponseHeadersPolicy", - "cloudfront:GetResponseHeadersPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - }, - "ResponseHeadersPolicyConfig": { - "$ref": "#/definitions/ResponseHeadersPolicyConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/LastModifiedTime" - ], - "required": [ - "ResponseHeadersPolicyConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudFront::ResponseHeadersPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "AccessControlAllowHeaders": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "AccessControlAllowMethods": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "AccessControlAllowOrigins": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "AccessControlExposeHeaders": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "ContentSecurityPolicy": { + "additionalProperties": false, + "properties": { + "ContentSecurityPolicy": { + "type": "string" + }, + "Override": { + "type": "boolean" + } + }, + "required": [ + "Override", + "ContentSecurityPolicy" + ], + "type": "object" + }, + "ContentTypeOptions": { + "additionalProperties": false, + "properties": { + "Override": { + "type": "boolean" + } + }, + "required": [ + "Override" + ], + "type": "object" + }, + "CorsConfig": { + "additionalProperties": false, + "properties": { + "AccessControlAllowCredentials": { + "type": "boolean" + }, + "AccessControlAllowHeaders": { + "$ref": "#/definitions/AccessControlAllowHeaders" + }, + "AccessControlAllowMethods": { + "$ref": "#/definitions/AccessControlAllowMethods" + }, + "AccessControlAllowOrigins": { + "$ref": "#/definitions/AccessControlAllowOrigins" + }, + "AccessControlExposeHeaders": { + "$ref": "#/definitions/AccessControlExposeHeaders" + }, + "AccessControlMaxAgeSec": { + "type": "integer" + }, + "OriginOverride": { + "type": "boolean" + } + }, + "required": [ + "AccessControlAllowOrigins", + "AccessControlAllowHeaders", + "AccessControlAllowMethods", + "AccessControlAllowCredentials", + "OriginOverride" + ], + "type": "object" + }, + "CustomHeader": { + "additionalProperties": false, + "properties": { + "Header": { + "type": "string" + }, + "Override": { + "type": "boolean" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Header", + "Value", + "Override" + ], + "type": "object" + }, + "CustomHeadersConfig": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomHeader" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "FrameOptions": { + "additionalProperties": false, + "properties": { + "FrameOption": { + "pattern": "^(DENY|SAMEORIGIN)$", + "type": "string" + }, + "Override": { + "type": "boolean" + } + }, + "required": [ + "Override", + "FrameOption" + ], + "type": "object" + }, + "ReferrerPolicy": { + "additionalProperties": false, + "properties": { + "Override": { + "type": "boolean" + }, + "ReferrerPolicy": { + "pattern": "^(no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url)$", + "type": "string" + } + }, + "required": [ + "Override", + "ReferrerPolicy" + ], + "type": "object" + }, + "RemoveHeader": { + "additionalProperties": false, + "properties": { + "Header": { + "type": "string" + } + }, + "required": [ + "Header" + ], + "type": "object" + }, + "RemoveHeadersConfig": { + "additionalProperties": false, + "properties": { + "Items": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RemoveHeader" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Items" + ], + "type": "object" + }, + "ResponseHeadersPolicyConfig": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "CorsConfig": { + "$ref": "#/definitions/CorsConfig" + }, + "CustomHeadersConfig": { + "$ref": "#/definitions/CustomHeadersConfig" + }, + "Name": { + "type": "string" + }, + "RemoveHeadersConfig": { + "$ref": "#/definitions/RemoveHeadersConfig" + }, + "SecurityHeadersConfig": { + "$ref": "#/definitions/SecurityHeadersConfig" + }, + "ServerTimingHeadersConfig": { + "$ref": "#/definitions/ServerTimingHeadersConfig" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SecurityHeadersConfig": { + "additionalProperties": false, + "properties": { + "ContentSecurityPolicy": { + "$ref": "#/definitions/ContentSecurityPolicy" + }, + "ContentTypeOptions": { + "$ref": "#/definitions/ContentTypeOptions" + }, + "FrameOptions": { + "$ref": "#/definitions/FrameOptions" + }, + "ReferrerPolicy": { + "$ref": "#/definitions/ReferrerPolicy" + }, + "StrictTransportSecurity": { + "$ref": "#/definitions/StrictTransportSecurity" + }, + "XSSProtection": { + "$ref": "#/definitions/XSSProtection" + } + }, + "required": [], + "type": "object" + }, + "ServerTimingHeadersConfig": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "SamplingRate": { + "maximum": 100, + "minimum": 0, + "multipleOf": 0.0001, + "type": "number" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "StrictTransportSecurity": { + "additionalProperties": false, + "properties": { + "AccessControlMaxAgeSec": { + "type": "integer" + }, + "IncludeSubdomains": { + "type": "boolean" + }, + "Override": { + "type": "boolean" + }, + "Preload": { + "type": "boolean" + } + }, + "required": [ + "Override", + "AccessControlMaxAgeSec" + ], + "type": "object" + }, + "XSSProtection": { + "additionalProperties": false, + "properties": { + "ModeBlock": { + "type": "boolean" + }, + "Override": { + "type": "boolean" + }, + "Protection": { + "type": "boolean" + }, + "ReportUri": { + "type": "string" + } + }, + "required": [ + "Override", + "Protection" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::ResponseHeadersPolicy", + "handlers": { + "create": { + "permissions": [ + "cloudfront:CreateResponseHeadersPolicy" + ] + }, + "delete": { + "permissions": [ + "cloudfront:DeleteResponseHeadersPolicy", + "cloudfront:GetResponseHeadersPolicy" + ] + }, + "list": { + "permissions": [ + "cloudfront:ListResponseHeadersPolicies" + ] + }, + "read": { + "permissions": [ + "cloudfront:GetResponseHeadersPolicy" + ] + }, + "update": { + "permissions": [ + "cloudfront:UpdateResponseHeadersPolicy", + "cloudfront:GetResponseHeadersPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "LastModifiedTime": { + "type": "string" + }, + "ResponseHeadersPolicyConfig": { + "$ref": "#/definitions/ResponseHeadersPolicyConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/LastModifiedTime" + ], + "required": [ + "ResponseHeadersPolicyConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudFront::ResponseHeadersPolicy" +} diff --git a/schema/aws-cloudfront-streamingdistribution.json b/schema/aws-cloudfront-streamingdistribution.json index 40a48c2..6c487ba 100644 --- a/schema/aws-cloudfront-streamingdistribution.json +++ b/schema/aws-cloudfront-streamingdistribution.json @@ -1,144 +1,144 @@ -{ - "additionalProperties": false, - "definitions": { - "Logging": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Enabled", - "Prefix" - ], - "type": "object" - }, - "S3Origin": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "OriginAccessIdentity": { - "type": "string" - } - }, - "required": [ - "DomainName", - "OriginAccessIdentity" - ], - "type": "object" - }, - "StreamingDistributionConfig": { - "additionalProperties": false, - "properties": { - "Aliases": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Comment": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Logging": { - "$ref": "#/definitions/Logging" - }, - "PriceClass": { - "type": "string" - }, - "S3Origin": { - "$ref": "#/definitions/S3Origin" - }, - "TrustedSigners": { - "$ref": "#/definitions/TrustedSigners" - } - }, - "required": [ - "Comment", - "Enabled", - "S3Origin", - "TrustedSigners" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TrustedSigners": { - "additionalProperties": false, - "properties": { - "AwsAccountNumbers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudFront::StreamingDistribution", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DomainName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "StreamingDistributionConfig": { - "$ref": "#/definitions/StreamingDistributionConfig" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/DomainName", - "/properties/Id" - ], - "required": [ - "StreamingDistributionConfig", - "Tags" - ], - "typeName": "AWS::CloudFront::StreamingDistribution" -} +{ + "additionalProperties": false, + "definitions": { + "Logging": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Prefix": { + "type": "string" + } + }, + "required": [ + "Bucket", + "Enabled", + "Prefix" + ], + "type": "object" + }, + "S3Origin": { + "additionalProperties": false, + "properties": { + "DomainName": { + "type": "string" + }, + "OriginAccessIdentity": { + "type": "string" + } + }, + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "type": "object" + }, + "StreamingDistributionConfig": { + "additionalProperties": false, + "properties": { + "Aliases": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Comment": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Logging": { + "$ref": "#/definitions/Logging" + }, + "PriceClass": { + "type": "string" + }, + "S3Origin": { + "$ref": "#/definitions/S3Origin" + }, + "TrustedSigners": { + "$ref": "#/definitions/TrustedSigners" + } + }, + "required": [ + "Comment", + "Enabled", + "S3Origin", + "TrustedSigners" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TrustedSigners": { + "additionalProperties": false, + "properties": { + "AwsAccountNumbers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudFront::StreamingDistribution", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DomainName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "StreamingDistributionConfig": { + "$ref": "#/definitions/StreamingDistributionConfig" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/DomainName", + "/properties/Id" + ], + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "typeName": "AWS::CloudFront::StreamingDistribution" +} diff --git a/schema/aws-cloudtrail-channel.json b/schema/aws-cloudtrail-channel.json index c503485..1f8d49e 100644 --- a/schema/aws-cloudtrail-channel.json +++ b/schema/aws-cloudtrail-channel.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Source" - ], - "definitions": { - "ChannelArn": { - "description": "The Amazon Resource Name (ARN) of a channel.", - "maxLength": 256, - "minLength": 3, - "pattern": "(^[a-zA-Z0-9._/\\-:]+$)", - "type": "string" - }, - "ChannelName": { - "description": "The name of the channel.", - "maxLength": 128, - "minLength": 3, - "pattern": "(^[a-zA-Z0-9._\\-]+$)", - "type": "string" - }, - "Destination": { - "additionalProperties": false, - "description": "The resource that receives events arriving from a channel.", - "properties": { - "Location": { - "description": "The ARN of a resource that receives events from a channel.", - "maxLength": 1024, - "minLength": 3, - "pattern": "(^[a-zA-Z0-9._/\\-:]+$)", - "type": "string" - }, - "Type": { - "description": "The type of destination for events arriving from a channel.", - "enum": [ - "EVENT_DATA_STORE" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Location" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Timestamp": { - "type": "string" - }, - "UUID": { - "maxLength": 36, - "minLength": 36, - "pattern": "(^[a-f0-9\\-]+$)", - "type": "string" - } - }, - "description": "A channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.", - "handlers": { - "create": { - "permissions": [ - "CloudTrail:CreateChannel", - "CloudTrail:AddTags" - ] - }, - "delete": { - "permissions": [ - "CloudTrail:DeleteChannel" - ] - }, - "list": { - "permissions": [ - "CloudTrail:ListChannels" - ] - }, - "read": { - "permissions": [ - "CloudTrail:GetChannel", - "CloudTrail:ListChannels" - ] - }, - "update": { - "permissions": [ - "CloudTrail:UpdateChannel", - "CloudTrail:GetChannel", - "CloudTrail:AddTags", - "CloudTrail:RemoveTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelArn" - ], - "properties": { - "ChannelArn": { - "$ref": "#/definitions/ChannelArn" - }, - "Destinations": { - "description": "One or more resources to which events arriving through a channel are logged and stored.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Destination" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "Name": { - "$ref": "#/definitions/ChannelName" - }, - "Source": { - "description": "The ARN of an on-premises storage solution or application, or a partner event source.", - "maxLength": 256, - "minLength": 1, - "pattern": "(.*)", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ChannelArn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CloudTrail::Channel", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Source" + ], + "definitions": { + "ChannelArn": { + "description": "The Amazon Resource Name (ARN) of a channel.", + "maxLength": 256, + "minLength": 3, + "pattern": "(^[a-zA-Z0-9._/\\-:]+$)", + "type": "string" + }, + "ChannelName": { + "description": "The name of the channel.", + "maxLength": 128, + "minLength": 3, + "pattern": "(^[a-zA-Z0-9._\\-]+$)", + "type": "string" + }, + "Destination": { + "additionalProperties": false, + "description": "The resource that receives events arriving from a channel.", + "properties": { + "Location": { + "description": "The ARN of a resource that receives events from a channel.", + "maxLength": 1024, + "minLength": 3, + "pattern": "(^[a-zA-Z0-9._/\\-:]+$)", + "type": "string" + }, + "Type": { + "description": "The type of destination for events arriving from a channel.", + "enum": [ + "EVENT_DATA_STORE" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Location" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Timestamp": { + "type": "string" + }, + "UUID": { + "maxLength": 36, + "minLength": 36, + "pattern": "(^[a-f0-9\\-]+$)", + "type": "string" + } + }, + "description": "A channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.", + "handlers": { + "create": { + "permissions": [ + "CloudTrail:CreateChannel", + "CloudTrail:AddTags" + ] + }, + "delete": { + "permissions": [ + "CloudTrail:DeleteChannel" + ] + }, + "list": { + "permissions": [ + "CloudTrail:ListChannels" + ] + }, + "read": { + "permissions": [ + "CloudTrail:GetChannel", + "CloudTrail:ListChannels" + ] + }, + "update": { + "permissions": [ + "CloudTrail:UpdateChannel", + "CloudTrail:GetChannel", + "CloudTrail:AddTags", + "CloudTrail:RemoveTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelArn" + ], + "properties": { + "ChannelArn": { + "$ref": "#/definitions/ChannelArn" + }, + "Destinations": { + "description": "One or more resources to which events arriving through a channel are logged and stored.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Destination" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Name": { + "$ref": "#/definitions/ChannelName" + }, + "Source": { + "description": "The ARN of an on-premises storage solution or application, or a partner event source.", + "maxLength": 256, + "minLength": 1, + "pattern": "(.*)", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ChannelArn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CloudTrail::Channel", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-cloudtrail-eventdatastore.json b/schema/aws-cloudtrail-eventdatastore.json index 2639138..ef96f7b 100644 --- a/schema/aws-cloudtrail-eventdatastore.json +++ b/schema/aws-cloudtrail-eventdatastore.json @@ -1,338 +1,338 @@ -{ - "additionalProperties": false, - "definitions": { - "AdvancedEventSelector": { - "additionalProperties": false, - "description": "Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record \ufb01elds. They help you control costs by logging only those events that are important to you.", - "properties": { - "FieldSelectors": { - "description": "Contains all selector statements in an advanced event selector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AdvancedFieldSelector" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FieldSelectors" - ], - "type": "object" - }, - "AdvancedFieldSelector": { - "additionalProperties": false, - "description": "A single selector statement in an advanced event selector.", - "properties": { - "EndsWith": { - "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Equals": { - "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Field": { - "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.", - "maxLength": 1000, - "minLength": 1, - "pattern": "([\\w|\\d|\\.|_]+)", - "type": "string" - }, - "NotEndsWith": { - "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotEquals": { - "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotStartsWith": { - "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "StartsWith": { - "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Field" - ], - "type": "object" - }, - "InsightSelector": { - "additionalProperties": false, - "description": "A string that contains Insights types that are logged on an event data store.", - "properties": { - "InsightType": { - "description": "The type of Insights to log on an event data store.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "An arbitrary set of tags (key-value pairs) for this event data store.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Timestamp": { - "type": "string" - } - }, - "description": "A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.", - "handlers": { - "create": { - "permissions": [ - "CloudTrail:CreateEventDataStore", - "CloudTrail:AddTags", - "CloudTrail:PutInsightSelectors", - "CloudTrail:EnableFederation", - "CloudTrail:GetEventDataStore", - "iam:PassRole", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "organizations:DescribeOrganization", - "organizations:ListAWSServiceAccessForOrganization", - "kms:GenerateDataKey", - "kms:Decrypt", - "glue:CreateDatabase", - "glue:CreateTable", - "glue:PassConnection", - "lakeformation:RegisterResource" - ] - }, - "delete": { - "permissions": [ - "CloudTrail:DeleteEventDataStore", - "CloudTrail:GetEventDataStore", - "CloudTrail:DisableFederation", - "glue:DeleteTable", - "lakeformation:DeregisterResource" - ] - }, - "list": { - "permissions": [ - "CloudTrail:ListEventDataStores", - "CloudTrail:GetEventDataStore", - "CloudTrail:GetInsightSelectors", - "CloudTrail:ListTags" - ] - }, - "read": { - "permissions": [ - "CloudTrail:GetEventDataStore", - "CloudTrail:ListEventDataStores", - "CloudTrail:GetInsightSelectors", - "CloudTrail:ListTags" - ] - }, - "update": { - "permissions": [ - "CloudTrail:UpdateEventDataStore", - "CloudTrail:RestoreEventDataStore", - "CloudTrail:AddTags", - "CloudTrail:RemoveTags", - "CloudTrail:StartEventDataStoreIngestion", - "CloudTrail:StopEventDataStoreIngestion", - "CloudTrail:GetEventDataStore", - "CloudTrail:PutInsightSelectors", - "CloudTrail:GetInsightSelectors", - "CloudTrail:EnableFederation", - "CloudTrail:DisableFederation", - "iam:PassRole", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "organizations:DescribeOrganization", - "organizations:ListAWSServiceAccessForOrganization", - "glue:CreateDatabase", - "glue:CreateTable", - "glue:PassConnection", - "lakeformation:RegisterResource", - "glue:DeleteTable", - "lakeformation:DeregisterResource", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/EventDataStoreArn" - ], - "properties": { - "AdvancedEventSelectors": { - "description": "The advanced event selectors that were used to select events for the data store.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AdvancedEventSelector" - }, - "type": "array", - "uniqueItems": true - }, - "BillingMode": { - "description": "The mode that the event data store will use to charge for event storage.", - "type": "string" - }, - "CreatedTimestamp": { - "$ref": "#/definitions/Timestamp", - "description": "The timestamp of the event data store's creation." - }, - "EventDataStoreArn": { - "description": "The ARN of the event data store.", - "type": "string" - }, - "FederationEnabled": { - "description": "Indicates whether federation is enabled on an event data store.", - "type": "boolean" - }, - "FederationRoleArn": { - "description": "The ARN of the role used for event data store federation.", - "type": "string" - }, - "IngestionEnabled": { - "description": "Indicates whether the event data store is ingesting events.", - "type": "boolean" - }, - "InsightSelectors": { - "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InsightSelector" - }, - "type": "array", - "uniqueItems": true - }, - "InsightsDestination": { - "description": "Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store", - "type": "string" - }, - "KmsKeyId": { - "description": "Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.", - "type": "string" - }, - "MultiRegionEnabled": { - "description": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.", - "type": "boolean" - }, - "Name": { - "description": "The name of the event data store.", - "type": "string" - }, - "OrganizationEnabled": { - "description": "Indicates that an event data store is collecting logged events for an organization.", - "type": "boolean" - }, - "RetentionPeriod": { - "description": "The retention period, in days.", - "type": "integer" - }, - "Status": { - "description": "The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TerminationProtectionEnabled": { - "description": "Indicates whether the event data store is protected from termination.", - "type": "boolean" - }, - "UpdatedTimestamp": { - "$ref": "#/definitions/Timestamp", - "description": "The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp." - } - }, - "propertyTransform": { - "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])" - }, - "readOnlyProperties": [ - "/properties/EventDataStoreArn", - "/properties/CreatedTimestamp", - "/properties/UpdatedTimestamp", - "/properties/Status", - "/properties/FederationStatus" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", - "typeName": "AWS::CloudTrail::EventDataStore" -} +{ + "additionalProperties": false, + "definitions": { + "AdvancedEventSelector": { + "additionalProperties": false, + "description": "Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record \ufb01elds. They help you control costs by logging only those events that are important to you.", + "properties": { + "FieldSelectors": { + "description": "Contains all selector statements in an advanced event selector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AdvancedFieldSelector" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FieldSelectors" + ], + "type": "object" + }, + "AdvancedFieldSelector": { + "additionalProperties": false, + "description": "A single selector statement in an advanced event selector.", + "properties": { + "EndsWith": { + "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Equals": { + "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Field": { + "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.", + "maxLength": 1000, + "minLength": 1, + "pattern": "([\\w|\\d|\\.|_]+)", + "type": "string" + }, + "NotEndsWith": { + "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotEquals": { + "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotStartsWith": { + "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "StartsWith": { + "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Field" + ], + "type": "object" + }, + "InsightSelector": { + "additionalProperties": false, + "description": "A string that contains Insights types that are logged on an event data store.", + "properties": { + "InsightType": { + "description": "The type of Insights to log on an event data store.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "An arbitrary set of tags (key-value pairs) for this event data store.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Timestamp": { + "type": "string" + } + }, + "description": "A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.", + "handlers": { + "create": { + "permissions": [ + "CloudTrail:CreateEventDataStore", + "CloudTrail:AddTags", + "CloudTrail:PutInsightSelectors", + "CloudTrail:EnableFederation", + "CloudTrail:GetEventDataStore", + "iam:PassRole", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "organizations:DescribeOrganization", + "organizations:ListAWSServiceAccessForOrganization", + "kms:GenerateDataKey", + "kms:Decrypt", + "glue:CreateDatabase", + "glue:CreateTable", + "glue:PassConnection", + "lakeformation:RegisterResource" + ] + }, + "delete": { + "permissions": [ + "CloudTrail:DeleteEventDataStore", + "CloudTrail:GetEventDataStore", + "CloudTrail:DisableFederation", + "glue:DeleteTable", + "lakeformation:DeregisterResource" + ] + }, + "list": { + "permissions": [ + "CloudTrail:ListEventDataStores", + "CloudTrail:GetEventDataStore", + "CloudTrail:GetInsightSelectors", + "CloudTrail:ListTags" + ] + }, + "read": { + "permissions": [ + "CloudTrail:GetEventDataStore", + "CloudTrail:ListEventDataStores", + "CloudTrail:GetInsightSelectors", + "CloudTrail:ListTags" + ] + }, + "update": { + "permissions": [ + "CloudTrail:UpdateEventDataStore", + "CloudTrail:RestoreEventDataStore", + "CloudTrail:AddTags", + "CloudTrail:RemoveTags", + "CloudTrail:StartEventDataStoreIngestion", + "CloudTrail:StopEventDataStoreIngestion", + "CloudTrail:GetEventDataStore", + "CloudTrail:PutInsightSelectors", + "CloudTrail:GetInsightSelectors", + "CloudTrail:EnableFederation", + "CloudTrail:DisableFederation", + "iam:PassRole", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "organizations:DescribeOrganization", + "organizations:ListAWSServiceAccessForOrganization", + "glue:CreateDatabase", + "glue:CreateTable", + "glue:PassConnection", + "lakeformation:RegisterResource", + "glue:DeleteTable", + "lakeformation:DeregisterResource", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/EventDataStoreArn" + ], + "properties": { + "AdvancedEventSelectors": { + "description": "The advanced event selectors that were used to select events for the data store.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AdvancedEventSelector" + }, + "type": "array", + "uniqueItems": true + }, + "BillingMode": { + "description": "The mode that the event data store will use to charge for event storage.", + "type": "string" + }, + "CreatedTimestamp": { + "$ref": "#/definitions/Timestamp", + "description": "The timestamp of the event data store's creation." + }, + "EventDataStoreArn": { + "description": "The ARN of the event data store.", + "type": "string" + }, + "FederationEnabled": { + "description": "Indicates whether federation is enabled on an event data store.", + "type": "boolean" + }, + "FederationRoleArn": { + "description": "The ARN of the role used for event data store federation.", + "type": "string" + }, + "IngestionEnabled": { + "description": "Indicates whether the event data store is ingesting events.", + "type": "boolean" + }, + "InsightSelectors": { + "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InsightSelector" + }, + "type": "array", + "uniqueItems": true + }, + "InsightsDestination": { + "description": "Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store", + "type": "string" + }, + "KmsKeyId": { + "description": "Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.", + "type": "string" + }, + "MultiRegionEnabled": { + "description": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.", + "type": "boolean" + }, + "Name": { + "description": "The name of the event data store.", + "type": "string" + }, + "OrganizationEnabled": { + "description": "Indicates that an event data store is collecting logged events for an organization.", + "type": "boolean" + }, + "RetentionPeriod": { + "description": "The retention period, in days.", + "type": "integer" + }, + "Status": { + "description": "The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TerminationProtectionEnabled": { + "description": "Indicates whether the event data store is protected from termination.", + "type": "boolean" + }, + "UpdatedTimestamp": { + "$ref": "#/definitions/Timestamp", + "description": "The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp." + } + }, + "propertyTransform": { + "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])" + }, + "readOnlyProperties": [ + "/properties/EventDataStoreArn", + "/properties/CreatedTimestamp", + "/properties/UpdatedTimestamp", + "/properties/Status", + "/properties/FederationStatus" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", + "typeName": "AWS::CloudTrail::EventDataStore" +} diff --git a/schema/aws-cloudtrail-resourcepolicy.json b/schema/aws-cloudtrail-resourcepolicy.json index 6f2bee2..69e5757 100644 --- a/schema/aws-cloudtrail-resourcepolicy.json +++ b/schema/aws-cloudtrail-resourcepolicy.json @@ -1,56 +1,56 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn" - ], - "description": "Resource Type definition for AWS::CloudTrail::ResourcePolicy", - "handlers": { - "create": { - "permissions": [ - "CloudTrail:PutResourcePolicy", - "CloudTrail:GetResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "CloudTrail:DeleteResourcePolicy" - ] - }, - "read": { - "permissions": [ - "CloudTrail:GetResourcePolicy" - ] - }, - "update": { - "permissions": [ - "CloudTrail:PutResourcePolicy", - "CloudTrail:GetResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceArn" - ], - "properties": { - "ResourceArn": { - "description": "The ARN of the AWS CloudTrail resource to which the policy applies.", - "type": "string" - }, - "ResourcePolicy": { - "description": "A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "ResourceArn", - "ResourcePolicy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::CloudTrail::ResourcePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn" + ], + "description": "Resource Type definition for AWS::CloudTrail::ResourcePolicy", + "handlers": { + "create": { + "permissions": [ + "CloudTrail:PutResourcePolicy", + "CloudTrail:GetResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "CloudTrail:DeleteResourcePolicy" + ] + }, + "read": { + "permissions": [ + "CloudTrail:GetResourcePolicy" + ] + }, + "update": { + "permissions": [ + "CloudTrail:PutResourcePolicy", + "CloudTrail:GetResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceArn" + ], + "properties": { + "ResourceArn": { + "description": "The ARN of the AWS CloudTrail resource to which the policy applies.", + "type": "string" + }, + "ResourcePolicy": { + "description": "A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "ResourceArn", + "ResourcePolicy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::CloudTrail::ResourcePolicy" +} diff --git a/schema/aws-cloudtrail-trail.json b/schema/aws-cloudtrail-trail.json index ff2de18..dcb475c 100644 --- a/schema/aws-cloudtrail-trail.json +++ b/schema/aws-cloudtrail-trail.json @@ -1,398 +1,398 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TrailName" - ], - "definitions": { - "AdvancedEventSelector": { - "additionalProperties": false, - "description": "Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record \ufb01elds. They help you control costs by logging only those events that are important to you.", - "properties": { - "FieldSelectors": { - "description": "Contains all selector statements in an advanced event selector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AdvancedFieldSelector" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FieldSelectors" - ], - "type": "object" - }, - "AdvancedFieldSelector": { - "additionalProperties": false, - "description": "A single selector statement in an advanced event selector.", - "properties": { - "EndsWith": { - "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Equals": { - "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Field": { - "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.", - "maxLength": 1000, - "minLength": 1, - "pattern": "([\\w|\\d|\\.|_]+)", - "type": "string" - }, - "NotEndsWith": { - "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotEquals": { - "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotStartsWith": { - "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "StartsWith": { - "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "(.+)", - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Field" - ], - "type": "object" - }, - "DataResource": { - "additionalProperties": false, - "description": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.", - "properties": { - "Type": { - "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.", - "type": "string" - }, - "Values": { - "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "EventSelector": { - "additionalProperties": false, - "description": "The type of email sending events to publish to the event destination.", - "properties": { - "DataResources": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataResource" - }, - "type": "array", - "uniqueItems": true - }, - "ExcludeManagementEventSources": { - "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing \"kms.amazonaws.com\". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "IncludeManagementEvents": { - "description": "Specify if you want your event selector to include management events for your trail.", - "type": "boolean" - }, - "ReadWriteType": { - "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.", - "enum": [ - "All", - "ReadOnly", - "WriteOnly" - ], - "type": "string" - } - }, - "type": "object" - }, - "InsightSelector": { - "additionalProperties": false, - "description": "A string that contains insight types that are logged on a trail.", - "properties": { - "InsightType": { - "description": "The type of insight to log on a trail.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "An arbitrary set of tags (key-value pairs) for this trail.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.", - "handlers": { - "create": { - "permissions": [ - "CloudTrail:CreateTrail", - "CloudTrail:StartLogging", - "CloudTrail:AddTags", - "CloudTrail:PutEventSelectors", - "CloudTrail:PutInsightSelectors", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "organizations:DescribeOrganization", - "organizations:ListAWSServiceAccessForOrganization" - ] - }, - "delete": { - "permissions": [ - "CloudTrail:DeleteTrail" - ] - }, - "list": { - "permissions": [ - "CloudTrail:ListTrails", - "CloudTrail:GetTrail", - "CloudTrail:GetTrailStatus", - "CloudTrail:ListTags", - "CloudTrail:GetEventSelectors", - "CloudTrail:GetInsightSelectors", - "CloudTrail:DescribeTrails" - ] - }, - "read": { - "permissions": [ - "CloudTrail:GetTrail", - "CloudTrail:GetTrailStatus", - "CloudTrail:ListTags", - "CloudTrail:GetEventSelectors", - "CloudTrail:GetInsightSelectors", - "CloudTrail:DescribeTrails" - ] - }, - "update": { - "permissions": [ - "CloudTrail:UpdateTrail", - "CloudTrail:StartLogging", - "CloudTrail:StopLogging", - "CloudTrail:AddTags", - "CloudTrail:RemoveTags", - "CloudTrail:PutEventSelectors", - "CloudTrail:PutInsightSelectors", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "organizations:DescribeOrganization", - "organizations:ListAWSServiceAccessForOrganization", - "CloudTrail:GetTrail", - "CloudTrail:DescribeTrails" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrailName" - ], - "properties": { - "AdvancedEventSelectors": { - "description": "The advanced event selectors that were used to select events for the data store.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AdvancedEventSelector" - }, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "type": "string" - }, - "CloudWatchLogsLogGroupArn": { - "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.", - "type": "string" - }, - "CloudWatchLogsRoleArn": { - "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.", - "type": "string" - }, - "EnableLogFileValidation": { - "description": "Specifies whether log file validation is enabled. The default is false.", - "type": "boolean" - }, - "EventSelectors": { - "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventSelector" - }, - "maxItems": 5, - "type": "array", - "uniqueItems": true - }, - "IncludeGlobalServiceEvents": { - "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files.", - "type": "boolean" - }, - "InsightSelectors": { - "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InsightSelector" - }, - "type": "array", - "uniqueItems": true - }, - "IsLogging": { - "description": "Whether the CloudTrail is currently logging AWS API calls.", - "type": "boolean" - }, - "IsMultiRegionTrail": { - "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.", - "type": "boolean" - }, - "IsOrganizationTrail": { - "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.", - "type": "boolean" - }, - "KMSKeyId": { - "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.", - "type": "string" - }, - "S3BucketName": { - "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.", - "type": "string" - }, - "S3KeyPrefix": { - "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.", - "maxLength": 200, - "type": "string" - }, - "SnsTopicArn": { - "type": "string" - }, - "SnsTopicName": { - "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.", - "maxLength": 256, - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TrailName": { - "maxLength": 128, - "minLength": 3, - "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\\._-])*[a-zA-Z0-9]$)", - "type": "string" - } - }, - "propertyTransform": { - "/properties/KMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KMSKeyId])" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/SnsTopicArn" - ], - "required": [ - "S3BucketName", - "IsLogging" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CloudTrail::Trail" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TrailName" + ], + "definitions": { + "AdvancedEventSelector": { + "additionalProperties": false, + "description": "Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record \ufb01elds. They help you control costs by logging only those events that are important to you.", + "properties": { + "FieldSelectors": { + "description": "Contains all selector statements in an advanced event selector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AdvancedFieldSelector" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FieldSelectors" + ], + "type": "object" + }, + "AdvancedFieldSelector": { + "additionalProperties": false, + "description": "A single selector statement in an advanced event selector.", + "properties": { + "EndsWith": { + "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Equals": { + "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Field": { + "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.", + "maxLength": 1000, + "minLength": 1, + "pattern": "([\\w|\\d|\\.|_]+)", + "type": "string" + }, + "NotEndsWith": { + "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotEquals": { + "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotStartsWith": { + "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "StartsWith": { + "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "(.+)", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Field" + ], + "type": "object" + }, + "DataResource": { + "additionalProperties": false, + "description": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.", + "properties": { + "Type": { + "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.", + "type": "string" + }, + "Values": { + "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "EventSelector": { + "additionalProperties": false, + "description": "The type of email sending events to publish to the event destination.", + "properties": { + "DataResources": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataResource" + }, + "type": "array", + "uniqueItems": true + }, + "ExcludeManagementEventSources": { + "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing \"kms.amazonaws.com\". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "IncludeManagementEvents": { + "description": "Specify if you want your event selector to include management events for your trail.", + "type": "boolean" + }, + "ReadWriteType": { + "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.", + "enum": [ + "All", + "ReadOnly", + "WriteOnly" + ], + "type": "string" + } + }, + "type": "object" + }, + "InsightSelector": { + "additionalProperties": false, + "description": "A string that contains insight types that are logged on a trail.", + "properties": { + "InsightType": { + "description": "The type of insight to log on a trail.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "An arbitrary set of tags (key-value pairs) for this trail.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.", + "handlers": { + "create": { + "permissions": [ + "CloudTrail:CreateTrail", + "CloudTrail:StartLogging", + "CloudTrail:AddTags", + "CloudTrail:PutEventSelectors", + "CloudTrail:PutInsightSelectors", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "organizations:DescribeOrganization", + "organizations:ListAWSServiceAccessForOrganization" + ] + }, + "delete": { + "permissions": [ + "CloudTrail:DeleteTrail" + ] + }, + "list": { + "permissions": [ + "CloudTrail:ListTrails", + "CloudTrail:GetTrail", + "CloudTrail:GetTrailStatus", + "CloudTrail:ListTags", + "CloudTrail:GetEventSelectors", + "CloudTrail:GetInsightSelectors", + "CloudTrail:DescribeTrails" + ] + }, + "read": { + "permissions": [ + "CloudTrail:GetTrail", + "CloudTrail:GetTrailStatus", + "CloudTrail:ListTags", + "CloudTrail:GetEventSelectors", + "CloudTrail:GetInsightSelectors", + "CloudTrail:DescribeTrails" + ] + }, + "update": { + "permissions": [ + "CloudTrail:UpdateTrail", + "CloudTrail:StartLogging", + "CloudTrail:StopLogging", + "CloudTrail:AddTags", + "CloudTrail:RemoveTags", + "CloudTrail:PutEventSelectors", + "CloudTrail:PutInsightSelectors", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "organizations:DescribeOrganization", + "organizations:ListAWSServiceAccessForOrganization", + "CloudTrail:GetTrail", + "CloudTrail:DescribeTrails" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrailName" + ], + "properties": { + "AdvancedEventSelectors": { + "description": "The advanced event selectors that were used to select events for the data store.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AdvancedEventSelector" + }, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "type": "string" + }, + "CloudWatchLogsLogGroupArn": { + "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.", + "type": "string" + }, + "CloudWatchLogsRoleArn": { + "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.", + "type": "string" + }, + "EnableLogFileValidation": { + "description": "Specifies whether log file validation is enabled. The default is false.", + "type": "boolean" + }, + "EventSelectors": { + "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventSelector" + }, + "maxItems": 5, + "type": "array", + "uniqueItems": true + }, + "IncludeGlobalServiceEvents": { + "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files.", + "type": "boolean" + }, + "InsightSelectors": { + "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InsightSelector" + }, + "type": "array", + "uniqueItems": true + }, + "IsLogging": { + "description": "Whether the CloudTrail is currently logging AWS API calls.", + "type": "boolean" + }, + "IsMultiRegionTrail": { + "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.", + "type": "boolean" + }, + "IsOrganizationTrail": { + "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.", + "type": "boolean" + }, + "KMSKeyId": { + "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.", + "type": "string" + }, + "S3BucketName": { + "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.", + "type": "string" + }, + "S3KeyPrefix": { + "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.", + "maxLength": 200, + "type": "string" + }, + "SnsTopicArn": { + "type": "string" + }, + "SnsTopicName": { + "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.", + "maxLength": 256, + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TrailName": { + "maxLength": 128, + "minLength": 3, + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\\._-])*[a-zA-Z0-9]$)", + "type": "string" + } + }, + "propertyTransform": { + "/properties/KMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KMSKeyId])" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/SnsTopicArn" + ], + "required": [ + "S3BucketName", + "IsLogging" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudtrail.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CloudTrail::Trail" +} diff --git a/schema/aws-cloudwatch-alarm.json b/schema/aws-cloudwatch-alarm.json index e9d4fb4..aa2a695 100644 --- a/schema/aws-cloudwatch-alarm.json +++ b/schema/aws-cloudwatch-alarm.json @@ -1,315 +1,315 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AlarmName" - ], - "definitions": { - "Dimension": { - "additionalProperties": false, - "description": "Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.", - "properties": { - "Name": { - "description": "The name of the dimension, from 1\u2013255 characters in length. This dimension name must have been included when the metric was published.", - "type": "string" - }, - "Value": { - "description": "The value for the dimension, from 1\u2013255 characters in length.", - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "Metric": { - "additionalProperties": false, - "description": "The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.", - "properties": { - "Dimensions": { - "description": "The metric dimensions that you want to be used for the metric that the alarm will watch.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "description": "The name of the metric that you want the alarm to watch. This is a required field.", - "type": "string" - }, - "Namespace": { - "description": "The namespace of the metric that the alarm will watch.", - "type": "string" - } - }, - "type": "object" - }, - "MetricDataQuery": { - "additionalProperties": false, - "description": "The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. \n Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.", - "properties": { - "AccountId": { - "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", - "type": "string" - }, - "Expression": { - "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.\n Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.", - "type": "string" - }, - "Id": { - "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.", - "type": "string" - }, - "Label": { - "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default.", - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/MetricStat", - "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." - }, - "Period": { - "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``.", - "type": "integer" - }, - "ReturnData": { - "description": "This option indicates whether to return the timestamps and raw data values of this metric.\n When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.\n This field is required.", - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "MetricStat": { - "additionalProperties": false, - "description": "This structure defines the metric to be returned, along with the statistics, period, and units.\n ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.", - "properties": { - "Metric": { - "$ref": "#/definitions/Metric", - "description": "The metric to return, including the metric name, namespace, and dimensions." - }, - "Period": { - "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.\n If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:\n + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).", - "type": "integer" - }, - "Stat": { - "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.", - "type": "string" - }, - "Unit": { - "description": "The unit to use for the returned data points. \n Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.", - "type": "string" - } - }, - "required": [ - "Stat", - "Period", - "Metric" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the specified tag key.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.\n When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.\n When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.", - "handlers": { - "create": { - "permissions": [ - "cloudwatch:PutMetricAlarm", - "cloudwatch:DescribeAlarms", - "cloudwatch:TagResource" - ] - }, - "delete": { - "permissions": [ - "cloudwatch:DeleteAlarms", - "cloudwatch:DescribeAlarms" - ] - }, - "list": { - "permissions": [ - "cloudwatch:DescribeAlarms" - ] - }, - "read": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "cloudwatch:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cloudwatch:PutMetricAlarm", - "cloudwatch:DescribeAlarms", - "cloudwatch:TagResource", - "cloudwatch:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AlarmName" - ], - "properties": { - "ActionsEnabled": { - "default": true, - "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", - "type": "boolean" - }, - "AlarmActions": { - "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AlarmDescription": { - "description": "The description of the alarm.", - "type": "string" - }, - "AlarmName": { - "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. \n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "Arn": { - "description": "", - "type": "string" - }, - "ComparisonOperator": { - "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.", - "type": "string" - }, - "DatapointsToAlarm": { - "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.\n If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.", - "type": "integer" - }, - "Dimensions": { - "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "EvaluateLowSampleCountPercentile": { - "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.", - "type": "string" - }, - "EvaluationPeriods": { - "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.\n For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.", - "type": "integer" - }, - "ExtendedStatistic": { - "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.", - "type": "string" - }, - "InsufficientDataActions": { - "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.", - "type": "string" - }, - "Metrics": { - "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.\n If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.", - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": true - }, - "Namespace": { - "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.\n For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)", - "type": "string" - }, - "OKActions": { - "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Period": { - "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.\n *Minimum:* 10", - "type": "integer" - }, - "Statistic": { - "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.", - "type": "string" - }, - "Tags": { - "description": "", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Threshold": { - "description": "The value to compare with the specified statistic.", - "type": "number" - }, - "ThresholdMetricId": { - "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.", - "type": "string" - }, - "TreatMissingData": { - "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.\n If you omit this parameter, the default behavior of ``missing`` is used.", - "type": "string" - }, - "Unit": { - "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.\n You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ComparisonOperator", - "EvaluationPeriods" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CloudWatch::Alarm" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AlarmName" + ], + "definitions": { + "Dimension": { + "additionalProperties": false, + "description": "Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.", + "properties": { + "Name": { + "description": "The name of the dimension, from 1\u2013255 characters in length. This dimension name must have been included when the metric was published.", + "type": "string" + }, + "Value": { + "description": "The value for the dimension, from 1\u2013255 characters in length.", + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "Metric": { + "additionalProperties": false, + "description": "The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.", + "properties": { + "Dimensions": { + "description": "The metric dimensions that you want to be used for the metric that the alarm will watch.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric that you want the alarm to watch. This is a required field.", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the metric that the alarm will watch.", + "type": "string" + } + }, + "type": "object" + }, + "MetricDataQuery": { + "additionalProperties": false, + "description": "The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. \n Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.", + "properties": { + "AccountId": { + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", + "type": "string" + }, + "Expression": { + "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.\n Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.", + "type": "string" + }, + "Id": { + "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.", + "type": "string" + }, + "Label": { + "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default.", + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/MetricStat", + "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." + }, + "Period": { + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``.", + "type": "integer" + }, + "ReturnData": { + "description": "This option indicates whether to return the timestamps and raw data values of this metric.\n When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.\n This field is required.", + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "MetricStat": { + "additionalProperties": false, + "description": "This structure defines the metric to be returned, along with the statistics, period, and units.\n ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.", + "properties": { + "Metric": { + "$ref": "#/definitions/Metric", + "description": "The metric to return, including the metric name, namespace, and dimensions." + }, + "Period": { + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.\n If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:\n + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).", + "type": "integer" + }, + "Stat": { + "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.", + "type": "string" + }, + "Unit": { + "description": "The unit to use for the returned data points. \n Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.", + "type": "string" + } + }, + "required": [ + "Stat", + "Period", + "Metric" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "One of the key-value pairs associated with the alarm. Tags can help you organize and categorize your resources.", + "properties": { + "Key": { + "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.\n When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.\n When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.", + "handlers": { + "create": { + "permissions": [ + "cloudwatch:PutMetricAlarm", + "cloudwatch:DescribeAlarms", + "cloudwatch:TagResource" + ] + }, + "delete": { + "permissions": [ + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms" + ] + }, + "list": { + "permissions": [ + "cloudwatch:DescribeAlarms" + ] + }, + "read": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "cloudwatch:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cloudwatch:PutMetricAlarm", + "cloudwatch:DescribeAlarms", + "cloudwatch:TagResource", + "cloudwatch:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AlarmName" + ], + "properties": { + "ActionsEnabled": { + "default": true, + "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", + "type": "boolean" + }, + "AlarmActions": { + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AlarmDescription": { + "description": "The description of the alarm.", + "type": "string" + }, + "AlarmName": { + "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. \n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "Arn": { + "description": "", + "type": "string" + }, + "ComparisonOperator": { + "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.", + "type": "string" + }, + "DatapointsToAlarm": { + "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.\n If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.", + "type": "integer" + }, + "Dimensions": { + "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "EvaluateLowSampleCountPercentile": { + "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.", + "type": "string" + }, + "EvaluationPeriods": { + "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.\n For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.", + "type": "integer" + }, + "ExtendedStatistic": { + "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.", + "type": "string" + }, + "InsufficientDataActions": { + "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.", + "type": "string" + }, + "Metrics": { + "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.\n If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.", + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": true + }, + "Namespace": { + "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.\n For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)", + "type": "string" + }, + "OKActions": { + "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Period": { + "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.\n *Minimum:* 10", + "type": "integer" + }, + "Statistic": { + "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the ``cloudwatch:TagResource`` permission.\n Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Threshold": { + "description": "The value to compare with the specified statistic.", + "type": "number" + }, + "ThresholdMetricId": { + "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.", + "type": "string" + }, + "TreatMissingData": { + "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.\n If you omit this parameter, the default behavior of ``missing`` is used.", + "type": "string" + }, + "Unit": { + "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.\n You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ComparisonOperator", + "EvaluationPeriods" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CloudWatch::Alarm" +} diff --git a/schema/aws-cloudwatch-anomalydetector.json b/schema/aws-cloudwatch-anomalydetector.json index 8bd7f0b..3a98454 100644 --- a/schema/aws-cloudwatch-anomalydetector.json +++ b/schema/aws-cloudwatch-anomalydetector.json @@ -1,226 +1,226 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Dimensions", - "/properties/MetricCharacteristics", - "/properties/MetricName", - "/properties/Namespace", - "/properties/SingleMetricAnomalyDetector", - "/properties/MetricMathAnomalyDetector", - "/properties/Stat" - ], - "definitions": { - "Configuration": { - "additionalProperties": false, - "properties": { - "ExcludedTimeRanges": { - "items": { - "$ref": "#/definitions/Range" - }, - "type": "array", - "uniqueItems": false - }, - "MetricTimeZone": { - "type": "string" - } - }, - "type": "object" - }, - "Dimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "Metric": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace" - ], - "type": "object" - }, - "MetricCharacteristics": { - "additionalProperties": false, - "properties": { - "PeriodicSpikes": { - "type": "boolean" - } - }, - "type": "object" - }, - "MetricDataQuery": { - "additionalProperties": false, - "properties": { - "AccountId": { - "type": "string" - }, - "Expression": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Label": { - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/MetricStat" - }, - "Period": { - "type": "integer" - }, - "ReturnData": { - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "MetricMathAnomalyDetector": { - "additionalProperties": false, - "properties": { - "MetricDataQueries": { - "items": { - "$ref": "#/definitions/MetricDataQuery" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "MetricStat": { - "additionalProperties": false, - "properties": { - "Metric": { - "$ref": "#/definitions/Metric" - }, - "Period": { - "type": "integer" - }, - "Stat": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Stat", - "Period", - "Metric" - ], - "type": "object" - }, - "Range": { - "additionalProperties": false, - "properties": { - "EndTime": { - "type": "string" - }, - "StartTime": { - "type": "string" - } - }, - "required": [ - "EndTime", - "StartTime" - ], - "type": "object" - }, - "SingleMetricAnomalyDetector": { - "additionalProperties": false, - "properties": { - "AccountId": { - "type": "string" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Stat": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudWatch::AnomalyDetector", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Configuration": { - "$ref": "#/definitions/Configuration" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "MetricCharacteristics": { - "$ref": "#/definitions/MetricCharacteristics" - }, - "MetricMathAnomalyDetector": { - "$ref": "#/definitions/MetricMathAnomalyDetector" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "SingleMetricAnomalyDetector": { - "$ref": "#/definitions/SingleMetricAnomalyDetector" - }, - "Stat": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::CloudWatch::AnomalyDetector" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Dimensions", + "/properties/MetricCharacteristics", + "/properties/MetricName", + "/properties/Namespace", + "/properties/SingleMetricAnomalyDetector", + "/properties/MetricMathAnomalyDetector", + "/properties/Stat" + ], + "definitions": { + "Configuration": { + "additionalProperties": false, + "properties": { + "ExcludedTimeRanges": { + "items": { + "$ref": "#/definitions/Range" + }, + "type": "array", + "uniqueItems": false + }, + "MetricTimeZone": { + "type": "string" + } + }, + "type": "object" + }, + "Dimension": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "Metric": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + } + }, + "required": [ + "MetricName", + "Namespace" + ], + "type": "object" + }, + "MetricCharacteristics": { + "additionalProperties": false, + "properties": { + "PeriodicSpikes": { + "type": "boolean" + } + }, + "type": "object" + }, + "MetricDataQuery": { + "additionalProperties": false, + "properties": { + "AccountId": { + "type": "string" + }, + "Expression": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Label": { + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/MetricStat" + }, + "Period": { + "type": "integer" + }, + "ReturnData": { + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "MetricMathAnomalyDetector": { + "additionalProperties": false, + "properties": { + "MetricDataQueries": { + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "MetricStat": { + "additionalProperties": false, + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Period": { + "type": "integer" + }, + "Stat": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "Stat", + "Period", + "Metric" + ], + "type": "object" + }, + "Range": { + "additionalProperties": false, + "properties": { + "EndTime": { + "type": "string" + }, + "StartTime": { + "type": "string" + } + }, + "required": [ + "EndTime", + "StartTime" + ], + "type": "object" + }, + "SingleMetricAnomalyDetector": { + "additionalProperties": false, + "properties": { + "AccountId": { + "type": "string" + }, + "Dimensions": { + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "Stat": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudWatch::AnomalyDetector", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Configuration": { + "$ref": "#/definitions/Configuration" + }, + "Dimensions": { + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "MetricCharacteristics": { + "$ref": "#/definitions/MetricCharacteristics" + }, + "MetricMathAnomalyDetector": { + "$ref": "#/definitions/MetricMathAnomalyDetector" + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "SingleMetricAnomalyDetector": { + "$ref": "#/definitions/SingleMetricAnomalyDetector" + }, + "Stat": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::CloudWatch::AnomalyDetector" +} diff --git a/schema/aws-cloudwatch-compositealarm.json b/schema/aws-cloudwatch-compositealarm.json index ab80022..082c16e 100644 --- a/schema/aws-cloudwatch-compositealarm.json +++ b/schema/aws-cloudwatch-compositealarm.json @@ -1,178 +1,178 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AlarmName" - ], - "definitions": { - "AlarmActionARN": { - "description": "Amazon Resource Name (ARN) of the action", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.", - "properties": { - "Key": { - "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the specified tag key.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression", - "handlers": { - "create": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "cloudwatch:PutCompositeAlarm", - "cloudwatch:TagResource" - ] - }, - "delete": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "cloudwatch:DeleteAlarms" - ] - }, - "list": { - "permissions": [ - "cloudwatch:DescribeAlarms" - ] - }, - "read": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "cloudwatch:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "cloudwatch:PutCompositeAlarm", - "cloudwatch:TagResource", - "cloudwatch:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AlarmName" - ], - "properties": { - "ActionsEnabled": { - "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", - "type": "boolean" - }, - "ActionsSuppressor": { - "description": "Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. ", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "ActionsSuppressorExtensionPeriod": { - "description": "Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.", - "minimum": 0, - "type": "integer" - }, - "ActionsSuppressorWaitPeriod": { - "description": "Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.", - "minimum": 0, - "type": "integer" - }, - "AlarmActions": { - "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).", - "items": { - "description": "Amazon Resource Name (ARN) of the action", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "AlarmDescription": { - "description": "The description of the alarm", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "AlarmName": { - "description": "The name of the Composite Alarm", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "AlarmRule": { - "description": "Expression which aggregates the state of other Alarms (Metric or Composite Alarms)", - "maxLength": 10240, - "minLength": 1, - "type": "string" - }, - "Arn": { - "description": "Amazon Resource Name (ARN) of the alarm", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "InsufficientDataActions": { - "description": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).", - "items": { - "description": "Amazon Resource Name (ARN) of the action", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "OKActions": { - "description": "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).", - "items": { - "description": "Amazon Resource Name (ARN) of the action", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "Tags": { - "description": "A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AlarmRule" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CloudWatch::CompositeAlarm" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AlarmName" + ], + "definitions": { + "AlarmActionARN": { + "description": "Amazon Resource Name (ARN) of the action", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.", + "properties": { + "Key": { + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression", + "handlers": { + "create": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "cloudwatch:PutCompositeAlarm", + "cloudwatch:TagResource" + ] + }, + "delete": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "cloudwatch:DeleteAlarms" + ] + }, + "list": { + "permissions": [ + "cloudwatch:DescribeAlarms" + ] + }, + "read": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "cloudwatch:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "cloudwatch:PutCompositeAlarm", + "cloudwatch:TagResource", + "cloudwatch:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AlarmName" + ], + "properties": { + "ActionsEnabled": { + "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", + "type": "boolean" + }, + "ActionsSuppressor": { + "description": "Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. ", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "ActionsSuppressorExtensionPeriod": { + "description": "Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.", + "minimum": 0, + "type": "integer" + }, + "ActionsSuppressorWaitPeriod": { + "description": "Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.", + "minimum": 0, + "type": "integer" + }, + "AlarmActions": { + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).", + "items": { + "description": "Amazon Resource Name (ARN) of the action", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "AlarmDescription": { + "description": "The description of the alarm", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "AlarmName": { + "description": "The name of the Composite Alarm", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "AlarmRule": { + "description": "Expression which aggregates the state of other Alarms (Metric or Composite Alarms)", + "maxLength": 10240, + "minLength": 1, + "type": "string" + }, + "Arn": { + "description": "Amazon Resource Name (ARN) of the alarm", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "InsufficientDataActions": { + "description": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "description": "Amazon Resource Name (ARN) of the action", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "OKActions": { + "description": "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "description": "Amazon Resource Name (ARN) of the action", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "Tags": { + "description": "A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AlarmRule" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CloudWatch::CompositeAlarm" +} diff --git a/schema/aws-cloudwatch-dashboard.json b/schema/aws-cloudwatch-dashboard.json index f462079..898db09 100644 --- a/schema/aws-cloudwatch-dashboard.json +++ b/schema/aws-cloudwatch-dashboard.json @@ -1,60 +1,60 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DashboardName" - ], - "description": "Resource Type definition for AWS::CloudWatch::Dashboard", - "handlers": { - "create": { - "permissions": [ - "cloudwatch:PutDashboard", - "cloudwatch:GetDashboard" - ] - }, - "delete": { - "permissions": [ - "cloudwatch:DeleteDashboards", - "cloudwatch:GetDashboard" - ] - }, - "list": { - "permissions": [ - "cloudwatch:ListDashboards" - ] - }, - "read": { - "permissions": [ - "cloudwatch:GetDashboard" - ] - }, - "update": { - "permissions": [ - "cloudwatch:PutDashboard" - ] - } - }, - "primaryIdentifier": [ - "/properties/DashboardName" - ], - "properties": { - "DashboardBody": { - "description": "The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard", - "type": "string" - }, - "DashboardName": { - "description": "The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.", - "type": "string" - } - }, - "required": [ - "DashboardBody" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CloudWatch::Dashboard" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DashboardName" + ], + "description": "Resource Type definition for AWS::CloudWatch::Dashboard", + "handlers": { + "create": { + "permissions": [ + "cloudwatch:PutDashboard", + "cloudwatch:GetDashboard" + ] + }, + "delete": { + "permissions": [ + "cloudwatch:DeleteDashboards", + "cloudwatch:GetDashboard" + ] + }, + "list": { + "permissions": [ + "cloudwatch:ListDashboards" + ] + }, + "read": { + "permissions": [ + "cloudwatch:GetDashboard" + ] + }, + "update": { + "permissions": [ + "cloudwatch:PutDashboard" + ] + } + }, + "primaryIdentifier": [ + "/properties/DashboardName" + ], + "properties": { + "DashboardBody": { + "description": "The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard", + "type": "string" + }, + "DashboardName": { + "description": "The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.", + "type": "string" + } + }, + "required": [ + "DashboardBody" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CloudWatch::Dashboard" +} diff --git a/schema/aws-cloudwatch-insightrule.json b/schema/aws-cloudwatch-insightrule.json index 7d3549c..471b74e 100644 --- a/schema/aws-cloudwatch-insightrule.json +++ b/schema/aws-cloudwatch-insightrule.json @@ -1,46 +1,46 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RuleName" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CloudWatch::InsightRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "RuleBody": { - "type": "string" - }, - "RuleName": { - "type": "string" - }, - "RuleState": { - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "RuleState", - "RuleBody", - "RuleName" - ], - "typeName": "AWS::CloudWatch::InsightRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RuleName" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CloudWatch::InsightRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "RuleBody": { + "type": "string" + }, + "RuleName": { + "type": "string" + }, + "RuleState": { + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "RuleState", + "RuleBody", + "RuleName" + ], + "typeName": "AWS::CloudWatch::InsightRule" +} diff --git a/schema/aws-cloudwatch-metricstream.json b/schema/aws-cloudwatch-metricstream.json index abf6a19..cdee013 100644 --- a/schema/aws-cloudwatch-metricstream.json +++ b/schema/aws-cloudwatch-metricstream.json @@ -1,282 +1,282 @@ -{ - "additionalProperties": false, - "allOf": [ - { - "required": [ - "FirehoseArn", - "RoleArn", - "OutputFormat" - ] - }, - { - "oneOf": [ - {}, - { - "required": [ - "IncludeFilters", - "ExcludeFilters" - ] - } - ] - } - ], - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "MetricStreamFilter": { - "additionalProperties": false, - "description": "This structure defines the metrics that will be streamed.", - "properties": { - "MetricNames": { - "description": "Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 999, - "type": "array" - }, - "Namespace": { - "description": "Only metrics with Namespace matching this value will be streamed.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "MetricStreamStatisticsConfiguration": { - "additionalProperties": false, - "description": "This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.", - "properties": { - "AdditionalStatistics": { - "description": "The additional statistics to stream for the metrics listed in IncludeMetrics.", - "items": { - "type": "string" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "IncludeMetrics": { - "description": "An array that defines the metrics that are to have additional statistics streamed.", - "items": { - "$ref": "#/definitions/MetricStreamStatisticsMetric" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "AdditionalStatistics", - "IncludeMetrics" - ], - "type": "object" - }, - "MetricStreamStatisticsMetric": { - "additionalProperties": false, - "description": "A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.", - "properties": { - "MetricName": { - "description": "The name of the metric.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Namespace": { - "description": "The namespace of the metric.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata that you can assign to a Metric Stream, consisting of a key-value pair.", - "properties": { - "Key": { - "description": "A unique identifier for the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "String which you can use to describe or define the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for Metric Stream", - "handlers": { - "create": { - "permissions": [ - "cloudwatch:PutMetricStream", - "cloudwatch:GetMetricStream", - "cloudwatch:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cloudwatch:DeleteMetricStream", - "cloudwatch:GetMetricStream" - ] - }, - "list": { - "permissions": [ - "cloudwatch:ListMetricStreams" - ] - }, - "read": { - "permissions": [ - "cloudwatch:GetMetricStream" - ] - }, - "update": { - "permissions": [ - "cloudwatch:PutMetricStream", - "cloudwatch:GetMetricStream", - "cloudwatch:TagResource", - "cloudwatch:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name of the metric stream.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "CreationDate": { - "anyOf": [ - { - "format": "date-time" - }, - { - "format": "timestamp" - } - ], - "description": "The date of creation of the metric stream.", - "type": "string" - }, - "ExcludeFilters": { - "description": "Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.", - "items": { - "$ref": "#/definitions/MetricStreamFilter" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "FirehoseArn": { - "description": "The ARN of the Kinesis Firehose where to stream the data.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "IncludeFilters": { - "description": "Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.", - "items": { - "$ref": "#/definitions/MetricStreamFilter" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "IncludeLinkedAccountsMetrics": { - "description": "If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.", - "type": "boolean" - }, - "LastUpdateDate": { - "anyOf": [ - { - "format": "date-time" - }, - { - "format": "timestamp" - } - ], - "description": "The date of the last update of the metric stream.", - "type": "string" - }, - "Name": { - "description": "Name of the metric stream.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "OutputFormat": { - "description": "The output format of the data streamed to the Kinesis Firehose.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that provides access to the Kinesis Firehose.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "State": { - "description": "Displays the state of the Metric Stream.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "StatisticsConfigurations": { - "description": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.", - "items": { - "$ref": "#/definitions/MetricStreamStatisticsConfiguration" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "A set of tags to assign to the delivery stream.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDate", - "/properties/LastUpdateDate", - "/properties/State" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", - "taggable": true, - "typeName": "AWS::CloudWatch::MetricStream", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "allOf": [ + { + "required": [ + "FirehoseArn", + "RoleArn", + "OutputFormat" + ] + }, + { + "oneOf": [ + {}, + { + "required": [ + "IncludeFilters", + "ExcludeFilters" + ] + } + ] + } + ], + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "MetricStreamFilter": { + "additionalProperties": false, + "description": "This structure defines the metrics that will be streamed.", + "properties": { + "MetricNames": { + "description": "Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 999, + "type": "array" + }, + "Namespace": { + "description": "Only metrics with Namespace matching this value will be streamed.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Namespace" + ], + "type": "object" + }, + "MetricStreamStatisticsConfiguration": { + "additionalProperties": false, + "description": "This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.", + "properties": { + "AdditionalStatistics": { + "description": "The additional statistics to stream for the metrics listed in IncludeMetrics.", + "items": { + "type": "string" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "IncludeMetrics": { + "description": "An array that defines the metrics that are to have additional statistics streamed.", + "items": { + "$ref": "#/definitions/MetricStreamStatisticsMetric" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "AdditionalStatistics", + "IncludeMetrics" + ], + "type": "object" + }, + "MetricStreamStatisticsMetric": { + "additionalProperties": false, + "description": "A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.", + "properties": { + "MetricName": { + "description": "The name of the metric.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Namespace": { + "description": "The namespace of the metric.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MetricName", + "Namespace" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata that you can assign to a Metric Stream, consisting of a key-value pair.", + "properties": { + "Key": { + "description": "A unique identifier for the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "String which you can use to describe or define the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Metric Stream", + "handlers": { + "create": { + "permissions": [ + "cloudwatch:PutMetricStream", + "cloudwatch:GetMetricStream", + "cloudwatch:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cloudwatch:DeleteMetricStream", + "cloudwatch:GetMetricStream" + ] + }, + "list": { + "permissions": [ + "cloudwatch:ListMetricStreams" + ] + }, + "read": { + "permissions": [ + "cloudwatch:GetMetricStream" + ] + }, + "update": { + "permissions": [ + "cloudwatch:PutMetricStream", + "cloudwatch:GetMetricStream", + "cloudwatch:TagResource", + "cloudwatch:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name of the metric stream.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "CreationDate": { + "anyOf": [ + { + "format": "date-time" + }, + { + "format": "timestamp" + } + ], + "description": "The date of creation of the metric stream.", + "type": "string" + }, + "ExcludeFilters": { + "description": "Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.", + "items": { + "$ref": "#/definitions/MetricStreamFilter" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "FirehoseArn": { + "description": "The ARN of the Kinesis Firehose where to stream the data.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "IncludeFilters": { + "description": "Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.", + "items": { + "$ref": "#/definitions/MetricStreamFilter" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "IncludeLinkedAccountsMetrics": { + "description": "If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.", + "type": "boolean" + }, + "LastUpdateDate": { + "anyOf": [ + { + "format": "date-time" + }, + { + "format": "timestamp" + } + ], + "description": "The date of the last update of the metric stream.", + "type": "string" + }, + "Name": { + "description": "Name of the metric stream.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "OutputFormat": { + "description": "The output format of the data streamed to the Kinesis Firehose.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that provides access to the Kinesis Firehose.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "State": { + "description": "Displays the state of the Metric Stream.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "StatisticsConfigurations": { + "description": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.", + "items": { + "$ref": "#/definitions/MetricStreamStatisticsConfiguration" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "A set of tags to assign to the delivery stream.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDate", + "/properties/LastUpdateDate", + "/properties/State" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", + "taggable": true, + "typeName": "AWS::CloudWatch::MetricStream", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-codeartifact-domain.json b/schema/aws-codeartifact-domain.json index 32702ad..5e44450 100644 --- a/schema/aws-codeartifact-domain.json +++ b/schema/aws-codeartifact-domain.json @@ -1,136 +1,144 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/EncryptionKey" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The resource schema to create a CodeArtifact domain.", - "handlers": { - "create": { - "permissions": [ - "codeartifact:CreateDomain", - "codeartifact:DescribeDomain", - "codeartifact:PutDomainPermissionsPolicy", - "codeartifact:GetDomainPermissionsPolicy", - "codeartifact:TagResource" - ] - }, - "delete": { - "permissions": [ - "codeartifact:DeleteDomain", - "codeartifact:DescribeDomain" - ] - }, - "list": { - "permissions": [ - "codeartifact:ListDomains" - ] - }, - "read": { - "permissions": [ - "codeartifact:DescribeDomain", - "codeartifact:GetDomainPermissionsPolicy", - "codeartifact:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codeartifact:PutDomainPermissionsPolicy", - "codeartifact:DeleteDomainPermissionsPolicy", - "codeartifact:GetDomainPermissionsPolicy", - "codeartifact:TagResource", - "codeartifact:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the domain.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DomainName": { - "description": "The name of the domain.", - "maxLength": 50, - "minLength": 2, - "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", - "type": "string" - }, - "EncryptionKey": { - "description": "The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.", - "type": "string" - }, - "Name": { - "description": "The name of the domain. This field is used for GetAtt", - "maxLength": 50, - "minLength": 2, - "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", - "type": "string" - }, - "Owner": { - "description": "The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt", - "pattern": "[0-9]{12}", - "type": "string" - }, - "PermissionsPolicyDocument": { - "description": "The access control resource policy on the provided domain.", - "maxLength": 5120, - "minLength": 2, - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Owner", - "/properties/Name", - "/properties/EncryptionKey", - "/properties/Arn" - ], - "required": [ - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeArtifact::Domain" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/EncryptionKey" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The resource schema to create a CodeArtifact domain.", + "handlers": { + "create": { + "permissions": [ + "codeartifact:CreateDomain", + "codeartifact:DescribeDomain", + "codeartifact:PutDomainPermissionsPolicy", + "codeartifact:GetDomainPermissionsPolicy", + "codeartifact:TagResource", + "codeartifact:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "codeartifact:DeleteDomain", + "codeartifact:DescribeDomain" + ] + }, + "list": { + "permissions": [ + "codeartifact:ListDomains" + ] + }, + "read": { + "permissions": [ + "codeartifact:DescribeDomain", + "codeartifact:GetDomainPermissionsPolicy", + "codeartifact:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeartifact:DescribeDomain", + "codeartifact:PutDomainPermissionsPolicy", + "codeartifact:DeleteDomainPermissionsPolicy", + "codeartifact:GetDomainPermissionsPolicy", + "codeartifact:TagResource", + "codeartifact:UntagResource", + "codeartifact:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the domain.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DomainName": { + "description": "The name of the domain.", + "maxLength": 50, + "minLength": 2, + "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", + "type": "string" + }, + "EncryptionKey": { + "description": "The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.", + "type": "string" + }, + "Name": { + "description": "The name of the domain. This field is used for GetAtt", + "maxLength": 50, + "minLength": 2, + "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", + "type": "string" + }, + "Owner": { + "description": "The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt", + "pattern": "[0-9]{12}", + "type": "string" + }, + "PermissionsPolicyDocument": { + "description": "The access control resource policy on the provided domain.", + "maxLength": 5120, + "minLength": 2, + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Owner", + "/properties/Name", + "/properties/EncryptionKey", + "/properties/Arn" + ], + "required": [ + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "codeartifact:ListTagsForResource", + "codeartifact:UntagResource", + "codeartifact:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeArtifact::Domain" +} diff --git a/schema/aws-codeartifact-packagegroup.json b/schema/aws-codeartifact-packagegroup.json index e85f9b9..80cfa24 100644 --- a/schema/aws-codeartifact-packagegroup.json +++ b/schema/aws-codeartifact-packagegroup.json @@ -1,216 +1,216 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/Pattern" - ], - "definitions": { - "OriginConfiguration": { - "additionalProperties": false, - "properties": { - "Restrictions": { - "$ref": "#/definitions/Restrictions", - "description": "The origin configuration that is applied to the package group.", - "type": "object" - } - }, - "required": [ - "Restrictions" - ], - "type": "object" - }, - "RestrictionType": { - "additionalProperties": false, - "properties": { - "Repositories": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RestrictionMode": { - "enum": [ - "ALLOW", - "BLOCK", - "ALLOW_SPECIFIC_REPOSITORIES", - "INHERIT" - ], - "type": "string" - } - }, - "required": [ - "RestrictionMode" - ], - "type": "object" - }, - "Restrictions": { - "additionalProperties": false, - "properties": { - "ExternalUpstream": { - "$ref": "#/definitions/RestrictionType", - "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections.", - "type": "object" - }, - "InternalUpstream": { - "$ref": "#/definitions/RestrictionType", - "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories.", - "type": "object" - }, - "Publish": { - "$ref": "#/definitions/RestrictionType", - "description": "The publish restriction determines if new package versions can be published.", - "type": "object" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The resource schema to create a CodeArtifact package group.", - "handlers": { - "create": { - "permissions": [ - "codeartifact:CreatePackageGroup", - "codeartifact:DescribePackageGroup", - "codeartifact:UpdatePackageGroup", - "codeartifact:UpdatePackageGroupOriginConfiguration", - "codeartifact:ListAllowedRepositoriesForGroup", - "codeartifact:ListTagsForResource", - "codeartifact:TagResource" - ] - }, - "delete": { - "permissions": [ - "codeartifact:DeletePackageGroup", - "codeartifact:DescribePackageGroup" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "codeartifact:ListPackageGroups" - ] - }, - "read": { - "permissions": [ - "codeartifact:DescribePackageGroup", - "codeartifact:ListAllowedRepositoriesForGroup", - "codeartifact:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codeartifact:UpdatePackageGroup", - "codeartifact:UpdatePackageGroupOriginConfiguration", - "codeartifact:DescribePackageGroup", - "codeartifact:ListAllowedRepositoriesForGroup", - "codeartifact:ListTagsForResource", - "codeartifact:TagResource", - "codeartifact:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the package group.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ContactInfo": { - "description": "The contact info of the package group.", - "maxLength": 1000, - "type": "string" - }, - "Description": { - "description": "The text description of the package group.", - "maxLength": 1000, - "type": "string" - }, - "DomainName": { - "description": "The name of the domain that contains the package group.", - "maxLength": 50, - "minLength": 2, - "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", - "type": "string" - }, - "DomainOwner": { - "description": "The 12-digit account ID of the AWS account that owns the domain.", - "pattern": "[0-9]{12}", - "type": "string" - }, - "OriginConfiguration": { - "$ref": "#/definitions/OriginConfiguration", - "description": "The package origin configuration of the package group.", - "type": "object" - }, - "Pattern": { - "description": "The package group pattern that is used to gather packages.", - "maxLength": 520, - "minLength": 2, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to the package group.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Pattern", - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "codeartifact:ListTagsForResource", - "codeartifact:UntagResource", - "codeartifact:TagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeArtifact::PackageGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/Pattern" + ], + "definitions": { + "OriginConfiguration": { + "additionalProperties": false, + "properties": { + "Restrictions": { + "$ref": "#/definitions/Restrictions", + "description": "The origin configuration that is applied to the package group.", + "type": "object" + } + }, + "required": [ + "Restrictions" + ], + "type": "object" + }, + "RestrictionType": { + "additionalProperties": false, + "properties": { + "Repositories": { + "items": { + "type": "string" + }, + "type": "array" + }, + "RestrictionMode": { + "enum": [ + "ALLOW", + "BLOCK", + "ALLOW_SPECIFIC_REPOSITORIES", + "INHERIT" + ], + "type": "string" + } + }, + "required": [ + "RestrictionMode" + ], + "type": "object" + }, + "Restrictions": { + "additionalProperties": false, + "properties": { + "ExternalUpstream": { + "$ref": "#/definitions/RestrictionType", + "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections.", + "type": "object" + }, + "InternalUpstream": { + "$ref": "#/definitions/RestrictionType", + "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories.", + "type": "object" + }, + "Publish": { + "$ref": "#/definitions/RestrictionType", + "description": "The publish restriction determines if new package versions can be published.", + "type": "object" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The resource schema to create a CodeArtifact package group.", + "handlers": { + "create": { + "permissions": [ + "codeartifact:CreatePackageGroup", + "codeartifact:DescribePackageGroup", + "codeartifact:UpdatePackageGroup", + "codeartifact:UpdatePackageGroupOriginConfiguration", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource", + "codeartifact:TagResource" + ] + }, + "delete": { + "permissions": [ + "codeartifact:DeletePackageGroup", + "codeartifact:DescribePackageGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "codeartifact:ListPackageGroups" + ] + }, + "read": { + "permissions": [ + "codeartifact:DescribePackageGroup", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeartifact:UpdatePackageGroup", + "codeartifact:UpdatePackageGroupOriginConfiguration", + "codeartifact:DescribePackageGroup", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource", + "codeartifact:TagResource", + "codeartifact:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the package group.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ContactInfo": { + "description": "The contact info of the package group.", + "maxLength": 1000, + "type": "string" + }, + "Description": { + "description": "The text description of the package group.", + "maxLength": 1000, + "type": "string" + }, + "DomainName": { + "description": "The name of the domain that contains the package group.", + "maxLength": 50, + "minLength": 2, + "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", + "type": "string" + }, + "DomainOwner": { + "description": "The 12-digit account ID of the AWS account that owns the domain.", + "pattern": "[0-9]{12}", + "type": "string" + }, + "OriginConfiguration": { + "$ref": "#/definitions/OriginConfiguration", + "description": "The package origin configuration of the package group.", + "type": "object" + }, + "Pattern": { + "description": "The package group pattern that is used to gather packages.", + "maxLength": 520, + "minLength": 2, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to the package group.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Pattern", + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "codeartifact:ListTagsForResource", + "codeartifact:UntagResource", + "codeartifact:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeArtifact::PackageGroup" +} diff --git a/schema/aws-codeartifact-repository.json b/schema/aws-codeartifact-repository.json index bdf2103..6895b2c 100644 --- a/schema/aws-codeartifact-repository.json +++ b/schema/aws-codeartifact-repository.json @@ -1,164 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RepositoryName", - "/properties/DomainName", - "/properties/DomainOwner" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The resource schema to create a CodeArtifact repository.", - "handlers": { - "create": { - "permissions": [ - "codeartifact:CreateRepository", - "codeartifact:DescribeRepository", - "codeartifact:PutRepositoryPermissionsPolicy", - "codeartifact:AssociateExternalConnection", - "codeartifact:AssociateWithDownstreamRepository", - "codeartifact:TagResource" - ] - }, - "delete": { - "permissions": [ - "codeartifact:DeleteRepository", - "codeartifact:DescribeRepository" - ] - }, - "list": { - "permissions": [ - "codeartifact:ListRepositories" - ] - }, - "read": { - "permissions": [ - "codeartifact:DescribeRepository", - "codeartifact:GetRepositoryPermissionsPolicy", - "codeartifact:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codeartifact:PutRepositoryPermissionsPolicy", - "codeartifact:DeleteRepositoryPermissionsPolicy", - "codeartifact:AssociateExternalConnection", - "codeartifact:DisassociateExternalConnection", - "codeartifact:UpdateRepository", - "codeartifact:DescribeRepository", - "codeartifact:AssociateWithDownstreamRepository", - "codeartifact:TagResource", - "codeartifact:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the repository.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "A text description of the repository.", - "maxLength": 1000, - "type": "string" - }, - "DomainName": { - "description": "The name of the domain that contains the repository.", - "maxLength": 50, - "minLength": 2, - "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", - "type": "string" - }, - "DomainOwner": { - "description": "The 12-digit account ID of the AWS account that owns the domain.", - "pattern": "[0-9]{12}", - "type": "string" - }, - "ExternalConnections": { - "description": "A list of external connections associated with the repository.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "The name of the repository. This is used for GetAtt", - "maxLength": 100, - "minLength": 2, - "pattern": "^([A-Za-z0-9][A-Za-z0-9._\\-]{1,99})$", - "type": "string" - }, - "PermissionsPolicyDocument": { - "description": "The access control resource policy on the provided repository.", - "maxLength": 5120, - "minLength": 2, - "type": "object" - }, - "RepositoryName": { - "description": "The name of the repository.", - "maxLength": 100, - "minLength": 2, - "pattern": "^([A-Za-z0-9][A-Za-z0-9._\\-]{1,99})$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Upstreams": { - "description": "A list of upstream repositories associated with the repository.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Name", - "/properties/DomainOwner", - "/properties/Arn" - ], - "required": [ - "RepositoryName", - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeArtifact::Repository" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RepositoryName", + "/properties/DomainName", + "/properties/DomainOwner" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The resource schema to create a CodeArtifact repository.", + "handlers": { + "create": { + "permissions": [ + "codeartifact:CreateRepository", + "codeartifact:DescribeRepository", + "codeartifact:PutRepositoryPermissionsPolicy", + "codeartifact:GetRepositoryPermissionsPolicy", + "codeartifact:AssociateExternalConnection", + "codeartifact:AssociateWithDownstreamRepository", + "codeartifact:TagResource", + "codeartifact:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "codeartifact:DeleteRepository", + "codeartifact:DescribeRepository" + ] + }, + "list": { + "permissions": [ + "codeartifact:ListRepositories" + ] + }, + "read": { + "permissions": [ + "codeartifact:DescribeRepository", + "codeartifact:GetRepositoryPermissionsPolicy", + "codeartifact:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeartifact:PutRepositoryPermissionsPolicy", + "codeartifact:GetRepositoryPermissionsPolicy", + "codeartifact:DeleteRepositoryPermissionsPolicy", + "codeartifact:AssociateExternalConnection", + "codeartifact:DisassociateExternalConnection", + "codeartifact:UpdateRepository", + "codeartifact:DescribeRepository", + "codeartifact:AssociateWithDownstreamRepository", + "codeartifact:TagResource", + "codeartifact:UntagResource", + "codeartifact:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the repository.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "A text description of the repository.", + "maxLength": 1000, + "type": "string" + }, + "DomainName": { + "description": "The name of the domain that contains the repository.", + "maxLength": 50, + "minLength": 2, + "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", + "type": "string" + }, + "DomainOwner": { + "description": "The 12-digit account ID of the AWS account that owns the domain.", + "pattern": "[0-9]{12}", + "type": "string" + }, + "ExternalConnections": { + "description": "A list of external connections associated with the repository.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "The name of the repository. This is used for GetAtt", + "maxLength": 100, + "minLength": 2, + "pattern": "^([A-Za-z0-9][A-Za-z0-9._\\-]{1,99})$", + "type": "string" + }, + "PermissionsPolicyDocument": { + "description": "The access control resource policy on the provided repository.", + "maxLength": 5120, + "minLength": 2, + "type": "object" + }, + "RepositoryName": { + "description": "The name of the repository.", + "maxLength": 100, + "minLength": 2, + "pattern": "^([A-Za-z0-9][A-Za-z0-9._\\-]{1,99})$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Upstreams": { + "description": "A list of upstream repositories associated with the repository.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Name", + "/properties/DomainOwner", + "/properties/Arn" + ], + "required": [ + "RepositoryName", + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "codeartifact:ListTagsForResource", + "codeartifact:UntagResource", + "codeartifact:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeArtifact::Repository" +} diff --git a/schema/aws-codebuild-fleet.json b/schema/aws-codebuild-fleet.json index 11427cf..d1b1cfb 100644 --- a/schema/aws-codebuild-fleet.json +++ b/schema/aws-codebuild-fleet.json @@ -1,154 +1,160 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "[a-zA-Z+-=._:/]+$", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeBuild::Fleet", - "handlers": { - "create": { - "permissions": [ - "codebuild:BatchGetFleets", - "codebuild:CreateFleet", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "codebuild:BatchGetFleets", - "codebuild:DeleteFleet" - ] - }, - "list": { - "permissions": [ - "codebuild:ListFleets" - ] - }, - "read": { - "permissions": [ - "codebuild:BatchGetFleets" - ] - }, - "update": { - "permissions": [ - "codebuild:BatchGetFleets", - "codebuild:UpdateFleet", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "minLength": 1, - "type": "string" - }, - "BaseCapacity": { - "minimum": 1, - "type": "integer" - }, - "ComputeType": { - "enum": [ - "BUILD_GENERAL1_SMALL", - "BUILD_GENERAL1_MEDIUM", - "BUILD_GENERAL1_LARGE", - "BUILD_GENERAL1_2XLARGE" - ], - "type": "string" - }, - "EnvironmentType": { - "enum": [ - "WINDOWS_SERVER_2019_CONTAINER", - "WINDOWS_SERVER_2022_CONTAINER", - "LINUX_CONTAINER", - "LINUX_GPU_CONTAINER", - "ARM_CONTAINER" - ], - "type": "string" - }, - "FleetServiceRole": { - "pattern": "^(?:arn:)[a-zA-Z+-=,._:/@]+$", - "type": "string" - }, - "FleetVpcConfig": { - "$ref": "#/definitions/VpcConfig" - }, - "Name": { - "maxLength": 128, - "minLength": 2, - "type": "string" - }, - "OverflowBehavior": { - "enum": [ - "QUEUE", - "ON_DEMAND" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeBuild::Fleet" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "[a-zA-Z+-=._:/]+$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Subnets": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeBuild::Fleet", + "handlers": { + "create": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:CreateFleet", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:DeleteFleet" + ] + }, + "list": { + "permissions": [ + "codebuild:ListFleets" + ] + }, + "read": { + "permissions": [ + "codebuild:BatchGetFleets" + ] + }, + "update": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:UpdateFleet", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "minLength": 1, + "type": "string" + }, + "BaseCapacity": { + "minimum": 1, + "type": "integer" + }, + "ComputeType": { + "enum": [ + "BUILD_GENERAL1_SMALL", + "BUILD_GENERAL1_MEDIUM", + "BUILD_GENERAL1_LARGE", + "BUILD_GENERAL1_XLARGE", + "BUILD_GENERAL1_2XLARGE" + ], + "type": "string" + }, + "EnvironmentType": { + "enum": [ + "WINDOWS_SERVER_2019_CONTAINER", + "WINDOWS_SERVER_2022_CONTAINER", + "LINUX_CONTAINER", + "LINUX_GPU_CONTAINER", + "ARM_CONTAINER", + "MAC_ARM" + ], + "type": "string" + }, + "FleetServiceRole": { + "pattern": "^(?:arn:)[a-zA-Z+-=,._:/@]+$", + "type": "string" + }, + "FleetVpcConfig": { + "$ref": "#/definitions/VpcConfig" + }, + "ImageId": { + "pattern": "^((aws/codebuild/[A-Za-z-]+:[0-9]+(-[0-9._]+)?)|ami-[a-z0-9]{1,1020})$", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 2, + "type": "string" + }, + "OverflowBehavior": { + "enum": [ + "QUEUE", + "ON_DEMAND" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeBuild::Fleet" +} diff --git a/schema/aws-codebuild-project.json b/schema/aws-codebuild-project.json index 177e07f..0e1d077 100644 --- a/schema/aws-codebuild-project.json +++ b/schema/aws-codebuild-project.json @@ -1,549 +1,549 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Artifacts": { - "additionalProperties": false, - "properties": { - "ArtifactIdentifier": { - "type": "string" - }, - "EncryptionDisabled": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NamespaceType": { - "type": "string" - }, - "OverrideArtifactName": { - "type": "boolean" - }, - "Packaging": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "BatchRestrictions": { - "additionalProperties": false, - "properties": { - "ComputeTypesAllowed": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaximumBuildsAllowed": { - "type": "integer" - } - }, - "type": "object" - }, - "BuildStatusConfig": { - "additionalProperties": false, - "properties": { - "Context": { - "type": "string" - }, - "TargetUrl": { - "type": "string" - } - }, - "type": "object" - }, - "CloudWatchLogsConfig": { - "additionalProperties": false, - "properties": { - "GroupName": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "StreamName": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "ComputeType": { - "type": "string" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Fleet": { - "$ref": "#/definitions/ProjectFleet" - }, - "Image": { - "type": "string" - }, - "ImagePullCredentialsType": { - "type": "string" - }, - "PrivilegedMode": { - "type": "boolean" - }, - "RegistryCredential": { - "$ref": "#/definitions/RegistryCredential" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Image", - "ComputeType" - ], - "type": "object" - }, - "EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "FilterGroup": { - "additionalProperties": false, - "type": "object" - }, - "GitSubmodulesConfig": { - "additionalProperties": false, - "properties": { - "FetchSubmodules": { - "type": "boolean" - } - }, - "required": [ - "FetchSubmodules" - ], - "type": "object" - }, - "LogsConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/CloudWatchLogsConfig" - }, - "S3Logs": { - "$ref": "#/definitions/S3LogsConfig" - } - }, - "type": "object" - }, - "ProjectBuildBatchConfig": { - "additionalProperties": false, - "properties": { - "BatchReportMode": { - "type": "string" - }, - "CombineArtifacts": { - "type": "boolean" - }, - "Restrictions": { - "$ref": "#/definitions/BatchRestrictions" - }, - "ServiceRole": { - "type": "string" - }, - "TimeoutInMins": { - "type": "integer" - } - }, - "type": "object" - }, - "ProjectCache": { - "additionalProperties": false, - "properties": { - "Location": { - "type": "string" - }, - "Modes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ProjectFileSystemLocation": { - "additionalProperties": false, - "properties": { - "Identifier": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "MountOptions": { - "type": "string" - }, - "MountPoint": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "MountPoint", - "Type", - "Identifier", - "Location" - ], - "type": "object" - }, - "ProjectFleet": { - "additionalProperties": false, - "properties": { - "FleetArn": { - "type": "string" - } - }, - "type": "object" - }, - "ProjectSourceVersion": { - "additionalProperties": false, - "properties": { - "SourceIdentifier": { - "type": "string" - }, - "SourceVersion": { - "type": "string" - } - }, - "required": [ - "SourceIdentifier" - ], - "type": "object" - }, - "ProjectTriggers": { - "additionalProperties": false, - "properties": { - "BuildType": { - "type": "string" - }, - "FilterGroups": { - "items": { - "$ref": "#/definitions/FilterGroup" - }, - "type": "array", - "uniqueItems": false - }, - "ScopeConfiguration": { - "$ref": "#/definitions/ScopeConfiguration" - }, - "Webhook": { - "type": "boolean" - } - }, - "type": "object" - }, - "RegistryCredential": { - "additionalProperties": false, - "properties": { - "Credential": { - "type": "string" - }, - "CredentialProvider": { - "type": "string" - } - }, - "required": [ - "Credential", - "CredentialProvider" - ], - "type": "object" - }, - "S3LogsConfig": { - "additionalProperties": false, - "properties": { - "EncryptionDisabled": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "ScopeConfiguration": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Source": { - "additionalProperties": false, - "properties": { - "Auth": { - "$ref": "#/definitions/SourceAuth" - }, - "BuildSpec": { - "type": "string" - }, - "BuildStatusConfig": { - "$ref": "#/definitions/BuildStatusConfig" - }, - "GitCloneDepth": { - "type": "integer" - }, - "GitSubmodulesConfig": { - "$ref": "#/definitions/GitSubmodulesConfig" - }, - "InsecureSsl": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "ReportBuildStatus": { - "type": "boolean" - }, - "SourceIdentifier": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SourceAuth": { - "additionalProperties": false, - "properties": { - "Resource": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeBuild::Project", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Artifacts": { - "$ref": "#/definitions/Artifacts" - }, - "BadgeEnabled": { - "type": "boolean" - }, - "BuildBatchConfig": { - "$ref": "#/definitions/ProjectBuildBatchConfig" - }, - "Cache": { - "$ref": "#/definitions/ProjectCache" - }, - "ConcurrentBuildLimit": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "EncryptionKey": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/Environment" - }, - "FileSystemLocations": { - "items": { - "$ref": "#/definitions/ProjectFileSystemLocation" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "LogsConfig": { - "$ref": "#/definitions/LogsConfig" - }, - "Name": { - "type": "string" - }, - "QueuedTimeoutInMinutes": { - "type": "integer" - }, - "ResourceAccessRole": { - "type": "string" - }, - "SecondaryArtifacts": { - "items": { - "$ref": "#/definitions/Artifacts" - }, - "type": "array", - "uniqueItems": false - }, - "SecondarySourceVersions": { - "items": { - "$ref": "#/definitions/ProjectSourceVersion" - }, - "type": "array", - "uniqueItems": false - }, - "SecondarySources": { - "items": { - "$ref": "#/definitions/Source" - }, - "type": "array", - "uniqueItems": false - }, - "ServiceRole": { - "type": "string" - }, - "Source": { - "$ref": "#/definitions/Source" - }, - "SourceVersion": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TimeoutInMinutes": { - "type": "integer" - }, - "Triggers": { - "$ref": "#/definitions/ProjectTriggers" - }, - "Visibility": { - "type": "string" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Artifacts", - "ServiceRole", - "Environment", - "Source" - ], - "typeName": "AWS::CodeBuild::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Artifacts": { + "additionalProperties": false, + "properties": { + "ArtifactIdentifier": { + "type": "string" + }, + "EncryptionDisabled": { + "type": "boolean" + }, + "Location": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "NamespaceType": { + "type": "string" + }, + "OverrideArtifactName": { + "type": "boolean" + }, + "Packaging": { + "type": "string" + }, + "Path": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "BatchRestrictions": { + "additionalProperties": false, + "properties": { + "ComputeTypesAllowed": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaximumBuildsAllowed": { + "type": "integer" + } + }, + "type": "object" + }, + "BuildStatusConfig": { + "additionalProperties": false, + "properties": { + "Context": { + "type": "string" + }, + "TargetUrl": { + "type": "string" + } + }, + "type": "object" + }, + "CloudWatchLogsConfig": { + "additionalProperties": false, + "properties": { + "GroupName": { + "type": "string" + }, + "Status": { + "type": "string" + }, + "StreamName": { + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "Environment": { + "additionalProperties": false, + "properties": { + "Certificate": { + "type": "string" + }, + "ComputeType": { + "type": "string" + }, + "EnvironmentVariables": { + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "Fleet": { + "$ref": "#/definitions/ProjectFleet" + }, + "Image": { + "type": "string" + }, + "ImagePullCredentialsType": { + "type": "string" + }, + "PrivilegedMode": { + "type": "boolean" + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Image", + "ComputeType" + ], + "type": "object" + }, + "EnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "FilterGroup": { + "additionalProperties": false, + "type": "object" + }, + "GitSubmodulesConfig": { + "additionalProperties": false, + "properties": { + "FetchSubmodules": { + "type": "boolean" + } + }, + "required": [ + "FetchSubmodules" + ], + "type": "object" + }, + "LogsConfig": { + "additionalProperties": false, + "properties": { + "CloudWatchLogs": { + "$ref": "#/definitions/CloudWatchLogsConfig" + }, + "S3Logs": { + "$ref": "#/definitions/S3LogsConfig" + } + }, + "type": "object" + }, + "ProjectBuildBatchConfig": { + "additionalProperties": false, + "properties": { + "BatchReportMode": { + "type": "string" + }, + "CombineArtifacts": { + "type": "boolean" + }, + "Restrictions": { + "$ref": "#/definitions/BatchRestrictions" + }, + "ServiceRole": { + "type": "string" + }, + "TimeoutInMins": { + "type": "integer" + } + }, + "type": "object" + }, + "ProjectCache": { + "additionalProperties": false, + "properties": { + "Location": { + "type": "string" + }, + "Modes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ProjectFileSystemLocation": { + "additionalProperties": false, + "properties": { + "Identifier": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "MountOptions": { + "type": "string" + }, + "MountPoint": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "MountPoint", + "Type", + "Identifier", + "Location" + ], + "type": "object" + }, + "ProjectFleet": { + "additionalProperties": false, + "properties": { + "FleetArn": { + "type": "string" + } + }, + "type": "object" + }, + "ProjectSourceVersion": { + "additionalProperties": false, + "properties": { + "SourceIdentifier": { + "type": "string" + }, + "SourceVersion": { + "type": "string" + } + }, + "required": [ + "SourceIdentifier" + ], + "type": "object" + }, + "ProjectTriggers": { + "additionalProperties": false, + "properties": { + "BuildType": { + "type": "string" + }, + "FilterGroups": { + "items": { + "$ref": "#/definitions/FilterGroup" + }, + "type": "array", + "uniqueItems": false + }, + "ScopeConfiguration": { + "$ref": "#/definitions/ScopeConfiguration" + }, + "Webhook": { + "type": "boolean" + } + }, + "type": "object" + }, + "RegistryCredential": { + "additionalProperties": false, + "properties": { + "Credential": { + "type": "string" + }, + "CredentialProvider": { + "type": "string" + } + }, + "required": [ + "Credential", + "CredentialProvider" + ], + "type": "object" + }, + "S3LogsConfig": { + "additionalProperties": false, + "properties": { + "EncryptionDisabled": { + "type": "boolean" + }, + "Location": { + "type": "string" + }, + "Status": { + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "ScopeConfiguration": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Source": { + "additionalProperties": false, + "properties": { + "Auth": { + "$ref": "#/definitions/SourceAuth" + }, + "BuildSpec": { + "type": "string" + }, + "BuildStatusConfig": { + "$ref": "#/definitions/BuildStatusConfig" + }, + "GitCloneDepth": { + "type": "integer" + }, + "GitSubmodulesConfig": { + "$ref": "#/definitions/GitSubmodulesConfig" + }, + "InsecureSsl": { + "type": "boolean" + }, + "Location": { + "type": "string" + }, + "ReportBuildStatus": { + "type": "boolean" + }, + "SourceIdentifier": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SourceAuth": { + "additionalProperties": false, + "properties": { + "Resource": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Subnets": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeBuild::Project", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Artifacts": { + "$ref": "#/definitions/Artifacts" + }, + "BadgeEnabled": { + "type": "boolean" + }, + "BuildBatchConfig": { + "$ref": "#/definitions/ProjectBuildBatchConfig" + }, + "Cache": { + "$ref": "#/definitions/ProjectCache" + }, + "ConcurrentBuildLimit": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "EncryptionKey": { + "type": "string" + }, + "Environment": { + "$ref": "#/definitions/Environment" + }, + "FileSystemLocations": { + "items": { + "$ref": "#/definitions/ProjectFileSystemLocation" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "LogsConfig": { + "$ref": "#/definitions/LogsConfig" + }, + "Name": { + "type": "string" + }, + "QueuedTimeoutInMinutes": { + "type": "integer" + }, + "ResourceAccessRole": { + "type": "string" + }, + "SecondaryArtifacts": { + "items": { + "$ref": "#/definitions/Artifacts" + }, + "type": "array", + "uniqueItems": false + }, + "SecondarySourceVersions": { + "items": { + "$ref": "#/definitions/ProjectSourceVersion" + }, + "type": "array", + "uniqueItems": false + }, + "SecondarySources": { + "items": { + "$ref": "#/definitions/Source" + }, + "type": "array", + "uniqueItems": false + }, + "ServiceRole": { + "type": "string" + }, + "Source": { + "$ref": "#/definitions/Source" + }, + "SourceVersion": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TimeoutInMinutes": { + "type": "integer" + }, + "Triggers": { + "$ref": "#/definitions/ProjectTriggers" + }, + "Visibility": { + "type": "string" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Artifacts", + "ServiceRole", + "Environment", + "Source" + ], + "typeName": "AWS::CodeBuild::Project" +} diff --git a/schema/aws-codebuild-reportgroup.json b/schema/aws-codebuild-reportgroup.json index 6762cbd..794c8d4 100644 --- a/schema/aws-codebuild-reportgroup.json +++ b/schema/aws-codebuild-reportgroup.json @@ -1,107 +1,107 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type" - ], - "definitions": { - "ReportExportConfig": { - "additionalProperties": false, - "properties": { - "ExportConfigType": { - "type": "string" - }, - "S3Destination": { - "$ref": "#/definitions/S3ReportExportConfig" - } - }, - "required": [ - "ExportConfigType" - ], - "type": "object" - }, - "S3ReportExportConfig": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "BucketOwner": { - "type": "string" - }, - "EncryptionDisabled": { - "type": "boolean" - }, - "EncryptionKey": { - "type": "string" - }, - "Packaging": { - "type": "string" - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeBuild::ReportGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DeleteReports": { - "type": "boolean" - }, - "ExportConfig": { - "$ref": "#/definitions/ReportExportConfig" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Type", - "ExportConfig" - ], - "typeName": "AWS::CodeBuild::ReportGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type" + ], + "definitions": { + "ReportExportConfig": { + "additionalProperties": false, + "properties": { + "ExportConfigType": { + "type": "string" + }, + "S3Destination": { + "$ref": "#/definitions/S3ReportExportConfig" + } + }, + "required": [ + "ExportConfigType" + ], + "type": "object" + }, + "S3ReportExportConfig": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "BucketOwner": { + "type": "string" + }, + "EncryptionDisabled": { + "type": "boolean" + }, + "EncryptionKey": { + "type": "string" + }, + "Packaging": { + "type": "string" + }, + "Path": { + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeBuild::ReportGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DeleteReports": { + "type": "boolean" + }, + "ExportConfig": { + "$ref": "#/definitions/ReportExportConfig" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Type", + "ExportConfig" + ], + "typeName": "AWS::CodeBuild::ReportGroup" +} diff --git a/schema/aws-codebuild-sourcecredential.json b/schema/aws-codebuild-sourcecredential.json index 604f869..ecd99c4 100644 --- a/schema/aws-codebuild-sourcecredential.json +++ b/schema/aws-codebuild-sourcecredential.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerType" - ], - "description": "Resource Type definition for AWS::CodeBuild::SourceCredential", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AuthType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ServerType": { - "type": "string" - }, - "Token": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ServerType", - "Token", - "AuthType" - ], - "typeName": "AWS::CodeBuild::SourceCredential" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerType" + ], + "description": "Resource Type definition for AWS::CodeBuild::SourceCredential", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AuthType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ServerType": { + "type": "string" + }, + "Token": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ServerType", + "Token", + "AuthType" + ], + "typeName": "AWS::CodeBuild::SourceCredential" +} diff --git a/schema/aws-codecommit-repository.json b/schema/aws-codecommit-repository.json index 2343ccc..c7857d7 100644 --- a/schema/aws-codecommit-repository.json +++ b/schema/aws-codecommit-repository.json @@ -1,147 +1,147 @@ -{ - "additionalProperties": false, - "definitions": { - "Code": { - "additionalProperties": false, - "properties": { - "BranchName": { - "type": "string" - }, - "S3": { - "$ref": "#/definitions/S3" - } - }, - "required": [ - "S3" - ], - "type": "object" - }, - "RepositoryTrigger": { - "additionalProperties": false, - "properties": { - "Branches": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CustomData": { - "type": "string" - }, - "DestinationArn": { - "type": "string" - }, - "Events": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Events", - "DestinationArn", - "Name" - ], - "type": "object" - }, - "S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeCommit::Repository", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CloneUrlHttp": { - "type": "string" - }, - "CloneUrlSsh": { - "type": "string" - }, - "Code": { - "$ref": "#/definitions/Code" - }, - "Id": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RepositoryDescription": { - "type": "string" - }, - "RepositoryName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Triggers": { - "items": { - "$ref": "#/definitions/RepositoryTrigger" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/CloneUrlHttp", - "/properties/Id", - "/properties/Name", - "/properties/CloneUrlSsh", - "/properties/Arn" - ], - "required": [ - "RepositoryName" - ], - "typeName": "AWS::CodeCommit::Repository" -} +{ + "additionalProperties": false, + "definitions": { + "Code": { + "additionalProperties": false, + "properties": { + "BranchName": { + "type": "string" + }, + "S3": { + "$ref": "#/definitions/S3" + } + }, + "required": [ + "S3" + ], + "type": "object" + }, + "RepositoryTrigger": { + "additionalProperties": false, + "properties": { + "Branches": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CustomData": { + "type": "string" + }, + "DestinationArn": { + "type": "string" + }, + "Events": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Events", + "DestinationArn", + "Name" + ], + "type": "object" + }, + "S3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "ObjectVersion": { + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeCommit::Repository", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CloneUrlHttp": { + "type": "string" + }, + "CloneUrlSsh": { + "type": "string" + }, + "Code": { + "$ref": "#/definitions/Code" + }, + "Id": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RepositoryDescription": { + "type": "string" + }, + "RepositoryName": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Triggers": { + "items": { + "$ref": "#/definitions/RepositoryTrigger" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/CloneUrlHttp", + "/properties/Id", + "/properties/Name", + "/properties/CloneUrlSsh", + "/properties/Arn" + ], + "required": [ + "RepositoryName" + ], + "typeName": "AWS::CodeCommit::Repository" +} diff --git a/schema/aws-codeconnections-connection.json b/schema/aws-codeconnections-connection.json index f4db7af..3e7d7bb 100644 --- a/schema/aws-codeconnections-connection.json +++ b/schema/aws-codeconnections-connection.json @@ -1,131 +1,131 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectionName", - "/properties/ProviderType", - "/properties/HostArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)", - "handlers": { - "create": { - "permissions": [ - "codeconnections:CreateConnection", - "codeconnections:TagResource" - ] - }, - "delete": { - "permissions": [ - "codeconnections:DeleteConnection" - ] - }, - "list": { - "permissions": [ - "codeconnections:ListConnections", - "codeconnections:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "codeconnections:GetConnection", - "codeconnections:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codeconnections:ListTagsForResource", - "codeconnections:TagResource", - "codeconnections:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectionArn" - ], - "properties": { - "ConnectionArn": { - "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "ConnectionName": { - "description": "The name of the connection. Connection names must be unique in an AWS user account.", - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "ConnectionStatus": { - "description": "The current status of the connection.", - "type": "string" - }, - "HostArn": { - "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "OwnerAccountId": { - "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.", - "maxLength": 12, - "minLength": 12, - "pattern": "[0-9]{12}", - "type": "string" - }, - "ProviderType": { - "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.", - "type": "string" - }, - "Tags": { - "description": "Specifies the tags applied to a connection.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ConnectionArn", - "/properties/ConnectionStatus", - "/properties/OwnerAccountId" - ], - "required": [ - "ConnectionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeconnections.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeConnections::Connection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectionName", + "/properties/ProviderType", + "/properties/HostArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)", + "handlers": { + "create": { + "permissions": [ + "codeconnections:CreateConnection", + "codeconnections:TagResource" + ] + }, + "delete": { + "permissions": [ + "codeconnections:DeleteConnection" + ] + }, + "list": { + "permissions": [ + "codeconnections:ListConnections", + "codeconnections:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "codeconnections:GetConnection", + "codeconnections:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeconnections:ListTagsForResource", + "codeconnections:TagResource", + "codeconnections:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectionArn" + ], + "properties": { + "ConnectionArn": { + "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "ConnectionName": { + "description": "The name of the connection. Connection names must be unique in an AWS user account.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ConnectionStatus": { + "description": "The current status of the connection.", + "type": "string" + }, + "HostArn": { + "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "OwnerAccountId": { + "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.", + "maxLength": 12, + "minLength": 12, + "pattern": "[0-9]{12}", + "type": "string" + }, + "ProviderType": { + "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.", + "type": "string" + }, + "Tags": { + "description": "Specifies the tags applied to a connection.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ConnectionArn", + "/properties/ConnectionStatus", + "/properties/OwnerAccountId" + ], + "required": [ + "ConnectionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeconnections.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeConnections::Connection" +} diff --git a/schema/aws-codedeploy-application.json b/schema/aws-codedeploy-application.json index 98b7420..792609e 100644 --- a/schema/aws-codedeploy-application.json +++ b/schema/aws-codedeploy-application.json @@ -1,88 +1,88 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName", - "/properties/ComputePlatform" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application", - "handlers": { - "create": { - "permissions": [ - "codedeploy:CreateApplication", - "codedeploy:TagResource" - ] - }, - "delete": { - "permissions": [ - "codedeploy:GetApplication", - "codedeploy:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "codedeploy:ListApplications" - ] - }, - "read": { - "permissions": [ - "codedeploy:GetApplication", - "codedeploy:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codedeploy:TagResource", - "codedeploy:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationName" - ], - "properties": { - "ApplicationName": { - "description": "A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.", - "type": "string" - }, - "ComputePlatform": { - "description": "The compute platform that CodeDeploy deploys the application to.", - "type": "string" - }, - "Tags": { - "description": "The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. ", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeDeploy::Application" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName", + "/properties/ComputePlatform" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application", + "handlers": { + "create": { + "permissions": [ + "codedeploy:CreateApplication", + "codedeploy:TagResource" + ] + }, + "delete": { + "permissions": [ + "codedeploy:GetApplication", + "codedeploy:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "codedeploy:ListApplications" + ] + }, + "read": { + "permissions": [ + "codedeploy:GetApplication", + "codedeploy:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codedeploy:TagResource", + "codedeploy:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationName" + ], + "properties": { + "ApplicationName": { + "description": "A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.", + "type": "string" + }, + "ComputePlatform": { + "description": "The compute platform that CodeDeploy deploys the application to.", + "type": "string" + }, + "Tags": { + "description": "The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. ", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeDeploy::Application" +} diff --git a/schema/aws-codedeploy-deploymentconfig.json b/schema/aws-codedeploy-deploymentconfig.json index 40a7aae..cc48a8e 100644 --- a/schema/aws-codedeploy-deploymentconfig.json +++ b/schema/aws-codedeploy-deploymentconfig.json @@ -1,169 +1,169 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeploymentConfigName", - "/properties/MinimumHealthyHosts", - "/properties/ComputePlatform", - "/properties/ZonalConfig", - "/properties/TrafficRoutingConfig" - ], - "definitions": { - "MinimumHealthyHosts": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "MinimumHealthyHostsPerZone": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "TimeBasedCanary": { - "additionalProperties": false, - "properties": { - "CanaryInterval": { - "type": "integer" - }, - "CanaryPercentage": { - "type": "integer" - } - }, - "required": [ - "CanaryPercentage", - "CanaryInterval" - ], - "type": "object" - }, - "TimeBasedLinear": { - "additionalProperties": false, - "properties": { - "LinearInterval": { - "type": "integer" - }, - "LinearPercentage": { - "type": "integer" - } - }, - "required": [ - "LinearInterval", - "LinearPercentage" - ], - "type": "object" - }, - "TrafficRoutingConfig": { - "additionalProperties": false, - "properties": { - "TimeBasedCanary": { - "$ref": "#/definitions/TimeBasedCanary" - }, - "TimeBasedLinear": { - "$ref": "#/definitions/TimeBasedLinear" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ZonalConfig": { - "additionalProperties": false, - "properties": { - "FirstZoneMonitorDurationInSeconds": { - "format": "int64", - "type": "integer" - }, - "MinimumHealthyHostsPerZone": { - "$ref": "#/definitions/MinimumHealthyHostsPerZone" - }, - "MonitorDurationInSeconds": { - "format": "int64", - "type": "integer" - } - }, - "required": [], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeDeploy::DeploymentConfig", - "handlers": { - "create": { - "permissions": [ - "codedeploy:CreateDeploymentConfig" - ] - }, - "delete": { - "permissions": [ - "codedeploy:GetDeploymentConfig", - "codedeploy:DeleteDeploymentConfig" - ] - }, - "list": { - "permissions": [ - "codedeploy:ListDeploymentConfigs" - ] - }, - "read": { - "permissions": [ - "codedeploy:GetDeploymentConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeploymentConfigName" - ], - "properties": { - "ComputePlatform": { - "description": "The destination platform type for the deployment (Lambda, Server, or ECS).", - "type": "string" - }, - "DeploymentConfigName": { - "description": "A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.", - "type": "string" - }, - "MinimumHealthyHosts": { - "$ref": "#/definitions/MinimumHealthyHosts", - "description": "The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value." - }, - "TrafficRoutingConfig": { - "$ref": "#/definitions/TrafficRoutingConfig", - "description": "The configuration that specifies how the deployment traffic is routed." - }, - "ZonalConfig": { - "$ref": "#/definitions/ZonalConfig", - "description": "The zonal deployment config that specifies how the zonal deployment behaves" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codedeploy", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::CodeDeploy::DeploymentConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeploymentConfigName", + "/properties/MinimumHealthyHosts", + "/properties/ComputePlatform", + "/properties/ZonalConfig", + "/properties/TrafficRoutingConfig" + ], + "definitions": { + "MinimumHealthyHosts": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "MinimumHealthyHostsPerZone": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "TimeBasedCanary": { + "additionalProperties": false, + "properties": { + "CanaryInterval": { + "type": "integer" + }, + "CanaryPercentage": { + "type": "integer" + } + }, + "required": [ + "CanaryPercentage", + "CanaryInterval" + ], + "type": "object" + }, + "TimeBasedLinear": { + "additionalProperties": false, + "properties": { + "LinearInterval": { + "type": "integer" + }, + "LinearPercentage": { + "type": "integer" + } + }, + "required": [ + "LinearInterval", + "LinearPercentage" + ], + "type": "object" + }, + "TrafficRoutingConfig": { + "additionalProperties": false, + "properties": { + "TimeBasedCanary": { + "$ref": "#/definitions/TimeBasedCanary" + }, + "TimeBasedLinear": { + "$ref": "#/definitions/TimeBasedLinear" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ZonalConfig": { + "additionalProperties": false, + "properties": { + "FirstZoneMonitorDurationInSeconds": { + "format": "int64", + "type": "integer" + }, + "MinimumHealthyHostsPerZone": { + "$ref": "#/definitions/MinimumHealthyHostsPerZone" + }, + "MonitorDurationInSeconds": { + "format": "int64", + "type": "integer" + } + }, + "required": [], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeDeploy::DeploymentConfig", + "handlers": { + "create": { + "permissions": [ + "codedeploy:CreateDeploymentConfig" + ] + }, + "delete": { + "permissions": [ + "codedeploy:GetDeploymentConfig", + "codedeploy:DeleteDeploymentConfig" + ] + }, + "list": { + "permissions": [ + "codedeploy:ListDeploymentConfigs" + ] + }, + "read": { + "permissions": [ + "codedeploy:GetDeploymentConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeploymentConfigName" + ], + "properties": { + "ComputePlatform": { + "description": "The destination platform type for the deployment (Lambda, Server, or ECS).", + "type": "string" + }, + "DeploymentConfigName": { + "description": "A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.", + "type": "string" + }, + "MinimumHealthyHosts": { + "$ref": "#/definitions/MinimumHealthyHosts", + "description": "The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value." + }, + "TrafficRoutingConfig": { + "$ref": "#/definitions/TrafficRoutingConfig", + "description": "The configuration that specifies how the deployment traffic is routed." + }, + "ZonalConfig": { + "$ref": "#/definitions/ZonalConfig", + "description": "The zonal deployment config that specifies how the zonal deployment behaves" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codedeploy", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::CodeDeploy::DeploymentConfig" +} diff --git a/schema/aws-codedeploy-deploymentgroup.json b/schema/aws-codedeploy-deploymentgroup.json index 199d226..53ed415 100644 --- a/schema/aws-codedeploy-deploymentgroup.json +++ b/schema/aws-codedeploy-deploymentgroup.json @@ -1,498 +1,498 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeploymentGroupName", - "/properties/ApplicationName" - ], - "definitions": { - "Alarm": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AlarmConfiguration": { - "additionalProperties": false, - "properties": { - "Alarms": { - "items": { - "$ref": "#/definitions/Alarm" - }, - "type": "array", - "uniqueItems": true - }, - "Enabled": { - "type": "boolean" - }, - "IgnorePollAlarmFailure": { - "type": "boolean" - } - }, - "type": "object" - }, - "AutoRollbackConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Events": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "BlueGreenDeploymentConfiguration": { - "additionalProperties": false, - "properties": { - "DeploymentReadyOption": { - "$ref": "#/definitions/DeploymentReadyOption" - }, - "GreenFleetProvisioningOption": { - "$ref": "#/definitions/GreenFleetProvisioningOption" - }, - "TerminateBlueInstancesOnDeploymentSuccess": { - "$ref": "#/definitions/BlueInstanceTerminationOption" - } - }, - "type": "object" - }, - "BlueInstanceTerminationOption": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "TerminationWaitTimeInMinutes": { - "type": "integer" - } - }, - "type": "object" - }, - "Deployment": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "IgnoreApplicationStopFailures": { - "type": "boolean" - }, - "Revision": { - "$ref": "#/definitions/RevisionLocation" - } - }, - "required": [ - "Revision" - ], - "type": "object" - }, - "DeploymentReadyOption": { - "additionalProperties": false, - "properties": { - "ActionOnTimeout": { - "type": "string" - }, - "WaitTimeInMinutes": { - "type": "integer" - } - }, - "type": "object" - }, - "DeploymentStyle": { - "additionalProperties": false, - "properties": { - "DeploymentOption": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - } - }, - "type": "object" - }, - "EC2TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "EC2TagSet": { - "additionalProperties": false, - "properties": { - "Ec2TagSetList": { - "items": { - "$ref": "#/definitions/EC2TagSetListObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "EC2TagSetListObject": { - "additionalProperties": false, - "properties": { - "Ec2TagGroup": { - "items": { - "$ref": "#/definitions/EC2TagFilter" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ECSService": { - "additionalProperties": false, - "properties": { - "ClusterName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - } - }, - "required": [ - "ServiceName", - "ClusterName" - ], - "type": "object" - }, - "ELBInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "GitHubLocation": { - "additionalProperties": false, - "properties": { - "CommitId": { - "type": "string" - }, - "Repository": { - "type": "string" - } - }, - "required": [ - "Repository", - "CommitId" - ], - "type": "object" - }, - "GreenFleetProvisioningOption": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - } - }, - "type": "object" - }, - "LoadBalancerInfo": { - "additionalProperties": false, - "properties": { - "ElbInfoList": { - "items": { - "$ref": "#/definitions/ELBInfo" - }, - "type": "array", - "uniqueItems": true - }, - "TargetGroupInfoList": { - "items": { - "$ref": "#/definitions/TargetGroupInfo" - }, - "type": "array", - "uniqueItems": true - }, - "TargetGroupPairInfoList": { - "items": { - "$ref": "#/definitions/TargetGroupPairInfo" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "OnPremisesTagSet": { - "additionalProperties": false, - "properties": { - "OnPremisesTagSetList": { - "items": { - "$ref": "#/definitions/OnPremisesTagSetListObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "OnPremisesTagSetListObject": { - "additionalProperties": false, - "properties": { - "OnPremisesTagGroup": { - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "RevisionLocation": { - "additionalProperties": false, - "properties": { - "GitHubLocation": { - "$ref": "#/definitions/GitHubLocation" - }, - "RevisionType": { - "type": "string" - }, - "S3Location": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "BundleType": { - "type": "string" - }, - "ETag": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "TargetGroupInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "TargetGroupPairInfo": { - "additionalProperties": false, - "properties": { - "ProdTrafficRoute": { - "$ref": "#/definitions/TrafficRoute" - }, - "TargetGroups": { - "items": { - "$ref": "#/definitions/TargetGroupInfo" - }, - "type": "array", - "uniqueItems": true - }, - "TestTrafficRoute": { - "$ref": "#/definitions/TrafficRoute" - } - }, - "type": "object" - }, - "TrafficRoute": { - "additionalProperties": false, - "properties": { - "ListenerArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "TriggerConfig": { - "additionalProperties": false, - "properties": { - "TriggerEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "TriggerName": { - "type": "string" - }, - "TriggerTargetArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeDeploy::DeploymentGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AlarmConfiguration": { - "$ref": "#/definitions/AlarmConfiguration" - }, - "ApplicationName": { - "type": "string" - }, - "AutoRollbackConfiguration": { - "$ref": "#/definitions/AutoRollbackConfiguration" - }, - "AutoScalingGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "BlueGreenDeploymentConfiguration": { - "$ref": "#/definitions/BlueGreenDeploymentConfiguration" - }, - "Deployment": { - "$ref": "#/definitions/Deployment" - }, - "DeploymentConfigName": { - "type": "string" - }, - "DeploymentGroupName": { - "type": "string" - }, - "DeploymentStyle": { - "$ref": "#/definitions/DeploymentStyle" - }, - "ECSServices": { - "items": { - "$ref": "#/definitions/ECSService" - }, - "type": "array", - "uniqueItems": true - }, - "Ec2TagFilters": { - "items": { - "$ref": "#/definitions/EC2TagFilter" - }, - "type": "array", - "uniqueItems": true - }, - "Ec2TagSet": { - "$ref": "#/definitions/EC2TagSet" - }, - "Id": { - "type": "string" - }, - "LoadBalancerInfo": { - "$ref": "#/definitions/LoadBalancerInfo" - }, - "OnPremisesInstanceTagFilters": { - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - }, - "OnPremisesTagSet": { - "$ref": "#/definitions/OnPremisesTagSet" - }, - "OutdatedInstancesStrategy": { - "type": "string" - }, - "ServiceRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TerminationHookEnabled": { - "type": "boolean" - }, - "TriggerConfigurations": { - "items": { - "$ref": "#/definitions/TriggerConfig" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationName", - "ServiceRoleArn" - ], - "typeName": "AWS::CodeDeploy::DeploymentGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeploymentGroupName", + "/properties/ApplicationName" + ], + "definitions": { + "Alarm": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "AlarmConfiguration": { + "additionalProperties": false, + "properties": { + "Alarms": { + "items": { + "$ref": "#/definitions/Alarm" + }, + "type": "array", + "uniqueItems": true + }, + "Enabled": { + "type": "boolean" + }, + "IgnorePollAlarmFailure": { + "type": "boolean" + } + }, + "type": "object" + }, + "AutoRollbackConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "Events": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "BlueGreenDeploymentConfiguration": { + "additionalProperties": false, + "properties": { + "DeploymentReadyOption": { + "$ref": "#/definitions/DeploymentReadyOption" + }, + "GreenFleetProvisioningOption": { + "$ref": "#/definitions/GreenFleetProvisioningOption" + }, + "TerminateBlueInstancesOnDeploymentSuccess": { + "$ref": "#/definitions/BlueInstanceTerminationOption" + } + }, + "type": "object" + }, + "BlueInstanceTerminationOption": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "TerminationWaitTimeInMinutes": { + "type": "integer" + } + }, + "type": "object" + }, + "Deployment": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "IgnoreApplicationStopFailures": { + "type": "boolean" + }, + "Revision": { + "$ref": "#/definitions/RevisionLocation" + } + }, + "required": [ + "Revision" + ], + "type": "object" + }, + "DeploymentReadyOption": { + "additionalProperties": false, + "properties": { + "ActionOnTimeout": { + "type": "string" + }, + "WaitTimeInMinutes": { + "type": "integer" + } + }, + "type": "object" + }, + "DeploymentStyle": { + "additionalProperties": false, + "properties": { + "DeploymentOption": { + "type": "string" + }, + "DeploymentType": { + "type": "string" + } + }, + "type": "object" + }, + "EC2TagFilter": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "EC2TagSet": { + "additionalProperties": false, + "properties": { + "Ec2TagSetList": { + "items": { + "$ref": "#/definitions/EC2TagSetListObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EC2TagSetListObject": { + "additionalProperties": false, + "properties": { + "Ec2TagGroup": { + "items": { + "$ref": "#/definitions/EC2TagFilter" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ECSService": { + "additionalProperties": false, + "properties": { + "ClusterName": { + "type": "string" + }, + "ServiceName": { + "type": "string" + } + }, + "required": [ + "ServiceName", + "ClusterName" + ], + "type": "object" + }, + "ELBInfo": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "GitHubLocation": { + "additionalProperties": false, + "properties": { + "CommitId": { + "type": "string" + }, + "Repository": { + "type": "string" + } + }, + "required": [ + "Repository", + "CommitId" + ], + "type": "object" + }, + "GreenFleetProvisioningOption": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + } + }, + "type": "object" + }, + "LoadBalancerInfo": { + "additionalProperties": false, + "properties": { + "ElbInfoList": { + "items": { + "$ref": "#/definitions/ELBInfo" + }, + "type": "array", + "uniqueItems": true + }, + "TargetGroupInfoList": { + "items": { + "$ref": "#/definitions/TargetGroupInfo" + }, + "type": "array", + "uniqueItems": true + }, + "TargetGroupPairInfoList": { + "items": { + "$ref": "#/definitions/TargetGroupPairInfo" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "OnPremisesTagSet": { + "additionalProperties": false, + "properties": { + "OnPremisesTagSetList": { + "items": { + "$ref": "#/definitions/OnPremisesTagSetListObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "OnPremisesTagSetListObject": { + "additionalProperties": false, + "properties": { + "OnPremisesTagGroup": { + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "RevisionLocation": { + "additionalProperties": false, + "properties": { + "GitHubLocation": { + "$ref": "#/definitions/GitHubLocation" + }, + "RevisionType": { + "type": "string" + }, + "S3Location": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "BundleType": { + "type": "string" + }, + "ETag": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagFilter": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "TargetGroupInfo": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "TargetGroupPairInfo": { + "additionalProperties": false, + "properties": { + "ProdTrafficRoute": { + "$ref": "#/definitions/TrafficRoute" + }, + "TargetGroups": { + "items": { + "$ref": "#/definitions/TargetGroupInfo" + }, + "type": "array", + "uniqueItems": true + }, + "TestTrafficRoute": { + "$ref": "#/definitions/TrafficRoute" + } + }, + "type": "object" + }, + "TrafficRoute": { + "additionalProperties": false, + "properties": { + "ListenerArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TriggerConfig": { + "additionalProperties": false, + "properties": { + "TriggerEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "TriggerName": { + "type": "string" + }, + "TriggerTargetArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeDeploy::DeploymentGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AlarmConfiguration": { + "$ref": "#/definitions/AlarmConfiguration" + }, + "ApplicationName": { + "type": "string" + }, + "AutoRollbackConfiguration": { + "$ref": "#/definitions/AutoRollbackConfiguration" + }, + "AutoScalingGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "BlueGreenDeploymentConfiguration": { + "$ref": "#/definitions/BlueGreenDeploymentConfiguration" + }, + "Deployment": { + "$ref": "#/definitions/Deployment" + }, + "DeploymentConfigName": { + "type": "string" + }, + "DeploymentGroupName": { + "type": "string" + }, + "DeploymentStyle": { + "$ref": "#/definitions/DeploymentStyle" + }, + "ECSServices": { + "items": { + "$ref": "#/definitions/ECSService" + }, + "type": "array", + "uniqueItems": true + }, + "Ec2TagFilters": { + "items": { + "$ref": "#/definitions/EC2TagFilter" + }, + "type": "array", + "uniqueItems": true + }, + "Ec2TagSet": { + "$ref": "#/definitions/EC2TagSet" + }, + "Id": { + "type": "string" + }, + "LoadBalancerInfo": { + "$ref": "#/definitions/LoadBalancerInfo" + }, + "OnPremisesInstanceTagFilters": { + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + }, + "OnPremisesTagSet": { + "$ref": "#/definitions/OnPremisesTagSet" + }, + "OutdatedInstancesStrategy": { + "type": "string" + }, + "ServiceRoleArn": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TerminationHookEnabled": { + "type": "boolean" + }, + "TriggerConfigurations": { + "items": { + "$ref": "#/definitions/TriggerConfig" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationName", + "ServiceRoleArn" + ], + "typeName": "AWS::CodeDeploy::DeploymentGroup" +} diff --git a/schema/aws-codeguruprofiler-profilinggroup.json b/schema/aws-codeguruprofiler-profilinggroup.json index c570b0f..928b4ab 100644 --- a/schema/aws-codeguruprofiler-profilinggroup.json +++ b/schema/aws-codeguruprofiler-profilinggroup.json @@ -1,176 +1,178 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProfilingGroupName", - "/properties/ComputePlatform" - ], - "definitions": { - "Channel": { - "description": "Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.", - "properties": { - "channelId": { - "$ref": "#/definitions/ChannelId" - }, - "channelUri": { - "$ref": "#/definitions/ChannelUri" - } - }, - "required": [ - "channelUri" - ], - "type": "object" - }, - "ChannelId": { - "description": "Unique identifier for each Channel in the notification configuration of a Profiling Group", - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", - "type": "string" - }, - "ChannelUri": { - "description": "Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.", - "pattern": "^arn:aws([-\\w]*):[a-z-]+:(([a-z]+-)+[0-9]+)?:([0-9]{12}):[^.]+$", - "type": "string" - }, - "IamArn": { - "pattern": "^arn:aws([-\\w]*):iam::([0-9]{12}):[\\S]+$", - "type": "string" - }, - "ProfilingGroupArn": { - "pattern": "^arn:aws([-\\w]*):codeguru-profiler:(([a-z]+-)+[0-9]+):([0-9]{12}):profilingGroup/[^.]+$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "This resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.", - "handlers": { - "create": { - "permissions": [ - "sns:Publish", - "codeguru-profiler:AddNotificationChannels", - "codeguru-profiler:CreateProfilingGroup", - "codeguru-profiler:PutPermission", - "codeguru-profiler:TagResource" - ] - }, - "delete": { - "permissions": [ - "codeguru-profiler:DeleteProfilingGroup" - ] - }, - "list": { - "permissions": [ - "codeguru-profiler:ListProfilingGroups", - "codeguru-profiler:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "codeguru-profiler:DescribeProfilingGroup", - "codeguru-profiler:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "sns:Publish", - "codeguru-profiler:AddNotificationChannels", - "codeguru-profiler:GetNotificationConfiguration", - "codeguru-profiler:RemoveNotificationChannel", - "codeguru-profiler:PutPermission", - "codeguru-profiler:RemovePermission", - "codeguru-profiler:GetPolicy", - "codeguru-profiler:TagResource", - "codeguru-profiler:UntagResource", - "codeguru-profiler:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProfilingGroupName" - ], - "properties": { - "AgentPermissions": { - "additionalProperties": false, - "description": "The agent permissions attached to this profiling group.", - "properties": { - "Principals": { - "description": "The principals for the agent permissions.", - "items": { - "$ref": "#/definitions/IamArn" - }, - "type": "array" - } - }, - "required": [ - "Principals" - ], - "type": "object" - }, - "AnomalyDetectionNotificationConfiguration": { - "description": "Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency", - "items": { - "$ref": "#/definitions/Channel" - }, - "type": "array" - }, - "Arn": { - "$ref": "#/definitions/ProfilingGroupArn", - "description": "The Amazon Resource Name (ARN) of the specified profiling group.", - "examples": [ - "arn:aws:codeguru-profiler:us-east-1:000000000000:profilingGroup/My-example-profiling-group" - ] - }, - "ComputePlatform": { - "description": "The compute platform of the profiling group.", - "enum": [ - "Default", - "AWSLambda" - ], - "type": "string" - }, - "ProfilingGroupName": { - "description": "The name of the profiling group.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[\\w-]+$", - "type": "string" - }, - "Tags": { - "description": "The tags associated with a profiling group.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ProfilingGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeguru-profiler", - "typeName": "AWS::CodeGuruProfiler::ProfilingGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfilingGroupName", + "/properties/ComputePlatform" + ], + "definitions": { + "Channel": { + "description": "Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.", + "properties": { + "channelId": { + "$ref": "#/definitions/ChannelId" + }, + "channelUri": { + "$ref": "#/definitions/ChannelUri" + } + }, + "required": [ + "channelUri" + ], + "type": "object" + }, + "ChannelId": { + "description": "Unique identifier for each Channel in the notification configuration of a Profiling Group", + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", + "type": "string" + }, + "ChannelUri": { + "description": "Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.", + "pattern": "^arn:aws([-\\w]*):[a-z-]+:(([a-z]+-)+[0-9]+)?:([0-9]{12}):[^.]+$", + "type": "string" + }, + "IamArn": { + "pattern": "^arn:aws([-\\w]*):iam::([0-9]{12}):[\\S]+$", + "type": "string" + }, + "ProfilingGroupArn": { + "pattern": "^arn:aws([-\\w]*):codeguru-profiler:(([a-z]+-)+[0-9]+):([0-9]{12}):profilingGroup/[^.]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "This resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.", + "handlers": { + "create": { + "permissions": [ + "sns:Publish", + "codeguru-profiler:AddNotificationChannels", + "codeguru-profiler:CreateProfilingGroup", + "codeguru-profiler:PutPermission", + "codeguru-profiler:TagResource" + ] + }, + "delete": { + "permissions": [ + "codeguru-profiler:DeleteProfilingGroup" + ] + }, + "list": { + "permissions": [ + "codeguru-profiler:ListProfilingGroups", + "codeguru-profiler:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "codeguru-profiler:DescribeProfilingGroup", + "codeguru-profiler:ListTagsForResource", + "codeguru-profiler:GetNotificationConfiguration", + "codeguru-profiler:GetPolicy" + ] + }, + "update": { + "permissions": [ + "sns:Publish", + "codeguru-profiler:AddNotificationChannels", + "codeguru-profiler:GetNotificationConfiguration", + "codeguru-profiler:RemoveNotificationChannel", + "codeguru-profiler:PutPermission", + "codeguru-profiler:RemovePermission", + "codeguru-profiler:GetPolicy", + "codeguru-profiler:TagResource", + "codeguru-profiler:UntagResource", + "codeguru-profiler:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProfilingGroupName" + ], + "properties": { + "AgentPermissions": { + "additionalProperties": false, + "description": "The agent permissions attached to this profiling group.", + "properties": { + "Principals": { + "description": "The principals for the agent permissions.", + "items": { + "$ref": "#/definitions/IamArn" + }, + "type": "array" + } + }, + "required": [ + "Principals" + ], + "type": "object" + }, + "AnomalyDetectionNotificationConfiguration": { + "description": "Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency", + "items": { + "$ref": "#/definitions/Channel" + }, + "type": "array" + }, + "Arn": { + "$ref": "#/definitions/ProfilingGroupArn", + "description": "The Amazon Resource Name (ARN) of the specified profiling group.", + "examples": [ + "arn:aws:codeguru-profiler:us-east-1:000000000000:profilingGroup/My-example-profiling-group" + ] + }, + "ComputePlatform": { + "description": "The compute platform of the profiling group.", + "enum": [ + "Default", + "AWSLambda" + ], + "type": "string" + }, + "ProfilingGroupName": { + "description": "The name of the profiling group.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[\\w-]+$", + "type": "string" + }, + "Tags": { + "description": "The tags associated with a profiling group.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ProfilingGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeguru-profiler", + "typeName": "AWS::CodeGuruProfiler::ProfilingGroup" +} diff --git a/schema/aws-codegurureviewer-repositoryassociation.json b/schema/aws-codegurureviewer-repositoryassociation.json index 073f453..1a65d89 100644 --- a/schema/aws-codegurureviewer-repositoryassociation.json +++ b/schema/aws-codegurureviewer-repositoryassociation.json @@ -1,149 +1,149 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type", - "/properties/Tags", - "/properties/BucketName", - "/properties/Owner", - "/properties/ConnectionArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "This resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.", - "handlers": { - "create": { - "permissions": [ - "codeguru-reviewer:DescribeRepositoryAssociation", - "codeguru-reviewer:AssociateRepository", - "codeguru-reviewer:TagResource", - "iam:CreateServiceLinkedRole", - "codecommit:TagResource", - "codecommit:GitPull", - "codecommit:TagResource", - "events:PutRule", - "events:PutTargets", - "codestar-connections:ListBranches", - "codestar-connections:ListRepositories", - "codestar-connections:ListTagsForResource", - "codestar-connections:PassConnection", - "codestar-connections:TagResource", - "codestar-connections:UseConnection", - "s3:ListBucket" - ] - }, - "delete": { - "permissions": [ - "codeguru-reviewer:DescribeRepositoryAssociation", - "codeguru-reviewer:DisassociateRepository", - "codecommit:UntagResource", - "events:DeleteRule", - "events:RemoveTargets", - "codestar-connections:UntagResource", - "codestar-connections:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "codeguru-reviewer:ListRepositoryAssociations" - ] - }, - "read": { - "permissions": [ - "codeguru-reviewer:DescribeRepositoryAssociation", - "codeguru-reviewer:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationArn" - ], - "properties": { - "AssociationArn": { - "description": "The Amazon Resource Name (ARN) of the repository association.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "BucketName": { - "description": "The name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.", - "maxLength": 63, - "minLength": 3, - "pattern": "^\\S(.*\\S)?$", - "type": "string" - }, - "ConnectionArn": { - "description": "The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "Name": { - "description": "Name of the repository to be associated.", - "maxLength": 100, - "minLength": 1, - "pattern": "^\\S[\\w.-]*$", - "type": "string" - }, - "Owner": { - "description": "The owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.", - "maxLength": 100, - "minLength": 1, - "pattern": "^\\S(.*\\S)?$", - "type": "string" - }, - "Tags": { - "description": "The tags associated with a repository association.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of repository to be associated.", - "enum": [ - "CodeCommit", - "Bitbucket", - "GitHubEnterpriseServer", - "S3Bucket" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociationArn" - ], - "required": [ - "Name", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codegurureviewer", - "typeName": "AWS::CodeGuruReviewer::RepositoryAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type", + "/properties/Tags", + "/properties/BucketName", + "/properties/Owner", + "/properties/ConnectionArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "This resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.", + "handlers": { + "create": { + "permissions": [ + "codeguru-reviewer:DescribeRepositoryAssociation", + "codeguru-reviewer:AssociateRepository", + "codeguru-reviewer:TagResource", + "iam:CreateServiceLinkedRole", + "codecommit:TagResource", + "codecommit:GitPull", + "codecommit:TagResource", + "events:PutRule", + "events:PutTargets", + "codestar-connections:ListBranches", + "codestar-connections:ListRepositories", + "codestar-connections:ListTagsForResource", + "codestar-connections:PassConnection", + "codestar-connections:TagResource", + "codestar-connections:UseConnection", + "s3:ListBucket" + ] + }, + "delete": { + "permissions": [ + "codeguru-reviewer:DescribeRepositoryAssociation", + "codeguru-reviewer:DisassociateRepository", + "codecommit:UntagResource", + "events:DeleteRule", + "events:RemoveTargets", + "codestar-connections:UntagResource", + "codestar-connections:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "codeguru-reviewer:ListRepositoryAssociations" + ] + }, + "read": { + "permissions": [ + "codeguru-reviewer:DescribeRepositoryAssociation", + "codeguru-reviewer:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationArn" + ], + "properties": { + "AssociationArn": { + "description": "The Amazon Resource Name (ARN) of the repository association.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "BucketName": { + "description": "The name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.", + "maxLength": 63, + "minLength": 3, + "pattern": "^\\S(.*\\S)?$", + "type": "string" + }, + "ConnectionArn": { + "description": "The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "Name": { + "description": "Name of the repository to be associated.", + "maxLength": 100, + "minLength": 1, + "pattern": "^\\S[\\w.-]*$", + "type": "string" + }, + "Owner": { + "description": "The owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.", + "maxLength": 100, + "minLength": 1, + "pattern": "^\\S(.*\\S)?$", + "type": "string" + }, + "Tags": { + "description": "The tags associated with a repository association.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of repository to be associated.", + "enum": [ + "CodeCommit", + "Bitbucket", + "GitHubEnterpriseServer", + "S3Bucket" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationArn" + ], + "required": [ + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codegurureviewer", + "typeName": "AWS::CodeGuruReviewer::RepositoryAssociation" +} diff --git a/schema/aws-codepipeline-customactiontype.json b/schema/aws-codepipeline-customactiontype.json index ce862b7..778e7ef 100644 --- a/schema/aws-codepipeline-customactiontype.json +++ b/schema/aws-codepipeline-customactiontype.json @@ -1,221 +1,221 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Category", - "/properties/ConfigurationProperties", - "/properties/InputArtifactDetails", - "/properties/OutputArtifactDetails", - "/properties/Provider", - "/properties/Settings", - "/properties/Version" - ], - "definitions": { - "ArtifactDetails": { - "additionalProperties": false, - "description": "Returns information about the details of an artifact.", - "properties": { - "MaximumCount": { - "description": "The maximum number of artifacts allowed for the action type.", - "type": "integer" - }, - "MinimumCount": { - "description": "The minimum number of artifacts allowed for the action type.", - "type": "integer" - } - }, - "required": [ - "MaximumCount", - "MinimumCount" - ], - "type": "object" - }, - "ConfigurationProperties": { - "additionalProperties": false, - "description": "The configuration properties for the custom action.", - "properties": { - "Description": { - "description": "The description of the action configuration property that is displayed to users. ", - "type": "string" - }, - "Key": { - "description": "Whether the configuration property is a key.", - "type": "boolean" - }, - "Name": { - "description": "The name of the action configuration property.", - "type": "string" - }, - "Queryable": { - "description": "Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. ", - "type": "boolean" - }, - "Required": { - "description": "Whether the configuration property is a required value.", - "type": "boolean" - }, - "Secret": { - "description": "Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.", - "type": "boolean" - }, - "Type": { - "description": "The type of the configuration property.", - "type": "string" - } - }, - "required": [ - "Key", - "Name", - "Required", - "Secret" - ], - "type": "object" - }, - "Settings": { - "additionalProperties": false, - "description": "Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action. ", - "properties": { - "EntityUrlTemplate": { - "description": "The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. ", - "type": "string" - }, - "ExecutionUrlTemplate": { - "description": "The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. ", - "type": "string" - }, - "RevisionUrlTemplate": { - "description": "The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. ", - "type": "string" - }, - "ThirdPartyConfigurationUrl": { - "description": "The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.", - "handlers": { - "create": { - "permissions": [ - "codepipeline:CreateCustomActionType", - "codepipeline:TagResource", - "codepipeline:ListActionTypes" - ] - }, - "delete": { - "permissions": [ - "codepipeline:DeleteCustomActionType", - "codepipeline:ListActionTypes" - ] - }, - "list": { - "permissions": [ - "codepipeline:ListActionTypes" - ] - }, - "read": { - "permissions": [ - "codepipeline:ListActionTypes", - "codepipeline:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codepipeline:ListActionTypes", - "codepipeline:TagResource", - "codepipeline:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Category", - "/properties/Provider", - "/properties/Version" - ], - "properties": { - "Category": { - "description": "The category of the custom action, such as a build action or a test action.", - "type": "string" - }, - "ConfigurationProperties": { - "description": "The configuration properties for the custom action.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigurationProperties" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "type": "string" - }, - "InputArtifactDetails": { - "$ref": "#/definitions/ArtifactDetails", - "description": "The details of the input artifact for the action, such as its commit ID." - }, - "OutputArtifactDetails": { - "$ref": "#/definitions/ArtifactDetails", - "description": "The details of the output artifact of the action, such as its commit ID." - }, - "Provider": { - "description": "The provider of the service used in the custom action, such as AWS CodeDeploy.", - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/Settings", - "description": "URLs that provide users information about this custom action." - }, - "Tags": { - "description": "Any tags assigned to the custom action.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Version": { - "description": "The version identifier of the custom action.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Category", - "InputArtifactDetails", - "OutputArtifactDetails", - "Provider", - "Version" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodePipeline::CustomActionType", - "writeOnlyProperties": [ - "/properties/ConfigurationProperties/*/Type" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Category", + "/properties/ConfigurationProperties", + "/properties/InputArtifactDetails", + "/properties/OutputArtifactDetails", + "/properties/Provider", + "/properties/Settings", + "/properties/Version" + ], + "definitions": { + "ArtifactDetails": { + "additionalProperties": false, + "description": "Returns information about the details of an artifact.", + "properties": { + "MaximumCount": { + "description": "The maximum number of artifacts allowed for the action type.", + "type": "integer" + }, + "MinimumCount": { + "description": "The minimum number of artifacts allowed for the action type.", + "type": "integer" + } + }, + "required": [ + "MaximumCount", + "MinimumCount" + ], + "type": "object" + }, + "ConfigurationProperties": { + "additionalProperties": false, + "description": "The configuration properties for the custom action.", + "properties": { + "Description": { + "description": "The description of the action configuration property that is displayed to users. ", + "type": "string" + }, + "Key": { + "description": "Whether the configuration property is a key.", + "type": "boolean" + }, + "Name": { + "description": "The name of the action configuration property.", + "type": "string" + }, + "Queryable": { + "description": "Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. ", + "type": "boolean" + }, + "Required": { + "description": "Whether the configuration property is a required value.", + "type": "boolean" + }, + "Secret": { + "description": "Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.", + "type": "boolean" + }, + "Type": { + "description": "The type of the configuration property.", + "type": "string" + } + }, + "required": [ + "Key", + "Name", + "Required", + "Secret" + ], + "type": "object" + }, + "Settings": { + "additionalProperties": false, + "description": "Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action. ", + "properties": { + "EntityUrlTemplate": { + "description": "The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. ", + "type": "string" + }, + "ExecutionUrlTemplate": { + "description": "The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. ", + "type": "string" + }, + "RevisionUrlTemplate": { + "description": "The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. ", + "type": "string" + }, + "ThirdPartyConfigurationUrl": { + "description": "The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.", + "handlers": { + "create": { + "permissions": [ + "codepipeline:CreateCustomActionType", + "codepipeline:TagResource", + "codepipeline:ListActionTypes" + ] + }, + "delete": { + "permissions": [ + "codepipeline:DeleteCustomActionType", + "codepipeline:ListActionTypes" + ] + }, + "list": { + "permissions": [ + "codepipeline:ListActionTypes" + ] + }, + "read": { + "permissions": [ + "codepipeline:ListActionTypes", + "codepipeline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codepipeline:ListActionTypes", + "codepipeline:TagResource", + "codepipeline:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Category", + "/properties/Provider", + "/properties/Version" + ], + "properties": { + "Category": { + "description": "The category of the custom action, such as a build action or a test action.", + "type": "string" + }, + "ConfigurationProperties": { + "description": "The configuration properties for the custom action.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigurationProperties" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "type": "string" + }, + "InputArtifactDetails": { + "$ref": "#/definitions/ArtifactDetails", + "description": "The details of the input artifact for the action, such as its commit ID." + }, + "OutputArtifactDetails": { + "$ref": "#/definitions/ArtifactDetails", + "description": "The details of the output artifact of the action, such as its commit ID." + }, + "Provider": { + "description": "The provider of the service used in the custom action, such as AWS CodeDeploy.", + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/Settings", + "description": "URLs that provide users information about this custom action." + }, + "Tags": { + "description": "Any tags assigned to the custom action.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Version": { + "description": "The version identifier of the custom action.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Category", + "InputArtifactDetails", + "OutputArtifactDetails", + "Provider", + "Version" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodePipeline::CustomActionType", + "writeOnlyProperties": [ + "/properties/ConfigurationProperties/*/Type" + ] +} diff --git a/schema/aws-codepipeline-pipeline.json b/schema/aws-codepipeline-pipeline.json index 43daccb..2254f2f 100644 --- a/schema/aws-codepipeline-pipeline.json +++ b/schema/aws-codepipeline-pipeline.json @@ -1,637 +1,761 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ActionDeclaration": { - "additionalProperties": false, - "description": "Represents information about an action declaration.", - "properties": { - "ActionTypeId": { - "$ref": "#/definitions/ActionTypeId" - }, - "Configuration": { - "description": "The action's configuration. These are key-value pairs that specify input values for an action.", - "type": "object" - }, - "InputArtifacts": { - "items": { - "$ref": "#/definitions/InputArtifact" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "The action declaration's name.", - "type": "string" - }, - "Namespace": { - "description": "The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.", - "type": "string" - }, - "OutputArtifacts": { - "items": { - "$ref": "#/definitions/OutputArtifact" - }, - "type": "array", - "uniqueItems": true - }, - "Region": { - "description": "The action declaration's AWS Region, such as us-east-1.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.", - "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", - "type": "string" - }, - "RunOrder": { - "description": "The order in which actions are run.", - "type": "integer" - }, - "TimeoutInMinutes": { - "description": "A timeout duration in minutes that can be applied against the ActionType\u2019s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType.", - "type": "integer" - } - }, - "required": [ - "ActionTypeId", - "Name" - ], - "type": "object" - }, - "ActionTypeId": { - "additionalProperties": false, - "description": "Represents information about an action type.", - "properties": { - "Category": { - "description": "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.", - "enum": [ - "Source", - "Build", - "Test", - "Deploy", - "Invoke", - "Approval" - ], - "type": "string" - }, - "Owner": { - "description": "The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom.", - "type": "string" - }, - "Provider": { - "description": "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy.", - "type": "string" - }, - "Version": { - "description": "A string that describes the action version.", - "type": "string" - } - }, - "required": [ - "Owner", - "Category", - "Version", - "Provider" - ], - "type": "object" - }, - "ArtifactStore": { - "additionalProperties": false, - "description": "The S3 bucket where artifacts for the pipeline are stored.", - "properties": { - "EncryptionKey": { - "$ref": "#/definitions/EncryptionKey" - }, - "Location": { - "description": "The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.", - "type": "string" - }, - "Type": { - "description": "The type of the artifact store, such as S3.", - "enum": [ - "S3" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Location" - ], - "type": "object" - }, - "ArtifactStoreMap": { - "additionalProperties": false, - "description": "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.", - "properties": { - "ArtifactStore": { - "$ref": "#/definitions/ArtifactStore" - }, - "Region": { - "description": "The action declaration's AWS Region, such as us-east-1.", - "type": "string" - } - }, - "required": [ - "ArtifactStore", - "Region" - ], - "type": "object" - }, - "BlockerDeclaration": { - "additionalProperties": false, - "description": "Reserved for future use.", - "properties": { - "Name": { - "description": "Reserved for future use.", - "type": "string" - }, - "Type": { - "description": "Reserved for future use.", - "enum": [ - "Schedule" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Name" - ], - "type": "object" - }, - "EncryptionKey": { - "additionalProperties": false, - "description": "Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key", - "properties": { - "Id": { - "description": "The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.", - "type": "string" - }, - "Type": { - "description": "The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.", - "type": "string" - } - }, - "required": [ - "Type", - "Id" - ], - "type": "object" - }, - "FailureConditions": { - "additionalProperties": false, - "description": "The configuration that specifies the result, such as rollback, to occur upon stage failure", - "properties": { - "Result": { - "description": "The specified result for when the failure conditions are met, such as rolling back the stage", - "enum": [ - "ROLLBACK" - ], - "type": "string" - } - }, - "type": "object" - }, - "GitBranchFilterCriteria": { - "additionalProperties": false, - "description": "The Git repository branches specified as filter criteria to start the pipeline.", - "properties": { - "Excludes": { - "description": "The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Includes": { - "description": "The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "GitConfiguration": { - "additionalProperties": false, - "description": "A type of trigger configuration for Git-based source actions.", - "properties": { - "PullRequest": { - "description": "The field where the repository event that will start the pipeline is specified as pull requests.", - "items": { - "$ref": "#/definitions/GitPullRequestFilter" - }, - "type": "array", - "uniqueItems": true - }, - "Push": { - "description": "The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.", - "items": { - "$ref": "#/definitions/GitPushFilter" - }, - "type": "array", - "uniqueItems": true - }, - "SourceActionName": { - "description": "The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.", - "type": "string" - } - }, - "required": [ - "SourceActionName" - ], - "type": "object" - }, - "GitFilePathFilterCriteria": { - "additionalProperties": false, - "description": "The Git repository file paths specified as filter criteria to start the pipeline.", - "properties": { - "Excludes": { - "description": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Includes": { - "description": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "GitPullRequestFilter": { - "additionalProperties": false, - "description": "The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.", - "properties": { - "Branches": { - "$ref": "#/definitions/GitBranchFilterCriteria" - }, - "Events": { - "description": "The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "FilePaths": { - "$ref": "#/definitions/GitFilePathFilterCriteria" - } - }, - "type": "object" - }, - "GitPushFilter": { - "additionalProperties": false, - "description": "The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.", - "properties": { - "Branches": { - "$ref": "#/definitions/GitBranchFilterCriteria" - }, - "FilePaths": { - "$ref": "#/definitions/GitFilePathFilterCriteria" - }, - "Tags": { - "$ref": "#/definitions/GitTagFilterCriteria" - } - }, - "type": "object" - }, - "GitTagFilterCriteria": { - "additionalProperties": false, - "description": "The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.", - "properties": { - "Excludes": { - "description": "The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Includes": { - "description": "The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "InputArtifact": { - "additionalProperties": false, - "description": "Represents information about an artifact to be worked on, such as a test or build artifact.", - "properties": { - "Name": { - "description": "The name of the artifact to be worked on (for example, \"My App\").", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "OutputArtifact": { - "additionalProperties": false, - "description": "Represents information about the output of an action.", - "properties": { - "Name": { - "description": "The name of the output of an artifact, such as \"My App\".", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "PipelineTriggerDeclaration": { - "additionalProperties": false, - "description": "Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.", - "properties": { - "GitConfiguration": { - "$ref": "#/definitions/GitConfiguration" - }, - "ProviderType": { - "description": "The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.", - "enum": [ - "CodeStarSourceConnection" - ], - "type": "string" - } - }, - "required": [ - "ProviderType" - ], - "type": "object" - }, - "StageDeclaration": { - "additionalProperties": false, - "description": "Represents information about a stage and its definition.", - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/ActionDeclaration" - }, - "type": "array", - "uniqueItems": true - }, - "Blockers": { - "items": { - "$ref": "#/definitions/BlockerDeclaration" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "The name of the stage.", - "type": "string" - }, - "OnFailure": { - "$ref": "#/definitions/FailureConditions", - "description": "The method to use when a stage has not completed successfully", - "type": "object" - } - }, - "required": [ - "Actions", - "Name" - ], - "type": "object" - }, - "StageTransition": { - "additionalProperties": false, - "description": "The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.", - "properties": { - "Reason": { - "description": "The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.", - "type": "string" - }, - "StageName": { - "description": "The name of the stage where you want to disable the inbound or outbound transition of artifacts.", - "type": "string" - } - }, - "required": [ - "StageName", - "Reason" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A tag is a key-value pair that is used to manage the resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VariableDeclaration": { - "additionalProperties": false, - "description": "A variable declared at the pipeline level.", - "properties": { - "DefaultValue": { - "description": "The value of a pipeline-level variable.", - "type": "string" - }, - "Description": { - "description": "The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.", - "type": "string" - }, - "Name": { - "description": "The name of a pipeline-level variable.", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - } - }, - "description": "The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "codepipeline:GetPipeline", - "codepipeline:CreatePipeline", - "codepipeline:DisableStageTransition", - "codepipeline:GetPipelineState", - "codepipeline:TagResource", - "codestar-connections:PassConnection" - ] - }, - "delete": { - "permissions": [ - "codepipeline:GetPipeline", - "codepipeline:DeletePipeline" - ] - }, - "list": { - "permissions": [ - "codepipeline:ListPipelines" - ] - }, - "read": { - "permissions": [ - "codepipeline:GetPipeline", - "codepipeline:ListTagsForResource", - "codepipeline:GetPipelineState" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "codepipeline:EnableStageTransition", - "codepipeline:StartPipelineExecution", - "codepipeline:GetPipeline", - "codepipeline:UpdatePipeline", - "codepipeline:GetPipelineState", - "codepipeline:DisableStageTransition", - "codepipeline:TagResource", - "codepipeline:UntagResource", - "codestar-connections:PassConnection" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "ArtifactStore": { - "$ref": "#/definitions/ArtifactStore", - "description": "The S3 bucket where artifacts for the pipeline are stored." - }, - "ArtifactStores": { - "description": "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.", - "items": { - "$ref": "#/definitions/ArtifactStoreMap" - }, - "type": "array", - "uniqueItems": true - }, - "DisableInboundStageTransitions": { - "description": "Represents the input of a DisableStageTransition action.", - "items": { - "$ref": "#/definitions/StageTransition" - }, - "type": "array", - "uniqueItems": true - }, - "ExecutionMode": { - "default": "SUPERSEDED", - "description": "The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.", - "enum": [ - "QUEUED", - "SUPERSEDED", - "PARALLEL" - ], - "type": "string" - }, - "Name": { - "description": "The name of the pipeline.", - "type": "string" - }, - "PipelineType": { - "description": "CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.", - "enum": [ - "V1", - "V2" - ], - "type": "string" - }, - "RestartExecutionOnUpdate": { - "description": "Indicates whether to rerun the CodePipeline pipeline after you update it.", - "type": "boolean" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn", - "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", - "type": "string" - }, - "Stages": { - "description": "Represents information about a stage and its definition.", - "items": { - "$ref": "#/definitions/StageDeclaration" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "Specifies the tags applied to the pipeline.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Triggers": { - "description": "The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.", - "items": { - "$ref": "#/definitions/PipelineTriggerDeclaration" - }, - "type": "array", - "uniqueItems": true - }, - "Variables": { - "description": "A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\\-_]+.", - "items": { - "$ref": "#/definitions/VariableDeclaration" - }, - "type": "array", - "uniqueItems": true - }, - "Version": { - "description": "The version of the pipeline.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Version" - ], - "required": [ - "Stages", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodePipeline::Pipeline", - "writeOnlyProperties": [ - "/properties/RestartExecutionOnUpdate" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ActionDeclaration": { + "additionalProperties": false, + "description": "Represents information about an action declaration.", + "properties": { + "ActionTypeId": { + "$ref": "#/definitions/ActionTypeId" + }, + "Configuration": { + "description": "The action's configuration. These are key-value pairs that specify input values for an action.", + "type": "object" + }, + "InputArtifacts": { + "items": { + "$ref": "#/definitions/InputArtifact" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "The action declaration's name.", + "type": "string" + }, + "Namespace": { + "description": "The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.", + "type": "string" + }, + "OutputArtifacts": { + "items": { + "$ref": "#/definitions/OutputArtifact" + }, + "type": "array", + "uniqueItems": true + }, + "Region": { + "description": "The action declaration's AWS Region, such as us-east-1.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.", + "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", + "type": "string" + }, + "RunOrder": { + "description": "The order in which actions are run.", + "type": "integer" + }, + "TimeoutInMinutes": { + "description": "A timeout duration in minutes that can be applied against the ActionType\u2019s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType.", + "type": "integer" + } + }, + "required": [ + "ActionTypeId", + "Name" + ], + "type": "object" + }, + "ActionTypeId": { + "additionalProperties": false, + "description": "Represents information about an action type.", + "properties": { + "Category": { + "description": "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.", + "enum": [ + "Source", + "Build", + "Test", + "Deploy", + "Invoke", + "Approval" + ], + "type": "string" + }, + "Owner": { + "description": "The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom.", + "type": "string" + }, + "Provider": { + "description": "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy.", + "type": "string" + }, + "Version": { + "description": "A string that describes the action version.", + "type": "string" + } + }, + "required": [ + "Owner", + "Category", + "Version", + "Provider" + ], + "type": "object" + }, + "ArtifactStore": { + "additionalProperties": false, + "description": "The S3 bucket where artifacts for the pipeline are stored.", + "properties": { + "EncryptionKey": { + "$ref": "#/definitions/EncryptionKey" + }, + "Location": { + "description": "The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.", + "type": "string" + }, + "Type": { + "description": "The type of the artifact store, such as S3.", + "enum": [ + "S3" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Location" + ], + "type": "object" + }, + "ArtifactStoreMap": { + "additionalProperties": false, + "description": "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.", + "properties": { + "ArtifactStore": { + "$ref": "#/definitions/ArtifactStore" + }, + "Region": { + "description": "The action declaration's AWS Region, such as us-east-1.", + "type": "string" + } + }, + "required": [ + "ArtifactStore", + "Region" + ], + "type": "object" + }, + "BeforeEntryConditions": { + "additionalProperties": false, + "description": "The configuration that specifies the rules to run before stage starts.", + "properties": { + "Conditions": { + "items": { + "$ref": "#/definitions/Condition" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "BlockerDeclaration": { + "additionalProperties": false, + "description": "Reserved for future use.", + "properties": { + "Name": { + "description": "Reserved for future use.", + "type": "string" + }, + "Type": { + "description": "Reserved for future use.", + "enum": [ + "Schedule" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Name" + ], + "type": "object" + }, + "Condition": { + "additionalProperties": false, + "description": "Represents information about condition.", + "properties": { + "Result": { + "description": "The specified result for when the failure conditions are met, such as rolling back the stage", + "type": "string" + }, + "Rules": { + "items": { + "$ref": "#/definitions/RuleDeclaration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EncryptionKey": { + "additionalProperties": false, + "description": "Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key", + "properties": { + "Id": { + "description": "The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.", + "type": "string" + }, + "Type": { + "description": "The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.", + "type": "string" + } + }, + "required": [ + "Type", + "Id" + ], + "type": "object" + }, + "FailureConditions": { + "additionalProperties": false, + "description": "The configuration that specifies the result, such as rollback, to occur upon stage failure", + "properties": { + "Conditions": { + "items": { + "$ref": "#/definitions/Condition" + }, + "type": "array", + "uniqueItems": true + }, + "Result": { + "description": "The specified result for when the failure conditions are met, such as rolling back the stage", + "enum": [ + "ROLLBACK" + ], + "type": "string" + } + }, + "type": "object" + }, + "GitBranchFilterCriteria": { + "additionalProperties": false, + "description": "The Git repository branches specified as filter criteria to start the pipeline.", + "properties": { + "Excludes": { + "description": "The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Includes": { + "description": "The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "GitConfiguration": { + "additionalProperties": false, + "description": "A type of trigger configuration for Git-based source actions.", + "properties": { + "PullRequest": { + "description": "The field where the repository event that will start the pipeline is specified as pull requests.", + "items": { + "$ref": "#/definitions/GitPullRequestFilter" + }, + "type": "array", + "uniqueItems": true + }, + "Push": { + "description": "The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.", + "items": { + "$ref": "#/definitions/GitPushFilter" + }, + "type": "array", + "uniqueItems": true + }, + "SourceActionName": { + "description": "The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.", + "type": "string" + } + }, + "required": [ + "SourceActionName" + ], + "type": "object" + }, + "GitFilePathFilterCriteria": { + "additionalProperties": false, + "description": "The Git repository file paths specified as filter criteria to start the pipeline.", + "properties": { + "Excludes": { + "description": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Includes": { + "description": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "GitPullRequestFilter": { + "additionalProperties": false, + "description": "The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.", + "properties": { + "Branches": { + "$ref": "#/definitions/GitBranchFilterCriteria" + }, + "Events": { + "description": "The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "FilePaths": { + "$ref": "#/definitions/GitFilePathFilterCriteria" + } + }, + "type": "object" + }, + "GitPushFilter": { + "additionalProperties": false, + "description": "The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.", + "properties": { + "Branches": { + "$ref": "#/definitions/GitBranchFilterCriteria" + }, + "FilePaths": { + "$ref": "#/definitions/GitFilePathFilterCriteria" + }, + "Tags": { + "$ref": "#/definitions/GitTagFilterCriteria" + } + }, + "type": "object" + }, + "GitTagFilterCriteria": { + "additionalProperties": false, + "description": "The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.", + "properties": { + "Excludes": { + "description": "The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Includes": { + "description": "The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "InputArtifact": { + "additionalProperties": false, + "description": "Represents information about an artifact to be worked on, such as a test or build artifact.", + "properties": { + "Name": { + "description": "The name of the artifact to be worked on (for example, \"My App\").", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "OutputArtifact": { + "additionalProperties": false, + "description": "Represents information about the output of an action.", + "properties": { + "Name": { + "description": "The name of the output of an artifact, such as \"My App\".", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "PipelineTriggerDeclaration": { + "additionalProperties": false, + "description": "Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.", + "properties": { + "GitConfiguration": { + "$ref": "#/definitions/GitConfiguration" + }, + "ProviderType": { + "description": "The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.", + "enum": [ + "CodeStarSourceConnection" + ], + "type": "string" + } + }, + "required": [ + "ProviderType" + ], + "type": "object" + }, + "RuleDeclaration": { + "additionalProperties": false, + "description": "Represents information about condition.", + "properties": { + "Configuration": { + "description": "The rule's configuration. These are key-value pairs that specify input values for a rule.", + "type": "object" + }, + "InputArtifacts": { + "items": { + "$ref": "#/definitions/InputArtifact" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "The rule declaration's name.", + "type": "string" + }, + "Region": { + "description": "The rule declaration's AWS Region, such as us-east-1.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.", + "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", + "type": "string" + }, + "RuleTypeId": { + "$ref": "#/definitions/RuleTypeId" + } + }, + "type": "object" + }, + "RuleTypeId": { + "additionalProperties": false, + "description": "Represents information about a rule type.", + "properties": { + "Category": { + "description": "A category for the provider type for the rule.", + "type": "string" + }, + "Owner": { + "description": "The creator of the rule being called. Only AWS is supported.", + "type": "string" + }, + "Provider": { + "description": "The provider of the service being called by the rule.", + "type": "string" + }, + "Version": { + "description": "A string that describes the rule version.", + "type": "string" + } + }, + "type": "object" + }, + "StageDeclaration": { + "additionalProperties": false, + "description": "Represents information about a stage and its definition.", + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/ActionDeclaration" + }, + "type": "array", + "uniqueItems": true + }, + "BeforeEntry": { + "$ref": "#/definitions/BeforeEntryConditions", + "description": "The method to use before stage runs.", + "type": "object" + }, + "Blockers": { + "items": { + "$ref": "#/definitions/BlockerDeclaration" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "The name of the stage.", + "type": "string" + }, + "OnFailure": { + "$ref": "#/definitions/FailureConditions", + "description": "The method to use when a stage has not completed successfully", + "type": "object" + }, + "OnSuccess": { + "$ref": "#/definitions/SuccessConditions", + "description": "The method to use when a stage has completed successfully", + "type": "object" + } + }, + "required": [ + "Actions", + "Name" + ], + "type": "object" + }, + "StageTransition": { + "additionalProperties": false, + "description": "The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.", + "properties": { + "Reason": { + "description": "The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.", + "type": "string" + }, + "StageName": { + "description": "The name of the stage where you want to disable the inbound or outbound transition of artifacts.", + "type": "string" + } + }, + "required": [ + "StageName", + "Reason" + ], + "type": "object" + }, + "SuccessConditions": { + "additionalProperties": false, + "description": "The configuration that specifies the result, such as rollback, to occur upon stage failure", + "properties": { + "Conditions": { + "items": { + "$ref": "#/definitions/Condition" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A tag is a key-value pair that is used to manage the resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VariableDeclaration": { + "additionalProperties": false, + "description": "A variable declared at the pipeline level.", + "properties": { + "DefaultValue": { + "description": "The value of a pipeline-level variable.", + "type": "string" + }, + "Description": { + "description": "The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.", + "type": "string" + }, + "Name": { + "description": "The name of a pipeline-level variable.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + } + }, + "description": "The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "codepipeline:GetPipeline", + "codepipeline:CreatePipeline", + "codepipeline:DisableStageTransition", + "codepipeline:GetPipelineState", + "codepipeline:TagResource", + "codestar-connections:PassConnection" + ] + }, + "delete": { + "permissions": [ + "codepipeline:GetPipeline", + "codepipeline:DeletePipeline" + ] + }, + "list": { + "permissions": [ + "codepipeline:ListPipelines" + ] + }, + "read": { + "permissions": [ + "codepipeline:GetPipeline", + "codepipeline:ListTagsForResource", + "codepipeline:GetPipelineState" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "codepipeline:EnableStageTransition", + "codepipeline:StartPipelineExecution", + "codepipeline:GetPipeline", + "codepipeline:UpdatePipeline", + "codepipeline:GetPipelineState", + "codepipeline:DisableStageTransition", + "codepipeline:TagResource", + "codepipeline:UntagResource", + "codestar-connections:PassConnection" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "ArtifactStore": { + "$ref": "#/definitions/ArtifactStore", + "description": "The S3 bucket where artifacts for the pipeline are stored." + }, + "ArtifactStores": { + "description": "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.", + "items": { + "$ref": "#/definitions/ArtifactStoreMap" + }, + "type": "array", + "uniqueItems": true + }, + "DisableInboundStageTransitions": { + "description": "Represents the input of a DisableStageTransition action.", + "items": { + "$ref": "#/definitions/StageTransition" + }, + "type": "array", + "uniqueItems": true + }, + "ExecutionMode": { + "default": "SUPERSEDED", + "description": "The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.", + "enum": [ + "QUEUED", + "SUPERSEDED", + "PARALLEL" + ], + "type": "string" + }, + "Name": { + "description": "The name of the pipeline.", + "type": "string" + }, + "PipelineType": { + "description": "CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.", + "enum": [ + "V1", + "V2" + ], + "type": "string" + }, + "RestartExecutionOnUpdate": { + "description": "Indicates whether to rerun the CodePipeline pipeline after you update it.", + "type": "boolean" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn", + "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", + "type": "string" + }, + "Stages": { + "description": "Represents information about a stage and its definition.", + "items": { + "$ref": "#/definitions/StageDeclaration" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "Specifies the tags applied to the pipeline.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Triggers": { + "description": "The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.", + "items": { + "$ref": "#/definitions/PipelineTriggerDeclaration" + }, + "type": "array", + "uniqueItems": true + }, + "Variables": { + "description": "A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\\-_]+.", + "items": { + "$ref": "#/definitions/VariableDeclaration" + }, + "type": "array", + "uniqueItems": true + }, + "Version": { + "description": "The version of the pipeline.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Version" + ], + "required": [ + "Stages", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "codepipeline:TagResource", + "codepipeline:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodePipeline::Pipeline", + "writeOnlyProperties": [ + "/properties/RestartExecutionOnUpdate" + ] +} diff --git a/schema/aws-codepipeline-webhook.json b/schema/aws-codepipeline-webhook.json index bd0af78..41c476b 100644 --- a/schema/aws-codepipeline-webhook.json +++ b/schema/aws-codepipeline-webhook.json @@ -1,88 +1,88 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "WebhookAuthConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedIPRange": { - "type": "string" - }, - "SecretToken": { - "type": "string" - } - }, - "type": "object" - }, - "WebhookFilterRule": { - "additionalProperties": false, - "properties": { - "JsonPath": { - "type": "string" - }, - "MatchEquals": { - "type": "string" - } - }, - "required": [ - "JsonPath" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodePipeline::Webhook", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Authentication": { - "type": "string" - }, - "AuthenticationConfiguration": { - "$ref": "#/definitions/WebhookAuthConfiguration" - }, - "Filters": { - "items": { - "$ref": "#/definitions/WebhookFilterRule" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RegisterWithThirdParty": { - "type": "boolean" - }, - "TargetAction": { - "type": "string" - }, - "TargetPipeline": { - "type": "string" - }, - "TargetPipelineVersion": { - "type": "integer" - }, - "Url": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Url" - ], - "required": [ - "AuthenticationConfiguration", - "Filters", - "Authentication", - "TargetPipeline", - "TargetAction", - "TargetPipelineVersion" - ], - "typeName": "AWS::CodePipeline::Webhook" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "WebhookAuthConfiguration": { + "additionalProperties": false, + "properties": { + "AllowedIPRange": { + "type": "string" + }, + "SecretToken": { + "type": "string" + } + }, + "type": "object" + }, + "WebhookFilterRule": { + "additionalProperties": false, + "properties": { + "JsonPath": { + "type": "string" + }, + "MatchEquals": { + "type": "string" + } + }, + "required": [ + "JsonPath" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodePipeline::Webhook", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Authentication": { + "type": "string" + }, + "AuthenticationConfiguration": { + "$ref": "#/definitions/WebhookAuthConfiguration" + }, + "Filters": { + "items": { + "$ref": "#/definitions/WebhookFilterRule" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RegisterWithThirdParty": { + "type": "boolean" + }, + "TargetAction": { + "type": "string" + }, + "TargetPipeline": { + "type": "string" + }, + "TargetPipelineVersion": { + "type": "integer" + }, + "Url": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Url" + ], + "required": [ + "AuthenticationConfiguration", + "Filters", + "Authentication", + "TargetPipeline", + "TargetAction", + "TargetPipelineVersion" + ], + "typeName": "AWS::CodePipeline::Webhook" +} diff --git a/schema/aws-codestar-githubrepository.json b/schema/aws-codestar-githubrepository.json index 1d33d2b..50cc3b1 100644 --- a/schema/aws-codestar-githubrepository.json +++ b/schema/aws-codestar-githubrepository.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "definitions": { - "Code": { - "additionalProperties": false, - "properties": { - "S3": { - "$ref": "#/definitions/S3" - } - }, - "required": [ - "S3" - ], - "type": "object" - }, - "S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeStar::GitHubRepository", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Code": { - "$ref": "#/definitions/Code" - }, - "ConnectionArn": { - "type": "string" - }, - "EnableIssues": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "IsPrivate": { - "type": "boolean" - }, - "RepositoryAccessToken": { - "type": "string" - }, - "RepositoryDescription": { - "type": "string" - }, - "RepositoryName": { - "type": "string" - }, - "RepositoryOwner": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RepositoryName", - "RepositoryOwner" - ], - "typeName": "AWS::CodeStar::GitHubRepository" -} +{ + "additionalProperties": false, + "definitions": { + "Code": { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/S3" + } + }, + "required": [ + "S3" + ], + "type": "object" + }, + "S3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "ObjectVersion": { + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeStar::GitHubRepository", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Code": { + "$ref": "#/definitions/Code" + }, + "ConnectionArn": { + "type": "string" + }, + "EnableIssues": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "IsPrivate": { + "type": "boolean" + }, + "RepositoryAccessToken": { + "type": "string" + }, + "RepositoryDescription": { + "type": "string" + }, + "RepositoryName": { + "type": "string" + }, + "RepositoryOwner": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RepositoryName", + "RepositoryOwner" + ], + "typeName": "AWS::CodeStar::GitHubRepository" +} diff --git a/schema/aws-codestarconnections-connection.json b/schema/aws-codestarconnections-connection.json index 841e298..a60f99d 100644 --- a/schema/aws-codestarconnections-connection.json +++ b/schema/aws-codestarconnections-connection.json @@ -1,131 +1,131 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectionName", - "/properties/ProviderType", - "/properties/HostArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Schema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline", - "handlers": { - "create": { - "permissions": [ - "codestar-connections:CreateConnection", - "codestar-connections:TagResource" - ] - }, - "delete": { - "permissions": [ - "codestar-connections:DeleteConnection" - ] - }, - "list": { - "permissions": [ - "codestar-connections:ListConnections", - "codestar-connections:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "codestar-connections:GetConnection", - "codestar-connections:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "codestar-connections:ListTagsForResource", - "codestar-connections:TagResource", - "codestar-connections:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectionArn" - ], - "properties": { - "ConnectionArn": { - "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "ConnectionName": { - "description": "The name of the connection. Connection names must be unique in an AWS user account.", - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "ConnectionStatus": { - "description": "The current status of the connection.", - "type": "string" - }, - "HostArn": { - "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "OwnerAccountId": { - "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.", - "maxLength": 12, - "minLength": 12, - "pattern": "[0-9]{12}", - "type": "string" - }, - "ProviderType": { - "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.", - "type": "string" - }, - "Tags": { - "description": "Specifies the tags applied to a connection.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ConnectionArn", - "/properties/ConnectionStatus", - "/properties/OwnerAccountId" - ], - "required": [ - "ConnectionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeStarConnections::Connection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectionName", + "/properties/ProviderType", + "/properties/HostArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Schema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline", + "handlers": { + "create": { + "permissions": [ + "codestar-connections:CreateConnection", + "codestar-connections:TagResource" + ] + }, + "delete": { + "permissions": [ + "codestar-connections:DeleteConnection" + ] + }, + "list": { + "permissions": [ + "codestar-connections:ListConnections", + "codestar-connections:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "codestar-connections:GetConnection", + "codestar-connections:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codestar-connections:ListTagsForResource", + "codestar-connections:TagResource", + "codestar-connections:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectionArn" + ], + "properties": { + "ConnectionArn": { + "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "ConnectionName": { + "description": "The name of the connection. Connection names must be unique in an AWS user account.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ConnectionStatus": { + "description": "The current status of the connection.", + "type": "string" + }, + "HostArn": { + "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "OwnerAccountId": { + "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.", + "maxLength": 12, + "minLength": 12, + "pattern": "[0-9]{12}", + "type": "string" + }, + "ProviderType": { + "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.", + "type": "string" + }, + "Tags": { + "description": "Specifies the tags applied to a connection.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ConnectionArn", + "/properties/ConnectionStatus", + "/properties/OwnerAccountId" + ], + "required": [ + "ConnectionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeStarConnections::Connection" +} diff --git a/schema/aws-codestarconnections-repositorylink.json b/schema/aws-codestarconnections-repositorylink.json index 81aa58c..67d1ca0 100644 --- a/schema/aws-codestarconnections-repositorylink.json +++ b/schema/aws-codestarconnections-repositorylink.json @@ -1,154 +1,159 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/RepositoryLinkId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RepositoryName", - "/properties/OwnerId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Schema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.", - "handlers": { - "create": { - "permissions": [ - "codestar-connections:CreateRepositoryLink", - "codestar-connections:TagResource", - "codestar-connections:UseConnection", - "codestar-connections:PassConnection", - "codestar-connections:GetConnection", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "codestar-connections:GetRepositoryLink", - "codestar-connections:DeleteRepositoryLink", - "codestar-connections:GetConnection" - ] - }, - "list": { - "permissions": [ - "codestar-connections:ListRepositoryLinks", - "codestar-connections:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "codestar-connections:GetRepositoryLink", - "codestar-connections:ListTagsForResource", - "codestar-connections:GetConnection" - ] - }, - "update": { - "permissions": [ - "codestar-connections:GetConnection", - "codestar-connections:ListTagsForResource", - "codestar-connections:PassConnection", - "codestar-connections:UseConnection", - "codestar-connections:TagResource", - "codestar-connections:UntagResource", - "codestar-connections:UpdateRepositoryLink" - ] - } - }, - "primaryIdentifier": [ - "/properties/RepositoryLinkArn" - ], - "properties": { - "ConnectionArn": { - "description": "The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "EncryptionKeyArn": { - "description": "The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "OwnerId": { - "description": "the ID of the entity that owns the repository.", - "pattern": "[a-za-z0-9_\\.-]+", - "type": "string" - }, - "ProviderType": { - "description": "The name of the external provider where your third-party code repository is configured.", - "enum": [ - "GitHub", - "Bitbucket", - "GitHubEnterprise", - "GitLab", - "GitLabSelfManaged" - ], - "type": "string" - }, - "RepositoryLinkArn": { - "description": "A unique Amazon Resource Name (ARN) to designate the repository link.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", - "type": "string" - }, - "RepositoryLinkId": { - "description": "A UUID that uniquely identifies the RepositoryLink.", - "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "type": "string" - }, - "RepositoryName": { - "description": "The repository for which the link is being created.", - "pattern": "[a-za-z0-9_\\.-]+", - "type": "string" - }, - "Tags": { - "description": "Specifies the tags applied to a RepositoryLink.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RepositoryLinkArn", - "/properties/RepositoryLinkId", - "/properties/ProviderType" - ], - "required": [ - "RepositoryName", - "ConnectionArn", - "OwnerId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CodeStarConnections::RepositoryLink" -} +{ + "additionalIdentifiers": [ + [ + "/properties/RepositoryLinkId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RepositoryName", + "/properties/OwnerId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Schema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.", + "handlers": { + "create": { + "permissions": [ + "codestar-connections:CreateRepositoryLink", + "codestar-connections:TagResource", + "codestar-connections:UseConnection", + "codestar-connections:PassConnection", + "codestar-connections:GetConnection", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "codestar-connections:GetRepositoryLink", + "codestar-connections:DeleteRepositoryLink", + "codestar-connections:GetConnection" + ] + }, + "list": { + "permissions": [ + "codestar-connections:ListRepositoryLinks", + "codestar-connections:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "codestar-connections:GetRepositoryLink", + "codestar-connections:ListTagsForResource", + "codestar-connections:GetConnection" + ] + }, + "update": { + "permissions": [ + "codestar-connections:GetConnection", + "codestar-connections:ListTagsForResource", + "codestar-connections:PassConnection", + "codestar-connections:UseConnection", + "codestar-connections:TagResource", + "codestar-connections:UntagResource", + "codestar-connections:UpdateRepositoryLink" + ] + } + }, + "primaryIdentifier": [ + "/properties/RepositoryLinkArn" + ], + "properties": { + "ConnectionArn": { + "description": "The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "EncryptionKeyArn": { + "description": "The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "OwnerId": { + "description": "the ID of the entity that owns the repository.", + "pattern": "[a-za-z0-9_\\.-]+", + "type": "string" + }, + "ProviderType": { + "description": "The name of the external provider where your third-party code repository is configured.", + "enum": [ + "GitHub", + "Bitbucket", + "GitHubEnterprise", + "GitLab", + "GitLabSelfManaged" + ], + "type": "string" + }, + "RepositoryLinkArn": { + "description": "A unique Amazon Resource Name (ARN) to designate the repository link.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "RepositoryLinkId": { + "description": "A UUID that uniquely identifies the RepositoryLink.", + "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "type": "string" + }, + "RepositoryName": { + "description": "The repository for which the link is being created.", + "pattern": "[a-za-z0-9_\\.-]+", + "type": "string" + }, + "Tags": { + "description": "Specifies the tags applied to a RepositoryLink.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RepositoryLinkArn", + "/properties/RepositoryLinkId", + "/properties/ProviderType" + ], + "required": [ + "RepositoryName", + "ConnectionArn", + "OwnerId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "codestar-connections:UntagResource", + "codestar-connections:ListTagsForResource", + "codestar-connections:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeStarConnections::RepositoryLink" +} diff --git a/schema/aws-codestarconnections-syncconfiguration.json b/schema/aws-codestarconnections-syncconfiguration.json index aba2b21..3881c8d 100644 --- a/schema/aws-codestarconnections-syncconfiguration.json +++ b/schema/aws-codestarconnections-syncconfiguration.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SyncType", - "/properties/ResourceName" - ], - "definitions": {}, - "description": "Schema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.", - "handlers": { - "create": { - "permissions": [ - "codestar-connections:CreateSyncConfiguration", - "codestar-connections:PassRepository", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "codestar-connections:DeleteSyncConfiguration", - "codestar-connections:GetSyncConfiguration" - ] - }, - "list": { - "permissions": [ - "codestar-connections:ListSyncConfigurations", - "codestar-connections:ListRepositoryLinks" - ] - }, - "read": { - "permissions": [ - "codestar-connections:GetSyncConfiguration" - ] - }, - "update": { - "permissions": [ - "codestar-connections:UpdateSyncConfiguration", - "codestar-connections:PassRepository", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceName", - "/properties/SyncType" - ], - "properties": { - "Branch": { - "description": "The name of the branch of the repository from which resources are to be synchronized,", - "type": "string" - }, - "ConfigFile": { - "description": "The source provider repository path of the sync configuration file of the respective SyncType.", - "type": "string" - }, - "OwnerId": { - "description": "the ID of the entity that owns the repository.", - "pattern": "[a-za-z0-9_\\.-]+", - "type": "string" - }, - "ProviderType": { - "description": "The name of the external provider where your third-party code repository is configured.", - "enum": [ - "GitHub", - "Bitbucket", - "GitHubEnterprise", - "GitLab", - "GitLabSelfManaged" - ], - "type": "string" - }, - "PublishDeploymentStatus": { - "description": "Whether to enable or disable publishing of deployment status to source providers.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "RepositoryLinkId": { - "description": "A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.", - "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "type": "string" - }, - "RepositoryName": { - "description": "The name of the repository that is being synced to.", - "pattern": "[a-za-z0-9_\\.-]+", - "type": "string" - }, - "ResourceName": { - "description": "The name of the resource that is being synchronized to the repository.", - "pattern": "[a-za-z0-9_\\.-]+", - "type": "string" - }, - "RoleArn": { - "description": "The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.", - "type": "string" - }, - "SyncType": { - "description": "The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.", - "type": "string" - }, - "TriggerResourceUpdateOn": { - "description": "When to trigger Git sync to begin the stack update.", - "enum": [ - "ANY_CHANGE", - "FILE_CHANGE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ProviderType", - "/properties/OwnerId", - "/properties/RepositoryName" - ], - "required": [ - "Branch", - "ConfigFile", - "RepositoryLinkId", - "ResourceName", - "SyncType", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::CodeStarConnections::SyncConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SyncType", + "/properties/ResourceName" + ], + "definitions": {}, + "description": "Schema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.", + "handlers": { + "create": { + "permissions": [ + "codestar-connections:CreateSyncConfiguration", + "codestar-connections:PassRepository", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "codestar-connections:DeleteSyncConfiguration", + "codestar-connections:GetSyncConfiguration" + ] + }, + "list": { + "permissions": [ + "codestar-connections:ListSyncConfigurations", + "codestar-connections:ListRepositoryLinks" + ] + }, + "read": { + "permissions": [ + "codestar-connections:GetSyncConfiguration" + ] + }, + "update": { + "permissions": [ + "codestar-connections:UpdateSyncConfiguration", + "codestar-connections:PassRepository", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceName", + "/properties/SyncType" + ], + "properties": { + "Branch": { + "description": "The name of the branch of the repository from which resources are to be synchronized,", + "type": "string" + }, + "ConfigFile": { + "description": "The source provider repository path of the sync configuration file of the respective SyncType.", + "type": "string" + }, + "OwnerId": { + "description": "the ID of the entity that owns the repository.", + "pattern": "[a-za-z0-9_\\.-]+", + "type": "string" + }, + "ProviderType": { + "description": "The name of the external provider where your third-party code repository is configured.", + "enum": [ + "GitHub", + "Bitbucket", + "GitHubEnterprise", + "GitLab", + "GitLabSelfManaged" + ], + "type": "string" + }, + "PublishDeploymentStatus": { + "description": "Whether to enable or disable publishing of deployment status to source providers.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "RepositoryLinkId": { + "description": "A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.", + "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "type": "string" + }, + "RepositoryName": { + "description": "The name of the repository that is being synced to.", + "pattern": "[a-za-z0-9_\\.-]+", + "type": "string" + }, + "ResourceName": { + "description": "The name of the resource that is being synchronized to the repository.", + "pattern": "[a-za-z0-9_\\.-]+", + "type": "string" + }, + "RoleArn": { + "description": "The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.", + "type": "string" + }, + "SyncType": { + "description": "The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.", + "type": "string" + }, + "TriggerResourceUpdateOn": { + "description": "When to trigger Git sync to begin the stack update.", + "enum": [ + "ANY_CHANGE", + "FILE_CHANGE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ProviderType", + "/properties/OwnerId", + "/properties/RepositoryName" + ], + "required": [ + "Branch", + "ConfigFile", + "RepositoryLinkId", + "ResourceName", + "SyncType", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::CodeStarConnections::SyncConfiguration" +} diff --git a/schema/aws-codestarnotifications-notificationrule.json b/schema/aws-codestarnotifications-notificationrule.json index cb9a1f6..557ef21 100644 --- a/schema/aws-codestarnotifications-notificationrule.json +++ b/schema/aws-codestarnotifications-notificationrule.json @@ -1,144 +1,144 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Resource" - ], - "definitions": { - "Target": { - "additionalProperties": false, - "properties": { - "TargetAddress": { - "type": "string" - }, - "TargetType": { - "type": "string" - } - }, - "required": [ - "TargetType", - "TargetAddress" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::CodeStarNotifications::NotificationRule", - "handlers": { - "create": { - "permissions": [ - "codestar-notifications:createNotificationRule" - ] - }, - "delete": { - "permissions": [ - "codestar-notifications:deleteNotificationRule", - "codestar-notifications:describeNotificationRule" - ] - }, - "list": { - "permissions": [ - "codestar-notifications:listNotificationRules" - ] - }, - "read": { - "permissions": [ - "codestar-notifications:describeNotificationRule" - ] - }, - "update": { - "permissions": [ - "codestar-notifications:updateNotificationRule", - "codestar-notifications:TagResource", - "codestar-notifications:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:aws[^:\\s]*:codestar-notifications:[^:\\s]+:\\d{12}:notificationrule\\/(.*\\S)?$", - "type": "string" - }, - "CreatedBy": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DetailType": { - "enum": [ - "BASIC", - "FULL" - ], - "type": "string" - }, - "EventTypeId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "EventTypeIds": { - "items": { - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "[A-Za-z0-9\\-_ ]+$", - "type": "string" - }, - "Resource": { - "pattern": "^arn:aws[^:\\s]*:[^:\\s]*:[^:\\s]*:[0-9]{12}:[^\\s]+$", - "type": "string" - }, - "Status": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "TargetAddress": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/Target" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "EventTypeIds", - "Resource", - "DetailType", - "Targets", - "Name" - ], - "typeName": "AWS::CodeStarNotifications::NotificationRule", - "writeOnlyProperties": [ - "/properties/EventTypeId", - "/properties/TargetAddress" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Resource" + ], + "definitions": { + "Target": { + "additionalProperties": false, + "properties": { + "TargetAddress": { + "type": "string" + }, + "TargetType": { + "type": "string" + } + }, + "required": [ + "TargetType", + "TargetAddress" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeStarNotifications::NotificationRule", + "handlers": { + "create": { + "permissions": [ + "codestar-notifications:createNotificationRule" + ] + }, + "delete": { + "permissions": [ + "codestar-notifications:deleteNotificationRule", + "codestar-notifications:describeNotificationRule" + ] + }, + "list": { + "permissions": [ + "codestar-notifications:listNotificationRules" + ] + }, + "read": { + "permissions": [ + "codestar-notifications:describeNotificationRule" + ] + }, + "update": { + "permissions": [ + "codestar-notifications:updateNotificationRule", + "codestar-notifications:TagResource", + "codestar-notifications:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:aws[^:\\s]*:codestar-notifications:[^:\\s]+:\\d{12}:notificationrule\\/(.*\\S)?$", + "type": "string" + }, + "CreatedBy": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DetailType": { + "enum": [ + "BASIC", + "FULL" + ], + "type": "string" + }, + "EventTypeId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "EventTypeIds": { + "items": { + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "[A-Za-z0-9\\-_ ]+$", + "type": "string" + }, + "Resource": { + "pattern": "^arn:aws[^:\\s]*:[^:\\s]*:[^:\\s]*:[0-9]{12}:[^\\s]+$", + "type": "string" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "TargetAddress": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Targets": { + "items": { + "$ref": "#/definitions/Target" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "EventTypeIds", + "Resource", + "DetailType", + "Targets", + "Name" + ], + "typeName": "AWS::CodeStarNotifications::NotificationRule", + "writeOnlyProperties": [ + "/properties/EventTypeId", + "/properties/TargetAddress" + ] +} diff --git a/schema/aws-cognito-identitypool.json b/schema/aws-cognito-identitypool.json index 9d866bd..bec9294 100644 --- a/schema/aws-cognito-identitypool.json +++ b/schema/aws-cognito-identitypool.json @@ -1,170 +1,210 @@ -{ - "additionalProperties": false, - "definitions": { - "CognitoIdentityProvider": { - "additionalProperties": false, - "properties": { - "ClientId": { - "type": "string" - }, - "ProviderName": { - "type": "string" - }, - "ServerSideTokenCheck": { - "type": "boolean" - } - }, - "required": [ - "ProviderName", - "ClientId" - ], - "type": "object" - }, - "CognitoStreams": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "StreamName": { - "type": "string" - }, - "StreamingStatus": { - "type": "string" - } - }, - "type": "object" - }, - "PushSync": { - "additionalProperties": false, - "properties": { - "ApplicationArns": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RoleArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::IdentityPool", - "handlers": { - "create": { - "permissions": [ - "cognito-identity:CreateIdentityPool", - "cognito-sync:SetIdentityPoolConfiguration", - "cognito-sync:SetCognitoEvents", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cognito-identity:DeleteIdentityPool" - ] - }, - "list": { - "permissions": [ - "cognito-identity:ListIdentityPools" - ] - }, - "read": { - "permissions": [ - "cognito-identity:DescribeIdentityPool" - ] - }, - "update": { - "permissions": [ - "cognito-identity:UpdateIdentityPool", - "cognito-identity:DescribeIdentityPool", - "cognito-sync:SetIdentityPoolConfiguration", - "cognito-sync:SetCognitoEvents", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllowClassicFlow": { - "type": "boolean" - }, - "AllowUnauthenticatedIdentities": { - "type": "boolean" - }, - "CognitoEvents": { - "type": "object" - }, - "CognitoIdentityProviders": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CognitoIdentityProvider" - }, - "type": "array", - "uniqueItems": false - }, - "CognitoStreams": { - "$ref": "#/definitions/CognitoStreams" - }, - "DeveloperProviderName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IdentityPoolName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OpenIdConnectProviderARNs": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PushSync": { - "$ref": "#/definitions/PushSync" - }, - "SamlProviderARNs": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SupportedLoginProviders": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Name" - ], - "required": [ - "AllowUnauthenticatedIdentities" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::IdentityPool", - "writeOnlyProperties": [ - "/properties/PushSync", - "/properties/CognitoStreams", - "/properties/CognitoEvents" - ] -} +{ + "additionalProperties": false, + "definitions": { + "CognitoIdentityProvider": { + "additionalProperties": false, + "properties": { + "ClientId": { + "type": "string" + }, + "ProviderName": { + "type": "string" + }, + "ServerSideTokenCheck": { + "type": "boolean" + } + }, + "required": [ + "ProviderName", + "ClientId" + ], + "type": "object" + }, + "CognitoStreams": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "type": "string" + }, + "StreamName": { + "type": "string" + }, + "StreamingStatus": { + "type": "string" + } + }, + "type": "object" + }, + "PushSync": { + "additionalProperties": false, + "properties": { + "ApplicationArns": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::IdentityPool", + "handlers": { + "create": { + "permissions": [ + "cognito-identity:CreateIdentityPool", + "cognito-sync:SetIdentityPoolConfiguration", + "cognito-sync:SetCognitoEvents", + "cognito-identity:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cognito-identity:DeleteIdentityPool" + ] + }, + "list": { + "permissions": [ + "cognito-identity:ListIdentityPools" + ] + }, + "read": { + "permissions": [ + "cognito-identity:DescribeIdentityPool" + ] + }, + "update": { + "permissions": [ + "cognito-identity:UpdateIdentityPool", + "cognito-identity:DescribeIdentityPool", + "cognito-sync:SetIdentityPoolConfiguration", + "cognito-sync:SetCognitoEvents", + "cognito-identity:TagResource", + "cognito-identity:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowClassicFlow": { + "type": "boolean" + }, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "CognitoEvents": { + "type": "object" + }, + "CognitoIdentityProviders": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CognitoIdentityProvider" + }, + "type": "array", + "uniqueItems": false + }, + "CognitoStreams": { + "$ref": "#/definitions/CognitoStreams" + }, + "DeveloperProviderName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IdentityPoolName": { + "type": "string" + }, + "IdentityPoolTags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "type": "string" + }, + "OpenIdConnectProviderARNs": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PushSync": { + "$ref": "#/definitions/PushSync" + }, + "SamlProviderARNs": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SupportedLoginProviders": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Name" + ], + "required": [ + "AllowUnauthenticatedIdentities" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "cognito-identity:TagResource", + "cognito-identity:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/IdentityPoolTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Cognito::IdentityPool", + "writeOnlyProperties": [ + "/properties/PushSync", + "/properties/CognitoStreams", + "/properties/CognitoEvents" + ] +} diff --git a/schema/aws-cognito-identitypoolprincipaltag.json b/schema/aws-cognito-identitypoolprincipaltag.json index 8ff6076..245e566 100644 --- a/schema/aws-cognito-identitypoolprincipaltag.json +++ b/schema/aws-cognito-identitypoolprincipaltag.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityPoolId", - "/properties/IdentityProviderName" - ], - "description": "Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag", - "handlers": { - "create": { - "permissions": [ - "cognito-identity:GetPrincipalTagAttributeMap", - "cognito-identity:SetPrincipalTagAttributeMap" - ] - }, - "delete": { - "permissions": [ - "cognito-identity:GetPrincipalTagAttributeMap", - "cognito-identity:SetPrincipalTagAttributeMap" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "IdentityPoolId": { - "$ref": "resource-schema.json#/properties/IdentityPoolId" - }, - "IdentityProviderName": { - "$ref": "resource-schema.json#/properties/IdentityProviderName" - } - }, - "required": [ - "IdentityPoolId", - "IdentityProviderName" - ] - }, - "permissions": [ - "cognito-identity:GetPrincipalTagAttributeMap" - ] - }, - "read": { - "permissions": [ - "cognito-identity:GetPrincipalTagAttributeMap" - ] - }, - "update": { - "permissions": [ - "cognito-identity:GetPrincipalTagAttributeMap", - "cognito-identity:SetPrincipalTagAttributeMap" - ] - } - }, - "primaryIdentifier": [ - "/properties/IdentityPoolId", - "/properties/IdentityProviderName" - ], - "properties": { - "IdentityPoolId": { - "type": "string" - }, - "IdentityProviderName": { - "type": "string" - }, - "PrincipalTags": { - "type": "object" - }, - "UseDefaults": { - "type": "boolean" - } - }, - "required": [ - "IdentityPoolId", - "IdentityProviderName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::IdentityPoolPrincipalTag" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityPoolId", + "/properties/IdentityProviderName" + ], + "description": "Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag", + "handlers": { + "create": { + "permissions": [ + "cognito-identity:GetPrincipalTagAttributeMap", + "cognito-identity:SetPrincipalTagAttributeMap" + ] + }, + "delete": { + "permissions": [ + "cognito-identity:GetPrincipalTagAttributeMap", + "cognito-identity:SetPrincipalTagAttributeMap" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IdentityPoolId": { + "$ref": "resource-schema.json#/properties/IdentityPoolId" + }, + "IdentityProviderName": { + "$ref": "resource-schema.json#/properties/IdentityProviderName" + } + }, + "required": [ + "IdentityPoolId", + "IdentityProviderName" + ] + }, + "permissions": [ + "cognito-identity:GetPrincipalTagAttributeMap" + ] + }, + "read": { + "permissions": [ + "cognito-identity:GetPrincipalTagAttributeMap" + ] + }, + "update": { + "permissions": [ + "cognito-identity:GetPrincipalTagAttributeMap", + "cognito-identity:SetPrincipalTagAttributeMap" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdentityPoolId", + "/properties/IdentityProviderName" + ], + "properties": { + "IdentityPoolId": { + "type": "string" + }, + "IdentityProviderName": { + "type": "string" + }, + "PrincipalTags": { + "type": "object" + }, + "UseDefaults": { + "type": "boolean" + } + }, + "required": [ + "IdentityPoolId", + "IdentityProviderName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::IdentityPoolPrincipalTag" +} diff --git a/schema/aws-cognito-identitypoolroleattachment.json b/schema/aws-cognito-identitypoolroleattachment.json index fe291f8..cacbc07 100644 --- a/schema/aws-cognito-identitypoolroleattachment.json +++ b/schema/aws-cognito-identitypoolroleattachment.json @@ -1,159 +1,159 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/IdentityPoolId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityPoolId" - ], - "definitions": { - "MappingRule": { - "additionalProperties": false, - "properties": { - "Claim": { - "type": "string" - }, - "MatchType": { - "type": "string" - }, - "RoleARN": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Claim", - "MatchType", - "RoleARN", - "Value" - ], - "type": "object" - }, - "RoleMapping": { - "additionalProperties": false, - "properties": { - "AmbiguousRoleResolution": { - "type": "string" - }, - "IdentityProvider": { - "type": "string" - }, - "RulesConfiguration": { - "$ref": "#/definitions/RulesConfigurationType" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "RulesConfigurationType": { - "additionalProperties": false, - "properties": { - "Rules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MappingRule" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Rules" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment", - "handlers": { - "create": { - "permissions": [ - "cognito-identity:GetIdentityPoolRoles", - "cognito-identity:SetIdentityPoolRoles", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "cognito-identity:GetIdentityPoolRoles", - "cognito-identity:SetIdentityPoolRoles" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "IdentityPoolId": { - "$ref": "resource-schema.json#/properties/IdentityPoolId" - } - }, - "required": [ - "IdentityPoolId" - ] - }, - "permissions": [ - "cognito-identity:GetIdentityPoolRoles" - ] - }, - "read": { - "permissions": [ - "cognito-identity:GetIdentityPoolRoles" - ] - }, - "update": { - "permissions": [ - "cognito-identity:GetIdentityPoolRoles", - "cognito-identity:SetIdentityPoolRoles", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "IdentityPoolId": { - "type": "string" - }, - "RoleMappings": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/RoleMapping" - } - } - }, - "Roles": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "type": "string" - } - } - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "IdentityPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::IdentityPoolRoleAttachment" -} +{ + "additionalIdentifiers": [ + [ + "/properties/IdentityPoolId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityPoolId" + ], + "definitions": { + "MappingRule": { + "additionalProperties": false, + "properties": { + "Claim": { + "type": "string" + }, + "MatchType": { + "type": "string" + }, + "RoleARN": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Claim", + "MatchType", + "RoleARN", + "Value" + ], + "type": "object" + }, + "RoleMapping": { + "additionalProperties": false, + "properties": { + "AmbiguousRoleResolution": { + "type": "string" + }, + "IdentityProvider": { + "type": "string" + }, + "RulesConfiguration": { + "$ref": "#/definitions/RulesConfigurationType" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "RulesConfigurationType": { + "additionalProperties": false, + "properties": { + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MappingRule" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Rules" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IdentityPoolId": { + "$ref": "resource-schema.json#/properties/IdentityPoolId" + } + }, + "required": [ + "IdentityPoolId" + ] + }, + "permissions": [ + "cognito-identity:GetIdentityPoolRoles" + ] + }, + "read": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles" + ] + }, + "update": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "IdentityPoolId": { + "type": "string" + }, + "RoleMappings": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/RoleMapping" + } + } + }, + "Roles": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "type": "string" + } + } + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IdentityPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::IdentityPoolRoleAttachment" +} diff --git a/schema/aws-cognito-logdeliveryconfiguration.json b/schema/aws-cognito-logdeliveryconfiguration.json index 7825c7a..ee773f1 100644 --- a/schema/aws-cognito-logdeliveryconfiguration.json +++ b/schema/aws-cognito-logdeliveryconfiguration.json @@ -1,119 +1,164 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId" - ], - "definitions": { - "CloudWatchLogsConfiguration": { - "additionalProperties": false, - "properties": { - "LogGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsConfiguration": { - "$ref": "#/definitions/CloudWatchLogsConfiguration" - }, - "EventSource": { - "type": "string" - }, - "LogLevel": { - "type": "string" - } - }, - "type": "object" - }, - "LogConfigurations": { - "items": { - "$ref": "#/definitions/LogConfiguration" - }, - "type": "array" - } - }, - "description": "Resource Type definition for AWS::Cognito::LogDeliveryConfiguration", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:GetLogDeliveryConfiguration", - "cognito-idp:SetLogDeliveryConfiguration", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:GetLogDeliveryConfiguration", - "cognito-idp:SetLogDeliveryConfiguration", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups" - ], - "timeoutInMinutes": 2 - }, - "read": { - "permissions": [ - "cognito-idp:GetLogDeliveryConfiguration" - ] - }, - "update": { - "permissions": [ - "cognito-idp:GetLogDeliveryConfiguration", - "cognito-idp:SetLogDeliveryConfiguration", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "LogConfigurations": { - "$ref": "#/definitions/LogConfigurations" - }, - "UserPoolId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "UserPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::LogDeliveryConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId" + ], + "definitions": { + "CloudWatchLogsConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupArn": { + "type": "string" + } + }, + "type": "object" + }, + "FirehoseConfiguration": { + "additionalProperties": false, + "properties": { + "StreamArn": { + "type": "string" + } + }, + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsConfiguration": { + "$ref": "#/definitions/CloudWatchLogsConfiguration" + }, + "EventSource": { + "type": "string" + }, + "FirehoseConfiguration": { + "$ref": "#/definitions/FirehoseConfiguration" + }, + "LogLevel": { + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3Configuration" + } + }, + "type": "object" + }, + "LogConfigurations": { + "items": { + "$ref": "#/definitions/LogConfiguration" + }, + "type": "array" + }, + "S3Configuration": { + "additionalProperties": false, + "properties": { + "BucketArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::LogDeliveryConfiguration", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:GetLogDeliveryConfiguration", + "cognito-idp:SetLogDeliveryConfiguration", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:ListBucket", + "s3:PutObject", + "s3:GetBucketAcl", + "firehose:TagDeliveryStream", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:GetLogDeliveryConfiguration", + "cognito-idp:SetLogDeliveryConfiguration", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:ListBucket", + "s3:PutObject", + "s3:GetBucketAcl", + "firehose:TagDeliveryStream", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2 + }, + "read": { + "permissions": [ + "cognito-idp:GetLogDeliveryConfiguration" + ] + }, + "update": { + "permissions": [ + "cognito-idp:GetLogDeliveryConfiguration", + "cognito-idp:SetLogDeliveryConfiguration", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:ListBucket", + "s3:PutObject", + "s3:GetBucketAcl", + "firehose:TagDeliveryStream", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "LogConfigurations": { + "$ref": "#/definitions/LogConfigurations" + }, + "UserPoolId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "UserPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::LogDeliveryConfiguration" +} diff --git a/schema/aws-cognito-userpool.json b/schema/aws-cognito-userpool.json index 0fb56c2..9aecad3 100644 --- a/schema/aws-cognito-userpool.json +++ b/schema/aws-cognito-userpool.json @@ -1,516 +1,538 @@ -{ - "additionalProperties": false, - "definitions": { - "AccountRecoverySetting": { - "additionalProperties": false, - "properties": { - "RecoveryMechanisms": { - "items": { - "$ref": "#/definitions/RecoveryOption" - }, - "type": "array" - } - }, - "type": "object" - }, - "AdminCreateUserConfig": { - "additionalProperties": false, - "properties": { - "AllowAdminCreateUserOnly": { - "type": "boolean" - }, - "InviteMessageTemplate": { - "$ref": "#/definitions/InviteMessageTemplate" - }, - "UnusedAccountValidityDays": { - "type": "integer" - } - }, - "type": "object" - }, - "CustomEmailSender": { - "additionalProperties": false, - "properties": { - "LambdaArn": { - "type": "string" - }, - "LambdaVersion": { - "type": "string" - } - }, - "type": "object" - }, - "CustomSMSSender": { - "additionalProperties": false, - "properties": { - "LambdaArn": { - "type": "string" - }, - "LambdaVersion": { - "type": "string" - } - }, - "type": "object" - }, - "DeviceConfiguration": { - "additionalProperties": false, - "properties": { - "ChallengeRequiredOnNewDevice": { - "type": "boolean" - }, - "DeviceOnlyRememberedOnUserPrompt": { - "type": "boolean" - } - }, - "type": "object" - }, - "EmailConfiguration": { - "additionalProperties": false, - "properties": { - "ConfigurationSet": { - "type": "string" - }, - "EmailSendingAccount": { - "type": "string" - }, - "From": { - "type": "string" - }, - "ReplyToEmailAddress": { - "type": "string" - }, - "SourceArn": { - "type": "string" - } - }, - "type": "object" - }, - "InviteMessageTemplate": { - "additionalProperties": false, - "properties": { - "EmailMessage": { - "type": "string" - }, - "EmailSubject": { - "type": "string" - }, - "SMSMessage": { - "type": "string" - } - }, - "type": "object" - }, - "LambdaConfig": { - "additionalProperties": false, - "properties": { - "CreateAuthChallenge": { - "type": "string" - }, - "CustomEmailSender": { - "$ref": "#/definitions/CustomEmailSender" - }, - "CustomMessage": { - "type": "string" - }, - "CustomSMSSender": { - "$ref": "#/definitions/CustomSMSSender" - }, - "DefineAuthChallenge": { - "type": "string" - }, - "KMSKeyID": { - "type": "string" - }, - "PostAuthentication": { - "type": "string" - }, - "PostConfirmation": { - "type": "string" - }, - "PreAuthentication": { - "type": "string" - }, - "PreSignUp": { - "type": "string" - }, - "PreTokenGeneration": { - "type": "string" - }, - "PreTokenGenerationConfig": { - "$ref": "#/definitions/PreTokenGenerationConfig" - }, - "UserMigration": { - "type": "string" - }, - "VerifyAuthChallengeResponse": { - "type": "string" - } - }, - "type": "object" - }, - "NumberAttributeConstraints": { - "additionalProperties": false, - "properties": { - "MaxValue": { - "type": "string" - }, - "MinValue": { - "type": "string" - } - }, - "type": "object" - }, - "PasswordPolicy": { - "additionalProperties": false, - "properties": { - "MinimumLength": { - "type": "integer" - }, - "RequireLowercase": { - "type": "boolean" - }, - "RequireNumbers": { - "type": "boolean" - }, - "RequireSymbols": { - "type": "boolean" - }, - "RequireUppercase": { - "type": "boolean" - }, - "TemporaryPasswordValidityDays": { - "type": "integer" - } - }, - "type": "object" - }, - "Policies": { - "additionalProperties": false, - "properties": { - "PasswordPolicy": { - "$ref": "#/definitions/PasswordPolicy" - } - }, - "type": "object" - }, - "PreTokenGenerationConfig": { - "additionalProperties": false, - "properties": { - "LambdaArn": { - "type": "string" - }, - "LambdaVersion": { - "type": "string" - } - }, - "type": "object" - }, - "RecoveryOption": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Priority": { - "type": "integer" - } - }, - "type": "object" - }, - "SchemaAttribute": { - "additionalProperties": false, - "properties": { - "AttributeDataType": { - "type": "string" - }, - "DeveloperOnlyAttribute": { - "type": "boolean" - }, - "Mutable": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "NumberAttributeConstraints": { - "$ref": "#/definitions/NumberAttributeConstraints" - }, - "Required": { - "type": "boolean" - }, - "StringAttributeConstraints": { - "$ref": "#/definitions/StringAttributeConstraints" - } - }, - "type": "object" - }, - "SmsConfiguration": { - "additionalProperties": false, - "properties": { - "ExternalId": { - "type": "string" - }, - "SnsCallerArn": { - "type": "string" - }, - "SnsRegion": { - "type": "string" - } - }, - "type": "object" - }, - "StringAttributeConstraints": { - "additionalProperties": false, - "properties": { - "MaxLength": { - "type": "string" - }, - "MinLength": { - "type": "string" - } - }, - "type": "object" - }, - "UserAttributeUpdateSettings": { - "additionalProperties": false, - "properties": { - "AttributesRequireVerificationBeforeUpdate": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "AttributesRequireVerificationBeforeUpdate" - ], - "type": "object" - }, - "UserPoolAddOns": { - "additionalProperties": false, - "properties": { - "AdvancedSecurityMode": { - "type": "string" - } - }, - "type": "object" - }, - "UsernameConfiguration": { - "additionalProperties": false, - "properties": { - "CaseSensitive": { - "type": "boolean" - } - }, - "type": "object" - }, - "VerificationMessageTemplate": { - "additionalProperties": false, - "properties": { - "DefaultEmailOption": { - "type": "string" - }, - "EmailMessage": { - "type": "string" - }, - "EmailMessageByLink": { - "type": "string" - }, - "EmailSubject": { - "type": "string" - }, - "EmailSubjectByLink": { - "type": "string" - }, - "SmsMessage": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPool", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:CreateUserPool", - "iam:PassRole", - "cognito-idp:SetUserPoolMfaConfig", - "cognito-idp:DescribeUserPool", - "kms:CreateGrant", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:DeleteUserPool" - ], - "timeoutInMinutes": 2 - }, - "list": { - "permissions": [ - "cognito-idp:ListUserPools" - ] - }, - "read": { - "permissions": [ - "cognito-idp:DescribeUserPool" - ] - }, - "update": { - "permissions": [ - "cognito-idp:UpdateUserPool", - "cognito-idp:ListTagsForResource", - "cognito-idp:UntagResource", - "cognito-idp:TagResource", - "cognito-idp:SetUserPoolMfaConfig", - "cognito-idp:AddCustomAttributes", - "cognito-idp:DescribeUserPool", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId" - ], - "properties": { - "AccountRecoverySetting": { - "$ref": "#/definitions/AccountRecoverySetting" - }, - "AdminCreateUserConfig": { - "$ref": "#/definitions/AdminCreateUserConfig" - }, - "AliasAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Arn": { - "type": "string" - }, - "AutoVerifiedAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DeletionProtection": { - "type": "string" - }, - "DeviceConfiguration": { - "$ref": "#/definitions/DeviceConfiguration" - }, - "EmailConfiguration": { - "$ref": "#/definitions/EmailConfiguration" - }, - "EmailVerificationMessage": { - "maxLength": 20000, - "minLength": 6, - "type": "string" - }, - "EmailVerificationSubject": { - "maxLength": 140, - "minLength": 1, - "type": "string" - }, - "EnabledMfas": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LambdaConfig": { - "$ref": "#/definitions/LambdaConfig" - }, - "MfaConfiguration": { - "type": "string" - }, - "Policies": { - "$ref": "#/definitions/Policies" - }, - "ProviderName": { - "type": "string" - }, - "ProviderURL": { - "type": "string" - }, - "Schema": { - "items": { - "$ref": "#/definitions/SchemaAttribute" - }, - "type": "array" - }, - "SmsAuthenticationMessage": { - "maxLength": 140, - "minLength": 6, - "type": "string" - }, - "SmsConfiguration": { - "$ref": "#/definitions/SmsConfiguration" - }, - "SmsVerificationMessage": { - "maxLength": 140, - "minLength": 6, - "type": "string" - }, - "UserAttributeUpdateSettings": { - "$ref": "#/definitions/UserAttributeUpdateSettings" - }, - "UserPoolAddOns": { - "$ref": "#/definitions/UserPoolAddOns" - }, - "UserPoolId": { - "type": "string" - }, - "UserPoolName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "UserPoolTags": { - "additionalProperties": false, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - }, - "UsernameAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UsernameConfiguration": { - "$ref": "#/definitions/UsernameConfiguration" - }, - "VerificationMessageTemplate": { - "$ref": "#/definitions/VerificationMessageTemplate" - } - }, - "propertyTransform": { - "/properties/Schema/*/Name": "'custom:' & '' & Name" - }, - "readOnlyProperties": [ - "/properties/ProviderName", - "/properties/UserPoolId", - "/properties/ProviderURL", - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/UserPoolTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Cognito::UserPool", - "writeOnlyProperties": [ - "/properties/EnabledMfas" - ] -} +{ + "additionalProperties": false, + "definitions": { + "AccountRecoverySetting": { + "additionalProperties": false, + "properties": { + "RecoveryMechanisms": { + "items": { + "$ref": "#/definitions/RecoveryOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdminCreateUserConfig": { + "additionalProperties": false, + "properties": { + "AllowAdminCreateUserOnly": { + "type": "boolean" + }, + "InviteMessageTemplate": { + "$ref": "#/definitions/InviteMessageTemplate" + }, + "UnusedAccountValidityDays": { + "type": "integer" + } + }, + "type": "object" + }, + "AdvancedSecurityAdditionalFlows": { + "additionalProperties": false, + "properties": { + "CustomAuthMode": { + "type": "string" + } + }, + "type": "object" + }, + "CustomEmailSender": { + "additionalProperties": false, + "properties": { + "LambdaArn": { + "type": "string" + }, + "LambdaVersion": { + "type": "string" + } + }, + "type": "object" + }, + "CustomSMSSender": { + "additionalProperties": false, + "properties": { + "LambdaArn": { + "type": "string" + }, + "LambdaVersion": { + "type": "string" + } + }, + "type": "object" + }, + "DeviceConfiguration": { + "additionalProperties": false, + "properties": { + "ChallengeRequiredOnNewDevice": { + "type": "boolean" + }, + "DeviceOnlyRememberedOnUserPrompt": { + "type": "boolean" + } + }, + "type": "object" + }, + "EmailConfiguration": { + "additionalProperties": false, + "properties": { + "ConfigurationSet": { + "type": "string" + }, + "EmailSendingAccount": { + "type": "string" + }, + "From": { + "type": "string" + }, + "ReplyToEmailAddress": { + "type": "string" + }, + "SourceArn": { + "type": "string" + } + }, + "type": "object" + }, + "InviteMessageTemplate": { + "additionalProperties": false, + "properties": { + "EmailMessage": { + "type": "string" + }, + "EmailSubject": { + "type": "string" + }, + "SMSMessage": { + "type": "string" + } + }, + "type": "object" + }, + "LambdaConfig": { + "additionalProperties": false, + "properties": { + "CreateAuthChallenge": { + "type": "string" + }, + "CustomEmailSender": { + "$ref": "#/definitions/CustomEmailSender" + }, + "CustomMessage": { + "type": "string" + }, + "CustomSMSSender": { + "$ref": "#/definitions/CustomSMSSender" + }, + "DefineAuthChallenge": { + "type": "string" + }, + "KMSKeyID": { + "type": "string" + }, + "PostAuthentication": { + "type": "string" + }, + "PostConfirmation": { + "type": "string" + }, + "PreAuthentication": { + "type": "string" + }, + "PreSignUp": { + "type": "string" + }, + "PreTokenGeneration": { + "type": "string" + }, + "PreTokenGenerationConfig": { + "$ref": "#/definitions/PreTokenGenerationConfig" + }, + "UserMigration": { + "type": "string" + }, + "VerifyAuthChallengeResponse": { + "type": "string" + } + }, + "type": "object" + }, + "NumberAttributeConstraints": { + "additionalProperties": false, + "properties": { + "MaxValue": { + "type": "string" + }, + "MinValue": { + "type": "string" + } + }, + "type": "object" + }, + "PasswordPolicy": { + "additionalProperties": false, + "properties": { + "MinimumLength": { + "type": "integer" + }, + "PasswordHistorySize": { + "type": "integer" + }, + "RequireLowercase": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireSymbols": { + "type": "boolean" + }, + "RequireUppercase": { + "type": "boolean" + }, + "TemporaryPasswordValidityDays": { + "type": "integer" + } + }, + "type": "object" + }, + "Policies": { + "additionalProperties": false, + "properties": { + "PasswordPolicy": { + "$ref": "#/definitions/PasswordPolicy" + } + }, + "type": "object" + }, + "PreTokenGenerationConfig": { + "additionalProperties": false, + "properties": { + "LambdaArn": { + "type": "string" + }, + "LambdaVersion": { + "type": "string" + } + }, + "type": "object" + }, + "RecoveryOption": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Priority": { + "type": "integer" + } + }, + "type": "object" + }, + "SchemaAttribute": { + "additionalProperties": false, + "properties": { + "AttributeDataType": { + "type": "string" + }, + "DeveloperOnlyAttribute": { + "type": "boolean" + }, + "Mutable": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "NumberAttributeConstraints": { + "$ref": "#/definitions/NumberAttributeConstraints" + }, + "Required": { + "type": "boolean" + }, + "StringAttributeConstraints": { + "$ref": "#/definitions/StringAttributeConstraints" + } + }, + "type": "object" + }, + "SmsConfiguration": { + "additionalProperties": false, + "properties": { + "ExternalId": { + "type": "string" + }, + "SnsCallerArn": { + "type": "string" + }, + "SnsRegion": { + "type": "string" + } + }, + "type": "object" + }, + "StringAttributeConstraints": { + "additionalProperties": false, + "properties": { + "MaxLength": { + "type": "string" + }, + "MinLength": { + "type": "string" + } + }, + "type": "object" + }, + "UserAttributeUpdateSettings": { + "additionalProperties": false, + "properties": { + "AttributesRequireVerificationBeforeUpdate": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "AttributesRequireVerificationBeforeUpdate" + ], + "type": "object" + }, + "UserPoolAddOns": { + "additionalProperties": false, + "properties": { + "AdvancedSecurityAdditionalFlows": { + "$ref": "#/definitions/AdvancedSecurityAdditionalFlows" + }, + "AdvancedSecurityMode": { + "type": "string" + } + }, + "type": "object" + }, + "UsernameConfiguration": { + "additionalProperties": false, + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "type": "object" + }, + "VerificationMessageTemplate": { + "additionalProperties": false, + "properties": { + "DefaultEmailOption": { + "type": "string" + }, + "EmailMessage": { + "type": "string" + }, + "EmailMessageByLink": { + "type": "string" + }, + "EmailSubject": { + "type": "string" + }, + "EmailSubjectByLink": { + "type": "string" + }, + "SmsMessage": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Cognito::UserPool Resource Type", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:CreateUserPool", + "iam:PassRole", + "cognito-idp:SetUserPoolMfaConfig", + "cognito-idp:DescribeUserPool", + "kms:CreateGrant", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:DeleteUserPool" + ], + "timeoutInMinutes": 2 + }, + "list": { + "permissions": [ + "cognito-idp:ListUserPools" + ] + }, + "read": { + "permissions": [ + "cognito-idp:DescribeUserPool", + "cognito-idp:GetUserPoolMfaConfig" + ] + }, + "update": { + "permissions": [ + "cognito-idp:UpdateUserPool", + "cognito-idp:ListTagsForResource", + "cognito-idp:UntagResource", + "cognito-idp:TagResource", + "cognito-idp:SetUserPoolMfaConfig", + "cognito-idp:AddCustomAttributes", + "cognito-idp:DescribeUserPool", + "cognito-idp:GetUserPoolMfaConfig", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId" + ], + "properties": { + "AccountRecoverySetting": { + "$ref": "#/definitions/AccountRecoverySetting" + }, + "AdminCreateUserConfig": { + "$ref": "#/definitions/AdminCreateUserConfig" + }, + "AliasAttributes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Arn": { + "type": "string" + }, + "AutoVerifiedAttributes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "DeletionProtection": { + "type": "string" + }, + "DeviceConfiguration": { + "$ref": "#/definitions/DeviceConfiguration" + }, + "EmailConfiguration": { + "$ref": "#/definitions/EmailConfiguration" + }, + "EmailVerificationMessage": { + "maxLength": 20000, + "minLength": 6, + "type": "string" + }, + "EmailVerificationSubject": { + "maxLength": 140, + "minLength": 1, + "type": "string" + }, + "EnabledMfas": { + "items": { + "type": "string" + }, + "type": "array" + }, + "LambdaConfig": { + "$ref": "#/definitions/LambdaConfig" + }, + "MfaConfiguration": { + "type": "string" + }, + "Policies": { + "$ref": "#/definitions/Policies" + }, + "ProviderName": { + "type": "string" + }, + "ProviderURL": { + "type": "string" + }, + "Schema": { + "items": { + "$ref": "#/definitions/SchemaAttribute" + }, + "type": "array" + }, + "SmsAuthenticationMessage": { + "maxLength": 140, + "minLength": 6, + "type": "string" + }, + "SmsConfiguration": { + "$ref": "#/definitions/SmsConfiguration" + }, + "SmsVerificationMessage": { + "maxLength": 140, + "minLength": 6, + "type": "string" + }, + "UserAttributeUpdateSettings": { + "$ref": "#/definitions/UserAttributeUpdateSettings" + }, + "UserPoolAddOns": { + "$ref": "#/definitions/UserPoolAddOns" + }, + "UserPoolId": { + "type": "string" + }, + "UserPoolName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "UserPoolTags": { + "additionalProperties": false, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + }, + "UsernameAttributes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "UsernameConfiguration": { + "$ref": "#/definitions/UsernameConfiguration" + }, + "VerificationMessageTemplate": { + "$ref": "#/definitions/VerificationMessageTemplate" + } + }, + "propertyTransform": { + "/properties/Schema/*/Name": "'custom:' & '' & Name" + }, + "readOnlyProperties": [ + "/properties/ProviderName", + "/properties/UserPoolId", + "/properties/ProviderURL", + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "cognito-idp:ListTagsForResource", + "cognito-idp:UntagResource", + "cognito-idp:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/UserPoolTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Cognito::UserPool", + "writeOnlyProperties": [ + "/properties/EnabledMfas" + ] +} diff --git a/schema/aws-cognito-userpoolclient.json b/schema/aws-cognito-userpoolclient.json index 5814bc0..17737ca 100644 --- a/schema/aws-cognito-userpoolclient.json +++ b/schema/aws-cognito-userpoolclient.json @@ -1,224 +1,224 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GenerateSecret", - "/properties/UserPoolId" - ], - "definitions": { - "AnalyticsConfiguration": { - "additionalProperties": false, - "properties": { - "ApplicationArn": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "ExternalId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UserDataShared": { - "type": "boolean" - } - }, - "type": "object" - }, - "TokenValidityUnits": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "IdToken": { - "type": "string" - }, - "RefreshToken": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPoolClient", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:CreateUserPoolClient", - "iam:PassRole", - "iam:PutRolePolicy", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:DeleteUserPoolClient", - "iam:PutRolePolicy", - "iam:DeleteRolePolicy" - ], - "timeoutInMinutes": 2 - }, - "list": { - "handlerSchema": { - "properties": { - "UserPoolId": { - "$ref": "resource-schema.json#/properties/UserPoolId" - } - }, - "required": [ - "UserPoolId" - ] - }, - "permissions": [ - "cognito-idp:ListUserPoolClients" - ] - }, - "read": { - "permissions": [ - "cognito-idp:DescribeUserPoolClient" - ] - }, - "update": { - "permissions": [ - "cognito-idp:UpdateUserPoolClient", - "iam:PassRole", - "iam:PutRolePolicy" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/ClientId" - ], - "properties": { - "AccessTokenValidity": { - "maximum": 86400, - "minimum": 1, - "type": "integer" - }, - "AllowedOAuthFlows": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedOAuthFlowsUserPoolClient": { - "type": "boolean" - }, - "AllowedOAuthScopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AnalyticsConfiguration": { - "$ref": "#/definitions/AnalyticsConfiguration" - }, - "AuthSessionValidity": { - "maximum": 15, - "minimum": 3, - "type": "integer" - }, - "CallbackURLs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClientId": { - "type": "string" - }, - "ClientName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "DefaultRedirectURI": { - "type": "string" - }, - "EnablePropagateAdditionalUserContextData": { - "type": "boolean" - }, - "EnableTokenRevocation": { - "type": "boolean" - }, - "ExplicitAuthFlows": { - "items": { - "type": "string" - }, - "type": "array" - }, - "GenerateSecret": { - "type": "boolean" - }, - "IdTokenValidity": { - "maximum": 86400, - "minimum": 1, - "type": "integer" - }, - "LogoutURLs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "PreventUserExistenceErrors": { - "type": "string" - }, - "ReadAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RefreshTokenValidity": { - "maximum": 315360000, - "minimum": 1, - "type": "integer" - }, - "SupportedIdentityProviders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TokenValidityUnits": { - "$ref": "#/definitions/TokenValidityUnits" - }, - "UserPoolId": { - "type": "string" - }, - "WriteAttributes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ClientSecret", - "/properties/Name", - "/properties/ClientId" - ], - "required": [ - "UserPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolClient" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GenerateSecret", + "/properties/UserPoolId" + ], + "definitions": { + "AnalyticsConfiguration": { + "additionalProperties": false, + "properties": { + "ApplicationArn": { + "type": "string" + }, + "ApplicationId": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "UserDataShared": { + "type": "boolean" + } + }, + "type": "object" + }, + "TokenValidityUnits": { + "additionalProperties": false, + "properties": { + "AccessToken": { + "type": "string" + }, + "IdToken": { + "type": "string" + }, + "RefreshToken": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolClient", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:CreateUserPoolClient", + "iam:PassRole", + "iam:PutRolePolicy", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:DeleteUserPoolClient", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy" + ], + "timeoutInMinutes": 2 + }, + "list": { + "handlerSchema": { + "properties": { + "UserPoolId": { + "$ref": "resource-schema.json#/properties/UserPoolId" + } + }, + "required": [ + "UserPoolId" + ] + }, + "permissions": [ + "cognito-idp:ListUserPoolClients" + ] + }, + "read": { + "permissions": [ + "cognito-idp:DescribeUserPoolClient" + ] + }, + "update": { + "permissions": [ + "cognito-idp:UpdateUserPoolClient", + "iam:PassRole", + "iam:PutRolePolicy" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "properties": { + "AccessTokenValidity": { + "maximum": 86400, + "minimum": 1, + "type": "integer" + }, + "AllowedOAuthFlows": { + "items": { + "type": "string" + }, + "type": "array" + }, + "AllowedOAuthFlowsUserPoolClient": { + "type": "boolean" + }, + "AllowedOAuthScopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "AnalyticsConfiguration": { + "$ref": "#/definitions/AnalyticsConfiguration" + }, + "AuthSessionValidity": { + "maximum": 15, + "minimum": 3, + "type": "integer" + }, + "CallbackURLs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ClientId": { + "type": "string" + }, + "ClientName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ClientSecret": { + "type": "string" + }, + "DefaultRedirectURI": { + "type": "string" + }, + "EnablePropagateAdditionalUserContextData": { + "type": "boolean" + }, + "EnableTokenRevocation": { + "type": "boolean" + }, + "ExplicitAuthFlows": { + "items": { + "type": "string" + }, + "type": "array" + }, + "GenerateSecret": { + "type": "boolean" + }, + "IdTokenValidity": { + "maximum": 86400, + "minimum": 1, + "type": "integer" + }, + "LogoutURLs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "type": "string" + }, + "PreventUserExistenceErrors": { + "type": "string" + }, + "ReadAttributes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "RefreshTokenValidity": { + "maximum": 315360000, + "minimum": 1, + "type": "integer" + }, + "SupportedIdentityProviders": { + "items": { + "type": "string" + }, + "type": "array" + }, + "TokenValidityUnits": { + "$ref": "#/definitions/TokenValidityUnits" + }, + "UserPoolId": { + "type": "string" + }, + "WriteAttributes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ClientSecret", + "/properties/Name", + "/properties/ClientId" + ], + "required": [ + "UserPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolClient" +} diff --git a/schema/aws-cognito-userpooldomain.json b/schema/aws-cognito-userpooldomain.json index ea5e9f6..3b6387a 100644 --- a/schema/aws-cognito-userpooldomain.json +++ b/schema/aws-cognito-userpooldomain.json @@ -1,48 +1,48 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/Domain" - ], - "definitions": { - "CustomDomainConfigType": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPoolDomain", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CloudFrontDistribution": { - "type": "string" - }, - "CustomDomainConfig": { - "$ref": "#/definitions/CustomDomainConfigType" - }, - "Domain": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/CloudFrontDistribution" - ], - "required": [ - "UserPoolId", - "Domain" - ], - "typeName": "AWS::Cognito::UserPoolDomain" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/Domain" + ], + "definitions": { + "CustomDomainConfigType": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolDomain", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CloudFrontDistribution": { + "type": "string" + }, + "CustomDomainConfig": { + "$ref": "#/definitions/CustomDomainConfigType" + }, + "Domain": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CloudFrontDistribution" + ], + "required": [ + "UserPoolId", + "Domain" + ], + "typeName": "AWS::Cognito::UserPoolDomain" +} diff --git a/schema/aws-cognito-userpoolgroup.json b/schema/aws-cognito-userpoolgroup.json index bbeed9f..e7ba2b8 100644 --- a/schema/aws-cognito-userpoolgroup.json +++ b/schema/aws-cognito-userpoolgroup.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/GroupName" - ], - "description": "Resource Type definition for AWS::Cognito::UserPoolGroup", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:CreateGroup", - "iam:PassRole", - "iam:PutRolePolicy", - "cognito-idp:GetGroup" - ], - "timeoutInMinutes": 5 - }, - "delete": { - "permissions": [ - "cognito-idp:DeleteGroup", - "cognito-idp:GetGroup", - "iam:PutRolePolicy" - ], - "timeoutInMinutes": 5 - }, - "list": { - "handlerSchema": { - "properties": { - "UserPoolId": { - "$ref": "resource-schema.json#/properties/UserPoolId" - } - }, - "required": [ - "UserPoolId" - ] - }, - "permissions": [ - "cognito-idp:ListGroups" - ] - }, - "read": { - "permissions": [ - "cognito-idp:GetGroup" - ] - }, - "update": { - "permissions": [ - "cognito-idp:UpdateGroup", - "iam:PassRole", - "iam:PutRolePolicy" - ], - "timeoutInMinutes": 5 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/GroupName" - ], - "properties": { - "Description": { - "maxLength": 2048, - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "Precedence": { - "minimum": 0, - "type": "integer" - }, - "RoleArn": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "UserPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/GroupName" + ], + "description": "Resource Type definition for AWS::Cognito::UserPoolGroup", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:CreateGroup", + "iam:PassRole", + "iam:PutRolePolicy", + "cognito-idp:GetGroup" + ], + "timeoutInMinutes": 5 + }, + "delete": { + "permissions": [ + "cognito-idp:DeleteGroup", + "cognito-idp:GetGroup", + "iam:PutRolePolicy" + ], + "timeoutInMinutes": 5 + }, + "list": { + "handlerSchema": { + "properties": { + "UserPoolId": { + "$ref": "resource-schema.json#/properties/UserPoolId" + } + }, + "required": [ + "UserPoolId" + ] + }, + "permissions": [ + "cognito-idp:ListGroups" + ] + }, + "read": { + "permissions": [ + "cognito-idp:GetGroup" + ] + }, + "update": { + "permissions": [ + "cognito-idp:UpdateGroup", + "iam:PassRole", + "iam:PutRolePolicy" + ], + "timeoutInMinutes": 5 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/GroupName" + ], + "properties": { + "Description": { + "maxLength": 2048, + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "Precedence": { + "minimum": 0, + "type": "integer" + }, + "RoleArn": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolGroup" +} diff --git a/schema/aws-cognito-userpoolidentityprovider.json b/schema/aws-cognito-userpoolidentityprovider.json index 66e2a43..27f9141 100644 --- a/schema/aws-cognito-userpoolidentityprovider.json +++ b/schema/aws-cognito-userpoolidentityprovider.json @@ -1,48 +1,48 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/ProviderName", - "/properties/ProviderType" - ], - "description": "Resource Type definition for AWS::Cognito::UserPoolIdentityProvider", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AttributeMapping": { - "type": "object" - }, - "Id": { - "type": "string" - }, - "IdpIdentifiers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ProviderDetails": { - "type": "object" - }, - "ProviderName": { - "type": "string" - }, - "ProviderType": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ProviderName", - "UserPoolId", - "ProviderType" - ], - "typeName": "AWS::Cognito::UserPoolIdentityProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/ProviderName", + "/properties/ProviderType" + ], + "description": "Resource Type definition for AWS::Cognito::UserPoolIdentityProvider", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AttributeMapping": { + "type": "object" + }, + "Id": { + "type": "string" + }, + "IdpIdentifiers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ProviderDetails": { + "type": "object" + }, + "ProviderName": { + "type": "string" + }, + "ProviderType": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ProviderName", + "UserPoolId", + "ProviderType" + ], + "typeName": "AWS::Cognito::UserPoolIdentityProvider" +} diff --git a/schema/aws-cognito-userpoolresourceserver.json b/schema/aws-cognito-userpoolresourceserver.json index f464ac3..598204d 100644 --- a/schema/aws-cognito-userpoolresourceserver.json +++ b/schema/aws-cognito-userpoolresourceserver.json @@ -1,102 +1,100 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/Identifier" - ], - "definitions": { - "ResourceServerScopeType": { - "additionalProperties": false, - "properties": { - "ScopeDescription": { - "type": "string" - }, - "ScopeName": { - "type": "string" - } - }, - "required": [ - "ScopeDescription", - "ScopeName" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPoolResourceServer", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:CreateResourceServer", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:DeleteResourceServer" - ], - "timeoutInMinutes": 2 - }, - "list": { - "handlerSchema": { - "properties": { - "UserPoolId": { - "$ref": "resource-schema.json#/properties/UserPoolId" - } - }, - "required": [ - "UserPoolId" - ] - }, - "permissions": [ - "cognito-idp:ListResourceServers" - ] - }, - "read": { - "permissions": [ - "cognito-idp:DescribeResourceServer" - ] - }, - "update": { - "permissions": [ - "cognito-idp:UpdateResourceServer", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/Identifier" - ], - "properties": { - "Identifier": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Scopes": { - "items": { - "$ref": "#/definitions/ResourceServerScopeType" - }, - "type": "array" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "UserPoolId", - "Identifier", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolResourceServer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/Identifier" + ], + "definitions": { + "ResourceServerScopeType": { + "additionalProperties": false, + "properties": { + "ScopeDescription": { + "type": "string" + }, + "ScopeName": { + "type": "string" + } + }, + "required": [ + "ScopeDescription", + "ScopeName" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolResourceServer", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:CreateResourceServer" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:DeleteResourceServer" + ], + "timeoutInMinutes": 2 + }, + "list": { + "handlerSchema": { + "properties": { + "UserPoolId": { + "$ref": "resource-schema.json#/properties/UserPoolId" + } + }, + "required": [ + "UserPoolId" + ] + }, + "permissions": [ + "cognito-idp:ListResourceServers" + ] + }, + "read": { + "permissions": [ + "cognito-idp:DescribeResourceServer" + ] + }, + "update": { + "permissions": [ + "cognito-idp:UpdateResourceServer" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/Identifier" + ], + "properties": { + "Identifier": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Scopes": { + "items": { + "$ref": "#/definitions/ResourceServerScopeType" + }, + "type": "array" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "Identifier", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolResourceServer" +} diff --git a/schema/aws-cognito-userpoolriskconfigurationattachment.json b/schema/aws-cognito-userpoolriskconfigurationattachment.json index 38d2ba2..dea40e3 100644 --- a/schema/aws-cognito-userpoolriskconfigurationattachment.json +++ b/schema/aws-cognito-userpoolriskconfigurationattachment.json @@ -1,215 +1,215 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/ClientId" - ], - "definitions": { - "AccountTakeoverActionType": { - "additionalProperties": false, - "properties": { - "EventAction": { - "type": "string" - }, - "Notify": { - "type": "boolean" - } - }, - "required": [ - "EventAction", - "Notify" - ], - "type": "object" - }, - "AccountTakeoverActionsType": { - "additionalProperties": false, - "properties": { - "HighAction": { - "$ref": "#/definitions/AccountTakeoverActionType" - }, - "LowAction": { - "$ref": "#/definitions/AccountTakeoverActionType" - }, - "MediumAction": { - "$ref": "#/definitions/AccountTakeoverActionType" - } - }, - "type": "object" - }, - "AccountTakeoverRiskConfigurationType": { - "additionalProperties": false, - "properties": { - "Actions": { - "$ref": "#/definitions/AccountTakeoverActionsType" - }, - "NotifyConfiguration": { - "$ref": "#/definitions/NotifyConfigurationType" - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "CompromisedCredentialsActionsType": { - "additionalProperties": false, - "properties": { - "EventAction": { - "type": "string" - } - }, - "required": [ - "EventAction" - ], - "type": "object" - }, - "CompromisedCredentialsRiskConfigurationType": { - "additionalProperties": false, - "properties": { - "Actions": { - "$ref": "#/definitions/CompromisedCredentialsActionsType" - }, - "EventFilter": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "NotifyConfigurationType": { - "additionalProperties": false, - "properties": { - "BlockEmail": { - "$ref": "#/definitions/NotifyEmailType" - }, - "From": { - "type": "string" - }, - "MfaEmail": { - "$ref": "#/definitions/NotifyEmailType" - }, - "NoActionEmail": { - "$ref": "#/definitions/NotifyEmailType" - }, - "ReplyTo": { - "type": "string" - }, - "SourceArn": { - "type": "string" - } - }, - "required": [ - "SourceArn" - ], - "type": "object" - }, - "NotifyEmailType": { - "additionalProperties": false, - "properties": { - "HtmlBody": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "TextBody": { - "type": "string" - } - }, - "required": [ - "Subject" - ], - "type": "object" - }, - "RiskExceptionConfigurationType": { - "additionalProperties": false, - "properties": { - "BlockedIPRangeList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SkippedIPRangeList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:SetRiskConfiguration", - "cognito-idp:DescribeRiskConfiguration", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:SetRiskConfiguration", - "cognito-idp:DescribeRiskConfiguration" - ], - "timeoutInMinutes": 2 - }, - "read": { - "permissions": [ - "cognito-idp:DescribeRiskConfiguration" - ] - }, - "update": { - "permissions": [ - "cognito-idp:SetRiskConfiguration", - "cognito-idp:DescribeRiskConfiguration", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/ClientId" - ], - "properties": { - "AccountTakeoverRiskConfiguration": { - "$ref": "#/definitions/AccountTakeoverRiskConfigurationType" - }, - "ClientId": { - "type": "string" - }, - "CompromisedCredentialsRiskConfiguration": { - "$ref": "#/definitions/CompromisedCredentialsRiskConfigurationType" - }, - "RiskExceptionConfiguration": { - "$ref": "#/definitions/RiskExceptionConfigurationType" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "UserPoolId", - "ClientId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "definitions": { + "AccountTakeoverActionType": { + "additionalProperties": false, + "properties": { + "EventAction": { + "type": "string" + }, + "Notify": { + "type": "boolean" + } + }, + "required": [ + "EventAction", + "Notify" + ], + "type": "object" + }, + "AccountTakeoverActionsType": { + "additionalProperties": false, + "properties": { + "HighAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + }, + "LowAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + }, + "MediumAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + } + }, + "type": "object" + }, + "AccountTakeoverRiskConfigurationType": { + "additionalProperties": false, + "properties": { + "Actions": { + "$ref": "#/definitions/AccountTakeoverActionsType" + }, + "NotifyConfiguration": { + "$ref": "#/definitions/NotifyConfigurationType" + } + }, + "required": [ + "Actions" + ], + "type": "object" + }, + "CompromisedCredentialsActionsType": { + "additionalProperties": false, + "properties": { + "EventAction": { + "type": "string" + } + }, + "required": [ + "EventAction" + ], + "type": "object" + }, + "CompromisedCredentialsRiskConfigurationType": { + "additionalProperties": false, + "properties": { + "Actions": { + "$ref": "#/definitions/CompromisedCredentialsActionsType" + }, + "EventFilter": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Actions" + ], + "type": "object" + }, + "NotifyConfigurationType": { + "additionalProperties": false, + "properties": { + "BlockEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "From": { + "type": "string" + }, + "MfaEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "NoActionEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "ReplyTo": { + "type": "string" + }, + "SourceArn": { + "type": "string" + } + }, + "required": [ + "SourceArn" + ], + "type": "object" + }, + "NotifyEmailType": { + "additionalProperties": false, + "properties": { + "HtmlBody": { + "type": "string" + }, + "Subject": { + "type": "string" + }, + "TextBody": { + "type": "string" + } + }, + "required": [ + "Subject" + ], + "type": "object" + }, + "RiskExceptionConfigurationType": { + "additionalProperties": false, + "properties": { + "BlockedIPRangeList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SkippedIPRangeList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration" + ], + "timeoutInMinutes": 2 + }, + "read": { + "permissions": [ + "cognito-idp:DescribeRiskConfiguration" + ] + }, + "update": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "properties": { + "AccountTakeoverRiskConfiguration": { + "$ref": "#/definitions/AccountTakeoverRiskConfigurationType" + }, + "ClientId": { + "type": "string" + }, + "CompromisedCredentialsRiskConfiguration": { + "$ref": "#/definitions/CompromisedCredentialsRiskConfigurationType" + }, + "RiskExceptionConfiguration": { + "$ref": "#/definitions/RiskExceptionConfigurationType" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "ClientId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" +} diff --git a/schema/aws-cognito-userpooluicustomizationattachment.json b/schema/aws-cognito-userpooluicustomizationattachment.json index 7479de7..e9b1bca 100644 --- a/schema/aws-cognito-userpooluicustomizationattachment.json +++ b/schema/aws-cognito-userpooluicustomizationattachment.json @@ -1,62 +1,62 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/ClientId" - ], - "description": "Resource Type definition for AWS::Cognito::UserPoolUICustomizationAttachment", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:SetUICustomization", - "cognito-idp:GetUICustomization" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:SetUICustomization", - "cognito-idp:GetUICustomization" - ], - "timeoutInMinutes": 2 - }, - "read": { - "permissions": [ - "cognito-idp:GetUICustomization" - ] - }, - "update": { - "permissions": [ - "cognito-idp:SetUICustomization" - ], - "timeoutInMinutes": 2 - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/ClientId" - ], - "properties": { - "CSS": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "UserPoolId", - "ClientId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolUICustomizationAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "description": "Resource Type definition for AWS::Cognito::UserPoolUICustomizationAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:SetUICustomization", + "cognito-idp:GetUICustomization" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:SetUICustomization", + "cognito-idp:GetUICustomization" + ], + "timeoutInMinutes": 2 + }, + "read": { + "permissions": [ + "cognito-idp:GetUICustomization" + ] + }, + "update": { + "permissions": [ + "cognito-idp:SetUICustomization" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "properties": { + "CSS": { + "type": "string" + }, + "ClientId": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "ClientId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolUICustomizationAttachment" +} diff --git a/schema/aws-cognito-userpooluser.json b/schema/aws-cognito-userpooluser.json index c0b74ba..78967ac 100644 --- a/schema/aws-cognito-userpooluser.json +++ b/schema/aws-cognito-userpooluser.json @@ -1,127 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DesiredDeliveryMediums", - "/properties/ForceAliasCreation", - "/properties/UserAttributes", - "/properties/Username", - "/properties/UserPoolId", - "/properties/ValidationData", - "/properties/ClientMetadata", - "/properties/MessageAction" - ], - "definitions": { - "AttributeType": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Cognito::UserPoolUser", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:AdminCreateUser", - "cognito-idp:AdminGetUser", - "iam:PassRole" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:AdminDeleteUser" - ], - "timeoutInMinutes": 2 - }, - "list": { - "handlerSchema": { - "properties": { - "UserPoolId": { - "$ref": "resource-schema.json#/properties/UserPoolId" - } - }, - "required": [ - "UserPoolId" - ] - }, - "permissions": [ - "cognito-idp:ListUsers" - ] - }, - "read": { - "permissions": [ - "cognito-idp:AdminGetUser" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/Username" - ], - "properties": { - "ClientMetadata": { - "additionalProperties": false, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - }, - "DesiredDeliveryMediums": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ForceAliasCreation": { - "type": "boolean" - }, - "MessageAction": { - "type": "string" - }, - "UserAttributes": { - "items": { - "$ref": "#/definitions/AttributeType" - }, - "type": "array" - }, - "UserPoolId": { - "type": "string" - }, - "Username": { - "type": "string" - }, - "ValidationData": { - "items": { - "$ref": "#/definitions/AttributeType" - }, - "type": "array" - } - }, - "required": [ - "UserPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolUser", - "writeOnlyProperties": [ - "/properties/DesiredDeliveryMediums", - "/properties/ForceAliasCreation", - "/properties/ValidationData", - "/properties/ClientMetadata", - "/properties/MessageAction" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DesiredDeliveryMediums", + "/properties/ForceAliasCreation", + "/properties/UserAttributes", + "/properties/Username", + "/properties/UserPoolId", + "/properties/ValidationData", + "/properties/ClientMetadata", + "/properties/MessageAction" + ], + "definitions": { + "AttributeType": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolUser", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:AdminCreateUser", + "cognito-idp:AdminGetUser", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:AdminDeleteUser" + ], + "timeoutInMinutes": 2 + }, + "list": { + "handlerSchema": { + "properties": { + "UserPoolId": { + "$ref": "resource-schema.json#/properties/UserPoolId" + } + }, + "required": [ + "UserPoolId" + ] + }, + "permissions": [ + "cognito-idp:ListUsers" + ] + }, + "read": { + "permissions": [ + "cognito-idp:AdminGetUser" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/Username" + ], + "properties": { + "ClientMetadata": { + "additionalProperties": false, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + }, + "DesiredDeliveryMediums": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ForceAliasCreation": { + "type": "boolean" + }, + "MessageAction": { + "type": "string" + }, + "UserAttributes": { + "items": { + "$ref": "#/definitions/AttributeType" + }, + "type": "array" + }, + "UserPoolId": { + "type": "string" + }, + "Username": { + "type": "string" + }, + "ValidationData": { + "items": { + "$ref": "#/definitions/AttributeType" + }, + "type": "array" + } + }, + "required": [ + "UserPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolUser", + "writeOnlyProperties": [ + "/properties/DesiredDeliveryMediums", + "/properties/ForceAliasCreation", + "/properties/ValidationData", + "/properties/ClientMetadata", + "/properties/MessageAction" + ] +} diff --git a/schema/aws-cognito-userpoolusertogroupattachment.json b/schema/aws-cognito-userpoolusertogroupattachment.json index 67178cf..675dd08 100644 --- a/schema/aws-cognito-userpoolusertogroupattachment.json +++ b/schema/aws-cognito-userpoolusertogroupattachment.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserPoolId", - "/properties/GroupName", - "/properties/Username" - ], - "description": "Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment", - "handlers": { - "create": { - "permissions": [ - "cognito-idp:AdminAddUserToGroup", - "cognito-idp:AdminListGroupsForUser" - ], - "timeoutInMinutes": 2 - }, - "delete": { - "permissions": [ - "cognito-idp:AdminRemoveUserFromGroup", - "cognito-idp:AdminListGroupsForUser" - ], - "timeoutInMinutes": 2 - }, - "read": { - "permissions": [ - "cognito-idp:AdminListGroupsForUser" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserPoolId", - "/properties/GroupName", - "/properties/Username" - ], - "properties": { - "GroupName": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "UserPoolId", - "Username", - "GroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Cognito::UserPoolUserToGroupAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/GroupName", + "/properties/Username" + ], + "description": "Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:AdminAddUserToGroup", + "cognito-idp:AdminListGroupsForUser" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:AdminRemoveUserFromGroup", + "cognito-idp:AdminListGroupsForUser" + ], + "timeoutInMinutes": 2 + }, + "read": { + "permissions": [ + "cognito-idp:AdminListGroupsForUser" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/GroupName", + "/properties/Username" + ], + "properties": { + "GroupName": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "Username", + "GroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolUserToGroupAttachment" +} diff --git a/schema/aws-comprehend-documentclassifier.json b/schema/aws-comprehend-documentclassifier.json index 50d8884..593c3c2 100644 --- a/schema/aws-comprehend-documentclassifier.json +++ b/schema/aws-comprehend-documentclassifier.json @@ -1,365 +1,365 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataAccessRoleArn", - "/properties/InputDataConfig", - "/properties/OutputDataConfig", - "/properties/LanguageCode", - "/properties/ModelKmsKeyId", - "/properties/DocumentClassifierName", - "/properties/VersionName", - "/properties/Mode", - "/properties/VolumeKmsKeyId", - "/properties/VpcConfig" - ], - "definitions": { - "AugmentedManifestsListItem": { - "additionalProperties": false, - "properties": { - "AttributeNames": { - "insertionOrder": false, - "items": { - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "maxItems": 63, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "S3Uri": { - "$ref": "#/definitions/S3Uri" - }, - "Split": { - "enum": [ - "TRAIN", - "TEST" - ], - "type": "string" - } - }, - "required": [ - "AttributeNames", - "S3Uri" - ], - "type": "object" - }, - "DocumentClassifierDocuments": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "$ref": "#/definitions/S3Uri" - }, - "TestS3Uri": { - "$ref": "#/definitions/S3Uri" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "DocumentClassifierInputDataConfig": { - "additionalProperties": false, - "properties": { - "AugmentedManifests": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AugmentedManifestsListItem" - }, - "type": "array", - "uniqueItems": true - }, - "DataFormat": { - "enum": [ - "COMPREHEND_CSV", - "AUGMENTED_MANIFEST" - ], - "type": "string" - }, - "DocumentReaderConfig": { - "$ref": "#/definitions/DocumentReaderConfig" - }, - "DocumentType": { - "enum": [ - "PLAIN_TEXT_DOCUMENT", - "SEMI_STRUCTURED_DOCUMENT" - ], - "type": "string" - }, - "Documents": { - "$ref": "#/definitions/DocumentClassifierDocuments" - }, - "LabelDelimiter": { - "maxLength": 1, - "minLength": 1, - "pattern": "^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$", - "type": "string" - }, - "S3Uri": { - "$ref": "#/definitions/S3Uri" - }, - "TestS3Uri": { - "$ref": "#/definitions/S3Uri" - } - }, - "required": [], - "type": "object" - }, - "DocumentClassifierOutputDataConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "S3Uri": { - "$ref": "#/definitions/S3Uri" - } - }, - "required": [], - "type": "object" - }, - "DocumentReaderConfig": { - "additionalProperties": false, - "properties": { - "DocumentReadAction": { - "enum": [ - "TEXTRACT_DETECT_DOCUMENT_TEXT", - "TEXTRACT_ANALYZE_DOCUMENT" - ], - "type": "string" - }, - "DocumentReadMode": { - "enum": [ - "SERVICE_DEFAULT", - "FORCE_DOCUMENT_READ_ACTION" - ], - "type": "string" - }, - "FeatureTypes": { - "insertionOrder": false, - "items": { - "enum": [ - "TABLES", - "FORMS" - ], - "type": "string" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "DocumentReadAction" - ], - "type": "object" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "S3Uri": { - "maxLength": 1024, - "pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - } - }, - "description": "Document Classifier enables training document classifier models.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "comprehend:CreateDocumentClassifier", - "comprehend:DescribeDocumentClassifier", - "comprehend:DescribeResourcePolicy", - "comprehend:ListTagsForResource", - "textract:DetectDocumentText" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "comprehend:DescribeDocumentClassifier", - "comprehend:DeleteDocumentClassifier" - ], - "timeoutInMinutes": 120 - }, - "list": { - "permissions": [ - "comprehend:ListDocumentClassifiers" - ] - }, - "read": { - "permissions": [ - "comprehend:DescribeDocumentClassifier", - "comprehend:DescribeResourcePolicy", - "comprehend:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "comprehend:PutResourcePolicy", - "comprehend:DeleteResourcePolicy", - "comprehend:DescribeResourcePolicy", - "comprehend:DescribeDocumentClassifier", - "comprehend:ListTagsForResource", - "comprehend:TagResource", - "comprehend:UntagResource" - ], - "timeoutInMinutes": 10 - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 256, - "minLength": 1, - "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?", - "type": "string" - }, - "DataAccessRoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", - "type": "string" - }, - "DocumentClassifierName": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "InputDataConfig": { - "$ref": "#/definitions/DocumentClassifierInputDataConfig" - }, - "LanguageCode": { - "enum": [ - "en", - "es", - "fr", - "it", - "de", - "pt" - ], - "type": "string" - }, - "Mode": { - "enum": [ - "MULTI_CLASS", - "MULTI_LABEL" - ], - "type": "string" - }, - "ModelKmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "ModelPolicy": { - "maxLength": 20000, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "type": "string" - }, - "OutputDataConfig": { - "$ref": "#/definitions/DocumentClassifierOutputDataConfig" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VersionName": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "VolumeKmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "DocumentClassifierName", - "DataAccessRoleArn", - "InputDataConfig", - "LanguageCode" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Comprehend::DocumentClassifier" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataAccessRoleArn", + "/properties/InputDataConfig", + "/properties/OutputDataConfig", + "/properties/LanguageCode", + "/properties/ModelKmsKeyId", + "/properties/DocumentClassifierName", + "/properties/VersionName", + "/properties/Mode", + "/properties/VolumeKmsKeyId", + "/properties/VpcConfig" + ], + "definitions": { + "AugmentedManifestsListItem": { + "additionalProperties": false, + "properties": { + "AttributeNames": { + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "maxItems": 63, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "S3Uri": { + "$ref": "#/definitions/S3Uri" + }, + "Split": { + "enum": [ + "TRAIN", + "TEST" + ], + "type": "string" + } + }, + "required": [ + "AttributeNames", + "S3Uri" + ], + "type": "object" + }, + "DocumentClassifierDocuments": { + "additionalProperties": false, + "properties": { + "S3Uri": { + "$ref": "#/definitions/S3Uri" + }, + "TestS3Uri": { + "$ref": "#/definitions/S3Uri" + } + }, + "required": [ + "S3Uri" + ], + "type": "object" + }, + "DocumentClassifierInputDataConfig": { + "additionalProperties": false, + "properties": { + "AugmentedManifests": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AugmentedManifestsListItem" + }, + "type": "array", + "uniqueItems": true + }, + "DataFormat": { + "enum": [ + "COMPREHEND_CSV", + "AUGMENTED_MANIFEST" + ], + "type": "string" + }, + "DocumentReaderConfig": { + "$ref": "#/definitions/DocumentReaderConfig" + }, + "DocumentType": { + "enum": [ + "PLAIN_TEXT_DOCUMENT", + "SEMI_STRUCTURED_DOCUMENT" + ], + "type": "string" + }, + "Documents": { + "$ref": "#/definitions/DocumentClassifierDocuments" + }, + "LabelDelimiter": { + "maxLength": 1, + "minLength": 1, + "pattern": "^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$", + "type": "string" + }, + "S3Uri": { + "$ref": "#/definitions/S3Uri" + }, + "TestS3Uri": { + "$ref": "#/definitions/S3Uri" + } + }, + "required": [], + "type": "object" + }, + "DocumentClassifierOutputDataConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "S3Uri": { + "$ref": "#/definitions/S3Uri" + } + }, + "required": [], + "type": "object" + }, + "DocumentReaderConfig": { + "additionalProperties": false, + "properties": { + "DocumentReadAction": { + "enum": [ + "TEXTRACT_DETECT_DOCUMENT_TEXT", + "TEXTRACT_ANALYZE_DOCUMENT" + ], + "type": "string" + }, + "DocumentReadMode": { + "enum": [ + "SERVICE_DEFAULT", + "FORCE_DOCUMENT_READ_ACTION" + ], + "type": "string" + }, + "FeatureTypes": { + "insertionOrder": false, + "items": { + "enum": [ + "TABLES", + "FORMS" + ], + "type": "string" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "DocumentReadAction" + ], + "type": "object" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "S3Uri": { + "maxLength": 1024, + "pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "Document Classifier enables training document classifier models.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "comprehend:CreateDocumentClassifier", + "comprehend:DescribeDocumentClassifier", + "comprehend:DescribeResourcePolicy", + "comprehend:ListTagsForResource", + "textract:DetectDocumentText" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "comprehend:DescribeDocumentClassifier", + "comprehend:DeleteDocumentClassifier" + ], + "timeoutInMinutes": 120 + }, + "list": { + "permissions": [ + "comprehend:ListDocumentClassifiers" + ] + }, + "read": { + "permissions": [ + "comprehend:DescribeDocumentClassifier", + "comprehend:DescribeResourcePolicy", + "comprehend:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "comprehend:PutResourcePolicy", + "comprehend:DeleteResourcePolicy", + "comprehend:DescribeResourcePolicy", + "comprehend:DescribeDocumentClassifier", + "comprehend:ListTagsForResource", + "comprehend:TagResource", + "comprehend:UntagResource" + ], + "timeoutInMinutes": 10 + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 256, + "minLength": 1, + "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?", + "type": "string" + }, + "DataAccessRoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", + "type": "string" + }, + "DocumentClassifierName": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "InputDataConfig": { + "$ref": "#/definitions/DocumentClassifierInputDataConfig" + }, + "LanguageCode": { + "enum": [ + "en", + "es", + "fr", + "it", + "de", + "pt" + ], + "type": "string" + }, + "Mode": { + "enum": [ + "MULTI_CLASS", + "MULTI_LABEL" + ], + "type": "string" + }, + "ModelKmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "ModelPolicy": { + "maxLength": 20000, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "type": "string" + }, + "OutputDataConfig": { + "$ref": "#/definitions/DocumentClassifierOutputDataConfig" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VersionName": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "VolumeKmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "DocumentClassifierName", + "DataAccessRoleArn", + "InputDataConfig", + "LanguageCode" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Comprehend::DocumentClassifier" +} diff --git a/schema/aws-comprehend-flywheel.json b/schema/aws-comprehend-flywheel.json index c373bc6..5287ef4 100644 --- a/schema/aws-comprehend-flywheel.json +++ b/schema/aws-comprehend-flywheel.json @@ -1,285 +1,285 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FlywheelName", - "/properties/ModelType", - "/properties/DataLakeS3Uri", - "/properties/TaskConfig" - ], - "definitions": { - "DataSecurityConfig": { - "additionalProperties": false, - "properties": { - "DataLakeKmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "ModelKmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "VolumeKmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "required": [], - "type": "object" - }, - "DocumentClassificationConfig": { - "additionalProperties": false, - "properties": { - "Labels": { - "insertionOrder": false, - "items": { - "maxLength": 5000, - "type": "string" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "Mode": { - "enum": [ - "MULTI_CLASS", - "MULTI_LABEL" - ], - "type": "string" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "EntityRecognitionConfig": { - "additionalProperties": false, - "properties": { - "EntityTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EntityTypesListItem" - }, - "maxItems": 25, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "EntityTypesListItem": { - "additionalProperties": false, - "properties": { - "Type": { - "maxLength": 64, - "minLength": 1, - "pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TaskConfig": { - "additionalProperties": false, - "properties": { - "DocumentClassificationConfig": { - "$ref": "#/definitions/DocumentClassificationConfig" - }, - "EntityRecognitionConfig": { - "$ref": "#/definitions/EntityRecognitionConfig" - }, - "LanguageCode": { - "enum": [ - "en", - "es", - "fr", - "it", - "de", - "pt" - ], - "type": "string" - } - }, - "required": [ - "LanguageCode" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - } - }, - "description": "The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "comprehend:CreateFlywheel", - "comprehend:DescribeFlywheel", - "comprehend:ListTagsForResource" - ], - "timeoutInMinutes": 240 - }, - "delete": { - "permissions": [ - "comprehend:DeleteFlywheel", - "comprehend:DescribeFlywheel" - ], - "timeoutInMinutes": 120 - }, - "list": { - "permissions": [ - "comprehend:ListFlywheels" - ] - }, - "read": { - "permissions": [ - "comprehend:DescribeFlywheel", - "comprehend:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "comprehend:DescribeFlywheel", - "comprehend:UpdateFlywheel", - "comprehend:ListTagsForResource", - "comprehend:TagResource", - "comprehend:UntagResource" - ], - "timeoutInMinutes": 10 - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "ActiveModelArn": { - "maxLength": 256, - "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?", - "type": "string" - }, - "Arn": { - "maxLength": 256, - "minLength": 1, - "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "DataAccessRoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", - "type": "string" - }, - "DataLakeS3Uri": { - "maxLength": 512, - "pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?", - "type": "string" - }, - "DataSecurityConfig": { - "$ref": "#/definitions/DataSecurityConfig" - }, - "FlywheelName": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "ModelType": { - "enum": [ - "DOCUMENT_CLASSIFIER", - "ENTITY_RECOGNIZER" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TaskConfig": { - "$ref": "#/definitions/TaskConfig" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "FlywheelName", - "DataAccessRoleArn", - "DataLakeS3Uri" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Comprehend::Flywheel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FlywheelName", + "/properties/ModelType", + "/properties/DataLakeS3Uri", + "/properties/TaskConfig" + ], + "definitions": { + "DataSecurityConfig": { + "additionalProperties": false, + "properties": { + "DataLakeKmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "ModelKmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "VolumeKmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "required": [], + "type": "object" + }, + "DocumentClassificationConfig": { + "additionalProperties": false, + "properties": { + "Labels": { + "insertionOrder": false, + "items": { + "maxLength": 5000, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "Mode": { + "enum": [ + "MULTI_CLASS", + "MULTI_LABEL" + ], + "type": "string" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "EntityRecognitionConfig": { + "additionalProperties": false, + "properties": { + "EntityTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EntityTypesListItem" + }, + "maxItems": 25, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EntityTypesListItem": { + "additionalProperties": false, + "properties": { + "Type": { + "maxLength": 64, + "minLength": 1, + "pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TaskConfig": { + "additionalProperties": false, + "properties": { + "DocumentClassificationConfig": { + "$ref": "#/definitions/DocumentClassificationConfig" + }, + "EntityRecognitionConfig": { + "$ref": "#/definitions/EntityRecognitionConfig" + }, + "LanguageCode": { + "enum": [ + "en", + "es", + "fr", + "it", + "de", + "pt" + ], + "type": "string" + } + }, + "required": [ + "LanguageCode" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "comprehend:CreateFlywheel", + "comprehend:DescribeFlywheel", + "comprehend:ListTagsForResource" + ], + "timeoutInMinutes": 240 + }, + "delete": { + "permissions": [ + "comprehend:DeleteFlywheel", + "comprehend:DescribeFlywheel" + ], + "timeoutInMinutes": 120 + }, + "list": { + "permissions": [ + "comprehend:ListFlywheels" + ] + }, + "read": { + "permissions": [ + "comprehend:DescribeFlywheel", + "comprehend:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "comprehend:DescribeFlywheel", + "comprehend:UpdateFlywheel", + "comprehend:ListTagsForResource", + "comprehend:TagResource", + "comprehend:UntagResource" + ], + "timeoutInMinutes": 10 + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "ActiveModelArn": { + "maxLength": 256, + "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?", + "type": "string" + }, + "Arn": { + "maxLength": 256, + "minLength": 1, + "pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "DataAccessRoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", + "type": "string" + }, + "DataLakeS3Uri": { + "maxLength": 512, + "pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?", + "type": "string" + }, + "DataSecurityConfig": { + "$ref": "#/definitions/DataSecurityConfig" + }, + "FlywheelName": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "ModelType": { + "enum": [ + "DOCUMENT_CLASSIFIER", + "ENTITY_RECOGNIZER" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TaskConfig": { + "$ref": "#/definitions/TaskConfig" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "FlywheelName", + "DataAccessRoleArn", + "DataLakeS3Uri" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Comprehend::Flywheel" +} diff --git a/schema/aws-config-aggregationauthorization.json b/schema/aws-config-aggregationauthorization.json index 4676b7a..cf95921 100644 --- a/schema/aws-config-aggregationauthorization.json +++ b/schema/aws-config-aggregationauthorization.json @@ -1,114 +1,119 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AuthorizedAccountId", - "/properties/AuthorizedAwsRegion" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::AggregationAuthorization", - "handlers": { - "create": { - "permissions": [ - "config:DescribeAggregationAuthorizations", - "config:PutAggregationAuthorization", - "config:TagResource" - ] - }, - "delete": { - "permissions": [ - "config:DescribeAggregationAuthorizations", - "config:DeleteAggregationAuthorization", - "config:UntagResource" - ] - }, - "list": { - "permissions": [ - "config:DescribeAggregationAuthorizations" - ] - }, - "read": { - "permissions": [ - "config:DescribeAggregationAuthorizations", - "config:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "config:DescribeAggregationAuthorizations", - "config:TagResource", - "config:UntagResource", - "config:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AuthorizedAccountId", - "/properties/AuthorizedAwsRegion" - ], - "properties": { - "AggregationAuthorizationArn": { - "description": "The ARN of the AggregationAuthorization.", - "type": "string" - }, - "AuthorizedAccountId": { - "description": "The 12-digit account ID of the account authorized to aggregate data.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "AuthorizedAwsRegion": { - "description": "The region authorized to collect aggregated data.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "The tags for the AggregationAuthorization.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AggregationAuthorizationArn" - ], - "required": [ - "AuthorizedAccountId", - "AuthorizedAwsRegion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Config::AggregationAuthorization" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AuthorizedAccountId", + "/properties/AuthorizedAwsRegion" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::AggregationAuthorization", + "handlers": { + "create": { + "permissions": [ + "config:DescribeAggregationAuthorizations", + "config:PutAggregationAuthorization", + "config:TagResource" + ] + }, + "delete": { + "permissions": [ + "config:DescribeAggregationAuthorizations", + "config:DeleteAggregationAuthorization", + "config:UntagResource" + ] + }, + "list": { + "permissions": [ + "config:DescribeAggregationAuthorizations" + ] + }, + "read": { + "permissions": [ + "config:DescribeAggregationAuthorizations", + "config:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "config:DescribeAggregationAuthorizations", + "config:TagResource", + "config:UntagResource", + "config:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AuthorizedAccountId", + "/properties/AuthorizedAwsRegion" + ], + "properties": { + "AggregationAuthorizationArn": { + "description": "The ARN of the AggregationAuthorization.", + "type": "string" + }, + "AuthorizedAccountId": { + "description": "The 12-digit account ID of the account authorized to aggregate data.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AuthorizedAwsRegion": { + "description": "The region authorized to collect aggregated data.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "The tags for the AggregationAuthorization.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AggregationAuthorizationArn" + ], + "required": [ + "AuthorizedAccountId", + "AuthorizedAwsRegion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "config:TagResource", + "config:UntagResource", + "config:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Config::AggregationAuthorization" +} diff --git a/schema/aws-config-configrule.json b/schema/aws-config-configrule.json index 67a555d..6325419 100644 --- a/schema/aws-config-configrule.json +++ b/schema/aws-config-configrule.json @@ -1,230 +1,230 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigRuleName" - ], - "definitions": { - "CustomPolicyDetails": { - "additionalProperties": false, - "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", - "properties": { - "EnableDebugLogDelivery": { - "description": "The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``.", - "type": "boolean" - }, - "PolicyRuntime": { - "description": "The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard).", - "type": "string" - }, - "PolicyText": { - "description": "The policy definition containing the logic for your CC Custom Policy rule.", - "type": "string" - } - }, - "type": "object" - }, - "EvaluationModeConfiguration": { - "additionalProperties": false, - "description": "The configuration object for CC rule evaluation mode. The supported valid values are Detective or Proactive.", - "properties": { - "Mode": { - "description": "The mode of an evaluation. The valid values are Detective or Proactive.", - "type": "string" - } - }, - "type": "object" - }, - "Scope": { - "additionalProperties": false, - "description": "Defines which resources trigger an evaluation for an CC rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.", - "properties": { - "ComplianceResourceId": { - "description": "The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``.", - "type": "string" - }, - "ComplianceResourceTypes": { - "description": "The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "TagKey": { - "description": "The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.", - "type": "string" - }, - "TagValue": { - "description": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``.", - "type": "string" - } - }, - "type": "object" - }, - "Source": { - "additionalProperties": false, - "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", - "properties": { - "CustomPolicyDetails": { - "$ref": "#/definitions/CustomPolicyDetails", - "description": "Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``." - }, - "Owner": { - "description": "Indicates whether AWS or the customer owns and manages the CC rule.\n CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*.\n CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*.", - "type": "string" - }, - "SourceDetails": { - "description": "Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic.\n If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``.", - "items": { - "$ref": "#/definitions/SourceDetail", - "description": "Source and message type that can trigger the rule" - }, - "type": "array", - "uniqueItems": true - }, - "SourceIdentifier": { - "description": "For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).\n For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``.\n For CC Custom Policy rules, this field will be ignored.", - "type": "string" - } - }, - "required": [ - "Owner" - ], - "type": "object" - }, - "SourceDetail": { - "additionalProperties": false, - "description": "Provides the source and the message types that trigger CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for ``SourceDetail`` only for custom rules.", - "properties": { - "EventSource": { - "description": "The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources.", - "type": "string" - }, - "MaximumExecutionFrequency": { - "description": "The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.\n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.\n Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule.", - "type": "string" - }, - "MessageType": { - "description": "The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:\n + ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.\n + ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.\n + ``ScheduledNotification`` - Triggers a periodic evaluation at the frequency specified for ``MaximumExecutionFrequency``.\n + ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.\n \n If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``.", - "type": "string" - } - }, - "required": [ - "EventSource", - "MessageType" - ], - "type": "object" - } - }, - "description": "You must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).\n Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.\n There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.\n CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.\n CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.\n If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. \n For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.\n If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.\n For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "config:PutConfigRule", - "config:DescribeConfigRules" - ] - }, - "delete": { - "permissions": [ - "config:DeleteConfigRule", - "config:DescribeConfigRules" - ] - }, - "list": { - "permissions": [ - "config:DescribeConfigRules" - ] - }, - "read": { - "permissions": [ - "config:DescribeConfigRules", - "config:DescribeComplianceByConfigRule" - ] - }, - "update": { - "permissions": [ - "config:PutConfigRule", - "config:DescribeConfigRules" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConfigRuleName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "Compliance": { - "additionalProperties": false, - "description": "Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.", - "properties": { - "Type": { - "description": "Compliance type determined by the Config rule", - "type": "string" - } - }, - "type": "object" - }, - "ConfigRuleId": { - "description": "", - "type": "string" - }, - "ConfigRuleName": { - "description": "A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).", - "type": "string" - }, - "Description": { - "description": "The description that you provide for the CC rule.", - "type": "string" - }, - "EvaluationModes": { - "description": "The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.", - "items": { - "$ref": "#/definitions/EvaluationModeConfiguration", - "description": "Mode of evaluation of AWS Config rule" - }, - "type": "array", - "uniqueItems": false - }, - "InputParameters": { - "description": "A string, in JSON format, that is passed to the CC rule Lambda function.", - "type": [ - "string", - "object" - ] - }, - "MaximumExecutionFrequency": { - "description": "The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:\n + You are using an AWS managed rule that is triggered at a periodic frequency.\n + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).\n \n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.", - "type": "string" - }, - "Scope": { - "$ref": "#/definitions/Scope", - "description": "Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.\n The scope can be empty." - }, - "Source": { - "$ref": "#/definitions/Source", - "description": "Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources." - } - }, - "propertyTransform": { - "/properties/Source": "Source.Owner=\"CUSTOM_LAMBDA\" ? ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) > 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) = 0) ? $ ~> | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"OversizedConfigurationItemChangeNotification\"}]} | : ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) = 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) > 0) ? $ ~> | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"ConfigurationItemChangeNotification\" }]} | : $ : $" - }, - "readOnlyProperties": [ - "/properties/ConfigRuleId", - "/properties/Compliance/Type", - "/properties/Arn" - ], - "required": [ - "Source" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Config::ConfigRule", - "writeOnlyProperties": [ - "/properties/Source/CustomPolicyDetails/PolicyText" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigRuleName" + ], + "definitions": { + "CustomPolicyDetails": { + "additionalProperties": false, + "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", + "properties": { + "EnableDebugLogDelivery": { + "description": "The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``.", + "type": "boolean" + }, + "PolicyRuntime": { + "description": "The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard).", + "type": "string" + }, + "PolicyText": { + "description": "The policy definition containing the logic for your CC Custom Policy rule.", + "type": "string" + } + }, + "type": "object" + }, + "EvaluationModeConfiguration": { + "additionalProperties": false, + "description": "The configuration object for CC rule evaluation mode. The supported valid values are Detective or Proactive.", + "properties": { + "Mode": { + "description": "The mode of an evaluation. The valid values are Detective or Proactive.", + "type": "string" + } + }, + "type": "object" + }, + "Scope": { + "additionalProperties": false, + "description": "Defines which resources trigger an evaluation for an CC rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.", + "properties": { + "ComplianceResourceId": { + "description": "The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``.", + "type": "string" + }, + "ComplianceResourceTypes": { + "description": "The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "TagKey": { + "description": "The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.", + "type": "string" + }, + "TagValue": { + "description": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``.", + "type": "string" + } + }, + "type": "object" + }, + "Source": { + "additionalProperties": false, + "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", + "properties": { + "CustomPolicyDetails": { + "$ref": "#/definitions/CustomPolicyDetails", + "description": "Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``." + }, + "Owner": { + "description": "Indicates whether AWS or the customer owns and manages the CC rule.\n CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*.\n CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*.", + "type": "string" + }, + "SourceDetails": { + "description": "Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic.\n If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``.", + "items": { + "$ref": "#/definitions/SourceDetail", + "description": "Source and message type that can trigger the rule" + }, + "type": "array", + "uniqueItems": true + }, + "SourceIdentifier": { + "description": "For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).\n For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``.\n For CC Custom Policy rules, this field will be ignored.", + "type": "string" + } + }, + "required": [ + "Owner" + ], + "type": "object" + }, + "SourceDetail": { + "additionalProperties": false, + "description": "Provides the source and the message types that trigger CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for ``SourceDetail`` only for custom rules.", + "properties": { + "EventSource": { + "description": "The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources.", + "type": "string" + }, + "MaximumExecutionFrequency": { + "description": "The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.\n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.\n Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule.", + "type": "string" + }, + "MessageType": { + "description": "The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:\n + ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.\n + ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.\n + ``ScheduledNotification`` - Triggers a periodic evaluation at the frequency specified for ``MaximumExecutionFrequency``.\n + ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.\n \n If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``.", + "type": "string" + } + }, + "required": [ + "EventSource", + "MessageType" + ], + "type": "object" + } + }, + "description": "You must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).\n Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.\n There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.\n CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.\n CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.\n If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. \n For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.\n If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.\n For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "config:PutConfigRule", + "config:DescribeConfigRules" + ] + }, + "delete": { + "permissions": [ + "config:DeleteConfigRule", + "config:DescribeConfigRules" + ] + }, + "list": { + "permissions": [ + "config:DescribeConfigRules" + ] + }, + "read": { + "permissions": [ + "config:DescribeConfigRules", + "config:DescribeComplianceByConfigRule" + ] + }, + "update": { + "permissions": [ + "config:PutConfigRule", + "config:DescribeConfigRules" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConfigRuleName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "Compliance": { + "additionalProperties": false, + "description": "Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.", + "properties": { + "Type": { + "description": "Compliance type determined by the Config rule", + "type": "string" + } + }, + "type": "object" + }, + "ConfigRuleId": { + "description": "", + "type": "string" + }, + "ConfigRuleName": { + "description": "A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).", + "type": "string" + }, + "Description": { + "description": "The description that you provide for the CC rule.", + "type": "string" + }, + "EvaluationModes": { + "description": "The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.", + "items": { + "$ref": "#/definitions/EvaluationModeConfiguration", + "description": "Mode of evaluation of AWS Config rule" + }, + "type": "array", + "uniqueItems": false + }, + "InputParameters": { + "description": "A string, in JSON format, that is passed to the CC rule Lambda function.", + "type": [ + "string", + "object" + ] + }, + "MaximumExecutionFrequency": { + "description": "The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:\n + You are using an AWS managed rule that is triggered at a periodic frequency.\n + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).\n \n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.", + "type": "string" + }, + "Scope": { + "$ref": "#/definitions/Scope", + "description": "Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.\n The scope can be empty." + }, + "Source": { + "$ref": "#/definitions/Source", + "description": "Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources." + } + }, + "propertyTransform": { + "/properties/Source": "Source.Owner=\"CUSTOM_LAMBDA\" ? ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) > 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) = 0) ? $ ~> | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"OversizedConfigurationItemChangeNotification\"}]} | : ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) = 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) > 0) ? $ ~> | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"ConfigurationItemChangeNotification\" }]} | : $ : $" + }, + "readOnlyProperties": [ + "/properties/ConfigRuleId", + "/properties/Compliance/Type", + "/properties/Arn" + ], + "required": [ + "Source" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Config::ConfigRule", + "writeOnlyProperties": [ + "/properties/Source/CustomPolicyDetails/PolicyText" + ] +} diff --git a/schema/aws-config-configurationaggregator.json b/schema/aws-config-configurationaggregator.json index 7924a57..2ebeeec 100644 --- a/schema/aws-config-configurationaggregator.json +++ b/schema/aws-config-configurationaggregator.json @@ -1,168 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigurationAggregatorName" - ], - "definitions": { - "AccountAggregationSource": { - "additionalProperties": false, - "properties": { - "AccountIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllAwsRegions": { - "type": "boolean" - }, - "AwsRegions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "AccountIds" - ], - "type": "object" - }, - "OrganizationAggregationSource": { - "additionalProperties": false, - "properties": { - "AllAwsRegions": { - "type": "boolean" - }, - "AwsRegions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::ConfigurationAggregator", - "handlers": { - "create": { - "permissions": [ - "config:PutConfigurationAggregator", - "config:DescribeConfigurationAggregators", - "config:TagResource", - "iam:PassRole", - "organizations:EnableAWSServiceAccess", - "organizations:ListDelegatedAdministrators" - ] - }, - "delete": { - "permissions": [ - "config:DeleteConfigurationAggregator", - "config:UntagResource" - ] - }, - "list": { - "permissions": [ - "config:DescribeConfigurationAggregators" - ] - }, - "read": { - "permissions": [ - "config:DescribeConfigurationAggregators", - "config:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "config:PutConfigurationAggregator", - "config:DescribeConfigurationAggregators", - "config:TagResource", - "config:UntagResource", - "config:ListTagsForResource", - "iam:PassRole", - "organizations:EnableAWSServiceAccess", - "organizations:ListDelegatedAdministrators" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConfigurationAggregatorName" - ], - "properties": { - "AccountAggregationSources": { - "items": { - "$ref": "#/definitions/AccountAggregationSource" - }, - "type": "array", - "uniqueItems": false - }, - "ConfigurationAggregatorArn": { - "description": "The Amazon Resource Name (ARN) of the aggregator.", - "type": "string" - }, - "ConfigurationAggregatorName": { - "description": "The name of the aggregator.", - "maxLength": 256, - "minLength": 1, - "pattern": "[\\w\\-]+", - "type": "string" - }, - "OrganizationAggregationSource": { - "$ref": "#/definitions/OrganizationAggregationSource" - }, - "Tags": { - "description": "The tags for the configuration aggregator.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ConfigurationAggregatorArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Config::ConfigurationAggregator" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigurationAggregatorName" + ], + "definitions": { + "AccountAggregationSource": { + "additionalProperties": false, + "properties": { + "AccountIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllAwsRegions": { + "type": "boolean" + }, + "AwsRegions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "AccountIds" + ], + "type": "object" + }, + "OrganizationAggregationSource": { + "additionalProperties": false, + "properties": { + "AllAwsRegions": { + "type": "boolean" + }, + "AwsRegions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::ConfigurationAggregator", + "handlers": { + "create": { + "permissions": [ + "config:PutConfigurationAggregator", + "config:DescribeConfigurationAggregators", + "config:TagResource", + "iam:PassRole", + "organizations:EnableAWSServiceAccess", + "organizations:ListDelegatedAdministrators" + ] + }, + "delete": { + "permissions": [ + "config:DeleteConfigurationAggregator", + "config:UntagResource" + ] + }, + "list": { + "permissions": [ + "config:DescribeConfigurationAggregators" + ] + }, + "read": { + "permissions": [ + "config:DescribeConfigurationAggregators", + "config:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "config:PutConfigurationAggregator", + "config:DescribeConfigurationAggregators", + "config:TagResource", + "config:UntagResource", + "config:ListTagsForResource", + "iam:PassRole", + "organizations:EnableAWSServiceAccess", + "organizations:ListDelegatedAdministrators" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConfigurationAggregatorName" + ], + "properties": { + "AccountAggregationSources": { + "items": { + "$ref": "#/definitions/AccountAggregationSource" + }, + "type": "array", + "uniqueItems": false + }, + "ConfigurationAggregatorArn": { + "description": "The Amazon Resource Name (ARN) of the aggregator.", + "type": "string" + }, + "ConfigurationAggregatorName": { + "description": "The name of the aggregator.", + "maxLength": 256, + "minLength": 1, + "pattern": "[\\w\\-]+", + "type": "string" + }, + "OrganizationAggregationSource": { + "$ref": "#/definitions/OrganizationAggregationSource" + }, + "Tags": { + "description": "The tags for the configuration aggregator.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ConfigurationAggregatorArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "config:TagResource", + "config:UntagResource", + "config:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Config::ConfigurationAggregator" +} diff --git a/schema/aws-config-configurationrecorder.json b/schema/aws-config-configurationrecorder.json index b4cc40d..b438f44 100644 --- a/schema/aws-config-configurationrecorder.json +++ b/schema/aws-config-configurationrecorder.json @@ -1,131 +1,131 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ExclusionByResourceTypes": { - "additionalProperties": false, - "properties": { - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ResourceTypes" - ], - "type": "object" - }, - "RecordingGroup": { - "additionalProperties": false, - "properties": { - "AllSupported": { - "type": "boolean" - }, - "ExclusionByResourceTypes": { - "$ref": "#/definitions/ExclusionByResourceTypes" - }, - "IncludeGlobalResourceTypes": { - "type": "boolean" - }, - "RecordingStrategy": { - "$ref": "#/definitions/RecordingStrategy" - }, - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "RecordingMode": { - "additionalProperties": false, - "properties": { - "RecordingFrequency": { - "type": "string" - }, - "RecordingModeOverrides": { - "items": { - "$ref": "#/definitions/RecordingModeOverride" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "RecordingFrequency" - ], - "type": "object" - }, - "RecordingModeOverride": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "RecordingFrequency": { - "type": "string" - }, - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ResourceTypes", - "RecordingFrequency" - ], - "type": "object" - }, - "RecordingStrategy": { - "additionalProperties": false, - "properties": { - "UseOnly": { - "type": "string" - } - }, - "required": [ - "UseOnly" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::ConfigurationRecorder", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RecordingGroup": { - "$ref": "#/definitions/RecordingGroup" - }, - "RecordingMode": { - "$ref": "#/definitions/RecordingMode" - }, - "RoleARN": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RoleARN" - ], - "typeName": "AWS::Config::ConfigurationRecorder" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ExclusionByResourceTypes": { + "additionalProperties": false, + "properties": { + "ResourceTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ResourceTypes" + ], + "type": "object" + }, + "RecordingGroup": { + "additionalProperties": false, + "properties": { + "AllSupported": { + "type": "boolean" + }, + "ExclusionByResourceTypes": { + "$ref": "#/definitions/ExclusionByResourceTypes" + }, + "IncludeGlobalResourceTypes": { + "type": "boolean" + }, + "RecordingStrategy": { + "$ref": "#/definitions/RecordingStrategy" + }, + "ResourceTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "RecordingMode": { + "additionalProperties": false, + "properties": { + "RecordingFrequency": { + "type": "string" + }, + "RecordingModeOverrides": { + "items": { + "$ref": "#/definitions/RecordingModeOverride" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "RecordingFrequency" + ], + "type": "object" + }, + "RecordingModeOverride": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "RecordingFrequency": { + "type": "string" + }, + "ResourceTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ResourceTypes", + "RecordingFrequency" + ], + "type": "object" + }, + "RecordingStrategy": { + "additionalProperties": false, + "properties": { + "UseOnly": { + "type": "string" + } + }, + "required": [ + "UseOnly" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::ConfigurationRecorder", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RecordingGroup": { + "$ref": "#/definitions/RecordingGroup" + }, + "RecordingMode": { + "$ref": "#/definitions/RecordingMode" + }, + "RoleARN": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RoleARN" + ], + "typeName": "AWS::Config::ConfigurationRecorder" +} diff --git a/schema/aws-config-conformancepack.json b/schema/aws-config-conformancepack.json index 6c90cf5..819318e 100644 --- a/schema/aws-config-conformancepack.json +++ b/schema/aws-config-conformancepack.json @@ -1,158 +1,158 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConformancePackName" - ], - "definitions": { - "ConformancePackInputParameter": { - "additionalProperties": false, - "description": "Input parameters in the form of key-value pairs for the conformance pack.", - "properties": { - "ParameterName": { - "$ref": "#/definitions/ParameterName" - }, - "ParameterValue": { - "$ref": "#/definitions/ParameterValue" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "ParameterName": { - "description": "Key part of key-value pair with value being parameter value", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "ParameterValue": { - "description": "Value part of key-value pair with key being parameter Name", - "maxLength": 4096, - "minLength": 0, - "type": "string" - } - }, - "description": "A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.", - "documentationUrl": "https://docs.aws.amazon.com/config/latest/developerguide/conformance-packs.html", - "handlers": { - "create": { - "permissions": [ - "config:PutConformancePack", - "config:DescribeConformancePackStatus", - "config:DescribeConformancePacks", - "s3:GetObject", - "s3:GetBucketAcl", - "iam:CreateServiceLinkedRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "config:DeleteConformancePack", - "config:DescribeConformancePackStatus" - ] - }, - "list": { - "permissions": [ - "config:DescribeConformancePacks" - ] - }, - "read": { - "permissions": [ - "config:DescribeConformancePacks" - ] - }, - "update": { - "permissions": [ - "config:PutConformancePack", - "config:DescribeConformancePackStatus", - "s3:GetObject", - "s3:GetBucketAcl", - "iam:CreateServiceLinkedRole", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConformancePackName" - ], - "properties": { - "ConformancePackInputParameters": { - "description": "A list of ConformancePackInputParameter objects.", - "items": { - "$ref": "#/definitions/ConformancePackInputParameter" - }, - "maxItems": 60, - "minItems": 0, - "type": "array" - }, - "ConformancePackName": { - "description": "Name of the conformance pack which will be assigned as the unique identifier.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z][-a-zA-Z0-9]*", - "type": "string" - }, - "DeliveryS3Bucket": { - "description": "AWS Config stores intermediate files while processing conformance pack template.", - "maxLength": 63, - "minLength": 0, - "type": "string" - }, - "DeliveryS3KeyPrefix": { - "description": "The prefix for delivery S3 bucket.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "TemplateBody": { - "description": "A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.", - "maxLength": 51200, - "minLength": 1, - "type": "string" - }, - "TemplateS3Uri": { - "description": "Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.", - "maxLength": 1024, - "minLength": 1, - "pattern": "s3://.*", - "type": "string" - }, - "TemplateSSMDocumentDetails": { - "additionalProperties": false, - "description": "The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.", - "properties": { - "DocumentName": { - "maxLength": 128, - "minLength": 3, - "type": "string" - }, - "DocumentVersion": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "ConformancePackName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Config::ConformancePack", - "writeOnlyProperties": [ - "/properties/TemplateBody", - "/properties/TemplateS3Uri", - "/properties/TemplateSSMDocumentDetails" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConformancePackName" + ], + "definitions": { + "ConformancePackInputParameter": { + "additionalProperties": false, + "description": "Input parameters in the form of key-value pairs for the conformance pack.", + "properties": { + "ParameterName": { + "$ref": "#/definitions/ParameterName" + }, + "ParameterValue": { + "$ref": "#/definitions/ParameterValue" + } + }, + "required": [ + "ParameterName", + "ParameterValue" + ], + "type": "object" + }, + "ParameterName": { + "description": "Key part of key-value pair with value being parameter value", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ParameterValue": { + "description": "Value part of key-value pair with key being parameter Name", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "description": "A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.", + "documentationUrl": "https://docs.aws.amazon.com/config/latest/developerguide/conformance-packs.html", + "handlers": { + "create": { + "permissions": [ + "config:PutConformancePack", + "config:DescribeConformancePackStatus", + "config:DescribeConformancePacks", + "s3:GetObject", + "s3:GetBucketAcl", + "iam:CreateServiceLinkedRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "config:DeleteConformancePack", + "config:DescribeConformancePackStatus" + ] + }, + "list": { + "permissions": [ + "config:DescribeConformancePacks" + ] + }, + "read": { + "permissions": [ + "config:DescribeConformancePacks" + ] + }, + "update": { + "permissions": [ + "config:PutConformancePack", + "config:DescribeConformancePackStatus", + "s3:GetObject", + "s3:GetBucketAcl", + "iam:CreateServiceLinkedRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConformancePackName" + ], + "properties": { + "ConformancePackInputParameters": { + "description": "A list of ConformancePackInputParameter objects.", + "items": { + "$ref": "#/definitions/ConformancePackInputParameter" + }, + "maxItems": 60, + "minItems": 0, + "type": "array" + }, + "ConformancePackName": { + "description": "Name of the conformance pack which will be assigned as the unique identifier.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z][-a-zA-Z0-9]*", + "type": "string" + }, + "DeliveryS3Bucket": { + "description": "AWS Config stores intermediate files while processing conformance pack template.", + "maxLength": 63, + "minLength": 0, + "type": "string" + }, + "DeliveryS3KeyPrefix": { + "description": "The prefix for delivery S3 bucket.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "TemplateBody": { + "description": "A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.", + "maxLength": 51200, + "minLength": 1, + "type": "string" + }, + "TemplateS3Uri": { + "description": "Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.", + "maxLength": 1024, + "minLength": 1, + "pattern": "s3://.*", + "type": "string" + }, + "TemplateSSMDocumentDetails": { + "additionalProperties": false, + "description": "The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.", + "properties": { + "DocumentName": { + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "DocumentVersion": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "ConformancePackName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Config::ConformancePack", + "writeOnlyProperties": [ + "/properties/TemplateBody", + "/properties/TemplateS3Uri", + "/properties/TemplateSSMDocumentDetails" + ] +} diff --git a/schema/aws-config-deliverychannel.json b/schema/aws-config-deliverychannel.json index 3ab8ec6..3d4eebc 100644 --- a/schema/aws-config-deliverychannel.json +++ b/schema/aws-config-deliverychannel.json @@ -1,51 +1,51 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ConfigSnapshotDeliveryProperties": { - "additionalProperties": false, - "properties": { - "DeliveryFrequency": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::DeliveryChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConfigSnapshotDeliveryProperties": { - "$ref": "#/definitions/ConfigSnapshotDeliveryProperties" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - }, - "S3KmsKeyArn": { - "type": "string" - }, - "SnsTopicARN": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "S3BucketName" - ], - "typeName": "AWS::Config::DeliveryChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ConfigSnapshotDeliveryProperties": { + "additionalProperties": false, + "properties": { + "DeliveryFrequency": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::DeliveryChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConfigSnapshotDeliveryProperties": { + "$ref": "#/definitions/ConfigSnapshotDeliveryProperties" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "S3BucketName": { + "type": "string" + }, + "S3KeyPrefix": { + "type": "string" + }, + "S3KmsKeyArn": { + "type": "string" + }, + "SnsTopicARN": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "S3BucketName" + ], + "typeName": "AWS::Config::DeliveryChannel" +} diff --git a/schema/aws-config-organizationconfigrule.json b/schema/aws-config-organizationconfigrule.json index 95fb063..5a2b978 100644 --- a/schema/aws-config-organizationconfigrule.json +++ b/schema/aws-config-organizationconfigrule.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OrganizationConfigRuleName" - ], - "definitions": { - "OrganizationCustomPolicyRuleMetadata": { - "additionalProperties": false, - "properties": { - "DebugLogDeliveryAccounts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "OrganizationConfigRuleTriggerTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PolicyText": { - "type": "string" - }, - "ResourceIdScope": { - "type": "string" - }, - "ResourceTypesScope": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Runtime": { - "type": "string" - }, - "TagKeyScope": { - "type": "string" - }, - "TagValueScope": { - "type": "string" - } - }, - "required": [ - "Runtime", - "PolicyText" - ], - "type": "object" - }, - "OrganizationCustomRuleMetadata": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "string" - }, - "LambdaFunctionArn": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "OrganizationConfigRuleTriggerTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ResourceIdScope": { - "type": "string" - }, - "ResourceTypesScope": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TagKeyScope": { - "type": "string" - }, - "TagValueScope": { - "type": "string" - } - }, - "required": [ - "LambdaFunctionArn", - "OrganizationConfigRuleTriggerTypes" - ], - "type": "object" - }, - "OrganizationManagedRuleMetadata": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "ResourceIdScope": { - "type": "string" - }, - "ResourceTypesScope": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RuleIdentifier": { - "type": "string" - }, - "TagKeyScope": { - "type": "string" - }, - "TagValueScope": { - "type": "string" - } - }, - "required": [ - "RuleIdentifier" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::OrganizationConfigRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ExcludedAccounts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "OrganizationConfigRuleName": { - "type": "string" - }, - "OrganizationCustomPolicyRuleMetadata": { - "$ref": "#/definitions/OrganizationCustomPolicyRuleMetadata" - }, - "OrganizationCustomRuleMetadata": { - "$ref": "#/definitions/OrganizationCustomRuleMetadata" - }, - "OrganizationManagedRuleMetadata": { - "$ref": "#/definitions/OrganizationManagedRuleMetadata" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "OrganizationConfigRuleName" - ], - "typeName": "AWS::Config::OrganizationConfigRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OrganizationConfigRuleName" + ], + "definitions": { + "OrganizationCustomPolicyRuleMetadata": { + "additionalProperties": false, + "properties": { + "DebugLogDeliveryAccounts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Description": { + "type": "string" + }, + "InputParameters": { + "type": "string" + }, + "MaximumExecutionFrequency": { + "type": "string" + }, + "OrganizationConfigRuleTriggerTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PolicyText": { + "type": "string" + }, + "ResourceIdScope": { + "type": "string" + }, + "ResourceTypesScope": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Runtime": { + "type": "string" + }, + "TagKeyScope": { + "type": "string" + }, + "TagValueScope": { + "type": "string" + } + }, + "required": [ + "Runtime", + "PolicyText" + ], + "type": "object" + }, + "OrganizationCustomRuleMetadata": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "InputParameters": { + "type": "string" + }, + "LambdaFunctionArn": { + "type": "string" + }, + "MaximumExecutionFrequency": { + "type": "string" + }, + "OrganizationConfigRuleTriggerTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ResourceIdScope": { + "type": "string" + }, + "ResourceTypesScope": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TagKeyScope": { + "type": "string" + }, + "TagValueScope": { + "type": "string" + } + }, + "required": [ + "LambdaFunctionArn", + "OrganizationConfigRuleTriggerTypes" + ], + "type": "object" + }, + "OrganizationManagedRuleMetadata": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "InputParameters": { + "type": "string" + }, + "MaximumExecutionFrequency": { + "type": "string" + }, + "ResourceIdScope": { + "type": "string" + }, + "ResourceTypesScope": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RuleIdentifier": { + "type": "string" + }, + "TagKeyScope": { + "type": "string" + }, + "TagValueScope": { + "type": "string" + } + }, + "required": [ + "RuleIdentifier" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::OrganizationConfigRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ExcludedAccounts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "OrganizationConfigRuleName": { + "type": "string" + }, + "OrganizationCustomPolicyRuleMetadata": { + "$ref": "#/definitions/OrganizationCustomPolicyRuleMetadata" + }, + "OrganizationCustomRuleMetadata": { + "$ref": "#/definitions/OrganizationCustomRuleMetadata" + }, + "OrganizationManagedRuleMetadata": { + "$ref": "#/definitions/OrganizationManagedRuleMetadata" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "OrganizationConfigRuleName" + ], + "typeName": "AWS::Config::OrganizationConfigRule" +} diff --git a/schema/aws-config-organizationconformancepack.json b/schema/aws-config-organizationconformancepack.json index d9ad932..f055ddc 100644 --- a/schema/aws-config-organizationconformancepack.json +++ b/schema/aws-config-organizationconformancepack.json @@ -1,160 +1,160 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OrganizationConformancePackName" - ], - "definitions": { - "AccountId": { - "type": "string" - }, - "ConformancePackInputParameter": { - "description": "Input parameters in the form of key-value pairs for the conformance pack.", - "properties": { - "ParameterName": { - "$ref": "#/definitions/ParameterName" - }, - "ParameterValue": { - "$ref": "#/definitions/ParameterValue" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "ParameterName": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "ParameterValue": { - "maxLength": 4096, - "minLength": 0, - "type": "string" - } - }, - "description": "Resource schema for AWS::Config::OrganizationConformancePack.", - "documentationUrl": "https://docs.aws.amazon.com/config/latest/developerguide/conformance-pack-organization-apis.html", - "handlers": { - "create": { - "permissions": [ - "config:PutOrganizationConformancePack", - "config:DescribeOrganizationConformancePackStatuses", - "config:GetOrganizationConformancePackDetailedStatus", - "config:DescribeOrganizationConformancePacks", - "s3:GetObject", - "s3:GetBucketAcl", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "organizations:ListDelegatedAdministrators", - "organizations:EnableAWSServiceAccess" - ], - "timeoutInMinutes": 706 - }, - "delete": { - "permissions": [ - "config:DeleteOrganizationConformancePack", - "config:DescribeOrganizationConformancePackStatuses", - "config:GetOrganizationConformancePackDetailedStatus", - "organizations:ListDelegatedAdministrators" - ], - "timeoutInMinutes": 706 - }, - "list": { - "permissions": [ - "config:DescribeOrganizationConformancePacks" - ] - }, - "read": { - "permissions": [ - "config:DescribeOrganizationConformancePacks" - ] - }, - "update": { - "permissions": [ - "config:PutOrganizationConformancePack", - "config:DescribeOrganizationConformancePackStatuses", - "config:GetOrganizationConformancePackDetailedStatus", - "s3:GetObject", - "s3:GetBucketAcl", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "organizations:ListDelegatedAdministrators", - "organizations:EnableAWSServiceAccess" - ], - "timeoutInMinutes": 706 - } - }, - "primaryIdentifier": [ - "/properties/OrganizationConformancePackName" - ], - "properties": { - "ConformancePackInputParameters": { - "description": "A list of ConformancePackInputParameter objects.", - "items": { - "$ref": "#/definitions/ConformancePackInputParameter" - }, - "maxItems": 60, - "minItems": 0, - "type": "array" - }, - "DeliveryS3Bucket": { - "description": "AWS Config stores intermediate files while processing conformance pack template.", - "maxLength": 63, - "minLength": 0, - "type": "string" - }, - "DeliveryS3KeyPrefix": { - "description": "The prefix for the delivery S3 bucket.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ExcludedAccounts": { - "description": "A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.", - "items": { - "$ref": "#/definitions/AccountId" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array" - }, - "OrganizationConformancePackName": { - "description": "The name of the organization conformance pack.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z][-a-zA-Z0-9]*", - "type": "string" - }, - "TemplateBody": { - "description": "A string containing full conformance pack template body.", - "maxLength": 51200, - "minLength": 1, - "type": "string" - }, - "TemplateS3Uri": { - "description": "Location of file containing the template body.", - "maxLength": 1024, - "minLength": 1, - "pattern": "s3://.*", - "type": "string" - } - }, - "required": [ - "OrganizationConformancePackName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Config::OrganizationConformancePack", - "writeOnlyProperties": [ - "/properties/TemplateBody", - "/properties/TemplateS3Uri" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OrganizationConformancePackName" + ], + "definitions": { + "AccountId": { + "type": "string" + }, + "ConformancePackInputParameter": { + "description": "Input parameters in the form of key-value pairs for the conformance pack.", + "properties": { + "ParameterName": { + "$ref": "#/definitions/ParameterName" + }, + "ParameterValue": { + "$ref": "#/definitions/ParameterValue" + } + }, + "required": [ + "ParameterName", + "ParameterValue" + ], + "type": "object" + }, + "ParameterName": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ParameterValue": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "description": "Resource schema for AWS::Config::OrganizationConformancePack.", + "documentationUrl": "https://docs.aws.amazon.com/config/latest/developerguide/conformance-pack-organization-apis.html", + "handlers": { + "create": { + "permissions": [ + "config:PutOrganizationConformancePack", + "config:DescribeOrganizationConformancePackStatuses", + "config:GetOrganizationConformancePackDetailedStatus", + "config:DescribeOrganizationConformancePacks", + "s3:GetObject", + "s3:GetBucketAcl", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "organizations:ListDelegatedAdministrators", + "organizations:EnableAWSServiceAccess" + ], + "timeoutInMinutes": 706 + }, + "delete": { + "permissions": [ + "config:DeleteOrganizationConformancePack", + "config:DescribeOrganizationConformancePackStatuses", + "config:GetOrganizationConformancePackDetailedStatus", + "organizations:ListDelegatedAdministrators" + ], + "timeoutInMinutes": 706 + }, + "list": { + "permissions": [ + "config:DescribeOrganizationConformancePacks" + ] + }, + "read": { + "permissions": [ + "config:DescribeOrganizationConformancePacks" + ] + }, + "update": { + "permissions": [ + "config:PutOrganizationConformancePack", + "config:DescribeOrganizationConformancePackStatuses", + "config:GetOrganizationConformancePackDetailedStatus", + "s3:GetObject", + "s3:GetBucketAcl", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "organizations:ListDelegatedAdministrators", + "organizations:EnableAWSServiceAccess" + ], + "timeoutInMinutes": 706 + } + }, + "primaryIdentifier": [ + "/properties/OrganizationConformancePackName" + ], + "properties": { + "ConformancePackInputParameters": { + "description": "A list of ConformancePackInputParameter objects.", + "items": { + "$ref": "#/definitions/ConformancePackInputParameter" + }, + "maxItems": 60, + "minItems": 0, + "type": "array" + }, + "DeliveryS3Bucket": { + "description": "AWS Config stores intermediate files while processing conformance pack template.", + "maxLength": 63, + "minLength": 0, + "type": "string" + }, + "DeliveryS3KeyPrefix": { + "description": "The prefix for the delivery S3 bucket.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ExcludedAccounts": { + "description": "A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.", + "items": { + "$ref": "#/definitions/AccountId" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "OrganizationConformancePackName": { + "description": "The name of the organization conformance pack.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z][-a-zA-Z0-9]*", + "type": "string" + }, + "TemplateBody": { + "description": "A string containing full conformance pack template body.", + "maxLength": 51200, + "minLength": 1, + "type": "string" + }, + "TemplateS3Uri": { + "description": "Location of file containing the template body.", + "maxLength": 1024, + "minLength": 1, + "pattern": "s3://.*", + "type": "string" + } + }, + "required": [ + "OrganizationConformancePackName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Config::OrganizationConformancePack", + "writeOnlyProperties": [ + "/properties/TemplateBody", + "/properties/TemplateS3Uri" + ] +} diff --git a/schema/aws-config-remediationconfiguration.json b/schema/aws-config-remediationconfiguration.json index f14a2fb..754f3fb 100644 --- a/schema/aws-config-remediationconfiguration.json +++ b/schema/aws-config-remediationconfiguration.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigRuleName" - ], - "definitions": { - "ExecutionControls": { - "additionalProperties": false, - "properties": { - "SsmControls": { - "$ref": "#/definitions/SsmControls" - } - }, - "type": "object" - }, - "SsmControls": { - "additionalProperties": false, - "properties": { - "ConcurrentExecutionRatePercentage": { - "type": "integer" - }, - "ErrorPercentage": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::RemediationConfiguration", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Automatic": { - "type": "boolean" - }, - "ConfigRuleName": { - "type": "string" - }, - "ExecutionControls": { - "$ref": "#/definitions/ExecutionControls" - }, - "Id": { - "type": "string" - }, - "MaximumAutomaticAttempts": { - "type": "integer" - }, - "Parameters": { - "type": "object" - }, - "ResourceType": { - "type": "string" - }, - "RetryAttemptSeconds": { - "type": "integer" - }, - "TargetId": { - "type": "string" - }, - "TargetType": { - "type": "string" - }, - "TargetVersion": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TargetType", - "ConfigRuleName", - "TargetId" - ], - "typeName": "AWS::Config::RemediationConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigRuleName" + ], + "definitions": { + "ExecutionControls": { + "additionalProperties": false, + "properties": { + "SsmControls": { + "$ref": "#/definitions/SsmControls" + } + }, + "type": "object" + }, + "SsmControls": { + "additionalProperties": false, + "properties": { + "ConcurrentExecutionRatePercentage": { + "type": "integer" + }, + "ErrorPercentage": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::RemediationConfiguration", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Automatic": { + "type": "boolean" + }, + "ConfigRuleName": { + "type": "string" + }, + "ExecutionControls": { + "$ref": "#/definitions/ExecutionControls" + }, + "Id": { + "type": "string" + }, + "MaximumAutomaticAttempts": { + "type": "integer" + }, + "Parameters": { + "type": "object" + }, + "ResourceType": { + "type": "string" + }, + "RetryAttemptSeconds": { + "type": "integer" + }, + "TargetId": { + "type": "string" + }, + "TargetType": { + "type": "string" + }, + "TargetVersion": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TargetType", + "ConfigRuleName", + "TargetId" + ], + "typeName": "AWS::Config::RemediationConfiguration" +} diff --git a/schema/aws-config-storedquery.json b/schema/aws-config-storedquery.json index 3efb866..e45bfcd 100644 --- a/schema/aws-config-storedquery.json +++ b/schema/aws-config-storedquery.json @@ -1,127 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/QueryName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Config::StoredQuery", - "handlers": { - "create": { - "permissions": [ - "config:PutStoredQuery", - "config:GetStoredQuery", - "config:TagResource" - ] - }, - "delete": { - "permissions": [ - "config:DeleteStoredQuery", - "config:UntagResource" - ] - }, - "list": { - "permissions": [ - "config:ListStoredQueries" - ] - }, - "read": { - "permissions": [ - "config:GetStoredQuery", - "config:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "config:PutStoredQuery", - "config:GetStoredQuery", - "config:TagResource", - "config:UntagResource", - "config:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/QueryName" - ], - "properties": { - "QueryArn": { - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "QueryDescription": { - "maxLength": 256, - "minLength": 0, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "QueryExpression": { - "maxLength": 4096, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "QueryId": { - "maxLength": 36, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - }, - "QueryName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_]+$", - "type": "string" - }, - "Tags": { - "description": "The tags for the stored query.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/QueryId", - "/properties/QueryArn" - ], - "required": [ - "QueryName", - "QueryExpression" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Config::StoredQuery" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/QueryName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Config::StoredQuery", + "handlers": { + "create": { + "permissions": [ + "config:PutStoredQuery", + "config:GetStoredQuery", + "config:TagResource" + ] + }, + "delete": { + "permissions": [ + "config:DeleteStoredQuery", + "config:UntagResource" + ] + }, + "list": { + "permissions": [ + "config:ListStoredQueries" + ] + }, + "read": { + "permissions": [ + "config:GetStoredQuery", + "config:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "config:PutStoredQuery", + "config:GetStoredQuery", + "config:TagResource", + "config:UntagResource", + "config:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/QueryName" + ], + "properties": { + "QueryArn": { + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "QueryDescription": { + "maxLength": 256, + "minLength": 0, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "QueryExpression": { + "maxLength": 4096, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "QueryId": { + "maxLength": 36, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + }, + "QueryName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string" + }, + "Tags": { + "description": "The tags for the stored query.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/QueryId", + "/properties/QueryArn" + ], + "required": [ + "QueryName", + "QueryExpression" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Config::StoredQuery" +} diff --git a/schema/aws-connect-agentstatus.json b/schema/aws-connect-agentstatus.json new file mode 100644 index 0000000..4dc0797 --- /dev/null +++ b/schema/aws-connect-agentstatus.json @@ -0,0 +1,160 @@ +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::AgentStatus", + "handlers": { + "create": { + "permissions": [ + "connect:CreateAgentStatus", + "connect:TagResource", + "connect:ListAgentStatuses" + ] + }, + "delete": { + "permissions": [] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListAgentStatuses" + ] + }, + "read": { + "permissions": [ + "connect:DescribeAgentStatus" + ] + }, + "update": { + "permissions": [ + "connect:UpdateAgentStatus", + "connect:UntagResource", + "connect:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentStatusArn" + ], + "properties": { + "AgentStatusArn": { + "description": "The Amazon Resource Name (ARN) of the agent status.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-state/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Description": { + "description": "The description of the status.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "DisplayOrder": { + "description": "The display order of the status.", + "maximum": 50, + "minimum": 1, + "type": "integer" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "LastModifiedRegion": { + "description": "Last modified region.", + "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", + "type": "string" + }, + "LastModifiedTime": { + "description": "Last modified time.", + "type": "number" + }, + "Name": { + "description": "The name of the status.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "ResetOrderNumber": { + "description": "A number indicating the reset order of the agent status.", + "type": "boolean" + }, + "State": { + "description": "The state of the status.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of agent status.", + "enum": [ + "ROUTABLE", + "CUSTOM", + "OFFLINE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentStatusArn", + "/properties/LastModifiedRegion", + "/properties/LastModifiedTime" + ], + "required": [ + "InstanceArn", + "Name", + "State" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::AgentStatus" +} diff --git a/schema/aws-connect-approvedorigin.json b/schema/aws-connect-approvedorigin.json index 36d52f7..5ea5378 100644 --- a/schema/aws-connect-approvedorigin.json +++ b/schema/aws-connect-approvedorigin.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceId", - "/properties/Origin" - ], - "definitions": { - "InstanceId": { - "description": "Amazon Connect instance identifier", - "maxLength": 100, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Origin": { - "description": "Domain name to be added to the allowlist of instance", - "maxLength": 267, - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::ApprovedOrigin", - "handlers": { - "create": { - "permissions": [ - "connect:AssociateApprovedOrigin", - "connect:ListApprovedOrigins" - ] - }, - "delete": { - "permissions": [ - "connect:DisassociateApprovedOrigin", - "connect:ListApprovedOrigins" - ] - }, - "list": { - "permissions": [ - "connect:ListApprovedOrigins" - ] - }, - "read": { - "permissions": [ - "connect:ListApprovedOrigins" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/InstanceId", - "/properties/Origin" - ], - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId" - }, - "Origin": { - "$ref": "#/definitions/Origin" - } - }, - "required": [ - "Origin", - "InstanceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Connect::ApprovedOrigin" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceId", + "/properties/Origin" + ], + "definitions": { + "InstanceId": { + "description": "Amazon Connect instance identifier", + "maxLength": 100, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Origin": { + "description": "Domain name to be added to the allowlist of instance", + "maxLength": 267, + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::ApprovedOrigin", + "handlers": { + "create": { + "permissions": [ + "connect:AssociateApprovedOrigin", + "connect:ListApprovedOrigins" + ] + }, + "delete": { + "permissions": [ + "connect:DisassociateApprovedOrigin", + "connect:ListApprovedOrigins" + ] + }, + "list": { + "permissions": [ + "connect:ListApprovedOrigins" + ] + }, + "read": { + "permissions": [ + "connect:ListApprovedOrigins" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/InstanceId", + "/properties/Origin" + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId" + }, + "Origin": { + "$ref": "#/definitions/Origin" + } + }, + "required": [ + "Origin", + "InstanceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::ApprovedOrigin" +} diff --git a/schema/aws-connect-contactflow.json b/schema/aws-connect-contactflow.json index c8d5433..b6c6764 100644 --- a/schema/aws-connect-contactflow.json +++ b/schema/aws-connect-contactflow.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::ContactFlow", - "handlers": { - "create": { - "permissions": [ - "connect:CreateContactFlow", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteContactFlow", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListContactFlows" - ] - }, - "read": { - "permissions": [ - "connect:DescribeContactFlow" - ] - }, - "update": { - "permissions": [ - "connect:UpdateContactFlowMetadata", - "connect:UpdateContactFlowContent", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ContactFlowArn" - ], - "properties": { - "ContactFlowArn": { - "description": "The identifier of the contact flow (ARN).", - "maxLength": 500, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Content": { - "description": "The content of the contact flow in JSON format.", - "maxLength": 256000, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The description of the contact flow.", - "maxLength": 500, - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance (ARN).", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the contact flow.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "State": { - "description": "The state of the contact flow.", - "enum": [ - "ACTIVE", - "ARCHIVED" - ], - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the contact flow.", - "enum": [ - "CONTACT_FLOW", - "CUSTOMER_QUEUE", - "CUSTOMER_HOLD", - "CUSTOMER_WHISPER", - "AGENT_HOLD", - "AGENT_WHISPER", - "OUTBOUND_WHISPER", - "AGENT_TRANSFER", - "QUEUE_TRANSFER" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ContactFlowArn" - ], - "required": [ - "InstanceArn", - "Content", - "Name", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::ContactFlow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::ContactFlow", + "handlers": { + "create": { + "permissions": [ + "connect:CreateContactFlow", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteContactFlow", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListContactFlows" + ] + }, + "read": { + "permissions": [ + "connect:DescribeContactFlow" + ] + }, + "update": { + "permissions": [ + "connect:UpdateContactFlowMetadata", + "connect:UpdateContactFlowContent", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ContactFlowArn" + ], + "properties": { + "ContactFlowArn": { + "description": "The identifier of the contact flow (ARN).", + "maxLength": 500, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Content": { + "description": "The content of the contact flow in JSON format.", + "maxLength": 256000, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The description of the contact flow.", + "maxLength": 500, + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance (ARN).", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the contact flow.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "State": { + "description": "The state of the contact flow.", + "enum": [ + "ACTIVE", + "ARCHIVED" + ], + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the contact flow.", + "enum": [ + "CONTACT_FLOW", + "CUSTOMER_QUEUE", + "CUSTOMER_HOLD", + "CUSTOMER_WHISPER", + "AGENT_HOLD", + "AGENT_WHISPER", + "OUTBOUND_WHISPER", + "AGENT_TRANSFER", + "QUEUE_TRANSFER" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ContactFlowArn" + ], + "required": [ + "InstanceArn", + "Content", + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::ContactFlow" +} diff --git a/schema/aws-connect-contactflowmodule.json b/schema/aws-connect-contactflowmodule.json index 4389d1a..8ff1c26 100644 --- a/schema/aws-connect-contactflowmodule.json +++ b/schema/aws-connect-contactflowmodule.json @@ -1,147 +1,147 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::ContactFlowModule.", - "handlers": { - "create": { - "permissions": [ - "connect:CreateContactFlowModule", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteContactFlowModule", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListContactFlowModules" - ] - }, - "read": { - "permissions": [ - "connect:DescribeContactFlowModule" - ] - }, - "update": { - "permissions": [ - "connect:UpdateContactFlowModuleMetadata", - "connect:UpdateContactFlowModuleContent", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ContactFlowModuleArn" - ], - "properties": { - "ContactFlowModuleArn": { - "description": "The identifier of the contact flow module (ARN).", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/flow-module/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Content": { - "description": "The content of the contact flow module in JSON format.", - "maxLength": 256000, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The description of the contact flow module.", - "maxLength": 500, - "pattern": ".*\\S.*", - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance (ARN).", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the contact flow module.", - "maxLength": 127, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "State": { - "description": "The state of the contact flow module.", - "maxLength": 500, - "type": "string" - }, - "Status": { - "description": "The status of the contact flow module.", - "maxLength": 500, - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ContactFlowModuleArn", - "/properties/Status" - ], - "required": [ - "InstanceArn", - "Name", - "Content" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::ContactFlowModule" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::ContactFlowModule.", + "handlers": { + "create": { + "permissions": [ + "connect:CreateContactFlowModule", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteContactFlowModule", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListContactFlowModules" + ] + }, + "read": { + "permissions": [ + "connect:DescribeContactFlowModule" + ] + }, + "update": { + "permissions": [ + "connect:UpdateContactFlowModuleMetadata", + "connect:UpdateContactFlowModuleContent", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ContactFlowModuleArn" + ], + "properties": { + "ContactFlowModuleArn": { + "description": "The identifier of the contact flow module (ARN).", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/flow-module/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Content": { + "description": "The content of the contact flow module in JSON format.", + "maxLength": 256000, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The description of the contact flow module.", + "maxLength": 500, + "pattern": ".*\\S.*", + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance (ARN).", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the contact flow module.", + "maxLength": 127, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "State": { + "description": "The state of the contact flow module.", + "maxLength": 500, + "type": "string" + }, + "Status": { + "description": "The status of the contact flow module.", + "maxLength": 500, + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ContactFlowModuleArn", + "/properties/Status" + ], + "required": [ + "InstanceArn", + "Name", + "Content" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::ContactFlowModule" +} diff --git a/schema/aws-connect-evaluationform.json b/schema/aws-connect-evaluationform.json index fe48e80..1dca9c3 100644 --- a/schema/aws-connect-evaluationform.json +++ b/schema/aws-connect-evaluationform.json @@ -1,545 +1,545 @@ -{ - "additionalProperties": false, - "definitions": { - "EvaluationFormBaseItem": { - "additionalProperties": false, - "description": "An item at the root level. All items must be sections.", - "properties": { - "Section": { - "$ref": "#/definitions/EvaluationFormSection", - "description": "A subsection or inner section of an item." - } - }, - "required": [ - "Section" - ], - "type": "object" - }, - "EvaluationFormItem": { - "additionalProperties": false, - "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.", - "properties": { - "Question": { - "$ref": "#/definitions/EvaluationFormQuestion", - "description": "The information of the question." - }, - "Section": { - "$ref": "#/definitions/EvaluationFormSection", - "description": "The information of the section." - } - }, - "type": "object" - }, - "EvaluationFormNumericQuestionAutomation": { - "additionalProperties": false, - "description": "Information about the automation configuration in numeric questions.", - "properties": { - "PropertyValue": { - "$ref": "#/definitions/NumericQuestionPropertyValueAutomation", - "description": "The property value of the automation." - } - }, - "required": [ - "PropertyValue" - ], - "type": "object" - }, - "EvaluationFormNumericQuestionOption": { - "additionalProperties": false, - "description": "Information about the option range used for scoring in numeric questions.", - "properties": { - "AutomaticFail": { - "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", - "type": "boolean" - }, - "MaxValue": { - "description": "The maximum answer value of the range option.", - "type": "integer" - }, - "MinValue": { - "description": "The minimum answer value of the range option.", - "type": "integer" - }, - "Score": { - "$ref": "#/definitions/Score", - "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" - } - }, - "required": [ - "MinValue", - "MaxValue" - ], - "type": "object" - }, - "EvaluationFormNumericQuestionProperties": { - "additionalProperties": false, - "description": "Information about properties for a numeric question in an evaluation form.", - "properties": { - "Automation": { - "$ref": "#/definitions/EvaluationFormNumericQuestionAutomation", - "description": "The automation properties of the numeric question." - }, - "MaxValue": { - "description": "The maximum answer value.", - "type": "integer" - }, - "MinValue": { - "description": "The minimum answer value.", - "type": "integer" - }, - "Options": { - "description": "The scoring options of the numeric question.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationFormNumericQuestionOption" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "MinValue", - "MaxValue" - ], - "type": "object" - }, - "EvaluationFormQuestion": { - "additionalProperties": false, - "description": "Information about a question from an evaluation form.", - "properties": { - "Instructions": { - "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", - "maxLength": 1024, - "type": "string" - }, - "NotApplicableEnabled": { - "description": "The flag to enable not applicable answers to the question.", - "type": "boolean" - }, - "QuestionType": { - "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``", - "enum": [ - "NUMERIC", - "SINGLESELECT", - "TEXT" - ], - "type": "string" - }, - "QuestionTypeProperties": { - "$ref": "#/definitions/EvaluationFormQuestionTypeProperties", - "description": "The properties of the type of question. Text questions do not have to define question type properties." - }, - "RefId": { - "$ref": "#/definitions/RefId", - "description": "The identifier of the question. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." - }, - "Title": { - "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350.", - "maxLength": 350, - "minLength": 1, - "type": "string" - }, - "Weight": { - "$ref": "#/definitions/Weight", - "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" - } - }, - "required": [ - "RefId", - "Title", - "QuestionType" - ], - "type": "object" - }, - "EvaluationFormQuestionTypeProperties": { - "additionalProperties": false, - "description": "Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.", - "properties": { - "Numeric": { - "$ref": "#/definitions/EvaluationFormNumericQuestionProperties", - "description": "The properties of the numeric question." - }, - "SingleSelect": { - "$ref": "#/definitions/EvaluationFormSingleSelectQuestionProperties", - "description": "The properties of the numeric question." - } - }, - "type": "object" - }, - "EvaluationFormSection": { - "additionalProperties": false, - "description": "Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).", - "properties": { - "Instructions": { - "description": "The instructions of the section.", - "maxLength": 1024, - "type": "string" - }, - "Items": { - "description": "The items of the section.\n *Minimum*: 1", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationFormItem" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "RefId": { - "$ref": "#/definitions/RefId", - "description": "The identifier of the section. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." - }, - "Title": { - "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Weight": { - "$ref": "#/definitions/Weight", - "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" - } - }, - "required": [ - "RefId", - "Title" - ], - "type": "object" - }, - "EvaluationFormSingleSelectQuestionAutomation": { - "additionalProperties": false, - "description": "Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.", - "properties": { - "DefaultOptionRefId": { - "$ref": "#/definitions/RefId", - "description": "The identifier of the default answer option, when none of the automation options match the criteria.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." - }, - "Options": { - "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomationOption" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Options" - ], - "type": "object" - }, - "EvaluationFormSingleSelectQuestionAutomationOption": { - "additionalProperties": false, - "description": "The automation options of the single select question.", - "properties": { - "RuleCategory": { - "$ref": "#/definitions/SingleSelectQuestionRuleCategoryAutomation", - "description": "The automation option based on a rule category for the single select question." - } - }, - "required": [ - "RuleCategory" - ], - "type": "object" - }, - "EvaluationFormSingleSelectQuestionOption": { - "additionalProperties": false, - "description": "Information about the automation configuration in single select questions.", - "properties": { - "AutomaticFail": { - "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", - "type": "boolean" - }, - "RefId": { - "$ref": "#/definitions/RefId", - "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." - }, - "Score": { - "$ref": "#/definitions/Score", - "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" - }, - "Text": { - "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "RefId", - "Text" - ], - "type": "object" - }, - "EvaluationFormSingleSelectQuestionProperties": { - "additionalProperties": false, - "description": "Information about the options in single select questions.", - "properties": { - "Automation": { - "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomation", - "description": "The display mode of the single select question." - }, - "DisplayAs": { - "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``", - "enum": [ - "DROPDOWN", - "RADIO" - ], - "type": "string" - }, - "Options": { - "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationFormSingleSelectQuestionOption" - }, - "maxItems": 256, - "minItems": 2, - "type": "array" - } - }, - "required": [ - "Options" - ], - "type": "object" - }, - "NumericQuestionPropertyValueAutomation": { - "additionalProperties": false, - "description": "Information about the property value used in automation of a numeric questions.", - "properties": { - "Label": { - "description": "The property label of the automation.", - "enum": [ - "OVERALL_CUSTOMER_SENTIMENT_SCORE", - "OVERALL_AGENT_SENTIMENT_SCORE", - "NON_TALK_TIME", - "NON_TALK_TIME_PERCENTAGE", - "NUMBER_OF_INTERRUPTIONS", - "CONTACT_DURATION", - "AGENT_INTERACTION_DURATION", - "CUSTOMER_HOLD_TIME" - ], - "type": "string" - } - }, - "required": [ - "Label" - ], - "type": "object" - }, - "RefId": { - "description": "The identifier to reference the item.", - "pattern": "^[a-zA-Z0-9._-]{1,40}$", - "type": "string" - }, - "Score": { - "description": "The score of an answer option.", - "maximum": 10, - "minimum": 0, - "type": "integer" - }, - "ScoringStrategy": { - "additionalProperties": false, - "description": "A scoring strategy of the evaluation form.", - "properties": { - "Mode": { - "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``", - "enum": [ - "QUESTION_ONLY", - "SECTION_ONLY" - ], - "type": "string" - }, - "Status": { - "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "required": [ - "Mode", - "Status" - ], - "type": "object" - }, - "SingleSelectQuestionRuleCategoryAutomation": { - "additionalProperties": false, - "description": "Information about the automation option based on a rule category for a single select question.\n *Length Constraints*: Minimum length of 1. Maximum length of 50.", - "properties": { - "Category": { - "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Condition": { - "description": "The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` \n *Maximum*: 50", - "enum": [ - "PRESENT", - "NOT_PRESENT" - ], - "type": "string" - }, - "OptionRefId": { - "$ref": "#/definitions/RefId", - "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." - } - }, - "required": [ - "Category", - "Condition", - "OptionRefId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Weight": { - "description": "The item weight used for scoring.", - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "description": "Creates an evaluation form for the specified CON instance.", - "handlers": { - "create": { - "permissions": [ - "connect:CreateEvaluationForm", - "connect:ActivateEvaluationForm", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteEvaluationForm", - "connect:UntagResource" - ] - }, - "list": { - "permissions": [ - "connect:ListEvaluationForms" - ] - }, - "read": { - "permissions": [ - "connect:DescribeEvaluationForm", - "connect:ListEvaluationFormVersions" - ] - }, - "update": { - "permissions": [ - "connect:UpdateEvaluationForm", - "connect:ListEvaluationFormVersions", - "connect:ActivateEvaluationForm", - "connect:DeactivateEvaluationForm", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/EvaluationFormArn" - ], - "properties": { - "Description": { - "description": "The description of the evaluation form.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", - "maxLength": 1024, - "type": "string" - }, - "EvaluationFormArn": { - "description": "", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Items": { - "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.\n *Minimum size*: 1\n *Maximum size*: 100", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationFormBaseItem" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "ScoringStrategy": { - "$ref": "#/definitions/ScoringStrategy", - "description": "A scoring strategy of the evaluation form." - }, - "Status": { - "default": "DRAFT", - "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``", - "enum": [ - "DRAFT", - "ACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Title": { - "description": "A title of the evaluation form.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/EvaluationFormArn" - ], - "required": [ - "Title", - "InstanceArn", - "Items", - "Status" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::EvaluationForm" -} +{ + "additionalProperties": false, + "definitions": { + "EvaluationFormBaseItem": { + "additionalProperties": false, + "description": "An item at the root level. All items must be sections.", + "properties": { + "Section": { + "$ref": "#/definitions/EvaluationFormSection", + "description": "A subsection or inner section of an item." + } + }, + "required": [ + "Section" + ], + "type": "object" + }, + "EvaluationFormItem": { + "additionalProperties": false, + "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.", + "properties": { + "Question": { + "$ref": "#/definitions/EvaluationFormQuestion", + "description": "The information of the question." + }, + "Section": { + "$ref": "#/definitions/EvaluationFormSection", + "description": "The information of the section." + } + }, + "type": "object" + }, + "EvaluationFormNumericQuestionAutomation": { + "additionalProperties": false, + "description": "Information about the automation configuration in numeric questions.", + "properties": { + "PropertyValue": { + "$ref": "#/definitions/NumericQuestionPropertyValueAutomation", + "description": "The property value of the automation." + } + }, + "required": [ + "PropertyValue" + ], + "type": "object" + }, + "EvaluationFormNumericQuestionOption": { + "additionalProperties": false, + "description": "Information about the option range used for scoring in numeric questions.", + "properties": { + "AutomaticFail": { + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", + "type": "boolean" + }, + "MaxValue": { + "description": "The maximum answer value of the range option.", + "type": "integer" + }, + "MinValue": { + "description": "The minimum answer value of the range option.", + "type": "integer" + }, + "Score": { + "$ref": "#/definitions/Score", + "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" + } + }, + "required": [ + "MinValue", + "MaxValue" + ], + "type": "object" + }, + "EvaluationFormNumericQuestionProperties": { + "additionalProperties": false, + "description": "Information about properties for a numeric question in an evaluation form.", + "properties": { + "Automation": { + "$ref": "#/definitions/EvaluationFormNumericQuestionAutomation", + "description": "The automation properties of the numeric question." + }, + "MaxValue": { + "description": "The maximum answer value.", + "type": "integer" + }, + "MinValue": { + "description": "The minimum answer value.", + "type": "integer" + }, + "Options": { + "description": "The scoring options of the numeric question.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationFormNumericQuestionOption" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "MinValue", + "MaxValue" + ], + "type": "object" + }, + "EvaluationFormQuestion": { + "additionalProperties": false, + "description": "Information about a question from an evaluation form.", + "properties": { + "Instructions": { + "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", + "maxLength": 1024, + "type": "string" + }, + "NotApplicableEnabled": { + "description": "The flag to enable not applicable answers to the question.", + "type": "boolean" + }, + "QuestionType": { + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``", + "enum": [ + "NUMERIC", + "SINGLESELECT", + "TEXT" + ], + "type": "string" + }, + "QuestionTypeProperties": { + "$ref": "#/definitions/EvaluationFormQuestionTypeProperties", + "description": "The properties of the type of question. Text questions do not have to define question type properties." + }, + "RefId": { + "$ref": "#/definitions/RefId", + "description": "The identifier of the question. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Title": { + "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350.", + "maxLength": 350, + "minLength": 1, + "type": "string" + }, + "Weight": { + "$ref": "#/definitions/Weight", + "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" + } + }, + "required": [ + "RefId", + "Title", + "QuestionType" + ], + "type": "object" + }, + "EvaluationFormQuestionTypeProperties": { + "additionalProperties": false, + "description": "Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.", + "properties": { + "Numeric": { + "$ref": "#/definitions/EvaluationFormNumericQuestionProperties", + "description": "The properties of the numeric question." + }, + "SingleSelect": { + "$ref": "#/definitions/EvaluationFormSingleSelectQuestionProperties", + "description": "The properties of the numeric question." + } + }, + "type": "object" + }, + "EvaluationFormSection": { + "additionalProperties": false, + "description": "Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).", + "properties": { + "Instructions": { + "description": "The instructions of the section.", + "maxLength": 1024, + "type": "string" + }, + "Items": { + "description": "The items of the section.\n *Minimum*: 1", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationFormItem" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "RefId": { + "$ref": "#/definitions/RefId", + "description": "The identifier of the section. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Title": { + "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Weight": { + "$ref": "#/definitions/Weight", + "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" + } + }, + "required": [ + "RefId", + "Title" + ], + "type": "object" + }, + "EvaluationFormSingleSelectQuestionAutomation": { + "additionalProperties": false, + "description": "Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.", + "properties": { + "DefaultOptionRefId": { + "$ref": "#/definitions/RefId", + "description": "The identifier of the default answer option, when none of the automation options match the criteria.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Options": { + "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomationOption" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Options" + ], + "type": "object" + }, + "EvaluationFormSingleSelectQuestionAutomationOption": { + "additionalProperties": false, + "description": "The automation options of the single select question.", + "properties": { + "RuleCategory": { + "$ref": "#/definitions/SingleSelectQuestionRuleCategoryAutomation", + "description": "The automation option based on a rule category for the single select question." + } + }, + "required": [ + "RuleCategory" + ], + "type": "object" + }, + "EvaluationFormSingleSelectQuestionOption": { + "additionalProperties": false, + "description": "Information about the automation configuration in single select questions.", + "properties": { + "AutomaticFail": { + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", + "type": "boolean" + }, + "RefId": { + "$ref": "#/definitions/RefId", + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Score": { + "$ref": "#/definitions/Score", + "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" + }, + "Text": { + "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "RefId", + "Text" + ], + "type": "object" + }, + "EvaluationFormSingleSelectQuestionProperties": { + "additionalProperties": false, + "description": "Information about the options in single select questions.", + "properties": { + "Automation": { + "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomation", + "description": "The display mode of the single select question." + }, + "DisplayAs": { + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``", + "enum": [ + "DROPDOWN", + "RADIO" + ], + "type": "string" + }, + "Options": { + "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationFormSingleSelectQuestionOption" + }, + "maxItems": 256, + "minItems": 2, + "type": "array" + } + }, + "required": [ + "Options" + ], + "type": "object" + }, + "NumericQuestionPropertyValueAutomation": { + "additionalProperties": false, + "description": "Information about the property value used in automation of a numeric questions.", + "properties": { + "Label": { + "description": "The property label of the automation.", + "enum": [ + "OVERALL_CUSTOMER_SENTIMENT_SCORE", + "OVERALL_AGENT_SENTIMENT_SCORE", + "NON_TALK_TIME", + "NON_TALK_TIME_PERCENTAGE", + "NUMBER_OF_INTERRUPTIONS", + "CONTACT_DURATION", + "AGENT_INTERACTION_DURATION", + "CUSTOMER_HOLD_TIME" + ], + "type": "string" + } + }, + "required": [ + "Label" + ], + "type": "object" + }, + "RefId": { + "description": "The identifier to reference the item.", + "pattern": "^[a-zA-Z0-9._-]{1,40}$", + "type": "string" + }, + "Score": { + "description": "The score of an answer option.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "ScoringStrategy": { + "additionalProperties": false, + "description": "A scoring strategy of the evaluation form.", + "properties": { + "Mode": { + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``", + "enum": [ + "QUESTION_ONLY", + "SECTION_ONLY" + ], + "type": "string" + }, + "Status": { + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [ + "Mode", + "Status" + ], + "type": "object" + }, + "SingleSelectQuestionRuleCategoryAutomation": { + "additionalProperties": false, + "description": "Information about the automation option based on a rule category for a single select question.\n *Length Constraints*: Minimum length of 1. Maximum length of 50.", + "properties": { + "Category": { + "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Condition": { + "description": "The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` \n *Maximum*: 50", + "enum": [ + "PRESENT", + "NOT_PRESENT" + ], + "type": "string" + }, + "OptionRefId": { + "$ref": "#/definitions/RefId", + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + } + }, + "required": [ + "Category", + "Condition", + "OptionRefId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Weight": { + "description": "The item weight used for scoring.", + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "description": "Creates an evaluation form for the specified CON instance.", + "handlers": { + "create": { + "permissions": [ + "connect:CreateEvaluationForm", + "connect:ActivateEvaluationForm", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteEvaluationForm", + "connect:UntagResource" + ] + }, + "list": { + "permissions": [ + "connect:ListEvaluationForms" + ] + }, + "read": { + "permissions": [ + "connect:DescribeEvaluationForm", + "connect:ListEvaluationFormVersions" + ] + }, + "update": { + "permissions": [ + "connect:UpdateEvaluationForm", + "connect:ListEvaluationFormVersions", + "connect:ActivateEvaluationForm", + "connect:DeactivateEvaluationForm", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/EvaluationFormArn" + ], + "properties": { + "Description": { + "description": "The description of the evaluation form.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", + "maxLength": 1024, + "type": "string" + }, + "EvaluationFormArn": { + "description": "", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Items": { + "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.\n *Minimum size*: 1\n *Maximum size*: 100", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationFormBaseItem" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "ScoringStrategy": { + "$ref": "#/definitions/ScoringStrategy", + "description": "A scoring strategy of the evaluation form." + }, + "Status": { + "default": "DRAFT", + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``", + "enum": [ + "DRAFT", + "ACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Title": { + "description": "A title of the evaluation form.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/EvaluationFormArn" + ], + "required": [ + "Title", + "InstanceArn", + "Items", + "Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::EvaluationForm" +} diff --git a/schema/aws-connect-hoursofoperation.json b/schema/aws-connect-hoursofoperation.json index 8781c9d..b9fe60e 100644 --- a/schema/aws-connect-hoursofoperation.json +++ b/schema/aws-connect-hoursofoperation.json @@ -1,195 +1,195 @@ -{ - "additionalProperties": false, - "definitions": { - "HoursOfOperationConfig": { - "additionalProperties": false, - "description": "Contains information about the hours of operation.", - "properties": { - "Day": { - "description": "The day that the hours of operation applies to.", - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - }, - "EndTime": { - "$ref": "#/definitions/HoursOfOperationTimeSlice", - "description": "The end time that your contact center closes." - }, - "StartTime": { - "$ref": "#/definitions/HoursOfOperationTimeSlice", - "description": "The start time that your contact center opens." - } - }, - "required": [ - "Day", - "StartTime", - "EndTime" - ], - "type": "object" - }, - "HoursOfOperationTimeSlice": { - "additionalProperties": false, - "description": "The start time or end time for an hours of operation.", - "properties": { - "Hours": { - "description": "The hours.", - "maximum": 23, - "minimum": 0, - "type": "integer" - }, - "Minutes": { - "description": "The minutes.", - "maximum": 59, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Hours", - "Minutes" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::HoursOfOperation", - "handlers": { - "create": { - "permissions": [ - "connect:CreateHoursOfOperation", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteHoursOfOperation", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListHoursOfOperations" - ] - }, - "read": { - "permissions": [ - "connect:DescribeHoursOfOperation" - ] - }, - "update": { - "permissions": [ - "connect:UpdateHoursOfOperation", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/HoursOfOperationArn" - ], - "properties": { - "Config": { - "description": "Configuration information for the hours of operation: day, start time, and end time.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HoursOfOperationConfig" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - }, - "Description": { - "description": "The description of the hours of operation.", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "HoursOfOperationArn": { - "description": "The Amazon Resource Name (ARN) for the hours of operation.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$", - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the hours of operation.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TimeZone": { - "description": "The time zone of the hours of operation.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/HoursOfOperationArn" - ], - "required": [ - "InstanceArn", - "Name", - "TimeZone", - "Config" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::HoursOfOperation" -} +{ + "additionalProperties": false, + "definitions": { + "HoursOfOperationConfig": { + "additionalProperties": false, + "description": "Contains information about the hours of operation.", + "properties": { + "Day": { + "description": "The day that the hours of operation applies to.", + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + }, + "EndTime": { + "$ref": "#/definitions/HoursOfOperationTimeSlice", + "description": "The end time that your contact center closes." + }, + "StartTime": { + "$ref": "#/definitions/HoursOfOperationTimeSlice", + "description": "The start time that your contact center opens." + } + }, + "required": [ + "Day", + "StartTime", + "EndTime" + ], + "type": "object" + }, + "HoursOfOperationTimeSlice": { + "additionalProperties": false, + "description": "The start time or end time for an hours of operation.", + "properties": { + "Hours": { + "description": "The hours.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "Minutes": { + "description": "The minutes.", + "maximum": 59, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Hours", + "Minutes" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::HoursOfOperation", + "handlers": { + "create": { + "permissions": [ + "connect:CreateHoursOfOperation", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteHoursOfOperation", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListHoursOfOperations" + ] + }, + "read": { + "permissions": [ + "connect:DescribeHoursOfOperation" + ] + }, + "update": { + "permissions": [ + "connect:UpdateHoursOfOperation", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/HoursOfOperationArn" + ], + "properties": { + "Config": { + "description": "Configuration information for the hours of operation: day, start time, and end time.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HoursOfOperationConfig" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "The description of the hours of operation.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "HoursOfOperationArn": { + "description": "The Amazon Resource Name (ARN) for the hours of operation.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$", + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the hours of operation.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TimeZone": { + "description": "The time zone of the hours of operation.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/HoursOfOperationArn" + ], + "required": [ + "InstanceArn", + "Name", + "TimeZone", + "Config" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::HoursOfOperation" +} diff --git a/schema/aws-connect-instance.json b/schema/aws-connect-instance.json index 747460f..29bf212 100644 --- a/schema/aws-connect-instance.json +++ b/schema/aws-connect-instance.json @@ -1,238 +1,238 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DirectoryId", - "/properties/InstanceAlias", - "/properties/IdentityManagementType" - ], - "definitions": { - "Attributes": { - "additionalProperties": false, - "properties": { - "AutoResolveBestVoices": { - "$ref": "#/definitions/AutoResolveBestVoices" - }, - "ContactLens": { - "$ref": "#/definitions/ContactLens" - }, - "ContactflowLogs": { - "$ref": "#/definitions/ContactflowLogs" - }, - "EarlyMedia": { - "$ref": "#/definitions/EarlyMedia" - }, - "InboundCalls": { - "$ref": "#/definitions/InboundCalls" - }, - "OutboundCalls": { - "$ref": "#/definitions/OutboundCalls" - }, - "UseCustomTTSVoices": { - "$ref": "#/definitions/UseCustomTTSVoices" - } - }, - "required": [ - "InboundCalls", - "OutboundCalls" - ], - "type": "object" - }, - "AutoResolveBestVoices": { - "description": "Boolean flag which enables AUTO_RESOLVE_BEST_VOICES on an instance.", - "type": "boolean" - }, - "ContactLens": { - "description": "Boolean flag which enables CONTACT_LENS on an instance.", - "type": "boolean" - }, - "ContactflowLogs": { - "description": "Boolean flag which enables CONTACTFLOW_LOGS on an instance.", - "type": "boolean" - }, - "EarlyMedia": { - "description": "Boolean flag which enables EARLY_MEDIA on an instance.", - "type": "boolean" - }, - "InboundCalls": { - "description": "Mandatory element which enables inbound calls on new instance.", - "type": "boolean" - }, - "OutboundCalls": { - "description": "Mandatory element which enables outbound calls on new instance.", - "type": "boolean" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UseCustomTTSVoices": { - "description": "Boolean flag which enables USE_CUSTOM_TTS_VOICES on an instance.", - "type": "boolean" - } - }, - "description": "Resource Type definition for AWS::Connect::Instance", - "handlers": { - "create": { - "permissions": [ - "connect:CreateInstance", - "connect:DescribeInstance", - "connect:UpdateInstanceAttribute", - "connect:TagResource", - "ds:CheckAlias", - "ds:CreateAlias", - "ds:AuthorizeApplication", - "ds:UnauthorizeApplication", - "ds:CreateIdentityPoolDirectory", - "ds:CreateDirectory", - "ds:DescribeDirectories", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "logs:CreateLogGroup" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteInstance", - "connect:DescribeInstance", - "connect:UntagResource", - "ds:DeleteDirectory", - "ds:UnauthorizeApplication", - "ds:DescribeDirectories" - ] - }, - "list": { - "permissions": [ - "connect:ListInstances", - "connect:ListInstanceAttributes", - "ds:DescribeDirectories" - ] - }, - "read": { - "permissions": [ - "connect:DescribeInstance", - "connect:ListInstanceAttributes", - "ds:DescribeDirectories" - ] - }, - "update": { - "permissions": [ - "connect:ListInstanceAttributes", - "connect:UpdateInstanceAttribute", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "An instanceArn is automatically generated on creation based on instanceId.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Attributes": { - "$ref": "#/definitions/Attributes", - "description": "The attributes for the instance." - }, - "CreatedTime": { - "description": "Timestamp of instance creation logged as part of instance creation.", - "format": "date-time", - "type": "string" - }, - "DirectoryId": { - "description": "Existing directoryId user wants to map to the new Connect instance.", - "maxLength": 12, - "minLength": 12, - "pattern": "^d-[0-9a-f]{10}$", - "type": "string" - }, - "Id": { - "description": "An instanceId is automatically generated on creation and assigned as the unique identifier.", - "type": "string" - }, - "IdentityManagementType": { - "description": "Specifies the type of directory integration for new instance.", - "enum": [ - "SAML", - "CONNECT_MANAGED", - "EXISTING_DIRECTORY" - ], - "type": "string" - }, - "InstanceAlias": { - "description": "Alias of the new directory created as part of new instance creation.", - "maxLength": 62, - "minLength": 1, - "pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$", - "type": "string" - }, - "InstanceStatus": { - "description": "Specifies the creation status of new instance.", - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_FAILED", - "ACTIVE" - ], - "type": "string" - }, - "ServiceRole": { - "description": "Service linked role created as part of instance creation.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/ServiceRole", - "/properties/CreatedTime", - "/properties/InstanceStatus" - ], - "required": [ - "IdentityManagementType", - "Attributes" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::Instance", - "writeOnlyProperties": [ - "/properties/DirectoryId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DirectoryId", + "/properties/InstanceAlias", + "/properties/IdentityManagementType" + ], + "definitions": { + "Attributes": { + "additionalProperties": false, + "properties": { + "AutoResolveBestVoices": { + "$ref": "#/definitions/AutoResolveBestVoices" + }, + "ContactLens": { + "$ref": "#/definitions/ContactLens" + }, + "ContactflowLogs": { + "$ref": "#/definitions/ContactflowLogs" + }, + "EarlyMedia": { + "$ref": "#/definitions/EarlyMedia" + }, + "InboundCalls": { + "$ref": "#/definitions/InboundCalls" + }, + "OutboundCalls": { + "$ref": "#/definitions/OutboundCalls" + }, + "UseCustomTTSVoices": { + "$ref": "#/definitions/UseCustomTTSVoices" + } + }, + "required": [ + "InboundCalls", + "OutboundCalls" + ], + "type": "object" + }, + "AutoResolveBestVoices": { + "description": "Boolean flag which enables AUTO_RESOLVE_BEST_VOICES on an instance.", + "type": "boolean" + }, + "ContactLens": { + "description": "Boolean flag which enables CONTACT_LENS on an instance.", + "type": "boolean" + }, + "ContactflowLogs": { + "description": "Boolean flag which enables CONTACTFLOW_LOGS on an instance.", + "type": "boolean" + }, + "EarlyMedia": { + "description": "Boolean flag which enables EARLY_MEDIA on an instance.", + "type": "boolean" + }, + "InboundCalls": { + "description": "Mandatory element which enables inbound calls on new instance.", + "type": "boolean" + }, + "OutboundCalls": { + "description": "Mandatory element which enables outbound calls on new instance.", + "type": "boolean" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UseCustomTTSVoices": { + "description": "Boolean flag which enables USE_CUSTOM_TTS_VOICES on an instance.", + "type": "boolean" + } + }, + "description": "Resource Type definition for AWS::Connect::Instance", + "handlers": { + "create": { + "permissions": [ + "connect:CreateInstance", + "connect:DescribeInstance", + "connect:UpdateInstanceAttribute", + "connect:TagResource", + "ds:CheckAlias", + "ds:CreateAlias", + "ds:AuthorizeApplication", + "ds:UnauthorizeApplication", + "ds:CreateIdentityPoolDirectory", + "ds:CreateDirectory", + "ds:DescribeDirectories", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "logs:CreateLogGroup" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteInstance", + "connect:DescribeInstance", + "connect:UntagResource", + "ds:DeleteDirectory", + "ds:UnauthorizeApplication", + "ds:DescribeDirectories" + ] + }, + "list": { + "permissions": [ + "connect:ListInstances", + "connect:ListInstanceAttributes", + "ds:DescribeDirectories" + ] + }, + "read": { + "permissions": [ + "connect:DescribeInstance", + "connect:ListInstanceAttributes", + "ds:DescribeDirectories" + ] + }, + "update": { + "permissions": [ + "connect:ListInstanceAttributes", + "connect:UpdateInstanceAttribute", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "An instanceArn is automatically generated on creation based on instanceId.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Attributes": { + "$ref": "#/definitions/Attributes", + "description": "The attributes for the instance." + }, + "CreatedTime": { + "description": "Timestamp of instance creation logged as part of instance creation.", + "format": "date-time", + "type": "string" + }, + "DirectoryId": { + "description": "Existing directoryId user wants to map to the new Connect instance.", + "maxLength": 12, + "minLength": 12, + "pattern": "^d-[0-9a-f]{10}$", + "type": "string" + }, + "Id": { + "description": "An instanceId is automatically generated on creation and assigned as the unique identifier.", + "type": "string" + }, + "IdentityManagementType": { + "description": "Specifies the type of directory integration for new instance.", + "enum": [ + "SAML", + "CONNECT_MANAGED", + "EXISTING_DIRECTORY" + ], + "type": "string" + }, + "InstanceAlias": { + "description": "Alias of the new directory created as part of new instance creation.", + "maxLength": 62, + "minLength": 1, + "pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$", + "type": "string" + }, + "InstanceStatus": { + "description": "Specifies the creation status of new instance.", + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_FAILED", + "ACTIVE" + ], + "type": "string" + }, + "ServiceRole": { + "description": "Service linked role created as part of instance creation.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/ServiceRole", + "/properties/CreatedTime", + "/properties/InstanceStatus" + ], + "required": [ + "IdentityManagementType", + "Attributes" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::Instance", + "writeOnlyProperties": [ + "/properties/DirectoryId" + ] +} diff --git a/schema/aws-connect-instancestorageconfig.json b/schema/aws-connect-instancestorageconfig.json index 04bb734..d8dc796 100644 --- a/schema/aws-connect-instancestorageconfig.json +++ b/schema/aws-connect-instancestorageconfig.json @@ -1,262 +1,262 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn", - "/properties/ResourceType" - ], - "definitions": { - "AssociationId": { - "description": "An associationID is automatically generated when a storage config is associated with an instance", - "maxLength": 100, - "minLength": 1, - "pattern": "^[-a-z0-9]*$", - "type": "string" - }, - "BucketName": { - "description": "A name for the S3 Bucket", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "EncryptionConfig": { - "additionalProperties": false, - "properties": { - "EncryptionType": { - "$ref": "#/definitions/EncryptionType" - }, - "KeyId": { - "$ref": "#/definitions/KeyId" - } - }, - "required": [ - "EncryptionType", - "KeyId" - ], - "type": "object" - }, - "EncryptionType": { - "description": "Specifies default encryption using AWS KMS-Managed Keys", - "enum": [ - "KMS" - ], - "type": "string" - }, - "FirehoseDeliveryStreamArn": { - "description": "An ARN is a unique AWS resource identifier.", - "pattern": "^arn:aws[-a-z0-9]*:firehose:[-a-z0-9]*:[0-9]{12}:deliverystream/[-a-zA-Z0-9_.]*$", - "type": "string" - }, - "Hours": { - "description": "Number of hours", - "type": "number" - }, - "InstanceStorageResourceType": { - "description": "Specifies the type of storage resource available for the instance", - "enum": [ - "CHAT_TRANSCRIPTS", - "CALL_RECORDINGS", - "SCHEDULED_REPORTS", - "MEDIA_STREAMS", - "CONTACT_TRACE_RECORDS", - "AGENT_EVENTS" - ], - "type": "string" - }, - "KeyId": { - "description": "Specifies the encryption key id", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "KinesisFirehoseConfig": { - "additionalProperties": false, - "properties": { - "FirehoseArn": { - "$ref": "#/definitions/FirehoseDeliveryStreamArn" - } - }, - "required": [ - "FirehoseArn" - ], - "type": "object" - }, - "KinesisStreamArn": { - "description": "An ARN is a unique AWS resource identifier.", - "pattern": "^arn:aws[-a-z0-9]*:kinesis:[-a-z0-9]*:[0-9]{12}:stream/[-a-zA-Z0-9_.]*$", - "type": "string" - }, - "KinesisStreamConfig": { - "additionalProperties": false, - "properties": { - "StreamArn": { - "$ref": "#/definitions/KinesisStreamArn" - } - }, - "required": [ - "StreamArn" - ], - "type": "object" - }, - "KinesisVideoStreamConfig": { - "additionalProperties": false, - "properties": { - "EncryptionConfig": { - "$ref": "#/definitions/EncryptionConfig" - }, - "Prefix": { - "$ref": "#/definitions/Prefix" - }, - "RetentionPeriodHours": { - "$ref": "#/definitions/Hours" - } - }, - "required": [ - "Prefix", - "RetentionPeriodHours", - "EncryptionConfig" - ], - "type": "object" - }, - "Prefix": { - "description": "Prefixes are used to infer logical hierarchy", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "S3Config": { - "additionalProperties": false, - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "BucketPrefix": { - "$ref": "#/definitions/Prefix" - }, - "EncryptionConfig": { - "$ref": "#/definitions/EncryptionConfig" - } - }, - "required": [ - "BucketName", - "BucketPrefix" - ], - "type": "object" - }, - "StorageType": { - "description": "Specifies the storage type to be associated with the instance", - "enum": [ - "S3", - "KINESIS_VIDEO_STREAM", - "KINESIS_STREAM", - "KINESIS_FIREHOSE" - ], - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::InstanceStorageConfig", - "handlers": { - "create": { - "permissions": [ - "connect:AssociateInstanceStorageConfig", - "connect:DescribeInstance", - "ds:DescribeDirectories", - "s3:GetBucketAcl", - "s3:GetBucketLocation", - "iam:PutRolePolicy", - "kinesis:DescribeStream", - "kms:DescribeKey", - "kms:CreateGrant", - "firehose:DescribeDeliveryStream" - ] - }, - "delete": { - "permissions": [ - "connect:DisassociateInstanceStorageConfig", - "connect:DescribeInstance", - "s3:GetBucketAcl", - "s3:GetBucketLocation", - "kms:RetireGrant" - ] - }, - "list": { - "permissions": [ - "connect:DescribeInstance", - "connect:ListInstanceStorageConfigs", - "ds:DescribeDirectories" - ] - }, - "read": { - "permissions": [ - "connect:DescribeInstanceStorageConfig", - "connect:ListInstanceStorageConfigs", - "connect:DescribeInstance", - "ds:DescribeDirectories", - "s3:GetBucketAcl", - "s3:GetBucketLocation" - ] - }, - "update": { - "permissions": [ - "connect:UpdateInstanceStorageConfig", - "ds:DescribeDirectories", - "s3:GetBucketAcl", - "s3:GetBucketLocation", - "kinesis:DescribeStream", - "iam:PutRolePolicy", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:RetireGrant", - "firehose:DescribeDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn", - "/properties/AssociationId", - "/properties/ResourceType" - ], - "properties": { - "AssociationId": { - "$ref": "#/definitions/AssociationId" - }, - "InstanceArn": { - "description": "Connect Instance ID with which the storage config will be associated", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "KinesisFirehoseConfig": { - "$ref": "#/definitions/KinesisFirehoseConfig" - }, - "KinesisStreamConfig": { - "$ref": "#/definitions/KinesisStreamConfig" - }, - "KinesisVideoStreamConfig": { - "$ref": "#/definitions/KinesisVideoStreamConfig" - }, - "ResourceType": { - "$ref": "#/definitions/InstanceStorageResourceType" - }, - "S3Config": { - "$ref": "#/definitions/S3Config" - }, - "StorageType": { - "$ref": "#/definitions/StorageType" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId" - ], - "required": [ - "InstanceArn", - "ResourceType", - "StorageType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Connect::InstanceStorageConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/ResourceType" + ], + "definitions": { + "AssociationId": { + "description": "An associationID is automatically generated when a storage config is associated with an instance", + "maxLength": 100, + "minLength": 1, + "pattern": "^[-a-z0-9]*$", + "type": "string" + }, + "BucketName": { + "description": "A name for the S3 Bucket", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "EncryptionConfig": { + "additionalProperties": false, + "properties": { + "EncryptionType": { + "$ref": "#/definitions/EncryptionType" + }, + "KeyId": { + "$ref": "#/definitions/KeyId" + } + }, + "required": [ + "EncryptionType", + "KeyId" + ], + "type": "object" + }, + "EncryptionType": { + "description": "Specifies default encryption using AWS KMS-Managed Keys", + "enum": [ + "KMS" + ], + "type": "string" + }, + "FirehoseDeliveryStreamArn": { + "description": "An ARN is a unique AWS resource identifier.", + "pattern": "^arn:aws[-a-z0-9]*:firehose:[-a-z0-9]*:[0-9]{12}:deliverystream/[-a-zA-Z0-9_.]*$", + "type": "string" + }, + "Hours": { + "description": "Number of hours", + "type": "number" + }, + "InstanceStorageResourceType": { + "description": "Specifies the type of storage resource available for the instance", + "enum": [ + "CHAT_TRANSCRIPTS", + "CALL_RECORDINGS", + "SCHEDULED_REPORTS", + "MEDIA_STREAMS", + "CONTACT_TRACE_RECORDS", + "AGENT_EVENTS" + ], + "type": "string" + }, + "KeyId": { + "description": "Specifies the encryption key id", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "KinesisFirehoseConfig": { + "additionalProperties": false, + "properties": { + "FirehoseArn": { + "$ref": "#/definitions/FirehoseDeliveryStreamArn" + } + }, + "required": [ + "FirehoseArn" + ], + "type": "object" + }, + "KinesisStreamArn": { + "description": "An ARN is a unique AWS resource identifier.", + "pattern": "^arn:aws[-a-z0-9]*:kinesis:[-a-z0-9]*:[0-9]{12}:stream/[-a-zA-Z0-9_.]*$", + "type": "string" + }, + "KinesisStreamConfig": { + "additionalProperties": false, + "properties": { + "StreamArn": { + "$ref": "#/definitions/KinesisStreamArn" + } + }, + "required": [ + "StreamArn" + ], + "type": "object" + }, + "KinesisVideoStreamConfig": { + "additionalProperties": false, + "properties": { + "EncryptionConfig": { + "$ref": "#/definitions/EncryptionConfig" + }, + "Prefix": { + "$ref": "#/definitions/Prefix" + }, + "RetentionPeriodHours": { + "$ref": "#/definitions/Hours" + } + }, + "required": [ + "Prefix", + "RetentionPeriodHours", + "EncryptionConfig" + ], + "type": "object" + }, + "Prefix": { + "description": "Prefixes are used to infer logical hierarchy", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "S3Config": { + "additionalProperties": false, + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "BucketPrefix": { + "$ref": "#/definitions/Prefix" + }, + "EncryptionConfig": { + "$ref": "#/definitions/EncryptionConfig" + } + }, + "required": [ + "BucketName", + "BucketPrefix" + ], + "type": "object" + }, + "StorageType": { + "description": "Specifies the storage type to be associated with the instance", + "enum": [ + "S3", + "KINESIS_VIDEO_STREAM", + "KINESIS_STREAM", + "KINESIS_FIREHOSE" + ], + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::InstanceStorageConfig", + "handlers": { + "create": { + "permissions": [ + "connect:AssociateInstanceStorageConfig", + "connect:DescribeInstance", + "ds:DescribeDirectories", + "s3:GetBucketAcl", + "s3:GetBucketLocation", + "iam:PutRolePolicy", + "kinesis:DescribeStream", + "kms:DescribeKey", + "kms:CreateGrant", + "firehose:DescribeDeliveryStream" + ] + }, + "delete": { + "permissions": [ + "connect:DisassociateInstanceStorageConfig", + "connect:DescribeInstance", + "s3:GetBucketAcl", + "s3:GetBucketLocation", + "kms:RetireGrant" + ] + }, + "list": { + "permissions": [ + "connect:DescribeInstance", + "connect:ListInstanceStorageConfigs", + "ds:DescribeDirectories" + ] + }, + "read": { + "permissions": [ + "connect:DescribeInstanceStorageConfig", + "connect:ListInstanceStorageConfigs", + "connect:DescribeInstance", + "ds:DescribeDirectories", + "s3:GetBucketAcl", + "s3:GetBucketLocation" + ] + }, + "update": { + "permissions": [ + "connect:UpdateInstanceStorageConfig", + "ds:DescribeDirectories", + "s3:GetBucketAcl", + "s3:GetBucketLocation", + "kinesis:DescribeStream", + "iam:PutRolePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:RetireGrant", + "firehose:DescribeDeliveryStream" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn", + "/properties/AssociationId", + "/properties/ResourceType" + ], + "properties": { + "AssociationId": { + "$ref": "#/definitions/AssociationId" + }, + "InstanceArn": { + "description": "Connect Instance ID with which the storage config will be associated", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "KinesisFirehoseConfig": { + "$ref": "#/definitions/KinesisFirehoseConfig" + }, + "KinesisStreamConfig": { + "$ref": "#/definitions/KinesisStreamConfig" + }, + "KinesisVideoStreamConfig": { + "$ref": "#/definitions/KinesisVideoStreamConfig" + }, + "ResourceType": { + "$ref": "#/definitions/InstanceStorageResourceType" + }, + "S3Config": { + "$ref": "#/definitions/S3Config" + }, + "StorageType": { + "$ref": "#/definitions/StorageType" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId" + ], + "required": [ + "InstanceArn", + "ResourceType", + "StorageType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::InstanceStorageConfig" +} diff --git a/schema/aws-connect-integrationassociation.json b/schema/aws-connect-integrationassociation.json index 26a0624..bfe0dc2 100644 --- a/schema/aws-connect-integrationassociation.json +++ b/schema/aws-connect-integrationassociation.json @@ -1,159 +1,159 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceId", - "/properties/IntegrationArn", - "/properties/IntegrationType" - ], - "definitions": { - "InstanceId": { - "description": "Amazon Connect instance identifier", - "maxLength": 100, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "IntegrationArn": { - "description": "ARN of Integration being associated with the instance", - "maxLength": 140, - "minLength": 1, - "type": "string" - }, - "IntegrationAssociationId": { - "description": "Identifier of the association with Connect Instance", - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", - "type": "string" - }, - "IntegrationType": { - "description": "Specifies the integration type to be associated with the instance", - "enum": [ - "LEX_BOT", - "LAMBDA_FUNCTION", - "APPLICATION" - ], - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::IntegrationAssociation", - "handlers": { - "create": { - "permissions": [ - "connect:DescribeInstance", - "ds:DescribeDirectories", - "app-integrations:CreateEventIntegrationAssociation", - "mobiletargeting:GetApp", - "cases:GetDomain", - "wisdom:GetAssistant", - "wisdom:GetKnowledgeBase", - "wisdom:TagResource", - "voiceid:DescribeDomain", - "events:PutTargets", - "events:PutRule", - "connect:AssociateBot", - "connect:AssociateLambdaFunction", - "connect:CreateIntegrationAssociation", - "connect:ListBots", - "connect:ListLambdaFunctions", - "connect:ListIntegrationAssociations", - "lambda:addPermission", - "lex:GetBot", - "lex:DescribeBotAlias", - "lex:CreateResourcePolicy", - "lex:UpdateResourcePolicy", - "lex:CreateResourcePolicyStatement", - "lambda:AddPermission", - "app-integrations:GetApplication", - "app-integrations:CreateApplicationAssociation", - "iam:AttachRolePolicy", - "iam:CreateServiceLinkedRole", - "iam:GetRolePolicy", - "iam:PutRolePolicy" - ] - }, - "delete": { - "permissions": [ - "connect:DescribeInstance", - "ds:DescribeDirectories", - "app-integrations:DeleteEventIntegrationAssociation", - "app-integrations:DeleteApplicationAssociation", - "events:ListTargetsByRule", - "events:RemoveTargets", - "events:DeleteRule", - "connect:DisassociateBot", - "connect:DisassociateLambdaFunction", - "connect:DeleteIntegrationAssociation", - "connect:ListBots", - "connect:ListLambdaFunctions", - "connect:ListIntegrationAssociations", - "lex:DeleteResourcePolicy", - "lex:DeleteResourcePolicyStatement", - "lambda:RemovePermission", - "iam:GetRolePolicy", - "iam:DeleteRolePolicy", - "iam:PutRolePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceId": { - "$ref": "resource-schema.json#/properties/InstanceId" - } - }, - "required": [ - "InstanceId" - ] - }, - "permissions": [ - "connect:ListBots", - "connect:ListLambdaFunctions", - "connect:ListIntegrationAssociations" - ] - }, - "read": { - "permissions": [ - "connect:ListBots", - "connect:ListLambdaFunctions", - "connect:ListIntegrationAssociations" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/InstanceId", - "/properties/IntegrationType", - "/properties/IntegrationArn" - ], - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId" - }, - "IntegrationArn": { - "$ref": "#/definitions/IntegrationArn" - }, - "IntegrationAssociationId": { - "$ref": "#/definitions/IntegrationAssociationId" - }, - "IntegrationType": { - "$ref": "#/definitions/IntegrationType" - } - }, - "readOnlyProperties": [ - "/properties/IntegrationAssociationId" - ], - "required": [ - "InstanceId", - "IntegrationType", - "IntegrationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Connect::IntegrationAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceId", + "/properties/IntegrationArn", + "/properties/IntegrationType" + ], + "definitions": { + "InstanceId": { + "description": "Amazon Connect instance identifier", + "maxLength": 100, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "IntegrationArn": { + "description": "ARN of Integration being associated with the instance", + "maxLength": 140, + "minLength": 1, + "type": "string" + }, + "IntegrationAssociationId": { + "description": "Identifier of the association with Connect Instance", + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", + "type": "string" + }, + "IntegrationType": { + "description": "Specifies the integration type to be associated with the instance", + "enum": [ + "LEX_BOT", + "LAMBDA_FUNCTION", + "APPLICATION" + ], + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::IntegrationAssociation", + "handlers": { + "create": { + "permissions": [ + "connect:DescribeInstance", + "ds:DescribeDirectories", + "app-integrations:CreateEventIntegrationAssociation", + "mobiletargeting:GetApp", + "cases:GetDomain", + "wisdom:GetAssistant", + "wisdom:GetKnowledgeBase", + "wisdom:TagResource", + "voiceid:DescribeDomain", + "events:PutTargets", + "events:PutRule", + "connect:AssociateBot", + "connect:AssociateLambdaFunction", + "connect:CreateIntegrationAssociation", + "connect:ListBots", + "connect:ListLambdaFunctions", + "connect:ListIntegrationAssociations", + "lambda:addPermission", + "lex:GetBot", + "lex:DescribeBotAlias", + "lex:CreateResourcePolicy", + "lex:UpdateResourcePolicy", + "lex:CreateResourcePolicyStatement", + "lambda:AddPermission", + "app-integrations:GetApplication", + "app-integrations:CreateApplicationAssociation", + "iam:AttachRolePolicy", + "iam:CreateServiceLinkedRole", + "iam:GetRolePolicy", + "iam:PutRolePolicy" + ] + }, + "delete": { + "permissions": [ + "connect:DescribeInstance", + "ds:DescribeDirectories", + "app-integrations:DeleteEventIntegrationAssociation", + "app-integrations:DeleteApplicationAssociation", + "events:ListTargetsByRule", + "events:RemoveTargets", + "events:DeleteRule", + "connect:DisassociateBot", + "connect:DisassociateLambdaFunction", + "connect:DeleteIntegrationAssociation", + "connect:ListBots", + "connect:ListLambdaFunctions", + "connect:ListIntegrationAssociations", + "lex:DeleteResourcePolicy", + "lex:DeleteResourcePolicyStatement", + "lambda:RemovePermission", + "iam:GetRolePolicy", + "iam:DeleteRolePolicy", + "iam:PutRolePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceId": { + "$ref": "resource-schema.json#/properties/InstanceId" + } + }, + "required": [ + "InstanceId" + ] + }, + "permissions": [ + "connect:ListBots", + "connect:ListLambdaFunctions", + "connect:ListIntegrationAssociations" + ] + }, + "read": { + "permissions": [ + "connect:ListBots", + "connect:ListLambdaFunctions", + "connect:ListIntegrationAssociations" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/InstanceId", + "/properties/IntegrationType", + "/properties/IntegrationArn" + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId" + }, + "IntegrationArn": { + "$ref": "#/definitions/IntegrationArn" + }, + "IntegrationAssociationId": { + "$ref": "#/definitions/IntegrationAssociationId" + }, + "IntegrationType": { + "$ref": "#/definitions/IntegrationType" + } + }, + "readOnlyProperties": [ + "/properties/IntegrationAssociationId" + ], + "required": [ + "InstanceId", + "IntegrationType", + "IntegrationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::IntegrationAssociation" +} diff --git a/schema/aws-connect-phonenumber.json b/schema/aws-connect-phonenumber.json index 494e8a2..1398c19 100644 --- a/schema/aws-connect-phonenumber.json +++ b/schema/aws-connect-phonenumber.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/CountryCode", - "/properties/Prefix", - "/properties/SourcePhoneNumberArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::PhoneNumber", - "handlers": { - "create": { - "permissions": [ - "connect:ClaimPhoneNumber", - "connect:SearchAvailablePhoneNumbers", - "connect:DescribePhoneNumber", - "connect:TagResource", - "connect:ImportPhoneNumber", - "sms-voice:DescribePhoneNumbers" - ] - }, - "delete": { - "permissions": [ - "connect:ReleasePhoneNumber", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TargetArn": { - "$ref": "resource-schema.json#/properties/TargetArn" - } - }, - "required": [ - "TargetArn" - ] - }, - "permissions": [ - "connect:ListPhoneNumbersV2" - ] - }, - "read": { - "permissions": [ - "connect:DescribePhoneNumber" - ] - }, - "update": { - "permissions": [ - "connect:UpdatePhoneNumber", - "connect:UpdatePhoneNumberMetadata", - "connect:DescribePhoneNumber", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PhoneNumberArn" - ], - "properties": { - "Address": { - "description": "The phone number e164 address.", - "pattern": "^\\+[0-9]{2,15}", - "type": "string" - }, - "CountryCode": { - "description": "The phone number country code.", - "pattern": "^[A-Z]{2}", - "type": "string" - }, - "Description": { - "description": "The description of the phone number.", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "PhoneNumberArn": { - "description": "The phone number ARN", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:phone-number/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Prefix": { - "description": "The phone number prefix.", - "pattern": "^\\+[0-9]{1,15}", - "type": "string" - }, - "SourcePhoneNumberArn": { - "description": "The source phone number arn.", - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TargetArn": { - "description": "The ARN of the target the phone number is claimed to.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:(instance|traffic-distribution-group)/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Type": { - "description": "The phone number type", - "pattern": "TOLL_FREE|DID|UIFN|SHARED|THIRD_PARTY_DID|THIRD_PARTY_TF|SHORT_CODE", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PhoneNumberArn", - "/properties/Address" - ], - "required": [ - "TargetArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::PhoneNumber", - "writeOnlyProperties": [ - "/properties/Prefix" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/CountryCode", + "/properties/Prefix", + "/properties/SourcePhoneNumberArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::PhoneNumber", + "handlers": { + "create": { + "permissions": [ + "connect:ClaimPhoneNumber", + "connect:SearchAvailablePhoneNumbers", + "connect:DescribePhoneNumber", + "connect:TagResource", + "connect:ImportPhoneNumber", + "sms-voice:DescribePhoneNumbers" + ] + }, + "delete": { + "permissions": [ + "connect:ReleasePhoneNumber", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TargetArn": { + "$ref": "resource-schema.json#/properties/TargetArn" + } + }, + "required": [ + "TargetArn" + ] + }, + "permissions": [ + "connect:ListPhoneNumbersV2" + ] + }, + "read": { + "permissions": [ + "connect:DescribePhoneNumber" + ] + }, + "update": { + "permissions": [ + "connect:UpdatePhoneNumber", + "connect:UpdatePhoneNumberMetadata", + "connect:DescribePhoneNumber", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PhoneNumberArn" + ], + "properties": { + "Address": { + "description": "The phone number e164 address.", + "pattern": "^\\+[0-9]{2,15}", + "type": "string" + }, + "CountryCode": { + "description": "The phone number country code.", + "pattern": "^[A-Z]{2}", + "type": "string" + }, + "Description": { + "description": "The description of the phone number.", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "PhoneNumberArn": { + "description": "The phone number ARN", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:phone-number/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Prefix": { + "description": "The phone number prefix.", + "pattern": "^\\+[0-9]{1,15}", + "type": "string" + }, + "SourcePhoneNumberArn": { + "description": "The source phone number arn.", + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TargetArn": { + "description": "The ARN of the target the phone number is claimed to.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:(instance|traffic-distribution-group)/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Type": { + "description": "The phone number type", + "pattern": "TOLL_FREE|DID|UIFN|SHARED|THIRD_PARTY_DID|THIRD_PARTY_TF|SHORT_CODE", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PhoneNumberArn", + "/properties/Address" + ], + "required": [ + "TargetArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::PhoneNumber", + "writeOnlyProperties": [ + "/properties/Prefix" + ] +} diff --git a/schema/aws-connect-predefinedattribute.json b/schema/aws-connect-predefinedattribute.json index 708e68d..ba6020c 100644 --- a/schema/aws-connect-predefinedattribute.json +++ b/schema/aws-connect-predefinedattribute.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn", - "/properties/Name" - ], - "definitions": { - "StringList": { - "description": "Predefined attribute values of type string list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Value" - }, - "maxItems": 128, - "minItems": 1, - "type": "array" - }, - "Value": { - "description": "Textual or numeric value that describes an attribute.", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::PredefinedAttribute", - "handlers": { - "create": { - "permissions": [ - "connect:CreatePredefinedAttribute" - ] - }, - "delete": { - "permissions": [ - "connect:DeletePredefinedAttribute" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListPredefinedAttributes" - ] - }, - "read": { - "permissions": [ - "connect:DescribePredefinedAttribute" - ] - }, - "update": { - "permissions": [ - "connect:UpdatePredefinedAttribute" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn", - "/properties/Name" - ], - "properties": { - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "LastModifiedRegion": { - "description": "Last modified region.", - "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", - "type": "string" - }, - "LastModifiedTime": { - "description": "Last modified time.", - "type": "number" - }, - "Name": { - "description": "The name of the predefined attribute.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Values": { - "additionalProperties": false, - "description": "The values of a predefined attribute.", - "properties": { - "StringList": { - "$ref": "#/definitions/StringList" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LastModifiedRegion", - "/properties/LastModifiedTime" - ], - "required": [ - "InstanceArn", - "Name", - "Values" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Connect::PredefinedAttribute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/Name" + ], + "definitions": { + "StringList": { + "description": "Predefined attribute values of type string list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Value" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + }, + "Value": { + "description": "Textual or numeric value that describes an attribute.", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::PredefinedAttribute", + "handlers": { + "create": { + "permissions": [ + "connect:CreatePredefinedAttribute" + ] + }, + "delete": { + "permissions": [ + "connect:DeletePredefinedAttribute" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListPredefinedAttributes" + ] + }, + "read": { + "permissions": [ + "connect:DescribePredefinedAttribute" + ] + }, + "update": { + "permissions": [ + "connect:UpdatePredefinedAttribute" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn", + "/properties/Name" + ], + "properties": { + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "LastModifiedRegion": { + "description": "Last modified region.", + "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", + "type": "string" + }, + "LastModifiedTime": { + "description": "Last modified time.", + "type": "number" + }, + "Name": { + "description": "The name of the predefined attribute.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Values": { + "additionalProperties": false, + "description": "The values of a predefined attribute.", + "properties": { + "StringList": { + "$ref": "#/definitions/StringList" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LastModifiedRegion", + "/properties/LastModifiedTime" + ], + "required": [ + "InstanceArn", + "Name", + "Values" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Connect::PredefinedAttribute" +} diff --git a/schema/aws-connect-prompt.json b/schema/aws-connect-prompt.json index fc43407..a18cdac 100644 --- a/schema/aws-connect-prompt.json +++ b/schema/aws-connect-prompt.json @@ -1,134 +1,134 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::Prompt", - "handlers": { - "create": { - "permissions": [ - "connect:CreatePrompt", - "connect:TagResource", - "s3:GetObject", - "kms:Decrypt", - "s3:GetObjectAcl" - ] - }, - "delete": { - "permissions": [ - "connect:DeletePrompt" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListPrompts" - ] - }, - "read": { - "permissions": [ - "connect:DescribePrompt" - ] - }, - "update": { - "permissions": [ - "connect:UpdatePrompt", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PromptArn" - ], - "properties": { - "Description": { - "description": "The description of the prompt.", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the prompt.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "PromptArn": { - "description": "The Amazon Resource Name (ARN) for the prompt.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/prompt/[-a-zA-Z0-9]*$", - "type": "string" - }, - "S3Uri": { - "description": "S3 URI of the customer's audio file for creating prompts resource..", - "maxLength": 2000, - "minLength": 1, - "pattern": "s3://\\S+/.+|https://\\S+\\.s3(\\.\\S+)?\\.amazonaws\\.com/\\S+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/PromptArn" - ], - "required": [ - "InstanceArn", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::Prompt", - "writeOnlyProperties": [ - "/properties/S3Uri" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::Prompt", + "handlers": { + "create": { + "permissions": [ + "connect:CreatePrompt", + "connect:TagResource", + "s3:GetObject", + "kms:Decrypt", + "s3:GetObjectAcl" + ] + }, + "delete": { + "permissions": [ + "connect:DeletePrompt" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListPrompts" + ] + }, + "read": { + "permissions": [ + "connect:DescribePrompt" + ] + }, + "update": { + "permissions": [ + "connect:UpdatePrompt", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PromptArn" + ], + "properties": { + "Description": { + "description": "The description of the prompt.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the prompt.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "PromptArn": { + "description": "The Amazon Resource Name (ARN) for the prompt.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/prompt/[-a-zA-Z0-9]*$", + "type": "string" + }, + "S3Uri": { + "description": "S3 URI of the customer's audio file for creating prompts resource..", + "maxLength": 2000, + "minLength": 1, + "pattern": "s3://\\S+/.+|https://\\S+\\.s3(\\.\\S+)?\\.amazonaws\\.com/\\S+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/PromptArn" + ], + "required": [ + "InstanceArn", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::Prompt", + "writeOnlyProperties": [ + "/properties/S3Uri" + ] +} diff --git a/schema/aws-connect-queue.json b/schema/aws-connect-queue.json index e230fa6..9d442cd 100644 --- a/schema/aws-connect-queue.json +++ b/schema/aws-connect-queue.json @@ -1,219 +1,224 @@ -{ - "additionalProperties": false, - "definitions": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "OutboundCallerConfig": { - "additionalProperties": false, - "description": "The outbound caller ID name, number, and outbound whisper flow.", - "properties": { - "OutboundCallerIdName": { - "$ref": "#/definitions/OutboundCallerIdName" - }, - "OutboundCallerIdNumberArn": { - "$ref": "#/definitions/OutboundCallerIdNumberArn" - }, - "OutboundFlowArn": { - "$ref": "#/definitions/OutboundFlowArn" - } - }, - "type": "object" - }, - "OutboundCallerIdName": { - "description": "The caller ID name.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "OutboundCallerIdNumberArn": { - "description": "The caller ID number.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:phone-number/[-a-zA-Z0-9]*$", - "type": "string" - }, - "OutboundFlowArn": { - "description": "The outbound whisper flow to be used during an outbound call.", - "maxLength": 500, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "QuickConnectArn": { - "description": "The Amazon Resource Name (ARN) for the quick connect.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/transfer-destination/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "$ref": "#/definitions/Key" - }, - "Value": { - "$ref": "#/definitions/Value" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::Queue", - "handlers": { - "create": { - "permissions": [ - "connect:CreateQueue", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteQueue", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListQueues", - "connect:ListQueueQuickConnects" - ] - }, - "read": { - "permissions": [ - "connect:DescribeQueue", - "connect:ListQueueQuickConnects" - ] - }, - "update": { - "permissions": [ - "connect:UpdateQueueHoursOfOperation", - "connect:UpdateQueueMaxContacts", - "connect:UpdateQueueName", - "connect:UpdateQueueOutboundCallerConfig", - "connect:UpdateQueueStatus", - "connect:AssociateQueueQuickConnects", - "connect:DisassociateQueueQuickConnects", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/QueueArn" - ], - "properties": { - "Description": { - "description": "The description of the queue.", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "HoursOfOperationArn": { - "description": "The identifier for the hours of operation.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$", - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "MaxContacts": { - "description": "The maximum number of contacts that can be in the queue before it is considered full.", - "minimum": 0, - "type": "integer" - }, - "Name": { - "description": "The name of the queue.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "OutboundCallerConfig": { - "$ref": "#/definitions/OutboundCallerConfig", - "description": "The outbound caller ID name, number, and outbound whisper flow." - }, - "QueueArn": { - "description": "The Amazon Resource Name (ARN) for the queue.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", - "type": "string" - }, - "QuickConnectArns": { - "description": "The quick connects available to agents who are working the queue.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/QuickConnectArn" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "Status": { - "description": "The status of the queue.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of queue.", - "enum": [ - "STANDARD", - "AGENT" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/QueueArn", - "/properties/Type" - ], - "required": [ - "InstanceArn", - "HoursOfOperationArn", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::Queue" -} +{ + "additionalProperties": false, + "definitions": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "OutboundCallerConfig": { + "additionalProperties": false, + "description": "The outbound caller ID name, number, and outbound whisper flow.", + "properties": { + "OutboundCallerIdName": { + "$ref": "#/definitions/OutboundCallerIdName" + }, + "OutboundCallerIdNumberArn": { + "$ref": "#/definitions/OutboundCallerIdNumberArn" + }, + "OutboundFlowArn": { + "$ref": "#/definitions/OutboundFlowArn" + } + }, + "type": "object" + }, + "OutboundCallerIdName": { + "description": "The caller ID name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "OutboundCallerIdNumberArn": { + "description": "The caller ID number.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:phone-number/[-a-zA-Z0-9]*$", + "type": "string" + }, + "OutboundFlowArn": { + "description": "The outbound whisper flow to be used during an outbound call.", + "maxLength": 500, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "QuickConnectArn": { + "description": "The Amazon Resource Name (ARN) for the quick connect.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/transfer-destination/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "$ref": "#/definitions/Key" + }, + "Value": { + "$ref": "#/definitions/Value" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::Queue", + "handlers": { + "create": { + "permissions": [ + "connect:CreateQueue", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteQueue", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListQueues", + "connect:ListQueueQuickConnects" + ] + }, + "read": { + "permissions": [ + "connect:DescribeQueue", + "connect:ListQueueQuickConnects" + ] + }, + "update": { + "permissions": [ + "connect:UpdateQueueHoursOfOperation", + "connect:UpdateQueueMaxContacts", + "connect:UpdateQueueName", + "connect:UpdateQueueOutboundCallerConfig", + "connect:UpdateQueueOutboundEmailConfig", + "connect:UpdateQueueStatus", + "connect:AssociateQueueQuickConnects", + "connect:DisassociateQueueQuickConnects", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/QueueArn" + ], + "properties": { + "Description": { + "description": "The description of the queue.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "HoursOfOperationArn": { + "description": "The identifier for the hours of operation.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$", + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "MaxContacts": { + "description": "The maximum number of contacts that can be in the queue before it is considered full.", + "minimum": 0, + "type": "integer" + }, + "Name": { + "description": "The name of the queue.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "OutboundCallerConfig": { + "$ref": "#/definitions/OutboundCallerConfig", + "description": "The outbound caller ID name, number, and outbound whisper flow." + }, + "QueueArn": { + "description": "The Amazon Resource Name (ARN) for the queue.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", + "type": "string" + }, + "QuickConnectArns": { + "description": "The quick connects available to agents who are working the queue.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/QuickConnectArn" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "Status": { + "description": "The status of the queue.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of queue.", + "enum": [ + "STANDARD", + "AGENT" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/QueueArn", + "/properties/Type" + ], + "required": [ + "InstanceArn", + "HoursOfOperationArn", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "connect:TagResource", + "connect:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::Queue" +} diff --git a/schema/aws-connect-quickconnect.json b/schema/aws-connect-quickconnect.json index 0c02df7..1005166 100644 --- a/schema/aws-connect-quickconnect.json +++ b/schema/aws-connect-quickconnect.json @@ -1,237 +1,237 @@ -{ - "additionalProperties": false, - "definitions": { - "ContactFlowArn": { - "description": "The identifier of the contact flow.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number in E.164 format.", - "pattern": "^\\+[1-9]\\d{1,14}$", - "type": "string" - }, - "PhoneNumberQuickConnectConfig": { - "additionalProperties": false, - "description": "The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.", - "properties": { - "PhoneNumber": { - "$ref": "#/definitions/PhoneNumber" - } - }, - "required": [ - "PhoneNumber" - ], - "type": "object" - }, - "QueueArn": { - "description": "The identifier for the queue.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", - "type": "string" - }, - "QueueQuickConnectConfig": { - "additionalProperties": false, - "description": "The queue configuration. This is required only if QuickConnectType is QUEUE.", - "properties": { - "ContactFlowArn": { - "$ref": "#/definitions/ContactFlowArn" - }, - "QueueArn": { - "$ref": "#/definitions/QueueArn" - } - }, - "required": [ - "ContactFlowArn", - "QueueArn" - ], - "type": "object" - }, - "QuickConnectConfig": { - "additionalProperties": false, - "description": "Configuration settings for the quick connect.", - "properties": { - "PhoneConfig": { - "$ref": "#/definitions/PhoneNumberQuickConnectConfig" - }, - "QueueConfig": { - "$ref": "#/definitions/QueueQuickConnectConfig" - }, - "QuickConnectType": { - "$ref": "#/definitions/QuickConnectType" - }, - "UserConfig": { - "$ref": "#/definitions/UserQuickConnectConfig" - } - }, - "required": [ - "QuickConnectType" - ], - "type": "object" - }, - "QuickConnectType": { - "description": "The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).", - "enum": [ - "PHONE_NUMBER", - "QUEUE", - "USER" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UserArn": { - "description": "The identifier of the user.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", - "type": "string" - }, - "UserQuickConnectConfig": { - "additionalProperties": false, - "description": "The user configuration. This is required only if QuickConnectType is USER.", - "properties": { - "ContactFlowArn": { - "$ref": "#/definitions/ContactFlowArn" - }, - "UserArn": { - "$ref": "#/definitions/UserArn" - } - }, - "required": [ - "ContactFlowArn", - "UserArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::QuickConnect", - "handlers": { - "create": { - "permissions": [ - "connect:CreateQuickConnect", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteQuickConnect", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListQuickConnects" - ] - }, - "read": { - "permissions": [ - "connect:DescribeQuickConnect" - ] - }, - "update": { - "permissions": [ - "connect:UpdateQuickConnectName", - "connect:UpdateQuickConnectConfig", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/QuickConnectArn" - ], - "properties": { - "Description": { - "description": "The description of the quick connect.", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the quick connect.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "QuickConnectArn": { - "description": "The Amazon Resource Name (ARN) for the quick connect.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/transfer-destination/[-a-zA-Z0-9]*$", - "type": "string" - }, - "QuickConnectConfig": { - "$ref": "#/definitions/QuickConnectConfig", - "description": "Configuration settings for the quick connect." - }, - "QuickConnectType": { - "description": "The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).", - "enum": [ - "PHONE_NUMBER", - "QUEUE", - "USER" - ], - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/QuickConnectArn", - "/properties/QuickConnectType" - ], - "required": [ - "Name", - "InstanceArn", - "QuickConnectConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::QuickConnect" -} +{ + "additionalProperties": false, + "definitions": { + "ContactFlowArn": { + "description": "The identifier of the contact flow.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number in E.164 format.", + "pattern": "^\\+[1-9]\\d{1,14}$", + "type": "string" + }, + "PhoneNumberQuickConnectConfig": { + "additionalProperties": false, + "description": "The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.", + "properties": { + "PhoneNumber": { + "$ref": "#/definitions/PhoneNumber" + } + }, + "required": [ + "PhoneNumber" + ], + "type": "object" + }, + "QueueArn": { + "description": "The identifier for the queue.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", + "type": "string" + }, + "QueueQuickConnectConfig": { + "additionalProperties": false, + "description": "The queue configuration. This is required only if QuickConnectType is QUEUE.", + "properties": { + "ContactFlowArn": { + "$ref": "#/definitions/ContactFlowArn" + }, + "QueueArn": { + "$ref": "#/definitions/QueueArn" + } + }, + "required": [ + "ContactFlowArn", + "QueueArn" + ], + "type": "object" + }, + "QuickConnectConfig": { + "additionalProperties": false, + "description": "Configuration settings for the quick connect.", + "properties": { + "PhoneConfig": { + "$ref": "#/definitions/PhoneNumberQuickConnectConfig" + }, + "QueueConfig": { + "$ref": "#/definitions/QueueQuickConnectConfig" + }, + "QuickConnectType": { + "$ref": "#/definitions/QuickConnectType" + }, + "UserConfig": { + "$ref": "#/definitions/UserQuickConnectConfig" + } + }, + "required": [ + "QuickConnectType" + ], + "type": "object" + }, + "QuickConnectType": { + "description": "The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).", + "enum": [ + "PHONE_NUMBER", + "QUEUE", + "USER" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserArn": { + "description": "The identifier of the user.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", + "type": "string" + }, + "UserQuickConnectConfig": { + "additionalProperties": false, + "description": "The user configuration. This is required only if QuickConnectType is USER.", + "properties": { + "ContactFlowArn": { + "$ref": "#/definitions/ContactFlowArn" + }, + "UserArn": { + "$ref": "#/definitions/UserArn" + } + }, + "required": [ + "ContactFlowArn", + "UserArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::QuickConnect", + "handlers": { + "create": { + "permissions": [ + "connect:CreateQuickConnect", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteQuickConnect", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListQuickConnects" + ] + }, + "read": { + "permissions": [ + "connect:DescribeQuickConnect" + ] + }, + "update": { + "permissions": [ + "connect:UpdateQuickConnectName", + "connect:UpdateQuickConnectConfig", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/QuickConnectArn" + ], + "properties": { + "Description": { + "description": "The description of the quick connect.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the quick connect.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "QuickConnectArn": { + "description": "The Amazon Resource Name (ARN) for the quick connect.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/transfer-destination/[-a-zA-Z0-9]*$", + "type": "string" + }, + "QuickConnectConfig": { + "$ref": "#/definitions/QuickConnectConfig", + "description": "Configuration settings for the quick connect." + }, + "QuickConnectType": { + "description": "The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).", + "enum": [ + "PHONE_NUMBER", + "QUEUE", + "USER" + ], + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/QuickConnectArn", + "/properties/QuickConnectType" + ], + "required": [ + "Name", + "InstanceArn", + "QuickConnectConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::QuickConnect" +} diff --git a/schema/aws-connect-routingprofile.json b/schema/aws-connect-routingprofile.json index 92f7982..659c102 100644 --- a/schema/aws-connect-routingprofile.json +++ b/schema/aws-connect-routingprofile.json @@ -1,276 +1,276 @@ -{ - "additionalProperties": false, - "definitions": { - "BehaviorType": { - "description": "Specifies the other channels that can be routed to an agent handling their current channel.", - "enum": [ - "ROUTE_CURRENT_CHANNEL_ONLY", - "ROUTE_ANY_CHANNEL" - ], - "type": "string" - }, - "Channel": { - "description": "The channels that agents can handle in the Contact Control Panel (CCP).", - "enum": [ - "VOICE", - "CHAT", - "TASK" - ], - "type": "string" - }, - "Concurrency": { - "description": "The number of contacts an agent can have on a channel simultaneously.", - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "CrossChannelBehavior": { - "additionalProperties": false, - "description": "Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.", - "properties": { - "BehaviorType": { - "$ref": "#/definitions/BehaviorType" - } - }, - "required": [ - "BehaviorType" - ], - "type": "object" - }, - "Delay": { - "description": "The delay, in seconds, a contact should wait in the queue before they are routed to an available agent.", - "maximum": 9999, - "minimum": 0, - "type": "integer" - }, - "MediaConcurrency": { - "additionalProperties": false, - "description": "Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.", - "properties": { - "Channel": { - "$ref": "#/definitions/Channel" - }, - "Concurrency": { - "$ref": "#/definitions/Concurrency" - }, - "CrossChannelBehavior": { - "$ref": "#/definitions/CrossChannelBehavior" - } - }, - "required": [ - "Channel", - "Concurrency" - ], - "type": "object" - }, - "Priority": { - "description": "The order in which contacts are to be handled for the queue.", - "maximum": 99, - "minimum": 1, - "type": "integer" - }, - "QueueArn": { - "description": "The Amazon Resource Name (ARN) for the queue.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", - "type": "string" - }, - "RoutingProfileQueueConfig": { - "additionalProperties": false, - "description": "Contains information about the queue and channel for which priority and delay can be set.", - "properties": { - "Delay": { - "$ref": "#/definitions/Delay" - }, - "Priority": { - "$ref": "#/definitions/Priority" - }, - "QueueReference": { - "$ref": "#/definitions/RoutingProfileQueueReference" - } - }, - "required": [ - "Delay", - "Priority", - "QueueReference" - ], - "type": "object" - }, - "RoutingProfileQueueReference": { - "additionalProperties": false, - "description": "Contains the channel and queue identifier for a routing profile.", - "properties": { - "Channel": { - "$ref": "#/definitions/Channel" - }, - "QueueArn": { - "$ref": "#/definitions/QueueArn" - } - }, - "required": [ - "Channel", - "QueueArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::RoutingProfile", - "handlers": { - "create": { - "permissions": [ - "connect:CreateRoutingProfile", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteRoutingProfile", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListRoutingProfiles", - "connect:ListRoutingProfileQueues" - ] - }, - "read": { - "permissions": [ - "connect:DescribeRoutingProfile", - "connect:ListRoutingProfileQueues" - ] - }, - "update": { - "permissions": [ - "connect:AssociateRoutingProfileQueues", - "connect:DisassociateRoutingProfileQueues", - "connect:UpdateRoutingProfileConcurrency", - "connect:UpdateRoutingProfileName", - "connect:UpdateRoutingProfileDefaultOutboundQueue", - "connect:UpdateRoutingProfileQueues", - "connect:TagResource", - "connect:UntagResource", - "connect:ListRoutingProfileQueues", - "connect:UpdateRoutingProfileAgentAvailabilityTimer" - ] - } - }, - "primaryIdentifier": [ - "/properties/RoutingProfileArn" - ], - "properties": { - "AgentAvailabilityTimer": { - "description": "Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.", - "enum": [ - "TIME_SINCE_LAST_ACTIVITY", - "TIME_SINCE_LAST_INBOUND" - ], - "type": "string" - }, - "DefaultOutboundQueueArn": { - "description": "The identifier of the default outbound queue for this routing profile.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Description": { - "description": "The description of the routing profile.", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "MediaConcurrencies": { - "description": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MediaConcurrency" - }, - "type": "array" - }, - "Name": { - "description": "The name of the routing profile.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "QueueConfigs": { - "description": "The queues to associate with this routing profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RoutingProfileQueueConfig" - }, - "minItems": 1, - "type": "array" - }, - "RoutingProfileArn": { - "description": "The Amazon Resource Name (ARN) of the routing profile.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/RoutingProfileArn" - ], - "required": [ - "InstanceArn", - "Name", - "Description", - "MediaConcurrencies", - "DefaultOutboundQueueArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::RoutingProfile" -} +{ + "additionalProperties": false, + "definitions": { + "BehaviorType": { + "description": "Specifies the other channels that can be routed to an agent handling their current channel.", + "enum": [ + "ROUTE_CURRENT_CHANNEL_ONLY", + "ROUTE_ANY_CHANNEL" + ], + "type": "string" + }, + "Channel": { + "description": "The channels that agents can handle in the Contact Control Panel (CCP).", + "enum": [ + "VOICE", + "CHAT", + "TASK" + ], + "type": "string" + }, + "Concurrency": { + "description": "The number of contacts an agent can have on a channel simultaneously.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "CrossChannelBehavior": { + "additionalProperties": false, + "description": "Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.", + "properties": { + "BehaviorType": { + "$ref": "#/definitions/BehaviorType" + } + }, + "required": [ + "BehaviorType" + ], + "type": "object" + }, + "Delay": { + "description": "The delay, in seconds, a contact should wait in the queue before they are routed to an available agent.", + "maximum": 9999, + "minimum": 0, + "type": "integer" + }, + "MediaConcurrency": { + "additionalProperties": false, + "description": "Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.", + "properties": { + "Channel": { + "$ref": "#/definitions/Channel" + }, + "Concurrency": { + "$ref": "#/definitions/Concurrency" + }, + "CrossChannelBehavior": { + "$ref": "#/definitions/CrossChannelBehavior" + } + }, + "required": [ + "Channel", + "Concurrency" + ], + "type": "object" + }, + "Priority": { + "description": "The order in which contacts are to be handled for the queue.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "QueueArn": { + "description": "The Amazon Resource Name (ARN) for the queue.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", + "type": "string" + }, + "RoutingProfileQueueConfig": { + "additionalProperties": false, + "description": "Contains information about the queue and channel for which priority and delay can be set.", + "properties": { + "Delay": { + "$ref": "#/definitions/Delay" + }, + "Priority": { + "$ref": "#/definitions/Priority" + }, + "QueueReference": { + "$ref": "#/definitions/RoutingProfileQueueReference" + } + }, + "required": [ + "Delay", + "Priority", + "QueueReference" + ], + "type": "object" + }, + "RoutingProfileQueueReference": { + "additionalProperties": false, + "description": "Contains the channel and queue identifier for a routing profile.", + "properties": { + "Channel": { + "$ref": "#/definitions/Channel" + }, + "QueueArn": { + "$ref": "#/definitions/QueueArn" + } + }, + "required": [ + "Channel", + "QueueArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::RoutingProfile", + "handlers": { + "create": { + "permissions": [ + "connect:CreateRoutingProfile", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteRoutingProfile", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListRoutingProfiles", + "connect:ListRoutingProfileQueues" + ] + }, + "read": { + "permissions": [ + "connect:DescribeRoutingProfile", + "connect:ListRoutingProfileQueues" + ] + }, + "update": { + "permissions": [ + "connect:AssociateRoutingProfileQueues", + "connect:DisassociateRoutingProfileQueues", + "connect:UpdateRoutingProfileConcurrency", + "connect:UpdateRoutingProfileName", + "connect:UpdateRoutingProfileDefaultOutboundQueue", + "connect:UpdateRoutingProfileQueues", + "connect:TagResource", + "connect:UntagResource", + "connect:ListRoutingProfileQueues", + "connect:UpdateRoutingProfileAgentAvailabilityTimer" + ] + } + }, + "primaryIdentifier": [ + "/properties/RoutingProfileArn" + ], + "properties": { + "AgentAvailabilityTimer": { + "description": "Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.", + "enum": [ + "TIME_SINCE_LAST_ACTIVITY", + "TIME_SINCE_LAST_INBOUND" + ], + "type": "string" + }, + "DefaultOutboundQueueArn": { + "description": "The identifier of the default outbound queue for this routing profile.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Description": { + "description": "The description of the routing profile.", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "MediaConcurrencies": { + "description": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MediaConcurrency" + }, + "type": "array" + }, + "Name": { + "description": "The name of the routing profile.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "QueueConfigs": { + "description": "The queues to associate with this routing profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RoutingProfileQueueConfig" + }, + "minItems": 1, + "type": "array" + }, + "RoutingProfileArn": { + "description": "The Amazon Resource Name (ARN) of the routing profile.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/RoutingProfileArn" + ], + "required": [ + "InstanceArn", + "Name", + "Description", + "MediaConcurrencies", + "DefaultOutboundQueueArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::RoutingProfile" +} diff --git a/schema/aws-connect-rule.json b/schema/aws-connect-rule.json index c9975b7..dfdcc2d 100644 --- a/schema/aws-connect-rule.json +++ b/schema/aws-connect-rule.json @@ -1,544 +1,544 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TriggerEventSource", - "/properties/InstanceArn" - ], - "definitions": { - "Actions": { - "additionalProperties": false, - "description": "The list of actions that will be executed when a rule is triggered.", - "properties": { - "AssignContactCategoryActions": { - "$ref": "#/definitions/AssignContactCategoryActions" - }, - "CreateCaseActions": { - "$ref": "#/definitions/CreateCaseActions" - }, - "EndAssociatedTasksActions": { - "$ref": "#/definitions/EndAssociatedTasksActions" - }, - "EventBridgeActions": { - "$ref": "#/definitions/EventBridgeActions" - }, - "SendNotificationActions": { - "$ref": "#/definitions/SendNotificationActions" - }, - "SubmitAutoEvaluationActions": { - "$ref": "#/definitions/SubmitAutoEvaluationActions" - }, - "TaskActions": { - "$ref": "#/definitions/TaskActions" - }, - "UpdateCaseActions": { - "$ref": "#/definitions/UpdateCaseActions" - } - }, - "type": "object" - }, - "AssignContactCategoryAction": { - "description": "The definition for assigning contact category action.", - "type": "object" - }, - "AssignContactCategoryActions": { - "description": "This action will assign contact category when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssignContactCategoryAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "CreateCaseAction": { - "additionalProperties": false, - "description": "The definition for create case action.", - "properties": { - "Fields": { - "$ref": "#/definitions/Fields" - }, - "TemplateId": { - "description": "The Id of template.", - "maxLength": 500, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Fields", - "TemplateId" - ], - "type": "object" - }, - "CreateCaseActions": { - "description": "This action will create a case when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CreateCaseAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "EndAssociatedTasksAction": { - "description": "The definition for ending associated task action.", - "type": "object" - }, - "EndAssociatedTasksActions": { - "description": "This action will end associated tasks when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EndAssociatedTasksAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "EventBridgeAction": { - "additionalProperties": false, - "description": "The definition for event bridge action.", - "properties": { - "Name": { - "description": "The name of the event bridge action.", - "pattern": "^[a-zA-Z0-9._-]{1,100}$", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "EventBridgeActions": { - "description": "This action will send event bridge notification when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventBridgeAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Field": { - "additionalProperties": false, - "description": "The field of the case.", - "properties": { - "Id": { - "description": "The Id of the field", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "Value": { - "$ref": "#/definitions/FieldValue" - } - }, - "required": [ - "Id", - "Value" - ], - "type": "object" - }, - "FieldValue": { - "additionalProperties": false, - "description": "The value of the field.", - "properties": { - "BooleanValue": { - "type": "boolean" - }, - "DoubleValue": { - "type": "number" - }, - "EmptyValue": { - "type": "object" - }, - "StringValue": { - "type": "string" - } - }, - "type": "object" - }, - "Fields": { - "description": "An array of case fields", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Field" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotificationRecipientType": { - "additionalProperties": false, - "description": "The type of notification recipient.", - "properties": { - "UserArns": { - "description": "The list of recipients by user arns.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/UserArn" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "UserTags": { - "additionalProperties": false, - "description": "The collection of recipients who are identified by user tags", - "patternProperties": { - "^(?=.{1,128}$).+$": { - "type": "string" - } - } - } - }, - "type": "object" - }, - "Reference": { - "additionalProperties": false, - "description": "A contact reference.", - "properties": { - "Type": { - "enum": [ - "URL", - "ATTACHMENT", - "NUMBER", - "STRING", - "DATE", - "EMAIL" - ], - "type": "string" - }, - "Value": { - "pattern": "^(/|https:)", - "type": "string" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - }, - "RuleTriggerEventSource": { - "additionalProperties": false, - "description": "The event source that will trigger the rule.", - "properties": { - "EventSourceName": { - "description": "The name of event source.", - "enum": [ - "OnContactEvaluationSubmit", - "OnPostCallAnalysisAvailable", - "OnRealTimeCallAnalysisAvailable", - "OnRealTimeChatAnalysisAvailable", - "OnPostChatAnalysisAvailable", - "OnZendeskTicketCreate", - "OnZendeskTicketStatusUpdate", - "OnSalesforceCaseCreate", - "OnMetricDataUpdate", - "OnCaseCreate", - "OnCaseUpdate" - ], - "type": "string" - }, - "IntegrationAssociationArn": { - "description": "The Amazon Resource Name (ARN) for the AppIntegration association.", - "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/integration-association/[-a-zA-Z0-9]*$", - "type": "string" - } - }, - "required": [ - "EventSourceName" - ], - "type": "object" - }, - "SendNotificationAction": { - "additionalProperties": false, - "description": "The definition for sending notification action.", - "properties": { - "Content": { - "description": "The content of notification.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "ContentType": { - "description": "The type of content.", - "enum": [ - "PLAIN_TEXT" - ], - "type": "string" - }, - "DeliveryMethod": { - "description": "The means of delivery.", - "enum": [ - "EMAIL" - ], - "type": "string" - }, - "Recipient": { - "$ref": "#/definitions/NotificationRecipientType" - }, - "Subject": { - "description": "The subject of notification.", - "maxLength": 200, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DeliveryMethod", - "Content", - "Recipient", - "ContentType" - ], - "type": "object" - }, - "SendNotificationActions": { - "description": "The action will send notification when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SendNotificationAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SubmitAutoEvaluationAction": { - "additionalProperties": false, - "description": "The definition of submit auto evaluation action.", - "properties": { - "EvaluationFormArn": { - "description": "The Amazon Resource Name (ARN) of the evaluation form.", - "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", - "type": "string" - } - }, - "required": [ - "EvaluationFormArn" - ], - "type": "object" - }, - "SubmitAutoEvaluationActions": { - "description": "This action will submit an auto contact evaluation when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubmitAutoEvaluationAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TaskAction": { - "additionalProperties": false, - "description": "The definition of task action.", - "properties": { - "ContactFlowArn": { - "description": "The Amazon Resource Name (ARN) of the contact flow.", - "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Description": { - "description": "The description which appears in the agent's Contact Control Panel (CCP).", - "maxLength": 4096, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "The name which appears in the agent's Contact Control Panel (CCP).", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "References": { - "additionalProperties": false, - "description": "A formatted URL that is shown to an agent in the Contact Control Panel (CCP).", - "patternProperties": { - "^(?=.{1,4096}$).+$": { - "$ref": "#/definitions/Reference" - } - } - } - }, - "required": [ - "Name", - "ContactFlowArn" - ], - "type": "object" - }, - "TaskActions": { - "description": "This action will generate a task when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TaskAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "UpdateCaseAction": { - "additionalProperties": false, - "description": "The definition for update case action.", - "properties": { - "Fields": { - "$ref": "#/definitions/Fields" - } - }, - "required": [ - "Fields" - ], - "type": "object" - }, - "UpdateCaseActions": { - "description": "This action will update a case when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/UpdateCaseAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "UserArn": { - "description": "The Amazon Resource Name (ARN) of the user.", - "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", - "type": "string" - } - }, - "description": "Resource Type definition for AWS:Connect::Rule", - "handlers": { - "create": { - "permissions": [ - "connect:CreateRule", - "cases:GetTemplate", - "cases:ListFields", - "cases:ListFieldOptions" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteRule", - "connect:UntagResource" - ] - }, - "read": { - "permissions": [ - "connect:DescribeRule" - ] - }, - "update": { - "permissions": [ - "connect:UpdateRule", - "cases:GetTemplate", - "cases:ListFields", - "cases:ListFieldOptions", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleArn" - ], - "properties": { - "Actions": { - "$ref": "#/definitions/Actions", - "description": "The list of actions that will be executed when a rule is triggered." - }, - "Function": { - "description": "The conditions of a rule.", - "type": "string" - }, - "InstanceArn": { - "description": "The Amazon Resource Name (ARN) of the instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the rule.", - "pattern": "^[a-zA-Z0-9._-]{1,200}$", - "type": "string" - }, - "PublishStatus": { - "description": "The publish status of a rule, either draft or published.", - "enum": [ - "DRAFT", - "PUBLISHED" - ], - "type": "string" - }, - "RuleArn": { - "description": "The Amazon Resource Name (ARN) of the rule.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/rule/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TriggerEventSource": { - "$ref": "#/definitions/RuleTriggerEventSource", - "description": "The event source that triggers the rule." - } - }, - "readOnlyProperties": [ - "/properties/RuleArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Name", - "InstanceArn", - "TriggerEventSource", - "Function", - "Actions", - "PublishStatus" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::Rule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TriggerEventSource", + "/properties/InstanceArn" + ], + "definitions": { + "Actions": { + "additionalProperties": false, + "description": "The list of actions that will be executed when a rule is triggered.", + "properties": { + "AssignContactCategoryActions": { + "$ref": "#/definitions/AssignContactCategoryActions" + }, + "CreateCaseActions": { + "$ref": "#/definitions/CreateCaseActions" + }, + "EndAssociatedTasksActions": { + "$ref": "#/definitions/EndAssociatedTasksActions" + }, + "EventBridgeActions": { + "$ref": "#/definitions/EventBridgeActions" + }, + "SendNotificationActions": { + "$ref": "#/definitions/SendNotificationActions" + }, + "SubmitAutoEvaluationActions": { + "$ref": "#/definitions/SubmitAutoEvaluationActions" + }, + "TaskActions": { + "$ref": "#/definitions/TaskActions" + }, + "UpdateCaseActions": { + "$ref": "#/definitions/UpdateCaseActions" + } + }, + "type": "object" + }, + "AssignContactCategoryAction": { + "description": "The definition for assigning contact category action.", + "type": "object" + }, + "AssignContactCategoryActions": { + "description": "This action will assign contact category when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssignContactCategoryAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "CreateCaseAction": { + "additionalProperties": false, + "description": "The definition for create case action.", + "properties": { + "Fields": { + "$ref": "#/definitions/Fields" + }, + "TemplateId": { + "description": "The Id of template.", + "maxLength": 500, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Fields", + "TemplateId" + ], + "type": "object" + }, + "CreateCaseActions": { + "description": "This action will create a case when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CreateCaseAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EndAssociatedTasksAction": { + "description": "The definition for ending associated task action.", + "type": "object" + }, + "EndAssociatedTasksActions": { + "description": "This action will end associated tasks when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EndAssociatedTasksAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EventBridgeAction": { + "additionalProperties": false, + "description": "The definition for event bridge action.", + "properties": { + "Name": { + "description": "The name of the event bridge action.", + "pattern": "^[a-zA-Z0-9._-]{1,100}$", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "EventBridgeActions": { + "description": "This action will send event bridge notification when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventBridgeAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Field": { + "additionalProperties": false, + "description": "The field of the case.", + "properties": { + "Id": { + "description": "The Id of the field", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "Value": { + "$ref": "#/definitions/FieldValue" + } + }, + "required": [ + "Id", + "Value" + ], + "type": "object" + }, + "FieldValue": { + "additionalProperties": false, + "description": "The value of the field.", + "properties": { + "BooleanValue": { + "type": "boolean" + }, + "DoubleValue": { + "type": "number" + }, + "EmptyValue": { + "type": "object" + }, + "StringValue": { + "type": "string" + } + }, + "type": "object" + }, + "Fields": { + "description": "An array of case fields", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Field" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotificationRecipientType": { + "additionalProperties": false, + "description": "The type of notification recipient.", + "properties": { + "UserArns": { + "description": "The list of recipients by user arns.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/UserArn" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "UserTags": { + "additionalProperties": false, + "description": "The collection of recipients who are identified by user tags", + "patternProperties": { + "^(?=.{1,128}$).+$": { + "type": "string" + } + } + } + }, + "type": "object" + }, + "Reference": { + "additionalProperties": false, + "description": "A contact reference.", + "properties": { + "Type": { + "enum": [ + "URL", + "ATTACHMENT", + "NUMBER", + "STRING", + "DATE", + "EMAIL" + ], + "type": "string" + }, + "Value": { + "pattern": "^(/|https:)", + "type": "string" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + }, + "RuleTriggerEventSource": { + "additionalProperties": false, + "description": "The event source that will trigger the rule.", + "properties": { + "EventSourceName": { + "description": "The name of event source.", + "enum": [ + "OnContactEvaluationSubmit", + "OnPostCallAnalysisAvailable", + "OnRealTimeCallAnalysisAvailable", + "OnRealTimeChatAnalysisAvailable", + "OnPostChatAnalysisAvailable", + "OnZendeskTicketCreate", + "OnZendeskTicketStatusUpdate", + "OnSalesforceCaseCreate", + "OnMetricDataUpdate", + "OnCaseCreate", + "OnCaseUpdate" + ], + "type": "string" + }, + "IntegrationAssociationArn": { + "description": "The Amazon Resource Name (ARN) for the AppIntegration association.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/integration-association/[-a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "EventSourceName" + ], + "type": "object" + }, + "SendNotificationAction": { + "additionalProperties": false, + "description": "The definition for sending notification action.", + "properties": { + "Content": { + "description": "The content of notification.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "ContentType": { + "description": "The type of content.", + "enum": [ + "PLAIN_TEXT" + ], + "type": "string" + }, + "DeliveryMethod": { + "description": "The means of delivery.", + "enum": [ + "EMAIL" + ], + "type": "string" + }, + "Recipient": { + "$ref": "#/definitions/NotificationRecipientType" + }, + "Subject": { + "description": "The subject of notification.", + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DeliveryMethod", + "Content", + "Recipient", + "ContentType" + ], + "type": "object" + }, + "SendNotificationActions": { + "description": "The action will send notification when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SendNotificationAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SubmitAutoEvaluationAction": { + "additionalProperties": false, + "description": "The definition of submit auto evaluation action.", + "properties": { + "EvaluationFormArn": { + "description": "The Amazon Resource Name (ARN) of the evaluation form.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "EvaluationFormArn" + ], + "type": "object" + }, + "SubmitAutoEvaluationActions": { + "description": "This action will submit an auto contact evaluation when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubmitAutoEvaluationAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TaskAction": { + "additionalProperties": false, + "description": "The definition of task action.", + "properties": { + "ContactFlowArn": { + "description": "The Amazon Resource Name (ARN) of the contact flow.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Description": { + "description": "The description which appears in the agent's Contact Control Panel (CCP).", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "The name which appears in the agent's Contact Control Panel (CCP).", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "References": { + "additionalProperties": false, + "description": "A formatted URL that is shown to an agent in the Contact Control Panel (CCP).", + "patternProperties": { + "^(?=.{1,4096}$).+$": { + "$ref": "#/definitions/Reference" + } + } + } + }, + "required": [ + "Name", + "ContactFlowArn" + ], + "type": "object" + }, + "TaskActions": { + "description": "This action will generate a task when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TaskAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "UpdateCaseAction": { + "additionalProperties": false, + "description": "The definition for update case action.", + "properties": { + "Fields": { + "$ref": "#/definitions/Fields" + } + }, + "required": [ + "Fields" + ], + "type": "object" + }, + "UpdateCaseActions": { + "description": "This action will update a case when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/UpdateCaseAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "UserArn": { + "description": "The Amazon Resource Name (ARN) of the user.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", + "type": "string" + } + }, + "description": "Resource Type definition for AWS:Connect::Rule", + "handlers": { + "create": { + "permissions": [ + "connect:CreateRule", + "cases:GetTemplate", + "cases:ListFields", + "cases:ListFieldOptions" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteRule", + "connect:UntagResource" + ] + }, + "read": { + "permissions": [ + "connect:DescribeRule" + ] + }, + "update": { + "permissions": [ + "connect:UpdateRule", + "cases:GetTemplate", + "cases:ListFields", + "cases:ListFieldOptions", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleArn" + ], + "properties": { + "Actions": { + "$ref": "#/definitions/Actions", + "description": "The list of actions that will be executed when a rule is triggered." + }, + "Function": { + "description": "The conditions of a rule.", + "type": "string" + }, + "InstanceArn": { + "description": "The Amazon Resource Name (ARN) of the instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the rule.", + "pattern": "^[a-zA-Z0-9._-]{1,200}$", + "type": "string" + }, + "PublishStatus": { + "description": "The publish status of a rule, either draft or published.", + "enum": [ + "DRAFT", + "PUBLISHED" + ], + "type": "string" + }, + "RuleArn": { + "description": "The Amazon Resource Name (ARN) of the rule.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/rule/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TriggerEventSource": { + "$ref": "#/definitions/RuleTriggerEventSource", + "description": "The event source that triggers the rule." + } + }, + "readOnlyProperties": [ + "/properties/RuleArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Name", + "InstanceArn", + "TriggerEventSource", + "Function", + "Actions", + "PublishStatus" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::Rule" +} diff --git a/schema/aws-connect-securitykey.json b/schema/aws-connect-securitykey.json index 97c9867..b6d789f 100644 --- a/schema/aws-connect-securitykey.json +++ b/schema/aws-connect-securitykey.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceId", - "/properties/Key" - ], - "definitions": { - "AssociationId": { - "description": "An associationID is automatically generated when a storage config is associated with an instance", - "maxLength": 100, - "minLength": 1, - "pattern": "^[-a-z0-9]*$", - "type": "string" - }, - "InstanceId": { - "description": "Amazon Connect instance identifier", - "maxLength": 100, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Key": { - "description": "A valid security key in PEM format.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::SecurityKey", - "handlers": { - "create": { - "permissions": [ - "connect:AssociateSecurityKey" - ] - }, - "delete": { - "permissions": [ - "connect:DisassociateSecurityKey" - ] - }, - "list": { - "permissions": [ - "connect:ListSecurityKeys" - ] - }, - "read": { - "permissions": [ - "connect:ListSecurityKeys" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/InstanceId", - "/properties/AssociationId" - ], - "properties": { - "AssociationId": { - "$ref": "#/definitions/AssociationId" - }, - "InstanceId": { - "$ref": "#/definitions/InstanceId" - }, - "Key": { - "$ref": "#/definitions/Key" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId" - ], - "required": [ - "Key", - "InstanceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Connect::SecurityKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceId", + "/properties/Key" + ], + "definitions": { + "AssociationId": { + "description": "An associationID is automatically generated when a storage config is associated with an instance", + "maxLength": 100, + "minLength": 1, + "pattern": "^[-a-z0-9]*$", + "type": "string" + }, + "InstanceId": { + "description": "Amazon Connect instance identifier", + "maxLength": 100, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Key": { + "description": "A valid security key in PEM format.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::SecurityKey", + "handlers": { + "create": { + "permissions": [ + "connect:AssociateSecurityKey" + ] + }, + "delete": { + "permissions": [ + "connect:DisassociateSecurityKey" + ] + }, + "list": { + "permissions": [ + "connect:ListSecurityKeys" + ] + }, + "read": { + "permissions": [ + "connect:ListSecurityKeys" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/InstanceId", + "/properties/AssociationId" + ], + "properties": { + "AssociationId": { + "$ref": "#/definitions/AssociationId" + }, + "InstanceId": { + "$ref": "#/definitions/InstanceId" + }, + "Key": { + "$ref": "#/definitions/Key" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId" + ], + "required": [ + "Key", + "InstanceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::SecurityKey" +} diff --git a/schema/aws-connect-securityprofile.json b/schema/aws-connect-securityprofile.json index a924e03..b53d35b 100644 --- a/schema/aws-connect-securityprofile.json +++ b/schema/aws-connect-securityprofile.json @@ -1,244 +1,244 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SecurityProfileName", - "/properties/InstanceArn" - ], - "definitions": { - "Application": { - "additionalProperties": false, - "description": "A third-party application's metadata.", - "properties": { - "ApplicationPermissions": { - "description": "The permissions that the agent is granted on the application", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ApplicationPermission" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "Namespace": { - "description": "Namespace of the application that you want to give access to.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ApplicationPermissions", - "Namespace" - ], - "type": "object" - }, - "ApplicationPermission": { - "description": "The permissions that the agent is granted on the application.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Permission": { - "description": "A permission associated with the security profile.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "ResourceName": { - "description": "A resource that a security profile applies tag or hierarchy restrictions to in Amazon Connect.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::SecurityProfile", - "handlers": { - "create": { - "permissions": [ - "connect:CreateSecurityProfile", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteSecurityProfile", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListSecurityProfiles" - ] - }, - "read": { - "permissions": [ - "connect:DescribeSecurityProfile", - "connect:ListSecurityProfileApplications", - "connect:ListSecurityProfilePermissions" - ] - }, - "update": { - "permissions": [ - "connect:TagResource", - "connect:UpdateSecurityProfile", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SecurityProfileArn" - ], - "properties": { - "AllowedAccessControlHierarchyGroupId": { - "description": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.", - "maxLength": 127, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "AllowedAccessControlTags": { - "description": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 2, - "type": "array", - "uniqueItems": true - }, - "Applications": { - "description": "A list of third-party applications that the security profile will give access to.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Application" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "Description": { - "description": "The description of the security profile.", - "maxLength": 250, - "minLength": 0, - "type": "string" - }, - "HierarchyRestrictedResources": { - "description": "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceName" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "LastModifiedRegion": { - "description": "The AWS Region where this resource was last modified.", - "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", - "type": "string" - }, - "LastModifiedTime": { - "description": "The timestamp when this resource was last modified.", - "type": "number" - }, - "Permissions": { - "description": "Permissions assigned to the security profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Permission" - }, - "maxItems": 500, - "type": "array", - "uniqueItems": true - }, - "SecurityProfileArn": { - "description": "The Amazon Resource Name (ARN) for the security profile.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$", - "type": "string" - }, - "SecurityProfileName": { - "description": "The name of the security profile.", - "maxLength": 127, - "minLength": 1, - "pattern": "^[ a-zA-Z0-9_@-]+$", - "type": "string" - }, - "TagRestrictedResources": { - "description": "The list of resources that a security profile applies tag restrictions to in Amazon Connect.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceName" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "The tags used to organize, track, or control access for this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/SecurityProfileArn", - "/properties/LastModifiedRegion", - "/properties/LastModifiedTime" - ], - "required": [ - "InstanceArn", - "SecurityProfileName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::SecurityProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SecurityProfileName", + "/properties/InstanceArn" + ], + "definitions": { + "Application": { + "additionalProperties": false, + "description": "A third-party application's metadata.", + "properties": { + "ApplicationPermissions": { + "description": "The permissions that the agent is granted on the application", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ApplicationPermission" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Namespace": { + "description": "Namespace of the application that you want to give access to.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ApplicationPermissions", + "Namespace" + ], + "type": "object" + }, + "ApplicationPermission": { + "description": "The permissions that the agent is granted on the application.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Permission": { + "description": "A permission associated with the security profile.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ResourceName": { + "description": "A resource that a security profile applies tag or hierarchy restrictions to in Amazon Connect.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::SecurityProfile", + "handlers": { + "create": { + "permissions": [ + "connect:CreateSecurityProfile", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteSecurityProfile", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListSecurityProfiles" + ] + }, + "read": { + "permissions": [ + "connect:DescribeSecurityProfile", + "connect:ListSecurityProfileApplications", + "connect:ListSecurityProfilePermissions" + ] + }, + "update": { + "permissions": [ + "connect:TagResource", + "connect:UpdateSecurityProfile", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SecurityProfileArn" + ], + "properties": { + "AllowedAccessControlHierarchyGroupId": { + "description": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.", + "maxLength": 127, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "AllowedAccessControlTags": { + "description": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 2, + "type": "array", + "uniqueItems": true + }, + "Applications": { + "description": "A list of third-party applications that the security profile will give access to.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Application" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "The description of the security profile.", + "maxLength": 250, + "minLength": 0, + "type": "string" + }, + "HierarchyRestrictedResources": { + "description": "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceName" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "LastModifiedRegion": { + "description": "The AWS Region where this resource was last modified.", + "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", + "type": "string" + }, + "LastModifiedTime": { + "description": "The timestamp when this resource was last modified.", + "type": "number" + }, + "Permissions": { + "description": "Permissions assigned to the security profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Permission" + }, + "maxItems": 500, + "type": "array", + "uniqueItems": true + }, + "SecurityProfileArn": { + "description": "The Amazon Resource Name (ARN) for the security profile.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$", + "type": "string" + }, + "SecurityProfileName": { + "description": "The name of the security profile.", + "maxLength": 127, + "minLength": 1, + "pattern": "^[ a-zA-Z0-9_@-]+$", + "type": "string" + }, + "TagRestrictedResources": { + "description": "The list of resources that a security profile applies tag restrictions to in Amazon Connect.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceName" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "The tags used to organize, track, or control access for this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/SecurityProfileArn", + "/properties/LastModifiedRegion", + "/properties/LastModifiedTime" + ], + "required": [ + "InstanceArn", + "SecurityProfileName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::SecurityProfile" +} diff --git a/schema/aws-connect-tasktemplate.json b/schema/aws-connect-tasktemplate.json index 37012df..a546793 100644 --- a/schema/aws-connect-tasktemplate.json +++ b/schema/aws-connect-tasktemplate.json @@ -1,337 +1,337 @@ -{ - "additionalProperties": false, - "definitions": { - "ClientToken": { - "description": "the client token string in uuid format", - "pattern": "^$|[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$", - "type": "string" - }, - "DefaultFieldValue": { - "additionalProperties": false, - "description": "the default value for the task template's field", - "properties": { - "DefaultValue": { - "$ref": "#/definitions/FieldValue" - }, - "Id": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "Id", - "DefaultValue" - ], - "type": "object" - }, - "Field": { - "additionalProperties": false, - "description": "A task template field object.", - "properties": { - "Description": { - "description": "The description of the task template's field", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "Id": { - "$ref": "#/definitions/FieldIdentifier" - }, - "SingleSelectOptions": { - "description": "list of field options to be used with single select", - "items": { - "$ref": "#/definitions/FieldOption" - }, - "maxItems": 50, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/FieldType" - } - }, - "required": [ - "Id", - "Type" - ], - "type": "object" - }, - "FieldIdentifier": { - "additionalProperties": false, - "description": "the identifier (name) for the task template field", - "properties": { - "Name": { - "description": "The name of the task template field", - "maxLength": 100, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "FieldOption": { - "description": "Single select field identifier", - "maxLength": 100, - "minLength": 1, - "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.,\\s-]*[A-Za-z0-9_.,-])?$", - "type": "string" - }, - "FieldType": { - "description": "The type of the task template's field", - "enum": [ - "NAME", - "DESCRIPTION", - "SCHEDULED_TIME", - "QUICK_CONNECT", - "URL", - "NUMBER", - "TEXT", - "TEXT_AREA", - "DATE_TIME", - "BOOLEAN", - "SINGLE_SELECT", - "EMAIL" - ], - "type": "string" - }, - "FieldValue": { - "description": "the default value for the task template's field", - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "InvisibleFieldInfo": { - "additionalProperties": false, - "description": "Invisible field info", - "properties": { - "Id": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "InvisibleTaskTemplateFields": { - "description": "The list of the task template's invisible fields", - "items": { - "$ref": "#/definitions/InvisibleFieldInfo" - }, - "maxItems": 50, - "type": "array" - }, - "ReadOnlyFieldInfo": { - "additionalProperties": false, - "description": "ReadOnly field info", - "properties": { - "Id": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "ReadOnlyTaskTemplateFields": { - "description": "The list of the task template's read only fields", - "items": { - "$ref": "#/definitions/ReadOnlyFieldInfo" - }, - "maxItems": 50, - "type": "array" - }, - "RequiredFieldInfo": { - "additionalProperties": false, - "description": "Required field info", - "properties": { - "Id": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "RequiredTaskTemplateFields": { - "description": "The list of the task template's required fields", - "items": { - "$ref": "#/definitions/RequiredFieldInfo" - }, - "maxItems": 50, - "type": "array" - }, - "Status": { - "description": "The status of the task template", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::TaskTemplate.", - "handlers": { - "create": { - "permissions": [ - "connect:CreateTaskTemplate", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteTaskTemplate", - "connect:UntagResource", - "connect:GetTaskTemplate" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListTaskTemplates" - ] - }, - "read": { - "permissions": [ - "connect:GetTaskTemplate" - ] - }, - "update": { - "permissions": [ - "connect:UpdateTaskTemplate", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The identifier (arn) of the task template.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/task-template/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string" - }, - "ClientToken": { - "$ref": "#/definitions/ClientToken" - }, - "Constraints": { - "additionalProperties": false, - "description": "The constraints for the task template", - "properties": { - "InvisibleFields": { - "$ref": "#/definitions/InvisibleTaskTemplateFields" - }, - "ReadOnlyFields": { - "$ref": "#/definitions/ReadOnlyTaskTemplateFields" - }, - "RequiredFields": { - "$ref": "#/definitions/RequiredTaskTemplateFields" - } - }, - "type": "object" - }, - "ContactFlowArn": { - "description": "The identifier of the contact flow.", - "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Defaults": { - "description": "", - "items": { - "$ref": "#/definitions/DefaultFieldValue" - }, - "maxItems": 50, - "type": "array" - }, - "Description": { - "description": "The description of the task template.", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "Fields": { - "description": "The list of task template's fields", - "items": { - "$ref": "#/definitions/Field" - }, - "maxItems": 50, - "type": "array" - }, - "InstanceArn": { - "description": "The identifier (arn) of the instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the task template.", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/Status" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "InstanceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::TaskTemplate" -} +{ + "additionalProperties": false, + "definitions": { + "ClientToken": { + "description": "the client token string in uuid format", + "pattern": "^$|[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$", + "type": "string" + }, + "DefaultFieldValue": { + "additionalProperties": false, + "description": "the default value for the task template's field", + "properties": { + "DefaultValue": { + "$ref": "#/definitions/FieldValue" + }, + "Id": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "Id", + "DefaultValue" + ], + "type": "object" + }, + "Field": { + "additionalProperties": false, + "description": "A task template field object.", + "properties": { + "Description": { + "description": "The description of the task template's field", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "Id": { + "$ref": "#/definitions/FieldIdentifier" + }, + "SingleSelectOptions": { + "description": "list of field options to be used with single select", + "items": { + "$ref": "#/definitions/FieldOption" + }, + "maxItems": 50, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/FieldType" + } + }, + "required": [ + "Id", + "Type" + ], + "type": "object" + }, + "FieldIdentifier": { + "additionalProperties": false, + "description": "the identifier (name) for the task template field", + "properties": { + "Name": { + "description": "The name of the task template field", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "FieldOption": { + "description": "Single select field identifier", + "maxLength": 100, + "minLength": 1, + "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.,\\s-]*[A-Za-z0-9_.,-])?$", + "type": "string" + }, + "FieldType": { + "description": "The type of the task template's field", + "enum": [ + "NAME", + "DESCRIPTION", + "SCHEDULED_TIME", + "QUICK_CONNECT", + "URL", + "NUMBER", + "TEXT", + "TEXT_AREA", + "DATE_TIME", + "BOOLEAN", + "SINGLE_SELECT", + "EMAIL" + ], + "type": "string" + }, + "FieldValue": { + "description": "the default value for the task template's field", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "InvisibleFieldInfo": { + "additionalProperties": false, + "description": "Invisible field info", + "properties": { + "Id": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "InvisibleTaskTemplateFields": { + "description": "The list of the task template's invisible fields", + "items": { + "$ref": "#/definitions/InvisibleFieldInfo" + }, + "maxItems": 50, + "type": "array" + }, + "ReadOnlyFieldInfo": { + "additionalProperties": false, + "description": "ReadOnly field info", + "properties": { + "Id": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "ReadOnlyTaskTemplateFields": { + "description": "The list of the task template's read only fields", + "items": { + "$ref": "#/definitions/ReadOnlyFieldInfo" + }, + "maxItems": 50, + "type": "array" + }, + "RequiredFieldInfo": { + "additionalProperties": false, + "description": "Required field info", + "properties": { + "Id": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "RequiredTaskTemplateFields": { + "description": "The list of the task template's required fields", + "items": { + "$ref": "#/definitions/RequiredFieldInfo" + }, + "maxItems": 50, + "type": "array" + }, + "Status": { + "description": "The status of the task template", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::TaskTemplate.", + "handlers": { + "create": { + "permissions": [ + "connect:CreateTaskTemplate", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteTaskTemplate", + "connect:UntagResource", + "connect:GetTaskTemplate" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListTaskTemplates" + ] + }, + "read": { + "permissions": [ + "connect:GetTaskTemplate" + ] + }, + "update": { + "permissions": [ + "connect:UpdateTaskTemplate", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The identifier (arn) of the task template.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/task-template/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", + "type": "string" + }, + "ClientToken": { + "$ref": "#/definitions/ClientToken" + }, + "Constraints": { + "additionalProperties": false, + "description": "The constraints for the task template", + "properties": { + "InvisibleFields": { + "$ref": "#/definitions/InvisibleTaskTemplateFields" + }, + "ReadOnlyFields": { + "$ref": "#/definitions/ReadOnlyTaskTemplateFields" + }, + "RequiredFields": { + "$ref": "#/definitions/RequiredTaskTemplateFields" + } + }, + "type": "object" + }, + "ContactFlowArn": { + "description": "The identifier of the contact flow.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Defaults": { + "description": "", + "items": { + "$ref": "#/definitions/DefaultFieldValue" + }, + "maxItems": 50, + "type": "array" + }, + "Description": { + "description": "The description of the task template.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "Fields": { + "description": "The list of task template's fields", + "items": { + "$ref": "#/definitions/Field" + }, + "maxItems": 50, + "type": "array" + }, + "InstanceArn": { + "description": "The identifier (arn) of the instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the task template.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/Status" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "InstanceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::TaskTemplate" +} diff --git a/schema/aws-connect-trafficdistributiongroup.json b/schema/aws-connect-trafficdistributiongroup.json index 17b15a3..f8178bb 100644 --- a/schema/aws-connect-trafficdistributiongroup.json +++ b/schema/aws-connect-trafficdistributiongroup.json @@ -1,140 +1,140 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::TrafficDistributionGroup", - "handlers": { - "create": { - "permissions": [ - "connect:CreateTrafficDistributionGroup", - "connect:DescribeTrafficDistributionGroup", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteTrafficDistributionGroup", - "connect:DescribeTrafficDistributionGroup", - "connect:UntagResource" - ] - }, - "list": { - "permissions": [ - "connect:ListTrafficDistributionGroups" - ] - }, - "read": { - "permissions": [ - "connect:DescribeTrafficDistributionGroup" - ] - }, - "update": { - "permissions": [ - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrafficDistributionGroupArn" - ], - "properties": { - "Description": { - "description": "A description for the traffic distribution group.", - "maxLength": 250, - "minLength": 1, - "pattern": "(^[\\S].*[\\S]$)|(^[\\S]$)", - "type": "string" - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance that has been replicated.", - "maxLength": 250, - "minLength": 1, - "pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "IsDefault": { - "description": "If this is the default traffic distribution group.", - "type": "boolean" - }, - "Name": { - "description": "The name for the traffic distribution group.", - "maxLength": 128, - "minLength": 1, - "pattern": "(^[\\S].*[\\S]$)|(^[\\S]$)", - "type": "string" - }, - "Status": { - "description": "The status of the traffic distribution group.", - "enum": [ - "CREATION_IN_PROGRESS", - "ACTIVE", - "CREATION_FAILED", - "PENDING_DELETION", - "DELETION_FAILED", - "UPDATE_IN_PROGRESS" - ], - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TrafficDistributionGroupArn": { - "description": "The identifier of the traffic distribution group.", - "pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TrafficDistributionGroupArn", - "/properties/Status", - "/properties/IsDefault" - ], - "required": [ - "InstanceArn", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::TrafficDistributionGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::TrafficDistributionGroup", + "handlers": { + "create": { + "permissions": [ + "connect:CreateTrafficDistributionGroup", + "connect:DescribeTrafficDistributionGroup", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteTrafficDistributionGroup", + "connect:DescribeTrafficDistributionGroup", + "connect:UntagResource" + ] + }, + "list": { + "permissions": [ + "connect:ListTrafficDistributionGroups" + ] + }, + "read": { + "permissions": [ + "connect:DescribeTrafficDistributionGroup" + ] + }, + "update": { + "permissions": [ + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrafficDistributionGroupArn" + ], + "properties": { + "Description": { + "description": "A description for the traffic distribution group.", + "maxLength": 250, + "minLength": 1, + "pattern": "(^[\\S].*[\\S]$)|(^[\\S]$)", + "type": "string" + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance that has been replicated.", + "maxLength": 250, + "minLength": 1, + "pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "IsDefault": { + "description": "If this is the default traffic distribution group.", + "type": "boolean" + }, + "Name": { + "description": "The name for the traffic distribution group.", + "maxLength": 128, + "minLength": 1, + "pattern": "(^[\\S].*[\\S]$)|(^[\\S]$)", + "type": "string" + }, + "Status": { + "description": "The status of the traffic distribution group.", + "enum": [ + "CREATION_IN_PROGRESS", + "ACTIVE", + "CREATION_FAILED", + "PENDING_DELETION", + "DELETION_FAILED", + "UPDATE_IN_PROGRESS" + ], + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TrafficDistributionGroupArn": { + "description": "The identifier of the traffic distribution group.", + "pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TrafficDistributionGroupArn", + "/properties/Status", + "/properties/IsDefault" + ], + "required": [ + "InstanceArn", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::TrafficDistributionGroup" +} diff --git a/schema/aws-connect-user.json b/schema/aws-connect-user.json index aaf78b7..f372380 100644 --- a/schema/aws-connect-user.json +++ b/schema/aws-connect-user.json @@ -1,310 +1,310 @@ -{ - "additionalProperties": false, - "definitions": { - "AfterContactWorkTimeLimit": { - "description": "The After Call Work (ACW) timeout setting, in seconds.", - "minimum": 0, - "type": "integer" - }, - "AttributeName": { - "description": "The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "AttributeValue": { - "description": "The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "AutoAccept": { - "description": "The Auto accept setting.", - "type": "boolean" - }, - "DeskPhoneNumber": { - "description": "The phone number for the user's desk phone.", - "type": "string" - }, - "Email": { - "description": "The email address. If you are using SAML for identity management and include this parameter, an error is returned.", - "type": "string" - }, - "FirstName": { - "description": "The first name. This is required if you are using Amazon Connect or SAML for identity management.", - "type": "string" - }, - "LastName": { - "description": "The last name. This is required if you are using Amazon Connect or SAML for identity management.", - "type": "string" - }, - "Level": { - "description": "The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.", - "maximum": 5.0, - "minimum": 1.0, - "type": "number" - }, - "Mobile": { - "description": "The mobile phone number.", - "pattern": "^\\+[1-9]\\d{1,14}$", - "type": "string" - }, - "PhoneType": { - "description": "The phone type.", - "enum": [ - "SOFT_PHONE", - "DESK_PHONE" - ], - "type": "string" - }, - "SecondaryEmail": { - "description": "The secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.", - "pattern": "(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", - "type": "string" - }, - "SecurityProfileArn": { - "description": "The identifier of the security profile for the user.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UserIdentityInfo": { - "additionalProperties": false, - "description": "Contains information about the identity of a user.", - "properties": { - "Email": { - "$ref": "#/definitions/Email" - }, - "FirstName": { - "$ref": "#/definitions/FirstName" - }, - "LastName": { - "$ref": "#/definitions/LastName" - }, - "Mobile": { - "$ref": "#/definitions/Mobile" - }, - "SecondaryEmail": { - "$ref": "#/definitions/SecondaryEmail" - } - }, - "type": "object" - }, - "UserPhoneConfig": { - "additionalProperties": false, - "description": "Contains information about the phone configuration settings for a user.", - "properties": { - "AfterContactWorkTimeLimit": { - "$ref": "#/definitions/AfterContactWorkTimeLimit" - }, - "AutoAccept": { - "$ref": "#/definitions/AutoAccept" - }, - "DeskPhoneNumber": { - "$ref": "#/definitions/DeskPhoneNumber" - }, - "PhoneType": { - "$ref": "#/definitions/PhoneType" - } - }, - "required": [ - "PhoneType" - ], - "type": "object" - }, - "UserProficiency": { - "additionalProperties": false, - "description": "Proficiency of a user.", - "properties": { - "AttributeName": { - "$ref": "#/definitions/AttributeName" - }, - "AttributeValue": { - "$ref": "#/definitions/AttributeValue" - }, - "Level": { - "$ref": "#/definitions/Level" - } - }, - "required": [ - "AttributeName", - "AttributeValue", - "Level" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::User", - "handlers": { - "create": { - "permissions": [ - "connect:CreateUser", - "connect:TagResource", - "connect:AssociateUserProficiencies" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteUser", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListUsers" - ] - }, - "read": { - "permissions": [ - "connect:DescribeUser", - "connect:ListUserProficiencies" - ] - }, - "update": { - "permissions": [ - "connect:UpdateUserIdentityInfo", - "connect:UpdateUserPhoneConfig", - "connect:UpdateUserRoutingProfile", - "connect:UpdateUserSecurityProfiles", - "connect:UpdateUserHierarchy", - "connect:TagResource", - "connect:UntagResource", - "connect:AssociateUserProficiencies", - "connect:DisassociateUserProficiencies", - "connect:UpdateUserProficiencies" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserArn" - ], - "properties": { - "DirectoryUserId": { - "description": "The identifier of the user account in the directory used for identity management.", - "type": "string" - }, - "HierarchyGroupArn": { - "description": "The identifier of the hierarchy group for the user.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$", - "type": "string" - }, - "IdentityInfo": { - "$ref": "#/definitions/UserIdentityInfo", - "description": "The information about the identity of the user." - }, - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Password": { - "description": "The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.", - "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$", - "type": "string" - }, - "PhoneConfig": { - "$ref": "#/definitions/UserPhoneConfig", - "description": "The phone settings for the user." - }, - "RoutingProfileArn": { - "description": "The identifier of the routing profile for the user.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$", - "type": "string" - }, - "SecurityProfileArns": { - "description": "One or more security profile arns for the user", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityProfileArn" - }, - "maxItems": 10, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserArn": { - "description": "The Amazon Resource Name (ARN) for the user.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", - "type": "string" - }, - "UserProficiencies": { - "description": "One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/UserProficiency" - }, - "type": "array" - }, - "Username": { - "description": "The user name for the account.", - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\_\\-\\.\\@]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/UserArn" - ], - "required": [ - "InstanceArn", - "PhoneConfig", - "RoutingProfileArn", - "SecurityProfileArns", - "Username" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::User", - "writeOnlyProperties": [ - "/properties/Password" - ] -} +{ + "additionalProperties": false, + "definitions": { + "AfterContactWorkTimeLimit": { + "description": "The After Call Work (ACW) timeout setting, in seconds.", + "minimum": 0, + "type": "integer" + }, + "AttributeName": { + "description": "The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "AttributeValue": { + "description": "The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "AutoAccept": { + "description": "The Auto accept setting.", + "type": "boolean" + }, + "DeskPhoneNumber": { + "description": "The phone number for the user's desk phone.", + "type": "string" + }, + "Email": { + "description": "The email address. If you are using SAML for identity management and include this parameter, an error is returned.", + "type": "string" + }, + "FirstName": { + "description": "The first name. This is required if you are using Amazon Connect or SAML for identity management.", + "type": "string" + }, + "LastName": { + "description": "The last name. This is required if you are using Amazon Connect or SAML for identity management.", + "type": "string" + }, + "Level": { + "description": "The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.", + "maximum": 5.0, + "minimum": 1.0, + "type": "number" + }, + "Mobile": { + "description": "The mobile phone number.", + "pattern": "^\\+[1-9]\\d{1,14}$", + "type": "string" + }, + "PhoneType": { + "description": "The phone type.", + "enum": [ + "SOFT_PHONE", + "DESK_PHONE" + ], + "type": "string" + }, + "SecondaryEmail": { + "description": "The secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.", + "pattern": "(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "SecurityProfileArn": { + "description": "The identifier of the security profile for the user.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserIdentityInfo": { + "additionalProperties": false, + "description": "Contains information about the identity of a user.", + "properties": { + "Email": { + "$ref": "#/definitions/Email" + }, + "FirstName": { + "$ref": "#/definitions/FirstName" + }, + "LastName": { + "$ref": "#/definitions/LastName" + }, + "Mobile": { + "$ref": "#/definitions/Mobile" + }, + "SecondaryEmail": { + "$ref": "#/definitions/SecondaryEmail" + } + }, + "type": "object" + }, + "UserPhoneConfig": { + "additionalProperties": false, + "description": "Contains information about the phone configuration settings for a user.", + "properties": { + "AfterContactWorkTimeLimit": { + "$ref": "#/definitions/AfterContactWorkTimeLimit" + }, + "AutoAccept": { + "$ref": "#/definitions/AutoAccept" + }, + "DeskPhoneNumber": { + "$ref": "#/definitions/DeskPhoneNumber" + }, + "PhoneType": { + "$ref": "#/definitions/PhoneType" + } + }, + "required": [ + "PhoneType" + ], + "type": "object" + }, + "UserProficiency": { + "additionalProperties": false, + "description": "Proficiency of a user.", + "properties": { + "AttributeName": { + "$ref": "#/definitions/AttributeName" + }, + "AttributeValue": { + "$ref": "#/definitions/AttributeValue" + }, + "Level": { + "$ref": "#/definitions/Level" + } + }, + "required": [ + "AttributeName", + "AttributeValue", + "Level" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::User", + "handlers": { + "create": { + "permissions": [ + "connect:CreateUser", + "connect:TagResource", + "connect:AssociateUserProficiencies" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteUser", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListUsers" + ] + }, + "read": { + "permissions": [ + "connect:DescribeUser", + "connect:ListUserProficiencies" + ] + }, + "update": { + "permissions": [ + "connect:UpdateUserIdentityInfo", + "connect:UpdateUserPhoneConfig", + "connect:UpdateUserRoutingProfile", + "connect:UpdateUserSecurityProfiles", + "connect:UpdateUserHierarchy", + "connect:TagResource", + "connect:UntagResource", + "connect:AssociateUserProficiencies", + "connect:DisassociateUserProficiencies", + "connect:UpdateUserProficiencies" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserArn" + ], + "properties": { + "DirectoryUserId": { + "description": "The identifier of the user account in the directory used for identity management.", + "type": "string" + }, + "HierarchyGroupArn": { + "description": "The identifier of the hierarchy group for the user.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$", + "type": "string" + }, + "IdentityInfo": { + "$ref": "#/definitions/UserIdentityInfo", + "description": "The information about the identity of the user." + }, + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Password": { + "description": "The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$", + "type": "string" + }, + "PhoneConfig": { + "$ref": "#/definitions/UserPhoneConfig", + "description": "The phone settings for the user." + }, + "RoutingProfileArn": { + "description": "The identifier of the routing profile for the user.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$", + "type": "string" + }, + "SecurityProfileArns": { + "description": "One or more security profile arns for the user", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityProfileArn" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserArn": { + "description": "The Amazon Resource Name (ARN) for the user.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$", + "type": "string" + }, + "UserProficiencies": { + "description": "One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/UserProficiency" + }, + "type": "array" + }, + "Username": { + "description": "The user name for the account.", + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\_\\-\\.\\@]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/UserArn" + ], + "required": [ + "InstanceArn", + "PhoneConfig", + "RoutingProfileArn", + "SecurityProfileArns", + "Username" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::User", + "writeOnlyProperties": [ + "/properties/Password" + ] +} diff --git a/schema/aws-connect-userhierarchygroup.json b/schema/aws-connect-userhierarchygroup.json index f3c0d0c..8fc27c3 100644 --- a/schema/aws-connect-userhierarchygroup.json +++ b/schema/aws-connect-userhierarchygroup.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ParentGroupArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UserHierarchyGroupArn": { - "description": "The Amazon Resource Name (ARN) for the user hierarchy group.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::Connect::UserHierarchyGroup", - "handlers": { - "create": { - "permissions": [ - "connect:CreateUserHierarchyGroup", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteUserHierarchyGroup", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListUserHierarchyGroups" - ] - }, - "read": { - "permissions": [ - "connect:DescribeUserHierarchyGroup" - ] - }, - "update": { - "permissions": [ - "connect:UpdateUserHierarchyGroupName", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserHierarchyGroupArn" - ], - "properties": { - "InstanceArn": { - "description": "The identifier of the Amazon Connect instance.", - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the user hierarchy group.", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ParentGroupArn": { - "$ref": "#/definitions/UserHierarchyGroupArn", - "description": "The Amazon Resource Name (ARN) for the parent user hierarchy group." - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserHierarchyGroupArn": { - "$ref": "#/definitions/UserHierarchyGroupArn", - "description": "The Amazon Resource Name (ARN) for the user hierarchy group." - } - }, - "readOnlyProperties": [ - "/properties/UserHierarchyGroupArn" - ], - "required": [ - "Name", - "InstanceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::UserHierarchyGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ParentGroupArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserHierarchyGroupArn": { + "description": "The Amazon Resource Name (ARN) for the user hierarchy group.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::UserHierarchyGroup", + "handlers": { + "create": { + "permissions": [ + "connect:CreateUserHierarchyGroup", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteUserHierarchyGroup", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListUserHierarchyGroups" + ] + }, + "read": { + "permissions": [ + "connect:DescribeUserHierarchyGroup" + ] + }, + "update": { + "permissions": [ + "connect:UpdateUserHierarchyGroupName", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserHierarchyGroupArn" + ], + "properties": { + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the user hierarchy group.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ParentGroupArn": { + "$ref": "#/definitions/UserHierarchyGroupArn", + "description": "The Amazon Resource Name (ARN) for the parent user hierarchy group." + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserHierarchyGroupArn": { + "$ref": "#/definitions/UserHierarchyGroupArn", + "description": "The Amazon Resource Name (ARN) for the user hierarchy group." + } + }, + "readOnlyProperties": [ + "/properties/UserHierarchyGroupArn" + ], + "required": [ + "Name", + "InstanceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::UserHierarchyGroup" +} diff --git a/schema/aws-connect-userhierarchystructure.json b/schema/aws-connect-userhierarchystructure.json new file mode 100644 index 0000000..bb809f5 --- /dev/null +++ b/schema/aws-connect-userhierarchystructure.json @@ -0,0 +1,190 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn" + ], + "definitions": { + "HierarchyLevelArn": { + "description": "The Amazon Resource Name (ARN) of the hierarchy level.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$", + "type": "string" + }, + "HierarchyLevelId": { + "description": "The identifier of the hierarchy level.", + "type": "string" + }, + "LevelFive": { + "additionalProperties": false, + "description": "Information about level five.", + "properties": { + "HierarchyLevelArn": { + "$ref": "#/definitions/HierarchyLevelArn" + }, + "HierarchyLevelId": { + "$ref": "#/definitions/HierarchyLevelId" + }, + "Name": { + "$ref": "#/definitions/Name" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LevelFour": { + "additionalProperties": false, + "description": "Information about level four.", + "properties": { + "HierarchyLevelArn": { + "$ref": "#/definitions/HierarchyLevelArn" + }, + "HierarchyLevelId": { + "$ref": "#/definitions/HierarchyLevelId" + }, + "Name": { + "$ref": "#/definitions/Name" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LevelOne": { + "additionalProperties": false, + "description": "Information about level one.", + "properties": { + "HierarchyLevelArn": { + "$ref": "#/definitions/HierarchyLevelArn" + }, + "HierarchyLevelId": { + "$ref": "#/definitions/HierarchyLevelId" + }, + "Name": { + "$ref": "#/definitions/Name" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LevelThree": { + "additionalProperties": false, + "description": "Information about level three.", + "properties": { + "HierarchyLevelArn": { + "$ref": "#/definitions/HierarchyLevelArn" + }, + "HierarchyLevelId": { + "$ref": "#/definitions/HierarchyLevelId" + }, + "Name": { + "$ref": "#/definitions/Name" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LevelTwo": { + "additionalProperties": false, + "description": "Information about level two.", + "properties": { + "HierarchyLevelArn": { + "$ref": "#/definitions/HierarchyLevelArn" + }, + "HierarchyLevelId": { + "$ref": "#/definitions/HierarchyLevelId" + }, + "Name": { + "$ref": "#/definitions/Name" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Name": { + "description": "The name of the hierarchy level.", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::Connect::UserHierarchyStructure", + "handlers": { + "create": { + "permissions": [ + "connect:UpdateUserHierarchyStructure" + ] + }, + "delete": { + "permissions": [ + "connect:UpdateUserHierarchyStructure" + ] + }, + "read": { + "permissions": [ + "connect:DescribeUserHierarchyStructure" + ] + }, + "update": { + "permissions": [ + "connect:UpdateUserHierarchyStructure" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserHierarchyStructureArn" + ], + "properties": { + "InstanceArn": { + "description": "The identifier of the Amazon Connect instance.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "UserHierarchyStructure": { + "additionalProperties": false, + "description": "Information about the hierarchy structure.", + "properties": { + "LevelFive": { + "$ref": "#/definitions/LevelFive" + }, + "LevelFour": { + "$ref": "#/definitions/LevelFour" + }, + "LevelOne": { + "$ref": "#/definitions/LevelOne" + }, + "LevelThree": { + "$ref": "#/definitions/LevelThree" + }, + "LevelTwo": { + "$ref": "#/definitions/LevelTwo" + } + }, + "type": "object" + }, + "UserHierarchyStructureArn": { + "description": "The identifier of the User Hierarchy Structure.", + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/user-hierarchy-structure", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/UserHierarchyStructureArn" + ], + "required": [ + "InstanceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::UserHierarchyStructure" +} diff --git a/schema/aws-connect-view.json b/schema/aws-connect-view.json index dc97973..39f6aae 100644 --- a/schema/aws-connect-view.json +++ b/schema/aws-connect-view.json @@ -1,162 +1,162 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Connect::View", - "handlers": { - "create": { - "permissions": [ - "connect:CreateView", - "connect:TagResource" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteView", - "connect:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "connect:ListViews" - ] - }, - "read": { - "permissions": [ - "connect:DescribeView" - ] - }, - "update": { - "permissions": [ - "connect:UpdateViewMetadata", - "connect:UpdateViewContent", - "connect:TagResource", - "connect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ViewArn" - ], - "properties": { - "Actions": { - "description": "The actions of the view in an array.", - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$", - "type": "string" - }, - "maxItems": 1000, - "type": "array" - }, - "Description": { - "description": "The description of the view.", - "maxLength": 4096, - "minLength": 0, - "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@,]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,]*)$", - "type": "string" - }, - "InstanceArn": { - "description": "The Amazon Resource Name (ARN) of the instance.", - "maxLength": 100, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "Name": { - "description": "The name of the view.", - "maxLength": 512, - "minLength": 1, - "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$", - "type": "string" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Template": { - "description": "The template of the view as JSON.", - "type": "object" - }, - "ViewArn": { - "description": "The Amazon Resource Name (ARN) of the view.", - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:$a-zA-Z0-9]*$", - "type": "string" - }, - "ViewContentSha256": { - "description": "The view content hash.", - "pattern": "^[a-zA-Z0-9]{64}$", - "type": "string" - }, - "ViewId": { - "description": "The view id of the view.", - "maxLength": 500, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\_\\-:\\/$]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ViewArn", - "/properties/ViewId", - "/properties/ViewContentSha256" - ], - "required": [ - "InstanceArn", - "Template", - "Actions", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Connect::View" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Connect::View", + "handlers": { + "create": { + "permissions": [ + "connect:CreateView", + "connect:TagResource" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteView", + "connect:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListViews" + ] + }, + "read": { + "permissions": [ + "connect:DescribeView" + ] + }, + "update": { + "permissions": [ + "connect:UpdateViewMetadata", + "connect:UpdateViewContent", + "connect:TagResource", + "connect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ViewArn" + ], + "properties": { + "Actions": { + "description": "The actions of the view in an array.", + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$", + "type": "string" + }, + "maxItems": 1000, + "type": "array" + }, + "Description": { + "description": "The description of the view.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@,]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,]*)$", + "type": "string" + }, + "InstanceArn": { + "description": "The Amazon Resource Name (ARN) of the instance.", + "maxLength": 100, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "Name": { + "description": "The name of the view.", + "maxLength": 512, + "minLength": 1, + "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$", + "type": "string" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Template": { + "description": "The template of the view as JSON.", + "type": "object" + }, + "ViewArn": { + "description": "The Amazon Resource Name (ARN) of the view.", + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:$a-zA-Z0-9]*$", + "type": "string" + }, + "ViewContentSha256": { + "description": "The view content hash.", + "pattern": "^[a-zA-Z0-9]{64}$", + "type": "string" + }, + "ViewId": { + "description": "The view id of the view.", + "maxLength": 500, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\_\\-:\\/$]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ViewArn", + "/properties/ViewId", + "/properties/ViewContentSha256" + ], + "required": [ + "InstanceArn", + "Template", + "Actions", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Connect::View" +} diff --git a/schema/aws-connect-viewversion.json b/schema/aws-connect-viewversion.json index d7d6ff9..ac2acfd 100644 --- a/schema/aws-connect-viewversion.json +++ b/schema/aws-connect-viewversion.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ViewArn", - "/properties/VersionDescription", - "/properties/ViewContentSha256" - ], - "description": "Resource Type definition for AWS::Connect::ViewVersion", - "handlers": { - "create": { - "permissions": [ - "connect:CreateViewVersion" - ] - }, - "delete": { - "permissions": [ - "connect:DeleteViewVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ViewArn": { - "$ref": "resource-schema.json#/properties/ViewArn" - } - }, - "required": [ - "ViewArn" - ] - }, - "permissions": [ - "connect:ListViewVersions" - ] - }, - "read": { - "permissions": [ - "connect:DescribeView" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/ViewVersionArn" - ], - "properties": { - "Version": { - "description": "The version of the view.", - "type": "integer" - }, - "VersionDescription": { - "description": "The description for the view version.", - "maxLength": 4096, - "minLength": 1, - "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@,]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,]*)$", - "type": "string" - }, - "ViewArn": { - "description": "The Amazon Resource Name (ARN) of the view for which a version is being created.", - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$", - "type": "string" - }, - "ViewContentSha256": { - "description": "The view content hash to be checked.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]{64}$", - "type": "string" - }, - "ViewVersionArn": { - "description": "The Amazon Resource Name (ARN) of the created view version.", - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$", - "type": "string" - } - }, - "propertyTransform": { - "/properties/ViewArn": "$join([\"^\", ViewArn, \":[0-9]*$\"])" - }, - "readOnlyProperties": [ - "/properties/ViewVersionArn", - "/properties/Version" - ], - "required": [ - "ViewArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Connect::ViewVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ViewArn", + "/properties/VersionDescription", + "/properties/ViewContentSha256" + ], + "description": "Resource Type definition for AWS::Connect::ViewVersion", + "handlers": { + "create": { + "permissions": [ + "connect:CreateViewVersion" + ] + }, + "delete": { + "permissions": [ + "connect:DeleteViewVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ViewArn": { + "$ref": "resource-schema.json#/properties/ViewArn" + } + }, + "required": [ + "ViewArn" + ] + }, + "permissions": [ + "connect:ListViewVersions" + ] + }, + "read": { + "permissions": [ + "connect:DescribeView" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/ViewVersionArn" + ], + "properties": { + "Version": { + "description": "The version of the view.", + "type": "integer" + }, + "VersionDescription": { + "description": "The description for the view version.", + "maxLength": 4096, + "minLength": 1, + "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@,]+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,]*)$", + "type": "string" + }, + "ViewArn": { + "description": "The Amazon Resource Name (ARN) of the view for which a version is being created.", + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$", + "type": "string" + }, + "ViewContentSha256": { + "description": "The view content hash to be checked.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]{64}$", + "type": "string" + }, + "ViewVersionArn": { + "description": "The Amazon Resource Name (ARN) of the created view version.", + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$", + "type": "string" + } + }, + "propertyTransform": { + "/properties/ViewArn": "$join([\"^\", ViewArn, \":[0-9]*$\"])" + }, + "readOnlyProperties": [ + "/properties/ViewVersionArn", + "/properties/Version" + ], + "required": [ + "ViewArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Connect::ViewVersion" +} diff --git a/schema/aws-connectcampaigns-campaign.json b/schema/aws-connectcampaigns-campaign.json index c2f08cb..a781f1e 100644 --- a/schema/aws-connectcampaigns-campaign.json +++ b/schema/aws-connectcampaigns-campaign.json @@ -1,271 +1,271 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectInstanceArn" - ], - "definitions": { - "AgentlessDialerConfig": { - "additionalProperties": false, - "description": "Agentless Dialer config", - "properties": { - "DialingCapacity": { - "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", - "maximum": 1, - "minimum": 0.01, - "type": "number" - } - }, - "required": [], - "type": "object" - }, - "AnswerMachineDetectionConfig": { - "additionalProperties": false, - "description": "The configuration used for answering machine detection during outbound calls", - "properties": { - "AwaitAnswerMachinePrompt": { - "description": "Enables detection of prompts (e.g., beep after after a voicemail greeting)", - "type": "boolean" - }, - "EnableAnswerMachineDetection": { - "description": "Flag to decided whether outbound calls should have answering machine detection enabled or not", - "type": "boolean" - } - }, - "required": [ - "EnableAnswerMachineDetection" - ], - "type": "object" - }, - "DialerConfig": { - "additionalProperties": false, - "description": "The possible types of dialer config parameters", - "oneOf": [ - { - "required": [ - "ProgressiveDialerConfig" - ] - }, - { - "required": [ - "PredictiveDialerConfig" - ] - }, - { - "required": [ - "AgentlessDialerConfig" - ] - } - ], - "properties": { - "AgentlessDialerConfig": { - "$ref": "#/definitions/AgentlessDialerConfig" - }, - "PredictiveDialerConfig": { - "$ref": "#/definitions/PredictiveDialerConfig" - }, - "ProgressiveDialerConfig": { - "$ref": "#/definitions/ProgressiveDialerConfig" - } - }, - "type": "object" - }, - "OutboundCallConfig": { - "additionalProperties": false, - "description": "The configuration used for outbound calls.", - "properties": { - "AnswerMachineDetectionConfig": { - "$ref": "#/definitions/AnswerMachineDetectionConfig" - }, - "ConnectContactFlowArn": { - "description": "The identifier of the contact flow for the outbound call.", - "maxLength": 500, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", - "type": "string" - }, - "ConnectQueueArn": { - "description": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.", - "maxLength": 500, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", - "type": "string" - }, - "ConnectSourcePhoneNumber": { - "description": "The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.", - "maxLength": 100, - "type": "string" - } - }, - "required": [ - "ConnectContactFlowArn" - ], - "type": "object" - }, - "PredictiveDialerConfig": { - "additionalProperties": false, - "description": "Predictive Dialer config", - "properties": { - "BandwidthAllocation": { - "description": "The bandwidth allocation of a queue resource.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "DialingCapacity": { - "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", - "maximum": 1, - "minimum": 0.01, - "type": "number" - } - }, - "required": [ - "BandwidthAllocation" - ], - "type": "object" - }, - "ProgressiveDialerConfig": { - "additionalProperties": false, - "description": "Progressive Dialer config", - "properties": { - "BandwidthAllocation": { - "description": "The bandwidth allocation of a queue resource.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "DialingCapacity": { - "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", - "maximum": 1, - "minimum": 0.01, - "type": "number" - } - }, - "required": [ - "BandwidthAllocation" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::ConnectCampaigns::Campaign Resource Type", - "handlers": { - "create": { - "permissions": [ - "connect-campaigns:CreateCampaign", - "connect-campaigns:DescribeCampaign", - "connect-campaigns:TagResource", - "connect:DescribeContactFlow", - "connect:DescribeInstance", - "connect:DescribeQueue" - ] - }, - "delete": { - "permissions": [ - "connect-campaigns:DeleteCampaign" - ] - }, - "list": { - "permissions": [ - "connect-campaigns:ListCampaigns" - ] - }, - "read": { - "permissions": [ - "connect-campaigns:DescribeCampaign" - ] - }, - "update": { - "permissions": [ - "connect-campaigns:UpdateCampaignDialerConfig", - "connect-campaigns:UpdateCampaignName", - "connect-campaigns:UpdateCampaignOutboundCallConfig", - "connect-campaigns:TagResource", - "connect-campaigns:UntagResource", - "connect-campaigns:DescribeCampaign" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Connect Campaign Arn", - "maxLength": 256, - "minLength": 0, - "pattern": "^arn:aws[-a-z0-9]*:connect-campaigns:[-a-z0-9]*:[0-9]{12}:campaign/[-a-zA-Z0-9]*$", - "type": "string" - }, - "ConnectInstanceArn": { - "description": "Amazon Connect Instance Arn", - "maxLength": 256, - "minLength": 0, - "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", - "type": "string" - }, - "DialerConfig": { - "$ref": "#/definitions/DialerConfig" - }, - "Name": { - "description": "Amazon Connect Campaign Name", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "OutboundCallConfig": { - "$ref": "#/definitions/OutboundCallConfig" - }, - "Tags": { - "description": "One or more tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ConnectInstanceArn", - "DialerConfig", - "Name", - "OutboundCallConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "connect-campaigns:UntagResource", - "connect-campaigns:TagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ConnectCampaigns::Campaign" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectInstanceArn" + ], + "definitions": { + "AgentlessDialerConfig": { + "additionalProperties": false, + "description": "Agentless Dialer config", + "properties": { + "DialingCapacity": { + "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", + "maximum": 1, + "minimum": 0.01, + "type": "number" + } + }, + "required": [], + "type": "object" + }, + "AnswerMachineDetectionConfig": { + "additionalProperties": false, + "description": "The configuration used for answering machine detection during outbound calls", + "properties": { + "AwaitAnswerMachinePrompt": { + "description": "Enables detection of prompts (e.g., beep after after a voicemail greeting)", + "type": "boolean" + }, + "EnableAnswerMachineDetection": { + "description": "Flag to decided whether outbound calls should have answering machine detection enabled or not", + "type": "boolean" + } + }, + "required": [ + "EnableAnswerMachineDetection" + ], + "type": "object" + }, + "DialerConfig": { + "additionalProperties": false, + "description": "The possible types of dialer config parameters", + "oneOf": [ + { + "required": [ + "ProgressiveDialerConfig" + ] + }, + { + "required": [ + "PredictiveDialerConfig" + ] + }, + { + "required": [ + "AgentlessDialerConfig" + ] + } + ], + "properties": { + "AgentlessDialerConfig": { + "$ref": "#/definitions/AgentlessDialerConfig" + }, + "PredictiveDialerConfig": { + "$ref": "#/definitions/PredictiveDialerConfig" + }, + "ProgressiveDialerConfig": { + "$ref": "#/definitions/ProgressiveDialerConfig" + } + }, + "type": "object" + }, + "OutboundCallConfig": { + "additionalProperties": false, + "description": "The configuration used for outbound calls.", + "properties": { + "AnswerMachineDetectionConfig": { + "$ref": "#/definitions/AnswerMachineDetectionConfig" + }, + "ConnectContactFlowArn": { + "description": "The identifier of the contact flow for the outbound call.", + "maxLength": 500, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$", + "type": "string" + }, + "ConnectQueueArn": { + "description": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.", + "maxLength": 500, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$", + "type": "string" + }, + "ConnectSourcePhoneNumber": { + "description": "The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.", + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "ConnectContactFlowArn" + ], + "type": "object" + }, + "PredictiveDialerConfig": { + "additionalProperties": false, + "description": "Predictive Dialer config", + "properties": { + "BandwidthAllocation": { + "description": "The bandwidth allocation of a queue resource.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "DialingCapacity": { + "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", + "maximum": 1, + "minimum": 0.01, + "type": "number" + } + }, + "required": [ + "BandwidthAllocation" + ], + "type": "object" + }, + "ProgressiveDialerConfig": { + "additionalProperties": false, + "description": "Progressive Dialer config", + "properties": { + "BandwidthAllocation": { + "description": "The bandwidth allocation of a queue resource.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "DialingCapacity": { + "description": "Allocates dialing capacity for this campaign between multiple active campaigns.", + "maximum": 1, + "minimum": 0.01, + "type": "number" + } + }, + "required": [ + "BandwidthAllocation" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::ConnectCampaigns::Campaign Resource Type", + "handlers": { + "create": { + "permissions": [ + "connect-campaigns:CreateCampaign", + "connect-campaigns:DescribeCampaign", + "connect-campaigns:TagResource", + "connect:DescribeContactFlow", + "connect:DescribeInstance", + "connect:DescribeQueue" + ] + }, + "delete": { + "permissions": [ + "connect-campaigns:DeleteCampaign" + ] + }, + "list": { + "permissions": [ + "connect-campaigns:ListCampaigns" + ] + }, + "read": { + "permissions": [ + "connect-campaigns:DescribeCampaign" + ] + }, + "update": { + "permissions": [ + "connect-campaigns:UpdateCampaignDialerConfig", + "connect-campaigns:UpdateCampaignName", + "connect-campaigns:UpdateCampaignOutboundCallConfig", + "connect-campaigns:TagResource", + "connect-campaigns:UntagResource", + "connect-campaigns:DescribeCampaign" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Connect Campaign Arn", + "maxLength": 256, + "minLength": 0, + "pattern": "^arn:aws[-a-z0-9]*:connect-campaigns:[-a-z0-9]*:[0-9]{12}:campaign/[-a-zA-Z0-9]*$", + "type": "string" + }, + "ConnectInstanceArn": { + "description": "Amazon Connect Instance Arn", + "maxLength": 256, + "minLength": 0, + "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", + "type": "string" + }, + "DialerConfig": { + "$ref": "#/definitions/DialerConfig" + }, + "Name": { + "description": "Amazon Connect Campaign Name", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "OutboundCallConfig": { + "$ref": "#/definitions/OutboundCallConfig" + }, + "Tags": { + "description": "One or more tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ConnectInstanceArn", + "DialerConfig", + "Name", + "OutboundCallConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "connect-campaigns:UntagResource", + "connect-campaigns:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ConnectCampaigns::Campaign" +} diff --git a/schema/aws-controltower-enabledbaseline.json b/schema/aws-controltower-enabledbaseline.json index 3b195d9..2985d5b 100644 --- a/schema/aws-controltower-enabledbaseline.json +++ b/schema/aws-controltower-enabledbaseline.json @@ -1,237 +1,237 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetIdentifier", - "/properties/BaselineIdentifier" - ], - "definitions": { - "AnyType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "number" - }, - { - "insertionOrder": false, - "items": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "object" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "boolean" - } - ] - }, - "Parameter": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Value": { - "$ref": "#/definitions/AnyType" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::ControlTower::EnabledBaseline Resource Type", - "handlers": { - "create": { - "permissions": [ - "controltower:EnableBaseline", - "controltower:TagResource", - "controltower:GetBaselineOperation", - "controltower:GetEnabledBaseline", - "controltower:ListTagsForResource", - "organizations:CreateOrganizationalUnit", - "organizations:CreateOrganization", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:EnablePolicyType", - "organizations:EnableAWSServiceAccess", - "organizations:ListRoots", - "servicecatalog:AssociatePrincipalWithPortfolio", - "servicecatalog:AssociateProductWithPortfolio", - "servicecatalog:CreatePortfolio", - "servicecatalog:CreateProduct", - "servicecatalog:CreateProvisioningArtifact", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:UpdatePortfolio", - "servicecatalog:UpdateProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "servicecatalog:DeleteProvisioningArtifact" - ] - }, - "delete": { - "permissions": [ - "controltower:DisableBaseline", - "controltower:GetBaselineOperation", - "organizations:CreateOrganizationalUnit", - "organizations:CreateOrganization", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:EnablePolicyType", - "organizations:EnableAWSServiceAccess", - "organizations:ListRoots", - "servicecatalog:AssociatePrincipalWithPortfolio", - "servicecatalog:AssociateProductWithPortfolio", - "servicecatalog:CreatePortfolio", - "servicecatalog:CreateProduct", - "servicecatalog:CreateProvisioningArtifact", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:UpdatePortfolio", - "servicecatalog:UpdateProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "servicecatalog:DeleteProvisioningArtifact" - ] - }, - "list": { - "permissions": [ - "controltower:ListEnabledBaselines" - ] - }, - "read": { - "permissions": [ - "controltower:GetEnabledBaseline", - "controltower:ListEnabledBaselines", - "controltower:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "controltower:UpdateEnabledBaseline", - "controltower:GetBaselineOperation", - "organizations:CreateOrganizationalUnit", - "organizations:CreateOrganization", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:EnablePolicyType", - "organizations:EnableAWSServiceAccess", - "organizations:ListRoots", - "servicecatalog:AssociatePrincipalWithPortfolio", - "servicecatalog:AssociateProductWithPortfolio", - "servicecatalog:CreatePortfolio", - "servicecatalog:CreateProduct", - "servicecatalog:CreateProvisioningArtifact", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:UpdatePortfolio", - "servicecatalog:UpdateProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "servicecatalog:DeleteProvisioningArtifact", - "controltower:TagResource", - "controltower:ListTagsForResource", - "controltower:GetEnabledBaseline" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnabledBaselineIdentifier" - ], - "properties": { - "BaselineIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - }, - "BaselineVersion": { - "pattern": "^\\d+(?:\\.\\d+){0,2}$", - "type": "string" - }, - "EnabledBaselineIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - }, - "Parameters": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/EnabledBaselineIdentifier" - ], - "required": [ - "BaselineIdentifier", - "TargetIdentifier", - "BaselineVersion" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ControlTower::EnabledBaseline" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetIdentifier", + "/properties/BaselineIdentifier" + ], + "definitions": { + "AnyType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "number" + }, + { + "insertionOrder": false, + "items": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "string" + } + ] + }, + "type": "array" + }, + { + "type": "boolean" + } + ] + }, + "Parameter": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "$ref": "#/definitions/AnyType" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::ControlTower::EnabledBaseline Resource Type", + "handlers": { + "create": { + "permissions": [ + "controltower:EnableBaseline", + "controltower:TagResource", + "controltower:GetBaselineOperation", + "controltower:GetEnabledBaseline", + "controltower:ListTagsForResource", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact" + ] + }, + "delete": { + "permissions": [ + "controltower:DisableBaseline", + "controltower:GetBaselineOperation", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact" + ] + }, + "list": { + "permissions": [ + "controltower:ListEnabledBaselines" + ] + }, + "read": { + "permissions": [ + "controltower:GetEnabledBaseline", + "controltower:ListEnabledBaselines", + "controltower:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "controltower:UpdateEnabledBaseline", + "controltower:GetBaselineOperation", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact", + "controltower:TagResource", + "controltower:ListTagsForResource", + "controltower:GetEnabledBaseline" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnabledBaselineIdentifier" + ], + "properties": { + "BaselineIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "BaselineVersion": { + "pattern": "^\\d+(?:\\.\\d+){0,2}$", + "type": "string" + }, + "EnabledBaselineIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "Parameters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TargetIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/EnabledBaselineIdentifier" + ], + "required": [ + "BaselineIdentifier", + "TargetIdentifier", + "BaselineVersion" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ControlTower::EnabledBaseline" +} diff --git a/schema/aws-controltower-enabledcontrol.json b/schema/aws-controltower-enabledcontrol.json index 7035dad..3741846 100644 --- a/schema/aws-controltower-enabledcontrol.json +++ b/schema/aws-controltower-enabledcontrol.json @@ -1,211 +1,211 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetIdentifier", - "/properties/ControlIdentifier" - ], - "definitions": { - "EnabledControlParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "anyOf": [ - { - "insertionOrder": false, - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "object" - }, - { - "type": "boolean" - } - ] - }, - "minItems": 1, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "object" - }, - { - "type": "boolean" - } - ] - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Enables a control on a specified target.", - "handlers": { - "create": { - "permissions": [ - "controltower:ListEnabledControls", - "controltower:GetEnabledControl", - "controltower:GetControlOperation", - "controltower:EnableControl", - "controltower:TagResource", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:ListPoliciesForTarget", - "organizations:ListTargetsForPolicy", - "organizations:DescribePolicy" - ], - "timeoutInMinutes": 720 - }, - "delete": { - "permissions": [ - "controltower:ListEnabledControls", - "controltower:GetEnabledControl", - "controltower:GetControlOperation", - "controltower:DisableControl", - "organizations:UpdatePolicy", - "organizations:DeletePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:ListPoliciesForTarget", - "organizations:ListTargetsForPolicy", - "organizations:DescribePolicy" - ], - "timeoutInMinutes": 720 - }, - "list": { - "handlerSchema": { - "properties": { - "TargetIdentifier": { - "$ref": "resource-schema.json#/properties/TargetIdentifier" - } - }, - "required": [ - "TargetIdentifier" - ] - }, - "permissions": [ - "controltower:ListEnabledControls" - ] - }, - "read": { - "permissions": [ - "controltower:ListEnabledControls", - "controltower:GetEnabledControl", - "controltower:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "controltower:ListEnabledControls", - "controltower:GetEnabledControl", - "controltower:GetControlOperation", - "controltower:UpdateEnabledControl", - "controltower:UntagResource", - "controltower:TagResource", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:ListPoliciesForTarget", - "organizations:ListTargetsForPolicy", - "organizations:DescribePolicy" - ], - "timeoutInMinutes": 720 - } - }, - "primaryIdentifier": [ - "/properties/TargetIdentifier", - "/properties/ControlIdentifier" - ], - "properties": { - "ControlIdentifier": { - "description": "Arn of the control.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - }, - "Parameters": { - "description": "Parameters to configure the enabled control behavior.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EnabledControlParameter" - }, - "minItems": 1, - "type": "array" - }, - "Tags": { - "description": "A set of tags to assign to the enabled control.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "TargetIdentifier": { - "description": "Arn for Organizational unit to which the control needs to be applied", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - } - }, - "required": [ - "TargetIdentifier", - "ControlIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ControlTower::EnabledControl" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetIdentifier", + "/properties/ControlIdentifier" + ], + "definitions": { + "EnabledControlParameter": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "anyOf": [ + { + "insertionOrder": false, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "boolean" + } + ] + }, + "minItems": 1, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Enables a control on a specified target.", + "handlers": { + "create": { + "permissions": [ + "controltower:ListEnabledControls", + "controltower:GetEnabledControl", + "controltower:GetControlOperation", + "controltower:EnableControl", + "controltower:TagResource", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:ListPoliciesForTarget", + "organizations:ListTargetsForPolicy", + "organizations:DescribePolicy" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "controltower:ListEnabledControls", + "controltower:GetEnabledControl", + "controltower:GetControlOperation", + "controltower:DisableControl", + "organizations:UpdatePolicy", + "organizations:DeletePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:ListPoliciesForTarget", + "organizations:ListTargetsForPolicy", + "organizations:DescribePolicy" + ], + "timeoutInMinutes": 720 + }, + "list": { + "handlerSchema": { + "properties": { + "TargetIdentifier": { + "$ref": "resource-schema.json#/properties/TargetIdentifier" + } + }, + "required": [ + "TargetIdentifier" + ] + }, + "permissions": [ + "controltower:ListEnabledControls" + ] + }, + "read": { + "permissions": [ + "controltower:ListEnabledControls", + "controltower:GetEnabledControl", + "controltower:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "controltower:ListEnabledControls", + "controltower:GetEnabledControl", + "controltower:GetControlOperation", + "controltower:UpdateEnabledControl", + "controltower:UntagResource", + "controltower:TagResource", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:ListPoliciesForTarget", + "organizations:ListTargetsForPolicy", + "organizations:DescribePolicy" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/TargetIdentifier", + "/properties/ControlIdentifier" + ], + "properties": { + "ControlIdentifier": { + "description": "Arn of the control.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "Parameters": { + "description": "Parameters to configure the enabled control behavior.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnabledControlParameter" + }, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "A set of tags to assign to the enabled control.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "TargetIdentifier": { + "description": "Arn for Organizational unit to which the control needs to be applied", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + } + }, + "required": [ + "TargetIdentifier", + "ControlIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ControlTower::EnabledControl" +} diff --git a/schema/aws-controltower-landingzone.json b/schema/aws-controltower-landingzone.json index 89e3d1c..de98b2a 100644 --- a/schema/aws-controltower-landingzone.json +++ b/schema/aws-controltower-landingzone.json @@ -1,205 +1,205 @@ -{ - "additionalProperties": false, - "definitions": { - "LandingZoneDriftStatus": { - "enum": [ - "DRIFTED", - "IN_SYNC" - ], - "type": "string" - }, - "LandingZoneStatus": { - "enum": [ - "ACTIVE", - "PROCESSING", - "FAILED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::ControlTower::LandingZone Resource Type", - "handlers": { - "create": { - "permissions": [ - "controltower:CreateLandingZone", - "controltower:GetLandingZoneOperation", - "controltower:ListTagsForResource", - "controltower:TagResource", - "controltower:GetLandingZone", - "cloudformation:DescribeOrganizationsAccess", - "servicecatalog:AssociatePrincipalWithPortfolio", - "servicecatalog:AssociateProductWithPortfolio", - "servicecatalog:CreatePortfolio", - "servicecatalog:CreateProduct", - "servicecatalog:CreateProvisioningArtifact", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:UpdatePortfolio", - "servicecatalog:UpdateProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "organizations:CreateOrganizationalUnit", - "organizations:CreateOrganization", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:EnablePolicyType", - "organizations:EnableAWSServiceAccess", - "organizations:ListRoots", - "sso:GetPeregrineStatus", - "sso:ListDirectoryAssociations", - "sso:StartPeregrine", - "sso:RegisterRegion" - ] - }, - "delete": { - "permissions": [ - "controltower:DeleteLandingZone", - "controltower:GetLandingZone", - "controltower:GetLandingZoneOperation", - "cloudformation:DescribeOrganizationsAccess", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:DeleteProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "servicecatalog:DeleteProduct", - "servicecatalog:DisassociatePrincipalFromPortfolio", - "servicecatalog:DisassociateProductFromPortfolio", - "servicecatalog:DeletePortfolio", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:ListRoots", - "sso:GetPeregrineStatus", - "sso:ListDirectoryAssociations", - "iam:DeleteRolePolicy", - "iam:DetachRolePolicy", - "iam:DeleteRole" - ] - }, - "list": { - "permissions": [ - "controltower:ListLandingZones" - ] - }, - "read": { - "permissions": [ - "controltower:GetLandingZone", - "controltower:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "controltower:UpdateLandingZone", - "controltower:GetLandingZoneOperation", - "controltower:ListTagsForResource", - "controltower:TagResource", - "controltower:GetLandingZone", - "controltower:UntagResource", - "cloudformation:DescribeOrganizationsAccess", - "servicecatalog:AssociatePrincipalWithPortfolio", - "servicecatalog:AssociateProductWithPortfolio", - "servicecatalog:CreatePortfolio", - "servicecatalog:CreateProduct", - "servicecatalog:CreateProvisioningArtifact", - "servicecatalog:ListPortfolios", - "servicecatalog:ListProvisioningArtifacts", - "servicecatalog:SearchProductsAsAdmin", - "servicecatalog:UpdatePortfolio", - "servicecatalog:UpdateProvisioningArtifact", - "servicecatalog:ListPrincipalsForPortfolio", - "organizations:CreateOrganizationalUnit", - "organizations:CreateOrganization", - "organizations:UpdatePolicy", - "organizations:CreatePolicy", - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:DeletePolicy", - "organizations:EnablePolicyType", - "organizations:EnableAWSServiceAccess", - "organizations:ListRoots", - "sso:GetPeregrineStatus", - "sso:ListDirectoryAssociations", - "sso:StartPeregrine", - "sso:RegisterRegion" - ] - } - }, - "primaryIdentifier": [ - "/properties/LandingZoneIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", - "type": "string" - }, - "DriftStatus": { - "$ref": "#/definitions/LandingZoneDriftStatus" - }, - "LandingZoneIdentifier": { - "type": "string" - }, - "LatestAvailableVersion": { - "maxLength": 10, - "minLength": 3, - "pattern": "\\d+.\\d+", - "type": "string" - }, - "Manifest": {}, - "Status": { - "$ref": "#/definitions/LandingZoneStatus" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Version": { - "maxLength": 10, - "minLength": 3, - "pattern": "\\d+.\\d+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LandingZoneIdentifier", - "/properties/Arn", - "/properties/Status", - "/properties/LatestAvailableVersion", - "/properties/DriftStatus" - ], - "required": [ - "Manifest", - "Version" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ControlTower::LandingZone" -} +{ + "additionalProperties": false, + "definitions": { + "LandingZoneDriftStatus": { + "enum": [ + "DRIFTED", + "IN_SYNC" + ], + "type": "string" + }, + "LandingZoneStatus": { + "enum": [ + "ACTIVE", + "PROCESSING", + "FAILED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::ControlTower::LandingZone Resource Type", + "handlers": { + "create": { + "permissions": [ + "controltower:CreateLandingZone", + "controltower:GetLandingZoneOperation", + "controltower:ListTagsForResource", + "controltower:TagResource", + "controltower:GetLandingZone", + "cloudformation:DescribeOrganizationsAccess", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "sso:GetPeregrineStatus", + "sso:ListDirectoryAssociations", + "sso:StartPeregrine", + "sso:RegisterRegion" + ] + }, + "delete": { + "permissions": [ + "controltower:DeleteLandingZone", + "controltower:GetLandingZone", + "controltower:GetLandingZoneOperation", + "cloudformation:DescribeOrganizationsAccess", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:DeleteProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProduct", + "servicecatalog:DisassociatePrincipalFromPortfolio", + "servicecatalog:DisassociateProductFromPortfolio", + "servicecatalog:DeletePortfolio", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:ListRoots", + "sso:GetPeregrineStatus", + "sso:ListDirectoryAssociations", + "iam:DeleteRolePolicy", + "iam:DetachRolePolicy", + "iam:DeleteRole" + ] + }, + "list": { + "permissions": [ + "controltower:ListLandingZones" + ] + }, + "read": { + "permissions": [ + "controltower:GetLandingZone", + "controltower:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "controltower:UpdateLandingZone", + "controltower:GetLandingZoneOperation", + "controltower:ListTagsForResource", + "controltower:TagResource", + "controltower:GetLandingZone", + "controltower:UntagResource", + "cloudformation:DescribeOrganizationsAccess", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "sso:GetPeregrineStatus", + "sso:ListDirectoryAssociations", + "sso:StartPeregrine", + "sso:RegisterRegion" + ] + } + }, + "primaryIdentifier": [ + "/properties/LandingZoneIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "DriftStatus": { + "$ref": "#/definitions/LandingZoneDriftStatus" + }, + "LandingZoneIdentifier": { + "type": "string" + }, + "LatestAvailableVersion": { + "maxLength": 10, + "minLength": 3, + "pattern": "\\d+.\\d+", + "type": "string" + }, + "Manifest": {}, + "Status": { + "$ref": "#/definitions/LandingZoneStatus" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Version": { + "maxLength": 10, + "minLength": 3, + "pattern": "\\d+.\\d+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LandingZoneIdentifier", + "/properties/Arn", + "/properties/Status", + "/properties/LatestAvailableVersion", + "/properties/DriftStatus" + ], + "required": [ + "Manifest", + "Version" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ControlTower::LandingZone" +} diff --git a/schema/aws-cur-reportdefinition.json b/schema/aws-cur-reportdefinition.json index b1ee396..b286c11 100644 --- a/schema/aws-cur-reportdefinition.json +++ b/schema/aws-cur-reportdefinition.json @@ -1,182 +1,182 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReportName", - "/properties/AdditionalSchemaElements", - "/properties/TimeUnit", - "/properties/ReportVersioning", - "/properties/BillingViewArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.", - "handlers": { - "create": { - "permissions": [ - "cur:PutReportDefinition", - "cur:DescribeReportDefinitions" - ] - }, - "delete": { - "permissions": [ - "cur:DeleteReportDefinition" - ] - }, - "list": { - "permissions": [ - "cur:DescribeReportDefinitions" - ] - }, - "read": { - "permissions": [ - "cur:DescribeReportDefinitions" - ] - }, - "update": { - "permissions": [ - "cur:DescribeReportDefinitions", - "cur:ModifyReportDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReportName" - ], - "properties": { - "AdditionalArtifacts": { - "default": [], - "description": "A list of manifests that you want Amazon Web Services to create for this report.", - "items": { - "description": "The types of manifest that you want AWS to create for this report.", - "enum": [ - "REDSHIFT", - "QUICKSIGHT", - "ATHENA" - ], - "type": "string" - }, - "type": "array" - }, - "AdditionalSchemaElements": { - "default": [], - "description": "A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.", - "items": { - "description": "Whether or not AWS includes resource IDs in the report.", - "enum": [ - "RESOURCES", - "SPLIT_COST_ALLOCATION_DATA", - "MANUAL_DISCOUNT_COMPATIBILITY" - ], - "type": "string" - }, - "type": "array" - }, - "BillingViewArn": { - "default": null, - "description": "The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.", - "maxLength": 128, - "minLength": 1, - "pattern": "(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}", - "type": "string" - }, - "Compression": { - "description": "The compression format that AWS uses for the report.", - "enum": [ - "ZIP", - "GZIP", - "Parquet" - ], - "type": "string" - }, - "Format": { - "description": "The format that AWS saves the report in.", - "enum": [ - "textORcsv", - "Parquet" - ], - "type": "string" - }, - "RefreshClosedReports": { - "description": "Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.", - "type": "boolean" - }, - "ReportName": { - "description": "The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.", - "maxLength": 256, - "minLength": 1, - "pattern": "[0-9A-Za-z!\\-_.*\\'()]+", - "type": "string" - }, - "ReportVersioning": { - "description": "Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.", - "enum": [ - "CREATE_NEW_REPORT", - "OVERWRITE_REPORT" - ], - "type": "string" - }, - "S3Bucket": { - "description": "The S3 bucket where AWS delivers the report.", - "maxLength": 256, - "minLength": 1, - "pattern": "[A-Za-z0-9_\\.\\-]+", - "type": "string" - }, - "S3Prefix": { - "description": "The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.", - "maxLength": 256, - "minLength": 1, - "pattern": "[0-9A-Za-z!\\-_.*\\'()/]*", - "type": "string" - }, - "S3Region": { - "description": "The region of the S3 bucket that AWS delivers the report into.", - "type": "string" - }, - "TimeUnit": { - "description": "The granularity of the line items in the report.", - "enum": [ - "HOURLY", - "DAILY", - "MONTHLY" - ], - "type": "string" - } - }, - "required": [ - "ReportName", - "TimeUnit", - "Format", - "Compression", - "S3Bucket", - "S3Prefix", - "S3Region", - "RefreshClosedReports", - "ReportVersioning" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cur.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::CUR::ReportDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReportName", + "/properties/AdditionalSchemaElements", + "/properties/TimeUnit", + "/properties/ReportVersioning", + "/properties/BillingViewArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.", + "handlers": { + "create": { + "permissions": [ + "cur:PutReportDefinition", + "cur:DescribeReportDefinitions" + ] + }, + "delete": { + "permissions": [ + "cur:DeleteReportDefinition" + ] + }, + "list": { + "permissions": [ + "cur:DescribeReportDefinitions" + ] + }, + "read": { + "permissions": [ + "cur:DescribeReportDefinitions" + ] + }, + "update": { + "permissions": [ + "cur:DescribeReportDefinitions", + "cur:ModifyReportDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReportName" + ], + "properties": { + "AdditionalArtifacts": { + "default": [], + "description": "A list of manifests that you want Amazon Web Services to create for this report.", + "items": { + "description": "The types of manifest that you want AWS to create for this report.", + "enum": [ + "REDSHIFT", + "QUICKSIGHT", + "ATHENA" + ], + "type": "string" + }, + "type": "array" + }, + "AdditionalSchemaElements": { + "default": [], + "description": "A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.", + "items": { + "description": "Whether or not AWS includes resource IDs in the report.", + "enum": [ + "RESOURCES", + "SPLIT_COST_ALLOCATION_DATA", + "MANUAL_DISCOUNT_COMPATIBILITY" + ], + "type": "string" + }, + "type": "array" + }, + "BillingViewArn": { + "default": null, + "description": "The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.", + "maxLength": 128, + "minLength": 1, + "pattern": "(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}", + "type": "string" + }, + "Compression": { + "description": "The compression format that AWS uses for the report.", + "enum": [ + "ZIP", + "GZIP", + "Parquet" + ], + "type": "string" + }, + "Format": { + "description": "The format that AWS saves the report in.", + "enum": [ + "textORcsv", + "Parquet" + ], + "type": "string" + }, + "RefreshClosedReports": { + "description": "Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.", + "type": "boolean" + }, + "ReportName": { + "description": "The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.", + "maxLength": 256, + "minLength": 1, + "pattern": "[0-9A-Za-z!\\-_.*\\'()]+", + "type": "string" + }, + "ReportVersioning": { + "description": "Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.", + "enum": [ + "CREATE_NEW_REPORT", + "OVERWRITE_REPORT" + ], + "type": "string" + }, + "S3Bucket": { + "description": "The S3 bucket where AWS delivers the report.", + "maxLength": 256, + "minLength": 1, + "pattern": "[A-Za-z0-9_\\.\\-]+", + "type": "string" + }, + "S3Prefix": { + "description": "The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.", + "maxLength": 256, + "minLength": 1, + "pattern": "[0-9A-Za-z!\\-_.*\\'()/]*", + "type": "string" + }, + "S3Region": { + "description": "The region of the S3 bucket that AWS delivers the report into.", + "type": "string" + }, + "TimeUnit": { + "description": "The granularity of the line items in the report.", + "enum": [ + "HOURLY", + "DAILY", + "MONTHLY" + ], + "type": "string" + } + }, + "required": [ + "ReportName", + "TimeUnit", + "Format", + "Compression", + "S3Bucket", + "S3Prefix", + "S3Region", + "RefreshClosedReports", + "ReportVersioning" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cur.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::CUR::ReportDefinition" +} diff --git a/schema/aws-customerprofiles-calculatedattributedefinition.json b/schema/aws-customerprofiles-calculatedattributedefinition.json index daf1184..2261638 100644 --- a/schema/aws-customerprofiles-calculatedattributedefinition.json +++ b/schema/aws-customerprofiles-calculatedattributedefinition.json @@ -1,322 +1,327 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/CalculatedAttributeName" - ], - "definitions": { - "AttributeDetails": { - "additionalProperties": false, - "description": "Mathematical expression and a list of attribute items specified in that expression.", - "properties": { - "Attributes": { - "$ref": "#/definitions/AttributeList" - }, - "Expression": { - "$ref": "#/definitions/Expression" - } - }, - "required": [ - "Attributes", - "Expression" - ], - "type": "object" - }, - "AttributeItem": { - "additionalProperties": false, - "description": "The details of a single attribute item specified in the mathematical expression.", - "properties": { - "Name": { - "$ref": "#/definitions/AttributeName" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AttributeList": { - "description": "A list of attribute items specified in the mathematical expression.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttributeItem" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "AttributeName": { - "description": "The name of an attribute defined in a profile object type.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "CalculatedAttributeName": { - "description": "The unique name of the calculated attribute.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", - "type": "string" - }, - "Conditions": { - "additionalProperties": false, - "description": "The conditions including range, object count, and threshold for the calculated attribute.", - "properties": { - "ObjectCount": { - "$ref": "#/definitions/ObjectCount" - }, - "Range": { - "$ref": "#/definitions/Range" - }, - "Threshold": { - "$ref": "#/definitions/Threshold" - } - }, - "type": "object" - }, - "Description": { - "description": "The description of the calculated attribute.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "DisplayName": { - "description": "The display name of the calculated attribute.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z_0-9-\\s]*$", - "type": "string" - }, - "DomainName": { - "description": "The unique name of the domain.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Expression": { - "description": "Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "ObjectCount": { - "description": "The number of profile objects used for the calculated attribute.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "Range": { - "additionalProperties": false, - "description": "The relative time period over which data is included in the aggregation.", - "properties": { - "Unit": { - "$ref": "#/definitions/RangeUnit" - }, - "Value": { - "$ref": "#/definitions/RangeValue" - } - }, - "required": [ - "Value", - "Unit" - ], - "type": "object" - }, - "RangeUnit": { - "description": "The unit of time.", - "enum": [ - "DAYS" - ], - "type": "string" - }, - "RangeValue": { - "description": "The amount of time of the specified unit.", - "maximum": 366, - "minimum": 1, - "type": "integer" - }, - "Statistic": { - "description": "The aggregation operation to perform for the calculated attribute.", - "enum": [ - "FIRST_OCCURRENCE", - "LAST_OCCURRENCE", - "COUNT", - "SUM", - "MINIMUM", - "MAXIMUM", - "AVERAGE", - "MAX_OCCURRENCE" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Threshold": { - "additionalProperties": false, - "description": "The threshold for the calculated attribute.", - "properties": { - "Operator": { - "$ref": "#/definitions/ThresholdOperator" - }, - "Value": { - "$ref": "#/definitions/ThresholdValue" - } - }, - "required": [ - "Value", - "Operator" - ], - "type": "object" - }, - "ThresholdOperator": { - "description": "The operator of the threshold.", - "enum": [ - "EQUAL_TO", - "GREATER_THAN", - "LESS_THAN", - "NOT_EQUAL_TO" - ], - "type": "string" - }, - "ThresholdValue": { - "description": "The value of the threshold.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "description": "A calculated attribute definition for Customer Profiles", - "handlers": { - "create": { - "permissions": [ - "profile:CreateCalculatedAttributeDefinition", - "profile:TagResource" - ] - }, - "delete": { - "permissions": [ - "profile:DeleteCalculatedAttributeDefinition" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "profile:ListCalculatedAttributeDefinitions" - ] - }, - "read": { - "permissions": [ - "profile:GetCalculatedAttributeDefinition" - ] - }, - "update": { - "permissions": [ - "profile:GetCalculatedAttributeDefinition", - "profile:UpdateCalculatedAttributeDefinition", - "profile:UntagResource", - "profile:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName", - "/properties/CalculatedAttributeName" - ], - "properties": { - "AttributeDetails": { - "$ref": "#/definitions/AttributeDetails" - }, - "CalculatedAttributeName": { - "$ref": "#/definitions/CalculatedAttributeName" - }, - "Conditions": { - "$ref": "#/definitions/Conditions" - }, - "CreatedAt": { - "description": "The timestamp of when the calculated attribute definition was created.", - "type": "string" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "DisplayName": { - "$ref": "#/definitions/DisplayName" - }, - "DomainName": { - "$ref": "#/definitions/DomainName" - }, - "LastUpdatedAt": { - "description": "The timestamp of when the calculated attribute definition was most recently edited.", - "type": "string" - }, - "Statistic": { - "$ref": "#/definitions/Statistic" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/LastUpdatedAt" - ], - "required": [ - "DomainName", - "CalculatedAttributeName", - "AttributeDetails", - "Statistic" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CustomerProfiles::CalculatedAttributeDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/CalculatedAttributeName" + ], + "definitions": { + "AttributeDetails": { + "additionalProperties": false, + "description": "Mathematical expression and a list of attribute items specified in that expression.", + "properties": { + "Attributes": { + "$ref": "#/definitions/AttributeList" + }, + "Expression": { + "$ref": "#/definitions/Expression" + } + }, + "required": [ + "Attributes", + "Expression" + ], + "type": "object" + }, + "AttributeItem": { + "additionalProperties": false, + "description": "The details of a single attribute item specified in the mathematical expression.", + "properties": { + "Name": { + "$ref": "#/definitions/AttributeName" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "AttributeList": { + "description": "A list of attribute items specified in the mathematical expression.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttributeItem" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "AttributeName": { + "description": "The name of an attribute defined in a profile object type.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "CalculatedAttributeName": { + "description": "The unique name of the calculated attribute.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", + "type": "string" + }, + "Conditions": { + "additionalProperties": false, + "description": "The conditions including range, object count, and threshold for the calculated attribute.", + "properties": { + "ObjectCount": { + "$ref": "#/definitions/ObjectCount" + }, + "Range": { + "$ref": "#/definitions/Range" + }, + "Threshold": { + "$ref": "#/definitions/Threshold" + } + }, + "type": "object" + }, + "Description": { + "description": "The description of the calculated attribute.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "DisplayName": { + "description": "The display name of the calculated attribute.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-\\s]*$", + "type": "string" + }, + "DomainName": { + "description": "The unique name of the domain.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Expression": { + "description": "Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ObjectCount": { + "description": "The number of profile objects used for the calculated attribute.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "Range": { + "additionalProperties": false, + "description": "The relative time period over which data is included in the aggregation.", + "properties": { + "Unit": { + "$ref": "#/definitions/RangeUnit" + }, + "Value": { + "$ref": "#/definitions/RangeValue" + } + }, + "required": [ + "Value", + "Unit" + ], + "type": "object" + }, + "RangeUnit": { + "description": "The unit of time.", + "enum": [ + "DAYS" + ], + "type": "string" + }, + "RangeValue": { + "description": "The amount of time of the specified unit.", + "maximum": 366, + "minimum": 1, + "type": "integer" + }, + "Statistic": { + "description": "The aggregation operation to perform for the calculated attribute.", + "enum": [ + "FIRST_OCCURRENCE", + "LAST_OCCURRENCE", + "COUNT", + "SUM", + "MINIMUM", + "MAXIMUM", + "AVERAGE", + "MAX_OCCURRENCE" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Threshold": { + "additionalProperties": false, + "description": "The threshold for the calculated attribute.", + "properties": { + "Operator": { + "$ref": "#/definitions/ThresholdOperator" + }, + "Value": { + "$ref": "#/definitions/ThresholdValue" + } + }, + "required": [ + "Value", + "Operator" + ], + "type": "object" + }, + "ThresholdOperator": { + "description": "The operator of the threshold.", + "enum": [ + "EQUAL_TO", + "GREATER_THAN", + "LESS_THAN", + "NOT_EQUAL_TO" + ], + "type": "string" + }, + "ThresholdValue": { + "description": "The value of the threshold.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "description": "A calculated attribute definition for Customer Profiles", + "handlers": { + "create": { + "permissions": [ + "profile:CreateCalculatedAttributeDefinition", + "profile:TagResource" + ] + }, + "delete": { + "permissions": [ + "profile:DeleteCalculatedAttributeDefinition" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "profile:ListCalculatedAttributeDefinitions" + ] + }, + "read": { + "permissions": [ + "profile:GetCalculatedAttributeDefinition" + ] + }, + "update": { + "permissions": [ + "profile:GetCalculatedAttributeDefinition", + "profile:UpdateCalculatedAttributeDefinition", + "profile:UntagResource", + "profile:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName", + "/properties/CalculatedAttributeName" + ], + "properties": { + "AttributeDetails": { + "$ref": "#/definitions/AttributeDetails" + }, + "CalculatedAttributeName": { + "$ref": "#/definitions/CalculatedAttributeName" + }, + "Conditions": { + "$ref": "#/definitions/Conditions" + }, + "CreatedAt": { + "description": "The timestamp of when the calculated attribute definition was created.", + "type": "string" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "DisplayName": { + "$ref": "#/definitions/DisplayName" + }, + "DomainName": { + "$ref": "#/definitions/DomainName" + }, + "LastUpdatedAt": { + "description": "The timestamp of when the calculated attribute definition was most recently edited.", + "type": "string" + }, + "Statistic": { + "$ref": "#/definitions/Statistic" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/LastUpdatedAt" + ], + "required": [ + "DomainName", + "CalculatedAttributeName", + "AttributeDetails", + "Statistic" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "profile:TagResource", + "profile:UntagResource", + "profile:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CustomerProfiles::CalculatedAttributeDefinition" +} diff --git a/schema/aws-customerprofiles-domain.json b/schema/aws-customerprofiles-domain.json index 496aec1..3831a10 100644 --- a/schema/aws-customerprofiles-domain.json +++ b/schema/aws-customerprofiles-domain.json @@ -1,463 +1,468 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "definitions": { - "AttributeTypesSelector": { - "additionalProperties": false, - "description": "Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.", - "properties": { - "Address": { - "description": "The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "AttributeMatchingModel": { - "description": "Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.", - "enum": [ - "ONE_TO_ONE", - "MANY_TO_MANY" - ], - "type": "string" - }, - "EmailAddress": { - "description": "The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - }, - "PhoneNumber": { - "description": "The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AttributeMatchingModel" - ], - "type": "object" - }, - "AutoMerging": { - "additionalProperties": false, - "description": "Configuration information about the auto-merging process.", - "properties": { - "ConflictResolution": { - "$ref": "#/definitions/ConflictResolution" - }, - "Consolidation": { - "$ref": "#/definitions/Consolidation" - }, - "Enabled": { - "description": "The flag that enables the auto-merging of duplicate profiles.", - "type": "boolean" - }, - "MinAllowedConfidenceScoreForMerging": { - "description": "A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.", - "maximum": 1.0, - "minimum": 0.0, - "type": "number" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ConflictResolution": { - "additionalProperties": false, - "description": "How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used? ", - "properties": { - "ConflictResolvingModel": { - "description": "How the auto-merging process should resolve conflicts between different profiles.", - "enum": [ - "RECENCY", - "SOURCE" - ], - "type": "string" - }, - "SourceName": { - "description": "The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConflictResolvingModel" - ], - "type": "object" - }, - "Consolidation": { - "additionalProperties": false, - "description": "A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.", - "properties": { - "MatchingAttributesList": { - "description": "A list of matching criteria.", - "items": { - "$ref": "#/definitions/MatchingAttributes" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "MatchingAttributesList" - ], - "type": "object" - }, - "DomainStats": { - "additionalProperties": false, - "description": "Usage-specific statistics about the domain.", - "properties": { - "MeteringProfileCount": { - "description": "The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.", - "type": "number" - }, - "ObjectCount": { - "description": "The total number of objects in domain.", - "type": "number" - }, - "ProfileCount": { - "description": "The total number of profiles currently in the domain.", - "type": "number" - }, - "TotalSize": { - "description": "The total size, in bytes, of all objects in the domain.", - "type": "number" - } - }, - "type": "object" - }, - "ExportingConfig": { - "additionalProperties": false, - "description": "Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.", - "properties": { - "S3Exporting": { - "$ref": "#/definitions/S3ExportingConfig" - } - }, - "type": "object" - }, - "JobSchedule": { - "additionalProperties": false, - "description": "The day and time when do you want to start the Identity Resolution Job every week.", - "properties": { - "DayOfTheWeek": { - "description": "The day when the Identity Resolution Job should run every week.", - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - }, - "Time": { - "description": "The time when the Identity Resolution Job should run every week.", - "maxLength": 5, - "minLength": 3, - "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - } - }, - "required": [ - "DayOfTheWeek", - "Time" - ], - "type": "object" - }, - "Matching": { - "additionalProperties": false, - "description": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.", - "properties": { - "AutoMerging": { - "$ref": "#/definitions/AutoMerging" - }, - "Enabled": { - "description": "The flag that enables the matching process of duplicate profiles.", - "type": "boolean" - }, - "ExportingConfig": { - "$ref": "#/definitions/ExportingConfig" - }, - "JobSchedule": { - "$ref": "#/definitions/JobSchedule" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "MatchingAttributes": { - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "MatchingRule": { - "additionalProperties": false, - "description": "Specifies how does the rule-based matching process should match profiles.", - "properties": { - "Rule": { - "$ref": "#/definitions/MatchingRuleAttributeList" - } - }, - "required": [ - "Rule" - ], - "type": "object" - }, - "MatchingRuleAttributeList": { - "description": "A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "RuleBasedMatching": { - "additionalProperties": false, - "description": "The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.", - "properties": { - "AttributeTypesSelector": { - "$ref": "#/definitions/AttributeTypesSelector" - }, - "ConflictResolution": { - "$ref": "#/definitions/ConflictResolution" - }, - "Enabled": { - "description": "The flag that enables the rule-based matching process of duplicate profiles.", - "type": "boolean" - }, - "ExportingConfig": { - "$ref": "#/definitions/ExportingConfig" - }, - "MatchingRules": { - "description": "Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.", - "items": { - "$ref": "#/definitions/MatchingRule" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "MaxAllowedRuleLevelForMatching": { - "description": "Indicates the maximum allowed rule level for matching.", - "maximum": 15, - "minimum": 1, - "type": "integer" - }, - "MaxAllowedRuleLevelForMerging": { - "description": "Indicates the maximum allowed rule level for merging.", - "maximum": 15, - "minimum": 1, - "type": "integer" - }, - "Status": { - "enum": [ - "PENDING", - "IN_PROGRESS", - "ACTIVE" - ], - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "S3ExportingConfig": { - "additionalProperties": false, - "description": "The S3 location where Identity Resolution Jobs write result files.", - "properties": { - "S3BucketName": { - "description": "The name of the S3 bucket where Identity Resolution Jobs write result files.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9.-]+$", - "type": "string" - }, - "S3KeyName": { - "description": "The S3 key name of the location where Identity Resolution Jobs write result files.", - "maxLength": 800, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "S3BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A domain defined for 3rd party data source in Profile Service", - "handlers": { - "create": { - "permissions": [ - "profile:CreateDomain", - "profile:TagResource" - ] - }, - "delete": { - "permissions": [ - "profile:DeleteDomain" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "profile:ListDomains" - ] - }, - "read": { - "permissions": [ - "profile:GetDomain" - ] - }, - "update": { - "permissions": [ - "profile:GetDomain", - "profile:UpdateDomain", - "profile:UntagResource", - "profile:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName" - ], - "properties": { - "CreatedAt": { - "description": "The time of this integration got created", - "type": "string" - }, - "DeadLetterQueueUrl": { - "description": "The URL of the SQS dead letter queue", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "DefaultEncryptionKey": { - "description": "The default encryption key", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "DefaultExpirationDays": { - "description": "The default number of days until the data within the domain expires.", - "maximum": 1098, - "minimum": 1, - "type": "integer" - }, - "DomainName": { - "description": "The unique name of the domain.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "LastUpdatedAt": { - "description": "The time of this integration got last updated at", - "type": "string" - }, - "Matching": { - "$ref": "#/definitions/Matching" - }, - "RuleBasedMatching": { - "$ref": "#/definitions/RuleBasedMatching" - }, - "Stats": { - "$ref": "#/definitions/DomainStats" - }, - "Tags": { - "description": "The tags (keys and values) associated with the domain", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/LastUpdatedAt", - "/properties/CreatedAt", - "/properties/RuleBasedMatching/Status", - "/properties/Stats" - ], - "required": [ - "DomainName", - "DefaultExpirationDays" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CustomerProfiles::Domain" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "definitions": { + "AttributeTypesSelector": { + "additionalProperties": false, + "description": "Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.", + "properties": { + "Address": { + "description": "The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "AttributeMatchingModel": { + "description": "Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.", + "enum": [ + "ONE_TO_ONE", + "MANY_TO_MANY" + ], + "type": "string" + }, + "EmailAddress": { + "description": "The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + }, + "PhoneNumber": { + "description": "The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AttributeMatchingModel" + ], + "type": "object" + }, + "AutoMerging": { + "additionalProperties": false, + "description": "Configuration information about the auto-merging process.", + "properties": { + "ConflictResolution": { + "$ref": "#/definitions/ConflictResolution" + }, + "Consolidation": { + "$ref": "#/definitions/Consolidation" + }, + "Enabled": { + "description": "The flag that enables the auto-merging of duplicate profiles.", + "type": "boolean" + }, + "MinAllowedConfidenceScoreForMerging": { + "description": "A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.", + "maximum": 1.0, + "minimum": 0.0, + "type": "number" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ConflictResolution": { + "additionalProperties": false, + "description": "How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used? ", + "properties": { + "ConflictResolvingModel": { + "description": "How the auto-merging process should resolve conflicts between different profiles.", + "enum": [ + "RECENCY", + "SOURCE" + ], + "type": "string" + }, + "SourceName": { + "description": "The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConflictResolvingModel" + ], + "type": "object" + }, + "Consolidation": { + "additionalProperties": false, + "description": "A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.", + "properties": { + "MatchingAttributesList": { + "description": "A list of matching criteria.", + "items": { + "$ref": "#/definitions/MatchingAttributes" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "MatchingAttributesList" + ], + "type": "object" + }, + "DomainStats": { + "additionalProperties": false, + "description": "Usage-specific statistics about the domain.", + "properties": { + "MeteringProfileCount": { + "description": "The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.", + "type": "number" + }, + "ObjectCount": { + "description": "The total number of objects in domain.", + "type": "number" + }, + "ProfileCount": { + "description": "The total number of profiles currently in the domain.", + "type": "number" + }, + "TotalSize": { + "description": "The total size, in bytes, of all objects in the domain.", + "type": "number" + } + }, + "type": "object" + }, + "ExportingConfig": { + "additionalProperties": false, + "description": "Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.", + "properties": { + "S3Exporting": { + "$ref": "#/definitions/S3ExportingConfig" + } + }, + "type": "object" + }, + "JobSchedule": { + "additionalProperties": false, + "description": "The day and time when do you want to start the Identity Resolution Job every week.", + "properties": { + "DayOfTheWeek": { + "description": "The day when the Identity Resolution Job should run every week.", + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + }, + "Time": { + "description": "The time when the Identity Resolution Job should run every week.", + "maxLength": 5, + "minLength": 3, + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + } + }, + "required": [ + "DayOfTheWeek", + "Time" + ], + "type": "object" + }, + "Matching": { + "additionalProperties": false, + "description": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.", + "properties": { + "AutoMerging": { + "$ref": "#/definitions/AutoMerging" + }, + "Enabled": { + "description": "The flag that enables the matching process of duplicate profiles.", + "type": "boolean" + }, + "ExportingConfig": { + "$ref": "#/definitions/ExportingConfig" + }, + "JobSchedule": { + "$ref": "#/definitions/JobSchedule" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "MatchingAttributes": { + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "MatchingRule": { + "additionalProperties": false, + "description": "Specifies how does the rule-based matching process should match profiles.", + "properties": { + "Rule": { + "$ref": "#/definitions/MatchingRuleAttributeList" + } + }, + "required": [ + "Rule" + ], + "type": "object" + }, + "MatchingRuleAttributeList": { + "description": "A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "RuleBasedMatching": { + "additionalProperties": false, + "description": "The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.", + "properties": { + "AttributeTypesSelector": { + "$ref": "#/definitions/AttributeTypesSelector" + }, + "ConflictResolution": { + "$ref": "#/definitions/ConflictResolution" + }, + "Enabled": { + "description": "The flag that enables the rule-based matching process of duplicate profiles.", + "type": "boolean" + }, + "ExportingConfig": { + "$ref": "#/definitions/ExportingConfig" + }, + "MatchingRules": { + "description": "Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.", + "items": { + "$ref": "#/definitions/MatchingRule" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "MaxAllowedRuleLevelForMatching": { + "description": "Indicates the maximum allowed rule level for matching.", + "maximum": 15, + "minimum": 1, + "type": "integer" + }, + "MaxAllowedRuleLevelForMerging": { + "description": "Indicates the maximum allowed rule level for merging.", + "maximum": 15, + "minimum": 1, + "type": "integer" + }, + "Status": { + "enum": [ + "PENDING", + "IN_PROGRESS", + "ACTIVE" + ], + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "S3ExportingConfig": { + "additionalProperties": false, + "description": "The S3 location where Identity Resolution Jobs write result files.", + "properties": { + "S3BucketName": { + "description": "The name of the S3 bucket where Identity Resolution Jobs write result files.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9.-]+$", + "type": "string" + }, + "S3KeyName": { + "description": "The S3 key name of the location where Identity Resolution Jobs write result files.", + "maxLength": 800, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "S3BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A domain defined for 3rd party data source in Profile Service", + "handlers": { + "create": { + "permissions": [ + "profile:CreateDomain", + "profile:TagResource" + ] + }, + "delete": { + "permissions": [ + "profile:DeleteDomain" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "profile:ListDomains" + ] + }, + "read": { + "permissions": [ + "profile:GetDomain" + ] + }, + "update": { + "permissions": [ + "profile:GetDomain", + "profile:UpdateDomain", + "profile:UntagResource", + "profile:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName" + ], + "properties": { + "CreatedAt": { + "description": "The time of this integration got created", + "type": "string" + }, + "DeadLetterQueueUrl": { + "description": "The URL of the SQS dead letter queue", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "DefaultEncryptionKey": { + "description": "The default encryption key", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "DefaultExpirationDays": { + "description": "The default number of days until the data within the domain expires.", + "maximum": 1098, + "minimum": 1, + "type": "integer" + }, + "DomainName": { + "description": "The unique name of the domain.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "LastUpdatedAt": { + "description": "The time of this integration got last updated at", + "type": "string" + }, + "Matching": { + "$ref": "#/definitions/Matching" + }, + "RuleBasedMatching": { + "$ref": "#/definitions/RuleBasedMatching" + }, + "Stats": { + "$ref": "#/definitions/DomainStats" + }, + "Tags": { + "description": "The tags (keys and values) associated with the domain", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/LastUpdatedAt", + "/properties/CreatedAt", + "/properties/RuleBasedMatching/Status", + "/properties/Stats" + ], + "required": [ + "DomainName", + "DefaultExpirationDays" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "profile:TagResource", + "profile:UntagResource", + "profile:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CustomerProfiles::Domain" +} diff --git a/schema/aws-customerprofiles-eventstream.json b/schema/aws-customerprofiles-eventstream.json index 1fc1a1b..9b3203c 100644 --- a/schema/aws-customerprofiles-eventstream.json +++ b/schema/aws-customerprofiles-eventstream.json @@ -1,183 +1,188 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/EventStreamName", - "/properties/Uri" - ], - "definitions": { - "Status": { - "description": "The status of enabling the Kinesis stream as a destination for export.", - "enum": [ - "HEALTHY", - "UNHEALTHY" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Uri": { - "description": "The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "description": "An Event Stream resource of Amazon Connect Customer Profiles", - "handlers": { - "create": { - "permissions": [ - "profile:CreateEventStream", - "iam:PutRolePolicy", - "kinesis:DescribeStreamSummary", - "profile:TagResource" - ] - }, - "delete": { - "permissions": [ - "profile:DeleteEventStream", - "iam:DeleteRolePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "profile:ListEventStreams" - ] - }, - "read": { - "permissions": [ - "profile:GetEventStream", - "kinesis:DescribeStreamSummary" - ] - }, - "update": { - "permissions": [ - "kinesis:DescribeStreamSummary", - "profile:GetEventStream", - "profile:UntagResource", - "profile:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName", - "/properties/EventStreamName" - ], - "properties": { - "CreatedAt": { - "description": "The timestamp of when the export was created.", - "type": "string" - }, - "DestinationDetails": { - "additionalProperties": false, - "description": "Details regarding the Kinesis stream.", - "properties": { - "Status": { - "$ref": "#/definitions/Status" - }, - "Uri": { - "$ref": "#/definitions/Uri" - } - }, - "required": [ - "Uri", - "Status" - ], - "type": "object" - }, - "DomainName": { - "description": "The unique name of the domain.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "EventStreamArn": { - "description": "A unique identifier for the event stream.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "EventStreamName": { - "description": "The name of the event stream.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "State": { - "description": "The operational state of destination stream for export.", - "enum": [ - "RUNNING", - "STOPPED" - ], - "type": "string" - }, - "Tags": { - "description": "The tags used to organize, track, or control access for this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Uri": { - "$ref": "#/definitions/Uri" - } - }, - "readOnlyProperties": [ - "/properties/DestinationDetails", - "/properties/CreatedAt", - "/properties/State", - "/properties/EventStreamArn" - ], - "required": [ - "DomainName", - "EventStreamName", - "Uri" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CustomerProfiles::EventStream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/EventStreamName", + "/properties/Uri" + ], + "definitions": { + "Status": { + "description": "The status of enabling the Kinesis stream as a destination for export.", + "enum": [ + "HEALTHY", + "UNHEALTHY" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Uri": { + "description": "The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "description": "An Event Stream resource of Amazon Connect Customer Profiles", + "handlers": { + "create": { + "permissions": [ + "profile:CreateEventStream", + "iam:PutRolePolicy", + "kinesis:DescribeStreamSummary", + "profile:TagResource" + ] + }, + "delete": { + "permissions": [ + "profile:DeleteEventStream", + "iam:DeleteRolePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "profile:ListEventStreams" + ] + }, + "read": { + "permissions": [ + "profile:GetEventStream", + "kinesis:DescribeStreamSummary" + ] + }, + "update": { + "permissions": [ + "kinesis:DescribeStreamSummary", + "profile:GetEventStream", + "profile:UntagResource", + "profile:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName", + "/properties/EventStreamName" + ], + "properties": { + "CreatedAt": { + "description": "The timestamp of when the export was created.", + "type": "string" + }, + "DestinationDetails": { + "additionalProperties": false, + "description": "Details regarding the Kinesis stream.", + "properties": { + "Status": { + "$ref": "#/definitions/Status" + }, + "Uri": { + "$ref": "#/definitions/Uri" + } + }, + "required": [ + "Uri", + "Status" + ], + "type": "object" + }, + "DomainName": { + "description": "The unique name of the domain.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "EventStreamArn": { + "description": "A unique identifier for the event stream.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "EventStreamName": { + "description": "The name of the event stream.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "State": { + "description": "The operational state of destination stream for export.", + "enum": [ + "RUNNING", + "STOPPED" + ], + "type": "string" + }, + "Tags": { + "description": "The tags used to organize, track, or control access for this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Uri": { + "$ref": "#/definitions/Uri" + } + }, + "readOnlyProperties": [ + "/properties/DestinationDetails", + "/properties/CreatedAt", + "/properties/State", + "/properties/EventStreamArn" + ], + "required": [ + "DomainName", + "EventStreamName", + "Uri" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "profile:TagResource", + "profile:UntagResource", + "profile:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CustomerProfiles::EventStream" +} diff --git a/schema/aws-customerprofiles-integration.json b/schema/aws-customerprofiles-integration.json index 8010b08..b3a5e22 100644 --- a/schema/aws-customerprofiles-integration.json +++ b/schema/aws-customerprofiles-integration.json @@ -1,702 +1,707 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/Uri" - ], - "definitions": { - "ConnectorOperator": { - "additionalProperties": false, - "properties": { - "Marketo": { - "$ref": "#/definitions/MarketoConnectorOperator" - }, - "S3": { - "$ref": "#/definitions/S3ConnectorOperator" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceConnectorOperator" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowConnectorOperator" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskConnectorOperator" - } - }, - "type": "object" - }, - "ConnectorType": { - "enum": [ - "Salesforce", - "Marketo", - "ServiceNow", - "Zendesk", - "S3" - ], - "type": "string" - }, - "Date": { - "type": "number" - }, - "DestinationField": { - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "FlowDefinition": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 2048, - "pattern": "[\\w!@#\\-.?,\\s]*", - "type": "string" - }, - "FlowName": { - "maxLength": 256, - "pattern": "[a-zA-Z0-9][\\w!@#.-]+", - "type": "string" - }, - "KmsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws:kms:.*:[0-9]+:.*", - "type": "string" - }, - "SourceFlowConfig": { - "$ref": "#/definitions/SourceFlowConfig" - }, - "Tasks": { - "items": { - "$ref": "#/definitions/Task" - }, - "type": "array" - }, - "TriggerConfig": { - "$ref": "#/definitions/TriggerConfig" - } - }, - "required": [ - "FlowName", - "KmsArn", - "Tasks", - "TriggerConfig", - "SourceFlowConfig" - ], - "type": "object" - }, - "IncrementalPullConfig": { - "additionalProperties": false, - "properties": { - "DatetimeTypeFieldName": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "MarketoConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "BETWEEN", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "MarketoSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "Object": { - "additionalProperties": false, - "maxLength": 512, - "pattern": "\\S+", - "type": "string" - }, - "ObjectTypeMapping": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Operator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "CONTAINS", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "OperatorPropertiesKeys": { - "enum": [ - "VALUE", - "VALUES", - "DATA_TYPE", - "UPPER_BOUND", - "LOWER_BOUND", - "SOURCE_DATA_TYPE", - "DESTINATION_DATA_TYPE", - "VALIDATION_ACTION", - "MASK_VALUE", - "MASK_LENGTH", - "TRUNCATE_LENGTH", - "MATH_OPERATION_FIELDS_ORDER", - "CONCAT_FORMAT", - "SUBFIELD_CATEGORY_MAP" - ], - "type": "string" - }, - "S3ConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "S3SourceProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "\\S+", - "type": "string" - }, - "BucketPrefix": { - "maxLength": 512, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "SalesforceConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "CONTAINS", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "SalesforceSourceProperties": { - "additionalProperties": false, - "properties": { - "EnableDynamicFieldUpdate": { - "type": "boolean" - }, - "IncludeDeletedRecords": { - "type": "boolean" - }, - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "ScheduledTriggerProperties": { - "additionalProperties": false, - "properties": { - "DataPullMode": { - "enum": [ - "Incremental", - "Complete" - ], - "type": "string" - }, - "FirstExecutionFrom": { - "$ref": "#/definitions/Date" - }, - "ScheduleEndTime": { - "$ref": "#/definitions/Date" - }, - "ScheduleExpression": { - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "ScheduleOffset": { - "maximum": 36000, - "minimum": 0, - "type": "integer" - }, - "ScheduleStartTime": { - "$ref": "#/definitions/Date" - }, - "Timezone": { - "maxLength": 256, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "ServiceNowConnectorOperator": { - "enum": [ - "PROJECTION", - "LESS_THAN", - "GREATER_THAN", - "CONTAINS", - "BETWEEN", - "LESS_THAN_OR_EQUAL_TO", - "GREATER_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "ServiceNowSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "SourceConnectorProperties": { - "additionalProperties": false, - "properties": { - "Marketo": { - "$ref": "#/definitions/MarketoSourceProperties" - }, - "S3": { - "$ref": "#/definitions/S3SourceProperties" - }, - "Salesforce": { - "$ref": "#/definitions/SalesforceSourceProperties" - }, - "ServiceNow": { - "$ref": "#/definitions/ServiceNowSourceProperties" - }, - "Zendesk": { - "$ref": "#/definitions/ZendeskSourceProperties" - } - }, - "type": "object" - }, - "SourceFlowConfig": { - "additionalProperties": false, - "properties": { - "ConnectorProfileName": { - "maxLength": 256, - "pattern": "[\\w/!@#+=.-]+", - "type": "string" - }, - "ConnectorType": { - "$ref": "#/definitions/ConnectorType" - }, - "IncrementalPullConfig": { - "$ref": "#/definitions/IncrementalPullConfig" - }, - "SourceConnectorProperties": { - "$ref": "#/definitions/SourceConnectorProperties" - } - }, - "required": [ - "ConnectorType", - "SourceConnectorProperties" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Task": { - "additionalProperties": false, - "properties": { - "ConnectorOperator": { - "$ref": "#/definitions/ConnectorOperator" - }, - "DestinationField": { - "$ref": "#/definitions/DestinationField" - }, - "SourceFields": { - "items": { - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "type": "array" - }, - "TaskProperties": { - "items": { - "$ref": "#/definitions/TaskPropertiesMap" - }, - "type": "array" - }, - "TaskType": { - "$ref": "#/definitions/TaskType" - } - }, - "required": [ - "SourceFields", - "TaskType" - ], - "type": "object" - }, - "TaskPropertiesMap": { - "additionalProperties": false, - "properties": { - "OperatorPropertyKey": { - "$ref": "#/definitions/OperatorPropertiesKeys" - }, - "Property": { - "maxLength": 2048, - "pattern": ".+", - "type": "string" - } - }, - "required": [ - "OperatorPropertyKey", - "Property" - ], - "type": "object" - }, - "TaskType": { - "enum": [ - "Arithmetic", - "Filter", - "Map", - "Mask", - "Merge", - "Truncate", - "Validate" - ], - "type": "string" - }, - "TriggerConfig": { - "additionalProperties": false, - "properties": { - "TriggerProperties": { - "$ref": "#/definitions/TriggerProperties" - }, - "TriggerType": { - "$ref": "#/definitions/TriggerType" - } - }, - "required": [ - "TriggerType" - ], - "type": "object" - }, - "TriggerProperties": { - "additionalProperties": false, - "properties": { - "Scheduled": { - "$ref": "#/definitions/ScheduledTriggerProperties" - } - }, - "type": "object" - }, - "TriggerType": { - "enum": [ - "Scheduled", - "Event", - "OnDemand" - ], - "type": "string" - }, - "ZendeskConnectorOperator": { - "enum": [ - "PROJECTION", - "GREATER_THAN", - "ADDITION", - "MULTIPLICATION", - "DIVISION", - "SUBTRACTION", - "MASK_ALL", - "MASK_FIRST_N", - "MASK_LAST_N", - "VALIDATE_NON_NULL", - "VALIDATE_NON_ZERO", - "VALIDATE_NON_NEGATIVE", - "VALIDATE_NUMERIC", - "NO_OP" - ], - "type": "string" - }, - "ZendeskSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "$ref": "#/definitions/Object" - } - }, - "required": [ - "Object" - ], - "type": "object" - } - }, - "description": "The resource schema for creating an Amazon Connect Customer Profiles Integration.", - "handlers": { - "create": { - "permissions": [ - "profile:GetIntegration", - "profile:PutIntegration", - "appflow:CreateFlow", - "app-integrations:CreateEventIntegrationAssociation", - "app-integrations:GetEventIntegration", - "events:ListTargetsByRule", - "events:PutRule", - "events:PutTargets", - "events:PutEvents", - "profile:TagResource" - ] - }, - "delete": { - "permissions": [ - "profile:DeleteIntegration", - "appflow:DeleteFlow", - "app-integrations:ListEventIntegrationAssociations", - "app-integrations:DeleteEventIntegrationAssociation", - "events:RemoveTargets", - "events:ListTargetsByRule", - "events:DeleteRule" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "profile:ListIntegrations" - ] - }, - "read": { - "permissions": [ - "profile:GetIntegration" - ] - }, - "update": { - "permissions": [ - "profile:PutIntegration", - "profile:GetIntegration", - "appflow:CreateFlow", - "app-integrations:GetEventIntegration", - "app-integrations:CreateEventIntegrationAssociation", - "app-integrations:ListEventIntegrationAssociations", - "app-integrations:DeleteEventIntegrationAssociation", - "events:ListTargetsByRule", - "events:RemoveTargets", - "events:DeleteRule", - "events:PutRule", - "events:PutTargets", - "events:PutEvents", - "profile:UntagResource", - "profile:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName", - "/properties/Uri" - ], - "properties": { - "CreatedAt": { - "description": "The time of this integration got created", - "type": "string" - }, - "DomainName": { - "description": "The unique name of the domain.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "FlowDefinition": { - "$ref": "#/definitions/FlowDefinition" - }, - "LastUpdatedAt": { - "description": "The time of this integration got last updated at", - "type": "string" - }, - "ObjectTypeName": { - "description": "The name of the ObjectType defined for the 3rd party data in Profile Service", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", - "type": "string" - }, - "ObjectTypeNames": { - "description": "The mapping between 3rd party event types and ObjectType names", - "items": { - "$ref": "#/definitions/ObjectTypeMapping" - }, - "type": "array" - }, - "Tags": { - "description": "The tags (keys and values) associated with the integration", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "Uri": { - "description": "The URI of the S3 bucket or any other type of data source.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LastUpdatedAt", - "/properties/CreatedAt" - ], - "required": [ - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CustomerProfiles::Integration", - "writeOnlyProperties": [ - "/properties/FlowDefinition" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/Uri" + ], + "definitions": { + "ConnectorOperator": { + "additionalProperties": false, + "properties": { + "Marketo": { + "$ref": "#/definitions/MarketoConnectorOperator" + }, + "S3": { + "$ref": "#/definitions/S3ConnectorOperator" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceConnectorOperator" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowConnectorOperator" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskConnectorOperator" + } + }, + "type": "object" + }, + "ConnectorType": { + "enum": [ + "Salesforce", + "Marketo", + "ServiceNow", + "Zendesk", + "S3" + ], + "type": "string" + }, + "Date": { + "type": "number" + }, + "DestinationField": { + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "FlowDefinition": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 2048, + "pattern": "[\\w!@#\\-.?,\\s]*", + "type": "string" + }, + "FlowName": { + "maxLength": 256, + "pattern": "[a-zA-Z0-9][\\w!@#.-]+", + "type": "string" + }, + "KmsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws:kms:.*:[0-9]+:.*", + "type": "string" + }, + "SourceFlowConfig": { + "$ref": "#/definitions/SourceFlowConfig" + }, + "Tasks": { + "items": { + "$ref": "#/definitions/Task" + }, + "type": "array" + }, + "TriggerConfig": { + "$ref": "#/definitions/TriggerConfig" + } + }, + "required": [ + "FlowName", + "KmsArn", + "Tasks", + "TriggerConfig", + "SourceFlowConfig" + ], + "type": "object" + }, + "IncrementalPullConfig": { + "additionalProperties": false, + "properties": { + "DatetimeTypeFieldName": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "MarketoConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "BETWEEN", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "MarketoSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "Object": { + "additionalProperties": false, + "maxLength": 512, + "pattern": "\\S+", + "type": "string" + }, + "ObjectTypeMapping": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Operator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "CONTAINS", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "OperatorPropertiesKeys": { + "enum": [ + "VALUE", + "VALUES", + "DATA_TYPE", + "UPPER_BOUND", + "LOWER_BOUND", + "SOURCE_DATA_TYPE", + "DESTINATION_DATA_TYPE", + "VALIDATION_ACTION", + "MASK_VALUE", + "MASK_LENGTH", + "TRUNCATE_LENGTH", + "MATH_OPERATION_FIELDS_ORDER", + "CONCAT_FORMAT", + "SUBFIELD_CATEGORY_MAP" + ], + "type": "string" + }, + "S3ConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "S3SourceProperties": { + "additionalProperties": false, + "properties": { + "BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "\\S+", + "type": "string" + }, + "BucketPrefix": { + "maxLength": 512, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "SalesforceConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "CONTAINS", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "SalesforceSourceProperties": { + "additionalProperties": false, + "properties": { + "EnableDynamicFieldUpdate": { + "type": "boolean" + }, + "IncludeDeletedRecords": { + "type": "boolean" + }, + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "ScheduledTriggerProperties": { + "additionalProperties": false, + "properties": { + "DataPullMode": { + "enum": [ + "Incremental", + "Complete" + ], + "type": "string" + }, + "FirstExecutionFrom": { + "$ref": "#/definitions/Date" + }, + "ScheduleEndTime": { + "$ref": "#/definitions/Date" + }, + "ScheduleExpression": { + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "ScheduleOffset": { + "maximum": 36000, + "minimum": 0, + "type": "integer" + }, + "ScheduleStartTime": { + "$ref": "#/definitions/Date" + }, + "Timezone": { + "maxLength": 256, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "ScheduleExpression" + ], + "type": "object" + }, + "ServiceNowConnectorOperator": { + "enum": [ + "PROJECTION", + "LESS_THAN", + "GREATER_THAN", + "CONTAINS", + "BETWEEN", + "LESS_THAN_OR_EQUAL_TO", + "GREATER_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "ServiceNowSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + }, + "SourceConnectorProperties": { + "additionalProperties": false, + "properties": { + "Marketo": { + "$ref": "#/definitions/MarketoSourceProperties" + }, + "S3": { + "$ref": "#/definitions/S3SourceProperties" + }, + "Salesforce": { + "$ref": "#/definitions/SalesforceSourceProperties" + }, + "ServiceNow": { + "$ref": "#/definitions/ServiceNowSourceProperties" + }, + "Zendesk": { + "$ref": "#/definitions/ZendeskSourceProperties" + } + }, + "type": "object" + }, + "SourceFlowConfig": { + "additionalProperties": false, + "properties": { + "ConnectorProfileName": { + "maxLength": 256, + "pattern": "[\\w/!@#+=.-]+", + "type": "string" + }, + "ConnectorType": { + "$ref": "#/definitions/ConnectorType" + }, + "IncrementalPullConfig": { + "$ref": "#/definitions/IncrementalPullConfig" + }, + "SourceConnectorProperties": { + "$ref": "#/definitions/SourceConnectorProperties" + } + }, + "required": [ + "ConnectorType", + "SourceConnectorProperties" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Task": { + "additionalProperties": false, + "properties": { + "ConnectorOperator": { + "$ref": "#/definitions/ConnectorOperator" + }, + "DestinationField": { + "$ref": "#/definitions/DestinationField" + }, + "SourceFields": { + "items": { + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "type": "array" + }, + "TaskProperties": { + "items": { + "$ref": "#/definitions/TaskPropertiesMap" + }, + "type": "array" + }, + "TaskType": { + "$ref": "#/definitions/TaskType" + } + }, + "required": [ + "SourceFields", + "TaskType" + ], + "type": "object" + }, + "TaskPropertiesMap": { + "additionalProperties": false, + "properties": { + "OperatorPropertyKey": { + "$ref": "#/definitions/OperatorPropertiesKeys" + }, + "Property": { + "maxLength": 2048, + "pattern": ".+", + "type": "string" + } + }, + "required": [ + "OperatorPropertyKey", + "Property" + ], + "type": "object" + }, + "TaskType": { + "enum": [ + "Arithmetic", + "Filter", + "Map", + "Mask", + "Merge", + "Truncate", + "Validate" + ], + "type": "string" + }, + "TriggerConfig": { + "additionalProperties": false, + "properties": { + "TriggerProperties": { + "$ref": "#/definitions/TriggerProperties" + }, + "TriggerType": { + "$ref": "#/definitions/TriggerType" + } + }, + "required": [ + "TriggerType" + ], + "type": "object" + }, + "TriggerProperties": { + "additionalProperties": false, + "properties": { + "Scheduled": { + "$ref": "#/definitions/ScheduledTriggerProperties" + } + }, + "type": "object" + }, + "TriggerType": { + "enum": [ + "Scheduled", + "Event", + "OnDemand" + ], + "type": "string" + }, + "ZendeskConnectorOperator": { + "enum": [ + "PROJECTION", + "GREATER_THAN", + "ADDITION", + "MULTIPLICATION", + "DIVISION", + "SUBTRACTION", + "MASK_ALL", + "MASK_FIRST_N", + "MASK_LAST_N", + "VALIDATE_NON_NULL", + "VALIDATE_NON_ZERO", + "VALIDATE_NON_NEGATIVE", + "VALIDATE_NUMERIC", + "NO_OP" + ], + "type": "string" + }, + "ZendeskSourceProperties": { + "additionalProperties": false, + "properties": { + "Object": { + "$ref": "#/definitions/Object" + } + }, + "required": [ + "Object" + ], + "type": "object" + } + }, + "description": "The resource schema for creating an Amazon Connect Customer Profiles Integration.", + "handlers": { + "create": { + "permissions": [ + "profile:GetIntegration", + "profile:PutIntegration", + "appflow:CreateFlow", + "app-integrations:CreateEventIntegrationAssociation", + "app-integrations:GetEventIntegration", + "events:ListTargetsByRule", + "events:PutRule", + "events:PutTargets", + "events:PutEvents", + "profile:TagResource" + ] + }, + "delete": { + "permissions": [ + "profile:DeleteIntegration", + "appflow:DeleteFlow", + "app-integrations:ListEventIntegrationAssociations", + "app-integrations:DeleteEventIntegrationAssociation", + "events:RemoveTargets", + "events:ListTargetsByRule", + "events:DeleteRule" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "profile:ListIntegrations" + ] + }, + "read": { + "permissions": [ + "profile:GetIntegration" + ] + }, + "update": { + "permissions": [ + "profile:PutIntegration", + "profile:GetIntegration", + "appflow:CreateFlow", + "app-integrations:GetEventIntegration", + "app-integrations:CreateEventIntegrationAssociation", + "app-integrations:ListEventIntegrationAssociations", + "app-integrations:DeleteEventIntegrationAssociation", + "events:ListTargetsByRule", + "events:RemoveTargets", + "events:DeleteRule", + "events:PutRule", + "events:PutTargets", + "events:PutEvents", + "profile:UntagResource", + "profile:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName", + "/properties/Uri" + ], + "properties": { + "CreatedAt": { + "description": "The time of this integration got created", + "type": "string" + }, + "DomainName": { + "description": "The unique name of the domain.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "FlowDefinition": { + "$ref": "#/definitions/FlowDefinition" + }, + "LastUpdatedAt": { + "description": "The time of this integration got last updated at", + "type": "string" + }, + "ObjectTypeName": { + "description": "The name of the ObjectType defined for the 3rd party data in Profile Service", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", + "type": "string" + }, + "ObjectTypeNames": { + "description": "The mapping between 3rd party event types and ObjectType names", + "items": { + "$ref": "#/definitions/ObjectTypeMapping" + }, + "type": "array" + }, + "Tags": { + "description": "The tags (keys and values) associated with the integration", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "Uri": { + "description": "The URI of the S3 bucket or any other type of data source.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LastUpdatedAt", + "/properties/CreatedAt" + ], + "required": [ + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "profile:TagResource", + "profile:UntagResource", + "profile:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CustomerProfiles::Integration", + "writeOnlyProperties": [ + "/properties/FlowDefinition" + ] +} diff --git a/schema/aws-customerprofiles-objecttype.json b/schema/aws-customerprofiles-objecttype.json index 0776d78..b7f9574 100644 --- a/schema/aws-customerprofiles-objecttype.json +++ b/schema/aws-customerprofiles-objecttype.json @@ -1,277 +1,282 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName", - "/properties/ObjectTypeName" - ], - "definitions": { - "FieldMap": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ObjectTypeField": { - "$ref": "#/definitions/ObjectTypeField" - } - }, - "type": "object" - }, - "KeyMap": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ObjectTypeKeyList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ObjectTypeKey" - }, - "type": "array" - } - }, - "type": "object" - }, - "ObjectTypeField": { - "additionalProperties": false, - "description": "Represents a field in a ProfileObjectType.", - "properties": { - "ContentType": { - "description": "The content type of the field. Used for determining equality when searching.", - "enum": [ - "STRING", - "NUMBER", - "PHONE_NUMBER", - "EMAIL_ADDRESS", - "NAME" - ], - "type": "string" - }, - "Source": { - "description": "A field of a ProfileObject. For example: _source.FirstName, where \"_source\" is a ProfileObjectType of a Zendesk user and \"FirstName\" is a field in that ObjectType.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Target": { - "description": "The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ObjectTypeKey": { - "additionalProperties": false, - "description": "An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.", - "properties": { - "FieldNames": { - "description": "The reference for the key name of the fields map. ", - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "type": "array" - }, - "StandardIdentifiers": { - "description": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.", - "items": { - "enum": [ - "PROFILE", - "UNIQUE", - "SECONDARY", - "LOOKUP_ONLY", - "NEW_ONLY", - "ASSET", - "CASE", - "ORDER" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An ObjectType resource of Amazon Connect Customer Profiles", - "handlers": { - "create": { - "permissions": [ - "profile:GetProfileObjectType", - "profile:PutProfileObjectType", - "profile:TagResource" - ] - }, - "delete": { - "permissions": [ - "profile:DeleteProfileObjectType" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainName": { - "$ref": "resource-schema.json#/properties/DomainName" - } - }, - "required": [ - "DomainName" - ] - }, - "permissions": [ - "profile:ListProfileObjectTypes" - ] - }, - "read": { - "permissions": [ - "profile:GetProfileObjectType" - ] - }, - "update": { - "permissions": [ - "profile:GetProfileObjectType", - "profile:PutProfileObjectType", - "profile:UntagResource", - "profile:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainName", - "/properties/ObjectTypeName" - ], - "properties": { - "AllowProfileCreation": { - "description": "Indicates whether a profile should be created when data is received.", - "type": "boolean" - }, - "CreatedAt": { - "description": "The time of this integration got created.", - "type": "string" - }, - "Description": { - "description": "Description of the profile object type.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "DomainName": { - "description": "The unique name of the domain.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "EncryptionKey": { - "description": "The default encryption key", - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "ExpirationDays": { - "description": "The default number of days until the data within the domain expires.", - "maximum": 1098, - "minimum": 1, - "type": "integer" - }, - "Fields": { - "description": "A list of the name and ObjectType field.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FieldMap" - }, - "type": "array" - }, - "Keys": { - "description": "A list of unique keys that can be used to map data to the profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KeyMap" - }, - "type": "array" - }, - "LastUpdatedAt": { - "description": "The time of this integration got last updated at.", - "type": "string" - }, - "ObjectTypeName": { - "description": "The name of the profile object type.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", - "type": "string" - }, - "SourceLastUpdatedTimestampFormat": { - "description": "The format of your sourceLastUpdatedTimestamp that was previously set up.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "The tags (keys and values) associated with the integration.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "TemplateId": { - "description": "A unique identifier for the object template.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LastUpdatedAt", - "/properties/CreatedAt" - ], - "required": [ - "DomainName", - "ObjectTypeName", - "Description" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::CustomerProfiles::ObjectType" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/ObjectTypeName" + ], + "definitions": { + "FieldMap": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ObjectTypeField": { + "$ref": "#/definitions/ObjectTypeField" + } + }, + "type": "object" + }, + "KeyMap": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ObjectTypeKeyList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ObjectTypeKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "ObjectTypeField": { + "additionalProperties": false, + "description": "Represents a field in a ProfileObjectType.", + "properties": { + "ContentType": { + "description": "The content type of the field. Used for determining equality when searching.", + "enum": [ + "STRING", + "NUMBER", + "PHONE_NUMBER", + "EMAIL_ADDRESS", + "NAME" + ], + "type": "string" + }, + "Source": { + "description": "A field of a ProfileObject. For example: _source.FirstName, where \"_source\" is a ProfileObjectType of a Zendesk user and \"FirstName\" is a field in that ObjectType.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Target": { + "description": "The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ObjectTypeKey": { + "additionalProperties": false, + "description": "An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.", + "properties": { + "FieldNames": { + "description": "The reference for the key name of the fields map. ", + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "type": "array" + }, + "StandardIdentifiers": { + "description": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.", + "items": { + "enum": [ + "PROFILE", + "UNIQUE", + "SECONDARY", + "LOOKUP_ONLY", + "NEW_ONLY", + "ASSET", + "CASE", + "ORDER" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An ObjectType resource of Amazon Connect Customer Profiles", + "handlers": { + "create": { + "permissions": [ + "profile:GetProfileObjectType", + "profile:PutProfileObjectType", + "profile:TagResource" + ] + }, + "delete": { + "permissions": [ + "profile:DeleteProfileObjectType" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "profile:ListProfileObjectTypes" + ] + }, + "read": { + "permissions": [ + "profile:GetProfileObjectType" + ] + }, + "update": { + "permissions": [ + "profile:GetProfileObjectType", + "profile:PutProfileObjectType", + "profile:UntagResource", + "profile:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainName", + "/properties/ObjectTypeName" + ], + "properties": { + "AllowProfileCreation": { + "description": "Indicates whether a profile should be created when data is received.", + "type": "boolean" + }, + "CreatedAt": { + "description": "The time of this integration got created.", + "type": "string" + }, + "Description": { + "description": "Description of the profile object type.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "DomainName": { + "description": "The unique name of the domain.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "EncryptionKey": { + "description": "The default encryption key", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ExpirationDays": { + "description": "The default number of days until the data within the domain expires.", + "maximum": 1098, + "minimum": 1, + "type": "integer" + }, + "Fields": { + "description": "A list of the name and ObjectType field.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FieldMap" + }, + "type": "array" + }, + "Keys": { + "description": "A list of unique keys that can be used to map data to the profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KeyMap" + }, + "type": "array" + }, + "LastUpdatedAt": { + "description": "The time of this integration got last updated at.", + "type": "string" + }, + "ObjectTypeName": { + "description": "The name of the profile object type.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$", + "type": "string" + }, + "SourceLastUpdatedTimestampFormat": { + "description": "The format of your sourceLastUpdatedTimestamp that was previously set up.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "The tags (keys and values) associated with the integration.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "TemplateId": { + "description": "A unique identifier for the object template.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LastUpdatedAt", + "/properties/CreatedAt" + ], + "required": [ + "DomainName", + "ObjectTypeName", + "Description" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "profile:TagResource", + "profile:UntagResource", + "profile:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CustomerProfiles::ObjectType" +} diff --git a/schema/aws-databrew-dataset.json b/schema/aws-databrew-dataset.json index 3244a94..ccb8300 100644 --- a/schema/aws-databrew-dataset.json +++ b/schema/aws-databrew-dataset.json @@ -1,467 +1,467 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "CsvOptions": { - "additionalProperties": false, - "description": "Csv options", - "properties": { - "Delimiter": { - "maxLength": 1, - "minLength": 1, - "type": "string" - }, - "HeaderRow": { - "type": "boolean" - } - }, - "type": "object" - }, - "DataCatalogInputDefinition": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "description": "Catalog id", - "type": "string" - }, - "DatabaseName": { - "description": "Database name", - "type": "string" - }, - "TableName": { - "description": "Table name", - "type": "string" - }, - "TempDirectory": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "DatabaseInputDefinition": { - "additionalProperties": false, - "properties": { - "DatabaseTableName": { - "description": "Database table name", - "type": "string" - }, - "GlueConnectionName": { - "description": "Glue connection name", - "type": "string" - }, - "QueryString": { - "description": "Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.", - "type": "string" - }, - "TempDirectory": { - "$ref": "#/definitions/S3Location" - } - }, - "required": [ - "GlueConnectionName" - ], - "type": "object" - }, - "DatasetParameter": { - "additionalProperties": false, - "properties": { - "CreateColumn": { - "description": "Add the value of this parameter as a column in a dataset.", - "type": "boolean" - }, - "DatetimeOptions": { - "$ref": "#/definitions/DatetimeOptions" - }, - "Filter": { - "$ref": "#/definitions/FilterExpression" - }, - "Name": { - "$ref": "#/definitions/PathParameterName" - }, - "Type": { - "description": "Parameter type", - "enum": [ - "String", - "Number", - "Datetime" - ], - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "DatetimeOptions": { - "additionalProperties": false, - "properties": { - "Format": { - "description": "Date/time format of a date parameter", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "LocaleCode": { - "description": "Locale code for a date parameter", - "maxLength": 100, - "minLength": 2, - "pattern": "^[A-Za-z0-9_\\.#@\\-]+$", - "type": "string" - }, - "TimezoneOffset": { - "description": "Timezone offset", - "maxLength": 6, - "minLength": 1, - "pattern": "^(Z|[-+](\\d|\\d{2}|\\d{2}:?\\d{2}))$", - "type": "string" - } - }, - "required": [ - "Format" - ], - "type": "object" - }, - "ExcelOptions": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "SheetNames" - ] - }, - { - "required": [ - "SheetIndexes" - ] - } - ], - "properties": { - "HeaderRow": { - "type": "boolean" - }, - "SheetIndexes": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "SheetNames": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "FilesLimit": { - "additionalProperties": false, - "properties": { - "MaxFiles": { - "description": "Maximum number of files", - "type": "integer" - }, - "Order": { - "description": "Order", - "enum": [ - "ASCENDING", - "DESCENDING" - ], - "type": "string" - }, - "OrderedBy": { - "description": "Ordered by", - "enum": [ - "LAST_MODIFIED_DATE" - ], - "type": "string" - } - }, - "required": [ - "MaxFiles" - ], - "type": "object" - }, - "FilterExpression": { - "additionalProperties": false, - "properties": { - "Expression": { - "description": "Filtering expression for a parameter", - "maxLength": 1024, - "minLength": 4, - "pattern": "^[><0-9A-Za-z_.,:)(!= ]+$", - "type": "string" - }, - "ValuesMap": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FilterValue" - }, - "type": "array" - } - }, - "required": [ - "Expression", - "ValuesMap" - ], - "type": "object" - }, - "FilterValue": { - "additionalProperties": false, - "description": "A key-value pair to associate expression variable names with their values", - "properties": { - "Value": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ValueReference": { - "description": "Variable name", - "maxLength": 128, - "minLength": 2, - "pattern": "^:[A-Za-z0-9_]+$", - "type": "string" - } - }, - "required": [ - "ValueReference", - "Value" - ], - "type": "object" - }, - "FormatOptions": { - "additionalProperties": false, - "description": "Format options for dataset", - "properties": { - "Csv": { - "$ref": "#/definitions/CsvOptions" - }, - "Excel": { - "$ref": "#/definitions/ExcelOptions" - }, - "Json": { - "$ref": "#/definitions/JsonOptions" - } - }, - "type": "object" - }, - "Input": { - "additionalProperties": false, - "description": "Input", - "properties": { - "DataCatalogInputDefinition": { - "$ref": "#/definitions/DataCatalogInputDefinition" - }, - "DatabaseInputDefinition": { - "$ref": "#/definitions/DatabaseInputDefinition" - }, - "Metadata": { - "$ref": "#/definitions/Metadata" - }, - "S3InputDefinition": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "JsonOptions": { - "additionalProperties": false, - "description": "Json options", - "properties": { - "MultiLine": { - "type": "boolean" - } - }, - "type": "object" - }, - "Metadata": { - "additionalProperties": false, - "properties": { - "SourceArn": { - "description": "Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.", - "type": "string" - } - }, - "type": "object" - }, - "PathOptions": { - "additionalProperties": false, - "description": "Path options for dataset", - "properties": { - "FilesLimit": { - "$ref": "#/definitions/FilesLimit" - }, - "LastModifiedDateCondition": { - "$ref": "#/definitions/FilterExpression" - }, - "Parameters": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PathParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "PathParameter": { - "additionalProperties": false, - "description": "A key-value pair to associate dataset parameter name with its definition.", - "properties": { - "DatasetParameter": { - "$ref": "#/definitions/DatasetParameter" - }, - "PathParameterName": { - "$ref": "#/definitions/PathParameterName" - } - }, - "required": [ - "PathParameterName", - "DatasetParameter" - ], - "type": "object" - }, - "PathParameterName": { - "description": "Parameter name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "S3Location": { - "additionalProperties": false, - "description": "Input location", - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataBrew::Dataset.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateDataset", - "databrew:TagResource", - "databrew:UntagResource", - "glue:GetConnection", - "glue:GetTable", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteDataset" - ] - }, - "list": { - "permissions": [ - "databrew:ListDatasets", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeDataset", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateDataset", - "glue:GetConnection", - "glue:GetTable" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Format": { - "description": "Dataset format", - "enum": [ - "CSV", - "JSON", - "PARQUET", - "EXCEL", - "ORC" - ], - "type": "string" - }, - "FormatOptions": { - "$ref": "#/definitions/FormatOptions", - "description": "Format options for dataset" - }, - "Input": { - "$ref": "#/definitions/Input", - "description": "Input" - }, - "Name": { - "description": "Dataset name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "PathOptions": { - "$ref": "#/definitions/PathOptions", - "description": "PathOptions" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Name", - "Input" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Dataset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "CsvOptions": { + "additionalProperties": false, + "description": "Csv options", + "properties": { + "Delimiter": { + "maxLength": 1, + "minLength": 1, + "type": "string" + }, + "HeaderRow": { + "type": "boolean" + } + }, + "type": "object" + }, + "DataCatalogInputDefinition": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "description": "Catalog id", + "type": "string" + }, + "DatabaseName": { + "description": "Database name", + "type": "string" + }, + "TableName": { + "description": "Table name", + "type": "string" + }, + "TempDirectory": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "DatabaseInputDefinition": { + "additionalProperties": false, + "properties": { + "DatabaseTableName": { + "description": "Database table name", + "type": "string" + }, + "GlueConnectionName": { + "description": "Glue connection name", + "type": "string" + }, + "QueryString": { + "description": "Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.", + "type": "string" + }, + "TempDirectory": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "GlueConnectionName" + ], + "type": "object" + }, + "DatasetParameter": { + "additionalProperties": false, + "properties": { + "CreateColumn": { + "description": "Add the value of this parameter as a column in a dataset.", + "type": "boolean" + }, + "DatetimeOptions": { + "$ref": "#/definitions/DatetimeOptions" + }, + "Filter": { + "$ref": "#/definitions/FilterExpression" + }, + "Name": { + "$ref": "#/definitions/PathParameterName" + }, + "Type": { + "description": "Parameter type", + "enum": [ + "String", + "Number", + "Datetime" + ], + "type": "string" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "DatetimeOptions": { + "additionalProperties": false, + "properties": { + "Format": { + "description": "Date/time format of a date parameter", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "LocaleCode": { + "description": "Locale code for a date parameter", + "maxLength": 100, + "minLength": 2, + "pattern": "^[A-Za-z0-9_\\.#@\\-]+$", + "type": "string" + }, + "TimezoneOffset": { + "description": "Timezone offset", + "maxLength": 6, + "minLength": 1, + "pattern": "^(Z|[-+](\\d|\\d{2}|\\d{2}:?\\d{2}))$", + "type": "string" + } + }, + "required": [ + "Format" + ], + "type": "object" + }, + "ExcelOptions": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "SheetNames" + ] + }, + { + "required": [ + "SheetIndexes" + ] + } + ], + "properties": { + "HeaderRow": { + "type": "boolean" + }, + "SheetIndexes": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "SheetNames": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FilesLimit": { + "additionalProperties": false, + "properties": { + "MaxFiles": { + "description": "Maximum number of files", + "type": "integer" + }, + "Order": { + "description": "Order", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "type": "string" + }, + "OrderedBy": { + "description": "Ordered by", + "enum": [ + "LAST_MODIFIED_DATE" + ], + "type": "string" + } + }, + "required": [ + "MaxFiles" + ], + "type": "object" + }, + "FilterExpression": { + "additionalProperties": false, + "properties": { + "Expression": { + "description": "Filtering expression for a parameter", + "maxLength": 1024, + "minLength": 4, + "pattern": "^[><0-9A-Za-z_.,:)(!= ]+$", + "type": "string" + }, + "ValuesMap": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FilterValue" + }, + "type": "array" + } + }, + "required": [ + "Expression", + "ValuesMap" + ], + "type": "object" + }, + "FilterValue": { + "additionalProperties": false, + "description": "A key-value pair to associate expression variable names with their values", + "properties": { + "Value": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ValueReference": { + "description": "Variable name", + "maxLength": 128, + "minLength": 2, + "pattern": "^:[A-Za-z0-9_]+$", + "type": "string" + } + }, + "required": [ + "ValueReference", + "Value" + ], + "type": "object" + }, + "FormatOptions": { + "additionalProperties": false, + "description": "Format options for dataset", + "properties": { + "Csv": { + "$ref": "#/definitions/CsvOptions" + }, + "Excel": { + "$ref": "#/definitions/ExcelOptions" + }, + "Json": { + "$ref": "#/definitions/JsonOptions" + } + }, + "type": "object" + }, + "Input": { + "additionalProperties": false, + "description": "Input", + "properties": { + "DataCatalogInputDefinition": { + "$ref": "#/definitions/DataCatalogInputDefinition" + }, + "DatabaseInputDefinition": { + "$ref": "#/definitions/DatabaseInputDefinition" + }, + "Metadata": { + "$ref": "#/definitions/Metadata" + }, + "S3InputDefinition": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "JsonOptions": { + "additionalProperties": false, + "description": "Json options", + "properties": { + "MultiLine": { + "type": "boolean" + } + }, + "type": "object" + }, + "Metadata": { + "additionalProperties": false, + "properties": { + "SourceArn": { + "description": "Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.", + "type": "string" + } + }, + "type": "object" + }, + "PathOptions": { + "additionalProperties": false, + "description": "Path options for dataset", + "properties": { + "FilesLimit": { + "$ref": "#/definitions/FilesLimit" + }, + "LastModifiedDateCondition": { + "$ref": "#/definitions/FilterExpression" + }, + "Parameters": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PathParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "PathParameter": { + "additionalProperties": false, + "description": "A key-value pair to associate dataset parameter name with its definition.", + "properties": { + "DatasetParameter": { + "$ref": "#/definitions/DatasetParameter" + }, + "PathParameterName": { + "$ref": "#/definitions/PathParameterName" + } + }, + "required": [ + "PathParameterName", + "DatasetParameter" + ], + "type": "object" + }, + "PathParameterName": { + "description": "Parameter name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "S3Location": { + "additionalProperties": false, + "description": "Input location", + "properties": { + "Bucket": { + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataBrew::Dataset.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateDataset", + "databrew:TagResource", + "databrew:UntagResource", + "glue:GetConnection", + "glue:GetTable", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteDataset" + ] + }, + "list": { + "permissions": [ + "databrew:ListDatasets", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeDataset", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateDataset", + "glue:GetConnection", + "glue:GetTable" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Format": { + "description": "Dataset format", + "enum": [ + "CSV", + "JSON", + "PARQUET", + "EXCEL", + "ORC" + ], + "type": "string" + }, + "FormatOptions": { + "$ref": "#/definitions/FormatOptions", + "description": "Format options for dataset" + }, + "Input": { + "$ref": "#/definitions/Input", + "description": "Input" + }, + "Name": { + "description": "Dataset name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PathOptions": { + "$ref": "#/definitions/PathOptions", + "description": "PathOptions" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Name", + "Input" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Dataset" +} diff --git a/schema/aws-databrew-job.json b/schema/aws-databrew-job.json index 293cbac..45c1e1c 100644 --- a/schema/aws-databrew-job.json +++ b/schema/aws-databrew-job.json @@ -1,632 +1,632 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type", - "/properties/Tags" - ], - "definitions": { - "AllowedStatistics": { - "additionalProperties": false, - "properties": { - "Statistics": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Statistic" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Statistics" - ], - "type": "object" - }, - "ColumnSelector": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Regex": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ColumnStatisticsConfiguration": { - "additionalProperties": false, - "properties": { - "Selectors": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ColumnSelector" - }, - "minItems": 1, - "type": "array" - }, - "Statistics": { - "$ref": "#/definitions/StatisticsConfiguration" - } - }, - "required": [ - "Statistics" - ], - "type": "object" - }, - "CsvOutputOptions": { - "additionalProperties": false, - "description": "Output Csv options", - "properties": { - "Delimiter": { - "maxLength": 1, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DataCatalogOutput": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DatabaseName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DatabaseOptions": { - "$ref": "#/definitions/DatabaseTableOutputOptions" - }, - "Overwrite": { - "type": "boolean" - }, - "S3Options": { - "$ref": "#/definitions/S3TableOutputOptions" - }, - "TableName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DatabaseName", - "TableName" - ], - "type": "object" - }, - "DatabaseOutput": { - "additionalProperties": false, - "properties": { - "DatabaseOptions": { - "$ref": "#/definitions/DatabaseTableOutputOptions" - }, - "DatabaseOutputMode": { - "description": "Database table name", - "enum": [ - "NEW_TABLE" - ], - "type": "string" - }, - "GlueConnectionName": { - "description": "Glue connection name", - "type": "string" - } - }, - "required": [ - "GlueConnectionName", - "DatabaseOptions" - ], - "type": "object" - }, - "DatabaseTableOutputOptions": { - "additionalProperties": false, - "properties": { - "TableName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "TempDirectory": { - "$ref": "#/definitions/S3Location" - } - }, - "required": [ - "TableName" - ], - "type": "object" - }, - "EntityDetectorConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedStatistics": { - "$ref": "#/definitions/AllowedStatistics" - }, - "EntityTypes": { - "insertionOrder": true, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Z_][A-Z\\\\d_]*$", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "EntityTypes" - ], - "type": "object" - }, - "JobSample": { - "additionalProperties": false, - "description": "Job Sample", - "properties": { - "Mode": { - "$ref": "#/definitions/SampleMode" - }, - "Size": { - "$ref": "#/definitions/JobSize" - } - }, - "type": "object" - }, - "JobSize": { - "description": "Sample configuration size for profile jobs.", - "format": "int64", - "type": "integer" - }, - "Output": { - "additionalProperties": false, - "properties": { - "CompressionFormat": { - "enum": [ - "GZIP", - "LZ4", - "SNAPPY", - "BZIP2", - "DEFLATE", - "LZO", - "BROTLI", - "ZSTD", - "ZLIB" - ], - "type": "string" - }, - "Format": { - "enum": [ - "CSV", - "JSON", - "PARQUET", - "GLUEPARQUET", - "AVRO", - "ORC", - "XML", - "TABLEAUHYPER" - ], - "type": "string" - }, - "FormatOptions": { - "$ref": "#/definitions/OutputFormatOptions" - }, - "Location": { - "$ref": "#/definitions/S3Location" - }, - "MaxOutputFiles": { - "maximum": 999, - "minimum": 1, - "type": "integer" - }, - "Overwrite": { - "type": "boolean" - }, - "PartitionColumns": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Location" - ], - "type": "object" - }, - "OutputFormatOptions": { - "additionalProperties": false, - "description": "Format options for job Output", - "properties": { - "Csv": { - "$ref": "#/definitions/CsvOutputOptions" - } - }, - "type": "object" - }, - "OutputLocation": { - "additionalProperties": false, - "description": "Output location", - "properties": { - "Bucket": { - "type": "string" - }, - "BucketOwner": { - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "ParameterMap": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9]{1,128}$": { - "type": "string" - } - }, - "type": "object" - }, - "ProfileConfiguration": { - "additionalProperties": false, - "properties": { - "ColumnStatisticsConfigurations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ColumnStatisticsConfiguration" - }, - "minItems": 1, - "type": "array" - }, - "DatasetStatisticsConfiguration": { - "$ref": "#/definitions/StatisticsConfiguration" - }, - "EntityDetectorConfiguration": { - "$ref": "#/definitions/EntityDetectorConfiguration" - }, - "ProfileColumns": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ColumnSelector" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Recipe": { - "additionalProperties": false, - "properties": { - "Name": { - "description": "Recipe name", - "type": "string" - }, - "Version": { - "description": "Recipe version", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "description": "S3 Output location", - "properties": { - "Bucket": { - "type": "string" - }, - "BucketOwner": { - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "S3TableOutputOptions": { - "additionalProperties": false, - "properties": { - "Location": { - "$ref": "#/definitions/S3Location" - } - }, - "required": [ - "Location" - ], - "type": "object" - }, - "SampleMode": { - "description": "Sample configuration mode for profile jobs.", - "enum": [ - "FULL_DATASET", - "CUSTOM_ROWS" - ], - "type": "string" - }, - "Statistic": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Z\\_]+$", - "type": "string" - }, - "StatisticOverride": { - "additionalProperties": false, - "properties": { - "Parameters": { - "$ref": "#/definitions/ParameterMap" - }, - "Statistic": { - "$ref": "#/definitions/Statistic" - } - }, - "required": [ - "Statistic", - "Parameters" - ], - "type": "object" - }, - "StatisticsConfiguration": { - "additionalProperties": false, - "properties": { - "IncludedStatistics": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Statistic" - }, - "minItems": 1, - "type": "array" - }, - "Overrides": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StatisticOverride" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ValidationConfiguration": { - "additionalProperties": false, - "description": "Configuration to attach Rulesets to the job", - "properties": { - "RulesetArn": { - "description": "Arn of the Ruleset", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ValidationMode": { - "$ref": "#/definitions/ValidationMode" - } - }, - "required": [ - "RulesetArn" - ], - "type": "object" - }, - "ValidationMode": { - "enum": [ - "CHECK_ALL" - ], - "type": "string" - } - }, - "description": "Resource schema for AWS::DataBrew::Job.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateProfileJob", - "databrew:CreateRecipeJob", - "databrew:TagResource", - "databrew:UntagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteJob" - ] - }, - "list": { - "permissions": [ - "databrew:ListJobs", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeJob", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateProfileJob", - "databrew:UpdateRecipeJob", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "DataCatalogOutputs": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DataCatalogOutput" - }, - "type": "array" - }, - "DatabaseOutputs": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DatabaseOutput" - }, - "type": "array" - }, - "DatasetName": { - "description": "Dataset name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "EncryptionKeyArn": { - "description": "Encryption Key Arn", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "EncryptionMode": { - "description": "Encryption mode", - "enum": [ - "SSE-KMS", - "SSE-S3" - ], - "type": "string" - }, - "JobSample": { - "$ref": "#/definitions/JobSample", - "description": "Job Sample" - }, - "LogSubscription": { - "description": "Log subscription", - "enum": [ - "ENABLE", - "DISABLE" - ], - "type": "string" - }, - "MaxCapacity": { - "description": "Max capacity", - "type": "integer" - }, - "MaxRetries": { - "description": "Max retries", - "type": "integer" - }, - "Name": { - "description": "Job name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "OutputLocation": { - "$ref": "#/definitions/OutputLocation", - "description": "Output location" - }, - "Outputs": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Output" - }, - "type": "array" - }, - "ProfileConfiguration": { - "$ref": "#/definitions/ProfileConfiguration", - "description": "Profile Job configuration" - }, - "ProjectName": { - "description": "Project name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Recipe": { - "$ref": "#/definitions/Recipe" - }, - "RoleArn": { - "description": "Role arn", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Timeout": { - "description": "Timeout", - "type": "integer" - }, - "Type": { - "description": "Job type", - "enum": [ - "PROFILE", - "RECIPE" - ], - "type": "string" - }, - "ValidationConfigurations": { - "description": "Data quality rules configuration", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ValidationConfiguration" - }, - "type": "array" - } - }, - "required": [ - "Name", - "RoleArn", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Job" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type", + "/properties/Tags" + ], + "definitions": { + "AllowedStatistics": { + "additionalProperties": false, + "properties": { + "Statistics": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Statistic" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Statistics" + ], + "type": "object" + }, + "ColumnSelector": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Regex": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ColumnStatisticsConfiguration": { + "additionalProperties": false, + "properties": { + "Selectors": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ColumnSelector" + }, + "minItems": 1, + "type": "array" + }, + "Statistics": { + "$ref": "#/definitions/StatisticsConfiguration" + } + }, + "required": [ + "Statistics" + ], + "type": "object" + }, + "CsvOutputOptions": { + "additionalProperties": false, + "description": "Output Csv options", + "properties": { + "Delimiter": { + "maxLength": 1, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DataCatalogOutput": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DatabaseName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DatabaseOptions": { + "$ref": "#/definitions/DatabaseTableOutputOptions" + }, + "Overwrite": { + "type": "boolean" + }, + "S3Options": { + "$ref": "#/definitions/S3TableOutputOptions" + }, + "TableName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DatabaseName", + "TableName" + ], + "type": "object" + }, + "DatabaseOutput": { + "additionalProperties": false, + "properties": { + "DatabaseOptions": { + "$ref": "#/definitions/DatabaseTableOutputOptions" + }, + "DatabaseOutputMode": { + "description": "Database table name", + "enum": [ + "NEW_TABLE" + ], + "type": "string" + }, + "GlueConnectionName": { + "description": "Glue connection name", + "type": "string" + } + }, + "required": [ + "GlueConnectionName", + "DatabaseOptions" + ], + "type": "object" + }, + "DatabaseTableOutputOptions": { + "additionalProperties": false, + "properties": { + "TableName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "TempDirectory": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "TableName" + ], + "type": "object" + }, + "EntityDetectorConfiguration": { + "additionalProperties": false, + "properties": { + "AllowedStatistics": { + "$ref": "#/definitions/AllowedStatistics" + }, + "EntityTypes": { + "insertionOrder": true, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Z_][A-Z\\\\d_]*$", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "EntityTypes" + ], + "type": "object" + }, + "JobSample": { + "additionalProperties": false, + "description": "Job Sample", + "properties": { + "Mode": { + "$ref": "#/definitions/SampleMode" + }, + "Size": { + "$ref": "#/definitions/JobSize" + } + }, + "type": "object" + }, + "JobSize": { + "description": "Sample configuration size for profile jobs.", + "format": "int64", + "type": "integer" + }, + "Output": { + "additionalProperties": false, + "properties": { + "CompressionFormat": { + "enum": [ + "GZIP", + "LZ4", + "SNAPPY", + "BZIP2", + "DEFLATE", + "LZO", + "BROTLI", + "ZSTD", + "ZLIB" + ], + "type": "string" + }, + "Format": { + "enum": [ + "CSV", + "JSON", + "PARQUET", + "GLUEPARQUET", + "AVRO", + "ORC", + "XML", + "TABLEAUHYPER" + ], + "type": "string" + }, + "FormatOptions": { + "$ref": "#/definitions/OutputFormatOptions" + }, + "Location": { + "$ref": "#/definitions/S3Location" + }, + "MaxOutputFiles": { + "maximum": 999, + "minimum": 1, + "type": "integer" + }, + "Overwrite": { + "type": "boolean" + }, + "PartitionColumns": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Location" + ], + "type": "object" + }, + "OutputFormatOptions": { + "additionalProperties": false, + "description": "Format options for job Output", + "properties": { + "Csv": { + "$ref": "#/definitions/CsvOutputOptions" + } + }, + "type": "object" + }, + "OutputLocation": { + "additionalProperties": false, + "description": "Output location", + "properties": { + "Bucket": { + "type": "string" + }, + "BucketOwner": { + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "ParameterMap": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9]{1,128}$": { + "type": "string" + } + }, + "type": "object" + }, + "ProfileConfiguration": { + "additionalProperties": false, + "properties": { + "ColumnStatisticsConfigurations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ColumnStatisticsConfiguration" + }, + "minItems": 1, + "type": "array" + }, + "DatasetStatisticsConfiguration": { + "$ref": "#/definitions/StatisticsConfiguration" + }, + "EntityDetectorConfiguration": { + "$ref": "#/definitions/EntityDetectorConfiguration" + }, + "ProfileColumns": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ColumnSelector" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Recipe": { + "additionalProperties": false, + "properties": { + "Name": { + "description": "Recipe name", + "type": "string" + }, + "Version": { + "description": "Recipe version", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "S3 Output location", + "properties": { + "Bucket": { + "type": "string" + }, + "BucketOwner": { + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "S3TableOutputOptions": { + "additionalProperties": false, + "properties": { + "Location": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "Location" + ], + "type": "object" + }, + "SampleMode": { + "description": "Sample configuration mode for profile jobs.", + "enum": [ + "FULL_DATASET", + "CUSTOM_ROWS" + ], + "type": "string" + }, + "Statistic": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Z\\_]+$", + "type": "string" + }, + "StatisticOverride": { + "additionalProperties": false, + "properties": { + "Parameters": { + "$ref": "#/definitions/ParameterMap" + }, + "Statistic": { + "$ref": "#/definitions/Statistic" + } + }, + "required": [ + "Statistic", + "Parameters" + ], + "type": "object" + }, + "StatisticsConfiguration": { + "additionalProperties": false, + "properties": { + "IncludedStatistics": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Statistic" + }, + "minItems": 1, + "type": "array" + }, + "Overrides": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StatisticOverride" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ValidationConfiguration": { + "additionalProperties": false, + "description": "Configuration to attach Rulesets to the job", + "properties": { + "RulesetArn": { + "description": "Arn of the Ruleset", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ValidationMode": { + "$ref": "#/definitions/ValidationMode" + } + }, + "required": [ + "RulesetArn" + ], + "type": "object" + }, + "ValidationMode": { + "enum": [ + "CHECK_ALL" + ], + "type": "string" + } + }, + "description": "Resource schema for AWS::DataBrew::Job.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateProfileJob", + "databrew:CreateRecipeJob", + "databrew:TagResource", + "databrew:UntagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteJob" + ] + }, + "list": { + "permissions": [ + "databrew:ListJobs", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeJob", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateProfileJob", + "databrew:UpdateRecipeJob", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "DataCatalogOutputs": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DataCatalogOutput" + }, + "type": "array" + }, + "DatabaseOutputs": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DatabaseOutput" + }, + "type": "array" + }, + "DatasetName": { + "description": "Dataset name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "EncryptionKeyArn": { + "description": "Encryption Key Arn", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "EncryptionMode": { + "description": "Encryption mode", + "enum": [ + "SSE-KMS", + "SSE-S3" + ], + "type": "string" + }, + "JobSample": { + "$ref": "#/definitions/JobSample", + "description": "Job Sample" + }, + "LogSubscription": { + "description": "Log subscription", + "enum": [ + "ENABLE", + "DISABLE" + ], + "type": "string" + }, + "MaxCapacity": { + "description": "Max capacity", + "type": "integer" + }, + "MaxRetries": { + "description": "Max retries", + "type": "integer" + }, + "Name": { + "description": "Job name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "OutputLocation": { + "$ref": "#/definitions/OutputLocation", + "description": "Output location" + }, + "Outputs": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Output" + }, + "type": "array" + }, + "ProfileConfiguration": { + "$ref": "#/definitions/ProfileConfiguration", + "description": "Profile Job configuration" + }, + "ProjectName": { + "description": "Project name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Recipe": { + "$ref": "#/definitions/Recipe" + }, + "RoleArn": { + "description": "Role arn", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Timeout": { + "description": "Timeout", + "type": "integer" + }, + "Type": { + "description": "Job type", + "enum": [ + "PROFILE", + "RECIPE" + ], + "type": "string" + }, + "ValidationConfigurations": { + "description": "Data quality rules configuration", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ValidationConfiguration" + }, + "type": "array" + } + }, + "required": [ + "Name", + "RoleArn", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Job" +} diff --git a/schema/aws-databrew-project.json b/schema/aws-databrew-project.json index 35082ce..b261e2a 100644 --- a/schema/aws-databrew-project.json +++ b/schema/aws-databrew-project.json @@ -1,137 +1,137 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "Sample": { - "additionalProperties": false, - "properties": { - "Size": { - "description": "Sample size", - "minimum": 1, - "type": "integer" - }, - "Type": { - "description": "Sample type", - "enum": [ - "FIRST_N", - "LAST_N", - "RANDOM" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataBrew::Project.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateProject", - "databrew:TagResource", - "databrew:UntagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteProject" - ] - }, - "list": { - "permissions": [ - "databrew:ListProjects", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeProject", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateProject", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "DatasetName": { - "description": "Dataset name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Project name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RecipeName": { - "description": "Recipe name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "Role arn", - "type": "string" - }, - "Sample": { - "$ref": "#/definitions/Sample", - "description": "Sample" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "DatasetName", - "Name", - "RecipeName", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "Sample": { + "additionalProperties": false, + "properties": { + "Size": { + "description": "Sample size", + "minimum": 1, + "type": "integer" + }, + "Type": { + "description": "Sample type", + "enum": [ + "FIRST_N", + "LAST_N", + "RANDOM" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataBrew::Project.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateProject", + "databrew:TagResource", + "databrew:UntagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteProject" + ] + }, + "list": { + "permissions": [ + "databrew:ListProjects", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeProject", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateProject", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "DatasetName": { + "description": "Dataset name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Project name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RecipeName": { + "description": "Recipe name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "Role arn", + "type": "string" + }, + "Sample": { + "$ref": "#/definitions/Sample", + "description": "Sample" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "DatasetName", + "Name", + "RecipeName", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Project" +} diff --git a/schema/aws-databrew-recipe.json b/schema/aws-databrew-recipe.json index 1bd7623..9e97272 100644 --- a/schema/aws-databrew-recipe.json +++ b/schema/aws-databrew-recipe.json @@ -1,589 +1,589 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "Operation": { - "description": "Step action operation", - "type": "string" - }, - "Parameters": { - "anyOf": [ - { - "$ref": "#/definitions/RecipeParameters" - }, - { - "$ref": "#/definitions/ParameterMap" - } - ] - } - }, - "required": [ - "Operation" - ], - "type": "object" - }, - "ConditionExpression": { - "additionalProperties": false, - "description": "Condition expressions applied to the step action", - "properties": { - "Condition": { - "description": "Input condition to be applied to the target column", - "type": "string" - }, - "TargetColumn": { - "description": "Name of the target column", - "type": "string" - }, - "Value": { - "description": "Value of the condition", - "type": "string" - } - }, - "required": [ - "Condition", - "TargetColumn" - ], - "type": "object" - }, - "DataCatalogInputDefinition": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "description": "Catalog id", - "type": "string" - }, - "DatabaseName": { - "description": "Database name", - "type": "string" - }, - "TableName": { - "description": "Table name", - "type": "string" - }, - "TempDirectory": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "ParameterMap": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9]{1,128}$": { - "type": "string" - } - }, - "type": "object" - }, - "RecipeParameters": { - "additionalProperties": false, - "properties": { - "AggregateFunction": { - "type": "string" - }, - "Base": { - "type": "string" - }, - "CaseStatement": { - "type": "string" - }, - "CategoryMap": { - "type": "string" - }, - "CharsToRemove": { - "type": "string" - }, - "CollapseConsecutiveWhitespace": { - "type": "string" - }, - "ColumnDataType": { - "type": "string" - }, - "ColumnRange": { - "type": "string" - }, - "Count": { - "type": "string" - }, - "CustomCharacters": { - "type": "string" - }, - "CustomStopWords": { - "type": "string" - }, - "CustomValue": { - "type": "string" - }, - "DatasetsColumns": { - "type": "string" - }, - "DateAddValue": { - "type": "string" - }, - "DateTimeFormat": { - "type": "string" - }, - "DateTimeParameters": { - "type": "string" - }, - "DeleteOtherRows": { - "type": "string" - }, - "Delimiter": { - "type": "string" - }, - "EndPattern": { - "type": "string" - }, - "EndPosition": { - "type": "string" - }, - "EndValue": { - "type": "string" - }, - "ExpandContractions": { - "type": "string" - }, - "Exponent": { - "type": "string" - }, - "FalseString": { - "type": "string" - }, - "GroupByAggFunctionOptions": { - "type": "string" - }, - "GroupByColumns": { - "type": "string" - }, - "HiddenColumns": { - "type": "string" - }, - "IgnoreCase": { - "type": "string" - }, - "IncludeInSplit": { - "type": "string" - }, - "Input": { - "additionalProperties": false, - "description": "Input", - "oneOf": [ - { - "required": [ - "S3InputDefinition" - ] - }, - { - "required": [ - "DataCatalogInputDefinition" - ] - } - ], - "properties": { - "DataCatalogInputDefinition": { - "$ref": "#/definitions/DataCatalogInputDefinition" - }, - "S3InputDefinition": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "Interval": { - "type": "string" - }, - "IsText": { - "type": "string" - }, - "JoinKeys": { - "type": "string" - }, - "JoinType": { - "type": "string" - }, - "LeftColumns": { - "type": "string" - }, - "Limit": { - "type": "string" - }, - "LowerBound": { - "type": "string" - }, - "MapType": { - "type": "string" - }, - "ModeType": { - "type": "string" - }, - "MultiLine": { - "type": "boolean" - }, - "NumRows": { - "type": "string" - }, - "NumRowsAfter": { - "type": "string" - }, - "NumRowsBefore": { - "type": "string" - }, - "OrderByColumn": { - "type": "string" - }, - "OrderByColumns": { - "type": "string" - }, - "Other": { - "type": "string" - }, - "Pattern": { - "type": "string" - }, - "PatternOption1": { - "type": "string" - }, - "PatternOption2": { - "type": "string" - }, - "PatternOptions": { - "type": "string" - }, - "Period": { - "type": "string" - }, - "Position": { - "type": "string" - }, - "RemoveAllPunctuation": { - "type": "string" - }, - "RemoveAllQuotes": { - "type": "string" - }, - "RemoveAllWhitespace": { - "type": "string" - }, - "RemoveCustomCharacters": { - "type": "string" - }, - "RemoveCustomValue": { - "type": "string" - }, - "RemoveLeadingAndTrailingPunctuation": { - "type": "string" - }, - "RemoveLeadingAndTrailingQuotes": { - "type": "string" - }, - "RemoveLeadingAndTrailingWhitespace": { - "type": "string" - }, - "RemoveLetters": { - "type": "string" - }, - "RemoveNumbers": { - "type": "string" - }, - "RemoveSourceColumn": { - "type": "string" - }, - "RemoveSpecialCharacters": { - "type": "string" - }, - "RightColumns": { - "type": "string" - }, - "SampleSize": { - "type": "string" - }, - "SampleType": { - "type": "string" - }, - "SecondInput": { - "type": "string" - }, - "SecondaryInputs": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SecondaryInput" - }, - "type": "array", - "uniqueItems": false - }, - "SheetIndexes": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "SheetNames": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "SourceColumn": { - "type": "string" - }, - "SourceColumn1": { - "type": "string" - }, - "SourceColumn2": { - "type": "string" - }, - "SourceColumns": { - "type": "string" - }, - "StartColumnIndex": { - "type": "string" - }, - "StartPattern": { - "type": "string" - }, - "StartPosition": { - "type": "string" - }, - "StartValue": { - "type": "string" - }, - "StemmingMode": { - "type": "string" - }, - "StepCount": { - "type": "string" - }, - "StepIndex": { - "type": "string" - }, - "StopWordsMode": { - "type": "string" - }, - "Strategy": { - "type": "string" - }, - "TargetColumn": { - "type": "string" - }, - "TargetColumnNames": { - "type": "string" - }, - "TargetDateFormat": { - "type": "string" - }, - "TargetIndex": { - "type": "string" - }, - "TimeZone": { - "type": "string" - }, - "TokenizerPattern": { - "type": "string" - }, - "TrueString": { - "type": "string" - }, - "UdfLang": { - "type": "string" - }, - "Units": { - "type": "string" - }, - "UnpivotColumn": { - "type": "string" - }, - "UpperBound": { - "type": "string" - }, - "UseNewDataFrame": { - "type": "string" - }, - "Value": { - "type": "string" - }, - "Value1": { - "type": "string" - }, - "Value2": { - "type": "string" - }, - "ValueColumn": { - "type": "string" - }, - "ViewFrame": { - "type": "string" - } - } - }, - "RecipeStep": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/Action" - }, - "ConditionExpressions": { - "description": "Condition expressions applied to the step action", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ConditionExpression" - }, - "type": "array" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "description": "Input location", - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "SecondaryInput": { - "additionalProperties": false, - "description": "Secondary input", - "oneOf": [ - { - "required": [ - "S3InputDefinition" - ] - }, - { - "required": [ - "DataCatalogInputDefinition" - ] - } - ], - "properties": { - "DataCatalogInputDefinition": { - "$ref": "#/definitions/DataCatalogInputDefinition" - }, - "S3InputDefinition": { - "$ref": "#/definitions/S3Location" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataBrew::Recipe.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateRecipe", - "databrew:TagResource", - "databrew:UntagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteRecipeVersion" - ] - }, - "list": { - "permissions": [ - "databrew:ListRecipes", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeRecipe", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateRecipe" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Description": { - "description": "Description of the recipe", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "Recipe name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Steps": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/RecipeStep", - "type": "object" - }, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Name", - "Steps" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Recipe" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "Operation": { + "description": "Step action operation", + "type": "string" + }, + "Parameters": { + "anyOf": [ + { + "$ref": "#/definitions/RecipeParameters" + }, + { + "$ref": "#/definitions/ParameterMap" + } + ] + } + }, + "required": [ + "Operation" + ], + "type": "object" + }, + "ConditionExpression": { + "additionalProperties": false, + "description": "Condition expressions applied to the step action", + "properties": { + "Condition": { + "description": "Input condition to be applied to the target column", + "type": "string" + }, + "TargetColumn": { + "description": "Name of the target column", + "type": "string" + }, + "Value": { + "description": "Value of the condition", + "type": "string" + } + }, + "required": [ + "Condition", + "TargetColumn" + ], + "type": "object" + }, + "DataCatalogInputDefinition": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "description": "Catalog id", + "type": "string" + }, + "DatabaseName": { + "description": "Database name", + "type": "string" + }, + "TableName": { + "description": "Table name", + "type": "string" + }, + "TempDirectory": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "ParameterMap": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9]{1,128}$": { + "type": "string" + } + }, + "type": "object" + }, + "RecipeParameters": { + "additionalProperties": false, + "properties": { + "AggregateFunction": { + "type": "string" + }, + "Base": { + "type": "string" + }, + "CaseStatement": { + "type": "string" + }, + "CategoryMap": { + "type": "string" + }, + "CharsToRemove": { + "type": "string" + }, + "CollapseConsecutiveWhitespace": { + "type": "string" + }, + "ColumnDataType": { + "type": "string" + }, + "ColumnRange": { + "type": "string" + }, + "Count": { + "type": "string" + }, + "CustomCharacters": { + "type": "string" + }, + "CustomStopWords": { + "type": "string" + }, + "CustomValue": { + "type": "string" + }, + "DatasetsColumns": { + "type": "string" + }, + "DateAddValue": { + "type": "string" + }, + "DateTimeFormat": { + "type": "string" + }, + "DateTimeParameters": { + "type": "string" + }, + "DeleteOtherRows": { + "type": "string" + }, + "Delimiter": { + "type": "string" + }, + "EndPattern": { + "type": "string" + }, + "EndPosition": { + "type": "string" + }, + "EndValue": { + "type": "string" + }, + "ExpandContractions": { + "type": "string" + }, + "Exponent": { + "type": "string" + }, + "FalseString": { + "type": "string" + }, + "GroupByAggFunctionOptions": { + "type": "string" + }, + "GroupByColumns": { + "type": "string" + }, + "HiddenColumns": { + "type": "string" + }, + "IgnoreCase": { + "type": "string" + }, + "IncludeInSplit": { + "type": "string" + }, + "Input": { + "additionalProperties": false, + "description": "Input", + "oneOf": [ + { + "required": [ + "S3InputDefinition" + ] + }, + { + "required": [ + "DataCatalogInputDefinition" + ] + } + ], + "properties": { + "DataCatalogInputDefinition": { + "$ref": "#/definitions/DataCatalogInputDefinition" + }, + "S3InputDefinition": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "Interval": { + "type": "string" + }, + "IsText": { + "type": "string" + }, + "JoinKeys": { + "type": "string" + }, + "JoinType": { + "type": "string" + }, + "LeftColumns": { + "type": "string" + }, + "Limit": { + "type": "string" + }, + "LowerBound": { + "type": "string" + }, + "MapType": { + "type": "string" + }, + "ModeType": { + "type": "string" + }, + "MultiLine": { + "type": "boolean" + }, + "NumRows": { + "type": "string" + }, + "NumRowsAfter": { + "type": "string" + }, + "NumRowsBefore": { + "type": "string" + }, + "OrderByColumn": { + "type": "string" + }, + "OrderByColumns": { + "type": "string" + }, + "Other": { + "type": "string" + }, + "Pattern": { + "type": "string" + }, + "PatternOption1": { + "type": "string" + }, + "PatternOption2": { + "type": "string" + }, + "PatternOptions": { + "type": "string" + }, + "Period": { + "type": "string" + }, + "Position": { + "type": "string" + }, + "RemoveAllPunctuation": { + "type": "string" + }, + "RemoveAllQuotes": { + "type": "string" + }, + "RemoveAllWhitespace": { + "type": "string" + }, + "RemoveCustomCharacters": { + "type": "string" + }, + "RemoveCustomValue": { + "type": "string" + }, + "RemoveLeadingAndTrailingPunctuation": { + "type": "string" + }, + "RemoveLeadingAndTrailingQuotes": { + "type": "string" + }, + "RemoveLeadingAndTrailingWhitespace": { + "type": "string" + }, + "RemoveLetters": { + "type": "string" + }, + "RemoveNumbers": { + "type": "string" + }, + "RemoveSourceColumn": { + "type": "string" + }, + "RemoveSpecialCharacters": { + "type": "string" + }, + "RightColumns": { + "type": "string" + }, + "SampleSize": { + "type": "string" + }, + "SampleType": { + "type": "string" + }, + "SecondInput": { + "type": "string" + }, + "SecondaryInputs": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SecondaryInput" + }, + "type": "array", + "uniqueItems": false + }, + "SheetIndexes": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "SheetNames": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "SourceColumn": { + "type": "string" + }, + "SourceColumn1": { + "type": "string" + }, + "SourceColumn2": { + "type": "string" + }, + "SourceColumns": { + "type": "string" + }, + "StartColumnIndex": { + "type": "string" + }, + "StartPattern": { + "type": "string" + }, + "StartPosition": { + "type": "string" + }, + "StartValue": { + "type": "string" + }, + "StemmingMode": { + "type": "string" + }, + "StepCount": { + "type": "string" + }, + "StepIndex": { + "type": "string" + }, + "StopWordsMode": { + "type": "string" + }, + "Strategy": { + "type": "string" + }, + "TargetColumn": { + "type": "string" + }, + "TargetColumnNames": { + "type": "string" + }, + "TargetDateFormat": { + "type": "string" + }, + "TargetIndex": { + "type": "string" + }, + "TimeZone": { + "type": "string" + }, + "TokenizerPattern": { + "type": "string" + }, + "TrueString": { + "type": "string" + }, + "UdfLang": { + "type": "string" + }, + "Units": { + "type": "string" + }, + "UnpivotColumn": { + "type": "string" + }, + "UpperBound": { + "type": "string" + }, + "UseNewDataFrame": { + "type": "string" + }, + "Value": { + "type": "string" + }, + "Value1": { + "type": "string" + }, + "Value2": { + "type": "string" + }, + "ValueColumn": { + "type": "string" + }, + "ViewFrame": { + "type": "string" + } + } + }, + "RecipeStep": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/Action" + }, + "ConditionExpressions": { + "description": "Condition expressions applied to the step action", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ConditionExpression" + }, + "type": "array" + } + }, + "required": [ + "Action" + ], + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "Input location", + "properties": { + "Bucket": { + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "SecondaryInput": { + "additionalProperties": false, + "description": "Secondary input", + "oneOf": [ + { + "required": [ + "S3InputDefinition" + ] + }, + { + "required": [ + "DataCatalogInputDefinition" + ] + } + ], + "properties": { + "DataCatalogInputDefinition": { + "$ref": "#/definitions/DataCatalogInputDefinition" + }, + "S3InputDefinition": { + "$ref": "#/definitions/S3Location" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataBrew::Recipe.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateRecipe", + "databrew:TagResource", + "databrew:UntagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteRecipeVersion" + ] + }, + "list": { + "permissions": [ + "databrew:ListRecipes", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeRecipe", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateRecipe" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Description": { + "description": "Description of the recipe", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "Recipe name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Steps": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/RecipeStep", + "type": "object" + }, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Name", + "Steps" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Recipe" +} diff --git a/schema/aws-databrew-ruleset.json b/schema/aws-databrew-ruleset.json index 70b5392..0db2ffd 100644 --- a/schema/aws-databrew-ruleset.json +++ b/schema/aws-databrew-ruleset.json @@ -1,250 +1,251 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/TargetArn" - ], - "definitions": { - "ColumnSelector": { - "additionalProperties": false, - "description": "Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression", - "properties": { - "Name": { - "description": "The name of a column from a dataset", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Regex": { - "description": "A regular expression for selecting a column from a dataset", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Disabled": { - "description": "Boolean value to disable/enable a rule", - "type": "boolean" - }, - "Expression": { - "description": "Expression with rule conditions", - "maxLength": 1024, - "minLength": 4, - "pattern": "^[><0-9A-Za-z_.,:)(!= ]+$", - "type": "string" - }, - "Rule": { - "additionalProperties": false, - "description": "Data quality rule for a target resource (dataset)", - "properties": { - "CheckExpression": { - "$ref": "#/definitions/Expression" - }, - "ColumnSelectors": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ColumnSelector" - }, - "minItems": 1, - "type": "array" - }, - "Disabled": { - "$ref": "#/definitions/Disabled" - }, - "Name": { - "description": "Name of the rule", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SubstitutionMap": { - "$ref": "#/definitions/ValuesMap" - }, - "Threshold": { - "$ref": "#/definitions/Threshold" - } - }, - "required": [ - "Name", - "CheckExpression" - ], - "type": "object" - }, - "SubstitutionValue": { - "additionalProperties": false, - "description": "A key-value pair to associate expression's substitution variable names with their values", - "properties": { - "Value": { - "description": "Value or column name", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ValueReference": { - "description": "Variable name", - "maxLength": 128, - "minLength": 2, - "pattern": "^:[A-Za-z0-9_]+$", - "type": "string" - } - }, - "required": [ - "ValueReference", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Threshold": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/ThresholdType" - }, - "Unit": { - "$ref": "#/definitions/ThresholdUnit" - }, - "Value": { - "$ref": "#/definitions/ThresholdValue" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "ThresholdType": { - "description": "Threshold type for a rule", - "enum": [ - "GREATER_THAN_OR_EQUAL", - "LESS_THAN_OR_EQUAL", - "GREATER_THAN", - "LESS_THAN" - ], - "type": "string" - }, - "ThresholdUnit": { - "description": "Threshold unit for a rule", - "enum": [ - "COUNT", - "PERCENTAGE" - ], - "type": "string" - }, - "ThresholdValue": { - "description": "Threshold value for a rule", - "type": "number" - }, - "ValuesMap": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SubstitutionValue" - }, - "type": "array" - } - }, - "description": "Resource schema for AWS::DataBrew::Ruleset.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateRuleset", - "databrew:TagResource", - "databrew:UntagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteRuleset" - ] - }, - "list": { - "permissions": [ - "databrew:ListRulesets", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeRuleset", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateRuleset" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Description": { - "description": "Description of the Ruleset", - "maxLength": 1024, - "type": "string" - }, - "Name": { - "description": "Name of the Ruleset", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Rules": { - "description": "List of the data quality rules in the ruleset", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Rule" - }, - "minItems": 1, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TargetArn": { - "description": "Arn of the target resource (dataset) to apply the ruleset to", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "Name", - "TargetArn", - "Rules" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Ruleset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/TargetArn", + "/properties/Tags" + ], + "definitions": { + "ColumnSelector": { + "additionalProperties": false, + "description": "Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression", + "properties": { + "Name": { + "description": "The name of a column from a dataset", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Regex": { + "description": "A regular expression for selecting a column from a dataset", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Disabled": { + "description": "Boolean value to disable/enable a rule", + "type": "boolean" + }, + "Expression": { + "description": "Expression with rule conditions", + "maxLength": 1024, + "minLength": 4, + "pattern": "^[><0-9A-Za-z_.,:)(!= ]+$", + "type": "string" + }, + "Rule": { + "additionalProperties": false, + "description": "Data quality rule for a target resource (dataset)", + "properties": { + "CheckExpression": { + "$ref": "#/definitions/Expression" + }, + "ColumnSelectors": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ColumnSelector" + }, + "minItems": 1, + "type": "array" + }, + "Disabled": { + "$ref": "#/definitions/Disabled" + }, + "Name": { + "description": "Name of the rule", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SubstitutionMap": { + "$ref": "#/definitions/ValuesMap" + }, + "Threshold": { + "$ref": "#/definitions/Threshold" + } + }, + "required": [ + "Name", + "CheckExpression" + ], + "type": "object" + }, + "SubstitutionValue": { + "additionalProperties": false, + "description": "A key-value pair to associate expression's substitution variable names with their values", + "properties": { + "Value": { + "description": "Value or column name", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ValueReference": { + "description": "Variable name", + "maxLength": 128, + "minLength": 2, + "pattern": "^:[A-Za-z0-9_]+$", + "type": "string" + } + }, + "required": [ + "ValueReference", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Threshold": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/ThresholdType" + }, + "Unit": { + "$ref": "#/definitions/ThresholdUnit" + }, + "Value": { + "$ref": "#/definitions/ThresholdValue" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "ThresholdType": { + "description": "Threshold type for a rule", + "enum": [ + "GREATER_THAN_OR_EQUAL", + "LESS_THAN_OR_EQUAL", + "GREATER_THAN", + "LESS_THAN" + ], + "type": "string" + }, + "ThresholdUnit": { + "description": "Threshold unit for a rule", + "enum": [ + "COUNT", + "PERCENTAGE" + ], + "type": "string" + }, + "ThresholdValue": { + "description": "Threshold value for a rule", + "type": "number" + }, + "ValuesMap": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SubstitutionValue" + }, + "type": "array" + } + }, + "description": "Resource schema for AWS::DataBrew::Ruleset.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateRuleset", + "databrew:TagResource", + "databrew:UntagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteRuleset" + ] + }, + "list": { + "permissions": [ + "databrew:ListRulesets", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeRuleset", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateRuleset" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Description": { + "description": "Description of the Ruleset", + "maxLength": 1024, + "type": "string" + }, + "Name": { + "description": "Name of the Ruleset", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Rules": { + "description": "List of the data quality rules in the ruleset", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "minItems": 1, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TargetArn": { + "description": "Arn of the target resource (dataset) to apply the ruleset to", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "Name", + "TargetArn", + "Rules" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Ruleset" +} diff --git a/schema/aws-databrew-schedule.json b/schema/aws-databrew-schedule.json index 088ceee..c5b59af 100644 --- a/schema/aws-databrew-schedule.json +++ b/schema/aws-databrew-schedule.json @@ -1,111 +1,111 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "JobName": { - "description": "Job name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataBrew::Schedule.", - "handlers": { - "create": { - "permissions": [ - "databrew:CreateSchedule", - "databrew:TagResource", - "databrew:UntagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "databrew:DeleteSchedule" - ] - }, - "list": { - "permissions": [ - "databrew:ListSchedules", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "databrew:DescribeSchedule", - "databrew:ListTagsForResource", - "iam:ListRoles" - ] - }, - "update": { - "permissions": [ - "databrew:UpdateSchedule" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "CronExpression": { - "description": "Schedule cron", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "JobNames": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/JobName" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "Schedule Name", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Name", - "CronExpression" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", - "taggable": true, - "typeName": "AWS::DataBrew::Schedule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "JobName": { + "description": "Job name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataBrew::Schedule.", + "handlers": { + "create": { + "permissions": [ + "databrew:CreateSchedule", + "databrew:TagResource", + "databrew:UntagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "databrew:DeleteSchedule" + ] + }, + "list": { + "permissions": [ + "databrew:ListSchedules", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "databrew:DescribeSchedule", + "databrew:ListTagsForResource", + "iam:ListRoles" + ] + }, + "update": { + "permissions": [ + "databrew:UpdateSchedule" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "CronExpression": { + "description": "Schedule cron", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "JobNames": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/JobName" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "Schedule Name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Name", + "CronExpression" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-databrew.git", + "taggable": true, + "typeName": "AWS::DataBrew::Schedule" +} diff --git a/schema/aws-datapipeline-pipeline.json b/schema/aws-datapipeline-pipeline.json index 6bff956..427fed0 100644 --- a/schema/aws-datapipeline-pipeline.json +++ b/schema/aws-datapipeline-pipeline.json @@ -1,255 +1,255 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name" - ], - "definitions": { - "Field": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.", - "type": "string" - }, - "RefValue": { - "description": "A field value that you specify as an identifier of another object in the same pipeline definition.", - "type": "string" - }, - "StringValue": { - "description": "A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "ParameterAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The field identifier.", - "type": "string" - }, - "StringValue": { - "description": "The field value, expressed as a String.", - "type": "string" - } - }, - "required": [ - "Key", - "StringValue" - ], - "type": "object" - }, - "ParameterObject": { - "additionalProperties": false, - "properties": { - "Attributes": { - "description": "The attributes of the parameter object.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ParameterAttribute" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "description": "The ID of the parameter object.", - "type": "string" - } - }, - "required": [ - "Attributes", - "Id" - ], - "type": "object" - }, - "ParameterValue": { - "additionalProperties": false, - "properties": { - "Id": { - "description": "The ID of the parameter value.", - "type": "string" - }, - "StringValue": { - "description": "The field value, expressed as a String.", - "type": "string" - } - }, - "required": [ - "Id", - "StringValue" - ], - "type": "object" - }, - "PipelineObject": { - "additionalProperties": false, - "properties": { - "Fields": { - "description": "Key-value pairs that define the properties of the object.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Field" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "description": "The ID of the object.", - "type": "string" - }, - "Name": { - "description": "The name of the object.", - "type": "string" - } - }, - "required": [ - "Fields", - "Id", - "Name" - ], - "type": "object" - }, - "PipelineTag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of a tag.", - "type": "string" - }, - "Value": { - "description": "The value to associate with the key name.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "datapipeline:CreatePipeline", - "datapipeline:PutPipelineDefinition", - "datapipeline:GetPipelineDefinition", - "datapipeline:DescribePipelines", - "datapipeline:ValidatePipelineDefinition", - "datapipeline:ActivatePipeline", - "datapipeline:AddTags", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "datapipeline:DeletePipeline", - "datapipeline:DescribePipelines", - "datapipeline:GetPipelineDefinition", - "datapipeline:RemoveTags" - ] - }, - "list": { - "permissions": [ - "datapipeline:ListPipelines" - ] - }, - "read": { - "permissions": [ - "datapipeline:GetPipelineDefinition", - "datapipeline:DescribePipelines" - ] - }, - "update": { - "permissions": [ - "datapipeline:PutPipelineDefinition", - "datapipeline:AddTags", - "datapipeline:RemoveTags", - "datapipeline:DeactivatePipeline", - "datapipeline:GetPipelineDefinition", - "datapipeline:ActivatePipeline", - "datapipeline:ValidatePipelineDefinition", - "datapipeline:DescribePipelines", - "datapipeline:AddTags", - "datapipeline:RemoveTags", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/PipelineId" - ], - "properties": { - "Activate": { - "description": "Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.", - "type": "boolean" - }, - "Description": { - "description": "A description of the pipeline.", - "type": "string" - }, - "Name": { - "description": "The name of the pipeline.", - "type": "string" - }, - "ParameterObjects": { - "description": "The parameter objects used with the pipeline.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ParameterObject" - }, - "type": "array", - "uniqueItems": false - }, - "ParameterValues": { - "description": "The parameter values used with the pipeline.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ParameterValue" - }, - "type": "array", - "uniqueItems": false - }, - "PipelineId": { - "type": "string" - }, - "PipelineObjects": { - "description": "The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PipelineObject" - }, - "type": "array", - "uniqueItems": false - }, - "PipelineTags": { - "description": "A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PipelineTag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/PipelineId" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datapipeline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/PipelineTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataPipeline::Pipeline" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name" + ], + "definitions": { + "Field": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.", + "type": "string" + }, + "RefValue": { + "description": "A field value that you specify as an identifier of another object in the same pipeline definition.", + "type": "string" + }, + "StringValue": { + "description": "A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "ParameterAttribute": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The field identifier.", + "type": "string" + }, + "StringValue": { + "description": "The field value, expressed as a String.", + "type": "string" + } + }, + "required": [ + "Key", + "StringValue" + ], + "type": "object" + }, + "ParameterObject": { + "additionalProperties": false, + "properties": { + "Attributes": { + "description": "The attributes of the parameter object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ParameterAttribute" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "description": "The ID of the parameter object.", + "type": "string" + } + }, + "required": [ + "Attributes", + "Id" + ], + "type": "object" + }, + "ParameterValue": { + "additionalProperties": false, + "properties": { + "Id": { + "description": "The ID of the parameter value.", + "type": "string" + }, + "StringValue": { + "description": "The field value, expressed as a String.", + "type": "string" + } + }, + "required": [ + "Id", + "StringValue" + ], + "type": "object" + }, + "PipelineObject": { + "additionalProperties": false, + "properties": { + "Fields": { + "description": "Key-value pairs that define the properties of the object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Field" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "description": "The ID of the object.", + "type": "string" + }, + "Name": { + "description": "The name of the object.", + "type": "string" + } + }, + "required": [ + "Fields", + "Id", + "Name" + ], + "type": "object" + }, + "PipelineTag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of a tag.", + "type": "string" + }, + "Value": { + "description": "The value to associate with the key name.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "datapipeline:CreatePipeline", + "datapipeline:PutPipelineDefinition", + "datapipeline:GetPipelineDefinition", + "datapipeline:DescribePipelines", + "datapipeline:ValidatePipelineDefinition", + "datapipeline:ActivatePipeline", + "datapipeline:AddTags", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "datapipeline:DeletePipeline", + "datapipeline:DescribePipelines", + "datapipeline:GetPipelineDefinition", + "datapipeline:RemoveTags" + ] + }, + "list": { + "permissions": [ + "datapipeline:ListPipelines" + ] + }, + "read": { + "permissions": [ + "datapipeline:GetPipelineDefinition", + "datapipeline:DescribePipelines" + ] + }, + "update": { + "permissions": [ + "datapipeline:PutPipelineDefinition", + "datapipeline:AddTags", + "datapipeline:RemoveTags", + "datapipeline:DeactivatePipeline", + "datapipeline:GetPipelineDefinition", + "datapipeline:ActivatePipeline", + "datapipeline:ValidatePipelineDefinition", + "datapipeline:DescribePipelines", + "datapipeline:AddTags", + "datapipeline:RemoveTags", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/PipelineId" + ], + "properties": { + "Activate": { + "description": "Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.", + "type": "boolean" + }, + "Description": { + "description": "A description of the pipeline.", + "type": "string" + }, + "Name": { + "description": "The name of the pipeline.", + "type": "string" + }, + "ParameterObjects": { + "description": "The parameter objects used with the pipeline.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ParameterObject" + }, + "type": "array", + "uniqueItems": false + }, + "ParameterValues": { + "description": "The parameter values used with the pipeline.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ParameterValue" + }, + "type": "array", + "uniqueItems": false + }, + "PipelineId": { + "type": "string" + }, + "PipelineObjects": { + "description": "The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PipelineObject" + }, + "type": "array", + "uniqueItems": false + }, + "PipelineTags": { + "description": "A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PipelineTag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/PipelineId" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datapipeline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/PipelineTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataPipeline::Pipeline" +} diff --git a/schema/aws-datasync-agent.json b/schema/aws-datasync-agent.json index 1b410a5..7ad021a 100644 --- a/schema/aws-datasync-agent.json +++ b/schema/aws-datasync-agent.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ActivationKey", - "/properties/SecurityGroupArns", - "/properties/SubnetArns", - "/properties/VpcEndpointId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::Agent.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateAgent", - "datasync:TagResource", - "datasync:DescribeAgent", - "datasync:ListTagsForResource", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcEndpoints" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteAgent" - ] - }, - "list": { - "permissions": [ - "datasync:ListAgents" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeAgent", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:UpdateAgent", - "datasync:DescribeAgent", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AgentArn" - ], - "properties": { - "ActivationKey": { - "description": "Activation key of the Agent.", - "maxLength": 29, - "pattern": "[A-Z0-9]{5}(-[A-Z0-9]{5}){4}", - "type": "string" - }, - "AgentArn": { - "description": "The DataSync Agent ARN.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "AgentName": { - "description": "The name configured for the agent. Text reference used to identify the agent in the console.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - }, - "EndpointType": { - "description": "The service endpoints that the agent will connect to.", - "enum": [ - "FIPS", - "PUBLIC", - "PRIVATE_LINK" - ], - "type": "string" - }, - "SecurityGroupArns": { - "description": "The ARNs of the security group used to protect your data transfer task subnets.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", - "type": "string" - }, - "type": "array" - }, - "SubnetArns": { - "description": "The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$", - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "VpcEndpointId": { - "description": "The ID of the VPC endpoint that the agent has access to.", - "pattern": "^vpce-[0-9a-f]{17}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AgentArn", - "/properties/EndpointType" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::Agent", - "writeOnlyProperties": [ - "/properties/ActivationKey" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ActivationKey", + "/properties/SecurityGroupArns", + "/properties/SubnetArns", + "/properties/VpcEndpointId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::Agent.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateAgent", + "datasync:TagResource", + "datasync:DescribeAgent", + "datasync:ListTagsForResource", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcEndpoints" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteAgent" + ] + }, + "list": { + "permissions": [ + "datasync:ListAgents" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeAgent", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:UpdateAgent", + "datasync:DescribeAgent", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentArn" + ], + "properties": { + "ActivationKey": { + "description": "Activation key of the Agent.", + "maxLength": 29, + "pattern": "[A-Z0-9]{5}(-[A-Z0-9]{5}){4}", + "type": "string" + }, + "AgentArn": { + "description": "The DataSync Agent ARN.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "AgentName": { + "description": "The name configured for the agent. Text reference used to identify the agent in the console.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + }, + "EndpointType": { + "description": "The service endpoints that the agent will connect to.", + "enum": [ + "FIPS", + "PUBLIC", + "PRIVATE_LINK" + ], + "type": "string" + }, + "SecurityGroupArns": { + "description": "The ARNs of the security group used to protect your data transfer task subnets.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", + "type": "string" + }, + "type": "array" + }, + "SubnetArns": { + "description": "The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$", + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VpcEndpointId": { + "description": "The ID of the VPC endpoint that the agent has access to.", + "pattern": "^vpce-[0-9a-f]{17}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentArn", + "/properties/EndpointType" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::Agent", + "writeOnlyProperties": [ + "/properties/ActivationKey" + ] +} diff --git a/schema/aws-datasync-locationazureblob.json b/schema/aws-datasync-locationazureblob.json index d8914d8..7c58ec2 100644 --- a/schema/aws-datasync-locationazureblob.json +++ b/schema/aws-datasync-locationazureblob.json @@ -1,188 +1,188 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AzureBlobContainerUrl" - ], - "definitions": { - "AzureBlobSasConfiguration": { - "additionalProperties": false, - "description": "Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.", - "properties": { - "AzureBlobSasToken": { - "description": "Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container.", - "maxLength": 255, - "minLength": 1, - "pattern": "(^.+$)", - "type": "string" - } - }, - "required": [ - "AzureBlobSasToken" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationAzureBlob.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationAzureBlob", - "datasync:DescribeLocationAzureBlob", - "datasync:TagResource", - "datasync:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationAzureBlob", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationAzureBlob", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "datasync:UpdateLocationAzureBlob" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "AgentArns": { - "description": "The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "AzureAccessTier": { - "default": "HOT", - "description": "Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.", - "enum": [ - "HOT", - "COOL", - "ARCHIVE" - ], - "type": "string" - }, - "AzureBlobAuthenticationType": { - "default": "SAS", - "description": "The specific authentication type that you want DataSync to use to access your Azure Blob Container.", - "enum": [ - "SAS" - ], - "type": "string" - }, - "AzureBlobContainerUrl": { - "description": "The URL of the Azure Blob container that was described.", - "maxLength": 325, - "pattern": "^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$", - "type": "string" - }, - "AzureBlobSasConfiguration": { - "$ref": "#/definitions/AzureBlobSasConfiguration" - }, - "AzureBlobType": { - "default": "BLOCK", - "description": "Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.", - "enum": [ - "BLOCK" - ], - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Azure Blob Location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the Azure Blob Location that was described.", - "maxLength": 4356, - "pattern": "^(azure-blob)://[a-zA-Z0-9./\\-]+$", - "type": "string" - }, - "Subdirectory": { - "description": "The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.", - "maxLength": 1024, - "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "AzureBlobAuthenticationType", - "AgentArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationAzureBlob", - "writeOnlyProperties": [ - "/properties/Subdirectory", - "/properties/AzureBlobSasConfiguration", - "/properties/AzureBlobContainerUrl" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AzureBlobContainerUrl" + ], + "definitions": { + "AzureBlobSasConfiguration": { + "additionalProperties": false, + "description": "Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.", + "properties": { + "AzureBlobSasToken": { + "description": "Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container.", + "maxLength": 255, + "minLength": 1, + "pattern": "(^.+$)", + "type": "string" + } + }, + "required": [ + "AzureBlobSasToken" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationAzureBlob.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationAzureBlob", + "datasync:DescribeLocationAzureBlob", + "datasync:TagResource", + "datasync:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationAzureBlob", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationAzureBlob", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "datasync:UpdateLocationAzureBlob" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "AgentArns": { + "description": "The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "AzureAccessTier": { + "default": "HOT", + "description": "Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.", + "enum": [ + "HOT", + "COOL", + "ARCHIVE" + ], + "type": "string" + }, + "AzureBlobAuthenticationType": { + "default": "SAS", + "description": "The specific authentication type that you want DataSync to use to access your Azure Blob Container.", + "enum": [ + "SAS" + ], + "type": "string" + }, + "AzureBlobContainerUrl": { + "description": "The URL of the Azure Blob container that was described.", + "maxLength": 325, + "pattern": "^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$", + "type": "string" + }, + "AzureBlobSasConfiguration": { + "$ref": "#/definitions/AzureBlobSasConfiguration" + }, + "AzureBlobType": { + "default": "BLOCK", + "description": "Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.", + "enum": [ + "BLOCK" + ], + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Azure Blob Location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the Azure Blob Location that was described.", + "maxLength": 4356, + "pattern": "^(azure-blob)://[a-zA-Z0-9./\\-]+$", + "type": "string" + }, + "Subdirectory": { + "description": "The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.", + "maxLength": 1024, + "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "AzureBlobAuthenticationType", + "AgentArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationAzureBlob", + "writeOnlyProperties": [ + "/properties/Subdirectory", + "/properties/AzureBlobSasConfiguration", + "/properties/AzureBlobContainerUrl" + ] +} diff --git a/schema/aws-datasync-locationefs.json b/schema/aws-datasync-locationefs.json index f99c009..b8ca4e0 100644 --- a/schema/aws-datasync-locationefs.json +++ b/schema/aws-datasync-locationefs.json @@ -1,190 +1,190 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Ec2Config", - "/properties/EfsFilesystemArn", - "/properties/Subdirectory", - "/properties/FileSystemAccessRoleArn", - "/properties/InTransitEncryption", - "/properties/AccessPointArn" - ], - "definitions": { - "Ec2Config": { - "additionalProperties": false, - "description": "The subnet and security group that DataSync uses to access target EFS file system.", - "properties": { - "SecurityGroupArns": { - "description": "The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SubnetArn": { - "description": "The ARN of the subnet that DataSync uses to access the target EFS file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$", - "type": "string" - } - }, - "required": [ - "SecurityGroupArns", - "SubnetArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationEFS.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationEfs", - "datasync:DescribeLocationEfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeMountTargets", - "elasticfilesystem:DescribeAccessPoints", - "iam:PassRole", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationEfs", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationEfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "AccessPointArn": { - "description": "The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$", - "type": "string" - }, - "Ec2Config": { - "$ref": "#/definitions/Ec2Config" - }, - "EfsFilesystemArn": { - "description": "The Amazon Resource Name (ARN) for the Amazon EFS file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$", - "type": "string" - }, - "FileSystemAccessRoleArn": { - "description": "The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "InTransitEncryption": { - "description": "Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.", - "enum": [ - "NONE", - "TLS1_2" - ], - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the EFS location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-/]+$", - "type": "string" - }, - "Subdirectory": { - "description": "A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "Ec2Config" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationEFS", - "writeOnlyProperties": [ - "/properties/EfsFilesystemArn", - "/properties/Subdirectory" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Ec2Config", + "/properties/EfsFilesystemArn", + "/properties/Subdirectory", + "/properties/FileSystemAccessRoleArn", + "/properties/InTransitEncryption", + "/properties/AccessPointArn" + ], + "definitions": { + "Ec2Config": { + "additionalProperties": false, + "description": "The subnet and security group that DataSync uses to access target EFS file system.", + "properties": { + "SecurityGroupArns": { + "description": "The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SubnetArn": { + "description": "The ARN of the subnet that DataSync uses to access the target EFS file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$", + "type": "string" + } + }, + "required": [ + "SecurityGroupArns", + "SubnetArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationEFS.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationEfs", + "datasync:DescribeLocationEfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeMountTargets", + "elasticfilesystem:DescribeAccessPoints", + "iam:PassRole", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationEfs", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationEfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "AccessPointArn": { + "description": "The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$", + "type": "string" + }, + "Ec2Config": { + "$ref": "#/definitions/Ec2Config" + }, + "EfsFilesystemArn": { + "description": "The Amazon Resource Name (ARN) for the Amazon EFS file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$", + "type": "string" + }, + "FileSystemAccessRoleArn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "InTransitEncryption": { + "description": "Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.", + "enum": [ + "NONE", + "TLS1_2" + ], + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the EFS location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-/]+$", + "type": "string" + }, + "Subdirectory": { + "description": "A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "Ec2Config" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationEFS", + "writeOnlyProperties": [ + "/properties/EfsFilesystemArn", + "/properties/Subdirectory" + ] +} diff --git a/schema/aws-datasync-locationfsxlustre.json b/schema/aws-datasync-locationfsxlustre.json index 245323f..33b2d12 100644 --- a/schema/aws-datasync-locationfsxlustre.json +++ b/schema/aws-datasync-locationfsxlustre.json @@ -1,146 +1,146 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FsxFilesystemArn", - "/properties/SecurityGroupArns", - "/properties/Subdirectory" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationFSxLustre.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationFsxLustre", - "datasync:DescribeLocationFsxLustre", - "datasync:ListTagsForResource", - "datasync:TagResource", - "fsx:DescribeFileSystems", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationFsxLustre", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationFsxLustre", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "FsxFilesystemArn": { - "description": "The Amazon Resource Name (ARN) for the FSx for Lustre file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the FSx for Lustre location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs|fsxl)://[a-zA-Z0-9.:/\\-]+$", - "type": "string" - }, - "SecurityGroupArns": { - "description": "The ARNs of the security groups that are to use to configure the FSx for Lustre file system.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Subdirectory": { - "description": "A subdirectory in the location's path.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "SecurityGroupArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationFSxLustre", - "writeOnlyProperties": [ - "/properties/Subdirectory", - "/properties/FsxFilesystemArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FsxFilesystemArn", + "/properties/SecurityGroupArns", + "/properties/Subdirectory" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationFSxLustre.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationFsxLustre", + "datasync:DescribeLocationFsxLustre", + "datasync:ListTagsForResource", + "datasync:TagResource", + "fsx:DescribeFileSystems", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationFsxLustre", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationFsxLustre", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "FsxFilesystemArn": { + "description": "The Amazon Resource Name (ARN) for the FSx for Lustre file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the FSx for Lustre location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs|fsxl)://[a-zA-Z0-9.:/\\-]+$", + "type": "string" + }, + "SecurityGroupArns": { + "description": "The ARNs of the security groups that are to use to configure the FSx for Lustre file system.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subdirectory": { + "description": "A subdirectory in the location's path.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "SecurityGroupArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationFSxLustre", + "writeOnlyProperties": [ + "/properties/Subdirectory", + "/properties/FsxFilesystemArn" + ] +} diff --git a/schema/aws-datasync-locationfsxontap.json b/schema/aws-datasync-locationfsxontap.json index 3a491a2..9353ea3 100644 --- a/schema/aws-datasync-locationfsxontap.json +++ b/schema/aws-datasync-locationfsxontap.json @@ -1,251 +1,251 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StorageVirtualMachineArn", - "/properties/SecurityGroupArns", - "/properties/Protocol", - "/properties/Subdirectory" - ], - "definitions": { - "NFS": { - "additionalProperties": false, - "description": "NFS protocol configuration for FSx ONTAP file system.", - "properties": { - "MountOptions": { - "$ref": "#/definitions/NfsMountOptions" - } - }, - "required": [ - "MountOptions" - ], - "type": "object" - }, - "NfsMountOptions": { - "additionalProperties": false, - "description": "The NFS mount options that DataSync can use to mount your NFS share.", - "properties": { - "Version": { - "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", - "enum": [ - "AUTOMATIC", - "NFS3", - "NFS4_0", - "NFS4_1" - ], - "type": "string" - } - }, - "type": "object" - }, - "Protocol": { - "additionalProperties": false, - "description": "Configuration settings for NFS or SMB protocol.", - "properties": { - "NFS": { - "$ref": "#/definitions/NFS" - }, - "SMB": { - "$ref": "#/definitions/SMB" - } - }, - "type": "object" - }, - "SMB": { - "additionalProperties": false, - "description": "SMB protocol configuration for FSx ONTAP file system.", - "properties": { - "Domain": { - "description": "The name of the Windows domain that the SMB server belongs to.", - "maxLength": 253, - "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", - "type": "string" - }, - "MountOptions": { - "$ref": "#/definitions/SmbMountOptions" - }, - "Password": { - "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.", - "maxLength": 104, - "pattern": "^.{0,104}$", - "type": "string" - }, - "User": { - "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share.", - "maxLength": 104, - "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", - "type": "string" - } - }, - "required": [ - "User", - "Password", - "MountOptions" - ], - "type": "object" - }, - "SmbMountOptions": { - "additionalProperties": false, - "description": "The mount options used by DataSync to access the SMB server.", - "properties": { - "Version": { - "description": "The specific SMB version that you want DataSync to use to mount your SMB share.", - "enum": [ - "AUTOMATIC", - "SMB2", - "SMB3" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationFSxONTAP.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationFsxOntap", - "datasync:DescribeLocationFsxOntap", - "datasync:ListTagsForResource", - "datasync:TagResource", - "fsx:DescribeStorageVirtualMachines", - "fsx:DescribeFileSystems", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationFsxOntap", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationFsxOntap", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "FsxFilesystemArn": { - "description": "The Amazon Resource Name (ARN) for the FSx ONAP file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the FSx ONTAP file system that was described.", - "maxLength": 4360, - "pattern": "^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\\-]+$", - "type": "string" - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "SecurityGroupArns": { - "description": "The ARNs of the security groups that are to use to configure the FSx ONTAP file system.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "StorageVirtualMachineArn": { - "description": "The Amazon Resource Name (ARN) for the FSx ONTAP SVM.", - "maxLength": 162, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$", - "type": "string" - }, - "Subdirectory": { - "description": "A subdirectory in the location's path.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri", - "/properties/FsxFilesystemArn" - ], - "required": [ - "SecurityGroupArns", - "StorageVirtualMachineArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationFSxONTAP", - "writeOnlyProperties": [ - "/properties/Protocol", - "/properties/Subdirectory" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StorageVirtualMachineArn", + "/properties/SecurityGroupArns", + "/properties/Protocol", + "/properties/Subdirectory" + ], + "definitions": { + "NFS": { + "additionalProperties": false, + "description": "NFS protocol configuration for FSx ONTAP file system.", + "properties": { + "MountOptions": { + "$ref": "#/definitions/NfsMountOptions" + } + }, + "required": [ + "MountOptions" + ], + "type": "object" + }, + "NfsMountOptions": { + "additionalProperties": false, + "description": "The NFS mount options that DataSync can use to mount your NFS share.", + "properties": { + "Version": { + "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", + "enum": [ + "AUTOMATIC", + "NFS3", + "NFS4_0", + "NFS4_1" + ], + "type": "string" + } + }, + "type": "object" + }, + "Protocol": { + "additionalProperties": false, + "description": "Configuration settings for NFS or SMB protocol.", + "properties": { + "NFS": { + "$ref": "#/definitions/NFS" + }, + "SMB": { + "$ref": "#/definitions/SMB" + } + }, + "type": "object" + }, + "SMB": { + "additionalProperties": false, + "description": "SMB protocol configuration for FSx ONTAP file system.", + "properties": { + "Domain": { + "description": "The name of the Windows domain that the SMB server belongs to.", + "maxLength": 253, + "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", + "type": "string" + }, + "MountOptions": { + "$ref": "#/definitions/SmbMountOptions" + }, + "Password": { + "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.", + "maxLength": 104, + "pattern": "^.{0,104}$", + "type": "string" + }, + "User": { + "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share.", + "maxLength": 104, + "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", + "type": "string" + } + }, + "required": [ + "User", + "Password", + "MountOptions" + ], + "type": "object" + }, + "SmbMountOptions": { + "additionalProperties": false, + "description": "The mount options used by DataSync to access the SMB server.", + "properties": { + "Version": { + "description": "The specific SMB version that you want DataSync to use to mount your SMB share.", + "enum": [ + "AUTOMATIC", + "SMB2", + "SMB3" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationFSxONTAP.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationFsxOntap", + "datasync:DescribeLocationFsxOntap", + "datasync:ListTagsForResource", + "datasync:TagResource", + "fsx:DescribeStorageVirtualMachines", + "fsx:DescribeFileSystems", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationFsxOntap", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationFsxOntap", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "FsxFilesystemArn": { + "description": "The Amazon Resource Name (ARN) for the FSx ONAP file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the FSx ONTAP file system that was described.", + "maxLength": 4360, + "pattern": "^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\\-]+$", + "type": "string" + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "SecurityGroupArns": { + "description": "The ARNs of the security groups that are to use to configure the FSx ONTAP file system.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "StorageVirtualMachineArn": { + "description": "The Amazon Resource Name (ARN) for the FSx ONTAP SVM.", + "maxLength": 162, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$", + "type": "string" + }, + "Subdirectory": { + "description": "A subdirectory in the location's path.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri", + "/properties/FsxFilesystemArn" + ], + "required": [ + "SecurityGroupArns", + "StorageVirtualMachineArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationFSxONTAP", + "writeOnlyProperties": [ + "/properties/Protocol", + "/properties/Subdirectory" + ] +} diff --git a/schema/aws-datasync-locationfsxopenzfs.json b/schema/aws-datasync-locationfsxopenzfs.json index 4618f5d..e2bdbd4 100644 --- a/schema/aws-datasync-locationfsxopenzfs.json +++ b/schema/aws-datasync-locationfsxopenzfs.json @@ -1,191 +1,191 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FsxFilesystemArn", - "/properties/SecurityGroupArns", - "/properties/Protocol", - "/properties/Subdirectory" - ], - "definitions": { - "MountOptions": { - "additionalProperties": false, - "description": "The NFS mount options that DataSync can use to mount your NFS share.", - "properties": { - "Version": { - "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", - "enum": [ - "AUTOMATIC", - "NFS3", - "NFS4_0", - "NFS4_1" - ], - "type": "string" - } - }, - "type": "object" - }, - "NFS": { - "additionalProperties": false, - "description": "FSx OpenZFS file system NFS protocol information", - "properties": { - "MountOptions": { - "$ref": "#/definitions/MountOptions" - } - }, - "required": [ - "MountOptions" - ], - "type": "object" - }, - "Protocol": { - "additionalProperties": false, - "description": "Configuration settings for an NFS or SMB protocol, currently only support NFS", - "properties": { - "NFS": { - "$ref": "#/definitions/NFS" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationFSxOpenZFS.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationFsxOpenZfs", - "datasync:DescribeLocationFsxOpenZfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "fsx:DescribeFileSystems", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationFsxOpenZfs", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationFsxOpenZfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "FsxFilesystemArn": { - "description": "The Amazon Resource Name (ARN) for the FSx OpenZFS file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the FSx OpenZFS that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs|fsxl|fsxz)://[a-zA-Z0-9.:/\\-]+$", - "type": "string" - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "SecurityGroupArns": { - "description": "The ARNs of the security groups that are to use to configure the FSx OpenZFS file system.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Subdirectory": { - "description": "A subdirectory in the location's path.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "SecurityGroupArns", - "Protocol" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationFSxOpenZFS", - "writeOnlyProperties": [ - "/properties/Subdirectory", - "/properties/FsxFilesystemArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FsxFilesystemArn", + "/properties/SecurityGroupArns", + "/properties/Protocol", + "/properties/Subdirectory" + ], + "definitions": { + "MountOptions": { + "additionalProperties": false, + "description": "The NFS mount options that DataSync can use to mount your NFS share.", + "properties": { + "Version": { + "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", + "enum": [ + "AUTOMATIC", + "NFS3", + "NFS4_0", + "NFS4_1" + ], + "type": "string" + } + }, + "type": "object" + }, + "NFS": { + "additionalProperties": false, + "description": "FSx OpenZFS file system NFS protocol information", + "properties": { + "MountOptions": { + "$ref": "#/definitions/MountOptions" + } + }, + "required": [ + "MountOptions" + ], + "type": "object" + }, + "Protocol": { + "additionalProperties": false, + "description": "Configuration settings for an NFS or SMB protocol, currently only support NFS", + "properties": { + "NFS": { + "$ref": "#/definitions/NFS" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationFSxOpenZFS.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationFsxOpenZfs", + "datasync:DescribeLocationFsxOpenZfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "fsx:DescribeFileSystems", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationFsxOpenZfs", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationFsxOpenZfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "FsxFilesystemArn": { + "description": "The Amazon Resource Name (ARN) for the FSx OpenZFS file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the FSx OpenZFS that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs|fsxl|fsxz)://[a-zA-Z0-9.:/\\-]+$", + "type": "string" + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "SecurityGroupArns": { + "description": "The ARNs of the security groups that are to use to configure the FSx OpenZFS file system.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subdirectory": { + "description": "A subdirectory in the location's path.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "SecurityGroupArns", + "Protocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationFSxOpenZFS", + "writeOnlyProperties": [ + "/properties/Subdirectory", + "/properties/FsxFilesystemArn" + ] +} diff --git a/schema/aws-datasync-locationfsxwindows.json b/schema/aws-datasync-locationfsxwindows.json index 3775adc..e44f87f 100644 --- a/schema/aws-datasync-locationfsxwindows.json +++ b/schema/aws-datasync-locationfsxwindows.json @@ -1,166 +1,166 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Domain", - "/properties/FsxFilesystemArn", - "/properties/Password", - "/properties/SecurityGroupArns", - "/properties/Subdirectory", - "/properties/User" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationFSxWindows.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationFsxWindows", - "datasync:DescribeLocationFsxWindows", - "datasync:ListTagsForResource", - "datasync:TagResource", - "fsx:DescribeFileSystems", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationFsxWindows", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationFsxWindows", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "Domain": { - "description": "The name of the Windows domain that the FSx for Windows server belongs to.", - "maxLength": 253, - "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", - "type": "string" - }, - "FsxFilesystemArn": { - "description": "The Amazon Resource Name (ARN) for the FSx for Windows file system.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the FSx for Windows location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", - "type": "string" - }, - "Password": { - "description": "The password of the user who has the permissions to access files and folders in the FSx for Windows file system.", - "maxLength": 104, - "pattern": "^.{0,104}$", - "type": "string" - }, - "SecurityGroupArns": { - "description": "The ARNs of the security groups that are to use to configure the FSx for Windows file system.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", - "type": "string" - }, - "type": "array" - }, - "Subdirectory": { - "description": "A subdirectory in the location's path.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "User": { - "description": "The user who has the permissions to access files and folders in the FSx for Windows file system.", - "maxLength": 104, - "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "User", - "SecurityGroupArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationFSxWindows", - "writeOnlyProperties": [ - "/properties/Password", - "/properties/Subdirectory", - "/properties/FsxFilesystemArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Domain", + "/properties/FsxFilesystemArn", + "/properties/Password", + "/properties/SecurityGroupArns", + "/properties/Subdirectory", + "/properties/User" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationFSxWindows.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationFsxWindows", + "datasync:DescribeLocationFsxWindows", + "datasync:ListTagsForResource", + "datasync:TagResource", + "fsx:DescribeFileSystems", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationFsxWindows", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationFsxWindows", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "Domain": { + "description": "The name of the Windows domain that the FSx for Windows server belongs to.", + "maxLength": 253, + "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", + "type": "string" + }, + "FsxFilesystemArn": { + "description": "The Amazon Resource Name (ARN) for the FSx for Windows file system.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the FSx for Windows location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", + "type": "string" + }, + "Password": { + "description": "The password of the user who has the permissions to access files and folders in the FSx for Windows file system.", + "maxLength": 104, + "pattern": "^.{0,104}$", + "type": "string" + }, + "SecurityGroupArns": { + "description": "The ARNs of the security groups that are to use to configure the FSx for Windows file system.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$", + "type": "string" + }, + "type": "array" + }, + "Subdirectory": { + "description": "A subdirectory in the location's path.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "User": { + "description": "The user who has the permissions to access files and folders in the FSx for Windows file system.", + "maxLength": 104, + "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "User", + "SecurityGroupArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationFSxWindows", + "writeOnlyProperties": [ + "/properties/Password", + "/properties/Subdirectory", + "/properties/FsxFilesystemArn" + ] +} diff --git a/schema/aws-datasync-locationhdfs.json b/schema/aws-datasync-locationhdfs.json index e388c09..9617f57 100644 --- a/schema/aws-datasync-locationhdfs.json +++ b/schema/aws-datasync-locationhdfs.json @@ -1,250 +1,250 @@ -{ - "additionalProperties": false, - "definitions": { - "NameNode": { - "additionalProperties": false, - "description": "HDFS Name Node IP and port information.", - "properties": { - "Hostname": { - "description": "The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster.", - "maxLength": 255, - "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", - "type": "string" - }, - "Port": { - "description": "The port on which the Name Node is listening on for client requests.", - "maximum": 65536, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "Hostname", - "Port" - ], - "type": "object" - }, - "QopConfiguration": { - "additionalProperties": false, - "description": "Configuration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.", - "properties": { - "DataTransferProtection": { - "default": "PRIVACY", - "description": "Configuration for Data Transfer Protection.", - "enum": [ - "AUTHENTICATION", - "INTEGRITY", - "PRIVACY", - "DISABLED" - ], - "type": "string" - }, - "RpcProtection": { - "default": "PRIVACY", - "description": "Configuration for RPC Protection.", - "enum": [ - "AUTHENTICATION", - "INTEGRITY", - "PRIVACY", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationHDFS.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationHdfs", - "datasync:DescribeLocationHdfs", - "datasync:TagResource", - "datasync:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationHdfs", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:UpdateLocationHdfs", - "datasync:DescribeLocationHdfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "AgentArns": { - "description": "ARN(s) of the agent(s) to use for an HDFS location.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "AuthenticationType": { - "description": "The authentication mode used to determine identity of user.", - "enum": [ - "SIMPLE", - "KERBEROS" - ], - "type": "string" - }, - "BlockSize": { - "description": "Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.", - "format": "int64", - "maximum": 1073741824, - "minimum": 1048576, - "type": "integer" - }, - "KerberosKeytab": { - "description": "The Base64 string representation of the Keytab file.", - "maxLength": 87384, - "type": "string" - }, - "KerberosKrb5Conf": { - "description": "The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.", - "maxLength": 174764, - "type": "string" - }, - "KerberosPrincipal": { - "description": "The unique identity, or principal, to which Kerberos can assign tickets.", - "maxLength": 256, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "KmsKeyProviderUri": { - "description": "The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.", - "maxLength": 255, - "minLength": 1, - "pattern": "^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the HDFS location.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the HDFS location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs)://[a-zA-Z0-9.:/\\-]+$", - "type": "string" - }, - "NameNodes": { - "description": "An array of Name Node(s) of the HDFS location.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NameNode" - }, - "minItems": 1, - "type": "array" - }, - "QopConfiguration": { - "$ref": "#/definitions/QopConfiguration" - }, - "ReplicationFactor": { - "default": 3, - "description": "Number of copies of each block that exists inside the HDFS cluster.", - "format": "int64", - "maximum": 512, - "minimum": 1, - "type": "integer" - }, - "SimpleUser": { - "description": "The user name that has read and write permissions on the specified HDFS cluster.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[_.A-Za-z0-9][-_.A-Za-z0-9]*$", - "type": "string" - }, - "Subdirectory": { - "description": "The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "NameNodes", - "AuthenticationType", - "AgentArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationHDFS", - "writeOnlyProperties": [ - "/properties/Subdirectory", - "/properties/KerberosKeytab", - "/properties/KerberosKrb5Conf" - ] -} +{ + "additionalProperties": false, + "definitions": { + "NameNode": { + "additionalProperties": false, + "description": "HDFS Name Node IP and port information.", + "properties": { + "Hostname": { + "description": "The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster.", + "maxLength": 255, + "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + }, + "Port": { + "description": "The port on which the Name Node is listening on for client requests.", + "maximum": 65536, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Hostname", + "Port" + ], + "type": "object" + }, + "QopConfiguration": { + "additionalProperties": false, + "description": "Configuration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.", + "properties": { + "DataTransferProtection": { + "default": "PRIVACY", + "description": "Configuration for Data Transfer Protection.", + "enum": [ + "AUTHENTICATION", + "INTEGRITY", + "PRIVACY", + "DISABLED" + ], + "type": "string" + }, + "RpcProtection": { + "default": "PRIVACY", + "description": "Configuration for RPC Protection.", + "enum": [ + "AUTHENTICATION", + "INTEGRITY", + "PRIVACY", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationHDFS.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationHdfs", + "datasync:DescribeLocationHdfs", + "datasync:TagResource", + "datasync:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationHdfs", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:UpdateLocationHdfs", + "datasync:DescribeLocationHdfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "AgentArns": { + "description": "ARN(s) of the agent(s) to use for an HDFS location.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "AuthenticationType": { + "description": "The authentication mode used to determine identity of user.", + "enum": [ + "SIMPLE", + "KERBEROS" + ], + "type": "string" + }, + "BlockSize": { + "description": "Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.", + "format": "int64", + "maximum": 1073741824, + "minimum": 1048576, + "type": "integer" + }, + "KerberosKeytab": { + "description": "The Base64 string representation of the Keytab file.", + "maxLength": 87384, + "type": "string" + }, + "KerberosKrb5Conf": { + "description": "The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.", + "maxLength": 174764, + "type": "string" + }, + "KerberosPrincipal": { + "description": "The unique identity, or principal, to which Kerberos can assign tickets.", + "maxLength": 256, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "KmsKeyProviderUri": { + "description": "The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.", + "maxLength": 255, + "minLength": 1, + "pattern": "^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the HDFS location.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the HDFS location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw|hdfs)://[a-zA-Z0-9.:/\\-]+$", + "type": "string" + }, + "NameNodes": { + "description": "An array of Name Node(s) of the HDFS location.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NameNode" + }, + "minItems": 1, + "type": "array" + }, + "QopConfiguration": { + "$ref": "#/definitions/QopConfiguration" + }, + "ReplicationFactor": { + "default": 3, + "description": "Number of copies of each block that exists inside the HDFS cluster.", + "format": "int64", + "maximum": 512, + "minimum": 1, + "type": "integer" + }, + "SimpleUser": { + "description": "The user name that has read and write permissions on the specified HDFS cluster.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[_.A-Za-z0-9][-_.A-Za-z0-9]*$", + "type": "string" + }, + "Subdirectory": { + "description": "The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "NameNodes", + "AuthenticationType", + "AgentArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationHDFS", + "writeOnlyProperties": [ + "/properties/Subdirectory", + "/properties/KerberosKeytab", + "/properties/KerberosKrb5Conf" + ] +} diff --git a/schema/aws-datasync-locationnfs.json b/schema/aws-datasync-locationnfs.json index 4199dbc..e8839f4 100644 --- a/schema/aws-datasync-locationnfs.json +++ b/schema/aws-datasync-locationnfs.json @@ -1,176 +1,176 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerHostname" - ], - "definitions": { - "MountOptions": { - "additionalProperties": false, - "description": "The NFS mount options that DataSync can use to mount your NFS share.", - "properties": { - "Version": { - "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", - "enum": [ - "AUTOMATIC", - "NFS3", - "NFS4_0", - "NFS4_1" - ], - "type": "string" - } - }, - "type": "object" - }, - "OnPremConfig": { - "additionalProperties": false, - "description": "Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.", - "properties": { - "AgentArns": { - "description": "ARN(s) of the agent(s) to use for an NFS location.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AgentArns" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationNFS", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationNfs", - "datasync:DescribeLocationNfs", - "datasync:ListTagsForResource", - "datasync:TagResource" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationNfs", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationNfs", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "datasync:UpdateLocationNfs" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the NFS location.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the NFS location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", - "type": "string" - }, - "MountOptions": { - "$ref": "#/definitions/MountOptions", - "default": { - "Version": "AUTOMATIC" - } - }, - "OnPremConfig": { - "$ref": "#/definitions/OnPremConfig" - }, - "ServerHostname": { - "description": "The name of the NFS server. This value is the IP address or DNS name of the NFS server.", - "maxLength": 255, - "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", - "type": "string" - }, - "Subdirectory": { - "description": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "OnPremConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationNFS", - "writeOnlyProperties": [ - "/properties/ServerHostname", - "/properties/Subdirectory" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerHostname" + ], + "definitions": { + "MountOptions": { + "additionalProperties": false, + "description": "The NFS mount options that DataSync can use to mount your NFS share.", + "properties": { + "Version": { + "description": "The specific NFS version that you want DataSync to use to mount your NFS share.", + "enum": [ + "AUTOMATIC", + "NFS3", + "NFS4_0", + "NFS4_1" + ], + "type": "string" + } + }, + "type": "object" + }, + "OnPremConfig": { + "additionalProperties": false, + "description": "Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.", + "properties": { + "AgentArns": { + "description": "ARN(s) of the agent(s) to use for an NFS location.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AgentArns" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationNFS", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationNfs", + "datasync:DescribeLocationNfs", + "datasync:ListTagsForResource", + "datasync:TagResource" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationNfs", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationNfs", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "datasync:UpdateLocationNfs" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the NFS location.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the NFS location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", + "type": "string" + }, + "MountOptions": { + "$ref": "#/definitions/MountOptions", + "default": { + "Version": "AUTOMATIC" + } + }, + "OnPremConfig": { + "$ref": "#/definitions/OnPremConfig" + }, + "ServerHostname": { + "description": "The name of the NFS server. This value is the IP address or DNS name of the NFS server.", + "maxLength": 255, + "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + }, + "Subdirectory": { + "description": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "OnPremConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationNFS", + "writeOnlyProperties": [ + "/properties/ServerHostname", + "/properties/Subdirectory" + ] +} diff --git a/schema/aws-datasync-locationobjectstorage.json b/schema/aws-datasync-locationobjectstorage.json index 07c03ef..c68dace 100644 --- a/schema/aws-datasync-locationobjectstorage.json +++ b/schema/aws-datasync-locationobjectstorage.json @@ -1,183 +1,183 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BucketName", - "/properties/ServerHostname" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationObjectStorage.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationObjectStorage", - "datasync:DescribeLocationObjectStorage", - "datasync:ListTagsForResource", - "datasync:TagResource" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationObjectStorage", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationObjectStorage", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "datasync:UpdateLocationObjectStorage" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "AccessKey": { - "description": "Optional. The access key is used if credentials are required to access the self-managed object storage server.", - "maxLength": 200, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "AgentArns": { - "description": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "BucketName": { - "description": "The name of the bucket on the self-managed object storage server.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the object storage location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw|object-storage)://[a-zA-Z0-9./\\-]+$", - "type": "string" - }, - "SecretKey": { - "description": "Optional. The secret key is used if credentials are required to access the self-managed object storage server.", - "maxLength": 200, - "minLength": 8, - "pattern": "^.+$", - "type": "string" - }, - "ServerCertificate": { - "description": "X.509 PEM content containing a certificate authority or chain to trust.", - "maxLength": 32768, - "type": "string" - }, - "ServerHostname": { - "description": "The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.", - "maxLength": 255, - "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", - "type": "string" - }, - "ServerPort": { - "description": "The port that your self-managed server accepts inbound network traffic on.", - "maximum": 65536, - "minimum": 1, - "type": "integer" - }, - "ServerProtocol": { - "description": "The protocol that the object storage server uses to communicate.", - "enum": [ - "HTTPS", - "HTTP" - ], - "type": "string" - }, - "Subdirectory": { - "description": "The subdirectory in the self-managed object storage server that is used to read data from.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "AgentArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationObjectStorage", - "writeOnlyProperties": [ - "/properties/SecretKey", - "/properties/BucketName", - "/properties/ServerHostname", - "/properties/Subdirectory" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BucketName", + "/properties/ServerHostname" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationObjectStorage.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationObjectStorage", + "datasync:DescribeLocationObjectStorage", + "datasync:ListTagsForResource", + "datasync:TagResource" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationObjectStorage", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationObjectStorage", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "datasync:UpdateLocationObjectStorage" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "AccessKey": { + "description": "Optional. The access key is used if credentials are required to access the self-managed object storage server.", + "maxLength": 200, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "AgentArns": { + "description": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "BucketName": { + "description": "The name of the bucket on the self-managed object storage server.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the object storage location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw|object-storage)://[a-zA-Z0-9./\\-]+$", + "type": "string" + }, + "SecretKey": { + "description": "Optional. The secret key is used if credentials are required to access the self-managed object storage server.", + "maxLength": 200, + "minLength": 8, + "pattern": "^.+$", + "type": "string" + }, + "ServerCertificate": { + "description": "X.509 PEM content containing a certificate authority or chain to trust.", + "maxLength": 32768, + "type": "string" + }, + "ServerHostname": { + "description": "The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.", + "maxLength": 255, + "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + }, + "ServerPort": { + "description": "The port that your self-managed server accepts inbound network traffic on.", + "maximum": 65536, + "minimum": 1, + "type": "integer" + }, + "ServerProtocol": { + "description": "The protocol that the object storage server uses to communicate.", + "enum": [ + "HTTPS", + "HTTP" + ], + "type": "string" + }, + "Subdirectory": { + "description": "The subdirectory in the self-managed object storage server that is used to read data from.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "AgentArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationObjectStorage", + "writeOnlyProperties": [ + "/properties/SecretKey", + "/properties/BucketName", + "/properties/ServerHostname", + "/properties/Subdirectory" + ] +} diff --git a/schema/aws-datasync-locations3.json b/schema/aws-datasync-locations3.json index 3f7c2dd..037795e 100644 --- a/schema/aws-datasync-locations3.json +++ b/schema/aws-datasync-locations3.json @@ -1,167 +1,167 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/S3Config", - "/properties/S3StorageClass", - "/properties/Subdirectory", - "/properties/S3BucketArn" - ], - "definitions": { - "S3Config": { - "additionalProperties": false, - "description": "The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.", - "properties": { - "BucketAccessRoleArn": { - "description": "The ARN of the IAM role of the Amazon S3 bucket.", - "maxLength": 2048, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", - "type": "string" - } - }, - "required": [ - "BucketAccessRoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationS3", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationS3", - "datasync:DescribeLocationS3", - "datasync:ListTagsForResource", - "datasync:TagResource", - "s3:ListAllMyBuckets", - "s3:ListBucket", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationS3", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationS3", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket location.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the S3 location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-/]+$", - "type": "string" - }, - "S3BucketArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket.", - "maxLength": 156, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\\-0-9]*:[0-9]*:.*$", - "type": "string" - }, - "S3Config": { - "$ref": "#/definitions/S3Config" - }, - "S3StorageClass": { - "default": "STANDARD", - "description": "The Amazon S3 storage class you want to store your files in when this location is used as a task destination.", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_INSTANT_RETRIEVAL", - "DEEP_ARCHIVE" - ], - "type": "string" - }, - "Subdirectory": { - "description": "A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.", - "maxLength": 1024, - "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "S3Config" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationS3", - "writeOnlyProperties": [ - "/properties/Subdirectory", - "/properties/S3BucketArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/S3Config", + "/properties/S3StorageClass", + "/properties/Subdirectory", + "/properties/S3BucketArn" + ], + "definitions": { + "S3Config": { + "additionalProperties": false, + "description": "The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.", + "properties": { + "BucketAccessRoleArn": { + "description": "The ARN of the IAM role of the Amazon S3 bucket.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + } + }, + "required": [ + "BucketAccessRoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationS3", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationS3", + "datasync:DescribeLocationS3", + "datasync:ListTagsForResource", + "datasync:TagResource", + "s3:ListAllMyBuckets", + "s3:ListBucket", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationS3", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationS3", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket location.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the S3 location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-/]+$", + "type": "string" + }, + "S3BucketArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket.", + "maxLength": 156, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\\-0-9]*:[0-9]*:.*$", + "type": "string" + }, + "S3Config": { + "$ref": "#/definitions/S3Config" + }, + "S3StorageClass": { + "default": "STANDARD", + "description": "The Amazon S3 storage class you want to store your files in when this location is used as a task destination.", + "enum": [ + "STANDARD", + "STANDARD_IA", + "ONEZONE_IA", + "INTELLIGENT_TIERING", + "GLACIER", + "GLACIER_INSTANT_RETRIEVAL", + "DEEP_ARCHIVE" + ], + "type": "string" + }, + "Subdirectory": { + "description": "A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.", + "maxLength": 1024, + "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "S3Config" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationS3", + "writeOnlyProperties": [ + "/properties/Subdirectory", + "/properties/S3BucketArn" + ] +} diff --git a/schema/aws-datasync-locationsmb.json b/schema/aws-datasync-locationsmb.json index bf09fde..cb2539d 100644 --- a/schema/aws-datasync-locationsmb.json +++ b/schema/aws-datasync-locationsmb.json @@ -1,184 +1,184 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerHostname" - ], - "definitions": { - "MountOptions": { - "additionalProperties": false, - "description": "The mount options used by DataSync to access the SMB server.", - "properties": { - "Version": { - "description": "The specific SMB version that you want DataSync to use to mount your SMB share.", - "enum": [ - "AUTOMATIC", - "SMB1", - "SMB2_0", - "SMB2", - "SMB3" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::LocationSMB.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateLocationSmb", - "datasync:DescribeLocationSmb", - "datasync:ListTagsForResource", - "datasync:TagResource" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "datasync:ListLocations" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeLocationSmb", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:DescribeLocationSmb", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "datasync:UpdateLocationSmb" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationArn" - ], - "properties": { - "AgentArns": { - "description": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "Domain": { - "description": "The name of the Windows domain that the SMB server belongs to.", - "maxLength": 253, - "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", - "type": "string" - }, - "LocationArn": { - "description": "The Amazon Resource Name (ARN) of the SMB location that is created.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "LocationUri": { - "description": "The URL of the SMB location that was described.", - "maxLength": 4356, - "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", - "type": "string" - }, - "MountOptions": { - "$ref": "#/definitions/MountOptions", - "default": { - "Version": "AUTOMATIC" - } - }, - "Password": { - "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.", - "maxLength": 104, - "pattern": "^.{0,104}$", - "type": "string" - }, - "ServerHostname": { - "description": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.", - "maxLength": 255, - "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", - "type": "string" - }, - "Subdirectory": { - "description": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "User": { - "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share.", - "maxLength": 104, - "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LocationArn", - "/properties/LocationUri" - ], - "required": [ - "User", - "AgentArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::LocationSMB", - "writeOnlyProperties": [ - "/properties/Password", - "/properties/Subdirectory", - "/properties/ServerHostname" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerHostname" + ], + "definitions": { + "MountOptions": { + "additionalProperties": false, + "description": "The mount options used by DataSync to access the SMB server.", + "properties": { + "Version": { + "description": "The specific SMB version that you want DataSync to use to mount your SMB share.", + "enum": [ + "AUTOMATIC", + "SMB1", + "SMB2_0", + "SMB2", + "SMB3" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::LocationSMB.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateLocationSmb", + "datasync:DescribeLocationSmb", + "datasync:ListTagsForResource", + "datasync:TagResource" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "datasync:ListLocations" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeLocationSmb", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:DescribeLocationSmb", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "datasync:UpdateLocationSmb" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationArn" + ], + "properties": { + "AgentArns": { + "description": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "Domain": { + "description": "The name of the Windows domain that the SMB server belongs to.", + "maxLength": 253, + "pattern": "^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$", + "type": "string" + }, + "LocationArn": { + "description": "The Amazon Resource Name (ARN) of the SMB location that is created.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "LocationUri": { + "description": "The URL of the SMB location that was described.", + "maxLength": 4356, + "pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\\-]+$", + "type": "string" + }, + "MountOptions": { + "$ref": "#/definitions/MountOptions", + "default": { + "Version": "AUTOMATIC" + } + }, + "Password": { + "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.", + "maxLength": 104, + "pattern": "^.{0,104}$", + "type": "string" + }, + "ServerHostname": { + "description": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.", + "maxLength": 255, + "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + }, + "Subdirectory": { + "description": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "User": { + "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share.", + "maxLength": 104, + "pattern": "^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LocationArn", + "/properties/LocationUri" + ], + "required": [ + "User", + "AgentArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::LocationSMB", + "writeOnlyProperties": [ + "/properties/Password", + "/properties/Subdirectory", + "/properties/ServerHostname" + ] +} diff --git a/schema/aws-datasync-storagesystem.json b/schema/aws-datasync-storagesystem.json index 7af305d..9a9e553 100644 --- a/schema/aws-datasync-storagesystem.json +++ b/schema/aws-datasync-storagesystem.json @@ -1,214 +1,214 @@ -{ - "additionalProperties": false, - "definitions": { - "ServerConfiguration": { - "additionalProperties": false, - "description": "The server name and network port required to connect with the management interface of the on-premises storage system.", - "properties": { - "ServerHostname": { - "description": "The domain name or IP address of the storage system's management interface.", - "maxLength": 255, - "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", - "type": "string" - }, - "ServerPort": { - "description": "The network port needed to access the system's management interface", - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "ServerHostname" - ], - "type": "object" - }, - "ServerCredentials": { - "additionalProperties": false, - "description": "The username and password for accessing your on-premises storage system's management interface.", - "properties": { - "Password": { - "description": "The password for your storage system's management interface", - "maxLength": 1024, - "type": "string" - }, - "Username": { - "description": "The username for your storage system's management interface.", - "maxLength": 1024, - "type": "string" - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::StorageSystem.", - "handlers": { - "create": { - "permissions": [ - "datasync:AddStorageSystem", - "datasync:DescribeStorageSystem", - "datasync:ListTagsForResource", - "datasync:TagResource", - "secretsmanager:CreateSecret", - "secretsmanager:DescribeSecret", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "datasync:DescribeStorageSystem", - "datasync:RemoveStorageSystem", - "secretsmanager:DescribeSecret", - "secretsmanager:DeleteSecret" - ] - }, - "list": { - "permissions": [ - "datasync:ListStorageSystems" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeStorageSystem", - "datasync:ListTagsForResource", - "secretsmanager:DescribeSecret" - ] - }, - "update": { - "permissions": [ - "datasync:UpdateStorageSystem", - "datasync:DescribeStorageSystem", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "secretsmanager:DescribeSecret", - "secretsmanager:PutSecretValue" - ] - } - }, - "primaryIdentifier": [ - "/properties/StorageSystemArn" - ], - "properties": { - "AgentArns": { - "description": "The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "CloudWatchLogGroupArn": { - "description": "The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.", - "maxLength": 562, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]+:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$", - "type": "string" - }, - "ConnectivityStatus": { - "description": "Indicates whether the DataSync agent can access the on-premises storage system.", - "enum": [ - "PASS", - "FAIL", - "UNKNOWN" - ], - "type": "string" - }, - "Name": { - "description": "A familiar name for the on-premises storage system.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - }, - "SecretsManagerArn": { - "description": "The ARN of a secret stored by AWS Secrets Manager.", - "maxLength": 2048, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\\-0-9]+:[0-9]{12}:secret:.*", - "type": "string" - }, - "ServerConfiguration": { - "$ref": "#/definitions/ServerConfiguration" - }, - "ServerCredentials": { - "$ref": "#/definitions/ServerCredentials" - }, - "StorageSystemArn": { - "description": "The ARN of the on-premises storage system added to DataSync Discovery.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "SystemType": { - "description": "The type of on-premises storage system that DataSync Discovery will analyze.", - "enum": [ - "NetAppONTAP" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/StorageSystemArn", - "/properties/ConnectivityStatus", - "/properties/SecretsManagerArn" - ], - "required": [ - "ServerConfiguration", - "SystemType", - "AgentArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::StorageSystem", - "writeOnlyProperties": [ - "/properties/ServerCredentials" - ] -} +{ + "additionalProperties": false, + "definitions": { + "ServerConfiguration": { + "additionalProperties": false, + "description": "The server name and network port required to connect with the management interface of the on-premises storage system.", + "properties": { + "ServerHostname": { + "description": "The domain name or IP address of the storage system's management interface.", + "maxLength": 255, + "pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + }, + "ServerPort": { + "description": "The network port needed to access the system's management interface", + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "ServerHostname" + ], + "type": "object" + }, + "ServerCredentials": { + "additionalProperties": false, + "description": "The username and password for accessing your on-premises storage system's management interface.", + "properties": { + "Password": { + "description": "The password for your storage system's management interface", + "maxLength": 1024, + "type": "string" + }, + "Username": { + "description": "The username for your storage system's management interface.", + "maxLength": 1024, + "type": "string" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::StorageSystem.", + "handlers": { + "create": { + "permissions": [ + "datasync:AddStorageSystem", + "datasync:DescribeStorageSystem", + "datasync:ListTagsForResource", + "datasync:TagResource", + "secretsmanager:CreateSecret", + "secretsmanager:DescribeSecret", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "datasync:DescribeStorageSystem", + "datasync:RemoveStorageSystem", + "secretsmanager:DescribeSecret", + "secretsmanager:DeleteSecret" + ] + }, + "list": { + "permissions": [ + "datasync:ListStorageSystems" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeStorageSystem", + "datasync:ListTagsForResource", + "secretsmanager:DescribeSecret" + ] + }, + "update": { + "permissions": [ + "datasync:UpdateStorageSystem", + "datasync:DescribeStorageSystem", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "secretsmanager:DescribeSecret", + "secretsmanager:PutSecretValue" + ] + } + }, + "primaryIdentifier": [ + "/properties/StorageSystemArn" + ], + "properties": { + "AgentArns": { + "description": "The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$", + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "CloudWatchLogGroupArn": { + "description": "The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.", + "maxLength": 562, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]+:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$", + "type": "string" + }, + "ConnectivityStatus": { + "description": "Indicates whether the DataSync agent can access the on-premises storage system.", + "enum": [ + "PASS", + "FAIL", + "UNKNOWN" + ], + "type": "string" + }, + "Name": { + "description": "A familiar name for the on-premises storage system.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + }, + "SecretsManagerArn": { + "description": "The ARN of a secret stored by AWS Secrets Manager.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\\-0-9]+:[0-9]{12}:secret:.*", + "type": "string" + }, + "ServerConfiguration": { + "$ref": "#/definitions/ServerConfiguration" + }, + "ServerCredentials": { + "$ref": "#/definitions/ServerCredentials" + }, + "StorageSystemArn": { + "description": "The ARN of the on-premises storage system added to DataSync Discovery.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "SystemType": { + "description": "The type of on-premises storage system that DataSync Discovery will analyze.", + "enum": [ + "NetAppONTAP" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/StorageSystemArn", + "/properties/ConnectivityStatus", + "/properties/SecretsManagerArn" + ], + "required": [ + "ServerConfiguration", + "SystemType", + "AgentArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::StorageSystem", + "writeOnlyProperties": [ + "/properties/ServerCredentials" + ] +} diff --git a/schema/aws-datasync-task.json b/schema/aws-datasync-task.json index 8cc3bba..1a320ff 100644 --- a/schema/aws-datasync-task.json +++ b/schema/aws-datasync-task.json @@ -1,606 +1,606 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DestinationLocationArn", - "/properties/SourceLocationArn" - ], - "definitions": { - "DestinationNetworkInterfaceArns": { - "description": "The Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.", - "insertionOrder": false, - "items": { - "pattern": "^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$", - "type": "string" - }, - "maxItems": 128, - "type": "array" - }, - "FilterRule": { - "additionalProperties": false, - "description": "Specifies which files folders and objects to include or exclude when transferring files from source to destination.", - "properties": { - "FilterType": { - "description": "The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.", - "enum": [ - "SIMPLE_PATTERN" - ], - "maxLength": 128, - "pattern": "^[A-Z0-9_]+$", - "type": "string" - }, - "Value": { - "description": "A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\".", - "maxLength": 409600, - "pattern": "^[^\\x00]+$", - "type": "string" - } - }, - "type": "object" - }, - "ManifestConfig": { - "additionalProperties": false, - "description": "Configures a manifest, which is a list of files or objects that you want DataSync to transfer.", - "properties": { - "Action": { - "description": "Specifies what DataSync uses the manifest for.", - "enum": [ - "TRANSFER" - ], - "type": "string" - }, - "Format": { - "description": "Specifies the file format of your manifest.", - "enum": [ - "CSV" - ], - "type": "string" - }, - "Source": { - "additionalProperties": false, - "description": "Specifies the manifest that you want DataSync to use and where it's hosted.", - "properties": { - "S3": { - "$ref": "#/definitions/ManifestConfigSourceS3" - } - }, - "type": "object" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "ManifestConfigSourceS3": { - "additionalProperties": false, - "description": "Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.", - "properties": { - "BucketAccessRoleArn": { - "description": "Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.", - "maxLength": 2048, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "ManifestObjectPath": { - "description": "Specifies the Amazon S3 object key of your manifest.", - "maxLength": 1024, - "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", - "type": "string" - }, - "ManifestObjectVersionId": { - "description": "Specifies the object version ID of the manifest that you want DataSync to use.", - "maxLength": 100, - "pattern": "^.+$", - "type": "string" - }, - "S3BucketArn": { - "description": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.", - "maxLength": 156, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", - "type": "string" - } - }, - "type": "object" - }, - "Options": { - "additionalProperties": false, - "description": "Represents the options that are available to control the behavior of a StartTaskExecution operation.", - "properties": { - "Atime": { - "description": "A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).", - "enum": [ - "NONE", - "BEST_EFFORT" - ], - "type": "string" - }, - "BytesPerSecond": { - "description": "A value that limits the bandwidth used by AWS DataSync.", - "format": "int64", - "minimum": -1, - "type": "integer" - }, - "Gid": { - "description": "The group ID (GID) of the file's owners.", - "enum": [ - "NONE", - "INT_VALUE", - "NAME", - "BOTH" - ], - "type": "string" - }, - "LogLevel": { - "description": "A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.", - "enum": [ - "OFF", - "BASIC", - "TRANSFER" - ], - "type": "string" - }, - "Mtime": { - "description": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.", - "enum": [ - "NONE", - "PRESERVE" - ], - "type": "string" - }, - "ObjectTags": { - "description": "A value that determines whether object tags should be read from the source object store and written to the destination object store.", - "enum": [ - "PRESERVE", - "NONE" - ], - "type": "string" - }, - "OverwriteMode": { - "description": "A value that determines whether files at the destination should be overwritten or preserved when copying files.", - "enum": [ - "ALWAYS", - "NEVER" - ], - "type": "string" - }, - "PosixPermissions": { - "description": "A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.", - "enum": [ - "NONE", - "PRESERVE" - ], - "type": "string" - }, - "PreserveDeletedFiles": { - "description": "A value that specifies whether files in the destination that don't exist in the source file system should be preserved.", - "enum": [ - "PRESERVE", - "REMOVE" - ], - "type": "string" - }, - "PreserveDevices": { - "description": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.", - "enum": [ - "NONE", - "PRESERVE" - ], - "type": "string" - }, - "SecurityDescriptorCopyFlags": { - "description": "A value that determines which components of the SMB security descriptor are copied during transfer.", - "enum": [ - "NONE", - "OWNER_DACL", - "OWNER_DACL_SACL" - ], - "type": "string" - }, - "TaskQueueing": { - "description": "A value that determines whether tasks should be queued before executing the tasks.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "TransferMode": { - "description": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.", - "enum": [ - "CHANGED", - "ALL" - ], - "type": "string" - }, - "Uid": { - "description": "The user ID (UID) of the file's owner.", - "enum": [ - "NONE", - "INT_VALUE", - "NAME", - "BOTH" - ], - "type": "string" - }, - "VerifyMode": { - "description": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.", - "enum": [ - "POINT_IN_TIME_CONSISTENT", - "ONLY_FILES_TRANSFERRED", - "NONE" - ], - "type": "string" - } - }, - "type": "object" - }, - "SourceNetworkInterfaceArns": { - "description": "The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.", - "insertionOrder": false, - "items": { - "pattern": "^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$", - "type": "string" - }, - "maxItems": 128, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", - "type": "string" - }, - "Value": { - "description": "The value for an AWS resource tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TaskReportConfig": { - "additionalProperties": false, - "description": "Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.", - "properties": { - "Destination": { - "additionalProperties": false, - "description": "Specifies where DataSync uploads your task report.", - "properties": { - "S3": { - "$ref": "#/definitions/TaskReportConfigDestinationS3" - } - }, - "type": "object" - }, - "ObjectVersionIds": { - "description": "Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.", - "enum": [ - "INCLUDE", - "NONE" - ], - "type": "string" - }, - "OutputType": { - "description": "Specifies the type of task report that you want.", - "enum": [ - "SUMMARY_ONLY", - "STANDARD" - ], - "type": "string" - }, - "Overrides": { - "additionalProperties": false, - "description": "Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.", - "properties": { - "Deleted": { - "additionalProperties": false, - "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.", - "properties": { - "ReportLevel": { - "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", - "enum": [ - "ERRORS_ONLY", - "SUCCESSES_AND_ERRORS" - ], - "type": "string" - } - }, - "type": "object" - }, - "Skipped": { - "additionalProperties": false, - "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.", - "properties": { - "ReportLevel": { - "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", - "enum": [ - "ERRORS_ONLY", - "SUCCESSES_AND_ERRORS" - ], - "type": "string" - } - }, - "type": "object" - }, - "Transferred": { - "additionalProperties": false, - "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.", - "properties": { - "ReportLevel": { - "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", - "enum": [ - "ERRORS_ONLY", - "SUCCESSES_AND_ERRORS" - ], - "type": "string" - } - }, - "type": "object" - }, - "Verified": { - "additionalProperties": false, - "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)", - "properties": { - "ReportLevel": { - "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", - "enum": [ - "ERRORS_ONLY", - "SUCCESSES_AND_ERRORS" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ReportLevel": { - "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", - "enum": [ - "ERRORS_ONLY", - "SUCCESSES_AND_ERRORS" - ], - "type": "string" - } - }, - "required": [ - "Destination", - "OutputType" - ], - "type": "object" - }, - "TaskReportConfigDestinationS3": { - "additionalProperties": false, - "description": "Specifies the Amazon S3 bucket where DataSync uploads your task report.", - "properties": { - "BucketAccessRoleArn": { - "description": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.", - "maxLength": 2048, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "S3BucketArn": { - "description": "Specifies the ARN of the S3 bucket where Datasync uploads your report.", - "maxLength": 156, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", - "type": "string" - }, - "Subdirectory": { - "description": "Specifies a bucket prefix for your report.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", - "type": "string" - } - }, - "type": "object" - }, - "TaskSchedule": { - "additionalProperties": false, - "description": "Specifies the schedule you want your task to use for repeated executions.", - "properties": { - "ScheduleExpression": { - "description": "A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location", - "maxLength": 256, - "pattern": "^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$", - "type": "string" - }, - "Status": { - "description": "Specifies status of a schedule.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::DataSync::Task.", - "handlers": { - "create": { - "permissions": [ - "datasync:CreateTask", - "datasync:DescribeTask", - "datasync:ListTagsForResource", - "datasync:TagResource", - "s3:ListAllMyBuckets", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion", - "ec2:DescribeNetworkInterfaces", - "ec2:CreateNetworkInterface", - "ec2:DeleteNetworkInterface", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:CreateNetworkInterfacePermission", - "fsx:DescribeFileSystems", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeMountTargets", - "logs:DescribeLogGroups", - "iam:GetRole", - "iam:PassRole", - "iam:AssumeRole" - ] - }, - "delete": { - "permissions": [ - "datasync:DeleteTask", - "ec2:DescribeNetworkInterfaces", - "ec2:DeleteNetworkInterface", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "fsx:DescribeFileSystems", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeMountTargets", - "iam:GetRole" - ] - }, - "list": { - "permissions": [ - "datasync:ListTasks" - ] - }, - "read": { - "permissions": [ - "datasync:DescribeTask", - "datasync:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "datasync:UpdateTask", - "datasync:DescribeTask", - "datasync:ListTagsForResource", - "datasync:TagResource", - "datasync:UntagResource", - "logs:DescribeLogGroups", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/TaskArn" - ], - "properties": { - "CloudWatchLogGroupArn": { - "description": "The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.", - "maxLength": 562, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$", - "type": "string" - }, - "DestinationLocationArn": { - "description": "The ARN of an AWS storage resource's location.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "DestinationNetworkInterfaceArns": { - "$ref": "#/definitions/DestinationNetworkInterfaceArns" - }, - "Excludes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FilterRule" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Includes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FilterRule" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "ManifestConfig": { - "$ref": "#/definitions/ManifestConfig" - }, - "Name": { - "description": "The name of a task. This value is a text reference that is used to identify the task in the console.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", - "type": "string" - }, - "Options": { - "$ref": "#/definitions/Options" - }, - "Schedule": { - "$ref": "#/definitions/TaskSchedule" - }, - "SourceLocationArn": { - "description": "The ARN of the source location for the task.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", - "type": "string" - }, - "SourceNetworkInterfaceArns": { - "$ref": "#/definitions/SourceNetworkInterfaceArns" - }, - "Status": { - "description": "The status of the task that was described.", - "enum": [ - "AVAILABLE", - "CREATING", - "QUEUED", - "RUNNING", - "UNAVAILABLE" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TaskArn": { - "description": "The ARN of the task.", - "maxLength": 128, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$", - "type": "string" - }, - "TaskReportConfig": { - "$ref": "#/definitions/TaskReportConfig" - } - }, - "readOnlyProperties": [ - "/properties/TaskArn", - "/properties/Status", - "/properties/SourceNetworkInterfaceArns", - "/properties/DestinationNetworkInterfaceArns" - ], - "required": [ - "DestinationLocationArn", - "SourceLocationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataSync::Task" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DestinationLocationArn", + "/properties/SourceLocationArn" + ], + "definitions": { + "DestinationNetworkInterfaceArns": { + "description": "The Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.", + "insertionOrder": false, + "items": { + "pattern": "^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$", + "type": "string" + }, + "maxItems": 128, + "type": "array" + }, + "FilterRule": { + "additionalProperties": false, + "description": "Specifies which files folders and objects to include or exclude when transferring files from source to destination.", + "properties": { + "FilterType": { + "description": "The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.", + "enum": [ + "SIMPLE_PATTERN" + ], + "maxLength": 128, + "pattern": "^[A-Z0-9_]+$", + "type": "string" + }, + "Value": { + "description": "A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\".", + "maxLength": 409600, + "pattern": "^[^\\x00]+$", + "type": "string" + } + }, + "type": "object" + }, + "ManifestConfig": { + "additionalProperties": false, + "description": "Configures a manifest, which is a list of files or objects that you want DataSync to transfer.", + "properties": { + "Action": { + "description": "Specifies what DataSync uses the manifest for.", + "enum": [ + "TRANSFER" + ], + "type": "string" + }, + "Format": { + "description": "Specifies the file format of your manifest.", + "enum": [ + "CSV" + ], + "type": "string" + }, + "Source": { + "additionalProperties": false, + "description": "Specifies the manifest that you want DataSync to use and where it's hosted.", + "properties": { + "S3": { + "$ref": "#/definitions/ManifestConfigSourceS3" + } + }, + "type": "object" + } + }, + "required": [ + "Source" + ], + "type": "object" + }, + "ManifestConfigSourceS3": { + "additionalProperties": false, + "description": "Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.", + "properties": { + "BucketAccessRoleArn": { + "description": "Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "ManifestObjectPath": { + "description": "Specifies the Amazon S3 object key of your manifest.", + "maxLength": 1024, + "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", + "type": "string" + }, + "ManifestObjectVersionId": { + "description": "Specifies the object version ID of the manifest that you want DataSync to use.", + "maxLength": 100, + "pattern": "^.+$", + "type": "string" + }, + "S3BucketArn": { + "description": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.", + "maxLength": 156, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", + "type": "string" + } + }, + "type": "object" + }, + "Options": { + "additionalProperties": false, + "description": "Represents the options that are available to control the behavior of a StartTaskExecution operation.", + "properties": { + "Atime": { + "description": "A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).", + "enum": [ + "NONE", + "BEST_EFFORT" + ], + "type": "string" + }, + "BytesPerSecond": { + "description": "A value that limits the bandwidth used by AWS DataSync.", + "format": "int64", + "minimum": -1, + "type": "integer" + }, + "Gid": { + "description": "The group ID (GID) of the file's owners.", + "enum": [ + "NONE", + "INT_VALUE", + "NAME", + "BOTH" + ], + "type": "string" + }, + "LogLevel": { + "description": "A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.", + "enum": [ + "OFF", + "BASIC", + "TRANSFER" + ], + "type": "string" + }, + "Mtime": { + "description": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.", + "enum": [ + "NONE", + "PRESERVE" + ], + "type": "string" + }, + "ObjectTags": { + "description": "A value that determines whether object tags should be read from the source object store and written to the destination object store.", + "enum": [ + "PRESERVE", + "NONE" + ], + "type": "string" + }, + "OverwriteMode": { + "description": "A value that determines whether files at the destination should be overwritten or preserved when copying files.", + "enum": [ + "ALWAYS", + "NEVER" + ], + "type": "string" + }, + "PosixPermissions": { + "description": "A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.", + "enum": [ + "NONE", + "PRESERVE" + ], + "type": "string" + }, + "PreserveDeletedFiles": { + "description": "A value that specifies whether files in the destination that don't exist in the source file system should be preserved.", + "enum": [ + "PRESERVE", + "REMOVE" + ], + "type": "string" + }, + "PreserveDevices": { + "description": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.", + "enum": [ + "NONE", + "PRESERVE" + ], + "type": "string" + }, + "SecurityDescriptorCopyFlags": { + "description": "A value that determines which components of the SMB security descriptor are copied during transfer.", + "enum": [ + "NONE", + "OWNER_DACL", + "OWNER_DACL_SACL" + ], + "type": "string" + }, + "TaskQueueing": { + "description": "A value that determines whether tasks should be queued before executing the tasks.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "TransferMode": { + "description": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.", + "enum": [ + "CHANGED", + "ALL" + ], + "type": "string" + }, + "Uid": { + "description": "The user ID (UID) of the file's owner.", + "enum": [ + "NONE", + "INT_VALUE", + "NAME", + "BOTH" + ], + "type": "string" + }, + "VerifyMode": { + "description": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.", + "enum": [ + "POINT_IN_TIME_CONSISTENT", + "ONLY_FILES_TRANSFERRED", + "NONE" + ], + "type": "string" + } + }, + "type": "object" + }, + "SourceNetworkInterfaceArns": { + "description": "The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.", + "insertionOrder": false, + "items": { + "pattern": "^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$", + "type": "string" + }, + "maxItems": 128, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:/-]+$", + "type": "string" + }, + "Value": { + "description": "The value for an AWS resource tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TaskReportConfig": { + "additionalProperties": false, + "description": "Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.", + "properties": { + "Destination": { + "additionalProperties": false, + "description": "Specifies where DataSync uploads your task report.", + "properties": { + "S3": { + "$ref": "#/definitions/TaskReportConfigDestinationS3" + } + }, + "type": "object" + }, + "ObjectVersionIds": { + "description": "Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.", + "enum": [ + "INCLUDE", + "NONE" + ], + "type": "string" + }, + "OutputType": { + "description": "Specifies the type of task report that you want.", + "enum": [ + "SUMMARY_ONLY", + "STANDARD" + ], + "type": "string" + }, + "Overrides": { + "additionalProperties": false, + "description": "Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.", + "properties": { + "Deleted": { + "additionalProperties": false, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.", + "properties": { + "ReportLevel": { + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", + "enum": [ + "ERRORS_ONLY", + "SUCCESSES_AND_ERRORS" + ], + "type": "string" + } + }, + "type": "object" + }, + "Skipped": { + "additionalProperties": false, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.", + "properties": { + "ReportLevel": { + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", + "enum": [ + "ERRORS_ONLY", + "SUCCESSES_AND_ERRORS" + ], + "type": "string" + } + }, + "type": "object" + }, + "Transferred": { + "additionalProperties": false, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.", + "properties": { + "ReportLevel": { + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", + "enum": [ + "ERRORS_ONLY", + "SUCCESSES_AND_ERRORS" + ], + "type": "string" + } + }, + "type": "object" + }, + "Verified": { + "additionalProperties": false, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)", + "properties": { + "ReportLevel": { + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", + "enum": [ + "ERRORS_ONLY", + "SUCCESSES_AND_ERRORS" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ReportLevel": { + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.", + "enum": [ + "ERRORS_ONLY", + "SUCCESSES_AND_ERRORS" + ], + "type": "string" + } + }, + "required": [ + "Destination", + "OutputType" + ], + "type": "object" + }, + "TaskReportConfigDestinationS3": { + "additionalProperties": false, + "description": "Specifies the Amazon S3 bucket where DataSync uploads your task report.", + "properties": { + "BucketAccessRoleArn": { + "description": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "S3BucketArn": { + "description": "Specifies the ARN of the S3 bucket where Datasync uploads your report.", + "maxLength": 156, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", + "type": "string" + }, + "Subdirectory": { + "description": "Specifies a bucket prefix for your report.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", + "type": "string" + } + }, + "type": "object" + }, + "TaskSchedule": { + "additionalProperties": false, + "description": "Specifies the schedule you want your task to use for repeated executions.", + "properties": { + "ScheduleExpression": { + "description": "A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location", + "maxLength": 256, + "pattern": "^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$", + "type": "string" + }, + "Status": { + "description": "Specifies status of a schedule.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::DataSync::Task.", + "handlers": { + "create": { + "permissions": [ + "datasync:CreateTask", + "datasync:DescribeTask", + "datasync:ListTagsForResource", + "datasync:TagResource", + "s3:ListAllMyBuckets", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion", + "ec2:DescribeNetworkInterfaces", + "ec2:CreateNetworkInterface", + "ec2:DeleteNetworkInterface", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:CreateNetworkInterfacePermission", + "fsx:DescribeFileSystems", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeMountTargets", + "logs:DescribeLogGroups", + "iam:GetRole", + "iam:PassRole", + "iam:AssumeRole" + ] + }, + "delete": { + "permissions": [ + "datasync:DeleteTask", + "ec2:DescribeNetworkInterfaces", + "ec2:DeleteNetworkInterface", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "fsx:DescribeFileSystems", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeMountTargets", + "iam:GetRole" + ] + }, + "list": { + "permissions": [ + "datasync:ListTasks" + ] + }, + "read": { + "permissions": [ + "datasync:DescribeTask", + "datasync:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "datasync:UpdateTask", + "datasync:DescribeTask", + "datasync:ListTagsForResource", + "datasync:TagResource", + "datasync:UntagResource", + "logs:DescribeLogGroups", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/TaskArn" + ], + "properties": { + "CloudWatchLogGroupArn": { + "description": "The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.", + "maxLength": 562, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$", + "type": "string" + }, + "DestinationLocationArn": { + "description": "The ARN of an AWS storage resource's location.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "DestinationNetworkInterfaceArns": { + "$ref": "#/definitions/DestinationNetworkInterfaceArns" + }, + "Excludes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterRule" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Includes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterRule" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "ManifestConfig": { + "$ref": "#/definitions/ManifestConfig" + }, + "Name": { + "description": "The name of a task. This value is a text reference that is used to identify the task in the console.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", + "type": "string" + }, + "Options": { + "$ref": "#/definitions/Options" + }, + "Schedule": { + "$ref": "#/definitions/TaskSchedule" + }, + "SourceLocationArn": { + "description": "The ARN of the source location for the task.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$", + "type": "string" + }, + "SourceNetworkInterfaceArns": { + "$ref": "#/definitions/SourceNetworkInterfaceArns" + }, + "Status": { + "description": "The status of the task that was described.", + "enum": [ + "AVAILABLE", + "CREATING", + "QUEUED", + "RUNNING", + "UNAVAILABLE" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TaskArn": { + "description": "The ARN of the task.", + "maxLength": 128, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$", + "type": "string" + }, + "TaskReportConfig": { + "$ref": "#/definitions/TaskReportConfig" + } + }, + "readOnlyProperties": [ + "/properties/TaskArn", + "/properties/Status", + "/properties/SourceNetworkInterfaceArns", + "/properties/DestinationNetworkInterfaceArns" + ], + "required": [ + "DestinationLocationArn", + "SourceLocationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datasync.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataSync::Task" +} diff --git a/schema/aws-datazone-datasource.json b/schema/aws-datazone-datasource.json index 993337a..94ac17c 100644 --- a/schema/aws-datazone-datasource.json +++ b/schema/aws-datazone-datasource.json @@ -1,543 +1,543 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EnvironmentIdentifier", - "/properties/DomainIdentifier", - "/properties/ProjectIdentifier", - "/properties/Type" - ], - "definitions": { - "AccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d{12}$", - "type": "string" - }, - "DataAccessRole": { - "description": "The data access role included in the configuration details of the AWS Glue data source.", - "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$", - "type": "string" - }, - "DataSourceConfigurationInput": { - "description": "Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "GlueRunConfiguration": { - "$ref": "#/definitions/GlueRunConfigurationInput" - } - }, - "title": "GlueRunConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "RedshiftRunConfiguration": { - "$ref": "#/definitions/RedshiftRunConfigurationInput" - } - }, - "title": "RedshiftRunConfiguration", - "type": "object" - } - ] - }, - "DataSourceStatus": { - "description": "The status of the data source.", - "enum": [ - "CREATING", - "FAILED_CREATION", - "READY", - "UPDATING", - "FAILED_UPDATE", - "RUNNING", - "DELETING", - "FAILED_DELETION" - ], - "type": "string" - }, - "EnableSetting": { - "description": "Specifies whether the data source is enabled.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "FilterExpression": { - "additionalProperties": false, - "description": "The search filter expression.", - "properties": { - "Expression": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FilterExpressionType" - } - }, - "required": [ - "Expression", - "Type" - ], - "type": "object" - }, - "FilterExpressionType": { - "description": "The search filter expression type.", - "enum": [ - "INCLUDE", - "EXCLUDE" - ], - "type": "string" - }, - "FormInput": { - "additionalProperties": false, - "description": "The details of a metadata form.", - "properties": { - "Content": { - "description": "The content of the metadata form.", - "maxLength": 75000, - "type": "string" - }, - "FormName": { - "$ref": "#/definitions/FormName", - "description": "The name of the metadata form." - }, - "TypeIdentifier": { - "description": "The ID of the metadata form type.", - "maxLength": 385, - "minLength": 1, - "pattern": "^(?!\\.)[\\w\\.]*\\w$", - "type": "string" - }, - "TypeRevision": { - "$ref": "#/definitions/TypeRevision", - "description": "The revision of the metadata form type." - } - }, - "required": [ - "FormName" - ], - "type": "object" - }, - "FormName": { - "description": "The name of the metadata form.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", - "type": "string" - }, - "GlueRunConfigurationInput": { - "additionalProperties": false, - "properties": { - "AutoImportDataQualityResult": { - "description": "Specifies whether to automatically import data quality metrics as part of the data source run.", - "type": "boolean" - }, - "DataAccessRole": { - "$ref": "#/definitions/DataAccessRole", - "description": "The data access role included in the configuration details of the AWS Glue data source." - }, - "RelationalFilterConfigurations": { - "description": "The relational filter configurations included in the configuration details of the AWS Glue data source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RelationalFilterConfiguration" - }, - "type": "array" - } - }, - "required": [ - "RelationalFilterConfigurations" - ], - "type": "object" - }, - "RecommendationConfiguration": { - "additionalProperties": false, - "description": "The recommendation to be updated as part of the UpdateDataSource action.", - "properties": { - "EnableBusinessNameGeneration": { - "description": "Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.", - "type": "boolean" - } - }, - "type": "object" - }, - "RedshiftClusterStorage": { - "additionalProperties": false, - "description": "The name of an Amazon Redshift cluster.", - "properties": { - "ClusterName": { - "description": "The name of an Amazon Redshift cluster.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[0-9a-z].[a-z0-9\\-]*$", - "type": "string" - } - }, - "required": [ - "ClusterName" - ], - "type": "object" - }, - "RedshiftCredentialConfiguration": { - "additionalProperties": false, - "description": "The ARN of a secret manager for an Amazon Redshift cluster.", - "properties": { - "SecretManagerArn": { - "description": "The ARN of a secret manager for an Amazon Redshift cluster.", - "maxLength": 256, - "pattern": "^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$", - "type": "string" - } - }, - "required": [ - "SecretManagerArn" - ], - "type": "object" - }, - "RedshiftRunConfigurationInput": { - "additionalProperties": false, - "description": "The configuration details of the Amazon Redshift data source.", - "properties": { - "DataAccessRole": { - "$ref": "#/definitions/DataAccessRole", - "description": "The data access role included in the configuration details of the Amazon Redshift data source." - }, - "RedshiftCredentialConfiguration": { - "$ref": "#/definitions/RedshiftCredentialConfiguration", - "description": "The details of the credentials required to access an Amazon Redshift cluster." - }, - "RedshiftStorage": { - "$ref": "#/definitions/RedshiftStorage", - "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run." - }, - "RelationalFilterConfigurations": { - "$ref": "#/definitions/RelationalFilterConfigurations" - } - }, - "required": [ - "RedshiftCredentialConfiguration", - "RedshiftStorage", - "RelationalFilterConfigurations" - ], - "type": "object" - }, - "RedshiftServerlessStorage": { - "additionalProperties": false, - "description": "The details of the Amazon Redshift Serverless workgroup storage.", - "properties": { - "WorkgroupName": { - "description": "The name of the Amazon Redshift Serverless workgroup.", - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9-]+$", - "type": "string" - } - }, - "required": [ - "WorkgroupName" - ], - "type": "object" - }, - "RedshiftStorage": { - "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.", - "oneOf": [ - { - "additionalProperties": false, - "description": "The details of the Amazon Redshift cluster source.", - "properties": { - "RedshiftClusterSource": { - "$ref": "#/definitions/RedshiftClusterStorage" - } - }, - "required": [ - "RedshiftClusterSource" - ], - "title": "RedshiftClusterSource", - "type": "object" - }, - { - "additionalProperties": false, - "description": "The details of the Amazon Redshift Serverless workgroup source.", - "properties": { - "RedshiftServerlessSource": { - "$ref": "#/definitions/RedshiftServerlessStorage" - } - }, - "required": [ - "RedshiftServerlessSource" - ], - "title": "RedshiftServerlessSource", - "type": "object" - } - ] - }, - "Region": { - "maxLength": 16, - "minLength": 4, - "pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]", - "type": "string" - }, - "RelationalFilterConfiguration": { - "additionalProperties": false, - "description": "The relational filter configuration for the data source.", - "properties": { - "DatabaseName": { - "description": "The database name specified in the relational filter configuration for the data source.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "FilterExpressions": { - "description": "The filter expressions specified in the relational filter configuration for the data source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FilterExpression" - }, - "type": "array" - }, - "SchemaName": { - "description": "The schema name specified in the relational filter configuration for the data source.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DatabaseName" - ], - "type": "object" - }, - "RelationalFilterConfigurations": { - "description": "The relational filter configurations included in the configuration details of the Amazon Redshift data source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RelationalFilterConfiguration" - }, - "type": "array" - }, - "ScheduleConfiguration": { - "additionalProperties": false, - "description": "The schedule of the data source runs.", - "properties": { - "Schedule": { - "description": "The schedule of the data source runs.", - "maxLength": 256, - "minLength": 1, - "pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\\)", - "type": "string" - }, - "Timezone": { - "$ref": "#/definitions/Timezone", - "description": "The timezone of the data source run." - } - }, - "type": "object" - }, - "Timezone": { - "type": "string" - }, - "TypeRevision": { - "description": "The revision of the metadata form type.", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "description": "A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. ", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateDataSource", - "iam:PassRole", - "datazone:GetDataSource", - "datazone:DeleteDataSource" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteDataSource", - "datazone:GetDataSource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - }, - "ProjectIdentifier": { - "$ref": "resource-schema.json#/properties/ProjectIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:ListDataSources" - ] - }, - "read": { - "permissions": [ - "datazone:GetDataSource" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateDataSource", - "datazone:GetDataSource", - "datazone:DeleteDataSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "AssetFormsInput": { - "description": "The metadata forms that are to be attached to the assets that this data source works with.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FormInput" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Configuration": { - "$ref": "#/definitions/DataSourceConfigurationInput", - "description": "Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration." - }, - "CreatedAt": { - "description": "The timestamp of when the data source was created.", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "The description of the data source.", - "maxLength": 2048, - "type": "string" - }, - "DomainId": { - "description": "The ID of the Amazon DataZone domain where the data source is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The ID of the Amazon DataZone domain where the data source is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnableSetting": { - "$ref": "#/definitions/EnableSetting", - "description": "Specifies whether the data source is enabled." - }, - "EnvironmentId": { - "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentIdentifier": { - "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", - "type": "string" - }, - "Id": { - "description": "The unique identifier of the data source.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "LastRunAssetCount": { - "description": "The number of assets created by the data source during its last run.", - "type": "number" - }, - "LastRunAt": { - "description": "The timestamp that specifies when the data source was last run.", - "type": "string" - }, - "LastRunStatus": { - "description": "The status of the last run of this data source.", - "type": "string" - }, - "Name": { - "description": "The name of the data source.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ProjectId": { - "description": "The ID of the Amazon DataZone project to which the data source is added.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "ProjectIdentifier": { - "description": "The identifier of the Amazon DataZone project in which you want to add the data source.", - "type": "string" - }, - "PublishOnImport": { - "description": "Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.", - "type": "boolean" - }, - "Recommendation": { - "$ref": "#/definitions/RecommendationConfiguration", - "description": "Specifies whether the business name generation is to be enabled for this data source." - }, - "Schedule": { - "$ref": "#/definitions/ScheduleConfiguration", - "description": "The schedule of the data source runs." - }, - "Status": { - "$ref": "#/definitions/DataSourceStatus", - "description": "The status of the data source." - }, - "Type": { - "description": "The type of the data source.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "UpdatedAt": { - "description": "The timestamp of when this data source was updated.", - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/DomainId", - "/properties/EnvironmentId", - "/properties/Id", - "/properties/LastRunAssetCount", - "/properties/LastRunAt", - "/properties/LastRunStatus", - "/properties/ProjectId", - "/properties/Status", - "/properties/UpdatedAt" - ], - "required": [ - "Name", - "DomainIdentifier", - "ProjectIdentifier", - "EnvironmentIdentifier", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::DataSource", - "writeOnlyProperties": [ - "/properties/AssetFormsInput", - "/properties/EnvironmentIdentifier", - "/properties/DomainIdentifier", - "/properties/Configuration", - "/properties/ProjectIdentifier" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EnvironmentIdentifier", + "/properties/DomainIdentifier", + "/properties/ProjectIdentifier", + "/properties/Type" + ], + "definitions": { + "AccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d{12}$", + "type": "string" + }, + "DataAccessRole": { + "description": "The data access role included in the configuration details of the AWS Glue data source.", + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$", + "type": "string" + }, + "DataSourceConfigurationInput": { + "description": "Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "GlueRunConfiguration": { + "$ref": "#/definitions/GlueRunConfigurationInput" + } + }, + "title": "GlueRunConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "RedshiftRunConfiguration": { + "$ref": "#/definitions/RedshiftRunConfigurationInput" + } + }, + "title": "RedshiftRunConfiguration", + "type": "object" + } + ] + }, + "DataSourceStatus": { + "description": "The status of the data source.", + "enum": [ + "CREATING", + "FAILED_CREATION", + "READY", + "UPDATING", + "FAILED_UPDATE", + "RUNNING", + "DELETING", + "FAILED_DELETION" + ], + "type": "string" + }, + "EnableSetting": { + "description": "Specifies whether the data source is enabled.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "FilterExpression": { + "additionalProperties": false, + "description": "The search filter expression.", + "properties": { + "Expression": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FilterExpressionType" + } + }, + "required": [ + "Expression", + "Type" + ], + "type": "object" + }, + "FilterExpressionType": { + "description": "The search filter expression type.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "type": "string" + }, + "FormInput": { + "additionalProperties": false, + "description": "The details of a metadata form.", + "properties": { + "Content": { + "description": "The content of the metadata form.", + "maxLength": 75000, + "type": "string" + }, + "FormName": { + "$ref": "#/definitions/FormName", + "description": "The name of the metadata form." + }, + "TypeIdentifier": { + "description": "The ID of the metadata form type.", + "maxLength": 385, + "minLength": 1, + "pattern": "^(?!\\.)[\\w\\.]*\\w$", + "type": "string" + }, + "TypeRevision": { + "$ref": "#/definitions/TypeRevision", + "description": "The revision of the metadata form type." + } + }, + "required": [ + "FormName" + ], + "type": "object" + }, + "FormName": { + "description": "The name of the metadata form.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", + "type": "string" + }, + "GlueRunConfigurationInput": { + "additionalProperties": false, + "properties": { + "AutoImportDataQualityResult": { + "description": "Specifies whether to automatically import data quality metrics as part of the data source run.", + "type": "boolean" + }, + "DataAccessRole": { + "$ref": "#/definitions/DataAccessRole", + "description": "The data access role included in the configuration details of the AWS Glue data source." + }, + "RelationalFilterConfigurations": { + "description": "The relational filter configurations included in the configuration details of the AWS Glue data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RelationalFilterConfiguration" + }, + "type": "array" + } + }, + "required": [ + "RelationalFilterConfigurations" + ], + "type": "object" + }, + "RecommendationConfiguration": { + "additionalProperties": false, + "description": "The recommendation to be updated as part of the UpdateDataSource action.", + "properties": { + "EnableBusinessNameGeneration": { + "description": "Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.", + "type": "boolean" + } + }, + "type": "object" + }, + "RedshiftClusterStorage": { + "additionalProperties": false, + "description": "The name of an Amazon Redshift cluster.", + "properties": { + "ClusterName": { + "description": "The name of an Amazon Redshift cluster.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[0-9a-z].[a-z0-9\\-]*$", + "type": "string" + } + }, + "required": [ + "ClusterName" + ], + "type": "object" + }, + "RedshiftCredentialConfiguration": { + "additionalProperties": false, + "description": "The ARN of a secret manager for an Amazon Redshift cluster.", + "properties": { + "SecretManagerArn": { + "description": "The ARN of a secret manager for an Amazon Redshift cluster.", + "maxLength": 256, + "pattern": "^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$", + "type": "string" + } + }, + "required": [ + "SecretManagerArn" + ], + "type": "object" + }, + "RedshiftRunConfigurationInput": { + "additionalProperties": false, + "description": "The configuration details of the Amazon Redshift data source.", + "properties": { + "DataAccessRole": { + "$ref": "#/definitions/DataAccessRole", + "description": "The data access role included in the configuration details of the Amazon Redshift data source." + }, + "RedshiftCredentialConfiguration": { + "$ref": "#/definitions/RedshiftCredentialConfiguration", + "description": "The details of the credentials required to access an Amazon Redshift cluster." + }, + "RedshiftStorage": { + "$ref": "#/definitions/RedshiftStorage", + "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run." + }, + "RelationalFilterConfigurations": { + "$ref": "#/definitions/RelationalFilterConfigurations" + } + }, + "required": [ + "RedshiftCredentialConfiguration", + "RedshiftStorage", + "RelationalFilterConfigurations" + ], + "type": "object" + }, + "RedshiftServerlessStorage": { + "additionalProperties": false, + "description": "The details of the Amazon Redshift Serverless workgroup storage.", + "properties": { + "WorkgroupName": { + "description": "The name of the Amazon Redshift Serverless workgroup.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]+$", + "type": "string" + } + }, + "required": [ + "WorkgroupName" + ], + "type": "object" + }, + "RedshiftStorage": { + "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.", + "oneOf": [ + { + "additionalProperties": false, + "description": "The details of the Amazon Redshift cluster source.", + "properties": { + "RedshiftClusterSource": { + "$ref": "#/definitions/RedshiftClusterStorage" + } + }, + "required": [ + "RedshiftClusterSource" + ], + "title": "RedshiftClusterSource", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The details of the Amazon Redshift Serverless workgroup source.", + "properties": { + "RedshiftServerlessSource": { + "$ref": "#/definitions/RedshiftServerlessStorage" + } + }, + "required": [ + "RedshiftServerlessSource" + ], + "title": "RedshiftServerlessSource", + "type": "object" + } + ] + }, + "Region": { + "maxLength": 16, + "minLength": 4, + "pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]", + "type": "string" + }, + "RelationalFilterConfiguration": { + "additionalProperties": false, + "description": "The relational filter configuration for the data source.", + "properties": { + "DatabaseName": { + "description": "The database name specified in the relational filter configuration for the data source.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "FilterExpressions": { + "description": "The filter expressions specified in the relational filter configuration for the data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterExpression" + }, + "type": "array" + }, + "SchemaName": { + "description": "The schema name specified in the relational filter configuration for the data source.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DatabaseName" + ], + "type": "object" + }, + "RelationalFilterConfigurations": { + "description": "The relational filter configurations included in the configuration details of the Amazon Redshift data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RelationalFilterConfiguration" + }, + "type": "array" + }, + "ScheduleConfiguration": { + "additionalProperties": false, + "description": "The schedule of the data source runs.", + "properties": { + "Schedule": { + "description": "The schedule of the data source runs.", + "maxLength": 256, + "minLength": 1, + "pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\\)", + "type": "string" + }, + "Timezone": { + "$ref": "#/definitions/Timezone", + "description": "The timezone of the data source run." + } + }, + "type": "object" + }, + "Timezone": { + "type": "string" + }, + "TypeRevision": { + "description": "The revision of the metadata form type.", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "description": "A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. ", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateDataSource", + "iam:PassRole", + "datazone:GetDataSource", + "datazone:DeleteDataSource" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteDataSource", + "datazone:GetDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListDataSources" + ] + }, + "read": { + "permissions": [ + "datazone:GetDataSource" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateDataSource", + "datazone:GetDataSource", + "datazone:DeleteDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AssetFormsInput": { + "description": "The metadata forms that are to be attached to the assets that this data source works with.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FormInput" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Configuration": { + "$ref": "#/definitions/DataSourceConfigurationInput", + "description": "Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration." + }, + "CreatedAt": { + "description": "The timestamp of when the data source was created.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "The description of the data source.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain where the data source is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain where the data source is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnableSetting": { + "$ref": "#/definitions/EnableSetting", + "description": "Specifies whether the data source is enabled." + }, + "EnvironmentId": { + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentIdentifier": { + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", + "type": "string" + }, + "Id": { + "description": "The unique identifier of the data source.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "LastRunAssetCount": { + "description": "The number of assets created by the data source during its last run.", + "type": "number" + }, + "LastRunAt": { + "description": "The timestamp that specifies when the data source was last run.", + "type": "string" + }, + "LastRunStatus": { + "description": "The status of the last run of this data source.", + "type": "string" + }, + "Name": { + "description": "The name of the data source.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ProjectId": { + "description": "The ID of the Amazon DataZone project to which the data source is added.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The identifier of the Amazon DataZone project in which you want to add the data source.", + "type": "string" + }, + "PublishOnImport": { + "description": "Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.", + "type": "boolean" + }, + "Recommendation": { + "$ref": "#/definitions/RecommendationConfiguration", + "description": "Specifies whether the business name generation is to be enabled for this data source." + }, + "Schedule": { + "$ref": "#/definitions/ScheduleConfiguration", + "description": "The schedule of the data source runs." + }, + "Status": { + "$ref": "#/definitions/DataSourceStatus", + "description": "The status of the data source." + }, + "Type": { + "description": "The type of the data source.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when this data source was updated.", + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id", + "/properties/LastRunAssetCount", + "/properties/LastRunAt", + "/properties/LastRunStatus", + "/properties/ProjectId", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "Name", + "DomainIdentifier", + "ProjectIdentifier", + "EnvironmentIdentifier", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::DataSource", + "writeOnlyProperties": [ + "/properties/AssetFormsInput", + "/properties/EnvironmentIdentifier", + "/properties/DomainIdentifier", + "/properties/Configuration", + "/properties/ProjectIdentifier" + ] +} diff --git a/schema/aws-datazone-domain.json b/schema/aws-datazone-domain.json index c48a3f3..33d5087 100644 --- a/schema/aws-datazone-domain.json +++ b/schema/aws-datazone-domain.json @@ -1,209 +1,215 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyIdentifier" - ], - "definitions": { - "AuthType": { - "description": "The type of single sign-on in Amazon DataZone.", - "enum": [ - "IAM_IDC", - "DISABLED" - ], - "type": "string" - }, - "DomainStatus": { - "description": "The status of the Amazon DataZone domain.", - "enum": [ - "CREATING", - "AVAILABLE", - "CREATION_FAILED", - "DELETING", - "DELETED", - "DELETION_FAILED" - ], - "type": "string" - }, - "SingleSignOn": { - "additionalProperties": false, - "description": "The single-sign on configuration of the Amazon DataZone domain.", - "properties": { - "Type": { - "$ref": "#/definitions/AuthType" - }, - "UserAssignment": { - "$ref": "#/definitions/UserAssignment" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with the domain.", - "properties": { - "Key": { - "description": "The key name of the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UserAssignment": { - "description": "The single sign-on user assignment in Amazon DataZone.", - "enum": [ - "AUTOMATIC", - "MANUAL" - ], - "type": "string" - } - }, - "description": "A domain is an organizing entity for connecting together assets, users, and their projects", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateDomain", - "datazone:UpdateDomain", - "datazone:GetDomain", - "datazone:TagResource", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "sso:PutApplicationAssignmentConfiguration" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteDomain", - "datazone:GetDomain" - ] - }, - "list": { - "permissions": [ - "datazone:ListDomains" - ] - }, - "read": { - "permissions": [ - "datazone:GetDomain" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateDomain", - "datazone:GetDomain", - "datazone:TagResource", - "datazone:UntagResource", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "sso:PutApplicationAssignmentConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The ARN of the Amazon DataZone domain.", - "pattern": "^arn:aws(|-cn|-us-gov):datazone:\\w+(?:-\\w+)+:\\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp of when the Amazon DataZone domain was last updated.", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "The description of the Amazon DataZone domain.", - "type": "string" - }, - "DomainExecutionRole": { - "description": "The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.", - "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", - "type": "string" - }, - "Id": { - "description": "The id of the Amazon DataZone domain.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "KmsKeyIdentifier": { - "description": "The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", - "type": "string" - }, - "LastUpdatedAt": { - "description": "The timestamp of when the Amazon DataZone domain was last updated.", - "format": "date-time", - "type": "string" - }, - "ManagedAccountId": { - "description": "The identifier of the AWS account that manages the domain.", - "type": "string" - }, - "Name": { - "description": "The name of the Amazon DataZone domain.", - "type": "string" - }, - "PortalUrl": { - "description": "The URL of the data portal for this Amazon DataZone domain.", - "type": "string" - }, - "SingleSignOn": { - "$ref": "#/definitions/SingleSignOn", - "description": "The single-sign on configuration of the Amazon DataZone domain." - }, - "Status": { - "$ref": "#/definitions/DomainStatus", - "description": "The status of the Amazon DataZone domain." - }, - "Tags": { - "description": "The tags specified for the Amazon DataZone domain.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/LastUpdatedAt", - "/properties/ManagedAccountId", - "/properties/PortalUrl", - "/properties/Status" - ], - "required": [ - "DomainExecutionRole", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DataZone::Domain" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyIdentifier" + ], + "definitions": { + "AuthType": { + "description": "The type of single sign-on in Amazon DataZone.", + "enum": [ + "IAM_IDC", + "DISABLED" + ], + "type": "string" + }, + "DomainStatus": { + "description": "The status of the Amazon DataZone domain.", + "enum": [ + "CREATING", + "AVAILABLE", + "CREATION_FAILED", + "DELETING", + "DELETED", + "DELETION_FAILED" + ], + "type": "string" + }, + "SingleSignOn": { + "additionalProperties": false, + "description": "The single-sign on configuration of the Amazon DataZone domain.", + "properties": { + "Type": { + "$ref": "#/definitions/AuthType" + }, + "UserAssignment": { + "$ref": "#/definitions/UserAssignment" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with the domain.", + "properties": { + "Key": { + "description": "The key name of the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserAssignment": { + "description": "The single sign-on user assignment in Amazon DataZone.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "type": "string" + } + }, + "description": "A domain is an organizing entity for connecting together assets, users, and their projects", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateDomain", + "datazone:UpdateDomain", + "datazone:GetDomain", + "datazone:TagResource", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:PutApplicationAssignmentConfiguration" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteDomain", + "datazone:GetDomain", + "sso:DeleteManagedApplicationInstance", + "sso:PutApplicationAssignmentConfiguration" + ] + }, + "list": { + "permissions": [ + "datazone:ListDomains" + ] + }, + "read": { + "permissions": [ + "datazone:GetDomain" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateDomain", + "datazone:GetDomain", + "datazone:TagResource", + "datazone:UntagResource", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:PutApplicationAssignmentConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the Amazon DataZone domain.", + "pattern": "^arn:aws(|-cn|-us-gov):datazone:\\w+(?:-\\w+)+:\\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when the Amazon DataZone domain was last updated.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone domain.", + "type": "string" + }, + "DomainExecutionRole": { + "description": "The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.", + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "Id": { + "description": "The id of the Amazon DataZone domain.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "KmsKeyIdentifier": { + "description": "The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "LastUpdatedAt": { + "description": "The timestamp of when the Amazon DataZone domain was last updated.", + "format": "date-time", + "type": "string" + }, + "ManagedAccountId": { + "description": "The identifier of the AWS account that manages the domain.", + "type": "string" + }, + "Name": { + "description": "The name of the Amazon DataZone domain.", + "type": "string" + }, + "PortalUrl": { + "description": "The URL of the data portal for this Amazon DataZone domain.", + "type": "string" + }, + "SingleSignOn": { + "$ref": "#/definitions/SingleSignOn", + "description": "The single-sign on configuration of the Amazon DataZone domain." + }, + "Status": { + "$ref": "#/definitions/DomainStatus", + "description": "The status of the Amazon DataZone domain." + }, + "Tags": { + "description": "The tags specified for the Amazon DataZone domain.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/LastUpdatedAt", + "/properties/ManagedAccountId", + "/properties/PortalUrl", + "/properties/Status" + ], + "required": [ + "DomainExecutionRole", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "datazone:TagResource", + "datazone:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataZone::Domain" +} diff --git a/schema/aws-datazone-environment.json b/schema/aws-datazone-environment.json index 43100b3..81be713 100644 --- a/schema/aws-datazone-environment.json +++ b/schema/aws-datazone-environment.json @@ -1,236 +1,259 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DomainIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/EnvironmentProfileIdentifier", - "/properties/ProjectIdentifier", - "/properties/UserParameters" - ], - "definitions": { - "EnvironmentParameter": { - "additionalProperties": false, - "description": "The parameter details of an environment.", - "properties": { - "Name": { - "description": "The name of an environment parameter.", - "type": "string" - }, - "Value": { - "description": "The value of an environment parameter.", - "type": "string" - } - }, - "type": "object" - }, - "EnvironmentStatus": { - "description": "The status of the Amazon DataZone environment.", - "enum": [ - "ACTIVE", - "CREATING", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED", - "VALIDATION_FAILED", - "SUSPENDED", - "DISABLED", - "EXPIRED", - "DELETED", - "INACCESSIBLE" - ], - "type": "string" - } - }, - "description": "Definition of AWS::DataZone::Environment Resource Type", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateEnvironment", - "datazone:GetEnvironment", - "datazone:DeleteEnvironment" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteEnvironment", - "datazone:GetEnvironment" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - }, - "ProjectIdentifier": { - "$ref": "resource-schema.json#/properties/ProjectIdentifier" - } - }, - "required": [ - "DomainIdentifier", - "ProjectIdentifier" - ] - }, - "permissions": [ - "datazone:ListEnvironments" - ] - }, - "read": { - "permissions": [ - "datazone:GetEnvironment" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateEnvironment", - "datazone:GetEnvironment", - "datazone:DeleteEnvironment" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "AwsAccountId": { - "description": "The AWS account in which the Amazon DataZone environment is created.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "AwsAccountRegion": { - "description": "The AWS region in which the Amazon DataZone environment is created.", - "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp of when the environment was created.", - "format": "date-time", - "type": "string" - }, - "CreatedBy": { - "description": "The Amazon DataZone user who created the environment.", - "type": "string" - }, - "Description": { - "description": "The description of the Amazon DataZone environment.", - "maxLength": 2048, - "type": "string" - }, - "DomainId": { - "description": "The identifier of the Amazon DataZone domain in which the environment is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The identifier of the Amazon DataZone domain in which the environment would be created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentBlueprintId": { - "description": "The ID of the blueprint with which the Amazon DataZone environment was created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentProfileId": { - "description": "The ID of the environment profile with which the Amazon DataZone environment was created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentProfileIdentifier": { - "description": "The ID of the environment profile with which the Amazon DataZone environment would be created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "GlossaryTerms": { - "description": "The glossary terms that can be used in the Amazon DataZone environment.", - "insertionOrder": false, - "items": { - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Id": { - "description": "The ID of the Amazon DataZone environment.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Name": { - "description": "The name of the environment.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\w -]+$", - "type": "string" - }, - "ProjectId": { - "description": "The ID of the Amazon DataZone project in which the environment is created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "ProjectIdentifier": { - "description": "The ID of the Amazon DataZone project in which the environment would be created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Provider": { - "description": "The provider of the Amazon DataZone environment.", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/EnvironmentStatus", - "description": "The status of the Amazon DataZone environment." - }, - "UpdatedAt": { - "description": "The timestamp of when the environment was updated.", - "format": "date-time", - "type": "string" - }, - "UserParameters": { - "description": "The user parameters of the Amazon DataZone environment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EnvironmentParameter" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/AwsAccountRegion", - "/properties/CreatedAt", - "/properties/CreatedBy", - "/properties/DomainId", - "/properties/EnvironmentBlueprintId", - "/properties/EnvironmentProfileId", - "/properties/Id", - "/properties/ProjectId", - "/properties/Provider", - "/properties/Status", - "/properties/UpdatedAt" - ], - "required": [ - "EnvironmentProfileIdentifier", - "Name", - "ProjectIdentifier", - "DomainIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "taggable": false - }, - "typeName": "AWS::DataZone::Environment", - "writeOnlyProperties": [ - "/properties/EnvironmentProfileIdentifier", - "/properties/ProjectIdentifier", - "/properties/DomainIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentProfileIdentifier", + "/properties/ProjectIdentifier", + "/properties/UserParameters", + "/properties/EnvironmentAccountIdentifier", + "/properties/EnvironmentAccountRegion" + ], + "definitions": { + "EnvironmentParameter": { + "additionalProperties": false, + "description": "The parameter details of an environment.", + "properties": { + "Name": { + "description": "The name of an environment parameter.", + "type": "string" + }, + "Value": { + "description": "The value of an environment parameter.", + "type": "string" + } + }, + "type": "object" + }, + "EnvironmentStatus": { + "description": "The status of the Amazon DataZone environment.", + "enum": [ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "CREATE_FAILED", + "UPDATE_FAILED", + "DELETE_FAILED", + "VALIDATION_FAILED", + "SUSPENDED", + "DISABLED", + "EXPIRED", + "DELETED", + "INACCESSIBLE" + ], + "type": "string" + } + }, + "description": "Definition of AWS::DataZone::Environment Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateEnvironment", + "datazone:GetEnvironment", + "datazone:DeleteEnvironment", + "datazone:AssociateEnvironmentRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteEnvironment", + "datazone:GetEnvironment" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier", + "ProjectIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironment" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateEnvironment", + "datazone:GetEnvironment", + "datazone:DeleteEnvironment", + "datazone:AssociateEnvironmentRole", + "datazone:DisassociateEnvironmentRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AwsAccountId": { + "description": "The AWS account in which the Amazon DataZone environment is created.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AwsAccountRegion": { + "description": "The AWS region in which the Amazon DataZone environment is created.", + "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when the environment was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the environment.", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone environment.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the environment is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the environment would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentAccountIdentifier": { + "description": "The AWS account in which the Amazon DataZone environment is created.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "EnvironmentAccountRegion": { + "description": "The AWS region in which the Amazon DataZone environment is created.", + "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", + "type": "string" + }, + "EnvironmentBlueprintId": { + "description": "The ID of the blueprint with which the Amazon DataZone environment was created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentProfileId": { + "description": "The ID of the environment profile with which the Amazon DataZone environment was created.", + "pattern": "^[a-zA-Z0-9_-]{0,36}$", + "type": "string" + }, + "EnvironmentProfileIdentifier": { + "description": "The ID of the environment profile with which the Amazon DataZone environment would be created.", + "pattern": "^[a-zA-Z0-9_-]{0,36}$", + "type": "string" + }, + "EnvironmentRoleArn": { + "description": "Environment role arn for custom aws environment permissions", + "type": "string" + }, + "GlossaryTerms": { + "description": "The glossary terms that can be used in the Amazon DataZone environment.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Id": { + "description": "The ID of the Amazon DataZone environment.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Name": { + "description": "The name of the environment.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + }, + "ProjectId": { + "description": "The ID of the Amazon DataZone project in which the environment is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The ID of the Amazon DataZone project in which the environment would be created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Provider": { + "description": "The provider of the Amazon DataZone environment.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/EnvironmentStatus", + "description": "The status of the Amazon DataZone environment." + }, + "UpdatedAt": { + "description": "The timestamp of when the environment was updated.", + "format": "date-time", + "type": "string" + }, + "UserParameters": { + "description": "The user parameters of the Amazon DataZone environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnvironmentParameter" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/AwsAccountRegion", + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/EnvironmentProfileId", + "/properties/Id", + "/properties/ProjectId", + "/properties/Provider", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "Name", + "ProjectIdentifier", + "DomainIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::Environment", + "writeOnlyProperties": [ + "/properties/EnvironmentProfileIdentifier", + "/properties/ProjectIdentifier", + "/properties/DomainIdentifier", + "/properties/EnvironmentAccountIdentifier", + "/properties/EnvironmentAccountRegion", + "/properties/EnvironmentRoleArn" + ] +} diff --git a/schema/aws-datazone-environmentactions.json b/schema/aws-datazone-environmentactions.json new file mode 100644 index 0000000..18ebab3 --- /dev/null +++ b/schema/aws-datazone-environmentactions.json @@ -0,0 +1,156 @@ +{ + "additionalIdentifiers": [ + [ + "/properties/EnvironmentIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentIdentifier" + ], + "definitions": { + "AwsConsoleLinkParameters": { + "additionalProperties": false, + "description": "The parameters of the console link specified as part of the environment action", + "properties": { + "Uri": { + "$ref": "#/definitions/EnvironmentActionURI" + } + }, + "type": "object" + }, + "EnvironmentActionURI": { + "description": "The URI of the console link specified as part of the environment action.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "description": "Definition of AWS::DataZone::EnvironmentActions Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateEnvironmentAction", + "datazone:GetEnvironmentAction", + "datazone:DeleteEnvironmentAction" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteEnvironmentAction", + "datazone:GetEnvironmentAction" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "DomainIdentifier", + "EnvironmentIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironmentActions" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironmentAction" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateEnvironmentAction", + "datazone:GetEnvironmentAction", + "datazone:DeleteEnvironmentAction" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id" + ], + "properties": { + "Description": { + "description": "The description of the Amazon DataZone environment action.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the environment is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the environment would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentId": { + "description": "The identifier of the Amazon DataZone environment in which the action is taking place", + "maxLength": 36, + "minLength": 1, + "pattern": "[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentIdentifier": { + "description": "The identifier of the Amazon DataZone environment in which the action is taking place", + "maxLength": 36, + "minLength": 1, + "pattern": "[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of the Amazon DataZone environment action.", + "maxLength": 36, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Identifier": { + "description": "The ID of the Amazon DataZone environment action.", + "maxLength": 36, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Name": { + "description": "The name of the environment action.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/AwsConsoleLinkParameters", + "description": "The parameters of the environment action." + } + }, + "readOnlyProperties": [ + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::EnvironmentActions", + "writeOnlyProperties": [ + "/properties/EnvironmentIdentifier", + "/properties/DomainIdentifier", + "/properties/Identifier" + ] +} diff --git a/schema/aws-datazone-environmentblueprintconfiguration.json b/schema/aws-datazone-environmentblueprintconfiguration.json index 4319570..4916e9e 100644 --- a/schema/aws-datazone-environmentblueprintconfiguration.json +++ b/schema/aws-datazone-environmentblueprintconfiguration.json @@ -1,159 +1,159 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DomainIdentifier", - "/properties/EnvironmentBlueprintIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/EnvironmentBlueprintIdentifier" - ], - "definitions": { - "Parameter": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "RegionalParameter": { - "additionalProperties": false, - "properties": { - "Parameters": { - "$ref": "#/definitions/Parameter" - }, - "Region": { - "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type", - "handlers": { - "create": { - "permissions": [ - "datazone:ListEnvironmentBlueprints", - "iam:PassRole", - "datazone:GetEnvironmentBlueprintConfiguration", - "datazone:PutEnvironmentBlueprintConfiguration" - ] - }, - "delete": { - "permissions": [ - "datazone:GetEnvironmentBlueprintConfiguration", - "datazone:DeleteEnvironmentBlueprintConfiguration" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:ListEnvironmentBlueprintConfigurations" - ] - }, - "read": { - "permissions": [ - "datazone:GetEnvironmentBlueprintConfiguration" - ] - }, - "update": { - "permissions": [ - "datazone:DeleteEnvironmentBlueprintConfiguration", - "iam:PassRole", - "datazone:GetEnvironmentBlueprintConfiguration", - "datazone:PutEnvironmentBlueprintConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/EnvironmentBlueprintId" - ], - "properties": { - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "DomainId": { - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnabledRegions": { - "insertionOrder": false, - "items": { - "maxLength": 16, - "minLength": 4, - "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", - "type": "string" - }, - "minItems": 0, - "type": "array" - }, - "EnvironmentBlueprintId": { - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentBlueprintIdentifier": { - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "ManageAccessRoleArn": { - "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", - "type": "string" - }, - "ProvisioningRoleArn": { - "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", - "type": "string" - }, - "RegionalParameters": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RegionalParameter" - }, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/DomainId", - "/properties/EnvironmentBlueprintId", - "/properties/UpdatedAt" - ], - "required": [ - "DomainIdentifier", - "EnvironmentBlueprintIdentifier", - "EnabledRegions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "taggable": false - }, - "typeName": "AWS::DataZone::EnvironmentBlueprintConfiguration", - "writeOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/EnvironmentBlueprintIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ], + "definitions": { + "Parameter": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "RegionalParameter": { + "additionalProperties": false, + "properties": { + "Parameters": { + "$ref": "#/definitions/Parameter" + }, + "Region": { + "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:ListEnvironmentBlueprints", + "iam:PassRole", + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:PutEnvironmentBlueprintConfiguration" + ] + }, + "delete": { + "permissions": [ + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:DeleteEnvironmentBlueprintConfiguration" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironmentBlueprintConfigurations" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironmentBlueprintConfiguration" + ] + }, + "update": { + "permissions": [ + "datazone:DeleteEnvironmentBlueprintConfiguration", + "iam:PassRole", + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:PutEnvironmentBlueprintConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/EnvironmentBlueprintId" + ], + "properties": { + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DomainId": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnabledRegions": { + "insertionOrder": false, + "items": { + "maxLength": 16, + "minLength": 4, + "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "EnvironmentBlueprintId": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintIdentifier": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ManageAccessRoleArn": { + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "ProvisioningRoleArn": { + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "RegionalParameters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RegionalParameter" + }, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/UpdatedAt" + ], + "required": [ + "DomainIdentifier", + "EnvironmentBlueprintIdentifier", + "EnabledRegions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::EnvironmentBlueprintConfiguration", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ] +} diff --git a/schema/aws-datazone-environmentprofile.json b/schema/aws-datazone-environmentprofile.json index 1ef6377..ce7b33c 100644 --- a/schema/aws-datazone-environmentprofile.json +++ b/schema/aws-datazone-environmentprofile.json @@ -1,186 +1,186 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DomainIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/EnvironmentBlueprintIdentifier", - "/properties/ProjectIdentifier" - ], - "definitions": { - "EnvironmentParameter": { - "additionalProperties": false, - "description": "The parameter details of an environment profile.", - "properties": { - "Name": { - "description": "The name of an environment profile parameter.", - "type": "string" - }, - "Value": { - "description": "The value of an environment profile parameter.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateEnvironmentProfile", - "datazone:GetEnvironmentProfile" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteEnvironmentProfile", - "datazone:GetEnvironmentProfile" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:ListEnvironmentProfiles" - ] - }, - "read": { - "permissions": [ - "datazone:GetEnvironmentProfile" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateEnvironmentProfile", - "datazone:GetEnvironmentProfile" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "AwsAccountId": { - "description": "The AWS account in which the Amazon DataZone environment is created.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "AwsAccountRegion": { - "description": "The AWS region in which this environment profile is created.", - "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp of when this environment profile was created.", - "format": "date-time", - "type": "string" - }, - "CreatedBy": { - "description": "The Amazon DataZone user who created this environment profile.", - "type": "string" - }, - "Description": { - "description": "The description of this Amazon DataZone environment profile.", - "maxLength": 2048, - "type": "string" - }, - "DomainId": { - "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentBlueprintId": { - "description": "The ID of the blueprint with which this environment profile is created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentBlueprintIdentifier": { - "description": "The ID of the blueprint with which this environment profile is created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Id": { - "description": "The ID of this Amazon DataZone environment profile.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Name": { - "description": "The name of this Amazon DataZone environment profile.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\w -]+$", - "type": "string" - }, - "ProjectId": { - "description": "The identifier of the project in which to create the environment profile.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "ProjectIdentifier": { - "description": "The identifier of the project in which to create the environment profile.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "UpdatedAt": { - "description": "The timestamp of when this environment profile was updated.", - "format": "date-time", - "type": "string" - }, - "UserParameters": { - "description": "The user parameters of this Amazon DataZone environment profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EnvironmentParameter" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/CreatedBy", - "/properties/DomainId", - "/properties/EnvironmentBlueprintId", - "/properties/Id", - "/properties/ProjectId", - "/properties/UpdatedAt" - ], - "required": [ - "EnvironmentBlueprintIdentifier", - "ProjectIdentifier", - "DomainIdentifier", - "AwsAccountId", - "AwsAccountRegion", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::EnvironmentProfile", - "writeOnlyProperties": [ - "/properties/EnvironmentBlueprintIdentifier", - "/properties/ProjectIdentifier", - "/properties/DomainIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier", + "/properties/ProjectIdentifier" + ], + "definitions": { + "EnvironmentParameter": { + "additionalProperties": false, + "description": "The parameter details of an environment profile.", + "properties": { + "Name": { + "description": "The name of an environment profile parameter.", + "type": "string" + }, + "Value": { + "description": "The value of an environment profile parameter.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironmentProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironmentProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AwsAccountId": { + "description": "The AWS account in which the Amazon DataZone environment is created.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AwsAccountRegion": { + "description": "The AWS region in which this environment profile is created.", + "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when this environment profile was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created this environment profile.", + "type": "string" + }, + "Description": { + "description": "The description of this Amazon DataZone environment profile.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintId": { + "description": "The ID of the blueprint with which this environment profile is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintIdentifier": { + "description": "The ID of the blueprint with which this environment profile is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of this Amazon DataZone environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Name": { + "description": "The name of this Amazon DataZone environment profile.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + }, + "ProjectId": { + "description": "The identifier of the project in which to create the environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The identifier of the project in which to create the environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when this environment profile was updated.", + "format": "date-time", + "type": "string" + }, + "UserParameters": { + "description": "The user parameters of this Amazon DataZone environment profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnvironmentParameter" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/Id", + "/properties/ProjectId", + "/properties/UpdatedAt" + ], + "required": [ + "EnvironmentBlueprintIdentifier", + "ProjectIdentifier", + "DomainIdentifier", + "AwsAccountId", + "AwsAccountRegion", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::EnvironmentProfile", + "writeOnlyProperties": [ + "/properties/EnvironmentBlueprintIdentifier", + "/properties/ProjectIdentifier", + "/properties/DomainIdentifier" + ] +} diff --git a/schema/aws-datazone-groupprofile.json b/schema/aws-datazone-groupprofile.json index d9f5806..881435a 100644 --- a/schema/aws-datazone-groupprofile.json +++ b/schema/aws-datazone-groupprofile.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/GroupIdentifier" - ], - "definitions": { - "GroupProfileStatus": { - "description": "The status of the group profile.", - "enum": [ - "ASSIGNED", - "NOT_ASSIGNED" - ], - "type": "string" - } - }, - "description": "Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateGroupProfile", - "datazone:GetGroupProfile", - "datazone:UpdateGroupProfile", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteGroupProfile", - "datazone:GetGroupProfile", - "datazone:UpdateGroupProfile", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:SearchGroupProfiles" - ] - }, - "read": { - "permissions": [ - "datazone:GetGroupProfile" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateGroupProfile", - "datazone:GetGroupProfile", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "DomainId": { - "description": "The identifier of the Amazon DataZone domain in which the group profile is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The identifier of the Amazon DataZone domain in which the group profile would be created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "GroupIdentifier": { - "description": "The ID of the group.", - "pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)", - "type": "string" - }, - "GroupName": { - "description": "The group-name of the Group Profile.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[a-zA-Z_0-9+=,.@-]+$", - "type": "string" - }, - "Id": { - "description": "The ID of the Amazon DataZone group profile.", - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/GroupProfileStatus" - } - }, - "readOnlyProperties": [ - "/properties/DomainId", - "/properties/GroupName", - "/properties/Id" - ], - "required": [ - "DomainIdentifier", - "GroupIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::GroupProfile", - "writeOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/GroupIdentifier" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/GroupIdentifier" + ], + "definitions": { + "GroupProfileStatus": { + "description": "The status of the group profile.", + "enum": [ + "ASSIGNED", + "NOT_ASSIGNED" + ], + "type": "string" + } + }, + "description": "Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateGroupProfile", + "datazone:GetGroupProfile", + "datazone:UpdateGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteGroupProfile", + "datazone:GetGroupProfile", + "datazone:UpdateGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:SearchGroupProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetGroupProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateGroupProfile", + "datazone:GetGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the group profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the group profile would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "GroupIdentifier": { + "description": "The ID of the group.", + "pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)", + "type": "string" + }, + "GroupName": { + "description": "The group-name of the Group Profile.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "type": "string" + }, + "Id": { + "description": "The ID of the Amazon DataZone group profile.", + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/GroupProfileStatus" + } + }, + "readOnlyProperties": [ + "/properties/DomainId", + "/properties/GroupName", + "/properties/Id" + ], + "required": [ + "DomainIdentifier", + "GroupIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::GroupProfile", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/GroupIdentifier" + ] +} diff --git a/schema/aws-datazone-project.json b/schema/aws-datazone-project.json index 8ab2866..f90d367 100644 --- a/schema/aws-datazone-project.json +++ b/schema/aws-datazone-project.json @@ -1,133 +1,133 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DomainIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier" - ], - "definitions": {}, - "description": "Amazon DataZone projects are business use case\u2013based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateProject", - "datazone:GetProject" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteProject", - "datazone:GetProject" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:ListProjects" - ] - }, - "read": { - "permissions": [ - "datazone:GetProject" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateProject", - "datazone:GetProject" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "CreatedAt": { - "description": "The timestamp of when the project was created.", - "format": "date-time", - "type": "string" - }, - "CreatedBy": { - "description": "The Amazon DataZone user who created the project.", - "type": "string" - }, - "Description": { - "description": "The description of the Amazon DataZone project.", - "maxLength": 2048, - "type": "string" - }, - "DomainId": { - "description": "The identifier of the Amazon DataZone domain in which the project was created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The ID of the Amazon DataZone domain in which this project is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "GlossaryTerms": { - "description": "The glossary terms that can be used in this Amazon DataZone project.", - "insertionOrder": false, - "items": { - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Id": { - "description": "The ID of the Amazon DataZone project.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "LastUpdatedAt": { - "description": "The timestamp of when the project was last updated.", - "format": "date-time", - "type": "string" - }, - "Name": { - "description": "The name of the Amazon DataZone project.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\w -]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/CreatedAt", - "/properties/CreatedBy", - "/properties/DomainId", - "/properties/LastUpdatedAt" - ], - "required": [ - "DomainIdentifier", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::Project", - "writeOnlyProperties": [ - "/properties/DomainIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier" + ], + "definitions": {}, + "description": "Amazon DataZone projects are business use case\u2013based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateProject", + "datazone:GetProject" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteProject", + "datazone:GetProject" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListProjects" + ] + }, + "read": { + "permissions": [ + "datazone:GetProject" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateProject", + "datazone:GetProject" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "CreatedAt": { + "description": "The timestamp of when the project was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the project.", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone project.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the project was created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which this project is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "GlossaryTerms": { + "description": "The glossary terms that can be used in this Amazon DataZone project.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Id": { + "description": "The ID of the Amazon DataZone project.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "LastUpdatedAt": { + "description": "The timestamp of when the project was last updated.", + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "The name of the Amazon DataZone project.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/LastUpdatedAt" + ], + "required": [ + "DomainIdentifier", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::Project", + "writeOnlyProperties": [ + "/properties/DomainIdentifier" + ] +} diff --git a/schema/aws-datazone-projectmembership.json b/schema/aws-datazone-projectmembership.json index 5470f07..aca6e4d 100644 --- a/schema/aws-datazone-projectmembership.json +++ b/schema/aws-datazone-projectmembership.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/ProjectIdentifier", - "/properties/Member" - ], - "definitions": { - "Member": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "UserIdentifier": { - "type": "string" - } - }, - "required": [ - "UserIdentifier" - ], - "title": "UserIdentifier", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "GroupIdentifier": { - "type": "string" - } - }, - "required": [ - "GroupIdentifier" - ], - "title": "GroupIdentifier", - "type": "object" - } - ] - }, - "MemberIdentifierType": { - "enum": [ - "USER_IDENTIFIER", - "GROUP_IDENTIFIER" - ], - "type": "string" - }, - "UserDesignation": { - "enum": [ - "PROJECT_OWNER", - "PROJECT_CONTRIBUTOR" - ], - "type": "string" - } - }, - "description": "Definition of AWS::DataZone::ProjectMembership Resource Type", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateProjectMembership", - "datazone:ListProjectMemberships", - "iam:GetRole", - "datazone:GetGroupProfile", - "datazone:GetUserProfile" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteProjectMembership" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - }, - "ProjectIdentifier": { - "$ref": "resource-schema.json#/properties/ProjectIdentifier" - } - }, - "required": [ - "DomainIdentifier", - "ProjectIdentifier" - ] - }, - "permissions": [ - "datazone:ListProjectMemberships" - ] - }, - "read": { - "permissions": [ - "datazone:ListProjectMemberships" - ] - }, - "update": { - "permissions": [ - "datazone:CreateProjectMembership", - "datazone:DeleteProjectMembership" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainIdentifier", - "/properties/MemberIdentifier", - "/properties/MemberIdentifierType", - "/properties/ProjectIdentifier" - ], - "properties": { - "Designation": { - "$ref": "#/definitions/UserDesignation" - }, - "DomainIdentifier": { - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Member": { - "$ref": "#/definitions/Member" - }, - "ProjectIdentifier": { - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - } - }, - "required": [ - "Designation", - "DomainIdentifier", - "ProjectIdentifier", - "Member" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "taggable": false - }, - "typeName": "AWS::DataZone::ProjectMembership", - "writeOnlyProperties": [ - "/properties/Designation", - "/properties/Member" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/ProjectIdentifier", + "/properties/Member" + ], + "definitions": { + "Member": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "UserIdentifier": { + "type": "string" + } + }, + "required": [ + "UserIdentifier" + ], + "title": "UserIdentifier", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "GroupIdentifier": { + "type": "string" + } + }, + "required": [ + "GroupIdentifier" + ], + "title": "GroupIdentifier", + "type": "object" + } + ] + }, + "MemberIdentifierType": { + "enum": [ + "USER_IDENTIFIER", + "GROUP_IDENTIFIER" + ], + "type": "string" + }, + "UserDesignation": { + "enum": [ + "PROJECT_OWNER", + "PROJECT_CONTRIBUTOR" + ], + "type": "string" + } + }, + "description": "Definition of AWS::DataZone::ProjectMembership Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateProjectMembership", + "datazone:ListProjectMemberships", + "iam:GetRole", + "datazone:GetGroupProfile", + "datazone:GetUserProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteProjectMembership" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier", + "ProjectIdentifier" + ] + }, + "permissions": [ + "datazone:ListProjectMemberships" + ] + }, + "read": { + "permissions": [ + "datazone:ListProjectMemberships" + ] + }, + "update": { + "permissions": [ + "datazone:CreateProjectMembership", + "datazone:DeleteProjectMembership" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainIdentifier", + "/properties/MemberIdentifier", + "/properties/MemberIdentifierType", + "/properties/ProjectIdentifier" + ], + "properties": { + "Designation": { + "$ref": "#/definitions/UserDesignation" + }, + "DomainIdentifier": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Member": { + "$ref": "#/definitions/Member" + }, + "ProjectIdentifier": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + } + }, + "required": [ + "Designation", + "DomainIdentifier", + "ProjectIdentifier", + "Member" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::ProjectMembership", + "writeOnlyProperties": [ + "/properties/Designation", + "/properties/Member" + ] +} diff --git a/schema/aws-datazone-subscriptiontarget.json b/schema/aws-datazone-subscriptiontarget.json index 098db8b..418a79e 100644 --- a/schema/aws-datazone-subscriptiontarget.json +++ b/schema/aws-datazone-subscriptiontarget.json @@ -1,212 +1,212 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/DomainIdentifier", - "/properties/EnvironmentIdentifier" - ], - "definitions": { - "SubscriptionTargetForm": { - "additionalProperties": false, - "description": "The details of the subscription target configuration.", - "properties": { - "Content": { - "description": "The content of the subscription target configuration.", - "type": "string" - }, - "FormName": { - "description": "The form name included in the subscription target configuration.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", - "type": "string" - } - }, - "required": [ - "Content", - "FormName" - ], - "type": "object" - } - }, - "description": "Subscription targets enables one to access the data to which you have subscribed in your projects.", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateSubscriptionTarget", - "datazone:GetSubscriptionTarget", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteSubscriptionTarget" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - }, - "EnvironmentIdentifier": { - "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" - } - }, - "required": [ - "DomainIdentifier" - ] - }, - "permissions": [ - "datazone:ListSubscriptionTargets" - ] - }, - "read": { - "permissions": [ - "datazone:GetSubscriptionTarget" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateSubscriptionTarget", - "datazone:GetSubscriptionTarget", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/EnvironmentId", - "/properties/Id" - ], - "properties": { - "ApplicableAssetTypes": { - "description": "The asset types that can be included in the subscription target.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[^\\.]*", - "type": "string" - }, - "type": "array" - }, - "AuthorizedPrincipals": { - "description": "The authorized principals of the subscription target.", - "insertionOrder": false, - "items": { - "pattern": "^[a-zA-Z0-9:/_-]*$", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "CreatedAt": { - "description": "The timestamp of when the subscription target was created.", - "format": "date-time", - "type": "string" - }, - "CreatedBy": { - "description": "The Amazon DataZone user who created the subscription target.", - "type": "string" - }, - "DomainId": { - "description": "The ID of the Amazon DataZone domain in which subscription target is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The ID of the Amazon DataZone domain in which subscription target would be created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentId": { - "description": "The ID of the environment in which subscription target is created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "EnvironmentIdentifier": { - "description": "The ID of the environment in which subscription target would be created.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Id": { - "description": "The ID of the subscription target.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "ManageAccessRole": { - "description": "The manage access role that is used to create the subscription target.", - "type": "string" - }, - "Name": { - "description": "The name of the subscription target.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ProjectId": { - "description": "The identifier of the project specified in the subscription target.", - "pattern": "^[a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Provider": { - "description": "The provider of the subscription target.", - "type": "string" - }, - "SubscriptionTargetConfig": { - "description": "The configuration of the subscription target.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubscriptionTargetForm" - }, - "type": "array" - }, - "Type": { - "description": "The type of the subscription target.", - "type": "string" - }, - "UpdatedAt": { - "description": "The timestamp of when the subscription target was updated.", - "format": "date-time", - "type": "string" - }, - "UpdatedBy": { - "description": "The Amazon DataZone user who updated the subscription target.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/CreatedBy", - "/properties/DomainId", - "/properties/EnvironmentId", - "/properties/Id", - "/properties/ProjectId", - "/properties/UpdatedAt", - "/properties/UpdatedBy" - ], - "required": [ - "ApplicableAssetTypes", - "AuthorizedPrincipals", - "DomainIdentifier", - "EnvironmentIdentifier", - "ManageAccessRole", - "Name", - "SubscriptionTargetConfig", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::SubscriptionTarget", - "writeOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/EnvironmentIdentifier" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/DomainIdentifier", + "/properties/EnvironmentIdentifier" + ], + "definitions": { + "SubscriptionTargetForm": { + "additionalProperties": false, + "description": "The details of the subscription target configuration.", + "properties": { + "Content": { + "description": "The content of the subscription target configuration.", + "type": "string" + }, + "FormName": { + "description": "The form name included in the subscription target configuration.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", + "type": "string" + } + }, + "required": [ + "Content", + "FormName" + ], + "type": "object" + } + }, + "description": "Subscription targets enables one to access the data to which you have subscribed in your projects.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateSubscriptionTarget", + "datazone:GetSubscriptionTarget", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteSubscriptionTarget" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListSubscriptionTargets" + ] + }, + "read": { + "permissions": [ + "datazone:GetSubscriptionTarget" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateSubscriptionTarget", + "datazone:GetSubscriptionTarget", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id" + ], + "properties": { + "ApplicableAssetTypes": { + "description": "The asset types that can be included in the subscription target.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[^\\.]*", + "type": "string" + }, + "type": "array" + }, + "AuthorizedPrincipals": { + "description": "The authorized principals of the subscription target.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9:/_-]*$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "CreatedAt": { + "description": "The timestamp of when the subscription target was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the subscription target.", + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain in which subscription target is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which subscription target would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentId": { + "description": "The ID of the environment in which subscription target is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentIdentifier": { + "description": "The ID of the environment in which subscription target would be created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of the subscription target.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ManageAccessRole": { + "description": "The manage access role that is used to create the subscription target.", + "type": "string" + }, + "Name": { + "description": "The name of the subscription target.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ProjectId": { + "description": "The identifier of the project specified in the subscription target.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Provider": { + "description": "The provider of the subscription target.", + "type": "string" + }, + "SubscriptionTargetConfig": { + "description": "The configuration of the subscription target.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubscriptionTargetForm" + }, + "type": "array" + }, + "Type": { + "description": "The type of the subscription target.", + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when the subscription target was updated.", + "format": "date-time", + "type": "string" + }, + "UpdatedBy": { + "description": "The Amazon DataZone user who updated the subscription target.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id", + "/properties/ProjectId", + "/properties/UpdatedAt", + "/properties/UpdatedBy" + ], + "required": [ + "ApplicableAssetTypes", + "AuthorizedPrincipals", + "DomainIdentifier", + "EnvironmentIdentifier", + "ManageAccessRole", + "Name", + "SubscriptionTargetConfig", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::SubscriptionTarget", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentIdentifier" + ] +} diff --git a/schema/aws-datazone-userprofile.json b/schema/aws-datazone-userprofile.json index 7818c2c..d343bf2 100644 --- a/schema/aws-datazone-userprofile.json +++ b/schema/aws-datazone-userprofile.json @@ -1,227 +1,227 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/UserIdentifier", - "/properties/UserType" - ], - "definitions": { - "IamUserProfileDetails": { - "additionalProperties": false, - "description": "The details of the IAM User Profile.", - "properties": { - "Arn": { - "description": "The ARN of the IAM User Profile.", - "type": "string" - } - }, - "type": "object" - }, - "SsoUserProfileDetails": { - "additionalProperties": false, - "description": "The details of the SSO User Profile.", - "properties": { - "FirstName": { - "description": "The First Name of the IAM User Profile.", - "type": "string" - }, - "LastName": { - "description": "The Last Name of the IAM User Profile.", - "type": "string" - }, - "Username": { - "description": "The username of the SSO User Profile.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[a-zA-Z_0-9+=,.@-]+$", - "type": "string" - } - }, - "type": "object" - }, - "UserProfileDetails": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Iam": { - "$ref": "#/definitions/IamUserProfileDetails" - } - }, - "required": [ - "Iam" - ], - "title": "Iam", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Sso": { - "$ref": "#/definitions/SsoUserProfileDetails" - } - }, - "required": [ - "Sso" - ], - "title": "Sso", - "type": "object" - } - ] - }, - "UserProfileStatus": { - "description": "The status of the user profile.", - "enum": [ - "ASSIGNED", - "NOT_ASSIGNED", - "ACTIVATED", - "DEACTIVATED" - ], - "type": "string" - }, - "UserProfileType": { - "description": "The type of the user profile.", - "enum": [ - "IAM", - "SSO" - ], - "type": "string" - }, - "UserType": { - "description": "The type of the user.", - "enum": [ - "IAM_USER", - "IAM_ROLE", - "SSO_USER" - ], - "type": "string" - } - }, - "description": "A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.", - "handlers": { - "create": { - "permissions": [ - "datazone:CreateUserProfile", - "datazone:GetUserProfile", - "datazone:UpdateUserProfile", - "datazone:GetDomain", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile", - "iam:GetRole", - "iam:GetUser" - ] - }, - "delete": { - "permissions": [ - "datazone:DeleteUserProfile", - "datazone:GetUserProfile", - "datazone:UpdateUserProfile", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile", - "iam:GetRole", - "iam:GetUser" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DomainIdentifier": { - "$ref": "resource-schema.json#/properties/DomainIdentifier" - }, - "UserType": { - "$ref": "resource-schema.json#/properties/UserType" - } - }, - "required": [ - "DomainIdentifier", - "UserType" - ] - }, - "permissions": [ - "datazone:SearchUserProfiles" - ] - }, - "read": { - "permissions": [ - "datazone:GetUserProfile" - ] - }, - "update": { - "permissions": [ - "datazone:UpdateUserProfile", - "datazone:GetUserProfile", - "datazone:UpdateUserProfile", - "sso:ListProfiles", - "sso:GetProfile", - "sso:AssociateProfile", - "sso:DisassociateProfile", - "iam:GetRole", - "iam:GetUser" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId", - "/properties/Id" - ], - "properties": { - "Details": { - "$ref": "#/definitions/UserProfileDetails" - }, - "DomainId": { - "description": "The identifier of the Amazon DataZone domain in which the user profile is created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "DomainIdentifier": { - "description": "The identifier of the Amazon DataZone domain in which the user profile would be created.", - "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", - "type": "string" - }, - "Id": { - "description": "The ID of the Amazon DataZone user profile.", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/UserProfileStatus" - }, - "Type": { - "$ref": "#/definitions/UserProfileType" - }, - "UserIdentifier": { - "description": "The ID of the user.", - "pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)", - "type": "string" - }, - "UserType": { - "$ref": "#/definitions/UserType" - } - }, - "readOnlyProperties": [ - "/properties/DomainId", - "/properties/Type", - "/properties/Id", - "/properties/Details" - ], - "required": [ - "DomainIdentifier", - "UserIdentifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DataZone::UserProfile", - "writeOnlyProperties": [ - "/properties/DomainIdentifier", - "/properties/UserIdentifier", - "/properties/UserType" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/UserIdentifier", + "/properties/UserType" + ], + "definitions": { + "IamUserProfileDetails": { + "additionalProperties": false, + "description": "The details of the IAM User Profile.", + "properties": { + "Arn": { + "description": "The ARN of the IAM User Profile.", + "type": "string" + } + }, + "type": "object" + }, + "SsoUserProfileDetails": { + "additionalProperties": false, + "description": "The details of the SSO User Profile.", + "properties": { + "FirstName": { + "description": "The First Name of the IAM User Profile.", + "type": "string" + }, + "LastName": { + "description": "The Last Name of the IAM User Profile.", + "type": "string" + }, + "Username": { + "description": "The username of the SSO User Profile.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "type": "string" + } + }, + "type": "object" + }, + "UserProfileDetails": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Iam": { + "$ref": "#/definitions/IamUserProfileDetails" + } + }, + "required": [ + "Iam" + ], + "title": "Iam", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Sso": { + "$ref": "#/definitions/SsoUserProfileDetails" + } + }, + "required": [ + "Sso" + ], + "title": "Sso", + "type": "object" + } + ] + }, + "UserProfileStatus": { + "description": "The status of the user profile.", + "enum": [ + "ASSIGNED", + "NOT_ASSIGNED", + "ACTIVATED", + "DEACTIVATED" + ], + "type": "string" + }, + "UserProfileType": { + "description": "The type of the user profile.", + "enum": [ + "IAM", + "SSO" + ], + "type": "string" + }, + "UserType": { + "description": "The type of the user.", + "enum": [ + "IAM_USER", + "IAM_ROLE", + "SSO_USER" + ], + "type": "string" + } + }, + "description": "A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "datazone:GetDomain", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "UserType": { + "$ref": "resource-schema.json#/properties/UserType" + } + }, + "required": [ + "DomainIdentifier", + "UserType" + ] + }, + "permissions": [ + "datazone:SearchUserProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetUserProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "Details": { + "$ref": "#/definitions/UserProfileDetails" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the user profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the user profile would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of the Amazon DataZone user profile.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/UserProfileStatus" + }, + "Type": { + "$ref": "#/definitions/UserProfileType" + }, + "UserIdentifier": { + "description": "The ID of the user.", + "pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)", + "type": "string" + }, + "UserType": { + "$ref": "#/definitions/UserType" + } + }, + "readOnlyProperties": [ + "/properties/DomainId", + "/properties/Type", + "/properties/Id", + "/properties/Details" + ], + "required": [ + "DomainIdentifier", + "UserIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::UserProfile", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/UserIdentifier", + "/properties/UserType" + ] +} diff --git a/schema/aws-dax-cluster.json b/schema/aws-dax-cluster.json index 30dd631..8a2b3c3 100644 --- a/schema/aws-dax-cluster.json +++ b/schema/aws-dax-cluster.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IAMRoleARN", - "/properties/SSESpecification", - "/properties/ClusterEndpointEncryptionType", - "/properties/ClusterName", - "/properties/NodeType", - "/properties/SubnetGroupName" - ], - "definitions": { - "SSESpecification": { - "additionalProperties": false, - "properties": { - "SSEEnabled": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DAX::Cluster", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ClusterDiscoveryEndpoint": { - "type": "string" - }, - "ClusterDiscoveryEndpointURL": { - "type": "string" - }, - "ClusterEndpointEncryptionType": { - "type": "string" - }, - "ClusterName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "IAMRoleARN": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NodeType": { - "type": "string" - }, - "NotificationTopicARN": { - "type": "string" - }, - "ParameterGroupName": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ReplicationFactor": { - "type": "integer" - }, - "SSESpecification": { - "$ref": "#/definitions/SSESpecification" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetGroupName": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ClusterDiscoveryEndpoint", - "/properties/Arn", - "/properties/ClusterDiscoveryEndpointURL" - ], - "required": [ - "ReplicationFactor", - "IAMRoleARN", - "NodeType" - ], - "typeName": "AWS::DAX::Cluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IAMRoleARN", + "/properties/SSESpecification", + "/properties/ClusterEndpointEncryptionType", + "/properties/ClusterName", + "/properties/NodeType", + "/properties/SubnetGroupName" + ], + "definitions": { + "SSESpecification": { + "additionalProperties": false, + "properties": { + "SSEEnabled": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DAX::Cluster", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ClusterDiscoveryEndpoint": { + "type": "string" + }, + "ClusterDiscoveryEndpointURL": { + "type": "string" + }, + "ClusterEndpointEncryptionType": { + "type": "string" + }, + "ClusterName": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "IAMRoleARN": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NodeType": { + "type": "string" + }, + "NotificationTopicARN": { + "type": "string" + }, + "ParameterGroupName": { + "type": "string" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "ReplicationFactor": { + "type": "integer" + }, + "SSESpecification": { + "$ref": "#/definitions/SSESpecification" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetGroupName": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ClusterDiscoveryEndpoint", + "/properties/Arn", + "/properties/ClusterDiscoveryEndpointURL" + ], + "required": [ + "ReplicationFactor", + "IAMRoleARN", + "NodeType" + ], + "typeName": "AWS::DAX::Cluster" +} diff --git a/schema/aws-dax-parametergroup.json b/schema/aws-dax-parametergroup.json index 9c306e8..b67f2db 100644 --- a/schema/aws-dax-parametergroup.json +++ b/schema/aws-dax-parametergroup.json @@ -1,28 +1,28 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ParameterGroupName" - ], - "description": "Resource Type definition for AWS::DAX::ParameterGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ParameterGroupName": { - "type": "string" - }, - "ParameterNameValues": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::DAX::ParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ParameterGroupName" + ], + "description": "Resource Type definition for AWS::DAX::ParameterGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ParameterGroupName": { + "type": "string" + }, + "ParameterNameValues": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::DAX::ParameterGroup" +} diff --git a/schema/aws-dax-subnetgroup.json b/schema/aws-dax-subnetgroup.json index d2acd59..95c760b 100644 --- a/schema/aws-dax-subnetgroup.json +++ b/schema/aws-dax-subnetgroup.json @@ -1,35 +1,35 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetGroupName" - ], - "description": "Resource Type definition for AWS::DAX::SubnetGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SubnetGroupName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SubnetIds" - ], - "typeName": "AWS::DAX::SubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetGroupName" + ], + "description": "Resource Type definition for AWS::DAX::SubnetGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SubnetGroupName": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SubnetIds" + ], + "typeName": "AWS::DAX::SubnetGroup" +} diff --git a/schema/aws-deadline-farm.json b/schema/aws-deadline-farm.json index 27282e5..379f411 100644 --- a/schema/aws-deadline-farm.json +++ b/schema/aws-deadline-farm.json @@ -1,147 +1,147 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Deadline::Farm Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateFarm", - "deadline:GetFarm", - "deadline:TagResource", - "deadline:ListTagsForResource", - "identitystore:ListGroupMembershipsForMember", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteFarm", - "deadline:GetFarm", - "identitystore:ListGroupMembershipsForMember", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:GenerateDataKey" - ] - }, - "list": { - "permissions": [ - "deadline:ListFarms", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetFarm", - "deadline:ListTagsForResource", - "identitystore:ListGroupMembershipsForMember", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:GenerateDataKey" - ] - }, - "update": { - "permissions": [ - "deadline:UpdateFarm", - "deadline:GetFarm", - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource", - "identitystore:ListGroupMembershipsForMember", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}$", - "type": "string" - }, - "Description": { - "default": "", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "KmsKeyArn": { - "pattern": "^arn:aws[-a-z]*:kms:.*:key/.*", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/FarmId", - "/properties/Arn" - ], - "required": [ - "DisplayName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Deadline::Farm" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Farm Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateFarm", + "deadline:GetFarm", + "deadline:TagResource", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteFarm", + "deadline:GetFarm", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "list": { + "permissions": [ + "deadline:ListFarms", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetFarm", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateFarm", + "deadline:GetFarm", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}$", + "type": "string" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "KmsKeyArn": { + "pattern": "^arn:aws[-a-z]*:kms:.*:key/.*", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/FarmId", + "/properties/Arn" + ], + "required": [ + "DisplayName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Farm" +} diff --git a/schema/aws-deadline-fleet.json b/schema/aws-deadline-fleet.json index 931c88c..0a404f3 100644 --- a/schema/aws-deadline-fleet.json +++ b/schema/aws-deadline-fleet.json @@ -1,591 +1,593 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FarmId" - ], - "definitions": { - "AcceleratorCountRange": { - "additionalProperties": false, - "properties": { - "Max": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "Min": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Min" - ], - "type": "object" - }, - "AcceleratorTotalMemoryMiBRange": { - "additionalProperties": false, - "properties": { - "Max": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "Min": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Min" - ], - "type": "object" - }, - "AcceleratorType": { - "enum": [ - "gpu" - ], - "type": "string" - }, - "AutoScalingMode": { - "enum": [ - "NO_SCALING", - "EVENT_BASED_AUTO_SCALING" - ], - "type": "string" - }, - "CpuArchitectureType": { - "enum": [ - "x86_64", - "arm64" - ], - "type": "string" - }, - "CustomerManagedFleetConfiguration": { - "additionalProperties": false, - "properties": { - "Mode": { - "$ref": "#/definitions/AutoScalingMode" - }, - "StorageProfileId": { - "pattern": "^sp-[0-9a-f]{32}$", - "type": "string" - }, - "WorkerCapabilities": { - "$ref": "#/definitions/CustomerManagedWorkerCapabilities" - } - }, - "required": [ - "Mode", - "WorkerCapabilities" - ], - "type": "object" - }, - "CustomerManagedFleetOperatingSystemFamily": { - "enum": [ - "WINDOWS", - "LINUX", - "MACOS" - ], - "type": "string" - }, - "CustomerManagedWorkerCapabilities": { - "additionalProperties": false, - "properties": { - "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCountRange" - }, - "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiBRange" - }, - "AcceleratorTypes": { - "items": { - "$ref": "#/definitions/AcceleratorType" - }, - "type": "array" - }, - "CpuArchitectureType": { - "$ref": "#/definitions/CpuArchitectureType" - }, - "CustomAmounts": { - "items": { - "$ref": "#/definitions/FleetAmountCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "CustomAttributes": { - "items": { - "$ref": "#/definitions/FleetAttributeCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRange" - }, - "OsFamily": { - "$ref": "#/definitions/CustomerManagedFleetOperatingSystemFamily" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCountRange" - } - }, - "required": [ - "CpuArchitectureType", - "MemoryMiB", - "OsFamily", - "VCpuCount" - ], - "type": "object" - }, - "Ec2EbsVolume": { - "additionalProperties": false, - "properties": { - "Iops": { - "default": 3000, - "maximum": 16000, - "minimum": 3000, - "type": "integer" - }, - "SizeGiB": { - "default": 250, - "type": "integer" - }, - "ThroughputMiB": { - "default": 125, - "maximum": 1000, - "minimum": 125, - "type": "integer" - } - }, - "type": "object" - }, - "Ec2MarketType": { - "enum": [ - "on-demand", - "spot" - ], - "type": "string" - }, - "FleetAmountCapability": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", - "type": "string" - } - }, - "required": [ - "Min", - "Name" - ], - "type": "object" - }, - "FleetAttributeCapability": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", - "type": "string" - }, - "Values": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z_]([a-zA-Z0-9_\\-]{0,99})$", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "FleetCapabilities": { - "additionalProperties": false, - "properties": { - "Amounts": { - "items": { - "$ref": "#/definitions/FleetAmountCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "Attributes": { - "items": { - "$ref": "#/definitions/FleetAttributeCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "FleetConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "CustomerManaged": { - "$ref": "#/definitions/CustomerManagedFleetConfiguration" - } - }, - "required": [ - "CustomerManaged" - ], - "title": "CustomerManaged", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ServiceManagedEc2": { - "$ref": "#/definitions/ServiceManagedEc2FleetConfiguration" - } - }, - "required": [ - "ServiceManagedEc2" - ], - "title": "ServiceManagedEc2", - "type": "object" - } - ] - }, - "FleetStatus": { - "enum": [ - "ACTIVE", - "CREATE_IN_PROGRESS", - "UPDATE_IN_PROGRESS", - "CREATE_FAILED", - "UPDATE_FAILED" - ], - "type": "string" - }, - "MemoryMiBRange": { - "additionalProperties": false, - "properties": { - "Max": { - "maximum": 2147483647, - "minimum": 512, - "type": "integer" - }, - "Min": { - "maximum": 2147483647, - "minimum": 512, - "type": "integer" - } - }, - "required": [ - "Min" - ], - "type": "object" - }, - "ServiceManagedEc2FleetConfiguration": { - "additionalProperties": false, - "properties": { - "InstanceCapabilities": { - "$ref": "#/definitions/ServiceManagedEc2InstanceCapabilities" - }, - "InstanceMarketOptions": { - "$ref": "#/definitions/ServiceManagedEc2InstanceMarketOptions" - } - }, - "required": [ - "InstanceCapabilities", - "InstanceMarketOptions" - ], - "type": "object" - }, - "ServiceManagedEc2InstanceCapabilities": { - "additionalProperties": false, - "properties": { - "AllowedInstanceTypes": { - "items": { - "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "CpuArchitectureType": { - "$ref": "#/definitions/CpuArchitectureType" - }, - "CustomAmounts": { - "items": { - "$ref": "#/definitions/FleetAmountCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "CustomAttributes": { - "items": { - "$ref": "#/definitions/FleetAttributeCapability" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "ExcludedInstanceTypes": { - "items": { - "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRange" - }, - "OsFamily": { - "$ref": "#/definitions/ServiceManagedFleetOperatingSystemFamily" - }, - "RootEbsVolume": { - "$ref": "#/definitions/Ec2EbsVolume" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCountRange" - } - }, - "required": [ - "CpuArchitectureType", - "MemoryMiB", - "OsFamily", - "VCpuCount" - ], - "type": "object" - }, - "ServiceManagedEc2InstanceMarketOptions": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/Ec2MarketType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ServiceManagedFleetOperatingSystemFamily": { - "enum": [ - "LINUX" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VCpuCountRange": { - "additionalProperties": false, - "properties": { - "Max": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "Min": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "Min" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Deadline::Fleet Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateFleet", - "deadline:GetFleet", - "iam:PassRole", - "identitystore:ListGroupMembershipsForMember", - "logs:CreateLogGroup", - "deadline:TagResource", - "deadline:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteFleet", - "deadline:GetFleet", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FarmId": { - "$ref": "resource-schema.json#/properties/FarmId" - } - }, - "required": [ - "FarmId" - ] - }, - "permissions": [ - "deadline:ListFleets", - "identitystore:DescribeGroup", - "identitystore:DescribeUser", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetFleet", - "identitystore:ListGroupMembershipsForMember", - "deadline:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "deadline:UpdateFleet", - "deadline:GetFleet", - "iam:PassRole", - "identitystore:ListGroupMembershipsForMember", - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}/fleet/fleet-[0-9a-z]{32}", - "type": "string" - }, - "Capabilities": { - "$ref": "#/definitions/FleetCapabilities" - }, - "Configuration": { - "$ref": "#/definitions/FleetConfiguration" - }, - "Description": { - "default": "", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "FleetId": { - "pattern": "^fleet-[0-9a-f]{32}$", - "type": "string" - }, - "MaxWorkerCount": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "MinWorkerCount": { - "default": 0, - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "RoleArn": { - "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/FleetStatus" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "WorkerCount": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Capabilities", - "/properties/FleetId", - "/properties/Status", - "/properties/WorkerCount", - "/properties/Arn" - ], - "required": [ - "Configuration", - "DisplayName", - "MaxWorkerCount", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Deadline::Fleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "AcceleratorCountRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "AcceleratorTotalMemoryMiBRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "AcceleratorType": { + "enum": [ + "gpu" + ], + "type": "string" + }, + "AutoScalingMode": { + "enum": [ + "NO_SCALING", + "EVENT_BASED_AUTO_SCALING" + ], + "type": "string" + }, + "CpuArchitectureType": { + "enum": [ + "x86_64", + "arm64" + ], + "type": "string" + }, + "CustomerManagedFleetConfiguration": { + "additionalProperties": false, + "properties": { + "Mode": { + "$ref": "#/definitions/AutoScalingMode" + }, + "StorageProfileId": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + }, + "WorkerCapabilities": { + "$ref": "#/definitions/CustomerManagedWorkerCapabilities" + } + }, + "required": [ + "Mode", + "WorkerCapabilities" + ], + "type": "object" + }, + "CustomerManagedFleetOperatingSystemFamily": { + "enum": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "type": "string" + }, + "CustomerManagedWorkerCapabilities": { + "additionalProperties": false, + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRange" + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRange" + }, + "AcceleratorTypes": { + "items": { + "$ref": "#/definitions/AcceleratorType" + }, + "type": "array" + }, + "CpuArchitectureType": { + "$ref": "#/definitions/CpuArchitectureType" + }, + "CustomAmounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "CustomAttributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRange" + }, + "OsFamily": { + "$ref": "#/definitions/CustomerManagedFleetOperatingSystemFamily" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRange" + } + }, + "required": [ + "CpuArchitectureType", + "MemoryMiB", + "OsFamily", + "VCpuCount" + ], + "type": "object" + }, + "Ec2EbsVolume": { + "additionalProperties": false, + "properties": { + "Iops": { + "default": 3000, + "maximum": 16000, + "minimum": 3000, + "type": "integer" + }, + "SizeGiB": { + "default": 250, + "type": "integer" + }, + "ThroughputMiB": { + "default": 125, + "maximum": 1000, + "minimum": 125, + "type": "integer" + } + }, + "type": "object" + }, + "Ec2MarketType": { + "enum": [ + "on-demand", + "spot" + ], + "type": "string" + }, + "FleetAmountCapability": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", + "type": "string" + } + }, + "required": [ + "Min", + "Name" + ], + "type": "object" + }, + "FleetAttributeCapability": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", + "type": "string" + }, + "Values": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z_]([a-zA-Z0-9_\\-]{0,99})$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "FleetCapabilities": { + "additionalProperties": false, + "properties": { + "Amounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "Attributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FleetConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "CustomerManaged": { + "$ref": "#/definitions/CustomerManagedFleetConfiguration" + } + }, + "required": [ + "CustomerManaged" + ], + "title": "CustomerManaged", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ServiceManagedEc2": { + "$ref": "#/definitions/ServiceManagedEc2FleetConfiguration" + } + }, + "required": [ + "ServiceManagedEc2" + ], + "title": "ServiceManagedEc2", + "type": "object" + } + ] + }, + "FleetStatus": { + "enum": [ + "ACTIVE", + "CREATE_IN_PROGRESS", + "UPDATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_FAILED" + ], + "type": "string" + }, + "MemoryMiBRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 512, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 512, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "ServiceManagedEc2FleetConfiguration": { + "additionalProperties": false, + "properties": { + "InstanceCapabilities": { + "$ref": "#/definitions/ServiceManagedEc2InstanceCapabilities" + }, + "InstanceMarketOptions": { + "$ref": "#/definitions/ServiceManagedEc2InstanceMarketOptions" + } + }, + "required": [ + "InstanceCapabilities", + "InstanceMarketOptions" + ], + "type": "object" + }, + "ServiceManagedEc2InstanceCapabilities": { + "additionalProperties": false, + "properties": { + "AllowedInstanceTypes": { + "items": { + "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "CpuArchitectureType": { + "$ref": "#/definitions/CpuArchitectureType" + }, + "CustomAmounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "CustomAttributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "ExcludedInstanceTypes": { + "items": { + "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRange" + }, + "OsFamily": { + "$ref": "#/definitions/ServiceManagedFleetOperatingSystemFamily" + }, + "RootEbsVolume": { + "$ref": "#/definitions/Ec2EbsVolume" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRange" + } + }, + "required": [ + "CpuArchitectureType", + "MemoryMiB", + "OsFamily", + "VCpuCount" + ], + "type": "object" + }, + "ServiceManagedEc2InstanceMarketOptions": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/Ec2MarketType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ServiceManagedFleetOperatingSystemFamily": { + "enum": [ + "LINUX", + "WINDOWS" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VCpuCountRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "Min": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Fleet Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateFleet", + "deadline:GetFleet", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteFleet", + "deadline:GetFleet", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListFleets", + "identitystore:DescribeGroup", + "identitystore:DescribeUser", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetFleet", + "identitystore:ListGroupMembershipsForMember", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateFleet", + "deadline:GetFleet", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}/fleet/fleet-[0-9a-z]{32}", + "type": "string" + }, + "Capabilities": { + "$ref": "#/definitions/FleetCapabilities" + }, + "Configuration": { + "$ref": "#/definitions/FleetConfiguration" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "FleetId": { + "pattern": "^fleet-[0-9a-f]{32}$", + "type": "string" + }, + "MaxWorkerCount": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "MinWorkerCount": { + "default": 0, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/FleetStatus" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "WorkerCount": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Capabilities", + "/properties/FleetId", + "/properties/Status", + "/properties/WorkerCount", + "/properties/Arn" + ], + "required": [ + "Configuration", + "DisplayName", + "FarmId", + "MaxWorkerCount", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Fleet" +} diff --git a/schema/aws-deadline-licenseendpoint.json b/schema/aws-deadline-licenseendpoint.json index 7bac7a9..2830efa 100644 --- a/schema/aws-deadline-licenseendpoint.json +++ b/schema/aws-deadline-licenseendpoint.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SecurityGroupIds", - "/properties/SubnetIds", - "/properties/VpcId" - ], - "definitions": { - "LicenseEndpointStatus": { - "enum": [ - "CREATE_IN_PROGRESS", - "DELETE_IN_PROGRESS", - "READY", - "NOT_READY" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Deadline::LicenseEndpoint Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateLicenseEndpoint", - "deadline:GetLicenseEndpoint", - "ec2:CreateTags", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "deadline:TagResource", - "deadline:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "deadline:GetLicenseEndpoint", - "deadline:DeleteLicenseEndpoint", - "ec2:DeleteVpcEndpoints", - "ec2:DescribeVpcEndpoints" - ] - }, - "list": { - "permissions": [ - "deadline:ListLicenseEndpoints" - ] - }, - "read": { - "permissions": [ - "deadline:GetLicenseEndpoint", - "deadline:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource", - "deadline:GetLicenseEndpoint" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}", - "type": "string" - }, - "DnsName": { - "type": "string" - }, - "LicenseEndpointId": { - "pattern": "^le-[0-9a-f]{32}$", - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/LicenseEndpointStatus" - }, - "StatusMessage": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "SubnetIds": { - "items": { - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "maxLength": 32, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DnsName", - "/properties/LicenseEndpointId", - "/properties/Status", - "/properties/StatusMessage", - "/properties/Arn" - ], - "required": [ - "SecurityGroupIds", - "SubnetIds", - "VpcId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Deadline::LicenseEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SecurityGroupIds", + "/properties/SubnetIds", + "/properties/VpcId" + ], + "definitions": { + "LicenseEndpointStatus": { + "enum": [ + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "READY", + "NOT_READY" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::LicenseEndpoint Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateLicenseEndpoint", + "deadline:GetLicenseEndpoint", + "ec2:CreateTags", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:GetLicenseEndpoint", + "deadline:DeleteLicenseEndpoint", + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints" + ] + }, + "list": { + "permissions": [ + "deadline:ListLicenseEndpoints" + ] + }, + "read": { + "permissions": [ + "deadline:GetLicenseEndpoint", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource", + "deadline:GetLicenseEndpoint" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}", + "type": "string" + }, + "DnsName": { + "type": "string" + }, + "LicenseEndpointId": { + "pattern": "^le-[0-9a-f]{32}$", + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/LicenseEndpointStatus" + }, + "StatusMessage": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "SubnetIds": { + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DnsName", + "/properties/LicenseEndpointId", + "/properties/Status", + "/properties/StatusMessage", + "/properties/Arn" + ], + "required": [ + "SecurityGroupIds", + "SubnetIds", + "VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::LicenseEndpoint" +} diff --git a/schema/aws-deadline-meteredproduct.json b/schema/aws-deadline-meteredproduct.json index 6e5ec86..8ca0fa1 100644 --- a/schema/aws-deadline-meteredproduct.json +++ b/schema/aws-deadline-meteredproduct.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LicenseEndpointId", - "/properties/ProductId" - ], - "description": "Definition of AWS::Deadline::MeteredProduct Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:PutMeteredProduct", - "deadline:ListMeteredProducts" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteMeteredProduct", - "deadline:ListMeteredProducts" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "LicenseEndpointId": { - "$ref": "resource-schema.json#/properties/LicenseEndpointId" - } - }, - "required": [ - "LicenseEndpointId" - ] - }, - "permissions": [ - "deadline:ListMeteredProducts" - ] - }, - "read": { - "permissions": [ - "deadline:GetMeteredProduct", - "deadline:ListMeteredProducts" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}/metered-product/[0-9a-z]{1,32}-[.0-9a-z]{1,32}", - "type": "string" - }, - "Family": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "LicenseEndpointId": { - "pattern": "^le-[0-9a-f]{32}$", - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1024, - "type": "integer" - }, - "ProductId": { - "pattern": "^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$", - "type": "string" - }, - "Vendor": { - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Port", - "/properties/Family", - "/properties/Vendor" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Deadline::MeteredProduct" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LicenseEndpointId", + "/properties/ProductId" + ], + "description": "Definition of AWS::Deadline::MeteredProduct Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:PutMeteredProduct", + "deadline:ListMeteredProducts" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteMeteredProduct", + "deadline:ListMeteredProducts" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "LicenseEndpointId": { + "$ref": "resource-schema.json#/properties/LicenseEndpointId" + } + }, + "required": [ + "LicenseEndpointId" + ] + }, + "permissions": [ + "deadline:ListMeteredProducts" + ] + }, + "read": { + "permissions": [ + "deadline:GetMeteredProduct", + "deadline:ListMeteredProducts" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}/metered-product/[0-9a-z]{1,32}-[.0-9a-z]{1,32}", + "type": "string" + }, + "Family": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "LicenseEndpointId": { + "pattern": "^le-[0-9a-f]{32}$", + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "ProductId": { + "pattern": "^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$", + "type": "string" + }, + "Vendor": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Port", + "/properties/Family", + "/properties/Vendor" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::MeteredProduct" +} diff --git a/schema/aws-deadline-monitor.json b/schema/aws-deadline-monitor.json index 3c4bd5d..427d029 100644 --- a/schema/aws-deadline-monitor.json +++ b/schema/aws-deadline-monitor.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityCenterInstanceArn" - ], - "description": "Definition of AWS::Deadline::Monitor Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateMonitor", - "deadline:GetMonitor", - "iam:PassRole", - "kms:CreateGrant", - "sso:CreateApplication", - "sso:DeleteApplication", - "sso:PutApplicationAssignmentConfiguration", - "sso:PutApplicationAuthenticationMethod", - "sso:PutApplicationGrant" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteMonitor", - "deadline:GetMonitor", - "sso:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "deadline:ListMonitors" - ] - }, - "read": { - "permissions": [ - "deadline:GetMonitor" - ] - }, - "update": { - "permissions": [ - "deadline:GetMonitor", - "deadline:UpdateMonitor", - "iam:PassRole", - "kms:CreateGrant", - "sso:PutApplicationGrant", - "sso:UpdateApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:monitor/monitor-[0-9a-z]{32}$", - "type": "string" - }, - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "IdentityCenterApplicationArn": { - "type": "string" - }, - "IdentityCenterInstanceArn": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", - "type": "string" - }, - "MonitorId": { - "pattern": "^monitor-[0-9a-f]{32}$", - "type": "string" - }, - "RoleArn": { - "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", - "type": "string" - }, - "Subdomain": { - "pattern": "^[a-z0-9-]{1,100}$", - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IdentityCenterApplicationArn", - "/properties/MonitorId", - "/properties/Url", - "/properties/Arn" - ], - "required": [ - "DisplayName", - "IdentityCenterInstanceArn", - "RoleArn", - "Subdomain" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Deadline::Monitor" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityCenterInstanceArn" + ], + "description": "Definition of AWS::Deadline::Monitor Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateMonitor", + "deadline:GetMonitor", + "iam:PassRole", + "kms:CreateGrant", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:PutApplicationAssignmentConfiguration", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteMonitor", + "deadline:GetMonitor", + "sso:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "deadline:ListMonitors" + ] + }, + "read": { + "permissions": [ + "deadline:GetMonitor" + ] + }, + "update": { + "permissions": [ + "deadline:GetMonitor", + "deadline:UpdateMonitor", + "iam:PassRole", + "kms:CreateGrant", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:monitor/monitor-[0-9a-z]{32}$", + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "IdentityCenterApplicationArn": { + "type": "string" + }, + "IdentityCenterInstanceArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "MonitorId": { + "pattern": "^monitor-[0-9a-f]{32}$", + "type": "string" + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Subdomain": { + "pattern": "^[a-z0-9-]{1,100}$", + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdentityCenterApplicationArn", + "/properties/MonitorId", + "/properties/Url", + "/properties/Arn" + ], + "required": [ + "DisplayName", + "IdentityCenterInstanceArn", + "RoleArn", + "Subdomain" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::Monitor" +} diff --git a/schema/aws-deadline-queue.json b/schema/aws-deadline-queue.json index 09eed07..6946818 100644 --- a/schema/aws-deadline-queue.json +++ b/schema/aws-deadline-queue.json @@ -1,284 +1,285 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FarmId" - ], - "definitions": { - "DefaultQueueBudgetAction": { - "default": "NONE", - "enum": [ - "NONE", - "STOP_SCHEDULING_AND_COMPLETE_TASKS", - "STOP_SCHEDULING_AND_CANCEL_TASKS" - ], - "type": "string" - }, - "JobAttachmentSettings": { - "additionalProperties": false, - "properties": { - "RootPrefix": { - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)", - "type": "string" - } - }, - "required": [ - "RootPrefix", - "S3BucketName" - ], - "type": "object" - }, - "JobRunAsUser": { - "additionalProperties": false, - "properties": { - "Posix": { - "$ref": "#/definitions/PosixUser" - }, - "RunAs": { - "$ref": "#/definitions/RunAs" - }, - "Windows": { - "$ref": "#/definitions/WindowsUser" - } - }, - "required": [ - "RunAs" - ], - "type": "object" - }, - "PosixUser": { - "additionalProperties": false, - "properties": { - "Group": { - "maxLength": 31, - "minLength": 0, - "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", - "type": "string" - }, - "User": { - "maxLength": 31, - "minLength": 0, - "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", - "type": "string" - } - }, - "required": [ - "Group", - "User" - ], - "type": "object" - }, - "RunAs": { - "enum": [ - "QUEUE_CONFIGURED_USER", - "WORKER_AGENT_USER" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WindowsUser": { - "additionalProperties": false, - "properties": { - "PasswordArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*):secretsmanager:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:secret:[a-zA-Z0-9-/_+=.@]{1,2028}$", - "type": "string" - }, - "User": { - "maxLength": 111, - "minLength": 0, - "pattern": "^[^\"'/\\[\\]:;|=,+*?<>\\s]*$", - "type": "string" - } - }, - "required": [ - "PasswordArn", - "User" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Deadline::Queue Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateQueue", - "deadline:GetQueue", - "iam:PassRole", - "identitystore:ListGroupMembershipsForMember", - "logs:CreateLogGroup", - "s3:ListBucket", - "deadline:TagResource", - "deadline:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteQueue", - "deadline:GetQueue", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FarmId": { - "$ref": "resource-schema.json#/properties/FarmId" - } - }, - "required": [ - "FarmId" - ] - }, - "permissions": [ - "deadline:ListQueues", - "identitystore:DescribeGroup", - "identitystore:DescribeUser", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetQueue", - "identitystore:ListGroupMembershipsForMember", - "deadline:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "deadline:UpdateQueue", - "deadline:GetQueue", - "iam:PassRole", - "identitystore:ListGroupMembershipsForMember", - "logs:CreateLogGroup", - "s3:ListBucket", - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AllowedStorageProfileIds": { - "items": { - "pattern": "^sp-[0-9a-f]{32}$", - "type": "string" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "pattern": "^arn:*", - "type": "string" - }, - "DefaultBudgetAction": { - "$ref": "#/definitions/DefaultQueueBudgetAction" - }, - "Description": { - "default": "", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "JobAttachmentSettings": { - "$ref": "#/definitions/JobAttachmentSettings" - }, - "JobRunAsUser": { - "$ref": "#/definitions/JobRunAsUser" - }, - "QueueId": { - "pattern": "^queue-[0-9a-f]{32}$", - "type": "string" - }, - "RequiredFileSystemLocationNames": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9A-Za-z ]*$", - "type": "string" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "RoleArn": { - "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/QueueId", - "/properties/Arn" - ], - "required": [ - "DisplayName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "deadline:TagResource", - "deadline:UntagResource", - "deadline:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Deadline::Queue" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "DefaultQueueBudgetAction": { + "default": "NONE", + "enum": [ + "NONE", + "STOP_SCHEDULING_AND_COMPLETE_TASKS", + "STOP_SCHEDULING_AND_CANCEL_TASKS" + ], + "type": "string" + }, + "JobAttachmentSettings": { + "additionalProperties": false, + "properties": { + "RootPrefix": { + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)", + "type": "string" + } + }, + "required": [ + "RootPrefix", + "S3BucketName" + ], + "type": "object" + }, + "JobRunAsUser": { + "additionalProperties": false, + "properties": { + "Posix": { + "$ref": "#/definitions/PosixUser" + }, + "RunAs": { + "$ref": "#/definitions/RunAs" + }, + "Windows": { + "$ref": "#/definitions/WindowsUser" + } + }, + "required": [ + "RunAs" + ], + "type": "object" + }, + "PosixUser": { + "additionalProperties": false, + "properties": { + "Group": { + "maxLength": 31, + "minLength": 0, + "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", + "type": "string" + }, + "User": { + "maxLength": 31, + "minLength": 0, + "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", + "type": "string" + } + }, + "required": [ + "Group", + "User" + ], + "type": "object" + }, + "RunAs": { + "enum": [ + "QUEUE_CONFIGURED_USER", + "WORKER_AGENT_USER" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WindowsUser": { + "additionalProperties": false, + "properties": { + "PasswordArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*):secretsmanager:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:secret:[a-zA-Z0-9-/_+=.@]{1,2028}$", + "type": "string" + }, + "User": { + "maxLength": 111, + "minLength": 0, + "pattern": "^[^\"'/\\[\\]:;|=,+*?<>\\s]*$", + "type": "string" + } + }, + "required": [ + "PasswordArn", + "User" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Queue Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateQueue", + "deadline:GetQueue", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "s3:ListBucket", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteQueue", + "deadline:GetQueue", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListQueues", + "identitystore:DescribeGroup", + "identitystore:DescribeUser", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetQueue", + "identitystore:ListGroupMembershipsForMember", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateQueue", + "deadline:GetQueue", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "s3:ListBucket", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AllowedStorageProfileIds": { + "items": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "pattern": "^arn:*", + "type": "string" + }, + "DefaultBudgetAction": { + "$ref": "#/definitions/DefaultQueueBudgetAction" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "JobAttachmentSettings": { + "$ref": "#/definitions/JobAttachmentSettings" + }, + "JobRunAsUser": { + "$ref": "#/definitions/JobRunAsUser" + }, + "QueueId": { + "pattern": "^queue-[0-9a-f]{32}$", + "type": "string" + }, + "RequiredFileSystemLocationNames": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z ]*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/QueueId", + "/properties/Arn" + ], + "required": [ + "DisplayName", + "FarmId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Queue" +} diff --git a/schema/aws-deadline-queueenvironment.json b/schema/aws-deadline-queueenvironment.json index 13c8e21..932758f 100644 --- a/schema/aws-deadline-queueenvironment.json +++ b/schema/aws-deadline-queueenvironment.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FarmId", - "/properties/QueueId" - ], - "definitions": { - "EnvironmentTemplateType": { - "enum": [ - "JSON", - "YAML" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Deadline::QueueEnvironment Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateQueueEnvironment", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteQueueEnvironment", - "deadline:GetQueueEnvironment", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FarmId": { - "$ref": "resource-schema.json#/properties/FarmId" - }, - "QueueId": { - "$ref": "resource-schema.json#/properties/QueueId" - } - }, - "required": [ - "FarmId", - "QueueId" - ] - }, - "permissions": [ - "deadline:ListQueueEnvironments", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetQueueEnvironment", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "update": { - "permissions": [ - "deadline:UpdateQueueEnvironment", - "identitystore:ListGroupMembershipsForMember" - ] - } - }, - "primaryIdentifier": [ - "/properties/FarmId", - "/properties/QueueId", - "/properties/QueueEnvironmentId" - ], - "properties": { - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Priority": { - "maximum": 10000, - "minimum": 0, - "type": "integer" - }, - "QueueEnvironmentId": { - "pattern": "^queueenv-[0-9a-f]{32}$", - "type": "string" - }, - "QueueId": { - "pattern": "^queue-[0-9a-f]{32}$", - "type": "string" - }, - "Template": { - "maxLength": 15000, - "minLength": 1, - "type": "string" - }, - "TemplateType": { - "$ref": "#/definitions/EnvironmentTemplateType" - } - }, - "readOnlyProperties": [ - "/properties/Name", - "/properties/QueueEnvironmentId" - ], - "required": [ - "FarmId", - "QueueId", - "Priority", - "Template", - "TemplateType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Deadline::QueueEnvironment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId", + "/properties/QueueId" + ], + "definitions": { + "EnvironmentTemplateType": { + "enum": [ + "JSON", + "YAML" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Deadline::QueueEnvironment Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteQueueEnvironment", + "deadline:GetQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + }, + "QueueId": { + "$ref": "resource-schema.json#/properties/QueueId" + } + }, + "required": [ + "FarmId", + "QueueId" + ] + }, + "permissions": [ + "deadline:ListQueueEnvironments", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + } + }, + "primaryIdentifier": [ + "/properties/FarmId", + "/properties/QueueId", + "/properties/QueueEnvironmentId" + ], + "properties": { + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Priority": { + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "QueueEnvironmentId": { + "pattern": "^queueenv-[0-9a-f]{32}$", + "type": "string" + }, + "QueueId": { + "pattern": "^queue-[0-9a-f]{32}$", + "type": "string" + }, + "Template": { + "maxLength": 15000, + "minLength": 1, + "type": "string" + }, + "TemplateType": { + "$ref": "#/definitions/EnvironmentTemplateType" + } + }, + "readOnlyProperties": [ + "/properties/Name", + "/properties/QueueEnvironmentId" + ], + "required": [ + "FarmId", + "QueueId", + "Priority", + "Template", + "TemplateType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::QueueEnvironment" +} diff --git a/schema/aws-deadline-queuefleetassociation.json b/schema/aws-deadline-queuefleetassociation.json index 5be049c..4a90466 100644 --- a/schema/aws-deadline-queuefleetassociation.json +++ b/schema/aws-deadline-queuefleetassociation.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FarmId", - "/properties/FleetId", - "/properties/QueueId" - ], - "description": "Definition of AWS::Deadline::QueueFleetAssociation Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateQueueFleetAssociation", - "deadline:GetQueueFleetAssociation", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteQueueFleetAssociation", - "deadline:GetQueueFleetAssociation", - "deadline:UpdateQueueFleetAssociation", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FarmId": { - "$ref": "resource-schema.json#/properties/FarmId" - } - }, - "required": [ - "FarmId" - ] - }, - "permissions": [ - "deadline:ListQueueFleetAssociations", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetQueueFleetAssociation", - "identitystore:ListGroupMembershipsForMember" - ] - } - }, - "primaryIdentifier": [ - "/properties/FarmId", - "/properties/FleetId", - "/properties/QueueId" - ], - "properties": { - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "FleetId": { - "pattern": "^fleet-[0-9a-f]{32}$", - "type": "string" - }, - "QueueId": { - "pattern": "^queue-[0-9a-f]{32}$", - "type": "string" - } - }, - "required": [ - "FarmId", - "FleetId", - "QueueId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Deadline::QueueFleetAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId", + "/properties/FleetId", + "/properties/QueueId" + ], + "description": "Definition of AWS::Deadline::QueueFleetAssociation Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateQueueFleetAssociation", + "deadline:GetQueueFleetAssociation", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteQueueFleetAssociation", + "deadline:GetQueueFleetAssociation", + "deadline:UpdateQueueFleetAssociation", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListQueueFleetAssociations", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetQueueFleetAssociation", + "identitystore:ListGroupMembershipsForMember" + ] + } + }, + "primaryIdentifier": [ + "/properties/FarmId", + "/properties/FleetId", + "/properties/QueueId" + ], + "properties": { + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "FleetId": { + "pattern": "^fleet-[0-9a-f]{32}$", + "type": "string" + }, + "QueueId": { + "pattern": "^queue-[0-9a-f]{32}$", + "type": "string" + } + }, + "required": [ + "FarmId", + "FleetId", + "QueueId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::QueueFleetAssociation" +} diff --git a/schema/aws-deadline-storageprofile.json b/schema/aws-deadline-storageprofile.json index cb17851..65070e7 100644 --- a/schema/aws-deadline-storageprofile.json +++ b/schema/aws-deadline-storageprofile.json @@ -1,139 +1,140 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FarmId" - ], - "definitions": { - "FileSystemLocation": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9A-Za-z ]*$", - "type": "string" - }, - "Path": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/FileSystemLocationType" - } - }, - "required": [ - "Name", - "Path", - "Type" - ], - "type": "object" - }, - "FileSystemLocationType": { - "enum": [ - "SHARED", - "LOCAL" - ], - "type": "string" - }, - "StorageProfileOperatingSystemFamily": { - "enum": [ - "WINDOWS", - "LINUX", - "MACOS" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Deadline::StorageProfile Resource Type", - "handlers": { - "create": { - "permissions": [ - "deadline:CreateStorageProfile", - "deadline:GetStorageProfile", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "delete": { - "permissions": [ - "deadline:DeleteStorageProfile", - "deadline:GetStorageProfile", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FarmId": { - "$ref": "resource-schema.json#/properties/FarmId" - } - }, - "required": [ - "FarmId" - ] - }, - "permissions": [ - "deadline:ListStorageProfiles", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "read": { - "permissions": [ - "deadline:GetStorageProfile", - "identitystore:ListGroupMembershipsForMember" - ] - }, - "update": { - "permissions": [ - "deadline:UpdateStorageProfile", - "deadline:GetStorageProfile", - "identitystore:ListGroupMembershipsForMember" - ] - } - }, - "primaryIdentifier": [ - "/properties/FarmId", - "/properties/StorageProfileId" - ], - "properties": { - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "FarmId": { - "pattern": "^farm-[0-9a-f]{32}$", - "type": "string" - }, - "FileSystemLocations": { - "items": { - "$ref": "#/definitions/FileSystemLocation" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "OsFamily": { - "$ref": "#/definitions/StorageProfileOperatingSystemFamily" - }, - "StorageProfileId": { - "pattern": "^sp-[0-9a-f]{32}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/StorageProfileId" - ], - "required": [ - "DisplayName", - "OsFamily" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Deadline::StorageProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "FileSystemLocation": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z ]*$", + "type": "string" + }, + "Path": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FileSystemLocationType" + } + }, + "required": [ + "Name", + "Path", + "Type" + ], + "type": "object" + }, + "FileSystemLocationType": { + "enum": [ + "SHARED", + "LOCAL" + ], + "type": "string" + }, + "StorageProfileOperatingSystemFamily": { + "enum": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Deadline::StorageProfile Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListStorageProfiles", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + } + }, + "primaryIdentifier": [ + "/properties/FarmId", + "/properties/StorageProfileId" + ], + "properties": { + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "FileSystemLocations": { + "items": { + "$ref": "#/definitions/FileSystemLocation" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "OsFamily": { + "$ref": "#/definitions/StorageProfileOperatingSystemFamily" + }, + "StorageProfileId": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StorageProfileId" + ], + "required": [ + "DisplayName", + "FarmId", + "OsFamily" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::StorageProfile" +} diff --git a/schema/aws-detective-graph.json b/schema/aws-detective-graph.json index 2d2dadc..afbc92d 100644 --- a/schema/aws-detective-graph.json +++ b/schema/aws-detective-graph.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::Detective::Graph", - "handlers": { - "create": { - "permissions": [ - "detective:CreateGraph", - "detective:UpdateOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - }, - "delete": { - "permissions": [ - "detective:DeleteGraph" - ] - }, - "list": { - "permissions": [ - "detective:ListGraphs", - "detective:ListTagsForResource", - "detective:DescribeOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - }, - "read": { - "permissions": [ - "detective:ListGraphs", - "detective:ListTagsForResource", - "detective:DescribeOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - }, - "update": { - "permissions": [ - "detective:UntagResource", - "detective:TagResource", - "detective:ListTagsForResource", - "detective:UpdateOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Detective graph ARN", - "type": "string" - }, - "AutoEnableMembers": { - "default": false, - "description": "Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.", - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", - "typeName": "AWS::Detective::Graph" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::Detective::Graph", + "handlers": { + "create": { + "permissions": [ + "detective:CreateGraph", + "detective:UpdateOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + }, + "delete": { + "permissions": [ + "detective:DeleteGraph" + ] + }, + "list": { + "permissions": [ + "detective:ListGraphs", + "detective:ListTagsForResource", + "detective:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + }, + "read": { + "permissions": [ + "detective:ListGraphs", + "detective:ListTagsForResource", + "detective:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + }, + "update": { + "permissions": [ + "detective:UntagResource", + "detective:TagResource", + "detective:ListTagsForResource", + "detective:UpdateOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Detective graph ARN", + "type": "string" + }, + "AutoEnableMembers": { + "default": false, + "description": "Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.", + "type": "boolean" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", + "typeName": "AWS::Detective::Graph" +} diff --git a/schema/aws-detective-memberinvitation.json b/schema/aws-detective-memberinvitation.json index 48f4f1e..a19538e 100644 --- a/schema/aws-detective-memberinvitation.json +++ b/schema/aws-detective-memberinvitation.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GraphArn", - "/properties/MemberId" - ], - "description": "Resource schema for AWS::Detective::MemberInvitation", - "handlers": { - "create": { - "permissions": [ - "detective:CreateMembers", - "detective:GetMembers" - ] - }, - "delete": { - "permissions": [ - "detective:DeleteMembers" - ] - }, - "list": { - "permissions": [ - "detective:ListGraphs", - "detective:ListMembers" - ] - }, - "read": { - "permissions": [ - "detective:GetMembers" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/GraphArn", - "/properties/MemberId" - ], - "properties": { - "DisableEmailNotification": { - "default": false, - "description": "When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect.", - "type": "boolean" - }, - "GraphArn": { - "description": "The ARN of the graph to which the member account will be invited", - "pattern": "arn:aws(-[\\w]+)*:detective:(([a-z]+-)+[0-9]+):[0-9]{12}:graph:[0-9a-f]{32}", - "type": "string" - }, - "MemberEmailAddress": { - "description": "The root email address for the account to be invited, for validation. Updating this field has no effect.", - "pattern": ".*@.*", - "type": "string" - }, - "MemberId": { - "description": "The AWS account ID to be invited to join the graph as a member", - "pattern": "[0-9]{12}", - "type": "string" - }, - "Message": { - "description": "A message to be included in the email invitation sent to the invited account. Updating this field has no effect.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "GraphArn", - "MemberId", - "MemberEmailAddress" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", - "typeName": "AWS::Detective::MemberInvitation", - "writeOnlyProperties": [ - "/properties/Message", - "/properties/DisableEmailNotification" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GraphArn", + "/properties/MemberId" + ], + "description": "Resource schema for AWS::Detective::MemberInvitation", + "handlers": { + "create": { + "permissions": [ + "detective:CreateMembers", + "detective:GetMembers" + ] + }, + "delete": { + "permissions": [ + "detective:DeleteMembers" + ] + }, + "list": { + "permissions": [ + "detective:ListGraphs", + "detective:ListMembers" + ] + }, + "read": { + "permissions": [ + "detective:GetMembers" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/GraphArn", + "/properties/MemberId" + ], + "properties": { + "DisableEmailNotification": { + "default": false, + "description": "When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect.", + "type": "boolean" + }, + "GraphArn": { + "description": "The ARN of the graph to which the member account will be invited", + "pattern": "arn:aws(-[\\w]+)*:detective:(([a-z]+-)+[0-9]+):[0-9]{12}:graph:[0-9a-f]{32}", + "type": "string" + }, + "MemberEmailAddress": { + "description": "The root email address for the account to be invited, for validation. Updating this field has no effect.", + "pattern": ".*@.*", + "type": "string" + }, + "MemberId": { + "description": "The AWS account ID to be invited to join the graph as a member", + "pattern": "[0-9]{12}", + "type": "string" + }, + "Message": { + "description": "A message to be included in the email invitation sent to the invited account. Updating this field has no effect.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "GraphArn", + "MemberId", + "MemberEmailAddress" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", + "typeName": "AWS::Detective::MemberInvitation", + "writeOnlyProperties": [ + "/properties/Message", + "/properties/DisableEmailNotification" + ] +} diff --git a/schema/aws-detective-organizationadmin.json b/schema/aws-detective-organizationadmin.json index 4b7bc2a..add8c1d 100644 --- a/schema/aws-detective-organizationadmin.json +++ b/schema/aws-detective-organizationadmin.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AccountId" - ], - "description": "Resource schema for AWS::Detective::OrganizationAdmin", - "handlers": { - "create": { - "permissions": [ - "detective:EnableOrganizationAdminAccount", - "detective:ListOrganizationAdminAccount", - "iam:CreateServiceLinkedRole", - "organizations:RegisterDelegatedAdministrator", - "organizations:DescribeOrganization", - "organizations:EnableAWSServiceAccess", - "organizations:ListAccounts" - ] - }, - "delete": { - "permissions": [ - "detective:DisableOrganizationAdminAccount", - "detective:ListOrganizationAdminAccount", - "organizations:DescribeOrganization" - ] - }, - "list": { - "permissions": [ - "detective:ListOrganizationAdminAccount", - "organizations:DescribeOrganization" - ] - }, - "read": { - "permissions": [ - "detective:ListOrganizationAdminAccount", - "organizations:DescribeOrganization" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "description": "The account ID of the account that should be registered as your Organization's delegated administrator for Detective", - "pattern": "[0-9]{12}", - "type": "string" - }, - "GraphArn": { - "description": "The Detective graph ARN", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/GraphArn" - ], - "required": [ - "AccountId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Detective::OrganizationAdmin" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AccountId" + ], + "description": "Resource schema for AWS::Detective::OrganizationAdmin", + "handlers": { + "create": { + "permissions": [ + "detective:EnableOrganizationAdminAccount", + "detective:ListOrganizationAdminAccount", + "iam:CreateServiceLinkedRole", + "organizations:RegisterDelegatedAdministrator", + "organizations:DescribeOrganization", + "organizations:EnableAWSServiceAccess", + "organizations:ListAccounts" + ] + }, + "delete": { + "permissions": [ + "detective:DisableOrganizationAdminAccount", + "detective:ListOrganizationAdminAccount", + "organizations:DescribeOrganization" + ] + }, + "list": { + "permissions": [ + "detective:ListOrganizationAdminAccount", + "organizations:DescribeOrganization" + ] + }, + "read": { + "permissions": [ + "detective:ListOrganizationAdminAccount", + "organizations:DescribeOrganization" + ] + }, + "update": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "description": "The account ID of the account that should be registered as your Organization's delegated administrator for Detective", + "pattern": "[0-9]{12}", + "type": "string" + }, + "GraphArn": { + "description": "The Detective graph ARN", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/GraphArn" + ], + "required": [ + "AccountId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-detective.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Detective::OrganizationAdmin" +} diff --git a/schema/aws-devopsguru-loganomalydetectionintegration.json b/schema/aws-devopsguru-loganomalydetectionintegration.json index 6b19b74..b9b3797 100644 --- a/schema/aws-devopsguru-loganomalydetectionintegration.json +++ b/schema/aws-devopsguru-loganomalydetectionintegration.json @@ -1,62 +1,62 @@ -{ - "additionalProperties": false, - "definitions": { - "AccountId": { - "description": "User account id, used as the primary identifier for the resource", - "pattern": "^\\d{12}$", - "type": "string" - } - }, - "description": "This resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.", - "handlers": { - "create": { - "permissions": [ - "devops-guru:DescribeServiceIntegration", - "devops-guru:UpdateServiceIntegration", - "logs:TagLogGroup", - "logs:UntagLogGroup" - ] - }, - "delete": { - "permissions": [ - "devops-guru:DescribeServiceIntegration", - "devops-guru:UpdateServiceIntegration", - "logs:TagLogGroup", - "logs:UntagLogGroup" - ] - }, - "list": { - "permissions": [ - "devops-guru:DescribeServiceIntegration" - ] - }, - "read": { - "permissions": [ - "devops-guru:DescribeServiceIntegration" - ] - }, - "update": { - "permissions": [ - "devops-guru:UpdateServiceIntegration", - "logs:TagLogGroup", - "logs:UntagLogGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "$ref": "#/definitions/AccountId" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration" -} +{ + "additionalProperties": false, + "definitions": { + "AccountId": { + "description": "User account id, used as the primary identifier for the resource", + "pattern": "^\\d{12}$", + "type": "string" + } + }, + "description": "This resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.", + "handlers": { + "create": { + "permissions": [ + "devops-guru:DescribeServiceIntegration", + "devops-guru:UpdateServiceIntegration", + "logs:TagLogGroup", + "logs:UntagLogGroup" + ] + }, + "delete": { + "permissions": [ + "devops-guru:DescribeServiceIntegration", + "devops-guru:UpdateServiceIntegration", + "logs:TagLogGroup", + "logs:UntagLogGroup" + ] + }, + "list": { + "permissions": [ + "devops-guru:DescribeServiceIntegration" + ] + }, + "read": { + "permissions": [ + "devops-guru:DescribeServiceIntegration" + ] + }, + "update": { + "permissions": [ + "devops-guru:UpdateServiceIntegration", + "logs:TagLogGroup", + "logs:UntagLogGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "$ref": "#/definitions/AccountId" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration" +} diff --git a/schema/aws-devopsguru-notificationchannel.json b/schema/aws-devopsguru-notificationchannel.json index cc5af51..0b3440c 100644 --- a/schema/aws-devopsguru-notificationchannel.json +++ b/schema/aws-devopsguru-notificationchannel.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Config" - ], - "definitions": { - "InsightSeveritiesFilterList": { - "description": "DevOps Guru insight severities to filter for", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InsightSeverity" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - }, - "InsightSeverity": { - "description": "DevOps Guru Insight Severity Enum", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - }, - "NotificationChannelConfig": { - "additionalProperties": false, - "description": "Information about notification channels you have configured with DevOps Guru.", - "properties": { - "Filters": { - "$ref": "#/definitions/NotificationFilterConfig" - }, - "Sns": { - "$ref": "#/definitions/SnsChannelConfig" - } - }, - "type": "object" - }, - "NotificationFilterConfig": { - "additionalProperties": false, - "description": "Information about filters of a notification channel configured in DevOpsGuru to filter for insights.", - "properties": { - "MessageTypes": { - "$ref": "#/definitions/NotificationMessageTypesFilterList" - }, - "Severities": { - "$ref": "#/definitions/InsightSeveritiesFilterList" - } - }, - "type": "object" - }, - "NotificationMessageType": { - "description": "DevOps Guru NotificationMessageType Enum", - "enum": [ - "NEW_INSIGHT", - "CLOSED_INSIGHT", - "NEW_ASSOCIATION", - "SEVERITY_UPGRADED", - "NEW_RECOMMENDATION" - ], - "type": "string" - }, - "NotificationMessageTypesFilterList": { - "description": "DevOps Guru message types to filter for", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NotificationMessageType" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SnsChannelConfig": { - "additionalProperties": false, - "description": "Information about a notification channel configured in DevOps Guru to send notifications when insights are created.", - "properties": { - "TopicArn": { - "maxLength": 1024, - "minLength": 36, - "pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "This resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.", - "handlers": { - "create": { - "permissions": [ - "devops-guru:AddNotificationChannel", - "devops-guru:ListNotificationChannels", - "sns:Publish", - "sns:GetTopicAttributes", - "sns:SetTopicAttributes" - ] - }, - "delete": { - "permissions": [ - "devops-guru:RemoveNotificationChannel", - "devops-guru:ListNotificationChannels" - ] - }, - "list": { - "permissions": [ - "devops-guru:ListNotificationChannels" - ] - }, - "read": { - "permissions": [ - "devops-guru:ListNotificationChannels" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Config": { - "$ref": "#/definitions/NotificationChannelConfig" - }, - "Id": { - "description": "The ID of a notification channel.", - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Config" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-devops-guru", - "typeName": "AWS::DevOpsGuru::NotificationChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Config" + ], + "definitions": { + "InsightSeveritiesFilterList": { + "description": "DevOps Guru insight severities to filter for", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InsightSeverity" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + }, + "InsightSeverity": { + "description": "DevOps Guru Insight Severity Enum", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + }, + "NotificationChannelConfig": { + "additionalProperties": false, + "description": "Information about notification channels you have configured with DevOps Guru.", + "properties": { + "Filters": { + "$ref": "#/definitions/NotificationFilterConfig" + }, + "Sns": { + "$ref": "#/definitions/SnsChannelConfig" + } + }, + "type": "object" + }, + "NotificationFilterConfig": { + "additionalProperties": false, + "description": "Information about filters of a notification channel configured in DevOpsGuru to filter for insights.", + "properties": { + "MessageTypes": { + "$ref": "#/definitions/NotificationMessageTypesFilterList" + }, + "Severities": { + "$ref": "#/definitions/InsightSeveritiesFilterList" + } + }, + "type": "object" + }, + "NotificationMessageType": { + "description": "DevOps Guru NotificationMessageType Enum", + "enum": [ + "NEW_INSIGHT", + "CLOSED_INSIGHT", + "NEW_ASSOCIATION", + "SEVERITY_UPGRADED", + "NEW_RECOMMENDATION" + ], + "type": "string" + }, + "NotificationMessageTypesFilterList": { + "description": "DevOps Guru message types to filter for", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NotificationMessageType" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SnsChannelConfig": { + "additionalProperties": false, + "description": "Information about a notification channel configured in DevOps Guru to send notifications when insights are created.", + "properties": { + "TopicArn": { + "maxLength": 1024, + "minLength": 36, + "pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "This resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.", + "handlers": { + "create": { + "permissions": [ + "devops-guru:AddNotificationChannel", + "devops-guru:ListNotificationChannels", + "sns:Publish", + "sns:GetTopicAttributes", + "sns:SetTopicAttributes" + ] + }, + "delete": { + "permissions": [ + "devops-guru:RemoveNotificationChannel", + "devops-guru:ListNotificationChannels" + ] + }, + "list": { + "permissions": [ + "devops-guru:ListNotificationChannels" + ] + }, + "read": { + "permissions": [ + "devops-guru:ListNotificationChannels" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Config": { + "$ref": "#/definitions/NotificationChannelConfig" + }, + "Id": { + "description": "The ID of a notification channel.", + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Config" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-devops-guru", + "typeName": "AWS::DevOpsGuru::NotificationChannel" +} diff --git a/schema/aws-devopsguru-resourcecollection.json b/schema/aws-devopsguru-resourcecollection.json index 87b8d9a..ea83d1a 100644 --- a/schema/aws-devopsguru-resourcecollection.json +++ b/schema/aws-devopsguru-resourcecollection.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "definitions": { - "CloudFormationCollectionFilter": { - "additionalProperties": false, - "description": "CloudFormation resource for DevOps Guru to monitor", - "properties": { - "StackNames": { - "description": "An array of CloudFormation stack names.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z*]+[a-zA-Z0-9-]*$", - "type": "string" - }, - "maxItems": 1000, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "ResourceCollectionFilter": { - "additionalProperties": false, - "description": "Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.", - "properties": { - "CloudFormation": { - "$ref": "#/definitions/CloudFormationCollectionFilter" - }, - "Tags": { - "$ref": "#/definitions/TagCollections" - } - }, - "type": "object" - }, - "TagCollection": { - "additionalProperties": false, - "description": "Tagged resource for DevOps Guru to monitor", - "properties": { - "AppBoundaryKey": { - "description": "A Tag key for DevOps Guru app boundary.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "TagValues": { - "description": "Tag values of DevOps Guru app boundary.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 1000, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "TagCollections": { - "description": "Tagged resources for DevOps Guru to monitor", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagCollection" - }, - "type": "array" - } - }, - "description": "This resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.", - "handlers": { - "create": { - "permissions": [ - "devops-guru:UpdateResourceCollection", - "devops-guru:GetResourceCollection" - ] - }, - "delete": { - "permissions": [ - "devops-guru:UpdateResourceCollection", - "devops-guru:GetResourceCollection" - ] - }, - "list": { - "permissions": [ - "devops-guru:GetResourceCollection" - ] - }, - "read": { - "permissions": [ - "devops-guru:GetResourceCollection" - ] - }, - "update": { - "permissions": [ - "devops-guru:UpdateResourceCollection", - "devops-guru:GetResourceCollection" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceCollectionType" - ], - "properties": { - "ResourceCollectionFilter": { - "$ref": "#/definitions/ResourceCollectionFilter" - }, - "ResourceCollectionType": { - "description": "The type of ResourceCollection", - "enum": [ - "AWS_CLOUD_FORMATION", - "AWS_TAGS" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceCollectionType" - ], - "required": [ - "ResourceCollectionFilter" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-devops-guru", - "tagging": { - "taggable": false - }, - "typeName": "AWS::DevOpsGuru::ResourceCollection" -} +{ + "additionalProperties": false, + "definitions": { + "CloudFormationCollectionFilter": { + "additionalProperties": false, + "description": "CloudFormation resource for DevOps Guru to monitor", + "properties": { + "StackNames": { + "description": "An array of CloudFormation stack names.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z*]+[a-zA-Z0-9-]*$", + "type": "string" + }, + "maxItems": 1000, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ResourceCollectionFilter": { + "additionalProperties": false, + "description": "Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.", + "properties": { + "CloudFormation": { + "$ref": "#/definitions/CloudFormationCollectionFilter" + }, + "Tags": { + "$ref": "#/definitions/TagCollections" + } + }, + "type": "object" + }, + "TagCollection": { + "additionalProperties": false, + "description": "Tagged resource for DevOps Guru to monitor", + "properties": { + "AppBoundaryKey": { + "description": "A Tag key for DevOps Guru app boundary.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "TagValues": { + "description": "Tag values of DevOps Guru app boundary.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 1000, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "TagCollections": { + "description": "Tagged resources for DevOps Guru to monitor", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagCollection" + }, + "type": "array" + } + }, + "description": "This resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.", + "handlers": { + "create": { + "permissions": [ + "devops-guru:UpdateResourceCollection", + "devops-guru:GetResourceCollection" + ] + }, + "delete": { + "permissions": [ + "devops-guru:UpdateResourceCollection", + "devops-guru:GetResourceCollection" + ] + }, + "list": { + "permissions": [ + "devops-guru:GetResourceCollection" + ] + }, + "read": { + "permissions": [ + "devops-guru:GetResourceCollection" + ] + }, + "update": { + "permissions": [ + "devops-guru:UpdateResourceCollection", + "devops-guru:GetResourceCollection" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceCollectionType" + ], + "properties": { + "ResourceCollectionFilter": { + "$ref": "#/definitions/ResourceCollectionFilter" + }, + "ResourceCollectionType": { + "description": "The type of ResourceCollection", + "enum": [ + "AWS_CLOUD_FORMATION", + "AWS_TAGS" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceCollectionType" + ], + "required": [ + "ResourceCollectionFilter" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-devops-guru", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DevOpsGuru::ResourceCollection" +} diff --git a/schema/aws-directoryservice-microsoftad.json b/schema/aws-directoryservice-microsoftad.json index 5c68a0d..33ddb56 100644 --- a/schema/aws-directoryservice-microsoftad.json +++ b/schema/aws-directoryservice-microsoftad.json @@ -1,84 +1,84 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcSettings", - "/properties/Edition", - "/properties/Name", - "/properties/Password", - "/properties/ShortName", - "/properties/CreateAlias" - ], - "definitions": { - "VpcSettings": { - "additionalProperties": false, - "properties": { - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId", - "SubnetIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DirectoryService::MicrosoftAD", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Alias": { - "type": "string" - }, - "CreateAlias": { - "type": "boolean" - }, - "DnsIpAddresses": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Edition": { - "type": "string" - }, - "EnableSso": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "ShortName": { - "type": "string" - }, - "VpcSettings": { - "$ref": "#/definitions/VpcSettings" - } - }, - "readOnlyProperties": [ - "/properties/Alias", - "/properties/DnsIpAddresses", - "/properties/Id" - ], - "required": [ - "VpcSettings", - "Name", - "Password" - ], - "typeName": "AWS::DirectoryService::MicrosoftAD" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcSettings", + "/properties/Edition", + "/properties/Name", + "/properties/Password", + "/properties/ShortName", + "/properties/CreateAlias" + ], + "definitions": { + "VpcSettings": { + "additionalProperties": false, + "properties": { + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "type": "string" + } + }, + "required": [ + "VpcId", + "SubnetIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DirectoryService::MicrosoftAD", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Alias": { + "type": "string" + }, + "CreateAlias": { + "type": "boolean" + }, + "DnsIpAddresses": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Edition": { + "type": "string" + }, + "EnableSso": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Password": { + "type": "string" + }, + "ShortName": { + "type": "string" + }, + "VpcSettings": { + "$ref": "#/definitions/VpcSettings" + } + }, + "readOnlyProperties": [ + "/properties/Alias", + "/properties/DnsIpAddresses", + "/properties/Id" + ], + "required": [ + "VpcSettings", + "Name", + "Password" + ], + "typeName": "AWS::DirectoryService::MicrosoftAD" +} diff --git a/schema/aws-directoryservice-simplead.json b/schema/aws-directoryservice-simplead.json index 90eab75..2e2a083 100644 --- a/schema/aws-directoryservice-simplead.json +++ b/schema/aws-directoryservice-simplead.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Size", - "/properties/VpcSettings", - "/properties/Name", - "/properties/Password", - "/properties/ShortName", - "/properties/Description", - "/properties/CreateAlias" - ], - "definitions": { - "VpcSettings": { - "$comment": "Contains VPC information", - "additionalProperties": false, - "properties": { - "SubnetIds": { - "description": "The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "description": "The identifier of the VPC in which to create the directory.", - "type": "string" - } - }, - "required": [ - "VpcId", - "SubnetIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DirectoryService::SimpleAD", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html", - "handlers": { - "create": { - "permissions": [ - "ds:CreateDirectory", - "ds:CreateAlias", - "ds:EnableSso", - "ds:DescribeDirectories", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:CreateSecurityGroup", - "ec2:CreateNetworkInterface", - "ec2:DescribeNetworkInterfaces", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:AuthorizeSecurityGroupEgress", - "ec2:CreateTags", - "ec2:RevokeSecurityGroupIngress", - "ec2:RevokeSecurityGroupEgress" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "ds:DeleteDirectory", - "ds:DescribeDirectories", - "ec2:DescribeNetworkInterfaces", - "ec2:DeleteSecurityGroup", - "ec2:DeleteNetworkInterface", - "ec2:RevokeSecurityGroupIngress", - "ec2:RevokeSecurityGroupEgress", - "ec2:DeleteTags" - ], - "timeoutInMinutes": 100 - }, - "list": { - "permissions": [ - "ds:DescribeDirectories" - ] - }, - "read": { - "permissions": [ - "ds:DescribeDirectories" - ] - }, - "update": { - "permissions": [ - "ds:EnableSso", - "ds:DisableSso", - "ds:DescribeDirectories" - ] - } - }, - "primaryIdentifier": [ - "/properties/DirectoryId" - ], - "properties": { - "Alias": { - "description": "The alias for a directory.", - "type": "string" - }, - "CreateAlias": { - "description": "The name of the configuration set.", - "type": "boolean" - }, - "Description": { - "description": "Description for the directory.", - "type": "string" - }, - "DirectoryId": { - "description": "The unique identifier for a directory.", - "type": "string" - }, - "DnsIpAddresses": { - "description": "The IP addresses of the DNS servers for the directory, such as [ \"172.31.3.154\", \"172.31.63.203\" ].", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "EnableSso": { - "description": "Whether to enable single sign-on for a Simple Active Directory in AWS.", - "type": "boolean" - }, - "Name": { - "description": "The fully qualified domain name for the AWS Managed Simple AD directory.", - "type": "string" - }, - "Password": { - "description": "The password for the default administrative user named Admin.", - "type": "string" - }, - "ShortName": { - "description": "The NetBIOS name for your domain.", - "type": "string" - }, - "Size": { - "description": "The size of the directory.", - "type": "string" - }, - "VpcSettings": { - "$ref": "#/definitions/VpcSettings", - "description": "VPC settings of the Simple AD directory server in AWS." - } - }, - "readOnlyProperties": [ - "/properties/Alias", - "/properties/DnsIpAddresses", - "/properties/DirectoryId" - ], - "required": [ - "VpcSettings", - "Size", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::DirectoryService::SimpleAD", - "writeOnlyProperties": [ - "/properties/Password" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Size", + "/properties/VpcSettings", + "/properties/Name", + "/properties/Password", + "/properties/ShortName", + "/properties/Description", + "/properties/CreateAlias" + ], + "definitions": { + "VpcSettings": { + "$comment": "Contains VPC information", + "additionalProperties": false, + "properties": { + "SubnetIds": { + "description": "The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "description": "The identifier of the VPC in which to create the directory.", + "type": "string" + } + }, + "required": [ + "VpcId", + "SubnetIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DirectoryService::SimpleAD", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html", + "handlers": { + "create": { + "permissions": [ + "ds:CreateDirectory", + "ds:CreateAlias", + "ds:EnableSso", + "ds:DescribeDirectories", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:CreateSecurityGroup", + "ec2:CreateNetworkInterface", + "ec2:DescribeNetworkInterfaces", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:CreateTags", + "ec2:RevokeSecurityGroupIngress", + "ec2:RevokeSecurityGroupEgress" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "ds:DeleteDirectory", + "ds:DescribeDirectories", + "ec2:DescribeNetworkInterfaces", + "ec2:DeleteSecurityGroup", + "ec2:DeleteNetworkInterface", + "ec2:RevokeSecurityGroupIngress", + "ec2:RevokeSecurityGroupEgress", + "ec2:DeleteTags" + ], + "timeoutInMinutes": 100 + }, + "list": { + "permissions": [ + "ds:DescribeDirectories" + ] + }, + "read": { + "permissions": [ + "ds:DescribeDirectories" + ] + }, + "update": { + "permissions": [ + "ds:EnableSso", + "ds:DisableSso", + "ds:DescribeDirectories" + ] + } + }, + "primaryIdentifier": [ + "/properties/DirectoryId" + ], + "properties": { + "Alias": { + "description": "The alias for a directory.", + "type": "string" + }, + "CreateAlias": { + "description": "The name of the configuration set.", + "type": "boolean" + }, + "Description": { + "description": "Description for the directory.", + "type": "string" + }, + "DirectoryId": { + "description": "The unique identifier for a directory.", + "type": "string" + }, + "DnsIpAddresses": { + "description": "The IP addresses of the DNS servers for the directory, such as [ \"172.31.3.154\", \"172.31.63.203\" ].", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "EnableSso": { + "description": "Whether to enable single sign-on for a Simple Active Directory in AWS.", + "type": "boolean" + }, + "Name": { + "description": "The fully qualified domain name for the AWS Managed Simple AD directory.", + "type": "string" + }, + "Password": { + "description": "The password for the default administrative user named Admin.", + "type": "string" + }, + "ShortName": { + "description": "The NetBIOS name for your domain.", + "type": "string" + }, + "Size": { + "description": "The size of the directory.", + "type": "string" + }, + "VpcSettings": { + "$ref": "#/definitions/VpcSettings", + "description": "VPC settings of the Simple AD directory server in AWS." + } + }, + "readOnlyProperties": [ + "/properties/Alias", + "/properties/DnsIpAddresses", + "/properties/DirectoryId" + ], + "required": [ + "VpcSettings", + "Size", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DirectoryService::SimpleAD", + "writeOnlyProperties": [ + "/properties/Password" + ] +} diff --git a/schema/aws-dlm-lifecyclepolicy.json b/schema/aws-dlm-lifecyclepolicy.json index aa31b63..7e643c0 100644 --- a/schema/aws-dlm-lifecyclepolicy.json +++ b/schema/aws-dlm-lifecyclepolicy.json @@ -1,577 +1,577 @@ -{ - "additionalProperties": false, - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "CrossRegionCopy": { - "items": { - "$ref": "#/definitions/CrossRegionCopyAction" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - } - }, - "required": [ - "CrossRegionCopy", - "Name" - ], - "type": "object" - }, - "ArchiveRetainRule": { - "additionalProperties": false, - "properties": { - "RetentionArchiveTier": { - "$ref": "#/definitions/RetentionArchiveTier" - } - }, - "required": [ - "RetentionArchiveTier" - ], - "type": "object" - }, - "ArchiveRule": { - "additionalProperties": false, - "properties": { - "RetainRule": { - "$ref": "#/definitions/ArchiveRetainRule" - } - }, - "required": [ - "RetainRule" - ], - "type": "object" - }, - "CreateRule": { - "additionalProperties": false, - "properties": { - "CronExpression": { - "type": "string" - }, - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "Scripts": { - "items": { - "$ref": "#/definitions/Script" - }, - "type": "array", - "uniqueItems": false - }, - "Times": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "CrossRegionCopyAction": { - "additionalProperties": false, - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "RetainRule": { - "$ref": "#/definitions/CrossRegionCopyRetainRule" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Target", - "EncryptionConfiguration" - ], - "type": "object" - }, - "CrossRegionCopyDeprecateRule": { - "additionalProperties": false, - "properties": { - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "required": [ - "IntervalUnit", - "Interval" - ], - "type": "object" - }, - "CrossRegionCopyRetainRule": { - "additionalProperties": false, - "properties": { - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "required": [ - "IntervalUnit", - "Interval" - ], - "type": "object" - }, - "CrossRegionCopyRule": { - "additionalProperties": false, - "properties": { - "CmkArn": { - "type": "string" - }, - "CopyTags": { - "type": "boolean" - }, - "DeprecateRule": { - "$ref": "#/definitions/CrossRegionCopyDeprecateRule" - }, - "Encrypted": { - "type": "boolean" - }, - "RetainRule": { - "$ref": "#/definitions/CrossRegionCopyRetainRule" - }, - "Target": { - "type": "string" - }, - "TargetRegion": { - "type": "string" - } - }, - "required": [ - "Encrypted" - ], - "type": "object" - }, - "CrossRegionCopyTargets": { - "additionalProperties": false, - "type": "object" - }, - "DeprecateRule": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "integer" - }, - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "CmkArn": { - "type": "string" - }, - "Encrypted": { - "type": "boolean" - } - }, - "required": [ - "Encrypted" - ], - "type": "object" - }, - "EventParameters": { - "additionalProperties": false, - "properties": { - "DescriptionRegex": { - "type": "string" - }, - "EventType": { - "type": "string" - }, - "SnapshotOwner": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "EventType", - "SnapshotOwner" - ], - "type": "object" - }, - "EventSource": { - "additionalProperties": false, - "properties": { - "Parameters": { - "$ref": "#/definitions/EventParameters" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ExcludeTags": { - "additionalProperties": false, - "type": "object" - }, - "ExcludeVolumeTypesList": { - "additionalProperties": false, - "type": "object" - }, - "Exclusions": { - "additionalProperties": false, - "properties": { - "ExcludeBootVolumes": { - "type": "boolean" - }, - "ExcludeTags": { - "$ref": "#/definitions/ExcludeTags" - }, - "ExcludeVolumeTypes": { - "$ref": "#/definitions/ExcludeVolumeTypesList" - } - }, - "type": "object" - }, - "FastRestoreRule": { - "additionalProperties": false, - "properties": { - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Count": { - "type": "integer" - }, - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "Parameters": { - "additionalProperties": false, - "properties": { - "ExcludeBootVolume": { - "type": "boolean" - }, - "ExcludeDataVolumeTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "NoReboot": { - "type": "boolean" - } - }, - "type": "object" - }, - "PolicyDetails": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": false - }, - "CopyTags": { - "type": "boolean" - }, - "CreateInterval": { - "type": "integer" - }, - "CrossRegionCopyTargets": { - "$ref": "#/definitions/CrossRegionCopyTargets" - }, - "EventSource": { - "$ref": "#/definitions/EventSource" - }, - "Exclusions": { - "$ref": "#/definitions/Exclusions" - }, - "ExtendDeletion": { - "type": "boolean" - }, - "Parameters": { - "$ref": "#/definitions/Parameters" - }, - "PolicyLanguage": { - "type": "string" - }, - "PolicyType": { - "type": "string" - }, - "ResourceLocations": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ResourceType": { - "type": "string" - }, - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RetainInterval": { - "type": "integer" - }, - "Schedules": { - "items": { - "$ref": "#/definitions/Schedule" - }, - "type": "array", - "uniqueItems": false - }, - "TargetTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "RetainRule": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "integer" - }, - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "RetentionArchiveTier": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "integer" - }, - "Interval": { - "type": "integer" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "properties": { - "ArchiveRule": { - "$ref": "#/definitions/ArchiveRule" - }, - "CopyTags": { - "type": "boolean" - }, - "CreateRule": { - "$ref": "#/definitions/CreateRule" - }, - "CrossRegionCopyRules": { - "items": { - "$ref": "#/definitions/CrossRegionCopyRule" - }, - "type": "array", - "uniqueItems": false - }, - "DeprecateRule": { - "$ref": "#/definitions/DeprecateRule" - }, - "FastRestoreRule": { - "$ref": "#/definitions/FastRestoreRule" - }, - "Name": { - "type": "string" - }, - "RetainRule": { - "$ref": "#/definitions/RetainRule" - }, - "ShareRules": { - "items": { - "$ref": "#/definitions/ShareRule" - }, - "type": "array", - "uniqueItems": false - }, - "TagsToAdd": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VariableTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Script": { - "additionalProperties": false, - "properties": { - "ExecuteOperationOnScriptFailure": { - "type": "boolean" - }, - "ExecutionHandler": { - "type": "string" - }, - "ExecutionHandlerService": { - "type": "string" - }, - "ExecutionTimeout": { - "type": "integer" - }, - "MaximumRetryCount": { - "type": "integer" - }, - "Stages": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "ShareRule": { - "additionalProperties": false, - "properties": { - "TargetAccounts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "UnshareInterval": { - "type": "integer" - }, - "UnshareIntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DLM::LifecyclePolicy", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CopyTags": { - "type": "boolean" - }, - "CreateInterval": { - "type": "integer" - }, - "CrossRegionCopyTargets": { - "$ref": "#/definitions/CrossRegionCopyTargets" - }, - "DefaultPolicy": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Exclusions": { - "$ref": "#/definitions/Exclusions" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "ExtendDeletion": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "PolicyDetails": { - "$ref": "#/definitions/PolicyDetails" - }, - "RetainInterval": { - "type": "integer" - }, - "State": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "typeName": "AWS::DLM::LifecyclePolicy" -} +{ + "additionalProperties": false, + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "CrossRegionCopy": { + "items": { + "$ref": "#/definitions/CrossRegionCopyAction" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + } + }, + "required": [ + "CrossRegionCopy", + "Name" + ], + "type": "object" + }, + "ArchiveRetainRule": { + "additionalProperties": false, + "properties": { + "RetentionArchiveTier": { + "$ref": "#/definitions/RetentionArchiveTier" + } + }, + "required": [ + "RetentionArchiveTier" + ], + "type": "object" + }, + "ArchiveRule": { + "additionalProperties": false, + "properties": { + "RetainRule": { + "$ref": "#/definitions/ArchiveRetainRule" + } + }, + "required": [ + "RetainRule" + ], + "type": "object" + }, + "CreateRule": { + "additionalProperties": false, + "properties": { + "CronExpression": { + "type": "string" + }, + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "Scripts": { + "items": { + "$ref": "#/definitions/Script" + }, + "type": "array", + "uniqueItems": false + }, + "Times": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CrossRegionCopyAction": { + "additionalProperties": false, + "properties": { + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "RetainRule": { + "$ref": "#/definitions/CrossRegionCopyRetainRule" + }, + "Target": { + "type": "string" + } + }, + "required": [ + "Target", + "EncryptionConfiguration" + ], + "type": "object" + }, + "CrossRegionCopyDeprecateRule": { + "additionalProperties": false, + "properties": { + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "required": [ + "IntervalUnit", + "Interval" + ], + "type": "object" + }, + "CrossRegionCopyRetainRule": { + "additionalProperties": false, + "properties": { + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "required": [ + "IntervalUnit", + "Interval" + ], + "type": "object" + }, + "CrossRegionCopyRule": { + "additionalProperties": false, + "properties": { + "CmkArn": { + "type": "string" + }, + "CopyTags": { + "type": "boolean" + }, + "DeprecateRule": { + "$ref": "#/definitions/CrossRegionCopyDeprecateRule" + }, + "Encrypted": { + "type": "boolean" + }, + "RetainRule": { + "$ref": "#/definitions/CrossRegionCopyRetainRule" + }, + "Target": { + "type": "string" + }, + "TargetRegion": { + "type": "string" + } + }, + "required": [ + "Encrypted" + ], + "type": "object" + }, + "CrossRegionCopyTargets": { + "additionalProperties": false, + "type": "object" + }, + "DeprecateRule": { + "additionalProperties": false, + "properties": { + "Count": { + "type": "integer" + }, + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "CmkArn": { + "type": "string" + }, + "Encrypted": { + "type": "boolean" + } + }, + "required": [ + "Encrypted" + ], + "type": "object" + }, + "EventParameters": { + "additionalProperties": false, + "properties": { + "DescriptionRegex": { + "type": "string" + }, + "EventType": { + "type": "string" + }, + "SnapshotOwner": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "EventType", + "SnapshotOwner" + ], + "type": "object" + }, + "EventSource": { + "additionalProperties": false, + "properties": { + "Parameters": { + "$ref": "#/definitions/EventParameters" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ExcludeTags": { + "additionalProperties": false, + "type": "object" + }, + "ExcludeVolumeTypesList": { + "additionalProperties": false, + "type": "object" + }, + "Exclusions": { + "additionalProperties": false, + "properties": { + "ExcludeBootVolumes": { + "type": "boolean" + }, + "ExcludeTags": { + "$ref": "#/definitions/ExcludeTags" + }, + "ExcludeVolumeTypes": { + "$ref": "#/definitions/ExcludeVolumeTypesList" + } + }, + "type": "object" + }, + "FastRestoreRule": { + "additionalProperties": false, + "properties": { + "AvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Count": { + "type": "integer" + }, + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "type": "object" + }, + "Parameters": { + "additionalProperties": false, + "properties": { + "ExcludeBootVolume": { + "type": "boolean" + }, + "ExcludeDataVolumeTags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "NoReboot": { + "type": "boolean" + } + }, + "type": "object" + }, + "PolicyDetails": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": false + }, + "CopyTags": { + "type": "boolean" + }, + "CreateInterval": { + "type": "integer" + }, + "CrossRegionCopyTargets": { + "$ref": "#/definitions/CrossRegionCopyTargets" + }, + "EventSource": { + "$ref": "#/definitions/EventSource" + }, + "Exclusions": { + "$ref": "#/definitions/Exclusions" + }, + "ExtendDeletion": { + "type": "boolean" + }, + "Parameters": { + "$ref": "#/definitions/Parameters" + }, + "PolicyLanguage": { + "type": "string" + }, + "PolicyType": { + "type": "string" + }, + "ResourceLocations": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ResourceType": { + "type": "string" + }, + "ResourceTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RetainInterval": { + "type": "integer" + }, + "Schedules": { + "items": { + "$ref": "#/definitions/Schedule" + }, + "type": "array", + "uniqueItems": false + }, + "TargetTags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "RetainRule": { + "additionalProperties": false, + "properties": { + "Count": { + "type": "integer" + }, + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "type": "object" + }, + "RetentionArchiveTier": { + "additionalProperties": false, + "properties": { + "Count": { + "type": "integer" + }, + "Interval": { + "type": "integer" + }, + "IntervalUnit": { + "type": "string" + } + }, + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "properties": { + "ArchiveRule": { + "$ref": "#/definitions/ArchiveRule" + }, + "CopyTags": { + "type": "boolean" + }, + "CreateRule": { + "$ref": "#/definitions/CreateRule" + }, + "CrossRegionCopyRules": { + "items": { + "$ref": "#/definitions/CrossRegionCopyRule" + }, + "type": "array", + "uniqueItems": false + }, + "DeprecateRule": { + "$ref": "#/definitions/DeprecateRule" + }, + "FastRestoreRule": { + "$ref": "#/definitions/FastRestoreRule" + }, + "Name": { + "type": "string" + }, + "RetainRule": { + "$ref": "#/definitions/RetainRule" + }, + "ShareRules": { + "items": { + "$ref": "#/definitions/ShareRule" + }, + "type": "array", + "uniqueItems": false + }, + "TagsToAdd": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VariableTags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Script": { + "additionalProperties": false, + "properties": { + "ExecuteOperationOnScriptFailure": { + "type": "boolean" + }, + "ExecutionHandler": { + "type": "string" + }, + "ExecutionHandlerService": { + "type": "string" + }, + "ExecutionTimeout": { + "type": "integer" + }, + "MaximumRetryCount": { + "type": "integer" + }, + "Stages": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "ShareRule": { + "additionalProperties": false, + "properties": { + "TargetAccounts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "UnshareInterval": { + "type": "integer" + }, + "UnshareIntervalUnit": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DLM::LifecyclePolicy", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CopyTags": { + "type": "boolean" + }, + "CreateInterval": { + "type": "integer" + }, + "CrossRegionCopyTargets": { + "$ref": "#/definitions/CrossRegionCopyTargets" + }, + "DefaultPolicy": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Exclusions": { + "$ref": "#/definitions/Exclusions" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "ExtendDeletion": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "PolicyDetails": { + "$ref": "#/definitions/PolicyDetails" + }, + "RetainInterval": { + "type": "integer" + }, + "State": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "typeName": "AWS::DLM::LifecyclePolicy" +} diff --git a/schema/aws-dms-certificate.json b/schema/aws-dms-certificate.json index 5da120f..ab90b16 100644 --- a/schema/aws-dms-certificate.json +++ b/schema/aws-dms-certificate.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateIdentifier", - "/properties/CertificatePem", - "/properties/CertificateWallet" - ], - "description": "Resource Type definition for AWS::DMS::Certificate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CertificateIdentifier": { - "type": "string" - }, - "CertificatePem": { - "type": "string" - }, - "CertificateWallet": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::DMS::Certificate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateIdentifier", + "/properties/CertificatePem", + "/properties/CertificateWallet" + ], + "description": "Resource Type definition for AWS::DMS::Certificate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CertificateIdentifier": { + "type": "string" + }, + "CertificatePem": { + "type": "string" + }, + "CertificateWallet": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::DMS::Certificate" +} diff --git a/schema/aws-dms-dataprovider.json b/schema/aws-dms-dataprovider.json index 1d9028f..d8a3d64 100644 --- a/schema/aws-dms-dataprovider.json +++ b/schema/aws-dms-dataprovider.json @@ -1,315 +1,321 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DataProviderName" - ] - ], - "additionalProperties": false, - "definitions": { - "DmsSslModeValue": { - "enum": [ - "none", - "require", - "verify-ca", - "verify-full" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DMS::DataProvider", - "handlers": { - "create": { - "permissions": [ - "dms:CreateDataProvider", - "dms:ListDataProviders", - "dms:DescribeDataProviders", - "dms:AddTagsToResource", - "dms:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "dms:DeleteDataProvider" - ] - }, - "list": { - "permissions": [ - "dms:ListDataProviders", - "dms:DescribeDataProviders", - "dms:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "dms:ListDataProviders", - "dms:DescribeDataProviders", - "dms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "dms:UpdateDataProvider", - "dms:ModifyDataProvider", - "dms:AddTagsToResource", - "dms:RemoveTagsToResource", - "dms:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DataProviderArn" - ], - "properties": { - "DataProviderArn": { - "description": "The data provider ARN.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DataProviderCreationTime": { - "description": "The data provider creation time.", - "maxLength": 40, - "minLength": 1, - "type": "string" - }, - "DataProviderIdentifier": { - "description": "The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DataProviderName": { - "description": "The property describes a name to identify the data provider.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The optional description of the data provider.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Engine": { - "description": "The property describes a data engine for the data provider.", - "enum": [ - "postgres", - "mysql", - "oracle", - "sqlserver", - "aurora", - "aurora_postgresql" - ], - "type": "string" - }, - "ExactSettings": { - "default": false, - "description": "The property describes the exact settings which can be modified", - "type": "boolean" - }, - "Settings": { - "additionalProperties": false, - "anyOf": [ - { - "required": [ - "PostgreSqlSettings" - ] - }, - { - "required": [ - "MySqlSettings" - ] - }, - { - "required": [ - "OracleSettings" - ] - }, - { - "required": [ - "MicrosoftSqlServerSettings" - ] - } - ], - "description": "The property identifies the exact type of settings for the data provider.", - "properties": { - "MicrosoftSqlServerSettings": { - "additionalProperties": false, - "description": "MicrosoftSqlServerSettings property identifier.", - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, - "required": [ - "ServerName", - "Port", - "SslMode", - "DatabaseName" - ], - "type": "object" - }, - "MySqlSettings": { - "additionalProperties": false, - "description": "MySqlSettings property identifier.", - "properties": { - "CertificateArn": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, - "required": [ - "ServerName", - "Port", - "SslMode" - ], - "type": "object" - }, - "OracleSettings": { - "additionalProperties": false, - "description": "OracleSettings property identifier.", - "properties": { - "AsmServer": { - "type": "string" - }, - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "SecretsManagerOracleAsmAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmSecretId": { - "type": "string" - }, - "SecretsManagerSecurityDbEncryptionAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecurityDbEncryptionSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, - "required": [ - "ServerName", - "Port", - "SslMode", - "DatabaseName" - ], - "type": "object" - }, - "PostgreSqlSettings": { - "additionalProperties": false, - "description": "PostgreSqlSettings property identifier.", - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, - "required": [ - "ServerName", - "Port", - "SslMode", - "DatabaseName" - ], - "type": "object" - } - }, - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/DataProviderArn", - "/properties/DataProviderCreationTime" - ], - "required": [ - "Engine" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-dms.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::DMS::DataProvider", - "writeOnlyProperties": [ - "/properties/DataProviderIdentifier", - "/properties/ExactSettings" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/DataProviderName" + ] + ], + "additionalProperties": false, + "definitions": { + "DmsSslModeValue": { + "enum": [ + "none", + "require", + "verify-ca", + "verify-full" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DMS::DataProvider", + "handlers": { + "create": { + "permissions": [ + "dms:CreateDataProvider", + "dms:ListDataProviders", + "dms:DescribeDataProviders", + "dms:AddTagsToResource", + "dms:ListTagsForResource", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "dms:DeleteDataProvider" + ] + }, + "list": { + "permissions": [ + "dms:ListDataProviders", + "dms:DescribeDataProviders", + "dms:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "dms:ListDataProviders", + "dms:DescribeDataProviders", + "dms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "dms:UpdateDataProvider", + "dms:ModifyDataProvider", + "dms:AddTagsToResource", + "dms:RemoveTagsToResource", + "dms:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DataProviderArn" + ], + "properties": { + "DataProviderArn": { + "description": "The data provider ARN.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DataProviderCreationTime": { + "description": "The data provider creation time.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "DataProviderIdentifier": { + "description": "The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DataProviderName": { + "description": "The property describes a name to identify the data provider.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The optional description of the data provider.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Engine": { + "description": "The property describes a data engine for the data provider.", + "enum": [ + "postgres", + "mysql", + "oracle", + "sqlserver", + "aurora", + "aurora_postgresql" + ], + "type": "string" + }, + "ExactSettings": { + "default": false, + "description": "The property describes the exact settings which can be modified", + "type": "boolean" + }, + "Settings": { + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "PostgreSqlSettings" + ] + }, + { + "required": [ + "MySqlSettings" + ] + }, + { + "required": [ + "OracleSettings" + ] + }, + { + "required": [ + "MicrosoftSqlServerSettings" + ] + } + ], + "description": "The property identifies the exact type of settings for the data provider.", + "properties": { + "MicrosoftSqlServerSettings": { + "additionalProperties": false, + "description": "MicrosoftSqlServerSettings property identifier.", + "properties": { + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", + "type": "object" + } + }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], + "type": "object" + }, + "MySqlSettings": { + "additionalProperties": false, + "description": "MySqlSettings property identifier.", + "properties": { + "CertificateArn": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", + "type": "object" + } + }, + "required": [ + "ServerName", + "Port", + "SslMode" + ], + "type": "object" + }, + "OracleSettings": { + "additionalProperties": false, + "description": "OracleSettings property identifier.", + "properties": { + "AsmServer": { + "type": "string" + }, + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "SecretsManagerOracleAsmAccessRoleArn": { + "type": "string" + }, + "SecretsManagerOracleAsmSecretId": { + "type": "string" + }, + "SecretsManagerSecurityDbEncryptionAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecurityDbEncryptionSecretId": { + "type": "string" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", + "type": "object" + } + }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], + "type": "object" + }, + "PostgreSqlSettings": { + "additionalProperties": false, + "description": "PostgreSqlSettings property identifier.", + "properties": { + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", + "type": "object" + } + }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], + "type": "object" + } + }, + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/DataProviderArn", + "/properties/DataProviderCreationTime" + ], + "required": [ + "Engine" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-dms.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DMS::DataProvider", + "writeOnlyProperties": [ + "/properties/DataProviderIdentifier", + "/properties/ExactSettings" + ] +} diff --git a/schema/aws-dms-endpoint.json b/schema/aws-dms-endpoint.json index d60744a..c0fd634 100644 --- a/schema/aws-dms-endpoint.json +++ b/schema/aws-dms-endpoint.json @@ -1,948 +1,948 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/ResourceIdentifier" - ], - "definitions": { - "DocDbSettings": { - "additionalProperties": false, - "properties": { - "DocsToInvestigate": { - "type": "integer" - }, - "ExtractDocId": { - "type": "boolean" - }, - "NestingLevel": { - "type": "string" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "DynamoDbSettings": { - "additionalProperties": false, - "properties": { - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "ElasticsearchSettings": { - "additionalProperties": false, - "properties": { - "EndpointUri": { - "type": "string" - }, - "ErrorRetryDuration": { - "type": "integer" - }, - "FullLoadErrorPercentage": { - "type": "integer" - }, - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "GcpMySQLSettings": { - "additionalProperties": false, - "properties": { - "AfterConnectScript": { - "type": "string" - }, - "CleanSourceMetadataOnMismatch": { - "type": "boolean" - }, - "DatabaseName": { - "type": "string" - }, - "EventsPollInterval": { - "type": "integer" - }, - "MaxFileSize": { - "type": "integer" - }, - "ParallelLoadThreads": { - "type": "integer" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "ServerTimezone": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "IbmDb2Settings": { - "additionalProperties": false, - "properties": { - "CurrentLsn": { - "type": "string" - }, - "KeepCsvFiles": { - "type": "boolean" - }, - "LoadTimeout": { - "type": "integer" - }, - "MaxFileSize": { - "type": "integer" - }, - "MaxKBytesPerRead": { - "type": "integer" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "SetDataCaptureChanges": { - "type": "boolean" - }, - "WriteBufferSize": { - "type": "integer" - } - }, - "type": "object" - }, - "KafkaSettings": { - "additionalProperties": false, - "properties": { - "Broker": { - "type": "string" - }, - "IncludeControlDetails": { - "type": "boolean" - }, - "IncludeNullAndEmpty": { - "type": "boolean" - }, - "IncludePartitionValue": { - "type": "boolean" - }, - "IncludeTableAlterOperations": { - "type": "boolean" - }, - "IncludeTransactionDetails": { - "type": "boolean" - }, - "MessageFormat": { - "type": "string" - }, - "MessageMaxBytes": { - "type": "integer" - }, - "NoHexPrefix": { - "type": "boolean" - }, - "PartitionIncludeSchemaTable": { - "type": "boolean" - }, - "SaslPassword": { - "type": "string" - }, - "SaslUserName": { - "type": "string" - }, - "SecurityProtocol": { - "type": "string" - }, - "SslCaCertificateArn": { - "type": "string" - }, - "SslClientCertificateArn": { - "type": "string" - }, - "SslClientKeyArn": { - "type": "string" - }, - "SslClientKeyPassword": { - "type": "string" - }, - "Topic": { - "type": "string" - } - }, - "type": "object" - }, - "KinesisSettings": { - "additionalProperties": false, - "properties": { - "IncludeControlDetails": { - "type": "boolean" - }, - "IncludeNullAndEmpty": { - "type": "boolean" - }, - "IncludePartitionValue": { - "type": "boolean" - }, - "IncludeTableAlterOperations": { - "type": "boolean" - }, - "IncludeTransactionDetails": { - "type": "boolean" - }, - "MessageFormat": { - "type": "string" - }, - "NoHexPrefix": { - "type": "boolean" - }, - "PartitionIncludeSchemaTable": { - "type": "boolean" - }, - "ServiceAccessRoleArn": { - "type": "string" - }, - "StreamArn": { - "type": "string" - } - }, - "type": "object" - }, - "MicrosoftSqlServerSettings": { - "additionalProperties": false, - "properties": { - "BcpPacketSize": { - "type": "integer" - }, - "ControlTablesFileGroup": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "ForceLobLookup": { - "type": "boolean" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "QuerySingleAlwaysOnNode": { - "type": "boolean" - }, - "ReadBackupOnly": { - "type": "boolean" - }, - "SafeguardPolicy": { - "type": "string" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "TlogAccessMode": { - "type": "string" - }, - "TrimSpaceInChar": { - "type": "boolean" - }, - "UseBcpFullLoad": { - "type": "boolean" - }, - "UseThirdPartyBackupDevice": { - "type": "boolean" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "MongoDbSettings": { - "additionalProperties": false, - "properties": { - "AuthMechanism": { - "type": "string" - }, - "AuthSource": { - "type": "string" - }, - "AuthType": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DocsToInvestigate": { - "type": "string" - }, - "ExtractDocId": { - "type": "string" - }, - "NestingLevel": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "MySqlSettings": { - "additionalProperties": false, - "properties": { - "AfterConnectScript": { - "type": "string" - }, - "CleanSourceMetadataOnMismatch": { - "type": "boolean" - }, - "EventsPollInterval": { - "type": "integer" - }, - "MaxFileSize": { - "type": "integer" - }, - "ParallelLoadThreads": { - "type": "integer" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerTimezone": { - "type": "string" - }, - "TargetDbType": { - "type": "string" - } - }, - "type": "object" - }, - "NeptuneSettings": { - "additionalProperties": false, - "properties": { - "ErrorRetryDuration": { - "type": "integer" - }, - "IamAuthEnabled": { - "type": "boolean" - }, - "MaxFileSize": { - "type": "integer" - }, - "MaxRetryCount": { - "type": "integer" - }, - "S3BucketFolder": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "OracleSettings": { - "additionalProperties": false, - "properties": { - "AccessAlternateDirectly": { - "type": "boolean" - }, - "AddSupplementalLogging": { - "type": "boolean" - }, - "AdditionalArchivedLogDestId": { - "type": "integer" - }, - "AllowSelectNestedTables": { - "type": "boolean" - }, - "ArchivedLogDestId": { - "type": "integer" - }, - "ArchivedLogsOnly": { - "type": "boolean" - }, - "AsmPassword": { - "type": "string" - }, - "AsmServer": { - "type": "string" - }, - "AsmUser": { - "type": "string" - }, - "CharLengthSemantics": { - "type": "string" - }, - "DirectPathNoLog": { - "type": "boolean" - }, - "DirectPathParallelLoad": { - "type": "boolean" - }, - "EnableHomogenousTablespace": { - "type": "boolean" - }, - "ExtraArchivedLogDestIds": { - "items": { - "type": "integer" - }, - "type": "array", - "uniqueItems": false - }, - "FailTasksOnLobTruncation": { - "type": "boolean" - }, - "NumberDatatypeScale": { - "type": "integer" - }, - "OraclePathPrefix": { - "type": "string" - }, - "ParallelAsmReadThreads": { - "type": "integer" - }, - "ReadAheadBlocks": { - "type": "integer" - }, - "ReadTableSpaceName": { - "type": "boolean" - }, - "ReplacePathPrefix": { - "type": "boolean" - }, - "RetryInterval": { - "type": "integer" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmSecretId": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "SecurityDbEncryption": { - "type": "string" - }, - "SecurityDbEncryptionName": { - "type": "string" - }, - "SpatialDataOptionToGeoJsonFunctionName": { - "type": "string" - }, - "StandbyDelayTime": { - "type": "integer" - }, - "UseAlternateFolderForOnline": { - "type": "boolean" - }, - "UseBFile": { - "type": "boolean" - }, - "UseDirectPathFullLoad": { - "type": "boolean" - }, - "UseLogminerReader": { - "type": "boolean" - }, - "UsePathPrefix": { - "type": "string" - } - }, - "type": "object" - }, - "PostgreSqlSettings": { - "additionalProperties": false, - "properties": { - "AfterConnectScript": { - "type": "string" - }, - "BabelfishDatabaseName": { - "type": "string" - }, - "CaptureDdls": { - "type": "boolean" - }, - "DatabaseMode": { - "type": "string" - }, - "DdlArtifactsSchema": { - "type": "string" - }, - "ExecuteTimeout": { - "type": "integer" - }, - "FailTasksOnLobTruncation": { - "type": "boolean" - }, - "HeartbeatEnable": { - "type": "boolean" - }, - "HeartbeatFrequency": { - "type": "integer" - }, - "HeartbeatSchema": { - "type": "string" - }, - "MapBooleanAsBoolean": { - "type": "boolean" - }, - "MaxFileSize": { - "type": "integer" - }, - "PluginName": { - "type": "string" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "SlotName": { - "type": "string" - } - }, - "type": "object" - }, - "RedisSettings": { - "additionalProperties": false, - "properties": { - "AuthPassword": { - "type": "string" - }, - "AuthType": { - "type": "string" - }, - "AuthUserName": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "ServerName": { - "type": "string" - }, - "SslCaCertificateArn": { - "type": "string" - }, - "SslSecurityProtocol": { - "type": "string" - } - }, - "type": "object" - }, - "RedshiftSettings": { - "additionalProperties": false, - "properties": { - "AcceptAnyDate": { - "type": "boolean" - }, - "AfterConnectScript": { - "type": "string" - }, - "BucketFolder": { - "type": "string" - }, - "BucketName": { - "type": "string" - }, - "CaseSensitiveNames": { - "type": "boolean" - }, - "CompUpdate": { - "type": "boolean" - }, - "ConnectionTimeout": { - "type": "integer" - }, - "DateFormat": { - "type": "string" - }, - "EmptyAsNull": { - "type": "boolean" - }, - "EncryptionMode": { - "type": "string" - }, - "ExplicitIds": { - "type": "boolean" - }, - "FileTransferUploadStreams": { - "type": "integer" - }, - "LoadTimeout": { - "type": "integer" - }, - "MapBooleanAsBoolean": { - "type": "boolean" - }, - "MaxFileSize": { - "type": "integer" - }, - "RemoveQuotes": { - "type": "boolean" - }, - "ReplaceChars": { - "type": "string" - }, - "ReplaceInvalidChars": { - "type": "string" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerSideEncryptionKmsKeyId": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - }, - "TimeFormat": { - "type": "string" - }, - "TrimBlanks": { - "type": "boolean" - }, - "TruncateColumns": { - "type": "boolean" - }, - "WriteBufferSize": { - "type": "integer" - } - }, - "type": "object" - }, - "S3Settings": { - "additionalProperties": false, - "properties": { - "AddColumnName": { - "type": "boolean" - }, - "AddTrailingPaddingCharacter": { - "type": "boolean" - }, - "BucketFolder": { - "type": "string" - }, - "BucketName": { - "type": "string" - }, - "CannedAclForObjects": { - "type": "string" - }, - "CdcInsertsAndUpdates": { - "type": "boolean" - }, - "CdcInsertsOnly": { - "type": "boolean" - }, - "CdcMaxBatchInterval": { - "type": "integer" - }, - "CdcMinFileSize": { - "type": "integer" - }, - "CdcPath": { - "type": "string" - }, - "CompressionType": { - "type": "string" - }, - "CsvDelimiter": { - "type": "string" - }, - "CsvNoSupValue": { - "type": "string" - }, - "CsvNullValue": { - "type": "string" - }, - "CsvRowDelimiter": { - "type": "string" - }, - "DataFormat": { - "type": "string" - }, - "DataPageSize": { - "type": "integer" - }, - "DatePartitionDelimiter": { - "type": "string" - }, - "DatePartitionEnabled": { - "type": "boolean" - }, - "DatePartitionSequence": { - "type": "string" - }, - "DatePartitionTimezone": { - "type": "string" - }, - "DictPageSizeLimit": { - "type": "integer" - }, - "EnableStatistics": { - "type": "boolean" - }, - "EncodingType": { - "type": "string" - }, - "EncryptionMode": { - "type": "string" - }, - "ExpectedBucketOwner": { - "type": "string" - }, - "ExternalTableDefinition": { - "type": "string" - }, - "GlueCatalogGeneration": { - "type": "boolean" - }, - "IgnoreHeaderRows": { - "type": "integer" - }, - "IncludeOpForFullLoad": { - "type": "boolean" - }, - "MaxFileSize": { - "type": "integer" - }, - "ParquetTimestampInMillisecond": { - "type": "boolean" - }, - "ParquetVersion": { - "type": "string" - }, - "PreserveTransactions": { - "type": "boolean" - }, - "Rfc4180": { - "type": "boolean" - }, - "RowGroupLength": { - "type": "integer" - }, - "ServerSideEncryptionKmsKeyId": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - }, - "TimestampColumnName": { - "type": "string" - }, - "UseCsvNoSupValue": { - "type": "boolean" - }, - "UseTaskStartTimeForFullLoadTimestamp": { - "type": "boolean" - } - }, - "type": "object" - }, - "SybaseSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DMS::Endpoint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DocDbSettings": { - "$ref": "#/definitions/DocDbSettings" - }, - "DynamoDbSettings": { - "$ref": "#/definitions/DynamoDbSettings" - }, - "ElasticsearchSettings": { - "$ref": "#/definitions/ElasticsearchSettings" - }, - "EndpointIdentifier": { - "type": "string" - }, - "EndpointType": { - "type": "string" - }, - "EngineName": { - "type": "string" - }, - "ExternalId": { - "type": "string" - }, - "ExtraConnectionAttributes": { - "type": "string" - }, - "GcpMySQLSettings": { - "$ref": "#/definitions/GcpMySQLSettings" - }, - "IbmDb2Settings": { - "$ref": "#/definitions/IbmDb2Settings" - }, - "Id": { - "type": "string" - }, - "KafkaSettings": { - "$ref": "#/definitions/KafkaSettings" - }, - "KinesisSettings": { - "$ref": "#/definitions/KinesisSettings" - }, - "KmsKeyId": { - "type": "string" - }, - "MicrosoftSqlServerSettings": { - "$ref": "#/definitions/MicrosoftSqlServerSettings" - }, - "MongoDbSettings": { - "$ref": "#/definitions/MongoDbSettings" - }, - "MySqlSettings": { - "$ref": "#/definitions/MySqlSettings" - }, - "NeptuneSettings": { - "$ref": "#/definitions/NeptuneSettings" - }, - "OracleSettings": { - "$ref": "#/definitions/OracleSettings" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "PostgreSqlSettings": { - "$ref": "#/definitions/PostgreSqlSettings" - }, - "RedisSettings": { - "$ref": "#/definitions/RedisSettings" - }, - "RedshiftSettings": { - "$ref": "#/definitions/RedshiftSettings" - }, - "ResourceIdentifier": { - "type": "string" - }, - "S3Settings": { - "$ref": "#/definitions/S3Settings" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "type": "string" - }, - "SybaseSettings": { - "$ref": "#/definitions/SybaseSettings" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Username": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ExternalId" - ], - "required": [ - "EndpointType", - "EngineName" - ], - "typeName": "AWS::DMS::Endpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/ResourceIdentifier" + ], + "definitions": { + "DocDbSettings": { + "additionalProperties": false, + "properties": { + "DocsToInvestigate": { + "type": "integer" + }, + "ExtractDocId": { + "type": "boolean" + }, + "NestingLevel": { + "type": "string" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + } + }, + "type": "object" + }, + "DynamoDbSettings": { + "additionalProperties": false, + "properties": { + "ServiceAccessRoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "ElasticsearchSettings": { + "additionalProperties": false, + "properties": { + "EndpointUri": { + "type": "string" + }, + "ErrorRetryDuration": { + "type": "integer" + }, + "FullLoadErrorPercentage": { + "type": "integer" + }, + "ServiceAccessRoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "GcpMySQLSettings": { + "additionalProperties": false, + "properties": { + "AfterConnectScript": { + "type": "string" + }, + "CleanSourceMetadataOnMismatch": { + "type": "boolean" + }, + "DatabaseName": { + "type": "string" + }, + "EventsPollInterval": { + "type": "integer" + }, + "MaxFileSize": { + "type": "integer" + }, + "ParallelLoadThreads": { + "type": "integer" + }, + "Password": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "ServerName": { + "type": "string" + }, + "ServerTimezone": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "IbmDb2Settings": { + "additionalProperties": false, + "properties": { + "CurrentLsn": { + "type": "string" + }, + "KeepCsvFiles": { + "type": "boolean" + }, + "LoadTimeout": { + "type": "integer" + }, + "MaxFileSize": { + "type": "integer" + }, + "MaxKBytesPerRead": { + "type": "integer" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "SetDataCaptureChanges": { + "type": "boolean" + }, + "WriteBufferSize": { + "type": "integer" + } + }, + "type": "object" + }, + "KafkaSettings": { + "additionalProperties": false, + "properties": { + "Broker": { + "type": "string" + }, + "IncludeControlDetails": { + "type": "boolean" + }, + "IncludeNullAndEmpty": { + "type": "boolean" + }, + "IncludePartitionValue": { + "type": "boolean" + }, + "IncludeTableAlterOperations": { + "type": "boolean" + }, + "IncludeTransactionDetails": { + "type": "boolean" + }, + "MessageFormat": { + "type": "string" + }, + "MessageMaxBytes": { + "type": "integer" + }, + "NoHexPrefix": { + "type": "boolean" + }, + "PartitionIncludeSchemaTable": { + "type": "boolean" + }, + "SaslPassword": { + "type": "string" + }, + "SaslUserName": { + "type": "string" + }, + "SecurityProtocol": { + "type": "string" + }, + "SslCaCertificateArn": { + "type": "string" + }, + "SslClientCertificateArn": { + "type": "string" + }, + "SslClientKeyArn": { + "type": "string" + }, + "SslClientKeyPassword": { + "type": "string" + }, + "Topic": { + "type": "string" + } + }, + "type": "object" + }, + "KinesisSettings": { + "additionalProperties": false, + "properties": { + "IncludeControlDetails": { + "type": "boolean" + }, + "IncludeNullAndEmpty": { + "type": "boolean" + }, + "IncludePartitionValue": { + "type": "boolean" + }, + "IncludeTableAlterOperations": { + "type": "boolean" + }, + "IncludeTransactionDetails": { + "type": "boolean" + }, + "MessageFormat": { + "type": "string" + }, + "NoHexPrefix": { + "type": "boolean" + }, + "PartitionIncludeSchemaTable": { + "type": "boolean" + }, + "ServiceAccessRoleArn": { + "type": "string" + }, + "StreamArn": { + "type": "string" + } + }, + "type": "object" + }, + "MicrosoftSqlServerSettings": { + "additionalProperties": false, + "properties": { + "BcpPacketSize": { + "type": "integer" + }, + "ControlTablesFileGroup": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "ForceLobLookup": { + "type": "boolean" + }, + "Password": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "QuerySingleAlwaysOnNode": { + "type": "boolean" + }, + "ReadBackupOnly": { + "type": "boolean" + }, + "SafeguardPolicy": { + "type": "string" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "ServerName": { + "type": "string" + }, + "TlogAccessMode": { + "type": "string" + }, + "TrimSpaceInChar": { + "type": "boolean" + }, + "UseBcpFullLoad": { + "type": "boolean" + }, + "UseThirdPartyBackupDevice": { + "type": "boolean" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "MongoDbSettings": { + "additionalProperties": false, + "properties": { + "AuthMechanism": { + "type": "string" + }, + "AuthSource": { + "type": "string" + }, + "AuthType": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "DocsToInvestigate": { + "type": "string" + }, + "ExtractDocId": { + "type": "string" + }, + "NestingLevel": { + "type": "string" + }, + "Password": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "ServerName": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "MySqlSettings": { + "additionalProperties": false, + "properties": { + "AfterConnectScript": { + "type": "string" + }, + "CleanSourceMetadataOnMismatch": { + "type": "boolean" + }, + "EventsPollInterval": { + "type": "integer" + }, + "MaxFileSize": { + "type": "integer" + }, + "ParallelLoadThreads": { + "type": "integer" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "ServerTimezone": { + "type": "string" + }, + "TargetDbType": { + "type": "string" + } + }, + "type": "object" + }, + "NeptuneSettings": { + "additionalProperties": false, + "properties": { + "ErrorRetryDuration": { + "type": "integer" + }, + "IamAuthEnabled": { + "type": "boolean" + }, + "MaxFileSize": { + "type": "integer" + }, + "MaxRetryCount": { + "type": "integer" + }, + "S3BucketFolder": { + "type": "string" + }, + "S3BucketName": { + "type": "string" + }, + "ServiceAccessRoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "OracleSettings": { + "additionalProperties": false, + "properties": { + "AccessAlternateDirectly": { + "type": "boolean" + }, + "AddSupplementalLogging": { + "type": "boolean" + }, + "AdditionalArchivedLogDestId": { + "type": "integer" + }, + "AllowSelectNestedTables": { + "type": "boolean" + }, + "ArchivedLogDestId": { + "type": "integer" + }, + "ArchivedLogsOnly": { + "type": "boolean" + }, + "AsmPassword": { + "type": "string" + }, + "AsmServer": { + "type": "string" + }, + "AsmUser": { + "type": "string" + }, + "CharLengthSemantics": { + "type": "string" + }, + "DirectPathNoLog": { + "type": "boolean" + }, + "DirectPathParallelLoad": { + "type": "boolean" + }, + "EnableHomogenousTablespace": { + "type": "boolean" + }, + "ExtraArchivedLogDestIds": { + "items": { + "type": "integer" + }, + "type": "array", + "uniqueItems": false + }, + "FailTasksOnLobTruncation": { + "type": "boolean" + }, + "NumberDatatypeScale": { + "type": "integer" + }, + "OraclePathPrefix": { + "type": "string" + }, + "ParallelAsmReadThreads": { + "type": "integer" + }, + "ReadAheadBlocks": { + "type": "integer" + }, + "ReadTableSpaceName": { + "type": "boolean" + }, + "ReplacePathPrefix": { + "type": "boolean" + }, + "RetryInterval": { + "type": "integer" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerOracleAsmAccessRoleArn": { + "type": "string" + }, + "SecretsManagerOracleAsmSecretId": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "SecurityDbEncryption": { + "type": "string" + }, + "SecurityDbEncryptionName": { + "type": "string" + }, + "SpatialDataOptionToGeoJsonFunctionName": { + "type": "string" + }, + "StandbyDelayTime": { + "type": "integer" + }, + "UseAlternateFolderForOnline": { + "type": "boolean" + }, + "UseBFile": { + "type": "boolean" + }, + "UseDirectPathFullLoad": { + "type": "boolean" + }, + "UseLogminerReader": { + "type": "boolean" + }, + "UsePathPrefix": { + "type": "string" + } + }, + "type": "object" + }, + "PostgreSqlSettings": { + "additionalProperties": false, + "properties": { + "AfterConnectScript": { + "type": "string" + }, + "BabelfishDatabaseName": { + "type": "string" + }, + "CaptureDdls": { + "type": "boolean" + }, + "DatabaseMode": { + "type": "string" + }, + "DdlArtifactsSchema": { + "type": "string" + }, + "ExecuteTimeout": { + "type": "integer" + }, + "FailTasksOnLobTruncation": { + "type": "boolean" + }, + "HeartbeatEnable": { + "type": "boolean" + }, + "HeartbeatFrequency": { + "type": "integer" + }, + "HeartbeatSchema": { + "type": "string" + }, + "MapBooleanAsBoolean": { + "type": "boolean" + }, + "MaxFileSize": { + "type": "integer" + }, + "PluginName": { + "type": "string" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "SlotName": { + "type": "string" + } + }, + "type": "object" + }, + "RedisSettings": { + "additionalProperties": false, + "properties": { + "AuthPassword": { + "type": "string" + }, + "AuthType": { + "type": "string" + }, + "AuthUserName": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ServerName": { + "type": "string" + }, + "SslCaCertificateArn": { + "type": "string" + }, + "SslSecurityProtocol": { + "type": "string" + } + }, + "type": "object" + }, + "RedshiftSettings": { + "additionalProperties": false, + "properties": { + "AcceptAnyDate": { + "type": "boolean" + }, + "AfterConnectScript": { + "type": "string" + }, + "BucketFolder": { + "type": "string" + }, + "BucketName": { + "type": "string" + }, + "CaseSensitiveNames": { + "type": "boolean" + }, + "CompUpdate": { + "type": "boolean" + }, + "ConnectionTimeout": { + "type": "integer" + }, + "DateFormat": { + "type": "string" + }, + "EmptyAsNull": { + "type": "boolean" + }, + "EncryptionMode": { + "type": "string" + }, + "ExplicitIds": { + "type": "boolean" + }, + "FileTransferUploadStreams": { + "type": "integer" + }, + "LoadTimeout": { + "type": "integer" + }, + "MapBooleanAsBoolean": { + "type": "boolean" + }, + "MaxFileSize": { + "type": "integer" + }, + "RemoveQuotes": { + "type": "boolean" + }, + "ReplaceChars": { + "type": "string" + }, + "ReplaceInvalidChars": { + "type": "string" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + }, + "ServerSideEncryptionKmsKeyId": { + "type": "string" + }, + "ServiceAccessRoleArn": { + "type": "string" + }, + "TimeFormat": { + "type": "string" + }, + "TrimBlanks": { + "type": "boolean" + }, + "TruncateColumns": { + "type": "boolean" + }, + "WriteBufferSize": { + "type": "integer" + } + }, + "type": "object" + }, + "S3Settings": { + "additionalProperties": false, + "properties": { + "AddColumnName": { + "type": "boolean" + }, + "AddTrailingPaddingCharacter": { + "type": "boolean" + }, + "BucketFolder": { + "type": "string" + }, + "BucketName": { + "type": "string" + }, + "CannedAclForObjects": { + "type": "string" + }, + "CdcInsertsAndUpdates": { + "type": "boolean" + }, + "CdcInsertsOnly": { + "type": "boolean" + }, + "CdcMaxBatchInterval": { + "type": "integer" + }, + "CdcMinFileSize": { + "type": "integer" + }, + "CdcPath": { + "type": "string" + }, + "CompressionType": { + "type": "string" + }, + "CsvDelimiter": { + "type": "string" + }, + "CsvNoSupValue": { + "type": "string" + }, + "CsvNullValue": { + "type": "string" + }, + "CsvRowDelimiter": { + "type": "string" + }, + "DataFormat": { + "type": "string" + }, + "DataPageSize": { + "type": "integer" + }, + "DatePartitionDelimiter": { + "type": "string" + }, + "DatePartitionEnabled": { + "type": "boolean" + }, + "DatePartitionSequence": { + "type": "string" + }, + "DatePartitionTimezone": { + "type": "string" + }, + "DictPageSizeLimit": { + "type": "integer" + }, + "EnableStatistics": { + "type": "boolean" + }, + "EncodingType": { + "type": "string" + }, + "EncryptionMode": { + "type": "string" + }, + "ExpectedBucketOwner": { + "type": "string" + }, + "ExternalTableDefinition": { + "type": "string" + }, + "GlueCatalogGeneration": { + "type": "boolean" + }, + "IgnoreHeaderRows": { + "type": "integer" + }, + "IncludeOpForFullLoad": { + "type": "boolean" + }, + "MaxFileSize": { + "type": "integer" + }, + "ParquetTimestampInMillisecond": { + "type": "boolean" + }, + "ParquetVersion": { + "type": "string" + }, + "PreserveTransactions": { + "type": "boolean" + }, + "Rfc4180": { + "type": "boolean" + }, + "RowGroupLength": { + "type": "integer" + }, + "ServerSideEncryptionKmsKeyId": { + "type": "string" + }, + "ServiceAccessRoleArn": { + "type": "string" + }, + "TimestampColumnName": { + "type": "string" + }, + "UseCsvNoSupValue": { + "type": "boolean" + }, + "UseTaskStartTimeForFullLoadTimestamp": { + "type": "boolean" + } + }, + "type": "object" + }, + "SybaseSettings": { + "additionalProperties": false, + "properties": { + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DMS::Endpoint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "DocDbSettings": { + "$ref": "#/definitions/DocDbSettings" + }, + "DynamoDbSettings": { + "$ref": "#/definitions/DynamoDbSettings" + }, + "ElasticsearchSettings": { + "$ref": "#/definitions/ElasticsearchSettings" + }, + "EndpointIdentifier": { + "type": "string" + }, + "EndpointType": { + "type": "string" + }, + "EngineName": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "ExtraConnectionAttributes": { + "type": "string" + }, + "GcpMySQLSettings": { + "$ref": "#/definitions/GcpMySQLSettings" + }, + "IbmDb2Settings": { + "$ref": "#/definitions/IbmDb2Settings" + }, + "Id": { + "type": "string" + }, + "KafkaSettings": { + "$ref": "#/definitions/KafkaSettings" + }, + "KinesisSettings": { + "$ref": "#/definitions/KinesisSettings" + }, + "KmsKeyId": { + "type": "string" + }, + "MicrosoftSqlServerSettings": { + "$ref": "#/definitions/MicrosoftSqlServerSettings" + }, + "MongoDbSettings": { + "$ref": "#/definitions/MongoDbSettings" + }, + "MySqlSettings": { + "$ref": "#/definitions/MySqlSettings" + }, + "NeptuneSettings": { + "$ref": "#/definitions/NeptuneSettings" + }, + "OracleSettings": { + "$ref": "#/definitions/OracleSettings" + }, + "Password": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "PostgreSqlSettings": { + "$ref": "#/definitions/PostgreSqlSettings" + }, + "RedisSettings": { + "$ref": "#/definitions/RedisSettings" + }, + "RedshiftSettings": { + "$ref": "#/definitions/RedshiftSettings" + }, + "ResourceIdentifier": { + "type": "string" + }, + "S3Settings": { + "$ref": "#/definitions/S3Settings" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "type": "string" + }, + "SybaseSettings": { + "$ref": "#/definitions/SybaseSettings" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Username": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ExternalId" + ], + "required": [ + "EndpointType", + "EngineName" + ], + "typeName": "AWS::DMS::Endpoint" +} diff --git a/schema/aws-dms-eventsubscription.json b/schema/aws-dms-eventsubscription.json index bdee90b..d4e40d5 100644 --- a/schema/aws-dms-eventsubscription.json +++ b/schema/aws-dms-eventsubscription.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubscriptionName", - "/properties/SourceIds" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DMS::EventSubscription", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Enabled": { - "type": "boolean" - }, - "EventCategories": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "SnsTopicArn": { - "type": "string" - }, - "SourceIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceType": { - "type": "string" - }, - "SubscriptionName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SnsTopicArn" - ], - "typeName": "AWS::DMS::EventSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriptionName", + "/properties/SourceIds" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DMS::EventSubscription", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "EventCategories": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "SnsTopicArn": { + "type": "string" + }, + "SourceIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceType": { + "type": "string" + }, + "SubscriptionName": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SnsTopicArn" + ], + "typeName": "AWS::DMS::EventSubscription" +} diff --git a/schema/aws-dms-instanceprofile.json b/schema/aws-dms-instanceprofile.json index 37f9906..e1aeeac 100644 --- a/schema/aws-dms-instanceprofile.json +++ b/schema/aws-dms-instanceprofile.json @@ -1,170 +1,173 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/InstanceProfileName" - ] - ], - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::DMS::InstanceProfile.", - "handlers": { - "create": { - "permissions": [ - "dms:CreateInstanceProfile", - "dms:ListInstanceProfiles", - "dms:DescribeInstanceProfiles", - "dms:AddTagsToResource", - "dms:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "dms:DeleteInstanceProfile" - ] - }, - "list": { - "permissions": [ - "dms:ListInstanceProfiles", - "dms:DescribeInstanceProfiles", - "dms:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "dms:ListInstanceProfiles", - "dms:DescribeInstanceProfiles", - "dms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "dms:UpdateInstanceProfile", - "dms:ModifyInstanceProfile", - "dms:AddTagsToResource", - "dms:RemoveTagsToResource", - "dms:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceProfileArn" - ], - "properties": { - "AvailabilityZone": { - "description": "The property describes an availability zone of the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The optional description of the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileArn": { - "description": "The property describes an ARN of the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileCreationTime": { - "description": "The property describes a creating time of the instance profile.", - "maxLength": 40, - "minLength": 1, - "type": "string" - }, - "InstanceProfileIdentifier": { - "description": "The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileName": { - "description": "The property describes a name for the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "KmsKeyArn": { - "description": "The property describes kms key arn for the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "NetworkType": { - "description": "The property describes a network type for the instance profile.", - "enum": [ - "IPV4", - "IPV6", - "DUAL" - ], - "type": "string" - }, - "PubliclyAccessible": { - "default": false, - "description": "The property describes the publicly accessible of the instance profile", - "type": "boolean" - }, - "SubnetGroupIdentifier": { - "description": "The property describes a subnet group identifier for the instance profile.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VpcSecurityGroups": { - "description": "The property describes vps security groups for the instance profile.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/InstanceProfileArn", - "/properties/InstanceProfileCreationTime" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-csf.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::DMS::InstanceProfile", - "writeOnlyProperties": [ - "/properties/InstanceProfileIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/InstanceProfileName" + ] + ], + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::DMS::InstanceProfile.", + "handlers": { + "create": { + "permissions": [ + "dms:CreateInstanceProfile", + "dms:ListInstanceProfiles", + "dms:DescribeInstanceProfiles", + "dms:AddTagsToResource", + "dms:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "dms:DeleteInstanceProfile" + ] + }, + "list": { + "permissions": [ + "dms:ListInstanceProfiles", + "dms:DescribeInstanceProfiles", + "dms:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "dms:ListInstanceProfiles", + "dms:DescribeInstanceProfiles", + "dms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "dms:UpdateInstanceProfile", + "dms:ModifyInstanceProfile", + "dms:AddTagsToResource", + "dms:RemoveTagsToResource", + "dms:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceProfileArn" + ], + "properties": { + "AvailabilityZone": { + "description": "The property describes an availability zone of the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The optional description of the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileArn": { + "description": "The property describes an ARN of the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileCreationTime": { + "description": "The property describes a creating time of the instance profile.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "InstanceProfileIdentifier": { + "description": "The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileName": { + "description": "The property describes a name for the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "KmsKeyArn": { + "description": "The property describes kms key arn for the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "NetworkType": { + "description": "The property describes a network type for the instance profile.", + "enum": [ + "IPV4", + "DUAL" + ], + "type": "string" + }, + "PubliclyAccessible": { + "default": false, + "description": "The property describes the publicly accessible of the instance profile", + "type": "boolean" + }, + "SubnetGroupIdentifier": { + "description": "The property describes a subnet group identifier for the instance profile.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VpcSecurityGroups": { + "description": "The property describes vps security groups for the instance profile.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/InstanceProfileArn", + "/properties/InstanceProfileCreationTime" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-csf.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DMS::InstanceProfile", + "writeOnlyProperties": [ + "/properties/InstanceProfileIdentifier" + ] +} diff --git a/schema/aws-dms-migrationproject.json b/schema/aws-dms-migrationproject.json index dad2311..ea1ae2f 100644 --- a/schema/aws-dms-migrationproject.json +++ b/schema/aws-dms-migrationproject.json @@ -1,211 +1,215 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/MigrationProjectName" - ] - ], - "additionalProperties": false, - "definitions": { - "DataProviderDescriptor": { - "additionalProperties": false, - "description": "It is an object that describes Source and Target DataProviders and credentials for connecting to databases that are used in MigrationProject", - "properties": { - "DataProviderArn": { - "type": "string" - }, - "DataProviderIdentifier": { - "type": "string" - }, - "DataProviderName": { - "type": "string" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/MigrationProjectCreationTime" - ], - "description": "Resource schema for AWS::DMS::MigrationProject", - "handlers": { - "create": { - "permissions": [ - "dms:CreateMigrationProject", - "dms:ListMigrationProjects", - "dms:DescribeMigrationProjects", - "dms:AddTagsToResource", - "dms:ListTagsForResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "dms:DeleteMigrationProject" - ] - }, - "list": { - "permissions": [ - "dms:ListMigrationProjects", - "dms:DescribeMigrationProjects", - "dms:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "dms:DescribeMigrationProjects", - "dms:ListMigrationProjects", - "dms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "dms:UpdateMigrationProject", - "dms:ModifyMigrationProject", - "dms:AddTagsToResource", - "dms:RemoveTagsToResource", - "dms:ListTagsForResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/MigrationProjectArn" - ], - "properties": { - "Description": { - "description": "The optional description of the migration project.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileArn": { - "description": "The property describes an instance profile arn for the migration project. For read", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileIdentifier": { - "description": "The property describes an instance profile identifier for the migration project. For create", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "InstanceProfileName": { - "description": "The property describes an instance profile name for the migration project. For read", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "MigrationProjectArn": { - "description": "The property describes an ARN of the migration project.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "MigrationProjectCreationTime": { - "description": "The property describes a creating time of the migration project.", - "maxLength": 40, - "minLength": 1, - "type": "string" - }, - "MigrationProjectIdentifier": { - "description": "The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "MigrationProjectName": { - "description": "The property describes a name to identify the migration project.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "SchemaConversionApplicationAttributes": { - "additionalProperties": false, - "description": "The property describes schema conversion application attributes for the migration project.", - "properties": { - "S3BucketPath": { - "type": "string" - }, - "S3BucketRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "SourceDataProviderDescriptors": { - "description": "The property describes source data provider descriptors for the migration project.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataProviderDescriptor" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TargetDataProviderDescriptors": { - "description": "The property describes target data provider descriptors for the migration project.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataProviderDescriptor" - }, - "type": "array", - "uniqueItems": true - }, - "TransformationRules": { - "description": "The property describes transformation rules for the migration project.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/MigrationProjectArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-csf.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::DMS::MigrationProject", - "writeOnlyProperties": [ - "/properties/MigrationProjectIdentifier", - "/properties/InstanceProfileIdentifier", - "/properties/SourceDataProviderDescriptors/*/DataProviderIdentifier", - "/properties/TargetDataProviderDescriptors/*/DataProviderIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/MigrationProjectName" + ] + ], + "additionalProperties": false, + "definitions": { + "DataProviderDescriptor": { + "additionalProperties": false, + "description": "It is an object that describes Source and Target DataProviders and credentials for connecting to databases that are used in MigrationProject", + "properties": { + "DataProviderArn": { + "type": "string" + }, + "DataProviderIdentifier": { + "type": "string" + }, + "DataProviderName": { + "type": "string" + }, + "SecretsManagerAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecretId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/MigrationProjectCreationTime" + ], + "description": "Resource schema for AWS::DMS::MigrationProject", + "handlers": { + "create": { + "permissions": [ + "dms:CreateMigrationProject", + "dms:ListMigrationProjects", + "dms:DescribeMigrationProjects", + "dms:AddTagsToResource", + "dms:ListTagsForResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "dms:DeleteMigrationProject" + ] + }, + "list": { + "permissions": [ + "dms:ListMigrationProjects", + "dms:DescribeMigrationProjects", + "dms:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "dms:DescribeMigrationProjects", + "dms:ListMigrationProjects", + "dms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "dms:UpdateMigrationProject", + "dms:ModifyMigrationProject", + "dms:AddTagsToResource", + "dms:RemoveTagsToResource", + "dms:ListTagsForResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/MigrationProjectArn" + ], + "properties": { + "Description": { + "description": "The optional description of the migration project.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileArn": { + "description": "The property describes an instance profile arn for the migration project. For read", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileIdentifier": { + "description": "The property describes an instance profile identifier for the migration project. For create", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "InstanceProfileName": { + "description": "The property describes an instance profile name for the migration project. For read", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "MigrationProjectArn": { + "description": "The property describes an ARN of the migration project.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "MigrationProjectCreationTime": { + "description": "The property describes a creating time of the migration project.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "MigrationProjectIdentifier": { + "description": "The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "MigrationProjectName": { + "description": "The property describes a name to identify the migration project.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SchemaConversionApplicationAttributes": { + "additionalProperties": false, + "description": "The property describes schema conversion application attributes for the migration project.", + "properties": { + "S3BucketPath": { + "type": "string" + }, + "S3BucketRoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "SourceDataProviderDescriptors": { + "description": "The property describes source data provider descriptors for the migration project.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataProviderDescriptor" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TargetDataProviderDescriptors": { + "description": "The property describes target data provider descriptors for the migration project.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataProviderDescriptor" + }, + "type": "array", + "uniqueItems": true + }, + "TransformationRules": { + "description": "The property describes transformation rules for the migration project.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/MigrationProjectArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-csf.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DMS::MigrationProject", + "writeOnlyProperties": [ + "/properties/MigrationProjectIdentifier", + "/properties/InstanceProfileIdentifier", + "/properties/SourceDataProviderDescriptors/*/DataProviderIdentifier", + "/properties/TargetDataProviderDescriptors/*/DataProviderIdentifier" + ] +} diff --git a/schema/aws-dms-replicationconfig.json b/schema/aws-dms-replicationconfig.json index 2dc73ec..c01c247 100644 --- a/schema/aws-dms-replicationconfig.json +++ b/schema/aws-dms-replicationconfig.json @@ -1,207 +1,207 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ReplicationConfigIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceIdentifier" - ], - "definitions": { - "ComputeConfig": { - "additionalProperties": false, - "description": "Configuration parameters for provisioning a AWS DMS Serverless replication", - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "DnsNameServers": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MaxCapacityUnits": { - "type": "integer" - }, - "MinCapacityUnits": { - "type": "integer" - }, - "MultiAZ": { - "type": "boolean" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ReplicationSubnetGroupId": { - "type": "string" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "MaxCapacityUnits" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A replication configuration that you later provide to configure and start a AWS DMS Serverless replication", - "handlers": { - "create": { - "permissions": [ - "dms:CreateReplicationConfig", - "dms:AddTagsToResource", - "dms:ListTagsForResource", - "iam:CreateServiceLinkedRole", - "iam:AttachRolePolicy", - "iam:PutRolePolicy", - "iam:UpdateRoleDescription" - ] - }, - "delete": { - "permissions": [ - "dms:DescribeReplicationConfigs", - "dms:DeleteReplicationConfig", - "dms:ListTagsForResource", - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus" - ] - }, - "list": { - "permissions": [ - "dms:DescribeReplicationConfigs", - "dms:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "dms:DescribeReplicationConfigs", - "dms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "dms:ModifyReplicationConfig", - "dms:AddTagsToResource", - "dms:RemoveTagsFromResource", - "dms:ListTagsForResource", - "iam:CreateServiceLinkedRole", - "iam:AttachRolePolicy", - "iam:PutRolePolicy", - "iam:UpdateRoleDescription" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReplicationConfigArn" - ], - "properties": { - "ComputeConfig": { - "$ref": "#/definitions/ComputeConfig" - }, - "ReplicationConfigArn": { - "description": "The Amazon Resource Name (ARN) of the Replication Config", - "type": "string" - }, - "ReplicationConfigIdentifier": { - "description": "A unique identifier of replication configuration", - "type": "string" - }, - "ReplicationSettings": { - "description": "JSON settings for Servereless replications that are provisioned using this replication configuration", - "type": "object" - }, - "ReplicationType": { - "description": "The type of AWS DMS Serverless replication to provision using this replication configuration", - "enum": [ - "full-load", - "full-load-and-cdc", - "cdc" - ], - "type": "string" - }, - "ResourceIdentifier": { - "description": "A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource", - "type": "string" - }, - "SourceEndpointArn": { - "description": "The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration", - "type": "string" - }, - "SupplementalSettings": { - "description": "JSON settings for specifying supplemental data", - "type": "object" - }, - "TableMappings": { - "description": "JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration", - "type": "object" - }, - "Tags": { - "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "TargetEndpointArn": { - "description": "The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ReplicationConfigArn" - ], - "required": [ - "ReplicationConfigIdentifier", - "SourceEndpointArn", - "TargetEndpointArn", - "ReplicationType", - "ComputeConfig", - "TableMappings" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-dms", - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "dms:AddTagsToResource", - "dms:ListTagsForResource", - "dms:RemoveTagsFromResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DMS::ReplicationConfig" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ReplicationConfigIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceIdentifier" + ], + "definitions": { + "ComputeConfig": { + "additionalProperties": false, + "description": "Configuration parameters for provisioning a AWS DMS Serverless replication", + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "DnsNameServers": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "MaxCapacityUnits": { + "type": "integer" + }, + "MinCapacityUnits": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "ReplicationSubnetGroupId": { + "type": "string" + }, + "VpcSecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "MaxCapacityUnits" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A replication configuration that you later provide to configure and start a AWS DMS Serverless replication", + "handlers": { + "create": { + "permissions": [ + "dms:CreateReplicationConfig", + "dms:AddTagsToResource", + "dms:ListTagsForResource", + "iam:CreateServiceLinkedRole", + "iam:AttachRolePolicy", + "iam:PutRolePolicy", + "iam:UpdateRoleDescription" + ] + }, + "delete": { + "permissions": [ + "dms:DescribeReplicationConfigs", + "dms:DeleteReplicationConfig", + "dms:ListTagsForResource", + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus" + ] + }, + "list": { + "permissions": [ + "dms:DescribeReplicationConfigs", + "dms:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "dms:DescribeReplicationConfigs", + "dms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "dms:ModifyReplicationConfig", + "dms:AddTagsToResource", + "dms:RemoveTagsFromResource", + "dms:ListTagsForResource", + "iam:CreateServiceLinkedRole", + "iam:AttachRolePolicy", + "iam:PutRolePolicy", + "iam:UpdateRoleDescription" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReplicationConfigArn" + ], + "properties": { + "ComputeConfig": { + "$ref": "#/definitions/ComputeConfig" + }, + "ReplicationConfigArn": { + "description": "The Amazon Resource Name (ARN) of the Replication Config", + "type": "string" + }, + "ReplicationConfigIdentifier": { + "description": "A unique identifier of replication configuration", + "type": "string" + }, + "ReplicationSettings": { + "description": "JSON settings for Servereless replications that are provisioned using this replication configuration", + "type": "object" + }, + "ReplicationType": { + "description": "The type of AWS DMS Serverless replication to provision using this replication configuration", + "enum": [ + "full-load", + "full-load-and-cdc", + "cdc" + ], + "type": "string" + }, + "ResourceIdentifier": { + "description": "A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource", + "type": "string" + }, + "SourceEndpointArn": { + "description": "The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration", + "type": "string" + }, + "SupplementalSettings": { + "description": "JSON settings for specifying supplemental data", + "type": "object" + }, + "TableMappings": { + "description": "JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration", + "type": "object" + }, + "Tags": { + "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "TargetEndpointArn": { + "description": "The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ReplicationConfigArn" + ], + "required": [ + "ReplicationConfigIdentifier", + "SourceEndpointArn", + "TargetEndpointArn", + "ReplicationType", + "ComputeConfig", + "TableMappings" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-dms", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "dms:AddTagsToResource", + "dms:ListTagsForResource", + "dms:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DMS::ReplicationConfig" +} diff --git a/schema/aws-dms-replicationinstance.json b/schema/aws-dms-replicationinstance.json index 6dc590e..f1fc25c 100644 --- a/schema/aws-dms-replicationinstance.json +++ b/schema/aws-dms-replicationinstance.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/ResourceIdentifier", - "/properties/ReplicationSubnetGroupIdentifier", - "/properties/PubliclyAccessible" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DMS::ReplicationInstance", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllocatedStorage": { - "type": "integer" - }, - "AllowMajorVersionUpgrade": { - "type": "boolean" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MultiAZ": { - "type": "boolean" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "ReplicationInstanceClass": { - "type": "string" - }, - "ReplicationInstanceIdentifier": { - "type": "string" - }, - "ReplicationInstancePrivateIpAddresses": { - "type": "string" - }, - "ReplicationInstancePublicIpAddresses": { - "type": "string" - }, - "ReplicationSubnetGroupIdentifier": { - "type": "string" - }, - "ResourceIdentifier": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ReplicationInstancePublicIpAddresses", - "/properties/Id", - "/properties/ReplicationInstancePrivateIpAddresses" - ], - "required": [ - "ReplicationInstanceClass" - ], - "typeName": "AWS::DMS::ReplicationInstance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/ResourceIdentifier", + "/properties/ReplicationSubnetGroupIdentifier", + "/properties/PubliclyAccessible" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DMS::ReplicationInstance", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllocatedStorage": { + "type": "integer" + }, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "AvailabilityZone": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "MultiAZ": { + "type": "boolean" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "ReplicationInstanceClass": { + "type": "string" + }, + "ReplicationInstanceIdentifier": { + "type": "string" + }, + "ReplicationInstancePrivateIpAddresses": { + "type": "string" + }, + "ReplicationInstancePublicIpAddresses": { + "type": "string" + }, + "ReplicationSubnetGroupIdentifier": { + "type": "string" + }, + "ResourceIdentifier": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcSecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ReplicationInstancePublicIpAddresses", + "/properties/Id", + "/properties/ReplicationInstancePrivateIpAddresses" + ], + "required": [ + "ReplicationInstanceClass" + ], + "typeName": "AWS::DMS::ReplicationInstance" +} diff --git a/schema/aws-dms-replicationsubnetgroup.json b/schema/aws-dms-replicationsubnetgroup.json index e4ac9b4..e52cc41 100644 --- a/schema/aws-dms-replicationsubnetgroup.json +++ b/schema/aws-dms-replicationsubnetgroup.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReplicationSubnetGroupIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DMS::ReplicationSubnetGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "ReplicationSubnetGroupDescription": { - "type": "string" - }, - "ReplicationSubnetGroupIdentifier": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ReplicationSubnetGroupDescription", - "SubnetIds" - ], - "typeName": "AWS::DMS::ReplicationSubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReplicationSubnetGroupIdentifier" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DMS::ReplicationSubnetGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "ReplicationSubnetGroupDescription": { + "type": "string" + }, + "ReplicationSubnetGroupIdentifier": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ReplicationSubnetGroupDescription", + "SubnetIds" + ], + "typeName": "AWS::DMS::ReplicationSubnetGroup" +} diff --git a/schema/aws-dms-replicationtask.json b/schema/aws-dms-replicationtask.json index 50d2177..fe6384d 100644 --- a/schema/aws-dms-replicationtask.json +++ b/schema/aws-dms-replicationtask.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceIdentifier", - "/properties/TargetEndpointArn", - "/properties/ReplicationInstanceArn", - "/properties/SourceEndpointArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DMS::ReplicationTask", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CdcStartPosition": { - "type": "string" - }, - "CdcStartTime": { - "type": "number" - }, - "CdcStopPosition": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MigrationType": { - "type": "string" - }, - "ReplicationInstanceArn": { - "type": "string" - }, - "ReplicationTaskIdentifier": { - "type": "string" - }, - "ReplicationTaskSettings": { - "type": "string" - }, - "ResourceIdentifier": { - "type": "string" - }, - "SourceEndpointArn": { - "type": "string" - }, - "TableMappings": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TargetEndpointArn": { - "type": "string" - }, - "TaskData": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TableMappings", - "SourceEndpointArn", - "MigrationType", - "TargetEndpointArn", - "ReplicationInstanceArn" - ], - "typeName": "AWS::DMS::ReplicationTask" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceIdentifier", + "/properties/TargetEndpointArn", + "/properties/ReplicationInstanceArn", + "/properties/SourceEndpointArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DMS::ReplicationTask", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CdcStartPosition": { + "type": "string" + }, + "CdcStartTime": { + "type": "number" + }, + "CdcStopPosition": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MigrationType": { + "type": "string" + }, + "ReplicationInstanceArn": { + "type": "string" + }, + "ReplicationTaskIdentifier": { + "type": "string" + }, + "ReplicationTaskSettings": { + "type": "string" + }, + "ResourceIdentifier": { + "type": "string" + }, + "SourceEndpointArn": { + "type": "string" + }, + "TableMappings": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TargetEndpointArn": { + "type": "string" + }, + "TaskData": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TableMappings", + "SourceEndpointArn", + "MigrationType", + "TargetEndpointArn", + "ReplicationInstanceArn" + ], + "typeName": "AWS::DMS::ReplicationTask" +} diff --git a/schema/aws-docdb-dbcluster.json b/schema/aws-docdb-dbcluster.json index c6ed943..5ae5471 100644 --- a/schema/aws-docdb-dbcluster.json +++ b/schema/aws-docdb-dbcluster.json @@ -1,144 +1,144 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/SnapshotIdentifier", - "/properties/MasterUsername", - "/properties/SourceDBClusterIdentifier", - "/properties/DBClusterIdentifier", - "/properties/AvailabilityZones", - "/properties/DBSubnetGroupName", - "/properties/StorageEncrypted" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DocDB::DBCluster", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BackupRetentionPeriod": { - "type": "integer" - }, - "ClusterResourceId": { - "type": "string" - }, - "CopyTagsToSnapshot": { - "type": "boolean" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBClusterParameterGroupName": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "DeletionProtection": { - "type": "boolean" - }, - "EnableCloudwatchLogsExports": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Endpoint": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - }, - "MasterUsername": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ReadEndpoint": { - "type": "string" - }, - "RestoreToTime": { - "type": "string" - }, - "RestoreType": { - "type": "string" - }, - "SnapshotIdentifier": { - "type": "string" - }, - "SourceDBClusterIdentifier": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - }, - "StorageType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UseLatestRestorableTime": { - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ReadEndpoint", - "/properties/Id", - "/properties/Endpoint", - "/properties/ClusterResourceId" - ], - "typeName": "AWS::DocDB::DBCluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/SnapshotIdentifier", + "/properties/MasterUsername", + "/properties/SourceDBClusterIdentifier", + "/properties/DBClusterIdentifier", + "/properties/AvailabilityZones", + "/properties/DBSubnetGroupName", + "/properties/StorageEncrypted" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DocDB::DBCluster", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "ClusterResourceId": { + "type": "string" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "DBClusterIdentifier": { + "type": "string" + }, + "DBClusterParameterGroupName": { + "type": "string" + }, + "DBSubnetGroupName": { + "type": "string" + }, + "DeletionProtection": { + "type": "boolean" + }, + "EnableCloudwatchLogsExports": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Endpoint": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "MasterUserPassword": { + "type": "string" + }, + "MasterUsername": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "PreferredBackupWindow": { + "type": "string" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "ReadEndpoint": { + "type": "string" + }, + "RestoreToTime": { + "type": "string" + }, + "RestoreType": { + "type": "string" + }, + "SnapshotIdentifier": { + "type": "string" + }, + "SourceDBClusterIdentifier": { + "type": "string" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "StorageType": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "VpcSecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ReadEndpoint", + "/properties/Id", + "/properties/Endpoint", + "/properties/ClusterResourceId" + ], + "typeName": "AWS::DocDB::DBCluster" +} diff --git a/schema/aws-docdb-dbclusterparametergroup.json b/schema/aws-docdb-dbclusterparametergroup.json index 6811948..c78d65c 100644 --- a/schema/aws-docdb-dbclusterparametergroup.json +++ b/schema/aws-docdb-dbclusterparametergroup.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Family", - "/properties/Description", - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DocDB::DBClusterParameterGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Family", - "Description", - "Parameters" - ], - "typeName": "AWS::DocDB::DBClusterParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Family", + "/properties/Description", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DocDB::DBClusterParameterGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Family": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Family", + "Description", + "Parameters" + ], + "typeName": "AWS::DocDB::DBClusterParameterGroup" +} diff --git a/schema/aws-docdb-dbinstance.json b/schema/aws-docdb-dbinstance.json index 033c142..648404c 100644 --- a/schema/aws-docdb-dbinstance.json +++ b/schema/aws-docdb-dbinstance.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBClusterIdentifier", - "/properties/AvailabilityZone", - "/properties/DBInstanceIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DocDB::DBInstance", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "CACertificateIdentifier": { - "type": "string" - }, - "CertificateRotationRestart": { - "type": "boolean" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBInstanceClass": { - "type": "string" - }, - "DBInstanceIdentifier": { - "type": "string" - }, - "EnablePerformanceInsights": { - "type": "boolean" - }, - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Port": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Port", - "/properties/Id", - "/properties/Endpoint" - ], - "required": [ - "DBInstanceClass", - "DBClusterIdentifier" - ], - "typeName": "AWS::DocDB::DBInstance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBClusterIdentifier", + "/properties/AvailabilityZone", + "/properties/DBInstanceIdentifier" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DocDB::DBInstance", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "AvailabilityZone": { + "type": "string" + }, + "CACertificateIdentifier": { + "type": "string" + }, + "CertificateRotationRestart": { + "type": "boolean" + }, + "DBClusterIdentifier": { + "type": "string" + }, + "DBInstanceClass": { + "type": "string" + }, + "DBInstanceIdentifier": { + "type": "string" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "Endpoint": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Port": { + "type": "string" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Port", + "/properties/Id", + "/properties/Endpoint" + ], + "required": [ + "DBInstanceClass", + "DBClusterIdentifier" + ], + "typeName": "AWS::DocDB::DBInstance" +} diff --git a/schema/aws-docdb-dbsubnetgroup.json b/schema/aws-docdb-dbsubnetgroup.json index 14e861d..ce798e4 100644 --- a/schema/aws-docdb-dbsubnetgroup.json +++ b/schema/aws-docdb-dbsubnetgroup.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBSubnetGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::DocDB::DBSubnetGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DBSubnetGroupDescription": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "typeName": "AWS::DocDB::DBSubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBSubnetGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::DocDB::DBSubnetGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DBSubnetGroupDescription": { + "type": "string" + }, + "DBSubnetGroupName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DBSubnetGroupDescription", + "SubnetIds" + ], + "typeName": "AWS::DocDB::DBSubnetGroup" +} diff --git a/schema/aws-docdb-eventsubscription.json b/schema/aws-docdb-eventsubscription.json index 3b9db01..d4ba003 100644 --- a/schema/aws-docdb-eventsubscription.json +++ b/schema/aws-docdb-eventsubscription.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubscriptionName", - "/properties/SnsTopicArn" - ], - "description": "Resource Type definition for AWS::DocDB::EventSubscription", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Enabled": { - "type": "boolean" - }, - "EventCategories": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "SnsTopicArn": { - "type": "string" - }, - "SourceIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceType": { - "type": "string" - }, - "SubscriptionName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SnsTopicArn" - ], - "typeName": "AWS::DocDB::EventSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriptionName", + "/properties/SnsTopicArn" + ], + "description": "Resource Type definition for AWS::DocDB::EventSubscription", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "EventCategories": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "SnsTopicArn": { + "type": "string" + }, + "SourceIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceType": { + "type": "string" + }, + "SubscriptionName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SnsTopicArn" + ], + "typeName": "AWS::DocDB::EventSubscription" +} diff --git a/schema/aws-docdbelastic-cluster.json b/schema/aws-docdbelastic-cluster.json index fbd0793..de224a9 100644 --- a/schema/aws-docdbelastic-cluster.json +++ b/schema/aws-docdbelastic-cluster.json @@ -1,210 +1,210 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdminUserName", - "/properties/AuthType", - "/properties/ClusterName", - "/properties/KmsKeyId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster", - "handlers": { - "create": { - "permissions": [ - "docdb-elastic:CreateCluster", - "docdb-elastic:TagResource", - "docdb-elastic:GetCluster", - "docdb-elastic:ListTagsForResource", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "ec2:DeleteVpcEndpoints", - "ec2:ModifyVpcEndpoint", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "ec2:DescribeAvailabilityZones", - "secretsmanager:ListSecrets", - "secretsmanager:ListSecretVersionIds", - "secretsmanager:DescribeSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:GetResourcePolicy", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "docdb-elastic:DeleteCluster", - "docdb-elastic:GetCluster", - "ec2:DescribeVpcEndpoints", - "ec2:DeleteVpcEndpoints", - "ec2:ModifyVpcEndpoint", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "ec2:DescribeAvailabilityZones" - ] - }, - "list": { - "permissions": [ - "docdb-elastic:ListClusters" - ] - }, - "read": { - "permissions": [ - "docdb-elastic:GetCluster", - "docdb-elastic:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "docdb-elastic:UpdateCluster", - "docdb-elastic:TagResource", - "docdb-elastic:UntagResource", - "docdb-elastic:GetCluster", - "docdb-elastic:ListTagsForResource", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "ec2:DeleteVpcEndpoints", - "ec2:ModifyVpcEndpoint", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "ec2:DescribeAvailabilityZones", - "secretsmanager:ListSecrets", - "secretsmanager:ListSecretVersionIds", - "secretsmanager:DescribeSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:GetResourcePolicy", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterArn" - ], - "properties": { - "AdminUserName": { - "type": "string" - }, - "AdminUserPassword": { - "type": "string" - }, - "AuthType": { - "type": "string" - }, - "BackupRetentionPeriod": { - "type": "integer" - }, - "ClusterArn": { - "type": "string" - }, - "ClusterEndpoint": { - "type": "string" - }, - "ClusterName": { - "maxLength": 50, - "minLength": 1, - "pattern": "[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*", - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ShardCapacity": { - "type": "integer" - }, - "ShardCount": { - "type": "integer" - }, - "ShardInstanceCount": { - "type": "integer" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "VpcSecurityGroupIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ClusterArn", - "/properties/ClusterEndpoint" - ], - "required": [ - "ClusterName", - "AdminUserName", - "ShardCapacity", - "ShardCount", - "AuthType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-docdbelastic/", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DocDBElastic::Cluster", - "writeOnlyProperties": [ - "/properties/AdminUserPassword" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdminUserName", + "/properties/AuthType", + "/properties/ClusterName", + "/properties/KmsKeyId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster", + "handlers": { + "create": { + "permissions": [ + "docdb-elastic:CreateCluster", + "docdb-elastic:TagResource", + "docdb-elastic:GetCluster", + "docdb-elastic:ListTagsForResource", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "ec2:DeleteVpcEndpoints", + "ec2:ModifyVpcEndpoint", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "ec2:DescribeAvailabilityZones", + "secretsmanager:ListSecrets", + "secretsmanager:ListSecretVersionIds", + "secretsmanager:DescribeSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:GetResourcePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "docdb-elastic:DeleteCluster", + "docdb-elastic:GetCluster", + "ec2:DescribeVpcEndpoints", + "ec2:DeleteVpcEndpoints", + "ec2:ModifyVpcEndpoint", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "ec2:DescribeAvailabilityZones" + ] + }, + "list": { + "permissions": [ + "docdb-elastic:ListClusters" + ] + }, + "read": { + "permissions": [ + "docdb-elastic:GetCluster", + "docdb-elastic:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "docdb-elastic:UpdateCluster", + "docdb-elastic:TagResource", + "docdb-elastic:UntagResource", + "docdb-elastic:GetCluster", + "docdb-elastic:ListTagsForResource", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "ec2:DeleteVpcEndpoints", + "ec2:ModifyVpcEndpoint", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "ec2:DescribeAvailabilityZones", + "secretsmanager:ListSecrets", + "secretsmanager:ListSecretVersionIds", + "secretsmanager:DescribeSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:GetResourcePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterArn" + ], + "properties": { + "AdminUserName": { + "type": "string" + }, + "AdminUserPassword": { + "type": "string" + }, + "AuthType": { + "type": "string" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "ClusterArn": { + "type": "string" + }, + "ClusterEndpoint": { + "type": "string" + }, + "ClusterName": { + "maxLength": 50, + "minLength": 1, + "pattern": "[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*", + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "PreferredBackupWindow": { + "type": "string" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "ShardCapacity": { + "type": "integer" + }, + "ShardCount": { + "type": "integer" + }, + "ShardInstanceCount": { + "type": "integer" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "VpcSecurityGroupIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ClusterArn", + "/properties/ClusterEndpoint" + ], + "required": [ + "ClusterName", + "AdminUserName", + "ShardCapacity", + "ShardCount", + "AuthType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-docdbelastic/", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DocDBElastic::Cluster", + "writeOnlyProperties": [ + "/properties/AdminUserPassword" + ] +} diff --git a/schema/aws-dynamodb-globaltable.json b/schema/aws-dynamodb-globaltable.json index 688f560..4d134d8 100644 --- a/schema/aws-dynamodb-globaltable.json +++ b/schema/aws-dynamodb-globaltable.json @@ -1,679 +1,679 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ], - [ - "/properties/StreamArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocalSecondaryIndexes", - "/properties/TableName", - "/properties/KeySchema" - ], - "definitions": { - "AttributeDefinition": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "AttributeType": { - "type": "string" - } - }, - "required": [ - "AttributeName", - "AttributeType" - ], - "type": "object" - }, - "CapacityAutoScalingSettings": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "minimum": 1, - "type": "integer" - }, - "MinCapacity": { - "minimum": 1, - "type": "integer" - }, - "SeedCapacity": { - "minimum": 1, - "type": "integer" - }, - "TargetTrackingScalingPolicyConfiguration": { - "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration" - } - }, - "required": [ - "MinCapacity", - "MaxCapacity", - "TargetTrackingScalingPolicyConfiguration" - ], - "type": "object" - }, - "ContributorInsightsSpecification": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "GlobalSecondaryIndex": { - "additionalProperties": false, - "properties": { - "IndexName": { - "maxLength": 255, - "minLength": 3, - "type": "string" - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/KeySchema" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Projection": { - "$ref": "#/definitions/Projection" - }, - "WriteOnDemandThroughputSettings": { - "$ref": "#/definitions/WriteOnDemandThroughputSettings" - }, - "WriteProvisionedThroughputSettings": { - "$ref": "#/definitions/WriteProvisionedThroughputSettings" - } - }, - "required": [ - "IndexName", - "Projection", - "KeySchema" - ], - "type": "object" - }, - "KeySchema": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "KeyType": { - "type": "string" - } - }, - "required": [ - "KeyType", - "AttributeName" - ], - "type": "object" - }, - "KinesisStreamSpecification": { - "additionalProperties": false, - "properties": { - "ApproximateCreationDateTimePrecision": { - "enum": [ - "MICROSECOND", - "MILLISECOND" - ], - "type": "string" - }, - "StreamArn": { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Kinesis::Stream" - }, - "type": "string" - } - }, - "required": [ - "StreamArn" - ], - "type": "object" - }, - "LocalSecondaryIndex": { - "additionalProperties": false, - "properties": { - "IndexName": { - "maxLength": 255, - "minLength": 3, - "type": "string" - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/KeySchema" - }, - "maxItems": 2, - "type": "array", - "uniqueItems": true - }, - "Projection": { - "$ref": "#/definitions/Projection" - } - }, - "required": [ - "IndexName", - "Projection", - "KeySchema" - ], - "type": "object" - }, - "PointInTimeRecoverySpecification": { - "additionalProperties": false, - "properties": { - "PointInTimeRecoveryEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "Projection": { - "additionalProperties": false, - "properties": { - "NonKeyAttributes": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProjectionType": { - "type": "string" - } - }, - "type": "object" - }, - "ReadOnDemandThroughputSettings": { - "additionalProperties": false, - "properties": { - "MaxReadRequestUnits": { - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "ReadProvisionedThroughputSettings": { - "additionalProperties": false, - "properties": { - "ReadCapacityAutoScalingSettings": { - "$ref": "#/definitions/CapacityAutoScalingSettings" - }, - "ReadCapacityUnits": { - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "ReplicaGlobalSecondaryIndexSpecification": { - "additionalProperties": false, - "properties": { - "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification" - }, - "IndexName": { - "maxLength": 255, - "minLength": 3, - "type": "string" - }, - "ReadOnDemandThroughputSettings": { - "$ref": "#/definitions/ReadOnDemandThroughputSettings" - }, - "ReadProvisionedThroughputSettings": { - "$ref": "#/definitions/ReadProvisionedThroughputSettings" - } - }, - "required": [ - "IndexName" - ], - "type": "object" - }, - "ReplicaSSESpecification": { - "additionalProperties": false, - "properties": { - "KMSMasterKeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/AliasName", - "typeName": "AWS::KMS::Alias" - } - } - ], - "type": "string" - } - }, - "required": [ - "KMSMasterKeyId" - ], - "type": "object" - }, - "ReplicaSpecification": { - "additionalProperties": false, - "properties": { - "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification" - }, - "DeletionProtectionEnabled": { - "type": "boolean" - }, - "GlobalSecondaryIndexes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ReplicaGlobalSecondaryIndexSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "KinesisStreamSpecification": { - "$ref": "#/definitions/KinesisStreamSpecification" - }, - "PointInTimeRecoverySpecification": { - "$ref": "#/definitions/PointInTimeRecoverySpecification" - }, - "ReadOnDemandThroughputSettings": { - "$ref": "#/definitions/ReadOnDemandThroughputSettings" - }, - "ReadProvisionedThroughputSettings": { - "$ref": "#/definitions/ReadProvisionedThroughputSettings" - }, - "Region": { - "type": "string" - }, - "ReplicaStreamSpecification": { - "$ref": "#/definitions/ReplicaStreamSpecification" - }, - "ResourcePolicy": { - "$ref": "#/definitions/ResourcePolicy" - }, - "SSESpecification": { - "$ref": "#/definitions/ReplicaSSESpecification" - }, - "TableClass": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "ReplicaStreamSpecification": { - "additionalProperties": false, - "properties": { - "ResourcePolicy": { - "$ref": "#/definitions/ResourcePolicy" - } - }, - "required": [ - "ResourcePolicy" - ], - "type": "object" - }, - "ResourcePolicy": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - } - }, - "required": [ - "PolicyDocument" - ], - "type": "object" - }, - "SSESpecification": { - "additionalProperties": false, - "properties": { - "SSEEnabled": { - "type": "boolean" - }, - "SSEType": { - "type": "string" - } - }, - "required": [ - "SSEEnabled" - ], - "type": "object" - }, - "StreamSpecification": { - "additionalProperties": false, - "properties": { - "StreamViewType": { - "type": "string" - } - }, - "required": [ - "StreamViewType" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetTrackingScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "DisableScaleIn": { - "type": "boolean" - }, - "ScaleInCooldown": { - "minimum": 0, - "type": "integer" - }, - "ScaleOutCooldown": { - "minimum": 0, - "type": "integer" - }, - "TargetValue": { - "format": "double", - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "TimeToLiveSpecification": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "WriteOnDemandThroughputSettings": { - "additionalProperties": false, - "properties": { - "MaxWriteRequestUnits": { - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "WriteProvisionedThroughputSettings": { - "additionalProperties": false, - "properties": { - "WriteCapacityAutoScalingSettings": { - "$ref": "#/definitions/CapacityAutoScalingSettings" - } - }, - "type": "object" - } - }, - "description": "Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable", - "handlers": { - "create": { - "permissions": [ - "dynamodb:CreateTable", - "dynamodb:CreateTableReplica", - "dynamodb:Describe*", - "dynamodb:UpdateTimeToLive", - "dynamodb:UpdateContributorInsights", - "dynamodb:UpdateContinuousBackups", - "dynamodb:ListTagsOfResource", - "dynamodb:Query", - "dynamodb:Scan", - "dynamodb:UpdateItem", - "dynamodb:PutItem", - "dynamodb:GetItem", - "dynamodb:DeleteItem", - "dynamodb:BatchWriteItem", - "dynamodb:TagResource", - "dynamodb:EnableKinesisStreamingDestination", - "dynamodb:DisableKinesisStreamingDestination", - "dynamodb:UpdateTableReplicaAutoScaling", - "dynamodb:TagResource", - "dynamodb:GetResourcePolicy", - "dynamodb:PutResourcePolicy", - "application-autoscaling:DeleteScalingPolicy", - "application-autoscaling:DeleteScheduledAction", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:Describe*", - "application-autoscaling:PutScalingPolicy", - "application-autoscaling:PutScheduledAction", - "application-autoscaling:RegisterScalableTarget", - "kinesis:ListStreams", - "kinesis:DescribeStream", - "kinesis:PutRecords", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:Decrypt", - "kms:RevokeGrant", - "cloudwatch:PutMetricData", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "dynamodb:Describe*", - "dynamodb:DeleteTable", - "application-autoscaling:DeleteScalingPolicy", - "application-autoscaling:DeleteScheduledAction", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:Describe*", - "application-autoscaling:PutScalingPolicy", - "application-autoscaling:PutScheduledAction", - "application-autoscaling:RegisterScalableTarget" - ] - }, - "list": { - "permissions": [ - "dynamodb:ListTables", - "cloudwatch:PutMetricData" - ] - }, - "read": { - "permissions": [ - "dynamodb:Describe*", - "dynamodb:GetResourcePolicy", - "application-autoscaling:Describe*", - "cloudwatch:PutMetricData", - "dynamodb:ListTagsOfResource", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "dynamodb:Describe*", - "dynamodb:CreateTableReplica", - "dynamodb:UpdateTable", - "dynamodb:UpdateTimeToLive", - "dynamodb:UpdateContinuousBackups", - "dynamodb:UpdateContributorInsights", - "dynamodb:ListTagsOfResource", - "dynamodb:Query", - "dynamodb:Scan", - "dynamodb:UpdateItem", - "dynamodb:PutItem", - "dynamodb:GetItem", - "dynamodb:DeleteItem", - "dynamodb:BatchWriteItem", - "dynamodb:DeleteTable", - "dynamodb:DeleteTableReplica", - "dynamodb:UpdateItem", - "dynamodb:TagResource", - "dynamodb:UntagResource", - "dynamodb:EnableKinesisStreamingDestination", - "dynamodb:DisableKinesisStreamingDestination", - "dynamodb:UpdateTableReplicaAutoScaling", - "dynamodb:UpdateKinesisStreamingDestination", - "dynamodb:GetResourcePolicy", - "dynamodb:PutResourcePolicy", - "dynamodb:DeleteResourcePolicy", - "application-autoscaling:DeleteScalingPolicy", - "application-autoscaling:DeleteScheduledAction", - "application-autoscaling:DeregisterScalableTarget", - "application-autoscaling:Describe*", - "application-autoscaling:PutScalingPolicy", - "application-autoscaling:PutScheduledAction", - "application-autoscaling:RegisterScalableTarget", - "kinesis:ListStreams", - "kinesis:DescribeStream", - "kinesis:PutRecords", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:RevokeGrant", - "cloudwatch:PutMetricData" - ], - "timeoutInMinutes": 1200 - } - }, - "primaryIdentifier": [ - "/properties/TableName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AttributeDefinitions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttributeDefinition" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "BillingMode": { - "type": "string" - }, - "GlobalSecondaryIndexes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/GlobalSecondaryIndex" - }, - "type": "array", - "uniqueItems": true - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/KeySchema" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "LocalSecondaryIndexes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LocalSecondaryIndex" - }, - "type": "array", - "uniqueItems": true - }, - "Replicas": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ReplicaSpecification" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SSESpecification": { - "$ref": "#/definitions/SSESpecification" - }, - "StreamArn": { - "type": "string" - }, - "StreamSpecification": { - "$ref": "#/definitions/StreamSpecification" - }, - "TableId": { - "type": "string" - }, - "TableName": { - "type": "string" - }, - "TimeToLiveSpecification": { - "$ref": "#/definitions/TimeToLiveSpecification" - }, - "WriteOnDemandThroughputSettings": { - "$ref": "#/definitions/WriteOnDemandThroughputSettings" - }, - "WriteProvisionedThroughputSettings": { - "$ref": "#/definitions/WriteProvisionedThroughputSettings" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/StreamArn", - "/properties/TableId" - ], - "required": [ - "KeySchema", - "AttributeDefinitions", - "Replicas" - ], - "typeName": "AWS::DynamoDB::GlobalTable", - "writeOnlyProperties": [ - "/properties/Replicas/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity", - "/properties/Replicas/*/GlobalSecondaryIndexes/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity", - "/properties/WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity", - "/properties/GlobalSecondaryIndexes/*/WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ], + [ + "/properties/StreamArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocalSecondaryIndexes", + "/properties/TableName", + "/properties/KeySchema" + ], + "definitions": { + "AttributeDefinition": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "AttributeType": { + "type": "string" + } + }, + "required": [ + "AttributeName", + "AttributeType" + ], + "type": "object" + }, + "CapacityAutoScalingSettings": { + "additionalProperties": false, + "properties": { + "MaxCapacity": { + "minimum": 1, + "type": "integer" + }, + "MinCapacity": { + "minimum": 1, + "type": "integer" + }, + "SeedCapacity": { + "minimum": 1, + "type": "integer" + }, + "TargetTrackingScalingPolicyConfiguration": { + "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration" + } + }, + "required": [ + "MinCapacity", + "MaxCapacity", + "TargetTrackingScalingPolicyConfiguration" + ], + "type": "object" + }, + "ContributorInsightsSpecification": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "GlobalSecondaryIndex": { + "additionalProperties": false, + "properties": { + "IndexName": { + "maxLength": 255, + "minLength": 3, + "type": "string" + }, + "KeySchema": { + "items": { + "$ref": "#/definitions/KeySchema" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Projection": { + "$ref": "#/definitions/Projection" + }, + "WriteOnDemandThroughputSettings": { + "$ref": "#/definitions/WriteOnDemandThroughputSettings" + }, + "WriteProvisionedThroughputSettings": { + "$ref": "#/definitions/WriteProvisionedThroughputSettings" + } + }, + "required": [ + "IndexName", + "Projection", + "KeySchema" + ], + "type": "object" + }, + "KeySchema": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "KeyType": { + "type": "string" + } + }, + "required": [ + "KeyType", + "AttributeName" + ], + "type": "object" + }, + "KinesisStreamSpecification": { + "additionalProperties": false, + "properties": { + "ApproximateCreationDateTimePrecision": { + "enum": [ + "MICROSECOND", + "MILLISECOND" + ], + "type": "string" + }, + "StreamArn": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, + "type": "string" + } + }, + "required": [ + "StreamArn" + ], + "type": "object" + }, + "LocalSecondaryIndex": { + "additionalProperties": false, + "properties": { + "IndexName": { + "maxLength": 255, + "minLength": 3, + "type": "string" + }, + "KeySchema": { + "items": { + "$ref": "#/definitions/KeySchema" + }, + "maxItems": 2, + "type": "array", + "uniqueItems": true + }, + "Projection": { + "$ref": "#/definitions/Projection" + } + }, + "required": [ + "IndexName", + "Projection", + "KeySchema" + ], + "type": "object" + }, + "PointInTimeRecoverySpecification": { + "additionalProperties": false, + "properties": { + "PointInTimeRecoveryEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "Projection": { + "additionalProperties": false, + "properties": { + "NonKeyAttributes": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProjectionType": { + "type": "string" + } + }, + "type": "object" + }, + "ReadOnDemandThroughputSettings": { + "additionalProperties": false, + "properties": { + "MaxReadRequestUnits": { + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "ReadProvisionedThroughputSettings": { + "additionalProperties": false, + "properties": { + "ReadCapacityAutoScalingSettings": { + "$ref": "#/definitions/CapacityAutoScalingSettings" + }, + "ReadCapacityUnits": { + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "ReplicaGlobalSecondaryIndexSpecification": { + "additionalProperties": false, + "properties": { + "ContributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification" + }, + "IndexName": { + "maxLength": 255, + "minLength": 3, + "type": "string" + }, + "ReadOnDemandThroughputSettings": { + "$ref": "#/definitions/ReadOnDemandThroughputSettings" + }, + "ReadProvisionedThroughputSettings": { + "$ref": "#/definitions/ReadProvisionedThroughputSettings" + } + }, + "required": [ + "IndexName" + ], + "type": "object" + }, + "ReplicaSSESpecification": { + "additionalProperties": false, + "properties": { + "KMSMasterKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "type": "string" + } + }, + "required": [ + "KMSMasterKeyId" + ], + "type": "object" + }, + "ReplicaSpecification": { + "additionalProperties": false, + "properties": { + "ContributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification" + }, + "DeletionProtectionEnabled": { + "type": "boolean" + }, + "GlobalSecondaryIndexes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ReplicaGlobalSecondaryIndexSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "KinesisStreamSpecification": { + "$ref": "#/definitions/KinesisStreamSpecification" + }, + "PointInTimeRecoverySpecification": { + "$ref": "#/definitions/PointInTimeRecoverySpecification" + }, + "ReadOnDemandThroughputSettings": { + "$ref": "#/definitions/ReadOnDemandThroughputSettings" + }, + "ReadProvisionedThroughputSettings": { + "$ref": "#/definitions/ReadProvisionedThroughputSettings" + }, + "Region": { + "type": "string" + }, + "ReplicaStreamSpecification": { + "$ref": "#/definitions/ReplicaStreamSpecification" + }, + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy" + }, + "SSESpecification": { + "$ref": "#/definitions/ReplicaSSESpecification" + }, + "TableClass": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Region" + ], + "type": "object" + }, + "ReplicaStreamSpecification": { + "additionalProperties": false, + "properties": { + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy" + } + }, + "required": [ + "ResourcePolicy" + ], + "type": "object" + }, + "ResourcePolicy": { + "additionalProperties": false, + "properties": { + "PolicyDocument": { + "type": "object" + } + }, + "required": [ + "PolicyDocument" + ], + "type": "object" + }, + "SSESpecification": { + "additionalProperties": false, + "properties": { + "SSEEnabled": { + "type": "boolean" + }, + "SSEType": { + "type": "string" + } + }, + "required": [ + "SSEEnabled" + ], + "type": "object" + }, + "StreamSpecification": { + "additionalProperties": false, + "properties": { + "StreamViewType": { + "type": "string" + } + }, + "required": [ + "StreamViewType" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetTrackingScalingPolicyConfiguration": { + "additionalProperties": false, + "properties": { + "DisableScaleIn": { + "type": "boolean" + }, + "ScaleInCooldown": { + "minimum": 0, + "type": "integer" + }, + "ScaleOutCooldown": { + "minimum": 0, + "type": "integer" + }, + "TargetValue": { + "format": "double", + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + }, + "TimeToLiveSpecification": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "WriteOnDemandThroughputSettings": { + "additionalProperties": false, + "properties": { + "MaxWriteRequestUnits": { + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "WriteProvisionedThroughputSettings": { + "additionalProperties": false, + "properties": { + "WriteCapacityAutoScalingSettings": { + "$ref": "#/definitions/CapacityAutoScalingSettings" + } + }, + "type": "object" + } + }, + "description": "Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable", + "handlers": { + "create": { + "permissions": [ + "dynamodb:CreateTable", + "dynamodb:CreateTableReplica", + "dynamodb:Describe*", + "dynamodb:UpdateTimeToLive", + "dynamodb:UpdateContributorInsights", + "dynamodb:UpdateContinuousBackups", + "dynamodb:ListTagsOfResource", + "dynamodb:Query", + "dynamodb:Scan", + "dynamodb:UpdateItem", + "dynamodb:PutItem", + "dynamodb:GetItem", + "dynamodb:DeleteItem", + "dynamodb:BatchWriteItem", + "dynamodb:TagResource", + "dynamodb:EnableKinesisStreamingDestination", + "dynamodb:DisableKinesisStreamingDestination", + "dynamodb:UpdateTableReplicaAutoScaling", + "dynamodb:TagResource", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "application-autoscaling:DeleteScalingPolicy", + "application-autoscaling:DeleteScheduledAction", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:Describe*", + "application-autoscaling:PutScalingPolicy", + "application-autoscaling:PutScheduledAction", + "application-autoscaling:RegisterScalableTarget", + "kinesis:ListStreams", + "kinesis:DescribeStream", + "kinesis:PutRecords", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:Decrypt", + "kms:RevokeGrant", + "cloudwatch:PutMetricData", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "dynamodb:Describe*", + "dynamodb:DeleteTable", + "application-autoscaling:DeleteScalingPolicy", + "application-autoscaling:DeleteScheduledAction", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:Describe*", + "application-autoscaling:PutScalingPolicy", + "application-autoscaling:PutScheduledAction", + "application-autoscaling:RegisterScalableTarget" + ] + }, + "list": { + "permissions": [ + "dynamodb:ListTables", + "cloudwatch:PutMetricData" + ] + }, + "read": { + "permissions": [ + "dynamodb:Describe*", + "dynamodb:GetResourcePolicy", + "application-autoscaling:Describe*", + "cloudwatch:PutMetricData", + "dynamodb:ListTagsOfResource", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "dynamodb:Describe*", + "dynamodb:CreateTableReplica", + "dynamodb:UpdateTable", + "dynamodb:UpdateTimeToLive", + "dynamodb:UpdateContinuousBackups", + "dynamodb:UpdateContributorInsights", + "dynamodb:ListTagsOfResource", + "dynamodb:Query", + "dynamodb:Scan", + "dynamodb:UpdateItem", + "dynamodb:PutItem", + "dynamodb:GetItem", + "dynamodb:DeleteItem", + "dynamodb:BatchWriteItem", + "dynamodb:DeleteTable", + "dynamodb:DeleteTableReplica", + "dynamodb:UpdateItem", + "dynamodb:TagResource", + "dynamodb:UntagResource", + "dynamodb:EnableKinesisStreamingDestination", + "dynamodb:DisableKinesisStreamingDestination", + "dynamodb:UpdateTableReplicaAutoScaling", + "dynamodb:UpdateKinesisStreamingDestination", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "dynamodb:DeleteResourcePolicy", + "application-autoscaling:DeleteScalingPolicy", + "application-autoscaling:DeleteScheduledAction", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:Describe*", + "application-autoscaling:PutScalingPolicy", + "application-autoscaling:PutScheduledAction", + "application-autoscaling:RegisterScalableTarget", + "kinesis:ListStreams", + "kinesis:DescribeStream", + "kinesis:PutRecords", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:RevokeGrant", + "cloudwatch:PutMetricData" + ], + "timeoutInMinutes": 1200 + } + }, + "primaryIdentifier": [ + "/properties/TableName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AttributeDefinitions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttributeDefinition" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "BillingMode": { + "type": "string" + }, + "GlobalSecondaryIndexes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/GlobalSecondaryIndex" + }, + "type": "array", + "uniqueItems": true + }, + "KeySchema": { + "items": { + "$ref": "#/definitions/KeySchema" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "LocalSecondaryIndexes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LocalSecondaryIndex" + }, + "type": "array", + "uniqueItems": true + }, + "Replicas": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ReplicaSpecification" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SSESpecification": { + "$ref": "#/definitions/SSESpecification" + }, + "StreamArn": { + "type": "string" + }, + "StreamSpecification": { + "$ref": "#/definitions/StreamSpecification" + }, + "TableId": { + "type": "string" + }, + "TableName": { + "type": "string" + }, + "TimeToLiveSpecification": { + "$ref": "#/definitions/TimeToLiveSpecification" + }, + "WriteOnDemandThroughputSettings": { + "$ref": "#/definitions/WriteOnDemandThroughputSettings" + }, + "WriteProvisionedThroughputSettings": { + "$ref": "#/definitions/WriteProvisionedThroughputSettings" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/StreamArn", + "/properties/TableId" + ], + "required": [ + "KeySchema", + "AttributeDefinitions", + "Replicas" + ], + "typeName": "AWS::DynamoDB::GlobalTable", + "writeOnlyProperties": [ + "/properties/Replicas/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity", + "/properties/Replicas/*/GlobalSecondaryIndexes/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity", + "/properties/WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity", + "/properties/GlobalSecondaryIndexes/*/WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity" + ] +} diff --git a/schema/aws-dynamodb-table.json b/schema/aws-dynamodb-table.json index 2005cd3..b002083 100644 --- a/schema/aws-dynamodb-table.json +++ b/schema/aws-dynamodb-table.json @@ -1,678 +1,678 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TableName", - "/properties/ImportSourceSpecification" - ], - "definitions": { - "AttributeDefinition": { - "additionalProperties": false, - "description": "Represents an attribute for describing the schema for the table and indexes.", - "properties": { - "AttributeName": { - "description": "A name for the attribute.", - "type": "string" - }, - "AttributeType": { - "description": "The data type for the attribute, where:\n + ``S`` - the attribute is of type String\n + ``N`` - the attribute is of type Number\n + ``B`` - the attribute is of type Binary", - "type": "string" - } - }, - "required": [ - "AttributeName", - "AttributeType" - ], - "type": "object" - }, - "ContributorInsightsSpecification": { - "additionalProperties": false, - "description": "The settings used to enable or disable CloudWatch Contributor Insights.", - "properties": { - "Enabled": { - "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "Csv": { - "additionalProperties": false, - "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList.", - "properties": { - "Delimiter": { - "description": "The delimiter used for separating items in the CSV file being imported.", - "type": "string" - }, - "HeaderList": { - "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "DeprecatedHashKeyElement": { - "additionalProperties": false, - "description": "", - "properties": { - "AttributeName": { - "type": "string" - }, - "AttributeType": { - "type": "string" - } - }, - "required": [ - "AttributeType", - "AttributeName" - ], - "type": "object" - }, - "DeprecatedKeySchema": { - "additionalProperties": false, - "description": "", - "properties": { - "HashKeyElement": { - "$ref": "#/definitions/DeprecatedHashKeyElement" - } - }, - "required": [ - "HashKeyElement" - ], - "type": "object" - }, - "GlobalSecondaryIndex": { - "additionalProperties": false, - "description": "Represents the properties of a global secondary index.", - "properties": { - "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification", - "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index." - }, - "IndexName": { - "description": "The name of the global secondary index. The name must be unique among all other indexes on this table.", - "type": "string" - }, - "KeySchema": { - "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", - "items": { - "$ref": "#/definitions/KeySchema" - }, - "type": "array", - "uniqueItems": true - }, - "OnDemandThroughput": { - "$ref": "#/definitions/OnDemandThroughput", - "description": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." - }, - "Projection": { - "$ref": "#/definitions/Projection", - "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput", - "description": "Represents the provisioned throughput settings for the specified global secondary index.\n For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*." - } - }, - "required": [ - "IndexName", - "Projection", - "KeySchema" - ], - "type": "object" - }, - "ImportSourceSpecification": { - "additionalProperties": false, - "description": "Specifies the properties of data being imported from the S3 bucket source to the table.", - "properties": { - "InputCompressionType": { - "description": "Type of compression to be used on the input coming from the imported table.", - "type": "string" - }, - "InputFormat": { - "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``.", - "type": "string" - }, - "InputFormatOptions": { - "$ref": "#/definitions/InputFormatOptions", - "description": "Additional properties that specify how the input is formatted," - }, - "S3BucketSource": { - "$ref": "#/definitions/S3BucketSource", - "description": "The S3 bucket that provides the source for the import." - } - }, - "required": [ - "S3BucketSource", - "InputFormat" - ], - "type": "object" - }, - "InputFormatOptions": { - "additionalProperties": false, - "description": "The format options for the data that was imported into the target table. There is one value, CsvOption.", - "properties": { - "Csv": { - "$ref": "#/definitions/Csv", - "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList." - } - }, - "type": "object" - }, - "KeySchema": { - "additionalProperties": false, - "description": "Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.\n A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key.\n A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.", - "properties": { - "AttributeName": { - "description": "The name of a key attribute.", - "type": "string" - }, - "KeyType": { - "description": "The role that this key attribute will assume:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", - "type": "string" - } - }, - "required": [ - "KeyType", - "AttributeName" - ], - "type": "object" - }, - "KinesisStreamSpecification": { - "additionalProperties": false, - "description": "The Kinesis Data Streams configuration for the specified table.", - "properties": { - "ApproximateCreationDateTimePrecision": { - "description": "The precision for the time and date that the stream was created.", - "enum": [ - "MICROSECOND", - "MILLISECOND" - ], - "type": "string" - }, - "StreamArn": { - "description": "The ARN for a specific Kinesis data stream.\n Length Constraints: Minimum length of 37. Maximum length of 1024.", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Kinesis::Stream" - }, - "type": "string" - } - }, - "required": [ - "StreamArn" - ], - "type": "object" - }, - "LocalSecondaryIndex": { - "additionalProperties": false, - "description": "Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.", - "properties": { - "IndexName": { - "description": "The name of the local secondary index. The name must be unique among all other indexes on this table.", - "type": "string" - }, - "KeySchema": { - "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", - "items": { - "$ref": "#/definitions/KeySchema" - }, - "type": "array", - "uniqueItems": true - }, - "Projection": { - "$ref": "#/definitions/Projection", - "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." - } - }, - "required": [ - "IndexName", - "Projection", - "KeySchema" - ], - "type": "object" - }, - "OnDemandThroughput": { - "additionalProperties": false, - "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both.", - "properties": { - "MaxReadRequestUnits": { - "description": "Maximum number of read request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1.", - "minimum": 1, - "type": "integer" - }, - "MaxWriteRequestUnits": { - "description": "Maximum number of write request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1.", - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "PointInTimeRecoverySpecification": { - "additionalProperties": false, - "description": "The settings used to enable point in time recovery.", - "properties": { - "PointInTimeRecoveryEnabled": { - "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.", - "type": "boolean" - } - }, - "type": "object" - }, - "Projection": { - "additionalProperties": false, - "description": "Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.", - "properties": { - "NonKeyAttributes": { - "description": "Represents the non-key attribute names which will be projected into the index.\n For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ProjectionType": { - "description": "The set of attributes that are projected into the index:\n + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.\n + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.\n + ``ALL`` - All of the table attributes are projected into the index.\n \n When using the DynamoDB console, ``ALL`` is selected by default.", - "type": "string" - } - }, - "type": "object" - }, - "ProvisionedThroughput": { - "additionalProperties": false, - "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).", - "properties": { - "ReadCapacityUnits": { - "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", - "type": "integer" - }, - "WriteCapacityUnits": { - "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", - "type": "integer" - } - }, - "required": [ - "WriteCapacityUnits", - "ReadCapacityUnits" - ], - "type": "object" - }, - "ResourcePolicy": { - "additionalProperties": false, - "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n While defining resource-based policies in your CFNshort templates, the following considerations apply:\n + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. \n + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes.\n + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template.\n For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won\u2019t be synced with the policy in the template.\n Conversely, say that your template doesn\u2019t contain a resource-based policy, but you add a policy outside of the template. This policy won\u2019t be removed from DDB as long as you don\u2019t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template.\n \n For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).", - "properties": { - "PolicyDocument": { - "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).", - "type": "object" - } - }, - "required": [ - "PolicyDocument" - ], - "type": "object" - }, - "S3BucketSource": { - "additionalProperties": false, - "description": "The S3 bucket that is being imported from.", - "properties": { - "S3Bucket": { - "description": "The S3 bucket that is being imported from.", - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "S3BucketOwner": { - "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.", - "type": "string" - }, - "S3KeyPrefix": { - "description": "The key prefix shared by all S3 Objects that are being imported.", - "type": "string" - } - }, - "required": [ - "S3Bucket" - ], - "type": "object" - }, - "SSESpecification": { - "additionalProperties": false, - "description": "Represents the settings used to enable server-side encryption.", - "properties": { - "KMSMasterKeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/AliasName", - "typeName": "AWS::KMS::Alias" - } - } - ], - "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``.", - "type": "string" - }, - "SSEEnabled": { - "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.", - "type": "boolean" - }, - "SSEType": { - "description": "Server-side encryption type. The only supported value is:\n + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).", - "type": "string" - } - }, - "required": [ - "SSEEnabled" - ], - "type": "object" - }, - "StreamSpecification": { - "additionalProperties": false, - "description": "Represents the DynamoDB Streams configuration for a table in DynamoDB.", - "properties": { - "ResourcePolicy": { - "$ref": "#/definitions/ResourcePolicy", - "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." - }, - "StreamViewType": { - "description": "When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:\n + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.\n + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.\n + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.\n + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream.", - "type": "string" - } - }, - "required": [ - "StreamViewType" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. \n AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag.\n For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.", - "properties": { - "Key": { - "description": "The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.", - "type": "string" - }, - "Value": { - "description": "The value of the tag. Tag values are case-sensitive and can be null.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TimeToLiveSpecification": { - "additionalProperties": false, - "description": "Represents the settings used to enable or disable Time to Live (TTL) for the specified table.", - "properties": { - "AttributeName": { - "description": "The name of the TTL attribute used to store the expiration time for items in the table.\n + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.\n + To update this property, you must first disable TTL and then enable TTL with the new attribute name.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table.", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - } - }, - "description": "The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.\n You should be aware of the following behaviors when working with DDB tables:\n + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).\n \n Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.", - "handlers": { - "create": { - "permissions": [ - "dynamodb:CreateTable", - "dynamodb:DescribeImport", - "dynamodb:DescribeTable", - "dynamodb:DescribeTimeToLive", - "dynamodb:UpdateTimeToLive", - "dynamodb:UpdateContributorInsights", - "dynamodb:UpdateContinuousBackups", - "dynamodb:DescribeContinuousBackups", - "dynamodb:DescribeContributorInsights", - "dynamodb:EnableKinesisStreamingDestination", - "dynamodb:DisableKinesisStreamingDestination", - "dynamodb:DescribeKinesisStreamingDestination", - "dynamodb:ImportTable", - "dynamodb:ListTagsOfResource", - "dynamodb:TagResource", - "dynamodb:UpdateTable", - "dynamodb:GetResourcePolicy", - "dynamodb:PutResourcePolicy", - "kinesis:DescribeStream", - "kinesis:PutRecords", - "iam:CreateServiceLinkedRole", - "kms:CreateGrant", - "kms:Decrypt", - "kms:DescribeKey", - "kms:ListAliases", - "kms:Encrypt", - "kms:RevokeGrant", - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:DescribeLogGroups", - "logs:DescribeLogStreams", - "logs:PutLogEvents", - "logs:PutRetentionPolicy", - "s3:GetObject", - "s3:GetObjectMetadata", - "s3:ListBucket" - ], - "timeoutInMinutes": 720 - }, - "delete": { - "permissions": [ - "dynamodb:DeleteTable", - "dynamodb:DescribeTable" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "dynamodb:ListTables" - ] - }, - "read": { - "permissions": [ - "dynamodb:DescribeTable", - "dynamodb:DescribeContinuousBackups", - "dynamodb:DescribeContributorInsights", - "dynamodb:DescribeKinesisStreamingDestination", - "dynamodb:ListTagsOfResource", - "dynamodb:GetResourcePolicy" - ] - }, - "update": { - "permissions": [ - "dynamodb:UpdateTable", - "dynamodb:DescribeTable", - "dynamodb:DescribeTimeToLive", - "dynamodb:UpdateTimeToLive", - "dynamodb:UpdateContinuousBackups", - "dynamodb:UpdateContributorInsights", - "dynamodb:UpdateKinesisStreamingDestination", - "dynamodb:DescribeContinuousBackups", - "dynamodb:DescribeKinesisStreamingDestination", - "dynamodb:ListTagsOfResource", - "dynamodb:TagResource", - "dynamodb:UntagResource", - "dynamodb:DescribeContributorInsights", - "dynamodb:EnableKinesisStreamingDestination", - "dynamodb:DisableKinesisStreamingDestination", - "dynamodb:GetResourcePolicy", - "dynamodb:PutResourcePolicy", - "dynamodb:DeleteResourcePolicy", - "kinesis:DescribeStream", - "kinesis:PutRecords", - "iam:CreateServiceLinkedRole", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:ListAliases", - "kms:RevokeGrant" - ], - "timeoutInMinutes": 720 - } - }, - "primaryIdentifier": [ - "/properties/TableName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "AttributeDefinitions": { - "description": "A list of attributes that describe the key schema for the table and indexes.\n This property is required to create a DDB table.\n Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.", - "items": { - "$ref": "#/definitions/AttributeDefinition" - }, - "type": "array", - "uniqueItems": true - }, - "BillingMode": { - "description": "Specify how you are charged for read and write throughput and how you manage capacity.\n Valid values include:\n + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\n + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable 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).\n \n If not specified, the default is ``PROVISIONED``.", - "type": "string" - }, - "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification", - "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table." - }, - "DeletionProtectionEnabled": { - "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.", - "type": "boolean" - }, - "GlobalSecondaryIndexes": { - "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.\n If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.\n If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. \n Updates are not supported. The following are exceptions:\n + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.\n + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.", - "items": { - "$ref": "#/definitions/GlobalSecondaryIndex" - }, - "type": "array", - "uniqueItems": false - }, - "ImportSourceSpecification": { - "$ref": "#/definitions/ImportSourceSpecification", - "description": "Specifies the properties of data being imported from the S3 bucket source to the table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission." - }, - "KeySchema": { - "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.", - "oneOf": [ - { - "items": { - "$ref": "#/definitions/KeySchema" - }, - "type": "array", - "uniqueItems": true - }, - { - "type": "object" - } - ] - }, - "KinesisStreamSpecification": { - "$ref": "#/definitions/KinesisStreamSpecification", - "description": "The Kinesis Data Streams configuration for the specified table." - }, - "LocalSecondaryIndexes": { - "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.", - "items": { - "$ref": "#/definitions/LocalSecondaryIndex" - }, - "type": "array", - "uniqueItems": false - }, - "OnDemandThroughput": { - "$ref": "#/definitions/OnDemandThroughput", - "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." - }, - "PointInTimeRecoverySpecification": { - "$ref": "#/definitions/PointInTimeRecoverySpecification", - "description": "The settings used to enable point in time recovery." - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput", - "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). \n If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property." - }, - "ResourcePolicy": { - "$ref": "#/definitions/ResourcePolicy", - "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." - }, - "SSESpecification": { - "$ref": "#/definitions/SSESpecification", - "description": "Specifies the settings to enable server-side encryption." - }, - "StreamArn": { - "description": "", - "type": "string" - }, - "StreamSpecification": { - "$ref": "#/definitions/StreamSpecification", - "description": "The settings for the DDB table stream, which capture changes to items stored in the table." - }, - "TableClass": { - "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.", - "type": "string" - }, - "TableName": { - "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TimeToLiveSpecification": { - "$ref": "#/definitions/TimeToLiveSpecification", - "description": "Specifies the Time to Live (TTL) settings for the table.\n For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide." - } - }, - "propertyTransform": { - "/properties/SSESpecification/KMSMasterKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,3}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,4}[-]{1}[1-4]{1}:[0-9]{12}[:]{1}key\\/\", SSESpecification.KMSMasterKeyId]) $OR $join([\"arn:(aws)[-]{0,1}[a-z]{0,3}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,4}[-]{1}[1-4]{1}:[0-9]{12}[:]{1}key\\/\", KMSMasterKeyId])" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/StreamArn" - ], - "required": [ - "KeySchema" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::DynamoDB::Table", - "writeOnlyProperties": [ - "/properties/ImportSourceSpecification" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TableName", + "/properties/ImportSourceSpecification" + ], + "definitions": { + "AttributeDefinition": { + "additionalProperties": false, + "description": "Represents an attribute for describing the schema for the table and indexes.", + "properties": { + "AttributeName": { + "description": "A name for the attribute.", + "type": "string" + }, + "AttributeType": { + "description": "The data type for the attribute, where:\n + ``S`` - the attribute is of type String\n + ``N`` - the attribute is of type Number\n + ``B`` - the attribute is of type Binary", + "type": "string" + } + }, + "required": [ + "AttributeName", + "AttributeType" + ], + "type": "object" + }, + "ContributorInsightsSpecification": { + "additionalProperties": false, + "description": "The settings used to enable or disable CloudWatch Contributor Insights.", + "properties": { + "Enabled": { + "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "Csv": { + "additionalProperties": false, + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList.", + "properties": { + "Delimiter": { + "description": "The delimiter used for separating items in the CSV file being imported.", + "type": "string" + }, + "HeaderList": { + "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "DeprecatedHashKeyElement": { + "additionalProperties": false, + "description": "", + "properties": { + "AttributeName": { + "type": "string" + }, + "AttributeType": { + "type": "string" + } + }, + "required": [ + "AttributeType", + "AttributeName" + ], + "type": "object" + }, + "DeprecatedKeySchema": { + "additionalProperties": false, + "description": "", + "properties": { + "HashKeyElement": { + "$ref": "#/definitions/DeprecatedHashKeyElement" + } + }, + "required": [ + "HashKeyElement" + ], + "type": "object" + }, + "GlobalSecondaryIndex": { + "additionalProperties": false, + "description": "Represents the properties of a global secondary index.", + "properties": { + "ContributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index." + }, + "IndexName": { + "description": "The name of the global secondary index. The name must be unique among all other indexes on this table.", + "type": "string" + }, + "KeySchema": { + "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", + "items": { + "$ref": "#/definitions/KeySchema" + }, + "type": "array", + "uniqueItems": true + }, + "OnDemandThroughput": { + "$ref": "#/definitions/OnDemandThroughput", + "description": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, + "Projection": { + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + }, + "ProvisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Represents the provisioned throughput settings for the specified global secondary index.\n For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*." + } + }, + "required": [ + "IndexName", + "Projection", + "KeySchema" + ], + "type": "object" + }, + "ImportSourceSpecification": { + "additionalProperties": false, + "description": "Specifies the properties of data being imported from the S3 bucket source to the table.", + "properties": { + "InputCompressionType": { + "description": "Type of compression to be used on the input coming from the imported table.", + "type": "string" + }, + "InputFormat": { + "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``.", + "type": "string" + }, + "InputFormatOptions": { + "$ref": "#/definitions/InputFormatOptions", + "description": "Additional properties that specify how the input is formatted," + }, + "S3BucketSource": { + "$ref": "#/definitions/S3BucketSource", + "description": "The S3 bucket that provides the source for the import." + } + }, + "required": [ + "S3BucketSource", + "InputFormat" + ], + "type": "object" + }, + "InputFormatOptions": { + "additionalProperties": false, + "description": "The format options for the data that was imported into the target table. There is one value, CsvOption.", + "properties": { + "Csv": { + "$ref": "#/definitions/Csv", + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList." + } + }, + "type": "object" + }, + "KeySchema": { + "additionalProperties": false, + "description": "Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.\n A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key.\n A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.", + "properties": { + "AttributeName": { + "description": "The name of a key attribute.", + "type": "string" + }, + "KeyType": { + "description": "The role that this key attribute will assume:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", + "type": "string" + } + }, + "required": [ + "KeyType", + "AttributeName" + ], + "type": "object" + }, + "KinesisStreamSpecification": { + "additionalProperties": false, + "description": "The Kinesis Data Streams configuration for the specified table.", + "properties": { + "ApproximateCreationDateTimePrecision": { + "description": "The precision for the time and date that the stream was created.", + "enum": [ + "MICROSECOND", + "MILLISECOND" + ], + "type": "string" + }, + "StreamArn": { + "description": "The ARN for a specific Kinesis data stream.\n Length Constraints: Minimum length of 37. Maximum length of 1024.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, + "type": "string" + } + }, + "required": [ + "StreamArn" + ], + "type": "object" + }, + "LocalSecondaryIndex": { + "additionalProperties": false, + "description": "Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.", + "properties": { + "IndexName": { + "description": "The name of the local secondary index. The name must be unique among all other indexes on this table.", + "type": "string" + }, + "KeySchema": { + "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", + "items": { + "$ref": "#/definitions/KeySchema" + }, + "type": "array", + "uniqueItems": true + }, + "Projection": { + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + } + }, + "required": [ + "IndexName", + "Projection", + "KeySchema" + ], + "type": "object" + }, + "OnDemandThroughput": { + "additionalProperties": false, + "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both.", + "properties": { + "MaxReadRequestUnits": { + "description": "Maximum number of read request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1.", + "minimum": 1, + "type": "integer" + }, + "MaxWriteRequestUnits": { + "description": "Maximum number of write request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1.", + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "PointInTimeRecoverySpecification": { + "additionalProperties": false, + "description": "The settings used to enable point in time recovery.", + "properties": { + "PointInTimeRecoveryEnabled": { + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.", + "type": "boolean" + } + }, + "type": "object" + }, + "Projection": { + "additionalProperties": false, + "description": "Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.", + "properties": { + "NonKeyAttributes": { + "description": "Represents the non-key attribute names which will be projected into the index.\n For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ProjectionType": { + "description": "The set of attributes that are projected into the index:\n + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.\n + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.\n + ``ALL`` - All of the table attributes are projected into the index.\n \n When using the DynamoDB console, ``ALL`` is selected by default.", + "type": "string" + } + }, + "type": "object" + }, + "ProvisionedThroughput": { + "additionalProperties": false, + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).", + "properties": { + "ReadCapacityUnits": { + "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", + "type": "integer" + }, + "WriteCapacityUnits": { + "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", + "type": "integer" + } + }, + "required": [ + "WriteCapacityUnits", + "ReadCapacityUnits" + ], + "type": "object" + }, + "ResourcePolicy": { + "additionalProperties": false, + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n While defining resource-based policies in your CFNshort templates, the following considerations apply:\n + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. \n + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes.\n + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template.\n For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won\u2019t be synced with the policy in the template.\n Conversely, say that your template doesn\u2019t contain a resource-based policy, but you add a policy outside of the template. This policy won\u2019t be removed from DDB as long as you don\u2019t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template.\n \n For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).", + "properties": { + "PolicyDocument": { + "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).", + "type": "object" + } + }, + "required": [ + "PolicyDocument" + ], + "type": "object" + }, + "S3BucketSource": { + "additionalProperties": false, + "description": "The S3 bucket that is being imported from.", + "properties": { + "S3Bucket": { + "description": "The S3 bucket that is being imported from.", + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "S3BucketOwner": { + "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.", + "type": "string" + }, + "S3KeyPrefix": { + "description": "The key prefix shared by all S3 Objects that are being imported.", + "type": "string" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "SSESpecification": { + "additionalProperties": false, + "description": "Represents the settings used to enable server-side encryption.", + "properties": { + "KMSMasterKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``.", + "type": "string" + }, + "SSEEnabled": { + "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.", + "type": "boolean" + }, + "SSEType": { + "description": "Server-side encryption type. The only supported value is:\n + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).", + "type": "string" + } + }, + "required": [ + "SSEEnabled" + ], + "type": "object" + }, + "StreamSpecification": { + "additionalProperties": false, + "description": "Represents the DynamoDB Streams configuration for a table in DynamoDB.", + "properties": { + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." + }, + "StreamViewType": { + "description": "When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:\n + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.\n + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.\n + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.\n + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream.", + "type": "string" + } + }, + "required": [ + "StreamViewType" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. \n AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag.\n For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.", + "properties": { + "Key": { + "description": "The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.", + "type": "string" + }, + "Value": { + "description": "The value of the tag. Tag values are case-sensitive and can be null.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TimeToLiveSpecification": { + "additionalProperties": false, + "description": "Represents the settings used to enable or disable Time to Live (TTL) for the specified table.", + "properties": { + "AttributeName": { + "description": "The name of the TTL attribute used to store the expiration time for items in the table.\n + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.\n + To update this property, you must first disable TTL and then enable TTL with the new attribute name.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table.", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + }, + "description": "The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.\n You should be aware of the following behaviors when working with DDB tables:\n + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).\n \n Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.", + "handlers": { + "create": { + "permissions": [ + "dynamodb:CreateTable", + "dynamodb:DescribeImport", + "dynamodb:DescribeTable", + "dynamodb:DescribeTimeToLive", + "dynamodb:UpdateTimeToLive", + "dynamodb:UpdateContributorInsights", + "dynamodb:UpdateContinuousBackups", + "dynamodb:DescribeContinuousBackups", + "dynamodb:DescribeContributorInsights", + "dynamodb:EnableKinesisStreamingDestination", + "dynamodb:DisableKinesisStreamingDestination", + "dynamodb:DescribeKinesisStreamingDestination", + "dynamodb:ImportTable", + "dynamodb:ListTagsOfResource", + "dynamodb:TagResource", + "dynamodb:UpdateTable", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "kinesis:DescribeStream", + "kinesis:PutRecords", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:Decrypt", + "kms:DescribeKey", + "kms:ListAliases", + "kms:Encrypt", + "kms:RevokeGrant", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:PutLogEvents", + "logs:PutRetentionPolicy", + "s3:GetObject", + "s3:GetObjectMetadata", + "s3:ListBucket" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "dynamodb:DeleteTable", + "dynamodb:DescribeTable" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "dynamodb:ListTables" + ] + }, + "read": { + "permissions": [ + "dynamodb:DescribeTable", + "dynamodb:DescribeContinuousBackups", + "dynamodb:DescribeContributorInsights", + "dynamodb:DescribeKinesisStreamingDestination", + "dynamodb:ListTagsOfResource", + "dynamodb:GetResourcePolicy" + ] + }, + "update": { + "permissions": [ + "dynamodb:UpdateTable", + "dynamodb:DescribeTable", + "dynamodb:DescribeTimeToLive", + "dynamodb:UpdateTimeToLive", + "dynamodb:UpdateContinuousBackups", + "dynamodb:UpdateContributorInsights", + "dynamodb:UpdateKinesisStreamingDestination", + "dynamodb:DescribeContinuousBackups", + "dynamodb:DescribeKinesisStreamingDestination", + "dynamodb:ListTagsOfResource", + "dynamodb:TagResource", + "dynamodb:UntagResource", + "dynamodb:DescribeContributorInsights", + "dynamodb:EnableKinesisStreamingDestination", + "dynamodb:DisableKinesisStreamingDestination", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "dynamodb:DeleteResourcePolicy", + "kinesis:DescribeStream", + "kinesis:PutRecords", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:ListAliases", + "kms:RevokeGrant" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/TableName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "AttributeDefinitions": { + "description": "A list of attributes that describe the key schema for the table and indexes.\n This property is required to create a DDB table.\n Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.", + "items": { + "$ref": "#/definitions/AttributeDefinition" + }, + "type": "array", + "uniqueItems": true + }, + "BillingMode": { + "description": "Specify how you are charged for read and write throughput and how you manage capacity.\n Valid values include:\n + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\n + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable 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).\n \n If not specified, the default is ``PROVISIONED``.", + "type": "string" + }, + "ContributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table." + }, + "DeletionProtectionEnabled": { + "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.", + "type": "boolean" + }, + "GlobalSecondaryIndexes": { + "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.\n If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.\n If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. \n Updates are not supported. The following are exceptions:\n + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.\n + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.", + "items": { + "$ref": "#/definitions/GlobalSecondaryIndex" + }, + "type": "array", + "uniqueItems": false + }, + "ImportSourceSpecification": { + "$ref": "#/definitions/ImportSourceSpecification", + "description": "Specifies the properties of data being imported from the S3 bucket source to the table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission." + }, + "KeySchema": { + "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.", + "oneOf": [ + { + "items": { + "$ref": "#/definitions/KeySchema" + }, + "type": "array", + "uniqueItems": true + }, + { + "type": "object" + } + ] + }, + "KinesisStreamSpecification": { + "$ref": "#/definitions/KinesisStreamSpecification", + "description": "The Kinesis Data Streams configuration for the specified table." + }, + "LocalSecondaryIndexes": { + "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.", + "items": { + "$ref": "#/definitions/LocalSecondaryIndex" + }, + "type": "array", + "uniqueItems": false + }, + "OnDemandThroughput": { + "$ref": "#/definitions/OnDemandThroughput", + "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, + "PointInTimeRecoverySpecification": { + "$ref": "#/definitions/PointInTimeRecoverySpecification", + "description": "The settings used to enable point in time recovery." + }, + "ProvisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). \n If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property." + }, + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." + }, + "SSESpecification": { + "$ref": "#/definitions/SSESpecification", + "description": "Specifies the settings to enable server-side encryption." + }, + "StreamArn": { + "description": "", + "type": "string" + }, + "StreamSpecification": { + "$ref": "#/definitions/StreamSpecification", + "description": "The settings for the DDB table stream, which capture changes to items stored in the table." + }, + "TableClass": { + "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.", + "type": "string" + }, + "TableName": { + "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TimeToLiveSpecification": { + "$ref": "#/definitions/TimeToLiveSpecification", + "description": "Specifies the Time to Live (TTL) settings for the table.\n For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide." + } + }, + "propertyTransform": { + "/properties/SSESpecification/KMSMasterKeyId": "$join([\"arn:aws(-[a-z]{1,4}){0,2}:kms:[a-z]{2,4}(-[a-z]{1,4})?-[a-z]{1,10}-[0-9]:[0-9]{12}:key\\/\", SSESpecification.KMSMasterKeyId]) $OR $join([\"arn:aws(-[a-z]{1,4}){0,2}:kms:[a-z]{2,4}(-[a-z]{1,4})?-[a-z]{1,10}-[0-9]:[0-9]{12}:key\\/\", KMSMasterKeyId])" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/StreamArn" + ], + "required": [ + "KeySchema" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DynamoDB::Table", + "writeOnlyProperties": [ + "/properties/ImportSourceSpecification" + ] +} diff --git a/schema/aws-ec2-capacityreservation.json b/schema/aws-ec2-capacityreservation.json index 9015cf9..4abb11d 100644 --- a/schema/aws-ec2-capacityreservation.json +++ b/schema/aws-ec2-capacityreservation.json @@ -1,159 +1,158 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tenancy", - "/properties/InstanceMatchCriteria", - "/properties/InstancePlatform", - "/properties/InstanceType", - "/properties/AvailabilityZone", - "/properties/TagSpecifications", - "/properties/OutPostArn", - "/properties/EphemeralStorage", - "/properties/EbsOptimized", - "/properties/PlacementGroupArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::CapacityReservation", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:CreateCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeCapacityReservations" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeCapacityReservations" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyCapacityReservation", - "ec2:CreateCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "AvailableInstanceCount": { - "type": "integer" - }, - "EbsOptimized": { - "type": "boolean" - }, - "EndDate": { - "type": "string" - }, - "EndDateType": { - "type": "string" - }, - "EphemeralStorage": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "InstanceCount": { - "type": "integer" - }, - "InstanceMatchCriteria": { - "type": "string" - }, - "InstancePlatform": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "OutPostArn": { - "type": "string" - }, - "PlacementGroupArn": { - "type": "string" - }, - "TagSpecifications": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "Tenancy": { - "type": "string" - }, - "TotalInstanceCount": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/AvailableInstanceCount", - "/properties/TotalInstanceCount" - ], - "required": [ - "InstanceCount", - "AvailabilityZone", - "InstancePlatform", - "InstanceType" - ], - "typeName": "AWS::EC2::CapacityReservation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tenancy", + "/properties/InstancePlatform", + "/properties/InstanceType", + "/properties/AvailabilityZone", + "/properties/TagSpecifications", + "/properties/OutPostArn", + "/properties/EphemeralStorage", + "/properties/EbsOptimized", + "/properties/PlacementGroupArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagSpecification": { + "additionalProperties": false, + "properties": { + "ResourceType": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::CapacityReservation", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:CreateCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeCapacityReservations" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeCapacityReservations" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyCapacityReservation", + "ec2:CreateCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "AvailableInstanceCount": { + "type": "integer" + }, + "EbsOptimized": { + "type": "boolean" + }, + "EndDate": { + "type": "string" + }, + "EndDateType": { + "type": "string" + }, + "EphemeralStorage": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceMatchCriteria": { + "type": "string" + }, + "InstancePlatform": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "OutPostArn": { + "type": "string" + }, + "PlacementGroupArn": { + "type": "string" + }, + "TagSpecifications": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "Tenancy": { + "type": "string" + }, + "TotalInstanceCount": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/AvailableInstanceCount", + "/properties/TotalInstanceCount" + ], + "required": [ + "InstanceCount", + "AvailabilityZone", + "InstancePlatform", + "InstanceType" + ], + "typeName": "AWS::EC2::CapacityReservation" +} diff --git a/schema/aws-ec2-capacityreservationfleet.json b/schema/aws-ec2-capacityreservationfleet.json index 1645430..3cd3c9a 100644 --- a/schema/aws-ec2-capacityreservationfleet.json +++ b/schema/aws-ec2-capacityreservationfleet.json @@ -1,191 +1,191 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceTypeSpecifications", - "/properties/AllocationStrategy", - "/properties/TagSpecifications", - "/properties/EndDate", - "/properties/Tenancy", - "/properties/InstanceMatchCriteria" - ], - "definitions": { - "InstanceTypeSpecification": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "AvailabilityZoneId": { - "type": "string" - }, - "EbsOptimized": { - "type": "boolean" - }, - "InstancePlatform": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Priority": { - "maximum": 999, - "minimum": 0, - "type": "integer" - }, - "Weight": { - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::CapacityReservationFleet", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateCapacityReservationFleet", - "ec2:ModifyCapacityReservationFleet", - "ec2:DescribeCapacityReservationFleets", - "ec2:CancelCapacityReservationFleets", - "ec2:CreateCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:DescribeInstances", - "ec2:CreateTags", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "ec2:CreateCapacityReservationFleet", - "ec2:ModifyCapacityReservationFleet", - "ec2:DescribeCapacityReservationFleets", - "ec2:CancelCapacityReservationFleets", - "ec2:CreateCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeCapacityReservationFleets", - "ec2:DescribeCapacityReservations", - "ec2:DescribeInstances" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeCapacityReservationFleets", - "ec2:DescribeInstances", - "ec2:DescribeCapacityReservations" - ] - }, - "update": { - "permissions": [ - "ec2:CreateCapacityReservationFleet", - "ec2:ModifyCapacityReservationFleet", - "ec2:DescribeCapacityReservationFleets", - "ec2:CancelCapacityReservationFleets", - "ec2:CreateCapacityReservation", - "ec2:ModifyCapacityReservation", - "ec2:DescribeCapacityReservations", - "ec2:CancelCapacityReservation", - "ec2:DescribeInstances", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/CapacityReservationFleetId" - ], - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "CapacityReservationFleetId": { - "type": "string" - }, - "EndDate": { - "type": "string" - }, - "InstanceMatchCriteria": { - "enum": [ - "open" - ], - "type": "string" - }, - "InstanceTypeSpecifications": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceTypeSpecification" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "NoRemoveEndDate": { - "type": "boolean" - }, - "RemoveEndDate": { - "type": "boolean" - }, - "TagSpecifications": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "Tenancy": { - "enum": [ - "default" - ], - "type": "string" - }, - "TotalTargetCapacity": { - "maximum": 25000, - "minimum": 1, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/CapacityReservationFleetId" - ], - "taggable": true, - "typeName": "AWS::EC2::CapacityReservationFleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceTypeSpecifications", + "/properties/AllocationStrategy", + "/properties/TagSpecifications", + "/properties/EndDate", + "/properties/Tenancy", + "/properties/InstanceMatchCriteria" + ], + "definitions": { + "InstanceTypeSpecification": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "AvailabilityZoneId": { + "type": "string" + }, + "EbsOptimized": { + "type": "boolean" + }, + "InstancePlatform": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Priority": { + "maximum": 999, + "minimum": 0, + "type": "integer" + }, + "Weight": { + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagSpecification": { + "additionalProperties": false, + "properties": { + "ResourceType": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::CapacityReservationFleet", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateCapacityReservationFleet", + "ec2:ModifyCapacityReservationFleet", + "ec2:DescribeCapacityReservationFleets", + "ec2:CancelCapacityReservationFleets", + "ec2:CreateCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:DescribeInstances", + "ec2:CreateTags", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ec2:CreateCapacityReservationFleet", + "ec2:ModifyCapacityReservationFleet", + "ec2:DescribeCapacityReservationFleets", + "ec2:CancelCapacityReservationFleets", + "ec2:CreateCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeCapacityReservationFleets", + "ec2:DescribeCapacityReservations", + "ec2:DescribeInstances" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeCapacityReservationFleets", + "ec2:DescribeInstances", + "ec2:DescribeCapacityReservations" + ] + }, + "update": { + "permissions": [ + "ec2:CreateCapacityReservationFleet", + "ec2:ModifyCapacityReservationFleet", + "ec2:DescribeCapacityReservationFleets", + "ec2:CancelCapacityReservationFleets", + "ec2:CreateCapacityReservation", + "ec2:ModifyCapacityReservation", + "ec2:DescribeCapacityReservations", + "ec2:CancelCapacityReservation", + "ec2:DescribeInstances", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/CapacityReservationFleetId" + ], + "properties": { + "AllocationStrategy": { + "type": "string" + }, + "CapacityReservationFleetId": { + "type": "string" + }, + "EndDate": { + "type": "string" + }, + "InstanceMatchCriteria": { + "enum": [ + "open" + ], + "type": "string" + }, + "InstanceTypeSpecifications": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceTypeSpecification" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "NoRemoveEndDate": { + "type": "boolean" + }, + "RemoveEndDate": { + "type": "boolean" + }, + "TagSpecifications": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "Tenancy": { + "enum": [ + "default" + ], + "type": "string" + }, + "TotalTargetCapacity": { + "maximum": 25000, + "minimum": 1, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/CapacityReservationFleetId" + ], + "taggable": true, + "typeName": "AWS::EC2::CapacityReservationFleet" +} diff --git a/schema/aws-ec2-carriergateway.json b/schema/aws-ec2-carriergateway.json index 7395b3c..c0d0cf4 100644 --- a/schema/aws-ec2-carriergateway.json +++ b/schema/aws-ec2-carriergateway.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateCarrierGateway", - "ec2:DescribeCarrierGateways", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteCarrierGateway", - "ec2:DescribeCarrierGateways" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeCarrierGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeCarrierGateways" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeCarrierGateways", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/CarrierGatewayId" - ], - "properties": { - "CarrierGatewayId": { - "description": "The ID of the carrier gateway.", - "type": "string" - }, - "OwnerId": { - "description": "The ID of the owner.", - "type": "string" - }, - "State": { - "description": "The state of the carrier gateway.", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "The tags for the carrier gateway." - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CarrierGatewayId", - "/properties/OwnerId", - "/properties/State" - ], - "required": [ - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::EC2::CarrierGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateCarrierGateway", + "ec2:DescribeCarrierGateways", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteCarrierGateway", + "ec2:DescribeCarrierGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeCarrierGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeCarrierGateways" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeCarrierGateways", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/CarrierGatewayId" + ], + "properties": { + "CarrierGatewayId": { + "description": "The ID of the carrier gateway.", + "type": "string" + }, + "OwnerId": { + "description": "The ID of the owner.", + "type": "string" + }, + "State": { + "description": "The state of the carrier gateway.", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "The tags for the carrier gateway." + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CarrierGatewayId", + "/properties/OwnerId", + "/properties/State" + ], + "required": [ + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::EC2::CarrierGateway" +} diff --git a/schema/aws-ec2-clientvpnauthorizationrule.json b/schema/aws-ec2-clientvpnauthorizationrule.json index e7cf898..821db5b 100644 --- a/schema/aws-ec2-clientvpnauthorizationrule.json +++ b/schema/aws-ec2-clientvpnauthorizationrule.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClientVpnEndpointId", - "/properties/AuthorizeAllGroups", - "/properties/Description", - "/properties/AccessGroupId", - "/properties/TargetNetworkCidr" - ], - "description": "Resource Type definition for AWS::EC2::ClientVpnAuthorizationRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessGroupId": { - "type": "string" - }, - "AuthorizeAllGroups": { - "type": "boolean" - }, - "ClientVpnEndpointId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "TargetNetworkCidr": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ClientVpnEndpointId", - "TargetNetworkCidr" - ], - "typeName": "AWS::EC2::ClientVpnAuthorizationRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientVpnEndpointId", + "/properties/AuthorizeAllGroups", + "/properties/Description", + "/properties/AccessGroupId", + "/properties/TargetNetworkCidr" + ], + "description": "Resource Type definition for AWS::EC2::ClientVpnAuthorizationRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessGroupId": { + "type": "string" + }, + "AuthorizeAllGroups": { + "type": "boolean" + }, + "ClientVpnEndpointId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "TargetNetworkCidr": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "typeName": "AWS::EC2::ClientVpnAuthorizationRule" +} diff --git a/schema/aws-ec2-clientvpnendpoint.json b/schema/aws-ec2-clientvpnendpoint.json index ea8178c..5c70150 100644 --- a/schema/aws-ec2-clientvpnendpoint.json +++ b/schema/aws-ec2-clientvpnendpoint.json @@ -1,238 +1,238 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransportProtocol", - "/properties/ClientCidrBlock", - "/properties/TagSpecifications", - "/properties/AuthenticationOptions" - ], - "definitions": { - "CertificateAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "ClientRootCertificateChainArn": { - "type": "string" - } - }, - "required": [ - "ClientRootCertificateChainArn" - ], - "type": "object" - }, - "ClientAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "ActiveDirectory": { - "$ref": "#/definitions/DirectoryServiceAuthenticationRequest" - }, - "FederatedAuthentication": { - "$ref": "#/definitions/FederatedAuthenticationRequest" - }, - "MutualAuthentication": { - "$ref": "#/definitions/CertificateAuthenticationRequest" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ClientConnectOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LambdaFunctionArn": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ClientLoginBannerOptions": { - "additionalProperties": false, - "properties": { - "BannerText": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ConnectionLogOptions": { - "additionalProperties": false, - "properties": { - "CloudwatchLogGroup": { - "type": "string" - }, - "CloudwatchLogStream": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "DirectoryServiceAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "DirectoryId": { - "type": "string" - } - }, - "required": [ - "DirectoryId" - ], - "type": "object" - }, - "FederatedAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "SAMLProviderArn": { - "type": "string" - }, - "SelfServiceSAMLProviderArn": { - "type": "string" - } - }, - "required": [ - "SAMLProviderArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ResourceType", - "Tags" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::ClientVpnEndpoint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AuthenticationOptions": { - "items": { - "$ref": "#/definitions/ClientAuthenticationRequest" - }, - "type": "array", - "uniqueItems": false - }, - "ClientCidrBlock": { - "type": "string" - }, - "ClientConnectOptions": { - "$ref": "#/definitions/ClientConnectOptions" - }, - "ClientLoginBannerOptions": { - "$ref": "#/definitions/ClientLoginBannerOptions" - }, - "ConnectionLogOptions": { - "$ref": "#/definitions/ConnectionLogOptions" - }, - "Description": { - "type": "string" - }, - "DnsServers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SelfServicePortal": { - "type": "string" - }, - "ServerCertificateArn": { - "type": "string" - }, - "SessionTimeoutHours": { - "type": "integer" - }, - "SplitTunnel": { - "type": "boolean" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/TagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "TransportProtocol": { - "type": "string" - }, - "VpcId": { - "type": "string" - }, - "VpnPort": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ClientCidrBlock", - "ConnectionLogOptions", - "AuthenticationOptions", - "ServerCertificateArn" - ], - "typeName": "AWS::EC2::ClientVpnEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransportProtocol", + "/properties/ClientCidrBlock", + "/properties/TagSpecifications", + "/properties/AuthenticationOptions" + ], + "definitions": { + "CertificateAuthenticationRequest": { + "additionalProperties": false, + "properties": { + "ClientRootCertificateChainArn": { + "type": "string" + } + }, + "required": [ + "ClientRootCertificateChainArn" + ], + "type": "object" + }, + "ClientAuthenticationRequest": { + "additionalProperties": false, + "properties": { + "ActiveDirectory": { + "$ref": "#/definitions/DirectoryServiceAuthenticationRequest" + }, + "FederatedAuthentication": { + "$ref": "#/definitions/FederatedAuthenticationRequest" + }, + "MutualAuthentication": { + "$ref": "#/definitions/CertificateAuthenticationRequest" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ClientConnectOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "LambdaFunctionArn": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ClientLoginBannerOptions": { + "additionalProperties": false, + "properties": { + "BannerText": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ConnectionLogOptions": { + "additionalProperties": false, + "properties": { + "CloudwatchLogGroup": { + "type": "string" + }, + "CloudwatchLogStream": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "DirectoryServiceAuthenticationRequest": { + "additionalProperties": false, + "properties": { + "DirectoryId": { + "type": "string" + } + }, + "required": [ + "DirectoryId" + ], + "type": "object" + }, + "FederatedAuthenticationRequest": { + "additionalProperties": false, + "properties": { + "SAMLProviderArn": { + "type": "string" + }, + "SelfServiceSAMLProviderArn": { + "type": "string" + } + }, + "required": [ + "SAMLProviderArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagSpecification": { + "additionalProperties": false, + "properties": { + "ResourceType": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ResourceType", + "Tags" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::ClientVpnEndpoint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AuthenticationOptions": { + "items": { + "$ref": "#/definitions/ClientAuthenticationRequest" + }, + "type": "array", + "uniqueItems": false + }, + "ClientCidrBlock": { + "type": "string" + }, + "ClientConnectOptions": { + "$ref": "#/definitions/ClientConnectOptions" + }, + "ClientLoginBannerOptions": { + "$ref": "#/definitions/ClientLoginBannerOptions" + }, + "ConnectionLogOptions": { + "$ref": "#/definitions/ConnectionLogOptions" + }, + "Description": { + "type": "string" + }, + "DnsServers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SelfServicePortal": { + "type": "string" + }, + "ServerCertificateArn": { + "type": "string" + }, + "SessionTimeoutHours": { + "type": "integer" + }, + "SplitTunnel": { + "type": "boolean" + }, + "TagSpecifications": { + "items": { + "$ref": "#/definitions/TagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "TransportProtocol": { + "type": "string" + }, + "VpcId": { + "type": "string" + }, + "VpnPort": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ClientCidrBlock", + "ConnectionLogOptions", + "AuthenticationOptions", + "ServerCertificateArn" + ], + "typeName": "AWS::EC2::ClientVpnEndpoint" +} diff --git a/schema/aws-ec2-clientvpnroute.json b/schema/aws-ec2-clientvpnroute.json index 5d563c3..dada7bc 100644 --- a/schema/aws-ec2-clientvpnroute.json +++ b/schema/aws-ec2-clientvpnroute.json @@ -1,39 +1,39 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClientVpnEndpointId", - "/properties/DestinationCidrBlock", - "/properties/Description", - "/properties/TargetVpcSubnetId" - ], - "description": "Resource Type definition for AWS::EC2::ClientVpnRoute", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ClientVpnEndpointId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "TargetVpcSubnetId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ClientVpnEndpointId", - "TargetVpcSubnetId", - "DestinationCidrBlock" - ], - "typeName": "AWS::EC2::ClientVpnRoute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientVpnEndpointId", + "/properties/DestinationCidrBlock", + "/properties/Description", + "/properties/TargetVpcSubnetId" + ], + "description": "Resource Type definition for AWS::EC2::ClientVpnRoute", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ClientVpnEndpointId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "TargetVpcSubnetId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ClientVpnEndpointId", + "TargetVpcSubnetId", + "DestinationCidrBlock" + ], + "typeName": "AWS::EC2::ClientVpnRoute" +} diff --git a/schema/aws-ec2-clientvpntargetnetworkassociation.json b/schema/aws-ec2-clientvpntargetnetworkassociation.json index bf5c806..b1f10b9 100644 --- a/schema/aws-ec2-clientvpntargetnetworkassociation.json +++ b/schema/aws-ec2-clientvpntargetnetworkassociation.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClientVpnEndpointId", - "/properties/SubnetId" - ], - "description": "Resource Type definition for AWS::EC2::ClientVpnTargetNetworkAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ClientVpnEndpointId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ClientVpnEndpointId", - "SubnetId" - ], - "typeName": "AWS::EC2::ClientVpnTargetNetworkAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientVpnEndpointId", + "/properties/SubnetId" + ], + "description": "Resource Type definition for AWS::EC2::ClientVpnTargetNetworkAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ClientVpnEndpointId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SubnetId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ClientVpnEndpointId", + "SubnetId" + ], + "typeName": "AWS::EC2::ClientVpnTargetNetworkAssociation" +} diff --git a/schema/aws-ec2-customergateway.json b/schema/aws-ec2-customergateway.json index e700ec3..2694ee4 100644 --- a/schema/aws-ec2-customergateway.json +++ b/schema/aws-ec2-customergateway.json @@ -1,128 +1,131 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateArn", - "/properties/BgpAsn", - "/properties/BgpAsnExtended", - "/properties/Type", - "/properties/IpAddress", - "/properties/DeviceName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a customer gateway.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateCustomerGateway", - "ec2:DescribeCustomerGateways", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteCustomerGateway", - "ec2:DescribeCustomerGateways", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeCustomerGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeCustomerGateways" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeCustomerGateways" - ] - } - }, - "primaryIdentifier": [ - "/properties/CustomerGatewayId" - ], - "properties": { - "BgpAsn": { - "default": 65000, - "description": "For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.\n Default: 65000\n Valid values: ``1`` to ``2,147,483,647``", - "type": "integer" - }, - "BgpAsnExtended": { - "description": "For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.\n Valid values: ``2,147,483,648`` to ``4,294,967,295``", - "maximum": 4294967294, - "minimum": 2147483648, - "multipleOf": 1, - "type": "number" - }, - "CertificateArn": { - "description": "The Amazon Resource Name (ARN) for the customer gateway certificate.", - "pattern": "^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[a-zA-Z0-9-_]+$", - "type": "string" - }, - "CustomerGatewayId": { - "description": "", - "type": "string" - }, - "DeviceName": { - "description": "The name of customer gateway device.", - "type": "string" - }, - "IpAddress": { - "description": "IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address.", - "type": "string" - }, - "Tags": { - "description": "One or more tags for the customer gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of VPN connection that this customer gateway supports (``ipsec.1``).", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CustomerGatewayId" - ], - "required": [ - "IpAddress", - "Type" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::CustomerGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateArn", + "/properties/BgpAsn", + "/properties/BgpAsnExtended", + "/properties/Type", + "/properties/IpAddress", + "/properties/DeviceName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a customer gateway.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateCustomerGateway", + "ec2:DescribeCustomerGateways", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteCustomerGateway", + "ec2:DescribeCustomerGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeCustomerGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeCustomerGateways" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeCustomerGateways" + ] + } + }, + "primaryIdentifier": [ + "/properties/CustomerGatewayId" + ], + "properties": { + "BgpAsn": { + "default": 65000, + "description": "For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.\n Default: 65000\n Valid values: ``1`` to ``2,147,483,647``", + "type": "integer" + }, + "BgpAsnExtended": { + "description": "For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.\n Valid values: ``2,147,483,648`` to ``4,294,967,295``", + "maximum": 4294967294, + "minimum": 2147483648, + "multipleOf": 1, + "type": "number" + }, + "CertificateArn": { + "description": "The Amazon Resource Name (ARN) for the customer gateway certificate.", + "pattern": "^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[a-zA-Z0-9-_]+$", + "type": "string" + }, + "CustomerGatewayId": { + "description": "", + "type": "string" + }, + "DeviceName": { + "description": "The name of customer gateway device.", + "type": "string" + }, + "IpAddress": { + "description": "IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address.", + "type": "string" + }, + "Tags": { + "description": "One or more tags for the customer gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of VPN connection that this customer gateway supports (``ipsec.1``).", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CustomerGatewayId" + ], + "required": [ + "IpAddress", + "Type" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::CustomerGateway" +} diff --git a/schema/aws-ec2-dhcpoptions.json b/schema/aws-ec2-dhcpoptions.json index 04c7d64..8bd6bf1 100644 --- a/schema/aws-ec2-dhcpoptions.json +++ b/schema/aws-ec2-dhcpoptions.json @@ -1,132 +1,136 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NetbiosNameServers", - "/properties/NetbiosNodeType", - "/properties/NtpServers", - "/properties/DomainName", - "/properties/DomainNameServers", - "/properties/Ipv6AddressPreferredLeaseTime" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::DHCPOptions", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateDhcpOptions", - "ec2:DescribeDhcpOptions", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteDhcpOptions", - "ec2:DeleteTags", - "ec2:DescribeDhcpOptions" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeDhcpOptions" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeDhcpOptions", - "ec2:DescribeTags" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:DescribeDhcpOptions", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/DhcpOptionsId" - ], - "properties": { - "DhcpOptionsId": { - "type": "string" - }, - "DomainName": { - "description": "This value is used to complete unqualified DNS hostnames.", - "type": "string" - }, - "DomainNameServers": { - "description": "The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Ipv6AddressPreferredLeaseTime": { - "description": "The preferred Lease Time for ipV6 address in seconds.", - "type": "integer" - }, - "NetbiosNameServers": { - "description": "The IPv4 addresses of up to four NetBIOS name servers.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "NetbiosNodeType": { - "description": "The NetBIOS node type (1, 2, 4, or 8).", - "type": "integer" - }, - "NtpServers": { - "description": "The IPv4 addresses of up to four Network Time Protocol (NTP) servers.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "Any tags assigned to the DHCP options set.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/DhcpOptionsId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::DHCPOptions" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NetbiosNameServers", + "/properties/NetbiosNodeType", + "/properties/NtpServers", + "/properties/DomainName", + "/properties/DomainNameServers", + "/properties/Ipv6AddressPreferredLeaseTime" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::DHCPOptions", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateDhcpOptions", + "ec2:DescribeDhcpOptions", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteDhcpOptions", + "ec2:DeleteTags", + "ec2:DescribeDhcpOptions" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeDhcpOptions" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeDhcpOptions", + "ec2:DescribeTags" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:DescribeDhcpOptions", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/DhcpOptionsId" + ], + "properties": { + "DhcpOptionsId": { + "type": "string" + }, + "DomainName": { + "description": "This value is used to complete unqualified DNS hostnames.", + "type": "string" + }, + "DomainNameServers": { + "description": "The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Ipv6AddressPreferredLeaseTime": { + "description": "The preferred Lease Time for ipV6 address in seconds.", + "type": "integer" + }, + "NetbiosNameServers": { + "description": "The IPv4 addresses of up to four NetBIOS name servers.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "NetbiosNodeType": { + "description": "The NetBIOS node type (1, 2, 4, or 8).", + "type": "integer" + }, + "NtpServers": { + "description": "The IPv4 addresses of up to four Network Time Protocol (NTP) servers.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "Any tags assigned to the DHCP options set.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/DhcpOptionsId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::DHCPOptions" +} diff --git a/schema/aws-ec2-ec2fleet.json b/schema/aws-ec2-ec2fleet.json index dd28c60..4e2558e 100644 --- a/schema/aws-ec2-ec2fleet.json +++ b/schema/aws-ec2-ec2fleet.json @@ -1,713 +1,713 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LaunchTemplateConfigs", - "/properties/OnDemandOptions", - "/properties/ReplaceUnhealthyInstances", - "/properties/SpotOptions", - "/properties/TagSpecifications", - "/properties/TerminateInstancesWithExpiration", - "/properties/Type", - "/properties/ValidFrom", - "/properties/ValidUntil" - ], - "definitions": { - "AcceleratorCountRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "AcceleratorTotalMemoryMiBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "BaselineEbsBandwidthMbpsRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "CapacityRebalance": { - "additionalProperties": false, - "properties": { - "ReplacementStrategy": { - "enum": [ - "launch", - "launch-before-terminate" - ], - "type": "string" - }, - "TerminationDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "CapacityReservationOptionsRequest": { - "additionalProperties": false, - "properties": { - "UsageStrategy": { - "enum": [ - "use-capacity-reservations-first" - ], - "type": "string" - } - }, - "type": "object" - }, - "FleetLaunchTemplateConfigRequest": { - "additionalProperties": false, - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/FleetLaunchTemplateSpecificationRequest" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/FleetLaunchTemplateOverridesRequest" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "FleetLaunchTemplateOverridesRequest": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirementsRequest" - }, - "InstanceType": { - "type": "string" - }, - "MaxPrice": { - "type": "string" - }, - "Placement": { - "$ref": "#/definitions/Placement" - }, - "Priority": { - "type": "number" - }, - "SubnetId": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "FleetLaunchTemplateSpecificationRequest": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "maxLength": 128, - "minLength": 3, - "pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+", - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "InstanceRequirementsRequest": { - "additionalProperties": false, - "properties": { - "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCountRequest" - }, - "AcceleratorManufacturers": { - "items": { - "enum": [ - "amazon-web-services", - "amd", - "habana", - "nvidia", - "xilinx" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorNames": { - "items": { - "enum": [ - "a10g", - "a100", - "h100", - "inferentia", - "k520", - "k80", - "m60", - "radeon-pro-v520", - "t4", - "t4g", - "vu9p", - "v100" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest" - }, - "AcceleratorTypes": { - "items": { - "enum": [ - "gpu", - "fpga", - "inference" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowedInstanceTypes": { - "items": { - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\.\\*]+", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BareMetal": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest" - }, - "BurstablePerformance": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "CpuManufacturers": { - "items": { - "enum": [ - "intel", - "amd", - "amazon-web-services" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ExcludedInstanceTypes": { - "items": { - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\.\\*]+", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "InstanceGenerations": { - "items": { - "enum": [ - "current", - "previous" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LocalStorage": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "LocalStorageTypes": { - "items": { - "enum": [ - "hdd", - "ssd" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { - "type": "integer" - }, - "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpuRequest" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRequest" - }, - "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbpsRequest" - }, - "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCountRequest" - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "type": "integer" - }, - "RequireHibernateSupport": { - "type": "boolean" - }, - "SpotMaxPricePercentageOverLowestPrice": { - "type": "integer" - }, - "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGBRequest" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCountRangeRequest" - } - }, - "type": "object" - }, - "MaintenanceStrategies": { - "additionalProperties": false, - "properties": { - "CapacityRebalance": { - "$ref": "#/definitions/CapacityRebalance" - } - }, - "type": "object" - }, - "MemoryGiBPerVCpuRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "MemoryMiBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "NetworkBandwidthGbpsRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "NetworkInterfaceCountRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "OnDemandOptionsRequest": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "CapacityReservationOptions": { - "$ref": "#/definitions/CapacityReservationOptionsRequest" - }, - "MaxTotalPrice": { - "type": "string" - }, - "MinTargetCapacity": { - "type": "integer" - }, - "SingleAvailabilityZone": { - "type": "boolean" - }, - "SingleInstanceType": { - "type": "boolean" - } - }, - "type": "object" - }, - "Placement": { - "additionalProperties": false, - "properties": { - "Affinity": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "HostId": { - "type": "string" - }, - "HostResourceGroupArn": { - "type": "string" - }, - "PartitionNumber": { - "type": "integer" - }, - "SpreadDomain": { - "type": "string" - }, - "Tenancy": { - "type": "string" - } - }, - "type": "object" - }, - "SpotOptionsRequest": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "enum": [ - "lowest-price", - "lowestPrice", - "diversified", - "capacityOptimized", - "capacity-optimized", - "capacityOptimizedPrioritized", - "capacity-optimized-prioritized", - "priceCapacityOptimized", - "price-capacity-optimized" - ], - "type": "string" - }, - "InstanceInterruptionBehavior": { - "enum": [ - "hibernate", - "stop", - "terminate" - ], - "type": "string" - }, - "InstancePoolsToUseCount": { - "type": "integer" - }, - "MaintenanceStrategies": { - "$ref": "#/definitions/MaintenanceStrategies" - }, - "MaxTotalPrice": { - "type": "string" - }, - "MinTargetCapacity": { - "type": "integer" - }, - "SingleAvailabilityZone": { - "type": "boolean" - }, - "SingleInstanceType": { - "type": "boolean" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "enum": [ - "client-vpn-endpoint", - "customer-gateway", - "dedicated-host", - "dhcp-options", - "egress-only-internet-gateway", - "elastic-gpu", - "elastic-ip", - "export-image-task", - "export-instance-task", - "fleet", - "fpga-image", - "host-reservation", - "image", - "import-image-task", - "import-snapshot-task", - "instance", - "internet-gateway", - "key-pair", - "launch-template", - "local-gateway-route-table-vpc-association", - "natgateway", - "network-acl", - "network-insights-analysis", - "network-insights-path", - "network-interface", - "placement-group", - "reserved-instances", - "route-table", - "security-group", - "snapshot", - "spot-fleet-request", - "spot-instances-request", - "subnet", - "traffic-mirror-filter", - "traffic-mirror-session", - "traffic-mirror-target", - "transit-gateway", - "transit-gateway-attachment", - "transit-gateway-connect-peer", - "transit-gateway-multicast-domain", - "transit-gateway-route-table", - "volume", - "vpc", - "vpc-flow-log", - "vpc-peering-connection", - "vpn-connection", - "vpn-gateway" - ], - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "TargetCapacitySpecificationRequest": { - "additionalProperties": false, - "properties": { - "DefaultTargetCapacityType": { - "enum": [ - "on-demand", - "spot" - ], - "type": "string" - }, - "OnDemandTargetCapacity": { - "type": "integer" - }, - "SpotTargetCapacity": { - "type": "integer" - }, - "TargetCapacityUnitType": { - "enum": [ - "vcpu", - "memory-mib", - "units" - ], - "type": "string" - }, - "TotalTargetCapacity": { - "type": "integer" - } - }, - "required": [ - "TotalTargetCapacity" - ], - "type": "object" - }, - "TotalLocalStorageGBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "VCpuCountRangeRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::EC2Fleet", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateFleet", - "ec2:DescribeFleets" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeFleets", - "ec2:DeleteFleets" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeFleets" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeFleets" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyFleet", - "ec2:DescribeFleets" - ] - } - }, - "primaryIdentifier": [ - "/properties/FleetId" - ], - "properties": { - "Context": { - "type": "string" - }, - "ExcessCapacityTerminationPolicy": { - "enum": [ - "termination", - "no-termination" - ], - "type": "string" - }, - "FleetId": { - "type": "string" - }, - "LaunchTemplateConfigs": { - "items": { - "$ref": "#/definitions/FleetLaunchTemplateConfigRequest" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "OnDemandOptions": { - "$ref": "#/definitions/OnDemandOptionsRequest" - }, - "ReplaceUnhealthyInstances": { - "type": "boolean" - }, - "SpotOptions": { - "$ref": "#/definitions/SpotOptionsRequest" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/TagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "TargetCapacitySpecification": { - "$ref": "#/definitions/TargetCapacitySpecificationRequest" - }, - "TerminateInstancesWithExpiration": { - "type": "boolean" - }, - "Type": { - "enum": [ - "maintain", - "request", - "instant" - ], - "type": "string" - }, - "ValidFrom": { - "type": "string" - }, - "ValidUntil": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/FleetId" - ], - "required": [ - "TargetCapacitySpecification", - "LaunchTemplateConfigs" - ], - "typeName": "AWS::EC2::EC2Fleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LaunchTemplateConfigs", + "/properties/OnDemandOptions", + "/properties/ReplaceUnhealthyInstances", + "/properties/SpotOptions", + "/properties/TagSpecifications", + "/properties/TerminateInstancesWithExpiration", + "/properties/Type", + "/properties/ValidFrom", + "/properties/ValidUntil" + ], + "definitions": { + "AcceleratorCountRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "AcceleratorTotalMemoryMiBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "BaselineEbsBandwidthMbpsRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "CapacityRebalance": { + "additionalProperties": false, + "properties": { + "ReplacementStrategy": { + "enum": [ + "launch", + "launch-before-terminate" + ], + "type": "string" + }, + "TerminationDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "CapacityReservationOptionsRequest": { + "additionalProperties": false, + "properties": { + "UsageStrategy": { + "enum": [ + "use-capacity-reservations-first" + ], + "type": "string" + } + }, + "type": "object" + }, + "FleetLaunchTemplateConfigRequest": { + "additionalProperties": false, + "properties": { + "LaunchTemplateSpecification": { + "$ref": "#/definitions/FleetLaunchTemplateSpecificationRequest" + }, + "Overrides": { + "items": { + "$ref": "#/definitions/FleetLaunchTemplateOverridesRequest" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "FleetLaunchTemplateOverridesRequest": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "InstanceRequirements": { + "$ref": "#/definitions/InstanceRequirementsRequest" + }, + "InstanceType": { + "type": "string" + }, + "MaxPrice": { + "type": "string" + }, + "Placement": { + "$ref": "#/definitions/Placement" + }, + "Priority": { + "type": "number" + }, + "SubnetId": { + "type": "string" + }, + "WeightedCapacity": { + "type": "number" + } + }, + "type": "object" + }, + "FleetLaunchTemplateSpecificationRequest": { + "additionalProperties": false, + "properties": { + "LaunchTemplateId": { + "type": "string" + }, + "LaunchTemplateName": { + "maxLength": 128, + "minLength": 3, + "pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+", + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "required": [ + "Version" + ], + "type": "object" + }, + "InstanceRequirementsRequest": { + "additionalProperties": false, + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRequest" + }, + "AcceleratorManufacturers": { + "items": { + "enum": [ + "amazon-web-services", + "amd", + "habana", + "nvidia", + "xilinx" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorNames": { + "items": { + "enum": [ + "a10g", + "a100", + "h100", + "inferentia", + "k520", + "k80", + "m60", + "radeon-pro-v520", + "t4", + "t4g", + "vu9p", + "v100" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest" + }, + "AcceleratorTypes": { + "items": { + "enum": [ + "gpu", + "fpga", + "inference" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowedInstanceTypes": { + "items": { + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\.\\*]+", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BareMetal": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "BaselineEbsBandwidthMbps": { + "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest" + }, + "BurstablePerformance": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "CpuManufacturers": { + "items": { + "enum": [ + "intel", + "amd", + "amazon-web-services" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ExcludedInstanceTypes": { + "items": { + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\.\\*]+", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "InstanceGenerations": { + "items": { + "enum": [ + "current", + "previous" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LocalStorage": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "LocalStorageTypes": { + "items": { + "enum": [ + "hdd", + "ssd" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": "integer" + }, + "MemoryGiBPerVCpu": { + "$ref": "#/definitions/MemoryGiBPerVCpuRequest" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRequest" + }, + "NetworkBandwidthGbps": { + "$ref": "#/definitions/NetworkBandwidthGbpsRequest" + }, + "NetworkInterfaceCount": { + "$ref": "#/definitions/NetworkInterfaceCountRequest" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": "integer" + }, + "RequireHibernateSupport": { + "type": "boolean" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": "integer" + }, + "TotalLocalStorageGB": { + "$ref": "#/definitions/TotalLocalStorageGBRequest" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRangeRequest" + } + }, + "type": "object" + }, + "MaintenanceStrategies": { + "additionalProperties": false, + "properties": { + "CapacityRebalance": { + "$ref": "#/definitions/CapacityRebalance" + } + }, + "type": "object" + }, + "MemoryGiBPerVCpuRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "MemoryMiBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "NetworkBandwidthGbpsRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "NetworkInterfaceCountRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "OnDemandOptionsRequest": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + }, + "CapacityReservationOptions": { + "$ref": "#/definitions/CapacityReservationOptionsRequest" + }, + "MaxTotalPrice": { + "type": "string" + }, + "MinTargetCapacity": { + "type": "integer" + }, + "SingleAvailabilityZone": { + "type": "boolean" + }, + "SingleInstanceType": { + "type": "boolean" + } + }, + "type": "object" + }, + "Placement": { + "additionalProperties": false, + "properties": { + "Affinity": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "HostId": { + "type": "string" + }, + "HostResourceGroupArn": { + "type": "string" + }, + "PartitionNumber": { + "type": "integer" + }, + "SpreadDomain": { + "type": "string" + }, + "Tenancy": { + "type": "string" + } + }, + "type": "object" + }, + "SpotOptionsRequest": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "enum": [ + "lowest-price", + "lowestPrice", + "diversified", + "capacityOptimized", + "capacity-optimized", + "capacityOptimizedPrioritized", + "capacity-optimized-prioritized", + "priceCapacityOptimized", + "price-capacity-optimized" + ], + "type": "string" + }, + "InstanceInterruptionBehavior": { + "enum": [ + "hibernate", + "stop", + "terminate" + ], + "type": "string" + }, + "InstancePoolsToUseCount": { + "type": "integer" + }, + "MaintenanceStrategies": { + "$ref": "#/definitions/MaintenanceStrategies" + }, + "MaxTotalPrice": { + "type": "string" + }, + "MinTargetCapacity": { + "type": "integer" + }, + "SingleAvailabilityZone": { + "type": "boolean" + }, + "SingleInstanceType": { + "type": "boolean" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagSpecification": { + "additionalProperties": false, + "properties": { + "ResourceType": { + "enum": [ + "client-vpn-endpoint", + "customer-gateway", + "dedicated-host", + "dhcp-options", + "egress-only-internet-gateway", + "elastic-gpu", + "elastic-ip", + "export-image-task", + "export-instance-task", + "fleet", + "fpga-image", + "host-reservation", + "image", + "import-image-task", + "import-snapshot-task", + "instance", + "internet-gateway", + "key-pair", + "launch-template", + "local-gateway-route-table-vpc-association", + "natgateway", + "network-acl", + "network-insights-analysis", + "network-insights-path", + "network-interface", + "placement-group", + "reserved-instances", + "route-table", + "security-group", + "snapshot", + "spot-fleet-request", + "spot-instances-request", + "subnet", + "traffic-mirror-filter", + "traffic-mirror-session", + "traffic-mirror-target", + "transit-gateway", + "transit-gateway-attachment", + "transit-gateway-connect-peer", + "transit-gateway-multicast-domain", + "transit-gateway-route-table", + "volume", + "vpc", + "vpc-flow-log", + "vpc-peering-connection", + "vpn-connection", + "vpn-gateway" + ], + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "TargetCapacitySpecificationRequest": { + "additionalProperties": false, + "properties": { + "DefaultTargetCapacityType": { + "enum": [ + "on-demand", + "spot" + ], + "type": "string" + }, + "OnDemandTargetCapacity": { + "type": "integer" + }, + "SpotTargetCapacity": { + "type": "integer" + }, + "TargetCapacityUnitType": { + "enum": [ + "vcpu", + "memory-mib", + "units" + ], + "type": "string" + }, + "TotalTargetCapacity": { + "type": "integer" + } + }, + "required": [ + "TotalTargetCapacity" + ], + "type": "object" + }, + "TotalLocalStorageGBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "VCpuCountRangeRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::EC2Fleet", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateFleet", + "ec2:DescribeFleets" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeFleets", + "ec2:DeleteFleets" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeFleets" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeFleets" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyFleet", + "ec2:DescribeFleets" + ] + } + }, + "primaryIdentifier": [ + "/properties/FleetId" + ], + "properties": { + "Context": { + "type": "string" + }, + "ExcessCapacityTerminationPolicy": { + "enum": [ + "termination", + "no-termination" + ], + "type": "string" + }, + "FleetId": { + "type": "string" + }, + "LaunchTemplateConfigs": { + "items": { + "$ref": "#/definitions/FleetLaunchTemplateConfigRequest" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "OnDemandOptions": { + "$ref": "#/definitions/OnDemandOptionsRequest" + }, + "ReplaceUnhealthyInstances": { + "type": "boolean" + }, + "SpotOptions": { + "$ref": "#/definitions/SpotOptionsRequest" + }, + "TagSpecifications": { + "items": { + "$ref": "#/definitions/TagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "TargetCapacitySpecification": { + "$ref": "#/definitions/TargetCapacitySpecificationRequest" + }, + "TerminateInstancesWithExpiration": { + "type": "boolean" + }, + "Type": { + "enum": [ + "maintain", + "request", + "instant" + ], + "type": "string" + }, + "ValidFrom": { + "type": "string" + }, + "ValidUntil": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/FleetId" + ], + "required": [ + "TargetCapacitySpecification", + "LaunchTemplateConfigs" + ], + "typeName": "AWS::EC2::EC2Fleet" +} diff --git a/schema/aws-ec2-egressonlyinternetgateway.json b/schema/aws-ec2-egressonlyinternetgateway.json index 147b32e..0b94c52 100644 --- a/schema/aws-ec2-egressonlyinternetgateway.json +++ b/schema/aws-ec2-egressonlyinternetgateway.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId" - ], - "description": "Resource Type definition for AWS::EC2::EgressOnlyInternetGateway", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateEgressOnlyInternetGateway", - "ec2:DescribeEgressOnlyInternetGateways" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteEgressOnlyInternetGateway", - "ec2:DescribeEgressOnlyInternetGateways", - "ec2:DescribeVpcs" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeEgressOnlyInternetGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeEgressOnlyInternetGateways" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "Service Generated ID of the EgressOnlyInternetGateway", - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC for which to create the egress-only internet gateway.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::EgressOnlyInternetGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId" + ], + "description": "Resource Type definition for AWS::EC2::EgressOnlyInternetGateway", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateEgressOnlyInternetGateway", + "ec2:DescribeEgressOnlyInternetGateways" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteEgressOnlyInternetGateway", + "ec2:DescribeEgressOnlyInternetGateways", + "ec2:DescribeVpcs" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeEgressOnlyInternetGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeEgressOnlyInternetGateways" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "Service Generated ID of the EgressOnlyInternetGateway", + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC for which to create the egress-only internet gateway.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::EgressOnlyInternetGateway" +} diff --git a/schema/aws-ec2-eip.json b/schema/aws-ec2-eip.json index 370edc5..be0a6b4 100644 --- a/schema/aws-ec2-eip.json +++ b/schema/aws-ec2-eip.json @@ -1,130 +1,130 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Domain", - "/properties/NetworkBorderGroup", - "/properties/TransferAddress" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.\n You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.\n For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:AllocateAddress", - "ec2:AcceptAddressTransfer", - "ec2:DescribeAddresses", - "ec2:AssociateAddress", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:ReleaseAddress", - "ec2:DescribeAddresses", - "ec2:DisassociateAddress" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeAddresses" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeAddresses" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeAddresses", - "ec2:DisassociateAddress", - "ec2:DeleteTags", - "ec2:CreateTags", - "ec2:AssociateAddress" - ] - } - }, - "primaryIdentifier": [ - "/properties/PublicIp", - "/properties/AllocationId" - ], - "properties": { - "AllocationId": { - "description": "", - "type": "string" - }, - "Domain": { - "description": "The network (``vpc``).\n If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the instance.\n Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", - "type": "string" - }, - "NetworkBorderGroup": { - "description": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.\n Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.", - "type": "string" - }, - "PublicIp": { - "description": "", - "type": "string" - }, - "PublicIpv4Pool": { - "description": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", - "type": "string" - }, - "Tags": { - "description": "Any tags assigned to the Elastic IP address.\n Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransferAddress": { - "description": "The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/Domain": "\"vpc\"" - }, - "readOnlyProperties": [ - "/properties/PublicIp", - "/properties/AllocationId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::EIP", - "writeOnlyProperties": [ - "/properties/TransferAddress" - ] -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Domain", + "/properties/NetworkBorderGroup", + "/properties/TransferAddress" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.\n You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.\n For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:AllocateAddress", + "ec2:AcceptAddressTransfer", + "ec2:DescribeAddresses", + "ec2:AssociateAddress", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:ReleaseAddress", + "ec2:DescribeAddresses", + "ec2:DisassociateAddress" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeAddresses" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeAddresses" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeAddresses", + "ec2:DisassociateAddress", + "ec2:DeleteTags", + "ec2:CreateTags", + "ec2:AssociateAddress" + ] + } + }, + "primaryIdentifier": [ + "/properties/PublicIp", + "/properties/AllocationId" + ], + "properties": { + "AllocationId": { + "description": "", + "type": "string" + }, + "Domain": { + "description": "The network (``vpc``).\n If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the instance.\n Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", + "type": "string" + }, + "NetworkBorderGroup": { + "description": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.\n Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.", + "type": "string" + }, + "PublicIp": { + "description": "", + "type": "string" + }, + "PublicIpv4Pool": { + "description": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", + "type": "string" + }, + "Tags": { + "description": "Any tags assigned to the Elastic IP address.\n Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransferAddress": { + "description": "The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/Domain": "\"vpc\"" + }, + "readOnlyProperties": [ + "/properties/PublicIp", + "/properties/AllocationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::EIP", + "writeOnlyProperties": [ + "/properties/TransferAddress" + ] +} diff --git a/schema/aws-ec2-eipassociation.json b/schema/aws-ec2-eipassociation.json index fff0fe0..2c29bb2 100644 --- a/schema/aws-ec2-eipassociation.json +++ b/schema/aws-ec2-eipassociation.json @@ -1,76 +1,76 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AllocationId", - "/properties/NetworkInterfaceId", - "/properties/InstanceId", - "/properties/PrivateIpAddress", - "/properties/EIP" - ], - "deprecatedProperties": [ - "/properties/EIP" - ], - "description": "Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview).\n You must specify ``AllocationId`` and either ``InstanceId``, ``NetworkInterfaceId``, or ``PrivateIpAddress``.", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeAddresses", - "ec2:AssociateAddress" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateAddress", - "ec2:DescribeAddresses" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeAddresses" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeAddresses" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllocationId": { - "description": "The allocation ID. This is required.", - "type": "string" - }, - "EIP": { - "description": "", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.\n You can specify either the instance ID or the network interface ID, but not both.", - "type": "string" - }, - "PrivateIpAddress": { - "description": "The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "replacementStrategy": "delete_then_create", - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/tree/master/aws-ec2-eipassociation", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::EIPAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AllocationId", + "/properties/NetworkInterfaceId", + "/properties/InstanceId", + "/properties/PrivateIpAddress", + "/properties/EIP" + ], + "deprecatedProperties": [ + "/properties/EIP" + ], + "description": "Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview).\n You must specify ``AllocationId`` and either ``InstanceId``, ``NetworkInterfaceId``, or ``PrivateIpAddress``.", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeAddresses", + "ec2:AssociateAddress" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateAddress", + "ec2:DescribeAddresses" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeAddresses" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeAddresses" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllocationId": { + "description": "The allocation ID. This is required.", + "type": "string" + }, + "EIP": { + "description": "", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.\n You can specify either the instance ID or the network interface ID, but not both.", + "type": "string" + }, + "PrivateIpAddress": { + "description": "The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "replacementStrategy": "delete_then_create", + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/tree/master/aws-ec2-eipassociation", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::EIPAssociation" +} diff --git a/schema/aws-ec2-enclavecertificateiamroleassociation.json b/schema/aws-ec2-enclavecertificateiamroleassociation.json index 80dba00..3f7d1fe 100644 --- a/schema/aws-ec2-enclavecertificateiamroleassociation.json +++ b/schema/aws-ec2-enclavecertificateiamroleassociation.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateArn", - "/properties/RoleArn" - ], - "description": "Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateEnclaveCertificateIamRole" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateEnclaveCertificateIamRole" - ] - }, - "list": { - "permissions": [ - "ec2:GetAssociatedEnclaveCertificateIamRoles" - ] - }, - "read": { - "permissions": [ - "ec2:GetAssociatedEnclaveCertificateIamRoles" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateArn", - "/properties/RoleArn" - ], - "properties": { - "CertificateArn": { - "description": "The Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.", - "maxLength": 1283, - "minLength": 1, - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:acm:[A-Za-z0-9-]{1,64}:([0-9]{12})?:certificate/.+$", - "type": "string" - }, - "CertificateS3BucketName": { - "description": "The name of the Amazon S3 bucket to which the certificate was uploaded.", - "type": "string" - }, - "CertificateS3ObjectKey": { - "description": "The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.", - "type": "string" - }, - "EncryptionKmsKeyId": { - "description": "The ID of the AWS KMS CMK used to encrypt the private key of the certificate.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.", - "maxLength": 1283, - "minLength": 1, - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:iam:.*:([0-9]{12})?:role/.+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CertificateS3BucketName", - "/properties/CertificateS3ObjectKey", - "/properties/EncryptionKmsKeyId" - ], - "required": [ - "CertificateArn", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-acmcerts.git", - "typeName": "AWS::EC2::EnclaveCertificateIamRoleAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateArn", + "/properties/RoleArn" + ], + "description": "Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateEnclaveCertificateIamRole" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateEnclaveCertificateIamRole" + ] + }, + "list": { + "permissions": [ + "ec2:GetAssociatedEnclaveCertificateIamRoles" + ] + }, + "read": { + "permissions": [ + "ec2:GetAssociatedEnclaveCertificateIamRoles" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateArn", + "/properties/RoleArn" + ], + "properties": { + "CertificateArn": { + "description": "The Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.", + "maxLength": 1283, + "minLength": 1, + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:acm:[A-Za-z0-9-]{1,64}:([0-9]{12})?:certificate/.+$", + "type": "string" + }, + "CertificateS3BucketName": { + "description": "The name of the Amazon S3 bucket to which the certificate was uploaded.", + "type": "string" + }, + "CertificateS3ObjectKey": { + "description": "The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.", + "type": "string" + }, + "EncryptionKmsKeyId": { + "description": "The ID of the AWS KMS CMK used to encrypt the private key of the certificate.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.", + "maxLength": 1283, + "minLength": 1, + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:iam:.*:([0-9]{12})?:role/.+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CertificateS3BucketName", + "/properties/CertificateS3ObjectKey", + "/properties/EncryptionKmsKeyId" + ], + "required": [ + "CertificateArn", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-acmcerts.git", + "typeName": "AWS::EC2::EnclaveCertificateIamRoleAssociation" +} diff --git a/schema/aws-ec2-flowlog.json b/schema/aws-ec2-flowlog.json index b4ee147..1a4964c 100644 --- a/schema/aws-ec2-flowlog.json +++ b/schema/aws-ec2-flowlog.json @@ -1,186 +1,186 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeliverCrossAccountRole", - "/properties/DeliverLogsPermissionArn", - "/properties/LogGroupName", - "/properties/LogDestination", - "/properties/ResourceId", - "/properties/TrafficType", - "/properties/LogDestinationType", - "/properties/ResourceType", - "/properties/LogFormat", - "/properties/MaxAggregationInterval", - "/properties/DestinationOptions" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateFlowLogs", - "ec2:DescribeFlowLogs", - "ec2:CreateTags", - "iam:PassRole", - "logs:CreateLogDelivery", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteFlowLogs", - "ec2:DescribeFlowLogs", - "logs:DeleteLogDelivery" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeFlowLogs" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeFlowLogs" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeFlowLogs" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeliverCrossAccountRole": { - "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.", - "type": "string" - }, - "DeliverLogsPermissionArn": { - "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.", - "type": "string" - }, - "DestinationOptions": { - "additionalProperties": false, - "properties": { - "FileFormat": { - "enum": [ - "plain-text", - "parquet" - ], - "type": "string" - }, - "HiveCompatiblePartitions": { - "type": "boolean" - }, - "PerHourPartition": { - "type": "boolean" - } - }, - "required": [ - "FileFormat", - "HiveCompatiblePartitions", - "PerHourPartition" - ], - "type": "object" - }, - "Id": { - "description": "The Flow Log ID", - "type": "string" - }, - "LogDestination": { - "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.", - "type": "string" - }, - "LogDestinationType": { - "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.", - "enum": [ - "cloud-watch-logs", - "s3", - "kinesis-data-firehose" - ], - "type": "string" - }, - "LogFormat": { - "description": "The fields to include in the flow log record, in the order in which they should appear.", - "type": "string" - }, - "LogGroupName": { - "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.", - "type": "string" - }, - "MaxAggregationInterval": { - "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).", - "type": "integer" - }, - "ResourceId": { - "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log.", - "type": "string" - }, - "ResourceType": { - "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.", - "enum": [ - "NetworkInterface", - "Subnet", - "VPC", - "TransitGateway", - "TransitGatewayAttachment" - ], - "type": "string" - }, - "Tags": { - "description": "The tags to apply to the flow logs.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TrafficType": { - "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.", - "enum": [ - "ACCEPT", - "ALL", - "REJECT" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResourceType", - "ResourceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-flowlog.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::FlowLog" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeliverCrossAccountRole", + "/properties/DeliverLogsPermissionArn", + "/properties/LogGroupName", + "/properties/LogDestination", + "/properties/ResourceId", + "/properties/TrafficType", + "/properties/LogDestinationType", + "/properties/ResourceType", + "/properties/LogFormat", + "/properties/MaxAggregationInterval", + "/properties/DestinationOptions" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateFlowLogs", + "ec2:DescribeFlowLogs", + "ec2:CreateTags", + "iam:PassRole", + "logs:CreateLogDelivery", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteFlowLogs", + "ec2:DescribeFlowLogs", + "logs:DeleteLogDelivery" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeFlowLogs" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeFlowLogs" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeFlowLogs" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeliverCrossAccountRole": { + "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.", + "type": "string" + }, + "DeliverLogsPermissionArn": { + "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.", + "type": "string" + }, + "DestinationOptions": { + "additionalProperties": false, + "properties": { + "FileFormat": { + "enum": [ + "plain-text", + "parquet" + ], + "type": "string" + }, + "HiveCompatiblePartitions": { + "type": "boolean" + }, + "PerHourPartition": { + "type": "boolean" + } + }, + "required": [ + "FileFormat", + "HiveCompatiblePartitions", + "PerHourPartition" + ], + "type": "object" + }, + "Id": { + "description": "The Flow Log ID", + "type": "string" + }, + "LogDestination": { + "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.", + "type": "string" + }, + "LogDestinationType": { + "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.", + "enum": [ + "cloud-watch-logs", + "s3", + "kinesis-data-firehose" + ], + "type": "string" + }, + "LogFormat": { + "description": "The fields to include in the flow log record, in the order in which they should appear.", + "type": "string" + }, + "LogGroupName": { + "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.", + "type": "string" + }, + "MaxAggregationInterval": { + "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).", + "type": "integer" + }, + "ResourceId": { + "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log.", + "type": "string" + }, + "ResourceType": { + "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.", + "enum": [ + "NetworkInterface", + "Subnet", + "VPC", + "TransitGateway", + "TransitGatewayAttachment" + ], + "type": "string" + }, + "Tags": { + "description": "The tags to apply to the flow logs.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TrafficType": { + "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.", + "enum": [ + "ACCEPT", + "ALL", + "REJECT" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceType", + "ResourceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-flowlog.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::FlowLog" +} diff --git a/schema/aws-ec2-gatewayroutetableassociation.json b/schema/aws-ec2-gatewayroutetableassociation.json index 4cf932a..bcc8103 100644 --- a/schema/aws-ec2-gatewayroutetableassociation.json +++ b/schema/aws-ec2-gatewayroutetableassociation.json @@ -1,64 +1,64 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GatewayId" - ], - "description": "Associates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeRouteTables", - "ec2:AssociateRouteTable" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeRouteTables", - "ec2:DisassociateRouteTable" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeRouteTables", - "ec2:ReplaceRouteTableAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/GatewayId" - ], - "properties": { - "AssociationId": { - "description": "The route table association ID.", - "type": "string" - }, - "GatewayId": { - "description": "The ID of the gateway.", - "type": "string" - }, - "RouteTableId": { - "description": "The ID of the route table.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId" - ], - "required": [ - "RouteTableId", - "GatewayId" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::GatewayRouteTableAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GatewayId" + ], + "description": "Associates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeRouteTables", + "ec2:AssociateRouteTable" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeRouteTables", + "ec2:DisassociateRouteTable" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeRouteTables", + "ec2:ReplaceRouteTableAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/GatewayId" + ], + "properties": { + "AssociationId": { + "description": "The route table association ID.", + "type": "string" + }, + "GatewayId": { + "description": "The ID of the gateway.", + "type": "string" + }, + "RouteTableId": { + "description": "The ID of the route table.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId" + ], + "required": [ + "RouteTableId", + "GatewayId" + ], + "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::GatewayRouteTableAssociation" +} diff --git a/schema/aws-ec2-host.json b/schema/aws-ec2-host.json index 2d28b5f..02a26f8 100644 --- a/schema/aws-ec2-host.json +++ b/schema/aws-ec2-host.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AvailabilityZone", - "/properties/InstanceType", - "/properties/InstanceFamily", - "/properties/OutpostArn", - "/properties/AssetId" - ], - "description": "Resource Type definition for AWS::EC2::Host", - "handlers": { - "create": { - "permissions": [ - "ec2:AllocateHosts", - "ec2:DescribeHosts" - ] - }, - "delete": { - "permissions": [ - "ec2:ReleaseHosts", - "ec2:DescribeHosts" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeHosts" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeHosts" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyHosts", - "ec2:DescribeHosts" - ] - } - }, - "primaryIdentifier": [ - "/properties/HostId" - ], - "properties": { - "AssetId": { - "description": "The ID of the Outpost hardware asset.", - "type": "string" - }, - "AutoPlacement": { - "description": "Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.", - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone in which to allocate the Dedicated Host.", - "type": "string" - }, - "HostId": { - "description": "ID of the host created.", - "type": "string" - }, - "HostMaintenance": { - "description": "Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.", - "type": "string" - }, - "HostRecovery": { - "description": "Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.", - "type": "string" - }, - "InstanceFamily": { - "description": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.", - "type": "string" - }, - "InstanceType": { - "description": "Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.", - "type": "string" - }, - "OutpostArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/HostId" - ], - "required": [ - "AvailabilityZone" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "typeName": "AWS::EC2::Host" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AvailabilityZone", + "/properties/InstanceType", + "/properties/InstanceFamily", + "/properties/OutpostArn", + "/properties/AssetId" + ], + "description": "Resource Type definition for AWS::EC2::Host", + "handlers": { + "create": { + "permissions": [ + "ec2:AllocateHosts", + "ec2:DescribeHosts" + ] + }, + "delete": { + "permissions": [ + "ec2:ReleaseHosts", + "ec2:DescribeHosts" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeHosts" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeHosts" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyHosts", + "ec2:DescribeHosts" + ] + } + }, + "primaryIdentifier": [ + "/properties/HostId" + ], + "properties": { + "AssetId": { + "description": "The ID of the Outpost hardware asset.", + "type": "string" + }, + "AutoPlacement": { + "description": "Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone in which to allocate the Dedicated Host.", + "type": "string" + }, + "HostId": { + "description": "ID of the host created.", + "type": "string" + }, + "HostMaintenance": { + "description": "Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.", + "type": "string" + }, + "HostRecovery": { + "description": "Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.", + "type": "string" + }, + "InstanceFamily": { + "description": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.", + "type": "string" + }, + "InstanceType": { + "description": "Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.", + "type": "string" + }, + "OutpostArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/HostId" + ], + "required": [ + "AvailabilityZone" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "typeName": "AWS::EC2::Host" +} diff --git a/schema/aws-ec2-instance.json b/schema/aws-ec2-instance.json index bb325f0..339d46c 100644 --- a/schema/aws-ec2-instance.json +++ b/schema/aws-ec2-instance.json @@ -1,819 +1,823 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/AdditionalInfo", - "/properties/Affinity", - "/properties/EbsOptimized", - "/properties/HostId", - "/properties/InstanceType", - "/properties/KernelId", - "/properties/PrivateDnsNameOptions", - "/properties/RamdiskId", - "/properties/SecurityGroupIds", - "/properties/Tenancy", - "/properties/UserData", - "/properties/BlockDeviceMappings" - ], - "createOnlyProperties": [ - "/properties/AvailabilityZone", - "/properties/CpuOptions", - "/properties/ElasticGpuSpecifications", - "/properties/ElasticInferenceAccelerators", - "/properties/EnclaveOptions", - "/properties/HibernationOptions", - "/properties/HostResourceGroupArn", - "/properties/ImageId", - "/properties/Ipv6AddressCount", - "/properties/Ipv6Addresses", - "/properties/KeyName", - "/properties/LaunchTemplate", - "/properties/LicenseSpecifications", - "/properties/NetworkInterfaces", - "/properties/PlacementGroupName", - "/properties/PrivateIpAddress", - "/properties/SecurityGroups", - "/properties/SubnetId" - ], - "definitions": { - "AssociationParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The name of an input parameter that is in the associated SSM document.", - "type": "string" - }, - "Value": { - "description": "The value of an input parameter.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "description": "The device name (for example, /dev/sdh or xvdh).", - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/Ebs", - "description": "Parameters used to automatically set up EBS volumes when the instance is launched." - }, - "NoDevice": { - "additionalProperties": false, - "type": "object" - }, - "VirtualName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "Ebs": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "description": "Indicates whether the EBS volume is deleted on instance termination.", - "type": "boolean" - }, - "Encrypted": { - "description": "Indicates whether the volume should be encrypted.", - "type": "boolean" - }, - "Iops": { - "description": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.", - "type": "string" - }, - "SnapshotId": { - "description": "The ID of the snapshot.", - "type": "string" - }, - "VolumeSize": { - "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.", - "type": "integer" - }, - "VolumeType": { - "description": "The volume type.", - "type": "string" - } - }, - "type": "object" - }, - "ElasticGpuSpecification": { - "additionalProperties": false, - "properties": { - "Type": { - "description": "The type of Elastic Graphics accelerator.", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ElasticInferenceAccelerator": { - "additionalProperties": false, - "properties": { - "Count": { - "description": "The number of elastic inference accelerators to attach to the instance.", - "minimum": 0, - "type": "integer" - }, - "Type": { - "description": "The type of elastic inference accelerator.", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "description": "The IPv6 address.", - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "LaunchTemplateSpecification": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "LaunchTemplateName", - "Version" - ] - }, - { - "required": [ - "LaunchTemplateId", - "Version" - ] - } - ], - "properties": { - "LaunchTemplateId": { - "description": "The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", - "type": "string" - }, - "LaunchTemplateName": { - "description": "The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", - "type": "string" - }, - "Version": { - "description": "The version number of the launch template.", - "type": "string" - } - }, - "type": "object" - }, - "LicenseSpecification": { - "additionalProperties": false, - "properties": { - "LicenseConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the license configuration.", - "type": "string" - } - }, - "required": [ - "LicenseConfigurationArn" - ], - "type": "object" - }, - "NetworkInterface": { - "additionalProperties": false, - "properties": { - "AssociateCarrierIpAddress": { - "description": "Not currently supported by AWS CloudFormation.", - "type": "boolean" - }, - "AssociatePublicIpAddress": { - "description": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.", - "type": "boolean" - }, - "DeleteOnTermination": { - "description": "If set to true, the interface is deleted when the instance is terminated.", - "type": "boolean" - }, - "Description": { - "description": "The description of the network interface.", - "type": "string" - }, - "DeviceIndex": { - "description": "The position of the network interface in the attachment order. A primary network interface has a device index of 0.", - "type": "string" - }, - "GroupSet": { - "description": "The IDs of the security groups for the network interface.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Ipv6AddressCount": { - "description": "A number of IPv6 addresses to assign to the network interface.", - "type": "integer" - }, - "Ipv6Addresses": { - "description": "The IPv6 addresses associated with the network interface.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceIpv6Address" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkInterfaceId": { - "description": "The ID of the network interface.", - "type": "string" - }, - "PrivateIpAddress": { - "description": "The private IPv4 address of the network interface.", - "type": "string" - }, - "PrivateIpAddresses": { - "description": "One or more private IPv4 addresses to assign to the network interface.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PrivateIpAddressSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "SecondaryPrivateIpAddressCount": { - "description": "The number of secondary private IPv4 addresses.", - "type": "integer" - }, - "SubnetId": { - "description": "The ID of the subnet.", - "type": "string" - } - }, - "required": [ - "DeviceIndex" - ], - "type": "object" - }, - "PrivateDnsNameOptions": { - "additionalProperties": false, - "properties": { - "EnableResourceNameDnsAAAARecord": { - "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", - "type": "boolean" - }, - "EnableResourceNameDnsARecord": { - "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", - "type": "boolean" - }, - "HostnameType": { - "description": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", - "enum": [ - "ip-name", - "resource-name" - ], - "type": "string" - } - }, - "type": "object" - }, - "PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", - "type": "boolean" - }, - "PrivateIpAddress": { - "description": "The private IPv4 addresses.", - "type": "string" - } - }, - "required": [ - "PrivateIpAddress", - "Primary" - ], - "type": "object" - }, - "SsmAssociation": { - "additionalProperties": false, - "properties": { - "AssociationParameters": { - "description": "The input parameter values to use with the associated SSM document.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssociationParameter" - }, - "type": "array", - "uniqueItems": false - }, - "DocumentName": { - "description": "The name of an SSM document to associate with the instance.", - "type": "string" - } - }, - "required": [ - "DocumentName" - ], - "type": "object" - }, - "State": { - "additionalProperties": false, - "description": "The current state of the instance", - "properties": { - "Code": { - "description": "The state of the instance as a 16-bit unsigned integer.", - "type": "string" - }, - "Name": { - "description": "The current state of the instance.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Volume": { - "additionalProperties": false, - "properties": { - "Device": { - "description": "The device name (for example, /dev/sdh or xvdh).", - "type": "string" - }, - "VolumeId": { - "description": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.", - "type": "string" - } - }, - "required": [ - "VolumeId", - "Device" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::Instance", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "ec2:ModifyPrivateDnsNameOptions", - "ec2:DescribeElasticGpus", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeVolumes", - "ec2:RunInstances", - "ec2:AssociateIamInstanceProfile", - "ec2:DescribeIamInstanceProfileAssociations", - "ec2:DescribeInstances", - "ec2:DescribeSubnets", - "ec2:DescribeKeyPairs", - "ec2:DescribeSecurityGroups", - "ec2:DescribeVpcs", - "ec2:DescribeInstanceAttribute", - "ec2:DescribeInstanceCreditSpecifications", - "ec2:DescribeLaunchTemplates", - "ec2:DescribeLaunchTemplateVersions", - "ec2:DetachVolume", - "ec2:DisassociateIamInstanceProfile", - "ec2:ModifyInstanceAttribute", - "ec2:ModifyInstanceCreditSpecification", - "ec2:ModifyInstancePlacement", - "ec2:MonitorInstances", - "ec2:AttachVolume", - "ec2:CreateTags", - "ec2:ReplaceIamInstanceProfileAssociation", - "ec2:StartInstances", - "elastic-inference:DescribeAccelerators", - "ssm:CreateAssociation", - "ssm:DescribeAssociation", - "ssm:ListAssociations" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeInstances", - "ec2:TerminateInstances", - "ec2:DescribeElasticGpus", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeVolumes", - "ec2:DescribeInstances", - "ec2:DescribeInstanceAttribute", - "ec2:DescribeInstanceCreditSpecifications", - "ec2:DescribeLaunchTemplates", - "elastic-inference:DescribeAccelerators", - "ssm:DescribeAssociation", - "ssm:ListAssociations" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeInstances" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeElasticGpus", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeVolumes", - "ec2:DescribeInstances", - "ec2:DescribeInstanceAttribute", - "ec2:DescribeInstanceCreditSpecifications", - "ec2:DescribeLaunchTemplates", - "elastic-inference:DescribeAccelerators", - "ssm:DescribeAssociation", - "ssm:ListAssociations" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeElasticGpus", - "ec2:ModifyPrivateDnsNameOptions", - "ec2:DescribeNetworkInterfaces", - "ec2:AssociateIamInstanceProfile", - "ec2:DescribeIamInstanceProfileAssociations", - "ec2:DescribeInstances", - "ec2:DescribeSubnets", - "ec2:DescribeKeyPairs", - "ec2:DescribeSecurityGroups", - "ec2:DescribeVpcs", - "ec2:DescribeInstanceAttribute", - "ec2:DescribeInstanceCreditSpecifications", - "ec2:DescribeLaunchTemplates", - "ec2:DetachVolume", - "ec2:DisassociateIamInstanceProfile", - "ec2:ModifyInstanceAttribute", - "ec2:ModifyInstanceCreditSpecification", - "ec2:ModifyInstanceMaintenanceOptions", - "ec2:ModifyInstancePlacement", - "ec2:MonitorInstances", - "ec2:AttachVolume", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:ReplaceIamInstanceProfileAssociation", - "ec2:StartInstances", - "ec2:StopInstances", - "ec2:UnmonitorInstances", - "elastic-inference:DescribeAccelerators", - "ssm:CreateAssociation", - "ssm:DeleteAssociation", - "ssm:DescribeAssociation", - "ssm:ListAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceId" - ], - "properties": { - "AdditionalInfo": { - "description": "This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).", - "type": "string" - }, - "Affinity": { - "description": "Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.", - "enum": [ - "default", - "host" - ], - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone of the instance.", - "type": "string" - }, - "BlockDeviceMappings": { - "description": "The block device mapping entries that defines the block devices to attach to the instance at launch.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BlockDeviceMapping" - }, - "type": "array", - "uniqueItems": false - }, - "CpuOptions": { - "additionalProperties": false, - "description": "The CPU options for the instance.", - "properties": { - "CoreCount": { - "type": "integer" - }, - "ThreadsPerCore": { - "type": "integer" - } - }, - "type": "object" - }, - "CreditSpecification": { - "additionalProperties": false, - "description": "The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.", - "properties": { - "CPUCredits": { - "type": "string" - } - }, - "type": "object" - }, - "DisableApiTermination": { - "description": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.", - "type": "boolean" - }, - "EbsOptimized": { - "description": "Indicates whether the instance is optimized for Amazon EBS I/O.", - "type": "boolean" - }, - "ElasticGpuSpecifications": { - "description": "An elastic GPU to associate with the instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ElasticGpuSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "ElasticInferenceAccelerators": { - "description": "An elastic inference accelerator to associate with the instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ElasticInferenceAccelerator" - }, - "type": "array", - "uniqueItems": false - }, - "EnclaveOptions": { - "additionalProperties": false, - "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", - "properties": { - "Enabled": { - "description": "If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", - "type": "boolean" - } - }, - "type": "object" - }, - "HibernationOptions": { - "additionalProperties": false, - "description": "Indicates whether an instance is enabled for hibernation.", - "properties": { - "Configured": { - "default": false, - "description": "If you set this parameter to true, your instance is enabled for hibernation.", - "type": "boolean" - } - }, - "type": "object" - }, - "HostId": { - "description": "If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.", - "type": "string" - }, - "HostResourceGroupArn": { - "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.", - "type": "string" - }, - "IamInstanceProfile": { - "description": "The IAM instance profile.", - "type": "string" - }, - "ImageId": { - "description": "The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.", - "type": "string" - }, - "InstanceId": { - "description": "The EC2 Instance ID.", - "type": "string" - }, - "InstanceInitiatedShutdownBehavior": { - "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).", - "type": "string" - }, - "InstanceType": { - "description": "The instance type.", - "type": "string" - }, - "Ipv6AddressCount": { - "description": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.", - "type": "integer" - }, - "Ipv6Addresses": { - "description": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceIpv6Address" - }, - "type": "array", - "uniqueItems": false - }, - "KernelId": { - "description": "The ID of the kernel.", - "type": "string" - }, - "KeyName": { - "description": "The name of the key pair.", - "type": "string" - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification", - "description": "The launch template to use to launch the instances.", - "type": "object" - }, - "LicenseSpecifications": { - "description": "The license configurations.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LicenseSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "Monitoring": { - "description": "Specifies whether detailed monitoring is enabled for the instance.", - "type": "boolean" - }, - "NetworkInterfaces": { - "description": "The network interfaces to associate with the instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "type": "array", - "uniqueItems": false - }, - "PlacementGroupName": { - "description": "The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).", - "type": "string" - }, - "PrivateDnsName": { - "description": "The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.", - "type": "string" - }, - "PrivateDnsNameOptions": { - "$ref": "#/definitions/PrivateDnsNameOptions", - "description": "The options for the instance hostname.", - "type": "object" - }, - "PrivateIp": { - "description": "The private IP address of the specified instance. For example: 10.24.34.0.", - "type": "string" - }, - "PrivateIpAddress": { - "description": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.", - "type": "string" - }, - "PropagateTagsToVolumeOnCreation": { - "description": "Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.", - "type": "boolean" - }, - "PublicDnsName": { - "description": "The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.", - "type": "string" - }, - "PublicIp": { - "description": "The public IP address of the specified instance. For example: 192.0.2.0.", - "type": "string" - }, - "RamdiskId": { - "description": "The ID of the RAM disk to select.", - "type": "string" - }, - "SecurityGroupIds": { - "description": "The IDs of the security groups.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroups": { - "description": "the names of the security groups. For a nondefault VPC, you must use security group IDs instead.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceDestCheck": { - "description": "Specifies whether to enable an instance launched in a VPC to perform NAT.", - "type": "boolean" - }, - "SsmAssociations": { - "description": "The SSM document and parameter values in AWS Systems Manager to associate with this instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SsmAssociation" - }, - "type": "array", - "uniqueItems": false - }, - "State": { - "$ref": "#/definitions/State", - "description": "The current state of the instance.", - "type": "object" - }, - "SubnetId": { - "description": "[EC2-VPC] The ID of the subnet to launch the instance into.\n\n", - "type": "string" - }, - "Tags": { - "description": "The tags to add to the instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Tenancy": { - "description": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.", - "type": "string" - }, - "UserData": { - "description": "The user data to make available to the instance.", - "type": "string" - }, - "Volumes": { - "description": "The volumes to attach to the instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Volume" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC that the instance is running in.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/InstanceId", - "/properties/PrivateIp", - "/properties/PublicDnsName", - "/properties/PublicIp", - "/properties/PrivateDnsName", - "/properties/VpcId", - "/properties/State" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::Instance", - "writeOnlyProperties": [ - "/properties/BlockDeviceMappings/*/NoDevice", - "/properties/BlockDeviceMappings/*/VirtualName", - "/properties/LicenseSpecification", - "/properties/AdditionalInfo", - "/properties/Ipv6AddressCount", - "/properties/Ipv6Addresses", - "/properties/PropagateTagsToVolumeOnCreation", - "/properties/LaunchTemplate" - ] -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/AdditionalInfo", + "/properties/Affinity", + "/properties/EbsOptimized", + "/properties/HostId", + "/properties/InstanceType", + "/properties/KernelId", + "/properties/PrivateDnsNameOptions", + "/properties/RamdiskId", + "/properties/SecurityGroupIds", + "/properties/Tenancy", + "/properties/UserData", + "/properties/BlockDeviceMappings" + ], + "createOnlyProperties": [ + "/properties/AvailabilityZone", + "/properties/CpuOptions", + "/properties/ElasticGpuSpecifications", + "/properties/ElasticInferenceAccelerators", + "/properties/EnclaveOptions", + "/properties/HibernationOptions", + "/properties/HostResourceGroupArn", + "/properties/ImageId", + "/properties/Ipv6AddressCount", + "/properties/Ipv6Addresses", + "/properties/KeyName", + "/properties/LaunchTemplate", + "/properties/LicenseSpecifications", + "/properties/NetworkInterfaces", + "/properties/PlacementGroupName", + "/properties/PrivateIpAddress", + "/properties/SecurityGroups", + "/properties/SubnetId" + ], + "definitions": { + "AssociationParameter": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The name of an input parameter that is in the associated SSM document.", + "type": "string" + }, + "Value": { + "description": "The value of an input parameter.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "BlockDeviceMapping": { + "additionalProperties": false, + "properties": { + "DeviceName": { + "description": "The device name (for example, /dev/sdh or xvdh).", + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/Ebs", + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." + }, + "NoDevice": { + "additionalProperties": false, + "type": "object" + }, + "VirtualName": { + "type": "string" + } + }, + "required": [ + "DeviceName" + ], + "type": "object" + }, + "Ebs": { + "additionalProperties": false, + "properties": { + "DeleteOnTermination": { + "description": "Indicates whether the EBS volume is deleted on instance termination.", + "type": "boolean" + }, + "Encrypted": { + "description": "Indicates whether the volume should be encrypted.", + "type": "boolean" + }, + "Iops": { + "description": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.", + "type": "string" + }, + "SnapshotId": { + "description": "The ID of the snapshot.", + "type": "string" + }, + "VolumeSize": { + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.", + "type": "integer" + }, + "VolumeType": { + "description": "The volume type.", + "type": "string" + } + }, + "type": "object" + }, + "ElasticGpuSpecification": { + "additionalProperties": false, + "properties": { + "Type": { + "description": "The type of Elastic Graphics accelerator.", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ElasticInferenceAccelerator": { + "additionalProperties": false, + "properties": { + "Count": { + "description": "The number of elastic inference accelerators to attach to the instance.", + "minimum": 0, + "type": "integer" + }, + "Type": { + "description": "The type of elastic inference accelerator.", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "InstanceIpv6Address": { + "additionalProperties": false, + "properties": { + "Ipv6Address": { + "description": "The IPv6 address.", + "type": "string" + } + }, + "required": [ + "Ipv6Address" + ], + "type": "object" + }, + "LaunchTemplateSpecification": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "LaunchTemplateName", + "Version" + ] + }, + { + "required": [ + "LaunchTemplateId", + "Version" + ] + } + ], + "properties": { + "LaunchTemplateId": { + "description": "The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", + "type": "string" + }, + "LaunchTemplateName": { + "description": "The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", + "type": "string" + }, + "Version": { + "description": "The version number of the launch template.", + "type": "string" + } + }, + "type": "object" + }, + "LicenseSpecification": { + "additionalProperties": false, + "properties": { + "LicenseConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the license configuration.", + "type": "string" + } + }, + "required": [ + "LicenseConfigurationArn" + ], + "type": "object" + }, + "NetworkInterface": { + "additionalProperties": false, + "properties": { + "AssociateCarrierIpAddress": { + "description": "Not currently supported by AWS CloudFormation.", + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "description": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.", + "type": "boolean" + }, + "DeleteOnTermination": { + "description": "If set to true, the interface is deleted when the instance is terminated.", + "type": "boolean" + }, + "Description": { + "description": "The description of the network interface.", + "type": "string" + }, + "DeviceIndex": { + "description": "The position of the network interface in the attachment order. A primary network interface has a device index of 0.", + "type": "string" + }, + "GroupSet": { + "description": "The IDs of the security groups for the network interface.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Ipv6AddressCount": { + "description": "A number of IPv6 addresses to assign to the network interface.", + "type": "integer" + }, + "Ipv6Addresses": { + "description": "The IPv6 addresses associated with the network interface.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "type": "array", + "uniqueItems": false + }, + "NetworkInterfaceId": { + "description": "The ID of the network interface.", + "type": "string" + }, + "PrivateIpAddress": { + "description": "The private IPv4 address of the network interface.", + "type": "string" + }, + "PrivateIpAddresses": { + "description": "One or more private IPv4 addresses to assign to the network interface.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PrivateIpAddressSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "SecondaryPrivateIpAddressCount": { + "description": "The number of secondary private IPv4 addresses.", + "type": "integer" + }, + "SubnetId": { + "description": "The ID of the subnet.", + "type": "string" + } + }, + "required": [ + "DeviceIndex" + ], + "type": "object" + }, + "PrivateDnsNameOptions": { + "additionalProperties": false, + "properties": { + "EnableResourceNameDnsAAAARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", + "type": "boolean" + }, + "EnableResourceNameDnsARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", + "type": "boolean" + }, + "HostnameType": { + "description": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", + "enum": [ + "ip-name", + "resource-name" + ], + "type": "string" + } + }, + "type": "object" + }, + "PrivateIpAddressSpecification": { + "additionalProperties": false, + "properties": { + "Primary": { + "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", + "type": "boolean" + }, + "PrivateIpAddress": { + "description": "The private IPv4 addresses.", + "type": "string" + } + }, + "required": [ + "PrivateIpAddress", + "Primary" + ], + "type": "object" + }, + "SsmAssociation": { + "additionalProperties": false, + "properties": { + "AssociationParameters": { + "description": "The input parameter values to use with the associated SSM document.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssociationParameter" + }, + "type": "array", + "uniqueItems": false + }, + "DocumentName": { + "description": "The name of an SSM document to associate with the instance.", + "type": "string" + } + }, + "required": [ + "DocumentName" + ], + "type": "object" + }, + "State": { + "additionalProperties": false, + "description": "The current state of the instance", + "properties": { + "Code": { + "description": "The state of the instance as a 16-bit unsigned integer.", + "type": "string" + }, + "Name": { + "description": "The current state of the instance.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Volume": { + "additionalProperties": false, + "properties": { + "Device": { + "description": "The device name (for example, /dev/sdh or xvdh).", + "type": "string" + }, + "VolumeId": { + "description": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.", + "type": "string" + } + }, + "required": [ + "VolumeId", + "Device" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::Instance", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "ec2:ModifyPrivateDnsNameOptions", + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:RunInstances", + "ec2:AssociateIamInstanceProfile", + "ec2:DescribeIamInstanceProfileAssociations", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeKeyPairs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeVpcs", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:DetachVolume", + "ec2:DisassociateIamInstanceProfile", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyInstanceCreditSpecification", + "ec2:ModifyInstancePlacement", + "ec2:MonitorInstances", + "ec2:AttachVolume", + "ec2:CreateTags", + "ec2:ReplaceIamInstanceProfileAssociation", + "ec2:StartInstances", + "elastic-inference:DescribeAccelerators", + "ssm:CreateAssociation", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "elastic-inference:DescribeAccelerators", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeInstances" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "elastic-inference:DescribeAccelerators", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeElasticGpus", + "ec2:ModifyPrivateDnsNameOptions", + "ec2:DescribeNetworkInterfaces", + "ec2:AssociateIamInstanceProfile", + "ec2:DescribeIamInstanceProfileAssociations", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeKeyPairs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeVpcs", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "ec2:DetachVolume", + "ec2:DisassociateIamInstanceProfile", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyInstanceCreditSpecification", + "ec2:ModifyInstanceMaintenanceOptions", + "ec2:ModifyInstancePlacement", + "ec2:MonitorInstances", + "ec2:AttachVolume", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:ReplaceIamInstanceProfileAssociation", + "ec2:StartInstances", + "ec2:StopInstances", + "ec2:UnmonitorInstances", + "elastic-inference:DescribeAccelerators", + "ssm:CreateAssociation", + "ssm:DeleteAssociation", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceId" + ], + "properties": { + "AdditionalInfo": { + "description": "This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).", + "type": "string" + }, + "Affinity": { + "description": "Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.", + "enum": [ + "default", + "host" + ], + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone of the instance.", + "type": "string" + }, + "BlockDeviceMappings": { + "description": "The block device mapping entries that defines the block devices to attach to the instance at launch.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "type": "array", + "uniqueItems": false + }, + "CpuOptions": { + "additionalProperties": false, + "description": "The CPU options for the instance.", + "properties": { + "CoreCount": { + "type": "integer" + }, + "ThreadsPerCore": { + "type": "integer" + } + }, + "type": "object" + }, + "CreditSpecification": { + "additionalProperties": false, + "description": "The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.", + "properties": { + "CPUCredits": { + "type": "string" + } + }, + "type": "object" + }, + "DisableApiTermination": { + "description": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.", + "type": "boolean" + }, + "EbsOptimized": { + "description": "Indicates whether the instance is optimized for Amazon EBS I/O.", + "type": "boolean" + }, + "ElasticGpuSpecifications": { + "description": "An elastic GPU to associate with the instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ElasticGpuSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "ElasticInferenceAccelerators": { + "description": "An elastic inference accelerator to associate with the instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ElasticInferenceAccelerator" + }, + "type": "array", + "uniqueItems": false + }, + "EnclaveOptions": { + "additionalProperties": false, + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", + "properties": { + "Enabled": { + "description": "If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", + "type": "boolean" + } + }, + "type": "object" + }, + "HibernationOptions": { + "additionalProperties": false, + "description": "Indicates whether an instance is enabled for hibernation.", + "properties": { + "Configured": { + "default": false, + "description": "If you set this parameter to true, your instance is enabled for hibernation.", + "type": "boolean" + } + }, + "type": "object" + }, + "HostId": { + "description": "If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.", + "type": "string" + }, + "HostResourceGroupArn": { + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.", + "type": "string" + }, + "IamInstanceProfile": { + "description": "The IAM instance profile.", + "type": "string" + }, + "ImageId": { + "description": "The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.", + "type": "string" + }, + "InstanceId": { + "description": "The EC2 Instance ID.", + "type": "string" + }, + "InstanceInitiatedShutdownBehavior": { + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).", + "type": "string" + }, + "InstanceType": { + "description": "The instance type.", + "type": "string" + }, + "Ipv6AddressCount": { + "description": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.", + "type": "integer" + }, + "Ipv6Addresses": { + "description": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "type": "array", + "uniqueItems": false + }, + "KernelId": { + "description": "The ID of the kernel.", + "type": "string" + }, + "KeyName": { + "description": "The name of the key pair.", + "type": "string" + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "The launch template to use to launch the instances.", + "type": "object" + }, + "LicenseSpecifications": { + "description": "The license configurations.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LicenseSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "Monitoring": { + "description": "Specifies whether detailed monitoring is enabled for the instance.", + "type": "boolean" + }, + "NetworkInterfaces": { + "description": "The network interfaces to associate with the instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "type": "array", + "uniqueItems": false + }, + "PlacementGroupName": { + "description": "The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).", + "type": "string" + }, + "PrivateDnsName": { + "description": "The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.", + "type": "string" + }, + "PrivateDnsNameOptions": { + "$ref": "#/definitions/PrivateDnsNameOptions", + "description": "The options for the instance hostname.", + "type": "object" + }, + "PrivateIp": { + "description": "The private IP address of the specified instance. For example: 10.24.34.0.", + "type": "string" + }, + "PrivateIpAddress": { + "description": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.", + "type": "string" + }, + "PropagateTagsToVolumeOnCreation": { + "description": "Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.", + "type": "boolean" + }, + "PublicDnsName": { + "description": "The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.", + "type": "string" + }, + "PublicIp": { + "description": "The public IP address of the specified instance. For example: 192.0.2.0.", + "type": "string" + }, + "RamdiskId": { + "description": "The ID of the RAM disk to select.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "The IDs of the security groups.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroups": { + "description": "the names of the security groups. For a nondefault VPC, you must use security group IDs instead.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceDestCheck": { + "description": "Specifies whether to enable an instance launched in a VPC to perform NAT.", + "type": "boolean" + }, + "SsmAssociations": { + "description": "The SSM document and parameter values in AWS Systems Manager to associate with this instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SsmAssociation" + }, + "type": "array", + "uniqueItems": false + }, + "State": { + "$ref": "#/definitions/State", + "description": "The current state of the instance.", + "type": "object" + }, + "SubnetId": { + "description": "[EC2-VPC] The ID of the subnet to launch the instance into.\n\n", + "type": "string" + }, + "Tags": { + "description": "The tags to add to the instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Tenancy": { + "description": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.", + "type": "string" + }, + "UserData": { + "description": "The user data to make available to the instance.", + "type": "string" + }, + "Volumes": { + "description": "The volumes to attach to the instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Volume" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC that the instance is running in.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/InstanceId", + "/properties/PrivateIp", + "/properties/PublicDnsName", + "/properties/PublicIp", + "/properties/PrivateDnsName", + "/properties/VpcId", + "/properties/State" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::Instance", + "writeOnlyProperties": [ + "/properties/BlockDeviceMappings/*/NoDevice", + "/properties/BlockDeviceMappings/*/VirtualName", + "/properties/LicenseSpecification", + "/properties/AdditionalInfo", + "/properties/Ipv6AddressCount", + "/properties/Ipv6Addresses", + "/properties/PropagateTagsToVolumeOnCreation", + "/properties/LaunchTemplate" + ] +} diff --git a/schema/aws-ec2-instanceconnectendpoint.json b/schema/aws-ec2-instanceconnectendpoint.json index 95a195e..fccfa0f 100644 --- a/schema/aws-ec2-instanceconnectendpoint.json +++ b/schema/aws-ec2-instanceconnectendpoint.json @@ -1,124 +1,124 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetId", - "/properties/ClientToken", - "/properties/PreserveClientIp", - "/properties/SecurityGroupIds" - ], - "definitions": { - "SecurityGroupId": { - "description": "A key-value pair to associate with a resource.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::InstanceConnectEndpoint", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateInstanceConnectEndpoint", - "ec2:DescribeInstanceConnectEndpoints", - "ec2:CreateTags", - "ec2:CreateNetworkInterface", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteInstanceConnectEndpoint", - "ec2:DescribeInstanceConnectEndpoints" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeInstanceConnectEndpoints" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeInstanceConnectEndpoints" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeInstanceConnectEndpoints", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ClientToken": { - "description": "The client token of the instance connect endpoint.", - "type": "string" - }, - "Id": { - "description": "The id of the instance connect endpoint", - "type": "string" - }, - "PreserveClientIp": { - "description": "If true, the address of the instance connect endpoint client is preserved when connecting to the end resource", - "type": "boolean" - }, - "SecurityGroupIds": { - "description": "The security group IDs of the instance connect endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetId": { - "description": "The subnet id of the instance connect endpoint", - "type": "string" - }, - "Tags": { - "description": "The tags of the instance connect endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::InstanceConnectEndpoint", - "writeOnlyProperties": [ - "/properties/ClientToken" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetId", + "/properties/ClientToken", + "/properties/PreserveClientIp", + "/properties/SecurityGroupIds" + ], + "definitions": { + "SecurityGroupId": { + "description": "A key-value pair to associate with a resource.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::InstanceConnectEndpoint", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateInstanceConnectEndpoint", + "ec2:DescribeInstanceConnectEndpoints", + "ec2:CreateTags", + "ec2:CreateNetworkInterface", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteInstanceConnectEndpoint", + "ec2:DescribeInstanceConnectEndpoints" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeInstanceConnectEndpoints" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeInstanceConnectEndpoints" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeInstanceConnectEndpoints", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ClientToken": { + "description": "The client token of the instance connect endpoint.", + "type": "string" + }, + "Id": { + "description": "The id of the instance connect endpoint", + "type": "string" + }, + "PreserveClientIp": { + "description": "If true, the address of the instance connect endpoint client is preserved when connecting to the end resource", + "type": "boolean" + }, + "SecurityGroupIds": { + "description": "The security group IDs of the instance connect endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetId": { + "description": "The subnet id of the instance connect endpoint", + "type": "string" + }, + "Tags": { + "description": "The tags of the instance connect endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::InstanceConnectEndpoint", + "writeOnlyProperties": [ + "/properties/ClientToken" + ] +} diff --git a/schema/aws-ec2-internetgateway.json b/schema/aws-ec2-internetgateway.json index 1c7b793..8660f0c 100644 --- a/schema/aws-ec2-internetgateway.json +++ b/schema/aws-ec2-internetgateway.json @@ -1,90 +1,94 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag value.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateInternetGateway", - "ec2:CreateTags", - "ec2:DescribeInternetGateways" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteInternetGateway", - "ec2:DescribeInternetGateways" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeInternetGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeInternetGateways" - ] - }, - "update": { - "permissions": [ - "ec2:DeleteTags", - "ec2:CreateTags", - "ec2:DescribeInternetGateways" - ] - } - }, - "primaryIdentifier": [ - "/properties/InternetGatewayId" - ], - "properties": { - "InternetGatewayId": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "Any tags to assign to the internet gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/InternetGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::InternetGateway" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag value.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateInternetGateway", + "ec2:CreateTags", + "ec2:DescribeInternetGateways" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteInternetGateway", + "ec2:DescribeInternetGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeInternetGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeInternetGateways" + ] + }, + "update": { + "permissions": [ + "ec2:DeleteTags", + "ec2:CreateTags", + "ec2:DescribeInternetGateways" + ] + } + }, + "primaryIdentifier": [ + "/properties/InternetGatewayId" + ], + "properties": { + "InternetGatewayId": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "Any tags to assign to the internet gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/InternetGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::InternetGateway" +} diff --git a/schema/aws-ec2-ipam.json b/schema/aws-ec2-ipam.json index 794644a..8462511 100644 --- a/schema/aws-ec2-ipam.json +++ b/schema/aws-ec2-ipam.json @@ -1,165 +1,169 @@ -{ - "additionalProperties": false, - "definitions": { - "IpamOperatingRegion": { - "additionalProperties": false, - "description": "The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring", - "properties": { - "RegionName": { - "description": "The name of the region.", - "type": "string" - } - }, - "required": [ - "RegionName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EC2::IPAM Type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateIpam", - "iam:CreateServiceLinkedRole", - "ec2:CreateTags", - "ec2:DescribeIpams" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteIpam", - "ec2:DeleteTags", - "ec2:DescribeIpams" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeIpams" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeIpams" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyIpam", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeIpams" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamId" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the IPAM.", - "type": "string" - }, - "DefaultResourceDiscoveryAssociationId": { - "description": "The Id of the default association to the default resource discovery, created with this IPAM.", - "type": "string" - }, - "DefaultResourceDiscoveryId": { - "description": "The Id of the default resource discovery, created with this IPAM.", - "type": "string" - }, - "Description": { - "type": "string" - }, - "IpamId": { - "description": "Id of the IPAM.", - "type": "string" - }, - "OperatingRegions": { - "description": "The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IpamOperatingRegion" - }, - "type": "array", - "uniqueItems": true - }, - "PrivateDefaultScopeId": { - "description": "The Id of the default scope for publicly routable IP space, created with this IPAM.", - "type": "string" - }, - "PublicDefaultScopeId": { - "description": "The Id of the default scope for publicly routable IP space, created with this IPAM.", - "maxLength": 255, - "type": "string" - }, - "ResourceDiscoveryAssociationCount": { - "description": "The count of resource discoveries associated with this IPAM.", - "type": "integer" - }, - "ScopeCount": { - "description": "The number of scopes that currently exist in this IPAM.", - "type": "integer" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Tier": { - "description": "The tier of the IPAM.", - "enum": [ - "free", - "advanced" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IpamId", - "/properties/Arn", - "/properties/PublicDefaultScopeId", - "/properties/PrivateDefaultScopeId", - "/properties/ScopeCount", - "/properties/ResourceDiscoveryAssociationCount", - "/properties/DefaultResourceDiscoveryId", - "/properties/DefaultResourceDiscoveryAssociationId" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::IPAM" -} +{ + "additionalProperties": false, + "definitions": { + "IpamOperatingRegion": { + "additionalProperties": false, + "description": "The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring", + "properties": { + "RegionName": { + "description": "The name of the region.", + "type": "string" + } + }, + "required": [ + "RegionName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EC2::IPAM Type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateIpam", + "iam:CreateServiceLinkedRole", + "ec2:CreateTags", + "ec2:DescribeIpams" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteIpam", + "ec2:DeleteTags", + "ec2:DescribeIpams" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeIpams" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeIpams" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyIpam", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeIpams" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamId" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the IPAM.", + "type": "string" + }, + "DefaultResourceDiscoveryAssociationId": { + "description": "The Id of the default association to the default resource discovery, created with this IPAM.", + "type": "string" + }, + "DefaultResourceDiscoveryId": { + "description": "The Id of the default resource discovery, created with this IPAM.", + "type": "string" + }, + "Description": { + "type": "string" + }, + "EnablePrivateGua": { + "description": "Enable provisioning of GUA space in private pools.", + "type": "boolean" + }, + "IpamId": { + "description": "Id of the IPAM.", + "type": "string" + }, + "OperatingRegions": { + "description": "The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IpamOperatingRegion" + }, + "type": "array", + "uniqueItems": true + }, + "PrivateDefaultScopeId": { + "description": "The Id of the default scope for publicly routable IP space, created with this IPAM.", + "type": "string" + }, + "PublicDefaultScopeId": { + "description": "The Id of the default scope for publicly routable IP space, created with this IPAM.", + "maxLength": 255, + "type": "string" + }, + "ResourceDiscoveryAssociationCount": { + "description": "The count of resource discoveries associated with this IPAM.", + "type": "integer" + }, + "ScopeCount": { + "description": "The number of scopes that currently exist in this IPAM.", + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Tier": { + "description": "The tier of the IPAM.", + "enum": [ + "free", + "advanced" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IpamId", + "/properties/Arn", + "/properties/PublicDefaultScopeId", + "/properties/PrivateDefaultScopeId", + "/properties/ScopeCount", + "/properties/ResourceDiscoveryAssociationCount", + "/properties/DefaultResourceDiscoveryId", + "/properties/DefaultResourceDiscoveryAssociationId" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::IPAM" +} diff --git a/schema/aws-ec2-ipamallocation.json b/schema/aws-ec2-ipamallocation.json index a00c72f..96f9222 100644 --- a/schema/aws-ec2-ipamallocation.json +++ b/schema/aws-ec2-ipamallocation.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpamPoolId", - "/properties/Cidr", - "/properties/Description", - "/properties/NetmaskLength" - ], - "definitions": { - "Cidr": { - "description": "Represents an IPAM custom allocation of a single IPv4 or IPv6 CIDR", - "type": "string" - } - }, - "description": "Resource Schema of AWS::EC2::IPAMAllocation Type", - "handlers": { - "create": { - "permissions": [ - "ec2:AllocateIpamPoolCidr", - "ec2:GetIpamPoolAllocations" - ] - }, - "delete": { - "permissions": [ - "ec2:ReleaseIpamPoolAllocation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "IpamPoolId": { - "$ref": "resource-schema.json#/properties/IpamPoolId" - } - }, - "required": [ - "IpamPoolId" - ] - }, - "permissions": [ - "ec2:GetIpamPoolAllocations" - ] - }, - "read": { - "permissions": [ - "ec2:GetIpamPoolAllocations" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamPoolId", - "/properties/IpamPoolAllocationId", - "/properties/Cidr" - ], - "properties": { - "Cidr": { - "$ref": "#/definitions/Cidr" - }, - "Description": { - "type": "string" - }, - "IpamPoolAllocationId": { - "description": "Id of the allocation.", - "type": "string" - }, - "IpamPoolId": { - "description": "Id of the IPAM Pool.", - "type": "string" - }, - "NetmaskLength": { - "description": "The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.", - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/IpamPoolAllocationId" - ], - "required": [ - "IpamPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::IPAMAllocation", - "writeOnlyProperties": [ - "/properties/NetmaskLength" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpamPoolId", + "/properties/Cidr", + "/properties/Description", + "/properties/NetmaskLength" + ], + "definitions": { + "Cidr": { + "description": "Represents an IPAM custom allocation of a single IPv4 or IPv6 CIDR", + "type": "string" + } + }, + "description": "Resource Schema of AWS::EC2::IPAMAllocation Type", + "handlers": { + "create": { + "permissions": [ + "ec2:AllocateIpamPoolCidr", + "ec2:GetIpamPoolAllocations" + ] + }, + "delete": { + "permissions": [ + "ec2:ReleaseIpamPoolAllocation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IpamPoolId": { + "$ref": "resource-schema.json#/properties/IpamPoolId" + } + }, + "required": [ + "IpamPoolId" + ] + }, + "permissions": [ + "ec2:GetIpamPoolAllocations" + ] + }, + "read": { + "permissions": [ + "ec2:GetIpamPoolAllocations" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamPoolId", + "/properties/IpamPoolAllocationId", + "/properties/Cidr" + ], + "properties": { + "Cidr": { + "$ref": "#/definitions/Cidr" + }, + "Description": { + "type": "string" + }, + "IpamPoolAllocationId": { + "description": "Id of the allocation.", + "type": "string" + }, + "IpamPoolId": { + "description": "Id of the IPAM Pool.", + "type": "string" + }, + "NetmaskLength": { + "description": "The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.", + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/IpamPoolAllocationId" + ], + "required": [ + "IpamPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::IPAMAllocation", + "writeOnlyProperties": [ + "/properties/NetmaskLength" + ] +} diff --git a/schema/aws-ec2-ipampool.json b/schema/aws-ec2-ipampool.json index 0d30fb1..f9a6b9f 100644 --- a/schema/aws-ec2-ipampool.json +++ b/schema/aws-ec2-ipampool.json @@ -1,282 +1,282 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpamScopeId", - "/properties/SourceIpamPoolId", - "/properties/Locale", - "/properties/AddressFamily", - "/properties/PubliclyAdvertisable", - "/properties/PublicIpSource", - "/properties/AwsService", - "/properties/SourceResource" - ], - "definitions": { - "Cidr": { - "description": "Represents a single IPv4 or IPv6 CIDR", - "type": "string" - }, - "ProvisionedCidr": { - "additionalProperties": false, - "description": "An address space to be inserted into this pool. All allocations must be made from this address space.", - "properties": { - "Cidr": { - "$ref": "#/definitions/Cidr" - } - }, - "required": [ - "Cidr" - ], - "type": "object" - }, - "SourceResource": { - "additionalProperties": false, - "description": "The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations", - "properties": { - "ResourceId": { - "type": "string" - }, - "ResourceOwner": { - "type": "string" - }, - "ResourceRegion": { - "type": "string" - }, - "ResourceType": { - "type": "string" - } - }, - "required": [ - "ResourceId", - "ResourceType", - "ResourceRegion", - "ResourceOwner" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EC2::IPAMPool Type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateIpamPool", - "ec2:DescribeIpamPools", - "ec2:ProvisionIpamPoolCidr", - "ec2:GetIpamPoolCidrs", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteIpamPool", - "ec2:DescribeIpamPools", - "ec2:GetIpamPoolCidrs", - "ec2:DeprovisionIpamPoolCidr", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeIpamPools" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeIpamPools", - "ec2:GetIpamPoolCidrs" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyIpamPool", - "ec2:DescribeIpamPools", - "ec2:GetIpamPoolCidrs", - "ec2:ProvisionIpamPoolCidr", - "ec2:DeprovisionIpamPoolCidr", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamPoolId" - ], - "properties": { - "AddressFamily": { - "description": "The address family of the address space in this pool. Either IPv4 or IPv6.", - "type": "string" - }, - "AllocationDefaultNetmaskLength": { - "description": "The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.", - "type": "integer" - }, - "AllocationMaxNetmaskLength": { - "description": "The maximum allowed netmask length for allocations made from this pool.", - "type": "integer" - }, - "AllocationMinNetmaskLength": { - "description": "The minimum allowed netmask length for allocations made from this pool.", - "type": "integer" - }, - "AllocationResourceTags": { - "description": "When specified, an allocation will not be allowed unless a resource has a matching set of tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the IPAM Pool.", - "type": "string" - }, - "AutoImport": { - "description": "Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.", - "type": "boolean" - }, - "AwsService": { - "description": "Limits which service in Amazon Web Services that the pool can be used in.", - "enum": [ - "ec2" - ], - "type": "string" - }, - "Description": { - "type": "string" - }, - "IpamArn": { - "description": "The Amazon Resource Name (ARN) of the IPAM this pool is a part of.", - "type": "string" - }, - "IpamPoolId": { - "description": "Id of the IPAM Pool.", - "type": "string" - }, - "IpamScopeArn": { - "description": "The Amazon Resource Name (ARN) of the scope this pool is a part of.", - "type": "string" - }, - "IpamScopeId": { - "description": "The Id of the scope this pool is a part of.", - "type": "string" - }, - "IpamScopeType": { - "description": "Determines whether this scope contains publicly routable space or space for a private network", - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "Locale": { - "description": "The region of this pool. If not set, this will default to \"None\" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.", - "type": "string" - }, - "PoolDepth": { - "description": "The depth of this pool in the source pool hierarchy.", - "type": "integer" - }, - "ProvisionedCidrs": { - "description": "A list of cidrs representing the address space available for allocation in this pool.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ProvisionedCidr" - }, - "type": "array", - "uniqueItems": true - }, - "PublicIpSource": { - "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.", - "enum": [ - "byoip", - "amazon" - ], - "type": "string" - }, - "PubliclyAdvertisable": { - "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.", - "type": "boolean" - }, - "SourceIpamPoolId": { - "description": "The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.", - "type": "string" - }, - "SourceResource": { - "$ref": "#/definitions/SourceResource" - }, - "State": { - "description": "The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\"", - "enum": [ - "create-in-progress", - "create-complete", - "modify-in-progress", - "modify-complete", - "delete-in-progress", - "delete-complete" - ], - "type": "string" - }, - "StateMessage": { - "description": "An explanation of how the pool arrived at it current state.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/AddressFamily": "$lowercase(AddressFamily)" - }, - "readOnlyProperties": [ - "/properties/IpamPoolId", - "/properties/Arn", - "/properties/IpamScopeArn", - "/properties/IpamScopeType", - "/properties/IpamArn", - "/properties/PoolDepth", - "/properties/State", - "/properties/StateMessage" - ], - "required": [ - "IpamScopeId", - "AddressFamily" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::IPAMPool" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpamScopeId", + "/properties/SourceIpamPoolId", + "/properties/Locale", + "/properties/AddressFamily", + "/properties/PubliclyAdvertisable", + "/properties/PublicIpSource", + "/properties/AwsService", + "/properties/SourceResource" + ], + "definitions": { + "Cidr": { + "description": "Represents a single IPv4 or IPv6 CIDR", + "type": "string" + }, + "ProvisionedCidr": { + "additionalProperties": false, + "description": "An address space to be inserted into this pool. All allocations must be made from this address space.", + "properties": { + "Cidr": { + "$ref": "#/definitions/Cidr" + } + }, + "required": [ + "Cidr" + ], + "type": "object" + }, + "SourceResource": { + "additionalProperties": false, + "description": "The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations", + "properties": { + "ResourceId": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "ResourceRegion": { + "type": "string" + }, + "ResourceType": { + "type": "string" + } + }, + "required": [ + "ResourceId", + "ResourceType", + "ResourceRegion", + "ResourceOwner" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EC2::IPAMPool Type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateIpamPool", + "ec2:DescribeIpamPools", + "ec2:ProvisionIpamPoolCidr", + "ec2:GetIpamPoolCidrs", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteIpamPool", + "ec2:DescribeIpamPools", + "ec2:GetIpamPoolCidrs", + "ec2:DeprovisionIpamPoolCidr", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeIpamPools" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeIpamPools", + "ec2:GetIpamPoolCidrs" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyIpamPool", + "ec2:DescribeIpamPools", + "ec2:GetIpamPoolCidrs", + "ec2:ProvisionIpamPoolCidr", + "ec2:DeprovisionIpamPoolCidr", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamPoolId" + ], + "properties": { + "AddressFamily": { + "description": "The address family of the address space in this pool. Either IPv4 or IPv6.", + "type": "string" + }, + "AllocationDefaultNetmaskLength": { + "description": "The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.", + "type": "integer" + }, + "AllocationMaxNetmaskLength": { + "description": "The maximum allowed netmask length for allocations made from this pool.", + "type": "integer" + }, + "AllocationMinNetmaskLength": { + "description": "The minimum allowed netmask length for allocations made from this pool.", + "type": "integer" + }, + "AllocationResourceTags": { + "description": "When specified, an allocation will not be allowed unless a resource has a matching set of tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the IPAM Pool.", + "type": "string" + }, + "AutoImport": { + "description": "Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.", + "type": "boolean" + }, + "AwsService": { + "description": "Limits which service in Amazon Web Services that the pool can be used in.", + "enum": [ + "ec2" + ], + "type": "string" + }, + "Description": { + "type": "string" + }, + "IpamArn": { + "description": "The Amazon Resource Name (ARN) of the IPAM this pool is a part of.", + "type": "string" + }, + "IpamPoolId": { + "description": "Id of the IPAM Pool.", + "type": "string" + }, + "IpamScopeArn": { + "description": "The Amazon Resource Name (ARN) of the scope this pool is a part of.", + "type": "string" + }, + "IpamScopeId": { + "description": "The Id of the scope this pool is a part of.", + "type": "string" + }, + "IpamScopeType": { + "description": "Determines whether this scope contains publicly routable space or space for a private network", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "Locale": { + "description": "The region of this pool. If not set, this will default to \"None\" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.", + "type": "string" + }, + "PoolDepth": { + "description": "The depth of this pool in the source pool hierarchy.", + "type": "integer" + }, + "ProvisionedCidrs": { + "description": "A list of cidrs representing the address space available for allocation in this pool.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ProvisionedCidr" + }, + "type": "array", + "uniqueItems": true + }, + "PublicIpSource": { + "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.", + "enum": [ + "byoip", + "amazon" + ], + "type": "string" + }, + "PubliclyAdvertisable": { + "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.", + "type": "boolean" + }, + "SourceIpamPoolId": { + "description": "The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.", + "type": "string" + }, + "SourceResource": { + "$ref": "#/definitions/SourceResource" + }, + "State": { + "description": "The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\"", + "enum": [ + "create-in-progress", + "create-complete", + "modify-in-progress", + "modify-complete", + "delete-in-progress", + "delete-complete" + ], + "type": "string" + }, + "StateMessage": { + "description": "An explanation of how the pool arrived at it current state.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/AddressFamily": "$lowercase(AddressFamily)" + }, + "readOnlyProperties": [ + "/properties/IpamPoolId", + "/properties/Arn", + "/properties/IpamScopeArn", + "/properties/IpamScopeType", + "/properties/IpamArn", + "/properties/PoolDepth", + "/properties/State", + "/properties/StateMessage" + ], + "required": [ + "IpamScopeId", + "AddressFamily" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::IPAMPool" +} diff --git a/schema/aws-ec2-ipampoolcidr.json b/schema/aws-ec2-ipampoolcidr.json index 27bbb11..1a6983a 100644 --- a/schema/aws-ec2-ipampoolcidr.json +++ b/schema/aws-ec2-ipampoolcidr.json @@ -1,84 +1,84 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpamPoolId", - "/properties/Cidr", - "/properties/NetmaskLength" - ], - "description": "Resource Schema of AWS::EC2::IPAMPoolCidr Type", - "handlers": { - "create": { - "permissions": [ - "ec2:ProvisionIpamPoolCidr", - "ec2:GetIpamPoolCidrs" - ] - }, - "delete": { - "permissions": [ - "ec2:DeprovisionIpamPoolCidr", - "ec2:GetIpamPoolCidrs" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "IpamPoolId": { - "$ref": "resource-schema.json#/properties/IpamPoolId" - } - }, - "required": [ - "IpamPoolId" - ] - }, - "permissions": [ - "ec2:GetIpamPoolCidrs" - ] - }, - "read": { - "permissions": [ - "ec2:GetIpamPoolCidrs" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamPoolId", - "/properties/IpamPoolCidrId" - ], - "properties": { - "Cidr": { - "description": "Represents a single IPv4 or IPv6 CIDR", - "type": "string" - }, - "IpamPoolCidrId": { - "description": "Id of the IPAM Pool Cidr.", - "type": "string" - }, - "IpamPoolId": { - "description": "Id of the IPAM Pool.", - "type": "string" - }, - "NetmaskLength": { - "description": "The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.", - "type": "integer" - }, - "State": { - "description": "Provisioned state of the cidr.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IpamPoolCidrId", - "/properties/State" - ], - "required": [ - "IpamPoolId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::IPAMPoolCidr" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpamPoolId", + "/properties/Cidr", + "/properties/NetmaskLength" + ], + "description": "Resource Schema of AWS::EC2::IPAMPoolCidr Type", + "handlers": { + "create": { + "permissions": [ + "ec2:ProvisionIpamPoolCidr", + "ec2:GetIpamPoolCidrs" + ] + }, + "delete": { + "permissions": [ + "ec2:DeprovisionIpamPoolCidr", + "ec2:GetIpamPoolCidrs" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IpamPoolId": { + "$ref": "resource-schema.json#/properties/IpamPoolId" + } + }, + "required": [ + "IpamPoolId" + ] + }, + "permissions": [ + "ec2:GetIpamPoolCidrs" + ] + }, + "read": { + "permissions": [ + "ec2:GetIpamPoolCidrs" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamPoolId", + "/properties/IpamPoolCidrId" + ], + "properties": { + "Cidr": { + "description": "Represents a single IPv4 or IPv6 CIDR", + "type": "string" + }, + "IpamPoolCidrId": { + "description": "Id of the IPAM Pool Cidr.", + "type": "string" + }, + "IpamPoolId": { + "description": "Id of the IPAM Pool.", + "type": "string" + }, + "NetmaskLength": { + "description": "The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.", + "type": "integer" + }, + "State": { + "description": "Provisioned state of the cidr.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IpamPoolCidrId", + "/properties/State" + ], + "required": [ + "IpamPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::IPAMPoolCidr" +} diff --git a/schema/aws-ec2-ipamresourcediscovery.json b/schema/aws-ec2-ipamresourcediscovery.json index fa97a5f..59e19d6 100644 --- a/schema/aws-ec2-ipamresourcediscovery.json +++ b/schema/aws-ec2-ipamresourcediscovery.json @@ -1,146 +1,146 @@ -{ - "additionalProperties": false, - "definitions": { - "IpamOperatingRegion": { - "additionalProperties": false, - "description": "The regions IPAM Resource Discovery is enabled for. Allows for monitoring.", - "properties": { - "RegionName": { - "description": "The name of the region.", - "type": "string" - } - }, - "required": [ - "RegionName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EC2::IPAMResourceDiscovery Type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateIpamResourceDiscovery", - "ec2:DescribeIpamResourceDiscoveries", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteIpamResourceDiscovery", - "ec2:DescribeIpamResourceDiscoveries", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeIpamResourceDiscoveries" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeIpamResourceDiscoveries" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyIpamResourceDiscovery", - "ec2:DescribeIpamResourceDiscoveries", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamResourceDiscoveryId" - ], - "properties": { - "Description": { - "type": "string" - }, - "IpamResourceDiscoveryArn": { - "description": "Amazon Resource Name (Arn) for the Resource Discovery.", - "type": "string" - }, - "IpamResourceDiscoveryId": { - "description": "Id of the IPAM Pool.", - "type": "string" - }, - "IpamResourceDiscoveryRegion": { - "description": "The region the resource discovery is setup in. ", - "type": "string" - }, - "IsDefault": { - "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.", - "type": "boolean" - }, - "OperatingRegions": { - "description": "The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IpamOperatingRegion" - }, - "type": "array", - "uniqueItems": true - }, - "OwnerId": { - "description": "Owner Account ID of the Resource Discovery", - "type": "string" - }, - "State": { - "description": "The state of this Resource Discovery.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": {}, - "readOnlyProperties": [ - "/properties/IpamResourceDiscoveryId", - "/properties/IpamResourceDiscoveryArn", - "/properties/OwnerId", - "/properties/IpamResourceDiscoveryRegion", - "/properties/IsDefault", - "/properties/State" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::IPAMResourceDiscovery" -} +{ + "additionalProperties": false, + "definitions": { + "IpamOperatingRegion": { + "additionalProperties": false, + "description": "The regions IPAM Resource Discovery is enabled for. Allows for monitoring.", + "properties": { + "RegionName": { + "description": "The name of the region.", + "type": "string" + } + }, + "required": [ + "RegionName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EC2::IPAMResourceDiscovery Type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateIpamResourceDiscovery", + "ec2:DescribeIpamResourceDiscoveries", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteIpamResourceDiscovery", + "ec2:DescribeIpamResourceDiscoveries", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeIpamResourceDiscoveries" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeIpamResourceDiscoveries" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyIpamResourceDiscovery", + "ec2:DescribeIpamResourceDiscoveries", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamResourceDiscoveryId" + ], + "properties": { + "Description": { + "type": "string" + }, + "IpamResourceDiscoveryArn": { + "description": "Amazon Resource Name (Arn) for the Resource Discovery.", + "type": "string" + }, + "IpamResourceDiscoveryId": { + "description": "Id of the IPAM Pool.", + "type": "string" + }, + "IpamResourceDiscoveryRegion": { + "description": "The region the resource discovery is setup in. ", + "type": "string" + }, + "IsDefault": { + "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.", + "type": "boolean" + }, + "OperatingRegions": { + "description": "The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IpamOperatingRegion" + }, + "type": "array", + "uniqueItems": true + }, + "OwnerId": { + "description": "Owner Account ID of the Resource Discovery", + "type": "string" + }, + "State": { + "description": "The state of this Resource Discovery.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": {}, + "readOnlyProperties": [ + "/properties/IpamResourceDiscoveryId", + "/properties/IpamResourceDiscoveryArn", + "/properties/OwnerId", + "/properties/IpamResourceDiscoveryRegion", + "/properties/IsDefault", + "/properties/State" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::IPAMResourceDiscovery" +} diff --git a/schema/aws-ec2-ipamresourcediscoveryassociation.json b/schema/aws-ec2-ipamresourcediscoveryassociation.json index 6dc1568..77ef4f1 100644 --- a/schema/aws-ec2-ipamresourcediscoveryassociation.json +++ b/schema/aws-ec2-ipamresourcediscoveryassociation.json @@ -1,143 +1,143 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpamId", - "/properties/IpamResourceDiscoveryId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateIpamResourceDiscovery", - "ec2:DescribeIpamResourceDiscoveryAssociations", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateIpamResourceDiscovery", - "ec2:DescribeIpamResourceDiscoveryAssociations", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeIpamResourceDiscoveryAssociations" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeIpamResourceDiscoveryAssociations" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeIpamResourceDiscoveryAssociations", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamResourceDiscoveryAssociationId" - ], - "properties": { - "IpamArn": { - "description": "Arn of the IPAM.", - "type": "string" - }, - "IpamId": { - "description": "The Id of the IPAM this Resource Discovery is associated to.", - "type": "string" - }, - "IpamRegion": { - "description": "The home region of the IPAM.", - "type": "string" - }, - "IpamResourceDiscoveryAssociationArn": { - "description": "The Amazon Resource Name (ARN) of the resource discovery association is a part of.", - "type": "string" - }, - "IpamResourceDiscoveryAssociationId": { - "description": "Id of the IPAM Resource Discovery Association.", - "type": "string" - }, - "IpamResourceDiscoveryId": { - "description": "The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.", - "type": "string" - }, - "IsDefault": { - "description": "If the Resource Discovery Association exists due as part of CreateIpam.", - "type": "boolean" - }, - "OwnerId": { - "description": "The AWS Account ID for the account where the shared IPAM exists.", - "type": "string" - }, - "ResourceDiscoveryStatus": { - "description": "The status of the resource discovery.", - "type": "string" - }, - "State": { - "description": "The operational state of the Resource Discovery Association. Related to Create/Delete activities.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/IpamArn", - "/properties/IpamRegion", - "/properties/IpamResourceDiscoveryAssociationId", - "/properties/IpamResourceDiscoveryAssociationArn", - "/properties/IsDefault", - "/properties/ResourceDiscoveryStatus", - "/properties/State", - "/properties/OwnerId" - ], - "required": [ - "IpamId", - "IpamResourceDiscoveryId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::IPAMResourceDiscoveryAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpamId", + "/properties/IpamResourceDiscoveryId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateIpamResourceDiscovery", + "ec2:DescribeIpamResourceDiscoveryAssociations", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateIpamResourceDiscovery", + "ec2:DescribeIpamResourceDiscoveryAssociations", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeIpamResourceDiscoveryAssociations" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeIpamResourceDiscoveryAssociations" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeIpamResourceDiscoveryAssociations", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamResourceDiscoveryAssociationId" + ], + "properties": { + "IpamArn": { + "description": "Arn of the IPAM.", + "type": "string" + }, + "IpamId": { + "description": "The Id of the IPAM this Resource Discovery is associated to.", + "type": "string" + }, + "IpamRegion": { + "description": "The home region of the IPAM.", + "type": "string" + }, + "IpamResourceDiscoveryAssociationArn": { + "description": "The Amazon Resource Name (ARN) of the resource discovery association is a part of.", + "type": "string" + }, + "IpamResourceDiscoveryAssociationId": { + "description": "Id of the IPAM Resource Discovery Association.", + "type": "string" + }, + "IpamResourceDiscoveryId": { + "description": "The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.", + "type": "string" + }, + "IsDefault": { + "description": "If the Resource Discovery Association exists due as part of CreateIpam.", + "type": "boolean" + }, + "OwnerId": { + "description": "The AWS Account ID for the account where the shared IPAM exists.", + "type": "string" + }, + "ResourceDiscoveryStatus": { + "description": "The status of the resource discovery.", + "type": "string" + }, + "State": { + "description": "The operational state of the Resource Discovery Association. Related to Create/Delete activities.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/IpamArn", + "/properties/IpamRegion", + "/properties/IpamResourceDiscoveryAssociationId", + "/properties/IpamResourceDiscoveryAssociationArn", + "/properties/IsDefault", + "/properties/ResourceDiscoveryStatus", + "/properties/State", + "/properties/OwnerId" + ], + "required": [ + "IpamId", + "IpamResourceDiscoveryId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::IPAMResourceDiscoveryAssociation" +} diff --git a/schema/aws-ec2-ipamscope.json b/schema/aws-ec2-ipamscope.json index 743a6ba..018656a 100644 --- a/schema/aws-ec2-ipamscope.json +++ b/schema/aws-ec2-ipamscope.json @@ -1,135 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpamId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EC2::IPAMScope Type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateIpamScope", - "ec2:DescribeIpamScopes", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteIpamScope", - "ec2:DescribeIpamScopes", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeIpamScopes" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeIpamScopes" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyIpamScope", - "ec2:DescribeIpamScopes", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpamScopeId" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the IPAM scope.", - "type": "string" - }, - "Description": { - "type": "string" - }, - "IpamArn": { - "description": "The Amazon Resource Name (ARN) of the IPAM this scope is a part of.", - "type": "string" - }, - "IpamId": { - "description": "The Id of the IPAM this scope is a part of.", - "type": "string" - }, - "IpamScopeId": { - "description": "Id of the IPAM scope.", - "type": "string" - }, - "IpamScopeType": { - "description": "Determines whether this scope contains publicly routable space or space for a private network", - "enum": [ - "public", - "private" - ], - "type": "string" - }, - "IsDefault": { - "description": "Is this one of the default scopes created with the IPAM.", - "type": "boolean" - }, - "PoolCount": { - "description": "The number of pools that currently exist in this scope.", - "type": "integer" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/IpamScopeId", - "/properties/Arn", - "/properties/IpamArn", - "/properties/IsDefault", - "/properties/PoolCount", - "/properties/IpamScopeType" - ], - "required": [ - "IpamId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::IPAMScope" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpamId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EC2::IPAMScope Type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateIpamScope", + "ec2:DescribeIpamScopes", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteIpamScope", + "ec2:DescribeIpamScopes", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeIpamScopes" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeIpamScopes" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyIpamScope", + "ec2:DescribeIpamScopes", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpamScopeId" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the IPAM scope.", + "type": "string" + }, + "Description": { + "type": "string" + }, + "IpamArn": { + "description": "The Amazon Resource Name (ARN) of the IPAM this scope is a part of.", + "type": "string" + }, + "IpamId": { + "description": "The Id of the IPAM this scope is a part of.", + "type": "string" + }, + "IpamScopeId": { + "description": "Id of the IPAM scope.", + "type": "string" + }, + "IpamScopeType": { + "description": "Determines whether this scope contains publicly routable space or space for a private network", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "IsDefault": { + "description": "Is this one of the default scopes created with the IPAM.", + "type": "boolean" + }, + "PoolCount": { + "description": "The number of pools that currently exist in this scope.", + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/IpamScopeId", + "/properties/Arn", + "/properties/IpamArn", + "/properties/IsDefault", + "/properties/PoolCount", + "/properties/IpamScopeType" + ], + "required": [ + "IpamId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ipam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::IPAMScope" +} diff --git a/schema/aws-ec2-keypair.json b/schema/aws-ec2-keypair.json index 69ffd25..f7286b4 100644 --- a/schema/aws-ec2-keypair.json +++ b/schema/aws-ec2-keypair.json @@ -1,137 +1,137 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/KeyPairId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KeyName", - "/properties/KeyType", - "/properties/KeyFormat", - "/properties/PublicKeyMaterial", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag value.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Specifies a key pair for use with an EC2long instance as follows:\n + To import an existing key pair, include the ``PublicKeyMaterial`` property.\n + To create a new key pair, omit the ``PublicKeyMaterial`` property.\n \n When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.\n When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: ``/ec2/keypair/{key_pair_id}``. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.\n When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateKeyPair", - "ec2:ImportKeyPair", - "ec2:CreateTags", - "ssm:PutParameter" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteKeyPair", - "ssm:DeleteParameter", - "ec2:DescribeKeyPairs" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeKeyPairs" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeKeyPairs" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyName" - ], - "properties": { - "KeyFingerprint": { - "description": "", - "type": "string" - }, - "KeyFormat": { - "default": "pem", - "description": "The format of the key pair.\n Default: ``pem``", - "enum": [ - "pem", - "ppk" - ], - "type": "string" - }, - "KeyName": { - "description": "A unique name for the key pair.\n Constraints: Up to 255 ASCII characters", - "type": "string" - }, - "KeyPairId": { - "description": "", - "type": "string" - }, - "KeyType": { - "default": "rsa", - "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances.\n If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value.\n Default: ``rsa``", - "enum": [ - "rsa", - "ed25519" - ], - "type": "string" - }, - "PublicKeyMaterial": { - "description": "The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created.", - "type": "string" - }, - "Tags": { - "description": "The tags to apply to the key pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/KeyPairId", - "/properties/KeyFingerprint" - ], - "required": [ - "KeyName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "ec2:CreateTags" - ], - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::EC2::KeyPair", - "writeOnlyProperties": [ - "/properties/KeyFormat" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/KeyPairId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KeyName", + "/properties/KeyType", + "/properties/KeyFormat", + "/properties/PublicKeyMaterial", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag value.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Specifies a key pair for use with an EC2long instance as follows:\n + To import an existing key pair, include the ``PublicKeyMaterial`` property.\n + To create a new key pair, omit the ``PublicKeyMaterial`` property.\n \n When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.\n When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: ``/ec2/keypair/{key_pair_id}``. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.\n When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateKeyPair", + "ec2:ImportKeyPair", + "ec2:CreateTags", + "ssm:PutParameter" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteKeyPair", + "ssm:DeleteParameter", + "ec2:DescribeKeyPairs" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeKeyPairs" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeKeyPairs" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyName" + ], + "properties": { + "KeyFingerprint": { + "description": "", + "type": "string" + }, + "KeyFormat": { + "default": "pem", + "description": "The format of the key pair.\n Default: ``pem``", + "enum": [ + "pem", + "ppk" + ], + "type": "string" + }, + "KeyName": { + "description": "A unique name for the key pair.\n Constraints: Up to 255 ASCII characters", + "type": "string" + }, + "KeyPairId": { + "description": "", + "type": "string" + }, + "KeyType": { + "default": "rsa", + "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances.\n If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value.\n Default: ``rsa``", + "enum": [ + "rsa", + "ed25519" + ], + "type": "string" + }, + "PublicKeyMaterial": { + "description": "The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created.", + "type": "string" + }, + "Tags": { + "description": "The tags to apply to the key pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/KeyPairId", + "/properties/KeyFingerprint" + ], + "required": [ + "KeyName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ec2:CreateTags" + ], + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::EC2::KeyPair", + "writeOnlyProperties": [ + "/properties/KeyFormat" + ] +} diff --git a/schema/aws-ec2-launchtemplate.json b/schema/aws-ec2-launchtemplate.json index d71415d..838294e 100644 --- a/schema/aws-ec2-launchtemplate.json +++ b/schema/aws-ec2-launchtemplate.json @@ -1,1148 +1,1148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LaunchTemplateName" - ], - "definitions": { - "AcceleratorCount": { - "additionalProperties": false, - "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.", - "properties": { - "Max": { - "description": "The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``.", - "type": "integer" - }, - "Min": { - "description": "The minimum number of accelerators. To specify no minimum limit, omit this parameter.", - "type": "integer" - } - }, - "type": "object" - }, - "AcceleratorTotalMemoryMiB": { - "additionalProperties": false, - "description": "The minimum and maximum amount of total accelerator memory, in MiB.", - "properties": { - "Max": { - "description": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.", - "type": "integer" - }, - "Min": { - "description": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.", - "type": "integer" - } - }, - "type": "object" - }, - "BaselineEbsBandwidthMbps": { - "additionalProperties": false, - "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.", - "properties": { - "Max": { - "description": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.", - "type": "integer" - }, - "Min": { - "description": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.", - "type": "integer" - } - }, - "type": "object" - }, - "BlockDeviceMapping": { - "additionalProperties": false, - "description": "Specifies a block device mapping for a launch template. You must specify ``DeviceName`` plus exactly one of the following properties: ``Ebs``, ``NoDevice``, or ``VirtualName``.\n ``BlockDeviceMapping`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "DeviceName": { - "description": "The device name (for example, /dev/sdh or xvdh).", - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/Ebs", - "description": "Parameters used to automatically set up EBS volumes when the instance is launched." - }, - "NoDevice": { - "description": "To omit the device from the block device mapping, specify an empty string.", - "type": "string" - }, - "VirtualName": { - "description": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.", - "type": "string" - } - }, - "type": "object" - }, - "CapacityReservationSpecification": { - "additionalProperties": false, - "description": "Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.\n ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "CapacityReservationPreference": { - "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.", - "type": "string" - }, - "CapacityReservationTarget": { - "$ref": "#/definitions/CapacityReservationTarget", - "description": "Information about the target Capacity Reservation or Capacity Reservation group." - } - }, - "type": "object" - }, - "CapacityReservationTarget": { - "additionalProperties": false, - "description": "Specifies a target Capacity Reservation.\n ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.", - "properties": { - "CapacityReservationId": { - "description": "The ID of the Capacity Reservation in which to run the instance.", - "type": "string" - }, - "CapacityReservationResourceGroupArn": { - "description": "The ARN of the Capacity Reservation resource group in which to run the instance.", - "type": "string" - } - }, - "type": "object" - }, - "ConnectionTrackingSpecification": { - "additionalProperties": false, - "description": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.", - "properties": { - "TcpEstablishedTimeout": { - "description": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.", - "type": "integer" - }, - "UdpStreamTimeout": { - "description": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.", - "type": "integer" - }, - "UdpTimeout": { - "description": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.", - "type": "integer" - } - }, - "type": "object" - }, - "CpuOptions": { - "additionalProperties": false, - "description": "Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*.\n ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "AmdSevSnp": { - "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).", - "enum": [ - "enabled", - "disabled" - ], - "type": "string" - }, - "CoreCount": { - "description": "The number of CPU cores for the instance.", - "type": "integer" - }, - "ThreadsPerCore": { - "description": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``.", - "type": "integer" - } - }, - "type": "object" - }, - "CreditSpecification": { - "additionalProperties": false, - "description": "Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "CpuCredits": { - "description": "The credit option for CPU usage of a T instance.\n Valid values: ``standard`` | ``unlimited``", - "type": "string" - } - }, - "type": "object" - }, - "Ebs": { - "additionalProperties": false, - "description": "Parameters for a block device for an EBS volume in an Amazon EC2 launch template.\n ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html).", - "properties": { - "DeleteOnTermination": { - "description": "Indicates whether the EBS volume is deleted on instance termination.", - "type": "boolean" - }, - "Encrypted": { - "description": "Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.", - "type": "boolean" - }, - "Iops": { - "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type:\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.\n This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption.", - "type": "string" - }, - "SnapshotId": { - "description": "The ID of the snapshot.", - "type": "string" - }, - "Throughput": { - "description": "The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s.\n Valid Range: Minimum value of 125. Maximum value of 1000.", - "type": "integer" - }, - "VolumeSize": { - "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 GiB\n + ``io1``: 4 - 16,384 GiB\n + ``io2``: 4 - 65,536 GiB\n + ``st1`` and ``sc1``: 125 - 16,384 GiB\n + ``standard``: 1 - 1024 GiB", - "type": "integer" - }, - "VolumeType": { - "description": "The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "ElasticGpuSpecification": { - "additionalProperties": false, - "description": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.\n Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.\n ``ElasticGpuSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Type": { - "description": "The type of Elastic Graphics accelerator.", - "type": "string" - } - }, - "type": "object" - }, - "EnaSrdSpecification": { - "additionalProperties": false, - "description": "ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.", - "properties": { - "EnaSrdEnabled": { - "description": "Indicates whether ENA Express is enabled for the network interface.", - "type": "boolean" - }, - "EnaSrdUdpSpecification": { - "$ref": "#/definitions/EnaSrdUdpSpecification", - "description": "Configures ENA Express for UDP network traffic." - } - }, - "type": "object" - }, - "EnaSrdUdpSpecification": { - "additionalProperties": false, - "description": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.", - "properties": { - "EnaSrdUdpEnabled": { - "description": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.", - "type": "boolean" - } - }, - "type": "object" - }, - "EnclaveOptions": { - "additionalProperties": false, - "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", - "properties": { - "Enabled": { - "description": "If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", - "type": "boolean" - } - }, - "type": "object" - }, - "HibernationOptions": { - "additionalProperties": false, - "description": "Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.\n ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Configured": { - "description": "If you set this parameter to ``true``, the instance is enabled for hibernation.\n Default: ``false``", - "type": "boolean" - } - }, - "type": "object" - }, - "IamInstanceProfile": { - "additionalProperties": false, - "description": "Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.\n If you are creating the launch template for use with an ASlong group, you can specify either the name or the ARN of the instance profile, but not both.\n ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the instance profile.", - "type": "string" - }, - "Name": { - "description": "The name of the instance profile.", - "type": "string" - } - }, - "type": "object" - }, - "InstanceMarketOptions": { - "additionalProperties": false, - "description": "Specifies the market (purchasing) option for an instance.\n ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "MarketType": { - "description": "The market type.", - "type": "string" - }, - "SpotOptions": { - "$ref": "#/definitions/SpotOptions", - "description": "The options for Spot Instances." - } - }, - "type": "object" - }, - "InstanceRequirements": { - "additionalProperties": false, - "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", - "properties": { - "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCount", - "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" - }, - "AcceleratorManufacturers": { - "description": "Indicates whether instance types must have accelerators by specific manufacturers.\n + For instance types with AWS devices, specify ``amazon-web-services``.\n + For instance types with AMD devices, specify ``amd``.\n + For instance types with Habana devices, specify ``habana``.\n + For instance types with NVIDIA devices, specify ``nvidia``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorNames": { - "description": "The accelerators that must be on the instance type.\n + For instance types with NVIDIA A10G GPUs, specify ``a10g``.\n + For instance types with NVIDIA A100 GPUs, specify ``a100``.\n + For instance types with NVIDIA H100 GPUs, specify ``h100``.\n + For instance types with AWS Inferentia chips, specify ``inferentia``.\n + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\n + For instance types with NVIDIA M60 GPUs, specify ``m60``.\n + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n + For instance types with NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA T4G GPUs, specify ``t4g``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n \n Default: Any accelerator", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiB", - "description": "The minimum and maximum amount of total accelerator memory, in MiB.\n Default: No minimum or maximum limits" - }, - "AcceleratorTypes": { - "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowedInstanceTypes": { - "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BareMetal": { - "description": "Indicates whether bare metal instance types must be included, excluded, or required.\n + To include bare metal instance types, specify ``included``.\n + To require only bare metal instance types, specify ``required``.\n + To exclude bare metal instance types, specify ``excluded``.\n \n Default: ``excluded``", - "type": "string" - }, - "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbps", - "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits" - }, - "BurstablePerformance": { - "description": "Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n + To include burstable performance instance types, specify ``included``.\n + To require only burstable performance instance types, specify ``required``.\n + To exclude burstable performance instance types, specify ``excluded``.\n \n Default: ``excluded``", - "type": "string" - }, - "CpuManufacturers": { - "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ExcludedInstanceTypes": { - "description": "The instance types to exclude.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", - "items": { - "description": "The user data to make available to the instance.", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "InstanceGenerations": { - "description": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n For current generation instance types, specify ``current``.\n For previous generation instance types, specify ``previous``.\n Default: Current and previous generation instance types", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LocalStorage": { - "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n + To include instance types with instance store volumes, specify ``included``.\n + To require only instance types with instance store volumes, specify ``required``.\n + To exclude instance types with instance store volumes, specify ``excluded``.\n \n Default: ``included``", - "type": "string" - }, - "LocalStorageTypes": { - "description": "The type of local storage that is required.\n + For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n + For instance types with solid state drive (SSD) storage, specify ``ssd``.\n \n Default: ``hdd`` and ``ssd``", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { - "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", - "type": "integer" - }, - "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpu", - "description": "The minimum and maximum amount of memory per vCPU, in GiB.\n Default: No minimum or maximum limits" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiB", - "description": "The minimum and maximum amount of memory, in MiB." - }, - "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbps", - "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" - }, - "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCount", - "description": "The minimum and maximum number of network interfaces.\n Default: No minimum or maximum limits" - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n Default: ``20``", - "type": "integer" - }, - "RequireHibernateSupport": { - "description": "Indicates whether instance types must support hibernation for On-Demand Instances.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\n Default: ``false``", - "type": "boolean" - }, - "SpotMaxPricePercentageOverLowestPrice": { - "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.\n Default: ``100``", - "type": "integer" - }, - "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGB", - "description": "The minimum and maximum amount of total local storage, in GB.\n Default: No minimum or maximum limits" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCount", - "description": "The minimum and maximum number of vCPUs." - } - }, - "type": "object" - }, - "Ipv4PrefixSpecification": { - "additionalProperties": false, - "description": "Specifies an IPv4 prefix for a network interface.\n ``Ipv4PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", - "properties": { - "Ipv4Prefix": { - "description": "The IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "Ipv6Add": { - "additionalProperties": false, - "description": "Specifies an IPv6 address in an Amazon EC2 launch template.\n ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", - "properties": { - "Ipv6Address": { - "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", - "type": "string" - } - }, - "type": "object" - }, - "Ipv6PrefixSpecification": { - "additionalProperties": false, - "description": "Specifies an IPv6 prefix for a network interface.\n ``Ipv6PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", - "properties": { - "Ipv6Prefix": { - "description": "The IPv6 prefix.", - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplateData": { - "additionalProperties": false, - "description": "The information to include in the launch template.\n You must specify at least one parameter for the launch template data.", - "properties": { - "BlockDeviceMappings": { - "description": "The block device mapping.", - "items": { - "$ref": "#/definitions/BlockDeviceMapping" - }, - "type": "array", - "uniqueItems": false - }, - "CapacityReservationSpecification": { - "$ref": "#/definitions/CapacityReservationSpecification", - "description": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)." - }, - "CpuOptions": { - "$ref": "#/definitions/CpuOptions", - "description": "The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide*." - }, - "CreditSpecification": { - "$ref": "#/definitions/CreditSpecification", - "description": "The credit option for CPU usage of the instance. Valid only for T instances." - }, - "DisableApiStop": { - "description": "Indicates whether to enable the instance for stop protection. For more information, see [Enable stop protection for your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the *Amazon EC2 User Guide*.", - "type": "boolean" - }, - "DisableApiTermination": { - "description": "If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance.", - "type": "boolean" - }, - "EbsOptimized": { - "description": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.", - "type": "boolean" - }, - "ElasticGpuSpecifications": { - "description": "Deprecated.\n Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.", - "items": { - "$ref": "#/definitions/ElasticGpuSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "ElasticInferenceAccelerators": { - "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", - "items": { - "$ref": "#/definitions/LaunchTemplateElasticInferenceAccelerator" - }, - "type": "array", - "uniqueItems": false - }, - "EnclaveOptions": { - "$ref": "#/definitions/EnclaveOptions", - "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.\n You can't enable AWS Nitro Enclaves and hibernation on the same instance." - }, - "HibernationOptions": { - "$ref": "#/definitions/HibernationOptions", - "description": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*." - }, - "IamInstanceProfile": { - "$ref": "#/definitions/IamInstanceProfile", - "description": "The name or Amazon Resource Name (ARN) of an IAM instance profile." - }, - "ImageId": { - "description": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.\n Valid formats:\n + ``ami-17characters00000`` \n + ``resolve:ssm:parameter-name`` \n + ``resolve:ssm:parameter-name:version-number`` \n + ``resolve:ssm:parameter-name:label`` \n \n For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*.", - "type": "string" - }, - "InstanceInitiatedShutdownBehavior": { - "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n Default: ``stop``", - "type": "string" - }, - "InstanceMarketOptions": { - "$ref": "#/definitions/InstanceMarketOptions", - "description": "The market (purchasing) option for the instances." - }, - "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirements", - "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." - }, - "InstanceType": { - "description": "The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n If you specify ``InstanceType``, you can't specify ``InstanceRequirements``.", - "type": "string" - }, - "KernelId": { - "description": "The ID of the kernel.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.", - "type": "string" - }, - "KeyName": { - "description": "The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.", - "type": "string" - }, - "LicenseSpecifications": { - "description": "The license configurations.", - "items": { - "$ref": "#/definitions/LicenseSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "MaintenanceOptions": { - "$ref": "#/definitions/MaintenanceOptions", - "description": "The maintenance options of your instance." - }, - "MetadataOptions": { - "$ref": "#/definitions/MetadataOptions", - "description": "The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*." - }, - "Monitoring": { - "$ref": "#/definitions/Monitoring", - "description": "The monitoring for the instance." - }, - "NetworkInterfaces": { - "description": "The network interfaces for the instance.", - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "type": "array", - "uniqueItems": false - }, - "Placement": { - "$ref": "#/definitions/Placement", - "description": "The placement for the instance." - }, - "PrivateDnsNameOptions": { - "$ref": "#/definitions/PrivateDnsNameOptions", - "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*." - }, - "RamDiskId": { - "description": "The ID of the RAM disk.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.", - "type": "string" - }, - "SecurityGroupIds": { - "description": "The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.\n If you specify a network interface, you must specify any security groups as part of the network interface instead.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroups": { - "description": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.\n If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "TagSpecifications": { - "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", - "items": { - "$ref": "#/definitions/TagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "UserData": { - "description": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplateElasticInferenceAccelerator": { - "additionalProperties": false, - "description": "Specifies an elastic inference accelerator.\n ``LaunchTemplateElasticInferenceAccelerator`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Count": { - "description": "The number of elastic inference accelerators to attach to the instance. \n Default: 1", - "type": "integer" - }, - "Type": { - "description": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.", - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplateTagSpecification": { - "additionalProperties": false, - "description": "Specifies the tags to apply to the launch template during creation.\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", - "properties": { - "ResourceType": { - "description": "The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``.", - "type": "string" - }, - "Tags": { - "description": "The tags for the resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "LicenseSpecification": { - "additionalProperties": false, - "description": "Specifies a license configuration for an instance.\n ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "LicenseConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the license configuration.", - "type": "string" - } - }, - "type": "object" - }, - "MaintenanceOptions": { - "additionalProperties": false, - "description": "The maintenance options of your instance.", - "properties": { - "AutoRecovery": { - "description": "Disables the automatic recovery behavior of your instance or sets it to default.", - "type": "string" - } - }, - "type": "object" - }, - "MemoryGiBPerVCpu": { - "additionalProperties": false, - "description": "The minimum and maximum amount of memory per vCPU, in GiB.", - "properties": { - "Max": { - "description": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.", - "type": "number" - }, - "Min": { - "description": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.", - "type": "number" - } - }, - "type": "object" - }, - "MemoryMiB": { - "additionalProperties": false, - "description": "The minimum and maximum amount of memory, in MiB.", - "properties": { - "Max": { - "description": "The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.", - "type": "integer" - }, - "Min": { - "description": "The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``.", - "type": "integer" - } - }, - "type": "object" - }, - "MetadataOptions": { - "additionalProperties": false, - "description": "The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.\n ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "HttpEndpoint": { - "description": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.\n If you specify a value of ``disabled``, you will not be able to access your instance metadata.", - "type": "string" - }, - "HttpProtocolIpv6": { - "description": "Enables or disables the IPv6 endpoint for the instance metadata service.\n Default: ``disabled``", - "type": "string" - }, - "HttpPutResponseHopLimit": { - "description": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.\n Default: ``1`` \n Possible values: Integers from 1 to 64", - "type": "integer" - }, - "HttpTokens": { - "description": "Indicates whether IMDSv2 is required.\n + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.\n + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.\n \n Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``.", - "type": "string" - }, - "InstanceMetadataTags": { - "description": "Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\n Default: ``disabled``", - "type": "string" - } - }, - "type": "object" - }, - "Monitoring": { - "additionalProperties": false, - "description": "Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*.\n ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Enabled": { - "description": "Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "NetworkBandwidthGbps": { - "additionalProperties": false, - "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.", - "properties": { - "Max": { - "description": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.", - "type": "number" - }, - "Min": { - "description": "The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.", - "type": "number" - } - }, - "type": "object" - }, - "NetworkInterface": { - "additionalProperties": false, - "description": "Specifies the parameters for a network interface.\n ``NetworkInterface`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "AssociateCarrierIpAddress": { - "description": "Associates a Carrier IP address with eth0 for a new network interface.\n Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*.", - "type": "boolean" - }, - "AssociatePublicIpAddress": { - "description": "Associates a public IPv4 address with eth0 for a new network interface.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", - "type": "boolean" - }, - "ConnectionTrackingSpecification": { - "$ref": "#/definitions/ConnectionTrackingSpecification", - "description": "A connection tracking specification for the network interface." - }, - "DeleteOnTermination": { - "description": "Indicates whether the network interface is deleted when the instance is terminated.", - "type": "boolean" - }, - "Description": { - "description": "A description for the network interface.", - "type": "string" - }, - "DeviceIndex": { - "description": "The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.", - "type": "integer" - }, - "EnaSrdSpecification": { - "$ref": "#/definitions/EnaSrdSpecification", - "description": "The ENA Express configuration for the network interface." - }, - "Groups": { - "description": "The IDs of one or more security groups.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "InterfaceType": { - "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``", - "type": "string" - }, - "Ipv4PrefixCount": { - "description": "The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option.", - "type": "integer" - }, - "Ipv4Prefixes": { - "description": "One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option.", - "items": { - "$ref": "#/definitions/Ipv4PrefixSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "Ipv6AddressCount": { - "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.", - "type": "integer" - }, - "Ipv6Addresses": { - "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", - "items": { - "$ref": "#/definitions/Ipv6Add" - }, - "type": "array", - "uniqueItems": false - }, - "Ipv6PrefixCount": { - "description": "The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option.", - "type": "integer" - }, - "Ipv6Prefixes": { - "description": "One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option.", - "items": { - "$ref": "#/definitions/Ipv6PrefixSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkCardIndex": { - "description": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.", - "type": "integer" - }, - "NetworkInterfaceId": { - "description": "The ID of the network interface.", - "type": "string" - }, - "PrimaryIpv6": { - "description": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).", - "type": "boolean" - }, - "PrivateIpAddress": { - "description": "The primary private IPv4 address of the network interface.", - "type": "string" - }, - "PrivateIpAddresses": { - "description": "One or more private IPv4 addresses.", - "items": { - "$ref": "#/definitions/PrivateIpAdd" - }, - "type": "array", - "uniqueItems": false - }, - "SecondaryPrivateIpAddressCount": { - "description": "The number of secondary private IPv4 addresses to assign to a network interface.", - "type": "integer" - }, - "SubnetId": { - "description": "The ID of the subnet for the network interface.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkInterfaceCount": { - "additionalProperties": false, - "description": "The minimum and maximum number of network interfaces.", - "properties": { - "Max": { - "description": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter.", - "type": "integer" - }, - "Min": { - "description": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.", - "type": "integer" - } - }, - "type": "object" - }, - "Placement": { - "additionalProperties": false, - "description": "Specifies the placement of an instance.\n ``Placement`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "Affinity": { - "description": "The affinity setting for an instance on a Dedicated Host.", - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone for the instance.", - "type": "string" - }, - "GroupId": { - "description": "The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group.", - "type": "string" - }, - "GroupName": { - "description": "The name of the placement group for the instance.", - "type": "string" - }, - "HostId": { - "description": "The ID of the Dedicated Host for the instance.", - "type": "string" - }, - "HostResourceGroupArn": { - "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``.", - "type": "string" - }, - "PartitionNumber": { - "description": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``.", - "type": "integer" - }, - "SpreadDomain": { - "description": "Reserved for future use.", - "type": "string" - }, - "Tenancy": { - "description": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.", - "type": "string" - } - }, - "type": "object" - }, - "PrivateDnsNameOptions": { - "additionalProperties": false, - "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.", - "properties": { - "EnableResourceNameDnsAAAARecord": { - "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.", - "type": "boolean" - }, - "EnableResourceNameDnsARecord": { - "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.", - "type": "boolean" - }, - "HostnameType": { - "description": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "PrivateIpAdd": { - "additionalProperties": false, - "description": "Specifies a secondary private IPv4 address for a network interface.\n ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", - "properties": { - "Primary": { - "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", - "type": "boolean" - }, - "PrivateIpAddress": { - "description": "The private IPv4 address.", - "type": "string" - } - }, - "type": "object" - }, - "SpotOptions": { - "additionalProperties": false, - "description": "Specifies options for Spot Instances.\n ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html).", - "properties": { - "BlockDurationMinutes": { - "description": "Deprecated.", - "type": "integer" - }, - "InstanceInterruptionBehavior": { - "description": "The behavior when a Spot Instance is interrupted. The default is ``terminate``.", - "type": "string" - }, - "MaxPrice": { - "description": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.", - "type": "string" - }, - "SpotInstanceType": { - "description": "The Spot Instance request type.\n If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity.", - "type": "string" - }, - "ValidUntil": { - "description": "The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.\n + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.\n + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.\n \n Default: 7 days from the current date", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagSpecification": { - "additionalProperties": false, - "description": "Specifies the tags to apply to a resource when the resource is created for the launch template.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", - "properties": { - "ResourceType": { - "description": "The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).", - "type": "string" - }, - "Tags": { - "description": "The tags to apply to the resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "TotalLocalStorageGB": { - "additionalProperties": false, - "description": "The minimum and maximum amount of total local storage, in GB.", - "properties": { - "Max": { - "description": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.", - "type": "number" - }, - "Min": { - "description": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.", - "type": "number" - } - }, - "type": "object" - }, - "VCpuCount": { - "additionalProperties": false, - "description": "The minimum and maximum number of vCPUs.", - "properties": { - "Max": { - "description": "The maximum number of vCPUs. To specify no maximum limit, omit this parameter.", - "type": "integer" - }, - "Min": { - "description": "The minimum number of vCPUs. To specify no minimum limit, specify ``0``.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Specifies the properties for creating a launch template.\n The minimum required properties for specifying a launch template are as follows:\n + You must specify at least one property for the launch template data.\n + You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you.\n \n A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.\n For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateLaunchTemplate", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteLaunchTemplate", - "ec2:DeleteTags", - "ec2:DescribeLaunchTemplates" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeLaunchTemplates" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeLaunchTemplates" - ] - }, - "update": { - "permissions": [ - "ec2:CreateLaunchTemplateVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/LaunchTemplateId" - ], - "properties": { - "DefaultVersionNumber": { - "description": "", - "type": "string" - }, - "LatestVersionNumber": { - "description": "", - "type": "string" - }, - "LaunchTemplateData": { - "$ref": "#/definitions/LaunchTemplateData", - "description": "The information for the launch template." - }, - "LaunchTemplateId": { - "description": "", - "type": "string" - }, - "LaunchTemplateName": { - "description": "A name for the launch template.", - "type": "string" - }, - "TagSpecifications": { - "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", - "items": { - "$ref": "#/definitions/LaunchTemplateTagSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "VersionDescription": { - "description": "A description for the first version of the launch template.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DefaultVersionNumber", - "/properties/LaunchTemplateId", - "/properties/LatestVersionNumber" - ], - "required": [ - "LaunchTemplateData" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::LaunchTemplate", - "writeOnlyProperties": [ - "/properties/LaunchTemplateData", - "/properties/VersionDescription", - "/properties/TagSpecifications" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LaunchTemplateName" + ], + "definitions": { + "AcceleratorCount": { + "additionalProperties": false, + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.", + "properties": { + "Max": { + "description": "The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``.", + "type": "integer" + }, + "Min": { + "description": "The minimum number of accelerators. To specify no minimum limit, omit this parameter.", + "type": "integer" + } + }, + "type": "object" + }, + "AcceleratorTotalMemoryMiB": { + "additionalProperties": false, + "description": "The minimum and maximum amount of total accelerator memory, in MiB.", + "properties": { + "Max": { + "description": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.", + "type": "integer" + }, + "Min": { + "description": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.", + "type": "integer" + } + }, + "type": "object" + }, + "BaselineEbsBandwidthMbps": { + "additionalProperties": false, + "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.", + "properties": { + "Max": { + "description": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.", + "type": "integer" + }, + "Min": { + "description": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.", + "type": "integer" + } + }, + "type": "object" + }, + "BlockDeviceMapping": { + "additionalProperties": false, + "description": "Specifies a block device mapping for a launch template. You must specify ``DeviceName`` plus exactly one of the following properties: ``Ebs``, ``NoDevice``, or ``VirtualName``.\n ``BlockDeviceMapping`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "DeviceName": { + "description": "The device name (for example, /dev/sdh or xvdh).", + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/Ebs", + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." + }, + "NoDevice": { + "description": "To omit the device from the block device mapping, specify an empty string.", + "type": "string" + }, + "VirtualName": { + "description": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.", + "type": "string" + } + }, + "type": "object" + }, + "CapacityReservationSpecification": { + "additionalProperties": false, + "description": "Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.\n ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "CapacityReservationPreference": { + "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.", + "type": "string" + }, + "CapacityReservationTarget": { + "$ref": "#/definitions/CapacityReservationTarget", + "description": "Information about the target Capacity Reservation or Capacity Reservation group." + } + }, + "type": "object" + }, + "CapacityReservationTarget": { + "additionalProperties": false, + "description": "Specifies a target Capacity Reservation.\n ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.", + "properties": { + "CapacityReservationId": { + "description": "The ID of the Capacity Reservation in which to run the instance.", + "type": "string" + }, + "CapacityReservationResourceGroupArn": { + "description": "The ARN of the Capacity Reservation resource group in which to run the instance.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionTrackingSpecification": { + "additionalProperties": false, + "description": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.", + "properties": { + "TcpEstablishedTimeout": { + "description": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.", + "type": "integer" + }, + "UdpStreamTimeout": { + "description": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.", + "type": "integer" + }, + "UdpTimeout": { + "description": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.", + "type": "integer" + } + }, + "type": "object" + }, + "CpuOptions": { + "additionalProperties": false, + "description": "Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*.\n ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "AmdSevSnp": { + "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + }, + "CoreCount": { + "description": "The number of CPU cores for the instance.", + "type": "integer" + }, + "ThreadsPerCore": { + "description": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``.", + "type": "integer" + } + }, + "type": "object" + }, + "CreditSpecification": { + "additionalProperties": false, + "description": "Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "CpuCredits": { + "description": "The credit option for CPU usage of a T instance.\n Valid values: ``standard`` | ``unlimited``", + "type": "string" + } + }, + "type": "object" + }, + "Ebs": { + "additionalProperties": false, + "description": "Parameters for a block device for an EBS volume in an Amazon EC2 launch template.\n ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html).", + "properties": { + "DeleteOnTermination": { + "description": "Indicates whether the EBS volume is deleted on instance termination.", + "type": "boolean" + }, + "Encrypted": { + "description": "Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.", + "type": "boolean" + }, + "Iops": { + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type:\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.\n This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption.", + "type": "string" + }, + "SnapshotId": { + "description": "The ID of the snapshot.", + "type": "string" + }, + "Throughput": { + "description": "The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s.\n Valid Range: Minimum value of 125. Maximum value of 1000.", + "type": "integer" + }, + "VolumeSize": { + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 GiB\n + ``io1``: 4 - 16,384 GiB\n + ``io2``: 4 - 65,536 GiB\n + ``st1`` and ``sc1``: 125 - 16,384 GiB\n + ``standard``: 1 - 1024 GiB", + "type": "integer" + }, + "VolumeType": { + "description": "The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "ElasticGpuSpecification": { + "additionalProperties": false, + "description": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.\n Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.\n ``ElasticGpuSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Type": { + "description": "The type of Elastic Graphics accelerator.", + "type": "string" + } + }, + "type": "object" + }, + "EnaSrdSpecification": { + "additionalProperties": false, + "description": "ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.", + "properties": { + "EnaSrdEnabled": { + "description": "Indicates whether ENA Express is enabled for the network interface.", + "type": "boolean" + }, + "EnaSrdUdpSpecification": { + "$ref": "#/definitions/EnaSrdUdpSpecification", + "description": "Configures ENA Express for UDP network traffic." + } + }, + "type": "object" + }, + "EnaSrdUdpSpecification": { + "additionalProperties": false, + "description": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.", + "properties": { + "EnaSrdUdpEnabled": { + "description": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.", + "type": "boolean" + } + }, + "type": "object" + }, + "EnclaveOptions": { + "additionalProperties": false, + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", + "properties": { + "Enabled": { + "description": "If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", + "type": "boolean" + } + }, + "type": "object" + }, + "HibernationOptions": { + "additionalProperties": false, + "description": "Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.\n ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Configured": { + "description": "If you set this parameter to ``true``, the instance is enabled for hibernation.\n Default: ``false``", + "type": "boolean" + } + }, + "type": "object" + }, + "IamInstanceProfile": { + "additionalProperties": false, + "description": "Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.\n If you are creating the launch template for use with an ASlong group, you can specify either the name or the ARN of the instance profile, but not both.\n ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the instance profile.", + "type": "string" + }, + "Name": { + "description": "The name of the instance profile.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceMarketOptions": { + "additionalProperties": false, + "description": "Specifies the market (purchasing) option for an instance.\n ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "MarketType": { + "description": "The market type.", + "type": "string" + }, + "SpotOptions": { + "$ref": "#/definitions/SpotOptions", + "description": "The options for Spot Instances." + } + }, + "type": "object" + }, + "InstanceRequirements": { + "additionalProperties": false, + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCount", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" + }, + "AcceleratorManufacturers": { + "description": "Indicates whether instance types must have accelerators by specific manufacturers.\n + For instance types with AWS devices, specify ``amazon-web-services``.\n + For instance types with AMD devices, specify ``amd``.\n + For instance types with Habana devices, specify ``habana``.\n + For instance types with NVIDIA devices, specify ``nvidia``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorNames": { + "description": "The accelerators that must be on the instance type.\n + For instance types with NVIDIA A10G GPUs, specify ``a10g``.\n + For instance types with NVIDIA A100 GPUs, specify ``a100``.\n + For instance types with NVIDIA H100 GPUs, specify ``h100``.\n + For instance types with AWS Inferentia chips, specify ``inferentia``.\n + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\n + For instance types with NVIDIA M60 GPUs, specify ``m60``.\n + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n + For instance types with NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA T4G GPUs, specify ``t4g``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n \n Default: Any accelerator", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiB", + "description": "The minimum and maximum amount of total accelerator memory, in MiB.\n Default: No minimum or maximum limits" + }, + "AcceleratorTypes": { + "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowedInstanceTypes": { + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BareMetal": { + "description": "Indicates whether bare metal instance types must be included, excluded, or required.\n + To include bare metal instance types, specify ``included``.\n + To require only bare metal instance types, specify ``required``.\n + To exclude bare metal instance types, specify ``excluded``.\n \n Default: ``excluded``", + "type": "string" + }, + "BaselineEbsBandwidthMbps": { + "$ref": "#/definitions/BaselineEbsBandwidthMbps", + "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS\u2013optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits" + }, + "BurstablePerformance": { + "description": "Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n + To include burstable performance instance types, specify ``included``.\n + To require only burstable performance instance types, specify ``required``.\n + To exclude burstable performance instance types, specify ``excluded``.\n \n Default: ``excluded``", + "type": "string" + }, + "CpuManufacturers": { + "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ExcludedInstanceTypes": { + "description": "The instance types to exclude.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", + "items": { + "description": "The user data to make available to the instance.", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "InstanceGenerations": { + "description": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n For current generation instance types, specify ``current``.\n For previous generation instance types, specify ``previous``.\n Default: Current and previous generation instance types", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LocalStorage": { + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n + To include instance types with instance store volumes, specify ``included``.\n + To require only instance types with instance store volumes, specify ``required``.\n + To exclude instance types with instance store volumes, specify ``excluded``.\n \n Default: ``included``", + "type": "string" + }, + "LocalStorageTypes": { + "description": "The type of local storage that is required.\n + For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n + For instance types with solid state drive (SSD) storage, specify ``ssd``.\n \n Default: ``hdd`` and ``ssd``", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", + "type": "integer" + }, + "MemoryGiBPerVCpu": { + "$ref": "#/definitions/MemoryGiBPerVCpu", + "description": "The minimum and maximum amount of memory per vCPU, in GiB.\n Default: No minimum or maximum limits" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiB", + "description": "The minimum and maximum amount of memory, in MiB." + }, + "NetworkBandwidthGbps": { + "$ref": "#/definitions/NetworkBandwidthGbps", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" + }, + "NetworkInterfaceCount": { + "$ref": "#/definitions/NetworkInterfaceCount", + "description": "The minimum and maximum number of network interfaces.\n Default: No minimum or maximum limits" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n Default: ``20``", + "type": "integer" + }, + "RequireHibernateSupport": { + "description": "Indicates whether instance types must support hibernation for On-Demand Instances.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\n Default: ``false``", + "type": "boolean" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.\n Default: ``100``", + "type": "integer" + }, + "TotalLocalStorageGB": { + "$ref": "#/definitions/TotalLocalStorageGB", + "description": "The minimum and maximum amount of total local storage, in GB.\n Default: No minimum or maximum limits" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCount", + "description": "The minimum and maximum number of vCPUs." + } + }, + "type": "object" + }, + "Ipv4PrefixSpecification": { + "additionalProperties": false, + "description": "Specifies an IPv4 prefix for a network interface.\n ``Ipv4PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", + "properties": { + "Ipv4Prefix": { + "description": "The IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "Ipv6Add": { + "additionalProperties": false, + "description": "Specifies an IPv6 address in an Amazon EC2 launch template.\n ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", + "properties": { + "Ipv6Address": { + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", + "type": "string" + } + }, + "type": "object" + }, + "Ipv6PrefixSpecification": { + "additionalProperties": false, + "description": "Specifies an IPv6 prefix for a network interface.\n ``Ipv6PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", + "properties": { + "Ipv6Prefix": { + "description": "The IPv6 prefix.", + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplateData": { + "additionalProperties": false, + "description": "The information to include in the launch template.\n You must specify at least one parameter for the launch template data.", + "properties": { + "BlockDeviceMappings": { + "description": "The block device mapping.", + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "type": "array", + "uniqueItems": false + }, + "CapacityReservationSpecification": { + "$ref": "#/definitions/CapacityReservationSpecification", + "description": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)." + }, + "CpuOptions": { + "$ref": "#/definitions/CpuOptions", + "description": "The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide*." + }, + "CreditSpecification": { + "$ref": "#/definitions/CreditSpecification", + "description": "The credit option for CPU usage of the instance. Valid only for T instances." + }, + "DisableApiStop": { + "description": "Indicates whether to enable the instance for stop protection. For more information, see [Enable stop protection for your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the *Amazon EC2 User Guide*.", + "type": "boolean" + }, + "DisableApiTermination": { + "description": "If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance.", + "type": "boolean" + }, + "EbsOptimized": { + "description": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.", + "type": "boolean" + }, + "ElasticGpuSpecifications": { + "description": "Deprecated.\n Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.", + "items": { + "$ref": "#/definitions/ElasticGpuSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "ElasticInferenceAccelerators": { + "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", + "items": { + "$ref": "#/definitions/LaunchTemplateElasticInferenceAccelerator" + }, + "type": "array", + "uniqueItems": false + }, + "EnclaveOptions": { + "$ref": "#/definitions/EnclaveOptions", + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.\n You can't enable AWS Nitro Enclaves and hibernation on the same instance." + }, + "HibernationOptions": { + "$ref": "#/definitions/HibernationOptions", + "description": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*." + }, + "IamInstanceProfile": { + "$ref": "#/definitions/IamInstanceProfile", + "description": "The name or Amazon Resource Name (ARN) of an IAM instance profile." + }, + "ImageId": { + "description": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.\n Valid formats:\n + ``ami-0ac394d6a3example`` \n + ``resolve:ssm:parameter-name`` \n + ``resolve:ssm:parameter-name:version-number`` \n + ``resolve:ssm:parameter-name:label`` \n \n For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*.", + "type": "string" + }, + "InstanceInitiatedShutdownBehavior": { + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n Default: ``stop``", + "type": "string" + }, + "InstanceMarketOptions": { + "$ref": "#/definitions/InstanceMarketOptions", + "description": "The market (purchasing) option for the instances." + }, + "InstanceRequirements": { + "$ref": "#/definitions/InstanceRequirements", + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." + }, + "InstanceType": { + "description": "The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n If you specify ``InstanceType``, you can't specify ``InstanceRequirements``.", + "type": "string" + }, + "KernelId": { + "description": "The ID of the kernel.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.", + "type": "string" + }, + "KeyName": { + "description": "The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.", + "type": "string" + }, + "LicenseSpecifications": { + "description": "The license configurations.", + "items": { + "$ref": "#/definitions/LicenseSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "MaintenanceOptions": { + "$ref": "#/definitions/MaintenanceOptions", + "description": "The maintenance options of your instance." + }, + "MetadataOptions": { + "$ref": "#/definitions/MetadataOptions", + "description": "The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*." + }, + "Monitoring": { + "$ref": "#/definitions/Monitoring", + "description": "The monitoring for the instance." + }, + "NetworkInterfaces": { + "description": "The network interfaces for the instance.", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "type": "array", + "uniqueItems": false + }, + "Placement": { + "$ref": "#/definitions/Placement", + "description": "The placement for the instance." + }, + "PrivateDnsNameOptions": { + "$ref": "#/definitions/PrivateDnsNameOptions", + "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*." + }, + "RamDiskId": { + "description": "The ID of the RAM disk.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.\n If you specify a network interface, you must specify any security groups as part of the network interface instead.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroups": { + "description": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.\n If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "TagSpecifications": { + "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", + "items": { + "$ref": "#/definitions/TagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "UserData": { + "description": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplateElasticInferenceAccelerator": { + "additionalProperties": false, + "description": "Specifies an elastic inference accelerator.\n ``LaunchTemplateElasticInferenceAccelerator`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Count": { + "description": "The number of elastic inference accelerators to attach to the instance. \n Default: 1", + "type": "integer" + }, + "Type": { + "description": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.", + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplateTagSpecification": { + "additionalProperties": false, + "description": "Specifies the tags to apply to the launch template during creation.\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", + "properties": { + "ResourceType": { + "description": "The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``.", + "type": "string" + }, + "Tags": { + "description": "The tags for the resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "LicenseSpecification": { + "additionalProperties": false, + "description": "Specifies a license configuration for an instance.\n ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "LicenseConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the license configuration.", + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceOptions": { + "additionalProperties": false, + "description": "The maintenance options of your instance.", + "properties": { + "AutoRecovery": { + "description": "Disables the automatic recovery behavior of your instance or sets it to default.", + "type": "string" + } + }, + "type": "object" + }, + "MemoryGiBPerVCpu": { + "additionalProperties": false, + "description": "The minimum and maximum amount of memory per vCPU, in GiB.", + "properties": { + "Max": { + "description": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.", + "type": "number" + }, + "Min": { + "description": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.", + "type": "number" + } + }, + "type": "object" + }, + "MemoryMiB": { + "additionalProperties": false, + "description": "The minimum and maximum amount of memory, in MiB.", + "properties": { + "Max": { + "description": "The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.", + "type": "integer" + }, + "Min": { + "description": "The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``.", + "type": "integer" + } + }, + "type": "object" + }, + "MetadataOptions": { + "additionalProperties": false, + "description": "The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.\n ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "HttpEndpoint": { + "description": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.\n If you specify a value of ``disabled``, you will not be able to access your instance metadata.", + "type": "string" + }, + "HttpProtocolIpv6": { + "description": "Enables or disables the IPv6 endpoint for the instance metadata service.\n Default: ``disabled``", + "type": "string" + }, + "HttpPutResponseHopLimit": { + "description": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.\n Default: ``1`` \n Possible values: Integers from 1 to 64", + "type": "integer" + }, + "HttpTokens": { + "description": "Indicates whether IMDSv2 is required.\n + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.\n + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.\n \n Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``.", + "type": "string" + }, + "InstanceMetadataTags": { + "description": "Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\n Default: ``disabled``", + "type": "string" + } + }, + "type": "object" + }, + "Monitoring": { + "additionalProperties": false, + "description": "Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*.\n ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Enabled": { + "description": "Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "NetworkBandwidthGbps": { + "additionalProperties": false, + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.", + "properties": { + "Max": { + "description": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.", + "type": "number" + }, + "Min": { + "description": "The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.", + "type": "number" + } + }, + "type": "object" + }, + "NetworkInterface": { + "additionalProperties": false, + "description": "Specifies the parameters for a network interface.\n ``NetworkInterface`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "AssociateCarrierIpAddress": { + "description": "Associates a Carrier IP address with eth0 for a new network interface.\n Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*.", + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "description": "Associates a public IPv4 address with eth0 for a new network interface.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", + "type": "boolean" + }, + "ConnectionTrackingSpecification": { + "$ref": "#/definitions/ConnectionTrackingSpecification", + "description": "A connection tracking specification for the network interface." + }, + "DeleteOnTermination": { + "description": "Indicates whether the network interface is deleted when the instance is terminated.", + "type": "boolean" + }, + "Description": { + "description": "A description for the network interface.", + "type": "string" + }, + "DeviceIndex": { + "description": "The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.", + "type": "integer" + }, + "EnaSrdSpecification": { + "$ref": "#/definitions/EnaSrdSpecification", + "description": "The ENA Express configuration for the network interface." + }, + "Groups": { + "description": "The IDs of one or more security groups.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "InterfaceType": { + "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``", + "type": "string" + }, + "Ipv4PrefixCount": { + "description": "The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option.", + "type": "integer" + }, + "Ipv4Prefixes": { + "description": "One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option.", + "items": { + "$ref": "#/definitions/Ipv4PrefixSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "Ipv6AddressCount": { + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.", + "type": "integer" + }, + "Ipv6Addresses": { + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", + "items": { + "$ref": "#/definitions/Ipv6Add" + }, + "type": "array", + "uniqueItems": false + }, + "Ipv6PrefixCount": { + "description": "The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option.", + "type": "integer" + }, + "Ipv6Prefixes": { + "description": "One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option.", + "items": { + "$ref": "#/definitions/Ipv6PrefixSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "NetworkCardIndex": { + "description": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.", + "type": "integer" + }, + "NetworkInterfaceId": { + "description": "The ID of the network interface.", + "type": "string" + }, + "PrimaryIpv6": { + "description": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).", + "type": "boolean" + }, + "PrivateIpAddress": { + "description": "The primary private IPv4 address of the network interface.", + "type": "string" + }, + "PrivateIpAddresses": { + "description": "One or more private IPv4 addresses.", + "items": { + "$ref": "#/definitions/PrivateIpAdd" + }, + "type": "array", + "uniqueItems": false + }, + "SecondaryPrivateIpAddressCount": { + "description": "The number of secondary private IPv4 addresses to assign to a network interface.", + "type": "integer" + }, + "SubnetId": { + "description": "The ID of the subnet for the network interface.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkInterfaceCount": { + "additionalProperties": false, + "description": "The minimum and maximum number of network interfaces.", + "properties": { + "Max": { + "description": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter.", + "type": "integer" + }, + "Min": { + "description": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.", + "type": "integer" + } + }, + "type": "object" + }, + "Placement": { + "additionalProperties": false, + "description": "Specifies the placement of an instance.\n ``Placement`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "Affinity": { + "description": "The affinity setting for an instance on a Dedicated Host.", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone for the instance.", + "type": "string" + }, + "GroupId": { + "description": "The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group.", + "type": "string" + }, + "GroupName": { + "description": "The name of the placement group for the instance.", + "type": "string" + }, + "HostId": { + "description": "The ID of the Dedicated Host for the instance.", + "type": "string" + }, + "HostResourceGroupArn": { + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``.", + "type": "string" + }, + "PartitionNumber": { + "description": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``.", + "type": "integer" + }, + "SpreadDomain": { + "description": "Reserved for future use.", + "type": "string" + }, + "Tenancy": { + "description": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.", + "type": "string" + } + }, + "type": "object" + }, + "PrivateDnsNameOptions": { + "additionalProperties": false, + "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.", + "type": "boolean" + }, + "EnableResourceNameDnsARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.", + "type": "boolean" + }, + "HostnameType": { + "description": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "PrivateIpAdd": { + "additionalProperties": false, + "description": "Specifies a secondary private IPv4 address for a network interface.\n ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).", + "properties": { + "Primary": { + "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", + "type": "boolean" + }, + "PrivateIpAddress": { + "description": "The private IPv4 address.", + "type": "string" + } + }, + "type": "object" + }, + "SpotOptions": { + "additionalProperties": false, + "description": "Specifies options for Spot Instances.\n ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html).", + "properties": { + "BlockDurationMinutes": { + "description": "Deprecated.", + "type": "integer" + }, + "InstanceInterruptionBehavior": { + "description": "The behavior when a Spot Instance is interrupted. The default is ``terminate``.", + "type": "string" + }, + "MaxPrice": { + "description": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.", + "type": "string" + }, + "SpotInstanceType": { + "description": "The Spot Instance request type.\n If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity.", + "type": "string" + }, + "ValidUntil": { + "description": "The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.\n + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.\n + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.\n \n Default: 7 days from the current date", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagSpecification": { + "additionalProperties": false, + "description": "Specifies the tags to apply to a resource when the resource is created for the launch template.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "properties": { + "ResourceType": { + "description": "The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).", + "type": "string" + }, + "Tags": { + "description": "The tags to apply to the resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "TotalLocalStorageGB": { + "additionalProperties": false, + "description": "The minimum and maximum amount of total local storage, in GB.", + "properties": { + "Max": { + "description": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.", + "type": "number" + }, + "Min": { + "description": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.", + "type": "number" + } + }, + "type": "object" + }, + "VCpuCount": { + "additionalProperties": false, + "description": "The minimum and maximum number of vCPUs.", + "properties": { + "Max": { + "description": "The maximum number of vCPUs. To specify no maximum limit, omit this parameter.", + "type": "integer" + }, + "Min": { + "description": "The minimum number of vCPUs. To specify no minimum limit, specify ``0``.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Specifies the properties for creating a launch template.\n The minimum required properties for specifying a launch template are as follows:\n + You must specify at least one property for the launch template data.\n + You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you.\n \n A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.\n For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateLaunchTemplate", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteLaunchTemplate", + "ec2:DeleteTags", + "ec2:DescribeLaunchTemplates" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeLaunchTemplates" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeLaunchTemplates" + ] + }, + "update": { + "permissions": [ + "ec2:CreateLaunchTemplateVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/LaunchTemplateId" + ], + "properties": { + "DefaultVersionNumber": { + "description": "", + "type": "string" + }, + "LatestVersionNumber": { + "description": "", + "type": "string" + }, + "LaunchTemplateData": { + "$ref": "#/definitions/LaunchTemplateData", + "description": "The information for the launch template." + }, + "LaunchTemplateId": { + "description": "", + "type": "string" + }, + "LaunchTemplateName": { + "description": "A name for the launch template.", + "type": "string" + }, + "TagSpecifications": { + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).", + "items": { + "$ref": "#/definitions/LaunchTemplateTagSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "VersionDescription": { + "description": "A description for the first version of the launch template.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DefaultVersionNumber", + "/properties/LaunchTemplateId", + "/properties/LatestVersionNumber" + ], + "required": [ + "LaunchTemplateData" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::LaunchTemplate", + "writeOnlyProperties": [ + "/properties/LaunchTemplateData", + "/properties/VersionDescription", + "/properties/TagSpecifications" + ] +} diff --git a/schema/aws-ec2-localgatewayroute.json b/schema/aws-ec2-localgatewayroute.json index f2b2268..280b5fb 100644 --- a/schema/aws-ec2-localgatewayroute.json +++ b/schema/aws-ec2-localgatewayroute.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DestinationCidrBlock", - "/properties/LocalGatewayRouteTableId" - ], - "description": "Describes a route for a local gateway route table.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateLocalGatewayRoute", - "ec2:SearchLocalGatewayRoutes" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteLocalGatewayRoute", - "ec2:SearchLocalGatewayRoutes" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTables", - "ec2:SearchLocalGatewayRoutes" - ] - }, - "read": { - "permissions": [ - "ec2:SearchLocalGatewayRoutes" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyLocalGatewayRoute", - "ec2:SearchLocalGatewayRoutes" - ] - } - }, - "oneOf": [ - { - "required": [ - "DestinationCidrBlock", - "LocalGatewayRouteTableId", - "LocalGatewayVirtualInterfaceGroupId" - ] - }, - { - "required": [ - "DestinationCidrBlock", - "LocalGatewayRouteTableId", - "NetworkInterfaceId" - ] - } - ], - "primaryIdentifier": [ - "/properties/DestinationCidrBlock", - "/properties/LocalGatewayRouteTableId" - ], - "properties": { - "DestinationCidrBlock": { - "description": "The CIDR block used for destination matches.", - "type": "string" - }, - "LocalGatewayRouteTableId": { - "description": "The ID of the local gateway route table.", - "type": "string" - }, - "LocalGatewayVirtualInterfaceGroupId": { - "description": "The ID of the virtual interface group.", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of the network interface.", - "type": "string" - }, - "State": { - "description": "The state of the route.", - "type": "string" - }, - "Type": { - "description": "The route type.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/State", - "/properties/Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::LocalGatewayRoute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DestinationCidrBlock", + "/properties/LocalGatewayRouteTableId" + ], + "description": "Describes a route for a local gateway route table.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateLocalGatewayRoute", + "ec2:SearchLocalGatewayRoutes" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteLocalGatewayRoute", + "ec2:SearchLocalGatewayRoutes" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTables", + "ec2:SearchLocalGatewayRoutes" + ] + }, + "read": { + "permissions": [ + "ec2:SearchLocalGatewayRoutes" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyLocalGatewayRoute", + "ec2:SearchLocalGatewayRoutes" + ] + } + }, + "oneOf": [ + { + "required": [ + "DestinationCidrBlock", + "LocalGatewayRouteTableId", + "LocalGatewayVirtualInterfaceGroupId" + ] + }, + { + "required": [ + "DestinationCidrBlock", + "LocalGatewayRouteTableId", + "NetworkInterfaceId" + ] + } + ], + "primaryIdentifier": [ + "/properties/DestinationCidrBlock", + "/properties/LocalGatewayRouteTableId" + ], + "properties": { + "DestinationCidrBlock": { + "description": "The CIDR block used for destination matches.", + "type": "string" + }, + "LocalGatewayRouteTableId": { + "description": "The ID of the local gateway route table.", + "type": "string" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "description": "The ID of the virtual interface group.", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The ID of the network interface.", + "type": "string" + }, + "State": { + "description": "The state of the route.", + "type": "string" + }, + "Type": { + "description": "The route type.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/State", + "/properties/Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::LocalGatewayRoute" +} diff --git a/schema/aws-ec2-localgatewayroutetable.json b/schema/aws-ec2-localgatewayroutetable.json index d760f39..d3101f2 100644 --- a/schema/aws-ec2-localgatewayroutetable.json +++ b/schema/aws-ec2-localgatewayroutetable.json @@ -1,125 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocalGatewayId", - "/properties/Mode" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "Describes a route table for a local gateway.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateLocalGatewayRouteTable", - "ec2:DescribeLocalGatewayRouteTables", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteLocalGatewayRouteTable", - "ec2:DescribeLocalGatewayRouteTables", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTables" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTables" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTables", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocalGatewayRouteTableId" - ], - "properties": { - "LocalGatewayId": { - "description": "The ID of the local gateway.", - "type": "string" - }, - "LocalGatewayRouteTableArn": { - "description": "The ARN of the local gateway route table.", - "type": "string" - }, - "LocalGatewayRouteTableId": { - "description": "The ID of the local gateway route table.", - "type": "string" - }, - "Mode": { - "description": "The mode of the local gateway route table.", - "type": "string" - }, - "OutpostArn": { - "description": "The ARN of the outpost.", - "type": "string" - }, - "OwnerId": { - "description": "The owner of the local gateway route table.", - "type": "string" - }, - "State": { - "description": "The state of the local gateway route table.", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "The tags for the local gateway route table." - } - }, - "readOnlyProperties": [ - "/properties/LocalGatewayRouteTableId", - "/properties/LocalGatewayRouteTableArn", - "/properties/OutpostArn", - "/properties/OwnerId", - "/properties/State" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "LocalGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::LocalGatewayRouteTable" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocalGatewayId", + "/properties/Mode" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "Describes a route table for a local gateway.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateLocalGatewayRouteTable", + "ec2:DescribeLocalGatewayRouteTables", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteLocalGatewayRouteTable", + "ec2:DescribeLocalGatewayRouteTables", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTables" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTables" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTables", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocalGatewayRouteTableId" + ], + "properties": { + "LocalGatewayId": { + "description": "The ID of the local gateway.", + "type": "string" + }, + "LocalGatewayRouteTableArn": { + "description": "The ARN of the local gateway route table.", + "type": "string" + }, + "LocalGatewayRouteTableId": { + "description": "The ID of the local gateway route table.", + "type": "string" + }, + "Mode": { + "description": "The mode of the local gateway route table.", + "type": "string" + }, + "OutpostArn": { + "description": "The ARN of the outpost.", + "type": "string" + }, + "OwnerId": { + "description": "The owner of the local gateway route table.", + "type": "string" + }, + "State": { + "description": "The state of the local gateway route table.", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "The tags for the local gateway route table." + } + }, + "readOnlyProperties": [ + "/properties/LocalGatewayRouteTableId", + "/properties/LocalGatewayRouteTableArn", + "/properties/OutpostArn", + "/properties/OwnerId", + "/properties/State" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "LocalGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ec2:DeleteTags", + "ec2:CreateTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::LocalGatewayRouteTable" +} diff --git a/schema/aws-ec2-localgatewayroutetablevirtualinterfacegroupassociation.json b/schema/aws-ec2-localgatewayroutetablevirtualinterfacegroupassociation.json index 7b2fb85..6b12480 100644 --- a/schema/aws-ec2-localgatewayroutetablevirtualinterfacegroupassociation.json +++ b/schema/aws-ec2-localgatewayroutetablevirtualinterfacegroupassociation.json @@ -1,126 +1,126 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocalGatewayRouteTableId", - "/properties/LocalGatewayVirtualInterfaceGroupId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "Describes a local gateway route table virtual interface group association for a local gateway.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" - ], - "properties": { - "LocalGatewayId": { - "description": "The ID of the local gateway.", - "type": "string" - }, - "LocalGatewayRouteTableArn": { - "description": "The ARN of the local gateway route table.", - "type": "string" - }, - "LocalGatewayRouteTableId": { - "description": "The ID of the local gateway route table.", - "type": "string" - }, - "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { - "description": "The ID of the local gateway route table virtual interface group association.", - "type": "string" - }, - "LocalGatewayVirtualInterfaceGroupId": { - "description": "The ID of the local gateway route table virtual interface group.", - "type": "string" - }, - "OwnerId": { - "description": "The owner of the local gateway route table virtual interface group association.", - "type": "string" - }, - "State": { - "description": "The state of the local gateway route table virtual interface group association.", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "The tags for the local gateway route table virtual interface group association." - } - }, - "readOnlyProperties": [ - "/properties/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", - "/properties/LocalGatewayId", - "/properties/LocalGatewayRouteTableArn", - "/properties/OwnerId", - "/properties/State" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "LocalGatewayRouteTableId", - "LocalGatewayVirtualInterfaceGroupId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocalGatewayRouteTableId", + "/properties/LocalGatewayVirtualInterfaceGroupId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "Describes a local gateway route table virtual interface group association for a local gateway.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" + ], + "properties": { + "LocalGatewayId": { + "description": "The ID of the local gateway.", + "type": "string" + }, + "LocalGatewayRouteTableArn": { + "description": "The ARN of the local gateway route table.", + "type": "string" + }, + "LocalGatewayRouteTableId": { + "description": "The ID of the local gateway route table.", + "type": "string" + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "description": "The ID of the local gateway route table virtual interface group association.", + "type": "string" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "description": "The ID of the local gateway route table virtual interface group.", + "type": "string" + }, + "OwnerId": { + "description": "The owner of the local gateway route table virtual interface group association.", + "type": "string" + }, + "State": { + "description": "The state of the local gateway route table virtual interface group association.", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "The tags for the local gateway route table virtual interface group association." + } + }, + "readOnlyProperties": [ + "/properties/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "/properties/LocalGatewayId", + "/properties/LocalGatewayRouteTableArn", + "/properties/OwnerId", + "/properties/State" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "LocalGatewayRouteTableId", + "LocalGatewayVirtualInterfaceGroupId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" +} diff --git a/schema/aws-ec2-localgatewayroutetablevpcassociation.json b/schema/aws-ec2-localgatewayroutetablevpcassociation.json index 45c3634..44557d4 100644 --- a/schema/aws-ec2-localgatewayroutetablevpcassociation.json +++ b/schema/aws-ec2-localgatewayroutetablevpcassociation.json @@ -1,115 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocalGatewayRouteTableId", - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!aws:.*)", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "Describes an association between a local gateway route table and a VPC.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateLocalGatewayRouteTableVpcAssociation", - "ec2:DescribeLocalGatewayRouteTableVpcAssociations", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteLocalGatewayRouteTableVpcAssociation", - "ec2:DescribeLocalGatewayRouteTableVpcAssociations", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVpcAssociations" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVpcAssociations" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeLocalGatewayRouteTableVpcAssociations", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocalGatewayRouteTableVpcAssociationId" - ], - "properties": { - "LocalGatewayId": { - "description": "The ID of the local gateway.", - "type": "string" - }, - "LocalGatewayRouteTableId": { - "description": "The ID of the local gateway route table.", - "type": "string" - }, - "LocalGatewayRouteTableVpcAssociationId": { - "description": "The ID of the association.", - "type": "string" - }, - "State": { - "description": "The state of the association.", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "The tags for the association." - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LocalGatewayId", - "/properties/LocalGatewayRouteTableVpcAssociationId", - "/properties/State" - ], - "required": [ - "LocalGatewayRouteTableId", - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::LocalGatewayRouteTableVPCAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocalGatewayRouteTableId", + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!aws:.*)", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "Describes an association between a local gateway route table and a VPC.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateLocalGatewayRouteTableVpcAssociation", + "ec2:DescribeLocalGatewayRouteTableVpcAssociations", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteLocalGatewayRouteTableVpcAssociation", + "ec2:DescribeLocalGatewayRouteTableVpcAssociations", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVpcAssociations" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVpcAssociations" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeLocalGatewayRouteTableVpcAssociations", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocalGatewayRouteTableVpcAssociationId" + ], + "properties": { + "LocalGatewayId": { + "description": "The ID of the local gateway.", + "type": "string" + }, + "LocalGatewayRouteTableId": { + "description": "The ID of the local gateway route table.", + "type": "string" + }, + "LocalGatewayRouteTableVpcAssociationId": { + "description": "The ID of the association.", + "type": "string" + }, + "State": { + "description": "The state of the association.", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "The tags for the association." + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LocalGatewayId", + "/properties/LocalGatewayRouteTableVpcAssociationId", + "/properties/State" + ], + "required": [ + "LocalGatewayRouteTableId", + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-lgw.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ec2:DeleteTags", + "ec2:CreateTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::LocalGatewayRouteTableVPCAssociation" +} diff --git a/schema/aws-ec2-natgateway.json b/schema/aws-ec2-natgateway.json index e0a43b7..f9d5f56 100644 --- a/schema/aws-ec2-natgateway.json +++ b/schema/aws-ec2-natgateway.json @@ -1,144 +1,144 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetId", - "/properties/ConnectivityType", - "/properties/AllocationId", - "/properties/PrivateIpAddress" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.\n With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.\n If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.\n When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNatGateway", - "ec2:DescribeNatGateways", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNatGateway", - "ec2:DescribeNatGateways" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNatGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNatGateways" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNatGateways", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:AssociateNatGatewayAddress", - "ec2:DisassociateNatGatewayAddress", - "ec2:AssignPrivateNatGatewayAddress", - "ec2:UnassignPrivateNatGatewayAddress" - ] - } - }, - "primaryIdentifier": [ - "/properties/NatGatewayId" - ], - "properties": { - "AllocationId": { - "description": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.", - "type": "string" - }, - "ConnectivityType": { - "description": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.", - "type": "string" - }, - "MaxDrainDurationSeconds": { - "description": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.", - "type": "integer" - }, - "NatGatewayId": { - "description": "", - "type": "string" - }, - "PrivateIpAddress": { - "description": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.", - "type": "string" - }, - "SecondaryAllocationIds": { - "description": "Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SecondaryPrivateIpAddressCount": { - "description": "[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.", - "minimum": 1, - "type": "integer" - }, - "SecondaryPrivateIpAddresses": { - "description": "Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetId": { - "description": "The ID of the subnet in which the NAT gateway is located.", - "type": "string" - }, - "Tags": { - "description": "The tags for the NAT gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/NatGatewayId" - ], - "required": [ - "SubnetId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::NatGateway", - "writeOnlyProperties": [ - "/properties/MaxDrainDurationSeconds" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetId", + "/properties/ConnectivityType", + "/properties/AllocationId", + "/properties/PrivateIpAddress" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.\n With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.\n If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.\n When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNatGateway", + "ec2:DescribeNatGateways", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNatGateway", + "ec2:DescribeNatGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNatGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNatGateways" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNatGateways", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:AssociateNatGatewayAddress", + "ec2:DisassociateNatGatewayAddress", + "ec2:AssignPrivateNatGatewayAddress", + "ec2:UnassignPrivateNatGatewayAddress" + ] + } + }, + "primaryIdentifier": [ + "/properties/NatGatewayId" + ], + "properties": { + "AllocationId": { + "description": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.", + "type": "string" + }, + "ConnectivityType": { + "description": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.", + "type": "string" + }, + "MaxDrainDurationSeconds": { + "description": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.", + "type": "integer" + }, + "NatGatewayId": { + "description": "", + "type": "string" + }, + "PrivateIpAddress": { + "description": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.", + "type": "string" + }, + "SecondaryAllocationIds": { + "description": "Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SecondaryPrivateIpAddressCount": { + "description": "[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.", + "minimum": 1, + "type": "integer" + }, + "SecondaryPrivateIpAddresses": { + "description": "Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetId": { + "description": "The ID of the subnet in which the NAT gateway is located.", + "type": "string" + }, + "Tags": { + "description": "The tags for the NAT gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/NatGatewayId" + ], + "required": [ + "SubnetId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::NatGateway", + "writeOnlyProperties": [ + "/properties/MaxDrainDurationSeconds" + ] +} diff --git a/schema/aws-ec2-networkacl.json b/schema/aws-ec2-networkacl.json index 2dd3ced..2cd5f5d 100644 --- a/schema/aws-ec2-networkacl.json +++ b/schema/aws-ec2-networkacl.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a network ACL for your VPC.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkAcl", - "ec2:DescribeNetworkAcls", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteTags", - "ec2:DeleteNetworkAcl", - "ec2:DescribeNetworkAcls" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkAcls" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkAcls", - "ec2:DescribeTags" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNetworkAcls", - "ec2:DeleteTags", - "ec2:CreateTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "The tags for the network ACL.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC for the network ACL.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::NetworkAcl" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a network ACL for your VPC.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkAcl", + "ec2:DescribeNetworkAcls", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteTags", + "ec2:DeleteNetworkAcl", + "ec2:DescribeNetworkAcls" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkAcls" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkAcls", + "ec2:DescribeTags" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNetworkAcls", + "ec2:DeleteTags", + "ec2:CreateTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "The tags for the network ACL.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC for the network ACL.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::NetworkAcl" +} diff --git a/schema/aws-ec2-networkaclentry.json b/schema/aws-ec2-networkaclentry.json index e7818cb..beaa0ce 100644 --- a/schema/aws-ec2-networkaclentry.json +++ b/schema/aws-ec2-networkaclentry.json @@ -1,111 +1,116 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Egress", - "/properties/RuleNumber", - "/properties/NetworkAclId" - ], - "definitions": { - "Icmp": { - "additionalProperties": false, - "properties": { - "Code": { - "type": "integer" - }, - "Type": { - "type": "integer" - } - }, - "type": "object" - }, - "PortRange": { - "additionalProperties": false, - "properties": { - "From": { - "type": "integer" - }, - "To": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::NetworkAclEntry", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkAclEntry", - "ec2:DescribeNetworkAcls" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNetworkAclEntry", - "ec2:DescribeNetworkAcls" - ] - }, - "update": { - "permissions": [ - "ec2:ReplaceNetworkAclEntry", - "ec2:DescribeNetworkAcls" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CidrBlock": { - "description": "The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property", - "type": "string" - }, - "Egress": { - "description": "Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet)", - "type": "boolean" - }, - "Icmp": { - "$ref": "#/definitions/Icmp", - "description": "The Internet Control Message Protocol (ICMP) code and type. Requirement is conditional: Required if specifying 1 (ICMP) for the protocol parameter" - }, - "Id": { - "type": "string" - }, - "Ipv6CidrBlock": { - "description": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64)", - "type": "string" - }, - "NetworkAclId": { - "description": "The ID of the network ACL", - "type": "string" - }, - "PortRange": { - "$ref": "#/definitions/PortRange", - "description": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18" - }, - "Protocol": { - "description": "The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code", - "type": "integer" - }, - "RuleAction": { - "description": "Indicates whether to allow or deny the traffic that matches the rule", - "type": "string" - }, - "RuleNumber": { - "description": "Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule", - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "NetworkAclId", - "RuleAction", - "RuleNumber", - "Protocol" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "taggable": false, - "typeName": "AWS::EC2::NetworkAclEntry" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Egress", + "/properties/RuleNumber", + "/properties/NetworkAclId" + ], + "definitions": { + "Icmp": { + "additionalProperties": false, + "properties": { + "Code": { + "type": "integer" + }, + "Type": { + "type": "integer" + } + }, + "type": "object" + }, + "PortRange": { + "additionalProperties": false, + "properties": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::NetworkAclEntry", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkAclEntry", + "ec2:DescribeNetworkAcls" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNetworkAclEntry", + "ec2:DescribeNetworkAcls" + ] + }, + "update": { + "permissions": [ + "ec2:ReplaceNetworkAclEntry", + "ec2:DescribeNetworkAcls" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CidrBlock": { + "description": "The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property", + "type": "string" + }, + "Egress": { + "description": "Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet)", + "type": "boolean" + }, + "Icmp": { + "$ref": "#/definitions/Icmp", + "description": "The Internet Control Message Protocol (ICMP) code and type. Requirement is conditional: Required if specifying 1 (ICMP) for the protocol parameter" + }, + "Id": { + "type": "string" + }, + "Ipv6CidrBlock": { + "description": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64)", + "type": "string" + }, + "NetworkAclId": { + "description": "The ID of the network ACL", + "type": "string" + }, + "PortRange": { + "$ref": "#/definitions/PortRange", + "description": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18" + }, + "Protocol": { + "description": "The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code", + "type": "integer" + }, + "RuleAction": { + "description": "Indicates whether to allow or deny the traffic that matches the rule", + "type": "string" + }, + "RuleNumber": { + "description": "Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule", + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "NetworkAclId", + "RuleAction", + "RuleNumber", + "Protocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::NetworkAclEntry" +} diff --git a/schema/aws-ec2-networkinsightsaccessscope.json b/schema/aws-ec2-networkinsightsaccessscope.json index 276fcc6..703e22a 100644 --- a/schema/aws-ec2-networkinsightsaccessscope.json +++ b/schema/aws-ec2-networkinsightsaccessscope.json @@ -1,236 +1,236 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/NetworkInsightsAccessScopeArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MatchPaths", - "/properties/ExcludePaths" - ], - "definitions": { - "AccessScopePathRequest": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/PathStatementRequest" - }, - "Source": { - "$ref": "#/definitions/PathStatementRequest" - }, - "ThroughResources": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ThroughResourcesStatementRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "PacketHeaderStatementRequest": { - "additionalProperties": false, - "properties": { - "DestinationAddresses": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "DestinationPorts": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "DestinationPrefixLists": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Protocols": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Protocol" - }, - "type": "array" - }, - "SourceAddresses": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "SourcePorts": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "SourcePrefixLists": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "PathStatementRequest": { - "additionalProperties": false, - "properties": { - "PacketHeaderStatement": { - "$ref": "#/definitions/PacketHeaderStatementRequest" - }, - "ResourceStatement": { - "$ref": "#/definitions/ResourceStatementRequest" - } - }, - "type": "object" - }, - "Protocol": { - "enum": [ - "tcp", - "udp" - ], - "type": "string" - }, - "ResourceStatementRequest": { - "additionalProperties": false, - "properties": { - "ResourceTypes": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Resources": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "ThroughResourcesStatementRequest": { - "additionalProperties": false, - "properties": { - "ResourceStatement": { - "$ref": "#/definitions/ResourceStatementRequest" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::EC2::NetworkInsightsAccessScope", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkInsightsAccessScope", - "ec2:CreateTags", - "tiros:CreateQuery" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNetworkInsightsAccessScope", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopes" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopes", - "ec2:GetNetworkInsightsAccessScopeContent" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopes", - "ec2:GetNetworkInsightsAccessScopeContent", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/NetworkInsightsAccessScopeId" - ], - "properties": { - "CreatedDate": { - "type": "string" - }, - "ExcludePaths": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AccessScopePathRequest" - }, - "type": "array" - }, - "MatchPaths": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AccessScopePathRequest" - }, - "type": "array" - }, - "NetworkInsightsAccessScopeArn": { - "type": "string" - }, - "NetworkInsightsAccessScopeId": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UpdatedDate": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NetworkInsightsAccessScopeId", - "/properties/NetworkInsightsAccessScopeArn", - "/properties/CreatedDate", - "/properties/UpdatedDate" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", - "typeName": "AWS::EC2::NetworkInsightsAccessScope", - "writeOnlyProperties": [ - "/properties/MatchPaths", - "/properties/ExcludePaths" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/NetworkInsightsAccessScopeArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MatchPaths", + "/properties/ExcludePaths" + ], + "definitions": { + "AccessScopePathRequest": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/PathStatementRequest" + }, + "Source": { + "$ref": "#/definitions/PathStatementRequest" + }, + "ThroughResources": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ThroughResourcesStatementRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "PacketHeaderStatementRequest": { + "additionalProperties": false, + "properties": { + "DestinationAddresses": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "DestinationPorts": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "DestinationPrefixLists": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Protocols": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Protocol" + }, + "type": "array" + }, + "SourceAddresses": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "SourcePorts": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "SourcePrefixLists": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PathStatementRequest": { + "additionalProperties": false, + "properties": { + "PacketHeaderStatement": { + "$ref": "#/definitions/PacketHeaderStatementRequest" + }, + "ResourceStatement": { + "$ref": "#/definitions/ResourceStatementRequest" + } + }, + "type": "object" + }, + "Protocol": { + "enum": [ + "tcp", + "udp" + ], + "type": "string" + }, + "ResourceStatementRequest": { + "additionalProperties": false, + "properties": { + "ResourceTypes": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Resources": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "ThroughResourcesStatementRequest": { + "additionalProperties": false, + "properties": { + "ResourceStatement": { + "$ref": "#/definitions/ResourceStatementRequest" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::EC2::NetworkInsightsAccessScope", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkInsightsAccessScope", + "ec2:CreateTags", + "tiros:CreateQuery" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNetworkInsightsAccessScope", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopes" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopes", + "ec2:GetNetworkInsightsAccessScopeContent" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopes", + "ec2:GetNetworkInsightsAccessScopeContent", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/NetworkInsightsAccessScopeId" + ], + "properties": { + "CreatedDate": { + "type": "string" + }, + "ExcludePaths": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AccessScopePathRequest" + }, + "type": "array" + }, + "MatchPaths": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AccessScopePathRequest" + }, + "type": "array" + }, + "NetworkInsightsAccessScopeArn": { + "type": "string" + }, + "NetworkInsightsAccessScopeId": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "UpdatedDate": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NetworkInsightsAccessScopeId", + "/properties/NetworkInsightsAccessScopeArn", + "/properties/CreatedDate", + "/properties/UpdatedDate" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", + "typeName": "AWS::EC2::NetworkInsightsAccessScope", + "writeOnlyProperties": [ + "/properties/MatchPaths", + "/properties/ExcludePaths" + ] +} diff --git a/schema/aws-ec2-networkinsightsaccessscopeanalysis.json b/schema/aws-ec2-networkinsightsaccessscopeanalysis.json index 9cdab78..c4a159f 100644 --- a/schema/aws-ec2-networkinsightsaccessscopeanalysis.json +++ b/schema/aws-ec2-networkinsightsaccessscopeanalysis.json @@ -1,131 +1,131 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/NetworkInsightsAccessScopeAnalysisArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NetworkInsightsAccessScopeId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTags", - "ec2:StartNetworkInsightsAccessScopeAnalysis", - "ec2:GetTransitGatewayRouteTablePropagations", - "ec2:Describe*", - "elasticloadbalancing:Describe*", - "directconnect:Describe*", - "tiros:CreateQuery", - "tiros:GetQueryAnswer", - "tiros:GetQueryExplanation" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNetworkInsightsAccessScopeAnalysis", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopeAnalyses" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopeAnalyses" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNetworkInsightsAccessScopeAnalyses", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/NetworkInsightsAccessScopeAnalysisId" - ], - "properties": { - "AnalyzedEniCount": { - "type": "integer" - }, - "EndDate": { - "type": "string" - }, - "FindingsFound": { - "enum": [ - "true", - "false", - "unknown" - ], - "type": "string" - }, - "NetworkInsightsAccessScopeAnalysisArn": { - "type": "string" - }, - "NetworkInsightsAccessScopeAnalysisId": { - "type": "string" - }, - "NetworkInsightsAccessScopeId": { - "type": "string" - }, - "StartDate": { - "type": "string" - }, - "Status": { - "enum": [ - "running", - "failed", - "succeeded" - ], - "type": "string" - }, - "StatusMessage": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/NetworkInsightsAccessScopeAnalysisId", - "/properties/NetworkInsightsAccessScopeAnalysisArn", - "/properties/Status", - "/properties/StatusMessage", - "/properties/StartDate", - "/properties/EndDate", - "/properties/FindingsFound", - "/properties/AnalyzedEniCount" - ], - "required": [ - "NetworkInsightsAccessScopeId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", - "typeName": "AWS::EC2::NetworkInsightsAccessScopeAnalysis" -} +{ + "additionalIdentifiers": [ + [ + "/properties/NetworkInsightsAccessScopeAnalysisArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NetworkInsightsAccessScopeId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTags", + "ec2:StartNetworkInsightsAccessScopeAnalysis", + "ec2:GetTransitGatewayRouteTablePropagations", + "ec2:Describe*", + "elasticloadbalancing:Describe*", + "directconnect:Describe*", + "tiros:CreateQuery", + "tiros:GetQueryAnswer", + "tiros:GetQueryExplanation" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNetworkInsightsAccessScopeAnalysis", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopeAnalyses" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopeAnalyses" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNetworkInsightsAccessScopeAnalyses", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/NetworkInsightsAccessScopeAnalysisId" + ], + "properties": { + "AnalyzedEniCount": { + "type": "integer" + }, + "EndDate": { + "type": "string" + }, + "FindingsFound": { + "enum": [ + "true", + "false", + "unknown" + ], + "type": "string" + }, + "NetworkInsightsAccessScopeAnalysisArn": { + "type": "string" + }, + "NetworkInsightsAccessScopeAnalysisId": { + "type": "string" + }, + "NetworkInsightsAccessScopeId": { + "type": "string" + }, + "StartDate": { + "type": "string" + }, + "Status": { + "enum": [ + "running", + "failed", + "succeeded" + ], + "type": "string" + }, + "StatusMessage": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/NetworkInsightsAccessScopeAnalysisId", + "/properties/NetworkInsightsAccessScopeAnalysisArn", + "/properties/Status", + "/properties/StatusMessage", + "/properties/StartDate", + "/properties/EndDate", + "/properties/FindingsFound", + "/properties/AnalyzedEniCount" + ], + "required": [ + "NetworkInsightsAccessScopeId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", + "typeName": "AWS::EC2::NetworkInsightsAccessScopeAnalysis" +} diff --git a/schema/aws-ec2-networkinsightsanalysis.json b/schema/aws-ec2-networkinsightsanalysis.json index 1d2c672..9bdce99 100644 --- a/schema/aws-ec2-networkinsightsanalysis.json +++ b/schema/aws-ec2-networkinsightsanalysis.json @@ -1,706 +1,706 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/NetworkInsightsAnalysisArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NetworkInsightsPathId", - "/properties/FilterInArns" - ], - "definitions": { - "AdditionalDetail": { - "additionalProperties": false, - "properties": { - "AdditionalDetailType": { - "type": "string" - }, - "Component": { - "$ref": "#/definitions/AnalysisComponent" - }, - "LoadBalancers": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AnalysisComponent" - }, - "type": "array", - "uniqueItems": false - }, - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "AlternatePathHint": { - "additionalProperties": false, - "properties": { - "ComponentArn": { - "type": "string" - }, - "ComponentId": { - "type": "string" - } - }, - "type": "object" - }, - "AnalysisAclRule": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Egress": { - "type": "boolean" - }, - "PortRange": { - "$ref": "#/definitions/PortRange" - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "RuleAction": { - "type": "string" - }, - "RuleNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "AnalysisComponent": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "type": "object" - }, - "AnalysisLoadBalancerListener": { - "additionalProperties": false, - "properties": { - "InstancePort": { - "$ref": "#/definitions/Port" - }, - "LoadBalancerPort": { - "$ref": "#/definitions/Port" - } - }, - "type": "object" - }, - "AnalysisLoadBalancerTarget": { - "additionalProperties": false, - "properties": { - "Address": { - "$ref": "#/definitions/IpAddress" - }, - "AvailabilityZone": { - "type": "string" - }, - "Instance": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Port": { - "$ref": "#/definitions/Port" - } - }, - "type": "object" - }, - "AnalysisPacketHeader": { - "additionalProperties": false, - "properties": { - "DestinationAddresses": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpAddress" - }, - "type": "array", - "uniqueItems": false - }, - "DestinationPortRanges": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "SourceAddresses": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpAddress" - }, - "type": "array", - "uniqueItems": false - }, - "SourcePortRanges": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "AnalysisRouteTableRoute": { - "additionalProperties": false, - "properties": { - "NatGatewayId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "Origin": { - "type": "string" - }, - "State": { - "type": "string" - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcPeeringConnectionId": { - "type": "string" - }, - "destinationCidr": { - "type": "string" - }, - "destinationPrefixListId": { - "type": "string" - }, - "egressOnlyInternetGatewayId": { - "type": "string" - }, - "gatewayId": { - "type": "string" - }, - "instanceId": { - "type": "string" - } - }, - "type": "object" - }, - "AnalysisSecurityGroupRule": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Direction": { - "type": "string" - }, - "PortRange": { - "$ref": "#/definitions/PortRange" - }, - "PrefixListId": { - "type": "string" - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "SecurityGroupId": { - "type": "string" - } - }, - "type": "object" - }, - "Explanation": { - "additionalProperties": false, - "properties": { - "Acl": { - "$ref": "#/definitions/AnalysisComponent" - }, - "AclRule": { - "$ref": "#/definitions/AnalysisAclRule" - }, - "Address": { - "$ref": "#/definitions/IpAddress" - }, - "Addresses": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpAddress" - }, - "type": "array", - "uniqueItems": false - }, - "AttachedTo": { - "$ref": "#/definitions/AnalysisComponent" - }, - "AvailabilityZones": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Cidrs": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ClassicLoadBalancerListener": { - "$ref": "#/definitions/AnalysisLoadBalancerListener" - }, - "Component": { - "$ref": "#/definitions/AnalysisComponent" - }, - "ComponentAccount": { - "type": "string" - }, - "ComponentRegion": { - "type": "string" - }, - "CustomerGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Destination": { - "$ref": "#/definitions/AnalysisComponent" - }, - "DestinationVpc": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Direction": { - "type": "string" - }, - "ElasticLoadBalancerListener": { - "$ref": "#/definitions/AnalysisComponent" - }, - "ExplanationCode": { - "type": "string" - }, - "IngressRouteTable": { - "$ref": "#/definitions/AnalysisComponent" - }, - "InternetGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "LoadBalancerArn": { - "$ref": "#/definitions/ResourceArn" - }, - "LoadBalancerListenerPort": { - "$ref": "#/definitions/Port" - }, - "LoadBalancerTarget": { - "$ref": "#/definitions/AnalysisLoadBalancerTarget" - }, - "LoadBalancerTargetGroup": { - "$ref": "#/definitions/AnalysisComponent" - }, - "LoadBalancerTargetGroups": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AnalysisComponent" - }, - "type": "array", - "uniqueItems": false - }, - "LoadBalancerTargetPort": { - "$ref": "#/definitions/Port" - }, - "MissingComponent": { - "type": "string" - }, - "NatGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "NetworkInterface": { - "$ref": "#/definitions/AnalysisComponent" - }, - "PacketField": { - "type": "string" - }, - "Port": { - "$ref": "#/definitions/Port" - }, - "PortRanges": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "PrefixList": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Protocols": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Protocol" - }, - "type": "array", - "uniqueItems": false - }, - "RouteTable": { - "$ref": "#/definitions/AnalysisComponent" - }, - "RouteTableRoute": { - "$ref": "#/definitions/AnalysisRouteTableRoute" - }, - "SecurityGroup": { - "$ref": "#/definitions/AnalysisComponent" - }, - "SecurityGroupRule": { - "$ref": "#/definitions/AnalysisSecurityGroupRule" - }, - "SecurityGroups": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AnalysisComponent" - }, - "type": "array", - "uniqueItems": false - }, - "SourceVpc": { - "$ref": "#/definitions/AnalysisComponent" - }, - "State": { - "type": "string" - }, - "Subnet": { - "$ref": "#/definitions/AnalysisComponent" - }, - "SubnetRouteTable": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGatewayAttachment": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGatewayRouteTable": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGatewayRouteTableRoute": { - "$ref": "#/definitions/TransitGatewayRouteTableRoute" - }, - "Vpc": { - "$ref": "#/definitions/AnalysisComponent" - }, - "VpcPeeringConnection": { - "$ref": "#/definitions/AnalysisComponent" - }, - "VpnConnection": { - "$ref": "#/definitions/AnalysisComponent" - }, - "VpnGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "vpcEndpoint": { - "$ref": "#/definitions/AnalysisComponent" - } - }, - "type": "object" - }, - "IpAddress": { - "type": "string" - }, - "PathComponent": { - "additionalProperties": false, - "properties": { - "AclRule": { - "$ref": "#/definitions/AnalysisAclRule" - }, - "AdditionalDetails": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AdditionalDetail" - }, - "type": "array", - "uniqueItems": false - }, - "Component": { - "$ref": "#/definitions/AnalysisComponent" - }, - "DestinationVpc": { - "$ref": "#/definitions/AnalysisComponent" - }, - "ElasticLoadBalancerListener": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Explanations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Explanation" - }, - "type": "array", - "uniqueItems": false - }, - "InboundHeader": { - "$ref": "#/definitions/AnalysisPacketHeader" - }, - "OutboundHeader": { - "$ref": "#/definitions/AnalysisPacketHeader" - }, - "RouteTableRoute": { - "$ref": "#/definitions/AnalysisRouteTableRoute" - }, - "SecurityGroupRule": { - "$ref": "#/definitions/AnalysisSecurityGroupRule" - }, - "SequenceNumber": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - }, - "SourceVpc": { - "$ref": "#/definitions/AnalysisComponent" - }, - "Subnet": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGateway": { - "$ref": "#/definitions/AnalysisComponent" - }, - "TransitGatewayRouteTableRoute": { - "$ref": "#/definitions/TransitGatewayRouteTableRoute" - }, - "Vpc": { - "$ref": "#/definitions/AnalysisComponent" - } - }, - "type": "object" - }, - "Port": { - "type": "integer" - }, - "PortRange": { - "additionalProperties": false, - "properties": { - "From": { - "type": "integer" - }, - "To": { - "type": "integer" - } - }, - "type": "object" - }, - "Protocol": { - "type": "string" - }, - "ResourceArn": { - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TransitGatewayRouteTableRoute": { - "additionalProperties": false, - "properties": { - "AttachmentId": { - "type": "string" - }, - "DestinationCidr": { - "type": "string" - }, - "PrefixListId": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "ResourceType": { - "type": "string" - }, - "RouteOrigin": { - "type": "string" - }, - "State": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::EC2::NetworkInsightsAnalysis", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTags", - "ec2:StartNetworkInsightsAnalysis", - "ec2:GetTransitGatewayRouteTablePropagations", - "ec2:SearchTransitGatewayRoutes", - "ec2:Describe*", - "ec2:GetManagedPrefixListEntries", - "elasticloadbalancing:Describe*", - "directconnect:Describe*", - "tiros:CreateQuery", - "tiros:GetQueryAnswer", - "tiros:GetQueryExplanation" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNetworkInsightsAnalysis", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:Describe*" - ] - }, - "read": { - "permissions": [ - "ec2:Describe*" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:Describe*", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/NetworkInsightsAnalysisId" - ], - "properties": { - "AdditionalAccounts": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AlternatePathHints": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AlternatePathHint" - }, - "type": "array", - "uniqueItems": false - }, - "Explanations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Explanation" - }, - "type": "array", - "uniqueItems": false - }, - "FilterInArns": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResourceArn" - }, - "type": "array", - "uniqueItems": false - }, - "ForwardPathComponents": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PathComponent" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkInsightsAnalysisArn": { - "type": "string" - }, - "NetworkInsightsAnalysisId": { - "type": "string" - }, - "NetworkInsightsPathId": { - "type": "string" - }, - "NetworkPathFound": { - "type": "boolean" - }, - "ReturnPathComponents": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PathComponent" - }, - "type": "array", - "uniqueItems": false - }, - "StartDate": { - "type": "string" - }, - "Status": { - "enum": [ - "running", - "failed", - "succeeded" - ], - "type": "string" - }, - "StatusMessage": { - "type": "string" - }, - "SuggestedAccounts": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/NetworkInsightsAnalysisId", - "/properties/NetworkInsightsAnalysisArn", - "/properties/StartDate", - "/properties/Status", - "/properties/StatusMessage", - "/properties/NetworkPathFound", - "/properties/ForwardPathComponents", - "/properties/ReturnPathComponents", - "/properties/Explanations", - "/properties/AlternatePathHints", - "/properties/SuggestedAccounts" - ], - "required": [ - "NetworkInsightsPathId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", - "typeName": "AWS::EC2::NetworkInsightsAnalysis" -} +{ + "additionalIdentifiers": [ + [ + "/properties/NetworkInsightsAnalysisArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NetworkInsightsPathId", + "/properties/FilterInArns" + ], + "definitions": { + "AdditionalDetail": { + "additionalProperties": false, + "properties": { + "AdditionalDetailType": { + "type": "string" + }, + "Component": { + "$ref": "#/definitions/AnalysisComponent" + }, + "LoadBalancers": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AnalysisComponent" + }, + "type": "array", + "uniqueItems": false + }, + "ServiceName": { + "type": "string" + } + }, + "type": "object" + }, + "AlternatePathHint": { + "additionalProperties": false, + "properties": { + "ComponentArn": { + "type": "string" + }, + "ComponentId": { + "type": "string" + } + }, + "type": "object" + }, + "AnalysisAclRule": { + "additionalProperties": false, + "properties": { + "Cidr": { + "type": "string" + }, + "Egress": { + "type": "boolean" + }, + "PortRange": { + "$ref": "#/definitions/PortRange" + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "RuleAction": { + "type": "string" + }, + "RuleNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "AnalysisComponent": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "type": "object" + }, + "AnalysisLoadBalancerListener": { + "additionalProperties": false, + "properties": { + "InstancePort": { + "$ref": "#/definitions/Port" + }, + "LoadBalancerPort": { + "$ref": "#/definitions/Port" + } + }, + "type": "object" + }, + "AnalysisLoadBalancerTarget": { + "additionalProperties": false, + "properties": { + "Address": { + "$ref": "#/definitions/IpAddress" + }, + "AvailabilityZone": { + "type": "string" + }, + "Instance": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Port": { + "$ref": "#/definitions/Port" + } + }, + "type": "object" + }, + "AnalysisPacketHeader": { + "additionalProperties": false, + "properties": { + "DestinationAddresses": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpAddress" + }, + "type": "array", + "uniqueItems": false + }, + "DestinationPortRanges": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "SourceAddresses": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpAddress" + }, + "type": "array", + "uniqueItems": false + }, + "SourcePortRanges": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "AnalysisRouteTableRoute": { + "additionalProperties": false, + "properties": { + "NatGatewayId": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "Origin": { + "type": "string" + }, + "State": { + "type": "string" + }, + "TransitGatewayId": { + "type": "string" + }, + "VpcPeeringConnectionId": { + "type": "string" + }, + "destinationCidr": { + "type": "string" + }, + "destinationPrefixListId": { + "type": "string" + }, + "egressOnlyInternetGatewayId": { + "type": "string" + }, + "gatewayId": { + "type": "string" + }, + "instanceId": { + "type": "string" + } + }, + "type": "object" + }, + "AnalysisSecurityGroupRule": { + "additionalProperties": false, + "properties": { + "Cidr": { + "type": "string" + }, + "Direction": { + "type": "string" + }, + "PortRange": { + "$ref": "#/definitions/PortRange" + }, + "PrefixListId": { + "type": "string" + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "SecurityGroupId": { + "type": "string" + } + }, + "type": "object" + }, + "Explanation": { + "additionalProperties": false, + "properties": { + "Acl": { + "$ref": "#/definitions/AnalysisComponent" + }, + "AclRule": { + "$ref": "#/definitions/AnalysisAclRule" + }, + "Address": { + "$ref": "#/definitions/IpAddress" + }, + "Addresses": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpAddress" + }, + "type": "array", + "uniqueItems": false + }, + "AttachedTo": { + "$ref": "#/definitions/AnalysisComponent" + }, + "AvailabilityZones": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Cidrs": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ClassicLoadBalancerListener": { + "$ref": "#/definitions/AnalysisLoadBalancerListener" + }, + "Component": { + "$ref": "#/definitions/AnalysisComponent" + }, + "ComponentAccount": { + "type": "string" + }, + "ComponentRegion": { + "type": "string" + }, + "CustomerGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Destination": { + "$ref": "#/definitions/AnalysisComponent" + }, + "DestinationVpc": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Direction": { + "type": "string" + }, + "ElasticLoadBalancerListener": { + "$ref": "#/definitions/AnalysisComponent" + }, + "ExplanationCode": { + "type": "string" + }, + "IngressRouteTable": { + "$ref": "#/definitions/AnalysisComponent" + }, + "InternetGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "LoadBalancerArn": { + "$ref": "#/definitions/ResourceArn" + }, + "LoadBalancerListenerPort": { + "$ref": "#/definitions/Port" + }, + "LoadBalancerTarget": { + "$ref": "#/definitions/AnalysisLoadBalancerTarget" + }, + "LoadBalancerTargetGroup": { + "$ref": "#/definitions/AnalysisComponent" + }, + "LoadBalancerTargetGroups": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AnalysisComponent" + }, + "type": "array", + "uniqueItems": false + }, + "LoadBalancerTargetPort": { + "$ref": "#/definitions/Port" + }, + "MissingComponent": { + "type": "string" + }, + "NatGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "NetworkInterface": { + "$ref": "#/definitions/AnalysisComponent" + }, + "PacketField": { + "type": "string" + }, + "Port": { + "$ref": "#/definitions/Port" + }, + "PortRanges": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "PrefixList": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Protocols": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Protocol" + }, + "type": "array", + "uniqueItems": false + }, + "RouteTable": { + "$ref": "#/definitions/AnalysisComponent" + }, + "RouteTableRoute": { + "$ref": "#/definitions/AnalysisRouteTableRoute" + }, + "SecurityGroup": { + "$ref": "#/definitions/AnalysisComponent" + }, + "SecurityGroupRule": { + "$ref": "#/definitions/AnalysisSecurityGroupRule" + }, + "SecurityGroups": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AnalysisComponent" + }, + "type": "array", + "uniqueItems": false + }, + "SourceVpc": { + "$ref": "#/definitions/AnalysisComponent" + }, + "State": { + "type": "string" + }, + "Subnet": { + "$ref": "#/definitions/AnalysisComponent" + }, + "SubnetRouteTable": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGatewayAttachment": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGatewayRouteTable": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGatewayRouteTableRoute": { + "$ref": "#/definitions/TransitGatewayRouteTableRoute" + }, + "Vpc": { + "$ref": "#/definitions/AnalysisComponent" + }, + "VpcPeeringConnection": { + "$ref": "#/definitions/AnalysisComponent" + }, + "VpnConnection": { + "$ref": "#/definitions/AnalysisComponent" + }, + "VpnGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "vpcEndpoint": { + "$ref": "#/definitions/AnalysisComponent" + } + }, + "type": "object" + }, + "IpAddress": { + "type": "string" + }, + "PathComponent": { + "additionalProperties": false, + "properties": { + "AclRule": { + "$ref": "#/definitions/AnalysisAclRule" + }, + "AdditionalDetails": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AdditionalDetail" + }, + "type": "array", + "uniqueItems": false + }, + "Component": { + "$ref": "#/definitions/AnalysisComponent" + }, + "DestinationVpc": { + "$ref": "#/definitions/AnalysisComponent" + }, + "ElasticLoadBalancerListener": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Explanations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Explanation" + }, + "type": "array", + "uniqueItems": false + }, + "InboundHeader": { + "$ref": "#/definitions/AnalysisPacketHeader" + }, + "OutboundHeader": { + "$ref": "#/definitions/AnalysisPacketHeader" + }, + "RouteTableRoute": { + "$ref": "#/definitions/AnalysisRouteTableRoute" + }, + "SecurityGroupRule": { + "$ref": "#/definitions/AnalysisSecurityGroupRule" + }, + "SequenceNumber": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + }, + "SourceVpc": { + "$ref": "#/definitions/AnalysisComponent" + }, + "Subnet": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGateway": { + "$ref": "#/definitions/AnalysisComponent" + }, + "TransitGatewayRouteTableRoute": { + "$ref": "#/definitions/TransitGatewayRouteTableRoute" + }, + "Vpc": { + "$ref": "#/definitions/AnalysisComponent" + } + }, + "type": "object" + }, + "Port": { + "type": "integer" + }, + "PortRange": { + "additionalProperties": false, + "properties": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + } + }, + "type": "object" + }, + "Protocol": { + "type": "string" + }, + "ResourceArn": { + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TransitGatewayRouteTableRoute": { + "additionalProperties": false, + "properties": { + "AttachmentId": { + "type": "string" + }, + "DestinationCidr": { + "type": "string" + }, + "PrefixListId": { + "type": "string" + }, + "ResourceId": { + "type": "string" + }, + "ResourceType": { + "type": "string" + }, + "RouteOrigin": { + "type": "string" + }, + "State": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::EC2::NetworkInsightsAnalysis", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTags", + "ec2:StartNetworkInsightsAnalysis", + "ec2:GetTransitGatewayRouteTablePropagations", + "ec2:SearchTransitGatewayRoutes", + "ec2:Describe*", + "ec2:GetManagedPrefixListEntries", + "elasticloadbalancing:Describe*", + "directconnect:Describe*", + "tiros:CreateQuery", + "tiros:GetQueryAnswer", + "tiros:GetQueryExplanation" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNetworkInsightsAnalysis", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:Describe*" + ] + }, + "read": { + "permissions": [ + "ec2:Describe*" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:Describe*", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/NetworkInsightsAnalysisId" + ], + "properties": { + "AdditionalAccounts": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AlternatePathHints": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AlternatePathHint" + }, + "type": "array", + "uniqueItems": false + }, + "Explanations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Explanation" + }, + "type": "array", + "uniqueItems": false + }, + "FilterInArns": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ResourceArn" + }, + "type": "array", + "uniqueItems": false + }, + "ForwardPathComponents": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PathComponent" + }, + "type": "array", + "uniqueItems": false + }, + "NetworkInsightsAnalysisArn": { + "type": "string" + }, + "NetworkInsightsAnalysisId": { + "type": "string" + }, + "NetworkInsightsPathId": { + "type": "string" + }, + "NetworkPathFound": { + "type": "boolean" + }, + "ReturnPathComponents": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PathComponent" + }, + "type": "array", + "uniqueItems": false + }, + "StartDate": { + "type": "string" + }, + "Status": { + "enum": [ + "running", + "failed", + "succeeded" + ], + "type": "string" + }, + "StatusMessage": { + "type": "string" + }, + "SuggestedAccounts": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/NetworkInsightsAnalysisId", + "/properties/NetworkInsightsAnalysisArn", + "/properties/StartDate", + "/properties/Status", + "/properties/StatusMessage", + "/properties/NetworkPathFound", + "/properties/ForwardPathComponents", + "/properties/ReturnPathComponents", + "/properties/Explanations", + "/properties/AlternatePathHints", + "/properties/SuggestedAccounts" + ], + "required": [ + "NetworkInsightsPathId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", + "typeName": "AWS::EC2::NetworkInsightsAnalysis" +} diff --git a/schema/aws-ec2-networkinsightspath.json b/schema/aws-ec2-networkinsightspath.json index e8d24ed..cb1b505 100644 --- a/schema/aws-ec2-networkinsightspath.json +++ b/schema/aws-ec2-networkinsightspath.json @@ -1,181 +1,181 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/NetworkInsightsPathArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceIp", - "/properties/DestinationIp", - "/properties/Source", - "/properties/Destination", - "/properties/Protocol", - "/properties/DestinationPort", - "/properties/FilterAtSource", - "/properties/FilterAtDestination" - ], - "definitions": { - "FilterPortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "integer" - }, - "ToPort": { - "type": "integer" - } - }, - "type": "object" - }, - "IpAddress": { - "type": "string" - }, - "PathFilter": { - "additionalProperties": false, - "properties": { - "DestinationAddress": { - "$ref": "#/definitions/IpAddress" - }, - "DestinationPortRange": { - "$ref": "#/definitions/FilterPortRange" - }, - "SourceAddress": { - "$ref": "#/definitions/IpAddress" - }, - "SourcePortRange": { - "$ref": "#/definitions/FilterPortRange" - } - }, - "type": "object" - }, - "Port": { - "type": "integer" - }, - "Protocol": { - "enum": [ - "tcp", - "udp" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "Resource schema for AWS::EC2::NetworkInsightsPath", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkInsightsPath", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteNetworkInsightsPath", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkInsightsPaths" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkInsightsPaths" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNetworkInsightsPaths", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/NetworkInsightsPathId" - ], - "properties": { - "CreatedDate": { - "type": "string" - }, - "Destination": { - "type": "string" - }, - "DestinationArn": { - "type": "string" - }, - "DestinationIp": { - "$ref": "#/definitions/IpAddress" - }, - "DestinationPort": { - "$ref": "#/definitions/Port" - }, - "FilterAtDestination": { - "$ref": "#/definitions/PathFilter" - }, - "FilterAtSource": { - "$ref": "#/definitions/PathFilter" - }, - "NetworkInsightsPathArn": { - "type": "string" - }, - "NetworkInsightsPathId": { - "type": "string" - }, - "Protocol": { - "$ref": "#/definitions/Protocol" - }, - "Source": { - "type": "string" - }, - "SourceArn": { - "type": "string" - }, - "SourceIp": { - "$ref": "#/definitions/IpAddress" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/NetworkInsightsPathId", - "/properties/NetworkInsightsPathArn", - "/properties/CreatedDate", - "/properties/SourceArn", - "/properties/DestinationArn" - ], - "required": [ - "Protocol", - "Source" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", - "typeName": "AWS::EC2::NetworkInsightsPath" -} +{ + "additionalIdentifiers": [ + [ + "/properties/NetworkInsightsPathArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceIp", + "/properties/DestinationIp", + "/properties/Source", + "/properties/Destination", + "/properties/Protocol", + "/properties/DestinationPort", + "/properties/FilterAtSource", + "/properties/FilterAtDestination" + ], + "definitions": { + "FilterPortRange": { + "additionalProperties": false, + "properties": { + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + } + }, + "type": "object" + }, + "IpAddress": { + "type": "string" + }, + "PathFilter": { + "additionalProperties": false, + "properties": { + "DestinationAddress": { + "$ref": "#/definitions/IpAddress" + }, + "DestinationPortRange": { + "$ref": "#/definitions/FilterPortRange" + }, + "SourceAddress": { + "$ref": "#/definitions/IpAddress" + }, + "SourcePortRange": { + "$ref": "#/definitions/FilterPortRange" + } + }, + "type": "object" + }, + "Port": { + "type": "integer" + }, + "Protocol": { + "enum": [ + "tcp", + "udp" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "Resource schema for AWS::EC2::NetworkInsightsPath", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkInsightsPath", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteNetworkInsightsPath", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkInsightsPaths" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkInsightsPaths" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNetworkInsightsPaths", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/NetworkInsightsPathId" + ], + "properties": { + "CreatedDate": { + "type": "string" + }, + "Destination": { + "type": "string" + }, + "DestinationArn": { + "type": "string" + }, + "DestinationIp": { + "$ref": "#/definitions/IpAddress" + }, + "DestinationPort": { + "$ref": "#/definitions/Port" + }, + "FilterAtDestination": { + "$ref": "#/definitions/PathFilter" + }, + "FilterAtSource": { + "$ref": "#/definitions/PathFilter" + }, + "NetworkInsightsPathArn": { + "type": "string" + }, + "NetworkInsightsPathId": { + "type": "string" + }, + "Protocol": { + "$ref": "#/definitions/Protocol" + }, + "Source": { + "type": "string" + }, + "SourceArn": { + "type": "string" + }, + "SourceIp": { + "$ref": "#/definitions/IpAddress" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/NetworkInsightsPathId", + "/properties/NetworkInsightsPathArn", + "/properties/CreatedDate", + "/properties/SourceArn", + "/properties/DestinationArn" + ], + "required": [ + "Protocol", + "Source" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni.git", + "typeName": "AWS::EC2::NetworkInsightsPath" +} diff --git a/schema/aws-ec2-networkinterface.json b/schema/aws-ec2-networkinterface.json index 1052372..23819b5 100644 --- a/schema/aws-ec2-networkinterface.json +++ b/schema/aws-ec2-networkinterface.json @@ -1,278 +1,278 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/PrivateIpAddresses", - "/properties/EnablePrimaryIpv6", - "/properties/ConnectionTrackingSpecification" - ], - "createOnlyProperties": [ - "/properties/PrivateIpAddress", - "/properties/InterfaceType", - "/properties/SubnetId" - ], - "definitions": { - "ConnectionTrackingSpecification": { - "additionalProperties": false, - "properties": { - "TcpEstablishedTimeout": { - "type": "integer" - }, - "UdpStreamTimeout": { - "type": "integer" - }, - "UdpTimeout": { - "type": "integer" - } - }, - "type": "object" - }, - "InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "Ipv4PrefixSpecification": { - "additionalProperties": false, - "properties": { - "Ipv4Prefix": { - "type": "string" - } - }, - "required": [ - "Ipv4Prefix" - ], - "type": "object" - }, - "Ipv6PrefixSpecification": { - "additionalProperties": false, - "properties": { - "Ipv6Prefix": { - "type": "string" - } - }, - "required": [ - "Ipv6Prefix" - ], - "type": "object" - }, - "PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "required": [ - "PrivateIpAddress", - "Primary" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::EC2::NetworkInterface resource creates network interface", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkInterface", - "ec2:DescribeNetworkInterfaces", - "ec2:CreateTags", - "ec2:ModifyNetworkInterfaceAttribute" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeNetworkInterfaces", - "ec2:DeleteNetworkInterface" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkInterfaces" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkInterfaces" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeNetworkInterfaces", - "ec2:ModifyNetworkInterfaceAttribute", - "ec2:UnassignIpv6Addresses", - "ec2:AssignIpv6Addresses", - "ec2:DeleteTags", - "ec2:CreateTags", - "ec2:UnassignPrivateIpAddresses", - "ec2:AssignPrivateIpAddresses" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConnectionTrackingSpecification": { - "$ref": "#/definitions/ConnectionTrackingSpecification" - }, - "Description": { - "description": "A description for the network interface.", - "type": "string" - }, - "EnablePrimaryIpv6": { - "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.", - "type": "boolean" - }, - "GroupSet": { - "description": "A list of security group IDs associated with this network interface.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "description": "Network interface id.", - "type": "string" - }, - "InterfaceType": { - "description": "Indicates the type of network interface.", - "type": "string" - }, - "Ipv4PrefixCount": { - "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", - "type": "integer" - }, - "Ipv4Prefixes": { - "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ipv4PrefixSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "Ipv6AddressCount": { - "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.", - "type": "integer" - }, - "Ipv6Addresses": { - "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceIpv6Address" - }, - "type": "array", - "uniqueItems": true - }, - "Ipv6PrefixCount": { - "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", - "type": "integer" - }, - "Ipv6Prefixes": { - "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ipv6PrefixSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "PrimaryIpv6Address": { - "description": "The primary IPv6 address", - "type": "string" - }, - "PrimaryPrivateIpAddress": { - "description": "Returns the primary private IP address of the network interface.", - "type": "string" - }, - "PrivateIpAddress": { - "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ", - "type": "string" - }, - "PrivateIpAddresses": { - "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PrivateIpAddressSpecification" - }, - "type": "array", - "uniqueItems": false - }, - "SecondaryPrivateIpAddressCount": { - "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses", - "type": "integer" - }, - "SecondaryPrivateIpAddresses": { - "description": "Returns the secondary private IP addresses of the network interface.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceDestCheck": { - "description": "Indicates whether traffic to or from the instance is validated.", - "type": "boolean" - }, - "SubnetId": { - "description": "The ID of the subnet to associate with the network interface.", - "type": "string" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this network interface.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/SecondaryPrivateIpAddresses", - "/properties/PrimaryPrivateIpAddress", - "/properties/PrimaryIpv6Address", - "/properties/VpcId" - ], - "required": [ - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/networkinterface", - "taggable": true, - "typeName": "AWS::EC2::NetworkInterface" -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/PrivateIpAddresses", + "/properties/EnablePrimaryIpv6", + "/properties/ConnectionTrackingSpecification" + ], + "createOnlyProperties": [ + "/properties/PrivateIpAddress", + "/properties/InterfaceType", + "/properties/SubnetId" + ], + "definitions": { + "ConnectionTrackingSpecification": { + "additionalProperties": false, + "properties": { + "TcpEstablishedTimeout": { + "type": "integer" + }, + "UdpStreamTimeout": { + "type": "integer" + }, + "UdpTimeout": { + "type": "integer" + } + }, + "type": "object" + }, + "InstanceIpv6Address": { + "additionalProperties": false, + "properties": { + "Ipv6Address": { + "type": "string" + } + }, + "required": [ + "Ipv6Address" + ], + "type": "object" + }, + "Ipv4PrefixSpecification": { + "additionalProperties": false, + "properties": { + "Ipv4Prefix": { + "type": "string" + } + }, + "required": [ + "Ipv4Prefix" + ], + "type": "object" + }, + "Ipv6PrefixSpecification": { + "additionalProperties": false, + "properties": { + "Ipv6Prefix": { + "type": "string" + } + }, + "required": [ + "Ipv6Prefix" + ], + "type": "object" + }, + "PrivateIpAddressSpecification": { + "additionalProperties": false, + "properties": { + "Primary": { + "type": "boolean" + }, + "PrivateIpAddress": { + "type": "string" + } + }, + "required": [ + "PrivateIpAddress", + "Primary" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::EC2::NetworkInterface resource creates network interface", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkInterface", + "ec2:DescribeNetworkInterfaces", + "ec2:CreateTags", + "ec2:ModifyNetworkInterfaceAttribute" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeNetworkInterfaces", + "ec2:DeleteNetworkInterface" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkInterfaces" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkInterfaces" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeNetworkInterfaces", + "ec2:ModifyNetworkInterfaceAttribute", + "ec2:UnassignIpv6Addresses", + "ec2:AssignIpv6Addresses", + "ec2:DeleteTags", + "ec2:CreateTags", + "ec2:UnassignPrivateIpAddresses", + "ec2:AssignPrivateIpAddresses" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConnectionTrackingSpecification": { + "$ref": "#/definitions/ConnectionTrackingSpecification" + }, + "Description": { + "description": "A description for the network interface.", + "type": "string" + }, + "EnablePrimaryIpv6": { + "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.", + "type": "boolean" + }, + "GroupSet": { + "description": "A list of security group IDs associated with this network interface.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "description": "Network interface id.", + "type": "string" + }, + "InterfaceType": { + "description": "Indicates the type of network interface.", + "type": "string" + }, + "Ipv4PrefixCount": { + "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", + "type": "integer" + }, + "Ipv4Prefixes": { + "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Ipv4PrefixSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "Ipv6AddressCount": { + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.", + "type": "integer" + }, + "Ipv6Addresses": { + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "type": "array", + "uniqueItems": true + }, + "Ipv6PrefixCount": { + "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", + "type": "integer" + }, + "Ipv6Prefixes": { + "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Ipv6PrefixSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "PrimaryIpv6Address": { + "description": "The primary IPv6 address", + "type": "string" + }, + "PrimaryPrivateIpAddress": { + "description": "Returns the primary private IP address of the network interface.", + "type": "string" + }, + "PrivateIpAddress": { + "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ", + "type": "string" + }, + "PrivateIpAddresses": { + "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PrivateIpAddressSpecification" + }, + "type": "array", + "uniqueItems": false + }, + "SecondaryPrivateIpAddressCount": { + "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses", + "type": "integer" + }, + "SecondaryPrivateIpAddresses": { + "description": "Returns the secondary private IP addresses of the network interface.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceDestCheck": { + "description": "Indicates whether traffic to or from the instance is validated.", + "type": "boolean" + }, + "SubnetId": { + "description": "The ID of the subnet to associate with the network interface.", + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this network interface.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/SecondaryPrivateIpAddresses", + "/properties/PrimaryPrivateIpAddress", + "/properties/PrimaryIpv6Address", + "/properties/VpcId" + ], + "required": [ + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/networkinterface", + "taggable": true, + "typeName": "AWS::EC2::NetworkInterface" +} diff --git a/schema/aws-ec2-networkinterfaceattachment.json b/schema/aws-ec2-networkinterfaceattachment.json index 78740cf..6e534b6 100644 --- a/schema/aws-ec2-networkinterfaceattachment.json +++ b/schema/aws-ec2-networkinterfaceattachment.json @@ -1,117 +1,117 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/NetworkInterfaceId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeviceIndex", - "/properties/InstanceId", - "/properties/NetworkInterfaceId" - ], - "definitions": { - "EnaSrdSpecification": { - "additionalProperties": false, - "description": "ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.", - "properties": { - "EnaSrdEnabled": { - "description": "Indicates whether ENA Express is enabled for the network interface.", - "type": "boolean" - }, - "EnaSrdUdpSpecification": { - "additionalProperties": false, - "description": "Configures ENA Express for UDP network traffic.", - "properties": { - "EnaSrdUdpEnabled": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.", - "handlers": { - "create": { - "permissions": [ - "ec2:AttachNetworkInterface", - "ec2:DescribeNetworkInterfaces", - "ec2:ModifyNetworkInterfaceAttribute" - ] - }, - "delete": { - "permissions": [ - "ec2:DetachNetworkInterface", - "ec2:DescribeNetworkInterfaces" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkInterfaces" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkInterfaces" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyNetworkInterfaceAttribute", - "ec2:DescribeNetworkInterfaces", - "ec2:AttachNetworkInterface", - "ec2:DetachNetworkInterface" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentId" - ], - "properties": { - "AttachmentId": { - "description": "", - "type": "string" - }, - "DeleteOnTermination": { - "default": true, - "description": "Whether to delete the network interface when the instance terminates. By default, this value is set to ``true``.", - "type": "boolean" - }, - "DeviceIndex": { - "description": "The network interface's position in the attachment order. For example, the first attached network interface has a ``DeviceIndex`` of 0.", - "type": "string" - }, - "EnaSrdSpecification": { - "$ref": "#/definitions/EnaSrdSpecification", - "description": "Configures ENA Express for the network interface that this action attaches to the instance." - }, - "InstanceId": { - "description": "The ID of the instance to which you will attach the ENI.", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of the ENI that you want to attach.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AttachmentId" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "DeviceIndex", - "InstanceId", - "NetworkInterfaceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::NetworkInterfaceAttachment" -} +{ + "additionalIdentifiers": [ + [ + "/properties/NetworkInterfaceId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeviceIndex", + "/properties/InstanceId", + "/properties/NetworkInterfaceId" + ], + "definitions": { + "EnaSrdSpecification": { + "additionalProperties": false, + "description": "ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.", + "properties": { + "EnaSrdEnabled": { + "description": "Indicates whether ENA Express is enabled for the network interface.", + "type": "boolean" + }, + "EnaSrdUdpSpecification": { + "additionalProperties": false, + "description": "Configures ENA Express for UDP network traffic.", + "properties": { + "EnaSrdUdpEnabled": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.", + "handlers": { + "create": { + "permissions": [ + "ec2:AttachNetworkInterface", + "ec2:DescribeNetworkInterfaces", + "ec2:ModifyNetworkInterfaceAttribute" + ] + }, + "delete": { + "permissions": [ + "ec2:DetachNetworkInterface", + "ec2:DescribeNetworkInterfaces" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkInterfaces" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkInterfaces" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyNetworkInterfaceAttribute", + "ec2:DescribeNetworkInterfaces", + "ec2:AttachNetworkInterface", + "ec2:DetachNetworkInterface" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentId" + ], + "properties": { + "AttachmentId": { + "description": "", + "type": "string" + }, + "DeleteOnTermination": { + "default": true, + "description": "Whether to delete the network interface when the instance terminates. By default, this value is set to ``true``.", + "type": "boolean" + }, + "DeviceIndex": { + "description": "The network interface's position in the attachment order. For example, the first attached network interface has a ``DeviceIndex`` of 0.", + "type": "string" + }, + "EnaSrdSpecification": { + "$ref": "#/definitions/EnaSrdSpecification", + "description": "Configures ENA Express for the network interface that this action attaches to the instance." + }, + "InstanceId": { + "description": "The ID of the instance to which you will attach the ENI.", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The ID of the ENI that you want to attach.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AttachmentId" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "DeviceIndex", + "InstanceId", + "NetworkInterfaceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::NetworkInterfaceAttachment" +} diff --git a/schema/aws-ec2-networkinterfacepermission.json b/schema/aws-ec2-networkinterfacepermission.json index 0f335ac..9dbe2d7 100644 --- a/schema/aws-ec2-networkinterfacepermission.json +++ b/schema/aws-ec2-networkinterfacepermission.json @@ -1,35 +1,35 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/Permission", - "/properties/NetworkInterfaceId" - ], - "description": "Resource Type definition for AWS::EC2::NetworkInterfacePermission", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AwsAccountId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "Permission": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "AwsAccountId", - "NetworkInterfaceId", - "Permission" - ], - "typeName": "AWS::EC2::NetworkInterfacePermission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/Permission", + "/properties/NetworkInterfaceId" + ], + "description": "Resource Type definition for AWS::EC2::NetworkInterfacePermission", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AwsAccountId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "Permission": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "AwsAccountId", + "NetworkInterfaceId", + "Permission" + ], + "typeName": "AWS::EC2::NetworkInterfacePermission" +} diff --git a/schema/aws-ec2-networkperformancemetricsubscription.json b/schema/aws-ec2-networkperformancemetricsubscription.json index b2c25de..474fc59 100644 --- a/schema/aws-ec2-networkperformancemetricsubscription.json +++ b/schema/aws-ec2-networkperformancemetricsubscription.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Source", - "/properties/Destination", - "/properties/Metric", - "/properties/Statistic" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions", - "ec2:EnableAwsNetworkPerformanceMetricSubscription" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions", - "ec2:DisableAwsNetworkPerformanceMetricSubscription" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions" - ] - } - }, - "primaryIdentifier": [ - "/properties/Source", - "/properties/Destination", - "/properties/Metric", - "/properties/Statistic" - ], - "properties": { - "Destination": { - "description": "The target Region or Availability Zone for the metric to subscribe to.", - "type": "string" - }, - "Metric": { - "description": "The metric type to subscribe to.", - "type": "string" - }, - "Source": { - "description": "The starting Region or Availability Zone for metric to subscribe to.", - "type": "string" - }, - "Statistic": { - "description": "The statistic to subscribe to.", - "type": "string" - } - }, - "required": [ - "Source", - "Destination", - "Metric", - "Statistic" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::NetworkPerformanceMetricSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Source", + "/properties/Destination", + "/properties/Metric", + "/properties/Statistic" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions", + "ec2:EnableAwsNetworkPerformanceMetricSubscription" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions", + "ec2:DisableAwsNetworkPerformanceMetricSubscription" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeAwsNetworkPerformanceMetricSubscriptions" + ] + } + }, + "primaryIdentifier": [ + "/properties/Source", + "/properties/Destination", + "/properties/Metric", + "/properties/Statistic" + ], + "properties": { + "Destination": { + "description": "The target Region or Availability Zone for the metric to subscribe to.", + "type": "string" + }, + "Metric": { + "description": "The metric type to subscribe to.", + "type": "string" + }, + "Source": { + "description": "The starting Region or Availability Zone for metric to subscribe to.", + "type": "string" + }, + "Statistic": { + "description": "The statistic to subscribe to.", + "type": "string" + } + }, + "required": [ + "Source", + "Destination", + "Metric", + "Statistic" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::NetworkPerformanceMetricSubscription" +} diff --git a/schema/aws-ec2-placementgroup.json b/schema/aws-ec2-placementgroup.json index fd8042d..b7d1ff9 100644 --- a/schema/aws-ec2-placementgroup.json +++ b/schema/aws-ec2-placementgroup.json @@ -1,100 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags", - "/properties/Strategy", - "/properties/SpreadLevel", - "/properties/PartitionCount" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::PlacementGroup", - "handlers": { - "create": { - "permissions": [ - "ec2:CreatePlacementGroup", - "ec2:DescribePlacementGroups", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeletePlacementGroup", - "ec2:DescribePlacementGroups" - ] - }, - "list": { - "permissions": [ - "ec2:DescribePlacementGroups" - ] - }, - "read": { - "permissions": [ - "ec2:DescribePlacementGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/GroupName" - ], - "properties": { - "GroupName": { - "description": "The Group Name of Placement Group.", - "type": "string" - }, - "PartitionCount": { - "description": "The number of partitions. Valid only when **Strategy** is set to `partition`", - "type": "integer" - }, - "SpreadLevel": { - "description": "The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread", - "type": "string" - }, - "Strategy": { - "description": "The placement strategy.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/GroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", - "tagging": { - "cloudFormationSystemTags": false, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::EC2::PlacementGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags", + "/properties/Strategy", + "/properties/SpreadLevel", + "/properties/PartitionCount" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::PlacementGroup", + "handlers": { + "create": { + "permissions": [ + "ec2:CreatePlacementGroup", + "ec2:DescribePlacementGroups", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeletePlacementGroup", + "ec2:DescribePlacementGroups" + ] + }, + "list": { + "permissions": [ + "ec2:DescribePlacementGroups" + ] + }, + "read": { + "permissions": [ + "ec2:DescribePlacementGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/GroupName" + ], + "properties": { + "GroupName": { + "description": "The Group Name of Placement Group.", + "type": "string" + }, + "PartitionCount": { + "description": "The number of partitions. Valid only when **Strategy** is set to `partition`", + "type": "integer" + }, + "SpreadLevel": { + "description": "The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread", + "type": "string" + }, + "Strategy": { + "description": "The placement strategy.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/GroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ec2:CreateTags" + ], + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::EC2::PlacementGroup" +} diff --git a/schema/aws-ec2-prefixlist.json b/schema/aws-ec2-prefixlist.json index bbc67fd..a494e85 100644 --- a/schema/aws-ec2-prefixlist.json +++ b/schema/aws-ec2-prefixlist.json @@ -1,151 +1,156 @@ -{ - "additionalProperties": false, - "definitions": { - "Entry": { - "additionalProperties": false, - "properties": { - "Cidr": { - "maxLength": 46, - "minLength": 1, - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Cidr" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema of AWS::EC2::PrefixList Type", - "handlers": { - "create": { - "permissions": [ - "EC2:CreateManagedPrefixList", - "EC2:DescribeManagedPrefixLists", - "EC2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "EC2:DeleteManagedPrefixList", - "EC2:DescribeManagedPrefixLists" - ] - }, - "list": { - "permissions": [ - "EC2:DescribeManagedPrefixLists", - "EC2:GetManagedPrefixListEntries" - ] - }, - "read": { - "permissions": [ - "EC2:GetManagedPrefixListEntries", - "EC2:DescribeManagedPrefixLists" - ] - }, - "update": { - "permissions": [ - "EC2:DescribeManagedPrefixLists", - "EC2:GetManagedPrefixListEntries", - "EC2:ModifyManagedPrefixList", - "EC2:CreateTags", - "EC2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/PrefixListId" - ], - "properties": { - "AddressFamily": { - "description": "Ip Version of Prefix List.", - "enum": [ - "IPv4", - "IPv6" - ], - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the Prefix List.", - "type": "string" - }, - "Entries": { - "description": "Entries of Prefix List.", - "items": { - "$ref": "#/definitions/Entry" - }, - "type": "array" - }, - "MaxEntries": { - "description": "Max Entries of Prefix List.", - "minimum": 1, - "type": "integer" - }, - "OwnerId": { - "description": "Owner Id of Prefix List.", - "type": "string" - }, - "PrefixListId": { - "description": "Id of Prefix List.", - "type": "string" - }, - "PrefixListName": { - "description": "Name of Prefix List.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "Tags for Prefix List", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Version": { - "description": "Version of Prefix List.", - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/PrefixListId", - "/properties/OwnerId", - "/properties/Version", - "/properties/Arn" - ], - "required": [ - "PrefixListName", - "AddressFamily" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::PrefixList" -} +{ + "additionalProperties": false, + "definitions": { + "Entry": { + "additionalProperties": false, + "properties": { + "Cidr": { + "maxLength": 46, + "minLength": 1, + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Cidr" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema of AWS::EC2::PrefixList Type", + "handlers": { + "create": { + "permissions": [ + "EC2:CreateManagedPrefixList", + "EC2:DescribeManagedPrefixLists", + "EC2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "EC2:DeleteManagedPrefixList", + "EC2:DescribeManagedPrefixLists" + ] + }, + "list": { + "permissions": [ + "EC2:DescribeManagedPrefixLists", + "EC2:GetManagedPrefixListEntries" + ] + }, + "read": { + "permissions": [ + "EC2:GetManagedPrefixListEntries", + "EC2:DescribeManagedPrefixLists" + ] + }, + "update": { + "permissions": [ + "EC2:DescribeManagedPrefixLists", + "EC2:GetManagedPrefixListEntries", + "EC2:ModifyManagedPrefixList", + "EC2:CreateTags", + "EC2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/PrefixListId" + ], + "properties": { + "AddressFamily": { + "description": "Ip Version of Prefix List.", + "enum": [ + "IPv4", + "IPv6" + ], + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the Prefix List.", + "type": "string" + }, + "Entries": { + "description": "Entries of Prefix List.", + "items": { + "$ref": "#/definitions/Entry" + }, + "type": "array" + }, + "MaxEntries": { + "description": "Max Entries of Prefix List.", + "minimum": 1, + "type": "integer" + }, + "OwnerId": { + "description": "Owner Id of Prefix List.", + "type": "string" + }, + "PrefixListId": { + "description": "Id of Prefix List.", + "type": "string" + }, + "PrefixListName": { + "description": "Name of Prefix List.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "Tags for Prefix List", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Version": { + "description": "Version of Prefix List.", + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/PrefixListId", + "/properties/OwnerId", + "/properties/Version", + "/properties/Arn" + ], + "required": [ + "PrefixListName", + "AddressFamily" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "EC2:DeleteTags", + "EC2:CreateTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::PrefixList" +} diff --git a/schema/aws-ec2-route.json b/schema/aws-ec2-route.json index beb98a9..f134033 100644 --- a/schema/aws-ec2-route.json +++ b/schema/aws-ec2-route.json @@ -1,133 +1,133 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RouteTableId", - "/properties/DestinationCidrBlock", - "/properties/DestinationIpv6CidrBlock", - "/properties/DestinationPrefixListId" - ], - "description": "Specifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.\n You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.\n If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateRoute", - "ec2:DescribeRouteTables", - "ec2:DescribeNetworkInterfaces" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteRoute", - "ec2:DescribeRouteTables" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RouteTableId": { - "$ref": "resource-schema.json#/properties/RouteTableId" - } - }, - "required": [ - "RouteTableId" - ] - }, - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "update": { - "permissions": [ - "ec2:ReplaceRoute", - "ec2:DescribeRouteTables", - "ec2:DescribeNetworkInterfaces" - ] - } - }, - "primaryIdentifier": [ - "/properties/RouteTableId", - "/properties/CidrBlock" - ], - "properties": { - "CarrierGatewayId": { - "description": "The ID of the carrier gateway.\n You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.", - "type": "string" - }, - "CidrBlock": { - "description": "", - "type": "string" - }, - "CoreNetworkArn": { - "description": "The Amazon Resource Name (ARN) of the core network.", - "type": "string" - }, - "DestinationCidrBlock": { - "description": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.", - "type": "string" - }, - "DestinationIpv6CidrBlock": { - "description": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.", - "type": "string" - }, - "DestinationPrefixListId": { - "description": "The ID of a prefix list used for the destination match.", - "type": "string" - }, - "EgressOnlyInternetGatewayId": { - "description": "[IPv6 traffic only] The ID of an egress-only internet gateway.", - "type": "string" - }, - "GatewayId": { - "description": "The ID of an internet gateway or virtual private gateway attached to your VPC.", - "type": "string" - }, - "InstanceId": { - "description": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.", - "type": "string" - }, - "LocalGatewayId": { - "description": "The ID of the local gateway.", - "type": "string" - }, - "NatGatewayId": { - "description": "[IPv4 traffic only] The ID of a NAT gateway.", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of a network interface.", - "type": "string" - }, - "RouteTableId": { - "description": "The ID of the route table for the route.", - "type": "string" - }, - "TransitGatewayId": { - "description": "The ID of a transit gateway.", - "type": "string" - }, - "VpcEndpointId": { - "description": "The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.", - "type": "string" - }, - "VpcPeeringConnectionId": { - "description": "The ID of a VPC peering connection.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CidrBlock" - ], - "required": [ - "RouteTableId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::Route" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RouteTableId", + "/properties/DestinationCidrBlock", + "/properties/DestinationIpv6CidrBlock", + "/properties/DestinationPrefixListId" + ], + "description": "Specifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.\n You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.\n If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateRoute", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkInterfaces" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteRoute", + "ec2:DescribeRouteTables" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RouteTableId": { + "$ref": "resource-schema.json#/properties/RouteTableId" + } + }, + "required": [ + "RouteTableId" + ] + }, + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "update": { + "permissions": [ + "ec2:ReplaceRoute", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkInterfaces" + ] + } + }, + "primaryIdentifier": [ + "/properties/RouteTableId", + "/properties/CidrBlock" + ], + "properties": { + "CarrierGatewayId": { + "description": "The ID of the carrier gateway.\n You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.", + "type": "string" + }, + "CidrBlock": { + "description": "", + "type": "string" + }, + "CoreNetworkArn": { + "description": "The Amazon Resource Name (ARN) of the core network.", + "type": "string" + }, + "DestinationCidrBlock": { + "description": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.", + "type": "string" + }, + "DestinationIpv6CidrBlock": { + "description": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.", + "type": "string" + }, + "DestinationPrefixListId": { + "description": "The ID of a prefix list used for the destination match.", + "type": "string" + }, + "EgressOnlyInternetGatewayId": { + "description": "[IPv6 traffic only] The ID of an egress-only internet gateway.", + "type": "string" + }, + "GatewayId": { + "description": "The ID of an internet gateway or virtual private gateway attached to your VPC.", + "type": "string" + }, + "InstanceId": { + "description": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.", + "type": "string" + }, + "LocalGatewayId": { + "description": "The ID of the local gateway.", + "type": "string" + }, + "NatGatewayId": { + "description": "[IPv4 traffic only] The ID of a NAT gateway.", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The ID of a network interface.", + "type": "string" + }, + "RouteTableId": { + "description": "The ID of the route table for the route.", + "type": "string" + }, + "TransitGatewayId": { + "description": "The ID of a transit gateway.", + "type": "string" + }, + "VpcEndpointId": { + "description": "The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.", + "type": "string" + }, + "VpcPeeringConnectionId": { + "description": "The ID of a VPC peering connection.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CidrBlock" + ], + "required": [ + "RouteTableId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::Route" +} diff --git a/schema/aws-ec2-routetable.json b/schema/aws-ec2-routetable.json index 7a3a01f..49adb65 100644 --- a/schema/aws-ec2-routetable.json +++ b/schema/aws-ec2-routetable.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.\n For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateRouteTable", - "ec2:CreateTags", - "ec2:DescribeRouteTables" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeRouteTables", - "ec2:DeleteRouteTable" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeRouteTables" - ] - } - }, - "primaryIdentifier": [ - "/properties/RouteTableId" - ], - "properties": { - "RouteTableId": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "Any tags assigned to the route table.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RouteTableId" - ], - "required": [ - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::RouteTable" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.\n For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateRouteTable", + "ec2:CreateTags", + "ec2:DescribeRouteTables" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeRouteTables", + "ec2:DeleteRouteTable" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeRouteTables" + ] + } + }, + "primaryIdentifier": [ + "/properties/RouteTableId" + ], + "properties": { + "RouteTableId": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "Any tags assigned to the route table.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RouteTableId" + ], + "required": [ + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::RouteTable" +} diff --git a/schema/aws-ec2-securitygroup.json b/schema/aws-ec2-securitygroup.json index 727a4e6..64c9593 100644 --- a/schema/aws-ec2-securitygroup.json +++ b/schema/aws-ec2-securitygroup.json @@ -1,220 +1,225 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GroupDescription", - "/properties/GroupName", - "/properties/VpcId" - ], - "definitions": { - "Egress": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DestinationPrefixListId": { - "type": "string" - }, - "DestinationSecurityGroupId": { - "type": "string" - }, - "FromPort": { - "type": "integer" - }, - "IpProtocol": { - "type": "string" - }, - "ToPort": { - "type": "integer" - } - }, - "required": [ - "IpProtocol" - ], - "type": "object" - }, - "Ingress": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FromPort": { - "type": "integer" - }, - "IpProtocol": { - "type": "string" - }, - "SourcePrefixListId": { - "type": "string" - }, - "SourceSecurityGroupId": { - "type": "string" - }, - "SourceSecurityGroupName": { - "type": "string" - }, - "SourceSecurityGroupOwnerId": { - "type": "string" - }, - "ToPort": { - "type": "integer" - } - }, - "required": [ - "IpProtocol" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/SecurityGroupEgress/*/SourceSecurityGroupId" - ], - "description": "Resource Type definition for AWS::EC2::SecurityGroup", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateSecurityGroup", - "ec2:DescribeSecurityGroups", - "ec2:RevokeSecurityGroupEgress", - "ec2:AuthorizeSecurityGroupEgress", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteSecurityGroup", - "ec2:DescribeInstances" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSecurityGroups" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSecurityGroups" - ] - }, - "update": { - "permissions": [ - "ec2:RevokeSecurityGroupEgress", - "ec2:RevokeSecurityGroupIngress", - "ec2:DescribeSecurityGroups", - "ec2:AuthorizeSecurityGroupEgress", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "GroupDescription": { - "description": "A description for the security group.", - "type": "string" - }, - "GroupId": { - "description": "The group ID of the specified security group.", - "type": "string" - }, - "GroupName": { - "description": "The name of the security group.", - "type": "string" - }, - "Id": { - "description": "The group name or group ID depending on whether the SG is created in default or specific VPC", - "type": "string" - }, - "SecurityGroupEgress": { - "description": "[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Egress" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroupIngress": { - "description": "The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ingress" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "Any tags assigned to the security group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC for the security group.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/SecurityGroupEgress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", - "/properties/SecurityGroupEgress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", - "/properties/SecurityGroupEgress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)", - "/properties/SecurityGroupIngress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", - "/properties/SecurityGroupIngress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", - "/properties/SecurityGroupIngress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/GroupId" - ], - "required": [ - "GroupDescription" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::SecurityGroup", - "writeOnlyProperties": [ - "/properties/SecurityGroupIngress/*/SourceSecurityGroupName" - ] -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupDescription", + "/properties/GroupName", + "/properties/VpcId" + ], + "definitions": { + "Egress": { + "additionalProperties": false, + "properties": { + "CidrIp": { + "type": "string" + }, + "CidrIpv6": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DestinationPrefixListId": { + "type": "string" + }, + "DestinationSecurityGroupId": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "IpProtocol": { + "type": "string" + }, + "ToPort": { + "type": "integer" + } + }, + "required": [ + "IpProtocol" + ], + "type": "object" + }, + "Ingress": { + "additionalProperties": false, + "properties": { + "CidrIp": { + "type": "string" + }, + "CidrIpv6": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "IpProtocol": { + "type": "string" + }, + "SourcePrefixListId": { + "type": "string" + }, + "SourceSecurityGroupId": { + "type": "string" + }, + "SourceSecurityGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "type": "string" + }, + "ToPort": { + "type": "integer" + } + }, + "required": [ + "IpProtocol" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/SecurityGroupEgress/*/SourceSecurityGroupId" + ], + "description": "Resource Type definition for AWS::EC2::SecurityGroup", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateSecurityGroup", + "ec2:DescribeSecurityGroups", + "ec2:RevokeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "ec2:DeleteSecurityGroup", + "ec2:DescribeInstances" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSecurityGroups" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSecurityGroups" + ] + }, + "update": { + "permissions": [ + "ec2:RevokeSecurityGroupEgress", + "ec2:RevokeSecurityGroupIngress", + "ec2:DescribeSecurityGroups", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "GroupDescription": { + "description": "A description for the security group.", + "type": "string" + }, + "GroupId": { + "description": "The group ID of the specified security group.", + "type": "string" + }, + "GroupName": { + "description": "The name of the security group.", + "type": "string" + }, + "Id": { + "description": "The group name or group ID depending on whether the SG is created in default or specific VPC", + "type": "string" + }, + "SecurityGroupEgress": { + "description": "[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Egress" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroupIngress": { + "description": "The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Ingress" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "Any tags assigned to the security group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC for the security group.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/SecurityGroupEgress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/SecurityGroupEgress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/SecurityGroupEgress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)", + "/properties/SecurityGroupIngress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/SecurityGroupIngress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/SecurityGroupIngress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/GroupId" + ], + "required": [ + "GroupDescription" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::SecurityGroup", + "writeOnlyProperties": [ + "/properties/SecurityGroupIngress/*/SourceSecurityGroupName" + ] +} diff --git a/schema/aws-ec2-securitygroupegress.json b/schema/aws-ec2-securitygroupegress.json index 4a164bd..4d90ed3 100644 --- a/schema/aws-ec2-securitygroupegress.json +++ b/schema/aws-ec2-securitygroupegress.json @@ -1,109 +1,109 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpProtocol", - "/properties/DestinationSecurityGroupId", - "/properties/ToPort", - "/properties/CidrIp", - "/properties/FromPort", - "/properties/GroupId", - "/properties/CidrIpv6", - "/properties/DestinationPrefixListId" - ], - "description": "Adds the specified outbound (egress) rule to a security group.\n An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\n You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.\n You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.\n Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.", - "handlers": { - "create": { - "permissions": [ - "ec2:AuthorizeSecurityGroupEgress", - "ec2:RevokeSecurityGroupEgress", - "ec2:DescribeSecurityGroupRules" - ] - }, - "delete": { - "permissions": [ - "ec2:RevokeSecurityGroupEgress", - "ec2:DescribeSecurityGroupRules" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSecurityGroupRules" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSecurityGroupRules" - ] - }, - "update": { - "permissions": [ - "ec2:UpdateSecurityGroupRuleDescriptionsEgress" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CidrIp": { - "description": "The IPv4 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.", - "type": "string" - }, - "CidrIpv6": { - "description": "The IPv6 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.", - "type": "string" - }, - "Description": { - "description": "The description of an egress (outbound) security group rule.\n Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*", - "type": "string" - }, - "DestinationPrefixListId": { - "description": "The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", - "type": "string" - }, - "DestinationSecurityGroupId": { - "description": "The ID of the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", - "type": "string" - }, - "FromPort": { - "description": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).", - "type": "integer" - }, - "GroupId": { - "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "IpProtocol": { - "description": "The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\n Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", - "type": "string" - }, - "ToPort": { - "description": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).", - "type": "integer" - } - }, - "propertyTransform": { - "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", - "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", - "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "IpProtocol", - "GroupId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::SecurityGroupEgress" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpProtocol", + "/properties/DestinationSecurityGroupId", + "/properties/ToPort", + "/properties/CidrIp", + "/properties/FromPort", + "/properties/GroupId", + "/properties/CidrIpv6", + "/properties/DestinationPrefixListId" + ], + "description": "Adds the specified outbound (egress) rule to a security group.\n An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).\n You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.\n You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.\n Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.", + "handlers": { + "create": { + "permissions": [ + "ec2:AuthorizeSecurityGroupEgress", + "ec2:RevokeSecurityGroupEgress", + "ec2:DescribeSecurityGroupRules" + ] + }, + "delete": { + "permissions": [ + "ec2:RevokeSecurityGroupEgress", + "ec2:DescribeSecurityGroupRules" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSecurityGroupRules" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSecurityGroupRules" + ] + }, + "update": { + "permissions": [ + "ec2:UpdateSecurityGroupRuleDescriptionsEgress" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CidrIp": { + "description": "The IPv4 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.", + "type": "string" + }, + "CidrIpv6": { + "description": "The IPv6 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.", + "type": "string" + }, + "Description": { + "description": "The description of an egress (outbound) security group rule.\n Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*", + "type": "string" + }, + "DestinationPrefixListId": { + "description": "The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", + "type": "string" + }, + "DestinationSecurityGroupId": { + "description": "The ID of the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", + "type": "string" + }, + "FromPort": { + "description": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).", + "type": "integer" + }, + "GroupId": { + "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "IpProtocol": { + "description": "The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\n Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", + "type": "string" + }, + "ToPort": { + "description": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).", + "type": "integer" + } + }, + "propertyTransform": { + "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IpProtocol", + "GroupId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SecurityGroupEgress" +} diff --git a/schema/aws-ec2-securitygroupingress.json b/schema/aws-ec2-securitygroupingress.json index 685592b..d6c56a8 100644 --- a/schema/aws-ec2-securitygroupingress.json +++ b/schema/aws-ec2-securitygroupingress.json @@ -1,123 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GroupName", - "/properties/IpProtocol", - "/properties/SourceSecurityGroupId", - "/properties/SourcePrefixListId", - "/properties/ToPort", - "/properties/CidrIp", - "/properties/SourceSecurityGroupName", - "/properties/SourceSecurityGroupOwnerId", - "/properties/FromPort", - "/properties/GroupId", - "/properties/CidrIpv6" - ], - "description": "Resource Type definition for AWS::EC2::SecurityGroupIngress", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeSecurityGroupRules", - "ec2:AuthorizeSecurityGroupIngress" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeSecurityGroupRules", - "ec2:RevokeSecurityGroupIngress" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSecurityGroupRules" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSecurityGroups", - "ec2:DescribeSecurityGroupRules" - ] - }, - "update": { - "permissions": [ - "ec2:UpdateSecurityGroupRuleDescriptionsIngress" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CidrIp": { - "description": "The IPv4 ranges", - "type": "string" - }, - "CidrIpv6": { - "description": "[VPC only] The IPv6 ranges", - "type": "string" - }, - "Description": { - "description": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously", - "type": "string" - }, - "FromPort": { - "description": "The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", - "type": "integer" - }, - "GroupId": { - "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", - "type": "string" - }, - "GroupName": { - "description": "The name of the security group.", - "type": "string" - }, - "Id": { - "description": "The Security Group Rule Id", - "type": "string" - }, - "IpProtocol": { - "description": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).\n\n[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", - "type": "string" - }, - "SourcePrefixListId": { - "description": "[EC2-VPC only] The ID of a prefix list.\n\n", - "type": "string" - }, - "SourceSecurityGroupId": { - "description": "The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.", - "type": "string" - }, - "SourceSecurityGroupName": { - "description": "[EC2-Classic, default VPC] The name of the source security group.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", - "type": "string" - }, - "SourceSecurityGroupOwnerId": { - "description": "[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.\n\nIf you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.", - "type": "string" - }, - "ToPort": { - "description": "The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", - "type": "integer" - } - }, - "propertyTransform": { - "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", - "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", - "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "IpProtocol" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::SecurityGroupIngress" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupName", + "/properties/IpProtocol", + "/properties/SourceSecurityGroupId", + "/properties/SourcePrefixListId", + "/properties/ToPort", + "/properties/CidrIp", + "/properties/SourceSecurityGroupName", + "/properties/SourceSecurityGroupOwnerId", + "/properties/FromPort", + "/properties/GroupId", + "/properties/CidrIpv6" + ], + "description": "Resource Type definition for AWS::EC2::SecurityGroupIngress", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeSecurityGroupRules", + "ec2:AuthorizeSecurityGroupIngress" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeSecurityGroupRules", + "ec2:RevokeSecurityGroupIngress" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSecurityGroupRules" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "ec2:DescribeSecurityGroupRules" + ] + }, + "update": { + "permissions": [ + "ec2:UpdateSecurityGroupRuleDescriptionsIngress" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CidrIp": { + "description": "The IPv4 ranges", + "type": "string" + }, + "CidrIpv6": { + "description": "[VPC only] The IPv6 ranges", + "type": "string" + }, + "Description": { + "description": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously", + "type": "string" + }, + "FromPort": { + "description": "The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", + "type": "integer" + }, + "GroupId": { + "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", + "type": "string" + }, + "GroupName": { + "description": "The name of the security group.", + "type": "string" + }, + "Id": { + "description": "The Security Group Rule Id", + "type": "string" + }, + "IpProtocol": { + "description": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).\n\n[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", + "type": "string" + }, + "SourcePrefixListId": { + "description": "[EC2-VPC only] The ID of a prefix list.\n\n", + "type": "string" + }, + "SourceSecurityGroupId": { + "description": "The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.", + "type": "string" + }, + "SourceSecurityGroupName": { + "description": "[EC2-Classic, default VPC] The name of the source security group.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "description": "[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.\n\nIf you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.", + "type": "string" + }, + "ToPort": { + "description": "The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", + "type": "integer" + } + }, + "propertyTransform": { + "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IpProtocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SecurityGroupIngress" +} diff --git a/schema/aws-ec2-snapshotblockpublicaccess.json b/schema/aws-ec2-snapshotblockpublicaccess.json index f45e595..8ad625c 100644 --- a/schema/aws-ec2-snapshotblockpublicaccess.json +++ b/schema/aws-ec2-snapshotblockpublicaccess.json @@ -1,62 +1,62 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::EC2::SnapshotBlockPublicAccess", - "handlers": { - "create": { - "permissions": [ - "ec2:EnableSnapshotBlockPublicAccess", - "ec2:GetSnapshotBlockPublicAccessState" - ] - }, - "delete": { - "permissions": [ - "ec2:DisableSnapshotBlockPublicAccess", - "ec2:GetSnapshotBlockPublicAccessState" - ] - }, - "list": { - "permissions": [ - "ec2:GetSnapshotBlockPublicAccessState" - ] - }, - "read": { - "permissions": [ - "ec2:GetSnapshotBlockPublicAccessState" - ] - }, - "update": { - "permissions": [ - "ec2:EnableSnapshotBlockPublicAccess", - "ec2:GetSnapshotBlockPublicAccessState" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "description": "The identifier for the specified AWS account.", - "type": "string" - }, - "State": { - "description": "The state of EBS Snapshot Block Public Access.", - "enum": [ - "block-all-sharing", - "block-new-sharing" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "required": [ - "State" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::SnapshotBlockPublicAccess" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::EC2::SnapshotBlockPublicAccess", + "handlers": { + "create": { + "permissions": [ + "ec2:EnableSnapshotBlockPublicAccess", + "ec2:GetSnapshotBlockPublicAccessState" + ] + }, + "delete": { + "permissions": [ + "ec2:DisableSnapshotBlockPublicAccess", + "ec2:GetSnapshotBlockPublicAccessState" + ] + }, + "list": { + "permissions": [ + "ec2:GetSnapshotBlockPublicAccessState" + ] + }, + "read": { + "permissions": [ + "ec2:GetSnapshotBlockPublicAccessState" + ] + }, + "update": { + "permissions": [ + "ec2:EnableSnapshotBlockPublicAccess", + "ec2:GetSnapshotBlockPublicAccessState" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "description": "The identifier for the specified AWS account.", + "type": "string" + }, + "State": { + "description": "The state of EBS Snapshot Block Public Access.", + "enum": [ + "block-all-sharing", + "block-new-sharing" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "required": [ + "State" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::SnapshotBlockPublicAccess" +} diff --git a/schema/aws-ec2-spotfleet.json b/schema/aws-ec2-spotfleet.json index 00d88ff..607496f 100644 --- a/schema/aws-ec2-spotfleet.json +++ b/schema/aws-ec2-spotfleet.json @@ -1,979 +1,979 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SpotFleetRequestConfigData/AllocationStrategy", - "/properties/SpotFleetRequestConfigData/IamFleetRole", - "/properties/SpotFleetRequestConfigData/InstanceInterruptionBehavior", - "/properties/SpotFleetRequestConfigData/InstancePoolsToUseCount", - "/properties/SpotFleetRequestConfigData/LaunchSpecifications", - "/properties/SpotFleetRequestConfigData/LaunchTemplateConfigs", - "/properties/SpotFleetRequestConfigData/LoadBalancersConfig", - "/properties/SpotFleetRequestConfigData/OnDemandAllocationStrategy", - "/properties/SpotFleetRequestConfigData/OnDemandMaxTotalPrice", - "/properties/SpotFleetRequestConfigData/OnDemandTargetCapacity", - "/properties/SpotFleetRequestConfigData/ReplaceUnhealthyInstances", - "/properties/SpotFleetRequestConfigData/SpotMaintenanceStrategies", - "/properties/SpotFleetRequestConfigData/SpotMaxTotalPrice", - "/properties/SpotFleetRequestConfigData/SpotPrice", - "/properties/SpotFleetRequestConfigData/TagSpecifications", - "/properties/SpotFleetRequestConfigData/TerminateInstancesWithExpiration", - "/properties/SpotFleetRequestConfigData/Type", - "/properties/SpotFleetRequestConfigData/ValidFrom", - "/properties/SpotFleetRequestConfigData/ValidUntil" - ], - "definitions": { - "AcceleratorCountRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "AcceleratorTotalMemoryMiBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "BaselineEbsBandwidthMbpsRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/EbsBlockDevice" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "ClassicLoadBalancer": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "ClassicLoadBalancersConfig": { - "additionalProperties": false, - "properties": { - "ClassicLoadBalancers": { - "items": { - "$ref": "#/definitions/ClassicLoadBalancer" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ClassicLoadBalancers" - ], - "type": "object" - }, - "EbsBlockDevice": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "integer" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "integer" - }, - "VolumeType": { - "enum": [ - "gp2", - "gp3", - "io1", - "io2", - "sc1", - "st1", - "standard" - ], - "type": "string" - } - }, - "type": "object" - }, - "FleetLaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "maxLength": 128, - "minLength": 3, - "pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+", - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "GroupIdentifier": { - "additionalProperties": false, - "properties": { - "GroupId": { - "type": "string" - } - }, - "required": [ - "GroupId" - ], - "type": "object" - }, - "IamInstanceProfileSpecification": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "InstanceNetworkInterfaceSpecification": { - "additionalProperties": false, - "properties": { - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "DeleteOnTermination": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DeviceIndex": { - "type": "integer" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Ipv6AddressCount": { - "type": "integer" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/InstanceIpv6Address" - }, - "type": "array", - "uniqueItems": true - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddresses": { - "items": { - "$ref": "#/definitions/PrivateIpAddressSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "SecondaryPrivateIpAddressCount": { - "type": "integer" - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - }, - "InstanceRequirementsRequest": { - "additionalProperties": false, - "properties": { - "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCountRequest" - }, - "AcceleratorManufacturers": { - "items": { - "enum": [ - "amazon-web-services", - "amd", - "habana", - "nvidia", - "xilinx" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorNames": { - "items": { - "enum": [ - "a10g", - "a100", - "h100", - "inferentia", - "k520", - "k80", - "m60", - "radeon-pro-v520", - "t4", - "t4g", - "vu9p", - "v100" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest" - }, - "AcceleratorTypes": { - "items": { - "enum": [ - "gpu", - "fpga", - "inference" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowedInstanceTypes": { - "items": { - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\.\\*]+", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BareMetal": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest" - }, - "BurstablePerformance": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "CpuManufacturers": { - "items": { - "enum": [ - "intel", - "amd", - "amazon-web-services" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ExcludedInstanceTypes": { - "items": { - "maxLength": 30, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\.\\*]+", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "InstanceGenerations": { - "items": { - "enum": [ - "current", - "previous" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LocalStorage": { - "enum": [ - "included", - "required", - "excluded" - ], - "type": "string" - }, - "LocalStorageTypes": { - "items": { - "enum": [ - "hdd", - "ssd" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { - "type": "integer" - }, - "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpuRequest" - }, - "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRequest" - }, - "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbpsRequest" - }, - "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCountRequest" - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "type": "integer" - }, - "RequireHibernateSupport": { - "type": "boolean" - }, - "SpotMaxPricePercentageOverLowestPrice": { - "type": "integer" - }, - "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGBRequest" - }, - "VCpuCount": { - "$ref": "#/definitions/VCpuCountRangeRequest" - } - }, - "type": "object" - }, - "LaunchTemplateConfig": { - "additionalProperties": false, - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/FleetLaunchTemplateSpecification" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/LaunchTemplateOverrides" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "LaunchTemplateOverrides": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirementsRequest" - }, - "InstanceType": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "SpotPrice": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "LoadBalancersConfig": { - "additionalProperties": false, - "properties": { - "ClassicLoadBalancersConfig": { - "$ref": "#/definitions/ClassicLoadBalancersConfig" - }, - "TargetGroupsConfig": { - "$ref": "#/definitions/TargetGroupsConfig" - } - }, - "type": "object" - }, - "MemoryGiBPerVCpuRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "MemoryMiBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "NetworkBandwidthGbpsRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "NetworkInterfaceCountRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - }, - "PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "required": [ - "PrivateIpAddress" - ], - "type": "object" - }, - "SpotCapacityRebalance": { - "additionalProperties": false, - "properties": { - "ReplacementStrategy": { - "enum": [ - "launch", - "launch-before-terminate" - ], - "type": "string" - }, - "TerminationDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "SpotFleetLaunchSpecification": { - "additionalProperties": false, - "properties": { - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/BlockDeviceMapping" - }, - "type": "array", - "uniqueItems": true - }, - "EbsOptimized": { - "default": false, - "type": "boolean" - }, - "IamInstanceProfile": { - "$ref": "#/definitions/IamInstanceProfileSpecification" - }, - "ImageId": { - "type": "string" - }, - "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirementsRequest" - }, - "InstanceType": { - "type": "string" - }, - "KernelId": { - "type": "string" - }, - "KeyName": { - "type": "string" - }, - "Monitoring": { - "$ref": "#/definitions/SpotFleetMonitoring" - }, - "NetworkInterfaces": { - "items": { - "$ref": "#/definitions/InstanceNetworkInterfaceSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "Placement": { - "$ref": "#/definitions/SpotPlacement" - }, - "RamdiskId": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "$ref": "#/definitions/GroupIdentifier" - }, - "type": "array", - "uniqueItems": true - }, - "SpotPrice": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/SpotFleetTagSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "UserData": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "required": [ - "ImageId" - ], - "type": "object" - }, - "SpotFleetMonitoring": { - "additionalProperties": false, - "properties": { - "Enabled": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "SpotFleetRequestConfigData": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "enum": [ - "capacityOptimized", - "capacityOptimizedPrioritized", - "diversified", - "lowestPrice", - "priceCapacityOptimized" - ], - "type": "string" - }, - "Context": { - "type": "string" - }, - "ExcessCapacityTerminationPolicy": { - "enum": [ - "Default", - "NoTermination", - "default", - "noTermination" - ], - "type": "string" - }, - "IamFleetRole": { - "type": "string" - }, - "InstanceInterruptionBehavior": { - "enum": [ - "hibernate", - "stop", - "terminate" - ], - "type": "string" - }, - "InstancePoolsToUseCount": { - "type": "integer" - }, - "LaunchSpecifications": { - "items": { - "$ref": "#/definitions/SpotFleetLaunchSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "LaunchTemplateConfigs": { - "items": { - "$ref": "#/definitions/LaunchTemplateConfig" - }, - "type": "array", - "uniqueItems": true - }, - "LoadBalancersConfig": { - "$ref": "#/definitions/LoadBalancersConfig" - }, - "OnDemandAllocationStrategy": { - "type": "string" - }, - "OnDemandMaxTotalPrice": { - "type": "string" - }, - "OnDemandTargetCapacity": { - "type": "integer" - }, - "ReplaceUnhealthyInstances": { - "type": "boolean" - }, - "SpotMaintenanceStrategies": { - "$ref": "#/definitions/SpotMaintenanceStrategies" - }, - "SpotMaxTotalPrice": { - "type": "string" - }, - "SpotPrice": { - "type": "string" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/SpotFleetTagSpecification" - }, - "type": "array", - "uniqueItems": true - }, - "TargetCapacity": { - "type": "integer" - }, - "TargetCapacityUnitType": { - "enum": [ - "vcpu", - "memory-mib", - "units" - ], - "type": "string" - }, - "TerminateInstancesWithExpiration": { - "type": "boolean" - }, - "Type": { - "enum": [ - "maintain", - "request" - ], - "type": "string" - }, - "ValidFrom": { - "type": "string" - }, - "ValidUntil": { - "type": "string" - } - }, - "required": [ - "IamFleetRole", - "TargetCapacity" - ], - "type": "object" - }, - "SpotFleetTagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "enum": [ - "client-vpn-endpoint", - "customer-gateway", - "dedicated-host", - "dhcp-options", - "egress-only-internet-gateway", - "elastic-gpu", - "elastic-ip", - "export-image-task", - "export-instance-task", - "fleet", - "fpga-image", - "host-reservation", - "image", - "import-image-task", - "import-snapshot-task", - "instance", - "internet-gateway", - "key-pair", - "launch-template", - "local-gateway-route-table-vpc-association", - "natgateway", - "network-acl", - "network-insights-analysis", - "network-insights-path", - "network-interface", - "placement-group", - "reserved-instances", - "route-table", - "security-group", - "snapshot", - "spot-fleet-request", - "spot-instances-request", - "subnet", - "traffic-mirror-filter", - "traffic-mirror-session", - "traffic-mirror-target", - "transit-gateway", - "transit-gateway-attachment", - "transit-gateway-connect-peer", - "transit-gateway-multicast-domain", - "transit-gateway-route-table", - "volume", - "vpc", - "vpc-flow-log", - "vpc-peering-connection", - "vpn-connection", - "vpn-gateway" - ], - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SpotMaintenanceStrategies": { - "additionalProperties": false, - "properties": { - "CapacityRebalance": { - "$ref": "#/definitions/SpotCapacityRebalance" - } - }, - "type": "object" - }, - "SpotPlacement": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "Tenancy": { - "enum": [ - "dedicated", - "default", - "host" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetGroup": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "TargetGroupsConfig": { - "additionalProperties": false, - "properties": { - "TargetGroups": { - "items": { - "$ref": "#/definitions/TargetGroup" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "TargetGroups" - ], - "type": "object" - }, - "TotalLocalStorageGBRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - } - }, - "type": "object" - }, - "VCpuCountRangeRequest": { - "additionalProperties": false, - "properties": { - "Max": { - "type": "integer" - }, - "Min": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::SpotFleet", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "ec2:CreateTags", - "ec2:RequestSpotFleet", - "ec2:DescribeSpotFleetRequests", - "ec2:RunInstances" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeSpotFleetRequests", - "ec2:CancelSpotFleetRequests" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSpotFleetRequests" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSpotFleetRequests" - ] - }, - "update": { - "permissions": [ - "ec2:ModifySpotFleetRequest", - "ec2:DescribeSpotFleetRequests" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "SpotFleetRequestConfigData": { - "$ref": "#/definitions/SpotFleetRequestConfigData" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SpotFleetRequestConfigData" - ], - "typeName": "AWS::EC2::SpotFleet", - "writeOnlyProperties": [ - "/properties/SpotFleetRequestConfigData/TagSpecifications", - "/properties/SpotFleetRequestConfigData/LaunchSpecifications/*/NetworkInterfaces/*/Groups" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SpotFleetRequestConfigData/AllocationStrategy", + "/properties/SpotFleetRequestConfigData/IamFleetRole", + "/properties/SpotFleetRequestConfigData/InstanceInterruptionBehavior", + "/properties/SpotFleetRequestConfigData/InstancePoolsToUseCount", + "/properties/SpotFleetRequestConfigData/LaunchSpecifications", + "/properties/SpotFleetRequestConfigData/LaunchTemplateConfigs", + "/properties/SpotFleetRequestConfigData/LoadBalancersConfig", + "/properties/SpotFleetRequestConfigData/OnDemandAllocationStrategy", + "/properties/SpotFleetRequestConfigData/OnDemandMaxTotalPrice", + "/properties/SpotFleetRequestConfigData/OnDemandTargetCapacity", + "/properties/SpotFleetRequestConfigData/ReplaceUnhealthyInstances", + "/properties/SpotFleetRequestConfigData/SpotMaintenanceStrategies", + "/properties/SpotFleetRequestConfigData/SpotMaxTotalPrice", + "/properties/SpotFleetRequestConfigData/SpotPrice", + "/properties/SpotFleetRequestConfigData/TagSpecifications", + "/properties/SpotFleetRequestConfigData/TerminateInstancesWithExpiration", + "/properties/SpotFleetRequestConfigData/Type", + "/properties/SpotFleetRequestConfigData/ValidFrom", + "/properties/SpotFleetRequestConfigData/ValidUntil" + ], + "definitions": { + "AcceleratorCountRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "AcceleratorTotalMemoryMiBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "BaselineEbsBandwidthMbpsRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "BlockDeviceMapping": { + "additionalProperties": false, + "properties": { + "DeviceName": { + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/EbsBlockDevice" + }, + "NoDevice": { + "type": "string" + }, + "VirtualName": { + "type": "string" + } + }, + "required": [ + "DeviceName" + ], + "type": "object" + }, + "ClassicLoadBalancer": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "ClassicLoadBalancersConfig": { + "additionalProperties": false, + "properties": { + "ClassicLoadBalancers": { + "items": { + "$ref": "#/definitions/ClassicLoadBalancer" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ClassicLoadBalancers" + ], + "type": "object" + }, + "EbsBlockDevice": { + "additionalProperties": false, + "properties": { + "DeleteOnTermination": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": { + "enum": [ + "gp2", + "gp3", + "io1", + "io2", + "sc1", + "st1", + "standard" + ], + "type": "string" + } + }, + "type": "object" + }, + "FleetLaunchTemplateSpecification": { + "additionalProperties": false, + "properties": { + "LaunchTemplateId": { + "type": "string" + }, + "LaunchTemplateName": { + "maxLength": 128, + "minLength": 3, + "pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+", + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "required": [ + "Version" + ], + "type": "object" + }, + "GroupIdentifier": { + "additionalProperties": false, + "properties": { + "GroupId": { + "type": "string" + } + }, + "required": [ + "GroupId" + ], + "type": "object" + }, + "IamInstanceProfileSpecification": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + } + }, + "type": "object" + }, + "InstanceIpv6Address": { + "additionalProperties": false, + "properties": { + "Ipv6Address": { + "type": "string" + } + }, + "required": [ + "Ipv6Address" + ], + "type": "object" + }, + "InstanceNetworkInterfaceSpecification": { + "additionalProperties": false, + "properties": { + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "Description": { + "type": "string" + }, + "DeviceIndex": { + "type": "integer" + }, + "Groups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Ipv6AddressCount": { + "type": "integer" + }, + "Ipv6Addresses": { + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "type": "array", + "uniqueItems": true + }, + "NetworkInterfaceId": { + "type": "string" + }, + "PrivateIpAddresses": { + "items": { + "$ref": "#/definitions/PrivateIpAddressSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "SubnetId": { + "type": "string" + } + }, + "type": "object" + }, + "InstanceRequirementsRequest": { + "additionalProperties": false, + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRequest" + }, + "AcceleratorManufacturers": { + "items": { + "enum": [ + "amazon-web-services", + "amd", + "habana", + "nvidia", + "xilinx" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorNames": { + "items": { + "enum": [ + "a10g", + "a100", + "h100", + "inferentia", + "k520", + "k80", + "m60", + "radeon-pro-v520", + "t4", + "t4g", + "vu9p", + "v100" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest" + }, + "AcceleratorTypes": { + "items": { + "enum": [ + "gpu", + "fpga", + "inference" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowedInstanceTypes": { + "items": { + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\.\\*]+", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BareMetal": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "BaselineEbsBandwidthMbps": { + "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest" + }, + "BurstablePerformance": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "CpuManufacturers": { + "items": { + "enum": [ + "intel", + "amd", + "amazon-web-services" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ExcludedInstanceTypes": { + "items": { + "maxLength": 30, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\.\\*]+", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "InstanceGenerations": { + "items": { + "enum": [ + "current", + "previous" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LocalStorage": { + "enum": [ + "included", + "required", + "excluded" + ], + "type": "string" + }, + "LocalStorageTypes": { + "items": { + "enum": [ + "hdd", + "ssd" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": "integer" + }, + "MemoryGiBPerVCpu": { + "$ref": "#/definitions/MemoryGiBPerVCpuRequest" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRequest" + }, + "NetworkBandwidthGbps": { + "$ref": "#/definitions/NetworkBandwidthGbpsRequest" + }, + "NetworkInterfaceCount": { + "$ref": "#/definitions/NetworkInterfaceCountRequest" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": "integer" + }, + "RequireHibernateSupport": { + "type": "boolean" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": "integer" + }, + "TotalLocalStorageGB": { + "$ref": "#/definitions/TotalLocalStorageGBRequest" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRangeRequest" + } + }, + "type": "object" + }, + "LaunchTemplateConfig": { + "additionalProperties": false, + "properties": { + "LaunchTemplateSpecification": { + "$ref": "#/definitions/FleetLaunchTemplateSpecification" + }, + "Overrides": { + "items": { + "$ref": "#/definitions/LaunchTemplateOverrides" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "LaunchTemplateOverrides": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "InstanceRequirements": { + "$ref": "#/definitions/InstanceRequirementsRequest" + }, + "InstanceType": { + "type": "string" + }, + "Priority": { + "type": "number" + }, + "SpotPrice": { + "type": "string" + }, + "SubnetId": { + "type": "string" + }, + "WeightedCapacity": { + "type": "number" + } + }, + "type": "object" + }, + "LoadBalancersConfig": { + "additionalProperties": false, + "properties": { + "ClassicLoadBalancersConfig": { + "$ref": "#/definitions/ClassicLoadBalancersConfig" + }, + "TargetGroupsConfig": { + "$ref": "#/definitions/TargetGroupsConfig" + } + }, + "type": "object" + }, + "MemoryGiBPerVCpuRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "MemoryMiBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "NetworkBandwidthGbpsRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "NetworkInterfaceCountRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + }, + "PrivateIpAddressSpecification": { + "additionalProperties": false, + "properties": { + "Primary": { + "type": "boolean" + }, + "PrivateIpAddress": { + "type": "string" + } + }, + "required": [ + "PrivateIpAddress" + ], + "type": "object" + }, + "SpotCapacityRebalance": { + "additionalProperties": false, + "properties": { + "ReplacementStrategy": { + "enum": [ + "launch", + "launch-before-terminate" + ], + "type": "string" + }, + "TerminationDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "SpotFleetLaunchSpecification": { + "additionalProperties": false, + "properties": { + "BlockDeviceMappings": { + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "type": "array", + "uniqueItems": true + }, + "EbsOptimized": { + "default": false, + "type": "boolean" + }, + "IamInstanceProfile": { + "$ref": "#/definitions/IamInstanceProfileSpecification" + }, + "ImageId": { + "type": "string" + }, + "InstanceRequirements": { + "$ref": "#/definitions/InstanceRequirementsRequest" + }, + "InstanceType": { + "type": "string" + }, + "KernelId": { + "type": "string" + }, + "KeyName": { + "type": "string" + }, + "Monitoring": { + "$ref": "#/definitions/SpotFleetMonitoring" + }, + "NetworkInterfaces": { + "items": { + "$ref": "#/definitions/InstanceNetworkInterfaceSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "Placement": { + "$ref": "#/definitions/SpotPlacement" + }, + "RamdiskId": { + "type": "string" + }, + "SecurityGroups": { + "items": { + "$ref": "#/definitions/GroupIdentifier" + }, + "type": "array", + "uniqueItems": true + }, + "SpotPrice": { + "type": "string" + }, + "SubnetId": { + "type": "string" + }, + "TagSpecifications": { + "items": { + "$ref": "#/definitions/SpotFleetTagSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "UserData": { + "type": "string" + }, + "WeightedCapacity": { + "type": "number" + } + }, + "required": [ + "ImageId" + ], + "type": "object" + }, + "SpotFleetMonitoring": { + "additionalProperties": false, + "properties": { + "Enabled": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "SpotFleetRequestConfigData": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "enum": [ + "capacityOptimized", + "capacityOptimizedPrioritized", + "diversified", + "lowestPrice", + "priceCapacityOptimized" + ], + "type": "string" + }, + "Context": { + "type": "string" + }, + "ExcessCapacityTerminationPolicy": { + "enum": [ + "Default", + "NoTermination", + "default", + "noTermination" + ], + "type": "string" + }, + "IamFleetRole": { + "type": "string" + }, + "InstanceInterruptionBehavior": { + "enum": [ + "hibernate", + "stop", + "terminate" + ], + "type": "string" + }, + "InstancePoolsToUseCount": { + "type": "integer" + }, + "LaunchSpecifications": { + "items": { + "$ref": "#/definitions/SpotFleetLaunchSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "LaunchTemplateConfigs": { + "items": { + "$ref": "#/definitions/LaunchTemplateConfig" + }, + "type": "array", + "uniqueItems": true + }, + "LoadBalancersConfig": { + "$ref": "#/definitions/LoadBalancersConfig" + }, + "OnDemandAllocationStrategy": { + "type": "string" + }, + "OnDemandMaxTotalPrice": { + "type": "string" + }, + "OnDemandTargetCapacity": { + "type": "integer" + }, + "ReplaceUnhealthyInstances": { + "type": "boolean" + }, + "SpotMaintenanceStrategies": { + "$ref": "#/definitions/SpotMaintenanceStrategies" + }, + "SpotMaxTotalPrice": { + "type": "string" + }, + "SpotPrice": { + "type": "string" + }, + "TagSpecifications": { + "items": { + "$ref": "#/definitions/SpotFleetTagSpecification" + }, + "type": "array", + "uniqueItems": true + }, + "TargetCapacity": { + "type": "integer" + }, + "TargetCapacityUnitType": { + "enum": [ + "vcpu", + "memory-mib", + "units" + ], + "type": "string" + }, + "TerminateInstancesWithExpiration": { + "type": "boolean" + }, + "Type": { + "enum": [ + "maintain", + "request" + ], + "type": "string" + }, + "ValidFrom": { + "type": "string" + }, + "ValidUntil": { + "type": "string" + } + }, + "required": [ + "IamFleetRole", + "TargetCapacity" + ], + "type": "object" + }, + "SpotFleetTagSpecification": { + "additionalProperties": false, + "properties": { + "ResourceType": { + "enum": [ + "client-vpn-endpoint", + "customer-gateway", + "dedicated-host", + "dhcp-options", + "egress-only-internet-gateway", + "elastic-gpu", + "elastic-ip", + "export-image-task", + "export-instance-task", + "fleet", + "fpga-image", + "host-reservation", + "image", + "import-image-task", + "import-snapshot-task", + "instance", + "internet-gateway", + "key-pair", + "launch-template", + "local-gateway-route-table-vpc-association", + "natgateway", + "network-acl", + "network-insights-analysis", + "network-insights-path", + "network-interface", + "placement-group", + "reserved-instances", + "route-table", + "security-group", + "snapshot", + "spot-fleet-request", + "spot-instances-request", + "subnet", + "traffic-mirror-filter", + "traffic-mirror-session", + "traffic-mirror-target", + "transit-gateway", + "transit-gateway-attachment", + "transit-gateway-connect-peer", + "transit-gateway-multicast-domain", + "transit-gateway-route-table", + "volume", + "vpc", + "vpc-flow-log", + "vpc-peering-connection", + "vpn-connection", + "vpn-gateway" + ], + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SpotMaintenanceStrategies": { + "additionalProperties": false, + "properties": { + "CapacityRebalance": { + "$ref": "#/definitions/SpotCapacityRebalance" + } + }, + "type": "object" + }, + "SpotPlacement": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "Tenancy": { + "enum": [ + "dedicated", + "default", + "host" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetGroup": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "TargetGroupsConfig": { + "additionalProperties": false, + "properties": { + "TargetGroups": { + "items": { + "$ref": "#/definitions/TargetGroup" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "TargetGroups" + ], + "type": "object" + }, + "TotalLocalStorageGBRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + } + }, + "type": "object" + }, + "VCpuCountRangeRequest": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "integer" + }, + "Min": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::SpotFleet", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "ec2:CreateTags", + "ec2:RequestSpotFleet", + "ec2:DescribeSpotFleetRequests", + "ec2:RunInstances" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeSpotFleetRequests", + "ec2:CancelSpotFleetRequests" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSpotFleetRequests" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSpotFleetRequests" + ] + }, + "update": { + "permissions": [ + "ec2:ModifySpotFleetRequest", + "ec2:DescribeSpotFleetRequests" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "SpotFleetRequestConfigData": { + "$ref": "#/definitions/SpotFleetRequestConfigData" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SpotFleetRequestConfigData" + ], + "typeName": "AWS::EC2::SpotFleet", + "writeOnlyProperties": [ + "/properties/SpotFleetRequestConfigData/TagSpecifications", + "/properties/SpotFleetRequestConfigData/LaunchSpecifications/*/NetworkInterfaces/*/Groups" + ] +} diff --git a/schema/aws-ec2-subnet.json b/schema/aws-ec2-subnet.json index 0091443..a01b7ac 100644 --- a/schema/aws-ec2-subnet.json +++ b/schema/aws-ec2-subnet.json @@ -1,205 +1,210 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/Ipv6CidrBlock" - ], - "createOnlyProperties": [ - "/properties/VpcId", - "/properties/AvailabilityZone", - "/properties/AvailabilityZoneId", - "/properties/CidrBlock", - "/properties/OutpostArn", - "/properties/Ipv6Native", - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength", - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a subnet for the specified VPC.\n For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.\n For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeSubnets", - "ec2:CreateSubnet", - "ec2:CreateTags", - "ec2:ModifySubnetAttribute" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeSubnets", - "ec2:DeleteSubnet" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSubnets", - "ec2:DescribeNetworkAcls" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSubnets", - "ec2:DescribeNetworkAcls" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeSubnets", - "ec2:ModifySubnetAttribute", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:AssociateSubnetCidrBlock", - "ec2:DisassociateSubnetCidrBlock" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubnetId" - ], - "properties": { - "AssignIpv6AddressOnCreation": { - "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", - "type": "boolean" - }, - "AvailabilityZone": { - "description": "The Availability Zone of the subnet.\n If you update this property, you must also update the ``CidrBlock`` property.", - "type": "string" - }, - "AvailabilityZoneId": { - "description": "The AZ ID of the subnet.", - "type": "string" - }, - "CidrBlock": { - "description": "The IPv4 CIDR block assigned to the subnet.\n If you update this property, we create a new subnet, and then delete the existing one.", - "type": "string" - }, - "EnableDns64": { - "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.", - "type": "boolean" - }, - "EnableLniAtDeviceIndex": { - "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).", - "type": "integer" - }, - "Ipv4IpamPoolId": { - "description": "An IPv4 IPAM pool ID for the subnet.", - "type": "string" - }, - "Ipv4NetmaskLength": { - "description": "An IPv4 netmask length for the subnet.", - "type": "integer" - }, - "Ipv6CidrBlock": { - "description": "The IPv6 CIDR block.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", - "type": "string" - }, - "Ipv6CidrBlocks": { - "description": "The IPv6 network ranges for the subnet, in CIDR notation.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Ipv6IpamPoolId": { - "description": "An IPv6 IPAM pool ID for the subnet.", - "type": "string" - }, - "Ipv6Native": { - "description": "Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.", - "type": "boolean" - }, - "Ipv6NetmaskLength": { - "description": "An IPv6 netmask length for the subnet.", - "type": "integer" - }, - "MapPublicIpOnLaunch": { - "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", - "type": "boolean" - }, - "NetworkAclAssociationId": { - "description": "", - "type": "string" - }, - "OutpostArn": { - "description": "The Amazon Resource Name (ARN) of the Outpost.", - "type": "string" - }, - "PrivateDnsNameOptionsOnLaunch": { - "additionalProperties": false, - "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.\n Available options:\n + EnableResourceNameDnsAAAARecord (true | false)\n + EnableResourceNameDnsARecord (true | false)\n + HostnameType (ip-name | resource-name)", - "properties": { - "EnableResourceNameDnsAAAARecord": { - "type": "boolean" - }, - "EnableResourceNameDnsARecord": { - "type": "boolean" - }, - "HostnameType": { - "type": "string" - } - }, - "type": "object" - }, - "SubnetId": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "Any tags assigned to the subnet.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC the subnet is in.\n If you update this property, you must also update the ``CidrBlock`` property.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NetworkAclAssociationId", - "/properties/SubnetId" - ], - "required": [ - "VpcId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::Subnet", - "writeOnlyProperties": [ - "/properties/EnableLniAtDeviceIndex", - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength", - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/Ipv6CidrBlock" + ], + "createOnlyProperties": [ + "/properties/VpcId", + "/properties/AvailabilityZone", + "/properties/AvailabilityZoneId", + "/properties/CidrBlock", + "/properties/OutpostArn", + "/properties/Ipv6Native", + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength", + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a subnet for the specified VPC.\n For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.\n For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeSubnets", + "ec2:CreateSubnet", + "ec2:CreateTags", + "ec2:ModifySubnetAttribute" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeSubnets", + "ec2:DeleteSubnet" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSubnets", + "ec2:DescribeNetworkAcls" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSubnets", + "ec2:DescribeNetworkAcls" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeSubnets", + "ec2:ModifySubnetAttribute", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:AssociateSubnetCidrBlock", + "ec2:DisassociateSubnetCidrBlock" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubnetId" + ], + "properties": { + "AssignIpv6AddressOnCreation": { + "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", + "type": "boolean" + }, + "AvailabilityZone": { + "description": "The Availability Zone of the subnet.\n If you update this property, you must also update the ``CidrBlock`` property.", + "type": "string" + }, + "AvailabilityZoneId": { + "description": "The AZ ID of the subnet.", + "type": "string" + }, + "CidrBlock": { + "description": "The IPv4 CIDR block assigned to the subnet.\n If you update this property, we create a new subnet, and then delete the existing one.", + "type": "string" + }, + "EnableDns64": { + "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.\n You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a ``0.0.0.0/0`` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *User Guide*.", + "type": "boolean" + }, + "EnableLniAtDeviceIndex": { + "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).", + "type": "integer" + }, + "Ipv4IpamPoolId": { + "description": "An IPv4 IPAM pool ID for the subnet.", + "type": "string" + }, + "Ipv4NetmaskLength": { + "description": "An IPv4 netmask length for the subnet.", + "type": "integer" + }, + "Ipv6CidrBlock": { + "description": "The IPv6 CIDR block.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", + "type": "string" + }, + "Ipv6CidrBlocks": { + "description": "", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Ipv6IpamPoolId": { + "description": "An IPv6 IPAM pool ID for the subnet.", + "type": "string" + }, + "Ipv6Native": { + "description": "Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.", + "type": "boolean" + }, + "Ipv6NetmaskLength": { + "description": "An IPv6 netmask length for the subnet.", + "type": "integer" + }, + "MapPublicIpOnLaunch": { + "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", + "type": "boolean" + }, + "NetworkAclAssociationId": { + "description": "", + "type": "string" + }, + "OutpostArn": { + "description": "The Amazon Resource Name (ARN) of the Outpost.", + "type": "string" + }, + "PrivateDnsNameOptionsOnLaunch": { + "additionalProperties": false, + "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.\n Available options:\n + EnableResourceNameDnsAAAARecord (true | false)\n + EnableResourceNameDnsARecord (true | false)\n + HostnameType (ip-name | resource-name)", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "type": "boolean" + }, + "EnableResourceNameDnsARecord": { + "type": "boolean" + }, + "HostnameType": { + "type": "string" + } + }, + "type": "object" + }, + "SubnetId": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "Any tags assigned to the subnet.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC the subnet is in.\n If you update this property, you must also update the ``CidrBlock`` property.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NetworkAclAssociationId", + "/properties/SubnetId", + "/properties/Ipv6CidrBlocks" + ], + "required": [ + "VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::Subnet", + "writeOnlyProperties": [ + "/properties/EnableLniAtDeviceIndex", + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength", + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ] +} diff --git a/schema/aws-ec2-subnetcidrblock.json b/schema/aws-ec2-subnetcidrblock.json index 3a0342f..9f10202 100644 --- a/schema/aws-ec2-subnetcidrblock.json +++ b/schema/aws-ec2-subnetcidrblock.json @@ -1,84 +1,94 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Ipv6CidrBlock", - "/properties/SubnetId", - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ], - "description": "The AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateSubnetCidrBlock", - "ec2:DescribeSubnets" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateSubnetCidrBlock", - "ec2:DescribeSubnets" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeSubnets" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeSubnets" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "Information about the IPv6 association.", - "type": "string" - }, - "Ipv6CidrBlock": { - "description": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length", - "maxLength": 42, - "type": "string" - }, - "Ipv6IpamPoolId": { - "description": "The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR", - "type": "string" - }, - "Ipv6NetmaskLength": { - "description": "The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool", - "maximum": 128, - "minimum": 0, - "type": "integer" - }, - "SubnetId": { - "description": "The ID of the subnet", - "type": "string" - } - }, - "propertyTransform": { - "/properties/Ipv6CidrBlock": "$join([$match($replace(Ipv6CidrBlock, /(^|:)(0{1,4})([0-9a-fA-F]{1,4})/, \"$1$3\"), /^([0-9a-fA-F]{1,4}:){4}/).match, \":/64\"])" - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/subnetcidrblock", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::SubnetCidrBlock", - "writeOnlyProperties": [ - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ] -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Ipv6CidrBlock", + "/properties/SubnetId", + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ], + "description": "The AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateSubnetCidrBlock", + "ec2:DescribeSubnets" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateSubnetCidrBlock", + "ec2:DescribeSubnets" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSubnets" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSubnets" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "Information about the IPv6 association.", + "type": "string" + }, + "IpSource": { + "description": "The IP Source of an IPv6 Subnet CIDR Block.", + "type": "string" + }, + "Ipv6AddressAttribute": { + "description": "The value denoting whether an IPv6 Subnet CIDR Block is public or private.", + "type": "string" + }, + "Ipv6CidrBlock": { + "description": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length", + "maxLength": 42, + "type": "string" + }, + "Ipv6IpamPoolId": { + "description": "The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR", + "type": "string" + }, + "Ipv6NetmaskLength": { + "description": "The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "SubnetId": { + "description": "The ID of the subnet", + "type": "string" + } + }, + "propertyTransform": { + "/properties/Ipv6CidrBlock": "$join([$match($replace(Ipv6CidrBlock, /(^|:)(0{1,4})([0-9a-fA-F]{1,4})/, \"$1$3\"), /^([0-9a-fA-F]{1,4}:){4}/).match, \":/64\"])" + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Ipv6AddressAttribute", + "/properties/IpSource" + ], + "required": [ + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/subnetcidrblock", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SubnetCidrBlock", + "writeOnlyProperties": [ + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ] +} diff --git a/schema/aws-ec2-subnetnetworkaclassociation.json b/schema/aws-ec2-subnetnetworkaclassociation.json index 07e6e9d..467c6b7 100644 --- a/schema/aws-ec2-subnetnetworkaclassociation.json +++ b/schema/aws-ec2-subnetnetworkaclassociation.json @@ -1,64 +1,64 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetId", - "/properties/NetworkAclId" - ], - "description": "Resource Type definition for AWS::EC2::SubnetNetworkAclAssociation", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeNetworkAcls", - "ec2:ReplaceNetworkAclAssociation" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeNetworkAcls", - "ec2:ReplaceNetworkAclAssociation" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeNetworkAcls" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeNetworkAcls" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationId" - ], - "properties": { - "AssociationId": { - "type": "string" - }, - "NetworkAclId": { - "description": "The ID of the network ACL", - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "NetworkAclId", - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::SubnetNetworkAclAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetId", + "/properties/NetworkAclId" + ], + "description": "Resource Type definition for AWS::EC2::SubnetNetworkAclAssociation", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeNetworkAcls", + "ec2:ReplaceNetworkAclAssociation" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeNetworkAcls", + "ec2:ReplaceNetworkAclAssociation" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeNetworkAcls" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeNetworkAcls" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationId" + ], + "properties": { + "AssociationId": { + "type": "string" + }, + "NetworkAclId": { + "description": "The ID of the network ACL", + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "NetworkAclId", + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SubnetNetworkAclAssociation" +} diff --git a/schema/aws-ec2-subnetroutetableassociation.json b/schema/aws-ec2-subnetroutetableassociation.json index 0061f56..aa874c3 100644 --- a/schema/aws-ec2-subnetroutetableassociation.json +++ b/schema/aws-ec2-subnetroutetableassociation.json @@ -1,68 +1,68 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetId", - "/properties/RouteTableId" - ], - "description": "Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateRouteTable", - "ec2:ReplaceRouteTableAssociation", - "ec2:DescribeSubnets", - "ec2:DescribeRouteTables" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateRouteTable", - "ec2:DescribeSubnets", - "ec2:DescribeRouteTables" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeRouteTables" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "RouteTableId": { - "description": "The ID of the route table.\n The physical ID changes when the route table ID is changed.", - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "RouteTableId", - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::SubnetRouteTableAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetId", + "/properties/RouteTableId" + ], + "description": "Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateRouteTable", + "ec2:ReplaceRouteTableAssociation", + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateRouteTable", + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeRouteTables" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "RouteTableId": { + "description": "The ID of the route table.\n The physical ID changes when the route table ID is changed.", + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "RouteTableId", + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SubnetRouteTableAssociation" +} diff --git a/schema/aws-ec2-trafficmirrorfilter.json b/schema/aws-ec2-trafficmirrorfilter.json index 4263929..287bcc6 100644 --- a/schema/aws-ec2-trafficmirrorfilter.json +++ b/schema/aws-ec2-trafficmirrorfilter.json @@ -1,54 +1,54 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TrafficMirrorFilter", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NetworkServices": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::EC2::TrafficMirrorFilter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TrafficMirrorFilter", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NetworkServices": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::EC2::TrafficMirrorFilter" +} diff --git a/schema/aws-ec2-trafficmirrorfilterrule.json b/schema/aws-ec2-trafficmirrorfilterrule.json index 850e64d..5cd1b28 100644 --- a/schema/aws-ec2-trafficmirrorfilterrule.json +++ b/schema/aws-ec2-trafficmirrorfilterrule.json @@ -1,98 +1,98 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TrafficMirrorFilterId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TrafficMirrorPortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "integer" - }, - "ToPort": { - "type": "integer" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TrafficMirrorFilterRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "DestinationPortRange": { - "$ref": "#/definitions/TrafficMirrorPortRange" - }, - "Id": { - "type": "string" - }, - "Protocol": { - "type": "integer" - }, - "RuleAction": { - "type": "string" - }, - "RuleNumber": { - "type": "integer" - }, - "SourceCidrBlock": { - "type": "string" - }, - "SourcePortRange": { - "$ref": "#/definitions/TrafficMirrorPortRange" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TrafficDirection": { - "type": "string" - }, - "TrafficMirrorFilterId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RuleAction", - "SourceCidrBlock", - "RuleNumber", - "DestinationCidrBlock", - "TrafficMirrorFilterId", - "TrafficDirection" - ], - "typeName": "AWS::EC2::TrafficMirrorFilterRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TrafficMirrorFilterId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TrafficMirrorPortRange": { + "additionalProperties": false, + "properties": { + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TrafficMirrorFilterRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + }, + "DestinationPortRange": { + "$ref": "#/definitions/TrafficMirrorPortRange" + }, + "Id": { + "type": "string" + }, + "Protocol": { + "type": "integer" + }, + "RuleAction": { + "type": "string" + }, + "RuleNumber": { + "type": "integer" + }, + "SourceCidrBlock": { + "type": "string" + }, + "SourcePortRange": { + "$ref": "#/definitions/TrafficMirrorPortRange" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TrafficDirection": { + "type": "string" + }, + "TrafficMirrorFilterId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RuleAction", + "SourceCidrBlock", + "RuleNumber", + "DestinationCidrBlock", + "TrafficMirrorFilterId", + "TrafficDirection" + ], + "typeName": "AWS::EC2::TrafficMirrorFilterRule" +} diff --git a/schema/aws-ec2-trafficmirrorsession.json b/schema/aws-ec2-trafficmirrorsession.json index 8489c11..7481d03 100644 --- a/schema/aws-ec2-trafficmirrorsession.json +++ b/schema/aws-ec2-trafficmirrorsession.json @@ -1,71 +1,71 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NetworkInterfaceId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TrafficMirrorSession", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PacketLength": { - "type": "integer" - }, - "SessionNumber": { - "type": "integer" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TrafficMirrorFilterId": { - "type": "string" - }, - "TrafficMirrorTargetId": { - "type": "string" - }, - "VirtualNetworkId": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TrafficMirrorTargetId", - "NetworkInterfaceId", - "TrafficMirrorFilterId", - "SessionNumber" - ], - "typeName": "AWS::EC2::TrafficMirrorSession" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NetworkInterfaceId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TrafficMirrorSession", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "PacketLength": { + "type": "integer" + }, + "SessionNumber": { + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TrafficMirrorFilterId": { + "type": "string" + }, + "TrafficMirrorTargetId": { + "type": "string" + }, + "VirtualNetworkId": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TrafficMirrorTargetId", + "NetworkInterfaceId", + "TrafficMirrorFilterId", + "SessionNumber" + ], + "typeName": "AWS::EC2::TrafficMirrorSession" +} diff --git a/schema/aws-ec2-trafficmirrortarget.json b/schema/aws-ec2-trafficmirrortarget.json index 09e5523..bec88f9 100644 --- a/schema/aws-ec2-trafficmirrortarget.json +++ b/schema/aws-ec2-trafficmirrortarget.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GatewayLoadBalancerEndpointId", - "/properties/NetworkLoadBalancerArn", - "/properties/NetworkInterfaceId", - "/properties/Description" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TrafficMirrorTarget", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "GatewayLoadBalancerEndpointId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "NetworkLoadBalancerArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::EC2::TrafficMirrorTarget" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GatewayLoadBalancerEndpointId", + "/properties/NetworkLoadBalancerArn", + "/properties/NetworkInterfaceId", + "/properties/Description" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TrafficMirrorTarget", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "GatewayLoadBalancerEndpointId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "NetworkLoadBalancerArn": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::EC2::TrafficMirrorTarget" +} diff --git a/schema/aws-ec2-transitgateway.json b/schema/aws-ec2-transitgateway.json index 42d5408..0624d3f 100644 --- a/schema/aws-ec2-transitgateway.json +++ b/schema/aws-ec2-transitgateway.json @@ -1,152 +1,156 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AmazonSideAsn", - "/properties/MulticastSupport" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TransitGateway", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTransitGateway", - "ec2:CreateTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTags", - "ec2:DeleteTransitGateway", - "ec2:DeleteTags", - "ec2:ModifyTransitGateway", - "ec2:ModifyTransitGatewayOptions" - ] - }, - "delete": { - "permissions": [ - "ec2:CreateTransitGateway", - "ec2:CreateTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTags", - "ec2:DeleteTransitGateway", - "ec2:DeleteTags", - "ec2:ModifyTransitGateway", - "ec2:ModifyTransitGatewayOptions" - ] - }, - "list": { - "permissions": [ - "ec2:CreateTransitGateway", - "ec2:CreateTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTags", - "ec2:DeleteTransitGateway", - "ec2:DeleteTags", - "ec2:ModifyTransitGateway", - "ec2:ModifyTransitGatewayOptions" - ] - }, - "read": { - "permissions": [ - "ec2:CreateTransitGateway", - "ec2:CreateTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTags", - "ec2:DeleteTransitGateway", - "ec2:DeleteTags", - "ec2:ModifyTransitGateway", - "ec2:ModifyTransitGatewayOptions" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTransitGateway", - "ec2:CreateTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTags", - "ec2:DeleteTransitGateway", - "ec2:DeleteTags", - "ec2:ModifyTransitGateway", - "ec2:ModifyTransitGatewayOptions" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AmazonSideAsn": { - "format": "int64", - "type": "integer" - }, - "AssociationDefaultRouteTableId": { - "type": "string" - }, - "AutoAcceptSharedAttachments": { - "type": "string" - }, - "DefaultRouteTableAssociation": { - "type": "string" - }, - "DefaultRouteTablePropagation": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DnsSupport": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MulticastSupport": { - "type": "string" - }, - "PropagationDefaultRouteTableId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitGatewayArn": { - "type": "string" - }, - "TransitGatewayCidrBlocks": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpnEcmpSupport": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/TransitGatewayArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", - "tagging": { - "taggable": true - }, - "typeName": "AWS::EC2::TransitGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AmazonSideAsn", + "/properties/MulticastSupport" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TransitGateway", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTransitGateway", + "ec2:CreateTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTags", + "ec2:DeleteTransitGateway", + "ec2:DeleteTags", + "ec2:ModifyTransitGateway", + "ec2:ModifyTransitGatewayOptions" + ] + }, + "delete": { + "permissions": [ + "ec2:CreateTransitGateway", + "ec2:CreateTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTags", + "ec2:DeleteTransitGateway", + "ec2:DeleteTags", + "ec2:ModifyTransitGateway", + "ec2:ModifyTransitGatewayOptions" + ] + }, + "list": { + "permissions": [ + "ec2:CreateTransitGateway", + "ec2:CreateTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTags", + "ec2:DeleteTransitGateway", + "ec2:DeleteTags", + "ec2:ModifyTransitGateway", + "ec2:ModifyTransitGatewayOptions" + ] + }, + "read": { + "permissions": [ + "ec2:CreateTransitGateway", + "ec2:CreateTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTags", + "ec2:DeleteTransitGateway", + "ec2:DeleteTags", + "ec2:ModifyTransitGateway", + "ec2:ModifyTransitGatewayOptions" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTransitGateway", + "ec2:CreateTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTags", + "ec2:DeleteTransitGateway", + "ec2:DeleteTags", + "ec2:ModifyTransitGateway", + "ec2:ModifyTransitGatewayOptions" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AmazonSideAsn": { + "format": "int64", + "type": "integer" + }, + "AssociationDefaultRouteTableId": { + "type": "string" + }, + "AutoAcceptSharedAttachments": { + "type": "string" + }, + "DefaultRouteTableAssociation": { + "type": "string" + }, + "DefaultRouteTablePropagation": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DnsSupport": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MulticastSupport": { + "type": "string" + }, + "PropagationDefaultRouteTableId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitGatewayArn": { + "type": "string" + }, + "TransitGatewayCidrBlocks": { + "items": { + "type": "string" + }, + "type": "array" + }, + "VpnEcmpSupport": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/TransitGatewayArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGateway" +} diff --git a/schema/aws-ec2-transitgatewayattachment.json b/schema/aws-ec2-transitgatewayattachment.json index 742018a..67e8513 100644 --- a/schema/aws-ec2-transitgatewayattachment.json +++ b/schema/aws-ec2-transitgatewayattachment.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayId", - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TransitGatewayAttachment", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeTags", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeTags", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Options": { - "additionalProperties": false, - "description": "The options for the transit gateway vpc attachment.", - "properties": { - "ApplianceModeSupport": { - "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - }, - "DnsSupport": { - "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - }, - "Ipv6Support": { - "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - }, - "SecurityGroupReferencingSupport": { - "description": "Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - } - }, - "type": "object" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "VpcId", - "SubnetIds", - "TransitGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::TransitGatewayAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayId", + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TransitGatewayAttachment", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeTags", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeTags", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Options": { + "additionalProperties": false, + "description": "The options for the transit gateway vpc attachment.", + "properties": { + "ApplianceModeSupport": { + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + }, + "DnsSupport": { + "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + }, + "Ipv6Support": { + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + } + }, + "type": "object" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "VpcId", + "SubnetIds", + "TransitGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayAttachment" +} diff --git a/schema/aws-ec2-transitgatewayconnect.json b/schema/aws-ec2-transitgatewayconnect.json index 2743213..2402934 100644 --- a/schema/aws-ec2-transitgatewayconnect.json +++ b/schema/aws-ec2-transitgatewayconnect.json @@ -1,115 +1,122 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransportTransitGatewayAttachmentId", - "/properties/Options" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", - "type": "string" - }, - "Value": { - "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", - "type": "string" - } - }, - "type": "object" - }, - "TransitGatewayConnectOptions": { - "additionalProperties": false, - "properties": { - "Protocol": { - "description": "The tunnel protocol.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::EC2::TransitGatewayConnect type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTransitGatewayConnect", - "ec2:DescribeTransitGatewayConnects", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteTransitGatewayConnect", - "ec2:DescribeTransitGatewayConnects", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayConnects" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayConnects" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeTransitGatewayConnects", - "ec2:DeleteTags", - "ec2:CreateTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayAttachmentId" - ], - "properties": { - "CreationTime": { - "description": "The creation time.", - "type": "string" - }, - "Options": { - "$ref": "#/definitions/TransitGatewayConnectOptions", - "description": "The Connect attachment options." - }, - "State": { - "description": "The state of the attachment.", - "type": "string" - }, - "Tags": { - "description": "The tags for the attachment.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of the Connect attachment.", - "type": "string" - }, - "TransitGatewayId": { - "description": "The ID of the transit gateway.", - "type": "string" - }, - "TransportTransitGatewayAttachmentId": { - "description": "The ID of the attachment from which the Connect attachment was created.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TransitGatewayAttachmentId", - "/properties/State", - "/properties/CreationTime", - "/properties/TransitGatewayId" - ], - "required": [ - "TransportTransitGatewayAttachmentId", - "Options" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", - "typeName": "AWS::EC2::TransitGatewayConnect" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransportTransitGatewayAttachmentId", + "/properties/Options" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", + "type": "string" + }, + "Value": { + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", + "type": "string" + } + }, + "type": "object" + }, + "TransitGatewayConnectOptions": { + "additionalProperties": false, + "properties": { + "Protocol": { + "description": "The tunnel protocol.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::EC2::TransitGatewayConnect type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTransitGatewayConnect", + "ec2:DescribeTransitGatewayConnects", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteTransitGatewayConnect", + "ec2:DescribeTransitGatewayConnects", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayConnects" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayConnects" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeTransitGatewayConnects", + "ec2:DeleteTags", + "ec2:CreateTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayAttachmentId" + ], + "properties": { + "CreationTime": { + "description": "The creation time.", + "type": "string" + }, + "Options": { + "$ref": "#/definitions/TransitGatewayConnectOptions", + "description": "The Connect attachment options." + }, + "State": { + "description": "The state of the attachment.", + "type": "string" + }, + "Tags": { + "description": "The tags for the attachment.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of the Connect attachment.", + "type": "string" + }, + "TransitGatewayId": { + "description": "The ID of the transit gateway.", + "type": "string" + }, + "TransportTransitGatewayAttachmentId": { + "description": "The ID of the attachment from which the Connect attachment was created.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TransitGatewayAttachmentId", + "/properties/State", + "/properties/CreationTime", + "/properties/TransitGatewayId" + ], + "required": [ + "TransportTransitGatewayAttachmentId", + "Options" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayConnect" +} diff --git a/schema/aws-ec2-transitgatewaymulticastdomain.json b/schema/aws-ec2-transitgatewaymulticastdomain.json index 03420f0..58afbde 100644 --- a/schema/aws-ec2-transitgatewaymulticastdomain.json +++ b/schema/aws-ec2-transitgatewaymulticastdomain.json @@ -1,119 +1,126 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", - "type": "string" - }, - "Value": { - "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::EC2::TransitGatewayMulticastDomain type", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeTransitGatewayMulticastDomains", - "ec2:CreateTransitGatewayMulticastDomain", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeTransitGatewayMulticastDomains", - "ec2:DeleteTransitGatewayMulticastDomain", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayMulticastDomains" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayMulticastDomains" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeTransitGatewayMulticastDomains", - "ec2:DeleteTags", - "ec2:CreateTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayMulticastDomainId" - ], - "properties": { - "CreationTime": { - "description": "The time the transit gateway multicast domain was created.", - "format": "date-time", - "type": "string" - }, - "Options": { - "additionalProperties": false, - "description": "The options for the transit gateway multicast domain.", - "properties": { - "AutoAcceptSharedAssociations": { - "description": "Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable", - "type": "string" - }, - "Igmpv2Support": { - "description": "Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable", - "type": "string" - }, - "StaticSourcesSupport": { - "description": "Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable", - "type": "string" - } - }, - "type": "object" - }, - "State": { - "description": "The state of the transit gateway multicast domain.", - "type": "string" - }, - "Tags": { - "description": "The tags for the transit gateway multicast domain.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "description": "The ID of the transit gateway.", - "type": "string" - }, - "TransitGatewayMulticastDomainArn": { - "description": "The Amazon Resource Name (ARN) of the transit gateway multicast domain.", - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "description": "The ID of the transit gateway multicast domain.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/State", - "/properties/CreationTime", - "/properties/TransitGatewayMulticastDomainArn" - ], - "required": [ - "TransitGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway/aws-ec2-transitgatewaymulticastdomain", - "typeName": "AWS::EC2::TransitGatewayMulticastDomain" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", + "type": "string" + }, + "Value": { + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::EC2::TransitGatewayMulticastDomain type", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeTransitGatewayMulticastDomains", + "ec2:CreateTransitGatewayMulticastDomain", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeTransitGatewayMulticastDomains", + "ec2:DeleteTransitGatewayMulticastDomain", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayMulticastDomains" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayMulticastDomains" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeTransitGatewayMulticastDomains", + "ec2:DeleteTags", + "ec2:CreateTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayMulticastDomainId" + ], + "properties": { + "CreationTime": { + "description": "The time the transit gateway multicast domain was created.", + "format": "date-time", + "type": "string" + }, + "Options": { + "additionalProperties": false, + "description": "The options for the transit gateway multicast domain.", + "properties": { + "AutoAcceptSharedAssociations": { + "description": "Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable", + "type": "string" + }, + "Igmpv2Support": { + "description": "Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable", + "type": "string" + }, + "StaticSourcesSupport": { + "description": "Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable", + "type": "string" + } + }, + "type": "object" + }, + "State": { + "description": "The state of the transit gateway multicast domain.", + "type": "string" + }, + "Tags": { + "description": "The tags for the transit gateway multicast domain.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TransitGatewayId": { + "description": "The ID of the transit gateway.", + "type": "string" + }, + "TransitGatewayMulticastDomainArn": { + "description": "The Amazon Resource Name (ARN) of the transit gateway multicast domain.", + "type": "string" + }, + "TransitGatewayMulticastDomainId": { + "description": "The ID of the transit gateway multicast domain.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/State", + "/properties/CreationTime", + "/properties/TransitGatewayMulticastDomainArn" + ], + "required": [ + "TransitGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway/aws-ec2-transitgatewaymulticastdomain", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayMulticastDomain" +} diff --git a/schema/aws-ec2-transitgatewaymulticastdomainassociation.json b/schema/aws-ec2-transitgatewaymulticastdomainassociation.json index 7809b18..e05c4c8 100644 --- a/schema/aws-ec2-transitgatewaymulticastdomainassociation.json +++ b/schema/aws-ec2-transitgatewaymulticastdomainassociation.json @@ -1,76 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/TransitGatewayAttachmentId", - "/properties/SubnetId" - ], - "description": "The AWS::EC2::TransitGatewayMulticastDomainAssociation type", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateTransitGatewayMulticastDomain", - "ec2:GetTransitGatewayMulticastDomainAssociations" - ] - }, - "delete": { - "permissions": [ - "ec2:DisassociateTransitGatewayMulticastDomain", - "ec2:GetTransitGatewayMulticastDomainAssociations" - ] - }, - "list": { - "permissions": [ - "ec2:GetTransitGatewayMulticastDomainAssociations" - ] - }, - "read": { - "permissions": [ - "ec2:GetTransitGatewayMulticastDomainAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/TransitGatewayAttachmentId", - "/properties/SubnetId" - ], - "properties": { - "ResourceId": { - "description": "The ID of the resource.", - "type": "string" - }, - "ResourceType": { - "description": "The type of resource, for example a VPC attachment.", - "type": "string" - }, - "State": { - "description": "The state of the subnet association.", - "type": "string" - }, - "SubnetId": { - "description": "The IDs of the subnets to associate with the transit gateway multicast domain.", - "type": "string" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of the transit gateway attachment.", - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "description": "The ID of the transit gateway multicast domain.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceId", - "/properties/ResourceType", - "/properties/State" - ], - "required": [ - "TransitGatewayMulticastDomainId", - "TransitGatewayAttachmentId", - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", - "typeName": "AWS::EC2::TransitGatewayMulticastDomainAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/TransitGatewayAttachmentId", + "/properties/SubnetId" + ], + "description": "The AWS::EC2::TransitGatewayMulticastDomainAssociation type", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateTransitGatewayMulticastDomain", + "ec2:GetTransitGatewayMulticastDomainAssociations" + ] + }, + "delete": { + "permissions": [ + "ec2:DisassociateTransitGatewayMulticastDomain", + "ec2:GetTransitGatewayMulticastDomainAssociations" + ] + }, + "list": { + "permissions": [ + "ec2:GetTransitGatewayMulticastDomainAssociations" + ] + }, + "read": { + "permissions": [ + "ec2:GetTransitGatewayMulticastDomainAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/TransitGatewayAttachmentId", + "/properties/SubnetId" + ], + "properties": { + "ResourceId": { + "description": "The ID of the resource.", + "type": "string" + }, + "ResourceType": { + "description": "The type of resource, for example a VPC attachment.", + "type": "string" + }, + "State": { + "description": "The state of the subnet association.", + "type": "string" + }, + "SubnetId": { + "description": "The IDs of the subnets to associate with the transit gateway multicast domain.", + "type": "string" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of the transit gateway attachment.", + "type": "string" + }, + "TransitGatewayMulticastDomainId": { + "description": "The ID of the transit gateway multicast domain.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceId", + "/properties/ResourceType", + "/properties/State" + ], + "required": [ + "TransitGatewayMulticastDomainId", + "TransitGatewayAttachmentId", + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayMulticastDomainAssociation" +} diff --git a/schema/aws-ec2-transitgatewaymulticastgroupmember.json b/schema/aws-ec2-transitgatewaymulticastgroupmember.json index 76fd921..06b0261 100644 --- a/schema/aws-ec2-transitgatewaymulticastgroupmember.json +++ b/schema/aws-ec2-transitgatewaymulticastgroupmember.json @@ -1,101 +1,112 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/GroupIpAddress", - "/properties/NetworkInterfaceId" - ], - "description": "The AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group", - "handlers": { - "create": { - "permissions": [ - "ec2:RegisterTransitGatewayMulticastGroupMembers", - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "delete": { - "permissions": [ - "ec2:DeregisterTransitGatewayMulticastGroupMembers", - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "list": { - "permissions": [ - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "read": { - "permissions": [ - "ec2:SearchTransitGatewayMulticastGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/GroupIpAddress", - "/properties/NetworkInterfaceId" - ], - "properties": { - "GroupIpAddress": { - "description": "The IP address assigned to the transit gateway multicast group.", - "type": "string" - }, - "GroupMember": { - "description": "Indicates that the resource is a transit gateway multicast group member.", - "type": "boolean" - }, - "GroupSource": { - "description": "Indicates that the resource is a transit gateway multicast group member.", - "type": "boolean" - }, - "MemberType": { - "description": "The member type (for example, static).", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of the transit gateway attachment.", - "type": "string" - }, - "ResourceId": { - "description": "The ID of the resource.", - "type": "string" - }, - "ResourceType": { - "description": "The type of resource, for example a VPC attachment.", - "type": "string" - }, - "SourceType": { - "description": "The source type.", - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet.", - "type": "string" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of the transit gateway attachment.", - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "description": "The ID of the transit gateway multicast domain.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SubnetId", - "/properties/ResourceId", - "/properties/ResourceType", - "/properties/GroupSource", - "/properties/GroupMember", - "/properties/MemberType", - "/properties/SourceType", - "/properties/TransitGatewayAttachmentId" - ], - "required": [ - "GroupIpAddress", - "NetworkInterfaceId", - "TransitGatewayMulticastDomainId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgatewaymulticastdomain/aws-ec2-transitgatewaymulticastgroupsource", - "typeName": "AWS::EC2::TransitGatewayMulticastGroupMember" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/GroupIpAddress", + "/properties/NetworkInterfaceId" + ], + "description": "The AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group", + "handlers": { + "create": { + "permissions": [ + "ec2:RegisterTransitGatewayMulticastGroupMembers", + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "delete": { + "permissions": [ + "ec2:DeregisterTransitGatewayMulticastGroupMembers", + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TransitGatewayMulticastDomainId": { + "$ref": "resource-schema.json#/properties/TransitGatewayMulticastDomainId" + } + }, + "required": [ + "TransitGatewayMulticastDomainId" + ] + }, + "permissions": [ + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "read": { + "permissions": [ + "ec2:SearchTransitGatewayMulticastGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/GroupIpAddress", + "/properties/NetworkInterfaceId" + ], + "properties": { + "GroupIpAddress": { + "description": "The IP address assigned to the transit gateway multicast group.", + "type": "string" + }, + "GroupMember": { + "description": "Indicates that the resource is a transit gateway multicast group member.", + "type": "boolean" + }, + "GroupSource": { + "description": "Indicates that the resource is a transit gateway multicast group member.", + "type": "boolean" + }, + "MemberType": { + "description": "The member type (for example, static).", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The ID of the transit gateway attachment.", + "type": "string" + }, + "ResourceId": { + "description": "The ID of the resource.", + "type": "string" + }, + "ResourceType": { + "description": "The type of resource, for example a VPC attachment.", + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet.", + "type": "string" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of the transit gateway attachment.", + "type": "string" + }, + "TransitGatewayMulticastDomainId": { + "description": "The ID of the transit gateway multicast domain.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SubnetId", + "/properties/ResourceId", + "/properties/ResourceType", + "/properties/GroupSource", + "/properties/GroupMember", + "/properties/MemberType", + "/properties/TransitGatewayAttachmentId" + ], + "required": [ + "GroupIpAddress", + "NetworkInterfaceId", + "TransitGatewayMulticastDomainId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgatewaymulticastdomain/aws-ec2-transitgatewaymulticastgroupsource", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayMulticastGroupMember" +} diff --git a/schema/aws-ec2-transitgatewaymulticastgroupsource.json b/schema/aws-ec2-transitgatewaymulticastgroupsource.json index 736b632..b6c1fd5 100644 --- a/schema/aws-ec2-transitgatewaymulticastgroupsource.json +++ b/schema/aws-ec2-transitgatewaymulticastgroupsource.json @@ -1,101 +1,112 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/GroupIpAddress", - "/properties/NetworkInterfaceId" - ], - "description": "The AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group", - "handlers": { - "create": { - "permissions": [ - "ec2:RegisterTransitGatewayMulticastGroupSources", - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "delete": { - "permissions": [ - "ec2:DeregisterTransitGatewayMulticastGroupSources", - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "list": { - "permissions": [ - "ec2:SearchTransitGatewayMulticastGroups" - ] - }, - "read": { - "permissions": [ - "ec2:SearchTransitGatewayMulticastGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayMulticastDomainId", - "/properties/GroupIpAddress", - "/properties/NetworkInterfaceId" - ], - "properties": { - "GroupIpAddress": { - "description": "The IP address assigned to the transit gateway multicast group.", - "type": "string" - }, - "GroupMember": { - "description": "Indicates that the resource is a transit gateway multicast group member.", - "type": "boolean" - }, - "GroupSource": { - "description": "Indicates that the resource is a transit gateway multicast group member.", - "type": "boolean" - }, - "MemberType": { - "description": "The member type (for example, static).", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The ID of the transit gateway attachment.", - "type": "string" - }, - "ResourceId": { - "description": "The ID of the resource.", - "type": "string" - }, - "ResourceType": { - "description": "The type of resource, for example a VPC attachment.", - "type": "string" - }, - "SourceType": { - "description": "The source type.", - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet.", - "type": "string" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of the transit gateway attachment.", - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "description": "The ID of the transit gateway multicast domain.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SubnetId", - "/properties/ResourceId", - "/properties/ResourceType", - "/properties/GroupSource", - "/properties/GroupMember", - "/properties/MemberType", - "/properties/SourceType", - "/properties/TransitGatewayAttachmentId" - ], - "required": [ - "TransitGatewayMulticastDomainId", - "NetworkInterfaceId", - "GroupIpAddress" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgatewaymulticastdomain/aws-ec2-transitgatewaymulticastgroupsource", - "typeName": "AWS::EC2::TransitGatewayMulticastGroupSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/GroupIpAddress", + "/properties/NetworkInterfaceId" + ], + "description": "The AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group", + "handlers": { + "create": { + "permissions": [ + "ec2:RegisterTransitGatewayMulticastGroupSources", + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "delete": { + "permissions": [ + "ec2:DeregisterTransitGatewayMulticastGroupSources", + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TransitGatewayMulticastDomainId": { + "$ref": "resource-schema.json#/properties/TransitGatewayMulticastDomainId" + } + }, + "required": [ + "TransitGatewayMulticastDomainId" + ] + }, + "permissions": [ + "ec2:SearchTransitGatewayMulticastGroups" + ] + }, + "read": { + "permissions": [ + "ec2:SearchTransitGatewayMulticastGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayMulticastDomainId", + "/properties/GroupIpAddress", + "/properties/NetworkInterfaceId" + ], + "properties": { + "GroupIpAddress": { + "description": "The IP address assigned to the transit gateway multicast group.", + "type": "string" + }, + "GroupMember": { + "description": "Indicates that the resource is a transit gateway multicast group member.", + "type": "boolean" + }, + "GroupSource": { + "description": "Indicates that the resource is a transit gateway multicast group member.", + "type": "boolean" + }, + "NetworkInterfaceId": { + "description": "The ID of the transit gateway attachment.", + "type": "string" + }, + "ResourceId": { + "description": "The ID of the resource.", + "type": "string" + }, + "ResourceType": { + "description": "The type of resource, for example a VPC attachment.", + "type": "string" + }, + "SourceType": { + "description": "The source type.", + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet.", + "type": "string" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of the transit gateway attachment.", + "type": "string" + }, + "TransitGatewayMulticastDomainId": { + "description": "The ID of the transit gateway multicast domain.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SubnetId", + "/properties/ResourceId", + "/properties/ResourceType", + "/properties/GroupSource", + "/properties/GroupMember", + "/properties/SourceType", + "/properties/TransitGatewayAttachmentId" + ], + "required": [ + "TransitGatewayMulticastDomainId", + "NetworkInterfaceId", + "GroupIpAddress" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgatewaymulticastdomain/aws-ec2-transitgatewaymulticastgroupsource", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayMulticastGroupSource" +} diff --git a/schema/aws-ec2-transitgatewaypeeringattachment.json b/schema/aws-ec2-transitgatewaypeeringattachment.json index de25126..edaddf8 100644 --- a/schema/aws-ec2-transitgatewaypeeringattachment.json +++ b/schema/aws-ec2-transitgatewaypeeringattachment.json @@ -1,128 +1,139 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayId", - "/properties/PeerTransitGatewayId", - "/properties/PeerRegion", - "/properties/PeerAccountId" - ], - "definitions": { - "PeeringAttachmentStatus": { - "additionalProperties": false, - "properties": { - "Code": { - "description": "The status code.", - "type": "string" - }, - "Message": { - "description": "The status message, if applicable.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", - "type": "string" - }, - "Value": { - "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::EC2::TransitGatewayPeeringAttachment type", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTransitGatewayPeeringAttachment", - "ec2:DescribeTransitGatewayPeeringAttachments" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteTransitGatewayPeeringAttachment", - "ec2:DescribeTransitGatewayPeeringAttachments" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayPeeringAttachments" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayPeeringAttachments" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeTransitGatewayPeeringAttachments" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayAttachmentId" - ], - "properties": { - "CreationTime": { - "description": "The time the transit gateway peering attachment was created.", - "format": "date-time", - "type": "string" - }, - "PeerAccountId": { - "description": "The ID of the peer account", - "type": "string" - }, - "PeerRegion": { - "description": "Peer Region", - "type": "string" - }, - "PeerTransitGatewayId": { - "description": "The ID of the peer transit gateway.", - "type": "string" - }, - "State": { - "description": "The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/PeeringAttachmentStatus", - "description": "The status of the transit gateway peering attachment." - }, - "Tags": { - "description": "The tags for the transit gateway peering attachment.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of the transit gateway peering attachment.", - "type": "string" - }, - "TransitGatewayId": { - "description": "The ID of the transit gateway.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TransitGatewayAttachmentId", - "/properties/Status", - "/properties/State", - "/properties/CreationTime" - ], - "required": [ - "TransitGatewayId", - "PeerTransitGatewayId", - "PeerAccountId", - "PeerRegion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", - "typeName": "AWS::EC2::TransitGatewayPeeringAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayId", + "/properties/PeerTransitGatewayId", + "/properties/PeerRegion", + "/properties/PeerAccountId" + ], + "definitions": { + "PeeringAttachmentStatus": { + "additionalProperties": false, + "properties": { + "Code": { + "description": "The status code.", + "type": "string" + }, + "Message": { + "description": "The status message, if applicable.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.", + "type": "string" + }, + "Value": { + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::EC2::TransitGatewayPeeringAttachment type", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTransitGatewayPeeringAttachment", + "ec2:DescribeTransitGatewayPeeringAttachments", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteTransitGatewayPeeringAttachment", + "ec2:DescribeTransitGatewayPeeringAttachments", + "ec2:DeleteTags" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayPeeringAttachments" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayPeeringAttachments" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeTransitGatewayPeeringAttachments", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayAttachmentId" + ], + "properties": { + "CreationTime": { + "description": "The time the transit gateway peering attachment was created.", + "format": "date-time", + "type": "string" + }, + "PeerAccountId": { + "description": "The ID of the peer account", + "type": "string" + }, + "PeerRegion": { + "description": "Peer Region", + "type": "string" + }, + "PeerTransitGatewayId": { + "description": "The ID of the peer transit gateway.", + "type": "string" + }, + "State": { + "description": "The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/PeeringAttachmentStatus", + "description": "The status of the transit gateway peering attachment." + }, + "Tags": { + "description": "The tags for the transit gateway peering attachment.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of the transit gateway peering attachment.", + "type": "string" + }, + "TransitGatewayId": { + "description": "The ID of the transit gateway.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TransitGatewayAttachmentId", + "/properties/Status", + "/properties/State", + "/properties/CreationTime" + ], + "required": [ + "TransitGatewayId", + "PeerTransitGatewayId", + "PeerAccountId", + "PeerRegion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-myservice", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayPeeringAttachment" +} diff --git a/schema/aws-ec2-transitgatewayroute.json b/schema/aws-ec2-transitgatewayroute.json index b239307..e9b6449 100644 --- a/schema/aws-ec2-transitgatewayroute.json +++ b/schema/aws-ec2-transitgatewayroute.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayRouteTableId", - "/properties/TransitGatewayAttachmentId", - "/properties/DestinationCidrBlock", - "/properties/Blackhole" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::EC2::TransitGatewayRoute", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTransitGatewayRoute", - "ec2:SearchTransitGatewayRoutes" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteTransitGatewayRoute", - "ec2:SearchTransitGatewayRoutes" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TransitGatewayRouteTableId": { - "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" - } - }, - "required": [ - "TransitGatewayRouteTableId" - ] - }, - "permissions": [ - "ec2:SearchTransitGatewayRoutes" - ] - }, - "read": { - "permissions": [ - "ec2:SearchTransitGatewayRoutes" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayRouteTableId", - "/properties/DestinationCidrBlock" - ], - "properties": { - "Blackhole": { - "description": "Indicates whether to drop traffic that matches this route.", - "type": "boolean" - }, - "DestinationCidrBlock": { - "description": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.", - "type": "string" - }, - "TransitGatewayAttachmentId": { - "description": "The ID of transit gateway attachment.", - "type": "string" - }, - "TransitGatewayRouteTableId": { - "description": "The ID of transit gateway route table.", - "type": "string" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "TransitGatewayRouteTableId", - "DestinationCidrBlock" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::TransitGatewayRoute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayRouteTableId", + "/properties/TransitGatewayAttachmentId", + "/properties/DestinationCidrBlock", + "/properties/Blackhole" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::EC2::TransitGatewayRoute", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTransitGatewayRoute", + "ec2:SearchTransitGatewayRoutes" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteTransitGatewayRoute", + "ec2:SearchTransitGatewayRoutes" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TransitGatewayRouteTableId": { + "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" + } + }, + "required": [ + "TransitGatewayRouteTableId" + ] + }, + "permissions": [ + "ec2:SearchTransitGatewayRoutes" + ] + }, + "read": { + "permissions": [ + "ec2:SearchTransitGatewayRoutes" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayRouteTableId", + "/properties/DestinationCidrBlock" + ], + "properties": { + "Blackhole": { + "description": "Indicates whether to drop traffic that matches this route.", + "type": "boolean" + }, + "DestinationCidrBlock": { + "description": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.", + "type": "string" + }, + "TransitGatewayAttachmentId": { + "description": "The ID of transit gateway attachment.", + "type": "string" + }, + "TransitGatewayRouteTableId": { + "description": "The ID of transit gateway route table.", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "TransitGatewayRouteTableId", + "DestinationCidrBlock" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayRoute" +} diff --git a/schema/aws-ec2-transitgatewayroutetable.json b/schema/aws-ec2-transitgatewayroutetable.json index 6abe495..2258877 100644 --- a/schema/aws-ec2-transitgatewayroutetable.json +++ b/schema/aws-ec2-transitgatewayroutetable.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayId", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key of the associated tag key-value pair", - "type": "string" - }, - "Value": { - "description": "The value of the associated tag key-value pair", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TransitGatewayRouteTable", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateTransitGatewayRouteTable", - "ec2:CreateTags", - "ec2:DescribeTransitGatewayRouteTables" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteTransitGatewayRouteTable", - "ec2:DescribeTransitGatewayRouteTables", - "ec2:GetTransitGatewayRouteTableAssociations", - "ec2:DisassociateTransitGatewayRouteTable" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayRouteTables" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayRouteTables" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayRouteTableId" - ], - "properties": { - "Tags": { - "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitGatewayId": { - "description": "The ID of the transit gateway.", - "type": "string" - }, - "TransitGatewayRouteTableId": { - "description": "Transit Gateway Route Table primary identifier", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TransitGatewayRouteTableId" - ], - "required": [ - "TransitGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::EC2::TransitGatewayRouteTable" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayId", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key of the associated tag key-value pair", + "type": "string" + }, + "Value": { + "description": "The value of the associated tag key-value pair", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TransitGatewayRouteTable", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateTransitGatewayRouteTable", + "ec2:CreateTags", + "ec2:DescribeTransitGatewayRouteTables" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteTransitGatewayRouteTable", + "ec2:DescribeTransitGatewayRouteTables", + "ec2:GetTransitGatewayRouteTableAssociations", + "ec2:DisassociateTransitGatewayRouteTable" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayRouteTables" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayRouteTables" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayRouteTableId" + ], + "properties": { + "Tags": { + "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitGatewayId": { + "description": "The ID of the transit gateway.", + "type": "string" + }, + "TransitGatewayRouteTableId": { + "description": "Transit Gateway Route Table primary identifier", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TransitGatewayRouteTableId" + ], + "required": [ + "TransitGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayRouteTable" +} diff --git a/schema/aws-ec2-transitgatewayroutetableassociation.json b/schema/aws-ec2-transitgatewayroutetableassociation.json index f990601..6dbf32d 100644 --- a/schema/aws-ec2-transitgatewayroutetableassociation.json +++ b/schema/aws-ec2-transitgatewayroutetableassociation.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayRouteTableId", - "/properties/TransitGatewayAttachmentId" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateTransitGatewayRouteTable", - "ec2:GetTransitGatewayRouteTableAssociations" - ] - }, - "delete": { - "permissions": [ - "ec2:GetTransitGatewayRouteTableAssociations", - "ec2:DisassociateTransitGatewayRouteTable" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TransitGatewayRouteTableId": { - "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" - } - }, - "required": [ - "TransitGatewayRouteTableId" - ] - }, - "permissions": [ - "ec2:GetTransitGatewayRouteTableAssociations" - ] - }, - "read": { - "permissions": [ - "ec2:GetTransitGatewayRouteTableAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayRouteTableId", - "/properties/TransitGatewayAttachmentId" - ], - "properties": { - "TransitGatewayAttachmentId": { - "description": "The ID of transit gateway attachment.", - "type": "string" - }, - "TransitGatewayRouteTableId": { - "description": "The ID of transit gateway route table.", - "type": "string" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "TransitGatewayRouteTableId", - "TransitGatewayAttachmentId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::TransitGatewayRouteTableAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayRouteTableId", + "/properties/TransitGatewayAttachmentId" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateTransitGatewayRouteTable", + "ec2:GetTransitGatewayRouteTableAssociations" + ] + }, + "delete": { + "permissions": [ + "ec2:GetTransitGatewayRouteTableAssociations", + "ec2:DisassociateTransitGatewayRouteTable" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TransitGatewayRouteTableId": { + "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" + } + }, + "required": [ + "TransitGatewayRouteTableId" + ] + }, + "permissions": [ + "ec2:GetTransitGatewayRouteTableAssociations" + ] + }, + "read": { + "permissions": [ + "ec2:GetTransitGatewayRouteTableAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayRouteTableId", + "/properties/TransitGatewayAttachmentId" + ], + "properties": { + "TransitGatewayAttachmentId": { + "description": "The ID of transit gateway attachment.", + "type": "string" + }, + "TransitGatewayRouteTableId": { + "description": "The ID of transit gateway route table.", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayRouteTableAssociation" +} diff --git a/schema/aws-ec2-transitgatewayroutetablepropagation.json b/schema/aws-ec2-transitgatewayroutetablepropagation.json index 3591b54..70f29f4 100644 --- a/schema/aws-ec2-transitgatewayroutetablepropagation.json +++ b/schema/aws-ec2-transitgatewayroutetablepropagation.json @@ -1,69 +1,69 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayAttachmentId", - "/properties/TransitGatewayRouteTableId" - ], - "definitions": {}, - "description": "AWS::EC2::TransitGatewayRouteTablePropagation Type", - "handlers": { - "create": { - "permissions": [ - "ec2:GetTransitGatewayRouteTablePropagations", - "ec2:EnableTransitGatewayRouteTablePropagation" - ] - }, - "delete": { - "permissions": [ - "ec2:GetTransitGatewayRouteTablePropagations", - "ec2:DisableTransitGatewayRouteTablePropagation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TransitGatewayRouteTableId": { - "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" - } - }, - "required": [ - "TransitGatewayRouteTableId" - ] - }, - "permissions": [ - "ec2:GetTransitGatewayRouteTablePropagations" - ] - }, - "read": { - "permissions": [ - "ec2:GetTransitGatewayRouteTablePropagations" - ] - } - }, - "primaryIdentifier": [ - "/properties/TransitGatewayRouteTableId", - "/properties/TransitGatewayAttachmentId" - ], - "properties": { - "TransitGatewayAttachmentId": { - "description": "The ID of transit gateway attachment.", - "type": "string" - }, - "TransitGatewayRouteTableId": { - "description": "The ID of transit gateway route table.", - "type": "string" - } - }, - "required": [ - "TransitGatewayRouteTableId", - "TransitGatewayAttachmentId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway/aws-ec2-transitgatewayroutetablepropagation", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::TransitGatewayRouteTablePropagation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayAttachmentId", + "/properties/TransitGatewayRouteTableId" + ], + "definitions": {}, + "description": "AWS::EC2::TransitGatewayRouteTablePropagation Type", + "handlers": { + "create": { + "permissions": [ + "ec2:GetTransitGatewayRouteTablePropagations", + "ec2:EnableTransitGatewayRouteTablePropagation" + ] + }, + "delete": { + "permissions": [ + "ec2:GetTransitGatewayRouteTablePropagations", + "ec2:DisableTransitGatewayRouteTablePropagation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TransitGatewayRouteTableId": { + "$ref": "resource-schema.json#/properties/TransitGatewayRouteTableId" + } + }, + "required": [ + "TransitGatewayRouteTableId" + ] + }, + "permissions": [ + "ec2:GetTransitGatewayRouteTablePropagations" + ] + }, + "read": { + "permissions": [ + "ec2:GetTransitGatewayRouteTablePropagations" + ] + } + }, + "primaryIdentifier": [ + "/properties/TransitGatewayRouteTableId", + "/properties/TransitGatewayAttachmentId" + ], + "properties": { + "TransitGatewayAttachmentId": { + "description": "The ID of transit gateway attachment.", + "type": "string" + }, + "TransitGatewayRouteTableId": { + "description": "The ID of transit gateway route table.", + "type": "string" + } + }, + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway/aws-ec2-transitgatewayroutetablepropagation", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::TransitGatewayRouteTablePropagation" +} diff --git a/schema/aws-ec2-transitgatewayvpcattachment.json b/schema/aws-ec2-transitgatewayvpcattachment.json index cc214dd..5435133 100644 --- a/schema/aws-ec2-transitgatewayvpcattachment.json +++ b/schema/aws-ec2-transitgatewayvpcattachment.json @@ -1,178 +1,178 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TransitGatewayId", - "/properties/SubnetIds", - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::TransitGatewayVpcAttachment", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeTags", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeTags", - "ec2:DescribeTransitGatewayAttachments", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeTransitGatewayAttachments", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeTags", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:CreateTags", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags", - "ec2:ModifyTransitGatewayVpcAttachment" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AddSubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Options": { - "additionalProperties": false, - "description": "The options for the transit gateway vpc attachment.", - "properties": { - "ApplianceModeSupport": { - "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - }, - "DnsSupport": { - "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - }, - "Ipv6Support": { - "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", - "type": "string" - } - }, - "type": "object" - }, - "RemoveSubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SubnetIds", - "VpcId", - "TransitGatewayId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::TransitGatewayVpcAttachment", - "writeOnlyProperties": [ - "/properties/AddSubnetIds", - "/properties/RemoveSubnetIds" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TransitGatewayId", + "/properties/SubnetIds", + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::TransitGatewayVpcAttachment", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeTags", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeTags", + "ec2:DescribeTransitGatewayAttachments", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeTransitGatewayAttachments", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeTags", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:CreateTags", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags", + "ec2:ModifyTransitGatewayVpcAttachment" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AddSubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Options": { + "additionalProperties": false, + "description": "The options for the transit gateway vpc attachment.", + "properties": { + "ApplianceModeSupport": { + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + }, + "DnsSupport": { + "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + }, + "Ipv6Support": { + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", + "type": "string" + } + }, + "type": "object" + }, + "RemoveSubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SubnetIds", + "VpcId", + "TransitGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transitgateway", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::TransitGatewayVpcAttachment", + "writeOnlyProperties": [ + "/properties/AddSubnetIds", + "/properties/RemoveSubnetIds" + ] +} diff --git a/schema/aws-ec2-verifiedaccessendpoint.json b/schema/aws-ec2-verifiedaccessendpoint.json index 175b241..48bcf29 100644 --- a/schema/aws-ec2-verifiedaccessendpoint.json +++ b/schema/aws-ec2-verifiedaccessendpoint.json @@ -1,423 +1,423 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationDomain", - "/properties/AttachmentType", - "/properties/DomainCertificateArn", - "/properties/EndpointDomainPrefix", - "/properties/EndpointType", - "/properties/SecurityGroupIds", - "/properties/NetworkInterfaceOptions/NetworkInterfaceId", - "/properties/LoadBalancerOptions/LoadBalancerArn" - ], - "definitions": { - "LoadBalancerOptions": { - "additionalProperties": false, - "description": "The load balancer details if creating the AWS Verified Access endpoint as load-balancertype.", - "properties": { - "LoadBalancerArn": { - "description": "The ARN of the load balancer.", - "type": "string" - }, - "Port": { - "description": "The IP port number.", - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "description": "The IP protocol.", - "type": "string" - }, - "SubnetIds": { - "description": "The IDs of the subnets.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetId" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "NetworkInterfaceOptions": { - "additionalProperties": false, - "description": "The options for network-interface type endpoint.", - "properties": { - "NetworkInterfaceId": { - "description": "The ID of the network interface.", - "type": "string" - }, - "Port": { - "description": "The IP port number.", - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "description": "The IP protocol.", - "type": "string" - } - }, - "type": "object" - }, - "SecurityGroupId": { - "description": "The ID of a security group for the endpoint.", - "type": "string" - }, - "SseSpecification": { - "additionalProperties": false, - "description": "The configuration options for customer provided KMS encryption.", - "properties": { - "CustomerManagedKeyEnabled": { - "description": "Whether to encrypt the policy with the provided key or disable encryption", - "type": "boolean" - }, - "KmsKeyArn": { - "description": "KMS Key Arn used to encrypt the group policy", - "type": "string" - } - }, - "type": "object" - }, - "SubnetId": { - "description": "The IDs of the subnet.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVerifiedAccessEndpoint", - "ec2:DescribeVerifiedAccessEndpoints", - "ec2:CreateTags", - "ec2:DescribeTags", - "iam:CreateServiceLinkedRole", - "iam:ListRoles", - "acm:GetCertificateWithPK", - "acm:DescribeCertificate", - "acm:CreateCertificateRelation", - "sso:GetManagedApplicationInstance", - "sso:GetPeregrineStatus", - "sso:GetSharedSsoConfiguration", - "sso:CreateManagedApplicationInstance", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeAccountAttributes", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeListenerCertificates", - "acm:DeleteCertificateRelation", - "ec2:DeleteTags", - "ec2:DeleteVerifiedAccessEndpoint", - "ec2:GetVerifiedAccessEndpointPolicy", - "ec2:ModifyVerifiedAccessEndpoint", - "ec2:ModifyVerifiedAccessEndpointPolicy", - "sso:DeleteManagedApplicationInstance", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "ec2:DescribeVerifiedAccessEndpoints", - "ec2:DescribeTags", - "ec2:DeleteVerifiedAccessEndpoint", - "ec2:DeleteTags", - "sso:DeleteManagedApplicationInstance", - "acm:DeleteCertificateRelation", - "acm:DescribeCertificate", - "acm:CreateCertificateRelation", - "acm:GetCertificateWithPK", - "ec2:CreateTags", - "ec2:CreateVerifiedAccessEndpoint", - "ec2:DescribeAccountAttributes", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:GetVerifiedAccessEndpointPolicy", - "ec2:ModifyVerifiedAccessEndpoint", - "ec2:ModifyVerifiedAccessEndpointPolicy", - "elasticloadbalancing:DescribeListenerCertificates", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeLoadBalancers", - "iam:CreateServiceLinkedRole", - "iam:ListRoles", - "sso:CreateManagedApplicationInstance", - "sso:GetManagedApplicationInstance", - "sso:GetPeregrineStatus", - "sso:GetSharedSsoConfiguration", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "ec2:DescribeVerifiedAccessEndpoints", - "ec2:DescribeTags", - "acm:CreateCertificateRelation", - "acm:DeleteCertificateRelation", - "acm:DescribeCertificate", - "acm:GetCertificateWithPK", - "ec2:CreateTags", - "ec2:CreateVerifiedAccessEndpoint", - "ec2:DeleteTags", - "ec2:DeleteVerifiedAccessEndpoint", - "ec2:DescribeAccountAttributes", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:GetVerifiedAccessEndpointPolicy", - "ec2:ModifyVerifiedAccessEndpoint", - "ec2:ModifyVerifiedAccessEndpointPolicy", - "elasticloadbalancing:DescribeListenerCertificates", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeLoadBalancers", - "iam:CreateServiceLinkedRole", - "iam:ListRoles", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "sso:GetManagedApplicationInstance", - "sso:GetPeregrineStatus", - "sso:GetSharedSsoConfiguration", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVerifiedAccessEndpoints", - "ec2:GetVerifiedAccessEndpointPolicy", - "ec2:DescribeTags", - "acm:CreateCertificateRelation", - "acm:DeleteCertificateRelation", - "acm:DescribeCertificate", - "acm:GetCertificateWithPK", - "ec2:CreateTags", - "ec2:CreateVerifiedAccessEndpoint", - "ec2:DeleteTags", - "ec2:DeleteVerifiedAccessEndpoint", - "ec2:DescribeAccountAttributes", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:ModifyVerifiedAccessEndpoint", - "ec2:ModifyVerifiedAccessEndpointPolicy", - "elasticloadbalancing:DescribeListenerCertificates", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeLoadBalancers", - "iam:CreateServiceLinkedRole", - "iam:ListRoles", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "sso:GetManagedApplicationInstance", - "sso:GetPeregrineStatus", - "sso:GetSharedSsoConfiguration", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVerifiedAccessEndpoint", - "ec2:ModifyVerifiedAccessEndpointPolicy", - "ec2:DescribeVerifiedAccessEndpoints", - "ec2:GetVerifiedAccessEndpointPolicy", - "ec2:DescribeTags", - "ec2:DeleteTags", - "ec2:CreateTags", - "acm:GetCertificateWithPK", - "acm:DescribeCertificate", - "acm:CreateCertificateRelation", - "acm:DeleteCertificateRelation", - "sso:GetManagedApplicationInstance", - "sso:GetPeregrineStatus", - "sso:GetSharedSsoConfiguration", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeAccountAttributes", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeListenerCertificates", - "ec2:CreateVerifiedAccessEndpoint", - "ec2:DeleteVerifiedAccessEndpoint", - "iam:CreateServiceLinkedRole", - "iam:ListRoles", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ], - "timeoutInMinutes": 60 - } - }, - "primaryIdentifier": [ - "/properties/VerifiedAccessEndpointId" - ], - "properties": { - "ApplicationDomain": { - "description": "The DNS name for users to reach your application.", - "type": "string" - }, - "AttachmentType": { - "description": "The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.", - "type": "string" - }, - "CreationTime": { - "description": "The creation time.", - "type": "string" - }, - "Description": { - "description": "A description for the AWS Verified Access endpoint.", - "type": "string" - }, - "DeviceValidationDomain": { - "description": "Returned if endpoint has a device trust provider attached.", - "type": "string" - }, - "DomainCertificateArn": { - "description": "The ARN of a public TLS/SSL certificate imported into or created with ACM.", - "type": "string" - }, - "EndpointDomain": { - "description": "A DNS name that is generated for the endpoint.", - "type": "string" - }, - "EndpointDomainPrefix": { - "description": "A custom identifier that gets prepended to a DNS name that is generated for the endpoint.", - "type": "string" - }, - "EndpointType": { - "description": "The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.", - "type": "string" - }, - "LastUpdatedTime": { - "description": "The last updated time.", - "type": "string" - }, - "LoadBalancerOptions": { - "$ref": "#/definitions/LoadBalancerOptions", - "description": "The load balancer details if creating the AWS Verified Access endpoint as load-balancer type." - }, - "NetworkInterfaceOptions": { - "$ref": "#/definitions/NetworkInterfaceOptions", - "description": "The options for network-interface type endpoint." - }, - "PolicyDocument": { - "description": "The AWS Verified Access policy document.", - "type": "string" - }, - "PolicyEnabled": { - "description": "The status of the Verified Access policy.", - "type": "boolean" - }, - "SecurityGroupIds": { - "description": "The IDs of the security groups for the endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "type": "array", - "uniqueItems": true - }, - "SseSpecification": { - "$ref": "#/definitions/SseSpecification", - "description": "The configuration options for customer provided KMS encryption." - }, - "Status": { - "description": "The endpoint status.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VerifiedAccessEndpointId": { - "description": "The ID of the AWS Verified Access endpoint.", - "type": "string" - }, - "VerifiedAccessGroupId": { - "description": "The ID of the AWS Verified Access group.", - "type": "string" - }, - "VerifiedAccessInstanceId": { - "description": "The ID of the AWS Verified Access instance.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VerifiedAccessEndpointId", - "/properties/EndpointDomain", - "/properties/CreationTime", - "/properties/LastUpdatedTime", - "/properties/Status", - "/properties/DeviceValidationDomain", - "/properties/VerifiedAccessInstanceId" - ], - "required": [ - "ApplicationDomain", - "AttachmentType", - "DomainCertificateArn", - "EndpointType", - "VerifiedAccessGroupId", - "EndpointDomainPrefix" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessendpoint", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VerifiedAccessEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationDomain", + "/properties/AttachmentType", + "/properties/DomainCertificateArn", + "/properties/EndpointDomainPrefix", + "/properties/EndpointType", + "/properties/SecurityGroupIds", + "/properties/NetworkInterfaceOptions/NetworkInterfaceId", + "/properties/LoadBalancerOptions/LoadBalancerArn" + ], + "definitions": { + "LoadBalancerOptions": { + "additionalProperties": false, + "description": "The load balancer details if creating the AWS Verified Access endpoint as load-balancertype.", + "properties": { + "LoadBalancerArn": { + "description": "The ARN of the load balancer.", + "type": "string" + }, + "Port": { + "description": "The IP port number.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "description": "The IP protocol.", + "type": "string" + }, + "SubnetIds": { + "description": "The IDs of the subnets.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetId" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "NetworkInterfaceOptions": { + "additionalProperties": false, + "description": "The options for network-interface type endpoint.", + "properties": { + "NetworkInterfaceId": { + "description": "The ID of the network interface.", + "type": "string" + }, + "Port": { + "description": "The IP port number.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "description": "The IP protocol.", + "type": "string" + } + }, + "type": "object" + }, + "SecurityGroupId": { + "description": "The ID of a security group for the endpoint.", + "type": "string" + }, + "SseSpecification": { + "additionalProperties": false, + "description": "The configuration options for customer provided KMS encryption.", + "properties": { + "CustomerManagedKeyEnabled": { + "description": "Whether to encrypt the policy with the provided key or disable encryption", + "type": "boolean" + }, + "KmsKeyArn": { + "description": "KMS Key Arn used to encrypt the group policy", + "type": "string" + } + }, + "type": "object" + }, + "SubnetId": { + "description": "The IDs of the subnet.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVerifiedAccessEndpoint", + "ec2:DescribeVerifiedAccessEndpoints", + "ec2:CreateTags", + "ec2:DescribeTags", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "acm:GetCertificateWithPK", + "acm:DescribeCertificate", + "acm:CreateCertificateRelation", + "sso:GetManagedApplicationInstance", + "sso:GetPeregrineStatus", + "sso:GetSharedSsoConfiguration", + "sso:CreateManagedApplicationInstance", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeAccountAttributes", + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeListenerCertificates", + "acm:DeleteCertificateRelation", + "ec2:DeleteTags", + "ec2:DeleteVerifiedAccessEndpoint", + "ec2:GetVerifiedAccessEndpointPolicy", + "ec2:ModifyVerifiedAccessEndpoint", + "ec2:ModifyVerifiedAccessEndpointPolicy", + "sso:DeleteManagedApplicationInstance", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "ec2:DescribeVerifiedAccessEndpoints", + "ec2:DescribeTags", + "ec2:DeleteVerifiedAccessEndpoint", + "ec2:DeleteTags", + "sso:DeleteManagedApplicationInstance", + "acm:DeleteCertificateRelation", + "acm:DescribeCertificate", + "acm:CreateCertificateRelation", + "acm:GetCertificateWithPK", + "ec2:CreateTags", + "ec2:CreateVerifiedAccessEndpoint", + "ec2:DescribeAccountAttributes", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:GetVerifiedAccessEndpointPolicy", + "ec2:ModifyVerifiedAccessEndpoint", + "ec2:ModifyVerifiedAccessEndpointPolicy", + "elasticloadbalancing:DescribeListenerCertificates", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeLoadBalancers", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "sso:CreateManagedApplicationInstance", + "sso:GetManagedApplicationInstance", + "sso:GetPeregrineStatus", + "sso:GetSharedSsoConfiguration", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "ec2:DescribeVerifiedAccessEndpoints", + "ec2:DescribeTags", + "acm:CreateCertificateRelation", + "acm:DeleteCertificateRelation", + "acm:DescribeCertificate", + "acm:GetCertificateWithPK", + "ec2:CreateTags", + "ec2:CreateVerifiedAccessEndpoint", + "ec2:DeleteTags", + "ec2:DeleteVerifiedAccessEndpoint", + "ec2:DescribeAccountAttributes", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:GetVerifiedAccessEndpointPolicy", + "ec2:ModifyVerifiedAccessEndpoint", + "ec2:ModifyVerifiedAccessEndpointPolicy", + "elasticloadbalancing:DescribeListenerCertificates", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeLoadBalancers", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:GetManagedApplicationInstance", + "sso:GetPeregrineStatus", + "sso:GetSharedSsoConfiguration", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVerifiedAccessEndpoints", + "ec2:GetVerifiedAccessEndpointPolicy", + "ec2:DescribeTags", + "acm:CreateCertificateRelation", + "acm:DeleteCertificateRelation", + "acm:DescribeCertificate", + "acm:GetCertificateWithPK", + "ec2:CreateTags", + "ec2:CreateVerifiedAccessEndpoint", + "ec2:DeleteTags", + "ec2:DeleteVerifiedAccessEndpoint", + "ec2:DescribeAccountAttributes", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:ModifyVerifiedAccessEndpoint", + "ec2:ModifyVerifiedAccessEndpointPolicy", + "elasticloadbalancing:DescribeListenerCertificates", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeLoadBalancers", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:GetManagedApplicationInstance", + "sso:GetPeregrineStatus", + "sso:GetSharedSsoConfiguration", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVerifiedAccessEndpoint", + "ec2:ModifyVerifiedAccessEndpointPolicy", + "ec2:DescribeVerifiedAccessEndpoints", + "ec2:GetVerifiedAccessEndpointPolicy", + "ec2:DescribeTags", + "ec2:DeleteTags", + "ec2:CreateTags", + "acm:GetCertificateWithPK", + "acm:DescribeCertificate", + "acm:CreateCertificateRelation", + "acm:DeleteCertificateRelation", + "sso:GetManagedApplicationInstance", + "sso:GetPeregrineStatus", + "sso:GetSharedSsoConfiguration", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeAccountAttributes", + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeListenerCertificates", + "ec2:CreateVerifiedAccessEndpoint", + "ec2:DeleteVerifiedAccessEndpoint", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ], + "timeoutInMinutes": 60 + } + }, + "primaryIdentifier": [ + "/properties/VerifiedAccessEndpointId" + ], + "properties": { + "ApplicationDomain": { + "description": "The DNS name for users to reach your application.", + "type": "string" + }, + "AttachmentType": { + "description": "The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.", + "type": "string" + }, + "CreationTime": { + "description": "The creation time.", + "type": "string" + }, + "Description": { + "description": "A description for the AWS Verified Access endpoint.", + "type": "string" + }, + "DeviceValidationDomain": { + "description": "Returned if endpoint has a device trust provider attached.", + "type": "string" + }, + "DomainCertificateArn": { + "description": "The ARN of a public TLS/SSL certificate imported into or created with ACM.", + "type": "string" + }, + "EndpointDomain": { + "description": "A DNS name that is generated for the endpoint.", + "type": "string" + }, + "EndpointDomainPrefix": { + "description": "A custom identifier that gets prepended to a DNS name that is generated for the endpoint.", + "type": "string" + }, + "EndpointType": { + "description": "The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.", + "type": "string" + }, + "LastUpdatedTime": { + "description": "The last updated time.", + "type": "string" + }, + "LoadBalancerOptions": { + "$ref": "#/definitions/LoadBalancerOptions", + "description": "The load balancer details if creating the AWS Verified Access endpoint as load-balancer type." + }, + "NetworkInterfaceOptions": { + "$ref": "#/definitions/NetworkInterfaceOptions", + "description": "The options for network-interface type endpoint." + }, + "PolicyDocument": { + "description": "The AWS Verified Access policy document.", + "type": "string" + }, + "PolicyEnabled": { + "description": "The status of the Verified Access policy.", + "type": "boolean" + }, + "SecurityGroupIds": { + "description": "The IDs of the security groups for the endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "type": "array", + "uniqueItems": true + }, + "SseSpecification": { + "$ref": "#/definitions/SseSpecification", + "description": "The configuration options for customer provided KMS encryption." + }, + "Status": { + "description": "The endpoint status.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VerifiedAccessEndpointId": { + "description": "The ID of the AWS Verified Access endpoint.", + "type": "string" + }, + "VerifiedAccessGroupId": { + "description": "The ID of the AWS Verified Access group.", + "type": "string" + }, + "VerifiedAccessInstanceId": { + "description": "The ID of the AWS Verified Access instance.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VerifiedAccessEndpointId", + "/properties/EndpointDomain", + "/properties/CreationTime", + "/properties/LastUpdatedTime", + "/properties/Status", + "/properties/DeviceValidationDomain", + "/properties/VerifiedAccessInstanceId" + ], + "required": [ + "ApplicationDomain", + "AttachmentType", + "DomainCertificateArn", + "EndpointType", + "VerifiedAccessGroupId", + "EndpointDomainPrefix" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessendpoint", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VerifiedAccessEndpoint" +} diff --git a/schema/aws-ec2-verifiedaccessgroup.json b/schema/aws-ec2-verifiedaccessgroup.json index 2fddb87..dcc36c3 100644 --- a/schema/aws-ec2-verifiedaccessgroup.json +++ b/schema/aws-ec2-verifiedaccessgroup.json @@ -1,185 +1,185 @@ -{ - "additionalProperties": false, - "definitions": { - "SseSpecification": { - "additionalProperties": false, - "description": "The configuration options for customer provided KMS encryption.", - "properties": { - "CustomerManagedKeyEnabled": { - "description": "Whether to encrypt the policy with the provided key or disable encryption", - "type": "boolean" - }, - "KmsKeyArn": { - "description": "KMS Key Arn used to encrypt the group policy", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVerifiedAccessGroup", - "ec2:DescribeVerifiedAccessGroups", - "ec2:GetVerifiedAccessGroupPolicy", - "ec2:CreateTags", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVerifiedAccessGroup", - "ec2:DeleteTags", - "ec2:DescribeVerifiedAccessGroups", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVerifiedAccessGroups", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVerifiedAccessGroups", - "ec2:GetVerifiedAccessGroupPolicy", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVerifiedAccessGroup", - "ec2:ModifyVerifiedAccessGroupPolicy", - "ec2:DescribeVerifiedAccessGroups", - "ec2:GetVerifiedAccessGroupPolicy", - "ec2:DescribeTags", - "ec2:DeleteTags", - "ec2:CreateTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/VerifiedAccessGroupId" - ], - "properties": { - "CreationTime": { - "description": "Time this Verified Access Group was created.", - "type": "string" - }, - "Description": { - "description": "A description for the AWS Verified Access group.", - "type": "string" - }, - "LastUpdatedTime": { - "description": "Time this Verified Access Group was last updated.", - "type": "string" - }, - "Owner": { - "description": "The AWS account number that owns the group.", - "type": "string" - }, - "PolicyDocument": { - "description": "The AWS Verified Access policy document.", - "type": "string" - }, - "PolicyEnabled": { - "description": "The status of the Verified Access policy.", - "type": "boolean" - }, - "SseSpecification": { - "$ref": "#/definitions/SseSpecification", - "description": "The configuration options for customer provided KMS encryption." - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VerifiedAccessGroupArn": { - "description": "The ARN of the Verified Access group.", - "type": "string" - }, - "VerifiedAccessGroupId": { - "description": "The ID of the AWS Verified Access group.", - "type": "string" - }, - "VerifiedAccessInstanceId": { - "description": "The ID of the AWS Verified Access instance.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VerifiedAccessGroupId", - "/properties/CreationTime", - "/properties/LastUpdatedTime", - "/properties/Owner", - "/properties/VerifiedAccessGroupArn" - ], - "required": [ - "VerifiedAccessInstanceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessgroup", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VerifiedAccessGroup" -} +{ + "additionalProperties": false, + "definitions": { + "SseSpecification": { + "additionalProperties": false, + "description": "The configuration options for customer provided KMS encryption.", + "properties": { + "CustomerManagedKeyEnabled": { + "description": "Whether to encrypt the policy with the provided key or disable encryption", + "type": "boolean" + }, + "KmsKeyArn": { + "description": "KMS Key Arn used to encrypt the group policy", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVerifiedAccessGroup", + "ec2:DescribeVerifiedAccessGroups", + "ec2:GetVerifiedAccessGroupPolicy", + "ec2:CreateTags", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVerifiedAccessGroup", + "ec2:DeleteTags", + "ec2:DescribeVerifiedAccessGroups", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVerifiedAccessGroups", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVerifiedAccessGroups", + "ec2:GetVerifiedAccessGroupPolicy", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVerifiedAccessGroup", + "ec2:ModifyVerifiedAccessGroupPolicy", + "ec2:DescribeVerifiedAccessGroups", + "ec2:GetVerifiedAccessGroupPolicy", + "ec2:DescribeTags", + "ec2:DeleteTags", + "ec2:CreateTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/VerifiedAccessGroupId" + ], + "properties": { + "CreationTime": { + "description": "Time this Verified Access Group was created.", + "type": "string" + }, + "Description": { + "description": "A description for the AWS Verified Access group.", + "type": "string" + }, + "LastUpdatedTime": { + "description": "Time this Verified Access Group was last updated.", + "type": "string" + }, + "Owner": { + "description": "The AWS account number that owns the group.", + "type": "string" + }, + "PolicyDocument": { + "description": "The AWS Verified Access policy document.", + "type": "string" + }, + "PolicyEnabled": { + "description": "The status of the Verified Access policy.", + "type": "boolean" + }, + "SseSpecification": { + "$ref": "#/definitions/SseSpecification", + "description": "The configuration options for customer provided KMS encryption." + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VerifiedAccessGroupArn": { + "description": "The ARN of the Verified Access group.", + "type": "string" + }, + "VerifiedAccessGroupId": { + "description": "The ID of the AWS Verified Access group.", + "type": "string" + }, + "VerifiedAccessInstanceId": { + "description": "The ID of the AWS Verified Access instance.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VerifiedAccessGroupId", + "/properties/CreationTime", + "/properties/LastUpdatedTime", + "/properties/Owner", + "/properties/VerifiedAccessGroupArn" + ], + "required": [ + "VerifiedAccessInstanceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessgroup", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VerifiedAccessGroup" +} diff --git a/schema/aws-ec2-verifiedaccessinstance.json b/schema/aws-ec2-verifiedaccessinstance.json index 560e963..c555b9d 100644 --- a/schema/aws-ec2-verifiedaccessinstance.json +++ b/schema/aws-ec2-verifiedaccessinstance.json @@ -1,293 +1,293 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VerifiedAccessLogs": { - "additionalProperties": false, - "description": "The configuration options for AWS Verified Access instances.", - "properties": { - "CloudWatchLogs": { - "additionalProperties": false, - "description": "Sends Verified Access logs to CloudWatch Logs.", - "properties": { - "Enabled": { - "description": "Indicates whether logging is enabled.", - "type": "boolean" - }, - "LogGroup": { - "description": "The ID of the CloudWatch Logs log group.", - "type": "string" - } - }, - "type": "object" - }, - "IncludeTrustContext": { - "description": "Include claims from trust providers in Verified Access logs.", - "type": "boolean" - }, - "KinesisDataFirehose": { - "additionalProperties": false, - "description": "Sends Verified Access logs to Kinesis.", - "properties": { - "DeliveryStream": { - "description": "The ID of the delivery stream.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether logging is enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "LogVersion": { - "description": "Select log version for Verified Access logs.", - "type": "string" - }, - "S3": { - "additionalProperties": false, - "description": "Sends Verified Access logs to Amazon S3.", - "properties": { - "BucketName": { - "description": "The bucket name.", - "type": "string" - }, - "BucketOwner": { - "description": "The ID of the AWS account that owns the Amazon S3 bucket.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether logging is enabled.", - "type": "boolean" - }, - "Prefix": { - "description": "The bucket prefix.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "VerifiedAccessTrustProvider": { - "additionalProperties": false, - "description": "A Verified Access Trust Provider.", - "properties": { - "Description": { - "description": "The description of trust provider.", - "type": "string" - }, - "DeviceTrustProviderType": { - "description": "The type of device-based trust provider.", - "type": "string" - }, - "TrustProviderType": { - "description": "The type of trust provider (user- or device-based).", - "type": "string" - }, - "UserTrustProviderType": { - "description": "The type of user-based trust provider.", - "type": "string" - }, - "VerifiedAccessTrustProviderId": { - "description": "The ID of the trust provider.", - "type": "string" - } - }, - "type": "object" - }, - "VerifiedAccessTrustProviderId": { - "description": "The ID of the AWS Verified Access trust provider.", - "type": "string" - } - }, - "description": "The AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVerifiedAccessInstance", - "ec2:AttachVerifiedAccessTrustProvider", - "ec2:ModifyVerifiedAccessInstanceLoggingConfiguration", - "ec2:DescribeVerifiedAccessInstances", - "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", - "ec2:DetachVerifiedAccessTrustProvider", - "ec2:DeleteVerifiedAccessInstance", - "ec2:CreateTags", - "ec2:DescribeTags", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:PutDestination", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutLogEvents", - "logs:DescribeLogStreams", - "s3:listBuckets", - "s3:PutObject", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "logs:DescribeLogGroups", - "logs:PutResourcePolicy", - "firehose:TagDeliveryStream", - "logs:DescribeResourcePolicies", - "iam:CreateServiceLinkedRole", - "verified-access:AllowVerifiedAccess" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVerifiedAccessInstance", - "ec2:DeleteTags", - "ec2:DescribeVerifiedAccessInstances", - "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", - "ec2:DetachVerifiedAccessTrustProvider", - "ec2:GetVerifiedAccessGroupPolicy", - "ec2:DescribeTags", - "logs:ListLogDeliveries", - "logs:GetLogDelivery", - "logs:DeleteLogDelivery" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVerifiedAccessInstances", - "ec2:DescribeTags", - "logs:ListLogDeliveries", - "logs:GetLogDelivery" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVerifiedAccessInstances", - "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", - "ec2:DescribeTags", - "logs:GetLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVerifiedAccessInstance", - "ec2:ModifyVerifiedAccessInstanceLoggingConfiguration", - "ec2:DescribeVerifiedAccessInstances", - "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", - "ec2:DescribeTags", - "ec2:AttachVerifiedAccessTrustProvider", - "ec2:DetachVerifiedAccessTrustProvider", - "ec2:DeleteTags", - "ec2:CreateTags", - "ec2:DescribeTags", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:PutDestination", - "logs:PutLogEvents", - "logs:DescribeLogStreams", - "s3:listBuckets", - "s3:PutObject", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "logs:DescribeLogGroups", - "logs:PutResourcePolicy", - "firehose:TagDeliveryStream", - "iam:CreateServiceLinkedRole", - "logs:DescribeResourcePolicies" - ] - } - }, - "primaryIdentifier": [ - "/properties/VerifiedAccessInstanceId" - ], - "properties": { - "CreationTime": { - "description": "Time this Verified Access Instance was created.", - "type": "string" - }, - "Description": { - "description": "A description for the AWS Verified Access instance.", - "type": "string" - }, - "FipsEnabled": { - "description": "Indicates whether FIPS is enabled", - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "Time this Verified Access Instance was last updated.", - "type": "string" - }, - "LoggingConfigurations": { - "$ref": "#/definitions/VerifiedAccessLogs", - "description": "The configuration options for AWS Verified Access instances." - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VerifiedAccessInstanceId": { - "description": "The ID of the AWS Verified Access instance.", - "type": "string" - }, - "VerifiedAccessTrustProviderIds": { - "description": "The IDs of the AWS Verified Access trust providers.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VerifiedAccessTrustProviderId" - }, - "type": "array", - "uniqueItems": true - }, - "VerifiedAccessTrustProviders": { - "description": "AWS Verified Access trust providers.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VerifiedAccessTrustProvider" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/VerifiedAccessInstanceId", - "/properties/CreationTime", - "/properties/LastUpdatedTime" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessinstance", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VerifiedAccessInstance" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VerifiedAccessLogs": { + "additionalProperties": false, + "description": "The configuration options for AWS Verified Access instances.", + "properties": { + "CloudWatchLogs": { + "additionalProperties": false, + "description": "Sends Verified Access logs to CloudWatch Logs.", + "properties": { + "Enabled": { + "description": "Indicates whether logging is enabled.", + "type": "boolean" + }, + "LogGroup": { + "description": "The ID of the CloudWatch Logs log group.", + "type": "string" + } + }, + "type": "object" + }, + "IncludeTrustContext": { + "description": "Include claims from trust providers in Verified Access logs.", + "type": "boolean" + }, + "KinesisDataFirehose": { + "additionalProperties": false, + "description": "Sends Verified Access logs to Kinesis.", + "properties": { + "DeliveryStream": { + "description": "The ID of the delivery stream.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether logging is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "LogVersion": { + "description": "Select log version for Verified Access logs.", + "type": "string" + }, + "S3": { + "additionalProperties": false, + "description": "Sends Verified Access logs to Amazon S3.", + "properties": { + "BucketName": { + "description": "The bucket name.", + "type": "string" + }, + "BucketOwner": { + "description": "The ID of the AWS account that owns the Amazon S3 bucket.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether logging is enabled.", + "type": "boolean" + }, + "Prefix": { + "description": "The bucket prefix.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "VerifiedAccessTrustProvider": { + "additionalProperties": false, + "description": "A Verified Access Trust Provider.", + "properties": { + "Description": { + "description": "The description of trust provider.", + "type": "string" + }, + "DeviceTrustProviderType": { + "description": "The type of device-based trust provider.", + "type": "string" + }, + "TrustProviderType": { + "description": "The type of trust provider (user- or device-based).", + "type": "string" + }, + "UserTrustProviderType": { + "description": "The type of user-based trust provider.", + "type": "string" + }, + "VerifiedAccessTrustProviderId": { + "description": "The ID of the trust provider.", + "type": "string" + } + }, + "type": "object" + }, + "VerifiedAccessTrustProviderId": { + "description": "The ID of the AWS Verified Access trust provider.", + "type": "string" + } + }, + "description": "The AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVerifiedAccessInstance", + "ec2:AttachVerifiedAccessTrustProvider", + "ec2:ModifyVerifiedAccessInstanceLoggingConfiguration", + "ec2:DescribeVerifiedAccessInstances", + "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", + "ec2:DetachVerifiedAccessTrustProvider", + "ec2:DeleteVerifiedAccessInstance", + "ec2:CreateTags", + "ec2:DescribeTags", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:PutDestination", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:DescribeLogStreams", + "s3:listBuckets", + "s3:PutObject", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "logs:DescribeLogGroups", + "logs:PutResourcePolicy", + "firehose:TagDeliveryStream", + "logs:DescribeResourcePolicies", + "iam:CreateServiceLinkedRole", + "verified-access:AllowVerifiedAccess" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVerifiedAccessInstance", + "ec2:DeleteTags", + "ec2:DescribeVerifiedAccessInstances", + "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", + "ec2:DetachVerifiedAccessTrustProvider", + "ec2:GetVerifiedAccessGroupPolicy", + "ec2:DescribeTags", + "logs:ListLogDeliveries", + "logs:GetLogDelivery", + "logs:DeleteLogDelivery" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVerifiedAccessInstances", + "ec2:DescribeTags", + "logs:ListLogDeliveries", + "logs:GetLogDelivery" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVerifiedAccessInstances", + "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", + "ec2:DescribeTags", + "logs:GetLogDelivery", + "logs:ListLogDeliveries" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVerifiedAccessInstance", + "ec2:ModifyVerifiedAccessInstanceLoggingConfiguration", + "ec2:DescribeVerifiedAccessInstances", + "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", + "ec2:DescribeTags", + "ec2:AttachVerifiedAccessTrustProvider", + "ec2:DetachVerifiedAccessTrustProvider", + "ec2:DeleteTags", + "ec2:CreateTags", + "ec2:DescribeTags", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:PutDestination", + "logs:PutLogEvents", + "logs:DescribeLogStreams", + "s3:listBuckets", + "s3:PutObject", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "logs:DescribeLogGroups", + "logs:PutResourcePolicy", + "firehose:TagDeliveryStream", + "iam:CreateServiceLinkedRole", + "logs:DescribeResourcePolicies" + ] + } + }, + "primaryIdentifier": [ + "/properties/VerifiedAccessInstanceId" + ], + "properties": { + "CreationTime": { + "description": "Time this Verified Access Instance was created.", + "type": "string" + }, + "Description": { + "description": "A description for the AWS Verified Access instance.", + "type": "string" + }, + "FipsEnabled": { + "description": "Indicates whether FIPS is enabled", + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "Time this Verified Access Instance was last updated.", + "type": "string" + }, + "LoggingConfigurations": { + "$ref": "#/definitions/VerifiedAccessLogs", + "description": "The configuration options for AWS Verified Access instances." + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VerifiedAccessInstanceId": { + "description": "The ID of the AWS Verified Access instance.", + "type": "string" + }, + "VerifiedAccessTrustProviderIds": { + "description": "The IDs of the AWS Verified Access trust providers.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VerifiedAccessTrustProviderId" + }, + "type": "array", + "uniqueItems": true + }, + "VerifiedAccessTrustProviders": { + "description": "AWS Verified Access trust providers.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VerifiedAccessTrustProvider" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/VerifiedAccessInstanceId", + "/properties/CreationTime", + "/properties/LastUpdatedTime" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccessinstance", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VerifiedAccessInstance" +} diff --git a/schema/aws-ec2-verifiedaccesstrustprovider.json b/schema/aws-ec2-verifiedaccesstrustprovider.json index 89ebab3..574eae0 100644 --- a/schema/aws-ec2-verifiedaccesstrustprovider.json +++ b/schema/aws-ec2-verifiedaccesstrustprovider.json @@ -1,236 +1,236 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyReferenceName", - "/properties/DeviceOptions", - "/properties/DeviceTrustProviderType", - "/properties/TrustProviderType", - "/properties/UserTrustProviderType" - ], - "definitions": { - "DeviceOptions": { - "additionalProperties": false, - "description": "The options for device identity based trust providers.", - "properties": { - "PublicSigningKeyUrl": { - "description": "URL Verified Access will use to verify authenticity of the device tokens.", - "type": "string" - }, - "TenantId": { - "description": "The ID of the tenant application with the device-identity provider.", - "type": "string" - } - }, - "type": "object" - }, - "OidcOptions": { - "additionalProperties": false, - "description": "The OpenID Connect details for an oidc -type, user-identity based trust provider.", - "properties": { - "AuthorizationEndpoint": { - "description": "The OIDC authorization endpoint.", - "type": "string" - }, - "ClientId": { - "description": "The client identifier.", - "type": "string" - }, - "ClientSecret": { - "description": "The client secret.", - "type": "string" - }, - "Issuer": { - "description": "The OIDC issuer.", - "type": "string" - }, - "Scope": { - "description": "OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes.", - "type": "string" - }, - "TokenEndpoint": { - "description": "The OIDC token endpoint.", - "type": "string" - }, - "UserInfoEndpoint": { - "description": "The OIDC user info endpoint.", - "type": "string" - } - }, - "type": "object" - }, - "SseSpecification": { - "$ref": "#/definitions/SseSpecification", - "description": "The configuration options for customer provided KMS encryption." - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVerifiedAccessTrustProvider", - "ec2:DescribeVerifiedAccessTrustProviders", - "ec2:CreateTags", - "ec2:DescribeTags", - "sso:GetSharedSsoConfiguration", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVerifiedAccessTrustProvider", - "ec2:DeleteTags", - "ec2:DescribeVerifiedAccessTrustProviders", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVerifiedAccessTrustProviders", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVerifiedAccessTrustProviders", - "ec2:DescribeTags", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVerifiedAccessTrustProvider", - "ec2:DescribeVerifiedAccessTrustProviders", - "ec2:DescribeTags", - "ec2:DeleteTags", - "ec2:CreateTags", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/VerifiedAccessTrustProviderId" - ], - "properties": { - "CreationTime": { - "description": "The creation time.", - "type": "string" - }, - "Description": { - "description": "A description for the Amazon Web Services Verified Access trust provider.", - "type": "string" - }, - "DeviceOptions": { - "$ref": "#/definitions/DeviceOptions" - }, - "DeviceTrustProviderType": { - "description": "The type of device-based trust provider. Possible values: jamf|crowdstrike", - "type": "string" - }, - "LastUpdatedTime": { - "description": "The last updated time.", - "type": "string" - }, - "OidcOptions": { - "$ref": "#/definitions/OidcOptions" - }, - "PolicyReferenceName": { - "description": "The identifier to be used when working with policy rules.", - "type": "string" - }, - "SseSpecification": { - "additionalProperties": false, - "description": "The configuration options for customer provided KMS encryption.", - "properties": { - "CustomerManagedKeyEnabled": { - "description": "Whether to encrypt the policy with the provided key or disable encryption", - "type": "boolean" - }, - "KmsKeyArn": { - "description": "KMS Key Arn used to encrypt the group policy", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TrustProviderType": { - "description": "Type of trust provider. Possible values: user|device", - "type": "string" - }, - "UserTrustProviderType": { - "description": "The type of device-based trust provider. Possible values: oidc|iam-identity-center", - "type": "string" - }, - "VerifiedAccessTrustProviderId": { - "description": "The ID of the Amazon Web Services Verified Access trust provider.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VerifiedAccessTrustProviderId", - "/properties/CreationTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "TrustProviderType", - "PolicyReferenceName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccesstrustprovider", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VerifiedAccessTrustProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyReferenceName", + "/properties/DeviceOptions", + "/properties/DeviceTrustProviderType", + "/properties/TrustProviderType", + "/properties/UserTrustProviderType" + ], + "definitions": { + "DeviceOptions": { + "additionalProperties": false, + "description": "The options for device identity based trust providers.", + "properties": { + "PublicSigningKeyUrl": { + "description": "URL Verified Access will use to verify authenticity of the device tokens.", + "type": "string" + }, + "TenantId": { + "description": "The ID of the tenant application with the device-identity provider.", + "type": "string" + } + }, + "type": "object" + }, + "OidcOptions": { + "additionalProperties": false, + "description": "The OpenID Connect details for an oidc -type, user-identity based trust provider.", + "properties": { + "AuthorizationEndpoint": { + "description": "The OIDC authorization endpoint.", + "type": "string" + }, + "ClientId": { + "description": "The client identifier.", + "type": "string" + }, + "ClientSecret": { + "description": "The client secret.", + "type": "string" + }, + "Issuer": { + "description": "The OIDC issuer.", + "type": "string" + }, + "Scope": { + "description": "OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes.", + "type": "string" + }, + "TokenEndpoint": { + "description": "The OIDC token endpoint.", + "type": "string" + }, + "UserInfoEndpoint": { + "description": "The OIDC user info endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "SseSpecification": { + "$ref": "#/definitions/SseSpecification", + "description": "The configuration options for customer provided KMS encryption." + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVerifiedAccessTrustProvider", + "ec2:DescribeVerifiedAccessTrustProviders", + "ec2:CreateTags", + "ec2:DescribeTags", + "sso:GetSharedSsoConfiguration", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVerifiedAccessTrustProvider", + "ec2:DeleteTags", + "ec2:DescribeVerifiedAccessTrustProviders", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVerifiedAccessTrustProviders", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVerifiedAccessTrustProviders", + "ec2:DescribeTags", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVerifiedAccessTrustProvider", + "ec2:DescribeVerifiedAccessTrustProviders", + "ec2:DescribeTags", + "ec2:DeleteTags", + "ec2:CreateTags", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/VerifiedAccessTrustProviderId" + ], + "properties": { + "CreationTime": { + "description": "The creation time.", + "type": "string" + }, + "Description": { + "description": "A description for the Amazon Web Services Verified Access trust provider.", + "type": "string" + }, + "DeviceOptions": { + "$ref": "#/definitions/DeviceOptions" + }, + "DeviceTrustProviderType": { + "description": "The type of device-based trust provider. Possible values: jamf|crowdstrike", + "type": "string" + }, + "LastUpdatedTime": { + "description": "The last updated time.", + "type": "string" + }, + "OidcOptions": { + "$ref": "#/definitions/OidcOptions" + }, + "PolicyReferenceName": { + "description": "The identifier to be used when working with policy rules.", + "type": "string" + }, + "SseSpecification": { + "additionalProperties": false, + "description": "The configuration options for customer provided KMS encryption.", + "properties": { + "CustomerManagedKeyEnabled": { + "description": "Whether to encrypt the policy with the provided key or disable encryption", + "type": "boolean" + }, + "KmsKeyArn": { + "description": "KMS Key Arn used to encrypt the group policy", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TrustProviderType": { + "description": "Type of trust provider. Possible values: user|device", + "type": "string" + }, + "UserTrustProviderType": { + "description": "The type of device-based trust provider. Possible values: oidc|iam-identity-center", + "type": "string" + }, + "VerifiedAccessTrustProviderId": { + "description": "The ID of the Amazon Web Services Verified Access trust provider.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VerifiedAccessTrustProviderId", + "/properties/CreationTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "TrustProviderType", + "PolicyReferenceName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-verified-access.aws-ec2-verifiedaccesstrustprovider", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VerifiedAccessTrustProvider" +} diff --git a/schema/aws-ec2-volume.json b/schema/aws-ec2-volume.json index c7df7b1..db6086c 100644 --- a/schema/aws-ec2-volume.json +++ b/schema/aws-ec2-volume.json @@ -1,150 +1,150 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies an Amazon Elastic Block Store (Amazon EBS) volume.\n When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.\n Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.\n Some common scenarios when you might encounter a cooldown period for Amazon EBS include:\n + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.\n + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.\n \n For more information on the coo", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVolume", - "ec2:DescribeVolumes", - "ec2:DescribeVolumeAttribute", - "ec2:ModifyVolumeAttribute", - "ec2:CreateTags", - "kms:GenerateDataKeyWithoutPlaintext", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVolume", - "ec2:CreateSnapshot", - "ec2:DescribeSnapshots", - "ec2:DeleteTags", - "ec2:DescribeVolumes" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVolumes", - "ec2:DescribeTags", - "ec2:DescribeVolumeAttribute" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVolumes", - "ec2:DescribeVolumeAttribute", - "ec2:DescribeTags" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVolume", - "ec2:ModifyVolumeAttribute", - "ec2:DescribeVolumeAttribute", - "ec2:DescribeVolumesModifications", - "ec2:DescribeVolumes", - "ec2:CreateTags", - "ec2:DeleteTags" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/VolumeId" - ], - "properties": { - "AutoEnableIO": { - "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.", - "type": "boolean" - }, - "AvailabilityZone": { - "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.", - "type": "string" - }, - "Encrypted": { - "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.\n Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).", - "type": "boolean" - }, - "Iops": { - "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type:\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.\n This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.\n If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.\n Alternatively, if you want to specify a different key, you can specify one of the following:\n + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.\n + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.\n + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.\n + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.", - "type": "string" - }, - "MultiAttachEnabled": { - "description": "Indicates whether Amazon EBS Multi-Attach is enabled.\n CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.", - "type": "boolean" - }, - "OutpostArn": { - "description": "The Amazon Resource Name (ARN) of the Outpost.", - "type": "string" - }, - "Size": { - "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 GiB\n + ``io1``: 4 - 16,384 GiB\n + ``io2``: 4 - 65,536 GiB\n + ``st1`` and ``sc1``: 125 - 16,384 GiB\n + ``standard``: 1 - 1024 GiB", - "type": "integer" - }, - "SnapshotId": { - "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.", - "type": "string" - }, - "Tags": { - "description": "The tags to apply to the volume during creation.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Throughput": { - "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.\n This parameter is valid only for ``gp3`` volumes. The default value is 125.\n Valid Range: Minimum value of 125. Maximum value of 1000.", - "type": "integer" - }, - "VolumeId": { - "description": "", - "type": "string" - }, - "VolumeType": { - "description": "The volume type. This parameter can be one of the following values:\n + General Purpose SSD: ``gp2`` | ``gp3`` \n + Provisioned IOPS SSD: ``io1`` | ``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n \n For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.\n Default: ``gp2``", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VolumeId" - ], - "required": [ - "AvailabilityZone" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::Volume" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies an Amazon Elastic Block Store (Amazon EBS) volume.\n When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.\n Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.\n Some common scenarios when you might encounter a cooldown period for Amazon EBS include:\n + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.\n + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.\n \n For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html).\n *DeletionPolicy attribute* \n To control how CFNlong handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVolume", + "ec2:DescribeVolumes", + "ec2:DescribeVolumeAttribute", + "ec2:ModifyVolumeAttribute", + "ec2:CreateTags", + "kms:GenerateDataKeyWithoutPlaintext", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVolume", + "ec2:CreateSnapshot", + "ec2:DescribeSnapshots", + "ec2:DeleteTags", + "ec2:DescribeVolumes" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVolumes", + "ec2:DescribeTags", + "ec2:DescribeVolumeAttribute" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVolumes", + "ec2:DescribeVolumeAttribute", + "ec2:DescribeTags" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVolume", + "ec2:ModifyVolumeAttribute", + "ec2:DescribeVolumeAttribute", + "ec2:DescribeVolumesModifications", + "ec2:DescribeVolumes", + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/VolumeId" + ], + "properties": { + "AutoEnableIO": { + "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.", + "type": "boolean" + }, + "AvailabilityZone": { + "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.", + "type": "string" + }, + "Encrypted": { + "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*.\n Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances).", + "type": "boolean" + }, + "Iops": { + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type:\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS.\n This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.\n If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.\n Alternatively, if you want to specify a different key, you can specify one of the following:\n + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.\n + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.\n + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.\n + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.", + "type": "string" + }, + "MultiAttachEnabled": { + "description": "Indicates whether Amazon EBS Multi-Attach is enabled.\n CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.", + "type": "boolean" + }, + "OutpostArn": { + "description": "The Amazon Resource Name (ARN) of the Outpost.", + "type": "string" + }, + "Size": { + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 GiB\n + ``io1``: 4 - 16,384 GiB\n + ``io2``: 4 - 65,536 GiB\n + ``st1`` and ``sc1``: 125 - 16,384 GiB\n + ``standard``: 1 - 1024 GiB", + "type": "integer" + }, + "SnapshotId": { + "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.", + "type": "string" + }, + "Tags": { + "description": "The tags to apply to the volume during creation.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Throughput": { + "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.\n This parameter is valid only for ``gp3`` volumes. The default value is 125.\n Valid Range: Minimum value of 125. Maximum value of 1000.", + "type": "integer" + }, + "VolumeId": { + "description": "", + "type": "string" + }, + "VolumeType": { + "description": "The volume type. This parameter can be one of the following values:\n + General Purpose SSD: ``gp2`` | ``gp3`` \n + Provisioned IOPS SSD: ``io1`` | ``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n \n For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html).\n Default: ``gp2``", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VolumeId" + ], + "required": [ + "AvailabilityZone" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::Volume" +} diff --git a/schema/aws-ec2-volumeattachment.json b/schema/aws-ec2-volumeattachment.json index 4181873..997a418 100644 --- a/schema/aws-ec2-volumeattachment.json +++ b/schema/aws-ec2-volumeattachment.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Device", - "/properties/InstanceId", - "/properties/VolumeId" - ], - "definitions": { - "Device": { - "description": "The device name", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the instance to which the volume attaches", - "type": "string" - }, - "VolumeId": { - "description": "The ID of the Amazon EBS volume", - "type": "string" - } - }, - "description": "Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.\n Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.\n If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the \"running\" state. To detach the root volume, stop the instance first.\n If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.", - "handlers": { - "create": { - "permissions": [ - "ec2:AttachVolume", - "ec2:DescribeVolumes" - ] - }, - "delete": { - "permissions": [ - "ec2:DetachVolume", - "ec2:DescribeVolumes" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVolumes" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVolumes" - ] - } - }, - "primaryIdentifier": [ - "/properties/VolumeId", - "/properties/InstanceId" - ], - "properties": { - "Device": { - "$ref": "#/definitions/Device", - "description": "The device name (for example, ``/dev/sdh`` or ``xvdh``)." - }, - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance." - }, - "VolumeId": { - "$ref": "#/definitions/VolumeId", - "description": "The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume." - } - }, - "required": [ - "VolumeId", - "InstanceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VolumeAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Device", + "/properties/InstanceId", + "/properties/VolumeId" + ], + "definitions": { + "Device": { + "description": "The device name", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the instance to which the volume attaches", + "type": "string" + }, + "VolumeId": { + "description": "The ID of the Amazon EBS volume", + "type": "string" + } + }, + "description": "Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.\n Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.\n If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the \"running\" state. To detach the root volume, stop the instance first.\n If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.", + "handlers": { + "create": { + "permissions": [ + "ec2:AttachVolume", + "ec2:DescribeVolumes" + ] + }, + "delete": { + "permissions": [ + "ec2:DetachVolume", + "ec2:DescribeVolumes" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVolumes" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVolumes" + ] + } + }, + "primaryIdentifier": [ + "/properties/VolumeId", + "/properties/InstanceId" + ], + "properties": { + "Device": { + "$ref": "#/definitions/Device", + "description": "The device name (for example, ``/dev/sdh`` or ``xvdh``)." + }, + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance." + }, + "VolumeId": { + "$ref": "#/definitions/VolumeId", + "description": "The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume." + } + }, + "required": [ + "VolumeId", + "InstanceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VolumeAttachment" +} diff --git a/schema/aws-ec2-vpc.json b/schema/aws-ec2-vpc.json index 3eb8580..819cba6 100644 --- a/schema/aws-ec2-vpc.json +++ b/schema/aws-ec2-vpc.json @@ -1,159 +1,163 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/InstanceTenancy" - ], - "createOnlyProperties": [ - "/properties/CidrBlock", - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a virtual private cloud (VPC).\n You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).\n For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpc", - "ec2:DescribeVpcs", - "ec2:ModifyVpcAttribute", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpc", - "ec2:DescribeVpcs" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcs" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcs", - "ec2:DescribeSecurityGroups", - "ec2:DescribeNetworkAcls", - "ec2:DescribeVpcAttribute" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:ModifyVpcAttribute", - "ec2:DeleteTags", - "ec2:ModifyVpcTenancy" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpcId" - ], - "properties": { - "CidrBlock": { - "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", - "type": "string" - }, - "CidrBlockAssociations": { - "description": "", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "DefaultNetworkAcl": { - "description": "", - "insertionOrder": false, - "type": "string" - }, - "DefaultSecurityGroup": { - "description": "", - "insertionOrder": false, - "type": "string" - }, - "EnableDnsHostnames": { - "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\n You can only enable DNS hostnames if you've enabled DNS support.", - "type": "boolean" - }, - "EnableDnsSupport": { - "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).", - "type": "boolean" - }, - "InstanceTenancy": { - "description": "The allowed tenancy of instances launched into the VPC.\n + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.\n \n Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.", - "type": "string" - }, - "Ipv4IpamPoolId": { - "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", - "type": "string" - }, - "Ipv4NetmaskLength": { - "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.", - "type": "integer" - }, - "Ipv6CidrBlocks": { - "description": "", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "The tags for the VPC.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CidrBlockAssociations", - "/properties/DefaultNetworkAcl", - "/properties/DefaultSecurityGroup", - "/properties/Ipv6CidrBlocks", - "/properties/VpcId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VPC", - "writeOnlyProperties": [ - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/InstanceTenancy" + ], + "createOnlyProperties": [ + "/properties/CidrBlock", + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a virtual private cloud (VPC).\n To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).\n For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpc", + "ec2:DescribeVpcs", + "ec2:ModifyVpcAttribute", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpc", + "ec2:DescribeVpcs" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcs" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeNetworkAcls", + "ec2:DescribeVpcAttribute" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:ModifyVpcAttribute", + "ec2:DeleteTags", + "ec2:ModifyVpcTenancy" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpcId" + ], + "properties": { + "CidrBlock": { + "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", + "type": "string" + }, + "CidrBlockAssociations": { + "description": "", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "DefaultNetworkAcl": { + "description": "", + "insertionOrder": false, + "type": "string" + }, + "DefaultSecurityGroup": { + "description": "", + "insertionOrder": false, + "type": "string" + }, + "EnableDnsHostnames": { + "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\n You can only enable DNS hostnames if you've enabled DNS support.", + "type": "boolean" + }, + "EnableDnsSupport": { + "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).", + "type": "boolean" + }, + "InstanceTenancy": { + "description": "The allowed tenancy of instances launched into the VPC.\n + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.\n \n Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.", + "type": "string" + }, + "Ipv4IpamPoolId": { + "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", + "type": "string" + }, + "Ipv4NetmaskLength": { + "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.", + "type": "integer" + }, + "Ipv6CidrBlocks": { + "description": "", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "The tags for the VPC.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CidrBlockAssociations", + "/properties/DefaultNetworkAcl", + "/properties/DefaultSecurityGroup", + "/properties/Ipv6CidrBlocks", + "/properties/VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:DeleteTags", + "ec2:CreateTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VPC", + "writeOnlyProperties": [ + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength" + ] +} diff --git a/schema/aws-ec2-vpccidrblock.json b/schema/aws-ec2-vpccidrblock.json index ccf5c1a..389fd40 100644 --- a/schema/aws-ec2-vpccidrblock.json +++ b/schema/aws-ec2-vpccidrblock.json @@ -1,113 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Ipv6Pool", - "/properties/VpcId", - "/properties/AmazonProvidedIpv6CidrBlock", - "/properties/Ipv6CidrBlock", - "/properties/CidrBlock", - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength", - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ], - "description": "Resource Type definition for AWS::EC2::VPCCidrBlock", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateVpcCidrBlock", - "ec2:DescribeVpcs", - "ec2:AllocateIpamPoolCidr" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeVpcs", - "ec2:DisassociateVpcCidrBlock" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "required": [ - "VpcId" - ] - }, - "permissions": [ - "ec2:DescribeVpcs" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcs" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/VpcId" - ], - "properties": { - "AmazonProvidedIpv6CidrBlock": { - "description": "Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.", - "type": "boolean" - }, - "CidrBlock": { - "description": "An IPv4 CIDR block to associate with the VPC.", - "type": "string" - }, - "Id": { - "description": "The Id of the VPC associated CIDR Block.", - "type": "string" - }, - "Ipv4IpamPoolId": { - "description": "The ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.", - "type": "string" - }, - "Ipv4NetmaskLength": { - "description": "The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.", - "type": "integer" - }, - "Ipv6CidrBlock": { - "description": "An IPv6 CIDR block from the IPv6 address pool.", - "type": "string" - }, - "Ipv6IpamPoolId": { - "description": "The ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.", - "type": "string" - }, - "Ipv6NetmaskLength": { - "description": "The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.", - "type": "integer" - }, - "Ipv6Pool": { - "description": "The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.", - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "VpcId" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::VPCCidrBlock", - "writeOnlyProperties": [ - "/properties/Ipv4IpamPoolId", - "/properties/Ipv4NetmaskLength", - "/properties/Ipv6IpamPoolId", - "/properties/Ipv6NetmaskLength" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Ipv6Pool", + "/properties/VpcId", + "/properties/AmazonProvidedIpv6CidrBlock", + "/properties/Ipv6CidrBlock", + "/properties/CidrBlock", + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength", + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ], + "description": "Resource Type definition for AWS::EC2::VPCCidrBlock", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateVpcCidrBlock", + "ec2:DescribeVpcs", + "ec2:AllocateIpamPoolCidr" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeVpcs", + "ec2:DisassociateVpcCidrBlock" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "required": [ + "VpcId" + ] + }, + "permissions": [ + "ec2:DescribeVpcs" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcs" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/VpcId" + ], + "properties": { + "AmazonProvidedIpv6CidrBlock": { + "description": "Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.", + "type": "boolean" + }, + "CidrBlock": { + "description": "An IPv4 CIDR block to associate with the VPC.", + "type": "string" + }, + "Id": { + "description": "The Id of the VPC associated CIDR Block.", + "type": "string" + }, + "IpSource": { + "description": "The IP Source of an IPv6 VPC CIDR Block.", + "type": "string" + }, + "Ipv4IpamPoolId": { + "description": "The ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.", + "type": "string" + }, + "Ipv4NetmaskLength": { + "description": "The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.", + "type": "integer" + }, + "Ipv6AddressAttribute": { + "description": "The value denoting whether an IPv6 VPC CIDR Block is public or private.", + "type": "string" + }, + "Ipv6CidrBlock": { + "description": "An IPv6 CIDR block from the IPv6 address pool.", + "type": "string" + }, + "Ipv6IpamPoolId": { + "description": "The ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.", + "type": "string" + }, + "Ipv6NetmaskLength": { + "description": "The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.", + "type": "integer" + }, + "Ipv6Pool": { + "description": "The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.", + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Ipv6AddressAttribute", + "/properties/IpSource" + ], + "required": [ + "VpcId" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::VPCCidrBlock", + "writeOnlyProperties": [ + "/properties/Ipv4IpamPoolId", + "/properties/Ipv4NetmaskLength", + "/properties/Ipv6IpamPoolId", + "/properties/Ipv6NetmaskLength" + ] +} diff --git a/schema/aws-ec2-vpcdhcpoptionsassociation.json b/schema/aws-ec2-vpcdhcpoptionsassociation.json index c67314f..e3c0f02 100644 --- a/schema/aws-ec2-vpcdhcpoptionsassociation.json +++ b/schema/aws-ec2-vpcdhcpoptionsassociation.json @@ -1,62 +1,62 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DhcpOptionsId", - "/properties/VpcId" - ], - "description": "Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.", - "handlers": { - "create": { - "permissions": [ - "ec2:AssociateDhcpOptions" - ] - }, - "delete": { - "permissions": [ - "ec2:AssociateDhcpOptions" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcs" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcs" - ] - }, - "update": { - "permissions": [ - "ec2:AssociateDhcpOptions" - ] - } - }, - "primaryIdentifier": [ - "/properties/DhcpOptionsId", - "/properties/VpcId" - ], - "properties": { - "DhcpOptionsId": { - "description": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC.", - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "VpcId", - "DhcpOptionsId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCDHCPOptionsAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DhcpOptionsId", + "/properties/VpcId" + ], + "description": "Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.", + "handlers": { + "create": { + "permissions": [ + "ec2:AssociateDhcpOptions" + ] + }, + "delete": { + "permissions": [ + "ec2:AssociateDhcpOptions" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcs" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcs" + ] + }, + "update": { + "permissions": [ + "ec2:AssociateDhcpOptions" + ] + } + }, + "primaryIdentifier": [ + "/properties/DhcpOptionsId", + "/properties/VpcId" + ], + "properties": { + "DhcpOptionsId": { + "description": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC.", + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "VpcId", + "DhcpOptionsId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCDHCPOptionsAssociation" +} diff --git a/schema/aws-ec2-vpcendpoint.json b/schema/aws-ec2-vpcendpoint.json index 2108874..ab53a06 100644 --- a/schema/aws-ec2-vpcendpoint.json +++ b/schema/aws-ec2-vpcendpoint.json @@ -1,145 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceName", - "/properties/VpcEndpointType", - "/properties/VpcId" - ], - "description": "Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).\n An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.\n An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints" - ], - "timeoutInMinutes": 210 - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpoints", - "ec2:DescribeVpcEndpoints" - ], - "timeoutInMinutes": 210 - }, - "list": { - "permissions": [ - "ec2:DescribeVpcEndpoints" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcEndpoints" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVpcEndpoint", - "ec2:DescribeVpcEndpoints" - ], - "timeoutInMinutes": 210 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CreationTimestamp": { - "description": "", - "type": "string" - }, - "DnsEntries": { - "description": "", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "description": "", - "type": "string" - }, - "NetworkInterfaceIds": { - "description": "", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PolicyDocument": { - "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.\n For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.", - "type": [ - "string", - "object" - ] - }, - "PrivateDnsEnabled": { - "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.\n To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.\n This property is supported only for interface endpoints.\n Default: ``false``", - "type": "boolean" - }, - "RouteTableIds": { - "description": "The IDs of the route tables. Routing is supported only for gateway endpoints.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SecurityGroupIds": { - "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ServiceName": { - "description": "The name of the endpoint service.", - "type": "string" - }, - "SubnetIds": { - "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "VpcEndpointType": { - "description": "The type of endpoint.\n Default: Gateway", - "enum": [ - "Interface", - "Gateway", - "GatewayLoadBalancer" - ], - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NetworkInterfaceIds", - "/properties/CreationTimestamp", - "/properties/DnsEntries", - "/properties/Id" - ], - "required": [ - "VpcId", - "ServiceName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceName", + "/properties/VpcEndpointType", + "/properties/VpcId" + ], + "description": "Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).\n An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.\n An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint) \n An endpoint of type ``GatewayLoadBalancer`` provides private connectivity between your VPC and virtual appliances from a service provider.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints" + ], + "timeoutInMinutes": 210 + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints" + ], + "timeoutInMinutes": 210 + }, + "list": { + "permissions": [ + "ec2:DescribeVpcEndpoints" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcEndpoints" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVpcEndpoint", + "ec2:DescribeVpcEndpoints" + ], + "timeoutInMinutes": 210 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CreationTimestamp": { + "description": "", + "type": "string" + }, + "DnsEntries": { + "description": "", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "description": "", + "type": "string" + }, + "NetworkInterfaceIds": { + "description": "", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PolicyDocument": { + "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.\n For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.", + "type": [ + "string", + "object" + ] + }, + "PrivateDnsEnabled": { + "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.\n To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.\n This property is supported only for interface endpoints.\n Default: ``false``", + "type": "boolean" + }, + "RouteTableIds": { + "description": "The IDs of the route tables. Routing is supported only for gateway endpoints.", + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/RouteTableId", + "typeName": "AWS::EC2::RouteTable" + }, + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SecurityGroupIds": { + "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.", + "insertionOrder": false, + "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/GroupId", + "typeName": "AWS::EC2::SecurityGroup" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/DefaultSecurityGroup", + "typeName": "AWS::EC2::VPC" + } + } + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ServiceName": { + "description": "The name of the endpoint service.", + "type": "string" + }, + "SubnetIds": { + "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.", + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "VpcEndpointType": { + "description": "The type of endpoint.\n Default: Gateway", + "enum": [ + "Interface", + "Gateway", + "GatewayLoadBalancer" + ], + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NetworkInterfaceIds", + "/properties/CreationTimestamp", + "/properties/DnsEntries", + "/properties/Id" + ], + "required": [ + "VpcId", + "ServiceName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCEndpoint" +} diff --git a/schema/aws-ec2-vpcendpointconnectionnotification.json b/schema/aws-ec2-vpcendpointconnectionnotification.json index 9a0aa0c..8edbac5 100644 --- a/schema/aws-ec2-vpcendpointconnectionnotification.json +++ b/schema/aws-ec2-vpcendpointconnectionnotification.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceId", - "/properties/VPCEndpointId" - ], - "description": "Resource Type definition for AWS::EC2::VPCEndpointConnectionNotification", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpointConnectionNotification" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpointConnectionNotifications" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcEndpointConnectionNotifications" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcEndpointConnectionNotifications" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVpcEndpointConnectionNotification", - "ec2:DescribeVpcEndpointConnectionNotifications" - ] - } - }, - "primaryIdentifier": [ - "/properties/VPCEndpointConnectionNotificationId" - ], - "properties": { - "ConnectionEvents": { - "description": "The endpoint events for which to receive notifications.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ConnectionNotificationArn": { - "description": "The ARN of the SNS topic for the notifications.", - "type": "string" - }, - "ServiceId": { - "description": "The ID of the endpoint service.", - "type": "string" - }, - "VPCEndpointConnectionNotificationId": { - "description": "VPC Endpoint Connection ID generated by service", - "type": "string" - }, - "VPCEndpointId": { - "description": "The ID of the endpoint.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VPCEndpointConnectionNotificationId" - ], - "required": [ - "ConnectionEvents", - "ConnectionNotificationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-vpc-endpoint", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCEndpointConnectionNotification" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceId", + "/properties/VPCEndpointId" + ], + "description": "Resource Type definition for AWS::EC2::VPCEndpointConnectionNotification", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpointConnectionNotification" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpointConnectionNotifications" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcEndpointConnectionNotifications" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcEndpointConnectionNotifications" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVpcEndpointConnectionNotification", + "ec2:DescribeVpcEndpointConnectionNotifications" + ] + } + }, + "primaryIdentifier": [ + "/properties/VPCEndpointConnectionNotificationId" + ], + "properties": { + "ConnectionEvents": { + "description": "The endpoint events for which to receive notifications.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ConnectionNotificationArn": { + "description": "The ARN of the SNS topic for the notifications.", + "type": "string" + }, + "ServiceId": { + "description": "The ID of the endpoint service.", + "type": "string" + }, + "VPCEndpointConnectionNotificationId": { + "description": "VPC Endpoint Connection ID generated by service", + "type": "string" + }, + "VPCEndpointId": { + "description": "The ID of the endpoint.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VPCEndpointConnectionNotificationId" + ], + "required": [ + "ConnectionEvents", + "ConnectionNotificationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-vpc-endpoint", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCEndpointConnectionNotification" +} diff --git a/schema/aws-ec2-vpcendpointservice.json b/schema/aws-ec2-vpcendpointservice.json index 2ec96d5..cbdb524 100644 --- a/schema/aws-ec2-vpcendpointservice.json +++ b/schema/aws-ec2-vpcendpointservice.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::EC2::VPCEndpointService", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:ModifyVpcEndpointServiceConfiguration", - "ec2:ModifyVpcEndpointServicePayerResponsibility", - "cloudwatch:ListManagedInsightRules", - "cloudwatch:DeleteInsightRules", - "cloudwatch:PutManagedInsightRules", - "ec2:DescribeVpcEndpointServiceConfigurations" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "cloudwatch:ListManagedInsightRules", - "cloudwatch:DeleteInsightRules" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcEndpointServiceConfigurations", - "cloudwatch:ListManagedInsightRules" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcEndpointServiceConfigurations", - "cloudwatch:ListManagedInsightRules" - ] - }, - "update": { - "permissions": [ - "ec2:ModifyVpcEndpointServiceConfiguration", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePayerResponsibility", - "cloudwatch:ListManagedInsightRules", - "cloudwatch:DeleteInsightRules", - "cloudwatch:PutManagedInsightRules" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServiceId" - ], - "properties": { - "AcceptanceRequired": { - "type": "boolean" - }, - "ContributorInsightsEnabled": { - "type": "boolean" - }, - "GatewayLoadBalancerArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkLoadBalancerArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PayerResponsibility": { - "type": "string" - }, - "ServiceId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ServiceId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCEndpointService", - "writeOnlyProperties": [ - "/properties/ContributorInsightsEnabled" - ] -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::EC2::VPCEndpointService", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:ModifyVpcEndpointServiceConfiguration", + "ec2:ModifyVpcEndpointServicePayerResponsibility", + "cloudwatch:ListManagedInsightRules", + "cloudwatch:DeleteInsightRules", + "cloudwatch:PutManagedInsightRules", + "ec2:DescribeVpcEndpointServiceConfigurations" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "cloudwatch:ListManagedInsightRules", + "cloudwatch:DeleteInsightRules" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcEndpointServiceConfigurations", + "cloudwatch:ListManagedInsightRules" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcEndpointServiceConfigurations", + "cloudwatch:ListManagedInsightRules" + ] + }, + "update": { + "permissions": [ + "ec2:ModifyVpcEndpointServiceConfiguration", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePayerResponsibility", + "cloudwatch:ListManagedInsightRules", + "cloudwatch:DeleteInsightRules", + "cloudwatch:PutManagedInsightRules" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServiceId" + ], + "properties": { + "AcceptanceRequired": { + "type": "boolean" + }, + "ContributorInsightsEnabled": { + "type": "boolean" + }, + "GatewayLoadBalancerArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "NetworkLoadBalancerArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PayerResponsibility": { + "type": "string" + }, + "ServiceId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ServiceId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCEndpointService", + "writeOnlyProperties": [ + "/properties/ContributorInsightsEnabled" + ] +} diff --git a/schema/aws-ec2-vpcendpointservicepermissions.json b/schema/aws-ec2-vpcendpointservicepermissions.json index a0da250..d3e3d5d 100644 --- a/schema/aws-ec2-vpcendpointservicepermissions.json +++ b/schema/aws-ec2-vpcendpointservicepermissions.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceId" - ], - "description": "Resource Type definition for AWS::EC2::VPCEndpointServicePermissions", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpointServicePermissions", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:DeleteVpcEndpointServicePermissions", - "ec2:DescribeVpcEndpointServicePermissions" - ] - }, - "delete": { - "permissions": [ - "ec2:CreateVpcEndpointServicePermissions", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:DeleteVpcEndpointServicePermissions", - "ec2:DescribeVpcEndpointServicePermissions" - ] - }, - "list": { - "permissions": [ - "ec2:CreateVpcEndpointServicePermissions", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:DeleteVpcEndpointServicePermissions", - "ec2:DescribeVpcEndpointServicePermissions" - ] - }, - "read": { - "permissions": [ - "ec2:CreateVpcEndpointServicePermissions", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:DeleteVpcEndpointServicePermissions", - "ec2:DescribeVpcEndpointServicePermissions" - ] - }, - "update": { - "permissions": [ - "ec2:CreateVpcEndpointServicePermissions", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:DeleteVpcEndpointServicePermissions", - "ec2:DescribeVpcEndpointServicePermissions" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServiceId" - ], - "properties": { - "AllowedPrincipals": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ServiceId": { - "type": "string" - } - }, - "required": [ - "ServiceId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCEndpointServicePermissions" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceId" + ], + "description": "Resource Type definition for AWS::EC2::VPCEndpointServicePermissions", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpointServicePermissions", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:DeleteVpcEndpointServicePermissions", + "ec2:DescribeVpcEndpointServicePermissions" + ] + }, + "delete": { + "permissions": [ + "ec2:CreateVpcEndpointServicePermissions", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:DeleteVpcEndpointServicePermissions", + "ec2:DescribeVpcEndpointServicePermissions" + ] + }, + "list": { + "permissions": [ + "ec2:CreateVpcEndpointServicePermissions", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:DeleteVpcEndpointServicePermissions", + "ec2:DescribeVpcEndpointServicePermissions" + ] + }, + "read": { + "permissions": [ + "ec2:CreateVpcEndpointServicePermissions", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:DeleteVpcEndpointServicePermissions", + "ec2:DescribeVpcEndpointServicePermissions" + ] + }, + "update": { + "permissions": [ + "ec2:CreateVpcEndpointServicePermissions", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:DeleteVpcEndpointServicePermissions", + "ec2:DescribeVpcEndpointServicePermissions" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServiceId" + ], + "properties": { + "AllowedPrincipals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ServiceId": { + "type": "string" + } + }, + "required": [ + "ServiceId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCEndpointServicePermissions" +} diff --git a/schema/aws-ec2-vpcgatewayattachment.json b/schema/aws-ec2-vpcgatewayattachment.json index db1dca9..45cc06e 100644 --- a/schema/aws-ec2-vpcgatewayattachment.json +++ b/schema/aws-ec2-vpcgatewayattachment.json @@ -1,84 +1,84 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId" - ], - "description": "Resource Type definition for AWS::EC2::VPCGatewayAttachment", - "handlers": { - "create": { - "permissions": [ - "ec2:AttachInternetGateway", - "ec2:AttachVpnGateway", - "ec2:DescribeInternetGateways", - "ec2:DescribeVpnGateways" - ] - }, - "delete": { - "permissions": [ - "ec2:DetachInternetGateway", - "ec2:DetachVpnGateway", - "ec2:DescribeInternetGateways", - "ec2:DescribeVpnGateways" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeInternetGateways", - "ec2:DescribeVpnGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeInternetGateways", - "ec2:DescribeVpnGateways" - ] - }, - "update": { - "permissions": [ - "ec2:AttachInternetGateway", - "ec2:AttachVpnGateway", - "ec2:DetachInternetGateway", - "ec2:DetachVpnGateway", - "ec2:DescribeInternetGateways", - "ec2:DescribeVpnGateways" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentType", - "/properties/VpcId" - ], - "properties": { - "AttachmentType": { - "description": "Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment ", - "type": "string" - }, - "InternetGatewayId": { - "description": "The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.", - "type": "string" - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - }, - "VpnGatewayId": { - "description": "The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AttachmentType" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-vpc-gateway-attachment.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EC2::VPCGatewayAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId" + ], + "description": "Resource Type definition for AWS::EC2::VPCGatewayAttachment", + "handlers": { + "create": { + "permissions": [ + "ec2:AttachInternetGateway", + "ec2:AttachVpnGateway", + "ec2:DescribeInternetGateways", + "ec2:DescribeVpnGateways" + ] + }, + "delete": { + "permissions": [ + "ec2:DetachInternetGateway", + "ec2:DetachVpnGateway", + "ec2:DescribeInternetGateways", + "ec2:DescribeVpnGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeInternetGateways", + "ec2:DescribeVpnGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeInternetGateways", + "ec2:DescribeVpnGateways" + ] + }, + "update": { + "permissions": [ + "ec2:AttachInternetGateway", + "ec2:AttachVpnGateway", + "ec2:DetachInternetGateway", + "ec2:DetachVpnGateway", + "ec2:DescribeInternetGateways", + "ec2:DescribeVpnGateways" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentType", + "/properties/VpcId" + ], + "properties": { + "AttachmentType": { + "description": "Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment ", + "type": "string" + }, + "InternetGatewayId": { + "description": "The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.", + "type": "string" + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + }, + "VpnGatewayId": { + "description": "The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AttachmentType" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-vpc-gateway-attachment.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPCGatewayAttachment" +} diff --git a/schema/aws-ec2-vpcpeeringconnection.json b/schema/aws-ec2-vpcpeeringconnection.json index e6256dc..80113eb 100644 --- a/schema/aws-ec2-vpcpeeringconnection.json +++ b/schema/aws-ec2-vpcpeeringconnection.json @@ -1,121 +1,125 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PeerRegion", - "/properties/PeerOwnerId", - "/properties/PeerVpcId", - "/properties/PeerRoleArn", - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::VPCPeeringConnection", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcPeeringConnection", - "ec2:DescribeVpcPeeringConnections", - "ec2:AcceptVpcPeeringConnection", - "ec2:CreateTags", - "sts:AssumeRole" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcPeeringConnection", - "ec2:DescribeVpcPeeringConnections" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcPeeringConnections" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcPeeringConnections" - ] - }, - "update": { - "permissions": [ - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeVpcPeeringConnections" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "PeerOwnerId": { - "description": "The AWS account ID of the owner of the accepter VPC.", - "type": "string" - }, - "PeerRegion": { - "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.", - "type": "string" - }, - "PeerRoleArn": { - "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.", - "type": "string" - }, - "PeerVpcId": { - "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcId": { - "description": "The ID of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "VpcId", - "PeerVpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-ec2-vpcpeering.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VPCPeeringConnection", - "writeOnlyProperties": [ - "/properties/PeerRoleArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PeerRegion", + "/properties/PeerOwnerId", + "/properties/PeerVpcId", + "/properties/PeerRoleArn", + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EC2::VPCPeeringConnection", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcPeeringConnection", + "ec2:DescribeVpcPeeringConnections", + "ec2:AcceptVpcPeeringConnection", + "ec2:CreateTags", + "sts:AssumeRole" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcPeeringConnection", + "ec2:DescribeVpcPeeringConnections" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcPeeringConnections" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcPeeringConnections" + ] + }, + "update": { + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeVpcPeeringConnections" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "PeerOwnerId": { + "description": "The AWS account ID of the owner of the accepter VPC.", + "type": "string" + }, + "PeerRegion": { + "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.", + "type": "string" + }, + "PeerRoleArn": { + "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.", + "type": "string" + }, + "PeerVpcId": { + "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "VpcId", + "PeerVpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-ec2-vpcpeering.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VPCPeeringConnection", + "writeOnlyProperties": [ + "/properties/PeerRoleArn" + ] +} diff --git a/schema/aws-ec2-vpnconnection.json b/schema/aws-ec2-vpnconnection.json index da27fe8..d8e8942 100644 --- a/schema/aws-ec2-vpnconnection.json +++ b/schema/aws-ec2-vpnconnection.json @@ -1,138 +1,187 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/CustomerGatewayId", - "/properties/VpnGatewayId", - "/properties/TransitGatewayId", - "/properties/VpnTunnelOptionsSpecifications", - "/properties/StaticRoutesOnly" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpnTunnelOptionsSpecification": { - "additionalProperties": false, - "properties": { - "PreSharedKey": { - "type": "string" - }, - "TunnelInsideCidr": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EC2::VPNConnection", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeVpnConnections", - "ec2:CreateVpnConnection", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeVpnConnections", - "ec2:DeleteVpnConnection", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpnConnections" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpnConnections" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeVpnConnections", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/VpnConnectionId" - ], - "properties": { - "CustomerGatewayId": { - "description": "The ID of the customer gateway at your end of the VPN connection.", - "type": "string" - }, - "StaticRoutesOnly": { - "description": "Indicates whether the VPN connection uses static routes only.", - "type": "boolean" - }, - "Tags": { - "description": "Any tags assigned to the VPN connection.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitGatewayId": { - "description": "The ID of the transit gateway associated with the VPN connection.", - "type": "string" - }, - "Type": { - "description": "The type of VPN connection.", - "type": "string" - }, - "VpnConnectionId": { - "description": "The provider-assigned unique ID for this managed resource", - "type": "string" - }, - "VpnGatewayId": { - "description": "The ID of the virtual private gateway at the AWS side of the VPN connection.", - "type": "string" - }, - "VpnTunnelOptionsSpecifications": { - "description": "The tunnel options for the VPN connection.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpnTunnelOptionsSpecification" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/VpnConnectionId" - ], - "required": [ - "Type", - "CustomerGatewayId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VPNConnection" -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/CustomerGatewayId", + "/properties/VpnGatewayId", + "/properties/TransitGatewayId", + "/properties/EnableAcceleration", + "/properties/LocalIpv4NetworkCidr", + "/properties/LocalIpv6NetworkCidr", + "/properties/OutsideIpAddressType", + "/properties/RemoteIpv4NetworkCidr", + "/properties/RemoteIpv6NetworkCidr", + "/properties/StaticRoutesOnly", + "/properties/TransportTransitGatewayAttachmentId", + "/properties/TunnelInsideIpVersion", + "/properties/VpnTunnelOptionsSpecifications" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpnTunnelOptionsSpecification": { + "additionalProperties": false, + "description": "The tunnel options for a single VPN tunnel.", + "properties": { + "PreSharedKey": { + "description": "The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.\n Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).", + "type": "string" + }, + "TunnelInsideCidr": { + "description": "The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. \n Constraints: A size /30 CIDR block from the ``169.254.0.0/16`` range. The following CIDR blocks are reserved and cannot be used:\n + ``169.254.0.0/30`` \n + ``169.254.1.0/30`` \n + ``169.254.2.0/30`` \n + ``169.254.3.0/30`` \n + ``169.254.4.0/30`` \n + ``169.254.5.0/30`` \n + ``169.254.169.252/30``", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.\n To specify a VPN connection between a transit gateway and customer gateway, use the ``TransitGatewayId`` and ``CustomerGatewayId`` properties.\n To specify a VPN connection between a virtual private gateway and customer gateway, use the ``VpnGatewayId`` and ``CustomerGatewayId`` properties.\n For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeVpnConnections", + "ec2:CreateVpnConnection", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeVpnConnections", + "ec2:DeleteVpnConnection" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpnConnections" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpnConnections" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeVpnConnections", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/VpnConnectionId" + ], + "properties": { + "CustomerGatewayId": { + "description": "The ID of the customer gateway at your end of the VPN connection.", + "type": "string" + }, + "EnableAcceleration": { + "description": "Indicate whether to enable acceleration for the VPN connection.\n Default: ``false``", + "type": "boolean" + }, + "LocalIpv4NetworkCidr": { + "description": "", + "type": "string" + }, + "LocalIpv6NetworkCidr": { + "description": "", + "type": "string" + }, + "OutsideIpAddressType": { + "description": "", + "type": "string" + }, + "RemoteIpv4NetworkCidr": { + "description": "", + "type": "string" + }, + "RemoteIpv6NetworkCidr": { + "description": "", + "type": "string" + }, + "StaticRoutesOnly": { + "description": "Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.\n If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify ``true``.", + "type": "boolean" + }, + "Tags": { + "description": "Any tags assigned to the VPN connection.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitGatewayId": { + "description": "The ID of the transit gateway associated with the VPN connection.\n You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both.", + "type": "string" + }, + "TransportTransitGatewayAttachmentId": { + "description": "", + "type": "string" + }, + "TunnelInsideIpVersion": { + "description": "", + "type": "string" + }, + "Type": { + "description": "The type of VPN connection.", + "type": "string" + }, + "VpnConnectionId": { + "description": "", + "type": "string" + }, + "VpnGatewayId": { + "description": "The ID of the virtual private gateway at the AWS side of the VPN connection.\n You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both.", + "type": "string" + }, + "VpnTunnelOptionsSpecifications": { + "description": "The tunnel options for the VPN connection.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpnTunnelOptionsSpecification" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/VpnConnectionId" + ], + "required": [ + "Type", + "CustomerGatewayId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VPNConnection" +} diff --git a/schema/aws-ec2-vpnconnectionroute.json b/schema/aws-ec2-vpnconnectionroute.json index 08f3437..ac3cc52 100644 --- a/schema/aws-ec2-vpnconnectionroute.json +++ b/schema/aws-ec2-vpnconnectionroute.json @@ -1,55 +1,55 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DestinationCidrBlock", - "/properties/VpnConnectionId" - ], - "description": "Resource Type definition for AWS::EC2::VPNConnectionRoute", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpnConnectionRoute", - "ec2:DescribeVpnConnections" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpnConnectionRoute", - "ec2:DescribeVpnConnections" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpnConnections" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpnConnections" - ] - } - }, - "primaryIdentifier": [ - "/properties/DestinationCidrBlock", - "/properties/VpnConnectionId" - ], - "properties": { - "DestinationCidrBlock": { - "description": "The CIDR block associated with the local subnet of the customer network.", - "type": "string" - }, - "VpnConnectionId": { - "description": "The ID of the VPN connection.", - "type": "string" - } - }, - "required": [ - "DestinationCidrBlock", - "VpnConnectionId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EC2::VPNConnectionRoute" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DestinationCidrBlock", + "/properties/VpnConnectionId" + ], + "description": "Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.\n For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpnConnectionRoute", + "ec2:DescribeVpnConnections" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpnConnectionRoute", + "ec2:DescribeVpnConnections" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpnConnections" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpnConnections" + ] + } + }, + "primaryIdentifier": [ + "/properties/DestinationCidrBlock", + "/properties/VpnConnectionId" + ], + "properties": { + "DestinationCidrBlock": { + "description": "The CIDR block associated with the local subnet of the customer network.", + "type": "string" + }, + "VpnConnectionId": { + "description": "The ID of the VPN connection.", + "type": "string" + } + }, + "required": [ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EC2::VPNConnectionRoute" +} diff --git a/schema/aws-ec2-vpngateway.json b/schema/aws-ec2-vpngateway.json index 170206f..bbb9e49 100644 --- a/schema/aws-ec2-vpngateway.json +++ b/schema/aws-ec2-vpngateway.json @@ -1,104 +1,107 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AmazonSideAsn", - "/properties/Type" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.\n For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpnGateway", - "ec2:DescribeVpnGateways", - "ec2:CreateTags" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpnGateway", - "ec2:DescribeVpnGateways", - "ec2:DeleteTags" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpnGateways" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpnGateways" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeVpnGateways", - "ec2:CreateTags", - "ec2:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/VPNGatewayId" - ], - "properties": { - "AmazonSideAsn": { - "description": "The private Autonomous System Number (ASN) for the Amazon side of a BGP session.", - "format": "int64", - "type": "integer" - }, - "Tags": { - "description": "Any tags assigned to the virtual private gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of VPN connection the virtual private gateway supports.", - "type": "string" - }, - "VPNGatewayId": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VPNGatewayId" - ], - "required": [ - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EC2::VPNGateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AmazonSideAsn", + "/properties/Type" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.\n For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpnGateway", + "ec2:DescribeVpnGateways", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpnGateway", + "ec2:DescribeVpnGateways" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpnGateways" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpnGateways" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeVpnGateways", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/VPNGatewayId" + ], + "properties": { + "AmazonSideAsn": { + "description": "The private Autonomous System Number (ASN) for the Amazon side of a BGP session.", + "format": "int64", + "type": "integer" + }, + "Tags": { + "description": "Any tags assigned to the virtual private gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of VPN connection the virtual private gateway supports.", + "type": "string" + }, + "VPNGatewayId": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VPNGatewayId" + ], + "required": [ + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ec2:CreateTags", + "ec2:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::VPNGateway" +} diff --git a/schema/aws-ec2-vpngatewayroutepropagation.json b/schema/aws-ec2-vpngatewayroutepropagation.json index 1eff207..3ca806b 100644 --- a/schema/aws-ec2-vpngatewayroutepropagation.json +++ b/schema/aws-ec2-vpngatewayroutepropagation.json @@ -1,30 +1,60 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::EC2::VPNGatewayRoutePropagation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "RouteTableIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VpnGatewayId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RouteTableIds", - "VpnGatewayId" - ], - "typeName": "AWS::EC2::VPNGatewayRoutePropagation" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::EC2::VPNGatewayRoutePropagation", + "handlers": { + "create": { + "permissions": [ + "ec2:EnableVgwRoutePropagation", + "ec2:DescribeRouteTables" + ] + }, + "delete": { + "permissions": [ + "ec2:DisableVgwRoutePropagation", + "ec2:DescribeRouteTables" + ] + }, + "update": { + "permissions": [ + "ec2:EnableVgwRoutePropagation", + "ec2:DescribeRouteTables" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "RouteTableIds": { + "description": "The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VpnGatewayId": { + "description": "The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RouteTableIds", + "VpnGatewayId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::VPNGatewayRoutePropagation" +} diff --git a/schema/aws-ecr-publicrepository.json b/schema/aws-ecr-publicrepository.json index ef8f441..c3f3519 100644 --- a/schema/aws-ecr-publicrepository.json +++ b/schema/aws-ecr-publicrepository.json @@ -1,182 +1,182 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RepositoryName" - ], - "definitions": { - "AboutText": { - "description": "Provide a detailed description of the repository. Identify what is included in the repository, any licensing details, or other relevant information.", - "maxLength": 10240, - "type": "string" - }, - "Architecture": { - "description": "The name of the architecture.", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ArchitectureList": { - "description": "Select the system architectures that the images in your repository are compatible with.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Architecture" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "OperatingSystem": { - "description": "The name of the operating system.", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "OperatingSystemList": { - "description": "Select the operating systems that the images in your repository are compatible with.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OperatingSystem" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "RegistryId": { - "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. ", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "RepositoryDescription": { - "description": "The description of the public repository.", - "maxLength": 1024, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "UsageText": { - "description": "Provide detailed information about how to use the images in the repository. This provides context, support information, and additional usage details for users of the repository.", - "maxLength": 10240, - "type": "string" - } - }, - "description": "The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR", - "handlers": { - "create": { - "permissions": [ - "ecr-public:CreateRepository", - "ecr-public:SetRepositoryPolicy", - "ecr-public:PutRepositoryCatalogData", - "ecr-public:TagResource" - ] - }, - "delete": { - "permissions": [ - "ecr-public:DeleteRepository" - ] - }, - "list": { - "permissions": [ - "ecr-public:DescribeRepositories" - ] - }, - "read": { - "permissions": [ - "ecr-public:DescribeRepositories", - "ecr-public:GetRepositoryPolicy", - "ecr-public:GetRepositoryCatalogData", - "ecr-public:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ecr-public:SetRepositoryPolicy", - "ecr-public:DeleteRepositoryPolicy", - "ecr-public:PutRepositoryCatalogData", - "ecr-public:TagResource", - "ecr-public:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RepositoryName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "RepositoryCatalogData": { - "additionalProperties": false, - "description": "The CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see ", - "properties": { - "AboutText": { - "$ref": "#/definitions/AboutText" - }, - "Architectures": { - "$ref": "#/definitions/ArchitectureList" - }, - "OperatingSystems": { - "$ref": "#/definitions/OperatingSystemList" - }, - "RepositoryDescription": { - "$ref": "#/definitions/RepositoryDescription" - }, - "UsageText": { - "$ref": "#/definitions/UsageText" - } - }, - "type": "object" - }, - "RepositoryName": { - "description": "The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.", - "maxLength": 256, - "minLength": 2, - "pattern": "^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$", - "type": "string" - }, - "RepositoryPolicyText": { - "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. ", - "type": [ - "object", - "string" - ] - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "typeName": "AWS::ECR::PublicRepository" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RepositoryName" + ], + "definitions": { + "AboutText": { + "description": "Provide a detailed description of the repository. Identify what is included in the repository, any licensing details, or other relevant information.", + "maxLength": 10240, + "type": "string" + }, + "Architecture": { + "description": "The name of the architecture.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ArchitectureList": { + "description": "Select the system architectures that the images in your repository are compatible with.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Architecture" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "OperatingSystem": { + "description": "The name of the operating system.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "OperatingSystemList": { + "description": "Select the operating systems that the images in your repository are compatible with.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OperatingSystem" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "RegistryId": { + "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. ", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "RepositoryDescription": { + "description": "The description of the public repository.", + "maxLength": 1024, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "UsageText": { + "description": "Provide detailed information about how to use the images in the repository. This provides context, support information, and additional usage details for users of the repository.", + "maxLength": 10240, + "type": "string" + } + }, + "description": "The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR", + "handlers": { + "create": { + "permissions": [ + "ecr-public:CreateRepository", + "ecr-public:SetRepositoryPolicy", + "ecr-public:PutRepositoryCatalogData", + "ecr-public:TagResource" + ] + }, + "delete": { + "permissions": [ + "ecr-public:DeleteRepository" + ] + }, + "list": { + "permissions": [ + "ecr-public:DescribeRepositories" + ] + }, + "read": { + "permissions": [ + "ecr-public:DescribeRepositories", + "ecr-public:GetRepositoryPolicy", + "ecr-public:GetRepositoryCatalogData", + "ecr-public:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ecr-public:SetRepositoryPolicy", + "ecr-public:DeleteRepositoryPolicy", + "ecr-public:PutRepositoryCatalogData", + "ecr-public:TagResource", + "ecr-public:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RepositoryName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "RepositoryCatalogData": { + "additionalProperties": false, + "description": "The CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see ", + "properties": { + "AboutText": { + "$ref": "#/definitions/AboutText" + }, + "Architectures": { + "$ref": "#/definitions/ArchitectureList" + }, + "OperatingSystems": { + "$ref": "#/definitions/OperatingSystemList" + }, + "RepositoryDescription": { + "$ref": "#/definitions/RepositoryDescription" + }, + "UsageText": { + "$ref": "#/definitions/UsageText" + } + }, + "type": "object" + }, + "RepositoryName": { + "description": "The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.", + "maxLength": 256, + "minLength": 2, + "pattern": "^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$", + "type": "string" + }, + "RepositoryPolicyText": { + "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. ", + "type": [ + "object", + "string" + ] + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "typeName": "AWS::ECR::PublicRepository" +} diff --git a/schema/aws-ecr-pullthroughcacherule.json b/schema/aws-ecr-pullthroughcacherule.json index 06730e2..b4a1748 100644 --- a/schema/aws-ecr-pullthroughcacherule.json +++ b/schema/aws-ecr-pullthroughcacherule.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EcrRepositoryPrefix", - "/properties/UpstreamRegistryUrl", - "/properties/CredentialArn", - "/properties/UpstreamRegistry" - ], - "definitions": { - "CredentialArn": { - "description": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.", - "maxLength": 612, - "minLength": 50, - "pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$", - "type": "string" - }, - "EcrRepositoryPrefix": { - "description": "The ECRRepositoryPrefix is a custom alias for upstream registry url.", - "maxLength": 30, - "minLength": 2, - "pattern": "(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*", - "type": "string" - }, - "PullThroughCacheRule": { - "additionalProperties": false, - "maxItems": 50, - "minItems": 0, - "properties": { - "CredentialArn": { - "$ref": "#/definitions/CredentialArn" - }, - "EcrRepositoryPrefix": { - "$ref": "#/definitions/EcrRepositoryPrefix" - }, - "RegistryId": { - "$ref": "#/definitions/RegistryId" - }, - "UpstreamRegistry": { - "$ref": "#/definitions/UpstreamRegistry" - }, - "UpstreamRegistryUrl": { - "$ref": "#/definitions/UpstreamRegistryUrl" - } - }, - "required": [ - "EcrRepositoryPrefix", - "UpstreamRegistryUrl" - ], - "type": "object" - }, - "RegistryId": { - "description": "The account ID of the registry pull-through cache repository will be created in.", - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "UpstreamRegistry": { - "description": "The name of the upstream registry.", - "type": "string" - }, - "UpstreamRegistryUrl": { - "description": "The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached", - "type": "string" - } - }, - "description": "The AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.", - "handlers": { - "create": { - "permissions": [ - "ecr:DescribePullThroughCacheRules", - "ecr:CreatePullThroughCacheRule", - "ecr:DeletePullThroughCacheRule", - "iam:CreateServiceLinkedRole", - "secretsmanager:GetSecretValue" - ] - }, - "delete": { - "permissions": [ - "ecr:DescribePullThroughCacheRules", - "ecr:DeletePullThroughCacheRule" - ] - }, - "list": { - "permissions": [ - "ecr:DescribePullThroughCacheRules" - ] - }, - "read": { - "permissions": [ - "ecr:DescribePullThroughCacheRules" - ] - }, - "update": { - "permissions": [ - "ecr:DescribePullThroughCacheRules", - "ecr:CreatePullThroughCacheRule", - "ecr:DeletePullThroughCacheRule", - "iam:CreateServiceLinkedRole", - "secretsmanager:GetSecretValue" - ] - } - }, - "primaryIdentifier": [ - "/properties/EcrRepositoryPrefix" - ], - "properties": { - "CredentialArn": { - "description": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.", - "maxLength": 612, - "minLength": 50, - "pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$", - "type": "string" - }, - "EcrRepositoryPrefix": { - "description": "The ECRRepositoryPrefix is a custom alias for upstream registry url.", - "maxLength": 30, - "minLength": 2, - "pattern": "(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*", - "type": "string" - }, - "UpstreamRegistry": { - "description": "The name of the upstream registry.", - "type": "string" - }, - "UpstreamRegistryUrl": { - "description": "The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ECR::PullThroughCacheRule", - "writeOnlyProperties": [ - "/properties/CredentialArn", - "/properties/UpstreamRegistry" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EcrRepositoryPrefix", + "/properties/UpstreamRegistryUrl", + "/properties/CredentialArn", + "/properties/UpstreamRegistry" + ], + "definitions": { + "CredentialArn": { + "description": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.", + "maxLength": 612, + "minLength": 50, + "pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$", + "type": "string" + }, + "EcrRepositoryPrefix": { + "description": "The ECRRepositoryPrefix is a custom alias for upstream registry url.", + "maxLength": 30, + "minLength": 2, + "pattern": "(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*", + "type": "string" + }, + "PullThroughCacheRule": { + "additionalProperties": false, + "maxItems": 50, + "minItems": 0, + "properties": { + "CredentialArn": { + "$ref": "#/definitions/CredentialArn" + }, + "EcrRepositoryPrefix": { + "$ref": "#/definitions/EcrRepositoryPrefix" + }, + "RegistryId": { + "$ref": "#/definitions/RegistryId" + }, + "UpstreamRegistry": { + "$ref": "#/definitions/UpstreamRegistry" + }, + "UpstreamRegistryUrl": { + "$ref": "#/definitions/UpstreamRegistryUrl" + } + }, + "required": [ + "EcrRepositoryPrefix", + "UpstreamRegistryUrl" + ], + "type": "object" + }, + "RegistryId": { + "description": "The account ID of the registry pull-through cache repository will be created in.", + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "UpstreamRegistry": { + "description": "The name of the upstream registry.", + "type": "string" + }, + "UpstreamRegistryUrl": { + "description": "The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached", + "type": "string" + } + }, + "description": "The AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.", + "handlers": { + "create": { + "permissions": [ + "ecr:DescribePullThroughCacheRules", + "ecr:CreatePullThroughCacheRule", + "ecr:DeletePullThroughCacheRule", + "iam:CreateServiceLinkedRole", + "secretsmanager:GetSecretValue" + ] + }, + "delete": { + "permissions": [ + "ecr:DescribePullThroughCacheRules", + "ecr:DeletePullThroughCacheRule" + ] + }, + "list": { + "permissions": [ + "ecr:DescribePullThroughCacheRules" + ] + }, + "read": { + "permissions": [ + "ecr:DescribePullThroughCacheRules" + ] + }, + "update": { + "permissions": [ + "ecr:DescribePullThroughCacheRules", + "ecr:CreatePullThroughCacheRule", + "ecr:DeletePullThroughCacheRule", + "iam:CreateServiceLinkedRole", + "secretsmanager:GetSecretValue" + ] + } + }, + "primaryIdentifier": [ + "/properties/EcrRepositoryPrefix" + ], + "properties": { + "CredentialArn": { + "description": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.", + "maxLength": 612, + "minLength": 50, + "pattern": "^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$", + "type": "string" + }, + "EcrRepositoryPrefix": { + "description": "The ECRRepositoryPrefix is a custom alias for upstream registry url.", + "maxLength": 30, + "minLength": 2, + "pattern": "(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*", + "type": "string" + }, + "UpstreamRegistry": { + "description": "The name of the upstream registry.", + "type": "string" + }, + "UpstreamRegistryUrl": { + "description": "The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached", + "type": "string" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ECR::PullThroughCacheRule", + "writeOnlyProperties": [ + "/properties/CredentialArn", + "/properties/UpstreamRegistry" + ] +} diff --git a/schema/aws-ecr-registrypolicy.json b/schema/aws-ecr-registrypolicy.json index 425c052..dfc7e49 100644 --- a/schema/aws-ecr-registrypolicy.json +++ b/schema/aws-ecr-registrypolicy.json @@ -1,66 +1,66 @@ -{ - "additionalProperties": false, - "definitions": { - "RegistryId": { - "description": "The registry id.", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - } - }, - "description": "The ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.\n A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ecr:GetRegistryPolicy", - "ecr:PutRegistryPolicy" - ] - }, - "delete": { - "permissions": [ - "ecr:DeleteRegistryPolicy" - ] - }, - "list": { - "permissions": [ - "ecr:GetRegistryPolicy" - ] - }, - "read": { - "permissions": [ - "ecr:GetRegistryPolicy" - ] - }, - "update": { - "permissions": [ - "ecr:GetRegistryPolicy", - "ecr:PutRegistryPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/RegistryId" - ], - "properties": { - "PolicyText": { - "description": "The JSON policy text for your registry.", - "type": "object" - }, - "RegistryId": { - "$ref": "#/definitions/RegistryId", - "description": "" - } - }, - "readOnlyProperties": [ - "/properties/RegistryId" - ], - "required": [ - "PolicyText" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ECR::RegistryPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "RegistryId": { + "description": "The registry id.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + } + }, + "description": "The ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.\n A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ecr:GetRegistryPolicy", + "ecr:PutRegistryPolicy" + ] + }, + "delete": { + "permissions": [ + "ecr:DeleteRegistryPolicy" + ] + }, + "list": { + "permissions": [ + "ecr:GetRegistryPolicy" + ] + }, + "read": { + "permissions": [ + "ecr:GetRegistryPolicy" + ] + }, + "update": { + "permissions": [ + "ecr:GetRegistryPolicy", + "ecr:PutRegistryPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/RegistryId" + ], + "properties": { + "PolicyText": { + "description": "The JSON policy text for your registry.", + "type": "object" + }, + "RegistryId": { + "$ref": "#/definitions/RegistryId", + "description": "" + } + }, + "readOnlyProperties": [ + "/properties/RegistryId" + ], + "required": [ + "PolicyText" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ECR::RegistryPolicy" +} diff --git a/schema/aws-ecr-replicationconfiguration.json b/schema/aws-ecr-replicationconfiguration.json index 2d205a7..773f1ed 100644 --- a/schema/aws-ecr-replicationconfiguration.json +++ b/schema/aws-ecr-replicationconfiguration.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "definitions": { - "Filter": { - "description": "The repository filter to be applied for replication.", - "pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$", - "type": "string" - }, - "FilterType": { - "description": "Type of repository filter", - "enum": [ - "PREFIX_MATCH" - ], - "type": "string" - }, - "Region": { - "description": "A Region to replicate to.", - "pattern": "[0-9a-z-]{2,25}", - "type": "string" - }, - "RegistryId": { - "description": "The account ID of the destination registry to replicate to.", - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "ReplicationConfiguration": { - "additionalProperties": false, - "description": "An object representing the replication configuration for a registry.", - "properties": { - "Rules": { - "description": "An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules.", - "items": { - "$ref": "#/definitions/ReplicationRule" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "ReplicationDestination": { - "additionalProperties": false, - "description": "An array of objects representing the details of a replication destination.", - "properties": { - "Region": { - "$ref": "#/definitions/Region" - }, - "RegistryId": { - "$ref": "#/definitions/RegistryId" - } - }, - "required": [ - "Region", - "RegistryId" - ], - "type": "object" - }, - "ReplicationRule": { - "additionalProperties": false, - "description": "An array of objects representing the details of a replication destination.", - "properties": { - "Destinations": { - "description": "An array of objects representing the details of a replication destination.", - "items": { - "$ref": "#/definitions/ReplicationDestination" - }, - "maxItems": 25, - "minItems": 1, - "type": "array" - }, - "RepositoryFilters": { - "description": "An array of objects representing the details of a repository filter.", - "items": { - "$ref": "#/definitions/RepositoryFilter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Destinations" - ], - "type": "object" - }, - "RepositoryFilter": { - "additionalProperties": false, - "description": "An array of objects representing the details of a repository filter.", - "properties": { - "Filter": { - "$ref": "#/definitions/Filter" - }, - "FilterType": { - "$ref": "#/definitions/FilterType" - } - }, - "required": [ - "Filter", - "FilterType" - ], - "type": "object" - } - }, - "description": "The AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html", - "handlers": { - "create": { - "permissions": [ - "ecr:DescribeRegistry", - "ecr:PutReplicationConfiguration", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "ecr:DescribeRegistry", - "ecr:PutReplicationConfiguration", - "iam:CreateServiceLinkedRole" - ] - }, - "list": { - "permissions": [ - "ecr:DescribeRegistry" - ] - }, - "read": { - "permissions": [ - "ecr:DescribeRegistry" - ] - }, - "update": { - "permissions": [ - "ecr:DescribeRegistry", - "ecr:PutReplicationConfiguration", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RegistryId" - ], - "properties": { - "RegistryId": { - "description": "The RegistryId associated with the aws account.", - "type": "string" - }, - "ReplicationConfiguration": { - "$ref": "#/definitions/ReplicationConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/RegistryId" - ], - "required": [ - "ReplicationConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ECR::ReplicationConfiguration" -} +{ + "additionalProperties": false, + "definitions": { + "Filter": { + "description": "The repository filter to be applied for replication.", + "pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$", + "type": "string" + }, + "FilterType": { + "description": "Type of repository filter", + "enum": [ + "PREFIX_MATCH" + ], + "type": "string" + }, + "Region": { + "description": "A Region to replicate to.", + "pattern": "[0-9a-z-]{2,25}", + "type": "string" + }, + "RegistryId": { + "description": "The account ID of the destination registry to replicate to.", + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "ReplicationConfiguration": { + "additionalProperties": false, + "description": "An object representing the replication configuration for a registry.", + "properties": { + "Rules": { + "description": "An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules.", + "items": { + "$ref": "#/definitions/ReplicationRule" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Rules" + ], + "type": "object" + }, + "ReplicationDestination": { + "additionalProperties": false, + "description": "An array of objects representing the details of a replication destination.", + "properties": { + "Region": { + "$ref": "#/definitions/Region" + }, + "RegistryId": { + "$ref": "#/definitions/RegistryId" + } + }, + "required": [ + "Region", + "RegistryId" + ], + "type": "object" + }, + "ReplicationRule": { + "additionalProperties": false, + "description": "An array of objects representing the details of a replication destination.", + "properties": { + "Destinations": { + "description": "An array of objects representing the details of a replication destination.", + "items": { + "$ref": "#/definitions/ReplicationDestination" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + }, + "RepositoryFilters": { + "description": "An array of objects representing the details of a repository filter.", + "items": { + "$ref": "#/definitions/RepositoryFilter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Destinations" + ], + "type": "object" + }, + "RepositoryFilter": { + "additionalProperties": false, + "description": "An array of objects representing the details of a repository filter.", + "properties": { + "Filter": { + "$ref": "#/definitions/Filter" + }, + "FilterType": { + "$ref": "#/definitions/FilterType" + } + }, + "required": [ + "Filter", + "FilterType" + ], + "type": "object" + } + }, + "description": "The AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html", + "handlers": { + "create": { + "permissions": [ + "ecr:DescribeRegistry", + "ecr:PutReplicationConfiguration", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ecr:DescribeRegistry", + "ecr:PutReplicationConfiguration", + "iam:CreateServiceLinkedRole" + ] + }, + "list": { + "permissions": [ + "ecr:DescribeRegistry" + ] + }, + "read": { + "permissions": [ + "ecr:DescribeRegistry" + ] + }, + "update": { + "permissions": [ + "ecr:DescribeRegistry", + "ecr:PutReplicationConfiguration", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RegistryId" + ], + "properties": { + "RegistryId": { + "description": "The RegistryId associated with the aws account.", + "type": "string" + }, + "ReplicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/RegistryId" + ], + "required": [ + "ReplicationConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ECR::ReplicationConfiguration" +} diff --git a/schema/aws-ecr-repository.json b/schema/aws-ecr-repository.json index 59ab5f6..c1cfe93 100644 --- a/schema/aws-ecr-repository.json +++ b/schema/aws-ecr-repository.json @@ -1,240 +1,245 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RepositoryName", - "/properties/EncryptionConfiguration", - "/properties/EncryptionConfiguration/EncryptionType", - "/properties/EncryptionConfiguration/KmsKey" - ], - "definitions": { - "EmptyOnDelete": { - "description": "If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories.", - "type": "boolean" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.", - "properties": { - "EncryptionType": { - "$ref": "#/definitions/EncryptionType", - "description": "The encryption type to use.\n If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.\n If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*." - }, - "KmsKey": { - "$ref": "#/definitions/KmsKey", - "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used." - } - }, - "required": [ - "EncryptionType" - ], - "type": "object" - }, - "EncryptionType": { - "description": "The encryption type to use.", - "enum": [ - "AES256", - "KMS" - ], - "type": "string" - }, - "ImageScanningConfiguration": { - "additionalProperties": false, - "description": "The image scanning configuration for a repository.", - "properties": { - "ScanOnPush": { - "$ref": "#/definitions/ScanOnPush", - "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started." - } - }, - "type": "object" - }, - "KmsKey": { - "description": "If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "LifecyclePolicy": { - "additionalProperties": false, - "description": "The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.", - "properties": { - "LifecyclePolicyText": { - "$ref": "#/definitions/LifecyclePolicyText", - "description": "The JSON repository policy text to apply to the repository." - }, - "RegistryId": { - "$ref": "#/definitions/RegistryId", - "description": "The AWS account ID associated with the registry that contains the repository. If you do\u2028 not specify a registry, the default registry is assumed." - } - }, - "type": "object" - }, - "LifecyclePolicyText": { - "description": "The JSON repository policy text to apply to the repository.", - "maxLength": 30720, - "minLength": 100, - "type": "string" - }, - "RegistryId": { - "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. ", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "ScanOnPush": { - "description": "The setting that determines whether images are scanned after being pushed to a repository.", - "type": "boolean" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", - "properties": { - "Key": { - "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A ``value`` acts as a descriptor within a tag category (key).", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.", - "handlers": { - "create": { - "permissions": [ - "ecr:CreateRepository", - "ecr:PutLifecyclePolicy", - "ecr:SetRepositoryPolicy", - "ecr:TagResource", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:RetireGrant" - ] - }, - "delete": { - "permissions": [ - "ecr:DeleteRepository", - "kms:RetireGrant" - ] - }, - "list": { - "permissions": [ - "ecr:DescribeRepositories" - ] - }, - "read": { - "permissions": [ - "ecr:DescribeRepositories", - "ecr:GetLifecyclePolicy", - "ecr:GetRepositoryPolicy", - "ecr:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ecr:DescribeRepositories", - "ecr:PutLifecyclePolicy", - "ecr:SetRepositoryPolicy", - "ecr:ListTagsForResource", - "ecr:TagResource", - "ecr:UntagResource", - "ecr:DeleteLifecyclePolicy", - "ecr:DeleteRepositoryPolicy", - "ecr:PutImageScanningConfiguration", - "ecr:PutImageTagMutability", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:RetireGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/RepositoryName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "EmptyOnDelete": { - "$ref": "#/definitions/EmptyOnDelete", - "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it." - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration", - "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest." - }, - "ImageScanningConfiguration": { - "$ref": "#/definitions/ImageScanningConfiguration", - "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository." - }, - "ImageTagMutability": { - "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.", - "enum": [ - "MUTABLE", - "IMMUTABLE" - ], - "type": "string" - }, - "LifecyclePolicy": { - "$ref": "#/definitions/LifecyclePolicy", - "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)." - }, - "RepositoryName": { - "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "maxLength": 256, - "minLength": 2, - "pattern": "^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$", - "type": "string" - }, - "RepositoryPolicyText": { - "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.", - "type": [ - "object", - "string" - ] - }, - "RepositoryUri": { - "description": "", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/RepositoryUri" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ECR::Repository", - "writeOnlyProperties": [ - "/properties/EmptyOnDelete" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RepositoryName", + "/properties/EncryptionConfiguration", + "/properties/EncryptionConfiguration/EncryptionType", + "/properties/EncryptionConfiguration/KmsKey" + ], + "definitions": { + "EmptyOnDelete": { + "description": "If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories.", + "type": "boolean" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.", + "properties": { + "EncryptionType": { + "$ref": "#/definitions/EncryptionType", + "description": "The encryption type to use.\n If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.\n If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*." + }, + "KmsKey": { + "$ref": "#/definitions/KmsKey", + "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used." + } + }, + "required": [ + "EncryptionType" + ], + "type": "object" + }, + "EncryptionType": { + "description": "The encryption type to use.", + "enum": [ + "AES256", + "KMS", + "KMS_DSSE" + ], + "type": "string" + }, + "ImageScanningConfiguration": { + "additionalProperties": false, + "description": "The image scanning configuration for a repository.", + "properties": { + "ScanOnPush": { + "$ref": "#/definitions/ScanOnPush", + "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started." + } + }, + "type": "object" + }, + "KmsKey": { + "description": "If you use the KMS or KMS_DSSE encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "LifecyclePolicy": { + "additionalProperties": false, + "description": "The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.", + "properties": { + "LifecyclePolicyText": { + "$ref": "#/definitions/LifecyclePolicyText", + "description": "The JSON repository policy text to apply to the repository." + }, + "RegistryId": { + "$ref": "#/definitions/RegistryId", + "description": "The AWS account ID associated with the registry that contains the repository. If you do\u2028 not specify a registry, the default registry is assumed." + } + }, + "type": "object" + }, + "LifecyclePolicyText": { + "description": "The JSON repository policy text to apply to the repository.", + "maxLength": 30720, + "minLength": 100, + "type": "string" + }, + "RegistryId": { + "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. ", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "ScanOnPush": { + "description": "The setting that determines whether images are scanned after being pushed to a repository.", + "type": "boolean" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", + "properties": { + "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A ``value`` acts as a descriptor within a tag category (key).", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.", + "handlers": { + "create": { + "permissions": [ + "ecr:CreateRepository", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy", + "ecr:TagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:RetireGrant" + ] + }, + "delete": { + "permissions": [ + "ecr:DeleteRepository", + "kms:RetireGrant" + ] + }, + "list": { + "permissions": [ + "ecr:DescribeRepositories" + ] + }, + "read": { + "permissions": [ + "ecr:DescribeRepositories", + "ecr:GetLifecyclePolicy", + "ecr:GetRepositoryPolicy", + "ecr:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ecr:DescribeRepositories", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy", + "ecr:ListTagsForResource", + "ecr:TagResource", + "ecr:UntagResource", + "ecr:DeleteLifecyclePolicy", + "ecr:DeleteRepositoryPolicy", + "ecr:PutImageScanningConfiguration", + "ecr:PutImageTagMutability", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:RetireGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/RepositoryName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "EmptyOnDelete": { + "$ref": "#/definitions/EmptyOnDelete", + "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it." + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration", + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest." + }, + "ImageScanningConfiguration": { + "$ref": "#/definitions/ImageScanningConfiguration", + "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository." + }, + "ImageTagMutability": { + "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.", + "enum": [ + "MUTABLE", + "IMMUTABLE" + ], + "type": "string" + }, + "LifecyclePolicy": { + "$ref": "#/definitions/LifecyclePolicy", + "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)." + }, + "RepositoryName": { + "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "maxLength": 256, + "minLength": 2, + "pattern": "^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$", + "type": "string" + }, + "RepositoryPolicyText": { + "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.", + "type": [ + "object", + "string" + ] + }, + "RepositoryUri": { + "description": "", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/RepositoryUri" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ecr:TagResource", + "ecr:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ECR::Repository", + "writeOnlyProperties": [ + "/properties/EmptyOnDelete" + ] +} diff --git a/schema/aws-ecr-repositorycreationtemplate.json b/schema/aws-ecr-repositorycreationtemplate.json index 128486a..cf9c89c 100644 --- a/schema/aws-ecr-repositorycreationtemplate.json +++ b/schema/aws-ecr-repositorycreationtemplate.json @@ -1,193 +1,193 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Prefix" - ], - "definitions": { - "AppliedForItem": { - "description": "Enumerable Strings representing the repository creation scenarios that the template will apply towards.", - "enum": [ - "REPLICATION", - "PULL_THROUGH_CACHE" - ], - "type": "string" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n\nFor more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html", - "properties": { - "EncryptionType": { - "$ref": "#/definitions/EncryptionType" - }, - "KmsKey": { - "$ref": "#/definitions/KmsKey" - } - }, - "required": [ - "EncryptionType" - ], - "type": "object" - }, - "EncryptionType": { - "description": "The encryption type to use.", - "enum": [ - "AES256", - "KMS" - ], - "type": "string" - }, - "KmsKey": { - "description": "If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "An array of key-value pairs to apply to this resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.", - "handlers": { - "create": { - "permissions": [ - "ecr:CreateRepositoryCreationTemplate", - "ecr:PutLifecyclePolicy", - "ecr:SetRepositoryPolicy", - "ecr:CreateRepository", - "iam:CreateServiceLinkedRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "ecr:DeleteRepositoryCreationTemplate" - ] - }, - "list": { - "permissions": [ - "ecr:DescribeRepositoryCreationTemplates" - ] - }, - "read": { - "permissions": [ - "ecr:DescribeRepositoryCreationTemplates" - ] - }, - "update": { - "permissions": [ - "ecr:DescribeRepositoryCreationTemplates", - "ecr:UpdateRepositoryCreationTemplate", - "ecr:PutLifecyclePolicy", - "ecr:SetRepositoryPolicy", - "ecr:CreateRepository", - "iam:CreateServiceLinkedRole", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Prefix" - ], - "properties": { - "AppliedFor": { - "description": "A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AppliedForItem" - }, - "type": "array", - "uniqueItems": true - }, - "CreatedAt": { - "description": "Create timestamp of the template.", - "type": "string" - }, - "CustomRoleArn": { - "description": "The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.", - "maxLength": 2048, - "pattern": "^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$", - "type": "string" - }, - "Description": { - "description": "The description of the template.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "ImageTagMutability": { - "description": "The image tag mutability setting for the repository.", - "enum": [ - "MUTABLE", - "IMMUTABLE" - ], - "type": "string" - }, - "LifecyclePolicy": { - "description": "The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html", - "maxLength": 30720, - "minLength": 100, - "type": "string" - }, - "Prefix": { - "description": "The prefix use to match the repository name and apply the template.", - "maxLength": 256, - "minLength": 1, - "pattern": "^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$", - "type": "string" - }, - "RepositoryPolicy": { - "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html", - "type": "string" - }, - "ResourceTags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "description": "Update timestamp of the template.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/UpdatedAt" - ], - "required": [ - "Prefix", - "AppliedFor" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ECR::RepositoryCreationTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Prefix" + ], + "definitions": { + "AppliedForItem": { + "description": "Enumerable Strings representing the repository creation scenarios that the template will apply towards.", + "enum": [ + "REPLICATION", + "PULL_THROUGH_CACHE" + ], + "type": "string" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n\nFor more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html", + "properties": { + "EncryptionType": { + "$ref": "#/definitions/EncryptionType" + }, + "KmsKey": { + "$ref": "#/definitions/KmsKey" + } + }, + "required": [ + "EncryptionType" + ], + "type": "object" + }, + "EncryptionType": { + "description": "The encryption type to use.", + "enum": [ + "AES256", + "KMS" + ], + "type": "string" + }, + "KmsKey": { + "description": "If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "An array of key-value pairs to apply to this resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.", + "handlers": { + "create": { + "permissions": [ + "ecr:CreateRepositoryCreationTemplate", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy", + "ecr:CreateRepository", + "iam:CreateServiceLinkedRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "ecr:DeleteRepositoryCreationTemplate" + ] + }, + "list": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates" + ] + }, + "read": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates" + ] + }, + "update": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates", + "ecr:UpdateRepositoryCreationTemplate", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy", + "ecr:CreateRepository", + "iam:CreateServiceLinkedRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Prefix" + ], + "properties": { + "AppliedFor": { + "description": "A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AppliedForItem" + }, + "type": "array", + "uniqueItems": true + }, + "CreatedAt": { + "description": "Create timestamp of the template.", + "type": "string" + }, + "CustomRoleArn": { + "description": "The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.", + "maxLength": 2048, + "pattern": "^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$", + "type": "string" + }, + "Description": { + "description": "The description of the template.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ImageTagMutability": { + "description": "The image tag mutability setting for the repository.", + "enum": [ + "MUTABLE", + "IMMUTABLE" + ], + "type": "string" + }, + "LifecyclePolicy": { + "description": "The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html", + "maxLength": 30720, + "minLength": 100, + "type": "string" + }, + "Prefix": { + "description": "The prefix use to match the repository name and apply the template.", + "maxLength": 256, + "minLength": 1, + "pattern": "^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$", + "type": "string" + }, + "RepositoryPolicy": { + "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html", + "type": "string" + }, + "ResourceTags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "Update timestamp of the template.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "Prefix", + "AppliedFor" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ECR::RepositoryCreationTemplate" +} diff --git a/schema/aws-ecs-capacityprovider.json b/schema/aws-ecs-capacityprovider.json index 3287798..4e6d34c 100644 --- a/schema/aws-ecs-capacityprovider.json +++ b/schema/aws-ecs-capacityprovider.json @@ -1,141 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AutoScalingGroupProvider/AutoScalingGroupArn", - "/properties/Name" - ], - "definitions": { - "AutoScalingGroupProvider": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupArn": { - "type": "string" - }, - "ManagedDraining": { - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "ManagedScaling": { - "$ref": "#/definitions/ManagedScaling" - }, - "ManagedTerminationProtection": { - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - } - }, - "required": [ - "AutoScalingGroupArn" - ], - "type": "object" - }, - "ManagedScaling": { - "additionalProperties": false, - "description": "The managed scaling settings for the Auto Scaling group capacity provider.", - "properties": { - "InstanceWarmupPeriod": { - "type": "integer" - }, - "MaximumScalingStepSize": { - "type": "integer" - }, - "MinimumScalingStepSize": { - "type": "integer" - }, - "Status": { - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "TargetCapacity": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "minLength": 1, - "type": "string" - }, - "Value": { - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ECS::CapacityProvider.", - "handlers": { - "create": { - "permissions": [ - "autoscaling:CreateOrUpdateTags", - "ecs:CreateCapacityProvider", - "ecs:DescribeCapacityProviders", - "ecs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ecs:DescribeCapacityProviders", - "ecs:DeleteCapacityProvider" - ] - }, - "list": { - "permissions": [ - "ecs:DescribeCapacityProviders" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeCapacityProviders" - ] - }, - "update": { - "permissions": [ - "ecs:UpdateCapacityProvider", - "ecs:DescribeCapacityProviders", - "ecs:ListTagsForResource", - "ecs:TagResource", - "ecs:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AutoScalingGroupProvider": { - "$ref": "#/definitions/AutoScalingGroupProvider" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "propertyTransform": { - "/properties/AutoScalingGroupProvider/AutoScalingGroupArn": "$split(AutoScalingGroupProvider.AutoScalingGroupArn, \"autoScalingGroupName/\")[-1] $OR $split(AutoScalingGroupArn, \"autoScalingGroupName/\")[-1]" - }, - "required": [ - "AutoScalingGroupProvider" - ], - "tagging": { - "taggable": true - }, - "typeName": "AWS::ECS::CapacityProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AutoScalingGroupProvider/AutoScalingGroupArn", + "/properties/Name" + ], + "definitions": { + "AutoScalingGroupProvider": { + "additionalProperties": false, + "properties": { + "AutoScalingGroupArn": { + "type": "string" + }, + "ManagedDraining": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "ManagedScaling": { + "$ref": "#/definitions/ManagedScaling" + }, + "ManagedTerminationProtection": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + } + }, + "required": [ + "AutoScalingGroupArn" + ], + "type": "object" + }, + "ManagedScaling": { + "additionalProperties": false, + "description": "The managed scaling settings for the Auto Scaling group capacity provider.", + "properties": { + "InstanceWarmupPeriod": { + "type": "integer" + }, + "MaximumScalingStepSize": { + "type": "integer" + }, + "MinimumScalingStepSize": { + "type": "integer" + }, + "Status": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "TargetCapacity": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "minLength": 1, + "type": "string" + }, + "Value": { + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ECS::CapacityProvider.", + "handlers": { + "create": { + "permissions": [ + "autoscaling:CreateOrUpdateTags", + "ecs:CreateCapacityProvider", + "ecs:DescribeCapacityProviders", + "ecs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ecs:DescribeCapacityProviders", + "ecs:DeleteCapacityProvider" + ] + }, + "list": { + "permissions": [ + "ecs:DescribeCapacityProviders" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeCapacityProviders" + ] + }, + "update": { + "permissions": [ + "ecs:UpdateCapacityProvider", + "ecs:DescribeCapacityProviders", + "ecs:ListTagsForResource", + "ecs:TagResource", + "ecs:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AutoScalingGroupProvider": { + "$ref": "#/definitions/AutoScalingGroupProvider" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "propertyTransform": { + "/properties/AutoScalingGroupProvider/AutoScalingGroupArn": "$split(AutoScalingGroupProvider.AutoScalingGroupArn, \"autoScalingGroupName/\")[-1] $OR $split(AutoScalingGroupArn, \"autoScalingGroupName/\")[-1]" + }, + "required": [ + "AutoScalingGroupProvider" + ], + "tagging": { + "taggable": true + }, + "typeName": "AWS::ECS::CapacityProvider" +} diff --git a/schema/aws-ecs-cluster.json b/schema/aws-ecs-cluster.json index 3a1b7be..a4061c7 100644 --- a/schema/aws-ecs-cluster.json +++ b/schema/aws-ecs-cluster.json @@ -1,258 +1,263 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName" - ], - "definitions": { - "CapacityProviderStrategyItem": { - "additionalProperties": false, - "description": "The ``CapacityProviderStrategyItem`` property specifies the details of the default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", - "properties": { - "Base": { - "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", - "type": "integer" - }, - "CapacityProvider": { - "description": "The short name of the capacity provider.", - "relationshipRef": { - "propertyPath": "/properties/Name", - "typeName": "AWS::ECS::CapacityProvider" - }, - "type": "string" - }, - "Weight": { - "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", - "type": "integer" - } - }, - "type": "object" - }, - "ClusterConfiguration": { - "additionalProperties": false, - "description": "The execute command configuration for the cluster.", - "properties": { - "ExecuteCommandConfiguration": { - "$ref": "#/definitions/ExecuteCommandConfiguration", - "description": "The details of the execute command configuration." - }, - "ManagedStorageConfiguration": { - "$ref": "#/definitions/ManagedStorageConfiguration", - "description": "" - } - }, - "type": "object" - }, - "ClusterSettings": { - "additionalProperties": false, - "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", - "properties": { - "Name": { - "description": "The name of the cluster setting. The value is ``containerInsights`` .", - "type": "string" - }, - "Value": { - "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. \n If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html).", - "type": "string" - } - }, - "type": "object" - }, - "ExecuteCommandConfiguration": { - "additionalProperties": false, - "description": "The details of the execute command configuration.", - "properties": { - "KmsKeyId": { - "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container.", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - }, - "type": "string" - }, - "LogConfiguration": { - "$ref": "#/definitions/ExecuteCommandLogConfiguration", - "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided." - }, - "Logging": { - "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available.\n + ``NONE``: The execute command session is not logged.\n + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged.\n + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required.", - "type": "string" - } - }, - "type": "object" - }, - "ExecuteCommandLogConfiguration": { - "additionalProperties": false, - "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.", - "properties": { - "CloudWatchEncryptionEnabled": { - "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.", - "type": "boolean" - }, - "CloudWatchLogGroupName": { - "description": "The name of the CloudWatch log group to send logs to.\n The CloudWatch log group must already be created.", - "relationshipRef": { - "propertyPath": "/properties/LogGroupName", - "typeName": "AWS::Logs::LogGroup" - }, - "type": "string" - }, - "S3BucketName": { - "description": "The name of the S3 bucket to send logs to.\n The S3 bucket must already be created.", - "type": "string" - }, - "S3EncryptionEnabled": { - "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.", - "type": "boolean" - }, - "S3KeyPrefix": { - "description": "An optional folder in the S3 bucket to place logs in.", - "type": "string" - } - }, - "type": "object" - }, - "ManagedStorageConfiguration": { - "additionalProperties": false, - "description": "", - "properties": { - "FargateEphemeralStorageKmsKeyId": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "ServiceConnectDefaults": { - "additionalProperties": false, - "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Namespace": { - "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).\n If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.\n If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect.\n If you update the cluster with an empty string ``\"\"`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately.\n For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "properties": { - "Key": { - "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", - "type": "string" - }, - "Value": { - "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ECS::Cluster`` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.", - "handlers": { - "create": { - "permissions": [ - "ecs:CreateCluster", - "ecs:DescribeClusters", - "iam:CreateServiceLinkedRole", - "ecs:TagResource", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "ecs:DeleteCluster", - "ecs:DescribeClusters", - "kms:DescribeKey" - ] - }, - "list": { - "permissions": [ - "ecs:DescribeClusters", - "ecs:ListClusters" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeClusters", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "ecs:PutAccountSettingDefault", - "ecs:DescribeClusters", - "ecs:TagResource", - "ecs:UntagResource", - "ecs:PutAccountSetting", - "ecs:ListTagsForResource", - "ecs:UpdateCluster", - "ecs:UpdateClusterSettings", - "ecs:PutClusterCapacityProviders", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "CapacityProviders": { - "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation.\n To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ClusterName": { - "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.", - "type": "string" - }, - "ClusterSettings": { - "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", - "items": { - "$ref": "#/definitions/ClusterSettings" - }, - "type": "array" - }, - "Configuration": { - "$ref": "#/definitions/ClusterConfiguration", - "description": "The execute command configuration for the cluster." - }, - "DefaultCapacityProviderStrategy": { - "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", - "items": { - "$ref": "#/definitions/CapacityProviderStrategyItem" - }, - "type": "array" - }, - "ServiceConnectDefaults": { - "$ref": "#/definitions/ServiceConnectDefaults", - "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "Tags": { - "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "taggable": true - }, - "typeName": "AWS::ECS::Cluster", - "writeOnlyProperties": [ - "/properties/ServiceConnectDefaults" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName" + ], + "definitions": { + "CapacityProviderStrategyItem": { + "additionalProperties": false, + "description": "The ``CapacityProviderStrategyItem`` property specifies the details of the default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", + "properties": { + "Base": { + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", + "type": "integer" + }, + "CapacityProvider": { + "description": "The short name of the capacity provider.", + "relationshipRef": { + "propertyPath": "/properties/Name", + "typeName": "AWS::ECS::CapacityProvider" + }, + "type": "string" + }, + "Weight": { + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", + "type": "integer" + } + }, + "type": "object" + }, + "ClusterConfiguration": { + "additionalProperties": false, + "description": "The execute command and managed storage configuration for the cluster.", + "properties": { + "ExecuteCommandConfiguration": { + "$ref": "#/definitions/ExecuteCommandConfiguration", + "description": "The details of the execute command configuration." + }, + "ManagedStorageConfiguration": { + "$ref": "#/definitions/ManagedStorageConfiguration", + "description": "The details of the managed storage configuration." + } + }, + "type": "object" + }, + "ClusterSettings": { + "additionalProperties": false, + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", + "properties": { + "Name": { + "description": "The name of the cluster setting. The value is ``containerInsights`` .", + "type": "string" + }, + "Value": { + "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. \n If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html).", + "type": "string" + } + }, + "type": "object" + }, + "ExecuteCommandConfiguration": { + "additionalProperties": false, + "description": "The details of the execute command configuration.", + "properties": { + "KmsKeyId": { + "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, + "type": "string" + }, + "LogConfiguration": { + "$ref": "#/definitions/ExecuteCommandLogConfiguration", + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided." + }, + "Logging": { + "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available.\n + ``NONE``: The execute command session is not logged.\n + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged.\n + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required.", + "type": "string" + } + }, + "type": "object" + }, + "ExecuteCommandLogConfiguration": { + "additionalProperties": false, + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.", + "properties": { + "CloudWatchEncryptionEnabled": { + "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.", + "type": "boolean" + }, + "CloudWatchLogGroupName": { + "description": "The name of the CloudWatch log group to send logs to.\n The CloudWatch log group must already be created.", + "relationshipRef": { + "propertyPath": "/properties/LogGroupName", + "typeName": "AWS::Logs::LogGroup" + }, + "type": "string" + }, + "S3BucketName": { + "description": "The name of the S3 bucket to send logs to.\n The S3 bucket must already be created.", + "type": "string" + }, + "S3EncryptionEnabled": { + "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.", + "type": "boolean" + }, + "S3KeyPrefix": { + "description": "An optional folder in the S3 bucket to place logs in.", + "type": "string" + } + }, + "type": "object" + }, + "ManagedStorageConfiguration": { + "additionalProperties": false, + "description": "The managed storage configuration for the cluster.", + "properties": { + "FargateEphemeralStorageKmsKeyId": { + "description": "Specify the KMSlong key ID for the Fargate ephemeral storage.", + "type": "string" + }, + "KmsKeyId": { + "description": "Specify a KMSlong key ID to encrypt the managed storage.", + "type": "string" + } + }, + "type": "object" + }, + "ServiceConnectDefaults": { + "additionalProperties": false, + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Namespace": { + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).\n If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.\n If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect.\n If you update the cluster with an empty string ``\"\"`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately.\n For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "properties": { + "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", + "type": "string" + }, + "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ECS::Cluster`` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.", + "handlers": { + "create": { + "permissions": [ + "ecs:CreateCluster", + "ecs:DescribeClusters", + "iam:CreateServiceLinkedRole", + "ecs:TagResource", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "ecs:DeleteCluster", + "ecs:DescribeClusters", + "kms:DescribeKey" + ] + }, + "list": { + "permissions": [ + "ecs:DescribeClusters", + "ecs:ListClusters" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeClusters", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "ecs:PutAccountSettingDefault", + "ecs:DescribeClusters", + "ecs:TagResource", + "ecs:UntagResource", + "ecs:PutAccountSetting", + "ecs:ListTagsForResource", + "ecs:UpdateCluster", + "ecs:UpdateClusterSettings", + "ecs:PutClusterCapacityProviders", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "CapacityProviders": { + "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation.\n To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ClusterName": { + "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.", + "type": "string" + }, + "ClusterSettings": { + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", + "items": { + "$ref": "#/definitions/ClusterSettings" + }, + "type": "array" + }, + "Configuration": { + "$ref": "#/definitions/ClusterConfiguration", + "description": "The execute command and managed storage configuration for the cluster." + }, + "DefaultCapacityProviderStrategy": { + "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "type": "array" + }, + "ServiceConnectDefaults": { + "$ref": "#/definitions/ServiceConnectDefaults", + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Tags": { + "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "propertyTransform": { + "/properties/Configuration/ManagedStorageConfiguration/FargateEphemeralStorageKmsKeyId": "$join([\"arn:aws[-a-z]*:kms:[a-z0-9-]+:[0-9]{12}:key/\", FargateEphemeralStorageKmsKeyId])" + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "taggable": true + }, + "typeName": "AWS::ECS::Cluster", + "writeOnlyProperties": [ + "/properties/ServiceConnectDefaults" + ] +} diff --git a/schema/aws-ecs-clustercapacityproviderassociations.json b/schema/aws-ecs-clustercapacityproviderassociations.json index 30c774a..ea71d89 100644 --- a/schema/aws-ecs-clustercapacityproviderassociations.json +++ b/schema/aws-ecs-clustercapacityproviderassociations.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Cluster" - ], - "definitions": { - "CapacityProvider": { - "anyOf": [ - { - "enum": [ - "FARGATE", - "FARGATE_SPOT" - ], - "type": "string" - }, - { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - ], - "description": "If using ec2 auto-scaling, the name of the associated capacity provider. Otherwise FARGATE, FARGATE_SPOT.", - "type": "string" - }, - "CapacityProviderStrategy": { - "additionalProperties": false, - "properties": { - "Base": { - "maximum": 100000, - "minimum": 0, - "type": "integer" - }, - "CapacityProvider": { - "$ref": "#/definitions/CapacityProvider" - }, - "Weight": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "CapacityProvider" - ], - "type": "object" - }, - "CapacityProviders": { - "description": "List of capacity providers to associate with the cluster", - "items": { - "$ref": "#/definitions/CapacityProvider" - }, - "type": "array", - "uniqueItems": true - }, - "Cluster": { - "description": "The name of the cluster", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DefaultCapacityProviderStrategy": { - "description": "List of capacity providers to associate with the cluster", - "items": { - "$ref": "#/definitions/CapacityProviderStrategy" - }, - "type": "array" - } - }, - "description": "Associate a set of ECS Capacity Providers with a specified ECS Cluster", - "handlers": { - "create": { - "permissions": [ - "ecs:DescribeClusters", - "ecs:PutClusterCapacityProviders" - ] - }, - "delete": { - "permissions": [ - "ecs:PutClusterCapacityProviders", - "ecs:DescribeClusters" - ] - }, - "list": { - "permissions": [ - "ecs:DescribeClusters", - "ecs:ListClusters" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeClusters" - ] - }, - "update": { - "permissions": [ - "ecs:DescribeClusters", - "ecs:PutClusterCapacityProviders" - ] - } - }, - "primaryIdentifier": [ - "/properties/Cluster" - ], - "properties": { - "CapacityProviders": { - "$ref": "#/definitions/CapacityProviders" - }, - "Cluster": { - "$ref": "#/definitions/Cluster" - }, - "DefaultCapacityProviderStrategy": { - "$ref": "#/definitions/DefaultCapacityProviderStrategy" - } - }, - "required": [ - "CapacityProviders", - "Cluster", - "DefaultCapacityProviderStrategy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ECS::ClusterCapacityProviderAssociations" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Cluster" + ], + "definitions": { + "CapacityProvider": { + "anyOf": [ + { + "enum": [ + "FARGATE", + "FARGATE_SPOT" + ], + "type": "string" + }, + { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + ], + "description": "If using ec2 auto-scaling, the name of the associated capacity provider. Otherwise FARGATE, FARGATE_SPOT.", + "type": "string" + }, + "CapacityProviderStrategy": { + "additionalProperties": false, + "properties": { + "Base": { + "maximum": 100000, + "minimum": 0, + "type": "integer" + }, + "CapacityProvider": { + "$ref": "#/definitions/CapacityProvider" + }, + "Weight": { + "maximum": 1000, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "CapacityProvider" + ], + "type": "object" + }, + "CapacityProviders": { + "description": "List of capacity providers to associate with the cluster", + "items": { + "$ref": "#/definitions/CapacityProvider" + }, + "type": "array", + "uniqueItems": true + }, + "Cluster": { + "description": "The name of the cluster", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DefaultCapacityProviderStrategy": { + "description": "List of capacity providers to associate with the cluster", + "items": { + "$ref": "#/definitions/CapacityProviderStrategy" + }, + "type": "array" + } + }, + "description": "Associate a set of ECS Capacity Providers with a specified ECS Cluster", + "handlers": { + "create": { + "permissions": [ + "ecs:DescribeClusters", + "ecs:PutClusterCapacityProviders" + ] + }, + "delete": { + "permissions": [ + "ecs:PutClusterCapacityProviders", + "ecs:DescribeClusters" + ] + }, + "list": { + "permissions": [ + "ecs:DescribeClusters", + "ecs:ListClusters" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeClusters" + ] + }, + "update": { + "permissions": [ + "ecs:DescribeClusters", + "ecs:PutClusterCapacityProviders" + ] + } + }, + "primaryIdentifier": [ + "/properties/Cluster" + ], + "properties": { + "CapacityProviders": { + "$ref": "#/definitions/CapacityProviders" + }, + "Cluster": { + "$ref": "#/definitions/Cluster" + }, + "DefaultCapacityProviderStrategy": { + "$ref": "#/definitions/DefaultCapacityProviderStrategy" + } + }, + "required": [ + "CapacityProviders", + "Cluster", + "DefaultCapacityProviderStrategy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ECS::ClusterCapacityProviderAssociations" +} diff --git a/schema/aws-ecs-primarytaskset.json b/schema/aws-ecs-primarytaskset.json index c1889ac..ead9ca3 100644 --- a/schema/aws-ecs-primarytaskset.json +++ b/schema/aws-ecs-primarytaskset.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Cluster", - "/properties/Service" - ], - "description": "A pseudo-resource that manages which of your ECS task sets is primary.", - "handlers": { - "create": { - "permissions": [ - "ecs:DescribeTaskSets", - "ecs:UpdateServicePrimaryTaskSet" - ] - }, - "delete": { - "permissions": [] - }, - "read": { - "permissions": [] - }, - "update": { - "permissions": [ - "ecs:DescribeTaskSets", - "ecs:UpdateServicePrimaryTaskSet" - ] - } - }, - "primaryIdentifier": [ - "/properties/Cluster", - "/properties/Service" - ], - "properties": { - "Cluster": { - "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.", - "type": "string" - }, - "Service": { - "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.", - "type": "string" - }, - "TaskSetId": { - "description": "The ID or full Amazon Resource Name (ARN) of the task set.", - "type": "string" - } - }, - "required": [ - "Cluster", - "Service", - "TaskSetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecs.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ECS::PrimaryTaskSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Cluster", + "/properties/Service" + ], + "description": "A pseudo-resource that manages which of your ECS task sets is primary.", + "handlers": { + "create": { + "permissions": [ + "ecs:DescribeTaskSets", + "ecs:UpdateServicePrimaryTaskSet" + ] + }, + "delete": { + "permissions": [] + }, + "read": { + "permissions": [] + }, + "update": { + "permissions": [ + "ecs:DescribeTaskSets", + "ecs:UpdateServicePrimaryTaskSet" + ] + } + }, + "primaryIdentifier": [ + "/properties/Cluster", + "/properties/Service" + ], + "properties": { + "Cluster": { + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.", + "type": "string" + }, + "Service": { + "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.", + "type": "string" + }, + "TaskSetId": { + "description": "The ID or full Amazon Resource Name (ARN) of the task set.", + "type": "string" + } + }, + "required": [ + "Cluster", + "Service", + "TaskSetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecs.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ECS::PrimaryTaskSet" +} diff --git a/schema/aws-ecs-service.json b/schema/aws-ecs-service.json index 66b5ee0..cb6618e 100644 --- a/schema/aws-ecs-service.json +++ b/schema/aws-ecs-service.json @@ -1,738 +1,741 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Cluster", - "/properties/DeploymentController", - "/properties/LaunchType", - "/properties/Role", - "/properties/SchedulingStrategy", - "/properties/ServiceName" - ], - "definitions": { - "AwsVpcConfiguration": { - "additionalProperties": false, - "description": "An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}``", - "properties": { - "AssignPublicIp": { - "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "SecurityGroups": { - "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``.\n All specified security groups must be from the same VPC.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``.\n All specified subnets must be from the same VPC.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CapacityProviderStrategyItem": { - "additionalProperties": false, - "description": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the ``RunTask`` or ``CreateService`` APIs or as the default capacity provider strategy for a cluster with the ``CreateCluster`` API.\n Only capacity providers that are already associated with a cluster and have an ``ACTIVE`` or ``UPDATING`` status can be used in a capacity provider strategy. The ``PutClusterCapacityProviders`` API is used to associate a capacity provider with a cluster.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the ``CreateCapacityProvider`` API operation.\n To use an FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.", - "properties": { - "Base": { - "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", - "type": "integer" - }, - "CapacityProvider": { - "description": "The short name of the capacity provider.", - "type": "string" - }, - "Weight": { - "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", - "type": "integer" - } - }, - "type": "object" - }, - "DeploymentAlarms": { - "additionalProperties": false, - "description": "One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.\n When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.\n You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update).\n For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "AlarmNames": { - "description": "One or more CloudWatch alarm names. Use a \",\" to separate the alarms.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Enable": { - "description": "Determines whether to use the CloudWatch alarm option in the service deployment process.", - "type": "boolean" - }, - "Rollback": { - "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", - "type": "boolean" - } - }, - "required": [ - "AlarmNames", - "Rollback", - "Enable" - ], - "type": "object" - }, - "DeploymentCircuitBreaker": { - "additionalProperties": false, - "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Enable": { - "description": "Determines whether to use the deployment circuit breaker logic for the service.", - "type": "boolean" - }, - "Rollback": { - "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", - "type": "boolean" - } - }, - "required": [ - "Enable", - "Rollback" - ], - "type": "object" - }, - "DeploymentConfiguration": { - "additionalProperties": false, - "description": "The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.", - "properties": { - "Alarms": { - "$ref": "#/definitions/DeploymentAlarms", - "description": "Information about the CloudWatch alarms." - }, - "DeploymentCircuitBreaker": { - "$ref": "#/definitions/DeploymentCircuitBreaker", - "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*" - }, - "MaximumPercent": { - "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.", - "type": "integer" - }, - "MinimumHealthyPercent": { - "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. \n For services that *do not* use a load balancer, the following should be noted:\n + A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total.\n + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. \n \n For services that *do* use a load balancer, the following should be noted:\n + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n \n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.", - "type": "integer" - } - }, - "type": "object" - }, - "DeploymentController": { - "additionalProperties": false, - "description": "The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Type": { - "description": "The deployment controller type to use. There are three deployment controller types available:\n + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.", - "enum": [ - "CODE_DEPLOY", - "ECS", - "EXTERNAL" - ], - "type": "string" - } - }, - "type": "object" - }, - "EBSTagSpecification": { - "description": "The tag specifications of an Amazon EBS volume.", - "properties": { - "PropagateTags": { - "description": "Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in \u2028``ServiceVolumeConfiguration``. If no value is specified, the tags aren't \u2028propagated.", - "enum": [ - "SERVICE", - "TASK_DEFINITION" - ], - "type": "string" - }, - "ResourceType": { - "description": "The type of volume resource.", - "type": "string" - }, - "Tags": { - "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ResourceType" - ], - "type": "object" - }, - "LoadBalancer": { - "additionalProperties": false, - "description": "The ``LoadBalancer`` property specifies details on a load balancer that is used with a service.\n If the service is using the ``CODE_DEPLOY`` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an ACDlong deployment group, you specify two target groups (referred to as a ``targetGroupPair``). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.\n Services with tasks that use the ``awsvpc`` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ``ip`` as the target type, not ``instance``. Tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance.", - "properties": { - "ContainerName": { - "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.\n You need to specify the container name when configuring the target group for an Amazon ECS load balancer.", - "type": "string" - }, - "ContainerPort": { - "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping.", - "type": "integer" - }, - "LoadBalancerName": { - "description": "The name of the load balancer to associate with the Amazon ECS service or task set.\n If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.", - "type": "string" - }, - "TargetGroupArn": { - "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.\n A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. \n For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*.\n For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.", - "type": "string" - } - }, - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/).\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.", - "properties": { - "LogDriver": { - "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", - "type": "string" - }, - "Options": { - "additionalProperties": false, - "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "SecretOptions": { - "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "description": "The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service.", - "properties": { - "AwsvpcConfiguration": { - "$ref": "#/definitions/AwsVpcConfiguration", - "description": "The VPC subnets and security groups that are associated with a task.\n All specified subnets and security groups must be from the same VPC." - } - }, - "type": "object" - }, - "PlacementConstraint": { - "additionalProperties": false, - "description": "The ``PlacementConstraint`` property specifies an object representing a constraint on task placement in the task definition. For more information, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Expression": { - "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Type": { - "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.", - "enum": [ - "distinctInstance", - "memberOf" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "PlacementStrategy": { - "additionalProperties": false, - "description": "The ``PlacementStrategy`` property specifies the task placement strategy for a task or service. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Field": { - "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used.", - "type": "string" - }, - "Type": { - "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.", - "enum": [ - "binpack", - "random", - "spread" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Secret": { - "additionalProperties": false, - "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Name": { - "description": "The name of the secret.", - "type": "string" - }, - "ValueFrom": { - "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", - "type": "string" - } - }, - "required": [ - "Name", - "ValueFrom" - ], - "type": "object" - }, - "ServiceConnectClientAlias": { - "additionalProperties": false, - "description": "Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "DnsName": { - "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.\n If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.\n To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Port": { - "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "integer" - } - }, - "required": [ - "Port" - ], - "type": "object" - }, - "ServiceConnectConfiguration": { - "additionalProperties": false, - "description": "The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Enabled": { - "description": "Specifies whether to use Service Connect with this service.", - "type": "boolean" - }, - "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration", - "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/).\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." - }, - "Namespace": { - "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", - "type": "string" - }, - "Services": { - "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. \n This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.\n An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service.", - "items": { - "$ref": "#/definitions/ServiceConnectService" - }, - "type": "array" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ServiceConnectService": { - "additionalProperties": false, - "description": "The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "ClientAliases": { - "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.\n Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``.", - "items": { - "$ref": "#/definitions/ServiceConnectClientAlias" - }, - "type": "array" - }, - "DiscoveryName": { - "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.", - "type": "string" - }, - "IngressPortOverride": { - "description": "The port number for the Service Connect proxy to listen on.\n Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.\n In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.", - "type": "integer" - }, - "PortName": { - "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service.", - "type": "string" - }, - "Timeout": { - "$ref": "#/definitions/TimeoutConfiguration", - "description": "A reference to an object that represents the configured timeouts for Service Connect." - }, - "Tls": { - "$ref": "#/definitions/ServiceConnectTlsConfiguration", - "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration." - } - }, - "required": [ - "PortName" - ], - "type": "object" - }, - "ServiceConnectTlsCertificateAuthority": { - "additionalProperties": false, - "description": "An object that represents the AWS Private Certificate Authority certificate.", - "properties": { - "AwsPcaAuthorityArn": { - "description": "The ARN of the AWS Private Certificate Authority certificate.", - "type": "string" - } - }, - "type": "object" - }, - "ServiceConnectTlsConfiguration": { - "additionalProperties": false, - "description": "An object that represents the configuration for Service Connect TLS.", - "properties": { - "IssuerCertificateAuthority": { - "$ref": "#/definitions/ServiceConnectTlsCertificateAuthority", - "description": "The signer certificate authority." - }, - "KmsKey": { - "description": "The AWS Key Management Service key.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.", - "type": "string" - } - }, - "required": [ - "IssuerCertificateAuthority" - ], - "type": "object" - }, - "ServiceManagedEBSVolumeConfiguration": { - "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.\n Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.", - "properties": { - "Encrypted": { - "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", - "type": "boolean" - }, - "FilesystemType": { - "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.\n The available filesystem types are\u2028 ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.", - "type": "string" - }, - "Iops": { - "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type.\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types.\n This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*.", - "type": "string" - }, - "SizeInGiB": { - "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n The following are the supported volume size values for each volume type.\n + ``gp2`` and ``gp3``: 1-16,384\n + ``io1`` and ``io2``: 4-16,384\n + ``st1`` and ``sc1``: 125-16,384\n + ``standard``: 1-1,024", - "type": "integer" - }, - "SnapshotId": { - "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", - "type": "string" - }, - "TagSpecifications": { - "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", - "items": { - "$ref": "#/definitions/EBSTagSpecification" - }, - "type": "array" - }, - "Throughput": { - "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n This parameter is only supported for the ``gp3`` volume type.", - "type": "integer" - }, - "VolumeType": { - "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.\n The following are the supported volume types.\n + General Purpose SSD: ``gp2``|``gp3`` \n + Provisioned IOPS SSD: ``io1``|``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n The magnetic volume type is not supported on Fargate.", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "ServiceRegistry": { - "additionalProperties": false, - "description": "The ``ServiceRegistry`` property specifies details of the service registry. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "ContainerName": { - "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", - "type": "string" - }, - "ContainerPort": { - "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", - "type": "integer" - }, - "Port": { - "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used.", - "type": "integer" - }, - "RegistryArn": { - "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).", - "type": "string" - } - }, - "type": "object" - }, - "ServiceVolumeConfiguration": { - "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", - "properties": { - "ManagedEBSVolume": { - "$ref": "#/definitions/ServiceManagedEBSVolumeConfiguration", - "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created." - }, - "Name": { - "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition.", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "properties": { - "Key": { - "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", - "type": "string" - }, - "Value": { - "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", - "type": "string" - } - }, - "type": "object" - }, - "TimeoutConfiguration": { - "additionalProperties": false, - "description": "An object that represents the timeout configurations for Service Connect.\n If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``.", - "properties": { - "IdleTimeoutSeconds": { - "description": "The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``.\n The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes.\n The ``idleTimeout`` default for ``TCP`` is 1 hour.", - "type": "integer" - }, - "PerRequestTimeoutSeconds": { - "description": "The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.\n The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.\n Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", - "handlers": { - "create": { - "permissions": [ - "ecs:CreateService", - "ecs:DescribeServices", - "iam:PassRole", - "ecs:TagResource" - ], - "timeoutInMinutes": 180 - }, - "delete": { - "permissions": [ - "ecs:DeleteService", - "ecs:DescribeServices" - ], - "timeoutInMinutes": 30 - }, - "list": { - "permissions": [ - "ecs:DescribeServices", - "ecs:ListClusters", - "ecs:ListServices" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeServices" - ] - }, - "update": { - "permissions": [ - "ecs:DescribeServices", - "ecs:ListTagsForResource", - "ecs:TagResource", - "ecs:UntagResource", - "ecs:UpdateService" - ], - "timeoutInMinutes": 180 - } - }, - "primaryIdentifier": [ - "/properties/ServiceArn", - "/properties/Cluster" - ], - "properties": { - "CapacityProviderStrategy": { - "description": "The capacity provider strategy to use for the service.\n If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.\n A capacity provider strategy may contain a maximum of 6 capacity providers.", - "items": { - "$ref": "#/definitions/CapacityProviderStrategyItem" - }, - "type": "array" - }, - "Cluster": { - "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.", - "type": "string" - }, - "DeploymentConfiguration": { - "$ref": "#/definitions/DeploymentConfiguration", - "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." - }, - "DeploymentController": { - "$ref": "#/definitions/DeploymentController", - "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used." - }, - "DesiredCount": { - "description": "The number of instantiations of the specified task definition to place and keep running in your service.\n For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.\n For existing services, if a desired count is not specified, it is omitted from the operation.", - "type": "integer" - }, - "EnableECSManagedTags": { - "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.\n When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.", - "type": "boolean" - }, - "EnableExecuteCommand": { - "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.", - "type": "boolean" - }, - "HealthCheckGracePeriodSeconds": { - "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.\n If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\n If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.", - "type": "integer" - }, - "LaunchType": { - "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", - "enum": [ - "EC2", - "FARGATE", - "EXTERNAL" - ], - "type": "string" - }, - "LoadBalancers": { - "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.", - "items": { - "$ref": "#/definitions/LoadBalancer" - }, - "type": "array" - }, - "Name": { - "description": "", - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration", - "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "PlacementConstraints": { - "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.", - "items": { - "$ref": "#/definitions/PlacementConstraint" - }, - "type": "array" - }, - "PlacementStrategies": { - "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.", - "items": { - "$ref": "#/definitions/PlacementStrategy" - }, - "type": "array" - }, - "PlatformVersion": { - "default": "LATEST", - "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "PropagateTags": { - "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.\n The default is ``NONE``.", - "enum": [ - "SERVICE", - "TASK_DEFINITION" - ], - "type": "string" - }, - "Role": { - "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.\n If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.", - "type": "string" - }, - "SchedulingStrategy": { - "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n There are two service scheduler strategies available:\n + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.\n + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.", - "enum": [ - "DAEMON", - "REPLICA" - ], - "type": "string" - }, - "ServiceArn": { - "description": "", - "type": "string" - }, - "ServiceConnectConfiguration": { - "$ref": "#/definitions/ServiceConnectConfiguration", - "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "ServiceName": { - "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.\n The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.", - "type": "string" - }, - "ServiceRegistries": { - "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n Each service may be associated with one service registry. Multiple service registries for each service isn't supported.", - "items": { - "$ref": "#/definitions/ServiceRegistry" - }, - "type": "array" - }, - "Tags": { - "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskDefinition": { - "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.\n A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.\n For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).", - "type": "string" - }, - "VolumeConfigurations": { - "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", - "items": { - "$ref": "#/definitions/ServiceVolumeConfiguration" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ServiceArn", - "/properties/Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ECS::Service", - "writeOnlyProperties": [ - "/properties/ServiceConnectConfiguration", - "/properties/VolumeConfigurations" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Cluster", + "/properties/DeploymentController", + "/properties/LaunchType", + "/properties/Role", + "/properties/SchedulingStrategy", + "/properties/ServiceName" + ], + "definitions": { + "AwsVpcConfiguration": { + "additionalProperties": false, + "description": "An object representing the networking details for a task or service. For example ``awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}``.", + "properties": { + "AssignPublicIp": { + "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "SecurityGroups": { + "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``awsvpcConfiguration``.\n All specified security groups must be from the same VPC.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Subnets": { + "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``awsvpcConfiguration``.\n All specified subnets must be from the same VPC.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CapacityProviderStrategyItem": { + "additionalProperties": false, + "description": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the ``RunTask`` or ``CreateService`` APIs or as the default capacity provider strategy for a cluster with the ``CreateCluster`` API.\n Only capacity providers that are already associated with a cluster and have an ``ACTIVE`` or ``UPDATING`` status can be used in a capacity provider strategy. The ``PutClusterCapacityProviders`` API is used to associate a capacity provider with a cluster.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the ``CreateCapacityProvider`` API operation.\n To use an FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.", + "properties": { + "Base": { + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", + "type": "integer" + }, + "CapacityProvider": { + "description": "The short name of the capacity provider.", + "type": "string" + }, + "Weight": { + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", + "type": "integer" + } + }, + "type": "object" + }, + "DeploymentAlarms": { + "additionalProperties": false, + "description": "One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.\n When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.\n You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update).\n For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "AlarmNames": { + "description": "One or more CloudWatch alarm names. Use a \",\" to separate the alarms.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Enable": { + "description": "Determines whether to use the CloudWatch alarm option in the service deployment process.", + "type": "boolean" + }, + "Rollback": { + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", + "type": "boolean" + } + }, + "required": [ + "AlarmNames", + "Rollback", + "Enable" + ], + "type": "object" + }, + "DeploymentCircuitBreaker": { + "additionalProperties": false, + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Enable": { + "description": "Determines whether to use the deployment circuit breaker logic for the service.", + "type": "boolean" + }, + "Rollback": { + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", + "type": "boolean" + } + }, + "required": [ + "Enable", + "Rollback" + ], + "type": "object" + }, + "DeploymentConfiguration": { + "additionalProperties": false, + "description": "Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.", + "properties": { + "Alarms": { + "$ref": "#/definitions/DeploymentAlarms", + "description": "Information about the CloudWatch alarms." + }, + "DeploymentCircuitBreaker": { + "$ref": "#/definitions/DeploymentCircuitBreaker", + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*" + }, + "MaximumPercent": { + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types, and tasks in the service use the EC2 launch type, the *maximum percent* value is set to the default value. The *maximum percent* value is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state.\n You can't specify a custom ``maximumPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type.\n If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.", + "type": "integer" + }, + "MinimumHealthyPercent": { + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. \n For services that *do not* use a load balancer, the following should be noted:\n + A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total.\n + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. \n \n For services that *do* use a load balancer, the following should be noted:\n + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n \n The default value for a replica service for ``minimumHealthyPercent`` is 100%. The default ``minimumHealthyPercent`` value for a service using the ``DAEMON`` service schedule is 0% for the CLI, the AWS SDKs, and the APIs and 50% for the AWS Management Console.\n The minimum number of healthy tasks during a deployment is the ``desiredCount`` multiplied by the ``minimumHealthyPercent``/100, rounded up to the nearest integer value.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value. The *minimum healthy percent* value is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state.\n You can't specify a custom ``minimumHealthyPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.", + "type": "integer" + } + }, + "type": "object" + }, + "DeploymentController": { + "additionalProperties": false, + "description": "The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Type": { + "description": "The deployment controller type to use. There are three deployment controller types available:\n + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.", + "enum": [ + "CODE_DEPLOY", + "ECS", + "EXTERNAL" + ], + "type": "string" + } + }, + "type": "object" + }, + "EBSTagSpecification": { + "additionalProperties": false, + "description": "The tag specifications of an Amazon EBS volume.", + "properties": { + "PropagateTags": { + "description": "Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in \u2028``ServiceVolumeConfiguration``. If no value is specified, the tags aren't \u2028propagated.", + "enum": [ + "SERVICE", + "TASK_DEFINITION" + ], + "type": "string" + }, + "ResourceType": { + "description": "The type of volume resource.", + "type": "string" + }, + "Tags": { + "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "ResourceType" + ], + "type": "object" + }, + "LoadBalancer": { + "additionalProperties": false, + "description": "The ``LoadBalancer`` property specifies details on a load balancer that is used with a service.\n If the service is using the ``CODE_DEPLOY`` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an ACDlong deployment group, you specify two target groups (referred to as a ``targetGroupPair``). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.\n Services with tasks that use the ``awsvpc`` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ``ip`` as the target type, not ``instance``. Tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance.", + "properties": { + "ContainerName": { + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.\n You need to specify the container name when configuring the target group for an Amazon ECS load balancer.", + "type": "string" + }, + "ContainerPort": { + "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping.", + "type": "integer" + }, + "LoadBalancerName": { + "description": "The name of the load balancer to associate with the Amazon ECS service or task set.\n If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.", + "type": "string" + }, + "TargetGroupArn": { + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.\n A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. \n For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*.\n For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.", + "type": "string" + } + }, + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the docker container create command and the ``--log-driver`` option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.", + "properties": { + "LogDriver": { + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Send Amazon ECS logs to an service or Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", + "type": "string" + }, + "Options": { + "additionalProperties": false, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "SecretOptions": { + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "description": "The network configuration for a task or service.", + "properties": { + "AwsvpcConfiguration": { + "$ref": "#/definitions/AwsVpcConfiguration", + "description": "The VPC subnets and security groups that are associated with a task.\n All specified subnets and security groups must be from the same VPC." + } + }, + "type": "object" + }, + "PlacementConstraint": { + "additionalProperties": false, + "description": "An object representing a constraint on task placement. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you're using the Fargate launch type, task placement constraints aren't supported.", + "properties": { + "Expression": { + "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "Type": { + "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.", + "enum": [ + "distinctInstance", + "memberOf" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "PlacementStrategy": { + "additionalProperties": false, + "description": "The task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Field": { + "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``cpu`` and ``memory``. For the ``random`` placement strategy, this field is not used.", + "type": "string" + }, + "Type": { + "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.", + "enum": [ + "binpack", + "random", + "spread" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Secret": { + "additionalProperties": false, + "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Name": { + "description": "The name of the secret.", + "type": "string" + }, + "ValueFrom": { + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", + "type": "string" + } + }, + "required": [ + "Name", + "ValueFrom" + ], + "type": "object" + }, + "ServiceConnectClientAlias": { + "additionalProperties": false, + "description": "Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "DnsName": { + "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.\n If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.\n To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "Port": { + "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "integer" + } + }, + "required": [ + "Port" + ], + "type": "object" + }, + "ServiceConnectConfiguration": { + "additionalProperties": false, + "description": "The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Enabled": { + "description": "Specifies whether to use Service Connect with this service.", + "type": "boolean" + }, + "LogConfiguration": { + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the docker container create command and the ``--log-driver`` option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." + }, + "Namespace": { + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", + "type": "string" + }, + "Services": { + "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. \n This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.\n An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service.", + "items": { + "$ref": "#/definitions/ServiceConnectService" + }, + "type": "array" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ServiceConnectService": { + "additionalProperties": false, + "description": "The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "ClientAliases": { + "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.\n Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``.", + "items": { + "$ref": "#/definitions/ServiceConnectClientAlias" + }, + "type": "array" + }, + "DiscoveryName": { + "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.", + "type": "string" + }, + "IngressPortOverride": { + "description": "The port number for the Service Connect proxy to listen on.\n Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.\n In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.", + "type": "integer" + }, + "PortName": { + "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service.", + "type": "string" + }, + "Timeout": { + "$ref": "#/definitions/TimeoutConfiguration", + "description": "A reference to an object that represents the configured timeouts for Service Connect." + }, + "Tls": { + "$ref": "#/definitions/ServiceConnectTlsConfiguration", + "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration." + } + }, + "required": [ + "PortName" + ], + "type": "object" + }, + "ServiceConnectTlsCertificateAuthority": { + "additionalProperties": false, + "description": "The certificate root authority that secures your service.", + "properties": { + "AwsPcaAuthorityArn": { + "description": "The ARN of the AWS Private Certificate Authority certificate.", + "type": "string" + } + }, + "type": "object" + }, + "ServiceConnectTlsConfiguration": { + "additionalProperties": false, + "description": "The key that encrypts and decrypts your resources for Service Connect TLS.", + "properties": { + "IssuerCertificateAuthority": { + "$ref": "#/definitions/ServiceConnectTlsCertificateAuthority", + "description": "The signer certificate authority." + }, + "KmsKey": { + "description": "The AWS Key Management Service key.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.", + "type": "string" + } + }, + "required": [ + "IssuerCertificateAuthority" + ], + "type": "object" + }, + "ServiceManagedEBSVolumeConfiguration": { + "additionalProperties": false, + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.\n Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.", + "properties": { + "Encrypted": { + "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", + "type": "boolean" + }, + "FilesystemType": { + "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.\n The available filesystem types are\u2028 ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.", + "type": "string" + }, + "Iops": { + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type.\n + ``gp3``: 3,000 - 16,000 IOPS\n + ``io1``: 100 - 64,000 IOPS\n + ``io2``: 100 - 256,000 IOPS\n \n This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types.\n This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*.", + "type": "string" + }, + "SizeInGiB": { + "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n The following are the supported volume size values for each volume type.\n + ``gp2`` and ``gp3``: 1-16,384\n + ``io1`` and ``io2``: 4-16,384\n + ``st1`` and ``sc1``: 125-16,384\n + ``standard``: 1-1,024", + "type": "integer" + }, + "SnapshotId": { + "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", + "type": "string" + }, + "TagSpecifications": { + "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", + "items": { + "$ref": "#/definitions/EBSTagSpecification" + }, + "type": "array" + }, + "Throughput": { + "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n This parameter is only supported for the ``gp3`` volume type.", + "type": "integer" + }, + "VolumeType": { + "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.\n The following are the supported volume types.\n + General Purpose SSD: ``gp2``|``gp3`` \n + Provisioned IOPS SSD: ``io1``|``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n The magnetic volume type is not supported on Fargate.", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "ServiceRegistry": { + "additionalProperties": false, + "description": "The details for the service registry.\n Each service may be associated with one service registry. Multiple service registries for each service are not supported.\n When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.", + "properties": { + "ContainerName": { + "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", + "type": "string" + }, + "ContainerPort": { + "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", + "type": "integer" + }, + "Port": { + "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used.", + "type": "integer" + }, + "RegistryArn": { + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).", + "type": "string" + } + }, + "type": "object" + }, + "ServiceVolumeConfiguration": { + "additionalProperties": false, + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", + "properties": { + "ManagedEBSVolume": { + "$ref": "#/definitions/ServiceManagedEBSVolumeConfiguration", + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created." + }, + "Name": { + "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "properties": { + "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", + "type": "string" + }, + "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", + "type": "string" + } + }, + "type": "object" + }, + "TimeoutConfiguration": { + "additionalProperties": false, + "description": "An object that represents the timeout configurations for Service Connect.\n If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``.", + "properties": { + "IdleTimeoutSeconds": { + "description": "The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``.\n The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes.\n The ``idleTimeout`` default for ``TCP`` is 1 hour.", + "type": "integer" + }, + "PerRequestTimeoutSeconds": { + "description": "The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.\n The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ``ServiceConnectConfiguration`` property the is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.\n Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", + "handlers": { + "create": { + "permissions": [ + "ecs:CreateService", + "ecs:DescribeServices", + "iam:PassRole", + "ecs:TagResource" + ], + "timeoutInMinutes": 180 + }, + "delete": { + "permissions": [ + "ecs:DeleteService", + "ecs:DescribeServices" + ], + "timeoutInMinutes": 30 + }, + "list": { + "permissions": [ + "ecs:DescribeServices", + "ecs:ListClusters", + "ecs:ListServices" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeServices" + ] + }, + "update": { + "permissions": [ + "ecs:DescribeServices", + "ecs:ListTagsForResource", + "ecs:TagResource", + "ecs:UntagResource", + "ecs:UpdateService" + ], + "timeoutInMinutes": 180 + } + }, + "primaryIdentifier": [ + "/properties/ServiceArn", + "/properties/Cluster" + ], + "properties": { + "CapacityProviderStrategy": { + "description": "The capacity provider strategy to use for the service.\n If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.\n A capacity provider strategy may contain a maximum of 6 capacity providers.", + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "type": "array" + }, + "Cluster": { + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.", + "type": "string" + }, + "DeploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." + }, + "DeploymentController": { + "$ref": "#/definitions/DeploymentController", + "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used." + }, + "DesiredCount": { + "description": "The number of instantiations of the specified task definition to place and keep running in your service.\n For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.\n For existing services, if a desired count is not specified, it is omitted from the operation.", + "type": "integer" + }, + "EnableECSManagedTags": { + "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.\n When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.", + "type": "boolean" + }, + "EnableExecuteCommand": { + "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.", + "type": "boolean" + }, + "HealthCheckGracePeriodSeconds": { + "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.\n If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\n If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.", + "type": "integer" + }, + "LaunchType": { + "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", + "enum": [ + "EC2", + "FARGATE", + "EXTERNAL" + ], + "type": "string" + }, + "LoadBalancers": { + "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "type": "array" + }, + "Name": { + "description": "", + "type": "string" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "PlacementConstraints": { + "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.", + "items": { + "$ref": "#/definitions/PlacementConstraint" + }, + "type": "array" + }, + "PlacementStrategies": { + "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.", + "items": { + "$ref": "#/definitions/PlacementStrategy" + }, + "type": "array" + }, + "PlatformVersion": { + "default": "LATEST", + "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "PropagateTags": { + "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.\n You must set this to a value other than ``NONE`` when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*.\n The default is ``NONE``.", + "enum": [ + "SERVICE", + "TASK_DEFINITION" + ], + "type": "string" + }, + "Role": { + "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.\n If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.", + "type": "string" + }, + "SchedulingStrategy": { + "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n There are two service scheduler strategies available:\n + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.\n + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.", + "enum": [ + "DAEMON", + "REPLICA" + ], + "type": "string" + }, + "ServiceArn": { + "description": "", + "type": "string" + }, + "ServiceConnectConfiguration": { + "$ref": "#/definitions/ServiceConnectConfiguration", + "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "ServiceName": { + "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.\n The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.", + "type": "string" + }, + "ServiceRegistries": { + "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n Each service may be associated with one service registry. Multiple service registries for each service isn't supported.", + "items": { + "$ref": "#/definitions/ServiceRegistry" + }, + "type": "array" + }, + "Tags": { + "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TaskDefinition": { + "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.\n A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.\n For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).", + "type": "string" + }, + "VolumeConfigurations": { + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", + "items": { + "$ref": "#/definitions/ServiceVolumeConfiguration" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ServiceArn", + "/properties/Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ECS::Service", + "writeOnlyProperties": [ + "/properties/ServiceConnectConfiguration", + "/properties/VolumeConfigurations" + ] +} diff --git a/schema/aws-ecs-taskdefinition.json b/schema/aws-ecs-taskdefinition.json index 83e8d94..5df5f2e 100644 --- a/schema/aws-ecs-taskdefinition.json +++ b/schema/aws-ecs-taskdefinition.json @@ -1,1134 +1,1161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Family", - "/properties/ContainerDefinitions", - "/properties/Cpu", - "/properties/ExecutionRoleArn", - "/properties/InferenceAccelerators", - "/properties/Memory", - "/properties/NetworkMode", - "/properties/PlacementConstraints", - "/properties/ProxyConfiguration", - "/properties/RequiresCompatibilities", - "/properties/RuntimePlatform", - "/properties/TaskRoleArn", - "/properties/Volumes", - "/properties/PidMode", - "/properties/IpcMode", - "/properties/EphemeralStorage" - ], - "definitions": { - "AuthorizationConfig": { - "additionalProperties": false, - "description": "The authorization configuration details for the Amazon EFS file system.", - "properties": { - "AccessPointId": { - "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*.", - "type": "string" - }, - "IAM": { - "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "ContainerDefinition": { - "additionalProperties": false, - "description": "The ``ContainerDefinition`` property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task.", - "properties": { - "Command": { - "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Cpu": { - "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value.\n You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version:\n + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n + *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.\n \n On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU.", - "type": "integer" - }, - "CredentialSpecs": { - "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1.\n There are two formats for each ARN.\n + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. \n In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.\n If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "DependsOn": { - "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ContainerDependency" - }, - "type": "array" - }, - "DisableNetworking": { - "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).\n This parameter is not supported for Windows containers.", - "type": "boolean" - }, - "DnsSearchDomains": { - "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "DnsServers": { - "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "DockerLabels": { - "additionalProperties": false, - "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "DockerSecurityOptions": { - "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type.\n For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.\n For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.\n This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). \n Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "EntryPoint": { - "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead.\n The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint).", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array", - "uniqueItems": true - }, - "EnvironmentFiles": { - "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/).\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EnvironmentFile" - }, - "type": "array" - }, - "Essential": { - "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "boolean" - }, - "ExtraHosts": { - "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HostEntry" - }, - "type": "array" - }, - "FirelensConfiguration": { - "$ref": "#/definitions/FirelensConfiguration", - "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "HealthCheck": { - "$ref": "#/definitions/HealthCheck", - "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." - }, - "Hostname": { - "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode.", - "type": "string" - }, - "Image": { - "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. \n + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).\n + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).\n + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``).", - "type": "string" - }, - "Interactive": { - "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", - "type": "boolean" - }, - "Links": { - "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.\n Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LinuxParameters": { - "$ref": "#/definitions/LinuxParameters", - "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n This parameter is not supported for Windows containers." - }, - "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration", - "description": "The log configuration specification for the container.\n This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "Memory": { - "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If using the Fargate launch type, this parameter is optional.\n If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.", - "type": "integer" - }, - "MemoryReservation": { - "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. \n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.", - "type": "integer" - }, - "MountPoints": { - "description": "The mount points for data volumes in your container.\n This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MountPoint" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", - "type": "string" - }, - "PortMappings": { - "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. \n This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PortMapping" - }, - "type": "array", - "uniqueItems": true - }, - "Privileged": { - "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers or tasks run on FARGATElong.", - "type": "boolean" - }, - "PseudoTerminal": { - "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", - "type": "boolean" - }, - "RepositoryCredentials": { - "$ref": "#/definitions/RepositoryCredentials", - "description": "The private repository authentication credentials to use." - }, - "ResourceRequirements": { - "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceRequirement" - }, - "type": "array" - }, - "Secrets": { - "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array" - }, - "StartTimeout": { - "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state.\n When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds.", - "type": "integer" - }, - "StopTimeout": { - "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds.", - "type": "integer" - }, - "SystemControls": { - "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SystemControl" - }, - "type": "array" - }, - "Ulimits": { - "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n This parameter is not supported for Windows containers.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ulimit" - }, - "type": "array" - }, - "User": { - "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n + ``user`` \n + ``user:group`` \n + ``uid`` \n + ``uid:gid`` \n + ``user:gid`` \n + ``uid:group`` \n \n This parameter is not supported for Windows containers.", - "type": "string" - }, - "VolumesFrom": { - "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VolumeFrom" - }, - "type": "array", - "uniqueItems": true - }, - "WorkingDirectory": { - "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", - "type": "string" - } - }, - "required": [ - "Name", - "Image" - ], - "type": "object" - }, - "ContainerDependency": { - "additionalProperties": false, - "description": "The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.", - "properties": { - "Condition": { - "description": "The dependency condition of the container. The following are the available conditions and their behavior:\n + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.\n + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.", - "type": "string" - }, - "ContainerName": { - "description": "The name of a container.", - "type": "string" - } - }, - "type": "object" - }, - "Device": { - "additionalProperties": false, - "description": "The ``Device`` property specifies an object representing a container instance host device.", - "properties": { - "ContainerPath": { - "description": "The path inside the container at which to expose the host device.", - "type": "string" - }, - "HostPath": { - "description": "The path for the device on the host container instance.", - "type": "string" - }, - "Permissions": { - "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "DockerVolumeConfiguration": { - "additionalProperties": false, - "description": "The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead.", - "properties": { - "Autoprovision": { - "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist.\n This field is only used if the ``scope`` is ``shared``.", - "type": "boolean" - }, - "Driver": { - "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", - "type": "string" - }, - "DriverOpts": { - "additionalProperties": false, - "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Labels": { - "additionalProperties": false, - "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Scope": { - "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops.", - "type": "string" - } - }, - "type": "object" - }, - "EFSVolumeConfiguration": { - "additionalProperties": false, - "description": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/AuthorizationConfig", - "description": "The authorization configuration details for the Amazon EFS file system." - }, - "FilesystemId": { - "description": "The Amazon EFS file system ID to use.", - "type": "string" - }, - "RootDirectory": { - "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter.\n If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point.", - "type": "string" - }, - "TransitEncryption": { - "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "TransitEncryptionPort": { - "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*.", - "type": "integer" - } - }, - "required": [ - "FilesystemId" - ], - "type": "object" - }, - "EnvironmentFile": { - "additionalProperties": false, - "description": "A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*.\n Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. \n You must use the following platforms for the Fargate launch type:\n + Linux platform version ``1.4.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n Consider the following when using the Fargate launch type:\n + The file is handled like a native Docker env-file.\n + There is no support for shell escape handling.\n + The container entry point interperts the ``VARIABLE`` values.", - "properties": { - "Type": { - "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``.", - "type": "string" - }, - "Value": { - "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.", - "type": "string" - } - }, - "type": "object" - }, - "EphemeralStorage": { - "additionalProperties": false, - "description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*.\n For tasks using the Fargate launch type, the task requires the following platforms:\n + Linux platform version ``1.4.0`` or later.\n + Windows platform version ``1.0.0`` or later.", - "properties": { - "SizeInGiB": { - "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB.", - "type": "integer" - } - }, - "type": "object" - }, - "FSxAuthorizationConfig": { - "additionalProperties": false, - "description": "", - "properties": { - "CredentialsParameter": { - "description": "", - "type": "string" - }, - "Domain": { - "description": "", - "type": "string" - } - }, - "required": [ - "CredentialsParameter", - "Domain" - ], - "type": "object" - }, - "FSxWindowsFileServerVolumeConfiguration": { - "additionalProperties": false, - "description": "This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.\n For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/FSxAuthorizationConfig", - "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." - }, - "FileSystemId": { - "description": "The Amazon FSx for Windows File Server file system ID to use.", - "type": "string" - }, - "RootDirectory": { - "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.", - "type": "string" - } - }, - "required": [ - "FileSystemId", - "RootDirectory" - ], - "type": "object" - }, - "FirelensConfiguration": { - "additionalProperties": false, - "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Options": { - "additionalProperties": false, - "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n If specified, valid option keys are:\n + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` \n + ``config-file-type``, which can be ``s3`` or ``file`` \n + ``config-file-value``, which is either an S3 ARN or a file path", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``.", - "type": "string" - } - }, - "type": "object" - }, - "HealthCheck": { - "additionalProperties": false, - "description": "The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/).\n The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.\n If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.\n The following are notes about container health check support:\n + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\n + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\n + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.", - "properties": { - "Command": { - "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. \n When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.\n ``[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`` \n You don't include the double quotes and brackets when you use the AWS Management Console.\n ``CMD-SHELL, curl -f http://localhost/ || exit 1`` \n An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Interval": { - "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.", - "type": "integer" - }, - "Retries": { - "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.", - "type": "integer" - }, - "StartPeriod": { - "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off.\n If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.", - "type": "integer" - }, - "Timeout": { - "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.", - "type": "integer" - } - }, - "type": "object" - }, - "HostEntry": { - "additionalProperties": false, - "description": "The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource.", - "properties": { - "Hostname": { - "description": "The hostname to use in the ``/etc/hosts`` entry.", - "type": "string" - }, - "IpAddress": { - "description": "The IP address to use in the ``/etc/hosts`` entry.", - "type": "string" - } - }, - "type": "object" - }, - "HostVolumeProperties": { - "additionalProperties": false, - "description": "The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.", - "properties": { - "SourcePath": { - "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported.", - "type": "string" - } - }, - "type": "object" - }, - "InferenceAccelerator": { - "additionalProperties": false, - "description": "Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "DeviceName": { - "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).", - "type": "string" - }, - "DeviceType": { - "description": "The Elastic Inference accelerator type to use.", - "type": "string" - } - }, - "type": "object" - }, - "KernelCapabilities": { - "additionalProperties": false, - "description": "The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.", - "properties": { - "Add": { - "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Drop": { - "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "KeyValuePair": { - "additionalProperties": false, - "description": "A key-value pair object.", - "properties": { - "Name": { - "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable.", - "type": "string" - }, - "Value": { - "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable.", - "type": "string" - } - }, - "type": "object" - }, - "LinuxParameters": { - "additionalProperties": false, - "description": "The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).", - "properties": { - "Capabilities": { - "$ref": "#/definitions/KernelCapabilities", - "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.\n For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later." - }, - "Devices": { - "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Device" - }, - "type": "array" - }, - "InitProcessEnabled": { - "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", - "type": "boolean" - }, - "MaxSwap": { - "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value.\n If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.\n If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", - "type": "integer" - }, - "SharedMemorySize": { - "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported.", - "type": "integer" - }, - "Swappiness": { - "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", - "type": "integer" - }, - "Tmpfs": { - "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tmpfs" - }, - "type": "array" - } - }, - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "description": "The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.", - "properties": { - "LogDriver": { - "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", - "type": "string" - }, - "Options": { - "additionalProperties": false, - "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "SecretOptions": { - "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array" - } - }, - "required": [ - "LogDriver" - ], - "type": "object" - }, - "MountPoint": { - "additionalProperties": false, - "description": "The details for a volume mount point that's used in a container definition.", - "properties": { - "ContainerPath": { - "description": "The path on the container to mount the host volume at.", - "type": "string" - }, - "ReadOnly": { - "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", - "type": "boolean" - }, - "SourceVolume": { - "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``.", - "type": "string" - } - }, - "type": "object" - }, - "PortMapping": { - "additionalProperties": false, - "description": "The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.\n If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.", - "properties": { - "AppProtocol": { - "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "enum": [ - "http", - "http2", - "grpc" - ], - "type": "string" - }, - "ContainerPort": { - "description": "The port number on the container that's bound to the user-specified or automatically assigned host port.\n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.", - "type": "integer" - }, - "ContainerPortRange": { - "description": "The port number range on the container that's bound to the dynamically mapped host port range. \n The following rules apply when you specify a ``containerPortRange``:\n + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode.\n + This parameter is available for both the EC2 and FARGATElong launch types.\n + This parameter is available for both the Linux and Windows operating systems.\n + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package \n + You can specify a maximum of 100 port ranges per container.\n + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.\n \n + The ``containerPortRange`` valid values are between 1 and 65535.\n + A port can only be included in one port mapping per container.\n + You cannot specify overlapping port ranges.\n + The first port in the range must be less than last port in the range.\n + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.\n For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.\n For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*.\n \n You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports.", - "type": "string" - }, - "HostPort": { - "description": "The port number on the container instance to reserve for your container.\n If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.\n \n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.", - "type": "integer" - }, - "Name": { - "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Protocol": { - "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.", - "type": "string" - } - }, - "type": "object" - }, - "ProxyConfiguration": { - "additionalProperties": false, - "description": "The configuration details for the App Mesh proxy.\n For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)", - "properties": { - "ContainerName": { - "description": "The name of the container that will serve as the App Mesh proxy.", - "type": "string" - }, - "ProxyConfigurationProperties": { - "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.\n + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty.\n + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.\n + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.\n + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.\n + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.\n + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.\n + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KeyValuePair" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The proxy type. The only supported value is ``APPMESH``.", - "type": "string" - } - }, - "required": [ - "ContainerName" - ], - "type": "object" - }, - "RepositoryCredentials": { - "additionalProperties": false, - "description": "The repository credentials for private registry authentication.", - "properties": { - "CredentialsParameter": { - "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.\n When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.", - "type": "string" - } - }, - "type": "object" - }, - "ResourceRequirement": { - "additionalProperties": false, - "description": "The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*", - "properties": { - "Type": { - "description": "The type of resource to assign to a container.", - "type": "string" - }, - "Value": { - "description": "The value for the specified resource type.\n When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition.", - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "RuntimePlatform": { - "additionalProperties": false, - "description": "Information about the platform for the Amazon ECS service or task.\n For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "CpuArchitecture": { - "description": "The CPU architecture.\n You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.", - "type": "string" - }, - "OperatingSystemFamily": { - "description": "The operating system.", - "type": "string" - } - }, - "type": "object" - }, - "Secret": { - "additionalProperties": false, - "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", - "properties": { - "Name": { - "description": "The name of the secret.", - "type": "string" - }, - "ValueFrom": { - "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", - "type": "string" - } - }, - "required": [ - "Name", - "ValueFrom" - ], - "type": "object" - }, - "SystemControl": { - "additionalProperties": false, - "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.\n We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages:\n + For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect.\n + For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported.\n \n If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\n + For tasks that use the ``host`` IPC mode, IPC namespace ``systemControls`` aren't supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task.\n \n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", - "properties": { - "Namespace": { - "description": "The namespaced kernel parameter to set a ``value`` for.", - "type": "string" - }, - "Value": { - "description": "The namespaced kernel parameter to set a ``value`` for.\n Valid IPC namespace values: ``\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"``, and ``Sysctls`` that start with ``\"fs.mqueue.*\"`` \n Valid network namespace values: ``Sysctls`` that start with ``\"net.*\"`` \n All of these values are supported by Fargate.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "properties": { - "Key": { - "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", - "type": "string" - }, - "Value": { - "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", - "type": "string" - } - }, - "type": "object" - }, - "TaskDefinitionPlacementConstraint": { - "additionalProperties": false, - "description": "The constraint on task placement in the task definition. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.\n Task placement constraints aren't supported for tasks run on FARGATElong.", - "properties": { - "Expression": { - "description": "A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Type": { - "description": "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates.", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Tmpfs": { - "additionalProperties": false, - "description": "The container path, mount options, and size of the tmpfs mount.", - "properties": { - "ContainerPath": { - "description": "The absolute file path where the tmpfs volume is to be mounted.", - "type": "string" - }, - "MountOptions": { - "description": "The list of tmpfs volume mount options.\n Valid values: ``\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"``", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Size": { - "description": "The maximum size (in MiB) of the tmpfs volume.", - "type": "integer" - } - }, - "required": [ - "Size" - ], - "type": "object" - }, - "Ulimit": { - "additionalProperties": false, - "description": "The ``ulimit`` settings to pass to the container.\n Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``65535`` and the default hard limit is ``65535``.\n You can specify the ``ulimit`` settings for a container in a task definition.", - "properties": { - "HardLimit": { - "description": "The hard limit for the ``ulimit`` type.", - "type": "integer" - }, - "Name": { - "description": "The ``type`` of the ``ulimit``.", - "type": "string" - }, - "SoftLimit": { - "description": "The soft limit for the ``ulimit`` type.", - "type": "integer" - } - }, - "required": [ - "HardLimit", - "Name", - "SoftLimit" - ], - "type": "object" - }, - "Volume": { - "additionalProperties": false, - "description": "The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).", - "properties": { - "ConfiguredAtLaunch": { - "description": "Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.\n To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs.", - "type": "boolean" - }, - "DockerVolumeConfiguration": { - "$ref": "#/definitions/DockerVolumeConfiguration", - "description": "This parameter is specified when you use Docker volumes.\n Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead.\n Docker volumes aren't supported by tasks run on FARGATElong." - }, - "EFSVolumeConfiguration": { - "$ref": "#/definitions/EFSVolumeConfiguration", - "description": "This parameter is specified when you use an Amazon Elastic File System file system for task storage." - }, - "FSxWindowsFileServerVolumeConfiguration": { - "$ref": "#/definitions/FSxWindowsFileServerVolumeConfiguration", - "description": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage." - }, - "Host": { - "$ref": "#/definitions/HostVolumeProperties", - "description": "This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``." - }, - "Name": { - "description": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.\n When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task.\n For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition.\n When a volume is using the ``efsVolumeConfiguration``, the name is required.", - "type": "string" - } - }, - "type": "object" - }, - "VolumeFrom": { - "additionalProperties": false, - "description": "Details on a data volume from another container in the same task definition.", - "properties": { - "ReadOnly": { - "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", - "type": "boolean" - }, - "SourceContainer": { - "description": "The name of another container within the same task definition to mount volumes from.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.\n You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.", - "handlers": { - "create": { - "permissions": [ - "ecs:RegisterTaskDefinition", - "ecs:DescribeTaskDefinition", - "ecs:TagResource", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "ecs:DeregisterTaskDefinition", - "ecs:DescribeTaskDefinition", - "iam:GetRole", - "iam:PassRole" - ] - }, - "list": { - "permissions": [ - "ecs:ListTaskDefinitions", - "ecs:DescribeTaskDefinition" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeTaskDefinition" - ] - }, - "update": { - "permissions": [ - "ecs:TagResource", - "ecs:UntagResource", - "ecs:ListTagsForResource", - "ecs:DescribeTaskDefinition", - "iam:GetRole", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/TaskDefinitionArn" - ], - "properties": { - "ContainerDefinitions": { - "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ContainerDefinition" - }, - "type": "array", - "uniqueItems": true - }, - "Cpu": { - "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later.", - "type": "string" - }, - "EphemeralStorage": { - "$ref": "#/definitions/EphemeralStorage", - "description": "The ephemeral storage settings to use for tasks run with the task definition." - }, - "ExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Family": { - "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.", - "type": "string" - }, - "InferenceAccelerators": { - "description": "The Elastic Inference accelerators to use for the containers in the task.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InferenceAccelerator" - }, - "type": "array", - "uniqueItems": true - }, - "IpcMode": { - "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.\n If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.\n \n This parameter is not supported for Windows containers or tasks run on FARGATElong.", - "type": "string" - }, - "Memory": { - "description": "The amount (in MiB) of memory used by the task.\n If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).\n If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.\n + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)\n + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)\n + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)\n + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)\n + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)\n + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)\n This option requires Linux platform ``1.4.0`` or later.\n + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)\n This option requires Linux platform ``1.4.0`` or later.", - "type": "string" - }, - "NetworkMode": { - "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.\n For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.\n With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. \n When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.\n If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.\n For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.", - "type": "string" - }, - "PidMode": { - "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.\n If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.\n If ``task`` is specified, all containers within the specified task share the same process namespace.\n If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.\n If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", - "type": "string" - }, - "PlacementConstraints": { - "description": "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TaskDefinitionPlacementConstraint" - }, - "type": "array", - "uniqueItems": true - }, - "ProxyConfiguration": { - "$ref": "#/definitions/ProxyConfiguration", - "description": "The configuration details for the App Mesh proxy.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*." - }, - "RequiresCompatibilities": { - "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "RuntimePlatform": { - "$ref": "#/definitions/RuntimePlatform", - "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type." - }, - "Tags": { - "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskDefinitionArn": { - "description": "", - "type": "string" - }, - "TaskRoleArn": { - "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.", - "type": "string" - }, - "Volumes": { - "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.\n The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Volume" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/TaskRoleArn": "TaskRoleArn $OR $split(TaskRoleArn, \"role/\")[-1]" - }, - "readOnlyProperties": [ - "/properties/TaskDefinitionArn" - ], - "sourceUrl": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ECS::TaskDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Family", + "/properties/ContainerDefinitions", + "/properties/Cpu", + "/properties/ExecutionRoleArn", + "/properties/InferenceAccelerators", + "/properties/Memory", + "/properties/NetworkMode", + "/properties/PlacementConstraints", + "/properties/ProxyConfiguration", + "/properties/RequiresCompatibilities", + "/properties/RuntimePlatform", + "/properties/TaskRoleArn", + "/properties/Volumes", + "/properties/PidMode", + "/properties/IpcMode", + "/properties/EphemeralStorage" + ], + "definitions": { + "AuthorizationConfig": { + "additionalProperties": false, + "description": "The authorization configuration details for the Amazon EFS file system.", + "properties": { + "AccessPointId": { + "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*.", + "type": "string" + }, + "IAM": { + "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "ContainerDefinition": { + "additionalProperties": false, + "description": "The ``ContainerDefinition`` property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task.", + "properties": { + "Command": { + "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the docker container create command and the ``COMMAND`` parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Cpu": { + "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the docker container create commandand the ``--cpu-shares`` option to docker run.\n This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value.\n You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version:\n + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n + *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.\n \n On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU.", + "type": "integer" + }, + "CredentialSpecs": { + "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1.\n There are two formats for each ARN.\n + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. \n In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.\n If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "DependsOn": { + "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerDependency" + }, + "type": "array" + }, + "DisableNetworking": { + "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the docker container create command.\n This parameter is not supported for Windows containers.", + "type": "boolean" + }, + "DnsSearchDomains": { + "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the docker container create command and the ``--dns-search`` option to docker run.\n This parameter is not supported for Windows containers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "DnsServers": { + "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the docker container create command and the ``--dns`` option to docker run.\n This parameter is not supported for Windows containers.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "DockerLabels": { + "additionalProperties": false, + "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the docker container create command and the ``--label`` option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "DockerSecurityOptions": { + "description": "A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.\n For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.\n For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.\n This parameter maps to ``SecurityOpt`` in the docker container create command and the ``--security-opt`` option to docker run.\n The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "EntryPoint": { + "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead.\n The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in tthe docker container create command and the ``--entrypoint`` option to docker run.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Environment": { + "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the docker container create command and the ``--env`` option to docker run.\n We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array", + "uniqueItems": true + }, + "EnvironmentFiles": { + "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to docker run.\n You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EnvironmentFile" + }, + "type": "array" + }, + "Essential": { + "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "boolean" + }, + "ExtraHosts": { + "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the docker container create command and the ``--add-host`` option to docker run.\n This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HostEntry" + }, + "type": "array" + }, + "FirelensConfiguration": { + "$ref": "#/definitions/FirelensConfiguration", + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "HealthCheck": { + "$ref": "#/definitions/HealthCheck", + "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the docker container create command and the ``HEALTHCHECK`` parameter of docker run." + }, + "Hostname": { + "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in thethe docker container create command and the ``--hostname`` option to docker run.\n The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode.", + "type": "string" + }, + "Image": { + "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the docker container create command and the ``IMAGE`` parameter of docker run.\n + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. \n + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).\n + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).\n + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``).", + "type": "string" + }, + "Interactive": { + "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the docker container create command and the ``--interactive`` option to docker run.", + "type": "boolean" + }, + "Links": { + "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to ``Links`` in the docker container create command and the ``--link`` option to docker run.\n This parameter is not supported for Windows containers.\n Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LinuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n This parameter is not supported for Windows containers." + }, + "LogConfiguration": { + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration specification for the container.\n This parameter maps to ``LogConfig`` in the docker Create a container command and the ``--log-driver`` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Developer Guide*." + }, + "Memory": { + "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If using the Fargate launch type, this parameter is optional.\n If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.", + "type": "integer" + }, + "MemoryReservation": { + "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the docker container create command and the ``--memory-reservation`` option to docker run.\n If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. \n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.", + "type": "integer" + }, + "MountPoints": { + "description": "The mount points for data volumes in your container.\n This parameter maps to ``Volumes`` in the docker container create command and the ``--volume`` option to docker run.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MountPoint" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in tthe docker container create command and the ``--name`` option to docker run.", + "type": "string" + }, + "PortMappings": { + "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. \n This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PortMapping" + }, + "type": "array", + "uniqueItems": true + }, + "Privileged": { + "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the docker container create command and the ``--privileged`` option to docker run\n This parameter is not supported for Windows containers or tasks run on FARGATElong.", + "type": "boolean" + }, + "PseudoTerminal": { + "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in tthe docker container create command and the ``--tty`` option to docker run.", + "type": "boolean" + }, + "ReadonlyRootFilesystem": { + "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the docker container create command and the ``--read-only`` option to docker run.\n This parameter is not supported for Windows containers.", + "type": "boolean" + }, + "RepositoryCredentials": { + "$ref": "#/definitions/RepositoryCredentials", + "description": "The private repository authentication credentials to use." + }, + "ResourceRequirements": { + "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceRequirement" + }, + "type": "array" + }, + "RestartPolicy": { + "$ref": "#/definitions/RestartPolicy", + "description": "The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Secrets": { + "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array" + }, + "StartTimeout": { + "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state.\n When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values for Fargate are 2-120 seconds.", + "type": "integer" + }, + "StopTimeout": { + "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds.", + "type": "integer" + }, + "SystemControls": { + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in tthe docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SystemControl" + }, + "type": "array" + }, + "Ulimits": { + "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n This parameter is not supported for Windows containers.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Ulimit" + }, + "type": "array" + }, + "User": { + "description": "The user to use inside the container. This parameter maps to ``User`` in the docker container create command and the ``--user`` option to docker run.\n When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n + ``user`` \n + ``user:group`` \n + ``uid`` \n + ``uid:gid`` \n + ``user:gid`` \n + ``uid:group`` \n \n This parameter is not supported for Windows containers.", + "type": "string" + }, + "VolumesFrom": { + "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in tthe docker container create command and the ``--volumes-from`` option to docker run.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VolumeFrom" + }, + "type": "array", + "uniqueItems": true + }, + "WorkingDirectory": { + "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the docker container create command and the ``--workdir`` option to docker run.", + "type": "string" + } + }, + "required": [ + "Name", + "Image" + ], + "type": "object" + }, + "ContainerDependency": { + "additionalProperties": false, + "description": "The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.", + "properties": { + "Condition": { + "description": "The dependency condition of the container. The following are the available conditions and their behavior:\n + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.\n + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.", + "type": "string" + }, + "ContainerName": { + "description": "The name of a container.", + "type": "string" + } + }, + "type": "object" + }, + "Device": { + "additionalProperties": false, + "description": "The ``Device`` property specifies an object representing a container instance host device.", + "properties": { + "ContainerPath": { + "description": "The path inside the container at which to expose the host device.", + "type": "string" + }, + "HostPath": { + "description": "The path for the device on the host container instance.", + "type": "string" + }, + "Permissions": { + "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "DockerVolumeConfiguration": { + "additionalProperties": false, + "description": "The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead.", + "properties": { + "Autoprovision": { + "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist.\n This field is only used if the ``scope`` is ``shared``.", + "type": "boolean" + }, + "Driver": { + "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to ``Driver`` in the docker container create command and the ``xxdriver`` option to docker volume create.", + "type": "string" + }, + "DriverOpts": { + "additionalProperties": false, + "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the docker create-volume command and the ``xxopt`` option to docker volume create.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Labels": { + "additionalProperties": false, + "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the docker container create command and the ``xxlabel`` option to docker volume create.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Scope": { + "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops.", + "type": "string" + } + }, + "type": "object" + }, + "EFSVolumeConfiguration": { + "additionalProperties": false, + "description": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "AuthorizationConfig": { + "$ref": "#/definitions/AuthorizationConfig", + "description": "The authorization configuration details for the Amazon EFS file system." + }, + "FilesystemId": { + "description": "The Amazon EFS file system ID to use.", + "type": "string" + }, + "RootDirectory": { + "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter.\n If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point.", + "type": "string" + }, + "TransitEncryption": { + "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "TransitEncryptionPort": { + "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*.", + "type": "integer" + } + }, + "required": [ + "FilesystemId" + ], + "type": "object" + }, + "EnvironmentFile": { + "additionalProperties": false, + "description": "A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*.\n Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. \n You must use the following platforms for the Fargate launch type:\n + Linux platform version ``1.4.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n Consider the following when using the Fargate launch type:\n + The file is handled like a native Docker env-file.\n + There is no support for shell escape handling.\n + The container entry point interperts the ``VARIABLE`` values.", + "properties": { + "Type": { + "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``.", + "type": "string" + }, + "Value": { + "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.", + "type": "string" + } + }, + "type": "object" + }, + "EphemeralStorage": { + "additionalProperties": false, + "description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*.\n For tasks using the Fargate launch type, the task requires the following platforms:\n + Linux platform version ``1.4.0`` or later.\n + Windows platform version ``1.0.0`` or later.", + "properties": { + "SizeInGiB": { + "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB.", + "type": "integer" + } + }, + "type": "object" + }, + "FSxAuthorizationConfig": { + "additionalProperties": false, + "description": "The authorization configuration details for Amazon FSx for Windows File Server file system. See [FSxWindowsFileServerVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the *Amazon ECS API Reference*.\n For more information and the input format, see [Amazon FSx for Windows File Server Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "CredentialsParameter": { + "description": "The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an ASMlong secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.", + "type": "string" + }, + "Domain": { + "description": "A fully qualified domain name hosted by an [](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.", + "type": "string" + } + }, + "required": [ + "CredentialsParameter", + "Domain" + ], + "type": "object" + }, + "FSxWindowsFileServerVolumeConfiguration": { + "additionalProperties": false, + "description": "This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.\n For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "AuthorizationConfig": { + "$ref": "#/definitions/FSxAuthorizationConfig", + "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." + }, + "FileSystemId": { + "description": "The Amazon FSx for Windows File Server file system ID to use.", + "type": "string" + }, + "RootDirectory": { + "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.", + "type": "string" + } + }, + "required": [ + "FileSystemId", + "RootDirectory" + ], + "type": "object" + }, + "FirelensConfiguration": { + "additionalProperties": false, + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Options": { + "additionalProperties": false, + "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n If specified, valid option keys are:\n + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` \n + ``config-file-type``, which can be ``s3`` or ``file`` \n + ``config-file-value``, which is either an S3 ARN or a file path", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``.", + "type": "string" + } + }, + "type": "object" + }, + "HealthCheck": { + "additionalProperties": false, + "description": "The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of docker run.\n The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.\n If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.\n The following are notes about container health check support:\n + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\n + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\n + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.", + "properties": { + "Command": { + "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. \n When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.\n ``[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`` \n You don't include the double quotes and brackets when you use the AWS Management Console.\n ``CMD-SHELL, curl -f http://localhost/ || exit 1`` \n An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in tthe docker container create command", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Interval": { + "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.", + "type": "integer" + }, + "Retries": { + "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.", + "type": "integer" + }, + "StartPeriod": { + "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off.\n If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.", + "type": "integer" + }, + "Timeout": { + "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.", + "type": "integer" + } + }, + "type": "object" + }, + "HostEntry": { + "additionalProperties": false, + "description": "The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource.", + "properties": { + "Hostname": { + "description": "The hostname to use in the ``/etc/hosts`` entry.", + "type": "string" + }, + "IpAddress": { + "description": "The IP address to use in the ``/etc/hosts`` entry.", + "type": "string" + } + }, + "type": "object" + }, + "HostVolumeProperties": { + "additionalProperties": false, + "description": "The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.", + "properties": { + "SourcePath": { + "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported.", + "type": "string" + } + }, + "type": "object" + }, + "InferenceAccelerator": { + "additionalProperties": false, + "description": "Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "DeviceName": { + "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).", + "type": "string" + }, + "DeviceType": { + "description": "The Elastic Inference accelerator type to use.", + "type": "string" + } + }, + "type": "object" + }, + "KernelCapabilities": { + "additionalProperties": false, + "description": "The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.", + "properties": { + "Add": { + "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the docker container create command and the ``--cap-add`` option to docker run.\n Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Drop": { + "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the docker container create command and the ``--cap-drop`` option to docker run.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "KeyValuePair": { + "additionalProperties": false, + "description": "A key-value pair object.", + "properties": { + "Name": { + "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable.", + "type": "string" + }, + "Value": { + "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable.", + "type": "string" + } + }, + "type": "object" + }, + "LinuxParameters": { + "additionalProperties": false, + "description": "The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).", + "properties": { + "Capabilities": { + "$ref": "#/definitions/KernelCapabilities", + "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.\n For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later." + }, + "Devices": { + "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in tthe docker container create command and the ``--device`` option to docker run.\n If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Device" + }, + "type": "array" + }, + "InitProcessEnabled": { + "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", + "type": "boolean" + }, + "MaxSwap": { + "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to docker run where the value would be the sum of the container memory plus the ``maxSwap`` value.\n If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.\n If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", + "type": "integer" + }, + "SharedMemorySize": { + "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to docker run.\n If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported.", + "type": "integer" + }, + "Swappiness": { + "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to docker run.\n If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", + "type": "integer" + }, + "Tmpfs": { + "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to docker run.\n If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tmpfs" + }, + "type": "array" + } + }, + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "description": "The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.", + "properties": { + "LogDriver": { + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Send Amazon ECS logs to an service or Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", + "type": "string" + }, + "Options": { + "additionalProperties": false, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "SecretOptions": { + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Secret" + }, + "type": "array" + } + }, + "required": [ + "LogDriver" + ], + "type": "object" + }, + "MountPoint": { + "additionalProperties": false, + "description": "The details for a volume mount point that's used in a container definition.", + "properties": { + "ContainerPath": { + "description": "The path on the container to mount the host volume at.", + "type": "string" + }, + "ReadOnly": { + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", + "type": "boolean" + }, + "SourceVolume": { + "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``.", + "type": "string" + } + }, + "type": "object" + }, + "PortMapping": { + "additionalProperties": false, + "description": "The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.\n If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.", + "properties": { + "AppProtocol": { + "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "enum": [ + "http", + "http2", + "grpc" + ], + "type": "string" + }, + "ContainerPort": { + "description": "The port number on the container that's bound to the user-specified or automatically assigned host port.\n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.", + "type": "integer" + }, + "ContainerPortRange": { + "description": "The port number range on the container that's bound to the dynamically mapped host port range. \n The following rules apply when you specify a ``containerPortRange``:\n + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode.\n + This parameter is available for both the EC2 and FARGATElong launch types.\n + This parameter is available for both the Linux and Windows operating systems.\n + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package \n + You can specify a maximum of 100 port ranges per container.\n + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.\n \n + The ``containerPortRange`` valid values are between 1 and 65535.\n + A port can only be included in one port mapping per container.\n + You cannot specify overlapping port ranges.\n + The first port in the range must be less than last port in the range.\n + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.\n For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.\n For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*.\n \n You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports.", + "type": "string" + }, + "HostPort": { + "description": "The port number on the container instance to reserve for your container.\n If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.\n \n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.", + "type": "integer" + }, + "Name": { + "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "Protocol": { + "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.", + "type": "string" + } + }, + "type": "object" + }, + "ProxyConfiguration": { + "additionalProperties": false, + "description": "The configuration details for the App Mesh proxy.\n For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)", + "properties": { + "ContainerName": { + "description": "The name of the container that will serve as the App Mesh proxy.", + "type": "string" + }, + "ProxyConfigurationProperties": { + "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.\n + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty.\n + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.\n + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.\n + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.\n + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.\n + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.\n + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The proxy type. The only supported value is ``APPMESH``.", + "type": "string" + } + }, + "required": [ + "ContainerName" + ], + "type": "object" + }, + "RepositoryCredentials": { + "additionalProperties": false, + "description": "The repository credentials for private registry authentication.", + "properties": { + "CredentialsParameter": { + "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.\n When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceRequirement": { + "additionalProperties": false, + "description": "The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*", + "properties": { + "Type": { + "description": "The type of resource to assign to a container.", + "type": "string" + }, + "Value": { + "description": "The value for the specified resource type.\n When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition.", + "type": "string" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "RestartPolicy": { + "additionalProperties": false, + "description": "You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability. When you enable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Enabled": { + "description": "Specifies whether a restart policy is enabled for the container.", + "type": "boolean" + }, + "IgnoredExitCodes": { + "description": "A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.", + "insertionOrder": false, + "items": { + "type": "integer" + }, + "type": "array" + }, + "RestartAttemptPeriod": { + "description": "A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every ``restartAttemptPeriod`` seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum ``restartAttemptPeriod`` of 60 seconds and a maximum ``restartAttemptPeriod`` of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.", + "type": "integer" + } + }, + "type": "object" + }, + "RuntimePlatform": { + "additionalProperties": false, + "description": "Information about the platform for the Amazon ECS service or task.\n For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "CpuArchitecture": { + "description": "The CPU architecture.\n You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.", + "type": "string" + }, + "OperatingSystemFamily": { + "description": "The operating system.", + "type": "string" + } + }, + "type": "object" + }, + "Secret": { + "additionalProperties": false, + "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "Name": { + "description": "The name of the secret.", + "type": "string" + }, + "ValueFrom": { + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", + "type": "string" + } + }, + "required": [ + "Name", + "ValueFrom" + ], + "type": "object" + }, + "SystemControl": { + "additionalProperties": false, + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in tthe docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.\n We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages:\n + For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect.\n + For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported.\n \n If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\n + For tasks that use the ``host`` IPC mode, IPC namespace ``systemControls`` aren't supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task.\n \n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", + "properties": { + "Namespace": { + "description": "The namespaced kernel parameter to set a ``value`` for.", + "type": "string" + }, + "Value": { + "description": "The namespaced kernel parameter to set a ``value`` for.\n Valid IPC namespace values: ``\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"``, and ``Sysctls`` that start with ``\"fs.mqueue.*\"`` \n Valid network namespace values: ``Sysctls`` that start with ``\"net.*\"`` \n All of these values are supported by Fargate.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "properties": { + "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", + "type": "string" + }, + "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", + "type": "string" + } + }, + "type": "object" + }, + "TaskDefinitionPlacementConstraint": { + "additionalProperties": false, + "description": "The constraint on task placement in the task definition. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.\n Task placement constraints aren't supported for tasks run on FARGATElong.", + "properties": { + "Expression": { + "description": "A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "Type": { + "description": "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates.", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Tmpfs": { + "additionalProperties": false, + "description": "The container path, mount options, and size of the tmpfs mount.", + "properties": { + "ContainerPath": { + "description": "The absolute file path where the tmpfs volume is to be mounted.", + "type": "string" + }, + "MountOptions": { + "description": "The list of tmpfs volume mount options.\n Valid values: ``\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"``", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Size": { + "description": "The maximum size (in MiB) of the tmpfs volume.", + "type": "integer" + } + }, + "required": [ + "Size" + ], + "type": "object" + }, + "Ulimit": { + "additionalProperties": false, + "description": "The ``ulimit`` settings to pass to the container.\n Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``65535`` and the default hard limit is ``65535``.\n You can specify the ``ulimit`` settings for a container in a task definition.", + "properties": { + "HardLimit": { + "description": "The hard limit for the ``ulimit`` type.", + "type": "integer" + }, + "Name": { + "description": "The ``type`` of the ``ulimit``.", + "type": "string" + }, + "SoftLimit": { + "description": "The soft limit for the ``ulimit`` type.", + "type": "integer" + } + }, + "required": [ + "HardLimit", + "Name", + "SoftLimit" + ], + "type": "object" + }, + "Volume": { + "additionalProperties": false, + "description": "The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).", + "properties": { + "ConfiguredAtLaunch": { + "description": "Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.\n To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs.", + "type": "boolean" + }, + "DockerVolumeConfiguration": { + "$ref": "#/definitions/DockerVolumeConfiguration", + "description": "This parameter is specified when you use Docker volumes.\n Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead.\n Docker volumes aren't supported by tasks run on FARGATElong." + }, + "EFSVolumeConfiguration": { + "$ref": "#/definitions/EFSVolumeConfiguration", + "description": "This parameter is specified when you use an Amazon Elastic File System file system for task storage." + }, + "FSxWindowsFileServerVolumeConfiguration": { + "$ref": "#/definitions/FSxWindowsFileServerVolumeConfiguration", + "description": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage." + }, + "Host": { + "$ref": "#/definitions/HostVolumeProperties", + "description": "This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``." + }, + "Name": { + "description": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.\n When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task.\n For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition.\n When a volume is using the ``efsVolumeConfiguration``, the name is required.", + "type": "string" + } + }, + "type": "object" + }, + "VolumeFrom": { + "additionalProperties": false, + "description": "Details on a data volume from another container in the same task definition.", + "properties": { + "ReadOnly": { + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", + "type": "boolean" + }, + "SourceContainer": { + "description": "The name of another container within the same task definition to mount volumes from.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.\n You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.", + "handlers": { + "create": { + "permissions": [ + "ecs:RegisterTaskDefinition", + "ecs:DescribeTaskDefinition", + "ecs:TagResource", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "ecs:DeregisterTaskDefinition", + "ecs:DescribeTaskDefinition", + "iam:GetRole", + "iam:PassRole" + ] + }, + "list": { + "permissions": [ + "ecs:ListTaskDefinitions", + "ecs:DescribeTaskDefinition" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeTaskDefinition" + ] + }, + "update": { + "permissions": [ + "ecs:TagResource", + "ecs:UntagResource", + "ecs:ListTagsForResource", + "ecs:DescribeTaskDefinition", + "iam:GetRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/TaskDefinitionArn" + ], + "properties": { + "ContainerDefinitions": { + "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerDefinition" + }, + "type": "array", + "uniqueItems": true + }, + "Cpu": { + "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later.", + "type": "string" + }, + "EphemeralStorage": { + "$ref": "#/definitions/EphemeralStorage", + "description": "The ephemeral storage settings to use for tasks run with the task definition." + }, + "ExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.", + "type": "string" + }, + "Family": { + "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.", + "type": "string" + }, + "InferenceAccelerators": { + "description": "The Elastic Inference accelerators to use for the containers in the task.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InferenceAccelerator" + }, + "type": "array", + "uniqueItems": true + }, + "IpcMode": { + "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.\n If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.\n If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.\n \n This parameter is not supported for Windows containers or tasks run on FARGATElong.", + "type": "string" + }, + "Memory": { + "description": "The amount (in MiB) of memory used by the task.\n If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).\n If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.\n + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)\n + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)\n + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)\n + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)\n + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)\n + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)\n This option requires Linux platform ``1.4.0`` or later.\n + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)\n This option requires Linux platform ``1.4.0`` or later.", + "type": "string" + }, + "NetworkMode": { + "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.\n For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.\n With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. \n When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.\n If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.", + "type": "string" + }, + "PidMode": { + "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.\n If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.\n If ``task`` is specified, all containers within the specified task share the same process namespace.\n If no value is specified, the default is a private namespace for each container.\n If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure.\n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", + "type": "string" + }, + "PlacementConstraints": { + "description": "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TaskDefinitionPlacementConstraint" + }, + "type": "array", + "uniqueItems": true + }, + "ProxyConfiguration": { + "$ref": "#/definitions/ProxyConfiguration", + "description": "The configuration details for the App Mesh proxy.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "RequiresCompatibilities": { + "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "RuntimePlatform": { + "$ref": "#/definitions/RuntimePlatform", + "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type." + }, + "Tags": { + "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TaskDefinitionArn": { + "description": "", + "type": "string" + }, + "TaskRoleArn": { + "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n String validation is done on the ECS side. If an invalid string value is given for ``TaskRoleArn``, it may cause the Cloudformation job to hang.", + "type": "string" + }, + "Volumes": { + "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.\n The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Volume" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/TaskRoleArn": "TaskRoleArn $OR $split(TaskRoleArn, \"role/\")[-1]" + }, + "readOnlyProperties": [ + "/properties/TaskDefinitionArn" + ], + "sourceUrl": "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ECS::TaskDefinition" +} diff --git a/schema/aws-ecs-taskset.json b/schema/aws-ecs-taskset.json index e0aee5d..d64284e 100644 --- a/schema/aws-ecs-taskset.json +++ b/schema/aws-ecs-taskset.json @@ -1,242 +1,242 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Cluster", - "/properties/ExternalId", - "/properties/LaunchType", - "/properties/LoadBalancers", - "/properties/NetworkConfiguration", - "/properties/PlatformVersion", - "/properties/Service", - "/properties/ServiceRegistries", - "/properties/TaskDefinition" - ], - "definitions": { - "AwsVpcConfiguration": { - "additionalProperties": false, - "description": "The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC.", - "properties": { - "AssignPublicIp": { - "description": "Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "SecurityGroups": { - "description": "The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.", - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "Subnets": { - "description": "The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.", - "items": { - "type": "string" - }, - "maxItems": 16, - "type": "array" - } - }, - "required": [ - "Subnets" - ], - "type": "object" - }, - "LoadBalancer": { - "additionalProperties": false, - "description": "A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. ", - "properties": { - "ContainerName": { - "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.", - "type": "string" - }, - "ContainerPort": { - "description": "The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.", - "type": "integer" - }, - "TargetGroupArn": { - "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "description": "An object representing the network configuration for a task or service.", - "properties": { - "AwsVpcConfiguration": { - "$ref": "#/definitions/AwsVpcConfiguration" - } - }, - "type": "object" - }, - "Scale": { - "additionalProperties": false, - "properties": { - "Unit": { - "description": "The unit of measure for the scale value.", - "enum": [ - "PERCENT" - ], - "type": "string" - }, - "Value": { - "description": "The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.", - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "ServiceRegistry": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "description": "The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.", - "type": "string" - }, - "ContainerPort": { - "description": "The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.", - "type": "integer" - }, - "Port": { - "description": "The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.", - "type": "integer" - }, - "RegistryArn": { - "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.", - "handlers": { - "create": { - "permissions": [ - "ecs:CreateTaskSet", - "ecs:DescribeTaskSets", - "ecs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ecs:DeleteTaskSet", - "ecs:DescribeTaskSets" - ] - }, - "read": { - "permissions": [ - "ecs:DescribeTaskSets" - ] - }, - "update": { - "permissions": [ - "ecs:DescribeTaskSets", - "ecs:TagResource", - "ecs:UntagResource", - "ecs:UpdateTaskSet" - ] - } - }, - "primaryIdentifier": [ - "/properties/Cluster", - "/properties/Service", - "/properties/Id" - ], - "properties": { - "Cluster": { - "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.", - "type": "string" - }, - "ExternalId": { - "description": "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. ", - "type": "string" - }, - "Id": { - "description": "The ID of the task set.", - "type": "string" - }, - "LaunchType": { - "description": "The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ", - "enum": [ - "EC2", - "FARGATE" - ], - "type": "string" - }, - "LoadBalancers": { - "items": { - "$ref": "#/definitions/LoadBalancer" - }, - "type": "array" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "PlatformVersion": { - "description": "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.", - "type": "string" - }, - "Scale": { - "$ref": "#/definitions/Scale", - "description": "A floating-point percentage of the desired number of tasks to place and keep running in the task set." - }, - "Service": { - "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.", - "type": "string" - }, - "ServiceRegistries": { - "description": "The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.", - "items": { - "$ref": "#/definitions/ServiceRegistry" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskDefinition": { - "description": "The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Cluster", - "Service", - "TaskDefinition" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecs.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ECS::TaskSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Cluster", + "/properties/ExternalId", + "/properties/LaunchType", + "/properties/LoadBalancers", + "/properties/NetworkConfiguration", + "/properties/PlatformVersion", + "/properties/Service", + "/properties/ServiceRegistries", + "/properties/TaskDefinition" + ], + "definitions": { + "AwsVpcConfiguration": { + "additionalProperties": false, + "description": "The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC.", + "properties": { + "AssignPublicIp": { + "description": "Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "SecurityGroups": { + "description": "The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.", + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "Subnets": { + "description": "The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.", + "items": { + "type": "string" + }, + "maxItems": 16, + "type": "array" + } + }, + "required": [ + "Subnets" + ], + "type": "object" + }, + "LoadBalancer": { + "additionalProperties": false, + "description": "A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. ", + "properties": { + "ContainerName": { + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.", + "type": "string" + }, + "ContainerPort": { + "description": "The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.", + "type": "integer" + }, + "TargetGroupArn": { + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "description": "An object representing the network configuration for a task or service.", + "properties": { + "AwsVpcConfiguration": { + "$ref": "#/definitions/AwsVpcConfiguration" + } + }, + "type": "object" + }, + "Scale": { + "additionalProperties": false, + "properties": { + "Unit": { + "description": "The unit of measure for the scale value.", + "enum": [ + "PERCENT" + ], + "type": "string" + }, + "Value": { + "description": "The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.", + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "ServiceRegistry": { + "additionalProperties": false, + "properties": { + "ContainerName": { + "description": "The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.", + "type": "string" + }, + "ContainerPort": { + "description": "The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.", + "type": "integer" + }, + "Port": { + "description": "The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.", + "type": "integer" + }, + "RegistryArn": { + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.", + "handlers": { + "create": { + "permissions": [ + "ecs:CreateTaskSet", + "ecs:DescribeTaskSets", + "ecs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ecs:DeleteTaskSet", + "ecs:DescribeTaskSets" + ] + }, + "read": { + "permissions": [ + "ecs:DescribeTaskSets" + ] + }, + "update": { + "permissions": [ + "ecs:DescribeTaskSets", + "ecs:TagResource", + "ecs:UntagResource", + "ecs:UpdateTaskSet" + ] + } + }, + "primaryIdentifier": [ + "/properties/Cluster", + "/properties/Service", + "/properties/Id" + ], + "properties": { + "Cluster": { + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.", + "type": "string" + }, + "ExternalId": { + "description": "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. ", + "type": "string" + }, + "Id": { + "description": "The ID of the task set.", + "type": "string" + }, + "LaunchType": { + "description": "The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ", + "enum": [ + "EC2", + "FARGATE" + ], + "type": "string" + }, + "LoadBalancers": { + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "type": "array" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "PlatformVersion": { + "description": "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.", + "type": "string" + }, + "Scale": { + "$ref": "#/definitions/Scale", + "description": "A floating-point percentage of the desired number of tasks to place and keep running in the task set." + }, + "Service": { + "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.", + "type": "string" + }, + "ServiceRegistries": { + "description": "The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.", + "items": { + "$ref": "#/definitions/ServiceRegistry" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TaskDefinition": { + "description": "The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Cluster", + "Service", + "TaskDefinition" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecs.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ECS::TaskSet" +} diff --git a/schema/aws-efs-accesspoint.json b/schema/aws-efs-accesspoint.json index 6fafea2..f5610b0 100644 --- a/schema/aws-efs-accesspoint.json +++ b/schema/aws-efs-accesspoint.json @@ -1,195 +1,195 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FileSystemId", - "/properties/ClientToken", - "/properties/CreationInfo", - "/properties/CreationInfo/OwnerUid", - "/properties/CreationInfo/OwnerGid", - "/properties/CreationInfo/Permissions", - "/properties/PosixUser", - "/properties/PosixUser/Uid", - "/properties/PosixUser/Gid", - "/properties/PosixUser/SecondaryGids", - "/properties/RootDirectory", - "/properties/RootDirectory/Path", - "/properties/RootDirectory/CreationInfo" - ], - "definitions": { - "AccessPointTag": { - "additionalProperties": false, - "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", - "properties": { - "Key": { - "description": "The tag key (String). The key can't start with ``aws:``.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value of the tag key.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "CreationInfo": { - "additionalProperties": false, - "description": "Required if the ``RootDirectory`` > ``Path`` specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory`` > ``Path``. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying ``CreationInfo``, you must include values for all properties. \n Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.\n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` does not exist, attempts to mount the file system using the access point will fail.", - "properties": { - "OwnerGid": { - "description": "Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", - "type": "string" - }, - "OwnerUid": { - "description": "Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", - "type": "string" - }, - "Permissions": { - "description": "Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits.", - "pattern": "^[0-7]{3,4}$", - "type": "string" - } - }, - "required": [ - "OwnerUid", - "OwnerGid", - "Permissions" - ], - "type": "object" - }, - "PosixUser": { - "additionalProperties": false, - "description": "The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.", - "properties": { - "Gid": { - "description": "The POSIX group ID used for all file system operations using this access point.", - "type": "string" - }, - "SecondaryGids": { - "description": "Secondary POSIX group IDs used for all file system operations using this access point.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Uid": { - "description": "The POSIX user ID used for all file system operations using this access point.", - "type": "string" - } - }, - "required": [ - "Uid", - "Gid" - ], - "type": "object" - }, - "RootDirectory": { - "additionalProperties": false, - "description": "Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's ``RootDirectory`` and its subdirectories.", - "properties": { - "CreationInfo": { - "$ref": "#/definitions/CreationInfo", - "description": "(Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` > ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. \n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` > ``Path`` does not exist, attempts to mount the file system using the access point will fail." - }, - "Path": { - "description": "Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``.", - "maxLength": 100, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).\n This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action.", - "handlers": { - "create": { - "permissions": [ - "elasticfilesystem:CreateAccessPoint", - "elasticfilesystem:TagResource", - "elasticfilesystem:DescribeAccessPoints" - ] - }, - "delete": { - "permissions": [ - "elasticfilesystem:DeleteAccessPoint", - "elasticfilesystem:DescribeAccessPoints" - ] - }, - "list": { - "permissions": [ - "elasticfilesystem:DescribeAccessPoints" - ] - }, - "read": { - "permissions": [ - "elasticfilesystem:DescribeAccessPoints" - ] - }, - "update": { - "permissions": [ - "elasticfilesystem:DescribeAccessPoints", - "elasticfilesystem:ListTagsForResource", - "elasticfilesystem:TagResource", - "elasticfilesystem:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccessPointId" - ], - "properties": { - "AccessPointId": { - "description": "", - "type": "string" - }, - "AccessPointTags": { - "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AccessPointTag" - }, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "description": "", - "type": "string" - }, - "ClientToken": { - "description": "The opaque string specified in the request to ensure idempotent creation.", - "type": "string" - }, - "FileSystemId": { - "description": "The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``.", - "type": "string" - }, - "PosixUser": { - "$ref": "#/definitions/PosixUser", - "description": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point." - }, - "RootDirectory": { - "$ref": "#/definitions/RootDirectory", - "description": "The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point." - } - }, - "readOnlyProperties": [ - "/properties/AccessPointId", - "/properties/Arn" - ], - "required": [ - "FileSystemId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/AccessPointTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EFS::AccessPoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FileSystemId", + "/properties/ClientToken", + "/properties/CreationInfo", + "/properties/CreationInfo/OwnerUid", + "/properties/CreationInfo/OwnerGid", + "/properties/CreationInfo/Permissions", + "/properties/PosixUser", + "/properties/PosixUser/Uid", + "/properties/PosixUser/Gid", + "/properties/PosixUser/SecondaryGids", + "/properties/RootDirectory", + "/properties/RootDirectory/Path", + "/properties/RootDirectory/CreationInfo" + ], + "definitions": { + "AccessPointTag": { + "additionalProperties": false, + "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", + "properties": { + "Key": { + "description": "The tag key (String). The key can't start with ``aws:``.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value of the tag key.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "CreationInfo": { + "additionalProperties": false, + "description": "Required if the ``RootDirectory`` > ``Path`` specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory`` > ``Path``. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying ``CreationInfo``, you must include values for all properties. \n Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.\n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` does not exist, attempts to mount the file system using the access point will fail.", + "properties": { + "OwnerGid": { + "description": "Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", + "type": "string" + }, + "OwnerUid": { + "description": "Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", + "type": "string" + }, + "Permissions": { + "description": "Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits.", + "pattern": "^[0-7]{3,4}$", + "type": "string" + } + }, + "required": [ + "OwnerUid", + "OwnerGid", + "Permissions" + ], + "type": "object" + }, + "PosixUser": { + "additionalProperties": false, + "description": "The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.", + "properties": { + "Gid": { + "description": "The POSIX group ID used for all file system operations using this access point.", + "type": "string" + }, + "SecondaryGids": { + "description": "Secondary POSIX group IDs used for all file system operations using this access point.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Uid": { + "description": "The POSIX user ID used for all file system operations using this access point.", + "type": "string" + } + }, + "required": [ + "Uid", + "Gid" + ], + "type": "object" + }, + "RootDirectory": { + "additionalProperties": false, + "description": "Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's ``RootDirectory`` and its subdirectories.", + "properties": { + "CreationInfo": { + "$ref": "#/definitions/CreationInfo", + "description": "(Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` > ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. \n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` > ``Path`` does not exist, attempts to mount the file system using the access point will fail." + }, + "Path": { + "description": "Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).\n This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action.", + "handlers": { + "create": { + "permissions": [ + "elasticfilesystem:CreateAccessPoint", + "elasticfilesystem:TagResource", + "elasticfilesystem:DescribeAccessPoints" + ] + }, + "delete": { + "permissions": [ + "elasticfilesystem:DeleteAccessPoint", + "elasticfilesystem:DescribeAccessPoints" + ] + }, + "list": { + "permissions": [ + "elasticfilesystem:DescribeAccessPoints" + ] + }, + "read": { + "permissions": [ + "elasticfilesystem:DescribeAccessPoints" + ] + }, + "update": { + "permissions": [ + "elasticfilesystem:DescribeAccessPoints", + "elasticfilesystem:ListTagsForResource", + "elasticfilesystem:TagResource", + "elasticfilesystem:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccessPointId" + ], + "properties": { + "AccessPointId": { + "description": "", + "type": "string" + }, + "AccessPointTags": { + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AccessPointTag" + }, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "description": "", + "type": "string" + }, + "ClientToken": { + "description": "The opaque string specified in the request to ensure idempotent creation.", + "type": "string" + }, + "FileSystemId": { + "description": "The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``.", + "type": "string" + }, + "PosixUser": { + "$ref": "#/definitions/PosixUser", + "description": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point." + }, + "RootDirectory": { + "$ref": "#/definitions/RootDirectory", + "description": "The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point." + } + }, + "readOnlyProperties": [ + "/properties/AccessPointId", + "/properties/Arn" + ], + "required": [ + "FileSystemId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/AccessPointTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EFS::AccessPoint" +} diff --git a/schema/aws-efs-filesystem.json b/schema/aws-efs-filesystem.json index 2f45f58..373ba76 100644 --- a/schema/aws-efs-filesystem.json +++ b/schema/aws-efs-filesystem.json @@ -1,289 +1,289 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AvailabilityZoneName", - "/properties/Encrypted", - "/properties/KmsKeyId", - "/properties/PerformanceMode" - ], - "definitions": { - "Arn": { - "type": "string" - }, - "BackupPolicy": { - "additionalProperties": false, - "description": "The backup policy turns automatic backups for the file system on or off.", - "properties": { - "Status": { - "description": "Set the backup policy status for the file system.\n + *ENABLED* - Turns automatic backups on for the file system. \n + *DISABLED* - Turns automatic backups off for the file system.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "ElasticFileSystemTag": { - "additionalProperties": false, - "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", - "properties": { - "Key": { - "description": "The tag key (String). The key can't start with ``aws:``.", - "type": "string" - }, - "Value": { - "description": "The value of the tag key.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "FileSystemProtection": { - "additionalProperties": false, - "description": "Describes the protection on the file system.", - "properties": { - "ReplicationOverwriteProtection": { - "description": "The status of the file system's replication overwrite protection.\n + ``ENABLED`` \u2013 The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n + ``DISABLED`` \u2013 The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n + ``REPLICATING`` \u2013 The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.\n \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "LifecyclePolicy": { - "additionalProperties": false, - "description": "Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\n + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``.\n + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.", - "properties": { - "TransitionToArchive": { - "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", - "type": "string" - }, - "TransitionToIA": { - "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.", - "type": "string" - }, - "TransitionToPrimaryStorageClass": { - "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", - "type": "string" - } - }, - "type": "object" - }, - "ReplicationConfiguration": { - "additionalProperties": false, - "description": "Describes the replication configuration for a specific file system.", - "properties": { - "Destinations": { - "description": "An array of destination objects. Only one destination object is supported.", - "items": { - "$ref": "#/definitions/ReplicationDestination" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ReplicationDestination": { - "additionalProperties": false, - "description": "Describes the destination file system in the replication configuration.", - "properties": { - "AvailabilityZoneName": { - "description": "For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. \n Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.\n One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", - "type": "string" - }, - "FileSystemId": { - "description": "The ID of the destination Amazon EFS file system.", - "type": "string" - }, - "KmsKeyId": { - "description": "The ID of an kms-key-long used to protect the encrypted file system.", - "type": "string" - }, - "Region": { - "description": "The AWS-Region in which the destination file system is located.\n For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.", - "handlers": { - "create": { - "permissions": [ - "elasticfilesystem:CreateFileSystem", - "elasticfilesystem:DescribeReplicationConfigurations", - "elasticfilesystem:TagResource", - "elasticfilesystem:CreateReplicationConfiguration", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:PutBackupPolicy", - "elasticfilesystem:PutFileSystemPolicy", - "elasticfilesystem:PutLifecycleConfiguration", - "elasticfilesystem:UpdateFileSystemProtection", - "kms:DescribeKey", - "kms:GenerateDataKeyWithoutPlaintext", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DeleteFileSystem", - "elasticfilesystem:DeleteReplicationConfiguration", - "elasticfilesystem:DescribeReplicationConfigurations" - ] - }, - "list": { - "permissions": [ - "elasticfilesystem:DescribeBackupPolicy", - "elasticfilesystem:DescribeFileSystemPolicy", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeLifecycleConfiguration", - "elasticfilesystem:DescribeReplicationConfigurations" - ] - }, - "read": { - "permissions": [ - "elasticfilesystem:DescribeBackupPolicy", - "elasticfilesystem:DescribeFileSystemPolicy", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeLifecycleConfiguration", - "elasticfilesystem:DescribeReplicationConfigurations" - ] - }, - "update": { - "permissions": [ - "elasticfilesystem:CreateReplicationConfiguration", - "elasticfilesystem:DeleteFileSystemPolicy", - "elasticfilesystem:DescribeBackupPolicy", - "elasticfilesystem:DescribeFileSystemPolicy", - "elasticfilesystem:DescribeFileSystems", - "elasticfilesystem:DescribeLifecycleConfiguration", - "elasticfilesystem:DescribeReplicationConfigurations", - "elasticfilesystem:DeleteTags", - "elasticfilesystem:DeleteReplicationConfiguration", - "elasticfilesystem:ListTagsForResource", - "elasticfilesystem:PutBackupPolicy", - "elasticfilesystem:PutFileSystemPolicy", - "elasticfilesystem:PutLifecycleConfiguration", - "elasticfilesystem:TagResource", - "elasticfilesystem:UntagResource", - "elasticfilesystem:UpdateFileSystem", - "elasticfilesystem:UpdateFileSystemProtection", - "kms:DescribeKey", - "kms:GenerateDataKeyWithoutPlaintext", - "kms:CreateGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/FileSystemId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "" - }, - "AvailabilityZoneName": { - "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.\n One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", - "type": "string" - }, - "BackupPolicy": { - "$ref": "#/definitions/BackupPolicy", - "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system." - }, - "BypassPolicyLockoutSafetyCheck": { - "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.", - "type": "boolean" - }, - "Encrypted": { - "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.", - "type": "boolean" - }, - "FileSystemId": { - "description": "", - "type": "string" - }, - "FileSystemPolicy": { - "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.", - "type": "object" - }, - "FileSystemProtection": { - "$ref": "#/definitions/FileSystemProtection", - "description": "Describes the protection on the file system." - }, - "FileSystemTags": { - "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``\"Key\":\"Name\",\"Value\":\"{value}\"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.", - "items": { - "$ref": "#/definitions/ElasticFileSystemTag" - }, - "type": "array", - "uniqueItems": true - }, - "KmsKeyId": { - "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:\n + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.\n + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.\n + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.\n + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.\n \n If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.", - "type": "string" - }, - "LifecyclePolicies": { - "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:\n + When to move files in the file system from primary storage to IA storage.\n + When to move files in the file system from primary storage or IA storage to Archive storage.\n + When to move files that are in IA or Archive storage to primary storage.\n \n EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.", - "items": { - "$ref": "#/definitions/LifecyclePolicy" - }, - "type": "array", - "uniqueItems": true - }, - "PerformanceMode": { - "description": "The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.\n Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.\n Default is ``generalPurpose``.", - "type": "string" - }, - "ProvisionedThroughputInMibps": { - "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.", - "type": "number" - }, - "ReplicationConfiguration": { - "$ref": "#/definitions/ReplicationConfiguration", - "description": "Describes the replication configuration for a specific file system." - }, - "ThroughputMode": { - "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. \n Default is ``bursting``.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/FileSystemProtection/ReplicationOverwriteProtection": "$uppercase(FileSystemProtection.ReplicationOverwriteProtection)='DISABLED' ? 'REPLICATING' : $uppercase(FileSystemProtection.ReplicationOverwriteProtection)", - "/properties/KmsKeyId": "\"arn:aws[-a-z]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+\"" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/FileSystemId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/FileSystemTags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EFS::FileSystem", - "writeOnlyProperties": [ - "/properties/BypassPolicyLockoutSafetyCheck", - "/properties/ReplicationConfiguration/Destinations/0/AvailabilityZoneName", - "/properties/ReplicationConfiguration/Destinations/0/KmsKeyId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AvailabilityZoneName", + "/properties/Encrypted", + "/properties/KmsKeyId", + "/properties/PerformanceMode" + ], + "definitions": { + "Arn": { + "type": "string" + }, + "BackupPolicy": { + "additionalProperties": false, + "description": "The backup policy turns automatic backups for the file system on or off.", + "properties": { + "Status": { + "description": "Set the backup policy status for the file system.\n + *ENABLED* - Turns automatic backups on for the file system. \n + *DISABLED* - Turns automatic backups off for the file system.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "ElasticFileSystemTag": { + "additionalProperties": false, + "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", + "properties": { + "Key": { + "description": "The tag key (String). The key can't start with ``aws:``.", + "type": "string" + }, + "Value": { + "description": "The value of the tag key.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "FileSystemProtection": { + "additionalProperties": false, + "description": "Describes the protection on the file system.", + "properties": { + "ReplicationOverwriteProtection": { + "description": "The status of the file system's replication overwrite protection.\n + ``ENABLED`` \u2013 The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n + ``DISABLED`` \u2013 The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n + ``REPLICATING`` \u2013 The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.\n \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "LifecyclePolicy": { + "additionalProperties": false, + "description": "Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\n + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``.\n + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.", + "properties": { + "TransitionToArchive": { + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", + "type": "string" + }, + "TransitionToIA": { + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.", + "type": "string" + }, + "TransitionToPrimaryStorageClass": { + "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", + "type": "string" + } + }, + "type": "object" + }, + "ReplicationConfiguration": { + "additionalProperties": false, + "description": "Describes the replication configuration for a specific file system.", + "properties": { + "Destinations": { + "description": "An array of destination objects. Only one destination object is supported.", + "items": { + "$ref": "#/definitions/ReplicationDestination" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ReplicationDestination": { + "additionalProperties": false, + "description": "Describes the destination file system in the replication configuration.", + "properties": { + "AvailabilityZoneName": { + "description": "For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. \n Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.\n One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", + "type": "string" + }, + "FileSystemId": { + "description": "The ID of the destination Amazon EFS file system.", + "type": "string" + }, + "KmsKeyId": { + "description": "The ID of an kms-key-long used to protect the encrypted file system.", + "type": "string" + }, + "Region": { + "description": "The AWS-Region in which the destination file system is located.\n For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.", + "handlers": { + "create": { + "permissions": [ + "elasticfilesystem:CreateFileSystem", + "elasticfilesystem:DescribeReplicationConfigurations", + "elasticfilesystem:TagResource", + "elasticfilesystem:CreateReplicationConfiguration", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:PutBackupPolicy", + "elasticfilesystem:PutFileSystemPolicy", + "elasticfilesystem:PutLifecycleConfiguration", + "elasticfilesystem:UpdateFileSystemProtection", + "kms:DescribeKey", + "kms:GenerateDataKeyWithoutPlaintext", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DeleteFileSystem", + "elasticfilesystem:DeleteReplicationConfiguration", + "elasticfilesystem:DescribeReplicationConfigurations" + ] + }, + "list": { + "permissions": [ + "elasticfilesystem:DescribeBackupPolicy", + "elasticfilesystem:DescribeFileSystemPolicy", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeLifecycleConfiguration", + "elasticfilesystem:DescribeReplicationConfigurations" + ] + }, + "read": { + "permissions": [ + "elasticfilesystem:DescribeBackupPolicy", + "elasticfilesystem:DescribeFileSystemPolicy", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeLifecycleConfiguration", + "elasticfilesystem:DescribeReplicationConfigurations" + ] + }, + "update": { + "permissions": [ + "elasticfilesystem:CreateReplicationConfiguration", + "elasticfilesystem:DeleteFileSystemPolicy", + "elasticfilesystem:DescribeBackupPolicy", + "elasticfilesystem:DescribeFileSystemPolicy", + "elasticfilesystem:DescribeFileSystems", + "elasticfilesystem:DescribeLifecycleConfiguration", + "elasticfilesystem:DescribeReplicationConfigurations", + "elasticfilesystem:DeleteTags", + "elasticfilesystem:DeleteReplicationConfiguration", + "elasticfilesystem:ListTagsForResource", + "elasticfilesystem:PutBackupPolicy", + "elasticfilesystem:PutFileSystemPolicy", + "elasticfilesystem:PutLifecycleConfiguration", + "elasticfilesystem:TagResource", + "elasticfilesystem:UntagResource", + "elasticfilesystem:UpdateFileSystem", + "elasticfilesystem:UpdateFileSystemProtection", + "kms:DescribeKey", + "kms:GenerateDataKeyWithoutPlaintext", + "kms:CreateGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/FileSystemId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "" + }, + "AvailabilityZoneName": { + "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.\n One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", + "type": "string" + }, + "BackupPolicy": { + "$ref": "#/definitions/BackupPolicy", + "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system." + }, + "BypassPolicyLockoutSafetyCheck": { + "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.", + "type": "boolean" + }, + "Encrypted": { + "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.", + "type": "boolean" + }, + "FileSystemId": { + "description": "", + "type": "string" + }, + "FileSystemPolicy": { + "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.", + "type": "object" + }, + "FileSystemProtection": { + "$ref": "#/definitions/FileSystemProtection", + "description": "Describes the protection on the file system." + }, + "FileSystemTags": { + "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``\"Key\":\"Name\",\"Value\":\"{value}\"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.", + "items": { + "$ref": "#/definitions/ElasticFileSystemTag" + }, + "type": "array", + "uniqueItems": true + }, + "KmsKeyId": { + "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:\n + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.\n + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.\n + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.\n + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.\n \n If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.", + "type": "string" + }, + "LifecyclePolicies": { + "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:\n + When to move files in the file system from primary storage to IA storage.\n + When to move files in the file system from primary storage or IA storage to Archive storage.\n + When to move files that are in IA or Archive storage to primary storage.\n \n EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.", + "items": { + "$ref": "#/definitions/LifecyclePolicy" + }, + "type": "array", + "uniqueItems": true + }, + "PerformanceMode": { + "description": "The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.\n Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.\n Default is ``generalPurpose``.", + "type": "string" + }, + "ProvisionedThroughputInMibps": { + "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.", + "type": "number" + }, + "ReplicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration", + "description": "Describes the replication configuration for a specific file system." + }, + "ThroughputMode": { + "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. \n Default is ``bursting``.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/FileSystemProtection/ReplicationOverwriteProtection": "$uppercase(FileSystemProtection.ReplicationOverwriteProtection)='DISABLED' ? 'REPLICATING' : $uppercase(FileSystemProtection.ReplicationOverwriteProtection)", + "/properties/KmsKeyId": "\"arn:aws[-a-z]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+\"" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/FileSystemId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/FileSystemTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EFS::FileSystem", + "writeOnlyProperties": [ + "/properties/BypassPolicyLockoutSafetyCheck", + "/properties/ReplicationConfiguration/Destinations/0/AvailabilityZoneName", + "/properties/ReplicationConfiguration/Destinations/0/KmsKeyId" + ] +} diff --git a/schema/aws-efs-mounttarget.json b/schema/aws-efs-mounttarget.json index b266687..caeb1bf 100644 --- a/schema/aws-efs-mounttarget.json +++ b/schema/aws-efs-mounttarget.json @@ -1,95 +1,95 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IpAddress", - "/properties/SubnetId", - "/properties/FileSystemId" - ], - "description": "The ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.", - "handlers": { - "create": { - "permissions": [ - "elasticfilesystem:CreateMountTarget", - "elasticfilesystem:DescribeMountTargets" - ] - }, - "delete": { - "permissions": [ - "elasticfilesystem:DescribeMountTargets", - "elasticfilesystem:DeleteMountTarget" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FileSystemId": { - "$ref": "resource-schema.json#/properties/FileSystemId" - } - }, - "required": [ - "FileSystemId" - ] - }, - "permissions": [ - "elasticfilesystem:DescribeMountTargets", - "elasticfilesystem:DescribeMountTargetSecurityGroups" - ] - }, - "read": { - "permissions": [ - "elasticfilesystem:DescribeMountTargets", - "elasticfilesystem:DescribeMountTargetSecurityGroups" - ] - }, - "update": { - "permissions": [ - "elasticfilesystem:DescribeMountTargets", - "elasticfilesystem:DescribeMountTargetSecurityGroups", - "elasticfilesystem:ModifyMountTargetSecurityGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "FileSystemId": { - "description": "The ID of the file system for which to create the mount target.", - "type": "string" - }, - "Id": { - "description": "", - "type": "string" - }, - "IpAddress": { - "description": "Valid IPv4 address within the address range of the specified subnet.", - "type": "string" - }, - "SecurityGroups": { - "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetId": { - "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FileSystemId", - "SecurityGroups", - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EFS::MountTarget" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IpAddress", + "/properties/SubnetId", + "/properties/FileSystemId" + ], + "description": "The ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.", + "handlers": { + "create": { + "permissions": [ + "elasticfilesystem:CreateMountTarget", + "elasticfilesystem:DescribeMountTargets" + ] + }, + "delete": { + "permissions": [ + "elasticfilesystem:DescribeMountTargets", + "elasticfilesystem:DeleteMountTarget" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FileSystemId": { + "$ref": "resource-schema.json#/properties/FileSystemId" + } + }, + "required": [ + "FileSystemId" + ] + }, + "permissions": [ + "elasticfilesystem:DescribeMountTargets", + "elasticfilesystem:DescribeMountTargetSecurityGroups" + ] + }, + "read": { + "permissions": [ + "elasticfilesystem:DescribeMountTargets", + "elasticfilesystem:DescribeMountTargetSecurityGroups" + ] + }, + "update": { + "permissions": [ + "elasticfilesystem:DescribeMountTargets", + "elasticfilesystem:DescribeMountTargetSecurityGroups", + "elasticfilesystem:ModifyMountTargetSecurityGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "FileSystemId": { + "description": "The ID of the file system for which to create the mount target.", + "type": "string" + }, + "Id": { + "description": "", + "type": "string" + }, + "IpAddress": { + "description": "Valid IPv4 address within the address range of the specified subnet.", + "type": "string" + }, + "SecurityGroups": { + "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetId": { + "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FileSystemId", + "SecurityGroups", + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EFS::MountTarget" +} diff --git a/schema/aws-eks-accessentry.json b/schema/aws-eks-accessentry.json index d755e89..a5baa66 100644 --- a/schema/aws-eks-accessentry.json +++ b/schema/aws-eks-accessentry.json @@ -1,201 +1,201 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PrincipalArn", - "/properties/ClusterName", - "/properties/Type" - ], - "definitions": { - "AccessPolicy": { - "additionalProperties": false, - "description": "An access policy to associate with the current access entry.", - "properties": { - "AccessScope": { - "$ref": "#/definitions/AccessScope" - }, - "PolicyArn": { - "description": "The ARN of the access policy to add to the access entry.", - "type": "string" - } - }, - "required": [ - "PolicyArn", - "AccessScope" - ], - "type": "object" - }, - "AccessScope": { - "additionalProperties": false, - "description": "The access scope of the access policy.", - "properties": { - "Namespaces": { - "description": "The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the access scope.", - "enum": [ - "namespace", - "cluster" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An object representing an Amazon EKS AccessEntry.", - "handlers": { - "create": { - "permissions": [ - "eks:CreateAccessEntry", - "eks:DescribeAccessEntry", - "eks:AssociateAccessPolicy", - "eks:TagResource", - "eks:ListAssociatedAccessPolicies" - ] - }, - "delete": { - "permissions": [ - "eks:DeleteAccessEntry", - "eks:DescribeAccessEntry" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListAccessEntries" - ] - }, - "read": { - "permissions": [ - "eks:DescribeAccessEntry", - "eks:ListAssociatedAccessPolicies" - ] - }, - "update": { - "permissions": [ - "eks:DescribeAccessEntry", - "eks:ListAssociatedAccessPolicies", - "eks:UpdateAccessEntry", - "eks:AssociateAccessPolicy", - "eks:DisassociateAccessPolicy", - "eks:TagResource", - "eks:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PrincipalArn", - "/properties/ClusterName" - ], - "properties": { - "AccessEntryArn": { - "description": "The ARN of the access entry.", - "type": "string" - }, - "AccessPolicies": { - "description": "An array of access policies that are associated with the access entry.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AccessPolicy" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ClusterName": { - "description": "The cluster that the access entry is created for.", - "minLength": 1, - "type": "string" - }, - "KubernetesGroups": { - "description": "The Kubernetes groups that the access entry is associated with.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "PrincipalArn": { - "description": "The principal ARN that the access entry is created for.", - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The node type to associate with the access entry.", - "type": "string" - }, - "Username": { - "description": "The Kubernetes user that the access entry is associated with.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccessEntryArn" - ], - "replacementStrategy": "create_then_delete", - "required": [ - "PrincipalArn", - "ClusterName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::AccessEntry" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PrincipalArn", + "/properties/ClusterName", + "/properties/Type" + ], + "definitions": { + "AccessPolicy": { + "additionalProperties": false, + "description": "An access policy to associate with the current access entry.", + "properties": { + "AccessScope": { + "$ref": "#/definitions/AccessScope" + }, + "PolicyArn": { + "description": "The ARN of the access policy to add to the access entry.", + "type": "string" + } + }, + "required": [ + "PolicyArn", + "AccessScope" + ], + "type": "object" + }, + "AccessScope": { + "additionalProperties": false, + "description": "The access scope of the access policy.", + "properties": { + "Namespaces": { + "description": "The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the access scope.", + "enum": [ + "namespace", + "cluster" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An object representing an Amazon EKS AccessEntry.", + "handlers": { + "create": { + "permissions": [ + "eks:CreateAccessEntry", + "eks:DescribeAccessEntry", + "eks:AssociateAccessPolicy", + "eks:TagResource", + "eks:ListAssociatedAccessPolicies" + ] + }, + "delete": { + "permissions": [ + "eks:DeleteAccessEntry", + "eks:DescribeAccessEntry" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListAccessEntries" + ] + }, + "read": { + "permissions": [ + "eks:DescribeAccessEntry", + "eks:ListAssociatedAccessPolicies" + ] + }, + "update": { + "permissions": [ + "eks:DescribeAccessEntry", + "eks:ListAssociatedAccessPolicies", + "eks:UpdateAccessEntry", + "eks:AssociateAccessPolicy", + "eks:DisassociateAccessPolicy", + "eks:TagResource", + "eks:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PrincipalArn", + "/properties/ClusterName" + ], + "properties": { + "AccessEntryArn": { + "description": "The ARN of the access entry.", + "type": "string" + }, + "AccessPolicies": { + "description": "An array of access policies that are associated with the access entry.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AccessPolicy" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ClusterName": { + "description": "The cluster that the access entry is created for.", + "minLength": 1, + "type": "string" + }, + "KubernetesGroups": { + "description": "The Kubernetes groups that the access entry is associated with.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "PrincipalArn": { + "description": "The principal ARN that the access entry is created for.", + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The node type to associate with the access entry.", + "type": "string" + }, + "Username": { + "description": "The Kubernetes user that the access entry is associated with.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccessEntryArn" + ], + "replacementStrategy": "create_then_delete", + "required": [ + "PrincipalArn", + "ClusterName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::AccessEntry" +} diff --git a/schema/aws-eks-addon.json b/schema/aws-eks-addon.json index 571fa01..8886731 100644 --- a/schema/aws-eks-addon.json +++ b/schema/aws-eks-addon.json @@ -1,194 +1,198 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName", - "/properties/AddonName" - ], - "definitions": { - "PodIdentityAssociation": { - "additionalProperties": false, - "description": "A pod identity to associate with an add-on.", - "properties": { - "RoleArn": { - "description": "The IAM role ARN that the pod identity association is created for.", - "pattern": "^arn:aws(-cn|-us-gov|-iso(-[a-z])?)?:iam::\\d{12}:(role)\\/*", - "type": "string" - }, - "ServiceAccount": { - "description": "The Kubernetes service account that the pod identity association is created for.", - "type": "string" - } - }, - "required": [ - "ServiceAccount", - "RoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema for AWS::EKS::Addon", - "handlers": { - "create": { - "permissions": [ - "eks:CreateAddon", - "eks:DescribeAddon", - "eks:TagResource", - "iam:PassRole", - "iam:GetRole", - "eks:CreatePodIdentityAssociation" - ] - }, - "delete": { - "permissions": [ - "eks:DeleteAddon", - "eks:DescribeAddon", - "eks:DeletePodIdentityAssociation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListAddons" - ] - }, - "read": { - "permissions": [ - "eks:DescribeAddon" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iam:GetRole", - "eks:UpdateAddon", - "eks:DescribeAddon", - "eks:DescribeUpdate", - "eks:ListTagsForResource", - "eks:TagResource", - "eks:UntagResource", - "eks:CreatePodIdentityAssociation", - "eks:DeletePodIdentityAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterName", - "/properties/AddonName" - ], - "properties": { - "AddonName": { - "description": "Name of Addon", - "minLength": 1, - "type": "string" - }, - "AddonVersion": { - "description": "Version of Addon", - "minLength": 1, - "type": "string" - }, - "Arn": { - "description": "Amazon Resource Name (ARN) of the add-on", - "type": "string" - }, - "ClusterName": { - "description": "Name of Cluster", - "minLength": 1, - "type": "string" - }, - "ConfigurationValues": { - "description": "The configuration values to use with the add-on", - "minLength": 1, - "type": "string" - }, - "PodIdentityAssociations": { - "description": "An array of pod identities to apply to this add-on.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PodIdentityAssociation" - }, - "type": "array", - "uniqueItems": true - }, - "PreserveOnDelete": { - "description": "PreserveOnDelete parameter value", - "type": "boolean" - }, - "ResolveConflicts": { - "description": "Resolve parameter value conflicts", - "enum": [ - "NONE", - "OVERWRITE", - "PRESERVE" - ], - "minLength": 1, - "type": "string" - }, - "ServiceAccountRoleArn": { - "description": "IAM role to bind to the add-on's service account", - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ClusterName", - "AddonName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::Addon", - "writeOnlyProperties": [ - "/properties/ResolveConflicts", - "/properties/PreserveOnDelete", - "/properties/PodIdentityAssociations" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/AddonName" + ], + "definitions": { + "PodIdentityAssociation": { + "additionalProperties": false, + "description": "A pod identity to associate with an add-on.", + "properties": { + "RoleArn": { + "description": "The IAM role ARN that the pod identity association is created for.", + "pattern": "^arn:aws(-cn|-us-gov|-iso(-[a-z])?)?:iam::\\d{12}:(role)\\/*", + "type": "string" + }, + "ServiceAccount": { + "description": "The Kubernetes service account that the pod identity association is created for.", + "type": "string" + } + }, + "required": [ + "ServiceAccount", + "RoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema for AWS::EKS::Addon", + "handlers": { + "create": { + "permissions": [ + "eks:CreateAddon", + "eks:DescribeAddon", + "eks:TagResource", + "iam:PassRole", + "iam:GetRole", + "eks:CreatePodIdentityAssociation" + ] + }, + "delete": { + "permissions": [ + "eks:DeleteAddon", + "eks:DescribeAddon", + "eks:DeletePodIdentityAssociation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListAddons" + ] + }, + "read": { + "permissions": [ + "eks:DescribeAddon" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iam:GetRole", + "eks:UpdateAddon", + "eks:DescribeAddon", + "eks:DescribeUpdate", + "eks:ListTagsForResource", + "eks:TagResource", + "eks:UntagResource", + "eks:CreatePodIdentityAssociation", + "eks:DeletePodIdentityAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterName", + "/properties/AddonName" + ], + "properties": { + "AddonName": { + "description": "Name of Addon", + "minLength": 1, + "type": "string" + }, + "AddonVersion": { + "description": "Version of Addon", + "minLength": 1, + "type": "string" + }, + "Arn": { + "description": "Amazon Resource Name (ARN) of the add-on", + "type": "string" + }, + "ClusterName": { + "description": "Name of Cluster", + "minLength": 1, + "type": "string" + }, + "ConfigurationValues": { + "description": "The configuration values to use with the add-on", + "minLength": 1, + "type": "string" + }, + "PodIdentityAssociations": { + "description": "An array of pod identities to apply to this add-on.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PodIdentityAssociation" + }, + "type": "array", + "uniqueItems": true + }, + "PreserveOnDelete": { + "description": "PreserveOnDelete parameter value", + "type": "boolean" + }, + "ResolveConflicts": { + "description": "Resolve parameter value conflicts", + "enum": [ + "NONE", + "OVERWRITE", + "PRESERVE" + ], + "minLength": 1, + "type": "string" + }, + "ServiceAccountRoleArn": { + "description": "IAM role to bind to the add-on's service account", + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ClusterName", + "AddonName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "eks:TagResource", + "eks:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::Addon", + "writeOnlyProperties": [ + "/properties/ResolveConflicts", + "/properties/PreserveOnDelete", + "/properties/PodIdentityAssociations" + ] +} diff --git a/schema/aws-eks-cluster.json b/schema/aws-eks-cluster.json index 98c6bd0..9dacdd2 100644 --- a/schema/aws-eks-cluster.json +++ b/schema/aws-eks-cluster.json @@ -1,476 +1,480 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OutpostConfig", - "/properties/EncryptionConfig", - "/properties/KubernetesNetworkConfig", - "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", - "/properties/Name", - "/properties/RoleArn", - "/properties/BootstrapSelfManagedAddons" - ], - "definitions": { - "AccessConfig": { - "additionalProperties": false, - "description": "An object representing the Access Config to use for the cluster.", - "properties": { - "AuthenticationMode": { - "description": "Specify the authentication mode that should be used to create your cluster.", - "enum": [ - "CONFIG_MAP", - "API_AND_CONFIG_MAP", - "API" - ], - "type": "string" - }, - "BootstrapClusterCreatorAdminPermissions": { - "description": "Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.", - "type": "boolean" - } - }, - "type": "object" - }, - "ClusterLogging": { - "additionalProperties": false, - "description": "The cluster control plane logging configuration for your cluster. ", - "properties": { - "EnabledTypes": { - "$ref": "#/definitions/EnabledTypes" - } - }, - "type": "object" - }, - "ControlPlanePlacement": { - "additionalProperties": false, - "description": "Specify the placement group of the control plane machines for your cluster.", - "properties": { - "GroupName": { - "description": "Specify the placement group name of the control place machines for your cluster.", - "type": "string" - } - }, - "type": "object" - }, - "EnabledTypes": { - "description": "Enable control plane logs for your cluster, all log types will be disabled if the array is empty", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LoggingTypeConfig" - }, - "type": "array" - }, - "EncryptionConfig": { - "additionalProperties": false, - "description": "The encryption configuration for the cluster", - "properties": { - "Provider": { - "$ref": "#/definitions/Provider", - "description": "The encryption provider for the cluster." - }, - "Resources": { - "description": "Specifies the resources to be encrypted. The only supported value is \"secrets\".", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "KubernetesNetworkConfig": { - "additionalProperties": false, - "description": "The Kubernetes network configuration for the cluster.", - "properties": { - "IpFamily": { - "description": "Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on", - "enum": [ - "ipv4", - "ipv6" - ], - "type": "string" - }, - "ServiceIpv4Cidr": { - "description": "The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. ", - "type": "string" - }, - "ServiceIpv6Cidr": { - "description": "The CIDR block to assign Kubernetes service IP addresses from.", - "type": "string" - } - }, - "type": "object" - }, - "Logging": { - "additionalProperties": false, - "description": "Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.", - "properties": { - "ClusterLogging": { - "$ref": "#/definitions/ClusterLogging", - "description": "The cluster control plane logging configuration for your cluster. " - } - }, - "type": "object" - }, - "LoggingTypeConfig": { - "additionalProperties": false, - "description": "Enabled Logging Type", - "properties": { - "Type": { - "description": "name of the log type", - "enum": [ - "api", - "audit", - "authenticator", - "controllerManager", - "scheduler" - ], - "type": "string" - } - }, - "type": "object" - }, - "OutpostConfig": { - "additionalProperties": false, - "description": "An object representing the Outpost configuration to use for AWS EKS outpost cluster.", - "properties": { - "ControlPlaneInstanceType": { - "description": "Specify the Instance type of the machines that should be used to create your cluster.", - "type": "string" - }, - "ControlPlanePlacement": { - "$ref": "#/definitions/ControlPlanePlacement", - "description": "Specify the placement group of the control plane machines for your cluster." - }, - "OutpostArns": { - "description": "Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "OutpostArns", - "ControlPlaneInstanceType" - ], - "type": "object" - }, - "Provider": { - "additionalProperties": false, - "properties": { - "KeyArn": { - "description": "Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key.", - "type": "string" - } - }, - "type": "object" - }, - "RemoteNodeNetwork": { - "additionalProperties": false, - "description": "Network configuration of nodes run on-premises with EKS Hybrid Nodes.", - "properties": { - "Cidrs": { - "description": "Specifies the list of remote node CIDRs.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Cidrs" - ], - "type": "object" - }, - "RemoteNodeNetworks": { - "description": "Network configuration of nodes run on-premises with EKS Hybrid Nodes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RemoteNodeNetwork" - }, - "type": "array" - }, - "RemotePodNetwork": { - "additionalProperties": false, - "description": "Network configuration of pods run on-premises with EKS Hybrid Nodes.", - "properties": { - "Cidrs": { - "description": "Specifies the list of remote pod CIDRs.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Cidrs" - ], - "type": "object" - }, - "RemotePodNetworks": { - "description": "Network configuration of pods run on-premises with EKS Hybrid Nodes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RemotePodNetwork" - }, - "type": "array" - }, - "ResourcesVpcConfig": { - "additionalProperties": false, - "description": "An object representing the VPC configuration to use for an Amazon EKS cluster.", - "properties": { - "EndpointPrivateAccess": { - "description": "Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.", - "type": "boolean" - }, - "EndpointPublicAccess": { - "description": "Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.", - "type": "boolean" - }, - "PublicAccessCidrs": { - "description": "The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - }, - "SecurityGroupIds": { - "description": "Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "description": "Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.", - "insertionOrder": false, - "items": { - "minItems": 1, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UpgradePolicy": { - "additionalProperties": false, - "description": "An object representing the Upgrade Policy to use for the cluster.", - "properties": { - "SupportType": { - "description": "Specify the support type for your cluster.", - "enum": [ - "STANDARD", - "EXTENDED" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "An object representing an Amazon EKS cluster.", - "handlers": { - "create": { - "permissions": [ - "eks:CreateCluster", - "eks:DescribeCluster", - "eks:TagResource", - "iam:PassRole", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "iam:CreateServiceLinkedRole", - "iam:CreateInstanceProfile", - "iam:TagInstanceProfile", - "iam:AddRoleToInstanceProfile", - "iam:GetInstanceProfile", - "iam:DeleteInstanceProfile", - "iam:RemoveRoleFromInstanceProfile", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "eks:DeleteCluster", - "eks:DescribeCluster" - ] - }, - "list": { - "permissions": [ - "eks:ListClusters" - ] - }, - "read": { - "permissions": [ - "eks:DescribeCluster" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "eks:UpdateClusterConfig", - "eks:UpdateClusterVersion", - "eks:DescribeCluster", - "eks:DescribeUpdate", - "eks:TagResource", - "eks:UntagResource" - ], - "timeoutInMinutes": 180 - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AccessConfig": { - "$ref": "#/definitions/AccessConfig" - }, - "Arn": { - "description": "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.", - "type": "string" - }, - "BootstrapSelfManagedAddons": { - "description": "Set this value to false to avoid creating the default networking addons when the cluster is created.", - "type": "boolean" - }, - "CertificateAuthorityData": { - "description": "The certificate-authority-data for your cluster.", - "type": "string" - }, - "ClusterSecurityGroupId": { - "description": "The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.", - "type": "string" - }, - "EncryptionConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EncryptionConfig", - "maxItems": 1 - }, - "type": "array" - }, - "EncryptionConfigKeyArn": { - "description": "Amazon Resource Name (ARN) or alias of the customer master key (CMK).", - "type": "string" - }, - "Endpoint": { - "description": "The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.", - "type": "string" - }, - "Id": { - "description": "The unique ID given to your cluster.", - "type": "string" - }, - "KubernetesNetworkConfig": { - "$ref": "#/definitions/KubernetesNetworkConfig" - }, - "Logging": { - "$ref": "#/definitions/Logging" - }, - "Name": { - "description": "The unique name to give to your cluster.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*", - "type": "string" - }, - "OpenIdConnectIssuerUrl": { - "description": "The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.", - "type": "string" - }, - "OutpostConfig": { - "$ref": "#/definitions/OutpostConfig" - }, - "ResourcesVpcConfig": { - "$ref": "#/definitions/ResourcesVpcConfig" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "UpgradePolicy": { - "$ref": "#/definitions/UpgradePolicy" - }, - "Version": { - "description": "The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.", - "pattern": "1\\.\\d\\d", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/Endpoint", - "/properties/CertificateAuthorityData", - "/properties/ClusterSecurityGroupId", - "/properties/EncryptionConfigKeyArn", - "/properties/OpenIdConnectIssuerUrl", - "/properties/KubernetesNetworkConfig/ServiceIpv6Cidr" - ], - "required": [ - "RoleArn", - "ResourcesVpcConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::Cluster", - "writeOnlyProperties": [ - "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", - "/properties/BootstrapSelfManagedAddons" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OutpostConfig", + "/properties/EncryptionConfig", + "/properties/KubernetesNetworkConfig", + "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", + "/properties/Name", + "/properties/RoleArn", + "/properties/BootstrapSelfManagedAddons" + ], + "definitions": { + "AccessConfig": { + "additionalProperties": false, + "description": "An object representing the Access Config to use for the cluster.", + "properties": { + "AuthenticationMode": { + "description": "Specify the authentication mode that should be used to create your cluster.", + "enum": [ + "CONFIG_MAP", + "API_AND_CONFIG_MAP", + "API" + ], + "type": "string" + }, + "BootstrapClusterCreatorAdminPermissions": { + "description": "Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.", + "type": "boolean" + } + }, + "type": "object" + }, + "ClusterLogging": { + "additionalProperties": false, + "description": "The cluster control plane logging configuration for your cluster. ", + "properties": { + "EnabledTypes": { + "$ref": "#/definitions/EnabledTypes" + } + }, + "type": "object" + }, + "ControlPlanePlacement": { + "additionalProperties": false, + "description": "Specify the placement group of the control plane machines for your cluster.", + "properties": { + "GroupName": { + "description": "Specify the placement group name of the control place machines for your cluster.", + "type": "string" + } + }, + "type": "object" + }, + "EnabledTypes": { + "description": "Enable control plane logs for your cluster, all log types will be disabled if the array is empty", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LoggingTypeConfig" + }, + "type": "array" + }, + "EncryptionConfig": { + "additionalProperties": false, + "description": "The encryption configuration for the cluster", + "properties": { + "Provider": { + "$ref": "#/definitions/Provider", + "description": "The encryption provider for the cluster." + }, + "Resources": { + "description": "Specifies the resources to be encrypted. The only supported value is \"secrets\".", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "KubernetesNetworkConfig": { + "additionalProperties": false, + "description": "The Kubernetes network configuration for the cluster.", + "properties": { + "IpFamily": { + "description": "Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "ServiceIpv4Cidr": { + "description": "The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. ", + "type": "string" + }, + "ServiceIpv6Cidr": { + "description": "The CIDR block to assign Kubernetes service IP addresses from.", + "type": "string" + } + }, + "type": "object" + }, + "Logging": { + "additionalProperties": false, + "description": "Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.", + "properties": { + "ClusterLogging": { + "$ref": "#/definitions/ClusterLogging", + "description": "The cluster control plane logging configuration for your cluster. " + } + }, + "type": "object" + }, + "LoggingTypeConfig": { + "additionalProperties": false, + "description": "Enabled Logging Type", + "properties": { + "Type": { + "description": "name of the log type", + "enum": [ + "api", + "audit", + "authenticator", + "controllerManager", + "scheduler" + ], + "type": "string" + } + }, + "type": "object" + }, + "OutpostConfig": { + "additionalProperties": false, + "description": "An object representing the Outpost configuration to use for AWS EKS outpost cluster.", + "properties": { + "ControlPlaneInstanceType": { + "description": "Specify the Instance type of the machines that should be used to create your cluster.", + "type": "string" + }, + "ControlPlanePlacement": { + "$ref": "#/definitions/ControlPlanePlacement", + "description": "Specify the placement group of the control plane machines for your cluster." + }, + "OutpostArns": { + "description": "Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "OutpostArns", + "ControlPlaneInstanceType" + ], + "type": "object" + }, + "Provider": { + "additionalProperties": false, + "properties": { + "KeyArn": { + "description": "Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key.", + "type": "string" + } + }, + "type": "object" + }, + "RemoteNodeNetwork": { + "additionalProperties": false, + "description": "Network configuration of nodes run on-premises with EKS Hybrid Nodes.", + "properties": { + "Cidrs": { + "description": "Specifies the list of remote node CIDRs.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Cidrs" + ], + "type": "object" + }, + "RemoteNodeNetworks": { + "description": "Network configuration of nodes run on-premises with EKS Hybrid Nodes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RemoteNodeNetwork" + }, + "type": "array" + }, + "RemotePodNetwork": { + "additionalProperties": false, + "description": "Network configuration of pods run on-premises with EKS Hybrid Nodes.", + "properties": { + "Cidrs": { + "description": "Specifies the list of remote pod CIDRs.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Cidrs" + ], + "type": "object" + }, + "RemotePodNetworks": { + "description": "Network configuration of pods run on-premises with EKS Hybrid Nodes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RemotePodNetwork" + }, + "type": "array" + }, + "ResourcesVpcConfig": { + "additionalProperties": false, + "description": "An object representing the VPC configuration to use for an Amazon EKS cluster.", + "properties": { + "EndpointPrivateAccess": { + "description": "Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.", + "type": "boolean" + }, + "EndpointPublicAccess": { + "description": "Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.", + "type": "boolean" + }, + "PublicAccessCidrs": { + "description": "The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + }, + "SecurityGroupIds": { + "description": "Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + }, + "SubnetIds": { + "description": "Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.", + "insertionOrder": false, + "items": { + "minItems": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "SubnetIds" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UpgradePolicy": { + "additionalProperties": false, + "description": "An object representing the Upgrade Policy to use for the cluster.", + "properties": { + "SupportType": { + "description": "Specify the support type for your cluster.", + "enum": [ + "STANDARD", + "EXTENDED" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "An object representing an Amazon EKS cluster.", + "handlers": { + "create": { + "permissions": [ + "eks:CreateCluster", + "eks:DescribeCluster", + "eks:TagResource", + "iam:PassRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "iam:CreateServiceLinkedRole", + "iam:CreateInstanceProfile", + "iam:TagInstanceProfile", + "iam:AddRoleToInstanceProfile", + "iam:GetInstanceProfile", + "iam:DeleteInstanceProfile", + "iam:RemoveRoleFromInstanceProfile", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "eks:DeleteCluster", + "eks:DescribeCluster" + ] + }, + "list": { + "permissions": [ + "eks:ListClusters" + ] + }, + "read": { + "permissions": [ + "eks:DescribeCluster" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "eks:UpdateClusterConfig", + "eks:UpdateClusterVersion", + "eks:DescribeCluster", + "eks:DescribeUpdate", + "eks:TagResource", + "eks:UntagResource" + ], + "timeoutInMinutes": 180 + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AccessConfig": { + "$ref": "#/definitions/AccessConfig" + }, + "Arn": { + "description": "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.", + "type": "string" + }, + "BootstrapSelfManagedAddons": { + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created.", + "type": "boolean" + }, + "CertificateAuthorityData": { + "description": "The certificate-authority-data for your cluster.", + "type": "string" + }, + "ClusterSecurityGroupId": { + "description": "The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.", + "type": "string" + }, + "EncryptionConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EncryptionConfig", + "maxItems": 1 + }, + "type": "array" + }, + "EncryptionConfigKeyArn": { + "description": "Amazon Resource Name (ARN) or alias of the customer master key (CMK).", + "type": "string" + }, + "Endpoint": { + "description": "The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.", + "type": "string" + }, + "Id": { + "description": "The unique ID given to your cluster.", + "type": "string" + }, + "KubernetesNetworkConfig": { + "$ref": "#/definitions/KubernetesNetworkConfig" + }, + "Logging": { + "$ref": "#/definitions/Logging" + }, + "Name": { + "description": "The unique name to give to your cluster.", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*", + "type": "string" + }, + "OpenIdConnectIssuerUrl": { + "description": "The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.", + "type": "string" + }, + "OutpostConfig": { + "$ref": "#/definitions/OutpostConfig" + }, + "ResourcesVpcConfig": { + "$ref": "#/definitions/ResourcesVpcConfig" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "UpgradePolicy": { + "$ref": "#/definitions/UpgradePolicy" + }, + "Version": { + "description": "The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.", + "pattern": "1\\.\\d\\d", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/Endpoint", + "/properties/CertificateAuthorityData", + "/properties/ClusterSecurityGroupId", + "/properties/EncryptionConfigKeyArn", + "/properties/OpenIdConnectIssuerUrl", + "/properties/KubernetesNetworkConfig/ServiceIpv6Cidr" + ], + "required": [ + "RoleArn", + "ResourcesVpcConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "eks:TagResource", + "eks:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::Cluster", + "writeOnlyProperties": [ + "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", + "/properties/BootstrapSelfManagedAddons" + ] +} diff --git a/schema/aws-eks-fargateprofile.json b/schema/aws-eks-fargateprofile.json index ee73459..5d5c5fc 100644 --- a/schema/aws-eks-fargateprofile.json +++ b/schema/aws-eks-fargateprofile.json @@ -1,186 +1,190 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName", - "/properties/FargateProfileName", - "/properties/PodExecutionRoleArn", - "/properties/Subnets", - "/properties/Selectors" - ], - "definitions": { - "Label": { - "additionalProperties": false, - "description": "A key-value pair to associate with a pod.", - "properties": { - "Key": { - "description": "The key name of the label.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the label. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Selector": { - "additionalProperties": false, - "properties": { - "Labels": { - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "Namespace": { - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema for AWS::EKS::FargateProfile", - "handlers": { - "create": { - "permissions": [ - "eks:CreateFargateProfile", - "eks:DescribeFargateProfile", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "eks:TagResource" - ] - }, - "delete": { - "permissions": [ - "eks:DeleteFargateProfile", - "eks:DescribeFargateProfile" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListFargateProfiles" - ] - }, - "read": { - "permissions": [ - "eks:DescribeFargateProfile" - ] - }, - "update": { - "permissions": [ - "eks:DescribeFargateProfile", - "eks:ListTagsForResource", - "eks:TagResource", - "eks:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterName", - "/properties/FargateProfileName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ClusterName": { - "description": "Name of the Cluster", - "minLength": 1, - "type": "string" - }, - "FargateProfileName": { - "description": "Name of FargateProfile", - "minLength": 1, - "type": "string" - }, - "PodExecutionRoleArn": { - "description": "The IAM policy arn for pods", - "minLength": 1, - "type": "string" - }, - "Selectors": { - "items": { - "$ref": "#/definitions/Selector" - }, - "minItems": 1, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ClusterName", - "PodExecutionRoleArn", - "Selectors" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::FargateProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/FargateProfileName", + "/properties/PodExecutionRoleArn", + "/properties/Subnets", + "/properties/Selectors" + ], + "definitions": { + "Label": { + "additionalProperties": false, + "description": "A key-value pair to associate with a pod.", + "properties": { + "Key": { + "description": "The key name of the label.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the label. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Selector": { + "additionalProperties": false, + "properties": { + "Labels": { + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "Namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Namespace" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema for AWS::EKS::FargateProfile", + "handlers": { + "create": { + "permissions": [ + "eks:CreateFargateProfile", + "eks:DescribeFargateProfile", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "eks:TagResource" + ] + }, + "delete": { + "permissions": [ + "eks:DeleteFargateProfile", + "eks:DescribeFargateProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListFargateProfiles" + ] + }, + "read": { + "permissions": [ + "eks:DescribeFargateProfile" + ] + }, + "update": { + "permissions": [ + "eks:DescribeFargateProfile", + "eks:ListTagsForResource", + "eks:TagResource", + "eks:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterName", + "/properties/FargateProfileName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ClusterName": { + "description": "Name of the Cluster", + "minLength": 1, + "type": "string" + }, + "FargateProfileName": { + "description": "Name of FargateProfile", + "minLength": 1, + "type": "string" + }, + "PodExecutionRoleArn": { + "description": "The IAM policy arn for pods", + "minLength": 1, + "type": "string" + }, + "Selectors": { + "items": { + "$ref": "#/definitions/Selector" + }, + "minItems": 1, + "type": "array" + }, + "Subnets": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ClusterName", + "PodExecutionRoleArn", + "Selectors" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "eks:TagResource", + "eks:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::FargateProfile" +} diff --git a/schema/aws-eks-identityproviderconfig.json b/schema/aws-eks-identityproviderconfig.json index ad6a8fa..e341fe5 100644 --- a/schema/aws-eks-identityproviderconfig.json +++ b/schema/aws-eks-identityproviderconfig.json @@ -1,199 +1,199 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Oidc", - "/properties/Type", - "/properties/IdentityProviderConfigName", - "/properties/ClusterName" - ], - "definitions": { - "OidcIdentityProviderConfig": { - "additionalProperties": false, - "description": "An object representing an OpenID Connect (OIDC) configuration.", - "properties": { - "ClientId": { - "description": "This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.", - "type": "string" - }, - "GroupsClaim": { - "description": "The JWT claim that the provider uses to return your groups.", - "type": "string" - }, - "GroupsPrefix": { - "description": "The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).", - "type": "string" - }, - "IssuerUrl": { - "description": "The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.", - "type": "string" - }, - "RequiredClaims": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RequiredClaim" - }, - "type": "array", - "uniqueItems": true - }, - "UsernameClaim": { - "description": "The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.", - "type": "string" - }, - "UsernamePrefix": { - "description": "The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.", - "type": "string" - } - }, - "required": [ - "ClientId", - "IssuerUrl" - ], - "type": "object" - }, - "RequiredClaim": { - "additionalProperties": false, - "description": "The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.", - "properties": { - "Key": { - "description": "The key of the requiredClaims.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the requiredClaims.", - "maxLength": 253, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An object representing an Amazon EKS IdentityProviderConfig.", - "handlers": { - "create": { - "permissions": [ - "eks:DescribeUpdate", - "eks:AssociateIdentityProviderConfig", - "eks:DescribeIdentityProviderConfig", - "eks:TagResource" - ] - }, - "delete": { - "permissions": [ - "eks:DisassociateIdentityProviderConfig", - "eks:DescribeIdentityProviderConfig" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListIdentityProviderConfigs" - ] - }, - "read": { - "permissions": [ - "eks:DescribeIdentityProviderConfig" - ] - }, - "update": { - "permissions": [ - "eks:DescribeIdentityProviderConfig", - "eks:TagResource", - "eks:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/IdentityProviderConfigName", - "/properties/ClusterName", - "/properties/Type" - ], - "properties": { - "ClusterName": { - "description": "The name of the identity provider configuration.", - "type": "string" - }, - "IdentityProviderConfigArn": { - "description": "The ARN of the configuration.", - "type": "string" - }, - "IdentityProviderConfigName": { - "description": "The name of the OIDC provider configuration.", - "type": "string" - }, - "Oidc": { - "$ref": "#/definitions/OidcIdentityProviderConfig" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the identity provider configuration.", - "enum": [ - "oidc" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IdentityProviderConfigArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Type", - "ClusterName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::IdentityProviderConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Oidc", + "/properties/Type", + "/properties/IdentityProviderConfigName", + "/properties/ClusterName" + ], + "definitions": { + "OidcIdentityProviderConfig": { + "additionalProperties": false, + "description": "An object representing an OpenID Connect (OIDC) configuration.", + "properties": { + "ClientId": { + "description": "This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.", + "type": "string" + }, + "GroupsClaim": { + "description": "The JWT claim that the provider uses to return your groups.", + "type": "string" + }, + "GroupsPrefix": { + "description": "The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups).", + "type": "string" + }, + "IssuerUrl": { + "description": "The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens.", + "type": "string" + }, + "RequiredClaims": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RequiredClaim" + }, + "type": "array", + "uniqueItems": true + }, + "UsernameClaim": { + "description": "The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.", + "type": "string" + }, + "UsernamePrefix": { + "description": "The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.", + "type": "string" + } + }, + "required": [ + "ClientId", + "IssuerUrl" + ], + "type": "object" + }, + "RequiredClaim": { + "additionalProperties": false, + "description": "The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.", + "properties": { + "Key": { + "description": "The key of the requiredClaims.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the requiredClaims.", + "maxLength": 253, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An object representing an Amazon EKS IdentityProviderConfig.", + "handlers": { + "create": { + "permissions": [ + "eks:DescribeUpdate", + "eks:AssociateIdentityProviderConfig", + "eks:DescribeIdentityProviderConfig", + "eks:TagResource" + ] + }, + "delete": { + "permissions": [ + "eks:DisassociateIdentityProviderConfig", + "eks:DescribeIdentityProviderConfig" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListIdentityProviderConfigs" + ] + }, + "read": { + "permissions": [ + "eks:DescribeIdentityProviderConfig" + ] + }, + "update": { + "permissions": [ + "eks:DescribeIdentityProviderConfig", + "eks:TagResource", + "eks:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdentityProviderConfigName", + "/properties/ClusterName", + "/properties/Type" + ], + "properties": { + "ClusterName": { + "description": "The name of the identity provider configuration.", + "type": "string" + }, + "IdentityProviderConfigArn": { + "description": "The ARN of the configuration.", + "type": "string" + }, + "IdentityProviderConfigName": { + "description": "The name of the OIDC provider configuration.", + "type": "string" + }, + "Oidc": { + "$ref": "#/definitions/OidcIdentityProviderConfig" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the identity provider configuration.", + "enum": [ + "oidc" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdentityProviderConfigArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Type", + "ClusterName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::IdentityProviderConfig" +} diff --git a/schema/aws-eks-nodegroup.json b/schema/aws-eks-nodegroup.json index f352535..c487f4e 100644 --- a/schema/aws-eks-nodegroup.json +++ b/schema/aws-eks-nodegroup.json @@ -1,313 +1,313 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CapacityType", - "/properties/NodegroupName", - "/properties/RemoteAccess", - "/properties/NodeRole", - "/properties/ClusterName", - "/properties/InstanceTypes", - "/properties/DiskSize", - "/properties/AmiType", - "/properties/Subnets" - ], - "definitions": { - "LaunchTemplateSpecification": { - "additionalProperties": false, - "description": "An object representing a launch template specification for AWS EKS Nodegroup.", - "properties": { - "Id": { - "minLength": 1, - "type": "string" - }, - "Name": { - "minLength": 1, - "type": "string" - }, - "Version": { - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "RemoteAccess": { - "additionalProperties": false, - "description": "An object representing a remote access configuration specification for AWS EKS Nodegroup.", - "properties": { - "Ec2SshKey": { - "type": "string" - }, - "SourceSecurityGroups": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Ec2SshKey" - ], - "type": "object" - }, - "ScalingConfig": { - "additionalProperties": false, - "description": "An object representing a auto scaling group specification for AWS EKS Nodegroup.", - "properties": { - "DesiredSize": { - "minimum": 0, - "type": "integer" - }, - "MaxSize": { - "minimum": 1, - "type": "integer" - }, - "MinSize": { - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "Taint": { - "additionalProperties": false, - "description": "An object representing a Taint specification for AWS EKS Nodegroup.", - "properties": { - "Effect": { - "minLength": 1, - "type": "string" - }, - "Key": { - "minLength": 1, - "type": "string" - }, - "Value": { - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "UpdateConfig": { - "additionalProperties": false, - "description": "The node group update configuration.", - "properties": { - "MaxUnavailable": { - "description": "The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. ", - "minimum": 1, - "type": "number" - }, - "MaxUnavailablePercentage": { - "description": "The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.", - "maximum": 100, - "minimum": 1, - "type": "number" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::EKS::Nodegroup", - "handlers": { - "create": { - "permissions": [ - "eks:CreateNodegroup", - "eks:DescribeNodegroup", - "eks:TagResource", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:DescribeSecurityGroups", - "ec2:DescribeKeyPairs", - "ec2:CreateTags", - "ec2:DeleteTags", - "ec2:DescribeRouteTables", - "ec2:DescribeLaunchTemplates", - "ec2:DescribeLaunchTemplateVersions", - "ec2:RunInstances", - "iam:CreateServiceLinkedRole", - "iam:GetRole", - "iam:PassRole", - "iam:ListAttachedRolePolicies" - ] - }, - "delete": { - "permissions": [ - "eks:DeleteNodegroup", - "eks:DescribeNodegroup" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListNodegroups" - ] - }, - "read": { - "permissions": [ - "eks:DescribeNodegroup" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "eks:DescribeNodegroup", - "eks:DescribeUpdate", - "eks:ListUpdates", - "eks:TagResource", - "eks:UntagResource", - "eks:UpdateNodegroupConfig", - "eks:UpdateNodegroupVersion" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AmiType": { - "description": "The AMI type for your node group.", - "type": "string" - }, - "Arn": { - "type": "string" - }, - "CapacityType": { - "description": "The capacity type of your managed node group.", - "type": "string" - }, - "ClusterName": { - "description": "Name of the cluster to create the node group in.", - "minLength": 1, - "type": "string" - }, - "DiskSize": { - "description": "The root device disk size (in GiB) for your node group instances.", - "type": "integer" - }, - "ForceUpdateEnabled": { - "default": false, - "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.", - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "InstanceTypes": { - "description": "Specify the instance types for a node group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Labels": { - "additionalProperties": false, - "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created.", - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification", - "description": "An object representing a node group's launch template specification." - }, - "NodeRole": { - "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group.", - "type": "string" - }, - "NodegroupName": { - "description": "The unique name to give your node group.", - "minLength": 1, - "type": "string" - }, - "ReleaseVersion": { - "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group.", - "type": "string" - }, - "RemoteAccess": { - "$ref": "#/definitions/RemoteAccess", - "description": "The remote access (SSH) configuration to use with your node group." - }, - "ScalingConfig": { - "$ref": "#/definitions/ScalingConfig", - "description": "The scaling configuration details for the Auto Scaling group that is created for your node group." - }, - "Subnets": { - "description": "The subnets to use for the Auto Scaling group that is created for your node group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "additionalProperties": false, - "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.", - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "Taints": { - "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Taint" - }, - "type": "array" - }, - "UpdateConfig": { - "$ref": "#/definitions/UpdateConfig", - "description": "The node group update configuration." - }, - "Version": { - "description": "The Kubernetes version to use for your managed nodes.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "ClusterName", - "NodeRole", - "Subnets" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "eks:TagResource", - "eks:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::Nodegroup", - "writeOnlyProperties": [ - "/properties/ForceUpdateEnabled" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CapacityType", + "/properties/NodegroupName", + "/properties/RemoteAccess", + "/properties/NodeRole", + "/properties/ClusterName", + "/properties/InstanceTypes", + "/properties/DiskSize", + "/properties/AmiType", + "/properties/Subnets" + ], + "definitions": { + "LaunchTemplateSpecification": { + "additionalProperties": false, + "description": "An object representing a launch template specification for AWS EKS Nodegroup.", + "properties": { + "Id": { + "minLength": 1, + "type": "string" + }, + "Name": { + "minLength": 1, + "type": "string" + }, + "Version": { + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "RemoteAccess": { + "additionalProperties": false, + "description": "An object representing a remote access configuration specification for AWS EKS Nodegroup.", + "properties": { + "Ec2SshKey": { + "type": "string" + }, + "SourceSecurityGroups": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Ec2SshKey" + ], + "type": "object" + }, + "ScalingConfig": { + "additionalProperties": false, + "description": "An object representing a auto scaling group specification for AWS EKS Nodegroup.", + "properties": { + "DesiredSize": { + "minimum": 0, + "type": "integer" + }, + "MaxSize": { + "minimum": 1, + "type": "integer" + }, + "MinSize": { + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "Taint": { + "additionalProperties": false, + "description": "An object representing a Taint specification for AWS EKS Nodegroup.", + "properties": { + "Effect": { + "minLength": 1, + "type": "string" + }, + "Key": { + "minLength": 1, + "type": "string" + }, + "Value": { + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "UpdateConfig": { + "additionalProperties": false, + "description": "The node group update configuration.", + "properties": { + "MaxUnavailable": { + "description": "The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. ", + "minimum": 1, + "type": "number" + }, + "MaxUnavailablePercentage": { + "description": "The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.", + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::EKS::Nodegroup", + "handlers": { + "create": { + "permissions": [ + "eks:CreateNodegroup", + "eks:DescribeNodegroup", + "eks:TagResource", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeKeyPairs", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeRouteTables", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:RunInstances", + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "iam:PassRole", + "iam:ListAttachedRolePolicies" + ] + }, + "delete": { + "permissions": [ + "eks:DeleteNodegroup", + "eks:DescribeNodegroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListNodegroups" + ] + }, + "read": { + "permissions": [ + "eks:DescribeNodegroup" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "eks:DescribeNodegroup", + "eks:DescribeUpdate", + "eks:ListUpdates", + "eks:TagResource", + "eks:UntagResource", + "eks:UpdateNodegroupConfig", + "eks:UpdateNodegroupVersion" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AmiType": { + "description": "The AMI type for your node group.", + "type": "string" + }, + "Arn": { + "type": "string" + }, + "CapacityType": { + "description": "The capacity type of your managed node group.", + "type": "string" + }, + "ClusterName": { + "description": "Name of the cluster to create the node group in.", + "minLength": 1, + "type": "string" + }, + "DiskSize": { + "description": "The root device disk size (in GiB) for your node group instances.", + "type": "integer" + }, + "ForceUpdateEnabled": { + "default": false, + "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.", + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "InstanceTypes": { + "description": "Specify the instance types for a node group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Labels": { + "additionalProperties": false, + "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created.", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "An object representing a node group's launch template specification." + }, + "NodeRole": { + "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group.", + "type": "string" + }, + "NodegroupName": { + "description": "The unique name to give your node group.", + "minLength": 1, + "type": "string" + }, + "ReleaseVersion": { + "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group.", + "type": "string" + }, + "RemoteAccess": { + "$ref": "#/definitions/RemoteAccess", + "description": "The remote access (SSH) configuration to use with your node group." + }, + "ScalingConfig": { + "$ref": "#/definitions/ScalingConfig", + "description": "The scaling configuration details for the Auto Scaling group that is created for your node group." + }, + "Subnets": { + "description": "The subnets to use for the Auto Scaling group that is created for your node group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "additionalProperties": false, + "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "Taints": { + "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Taint" + }, + "type": "array" + }, + "UpdateConfig": { + "$ref": "#/definitions/UpdateConfig", + "description": "The node group update configuration." + }, + "Version": { + "description": "The Kubernetes version to use for your managed nodes.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "ClusterName", + "NodeRole", + "Subnets" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "eks:TagResource", + "eks:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::Nodegroup", + "writeOnlyProperties": [ + "/properties/ForceUpdateEnabled" + ] +} diff --git a/schema/aws-eks-podidentityassociation.json b/schema/aws-eks-podidentityassociation.json index ca799a8..c517a63 100644 --- a/schema/aws-eks-podidentityassociation.json +++ b/schema/aws-eks-podidentityassociation.json @@ -1,141 +1,145 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName", - "/properties/Namespace", - "/properties/ServiceAccount" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An object representing an Amazon EKS PodIdentityAssociation.", - "handlers": { - "create": { - "permissions": [ - "eks:CreatePodIdentityAssociation", - "eks:DescribePodIdentityAssociation", - "eks:TagResource", - "iam:PassRole", - "iam:GetRole" - ] - }, - "delete": { - "permissions": [ - "eks:DeletePodIdentityAssociation", - "eks:DescribePodIdentityAssociation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterName": { - "$ref": "resource-schema.json#/properties/ClusterName" - } - }, - "required": [ - "ClusterName" - ] - }, - "permissions": [ - "eks:ListPodIdentityAssociations" - ] - }, - "read": { - "permissions": [ - "eks:DescribePodIdentityAssociation" - ] - }, - "update": { - "permissions": [ - "eks:DescribePodIdentityAssociation", - "eks:UpdatePodIdentityAssociation", - "eks:TagResource", - "eks:UntagResource", - "iam:PassRole", - "iam:GetRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationArn" - ], - "properties": { - "AssociationArn": { - "description": "The ARN of the pod identity association.", - "type": "string" - }, - "AssociationId": { - "description": "The ID of the pod identity association.", - "minLength": 1, - "type": "string" - }, - "ClusterName": { - "description": "The cluster that the pod identity association is created for.", - "minLength": 1, - "type": "string" - }, - "Namespace": { - "description": "The Kubernetes namespace that the pod identity association is created for.", - "type": "string" - }, - "RoleArn": { - "description": "The IAM role ARN that the pod identity association is created for.", - "type": "string" - }, - "ServiceAccount": { - "description": "The Kubernetes service account that the pod identity association is created for.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AssociationArn", - "/properties/AssociationId" - ], - "replacementStrategy": "create_then_delete", - "required": [ - "ClusterName", - "RoleArn", - "Namespace", - "ServiceAccount" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EKS::PodIdentityAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/Namespace", + "/properties/ServiceAccount" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An object representing an Amazon EKS PodIdentityAssociation.", + "handlers": { + "create": { + "permissions": [ + "eks:CreatePodIdentityAssociation", + "eks:DescribePodIdentityAssociation", + "eks:TagResource", + "iam:PassRole", + "iam:GetRole" + ] + }, + "delete": { + "permissions": [ + "eks:DeletePodIdentityAssociation", + "eks:DescribePodIdentityAssociation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, + "permissions": [ + "eks:ListPodIdentityAssociations" + ] + }, + "read": { + "permissions": [ + "eks:DescribePodIdentityAssociation" + ] + }, + "update": { + "permissions": [ + "eks:DescribePodIdentityAssociation", + "eks:UpdatePodIdentityAssociation", + "eks:TagResource", + "eks:UntagResource", + "iam:PassRole", + "iam:GetRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationArn" + ], + "properties": { + "AssociationArn": { + "description": "The ARN of the pod identity association.", + "type": "string" + }, + "AssociationId": { + "description": "The ID of the pod identity association.", + "minLength": 1, + "type": "string" + }, + "ClusterName": { + "description": "The cluster that the pod identity association is created for.", + "minLength": 1, + "type": "string" + }, + "Namespace": { + "description": "The Kubernetes namespace that the pod identity association is created for.", + "type": "string" + }, + "RoleArn": { + "description": "The IAM role ARN that the pod identity association is created for.", + "type": "string" + }, + "ServiceAccount": { + "description": "The Kubernetes service account that the pod identity association is created for.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AssociationArn", + "/properties/AssociationId" + ], + "replacementStrategy": "create_then_delete", + "required": [ + "ClusterName", + "RoleArn", + "Namespace", + "ServiceAccount" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "eks:TagResource", + "eks:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EKS::PodIdentityAssociation" +} diff --git a/schema/aws-elasticache-cachecluster.json b/schema/aws-elasticache-cachecluster.json index d4b25b5..d3d8fec 100644 --- a/schema/aws-elasticache-cachecluster.json +++ b/schema/aws-elasticache-cachecluster.json @@ -1,223 +1,223 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Port", - "/properties/SnapshotArns", - "/properties/SnapshotName", - "/properties/CacheSubnetGroupName", - "/properties/ClusterName", - "/properties/NetworkType", - "/properties/Engine" - ], - "definitions": { - "CloudWatchLogsDestinationDetails": { - "additionalProperties": false, - "properties": { - "LogGroup": { - "type": "string" - } - }, - "required": [ - "LogGroup" - ], - "type": "object" - }, - "DestinationDetails": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsDetails": { - "$ref": "#/definitions/CloudWatchLogsDestinationDetails" - }, - "KinesisFirehoseDetails": { - "$ref": "#/definitions/KinesisFirehoseDestinationDetails" - } - }, - "type": "object" - }, - "KinesisFirehoseDestinationDetails": { - "additionalProperties": false, - "properties": { - "DeliveryStream": { - "type": "string" - } - }, - "required": [ - "DeliveryStream" - ], - "type": "object" - }, - "LogDeliveryConfigurationRequest": { - "additionalProperties": false, - "properties": { - "DestinationDetails": { - "$ref": "#/definitions/DestinationDetails" - }, - "DestinationType": { - "type": "string" - }, - "LogFormat": { - "type": "string" - }, - "LogType": { - "type": "string" - } - }, - "required": [ - "LogFormat", - "LogType", - "DestinationType", - "DestinationDetails" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::CacheCluster", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AZMode": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "CacheNodeType": { - "type": "string" - }, - "CacheParameterGroupName": { - "type": "string" - }, - "CacheSecurityGroupNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CacheSubnetGroupName": { - "type": "string" - }, - "ClusterName": { - "type": "string" - }, - "ConfigurationEndpointAddress": { - "type": "string" - }, - "ConfigurationEndpointPort": { - "type": "string" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IpDiscovery": { - "type": "string" - }, - "LogDeliveryConfigurations": { - "items": { - "$ref": "#/definitions/LogDeliveryConfigurationRequest" - }, - "type": "array", - "uniqueItems": true - }, - "NetworkType": { - "type": "string" - }, - "NotificationTopicArn": { - "type": "string" - }, - "NumCacheNodes": { - "type": "integer" - }, - "Port": { - "type": "integer" - }, - "PreferredAvailabilityZone": { - "type": "string" - }, - "PreferredAvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "RedisEndpointAddress": { - "type": "string" - }, - "RedisEndpointPort": { - "type": "string" - }, - "SnapshotArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SnapshotName": { - "type": "string" - }, - "SnapshotRetentionLimit": { - "type": "integer" - }, - "SnapshotWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitEncryptionEnabled": { - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ConfigurationEndpoint.Address", - "/properties/Id", - "/properties/ConfigurationEndpoint.Port", - "/properties/RedisEndpoint.Port", - "/properties/RedisEndpoint.Address" - ], - "required": [ - "CacheNodeType", - "NumCacheNodes", - "Engine" - ], - "typeName": "AWS::ElastiCache::CacheCluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Port", + "/properties/SnapshotArns", + "/properties/SnapshotName", + "/properties/CacheSubnetGroupName", + "/properties/ClusterName", + "/properties/NetworkType", + "/properties/Engine" + ], + "definitions": { + "CloudWatchLogsDestinationDetails": { + "additionalProperties": false, + "properties": { + "LogGroup": { + "type": "string" + } + }, + "required": [ + "LogGroup" + ], + "type": "object" + }, + "DestinationDetails": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsDetails": { + "$ref": "#/definitions/CloudWatchLogsDestinationDetails" + }, + "KinesisFirehoseDetails": { + "$ref": "#/definitions/KinesisFirehoseDestinationDetails" + } + }, + "type": "object" + }, + "KinesisFirehoseDestinationDetails": { + "additionalProperties": false, + "properties": { + "DeliveryStream": { + "type": "string" + } + }, + "required": [ + "DeliveryStream" + ], + "type": "object" + }, + "LogDeliveryConfigurationRequest": { + "additionalProperties": false, + "properties": { + "DestinationDetails": { + "$ref": "#/definitions/DestinationDetails" + }, + "DestinationType": { + "type": "string" + }, + "LogFormat": { + "type": "string" + }, + "LogType": { + "type": "string" + } + }, + "required": [ + "LogFormat", + "LogType", + "DestinationType", + "DestinationDetails" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::CacheCluster", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AZMode": { + "type": "string" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "CacheNodeType": { + "type": "string" + }, + "CacheParameterGroupName": { + "type": "string" + }, + "CacheSecurityGroupNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CacheSubnetGroupName": { + "type": "string" + }, + "ClusterName": { + "type": "string" + }, + "ConfigurationEndpointAddress": { + "type": "string" + }, + "ConfigurationEndpointPort": { + "type": "string" + }, + "Engine": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IpDiscovery": { + "type": "string" + }, + "LogDeliveryConfigurations": { + "items": { + "$ref": "#/definitions/LogDeliveryConfigurationRequest" + }, + "type": "array", + "uniqueItems": true + }, + "NetworkType": { + "type": "string" + }, + "NotificationTopicArn": { + "type": "string" + }, + "NumCacheNodes": { + "type": "integer" + }, + "Port": { + "type": "integer" + }, + "PreferredAvailabilityZone": { + "type": "string" + }, + "PreferredAvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "RedisEndpointAddress": { + "type": "string" + }, + "RedisEndpointPort": { + "type": "string" + }, + "SnapshotArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SnapshotName": { + "type": "string" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "VpcSecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ConfigurationEndpoint.Address", + "/properties/Id", + "/properties/ConfigurationEndpoint.Port", + "/properties/RedisEndpoint.Port", + "/properties/RedisEndpoint.Address" + ], + "required": [ + "CacheNodeType", + "NumCacheNodes", + "Engine" + ], + "typeName": "AWS::ElastiCache::CacheCluster" +} diff --git a/schema/aws-elasticache-globalreplicationgroup.json b/schema/aws-elasticache-globalreplicationgroup.json index d20c033..f55391a 100644 --- a/schema/aws-elasticache-globalreplicationgroup.json +++ b/schema/aws-elasticache-globalreplicationgroup.json @@ -1,179 +1,179 @@ -{ - "additionalProperties": false, - "definitions": { - "GlobalReplicationGroupMember": { - "additionalProperties": false, - "properties": { - "ReplicationGroupId": { - "description": "Regionally unique identifier for the member i.e. ReplicationGroupId.", - "type": "string" - }, - "ReplicationGroupRegion": { - "description": "The AWS region of the Global Datastore member.", - "type": "string" - }, - "Role": { - "description": "Indicates the role of the member, primary or secondary.", - "enum": [ - "PRIMARY", - "SECONDARY" - ], - "type": "string" - } - }, - "type": "object" - }, - "RegionalConfiguration": { - "additionalProperties": false, - "properties": { - "ReplicationGroupId": { - "description": "The replication group id of the Global Datastore member.", - "type": "string" - }, - "ReplicationGroupRegion": { - "description": "The AWS region of the Global Datastore member.", - "type": "string" - }, - "ReshardingConfigurations": { - "description": "A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. ", - "items": { - "$ref": "#/definitions/ReshardingConfiguration" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ReshardingConfiguration": { - "additionalProperties": false, - "properties": { - "NodeGroupId": { - "description": "Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.", - "type": "string" - }, - "PreferredAvailabilityZones": { - "description": "A list of preferred availability zones for the nodes of new node groups.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.", - "handlers": { - "create": { - "permissions": [ - "elasticache:CreateGlobalReplicationGroup", - "elasticache:DescribeGlobalReplicationGroups" - ] - }, - "delete": { - "permissions": [ - "elasticache:DeleteGlobalReplicationGroup", - "elasticache:DisassociateGlobalReplicationGroup", - "elasticache:DescribeGlobalReplicationGroups" - ] - }, - "list": { - "permissions": [ - "elasticache:DescribeGlobalReplicationGroups" - ] - }, - "read": { - "permissions": [ - "elasticache:DescribeGlobalReplicationGroups" - ] - }, - "update": { - "permissions": [ - "elasticache:ModifyGlobalReplicationGroup", - "elasticache:FailoverGlobalReplicationGroup", - "elasticache:DescribeGlobalReplicationGroups", - "elasticache:IncreaseNodeGroupsInGlobalReplicationGroup", - "elasticache:DecreaseNodeGroupsInGlobalReplicationGroup", - "elasticache:DisassociateGlobalReplicationGroup", - "elasticache:RebalanceSlotsInGlobalReplicationGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalReplicationGroupId" - ], - "properties": { - "AutomaticFailoverEnabled": { - "description": "AutomaticFailoverEnabled", - "type": "boolean" - }, - "CacheNodeType": { - "description": "The cache node type of the Global Datastore", - "type": "string" - }, - "CacheParameterGroupName": { - "description": "Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.", - "type": "string" - }, - "EngineVersion": { - "description": "The engine version of the Global Datastore.", - "type": "string" - }, - "GlobalNodeGroupCount": { - "description": "Indicates the number of node groups in the Global Datastore.", - "type": "integer" - }, - "GlobalReplicationGroupDescription": { - "description": "The optional description of the Global Datastore", - "type": "string" - }, - "GlobalReplicationGroupId": { - "description": "The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.", - "type": "string" - }, - "GlobalReplicationGroupIdSuffix": { - "description": "The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. ", - "type": "string" - }, - "Members": { - "description": "The replication groups that comprise the Global Datastore.", - "items": { - "$ref": "#/definitions/GlobalReplicationGroupMember" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "RegionalConfigurations": { - "description": "Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore ", - "items": { - "$ref": "#/definitions/RegionalConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "Status": { - "description": "The status of the Global Datastore", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/GlobalReplicationGroupId", - "/properties/Status" - ], - "required": [ - "Members" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", - "typeName": "AWS::ElastiCache::GlobalReplicationGroup", - "writeOnlyProperties": [ - "/properties/GlobalReplicationGroupIdSuffix", - "/properties/AutomaticFailoverEnabled", - "/properties/CacheNodeType", - "/properties/EngineVersion", - "/properties/GlobalNodeGroupCount", - "/properties/RegionalConfigurations" - ] -} +{ + "additionalProperties": false, + "definitions": { + "GlobalReplicationGroupMember": { + "additionalProperties": false, + "properties": { + "ReplicationGroupId": { + "description": "Regionally unique identifier for the member i.e. ReplicationGroupId.", + "type": "string" + }, + "ReplicationGroupRegion": { + "description": "The AWS region of the Global Datastore member.", + "type": "string" + }, + "Role": { + "description": "Indicates the role of the member, primary or secondary.", + "enum": [ + "PRIMARY", + "SECONDARY" + ], + "type": "string" + } + }, + "type": "object" + }, + "RegionalConfiguration": { + "additionalProperties": false, + "properties": { + "ReplicationGroupId": { + "description": "The replication group id of the Global Datastore member.", + "type": "string" + }, + "ReplicationGroupRegion": { + "description": "The AWS region of the Global Datastore member.", + "type": "string" + }, + "ReshardingConfigurations": { + "description": "A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. ", + "items": { + "$ref": "#/definitions/ReshardingConfiguration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ReshardingConfiguration": { + "additionalProperties": false, + "properties": { + "NodeGroupId": { + "description": "Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.", + "type": "string" + }, + "PreferredAvailabilityZones": { + "description": "A list of preferred availability zones for the nodes of new node groups.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.", + "handlers": { + "create": { + "permissions": [ + "elasticache:CreateGlobalReplicationGroup", + "elasticache:DescribeGlobalReplicationGroups" + ] + }, + "delete": { + "permissions": [ + "elasticache:DeleteGlobalReplicationGroup", + "elasticache:DisassociateGlobalReplicationGroup", + "elasticache:DescribeGlobalReplicationGroups" + ] + }, + "list": { + "permissions": [ + "elasticache:DescribeGlobalReplicationGroups" + ] + }, + "read": { + "permissions": [ + "elasticache:DescribeGlobalReplicationGroups" + ] + }, + "update": { + "permissions": [ + "elasticache:ModifyGlobalReplicationGroup", + "elasticache:FailoverGlobalReplicationGroup", + "elasticache:DescribeGlobalReplicationGroups", + "elasticache:IncreaseNodeGroupsInGlobalReplicationGroup", + "elasticache:DecreaseNodeGroupsInGlobalReplicationGroup", + "elasticache:DisassociateGlobalReplicationGroup", + "elasticache:RebalanceSlotsInGlobalReplicationGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalReplicationGroupId" + ], + "properties": { + "AutomaticFailoverEnabled": { + "description": "AutomaticFailoverEnabled", + "type": "boolean" + }, + "CacheNodeType": { + "description": "The cache node type of the Global Datastore", + "type": "string" + }, + "CacheParameterGroupName": { + "description": "Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.", + "type": "string" + }, + "EngineVersion": { + "description": "The engine version of the Global Datastore.", + "type": "string" + }, + "GlobalNodeGroupCount": { + "description": "Indicates the number of node groups in the Global Datastore.", + "type": "integer" + }, + "GlobalReplicationGroupDescription": { + "description": "The optional description of the Global Datastore", + "type": "string" + }, + "GlobalReplicationGroupId": { + "description": "The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.", + "type": "string" + }, + "GlobalReplicationGroupIdSuffix": { + "description": "The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. ", + "type": "string" + }, + "Members": { + "description": "The replication groups that comprise the Global Datastore.", + "items": { + "$ref": "#/definitions/GlobalReplicationGroupMember" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RegionalConfigurations": { + "description": "Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore ", + "items": { + "$ref": "#/definitions/RegionalConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "Status": { + "description": "The status of the Global Datastore", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/GlobalReplicationGroupId", + "/properties/Status" + ], + "required": [ + "Members" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", + "typeName": "AWS::ElastiCache::GlobalReplicationGroup", + "writeOnlyProperties": [ + "/properties/GlobalReplicationGroupIdSuffix", + "/properties/AutomaticFailoverEnabled", + "/properties/CacheNodeType", + "/properties/EngineVersion", + "/properties/GlobalNodeGroupCount", + "/properties/RegionalConfigurations" + ] +} diff --git a/schema/aws-elasticache-parametergroup.json b/schema/aws-elasticache-parametergroup.json index f1f8f7a..a162bed 100644 --- a/schema/aws-elasticache-parametergroup.json +++ b/schema/aws-elasticache-parametergroup.json @@ -1,114 +1,114 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CacheParameterGroupFamily" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::ParameterGroup", - "handlers": { - "create": { - "permissions": [ - "ElastiCache:CreateCacheParameterGroup", - "ElastiCache:DescribeCacheParameterGroups", - "ElastiCache:AddTagsToResource", - "ElastiCache:ModifyCacheParameterGroup" - ] - }, - "delete": { - "permissions": [ - "ElastiCache:DescribeCacheParameterGroups", - "ElastiCache:DeleteCacheParameterGroup" - ] - }, - "list": { - "permissions": [ - "ElastiCache:DescribeCacheParameterGroups" - ] - }, - "read": { - "permissions": [ - "ElastiCache:DescribeCacheParameterGroups", - "ElastiCache:DescribeCacheParameters", - "ElastiCache:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ElastiCache:ModifyCacheParameterGroup", - "ElastiCache:DescribeCacheParameterGroups", - "ElastiCache:DescribeCacheParameters", - "ElastiCache:DescribeEngineDefaultParameters", - "ElastiCache:AddTagsToResource", - "ElastiCache:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CacheParameterGroupName" - ], - "properties": { - "CacheParameterGroupFamily": { - "description": "The name of the cache parameter group family that this cache parameter group is compatible with.", - "type": "string" - }, - "CacheParameterGroupName": { - "description": "The name of the Cache Parameter Group.", - "type": "string" - }, - "Description": { - "description": "The description for this cache parameter group.", - "type": "string" - }, - "Properties": { - "additionalProperties": false, - "description": "A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/CacheParameterGroupName" - ], - "required": [ - "Description", - "CacheParameterGroupFamily" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElastiCache::ParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CacheParameterGroupFamily" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::ParameterGroup", + "handlers": { + "create": { + "permissions": [ + "ElastiCache:CreateCacheParameterGroup", + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:AddTagsToResource", + "ElastiCache:ModifyCacheParameterGroup" + ] + }, + "delete": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DeleteCacheParameterGroup" + ] + }, + "list": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups" + ] + }, + "read": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DescribeCacheParameters", + "ElastiCache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ElastiCache:ModifyCacheParameterGroup", + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DescribeCacheParameters", + "ElastiCache:DescribeEngineDefaultParameters", + "ElastiCache:AddTagsToResource", + "ElastiCache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CacheParameterGroupName" + ], + "properties": { + "CacheParameterGroupFamily": { + "description": "The name of the cache parameter group family that this cache parameter group is compatible with.", + "type": "string" + }, + "CacheParameterGroupName": { + "description": "The name of the Cache Parameter Group.", + "type": "string" + }, + "Description": { + "description": "The description for this cache parameter group.", + "type": "string" + }, + "Properties": { + "additionalProperties": false, + "description": "A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/CacheParameterGroupName" + ], + "required": [ + "Description", + "CacheParameterGroupFamily" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::ParameterGroup" +} diff --git a/schema/aws-elasticache-replicationgroup.json b/schema/aws-elasticache-replicationgroup.json index a652ba8..f774b93 100644 --- a/schema/aws-elasticache-replicationgroup.json +++ b/schema/aws-elasticache-replicationgroup.json @@ -1,331 +1,331 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/Port", - "/properties/SnapshotArns", - "/properties/CacheSubnetGroupName", - "/properties/NetworkType", - "/properties/DataTieringEnabled", - "/properties/AtRestEncryptionEnabled", - "/properties/ReplicationGroupId", - "/properties/GlobalReplicationGroupId", - "/properties/ReplicasPerNodeGroup", - "/properties/PreferredCacheClusterAZs", - "/properties/SnapshotName", - "/properties/Engine" - ], - "definitions": { - "CloudWatchLogsDestinationDetails": { - "additionalProperties": false, - "properties": { - "LogGroup": { - "type": "string" - } - }, - "required": [ - "LogGroup" - ], - "type": "object" - }, - "DestinationDetails": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsDetails": { - "$ref": "#/definitions/CloudWatchLogsDestinationDetails" - }, - "KinesisFirehoseDetails": { - "$ref": "#/definitions/KinesisFirehoseDestinationDetails" - } - }, - "type": "object" - }, - "KinesisFirehoseDestinationDetails": { - "additionalProperties": false, - "properties": { - "DeliveryStream": { - "type": "string" - } - }, - "required": [ - "DeliveryStream" - ], - "type": "object" - }, - "LogDeliveryConfigurationRequest": { - "additionalProperties": false, - "properties": { - "DestinationDetails": { - "$ref": "#/definitions/DestinationDetails" - }, - "DestinationType": { - "type": "string" - }, - "LogFormat": { - "type": "string" - }, - "LogType": { - "type": "string" - } - }, - "required": [ - "LogFormat", - "LogType", - "DestinationType", - "DestinationDetails" - ], - "type": "object" - }, - "NodeGroupConfiguration": { - "additionalProperties": false, - "properties": { - "NodeGroupId": { - "type": "string" - }, - "PrimaryAvailabilityZone": { - "type": "string" - }, - "ReplicaAvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ReplicaCount": { - "type": "integer" - }, - "Slots": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::ReplicationGroup", - "primaryIdentifier": [ - "/properties/ReplicationGroupId" - ], - "properties": { - "AtRestEncryptionEnabled": { - "type": "boolean" - }, - "AuthToken": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AutomaticFailoverEnabled": { - "type": "boolean" - }, - "CacheNodeType": { - "type": "string" - }, - "CacheParameterGroupName": { - "type": "string" - }, - "CacheSecurityGroupNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CacheSubnetGroupName": { - "type": "string" - }, - "ClusterMode": { - "type": "string" - }, - "ConfigurationEndPointAddress": { - "type": "string" - }, - "ConfigurationEndPointPort": { - "type": "string" - }, - "DataTieringEnabled": { - "type": "boolean" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "GlobalReplicationGroupId": { - "type": "string" - }, - "IpDiscovery": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "LogDeliveryConfigurations": { - "items": { - "$ref": "#/definitions/LogDeliveryConfigurationRequest" - }, - "type": "array", - "uniqueItems": true - }, - "MultiAZEnabled": { - "type": "boolean" - }, - "NetworkType": { - "type": "string" - }, - "NodeGroupConfiguration": { - "items": { - "$ref": "#/definitions/NodeGroupConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "NotificationTopicArn": { - "type": "string" - }, - "NumCacheClusters": { - "type": "integer" - }, - "NumNodeGroups": { - "type": "integer" - }, - "Port": { - "type": "integer" - }, - "PreferredCacheClusterAZs": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "PrimaryClusterId": { - "type": "string" - }, - "PrimaryEndPointAddress": { - "type": "string" - }, - "PrimaryEndPointPort": { - "type": "string" - }, - "ReadEndPointAddresses": { - "type": "string" - }, - "ReadEndPointAddressesList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ReadEndPointPorts": { - "type": "string" - }, - "ReadEndPointPortsList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ReaderEndPointAddress": { - "type": "string" - }, - "ReaderEndPointPort": { - "type": "string" - }, - "ReplicasPerNodeGroup": { - "type": "integer" - }, - "ReplicationGroupDescription": { - "type": "string" - }, - "ReplicationGroupId": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SnapshotArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SnapshotName": { - "type": "string" - }, - "SnapshotRetentionLimit": { - "type": "integer" - }, - "SnapshotWindow": { - "type": "string" - }, - "SnapshottingClusterId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TransitEncryptionEnabled": { - "type": "boolean" - }, - "TransitEncryptionMode": { - "type": "string" - }, - "UserGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ConfigurationEndPoint.Address", - "/properties/PrimaryEndPoint.Address", - "/properties/PrimaryEndPoint.Port", - "/properties/ReaderEndPoint.Address", - "/properties/ConfigurationEndPoint.Port", - "/properties/ReadEndPoint.Addresses.List", - "/properties/ReadEndPoint.Ports.List", - "/properties/ReaderEndPoint.Port", - "/properties/ReadEndPoint.Addresses", - "/properties/ReadEndPoint.Ports", - "/properties/ReplicationGroupId" - ], - "required": [ - "ReplicationGroupDescription" - ], - "typeName": "AWS::ElastiCache::ReplicationGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/Port", + "/properties/SnapshotArns", + "/properties/CacheSubnetGroupName", + "/properties/NetworkType", + "/properties/DataTieringEnabled", + "/properties/AtRestEncryptionEnabled", + "/properties/ReplicationGroupId", + "/properties/GlobalReplicationGroupId", + "/properties/ReplicasPerNodeGroup", + "/properties/PreferredCacheClusterAZs", + "/properties/SnapshotName", + "/properties/Engine" + ], + "definitions": { + "CloudWatchLogsDestinationDetails": { + "additionalProperties": false, + "properties": { + "LogGroup": { + "type": "string" + } + }, + "required": [ + "LogGroup" + ], + "type": "object" + }, + "DestinationDetails": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsDetails": { + "$ref": "#/definitions/CloudWatchLogsDestinationDetails" + }, + "KinesisFirehoseDetails": { + "$ref": "#/definitions/KinesisFirehoseDestinationDetails" + } + }, + "type": "object" + }, + "KinesisFirehoseDestinationDetails": { + "additionalProperties": false, + "properties": { + "DeliveryStream": { + "type": "string" + } + }, + "required": [ + "DeliveryStream" + ], + "type": "object" + }, + "LogDeliveryConfigurationRequest": { + "additionalProperties": false, + "properties": { + "DestinationDetails": { + "$ref": "#/definitions/DestinationDetails" + }, + "DestinationType": { + "type": "string" + }, + "LogFormat": { + "type": "string" + }, + "LogType": { + "type": "string" + } + }, + "required": [ + "LogFormat", + "LogType", + "DestinationType", + "DestinationDetails" + ], + "type": "object" + }, + "NodeGroupConfiguration": { + "additionalProperties": false, + "properties": { + "NodeGroupId": { + "type": "string" + }, + "PrimaryAvailabilityZone": { + "type": "string" + }, + "ReplicaAvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ReplicaCount": { + "type": "integer" + }, + "Slots": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::ReplicationGroup", + "primaryIdentifier": [ + "/properties/ReplicationGroupId" + ], + "properties": { + "AtRestEncryptionEnabled": { + "type": "boolean" + }, + "AuthToken": { + "type": "string" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "AutomaticFailoverEnabled": { + "type": "boolean" + }, + "CacheNodeType": { + "type": "string" + }, + "CacheParameterGroupName": { + "type": "string" + }, + "CacheSecurityGroupNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CacheSubnetGroupName": { + "type": "string" + }, + "ClusterMode": { + "type": "string" + }, + "ConfigurationEndPointAddress": { + "type": "string" + }, + "ConfigurationEndPointPort": { + "type": "string" + }, + "DataTieringEnabled": { + "type": "boolean" + }, + "Engine": { + "type": "string" + }, + "EngineVersion": { + "type": "string" + }, + "GlobalReplicationGroupId": { + "type": "string" + }, + "IpDiscovery": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "LogDeliveryConfigurations": { + "items": { + "$ref": "#/definitions/LogDeliveryConfigurationRequest" + }, + "type": "array", + "uniqueItems": true + }, + "MultiAZEnabled": { + "type": "boolean" + }, + "NetworkType": { + "type": "string" + }, + "NodeGroupConfiguration": { + "items": { + "$ref": "#/definitions/NodeGroupConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "NotificationTopicArn": { + "type": "string" + }, + "NumCacheClusters": { + "type": "integer" + }, + "NumNodeGroups": { + "type": "integer" + }, + "Port": { + "type": "integer" + }, + "PreferredCacheClusterAZs": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "PrimaryClusterId": { + "type": "string" + }, + "PrimaryEndPointAddress": { + "type": "string" + }, + "PrimaryEndPointPort": { + "type": "string" + }, + "ReadEndPointAddresses": { + "type": "string" + }, + "ReadEndPointAddressesList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ReadEndPointPorts": { + "type": "string" + }, + "ReadEndPointPortsList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ReaderEndPointAddress": { + "type": "string" + }, + "ReaderEndPointPort": { + "type": "string" + }, + "ReplicasPerNodeGroup": { + "type": "integer" + }, + "ReplicationGroupDescription": { + "type": "string" + }, + "ReplicationGroupId": { + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SnapshotArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SnapshotName": { + "type": "string" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": { + "type": "string" + }, + "SnapshottingClusterId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "TransitEncryptionMode": { + "type": "string" + }, + "UserGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ConfigurationEndPoint.Address", + "/properties/PrimaryEndPoint.Address", + "/properties/PrimaryEndPoint.Port", + "/properties/ReaderEndPoint.Address", + "/properties/ConfigurationEndPoint.Port", + "/properties/ReadEndPoint.Addresses.List", + "/properties/ReadEndPoint.Ports.List", + "/properties/ReaderEndPoint.Port", + "/properties/ReadEndPoint.Addresses", + "/properties/ReadEndPoint.Ports", + "/properties/ReplicationGroupId" + ], + "required": [ + "ReplicationGroupDescription" + ], + "typeName": "AWS::ElastiCache::ReplicationGroup" +} diff --git a/schema/aws-elasticache-securitygroup.json b/schema/aws-elasticache-securitygroup.json index 64f44f4..e003cec 100644 --- a/schema/aws-elasticache-securitygroup.json +++ b/schema/aws-elasticache-securitygroup.json @@ -1,47 +1,47 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::SecurityGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Description" - ], - "typeName": "AWS::ElastiCache::SecurityGroup" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::SecurityGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Description" + ], + "typeName": "AWS::ElastiCache::SecurityGroup" +} diff --git a/schema/aws-elasticache-securitygroupingress.json b/schema/aws-elasticache-securitygroupingress.json index fb804e7..385b5a7 100644 --- a/schema/aws-elasticache-securitygroupingress.json +++ b/schema/aws-elasticache-securitygroupingress.json @@ -1,29 +1,29 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::ElastiCache::SecurityGroupIngress", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CacheSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "EC2SecurityGroupName", - "CacheSecurityGroupName" - ], - "typeName": "AWS::ElastiCache::SecurityGroupIngress" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::ElastiCache::SecurityGroupIngress", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CacheSecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupOwnerId": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "EC2SecurityGroupName", + "CacheSecurityGroupName" + ], + "typeName": "AWS::ElastiCache::SecurityGroupIngress" +} diff --git a/schema/aws-elasticache-serverlesscache.json b/schema/aws-elasticache-serverlesscache.json index 91ca6b1..c26741a 100644 --- a/schema/aws-elasticache-serverlesscache.json +++ b/schema/aws-elasticache-serverlesscache.json @@ -1,277 +1,277 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerlessCacheName", - "/properties/Engine", - "/properties/MajorEngineVersion", - "/properties/KmsKeyId", - "/properties/SnapshotArnsToRestore", - "/properties/SubnetIds" - ], - "definitions": { - "CacheUsageLimits": { - "additionalProperties": false, - "description": "The cache capacity limit of the Serverless Cache.", - "properties": { - "DataStorage": { - "$ref": "#/definitions/DataStorage" - }, - "ECPUPerSecond": { - "$ref": "#/definitions/ECPUPerSecond" - } - }, - "type": "object" - }, - "DataStorage": { - "additionalProperties": false, - "description": "The cached data capacity of the Serverless Cache.", - "properties": { - "Maximum": { - "description": "The maximum cached data capacity of the Serverless Cache.", - "type": "integer" - }, - "Minimum": { - "description": "The minimum cached data capacity of the Serverless Cache.", - "type": "integer" - }, - "Unit": { - "description": "The unit of cached data capacity of the Serverless Cache.", - "enum": [ - "GB" - ], - "type": "string" - } - }, - "required": [ - "Unit" - ], - "type": "object" - }, - "ECPUPerSecond": { - "additionalProperties": false, - "description": "The ECPU per second of the Serverless Cache.", - "properties": { - "Maximum": { - "description": "The maximum ECPU per second of the Serverless Cache.", - "type": "integer" - }, - "Minimum": { - "description": "The minimum ECPU per second of the Serverless Cache.", - "type": "integer" - } - }, - "type": "object" - }, - "Endpoint": { - "additionalProperties": false, - "description": "The address and the port.", - "properties": { - "Address": { - "description": "Endpoint address.", - "type": "string" - }, - "Port": { - "description": "Endpoint port.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with Serverless Cache.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.", - "handlers": { - "create": { - "permissions": [ - "elasticache:CreateServerlessCache", - "elasticache:DescribeServerlessCaches", - "elasticache:AddTagsToResource", - "elasticache:ListTagsForResource", - "ec2:CreateTags", - "ec2:CreateVpcEndpoint", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "elasticache:DeleteServerlessCache", - "elasticache:DescribeServerlessCaches", - "elasticache:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "elasticache:DescribeServerlessCaches", - "elasticache:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "elasticache:DescribeServerlessCaches", - "elasticache:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "elasticache:ModifyServerlessCache", - "elasticache:DescribeServerlessCaches", - "elasticache:AddTagsToResource", - "elasticache:ListTagsForResource", - "elasticache:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServerlessCacheName" - ], - "properties": { - "ARN": { - "description": "The ARN of the Serverless Cache.", - "type": "string" - }, - "CacheUsageLimits": { - "$ref": "#/definitions/CacheUsageLimits" - }, - "CreateTime": { - "description": "The creation time of the Serverless Cache.", - "type": "string" - }, - "DailySnapshotTime": { - "description": "The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.", - "type": "string" - }, - "Description": { - "description": "The description of the Serverless Cache.", - "type": "string" - }, - "Endpoint": { - "$ref": "#/definitions/Endpoint" - }, - "Engine": { - "description": "The engine name of the Serverless Cache.", - "type": "string" - }, - "FinalSnapshotName": { - "description": "The final snapshot name which is taken before Serverless Cache is deleted.", - "type": "string" - }, - "FullEngineVersion": { - "description": "The full engine version of the Serverless Cache.", - "type": "string" - }, - "KmsKeyId": { - "description": "The ID of the KMS key used to encrypt the cluster.", - "type": "string" - }, - "MajorEngineVersion": { - "description": "The major engine version of the Serverless Cache.", - "type": "string" - }, - "ReaderEndpoint": { - "$ref": "#/definitions/Endpoint" - }, - "SecurityGroupIds": { - "description": "One or more Amazon VPC security groups associated with this Serverless Cache.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ServerlessCacheName": { - "description": "The name of the Serverless Cache. This value must be unique.", - "type": "string" - }, - "SnapshotArnsToRestore": { - "description": "The ARN's of snapshot to restore Serverless Cache.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SnapshotRetentionLimit": { - "description": "The snapshot retention limit of the Serverless Cache.", - "type": "integer" - }, - "Status": { - "description": "The status of the Serverless Cache.", - "type": "string" - }, - "SubnetIds": { - "description": "The subnet id's of the Serverless Cache.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this Serverless Cache.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "UserGroupId": { - "description": "The ID of the user group.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/FullEngineVersion", - "/properties/CreateTime", - "/properties/Status", - "/properties/Endpoint/Address", - "/properties/Endpoint/Port", - "/properties/ReaderEndpoint/Address", - "/properties/ReaderEndpoint/Port", - "/properties/ARN" - ], - "required": [ - "ServerlessCacheName", - "Engine" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElastiCache::ServerlessCache", - "writeOnlyProperties": [ - "/properties/SnapshotArnsToRestore", - "/properties/FinalSnapshotName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerlessCacheName", + "/properties/Engine", + "/properties/MajorEngineVersion", + "/properties/KmsKeyId", + "/properties/SnapshotArnsToRestore", + "/properties/SubnetIds" + ], + "definitions": { + "CacheUsageLimits": { + "additionalProperties": false, + "description": "The cache capacity limit of the Serverless Cache.", + "properties": { + "DataStorage": { + "$ref": "#/definitions/DataStorage" + }, + "ECPUPerSecond": { + "$ref": "#/definitions/ECPUPerSecond" + } + }, + "type": "object" + }, + "DataStorage": { + "additionalProperties": false, + "description": "The cached data capacity of the Serverless Cache.", + "properties": { + "Maximum": { + "description": "The maximum cached data capacity of the Serverless Cache.", + "type": "integer" + }, + "Minimum": { + "description": "The minimum cached data capacity of the Serverless Cache.", + "type": "integer" + }, + "Unit": { + "description": "The unit of cached data capacity of the Serverless Cache.", + "enum": [ + "GB" + ], + "type": "string" + } + }, + "required": [ + "Unit" + ], + "type": "object" + }, + "ECPUPerSecond": { + "additionalProperties": false, + "description": "The ECPU per second of the Serverless Cache.", + "properties": { + "Maximum": { + "description": "The maximum ECPU per second of the Serverless Cache.", + "type": "integer" + }, + "Minimum": { + "description": "The minimum ECPU per second of the Serverless Cache.", + "type": "integer" + } + }, + "type": "object" + }, + "Endpoint": { + "additionalProperties": false, + "description": "The address and the port.", + "properties": { + "Address": { + "description": "Endpoint address.", + "type": "string" + }, + "Port": { + "description": "Endpoint port.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with Serverless Cache.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.", + "handlers": { + "create": { + "permissions": [ + "elasticache:CreateServerlessCache", + "elasticache:DescribeServerlessCaches", + "elasticache:AddTagsToResource", + "elasticache:ListTagsForResource", + "ec2:CreateTags", + "ec2:CreateVpcEndpoint", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "elasticache:DeleteServerlessCache", + "elasticache:DescribeServerlessCaches", + "elasticache:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "elasticache:DescribeServerlessCaches", + "elasticache:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "elasticache:DescribeServerlessCaches", + "elasticache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "elasticache:ModifyServerlessCache", + "elasticache:DescribeServerlessCaches", + "elasticache:AddTagsToResource", + "elasticache:ListTagsForResource", + "elasticache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServerlessCacheName" + ], + "properties": { + "ARN": { + "description": "The ARN of the Serverless Cache.", + "type": "string" + }, + "CacheUsageLimits": { + "$ref": "#/definitions/CacheUsageLimits" + }, + "CreateTime": { + "description": "The creation time of the Serverless Cache.", + "type": "string" + }, + "DailySnapshotTime": { + "description": "The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.", + "type": "string" + }, + "Description": { + "description": "The description of the Serverless Cache.", + "type": "string" + }, + "Endpoint": { + "$ref": "#/definitions/Endpoint" + }, + "Engine": { + "description": "The engine name of the Serverless Cache.", + "type": "string" + }, + "FinalSnapshotName": { + "description": "The final snapshot name which is taken before Serverless Cache is deleted.", + "type": "string" + }, + "FullEngineVersion": { + "description": "The full engine version of the Serverless Cache.", + "type": "string" + }, + "KmsKeyId": { + "description": "The ID of the KMS key used to encrypt the cluster.", + "type": "string" + }, + "MajorEngineVersion": { + "description": "The major engine version of the Serverless Cache.", + "type": "string" + }, + "ReaderEndpoint": { + "$ref": "#/definitions/Endpoint" + }, + "SecurityGroupIds": { + "description": "One or more Amazon VPC security groups associated with this Serverless Cache.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ServerlessCacheName": { + "description": "The name of the Serverless Cache. This value must be unique.", + "type": "string" + }, + "SnapshotArnsToRestore": { + "description": "The ARN's of snapshot to restore Serverless Cache.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SnapshotRetentionLimit": { + "description": "The snapshot retention limit of the Serverless Cache.", + "type": "integer" + }, + "Status": { + "description": "The status of the Serverless Cache.", + "type": "string" + }, + "SubnetIds": { + "description": "The subnet id's of the Serverless Cache.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this Serverless Cache.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "UserGroupId": { + "description": "The ID of the user group.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/FullEngineVersion", + "/properties/CreateTime", + "/properties/Status", + "/properties/Endpoint/Address", + "/properties/Endpoint/Port", + "/properties/ReaderEndpoint/Address", + "/properties/ReaderEndpoint/Port", + "/properties/ARN" + ], + "required": [ + "ServerlessCacheName", + "Engine" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::ServerlessCache", + "writeOnlyProperties": [ + "/properties/SnapshotArnsToRestore", + "/properties/FinalSnapshotName" + ] +} diff --git a/schema/aws-elasticache-subnetgroup.json b/schema/aws-elasticache-subnetgroup.json index 990f65f..09dea73 100644 --- a/schema/aws-elasticache-subnetgroup.json +++ b/schema/aws-elasticache-subnetgroup.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CacheSubnetGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::SubnetGroup", - "handlers": { - "create": { - "permissions": [ - "elasticache:CreateCacheSubnetGroup", - "elasticache:AddTagsToResource", - "elasticache:DescribeCacheSubnetGroups", - "elasticache:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "elasticache:DeleteCacheSubnetGroup", - "elasticache:DescribeCacheSubnetGroups", - "elasticache:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "elasticache:DescribeCacheSubnetGroups" - ] - }, - "read": { - "permissions": [ - "elasticache:DescribeCacheSubnetGroups", - "elasticache:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "elasticache:ModifyCacheSubnetGroup", - "elasticache:DescribeCacheSubnetGroups", - "elasticache:AddTagsToResource", - "elasticache:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CacheSubnetGroupName" - ], - "properties": { - "CacheSubnetGroupName": { - "description": "The name for the cache subnet group. This value is stored as a lowercase string.", - "type": "string" - }, - "Description": { - "description": "The description for the cache subnet group.", - "type": "string" - }, - "SubnetIds": { - "description": "The EC2 subnet IDs for the cache subnet group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Description", - "SubnetIds" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElastiCache::SubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CacheSubnetGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::SubnetGroup", + "handlers": { + "create": { + "permissions": [ + "elasticache:CreateCacheSubnetGroup", + "elasticache:AddTagsToResource", + "elasticache:DescribeCacheSubnetGroups", + "elasticache:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "elasticache:DeleteCacheSubnetGroup", + "elasticache:DescribeCacheSubnetGroups", + "elasticache:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "elasticache:DescribeCacheSubnetGroups" + ] + }, + "read": { + "permissions": [ + "elasticache:DescribeCacheSubnetGroups", + "elasticache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "elasticache:ModifyCacheSubnetGroup", + "elasticache:DescribeCacheSubnetGroups", + "elasticache:AddTagsToResource", + "elasticache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CacheSubnetGroupName" + ], + "properties": { + "CacheSubnetGroupName": { + "description": "The name for the cache subnet group. This value is stored as a lowercase string.", + "type": "string" + }, + "Description": { + "description": "The description for the cache subnet group.", + "type": "string" + }, + "SubnetIds": { + "description": "The EC2 subnet IDs for the cache subnet group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Description", + "SubnetIds" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::SubnetGroup" +} diff --git a/schema/aws-elasticache-user.json b/schema/aws-elasticache-user.json index b3a6596..a009412 100644 --- a/schema/aws-elasticache-user.json +++ b/schema/aws-elasticache-user.json @@ -1,181 +1,181 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserId", - "/properties/UserName", - "/properties/Engine" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::User", - "handlers": { - "create": { - "permissions": [ - "elasticache:CreateUser", - "elasticache:DescribeUsers", - "elasticache:ListTagsForResource", - "elasticache:AddTagsToResource" - ] - }, - "delete": { - "permissions": [ - "elasticache:DeleteUser", - "elasticache:DescribeUsers" - ] - }, - "list": { - "permissions": [ - "elasticache:DescribeUsers", - "elasticache:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "elasticache:DescribeUsers", - "elasticache:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "elasticache:ModifyUser", - "elasticache:DescribeUsers", - "elasticache:ListTagsForResource", - "elasticache:AddTagsToResource", - "elasticache:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserId" - ], - "properties": { - "AccessString": { - "description": "Access permissions string used for this user account.", - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the user account.", - "type": "string" - }, - "AuthenticationMode": { - "additionalProperties": false, - "properties": { - "Passwords": { - "$comment": "List of passwords.", - "description": "Passwords used for this user account. You can create up to two passwords for each user.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "Authentication Type", - "enum": [ - "password", - "no-password-required", - "iam" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Engine": { - "description": "Must be redis.", - "enum": [ - "redis" - ], - "type": "string" - }, - "NoPasswordRequired": { - "description": "Indicates a password is not required for this user account.", - "type": "boolean" - }, - "Passwords": { - "$comment": "List of passwords.", - "description": "Passwords used for this user account. You can create up to two passwords for each user.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Status": { - "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this user.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserId": { - "description": "The ID of the user.", - "pattern": "[a-z][a-z0-9\\\\-]*", - "type": "string" - }, - "UserName": { - "description": "The username of the user.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Arn" - ], - "required": [ - "UserId", - "UserName", - "Engine" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElastiCache::User", - "writeOnlyProperties": [ - "/properties/Passwords", - "/properties/NoPasswordRequired", - "/properties/AccessString", - "/properties/AuthenticationMode" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserId", + "/properties/UserName", + "/properties/Engine" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::User", + "handlers": { + "create": { + "permissions": [ + "elasticache:CreateUser", + "elasticache:DescribeUsers", + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource" + ] + }, + "delete": { + "permissions": [ + "elasticache:DeleteUser", + "elasticache:DescribeUsers" + ] + }, + "list": { + "permissions": [ + "elasticache:DescribeUsers", + "elasticache:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "elasticache:DescribeUsers", + "elasticache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "elasticache:ModifyUser", + "elasticache:DescribeUsers", + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource", + "elasticache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserId" + ], + "properties": { + "AccessString": { + "description": "Access permissions string used for this user account.", + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the user account.", + "type": "string" + }, + "AuthenticationMode": { + "additionalProperties": false, + "properties": { + "Passwords": { + "$comment": "List of passwords.", + "description": "Passwords used for this user account. You can create up to two passwords for each user.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "Authentication Type", + "enum": [ + "password", + "no-password-required", + "iam" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Engine": { + "description": "Must be redis.", + "enum": [ + "redis" + ], + "type": "string" + }, + "NoPasswordRequired": { + "description": "Indicates a password is not required for this user account.", + "type": "boolean" + }, + "Passwords": { + "$comment": "List of passwords.", + "description": "Passwords used for this user account. You can create up to two passwords for each user.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Status": { + "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this user.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserId": { + "description": "The ID of the user.", + "pattern": "[a-z][a-z0-9\\\\-]*", + "type": "string" + }, + "UserName": { + "description": "The username of the user.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn" + ], + "required": [ + "UserId", + "UserName", + "Engine" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::User", + "writeOnlyProperties": [ + "/properties/Passwords", + "/properties/NoPasswordRequired", + "/properties/AccessString", + "/properties/AuthenticationMode" + ] +} diff --git a/schema/aws-elasticache-usergroup.json b/schema/aws-elasticache-usergroup.json index 44a590a..2b21671 100644 --- a/schema/aws-elasticache-usergroup.json +++ b/schema/aws-elasticache-usergroup.json @@ -1,136 +1,136 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserGroupId", - "/properties/Engine" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElastiCache::UserGroup", - "handlers": { - "create": { - "permissions": [ - "elasticache:CreateUserGroup", - "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource", - "elasticache:AddTagsToResource" - ] - }, - "delete": { - "permissions": [ - "elasticache:ModifyReplicationGroup", - "elasticache:DeleteUserGroup", - "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "elasticache:ModifyUserGroup", - "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource", - "elasticache:AddTagsToResource", - "elasticache:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserGroupId" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the user account.", - "type": "string" - }, - "Engine": { - "description": "Must be redis.", - "enum": [ - "redis" - ], - "type": "string" - }, - "Status": { - "description": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this user.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserGroupId": { - "description": "The ID of the user group.", - "pattern": "[a-z][a-z0-9\\\\-]*", - "type": "string" - }, - "UserIds": { - "$comment": "List of users.", - "description": "List of users associated to this user group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Arn" - ], - "required": [ - "UserGroupId", - "Engine", - "UserIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElastiCache::UserGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserGroupId", + "/properties/Engine" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::UserGroup", + "handlers": { + "create": { + "permissions": [ + "elasticache:CreateUserGroup", + "elasticache:DescribeUserGroups", + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource" + ] + }, + "delete": { + "permissions": [ + "elasticache:ModifyReplicationGroup", + "elasticache:DeleteUserGroup", + "elasticache:DescribeUserGroups", + "elasticache:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "elasticache:DescribeUserGroups", + "elasticache:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "elasticache:DescribeUserGroups", + "elasticache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "elasticache:ModifyUserGroup", + "elasticache:DescribeUserGroups", + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource", + "elasticache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserGroupId" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the user account.", + "type": "string" + }, + "Engine": { + "description": "Must be redis.", + "enum": [ + "redis" + ], + "type": "string" + }, + "Status": { + "description": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this user.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserGroupId": { + "description": "The ID of the user group.", + "pattern": "[a-z][a-z0-9\\\\-]*", + "type": "string" + }, + "UserIds": { + "$comment": "List of users.", + "description": "List of users associated to this user group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn" + ], + "required": [ + "UserGroupId", + "Engine", + "UserIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticache", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::UserGroup" +} diff --git a/schema/aws-elasticbeanstalk-application.json b/schema/aws-elasticbeanstalk-application.json index 164a0c9..d2196bf 100644 --- a/schema/aws-elasticbeanstalk-application.json +++ b/schema/aws-elasticbeanstalk-application.json @@ -1,126 +1,126 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "ApplicationResourceLifecycleConfig": { - "additionalProperties": false, - "properties": { - "ServiceRole": { - "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.", - "type": "string" - }, - "VersionLifecycleConfig": { - "$ref": "#/definitions/ApplicationVersionLifecycleConfig", - "description": "Defines lifecycle settings for application versions." - } - }, - "type": "object" - }, - "ApplicationVersionLifecycleConfig": { - "additionalProperties": false, - "properties": { - "MaxAgeRule": { - "$ref": "#/definitions/MaxAgeRule", - "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." - }, - "MaxCountRule": { - "$ref": "#/definitions/MaxCountRule", - "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." - } - }, - "type": "object" - }, - "MaxAgeRule": { - "additionalProperties": false, - "properties": { - "DeleteSourceFromS3": { - "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.", - "type": "boolean" - }, - "Enabled": { - "description": "Specify true to apply the rule, or false to disable it.", - "type": "boolean" - }, - "MaxAgeInDays": { - "description": "Specify the number of days to retain an application versions.", - "type": "integer" - } - }, - "type": "object" - }, - "MaxCountRule": { - "additionalProperties": false, - "properties": { - "DeleteSourceFromS3": { - "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.", - "type": "boolean" - }, - "Enabled": { - "description": "Specify true to apply the rule, or false to disable it.", - "type": "boolean" - }, - "MaxCount": { - "description": "Specify the maximum number of application versions to retain.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "The AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.", - "handlers": { - "create": { - "permissions": [ - "elasticbeanstalk:CreateApplication" - ] - }, - "delete": { - "permissions": [ - "elasticbeanstalk:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "elasticbeanstalk:DescribeApplications" - ] - }, - "read": { - "permissions": [ - "elasticbeanstalk:DescribeApplications" - ] - }, - "update": { - "permissions": [ - "elasticbeanstalk:UpdateApplication", - "elasticbeanstalk:UpdateApplicationResourceLifecycle" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationName" - ], - "properties": { - "ApplicationName": { - "description": "A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.", - "type": "string" - }, - "Description": { - "description": "Your description of the application.", - "type": "string" - }, - "ResourceLifecycleConfig": { - "$ref": "#/definitions/ApplicationResourceLifecycleConfig", - "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ElasticBeanstalk::Application" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "ApplicationResourceLifecycleConfig": { + "additionalProperties": false, + "properties": { + "ServiceRole": { + "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.", + "type": "string" + }, + "VersionLifecycleConfig": { + "$ref": "#/definitions/ApplicationVersionLifecycleConfig", + "description": "Defines lifecycle settings for application versions." + } + }, + "type": "object" + }, + "ApplicationVersionLifecycleConfig": { + "additionalProperties": false, + "properties": { + "MaxAgeRule": { + "$ref": "#/definitions/MaxAgeRule", + "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." + }, + "MaxCountRule": { + "$ref": "#/definitions/MaxCountRule", + "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." + } + }, + "type": "object" + }, + "MaxAgeRule": { + "additionalProperties": false, + "properties": { + "DeleteSourceFromS3": { + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.", + "type": "boolean" + }, + "Enabled": { + "description": "Specify true to apply the rule, or false to disable it.", + "type": "boolean" + }, + "MaxAgeInDays": { + "description": "Specify the number of days to retain an application versions.", + "type": "integer" + } + }, + "type": "object" + }, + "MaxCountRule": { + "additionalProperties": false, + "properties": { + "DeleteSourceFromS3": { + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.", + "type": "boolean" + }, + "Enabled": { + "description": "Specify true to apply the rule, or false to disable it.", + "type": "boolean" + }, + "MaxCount": { + "description": "Specify the maximum number of application versions to retain.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "The AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.", + "handlers": { + "create": { + "permissions": [ + "elasticbeanstalk:CreateApplication" + ] + }, + "delete": { + "permissions": [ + "elasticbeanstalk:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "elasticbeanstalk:DescribeApplications" + ] + }, + "read": { + "permissions": [ + "elasticbeanstalk:DescribeApplications" + ] + }, + "update": { + "permissions": [ + "elasticbeanstalk:UpdateApplication", + "elasticbeanstalk:UpdateApplicationResourceLifecycle" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationName" + ], + "properties": { + "ApplicationName": { + "description": "A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.", + "type": "string" + }, + "Description": { + "description": "Your description of the application.", + "type": "string" + }, + "ResourceLifecycleConfig": { + "$ref": "#/definitions/ApplicationResourceLifecycleConfig", + "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ElasticBeanstalk::Application" +} diff --git a/schema/aws-elasticbeanstalk-applicationversion.json b/schema/aws-elasticbeanstalk-applicationversion.json index 9d28337..4d970ef 100644 --- a/schema/aws-elasticbeanstalk-applicationversion.json +++ b/schema/aws-elasticbeanstalk-applicationversion.json @@ -1,94 +1,94 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceBundle", - "/properties/ApplicationName" - ], - "definitions": { - "SourceBundle": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "description": "The Amazon S3 bucket where the data is located.", - "type": "string" - }, - "S3Key": { - "description": "The Amazon S3 key where the data is located.", - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticBeanstalk::ApplicationVersion", - "handlers": { - "create": { - "permissions": [ - "elasticbeanstalk:CreateApplicationVersion", - "elasticbeanstalk:DescribeApplicationVersions", - "s3:GetObject", - "s3:PutObject" - ] - }, - "delete": { - "permissions": [ - "elasticbeanstalk:DeleteApplicationVersion" - ] - }, - "list": { - "permissions": [ - "elasticbeanstalk:DescribeApplicationVersions" - ] - }, - "read": { - "permissions": [ - "elasticbeanstalk:DescribeApplicationVersions" - ] - }, - "update": { - "permissions": [ - "elasticbeanstalk:UpdateApplicationVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationName", - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "description": "The name of the Elastic Beanstalk application that is associated with this application version. ", - "type": "string" - }, - "Description": { - "description": "A description of this application version.", - "type": "string" - }, - "Id": { - "type": "string" - }, - "SourceBundle": { - "$ref": "#/definitions/SourceBundle", - "description": "The Amazon S3 bucket and key that identify the location of the source bundle for this version. " - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationName", - "SourceBundle" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ElasticBeanstalk::ApplicationVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceBundle", + "/properties/ApplicationName" + ], + "definitions": { + "SourceBundle": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "description": "The Amazon S3 bucket where the data is located.", + "type": "string" + }, + "S3Key": { + "description": "The Amazon S3 key where the data is located.", + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticBeanstalk::ApplicationVersion", + "handlers": { + "create": { + "permissions": [ + "elasticbeanstalk:CreateApplicationVersion", + "elasticbeanstalk:DescribeApplicationVersions", + "s3:GetObject", + "s3:PutObject" + ] + }, + "delete": { + "permissions": [ + "elasticbeanstalk:DeleteApplicationVersion" + ] + }, + "list": { + "permissions": [ + "elasticbeanstalk:DescribeApplicationVersions" + ] + }, + "read": { + "permissions": [ + "elasticbeanstalk:DescribeApplicationVersions" + ] + }, + "update": { + "permissions": [ + "elasticbeanstalk:UpdateApplicationVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationName", + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "description": "The name of the Elastic Beanstalk application that is associated with this application version. ", + "type": "string" + }, + "Description": { + "description": "A description of this application version.", + "type": "string" + }, + "Id": { + "type": "string" + }, + "SourceBundle": { + "$ref": "#/definitions/SourceBundle", + "description": "The Amazon S3 bucket and key that identify the location of the source bundle for this version. " + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationName", + "SourceBundle" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ElasticBeanstalk::ApplicationVersion" +} diff --git a/schema/aws-elasticbeanstalk-configurationtemplate.json b/schema/aws-elasticbeanstalk-configurationtemplate.json index 201e00e..c6bf04d 100644 --- a/schema/aws-elasticbeanstalk-configurationtemplate.json +++ b/schema/aws-elasticbeanstalk-configurationtemplate.json @@ -1,146 +1,146 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName", - "/properties/EnvironmentId", - "/properties/PlatformArn", - "/properties/SolutionStackName", - "/properties/SourceConfiguration" - ], - "definitions": { - "ConfigurationOptionSetting": { - "additionalProperties": false, - "properties": { - "Namespace": { - "description": "A unique namespace that identifies the option's associated AWS resource.", - "type": "string" - }, - "OptionName": { - "description": "The name of the configuration option.", - "type": "string" - }, - "ResourceName": { - "description": "A unique resource name for the option setting. Use it for a time\u2013based scaling configuration option. ", - "type": "string" - }, - "Value": { - "description": "The current value for the configuration option.", - "type": "string" - } - }, - "required": [ - "Namespace", - "OptionName" - ], - "type": "object" - }, - "SourceConfiguration": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "description": "The name of the application associated with the configuration.", - "type": "string" - }, - "TemplateName": { - "description": "The name of the configuration template.", - "type": "string" - } - }, - "required": [ - "TemplateName", - "ApplicationName" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate", - "handlers": { - "create": { - "permissions": [ - "elasticbeanstalk:CreateConfigurationTemplate" - ] - }, - "delete": { - "permissions": [ - "elasticbeanstalk:DeleteConfigurationTemplate", - "elasticbeanstalk:DescribeConfigurationSettings" - ] - }, - "list": { - "permissions": [ - "elasticbeanstalk:DescribeApplications" - ] - }, - "read": { - "permissions": [ - "elasticbeanstalk:DescribeConfigurationSettings" - ] - }, - "update": { - "permissions": [ - "elasticbeanstalk:UpdateConfigurationTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationName", - "/properties/TemplateName" - ], - "properties": { - "ApplicationName": { - "description": "The name of the Elastic Beanstalk application to associate with this configuration template. ", - "type": "string" - }, - "Description": { - "description": "An optional description for this configuration.", - "type": "string" - }, - "EnvironmentId": { - "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. ", - "type": "string" - }, - "OptionSettings": { - "arrayType": "AttributeList", - "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide. ", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigurationOptionSetting" - }, - "type": "array", - "uniqueItems": false - }, - "PlatformArn": { - "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide. ", - "type": "string" - }, - "SolutionStackName": { - "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.\n\n You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.\n\n Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. ", - "type": "string" - }, - "SourceConfiguration": { - "$ref": "#/definitions/SourceConfiguration", - "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.\n\nValues specified in OptionSettings override any values obtained from the SourceConfiguration.\n\nYou must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.\n\nConstraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. " - }, - "TemplateName": { - "description": "The name of the configuration template", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TemplateName" - ], - "required": [ - "ApplicationName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ElasticBeanstalk::ConfigurationTemplate", - "writeOnlyProperties": [ - "/properties/EnvironmentId", - "/properties/SourceConfiguration/ApplicationName", - "/properties/SourceConfiguration/TemplateName" - ] -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName", + "/properties/EnvironmentId", + "/properties/PlatformArn", + "/properties/SolutionStackName", + "/properties/SourceConfiguration" + ], + "definitions": { + "ConfigurationOptionSetting": { + "additionalProperties": false, + "properties": { + "Namespace": { + "description": "A unique namespace that identifies the option's associated AWS resource.", + "type": "string" + }, + "OptionName": { + "description": "The name of the configuration option.", + "type": "string" + }, + "ResourceName": { + "description": "A unique resource name for the option setting. Use it for a time\u2013based scaling configuration option. ", + "type": "string" + }, + "Value": { + "description": "The current value for the configuration option.", + "type": "string" + } + }, + "required": [ + "Namespace", + "OptionName" + ], + "type": "object" + }, + "SourceConfiguration": { + "additionalProperties": false, + "properties": { + "ApplicationName": { + "description": "The name of the application associated with the configuration.", + "type": "string" + }, + "TemplateName": { + "description": "The name of the configuration template.", + "type": "string" + } + }, + "required": [ + "TemplateName", + "ApplicationName" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate", + "handlers": { + "create": { + "permissions": [ + "elasticbeanstalk:CreateConfigurationTemplate" + ] + }, + "delete": { + "permissions": [ + "elasticbeanstalk:DeleteConfigurationTemplate", + "elasticbeanstalk:DescribeConfigurationSettings" + ] + }, + "list": { + "permissions": [ + "elasticbeanstalk:DescribeApplications" + ] + }, + "read": { + "permissions": [ + "elasticbeanstalk:DescribeConfigurationSettings" + ] + }, + "update": { + "permissions": [ + "elasticbeanstalk:UpdateConfigurationTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationName", + "/properties/TemplateName" + ], + "properties": { + "ApplicationName": { + "description": "The name of the Elastic Beanstalk application to associate with this configuration template. ", + "type": "string" + }, + "Description": { + "description": "An optional description for this configuration.", + "type": "string" + }, + "EnvironmentId": { + "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. ", + "type": "string" + }, + "OptionSettings": { + "arrayType": "AttributeList", + "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide. ", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigurationOptionSetting" + }, + "type": "array", + "uniqueItems": false + }, + "PlatformArn": { + "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide. ", + "type": "string" + }, + "SolutionStackName": { + "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.\n\n You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.\n\n Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. ", + "type": "string" + }, + "SourceConfiguration": { + "$ref": "#/definitions/SourceConfiguration", + "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.\n\nValues specified in OptionSettings override any values obtained from the SourceConfiguration.\n\nYou must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.\n\nConstraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. " + }, + "TemplateName": { + "description": "The name of the configuration template", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TemplateName" + ], + "required": [ + "ApplicationName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticbeanstalk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ElasticBeanstalk::ConfigurationTemplate", + "writeOnlyProperties": [ + "/properties/EnvironmentId", + "/properties/SourceConfiguration/ApplicationName", + "/properties/SourceConfiguration/TemplateName" + ] +} diff --git a/schema/aws-elasticbeanstalk-environment.json b/schema/aws-elasticbeanstalk-environment.json index 4508802..8e6cdb0 100644 --- a/schema/aws-elasticbeanstalk-environment.json +++ b/schema/aws-elasticbeanstalk-environment.json @@ -1,210 +1,210 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CNAMEPrefix", - "/properties/EnvironmentName", - "/properties/ApplicationName", - "/properties/SolutionStackName", - "/properties/Tier/Name", - "/properties/Tier/Type" - ], - "definitions": { - "OptionSetting": { - "additionalProperties": false, - "properties": { - "Namespace": { - "description": "A unique namespace that identifies the option's associated AWS resource.", - "type": "string" - }, - "OptionName": { - "description": "The name of the configuration option.", - "type": "string" - }, - "ResourceName": { - "description": "A unique resource name for the option setting. Use it for a time\u2013based scaling configuration option.", - "type": "string" - }, - "Value": { - "description": "The current value for the configuration option.", - "type": "string" - } - }, - "required": [ - "Namespace", - "OptionName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag.", - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Tier": { - "additionalProperties": false, - "properties": { - "Name": { - "description": "The name of this environment tier.", - "type": "string" - }, - "Type": { - "description": "The type of this environment tier.", - "type": "string" - }, - "Version": { - "description": "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticBeanstalk::Environment", - "handlers": { - "create": { - "permissions": [ - "elasticbeanstalk:DescribeEnvironments", - "elasticbeanstalk:CreateEnvironment", - "elasticbeanstalk:AddTags", - "elasticbeanstalk:ListTagsForResource", - "iam:PassRole" - ], - "timeoutInMinutes": 120 - }, - "delete": { - "permissions": [ - "elasticbeanstalk:DescribeEnvironments", - "elasticbeanstalk:TerminateEnvironment" - ], - "timeoutInMinutes": 210 - }, - "list": { - "permissions": [ - "elasticbeanstalk:DescribeEnvironments", - "elasticbeanstalk:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "elasticbeanstalk:DescribeEnvironments", - "elasticbeanstalk:DescribeConfigurationSettings", - "elasticbeanstalk:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "elasticbeanstalk:DescribeEnvironments", - "elasticbeanstalk:UpdateEnvironment", - "elasticbeanstalk:UpdateTagsForResource", - "elasticbeanstalk:AssociateEnvironmentOperationsRole", - "elasticbeanstalk:DisassociateEnvironmentOperationsRole", - "elasticbeanstalk:AddTags", - "elasticbeanstalk:ListTagsForResource", - "iam:PassRole" - ], - "timeoutInMinutes": 300 - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentName" - ], - "properties": { - "ApplicationName": { - "description": "The name of the application that is associated with this environment.", - "type": "string" - }, - "CNAMEPrefix": { - "description": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.", - "type": "string" - }, - "Description": { - "description": "Your description for this environment.", - "type": "string" - }, - "EndpointURL": { - "type": "string" - }, - "EnvironmentName": { - "description": "A unique name for the environment.", - "type": "string" - }, - "OperationsRole": { - "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.", - "type": "string" - }, - "OptionSettings": { - "description": "Key-value pairs defining configuration options for this environment, such as the instance type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OptionSetting" - }, - "type": "array", - "uniqueItems": false - }, - "PlatformArn": { - "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment.", - "type": "string" - }, - "SolutionStackName": { - "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.", - "type": "string" - }, - "Tags": { - "description": "Specifies the tags applied to resources in the environment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TemplateName": { - "description": "The name of the Elastic Beanstalk configuration template to use with the environment.", - "type": "string" - }, - "Tier": { - "$ref": "#/definitions/Tier", - "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." - }, - "VersionLabel": { - "description": "The name of the application version to deploy.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/EndpointURL" - ], - "required": [ - "ApplicationName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElasticBeanstalk::Environment", - "writeOnlyProperties": [ - "/properties/TemplateName", - "/properties/OptionSettings", - "/properties/OptionSettings/*/OptionName", - "/properties/OptionSettings/*/ResourceName", - "/properties/OptionSettings/*/Namespace", - "/properties/OptionSettings/*/Value" - ] -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CNAMEPrefix", + "/properties/EnvironmentName", + "/properties/ApplicationName", + "/properties/SolutionStackName", + "/properties/Tier/Name", + "/properties/Tier/Type" + ], + "definitions": { + "OptionSetting": { + "additionalProperties": false, + "properties": { + "Namespace": { + "description": "A unique namespace that identifies the option's associated AWS resource.", + "type": "string" + }, + "OptionName": { + "description": "The name of the configuration option.", + "type": "string" + }, + "ResourceName": { + "description": "A unique resource name for the option setting. Use it for a time\u2013based scaling configuration option.", + "type": "string" + }, + "Value": { + "description": "The current value for the configuration option.", + "type": "string" + } + }, + "required": [ + "Namespace", + "OptionName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag.", + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Tier": { + "additionalProperties": false, + "properties": { + "Name": { + "description": "The name of this environment tier.", + "type": "string" + }, + "Type": { + "description": "The type of this environment tier.", + "type": "string" + }, + "Version": { + "description": "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticBeanstalk::Environment", + "handlers": { + "create": { + "permissions": [ + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:CreateEnvironment", + "elasticbeanstalk:AddTags", + "elasticbeanstalk:ListTagsForResource", + "iam:PassRole" + ], + "timeoutInMinutes": 120 + }, + "delete": { + "permissions": [ + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:TerminateEnvironment" + ], + "timeoutInMinutes": 210 + }, + "list": { + "permissions": [ + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:DescribeConfigurationSettings", + "elasticbeanstalk:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:UpdateEnvironment", + "elasticbeanstalk:UpdateTagsForResource", + "elasticbeanstalk:AssociateEnvironmentOperationsRole", + "elasticbeanstalk:DisassociateEnvironmentOperationsRole", + "elasticbeanstalk:AddTags", + "elasticbeanstalk:ListTagsForResource", + "iam:PassRole" + ], + "timeoutInMinutes": 300 + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentName" + ], + "properties": { + "ApplicationName": { + "description": "The name of the application that is associated with this environment.", + "type": "string" + }, + "CNAMEPrefix": { + "description": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.", + "type": "string" + }, + "Description": { + "description": "Your description for this environment.", + "type": "string" + }, + "EndpointURL": { + "type": "string" + }, + "EnvironmentName": { + "description": "A unique name for the environment.", + "type": "string" + }, + "OperationsRole": { + "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.", + "type": "string" + }, + "OptionSettings": { + "description": "Key-value pairs defining configuration options for this environment, such as the instance type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OptionSetting" + }, + "type": "array", + "uniqueItems": false + }, + "PlatformArn": { + "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment.", + "type": "string" + }, + "SolutionStackName": { + "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.", + "type": "string" + }, + "Tags": { + "description": "Specifies the tags applied to resources in the environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TemplateName": { + "description": "The name of the Elastic Beanstalk configuration template to use with the environment.", + "type": "string" + }, + "Tier": { + "$ref": "#/definitions/Tier", + "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." + }, + "VersionLabel": { + "description": "The name of the application version to deploy.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/EndpointURL" + ], + "required": [ + "ApplicationName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElasticBeanstalk::Environment", + "writeOnlyProperties": [ + "/properties/TemplateName", + "/properties/OptionSettings", + "/properties/OptionSettings/*/OptionName", + "/properties/OptionSettings/*/ResourceName", + "/properties/OptionSettings/*/Namespace", + "/properties/OptionSettings/*/Value" + ] +} diff --git a/schema/aws-elasticloadbalancing-loadbalancer.json b/schema/aws-elasticloadbalancing-loadbalancer.json index e1ed1ca..d6a1a3d 100644 --- a/schema/aws-elasticloadbalancing-loadbalancer.json +++ b/schema/aws-elasticloadbalancing-loadbalancer.json @@ -1,321 +1,321 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoadBalancerName", - "/properties/Scheme" - ], - "definitions": { - "AccessLoggingPolicy": { - "additionalProperties": false, - "properties": { - "EmitInterval": { - "type": "integer" - }, - "Enabled": { - "type": "boolean" - }, - "S3BucketName": { - "type": "string" - }, - "S3BucketPrefix": { - "type": "string" - } - }, - "required": [ - "Enabled", - "S3BucketName" - ], - "type": "object" - }, - "AppCookieStickinessPolicy": { - "additionalProperties": false, - "properties": { - "CookieName": { - "type": "string" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "PolicyName", - "CookieName" - ], - "type": "object" - }, - "ConnectionDrainingPolicy": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Timeout": { - "type": "integer" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ConnectionSettings": { - "additionalProperties": false, - "properties": { - "IdleTimeout": { - "type": "integer" - } - }, - "required": [ - "IdleTimeout" - ], - "type": "object" - }, - "HealthCheck": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "string" - }, - "Interval": { - "type": "string" - }, - "Target": { - "type": "string" - }, - "Timeout": { - "type": "string" - }, - "UnhealthyThreshold": { - "type": "string" - } - }, - "required": [ - "Target", - "UnhealthyThreshold", - "Timeout", - "HealthyThreshold", - "Interval" - ], - "type": "object" - }, - "LBCookieStickinessPolicy": { - "additionalProperties": false, - "properties": { - "CookieExpirationPeriod": { - "type": "string" - }, - "PolicyName": { - "type": "string" - } - }, - "type": "object" - }, - "Listeners": { - "additionalProperties": false, - "properties": { - "InstancePort": { - "type": "string" - }, - "InstanceProtocol": { - "type": "string" - }, - "LoadBalancerPort": { - "type": "string" - }, - "PolicyNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Protocol": { - "type": "string" - }, - "SSLCertificateId": { - "type": "string" - } - }, - "required": [ - "InstancePort", - "LoadBalancerPort", - "Protocol" - ], - "type": "object" - }, - "Policies": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "type": "object" - }, - "type": "array", - "uniqueItems": true - }, - "InstancePorts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LoadBalancerPorts": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "PolicyName": { - "type": "string" - }, - "PolicyType": { - "type": "string" - } - }, - "required": [ - "PolicyType", - "PolicyName", - "Attributes" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticLoadBalancing::LoadBalancer", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessLoggingPolicy": { - "$ref": "#/definitions/AccessLoggingPolicy" - }, - "AppCookieStickinessPolicy": { - "items": { - "$ref": "#/definitions/AppCookieStickinessPolicy" - }, - "type": "array", - "uniqueItems": true - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CanonicalHostedZoneName": { - "type": "string" - }, - "CanonicalHostedZoneNameID": { - "type": "string" - }, - "ConnectionDrainingPolicy": { - "$ref": "#/definitions/ConnectionDrainingPolicy" - }, - "ConnectionSettings": { - "$ref": "#/definitions/ConnectionSettings" - }, - "CrossZone": { - "type": "boolean" - }, - "DNSName": { - "type": "string" - }, - "HealthCheck": { - "$ref": "#/definitions/HealthCheck" - }, - "Id": { - "type": "string" - }, - "Instances": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LBCookieStickinessPolicy": { - "items": { - "$ref": "#/definitions/LBCookieStickinessPolicy" - }, - "type": "array", - "uniqueItems": true - }, - "Listeners": { - "items": { - "$ref": "#/definitions/Listeners" - }, - "type": "array", - "uniqueItems": true - }, - "LoadBalancerName": { - "type": "string" - }, - "Policies": { - "items": { - "$ref": "#/definitions/Policies" - }, - "type": "array", - "uniqueItems": true - }, - "Scheme": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SourceSecurityGroupGroupName": { - "type": "string" - }, - "SourceSecurityGroupOwnerAlias": { - "type": "string" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/CanonicalHostedZoneName", - "/properties/CanonicalHostedZoneNameID", - "/properties/SourceSecurityGroup.GroupName", - "/properties/DNSName", - "/properties/SourceSecurityGroup.OwnerAlias" - ], - "required": [ - "Listeners" - ], - "typeName": "AWS::ElasticLoadBalancing::LoadBalancer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoadBalancerName", + "/properties/Scheme" + ], + "definitions": { + "AccessLoggingPolicy": { + "additionalProperties": false, + "properties": { + "EmitInterval": { + "type": "integer" + }, + "Enabled": { + "type": "boolean" + }, + "S3BucketName": { + "type": "string" + }, + "S3BucketPrefix": { + "type": "string" + } + }, + "required": [ + "Enabled", + "S3BucketName" + ], + "type": "object" + }, + "AppCookieStickinessPolicy": { + "additionalProperties": false, + "properties": { + "CookieName": { + "type": "string" + }, + "PolicyName": { + "type": "string" + } + }, + "required": [ + "PolicyName", + "CookieName" + ], + "type": "object" + }, + "ConnectionDrainingPolicy": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ConnectionSettings": { + "additionalProperties": false, + "properties": { + "IdleTimeout": { + "type": "integer" + } + }, + "required": [ + "IdleTimeout" + ], + "type": "object" + }, + "HealthCheck": { + "additionalProperties": false, + "properties": { + "HealthyThreshold": { + "type": "string" + }, + "Interval": { + "type": "string" + }, + "Target": { + "type": "string" + }, + "Timeout": { + "type": "string" + }, + "UnhealthyThreshold": { + "type": "string" + } + }, + "required": [ + "Target", + "UnhealthyThreshold", + "Timeout", + "HealthyThreshold", + "Interval" + ], + "type": "object" + }, + "LBCookieStickinessPolicy": { + "additionalProperties": false, + "properties": { + "CookieExpirationPeriod": { + "type": "string" + }, + "PolicyName": { + "type": "string" + } + }, + "type": "object" + }, + "Listeners": { + "additionalProperties": false, + "properties": { + "InstancePort": { + "type": "string" + }, + "InstanceProtocol": { + "type": "string" + }, + "LoadBalancerPort": { + "type": "string" + }, + "PolicyNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Protocol": { + "type": "string" + }, + "SSLCertificateId": { + "type": "string" + } + }, + "required": [ + "InstancePort", + "LoadBalancerPort", + "Protocol" + ], + "type": "object" + }, + "Policies": { + "additionalProperties": false, + "properties": { + "Attributes": { + "items": { + "type": "object" + }, + "type": "array", + "uniqueItems": true + }, + "InstancePorts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LoadBalancerPorts": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "PolicyName": { + "type": "string" + }, + "PolicyType": { + "type": "string" + } + }, + "required": [ + "PolicyType", + "PolicyName", + "Attributes" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticLoadBalancing::LoadBalancer", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessLoggingPolicy": { + "$ref": "#/definitions/AccessLoggingPolicy" + }, + "AppCookieStickinessPolicy": { + "items": { + "$ref": "#/definitions/AppCookieStickinessPolicy" + }, + "type": "array", + "uniqueItems": true + }, + "AvailabilityZones": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CanonicalHostedZoneName": { + "type": "string" + }, + "CanonicalHostedZoneNameID": { + "type": "string" + }, + "ConnectionDrainingPolicy": { + "$ref": "#/definitions/ConnectionDrainingPolicy" + }, + "ConnectionSettings": { + "$ref": "#/definitions/ConnectionSettings" + }, + "CrossZone": { + "type": "boolean" + }, + "DNSName": { + "type": "string" + }, + "HealthCheck": { + "$ref": "#/definitions/HealthCheck" + }, + "Id": { + "type": "string" + }, + "Instances": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LBCookieStickinessPolicy": { + "items": { + "$ref": "#/definitions/LBCookieStickinessPolicy" + }, + "type": "array", + "uniqueItems": true + }, + "Listeners": { + "items": { + "$ref": "#/definitions/Listeners" + }, + "type": "array", + "uniqueItems": true + }, + "LoadBalancerName": { + "type": "string" + }, + "Policies": { + "items": { + "$ref": "#/definitions/Policies" + }, + "type": "array", + "uniqueItems": true + }, + "Scheme": { + "type": "string" + }, + "SecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SourceSecurityGroupGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerAlias": { + "type": "string" + }, + "Subnets": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CanonicalHostedZoneName", + "/properties/CanonicalHostedZoneNameID", + "/properties/SourceSecurityGroup.GroupName", + "/properties/DNSName", + "/properties/SourceSecurityGroup.OwnerAlias" + ], + "required": [ + "Listeners" + ], + "typeName": "AWS::ElasticLoadBalancing::LoadBalancer" +} diff --git a/schema/aws-elasticloadbalancingv2-listener.json b/schema/aws-elasticloadbalancingv2-listener.json index 8eda9bf..3edb499 100644 --- a/schema/aws-elasticloadbalancingv2-listener.json +++ b/schema/aws-elasticloadbalancingv2-listener.json @@ -1,474 +1,500 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoadBalancerArn" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "Specifies an action for a listener rule.", - "properties": { - "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AuthenticateCognitoConfig", - "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." - }, - "AuthenticateOidcConfig": { - "$ref": "#/definitions/AuthenticateOidcConfig", - "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." - }, - "FixedResponseConfig": { - "$ref": "#/definitions/FixedResponseConfig", - "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." - }, - "ForwardConfig": { - "$ref": "#/definitions/ForwardConfig", - "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." - }, - "Order": { - "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", - "type": "integer" - }, - "RedirectConfig": { - "$ref": "#/definitions/RedirectConfig", - "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." - }, - "TargetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", - "relationshipRef": { - "propertyPath": "/properties/TargetGroupArn", - "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" - }, - "type": "string" - }, - "Type": { - "description": "The type of action.", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AuthenticateCognitoConfig": { - "additionalProperties": false, - "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", - "properties": { - "AuthenticationRequestExtraParams": { - "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "OnUnauthenticatedRequest": { - "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", - "type": "string" - }, - "Scope": { - "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", - "type": "string" - }, - "SessionCookieName": { - "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", - "type": "string" - }, - "SessionTimeout": { - "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", - "type": "string" - }, - "UserPoolArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Cognito::UserPool" - }, - "type": "string" - }, - "UserPoolClientId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/UserPoolId", - "typeName": "AWS::Cognito::UserPoolClient" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/ClientId", - "typeName": "AWS::Cognito::UserPoolClient" - } - } - ], - "description": "The ID of the Amazon Cognito user pool client.", - "type": "string" - }, - "UserPoolDomain": { - "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::Cognito::UserPoolDomain" - }, - "type": "string" - } - }, - "required": [ - "UserPoolClientId", - "UserPoolDomain", - "UserPoolArn" - ], - "type": "object" - }, - "AuthenticateOidcConfig": { - "additionalProperties": false, - "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", - "properties": { - "AuthenticationRequestExtraParams": { - "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "AuthorizationEndpoint": { - "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "ClientId": { - "description": "The OAuth 2.0 client identifier.", - "type": "string" - }, - "ClientSecret": { - "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", - "type": "string" - }, - "Issuer": { - "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "OnUnauthenticatedRequest": { - "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", - "type": "string" - }, - "Scope": { - "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", - "type": "string" - }, - "SessionCookieName": { - "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", - "type": "string" - }, - "SessionTimeout": { - "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", - "type": "string" - }, - "TokenEndpoint": { - "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "UseExistingClientSecret": { - "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", - "type": "boolean" - }, - "UserInfoEndpoint": { - "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - } - }, - "required": [ - "TokenEndpoint", - "Issuer", - "UserInfoEndpoint", - "ClientId", - "AuthorizationEndpoint" - ], - "type": "object" - }, - "Certificate": { - "additionalProperties": false, - "description": "Specifies an SSL server certificate to use as the default certificate for a secure listener.", - "properties": { - "CertificateArn": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::CertificateManager::Certificate" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::ServerCertificate" - } - } - ], - "description": "The Amazon Resource Name (ARN) of the certificate.", - "type": "string" - } - }, - "type": "object" - }, - "FixedResponseConfig": { - "additionalProperties": false, - "description": "Specifies information required when returning a custom HTTP response.", - "properties": { - "ContentType": { - "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", - "type": "string" - }, - "MessageBody": { - "description": "The message.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP response code (2XX, 4XX, or 5XX).", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "ForwardConfig": { - "additionalProperties": false, - "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", - "properties": { - "TargetGroupStickinessConfig": { - "$ref": "#/definitions/TargetGroupStickinessConfig", - "description": "Information about the target group stickiness for a rule." - }, - "TargetGroups": { - "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", - "items": { - "$ref": "#/definitions/TargetGroupTuple" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "MutualAuthentication": { - "additionalProperties": false, - "description": "Specifies the configuration information for mutual authentication.", - "properties": { - "IgnoreClientCertificateExpiry": { - "description": "Indicates whether expired client certificates are ignored.", - "type": "boolean" - }, - "Mode": { - "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``.", - "type": "string" - }, - "TrustStoreArn": { - "description": "The Amazon Resource Name (ARN) of the trust store.", - "type": "string" - } - }, - "type": "object" - }, - "RedirectConfig": { - "additionalProperties": false, - "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&value=xyz\".", - "properties": { - "Host": { - "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", - "type": "string" - }, - "Path": { - "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", - "type": "string" - }, - "Port": { - "description": "The port. You can specify a value from 1 to 65535 or #{port}.", - "type": "string" - }, - "Protocol": { - "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", - "type": "string" - }, - "Query": { - "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "TargetGroupStickinessConfig": { - "additionalProperties": false, - "description": "Information about the target group stickiness for a rule.", - "properties": { - "DurationSeconds": { - "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", - "type": "integer" - }, - "Enabled": { - "description": "Indicates whether target group stickiness is enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "TargetGroupTuple": { - "additionalProperties": false, - "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", - "properties": { - "TargetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the target group.", - "relationshipRef": { - "propertyPath": "/properties/TargetGroupArn", - "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" - }, - "type": "string" - }, - "Weight": { - "description": "The weight. The range is 0 to 999.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Specifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:CreateListener", - "elasticloadbalancing:DescribeListeners", - "cognito-idp:DescribeUserPoolClient" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DeleteListener", - "elasticloadbalancing:DescribeListeners" - ] - }, - "list": { - "handlerSchema": { - "oneOf": [ - { - "required": [ - "LoadBalancerArn" - ] - }, - { - "required": [ - "ListenerArns" - ] - } - ], - "properties": { - "ListenerArns": { - "items": { - "$ref": "resource-schema.json#/properties/ListenerArn" - }, - "type": "array", - "uniqueItems": false - }, - "LoadBalancerArn": { - "$ref": "resource-schema.json#/properties/LoadBalancerArn" - } - } - }, - "permissions": [ - "elasticloadbalancing:DescribeListeners" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeListeners" - ] - }, - "update": { - "permissions": [ - "elasticloadbalancing:ModifyListener", - "elasticloadbalancing:DescribeListeners", - "cognito-idp:DescribeUserPoolClient" - ] - } - }, - "primaryIdentifier": [ - "/properties/ListenerArn" - ], - "properties": { - "AlpnPolicy": { - "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Certificates": { - "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.\n To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).", - "items": { - "$ref": "#/definitions/Certificate" - }, - "type": "array", - "uniqueItems": true - }, - "DefaultActions": { - "description": "The actions for the default rule. You cannot define a condition for a default rule.\n To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).", - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": true - }, - "ListenerArn": { - "description": "", - "type": "string" - }, - "LoadBalancerArn": { - "description": "The Amazon Resource Name (ARN) of the load balancer.", - "type": "string" - }, - "MutualAuthentication": { - "$ref": "#/definitions/MutualAuthentication", - "description": "The mutual authentication configuration information." - }, - "Port": { - "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.", - "type": "integer" - }, - "Protocol": { - "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can\u2019t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.", - "type": "string" - }, - "SslPolicy": { - "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.\n Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.\n For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ListenerArn" - ], - "required": [ - "LoadBalancerArn", - "DefaultActions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ElasticLoadBalancingV2::Listener", - "writeOnlyProperties": [ - "/properties/DefaultActions/*/AuthenticateOidcConfig/ClientSecret" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoadBalancerArn" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "Specifies an action for a listener rule.", + "properties": { + "AuthenticateCognitoConfig": { + "$ref": "#/definitions/AuthenticateCognitoConfig", + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." + }, + "AuthenticateOidcConfig": { + "$ref": "#/definitions/AuthenticateOidcConfig", + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." + }, + "FixedResponseConfig": { + "$ref": "#/definitions/FixedResponseConfig", + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." + }, + "ForwardConfig": { + "$ref": "#/definitions/ForwardConfig", + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." + }, + "Order": { + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", + "type": "integer" + }, + "RedirectConfig": { + "$ref": "#/definitions/RedirectConfig", + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." + }, + "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", + "relationshipRef": { + "propertyPath": "/properties/TargetGroupArn", + "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + }, + "type": "string" + }, + "Type": { + "description": "The type of action.", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "AuthenticateCognitoConfig": { + "additionalProperties": false, + "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", + "properties": { + "AuthenticationRequestExtraParams": { + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", + "type": "string" + }, + "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", + "type": "string" + }, + "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", + "type": "string" + }, + "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", + "type": "string" + }, + "UserPoolArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Cognito::UserPool" + }, + "type": "string" + }, + "UserPoolClientId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/UserPoolId", + "typeName": "AWS::Cognito::UserPoolClient" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/ClientId", + "typeName": "AWS::Cognito::UserPoolClient" + } + } + ], + "description": "The ID of the Amazon Cognito user pool client.", + "type": "string" + }, + "UserPoolDomain": { + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Cognito::UserPoolDomain" + }, + "type": "string" + } + }, + "required": [ + "UserPoolClientId", + "UserPoolDomain", + "UserPoolArn" + ], + "type": "object" + }, + "AuthenticateOidcConfig": { + "additionalProperties": false, + "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", + "properties": { + "AuthenticationRequestExtraParams": { + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "AuthorizationEndpoint": { + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "ClientId": { + "description": "The OAuth 2.0 client identifier.", + "type": "string" + }, + "ClientSecret": { + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", + "type": "string" + }, + "Issuer": { + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", + "type": "string" + }, + "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", + "type": "string" + }, + "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", + "type": "string" + }, + "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", + "type": "string" + }, + "TokenEndpoint": { + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "UseExistingClientSecret": { + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", + "type": "boolean" + }, + "UserInfoEndpoint": { + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + } + }, + "required": [ + "TokenEndpoint", + "Issuer", + "UserInfoEndpoint", + "ClientId", + "AuthorizationEndpoint" + ], + "type": "object" + }, + "Certificate": { + "additionalProperties": false, + "description": "Specifies an SSL server certificate to use as the default certificate for a secure listener.", + "properties": { + "CertificateArn": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::CertificateManager::Certificate" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::ServerCertificate" + } + } + ], + "description": "The Amazon Resource Name (ARN) of the certificate.", + "type": "string" + } + }, + "type": "object" + }, + "FixedResponseConfig": { + "additionalProperties": false, + "description": "Specifies information required when returning a custom HTTP response.", + "properties": { + "ContentType": { + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", + "type": "string" + }, + "MessageBody": { + "description": "The message.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP response code (2XX, 4XX, or 5XX).", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "ForwardConfig": { + "additionalProperties": false, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", + "properties": { + "TargetGroupStickinessConfig": { + "$ref": "#/definitions/TargetGroupStickinessConfig", + "description": "Information about the target group stickiness for a rule." + }, + "TargetGroups": { + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "items": { + "$ref": "#/definitions/TargetGroupTuple" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ListenerAttribute": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "MutualAuthentication": { + "additionalProperties": false, + "description": "Specifies the configuration information for mutual authentication.", + "properties": { + "IgnoreClientCertificateExpiry": { + "description": "Indicates whether expired client certificates are ignored.", + "type": "boolean" + }, + "Mode": { + "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``.", + "type": "string" + }, + "TrustStoreArn": { + "description": "The Amazon Resource Name (ARN) of the trust store.", + "type": "string" + } + }, + "type": "object" + }, + "RedirectConfig": { + "additionalProperties": false, + "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&value=xyz\".", + "properties": { + "Host": { + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", + "type": "string" + }, + "Path": { + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", + "type": "string" + }, + "Port": { + "description": "The port. You can specify a value from 1 to 65535 or #{port}.", + "type": "string" + }, + "Protocol": { + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", + "type": "string" + }, + "Query": { + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "TargetGroupStickinessConfig": { + "additionalProperties": false, + "description": "Information about the target group stickiness for a rule.", + "properties": { + "DurationSeconds": { + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", + "type": "integer" + }, + "Enabled": { + "description": "Indicates whether target group stickiness is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetGroupTuple": { + "additionalProperties": false, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "properties": { + "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group.", + "relationshipRef": { + "propertyPath": "/properties/TargetGroupArn", + "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + }, + "type": "string" + }, + "Weight": { + "description": "The weight. The range is 0 to 999.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Specifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:CreateListener", + "elasticloadbalancing:DescribeListeners", + "cognito-idp:DescribeUserPoolClient", + "elasticloadbalancing:ModifyListenerAttributes" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DeleteListener", + "elasticloadbalancing:DescribeListeners" + ] + }, + "list": { + "handlerSchema": { + "oneOf": [ + { + "required": [ + "LoadBalancerArn" + ] + }, + { + "required": [ + "ListenerArns" + ] + } + ], + "properties": { + "ListenerArns": { + "items": { + "$ref": "resource-schema.json#/properties/ListenerArn" + }, + "type": "array", + "uniqueItems": false + }, + "LoadBalancerArn": { + "$ref": "resource-schema.json#/properties/LoadBalancerArn" + } + } + }, + "permissions": [ + "elasticloadbalancing:DescribeListeners" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeListenerAttributes" + ] + }, + "update": { + "permissions": [ + "elasticloadbalancing:ModifyListener", + "elasticloadbalancing:DescribeListeners", + "cognito-idp:DescribeUserPoolClient", + "elasticloadbalancing:ModifyListenerAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/ListenerArn" + ], + "properties": { + "AlpnPolicy": { + "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Certificates": { + "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.\n To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).", + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array", + "uniqueItems": true + }, + "DefaultActions": { + "description": "The actions for the default rule. You cannot define a condition for a default rule.\n To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).", + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": true + }, + "ListenerArn": { + "description": "", + "type": "string" + }, + "ListenerAttributes": { + "arrayType": "AttributeList", + "description": "", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ListenerAttribute" + }, + "type": "array", + "uniqueItems": true + }, + "LoadBalancerArn": { + "description": "The Amazon Resource Name (ARN) of the load balancer.", + "type": "string" + }, + "MutualAuthentication": { + "$ref": "#/definitions/MutualAuthentication", + "description": "The mutual authentication configuration information." + }, + "Port": { + "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.", + "type": "integer" + }, + "Protocol": { + "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can\u2019t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.", + "type": "string" + }, + "SslPolicy": { + "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.\n Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.\n For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ListenerArn" + ], + "required": [ + "LoadBalancerArn", + "DefaultActions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ElasticLoadBalancingV2::Listener", + "writeOnlyProperties": [ + "/properties/DefaultActions/*/AuthenticateOidcConfig/ClientSecret" + ] +} diff --git a/schema/aws-elasticloadbalancingv2-listenercertificate.json b/schema/aws-elasticloadbalancingv2-listenercertificate.json index da6048e..365dca9 100644 --- a/schema/aws-elasticloadbalancingv2-listenercertificate.json +++ b/schema/aws-elasticloadbalancingv2-listenercertificate.json @@ -1,44 +1,44 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ListenerArn" - ], - "definitions": { - "Certificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::ListenerCertificate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Certificates": { - "items": { - "$ref": "#/definitions/Certificate" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "type": "string" - }, - "ListenerArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ListenerArn", - "Certificates" - ], - "typeName": "AWS::ElasticLoadBalancingV2::ListenerCertificate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ListenerArn" + ], + "definitions": { + "Certificate": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::ListenerCertificate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Certificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "type": "string" + }, + "ListenerArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ListenerArn", + "Certificates" + ], + "typeName": "AWS::ElasticLoadBalancingV2::ListenerCertificate" +} diff --git a/schema/aws-elasticloadbalancingv2-listenerrule.json b/schema/aws-elasticloadbalancingv2-listenerrule.json index 3b58e95..7715dc8 100644 --- a/schema/aws-elasticloadbalancingv2-listenerrule.json +++ b/schema/aws-elasticloadbalancingv2-listenerrule.json @@ -1,553 +1,553 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ListenerArn" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "Specifies an action for a listener rule.", - "properties": { - "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AuthenticateCognitoConfig", - "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." - }, - "AuthenticateOidcConfig": { - "$ref": "#/definitions/AuthenticateOidcConfig", - "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." - }, - "FixedResponseConfig": { - "$ref": "#/definitions/FixedResponseConfig", - "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." - }, - "ForwardConfig": { - "$ref": "#/definitions/ForwardConfig", - "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." - }, - "Order": { - "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", - "type": "integer" - }, - "RedirectConfig": { - "$ref": "#/definitions/RedirectConfig", - "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." - }, - "TargetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", - "type": "string" - }, - "Type": { - "description": "The type of action.", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AuthenticateCognitoConfig": { - "additionalProperties": false, - "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": false, - "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "OnUnauthenticatedRequest": { - "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", - "type": "string" - }, - "Scope": { - "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", - "type": "string" - }, - "SessionCookieName": { - "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", - "type": "string" - }, - "SessionTimeout": { - "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", - "type": "integer" - }, - "UserPoolArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", - "type": "string" - }, - "UserPoolClientId": { - "description": "The ID of the Amazon Cognito user pool client.", - "type": "string" - }, - "UserPoolDomain": { - "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", - "type": "string" - } - }, - "required": [ - "UserPoolClientId", - "UserPoolDomain", - "UserPoolArn" - ], - "type": "object" - }, - "AuthenticateOidcConfig": { - "additionalProperties": false, - "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": false, - "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "AuthorizationEndpoint": { - "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "ClientId": { - "description": "The OAuth 2.0 client identifier.", - "type": "string" - }, - "ClientSecret": { - "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", - "type": "string" - }, - "Issuer": { - "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "OnUnauthenticatedRequest": { - "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", - "type": "string" - }, - "Scope": { - "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", - "type": "string" - }, - "SessionCookieName": { - "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", - "type": "string" - }, - "SessionTimeout": { - "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", - "type": "integer" - }, - "TokenEndpoint": { - "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - }, - "UseExistingClientSecret": { - "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", - "type": "boolean" - }, - "UserInfoEndpoint": { - "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", - "type": "string" - } - }, - "required": [ - "TokenEndpoint", - "Issuer", - "UserInfoEndpoint", - "ClientId", - "AuthorizationEndpoint" - ], - "type": "object" - }, - "FixedResponseConfig": { - "additionalProperties": false, - "description": "Specifies information required when returning a custom HTTP response.", - "properties": { - "ContentType": { - "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", - "type": "string" - }, - "MessageBody": { - "description": "The message.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP response code (2XX, 4XX, or 5XX).", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "ForwardConfig": { - "additionalProperties": false, - "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", - "properties": { - "TargetGroupStickinessConfig": { - "$ref": "#/definitions/TargetGroupStickinessConfig", - "description": "Information about the target group stickiness for a rule." - }, - "TargetGroups": { - "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetGroupTuple" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "HostHeaderConfig": { - "additionalProperties": false, - "description": "Information about a host header condition.", - "properties": { - "Values": { - "description": "The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "HttpHeaderConfig": { - "additionalProperties": false, - "description": "Information about an HTTP header condition.\n There is a set of standard HTTP header fields. You can also define custom HTTP header fields.", - "properties": { - "HttpHeaderName": { - "description": "The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.", - "type": "string" - }, - "Values": { - "description": "The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If the same header appears multiple times in the request, we search them in order until a match is found.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "HttpRequestMethodConfig": { - "additionalProperties": false, - "description": "Information about an HTTP method condition.\n HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.", - "properties": { - "Values": { - "description": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "PathPatternConfig": { - "additionalProperties": false, - "description": "Information about a path pattern condition.", - "properties": { - "Values": { - "description": "The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "QueryStringConfig": { - "additionalProperties": false, - "description": "Information about a query string condition.\n The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.", - "properties": { - "Values": { - "description": "The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\\' character.\n If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/QueryStringKeyValue" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "QueryStringKeyValue": { - "additionalProperties": false, - "description": "Information about a key/value pair.", - "properties": { - "Key": { - "description": "The key. You can omit the key.", - "type": "string" - }, - "Value": { - "description": "The value.", - "type": "string" - } - }, - "type": "object" - }, - "RedirectConfig": { - "additionalProperties": false, - "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&value=xyz\".", - "properties": { - "Host": { - "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", - "type": "string" - }, - "Path": { - "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", - "type": "string" - }, - "Port": { - "description": "The port. You can specify a value from 1 to 65535 or #{port}.", - "type": "string" - }, - "Protocol": { - "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", - "type": "string" - }, - "Query": { - "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", - "type": "string" - }, - "StatusCode": { - "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "RuleCondition": { - "additionalProperties": false, - "description": "Specifies a condition for a listener rule.", - "properties": { - "Field": { - "description": "The field in the HTTP request. The following are the possible values:\n + ``http-header`` \n + ``http-request-method`` \n + ``host-header`` \n + ``path-pattern`` \n + ``query-string`` \n + ``source-ip``", - "type": "string" - }, - "HostHeaderConfig": { - "$ref": "#/definitions/HostHeaderConfig", - "description": "Information for a host header condition. Specify only when ``Field`` is ``host-header``." - }, - "HttpHeaderConfig": { - "$ref": "#/definitions/HttpHeaderConfig", - "description": "Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``." - }, - "HttpRequestMethodConfig": { - "$ref": "#/definitions/HttpRequestMethodConfig", - "description": "Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``." - }, - "PathPatternConfig": { - "$ref": "#/definitions/PathPatternConfig", - "description": "Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``." - }, - "QueryStringConfig": { - "$ref": "#/definitions/QueryStringConfig", - "description": "Information for a query string condition. Specify only when ``Field`` is ``query-string``." - }, - "SourceIpConfig": { - "$ref": "#/definitions/SourceIpConfig", - "description": "Information for a source IP condition. Specify only when ``Field`` is ``source-ip``." - }, - "Values": { - "description": "The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.\n If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + - .\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)\n \n If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + _ - . $ / ~ \" ' @ : +\n + & (using &)\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "SourceIpConfig": { - "additionalProperties": false, - "description": "Information about a source IP condition.\n You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.", - "properties": { - "Values": { - "description": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.\n If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "TargetGroupStickinessConfig": { - "additionalProperties": false, - "description": "Information about the target group stickiness for a rule.", - "properties": { - "DurationSeconds": { - "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", - "type": "integer" - }, - "Enabled": { - "description": "Indicates whether target group stickiness is enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "TargetGroupTuple": { - "additionalProperties": false, - "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", - "properties": { - "TargetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the target group.", - "type": "string" - }, - "Weight": { - "description": "The weight. The range is 0 to 999.", - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.\n For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:CreateRule", - "elasticloadbalancing:DescribeRules", - "cognito-idp:DescribeUserPoolClient" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DeleteRule", - "elasticloadbalancing:DescribeRules" - ] - }, - "list": { - "handlerSchema": { - "oneOf": [ - { - "required": [ - "ListenerArn" - ] - }, - { - "required": [ - "RuleArns" - ] - } - ], - "properties": { - "ListenerArn": { - "$ref": "resource-schema.json#/properties/ListenerArn" - }, - "RuleArns": { - "insertionOrder": false, - "items": { - "$ref": "resource-schema.json#/properties/RuleArn" - }, - "type": "array", - "uniqueItems": false - } - } - }, - "permissions": [ - "elasticloadbalancing:DescribeRules" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeRules" - ] - }, - "update": { - "permissions": [ - "elasticloadbalancing:ModifyRule", - "elasticloadbalancing:SetRulePriorities", - "elasticloadbalancing:DescribeRules" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleArn" - ], - "properties": { - "Actions": { - "description": "The actions.\n The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": true - }, - "Conditions": { - "description": "The conditions.\n The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RuleCondition" - }, - "type": "array", - "uniqueItems": true - }, - "IsDefault": { - "description": "", - "type": "boolean" - }, - "ListenerArn": { - "description": "The Amazon Resource Name (ARN) of the listener.", - "type": "string" - }, - "Priority": { - "description": "The rule priority. A listener can't have multiple rules with the same priority.\n If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.", - "type": "integer" - }, - "RuleArn": { - "description": "", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RuleArn", - "/properties/IsDefault" - ], - "required": [ - "Actions", - "Priority", - "Conditions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ElasticLoadBalancingV2::ListenerRule", - "writeOnlyProperties": [ - "/properties/Actions/*/AuthenticateOidcConfig/ClientSecret", - "/properties/ListenerArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ListenerArn" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "Specifies an action for a listener rule.", + "properties": { + "AuthenticateCognitoConfig": { + "$ref": "#/definitions/AuthenticateCognitoConfig", + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." + }, + "AuthenticateOidcConfig": { + "$ref": "#/definitions/AuthenticateOidcConfig", + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." + }, + "FixedResponseConfig": { + "$ref": "#/definitions/FixedResponseConfig", + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." + }, + "ForwardConfig": { + "$ref": "#/definitions/ForwardConfig", + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." + }, + "Order": { + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", + "type": "integer" + }, + "RedirectConfig": { + "$ref": "#/definitions/RedirectConfig", + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." + }, + "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", + "type": "string" + }, + "Type": { + "description": "The type of action.", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "AuthenticateCognitoConfig": { + "additionalProperties": false, + "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", + "properties": { + "AuthenticationRequestExtraParams": { + "additionalProperties": false, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", + "type": "string" + }, + "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", + "type": "string" + }, + "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", + "type": "string" + }, + "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", + "type": "integer" + }, + "UserPoolArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", + "type": "string" + }, + "UserPoolClientId": { + "description": "The ID of the Amazon Cognito user pool client.", + "type": "string" + }, + "UserPoolDomain": { + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", + "type": "string" + } + }, + "required": [ + "UserPoolClientId", + "UserPoolDomain", + "UserPoolArn" + ], + "type": "object" + }, + "AuthenticateOidcConfig": { + "additionalProperties": false, + "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", + "properties": { + "AuthenticationRequestExtraParams": { + "additionalProperties": false, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "AuthorizationEndpoint": { + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "ClientId": { + "description": "The OAuth 2.0 client identifier.", + "type": "string" + }, + "ClientSecret": { + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", + "type": "string" + }, + "Issuer": { + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", + "type": "string" + }, + "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", + "type": "string" + }, + "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", + "type": "string" + }, + "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", + "type": "integer" + }, + "TokenEndpoint": { + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + }, + "UseExistingClientSecret": { + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", + "type": "boolean" + }, + "UserInfoEndpoint": { + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", + "type": "string" + } + }, + "required": [ + "TokenEndpoint", + "Issuer", + "UserInfoEndpoint", + "ClientId", + "AuthorizationEndpoint" + ], + "type": "object" + }, + "FixedResponseConfig": { + "additionalProperties": false, + "description": "Specifies information required when returning a custom HTTP response.", + "properties": { + "ContentType": { + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", + "type": "string" + }, + "MessageBody": { + "description": "The message.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP response code (2XX, 4XX, or 5XX).", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "ForwardConfig": { + "additionalProperties": false, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", + "properties": { + "TargetGroupStickinessConfig": { + "$ref": "#/definitions/TargetGroupStickinessConfig", + "description": "Information about the target group stickiness for a rule." + }, + "TargetGroups": { + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetGroupTuple" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "HostHeaderConfig": { + "additionalProperties": false, + "description": "Information about a host header condition.", + "properties": { + "Values": { + "description": "The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "HttpHeaderConfig": { + "additionalProperties": false, + "description": "Information about an HTTP header condition.\n There is a set of standard HTTP header fields. You can also define custom HTTP header fields.", + "properties": { + "HttpHeaderName": { + "description": "The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.", + "type": "string" + }, + "Values": { + "description": "The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If the same header appears multiple times in the request, we search them in order until a match is found.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "HttpRequestMethodConfig": { + "additionalProperties": false, + "description": "Information about an HTTP method condition.\n HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.", + "properties": { + "Values": { + "description": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "PathPatternConfig": { + "additionalProperties": false, + "description": "Information about a path pattern condition.", + "properties": { + "Values": { + "description": "The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "QueryStringConfig": { + "additionalProperties": false, + "description": "Information about a query string condition.\n The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.", + "properties": { + "Values": { + "description": "The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\\' character.\n If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/QueryStringKeyValue" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "QueryStringKeyValue": { + "additionalProperties": false, + "description": "Information about a key/value pair.", + "properties": { + "Key": { + "description": "The key. You can omit the key.", + "type": "string" + }, + "Value": { + "description": "The value.", + "type": "string" + } + }, + "type": "object" + }, + "RedirectConfig": { + "additionalProperties": false, + "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&value=xyz\".", + "properties": { + "Host": { + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", + "type": "string" + }, + "Path": { + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", + "type": "string" + }, + "Port": { + "description": "The port. You can specify a value from 1 to 65535 or #{port}.", + "type": "string" + }, + "Protocol": { + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", + "type": "string" + }, + "Query": { + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", + "type": "string" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "RuleCondition": { + "additionalProperties": false, + "description": "Specifies a condition for a listener rule.", + "properties": { + "Field": { + "description": "The field in the HTTP request. The following are the possible values:\n + ``http-header`` \n + ``http-request-method`` \n + ``host-header`` \n + ``path-pattern`` \n + ``query-string`` \n + ``source-ip``", + "type": "string" + }, + "HostHeaderConfig": { + "$ref": "#/definitions/HostHeaderConfig", + "description": "Information for a host header condition. Specify only when ``Field`` is ``host-header``." + }, + "HttpHeaderConfig": { + "$ref": "#/definitions/HttpHeaderConfig", + "description": "Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``." + }, + "HttpRequestMethodConfig": { + "$ref": "#/definitions/HttpRequestMethodConfig", + "description": "Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``." + }, + "PathPatternConfig": { + "$ref": "#/definitions/PathPatternConfig", + "description": "Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``." + }, + "QueryStringConfig": { + "$ref": "#/definitions/QueryStringConfig", + "description": "Information for a query string condition. Specify only when ``Field`` is ``query-string``." + }, + "SourceIpConfig": { + "$ref": "#/definitions/SourceIpConfig", + "description": "Information for a source IP condition. Specify only when ``Field`` is ``source-ip``." + }, + "Values": { + "description": "The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.\n If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + - .\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)\n \n If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + _ - . $ / ~ \" ' @ : +\n + & (using &)\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "SourceIpConfig": { + "additionalProperties": false, + "description": "Information about a source IP condition.\n You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.", + "properties": { + "Values": { + "description": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.\n If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TargetGroupStickinessConfig": { + "additionalProperties": false, + "description": "Information about the target group stickiness for a rule.", + "properties": { + "DurationSeconds": { + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", + "type": "integer" + }, + "Enabled": { + "description": "Indicates whether target group stickiness is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetGroupTuple": { + "additionalProperties": false, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "properties": { + "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group.", + "type": "string" + }, + "Weight": { + "description": "The weight. The range is 0 to 999.", + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.\n For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:CreateRule", + "elasticloadbalancing:DescribeRules", + "cognito-idp:DescribeUserPoolClient" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DeleteRule", + "elasticloadbalancing:DescribeRules" + ] + }, + "list": { + "handlerSchema": { + "oneOf": [ + { + "required": [ + "ListenerArn" + ] + }, + { + "required": [ + "RuleArns" + ] + } + ], + "properties": { + "ListenerArn": { + "$ref": "resource-schema.json#/properties/ListenerArn" + }, + "RuleArns": { + "insertionOrder": false, + "items": { + "$ref": "resource-schema.json#/properties/RuleArn" + }, + "type": "array", + "uniqueItems": false + } + } + }, + "permissions": [ + "elasticloadbalancing:DescribeRules" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeRules" + ] + }, + "update": { + "permissions": [ + "elasticloadbalancing:ModifyRule", + "elasticloadbalancing:SetRulePriorities", + "elasticloadbalancing:DescribeRules" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleArn" + ], + "properties": { + "Actions": { + "description": "The actions.\n The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": true + }, + "Conditions": { + "description": "The conditions.\n The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RuleCondition" + }, + "type": "array", + "uniqueItems": true + }, + "IsDefault": { + "description": "", + "type": "boolean" + }, + "ListenerArn": { + "description": "The Amazon Resource Name (ARN) of the listener.", + "type": "string" + }, + "Priority": { + "description": "The rule priority. A listener can't have multiple rules with the same priority.\n If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.", + "type": "integer" + }, + "RuleArn": { + "description": "", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RuleArn", + "/properties/IsDefault" + ], + "required": [ + "Actions", + "Priority", + "Conditions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ElasticLoadBalancingV2::ListenerRule", + "writeOnlyProperties": [ + "/properties/Actions/*/AuthenticateOidcConfig/ClientSecret", + "/properties/ListenerArn" + ] +} diff --git a/schema/aws-elasticloadbalancingv2-loadbalancer.json b/schema/aws-elasticloadbalancingv2-loadbalancer.json index 67fb84b..e6a4917 100644 --- a/schema/aws-elasticloadbalancingv2-loadbalancer.json +++ b/schema/aws-elasticloadbalancingv2-loadbalancer.json @@ -1,217 +1,222 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type", - "/properties/Scheme" - ], - "definitions": { - "LoadBalancerAttribute": { - "additionalProperties": false, - "description": "Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", - "properties": { - "Key": { - "description": "The name of the attribute.\n The following attributes are supported by all load balancers:\n + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed.\n \n The following attributes are supported by both Application Load Balancers and Network Load Balancers:\n + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs.\n + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.\n \n The following attributes are supported by only Application Load Balancers:\n + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\n + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.\n + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs.\n + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``.\n + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``.\n + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``.\n + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change.\n + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n \n + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.\n + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``.\n \n The following attributes are supported by only Network Load Balancers:\n + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity.", - "type": "string" - }, - "Value": { - "description": "The value of the attribute.", - "type": "string" - } - }, - "type": "object" - }, - "SubnetMapping": { - "additionalProperties": false, - "description": "Specifies a subnet for a load balancer.", - "properties": { - "AllocationId": { - "description": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.", - "type": "string" - }, - "IPv6Address": { - "description": "[Network Load Balancers] The IPv6 address.", - "type": "string" - }, - "PrivateIPv4Address": { - "description": "[Network Load Balancers] The private IPv4 address for an internal load balancer.", - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet.", - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Information about a tag.", - "properties": { - "Key": { - "description": "The key of the tag.", - "type": "string" - }, - "Value": { - "description": "The value of the tag.", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:CreateLoadBalancer", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:ModifyLoadBalancerAttributes", - "elasticloadbalancing:AddTags" - ], - "timeoutInMinutes": 30 - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DeleteLoadBalancer" - ] - }, - "list": { - "permissions": [ - "elasticloadbalancing:DescribeLoadBalancers" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeLoadBalancerAttributes", - "elasticloadbalancing:DescribeTags" - ] - }, - "update": { - "permissions": [ - "elasticloadbalancing:ModifyLoadBalancerAttributes", - "elasticloadbalancing:SetSubnets", - "elasticloadbalancing:SetIpAddressType", - "elasticloadbalancing:SetSecurityGroups", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RemoveTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/LoadBalancerArn" - ], - "properties": { - "CanonicalHostedZoneID": { - "description": "", - "type": "string" - }, - "DNSName": { - "description": "", - "type": "string" - }, - "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { - "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.", - "type": "string" - }, - "IpAddressType": { - "description": "Note: Internal load balancers must use the ``ipv4`` IP address type.\n [Application Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses), ``dualstack`` (for IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).\n [Network Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can\u2019t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.\n [Gateway Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses).", - "type": "string" - }, - "LoadBalancerArn": { - "description": "", - "type": "string" - }, - "LoadBalancerAttributes": { - "arrayType": "AttributeList", - "description": "The load balancer attributes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LoadBalancerAttribute" - }, - "type": "array", - "uniqueItems": true - }, - "LoadBalancerFullName": { - "description": "", - "type": "string" - }, - "LoadBalancerName": { - "description": "", - "type": "string" - }, - "Name": { - "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".\n If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.", - "type": "string" - }, - "Scheme": { - "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.\n The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.\n The default is an Internet-facing load balancer.\n You cannot specify a scheme for a Gateway Load Balancer.", - "type": "string" - }, - "SecurityGroups": { - "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetMappings": { - "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.\n [Application Load Balancers on Outposts] You must specify one Outpost subnet.\n [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetMapping" - }, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones.\n [Application Load Balancers on Outposts] You must specify one Outpost subnet.\n [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "The tags to assign to the load balancer.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of load balancer. The default is ``application``.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LoadBalancerName", - "/properties/LoadBalancerFullName", - "/properties/CanonicalHostedZoneID", - "/properties/LoadBalancerArn", - "/properties/DNSName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElasticLoadBalancingV2::LoadBalancer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type", + "/properties/Scheme" + ], + "definitions": { + "LoadBalancerAttribute": { + "additionalProperties": false, + "description": "Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", + "properties": { + "Key": { + "description": "The name of the attribute.\n The following attributes are supported by all load balancers:\n + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed.\n \n The following attributes are supported by both Application Load Balancers and Network Load Balancers:\n + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs.\n + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.\n \n The following attributes are supported by only Application Load Balancers:\n + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\n + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.\n + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs.\n + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``.\n + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``.\n + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``.\n + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change.\n + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n \n + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.\n + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``.\n \n The following attributes are supported by only Network Load Balancers:\n + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity.", + "type": "string" + }, + "Value": { + "description": "The value of the attribute.", + "type": "string" + } + }, + "type": "object" + }, + "SubnetMapping": { + "additionalProperties": false, + "description": "Specifies a subnet for a load balancer.", + "properties": { + "AllocationId": { + "description": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.", + "type": "string" + }, + "IPv6Address": { + "description": "[Network Load Balancers] The IPv6 address.", + "type": "string" + }, + "PrivateIPv4Address": { + "description": "[Network Load Balancers] The private IPv4 address for an internal load balancer.", + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet.", + "type": "string" + } + }, + "required": [ + "SubnetId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Information about a tag.", + "properties": { + "Key": { + "description": "The key of the tag.", + "type": "string" + }, + "Value": { + "description": "The value of the tag.", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:CreateLoadBalancer", + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:ModifyLoadBalancerAttributes", + "elasticloadbalancing:AddTags" + ], + "timeoutInMinutes": 30 + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DeleteLoadBalancer" + ] + }, + "list": { + "permissions": [ + "elasticloadbalancing:DescribeLoadBalancers" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DescribeLoadBalancerAttributes", + "elasticloadbalancing:DescribeTags" + ] + }, + "update": { + "permissions": [ + "elasticloadbalancing:ModifyLoadBalancerAttributes", + "elasticloadbalancing:SetSubnets", + "elasticloadbalancing:SetIpAddressType", + "elasticloadbalancing:SetSecurityGroups", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RemoveTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/LoadBalancerArn" + ], + "properties": { + "CanonicalHostedZoneID": { + "description": "", + "type": "string" + }, + "DNSName": { + "description": "", + "type": "string" + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.", + "type": "string" + }, + "IpAddressType": { + "description": "Note: Internal load balancers must use the ``ipv4`` IP address type.\n [Application Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses), ``dualstack`` (for IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).\n Note: Application Load Balancer authentication only supports IPv4 addresses when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer cannot complete the authentication process, resulting in HTTP 500 errors.\n [Network Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can\u2019t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.\n [Gateway Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses).", + "type": "string" + }, + "LoadBalancerArn": { + "description": "", + "type": "string" + }, + "LoadBalancerAttributes": { + "arrayType": "AttributeList", + "description": "The load balancer attributes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LoadBalancerAttribute" + }, + "type": "array", + "uniqueItems": true + }, + "LoadBalancerFullName": { + "description": "", + "type": "string" + }, + "LoadBalancerName": { + "description": "", + "type": "string" + }, + "Name": { + "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".\n If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.", + "type": "string" + }, + "Scheme": { + "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.\n The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.\n The default is an Internet-facing load balancer.\n You cannot specify a scheme for a Gateway Load Balancer.", + "type": "string" + }, + "SecurityGroups": { + "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetMappings": { + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.\n [Application Load Balancers on Outposts] You must specify one Outpost subnet.\n [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetMapping" + }, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones.\n [Application Load Balancers on Outposts] You must specify one Outpost subnet.\n [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "The tags to assign to the load balancer.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of load balancer. The default is ``application``.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LoadBalancerName", + "/properties/LoadBalancerFullName", + "/properties/CanonicalHostedZoneID", + "/properties/LoadBalancerArn", + "/properties/DNSName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "elasticloadbalancing:AddTags", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:RemoveTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElasticLoadBalancingV2::LoadBalancer" +} diff --git a/schema/aws-elasticloadbalancingv2-targetgroup.json b/schema/aws-elasticloadbalancingv2-targetgroup.json index 26184fe..edb0599 100644 --- a/schema/aws-elasticloadbalancingv2-targetgroup.json +++ b/schema/aws-elasticloadbalancingv2-targetgroup.json @@ -1,257 +1,257 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetType", - "/properties/ProtocolVersion", - "/properties/Port", - "/properties/Name", - "/properties/VpcId", - "/properties/Protocol", - "/properties/IpAddressType" - ], - "definitions": { - "Matcher": { - "additionalProperties": false, - "properties": { - "GrpcCode": { - "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.", - "type": "string" - }, - "HttpCode": { - "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. ", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The value for the tag. ", - "type": "string" - }, - "Value": { - "description": "The key name of the tag. ", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetDescription": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "description": "An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.", - "type": "string" - }, - "Id": { - "description": "The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. ", - "type": "string" - }, - "Port": { - "description": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.", - "type": "integer" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "TargetGroupAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The value of the attribute.", - "type": "string" - }, - "Value": { - "description": "The name of the attribute.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:CreateTargetGroup", - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:RegisterTargets", - "elasticloadbalancing:ModifyTargetGroupAttributes", - "elasticloadbalancing:DescribeTargetHealth", - "elasticloadbalancing:AddTags" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DeleteTargetGroup", - "elasticloadbalancing:DescribeTargetGroups" - ] - }, - "list": { - "permissions": [ - "elasticloadbalancing:DescribeTargetGroups" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:DescribeTargetGroupAttributes", - "elasticloadbalancing:DescribeTargetHealth", - "elasticloadbalancing:DescribeTags" - ] - }, - "update": { - "permissions": [ - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:ModifyTargetGroup", - "elasticloadbalancing:ModifyTargetGroupAttributes", - "elasticloadbalancing:RegisterTargets", - "elasticloadbalancing:DescribeTargetHealth", - "elasticloadbalancing:DeregisterTargets", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RemoveTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/TargetGroupArn" - ], - "properties": { - "HealthCheckEnabled": { - "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.", - "type": "boolean" - }, - "HealthCheckIntervalSeconds": { - "description": "The approximate amount of time, in seconds, between health checks of an individual target.", - "type": "integer" - }, - "HealthCheckPath": { - "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.", - "type": "string" - }, - "HealthCheckPort": { - "description": "The port the load balancer uses when performing health checks on targets. ", - "type": "string" - }, - "HealthCheckProtocol": { - "description": "The protocol the load balancer uses when performing health checks on targets. ", - "type": "string" - }, - "HealthCheckTimeoutSeconds": { - "description": "The amount of time, in seconds, during which no response from a target means a failed health check.", - "type": "integer" - }, - "HealthyThresholdCount": { - "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy. ", - "type": "integer" - }, - "IpAddressType": { - "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6. ", - "type": "string" - }, - "LoadBalancerArns": { - "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Matcher": { - "$ref": "#/definitions/Matcher", - "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." - }, - "Name": { - "description": "The name of the target group.", - "type": "string" - }, - "Port": { - "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.", - "type": "integer" - }, - "Protocol": { - "description": "The protocol to use for routing traffic to the targets.", - "type": "string" - }, - "ProtocolVersion": { - "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.", - "type": "string" - }, - "Tags": { - "description": "The tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TargetGroupArn": { - "description": "The ARN of the Target Group", - "type": "string" - }, - "TargetGroupAttributes": { - "arrayType": "AttributeList", - "description": "The attributes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetGroupAttribute" - }, - "type": "array", - "uniqueItems": true - }, - "TargetGroupFullName": { - "description": "The full name of the target group.", - "type": "string" - }, - "TargetGroupName": { - "description": "The name of the target group.", - "type": "string" - }, - "TargetType": { - "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.", - "type": "string" - }, - "Targets": { - "description": "The targets.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetDescription" - }, - "type": "array", - "uniqueItems": true - }, - "UnhealthyThresholdCount": { - "description": "The number of consecutive health check failures required before considering a target unhealthy.", - "type": "integer" - }, - "VpcId": { - "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LoadBalancerArns", - "/properties/TargetGroupArn", - "/properties/TargetGroupName", - "/properties/TargetGroupFullName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetType", + "/properties/ProtocolVersion", + "/properties/Port", + "/properties/Name", + "/properties/VpcId", + "/properties/Protocol", + "/properties/IpAddressType" + ], + "definitions": { + "Matcher": { + "additionalProperties": false, + "properties": { + "GrpcCode": { + "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.", + "type": "string" + }, + "HttpCode": { + "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. ", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The value for the tag. ", + "type": "string" + }, + "Value": { + "description": "The key name of the tag. ", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetDescription": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "description": "An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.", + "type": "string" + }, + "Id": { + "description": "The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. ", + "type": "string" + }, + "Port": { + "description": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.", + "type": "integer" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "TargetGroupAttribute": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The value of the attribute.", + "type": "string" + }, + "Value": { + "description": "The name of the attribute.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:CreateTargetGroup", + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:RegisterTargets", + "elasticloadbalancing:ModifyTargetGroupAttributes", + "elasticloadbalancing:DescribeTargetHealth", + "elasticloadbalancing:AddTags" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DeleteTargetGroup", + "elasticloadbalancing:DescribeTargetGroups" + ] + }, + "list": { + "permissions": [ + "elasticloadbalancing:DescribeTargetGroups" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:DescribeTargetGroupAttributes", + "elasticloadbalancing:DescribeTargetHealth", + "elasticloadbalancing:DescribeTags" + ] + }, + "update": { + "permissions": [ + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:ModifyTargetGroup", + "elasticloadbalancing:ModifyTargetGroupAttributes", + "elasticloadbalancing:RegisterTargets", + "elasticloadbalancing:DescribeTargetHealth", + "elasticloadbalancing:DeregisterTargets", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RemoveTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/TargetGroupArn" + ], + "properties": { + "HealthCheckEnabled": { + "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.", + "type": "boolean" + }, + "HealthCheckIntervalSeconds": { + "description": "The approximate amount of time, in seconds, between health checks of an individual target.", + "type": "integer" + }, + "HealthCheckPath": { + "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.", + "type": "string" + }, + "HealthCheckPort": { + "description": "The port the load balancer uses when performing health checks on targets. ", + "type": "string" + }, + "HealthCheckProtocol": { + "description": "The protocol the load balancer uses when performing health checks on targets. ", + "type": "string" + }, + "HealthCheckTimeoutSeconds": { + "description": "The amount of time, in seconds, during which no response from a target means a failed health check.", + "type": "integer" + }, + "HealthyThresholdCount": { + "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy. ", + "type": "integer" + }, + "IpAddressType": { + "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6. ", + "type": "string" + }, + "LoadBalancerArns": { + "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Matcher": { + "$ref": "#/definitions/Matcher", + "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." + }, + "Name": { + "description": "The name of the target group.", + "type": "string" + }, + "Port": { + "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.", + "type": "integer" + }, + "Protocol": { + "description": "The protocol to use for routing traffic to the targets.", + "type": "string" + }, + "ProtocolVersion": { + "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.", + "type": "string" + }, + "Tags": { + "description": "The tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TargetGroupArn": { + "description": "The ARN of the Target Group", + "type": "string" + }, + "TargetGroupAttributes": { + "arrayType": "AttributeList", + "description": "The attributes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetGroupAttribute" + }, + "type": "array", + "uniqueItems": true + }, + "TargetGroupFullName": { + "description": "The full name of the target group.", + "type": "string" + }, + "TargetGroupName": { + "description": "The name of the target group.", + "type": "string" + }, + "TargetType": { + "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.", + "type": "string" + }, + "Targets": { + "description": "The targets.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetDescription" + }, + "type": "array", + "uniqueItems": true + }, + "UnhealthyThresholdCount": { + "description": "The number of consecutive health check failures required before considering a target unhealthy.", + "type": "integer" + }, + "VpcId": { + "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LoadBalancerArns", + "/properties/TargetGroupArn", + "/properties/TargetGroupName", + "/properties/TargetGroupFullName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" +} diff --git a/schema/aws-elasticloadbalancingv2-truststore.json b/schema/aws-elasticloadbalancingv2-truststore.json index c047f1f..4a02d3b 100644 --- a/schema/aws-elasticloadbalancingv2-truststore.json +++ b/schema/aws-elasticloadbalancingv2-truststore.json @@ -1,146 +1,151 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStore", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:CreateTrustStore", - "elasticloadbalancing:DescribeTrustStores", - "elasticloadbalancing:AddTags", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DescribeTrustStores", - "elasticloadbalancing:DeleteTrustStore" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Names": { - "insertionOrder": false, - "items": { - "$ref": "resource-schema.json#/properties/Name" - }, - "type": "array", - "uniqueItems": false - }, - "TrustStoreArns": { - "insertionOrder": false, - "items": { - "$ref": "resource-schema.json#/properties/TrustStoreArn" - }, - "type": "array", - "uniqueItems": false - } - } - }, - "permissions": [ - "elasticloadbalancing:DescribeTrustStores", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeTrustStores", - "elasticloadbalancing:DescribeTags" - ] - }, - "update": { - "permissions": [ - "elasticloadbalancing:ModifyTrustStore", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RemoveTags", - "s3:GetObject", - "s3:GetObjectVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrustStoreArn" - ], - "properties": { - "CaCertificatesBundleS3Bucket": { - "description": "The name of the S3 bucket to fetch the CA certificate bundle from.", - "type": "string" - }, - "CaCertificatesBundleS3Key": { - "description": "The name of the S3 object to fetch the CA certificate bundle from.", - "type": "string" - }, - "CaCertificatesBundleS3ObjectVersion": { - "description": "The version of the S3 bucket that contains the CA certificate bundle.", - "type": "string" - }, - "Name": { - "description": "The name of the trust store.", - "type": "string" - }, - "NumberOfCaCertificates": { - "description": "The number of certificates associated with the trust store.", - "type": "integer" - }, - "Status": { - "description": "The status of the trust store, could be either of ACTIVE or CREATING.", - "type": "string" - }, - "Tags": { - "description": "The tags to assign to the trust store.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TrustStoreArn": { - "description": "The Amazon Resource Name (ARN) of the trust store.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TrustStoreArn", - "/properties/Status", - "/properties/NumberOfCaCertificates" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ElasticLoadBalancingV2::TrustStore", - "writeOnlyProperties": [ - "/properties/CaCertificatesBundleS3Bucket", - "/properties/CaCertificatesBundleS3Key", - "/properties/CaCertificatesBundleS3ObjectVersion" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStore", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:CreateTrustStore", + "elasticloadbalancing:DescribeTrustStores", + "elasticloadbalancing:AddTags", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DescribeTrustStores", + "elasticloadbalancing:DeleteTrustStore" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Names": { + "insertionOrder": false, + "items": { + "$ref": "resource-schema.json#/properties/Name" + }, + "type": "array", + "uniqueItems": false + }, + "TrustStoreArns": { + "insertionOrder": false, + "items": { + "$ref": "resource-schema.json#/properties/TrustStoreArn" + }, + "type": "array", + "uniqueItems": false + } + } + }, + "permissions": [ + "elasticloadbalancing:DescribeTrustStores", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeTrustStores", + "elasticloadbalancing:DescribeTags" + ] + }, + "update": { + "permissions": [ + "elasticloadbalancing:ModifyTrustStore", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RemoveTags", + "s3:GetObject", + "s3:GetObjectVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrustStoreArn" + ], + "properties": { + "CaCertificatesBundleS3Bucket": { + "description": "The name of the S3 bucket to fetch the CA certificate bundle from.", + "type": "string" + }, + "CaCertificatesBundleS3Key": { + "description": "The name of the S3 object to fetch the CA certificate bundle from.", + "type": "string" + }, + "CaCertificatesBundleS3ObjectVersion": { + "description": "The version of the S3 bucket that contains the CA certificate bundle.", + "type": "string" + }, + "Name": { + "description": "The name of the trust store.", + "type": "string" + }, + "NumberOfCaCertificates": { + "description": "The number of certificates associated with the trust store.", + "type": "integer" + }, + "Status": { + "description": "The status of the trust store, could be either of ACTIVE or CREATING.", + "type": "string" + }, + "Tags": { + "description": "The tags to assign to the trust store.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TrustStoreArn": { + "description": "The Amazon Resource Name (ARN) of the trust store.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TrustStoreArn", + "/properties/Status", + "/properties/NumberOfCaCertificates" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "elasticloadbalancing:AddTags", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:RemoveTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElasticLoadBalancingV2::TrustStore", + "writeOnlyProperties": [ + "/properties/CaCertificatesBundleS3Bucket", + "/properties/CaCertificatesBundleS3Key", + "/properties/CaCertificatesBundleS3ObjectVersion" + ] +} diff --git a/schema/aws-elasticloadbalancingv2-truststorerevocation.json b/schema/aws-elasticloadbalancingv2-truststorerevocation.json index be772e5..4cd0f4d 100644 --- a/schema/aws-elasticloadbalancingv2-truststorerevocation.json +++ b/schema/aws-elasticloadbalancingv2-truststorerevocation.json @@ -1,143 +1,143 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TrustStoreArn", - "/properties/RevocationContents" - ], - "definitions": { - "RevocationContent": { - "additionalProperties": false, - "properties": { - "RevocationType": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - } - }, - "type": "object" - }, - "RevocationId": { - "type": "string" - }, - "TrustStoreRevocation": { - "additionalProperties": false, - "properties": { - "NumberOfRevokedEntries": { - "format": "int64", - "type": "integer" - }, - "RevocationId": { - "type": "string" - }, - "RevocationType": { - "type": "string" - }, - "TrustStoreArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html", - "handlers": { - "create": { - "permissions": [ - "elasticloadbalancing:AddTrustStoreRevocations", - "elasticloadbalancing:DescribeTrustStoreRevocations", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DescribeTrustStoreRevocations", - "elasticloadbalancing:RemoveTrustStoreRevocations" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RevocationIds": { - "insertionOrder": false, - "items": { - "$ref": "resource-schema.json#/properties/RevocationId" - }, - "type": "array", - "uniqueItems": false - }, - "TrustStoreArn": { - "$ref": "resource-schema.json#/properties/TrustStoreArn" - } - }, - "required": [ - "TrustStoreArn" - ] - }, - "permissions": [ - "elasticloadbalancing:DescribeTrustStoreRevocations" - ] - }, - "read": { - "permissions": [ - "elasticloadbalancing:DescribeTrustStoreRevocations" - ] - } - }, - "primaryIdentifier": [ - "/properties/RevocationId", - "/properties/TrustStoreArn" - ], - "properties": { - "RevocationContents": { - "description": "The attributes required to create a trust store revocation.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RevocationContent" - }, - "type": "array", - "uniqueItems": true - }, - "RevocationId": { - "description": "The ID associated with the revocation.", - "format": "int64", - "type": "integer" - }, - "TrustStoreArn": { - "description": "The Amazon Resource Name (ARN) of the trust store.", - "type": "string" - }, - "TrustStoreRevocations": { - "description": "The data associated with a trust store revocation", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TrustStoreRevocation" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/RevocationId", - "/properties/TrustStoreRevocations" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ElasticLoadBalancingV2::TrustStoreRevocation", - "writeOnlyProperties": [ - "/properties/RevocationContents" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TrustStoreArn", + "/properties/RevocationContents" + ], + "definitions": { + "RevocationContent": { + "additionalProperties": false, + "properties": { + "RevocationType": { + "type": "string" + }, + "S3Bucket": { + "type": "string" + }, + "S3Key": { + "type": "string" + }, + "S3ObjectVersion": { + "type": "string" + } + }, + "type": "object" + }, + "RevocationId": { + "type": "string" + }, + "TrustStoreRevocation": { + "additionalProperties": false, + "properties": { + "NumberOfRevokedEntries": { + "format": "int64", + "type": "integer" + }, + "RevocationId": { + "type": "string" + }, + "RevocationType": { + "type": "string" + }, + "TrustStoreArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html", + "handlers": { + "create": { + "permissions": [ + "elasticloadbalancing:AddTrustStoreRevocations", + "elasticloadbalancing:DescribeTrustStoreRevocations", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DescribeTrustStoreRevocations", + "elasticloadbalancing:RemoveTrustStoreRevocations" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RevocationIds": { + "insertionOrder": false, + "items": { + "$ref": "resource-schema.json#/properties/RevocationId" + }, + "type": "array", + "uniqueItems": false + }, + "TrustStoreArn": { + "$ref": "resource-schema.json#/properties/TrustStoreArn" + } + }, + "required": [ + "TrustStoreArn" + ] + }, + "permissions": [ + "elasticloadbalancing:DescribeTrustStoreRevocations" + ] + }, + "read": { + "permissions": [ + "elasticloadbalancing:DescribeTrustStoreRevocations" + ] + } + }, + "primaryIdentifier": [ + "/properties/RevocationId", + "/properties/TrustStoreArn" + ], + "properties": { + "RevocationContents": { + "description": "The attributes required to create a trust store revocation.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RevocationContent" + }, + "type": "array", + "uniqueItems": true + }, + "RevocationId": { + "description": "The ID associated with the revocation.", + "format": "int64", + "type": "integer" + }, + "TrustStoreArn": { + "description": "The Amazon Resource Name (ARN) of the trust store.", + "type": "string" + }, + "TrustStoreRevocations": { + "description": "The data associated with a trust store revocation", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TrustStoreRevocation" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/RevocationId", + "/properties/TrustStoreRevocations" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ElasticLoadBalancingV2::TrustStoreRevocation", + "writeOnlyProperties": [ + "/properties/RevocationContents" + ] +} diff --git a/schema/aws-elasticsearch-domain.json b/schema/aws-elasticsearch-domain.json index e45edcb..0935c8d 100644 --- a/schema/aws-elasticsearch-domain.json +++ b/schema/aws-elasticsearch-domain.json @@ -1,317 +1,317 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainName" - ], - "definitions": { - "AdvancedSecurityOptionsInput": { - "additionalProperties": false, - "properties": { - "AnonymousAuthEnabled": { - "type": "boolean" - }, - "Enabled": { - "type": "boolean" - }, - "InternalUserDatabaseEnabled": { - "type": "boolean" - }, - "MasterUserOptions": { - "$ref": "#/definitions/MasterUserOptions" - } - }, - "type": "object" - }, - "CognitoOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "IdentityPoolId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "ColdStorageOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "DomainEndpointOptions": { - "additionalProperties": false, - "properties": { - "CustomEndpoint": { - "type": "string" - }, - "CustomEndpointCertificateArn": { - "type": "string" - }, - "CustomEndpointEnabled": { - "type": "boolean" - }, - "EnforceHTTPS": { - "type": "boolean" - }, - "TLSSecurityPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "EBSOptions": { - "additionalProperties": false, - "properties": { - "EBSEnabled": { - "type": "boolean" - }, - "Iops": { - "type": "integer" - }, - "VolumeSize": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "ElasticsearchClusterConfig": { - "additionalProperties": false, - "properties": { - "ColdStorageOptions": { - "$ref": "#/definitions/ColdStorageOptions" - }, - "DedicatedMasterCount": { - "type": "integer" - }, - "DedicatedMasterEnabled": { - "type": "boolean" - }, - "DedicatedMasterType": { - "type": "string" - }, - "InstanceCount": { - "type": "integer" - }, - "InstanceType": { - "type": "string" - }, - "WarmCount": { - "type": "integer" - }, - "WarmEnabled": { - "type": "boolean" - }, - "WarmType": { - "type": "string" - }, - "ZoneAwarenessConfig": { - "$ref": "#/definitions/ZoneAwarenessConfig" - }, - "ZoneAwarenessEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "EncryptionAtRestOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "KmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "LogPublishingOption": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "MasterUserOptions": { - "additionalProperties": false, - "properties": { - "MasterUserARN": { - "type": "string" - }, - "MasterUserName": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - } - }, - "type": "object" - }, - "NodeToNodeEncryptionOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "SnapshotOptions": { - "additionalProperties": false, - "properties": { - "AutomatedSnapshotStartHour": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VPCOptions": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ZoneAwarenessConfig": { - "additionalProperties": false, - "properties": { - "AvailabilityZoneCount": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Elasticsearch::Domain", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessPolicies": { - "type": "object" - }, - "AdvancedOptions": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "AdvancedSecurityOptions": { - "$ref": "#/definitions/AdvancedSecurityOptionsInput" - }, - "Arn": { - "type": "string" - }, - "CognitoOptions": { - "$ref": "#/definitions/CognitoOptions" - }, - "DomainArn": { - "type": "string" - }, - "DomainEndpoint": { - "type": "string" - }, - "DomainEndpointOptions": { - "$ref": "#/definitions/DomainEndpointOptions" - }, - "DomainName": { - "type": "string" - }, - "EBSOptions": { - "$ref": "#/definitions/EBSOptions" - }, - "ElasticsearchClusterConfig": { - "$ref": "#/definitions/ElasticsearchClusterConfig" - }, - "ElasticsearchVersion": { - "type": "string" - }, - "EncryptionAtRestOptions": { - "$ref": "#/definitions/EncryptionAtRestOptions" - }, - "Id": { - "type": "string" - }, - "LogPublishingOptions": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "$ref": "#/definitions/LogPublishingOption" - } - }, - "type": "object" - }, - "NodeToNodeEncryptionOptions": { - "$ref": "#/definitions/NodeToNodeEncryptionOptions" - }, - "SnapshotOptions": { - "$ref": "#/definitions/SnapshotOptions" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VPCOptions": { - "$ref": "#/definitions/VPCOptions" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/DomainArn", - "/properties/DomainEndpoint", - "/properties/Arn" - ], - "typeName": "AWS::Elasticsearch::Domain" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName" + ], + "definitions": { + "AdvancedSecurityOptionsInput": { + "additionalProperties": false, + "properties": { + "AnonymousAuthEnabled": { + "type": "boolean" + }, + "Enabled": { + "type": "boolean" + }, + "InternalUserDatabaseEnabled": { + "type": "boolean" + }, + "MasterUserOptions": { + "$ref": "#/definitions/MasterUserOptions" + } + }, + "type": "object" + }, + "CognitoOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "IdentityPoolId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "type": "object" + }, + "ColdStorageOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "DomainEndpointOptions": { + "additionalProperties": false, + "properties": { + "CustomEndpoint": { + "type": "string" + }, + "CustomEndpointCertificateArn": { + "type": "string" + }, + "CustomEndpointEnabled": { + "type": "boolean" + }, + "EnforceHTTPS": { + "type": "boolean" + }, + "TLSSecurityPolicy": { + "type": "string" + } + }, + "type": "object" + }, + "EBSOptions": { + "additionalProperties": false, + "properties": { + "EBSEnabled": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "type": "object" + }, + "ElasticsearchClusterConfig": { + "additionalProperties": false, + "properties": { + "ColdStorageOptions": { + "$ref": "#/definitions/ColdStorageOptions" + }, + "DedicatedMasterCount": { + "type": "integer" + }, + "DedicatedMasterEnabled": { + "type": "boolean" + }, + "DedicatedMasterType": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceType": { + "type": "string" + }, + "WarmCount": { + "type": "integer" + }, + "WarmEnabled": { + "type": "boolean" + }, + "WarmType": { + "type": "string" + }, + "ZoneAwarenessConfig": { + "$ref": "#/definitions/ZoneAwarenessConfig" + }, + "ZoneAwarenessEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "EncryptionAtRestOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "KmsKeyId": { + "type": "string" + } + }, + "type": "object" + }, + "LogPublishingOption": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsLogGroupArn": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "MasterUserOptions": { + "additionalProperties": false, + "properties": { + "MasterUserARN": { + "type": "string" + }, + "MasterUserName": { + "type": "string" + }, + "MasterUserPassword": { + "type": "string" + } + }, + "type": "object" + }, + "NodeToNodeEncryptionOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "SnapshotOptions": { + "additionalProperties": false, + "properties": { + "AutomatedSnapshotStartHour": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VPCOptions": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ZoneAwarenessConfig": { + "additionalProperties": false, + "properties": { + "AvailabilityZoneCount": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Elasticsearch::Domain", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessPolicies": { + "type": "object" + }, + "AdvancedOptions": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "AdvancedSecurityOptions": { + "$ref": "#/definitions/AdvancedSecurityOptionsInput" + }, + "Arn": { + "type": "string" + }, + "CognitoOptions": { + "$ref": "#/definitions/CognitoOptions" + }, + "DomainArn": { + "type": "string" + }, + "DomainEndpoint": { + "type": "string" + }, + "DomainEndpointOptions": { + "$ref": "#/definitions/DomainEndpointOptions" + }, + "DomainName": { + "type": "string" + }, + "EBSOptions": { + "$ref": "#/definitions/EBSOptions" + }, + "ElasticsearchClusterConfig": { + "$ref": "#/definitions/ElasticsearchClusterConfig" + }, + "ElasticsearchVersion": { + "type": "string" + }, + "EncryptionAtRestOptions": { + "$ref": "#/definitions/EncryptionAtRestOptions" + }, + "Id": { + "type": "string" + }, + "LogPublishingOptions": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "$ref": "#/definitions/LogPublishingOption" + } + }, + "type": "object" + }, + "NodeToNodeEncryptionOptions": { + "$ref": "#/definitions/NodeToNodeEncryptionOptions" + }, + "SnapshotOptions": { + "$ref": "#/definitions/SnapshotOptions" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VPCOptions": { + "$ref": "#/definitions/VPCOptions" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/DomainArn", + "/properties/DomainEndpoint", + "/properties/Arn" + ], + "typeName": "AWS::Elasticsearch::Domain" +} diff --git a/schema/aws-emr-cluster.json b/schema/aws-emr-cluster.json index 46037f3..ad01c74 100644 --- a/schema/aws-emr-cluster.json +++ b/schema/aws-emr-cluster.json @@ -1,859 +1,859 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Steps", - "/properties/EbsRootVolumeSize", - "/properties/SecurityConfiguration", - "/properties/ScaleDownBehavior", - "/properties/Configurations", - "/properties/ReleaseLabel", - "/properties/BootstrapActions", - "/properties/EbsRootVolumeIops", - "/properties/KerberosAttributes", - "/properties/ServiceRole", - "/properties/LogEncryptionKmsKeyId", - "/properties/Name", - "/properties/EbsRootVolumeThroughput", - "/properties/JobFlowRole", - "/properties/AdditionalInfo", - "/properties/LogUri", - "/properties/CustomAmiId", - "/properties/PlacementGroupConfigs", - "/properties/OSReleaseLabel", - "/properties/AutoScalingRole", - "/properties/Applications" - ], - "definitions": { - "Application": { - "additionalProperties": false, - "properties": { - "AdditionalInfo": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Args": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AutoScalingPolicy": { - "additionalProperties": false, - "properties": { - "Constraints": { - "$ref": "#/definitions/ScalingConstraints" - }, - "Rules": { - "items": { - "$ref": "#/definitions/ScalingRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Constraints", - "Rules" - ], - "type": "object" - }, - "AutoTerminationPolicy": { - "additionalProperties": false, - "properties": { - "IdleTimeout": { - "type": "integer" - } - }, - "type": "object" - }, - "BootstrapActionConfig": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ScriptBootstrapAction": { - "$ref": "#/definitions/ScriptBootstrapActionConfig" - } - }, - "required": [ - "ScriptBootstrapAction", - "Name" - ], - "type": "object" - }, - "CloudWatchAlarmDefinition": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": true - }, - "EvaluationPeriods": { - "type": "integer" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Period": { - "type": "integer" - }, - "Statistic": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "ComparisonOperator", - "Period", - "Threshold" - ], - "type": "object" - }, - "ComputeLimits": { - "additionalProperties": false, - "properties": { - "MaximumCapacityUnits": { - "type": "integer" - }, - "MaximumCoreCapacityUnits": { - "type": "integer" - }, - "MaximumOnDemandCapacityUnits": { - "type": "integer" - }, - "MinimumCapacityUnits": { - "type": "integer" - }, - "UnitType": { - "type": "string" - } - }, - "required": [ - "UnitType", - "MaximumCapacityUnits", - "MinimumCapacityUnits" - ], - "type": "object" - }, - "Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "integer" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/EbsBlockDeviceConfig" - }, - "type": "array", - "uniqueItems": true - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "HadoopJarStepConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Jar": { - "type": "string" - }, - "MainClass": { - "type": "string" - }, - "StepProperties": { - "items": { - "$ref": "#/definitions/KeyValue" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Jar" - ], - "type": "object" - }, - "InstanceFleetConfig": { - "additionalProperties": false, - "properties": { - "InstanceTypeConfigs": { - "items": { - "$ref": "#/definitions/InstanceTypeConfig" - }, - "type": "array", - "uniqueItems": true - }, - "LaunchSpecifications": { - "$ref": "#/definitions/InstanceFleetProvisioningSpecifications" - }, - "Name": { - "type": "string" - }, - "TargetOnDemandCapacity": { - "type": "integer" - }, - "TargetSpotCapacity": { - "type": "integer" - } - }, - "type": "object" - }, - "InstanceFleetProvisioningSpecifications": { - "additionalProperties": false, - "properties": { - "OnDemandSpecification": { - "$ref": "#/definitions/OnDemandProvisioningSpecification" - }, - "SpotSpecification": { - "$ref": "#/definitions/SpotProvisioningSpecification" - } - }, - "type": "object" - }, - "InstanceGroupConfig": { - "additionalProperties": false, - "properties": { - "AutoScalingPolicy": { - "$ref": "#/definitions/AutoScalingPolicy" - }, - "BidPrice": { - "type": "string" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - }, - "CustomAmiId": { - "type": "string" - }, - "EbsConfiguration": { - "$ref": "#/definitions/EbsConfiguration" - }, - "InstanceCount": { - "type": "integer" - }, - "InstanceType": { - "type": "string" - }, - "Market": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "InstanceCount", - "InstanceType" - ], - "type": "object" - }, - "InstanceTypeConfig": { - "additionalProperties": false, - "properties": { - "BidPrice": { - "type": "string" - }, - "BidPriceAsPercentageOfOnDemandPrice": { - "type": "number" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - }, - "CustomAmiId": { - "type": "string" - }, - "EbsConfiguration": { - "$ref": "#/definitions/EbsConfiguration" - }, - "InstanceType": { - "type": "string" - }, - "WeightedCapacity": { - "type": "integer" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "JobFlowInstancesConfig": { - "additionalProperties": false, - "properties": { - "AdditionalMasterSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AdditionalSlaveSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CoreInstanceFleet": { - "$ref": "#/definitions/InstanceFleetConfig" - }, - "CoreInstanceGroup": { - "$ref": "#/definitions/InstanceGroupConfig" - }, - "Ec2KeyName": { - "type": "string" - }, - "Ec2SubnetId": { - "type": "string" - }, - "Ec2SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "EmrManagedMasterSecurityGroup": { - "type": "string" - }, - "EmrManagedSlaveSecurityGroup": { - "type": "string" - }, - "HadoopVersion": { - "type": "string" - }, - "KeepJobFlowAliveWhenNoSteps": { - "type": "boolean" - }, - "MasterInstanceFleet": { - "$ref": "#/definitions/InstanceFleetConfig" - }, - "MasterInstanceGroup": { - "$ref": "#/definitions/InstanceGroupConfig" - }, - "Placement": { - "$ref": "#/definitions/PlacementType" - }, - "ServiceAccessSecurityGroup": { - "type": "string" - }, - "TaskInstanceFleets": { - "items": { - "$ref": "#/definitions/InstanceFleetConfig" - }, - "type": "array", - "uniqueItems": true - }, - "TaskInstanceGroups": { - "items": { - "$ref": "#/definitions/InstanceGroupConfig" - }, - "type": "array", - "uniqueItems": true - }, - "TerminationProtected": { - "type": "boolean" - }, - "UnhealthyNodeReplacement": { - "type": "boolean" - } - }, - "type": "object" - }, - "KerberosAttributes": { - "additionalProperties": false, - "properties": { - "ADDomainJoinPassword": { - "type": "string" - }, - "ADDomainJoinUser": { - "type": "string" - }, - "CrossRealmTrustPrincipalPassword": { - "type": "string" - }, - "KdcAdminPassword": { - "type": "string" - }, - "Realm": { - "type": "string" - } - }, - "required": [ - "KdcAdminPassword", - "Realm" - ], - "type": "object" - }, - "KeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "ManagedScalingPolicy": { - "additionalProperties": false, - "properties": { - "ComputeLimits": { - "$ref": "#/definitions/ComputeLimits" - } - }, - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "OnDemandProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - } - }, - "required": [ - "AllocationStrategy" - ], - "type": "object" - }, - "PlacementGroupConfig": { - "additionalProperties": false, - "properties": { - "InstanceRole": { - "type": "string" - }, - "PlacementStrategy": { - "type": "string" - } - }, - "required": [ - "InstanceRole" - ], - "type": "object" - }, - "PlacementType": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone" - ], - "type": "object" - }, - "ScalingAction": { - "additionalProperties": false, - "properties": { - "Market": { - "type": "string" - }, - "SimpleScalingPolicyConfiguration": { - "$ref": "#/definitions/SimpleScalingPolicyConfiguration" - } - }, - "required": [ - "SimpleScalingPolicyConfiguration" - ], - "type": "object" - }, - "ScalingConstraints": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "integer" - }, - "MinCapacity": { - "type": "integer" - } - }, - "required": [ - "MinCapacity", - "MaxCapacity" - ], - "type": "object" - }, - "ScalingRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/ScalingAction" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Trigger": { - "$ref": "#/definitions/ScalingTrigger" - } - }, - "required": [ - "Action", - "Trigger", - "Name" - ], - "type": "object" - }, - "ScalingTrigger": { - "additionalProperties": false, - "properties": { - "CloudWatchAlarmDefinition": { - "$ref": "#/definitions/CloudWatchAlarmDefinition" - } - }, - "required": [ - "CloudWatchAlarmDefinition" - ], - "type": "object" - }, - "ScriptBootstrapActionConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "SimpleScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "CoolDown": { - "type": "integer" - }, - "ScalingAdjustment": { - "type": "integer" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "SpotProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BlockDurationMinutes": { - "type": "integer" - }, - "TimeoutAction": { - "type": "string" - }, - "TimeoutDurationMinutes": { - "type": "integer" - } - }, - "required": [ - "TimeoutDurationMinutes", - "TimeoutAction" - ], - "type": "object" - }, - "StepConfig": { - "additionalProperties": false, - "properties": { - "ActionOnFailure": { - "type": "string" - }, - "HadoopJarStep": { - "$ref": "#/definitions/HadoopJarStepConfig" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "HadoopJarStep", - "Name" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "integer" - }, - "SizeInGB": { - "type": "integer" - }, - "Throughput": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EMR::Cluster", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AdditionalInfo": { - "type": "object" - }, - "Applications": { - "items": { - "$ref": "#/definitions/Application" - }, - "type": "array", - "uniqueItems": true - }, - "AutoScalingRole": { - "type": "string" - }, - "AutoTerminationPolicy": { - "$ref": "#/definitions/AutoTerminationPolicy" - }, - "BootstrapActions": { - "items": { - "$ref": "#/definitions/BootstrapActionConfig" - }, - "type": "array", - "uniqueItems": true - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - }, - "CustomAmiId": { - "type": "string" - }, - "EbsRootVolumeIops": { - "type": "integer" - }, - "EbsRootVolumeSize": { - "type": "integer" - }, - "EbsRootVolumeThroughput": { - "type": "integer" - }, - "Id": { - "type": "string" - }, - "Instances": { - "$ref": "#/definitions/JobFlowInstancesConfig" - }, - "JobFlowRole": { - "type": "string" - }, - "KerberosAttributes": { - "$ref": "#/definitions/KerberosAttributes" - }, - "LogEncryptionKmsKeyId": { - "type": "string" - }, - "LogUri": { - "type": "string" - }, - "ManagedScalingPolicy": { - "$ref": "#/definitions/ManagedScalingPolicy" - }, - "MasterPublicDNS": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OSReleaseLabel": { - "type": "string" - }, - "PlacementGroupConfigs": { - "items": { - "$ref": "#/definitions/PlacementGroupConfig" - }, - "type": "array", - "uniqueItems": true - }, - "ReleaseLabel": { - "type": "string" - }, - "ScaleDownBehavior": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "ServiceRole": { - "type": "string" - }, - "StepConcurrencyLevel": { - "type": "integer" - }, - "Steps": { - "items": { - "$ref": "#/definitions/StepConfig" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VisibleToAllUsers": { - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/MasterPublicDNS" - ], - "required": [ - "Instances", - "ServiceRole", - "JobFlowRole", - "Name" - ], - "typeName": "AWS::EMR::Cluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Steps", + "/properties/EbsRootVolumeSize", + "/properties/SecurityConfiguration", + "/properties/ScaleDownBehavior", + "/properties/Configurations", + "/properties/ReleaseLabel", + "/properties/BootstrapActions", + "/properties/EbsRootVolumeIops", + "/properties/KerberosAttributes", + "/properties/ServiceRole", + "/properties/LogEncryptionKmsKeyId", + "/properties/Name", + "/properties/EbsRootVolumeThroughput", + "/properties/JobFlowRole", + "/properties/AdditionalInfo", + "/properties/LogUri", + "/properties/CustomAmiId", + "/properties/PlacementGroupConfigs", + "/properties/OSReleaseLabel", + "/properties/AutoScalingRole", + "/properties/Applications" + ], + "definitions": { + "Application": { + "additionalProperties": false, + "properties": { + "AdditionalInfo": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Args": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "type": "object" + }, + "AutoScalingPolicy": { + "additionalProperties": false, + "properties": { + "Constraints": { + "$ref": "#/definitions/ScalingConstraints" + }, + "Rules": { + "items": { + "$ref": "#/definitions/ScalingRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Constraints", + "Rules" + ], + "type": "object" + }, + "AutoTerminationPolicy": { + "additionalProperties": false, + "properties": { + "IdleTimeout": { + "type": "integer" + } + }, + "type": "object" + }, + "BootstrapActionConfig": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "ScriptBootstrapAction": { + "$ref": "#/definitions/ScriptBootstrapActionConfig" + } + }, + "required": [ + "ScriptBootstrapAction", + "Name" + ], + "type": "object" + }, + "CloudWatchAlarmDefinition": { + "additionalProperties": false, + "properties": { + "ComparisonOperator": { + "type": "string" + }, + "Dimensions": { + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": true + }, + "EvaluationPeriods": { + "type": "integer" + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "Period": { + "type": "integer" + }, + "Statistic": { + "type": "string" + }, + "Threshold": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "MetricName", + "ComparisonOperator", + "Period", + "Threshold" + ], + "type": "object" + }, + "ComputeLimits": { + "additionalProperties": false, + "properties": { + "MaximumCapacityUnits": { + "type": "integer" + }, + "MaximumCoreCapacityUnits": { + "type": "integer" + }, + "MaximumOnDemandCapacityUnits": { + "type": "integer" + }, + "MinimumCapacityUnits": { + "type": "integer" + }, + "UnitType": { + "type": "string" + } + }, + "required": [ + "UnitType", + "MaximumCapacityUnits", + "MinimumCapacityUnits" + ], + "type": "object" + }, + "Configuration": { + "additionalProperties": false, + "properties": { + "Classification": { + "type": "string" + }, + "ConfigurationProperties": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EbsBlockDeviceConfig": { + "additionalProperties": false, + "properties": { + "VolumeSpecification": { + "$ref": "#/definitions/VolumeSpecification" + }, + "VolumesPerInstance": { + "type": "integer" + } + }, + "required": [ + "VolumeSpecification" + ], + "type": "object" + }, + "EbsConfiguration": { + "additionalProperties": false, + "properties": { + "EbsBlockDeviceConfigs": { + "items": { + "$ref": "#/definitions/EbsBlockDeviceConfig" + }, + "type": "array", + "uniqueItems": true + }, + "EbsOptimized": { + "type": "boolean" + } + }, + "type": "object" + }, + "HadoopJarStepConfig": { + "additionalProperties": false, + "properties": { + "Args": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Jar": { + "type": "string" + }, + "MainClass": { + "type": "string" + }, + "StepProperties": { + "items": { + "$ref": "#/definitions/KeyValue" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Jar" + ], + "type": "object" + }, + "InstanceFleetConfig": { + "additionalProperties": false, + "properties": { + "InstanceTypeConfigs": { + "items": { + "$ref": "#/definitions/InstanceTypeConfig" + }, + "type": "array", + "uniqueItems": true + }, + "LaunchSpecifications": { + "$ref": "#/definitions/InstanceFleetProvisioningSpecifications" + }, + "Name": { + "type": "string" + }, + "TargetOnDemandCapacity": { + "type": "integer" + }, + "TargetSpotCapacity": { + "type": "integer" + } + }, + "type": "object" + }, + "InstanceFleetProvisioningSpecifications": { + "additionalProperties": false, + "properties": { + "OnDemandSpecification": { + "$ref": "#/definitions/OnDemandProvisioningSpecification" + }, + "SpotSpecification": { + "$ref": "#/definitions/SpotProvisioningSpecification" + } + }, + "type": "object" + }, + "InstanceGroupConfig": { + "additionalProperties": false, + "properties": { + "AutoScalingPolicy": { + "$ref": "#/definitions/AutoScalingPolicy" + }, + "BidPrice": { + "type": "string" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + }, + "CustomAmiId": { + "type": "string" + }, + "EbsConfiguration": { + "$ref": "#/definitions/EbsConfiguration" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceType": { + "type": "string" + }, + "Market": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "InstanceCount", + "InstanceType" + ], + "type": "object" + }, + "InstanceTypeConfig": { + "additionalProperties": false, + "properties": { + "BidPrice": { + "type": "string" + }, + "BidPriceAsPercentageOfOnDemandPrice": { + "type": "number" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + }, + "CustomAmiId": { + "type": "string" + }, + "EbsConfiguration": { + "$ref": "#/definitions/EbsConfiguration" + }, + "InstanceType": { + "type": "string" + }, + "WeightedCapacity": { + "type": "integer" + } + }, + "required": [ + "InstanceType" + ], + "type": "object" + }, + "JobFlowInstancesConfig": { + "additionalProperties": false, + "properties": { + "AdditionalMasterSecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AdditionalSlaveSecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CoreInstanceFleet": { + "$ref": "#/definitions/InstanceFleetConfig" + }, + "CoreInstanceGroup": { + "$ref": "#/definitions/InstanceGroupConfig" + }, + "Ec2KeyName": { + "type": "string" + }, + "Ec2SubnetId": { + "type": "string" + }, + "Ec2SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "EmrManagedMasterSecurityGroup": { + "type": "string" + }, + "EmrManagedSlaveSecurityGroup": { + "type": "string" + }, + "HadoopVersion": { + "type": "string" + }, + "KeepJobFlowAliveWhenNoSteps": { + "type": "boolean" + }, + "MasterInstanceFleet": { + "$ref": "#/definitions/InstanceFleetConfig" + }, + "MasterInstanceGroup": { + "$ref": "#/definitions/InstanceGroupConfig" + }, + "Placement": { + "$ref": "#/definitions/PlacementType" + }, + "ServiceAccessSecurityGroup": { + "type": "string" + }, + "TaskInstanceFleets": { + "items": { + "$ref": "#/definitions/InstanceFleetConfig" + }, + "type": "array", + "uniqueItems": true + }, + "TaskInstanceGroups": { + "items": { + "$ref": "#/definitions/InstanceGroupConfig" + }, + "type": "array", + "uniqueItems": true + }, + "TerminationProtected": { + "type": "boolean" + }, + "UnhealthyNodeReplacement": { + "type": "boolean" + } + }, + "type": "object" + }, + "KerberosAttributes": { + "additionalProperties": false, + "properties": { + "ADDomainJoinPassword": { + "type": "string" + }, + "ADDomainJoinUser": { + "type": "string" + }, + "CrossRealmTrustPrincipalPassword": { + "type": "string" + }, + "KdcAdminPassword": { + "type": "string" + }, + "Realm": { + "type": "string" + } + }, + "required": [ + "KdcAdminPassword", + "Realm" + ], + "type": "object" + }, + "KeyValue": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "ManagedScalingPolicy": { + "additionalProperties": false, + "properties": { + "ComputeLimits": { + "$ref": "#/definitions/ComputeLimits" + } + }, + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "OnDemandProvisioningSpecification": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + } + }, + "required": [ + "AllocationStrategy" + ], + "type": "object" + }, + "PlacementGroupConfig": { + "additionalProperties": false, + "properties": { + "InstanceRole": { + "type": "string" + }, + "PlacementStrategy": { + "type": "string" + } + }, + "required": [ + "InstanceRole" + ], + "type": "object" + }, + "PlacementType": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + } + }, + "required": [ + "AvailabilityZone" + ], + "type": "object" + }, + "ScalingAction": { + "additionalProperties": false, + "properties": { + "Market": { + "type": "string" + }, + "SimpleScalingPolicyConfiguration": { + "$ref": "#/definitions/SimpleScalingPolicyConfiguration" + } + }, + "required": [ + "SimpleScalingPolicyConfiguration" + ], + "type": "object" + }, + "ScalingConstraints": { + "additionalProperties": false, + "properties": { + "MaxCapacity": { + "type": "integer" + }, + "MinCapacity": { + "type": "integer" + } + }, + "required": [ + "MinCapacity", + "MaxCapacity" + ], + "type": "object" + }, + "ScalingRule": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/ScalingAction" + }, + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Trigger": { + "$ref": "#/definitions/ScalingTrigger" + } + }, + "required": [ + "Action", + "Trigger", + "Name" + ], + "type": "object" + }, + "ScalingTrigger": { + "additionalProperties": false, + "properties": { + "CloudWatchAlarmDefinition": { + "$ref": "#/definitions/CloudWatchAlarmDefinition" + } + }, + "required": [ + "CloudWatchAlarmDefinition" + ], + "type": "object" + }, + "ScriptBootstrapActionConfig": { + "additionalProperties": false, + "properties": { + "Args": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Path": { + "type": "string" + } + }, + "required": [ + "Path" + ], + "type": "object" + }, + "SimpleScalingPolicyConfiguration": { + "additionalProperties": false, + "properties": { + "AdjustmentType": { + "type": "string" + }, + "CoolDown": { + "type": "integer" + }, + "ScalingAdjustment": { + "type": "integer" + } + }, + "required": [ + "ScalingAdjustment" + ], + "type": "object" + }, + "SpotProvisioningSpecification": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + }, + "BlockDurationMinutes": { + "type": "integer" + }, + "TimeoutAction": { + "type": "string" + }, + "TimeoutDurationMinutes": { + "type": "integer" + } + }, + "required": [ + "TimeoutDurationMinutes", + "TimeoutAction" + ], + "type": "object" + }, + "StepConfig": { + "additionalProperties": false, + "properties": { + "ActionOnFailure": { + "type": "string" + }, + "HadoopJarStep": { + "$ref": "#/definitions/HadoopJarStepConfig" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "HadoopJarStep", + "Name" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VolumeSpecification": { + "additionalProperties": false, + "properties": { + "Iops": { + "type": "integer" + }, + "SizeInGB": { + "type": "integer" + }, + "Throughput": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "required": [ + "SizeInGB", + "VolumeType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EMR::Cluster", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AdditionalInfo": { + "type": "object" + }, + "Applications": { + "items": { + "$ref": "#/definitions/Application" + }, + "type": "array", + "uniqueItems": true + }, + "AutoScalingRole": { + "type": "string" + }, + "AutoTerminationPolicy": { + "$ref": "#/definitions/AutoTerminationPolicy" + }, + "BootstrapActions": { + "items": { + "$ref": "#/definitions/BootstrapActionConfig" + }, + "type": "array", + "uniqueItems": true + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + }, + "CustomAmiId": { + "type": "string" + }, + "EbsRootVolumeIops": { + "type": "integer" + }, + "EbsRootVolumeSize": { + "type": "integer" + }, + "EbsRootVolumeThroughput": { + "type": "integer" + }, + "Id": { + "type": "string" + }, + "Instances": { + "$ref": "#/definitions/JobFlowInstancesConfig" + }, + "JobFlowRole": { + "type": "string" + }, + "KerberosAttributes": { + "$ref": "#/definitions/KerberosAttributes" + }, + "LogEncryptionKmsKeyId": { + "type": "string" + }, + "LogUri": { + "type": "string" + }, + "ManagedScalingPolicy": { + "$ref": "#/definitions/ManagedScalingPolicy" + }, + "MasterPublicDNS": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OSReleaseLabel": { + "type": "string" + }, + "PlacementGroupConfigs": { + "items": { + "$ref": "#/definitions/PlacementGroupConfig" + }, + "type": "array", + "uniqueItems": true + }, + "ReleaseLabel": { + "type": "string" + }, + "ScaleDownBehavior": { + "type": "string" + }, + "SecurityConfiguration": { + "type": "string" + }, + "ServiceRole": { + "type": "string" + }, + "StepConcurrencyLevel": { + "type": "integer" + }, + "Steps": { + "items": { + "$ref": "#/definitions/StepConfig" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VisibleToAllUsers": { + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/MasterPublicDNS" + ], + "required": [ + "Instances", + "ServiceRole", + "JobFlowRole", + "Name" + ], + "typeName": "AWS::EMR::Cluster" +} diff --git a/schema/aws-emr-instancefleetconfig.json b/schema/aws-emr-instancefleetconfig.json index 66a2b10..66a1f60 100644 --- a/schema/aws-emr-instancefleetconfig.json +++ b/schema/aws-emr-instancefleetconfig.json @@ -1,211 +1,211 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/InstanceTypeConfigs", - "/properties/LaunchSpecifications", - "/properties/ClusterId", - "/properties/InstanceFleetType" - ], - "definitions": { - "Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "integer" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/EbsBlockDeviceConfig" - }, - "type": "array", - "uniqueItems": true - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "InstanceFleetProvisioningSpecifications": { - "additionalProperties": false, - "properties": { - "OnDemandSpecification": { - "$ref": "#/definitions/OnDemandProvisioningSpecification" - }, - "SpotSpecification": { - "$ref": "#/definitions/SpotProvisioningSpecification" - } - }, - "type": "object" - }, - "InstanceTypeConfig": { - "additionalProperties": false, - "properties": { - "BidPrice": { - "type": "string" - }, - "BidPriceAsPercentageOfOnDemandPrice": { - "type": "number" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - }, - "CustomAmiId": { - "type": "string" - }, - "EbsConfiguration": { - "$ref": "#/definitions/EbsConfiguration" - }, - "InstanceType": { - "type": "string" - }, - "WeightedCapacity": { - "type": "integer" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "OnDemandProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - } - }, - "required": [ - "AllocationStrategy" - ], - "type": "object" - }, - "SpotProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BlockDurationMinutes": { - "type": "integer" - }, - "TimeoutAction": { - "type": "string" - }, - "TimeoutDurationMinutes": { - "type": "integer" - } - }, - "required": [ - "TimeoutDurationMinutes", - "TimeoutAction" - ], - "type": "object" - }, - "VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "integer" - }, - "SizeInGB": { - "type": "integer" - }, - "Throughput": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EMR::InstanceFleetConfig", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ClusterId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InstanceFleetType": { - "type": "string" - }, - "InstanceTypeConfigs": { - "items": { - "$ref": "#/definitions/InstanceTypeConfig" - }, - "type": "array", - "uniqueItems": true - }, - "LaunchSpecifications": { - "$ref": "#/definitions/InstanceFleetProvisioningSpecifications" - }, - "Name": { - "type": "string" - }, - "TargetOnDemandCapacity": { - "type": "integer" - }, - "TargetSpotCapacity": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "InstanceFleetType", - "ClusterId" - ], - "typeName": "AWS::EMR::InstanceFleetConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/InstanceTypeConfigs", + "/properties/LaunchSpecifications", + "/properties/ClusterId", + "/properties/InstanceFleetType" + ], + "definitions": { + "Configuration": { + "additionalProperties": false, + "properties": { + "Classification": { + "type": "string" + }, + "ConfigurationProperties": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EbsBlockDeviceConfig": { + "additionalProperties": false, + "properties": { + "VolumeSpecification": { + "$ref": "#/definitions/VolumeSpecification" + }, + "VolumesPerInstance": { + "type": "integer" + } + }, + "required": [ + "VolumeSpecification" + ], + "type": "object" + }, + "EbsConfiguration": { + "additionalProperties": false, + "properties": { + "EbsBlockDeviceConfigs": { + "items": { + "$ref": "#/definitions/EbsBlockDeviceConfig" + }, + "type": "array", + "uniqueItems": true + }, + "EbsOptimized": { + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceFleetProvisioningSpecifications": { + "additionalProperties": false, + "properties": { + "OnDemandSpecification": { + "$ref": "#/definitions/OnDemandProvisioningSpecification" + }, + "SpotSpecification": { + "$ref": "#/definitions/SpotProvisioningSpecification" + } + }, + "type": "object" + }, + "InstanceTypeConfig": { + "additionalProperties": false, + "properties": { + "BidPrice": { + "type": "string" + }, + "BidPriceAsPercentageOfOnDemandPrice": { + "type": "number" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + }, + "CustomAmiId": { + "type": "string" + }, + "EbsConfiguration": { + "$ref": "#/definitions/EbsConfiguration" + }, + "InstanceType": { + "type": "string" + }, + "WeightedCapacity": { + "type": "integer" + } + }, + "required": [ + "InstanceType" + ], + "type": "object" + }, + "OnDemandProvisioningSpecification": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + } + }, + "required": [ + "AllocationStrategy" + ], + "type": "object" + }, + "SpotProvisioningSpecification": { + "additionalProperties": false, + "properties": { + "AllocationStrategy": { + "type": "string" + }, + "BlockDurationMinutes": { + "type": "integer" + }, + "TimeoutAction": { + "type": "string" + }, + "TimeoutDurationMinutes": { + "type": "integer" + } + }, + "required": [ + "TimeoutDurationMinutes", + "TimeoutAction" + ], + "type": "object" + }, + "VolumeSpecification": { + "additionalProperties": false, + "properties": { + "Iops": { + "type": "integer" + }, + "SizeInGB": { + "type": "integer" + }, + "Throughput": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "required": [ + "SizeInGB", + "VolumeType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EMR::InstanceFleetConfig", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ClusterId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InstanceFleetType": { + "type": "string" + }, + "InstanceTypeConfigs": { + "items": { + "$ref": "#/definitions/InstanceTypeConfig" + }, + "type": "array", + "uniqueItems": true + }, + "LaunchSpecifications": { + "$ref": "#/definitions/InstanceFleetProvisioningSpecifications" + }, + "Name": { + "type": "string" + }, + "TargetOnDemandCapacity": { + "type": "integer" + }, + "TargetSpotCapacity": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "InstanceFleetType", + "ClusterId" + ], + "typeName": "AWS::EMR::InstanceFleetConfig" +} diff --git a/schema/aws-emr-instancegroupconfig.json b/schema/aws-emr-instancegroupconfig.json index b53a8d1..87e5f2a 100644 --- a/schema/aws-emr-instancegroupconfig.json +++ b/schema/aws-emr-instancegroupconfig.json @@ -1,312 +1,312 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceRole", - "/properties/JobFlowId", - "/properties/Name", - "/properties/InstanceType", - "/properties/CustomAmiId", - "/properties/Configurations", - "/properties/EbsConfiguration", - "/properties/Market", - "/properties/BidPrice" - ], - "definitions": { - "AutoScalingPolicy": { - "additionalProperties": false, - "properties": { - "Constraints": { - "$ref": "#/definitions/ScalingConstraints" - }, - "Rules": { - "items": { - "$ref": "#/definitions/ScalingRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Constraints", - "Rules" - ], - "type": "object" - }, - "CloudWatchAlarmDefinition": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "type": "array", - "uniqueItems": true - }, - "EvaluationPeriods": { - "type": "integer" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Period": { - "type": "integer" - }, - "Statistic": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "ComparisonOperator", - "Period", - "Threshold" - ], - "type": "object" - }, - "Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "integer" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/EbsBlockDeviceConfig" - }, - "type": "array", - "uniqueItems": true - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ScalingAction": { - "additionalProperties": false, - "properties": { - "Market": { - "type": "string" - }, - "SimpleScalingPolicyConfiguration": { - "$ref": "#/definitions/SimpleScalingPolicyConfiguration" - } - }, - "required": [ - "SimpleScalingPolicyConfiguration" - ], - "type": "object" - }, - "ScalingConstraints": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "integer" - }, - "MinCapacity": { - "type": "integer" - } - }, - "required": [ - "MinCapacity", - "MaxCapacity" - ], - "type": "object" - }, - "ScalingRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/ScalingAction" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Trigger": { - "$ref": "#/definitions/ScalingTrigger" - } - }, - "required": [ - "Action", - "Trigger", - "Name" - ], - "type": "object" - }, - "ScalingTrigger": { - "additionalProperties": false, - "properties": { - "CloudWatchAlarmDefinition": { - "$ref": "#/definitions/CloudWatchAlarmDefinition" - } - }, - "required": [ - "CloudWatchAlarmDefinition" - ], - "type": "object" - }, - "SimpleScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "CoolDown": { - "type": "integer" - }, - "ScalingAdjustment": { - "type": "integer" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "integer" - }, - "SizeInGB": { - "type": "integer" - }, - "Throughput": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EMR::InstanceGroupConfig", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AutoScalingPolicy": { - "$ref": "#/definitions/AutoScalingPolicy" - }, - "BidPrice": { - "type": "string" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/Configuration" - }, - "type": "array", - "uniqueItems": true - }, - "CustomAmiId": { - "type": "string" - }, - "EbsConfiguration": { - "$ref": "#/definitions/EbsConfiguration" - }, - "Id": { - "type": "string" - }, - "InstanceCount": { - "type": "integer" - }, - "InstanceRole": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "JobFlowId": { - "type": "string" - }, - "Market": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "JobFlowId", - "InstanceCount", - "InstanceRole", - "InstanceType" - ], - "typeName": "AWS::EMR::InstanceGroupConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceRole", + "/properties/JobFlowId", + "/properties/Name", + "/properties/InstanceType", + "/properties/CustomAmiId", + "/properties/Configurations", + "/properties/EbsConfiguration", + "/properties/Market", + "/properties/BidPrice" + ], + "definitions": { + "AutoScalingPolicy": { + "additionalProperties": false, + "properties": { + "Constraints": { + "$ref": "#/definitions/ScalingConstraints" + }, + "Rules": { + "items": { + "$ref": "#/definitions/ScalingRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Constraints", + "Rules" + ], + "type": "object" + }, + "CloudWatchAlarmDefinition": { + "additionalProperties": false, + "properties": { + "ComparisonOperator": { + "type": "string" + }, + "Dimensions": { + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "type": "array", + "uniqueItems": true + }, + "EvaluationPeriods": { + "type": "integer" + }, + "MetricName": { + "type": "string" + }, + "Namespace": { + "type": "string" + }, + "Period": { + "type": "integer" + }, + "Statistic": { + "type": "string" + }, + "Threshold": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "MetricName", + "ComparisonOperator", + "Period", + "Threshold" + ], + "type": "object" + }, + "Configuration": { + "additionalProperties": false, + "properties": { + "Classification": { + "type": "string" + }, + "ConfigurationProperties": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "EbsBlockDeviceConfig": { + "additionalProperties": false, + "properties": { + "VolumeSpecification": { + "$ref": "#/definitions/VolumeSpecification" + }, + "VolumesPerInstance": { + "type": "integer" + } + }, + "required": [ + "VolumeSpecification" + ], + "type": "object" + }, + "EbsConfiguration": { + "additionalProperties": false, + "properties": { + "EbsBlockDeviceConfigs": { + "items": { + "$ref": "#/definitions/EbsBlockDeviceConfig" + }, + "type": "array", + "uniqueItems": true + }, + "EbsOptimized": { + "type": "boolean" + } + }, + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ScalingAction": { + "additionalProperties": false, + "properties": { + "Market": { + "type": "string" + }, + "SimpleScalingPolicyConfiguration": { + "$ref": "#/definitions/SimpleScalingPolicyConfiguration" + } + }, + "required": [ + "SimpleScalingPolicyConfiguration" + ], + "type": "object" + }, + "ScalingConstraints": { + "additionalProperties": false, + "properties": { + "MaxCapacity": { + "type": "integer" + }, + "MinCapacity": { + "type": "integer" + } + }, + "required": [ + "MinCapacity", + "MaxCapacity" + ], + "type": "object" + }, + "ScalingRule": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/ScalingAction" + }, + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Trigger": { + "$ref": "#/definitions/ScalingTrigger" + } + }, + "required": [ + "Action", + "Trigger", + "Name" + ], + "type": "object" + }, + "ScalingTrigger": { + "additionalProperties": false, + "properties": { + "CloudWatchAlarmDefinition": { + "$ref": "#/definitions/CloudWatchAlarmDefinition" + } + }, + "required": [ + "CloudWatchAlarmDefinition" + ], + "type": "object" + }, + "SimpleScalingPolicyConfiguration": { + "additionalProperties": false, + "properties": { + "AdjustmentType": { + "type": "string" + }, + "CoolDown": { + "type": "integer" + }, + "ScalingAdjustment": { + "type": "integer" + } + }, + "required": [ + "ScalingAdjustment" + ], + "type": "object" + }, + "VolumeSpecification": { + "additionalProperties": false, + "properties": { + "Iops": { + "type": "integer" + }, + "SizeInGB": { + "type": "integer" + }, + "Throughput": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "required": [ + "SizeInGB", + "VolumeType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EMR::InstanceGroupConfig", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AutoScalingPolicy": { + "$ref": "#/definitions/AutoScalingPolicy" + }, + "BidPrice": { + "type": "string" + }, + "Configurations": { + "items": { + "$ref": "#/definitions/Configuration" + }, + "type": "array", + "uniqueItems": true + }, + "CustomAmiId": { + "type": "string" + }, + "EbsConfiguration": { + "$ref": "#/definitions/EbsConfiguration" + }, + "Id": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceRole": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "JobFlowId": { + "type": "string" + }, + "Market": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "JobFlowId", + "InstanceCount", + "InstanceRole", + "InstanceType" + ], + "typeName": "AWS::EMR::InstanceGroupConfig" +} diff --git a/schema/aws-emr-securityconfiguration.json b/schema/aws-emr-securityconfiguration.json index dc7242c..ba17eea 100644 --- a/schema/aws-emr-securityconfiguration.json +++ b/schema/aws-emr-securityconfiguration.json @@ -1,54 +1,54 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/SecurityConfiguration" - ], - "description": "Use a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.", - "handlers": { - "create": { - "permissions": [ - "elasticmapreduce:CreateSecurityConfiguration", - "elasticmapreduce:DescribeSecurityConfiguration" - ] - }, - "delete": { - "permissions": [ - "elasticmapreduce:DeleteSecurityConfiguration" - ] - }, - "list": { - "permissions": [ - "elasticmapreduce:ListSecurityConfigurations" - ] - }, - "read": { - "permissions": [ - "elasticmapreduce:DescribeSecurityConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Name": { - "description": "The name of the security configuration.", - "type": "string" - }, - "SecurityConfiguration": { - "description": "The security configuration details in JSON format.", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "SecurityConfiguration" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::EMR::SecurityConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/SecurityConfiguration" + ], + "description": "Use a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.", + "handlers": { + "create": { + "permissions": [ + "elasticmapreduce:CreateSecurityConfiguration", + "elasticmapreduce:DescribeSecurityConfiguration" + ] + }, + "delete": { + "permissions": [ + "elasticmapreduce:DeleteSecurityConfiguration" + ] + }, + "list": { + "permissions": [ + "elasticmapreduce:ListSecurityConfigurations" + ] + }, + "read": { + "permissions": [ + "elasticmapreduce:DescribeSecurityConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Name": { + "description": "The name of the security configuration.", + "type": "string" + }, + "SecurityConfiguration": { + "description": "The security configuration details in JSON format.", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "SecurityConfiguration" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::EMR::SecurityConfiguration" +} diff --git a/schema/aws-emr-step.json b/schema/aws-emr-step.json index 6d316e7..a1a01b6 100644 --- a/schema/aws-emr-step.json +++ b/schema/aws-emr-step.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobFlowId", - "/properties/HadoopJarStep", - "/properties/Name", - "/properties/ActionOnFailure" - ], - "definitions": { - "HadoopJarStepConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Jar": { - "type": "string" - }, - "MainClass": { - "type": "string" - }, - "StepProperties": { - "items": { - "$ref": "#/definitions/KeyValue" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Jar" - ], - "type": "object" - }, - "KeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Schema for AWS::EMR::Step", - "handlers": { - "create": { - "permissions": [ - "emr:AddJobFlowSteps" - ] - }, - "delete": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ActionOnFailure": { - "description": "This specifies what action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE.", - "type": "string" - }, - "HadoopJarStep": { - "$ref": "#/definitions/HadoopJarStepConfig", - "description": "The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps." - }, - "Id": { - "description": "ID generated by service", - "type": "string" - }, - "JobFlowId": { - "description": "A string that uniquely identifies the cluster (job flow).", - "type": "string" - }, - "Name": { - "description": "The name of the cluster step.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "JobFlowId", - "HadoopJarStep", - "ActionOnFailure", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::EMR::Step" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/JobFlowId", + "/properties/HadoopJarStep", + "/properties/Name", + "/properties/ActionOnFailure" + ], + "definitions": { + "HadoopJarStepConfig": { + "additionalProperties": false, + "properties": { + "Args": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Jar": { + "type": "string" + }, + "MainClass": { + "type": "string" + }, + "StepProperties": { + "items": { + "$ref": "#/definitions/KeyValue" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Jar" + ], + "type": "object" + }, + "KeyValue": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Schema for AWS::EMR::Step", + "handlers": { + "create": { + "permissions": [ + "emr:AddJobFlowSteps" + ] + }, + "delete": { + "permissions": [] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ActionOnFailure": { + "description": "This specifies what action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE.", + "type": "string" + }, + "HadoopJarStep": { + "$ref": "#/definitions/HadoopJarStepConfig", + "description": "The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps." + }, + "Id": { + "description": "ID generated by service", + "type": "string" + }, + "JobFlowId": { + "description": "A string that uniquely identifies the cluster (job flow).", + "type": "string" + }, + "Name": { + "description": "The name of the cluster step.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "JobFlowId", + "HadoopJarStep", + "ActionOnFailure", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::EMR::Step" +} diff --git a/schema/aws-emr-studio.json b/schema/aws-emr-studio.json index 2a0f8b3..af9c689 100644 --- a/schema/aws-emr-studio.json +++ b/schema/aws-emr-studio.json @@ -1,236 +1,236 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AuthMode", - "/properties/EngineSecurityGroupId", - "/properties/ServiceRole", - "/properties/UserRole", - "/properties/VpcId", - "/properties/WorkspaceSecurityGroupId", - "/properties/TrustedIdentityPropagationEnabled", - "/properties/IdcUserAssignment", - "/properties/IdcInstanceArn", - "/properties/EncryptionKeyArn" - ], - "definitions": { - "Arn": { - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "SubnetId": { - "description": "Identifier of a subnet", - "pattern": "^(subnet-[a-f0-9]{13})|(subnet-[a-f0-9]{8})\\Z", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "An arbitrary set of tags (key-value pairs) for this EMR Studio.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "[a-zA-Z+-=._:/]+$", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "description": "Resource schema for AWS::EMR::Studio", - "documentationUrl": "https://docs.aws.amazon.com/emr/latest/APIReference/API_CreateStudio.html", - "handlers": { - "create": { - "permissions": [ - "elasticmapreduce:CreateStudio", - "elasticmapreduce:DescribeStudio", - "elasticmapreduce:AddTags", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "elasticmapreduce:DeleteStudio", - "elasticmapreduce:DescribeStudio", - "sso:DeleteManagedApplicationInstance" - ] - }, - "list": { - "permissions": [ - "elasticmapreduce:ListStudios" - ] - }, - "read": { - "permissions": [ - "elasticmapreduce:DescribeStudio", - "sso:GetManagedApplicationInstance" - ] - }, - "update": { - "permissions": [ - "elasticmapreduce:UpdateStudio", - "elasticmapreduce:DescribeStudio", - "elasticmapreduce:AddTags", - "elasticmapreduce:RemoveTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/StudioId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the EMR Studio." - }, - "AuthMode": { - "description": "Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.", - "enum": [ - "SSO", - "IAM" - ], - "type": "string" - }, - "DefaultS3Location": { - "description": "The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.", - "maxLength": 10280, - "minLength": 6, - "pattern": "^s3://.*", - "type": "string" - }, - "Description": { - "description": "A detailed description of the Studio.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "EncryptionKeyArn": { - "$ref": "#/definitions/Arn", - "description": "The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3." - }, - "EngineSecurityGroupId": { - "description": "The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.", - "maxLength": 256, - "minLength": 4, - "pattern": "^sg-[a-zA-Z0-9\\-._]+$", - "type": "string" - }, - "IdcInstanceArn": { - "description": "The ARN of the IAM Identity Center instance to create the Studio application.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "IdcUserAssignment": { - "description": "Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.", - "enum": [ - "REQUIRED", - "OPTIONAL" - ], - "type": "string" - }, - "IdpAuthUrl": { - "description": "Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.", - "maxLength": 4096, - "pattern": "^https://[0-9a-zA-Z]([-.\\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$", - "type": "string" - }, - "IdpRelayStateParameterName": { - "description": "The name of relay state parameter for external Identity Provider.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "A descriptive name for the Amazon EMR Studio.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9_-]+", - "type": "string" - }, - "ServiceRole": { - "$ref": "#/definitions/Arn", - "description": "The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services." - }, - "StudioId": { - "description": "The ID of the EMR Studio.", - "maxLength": 256, - "minLength": 4, - "pattern": "^es-[0-9A-Z]+", - "type": "string" - }, - "SubnetIds": { - "description": "A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.", - "items": { - "$ref": "#/definitions/SubnetId" - }, - "minItems": 1, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters." - }, - "TrustedIdentityPropagationEnabled": { - "description": "A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.", - "type": "boolean" - }, - "Url": { - "description": "The unique Studio access URL.", - "maxLength": 4096, - "pattern": "^https://[0-9a-zA-Z]([-.\\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$", - "type": "string" - }, - "UserRole": { - "$ref": "#/definitions/Arn", - "description": "The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies." - }, - "VpcId": { - "description": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.", - "pattern": "^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$", - "type": "string" - }, - "WorkspaceSecurityGroupId": { - "description": "The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.", - "pattern": "^sg-[a-zA-Z0-9\\-._]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/StudioId", - "/properties/Arn", - "/properties/Url" - ], - "required": [ - "AuthMode", - "EngineSecurityGroupId", - "Name", - "ServiceRole", - "SubnetIds", - "VpcId", - "WorkspaceSecurityGroupId", - "DefaultS3Location" - ], - "typeName": "AWS::EMR::Studio" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AuthMode", + "/properties/EngineSecurityGroupId", + "/properties/ServiceRole", + "/properties/UserRole", + "/properties/VpcId", + "/properties/WorkspaceSecurityGroupId", + "/properties/TrustedIdentityPropagationEnabled", + "/properties/IdcUserAssignment", + "/properties/IdcInstanceArn", + "/properties/EncryptionKeyArn" + ], + "definitions": { + "Arn": { + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "SubnetId": { + "description": "Identifier of a subnet", + "pattern": "^(subnet-[a-f0-9]{13})|(subnet-[a-f0-9]{8})\\Z", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "An arbitrary set of tags (key-value pairs) for this EMR Studio.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "[a-zA-Z+-=._:/]+$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "description": "Resource schema for AWS::EMR::Studio", + "documentationUrl": "https://docs.aws.amazon.com/emr/latest/APIReference/API_CreateStudio.html", + "handlers": { + "create": { + "permissions": [ + "elasticmapreduce:CreateStudio", + "elasticmapreduce:DescribeStudio", + "elasticmapreduce:AddTags", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "elasticmapreduce:DeleteStudio", + "elasticmapreduce:DescribeStudio", + "sso:DeleteManagedApplicationInstance" + ] + }, + "list": { + "permissions": [ + "elasticmapreduce:ListStudios" + ] + }, + "read": { + "permissions": [ + "elasticmapreduce:DescribeStudio", + "sso:GetManagedApplicationInstance" + ] + }, + "update": { + "permissions": [ + "elasticmapreduce:UpdateStudio", + "elasticmapreduce:DescribeStudio", + "elasticmapreduce:AddTags", + "elasticmapreduce:RemoveTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/StudioId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the EMR Studio." + }, + "AuthMode": { + "description": "Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.", + "enum": [ + "SSO", + "IAM" + ], + "type": "string" + }, + "DefaultS3Location": { + "description": "The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.", + "maxLength": 10280, + "minLength": 6, + "pattern": "^s3://.*", + "type": "string" + }, + "Description": { + "description": "A detailed description of the Studio.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "EncryptionKeyArn": { + "$ref": "#/definitions/Arn", + "description": "The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3." + }, + "EngineSecurityGroupId": { + "description": "The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.", + "maxLength": 256, + "minLength": 4, + "pattern": "^sg-[a-zA-Z0-9\\-._]+$", + "type": "string" + }, + "IdcInstanceArn": { + "description": "The ARN of the IAM Identity Center instance to create the Studio application.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "IdcUserAssignment": { + "description": "Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.", + "enum": [ + "REQUIRED", + "OPTIONAL" + ], + "type": "string" + }, + "IdpAuthUrl": { + "description": "Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.", + "maxLength": 4096, + "pattern": "^https://[0-9a-zA-Z]([-.\\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$", + "type": "string" + }, + "IdpRelayStateParameterName": { + "description": "The name of relay state parameter for external Identity Provider.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "A descriptive name for the Amazon EMR Studio.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9_-]+", + "type": "string" + }, + "ServiceRole": { + "$ref": "#/definitions/Arn", + "description": "The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services." + }, + "StudioId": { + "description": "The ID of the EMR Studio.", + "maxLength": 256, + "minLength": 4, + "pattern": "^es-[0-9A-Z]+", + "type": "string" + }, + "SubnetIds": { + "description": "A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.", + "items": { + "$ref": "#/definitions/SubnetId" + }, + "minItems": 1, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters." + }, + "TrustedIdentityPropagationEnabled": { + "description": "A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.", + "type": "boolean" + }, + "Url": { + "description": "The unique Studio access URL.", + "maxLength": 4096, + "pattern": "^https://[0-9a-zA-Z]([-.\\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$", + "type": "string" + }, + "UserRole": { + "$ref": "#/definitions/Arn", + "description": "The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies." + }, + "VpcId": { + "description": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.", + "pattern": "^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$", + "type": "string" + }, + "WorkspaceSecurityGroupId": { + "description": "The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.", + "pattern": "^sg-[a-zA-Z0-9\\-._]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StudioId", + "/properties/Arn", + "/properties/Url" + ], + "required": [ + "AuthMode", + "EngineSecurityGroupId", + "Name", + "ServiceRole", + "SubnetIds", + "VpcId", + "WorkspaceSecurityGroupId", + "DefaultS3Location" + ], + "typeName": "AWS::EMR::Studio" +} diff --git a/schema/aws-emr-studiosessionmapping.json b/schema/aws-emr-studiosessionmapping.json index c9a52ab..a29a115 100644 --- a/schema/aws-emr-studiosessionmapping.json +++ b/schema/aws-emr-studiosessionmapping.json @@ -1,114 +1,114 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StudioId", - "/properties/IdentityType", - "/properties/IdentityName" - ], - "definitions": { - "IamPolicyArn": { - "pattern": "^arn:aws(-(cn|us-gov))?:iam::([0-9]{12})?:policy\\/[^.]+$", - "type": "string" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "documentationUrl": "https://docs.aws.amazon.com/cli/latest/reference/emr/create-studio-session-mapping.html", - "handlers": { - "create": { - "permissions": [ - "elasticmapreduce:CreateStudioSessionMapping", - "sso-directory:SearchUsers", - "sso-directory:SearchGroups", - "sso-directory:DescribeUser", - "sso-directory:DescribeGroup", - "sso:GetManagedApplicationInstance", - "sso:ListDirectoryAssociations", - "sso:GetProfile", - "sso:ListProfiles", - "sso:AssociateProfile" - ] - }, - "delete": { - "permissions": [ - "elasticmapreduce:GetStudioSessionMapping", - "elasticmapreduce:DeleteStudioSessionMapping", - "sso-directory:SearchUsers", - "sso-directory:SearchGroups", - "sso-directory:DescribeUser", - "sso-directory:DescribeGroup", - "sso:GetManagedApplicationInstance", - "sso:DescribeInstance", - "sso:ListDirectoryAssociations", - "sso:GetProfile", - "sso:ListProfiles", - "sso:DisassociateProfile" - ] - }, - "list": { - "permissions": [ - "elasticmapreduce:ListStudioSessionMappings" - ] - }, - "read": { - "permissions": [ - "elasticmapreduce:GetStudioSessionMapping", - "sso-directory:SearchUsers", - "sso-directory:SearchGroups", - "sso-directory:DescribeUser", - "sso-directory:DescribeGroup", - "sso:GetManagedApplicationInstance", - "sso:DescribeInstance" - ] - }, - "update": { - "permissions": [ - "elasticmapreduce:GetStudioSessionMapping", - "elasticmapreduce:UpdateStudioSessionMapping", - "sso-directory:SearchUsers", - "sso-directory:SearchGroups", - "sso-directory:DescribeUser", - "sso-directory:DescribeGroup", - "sso:GetManagedApplicationInstance", - "sso:DescribeInstance" - ] - } - }, - "primaryIdentifier": [ - "/properties/StudioId", - "/properties/IdentityType", - "/properties/IdentityName" - ], - "properties": { - "IdentityName": { - "description": "The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.", - "type": "string" - }, - "IdentityType": { - "description": "Specifies whether the identity to map to the Studio is a user or a group.", - "enum": [ - "USER", - "GROUP" - ], - "type": "string" - }, - "SessionPolicyArn": { - "$ref": "#/definitions/IamPolicyArn", - "description": "The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles." - }, - "StudioId": { - "description": "The ID of the Amazon EMR Studio to which the user or group will be mapped.", - "maxLength": 256, - "minLength": 4, - "pattern": "^es-[0-9A-Z]+", - "type": "string" - } - }, - "required": [ - "StudioId", - "IdentityName", - "IdentityType", - "SessionPolicyArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::EMR::StudioSessionMapping" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StudioId", + "/properties/IdentityType", + "/properties/IdentityName" + ], + "definitions": { + "IamPolicyArn": { + "pattern": "^arn:aws(-(cn|us-gov))?:iam::([0-9]{12})?:policy\\/[^.]+$", + "type": "string" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "documentationUrl": "https://docs.aws.amazon.com/cli/latest/reference/emr/create-studio-session-mapping.html", + "handlers": { + "create": { + "permissions": [ + "elasticmapreduce:CreateStudioSessionMapping", + "sso-directory:SearchUsers", + "sso-directory:SearchGroups", + "sso-directory:DescribeUser", + "sso-directory:DescribeGroup", + "sso:GetManagedApplicationInstance", + "sso:ListDirectoryAssociations", + "sso:GetProfile", + "sso:ListProfiles", + "sso:AssociateProfile" + ] + }, + "delete": { + "permissions": [ + "elasticmapreduce:GetStudioSessionMapping", + "elasticmapreduce:DeleteStudioSessionMapping", + "sso-directory:SearchUsers", + "sso-directory:SearchGroups", + "sso-directory:DescribeUser", + "sso-directory:DescribeGroup", + "sso:GetManagedApplicationInstance", + "sso:DescribeInstance", + "sso:ListDirectoryAssociations", + "sso:GetProfile", + "sso:ListProfiles", + "sso:DisassociateProfile" + ] + }, + "list": { + "permissions": [ + "elasticmapreduce:ListStudioSessionMappings" + ] + }, + "read": { + "permissions": [ + "elasticmapreduce:GetStudioSessionMapping", + "sso-directory:SearchUsers", + "sso-directory:SearchGroups", + "sso-directory:DescribeUser", + "sso-directory:DescribeGroup", + "sso:GetManagedApplicationInstance", + "sso:DescribeInstance" + ] + }, + "update": { + "permissions": [ + "elasticmapreduce:GetStudioSessionMapping", + "elasticmapreduce:UpdateStudioSessionMapping", + "sso-directory:SearchUsers", + "sso-directory:SearchGroups", + "sso-directory:DescribeUser", + "sso-directory:DescribeGroup", + "sso:GetManagedApplicationInstance", + "sso:DescribeInstance" + ] + } + }, + "primaryIdentifier": [ + "/properties/StudioId", + "/properties/IdentityType", + "/properties/IdentityName" + ], + "properties": { + "IdentityName": { + "description": "The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.", + "type": "string" + }, + "IdentityType": { + "description": "Specifies whether the identity to map to the Studio is a user or a group.", + "enum": [ + "USER", + "GROUP" + ], + "type": "string" + }, + "SessionPolicyArn": { + "$ref": "#/definitions/IamPolicyArn", + "description": "The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles." + }, + "StudioId": { + "description": "The ID of the Amazon EMR Studio to which the user or group will be mapped.", + "maxLength": 256, + "minLength": 4, + "pattern": "^es-[0-9A-Z]+", + "type": "string" + } + }, + "required": [ + "StudioId", + "IdentityName", + "IdentityType", + "SessionPolicyArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::EMR::StudioSessionMapping" +} diff --git a/schema/aws-emr-walworkspace.json b/schema/aws-emr-walworkspace.json index c7875f3..3ece8ca 100644 --- a/schema/aws-emr-walworkspace.json +++ b/schema/aws-emr-walworkspace.json @@ -1,93 +1,93 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WALWorkspaceName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::EMR::WALWorkspace Type", - "handlers": { - "create": { - "permissions": [ - "emrwal:CreateWorkspace", - "emrwal:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "emrwal:DeleteWorkspace" - ] - }, - "list": { - "permissions": [ - "emrwal:ListWorkspaces" - ] - }, - "read": { - "permissions": [ - "emrwal:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "emrwal:TagResource", - "emrwal:UntagResource", - "emrwal:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/WALWorkspaceName" - ], - "properties": { - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "WALWorkspaceName": { - "description": "The name of the emrwal container", - "maxLength": 32, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-emrwal", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EMR::WALWorkspace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WALWorkspaceName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::EMR::WALWorkspace Type", + "handlers": { + "create": { + "permissions": [ + "emrwal:CreateWorkspace", + "emrwal:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "emrwal:DeleteWorkspace" + ] + }, + "list": { + "permissions": [ + "emrwal:ListWorkspaces" + ] + }, + "read": { + "permissions": [ + "emrwal:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "emrwal:TagResource", + "emrwal:UntagResource", + "emrwal:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/WALWorkspaceName" + ], + "properties": { + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WALWorkspaceName": { + "description": "The name of the emrwal container", + "maxLength": 32, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-emrwal", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EMR::WALWorkspace" +} diff --git a/schema/aws-emrcontainers-virtualcluster.json b/schema/aws-emrcontainers-virtualcluster.json index 279398f..04e9c57 100644 --- a/schema/aws-emrcontainers-virtualcluster.json +++ b/schema/aws-emrcontainers-virtualcluster.json @@ -1,157 +1,157 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContainerProvider", - "/properties/Name" - ], - "definitions": { - "ContainerInfo": { - "additionalProperties": false, - "properties": { - "EksInfo": { - "$ref": "#/definitions/EksInfo" - } - }, - "required": [ - "EksInfo" - ], - "type": "object" - }, - "ContainerProvider": { - "additionalProperties": false, - "properties": { - "Id": { - "description": "The ID of the container cluster", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*", - "type": "string" - }, - "Info": { - "$ref": "#/definitions/ContainerInfo" - }, - "Type": { - "description": "The type of the container provider", - "type": "string" - } - }, - "required": [ - "Type", - "Id", - "Info" - ], - "type": "object" - }, - "EksInfo": { - "additionalProperties": false, - "properties": { - "Namespace": { - "maxLength": 63, - "minLength": 1, - "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?", - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "An arbitrary set of tags (key-value pairs) for this virtual cluster.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Schema of AWS::EMRContainers::VirtualCluster Type", - "handlers": { - "create": { - "permissions": [ - "emr-containers:CreateVirtualCluster", - "emr-containers:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "emr-containers:DeleteVirtualCluster" - ] - }, - "list": { - "permissions": [ - "emr-containers:ListVirtualClusters" - ] - }, - "read": { - "permissions": [ - "emr-containers:DescribeVirtualCluster" - ] - }, - "update": { - "permissions": [ - "emr-containers:DescribeVirtualCluster", - "emr-containers:ListTagsForResource", - "emr-containers:TagResource", - "emr-containers:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ContainerProvider": { - "$ref": "#/definitions/ContainerProvider", - "description": "Container provider of the virtual cluster." - }, - "Id": { - "description": "Id of the virtual cluster.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of the virtual cluster.", - "maxLength": 64, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this virtual cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name", - "ContainerProvider" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::EMRContainers::VirtualCluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContainerProvider", + "/properties/Name" + ], + "definitions": { + "ContainerInfo": { + "additionalProperties": false, + "properties": { + "EksInfo": { + "$ref": "#/definitions/EksInfo" + } + }, + "required": [ + "EksInfo" + ], + "type": "object" + }, + "ContainerProvider": { + "additionalProperties": false, + "properties": { + "Id": { + "description": "The ID of the container cluster", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*", + "type": "string" + }, + "Info": { + "$ref": "#/definitions/ContainerInfo" + }, + "Type": { + "description": "The type of the container provider", + "type": "string" + } + }, + "required": [ + "Type", + "Id", + "Info" + ], + "type": "object" + }, + "EksInfo": { + "additionalProperties": false, + "properties": { + "Namespace": { + "maxLength": 63, + "minLength": 1, + "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?", + "type": "string" + } + }, + "required": [ + "Namespace" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "An arbitrary set of tags (key-value pairs) for this virtual cluster.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Schema of AWS::EMRContainers::VirtualCluster Type", + "handlers": { + "create": { + "permissions": [ + "emr-containers:CreateVirtualCluster", + "emr-containers:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "emr-containers:DeleteVirtualCluster" + ] + }, + "list": { + "permissions": [ + "emr-containers:ListVirtualClusters" + ] + }, + "read": { + "permissions": [ + "emr-containers:DescribeVirtualCluster" + ] + }, + "update": { + "permissions": [ + "emr-containers:DescribeVirtualCluster", + "emr-containers:ListTagsForResource", + "emr-containers:TagResource", + "emr-containers:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ContainerProvider": { + "$ref": "#/definitions/ContainerProvider", + "description": "Container provider of the virtual cluster." + }, + "Id": { + "description": "Id of the virtual cluster.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of the virtual cluster.", + "maxLength": 64, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this virtual cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name", + "ContainerProvider" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::EMRContainers::VirtualCluster" +} diff --git a/schema/aws-emrserverless-application.json b/schema/aws-emrserverless-application.json index b0193a4..ddf34a6 100644 --- a/schema/aws-emrserverless-application.json +++ b/schema/aws-emrserverless-application.json @@ -1,667 +1,687 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/Architecture", - "/properties/ReleaseLabel", - "/properties/WorkerTypeSpecifications", - "/properties/MaximumCapacity", - "/properties/InitialCapacity", - "/properties/AutoStartConfiguration", - "/properties/AutoStopConfiguration", - "/properties/NetworkConfiguration", - "/properties/ImageConfiguration", - "/properties/MonitoringConfiguration", - "/properties/RuntimeConfiguration" - ], - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type" - ], - "definitions": { - "Architecture": { - "description": "The cpu architecture of an application.", - "enum": [ - "ARM64", - "X86_64" - ], - "type": "string" - }, - "AutoStartConfiguration": { - "additionalProperties": false, - "description": "Configuration for Auto Start of Application", - "properties": { - "Enabled": { - "default": true, - "description": "If set to true, the Application will automatically start. Defaults to true.", - "type": "boolean" - } - }, - "required": [], - "type": "object" - }, - "AutoStopConfiguration": { - "additionalProperties": false, - "description": "Configuration for Auto Stop of Application", - "properties": { - "Enabled": { - "default": true, - "description": "If set to true, the Application will automatically stop after being idle. Defaults to true.", - "type": "boolean" - }, - "IdleTimeoutMinutes": { - "description": "The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes.", - "type": "integer" - } - }, - "required": [], - "type": "object" - }, - "Classification": { - "maxLength": 1024, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "CloudWatchLoggingConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "default": false, - "description": "If set to false, CloudWatch logging will be turned off. Defaults to false.", - "type": "boolean" - }, - "EncryptionKeyArn": { - "$ref": "#/definitions/EncryptionKeyArn", - "description": "KMS key ARN to encrypt the logs stored in given CloudWatch log-group." - }, - "LogGroupName": { - "$ref": "#/definitions/LogGroupName", - "description": "Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless" - }, - "LogStreamNamePrefix": { - "$ref": "#/definitions/LogStreamNamePrefix", - "description": "Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group." - }, - "LogTypeMap": { - "description": "The specific log-streams which need to be uploaded to CloudWatch.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogTypeMapKeyValuePair" - }, - "type": "array", - "uniqueItems": true - } - } - }, - "ConfigurationList": { - "description": "Runtime configuration for batch and interactive JobRun.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigurationObject" - }, - "type": "array", - "uniqueItems": true - }, - "ConfigurationObject": { - "additionalProperties": false, - "description": "Configuration for a JobRun.", - "properties": { - "Classification": { - "$ref": "#/definitions/Classification", - "description": "String with a maximum length of 1024." - }, - "Configurations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigurationObject" - }, - "type": "array", - "uniqueItems": true - }, - "Properties": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z]+[-a-zA-Z0-9_.]*$": { - "$ref": "#/definitions/SensitivePropertiesMap" - } - }, - "type": "object" - } - }, - "required": [ - "Classification" - ], - "type": "object" - }, - "CpuSize": { - "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional.", - "maxLength": 15, - "minLength": 1, - "pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$", - "type": "string" - }, - "DiskSize": { - "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional", - "maxLength": 15, - "minLength": 1, - "pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$", - "type": "string" - }, - "DiskType": { - "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional", - "pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$", - "type": "string" - }, - "EncryptionKeyArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "ImageConfigurationInput": { - "additionalProperties": false, - "description": "The image configuration.", - "properties": { - "ImageUri": { - "description": "The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$", - "type": "string" - } - }, - "type": "object" - }, - "InitialCapacityConfig": { - "additionalProperties": false, - "properties": { - "WorkerConfiguration": { - "$ref": "#/definitions/WorkerConfiguration" - }, - "WorkerCount": { - "description": "Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped", - "format": "int64", - "maximum": 1000000, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "WorkerCount", - "WorkerConfiguration" - ], - "type": "object" - }, - "InitialCapacityConfigKeyValuePair": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "Worker type for an analytics framework.", - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/InitialCapacityConfig" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "InitialCapacityConfigMap": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InitialCapacityConfigKeyValuePair" - }, - "type": "array", - "uniqueItems": true - }, - "LogGroupName": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", - "type": "string" - }, - "LogStreamNamePrefix": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[^:*]*$", - "type": "string" - }, - "LogTypeList": { - "description": "List of Applicable values: [STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS]", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogTypeString" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "LogTypeMapKeyValuePair": { - "additionalProperties": false, - "properties": { - "Key": { - "$ref": "#/definitions/WorkerTypeString" - }, - "Value": { - "$ref": "#/definitions/LogTypeList" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "LogTypeString": { - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", - "type": "string" - }, - "ManagedPersistenceMonitoringConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "default": true, - "description": "If set to false, managed logging will be turned off. Defaults to true.", - "type": "boolean" - }, - "EncryptionKeyArn": { - "$ref": "#/definitions/EncryptionKeyArn", - "description": "KMS key ARN to encrypt the logs stored in managed persistence" - } - } - }, - "MaximumAllowedResources": { - "additionalProperties": false, - "properties": { - "Cpu": { - "$ref": "#/definitions/CpuSize", - "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." - }, - "Disk": { - "$ref": "#/definitions/DiskSize", - "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" - }, - "Memory": { - "$ref": "#/definitions/MemorySize", - "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." - } - }, - "required": [ - "Cpu", - "Memory" - ], - "type": "object" - }, - "MemorySize": { - "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional.", - "maxLength": 15, - "minLength": 1, - "pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$", - "type": "string" - }, - "MonitoringConfiguration": { - "additionalProperties": false, - "description": "Monitoring configuration for batch and interactive JobRun.", - "properties": { - "CloudWatchLoggingConfiguration": { - "$ref": "#/definitions/CloudWatchLoggingConfiguration", - "description": "CloudWatch logging configurations for a JobRun." - }, - "ManagedPersistenceMonitoringConfiguration": { - "$ref": "#/definitions/ManagedPersistenceMonitoringConfiguration", - "description": "Managed log persistence configurations for a JobRun." - }, - "S3MonitoringConfiguration": { - "$ref": "#/definitions/S3MonitoringConfiguration", - "description": "S3 monitoring configurations for a JobRun." - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "description": "The ID of the security groups in the VPC to which you want to connect your job or application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "description": "The ID of the subnets in the VPC to which you want to connect your job or application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetId" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [], - "type": "object" - }, - "S3MonitoringConfiguration": { - "additionalProperties": false, - "properties": { - "EncryptionKeyArn": { - "$ref": "#/definitions/EncryptionKeyArn", - "description": "KMS key ARN to encrypt the logs stored in given s3" - }, - "LogUri": { - "$ref": "#/definitions/UriString" - } - } - }, - "SecurityGroupId": { - "description": "Identifier of a security group", - "maxLength": 32, - "minLength": 1, - "pattern": "^[-0-9a-zA-Z]+", - "type": "string" - }, - "SensitivePropertiesKeyValuePair": { - "maxLength": 1024, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "SensitivePropertiesMap": { - "maxLength": 1024, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "SubnetId": { - "description": "Identifier of a subnet", - "maxLength": 32, - "minLength": 1, - "pattern": "^[-0-9a-zA-Z]+", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9 /_.:=+@-]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 /_.:=+@-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UriString": { - "maxLength": 10280, - "minLength": 1, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*", - "type": "string" - }, - "WorkerConfiguration": { - "additionalProperties": false, - "properties": { - "Cpu": { - "$ref": "#/definitions/CpuSize", - "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." - }, - "Disk": { - "$ref": "#/definitions/DiskSize", - "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" - }, - "DiskType": { - "$ref": "#/definitions/DiskType", - "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" - }, - "Memory": { - "$ref": "#/definitions/MemorySize", - "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." - } - }, - "required": [ - "Cpu", - "Memory" - ], - "type": "object" - }, - "WorkerTypeSpecificationInput": { - "additionalProperties": false, - "description": "The specifications for a worker type.", - "properties": { - "ImageConfiguration": { - "$ref": "#/definitions/ImageConfigurationInput" - } - }, - "type": "object" - }, - "WorkerTypeSpecificationInputMap": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z]+[-_]*[a-zA-Z]+$": { - "$ref": "#/definitions/WorkerTypeSpecificationInput" - } - }, - "type": "object" - }, - "WorkerTypeString": { - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", - "type": "string" - } - }, - "description": "Resource schema for AWS::EMRServerless::Application Type", - "handlers": { - "create": { - "permissions": [ - "kms:CreateKey", - "kms:CreateAlias", - "kms:DescribeKey", - "kms:EnableKey", - "kms:ListGrants", - "kms:ListAliases", - "kms:ListKeyPolicies", - "kms:ListKeys", - "kms:PutKeyPolicy", - "kms:UpdateKeyDescription", - "kms:UpdateAlias", - "kms:UpdatePrimaryRegion", - "kms:RevokeGrant", - "kms:DisableKey", - "kms:DisableKeyRotation", - "kms:GetKeyPolicy", - "kms:GetKeyRotationStatus", - "kms:DeleteAlias", - "kms:ScheduleKeyDeletion", - "kms:CancelKeyDeletion", - "kms:GenerateDataKey", - "kms:TagResource", - "kms:UntagResource", - "kms:Decrypt", - "emr-serverless:CreateApplication", - "emr-serverless:TagResource", - "emr-serverless:GetApplication", - "iam:CreateServiceLinkedRole", - "ec2:CreateNetworkInterface", - "ecr:BatchGetImage", - "ecr:DescribeImages", - "ecr:GetDownloadUrlForLayer" - ] - }, - "delete": { - "permissions": [ - "emr-serverless:DeleteApplication", - "emr-serverless:GetApplication" - ] - }, - "list": { - "permissions": [ - "emr-serverless:ListApplications" - ] - }, - "read": { - "permissions": [ - "emr-serverless:GetApplication" - ] - }, - "update": { - "permissions": [ - "emr-serverless:UpdateApplication", - "emr-serverless:TagResource", - "emr-serverless:UntagResource", - "emr-serverless:GetApplication", - "ec2:CreateNetworkInterface", - "ecr:BatchGetImage", - "ecr:DescribeImages", - "ecr:GetDownloadUrlForLayer", - "kms:CreateKey", - "kms:CreateAlias", - "kms:DescribeKey", - "kms:EnableKey", - "kms:ListGrants", - "kms:ListAliases", - "kms:ListKeyPolicies", - "kms:ListKeys", - "kms:PutKeyPolicy", - "kms:UpdateKeyDescription", - "kms:UpdateAlias", - "kms:UpdatePrimaryRegion", - "kms:RevokeGrant", - "kms:DisableKey", - "kms:DisableKeyRotation", - "kms:GetKeyPolicy", - "kms:GetKeyRotationStatus", - "kms:DeleteAlias", - "kms:ScheduleKeyDeletion", - "kms:CancelKeyDeletion", - "kms:GenerateDataKey", - "kms:TagResource", - "kms:UntagResource", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId" - ], - "properties": { - "ApplicationId": { - "description": "The ID of the EMR Serverless Application.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Architecture": { - "$ref": "#/definitions/Architecture" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the EMR Serverless Application.", - "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$", - "type": "string" - }, - "AutoStartConfiguration": { - "$ref": "#/definitions/AutoStartConfiguration", - "description": "Configuration for Auto Start of Application." - }, - "AutoStopConfiguration": { - "$ref": "#/definitions/AutoStopConfiguration", - "description": "Configuration for Auto Stop of Application." - }, - "ImageConfiguration": { - "$ref": "#/definitions/ImageConfigurationInput" - }, - "InitialCapacity": { - "$ref": "#/definitions/InitialCapacityConfigMap", - "description": "Initial capacity initialized when an Application is started." - }, - "MaximumCapacity": { - "$ref": "#/definitions/MaximumAllowedResources", - "description": "Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit." - }, - "MonitoringConfiguration": { - "$ref": "#/definitions/MonitoringConfiguration" - }, - "Name": { - "description": "User friendly Application name.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9._\\/#-]+$", - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration", - "description": "Network Configuration for customer VPC connectivity." - }, - "ReleaseLabel": { - "description": "EMR release label.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9._/-]+$", - "type": "string" - }, - "RuntimeConfiguration": { - "$ref": "#/definitions/ConfigurationList" - }, - "Tags": { - "description": "Tag map with key and value", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the application", - "type": "string" - }, - "WorkerTypeSpecifications": { - "$ref": "#/definitions/WorkerTypeSpecificationInputMap", - "description": "The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types." - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ApplicationId" - ], - "required": [ - "ReleaseLabel", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EMRServerless::Application" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/Architecture", + "/properties/ReleaseLabel", + "/properties/WorkerTypeSpecifications", + "/properties/MaximumCapacity", + "/properties/InitialCapacity", + "/properties/AutoStartConfiguration", + "/properties/AutoStopConfiguration", + "/properties/NetworkConfiguration", + "/properties/ImageConfiguration", + "/properties/MonitoringConfiguration", + "/properties/RuntimeConfiguration", + "/properties/InteractiveConfiguration" + ], + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type" + ], + "definitions": { + "Architecture": { + "description": "The cpu architecture of an application.", + "enum": [ + "ARM64", + "X86_64" + ], + "type": "string" + }, + "AutoStartConfiguration": { + "additionalProperties": false, + "description": "Configuration for Auto Start of Application", + "properties": { + "Enabled": { + "default": true, + "description": "If set to true, the Application will automatically start. Defaults to true.", + "type": "boolean" + } + }, + "required": [], + "type": "object" + }, + "AutoStopConfiguration": { + "additionalProperties": false, + "description": "Configuration for Auto Stop of Application", + "properties": { + "Enabled": { + "default": true, + "description": "If set to true, the Application will automatically stop after being idle. Defaults to true.", + "type": "boolean" + }, + "IdleTimeoutMinutes": { + "description": "The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes.", + "type": "integer" + } + }, + "required": [], + "type": "object" + }, + "Classification": { + "maxLength": 1024, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "CloudWatchLoggingConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "default": false, + "description": "If set to false, CloudWatch logging will be turned off. Defaults to false.", + "type": "boolean" + }, + "EncryptionKeyArn": { + "$ref": "#/definitions/EncryptionKeyArn", + "description": "KMS key ARN to encrypt the logs stored in given CloudWatch log-group." + }, + "LogGroupName": { + "$ref": "#/definitions/LogGroupName", + "description": "Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless" + }, + "LogStreamNamePrefix": { + "$ref": "#/definitions/LogStreamNamePrefix", + "description": "Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group." + }, + "LogTypeMap": { + "description": "The specific log-streams which need to be uploaded to CloudWatch.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogTypeMapKeyValuePair" + }, + "type": "array", + "uniqueItems": true + } + } + }, + "ConfigurationList": { + "description": "Runtime configuration for batch and interactive JobRun.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigurationObject" + }, + "type": "array", + "uniqueItems": true + }, + "ConfigurationObject": { + "additionalProperties": false, + "description": "Configuration for a JobRun.", + "properties": { + "Classification": { + "$ref": "#/definitions/Classification", + "description": "String with a maximum length of 1024." + }, + "Configurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigurationObject" + }, + "type": "array", + "uniqueItems": true + }, + "Properties": { + "additionalProperties": false, + "patternProperties": { + "^[a-zA-Z]+[-a-zA-Z0-9_.]*$": { + "$ref": "#/definitions/SensitivePropertiesMap" + } + }, + "type": "object" + } + }, + "required": [ + "Classification" + ], + "type": "object" + }, + "CpuSize": { + "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional.", + "maxLength": 15, + "minLength": 1, + "pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$", + "type": "string" + }, + "DiskSize": { + "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional", + "maxLength": 15, + "minLength": 1, + "pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$", + "type": "string" + }, + "DiskType": { + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional", + "pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$", + "type": "string" + }, + "EncryptionKeyArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "ImageConfigurationInput": { + "additionalProperties": false, + "description": "The image configuration.", + "properties": { + "ImageUri": { + "description": "The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$", + "type": "string" + } + }, + "type": "object" + }, + "InitialCapacityConfig": { + "additionalProperties": false, + "properties": { + "WorkerConfiguration": { + "$ref": "#/definitions/WorkerConfiguration" + }, + "WorkerCount": { + "description": "Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped", + "format": "int64", + "maximum": 1000000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "WorkerCount", + "WorkerConfiguration" + ], + "type": "object" + }, + "InitialCapacityConfigKeyValuePair": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "Worker type for an analytics framework.", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/InitialCapacityConfig" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "InitialCapacityConfigMap": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InitialCapacityConfigKeyValuePair" + }, + "type": "array", + "uniqueItems": true + }, + "InteractiveConfiguration": { + "additionalProperties": false, + "properties": { + "LivyEndpointEnabled": { + "default": false, + "description": "Enables an Apache Livy endpoint that you can connect to and run interactive jobs", + "type": "boolean" + }, + "StudioEnabled": { + "default": false, + "description": "Enabled you to connect an Application to Amazon EMR Studio to run interactive workloads in a notebook", + "type": "boolean" + } + }, + "type": "object" + }, + "LogGroupName": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + }, + "LogStreamNamePrefix": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[^:*]*$", + "type": "string" + }, + "LogTypeList": { + "description": "List of Applicable values: [STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS]", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogTypeString" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "LogTypeMapKeyValuePair": { + "additionalProperties": false, + "properties": { + "Key": { + "$ref": "#/definitions/WorkerTypeString" + }, + "Value": { + "$ref": "#/definitions/LogTypeList" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "LogTypeString": { + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", + "type": "string" + }, + "ManagedPersistenceMonitoringConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "default": true, + "description": "If set to false, managed logging will be turned off. Defaults to true.", + "type": "boolean" + }, + "EncryptionKeyArn": { + "$ref": "#/definitions/EncryptionKeyArn", + "description": "KMS key ARN to encrypt the logs stored in managed persistence" + } + } + }, + "MaximumAllowedResources": { + "additionalProperties": false, + "properties": { + "Cpu": { + "$ref": "#/definitions/CpuSize", + "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." + }, + "Disk": { + "$ref": "#/definitions/DiskSize", + "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" + }, + "Memory": { + "$ref": "#/definitions/MemorySize", + "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." + } + }, + "required": [ + "Cpu", + "Memory" + ], + "type": "object" + }, + "MemorySize": { + "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional.", + "maxLength": 15, + "minLength": 1, + "pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$", + "type": "string" + }, + "MonitoringConfiguration": { + "additionalProperties": false, + "description": "Monitoring configuration for batch and interactive JobRun.", + "properties": { + "CloudWatchLoggingConfiguration": { + "$ref": "#/definitions/CloudWatchLoggingConfiguration", + "description": "CloudWatch logging configurations for a JobRun." + }, + "ManagedPersistenceMonitoringConfiguration": { + "$ref": "#/definitions/ManagedPersistenceMonitoringConfiguration", + "description": "Managed log persistence configurations for a JobRun." + }, + "S3MonitoringConfiguration": { + "$ref": "#/definitions/S3MonitoringConfiguration", + "description": "S3 monitoring configurations for a JobRun." + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "description": "The ID of the security groups in the VPC to which you want to connect your job or application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "description": "The ID of the subnets in the VPC to which you want to connect your job or application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetId" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [], + "type": "object" + }, + "S3MonitoringConfiguration": { + "additionalProperties": false, + "properties": { + "EncryptionKeyArn": { + "$ref": "#/definitions/EncryptionKeyArn", + "description": "KMS key ARN to encrypt the logs stored in given s3" + }, + "LogUri": { + "$ref": "#/definitions/UriString" + } + } + }, + "SecurityGroupId": { + "description": "Identifier of a security group", + "maxLength": 32, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+", + "type": "string" + }, + "SensitivePropertiesKeyValuePair": { + "maxLength": 1024, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "SensitivePropertiesMap": { + "maxLength": 1024, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "SubnetId": { + "description": "Identifier of a subnet", + "maxLength": 32, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9 /_.:=+@-]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 /_.:=+@-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UriString": { + "maxLength": 10280, + "minLength": 1, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*", + "type": "string" + }, + "WorkerConfiguration": { + "additionalProperties": false, + "properties": { + "Cpu": { + "$ref": "#/definitions/CpuSize", + "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." + }, + "Disk": { + "$ref": "#/definitions/DiskSize", + "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" + }, + "DiskType": { + "$ref": "#/definitions/DiskType", + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" + }, + "Memory": { + "$ref": "#/definitions/MemorySize", + "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." + } + }, + "required": [ + "Cpu", + "Memory" + ], + "type": "object" + }, + "WorkerTypeSpecificationInput": { + "additionalProperties": false, + "description": "The specifications for a worker type.", + "properties": { + "ImageConfiguration": { + "$ref": "#/definitions/ImageConfigurationInput" + } + }, + "type": "object" + }, + "WorkerTypeSpecificationInputMap": { + "additionalProperties": false, + "patternProperties": { + "^[a-zA-Z]+[-_]*[a-zA-Z]+$": { + "$ref": "#/definitions/WorkerTypeSpecificationInput" + } + }, + "type": "object" + }, + "WorkerTypeString": { + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$", + "type": "string" + } + }, + "description": "Resource schema for AWS::EMRServerless::Application Type", + "handlers": { + "create": { + "permissions": [ + "kms:CreateKey", + "kms:CreateAlias", + "kms:DescribeKey", + "kms:EnableKey", + "kms:ListGrants", + "kms:ListAliases", + "kms:ListKeyPolicies", + "kms:ListKeys", + "kms:PutKeyPolicy", + "kms:UpdateKeyDescription", + "kms:UpdateAlias", + "kms:UpdatePrimaryRegion", + "kms:RevokeGrant", + "kms:DisableKey", + "kms:DisableKeyRotation", + "kms:GetKeyPolicy", + "kms:GetKeyRotationStatus", + "kms:DeleteAlias", + "kms:ScheduleKeyDeletion", + "kms:CancelKeyDeletion", + "kms:GenerateDataKey", + "kms:TagResource", + "kms:UntagResource", + "kms:Decrypt", + "emr-serverless:CreateApplication", + "emr-serverless:TagResource", + "emr-serverless:GetApplication", + "iam:CreateServiceLinkedRole", + "ec2:CreateNetworkInterface", + "ecr:BatchGetImage", + "ecr:DescribeImages", + "ecr:GetDownloadUrlForLayer" + ] + }, + "delete": { + "permissions": [ + "emr-serverless:DeleteApplication", + "emr-serverless:GetApplication" + ] + }, + "list": { + "permissions": [ + "emr-serverless:ListApplications" + ] + }, + "read": { + "permissions": [ + "emr-serverless:GetApplication" + ] + }, + "update": { + "permissions": [ + "emr-serverless:UpdateApplication", + "emr-serverless:TagResource", + "emr-serverless:UntagResource", + "emr-serverless:GetApplication", + "ec2:CreateNetworkInterface", + "ecr:BatchGetImage", + "ecr:DescribeImages", + "ecr:GetDownloadUrlForLayer", + "kms:CreateKey", + "kms:CreateAlias", + "kms:DescribeKey", + "kms:EnableKey", + "kms:ListGrants", + "kms:ListAliases", + "kms:ListKeyPolicies", + "kms:ListKeys", + "kms:PutKeyPolicy", + "kms:UpdateKeyDescription", + "kms:UpdateAlias", + "kms:UpdatePrimaryRegion", + "kms:RevokeGrant", + "kms:DisableKey", + "kms:DisableKeyRotation", + "kms:GetKeyPolicy", + "kms:GetKeyRotationStatus", + "kms:DeleteAlias", + "kms:ScheduleKeyDeletion", + "kms:CancelKeyDeletion", + "kms:GenerateDataKey", + "kms:TagResource", + "kms:UntagResource", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId" + ], + "properties": { + "ApplicationId": { + "description": "The ID of the EMR Serverless Application.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Architecture": { + "$ref": "#/definitions/Architecture" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the EMR Serverless Application.", + "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$", + "type": "string" + }, + "AutoStartConfiguration": { + "$ref": "#/definitions/AutoStartConfiguration", + "description": "Configuration for Auto Start of Application." + }, + "AutoStopConfiguration": { + "$ref": "#/definitions/AutoStopConfiguration", + "description": "Configuration for Auto Stop of Application." + }, + "ImageConfiguration": { + "$ref": "#/definitions/ImageConfigurationInput" + }, + "InitialCapacity": { + "$ref": "#/definitions/InitialCapacityConfigMap", + "description": "Initial capacity initialized when an Application is started." + }, + "InteractiveConfiguration": { + "$ref": "#/definitions/InteractiveConfiguration" + }, + "MaximumCapacity": { + "$ref": "#/definitions/MaximumAllowedResources", + "description": "Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit." + }, + "MonitoringConfiguration": { + "$ref": "#/definitions/MonitoringConfiguration" + }, + "Name": { + "description": "User friendly Application name.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9._\\/#-]+$", + "type": "string" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "Network Configuration for customer VPC connectivity." + }, + "ReleaseLabel": { + "description": "EMR release label.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9._/-]+$", + "type": "string" + }, + "RuntimeConfiguration": { + "$ref": "#/definitions/ConfigurationList" + }, + "Tags": { + "description": "Tag map with key and value", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the application", + "type": "string" + }, + "WorkerTypeSpecifications": { + "$ref": "#/definitions/WorkerTypeSpecificationInputMap", + "description": "The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types." + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ApplicationId" + ], + "required": [ + "ReleaseLabel", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EMRServerless::Application" +} diff --git a/schema/aws-entityresolution-idmappingworkflow.json b/schema/aws-entityresolution-idmappingworkflow.json index 2a7b360..13de899 100644 --- a/schema/aws-entityresolution-idmappingworkflow.json +++ b/schema/aws-entityresolution-idmappingworkflow.json @@ -1,359 +1,359 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkflowName" - ], - "definitions": { - "AttributeName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - }, - "CreatedAt": { - "description": "The time of this IdMappingWorkflow got created", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "EntityName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9-]*$", - "type": "string" - }, - "IdMappingRuleBasedProperties": { - "additionalProperties": false, - "properties": { - "AttributeMatchingModel": { - "enum": [ - "ONE_TO_ONE", - "MANY_TO_MANY" - ], - "type": "string" - }, - "RecordMatchingModel": { - "enum": [ - "ONE_SOURCE_TO_ONE_TARGET", - "MANY_SOURCE_TO_ONE_TARGET" - ], - "type": "string" - }, - "RuleDefinitionType": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string" - }, - "Rules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Rule" - }, - "maxItems": 25, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AttributeMatchingModel", - "RecordMatchingModel" - ], - "type": "object" - }, - "IdMappingTechniques": { - "additionalProperties": false, - "properties": { - "IdMappingType": { - "enum": [ - "PROVIDER", - "RULE_BASED" - ], - "type": "string" - }, - "ProviderProperties": { - "$ref": "#/definitions/ProviderProperties" - }, - "RuleBasedProperties": { - "$ref": "#/definitions/IdMappingRuleBasedProperties" - } - }, - "type": "object" - }, - "IdMappingWorkflowArn": { - "description": "The default IdMappingWorkflow arn", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$", - "type": "string" - }, - "IdMappingWorkflowInputSource": { - "additionalProperties": false, - "properties": { - "InputSourceARN": { - "description": "An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", - "type": "string" - }, - "SchemaArn": { - "$ref": "#/definitions/SchemaMappingArn", - "type": "string" - }, - "Type": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string" - } - }, - "required": [ - "InputSourceARN" - ], - "type": "object" - }, - "IdMappingWorkflowOutputSource": { - "additionalProperties": false, - "properties": { - "KMSArn": { - "$ref": "#/definitions/KMSArn" - }, - "OutputS3Path": { - "description": "The S3 path to which Entity Resolution will write the output table", - "pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", - "type": "string" - } - }, - "required": [ - "OutputS3Path" - ], - "type": "object" - }, - "IntermediateSourceConfiguration": { - "additionalProperties": false, - "properties": { - "IntermediateS3Path": { - "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution.", - "type": "string" - } - }, - "required": [ - "IntermediateS3Path" - ], - "type": "object" - }, - "KMSArn": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$", - "type": "string" - }, - "ProviderProperties": { - "additionalProperties": false, - "properties": { - "IntermediateSourceConfiguration": { - "$ref": "#/definitions/IntermediateSourceConfiguration" - }, - "ProviderConfiguration": { - "additionalProperties": false, - "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format", - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "ProviderServiceArn": { - "description": "Arn of the Provider Service being used.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$", - "type": "string" - } - }, - "required": [ - "ProviderServiceArn" - ], - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "MatchingKeys": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttributeName" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "RuleName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - } - }, - "required": [ - "RuleName", - "MatchingKeys" - ], - "type": "object" - }, - "SchemaMappingArn": { - "description": "The SchemaMapping arn associated with the Schema", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UpdatedAt": { - "description": "The time of this IdMappingWorkflow got last updated at", - "type": "string" - } - }, - "description": "IdMappingWorkflow defined in AWS Entity Resolution service", - "handlers": { - "create": { - "permissions": [ - "entityresolution:CreateIdMappingWorkflow", - "entityresolution:GetIdMappingWorkflow", - "entityresolution:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "entityresolution:DeleteIdMappingWorkflow", - "entityresolution:GetIdMappingWorkflow", - "entityresolution:UntagResource" - ] - }, - "list": { - "permissions": [ - "entityresolution:ListIdMappingWorkflows" - ] - }, - "read": { - "permissions": [ - "entityresolution:GetIdMappingWorkflow", - "entityresolution:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "entityresolution:GetIdMappingWorkflow", - "entityresolution:UpdateIdMappingWorkflow", - "entityresolution:ListTagsForResource", - "entityresolution:TagResource", - "entityresolution:UntagResource", - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkflowName" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/CreatedAt" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "The description of the IdMappingWorkflow" - }, - "IdMappingTechniques": { - "$ref": "#/definitions/IdMappingTechniques" - }, - "InputSourceConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IdMappingWorkflowInputSource" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "OutputSourceConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IdMappingWorkflowOutputSource" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "RoleArn": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "$ref": "#/definitions/UpdatedAt" - }, - "WorkflowArn": { - "$ref": "#/definitions/IdMappingWorkflowArn" - }, - "WorkflowName": { - "$ref": "#/definitions/EntityName", - "description": "The name of the IdMappingWorkflow" - } - }, - "readOnlyProperties": [ - "/properties/WorkflowArn", - "/properties/UpdatedAt", - "/properties/CreatedAt" - ], - "required": [ - "WorkflowName", - "InputSourceConfig", - "IdMappingTechniques", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EntityResolution::IdMappingWorkflow", - "writeOnlyProperties": [ - "/properties/IdMappingTechniques/NormalizationVersion" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkflowName" + ], + "definitions": { + "AttributeName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + }, + "CreatedAt": { + "description": "The time of this IdMappingWorkflow got created", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "EntityName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9-]*$", + "type": "string" + }, + "IdMappingRuleBasedProperties": { + "additionalProperties": false, + "properties": { + "AttributeMatchingModel": { + "enum": [ + "ONE_TO_ONE", + "MANY_TO_MANY" + ], + "type": "string" + }, + "RecordMatchingModel": { + "enum": [ + "ONE_SOURCE_TO_ONE_TARGET", + "MANY_SOURCE_TO_ONE_TARGET" + ], + "type": "string" + }, + "RuleDefinitionType": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + }, + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Rule" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AttributeMatchingModel", + "RecordMatchingModel" + ], + "type": "object" + }, + "IdMappingTechniques": { + "additionalProperties": false, + "properties": { + "IdMappingType": { + "enum": [ + "PROVIDER", + "RULE_BASED" + ], + "type": "string" + }, + "ProviderProperties": { + "$ref": "#/definitions/ProviderProperties" + }, + "RuleBasedProperties": { + "$ref": "#/definitions/IdMappingRuleBasedProperties" + } + }, + "type": "object" + }, + "IdMappingWorkflowArn": { + "description": "The default IdMappingWorkflow arn", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$", + "type": "string" + }, + "IdMappingWorkflowInputSource": { + "additionalProperties": false, + "properties": { + "InputSourceARN": { + "description": "An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", + "type": "string" + }, + "SchemaArn": { + "$ref": "#/definitions/SchemaMappingArn", + "type": "string" + }, + "Type": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + } + }, + "required": [ + "InputSourceARN" + ], + "type": "object" + }, + "IdMappingWorkflowOutputSource": { + "additionalProperties": false, + "properties": { + "KMSArn": { + "$ref": "#/definitions/KMSArn" + }, + "OutputS3Path": { + "description": "The S3 path to which Entity Resolution will write the output table", + "pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", + "type": "string" + } + }, + "required": [ + "OutputS3Path" + ], + "type": "object" + }, + "IntermediateSourceConfiguration": { + "additionalProperties": false, + "properties": { + "IntermediateS3Path": { + "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution.", + "type": "string" + } + }, + "required": [ + "IntermediateS3Path" + ], + "type": "object" + }, + "KMSArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$", + "type": "string" + }, + "ProviderProperties": { + "additionalProperties": false, + "properties": { + "IntermediateSourceConfiguration": { + "$ref": "#/definitions/IntermediateSourceConfiguration" + }, + "ProviderConfiguration": { + "additionalProperties": false, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderServiceArn": { + "description": "Arn of the Provider Service being used.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$", + "type": "string" + } + }, + "required": [ + "ProviderServiceArn" + ], + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "MatchingKeys": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttributeName" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "RuleName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + } + }, + "required": [ + "RuleName", + "MatchingKeys" + ], + "type": "object" + }, + "SchemaMappingArn": { + "description": "The SchemaMapping arn associated with the Schema", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UpdatedAt": { + "description": "The time of this IdMappingWorkflow got last updated at", + "type": "string" + } + }, + "description": "IdMappingWorkflow defined in AWS Entity Resolution service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:CreateIdMappingWorkflow", + "entityresolution:GetIdMappingWorkflow", + "entityresolution:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeleteIdMappingWorkflow", + "entityresolution:GetIdMappingWorkflow", + "entityresolution:UntagResource" + ] + }, + "list": { + "permissions": [ + "entityresolution:ListIdMappingWorkflows" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetIdMappingWorkflow", + "entityresolution:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "entityresolution:GetIdMappingWorkflow", + "entityresolution:UpdateIdMappingWorkflow", + "entityresolution:ListTagsForResource", + "entityresolution:TagResource", + "entityresolution:UntagResource", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkflowName" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/CreatedAt" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "The description of the IdMappingWorkflow" + }, + "IdMappingTechniques": { + "$ref": "#/definitions/IdMappingTechniques" + }, + "InputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdMappingWorkflowInputSource" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "OutputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdMappingWorkflowOutputSource" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "RoleArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "$ref": "#/definitions/UpdatedAt" + }, + "WorkflowArn": { + "$ref": "#/definitions/IdMappingWorkflowArn" + }, + "WorkflowName": { + "$ref": "#/definitions/EntityName", + "description": "The name of the IdMappingWorkflow" + } + }, + "readOnlyProperties": [ + "/properties/WorkflowArn", + "/properties/UpdatedAt", + "/properties/CreatedAt" + ], + "required": [ + "WorkflowName", + "InputSourceConfig", + "IdMappingTechniques", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EntityResolution::IdMappingWorkflow", + "writeOnlyProperties": [ + "/properties/IdMappingTechniques/NormalizationVersion" + ] +} diff --git a/schema/aws-entityresolution-idnamespace.json b/schema/aws-entityresolution-idnamespace.json index 7c37112..0230691 100644 --- a/schema/aws-entityresolution-idnamespace.json +++ b/schema/aws-entityresolution-idnamespace.json @@ -1,306 +1,306 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdNamespaceName" - ], - "definitions": { - "AttributeName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - }, - "EntityName": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z_0-9-]*$", - "type": "string" - }, - "IdNamespaceIdMappingWorkflowProperties": { - "additionalProperties": false, - "properties": { - "IdMappingType": { - "enum": [ - "PROVIDER", - "RULE_BASED" - ], - "type": "string" - }, - "ProviderProperties": { - "$ref": "#/definitions/NamespaceProviderProperties" - }, - "RuleBasedProperties": { - "$ref": "#/definitions/NamespaceRuleBasedProperties" - } - }, - "required": [ - "IdMappingType" - ], - "type": "object" - }, - "IdNamespaceInputSource": { - "additionalProperties": false, - "properties": { - "InputSourceARN": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", - "type": "string" - }, - "SchemaName": { - "$ref": "#/definitions/EntityName" - } - }, - "required": [ - "InputSourceARN" - ], - "type": "object" - }, - "NamespaceProviderProperties": { - "additionalProperties": false, - "properties": { - "ProviderConfiguration": { - "additionalProperties": false, - "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.", - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "ProviderServiceArn": { - "$ref": "#/definitions/ProviderServiceArn" - } - }, - "required": [ - "ProviderServiceArn" - ], - "type": "object" - }, - "NamespaceRuleBasedProperties": { - "additionalProperties": false, - "properties": { - "AttributeMatchingModel": { - "enum": [ - "ONE_TO_ONE", - "MANY_TO_MANY" - ], - "type": "string" - }, - "RecordMatchingModels": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RecordMatchingModel" - }, - "type": "array" - }, - "RuleDefinitionTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RuleDefinitionType" - }, - "type": "array" - }, - "Rules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Rule" - }, - "maxItems": 25, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "ProviderServiceArn": { - "maxLength": 255, - "minLength": 20, - "pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$", - "type": "string" - }, - "RecordMatchingModel": { - "enum": [ - "ONE_SOURCE_TO_ONE_TARGET", - "MANY_SOURCE_TO_ONE_TARGET" - ], - "type": "string" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "MatchingKeys": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttributeName" - }, - "maxItems": 25, - "minItems": 1, - "type": "array" - }, - "RuleName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - } - }, - "required": [ - "RuleName", - "MatchingKeys" - ], - "type": "object" - }, - "RuleDefinitionType": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "IdNamespace defined in AWS Entity Resolution service", - "handlers": { - "create": { - "permissions": [ - "entityresolution:CreateIdNamespace", - "entityresolution:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "entityresolution:DeleteIdNamespace", - "entityresolution:GetIdNamespace", - "entityresolution:UntagResource" - ] - }, - "list": { - "permissions": [ - "entityresolution:ListIdNamespaces" - ] - }, - "read": { - "permissions": [ - "entityresolution:GetIdNamespace", - "entityresolution:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "entityresolution:UpdateIdNamespace", - "entityresolution:ListTagsForResource", - "entityresolution:TagResource", - "entityresolution:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/IdNamespaceName" - ], - "properties": { - "CreatedAt": { - "description": "The date and time when the IdNamespace was created", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "IdMappingWorkflowProperties": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IdNamespaceIdMappingWorkflowProperties" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "IdNamespaceArn": { - "description": "The arn associated with the IdNamespace", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$", - "type": "string" - }, - "IdNamespaceName": { - "$ref": "#/definitions/EntityName" - }, - "InputSourceConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IdNamespaceInputSource" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "RoleArn": { - "maxLength": 512, - "minLength": 32, - "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Type": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string" - }, - "UpdatedAt": { - "description": "The date and time when the IdNamespace was updated", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IdNamespaceArn", - "/properties/CreatedAt", - "/properties/UpdatedAt" - ], - "required": [ - "IdNamespaceName", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EntityResolution::IdNamespace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdNamespaceName" + ], + "definitions": { + "AttributeName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + }, + "EntityName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9-]*$", + "type": "string" + }, + "IdNamespaceIdMappingWorkflowProperties": { + "additionalProperties": false, + "properties": { + "IdMappingType": { + "enum": [ + "PROVIDER", + "RULE_BASED" + ], + "type": "string" + }, + "ProviderProperties": { + "$ref": "#/definitions/NamespaceProviderProperties" + }, + "RuleBasedProperties": { + "$ref": "#/definitions/NamespaceRuleBasedProperties" + } + }, + "required": [ + "IdMappingType" + ], + "type": "object" + }, + "IdNamespaceInputSource": { + "additionalProperties": false, + "properties": { + "InputSourceARN": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", + "type": "string" + }, + "SchemaName": { + "$ref": "#/definitions/EntityName" + } + }, + "required": [ + "InputSourceARN" + ], + "type": "object" + }, + "NamespaceProviderProperties": { + "additionalProperties": false, + "properties": { + "ProviderConfiguration": { + "additionalProperties": false, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderServiceArn": { + "$ref": "#/definitions/ProviderServiceArn" + } + }, + "required": [ + "ProviderServiceArn" + ], + "type": "object" + }, + "NamespaceRuleBasedProperties": { + "additionalProperties": false, + "properties": { + "AttributeMatchingModel": { + "enum": [ + "ONE_TO_ONE", + "MANY_TO_MANY" + ], + "type": "string" + }, + "RecordMatchingModels": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RecordMatchingModel" + }, + "type": "array" + }, + "RuleDefinitionTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RuleDefinitionType" + }, + "type": "array" + }, + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Rule" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ProviderServiceArn": { + "maxLength": 255, + "minLength": 20, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$", + "type": "string" + }, + "RecordMatchingModel": { + "enum": [ + "ONE_SOURCE_TO_ONE_TARGET", + "MANY_SOURCE_TO_ONE_TARGET" + ], + "type": "string" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "MatchingKeys": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttributeName" + }, + "maxItems": 25, + "minItems": 1, + "type": "array" + }, + "RuleName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + } + }, + "required": [ + "RuleName", + "MatchingKeys" + ], + "type": "object" + }, + "RuleDefinitionType": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "IdNamespace defined in AWS Entity Resolution service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:CreateIdNamespace", + "entityresolution:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeleteIdNamespace", + "entityresolution:GetIdNamespace", + "entityresolution:UntagResource" + ] + }, + "list": { + "permissions": [ + "entityresolution:ListIdNamespaces" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetIdNamespace", + "entityresolution:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "entityresolution:UpdateIdNamespace", + "entityresolution:ListTagsForResource", + "entityresolution:TagResource", + "entityresolution:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdNamespaceName" + ], + "properties": { + "CreatedAt": { + "description": "The date and time when the IdNamespace was created", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "IdMappingWorkflowProperties": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdNamespaceIdMappingWorkflowProperties" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "IdNamespaceArn": { + "description": "The arn associated with the IdNamespace", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$", + "type": "string" + }, + "IdNamespaceName": { + "$ref": "#/definitions/EntityName" + }, + "InputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdNamespaceInputSource" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "RoleArn": { + "maxLength": 512, + "minLength": 32, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Type": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + }, + "UpdatedAt": { + "description": "The date and time when the IdNamespace was updated", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdNamespaceArn", + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "IdNamespaceName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EntityResolution::IdNamespace" +} diff --git a/schema/aws-entityresolution-matchingworkflow.json b/schema/aws-entityresolution-matchingworkflow.json index 40d8c6e..aa95af1 100644 --- a/schema/aws-entityresolution-matchingworkflow.json +++ b/schema/aws-entityresolution-matchingworkflow.json @@ -1,378 +1,410 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkflowName" - ], - "definitions": { - "AttributeName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - }, - "CreatedAt": { - "description": "The time of this MatchingWorkflow got created", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "EntityName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9-]*$", - "type": "string" - }, - "InputSource": { - "additionalProperties": false, - "properties": { - "ApplyNormalization": { - "type": "boolean" - }, - "InputSourceARN": { - "description": "An Glue table ARN for the input source table", - "pattern": "arn:(aws|aws-us-gov|aws-cn):.*:.*:[0-9]+:.*$", - "type": "string" - }, - "SchemaArn": { - "$ref": "#/definitions/SchemaMappingArn", - "type": "string" - } - }, - "required": [ - "InputSourceARN", - "SchemaArn" - ], - "type": "object" - }, - "IntermediateSourceConfiguration": { - "additionalProperties": false, - "properties": { - "IntermediateS3Path": { - "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution.", - "type": "string" - } - }, - "required": [ - "IntermediateS3Path" - ], - "type": "object" - }, - "KMSArn": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$", - "type": "string" - }, - "MatchingWorkflowArn": { - "description": "The default MatchingWorkflow arn", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$", - "type": "string" - }, - "OutputAttribute": { - "additionalProperties": false, - "properties": { - "Hashed": { - "type": "boolean" - }, - "Name": { - "$ref": "#/definitions/AttributeName" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "OutputSource": { - "additionalProperties": false, - "properties": { - "ApplyNormalization": { - "type": "boolean" - }, - "KMSArn": { - "$ref": "#/definitions/KMSArn" - }, - "Output": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OutputAttribute" - }, - "maxItems": 750, - "minItems": 0, - "type": "array" - }, - "OutputS3Path": { - "description": "The S3 path to which Entity Resolution will write the output table", - "pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", - "type": "string" - } - }, - "required": [ - "Output", - "OutputS3Path" - ], - "type": "object" - }, - "ProviderProperties": { - "additionalProperties": false, - "properties": { - "IntermediateSourceConfiguration": { - "$ref": "#/definitions/IntermediateSourceConfiguration" - }, - "ProviderConfiguration": { - "additionalProperties": false, - "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format", - "patternProperties": { - "^.+$": { - "type": "string" - } - }, - "type": "object" - }, - "ProviderServiceArn": { - "description": "Arn of the Provider service being used.", - "type": "string" - } - }, - "required": [ - "ProviderServiceArn" - ], - "type": "object" - }, - "ResolutionTechniques": { - "additionalProperties": false, - "properties": { - "ProviderProperties": { - "$ref": "#/definitions/ProviderProperties" - }, - "ResolutionType": { - "$ref": "#/definitions/ResolutionType" - }, - "RuleBasedProperties": { - "$ref": "#/definitions/RuleBasedProperties" - } - }, - "type": "object" - }, - "ResolutionType": { - "enum": [ - "RULE_MATCHING", - "ML_MATCHING", - "PROVIDER" - ], - "type": "string" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "MatchingKeys": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttributeName" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "RuleName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - } - }, - "required": [ - "RuleName", - "MatchingKeys" - ], - "type": "object" - }, - "RuleBasedProperties": { - "additionalProperties": false, - "properties": { - "AttributeMatchingModel": { - "enum": [ - "ONE_TO_ONE", - "MANY_TO_MANY" - ], - "type": "string" - }, - "MatchPurpose": { - "enum": [ - "IDENTIFIER_GENERATION", - "INDEXING" - ], - "type": "string" - }, - "Rules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Rule" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AttributeMatchingModel", - "Rules" - ], - "type": "object" - }, - "SchemaMappingArn": { - "description": "The SchemaMapping arn associated with the Schema", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UpdatedAt": { - "description": "The time of this MatchingWorkflow got last updated at", - "type": "string" - } - }, - "description": "MatchingWorkflow defined in AWS Entity Resolution service", - "handlers": { - "create": { - "permissions": [ - "entityresolution:CreateMatchingWorkflow", - "entityresolution:GetMatchingWorkflow", - "entityresolution:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "entityresolution:DeleteMatchingWorkflow", - "entityresolution:GetMatchingWorkflow", - "entityresolution:UntagResource" - ] - }, - "list": { - "permissions": [ - "entityresolution:ListMatchingWorkflows" - ] - }, - "read": { - "permissions": [ - "entityresolution:GetMatchingWorkflow", - "entityresolution:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "entityresolution:GetMatchingWorkflow", - "entityresolution:UpdateMatchingWorkflow", - "entityresolution:ListTagsForResource", - "entityresolution:TagResource", - "entityresolution:UntagResource", - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkflowName" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/CreatedAt" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "The description of the MatchingWorkflow" - }, - "InputSourceConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InputSource" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "OutputSourceConfig": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OutputSource" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "ResolutionTechniques": { - "$ref": "#/definitions/ResolutionTechniques" - }, - "RoleArn": { - "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "$ref": "#/definitions/UpdatedAt" - }, - "WorkflowArn": { - "$ref": "#/definitions/MatchingWorkflowArn" - }, - "WorkflowName": { - "$ref": "#/definitions/EntityName", - "description": "The name of the MatchingWorkflow" - } - }, - "readOnlyProperties": [ - "/properties/WorkflowArn", - "/properties/UpdatedAt", - "/properties/CreatedAt" - ], - "required": [ - "WorkflowName", - "InputSourceConfig", - "OutputSourceConfig", - "ResolutionTechniques", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EntityResolution::MatchingWorkflow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkflowName" + ], + "definitions": { + "AttributeName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + }, + "CreatedAt": { + "description": "The time of this MatchingWorkflow got created", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "EntityName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9-]*$", + "type": "string" + }, + "IncrementalRunConfig": { + "additionalProperties": false, + "properties": { + "IncrementalRunType": { + "enum": [ + "IMMEDIATE" + ], + "type": "string" + } + }, + "required": [ + "IncrementalRunType" + ], + "type": "object" + }, + "InputSource": { + "additionalProperties": false, + "properties": { + "ApplyNormalization": { + "type": "boolean" + }, + "InputSourceARN": { + "description": "An Glue table ARN for the input source table", + "pattern": "arn:(aws|aws-us-gov|aws-cn):.*:.*:[0-9]+:.*$", + "type": "string" + }, + "SchemaArn": { + "$ref": "#/definitions/SchemaMappingArn", + "type": "string" + } + }, + "required": [ + "InputSourceARN", + "SchemaArn" + ], + "type": "object" + }, + "IntermediateSourceConfiguration": { + "additionalProperties": false, + "properties": { + "IntermediateS3Path": { + "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution.", + "type": "string" + } + }, + "required": [ + "IntermediateS3Path" + ], + "type": "object" + }, + "KMSArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$", + "type": "string" + }, + "MatchingWorkflowArn": { + "description": "The default MatchingWorkflow arn", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$", + "type": "string" + }, + "OutputAttribute": { + "additionalProperties": false, + "properties": { + "Hashed": { + "type": "boolean" + }, + "Name": { + "$ref": "#/definitions/AttributeName" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "OutputSource": { + "additionalProperties": false, + "properties": { + "ApplyNormalization": { + "type": "boolean" + }, + "KMSArn": { + "$ref": "#/definitions/KMSArn" + }, + "Output": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OutputAttribute" + }, + "maxItems": 750, + "minItems": 0, + "type": "array" + }, + "OutputS3Path": { + "description": "The S3 path to which Entity Resolution will write the output table", + "pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", + "type": "string" + } + }, + "required": [ + "Output", + "OutputS3Path" + ], + "type": "object" + }, + "ProviderProperties": { + "additionalProperties": false, + "properties": { + "IntermediateSourceConfiguration": { + "$ref": "#/definitions/IntermediateSourceConfiguration" + }, + "ProviderConfiguration": { + "additionalProperties": false, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderServiceArn": { + "description": "Arn of the Provider service being used.", + "type": "string" + } + }, + "required": [ + "ProviderServiceArn" + ], + "type": "object" + }, + "ResolutionTechniques": { + "additionalProperties": false, + "properties": { + "ProviderProperties": { + "$ref": "#/definitions/ProviderProperties" + }, + "ResolutionType": { + "$ref": "#/definitions/ResolutionType" + }, + "RuleBasedProperties": { + "$ref": "#/definitions/RuleBasedProperties" + } + }, + "type": "object" + }, + "ResolutionType": { + "enum": [ + "RULE_MATCHING", + "ML_MATCHING", + "PROVIDER" + ], + "type": "string" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "MatchingKeys": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttributeName" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "RuleName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + } + }, + "required": [ + "RuleName", + "MatchingKeys" + ], + "type": "object" + }, + "RuleBasedProperties": { + "additionalProperties": false, + "properties": { + "AttributeMatchingModel": { + "enum": [ + "ONE_TO_ONE", + "MANY_TO_MANY" + ], + "type": "string" + }, + "MatchPurpose": { + "enum": [ + "IDENTIFIER_GENERATION", + "INDEXING" + ], + "type": "string" + }, + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Rule" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AttributeMatchingModel", + "Rules" + ], + "type": "object" + }, + "SchemaMappingArn": { + "description": "The SchemaMapping arn associated with the Schema", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UpdatedAt": { + "description": "The time of this MatchingWorkflow got last updated at", + "type": "string" + } + }, + "description": "MatchingWorkflow defined in AWS Entity Resolution service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:CreateMatchingWorkflow", + "entityresolution:GetMatchingWorkflow", + "entityresolution:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "iam:PassRole", + "events:PutRule", + "events:DeleteRule", + "events:PutTargets", + "events:ListTargetsByRule" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeleteMatchingWorkflow", + "entityresolution:GetMatchingWorkflow", + "entityresolution:UntagResource", + "events:PutRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule" + ] + }, + "list": { + "permissions": [ + "entityresolution:ListMatchingWorkflows" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetMatchingWorkflow", + "entityresolution:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "entityresolution:GetMatchingWorkflow", + "entityresolution:UpdateMatchingWorkflow", + "entityresolution:ListTagsForResource", + "entityresolution:TagResource", + "entityresolution:UntagResource", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "events:PutRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkflowName" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/CreatedAt" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "The description of the MatchingWorkflow" + }, + "IncrementalRunConfig": { + "$ref": "#/definitions/IncrementalRunConfig" + }, + "InputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InputSource" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "OutputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OutputSource" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "ResolutionTechniques": { + "$ref": "#/definitions/ResolutionTechniques" + }, + "RoleArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "$ref": "#/definitions/UpdatedAt" + }, + "WorkflowArn": { + "$ref": "#/definitions/MatchingWorkflowArn" + }, + "WorkflowName": { + "$ref": "#/definitions/EntityName", + "description": "The name of the MatchingWorkflow" + } + }, + "readOnlyProperties": [ + "/properties/WorkflowArn", + "/properties/UpdatedAt", + "/properties/CreatedAt" + ], + "required": [ + "WorkflowName", + "InputSourceConfig", + "OutputSourceConfig", + "ResolutionTechniques", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EntityResolution::MatchingWorkflow" +} diff --git a/schema/aws-entityresolution-policystatement.json b/schema/aws-entityresolution-policystatement.json index 2c5aec4..c159b87 100644 --- a/schema/aws-entityresolution-policystatement.json +++ b/schema/aws-entityresolution-policystatement.json @@ -1,133 +1,133 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StatementId", - "/properties/Arn" - ], - "definitions": { - "StatementAction": { - "maxLength": 64, - "minLength": 3, - "pattern": "^(entityresolution:[a-zA-Z0-9]+)$", - "type": "string" - }, - "StatementActionList": { - "items": { - "$ref": "#/definitions/StatementAction" - }, - "type": "array" - }, - "StatementCondition": { - "maxLength": 40960, - "minLength": 1, - "type": "string" - }, - "StatementEffect": { - "enum": [ - "Allow", - "Deny" - ], - "type": "string" - }, - "StatementId": { - "description": "The Statement Id of the policy statement that is being attached.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+$", - "type": "string" - }, - "StatementPrincipal": { - "maxLength": 64, - "minLength": 12, - "pattern": "^(\\\\d{12})|([a-z0-9\\\\.]+)$", - "type": "string" - }, - "StatementPrincipalList": { - "items": { - "$ref": "#/definitions/StatementPrincipal" - }, - "type": "array" - }, - "VeniceGlobalArn": { - "description": "Arn of the resource to which the policy statement is being attached.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$", - "type": "string" - } - }, - "description": "Policy Statement defined in AWS Entity Resolution Service", - "handlers": { - "create": { - "permissions": [ - "entityresolution:AddPolicyStatement" - ] - }, - "delete": { - "permissions": [ - "entityresolution:DeletePolicyStatement", - "entityresolution:GetPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/Arn" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "entityresolution:GetPolicy" - ] - }, - "read": { - "permissions": [ - "entityresolution:GetPolicy" - ] - }, - "update": { - "permissions": [ - "entityresolution:AddPolicyStatement", - "entityresolution:DeletePolicyStatement" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn", - "/properties/StatementId" - ], - "properties": { - "Action": { - "$ref": "#/definitions/StatementActionList" - }, - "Arn": { - "$ref": "#/definitions/VeniceGlobalArn" - }, - "Condition": { - "$ref": "#/definitions/StatementCondition" - }, - "Effect": { - "$ref": "#/definitions/StatementEffect" - }, - "Principal": { - "$ref": "#/definitions/StatementPrincipalList" - }, - "StatementId": { - "$ref": "#/definitions/StatementId" - } - }, - "required": [ - "Arn", - "StatementId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::EntityResolution::PolicyStatement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StatementId", + "/properties/Arn" + ], + "definitions": { + "StatementAction": { + "maxLength": 64, + "minLength": 3, + "pattern": "^(entityresolution:[a-zA-Z0-9]+)$", + "type": "string" + }, + "StatementActionList": { + "items": { + "$ref": "#/definitions/StatementAction" + }, + "type": "array" + }, + "StatementCondition": { + "maxLength": 40960, + "minLength": 1, + "type": "string" + }, + "StatementEffect": { + "enum": [ + "Allow", + "Deny" + ], + "type": "string" + }, + "StatementId": { + "description": "The Statement Id of the policy statement that is being attached.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+$", + "type": "string" + }, + "StatementPrincipal": { + "maxLength": 64, + "minLength": 12, + "pattern": "^(\\\\d{12})|([a-z0-9\\\\.]+)$", + "type": "string" + }, + "StatementPrincipalList": { + "items": { + "$ref": "#/definitions/StatementPrincipal" + }, + "type": "array" + }, + "VeniceGlobalArn": { + "description": "Arn of the resource to which the policy statement is being attached.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$", + "type": "string" + } + }, + "description": "Policy Statement defined in AWS Entity Resolution Service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:AddPolicyStatement" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeletePolicyStatement", + "entityresolution:GetPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Arn" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "entityresolution:GetPolicy" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetPolicy" + ] + }, + "update": { + "permissions": [ + "entityresolution:AddPolicyStatement", + "entityresolution:DeletePolicyStatement" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn", + "/properties/StatementId" + ], + "properties": { + "Action": { + "$ref": "#/definitions/StatementActionList" + }, + "Arn": { + "$ref": "#/definitions/VeniceGlobalArn" + }, + "Condition": { + "$ref": "#/definitions/StatementCondition" + }, + "Effect": { + "$ref": "#/definitions/StatementEffect" + }, + "Principal": { + "$ref": "#/definitions/StatementPrincipalList" + }, + "StatementId": { + "$ref": "#/definitions/StatementId" + } + }, + "required": [ + "Arn", + "StatementId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EntityResolution::PolicyStatement" +} diff --git a/schema/aws-entityresolution-schemamapping.json b/schema/aws-entityresolution-schemamapping.json index df76c12..2ff3ff2 100644 --- a/schema/aws-entityresolution-schemamapping.json +++ b/schema/aws-entityresolution-schemamapping.json @@ -1,225 +1,225 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SchemaName" - ], - "definitions": { - "AttributeName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9- \\t]*$", - "type": "string" - }, - "CreatedAt": { - "description": "The time of this SchemaMapping got created", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "EntityName": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[a-zA-Z_0-9-]*$", - "type": "string" - }, - "HasWorkflows": { - "description": "The boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with", - "type": "boolean" - }, - "Hashed": { - "type": "boolean" - }, - "MappedInputFields": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SchemaInputAttribute" - }, - "maxItems": 25, - "minItems": 2, - "type": "array" - }, - "SchemaAttributeType": { - "enum": [ - "NAME", - "NAME_FIRST", - "NAME_MIDDLE", - "NAME_LAST", - "ADDRESS", - "ADDRESS_STREET1", - "ADDRESS_STREET2", - "ADDRESS_STREET3", - "ADDRESS_CITY", - "ADDRESS_STATE", - "ADDRESS_COUNTRY", - "ADDRESS_POSTALCODE", - "PHONE", - "PHONE_NUMBER", - "PHONE_COUNTRYCODE", - "EMAIL_ADDRESS", - "UNIQUE_ID", - "DATE", - "STRING", - "PROVIDER_ID" - ], - "type": "string" - }, - "SchemaInputAttribute": { - "additionalProperties": false, - "properties": { - "FieldName": { - "$ref": "#/definitions/AttributeName" - }, - "GroupName": { - "$ref": "#/definitions/AttributeName" - }, - "Hashed": { - "$ref": "#/definitions/Hashed" - }, - "MatchKey": { - "$ref": "#/definitions/AttributeName" - }, - "SubType": { - "description": "The subtype of the Attribute. Would be required only when type is PROVIDER_ID", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SchemaAttributeType" - } - }, - "required": [ - "FieldName", - "Type" - ], - "type": "object" - }, - "SchemaMappingArn": { - "description": "The SchemaMapping arn associated with the Schema", - "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UpdatedAt": { - "description": "The time of this SchemaMapping got last updated at", - "type": "string" - } - }, - "description": "SchemaMapping defined in AWS Entity Resolution service", - "handlers": { - "create": { - "permissions": [ - "entityresolution:CreateSchemaMapping", - "entityresolution:GetSchemaMapping", - "entityresolution:TagResource" - ] - }, - "delete": { - "permissions": [ - "entityresolution:DeleteSchemaMapping", - "entityresolution:GetSchemaMapping" - ] - }, - "list": { - "permissions": [ - "entityresolution:ListSchemaMappings" - ] - }, - "read": { - "permissions": [ - "entityresolution:GetSchemaMapping", - "entityresolution:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "entityresolution:GetSchemaMapping", - "entityresolution:UpdateSchemaMapping", - "entityresolution:ListTagsForResource", - "entityresolution:TagResource", - "entityresolution:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SchemaName" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/CreatedAt" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "The description of the SchemaMapping" - }, - "HasWorkflows": { - "$ref": "#/definitions/HasWorkflows" - }, - "MappedInputFields": { - "$ref": "#/definitions/MappedInputFields", - "description": "The SchemaMapping attributes input" - }, - "SchemaArn": { - "$ref": "#/definitions/SchemaMappingArn" - }, - "SchemaName": { - "$ref": "#/definitions/EntityName", - "description": "The name of the SchemaMapping" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "$ref": "#/definitions/UpdatedAt" - } - }, - "readOnlyProperties": [ - "/properties/SchemaArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/HasWorkflows" - ], - "required": [ - "SchemaName", - "MappedInputFields" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EntityResolution::SchemaMapping" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SchemaName" + ], + "definitions": { + "AttributeName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9- \\t]*$", + "type": "string" + }, + "CreatedAt": { + "description": "The time of this SchemaMapping got created", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "EntityName": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[a-zA-Z_0-9-]*$", + "type": "string" + }, + "HasWorkflows": { + "description": "The boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with", + "type": "boolean" + }, + "Hashed": { + "type": "boolean" + }, + "MappedInputFields": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SchemaInputAttribute" + }, + "maxItems": 35, + "minItems": 2, + "type": "array" + }, + "SchemaAttributeType": { + "enum": [ + "NAME", + "NAME_FIRST", + "NAME_MIDDLE", + "NAME_LAST", + "ADDRESS", + "ADDRESS_STREET1", + "ADDRESS_STREET2", + "ADDRESS_STREET3", + "ADDRESS_CITY", + "ADDRESS_STATE", + "ADDRESS_COUNTRY", + "ADDRESS_POSTALCODE", + "PHONE", + "PHONE_NUMBER", + "PHONE_COUNTRYCODE", + "EMAIL_ADDRESS", + "UNIQUE_ID", + "DATE", + "STRING", + "PROVIDER_ID" + ], + "type": "string" + }, + "SchemaInputAttribute": { + "additionalProperties": false, + "properties": { + "FieldName": { + "$ref": "#/definitions/AttributeName" + }, + "GroupName": { + "$ref": "#/definitions/AttributeName" + }, + "Hashed": { + "$ref": "#/definitions/Hashed" + }, + "MatchKey": { + "$ref": "#/definitions/AttributeName" + }, + "SubType": { + "description": "The subtype of the Attribute. Would be required only when type is PROVIDER_ID", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SchemaAttributeType" + } + }, + "required": [ + "FieldName", + "Type" + ], + "type": "object" + }, + "SchemaMappingArn": { + "description": "The SchemaMapping arn associated with the Schema", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UpdatedAt": { + "description": "The time of this SchemaMapping got last updated at", + "type": "string" + } + }, + "description": "SchemaMapping defined in AWS Entity Resolution service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:CreateSchemaMapping", + "entityresolution:GetSchemaMapping", + "entityresolution:TagResource" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeleteSchemaMapping", + "entityresolution:GetSchemaMapping" + ] + }, + "list": { + "permissions": [ + "entityresolution:ListSchemaMappings" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetSchemaMapping", + "entityresolution:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "entityresolution:GetSchemaMapping", + "entityresolution:UpdateSchemaMapping", + "entityresolution:ListTagsForResource", + "entityresolution:TagResource", + "entityresolution:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SchemaName" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/CreatedAt" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "The description of the SchemaMapping" + }, + "HasWorkflows": { + "$ref": "#/definitions/HasWorkflows" + }, + "MappedInputFields": { + "$ref": "#/definitions/MappedInputFields", + "description": "The SchemaMapping attributes input" + }, + "SchemaArn": { + "$ref": "#/definitions/SchemaMappingArn" + }, + "SchemaName": { + "$ref": "#/definitions/EntityName", + "description": "The name of the SchemaMapping" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "$ref": "#/definitions/UpdatedAt" + } + }, + "readOnlyProperties": [ + "/properties/SchemaArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/HasWorkflows" + ], + "required": [ + "SchemaName", + "MappedInputFields" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EntityResolution::SchemaMapping" +} diff --git a/schema/aws-events-apidestination.json b/schema/aws-events-apidestination.json index 36e3c5a..ec46b2b 100644 --- a/schema/aws-events-apidestination.json +++ b/schema/aws-events-apidestination.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::Events::ApiDestination.", - "handlers": { - "create": { - "permissions": [ - "events:CreateApiDestination", - "events:DescribeApiDestination" - ] - }, - "delete": { - "permissions": [ - "events:DeleteApiDestination", - "events:DescribeApiDestination" - ] - }, - "list": { - "permissions": [ - "events:ListApiDestinations" - ] - }, - "read": { - "permissions": [ - "events:DescribeApiDestination" - ] - }, - "update": { - "permissions": [ - "events:UpdateApiDestination", - "events:DescribeApiDestination" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The arn of the api destination.", - "type": "string" - }, - "ConnectionArn": { - "description": "The arn of the connection.", - "type": "string" - }, - "Description": { - "maxLength": 512, - "type": "string" - }, - "HttpMethod": { - "enum": [ - "GET", - "HEAD", - "POST", - "OPTIONS", - "PUT", - "DELETE", - "PATCH" - ], - "type": "string" - }, - "InvocationEndpoint": { - "description": "Url endpoint to invoke.", - "type": "string" - }, - "InvocationRateLimitPerSecond": { - "minimum": 1, - "type": "integer" - }, - "Name": { - "description": "Name of the apiDestination.", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ConnectionArn", - "InvocationEndpoint", - "HttpMethod" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Events::ApiDestination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::Events::ApiDestination.", + "handlers": { + "create": { + "permissions": [ + "events:CreateApiDestination", + "events:DescribeApiDestination" + ] + }, + "delete": { + "permissions": [ + "events:DeleteApiDestination", + "events:DescribeApiDestination" + ] + }, + "list": { + "permissions": [ + "events:ListApiDestinations" + ] + }, + "read": { + "permissions": [ + "events:DescribeApiDestination" + ] + }, + "update": { + "permissions": [ + "events:UpdateApiDestination", + "events:DescribeApiDestination" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The arn of the api destination.", + "type": "string" + }, + "ConnectionArn": { + "description": "The arn of the connection.", + "type": "string" + }, + "Description": { + "maxLength": 512, + "type": "string" + }, + "HttpMethod": { + "enum": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "PUT", + "DELETE", + "PATCH" + ], + "type": "string" + }, + "InvocationEndpoint": { + "description": "Url endpoint to invoke.", + "type": "string" + }, + "InvocationRateLimitPerSecond": { + "minimum": 1, + "type": "integer" + }, + "Name": { + "description": "Name of the apiDestination.", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ConnectionArn", + "InvocationEndpoint", + "HttpMethod" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Events::ApiDestination" +} diff --git a/schema/aws-events-archive.json b/schema/aws-events-archive.json index 317e461..38a8773 100644 --- a/schema/aws-events-archive.json +++ b/schema/aws-events-archive.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ArchiveName", - "/properties/SourceArn" - ], - "description": "Resource Type definition for AWS::Events::Archive", - "handlers": { - "create": { - "permissions": [ - "events:DescribeArchive", - "events:CreateArchive" - ] - }, - "delete": { - "permissions": [ - "events:DescribeArchive", - "events:DeleteArchive" - ] - }, - "list": { - "permissions": [ - "events:ListArchives" - ] - }, - "read": { - "permissions": [ - "events:DescribeArchive" - ] - }, - "update": { - "permissions": [ - "events:DescribeArchive", - "events:UpdateArchive" - ] - } - }, - "primaryIdentifier": [ - "/properties/ArchiveName" - ], - "properties": { - "ArchiveName": { - "maxLength": 48, - "minLength": 1, - "type": "string" - }, - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EventPattern": { - "type": "object" - }, - "RetentionDays": { - "type": "integer" - }, - "SourceArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "SourceArn" - ], - "typeName": "AWS::Events::Archive" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ArchiveName", + "/properties/SourceArn" + ], + "description": "Resource Type definition for AWS::Events::Archive", + "handlers": { + "create": { + "permissions": [ + "events:DescribeArchive", + "events:CreateArchive" + ] + }, + "delete": { + "permissions": [ + "events:DescribeArchive", + "events:DeleteArchive" + ] + }, + "list": { + "permissions": [ + "events:ListArchives" + ] + }, + "read": { + "permissions": [ + "events:DescribeArchive" + ] + }, + "update": { + "permissions": [ + "events:DescribeArchive", + "events:UpdateArchive" + ] + } + }, + "primaryIdentifier": [ + "/properties/ArchiveName" + ], + "properties": { + "ArchiveName": { + "maxLength": 48, + "minLength": 1, + "type": "string" + }, + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "EventPattern": { + "type": "object" + }, + "RetentionDays": { + "type": "integer" + }, + "SourceArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "SourceArn" + ], + "typeName": "AWS::Events::Archive" +} diff --git a/schema/aws-events-connection.json b/schema/aws-events-connection.json index 1a8f61b..61608a2 100644 --- a/schema/aws-events-connection.json +++ b/schema/aws-events-connection.json @@ -1,252 +1,252 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ApiKeyAuthParameters": { - "additionalProperties": false, - "properties": { - "ApiKeyName": { - "type": "string" - }, - "ApiKeyValue": { - "type": "string" - } - }, - "required": [ - "ApiKeyName", - "ApiKeyValue" - ], - "type": "object" - }, - "AuthParameters": { - "additionalProperties": false, - "maxProperties": 2, - "minProperties": 1, - "oneOf": [ - { - "required": [ - "BasicAuthParameters" - ] - }, - { - "required": [ - "OAuthParameters" - ] - }, - { - "required": [ - "ApiKeyAuthParameters" - ] - } - ], - "properties": { - "ApiKeyAuthParameters": { - "$ref": "#/definitions/ApiKeyAuthParameters" - }, - "BasicAuthParameters": { - "$ref": "#/definitions/BasicAuthParameters" - }, - "InvocationHttpParameters": { - "$ref": "#/definitions/ConnectionHttpParameters" - }, - "OAuthParameters": { - "$ref": "#/definitions/OAuthParameters" - } - }, - "type": "object" - }, - "BasicAuthParameters": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Username", - "Password" - ], - "type": "object" - }, - "ClientParameters": { - "additionalProperties": false, - "properties": { - "ClientID": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - } - }, - "required": [ - "ClientID", - "ClientSecret" - ], - "type": "object" - }, - "ConnectionHttpParameters": { - "additionalProperties": false, - "properties": { - "BodyParameters": { - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array" - }, - "HeaderParameters": { - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array" - }, - "QueryStringParameters": { - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "OAuthParameters": { - "additionalProperties": false, - "properties": { - "AuthorizationEndpoint": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ClientParameters": { - "$ref": "#/definitions/ClientParameters" - }, - "HttpMethod": { - "enum": [ - "GET", - "POST", - "PUT" - ], - "type": "string" - }, - "OAuthHttpParameters": { - "$ref": "#/definitions/ConnectionHttpParameters" - } - }, - "required": [ - "ClientParameters", - "AuthorizationEndpoint", - "HttpMethod" - ], - "type": "object" - }, - "Parameter": { - "additionalProperties": false, - "properties": { - "IsValueSecret": { - "default": true, - "type": "boolean" - }, - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Events::Connection.", - "handlers": { - "create": { - "permissions": [ - "events:CreateConnection", - "events:DescribeConnection", - "secretsmanager:CreateSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:PutSecretValue", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "events:DeleteConnection", - "events:DescribeConnection" - ] - }, - "list": { - "permissions": [ - "events:ListConnections" - ] - }, - "read": { - "permissions": [ - "events:DescribeConnection" - ] - }, - "update": { - "permissions": [ - "events:UpdateConnection", - "events:DescribeConnection", - "secretsmanager:CreateSecret", - "secretsmanager:UpdateSecret", - "secretsmanager:GetSecretValue", - "secretsmanager:PutSecretValue" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The arn of the connection resource.", - "type": "string" - }, - "AuthParameters": { - "$ref": "#/definitions/AuthParameters" - }, - "AuthorizationType": { - "enum": [ - "API_KEY", - "BASIC", - "OAUTH_CLIENT_CREDENTIALS" - ], - "type": "string" - }, - "Description": { - "description": "Description of the connection.", - "maxLength": 512, - "type": "string" - }, - "Name": { - "description": "Name of the connection.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "SecretArn": { - "description": "The arn of the secrets manager secret created in the customer account.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/SecretArn" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Events::Connection", - "writeOnlyProperties": [ - "/properties/AuthParameters" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ApiKeyAuthParameters": { + "additionalProperties": false, + "properties": { + "ApiKeyName": { + "type": "string" + }, + "ApiKeyValue": { + "type": "string" + } + }, + "required": [ + "ApiKeyName", + "ApiKeyValue" + ], + "type": "object" + }, + "AuthParameters": { + "additionalProperties": false, + "maxProperties": 2, + "minProperties": 1, + "oneOf": [ + { + "required": [ + "BasicAuthParameters" + ] + }, + { + "required": [ + "OAuthParameters" + ] + }, + { + "required": [ + "ApiKeyAuthParameters" + ] + } + ], + "properties": { + "ApiKeyAuthParameters": { + "$ref": "#/definitions/ApiKeyAuthParameters" + }, + "BasicAuthParameters": { + "$ref": "#/definitions/BasicAuthParameters" + }, + "InvocationHttpParameters": { + "$ref": "#/definitions/ConnectionHttpParameters" + }, + "OAuthParameters": { + "$ref": "#/definitions/OAuthParameters" + } + }, + "type": "object" + }, + "BasicAuthParameters": { + "additionalProperties": false, + "properties": { + "Password": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + }, + "ClientParameters": { + "additionalProperties": false, + "properties": { + "ClientID": { + "type": "string" + }, + "ClientSecret": { + "type": "string" + } + }, + "required": [ + "ClientID", + "ClientSecret" + ], + "type": "object" + }, + "ConnectionHttpParameters": { + "additionalProperties": false, + "properties": { + "BodyParameters": { + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + }, + "HeaderParameters": { + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + }, + "QueryStringParameters": { + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "OAuthParameters": { + "additionalProperties": false, + "properties": { + "AuthorizationEndpoint": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ClientParameters": { + "$ref": "#/definitions/ClientParameters" + }, + "HttpMethod": { + "enum": [ + "GET", + "POST", + "PUT" + ], + "type": "string" + }, + "OAuthHttpParameters": { + "$ref": "#/definitions/ConnectionHttpParameters" + } + }, + "required": [ + "ClientParameters", + "AuthorizationEndpoint", + "HttpMethod" + ], + "type": "object" + }, + "Parameter": { + "additionalProperties": false, + "properties": { + "IsValueSecret": { + "default": true, + "type": "boolean" + }, + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Events::Connection.", + "handlers": { + "create": { + "permissions": [ + "events:CreateConnection", + "events:DescribeConnection", + "secretsmanager:CreateSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:PutSecretValue", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "events:DeleteConnection", + "events:DescribeConnection" + ] + }, + "list": { + "permissions": [ + "events:ListConnections" + ] + }, + "read": { + "permissions": [ + "events:DescribeConnection" + ] + }, + "update": { + "permissions": [ + "events:UpdateConnection", + "events:DescribeConnection", + "secretsmanager:CreateSecret", + "secretsmanager:UpdateSecret", + "secretsmanager:GetSecretValue", + "secretsmanager:PutSecretValue" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The arn of the connection resource.", + "type": "string" + }, + "AuthParameters": { + "$ref": "#/definitions/AuthParameters" + }, + "AuthorizationType": { + "enum": [ + "API_KEY", + "BASIC", + "OAUTH_CLIENT_CREDENTIALS" + ], + "type": "string" + }, + "Description": { + "description": "Description of the connection.", + "maxLength": 512, + "type": "string" + }, + "Name": { + "description": "Name of the connection.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "SecretArn": { + "description": "The arn of the secrets manager secret created in the customer account.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/SecretArn" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Events::Connection", + "writeOnlyProperties": [ + "/properties/AuthParameters" + ] +} diff --git a/schema/aws-events-endpoint.json b/schema/aws-events-endpoint.json index 73671fe..cae04da 100644 --- a/schema/aws-events-endpoint.json +++ b/schema/aws-events-endpoint.json @@ -1,238 +1,238 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "EndpointEventBus": { - "additionalProperties": false, - "properties": { - "EventBusArn": { - "$ref": "#/definitions/EventBusArn" - } - }, - "required": [ - "EventBusArn" - ], - "type": "object" - }, - "EventBusArn": { - "maxLength": 512, - "minLength": 1, - "pattern": "^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$", - "type": "string" - }, - "EventBuses": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EndpointEventBus" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - }, - "FailoverConfig": { - "additionalProperties": false, - "properties": { - "Primary": { - "$ref": "#/definitions/Primary" - }, - "Secondary": { - "$ref": "#/definitions/Secondary" - } - }, - "required": [ - "Primary", - "Secondary" - ], - "type": "object" - }, - "HealthCheck": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$", - "type": "string" - }, - "Primary": { - "additionalProperties": false, - "properties": { - "HealthCheck": { - "$ref": "#/definitions/HealthCheck" - } - }, - "required": [ - "HealthCheck" - ], - "type": "object" - }, - "ReplicationConfig": { - "additionalProperties": false, - "properties": { - "State": { - "$ref": "#/definitions/ReplicationState" - } - }, - "required": [ - "State" - ], - "type": "object" - }, - "ReplicationState": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Route": { - "maxLength": 20, - "minLength": 9, - "pattern": "^[\\-a-z0-9]+$", - "type": "string" - }, - "RoutingConfig": { - "additionalProperties": false, - "properties": { - "FailoverConfig": { - "$ref": "#/definitions/FailoverConfig" - } - }, - "required": [ - "FailoverConfig" - ], - "type": "object" - }, - "Secondary": { - "additionalProperties": false, - "properties": { - "Route": { - "$ref": "#/definitions/Route" - } - }, - "required": [ - "Route" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Events::Endpoint.", - "handlers": { - "create": { - "permissions": [ - "events:CreateEndpoint", - "events:DescribeEndpoint", - "route53:GetHealthCheck", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "events:DeleteEndpoint", - "events:DescribeEndpoint" - ] - }, - "list": { - "permissions": [ - "events:ListEndpoints" - ] - }, - "read": { - "permissions": [ - "events:DescribeEndpoint" - ] - }, - "update": { - "permissions": [ - "events:DescribeEndpoint", - "events:UpdateEndpoint", - "route53:GetHealthCheck", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:endpoint\\/[/\\.\\-_A-Za-z0-9]+$", - "type": "string" - }, - "Description": { - "maxLength": 512, - "pattern": ".*", - "type": "string" - }, - "EndpointId": { - "maxLength": 50, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$", - "type": "string" - }, - "EndpointUrl": { - "maxLength": 256, - "minLength": 1, - "pattern": "^(https://)?[\\.\\-a-z0-9]+$", - "type": "string" - }, - "EventBuses": { - "$ref": "#/definitions/EventBuses" - }, - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\.\\-_A-Za-z0-9]+$", - "type": "string" - }, - "ReplicationConfig": { - "$ref": "#/definitions/ReplicationConfig" - }, - "RoleArn": { - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$", - "type": "string" - }, - "RoutingConfig": { - "$ref": "#/definitions/RoutingConfig" - }, - "State": { - "enum": [ - "ACTIVE", - "CREATING", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED" - ], - "type": "string" - }, - "StateReason": { - "maxLength": 512, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/EndpointId", - "/properties/EndpointUrl", - "/properties/State", - "/properties/StateReason" - ], - "required": [ - "RoutingConfig", - "EventBuses" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-events.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Events::Endpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "EndpointEventBus": { + "additionalProperties": false, + "properties": { + "EventBusArn": { + "$ref": "#/definitions/EventBusArn" + } + }, + "required": [ + "EventBusArn" + ], + "type": "object" + }, + "EventBusArn": { + "maxLength": 512, + "minLength": 1, + "pattern": "^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$", + "type": "string" + }, + "EventBuses": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EndpointEventBus" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + }, + "FailoverConfig": { + "additionalProperties": false, + "properties": { + "Primary": { + "$ref": "#/definitions/Primary" + }, + "Secondary": { + "$ref": "#/definitions/Secondary" + } + }, + "required": [ + "Primary", + "Secondary" + ], + "type": "object" + }, + "HealthCheck": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$", + "type": "string" + }, + "Primary": { + "additionalProperties": false, + "properties": { + "HealthCheck": { + "$ref": "#/definitions/HealthCheck" + } + }, + "required": [ + "HealthCheck" + ], + "type": "object" + }, + "ReplicationConfig": { + "additionalProperties": false, + "properties": { + "State": { + "$ref": "#/definitions/ReplicationState" + } + }, + "required": [ + "State" + ], + "type": "object" + }, + "ReplicationState": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Route": { + "maxLength": 20, + "minLength": 9, + "pattern": "^[\\-a-z0-9]+$", + "type": "string" + }, + "RoutingConfig": { + "additionalProperties": false, + "properties": { + "FailoverConfig": { + "$ref": "#/definitions/FailoverConfig" + } + }, + "required": [ + "FailoverConfig" + ], + "type": "object" + }, + "Secondary": { + "additionalProperties": false, + "properties": { + "Route": { + "$ref": "#/definitions/Route" + } + }, + "required": [ + "Route" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Events::Endpoint.", + "handlers": { + "create": { + "permissions": [ + "events:CreateEndpoint", + "events:DescribeEndpoint", + "route53:GetHealthCheck", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "events:DeleteEndpoint", + "events:DescribeEndpoint" + ] + }, + "list": { + "permissions": [ + "events:ListEndpoints" + ] + }, + "read": { + "permissions": [ + "events:DescribeEndpoint" + ] + }, + "update": { + "permissions": [ + "events:DescribeEndpoint", + "events:UpdateEndpoint", + "route53:GetHealthCheck", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:endpoint\\/[/\\.\\-_A-Za-z0-9]+$", + "type": "string" + }, + "Description": { + "maxLength": 512, + "pattern": ".*", + "type": "string" + }, + "EndpointId": { + "maxLength": 50, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$", + "type": "string" + }, + "EndpointUrl": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(https://)?[\\.\\-a-z0-9]+$", + "type": "string" + }, + "EventBuses": { + "$ref": "#/definitions/EventBuses" + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\.\\-_A-Za-z0-9]+$", + "type": "string" + }, + "ReplicationConfig": { + "$ref": "#/definitions/ReplicationConfig" + }, + "RoleArn": { + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$", + "type": "string" + }, + "RoutingConfig": { + "$ref": "#/definitions/RoutingConfig" + }, + "State": { + "enum": [ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "CREATE_FAILED", + "UPDATE_FAILED" + ], + "type": "string" + }, + "StateReason": { + "maxLength": 512, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/EndpointId", + "/properties/EndpointUrl", + "/properties/State", + "/properties/StateReason" + ], + "required": [ + "RoutingConfig", + "EventBuses" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-events.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Events::Endpoint" +} diff --git a/schema/aws-events-eventbus.json b/schema/aws-events-eventbus.json index eb7a3d0..3a5dbe6 100644 --- a/schema/aws-events-eventbus.json +++ b/schema/aws-events-eventbus.json @@ -1,141 +1,146 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::Events::EventBus", - "handlers": { - "create": { - "permissions": [ - "events:CreateEventBus", - "events:DescribeEventBus", - "events:PutPermission", - "events:ListTagsForResource", - "events:TagResource", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "events:DescribeEventBus", - "events:UpdateEventBus", - "events:ListTagsForResource", - "events:UntagResource", - "events:RemovePermission", - "events:DeleteEventBus" - ] - }, - "list": { - "permissions": [ - "events:ListEventBuses", - "events:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "events:DescribeEventBus", - "events:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "events:TagResource", - "events:UntagResource", - "events:PutPermission", - "events:DescribeEventBus", - "events:UpdateEventBus", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) for the event bus.", - "type": "string" - }, - "DeadLetterConfig": { - "additionalProperties": false, - "description": "Dead Letter Queue for the event bus.", - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "Description": { - "description": "The description of the event bus.", - "type": "string" - }, - "EventSourceName": { - "description": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.", - "type": "string" - }, - "KmsKeyIdentifier": { - "description": "Kms Key Identifier used to encrypt events at rest in the event bus.", - "type": "string" - }, - "Name": { - "description": "The name of the event bus.", - "type": "string" - }, - "Policy": { - "description": "A JSON string that describes the permission policy statement for the event bus.", - "type": [ - "object", - "string" - ] - }, - "Tags": { - "description": "Any tags assigned to the event bus.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-events", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Events::EventBus", - "writeOnlyProperties": [ - "/properties/EventSourceName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::Events::EventBus", + "handlers": { + "create": { + "permissions": [ + "events:CreateEventBus", + "events:DescribeEventBus", + "events:PutPermission", + "events:ListTagsForResource", + "events:TagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "events:DescribeEventBus", + "events:UpdateEventBus", + "events:ListTagsForResource", + "events:UntagResource", + "events:RemovePermission", + "events:DeleteEventBus" + ] + }, + "list": { + "permissions": [ + "events:ListEventBuses", + "events:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "events:DescribeEventBus", + "events:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "events:TagResource", + "events:UntagResource", + "events:PutPermission", + "events:DescribeEventBus", + "events:UpdateEventBus", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) for the event bus.", + "type": "string" + }, + "DeadLetterConfig": { + "additionalProperties": false, + "description": "Dead Letter Queue for the event bus.", + "properties": { + "Arn": { + "type": "string" + } + }, + "type": "object" + }, + "Description": { + "description": "The description of the event bus.", + "type": "string" + }, + "EventSourceName": { + "description": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.", + "type": "string" + }, + "KmsKeyIdentifier": { + "description": "Kms Key Identifier used to encrypt events at rest in the event bus.", + "type": "string" + }, + "Name": { + "description": "The name of the event bus.", + "type": "string" + }, + "Policy": { + "description": "A JSON string that describes the permission policy statement for the event bus.", + "type": [ + "object", + "string" + ] + }, + "Tags": { + "description": "Any tags assigned to the event bus.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-events", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "events:UntagResource", + "events:TagResource", + "events:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Events::EventBus", + "writeOnlyProperties": [ + "/properties/EventSourceName" + ] +} diff --git a/schema/aws-events-eventbuspolicy.json b/schema/aws-events-eventbuspolicy.json index 8b3921d..e5123dc 100644 --- a/schema/aws-events-eventbuspolicy.json +++ b/schema/aws-events-eventbuspolicy.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EventBusName", - "/properties/StatementId" - ], - "definitions": { - "Condition": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Events::EventBusPolicy", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Action": { - "type": "string" - }, - "Condition": { - "$ref": "#/definitions/Condition" - }, - "EventBusName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "Statement": { - "type": "object" - }, - "StatementId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "StatementId" - ], - "typeName": "AWS::Events::EventBusPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EventBusName", + "/properties/StatementId" + ], + "definitions": { + "Condition": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Events::EventBusPolicy", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Action": { + "type": "string" + }, + "Condition": { + "$ref": "#/definitions/Condition" + }, + "EventBusName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Principal": { + "type": "string" + }, + "Statement": { + "type": "object" + }, + "StatementId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "StatementId" + ], + "typeName": "AWS::Events::EventBusPolicy" +} diff --git a/schema/aws-events-rule.json b/schema/aws-events-rule.json index af8f655..0fb5698 100644 --- a/schema/aws-events-rule.json +++ b/schema/aws-events-rule.json @@ -1,589 +1,589 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/EventBusName" - ], - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AppSyncParameters": { - "additionalProperties": false, - "properties": { - "GraphQLOperation": { - "type": "string" - } - }, - "required": [ - "GraphQLOperation" - ], - "type": "object" - }, - "AwsVpcConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - }, - "SecurityGroups": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Subnets" - ], - "type": "object" - }, - "BatchArrayProperties": { - "additionalProperties": false, - "properties": { - "Size": { - "type": "integer" - } - }, - "type": "object" - }, - "BatchParameters": { - "additionalProperties": false, - "properties": { - "ArrayProperties": { - "$ref": "#/definitions/BatchArrayProperties" - }, - "JobDefinition": { - "type": "string" - }, - "JobName": { - "type": "string" - }, - "RetryStrategy": { - "$ref": "#/definitions/BatchRetryStrategy" - } - }, - "required": [ - "JobName", - "JobDefinition" - ], - "type": "object" - }, - "BatchRetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "type": "integer" - } - }, - "type": "object" - }, - "CapacityProviderStrategyItem": { - "additionalProperties": false, - "properties": { - "Base": { - "type": "integer" - }, - "CapacityProvider": { - "type": "string" - }, - "Weight": { - "type": "integer" - } - }, - "required": [ - "CapacityProvider" - ], - "type": "object" - }, - "DeadLetterConfig": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "EcsParameters": { - "additionalProperties": false, - "properties": { - "CapacityProviderStrategy": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CapacityProviderStrategyItem" - }, - "type": "array", - "uniqueItems": true - }, - "EnableECSManagedTags": { - "type": "boolean" - }, - "EnableExecuteCommand": { - "type": "boolean" - }, - "Group": { - "type": "string" - }, - "LaunchType": { - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "PlacementConstraints": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PlacementConstraint" - }, - "type": "array", - "uniqueItems": true - }, - "PlacementStrategies": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PlacementStrategy" - }, - "type": "array", - "uniqueItems": true - }, - "PlatformVersion": { - "type": "string" - }, - "PropagateTags": { - "type": "string" - }, - "ReferenceId": { - "type": "string" - }, - "TagList": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TaskCount": { - "type": "integer" - }, - "TaskDefinitionArn": { - "type": "string" - } - }, - "required": [ - "TaskDefinitionArn" - ], - "type": "object" - }, - "HttpParameters": { - "additionalProperties": false, - "properties": { - "HeaderParameters": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "PathParameterValues": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "QueryStringParameters": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "InputTransformer": { - "additionalProperties": false, - "properties": { - "InputPathsMap": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "InputTemplate": { - "type": "string" - } - }, - "required": [ - "InputTemplate" - ], - "type": "object" - }, - "KinesisParameters": { - "additionalProperties": false, - "properties": { - "PartitionKeyPath": { - "type": "string" - } - }, - "required": [ - "PartitionKeyPath" - ], - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AwsVpcConfiguration": { - "$ref": "#/definitions/AwsVpcConfiguration" - } - }, - "type": "object" - }, - "PlacementConstraint": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "PlacementStrategy": { - "additionalProperties": false, - "properties": { - "Field": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "RedshiftDataParameters": { - "additionalProperties": false, - "properties": { - "Database": { - "type": "string" - }, - "DbUser": { - "type": "string" - }, - "SecretManagerArn": { - "type": "string" - }, - "Sql": { - "type": "string" - }, - "Sqls": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StatementName": { - "type": "string" - }, - "WithEvent": { - "type": "boolean" - } - }, - "required": [ - "Database" - ], - "type": "object" - }, - "RetryPolicy": { - "additionalProperties": false, - "properties": { - "MaximumEventAgeInSeconds": { - "type": "integer" - }, - "MaximumRetryAttempts": { - "type": "integer" - } - }, - "type": "object" - }, - "RunCommandParameters": { - "additionalProperties": false, - "properties": { - "RunCommandTargets": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/RunCommandTarget" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "RunCommandTargets" - ], - "type": "object" - }, - "RunCommandTarget": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Values", - "Key" - ], - "type": "object" - }, - "SageMakerPipelineParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "SageMakerPipelineParameters": { - "additionalProperties": false, - "properties": { - "PipelineParameterList": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SageMakerPipelineParameter" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "SqsParameters": { - "additionalProperties": false, - "properties": { - "MessageGroupId": { - "type": "string" - } - }, - "required": [ - "MessageGroupId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "Target": { - "additionalProperties": false, - "properties": { - "AppSyncParameters": { - "$ref": "#/definitions/AppSyncParameters" - }, - "Arn": { - "type": "string" - }, - "BatchParameters": { - "$ref": "#/definitions/BatchParameters" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/DeadLetterConfig" - }, - "EcsParameters": { - "$ref": "#/definitions/EcsParameters" - }, - "HttpParameters": { - "$ref": "#/definitions/HttpParameters" - }, - "Id": { - "type": "string" - }, - "Input": { - "type": "string" - }, - "InputPath": { - "type": "string" - }, - "InputTransformer": { - "$ref": "#/definitions/InputTransformer" - }, - "KinesisParameters": { - "$ref": "#/definitions/KinesisParameters" - }, - "RedshiftDataParameters": { - "$ref": "#/definitions/RedshiftDataParameters" - }, - "RetryPolicy": { - "$ref": "#/definitions/RetryPolicy" - }, - "RoleArn": { - "type": "string" - }, - "RunCommandParameters": { - "$ref": "#/definitions/RunCommandParameters" - }, - "SageMakerPipelineParameters": { - "$ref": "#/definitions/SageMakerPipelineParameters" - }, - "SqsParameters": { - "$ref": "#/definitions/SqsParameters" - } - }, - "required": [ - "Id", - "Arn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Events::Rule", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "events:DescribeRule", - "events:PutRule", - "events:PutTargets" - ] - }, - "delete": { - "permissions": [ - "iam:PassRole", - "events:DescribeRule", - "events:DeleteRule", - "events:RemoveTargets", - "events:ListTargetsByRule" - ] - }, - "list": { - "permissions": [ - "events:ListRules" - ] - }, - "read": { - "permissions": [ - "iam:PassRole", - "events:DescribeRule", - "events:ListTargetsByRule" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "events:DescribeRule", - "events:PutRule", - "events:RemoveTargets", - "events:PutTargets" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.", - "type": "string" - }, - "Description": { - "description": "The description of the rule.", - "type": "string" - }, - "EventBusName": { - "description": "The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.", - "type": "string" - }, - "EventPattern": { - "description": "The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.", - "type": [ - "string", - "object" - ] - }, - "Name": { - "description": "The name of the rule.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the role that is used for target invocation.", - "type": "string" - }, - "ScheduleExpression": { - "description": "The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.", - "type": "string" - }, - "State": { - "description": "The state of the rule.", - "enum": [ - "DISABLED", - "ENABLED", - "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" - ], - "type": "string" - }, - "Targets": { - "description": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.\nTargets are the resources that are invoked when a rule is triggered.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Target" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Events::Rule" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/EventBusName" + ], + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AppSyncParameters": { + "additionalProperties": false, + "properties": { + "GraphQLOperation": { + "type": "string" + } + }, + "required": [ + "GraphQLOperation" + ], + "type": "object" + }, + "AwsVpcConfiguration": { + "additionalProperties": false, + "properties": { + "AssignPublicIp": { + "type": "string" + }, + "SecurityGroups": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Subnets" + ], + "type": "object" + }, + "BatchArrayProperties": { + "additionalProperties": false, + "properties": { + "Size": { + "type": "integer" + } + }, + "type": "object" + }, + "BatchParameters": { + "additionalProperties": false, + "properties": { + "ArrayProperties": { + "$ref": "#/definitions/BatchArrayProperties" + }, + "JobDefinition": { + "type": "string" + }, + "JobName": { + "type": "string" + }, + "RetryStrategy": { + "$ref": "#/definitions/BatchRetryStrategy" + } + }, + "required": [ + "JobName", + "JobDefinition" + ], + "type": "object" + }, + "BatchRetryStrategy": { + "additionalProperties": false, + "properties": { + "Attempts": { + "type": "integer" + } + }, + "type": "object" + }, + "CapacityProviderStrategyItem": { + "additionalProperties": false, + "properties": { + "Base": { + "type": "integer" + }, + "CapacityProvider": { + "type": "string" + }, + "Weight": { + "type": "integer" + } + }, + "required": [ + "CapacityProvider" + ], + "type": "object" + }, + "DeadLetterConfig": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + } + }, + "type": "object" + }, + "EcsParameters": { + "additionalProperties": false, + "properties": { + "CapacityProviderStrategy": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "type": "array", + "uniqueItems": true + }, + "EnableECSManagedTags": { + "type": "boolean" + }, + "EnableExecuteCommand": { + "type": "boolean" + }, + "Group": { + "type": "string" + }, + "LaunchType": { + "type": "string" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "PlacementConstraints": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PlacementConstraint" + }, + "type": "array", + "uniqueItems": true + }, + "PlacementStrategies": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PlacementStrategy" + }, + "type": "array", + "uniqueItems": true + }, + "PlatformVersion": { + "type": "string" + }, + "PropagateTags": { + "type": "string" + }, + "ReferenceId": { + "type": "string" + }, + "TagList": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TaskCount": { + "type": "integer" + }, + "TaskDefinitionArn": { + "type": "string" + } + }, + "required": [ + "TaskDefinitionArn" + ], + "type": "object" + }, + "HttpParameters": { + "additionalProperties": false, + "properties": { + "HeaderParameters": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "PathParameterValues": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "QueryStringParameters": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "InputTransformer": { + "additionalProperties": false, + "properties": { + "InputPathsMap": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "InputTemplate": { + "type": "string" + } + }, + "required": [ + "InputTemplate" + ], + "type": "object" + }, + "KinesisParameters": { + "additionalProperties": false, + "properties": { + "PartitionKeyPath": { + "type": "string" + } + }, + "required": [ + "PartitionKeyPath" + ], + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "properties": { + "AwsVpcConfiguration": { + "$ref": "#/definitions/AwsVpcConfiguration" + } + }, + "type": "object" + }, + "PlacementConstraint": { + "additionalProperties": false, + "properties": { + "Expression": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "PlacementStrategy": { + "additionalProperties": false, + "properties": { + "Field": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "RedshiftDataParameters": { + "additionalProperties": false, + "properties": { + "Database": { + "type": "string" + }, + "DbUser": { + "type": "string" + }, + "SecretManagerArn": { + "type": "string" + }, + "Sql": { + "type": "string" + }, + "Sqls": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StatementName": { + "type": "string" + }, + "WithEvent": { + "type": "boolean" + } + }, + "required": [ + "Database" + ], + "type": "object" + }, + "RetryPolicy": { + "additionalProperties": false, + "properties": { + "MaximumEventAgeInSeconds": { + "type": "integer" + }, + "MaximumRetryAttempts": { + "type": "integer" + } + }, + "type": "object" + }, + "RunCommandParameters": { + "additionalProperties": false, + "properties": { + "RunCommandTargets": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/RunCommandTarget" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "RunCommandTargets" + ], + "type": "object" + }, + "RunCommandTarget": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Values": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Values", + "Key" + ], + "type": "object" + }, + "SageMakerPipelineParameter": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "SageMakerPipelineParameters": { + "additionalProperties": false, + "properties": { + "PipelineParameterList": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SageMakerPipelineParameter" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "SqsParameters": { + "additionalProperties": false, + "properties": { + "MessageGroupId": { + "type": "string" + } + }, + "required": [ + "MessageGroupId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "Target": { + "additionalProperties": false, + "properties": { + "AppSyncParameters": { + "$ref": "#/definitions/AppSyncParameters" + }, + "Arn": { + "type": "string" + }, + "BatchParameters": { + "$ref": "#/definitions/BatchParameters" + }, + "DeadLetterConfig": { + "$ref": "#/definitions/DeadLetterConfig" + }, + "EcsParameters": { + "$ref": "#/definitions/EcsParameters" + }, + "HttpParameters": { + "$ref": "#/definitions/HttpParameters" + }, + "Id": { + "type": "string" + }, + "Input": { + "type": "string" + }, + "InputPath": { + "type": "string" + }, + "InputTransformer": { + "$ref": "#/definitions/InputTransformer" + }, + "KinesisParameters": { + "$ref": "#/definitions/KinesisParameters" + }, + "RedshiftDataParameters": { + "$ref": "#/definitions/RedshiftDataParameters" + }, + "RetryPolicy": { + "$ref": "#/definitions/RetryPolicy" + }, + "RoleArn": { + "type": "string" + }, + "RunCommandParameters": { + "$ref": "#/definitions/RunCommandParameters" + }, + "SageMakerPipelineParameters": { + "$ref": "#/definitions/SageMakerPipelineParameters" + }, + "SqsParameters": { + "$ref": "#/definitions/SqsParameters" + } + }, + "required": [ + "Id", + "Arn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Events::Rule", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "events:DescribeRule", + "events:PutRule", + "events:PutTargets" + ] + }, + "delete": { + "permissions": [ + "iam:PassRole", + "events:DescribeRule", + "events:DeleteRule", + "events:RemoveTargets", + "events:ListTargetsByRule" + ] + }, + "list": { + "permissions": [ + "events:ListRules" + ] + }, + "read": { + "permissions": [ + "iam:PassRole", + "events:DescribeRule", + "events:ListTargetsByRule" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "events:DescribeRule", + "events:PutRule", + "events:RemoveTargets", + "events:PutTargets" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.", + "type": "string" + }, + "Description": { + "description": "The description of the rule.", + "type": "string" + }, + "EventBusName": { + "description": "The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.", + "type": "string" + }, + "EventPattern": { + "description": "The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.", + "type": [ + "string", + "object" + ] + }, + "Name": { + "description": "The name of the rule.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the role that is used for target invocation.", + "type": "string" + }, + "ScheduleExpression": { + "description": "The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.", + "type": "string" + }, + "State": { + "description": "The state of the rule.", + "enum": [ + "DISABLED", + "ENABLED", + "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" + ], + "type": "string" + }, + "Targets": { + "description": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.\nTargets are the resources that are invoked when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Target" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Events::Rule" +} diff --git a/schema/aws-eventschemas-discoverer.json b/schema/aws-eventschemas-discoverer.json index a788d9d..c06d58a 100644 --- a/schema/aws-eventschemas-discoverer.json +++ b/schema/aws-eventschemas-discoverer.json @@ -1,123 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceArn" - ], - "definitions": { - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EventSchemas::Discoverer", - "handlers": { - "create": { - "permissions": [ - "schemas:CreateDiscoverer", - "schemas:DescribeDiscoverer", - "schemas:TagResource", - "events:PutRule", - "events:PutTargets", - "events:EnableRule", - "events:ListTargetsByRule", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "schemas:DescribeDiscoverer", - "schemas:DeleteDiscoverer", - "events:DeleteRule", - "events:DisableRule", - "events:RemoveTargets" - ] - }, - "list": { - "permissions": [ - "schemas:ListDiscoverers" - ] - }, - "read": { - "permissions": [ - "schemas:DescribeDiscoverer" - ] - }, - "update": { - "permissions": [ - "schemas:DescribeDiscoverer", - "schemas:UpdateDiscoverer", - "schemas:TagResource", - "schemas:UntagResource", - "schemas:ListTagsForResource", - "events:PutTargets", - "events:PutRule" - ] - } - }, - "primaryIdentifier": [ - "/properties/DiscovererArn" - ], - "properties": { - "CrossAccount": { - "default": true, - "description": "Defines whether event schemas from other accounts are discovered. Default is True.", - "type": "boolean" - }, - "Description": { - "description": "A description for the discoverer.", - "type": "string" - }, - "DiscovererArn": { - "description": "The ARN of the discoverer.", - "type": "string" - }, - "DiscovererId": { - "description": "The Id of the discoverer.", - "type": "string" - }, - "SourceArn": { - "description": "The ARN of the event bus.", - "type": "string" - }, - "State": { - "description": "Defines the current state of the discoverer.", - "type": "string" - }, - "Tags": { - "description": "Tags associated with the resource.", - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/DiscovererArn", - "/properties/DiscovererId", - "/properties/State" - ], - "required": [ - "SourceArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EventSchemas::Discoverer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceArn" + ], + "definitions": { + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EventSchemas::Discoverer", + "handlers": { + "create": { + "permissions": [ + "schemas:CreateDiscoverer", + "schemas:DescribeDiscoverer", + "schemas:TagResource", + "events:PutRule", + "events:PutTargets", + "events:EnableRule", + "events:ListTargetsByRule", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "schemas:DescribeDiscoverer", + "schemas:DeleteDiscoverer", + "events:DeleteRule", + "events:DisableRule", + "events:RemoveTargets" + ] + }, + "list": { + "permissions": [ + "schemas:ListDiscoverers" + ] + }, + "read": { + "permissions": [ + "schemas:DescribeDiscoverer" + ] + }, + "update": { + "permissions": [ + "schemas:DescribeDiscoverer", + "schemas:UpdateDiscoverer", + "schemas:TagResource", + "schemas:UntagResource", + "schemas:ListTagsForResource", + "events:PutTargets", + "events:PutRule" + ] + } + }, + "primaryIdentifier": [ + "/properties/DiscovererArn" + ], + "properties": { + "CrossAccount": { + "default": true, + "description": "Defines whether event schemas from other accounts are discovered. Default is True.", + "type": "boolean" + }, + "Description": { + "description": "A description for the discoverer.", + "type": "string" + }, + "DiscovererArn": { + "description": "The ARN of the discoverer.", + "type": "string" + }, + "DiscovererId": { + "description": "The Id of the discoverer.", + "type": "string" + }, + "SourceArn": { + "description": "The ARN of the event bus.", + "type": "string" + }, + "State": { + "description": "Defines the current state of the discoverer.", + "type": "string" + }, + "Tags": { + "description": "Tags associated with the resource.", + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/DiscovererArn", + "/properties/DiscovererId", + "/properties/State" + ], + "required": [ + "SourceArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EventSchemas::Discoverer" +} diff --git a/schema/aws-eventschemas-registry.json b/schema/aws-eventschemas-registry.json index 5b340f2..5cc5c4e 100644 --- a/schema/aws-eventschemas-registry.json +++ b/schema/aws-eventschemas-registry.json @@ -1,95 +1,95 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RegistryName" - ], - "definitions": { - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EventSchemas::Registry", - "handlers": { - "create": { - "permissions": [ - "schemas:DescribeRegistry", - "schemas:CreateRegistry", - "schemas:TagResource" - ] - }, - "delete": { - "permissions": [ - "schemas:DescribeRegistry", - "schemas:DeleteRegistry" - ] - }, - "list": { - "permissions": [ - "schemas:ListRegistries" - ] - }, - "read": { - "permissions": [ - "schemas:DescribeRegistry" - ] - }, - "update": { - "permissions": [ - "schemas:DescribeRegistry", - "schemas:UpdateRegistry", - "schemas:TagResource", - "schemas:UntagResource", - "schemas:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RegistryArn" - ], - "properties": { - "Description": { - "description": "A description of the registry to be created.", - "type": "string" - }, - "RegistryArn": { - "description": "The ARN of the registry.", - "type": "string" - }, - "RegistryName": { - "description": "The name of the schema registry.", - "type": "string" - }, - "Tags": { - "description": "Tags associated with the resource.", - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/RegistryArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EventSchemas::Registry" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RegistryName" + ], + "definitions": { + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EventSchemas::Registry", + "handlers": { + "create": { + "permissions": [ + "schemas:DescribeRegistry", + "schemas:CreateRegistry", + "schemas:TagResource" + ] + }, + "delete": { + "permissions": [ + "schemas:DescribeRegistry", + "schemas:DeleteRegistry" + ] + }, + "list": { + "permissions": [ + "schemas:ListRegistries" + ] + }, + "read": { + "permissions": [ + "schemas:DescribeRegistry" + ] + }, + "update": { + "permissions": [ + "schemas:DescribeRegistry", + "schemas:UpdateRegistry", + "schemas:TagResource", + "schemas:UntagResource", + "schemas:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RegistryArn" + ], + "properties": { + "Description": { + "description": "A description of the registry to be created.", + "type": "string" + }, + "RegistryArn": { + "description": "The ARN of the registry.", + "type": "string" + }, + "RegistryName": { + "description": "The name of the schema registry.", + "type": "string" + }, + "Tags": { + "description": "Tags associated with the resource.", + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/RegistryArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EventSchemas::Registry" +} diff --git a/schema/aws-eventschemas-registrypolicy.json b/schema/aws-eventschemas-registrypolicy.json index a6517c3..f3bbc2c 100644 --- a/schema/aws-eventschemas-registrypolicy.json +++ b/schema/aws-eventschemas-registrypolicy.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::EventSchemas::RegistryPolicy", - "handlers": { - "create": { - "permissions": [ - "schemas:PutResourcePolicy", - "schemas:GetResourcePolicy", - "schemas:DescribeRegistry" - ] - }, - "delete": { - "permissions": [ - "schemas:DeleteResourcePolicy", - "schemas:GetResourcePolicy" - ] - }, - "read": { - "permissions": [ - "schemas:GetResourcePolicy" - ] - }, - "update": { - "permissions": [ - "schemas:PutResourcePolicy", - "schemas:GetResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Policy": { - "type": "object" - }, - "RegistryName": { - "type": "string" - }, - "RevisionId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RegistryName", - "Policy" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::EventSchemas::RegistryPolicy" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::EventSchemas::RegistryPolicy", + "handlers": { + "create": { + "permissions": [ + "schemas:PutResourcePolicy", + "schemas:GetResourcePolicy", + "schemas:DescribeRegistry" + ] + }, + "delete": { + "permissions": [ + "schemas:DeleteResourcePolicy", + "schemas:GetResourcePolicy" + ] + }, + "read": { + "permissions": [ + "schemas:GetResourcePolicy" + ] + }, + "update": { + "permissions": [ + "schemas:PutResourcePolicy", + "schemas:GetResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Policy": { + "type": "object" + }, + "RegistryName": { + "type": "string" + }, + "RevisionId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RegistryName", + "Policy" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::EventSchemas::RegistryPolicy" +} diff --git a/schema/aws-eventschemas-schema.json b/schema/aws-eventschemas-schema.json index dbe0930..270e405 100644 --- a/schema/aws-eventschemas-schema.json +++ b/schema/aws-eventschemas-schema.json @@ -1,141 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SchemaName", - "/properties/RegistryName" - ], - "definitions": { - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::EventSchemas::Schema", - "handlers": { - "create": { - "permissions": [ - "schemas:DescribeSchema", - "schemas:CreateSchema", - "schemas:TagResource" - ] - }, - "delete": { - "permissions": [ - "schemas:DescribeSchema", - "schemas:DeleteSchema", - "schemas:DeleteSchemaVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RegistryName": { - "type": "string" - } - }, - "required": [ - "RegistryName" - ] - }, - "permissions": [ - "schemas:ListSchemas", - "schemas:ListSchemaVersions" - ] - }, - "read": { - "permissions": [ - "schemas:DescribeSchema" - ] - }, - "update": { - "permissions": [ - "schemas:DescribeSchema", - "schemas:UpdateSchema", - "schemas:TagResource", - "schemas:UntagResource", - "schemas:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SchemaArn" - ], - "properties": { - "Content": { - "description": "The source of the schema definition.", - "type": "string" - }, - "Description": { - "description": "A description of the schema.", - "type": "string" - }, - "LastModified": { - "description": "The last modified time of the schema.", - "type": "string" - }, - "RegistryName": { - "description": "The name of the schema registry.", - "type": "string" - }, - "SchemaArn": { - "description": "The ARN of the schema.", - "type": "string" - }, - "SchemaName": { - "description": "The name of the schema.", - "type": "string" - }, - "SchemaVersion": { - "description": "The version number of the schema.", - "type": "string" - }, - "Tags": { - "description": "Tags associated with the resource.", - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.", - "type": "string" - }, - "VersionCreatedDate": { - "description": "The date the schema version was created.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SchemaArn", - "/properties/LastModified", - "/properties/VersionCreatedDate", - "/properties/SchemaVersion" - ], - "required": [ - "Type", - "Content", - "RegistryName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eventschemas", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::EventSchemas::Schema" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SchemaName", + "/properties/RegistryName" + ], + "definitions": { + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::EventSchemas::Schema", + "handlers": { + "create": { + "permissions": [ + "schemas:DescribeSchema", + "schemas:CreateSchema", + "schemas:TagResource" + ] + }, + "delete": { + "permissions": [ + "schemas:DescribeSchema", + "schemas:DeleteSchema", + "schemas:DeleteSchemaVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RegistryName": { + "type": "string" + } + }, + "required": [ + "RegistryName" + ] + }, + "permissions": [ + "schemas:ListSchemas", + "schemas:ListSchemaVersions" + ] + }, + "read": { + "permissions": [ + "schemas:DescribeSchema" + ] + }, + "update": { + "permissions": [ + "schemas:DescribeSchema", + "schemas:UpdateSchema", + "schemas:TagResource", + "schemas:UntagResource", + "schemas:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SchemaArn" + ], + "properties": { + "Content": { + "description": "The source of the schema definition.", + "type": "string" + }, + "Description": { + "description": "A description of the schema.", + "type": "string" + }, + "LastModified": { + "description": "The last modified time of the schema.", + "type": "string" + }, + "RegistryName": { + "description": "The name of the schema registry.", + "type": "string" + }, + "SchemaArn": { + "description": "The ARN of the schema.", + "type": "string" + }, + "SchemaName": { + "description": "The name of the schema.", + "type": "string" + }, + "SchemaVersion": { + "description": "The version number of the schema.", + "type": "string" + }, + "Tags": { + "description": "Tags associated with the resource.", + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.", + "type": "string" + }, + "VersionCreatedDate": { + "description": "The date the schema version was created.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SchemaArn", + "/properties/LastModified", + "/properties/VersionCreatedDate", + "/properties/SchemaVersion" + ], + "required": [ + "Type", + "Content", + "RegistryName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eventschemas", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EventSchemas::Schema" +} diff --git a/schema/aws-evidently-experiment.json b/schema/aws-evidently-experiment.json index 2004051..4927c65 100644 --- a/schema/aws-evidently-experiment.json +++ b/schema/aws-evidently-experiment.json @@ -1,314 +1,314 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Project" - ], - "definitions": { - "MetricGoalObject": { - "additionalProperties": false, - "properties": { - "DesiredChange": { - "enum": [ - "INCREASE", - "DECREASE" - ], - "type": "string" - }, - "EntityIdKey": { - "description": "The JSON path to reference the entity id in the event.", - "type": "string" - }, - "EventPattern": { - "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.", - "type": "string" - }, - "MetricName": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[\\S]+$", - "type": "string" - }, - "UnitLabel": { - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "ValueKey": { - "description": "The JSON path to reference the numerical metric value in the event.", - "type": "string" - } - }, - "required": [ - "MetricName", - "EntityIdKey", - "ValueKey", - "DesiredChange" - ], - "type": "object" - }, - "OnlineAbConfigObject": { - "additionalProperties": false, - "properties": { - "ControlTreatmentName": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "TreatmentWeights": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TreatmentToWeight" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "RunningStatusObject": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "Status", - "AnalysisCompleteTime" - ] - }, - { - "required": [ - "Status", - "Reason", - "DesiredState" - ] - } - ], - "properties": { - "AnalysisCompleteTime": { - "description": "Provide the analysis Completion time for an experiment", - "type": "string" - }, - "DesiredState": { - "description": "Provide CANCELLED or COMPLETED desired state when stopping an experiment", - "pattern": "^(CANCELLED|COMPLETED)", - "type": "string" - }, - "Reason": { - "description": "Reason is a required input for stopping the experiment", - "type": "string" - }, - "Status": { - "description": "Provide START or STOP action to apply on an experiment", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TreatmentObject": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Feature": { - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:.*)", - "type": "string" - }, - "TreatmentName": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Variation": { - "maxLength": 255, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - } - }, - "required": [ - "TreatmentName", - "Feature", - "Variation" - ], - "type": "object" - }, - "TreatmentToWeight": { - "additionalProperties": false, - "properties": { - "SplitWeight": { - "maximum": 100000, - "minimum": 0, - "type": "integer" - }, - "Treatment": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - } - }, - "required": [ - "Treatment", - "SplitWeight" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Evidently::Experiment.", - "handlers": { - "create": { - "permissions": [ - "evidently:CreateExperiment", - "evidently:TagResource", - "evidently:GetExperiment", - "evidently:StartExperiment" - ] - }, - "delete": { - "permissions": [ - "evidently:DeleteExperiment", - "evidently:UntagResource", - "evidently:GetExperiment" - ] - }, - "read": { - "permissions": [ - "evidently:GetExperiment", - "evidently:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "evidently:UpdateExperiment", - "evidently:TagResource", - "evidently:UntagResource", - "evidently:GetExperiment", - "evidently:StartExperiment", - "evidently:StopExperiment" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/experiment/[-a-zA-Z0-9._]*", - "type": "string" - }, - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "MetricGoals": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricGoalObject" - }, - "maxItems": 3, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "OnlineAbConfig": { - "$ref": "#/definitions/OnlineAbConfigObject" - }, - "Project": { - "maxLength": 2048, - "minLength": 0, - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", - "type": "string" - }, - "RandomizationSalt": { - "maxLength": 127, - "minLength": 0, - "pattern": ".*", - "type": "string" - }, - "RemoveSegment": { - "type": "boolean" - }, - "RunningStatus": { - "$ref": "#/definitions/RunningStatusObject", - "description": "Start Experiment. Default is False" - }, - "SamplingRate": { - "maximum": 100000, - "minimum": 0, - "type": "integer" - }, - "Segment": { - "maxLength": 2048, - "minLength": 0, - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*)", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Treatments": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TreatmentObject" - }, - "maxItems": 5, - "minItems": 2, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Project", - "Treatments", - "MetricGoals", - "OnlineAbConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", - "taggable": true, - "typeName": "AWS::Evidently::Experiment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Project" + ], + "definitions": { + "MetricGoalObject": { + "additionalProperties": false, + "properties": { + "DesiredChange": { + "enum": [ + "INCREASE", + "DECREASE" + ], + "type": "string" + }, + "EntityIdKey": { + "description": "The JSON path to reference the entity id in the event.", + "type": "string" + }, + "EventPattern": { + "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.", + "type": "string" + }, + "MetricName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[\\S]+$", + "type": "string" + }, + "UnitLabel": { + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "ValueKey": { + "description": "The JSON path to reference the numerical metric value in the event.", + "type": "string" + } + }, + "required": [ + "MetricName", + "EntityIdKey", + "ValueKey", + "DesiredChange" + ], + "type": "object" + }, + "OnlineAbConfigObject": { + "additionalProperties": false, + "properties": { + "ControlTreatmentName": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "TreatmentWeights": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TreatmentToWeight" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "RunningStatusObject": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "Status", + "AnalysisCompleteTime" + ] + }, + { + "required": [ + "Status", + "Reason", + "DesiredState" + ] + } + ], + "properties": { + "AnalysisCompleteTime": { + "description": "Provide the analysis Completion time for an experiment", + "type": "string" + }, + "DesiredState": { + "description": "Provide CANCELLED or COMPLETED desired state when stopping an experiment", + "pattern": "^(CANCELLED|COMPLETED)", + "type": "string" + }, + "Reason": { + "description": "Reason is a required input for stopping the experiment", + "type": "string" + }, + "Status": { + "description": "Provide START or STOP action to apply on an experiment", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TreatmentObject": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Feature": { + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:.*)", + "type": "string" + }, + "TreatmentName": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Variation": { + "maxLength": 255, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + } + }, + "required": [ + "TreatmentName", + "Feature", + "Variation" + ], + "type": "object" + }, + "TreatmentToWeight": { + "additionalProperties": false, + "properties": { + "SplitWeight": { + "maximum": 100000, + "minimum": 0, + "type": "integer" + }, + "Treatment": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + } + }, + "required": [ + "Treatment", + "SplitWeight" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Evidently::Experiment.", + "handlers": { + "create": { + "permissions": [ + "evidently:CreateExperiment", + "evidently:TagResource", + "evidently:GetExperiment", + "evidently:StartExperiment" + ] + }, + "delete": { + "permissions": [ + "evidently:DeleteExperiment", + "evidently:UntagResource", + "evidently:GetExperiment" + ] + }, + "read": { + "permissions": [ + "evidently:GetExperiment", + "evidently:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "evidently:UpdateExperiment", + "evidently:TagResource", + "evidently:UntagResource", + "evidently:GetExperiment", + "evidently:StartExperiment", + "evidently:StopExperiment" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/experiment/[-a-zA-Z0-9._]*", + "type": "string" + }, + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "MetricGoals": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricGoalObject" + }, + "maxItems": 3, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "OnlineAbConfig": { + "$ref": "#/definitions/OnlineAbConfigObject" + }, + "Project": { + "maxLength": 2048, + "minLength": 0, + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", + "type": "string" + }, + "RandomizationSalt": { + "maxLength": 127, + "minLength": 0, + "pattern": ".*", + "type": "string" + }, + "RemoveSegment": { + "type": "boolean" + }, + "RunningStatus": { + "$ref": "#/definitions/RunningStatusObject", + "description": "Start Experiment. Default is False" + }, + "SamplingRate": { + "maximum": 100000, + "minimum": 0, + "type": "integer" + }, + "Segment": { + "maxLength": 2048, + "minLength": 0, + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*)", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Treatments": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TreatmentObject" + }, + "maxItems": 5, + "minItems": 2, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Project", + "Treatments", + "MetricGoals", + "OnlineAbConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", + "taggable": true, + "typeName": "AWS::Evidently::Experiment" +} diff --git a/schema/aws-evidently-feature.json b/schema/aws-evidently-feature.json index ff69c15..79f9989 100644 --- a/schema/aws-evidently-feature.json +++ b/schema/aws-evidently-feature.json @@ -1,213 +1,213 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Project" - ], - "definitions": { - "EntityOverride": { - "additionalProperties": false, - "properties": { - "EntityId": { - "type": "string" - }, - "Variation": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VariationObject": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "VariationName", - "StringValue" - ] - }, - { - "required": [ - "VariationName", - "BooleanValue" - ] - }, - { - "required": [ - "VariationName", - "LongValue" - ] - }, - { - "required": [ - "VariationName", - "DoubleValue" - ] - } - ], - "properties": { - "BooleanValue": { - "type": "boolean" - }, - "DoubleValue": { - "type": "number" - }, - "LongValue": { - "type": "number" - }, - "StringValue": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "VariationName": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Evidently::Feature.", - "handlers": { - "create": { - "permissions": [ - "evidently:CreateFeature", - "evidently:TagResource", - "evidently:GetFeature" - ] - }, - "delete": { - "permissions": [ - "evidently:DeleteFeature", - "evidently:UntagResource", - "evidently:GetFeature" - ] - }, - "read": { - "permissions": [ - "evidently:GetFeature", - "evidently:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "evidently:UpdateFeature", - "evidently:ListTagsForResource", - "evidently:TagResource", - "evidently:UntagResource", - "evidently:GetFeature" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 0, - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/feature/[-a-zA-Z0-9._]*", - "type": "string" - }, - "DefaultVariation": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "EntityOverrides": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EntityOverride" - }, - "maxItems": 2500, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "EvaluationStrategy": { - "enum": [ - "ALL_RULES", - "DEFAULT_VARIATION" - ], - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Project": { - "maxLength": 2048, - "minLength": 0, - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Variations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/VariationObject" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Project", - "Variations" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", - "taggable": true, - "typeName": "AWS::Evidently::Feature" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Project" + ], + "definitions": { + "EntityOverride": { + "additionalProperties": false, + "properties": { + "EntityId": { + "type": "string" + }, + "Variation": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VariationObject": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "VariationName", + "StringValue" + ] + }, + { + "required": [ + "VariationName", + "BooleanValue" + ] + }, + { + "required": [ + "VariationName", + "LongValue" + ] + }, + { + "required": [ + "VariationName", + "DoubleValue" + ] + } + ], + "properties": { + "BooleanValue": { + "type": "boolean" + }, + "DoubleValue": { + "type": "number" + }, + "LongValue": { + "type": "number" + }, + "StringValue": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "VariationName": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Evidently::Feature.", + "handlers": { + "create": { + "permissions": [ + "evidently:CreateFeature", + "evidently:TagResource", + "evidently:GetFeature" + ] + }, + "delete": { + "permissions": [ + "evidently:DeleteFeature", + "evidently:UntagResource", + "evidently:GetFeature" + ] + }, + "read": { + "permissions": [ + "evidently:GetFeature", + "evidently:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "evidently:UpdateFeature", + "evidently:ListTagsForResource", + "evidently:TagResource", + "evidently:UntagResource", + "evidently:GetFeature" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 0, + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/feature/[-a-zA-Z0-9._]*", + "type": "string" + }, + "DefaultVariation": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "EntityOverrides": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EntityOverride" + }, + "maxItems": 2500, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "EvaluationStrategy": { + "enum": [ + "ALL_RULES", + "DEFAULT_VARIATION" + ], + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Project": { + "maxLength": 2048, + "minLength": 0, + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Variations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/VariationObject" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Project", + "Variations" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", + "taggable": true, + "typeName": "AWS::Evidently::Feature" +} diff --git a/schema/aws-evidently-launch.json b/schema/aws-evidently-launch.json index c0c5be3..52d61ab 100644 --- a/schema/aws-evidently-launch.json +++ b/schema/aws-evidently-launch.json @@ -1,315 +1,315 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Project" - ], - "definitions": { - "ExecutionStatusObject": { - "additionalProperties": false, - "properties": { - "DesiredState": { - "description": "Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.", - "type": "string" - }, - "Reason": { - "description": "Provide a reason for stopping the launch. Defaults to empty if not provided.", - "type": "string" - }, - "Status": { - "description": "Provide START or STOP action to apply on a launch", - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "GroupToWeight": { - "additionalProperties": false, - "properties": { - "GroupName": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "SplitWeight": { - "type": "integer" - } - }, - "required": [ - "GroupName", - "SplitWeight" - ], - "type": "object" - }, - "LaunchGroupObject": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "Feature": { - "type": "string" - }, - "GroupName": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Variation": { - "type": "string" - } - }, - "required": [ - "GroupName", - "Feature", - "Variation" - ], - "type": "object" - }, - "MetricDefinitionObject": { - "additionalProperties": false, - "properties": { - "EntityIdKey": { - "description": "The JSON path to reference the entity id in the event.", - "type": "string" - }, - "EventPattern": { - "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.", - "type": "string" - }, - "MetricName": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[\\S]+$", - "type": "string" - }, - "UnitLabel": { - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "ValueKey": { - "description": "The JSON path to reference the numerical metric value in the event.", - "type": "string" - } - }, - "required": [ - "MetricName", - "EntityIdKey", - "ValueKey" - ], - "type": "object" - }, - "SegmentOverride": { - "additionalProperties": false, - "properties": { - "EvaluationOrder": { - "type": "integer" - }, - "Segment": { - "maxLength": 2048, - "minLength": 1, - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*)", - "type": "string" - }, - "Weights": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/GroupToWeight" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Segment", - "EvaluationOrder", - "Weights" - ], - "type": "object" - }, - "StepConfig": { - "additionalProperties": false, - "properties": { - "GroupWeights": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/GroupToWeight" - }, - "type": "array", - "uniqueItems": true - }, - "SegmentOverrides": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SegmentOverride" - }, - "type": "array", - "uniqueItems": true - }, - "StartTime": { - "type": "string" - } - }, - "required": [ - "StartTime", - "GroupWeights" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Evidently::Launch.", - "handlers": { - "create": { - "permissions": [ - "evidently:CreateLaunch", - "evidently:TagResource", - "evidently:GetLaunch", - "evidently:StartLaunch" - ] - }, - "delete": { - "permissions": [ - "evidently:DeleteLaunch", - "evidently:UntagResource", - "evidently:GetLaunch" - ] - }, - "read": { - "permissions": [ - "evidently:GetLaunch", - "evidently:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "evidently:UpdateLaunch", - "evidently:ListTagsForResource", - "evidently:TagResource", - "evidently:UntagResource", - "evidently:GetLaunch", - "evidently:StartLaunch", - "evidently:StopLaunch" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/launch/[-a-zA-Z0-9._]*", - "type": "string" - }, - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "ExecutionStatus": { - "$ref": "#/definitions/ExecutionStatusObject", - "description": "Start or Stop Launch Launch. Default is not started." - }, - "Groups": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LaunchGroupObject" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "MetricMonitors": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricDefinitionObject" - }, - "maxItems": 3, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Project": { - "maxLength": 2048, - "minLength": 0, - "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", - "type": "string" - }, - "RandomizationSalt": { - "maxLength": 127, - "minLength": 0, - "pattern": ".*", - "type": "string" - }, - "ScheduledSplitsConfig": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StepConfig" - }, - "maxItems": 6, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Project", - "Groups", - "ScheduledSplitsConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", - "taggable": true, - "typeName": "AWS::Evidently::Launch" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Project" + ], + "definitions": { + "ExecutionStatusObject": { + "additionalProperties": false, + "properties": { + "DesiredState": { + "description": "Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.", + "type": "string" + }, + "Reason": { + "description": "Provide a reason for stopping the launch. Defaults to empty if not provided.", + "type": "string" + }, + "Status": { + "description": "Provide START or STOP action to apply on a launch", + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "GroupToWeight": { + "additionalProperties": false, + "properties": { + "GroupName": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "SplitWeight": { + "type": "integer" + } + }, + "required": [ + "GroupName", + "SplitWeight" + ], + "type": "object" + }, + "LaunchGroupObject": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "Feature": { + "type": "string" + }, + "GroupName": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Variation": { + "type": "string" + } + }, + "required": [ + "GroupName", + "Feature", + "Variation" + ], + "type": "object" + }, + "MetricDefinitionObject": { + "additionalProperties": false, + "properties": { + "EntityIdKey": { + "description": "The JSON path to reference the entity id in the event.", + "type": "string" + }, + "EventPattern": { + "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.", + "type": "string" + }, + "MetricName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[\\S]+$", + "type": "string" + }, + "UnitLabel": { + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "ValueKey": { + "description": "The JSON path to reference the numerical metric value in the event.", + "type": "string" + } + }, + "required": [ + "MetricName", + "EntityIdKey", + "ValueKey" + ], + "type": "object" + }, + "SegmentOverride": { + "additionalProperties": false, + "properties": { + "EvaluationOrder": { + "type": "integer" + }, + "Segment": { + "maxLength": 2048, + "minLength": 1, + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*)", + "type": "string" + }, + "Weights": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/GroupToWeight" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Segment", + "EvaluationOrder", + "Weights" + ], + "type": "object" + }, + "StepConfig": { + "additionalProperties": false, + "properties": { + "GroupWeights": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/GroupToWeight" + }, + "type": "array", + "uniqueItems": true + }, + "SegmentOverrides": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SegmentOverride" + }, + "type": "array", + "uniqueItems": true + }, + "StartTime": { + "type": "string" + } + }, + "required": [ + "StartTime", + "GroupWeights" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Evidently::Launch.", + "handlers": { + "create": { + "permissions": [ + "evidently:CreateLaunch", + "evidently:TagResource", + "evidently:GetLaunch", + "evidently:StartLaunch" + ] + }, + "delete": { + "permissions": [ + "evidently:DeleteLaunch", + "evidently:UntagResource", + "evidently:GetLaunch" + ] + }, + "read": { + "permissions": [ + "evidently:GetLaunch", + "evidently:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "evidently:UpdateLaunch", + "evidently:ListTagsForResource", + "evidently:TagResource", + "evidently:UntagResource", + "evidently:GetLaunch", + "evidently:StartLaunch", + "evidently:StopLaunch" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/launch/[-a-zA-Z0-9._]*", + "type": "string" + }, + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "ExecutionStatus": { + "$ref": "#/definitions/ExecutionStatusObject", + "description": "Start or Stop Launch Launch. Default is not started." + }, + "Groups": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LaunchGroupObject" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MetricMonitors": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricDefinitionObject" + }, + "maxItems": 3, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Project": { + "maxLength": 2048, + "minLength": 0, + "pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)", + "type": "string" + }, + "RandomizationSalt": { + "maxLength": 127, + "minLength": 0, + "pattern": ".*", + "type": "string" + }, + "ScheduledSplitsConfig": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StepConfig" + }, + "maxItems": 6, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Project", + "Groups", + "ScheduledSplitsConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", + "taggable": true, + "typeName": "AWS::Evidently::Launch" +} diff --git a/schema/aws-evidently-project.json b/schema/aws-evidently-project.json index 877ebd6..83351b3 100644 --- a/schema/aws-evidently-project.json +++ b/schema/aws-evidently-project.json @@ -1,222 +1,222 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AppConfigResourceObject": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "pattern": "[a-z0-9]{4,7}", - "type": "string" - }, - "EnvironmentId": { - "pattern": "[a-z0-9]{4,7}", - "type": "string" - } - }, - "required": [ - "ApplicationId", - "EnvironmentId" - ], - "type": "object" - }, - "DataDeliveryObject": { - "additionalProperties": false, - "description": "Destinations for data.", - "oneOf": [ - { - "required": [ - "S3" - ] - }, - { - "required": [ - "LogGroup" - ] - } - ], - "properties": { - "LogGroup": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[-a-zA-Z0-9._/]+$", - "type": "string" - }, - "S3": { - "$ref": "#/definitions/S3Destination" - } - }, - "type": "object" - }, - "S3Destination": { - "additionalProperties": false, - "properties": { - "BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][-a-z0-9]*[a-z0-9]$", - "type": "string" - }, - "Prefix": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^[-a-zA-Z0-9!_.*'()/]*$", - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Evidently::Project", - "handlers": { - "create": { - "permissions": [ - "evidently:CreateProject", - "evidently:GetProject", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "evidently:TagResource", - "evidently:ExportProjectAsConfiguration", - "appconfig:GetEnvironment", - "appconfig:CreateConfigurationProfile", - "appconfig:CreateHostedConfigurationVersion", - "appconfig:CreateExtensionAssociation", - "appconfig:TagResource", - "iam:GetRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "evidently:DeleteProject", - "evidently:GetProject", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "s3:GetBucketPolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "evidently:UntagResource", - "appconfig:DeleteHostedConfigurationVersion", - "appconfig:DeleteExtensionAssociation", - "appconfig:DeleteConfigurationProfile" - ] - }, - "read": { - "permissions": [ - "evidently:GetProject", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "s3:GetBucketPolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "evidently:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "evidently:UpdateProject", - "evidently:UpdateProjectDataDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "evidently:TagResource", - "evidently:UntagResource", - "evidently:ListTagsForResource", - "evidently:GetProject", - "evidently:ExportProjectAsConfiguration", - "appconfig:GetEnvironment", - "appconfig:CreateConfigurationProfile", - "appconfig:CreateHostedConfigurationVersion", - "appconfig:CreateExtensionAssociation", - "appconfig:TagResource", - "iam:GetRole", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AppConfigResource": { - "$ref": "#/definitions/AppConfigResourceObject" - }, - "Arn": { - "maxLength": 2048, - "minLength": 0, - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*", - "type": "string" - }, - "DataDelivery": { - "$ref": "#/definitions/DataDeliveryObject" - }, - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", - "taggable": true, - "typeName": "AWS::Evidently::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AppConfigResourceObject": { + "additionalProperties": false, + "properties": { + "ApplicationId": { + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "EnvironmentId": { + "pattern": "[a-z0-9]{4,7}", + "type": "string" + } + }, + "required": [ + "ApplicationId", + "EnvironmentId" + ], + "type": "object" + }, + "DataDeliveryObject": { + "additionalProperties": false, + "description": "Destinations for data.", + "oneOf": [ + { + "required": [ + "S3" + ] + }, + { + "required": [ + "LogGroup" + ] + } + ], + "properties": { + "LogGroup": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[-a-zA-Z0-9._/]+$", + "type": "string" + }, + "S3": { + "$ref": "#/definitions/S3Destination" + } + }, + "type": "object" + }, + "S3Destination": { + "additionalProperties": false, + "properties": { + "BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][-a-z0-9]*[a-z0-9]$", + "type": "string" + }, + "Prefix": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^[-a-zA-Z0-9!_.*'()/]*$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Evidently::Project", + "handlers": { + "create": { + "permissions": [ + "evidently:CreateProject", + "evidently:GetProject", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "evidently:TagResource", + "evidently:ExportProjectAsConfiguration", + "appconfig:GetEnvironment", + "appconfig:CreateConfigurationProfile", + "appconfig:CreateHostedConfigurationVersion", + "appconfig:CreateExtensionAssociation", + "appconfig:TagResource", + "iam:GetRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "evidently:DeleteProject", + "evidently:GetProject", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "s3:GetBucketPolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "evidently:UntagResource", + "appconfig:DeleteHostedConfigurationVersion", + "appconfig:DeleteExtensionAssociation", + "appconfig:DeleteConfigurationProfile" + ] + }, + "read": { + "permissions": [ + "evidently:GetProject", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "s3:GetBucketPolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "evidently:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "evidently:UpdateProject", + "evidently:UpdateProjectDataDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "evidently:TagResource", + "evidently:UntagResource", + "evidently:ListTagsForResource", + "evidently:GetProject", + "evidently:ExportProjectAsConfiguration", + "appconfig:GetEnvironment", + "appconfig:CreateConfigurationProfile", + "appconfig:CreateHostedConfigurationVersion", + "appconfig:CreateExtensionAssociation", + "appconfig:TagResource", + "iam:GetRole", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AppConfigResource": { + "$ref": "#/definitions/AppConfigResourceObject" + }, + "Arn": { + "maxLength": 2048, + "minLength": 0, + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*", + "type": "string" + }, + "DataDelivery": { + "$ref": "#/definitions/DataDeliveryObject" + }, + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", + "taggable": true, + "typeName": "AWS::Evidently::Project" +} diff --git a/schema/aws-evidently-segment.json b/schema/aws-evidently-segment.json index cc3eaeb..f3d2d00 100644 --- a/schema/aws-evidently-segment.json +++ b/schema/aws-evidently-segment.json @@ -1,109 +1,109 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Evidently::Segment", - "handlers": { - "create": { - "permissions": [ - "evidently:CreateSegment", - "evidently:GetSegment", - "evidently:TagResource" - ] - }, - "delete": { - "permissions": [ - "evidently:DeleteSegment", - "evidently:GetSegment", - "evidently:UntagResource" - ] - }, - "list": { - "permissions": [ - "evidently:ListSegment", - "evidently:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "evidently:GetSegment", - "evidently:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 0, - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*", - "type": "string" - }, - "Description": { - "maxLength": 160, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "pattern": "[-a-zA-Z0-9._]*", - "type": "string" - }, - "Pattern": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Evidently::Segment" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Evidently::Segment", + "handlers": { + "create": { + "permissions": [ + "evidently:CreateSegment", + "evidently:GetSegment", + "evidently:TagResource" + ] + }, + "delete": { + "permissions": [ + "evidently:DeleteSegment", + "evidently:GetSegment", + "evidently:UntagResource" + ] + }, + "list": { + "permissions": [ + "evidently:ListSegment", + "evidently:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "evidently:GetSegment", + "evidently:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 0, + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*", + "type": "string" + }, + "Description": { + "maxLength": 160, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "pattern": "[-a-zA-Z0-9._]*", + "type": "string" + }, + "Pattern": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Evidently::Segment" +} diff --git a/schema/aws-finspace-environment.json b/schema/aws-finspace-environment.json index 36326ed..5f26caf 100644 --- a/schema/aws-finspace-environment.json +++ b/schema/aws-finspace-environment.json @@ -1,284 +1,284 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/SuperuserParameters", - "/properties/FederationParameters", - "/properties/DataBundles", - "/properties/Tags" - ], - "definitions": { - "DataBundleArn": { - "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "FederationParameters": { - "additionalProperties": false, - "description": "Additional parameters to identify Federation mode", - "properties": { - "ApplicationCallBackURL": { - "description": "SAML metadata URL to link with the Environment", - "pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", - "type": "string" - }, - "AttributeMap": { - "description": "Attribute map for SAML configuration", - "insertionOrder": false, - "items": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "type": "array", - "uniqueItems": false - }, - "FederationProviderName": { - "description": "Federation provider name to link with the Environment", - "maxLength": 32, - "minLength": 1, - "pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+", - "type": "string" - }, - "FederationURN": { - "description": "SAML metadata URL to link with the Environment", - "type": "string" - }, - "SamlMetadataDocument": { - "description": "SAML metadata document to link the federation provider to the Environment", - "maxLength": 10000000, - "minLength": 1000, - "pattern": ".*", - "type": "string" - }, - "SamlMetadataURL": { - "description": "SAML metadata URL to link with the Environment", - "pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", - "type": "string" - } - }, - "type": "object" - }, - "SuperuserParameters": { - "additionalProperties": false, - "description": "Parameters of the first Superuser for the FinSpace Environment", - "properties": { - "EmailAddress": { - "description": "Email address", - "maxLength": 128, - "minLength": 1, - "pattern": "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+", - "type": "string" - }, - "FirstName": { - "description": "First name", - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]{1,50}$", - "type": "string" - }, - "LastName": { - "description": "Last name", - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]{1,50}$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A list of all tags for a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/DataBundles" - ], - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "finspace:CreateEnvironment", - "finspace:GetEnvironment", - "finspace:ListEnvironments", - "sts:AssumeRole" - ] - }, - "delete": { - "permissions": [ - "finspace:DeleteEnvironment", - "finspace:GetEnvironment" - ] - }, - "list": { - "permissions": [ - "finspace:ListEnvironments" - ] - }, - "read": { - "permissions": [ - "finspace:GetEnvironment" - ] - }, - "update": { - "permissions": [ - "finspace:UpdateEnvironment" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentId" - ], - "properties": { - "AwsAccountId": { - "description": "AWS account ID associated with the Environment", - "pattern": "^[a-zA-Z0-9]{1,26}$", - "type": "string" - }, - "DataBundles": { - "description": "ARNs of FinSpace Data Bundles to install", - "items": { - "$ref": "#/definitions/DataBundleArn" - }, - "type": "array", - "uniqueItems": false - }, - "DedicatedServiceAccountId": { - "description": "ID for FinSpace created account used to store Environment artifacts", - "pattern": "^[a-zA-Z0-9]{1,26}$", - "type": "string" - }, - "Description": { - "description": "Description of the Environment", - "pattern": "^[a-zA-Z0-9. ]{1,1000}$", - "type": "string" - }, - "EnvironmentArn": { - "description": "ARN of the Environment", - "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "EnvironmentId": { - "description": "Unique identifier for representing FinSpace Environment", - "pattern": "^[a-zA-Z0-9]{1,26}$", - "type": "string" - }, - "EnvironmentUrl": { - "description": "URL used to login to the Environment", - "pattern": "^[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", - "type": "string" - }, - "FederationMode": { - "description": "Federation mode used with the Environment", - "enum": [ - "LOCAL", - "FEDERATED" - ], - "type": "string" - }, - "FederationParameters": { - "$ref": "#/definitions/FederationParameters" - }, - "KmsKeyId": { - "description": "KMS key used to encrypt customer data within FinSpace Environment infrastructure", - "pattern": "^[a-zA-Z-0-9-:\\/]*{1,1000}$", - "type": "string" - }, - "Name": { - "description": "Name of the Environment", - "pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]{1,255}$", - "type": "string" - }, - "SageMakerStudioDomainUrl": { - "description": "SageMaker Studio Domain URL associated with the Environment", - "pattern": "^[a-zA-Z-0-9-:\\/.]*{1,1000}$", - "type": "string" - }, - "Status": { - "description": "State of the Environment", - "enum": [ - "CREATE_REQUESTED", - "CREATING", - "CREATED", - "DELETE_REQUESTED", - "DELETING", - "DELETED", - "FAILED_CREATION", - "FAILED_DELETION", - "RETRY_DELETION", - "SUSPENDED" - ], - "type": "string" - }, - "SuperuserParameters": { - "$ref": "#/definitions/SuperuserParameters" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/EnvironmentId", - "/properties/Status", - "/properties/SageMakerStudioDomainUrl", - "/properties/EnvironmentArn", - "/properties/EnvironmentUrl", - "/properties/AwsAccountId", - "/properties/DedicatedServiceAccountId" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::FinSpace::Environment", - "writeOnlyProperties": [ - "/properties/SuperuserParameters", - "/properties/FederationParameters/AttributeMap", - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/SuperuserParameters", + "/properties/FederationParameters", + "/properties/DataBundles", + "/properties/Tags" + ], + "definitions": { + "DataBundleArn": { + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "FederationParameters": { + "additionalProperties": false, + "description": "Additional parameters to identify Federation mode", + "properties": { + "ApplicationCallBackURL": { + "description": "SAML metadata URL to link with the Environment", + "pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", + "type": "string" + }, + "AttributeMap": { + "description": "Attribute map for SAML configuration", + "insertionOrder": false, + "items": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "type": "array", + "uniqueItems": false + }, + "FederationProviderName": { + "description": "Federation provider name to link with the Environment", + "maxLength": 32, + "minLength": 1, + "pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+", + "type": "string" + }, + "FederationURN": { + "description": "SAML metadata URL to link with the Environment", + "type": "string" + }, + "SamlMetadataDocument": { + "description": "SAML metadata document to link the federation provider to the Environment", + "maxLength": 10000000, + "minLength": 1000, + "pattern": ".*", + "type": "string" + }, + "SamlMetadataURL": { + "description": "SAML metadata URL to link with the Environment", + "pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", + "type": "string" + } + }, + "type": "object" + }, + "SuperuserParameters": { + "additionalProperties": false, + "description": "Parameters of the first Superuser for the FinSpace Environment", + "properties": { + "EmailAddress": { + "description": "Email address", + "maxLength": 128, + "minLength": 1, + "pattern": "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+", + "type": "string" + }, + "FirstName": { + "description": "First name", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]{1,50}$", + "type": "string" + }, + "LastName": { + "description": "Last name", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]{1,50}$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A list of all tags for a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/DataBundles" + ], + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "finspace:CreateEnvironment", + "finspace:GetEnvironment", + "finspace:ListEnvironments", + "sts:AssumeRole" + ] + }, + "delete": { + "permissions": [ + "finspace:DeleteEnvironment", + "finspace:GetEnvironment" + ] + }, + "list": { + "permissions": [ + "finspace:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "finspace:GetEnvironment" + ] + }, + "update": { + "permissions": [ + "finspace:UpdateEnvironment" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentId" + ], + "properties": { + "AwsAccountId": { + "description": "AWS account ID associated with the Environment", + "pattern": "^[a-zA-Z0-9]{1,26}$", + "type": "string" + }, + "DataBundles": { + "description": "ARNs of FinSpace Data Bundles to install", + "items": { + "$ref": "#/definitions/DataBundleArn" + }, + "type": "array", + "uniqueItems": false + }, + "DedicatedServiceAccountId": { + "description": "ID for FinSpace created account used to store Environment artifacts", + "pattern": "^[a-zA-Z0-9]{1,26}$", + "type": "string" + }, + "Description": { + "description": "Description of the Environment", + "pattern": "^[a-zA-Z0-9. ]{1,1000}$", + "type": "string" + }, + "EnvironmentArn": { + "description": "ARN of the Environment", + "pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "EnvironmentId": { + "description": "Unique identifier for representing FinSpace Environment", + "pattern": "^[a-zA-Z0-9]{1,26}$", + "type": "string" + }, + "EnvironmentUrl": { + "description": "URL used to login to the Environment", + "pattern": "^[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}", + "type": "string" + }, + "FederationMode": { + "description": "Federation mode used with the Environment", + "enum": [ + "LOCAL", + "FEDERATED" + ], + "type": "string" + }, + "FederationParameters": { + "$ref": "#/definitions/FederationParameters" + }, + "KmsKeyId": { + "description": "KMS key used to encrypt customer data within FinSpace Environment infrastructure", + "pattern": "^[a-zA-Z-0-9-:\\/]*{1,1000}$", + "type": "string" + }, + "Name": { + "description": "Name of the Environment", + "pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]{1,255}$", + "type": "string" + }, + "SageMakerStudioDomainUrl": { + "description": "SageMaker Studio Domain URL associated with the Environment", + "pattern": "^[a-zA-Z-0-9-:\\/.]*{1,1000}$", + "type": "string" + }, + "Status": { + "description": "State of the Environment", + "enum": [ + "CREATE_REQUESTED", + "CREATING", + "CREATED", + "DELETE_REQUESTED", + "DELETING", + "DELETED", + "FAILED_CREATION", + "FAILED_DELETION", + "RETRY_DELETION", + "SUSPENDED" + ], + "type": "string" + }, + "SuperuserParameters": { + "$ref": "#/definitions/SuperuserParameters" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/EnvironmentId", + "/properties/Status", + "/properties/SageMakerStudioDomainUrl", + "/properties/EnvironmentArn", + "/properties/EnvironmentUrl", + "/properties/AwsAccountId", + "/properties/DedicatedServiceAccountId" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::FinSpace::Environment", + "writeOnlyProperties": [ + "/properties/SuperuserParameters", + "/properties/FederationParameters/AttributeMap", + "/properties/Tags" + ] +} diff --git a/schema/aws-fis-experimenttemplate.json b/schema/aws-fis-experimenttemplate.json index 6d9e945..89c7e7f 100644 --- a/schema/aws-fis-experimenttemplate.json +++ b/schema/aws-fis-experimenttemplate.json @@ -1,410 +1,411 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags", - "/properties/ExperimentOptions/AccountTargeting" - ], - "definitions": { - "ActionId": { - "description": "The ID of the action.", - "maxLength": 64, - "type": "string" - }, - "ExperimentTemplateAction": { - "additionalProperties": false, - "description": "Specifies an action for the experiment template.", - "properties": { - "ActionId": { - "$ref": "#/definitions/ActionId" - }, - "Description": { - "$ref": "#/definitions/ExperimentTemplateActionItemDescription" - }, - "Parameters": { - "additionalProperties": false, - "description": "The parameters for the action, if applicable.", - "patternProperties": { - ".{1,64}": { - "$ref": "#/definitions/ExperimentTemplateActionItemParameter" - } - }, - "type": "object" - }, - "StartAfter": { - "$ref": "#/definitions/ExperimentTemplateActionItemStartAfterList" - }, - "Targets": { - "additionalProperties": false, - "description": "One or more targets for the action.", - "patternProperties": { - ".{1,64}": { - "$ref": "#/definitions/ExperimentTemplateActionItemTarget" - } - }, - "type": "object" - } - }, - "required": [ - "ActionId" - ], - "type": "object" - }, - "ExperimentTemplateActionItemDescription": { - "description": "A description for the action.", - "maxLength": 512, - "type": "string" - }, - "ExperimentTemplateActionItemParameter": { - "maxLength": 1024, - "type": "string" - }, - "ExperimentTemplateActionItemStartAfter": { - "maxLength": 64, - "type": "string" - }, - "ExperimentTemplateActionItemStartAfterList": { - "description": "The names of the actions that must be completed before the current action starts.", - "items": { - "$ref": "#/definitions/ExperimentTemplateActionItemStartAfter" - }, - "type": "array" - }, - "ExperimentTemplateActionItemTarget": { - "maxLength": 64, - "type": "string" - }, - "ExperimentTemplateActionMap": { - "additionalProperties": false, - "description": "The actions for the experiment.", - "patternProperties": { - "[\\S]{1,64}": { - "$ref": "#/definitions/ExperimentTemplateAction" - } - }, - "type": "object" - }, - "ExperimentTemplateDescription": { - "description": "A description for the experiment template.", - "maxLength": 512, - "type": "string" - }, - "ExperimentTemplateExperimentOptions": { - "additionalProperties": false, - "properties": { - "AccountTargeting": { - "description": "The account targeting setting for the experiment template.", - "enum": [ - "multi-account", - "single-account" - ], - "type": "string" - }, - "EmptyTargetResolutionMode": { - "description": "The target resolution failure mode for the experiment template.", - "enum": [ - "fail", - "skip" - ], - "type": "string" - } - }, - "type": "object" - }, - "ExperimentTemplateId": { - "type": "string" - }, - "ExperimentTemplateLogConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsConfiguration": { - "additionalProperties": false, - "properties": { - "LogGroupArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "LogGroupArn" - ], - "type": "object" - }, - "LogSchemaVersion": { - "minimum": 1, - "type": "integer" - }, - "S3Configuration": { - "additionalProperties": false, - "properties": { - "BucketName": { - "maxLength": 63, - "minLength": 3, - "type": "string" - }, - "Prefix": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - } - }, - "required": [ - "LogSchemaVersion" - ], - "type": "object" - }, - "ExperimentTemplateStopCondition": { - "additionalProperties": false, - "properties": { - "Source": { - "$ref": "#/definitions/StopConditionSource" - }, - "Value": { - "$ref": "#/definitions/StopConditionValue" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "ExperimentTemplateStopConditionList": { - "description": "One or more stop conditions.", - "items": { - "$ref": "#/definitions/ExperimentTemplateStopCondition" - }, - "type": "array" - }, - "ExperimentTemplateTarget": { - "additionalProperties": false, - "description": "Specifies a target for an experiment.", - "properties": { - "Filters": { - "$ref": "#/definitions/ExperimentTemplateTargetFilterList" - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - ".{1,64}": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "ResourceArns": { - "$ref": "#/definitions/ResourceArnList" - }, - "ResourceTags": { - "additionalProperties": false, - "patternProperties": { - ".{1,128}": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "ResourceType": { - "$ref": "#/definitions/ResourceType" - }, - "SelectionMode": { - "$ref": "#/definitions/ExperimentTemplateTargetSelectionMode" - } - }, - "required": [ - "ResourceType", - "SelectionMode" - ], - "type": "object" - }, - "ExperimentTemplateTargetFilter": { - "additionalProperties": false, - "description": "Describes a filter used for the target resource input in an experiment template.", - "properties": { - "Path": { - "$ref": "#/definitions/ExperimentTemplateTargetFilterPath" - }, - "Values": { - "$ref": "#/definitions/ExperimentTemplateTargetFilterValues" - } - }, - "required": [ - "Path", - "Values" - ], - "type": "object" - }, - "ExperimentTemplateTargetFilterList": { - "items": { - "$ref": "#/definitions/ExperimentTemplateTargetFilter" - }, - "type": "array" - }, - "ExperimentTemplateTargetFilterPath": { - "description": "The attribute path for the filter.", - "maxLength": 256, - "type": "string" - }, - "ExperimentTemplateTargetFilterValue": { - "maxLength": 128, - "type": "string" - }, - "ExperimentTemplateTargetFilterValues": { - "description": "The attribute values for the filter.", - "items": { - "$ref": "#/definitions/ExperimentTemplateTargetFilterValue" - }, - "type": "array" - }, - "ExperimentTemplateTargetMap": { - "additionalProperties": false, - "description": "The targets for the experiment.", - "patternProperties": { - ".{1,64}": { - "$ref": "#/definitions/ExperimentTemplateTarget" - } - }, - "type": "object" - }, - "ExperimentTemplateTargetSelectionMode": { - "description": "Scopes the identified resources to a specific number of the resources at random, or a percentage of the resources.", - "maxLength": 64, - "type": "string" - }, - "ResourceArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ResourceArnList": { - "description": "The Amazon Resource Names (ARNs) of the target resources.", - "items": { - "$ref": "#/definitions/ResourceArn" - }, - "type": "array" - }, - "ResourceType": { - "description": "The AWS resource type. The resource type must be supported for the specified action.", - "maxLength": 64, - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.", - "maxLength": 1224, - "type": "string" - }, - "StopConditionSource": { - "maxLength": 64, - "type": "string" - }, - "StopConditionValue": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "description": "Resource schema for AWS::FIS::ExperimentTemplate", - "handlers": { - "create": { - "permissions": [ - "fis:CreateExperimentTemplate", - "fis:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "fis:DeleteExperimentTemplate" - ] - }, - "list": { - "permissions": [ - "fis:ListExperimentTemplates", - "fis:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "fis:GetExperimentTemplate", - "fis:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "fis:UpdateExperimentTemplate", - "fis:TagResource", - "fis:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Actions": { - "$ref": "#/definitions/ExperimentTemplateActionMap" - }, - "Description": { - "$ref": "#/definitions/ExperimentTemplateDescription" - }, - "ExperimentOptions": { - "$ref": "#/definitions/ExperimentTemplateExperimentOptions" - }, - "Id": { - "$ref": "#/definitions/ExperimentTemplateId" - }, - "LogConfiguration": { - "$ref": "#/definitions/ExperimentTemplateLogConfiguration" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "StopConditions": { - "$ref": "#/definitions/ExperimentTemplateStopConditionList" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".{1,128}": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "Targets": { - "$ref": "#/definitions/ExperimentTemplateTargetMap" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Description", - "StopConditions", - "Targets", - "RoleArn", - "Tags" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fis.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "fis:TagResource", - "fis:UntagResource", - "fis:ListTagsForResource" - ], - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::FIS::ExperimentTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags", + "/properties/ExperimentOptions/AccountTargeting" + ], + "definitions": { + "ActionId": { + "description": "The ID of the action.", + "maxLength": 64, + "type": "string" + }, + "ExperimentTemplateAction": { + "additionalProperties": false, + "description": "Specifies an action for the experiment template.", + "properties": { + "ActionId": { + "$ref": "#/definitions/ActionId" + }, + "Description": { + "$ref": "#/definitions/ExperimentTemplateActionItemDescription" + }, + "Parameters": { + "additionalProperties": false, + "description": "The parameters for the action, if applicable.", + "patternProperties": { + ".{1,64}": { + "$ref": "#/definitions/ExperimentTemplateActionItemParameter" + } + }, + "type": "object" + }, + "StartAfter": { + "$ref": "#/definitions/ExperimentTemplateActionItemStartAfterList" + }, + "Targets": { + "additionalProperties": false, + "description": "One or more targets for the action.", + "patternProperties": { + ".{1,64}": { + "$ref": "#/definitions/ExperimentTemplateActionItemTarget" + } + }, + "type": "object" + } + }, + "required": [ + "ActionId" + ], + "type": "object" + }, + "ExperimentTemplateActionItemDescription": { + "description": "A description for the action.", + "maxLength": 512, + "type": "string" + }, + "ExperimentTemplateActionItemParameter": { + "maxLength": 1024, + "type": "string" + }, + "ExperimentTemplateActionItemStartAfter": { + "maxLength": 64, + "type": "string" + }, + "ExperimentTemplateActionItemStartAfterList": { + "description": "The names of the actions that must be completed before the current action starts.", + "items": { + "$ref": "#/definitions/ExperimentTemplateActionItemStartAfter" + }, + "type": "array" + }, + "ExperimentTemplateActionItemTarget": { + "maxLength": 64, + "type": "string" + }, + "ExperimentTemplateActionMap": { + "additionalProperties": false, + "description": "The actions for the experiment.", + "patternProperties": { + "[\\S]{1,64}": { + "$ref": "#/definitions/ExperimentTemplateAction" + } + }, + "type": "object" + }, + "ExperimentTemplateDescription": { + "description": "A description for the experiment template.", + "maxLength": 512, + "type": "string" + }, + "ExperimentTemplateExperimentOptions": { + "additionalProperties": false, + "properties": { + "AccountTargeting": { + "description": "The account targeting setting for the experiment template.", + "enum": [ + "multi-account", + "single-account" + ], + "type": "string" + }, + "EmptyTargetResolutionMode": { + "description": "The target resolution failure mode for the experiment template.", + "enum": [ + "fail", + "skip" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExperimentTemplateId": { + "type": "string" + }, + "ExperimentTemplateLogConfiguration": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "LogGroupArn" + ], + "type": "object" + }, + "LogSchemaVersion": { + "minimum": 1, + "type": "integer" + }, + "S3Configuration": { + "additionalProperties": false, + "properties": { + "BucketName": { + "maxLength": 63, + "minLength": 3, + "type": "string" + }, + "Prefix": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + } + }, + "required": [ + "LogSchemaVersion" + ], + "type": "object" + }, + "ExperimentTemplateStopCondition": { + "additionalProperties": false, + "properties": { + "Source": { + "$ref": "#/definitions/StopConditionSource" + }, + "Value": { + "$ref": "#/definitions/StopConditionValue" + } + }, + "required": [ + "Source" + ], + "type": "object" + }, + "ExperimentTemplateStopConditionList": { + "description": "One or more stop conditions.", + "items": { + "$ref": "#/definitions/ExperimentTemplateStopCondition" + }, + "type": "array" + }, + "ExperimentTemplateTarget": { + "additionalProperties": false, + "description": "Specifies a target for an experiment.", + "properties": { + "Filters": { + "$ref": "#/definitions/ExperimentTemplateTargetFilterList" + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + ".{1,64}": { + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "ResourceArns": { + "$ref": "#/definitions/ResourceArnList" + }, + "ResourceTags": { + "additionalProperties": false, + "patternProperties": { + ".{1,128}": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "ResourceType": { + "$ref": "#/definitions/ResourceType" + }, + "SelectionMode": { + "$ref": "#/definitions/ExperimentTemplateTargetSelectionMode" + } + }, + "required": [ + "ResourceType", + "SelectionMode" + ], + "type": "object" + }, + "ExperimentTemplateTargetFilter": { + "additionalProperties": false, + "description": "Describes a filter used for the target resource input in an experiment template.", + "properties": { + "Path": { + "$ref": "#/definitions/ExperimentTemplateTargetFilterPath" + }, + "Values": { + "$ref": "#/definitions/ExperimentTemplateTargetFilterValues" + } + }, + "required": [ + "Path", + "Values" + ], + "type": "object" + }, + "ExperimentTemplateTargetFilterList": { + "items": { + "$ref": "#/definitions/ExperimentTemplateTargetFilter" + }, + "type": "array" + }, + "ExperimentTemplateTargetFilterPath": { + "description": "The attribute path for the filter.", + "maxLength": 256, + "type": "string" + }, + "ExperimentTemplateTargetFilterValue": { + "maxLength": 128, + "type": "string" + }, + "ExperimentTemplateTargetFilterValues": { + "description": "The attribute values for the filter.", + "items": { + "$ref": "#/definitions/ExperimentTemplateTargetFilterValue" + }, + "type": "array" + }, + "ExperimentTemplateTargetMap": { + "additionalProperties": false, + "description": "The targets for the experiment.", + "patternProperties": { + ".{1,64}": { + "$ref": "#/definitions/ExperimentTemplateTarget" + } + }, + "type": "object" + }, + "ExperimentTemplateTargetSelectionMode": { + "description": "Scopes the identified resources to a specific number of the resources at random, or a percentage of the resources.", + "maxLength": 64, + "type": "string" + }, + "ResourceArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ResourceArnList": { + "description": "The Amazon Resource Names (ARNs) of the target resources.", + "items": { + "$ref": "#/definitions/ResourceArn" + }, + "type": "array" + }, + "ResourceType": { + "description": "The AWS resource type. The resource type must be supported for the specified action.", + "maxLength": 64, + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.", + "maxLength": 1224, + "type": "string" + }, + "StopConditionSource": { + "maxLength": 64, + "type": "string" + }, + "StopConditionValue": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "description": "Resource schema for AWS::FIS::ExperimentTemplate", + "handlers": { + "create": { + "permissions": [ + "fis:CreateExperimentTemplate", + "fis:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "fis:DeleteExperimentTemplate" + ] + }, + "list": { + "permissions": [ + "fis:ListExperimentTemplates", + "fis:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "fis:GetExperimentTemplate", + "fis:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "fis:UpdateExperimentTemplate", + "fis:TagResource", + "fis:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Actions": { + "$ref": "#/definitions/ExperimentTemplateActionMap" + }, + "Description": { + "$ref": "#/definitions/ExperimentTemplateDescription" + }, + "ExperimentOptions": { + "$ref": "#/definitions/ExperimentTemplateExperimentOptions" + }, + "Id": { + "$ref": "#/definitions/ExperimentTemplateId" + }, + "LogConfiguration": { + "$ref": "#/definitions/ExperimentTemplateLogConfiguration" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "StopConditions": { + "$ref": "#/definitions/ExperimentTemplateStopConditionList" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".{1,128}": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "Targets": { + "$ref": "#/definitions/ExperimentTemplateTargetMap" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Description", + "StopConditions", + "Targets", + "RoleArn", + "Tags" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fis.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "fis:TagResource", + "fis:UntagResource", + "fis:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::FIS::ExperimentTemplate" +} diff --git a/schema/aws-fis-targetaccountconfiguration.json b/schema/aws-fis-targetaccountconfiguration.json index ff528e4..2b2ffec 100644 --- a/schema/aws-fis-targetaccountconfiguration.json +++ b/schema/aws-fis-targetaccountconfiguration.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ExperimentTemplateId", - "/properties/AccountId" - ], - "definitions": { - "TargetAccountConfigurationDescription": { - "description": "The description of the target account.", - "maxLength": 512, - "type": "string" - }, - "TargetAccountId": { - "description": "The AWS account ID of the target account.", - "maxLength": 512, - "type": "string" - }, - "TargetAccountRoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role for the target account.", - "maxLength": 1224, - "type": "string" - }, - "TargetExperimentTemplateId": { - "description": "The ID of the experiment template.", - "type": "string" - } - }, - "description": "Resource schema for AWS::FIS::TargetAccountConfiguration", - "handlers": { - "create": { - "permissions": [ - "fis:CreateTargetAccountConfiguration" - ] - }, - "delete": { - "permissions": [ - "fis:DeleteTargetAccountConfiguration" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ExperimentTemplateId": { - "$ref": "resource-schema.json#/properties/ExperimentTemplateId" - } - }, - "required": [ - "ExperimentTemplateId" - ] - }, - "permissions": [ - "fis:ListTargetAccountConfigurations" - ] - }, - "read": { - "permissions": [ - "fis:GetTargetAccountConfiguration" - ] - }, - "update": { - "permissions": [ - "fis:UpdateTargetAccountConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/ExperimentTemplateId", - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "$ref": "#/definitions/TargetAccountId" - }, - "Description": { - "$ref": "#/definitions/TargetAccountConfigurationDescription" - }, - "ExperimentTemplateId": { - "$ref": "#/definitions/TargetExperimentTemplateId" - }, - "RoleArn": { - "$ref": "#/definitions/TargetAccountRoleArn" - } - }, - "required": [ - "ExperimentTemplateId", - "AccountId", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fis.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::FIS::TargetAccountConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ExperimentTemplateId", + "/properties/AccountId" + ], + "definitions": { + "TargetAccountConfigurationDescription": { + "description": "The description of the target account.", + "maxLength": 512, + "type": "string" + }, + "TargetAccountId": { + "description": "The AWS account ID of the target account.", + "maxLength": 512, + "type": "string" + }, + "TargetAccountRoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role for the target account.", + "maxLength": 1224, + "type": "string" + }, + "TargetExperimentTemplateId": { + "description": "The ID of the experiment template.", + "type": "string" + } + }, + "description": "Resource schema for AWS::FIS::TargetAccountConfiguration", + "handlers": { + "create": { + "permissions": [ + "fis:CreateTargetAccountConfiguration" + ] + }, + "delete": { + "permissions": [ + "fis:DeleteTargetAccountConfiguration" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ExperimentTemplateId": { + "$ref": "resource-schema.json#/properties/ExperimentTemplateId" + } + }, + "required": [ + "ExperimentTemplateId" + ] + }, + "permissions": [ + "fis:ListTargetAccountConfigurations" + ] + }, + "read": { + "permissions": [ + "fis:GetTargetAccountConfiguration" + ] + }, + "update": { + "permissions": [ + "fis:UpdateTargetAccountConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/ExperimentTemplateId", + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "$ref": "#/definitions/TargetAccountId" + }, + "Description": { + "$ref": "#/definitions/TargetAccountConfigurationDescription" + }, + "ExperimentTemplateId": { + "$ref": "#/definitions/TargetExperimentTemplateId" + }, + "RoleArn": { + "$ref": "#/definitions/TargetAccountRoleArn" + } + }, + "required": [ + "ExperimentTemplateId", + "AccountId", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fis.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::FIS::TargetAccountConfiguration" +} diff --git a/schema/aws-fms-notificationchannel.json b/schema/aws-fms-notificationchannel.json index c745456..e4f0930 100644 --- a/schema/aws-fms-notificationchannel.json +++ b/schema/aws-fms-notificationchannel.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "definitions": { - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^([^\\s]+)$", - "type": "string" - } - }, - "description": "Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.", - "handlers": { - "create": { - "permissions": [ - "fms:PutNotificationChannel", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "fms:DeleteNotificationChannel" - ] - }, - "list": { - "permissions": [ - "fms:GetNotificationChannel" - ] - }, - "read": { - "permissions": [ - "fms:GetNotificationChannel" - ] - }, - "update": { - "permissions": [ - "fms:PutNotificationChannel", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/SnsTopicArn" - ], - "properties": { - "SnsRoleName": { - "$ref": "#/definitions/ResourceArn" - }, - "SnsTopicArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "required": [ - "SnsRoleName", - "SnsTopicArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", - "typeName": "AWS::FMS::NotificationChannel" -} +{ + "additionalProperties": false, + "definitions": { + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^([^\\s]+)$", + "type": "string" + } + }, + "description": "Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.", + "handlers": { + "create": { + "permissions": [ + "fms:PutNotificationChannel", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "fms:DeleteNotificationChannel" + ] + }, + "list": { + "permissions": [ + "fms:GetNotificationChannel" + ] + }, + "read": { + "permissions": [ + "fms:GetNotificationChannel" + ] + }, + "update": { + "permissions": [ + "fms:PutNotificationChannel", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/SnsTopicArn" + ], + "properties": { + "SnsRoleName": { + "$ref": "#/definitions/ResourceArn" + }, + "SnsTopicArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "required": [ + "SnsRoleName", + "SnsTopicArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", + "typeName": "AWS::FMS::NotificationChannel" +} diff --git a/schema/aws-fms-policy.json b/schema/aws-fms-policy.json index ad9e6dc..fc80a68 100644 --- a/schema/aws-fms-policy.json +++ b/schema/aws-fms-policy.json @@ -1,503 +1,503 @@ -{ - "additionalProperties": false, - "definitions": { - "AccountId": { - "description": "An AWS account ID.", - "maxLength": 12, - "minLength": 12, - "pattern": "^([0-9]*)$", - "type": "string" - }, - "Base62Id": { - "description": "A Base62 ID", - "maxLength": 22, - "minLength": 22, - "pattern": "^[a-z0-9A-Z]{22}$", - "type": "string" - }, - "FirewallDeploymentModel": { - "description": "Firewall deployment mode.", - "enum": [ - "DISTRIBUTED", - "CENTRALIZED" - ], - "type": "string" - }, - "IEMap": { - "additionalProperties": false, - "description": "An FMS includeMap or excludeMap.", - "properties": { - "ACCOUNT": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AccountId" - }, - "type": "array" - }, - "ORGUNIT": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/OrganizationalUnitId" - }, - "type": "array" - } - }, - "type": "object" - }, - "ManagedServiceData": { - "description": "Firewall managed service data.", - "maxLength": 30000, - "minLength": 1, - "type": "string" - }, - "NetworkAclCommonPolicy": { - "additionalProperties": false, - "description": "Network ACL common policy.", - "properties": { - "NetworkAclEntrySet": { - "$ref": "#/definitions/NetworkAclEntrySet" - } - }, - "required": [ - "NetworkAclEntrySet" - ], - "type": "object" - }, - "NetworkAclEntry": { - "additionalProperties": false, - "description": "Network ACL entry.", - "properties": { - "CidrBlock": { - "description": "CIDR block.", - "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$", - "type": "string" - }, - "Egress": { - "description": "Whether the entry is an egress entry.", - "type": "boolean" - }, - "IcmpTypeCode": { - "additionalProperties": false, - "description": "ICMP type and code.", - "properties": { - "Code": { - "description": "Code.", - "maximum": 255, - "minimum": 0, - "type": "integer" - }, - "Type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Code", - "Type" - ], - "type": "object" - }, - "Ipv6CidrBlock": { - "description": "IPv6 CIDR block.", - "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))(/(1[0-2]|[0-9]))?$", - "type": "string" - }, - "PortRange": { - "additionalProperties": false, - "description": "Port range.", - "properties": { - "From": { - "description": "From Port.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "To": { - "description": "To Port.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "From", - "To" - ], - "type": "object" - }, - "Protocol": { - "description": "Protocol.", - "pattern": "^(tcp|udp|icmp|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$", - "type": "string" - }, - "RuleAction": { - "description": "Rule Action.", - "enum": [ - "allow", - "deny" - ], - "type": "string" - } - }, - "required": [ - "Egress", - "Protocol", - "RuleAction" - ], - "type": "object" - }, - "NetworkAclEntryList": { - "description": "NetworkAcl entry list.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NetworkAclEntry" - }, - "type": "array" - }, - "NetworkAclEntrySet": { - "additionalProperties": false, - "anyOf": [ - { - "required": [ - "FirstEntries" - ] - }, - { - "required": [ - "LastEntries" - ] - } - ], - "description": "Network ACL entry set.", - "properties": { - "FirstEntries": { - "$ref": "#/definitions/NetworkAclEntryList" - }, - "ForceRemediateForFirstEntries": { - "type": "boolean" - }, - "ForceRemediateForLastEntries": { - "type": "boolean" - }, - "LastEntries": { - "$ref": "#/definitions/NetworkAclEntryList" - } - }, - "required": [ - "ForceRemediateForFirstEntries", - "ForceRemediateForLastEntries" - ], - "type": "object" - }, - "NetworkFirewallPolicy": { - "additionalProperties": false, - "description": "Network firewall policy.", - "properties": { - "FirewallDeploymentModel": { - "$ref": "#/definitions/FirewallDeploymentModel" - } - }, - "required": [ - "FirewallDeploymentModel" - ], - "type": "object" - }, - "OrganizationalUnitId": { - "description": "An Organizational Unit ID.", - "maxLength": 68, - "minLength": 16, - "pattern": "^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", - "type": "string" - }, - "PolicyOption": { - "additionalProperties": false, - "description": "Firewall policy option.", - "oneOf": [ - { - "required": [ - "NetworkFirewallPolicy" - ] - }, - { - "required": [ - "ThirdPartyFirewallPolicy" - ] - }, - { - "required": [ - "NetworkAclCommonPolicy" - ] - } - ], - "properties": { - "NetworkAclCommonPolicy": { - "$ref": "#/definitions/NetworkAclCommonPolicy" - }, - "NetworkFirewallPolicy": { - "$ref": "#/definitions/NetworkFirewallPolicy" - }, - "ThirdPartyFirewallPolicy": { - "$ref": "#/definitions/ThirdPartyFirewallPolicy" - } - }, - "type": "object" - }, - "PolicyTag": { - "additionalProperties": false, - "description": "A policy tag.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "pattern": "^([^\\s]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "PolicyType": { - "description": "Firewall policy type.", - "enum": [ - "WAF", - "WAFV2", - "SHIELD_ADVANCED", - "SECURITY_GROUPS_COMMON", - "SECURITY_GROUPS_CONTENT_AUDIT", - "SECURITY_GROUPS_USAGE_AUDIT", - "NETWORK_FIREWALL", - "THIRD_PARTY_FIREWALL", - "DNS_FIREWALL", - "IMPORT_NETWORK_FIREWALL", - "NETWORK_ACL_COMMON" - ], - "type": "string" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "ResourceTag": { - "additionalProperties": false, - "description": "A resource tag.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "ResourceType": { - "description": "An AWS resource type", - "maxLength": 128, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "SecurityServicePolicyData": { - "additionalProperties": false, - "description": "Firewall security service policy data.", - "properties": { - "ManagedServiceData": { - "$ref": "#/definitions/ManagedServiceData" - }, - "PolicyOption": { - "$ref": "#/definitions/PolicyOption" - }, - "Type": { - "$ref": "#/definitions/PolicyType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ThirdPartyFirewallPolicy": { - "additionalProperties": false, - "description": "Third party firewall policy.", - "properties": { - "FirewallDeploymentModel": { - "$ref": "#/definitions/FirewallDeploymentModel" - } - }, - "required": [ - "FirewallDeploymentModel" - ], - "type": "object" - } - }, - "description": "Creates an AWS Firewall Manager policy.", - "handlers": { - "create": { - "permissions": [ - "fms:PutPolicy", - "fms:TagResource", - "waf-regional:ListRuleGroups", - "wafv2:CheckCapacity", - "wafv2:ListRuleGroups", - "wafv2:ListAvailableManagedRuleGroups", - "wafv2:ListAvailableManagedRuleGroupVersions", - "network-firewall:DescribeRuleGroup", - "network-firewall:DescribeRuleGroupMetadata", - "route53resolver:ListFirewallRuleGroups", - "ec2:DescribeAvailabilityZones", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "fms:DeletePolicy" - ] - }, - "list": { - "permissions": [ - "fms:ListPolicies", - "fms:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "fms:GetPolicy", - "fms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "fms:PutPolicy", - "fms:GetPolicy", - "fms:TagResource", - "fms:UntagResource", - "fms:ListTagsForResource", - "waf-regional:ListRuleGroups", - "wafv2:CheckCapacity", - "wafv2:ListRuleGroups", - "wafv2:ListAvailableManagedRuleGroups", - "wafv2:ListAvailableManagedRuleGroupVersions", - "network-firewall:DescribeRuleGroup", - "network-firewall:DescribeRuleGroupMetadata", - "route53resolver:ListFirewallRuleGroups", - "ec2:DescribeAvailabilityZones", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "DeleteAllPolicyResources": { - "type": "boolean" - }, - "ExcludeMap": { - "$ref": "#/definitions/IEMap" - }, - "ExcludeResourceTags": { - "type": "boolean" - }, - "Id": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-z0-9A-Z-]{36}$", - "type": "string" - }, - "IncludeMap": { - "$ref": "#/definitions/IEMap" - }, - "PolicyDescription": { - "maxLength": 256, - "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", - "type": "string" - }, - "PolicyName": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", - "type": "string" - }, - "RemediationEnabled": { - "type": "boolean" - }, - "ResourceSetIds": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Base62Id" - }, - "type": "array", - "uniqueItems": true - }, - "ResourceTags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResourceTag" - }, - "maxItems": 8, - "type": "array" - }, - "ResourceType": { - "$ref": "#/definitions/ResourceType" - }, - "ResourceTypeList": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResourceType" - }, - "type": "array" - }, - "ResourcesCleanUp": { - "type": "boolean" - }, - "SecurityServicePolicyData": { - "$ref": "#/definitions/SecurityServicePolicyData" - }, - "Tags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PolicyTag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "ExcludeResourceTags", - "PolicyName", - "RemediationEnabled", - "SecurityServicePolicyData" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", - "typeName": "AWS::FMS::Policy", - "writeOnlyProperties": [ - "/properties/DeleteAllPolicyResources" - ] -} +{ + "additionalProperties": false, + "definitions": { + "AccountId": { + "description": "An AWS account ID.", + "maxLength": 12, + "minLength": 12, + "pattern": "^([0-9]*)$", + "type": "string" + }, + "Base62Id": { + "description": "A Base62 ID", + "maxLength": 22, + "minLength": 22, + "pattern": "^[a-z0-9A-Z]{22}$", + "type": "string" + }, + "FirewallDeploymentModel": { + "description": "Firewall deployment mode.", + "enum": [ + "DISTRIBUTED", + "CENTRALIZED" + ], + "type": "string" + }, + "IEMap": { + "additionalProperties": false, + "description": "An FMS includeMap or excludeMap.", + "properties": { + "ACCOUNT": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AccountId" + }, + "type": "array" + }, + "ORGUNIT": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/OrganizationalUnitId" + }, + "type": "array" + } + }, + "type": "object" + }, + "ManagedServiceData": { + "description": "Firewall managed service data.", + "maxLength": 30000, + "minLength": 1, + "type": "string" + }, + "NetworkAclCommonPolicy": { + "additionalProperties": false, + "description": "Network ACL common policy.", + "properties": { + "NetworkAclEntrySet": { + "$ref": "#/definitions/NetworkAclEntrySet" + } + }, + "required": [ + "NetworkAclEntrySet" + ], + "type": "object" + }, + "NetworkAclEntry": { + "additionalProperties": false, + "description": "Network ACL entry.", + "properties": { + "CidrBlock": { + "description": "CIDR block.", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$", + "type": "string" + }, + "Egress": { + "description": "Whether the entry is an egress entry.", + "type": "boolean" + }, + "IcmpTypeCode": { + "additionalProperties": false, + "description": "ICMP type and code.", + "properties": { + "Code": { + "description": "Code.", + "maximum": 255, + "minimum": 0, + "type": "integer" + }, + "Type": { + "description": "Type.", + "maximum": 255, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Code", + "Type" + ], + "type": "object" + }, + "Ipv6CidrBlock": { + "description": "IPv6 CIDR block.", + "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))(/(1[0-2]|[0-9]))?$", + "type": "string" + }, + "PortRange": { + "additionalProperties": false, + "description": "Port range.", + "properties": { + "From": { + "description": "From Port.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "To": { + "description": "To Port.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + }, + "Protocol": { + "description": "Protocol.", + "pattern": "^(tcp|udp|icmp|-1|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$", + "type": "string" + }, + "RuleAction": { + "description": "Rule Action.", + "enum": [ + "allow", + "deny" + ], + "type": "string" + } + }, + "required": [ + "Egress", + "Protocol", + "RuleAction" + ], + "type": "object" + }, + "NetworkAclEntryList": { + "description": "NetworkAcl entry list.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NetworkAclEntry" + }, + "type": "array" + }, + "NetworkAclEntrySet": { + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "FirstEntries" + ] + }, + { + "required": [ + "LastEntries" + ] + } + ], + "description": "Network ACL entry set.", + "properties": { + "FirstEntries": { + "$ref": "#/definitions/NetworkAclEntryList" + }, + "ForceRemediateForFirstEntries": { + "type": "boolean" + }, + "ForceRemediateForLastEntries": { + "type": "boolean" + }, + "LastEntries": { + "$ref": "#/definitions/NetworkAclEntryList" + } + }, + "required": [ + "ForceRemediateForFirstEntries", + "ForceRemediateForLastEntries" + ], + "type": "object" + }, + "NetworkFirewallPolicy": { + "additionalProperties": false, + "description": "Network firewall policy.", + "properties": { + "FirewallDeploymentModel": { + "$ref": "#/definitions/FirewallDeploymentModel" + } + }, + "required": [ + "FirewallDeploymentModel" + ], + "type": "object" + }, + "OrganizationalUnitId": { + "description": "An Organizational Unit ID.", + "maxLength": 68, + "minLength": 16, + "pattern": "^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", + "type": "string" + }, + "PolicyOption": { + "additionalProperties": false, + "description": "Firewall policy option.", + "oneOf": [ + { + "required": [ + "NetworkFirewallPolicy" + ] + }, + { + "required": [ + "ThirdPartyFirewallPolicy" + ] + }, + { + "required": [ + "NetworkAclCommonPolicy" + ] + } + ], + "properties": { + "NetworkAclCommonPolicy": { + "$ref": "#/definitions/NetworkAclCommonPolicy" + }, + "NetworkFirewallPolicy": { + "$ref": "#/definitions/NetworkFirewallPolicy" + }, + "ThirdPartyFirewallPolicy": { + "$ref": "#/definitions/ThirdPartyFirewallPolicy" + } + }, + "type": "object" + }, + "PolicyTag": { + "additionalProperties": false, + "description": "A policy tag.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "pattern": "^([^\\s]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "PolicyType": { + "description": "Firewall policy type.", + "enum": [ + "WAF", + "WAFV2", + "SHIELD_ADVANCED", + "SECURITY_GROUPS_COMMON", + "SECURITY_GROUPS_CONTENT_AUDIT", + "SECURITY_GROUPS_USAGE_AUDIT", + "NETWORK_FIREWALL", + "THIRD_PARTY_FIREWALL", + "DNS_FIREWALL", + "IMPORT_NETWORK_FIREWALL", + "NETWORK_ACL_COMMON" + ], + "type": "string" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "ResourceTag": { + "additionalProperties": false, + "description": "A resource tag.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "ResourceType": { + "description": "An AWS resource type", + "maxLength": 128, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "SecurityServicePolicyData": { + "additionalProperties": false, + "description": "Firewall security service policy data.", + "properties": { + "ManagedServiceData": { + "$ref": "#/definitions/ManagedServiceData" + }, + "PolicyOption": { + "$ref": "#/definitions/PolicyOption" + }, + "Type": { + "$ref": "#/definitions/PolicyType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ThirdPartyFirewallPolicy": { + "additionalProperties": false, + "description": "Third party firewall policy.", + "properties": { + "FirewallDeploymentModel": { + "$ref": "#/definitions/FirewallDeploymentModel" + } + }, + "required": [ + "FirewallDeploymentModel" + ], + "type": "object" + } + }, + "description": "Creates an AWS Firewall Manager policy.", + "handlers": { + "create": { + "permissions": [ + "fms:PutPolicy", + "fms:TagResource", + "waf-regional:ListRuleGroups", + "wafv2:CheckCapacity", + "wafv2:ListRuleGroups", + "wafv2:ListAvailableManagedRuleGroups", + "wafv2:ListAvailableManagedRuleGroupVersions", + "network-firewall:DescribeRuleGroup", + "network-firewall:DescribeRuleGroupMetadata", + "route53resolver:ListFirewallRuleGroups", + "ec2:DescribeAvailabilityZones", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "fms:DeletePolicy" + ] + }, + "list": { + "permissions": [ + "fms:ListPolicies", + "fms:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "fms:GetPolicy", + "fms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "fms:PutPolicy", + "fms:GetPolicy", + "fms:TagResource", + "fms:UntagResource", + "fms:ListTagsForResource", + "waf-regional:ListRuleGroups", + "wafv2:CheckCapacity", + "wafv2:ListRuleGroups", + "wafv2:ListAvailableManagedRuleGroups", + "wafv2:ListAvailableManagedRuleGroupVersions", + "network-firewall:DescribeRuleGroup", + "network-firewall:DescribeRuleGroupMetadata", + "route53resolver:ListFirewallRuleGroups", + "ec2:DescribeAvailabilityZones", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "DeleteAllPolicyResources": { + "type": "boolean" + }, + "ExcludeMap": { + "$ref": "#/definitions/IEMap" + }, + "ExcludeResourceTags": { + "type": "boolean" + }, + "Id": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-z0-9A-Z-]{36}$", + "type": "string" + }, + "IncludeMap": { + "$ref": "#/definitions/IEMap" + }, + "PolicyDescription": { + "maxLength": 256, + "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", + "type": "string" + }, + "PolicyName": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", + "type": "string" + }, + "RemediationEnabled": { + "type": "boolean" + }, + "ResourceSetIds": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Base62Id" + }, + "type": "array", + "uniqueItems": true + }, + "ResourceTags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "maxItems": 8, + "type": "array" + }, + "ResourceType": { + "$ref": "#/definitions/ResourceType" + }, + "ResourceTypeList": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ResourceType" + }, + "type": "array" + }, + "ResourcesCleanUp": { + "type": "boolean" + }, + "SecurityServicePolicyData": { + "$ref": "#/definitions/SecurityServicePolicyData" + }, + "Tags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PolicyTag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "ExcludeResourceTags", + "PolicyName", + "RemediationEnabled", + "SecurityServicePolicyData" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", + "typeName": "AWS::FMS::Policy", + "writeOnlyProperties": [ + "/properties/DeleteAllPolicyResources" + ] +} diff --git a/schema/aws-fms-resourceset.json b/schema/aws-fms-resourceset.json index 06132bc..ff3a590 100644 --- a/schema/aws-fms-resourceset.json +++ b/schema/aws-fms-resourceset.json @@ -1,147 +1,147 @@ -{ - "additionalProperties": false, - "definitions": { - "Base62Id": { - "description": "A Base62 ID", - "maxLength": 22, - "minLength": 22, - "pattern": "^([a-z0-9A-Z]*)$", - "type": "string" - }, - "Resource": { - "description": "A resource ARN or URI.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "ResourceType": { - "description": "An AWS resource type", - "maxLength": 128, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A tag.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([^\\s]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "pattern": "^([^\\s]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates an AWS Firewall Manager resource set.", - "handlers": { - "create": { - "permissions": [ - "fms:PutResourceSet", - "fms:BatchAssociateResource", - "fms:ListResourceSetResources", - "fms:TagResource" - ] - }, - "delete": { - "permissions": [ - "fms:DeleteResourceSet" - ] - }, - "list": { - "permissions": [ - "fms:ListResourceSets" - ] - }, - "read": { - "permissions": [ - "fms:GetResourceSet", - "fms:ListResourceSetResources", - "fms:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "fms:PutResourceSet", - "fms:BatchAssociateResource", - "fms:BatchDisassociateResource", - "fms:GetResourceSet", - "fms:ListResourceSetResources", - "fms:TagResource", - "fms:UntagResource", - "fms:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "maxLength": 256, - "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]*)$", - "type": "string" - }, - "Id": { - "$ref": "#/definitions/Base62Id" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", - "type": "string" - }, - "ResourceTypeList": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResourceType" - }, - "type": "array", - "uniqueItems": true - }, - "Resources": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Resource" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "ResourceTypeList" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::FMS::ResourceSet" -} +{ + "additionalProperties": false, + "definitions": { + "Base62Id": { + "description": "A Base62 ID", + "maxLength": 22, + "minLength": 22, + "pattern": "^([a-z0-9A-Z]*)$", + "type": "string" + }, + "Resource": { + "description": "A resource ARN or URI.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "ResourceType": { + "description": "An AWS resource type", + "maxLength": 128, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A tag.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([^\\s]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "pattern": "^([^\\s]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates an AWS Firewall Manager resource set.", + "handlers": { + "create": { + "permissions": [ + "fms:PutResourceSet", + "fms:BatchAssociateResource", + "fms:ListResourceSetResources", + "fms:TagResource" + ] + }, + "delete": { + "permissions": [ + "fms:DeleteResourceSet" + ] + }, + "list": { + "permissions": [ + "fms:ListResourceSets" + ] + }, + "read": { + "permissions": [ + "fms:GetResourceSet", + "fms:ListResourceSetResources", + "fms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "fms:PutResourceSet", + "fms:BatchAssociateResource", + "fms:BatchDisassociateResource", + "fms:GetResourceSet", + "fms:ListResourceSetResources", + "fms:TagResource", + "fms:UntagResource", + "fms:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "maxLength": 256, + "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]*)$", + "type": "string" + }, + "Id": { + "$ref": "#/definitions/Base62Id" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([a-zA-Z0-9_.:/=+\\-@\\s]+)$", + "type": "string" + }, + "ResourceTypeList": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ResourceType" + }, + "type": "array", + "uniqueItems": true + }, + "Resources": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Resource" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name", + "ResourceTypeList" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fms.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::FMS::ResourceSet" +} diff --git a/schema/aws-forecast-dataset.json b/schema/aws-forecast-dataset.json index 260b62a..09cb7dc 100644 --- a/schema/aws-forecast-dataset.json +++ b/schema/aws-forecast-dataset.json @@ -1,183 +1,183 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatasetName" - ], - "definitions": { - "Attributes": { - "insertionOrder": true, - "items": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "description": "Name of the dataset field", - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", - "type": "string" - }, - "AttributeType": { - "description": "Data type of the field", - "enum": [ - "string", - "integer", - "float", - "timestamp", - "geolocation" - ], - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "KmsKeyArn": { - "description": "KMS key used to encrypt the Dataset data", - "maxLength": 256, - "pattern": "arn:aws[-a-z]*:kms:.*:key/.*", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.", - "maxLength": 256, - "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "description": "Resource Type Definition for AWS::Forecast::Dataset", - "handlers": { - "create": { - "permissions": [ - "forecast:CreateDataset" - ] - }, - "delete": { - "permissions": [ - "forecast:DeleteDataset" - ] - }, - "list": { - "permissions": [ - "forecast:ListDatasets" - ] - }, - "read": { - "permissions": [ - "forecast:DescribeDataset" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 256, - "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", - "type": "string" - }, - "DataFrequency": { - "description": "Frequency of data collection. This parameter is required for RELATED_TIME_SERIES", - "pattern": "^Y|M|W|D|H|30min|15min|10min|5min|1min$", - "type": "string" - }, - "DatasetName": { - "description": "A name for the dataset", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", - "type": "string" - }, - "DatasetType": { - "description": "The dataset type", - "enum": [ - "TARGET_TIME_SERIES", - "RELATED_TIME_SERIES", - "ITEM_METADATA" - ], - "type": "string" - }, - "Domain": { - "description": "The domain associated with the dataset", - "enum": [ - "RETAIL", - "CUSTOM", - "INVENTORY_PLANNING", - "EC2_CAPACITY", - "WORK_FORCE", - "WEB_TRAFFIC", - "METRICS" - ], - "type": "string" - }, - "EncryptionConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyArn": { - "$ref": "#/definitions/KmsKeyArn" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - } - }, - "type": "object" - }, - "Schema": { - "additionalProperties": false, - "properties": { - "Attributes": { - "$ref": "#/definitions/Attributes" - } - }, - "type": "object" - }, - "Tags": { - "insertionOrder": true, - "items": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "$ref": "#/definitions/Key" - }, - "Value": { - "$ref": "#/definitions/Value" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "DatasetName", - "DatasetType", - "Domain", - "Schema" - ], - "sourceUrl": "https://github.com/junlinzw/aws-cloudformation-resource-providers-forecast", - "taggable": false, - "typeName": "AWS::Forecast::Dataset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatasetName" + ], + "definitions": { + "Attributes": { + "insertionOrder": true, + "items": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "description": "Name of the dataset field", + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", + "type": "string" + }, + "AttributeType": { + "description": "Data type of the field", + "enum": [ + "string", + "integer", + "float", + "timestamp", + "geolocation" + ], + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "KmsKeyArn": { + "description": "KMS key used to encrypt the Dataset data", + "maxLength": 256, + "pattern": "arn:aws[-a-z]*:kms:.*:key/.*", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.", + "maxLength": 256, + "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "description": "Resource Type Definition for AWS::Forecast::Dataset", + "handlers": { + "create": { + "permissions": [ + "forecast:CreateDataset" + ] + }, + "delete": { + "permissions": [ + "forecast:DeleteDataset" + ] + }, + "list": { + "permissions": [ + "forecast:ListDatasets" + ] + }, + "read": { + "permissions": [ + "forecast:DescribeDataset" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 256, + "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", + "type": "string" + }, + "DataFrequency": { + "description": "Frequency of data collection. This parameter is required for RELATED_TIME_SERIES", + "pattern": "^Y|M|W|D|H|30min|15min|10min|5min|1min$", + "type": "string" + }, + "DatasetName": { + "description": "A name for the dataset", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", + "type": "string" + }, + "DatasetType": { + "description": "The dataset type", + "enum": [ + "TARGET_TIME_SERIES", + "RELATED_TIME_SERIES", + "ITEM_METADATA" + ], + "type": "string" + }, + "Domain": { + "description": "The domain associated with the dataset", + "enum": [ + "RETAIL", + "CUSTOM", + "INVENTORY_PLANNING", + "EC2_CAPACITY", + "WORK_FORCE", + "WEB_TRAFFIC", + "METRICS" + ], + "type": "string" + }, + "EncryptionConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyArn": { + "$ref": "#/definitions/KmsKeyArn" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + } + }, + "type": "object" + }, + "Schema": { + "additionalProperties": false, + "properties": { + "Attributes": { + "$ref": "#/definitions/Attributes" + } + }, + "type": "object" + }, + "Tags": { + "insertionOrder": true, + "items": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "$ref": "#/definitions/Key" + }, + "Value": { + "$ref": "#/definitions/Value" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "DatasetName", + "DatasetType", + "Domain", + "Schema" + ], + "sourceUrl": "https://github.com/junlinzw/aws-cloudformation-resource-providers-forecast", + "taggable": false, + "typeName": "AWS::Forecast::Dataset" +} diff --git a/schema/aws-forecast-datasetgroup.json b/schema/aws-forecast-datasetgroup.json index 7b35b18..7ba51d5 100644 --- a/schema/aws-forecast-datasetgroup.json +++ b/schema/aws-forecast-datasetgroup.json @@ -1,135 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatasetGroupName" - ], - "definitions": { - "Arn": { - "maxLength": 256, - "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", - "type": "string" - }, - "MaxResults": { - "description": "The number of items to return in the response.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "NextToken": { - "description": "If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.", - "maxLength": 3000, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Represents a dataset group that holds a collection of related datasets", - "handlers": { - "create": { - "permissions": [ - "forecast:CreateDatasetGroup" - ] - }, - "delete": { - "permissions": [ - "forecast:DeleteDatasetGroup" - ] - }, - "list": { - "permissions": [ - "forecast:ListDatasetGroups" - ] - }, - "read": { - "permissions": [ - "forecast:DescribeDatasetGroup" - ] - }, - "update": { - "permissions": [ - "forecast:UpdateDatasetGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatasetGroupArn" - ], - "properties": { - "DatasetArns": { - "description": "An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array" - }, - "DatasetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the dataset group to delete.", - "maxLength": 256, - "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", - "type": "string" - }, - "DatasetGroupName": { - "description": "A name for the dataset group.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", - "type": "string" - }, - "Domain": { - "description": "The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.", - "enum": [ - "RETAIL", - "CUSTOM", - "INVENTORY_PLANNING", - "EC2_CAPACITY", - "WORK_FORCE", - "WEB_TRAFFIC", - "METRICS" - ], - "type": "string" - }, - "Tags": { - "description": "The tags of Application Insights application.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/DatasetGroupArn" - ], - "required": [ - "DatasetGroupName", - "Domain" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-forecast", - "taggable": true, - "typeName": "AWS::Forecast::DatasetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatasetGroupName" + ], + "definitions": { + "Arn": { + "maxLength": 256, + "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", + "type": "string" + }, + "MaxResults": { + "description": "The number of items to return in the response.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "NextToken": { + "description": "If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.", + "maxLength": 3000, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Represents a dataset group that holds a collection of related datasets", + "handlers": { + "create": { + "permissions": [ + "forecast:CreateDatasetGroup" + ] + }, + "delete": { + "permissions": [ + "forecast:DeleteDatasetGroup" + ] + }, + "list": { + "permissions": [ + "forecast:ListDatasetGroups" + ] + }, + "read": { + "permissions": [ + "forecast:DescribeDatasetGroup" + ] + }, + "update": { + "permissions": [ + "forecast:UpdateDatasetGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatasetGroupArn" + ], + "properties": { + "DatasetArns": { + "description": "An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array" + }, + "DatasetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the dataset group to delete.", + "maxLength": 256, + "pattern": "^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$", + "type": "string" + }, + "DatasetGroupName": { + "description": "A name for the dataset group.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*", + "type": "string" + }, + "Domain": { + "description": "The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.", + "enum": [ + "RETAIL", + "CUSTOM", + "INVENTORY_PLANNING", + "EC2_CAPACITY", + "WORK_FORCE", + "WEB_TRAFFIC", + "METRICS" + ], + "type": "string" + }, + "Tags": { + "description": "The tags of Application Insights application.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/DatasetGroupArn" + ], + "required": [ + "DatasetGroupName", + "Domain" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-forecast", + "taggable": true, + "typeName": "AWS::Forecast::DatasetGroup" +} diff --git a/schema/aws-frauddetector-detector.json b/schema/aws-frauddetector-detector.json index 0c5cd85..f4cc778 100644 --- a/schema/aws-frauddetector-detector.json +++ b/schema/aws-frauddetector-detector.json @@ -1,612 +1,612 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DetectorId" - ], - "definitions": { - "EntityType": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the entity type was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the entity type was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this entity type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EventType": { - "additionalProperties": false, - "properties": { - "Arn": { - "description": "The ARN of the event type.", - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "Description": { - "description": "The description of the event type.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "EntityTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EntityType" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "EventVariables": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventVariable" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Inline": { - "type": "boolean" - }, - "Labels": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Label" - }, - "minItems": 2, - "type": "array", - "uniqueItems": false - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Name": { - "description": "The name for the event type", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EventVariable": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event variable was created.", - "type": "string" - }, - "DataSource": { - "enum": [ - "EVENT" - ], - "type": "string" - }, - "DataType": { - "enum": [ - "STRING", - "INTEGER", - "FLOAT", - "BOOLEAN" - ], - "type": "string" - }, - "DefaultValue": { - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the event variable was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event variable.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - }, - "VariableType": { - "enum": [ - "AUTH_CODE", - "AVS", - "BILLING_ADDRESS_L1", - "BILLING_ADDRESS_L2", - "BILLING_CITY", - "BILLING_COUNTRY", - "BILLING_NAME", - "BILLING_PHONE", - "BILLING_STATE", - "BILLING_ZIP", - "CARD_BIN", - "CATEGORICAL", - "CURRENCY_CODE", - "EMAIL_ADDRESS", - "FINGERPRINT", - "FRAUD_LABEL", - "FREE_FORM_TEXT", - "IP_ADDRESS", - "NUMERIC", - "ORDER_ID", - "PAYMENT_TYPE", - "PHONE_NUMBER", - "PRICE", - "PRODUCT_CATEGORY", - "SHIPPING_ADDRESS_L1", - "SHIPPING_ADDRESS_L2", - "SHIPPING_CITY", - "SHIPPING_COUNTRY", - "SHIPPING_NAME", - "SHIPPING_PHONE", - "SHIPPING_STATE", - "SHIPPING_ZIP", - "USERAGENT" - ], - "type": "string" - } - }, - "type": "object" - }, - "Label": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the label was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the label was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this label.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Model": { - "additionalProperties": false, - "description": "A model to associate with a detector.", - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "Outcome": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the outcome was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the outcome was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this outcome.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "DetectorId": { - "type": "string" - }, - "Expression": { - "type": "string" - }, - "Language": { - "enum": [ - "DETECTORPL" - ], - "type": "string" - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Outcomes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Outcome" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "RuleId": { - "type": "string" - }, - "RuleVersion": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A resource schema for a Detector in Amazon Fraud Detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:PutDetector", - "frauddetector:CreateDetectorVersion", - "frauddetector:UpdateDetectorVersionStatus", - "frauddetector:CreateRule", - "frauddetector:CreateVariable", - "frauddetector:PutLabel", - "frauddetector:PutOutcome", - "frauddetector:PutEntityType", - "frauddetector:PutEventType", - "frauddetector:DescribeDetector", - "frauddetector:GetDetectors", - "frauddetector:GetDetectorVersion", - "frauddetector:GetRules", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetExternalModels", - "frauddetector:GetModelVersion", - "frauddetector:GetLabels", - "frauddetector:GetOutcomes", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:GetDetectors", - "frauddetector:GetDetectorVersion", - "frauddetector:DescribeDetector", - "frauddetector:GetRules", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetOutcomes", - "frauddetector:GetEntityTypes", - "frauddetector:DeleteDetector", - "frauddetector:DeleteDetectorVersion", - "frauddetector:DeleteRule", - "frauddetector:DeleteEventType", - "frauddetector:DeleteVariable", - "frauddetector:DeleteLabel", - "frauddetector:DeleteOutcome", - "frauddetector:DeleteEntityType", - "frauddetector:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetDetectors", - "frauddetector:GetDetectorVersion", - "frauddetector:DescribeDetector", - "frauddetector:GetRules", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetExternalModels", - "frauddetector:GetModelVersion", - "frauddetector:GetLabels", - "frauddetector:GetOutcomes", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetDetectors", - "frauddetector:GetDetectorVersion", - "frauddetector:DescribeDetector", - "frauddetector:GetRules", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetExternalModels", - "frauddetector:GetModelVersion", - "frauddetector:GetLabels", - "frauddetector:GetOutcomes", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetDetectors", - "frauddetector:GetDetectorVersion", - "frauddetector:PutDetector", - "frauddetector:UpdateDetectorVersion", - "frauddetector:UpdateDetectorVersionStatus", - "frauddetector:UpdateDetectorVersionMetadata", - "frauddetector:UpdateRuleVersion", - "frauddetector:UpdateRuleMetadata", - "frauddetector:CreateRule", - "frauddetector:CreateVariable", - "frauddetector:UpdateVariable", - "frauddetector:GetVariables", - "frauddetector:PutLabel", - "frauddetector:PutOutcome", - "frauddetector:PutEntityType", - "frauddetector:PutEventType", - "frauddetector:GetRules", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetOutcomes", - "frauddetector:GetEntityTypes", - "frauddetector:GetExternalModels", - "frauddetector:GetModelVersion", - "frauddetector:DeleteEventType", - "frauddetector:DeleteVariable", - "frauddetector:DeleteLabel", - "frauddetector:DeleteEntityType", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the detector.", - "type": "string" - }, - "AssociatedModels": { - "description": "The models to associate with this detector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Model" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": false - }, - "CreatedTime": { - "description": "The time when the detector was created.", - "type": "string" - }, - "Description": { - "description": "The description of the detector.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "DetectorId": { - "description": "The ID of the detector", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "DetectorVersionId": { - "description": "The active version ID of the detector", - "type": "string" - }, - "DetectorVersionStatus": { - "description": "The desired detector version status for the detector", - "enum": [ - "DRAFT", - "ACTIVE" - ], - "type": "string" - }, - "EventType": { - "$ref": "#/definitions/EventType", - "description": "The event type to associate this detector with." - }, - "LastUpdatedTime": { - "description": "The time when the detector was last updated.", - "type": "string" - }, - "RuleExecutionMode": { - "enum": [ - "FIRST_MATCHED", - "ALL_MATCHED" - ], - "type": "string" - }, - "Rules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Rule" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "Tags associated with this detector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DetectorVersionId", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/Rules/*/RuleVersion", - "/properties/Rules/*/Arn", - "/properties/Rules/*/CreatedTime", - "/properties/Rules/*/LastUpdatedTime", - "/properties/Rules/*/Outcomes/*/Arn", - "/properties/Rules/*/Outcomes/*/CreatedTime", - "/properties/Rules/*/Outcomes/*/LastUpdatedTime", - "/properties/EventType/Arn", - "/properties/EventType/CreatedTime", - "/properties/EventType/LastUpdatedTime", - "/properties/EventType/EventVariables/*/Arn", - "/properties/EventType/EventVariables/*/CreatedTime", - "/properties/EventType/EventVariables/*/LastUpdatedTime", - "/properties/EventType/Labels/*/Arn", - "/properties/EventType/Labels/*/CreatedTime", - "/properties/EventType/Labels/*/LastUpdatedTime", - "/properties/EventType/EntityTypes/*/Arn", - "/properties/EventType/EntityTypes/*/CreatedTime", - "/properties/EventType/EntityTypes/*/LastUpdatedTime", - "/properties/AssociatedModels/*/Arn" - ], - "required": [ - "DetectorId", - "EventType", - "Rules" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::Detector" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorId" + ], + "definitions": { + "EntityType": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the entity type was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the entity type was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this entity type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EventType": { + "additionalProperties": false, + "properties": { + "Arn": { + "description": "The ARN of the event type.", + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "Description": { + "description": "The description of the event type.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "EntityTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EntityType" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "EventVariables": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventVariable" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Inline": { + "type": "boolean" + }, + "Labels": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Label" + }, + "minItems": 2, + "type": "array", + "uniqueItems": false + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Name": { + "description": "The name for the event type", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EventVariable": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event variable was created.", + "type": "string" + }, + "DataSource": { + "enum": [ + "EVENT" + ], + "type": "string" + }, + "DataType": { + "enum": [ + "STRING", + "INTEGER", + "FLOAT", + "BOOLEAN" + ], + "type": "string" + }, + "DefaultValue": { + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the event variable was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event variable.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + }, + "VariableType": { + "enum": [ + "AUTH_CODE", + "AVS", + "BILLING_ADDRESS_L1", + "BILLING_ADDRESS_L2", + "BILLING_CITY", + "BILLING_COUNTRY", + "BILLING_NAME", + "BILLING_PHONE", + "BILLING_STATE", + "BILLING_ZIP", + "CARD_BIN", + "CATEGORICAL", + "CURRENCY_CODE", + "EMAIL_ADDRESS", + "FINGERPRINT", + "FRAUD_LABEL", + "FREE_FORM_TEXT", + "IP_ADDRESS", + "NUMERIC", + "ORDER_ID", + "PAYMENT_TYPE", + "PHONE_NUMBER", + "PRICE", + "PRODUCT_CATEGORY", + "SHIPPING_ADDRESS_L1", + "SHIPPING_ADDRESS_L2", + "SHIPPING_CITY", + "SHIPPING_COUNTRY", + "SHIPPING_NAME", + "SHIPPING_PHONE", + "SHIPPING_STATE", + "SHIPPING_ZIP", + "USERAGENT" + ], + "type": "string" + } + }, + "type": "object" + }, + "Label": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the label was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the label was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this label.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Model": { + "additionalProperties": false, + "description": "A model to associate with a detector.", + "properties": { + "Arn": { + "type": "string" + } + }, + "type": "object" + }, + "Outcome": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the outcome was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the outcome was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this outcome.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DetectorId": { + "type": "string" + }, + "Expression": { + "type": "string" + }, + "Language": { + "enum": [ + "DETECTORPL" + ], + "type": "string" + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Outcomes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Outcome" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "RuleId": { + "type": "string" + }, + "RuleVersion": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A resource schema for a Detector in Amazon Fraud Detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:PutDetector", + "frauddetector:CreateDetectorVersion", + "frauddetector:UpdateDetectorVersionStatus", + "frauddetector:CreateRule", + "frauddetector:CreateVariable", + "frauddetector:PutLabel", + "frauddetector:PutOutcome", + "frauddetector:PutEntityType", + "frauddetector:PutEventType", + "frauddetector:DescribeDetector", + "frauddetector:GetDetectors", + "frauddetector:GetDetectorVersion", + "frauddetector:GetRules", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetExternalModels", + "frauddetector:GetModelVersion", + "frauddetector:GetLabels", + "frauddetector:GetOutcomes", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:GetDetectors", + "frauddetector:GetDetectorVersion", + "frauddetector:DescribeDetector", + "frauddetector:GetRules", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetOutcomes", + "frauddetector:GetEntityTypes", + "frauddetector:DeleteDetector", + "frauddetector:DeleteDetectorVersion", + "frauddetector:DeleteRule", + "frauddetector:DeleteEventType", + "frauddetector:DeleteVariable", + "frauddetector:DeleteLabel", + "frauddetector:DeleteOutcome", + "frauddetector:DeleteEntityType", + "frauddetector:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetDetectors", + "frauddetector:GetDetectorVersion", + "frauddetector:DescribeDetector", + "frauddetector:GetRules", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetExternalModels", + "frauddetector:GetModelVersion", + "frauddetector:GetLabels", + "frauddetector:GetOutcomes", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetDetectors", + "frauddetector:GetDetectorVersion", + "frauddetector:DescribeDetector", + "frauddetector:GetRules", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetExternalModels", + "frauddetector:GetModelVersion", + "frauddetector:GetLabels", + "frauddetector:GetOutcomes", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetDetectors", + "frauddetector:GetDetectorVersion", + "frauddetector:PutDetector", + "frauddetector:UpdateDetectorVersion", + "frauddetector:UpdateDetectorVersionStatus", + "frauddetector:UpdateDetectorVersionMetadata", + "frauddetector:UpdateRuleVersion", + "frauddetector:UpdateRuleMetadata", + "frauddetector:CreateRule", + "frauddetector:CreateVariable", + "frauddetector:UpdateVariable", + "frauddetector:GetVariables", + "frauddetector:PutLabel", + "frauddetector:PutOutcome", + "frauddetector:PutEntityType", + "frauddetector:PutEventType", + "frauddetector:GetRules", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetOutcomes", + "frauddetector:GetEntityTypes", + "frauddetector:GetExternalModels", + "frauddetector:GetModelVersion", + "frauddetector:DeleteEventType", + "frauddetector:DeleteVariable", + "frauddetector:DeleteLabel", + "frauddetector:DeleteEntityType", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the detector.", + "type": "string" + }, + "AssociatedModels": { + "description": "The models to associate with this detector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Model" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": false + }, + "CreatedTime": { + "description": "The time when the detector was created.", + "type": "string" + }, + "Description": { + "description": "The description of the detector.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "DetectorId": { + "description": "The ID of the detector", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "DetectorVersionId": { + "description": "The active version ID of the detector", + "type": "string" + }, + "DetectorVersionStatus": { + "description": "The desired detector version status for the detector", + "enum": [ + "DRAFT", + "ACTIVE" + ], + "type": "string" + }, + "EventType": { + "$ref": "#/definitions/EventType", + "description": "The event type to associate this detector with." + }, + "LastUpdatedTime": { + "description": "The time when the detector was last updated.", + "type": "string" + }, + "RuleExecutionMode": { + "enum": [ + "FIRST_MATCHED", + "ALL_MATCHED" + ], + "type": "string" + }, + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Rule" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "Tags associated with this detector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DetectorVersionId", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/Rules/*/RuleVersion", + "/properties/Rules/*/Arn", + "/properties/Rules/*/CreatedTime", + "/properties/Rules/*/LastUpdatedTime", + "/properties/Rules/*/Outcomes/*/Arn", + "/properties/Rules/*/Outcomes/*/CreatedTime", + "/properties/Rules/*/Outcomes/*/LastUpdatedTime", + "/properties/EventType/Arn", + "/properties/EventType/CreatedTime", + "/properties/EventType/LastUpdatedTime", + "/properties/EventType/EventVariables/*/Arn", + "/properties/EventType/EventVariables/*/CreatedTime", + "/properties/EventType/EventVariables/*/LastUpdatedTime", + "/properties/EventType/Labels/*/Arn", + "/properties/EventType/Labels/*/CreatedTime", + "/properties/EventType/Labels/*/LastUpdatedTime", + "/properties/EventType/EntityTypes/*/Arn", + "/properties/EventType/EntityTypes/*/CreatedTime", + "/properties/EventType/EntityTypes/*/LastUpdatedTime", + "/properties/AssociatedModels/*/Arn" + ], + "required": [ + "DetectorId", + "EventType", + "Rules" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::Detector" +} diff --git a/schema/aws-frauddetector-entitytype.json b/schema/aws-frauddetector-entitytype.json index d70774a..91543cc 100644 --- a/schema/aws-frauddetector-entitytype.json +++ b/schema/aws-frauddetector-entitytype.json @@ -1,116 +1,116 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An entity type for fraud detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:GetEntityTypes", - "frauddetector:PutEntityType", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:GetEntityTypes", - "frauddetector:DeleteEntityType" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetEntityTypes", - "frauddetector:PutEntityType", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The entity type ARN.", - "type": "string" - }, - "CreatedTime": { - "description": "The timestamp when the entity type was created.", - "type": "string" - }, - "Description": { - "description": "The entity type description.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LastUpdatedTime": { - "description": "The timestamp when the entity type was last updated.", - "type": "string" - }, - "Name": { - "description": "The name of the entity type.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this entity type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::EntityType" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An entity type for fraud detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:GetEntityTypes", + "frauddetector:PutEntityType", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:GetEntityTypes", + "frauddetector:DeleteEntityType" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetEntityTypes", + "frauddetector:PutEntityType", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The entity type ARN.", + "type": "string" + }, + "CreatedTime": { + "description": "The timestamp when the entity type was created.", + "type": "string" + }, + "Description": { + "description": "The entity type description.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LastUpdatedTime": { + "description": "The timestamp when the entity type was last updated.", + "type": "string" + }, + "Name": { + "description": "The name of the entity type.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this entity type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::EntityType" +} diff --git a/schema/aws-frauddetector-eventtype.json b/schema/aws-frauddetector-eventtype.json index b80bf63..69c33e2 100644 --- a/schema/aws-frauddetector-eventtype.json +++ b/schema/aws-frauddetector-eventtype.json @@ -1,365 +1,365 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "EntityType": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EventVariable": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "DataSource": { - "enum": [ - "EVENT" - ], - "type": "string" - }, - "DataType": { - "enum": [ - "STRING", - "INTEGER", - "FLOAT", - "BOOLEAN" - ], - "type": "string" - }, - "DefaultValue": { - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - }, - "VariableType": { - "enum": [ - "AUTH_CODE", - "AVS", - "BILLING_ADDRESS_L1", - "BILLING_ADDRESS_L2", - "BILLING_CITY", - "BILLING_COUNTRY", - "BILLING_NAME", - "BILLING_PHONE", - "BILLING_STATE", - "BILLING_ZIP", - "CARD_BIN", - "CATEGORICAL", - "CURRENCY_CODE", - "EMAIL_ADDRESS", - "FINGERPRINT", - "FRAUD_LABEL", - "FREE_FORM_TEXT", - "IP_ADDRESS", - "NUMERIC", - "ORDER_ID", - "PAYMENT_TYPE", - "PHONE_NUMBER", - "PRICE", - "PRODUCT_CATEGORY", - "SHIPPING_ADDRESS_L1", - "SHIPPING_ADDRESS_L2", - "SHIPPING_CITY", - "SHIPPING_COUNTRY", - "SHIPPING_NAME", - "SHIPPING_PHONE", - "SHIPPING_STATE", - "SHIPPING_ZIP", - "USERAGENT" - ], - "type": "string" - } - }, - "type": "object" - }, - "Label": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Inline": { - "type": "boolean" - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A resource schema for an EventType in Amazon Fraud Detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:BatchCreateVariable", - "frauddetector:BatchGetVariable", - "frauddetector:CreateVariable", - "frauddetector:GetVariables", - "frauddetector:PutLabel", - "frauddetector:PutEntityType", - "frauddetector:PutEventType", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:BatchGetVariable", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetEntityTypes", - "frauddetector:DeleteEventType", - "frauddetector:DeleteVariable", - "frauddetector:DeleteLabel", - "frauddetector:DeleteEntityType", - "frauddetector:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "frauddetector:BatchGetVariable", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:BatchGetVariable", - "frauddetector:GetVariables", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetEntityTypes", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:BatchCreateVariable", - "frauddetector:BatchGetVariable", - "frauddetector:CreateVariable", - "frauddetector:UpdateVariable", - "frauddetector:GetVariables", - "frauddetector:PutLabel", - "frauddetector:PutEntityType", - "frauddetector:PutEventType", - "frauddetector:GetEventTypes", - "frauddetector:GetLabels", - "frauddetector:GetEntityTypes", - "frauddetector:DeleteEventType", - "frauddetector:DeleteVariable", - "frauddetector:DeleteLabel", - "frauddetector:DeleteEntityType", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the event type.", - "type": "string" - }, - "CreatedTime": { - "description": "The time when the event type was created.", - "type": "string" - }, - "Description": { - "description": "The description of the event type.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "EntityTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EntityType" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "EventVariables": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventVariable" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Labels": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Label" - }, - "minItems": 2, - "type": "array", - "uniqueItems": false - }, - "LastUpdatedTime": { - "description": "The time when the event type was last updated.", - "type": "string" - }, - "Name": { - "description": "The name for the event type", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this event type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/EventVariables/*/Arn", - "/properties/EventVariables/*/CreatedTime", - "/properties/EventVariables/*/LastUpdatedTime", - "/properties/Labels/*/Arn", - "/properties/Labels/*/CreatedTime", - "/properties/Labels/*/LastUpdatedTime", - "/properties/EntityTypes/*/Arn", - "/properties/EntityTypes/*/CreatedTime", - "/properties/EntityTypes/*/LastUpdatedTime" - ], - "required": [ - "EntityTypes", - "EventVariables", - "Labels", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::EventType" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "EntityType": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EventVariable": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "DataSource": { + "enum": [ + "EVENT" + ], + "type": "string" + }, + "DataType": { + "enum": [ + "STRING", + "INTEGER", + "FLOAT", + "BOOLEAN" + ], + "type": "string" + }, + "DefaultValue": { + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + }, + "VariableType": { + "enum": [ + "AUTH_CODE", + "AVS", + "BILLING_ADDRESS_L1", + "BILLING_ADDRESS_L2", + "BILLING_CITY", + "BILLING_COUNTRY", + "BILLING_NAME", + "BILLING_PHONE", + "BILLING_STATE", + "BILLING_ZIP", + "CARD_BIN", + "CATEGORICAL", + "CURRENCY_CODE", + "EMAIL_ADDRESS", + "FINGERPRINT", + "FRAUD_LABEL", + "FREE_FORM_TEXT", + "IP_ADDRESS", + "NUMERIC", + "ORDER_ID", + "PAYMENT_TYPE", + "PHONE_NUMBER", + "PRICE", + "PRODUCT_CATEGORY", + "SHIPPING_ADDRESS_L1", + "SHIPPING_ADDRESS_L2", + "SHIPPING_CITY", + "SHIPPING_COUNTRY", + "SHIPPING_NAME", + "SHIPPING_PHONE", + "SHIPPING_STATE", + "SHIPPING_ZIP", + "USERAGENT" + ], + "type": "string" + } + }, + "type": "object" + }, + "Label": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Inline": { + "type": "boolean" + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A resource schema for an EventType in Amazon Fraud Detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:BatchCreateVariable", + "frauddetector:BatchGetVariable", + "frauddetector:CreateVariable", + "frauddetector:GetVariables", + "frauddetector:PutLabel", + "frauddetector:PutEntityType", + "frauddetector:PutEventType", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:BatchGetVariable", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetEntityTypes", + "frauddetector:DeleteEventType", + "frauddetector:DeleteVariable", + "frauddetector:DeleteLabel", + "frauddetector:DeleteEntityType", + "frauddetector:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "frauddetector:BatchGetVariable", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:BatchGetVariable", + "frauddetector:GetVariables", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetEntityTypes", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:BatchCreateVariable", + "frauddetector:BatchGetVariable", + "frauddetector:CreateVariable", + "frauddetector:UpdateVariable", + "frauddetector:GetVariables", + "frauddetector:PutLabel", + "frauddetector:PutEntityType", + "frauddetector:PutEventType", + "frauddetector:GetEventTypes", + "frauddetector:GetLabels", + "frauddetector:GetEntityTypes", + "frauddetector:DeleteEventType", + "frauddetector:DeleteVariable", + "frauddetector:DeleteLabel", + "frauddetector:DeleteEntityType", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the event type.", + "type": "string" + }, + "CreatedTime": { + "description": "The time when the event type was created.", + "type": "string" + }, + "Description": { + "description": "The description of the event type.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "EntityTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EntityType" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "EventVariables": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventVariable" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Labels": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Label" + }, + "minItems": 2, + "type": "array", + "uniqueItems": false + }, + "LastUpdatedTime": { + "description": "The time when the event type was last updated.", + "type": "string" + }, + "Name": { + "description": "The name for the event type", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this event type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/EventVariables/*/Arn", + "/properties/EventVariables/*/CreatedTime", + "/properties/EventVariables/*/LastUpdatedTime", + "/properties/Labels/*/Arn", + "/properties/Labels/*/CreatedTime", + "/properties/Labels/*/LastUpdatedTime", + "/properties/EntityTypes/*/Arn", + "/properties/EntityTypes/*/CreatedTime", + "/properties/EntityTypes/*/LastUpdatedTime" + ], + "required": [ + "EntityTypes", + "EventVariables", + "Labels", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::EventType" +} diff --git a/schema/aws-frauddetector-label.json b/schema/aws-frauddetector-label.json index 73529ac..afc936c 100644 --- a/schema/aws-frauddetector-label.json +++ b/schema/aws-frauddetector-label.json @@ -1,116 +1,116 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An label for fraud detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:GetLabels", - "frauddetector:PutLabel", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:GetLabels", - "frauddetector:DeleteLabel" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetLabels", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetLabels", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetLabels", - "frauddetector:PutLabel", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The label ARN.", - "type": "string" - }, - "CreatedTime": { - "description": "The timestamp when the label was created.", - "type": "string" - }, - "Description": { - "description": "The label description.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LastUpdatedTime": { - "description": "The timestamp when the label was last updated.", - "type": "string" - }, - "Name": { - "description": "The name of the label.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this label.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::Label" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An label for fraud detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:GetLabels", + "frauddetector:PutLabel", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:GetLabels", + "frauddetector:DeleteLabel" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetLabels", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetLabels", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetLabels", + "frauddetector:PutLabel", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The label ARN.", + "type": "string" + }, + "CreatedTime": { + "description": "The timestamp when the label was created.", + "type": "string" + }, + "Description": { + "description": "The label description.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LastUpdatedTime": { + "description": "The timestamp when the label was last updated.", + "type": "string" + }, + "Name": { + "description": "The name of the label.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this label.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::Label" +} diff --git a/schema/aws-frauddetector-list.json b/schema/aws-frauddetector-list.json index 354abfc..3e5c4da 100644 --- a/schema/aws-frauddetector-list.json +++ b/schema/aws-frauddetector-list.json @@ -1,155 +1,155 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Element": { - "description": "An element in a list.", - "maxLength": 64, - "minLength": 1, - "pattern": "^\\S+( +\\S+)*$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A resource schema for a List in Amazon Fraud Detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:CreateList", - "frauddetector:GetListElements", - "frauddetector:GetListsMetadata", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UpdateList" - ] - }, - "delete": { - "permissions": [ - "frauddetector:DeleteList", - "frauddetector:GetListsMetadata" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetListElements", - "frauddetector:GetListsMetadata", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetListElements", - "frauddetector:GetListsMetadata", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetListElements", - "frauddetector:GetListsMetadata", - "frauddetector:ListTagsForResource", - "frauddetector:UntagResource", - "frauddetector:UpdateList", - "frauddetector:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The list ARN.", - "type": "string" - }, - "CreatedTime": { - "description": "The time when the list was created.", - "type": "string" - }, - "Description": { - "description": "The description of the list.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Elements": { - "description": "The elements in this list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Element" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "LastUpdatedTime": { - "description": "The time when the list was last updated.", - "type": "string" - }, - "Name": { - "description": "The name of the list.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - }, - "VariableType": { - "description": "The variable type of the list.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Z_]{1,64}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::FraudDetector::List" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Element": { + "description": "An element in a list.", + "maxLength": 64, + "minLength": 1, + "pattern": "^\\S+( +\\S+)*$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A resource schema for a List in Amazon Fraud Detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:CreateList", + "frauddetector:GetListElements", + "frauddetector:GetListsMetadata", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UpdateList" + ] + }, + "delete": { + "permissions": [ + "frauddetector:DeleteList", + "frauddetector:GetListsMetadata" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetListElements", + "frauddetector:GetListsMetadata", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetListElements", + "frauddetector:GetListsMetadata", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetListElements", + "frauddetector:GetListsMetadata", + "frauddetector:ListTagsForResource", + "frauddetector:UntagResource", + "frauddetector:UpdateList", + "frauddetector:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The list ARN.", + "type": "string" + }, + "CreatedTime": { + "description": "The time when the list was created.", + "type": "string" + }, + "Description": { + "description": "The description of the list.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Elements": { + "description": "The elements in this list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Element" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "LastUpdatedTime": { + "description": "The time when the list was last updated.", + "type": "string" + }, + "Name": { + "description": "The name of the list.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + }, + "VariableType": { + "description": "The variable type of the list.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Z_]{1,64}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::FraudDetector::List" +} diff --git a/schema/aws-frauddetector-outcome.json b/schema/aws-frauddetector-outcome.json index 5bcc104..c80744a 100644 --- a/schema/aws-frauddetector-outcome.json +++ b/schema/aws-frauddetector-outcome.json @@ -1,116 +1,116 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An outcome for rule evaluation.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:GetOutcomes", - "frauddetector:PutOutcome", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:GetOutcomes", - "frauddetector:DeleteOutcome" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetOutcomes", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetOutcomes", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetOutcomes", - "frauddetector:PutOutcome", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The outcome ARN.", - "type": "string" - }, - "CreatedTime": { - "description": "The timestamp when the outcome was created.", - "type": "string" - }, - "Description": { - "description": "The outcome description.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LastUpdatedTime": { - "description": "The timestamp when the outcome was last updated.", - "type": "string" - }, - "Name": { - "description": "The name of the outcome.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-z_-]+$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this outcome.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::Outcome" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An outcome for rule evaluation.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:GetOutcomes", + "frauddetector:PutOutcome", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:GetOutcomes", + "frauddetector:DeleteOutcome" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetOutcomes", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetOutcomes", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetOutcomes", + "frauddetector:PutOutcome", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The outcome ARN.", + "type": "string" + }, + "CreatedTime": { + "description": "The timestamp when the outcome was created.", + "type": "string" + }, + "Description": { + "description": "The outcome description.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LastUpdatedTime": { + "description": "The timestamp when the outcome was last updated.", + "type": "string" + }, + "Name": { + "description": "The name of the outcome.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-z_-]+$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this outcome.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::Outcome" +} diff --git a/schema/aws-frauddetector-variable.json b/schema/aws-frauddetector-variable.json index 0692699..1b52245 100644 --- a/schema/aws-frauddetector-variable.json +++ b/schema/aws-frauddetector-variable.json @@ -1,178 +1,178 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A resource schema for a Variable in Amazon Fraud Detector.", - "handlers": { - "create": { - "permissions": [ - "frauddetector:GetVariables", - "frauddetector:CreateVariable", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource" - ] - }, - "delete": { - "permissions": [ - "frauddetector:GetVariables", - "frauddetector:DeleteVariable" - ] - }, - "list": { - "permissions": [ - "frauddetector:GetVariables", - "frauddetector:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "frauddetector:GetVariables", - "frauddetector:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "frauddetector:GetVariables", - "frauddetector:UpdateVariable", - "frauddetector:ListTagsForResource", - "frauddetector:TagResource", - "frauddetector:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the variable.", - "type": "string" - }, - "CreatedTime": { - "description": "The time when the variable was created.", - "type": "string" - }, - "DataSource": { - "description": "The source of the data.", - "enum": [ - "EVENT", - "EXTERNAL_MODEL_SCORE" - ], - "type": "string" - }, - "DataType": { - "description": "The data type.", - "enum": [ - "STRING", - "INTEGER", - "FLOAT", - "BOOLEAN" - ], - "type": "string" - }, - "DefaultValue": { - "description": "The default value for the variable when no value is received.", - "type": "string" - }, - "Description": { - "description": "The description.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "LastUpdatedTime": { - "description": "The time when the variable was last updated.", - "type": "string" - }, - "Name": { - "description": "The name of the variable.", - "pattern": "^[a-z_][a-z0-9_]{0,99}?$", - "type": "string" - }, - "Tags": { - "description": "Tags associated with this variable.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": false - }, - "VariableType": { - "description": "The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types", - "enum": [ - "AUTH_CODE", - "AVS", - "BILLING_ADDRESS_L1", - "BILLING_ADDRESS_L2", - "BILLING_CITY", - "BILLING_COUNTRY", - "BILLING_NAME", - "BILLING_PHONE", - "BILLING_STATE", - "BILLING_ZIP", - "CARD_BIN", - "CATEGORICAL", - "CURRENCY_CODE", - "EMAIL_ADDRESS", - "FINGERPRINT", - "FRAUD_LABEL", - "FREE_FORM_TEXT", - "IP_ADDRESS", - "NUMERIC", - "ORDER_ID", - "PAYMENT_TYPE", - "PHONE_NUMBER", - "PRICE", - "PRODUCT_CATEGORY", - "SHIPPING_ADDRESS_L1", - "SHIPPING_ADDRESS_L2", - "SHIPPING_CITY", - "SHIPPING_COUNTRY", - "SHIPPING_NAME", - "SHIPPING_PHONE", - "SHIPPING_STATE", - "SHIPPING_ZIP", - "USERAGENT" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "DataType", - "DataSource", - "DefaultValue", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::FraudDetector::Variable" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A resource schema for a Variable in Amazon Fraud Detector.", + "handlers": { + "create": { + "permissions": [ + "frauddetector:GetVariables", + "frauddetector:CreateVariable", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource" + ] + }, + "delete": { + "permissions": [ + "frauddetector:GetVariables", + "frauddetector:DeleteVariable" + ] + }, + "list": { + "permissions": [ + "frauddetector:GetVariables", + "frauddetector:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "frauddetector:GetVariables", + "frauddetector:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "frauddetector:GetVariables", + "frauddetector:UpdateVariable", + "frauddetector:ListTagsForResource", + "frauddetector:TagResource", + "frauddetector:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the variable.", + "type": "string" + }, + "CreatedTime": { + "description": "The time when the variable was created.", + "type": "string" + }, + "DataSource": { + "description": "The source of the data.", + "enum": [ + "EVENT", + "EXTERNAL_MODEL_SCORE" + ], + "type": "string" + }, + "DataType": { + "description": "The data type.", + "enum": [ + "STRING", + "INTEGER", + "FLOAT", + "BOOLEAN" + ], + "type": "string" + }, + "DefaultValue": { + "description": "The default value for the variable when no value is received.", + "type": "string" + }, + "Description": { + "description": "The description.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "LastUpdatedTime": { + "description": "The time when the variable was last updated.", + "type": "string" + }, + "Name": { + "description": "The name of the variable.", + "pattern": "^[a-z_][a-z0-9_]{0,99}?$", + "type": "string" + }, + "Tags": { + "description": "Tags associated with this variable.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": false + }, + "VariableType": { + "description": "The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types", + "enum": [ + "AUTH_CODE", + "AVS", + "BILLING_ADDRESS_L1", + "BILLING_ADDRESS_L2", + "BILLING_CITY", + "BILLING_COUNTRY", + "BILLING_NAME", + "BILLING_PHONE", + "BILLING_STATE", + "BILLING_ZIP", + "CARD_BIN", + "CATEGORICAL", + "CURRENCY_CODE", + "EMAIL_ADDRESS", + "FINGERPRINT", + "FRAUD_LABEL", + "FREE_FORM_TEXT", + "IP_ADDRESS", + "NUMERIC", + "ORDER_ID", + "PAYMENT_TYPE", + "PHONE_NUMBER", + "PRICE", + "PRODUCT_CATEGORY", + "SHIPPING_ADDRESS_L1", + "SHIPPING_ADDRESS_L2", + "SHIPPING_CITY", + "SHIPPING_COUNTRY", + "SHIPPING_NAME", + "SHIPPING_PHONE", + "SHIPPING_STATE", + "SHIPPING_ZIP", + "USERAGENT" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "DataType", + "DataSource", + "DefaultValue", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::FraudDetector::Variable" +} diff --git a/schema/aws-fsx-datarepositoryassociation.json b/schema/aws-fsx-datarepositoryassociation.json index d271157..5046b60 100644 --- a/schema/aws-fsx-datarepositoryassociation.json +++ b/schema/aws-fsx-datarepositoryassociation.json @@ -1,212 +1,216 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FileSystemId", - "/properties/FileSystemPath", - "/properties/DataRepositoryPath", - "/properties/BatchImportMetaDataOnCreate" - ], - "definitions": { - "AutoExportPolicy": { - "additionalProperties": false, - "description": "Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association.", - "properties": { - "Events": { - "$ref": "#/definitions/EventTypes", - "description": "The ``AutoExportPolicy`` can have the following event values:\n + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system.\n + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository.\n + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system.\n \n You can define any combination of event types for your ``AutoExportPolicy``." - } - }, - "required": [ - "Events" - ], - "type": "object" - }, - "AutoImportPolicy": { - "additionalProperties": false, - "description": "Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association.", - "properties": { - "Events": { - "$ref": "#/definitions/EventTypes", - "description": "The ``AutoImportPolicy`` can have the following event values:\n + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.\n + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.\n + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.\n \n You can define any combination of event types for your ``AutoImportPolicy``." - } - }, - "required": [ - "Events" - ], - "type": "object" - }, - "EventType": { - "enum": [ - "NEW", - "CHANGED", - "DELETED" - ], - "type": "string" - }, - "EventTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventType" - }, - "maxItems": 3, - "type": "array", - "uniqueItems": true - }, - "S3": { - "additionalProperties": false, - "description": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.", - "properties": { - "AutoExportPolicy": { - "$ref": "#/definitions/AutoExportPolicy", - "description": "Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." - }, - "AutoImportPolicy": { - "$ref": "#/definitions/AutoImportPolicy", - "description": "Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Specifies a key-value pair for a resource tag.", - "properties": { - "Key": { - "description": "A value that specifies the ``TagKey``, the name of the tag. Tag keys must be unique for the resource to which they are attached.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value that specifies the ``TagValue``, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of ``finances : April`` and also of ``payroll : April``.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. \n Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).", - "handlers": { - "create": { - "permissions": [ - "fsx:CreateDataRepositoryAssociation", - "fsx:DescribeDataRepositoryAssociations", - "fsx:TagResource", - "s3:ListBucket", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy" - ], - "timeoutInMinutes": 120 - }, - "delete": { - "permissions": [ - "fsx:DescribeDataRepositoryAssociations", - "fsx:DeleteDataRepositoryAssociation" - ], - "timeoutInMinutes": 180 - }, - "list": { - "permissions": [ - "fsx:DescribeDataRepositoryAssociations" - ] - }, - "read": { - "permissions": [ - "fsx:DescribeDataRepositoryAssociations" - ] - }, - "update": { - "permissions": [ - "fsx:DescribeDataRepositoryAssociations", - "fsx:UpdateDataRepositoryAssociation", - "fsx:TagResource", - "fsx:UntagResource", - "s3:ListBucket", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy" - ], - "timeoutInMinutes": 180 - } - }, - "primaryIdentifier": [ - "/properties/AssociationId" - ], - "properties": { - "AssociationId": { - "description": "", - "type": "string" - }, - "BatchImportMetaDataOnCreate": { - "description": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``.", - "type": "boolean" - }, - "DataRepositoryPath": { - "description": "The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to.", - "type": "string" - }, - "FileSystemId": { - "description": "The ID of the file system on which the data repository association is configured.", - "type": "string" - }, - "FileSystemPath": { - "description": "A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.\n This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.\n If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.", - "type": "string" - }, - "ImportedFileChunkSize": { - "description": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.\n The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.", - "type": "integer" - }, - "ResourceARN": { - "description": "", - "type": "string" - }, - "S3": { - "$ref": "#/definitions/S3", - "description": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository." - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/AssociationId", - "/properties/ResourceARN" - ], - "required": [ - "FileSystemId", - "FileSystemPath", - "DataRepositoryPath" - ], - "resourceLink": { - "mappings": { - "AssociationId": "/AssociationId", - "FileSystemId": "/FileSystemId" - }, - "templateUri": "/fsx/home?region=${awsRegion}#data-repository-associations-details/${FileSystemId}/${AssociationId}" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fsx.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::FSx::DataRepositoryAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FileSystemId", + "/properties/FileSystemPath", + "/properties/DataRepositoryPath", + "/properties/BatchImportMetaDataOnCreate" + ], + "definitions": { + "AutoExportPolicy": { + "additionalProperties": false, + "description": "Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association.", + "properties": { + "Events": { + "$ref": "#/definitions/EventTypes", + "description": "The ``AutoExportPolicy`` can have the following event values:\n + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system.\n + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository.\n + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system.\n \n You can define any combination of event types for your ``AutoExportPolicy``." + } + }, + "required": [ + "Events" + ], + "type": "object" + }, + "AutoImportPolicy": { + "additionalProperties": false, + "description": "Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association.", + "properties": { + "Events": { + "$ref": "#/definitions/EventTypes", + "description": "The ``AutoImportPolicy`` can have the following event values:\n + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.\n + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.\n + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.\n \n You can define any combination of event types for your ``AutoImportPolicy``." + } + }, + "required": [ + "Events" + ], + "type": "object" + }, + "EventType": { + "enum": [ + "NEW", + "CHANGED", + "DELETED" + ], + "type": "string" + }, + "EventTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventType" + }, + "maxItems": 3, + "type": "array", + "uniqueItems": true + }, + "S3": { + "additionalProperties": false, + "description": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.", + "properties": { + "AutoExportPolicy": { + "$ref": "#/definitions/AutoExportPolicy", + "description": "Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." + }, + "AutoImportPolicy": { + "$ref": "#/definitions/AutoImportPolicy", + "description": "Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Specifies a key-value pair for a resource tag.", + "properties": { + "Key": { + "description": "A value that specifies the ``TagKey``, the name of the tag. Tag keys must be unique for the resource to which they are attached.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value that specifies the ``TagValue``, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of ``finances : April`` and also of ``payroll : April``.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. \n Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).", + "handlers": { + "create": { + "permissions": [ + "fsx:CreateDataRepositoryAssociation", + "fsx:DescribeDataRepositoryAssociations", + "fsx:TagResource", + "s3:ListBucket", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy" + ], + "timeoutInMinutes": 120 + }, + "delete": { + "permissions": [ + "fsx:DescribeDataRepositoryAssociations", + "fsx:DeleteDataRepositoryAssociation" + ], + "timeoutInMinutes": 180 + }, + "list": { + "permissions": [ + "fsx:DescribeDataRepositoryAssociations" + ] + }, + "read": { + "permissions": [ + "fsx:DescribeDataRepositoryAssociations" + ] + }, + "update": { + "permissions": [ + "fsx:DescribeDataRepositoryAssociations", + "fsx:UpdateDataRepositoryAssociation", + "fsx:TagResource", + "fsx:UntagResource", + "s3:ListBucket", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy" + ], + "timeoutInMinutes": 180 + } + }, + "primaryIdentifier": [ + "/properties/AssociationId" + ], + "properties": { + "AssociationId": { + "description": "", + "type": "string" + }, + "BatchImportMetaDataOnCreate": { + "description": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``.", + "type": "boolean" + }, + "DataRepositoryPath": { + "description": "The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to.", + "type": "string" + }, + "FileSystemId": { + "description": "The ID of the file system on which the data repository association is configured.", + "type": "string" + }, + "FileSystemPath": { + "description": "A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.\n This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.\n If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.", + "type": "string" + }, + "ImportedFileChunkSize": { + "description": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.\n The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.", + "type": "integer" + }, + "ResourceARN": { + "description": "", + "type": "string" + }, + "S3": { + "$ref": "#/definitions/S3", + "description": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository." + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/AssociationId", + "/properties/ResourceARN" + ], + "required": [ + "FileSystemId", + "FileSystemPath", + "DataRepositoryPath" + ], + "resourceLink": { + "mappings": { + "AssociationId": "/AssociationId", + "FileSystemId": "/FileSystemId" + }, + "templateUri": "/fsx/home?region=${awsRegion}#data-repository-associations-details/${FileSystemId}/${AssociationId}" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fsx.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "fsx:TagResource", + "fsx:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::FSx::DataRepositoryAssociation" +} diff --git a/schema/aws-fsx-filesystem.json b/schema/aws-fsx-filesystem.json index a0a4733..ae370d6 100644 --- a/schema/aws-fsx-filesystem.json +++ b/schema/aws-fsx-filesystem.json @@ -1,459 +1,459 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/SecurityGroupIds", - "/properties/FileSystemTypeVersion", - "/properties/FileSystemType", - "/properties/SubnetIds", - "/properties/BackupId" - ], - "definitions": { - "AuditLogConfiguration": { - "additionalProperties": false, - "properties": { - "AuditLogDestination": { - "type": "string" - }, - "FileAccessAuditLogLevel": { - "type": "string" - }, - "FileShareAccessAuditLogLevel": { - "type": "string" - } - }, - "required": [ - "FileAccessAuditLogLevel", - "FileShareAccessAuditLogLevel" - ], - "type": "object" - }, - "ClientConfigurations": { - "additionalProperties": false, - "properties": { - "Clients": { - "type": "string" - }, - "Options": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DiskIopsConfiguration": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "integer" - }, - "Mode": { - "type": "string" - } - }, - "type": "object" - }, - "LustreConfiguration": { - "additionalProperties": false, - "properties": { - "AutoImportPolicy": { - "type": "string" - }, - "AutomaticBackupRetentionDays": { - "type": "integer" - }, - "CopyTagsToBackups": { - "type": "boolean" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DataCompressionType": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "DriveCacheType": { - "type": "string" - }, - "ExportPath": { - "type": "string" - }, - "ImportPath": { - "type": "string" - }, - "ImportedFileChunkSize": { - "type": "integer" - }, - "MetadataConfiguration": { - "$ref": "#/definitions/MetadataConfiguration" - }, - "PerUnitStorageThroughput": { - "type": "integer" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "type": "object" - }, - "MetadataConfiguration": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "integer" - }, - "Mode": { - "type": "string" - } - }, - "type": "object" - }, - "NfsExports": { - "additionalProperties": false, - "properties": { - "ClientConfigurations": { - "items": { - "$ref": "#/definitions/ClientConfigurations" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OntapConfiguration": { - "additionalProperties": false, - "properties": { - "AutomaticBackupRetentionDays": { - "type": "integer" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "DiskIopsConfiguration": { - "$ref": "#/definitions/DiskIopsConfiguration" - }, - "EndpointIpAddressRange": { - "type": "string" - }, - "FsxAdminPassword": { - "type": "string" - }, - "HAPairs": { - "type": "integer" - }, - "PreferredSubnetId": { - "type": "string" - }, - "RouteTableIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ThroughputCapacity": { - "type": "integer" - }, - "ThroughputCapacityPerHAPair": { - "type": "integer" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "required": [ - "DeploymentType" - ], - "type": "object" - }, - "OpenZFSConfiguration": { - "additionalProperties": false, - "properties": { - "AutomaticBackupRetentionDays": { - "type": "integer" - }, - "CopyTagsToBackups": { - "type": "boolean" - }, - "CopyTagsToVolumes": { - "type": "boolean" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "DiskIopsConfiguration": { - "$ref": "#/definitions/DiskIopsConfiguration" - }, - "EndpointIpAddressRange": { - "type": "string" - }, - "Options": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PreferredSubnetId": { - "type": "string" - }, - "RootVolumeConfiguration": { - "$ref": "#/definitions/RootVolumeConfiguration" - }, - "RouteTableIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ThroughputCapacity": { - "type": "integer" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "required": [ - "DeploymentType" - ], - "type": "object" - }, - "RootVolumeConfiguration": { - "additionalProperties": false, - "properties": { - "CopyTagsToSnapshots": { - "type": "boolean" - }, - "DataCompressionType": { - "type": "string" - }, - "NfsExports": { - "items": { - "$ref": "#/definitions/NfsExports" - }, - "type": "array", - "uniqueItems": false - }, - "ReadOnly": { - "type": "boolean" - }, - "RecordSizeKiB": { - "type": "integer" - }, - "UserAndGroupQuotas": { - "items": { - "$ref": "#/definitions/UserAndGroupQuotas" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SelfManagedActiveDirectoryConfiguration": { - "additionalProperties": false, - "properties": { - "DnsIps": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "DomainName": { - "type": "string" - }, - "FileSystemAdministratorsGroup": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "UserAndGroupQuotas": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "integer" - }, - "StorageCapacityQuotaGiB": { - "type": "integer" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "WindowsConfiguration": { - "additionalProperties": false, - "properties": { - "ActiveDirectoryId": { - "type": "string" - }, - "Aliases": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AuditLogConfiguration": { - "$ref": "#/definitions/AuditLogConfiguration" - }, - "AutomaticBackupRetentionDays": { - "type": "integer" - }, - "CopyTagsToBackups": { - "type": "boolean" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "DiskIopsConfiguration": { - "$ref": "#/definitions/DiskIopsConfiguration" - }, - "PreferredSubnetId": { - "type": "string" - }, - "SelfManagedActiveDirectoryConfiguration": { - "$ref": "#/definitions/SelfManagedActiveDirectoryConfiguration" - }, - "ThroughputCapacity": { - "type": "integer" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "required": [ - "ThroughputCapacity" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::FSx::FileSystem", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "BackupId": { - "type": "string" - }, - "DNSName": { - "type": "string" - }, - "FileSystemType": { - "type": "string" - }, - "FileSystemTypeVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "LustreConfiguration": { - "$ref": "#/definitions/LustreConfiguration" - }, - "LustreMountName": { - "type": "string" - }, - "OntapConfiguration": { - "$ref": "#/definitions/OntapConfiguration" - }, - "OpenZFSConfiguration": { - "$ref": "#/definitions/OpenZFSConfiguration" - }, - "ResourceARN": { - "type": "string" - }, - "RootVolumeId": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StorageCapacity": { - "type": "integer" - }, - "StorageType": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "WindowsConfiguration": { - "$ref": "#/definitions/WindowsConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/ResourceARN", - "/properties/Id", - "/properties/LustreMountName", - "/properties/RootVolumeId", - "/properties/DNSName" - ], - "required": [ - "FileSystemType", - "SubnetIds" - ], - "typeName": "AWS::FSx::FileSystem" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/SecurityGroupIds", + "/properties/FileSystemTypeVersion", + "/properties/FileSystemType", + "/properties/SubnetIds", + "/properties/BackupId" + ], + "definitions": { + "AuditLogConfiguration": { + "additionalProperties": false, + "properties": { + "AuditLogDestination": { + "type": "string" + }, + "FileAccessAuditLogLevel": { + "type": "string" + }, + "FileShareAccessAuditLogLevel": { + "type": "string" + } + }, + "required": [ + "FileAccessAuditLogLevel", + "FileShareAccessAuditLogLevel" + ], + "type": "object" + }, + "ClientConfigurations": { + "additionalProperties": false, + "properties": { + "Clients": { + "type": "string" + }, + "Options": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DiskIopsConfiguration": { + "additionalProperties": false, + "properties": { + "Iops": { + "type": "integer" + }, + "Mode": { + "type": "string" + } + }, + "type": "object" + }, + "LustreConfiguration": { + "additionalProperties": false, + "properties": { + "AutoImportPolicy": { + "type": "string" + }, + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "CopyTagsToBackups": { + "type": "boolean" + }, + "DailyAutomaticBackupStartTime": { + "type": "string" + }, + "DataCompressionType": { + "type": "string" + }, + "DeploymentType": { + "type": "string" + }, + "DriveCacheType": { + "type": "string" + }, + "ExportPath": { + "type": "string" + }, + "ImportPath": { + "type": "string" + }, + "ImportedFileChunkSize": { + "type": "integer" + }, + "MetadataConfiguration": { + "$ref": "#/definitions/MetadataConfiguration" + }, + "PerUnitStorageThroughput": { + "type": "integer" + }, + "WeeklyMaintenanceStartTime": { + "type": "string" + } + }, + "type": "object" + }, + "MetadataConfiguration": { + "additionalProperties": false, + "properties": { + "Iops": { + "type": "integer" + }, + "Mode": { + "type": "string" + } + }, + "type": "object" + }, + "NfsExports": { + "additionalProperties": false, + "properties": { + "ClientConfigurations": { + "items": { + "$ref": "#/definitions/ClientConfigurations" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OntapConfiguration": { + "additionalProperties": false, + "properties": { + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "DailyAutomaticBackupStartTime": { + "type": "string" + }, + "DeploymentType": { + "type": "string" + }, + "DiskIopsConfiguration": { + "$ref": "#/definitions/DiskIopsConfiguration" + }, + "EndpointIpAddressRange": { + "type": "string" + }, + "FsxAdminPassword": { + "type": "string" + }, + "HAPairs": { + "type": "integer" + }, + "PreferredSubnetId": { + "type": "string" + }, + "RouteTableIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ThroughputCapacity": { + "type": "integer" + }, + "ThroughputCapacityPerHAPair": { + "type": "integer" + }, + "WeeklyMaintenanceStartTime": { + "type": "string" + } + }, + "required": [ + "DeploymentType" + ], + "type": "object" + }, + "OpenZFSConfiguration": { + "additionalProperties": false, + "properties": { + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "CopyTagsToBackups": { + "type": "boolean" + }, + "CopyTagsToVolumes": { + "type": "boolean" + }, + "DailyAutomaticBackupStartTime": { + "type": "string" + }, + "DeploymentType": { + "type": "string" + }, + "DiskIopsConfiguration": { + "$ref": "#/definitions/DiskIopsConfiguration" + }, + "EndpointIpAddressRange": { + "type": "string" + }, + "Options": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PreferredSubnetId": { + "type": "string" + }, + "RootVolumeConfiguration": { + "$ref": "#/definitions/RootVolumeConfiguration" + }, + "RouteTableIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ThroughputCapacity": { + "type": "integer" + }, + "WeeklyMaintenanceStartTime": { + "type": "string" + } + }, + "required": [ + "DeploymentType" + ], + "type": "object" + }, + "RootVolumeConfiguration": { + "additionalProperties": false, + "properties": { + "CopyTagsToSnapshots": { + "type": "boolean" + }, + "DataCompressionType": { + "type": "string" + }, + "NfsExports": { + "items": { + "$ref": "#/definitions/NfsExports" + }, + "type": "array", + "uniqueItems": false + }, + "ReadOnly": { + "type": "boolean" + }, + "RecordSizeKiB": { + "type": "integer" + }, + "UserAndGroupQuotas": { + "items": { + "$ref": "#/definitions/UserAndGroupQuotas" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SelfManagedActiveDirectoryConfiguration": { + "additionalProperties": false, + "properties": { + "DnsIps": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "DomainName": { + "type": "string" + }, + "FileSystemAdministratorsGroup": { + "type": "string" + }, + "OrganizationalUnitDistinguishedName": { + "type": "string" + }, + "Password": { + "type": "string" + }, + "UserName": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "UserAndGroupQuotas": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "integer" + }, + "StorageCapacityQuotaGiB": { + "type": "integer" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "WindowsConfiguration": { + "additionalProperties": false, + "properties": { + "ActiveDirectoryId": { + "type": "string" + }, + "Aliases": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AuditLogConfiguration": { + "$ref": "#/definitions/AuditLogConfiguration" + }, + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "CopyTagsToBackups": { + "type": "boolean" + }, + "DailyAutomaticBackupStartTime": { + "type": "string" + }, + "DeploymentType": { + "type": "string" + }, + "DiskIopsConfiguration": { + "$ref": "#/definitions/DiskIopsConfiguration" + }, + "PreferredSubnetId": { + "type": "string" + }, + "SelfManagedActiveDirectoryConfiguration": { + "$ref": "#/definitions/SelfManagedActiveDirectoryConfiguration" + }, + "ThroughputCapacity": { + "type": "integer" + }, + "WeeklyMaintenanceStartTime": { + "type": "string" + } + }, + "required": [ + "ThroughputCapacity" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::FSx::FileSystem", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "BackupId": { + "type": "string" + }, + "DNSName": { + "type": "string" + }, + "FileSystemType": { + "type": "string" + }, + "FileSystemTypeVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "LustreConfiguration": { + "$ref": "#/definitions/LustreConfiguration" + }, + "LustreMountName": { + "type": "string" + }, + "OntapConfiguration": { + "$ref": "#/definitions/OntapConfiguration" + }, + "OpenZFSConfiguration": { + "$ref": "#/definitions/OpenZFSConfiguration" + }, + "ResourceARN": { + "type": "string" + }, + "RootVolumeId": { + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StorageCapacity": { + "type": "integer" + }, + "StorageType": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "WindowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/ResourceARN", + "/properties/Id", + "/properties/LustreMountName", + "/properties/RootVolumeId", + "/properties/DNSName" + ], + "required": [ + "FileSystemType", + "SubnetIds" + ], + "typeName": "AWS::FSx::FileSystem" +} diff --git a/schema/aws-fsx-snapshot.json b/schema/aws-fsx-snapshot.json index 94ef0b2..9f50cc8 100644 --- a/schema/aws-fsx-snapshot.json +++ b/schema/aws-fsx-snapshot.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VolumeId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::FSx::Snapshot", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceARN": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VolumeId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceARN", - "/properties/Id" - ], - "required": [ - "VolumeId", - "Name" - ], - "typeName": "AWS::FSx::Snapshot" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VolumeId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::FSx::Snapshot", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceARN": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VolumeId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceARN", + "/properties/Id" + ], + "required": [ + "VolumeId", + "Name" + ], + "typeName": "AWS::FSx::Snapshot" +} diff --git a/schema/aws-fsx-storagevirtualmachine.json b/schema/aws-fsx-storagevirtualmachine.json index d20991e..3fa07bc 100644 --- a/schema/aws-fsx-storagevirtualmachine.json +++ b/schema/aws-fsx-storagevirtualmachine.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/RootVolumeSecurityStyle", - "/properties/FileSystemId" - ], - "definitions": { - "ActiveDirectoryConfiguration": { - "additionalProperties": false, - "properties": { - "NetBiosName": { - "type": "string" - }, - "SelfManagedActiveDirectoryConfiguration": { - "$ref": "#/definitions/SelfManagedActiveDirectoryConfiguration" - } - }, - "type": "object" - }, - "SelfManagedActiveDirectoryConfiguration": { - "additionalProperties": false, - "properties": { - "DnsIps": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "DomainName": { - "type": "string" - }, - "FileSystemAdministratorsGroup": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::FSx::StorageVirtualMachine", - "primaryIdentifier": [ - "/properties/StorageVirtualMachineId" - ], - "properties": { - "ActiveDirectoryConfiguration": { - "$ref": "#/definitions/ActiveDirectoryConfiguration" - }, - "FileSystemId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceARN": { - "type": "string" - }, - "RootVolumeSecurityStyle": { - "type": "string" - }, - "StorageVirtualMachineId": { - "type": "string" - }, - "SvmAdminPassword": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UUID": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceARN", - "/properties/UUID", - "/properties/StorageVirtualMachineId" - ], - "required": [ - "FileSystemId", - "Name" - ], - "typeName": "AWS::FSx::StorageVirtualMachine" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/RootVolumeSecurityStyle", + "/properties/FileSystemId" + ], + "definitions": { + "ActiveDirectoryConfiguration": { + "additionalProperties": false, + "properties": { + "NetBiosName": { + "type": "string" + }, + "SelfManagedActiveDirectoryConfiguration": { + "$ref": "#/definitions/SelfManagedActiveDirectoryConfiguration" + } + }, + "type": "object" + }, + "SelfManagedActiveDirectoryConfiguration": { + "additionalProperties": false, + "properties": { + "DnsIps": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "DomainName": { + "type": "string" + }, + "FileSystemAdministratorsGroup": { + "type": "string" + }, + "OrganizationalUnitDistinguishedName": { + "type": "string" + }, + "Password": { + "type": "string" + }, + "UserName": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::FSx::StorageVirtualMachine", + "primaryIdentifier": [ + "/properties/StorageVirtualMachineId" + ], + "properties": { + "ActiveDirectoryConfiguration": { + "$ref": "#/definitions/ActiveDirectoryConfiguration" + }, + "FileSystemId": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceARN": { + "type": "string" + }, + "RootVolumeSecurityStyle": { + "type": "string" + }, + "StorageVirtualMachineId": { + "type": "string" + }, + "SvmAdminPassword": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UUID": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceARN", + "/properties/UUID", + "/properties/StorageVirtualMachineId" + ], + "required": [ + "FileSystemId", + "Name" + ], + "typeName": "AWS::FSx::StorageVirtualMachine" +} diff --git a/schema/aws-fsx-volume.json b/schema/aws-fsx-volume.json index 6a72262..4a5995d 100644 --- a/schema/aws-fsx-volume.json +++ b/schema/aws-fsx-volume.json @@ -1,350 +1,350 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BackupId", - "/properties/VolumeType" - ], - "definitions": { - "AggregateConfiguration": { - "additionalProperties": false, - "properties": { - "Aggregates": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ConstituentsPerAggregate": { - "type": "integer" - } - }, - "type": "object" - }, - "AutocommitPeriod": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ClientConfigurations": { - "additionalProperties": false, - "properties": { - "Clients": { - "type": "string" - }, - "Options": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Options", - "Clients" - ], - "type": "object" - }, - "NfsExports": { - "additionalProperties": false, - "properties": { - "ClientConfigurations": { - "items": { - "$ref": "#/definitions/ClientConfigurations" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ClientConfigurations" - ], - "type": "object" - }, - "OntapConfiguration": { - "additionalProperties": false, - "properties": { - "AggregateConfiguration": { - "$ref": "#/definitions/AggregateConfiguration" - }, - "CopyTagsToBackups": { - "type": "string" - }, - "JunctionPath": { - "type": "string" - }, - "OntapVolumeType": { - "type": "string" - }, - "SecurityStyle": { - "type": "string" - }, - "SizeInBytes": { - "type": "string" - }, - "SizeInMegabytes": { - "type": "string" - }, - "SnaplockConfiguration": { - "$ref": "#/definitions/SnaplockConfiguration" - }, - "SnapshotPolicy": { - "type": "string" - }, - "StorageEfficiencyEnabled": { - "type": "string" - }, - "StorageVirtualMachineId": { - "type": "string" - }, - "TieringPolicy": { - "$ref": "#/definitions/TieringPolicy" - }, - "VolumeStyle": { - "type": "string" - } - }, - "required": [ - "StorageVirtualMachineId" - ], - "type": "object" - }, - "OpenZFSConfiguration": { - "additionalProperties": false, - "properties": { - "CopyTagsToSnapshots": { - "type": "boolean" - }, - "DataCompressionType": { - "type": "string" - }, - "NfsExports": { - "items": { - "$ref": "#/definitions/NfsExports" - }, - "type": "array", - "uniqueItems": false - }, - "Options": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "OriginSnapshot": { - "$ref": "#/definitions/OriginSnapshot" - }, - "ParentVolumeId": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "RecordSizeKiB": { - "type": "integer" - }, - "StorageCapacityQuotaGiB": { - "type": "integer" - }, - "StorageCapacityReservationGiB": { - "type": "integer" - }, - "UserAndGroupQuotas": { - "items": { - "$ref": "#/definitions/UserAndGroupQuotas" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ParentVolumeId" - ], - "type": "object" - }, - "OriginSnapshot": { - "additionalProperties": false, - "properties": { - "CopyStrategy": { - "type": "string" - }, - "SnapshotARN": { - "type": "string" - } - }, - "required": [ - "CopyStrategy", - "SnapshotARN" - ], - "type": "object" - }, - "RetentionPeriod": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SnaplockConfiguration": { - "additionalProperties": false, - "properties": { - "AuditLogVolume": { - "type": "string" - }, - "AutocommitPeriod": { - "$ref": "#/definitions/AutocommitPeriod" - }, - "PrivilegedDelete": { - "type": "string" - }, - "RetentionPeriod": { - "$ref": "#/definitions/SnaplockRetentionPeriod" - }, - "SnaplockType": { - "type": "string" - }, - "VolumeAppendModeEnabled": { - "type": "string" - } - }, - "required": [ - "SnaplockType" - ], - "type": "object" - }, - "SnaplockRetentionPeriod": { - "additionalProperties": false, - "properties": { - "DefaultRetention": { - "$ref": "#/definitions/RetentionPeriod" - }, - "MaximumRetention": { - "$ref": "#/definitions/RetentionPeriod" - }, - "MinimumRetention": { - "$ref": "#/definitions/RetentionPeriod" - } - }, - "required": [ - "DefaultRetention", - "MaximumRetention", - "MinimumRetention" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TieringPolicy": { - "additionalProperties": false, - "properties": { - "CoolingPeriod": { - "type": "integer" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "UserAndGroupQuotas": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "integer" - }, - "StorageCapacityQuotaGiB": { - "type": "integer" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Id", - "StorageCapacityQuotaGiB" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::FSx::Volume", - "primaryIdentifier": [ - "/properties/VolumeId" - ], - "properties": { - "BackupId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OntapConfiguration": { - "$ref": "#/definitions/OntapConfiguration" - }, - "OpenZFSConfiguration": { - "$ref": "#/definitions/OpenZFSConfiguration" - }, - "ResourceARN": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UUID": { - "type": "string" - }, - "VolumeId": { - "type": "string" - }, - "VolumeType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceARN", - "/properties/VolumeId", - "/properties/UUID" - ], - "required": [ - "Name" - ], - "typeName": "AWS::FSx::Volume" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BackupId", + "/properties/VolumeType" + ], + "definitions": { + "AggregateConfiguration": { + "additionalProperties": false, + "properties": { + "Aggregates": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ConstituentsPerAggregate": { + "type": "integer" + } + }, + "type": "object" + }, + "AutocommitPeriod": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ClientConfigurations": { + "additionalProperties": false, + "properties": { + "Clients": { + "type": "string" + }, + "Options": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Options", + "Clients" + ], + "type": "object" + }, + "NfsExports": { + "additionalProperties": false, + "properties": { + "ClientConfigurations": { + "items": { + "$ref": "#/definitions/ClientConfigurations" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ClientConfigurations" + ], + "type": "object" + }, + "OntapConfiguration": { + "additionalProperties": false, + "properties": { + "AggregateConfiguration": { + "$ref": "#/definitions/AggregateConfiguration" + }, + "CopyTagsToBackups": { + "type": "string" + }, + "JunctionPath": { + "type": "string" + }, + "OntapVolumeType": { + "type": "string" + }, + "SecurityStyle": { + "type": "string" + }, + "SizeInBytes": { + "type": "string" + }, + "SizeInMegabytes": { + "type": "string" + }, + "SnaplockConfiguration": { + "$ref": "#/definitions/SnaplockConfiguration" + }, + "SnapshotPolicy": { + "type": "string" + }, + "StorageEfficiencyEnabled": { + "type": "string" + }, + "StorageVirtualMachineId": { + "type": "string" + }, + "TieringPolicy": { + "$ref": "#/definitions/TieringPolicy" + }, + "VolumeStyle": { + "type": "string" + } + }, + "required": [ + "StorageVirtualMachineId" + ], + "type": "object" + }, + "OpenZFSConfiguration": { + "additionalProperties": false, + "properties": { + "CopyTagsToSnapshots": { + "type": "boolean" + }, + "DataCompressionType": { + "type": "string" + }, + "NfsExports": { + "items": { + "$ref": "#/definitions/NfsExports" + }, + "type": "array", + "uniqueItems": false + }, + "Options": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "OriginSnapshot": { + "$ref": "#/definitions/OriginSnapshot" + }, + "ParentVolumeId": { + "type": "string" + }, + "ReadOnly": { + "type": "boolean" + }, + "RecordSizeKiB": { + "type": "integer" + }, + "StorageCapacityQuotaGiB": { + "type": "integer" + }, + "StorageCapacityReservationGiB": { + "type": "integer" + }, + "UserAndGroupQuotas": { + "items": { + "$ref": "#/definitions/UserAndGroupQuotas" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ParentVolumeId" + ], + "type": "object" + }, + "OriginSnapshot": { + "additionalProperties": false, + "properties": { + "CopyStrategy": { + "type": "string" + }, + "SnapshotARN": { + "type": "string" + } + }, + "required": [ + "CopyStrategy", + "SnapshotARN" + ], + "type": "object" + }, + "RetentionPeriod": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SnaplockConfiguration": { + "additionalProperties": false, + "properties": { + "AuditLogVolume": { + "type": "string" + }, + "AutocommitPeriod": { + "$ref": "#/definitions/AutocommitPeriod" + }, + "PrivilegedDelete": { + "type": "string" + }, + "RetentionPeriod": { + "$ref": "#/definitions/SnaplockRetentionPeriod" + }, + "SnaplockType": { + "type": "string" + }, + "VolumeAppendModeEnabled": { + "type": "string" + } + }, + "required": [ + "SnaplockType" + ], + "type": "object" + }, + "SnaplockRetentionPeriod": { + "additionalProperties": false, + "properties": { + "DefaultRetention": { + "$ref": "#/definitions/RetentionPeriod" + }, + "MaximumRetention": { + "$ref": "#/definitions/RetentionPeriod" + }, + "MinimumRetention": { + "$ref": "#/definitions/RetentionPeriod" + } + }, + "required": [ + "DefaultRetention", + "MaximumRetention", + "MinimumRetention" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TieringPolicy": { + "additionalProperties": false, + "properties": { + "CoolingPeriod": { + "type": "integer" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "UserAndGroupQuotas": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "integer" + }, + "StorageCapacityQuotaGiB": { + "type": "integer" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Id", + "StorageCapacityQuotaGiB" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::FSx::Volume", + "primaryIdentifier": [ + "/properties/VolumeId" + ], + "properties": { + "BackupId": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OntapConfiguration": { + "$ref": "#/definitions/OntapConfiguration" + }, + "OpenZFSConfiguration": { + "$ref": "#/definitions/OpenZFSConfiguration" + }, + "ResourceARN": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UUID": { + "type": "string" + }, + "VolumeId": { + "type": "string" + }, + "VolumeType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceARN", + "/properties/VolumeId", + "/properties/UUID" + ], + "required": [ + "Name" + ], + "typeName": "AWS::FSx::Volume" +} diff --git a/schema/aws-gamelift-alias.json b/schema/aws-gamelift-alias.json index d044f6d..3be1abf 100644 --- a/schema/aws-gamelift-alias.json +++ b/schema/aws-gamelift-alias.json @@ -1,107 +1,107 @@ -{ - "additionalProperties": false, - "definitions": { - "RoutingStrategy": { - "additionalProperties": false, - "anyOf": [ - { - "required": [ - "FleetId" - ] - }, - { - "required": [ - "Message" - ] - } - ], - "properties": { - "FleetId": { - "description": "A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.", - "pattern": "^fleet-\\S+", - "type": "string" - }, - "Message": { - "description": "The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.", - "type": "string" - }, - "Type": { - "description": "Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.", - "enum": [ - "SIMPLE", - "TERMINAL" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateAlias" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteAlias" - ] - }, - "list": { - "permissions": [ - "gamelift:ListAliases" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeAlias" - ] - }, - "update": { - "permissions": [ - "gamelift:UpdateAlias" - ] - } - }, - "primaryIdentifier": [ - "/properties/AliasId" - ], - "properties": { - "AliasId": { - "description": "Unique alias ID", - "type": "string" - }, - "Description": { - "description": "A human-readable description of the alias.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "A descriptive label that is associated with an alias. Alias names do not need to be unique.", - "maxLength": 1024, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "RoutingStrategy": { - "$ref": "#/definitions/RoutingStrategy", - "description": "A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message." - } - }, - "readOnlyProperties": [ - "/properties/AliasId" - ], - "required": [ - "Name", - "RoutingStrategy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "taggable": true, - "typeName": "AWS::GameLift::Alias" -} +{ + "additionalProperties": false, + "definitions": { + "RoutingStrategy": { + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "FleetId" + ] + }, + { + "required": [ + "Message" + ] + } + ], + "properties": { + "FleetId": { + "description": "A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.", + "pattern": "^fleet-\\S+", + "type": "string" + }, + "Message": { + "description": "The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.", + "type": "string" + }, + "Type": { + "description": "Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.", + "enum": [ + "SIMPLE", + "TERMINAL" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateAlias" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteAlias" + ] + }, + "list": { + "permissions": [ + "gamelift:ListAliases" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeAlias" + ] + }, + "update": { + "permissions": [ + "gamelift:UpdateAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/AliasId" + ], + "properties": { + "AliasId": { + "description": "Unique alias ID", + "type": "string" + }, + "Description": { + "description": "A human-readable description of the alias.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "A descriptive label that is associated with an alias. Alias names do not need to be unique.", + "maxLength": 1024, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "RoutingStrategy": { + "$ref": "#/definitions/RoutingStrategy", + "description": "A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message." + } + }, + "readOnlyProperties": [ + "/properties/AliasId" + ], + "required": [ + "Name", + "RoutingStrategy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "taggable": true, + "typeName": "AWS::GameLift::Alias" +} diff --git a/schema/aws-gamelift-build.json b/schema/aws-gamelift-build.json index 7fe6416..816403d 100644 --- a/schema/aws-gamelift-build.json +++ b/schema/aws-gamelift-build.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StorageLocation", - "/properties/OperatingSystem", - "/properties/ServerSdkVersion" - ], - "definitions": { - "StorageLocation": { - "$comment": "Contains object details present in the S3 Bucket", - "additionalProperties": false, - "properties": { - "Bucket": { - "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.", - "type": "string" - }, - "Key": { - "description": "The name of the zip file that contains the build files or script files.", - "type": "string" - }, - "ObjectVersion": { - "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.", - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GameLift::Build", - "handlers": { - "create": { - "permissions": [ - "gamelift:DescribeBuild", - "gamelift:CreateBuild" - ] - }, - "delete": { - "permissions": [ - "gamelift:DescribeBuild", - "gamelift:DeleteBuild" - ] - }, - "list": { - "permissions": [ - "gamelift:ListBuilds" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeBuild" - ] - }, - "update": { - "permissions": [ - "gamelift:UpdateBuild" - ] - } - }, - "primaryIdentifier": [ - "/properties/BuildId" - ], - "properties": { - "BuildId": { - "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.", - "type": "string" - }, - "Name": { - "description": "A descriptive label that is associated with a build. Build names do not need to be unique.", - "type": "string" - }, - "OperatingSystem": { - "description": "The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.", - "enum": [ - "AMAZON_LINUX", - "AMAZON_LINUX_2", - "AMAZON_LINUX_2023", - "WINDOWS_2012", - "WINDOWS_2016" - ], - "type": "string" - }, - "ServerSdkVersion": { - "description": "A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.", - "type": "string" - }, - "StorageLocation": { - "$ref": "#/definitions/StorageLocation", - "description": "Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region." - }, - "Version": { - "description": "Version information that is associated with this build. Version strings do not need to be unique.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/BuildId" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::GameLift::Build", - "writeOnlyProperties": [ - "/properties/StorageLocation", - "/properties/ServerSdkVersion" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StorageLocation", + "/properties/OperatingSystem", + "/properties/ServerSdkVersion" + ], + "definitions": { + "StorageLocation": { + "$comment": "Contains object details present in the S3 Bucket", + "additionalProperties": false, + "properties": { + "Bucket": { + "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.", + "type": "string" + }, + "Key": { + "description": "The name of the zip file that contains the build files or script files.", + "type": "string" + }, + "ObjectVersion": { + "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.", + "type": "string" + } + }, + "required": [ + "Bucket", + "Key", + "RoleArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GameLift::Build", + "handlers": { + "create": { + "permissions": [ + "gamelift:DescribeBuild", + "gamelift:CreateBuild" + ] + }, + "delete": { + "permissions": [ + "gamelift:DescribeBuild", + "gamelift:DeleteBuild" + ] + }, + "list": { + "permissions": [ + "gamelift:ListBuilds" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeBuild" + ] + }, + "update": { + "permissions": [ + "gamelift:UpdateBuild" + ] + } + }, + "primaryIdentifier": [ + "/properties/BuildId" + ], + "properties": { + "BuildId": { + "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.", + "type": "string" + }, + "Name": { + "description": "A descriptive label that is associated with a build. Build names do not need to be unique.", + "type": "string" + }, + "OperatingSystem": { + "description": "The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.", + "enum": [ + "AMAZON_LINUX", + "AMAZON_LINUX_2", + "AMAZON_LINUX_2023", + "WINDOWS_2012", + "WINDOWS_2016" + ], + "type": "string" + }, + "ServerSdkVersion": { + "description": "A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.", + "type": "string" + }, + "StorageLocation": { + "$ref": "#/definitions/StorageLocation", + "description": "Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region." + }, + "Version": { + "description": "Version information that is associated with this build. Version strings do not need to be unique.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BuildId" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::GameLift::Build", + "writeOnlyProperties": [ + "/properties/StorageLocation", + "/properties/ServerSdkVersion" + ] +} diff --git a/schema/aws-gamelift-containergroupdefinition.json b/schema/aws-gamelift-containergroupdefinition.json index 4326983..3426dc6 100644 --- a/schema/aws-gamelift-containergroupdefinition.json +++ b/schema/aws-gamelift-containergroupdefinition.json @@ -1,452 +1,457 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/SchedulingStrategy", - "/properties/TotalMemoryLimit", - "/properties/TotalCpuLimit", - "/properties/ContainerDefinitions", - "/properties/OperatingSystem" - ], - "definitions": { - "ContainerDefinition": { - "additionalProperties": false, - "description": "Details about a container that is used in a container fleet", - "properties": { - "Command": { - "description": "The command that's passed to the container.", - "insertionOrder": true, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "ContainerName": { - "description": "A descriptive label for the container definition. Container definition names must be unique with a container group definition.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Cpu": { - "description": "The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units", - "maximum": 10240, - "minimum": 1, - "type": "integer" - }, - "DependsOn": { - "description": "A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ContainerDependency" - }, - "maxItems": 10, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "EntryPoint": { - "description": "The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array.", - "insertionOrder": true, - "items": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Environment": { - "description": "The environment variables to pass to a container.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ContainerEnvironment" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Essential": { - "description": "Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.", - "type": "boolean" - }, - "HealthCheck": { - "$ref": "#/definitions/ContainerHealthCheck", - "description": "Specifies how the health of the containers will be checked." - }, - "ImageUri": { - "description": "Specifies the image URI of this container.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_\\.@\\/:]+$", - "type": "string" - }, - "MemoryLimits": { - "$ref": "#/definitions/MemoryLimits", - "description": "Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition." - }, - "PortConfiguration": { - "$ref": "#/definitions/PortConfiguration", - "description": "Defines the ports on the container." - }, - "ResolvedImageDigest": { - "description": "The digest of the container image.", - "pattern": "^sha256:[a-fA-F0-9]{64}$", - "type": "string" - }, - "WorkingDirectory": { - "description": "The working directory to run commands inside the container in.", - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "ContainerName", - "ImageUri" - ], - "type": "object" - }, - "ContainerDependency": { - "additionalProperties": false, - "description": "A dependency that impacts a container's startup and shutdown.", - "properties": { - "Condition": { - "description": "The type of dependency.", - "enum": [ - "START", - "COMPLETE", - "SUCCESS", - "HEALTHY" - ], - "type": "string" - }, - "ContainerName": { - "description": "A descriptive label for the container definition. The container being defined depends on this container's condition.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - } - }, - "required": [ - "ContainerName", - "Condition" - ], - "type": "object" - }, - "ContainerEnvironment": { - "additionalProperties": false, - "description": "An environment variable to set inside a container, in the form of a key-value pair.", - "properties": { - "Name": { - "description": "The environment variable name.", - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Value": { - "description": "The environment variable value.", - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "ContainerHealthCheck": { - "additionalProperties": false, - "description": "Specifies how the process manager checks the health of containers.", - "properties": { - "Command": { - "description": "A string array representing the command that the container runs to determine if it is healthy.", - "insertionOrder": true, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Interval": { - "description": "How often (in seconds) the health is checked.", - "maximum": 300, - "minimum": 60, - "type": "integer" - }, - "Retries": { - "description": "How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)", - "maximum": 10, - "minimum": 5, - "type": "integer" - }, - "StartPeriod": { - "description": "The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.", - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "Timeout": { - "description": "How many seconds the process manager allows the command to run before canceling it.", - "maximum": 60, - "minimum": 30, - "type": "integer" - } - }, - "required": [ - "Command" - ], - "type": "object" - }, - "ContainerPortRange": { - "additionalProperties": false, - "description": "A set of one or more port numbers that can be opened on the container.", - "properties": { - "FromPort": { - "description": "A starting value for the range of allowed port numbers.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "description": "Defines the protocol of these ports.", - "enum": [ - "TCP", - "UDP" - ], - "type": "string" - }, - "ToPort": { - "description": "An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "FromPort", - "Protocol", - "ToPort" - ], - "type": "object" - }, - "MemoryLimits": { - "additionalProperties": false, - "description": "Specifies how much memory is available to the container.", - "properties": { - "HardLimit": { - "description": "The hard limit of memory to reserve for the container.", - "maximum": 1024000, - "minimum": 4, - "type": "integer" - }, - "SoftLimit": { - "description": "The amount of memory that is reserved for the container.", - "maximum": 1024000, - "minimum": 4, - "type": "integer" - } - }, - "type": "object" - }, - "PortConfiguration": { - "additionalProperties": false, - "description": "Defines the ports on a container.", - "properties": { - "ContainerPortRanges": { - "description": "Specifies one or more ranges of ports on a container.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ContainerPortRange" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ContainerPortRanges" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateContainerGroupDefinition", - "gamelift:DescribeContainerGroupDefinition", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "ecr:BatchCheckLayerAvailability", - "ecr:BatchGetImage", - "ecr:GetDownloadUrlForLayer", - "ecr:DescribeImages" - ] - }, - "delete": { - "permissions": [ - "gamelift:DescribeContainerGroupDefinition", - "gamelift:DeleteContainerGroupDefinition" - ] - }, - "list": { - "permissions": [ - "gamelift:ListContainerGroupDefinitions" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeContainerGroupDefinition", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "ContainerDefinitions": { - "description": "A collection of container definitions that define the containers in this group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ContainerDefinition" - }, - "maxItems": 10, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ContainerGroupDefinitionArn": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.", - "maxLength": 512, - "minLength": 1, - "pattern": "^arn:.*:containergroupdefinition/containergroupdefinition-[a-zA-Z0-9-]+$", - "type": "string" - }, - "CreationTime": { - "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").", - "type": "string" - }, - "Name": { - "description": "A descriptive label for the container group definition.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "OperatingSystem": { - "description": "The operating system of the container group", - "enum": [ - "AMAZON_LINUX_2023" - ], - "type": "string" - }, - "SchedulingStrategy": { - "description": "Specifies whether the container group includes replica or daemon containers.", - "enum": [ - "REPLICA", - "DAEMON" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "TotalCpuLimit": { - "description": "The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)", - "maximum": 10240, - "minimum": 128, - "type": "integer" - }, - "TotalMemoryLimit": { - "description": "The maximum amount of memory (in MiB) to allocate for this container group.", - "maximum": 1024000, - "minimum": 4, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/ContainerGroupDefinitionArn", - "/properties/CreationTime", - "/properties/ContainerDefinitions/*/ResolvedImageDigest" - ], - "required": [ - "Name", - "TotalMemoryLimit", - "TotalCpuLimit", - "ContainerDefinitions", - "OperatingSystem" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GameLift::ContainerGroupDefinition" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/SchedulingStrategy", + "/properties/TotalMemoryLimit", + "/properties/TotalCpuLimit", + "/properties/ContainerDefinitions", + "/properties/OperatingSystem" + ], + "definitions": { + "ContainerDefinition": { + "additionalProperties": false, + "description": "Details about a container that is used in a container fleet", + "properties": { + "Command": { + "description": "The command that's passed to the container.", + "insertionOrder": true, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "ContainerName": { + "description": "A descriptive label for the container definition. Container definition names must be unique with a container group definition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Cpu": { + "description": "The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units", + "maximum": 10240, + "minimum": 1, + "type": "integer" + }, + "DependsOn": { + "description": "A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ContainerDependency" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EntryPoint": { + "description": "The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Environment": { + "description": "The environment variables to pass to a container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerEnvironment" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Essential": { + "description": "Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.", + "type": "boolean" + }, + "HealthCheck": { + "$ref": "#/definitions/ContainerHealthCheck", + "description": "Specifies how the health of the containers will be checked." + }, + "ImageUri": { + "description": "Specifies the image URI of this container.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_\\.@\\/:]+$", + "type": "string" + }, + "MemoryLimits": { + "$ref": "#/definitions/MemoryLimits", + "description": "Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition." + }, + "PortConfiguration": { + "$ref": "#/definitions/PortConfiguration", + "description": "Defines the ports on the container." + }, + "ResolvedImageDigest": { + "description": "The digest of the container image.", + "pattern": "^sha256:[a-fA-F0-9]{64}$", + "type": "string" + }, + "WorkingDirectory": { + "description": "The working directory to run commands inside the container in.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "ContainerName", + "ImageUri" + ], + "type": "object" + }, + "ContainerDependency": { + "additionalProperties": false, + "description": "A dependency that impacts a container's startup and shutdown.", + "properties": { + "Condition": { + "description": "The type of dependency.", + "enum": [ + "START", + "COMPLETE", + "SUCCESS", + "HEALTHY" + ], + "type": "string" + }, + "ContainerName": { + "description": "A descriptive label for the container definition. The container being defined depends on this container's condition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + } + }, + "required": [ + "ContainerName", + "Condition" + ], + "type": "object" + }, + "ContainerEnvironment": { + "additionalProperties": false, + "description": "An environment variable to set inside a container, in the form of a key-value pair.", + "properties": { + "Name": { + "description": "The environment variable name.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "description": "The environment variable value.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "ContainerHealthCheck": { + "additionalProperties": false, + "description": "Specifies how the process manager checks the health of containers.", + "properties": { + "Command": { + "description": "A string array representing the command that the container runs to determine if it is healthy.", + "insertionOrder": true, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Interval": { + "description": "How often (in seconds) the health is checked.", + "maximum": 300, + "minimum": 60, + "type": "integer" + }, + "Retries": { + "description": "How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)", + "maximum": 10, + "minimum": 5, + "type": "integer" + }, + "StartPeriod": { + "description": "The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "Timeout": { + "description": "How many seconds the process manager allows the command to run before canceling it.", + "maximum": 60, + "minimum": 30, + "type": "integer" + } + }, + "required": [ + "Command" + ], + "type": "object" + }, + "ContainerPortRange": { + "additionalProperties": false, + "description": "A set of one or more port numbers that can be opened on the container.", + "properties": { + "FromPort": { + "description": "A starting value for the range of allowed port numbers.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "description": "Defines the protocol of these ports.", + "enum": [ + "TCP", + "UDP" + ], + "type": "string" + }, + "ToPort": { + "description": "An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FromPort", + "Protocol", + "ToPort" + ], + "type": "object" + }, + "MemoryLimits": { + "additionalProperties": false, + "description": "Specifies how much memory is available to the container.", + "properties": { + "HardLimit": { + "description": "The hard limit of memory to reserve for the container.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + }, + "SoftLimit": { + "description": "The amount of memory that is reserved for the container.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + } + }, + "type": "object" + }, + "PortConfiguration": { + "additionalProperties": false, + "description": "Defines the ports on a container.", + "properties": { + "ContainerPortRanges": { + "description": "Specifies one or more ranges of ports on a container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerPortRange" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ContainerPortRanges" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateContainerGroupDefinition", + "gamelift:DescribeContainerGroupDefinition", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "ecr:BatchCheckLayerAvailability", + "ecr:BatchGetImage", + "ecr:GetDownloadUrlForLayer", + "ecr:DescribeImages" + ] + }, + "delete": { + "permissions": [ + "gamelift:DescribeContainerGroupDefinition", + "gamelift:DeleteContainerGroupDefinition" + ] + }, + "list": { + "permissions": [ + "gamelift:ListContainerGroupDefinitions" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeContainerGroupDefinition", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "ContainerDefinitions": { + "description": "A collection of container definitions that define the containers in this group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerDefinition" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ContainerGroupDefinitionArn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.", + "maxLength": 512, + "minLength": 1, + "pattern": "^arn:.*:containergroupdefinition/containergroupdefinition-[a-zA-Z0-9-]+$|^arn:.*:containergroupdefinition/[a-zA-Z0-9-\\:]+$", + "type": "string" + }, + "CreationTime": { + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").", + "type": "string" + }, + "Name": { + "description": "A descriptive label for the container group definition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "OperatingSystem": { + "description": "The operating system of the container group", + "enum": [ + "AMAZON_LINUX_2023" + ], + "type": "string" + }, + "SchedulingStrategy": { + "description": "Specifies whether the container group includes replica or daemon containers.", + "enum": [ + "REPLICA", + "DAEMON" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "TotalCpuLimit": { + "description": "The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)", + "maximum": 10240, + "minimum": 128, + "type": "integer" + }, + "TotalMemoryLimit": { + "description": "The maximum amount of memory (in MiB) to allocate for this container group.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/ContainerGroupDefinitionArn", + "/properties/CreationTime", + "/properties/ContainerDefinitions/*/ResolvedImageDigest" + ], + "required": [ + "Name", + "TotalMemoryLimit", + "TotalCpuLimit", + "ContainerDefinitions", + "OperatingSystem" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GameLift::ContainerGroupDefinition" +} diff --git a/schema/aws-gamelift-fleet.json b/schema/aws-gamelift-fleet.json index 1fdbaa5..2184f0d 100644 --- a/schema/aws-gamelift-fleet.json +++ b/schema/aws-gamelift-fleet.json @@ -1,666 +1,666 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplyCapacity", - "/properties/BuildId", - "/properties/CertificateConfiguration", - "/properties/ContainerGroupsConfiguration", - "/properties/EC2InstanceType", - "/properties/FleetType", - "/properties/InstanceRoleARN", - "/properties/InstanceRoleCredentialsProvider", - "/properties/LogPaths", - "/properties/PeerVpcAwsAccountId", - "/properties/PeerVpcId", - "/properties/ScriptId", - "/properties/ServerLaunchParameters", - "/properties/ServerLaunchPath", - "/properties/ComputeType" - ], - "definitions": { - "AnywhereConfiguration": { - "additionalProperties": false, - "description": "Configuration for Anywhere fleet.", - "properties": { - "Cost": { - "description": "Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.", - "maxLength": 11, - "minLength": 1, - "pattern": "^\\d{1,5}(?:\\.\\d{1,5})?$", - "type": "string" - } - }, - "required": [ - "Cost" - ] - }, - "CertificateConfiguration": { - "additionalProperties": false, - "description": "Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate.", - "properties": { - "CertificateType": { - "enum": [ - "DISABLED", - "GENERATED" - ], - "type": "string" - } - }, - "required": [ - "CertificateType" - ], - "type": "object" - }, - "ConnectionPortRange": { - "additionalProperties": false, - "description": "Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.", - "properties": { - "FromPort": { - "description": "A starting value for a range of allowed port numbers.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - }, - "ToPort": { - "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "ContainerGroupsConfiguration": { - "additionalProperties": false, - "description": "Specifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet.", - "properties": { - "ConnectionPortRange": { - "$ref": "#/definitions/ConnectionPortRange" - }, - "ContainerGroupDefinitionNames": { - "description": "The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-]+$", - "type": "string" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - }, - "ContainerGroupsPerInstance": { - "$ref": "#/definitions/ContainerGroupsPerInstance" - } - }, - "required": [ - "ContainerGroupDefinitionNames", - "ConnectionPortRange" - ], - "type": "object" - }, - "ContainerGroupsPerInstance": { - "additionalProperties": false, - "description": "The number of container groups per instance.", - "properties": { - "DesiredReplicaContainerGroupsPerInstance": { - "description": "Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.", - "maximum": 5000, - "minimum": 1, - "type": "integer" - }, - "MaxReplicaContainerGroupsPerInstance": { - "description": "GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.", - "maximum": 5000, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "IpPermission": { - "additionalProperties": false, - "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.", - "properties": { - "FromPort": { - "description": "A starting value for a range of allowed port numbers.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - }, - "IpRange": { - "description": "A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".", - "pattern": "(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))$)", - "type": "string" - }, - "Protocol": { - "description": "The network communication protocol used by the fleet.", - "enum": [ - "TCP", - "UDP" - ], - "type": "string" - }, - "ToPort": { - "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.", - "maximum": 60000, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "FromPort", - "IpRange", - "Protocol", - "ToPort" - ], - "type": "object" - }, - "Location": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-]+", - "type": "string" - }, - "LocationCapacity": { - "additionalProperties": false, - "description": "Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.", - "properties": { - "DesiredEC2Instances": { - "description": "The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.", - "minimum": 0, - "type": "integer" - }, - "MaxSize": { - "description": "The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value.", - "minimum": 0, - "type": "integer" - }, - "MinSize": { - "description": "The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value.", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "DesiredEC2Instances", - "MinSize", - "MaxSize" - ], - "type": "object" - }, - "LocationConfiguration": { - "additionalProperties": false, - "description": "A remote location where a multi-location fleet can deploy EC2 instances for game hosting.", - "properties": { - "Location": { - "$ref": "#/definitions/Location" - }, - "LocationCapacity": { - "$ref": "#/definitions/LocationCapacity" - } - }, - "required": [ - "Location" - ], - "type": "object" - }, - "ResourceCreationLimitPolicy": { - "additionalProperties": false, - "description": "A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".\n\nThe policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.", - "properties": { - "NewGameSessionsPerCreator": { - "description": "The maximum number of game sessions that an individual can create during the policy period.", - "minimum": 0, - "type": "integer" - }, - "PolicyPeriodInMinutes": { - "description": "The time span used in evaluating the resource creation limit policy.", - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "RuntimeConfiguration": { - "additionalProperties": false, - "description": "A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for.\n\nThe runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.\n\nAn Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.", - "properties": { - "GameSessionActivationTimeoutSeconds": { - "description": "The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.", - "maximum": 600, - "minimum": 1, - "type": "integer" - }, - "MaxConcurrentGameSessionActivations": { - "description": "The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.", - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "ServerProcesses": { - "description": "A collection of server process configurations that describe which server processes to run on each instance in a fleet.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ServerProcess" - }, - "maxItems": 50, - "type": "array" - } - }, - "type": "object" - }, - "ScalingPolicy": { - "additionalProperties": false, - "description": "Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.", - "properties": { - "ComparisonOperator": { - "description": "Comparison operator to use when measuring a metric against the threshold value.", - "enum": [ - "GreaterThanOrEqualToThreshold", - "GreaterThanThreshold", - "LessThanThreshold", - "LessThanOrEqualToThreshold" - ], - "type": "string" - }, - "EvaluationPeriods": { - "description": "Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.", - "minimum": 1, - "type": "integer" - }, - "Location": { - "$ref": "#/definitions/Location" - }, - "MetricName": { - "description": "Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.", - "enum": [ - "ActivatingGameSessions", - "ActiveGameSessions", - "ActiveInstances", - "AvailableGameSessions", - "AvailablePlayerSessions", - "CurrentPlayerSessions", - "IdleInstances", - "PercentAvailableGameSessions", - "PercentIdleInstances", - "QueueDepth", - "WaitTime", - "ConcurrentActivatableGameSessions" - ], - "type": "string" - }, - "Name": { - "description": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "PolicyType": { - "description": "The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.", - "enum": [ - "RuleBased", - "TargetBased" - ], - "type": "string" - }, - "ScalingAdjustment": { - "description": "Amount of adjustment to make, based on the scaling adjustment type.", - "type": "integer" - }, - "ScalingAdjustmentType": { - "description": "The type of adjustment to make to a fleet's instance count.", - "enum": [ - "ChangeInCapacity", - "ExactCapacity", - "PercentChangeInCapacity" - ], - "type": "string" - }, - "Status": { - "description": "Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.", - "enum": [ - "ACTIVE", - "UPDATE_REQUESTED", - "UPDATING", - "DELETE_REQUESTED", - "DELETING", - "DELETED", - "ERROR" - ], - "type": "string" - }, - "TargetConfiguration": { - "$ref": "#/definitions/TargetConfiguration", - "description": "An object that contains settings for a target-based scaling policy." - }, - "Threshold": { - "description": "Metric value used to trigger a scaling event.", - "type": "number" - }, - "UpdateStatus": { - "description": "The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.", - "enum": [ - "PENDING_UPDATE" - ], - "type": "string" - } - }, - "required": [ - "MetricName", - "Name" - ], - "type": "object" - }, - "ServerProcess": { - "additionalProperties": false, - "description": "A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.", - "properties": { - "ConcurrentExecutions": { - "description": "The number of server processes that use this configuration to run concurrently on an instance.", - "minimum": 1, - "type": "integer" - }, - "LaunchPath": { - "description": "The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:\n\nWindows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"\n\nLinux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\"", - "maxLength": 1024, - "minLength": 1, - "pattern": "^([Cc]:\\\\game\\S+|/local/game/\\S+)", - "type": "string" - }, - "Parameters": { - "description": "An optional list of parameters to pass to the server executable or Realtime script on launch.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConcurrentExecutions", - "LaunchPath" - ], - "type": "object" - }, - "TargetConfiguration": { - "additionalProperties": false, - "description": "Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.", - "properties": { - "TargetValue": { - "description": "Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).", - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/LogPaths", - "/properties/ServerLaunchParameters", - "/properties/ServerLaunchPath" - ], - "description": "The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateFleet", - "gamelift:DescribeFleetAttributes", - "gamelift:DescribeFleetLocationAttributes", - "gamelift:UpdateFleetCapacity", - "gamelift:DescribeFleetLocationCapacity", - "gamelift:PutScalingPolicy", - "gamelift:DescribeScalingPolicies" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteFleet", - "gamelift:DescribeFleetLocationCapacity", - "gamelift:DescribeScalingPolicies", - "gamelift:DeleteScalingPolicy" - ] - }, - "list": { - "permissions": [ - "gamelift:ListFleets" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeFleetAttributes", - "gamelift:DescribeFleetLocationAttributes", - "gamelift:DescribeFleetCapacity", - "gamelift:DescribeFleetPortSettings", - "gamelift:DescribeFleetUtilization", - "gamelift:DescribeRuntimeConfiguration", - "gamelift:DescribeEC2InstanceLimits", - "gamelift:DescribeFleetEvents", - "gamelift:DescribeScalingPolicies" - ] - }, - "update": { - "permissions": [ - "gamelift:UpdateFleetAttributes", - "gamelift:CreateFleetLocations", - "gamelift:DeleteFleetLocations", - "gamelift:UpdateFleetCapacity", - "gamelift:UpdateFleetPortSettings", - "gamelift:UpdateRuntimeConfiguration", - "gamelift:DescribeFleetLocationCapacity", - "gamelift:DescribeFleetPortSettings", - "gamelift:DescribeFleetLocationAttributes", - "gamelift:PutScalingPolicy", - "gamelift:DescribeScalingPolicies", - "gamelift:DeleteScalingPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/FleetId" - ], - "properties": { - "AnywhereConfiguration": { - "$ref": "#/definitions/AnywhereConfiguration", - "description": "Configuration for Anywhere fleet." - }, - "ApplyCapacity": { - "description": "Determines whether to apply fleet or location capacities on fleet creation.", - "enum": [ - "ON_UPDATE", - "ON_CREATE_AND_UPDATE" - ], - "type": "string" - }, - "BuildId": { - "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.", - "pattern": "^build-\\S+|^arn:.*:build/build-\\S+", - "type": "string" - }, - "CertificateConfiguration": { - "$ref": "#/definitions/CertificateConfiguration", - "description": "Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created." - }, - "ComputeType": { - "description": "ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.", - "enum": [ - "EC2", - "ANYWHERE", - "CONTAINER" - ], - "type": "string" - }, - "ContainerGroupsConfiguration": { - "$ref": "#/definitions/ContainerGroupsConfiguration" - }, - "Description": { - "description": "A human-readable description of a fleet.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "DesiredEC2Instances": { - "description": "[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.", - "minimum": 0, - "type": "integer" - }, - "EC2InboundPermissions": { - "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IpPermission" - }, - "maxItems": 50, - "type": "array" - }, - "EC2InstanceType": { - "description": "The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.", - "pattern": "^.*..*$", - "type": "string" - }, - "FleetId": { - "description": "Unique fleet ID", - "pattern": "^fleet-\\S+", - "type": "string" - }, - "FleetType": { - "description": "Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.", - "enum": [ - "ON_DEMAND", - "SPOT" - ], - "type": "string" - }, - "InstanceRoleARN": { - "description": "A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.", - "minLength": 1, - "pattern": "^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "InstanceRoleCredentialsProvider": { - "description": "Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.", - "enum": [ - "SHARED_CREDENTIAL_FILE" - ], - "type": "string" - }, - "Locations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LocationConfiguration" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "LogPaths": { - "description": "This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxSize": { - "description": "[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value.", - "minimum": 0, - "type": "integer" - }, - "MetricGroups": { - "description": "The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 1, - "type": "array" - }, - "MinSize": { - "description": "[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value.", - "minimum": 0, - "type": "integer" - }, - "Name": { - "description": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "NewGameSessionProtectionPolicy": { - "description": "A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.", - "enum": [ - "FullProtection", - "NoProtection" - ], - "type": "string" - }, - "PeerVpcAwsAccountId": { - "description": "A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "PeerVpcId": { - "description": "A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^vpc-\\S+", - "type": "string" - }, - "ResourceCreationLimitPolicy": { - "$ref": "#/definitions/ResourceCreationLimitPolicy", - "description": "A policy that limits the number of game sessions an individual player can create over a span of time for this fleet." - }, - "RuntimeConfiguration": { - "$ref": "#/definitions/RuntimeConfiguration", - "description": "Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.\n\nThis parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work." - }, - "ScalingPolicies": { - "description": "A list of rules that control how a fleet is scaled.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ScalingPolicy" - }, - "maxItems": 50, - "type": "array" - }, - "ScriptId": { - "description": "A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.\n\nNote: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.", - "pattern": "^script-\\S+|^arn:.*:script/script-\\S+", - "type": "string" - }, - "ServerLaunchParameters": { - "description": "This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "ServerLaunchPath": { - "description": "This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ContainerGroupsConfiguration/ContainerGroupsPerInstance/MaxReplicaContainerGroupsPerInstance", - "/properties/FleetId" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "taggable": true, - "typeName": "AWS::GameLift::Fleet", - "writeOnlyProperties": [ - "/properties/ApplyCapacity" - ] -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplyCapacity", + "/properties/BuildId", + "/properties/CertificateConfiguration", + "/properties/ContainerGroupsConfiguration", + "/properties/EC2InstanceType", + "/properties/FleetType", + "/properties/InstanceRoleARN", + "/properties/InstanceRoleCredentialsProvider", + "/properties/LogPaths", + "/properties/PeerVpcAwsAccountId", + "/properties/PeerVpcId", + "/properties/ScriptId", + "/properties/ServerLaunchParameters", + "/properties/ServerLaunchPath", + "/properties/ComputeType" + ], + "definitions": { + "AnywhereConfiguration": { + "additionalProperties": false, + "description": "Configuration for Anywhere fleet.", + "properties": { + "Cost": { + "description": "Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.", + "maxLength": 11, + "minLength": 1, + "pattern": "^\\d{1,5}(?:\\.\\d{1,5})?$", + "type": "string" + } + }, + "required": [ + "Cost" + ] + }, + "CertificateConfiguration": { + "additionalProperties": false, + "description": "Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate.", + "properties": { + "CertificateType": { + "enum": [ + "DISABLED", + "GENERATED" + ], + "type": "string" + } + }, + "required": [ + "CertificateType" + ], + "type": "object" + }, + "ConnectionPortRange": { + "additionalProperties": false, + "description": "Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.", + "properties": { + "FromPort": { + "description": "A starting value for a range of allowed port numbers.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + }, + "ToPort": { + "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + }, + "ContainerGroupsConfiguration": { + "additionalProperties": false, + "description": "Specifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet.", + "properties": { + "ConnectionPortRange": { + "$ref": "#/definitions/ConnectionPortRange" + }, + "ContainerGroupDefinitionNames": { + "description": "The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-]+$", + "type": "string" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "ContainerGroupsPerInstance": { + "$ref": "#/definitions/ContainerGroupsPerInstance" + } + }, + "required": [ + "ContainerGroupDefinitionNames", + "ConnectionPortRange" + ], + "type": "object" + }, + "ContainerGroupsPerInstance": { + "additionalProperties": false, + "description": "The number of container groups per instance.", + "properties": { + "DesiredReplicaContainerGroupsPerInstance": { + "description": "Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.", + "maximum": 5000, + "minimum": 1, + "type": "integer" + }, + "MaxReplicaContainerGroupsPerInstance": { + "description": "GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.", + "maximum": 5000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "IpPermission": { + "additionalProperties": false, + "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.", + "properties": { + "FromPort": { + "description": "A starting value for a range of allowed port numbers.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + }, + "IpRange": { + "description": "A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".", + "pattern": "(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))$)", + "type": "string" + }, + "Protocol": { + "description": "The network communication protocol used by the fleet.", + "enum": [ + "TCP", + "UDP" + ], + "type": "string" + }, + "ToPort": { + "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FromPort", + "IpRange", + "Protocol", + "ToPort" + ], + "type": "object" + }, + "Location": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-]+", + "type": "string" + }, + "LocationCapacity": { + "additionalProperties": false, + "description": "Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.", + "properties": { + "DesiredEC2Instances": { + "description": "The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.", + "minimum": 0, + "type": "integer" + }, + "MaxSize": { + "description": "The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value.", + "minimum": 0, + "type": "integer" + }, + "MinSize": { + "description": "The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "DesiredEC2Instances", + "MinSize", + "MaxSize" + ], + "type": "object" + }, + "LocationConfiguration": { + "additionalProperties": false, + "description": "A remote location where a multi-location fleet can deploy EC2 instances for game hosting.", + "properties": { + "Location": { + "$ref": "#/definitions/Location" + }, + "LocationCapacity": { + "$ref": "#/definitions/LocationCapacity" + } + }, + "required": [ + "Location" + ], + "type": "object" + }, + "ResourceCreationLimitPolicy": { + "additionalProperties": false, + "description": "A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".\n\nThe policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.", + "properties": { + "NewGameSessionsPerCreator": { + "description": "The maximum number of game sessions that an individual can create during the policy period.", + "minimum": 0, + "type": "integer" + }, + "PolicyPeriodInMinutes": { + "description": "The time span used in evaluating the resource creation limit policy.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "RuntimeConfiguration": { + "additionalProperties": false, + "description": "A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for.\n\nThe runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.\n\nAn Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.", + "properties": { + "GameSessionActivationTimeoutSeconds": { + "description": "The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.", + "maximum": 600, + "minimum": 1, + "type": "integer" + }, + "MaxConcurrentGameSessionActivations": { + "description": "The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "ServerProcesses": { + "description": "A collection of server process configurations that describe which server processes to run on each instance in a fleet.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ServerProcess" + }, + "maxItems": 50, + "type": "array" + } + }, + "type": "object" + }, + "ScalingPolicy": { + "additionalProperties": false, + "description": "Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.", + "properties": { + "ComparisonOperator": { + "description": "Comparison operator to use when measuring a metric against the threshold value.", + "enum": [ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ], + "type": "string" + }, + "EvaluationPeriods": { + "description": "Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.", + "minimum": 1, + "type": "integer" + }, + "Location": { + "$ref": "#/definitions/Location" + }, + "MetricName": { + "description": "Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.", + "enum": [ + "ActivatingGameSessions", + "ActiveGameSessions", + "ActiveInstances", + "AvailableGameSessions", + "AvailablePlayerSessions", + "CurrentPlayerSessions", + "IdleInstances", + "PercentAvailableGameSessions", + "PercentIdleInstances", + "QueueDepth", + "WaitTime", + "ConcurrentActivatableGameSessions" + ], + "type": "string" + }, + "Name": { + "description": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "PolicyType": { + "description": "The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.", + "enum": [ + "RuleBased", + "TargetBased" + ], + "type": "string" + }, + "ScalingAdjustment": { + "description": "Amount of adjustment to make, based on the scaling adjustment type.", + "type": "integer" + }, + "ScalingAdjustmentType": { + "description": "The type of adjustment to make to a fleet's instance count.", + "enum": [ + "ChangeInCapacity", + "ExactCapacity", + "PercentChangeInCapacity" + ], + "type": "string" + }, + "Status": { + "description": "Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.", + "enum": [ + "ACTIVE", + "UPDATE_REQUESTED", + "UPDATING", + "DELETE_REQUESTED", + "DELETING", + "DELETED", + "ERROR" + ], + "type": "string" + }, + "TargetConfiguration": { + "$ref": "#/definitions/TargetConfiguration", + "description": "An object that contains settings for a target-based scaling policy." + }, + "Threshold": { + "description": "Metric value used to trigger a scaling event.", + "type": "number" + }, + "UpdateStatus": { + "description": "The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.", + "enum": [ + "PENDING_UPDATE" + ], + "type": "string" + } + }, + "required": [ + "MetricName", + "Name" + ], + "type": "object" + }, + "ServerProcess": { + "additionalProperties": false, + "description": "A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.", + "properties": { + "ConcurrentExecutions": { + "description": "The number of server processes that use this configuration to run concurrently on an instance.", + "minimum": 1, + "type": "integer" + }, + "LaunchPath": { + "description": "The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:\n\nWindows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"\n\nLinux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\"", + "maxLength": 1024, + "minLength": 1, + "pattern": "^([Cc]:\\\\game\\S+|/local/game/\\S+)", + "type": "string" + }, + "Parameters": { + "description": "An optional list of parameters to pass to the server executable or Realtime script on launch.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConcurrentExecutions", + "LaunchPath" + ], + "type": "object" + }, + "TargetConfiguration": { + "additionalProperties": false, + "description": "Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.", + "properties": { + "TargetValue": { + "description": "Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).", + "type": "number" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/LogPaths", + "/properties/ServerLaunchParameters", + "/properties/ServerLaunchPath" + ], + "description": "The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateFleet", + "gamelift:DescribeFleetAttributes", + "gamelift:DescribeFleetLocationAttributes", + "gamelift:UpdateFleetCapacity", + "gamelift:DescribeFleetLocationCapacity", + "gamelift:PutScalingPolicy", + "gamelift:DescribeScalingPolicies" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteFleet", + "gamelift:DescribeFleetLocationCapacity", + "gamelift:DescribeScalingPolicies", + "gamelift:DeleteScalingPolicy" + ] + }, + "list": { + "permissions": [ + "gamelift:ListFleets" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeFleetAttributes", + "gamelift:DescribeFleetLocationAttributes", + "gamelift:DescribeFleetCapacity", + "gamelift:DescribeFleetPortSettings", + "gamelift:DescribeFleetUtilization", + "gamelift:DescribeRuntimeConfiguration", + "gamelift:DescribeEC2InstanceLimits", + "gamelift:DescribeFleetEvents", + "gamelift:DescribeScalingPolicies" + ] + }, + "update": { + "permissions": [ + "gamelift:UpdateFleetAttributes", + "gamelift:CreateFleetLocations", + "gamelift:DeleteFleetLocations", + "gamelift:UpdateFleetCapacity", + "gamelift:UpdateFleetPortSettings", + "gamelift:UpdateRuntimeConfiguration", + "gamelift:DescribeFleetLocationCapacity", + "gamelift:DescribeFleetPortSettings", + "gamelift:DescribeFleetLocationAttributes", + "gamelift:PutScalingPolicy", + "gamelift:DescribeScalingPolicies", + "gamelift:DeleteScalingPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/FleetId" + ], + "properties": { + "AnywhereConfiguration": { + "$ref": "#/definitions/AnywhereConfiguration", + "description": "Configuration for Anywhere fleet." + }, + "ApplyCapacity": { + "description": "Determines whether to apply fleet or location capacities on fleet creation.", + "enum": [ + "ON_UPDATE", + "ON_CREATE_AND_UPDATE" + ], + "type": "string" + }, + "BuildId": { + "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.", + "pattern": "^build-\\S+|^arn:.*:build/build-\\S+", + "type": "string" + }, + "CertificateConfiguration": { + "$ref": "#/definitions/CertificateConfiguration", + "description": "Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created." + }, + "ComputeType": { + "description": "ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.", + "enum": [ + "EC2", + "ANYWHERE", + "CONTAINER" + ], + "type": "string" + }, + "ContainerGroupsConfiguration": { + "$ref": "#/definitions/ContainerGroupsConfiguration" + }, + "Description": { + "description": "A human-readable description of a fleet.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "DesiredEC2Instances": { + "description": "[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.", + "minimum": 0, + "type": "integer" + }, + "EC2InboundPermissions": { + "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IpPermission" + }, + "maxItems": 50, + "type": "array" + }, + "EC2InstanceType": { + "description": "The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.", + "pattern": "^.*..*$", + "type": "string" + }, + "FleetId": { + "description": "Unique fleet ID", + "pattern": "^fleet-\\S+", + "type": "string" + }, + "FleetType": { + "description": "Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.", + "enum": [ + "ON_DEMAND", + "SPOT" + ], + "type": "string" + }, + "InstanceRoleARN": { + "description": "A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.", + "minLength": 1, + "pattern": "^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "InstanceRoleCredentialsProvider": { + "description": "Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.", + "enum": [ + "SHARED_CREDENTIAL_FILE" + ], + "type": "string" + }, + "Locations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LocationConfiguration" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "LogPaths": { + "description": "This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "MaxSize": { + "description": "[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value.", + "minimum": 0, + "type": "integer" + }, + "MetricGroups": { + "description": "The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "MinSize": { + "description": "[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value.", + "minimum": 0, + "type": "integer" + }, + "Name": { + "description": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "NewGameSessionProtectionPolicy": { + "description": "A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.", + "enum": [ + "FullProtection", + "NoProtection" + ], + "type": "string" + }, + "PeerVpcAwsAccountId": { + "description": "A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "PeerVpcId": { + "description": "A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^vpc-\\S+", + "type": "string" + }, + "ResourceCreationLimitPolicy": { + "$ref": "#/definitions/ResourceCreationLimitPolicy", + "description": "A policy that limits the number of game sessions an individual player can create over a span of time for this fleet." + }, + "RuntimeConfiguration": { + "$ref": "#/definitions/RuntimeConfiguration", + "description": "Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.\n\nThis parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work." + }, + "ScalingPolicies": { + "description": "A list of rules that control how a fleet is scaled.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ScalingPolicy" + }, + "maxItems": 50, + "type": "array" + }, + "ScriptId": { + "description": "A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.\n\nNote: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.", + "pattern": "^script-\\S+|^arn:.*:script/script-\\S+", + "type": "string" + }, + "ServerLaunchParameters": { + "description": "This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "ServerLaunchPath": { + "description": "This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ContainerGroupsConfiguration/ContainerGroupsPerInstance/MaxReplicaContainerGroupsPerInstance", + "/properties/FleetId" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "taggable": true, + "typeName": "AWS::GameLift::Fleet", + "writeOnlyProperties": [ + "/properties/ApplyCapacity" + ] +} diff --git a/schema/aws-gamelift-gameservergroup.json b/schema/aws-gamelift-gameservergroup.json index 8dc82eb..ffb3256 100644 --- a/schema/aws-gamelift-gameservergroup.json +++ b/schema/aws-gamelift-gameservergroup.json @@ -1,445 +1,445 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "definitions": { - "AutoScalingGroupArn": { - "description": "A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.", - "maxLength": 256, - "minLength": 0, - "pattern": "[ -\ud7ff\ue000-\ufffd\ud800\udc00-\udbff\udfff\r\n\t]*", - "type": "string" - }, - "AutoScalingPolicy": { - "additionalProperties": false, - "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", - "properties": { - "EstimatedInstanceWarmup": { - "$ref": "#/definitions/EstimatedInstanceWarmup" - }, - "TargetTrackingConfiguration": { - "$ref": "#/definitions/TargetTrackingConfiguration" - } - }, - "required": [ - "TargetTrackingConfiguration" - ], - "type": "object" - }, - "BalancingStrategy": { - "description": "The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.", - "enum": [ - "SPOT_ONLY", - "SPOT_PREFERRED", - "ON_DEMAND_ONLY" - ], - "type": "string" - }, - "CreationTime": { - "description": "A timestamp that indicates when this data object was created.", - "type": "string" - }, - "DeleteOption": { - "description": "The type of delete to perform.", - "enum": [ - "SAFE_DELETE", - "FORCE_DELETE", - "RETAIN" - ], - "type": "string" - }, - "EstimatedInstanceWarmup": { - "description": "Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.", - "type": "number" - }, - "GameServerGroup": { - "additionalProperties": false, - "description": "Properties that describe a game server group resource. A game server group manages certain properties of a corresponding EC2 Auto Scaling group.", - "properties": { - "AutoScalingGroupArn": { - "$ref": "#/definitions/AutoScalingGroupArn" - }, - "BalancingStrategy": { - "$ref": "#/definitions/BalancingStrategy" - }, - "CreationTime": { - "$ref": "#/definitions/CreationTime" - }, - "GameServerGroupArn": { - "$ref": "#/definitions/GameServerGroupArn" - }, - "GameServerGroupName": { - "$ref": "#/definitions/GameServerGroupName" - }, - "GameServerProtectionPolicy": { - "$ref": "#/definitions/GameServerProtectionPolicy" - }, - "InstanceDefinitions": { - "$ref": "#/definitions/InstanceDefinitions" - }, - "LastUpdatedTime": { - "$ref": "#/definitions/LastUpdatedTime" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "Status": { - "$ref": "#/definitions/Status" - }, - "StatusReason": { - "$ref": "#/definitions/StatusReason" - }, - "SuspendedActions": { - "$ref": "#/definitions/SuspendedActions" - } - }, - "type": "object" - }, - "GameServerGroupArn": { - "description": "A generated unique ID for the game server group.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "GameServerGroupName": { - "description": "An identifier for the new game server group.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9-\\.]+", - "type": "string" - }, - "GameServerProtectionPolicy": { - "description": "A flag that indicates whether instances in the game server group are protected from early termination.", - "enum": [ - "NO_PROTECTION", - "FULL_PROTECTION" - ], - "type": "string" - }, - "InstanceDefinition": { - "additionalProperties": false, - "description": "An allowed instance type for your game server group.", - "properties": { - "InstanceType": { - "$ref": "#/definitions/InstanceType" - }, - "WeightedCapacity": { - "$ref": "#/definitions/WeightedCapacity" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "InstanceDefinitions": { - "description": "A set of EC2 instance types to use when creating instances in the group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceDefinition" - }, - "maxItems": 20, - "minItems": 2, - "type": "array" - }, - "InstanceType": { - "description": "An EC2 instance type designation.", - "type": "string" - }, - "LastUpdatedTime": { - "description": "A timestamp that indicates when this game server group was last updated.", - "type": "string" - }, - "LaunchTemplate": { - "additionalProperties": false, - "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", - "properties": { - "LaunchTemplateId": { - "$ref": "#/definitions/LaunchTemplateId" - }, - "LaunchTemplateName": { - "$ref": "#/definitions/LaunchTemplateName" - }, - "Version": { - "$ref": "#/definitions/Version" - } - }, - "type": "object" - }, - "LaunchTemplateId": { - "description": "A unique identifier for an existing EC2 launch template.", - "type": "string" - }, - "LaunchTemplateName": { - "description": "A readable identifier for an existing EC2 launch template.", - "type": "string" - }, - "MaxSize": { - "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", - "minimum": 1, - "type": "number" - }, - "MinSize": { - "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", - "minimum": 0, - "type": "number" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:.*:role\\/[\\w+=,.@-]+", - "type": "string" - }, - "Status": { - "description": "The current status of the game server group.", - "enum": [ - "NEW", - "ACTIVATING", - "ACTIVE", - "DELETE_SCHEDULED", - "DELETING", - "DELETED", - "ERROR" - ], - "type": "string" - }, - "StatusReason": { - "description": "Additional information about the current game server group status.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "SuspendedActions": { - "items": { - "enum": [ - "REPLACE_INSTANCE_TYPES" - ], - "type": "string" - }, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key for a developer-defined key:value pair for tagging an AWS resource.", - "type": "string" - }, - "Value": { - "description": "The value for a developer-defined key:value pair for tagging an AWS resource.", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TargetTrackingConfiguration": { - "additionalProperties": false, - "description": "Settings for a target-based scaling policy applied to Auto Scaling group.", - "properties": { - "TargetValue": { - "$ref": "#/definitions/TargetValue" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "TargetValue": { - "description": "Desired value to use with a game server group target-based scaling policy.", - "type": "number" - }, - "Version": { - "description": "The version of the EC2 launch template to use.", - "type": "string" - }, - "VpcSubnets": { - "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", - "insertionOrder": false, - "items": { - "maxLength": 24, - "minLength": 15, - "pattern": "^subnet-[0-9a-z]+$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "WeightedCapacity": { - "description": "Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group.", - "pattern": "^[\\u0031-\\u0039][\\u0030-\\u0039]{0,2}$", - "type": "string" - } - }, - "description": "The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateGameServerGroup", - "gamelift:TagResource", - "gamelift:DescribeGameServerGroup", - "iam:assumeRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeSubnets", - "ec2:RunInstances", - "ec2:CreateTags", - "ec2:DescribeLaunchTemplateVersions", - "autoscaling:CreateAutoScalingGroup", - "autoscaling:DescribeLifecycleHooks", - "autoscaling:DescribeNotificationConfigurations", - "autoscaling:CreateAutoScalingGroup", - "autoscaling:CreateOrUpdateTags", - "autoscaling:DescribeAutoScalingGroups", - "autoscaling:ExitStandby", - "autoscaling:PutLifecycleHook", - "autoscaling:PutScalingPolicy", - "autoscaling:ResumeProcesses", - "autoscaling:SetInstanceProtection", - "autoscaling:UpdateAutoScalingGroup", - "events:PutRule", - "events:PutTargets" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteGameServerGroup", - "gamelift:DescribeGameServerGroup", - "iam:assumeRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeSubnets", - "ec2:DescribeLaunchTemplateVersions", - "autoscaling:CreateAutoScalingGroup", - "autoscaling:DescribeLifecycleHooks", - "autoscaling:DescribeNotificationConfigurations", - "autoscaling:DescribeAutoScalingGroups", - "autoscaling:ExitStandby", - "autoscaling:PutLifecycleHook", - "autoscaling:PutScalingPolicy", - "autoscaling:ResumeProcesses", - "autoscaling:SetInstanceProtection", - "autoscaling:UpdateAutoScalingGroup", - "autoscaling:DeleteAutoScalingGroup", - "events:PutRule", - "events:PutTargets" - ] - }, - "list": { - "permissions": [ - "gamelift:ListGameServerGroups" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeGameServerGroup" - ] - }, - "update": { - "permissions": [ - "gamelift:UpdateGameServerGroup", - "iam:assumeRole", - "iam:PassRole", - "autoscaling:DescribeAutoScalingGroups", - "autoscaling:UpdateAutoScalingGroup", - "autoscaling:SetInstanceProtection" - ] - } - }, - "primaryIdentifier": [ - "/properties/GameServerGroupArn" - ], - "properties": { - "AutoScalingGroupArn": { - "$ref": "#/definitions/AutoScalingGroupArn", - "description": "A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group." - }, - "AutoScalingPolicy": { - "$ref": "#/definitions/AutoScalingPolicy", - "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." - }, - "BalancingStrategy": { - "$ref": "#/definitions/BalancingStrategy", - "description": "The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting." - }, - "DeleteOption": { - "$ref": "#/definitions/DeleteOption", - "description": "The type of delete to perform." - }, - "GameServerGroupArn": { - "$ref": "#/definitions/GameServerGroupArn", - "description": "A generated unique ID for the game server group." - }, - "GameServerGroupName": { - "$ref": "#/definitions/GameServerGroupName", - "description": "An identifier for the new game server group." - }, - "GameServerProtectionPolicy": { - "$ref": "#/definitions/GameServerProtectionPolicy", - "description": "A flag that indicates whether instances in the game server group are protected from early termination." - }, - "InstanceDefinitions": { - "$ref": "#/definitions/InstanceDefinitions", - "description": "A set of EC2 instance types to use when creating instances in the group." - }, - "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplate", - "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." - }, - "MaxSize": { - "$ref": "#/definitions/MaxSize", - "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." - }, - "MinSize": { - "$ref": "#/definitions/MinSize", - "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn", - "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups." - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead." - }, - "VpcSubnets": { - "$ref": "#/definitions/VpcSubnets", - "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." - } - }, - "readOnlyProperties": [ - "/properties/GameServerGroupArn", - "/properties/AutoScalingGroupArn" - ], - "required": [ - "GameServerGroupName", - "InstanceDefinitions", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "taggable": true, - "typeName": "AWS::GameLift::GameServerGroup", - "writeOnlyProperties": [ - "/properties/DeleteOption", - "/properties/LaunchTemplate", - "/properties/MinSize", - "/properties/MaxSize", - "/properties/AutoScalingPolicy", - "/properties/VpcSubnets", - "/properties/Tags" - ] -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "definitions": { + "AutoScalingGroupArn": { + "description": "A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.", + "maxLength": 256, + "minLength": 0, + "pattern": "[ -\ud7ff\ue000-\ufffd\ud800\udc00-\udbff\udfff\r\n\t]*", + "type": "string" + }, + "AutoScalingPolicy": { + "additionalProperties": false, + "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", + "properties": { + "EstimatedInstanceWarmup": { + "$ref": "#/definitions/EstimatedInstanceWarmup" + }, + "TargetTrackingConfiguration": { + "$ref": "#/definitions/TargetTrackingConfiguration" + } + }, + "required": [ + "TargetTrackingConfiguration" + ], + "type": "object" + }, + "BalancingStrategy": { + "description": "The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.", + "enum": [ + "SPOT_ONLY", + "SPOT_PREFERRED", + "ON_DEMAND_ONLY" + ], + "type": "string" + }, + "CreationTime": { + "description": "A timestamp that indicates when this data object was created.", + "type": "string" + }, + "DeleteOption": { + "description": "The type of delete to perform.", + "enum": [ + "SAFE_DELETE", + "FORCE_DELETE", + "RETAIN" + ], + "type": "string" + }, + "EstimatedInstanceWarmup": { + "description": "Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.", + "type": "number" + }, + "GameServerGroup": { + "additionalProperties": false, + "description": "Properties that describe a game server group resource. A game server group manages certain properties of a corresponding EC2 Auto Scaling group.", + "properties": { + "AutoScalingGroupArn": { + "$ref": "#/definitions/AutoScalingGroupArn" + }, + "BalancingStrategy": { + "$ref": "#/definitions/BalancingStrategy" + }, + "CreationTime": { + "$ref": "#/definitions/CreationTime" + }, + "GameServerGroupArn": { + "$ref": "#/definitions/GameServerGroupArn" + }, + "GameServerGroupName": { + "$ref": "#/definitions/GameServerGroupName" + }, + "GameServerProtectionPolicy": { + "$ref": "#/definitions/GameServerProtectionPolicy" + }, + "InstanceDefinitions": { + "$ref": "#/definitions/InstanceDefinitions" + }, + "LastUpdatedTime": { + "$ref": "#/definitions/LastUpdatedTime" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "Status": { + "$ref": "#/definitions/Status" + }, + "StatusReason": { + "$ref": "#/definitions/StatusReason" + }, + "SuspendedActions": { + "$ref": "#/definitions/SuspendedActions" + } + }, + "type": "object" + }, + "GameServerGroupArn": { + "description": "A generated unique ID for the game server group.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "GameServerGroupName": { + "description": "An identifier for the new game server group.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9-\\.]+", + "type": "string" + }, + "GameServerProtectionPolicy": { + "description": "A flag that indicates whether instances in the game server group are protected from early termination.", + "enum": [ + "NO_PROTECTION", + "FULL_PROTECTION" + ], + "type": "string" + }, + "InstanceDefinition": { + "additionalProperties": false, + "description": "An allowed instance type for your game server group.", + "properties": { + "InstanceType": { + "$ref": "#/definitions/InstanceType" + }, + "WeightedCapacity": { + "$ref": "#/definitions/WeightedCapacity" + } + }, + "required": [ + "InstanceType" + ], + "type": "object" + }, + "InstanceDefinitions": { + "description": "A set of EC2 instance types to use when creating instances in the group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceDefinition" + }, + "maxItems": 20, + "minItems": 2, + "type": "array" + }, + "InstanceType": { + "description": "An EC2 instance type designation.", + "type": "string" + }, + "LastUpdatedTime": { + "description": "A timestamp that indicates when this game server group was last updated.", + "type": "string" + }, + "LaunchTemplate": { + "additionalProperties": false, + "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", + "properties": { + "LaunchTemplateId": { + "$ref": "#/definitions/LaunchTemplateId" + }, + "LaunchTemplateName": { + "$ref": "#/definitions/LaunchTemplateName" + }, + "Version": { + "$ref": "#/definitions/Version" + } + }, + "type": "object" + }, + "LaunchTemplateId": { + "description": "A unique identifier for an existing EC2 launch template.", + "type": "string" + }, + "LaunchTemplateName": { + "description": "A readable identifier for an existing EC2 launch template.", + "type": "string" + }, + "MaxSize": { + "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", + "minimum": 1, + "type": "number" + }, + "MinSize": { + "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", + "minimum": 0, + "type": "number" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:.*:role\\/[\\w+=,.@-]+", + "type": "string" + }, + "Status": { + "description": "The current status of the game server group.", + "enum": [ + "NEW", + "ACTIVATING", + "ACTIVE", + "DELETE_SCHEDULED", + "DELETING", + "DELETED", + "ERROR" + ], + "type": "string" + }, + "StatusReason": { + "description": "Additional information about the current game server group status.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "SuspendedActions": { + "items": { + "enum": [ + "REPLACE_INSTANCE_TYPES" + ], + "type": "string" + }, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key for a developer-defined key:value pair for tagging an AWS resource.", + "type": "string" + }, + "Value": { + "description": "The value for a developer-defined key:value pair for tagging an AWS resource.", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TargetTrackingConfiguration": { + "additionalProperties": false, + "description": "Settings for a target-based scaling policy applied to Auto Scaling group.", + "properties": { + "TargetValue": { + "$ref": "#/definitions/TargetValue" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" + }, + "TargetValue": { + "description": "Desired value to use with a game server group target-based scaling policy.", + "type": "number" + }, + "Version": { + "description": "The version of the EC2 launch template to use.", + "type": "string" + }, + "VpcSubnets": { + "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", + "insertionOrder": false, + "items": { + "maxLength": 24, + "minLength": 15, + "pattern": "^subnet-[0-9a-z]+$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "WeightedCapacity": { + "description": "Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group.", + "pattern": "^[\\u0031-\\u0039][\\u0030-\\u0039]{0,2}$", + "type": "string" + } + }, + "description": "The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateGameServerGroup", + "gamelift:TagResource", + "gamelift:DescribeGameServerGroup", + "iam:assumeRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeSubnets", + "ec2:RunInstances", + "ec2:CreateTags", + "ec2:DescribeLaunchTemplateVersions", + "autoscaling:CreateAutoScalingGroup", + "autoscaling:DescribeLifecycleHooks", + "autoscaling:DescribeNotificationConfigurations", + "autoscaling:CreateAutoScalingGroup", + "autoscaling:CreateOrUpdateTags", + "autoscaling:DescribeAutoScalingGroups", + "autoscaling:ExitStandby", + "autoscaling:PutLifecycleHook", + "autoscaling:PutScalingPolicy", + "autoscaling:ResumeProcesses", + "autoscaling:SetInstanceProtection", + "autoscaling:UpdateAutoScalingGroup", + "events:PutRule", + "events:PutTargets" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteGameServerGroup", + "gamelift:DescribeGameServerGroup", + "iam:assumeRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeSubnets", + "ec2:DescribeLaunchTemplateVersions", + "autoscaling:CreateAutoScalingGroup", + "autoscaling:DescribeLifecycleHooks", + "autoscaling:DescribeNotificationConfigurations", + "autoscaling:DescribeAutoScalingGroups", + "autoscaling:ExitStandby", + "autoscaling:PutLifecycleHook", + "autoscaling:PutScalingPolicy", + "autoscaling:ResumeProcesses", + "autoscaling:SetInstanceProtection", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:DeleteAutoScalingGroup", + "events:PutRule", + "events:PutTargets" + ] + }, + "list": { + "permissions": [ + "gamelift:ListGameServerGroups" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeGameServerGroup" + ] + }, + "update": { + "permissions": [ + "gamelift:UpdateGameServerGroup", + "iam:assumeRole", + "iam:PassRole", + "autoscaling:DescribeAutoScalingGroups", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:SetInstanceProtection" + ] + } + }, + "primaryIdentifier": [ + "/properties/GameServerGroupArn" + ], + "properties": { + "AutoScalingGroupArn": { + "$ref": "#/definitions/AutoScalingGroupArn", + "description": "A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group." + }, + "AutoScalingPolicy": { + "$ref": "#/definitions/AutoScalingPolicy", + "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "BalancingStrategy": { + "$ref": "#/definitions/BalancingStrategy", + "description": "The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting." + }, + "DeleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "The type of delete to perform." + }, + "GameServerGroupArn": { + "$ref": "#/definitions/GameServerGroupArn", + "description": "A generated unique ID for the game server group." + }, + "GameServerGroupName": { + "$ref": "#/definitions/GameServerGroupName", + "description": "An identifier for the new game server group." + }, + "GameServerProtectionPolicy": { + "$ref": "#/definitions/GameServerProtectionPolicy", + "description": "A flag that indicates whether instances in the game server group are protected from early termination." + }, + "InstanceDefinitions": { + "$ref": "#/definitions/InstanceDefinitions", + "description": "A set of EC2 instance types to use when creating instances in the group." + }, + "LaunchTemplate": { + "$ref": "#/definitions/LaunchTemplate", + "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "MaxSize": { + "$ref": "#/definitions/MaxSize", + "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "MinSize": { + "$ref": "#/definitions/MinSize", + "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn", + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups." + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead." + }, + "VpcSubnets": { + "$ref": "#/definitions/VpcSubnets", + "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + } + }, + "readOnlyProperties": [ + "/properties/GameServerGroupArn", + "/properties/AutoScalingGroupArn" + ], + "required": [ + "GameServerGroupName", + "InstanceDefinitions", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "taggable": true, + "typeName": "AWS::GameLift::GameServerGroup", + "writeOnlyProperties": [ + "/properties/DeleteOption", + "/properties/LaunchTemplate", + "/properties/MinSize", + "/properties/MaxSize", + "/properties/AutoScalingPolicy", + "/properties/VpcSubnets", + "/properties/Tags" + ] +} diff --git a/schema/aws-gamelift-gamesessionqueue.json b/schema/aws-gamelift-gamesessionqueue.json index 7032f34..32bb650 100644 --- a/schema/aws-gamelift-gamesessionqueue.json +++ b/schema/aws-gamelift-gamesessionqueue.json @@ -1,247 +1,247 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AllowedLocations": { - "description": "A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.", - "insertionOrder": false, - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-z]+(-([a-z]+|\\d))*", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "FilterConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedLocations": { - "$ref": "#/definitions/AllowedLocations" - } - }, - "type": "object" - }, - "GameSessionQueueDestination": { - "additionalProperties": false, - "description": "A fleet or alias designated in a game session queue.", - "properties": { - "DestinationArn": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9:/-]+", - "type": "string" - } - }, - "type": "object" - }, - "LocationOrder": { - "description": "The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.", - "insertionOrder": true, - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-]+", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "PlayerLatencyPolicy": { - "additionalProperties": false, - "description": "Sets a latency cap for individual players when placing a game session.", - "properties": { - "MaximumIndividualPlayerLatencyMilliseconds": { - "description": "The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.", - "minimum": 0, - "type": "integer" - }, - "PolicyDurationSeconds": { - "description": "The length of time, in seconds, that the policy is enforced while placing a new game session.", - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "PriorityConfiguration": { - "additionalProperties": false, - "properties": { - "LocationOrder": { - "$ref": "#/definitions/LocationOrder" - }, - "PriorityOrder": { - "$ref": "#/definitions/PriorityOrder" - } - }, - "type": "object" - }, - "PriorityOrder": { - "description": "The recommended sequence to use when prioritizing where to place new game sessions.", - "insertionOrder": true, - "items": { - "enum": [ - "LATENCY", - "COST", - "DESTINATION", - "LOCATION" - ], - "type": "string" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateGameSessionQueue", - "gamelift:ListTagsForResource", - "gamelift:TagResource" - ] - }, - "delete": { - "permissions": [ - "gamelift:DescribeGameSessionQueues", - "gamelift:DeleteGameSessionQueue" - ] - }, - "list": { - "permissions": [ - "gamelift:DescribeGameSessionQueues" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeGameSessionQueues", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:UpdateGameSessionQueue", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+", - "type": "string" - }, - "CustomEventData": { - "description": "Information that is added to all events that are related to this game session queue.", - "maxLength": 256, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "Destinations": { - "description": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/GameSessionQueueDestination" - }, - "type": "array" - }, - "FilterConfiguration": { - "$ref": "#/definitions/FilterConfiguration", - "description": "A list of locations where a queue is allowed to place new game sessions.", - "type": "object" - }, - "Name": { - "description": "A descriptive label that is associated with game session queue. Queue names must be unique within each Region.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9-]+", - "type": "string" - }, - "NotificationTarget": { - "description": "An SNS topic ARN that is set up to receive game session placement notifications.", - "maxLength": 300, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]*(\\.fifo)?", - "type": "string" - }, - "PlayerLatencyPolicies": { - "description": "A set of policies that act as a sliding cap on player latency.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PlayerLatencyPolicy" - }, - "type": "array" - }, - "PriorityConfiguration": { - "$ref": "#/definitions/PriorityConfiguration", - "description": "Custom settings to use when prioritizing destinations and locations for game session placements.", - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "TimeoutInSeconds": { - "description": "The maximum time, in seconds, that a new game session placement request remains in the queue.", - "minimum": 0, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::GameLift::GameSessionQueue" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AllowedLocations": { + "description": "A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.", + "insertionOrder": false, + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-z]+(-([a-z]+|\\d))*", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "FilterConfiguration": { + "additionalProperties": false, + "properties": { + "AllowedLocations": { + "$ref": "#/definitions/AllowedLocations" + } + }, + "type": "object" + }, + "GameSessionQueueDestination": { + "additionalProperties": false, + "description": "A fleet or alias designated in a game session queue.", + "properties": { + "DestinationArn": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9:/-]+", + "type": "string" + } + }, + "type": "object" + }, + "LocationOrder": { + "description": "The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.", + "insertionOrder": true, + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-]+", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "PlayerLatencyPolicy": { + "additionalProperties": false, + "description": "Sets a latency cap for individual players when placing a game session.", + "properties": { + "MaximumIndividualPlayerLatencyMilliseconds": { + "description": "The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.", + "minimum": 0, + "type": "integer" + }, + "PolicyDurationSeconds": { + "description": "The length of time, in seconds, that the policy is enforced while placing a new game session.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "PriorityConfiguration": { + "additionalProperties": false, + "properties": { + "LocationOrder": { + "$ref": "#/definitions/LocationOrder" + }, + "PriorityOrder": { + "$ref": "#/definitions/PriorityOrder" + } + }, + "type": "object" + }, + "PriorityOrder": { + "description": "The recommended sequence to use when prioritizing where to place new game sessions.", + "insertionOrder": true, + "items": { + "enum": [ + "LATENCY", + "COST", + "DESTINATION", + "LOCATION" + ], + "type": "string" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateGameSessionQueue", + "gamelift:ListTagsForResource", + "gamelift:TagResource" + ] + }, + "delete": { + "permissions": [ + "gamelift:DescribeGameSessionQueues", + "gamelift:DeleteGameSessionQueue" + ] + }, + "list": { + "permissions": [ + "gamelift:DescribeGameSessionQueues" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeGameSessionQueues", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:UpdateGameSessionQueue", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+", + "type": "string" + }, + "CustomEventData": { + "description": "Information that is added to all events that are related to this game session queue.", + "maxLength": 256, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "Destinations": { + "description": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/GameSessionQueueDestination" + }, + "type": "array" + }, + "FilterConfiguration": { + "$ref": "#/definitions/FilterConfiguration", + "description": "A list of locations where a queue is allowed to place new game sessions.", + "type": "object" + }, + "Name": { + "description": "A descriptive label that is associated with game session queue. Queue names must be unique within each Region.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9-]+", + "type": "string" + }, + "NotificationTarget": { + "description": "An SNS topic ARN that is set up to receive game session placement notifications.", + "maxLength": 300, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]*(\\.fifo)?", + "type": "string" + }, + "PlayerLatencyPolicies": { + "description": "A set of policies that act as a sliding cap on player latency.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PlayerLatencyPolicy" + }, + "type": "array" + }, + "PriorityConfiguration": { + "$ref": "#/definitions/PriorityConfiguration", + "description": "Custom settings to use when prioritizing destinations and locations for game session placements.", + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "TimeoutInSeconds": { + "description": "The maximum time, in seconds, that a new game session placement request remains in the queue.", + "minimum": 0, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::GameLift::GameSessionQueue" +} diff --git a/schema/aws-gamelift-location.json b/schema/aws-gamelift-location.json index 5cfed41..caaa573 100644 --- a/schema/aws-gamelift-location.json +++ b/schema/aws-gamelift-location.json @@ -1,105 +1,105 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LocationName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateLocation", - "gamelift:ListLocations", - "gamelift:ListTagsForResource", - "gamelift:TagResource" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteLocation" - ] - }, - "list": { - "permissions": [ - "gamelift:ListLocations" - ] - }, - "read": { - "permissions": [ - "gamelift:ListLocations", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:ListLocations", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LocationName" - ], - "properties": { - "LocationArn": { - "pattern": "^arn:.*:location/custom-\\S+", - "type": "string" - }, - "LocationName": { - "maxLength": 64, - "minLength": 8, - "pattern": "^custom-[A-Za-z0-9\\-]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/LocationArn" - ], - "required": [ - "LocationName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::GameLift::Location" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LocationName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateLocation", + "gamelift:ListLocations", + "gamelift:ListTagsForResource", + "gamelift:TagResource" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteLocation" + ] + }, + "list": { + "permissions": [ + "gamelift:ListLocations" + ] + }, + "read": { + "permissions": [ + "gamelift:ListLocations", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:ListLocations", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LocationName" + ], + "properties": { + "LocationArn": { + "pattern": "^arn:.*:location/custom-\\S+", + "type": "string" + }, + "LocationName": { + "maxLength": 64, + "minLength": 8, + "pattern": "^custom-[A-Za-z0-9\\-]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/LocationArn" + ], + "required": [ + "LocationName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::GameLift::Location" +} diff --git a/schema/aws-gamelift-matchmakingconfiguration.json b/schema/aws-gamelift-matchmakingconfiguration.json index e96d5d9..1ace220 100644 --- a/schema/aws-gamelift-matchmakingconfiguration.json +++ b/schema/aws-gamelift-matchmakingconfiguration.json @@ -1,230 +1,230 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "GameProperty": { - "additionalProperties": false, - "description": "A key-value pair that contains information about a game session.", - "properties": { - "Key": { - "description": "The game property identifier.", - "maxLength": 32, - "type": "string" - }, - "Value": { - "description": "The game property value.", - "maxLength": 96, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateMatchmakingConfiguration", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:DescribeMatchmakingConfigurations" - ] - }, - "delete": { - "permissions": [ - "gamelift:DescribeMatchmakingConfigurations", - "gamelift:DeleteMatchmakingConfiguration" - ] - }, - "list": { - "permissions": [ - "gamelift:DescribeMatchmakingConfigurations" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeMatchmakingConfigurations", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:DescribeMatchmakingConfigurations", - "gamelift:UpdateMatchmakingConfiguration", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AcceptanceRequired": { - "description": "A flag that indicates whether a match that was created with this configuration must be accepted by the matched players", - "type": "boolean" - }, - "AcceptanceTimeoutSeconds": { - "description": "The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.", - "maximum": 600, - "minimum": 1, - "type": "integer" - }, - "AdditionalPlayerCount": { - "description": "The number of player slots in a match to keep open for future players.", - "minimum": 0, - "type": "integer" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.", - "pattern": "^arn:.*:matchmakingconfiguration\\/[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "BackfillMode": { - "description": "The method used to backfill game sessions created with this matchmaking configuration.", - "enum": [ - "AUTOMATIC", - "MANUAL" - ], - "type": "string" - }, - "CreationTime": { - "description": "A time stamp indicating when this data object was created.", - "type": "string" - }, - "CustomEventData": { - "description": "Information to attach to all events related to the matchmaking configuration.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Description": { - "description": "A descriptive label that is associated with matchmaking configuration.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "FlexMatchMode": { - "description": "Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.", - "enum": [ - "STANDALONE", - "WITH_QUEUE" - ], - "type": "string" - }, - "GameProperties": { - "description": "A set of custom properties for a game session, formatted as key:value pairs.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/GameProperty" - }, - "maxItems": 16, - "type": "array", - "uniqueItems": true - }, - "GameSessionData": { - "description": "A set of custom game session properties, formatted as a single string value.", - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "GameSessionQueueArns": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9:/-]+", - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "A unique identifier for the matchmaking configuration.", - "maxLength": 128, - "pattern": "[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "NotificationTarget": { - "description": "An SNS topic ARN that is set up to receive matchmaking notifications.", - "maxLength": 300, - "minLength": 0, - "pattern": "[a-zA-Z0-9:_/-]*(.fifo)?", - "type": "string" - }, - "RequestTimeoutSeconds": { - "description": "The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.", - "maximum": 43200, - "minimum": 1, - "type": "integer" - }, - "RuleSetArn": { - "description": "The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.", - "pattern": "^arn:.*:matchmakingruleset\\/[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "RuleSetName": { - "description": "A unique identifier for the matchmaking rule set to use with this configuration.", - "maxLength": 128, - "pattern": "[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AcceptanceRequired", - "Name", - "RequestTimeoutSeconds", - "RuleSetName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::GameLift::MatchmakingConfiguration" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "GameProperty": { + "additionalProperties": false, + "description": "A key-value pair that contains information about a game session.", + "properties": { + "Key": { + "description": "The game property identifier.", + "maxLength": 32, + "type": "string" + }, + "Value": { + "description": "The game property value.", + "maxLength": 96, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateMatchmakingConfiguration", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:DescribeMatchmakingConfigurations" + ] + }, + "delete": { + "permissions": [ + "gamelift:DescribeMatchmakingConfigurations", + "gamelift:DeleteMatchmakingConfiguration" + ] + }, + "list": { + "permissions": [ + "gamelift:DescribeMatchmakingConfigurations" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeMatchmakingConfigurations", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:DescribeMatchmakingConfigurations", + "gamelift:UpdateMatchmakingConfiguration", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AcceptanceRequired": { + "description": "A flag that indicates whether a match that was created with this configuration must be accepted by the matched players", + "type": "boolean" + }, + "AcceptanceTimeoutSeconds": { + "description": "The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.", + "maximum": 600, + "minimum": 1, + "type": "integer" + }, + "AdditionalPlayerCount": { + "description": "The number of player slots in a match to keep open for future players.", + "minimum": 0, + "type": "integer" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.", + "pattern": "^arn:.*:matchmakingconfiguration\\/[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "BackfillMode": { + "description": "The method used to backfill game sessions created with this matchmaking configuration.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "type": "string" + }, + "CreationTime": { + "description": "A time stamp indicating when this data object was created.", + "type": "string" + }, + "CustomEventData": { + "description": "Information to attach to all events related to the matchmaking configuration.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Description": { + "description": "A descriptive label that is associated with matchmaking configuration.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "FlexMatchMode": { + "description": "Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.", + "enum": [ + "STANDALONE", + "WITH_QUEUE" + ], + "type": "string" + }, + "GameProperties": { + "description": "A set of custom properties for a game session, formatted as key:value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/GameProperty" + }, + "maxItems": 16, + "type": "array", + "uniqueItems": true + }, + "GameSessionData": { + "description": "A set of custom game session properties, formatted as a single string value.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "GameSessionQueueArns": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9:/-]+", + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "A unique identifier for the matchmaking configuration.", + "maxLength": 128, + "pattern": "[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "NotificationTarget": { + "description": "An SNS topic ARN that is set up to receive matchmaking notifications.", + "maxLength": 300, + "minLength": 0, + "pattern": "[a-zA-Z0-9:_/-]*(.fifo)?", + "type": "string" + }, + "RequestTimeoutSeconds": { + "description": "The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.", + "maximum": 43200, + "minimum": 1, + "type": "integer" + }, + "RuleSetArn": { + "description": "The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.", + "pattern": "^arn:.*:matchmakingruleset\\/[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "RuleSetName": { + "description": "A unique identifier for the matchmaking rule set to use with this configuration.", + "maxLength": 128, + "pattern": "[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AcceptanceRequired", + "Name", + "RequestTimeoutSeconds", + "RuleSetName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::GameLift::MatchmakingConfiguration" +} diff --git a/schema/aws-gamelift-matchmakingruleset.json b/schema/aws-gamelift-matchmakingruleset.json index a2af578..8f7034c 100644 --- a/schema/aws-gamelift-matchmakingruleset.json +++ b/schema/aws-gamelift-matchmakingruleset.json @@ -1,122 +1,122 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/RuleSetBody" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateMatchmakingRuleSet", - "gamelift:DescribeMatchmakingRuleSets", - "gamelift:ValidateMatchmakingRuleSet", - "gamelift:ListTagsForResource", - "gamelift:TagResource" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteMatchmakingRuleSet" - ] - }, - "list": { - "permissions": [ - "gamelift:DescribeMatchmakingRuleSets" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeMatchmakingRuleSets", - "gamelift:ValidateMatchmakingRuleSet", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:DescribeMatchmakingRuleSets", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.", - "pattern": "^arn:.*:matchmakingruleset\\/[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "CreationTime": { - "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.", - "type": "string" - }, - "Name": { - "description": "A unique identifier for the matchmaking rule set.", - "maxLength": 128, - "pattern": "[a-zA-Z0-9-\\.]*", - "type": "string" - }, - "RuleSetBody": { - "description": "A collection of matchmaking rules, formatted as a JSON string.", - "maxLength": 65535, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime" - ], - "required": [ - "Name", - "RuleSetBody" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::GameLift::MatchmakingRuleSet" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/RuleSetBody" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateMatchmakingRuleSet", + "gamelift:DescribeMatchmakingRuleSets", + "gamelift:ValidateMatchmakingRuleSet", + "gamelift:ListTagsForResource", + "gamelift:TagResource" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteMatchmakingRuleSet" + ] + }, + "list": { + "permissions": [ + "gamelift:DescribeMatchmakingRuleSets" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeMatchmakingRuleSets", + "gamelift:ValidateMatchmakingRuleSet", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:DescribeMatchmakingRuleSets", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.", + "pattern": "^arn:.*:matchmakingruleset\\/[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "CreationTime": { + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.", + "type": "string" + }, + "Name": { + "description": "A unique identifier for the matchmaking rule set.", + "maxLength": 128, + "pattern": "[a-zA-Z0-9-\\.]*", + "type": "string" + }, + "RuleSetBody": { + "description": "A collection of matchmaking rules, formatted as a JSON string.", + "maxLength": 65535, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime" + ], + "required": [ + "Name", + "RuleSetBody" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::GameLift::MatchmakingRuleSet" +} diff --git a/schema/aws-gamelift-script.json b/schema/aws-gamelift-script.json index da5e4fc..125ff42 100644 --- a/schema/aws-gamelift-script.json +++ b/schema/aws-gamelift-script.json @@ -1,168 +1,168 @@ -{ - "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", - "additionalProperties": false, - "definitions": { - "S3Location": { - "$comment": "Contains object details present in the S3 Bucket", - "additionalProperties": false, - "properties": { - "Bucket": { - "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.", - "minLength": 1, - "type": "string" - }, - "Key": { - "description": "The name of the zip file that contains the script files.", - "minLength": 1, - "type": "string" - }, - "ObjectVersion": { - "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.", - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.", - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.", - "handlers": { - "create": { - "permissions": [ - "gamelift:CreateScript", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:DescribeScript", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "gamelift:DeleteScript" - ] - }, - "list": { - "permissions": [ - "gamelift:ListScripts", - "gamelift:DescribeScript" - ] - }, - "read": { - "permissions": [ - "gamelift:DescribeScript", - "gamelift:ListScripts", - "gamelift:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "gamelift:DescribeScript", - "gamelift:UpdateScript", - "gamelift:ListTagsForResource", - "gamelift:TagResource", - "gamelift:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.", - "pattern": "^arn:.*:script\\/script-\\S+", - "type": "string" - }, - "CreationTime": { - "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").", - "type": "string" - }, - "Id": { - "description": "A unique identifier for the Realtime script", - "pattern": "^script-\\S+", - "type": "string" - }, - "Name": { - "description": "A descriptive label that is associated with a script. Script names do not need to be unique.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "SizeOnDisk": { - "description": "The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at \"0\".", - "minimum": 1, - "type": "integer" - }, - "StorageLocation": { - "$ref": "#/definitions/S3Location", - "description": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.", - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "Version": { - "description": "The version that is associated with a script. Version strings do not need to be unique.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/CreationTime", - "/properties/Arn", - "/properties/SizeOnDisk" - ], - "required": [ - "StorageLocation" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::GameLift::Script" -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "definitions": { + "S3Location": { + "$comment": "Contains object details present in the S3 Bucket", + "additionalProperties": false, + "properties": { + "Bucket": { + "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.", + "minLength": 1, + "type": "string" + }, + "Key": { + "description": "The name of the zip file that contains the script files.", + "minLength": 1, + "type": "string" + }, + "ObjectVersion": { + "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.", + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key", + "RoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateScript", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:DescribeScript", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "gamelift:DeleteScript" + ] + }, + "list": { + "permissions": [ + "gamelift:ListScripts", + "gamelift:DescribeScript" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeScript", + "gamelift:ListScripts", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:DescribeScript", + "gamelift:UpdateScript", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.", + "pattern": "^arn:.*:script\\/script-\\S+", + "type": "string" + }, + "CreationTime": { + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").", + "type": "string" + }, + "Id": { + "description": "A unique identifier for the Realtime script", + "pattern": "^script-\\S+", + "type": "string" + }, + "Name": { + "description": "A descriptive label that is associated with a script. Script names do not need to be unique.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "SizeOnDisk": { + "description": "The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at \"0\".", + "minimum": 1, + "type": "integer" + }, + "StorageLocation": { + "$ref": "#/definitions/S3Location", + "description": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.", + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "Version": { + "description": "The version that is associated with a script. Version strings do not need to be unique.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CreationTime", + "/properties/Arn", + "/properties/SizeOnDisk" + ], + "required": [ + "StorageLocation" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::GameLift::Script" +} diff --git a/schema/aws-globalaccelerator-accelerator.json b/schema/aws-globalaccelerator-accelerator.json index e173cde..bca03ab 100644 --- a/schema/aws-globalaccelerator-accelerator.json +++ b/schema/aws-globalaccelerator-accelerator.json @@ -1,158 +1,158 @@ -{ - "additionalProperties": false, - "definitions": { - "IpAddress": { - "description": "An IPV4 address", - "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "Tag is a key-value pair associated with accelerator.", - "properties": { - "Key": { - "description": "Key of the tag. Value can be 1 to 127 characters.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Value for the tag. Value can be 1 to 255 characters.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GlobalAccelerator::Accelerator", - "handlers": { - "create": { - "permissions": [ - "globalaccelerator:CreateAccelerator", - "globalaccelerator:DescribeAccelerator", - "globalaccelerator:TagResource" - ] - }, - "delete": { - "permissions": [ - "globalaccelerator:UpdateAccelerator", - "globalaccelerator:DeleteAccelerator", - "globalaccelerator:DescribeAccelerator" - ] - }, - "list": { - "permissions": [ - "globalaccelerator:ListAccelerators" - ] - }, - "read": { - "permissions": [ - "globalaccelerator:DescribeAccelerator" - ] - }, - "update": { - "permissions": [ - "globalaccelerator:UpdateAccelerator", - "globalaccelerator:TagResource", - "globalaccelerator:UntagResource", - "globalaccelerator:DescribeAccelerator" - ] - } - }, - "primaryIdentifier": [ - "/properties/AcceleratorArn" - ], - "properties": { - "AcceleratorArn": { - "description": "The Amazon Resource Name (ARN) of the accelerator.", - "type": "string" - }, - "DnsName": { - "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.", - "type": "string" - }, - "DualStackDnsName": { - "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.", - "type": "string" - }, - "Enabled": { - "default": true, - "description": "Indicates whether an accelerator is enabled. The value is true or false.", - "type": "boolean" - }, - "IpAddressType": { - "default": "IPV4", - "description": "IP Address type.", - "enum": [ - "IPV4", - "DUAL_STACK" - ], - "type": "string" - }, - "IpAddresses": { - "default": null, - "description": "The IP addresses from BYOIP Prefix pool.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpAddress" - }, - "type": "array" - }, - "Ipv4Addresses": { - "description": "The IPv4 addresses assigned to the accelerator.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Ipv6Addresses": { - "default": null, - "description": "The IPv6 addresses assigned if the accelerator is dualstack", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "Name of accelerator.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]{0,64}$", - "type": "string" - }, - "Tags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AcceleratorArn", - "/properties/DnsName", - "/properties/Ipv4Addresses", - "/properties/Ipv6Addresses", - "/properties/DualStackDnsName" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GlobalAccelerator::Accelerator" -} +{ + "additionalProperties": false, + "definitions": { + "IpAddress": { + "description": "An IPV4 address", + "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "Tag is a key-value pair associated with accelerator.", + "properties": { + "Key": { + "description": "Key of the tag. Value can be 1 to 127 characters.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Value for the tag. Value can be 1 to 255 characters.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GlobalAccelerator::Accelerator", + "handlers": { + "create": { + "permissions": [ + "globalaccelerator:CreateAccelerator", + "globalaccelerator:DescribeAccelerator", + "globalaccelerator:TagResource" + ] + }, + "delete": { + "permissions": [ + "globalaccelerator:UpdateAccelerator", + "globalaccelerator:DeleteAccelerator", + "globalaccelerator:DescribeAccelerator" + ] + }, + "list": { + "permissions": [ + "globalaccelerator:ListAccelerators" + ] + }, + "read": { + "permissions": [ + "globalaccelerator:DescribeAccelerator" + ] + }, + "update": { + "permissions": [ + "globalaccelerator:UpdateAccelerator", + "globalaccelerator:TagResource", + "globalaccelerator:UntagResource", + "globalaccelerator:DescribeAccelerator" + ] + } + }, + "primaryIdentifier": [ + "/properties/AcceleratorArn" + ], + "properties": { + "AcceleratorArn": { + "description": "The Amazon Resource Name (ARN) of the accelerator.", + "type": "string" + }, + "DnsName": { + "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.", + "type": "string" + }, + "DualStackDnsName": { + "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.", + "type": "string" + }, + "Enabled": { + "default": true, + "description": "Indicates whether an accelerator is enabled. The value is true or false.", + "type": "boolean" + }, + "IpAddressType": { + "default": "IPV4", + "description": "IP Address type.", + "enum": [ + "IPV4", + "DUAL_STACK" + ], + "type": "string" + }, + "IpAddresses": { + "default": null, + "description": "The IP addresses from BYOIP Prefix pool.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpAddress" + }, + "type": "array" + }, + "Ipv4Addresses": { + "description": "The IPv4 addresses assigned to the accelerator.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Ipv6Addresses": { + "default": null, + "description": "The IPv6 addresses assigned if the accelerator is dualstack", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "Name of accelerator.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{0,64}$", + "type": "string" + }, + "Tags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AcceleratorArn", + "/properties/DnsName", + "/properties/Ipv4Addresses", + "/properties/Ipv6Addresses", + "/properties/DualStackDnsName" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GlobalAccelerator::Accelerator" +} diff --git a/schema/aws-globalaccelerator-crossaccountattachment.json b/schema/aws-globalaccelerator-crossaccountattachment.json index 211e0bf..c7ea5d9 100644 --- a/schema/aws-globalaccelerator-crossaccountattachment.json +++ b/schema/aws-globalaccelerator-crossaccountattachment.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "definitions": { - "Resource": { - "additionalProperties": false, - "description": "ARN of resource to share.", - "properties": { - "Cidr": { - "type": "string" - }, - "EndpointId": { - "type": "string" - }, - "Region": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Tag is a key-value pair associated with Cross Account Attachment.", - "properties": { - "Key": { - "description": "Key of the tag. Value can be 1 to 127 characters.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Value for the tag. Value can be 1 to 255 characters.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment", - "handlers": { - "create": { - "permissions": [ - "globalaccelerator:DescribeCrossAccountAttachment", - "globalaccelerator:CreateCrossAccountAttachment", - "globalaccelerator:TagResource" - ] - }, - "delete": { - "permissions": [ - "globalaccelerator:DescribeCrossAccountAttachment", - "globalaccelerator:DeleteCrossAccountAttachment" - ] - }, - "list": { - "permissions": [ - "globalaccelerator:ListCrossAccountAttachments" - ] - }, - "read": { - "permissions": [ - "globalaccelerator:DescribeCrossAccountAttachment" - ] - }, - "update": { - "permissions": [ - "globalaccelerator:UpdateCrossAccountAttachment", - "globalaccelerator:DescribeCrossAccountAttachment", - "globalaccelerator:TagResource", - "globalaccelerator:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentArn" - ], - "properties": { - "AttachmentArn": { - "description": "The Amazon Resource Name (ARN) of the attachment.", - "type": "string" - }, - "Name": { - "description": "The Friendly identifier of the attachment.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]{0,64}$", - "type": "string" - }, - "Principals": { - "description": "Principals to share the resources with.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Resources": { - "description": "Resources shared using the attachment.", - "items": { - "$ref": "#/definitions/Resource" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AttachmentArn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GlobalAccelerator::CrossAccountAttachment", - "writeOnlyProperties": [ - "/properties/Resources/*/Region" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Resource": { + "additionalProperties": false, + "description": "ARN of resource to share.", + "properties": { + "Cidr": { + "type": "string" + }, + "EndpointId": { + "type": "string" + }, + "Region": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tag is a key-value pair associated with Cross Account Attachment.", + "properties": { + "Key": { + "description": "Key of the tag. Value can be 1 to 127 characters.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Value for the tag. Value can be 1 to 255 characters.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment", + "handlers": { + "create": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:CreateCrossAccountAttachment", + "globalaccelerator:TagResource" + ] + }, + "delete": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:DeleteCrossAccountAttachment" + ] + }, + "list": { + "permissions": [ + "globalaccelerator:ListCrossAccountAttachments" + ] + }, + "read": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment" + ] + }, + "update": { + "permissions": [ + "globalaccelerator:UpdateCrossAccountAttachment", + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:TagResource", + "globalaccelerator:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentArn" + ], + "properties": { + "AttachmentArn": { + "description": "The Amazon Resource Name (ARN) of the attachment.", + "type": "string" + }, + "Name": { + "description": "The Friendly identifier of the attachment.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{0,64}$", + "type": "string" + }, + "Principals": { + "description": "Principals to share the resources with.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Resources": { + "description": "Resources shared using the attachment.", + "items": { + "$ref": "#/definitions/Resource" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AttachmentArn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GlobalAccelerator::CrossAccountAttachment", + "writeOnlyProperties": [ + "/properties/Resources/*/Region" + ] +} diff --git a/schema/aws-globalaccelerator-endpointgroup.json b/schema/aws-globalaccelerator-endpointgroup.json index aa39e54..80e4948 100644 --- a/schema/aws-globalaccelerator-endpointgroup.json +++ b/schema/aws-globalaccelerator-endpointgroup.json @@ -1,184 +1,184 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EndpointGroupRegion", - "/properties/ListenerArn" - ], - "definitions": { - "EndpointConfiguration": { - "additionalProperties": false, - "description": "The configuration for a given endpoint", - "properties": { - "AttachmentArn": { - "description": "Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.", - "type": "string" - }, - "ClientIPPreservationEnabled": { - "default": true, - "description": "true if client ip should be preserved", - "type": "boolean" - }, - "EndpointId": { - "description": "Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID", - "type": "string" - }, - "Weight": { - "default": 100, - "description": "The weight for the endpoint.", - "maximum": 255, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "EndpointId" - ], - "type": "object" - }, - "Port": { - "description": "A network port number", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "PortOverride": { - "additionalProperties": false, - "description": "listener to endpoint port mapping.", - "properties": { - "EndpointPort": { - "$ref": "#/definitions/Port" - }, - "ListenerPort": { - "$ref": "#/definitions/Port" - } - }, - "required": [ - "ListenerPort", - "EndpointPort" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GlobalAccelerator::EndpointGroup", - "handlers": { - "create": { - "permissions": [ - "globalaccelerator:CreateEndpointGroup", - "globalaccelerator:DescribeEndpointGroup", - "globalaccelerator:DescribeAccelerator", - "globalaccelerator:DescribeListener", - "globalaccelerator:ListAccelerators", - "globalaccelerator:ListListeners" - ] - }, - "delete": { - "permissions": [ - "globalaccelerator:DeleteEndpointGroup", - "globalaccelerator:DescribeEndpointGroup", - "globalaccelerator:DescribeAccelerator" - ] - }, - "list": { - "permissions": [ - "globalaccelerator:ListEndpointGroups" - ] - }, - "read": { - "permissions": [ - "globalaccelerator:DescribeEndpointGroup" - ] - }, - "update": { - "permissions": [ - "globalaccelerator:UpdateEndpointGroup", - "globalaccelerator:DescribeEndpointGroup", - "globalaccelerator:DescribeListener", - "globalaccelerator:DescribeAccelerator" - ] - } - }, - "primaryIdentifier": [ - "/properties/EndpointGroupArn" - ], - "properties": { - "EndpointConfigurations": { - "description": "The list of endpoint objects.", - "items": { - "$ref": "#/definitions/EndpointConfiguration" - }, - "type": "array" - }, - "EndpointGroupArn": { - "description": "The Amazon Resource Name (ARN) of the endpoint group", - "type": "string" - }, - "EndpointGroupRegion": { - "description": "The name of the AWS Region where the endpoint group is located", - "type": "string" - }, - "HealthCheckIntervalSeconds": { - "default": 30, - "description": "The time in seconds between each health check for an endpoint. Must be a value of 10 or 30", - "type": "integer" - }, - "HealthCheckPath": { - "default": "/", - "description": "", - "type": "string" - }, - "HealthCheckPort": { - "default": -1, - "description": "The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.", - "maximum": 65535, - "minimum": -1, - "type": "integer" - }, - "HealthCheckProtocol": { - "default": "TCP", - "description": "The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.", - "enum": [ - "TCP", - "HTTP", - "HTTPS" - ], - "type": "string" - }, - "ListenerArn": { - "description": "The Amazon Resource Name (ARN) of the listener", - "type": "string" - }, - "PortOverrides": { - "items": { - "$ref": "#/definitions/PortOverride" - }, - "type": "array" - }, - "ThresholdCount": { - "default": 3, - "description": "The number of consecutive health checks required to set the state of the endpoint to unhealthy.", - "type": "integer" - }, - "TrafficDialPercentage": { - "default": 100, - "description": "The percentage of traffic to sent to an AWS Region", - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "readOnlyProperties": [ - "/properties/EndpointGroupArn" - ], - "required": [ - "ListenerArn", - "EndpointGroupRegion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", - "tagging": { - "taggable": false - }, - "typeName": "AWS::GlobalAccelerator::EndpointGroup", - "writeOnlyProperties": [ - "/properties/EndpointConfigurations/*/AttachmentArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EndpointGroupRegion", + "/properties/ListenerArn" + ], + "definitions": { + "EndpointConfiguration": { + "additionalProperties": false, + "description": "The configuration for a given endpoint", + "properties": { + "AttachmentArn": { + "description": "Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group.", + "type": "string" + }, + "ClientIPPreservationEnabled": { + "default": true, + "description": "true if client ip should be preserved", + "type": "boolean" + }, + "EndpointId": { + "description": "Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID", + "type": "string" + }, + "Weight": { + "default": 100, + "description": "The weight for the endpoint.", + "maximum": 255, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "EndpointId" + ], + "type": "object" + }, + "Port": { + "description": "A network port number", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "PortOverride": { + "additionalProperties": false, + "description": "listener to endpoint port mapping.", + "properties": { + "EndpointPort": { + "$ref": "#/definitions/Port" + }, + "ListenerPort": { + "$ref": "#/definitions/Port" + } + }, + "required": [ + "ListenerPort", + "EndpointPort" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GlobalAccelerator::EndpointGroup", + "handlers": { + "create": { + "permissions": [ + "globalaccelerator:CreateEndpointGroup", + "globalaccelerator:DescribeEndpointGroup", + "globalaccelerator:DescribeAccelerator", + "globalaccelerator:DescribeListener", + "globalaccelerator:ListAccelerators", + "globalaccelerator:ListListeners" + ] + }, + "delete": { + "permissions": [ + "globalaccelerator:DeleteEndpointGroup", + "globalaccelerator:DescribeEndpointGroup", + "globalaccelerator:DescribeAccelerator" + ] + }, + "list": { + "permissions": [ + "globalaccelerator:ListEndpointGroups" + ] + }, + "read": { + "permissions": [ + "globalaccelerator:DescribeEndpointGroup" + ] + }, + "update": { + "permissions": [ + "globalaccelerator:UpdateEndpointGroup", + "globalaccelerator:DescribeEndpointGroup", + "globalaccelerator:DescribeListener", + "globalaccelerator:DescribeAccelerator" + ] + } + }, + "primaryIdentifier": [ + "/properties/EndpointGroupArn" + ], + "properties": { + "EndpointConfigurations": { + "description": "The list of endpoint objects.", + "items": { + "$ref": "#/definitions/EndpointConfiguration" + }, + "type": "array" + }, + "EndpointGroupArn": { + "description": "The Amazon Resource Name (ARN) of the endpoint group", + "type": "string" + }, + "EndpointGroupRegion": { + "description": "The name of the AWS Region where the endpoint group is located", + "type": "string" + }, + "HealthCheckIntervalSeconds": { + "default": 30, + "description": "The time in seconds between each health check for an endpoint. Must be a value of 10 or 30", + "type": "integer" + }, + "HealthCheckPath": { + "default": "/", + "description": "", + "type": "string" + }, + "HealthCheckPort": { + "default": -1, + "description": "The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.", + "maximum": 65535, + "minimum": -1, + "type": "integer" + }, + "HealthCheckProtocol": { + "default": "TCP", + "description": "The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.", + "enum": [ + "TCP", + "HTTP", + "HTTPS" + ], + "type": "string" + }, + "ListenerArn": { + "description": "The Amazon Resource Name (ARN) of the listener", + "type": "string" + }, + "PortOverrides": { + "items": { + "$ref": "#/definitions/PortOverride" + }, + "type": "array" + }, + "ThresholdCount": { + "default": 3, + "description": "The number of consecutive health checks required to set the state of the endpoint to unhealthy.", + "type": "integer" + }, + "TrafficDialPercentage": { + "default": 100, + "description": "The percentage of traffic to sent to an AWS Region", + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "readOnlyProperties": [ + "/properties/EndpointGroupArn" + ], + "required": [ + "ListenerArn", + "EndpointGroupRegion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "taggable": false + }, + "typeName": "AWS::GlobalAccelerator::EndpointGroup", + "writeOnlyProperties": [ + "/properties/EndpointConfigurations/*/AttachmentArn" + ] +} diff --git a/schema/aws-globalaccelerator-listener.json b/schema/aws-globalaccelerator-listener.json index 224ec63..b9024bb 100644 --- a/schema/aws-globalaccelerator-listener.json +++ b/schema/aws-globalaccelerator-listener.json @@ -1,115 +1,115 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AcceleratorArn" - ], - "definitions": { - "Port": { - "description": "A network port number", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "PortRange": { - "additionalProperties": false, - "description": "A port range to support for connections from clients to your accelerator.", - "properties": { - "FromPort": { - "$ref": "#/definitions/Port" - }, - "ToPort": { - "$ref": "#/definitions/Port" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GlobalAccelerator::Listener", - "handlers": { - "create": { - "permissions": [ - "globalaccelerator:CreateListener", - "globalaccelerator:DescribeListener", - "globalaccelerator:DescribeAccelerator" - ] - }, - "delete": { - "permissions": [ - "globalaccelerator:DescribeListener", - "globalaccelerator:DeleteListener", - "globalaccelerator:DescribeAccelerator" - ] - }, - "list": { - "permissions": [ - "globalaccelerator:ListListeners" - ] - }, - "read": { - "permissions": [ - "globalaccelerator:DescribeListener" - ] - }, - "update": { - "permissions": [ - "globalaccelerator:UpdateListener", - "globalaccelerator:DescribeListener", - "globalaccelerator:DescribeAccelerator" - ] - } - }, - "primaryIdentifier": [ - "/properties/ListenerArn" - ], - "properties": { - "AcceleratorArn": { - "description": "The Amazon Resource Name (ARN) of the accelerator.", - "type": "string" - }, - "ClientAffinity": { - "default": "NONE", - "description": "Client affinity lets you direct all requests from a user to the same endpoint.", - "enum": [ - "NONE", - "SOURCE_IP" - ], - "type": "string" - }, - "ListenerArn": { - "description": "The Amazon Resource Name (ARN) of the listener.", - "type": "string" - }, - "PortRanges": { - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array" - }, - "Protocol": { - "default": "TCP", - "description": "The protocol for the listener.", - "enum": [ - "TCP", - "UDP" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ListenerArn" - ], - "required": [ - "AcceleratorArn", - "PortRanges", - "Protocol" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", - "tagging": { - "taggable": false - }, - "typeName": "AWS::GlobalAccelerator::Listener" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AcceleratorArn" + ], + "definitions": { + "Port": { + "description": "A network port number", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "PortRange": { + "additionalProperties": false, + "description": "A port range to support for connections from clients to your accelerator.", + "properties": { + "FromPort": { + "$ref": "#/definitions/Port" + }, + "ToPort": { + "$ref": "#/definitions/Port" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GlobalAccelerator::Listener", + "handlers": { + "create": { + "permissions": [ + "globalaccelerator:CreateListener", + "globalaccelerator:DescribeListener", + "globalaccelerator:DescribeAccelerator" + ] + }, + "delete": { + "permissions": [ + "globalaccelerator:DescribeListener", + "globalaccelerator:DeleteListener", + "globalaccelerator:DescribeAccelerator" + ] + }, + "list": { + "permissions": [ + "globalaccelerator:ListListeners" + ] + }, + "read": { + "permissions": [ + "globalaccelerator:DescribeListener" + ] + }, + "update": { + "permissions": [ + "globalaccelerator:UpdateListener", + "globalaccelerator:DescribeListener", + "globalaccelerator:DescribeAccelerator" + ] + } + }, + "primaryIdentifier": [ + "/properties/ListenerArn" + ], + "properties": { + "AcceleratorArn": { + "description": "The Amazon Resource Name (ARN) of the accelerator.", + "type": "string" + }, + "ClientAffinity": { + "default": "NONE", + "description": "Client affinity lets you direct all requests from a user to the same endpoint.", + "enum": [ + "NONE", + "SOURCE_IP" + ], + "type": "string" + }, + "ListenerArn": { + "description": "The Amazon Resource Name (ARN) of the listener.", + "type": "string" + }, + "PortRanges": { + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array" + }, + "Protocol": { + "default": "TCP", + "description": "The protocol for the listener.", + "enum": [ + "TCP", + "UDP" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ListenerArn" + ], + "required": [ + "AcceleratorArn", + "PortRanges", + "Protocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "taggable": false + }, + "typeName": "AWS::GlobalAccelerator::Listener" +} diff --git a/schema/aws-glue-classifier.json b/schema/aws-glue-classifier.json index ec23075..8b4e23d 100644 --- a/schema/aws-glue-classifier.json +++ b/schema/aws-glue-classifier.json @@ -1,127 +1,127 @@ -{ - "additionalProperties": false, - "definitions": { - "CsvClassifier": { - "additionalProperties": false, - "properties": { - "AllowSingleColumn": { - "type": "boolean" - }, - "ContainsCustomDatatype": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ContainsHeader": { - "type": "string" - }, - "CustomDatatypeConfigured": { - "type": "boolean" - }, - "Delimiter": { - "type": "string" - }, - "DisableValueTrimming": { - "type": "boolean" - }, - "Header": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "QuoteSymbol": { - "type": "string" - } - }, - "type": "object" - }, - "GrokClassifier": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "CustomPatterns": { - "type": "string" - }, - "GrokPattern": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "GrokPattern", - "Classification" - ], - "type": "object" - }, - "JsonClassifier": { - "additionalProperties": false, - "properties": { - "JsonPath": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "JsonPath" - ], - "type": "object" - }, - "XMLClassifier": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RowTag": { - "type": "string" - } - }, - "required": [ - "RowTag", - "Classification" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Classifier", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CsvClassifier": { - "$ref": "#/definitions/CsvClassifier" - }, - "GrokClassifier": { - "$ref": "#/definitions/GrokClassifier" - }, - "Id": { - "type": "string" - }, - "JsonClassifier": { - "$ref": "#/definitions/JsonClassifier" - }, - "XMLClassifier": { - "$ref": "#/definitions/XMLClassifier" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Glue::Classifier" -} +{ + "additionalProperties": false, + "definitions": { + "CsvClassifier": { + "additionalProperties": false, + "properties": { + "AllowSingleColumn": { + "type": "boolean" + }, + "ContainsCustomDatatype": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ContainsHeader": { + "type": "string" + }, + "CustomDatatypeConfigured": { + "type": "boolean" + }, + "Delimiter": { + "type": "string" + }, + "DisableValueTrimming": { + "type": "boolean" + }, + "Header": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "QuoteSymbol": { + "type": "string" + } + }, + "type": "object" + }, + "GrokClassifier": { + "additionalProperties": false, + "properties": { + "Classification": { + "type": "string" + }, + "CustomPatterns": { + "type": "string" + }, + "GrokPattern": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "GrokPattern", + "Classification" + ], + "type": "object" + }, + "JsonClassifier": { + "additionalProperties": false, + "properties": { + "JsonPath": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "JsonPath" + ], + "type": "object" + }, + "XMLClassifier": { + "additionalProperties": false, + "properties": { + "Classification": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RowTag": { + "type": "string" + } + }, + "required": [ + "RowTag", + "Classification" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Classifier", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CsvClassifier": { + "$ref": "#/definitions/CsvClassifier" + }, + "GrokClassifier": { + "$ref": "#/definitions/GrokClassifier" + }, + "Id": { + "type": "string" + }, + "JsonClassifier": { + "$ref": "#/definitions/JsonClassifier" + }, + "XMLClassifier": { + "$ref": "#/definitions/XMLClassifier" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Glue::Classifier" +} diff --git a/schema/aws-glue-connection.json b/schema/aws-glue-connection.json index 6259c04..ae23f96 100644 --- a/schema/aws-glue-connection.json +++ b/schema/aws-glue-connection.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CatalogId" - ], - "definitions": { - "ConnectionInput": { - "additionalProperties": false, - "properties": { - "ConnectionProperties": { - "type": "object" - }, - "ConnectionType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "MatchCriteria": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "PhysicalConnectionRequirements": { - "$ref": "#/definitions/PhysicalConnectionRequirements" - } - }, - "required": [ - "ConnectionType" - ], - "type": "object" - }, - "PhysicalConnectionRequirements": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "SecurityGroupIdList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Connection", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "ConnectionInput": { - "$ref": "#/definitions/ConnectionInput" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ConnectionInput", - "CatalogId" - ], - "typeName": "AWS::Glue::Connection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CatalogId" + ], + "definitions": { + "ConnectionInput": { + "additionalProperties": false, + "properties": { + "ConnectionProperties": { + "type": "object" + }, + "ConnectionType": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "MatchCriteria": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "PhysicalConnectionRequirements": { + "$ref": "#/definitions/PhysicalConnectionRequirements" + } + }, + "required": [ + "ConnectionType" + ], + "type": "object" + }, + "PhysicalConnectionRequirements": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "SecurityGroupIdList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Connection", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CatalogId": { + "type": "string" + }, + "ConnectionInput": { + "$ref": "#/definitions/ConnectionInput" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ConnectionInput", + "CatalogId" + ], + "typeName": "AWS::Glue::Connection" +} diff --git a/schema/aws-glue-crawler.json b/schema/aws-glue-crawler.json index e7105fb..382358f 100644 --- a/schema/aws-glue-crawler.json +++ b/schema/aws-glue-crawler.json @@ -1,316 +1,316 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "CatalogTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DlqEventQueueArn": { - "type": "string" - }, - "EventQueueArn": { - "type": "string" - }, - "Tables": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DeltaTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "CreateNativeDeltaTable": { - "type": "boolean" - }, - "DeltaTables": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "WriteManifest": { - "type": "boolean" - } - }, - "type": "object" - }, - "DynamoDBTarget": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "IcebergTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "Exclusions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaximumTraversalDepth": { - "type": "integer" - }, - "Paths": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "JdbcTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "EnableAdditionalMetadata": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Exclusions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "LakeFormationConfiguration": { - "additionalProperties": false, - "properties": { - "AccountId": { - "type": "string" - }, - "UseLakeFormationCredentials": { - "type": "boolean" - } - }, - "type": "object" - }, - "MongoDBTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "RecrawlPolicy": { - "additionalProperties": false, - "properties": { - "RecrawlBehavior": { - "type": "string" - } - }, - "type": "object" - }, - "S3Target": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "DlqEventQueueArn": { - "type": "string" - }, - "EventQueueArn": { - "type": "string" - }, - "Exclusions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Path": { - "type": "string" - }, - "SampleSize": { - "type": "integer" - } - }, - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "type": "object" - }, - "SchemaChangePolicy": { - "additionalProperties": false, - "properties": { - "DeleteBehavior": { - "type": "string" - }, - "UpdateBehavior": { - "type": "string" - } - }, - "type": "object" - }, - "Targets": { - "additionalProperties": false, - "properties": { - "CatalogTargets": { - "items": { - "$ref": "#/definitions/CatalogTarget" - }, - "type": "array", - "uniqueItems": false - }, - "DeltaTargets": { - "items": { - "$ref": "#/definitions/DeltaTarget" - }, - "type": "array", - "uniqueItems": false - }, - "DynamoDBTargets": { - "items": { - "$ref": "#/definitions/DynamoDBTarget" - }, - "type": "array", - "uniqueItems": false - }, - "IcebergTargets": { - "items": { - "$ref": "#/definitions/IcebergTarget" - }, - "type": "array", - "uniqueItems": false - }, - "JdbcTargets": { - "items": { - "$ref": "#/definitions/JdbcTarget" - }, - "type": "array", - "uniqueItems": false - }, - "MongoDBTargets": { - "items": { - "$ref": "#/definitions/MongoDBTarget" - }, - "type": "array", - "uniqueItems": false - }, - "S3Targets": { - "items": { - "$ref": "#/definitions/S3Target" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Crawler", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Classifiers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Configuration": { - "type": "string" - }, - "CrawlerSecurityConfiguration": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LakeFormationConfiguration": { - "$ref": "#/definitions/LakeFormationConfiguration" - }, - "Name": { - "type": "string" - }, - "RecrawlPolicy": { - "$ref": "#/definitions/RecrawlPolicy" - }, - "Role": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "SchemaChangePolicy": { - "$ref": "#/definitions/SchemaChangePolicy" - }, - "TablePrefix": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Targets": { - "$ref": "#/definitions/Targets" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Role", - "Targets" - ], - "typeName": "AWS::Glue::Crawler" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "CatalogTarget": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "DlqEventQueueArn": { + "type": "string" + }, + "EventQueueArn": { + "type": "string" + }, + "Tables": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DeltaTarget": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "CreateNativeDeltaTable": { + "type": "boolean" + }, + "DeltaTables": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "WriteManifest": { + "type": "boolean" + } + }, + "type": "object" + }, + "DynamoDBTarget": { + "additionalProperties": false, + "properties": { + "Path": { + "type": "string" + } + }, + "type": "object" + }, + "IcebergTarget": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "Exclusions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaximumTraversalDepth": { + "type": "integer" + }, + "Paths": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "JdbcTarget": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "EnableAdditionalMetadata": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Exclusions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Path": { + "type": "string" + } + }, + "type": "object" + }, + "LakeFormationConfiguration": { + "additionalProperties": false, + "properties": { + "AccountId": { + "type": "string" + }, + "UseLakeFormationCredentials": { + "type": "boolean" + } + }, + "type": "object" + }, + "MongoDBTarget": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "Path": { + "type": "string" + } + }, + "type": "object" + }, + "RecrawlPolicy": { + "additionalProperties": false, + "properties": { + "RecrawlBehavior": { + "type": "string" + } + }, + "type": "object" + }, + "S3Target": { + "additionalProperties": false, + "properties": { + "ConnectionName": { + "type": "string" + }, + "DlqEventQueueArn": { + "type": "string" + }, + "EventQueueArn": { + "type": "string" + }, + "Exclusions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Path": { + "type": "string" + }, + "SampleSize": { + "type": "integer" + } + }, + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "properties": { + "ScheduleExpression": { + "type": "string" + } + }, + "type": "object" + }, + "SchemaChangePolicy": { + "additionalProperties": false, + "properties": { + "DeleteBehavior": { + "type": "string" + }, + "UpdateBehavior": { + "type": "string" + } + }, + "type": "object" + }, + "Targets": { + "additionalProperties": false, + "properties": { + "CatalogTargets": { + "items": { + "$ref": "#/definitions/CatalogTarget" + }, + "type": "array", + "uniqueItems": false + }, + "DeltaTargets": { + "items": { + "$ref": "#/definitions/DeltaTarget" + }, + "type": "array", + "uniqueItems": false + }, + "DynamoDBTargets": { + "items": { + "$ref": "#/definitions/DynamoDBTarget" + }, + "type": "array", + "uniqueItems": false + }, + "IcebergTargets": { + "items": { + "$ref": "#/definitions/IcebergTarget" + }, + "type": "array", + "uniqueItems": false + }, + "JdbcTargets": { + "items": { + "$ref": "#/definitions/JdbcTarget" + }, + "type": "array", + "uniqueItems": false + }, + "MongoDBTargets": { + "items": { + "$ref": "#/definitions/MongoDBTarget" + }, + "type": "array", + "uniqueItems": false + }, + "S3Targets": { + "items": { + "$ref": "#/definitions/S3Target" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Crawler", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Classifiers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Configuration": { + "type": "string" + }, + "CrawlerSecurityConfiguration": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LakeFormationConfiguration": { + "$ref": "#/definitions/LakeFormationConfiguration" + }, + "Name": { + "type": "string" + }, + "RecrawlPolicy": { + "$ref": "#/definitions/RecrawlPolicy" + }, + "Role": { + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "SchemaChangePolicy": { + "$ref": "#/definitions/SchemaChangePolicy" + }, + "TablePrefix": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "Targets": { + "$ref": "#/definitions/Targets" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Role", + "Targets" + ], + "typeName": "AWS::Glue::Crawler" +} diff --git a/schema/aws-glue-customentitytype.json b/schema/aws-glue-customentitytype.json index 3623233..9b4265e 100644 --- a/schema/aws-glue-customentitytype.json +++ b/schema/aws-glue-customentitytype.json @@ -1,32 +1,32 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::Glue::CustomEntityType", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ContextWords": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RegexString": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Glue::CustomEntityType" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::Glue::CustomEntityType", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ContextWords": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RegexString": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Glue::CustomEntityType" +} diff --git a/schema/aws-glue-database.json b/schema/aws-glue-database.json index 82f7306..cacb2e7 100644 --- a/schema/aws-glue-database.json +++ b/schema/aws-glue-database.json @@ -1,114 +1,194 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CatalogId" - ], - "definitions": { - "DataLakePrincipal": { - "additionalProperties": false, - "properties": { - "DataLakePrincipalIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "DatabaseIdentifier": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Region": { - "type": "string" - } - }, - "type": "object" - }, - "DatabaseInput": { - "additionalProperties": false, - "properties": { - "CreateTableDefaultPermissions": { - "items": { - "$ref": "#/definitions/PrincipalPrivileges" - }, - "type": "array", - "uniqueItems": false - }, - "Description": { - "type": "string" - }, - "FederatedDatabase": { - "$ref": "#/definitions/FederatedDatabase" - }, - "LocationUri": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "TargetDatabase": { - "$ref": "#/definitions/DatabaseIdentifier" - } - }, - "type": "object" - }, - "FederatedDatabase": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "Identifier": { - "type": "string" - } - }, - "type": "object" - }, - "PrincipalPrivileges": { - "additionalProperties": false, - "properties": { - "Permissions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Principal": { - "$ref": "#/definitions/DataLakePrincipal" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Database", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseInput": { - "$ref": "#/definitions/DatabaseInput" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DatabaseInput", - "CatalogId" - ], - "typeName": "AWS::Glue::Database" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatabaseName" + ], + "definitions": { + "DataLakePrincipal": { + "additionalProperties": false, + "description": "The AWS Lake Formation principal.", + "properties": { + "DataLakePrincipalIdentifier": { + "description": "An identifier for the AWS Lake Formation principal.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseIdentifier": { + "additionalProperties": false, + "description": "A structure that describes a target database for resource linking.", + "properties": { + "CatalogId": { + "description": "The ID of the Data Catalog in which the database resides.", + "type": "string" + }, + "DatabaseName": { + "description": "The name of the catalog database.", + "type": "string" + }, + "Region": { + "description": "Region of the target database.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseInput": { + "additionalProperties": false, + "description": "The structure used to create or update a database.", + "properties": { + "CreateTableDefaultPermissions": { + "description": "Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PrincipalPrivileges", + "description": "The permissions granted to a principal." + }, + "type": "array", + "uniqueItems": false + }, + "Description": { + "description": "A description of the database.", + "type": "string" + }, + "FederatedDatabase": { + "$ref": "#/definitions/FederatedDatabase", + "description": "A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog." + }, + "LocationUri": { + "description": "The location of the database (for example, an HDFS path).", + "type": "string" + }, + "Name": { + "description": "The name of the database. For hive compatibility, this is folded to lowercase when it is stored.", + "type": "string" + }, + "Parameters": { + "description": "These key-value pairs define parameters and properties of the database.", + "type": "object" + }, + "TargetDatabase": { + "$ref": "#/definitions/DatabaseIdentifier", + "description": "A DatabaseIdentifier structure that describes a target database for resource linking." + } + }, + "type": "object" + }, + "FederatedDatabase": { + "additionalProperties": false, + "description": "A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.", + "properties": { + "ConnectionName": { + "description": "The name of the connection to the external metastore.", + "type": "string" + }, + "Identifier": { + "description": "A unique identifier for the federated database.", + "type": "string" + } + }, + "type": "object" + }, + "PrincipalPrivileges": { + "additionalProperties": false, + "description": "The permissions granted to a principal.", + "properties": { + "Permissions": { + "description": "The permissions that are granted to the principal.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Principal": { + "$ref": "#/definitions/DataLakePrincipal", + "description": "The principal who is granted permissions." + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Database", + "handlers": { + "create": { + "permissions": [ + "glue:CreateDatabase", + "glue:GetDatabase", + "glue:PassConnection", + "glue:CreateConnection", + "lakeformation:ListResources", + "lakeformation:DescribeResource", + "lakeformation:DescribeLakeFormationIdentityCenterConfiguration" + ] + }, + "delete": { + "permissions": [ + "glue:DeleteDatabase", + "glue:GetDatabase", + "glue:DeleteConnection", + "glue:GetConnection", + "lakeformation:ListResources", + "lakeformation:DescribeResource", + "lakeformation:DescribeLakeFormationIdentityCenterConfiguration" + ] + }, + "list": { + "permissions": [ + "glue:GetDatabases", + "lakeformation:ListResources", + "lakeformation:DescribeResource", + "lakeformation:DescribeLakeFormationIdentityCenterConfiguration" + ] + }, + "read": { + "permissions": [ + "glue:GetDatabase", + "glue:GetConnection", + "lakeformation:ListResources", + "lakeformation:DescribeResource", + "lakeformation:DescribeLakeFormationIdentityCenterConfiguration" + ] + }, + "update": { + "permissions": [ + "glue:UpdateDatabase", + "glue:UpdateConnection", + "lakeformation:ListResources", + "lakeformation:DescribeResource", + "lakeformation:DescribeLakeFormationIdentityCenterConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatabaseName" + ], + "properties": { + "CatalogId": { + "description": "The AWS account ID for the account in which to create the catalog object.", + "type": "string" + }, + "DatabaseInput": { + "$ref": "#/definitions/DatabaseInput", + "description": "The metadata for the database." + }, + "DatabaseName": { + "description": "The name of the database. For hive compatibility, this is folded to lowercase when it is store.", + "type": "string" + } + }, + "required": [ + "DatabaseInput", + "CatalogId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Glue::Database" +} diff --git a/schema/aws-glue-datacatalogencryptionsettings.json b/schema/aws-glue-datacatalogencryptionsettings.json index 546c493..8248b58 100644 --- a/schema/aws-glue-datacatalogencryptionsettings.json +++ b/schema/aws-glue-datacatalogencryptionsettings.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CatalogId" - ], - "definitions": { - "ConnectionPasswordEncryption": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "ReturnConnectionPasswordEncrypted": { - "type": "boolean" - } - }, - "type": "object" - }, - "DataCatalogEncryptionSettings": { - "additionalProperties": false, - "properties": { - "ConnectionPasswordEncryption": { - "$ref": "#/definitions/ConnectionPasswordEncryption" - }, - "EncryptionAtRest": { - "$ref": "#/definitions/EncryptionAtRest" - } - }, - "type": "object" - }, - "EncryptionAtRest": { - "additionalProperties": false, - "properties": { - "CatalogEncryptionMode": { - "type": "string" - }, - "CatalogEncryptionServiceRole": { - "type": "string" - }, - "SseAwsKmsKeyId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::DataCatalogEncryptionSettings", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "DataCatalogEncryptionSettings": { - "$ref": "#/definitions/DataCatalogEncryptionSettings" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DataCatalogEncryptionSettings", - "CatalogId" - ], - "typeName": "AWS::Glue::DataCatalogEncryptionSettings" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CatalogId" + ], + "definitions": { + "ConnectionPasswordEncryption": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "type": "string" + }, + "ReturnConnectionPasswordEncrypted": { + "type": "boolean" + } + }, + "type": "object" + }, + "DataCatalogEncryptionSettings": { + "additionalProperties": false, + "properties": { + "ConnectionPasswordEncryption": { + "$ref": "#/definitions/ConnectionPasswordEncryption" + }, + "EncryptionAtRest": { + "$ref": "#/definitions/EncryptionAtRest" + } + }, + "type": "object" + }, + "EncryptionAtRest": { + "additionalProperties": false, + "properties": { + "CatalogEncryptionMode": { + "type": "string" + }, + "CatalogEncryptionServiceRole": { + "type": "string" + }, + "SseAwsKmsKeyId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::DataCatalogEncryptionSettings", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CatalogId": { + "type": "string" + }, + "DataCatalogEncryptionSettings": { + "$ref": "#/definitions/DataCatalogEncryptionSettings" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DataCatalogEncryptionSettings", + "CatalogId" + ], + "typeName": "AWS::Glue::DataCatalogEncryptionSettings" +} diff --git a/schema/aws-glue-dataqualityruleset.json b/schema/aws-glue-dataqualityruleset.json index 20e0495..168932e 100644 --- a/schema/aws-glue-dataqualityruleset.json +++ b/schema/aws-glue-dataqualityruleset.json @@ -1,48 +1,48 @@ -{ - "additionalProperties": false, - "definitions": { - "DataQualityTargetTable": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::DataQualityRuleset", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ClientToken": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Ruleset": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TargetTable": { - "$ref": "#/definitions/DataQualityTargetTable" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Glue::DataQualityRuleset" -} +{ + "additionalProperties": false, + "definitions": { + "DataQualityTargetTable": { + "additionalProperties": false, + "properties": { + "DatabaseName": { + "type": "string" + }, + "TableName": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::DataQualityRuleset", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ClientToken": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Ruleset": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "TargetTable": { + "$ref": "#/definitions/DataQualityTargetTable" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Glue::DataQualityRuleset" +} diff --git a/schema/aws-glue-devendpoint.json b/schema/aws-glue-devendpoint.json index f6f5993..0247d37 100644 --- a/schema/aws-glue-devendpoint.json +++ b/schema/aws-glue-devendpoint.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EndpointName" - ], - "description": "Resource Type definition for AWS::Glue::DevEndpoint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arguments": { - "type": "object" - }, - "EndpointName": { - "type": "string" - }, - "ExtraJarsS3Path": { - "type": "string" - }, - "ExtraPythonLibsS3Path": { - "type": "string" - }, - "GlueVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NumberOfNodes": { - "type": "integer" - }, - "NumberOfWorkers": { - "type": "integer" - }, - "PublicKey": { - "type": "string" - }, - "PublicKeys": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RoleArn": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "WorkerType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RoleArn" - ], - "typeName": "AWS::Glue::DevEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EndpointName" + ], + "description": "Resource Type definition for AWS::Glue::DevEndpoint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arguments": { + "type": "object" + }, + "EndpointName": { + "type": "string" + }, + "ExtraJarsS3Path": { + "type": "string" + }, + "ExtraPythonLibsS3Path": { + "type": "string" + }, + "GlueVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NumberOfNodes": { + "type": "integer" + }, + "NumberOfWorkers": { + "type": "integer" + }, + "PublicKey": { + "type": "string" + }, + "PublicKeys": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RoleArn": { + "type": "string" + }, + "SecurityConfiguration": { + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetId": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "WorkerType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RoleArn" + ], + "typeName": "AWS::Glue::DevEndpoint" +} diff --git a/schema/aws-glue-job.json b/schema/aws-glue-job.json index 89750c7..48b7049 100644 --- a/schema/aws-glue-job.json +++ b/schema/aws-glue-job.json @@ -1,137 +1,140 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ConnectionsList": { - "additionalProperties": false, - "properties": { - "Connections": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "ExecutionProperty": { - "additionalProperties": false, - "properties": { - "MaxConcurrentRuns": { - "type": "number" - } - }, - "type": "object" - }, - "JobCommand": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "PythonVersion": { - "type": "string" - }, - "Runtime": { - "type": "string" - }, - "ScriptLocation": { - "type": "string" - } - }, - "type": "object" - }, - "NotificationProperty": { - "additionalProperties": false, - "properties": { - "NotifyDelayAfter": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Job", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllocatedCapacity": { - "type": "number" - }, - "Command": { - "$ref": "#/definitions/JobCommand" - }, - "Connections": { - "$ref": "#/definitions/ConnectionsList" - }, - "DefaultArguments": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "ExecutionClass": { - "type": "string" - }, - "ExecutionProperty": { - "$ref": "#/definitions/ExecutionProperty" - }, - "GlueVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LogUri": { - "type": "string" - }, - "MaintenanceWindow": { - "type": "string" - }, - "MaxCapacity": { - "type": "number" - }, - "MaxRetries": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "NonOverridableArguments": { - "type": "object" - }, - "NotificationProperty": { - "$ref": "#/definitions/NotificationProperty" - }, - "NumberOfWorkers": { - "type": "integer" - }, - "Role": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "type": "integer" - }, - "WorkerType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Role", - "Command" - ], - "typeName": "AWS::Glue::Job" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ConnectionsList": { + "additionalProperties": false, + "properties": { + "Connections": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "ExecutionProperty": { + "additionalProperties": false, + "properties": { + "MaxConcurrentRuns": { + "type": "number" + } + }, + "type": "object" + }, + "JobCommand": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "PythonVersion": { + "type": "string" + }, + "Runtime": { + "type": "string" + }, + "ScriptLocation": { + "type": "string" + } + }, + "type": "object" + }, + "NotificationProperty": { + "additionalProperties": false, + "properties": { + "NotifyDelayAfter": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Job", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllocatedCapacity": { + "type": "number" + }, + "Command": { + "$ref": "#/definitions/JobCommand" + }, + "Connections": { + "$ref": "#/definitions/ConnectionsList" + }, + "DefaultArguments": { + "type": "object" + }, + "Description": { + "type": "string" + }, + "ExecutionClass": { + "type": "string" + }, + "ExecutionProperty": { + "$ref": "#/definitions/ExecutionProperty" + }, + "GlueVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "JobMode": { + "type": "string" + }, + "LogUri": { + "type": "string" + }, + "MaintenanceWindow": { + "type": "string" + }, + "MaxCapacity": { + "type": "number" + }, + "MaxRetries": { + "type": "number" + }, + "Name": { + "type": "string" + }, + "NonOverridableArguments": { + "type": "object" + }, + "NotificationProperty": { + "$ref": "#/definitions/NotificationProperty" + }, + "NumberOfWorkers": { + "type": "integer" + }, + "Role": { + "type": "string" + }, + "SecurityConfiguration": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "Timeout": { + "type": "integer" + }, + "WorkerType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Role", + "Command" + ], + "typeName": "AWS::Glue::Job" +} diff --git a/schema/aws-glue-mltransform.json b/schema/aws-glue-mltransform.json index 01c9f5c..a50926d 100644 --- a/schema/aws-glue-mltransform.json +++ b/schema/aws-glue-mltransform.json @@ -1,163 +1,163 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InputRecordTables" - ], - "definitions": { - "FindMatchesParameters": { - "additionalProperties": false, - "properties": { - "AccuracyCostTradeoff": { - "type": "number" - }, - "EnforceProvidedLabels": { - "type": "boolean" - }, - "PrecisionRecallTradeoff": { - "type": "number" - }, - "PrimaryKeyColumnName": { - "type": "string" - } - }, - "required": [ - "PrimaryKeyColumnName" - ], - "type": "object" - }, - "GlueTables": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "ConnectionName": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "TableName", - "DatabaseName" - ], - "type": "object" - }, - "InputRecordTables": { - "additionalProperties": false, - "properties": { - "GlueTables": { - "items": { - "$ref": "#/definitions/GlueTables" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "MLUserDataEncryption": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MLUserDataEncryptionMode": { - "type": "string" - } - }, - "required": [ - "MLUserDataEncryptionMode" - ], - "type": "object" - }, - "TransformEncryption": { - "additionalProperties": false, - "properties": { - "MLUserDataEncryption": { - "$ref": "#/definitions/MLUserDataEncryption" - }, - "TaskRunSecurityConfigurationName": { - "type": "string" - } - }, - "type": "object" - }, - "TransformParameters": { - "additionalProperties": false, - "properties": { - "FindMatchesParameters": { - "$ref": "#/definitions/FindMatchesParameters" - }, - "TransformType": { - "type": "string" - } - }, - "required": [ - "TransformType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::MLTransform", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "GlueVersion": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InputRecordTables": { - "$ref": "#/definitions/InputRecordTables" - }, - "MaxCapacity": { - "type": "number" - }, - "MaxRetries": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "NumberOfWorkers": { - "type": "integer" - }, - "Role": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "type": "integer" - }, - "TransformEncryption": { - "$ref": "#/definitions/TransformEncryption" - }, - "TransformParameters": { - "$ref": "#/definitions/TransformParameters" - }, - "WorkerType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Role", - "TransformParameters", - "InputRecordTables" - ], - "typeName": "AWS::Glue::MLTransform" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InputRecordTables" + ], + "definitions": { + "FindMatchesParameters": { + "additionalProperties": false, + "properties": { + "AccuracyCostTradeoff": { + "type": "number" + }, + "EnforceProvidedLabels": { + "type": "boolean" + }, + "PrecisionRecallTradeoff": { + "type": "number" + }, + "PrimaryKeyColumnName": { + "type": "string" + } + }, + "required": [ + "PrimaryKeyColumnName" + ], + "type": "object" + }, + "GlueTables": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "ConnectionName": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "TableName": { + "type": "string" + } + }, + "required": [ + "TableName", + "DatabaseName" + ], + "type": "object" + }, + "InputRecordTables": { + "additionalProperties": false, + "properties": { + "GlueTables": { + "items": { + "$ref": "#/definitions/GlueTables" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "MLUserDataEncryption": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "type": "string" + }, + "MLUserDataEncryptionMode": { + "type": "string" + } + }, + "required": [ + "MLUserDataEncryptionMode" + ], + "type": "object" + }, + "TransformEncryption": { + "additionalProperties": false, + "properties": { + "MLUserDataEncryption": { + "$ref": "#/definitions/MLUserDataEncryption" + }, + "TaskRunSecurityConfigurationName": { + "type": "string" + } + }, + "type": "object" + }, + "TransformParameters": { + "additionalProperties": false, + "properties": { + "FindMatchesParameters": { + "$ref": "#/definitions/FindMatchesParameters" + }, + "TransformType": { + "type": "string" + } + }, + "required": [ + "TransformType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::MLTransform", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "GlueVersion": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InputRecordTables": { + "$ref": "#/definitions/InputRecordTables" + }, + "MaxCapacity": { + "type": "number" + }, + "MaxRetries": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "NumberOfWorkers": { + "type": "integer" + }, + "Role": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "Timeout": { + "type": "integer" + }, + "TransformEncryption": { + "$ref": "#/definitions/TransformEncryption" + }, + "TransformParameters": { + "$ref": "#/definitions/TransformParameters" + }, + "WorkerType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Role", + "TransformParameters", + "InputRecordTables" + ], + "typeName": "AWS::Glue::MLTransform" +} diff --git a/schema/aws-glue-partition.json b/schema/aws-glue-partition.json index 9832267..d172e39 100644 --- a/schema/aws-glue-partition.json +++ b/schema/aws-glue-partition.json @@ -1,221 +1,221 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TableName", - "/properties/DatabaseName", - "/properties/CatalogId" - ], - "definitions": { - "Column": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Order": { - "additionalProperties": false, - "properties": { - "Column": { - "type": "string" - }, - "SortOrder": { - "type": "integer" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "PartitionInput": { - "additionalProperties": false, - "properties": { - "Parameters": { - "type": "object" - }, - "StorageDescriptor": { - "$ref": "#/definitions/StorageDescriptor" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Values" - ], - "type": "object" - }, - "SchemaId": { - "additionalProperties": false, - "properties": { - "RegistryName": { - "type": "string" - }, - "SchemaArn": { - "type": "string" - }, - "SchemaName": { - "type": "string" - } - }, - "type": "object" - }, - "SchemaReference": { - "additionalProperties": false, - "properties": { - "SchemaId": { - "$ref": "#/definitions/SchemaId" - }, - "SchemaVersionId": { - "type": "string" - }, - "SchemaVersionNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "SerdeInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SerializationLibrary": { - "type": "string" - } - }, - "type": "object" - }, - "SkewedInfo": { - "additionalProperties": false, - "properties": { - "SkewedColumnNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SkewedColumnValueLocationMaps": { - "type": "object" - }, - "SkewedColumnValues": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "StorageDescriptor": { - "additionalProperties": false, - "properties": { - "BucketColumns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Columns": { - "items": { - "$ref": "#/definitions/Column" - }, - "type": "array", - "uniqueItems": false - }, - "Compressed": { - "type": "boolean" - }, - "InputFormat": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "NumberOfBuckets": { - "type": "integer" - }, - "OutputFormat": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SchemaReference": { - "$ref": "#/definitions/SchemaReference" - }, - "SerdeInfo": { - "$ref": "#/definitions/SerdeInfo" - }, - "SkewedInfo": { - "$ref": "#/definitions/SkewedInfo" - }, - "SortColumns": { - "items": { - "$ref": "#/definitions/Order" - }, - "type": "array", - "uniqueItems": false - }, - "StoredAsSubDirectories": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Partition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PartitionInput": { - "$ref": "#/definitions/PartitionInput" - }, - "TableName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TableName", - "DatabaseName", - "CatalogId", - "PartitionInput" - ], - "typeName": "AWS::Glue::Partition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TableName", + "/properties/DatabaseName", + "/properties/CatalogId" + ], + "definitions": { + "Column": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Order": { + "additionalProperties": false, + "properties": { + "Column": { + "type": "string" + }, + "SortOrder": { + "type": "integer" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "PartitionInput": { + "additionalProperties": false, + "properties": { + "Parameters": { + "type": "object" + }, + "StorageDescriptor": { + "$ref": "#/definitions/StorageDescriptor" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Values" + ], + "type": "object" + }, + "SchemaId": { + "additionalProperties": false, + "properties": { + "RegistryName": { + "type": "string" + }, + "SchemaArn": { + "type": "string" + }, + "SchemaName": { + "type": "string" + } + }, + "type": "object" + }, + "SchemaReference": { + "additionalProperties": false, + "properties": { + "SchemaId": { + "$ref": "#/definitions/SchemaId" + }, + "SchemaVersionId": { + "type": "string" + }, + "SchemaVersionNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "SerdeInfo": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "SerializationLibrary": { + "type": "string" + } + }, + "type": "object" + }, + "SkewedInfo": { + "additionalProperties": false, + "properties": { + "SkewedColumnNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SkewedColumnValueLocationMaps": { + "type": "object" + }, + "SkewedColumnValues": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "StorageDescriptor": { + "additionalProperties": false, + "properties": { + "BucketColumns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Columns": { + "items": { + "$ref": "#/definitions/Column" + }, + "type": "array", + "uniqueItems": false + }, + "Compressed": { + "type": "boolean" + }, + "InputFormat": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "NumberOfBuckets": { + "type": "integer" + }, + "OutputFormat": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "SchemaReference": { + "$ref": "#/definitions/SchemaReference" + }, + "SerdeInfo": { + "$ref": "#/definitions/SerdeInfo" + }, + "SkewedInfo": { + "$ref": "#/definitions/SkewedInfo" + }, + "SortColumns": { + "items": { + "$ref": "#/definitions/Order" + }, + "type": "array", + "uniqueItems": false + }, + "StoredAsSubDirectories": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Partition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PartitionInput": { + "$ref": "#/definitions/PartitionInput" + }, + "TableName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TableName", + "DatabaseName", + "CatalogId", + "PartitionInput" + ], + "typeName": "AWS::Glue::Partition" +} diff --git a/schema/aws-glue-registry.json b/schema/aws-glue-registry.json index e6bb866..3784b28 100644 --- a/schema/aws-glue-registry.json +++ b/schema/aws-glue-registry.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A key to identify the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Corresponding tag value for the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "This resource creates a Registry for authoring schemas as part of Glue Schema Registry.", - "handlers": { - "create": { - "permissions": [ - "glue:CreateRegistry", - "glue:GetRegistry", - "glue:GetTags" - ] - }, - "delete": { - "permissions": [ - "glue:GetRegistry", - "glue:DeleteRegistry" - ] - }, - "list": { - "permissions": [ - "glue:ListRegistries" - ] - }, - "read": { - "permissions": [ - "glue:GetRegistry", - "glue:GetTags" - ] - }, - "update": { - "permissions": [ - "glue:UpdateRegistry", - "glue:GetRegistry", - "glue:TagResource", - "glue:UntagResource", - "glue:GetTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name for the created Registry.", - "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", - "type": "string" - }, - "Description": { - "description": "A description of the registry. If description is not provided, there will not be any default value for this.", - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "List of tags to tag the Registry", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", - "typeName": "AWS::Glue::Registry" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "This resource creates a Registry for authoring schemas as part of Glue Schema Registry.", + "handlers": { + "create": { + "permissions": [ + "glue:CreateRegistry", + "glue:GetRegistry", + "glue:GetTags" + ] + }, + "delete": { + "permissions": [ + "glue:GetRegistry", + "glue:DeleteRegistry" + ] + }, + "list": { + "permissions": [ + "glue:ListRegistries" + ] + }, + "read": { + "permissions": [ + "glue:GetRegistry", + "glue:GetTags" + ] + }, + "update": { + "permissions": [ + "glue:UpdateRegistry", + "glue:GetRegistry", + "glue:TagResource", + "glue:UntagResource", + "glue:GetTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name for the created Registry.", + "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", + "type": "string" + }, + "Description": { + "description": "A description of the registry. If description is not provided, there will not be any default value for this.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "List of tags to tag the Registry", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "typeName": "AWS::Glue::Registry" +} diff --git a/schema/aws-glue-schema.json b/schema/aws-glue-schema.json index 09be097..efacdaa 100644 --- a/schema/aws-glue-schema.json +++ b/schema/aws-glue-schema.json @@ -1,190 +1,190 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Registry", - "/properties/Name", - "/properties/DataFormat", - "/properties/SchemaDefinition" - ], - "definitions": { - "Registry": { - "additionalProperties": false, - "description": "Identifier for the registry which the schema is part of.", - "properties": { - "Arn": { - "description": "Amazon Resource Name for the Registry.", - "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", - "type": "string" - }, - "Name": { - "description": "Name of the registry in which the schema will be created.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SchemaVersion": { - "additionalProperties": false, - "description": "Specify checkpoint version for update. This is only required to update the Compatibility.", - "properties": { - "IsLatest": { - "description": "Indicates if the latest version needs to be updated.", - "type": "boolean" - }, - "VersionNumber": { - "description": "Indicates the version number in the schema to update.", - "maximum": 100000, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A key to identify the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Corresponding tag value for the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "This resource represents a schema of Glue Schema Registry.", - "handlers": { - "create": { - "permissions": [ - "glue:CreateSchema" - ] - }, - "delete": { - "permissions": [ - "glue:DeleteSchema", - "glue:GetSchema" - ] - }, - "list": { - "permissions": [ - "glue:ListSchemas" - ] - }, - "read": { - "permissions": [ - "glue:GetSchemaVersion", - "glue:GetSchema", - "glue:GetTags" - ] - }, - "update": { - "permissions": [ - "glue:UpdateSchema", - "glue:GetSchemaVersion", - "glue:GetSchema", - "glue:GetTags", - "glue:TagResource", - "glue:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name for the Schema.", - "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", - "type": "string" - }, - "CheckpointVersion": { - "$ref": "#/definitions/SchemaVersion" - }, - "Compatibility": { - "description": "Compatibility setting for the schema.", - "enum": [ - "NONE", - "DISABLED", - "BACKWARD", - "BACKWARD_ALL", - "FORWARD", - "FORWARD_ALL", - "FULL", - "FULL_ALL" - ], - "type": "string" - }, - "DataFormat": { - "description": "Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'", - "enum": [ - "AVRO", - "JSON", - "PROTOBUF" - ], - "type": "string" - }, - "Description": { - "description": "A description of the schema. If description is not provided, there will not be any default value for this.", - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "InitialSchemaVersionId": { - "description": "Represents the version ID associated with the initial schema version.", - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", - "type": "string" - }, - "Name": { - "description": "Name of the schema.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Registry": { - "$ref": "#/definitions/Registry" - }, - "SchemaDefinition": { - "description": "Definition for the initial schema version in plain-text.", - "maxLength": 170000, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "List of tags to tag the schema", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/InitialSchemaVersionId" - ], - "required": [ - "Name", - "DataFormat", - "SchemaDefinition", - "Compatibility" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", - "typeName": "AWS::Glue::Schema", - "writeOnlyProperties": [ - "/properties/SchemaDefinition" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Registry", + "/properties/Name", + "/properties/DataFormat", + "/properties/SchemaDefinition" + ], + "definitions": { + "Registry": { + "additionalProperties": false, + "description": "Identifier for the registry which the schema is part of.", + "properties": { + "Arn": { + "description": "Amazon Resource Name for the Registry.", + "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", + "type": "string" + }, + "Name": { + "description": "Name of the registry in which the schema will be created.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SchemaVersion": { + "additionalProperties": false, + "description": "Specify checkpoint version for update. This is only required to update the Compatibility.", + "properties": { + "IsLatest": { + "description": "Indicates if the latest version needs to be updated.", + "type": "boolean" + }, + "VersionNumber": { + "description": "Indicates the version number in the schema to update.", + "maximum": 100000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "This resource represents a schema of Glue Schema Registry.", + "handlers": { + "create": { + "permissions": [ + "glue:CreateSchema" + ] + }, + "delete": { + "permissions": [ + "glue:DeleteSchema", + "glue:GetSchema" + ] + }, + "list": { + "permissions": [ + "glue:ListSchemas" + ] + }, + "read": { + "permissions": [ + "glue:GetSchemaVersion", + "glue:GetSchema", + "glue:GetTags" + ] + }, + "update": { + "permissions": [ + "glue:UpdateSchema", + "glue:GetSchemaVersion", + "glue:GetSchema", + "glue:GetTags", + "glue:TagResource", + "glue:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name for the Schema.", + "pattern": "arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*", + "type": "string" + }, + "CheckpointVersion": { + "$ref": "#/definitions/SchemaVersion" + }, + "Compatibility": { + "description": "Compatibility setting for the schema.", + "enum": [ + "NONE", + "DISABLED", + "BACKWARD", + "BACKWARD_ALL", + "FORWARD", + "FORWARD_ALL", + "FULL", + "FULL_ALL" + ], + "type": "string" + }, + "DataFormat": { + "description": "Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'", + "enum": [ + "AVRO", + "JSON", + "PROTOBUF" + ], + "type": "string" + }, + "Description": { + "description": "A description of the schema. If description is not provided, there will not be any default value for this.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "InitialSchemaVersionId": { + "description": "Represents the version ID associated with the initial schema version.", + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", + "type": "string" + }, + "Name": { + "description": "Name of the schema.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Registry": { + "$ref": "#/definitions/Registry" + }, + "SchemaDefinition": { + "description": "Definition for the initial schema version in plain-text.", + "maxLength": 170000, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "List of tags to tag the schema", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/InitialSchemaVersionId" + ], + "required": [ + "Name", + "DataFormat", + "SchemaDefinition", + "Compatibility" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "typeName": "AWS::Glue::Schema", + "writeOnlyProperties": [ + "/properties/SchemaDefinition" + ] +} diff --git a/schema/aws-glue-schemaversion.json b/schema/aws-glue-schemaversion.json index cbf9c3d..6ef70f8 100644 --- a/schema/aws-glue-schemaversion.json +++ b/schema/aws-glue-schemaversion.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Schema", - "/properties/SchemaDefinition" - ], - "definitions": { - "Schema": { - "additionalProperties": false, - "description": "Identifier for the schema where the schema version will be created.", - "properties": { - "RegistryName": { - "description": "Name of the registry to identify where the Schema is located.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "SchemaArn": { - "description": "Amazon Resource Name for the Schema. This attribute can be used to uniquely represent the Schema.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):glue:.*", - "type": "string" - }, - "SchemaName": { - "description": "Name of the schema. This parameter requires RegistryName to be provided.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "This resource represents an individual schema version of a schema defined in Glue Schema Registry.", - "handlers": { - "create": { - "permissions": [ - "glue:RegisterSchemaVersion", - "glue:GetSchemaVersion", - "glue:GetSchemaByDefinition" - ] - }, - "delete": { - "permissions": [ - "glue:DeleteSchemaVersions", - "glue:GetSchemaVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Schema": { - "$ref": "resource-schema.json#/properties/Schema" - } - }, - "required": [ - "Schema" - ] - }, - "permissions": [ - "glue:ListSchemaVersions" - ] - }, - "read": { - "permissions": [ - "glue:GetSchemaVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/VersionId" - ], - "properties": { - "Schema": { - "$ref": "#/definitions/Schema" - }, - "SchemaDefinition": { - "description": "Complete definition of the schema in plain-text.", - "maxLength": 170000, - "minLength": 1, - "type": "string" - }, - "VersionId": { - "description": "Represents the version ID associated with the schema version.", - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VersionId" - ], - "required": [ - "Schema", - "SchemaDefinition" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", - "typeName": "AWS::Glue::SchemaVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Schema", + "/properties/SchemaDefinition" + ], + "definitions": { + "Schema": { + "additionalProperties": false, + "description": "Identifier for the schema where the schema version will be created.", + "properties": { + "RegistryName": { + "description": "Name of the registry to identify where the Schema is located.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SchemaArn": { + "description": "Amazon Resource Name for the Schema. This attribute can be used to uniquely represent the Schema.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):glue:.*", + "type": "string" + }, + "SchemaName": { + "description": "Name of the schema. This parameter requires RegistryName to be provided.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "This resource represents an individual schema version of a schema defined in Glue Schema Registry.", + "handlers": { + "create": { + "permissions": [ + "glue:RegisterSchemaVersion", + "glue:GetSchemaVersion", + "glue:GetSchemaByDefinition" + ] + }, + "delete": { + "permissions": [ + "glue:DeleteSchemaVersions", + "glue:GetSchemaVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Schema": { + "$ref": "resource-schema.json#/properties/Schema" + } + }, + "required": [ + "Schema" + ] + }, + "permissions": [ + "glue:ListSchemaVersions" + ] + }, + "read": { + "permissions": [ + "glue:GetSchemaVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/VersionId" + ], + "properties": { + "Schema": { + "$ref": "#/definitions/Schema" + }, + "SchemaDefinition": { + "description": "Complete definition of the schema in plain-text.", + "maxLength": 170000, + "minLength": 1, + "type": "string" + }, + "VersionId": { + "description": "Represents the version ID associated with the schema version.", + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VersionId" + ], + "required": [ + "Schema", + "SchemaDefinition" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "typeName": "AWS::Glue::SchemaVersion" +} diff --git a/schema/aws-glue-schemaversionmetadata.json b/schema/aws-glue-schemaversionmetadata.json index 27b94cb..e56fadb 100644 --- a/schema/aws-glue-schemaversionmetadata.json +++ b/schema/aws-glue-schemaversionmetadata.json @@ -1,72 +1,72 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SchemaVersionId", - "/properties/Key", - "/properties/Value" - ], - "description": "This resource adds Key-Value metadata to a Schema version of Glue Schema Registry.", - "handlers": { - "create": { - "permissions": [ - "glue:putSchemaVersionMetadata" - ] - }, - "delete": { - "permissions": [ - "glue:removeSchemaVersionMetadata" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "SchemaVersionId": { - "$ref": "resource-schema.json#/properties/SchemaVersionId" - } - }, - "required": [ - "SchemaVersionId" - ] - }, - "permissions": [ - "glue:querySchemaVersionMetadata" - ] - }, - "read": { - "permissions": [ - "glue:querySchemaVersionMetadata" - ] - } - }, - "primaryIdentifier": [ - "/properties/SchemaVersionId", - "/properties/Key", - "/properties/Value" - ], - "properties": { - "Key": { - "description": "Metadata key", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SchemaVersionId": { - "description": "Represents the version ID associated with the schema version.", - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", - "type": "string" - }, - "Value": { - "description": "Metadata value", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "SchemaVersionId", - "Key", - "Value" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", - "typeName": "AWS::Glue::SchemaVersionMetadata" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SchemaVersionId", + "/properties/Key", + "/properties/Value" + ], + "description": "This resource adds Key-Value metadata to a Schema version of Glue Schema Registry.", + "handlers": { + "create": { + "permissions": [ + "glue:putSchemaVersionMetadata" + ] + }, + "delete": { + "permissions": [ + "glue:removeSchemaVersionMetadata" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "SchemaVersionId": { + "$ref": "resource-schema.json#/properties/SchemaVersionId" + } + }, + "required": [ + "SchemaVersionId" + ] + }, + "permissions": [ + "glue:querySchemaVersionMetadata" + ] + }, + "read": { + "permissions": [ + "glue:querySchemaVersionMetadata" + ] + } + }, + "primaryIdentifier": [ + "/properties/SchemaVersionId", + "/properties/Key", + "/properties/Value" + ], + "properties": { + "Key": { + "description": "Metadata key", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SchemaVersionId": { + "description": "Represents the version ID associated with the schema version.", + "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}", + "type": "string" + }, + "Value": { + "description": "Metadata value", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "SchemaVersionId", + "Key", + "Value" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "typeName": "AWS::Glue::SchemaVersionMetadata" +} diff --git a/schema/aws-glue-securityconfiguration.json b/schema/aws-glue-securityconfiguration.json index 9ae0db1..26a71b6 100644 --- a/schema/aws-glue-securityconfiguration.json +++ b/schema/aws-glue-securityconfiguration.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "CloudWatchEncryption": { - "additionalProperties": false, - "properties": { - "CloudWatchEncryptionMode": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - } - }, - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchEncryption": { - "$ref": "#/definitions/CloudWatchEncryption" - }, - "JobBookmarksEncryption": { - "$ref": "#/definitions/JobBookmarksEncryption" - }, - "S3Encryptions": { - "$ref": "#/definitions/S3Encryptions" - } - }, - "type": "object" - }, - "JobBookmarksEncryption": { - "additionalProperties": false, - "properties": { - "JobBookmarksEncryptionMode": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - } - }, - "type": "object" - }, - "S3Encryptions": { - "additionalProperties": false, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::SecurityConfiguration", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "EncryptionConfiguration", - "Name" - ], - "typeName": "AWS::Glue::SecurityConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "CloudWatchEncryption": { + "additionalProperties": false, + "properties": { + "CloudWatchEncryptionMode": { + "type": "string" + }, + "KmsKeyArn": { + "type": "string" + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "CloudWatchEncryption": { + "$ref": "#/definitions/CloudWatchEncryption" + }, + "JobBookmarksEncryption": { + "$ref": "#/definitions/JobBookmarksEncryption" + }, + "S3Encryptions": { + "$ref": "#/definitions/S3Encryptions" + } + }, + "type": "object" + }, + "JobBookmarksEncryption": { + "additionalProperties": false, + "properties": { + "JobBookmarksEncryptionMode": { + "type": "string" + }, + "KmsKeyArn": { + "type": "string" + } + }, + "type": "object" + }, + "S3Encryptions": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::SecurityConfiguration", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "EncryptionConfiguration", + "Name" + ], + "typeName": "AWS::Glue::SecurityConfiguration" +} diff --git a/schema/aws-glue-table.json b/schema/aws-glue-table.json index a9804cb..2d1d07a 100644 --- a/schema/aws-glue-table.json +++ b/schema/aws-glue-table.json @@ -1,284 +1,284 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatabaseName", - "/properties/CatalogId" - ], - "definitions": { - "Column": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "IcebergInput": { - "additionalProperties": false, - "properties": { - "MetadataOperation": { - "$ref": "#/definitions/MetadataOperation" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "MetadataOperation": { - "additionalProperties": false, - "type": "object" - }, - "OpenTableFormatInput": { - "additionalProperties": false, - "properties": { - "IcebergInput": { - "$ref": "#/definitions/IcebergInput" - } - }, - "type": "object" - }, - "Order": { - "additionalProperties": false, - "properties": { - "Column": { - "type": "string" - }, - "SortOrder": { - "type": "integer" - } - }, - "required": [ - "Column", - "SortOrder" - ], - "type": "object" - }, - "SchemaId": { - "additionalProperties": false, - "properties": { - "RegistryName": { - "type": "string" - }, - "SchemaArn": { - "type": "string" - }, - "SchemaName": { - "type": "string" - } - }, - "type": "object" - }, - "SchemaReference": { - "additionalProperties": false, - "properties": { - "SchemaId": { - "$ref": "#/definitions/SchemaId" - }, - "SchemaVersionId": { - "type": "string" - }, - "SchemaVersionNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "SerdeInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SerializationLibrary": { - "type": "string" - } - }, - "type": "object" - }, - "SkewedInfo": { - "additionalProperties": false, - "properties": { - "SkewedColumnNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SkewedColumnValueLocationMaps": { - "type": "object" - }, - "SkewedColumnValues": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "StorageDescriptor": { - "additionalProperties": false, - "properties": { - "BucketColumns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Columns": { - "items": { - "$ref": "#/definitions/Column" - }, - "type": "array", - "uniqueItems": false - }, - "Compressed": { - "type": "boolean" - }, - "InputFormat": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "NumberOfBuckets": { - "type": "integer" - }, - "OutputFormat": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SchemaReference": { - "$ref": "#/definitions/SchemaReference" - }, - "SerdeInfo": { - "$ref": "#/definitions/SerdeInfo" - }, - "SkewedInfo": { - "$ref": "#/definitions/SkewedInfo" - }, - "SortColumns": { - "items": { - "$ref": "#/definitions/Order" - }, - "type": "array", - "uniqueItems": false - }, - "StoredAsSubDirectories": { - "type": "boolean" - } - }, - "type": "object" - }, - "TableIdentifier": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Region": { - "type": "string" - } - }, - "type": "object" - }, - "TableInput": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "PartitionKeys": { - "items": { - "$ref": "#/definitions/Column" - }, - "type": "array", - "uniqueItems": false - }, - "Retention": { - "type": "integer" - }, - "StorageDescriptor": { - "$ref": "#/definitions/StorageDescriptor" - }, - "TableType": { - "type": "string" - }, - "TargetTable": { - "$ref": "#/definitions/TableIdentifier" - }, - "ViewExpandedText": { - "type": "string" - }, - "ViewOriginalText": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Table", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "OpenTableFormatInput": { - "$ref": "#/definitions/OpenTableFormatInput" - }, - "TableInput": { - "$ref": "#/definitions/TableInput" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TableInput", - "DatabaseName", - "CatalogId" - ], - "typeName": "AWS::Glue::Table" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatabaseName", + "/properties/CatalogId" + ], + "definitions": { + "Column": { + "additionalProperties": false, + "properties": { + "Comment": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "IcebergInput": { + "additionalProperties": false, + "properties": { + "MetadataOperation": { + "$ref": "#/definitions/MetadataOperation" + }, + "Version": { + "type": "string" + } + }, + "type": "object" + }, + "MetadataOperation": { + "additionalProperties": false, + "type": "object" + }, + "OpenTableFormatInput": { + "additionalProperties": false, + "properties": { + "IcebergInput": { + "$ref": "#/definitions/IcebergInput" + } + }, + "type": "object" + }, + "Order": { + "additionalProperties": false, + "properties": { + "Column": { + "type": "string" + }, + "SortOrder": { + "type": "integer" + } + }, + "required": [ + "Column", + "SortOrder" + ], + "type": "object" + }, + "SchemaId": { + "additionalProperties": false, + "properties": { + "RegistryName": { + "type": "string" + }, + "SchemaArn": { + "type": "string" + }, + "SchemaName": { + "type": "string" + } + }, + "type": "object" + }, + "SchemaReference": { + "additionalProperties": false, + "properties": { + "SchemaId": { + "$ref": "#/definitions/SchemaId" + }, + "SchemaVersionId": { + "type": "string" + }, + "SchemaVersionNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "SerdeInfo": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "SerializationLibrary": { + "type": "string" + } + }, + "type": "object" + }, + "SkewedInfo": { + "additionalProperties": false, + "properties": { + "SkewedColumnNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SkewedColumnValueLocationMaps": { + "type": "object" + }, + "SkewedColumnValues": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "StorageDescriptor": { + "additionalProperties": false, + "properties": { + "BucketColumns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Columns": { + "items": { + "$ref": "#/definitions/Column" + }, + "type": "array", + "uniqueItems": false + }, + "Compressed": { + "type": "boolean" + }, + "InputFormat": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "NumberOfBuckets": { + "type": "integer" + }, + "OutputFormat": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "SchemaReference": { + "$ref": "#/definitions/SchemaReference" + }, + "SerdeInfo": { + "$ref": "#/definitions/SerdeInfo" + }, + "SkewedInfo": { + "$ref": "#/definitions/SkewedInfo" + }, + "SortColumns": { + "items": { + "$ref": "#/definitions/Order" + }, + "type": "array", + "uniqueItems": false + }, + "StoredAsSubDirectories": { + "type": "boolean" + } + }, + "type": "object" + }, + "TableIdentifier": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Region": { + "type": "string" + } + }, + "type": "object" + }, + "TableInput": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Owner": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "PartitionKeys": { + "items": { + "$ref": "#/definitions/Column" + }, + "type": "array", + "uniqueItems": false + }, + "Retention": { + "type": "integer" + }, + "StorageDescriptor": { + "$ref": "#/definitions/StorageDescriptor" + }, + "TableType": { + "type": "string" + }, + "TargetTable": { + "$ref": "#/definitions/TableIdentifier" + }, + "ViewExpandedText": { + "type": "string" + }, + "ViewOriginalText": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Table", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "OpenTableFormatInput": { + "$ref": "#/definitions/OpenTableFormatInput" + }, + "TableInput": { + "$ref": "#/definitions/TableInput" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TableInput", + "DatabaseName", + "CatalogId" + ], + "typeName": "AWS::Glue::Table" +} diff --git a/schema/aws-glue-tableoptimizer.json b/schema/aws-glue-tableoptimizer.json index b6d5685..ea43a67 100644 --- a/schema/aws-glue-tableoptimizer.json +++ b/schema/aws-glue-tableoptimizer.json @@ -1,62 +1,62 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TableName", - "/properties/DatabaseName", - "/properties/Type", - "/properties/CatalogId" - ], - "definitions": { - "TableOptimizerConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Enabled", - "RoleArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::TableOptimizer", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "TableName": { - "type": "string" - }, - "TableOptimizerConfiguration": { - "$ref": "#/definitions/TableOptimizerConfiguration" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TableName", - "Type", - "DatabaseName", - "TableOptimizerConfiguration", - "CatalogId" - ], - "typeName": "AWS::Glue::TableOptimizer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TableName", + "/properties/DatabaseName", + "/properties/Type", + "/properties/CatalogId" + ], + "definitions": { + "TableOptimizerConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "Enabled", + "RoleArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::TableOptimizer", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "TableName": { + "type": "string" + }, + "TableOptimizerConfiguration": { + "$ref": "#/definitions/TableOptimizerConfiguration" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TableName", + "Type", + "DatabaseName", + "TableOptimizerConfiguration", + "CatalogId" + ], + "typeName": "AWS::Glue::TableOptimizer" +} diff --git a/schema/aws-glue-trigger.json b/schema/aws-glue-trigger.json index accc42d..74249cd 100644 --- a/schema/aws-glue-trigger.json +++ b/schema/aws-glue-trigger.json @@ -1,215 +1,215 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/WorkflowName", - "/properties/Type" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "The actions initiated by this trigger.", - "properties": { - "Arguments": { - "description": "The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.", - "type": "object" - }, - "CrawlerName": { - "description": "The name of the crawler to be used with this action.", - "type": "string" - }, - "JobName": { - "description": "The name of a job to be executed.", - "type": "string" - }, - "NotificationProperty": { - "$ref": "#/definitions/NotificationProperty", - "description": "Specifies configuration properties of a job run notification." - }, - "SecurityConfiguration": { - "description": "The name of the SecurityConfiguration structure to be used with this action.", - "type": "string" - }, - "Timeout": { - "description": "The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.", - "type": "integer" - } - }, - "type": "object" - }, - "Condition": { - "additionalProperties": false, - "description": "Defines a condition under which a trigger fires.", - "properties": { - "CrawlState": { - "description": "The state of the crawler to which this condition applies.", - "type": "string" - }, - "CrawlerName": { - "description": "The name of the crawler to which this condition applies.", - "type": "string" - }, - "JobName": { - "description": "The name of the job whose JobRuns this condition applies to, and on which this trigger waits.", - "type": "string" - }, - "LogicalOperator": { - "description": "A logical operator.", - "type": "string" - }, - "State": { - "description": "The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.", - "type": "string" - } - }, - "type": "object" - }, - "EventBatchingCondition": { - "additionalProperties": false, - "description": "Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.", - "properties": { - "BatchSize": { - "description": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.", - "type": "integer" - }, - "BatchWindow": { - "description": "Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.", - "type": "integer" - } - }, - "required": [ - "BatchSize" - ], - "type": "object" - }, - "NotificationProperty": { - "additionalProperties": false, - "description": "Specifies configuration properties of a job run notification.", - "properties": { - "NotifyDelayAfter": { - "description": "After a job run starts, the number of minutes to wait before sending a job run delay notification", - "type": "integer" - } - }, - "type": "object" - }, - "Predicate": { - "additionalProperties": false, - "description": "The predicate of this trigger, which defines when it will fire.", - "properties": { - "Conditions": { - "description": "A list of the conditions that determine when the trigger will fire.", - "items": { - "$ref": "#/definitions/Condition" - }, - "type": "array", - "uniqueItems": false - }, - "Logical": { - "description": "An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Glue::Trigger", - "handlers": { - "create": { - "permissions": [ - "glue:CreateTrigger", - "glue:GetTrigger", - "glue:TagResource" - ] - }, - "delete": { - "permissions": [ - "glue:DeleteTrigger", - "glue:GetTrigger" - ] - }, - "list": { - "permissions": [ - "glue:ListTriggers" - ] - }, - "read": { - "permissions": [ - "glue:GetTrigger", - "glue:GetTags" - ] - }, - "update": { - "permissions": [ - "glue:UpdateTrigger", - "glue:UntagResource", - "glue:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Actions": { - "description": "The actions initiated by this trigger.", - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": false - }, - "Description": { - "description": "A description of this trigger.", - "type": "string" - }, - "EventBatchingCondition": { - "$ref": "#/definitions/EventBatchingCondition", - "description": "Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires." - }, - "Name": { - "description": "The name of the trigger.", - "type": "string" - }, - "Predicate": { - "$ref": "#/definitions/Predicate", - "description": "The predicate of this trigger, which defines when it will fire." - }, - "Schedule": { - "description": "A cron expression used to specify the schedule.", - "type": "string" - }, - "StartOnCreation": { - "description": "Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.", - "type": "boolean" - }, - "Tags": { - "description": "The tags to use with this trigger.", - "type": "object" - }, - "Type": { - "description": "The type of trigger that this is.", - "type": "string" - }, - "WorkflowName": { - "description": "The name of the workflow associated with the trigger.", - "type": "string" - } - }, - "required": [ - "Type", - "Actions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Glue::Trigger", - "writeOnlyProperties": [ - "/properties/StartOnCreation" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/WorkflowName", + "/properties/Type" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "The actions initiated by this trigger.", + "properties": { + "Arguments": { + "description": "The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.", + "type": "object" + }, + "CrawlerName": { + "description": "The name of the crawler to be used with this action.", + "type": "string" + }, + "JobName": { + "description": "The name of a job to be executed.", + "type": "string" + }, + "NotificationProperty": { + "$ref": "#/definitions/NotificationProperty", + "description": "Specifies configuration properties of a job run notification." + }, + "SecurityConfiguration": { + "description": "The name of the SecurityConfiguration structure to be used with this action.", + "type": "string" + }, + "Timeout": { + "description": "The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.", + "type": "integer" + } + }, + "type": "object" + }, + "Condition": { + "additionalProperties": false, + "description": "Defines a condition under which a trigger fires.", + "properties": { + "CrawlState": { + "description": "The state of the crawler to which this condition applies.", + "type": "string" + }, + "CrawlerName": { + "description": "The name of the crawler to which this condition applies.", + "type": "string" + }, + "JobName": { + "description": "The name of the job whose JobRuns this condition applies to, and on which this trigger waits.", + "type": "string" + }, + "LogicalOperator": { + "description": "A logical operator.", + "type": "string" + }, + "State": { + "description": "The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.", + "type": "string" + } + }, + "type": "object" + }, + "EventBatchingCondition": { + "additionalProperties": false, + "description": "Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.", + "properties": { + "BatchSize": { + "description": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.", + "type": "integer" + }, + "BatchWindow": { + "description": "Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.", + "type": "integer" + } + }, + "required": [ + "BatchSize" + ], + "type": "object" + }, + "NotificationProperty": { + "additionalProperties": false, + "description": "Specifies configuration properties of a job run notification.", + "properties": { + "NotifyDelayAfter": { + "description": "After a job run starts, the number of minutes to wait before sending a job run delay notification", + "type": "integer" + } + }, + "type": "object" + }, + "Predicate": { + "additionalProperties": false, + "description": "The predicate of this trigger, which defines when it will fire.", + "properties": { + "Conditions": { + "description": "A list of the conditions that determine when the trigger will fire.", + "items": { + "$ref": "#/definitions/Condition" + }, + "type": "array", + "uniqueItems": false + }, + "Logical": { + "description": "An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Glue::Trigger", + "handlers": { + "create": { + "permissions": [ + "glue:CreateTrigger", + "glue:GetTrigger", + "glue:TagResource" + ] + }, + "delete": { + "permissions": [ + "glue:DeleteTrigger", + "glue:GetTrigger" + ] + }, + "list": { + "permissions": [ + "glue:ListTriggers" + ] + }, + "read": { + "permissions": [ + "glue:GetTrigger", + "glue:GetTags" + ] + }, + "update": { + "permissions": [ + "glue:UpdateTrigger", + "glue:UntagResource", + "glue:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Actions": { + "description": "The actions initiated by this trigger.", + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": false + }, + "Description": { + "description": "A description of this trigger.", + "type": "string" + }, + "EventBatchingCondition": { + "$ref": "#/definitions/EventBatchingCondition", + "description": "Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires." + }, + "Name": { + "description": "The name of the trigger.", + "type": "string" + }, + "Predicate": { + "$ref": "#/definitions/Predicate", + "description": "The predicate of this trigger, which defines when it will fire." + }, + "Schedule": { + "description": "A cron expression used to specify the schedule.", + "type": "string" + }, + "StartOnCreation": { + "description": "Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.", + "type": "boolean" + }, + "Tags": { + "description": "The tags to use with this trigger.", + "type": "object" + }, + "Type": { + "description": "The type of trigger that this is.", + "type": "string" + }, + "WorkflowName": { + "description": "The name of the workflow associated with the trigger.", + "type": "string" + } + }, + "required": [ + "Type", + "Actions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-glue.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Glue::Trigger", + "writeOnlyProperties": [ + "/properties/StartOnCreation" + ] +} diff --git a/schema/aws-glue-workflow.json b/schema/aws-glue-workflow.json index 3ea13a1..526edb9 100644 --- a/schema/aws-glue-workflow.json +++ b/schema/aws-glue-workflow.json @@ -1,34 +1,34 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::Glue::Workflow", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DefaultRunProperties": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MaxConcurrentRuns": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Glue::Workflow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::Glue::Workflow", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DefaultRunProperties": { + "type": "object" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MaxConcurrentRuns": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Glue::Workflow" +} diff --git a/schema/aws-grafana-workspace.json b/schema/aws-grafana-workspace.json index 56f5a17..09d7e39 100644 --- a/schema/aws-grafana-workspace.json +++ b/schema/aws-grafana-workspace.json @@ -1,495 +1,495 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClientToken" - ], - "definitions": { - "AccountAccessType": { - "description": "These enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.", - "enum": [ - "CURRENT_ACCOUNT", - "ORGANIZATION" - ], - "type": "string" - }, - "AssertionAttributes": { - "additionalProperties": false, - "description": "Maps Grafana friendly names to the IdPs SAML attributes.", - "properties": { - "Email": { - "description": "Name of the attribute within the SAML assert to use as the users email in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Groups": { - "description": "Name of the attribute within the SAML assert to use as the users groups in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Login": { - "description": "Name of the attribute within the SAML assert to use as the users login handle in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of the attribute within the SAML assert to use as the users name in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Org": { - "description": "Name of the attribute within the SAML assert to use as the users organizations in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Role": { - "description": "Name of the attribute within the SAML assert to use as the users roles in Grafana.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "AuthenticationProviderTypes": { - "description": "Valid workspace authentication providers.", - "enum": [ - "AWS_SSO", - "SAML" - ], - "type": "string" - }, - "DataSourceType": { - "description": "These enums represent valid AWS data sources that can be queried via the Grafana workspace. These data sources are primarily used to help customers visualize which data sources have been added to a service managed workspace IAM role.", - "enum": [ - "AMAZON_OPENSEARCH_SERVICE", - "CLOUDWATCH", - "PROMETHEUS", - "XRAY", - "TIMESTREAM", - "SITEWISE", - "ATHENA", - "REDSHIFT" - ], - "type": "string" - }, - "IdpMetadata": { - "additionalProperties": false, - "description": "IdP Metadata used to configure SAML authentication in Grafana.", - "properties": { - "Url": { - "description": "URL that vends the IdPs metadata.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Xml": { - "description": "XML blob of the IdPs metadata.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkAccessControl": { - "additionalProperties": false, - "description": "The configuration settings for Network Access Control.", - "properties": { - "PrefixListIds": { - "description": "The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.", - "insertionOrder": false, - "items": { - "description": "Prefix List Ids", - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "VpceIds": { - "description": "The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.", - "insertionOrder": false, - "items": { - "description": "VPCE Ids", - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "NotificationDestinationType": { - "description": "These enums represent valid AWS notification destinations that the Grafana workspace has permission to use. These notification destinations are primarily used to help customers visualize which destinations have been added to a service managed IAM role.", - "enum": [ - "SNS" - ], - "type": "string" - }, - "PermissionType": { - "description": "These enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.", - "enum": [ - "CUSTOMER_MANAGED", - "SERVICE_MANAGED" - ], - "type": "string" - }, - "RoleValues": { - "additionalProperties": false, - "description": "Maps SAML roles to the Grafana Editor and Admin roles.", - "properties": { - "Admin": { - "description": "List of SAML roles which will be mapped into the Grafana Admin role.", - "insertionOrder": false, - "items": { - "description": "A single SAML role.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "Editor": { - "description": "List of SAML roles which will be mapped into the Grafana Editor role.", - "insertionOrder": false, - "items": { - "description": "A single SAML role.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SamlConfiguration": { - "additionalProperties": false, - "description": "SAML configuration data associated with an AMG workspace.", - "properties": { - "AllowedOrganizations": { - "description": "List of SAML organizations allowed to access Grafana.", - "insertionOrder": false, - "items": { - "description": "A single SAML organization.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "AssertionAttributes": { - "$ref": "#/definitions/AssertionAttributes" - }, - "IdpMetadata": { - "$ref": "#/definitions/IdpMetadata" - }, - "LoginValidityDuration": { - "description": "The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.", - "type": "number" - }, - "RoleValues": { - "$ref": "#/definitions/RoleValues" - } - }, - "required": [ - "IdpMetadata" - ], - "type": "object" - }, - "SamlConfigurationStatus": { - "description": "Valid SAML configuration statuses.", - "enum": [ - "CONFIGURED", - "NOT_CONFIGURED" - ], - "type": "string" - }, - "VpcConfiguration": { - "additionalProperties": false, - "description": "The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.", - "properties": { - "SecurityGroupIds": { - "description": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.", - "insertionOrder": false, - "items": { - "description": "VPC Security Group Id", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "description": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.", - "insertionOrder": false, - "items": { - "description": "VPC Subnet Id", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 6, - "minItems": 2, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "WorkspaceStatus": { - "description": "These enums represent the status of a workspace.", - "enum": [ - "ACTIVE", - "CREATING", - "DELETING", - "FAILED", - "UPDATING", - "UPGRADING", - "VERSION_UPDATING", - "DELETION_FAILED", - "CREATION_FAILED", - "UPDATE_FAILED", - "UPGRADE_FAILED", - "LICENSE_REMOVAL_FAILED", - "VERSION_UPDATE_FAILED" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Grafana::Workspace Resource Type", - "handlers": { - "create": { - "permissions": [ - "grafana:CreateWorkspace", - "grafana:DescribeWorkspace", - "grafana:DescribeWorkspaceAuthentication", - "grafana:DescribeWorkspaceConfiguration", - "grafana:UpdateWorkspaceAuthentication", - "sso:DescribeRegisteredRegions", - "sso:CreateManagedApplicationInstance", - "organizations:DescribeOrganization", - "sso:GetSharedSsoConfiguration", - "iam:PassRole", - "ec2:GetManagedPrefixListEntries", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "sso:ListApplicationInstances", - "sso:GetApplicationInstance" - ] - }, - "delete": { - "permissions": [ - "grafana:DeleteWorkspace", - "grafana:DescribeWorkspace", - "grafana:DescribeWorkspaceAuthentication", - "grafana:DescribeWorkspaceConfiguration", - "sso:DeleteManagedApplicationInstance", - "sso:DescribeRegisteredRegions" - ] - }, - "list": { - "permissions": [ - "grafana:ListWorkspaces", - "grafana:DescribeWorkspaceAuthentication", - "grafana:DescribeWorkspaceConfiguration" - ] - }, - "read": { - "permissions": [ - "grafana:DescribeWorkspace", - "grafana:DescribeWorkspaceAuthentication", - "grafana:DescribeWorkspaceConfiguration" - ] - }, - "update": { - "permissions": [ - "grafana:DescribeWorkspace", - "grafana:DescribeWorkspaceAuthentication", - "grafana:DescribeWorkspaceConfiguration", - "grafana:UpdateWorkspace", - "grafana:UpdateWorkspaceAuthentication", - "grafana:UpdateWorkspaceConfiguration", - "sso:DescribeRegisteredRegions", - "sso:CreateManagedApplicationInstance", - "ec2:GetManagedPrefixListEntries", - "iam:PassRole", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "sso:ListApplicationInstances", - "sso:GetApplicationInstance" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccountAccessType": { - "$ref": "#/definitions/AccountAccessType" - }, - "AuthenticationProviders": { - "description": "List of authentication providers to enable.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AuthenticationProviderTypes" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ClientToken": { - "description": "A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", - "pattern": "^[!-~]{1,64}$", - "type": "string" - }, - "CreationTimestamp": { - "description": "Timestamp when the workspace was created.", - "format": "date-time", - "type": "string" - }, - "DataSources": { - "description": "List of data sources on the service managed IAM role.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataSourceType" - }, - "type": "array" - }, - "Description": { - "description": "Description of a workspace.", - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "Endpoint": { - "description": "Endpoint for the Grafana workspace.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "GrafanaVersion": { - "description": "The version of Grafana to support in your workspace.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "The id that uniquely identifies a Grafana workspace.", - "pattern": "^g-[0-9a-f]{10}$", - "type": "string" - }, - "ModificationTimestamp": { - "description": "Timestamp when the workspace was last modified", - "format": "date-time", - "type": "string" - }, - "Name": { - "description": "The user friendly name of a workspace.", - "pattern": "^[a-zA-Z0-9-._~]{1,255}$", - "type": "string" - }, - "NetworkAccessControl": { - "$ref": "#/definitions/NetworkAccessControl" - }, - "NotificationDestinations": { - "description": "List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NotificationDestinationType" - }, - "type": "array" - }, - "OrganizationRoleName": { - "description": "The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "OrganizationalUnits": { - "description": "List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.", - "insertionOrder": false, - "items": { - "description": "Id of an organizational unit.", - "type": "string" - }, - "type": "array" - }, - "PermissionType": { - "$ref": "#/definitions/PermissionType" - }, - "PluginAdminEnabled": { - "description": "Allow workspace admins to install plugins", - "type": "boolean" - }, - "RoleArn": { - "description": "IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "SamlConfiguration": { - "$ref": "#/definitions/SamlConfiguration" - }, - "SamlConfigurationStatus": { - "$ref": "#/definitions/SamlConfigurationStatus" - }, - "SsoClientId": { - "description": "The client ID of the AWS SSO Managed Application.", - "type": "string" - }, - "StackSetName": { - "description": "The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/WorkspaceStatus" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/SsoClientId", - "/properties/SamlConfigurationStatus", - "/properties/Endpoint", - "/properties/Status", - "/properties/CreationTimestamp", - "/properties/ModificationTimestamp" - ], - "required": [ - "AuthenticationProviders", - "PermissionType", - "AccountAccessType" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Grafana::Workspace", - "writeOnlyProperties": [ - "/properties/ClientToken" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientToken" + ], + "definitions": { + "AccountAccessType": { + "description": "These enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.", + "enum": [ + "CURRENT_ACCOUNT", + "ORGANIZATION" + ], + "type": "string" + }, + "AssertionAttributes": { + "additionalProperties": false, + "description": "Maps Grafana friendly names to the IdPs SAML attributes.", + "properties": { + "Email": { + "description": "Name of the attribute within the SAML assert to use as the users email in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Groups": { + "description": "Name of the attribute within the SAML assert to use as the users groups in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Login": { + "description": "Name of the attribute within the SAML assert to use as the users login handle in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of the attribute within the SAML assert to use as the users name in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Org": { + "description": "Name of the attribute within the SAML assert to use as the users organizations in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Role": { + "description": "Name of the attribute within the SAML assert to use as the users roles in Grafana.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "AuthenticationProviderTypes": { + "description": "Valid workspace authentication providers.", + "enum": [ + "AWS_SSO", + "SAML" + ], + "type": "string" + }, + "DataSourceType": { + "description": "These enums represent valid AWS data sources that can be queried via the Grafana workspace. These data sources are primarily used to help customers visualize which data sources have been added to a service managed workspace IAM role.", + "enum": [ + "AMAZON_OPENSEARCH_SERVICE", + "CLOUDWATCH", + "PROMETHEUS", + "XRAY", + "TIMESTREAM", + "SITEWISE", + "ATHENA", + "REDSHIFT" + ], + "type": "string" + }, + "IdpMetadata": { + "additionalProperties": false, + "description": "IdP Metadata used to configure SAML authentication in Grafana.", + "properties": { + "Url": { + "description": "URL that vends the IdPs metadata.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Xml": { + "description": "XML blob of the IdPs metadata.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkAccessControl": { + "additionalProperties": false, + "description": "The configuration settings for Network Access Control.", + "properties": { + "PrefixListIds": { + "description": "The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.", + "insertionOrder": false, + "items": { + "description": "Prefix List Ids", + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "VpceIds": { + "description": "The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.", + "insertionOrder": false, + "items": { + "description": "VPCE Ids", + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "NotificationDestinationType": { + "description": "These enums represent valid AWS notification destinations that the Grafana workspace has permission to use. These notification destinations are primarily used to help customers visualize which destinations have been added to a service managed IAM role.", + "enum": [ + "SNS" + ], + "type": "string" + }, + "PermissionType": { + "description": "These enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.", + "enum": [ + "CUSTOMER_MANAGED", + "SERVICE_MANAGED" + ], + "type": "string" + }, + "RoleValues": { + "additionalProperties": false, + "description": "Maps SAML roles to the Grafana Editor and Admin roles.", + "properties": { + "Admin": { + "description": "List of SAML roles which will be mapped into the Grafana Admin role.", + "insertionOrder": false, + "items": { + "description": "A single SAML role.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "Editor": { + "description": "List of SAML roles which will be mapped into the Grafana Editor role.", + "insertionOrder": false, + "items": { + "description": "A single SAML role.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SamlConfiguration": { + "additionalProperties": false, + "description": "SAML configuration data associated with an AMG workspace.", + "properties": { + "AllowedOrganizations": { + "description": "List of SAML organizations allowed to access Grafana.", + "insertionOrder": false, + "items": { + "description": "A single SAML organization.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "AssertionAttributes": { + "$ref": "#/definitions/AssertionAttributes" + }, + "IdpMetadata": { + "$ref": "#/definitions/IdpMetadata" + }, + "LoginValidityDuration": { + "description": "The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.", + "type": "number" + }, + "RoleValues": { + "$ref": "#/definitions/RoleValues" + } + }, + "required": [ + "IdpMetadata" + ], + "type": "object" + }, + "SamlConfigurationStatus": { + "description": "Valid SAML configuration statuses.", + "enum": [ + "CONFIGURED", + "NOT_CONFIGURED" + ], + "type": "string" + }, + "VpcConfiguration": { + "additionalProperties": false, + "description": "The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.", + "properties": { + "SecurityGroupIds": { + "description": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.", + "insertionOrder": false, + "items": { + "description": "VPC Security Group Id", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "description": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.", + "insertionOrder": false, + "items": { + "description": "VPC Subnet Id", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 6, + "minItems": 2, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SecurityGroupIds", + "SubnetIds" + ], + "type": "object" + }, + "WorkspaceStatus": { + "description": "These enums represent the status of a workspace.", + "enum": [ + "ACTIVE", + "CREATING", + "DELETING", + "FAILED", + "UPDATING", + "UPGRADING", + "VERSION_UPDATING", + "DELETION_FAILED", + "CREATION_FAILED", + "UPDATE_FAILED", + "UPGRADE_FAILED", + "LICENSE_REMOVAL_FAILED", + "VERSION_UPDATE_FAILED" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Grafana::Workspace Resource Type", + "handlers": { + "create": { + "permissions": [ + "grafana:CreateWorkspace", + "grafana:DescribeWorkspace", + "grafana:DescribeWorkspaceAuthentication", + "grafana:DescribeWorkspaceConfiguration", + "grafana:UpdateWorkspaceAuthentication", + "sso:DescribeRegisteredRegions", + "sso:CreateManagedApplicationInstance", + "organizations:DescribeOrganization", + "sso:GetSharedSsoConfiguration", + "iam:PassRole", + "ec2:GetManagedPrefixListEntries", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "sso:ListApplicationInstances", + "sso:GetApplicationInstance" + ] + }, + "delete": { + "permissions": [ + "grafana:DeleteWorkspace", + "grafana:DescribeWorkspace", + "grafana:DescribeWorkspaceAuthentication", + "grafana:DescribeWorkspaceConfiguration", + "sso:DeleteManagedApplicationInstance", + "sso:DescribeRegisteredRegions" + ] + }, + "list": { + "permissions": [ + "grafana:ListWorkspaces", + "grafana:DescribeWorkspaceAuthentication", + "grafana:DescribeWorkspaceConfiguration" + ] + }, + "read": { + "permissions": [ + "grafana:DescribeWorkspace", + "grafana:DescribeWorkspaceAuthentication", + "grafana:DescribeWorkspaceConfiguration" + ] + }, + "update": { + "permissions": [ + "grafana:DescribeWorkspace", + "grafana:DescribeWorkspaceAuthentication", + "grafana:DescribeWorkspaceConfiguration", + "grafana:UpdateWorkspace", + "grafana:UpdateWorkspaceAuthentication", + "grafana:UpdateWorkspaceConfiguration", + "sso:DescribeRegisteredRegions", + "sso:CreateManagedApplicationInstance", + "ec2:GetManagedPrefixListEntries", + "iam:PassRole", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "sso:ListApplicationInstances", + "sso:GetApplicationInstance" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccountAccessType": { + "$ref": "#/definitions/AccountAccessType" + }, + "AuthenticationProviders": { + "description": "List of authentication providers to enable.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AuthenticationProviderTypes" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ClientToken": { + "description": "A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "pattern": "^[!-~]{1,64}$", + "type": "string" + }, + "CreationTimestamp": { + "description": "Timestamp when the workspace was created.", + "format": "date-time", + "type": "string" + }, + "DataSources": { + "description": "List of data sources on the service managed IAM role.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataSourceType" + }, + "type": "array" + }, + "Description": { + "description": "Description of a workspace.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "Endpoint": { + "description": "Endpoint for the Grafana workspace.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "GrafanaVersion": { + "description": "The version of Grafana to support in your workspace.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The id that uniquely identifies a Grafana workspace.", + "pattern": "^g-[0-9a-f]{10}$", + "type": "string" + }, + "ModificationTimestamp": { + "description": "Timestamp when the workspace was last modified", + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "The user friendly name of a workspace.", + "pattern": "^[a-zA-Z0-9-._~]{1,255}$", + "type": "string" + }, + "NetworkAccessControl": { + "$ref": "#/definitions/NetworkAccessControl" + }, + "NotificationDestinations": { + "description": "List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NotificationDestinationType" + }, + "type": "array" + }, + "OrganizationRoleName": { + "description": "The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "OrganizationalUnits": { + "description": "List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.", + "insertionOrder": false, + "items": { + "description": "Id of an organizational unit.", + "type": "string" + }, + "type": "array" + }, + "PermissionType": { + "$ref": "#/definitions/PermissionType" + }, + "PluginAdminEnabled": { + "description": "Allow workspace admins to install plugins", + "type": "boolean" + }, + "RoleArn": { + "description": "IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "SamlConfiguration": { + "$ref": "#/definitions/SamlConfiguration" + }, + "SamlConfigurationStatus": { + "$ref": "#/definitions/SamlConfigurationStatus" + }, + "SsoClientId": { + "description": "The client ID of the AWS SSO Managed Application.", + "type": "string" + }, + "StackSetName": { + "description": "The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/WorkspaceStatus" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/SsoClientId", + "/properties/SamlConfigurationStatus", + "/properties/Endpoint", + "/properties/Status", + "/properties/CreationTimestamp", + "/properties/ModificationTimestamp" + ], + "required": [ + "AuthenticationProviders", + "PermissionType", + "AccountAccessType" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Grafana::Workspace", + "writeOnlyProperties": [ + "/properties/ClientToken" + ] +} diff --git a/schema/aws-greengrass-connectordefinition.json b/schema/aws-greengrass-connectordefinition.json index 77c0a8f..f226eb6 100644 --- a/schema/aws-greengrass-connectordefinition.json +++ b/schema/aws-greengrass-connectordefinition.json @@ -1,76 +1,76 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "Connector": { - "additionalProperties": false, - "properties": { - "ConnectorArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "required": [ - "ConnectorArn", - "Id" - ], - "type": "object" - }, - "ConnectorDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Connectors": { - "items": { - "$ref": "#/definitions/Connector" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Connectors" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::ConnectorDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/ConnectorDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::ConnectorDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "Connector": { + "additionalProperties": false, + "properties": { + "ConnectorArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Parameters": { + "type": "object" + } + }, + "required": [ + "ConnectorArn", + "Id" + ], + "type": "object" + }, + "ConnectorDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Connectors": { + "items": { + "$ref": "#/definitions/Connector" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Connectors" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::ConnectorDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/ConnectorDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::ConnectorDefinition" +} diff --git a/schema/aws-greengrass-connectordefinitionversion.json b/schema/aws-greengrass-connectordefinitionversion.json index 3645f4d..269b629 100644 --- a/schema/aws-greengrass-connectordefinitionversion.json +++ b/schema/aws-greengrass-connectordefinitionversion.json @@ -1,55 +1,55 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorDefinitionId", - "/properties/Connectors" - ], - "definitions": { - "Connector": { - "additionalProperties": false, - "properties": { - "ConnectorArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "required": [ - "ConnectorArn", - "Id" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::ConnectorDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConnectorDefinitionId": { - "type": "string" - }, - "Connectors": { - "items": { - "$ref": "#/definitions/Connector" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Connectors", - "ConnectorDefinitionId" - ], - "typeName": "AWS::Greengrass::ConnectorDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorDefinitionId", + "/properties/Connectors" + ], + "definitions": { + "Connector": { + "additionalProperties": false, + "properties": { + "ConnectorArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Parameters": { + "type": "object" + } + }, + "required": [ + "ConnectorArn", + "Id" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::ConnectorDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConnectorDefinitionId": { + "type": "string" + }, + "Connectors": { + "items": { + "$ref": "#/definitions/Connector" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Connectors", + "ConnectorDefinitionId" + ], + "typeName": "AWS::Greengrass::ConnectorDefinitionVersion" +} diff --git a/schema/aws-greengrass-coredefinition.json b/schema/aws-greengrass-coredefinition.json index f05d14d..03fd668 100644 --- a/schema/aws-greengrass-coredefinition.json +++ b/schema/aws-greengrass-coredefinition.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "Core": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "ThingArn", - "Id", - "CertificateArn" - ], - "type": "object" - }, - "CoreDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Cores": { - "items": { - "$ref": "#/definitions/Core" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Cores" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::CoreDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/CoreDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::CoreDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "Core": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": { + "type": "string" + } + }, + "required": [ + "ThingArn", + "Id", + "CertificateArn" + ], + "type": "object" + }, + "CoreDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Cores": { + "items": { + "$ref": "#/definitions/Core" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Cores" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::CoreDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/CoreDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::CoreDefinition" +} diff --git a/schema/aws-greengrass-coredefinitionversion.json b/schema/aws-greengrass-coredefinitionversion.json index 4d94ff0..3228beb 100644 --- a/schema/aws-greengrass-coredefinitionversion.json +++ b/schema/aws-greengrass-coredefinitionversion.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Cores", - "/properties/CoreDefinitionId" - ], - "definitions": { - "Core": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "ThingArn", - "Id", - "CertificateArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::CoreDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CoreDefinitionId": { - "type": "string" - }, - "Cores": { - "items": { - "$ref": "#/definitions/Core" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Cores", - "CoreDefinitionId" - ], - "typeName": "AWS::Greengrass::CoreDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Cores", + "/properties/CoreDefinitionId" + ], + "definitions": { + "Core": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": { + "type": "string" + } + }, + "required": [ + "ThingArn", + "Id", + "CertificateArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::CoreDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CoreDefinitionId": { + "type": "string" + }, + "Cores": { + "items": { + "$ref": "#/definitions/Core" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Cores", + "CoreDefinitionId" + ], + "typeName": "AWS::Greengrass::CoreDefinitionVersion" +} diff --git a/schema/aws-greengrass-devicedefinition.json b/schema/aws-greengrass-devicedefinition.json index f2f04c9..97cf172 100644 --- a/schema/aws-greengrass-devicedefinition.json +++ b/schema/aws-greengrass-devicedefinition.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "Device": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "ThingArn", - "Id", - "CertificateArn" - ], - "type": "object" - }, - "DeviceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Devices": { - "items": { - "$ref": "#/definitions/Device" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Devices" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::DeviceDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/DeviceDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::DeviceDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "Device": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": { + "type": "string" + } + }, + "required": [ + "ThingArn", + "Id", + "CertificateArn" + ], + "type": "object" + }, + "DeviceDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Devices": { + "items": { + "$ref": "#/definitions/Device" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Devices" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::DeviceDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/DeviceDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::DeviceDefinition" +} diff --git a/schema/aws-greengrass-devicedefinitionversion.json b/schema/aws-greengrass-devicedefinitionversion.json index fe52fe1..12b873c 100644 --- a/schema/aws-greengrass-devicedefinitionversion.json +++ b/schema/aws-greengrass-devicedefinitionversion.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeviceDefinitionId", - "/properties/Devices" - ], - "definitions": { - "Device": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "ThingArn", - "Id", - "CertificateArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::DeviceDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeviceDefinitionId": { - "type": "string" - }, - "Devices": { - "items": { - "$ref": "#/definitions/Device" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Devices", - "DeviceDefinitionId" - ], - "typeName": "AWS::Greengrass::DeviceDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeviceDefinitionId", + "/properties/Devices" + ], + "definitions": { + "Device": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": { + "type": "string" + } + }, + "required": [ + "ThingArn", + "Id", + "CertificateArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::DeviceDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeviceDefinitionId": { + "type": "string" + }, + "Devices": { + "items": { + "$ref": "#/definitions/Device" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Devices", + "DeviceDefinitionId" + ], + "typeName": "AWS::Greengrass::DeviceDefinitionVersion" +} diff --git a/schema/aws-greengrass-functiondefinition.json b/schema/aws-greengrass-functiondefinition.json index 9e90423..663e95c 100644 --- a/schema/aws-greengrass-functiondefinition.json +++ b/schema/aws-greengrass-functiondefinition.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "DefaultConfig": { - "additionalProperties": false, - "properties": { - "Execution": { - "$ref": "#/definitions/Execution" - } - }, - "required": [ - "Execution" - ], - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "properties": { - "AccessSysfs": { - "type": "boolean" - }, - "Execution": { - "$ref": "#/definitions/Execution" - }, - "ResourceAccessPolicies": { - "items": { - "$ref": "#/definitions/ResourceAccessPolicy" - }, - "type": "array", - "uniqueItems": false - }, - "Variables": { - "type": "object" - } - }, - "type": "object" - }, - "Execution": { - "additionalProperties": false, - "properties": { - "IsolationMode": { - "type": "string" - }, - "RunAs": { - "$ref": "#/definitions/RunAs" - } - }, - "type": "object" - }, - "Function": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "FunctionConfiguration": { - "$ref": "#/definitions/FunctionConfiguration" - }, - "Id": { - "type": "string" - } - }, - "required": [ - "FunctionArn", - "FunctionConfiguration", - "Id" - ], - "type": "object" - }, - "FunctionConfiguration": { - "additionalProperties": false, - "properties": { - "EncodingType": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/Environment" - }, - "ExecArgs": { - "type": "string" - }, - "Executable": { - "type": "string" - }, - "MemorySize": { - "type": "integer" - }, - "Pinned": { - "type": "boolean" - }, - "Timeout": { - "type": "integer" - } - }, - "type": "object" - }, - "FunctionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DefaultConfig": { - "$ref": "#/definitions/DefaultConfig" - }, - "Functions": { - "items": { - "$ref": "#/definitions/Function" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Functions" - ], - "type": "object" - }, - "ResourceAccessPolicy": { - "additionalProperties": false, - "properties": { - "Permission": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "required": [ - "ResourceId" - ], - "type": "object" - }, - "RunAs": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "integer" - }, - "Uid": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::FunctionDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/FunctionDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::FunctionDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "DefaultConfig": { + "additionalProperties": false, + "properties": { + "Execution": { + "$ref": "#/definitions/Execution" + } + }, + "required": [ + "Execution" + ], + "type": "object" + }, + "Environment": { + "additionalProperties": false, + "properties": { + "AccessSysfs": { + "type": "boolean" + }, + "Execution": { + "$ref": "#/definitions/Execution" + }, + "ResourceAccessPolicies": { + "items": { + "$ref": "#/definitions/ResourceAccessPolicy" + }, + "type": "array", + "uniqueItems": false + }, + "Variables": { + "type": "object" + } + }, + "type": "object" + }, + "Execution": { + "additionalProperties": false, + "properties": { + "IsolationMode": { + "type": "string" + }, + "RunAs": { + "$ref": "#/definitions/RunAs" + } + }, + "type": "object" + }, + "Function": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "type": "string" + }, + "FunctionConfiguration": { + "$ref": "#/definitions/FunctionConfiguration" + }, + "Id": { + "type": "string" + } + }, + "required": [ + "FunctionArn", + "FunctionConfiguration", + "Id" + ], + "type": "object" + }, + "FunctionConfiguration": { + "additionalProperties": false, + "properties": { + "EncodingType": { + "type": "string" + }, + "Environment": { + "$ref": "#/definitions/Environment" + }, + "ExecArgs": { + "type": "string" + }, + "Executable": { + "type": "string" + }, + "MemorySize": { + "type": "integer" + }, + "Pinned": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + }, + "type": "object" + }, + "FunctionDefinitionVersion": { + "additionalProperties": false, + "properties": { + "DefaultConfig": { + "$ref": "#/definitions/DefaultConfig" + }, + "Functions": { + "items": { + "$ref": "#/definitions/Function" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Functions" + ], + "type": "object" + }, + "ResourceAccessPolicy": { + "additionalProperties": false, + "properties": { + "Permission": { + "type": "string" + }, + "ResourceId": { + "type": "string" + } + }, + "required": [ + "ResourceId" + ], + "type": "object" + }, + "RunAs": { + "additionalProperties": false, + "properties": { + "Gid": { + "type": "integer" + }, + "Uid": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::FunctionDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/FunctionDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::FunctionDefinition" +} diff --git a/schema/aws-greengrass-functiondefinitionversion.json b/schema/aws-greengrass-functiondefinitionversion.json index fbfefe8..8e22f17 100644 --- a/schema/aws-greengrass-functiondefinitionversion.json +++ b/schema/aws-greengrass-functiondefinitionversion.json @@ -1,160 +1,160 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Functions", - "/properties/FunctionDefinitionId", - "/properties/DefaultConfig" - ], - "definitions": { - "DefaultConfig": { - "additionalProperties": false, - "properties": { - "Execution": { - "$ref": "#/definitions/Execution" - } - }, - "required": [ - "Execution" - ], - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "properties": { - "AccessSysfs": { - "type": "boolean" - }, - "Execution": { - "$ref": "#/definitions/Execution" - }, - "ResourceAccessPolicies": { - "items": { - "$ref": "#/definitions/ResourceAccessPolicy" - }, - "type": "array", - "uniqueItems": false - }, - "Variables": { - "type": "object" - } - }, - "type": "object" - }, - "Execution": { - "additionalProperties": false, - "properties": { - "IsolationMode": { - "type": "string" - }, - "RunAs": { - "$ref": "#/definitions/RunAs" - } - }, - "type": "object" - }, - "Function": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "FunctionConfiguration": { - "$ref": "#/definitions/FunctionConfiguration" - }, - "Id": { - "type": "string" - } - }, - "required": [ - "FunctionArn", - "FunctionConfiguration", - "Id" - ], - "type": "object" - }, - "FunctionConfiguration": { - "additionalProperties": false, - "properties": { - "EncodingType": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/Environment" - }, - "ExecArgs": { - "type": "string" - }, - "Executable": { - "type": "string" - }, - "MemorySize": { - "type": "integer" - }, - "Pinned": { - "type": "boolean" - }, - "Timeout": { - "type": "integer" - } - }, - "type": "object" - }, - "ResourceAccessPolicy": { - "additionalProperties": false, - "properties": { - "Permission": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "required": [ - "ResourceId" - ], - "type": "object" - }, - "RunAs": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "integer" - }, - "Uid": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::FunctionDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DefaultConfig": { - "$ref": "#/definitions/DefaultConfig" - }, - "FunctionDefinitionId": { - "type": "string" - }, - "Functions": { - "items": { - "$ref": "#/definitions/Function" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FunctionDefinitionId", - "Functions" - ], - "typeName": "AWS::Greengrass::FunctionDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Functions", + "/properties/FunctionDefinitionId", + "/properties/DefaultConfig" + ], + "definitions": { + "DefaultConfig": { + "additionalProperties": false, + "properties": { + "Execution": { + "$ref": "#/definitions/Execution" + } + }, + "required": [ + "Execution" + ], + "type": "object" + }, + "Environment": { + "additionalProperties": false, + "properties": { + "AccessSysfs": { + "type": "boolean" + }, + "Execution": { + "$ref": "#/definitions/Execution" + }, + "ResourceAccessPolicies": { + "items": { + "$ref": "#/definitions/ResourceAccessPolicy" + }, + "type": "array", + "uniqueItems": false + }, + "Variables": { + "type": "object" + } + }, + "type": "object" + }, + "Execution": { + "additionalProperties": false, + "properties": { + "IsolationMode": { + "type": "string" + }, + "RunAs": { + "$ref": "#/definitions/RunAs" + } + }, + "type": "object" + }, + "Function": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "type": "string" + }, + "FunctionConfiguration": { + "$ref": "#/definitions/FunctionConfiguration" + }, + "Id": { + "type": "string" + } + }, + "required": [ + "FunctionArn", + "FunctionConfiguration", + "Id" + ], + "type": "object" + }, + "FunctionConfiguration": { + "additionalProperties": false, + "properties": { + "EncodingType": { + "type": "string" + }, + "Environment": { + "$ref": "#/definitions/Environment" + }, + "ExecArgs": { + "type": "string" + }, + "Executable": { + "type": "string" + }, + "MemorySize": { + "type": "integer" + }, + "Pinned": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + }, + "type": "object" + }, + "ResourceAccessPolicy": { + "additionalProperties": false, + "properties": { + "Permission": { + "type": "string" + }, + "ResourceId": { + "type": "string" + } + }, + "required": [ + "ResourceId" + ], + "type": "object" + }, + "RunAs": { + "additionalProperties": false, + "properties": { + "Gid": { + "type": "integer" + }, + "Uid": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::FunctionDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DefaultConfig": { + "$ref": "#/definitions/DefaultConfig" + }, + "FunctionDefinitionId": { + "type": "string" + }, + "Functions": { + "items": { + "$ref": "#/definitions/Function" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FunctionDefinitionId", + "Functions" + ], + "typeName": "AWS::Greengrass::FunctionDefinitionVersion" +} diff --git a/schema/aws-greengrass-group.json b/schema/aws-greengrass-group.json index b0ce6ac..6468d3d 100644 --- a/schema/aws-greengrass-group.json +++ b/schema/aws-greengrass-group.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "GroupVersion": { - "additionalProperties": false, - "properties": { - "ConnectorDefinitionVersionArn": { - "type": "string" - }, - "CoreDefinitionVersionArn": { - "type": "string" - }, - "DeviceDefinitionVersionArn": { - "type": "string" - }, - "FunctionDefinitionVersionArn": { - "type": "string" - }, - "LoggerDefinitionVersionArn": { - "type": "string" - }, - "ResourceDefinitionVersionArn": { - "type": "string" - }, - "SubscriptionDefinitionVersionArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::Group", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/GroupVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "RoleAttachedAt": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/RoleAttachedAt", - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::Group" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "GroupVersion": { + "additionalProperties": false, + "properties": { + "ConnectorDefinitionVersionArn": { + "type": "string" + }, + "CoreDefinitionVersionArn": { + "type": "string" + }, + "DeviceDefinitionVersionArn": { + "type": "string" + }, + "FunctionDefinitionVersionArn": { + "type": "string" + }, + "LoggerDefinitionVersionArn": { + "type": "string" + }, + "ResourceDefinitionVersionArn": { + "type": "string" + }, + "SubscriptionDefinitionVersionArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::Group", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/GroupVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "RoleAttachedAt": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/RoleAttachedAt", + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::Group" +} diff --git a/schema/aws-greengrass-groupversion.json b/schema/aws-greengrass-groupversion.json index 7d6f55e..02cdb19 100644 --- a/schema/aws-greengrass-groupversion.json +++ b/schema/aws-greengrass-groupversion.json @@ -1,53 +1,53 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CoreDefinitionVersionArn", - "/properties/DeviceDefinitionVersionArn", - "/properties/ConnectorDefinitionVersionArn", - "/properties/SubscriptionDefinitionVersionArn", - "/properties/LoggerDefinitionVersionArn", - "/properties/GroupId", - "/properties/ResourceDefinitionVersionArn", - "/properties/FunctionDefinitionVersionArn" - ], - "description": "Resource Type definition for AWS::Greengrass::GroupVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConnectorDefinitionVersionArn": { - "type": "string" - }, - "CoreDefinitionVersionArn": { - "type": "string" - }, - "DeviceDefinitionVersionArn": { - "type": "string" - }, - "FunctionDefinitionVersionArn": { - "type": "string" - }, - "GroupId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LoggerDefinitionVersionArn": { - "type": "string" - }, - "ResourceDefinitionVersionArn": { - "type": "string" - }, - "SubscriptionDefinitionVersionArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "GroupId" - ], - "typeName": "AWS::Greengrass::GroupVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CoreDefinitionVersionArn", + "/properties/DeviceDefinitionVersionArn", + "/properties/ConnectorDefinitionVersionArn", + "/properties/SubscriptionDefinitionVersionArn", + "/properties/LoggerDefinitionVersionArn", + "/properties/GroupId", + "/properties/ResourceDefinitionVersionArn", + "/properties/FunctionDefinitionVersionArn" + ], + "description": "Resource Type definition for AWS::Greengrass::GroupVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConnectorDefinitionVersionArn": { + "type": "string" + }, + "CoreDefinitionVersionArn": { + "type": "string" + }, + "DeviceDefinitionVersionArn": { + "type": "string" + }, + "FunctionDefinitionVersionArn": { + "type": "string" + }, + "GroupId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LoggerDefinitionVersionArn": { + "type": "string" + }, + "ResourceDefinitionVersionArn": { + "type": "string" + }, + "SubscriptionDefinitionVersionArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "GroupId" + ], + "typeName": "AWS::Greengrass::GroupVersion" +} diff --git a/schema/aws-greengrass-loggerdefinition.json b/schema/aws-greengrass-loggerdefinition.json index fd4e928..4d64ada 100644 --- a/schema/aws-greengrass-loggerdefinition.json +++ b/schema/aws-greengrass-loggerdefinition.json @@ -1,84 +1,84 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "Logger": { - "additionalProperties": false, - "properties": { - "Component": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "Space": { - "type": "integer" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Level", - "Id", - "Component" - ], - "type": "object" - }, - "LoggerDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Loggers": { - "items": { - "$ref": "#/definitions/Logger" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Loggers" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::LoggerDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/LoggerDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::LoggerDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "Logger": { + "additionalProperties": false, + "properties": { + "Component": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Level": { + "type": "string" + }, + "Space": { + "type": "integer" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Level", + "Id", + "Component" + ], + "type": "object" + }, + "LoggerDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Loggers": { + "items": { + "$ref": "#/definitions/Logger" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Loggers" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::LoggerDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/LoggerDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::LoggerDefinition" +} diff --git a/schema/aws-greengrass-loggerdefinitionversion.json b/schema/aws-greengrass-loggerdefinitionversion.json index f08eb6f..f5fdf72 100644 --- a/schema/aws-greengrass-loggerdefinitionversion.json +++ b/schema/aws-greengrass-loggerdefinitionversion.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoggerDefinitionId", - "/properties/Loggers" - ], - "definitions": { - "Logger": { - "additionalProperties": false, - "properties": { - "Component": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "Space": { - "type": "integer" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Level", - "Id", - "Component" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::LoggerDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "LoggerDefinitionId": { - "type": "string" - }, - "Loggers": { - "items": { - "$ref": "#/definitions/Logger" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Loggers", - "LoggerDefinitionId" - ], - "typeName": "AWS::Greengrass::LoggerDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoggerDefinitionId", + "/properties/Loggers" + ], + "definitions": { + "Logger": { + "additionalProperties": false, + "properties": { + "Component": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Level": { + "type": "string" + }, + "Space": { + "type": "integer" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Level", + "Id", + "Component" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::LoggerDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "LoggerDefinitionId": { + "type": "string" + }, + "Loggers": { + "items": { + "$ref": "#/definitions/Logger" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Loggers", + "LoggerDefinitionId" + ], + "typeName": "AWS::Greengrass::LoggerDefinitionVersion" +} diff --git a/schema/aws-greengrass-resourcedefinition.json b/schema/aws-greengrass-resourcedefinition.json index bb5ecbf..8542cbd 100644 --- a/schema/aws-greengrass-resourcedefinition.json +++ b/schema/aws-greengrass-resourcedefinition.json @@ -1,220 +1,220 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "GroupOwnerSetting": { - "additionalProperties": false, - "properties": { - "AutoAddGroupOwner": { - "type": "boolean" - }, - "GroupOwner": { - "type": "string" - } - }, - "required": [ - "AutoAddGroupOwner" - ], - "type": "object" - }, - "LocalDeviceResourceData": { - "additionalProperties": false, - "properties": { - "GroupOwnerSetting": { - "$ref": "#/definitions/GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath" - ], - "type": "object" - }, - "LocalVolumeResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "GroupOwnerSetting": { - "$ref": "#/definitions/GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath", - "DestinationPath" - ], - "type": "object" - }, - "ResourceDataContainer": { - "additionalProperties": false, - "properties": { - "LocalDeviceResourceData": { - "$ref": "#/definitions/LocalDeviceResourceData" - }, - "LocalVolumeResourceData": { - "$ref": "#/definitions/LocalVolumeResourceData" - }, - "S3MachineLearningModelResourceData": { - "$ref": "#/definitions/S3MachineLearningModelResourceData" - }, - "SageMakerMachineLearningModelResourceData": { - "$ref": "#/definitions/SageMakerMachineLearningModelResourceData" - }, - "SecretsManagerSecretResourceData": { - "$ref": "#/definitions/SecretsManagerSecretResourceData" - } - }, - "type": "object" - }, - "ResourceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Resources": { - "items": { - "$ref": "#/definitions/ResourceInstance" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Resources" - ], - "type": "object" - }, - "ResourceDownloadOwnerSetting": { - "additionalProperties": false, - "properties": { - "GroupOwner": { - "type": "string" - }, - "GroupPermission": { - "type": "string" - } - }, - "required": [ - "GroupOwner", - "GroupPermission" - ], - "type": "object" - }, - "ResourceInstance": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceDataContainer": { - "$ref": "#/definitions/ResourceDataContainer" - } - }, - "required": [ - "ResourceDataContainer", - "Id", - "Name" - ], - "type": "object" - }, - "S3MachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/ResourceDownloadOwnerSetting" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "S3Uri" - ], - "type": "object" - }, - "SageMakerMachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/ResourceDownloadOwnerSetting" - }, - "SageMakerJobArn": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SageMakerJobArn" - ], - "type": "object" - }, - "SecretsManagerSecretResourceData": { - "additionalProperties": false, - "properties": { - "ARN": { - "type": "string" - }, - "AdditionalStagingLabelsToDownload": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::ResourceDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/ResourceDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::ResourceDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "GroupOwnerSetting": { + "additionalProperties": false, + "properties": { + "AutoAddGroupOwner": { + "type": "boolean" + }, + "GroupOwner": { + "type": "string" + } + }, + "required": [ + "AutoAddGroupOwner" + ], + "type": "object" + }, + "LocalDeviceResourceData": { + "additionalProperties": false, + "properties": { + "GroupOwnerSetting": { + "$ref": "#/definitions/GroupOwnerSetting" + }, + "SourcePath": { + "type": "string" + } + }, + "required": [ + "SourcePath" + ], + "type": "object" + }, + "LocalVolumeResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "GroupOwnerSetting": { + "$ref": "#/definitions/GroupOwnerSetting" + }, + "SourcePath": { + "type": "string" + } + }, + "required": [ + "SourcePath", + "DestinationPath" + ], + "type": "object" + }, + "ResourceDataContainer": { + "additionalProperties": false, + "properties": { + "LocalDeviceResourceData": { + "$ref": "#/definitions/LocalDeviceResourceData" + }, + "LocalVolumeResourceData": { + "$ref": "#/definitions/LocalVolumeResourceData" + }, + "S3MachineLearningModelResourceData": { + "$ref": "#/definitions/S3MachineLearningModelResourceData" + }, + "SageMakerMachineLearningModelResourceData": { + "$ref": "#/definitions/SageMakerMachineLearningModelResourceData" + }, + "SecretsManagerSecretResourceData": { + "$ref": "#/definitions/SecretsManagerSecretResourceData" + } + }, + "type": "object" + }, + "ResourceDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Resources": { + "items": { + "$ref": "#/definitions/ResourceInstance" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Resources" + ], + "type": "object" + }, + "ResourceDownloadOwnerSetting": { + "additionalProperties": false, + "properties": { + "GroupOwner": { + "type": "string" + }, + "GroupPermission": { + "type": "string" + } + }, + "required": [ + "GroupOwner", + "GroupPermission" + ], + "type": "object" + }, + "ResourceInstance": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceDataContainer": { + "$ref": "#/definitions/ResourceDataContainer" + } + }, + "required": [ + "ResourceDataContainer", + "Id", + "Name" + ], + "type": "object" + }, + "S3MachineLearningModelResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "OwnerSetting": { + "$ref": "#/definitions/ResourceDownloadOwnerSetting" + }, + "S3Uri": { + "type": "string" + } + }, + "required": [ + "DestinationPath", + "S3Uri" + ], + "type": "object" + }, + "SageMakerMachineLearningModelResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "OwnerSetting": { + "$ref": "#/definitions/ResourceDownloadOwnerSetting" + }, + "SageMakerJobArn": { + "type": "string" + } + }, + "required": [ + "DestinationPath", + "SageMakerJobArn" + ], + "type": "object" + }, + "SecretsManagerSecretResourceData": { + "additionalProperties": false, + "properties": { + "ARN": { + "type": "string" + }, + "AdditionalStagingLabelsToDownload": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::ResourceDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/ResourceDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::ResourceDefinition" +} diff --git a/schema/aws-greengrass-resourcedefinitionversion.json b/schema/aws-greengrass-resourcedefinitionversion.json index d4dd3dd..10b2c6e 100644 --- a/schema/aws-greengrass-resourcedefinitionversion.json +++ b/schema/aws-greengrass-resourcedefinitionversion.json @@ -1,199 +1,199 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Resources", - "/properties/ResourceDefinitionId" - ], - "definitions": { - "GroupOwnerSetting": { - "additionalProperties": false, - "properties": { - "AutoAddGroupOwner": { - "type": "boolean" - }, - "GroupOwner": { - "type": "string" - } - }, - "required": [ - "AutoAddGroupOwner" - ], - "type": "object" - }, - "LocalDeviceResourceData": { - "additionalProperties": false, - "properties": { - "GroupOwnerSetting": { - "$ref": "#/definitions/GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath" - ], - "type": "object" - }, - "LocalVolumeResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "GroupOwnerSetting": { - "$ref": "#/definitions/GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath", - "DestinationPath" - ], - "type": "object" - }, - "ResourceDataContainer": { - "additionalProperties": false, - "properties": { - "LocalDeviceResourceData": { - "$ref": "#/definitions/LocalDeviceResourceData" - }, - "LocalVolumeResourceData": { - "$ref": "#/definitions/LocalVolumeResourceData" - }, - "S3MachineLearningModelResourceData": { - "$ref": "#/definitions/S3MachineLearningModelResourceData" - }, - "SageMakerMachineLearningModelResourceData": { - "$ref": "#/definitions/SageMakerMachineLearningModelResourceData" - }, - "SecretsManagerSecretResourceData": { - "$ref": "#/definitions/SecretsManagerSecretResourceData" - } - }, - "type": "object" - }, - "ResourceDownloadOwnerSetting": { - "additionalProperties": false, - "properties": { - "GroupOwner": { - "type": "string" - }, - "GroupPermission": { - "type": "string" - } - }, - "required": [ - "GroupOwner", - "GroupPermission" - ], - "type": "object" - }, - "ResourceInstance": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceDataContainer": { - "$ref": "#/definitions/ResourceDataContainer" - } - }, - "required": [ - "ResourceDataContainer", - "Id", - "Name" - ], - "type": "object" - }, - "S3MachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/ResourceDownloadOwnerSetting" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "S3Uri" - ], - "type": "object" - }, - "SageMakerMachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/ResourceDownloadOwnerSetting" - }, - "SageMakerJobArn": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SageMakerJobArn" - ], - "type": "object" - }, - "SecretsManagerSecretResourceData": { - "additionalProperties": false, - "properties": { - "ARN": { - "type": "string" - }, - "AdditionalStagingLabelsToDownload": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::ResourceDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "ResourceDefinitionId": { - "type": "string" - }, - "Resources": { - "items": { - "$ref": "#/definitions/ResourceInstance" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Resources", - "ResourceDefinitionId" - ], - "typeName": "AWS::Greengrass::ResourceDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Resources", + "/properties/ResourceDefinitionId" + ], + "definitions": { + "GroupOwnerSetting": { + "additionalProperties": false, + "properties": { + "AutoAddGroupOwner": { + "type": "boolean" + }, + "GroupOwner": { + "type": "string" + } + }, + "required": [ + "AutoAddGroupOwner" + ], + "type": "object" + }, + "LocalDeviceResourceData": { + "additionalProperties": false, + "properties": { + "GroupOwnerSetting": { + "$ref": "#/definitions/GroupOwnerSetting" + }, + "SourcePath": { + "type": "string" + } + }, + "required": [ + "SourcePath" + ], + "type": "object" + }, + "LocalVolumeResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "GroupOwnerSetting": { + "$ref": "#/definitions/GroupOwnerSetting" + }, + "SourcePath": { + "type": "string" + } + }, + "required": [ + "SourcePath", + "DestinationPath" + ], + "type": "object" + }, + "ResourceDataContainer": { + "additionalProperties": false, + "properties": { + "LocalDeviceResourceData": { + "$ref": "#/definitions/LocalDeviceResourceData" + }, + "LocalVolumeResourceData": { + "$ref": "#/definitions/LocalVolumeResourceData" + }, + "S3MachineLearningModelResourceData": { + "$ref": "#/definitions/S3MachineLearningModelResourceData" + }, + "SageMakerMachineLearningModelResourceData": { + "$ref": "#/definitions/SageMakerMachineLearningModelResourceData" + }, + "SecretsManagerSecretResourceData": { + "$ref": "#/definitions/SecretsManagerSecretResourceData" + } + }, + "type": "object" + }, + "ResourceDownloadOwnerSetting": { + "additionalProperties": false, + "properties": { + "GroupOwner": { + "type": "string" + }, + "GroupPermission": { + "type": "string" + } + }, + "required": [ + "GroupOwner", + "GroupPermission" + ], + "type": "object" + }, + "ResourceInstance": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceDataContainer": { + "$ref": "#/definitions/ResourceDataContainer" + } + }, + "required": [ + "ResourceDataContainer", + "Id", + "Name" + ], + "type": "object" + }, + "S3MachineLearningModelResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "OwnerSetting": { + "$ref": "#/definitions/ResourceDownloadOwnerSetting" + }, + "S3Uri": { + "type": "string" + } + }, + "required": [ + "DestinationPath", + "S3Uri" + ], + "type": "object" + }, + "SageMakerMachineLearningModelResourceData": { + "additionalProperties": false, + "properties": { + "DestinationPath": { + "type": "string" + }, + "OwnerSetting": { + "$ref": "#/definitions/ResourceDownloadOwnerSetting" + }, + "SageMakerJobArn": { + "type": "string" + } + }, + "required": [ + "DestinationPath", + "SageMakerJobArn" + ], + "type": "object" + }, + "SecretsManagerSecretResourceData": { + "additionalProperties": false, + "properties": { + "ARN": { + "type": "string" + }, + "AdditionalStagingLabelsToDownload": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::ResourceDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "ResourceDefinitionId": { + "type": "string" + }, + "Resources": { + "items": { + "$ref": "#/definitions/ResourceInstance" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Resources", + "ResourceDefinitionId" + ], + "typeName": "AWS::Greengrass::ResourceDefinitionVersion" +} diff --git a/schema/aws-greengrass-subscriptiondefinition.json b/schema/aws-greengrass-subscriptiondefinition.json index 63ac8bc..51eadc4 100644 --- a/schema/aws-greengrass-subscriptiondefinition.json +++ b/schema/aws-greengrass-subscriptiondefinition.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InitialVersion" - ], - "definitions": { - "Subscription": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Target", - "Id", - "Source", - "Subject" - ], - "type": "object" - }, - "SubscriptionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Subscriptions": { - "items": { - "$ref": "#/definitions/Subscription" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Subscriptions" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::SubscriptionDefinition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InitialVersion": { - "$ref": "#/definitions/SubscriptionDefinitionVersion" - }, - "LatestVersionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/LatestVersionArn", - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Greengrass::SubscriptionDefinition" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InitialVersion" + ], + "definitions": { + "Subscription": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Source": { + "type": "string" + }, + "Subject": { + "type": "string" + }, + "Target": { + "type": "string" + } + }, + "required": [ + "Target", + "Id", + "Source", + "Subject" + ], + "type": "object" + }, + "SubscriptionDefinitionVersion": { + "additionalProperties": false, + "properties": { + "Subscriptions": { + "items": { + "$ref": "#/definitions/Subscription" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Subscriptions" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::SubscriptionDefinition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InitialVersion": { + "$ref": "#/definitions/SubscriptionDefinitionVersion" + }, + "LatestVersionArn": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/LatestVersionArn", + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Greengrass::SubscriptionDefinition" +} diff --git a/schema/aws-greengrass-subscriptiondefinitionversion.json b/schema/aws-greengrass-subscriptiondefinitionversion.json index f85a184..e66ec3d 100644 --- a/schema/aws-greengrass-subscriptiondefinitionversion.json +++ b/schema/aws-greengrass-subscriptiondefinitionversion.json @@ -1,60 +1,60 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Subscriptions", - "/properties/SubscriptionDefinitionId" - ], - "definitions": { - "Subscription": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Target", - "Id", - "Source", - "Subject" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Greengrass::SubscriptionDefinitionVersion", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "SubscriptionDefinitionId": { - "type": "string" - }, - "Subscriptions": { - "items": { - "$ref": "#/definitions/Subscription" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SubscriptionDefinitionId", - "Subscriptions" - ], - "typeName": "AWS::Greengrass::SubscriptionDefinitionVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Subscriptions", + "/properties/SubscriptionDefinitionId" + ], + "definitions": { + "Subscription": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Source": { + "type": "string" + }, + "Subject": { + "type": "string" + }, + "Target": { + "type": "string" + } + }, + "required": [ + "Target", + "Id", + "Source", + "Subject" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Greengrass::SubscriptionDefinitionVersion", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "SubscriptionDefinitionId": { + "type": "string" + }, + "Subscriptions": { + "items": { + "$ref": "#/definitions/Subscription" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SubscriptionDefinitionId", + "Subscriptions" + ], + "typeName": "AWS::Greengrass::SubscriptionDefinitionVersion" +} diff --git a/schema/aws-greengrassv2-componentversion.json b/schema/aws-greengrassv2-componentversion.json index 80d3a08..fa3b814 100644 --- a/schema/aws-greengrassv2-componentversion.json +++ b/schema/aws-greengrassv2-componentversion.json @@ -1,341 +1,341 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ComponentName", - "/properties/ComponentVersion" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LambdaFunction", - "/properties/InlineRecipe" - ], - "definitions": { - "ComponentDependencyRequirement": { - "additionalProperties": false, - "properties": { - "DependencyType": { - "enum": [ - "SOFT", - "HARD" - ], - "type": "string" - }, - "VersionRequirement": { - "type": "string" - } - }, - "type": "object" - }, - "ComponentPlatform": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "FilesystemPath": { - "type": "string" - }, - "LambdaAddGroupOwnerBoolean": { - "type": "boolean" - }, - "LambdaContainerParams": { - "additionalProperties": false, - "properties": { - "Devices": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LambdaDeviceMount" - }, - "type": "array" - }, - "MemorySizeInKB": { - "type": "integer" - }, - "MountROSysfs": { - "type": "boolean" - }, - "Volumes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LambdaVolumeMount" - }, - "type": "array" - } - }, - "type": "object" - }, - "LambdaDeviceMount": { - "additionalProperties": false, - "properties": { - "AddGroupOwner": { - "$ref": "#/definitions/LambdaAddGroupOwnerBoolean" - }, - "Path": { - "$ref": "#/definitions/FilesystemPath" - }, - "Permission": { - "$ref": "#/definitions/LambdaFilesystemPermission" - } - }, - "type": "object" - }, - "LambdaEventSource": { - "additionalProperties": false, - "properties": { - "Topic": { - "type": "string" - }, - "Type": { - "enum": [ - "PUB_SUB", - "IOT_CORE" - ], - "type": "string" - } - }, - "type": "object" - }, - "LambdaExecutionParameters": { - "additionalProperties": false, - "properties": { - "EnvironmentVariables": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "EventSources": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LambdaEventSource" - }, - "type": "array" - }, - "ExecArgs": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "InputPayloadEncodingType": { - "enum": [ - "json", - "binary" - ], - "type": "string" - }, - "LinuxProcessParams": { - "$ref": "#/definitions/LambdaLinuxProcessParams" - }, - "MaxIdleTimeInSeconds": { - "type": "integer" - }, - "MaxInstancesCount": { - "type": "integer" - }, - "MaxQueueSize": { - "type": "integer" - }, - "Pinned": { - "type": "boolean" - }, - "StatusTimeoutInSeconds": { - "type": "integer" - }, - "TimeoutInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "LambdaFilesystemPermission": { - "enum": [ - "ro", - "rw" - ], - "type": "string" - }, - "LambdaFunctionRecipeSource": { - "additionalProperties": false, - "properties": { - "ComponentDependencies": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "$ref": "#/definitions/ComponentDependencyRequirement" - } - }, - "type": "object" - }, - "ComponentLambdaParameters": { - "$ref": "#/definitions/LambdaExecutionParameters" - }, - "ComponentName": { - "type": "string" - }, - "ComponentPlatforms": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ComponentPlatform" - }, - "type": "array" - }, - "ComponentVersion": { - "type": "string" - }, - "LambdaArn": { - "pattern": "^arn:[^:]*:lambda:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - } - }, - "type": "object" - }, - "LambdaLinuxProcessParams": { - "additionalProperties": false, - "properties": { - "ContainerParams": { - "$ref": "#/definitions/LambdaContainerParams" - }, - "IsolationMode": { - "enum": [ - "GreengrassContainer", - "NoContainer" - ], - "type": "string" - } - }, - "type": "object" - }, - "LambdaVolumeMount": { - "additionalProperties": false, - "properties": { - "AddGroupOwner": { - "$ref": "#/definitions/LambdaAddGroupOwnerBoolean" - }, - "DestinationPath": { - "$ref": "#/definitions/FilesystemPath" - }, - "Permission": { - "$ref": "#/definitions/LambdaFilesystemPermission" - }, - "SourcePath": { - "$ref": "#/definitions/FilesystemPath" - } - }, - "type": "object" - } - }, - "description": "Resource for Greengrass component version.", - "handlers": { - "create": { - "permissions": [ - "greengrass:CreateComponentVersion", - "greengrass:DescribeComponent", - "greengrass:ListTagsForResource", - "greengrass:TagResource", - "lambda:GetFunction", - "s3:GetObject" - ] - }, - "delete": { - "permissions": [ - "greengrass:DeleteComponent" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "type": "string" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "greengrass:ListComponentVersions" - ] - }, - "read": { - "permissions": [ - "greengrass:DescribeComponent", - "greengrass:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "greengrass:DescribeComponent", - "greengrass:ListTagsForResource", - "greengrass:TagResource", - "greengrass:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ComponentName": { - "type": "string" - }, - "ComponentVersion": { - "type": "string" - }, - "InlineRecipe": { - "type": "string" - }, - "LambdaFunction": { - "$ref": "#/definitions/LambdaFunctionRecipeSource" - }, - "Tags": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^(?!aws:)[a-zA-Z+-=._:/]{1,128}$": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ComponentName", - "/properties/ComponentVersion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-greengrassv2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GreengrassV2::ComponentVersion", - "writeOnlyProperties": [ - "/properties/LambdaFunction", - "/properties/InlineRecipe" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ComponentName", + "/properties/ComponentVersion" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LambdaFunction", + "/properties/InlineRecipe" + ], + "definitions": { + "ComponentDependencyRequirement": { + "additionalProperties": false, + "properties": { + "DependencyType": { + "enum": [ + "SOFT", + "HARD" + ], + "type": "string" + }, + "VersionRequirement": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentPlatform": { + "additionalProperties": false, + "properties": { + "Attributes": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "FilesystemPath": { + "type": "string" + }, + "LambdaAddGroupOwnerBoolean": { + "type": "boolean" + }, + "LambdaContainerParams": { + "additionalProperties": false, + "properties": { + "Devices": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LambdaDeviceMount" + }, + "type": "array" + }, + "MemorySizeInKB": { + "type": "integer" + }, + "MountROSysfs": { + "type": "boolean" + }, + "Volumes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LambdaVolumeMount" + }, + "type": "array" + } + }, + "type": "object" + }, + "LambdaDeviceMount": { + "additionalProperties": false, + "properties": { + "AddGroupOwner": { + "$ref": "#/definitions/LambdaAddGroupOwnerBoolean" + }, + "Path": { + "$ref": "#/definitions/FilesystemPath" + }, + "Permission": { + "$ref": "#/definitions/LambdaFilesystemPermission" + } + }, + "type": "object" + }, + "LambdaEventSource": { + "additionalProperties": false, + "properties": { + "Topic": { + "type": "string" + }, + "Type": { + "enum": [ + "PUB_SUB", + "IOT_CORE" + ], + "type": "string" + } + }, + "type": "object" + }, + "LambdaExecutionParameters": { + "additionalProperties": false, + "properties": { + "EnvironmentVariables": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "EventSources": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LambdaEventSource" + }, + "type": "array" + }, + "ExecArgs": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "InputPayloadEncodingType": { + "enum": [ + "json", + "binary" + ], + "type": "string" + }, + "LinuxProcessParams": { + "$ref": "#/definitions/LambdaLinuxProcessParams" + }, + "MaxIdleTimeInSeconds": { + "type": "integer" + }, + "MaxInstancesCount": { + "type": "integer" + }, + "MaxQueueSize": { + "type": "integer" + }, + "Pinned": { + "type": "boolean" + }, + "StatusTimeoutInSeconds": { + "type": "integer" + }, + "TimeoutInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "LambdaFilesystemPermission": { + "enum": [ + "ro", + "rw" + ], + "type": "string" + }, + "LambdaFunctionRecipeSource": { + "additionalProperties": false, + "properties": { + "ComponentDependencies": { + "additionalProperties": false, + "patternProperties": { + ".*": { + "$ref": "#/definitions/ComponentDependencyRequirement" + } + }, + "type": "object" + }, + "ComponentLambdaParameters": { + "$ref": "#/definitions/LambdaExecutionParameters" + }, + "ComponentName": { + "type": "string" + }, + "ComponentPlatforms": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ComponentPlatform" + }, + "type": "array" + }, + "ComponentVersion": { + "type": "string" + }, + "LambdaArn": { + "pattern": "^arn:[^:]*:lambda:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + } + }, + "type": "object" + }, + "LambdaLinuxProcessParams": { + "additionalProperties": false, + "properties": { + "ContainerParams": { + "$ref": "#/definitions/LambdaContainerParams" + }, + "IsolationMode": { + "enum": [ + "GreengrassContainer", + "NoContainer" + ], + "type": "string" + } + }, + "type": "object" + }, + "LambdaVolumeMount": { + "additionalProperties": false, + "properties": { + "AddGroupOwner": { + "$ref": "#/definitions/LambdaAddGroupOwnerBoolean" + }, + "DestinationPath": { + "$ref": "#/definitions/FilesystemPath" + }, + "Permission": { + "$ref": "#/definitions/LambdaFilesystemPermission" + }, + "SourcePath": { + "$ref": "#/definitions/FilesystemPath" + } + }, + "type": "object" + } + }, + "description": "Resource for Greengrass component version.", + "handlers": { + "create": { + "permissions": [ + "greengrass:CreateComponentVersion", + "greengrass:DescribeComponent", + "greengrass:ListTagsForResource", + "greengrass:TagResource", + "lambda:GetFunction", + "s3:GetObject" + ] + }, + "delete": { + "permissions": [ + "greengrass:DeleteComponent" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "type": "string" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "greengrass:ListComponentVersions" + ] + }, + "read": { + "permissions": [ + "greengrass:DescribeComponent", + "greengrass:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "greengrass:DescribeComponent", + "greengrass:ListTagsForResource", + "greengrass:TagResource", + "greengrass:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ComponentName": { + "type": "string" + }, + "ComponentVersion": { + "type": "string" + }, + "InlineRecipe": { + "type": "string" + }, + "LambdaFunction": { + "$ref": "#/definitions/LambdaFunctionRecipeSource" + }, + "Tags": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^(?!aws:)[a-zA-Z+-=._:/]{1,128}$": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ComponentName", + "/properties/ComponentVersion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-greengrassv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GreengrassV2::ComponentVersion", + "writeOnlyProperties": [ + "/properties/LambdaFunction", + "/properties/InlineRecipe" + ] +} diff --git a/schema/aws-greengrassv2-deployment.json b/schema/aws-greengrassv2-deployment.json index ca5f3a9..094ea77 100644 --- a/schema/aws-greengrassv2-deployment.json +++ b/schema/aws-greengrassv2-deployment.json @@ -1,393 +1,393 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetArn", - "/properties/ParentTargetArn", - "/properties/DeploymentName", - "/properties/Components", - "/properties/IotJobConfiguration", - "/properties/DeploymentPolicies" - ], - "definitions": { - "ComponentConfigurationUpdate": { - "additionalProperties": false, - "properties": { - "Merge": { - "maxLength": 10485760, - "minLength": 1, - "type": "string" - }, - "Reset": { - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ComponentDeploymentSpecification": { - "additionalProperties": false, - "properties": { - "ComponentVersion": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ConfigurationUpdate": { - "$ref": "#/definitions/ComponentConfigurationUpdate" - }, - "RunWith": { - "$ref": "#/definitions/ComponentRunWith" - } - }, - "type": "object" - }, - "ComponentRunWith": { - "additionalProperties": false, - "properties": { - "PosixUser": { - "minLength": 1, - "type": "string" - }, - "SystemResourceLimits": { - "$ref": "#/definitions/SystemResourceLimits" - }, - "WindowsUser": { - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DeploymentComponentUpdatePolicy": { - "additionalProperties": false, - "properties": { - "Action": { - "enum": [ - "NOTIFY_COMPONENTS", - "SKIP_NOTIFY_COMPONENTS" - ], - "type": "string" - }, - "TimeoutInSeconds": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "DeploymentConfigurationValidationPolicy": { - "additionalProperties": false, - "properties": { - "TimeoutInSeconds": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "DeploymentIoTJobConfiguration": { - "additionalProperties": false, - "properties": { - "AbortConfig": { - "$ref": "#/definitions/IoTJobAbortConfig" - }, - "JobExecutionsRolloutConfig": { - "$ref": "#/definitions/IoTJobExecutionsRolloutConfig" - }, - "TimeoutConfig": { - "$ref": "#/definitions/IoTJobTimeoutConfig" - } - }, - "type": "object" - }, - "DeploymentPolicies": { - "additionalProperties": false, - "properties": { - "ComponentUpdatePolicy": { - "$ref": "#/definitions/DeploymentComponentUpdatePolicy" - }, - "ConfigurationValidationPolicy": { - "$ref": "#/definitions/DeploymentConfigurationValidationPolicy" - }, - "FailureHandlingPolicy": { - "enum": [ - "ROLLBACK", - "DO_NOTHING" - ], - "type": "string" - } - }, - "type": "object" - }, - "IoTJobAbortConfig": { - "additionalProperties": false, - "properties": { - "CriteriaList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IoTJobAbortCriteria" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "CriteriaList" - ], - "type": "object" - }, - "IoTJobAbortCriteria": { - "additionalProperties": false, - "properties": { - "Action": { - "enum": [ - "CANCEL" - ], - "type": "string" - }, - "FailureType": { - "enum": [ - "FAILED", - "REJECTED", - "TIMED_OUT", - "ALL" - ], - "type": "string" - }, - "MinNumberOfExecutedThings": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "ThresholdPercentage": { - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "FailureType", - "Action", - "ThresholdPercentage", - "MinNumberOfExecutedThings" - ], - "type": "object" - }, - "IoTJobExecutionsRolloutConfig": { - "additionalProperties": false, - "properties": { - "ExponentialRate": { - "$ref": "#/definitions/IoTJobExponentialRolloutRate" - }, - "MaximumPerMinute": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "IoTJobExponentialRolloutRate": { - "additionalProperties": false, - "properties": { - "BaseRatePerMinute": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "IncrementFactor": { - "maximum": 5, - "minimum": 1, - "type": "number" - }, - "RateIncreaseCriteria": { - "$ref": "#/definitions/IoTJobRateIncreaseCriteria" - } - }, - "required": [ - "BaseRatePerMinute", - "IncrementFactor", - "RateIncreaseCriteria" - ], - "type": "object" - }, - "IoTJobRateIncreaseCriteria": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "NumberOfNotifiedThings": { - "$ref": "#/definitions/NumberOfThings" - } - }, - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "NumberOfSucceededThings": { - "$ref": "#/definitions/NumberOfThings" - } - }, - "type": "object" - } - ], - "type": "object" - }, - "IoTJobTimeoutConfig": { - "additionalProperties": false, - "properties": { - "InProgressTimeoutInMinutes": { - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "NumberOfThings": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "SystemResourceLimits": { - "additionalProperties": false, - "properties": { - "Cpus": { - "minimum": 0, - "type": "number" - }, - "Memory": { - "format": "int64", - "maximum": 9223372036854771712, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource for Greengrass V2 deployment.", - "handlers": { - "create": { - "permissions": [ - "greengrass:CreateDeployment", - "greengrass:GetDeployment", - "greengrass:TagResource", - "iot:CancelJob", - "iot:CreateJob", - "iot:DeleteThingShadow", - "iot:DescribeJob", - "iot:DescribeThing", - "iot:DescribeThingGroup", - "iot:GetThingShadow", - "iot:UpdateJob", - "iot:UpdateThingShadow" - ] - }, - "delete": { - "permissions": [ - "greengrass:DeleteDeployment", - "greengrass:CancelDeployment", - "iot:CancelJob", - "iot:DeleteJob", - "iot:DescribeJob" - ] - }, - "list": { - "permissions": [ - "greengrass:ListDeployments", - "iot:DescribeJob", - "iot:DescribeThing", - "iot:DescribeThingGroup", - "iot:GetThingShadow" - ] - }, - "read": { - "permissions": [ - "greengrass:GetDeployment", - "iot:DescribeJob", - "iot:DescribeThing", - "iot:DescribeThingGroup", - "iot:GetThingShadow" - ] - }, - "update": { - "permissions": [ - "greengrass:GetDeployment", - "greengrass:TagResource", - "greengrass:UntagResource", - "iot:DescribeJob" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeploymentId" - ], - "properties": { - "Components": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/ComponentDeploymentSpecification" - } - }, - "type": "object" - }, - "DeploymentId": { - "pattern": ".+", - "type": "string" - }, - "DeploymentName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "DeploymentPolicies": { - "$ref": "#/definitions/DeploymentPolicies" - }, - "IotJobConfiguration": { - "$ref": "#/definitions/DeploymentIoTJobConfiguration" - }, - "ParentTargetArn": { - "pattern": "arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "maxProperties": 200, - "patternProperties": { - ".*": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "TargetArn": { - "pattern": "arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DeploymentId" - ], - "required": [ - "TargetArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GreengrassV2::Deployment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetArn", + "/properties/ParentTargetArn", + "/properties/DeploymentName", + "/properties/Components", + "/properties/IotJobConfiguration", + "/properties/DeploymentPolicies" + ], + "definitions": { + "ComponentConfigurationUpdate": { + "additionalProperties": false, + "properties": { + "Merge": { + "maxLength": 10485760, + "minLength": 1, + "type": "string" + }, + "Reset": { + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComponentDeploymentSpecification": { + "additionalProperties": false, + "properties": { + "ComponentVersion": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ConfigurationUpdate": { + "$ref": "#/definitions/ComponentConfigurationUpdate" + }, + "RunWith": { + "$ref": "#/definitions/ComponentRunWith" + } + }, + "type": "object" + }, + "ComponentRunWith": { + "additionalProperties": false, + "properties": { + "PosixUser": { + "minLength": 1, + "type": "string" + }, + "SystemResourceLimits": { + "$ref": "#/definitions/SystemResourceLimits" + }, + "WindowsUser": { + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DeploymentComponentUpdatePolicy": { + "additionalProperties": false, + "properties": { + "Action": { + "enum": [ + "NOTIFY_COMPONENTS", + "SKIP_NOTIFY_COMPONENTS" + ], + "type": "string" + }, + "TimeoutInSeconds": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "DeploymentConfigurationValidationPolicy": { + "additionalProperties": false, + "properties": { + "TimeoutInSeconds": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "DeploymentIoTJobConfiguration": { + "additionalProperties": false, + "properties": { + "AbortConfig": { + "$ref": "#/definitions/IoTJobAbortConfig" + }, + "JobExecutionsRolloutConfig": { + "$ref": "#/definitions/IoTJobExecutionsRolloutConfig" + }, + "TimeoutConfig": { + "$ref": "#/definitions/IoTJobTimeoutConfig" + } + }, + "type": "object" + }, + "DeploymentPolicies": { + "additionalProperties": false, + "properties": { + "ComponentUpdatePolicy": { + "$ref": "#/definitions/DeploymentComponentUpdatePolicy" + }, + "ConfigurationValidationPolicy": { + "$ref": "#/definitions/DeploymentConfigurationValidationPolicy" + }, + "FailureHandlingPolicy": { + "enum": [ + "ROLLBACK", + "DO_NOTHING" + ], + "type": "string" + } + }, + "type": "object" + }, + "IoTJobAbortConfig": { + "additionalProperties": false, + "properties": { + "CriteriaList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IoTJobAbortCriteria" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "CriteriaList" + ], + "type": "object" + }, + "IoTJobAbortCriteria": { + "additionalProperties": false, + "properties": { + "Action": { + "enum": [ + "CANCEL" + ], + "type": "string" + }, + "FailureType": { + "enum": [ + "FAILED", + "REJECTED", + "TIMED_OUT", + "ALL" + ], + "type": "string" + }, + "MinNumberOfExecutedThings": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "ThresholdPercentage": { + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "FailureType", + "Action", + "ThresholdPercentage", + "MinNumberOfExecutedThings" + ], + "type": "object" + }, + "IoTJobExecutionsRolloutConfig": { + "additionalProperties": false, + "properties": { + "ExponentialRate": { + "$ref": "#/definitions/IoTJobExponentialRolloutRate" + }, + "MaximumPerMinute": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "IoTJobExponentialRolloutRate": { + "additionalProperties": false, + "properties": { + "BaseRatePerMinute": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "IncrementFactor": { + "maximum": 5, + "minimum": 1, + "type": "number" + }, + "RateIncreaseCriteria": { + "$ref": "#/definitions/IoTJobRateIncreaseCriteria" + } + }, + "required": [ + "BaseRatePerMinute", + "IncrementFactor", + "RateIncreaseCriteria" + ], + "type": "object" + }, + "IoTJobRateIncreaseCriteria": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "NumberOfNotifiedThings": { + "$ref": "#/definitions/NumberOfThings" + } + }, + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "NumberOfSucceededThings": { + "$ref": "#/definitions/NumberOfThings" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "IoTJobTimeoutConfig": { + "additionalProperties": false, + "properties": { + "InProgressTimeoutInMinutes": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "NumberOfThings": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "SystemResourceLimits": { + "additionalProperties": false, + "properties": { + "Cpus": { + "minimum": 0, + "type": "number" + }, + "Memory": { + "format": "int64", + "maximum": 9223372036854771712, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource for Greengrass V2 deployment.", + "handlers": { + "create": { + "permissions": [ + "greengrass:CreateDeployment", + "greengrass:GetDeployment", + "greengrass:TagResource", + "iot:CancelJob", + "iot:CreateJob", + "iot:DeleteThingShadow", + "iot:DescribeJob", + "iot:DescribeThing", + "iot:DescribeThingGroup", + "iot:GetThingShadow", + "iot:UpdateJob", + "iot:UpdateThingShadow" + ] + }, + "delete": { + "permissions": [ + "greengrass:DeleteDeployment", + "greengrass:CancelDeployment", + "iot:CancelJob", + "iot:DeleteJob", + "iot:DescribeJob" + ] + }, + "list": { + "permissions": [ + "greengrass:ListDeployments", + "iot:DescribeJob", + "iot:DescribeThing", + "iot:DescribeThingGroup", + "iot:GetThingShadow" + ] + }, + "read": { + "permissions": [ + "greengrass:GetDeployment", + "iot:DescribeJob", + "iot:DescribeThing", + "iot:DescribeThingGroup", + "iot:GetThingShadow" + ] + }, + "update": { + "permissions": [ + "greengrass:GetDeployment", + "greengrass:TagResource", + "greengrass:UntagResource", + "iot:DescribeJob" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeploymentId" + ], + "properties": { + "Components": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/ComponentDeploymentSpecification" + } + }, + "type": "object" + }, + "DeploymentId": { + "pattern": ".+", + "type": "string" + }, + "DeploymentName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DeploymentPolicies": { + "$ref": "#/definitions/DeploymentPolicies" + }, + "IotJobConfiguration": { + "$ref": "#/definitions/DeploymentIoTJobConfiguration" + }, + "ParentTargetArn": { + "pattern": "arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "maxProperties": 200, + "patternProperties": { + ".*": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "TargetArn": { + "pattern": "arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DeploymentId" + ], + "required": [ + "TargetArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GreengrassV2::Deployment" +} diff --git a/schema/aws-groundstation-config.json b/schema/aws-groundstation-config.json index 2da39a7..43ee2a1 100644 --- a/schema/aws-groundstation-config.json +++ b/schema/aws-groundstation-config.json @@ -1,342 +1,342 @@ -{ - "additionalProperties": false, - "definitions": { - "AntennaDownlinkConfig": { - "additionalProperties": false, - "properties": { - "SpectrumConfig": { - "$ref": "#/definitions/SpectrumConfig" - } - }, - "type": "object" - }, - "AntennaDownlinkDemodDecodeConfig": { - "additionalProperties": false, - "properties": { - "DecodeConfig": { - "$ref": "#/definitions/DecodeConfig" - }, - "DemodulationConfig": { - "$ref": "#/definitions/DemodulationConfig" - }, - "SpectrumConfig": { - "$ref": "#/definitions/SpectrumConfig" - } - }, - "type": "object" - }, - "AntennaUplinkConfig": { - "additionalProperties": false, - "properties": { - "SpectrumConfig": { - "$ref": "#/definitions/UplinkSpectrumConfig" - }, - "TargetEirp": { - "$ref": "#/definitions/Eirp" - }, - "TransmitDisabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "BandwidthUnits": { - "enum": [ - "GHz", - "MHz", - "kHz" - ], - "type": "string" - }, - "BucketArn": { - "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$", - "type": "string" - }, - "ConfigData": { - "additionalProperties": false, - "maxProperties": 1, - "minProperties": 1, - "properties": { - "AntennaDownlinkConfig": { - "$ref": "#/definitions/AntennaDownlinkConfig" - }, - "AntennaDownlinkDemodDecodeConfig": { - "$ref": "#/definitions/AntennaDownlinkDemodDecodeConfig" - }, - "AntennaUplinkConfig": { - "$ref": "#/definitions/AntennaUplinkConfig" - }, - "DataflowEndpointConfig": { - "$ref": "#/definitions/DataflowEndpointConfig" - }, - "S3RecordingConfig": { - "$ref": "#/definitions/S3RecordingConfig" - }, - "TrackingConfig": { - "$ref": "#/definitions/TrackingConfig" - }, - "UplinkEchoConfig": { - "$ref": "#/definitions/UplinkEchoConfig" - } - }, - "type": "object" - }, - "DataflowEndpointConfig": { - "additionalProperties": false, - "properties": { - "DataflowEndpointName": { - "type": "string" - }, - "DataflowEndpointRegion": { - "type": "string" - } - }, - "type": "object" - }, - "DecodeConfig": { - "additionalProperties": false, - "properties": { - "UnvalidatedJSON": { - "$ref": "#/definitions/JsonString" - } - }, - "type": "object" - }, - "DemodulationConfig": { - "additionalProperties": false, - "properties": { - "UnvalidatedJSON": { - "$ref": "#/definitions/JsonString" - } - }, - "type": "object" - }, - "Eirp": { - "additionalProperties": false, - "properties": { - "Units": { - "$ref": "#/definitions/EirpUnits" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "EirpUnits": { - "enum": [ - "dBW" - ], - "type": "string" - }, - "Frequency": { - "additionalProperties": false, - "properties": { - "Units": { - "$ref": "#/definitions/FrequencyUnits" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "FrequencyBandwidth": { - "additionalProperties": false, - "properties": { - "Units": { - "$ref": "#/definitions/BandwidthUnits" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "FrequencyUnits": { - "enum": [ - "GHz", - "MHz", - "kHz" - ], - "type": "string" - }, - "JsonString": { - "pattern": "^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{1,8192}$", - "type": "string" - }, - "Polarization": { - "enum": [ - "LEFT_HAND", - "RIGHT_HAND", - "NONE" - ], - "type": "string" - }, - "RoleArn": { - "pattern": "^arn:[^:\\n]+:iam::[^:\\n]+:role\\/.+$", - "type": "string" - }, - "S3KeyPrefix": { - "pattern": "^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$", - "type": "string" - }, - "S3RecordingConfig": { - "additionalProperties": false, - "properties": { - "BucketArn": { - "$ref": "#/definitions/BucketArn" - }, - "Prefix": { - "$ref": "#/definitions/S3KeyPrefix" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - } - }, - "type": "object" - }, - "SpectrumConfig": { - "additionalProperties": false, - "properties": { - "Bandwidth": { - "$ref": "#/definitions/FrequencyBandwidth" - }, - "CenterFrequency": { - "$ref": "#/definitions/Frequency" - }, - "Polarization": { - "$ref": "#/definitions/Polarization" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", - "type": "string" - }, - "Value": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", - "type": "string" - } - }, - "type": "object" - }, - "TrackingConfig": { - "additionalProperties": false, - "properties": { - "Autotrack": { - "enum": [ - "REQUIRED", - "PREFERRED", - "REMOVED" - ], - "type": "string" - } - }, - "type": "object" - }, - "UplinkEchoConfig": { - "additionalProperties": false, - "properties": { - "AntennaUplinkConfigArn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "UplinkSpectrumConfig": { - "additionalProperties": false, - "properties": { - "CenterFrequency": { - "$ref": "#/definitions/Frequency" - }, - "Polarization": { - "$ref": "#/definitions/Polarization" - } - }, - "type": "object" - } - }, - "description": "AWS Ground Station config resource type for CloudFormation.", - "handlers": { - "create": { - "permissions": [ - "groundstation:CreateConfig", - "groundstation:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "groundstation:DeleteConfig" - ] - }, - "list": { - "permissions": [ - "groundstation:ListConfigs" - ] - }, - "read": { - "permissions": [ - "groundstation:GetConfig", - "groundstation:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "groundstation:UpdateConfig", - "groundstation:ListTagsForResource", - "groundstation:TagResource", - "groundstation:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "ConfigData": { - "$ref": "#/definitions/ConfigData" - }, - "Id": { - "type": "string" - }, - "Name": { - "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/Type" - ], - "required": [ - "Name", - "ConfigData" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", - "typeName": "AWS::GroundStation::Config" -} +{ + "additionalProperties": false, + "definitions": { + "AntennaDownlinkConfig": { + "additionalProperties": false, + "properties": { + "SpectrumConfig": { + "$ref": "#/definitions/SpectrumConfig" + } + }, + "type": "object" + }, + "AntennaDownlinkDemodDecodeConfig": { + "additionalProperties": false, + "properties": { + "DecodeConfig": { + "$ref": "#/definitions/DecodeConfig" + }, + "DemodulationConfig": { + "$ref": "#/definitions/DemodulationConfig" + }, + "SpectrumConfig": { + "$ref": "#/definitions/SpectrumConfig" + } + }, + "type": "object" + }, + "AntennaUplinkConfig": { + "additionalProperties": false, + "properties": { + "SpectrumConfig": { + "$ref": "#/definitions/UplinkSpectrumConfig" + }, + "TargetEirp": { + "$ref": "#/definitions/Eirp" + }, + "TransmitDisabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "BandwidthUnits": { + "enum": [ + "GHz", + "MHz", + "kHz" + ], + "type": "string" + }, + "BucketArn": { + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$", + "type": "string" + }, + "ConfigData": { + "additionalProperties": false, + "maxProperties": 1, + "minProperties": 1, + "properties": { + "AntennaDownlinkConfig": { + "$ref": "#/definitions/AntennaDownlinkConfig" + }, + "AntennaDownlinkDemodDecodeConfig": { + "$ref": "#/definitions/AntennaDownlinkDemodDecodeConfig" + }, + "AntennaUplinkConfig": { + "$ref": "#/definitions/AntennaUplinkConfig" + }, + "DataflowEndpointConfig": { + "$ref": "#/definitions/DataflowEndpointConfig" + }, + "S3RecordingConfig": { + "$ref": "#/definitions/S3RecordingConfig" + }, + "TrackingConfig": { + "$ref": "#/definitions/TrackingConfig" + }, + "UplinkEchoConfig": { + "$ref": "#/definitions/UplinkEchoConfig" + } + }, + "type": "object" + }, + "DataflowEndpointConfig": { + "additionalProperties": false, + "properties": { + "DataflowEndpointName": { + "type": "string" + }, + "DataflowEndpointRegion": { + "type": "string" + } + }, + "type": "object" + }, + "DecodeConfig": { + "additionalProperties": false, + "properties": { + "UnvalidatedJSON": { + "$ref": "#/definitions/JsonString" + } + }, + "type": "object" + }, + "DemodulationConfig": { + "additionalProperties": false, + "properties": { + "UnvalidatedJSON": { + "$ref": "#/definitions/JsonString" + } + }, + "type": "object" + }, + "Eirp": { + "additionalProperties": false, + "properties": { + "Units": { + "$ref": "#/definitions/EirpUnits" + }, + "Value": { + "type": "number" + } + }, + "type": "object" + }, + "EirpUnits": { + "enum": [ + "dBW" + ], + "type": "string" + }, + "Frequency": { + "additionalProperties": false, + "properties": { + "Units": { + "$ref": "#/definitions/FrequencyUnits" + }, + "Value": { + "type": "number" + } + }, + "type": "object" + }, + "FrequencyBandwidth": { + "additionalProperties": false, + "properties": { + "Units": { + "$ref": "#/definitions/BandwidthUnits" + }, + "Value": { + "type": "number" + } + }, + "type": "object" + }, + "FrequencyUnits": { + "enum": [ + "GHz", + "MHz", + "kHz" + ], + "type": "string" + }, + "JsonString": { + "pattern": "^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{1,8192}$", + "type": "string" + }, + "Polarization": { + "enum": [ + "LEFT_HAND", + "RIGHT_HAND", + "NONE" + ], + "type": "string" + }, + "RoleArn": { + "pattern": "^arn:[^:\\n]+:iam::[^:\\n]+:role\\/.+$", + "type": "string" + }, + "S3KeyPrefix": { + "pattern": "^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$", + "type": "string" + }, + "S3RecordingConfig": { + "additionalProperties": false, + "properties": { + "BucketArn": { + "$ref": "#/definitions/BucketArn" + }, + "Prefix": { + "$ref": "#/definitions/S3KeyPrefix" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + } + }, + "type": "object" + }, + "SpectrumConfig": { + "additionalProperties": false, + "properties": { + "Bandwidth": { + "$ref": "#/definitions/FrequencyBandwidth" + }, + "CenterFrequency": { + "$ref": "#/definitions/Frequency" + }, + "Polarization": { + "$ref": "#/definitions/Polarization" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", + "type": "string" + }, + "Value": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", + "type": "string" + } + }, + "type": "object" + }, + "TrackingConfig": { + "additionalProperties": false, + "properties": { + "Autotrack": { + "enum": [ + "REQUIRED", + "PREFERRED", + "REMOVED" + ], + "type": "string" + } + }, + "type": "object" + }, + "UplinkEchoConfig": { + "additionalProperties": false, + "properties": { + "AntennaUplinkConfigArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "UplinkSpectrumConfig": { + "additionalProperties": false, + "properties": { + "CenterFrequency": { + "$ref": "#/definitions/Frequency" + }, + "Polarization": { + "$ref": "#/definitions/Polarization" + } + }, + "type": "object" + } + }, + "description": "AWS Ground Station config resource type for CloudFormation.", + "handlers": { + "create": { + "permissions": [ + "groundstation:CreateConfig", + "groundstation:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "groundstation:DeleteConfig" + ] + }, + "list": { + "permissions": [ + "groundstation:ListConfigs" + ] + }, + "read": { + "permissions": [ + "groundstation:GetConfig", + "groundstation:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "groundstation:UpdateConfig", + "groundstation:ListTagsForResource", + "groundstation:TagResource", + "groundstation:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "ConfigData": { + "$ref": "#/definitions/ConfigData" + }, + "Id": { + "type": "string" + }, + "Name": { + "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/Type" + ], + "required": [ + "Name", + "ConfigData" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", + "typeName": "AWS::GroundStation::Config" +} diff --git a/schema/aws-groundstation-dataflowendpointgroup.json b/schema/aws-groundstation-dataflowendpointgroup.json index f037662..905626f 100644 --- a/schema/aws-groundstation-dataflowendpointgroup.json +++ b/schema/aws-groundstation-dataflowendpointgroup.json @@ -1,273 +1,273 @@ -{ - "additionalProperties": false, - "definitions": { - "AgentStatus": { - "description": "The status of AgentEndpoint.", - "enum": [ - "SUCCESS", - "FAILED", - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "AuditResults": { - "description": "The results of the audit.", - "enum": [ - "HEALTHY", - "UNHEALTHY" - ], - "type": "string" - }, - "AwsGroundStationAgentEndpoint": { - "additionalProperties": false, - "description": "Information about AwsGroundStationAgentEndpoint.", - "properties": { - "AgentStatus": { - "$ref": "#/definitions/AgentStatus" - }, - "AuditResults": { - "$ref": "#/definitions/AuditResults" - }, - "EgressAddress": { - "$ref": "#/definitions/ConnectionDetails" - }, - "IngressAddress": { - "$ref": "#/definitions/RangedConnectionDetails" - }, - "Name": { - "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", - "type": "string" - } - }, - "type": "object" - }, - "ConnectionDetails": { - "additionalProperties": false, - "description": "Egress address of AgentEndpoint with an optional mtu.", - "properties": { - "Mtu": { - "description": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.", - "type": "integer" - }, - "SocketAddress": { - "$ref": "#/definitions/SocketAddress" - } - }, - "type": "object" - }, - "DataflowEndpoint": { - "additionalProperties": false, - "properties": { - "Address": { - "$ref": "#/definitions/SocketAddress" - }, - "Mtu": { - "type": "integer" - }, - "Name": { - "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", - "type": "string" - } - }, - "type": "object" - }, - "EndpointDetails": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "Endpoint", - "SecurityDetails" - ] - }, - { - "required": [ - "AwsGroundStationAgentEndpoint" - ] - } - ], - "properties": { - "AwsGroundStationAgentEndpoint": { - "$ref": "#/definitions/AwsGroundStationAgentEndpoint" - }, - "Endpoint": { - "$ref": "#/definitions/DataflowEndpoint" - }, - "SecurityDetails": { - "$ref": "#/definitions/SecurityDetails" - } - }, - "type": "object" - }, - "IntegerRange": { - "additionalProperties": false, - "description": "An integer range that has a minimum and maximum value.", - "properties": { - "Maximum": { - "description": "A maximum value.", - "type": "integer" - }, - "Minimum": { - "description": "A minimum value.", - "type": "integer" - } - }, - "type": "object" - }, - "RangedConnectionDetails": { - "additionalProperties": false, - "description": "Ingress address of AgentEndpoint with a port range and an optional mtu.", - "properties": { - "Mtu": { - "description": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.", - "type": "integer" - }, - "SocketAddress": { - "$ref": "#/definitions/RangedSocketAddress" - } - }, - "type": "object" - }, - "RangedSocketAddress": { - "additionalProperties": false, - "description": "A socket address with a port range.", - "properties": { - "Name": { - "description": "IPv4 socket address.", - "type": "string" - }, - "PortRange": { - "$ref": "#/definitions/IntegerRange", - "description": "Port range of a socket address." - } - }, - "type": "object" - }, - "SecurityDetails": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "SocketAddress": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Port": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", - "type": "string" - }, - "Value": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS Ground Station DataflowEndpointGroup schema for CloudFormation", - "handlers": { - "create": { - "permissions": [ - "groundstation:CreateDataflowEndpointGroup", - "groundstation:GetDataflowEndpointGroup", - "groundstation:TagResource", - "iam:PassRole", - "ec2:describeAddresses", - "ec2:describeNetworkInterfaces", - "iam:createServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "groundstation:DeleteDataflowEndpointGroup", - "groundstation:GetDataflowEndpointGroup" - ] - }, - "list": { - "permissions": [ - "groundstation:ListDataflowEndpointGroups" - ] - }, - "read": { - "permissions": [ - "groundstation:GetDataflowEndpointGroup", - "groundstation:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "ContactPostPassDurationSeconds": { - "description": "Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.", - "type": "integer" - }, - "ContactPrePassDurationSeconds": { - "description": "Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.", - "type": "integer" - }, - "EndpointDetails": { - "items": { - "$ref": "#/definitions/EndpointDetails" - }, - "minItems": 1, - "type": "array" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "EndpointDetails" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", - "typeName": "AWS::GroundStation::DataflowEndpointGroup" -} +{ + "additionalProperties": false, + "definitions": { + "AgentStatus": { + "description": "The status of AgentEndpoint.", + "enum": [ + "SUCCESS", + "FAILED", + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "AuditResults": { + "description": "The results of the audit.", + "enum": [ + "HEALTHY", + "UNHEALTHY" + ], + "type": "string" + }, + "AwsGroundStationAgentEndpoint": { + "additionalProperties": false, + "description": "Information about AwsGroundStationAgentEndpoint.", + "properties": { + "AgentStatus": { + "$ref": "#/definitions/AgentStatus" + }, + "AuditResults": { + "$ref": "#/definitions/AuditResults" + }, + "EgressAddress": { + "$ref": "#/definitions/ConnectionDetails" + }, + "IngressAddress": { + "$ref": "#/definitions/RangedConnectionDetails" + }, + "Name": { + "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionDetails": { + "additionalProperties": false, + "description": "Egress address of AgentEndpoint with an optional mtu.", + "properties": { + "Mtu": { + "description": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.", + "type": "integer" + }, + "SocketAddress": { + "$ref": "#/definitions/SocketAddress" + } + }, + "type": "object" + }, + "DataflowEndpoint": { + "additionalProperties": false, + "properties": { + "Address": { + "$ref": "#/definitions/SocketAddress" + }, + "Mtu": { + "type": "integer" + }, + "Name": { + "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", + "type": "string" + } + }, + "type": "object" + }, + "EndpointDetails": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "Endpoint", + "SecurityDetails" + ] + }, + { + "required": [ + "AwsGroundStationAgentEndpoint" + ] + } + ], + "properties": { + "AwsGroundStationAgentEndpoint": { + "$ref": "#/definitions/AwsGroundStationAgentEndpoint" + }, + "Endpoint": { + "$ref": "#/definitions/DataflowEndpoint" + }, + "SecurityDetails": { + "$ref": "#/definitions/SecurityDetails" + } + }, + "type": "object" + }, + "IntegerRange": { + "additionalProperties": false, + "description": "An integer range that has a minimum and maximum value.", + "properties": { + "Maximum": { + "description": "A maximum value.", + "type": "integer" + }, + "Minimum": { + "description": "A minimum value.", + "type": "integer" + } + }, + "type": "object" + }, + "RangedConnectionDetails": { + "additionalProperties": false, + "description": "Ingress address of AgentEndpoint with a port range and an optional mtu.", + "properties": { + "Mtu": { + "description": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.", + "type": "integer" + }, + "SocketAddress": { + "$ref": "#/definitions/RangedSocketAddress" + } + }, + "type": "object" + }, + "RangedSocketAddress": { + "additionalProperties": false, + "description": "A socket address with a port range.", + "properties": { + "Name": { + "description": "IPv4 socket address.", + "type": "string" + }, + "PortRange": { + "$ref": "#/definitions/IntegerRange", + "description": "Port range of a socket address." + } + }, + "type": "object" + }, + "SecurityDetails": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SocketAddress": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Port": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", + "type": "string" + }, + "Value": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS Ground Station DataflowEndpointGroup schema for CloudFormation", + "handlers": { + "create": { + "permissions": [ + "groundstation:CreateDataflowEndpointGroup", + "groundstation:GetDataflowEndpointGroup", + "groundstation:TagResource", + "iam:PassRole", + "ec2:describeAddresses", + "ec2:describeNetworkInterfaces", + "iam:createServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "groundstation:DeleteDataflowEndpointGroup", + "groundstation:GetDataflowEndpointGroup" + ] + }, + "list": { + "permissions": [ + "groundstation:ListDataflowEndpointGroups" + ] + }, + "read": { + "permissions": [ + "groundstation:GetDataflowEndpointGroup", + "groundstation:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "ContactPostPassDurationSeconds": { + "description": "Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.", + "type": "integer" + }, + "ContactPrePassDurationSeconds": { + "description": "Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.", + "type": "integer" + }, + "EndpointDetails": { + "items": { + "$ref": "#/definitions/EndpointDetails" + }, + "minItems": 1, + "type": "array" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "EndpointDetails" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", + "typeName": "AWS::GroundStation::DataflowEndpointGroup" +} diff --git a/schema/aws-groundstation-missionprofile.json b/schema/aws-groundstation-missionprofile.json index c4c11aa..02f5036 100644 --- a/schema/aws-groundstation-missionprofile.json +++ b/schema/aws-groundstation-missionprofile.json @@ -1,177 +1,177 @@ -{ - "additionalProperties": false, - "definitions": { - "DataflowEdge": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - }, - "Source": { - "type": "string" - } - }, - "type": "object" - }, - "StreamsKmsKey": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "KmsKeyArn" - ] - }, - { - "required": [ - "KmsAliasArn" - ] - } - ], - "properties": { - "KmsAliasArn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "KmsKeyArn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", - "type": "string" - }, - "Value": { - "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS Ground Station Mission Profile resource type for CloudFormation.", - "handlers": { - "create": { - "permissions": [ - "groundstation:CreateMissionProfile", - "groundstation:GetMissionProfile", - "groundstation:TagResource", - "iam:PassRole", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "groundstation:DeleteMissionProfile", - "groundstation:GetMissionProfile" - ] - }, - "list": { - "permissions": [ - "groundstation:ListMissionProfiles" - ] - }, - "read": { - "permissions": [ - "groundstation:GetMissionProfile", - "groundstation:ListTagsForResource", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "update": { - "permissions": [ - "groundstation:UpdateMissionProfile", - "groundstation:GetMissionProfile", - "groundstation:ListTagsForResource", - "groundstation:TagResource", - "groundstation:UntagResource", - "iam:PassRole", - "kms:DescribeKey", - "kms:CreateGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/Arn" - ], - "properties": { - "Arn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "ContactPostPassDurationSeconds": { - "description": "Post-pass time needed after the contact.", - "type": "integer" - }, - "ContactPrePassDurationSeconds": { - "description": "Pre-pass time needed before the contact.", - "type": "integer" - }, - "DataflowEdges": { - "description": "", - "items": { - "$ref": "#/definitions/DataflowEdge" - }, - "minItems": 1, - "type": "array" - }, - "Id": { - "type": "string" - }, - "MinimumViableContactDurationSeconds": { - "description": "Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.", - "type": "integer" - }, - "Name": { - "description": "A name used to identify a mission profile.", - "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", - "type": "string" - }, - "Region": { - "type": "string" - }, - "StreamsKmsKey": { - "$ref": "#/definitions/StreamsKmsKey", - "description": "The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations." - }, - "StreamsKmsRole": { - "description": "The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TrackingConfigArn": { - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/Region" - ], - "required": [ - "Name", - "MinimumViableContactDurationSeconds", - "DataflowEdges", - "TrackingConfigArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", - "typeName": "AWS::GroundStation::MissionProfile" -} +{ + "additionalProperties": false, + "definitions": { + "DataflowEdge": { + "additionalProperties": false, + "properties": { + "Destination": { + "type": "string" + }, + "Source": { + "type": "string" + } + }, + "type": "object" + }, + "StreamsKmsKey": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "KmsKeyArn" + ] + }, + { + "required": [ + "KmsAliasArn" + ] + } + ], + "properties": { + "KmsAliasArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "KmsKeyArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,128}$", + "type": "string" + }, + "Value": { + "pattern": "^[ a-zA-Z0-9\\+\\-=._:/@]{1,256}$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS Ground Station Mission Profile resource type for CloudFormation.", + "handlers": { + "create": { + "permissions": [ + "groundstation:CreateMissionProfile", + "groundstation:GetMissionProfile", + "groundstation:TagResource", + "iam:PassRole", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "groundstation:DeleteMissionProfile", + "groundstation:GetMissionProfile" + ] + }, + "list": { + "permissions": [ + "groundstation:ListMissionProfiles" + ] + }, + "read": { + "permissions": [ + "groundstation:GetMissionProfile", + "groundstation:ListTagsForResource", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "update": { + "permissions": [ + "groundstation:UpdateMissionProfile", + "groundstation:GetMissionProfile", + "groundstation:ListTagsForResource", + "groundstation:TagResource", + "groundstation:UntagResource", + "iam:PassRole", + "kms:DescribeKey", + "kms:CreateGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "ContactPostPassDurationSeconds": { + "description": "Post-pass time needed after the contact.", + "type": "integer" + }, + "ContactPrePassDurationSeconds": { + "description": "Pre-pass time needed before the contact.", + "type": "integer" + }, + "DataflowEdges": { + "description": "", + "items": { + "$ref": "#/definitions/DataflowEdge" + }, + "minItems": 1, + "type": "array" + }, + "Id": { + "type": "string" + }, + "MinimumViableContactDurationSeconds": { + "description": "Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.", + "type": "integer" + }, + "Name": { + "description": "A name used to identify a mission profile.", + "pattern": "^[ a-zA-Z0-9_:-]{1,256}$", + "type": "string" + }, + "Region": { + "type": "string" + }, + "StreamsKmsKey": { + "$ref": "#/definitions/StreamsKmsKey", + "description": "The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations." + }, + "StreamsKmsRole": { + "description": "The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TrackingConfigArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/Region" + ], + "required": [ + "Name", + "MinimumViableContactDurationSeconds", + "DataflowEdges", + "TrackingConfigArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ground-station.git", + "typeName": "AWS::GroundStation::MissionProfile" +} diff --git a/schema/aws-guardduty-detector.json b/schema/aws-guardduty-detector.json index 4500a22..a2e45b9 100644 --- a/schema/aws-guardduty-detector.json +++ b/schema/aws-guardduty-detector.json @@ -1,217 +1,217 @@ -{ - "additionalProperties": false, - "definitions": { - "CFNDataSourceConfigurations": { - "additionalProperties": false, - "properties": { - "Kubernetes": { - "$ref": "#/definitions/CFNKubernetesConfiguration" - }, - "MalwareProtection": { - "$ref": "#/definitions/CFNMalwareProtectionConfiguration" - }, - "S3Logs": { - "$ref": "#/definitions/CFNS3LogsConfiguration" - } - }, - "type": "object" - }, - "CFNFeatureAdditionalConfiguration": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Status": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "CFNFeatureConfiguration": { - "additionalProperties": false, - "properties": { - "AdditionalConfiguration": { - "items": { - "$ref": "#/definitions/CFNFeatureAdditionalConfiguration" - }, - "type": "array" - }, - "Name": { - "maxLength": 128, - "type": "string" - }, - "Status": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "required": [ - "Name", - "Status" - ], - "type": "object" - }, - "CFNKubernetesAuditLogsConfiguration": { - "additionalProperties": false, - "properties": { - "Enable": { - "type": "boolean" - } - }, - "required": [ - "Enable" - ], - "type": "object" - }, - "CFNKubernetesConfiguration": { - "additionalProperties": false, - "properties": { - "AuditLogs": { - "$ref": "#/definitions/CFNKubernetesAuditLogsConfiguration" - } - }, - "required": [ - "AuditLogs" - ], - "type": "object" - }, - "CFNMalwareProtectionConfiguration": { - "additionalProperties": false, - "properties": { - "ScanEc2InstanceWithFindings": { - "$ref": "#/definitions/CFNScanEc2InstanceWithFindingsConfiguration" - } - }, - "type": "object" - }, - "CFNS3LogsConfiguration": { - "additionalProperties": false, - "properties": { - "Enable": { - "type": "boolean" - } - }, - "required": [ - "Enable" - ], - "type": "object" - }, - "CFNScanEc2InstanceWithFindingsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsVolumes": { - "type": "boolean" - } - }, - "type": "object" - }, - "TagItem": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GuardDuty::Detector", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateDetector", - "guardduty:GetDetector", - "guardduty:TagResource", - "iam:CreateServiceLinkedRole", - "iam:GetRole" - ] - }, - "delete": { - "permissions": [ - "guardduty:ListDetectors", - "guardduty:DeleteDetector", - "guardduty:GetDetector" - ] - }, - "list": { - "permissions": [ - "guardduty:ListDetectors" - ] - }, - "read": { - "permissions": [ - "guardduty:GetDetector" - ] - }, - "update": { - "permissions": [ - "guardduty:UpdateDetector", - "guardduty:GetDetector", - "guardduty:ListDetectors", - "iam:CreateServiceLinkedRole", - "iam:GetRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DataSources": { - "$ref": "#/definitions/CFNDataSourceConfigurations" - }, - "Enable": { - "type": "boolean" - }, - "Features": { - "items": { - "$ref": "#/definitions/CFNFeatureConfiguration" - }, - "type": "array" - }, - "FindingPublishingFrequency": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagItem" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Enable" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::GuardDuty::Detector" -} +{ + "additionalProperties": false, + "definitions": { + "CFNDataSourceConfigurations": { + "additionalProperties": false, + "properties": { + "Kubernetes": { + "$ref": "#/definitions/CFNKubernetesConfiguration" + }, + "MalwareProtection": { + "$ref": "#/definitions/CFNMalwareProtectionConfiguration" + }, + "S3Logs": { + "$ref": "#/definitions/CFNS3LogsConfiguration" + } + }, + "type": "object" + }, + "CFNFeatureAdditionalConfiguration": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Status": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "CFNFeatureConfiguration": { + "additionalProperties": false, + "properties": { + "AdditionalConfiguration": { + "items": { + "$ref": "#/definitions/CFNFeatureAdditionalConfiguration" + }, + "type": "array" + }, + "Name": { + "maxLength": 128, + "type": "string" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [ + "Name", + "Status" + ], + "type": "object" + }, + "CFNKubernetesAuditLogsConfiguration": { + "additionalProperties": false, + "properties": { + "Enable": { + "type": "boolean" + } + }, + "required": [ + "Enable" + ], + "type": "object" + }, + "CFNKubernetesConfiguration": { + "additionalProperties": false, + "properties": { + "AuditLogs": { + "$ref": "#/definitions/CFNKubernetesAuditLogsConfiguration" + } + }, + "required": [ + "AuditLogs" + ], + "type": "object" + }, + "CFNMalwareProtectionConfiguration": { + "additionalProperties": false, + "properties": { + "ScanEc2InstanceWithFindings": { + "$ref": "#/definitions/CFNScanEc2InstanceWithFindingsConfiguration" + } + }, + "type": "object" + }, + "CFNS3LogsConfiguration": { + "additionalProperties": false, + "properties": { + "Enable": { + "type": "boolean" + } + }, + "required": [ + "Enable" + ], + "type": "object" + }, + "CFNScanEc2InstanceWithFindingsConfiguration": { + "additionalProperties": false, + "properties": { + "EbsVolumes": { + "type": "boolean" + } + }, + "type": "object" + }, + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::Detector", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateDetector", + "guardduty:GetDetector", + "guardduty:TagResource", + "iam:CreateServiceLinkedRole", + "iam:GetRole" + ] + }, + "delete": { + "permissions": [ + "guardduty:ListDetectors", + "guardduty:DeleteDetector", + "guardduty:GetDetector" + ] + }, + "list": { + "permissions": [ + "guardduty:ListDetectors" + ] + }, + "read": { + "permissions": [ + "guardduty:GetDetector" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateDetector", + "guardduty:GetDetector", + "guardduty:ListDetectors", + "iam:CreateServiceLinkedRole", + "iam:GetRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DataSources": { + "$ref": "#/definitions/CFNDataSourceConfigurations" + }, + "Enable": { + "type": "boolean" + }, + "Features": { + "items": { + "$ref": "#/definitions/CFNFeatureConfiguration" + }, + "type": "array" + }, + "FindingPublishingFrequency": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Enable" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::GuardDuty::Detector" +} diff --git a/schema/aws-guardduty-filter.json b/schema/aws-guardduty-filter.json index 8a8163d..83bcc6f 100644 --- a/schema/aws-guardduty-filter.json +++ b/schema/aws-guardduty-filter.json @@ -1,196 +1,196 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DetectorId", - "/properties/Name" - ], - "definitions": { - "Condition": { - "additionalProperties": false, - "properties": { - "Eq": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Equals": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "GreaterThan": { - "format": "int64", - "type": "integer" - }, - "GreaterThanOrEqual": { - "format": "int64", - "type": "integer" - }, - "Gt": { - "type": "integer" - }, - "Gte": { - "type": "integer" - }, - "LessThan": { - "format": "int64", - "type": "integer" - }, - "LessThanOrEqual": { - "format": "int64", - "type": "integer" - }, - "Lt": { - "type": "integer" - }, - "Lte": { - "type": "integer" - }, - "Neq": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "NotEquals": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "FindingCriteria": { - "additionalProperties": false, - "properties": { - "Criterion": { - "additionalProperties": false, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/Condition" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "TagItem": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GuardDuty::Filter", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateFilter", - "guardduty:GetFilter", - "guardduty:TagResource" - ] - }, - "delete": { - "permissions": [ - "guardduty:ListDetectors", - "guardduty:ListFilters", - "guardduty:GetFilter", - "guardduty:DeleteFilter" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DetectorId": { - "type": "string" - } - } - }, - "permissions": [ - "guardduty:ListFilters" - ] - }, - "read": { - "permissions": [ - "guardduty:GetFilter" - ] - }, - "update": { - "permissions": [ - "guardduty:UpdateFilter", - "guardduty:GetFilter", - "guardduty:ListFilters" - ] - } - }, - "primaryIdentifier": [ - "/properties/DetectorId", - "/properties/Name" - ], - "properties": { - "Action": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DetectorId": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "FindingCriteria": { - "$ref": "#/definitions/FindingCriteria" - }, - "Name": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Rank": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagItem" - }, - "type": "array" - } - }, - "required": [ - "DetectorId", - "Name", - "FindingCriteria" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::GuardDuty::Filter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorId", + "/properties/Name" + ], + "definitions": { + "Condition": { + "additionalProperties": false, + "properties": { + "Eq": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Equals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "GreaterThan": { + "format": "int64", + "type": "integer" + }, + "GreaterThanOrEqual": { + "format": "int64", + "type": "integer" + }, + "Gt": { + "type": "integer" + }, + "Gte": { + "type": "integer" + }, + "LessThan": { + "format": "int64", + "type": "integer" + }, + "LessThanOrEqual": { + "format": "int64", + "type": "integer" + }, + "Lt": { + "type": "integer" + }, + "Lte": { + "type": "integer" + }, + "Neq": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "NotEquals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "FindingCriteria": { + "additionalProperties": false, + "properties": { + "Criterion": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/Condition" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::Filter", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateFilter", + "guardduty:GetFilter", + "guardduty:TagResource" + ] + }, + "delete": { + "permissions": [ + "guardduty:ListDetectors", + "guardduty:ListFilters", + "guardduty:GetFilter", + "guardduty:DeleteFilter" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListFilters" + ] + }, + "read": { + "permissions": [ + "guardduty:GetFilter" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateFilter", + "guardduty:GetFilter", + "guardduty:ListFilters" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorId", + "/properties/Name" + ], + "properties": { + "Action": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DetectorId": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "FindingCriteria": { + "$ref": "#/definitions/FindingCriteria" + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Rank": { + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "required": [ + "DetectorId", + "Name", + "FindingCriteria" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::GuardDuty::Filter" +} diff --git a/schema/aws-guardduty-ipset.json b/schema/aws-guardduty-ipset.json index cb7f6e4..7acff2c 100644 --- a/schema/aws-guardduty-ipset.json +++ b/schema/aws-guardduty-ipset.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Format", - "/properties/DetectorId" - ], - "definitions": { - "TagItem": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GuardDuty::IPSet", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateIPSet", - "guardduty:GetIPSet", - "guardduty:TagResource", - "iam:PutRolePolicy" - ] - }, - "delete": { - "permissions": [ - "guardduty:GetDetector", - "guardduty:ListDetectors", - "guardduty:ListIPSets", - "guardduty:GetIPSet", - "guardduty:DeleteIPSet", - "iam:DeleteRolePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DetectorId": { - "type": "string" - } - } - }, - "permissions": [ - "guardduty:ListIPSets" - ] - }, - "read": { - "permissions": [ - "guardduty:GetIPSet" - ] - }, - "update": { - "permissions": [ - "guardduty:UpdateIPSet", - "guardduty:GetIPSet", - "guardduty:ListIPSets", - "iam:PutRolePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/DetectorId" - ], - "properties": { - "Activate": { - "type": "boolean" - }, - "DetectorId": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "Format": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Location": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagItem" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Format", - "Location" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::GuardDuty::IPSet", - "writeOnlyProperties": [ - "/properties/Activate" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Format", + "/properties/DetectorId" + ], + "definitions": { + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::IPSet", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateIPSet", + "guardduty:GetIPSet", + "guardduty:TagResource", + "iam:PutRolePolicy" + ] + }, + "delete": { + "permissions": [ + "guardduty:GetDetector", + "guardduty:ListDetectors", + "guardduty:ListIPSets", + "guardduty:GetIPSet", + "guardduty:DeleteIPSet", + "iam:DeleteRolePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListIPSets" + ] + }, + "read": { + "permissions": [ + "guardduty:GetIPSet" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateIPSet", + "guardduty:GetIPSet", + "guardduty:ListIPSets", + "iam:PutRolePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/DetectorId" + ], + "properties": { + "Activate": { + "type": "boolean" + }, + "DetectorId": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "Format": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Location": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Format", + "Location" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::GuardDuty::IPSet", + "writeOnlyProperties": [ + "/properties/Activate" + ] +} diff --git a/schema/aws-guardduty-malwareprotectionplan.json b/schema/aws-guardduty-malwareprotectionplan.json index 094b015..8b6276c 100644 --- a/schema/aws-guardduty-malwareprotectionplan.json +++ b/schema/aws-guardduty-malwareprotectionplan.json @@ -1,183 +1,183 @@ -{ - "additionalProperties": false, - "definitions": { - "CFNActions": { - "additionalProperties": false, - "properties": { - "Tagging": { - "$ref": "#/definitions/CFNTagging", - "description": "Contains information about tagging status of the Malware Protection plan resource." - } - }, - "type": "object" - }, - "CFNProtectedResource": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "additionalProperties": false, - "description": "Information about the protected S3 bucket resource.", - "properties": { - "BucketName": { - "description": "Name of the S3 bucket.", - "type": "string" - }, - "ObjectPrefixes": { - "description": "Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "required": [ - "S3Bucket" - ], - "type": "object" - }, - "CFNStatusReasons": { - "additionalProperties": false, - "properties": { - "Code": { - "description": "The status code of the Malware Protection plan.", - "type": "string" - }, - "Message": { - "description": "Issue message that specifies the reason.", - "type": "string" - } - }, - "type": "object" - }, - "CFNTagging": { - "additionalProperties": false, - "properties": { - "Status": { - "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object.", - "type": "string" - } - }, - "type": "object" - }, - "TagItem": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GuardDuty::MalwareProtectionPlan", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateMalwareProtectionPlan", - "guardduty:GetMalwareProtectionPlan", - "guardduty:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "guardduty:DeleteMalwareProtectionPlan", - "guardduty:GetMalwareProtectionPlan" - ] - }, - "list": { - "permissions": [ - "guardduty:ListMalwareProtectionPlans" - ] - }, - "read": { - "permissions": [ - "guardduty:GetMalwareProtectionPlan" - ] - }, - "update": { - "permissions": [ - "guardduty:UpdateMalwareProtectionPlan", - "guardduty:GetMalwareProtectionPlan", - "guardduty:TagResource", - "guardduty:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/MalwareProtectionPlanId" - ], - "properties": { - "Actions": { - "$ref": "#/definitions/CFNActions", - "description": "Specifies the action that is to be applied to the Malware Protection plan resource." - }, - "Arn": { - "description": "Amazon Resource Name (ARN) of the protected resource.", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp when the Malware Protection plan resource was created.", - "type": "string" - }, - "MalwareProtectionPlanId": { - "description": "A unique identifier associated with Malware Protection plan resource.", - "type": "string" - }, - "ProtectedResource": { - "$ref": "#/definitions/CFNProtectedResource", - "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." - }, - "Role": { - "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.", - "type": "string" - }, - "Status": { - "description": "Status of the Malware Protection plan resource.", - "type": "string" - }, - "StatusReasons": { - "description": "Status details associated with the Malware Protection plan resource status.", - "items": { - "$ref": "#/definitions/CFNStatusReasons" - }, - "type": "array" - }, - "Tags": { - "description": "The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify.", - "items": { - "$ref": "#/definitions/TagItem" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/MalwareProtectionPlanId", - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Status", - "/properties/StatusReasons" - ], - "required": [ - "Role", - "ProtectedResource" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::GuardDuty::MalwareProtectionPlan" -} +{ + "additionalProperties": false, + "definitions": { + "CFNActions": { + "additionalProperties": false, + "properties": { + "Tagging": { + "$ref": "#/definitions/CFNTagging", + "description": "Contains information about tagging status of the Malware Protection plan resource." + } + }, + "type": "object" + }, + "CFNProtectedResource": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "additionalProperties": false, + "description": "Information about the protected S3 bucket resource.", + "properties": { + "BucketName": { + "description": "Name of the S3 bucket.", + "type": "string" + }, + "ObjectPrefixes": { + "description": "Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "CFNStatusReasons": { + "additionalProperties": false, + "properties": { + "Code": { + "description": "The status code of the Malware Protection plan.", + "type": "string" + }, + "Message": { + "description": "Issue message that specifies the reason.", + "type": "string" + } + }, + "type": "object" + }, + "CFNTagging": { + "additionalProperties": false, + "properties": { + "Status": { + "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object.", + "type": "string" + } + }, + "type": "object" + }, + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::MalwareProtectionPlan", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan", + "guardduty:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "guardduty:DeleteMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan" + ] + }, + "list": { + "permissions": [ + "guardduty:ListMalwareProtectionPlans" + ] + }, + "read": { + "permissions": [ + "guardduty:GetMalwareProtectionPlan" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan", + "guardduty:TagResource", + "guardduty:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/MalwareProtectionPlanId" + ], + "properties": { + "Actions": { + "$ref": "#/definitions/CFNActions", + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." + }, + "Arn": { + "description": "Amazon Resource Name (ARN) of the protected resource.", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp when the Malware Protection plan resource was created.", + "type": "string" + }, + "MalwareProtectionPlanId": { + "description": "A unique identifier associated with Malware Protection plan resource.", + "type": "string" + }, + "ProtectedResource": { + "$ref": "#/definitions/CFNProtectedResource", + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." + }, + "Role": { + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.", + "type": "string" + }, + "Status": { + "description": "Status of the Malware Protection plan resource.", + "type": "string" + }, + "StatusReasons": { + "description": "Status details associated with the Malware Protection plan resource status.", + "items": { + "$ref": "#/definitions/CFNStatusReasons" + }, + "type": "array" + }, + "Tags": { + "description": "The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify.", + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/MalwareProtectionPlanId", + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Status", + "/properties/StatusReasons" + ], + "required": [ + "Role", + "ProtectedResource" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GuardDuty::MalwareProtectionPlan" +} diff --git a/schema/aws-guardduty-master.json b/schema/aws-guardduty-master.json index 8c5c717..336ab2c 100644 --- a/schema/aws-guardduty-master.json +++ b/schema/aws-guardduty-master.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MasterId", - "/properties/InvitationId", - "/properties/DetectorId" - ], - "description": "GuardDuty Master resource schema", - "handlers": { - "create": { - "permissions": [ - "guardduty:ListInvitations", - "guardduty:AcceptInvitation", - "guardduty:GetMasterAccount" - ] - }, - "delete": { - "permissions": [ - "guardduty:DisassociateFromMasterAccount" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DetectorId": { - "type": "string" - }, - "MasterId": { - "type": "string" - } - } - }, - "permissions": [ - "guardduty:GetMasterAccount" - ] - }, - "read": { - "permissions": [ - "guardduty:GetMasterAccount" - ] - } - }, - "primaryIdentifier": [ - "/properties/DetectorId", - "/properties/MasterId" - ], - "properties": { - "DetectorId": { - "description": "Unique ID of the detector of the GuardDuty member account.", - "type": "string" - }, - "InvitationId": { - "description": "Value used to validate the master account to the member account.", - "type": "string" - }, - "MasterId": { - "description": "ID of the account used as the master account.", - "type": "string" - } - }, - "required": [ - "MasterId", - "DetectorId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::GuardDuty::Master" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MasterId", + "/properties/InvitationId", + "/properties/DetectorId" + ], + "description": "GuardDuty Master resource schema", + "handlers": { + "create": { + "permissions": [ + "guardduty:ListInvitations", + "guardduty:AcceptInvitation", + "guardduty:GetMasterAccount" + ] + }, + "delete": { + "permissions": [ + "guardduty:DisassociateFromMasterAccount" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + }, + "MasterId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:GetMasterAccount" + ] + }, + "read": { + "permissions": [ + "guardduty:GetMasterAccount" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorId", + "/properties/MasterId" + ], + "properties": { + "DetectorId": { + "description": "Unique ID of the detector of the GuardDuty member account.", + "type": "string" + }, + "InvitationId": { + "description": "Value used to validate the master account to the member account.", + "type": "string" + }, + "MasterId": { + "description": "ID of the account used as the master account.", + "type": "string" + } + }, + "required": [ + "MasterId", + "DetectorId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::GuardDuty::Master" +} diff --git a/schema/aws-guardduty-member.json b/schema/aws-guardduty-member.json index 7edc962..66446a3 100644 --- a/schema/aws-guardduty-member.json +++ b/schema/aws-guardduty-member.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DetectorId", - "/properties/MemberId" - ], - "description": "Resource Type definition for AWS::GuardDuty::Member", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateMembers", - "guardduty:GetMembers" - ] - }, - "delete": { - "permissions": [ - "guardduty:GetMembers", - "guardduty:DisassociateMembers", - "guardduty:DeleteMembers" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DetectorId": { - "type": "string" - } - } - }, - "permissions": [ - "guardduty:ListMembers" - ] - }, - "read": { - "permissions": [ - "guardduty:GetMembers" - ] - }, - "update": { - "permissions": [ - "guardduty:GetMembers", - "guardduty:CreateMembers", - "guardduty:DisassociateMembers", - "guardduty:StartMonitoringMembers", - "guardduty:StopMonitoringMembers", - "guardduty:InviteMembers" - ] - } - }, - "primaryIdentifier": [ - "/properties/DetectorId", - "/properties/MemberId" - ], - "properties": { - "DetectorId": { - "type": "string" - }, - "DisableEmailNotification": { - "type": "boolean" - }, - "Email": { - "type": "string" - }, - "MemberId": { - "type": "string" - }, - "Message": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Email" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::GuardDuty::Member", - "writeOnlyProperties": [ - "/properties/DisableEmailNotification", - "/properties/Message" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorId", + "/properties/MemberId" + ], + "description": "Resource Type definition for AWS::GuardDuty::Member", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateMembers", + "guardduty:GetMembers" + ] + }, + "delete": { + "permissions": [ + "guardduty:GetMembers", + "guardduty:DisassociateMembers", + "guardduty:DeleteMembers" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListMembers" + ] + }, + "read": { + "permissions": [ + "guardduty:GetMembers" + ] + }, + "update": { + "permissions": [ + "guardduty:GetMembers", + "guardduty:CreateMembers", + "guardduty:DisassociateMembers", + "guardduty:StartMonitoringMembers", + "guardduty:StopMonitoringMembers", + "guardduty:InviteMembers" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorId", + "/properties/MemberId" + ], + "properties": { + "DetectorId": { + "type": "string" + }, + "DisableEmailNotification": { + "type": "boolean" + }, + "Email": { + "type": "string" + }, + "MemberId": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "Status": { + "type": "string" + } + }, + "required": [ + "Email" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::GuardDuty::Member", + "writeOnlyProperties": [ + "/properties/DisableEmailNotification", + "/properties/Message" + ] +} diff --git a/schema/aws-guardduty-threatintelset.json b/schema/aws-guardduty-threatintelset.json index ab62e3e..de8aecc 100644 --- a/schema/aws-guardduty-threatintelset.json +++ b/schema/aws-guardduty-threatintelset.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Format", - "/properties/DetectorId" - ], - "definitions": { - "TagItem": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::GuardDuty::ThreatIntelSet", - "handlers": { - "create": { - "permissions": [ - "guardduty:CreateThreatIntelSet", - "guardduty:GetThreatIntelSet", - "guardduty:TagResource", - "iam:PutRolePolicy" - ] - }, - "delete": { - "permissions": [ - "guardduty:ListDetectors", - "guardduty:ListThreatIntelSets", - "guardduty:DeleteThreatIntelSet", - "guardduty:GetThreatIntelSet", - "iam:DeleteRolePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DetectorId": { - "type": "string" - } - } - }, - "permissions": [ - "guardduty:ListThreatIntelSets" - ] - }, - "read": { - "permissions": [ - "guardduty:GetThreatIntelSet" - ] - }, - "update": { - "permissions": [ - "guardduty:UpdateThreatIntelSet", - "guardduty:GetThreatIntelSet", - "guardduty:ListThreatIntelSets", - "iam:PutRolePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/DetectorId" - ], - "properties": { - "Activate": { - "type": "boolean" - }, - "DetectorId": { - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "Format": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "Id": { - "type": "string" - }, - "Location": { - "maxLength": 300, - "minLength": 1, - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/TagItem" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Format", - "Location" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::GuardDuty::ThreatIntelSet", - "writeOnlyProperties": [ - "/properties/Activate" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Format", + "/properties/DetectorId" + ], + "definitions": { + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::ThreatIntelSet", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateThreatIntelSet", + "guardduty:GetThreatIntelSet", + "guardduty:TagResource", + "iam:PutRolePolicy" + ] + }, + "delete": { + "permissions": [ + "guardduty:ListDetectors", + "guardduty:ListThreatIntelSets", + "guardduty:DeleteThreatIntelSet", + "guardduty:GetThreatIntelSet", + "iam:DeleteRolePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListThreatIntelSets" + ] + }, + "read": { + "permissions": [ + "guardduty:GetThreatIntelSet" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateThreatIntelSet", + "guardduty:GetThreatIntelSet", + "guardduty:ListThreatIntelSets", + "iam:PutRolePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/DetectorId" + ], + "properties": { + "Activate": { + "type": "boolean" + }, + "DetectorId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "Format": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "Id": { + "type": "string" + }, + "Location": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Format", + "Location" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::GuardDuty::ThreatIntelSet", + "writeOnlyProperties": [ + "/properties/Activate" + ] +} diff --git a/schema/aws-healthimaging-datastore.json b/schema/aws-healthimaging-datastore.json index eecbee0..58096c6 100644 --- a/schema/aws-healthimaging-datastore.json +++ b/schema/aws-healthimaging-datastore.json @@ -1,155 +1,155 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatastoreName", - "/properties/Tags", - "/properties/KmsKeyArn" - ], - "definitions": { - "CreatedAt": { - "description": "The timestamp when the data store was created.", - "type": "string" - }, - "DatastoreArn": { - "description": "The Datastore's ARN.", - "maxLength": 127, - "minLength": 1, - "pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?$", - "type": "string" - }, - "DatastoreId": { - "maxLength": 32, - "minLength": 0, - "pattern": "^[0-9a-z]{32}$", - "type": "string" - }, - "DatastoreName": { - "description": "User friendly name for Datastore.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[A-Za-z0-9._/#-]+$", - "type": "string" - }, - "DatastoreStatus": { - "description": "A string to denote the Datastore's state.", - "enum": [ - "CREATING", - "CREATE_FAILED", - "ACTIVE", - "DELETING", - "DELETED" - ], - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "KmsKeyArn": { - "description": "ARN referencing a KMS key or KMS key alias.", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A Map of key value pairs for Tags.", - "patternProperties": { - "^.+$": { - "description": "The string value for the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "UpdatedAt": { - "description": "The timestamp when the data store was created.", - "type": "string" - } - }, - "description": "Definition of AWS::HealthImaging::Datastore Resource Type", - "handlers": { - "create": { - "permissions": [ - "medical-imaging:CreateDatastore", - "medical-imaging:GetDatastore", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:RetireGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "lambda:InvokeFunction", - "medical-imaging:TagResource", - "medical-imaging:UntagResource", - "medical-imaging:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "medical-imaging:DeleteDatastore", - "medical-imaging:GetDatastore", - "medical-imaging:UntagResource", - "kms:DescribeKey", - "kms:RetireGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "medical-imaging:ListDatastores" - ] - }, - "read": { - "permissions": [ - "medical-imaging:GetDatastore", - "medical-imaging:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatastoreId" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/CreatedAt" - }, - "DatastoreArn": { - "$ref": "#/definitions/DatastoreArn" - }, - "DatastoreId": { - "$ref": "#/definitions/DatastoreId" - }, - "DatastoreName": { - "$ref": "#/definitions/DatastoreName" - }, - "DatastoreStatus": { - "$ref": "#/definitions/DatastoreStatus" - }, - "KmsKeyArn": { - "$ref": "#/definitions/KmsKeyArn" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "UpdatedAt": { - "$ref": "#/definitions/UpdatedAt" - } - }, - "readOnlyProperties": [ - "/properties/DatastoreArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/DatastoreId", - "/properties/DatastoreStatus" - ], - "required": [], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::HealthImaging::Datastore" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatastoreName", + "/properties/Tags", + "/properties/KmsKeyArn" + ], + "definitions": { + "CreatedAt": { + "description": "The timestamp when the data store was created.", + "type": "string" + }, + "DatastoreArn": { + "description": "The Datastore's ARN.", + "maxLength": 127, + "minLength": 1, + "pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?$", + "type": "string" + }, + "DatastoreId": { + "maxLength": 32, + "minLength": 0, + "pattern": "^[0-9a-z]{32}$", + "type": "string" + }, + "DatastoreName": { + "description": "User friendly name for Datastore.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[A-Za-z0-9._/#-]+$", + "type": "string" + }, + "DatastoreStatus": { + "description": "A string to denote the Datastore's state.", + "enum": [ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "DELETING", + "DELETED" + ], + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "KmsKeyArn": { + "description": "ARN referencing a KMS key or KMS key alias.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A Map of key value pairs for Tags.", + "patternProperties": { + "^.+$": { + "description": "The string value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "UpdatedAt": { + "description": "The timestamp when the data store was created.", + "type": "string" + } + }, + "description": "Definition of AWS::HealthImaging::Datastore Resource Type", + "handlers": { + "create": { + "permissions": [ + "medical-imaging:CreateDatastore", + "medical-imaging:GetDatastore", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:RetireGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "lambda:InvokeFunction", + "medical-imaging:TagResource", + "medical-imaging:UntagResource", + "medical-imaging:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "medical-imaging:DeleteDatastore", + "medical-imaging:GetDatastore", + "medical-imaging:UntagResource", + "kms:DescribeKey", + "kms:RetireGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "medical-imaging:ListDatastores" + ] + }, + "read": { + "permissions": [ + "medical-imaging:GetDatastore", + "medical-imaging:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatastoreId" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/CreatedAt" + }, + "DatastoreArn": { + "$ref": "#/definitions/DatastoreArn" + }, + "DatastoreId": { + "$ref": "#/definitions/DatastoreId" + }, + "DatastoreName": { + "$ref": "#/definitions/DatastoreName" + }, + "DatastoreStatus": { + "$ref": "#/definitions/DatastoreStatus" + }, + "KmsKeyArn": { + "$ref": "#/definitions/KmsKeyArn" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "UpdatedAt": { + "$ref": "#/definitions/UpdatedAt" + } + }, + "readOnlyProperties": [ + "/properties/DatastoreArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/DatastoreId", + "/properties/DatastoreStatus" + ], + "required": [], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::HealthImaging::Datastore" +} diff --git a/schema/aws-healthlake-fhirdatastore.json b/schema/aws-healthlake-fhirdatastore.json index f03549c..dff7d2d 100644 --- a/schema/aws-healthlake-fhirdatastore.json +++ b/schema/aws-healthlake-fhirdatastore.json @@ -1,295 +1,295 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatastoreName", - "/properties/DatastoreTypeVersion", - "/properties/PreloadDataConfig", - "/properties/SseConfiguration", - "/properties/IdentityProviderConfiguration" - ], - "definitions": { - "CreatedAt": { - "additionalProperties": false, - "description": "The time that a Data Store was created.", - "properties": { - "Nanos": { - "description": "Nanoseconds.", - "type": "integer" - }, - "Seconds": { - "description": "Seconds since epoch.", - "type": "string" - } - }, - "required": [ - "Seconds", - "Nanos" - ], - "type": "object" - }, - "DatastoreArn": { - "description": "The Amazon Resource Name used in the creation of the Data Store.", - "pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?", - "type": "string" - }, - "DatastoreEndpoint": { - "description": "The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.", - "maxLength": 10000, - "type": "string" - }, - "DatastoreId": { - "description": "The AWS-generated ID number for the Data Store.", - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "DatastoreName": { - "description": "The user-generated name for the Data Store.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "DatastoreStatus": { - "description": "The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.", - "enum": [ - "CREATING", - "ACTIVE", - "DELETING", - "DELETED" - ], - "type": "string" - }, - "DatastoreTypeVersion": { - "description": "The FHIR version. Only R4 version data is supported.", - "enum": [ - "R4" - ], - "type": "string" - }, - "IdentityProviderConfiguration": { - "additionalProperties": false, - "description": "The identity provider configuration for the datastore", - "properties": { - "AuthorizationStrategy": { - "description": "Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.", - "enum": [ - "SMART_ON_FHIR_V1", - "AWS_AUTH" - ], - "type": "string" - }, - "FineGrainedAuthorizationEnabled": { - "description": "Flag to indicate if fine-grained authorization will be enabled for the datastore", - "type": "boolean" - }, - "IdpLambdaArn": { - "description": "The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.", - "maxLength": 256, - "minLength": 49, - "pattern": "arn:aws[-a-z]*:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?", - "type": "string" - }, - "Metadata": { - "description": "The JSON metadata elements for identity provider configuration.", - "type": "string" - } - }, - "required": [ - "AuthorizationStrategy" - ], - "type": "object" - }, - "KmsEncryptionConfig": { - "additionalProperties": false, - "description": "The customer-managed-key (CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.", - "properties": { - "CmkType": { - "description": "The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.", - "enum": [ - "CUSTOMER_MANAGED_KMS_KEY", - "AWS_OWNED_KMS_KEY" - ], - "type": "string" - }, - "KmsKeyId": { - "description": "The KMS encryption key id/alias used to encrypt the Data Store contents at rest.", - "maxLength": 400, - "minLength": 1, - "pattern": "(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))", - "type": "string" - } - }, - "required": [ - "CmkType" - ], - "type": "object" - }, - "PreloadDataConfig": { - "additionalProperties": false, - "description": "The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.", - "properties": { - "PreloadDataType": { - "description": "The type of preloaded data. Only Synthea preloaded data is supported.", - "enum": [ - "SYNTHEA" - ], - "type": "string" - } - }, - "required": [ - "PreloadDataType" - ], - "type": "object" - }, - "SseConfiguration": { - "additionalProperties": false, - "description": "The server-side encryption key configuration for a customer provided encryption key.", - "properties": { - "KmsEncryptionConfig": { - "$ref": "#/definitions/KmsEncryptionConfig" - } - }, - "required": [ - "KmsEncryptionConfig" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.", - "properties": { - "Key": { - "description": "The key of the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value of the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "HealthLake FHIR Datastore", - "documentationUrl": "https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html", - "handlers": { - "create": { - "permissions": [ - "healthlake:CreateFHIRDatastore", - "healthlake:DescribeFHIRDatastore", - "iam:PassRole", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "ram:GetResourceShareInvitations", - "ram:AcceptResourceShareInvitation", - "glue:CreateDatabase", - "glue:DeleteDatabase", - "lambda:InvokeFunction", - "healthlake:TagResource", - "healthlake:UntagResource", - "healthlake:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "healthlake:DeleteFHIRDatastore", - "healthlake:DescribeFHIRDatastore", - "iam:PassRole", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "ram:GetResourceShareInvitations", - "ram:AcceptResourceShareInvitation", - "glue:CreateDatabase", - "glue:DeleteDatabase" - ] - }, - "list": { - "permissions": [ - "healthlake:ListFHIRDatastores" - ] - }, - "read": { - "permissions": [ - "healthlake:DescribeFHIRDatastore", - "healthlake:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "healthlake:TagResource", - "healthlake:UntagResource", - "healthlake:ListTagsForResource", - "healthlake:DescribeFHIRDatastore", - "iam:PassRole", - "iam:GetRole", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatastoreId" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/CreatedAt" - }, - "DatastoreArn": { - "$ref": "#/definitions/DatastoreArn" - }, - "DatastoreEndpoint": { - "$ref": "#/definitions/DatastoreEndpoint" - }, - "DatastoreId": { - "$ref": "#/definitions/DatastoreId" - }, - "DatastoreName": { - "$ref": "#/definitions/DatastoreName" - }, - "DatastoreStatus": { - "$ref": "#/definitions/DatastoreStatus" - }, - "DatastoreTypeVersion": { - "$ref": "#/definitions/DatastoreTypeVersion" - }, - "IdentityProviderConfiguration": { - "$ref": "#/definitions/IdentityProviderConfiguration" - }, - "PreloadDataConfig": { - "$ref": "#/definitions/PreloadDataConfig" - }, - "SseConfiguration": { - "$ref": "#/definitions/SseConfiguration" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/DatastoreArn", - "/properties/DatastoreEndpoint", - "/properties/DatastoreId", - "/properties/DatastoreStatus" - ], - "required": [ - "DatastoreTypeVersion" - ], - "taggable": true, - "typeName": "AWS::HealthLake::FHIRDatastore" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatastoreName", + "/properties/DatastoreTypeVersion", + "/properties/PreloadDataConfig", + "/properties/SseConfiguration", + "/properties/IdentityProviderConfiguration" + ], + "definitions": { + "CreatedAt": { + "additionalProperties": false, + "description": "The time that a Data Store was created.", + "properties": { + "Nanos": { + "description": "Nanoseconds.", + "type": "integer" + }, + "Seconds": { + "description": "Seconds since epoch.", + "type": "string" + } + }, + "required": [ + "Seconds", + "Nanos" + ], + "type": "object" + }, + "DatastoreArn": { + "description": "The Amazon Resource Name used in the creation of the Data Store.", + "pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?", + "type": "string" + }, + "DatastoreEndpoint": { + "description": "The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.", + "maxLength": 10000, + "type": "string" + }, + "DatastoreId": { + "description": "The AWS-generated ID number for the Data Store.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "DatastoreName": { + "description": "The user-generated name for the Data Store.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DatastoreStatus": { + "description": "The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "DELETED" + ], + "type": "string" + }, + "DatastoreTypeVersion": { + "description": "The FHIR version. Only R4 version data is supported.", + "enum": [ + "R4" + ], + "type": "string" + }, + "IdentityProviderConfiguration": { + "additionalProperties": false, + "description": "The identity provider configuration for the datastore", + "properties": { + "AuthorizationStrategy": { + "description": "Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.", + "enum": [ + "SMART_ON_FHIR_V1", + "AWS_AUTH" + ], + "type": "string" + }, + "FineGrainedAuthorizationEnabled": { + "description": "Flag to indicate if fine-grained authorization will be enabled for the datastore", + "type": "boolean" + }, + "IdpLambdaArn": { + "description": "The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.", + "maxLength": 256, + "minLength": 49, + "pattern": "arn:aws[-a-z]*:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?", + "type": "string" + }, + "Metadata": { + "description": "The JSON metadata elements for identity provider configuration.", + "type": "string" + } + }, + "required": [ + "AuthorizationStrategy" + ], + "type": "object" + }, + "KmsEncryptionConfig": { + "additionalProperties": false, + "description": "The customer-managed-key (CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.", + "properties": { + "CmkType": { + "description": "The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.", + "enum": [ + "CUSTOMER_MANAGED_KMS_KEY", + "AWS_OWNED_KMS_KEY" + ], + "type": "string" + }, + "KmsKeyId": { + "description": "The KMS encryption key id/alias used to encrypt the Data Store contents at rest.", + "maxLength": 400, + "minLength": 1, + "pattern": "(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))", + "type": "string" + } + }, + "required": [ + "CmkType" + ], + "type": "object" + }, + "PreloadDataConfig": { + "additionalProperties": false, + "description": "The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.", + "properties": { + "PreloadDataType": { + "description": "The type of preloaded data. Only Synthea preloaded data is supported.", + "enum": [ + "SYNTHEA" + ], + "type": "string" + } + }, + "required": [ + "PreloadDataType" + ], + "type": "object" + }, + "SseConfiguration": { + "additionalProperties": false, + "description": "The server-side encryption key configuration for a customer provided encryption key.", + "properties": { + "KmsEncryptionConfig": { + "$ref": "#/definitions/KmsEncryptionConfig" + } + }, + "required": [ + "KmsEncryptionConfig" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.", + "properties": { + "Key": { + "description": "The key of the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value of the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "HealthLake FHIR Datastore", + "documentationUrl": "https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html", + "handlers": { + "create": { + "permissions": [ + "healthlake:CreateFHIRDatastore", + "healthlake:DescribeFHIRDatastore", + "iam:PassRole", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "ram:GetResourceShareInvitations", + "ram:AcceptResourceShareInvitation", + "glue:CreateDatabase", + "glue:DeleteDatabase", + "lambda:InvokeFunction", + "healthlake:TagResource", + "healthlake:UntagResource", + "healthlake:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "healthlake:DeleteFHIRDatastore", + "healthlake:DescribeFHIRDatastore", + "iam:PassRole", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "ram:GetResourceShareInvitations", + "ram:AcceptResourceShareInvitation", + "glue:CreateDatabase", + "glue:DeleteDatabase" + ] + }, + "list": { + "permissions": [ + "healthlake:ListFHIRDatastores" + ] + }, + "read": { + "permissions": [ + "healthlake:DescribeFHIRDatastore", + "healthlake:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "healthlake:TagResource", + "healthlake:UntagResource", + "healthlake:ListTagsForResource", + "healthlake:DescribeFHIRDatastore", + "iam:PassRole", + "iam:GetRole", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatastoreId" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/CreatedAt" + }, + "DatastoreArn": { + "$ref": "#/definitions/DatastoreArn" + }, + "DatastoreEndpoint": { + "$ref": "#/definitions/DatastoreEndpoint" + }, + "DatastoreId": { + "$ref": "#/definitions/DatastoreId" + }, + "DatastoreName": { + "$ref": "#/definitions/DatastoreName" + }, + "DatastoreStatus": { + "$ref": "#/definitions/DatastoreStatus" + }, + "DatastoreTypeVersion": { + "$ref": "#/definitions/DatastoreTypeVersion" + }, + "IdentityProviderConfiguration": { + "$ref": "#/definitions/IdentityProviderConfiguration" + }, + "PreloadDataConfig": { + "$ref": "#/definitions/PreloadDataConfig" + }, + "SseConfiguration": { + "$ref": "#/definitions/SseConfiguration" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DatastoreArn", + "/properties/DatastoreEndpoint", + "/properties/DatastoreId", + "/properties/DatastoreStatus" + ], + "required": [ + "DatastoreTypeVersion" + ], + "taggable": true, + "typeName": "AWS::HealthLake::FHIRDatastore" +} diff --git a/schema/aws-iam-accesskey.json b/schema/aws-iam-accesskey.json index e54b264..c074c84 100644 --- a/schema/aws-iam-accesskey.json +++ b/schema/aws-iam-accesskey.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserName", - "/properties/Serial" - ], - "description": "Resource Type definition for AWS::IAM::AccessKey", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "SecretAccessKey": { - "type": "string" - }, - "Serial": { - "type": "integer" - }, - "Status": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SecretAccessKey", - "/properties/Id" - ], - "required": [ - "UserName" - ], - "typeName": "AWS::IAM::AccessKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserName", + "/properties/Serial" + ], + "description": "Resource Type definition for AWS::IAM::AccessKey", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "SecretAccessKey": { + "type": "string" + }, + "Serial": { + "type": "integer" + }, + "Status": { + "type": "string" + }, + "UserName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SecretAccessKey", + "/properties/Id" + ], + "required": [ + "UserName" + ], + "typeName": "AWS::IAM::AccessKey" +} diff --git a/schema/aws-iam-group.json b/schema/aws-iam-group.json index b56fd24..92c3a97 100644 --- a/schema/aws-iam-group.json +++ b/schema/aws-iam-group.json @@ -1,123 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GroupName" - ], - "definitions": { - "Policy": { - "additionalProperties": false, - "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", - "properties": { - "PolicyDocument": { - "description": "The policy document.", - "type": [ - "string", - "object" - ] - }, - "PolicyName": { - "description": "The friendly name (not ARN) identifying the policy.", - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "PolicyName" - ], - "type": "object" - } - }, - "description": "Creates a new group.\n For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateGroup", - "iam:PutGroupPolicy", - "iam:AttachGroupPolicy", - "iam:GetGroupPolicy", - "iam:GetGroup" - ] - }, - "delete": { - "permissions": [ - "iam:GetGroup", - "iam:DeleteGroup", - "iam:ListAttachedGroupPolicies", - "iam:ListGroupPolicies", - "iam:DetachGroupPolicy", - "iam:DeleteGroupPolicy", - "iam:GetGroupPolicy" - ] - }, - "list": { - "permissions": [ - "iam:ListGroups" - ] - }, - "read": { - "permissions": [ - "iam:GetGroup", - "iam:ListGroupPolicies", - "iam:GetGroupPolicy", - "iam:ListAttachedGroupPolicies" - ] - }, - "update": { - "permissions": [ - "iam:GetGroup", - "iam:UpdateGroup", - "iam:DetachGroupPolicy", - "iam:AttachGroupPolicy", - "iam:DeleteGroupPolicy", - "iam:PutGroupPolicy", - "iam:GetGroupPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/GroupName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "GroupName": { - "description": "The name of the group to create. Do not include the path in this value.\n The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both \"ADMINS\" and \"admins\". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", - "type": "string" - }, - "ManagedPolicyArns": { - "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.\n For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Path": { - "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", - "type": "string" - }, - "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).\n The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Policy" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::Group" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupName" + ], + "definitions": { + "Policy": { + "additionalProperties": false, + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", + "properties": { + "PolicyDocument": { + "description": "The policy document.", + "type": [ + "string", + "object" + ] + }, + "PolicyName": { + "description": "The friendly name (not ARN) identifying the policy.", + "type": "string" + } + }, + "required": [ + "PolicyDocument", + "PolicyName" + ], + "type": "object" + } + }, + "description": "Creates a new group.\n For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateGroup", + "iam:PutGroupPolicy", + "iam:AttachGroupPolicy", + "iam:GetGroupPolicy", + "iam:GetGroup" + ] + }, + "delete": { + "permissions": [ + "iam:GetGroup", + "iam:DeleteGroup", + "iam:ListAttachedGroupPolicies", + "iam:ListGroupPolicies", + "iam:DetachGroupPolicy", + "iam:DeleteGroupPolicy", + "iam:GetGroupPolicy" + ] + }, + "list": { + "permissions": [ + "iam:ListGroups" + ] + }, + "read": { + "permissions": [ + "iam:GetGroup", + "iam:ListGroupPolicies", + "iam:GetGroupPolicy", + "iam:ListAttachedGroupPolicies" + ] + }, + "update": { + "permissions": [ + "iam:GetGroup", + "iam:UpdateGroup", + "iam:DetachGroupPolicy", + "iam:AttachGroupPolicy", + "iam:DeleteGroupPolicy", + "iam:PutGroupPolicy", + "iam:GetGroupPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/GroupName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "GroupName": { + "description": "The name of the group to create. Do not include the path in this value.\n The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both \"ADMINS\" and \"admins\". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", + "type": "string" + }, + "ManagedPolicyArns": { + "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.\n For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Path": { + "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", + "type": "string" + }, + "Policies": { + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).\n The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Policy" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::Group" +} diff --git a/schema/aws-iam-grouppolicy.json b/schema/aws-iam-grouppolicy.json index 59b7d63..b199186 100644 --- a/schema/aws-iam-grouppolicy.json +++ b/schema/aws-iam-grouppolicy.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/GroupName" - ], - "description": "Adds or updates an inline policy document that is embedded in the specified IAM group.\n A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:PutGroupPolicy", - "iam:GetGroupPolicy" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteGroupPolicy", - "iam:GetGroupPolicy" - ] - }, - "read": { - "permissions": [ - "iam:GetGroupPolicy" - ] - }, - "update": { - "permissions": [ - "iam:PutGroupPolicy", - "iam:GetGroupPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyName", - "/properties/GroupName" - ], - "properties": { - "GroupName": { - "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.", - "type": "string" - }, - "PolicyDocument": { - "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", - "type": "object" - }, - "PolicyName": { - "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - } - }, - "required": [ - "PolicyName", - "GroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::GroupPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/GroupName" + ], + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group.\n A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:PutGroupPolicy", + "iam:GetGroupPolicy" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteGroupPolicy", + "iam:GetGroupPolicy" + ] + }, + "read": { + "permissions": [ + "iam:GetGroupPolicy" + ] + }, + "update": { + "permissions": [ + "iam:PutGroupPolicy", + "iam:GetGroupPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyName", + "/properties/GroupName" + ], + "properties": { + "GroupName": { + "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.", + "type": "string" + }, + "PolicyDocument": { + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", + "type": "object" + }, + "PolicyName": { + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + } + }, + "required": [ + "PolicyName", + "GroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::GroupPolicy" +} diff --git a/schema/aws-iam-instanceprofile.json b/schema/aws-iam-instanceprofile.json index 4d1ee4e..454257b 100644 --- a/schema/aws-iam-instanceprofile.json +++ b/schema/aws-iam-instanceprofile.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceProfileName", - "/properties/Path" - ], - "description": "Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).\n For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateInstanceProfile", - "iam:PassRole", - "iam:AddRoleToInstanceProfile", - "iam:GetInstanceProfile" - ] - }, - "delete": { - "permissions": [ - "iam:GetInstanceProfile", - "iam:RemoveRoleFromInstanceProfile", - "iam:DeleteInstanceProfile" - ] - }, - "list": { - "permissions": [ - "iam:ListInstanceProfiles" - ] - }, - "read": { - "permissions": [ - "iam:GetInstanceProfile" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iam:RemoveRoleFromInstanceProfile", - "iam:AddRoleToInstanceProfile", - "iam:GetInstanceProfile" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceProfileName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "InstanceProfileName": { - "description": "The name of the instance profile to create.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - }, - "Path": { - "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", - "type": "string" - }, - "Roles": { - "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Roles" - ], - "taggable": false, - "typeName": "AWS::IAM::InstanceProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceProfileName", + "/properties/Path" + ], + "description": "Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).\n For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateInstanceProfile", + "iam:PassRole", + "iam:AddRoleToInstanceProfile", + "iam:GetInstanceProfile" + ] + }, + "delete": { + "permissions": [ + "iam:GetInstanceProfile", + "iam:RemoveRoleFromInstanceProfile", + "iam:DeleteInstanceProfile" + ] + }, + "list": { + "permissions": [ + "iam:ListInstanceProfiles" + ] + }, + "read": { + "permissions": [ + "iam:GetInstanceProfile" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iam:RemoveRoleFromInstanceProfile", + "iam:AddRoleToInstanceProfile", + "iam:GetInstanceProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceProfileName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "InstanceProfileName": { + "description": "The name of the instance profile to create.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + }, + "Path": { + "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", + "type": "string" + }, + "Roles": { + "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Roles" + ], + "taggable": false, + "typeName": "AWS::IAM::InstanceProfile" +} diff --git a/schema/aws-iam-managedpolicy.json b/schema/aws-iam-managedpolicy.json index a1b1af4..dc798e2 100644 --- a/schema/aws-iam-managedpolicy.json +++ b/schema/aws-iam-managedpolicy.json @@ -1,162 +1,163 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ManagedPolicyName", - "/properties/Description", - "/properties/Path" - ], - "description": "Creates a new managed policy for your AWS-account.\n This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.\n As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.\n For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreatePolicy", - "iam:AttachGroupPolicy", - "iam:AttachUserPolicy", - "iam:AttachRolePolicy" - ] - }, - "delete": { - "permissions": [ - "iam:DetachRolePolicy", - "iam:GetPolicy", - "iam:ListPolicyVersions", - "iam:DetachGroupPolicy", - "iam:DetachUserPolicy", - "iam:DeletePolicyVersion", - "iam:DeletePolicy", - "iam:ListEntitiesForPolicy" - ] - }, - "list": { - "permissions": [ - "iam:ListPolicies" - ] - }, - "read": { - "permissions": [ - "iam:GetPolicy", - "iam:ListEntitiesForPolicy", - "iam:GetPolicyVersion" - ] - }, - "update": { - "permissions": [ - "iam:DetachRolePolicy", - "iam:GetPolicy", - "iam:ListPolicyVersions", - "iam:DetachGroupPolicy", - "iam:DetachUserPolicy", - "iam:CreatePolicyVersion", - "iam:DeletePolicyVersion", - "iam:AttachGroupPolicy", - "iam:AttachUserPolicy", - "iam:AttachRolePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyArn" - ], - "properties": { - "AttachmentCount": { - "description": "", - "type": "integer" - }, - "CreateDate": { - "description": "", - "type": "string" - }, - "DefaultVersionId": { - "description": "", - "type": "string" - }, - "Description": { - "description": "A friendly description of the policy.\n Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"\n The policy description is immutable. After a value is assigned, it cannot be changed.", - "type": "string" - }, - "Groups": { - "description": "The name (friendly name, not ARN) of the group to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "IsAttachable": { - "description": "", - "type": "boolean" - }, - "ManagedPolicyName": { - "description": "The friendly name of the policy.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", - "type": "string" - }, - "Path": { - "default": "/", - "description": "The path for the policy.\n For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use an asterisk (*) in the path name.", - "type": "string" - }, - "PermissionsBoundaryUsageCount": { - "description": "", - "type": "integer" - }, - "PolicyArn": { - "description": "", - "type": "string" - }, - "PolicyDocument": { - "description": "The JSON policy document that you want to use as the content for the new policy.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\n To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. \n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", - "type": [ - "object", - "string" - ] - }, - "PolicyId": { - "description": "", - "type": "string" - }, - "Roles": { - "description": "The name (friendly name, not ARN) of the role to attach the policy to.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "UpdateDate": { - "description": "", - "type": "string" - }, - "Users": { - "description": "The name (friendly name, not ARN) of the IAM user to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/PolicyArn", - "/properties/AttachmentCount", - "/properties/CreateDate", - "/properties/DefaultVersionId", - "/properties/IsAttachable", - "/properties/PermissionsBoundaryUsageCount", - "/properties/PolicyId", - "/properties/UpdateDate" - ], - "required": [ - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::ManagedPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ManagedPolicyName", + "/properties/Description", + "/properties/Path" + ], + "description": "Creates a new managed policy for your AWS-account.\n This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.\n As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.\n For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreatePolicy", + "iam:AttachGroupPolicy", + "iam:AttachUserPolicy", + "iam:AttachRolePolicy" + ] + }, + "delete": { + "permissions": [ + "iam:DetachRolePolicy", + "iam:GetPolicy", + "iam:ListPolicyVersions", + "iam:DetachGroupPolicy", + "iam:DetachUserPolicy", + "iam:DeletePolicyVersion", + "iam:DeletePolicy", + "iam:ListEntitiesForPolicy" + ] + }, + "list": { + "permissions": [ + "iam:ListPolicies" + ] + }, + "read": { + "permissions": [ + "iam:GetPolicy", + "iam:ListEntitiesForPolicy", + "iam:GetPolicyVersion" + ] + }, + "update": { + "permissions": [ + "iam:DetachRolePolicy", + "iam:GetPolicy", + "iam:ListPolicyVersions", + "iam:DetachGroupPolicy", + "iam:DetachUserPolicy", + "iam:CreatePolicyVersion", + "iam:DeletePolicyVersion", + "iam:AttachGroupPolicy", + "iam:AttachUserPolicy", + "iam:AttachRolePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyArn" + ], + "properties": { + "AttachmentCount": { + "description": "", + "type": "integer" + }, + "CreateDate": { + "description": "", + "type": "string" + }, + "DefaultVersionId": { + "description": "", + "type": "string" + }, + "Description": { + "description": "A friendly description of the policy.\n Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"\n The policy description is immutable. After a value is assigned, it cannot be changed.", + "type": "string" + }, + "Groups": { + "description": "The name (friendly name, not ARN) of the group to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "IsAttachable": { + "description": "", + "type": "boolean" + }, + "ManagedPolicyName": { + "description": "The friendly name of the policy.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", + "type": "string" + }, + "Path": { + "default": "/", + "description": "The path for the policy.\n For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use an asterisk (*) in the path name.", + "type": "string" + }, + "PermissionsBoundaryUsageCount": { + "description": "", + "type": "integer" + }, + "PolicyArn": { + "description": "", + "type": "string" + }, + "PolicyDocument": { + "description": "The JSON policy document that you want to use as the content for the new policy.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\n To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. \n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", + "type": [ + "object", + "string" + ] + }, + "PolicyId": { + "description": "", + "type": "string" + }, + "Roles": { + "description": "The name (friendly name, not ARN) of the role to attach the policy to.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "UpdateDate": { + "description": "", + "type": "string" + }, + "Users": { + "description": "The name (friendly name, not ARN) of the IAM user to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/PolicyArn", + "/properties/AttachmentCount", + "/properties/CreateDate", + "/properties/DefaultVersionId", + "/properties/IsAttachable", + "/properties/PermissionsBoundaryUsageCount", + "/properties/PolicyId", + "/properties/UpdateDate" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::ManagedPolicy" +} diff --git a/schema/aws-iam-oidcprovider.json b/schema/aws-iam-oidcprovider.json index fab8186..1d736d3 100644 --- a/schema/aws-iam-oidcprovider.json +++ b/schema/aws-iam-oidcprovider.json @@ -1,122 +1,122 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Url" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IAM::OIDCProvider", - "handlers": { - "create": { - "permissions": [ - "iam:CreateOpenIDConnectProvider", - "iam:TagOpenIDConnectProvider", - "iam:GetOpenIDConnectProvider" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteOpenIDConnectProvider" - ] - }, - "list": { - "permissions": [ - "iam:ListOpenIDConnectProvider", - "iam:GetOpenIDConnectProvider" - ] - }, - "read": { - "permissions": [ - "iam:GetOpenIDConnectProvider" - ] - }, - "update": { - "permissions": [ - "iam:UpdateOpenIDConnectProviderThumbprint", - "iam:RemoveClientIDFromOpenIDConnectProvider", - "iam:AddClientIDToOpenIDConnectProvider", - "iam:GetOpenIDConnectProvider", - "iam:TagOpenIDConnectProvider", - "iam:UntagOpenIDConnectProvider", - "iam:ListOpenIDConnectProviderTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN) of the OIDC provider", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ClientIdList": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "ThumbprintList": { - "insertionOrder": false, - "items": { - "maxLength": 40, - "minLength": 40, - "pattern": "[0-9A-Fa-f]{40}", - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "Url": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IAM::OIDCProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Url" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IAM::OIDCProvider", + "handlers": { + "create": { + "permissions": [ + "iam:CreateOpenIDConnectProvider", + "iam:TagOpenIDConnectProvider", + "iam:GetOpenIDConnectProvider" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteOpenIDConnectProvider" + ] + }, + "list": { + "permissions": [ + "iam:ListOpenIDConnectProvider", + "iam:GetOpenIDConnectProvider" + ] + }, + "read": { + "permissions": [ + "iam:GetOpenIDConnectProvider" + ] + }, + "update": { + "permissions": [ + "iam:UpdateOpenIDConnectProviderThumbprint", + "iam:RemoveClientIDFromOpenIDConnectProvider", + "iam:AddClientIDToOpenIDConnectProvider", + "iam:GetOpenIDConnectProvider", + "iam:TagOpenIDConnectProvider", + "iam:UntagOpenIDConnectProvider", + "iam:ListOpenIDConnectProviderTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN) of the OIDC provider", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ClientIdList": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "ThumbprintList": { + "insertionOrder": false, + "items": { + "maxLength": 40, + "minLength": 40, + "pattern": "[0-9A-Fa-f]{40}", + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "Url": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IAM::OIDCProvider" +} diff --git a/schema/aws-iam-policy.json b/schema/aws-iam-policy.json index 2013fab..4997c7c 100644 --- a/schema/aws-iam-policy.json +++ b/schema/aws-iam-policy.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "description": "Adds or updates an inline policy document that is embedded in the specified IAM group, user or role.\n An IAM user can also have a managed policy attached to it. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n The Groups, Roles, and Users properties are optional. However, you must specify at least one of these properties.\n For information about policy documents see [Creating policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed in an identity, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n This resource does not support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). The following", - "handlers": { - "create": { - "permissions": [ - "iam:GetUserPolicy", - "iam:GetRolePolicy", - "iam:GetGroupPolicy", - "iam:PutUserPolicy", - "iam:PutRolePolicy", - "iam:PutGroupPolicy" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "iam:DeleteRolePolicy", - "iam:DeleteUserPolicy", - "iam:DeleteGroupPolicy" - ], - "timeoutInMinutes": 2160 - }, - "update": { - "permissions": [ - "iam:PutUserPolicy", - "iam:PutRolePolicy", - "iam:PutGroupPolicy", - "iam:DeleteRolePolicy", - "iam:DeleteUserPolicy", - "iam:DeleteGroupPolicy" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Groups": { - "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "description": "", - "type": "string" - }, - "PolicyDocument": { - "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", - "maxLength": 131072, - "minLength": 1, - "type": [ - "object", - "string" - ] - }, - "PolicyName": { - "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Roles": { - "description": "The name of the role to associate the policy with.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Users": { - "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PolicyDocument", - "PolicyName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "taggable": false, - "typeName": "AWS::IAM::Policy" -} +{ + "additionalProperties": false, + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group, user or role.\n An IAM user can also have a managed policy attached to it. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n The Groups, Roles, and Users properties are optional. However, you must specify at least one of these properties.\n For information about policy documents see [Creating policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed in an identity, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n This resource does not support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). The following", + "handlers": { + "create": { + "permissions": [ + "iam:GetUserPolicy", + "iam:GetRolePolicy", + "iam:GetGroupPolicy", + "iam:PutUserPolicy", + "iam:PutRolePolicy", + "iam:PutGroupPolicy" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "iam:DeleteRolePolicy", + "iam:DeleteUserPolicy", + "iam:DeleteGroupPolicy" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "iam:PutUserPolicy", + "iam:PutRolePolicy", + "iam:PutGroupPolicy", + "iam:DeleteRolePolicy", + "iam:DeleteUserPolicy", + "iam:DeleteGroupPolicy" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Groups": { + "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "description": "", + "type": "string" + }, + "PolicyDocument": { + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", + "maxLength": 131072, + "minLength": 1, + "type": [ + "object", + "string" + ] + }, + "PolicyName": { + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Roles": { + "description": "The name of the role to associate the policy with.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Users": { + "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PolicyDocument", + "PolicyName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "taggable": false, + "typeName": "AWS::IAM::Policy" +} diff --git a/schema/aws-iam-role.json b/schema/aws-iam-role.json index 46984e0..7e3e30b 100644 --- a/schema/aws-iam-role.json +++ b/schema/aws-iam-role.json @@ -1,189 +1,189 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Path", - "/properties/RoleName" - ], - "definitions": { - "Policy": { - "additionalProperties": false, - "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", - "properties": { - "PolicyDocument": { - "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", - "type": [ - "string", - "object" - ] - }, - "PolicyName": { - "description": "The friendly name (not ARN) identifying the policy.", - "type": "string" - } - }, - "required": [ - "PolicyName", - "PolicyDocument" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", - "properties": { - "Key": { - "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", - "type": "string" - }, - "Value": { - "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates a new role for your AWS-account.\n For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateRole", - "iam:PutRolePolicy", - "iam:AttachRolePolicy", - "iam:GetRolePolicy", - "iam:TagRole", - "iam:UntagRole", - "iam:GetRole" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteRole", - "iam:DetachRolePolicy", - "iam:DeleteRolePolicy", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "iam:ListRolePolicies", - "iam:TagRole", - "iam:UntagRole" - ] - }, - "list": { - "permissions": [ - "iam:ListRoles" - ] - }, - "read": { - "permissions": [ - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "iam:ListRolePolicies", - "iam:GetRolePolicy" - ] - }, - "update": { - "permissions": [ - "iam:UpdateRole", - "iam:UpdateRoleDescription", - "iam:UpdateAssumeRolePolicy", - "iam:DetachRolePolicy", - "iam:AttachRolePolicy", - "iam:DeleteRolePermissionsBoundary", - "iam:PutRolePermissionsBoundary", - "iam:DeleteRolePolicy", - "iam:PutRolePolicy", - "iam:TagRole", - "iam:UntagRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RoleName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "AssumeRolePolicyDocument": { - "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.", - "type": [ - "object", - "string" - ] - }, - "Description": { - "description": "A description of the role that you provide.", - "type": "string" - }, - "ManagedPolicyArns": { - "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "MaxSessionDuration": { - "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.\n Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.", - "type": "integer" - }, - "Path": { - "default": "/", - "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", - "type": "string" - }, - "PermissionsBoundary": { - "description": "The ARN of the policy used to set the permissions boundary for the role.\n For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.", - "type": "string" - }, - "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).\n A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n If an external policy (such as ``AWS::IAM::Policy`` or", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Policy" - }, - "type": "array", - "uniqueItems": false - }, - "RoleId": { - "description": "", - "type": "string" - }, - "RoleName": { - "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both \"Role1\" and \"role1\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use", - "type": "string" - }, - "Tags": { - "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/RoleId" - ], - "required": [ - "AssumeRolePolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IAM::Role" -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Path", + "/properties/RoleName" + ], + "definitions": { + "Policy": { + "additionalProperties": false, + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", + "properties": { + "PolicyDocument": { + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", + "type": [ + "string", + "object" + ] + }, + "PolicyName": { + "description": "The friendly name (not ARN) identifying the policy.", + "type": "string" + } + }, + "required": [ + "PolicyName", + "PolicyDocument" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", + "properties": { + "Key": { + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", + "type": "string" + }, + "Value": { + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates a new role for your AWS-account.\n For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateRole", + "iam:PutRolePolicy", + "iam:AttachRolePolicy", + "iam:GetRolePolicy", + "iam:TagRole", + "iam:UntagRole", + "iam:GetRole" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteRole", + "iam:DetachRolePolicy", + "iam:DeleteRolePolicy", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "iam:ListRolePolicies", + "iam:TagRole", + "iam:UntagRole" + ] + }, + "list": { + "permissions": [ + "iam:ListRoles" + ] + }, + "read": { + "permissions": [ + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "iam:ListRolePolicies", + "iam:GetRolePolicy" + ] + }, + "update": { + "permissions": [ + "iam:UpdateRole", + "iam:UpdateRoleDescription", + "iam:UpdateAssumeRolePolicy", + "iam:DetachRolePolicy", + "iam:AttachRolePolicy", + "iam:DeleteRolePermissionsBoundary", + "iam:PutRolePermissionsBoundary", + "iam:DeleteRolePolicy", + "iam:PutRolePolicy", + "iam:TagRole", + "iam:UntagRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RoleName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "AssumeRolePolicyDocument": { + "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.", + "type": [ + "object", + "string" + ] + }, + "Description": { + "description": "A description of the role that you provide.", + "type": "string" + }, + "ManagedPolicyArns": { + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "MaxSessionDuration": { + "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.\n Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.", + "type": "integer" + }, + "Path": { + "default": "/", + "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", + "type": "string" + }, + "PermissionsBoundary": { + "description": "The ARN of the policy used to set the permissions boundary for the role.\n For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.", + "type": "string" + }, + "Policies": { + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).\n A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n If an external policy (such as ``AWS::IAM::Policy`` or", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Policy" + }, + "type": "array", + "uniqueItems": false + }, + "RoleId": { + "description": "", + "type": "string" + }, + "RoleName": { + "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both \"Role1\" and \"role1\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use", + "type": "string" + }, + "Tags": { + "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/RoleId" + ], + "required": [ + "AssumeRolePolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IAM::Role" +} diff --git a/schema/aws-iam-rolepolicy.json b/schema/aws-iam-rolepolicy.json index 9bdc2e1..aa3b32d 100644 --- a/schema/aws-iam-rolepolicy.json +++ b/schema/aws-iam-rolepolicy.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/RoleName" - ], - "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.\n A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:PutRolePolicy", - "iam:GetRolePolicy" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteRolePolicy", - "iam:GetRolePolicy" - ] - }, - "read": { - "permissions": [ - "iam:GetRolePolicy" - ] - }, - "update": { - "permissions": [ - "iam:PutRolePolicy", - "iam:GetRolePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyName", - "/properties/RoleName" - ], - "properties": { - "PolicyDocument": { - "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", - "type": "object" - }, - "PolicyName": { - "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - }, - "RoleName": { - "description": "The name of the role to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - } - }, - "required": [ - "PolicyName", - "RoleName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::RolePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/RoleName" + ], + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.\n A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:PutRolePolicy", + "iam:GetRolePolicy" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteRolePolicy", + "iam:GetRolePolicy" + ] + }, + "read": { + "permissions": [ + "iam:GetRolePolicy" + ] + }, + "update": { + "permissions": [ + "iam:PutRolePolicy", + "iam:GetRolePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyName", + "/properties/RoleName" + ], + "properties": { + "PolicyDocument": { + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", + "type": "object" + }, + "PolicyName": { + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + }, + "RoleName": { + "description": "The name of the role to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + } + }, + "required": [ + "PolicyName", + "RoleName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::RolePolicy" +} diff --git a/schema/aws-iam-samlprovider.json b/schema/aws-iam-samlprovider.json index 3103d15..d0b2050 100644 --- a/schema/aws-iam-samlprovider.json +++ b/schema/aws-iam-samlprovider.json @@ -1,109 +1,109 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IAM::SAMLProvider", - "handlers": { - "create": { - "permissions": [ - "iam:CreateSAMLProvider", - "iam:GetSAMLProvider", - "iam:TagSAMLProvider" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteSAMLProvider" - ] - }, - "list": { - "permissions": [ - "iam:ListSAMLProviders", - "iam:GetSAMLProvider" - ] - }, - "read": { - "permissions": [ - "iam:GetSAMLProvider" - ] - }, - "update": { - "permissions": [ - "iam:UpdateSAMLProvider", - "iam:GetSAMLProvider", - "iam:TagSAMLProvider", - "iam:ListSAMLProviderTags", - "iam:UntagSAMLProvider" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN) of the SAML provider", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w._-]+", - "type": "string" - }, - "SamlMetadataDocument": { - "maxLength": 10000000, - "minLength": 1000, - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "SamlMetadataDocument" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IAM::SAMLProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IAM::SAMLProvider", + "handlers": { + "create": { + "permissions": [ + "iam:CreateSAMLProvider", + "iam:GetSAMLProvider", + "iam:TagSAMLProvider" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteSAMLProvider" + ] + }, + "list": { + "permissions": [ + "iam:ListSAMLProviders", + "iam:GetSAMLProvider" + ] + }, + "read": { + "permissions": [ + "iam:GetSAMLProvider" + ] + }, + "update": { + "permissions": [ + "iam:UpdateSAMLProvider", + "iam:GetSAMLProvider", + "iam:TagSAMLProvider", + "iam:ListSAMLProviderTags", + "iam:UntagSAMLProvider" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN) of the SAML provider", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w._-]+", + "type": "string" + }, + "SamlMetadataDocument": { + "maxLength": 10000000, + "minLength": 1000, + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "SamlMetadataDocument" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IAM::SAMLProvider" +} diff --git a/schema/aws-iam-servercertificate.json b/schema/aws-iam-servercertificate.json index 89128fd..61e1e9f 100644 --- a/schema/aws-iam-servercertificate.json +++ b/schema/aws-iam-servercertificate.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerCertificateName", - "/properties/PrivateKey", - "/properties/CertificateBody", - "/properties/CertificateChain" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IAM::ServerCertificate", - "handlers": { - "create": { - "permissions": [ - "iam:UploadServerCertificate", - "iam:TagServerCertificate", - "iam:GetServerCertificate" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteServerCertificate" - ] - }, - "list": { - "permissions": [ - "iam:ListServerCertificates", - "iam:GetServerCertificate" - ] - }, - "read": { - "permissions": [ - "iam:GetServerCertificate" - ] - }, - "update": { - "permissions": [ - "iam:TagServerCertificate", - "iam:UntagServerCertificate", - "iam:ListServerCertificateTags", - "iam:GetServerCertificate" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServerCertificateName" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN) of the server certificate", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "CertificateBody": { - "maxLength": 16384, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "type": "string" - }, - "CertificateChain": { - "maxLength": 2097152, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "type": "string" - }, - "Path": { - "maxLength": 512, - "minLength": 1, - "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "type": "string" - }, - "PrivateKey": { - "maxLength": 16384, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "type": "string" - }, - "ServerCertificateName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IAM::ServerCertificate", - "writeOnlyProperties": [ - "/properties/PrivateKey", - "/properties/CertificateBody", - "/properties/CertificateChain" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerCertificateName", + "/properties/PrivateKey", + "/properties/CertificateBody", + "/properties/CertificateChain" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IAM::ServerCertificate", + "handlers": { + "create": { + "permissions": [ + "iam:UploadServerCertificate", + "iam:TagServerCertificate", + "iam:GetServerCertificate" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteServerCertificate" + ] + }, + "list": { + "permissions": [ + "iam:ListServerCertificates", + "iam:GetServerCertificate" + ] + }, + "read": { + "permissions": [ + "iam:GetServerCertificate" + ] + }, + "update": { + "permissions": [ + "iam:TagServerCertificate", + "iam:UntagServerCertificate", + "iam:ListServerCertificateTags", + "iam:GetServerCertificate" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServerCertificateName" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN) of the server certificate", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "CertificateBody": { + "maxLength": 16384, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "type": "string" + }, + "CertificateChain": { + "maxLength": 2097152, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "type": "string" + }, + "Path": { + "maxLength": 512, + "minLength": 1, + "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", + "type": "string" + }, + "PrivateKey": { + "maxLength": 16384, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "type": "string" + }, + "ServerCertificateName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IAM::ServerCertificate", + "writeOnlyProperties": [ + "/properties/PrivateKey", + "/properties/CertificateBody", + "/properties/CertificateChain" + ] +} diff --git a/schema/aws-iam-servicelinkedrole.json b/schema/aws-iam-servicelinkedrole.json index 8cbc380..5aa2fc5 100644 --- a/schema/aws-iam-servicelinkedrole.json +++ b/schema/aws-iam-servicelinkedrole.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CustomSuffix", - "/properties/AWSServiceName" - ], - "description": "Resource Type definition for AWS::IAM::ServiceLinkedRole", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "iam:GetRole" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteServiceLinkedRole", - "iam:GetServiceLinkedRoleDeletionStatus", - "iam:GetRole" - ] - }, - "read": { - "permissions": [ - "iam:GetRole" - ] - }, - "update": { - "permissions": [ - "iam:UpdateRole", - "iam:GetRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/RoleName" - ], - "properties": { - "AWSServiceName": { - "description": "The service principal for the AWS service to which this role is attached.", - "type": "string" - }, - "CustomSuffix": { - "description": "A string that you provide, which is combined with the service-provided prefix to form the complete role name.", - "type": "string" - }, - "Description": { - "description": "The description of the role.", - "type": "string" - }, - "RoleName": { - "description": "The name of the role.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RoleName" - ], - "required": [], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::ServiceLinkedRole", - "writeOnlyProperties": [ - "/properties/CustomSuffix", - "/properties/AWSServiceName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CustomSuffix", + "/properties/AWSServiceName" + ], + "description": "Resource Type definition for AWS::IAM::ServiceLinkedRole", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "iam:GetRole" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteServiceLinkedRole", + "iam:GetServiceLinkedRoleDeletionStatus", + "iam:GetRole" + ] + }, + "read": { + "permissions": [ + "iam:GetRole" + ] + }, + "update": { + "permissions": [ + "iam:UpdateRole", + "iam:GetRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/RoleName" + ], + "properties": { + "AWSServiceName": { + "description": "The service principal for the AWS service to which this role is attached.", + "type": "string" + }, + "CustomSuffix": { + "description": "A string that you provide, which is combined with the service-provided prefix to form the complete role name.", + "type": "string" + }, + "Description": { + "description": "The description of the role.", + "type": "string" + }, + "RoleName": { + "description": "The name of the role.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RoleName" + ], + "required": [], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::ServiceLinkedRole", + "writeOnlyProperties": [ + "/properties/CustomSuffix", + "/properties/AWSServiceName" + ] +} diff --git a/schema/aws-iam-user.json b/schema/aws-iam-user.json index fe7cdfd..63452f4 100644 --- a/schema/aws-iam-user.json +++ b/schema/aws-iam-user.json @@ -1,210 +1,210 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserName" - ], - "definitions": { - "LoginProfile": { - "additionalProperties": false, - "description": "Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.", - "properties": { - "Password": { - "description": "The user's password.", - "type": "string" - }, - "PasswordResetRequired": { - "description": "Specifies whether the user is required to set a new password on next sign-in.", - "type": "boolean" - } - }, - "required": [ - "Password" - ], - "type": "object" - }, - "Policy": { - "additionalProperties": false, - "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", - "properties": { - "PolicyDocument": { - "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", - "type": [ - "object", - "string" - ] - }, - "PolicyName": { - "description": "The friendly name (not ARN) identifying the policy.", - "type": "string" - } - }, - "required": [ - "PolicyName", - "PolicyDocument" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", - "properties": { - "Key": { - "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", - "type": "string" - }, - "Value": { - "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates a new IAM user for your AWS-account.\n For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateLoginProfile", - "iam:AddUserToGroup", - "iam:PutUserPolicy", - "iam:AttachUserPolicy", - "iam:CreateUser", - "iam:GetUser", - "iam:TagUser" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteAccessKey", - "iam:RemoveUserFromGroup", - "iam:DeleteUserPolicy", - "iam:DeleteUser", - "iam:DetachUserPolicy", - "iam:DeleteLoginProfile", - "iam:ListAccessKeys", - "iam:GetUserPolicy", - "iam:ListGroupsForUser", - "iam:ListAttachedUserPolicies", - "iam:ListUserPolicies", - "iam:GetUser", - "iam:GetLoginProfile" - ] - }, - "list": { - "permissions": [ - "iam:listUsers" - ] - }, - "read": { - "permissions": [ - "iam:GetUserPolicy", - "iam:ListGroupsForUser", - "iam:ListAttachedUserPolicies", - "iam:ListUserPolicies", - "iam:GetUser", - "iam:GetLoginProfile" - ] - }, - "update": { - "permissions": [ - "iam:UpdateLoginProfile", - "iam:UpdateUser", - "iam:PutUserPermissionsBoundary", - "iam:AttachUserPolicy", - "iam:DeleteUserPolicy", - "iam:DeleteUserPermissionsBoundary", - "iam:TagUser", - "iam:UntagUser", - "iam:CreateLoginProfile", - "iam:RemoveUserFromGroup", - "iam:AddUserToGroup", - "iam:PutUserPolicy", - "iam:DetachUserPolicy", - "iam:GetLoginProfile", - "iam:DeleteLoginProfile", - "iam:GetUser", - "iam:ListUserTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "Groups": { - "description": "A list of group names to which you want to add the user.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LoginProfile": { - "$ref": "#/definitions/LoginProfile", - "description": "Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.\n You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.\n For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*." - }, - "ManagedPolicyArns": { - "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Path": { - "description": "The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", - "type": "string" - }, - "PermissionsBoundary": { - "description": "The ARN of the managed policy that is used to set the permissions boundary for the user.\n A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.", - "type": "string" - }, - "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).\n The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Policy" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.\n If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserName": { - "description": "The name of the user to create. Do not include the path in this value.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both \"John\" and \"john\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IAM::User", - "writeOnlyProperties": [ - "/properties/LoginProfile/Password" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserName" + ], + "definitions": { + "LoginProfile": { + "additionalProperties": false, + "description": "Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.", + "properties": { + "Password": { + "description": "The user's password.", + "type": "string" + }, + "PasswordResetRequired": { + "description": "Specifies whether the user is required to set a new password on next sign-in.", + "type": "boolean" + } + }, + "required": [ + "Password" + ], + "type": "object" + }, + "Policy": { + "additionalProperties": false, + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", + "properties": { + "PolicyDocument": { + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", + "type": [ + "object", + "string" + ] + }, + "PolicyName": { + "description": "The friendly name (not ARN) identifying the policy.", + "type": "string" + } + }, + "required": [ + "PolicyName", + "PolicyDocument" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", + "properties": { + "Key": { + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", + "type": "string" + }, + "Value": { + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates a new IAM user for your AWS-account.\n For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateLoginProfile", + "iam:AddUserToGroup", + "iam:PutUserPolicy", + "iam:AttachUserPolicy", + "iam:CreateUser", + "iam:GetUser", + "iam:TagUser" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteAccessKey", + "iam:RemoveUserFromGroup", + "iam:DeleteUserPolicy", + "iam:DeleteUser", + "iam:DetachUserPolicy", + "iam:DeleteLoginProfile", + "iam:ListAccessKeys", + "iam:GetUserPolicy", + "iam:ListGroupsForUser", + "iam:ListAttachedUserPolicies", + "iam:ListUserPolicies", + "iam:GetUser", + "iam:GetLoginProfile" + ] + }, + "list": { + "permissions": [ + "iam:listUsers" + ] + }, + "read": { + "permissions": [ + "iam:GetUserPolicy", + "iam:ListGroupsForUser", + "iam:ListAttachedUserPolicies", + "iam:ListUserPolicies", + "iam:GetUser", + "iam:GetLoginProfile" + ] + }, + "update": { + "permissions": [ + "iam:UpdateLoginProfile", + "iam:UpdateUser", + "iam:PutUserPermissionsBoundary", + "iam:AttachUserPolicy", + "iam:DeleteUserPolicy", + "iam:DeleteUserPermissionsBoundary", + "iam:TagUser", + "iam:UntagUser", + "iam:CreateLoginProfile", + "iam:RemoveUserFromGroup", + "iam:AddUserToGroup", + "iam:PutUserPolicy", + "iam:DetachUserPolicy", + "iam:GetLoginProfile", + "iam:DeleteLoginProfile", + "iam:GetUser", + "iam:ListUserTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "Groups": { + "description": "A list of group names to which you want to add the user.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LoginProfile": { + "$ref": "#/definitions/LoginProfile", + "description": "Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.\n You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.\n For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*." + }, + "ManagedPolicyArns": { + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Path": { + "description": "The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", + "type": "string" + }, + "PermissionsBoundary": { + "description": "The ARN of the managed policy that is used to set the permissions boundary for the user.\n A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.", + "type": "string" + }, + "Policies": { + "description": "Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).\n The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Policy" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.\n If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserName": { + "description": "The name of the user to create. Do not include the path in this value.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both \"John\" and \"john\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IAM::User", + "writeOnlyProperties": [ + "/properties/LoginProfile/Password" + ] +} diff --git a/schema/aws-iam-userpolicy.json b/schema/aws-iam-userpolicy.json index 830dd26..ac35caf 100644 --- a/schema/aws-iam-userpolicy.json +++ b/schema/aws-iam-userpolicy.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/UserName" - ], - "description": "Adds or updates an inline policy document that is embedded in the specified IAM user.\n An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:PutUserPolicy", - "iam:GetUserPolicy" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteUserPolicy", - "iam:GetUserPolicy" - ] - }, - "read": { - "permissions": [ - "iam:GetUserPolicy" - ] - }, - "update": { - "permissions": [ - "iam:PutUserPolicy", - "iam:GetUserPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyName", - "/properties/UserName" - ], - "properties": { - "PolicyDocument": { - "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", - "type": "object" - }, - "PolicyName": { - "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - }, - "UserName": { - "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", - "type": "string" - } - }, - "required": [ - "PolicyName", - "UserName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IAM::UserPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/UserName" + ], + "description": "Adds or updates an inline policy document that is embedded in the specified IAM user.\n An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:PutUserPolicy", + "iam:GetUserPolicy" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteUserPolicy", + "iam:GetUserPolicy" + ] + }, + "read": { + "permissions": [ + "iam:GetUserPolicy" + ] + }, + "update": { + "permissions": [ + "iam:PutUserPolicy", + "iam:GetUserPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyName", + "/properties/UserName" + ], + "properties": { + "PolicyDocument": { + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII character ranging from the space character (``\\u0020``) through the end of the ASCII character range\n + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", + "type": "object" + }, + "PolicyName": { + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + }, + "UserName": { + "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", + "type": "string" + } + }, + "required": [ + "PolicyName", + "UserName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iam.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IAM::UserPolicy" +} diff --git a/schema/aws-iam-usertogroupaddition.json b/schema/aws-iam-usertogroupaddition.json index 75e2d66..abe687c 100644 --- a/schema/aws-iam-usertogroupaddition.json +++ b/schema/aws-iam-usertogroupaddition.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::IAM::UserToGroupAddition", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "GroupName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "GroupName", - "Users" - ], - "typeName": "AWS::IAM::UserToGroupAddition" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::IAM::UserToGroupAddition", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "GroupName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Users": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "GroupName", + "Users" + ], + "typeName": "AWS::IAM::UserToGroupAddition" +} diff --git a/schema/aws-iam-virtualmfadevice.json b/schema/aws-iam-virtualmfadevice.json index eb8b2b9..5b6f9ad 100644 --- a/schema/aws-iam-virtualmfadevice.json +++ b/schema/aws-iam-virtualmfadevice.json @@ -1,109 +1,109 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VirtualMfaDeviceName", - "/properties/Base32StringSeed", - "/properties/Path" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IAM::VirtualMFADevice", - "handlers": { - "create": { - "permissions": [ - "iam:CreateVirtualMFADevice", - "iam:EnableMFADevice", - "iam:ListVirtualMFADevices" - ] - }, - "delete": { - "permissions": [ - "iam:DeleteVirtualMFADevice", - "iam:DeactivateMFADevice" - ] - }, - "list": { - "permissions": [ - "iam:ListVirtualMFADevices" - ] - }, - "read": { - "permissions": [ - "iam:ListVirtualMFADevices" - ] - }, - "update": { - "permissions": [ - "iam:TagMFADevice", - "iam:UntagMFADevice" - ] - } - }, - "primaryIdentifier": [ - "/properties/SerialNumber" - ], - "properties": { - "Path": { - "maxLength": 512, - "minLength": 1, - "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "type": "string" - }, - "SerialNumber": { - "maxLength": 256, - "minLength": 9, - "pattern": "[\\w+=/:,.@-]+", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VirtualMfaDeviceName": { - "maxLength": 226, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SerialNumber" - ], - "required": [ - "Users" - ], - "typeName": "AWS::IAM::VirtualMFADevice" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VirtualMfaDeviceName", + "/properties/Base32StringSeed", + "/properties/Path" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IAM::VirtualMFADevice", + "handlers": { + "create": { + "permissions": [ + "iam:CreateVirtualMFADevice", + "iam:EnableMFADevice", + "iam:ListVirtualMFADevices" + ] + }, + "delete": { + "permissions": [ + "iam:DeleteVirtualMFADevice", + "iam:DeactivateMFADevice" + ] + }, + "list": { + "permissions": [ + "iam:ListVirtualMFADevices" + ] + }, + "read": { + "permissions": [ + "iam:ListVirtualMFADevices" + ] + }, + "update": { + "permissions": [ + "iam:TagMFADevice", + "iam:UntagMFADevice" + ] + } + }, + "primaryIdentifier": [ + "/properties/SerialNumber" + ], + "properties": { + "Path": { + "maxLength": 512, + "minLength": 1, + "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", + "type": "string" + }, + "SerialNumber": { + "maxLength": 256, + "minLength": 9, + "pattern": "[\\w+=/:,.@-]+", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Users": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VirtualMfaDeviceName": { + "maxLength": 226, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SerialNumber" + ], + "required": [ + "Users" + ], + "typeName": "AWS::IAM::VirtualMFADevice" +} diff --git a/schema/aws-identitystore-group.json b/schema/aws-identitystore-group.json index 09bb346..ab3be27 100644 --- a/schema/aws-identitystore-group.json +++ b/schema/aws-identitystore-group.json @@ -1,96 +1,96 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityStoreId" - ], - "description": "Resource Type definition for AWS::IdentityStore::Group", - "handlers": { - "create": { - "permissions": [ - "identitystore:CreateGroup", - "identitystore:DescribeGroup" - ] - }, - "delete": { - "permissions": [ - "identitystore:DescribeGroup", - "identitystore:DeleteGroup" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "IdentityStoreId": { - "$ref": "resource-schema.json#/properties/IdentityStoreId" - } - }, - "required": [ - "IdentityStoreId" - ] - }, - "permissions": [ - "identitystore:ListGroups" - ] - }, - "read": { - "permissions": [ - "identitystore:DescribeGroup" - ] - }, - "update": { - "permissions": [ - "identitystore:DescribeGroup", - "identitystore:UpdateGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/GroupId", - "/properties/IdentityStoreId" - ], - "properties": { - "Description": { - "description": "A string containing the description of the group.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r \u3000]+$", - "type": "string" - }, - "DisplayName": { - "description": "A string containing the name of the group. This value is commonly displayed when the group is referenced.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+$", - "type": "string" - }, - "GroupId": { - "description": "The unique identifier for a group in the identity store.", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - }, - "IdentityStoreId": { - "description": "The globally unique identifier for the identity store.", - "maxLength": 36, - "minLength": 1, - "pattern": "^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/GroupId" - ], - "required": [ - "IdentityStoreId", - "DisplayName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-identitystore", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IdentityStore::Group" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityStoreId" + ], + "description": "Resource Type definition for AWS::IdentityStore::Group", + "handlers": { + "create": { + "permissions": [ + "identitystore:CreateGroup", + "identitystore:DescribeGroup" + ] + }, + "delete": { + "permissions": [ + "identitystore:DescribeGroup", + "identitystore:DeleteGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IdentityStoreId": { + "$ref": "resource-schema.json#/properties/IdentityStoreId" + } + }, + "required": [ + "IdentityStoreId" + ] + }, + "permissions": [ + "identitystore:ListGroups" + ] + }, + "read": { + "permissions": [ + "identitystore:DescribeGroup" + ] + }, + "update": { + "permissions": [ + "identitystore:DescribeGroup", + "identitystore:UpdateGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/GroupId", + "/properties/IdentityStoreId" + ], + "properties": { + "Description": { + "description": "A string containing the description of the group.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r \u3000]+$", + "type": "string" + }, + "DisplayName": { + "description": "A string containing the name of the group. This value is commonly displayed when the group is referenced.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+$", + "type": "string" + }, + "GroupId": { + "description": "The unique identifier for a group in the identity store.", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + }, + "IdentityStoreId": { + "description": "The globally unique identifier for the identity store.", + "maxLength": 36, + "minLength": 1, + "pattern": "^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/GroupId" + ], + "required": [ + "IdentityStoreId", + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-identitystore", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IdentityStore::Group" +} diff --git a/schema/aws-identitystore-groupmembership.json b/schema/aws-identitystore-groupmembership.json index 8f7495c..8ab9236 100644 --- a/schema/aws-identitystore-groupmembership.json +++ b/schema/aws-identitystore-groupmembership.json @@ -1,114 +1,114 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityStoreId", - "/properties/GroupId", - "/properties/MemberId" - ], - "definitions": { - "MemberId": { - "additionalProperties": false, - "description": "An object containing the identifier of a group member.", - "properties": { - "UserId": { - "description": "The identifier for a user in the identity store.", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - } - }, - "required": [ - "UserId" - ], - "title": "UserId", - "type": "object" - } - }, - "description": "Resource Type Definition for AWS:IdentityStore::GroupMembership", - "handlers": { - "create": { - "permissions": [ - "identitystore:CreateGroupMembership", - "identitystore:DescribeGroupMembership" - ] - }, - "delete": { - "permissions": [ - "identitystore:DeleteGroupMembership", - "identitystore:DescribeGroupMembership" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GroupId": { - "$ref": "resource-schema.json#/properties/GroupId" - }, - "IdentityStoreId": { - "$ref": "resource-schema.json#/properties/IdentityStoreId" - } - }, - "required": [ - "IdentityStoreId", - "GroupId" - ] - }, - "permissions": [ - "identitystore:ListGroupMemberships" - ] - }, - "read": { - "permissions": [ - "identitystore:DescribeGroupMembership" - ] - } - }, - "primaryIdentifier": [ - "/properties/MembershipId", - "/properties/IdentityStoreId" - ], - "properties": { - "GroupId": { - "description": "The unique identifier for a group in the identity store.", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - }, - "IdentityStoreId": { - "description": "The globally unique identifier for the identity store.", - "maxLength": 36, - "minLength": 1, - "pattern": "^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "MemberId": { - "$ref": "#/definitions/MemberId", - "description": "An object containing the identifier of a group member." - }, - "MembershipId": { - "description": "The identifier for a GroupMembership in the identity store.", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/MembershipId" - ], - "required": [ - "IdentityStoreId", - "GroupId", - "MemberId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-identitystore", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IdentityStore::GroupMembership" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityStoreId", + "/properties/GroupId", + "/properties/MemberId" + ], + "definitions": { + "MemberId": { + "additionalProperties": false, + "description": "An object containing the identifier of a group member.", + "properties": { + "UserId": { + "description": "The identifier for a user in the identity store.", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + } + }, + "required": [ + "UserId" + ], + "title": "UserId", + "type": "object" + } + }, + "description": "Resource Type Definition for AWS:IdentityStore::GroupMembership", + "handlers": { + "create": { + "permissions": [ + "identitystore:CreateGroupMembership", + "identitystore:DescribeGroupMembership" + ] + }, + "delete": { + "permissions": [ + "identitystore:DeleteGroupMembership", + "identitystore:DescribeGroupMembership" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GroupId": { + "$ref": "resource-schema.json#/properties/GroupId" + }, + "IdentityStoreId": { + "$ref": "resource-schema.json#/properties/IdentityStoreId" + } + }, + "required": [ + "IdentityStoreId", + "GroupId" + ] + }, + "permissions": [ + "identitystore:ListGroupMemberships" + ] + }, + "read": { + "permissions": [ + "identitystore:DescribeGroupMembership" + ] + } + }, + "primaryIdentifier": [ + "/properties/MembershipId", + "/properties/IdentityStoreId" + ], + "properties": { + "GroupId": { + "description": "The unique identifier for a group in the identity store.", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + }, + "IdentityStoreId": { + "description": "The globally unique identifier for the identity store.", + "maxLength": 36, + "minLength": 1, + "pattern": "^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "MemberId": { + "$ref": "#/definitions/MemberId", + "description": "An object containing the identifier of a group member." + }, + "MembershipId": { + "description": "The identifier for a GroupMembership in the identity store.", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/MembershipId" + ], + "required": [ + "IdentityStoreId", + "GroupId", + "MemberId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-identitystore", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IdentityStore::GroupMembership" +} diff --git a/schema/aws-imagebuilder-component.json b/schema/aws-imagebuilder-component.json index 754fed7..64cfd15 100644 --- a/schema/aws-imagebuilder-component.json +++ b/schema/aws-imagebuilder-component.json @@ -1,172 +1,172 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Version", - "/properties/ChangeDescription", - "/properties/Description", - "/properties/Platform", - "/properties/Data", - "/properties/Uri", - "/properties/KmsKeyId", - "/properties/SupportedOsVersions", - "/properties/Tags" - ], - "description": "Resource schema for AWS::ImageBuilder::Component", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "iam:GetRole", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext", - "kms:Encrypt", - "kms:Decrypt", - "s3:GetObject", - "s3:HeadBucket", - "s3:GetBucketLocation", - "imagebuilder:TagResource", - "imagebuilder:GetComponent", - "imagebuilder:CreateComponent" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:GetComponent", - "imagebuilder:UnTagResource", - "imagebuilder:DeleteComponent" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/Arn" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "imagebuilder:ListComponents" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetComponent" - ] - } - }, - "oneOf": [ - { - "required": [ - "Data" - ] - }, - { - "required": [ - "Uri" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the component.", - "type": "string" - }, - "ChangeDescription": { - "description": "The change description of the component.", - "type": "string" - }, - "Data": { - "description": "The data of the component.", - "maxLength": 16000, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The description of the component.", - "type": "string" - }, - "Encrypted": { - "description": "The encryption status of the component.", - "type": "boolean" - }, - "KmsKeyId": { - "description": "The KMS key identifier used to encrypt the component.", - "type": "string" - }, - "Name": { - "description": "The name of the component.", - "type": "string" - }, - "Platform": { - "description": "The platform of the component.", - "enum": [ - "Windows", - "Linux" - ], - "type": "string" - }, - "SupportedOsVersions": { - "description": "The operating system (OS) version supported by the component.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the component.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "description": "The type of the component denotes whether the component is used to build the image or only to test it. ", - "enum": [ - "BUILD", - "TEST" - ], - "type": "string" - }, - "Uri": { - "description": "The uri of the component.", - "type": "string" - }, - "Version": { - "description": "The version of the component.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Type", - "/properties/Encrypted" - ], - "required": [ - "Name", - "Platform", - "Version" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::Component", - "writeOnlyProperties": [ - "/properties/Data", - "/properties/Uri", - "/properties/Platform" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Version", + "/properties/ChangeDescription", + "/properties/Description", + "/properties/Platform", + "/properties/Data", + "/properties/Uri", + "/properties/KmsKeyId", + "/properties/SupportedOsVersions", + "/properties/Tags" + ], + "description": "Resource schema for AWS::ImageBuilder::Component", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext", + "kms:Encrypt", + "kms:Decrypt", + "s3:GetObject", + "s3:HeadBucket", + "s3:GetBucketLocation", + "imagebuilder:TagResource", + "imagebuilder:GetComponent", + "imagebuilder:CreateComponent" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:GetComponent", + "imagebuilder:UnTagResource", + "imagebuilder:DeleteComponent" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Arn" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "imagebuilder:ListComponents" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetComponent" + ] + } + }, + "oneOf": [ + { + "required": [ + "Data" + ] + }, + { + "required": [ + "Uri" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the component.", + "type": "string" + }, + "ChangeDescription": { + "description": "The change description of the component.", + "type": "string" + }, + "Data": { + "description": "The data of the component.", + "maxLength": 16000, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The description of the component.", + "type": "string" + }, + "Encrypted": { + "description": "The encryption status of the component.", + "type": "boolean" + }, + "KmsKeyId": { + "description": "The KMS key identifier used to encrypt the component.", + "type": "string" + }, + "Name": { + "description": "The name of the component.", + "type": "string" + }, + "Platform": { + "description": "The platform of the component.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string" + }, + "SupportedOsVersions": { + "description": "The operating system (OS) version supported by the component.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the component.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "description": "The type of the component denotes whether the component is used to build the image or only to test it. ", + "enum": [ + "BUILD", + "TEST" + ], + "type": "string" + }, + "Uri": { + "description": "The uri of the component.", + "type": "string" + }, + "Version": { + "description": "The version of the component.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Type", + "/properties/Encrypted" + ], + "required": [ + "Name", + "Platform", + "Version" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::Component", + "writeOnlyProperties": [ + "/properties/Data", + "/properties/Uri", + "/properties/Platform" + ] +} diff --git a/schema/aws-imagebuilder-containerrecipe.json b/schema/aws-imagebuilder-containerrecipe.json index 4dafb57..3f5bcb4 100644 --- a/schema/aws-imagebuilder-containerrecipe.json +++ b/schema/aws-imagebuilder-containerrecipe.json @@ -1,343 +1,343 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Version", - "/properties/ContainerType", - "/properties/TargetRepository", - "/properties/InstanceConfiguration", - "/properties/ParentImage", - "/properties/Description", - "/properties/DockerfileTemplateUri", - "/properties/DockerfileTemplateData", - "/properties/ImageOsVersionOverride", - "/properties/KmsKeyId", - "/properties/PlatformOverride", - "/properties/WorkingDirectory", - "/properties/Components", - "/properties/Tags" - ], - "definitions": { - "ComponentConfiguration": { - "additionalProperties": false, - "description": "Configuration details of the component.", - "properties": { - "ComponentArn": { - "description": "The Amazon Resource Name (ARN) of the component.", - "type": "string" - }, - "Parameters": { - "description": "A group of parameter settings that are used to configure the component for a specific recipe.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ComponentParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "ComponentParameter": { - "additionalProperties": false, - "description": "Contains a key/value pair that sets the named component parameter.", - "properties": { - "Name": { - "description": "The name of the component parameter to set.", - "type": "string" - }, - "Value": { - "description": "Sets the value for the named component parameter.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "EbsInstanceBlockDeviceSpecification": { - "additionalProperties": false, - "description": "Amazon EBS-specific block device mapping specifications. ", - "properties": { - "DeleteOnTermination": { - "description": "Use to configure delete on termination of the associated device.", - "type": "boolean" - }, - "Encrypted": { - "description": "Use to configure device encryption.", - "type": "boolean" - }, - "Iops": { - "description": "Use to configure device IOPS.", - "type": "integer" - }, - "KmsKeyId": { - "description": "Use to configure the KMS key to use when encrypting the device.", - "type": "string" - }, - "SnapshotId": { - "description": "The snapshot that defines the device contents.", - "type": "string" - }, - "Throughput": { - "description": "For GP3 volumes only - The throughput in MiB/s that the volume supports.", - "type": "integer" - }, - "VolumeSize": { - "description": "Use to override the device's volume size.", - "type": "integer" - }, - "VolumeType": { - "description": "Use to override the device's volume type.", - "enum": [ - "standard", - "io1", - "io2", - "gp2", - "gp3", - "sc1", - "st1" - ], - "type": "string" - } - }, - "type": "object" - }, - "InstanceBlockDeviceMapping": { - "additionalProperties": false, - "description": "Defines block device mappings for the instance used to configure your image. ", - "properties": { - "DeviceName": { - "description": "The device to which these mappings apply.", - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/EbsInstanceBlockDeviceSpecification", - "description": "Use to manage Amazon EBS-specific configuration for this mapping." - }, - "NoDevice": { - "description": "Use to remove a mapping from the parent image.", - "type": "string" - }, - "VirtualName": { - "description": "Use to manage instance ephemeral devices.", - "type": "string" - } - }, - "type": "object" - }, - "InstanceConfiguration": { - "additionalProperties": false, - "description": "A group of options that can be used to configure an instance for building and testing container images.", - "properties": { - "BlockDeviceMappings": { - "description": "Defines the block devices to attach for building an instance from this Image Builder AMI.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceBlockDeviceMapping" - }, - "type": "array" - }, - "Image": { - "description": "The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.", - "type": "string" - } - }, - "type": "object" - }, - "TargetContainerRepository": { - "additionalProperties": false, - "description": "The container repository where the output container image is stored.", - "properties": { - "RepositoryName": { - "description": "The name of the container repository where the output container image is stored. This name is prefixed by the repository location.", - "type": "string" - }, - "Service": { - "description": "Specifies the service in which this image was registered.", - "enum": [ - "ECR" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::ImageBuilder::ContainerRecipe", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "imagebuilder:GetComponent", - "imagebuilder:TagResource", - "imagebuilder:GetContainerRecipe", - "imagebuilder:CreateContainerRecipe", - "imagebuilder:GetImage", - "kms:Encrypt", - "kms:Decrypt", - "kms:ReEncryptFrom", - "kms:ReEncryptTo", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext", - "s3:GetObject", - "s3:ListBucket", - "ecr:DescribeRepositories", - "ec2:DescribeImages" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:UnTagResource", - "imagebuilder:GetContainerRecipe", - "imagebuilder:DeleteContainerRecipe" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListContainerRecipes" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetContainerRecipe" - ] - } - }, - "oneOf": [ - { - "required": [ - "DockerfileTemplateData", - "Name", - "Version", - "Components", - "ParentImage", - "TargetRepository", - "ContainerType" - ] - }, - { - "required": [ - "DockerfileTemplateUri", - "Name", - "Version", - "Components", - "ParentImage", - "TargetRepository", - "ContainerType" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the container recipe.", - "type": "string" - }, - "Components": { - "description": "Components for build and test that are included in the container recipe.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ComponentConfiguration" - }, - "type": "array" - }, - "ContainerType": { - "description": "Specifies the type of container, such as Docker.", - "enum": [ - "DOCKER" - ], - "type": "string" - }, - "Description": { - "description": "The description of the container recipe.", - "type": "string" - }, - "DockerfileTemplateData": { - "description": "Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.", - "type": "string" - }, - "DockerfileTemplateUri": { - "description": "The S3 URI for the Dockerfile that will be used to build your container image.", - "type": "string" - }, - "ImageOsVersionOverride": { - "description": "Specifies the operating system version for the source image.", - "type": "string" - }, - "InstanceConfiguration": { - "$ref": "#/definitions/InstanceConfiguration", - "additionalProperties": false, - "description": "A group of options that can be used to configure an instance for building and testing container images." - }, - "KmsKeyId": { - "description": "Identifies which KMS key is used to encrypt the container image.", - "type": "string" - }, - "Name": { - "description": "The name of the container recipe.", - "type": "string" - }, - "ParentImage": { - "description": "The source image for the container recipe.", - "type": "string" - }, - "PlatformOverride": { - "description": "Specifies the operating system platform when you use a custom source image.", - "enum": [ - "Windows", - "Linux" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "Tags that are attached to the container recipe.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "TargetRepository": { - "$ref": "#/definitions/TargetContainerRepository", - "description": "The destination repository for the container image." - }, - "Version": { - "description": "The semantic version of the container recipe (..).", - "type": "string" - }, - "WorkingDirectory": { - "description": "The working directory to be used during build and test workflows.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/InstanceConfiguration/BlockDeviceMappings/*/Ebs/VolumeType": "$uppercase(VolumeType)" - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::ContainerRecipe", - "writeOnlyProperties": [ - "/properties/DockerfileTemplateData", - "/properties/DockerfileTemplateUri", - "/properties/ImageOsVersionOverride", - "/properties/PlatformOverride" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Version", + "/properties/ContainerType", + "/properties/TargetRepository", + "/properties/InstanceConfiguration", + "/properties/ParentImage", + "/properties/Description", + "/properties/DockerfileTemplateUri", + "/properties/DockerfileTemplateData", + "/properties/ImageOsVersionOverride", + "/properties/KmsKeyId", + "/properties/PlatformOverride", + "/properties/WorkingDirectory", + "/properties/Components", + "/properties/Tags" + ], + "definitions": { + "ComponentConfiguration": { + "additionalProperties": false, + "description": "Configuration details of the component.", + "properties": { + "ComponentArn": { + "description": "The Amazon Resource Name (ARN) of the component.", + "type": "string" + }, + "Parameters": { + "description": "A group of parameter settings that are used to configure the component for a specific recipe.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ComponentParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComponentParameter": { + "additionalProperties": false, + "description": "Contains a key/value pair that sets the named component parameter.", + "properties": { + "Name": { + "description": "The name of the component parameter to set.", + "type": "string" + }, + "Value": { + "description": "Sets the value for the named component parameter.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "EbsInstanceBlockDeviceSpecification": { + "additionalProperties": false, + "description": "Amazon EBS-specific block device mapping specifications. ", + "properties": { + "DeleteOnTermination": { + "description": "Use to configure delete on termination of the associated device.", + "type": "boolean" + }, + "Encrypted": { + "description": "Use to configure device encryption.", + "type": "boolean" + }, + "Iops": { + "description": "Use to configure device IOPS.", + "type": "integer" + }, + "KmsKeyId": { + "description": "Use to configure the KMS key to use when encrypting the device.", + "type": "string" + }, + "SnapshotId": { + "description": "The snapshot that defines the device contents.", + "type": "string" + }, + "Throughput": { + "description": "For GP3 volumes only - The throughput in MiB/s that the volume supports.", + "type": "integer" + }, + "VolumeSize": { + "description": "Use to override the device's volume size.", + "type": "integer" + }, + "VolumeType": { + "description": "Use to override the device's volume type.", + "enum": [ + "standard", + "io1", + "io2", + "gp2", + "gp3", + "sc1", + "st1" + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceBlockDeviceMapping": { + "additionalProperties": false, + "description": "Defines block device mappings for the instance used to configure your image. ", + "properties": { + "DeviceName": { + "description": "The device to which these mappings apply.", + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/EbsInstanceBlockDeviceSpecification", + "description": "Use to manage Amazon EBS-specific configuration for this mapping." + }, + "NoDevice": { + "description": "Use to remove a mapping from the parent image.", + "type": "string" + }, + "VirtualName": { + "description": "Use to manage instance ephemeral devices.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceConfiguration": { + "additionalProperties": false, + "description": "A group of options that can be used to configure an instance for building and testing container images.", + "properties": { + "BlockDeviceMappings": { + "description": "Defines the block devices to attach for building an instance from this Image Builder AMI.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceBlockDeviceMapping" + }, + "type": "array" + }, + "Image": { + "description": "The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.", + "type": "string" + } + }, + "type": "object" + }, + "TargetContainerRepository": { + "additionalProperties": false, + "description": "The container repository where the output container image is stored.", + "properties": { + "RepositoryName": { + "description": "The name of the container repository where the output container image is stored. This name is prefixed by the repository location.", + "type": "string" + }, + "Service": { + "description": "Specifies the service in which this image was registered.", + "enum": [ + "ECR" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::ImageBuilder::ContainerRecipe", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "imagebuilder:GetComponent", + "imagebuilder:TagResource", + "imagebuilder:GetContainerRecipe", + "imagebuilder:CreateContainerRecipe", + "imagebuilder:GetImage", + "kms:Encrypt", + "kms:Decrypt", + "kms:ReEncryptFrom", + "kms:ReEncryptTo", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext", + "s3:GetObject", + "s3:ListBucket", + "ecr:DescribeRepositories", + "ec2:DescribeImages" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:UnTagResource", + "imagebuilder:GetContainerRecipe", + "imagebuilder:DeleteContainerRecipe" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListContainerRecipes" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetContainerRecipe" + ] + } + }, + "oneOf": [ + { + "required": [ + "DockerfileTemplateData", + "Name", + "Version", + "Components", + "ParentImage", + "TargetRepository", + "ContainerType" + ] + }, + { + "required": [ + "DockerfileTemplateUri", + "Name", + "Version", + "Components", + "ParentImage", + "TargetRepository", + "ContainerType" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the container recipe.", + "type": "string" + }, + "Components": { + "description": "Components for build and test that are included in the container recipe.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ComponentConfiguration" + }, + "type": "array" + }, + "ContainerType": { + "description": "Specifies the type of container, such as Docker.", + "enum": [ + "DOCKER" + ], + "type": "string" + }, + "Description": { + "description": "The description of the container recipe.", + "type": "string" + }, + "DockerfileTemplateData": { + "description": "Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.", + "type": "string" + }, + "DockerfileTemplateUri": { + "description": "The S3 URI for the Dockerfile that will be used to build your container image.", + "type": "string" + }, + "ImageOsVersionOverride": { + "description": "Specifies the operating system version for the source image.", + "type": "string" + }, + "InstanceConfiguration": { + "$ref": "#/definitions/InstanceConfiguration", + "additionalProperties": false, + "description": "A group of options that can be used to configure an instance for building and testing container images." + }, + "KmsKeyId": { + "description": "Identifies which KMS key is used to encrypt the container image.", + "type": "string" + }, + "Name": { + "description": "The name of the container recipe.", + "type": "string" + }, + "ParentImage": { + "description": "The source image for the container recipe.", + "type": "string" + }, + "PlatformOverride": { + "description": "Specifies the operating system platform when you use a custom source image.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "Tags that are attached to the container recipe.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "TargetRepository": { + "$ref": "#/definitions/TargetContainerRepository", + "description": "The destination repository for the container image." + }, + "Version": { + "description": "The semantic version of the container recipe (..).", + "type": "string" + }, + "WorkingDirectory": { + "description": "The working directory to be used during build and test workflows.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/InstanceConfiguration/BlockDeviceMappings/*/Ebs/VolumeType": "$uppercase(VolumeType)" + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::ContainerRecipe", + "writeOnlyProperties": [ + "/properties/DockerfileTemplateData", + "/properties/DockerfileTemplateUri", + "/properties/ImageOsVersionOverride", + "/properties/PlatformOverride" + ] +} diff --git a/schema/aws-imagebuilder-distributionconfiguration.json b/schema/aws-imagebuilder-distributionconfiguration.json index a0082dd..5ba04d1 100644 --- a/schema/aws-imagebuilder-distributionconfiguration.json +++ b/schema/aws-imagebuilder-distributionconfiguration.json @@ -1,340 +1,340 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AmiDistributionConfiguration": { - "additionalProperties": false, - "description": "The specific AMI settings (for example, launch permissions, AMI tags).", - "properties": { - "AmiTags": { - "additionalProperties": false, - "description": "The tags to apply to AMIs distributed to this Region.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Description": { - "description": "The description of the AMI distribution configuration.", - "type": "string" - }, - "KmsKeyId": { - "description": "The KMS key identifier used to encrypt the distributed image.", - "type": "string" - }, - "LaunchPermissionConfiguration": { - "$ref": "#/definitions/LaunchPermissionConfiguration" - }, - "Name": { - "description": "The name of the AMI distribution configuration.", - "type": "string" - }, - "TargetAccountIds": { - "description": "The ID of accounts to which you want to distribute an image.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ContainerDistributionConfiguration": { - "additionalProperties": false, - "description": "Container distribution settings for encryption, licensing, and sharing in a specific Region.", - "properties": { - "ContainerTags": { - "description": "Tags that are attached to the container distribution configuration.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Description": { - "description": "The description of the container distribution configuration.", - "type": "string" - }, - "TargetRepository": { - "$ref": "#/definitions/TargetContainerRepository", - "description": "The destination repository for the container distribution configuration." - } - }, - "type": "object" - }, - "Distribution": { - "additionalProperties": false, - "description": "The distributions of the distribution configuration.", - "properties": { - "AmiDistributionConfiguration": { - "$ref": "#/definitions/AmiDistributionConfiguration" - }, - "ContainerDistributionConfiguration": { - "$ref": "#/definitions/ContainerDistributionConfiguration" - }, - "FastLaunchConfigurations": { - "description": "The Windows faster-launching configurations to use for AMI distribution.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/FastLaunchConfiguration" - }, - "type": "array" - }, - "LaunchTemplateConfigurations": { - "description": "A group of launchTemplateConfiguration settings that apply to image distribution.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LaunchTemplateConfiguration" - }, - "type": "array" - }, - "LicenseConfigurationArns": { - "description": "The License Manager Configuration to associate with the AMI in the specified Region.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LicenseConfigurationArn" - }, - "type": "array" - }, - "Region": { - "description": "region", - "type": "string" - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "FastLaunchConfiguration": { - "additionalProperties": false, - "description": "The Windows faster-launching configuration to use for AMI distribution.", - "properties": { - "AccountId": { - "description": "The owner account ID for the fast-launch enabled Windows AMI.", - "type": "string" - }, - "Enabled": { - "description": "A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.", - "type": "boolean" - }, - "LaunchTemplate": { - "$ref": "#/definitions/FastLaunchLaunchTemplateSpecification", - "description": "The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots." - }, - "MaxParallelLaunches": { - "description": "The maximum number of parallel instances that are launched for creating resources.", - "type": "integer" - }, - "SnapshotConfiguration": { - "$ref": "#/definitions/FastLaunchSnapshotConfiguration", - "description": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled." - } - }, - "type": "object" - }, - "FastLaunchLaunchTemplateSpecification": { - "additionalProperties": false, - "description": "The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.", - "properties": { - "LaunchTemplateId": { - "description": "The ID of the launch template to use for faster launching for a Windows AMI.", - "type": "string" - }, - "LaunchTemplateName": { - "description": "The name of the launch template to use for faster launching for a Windows AMI.", - "type": "string" - }, - "LaunchTemplateVersion": { - "description": "The version of the launch template to use for faster launching for a Windows AMI.", - "type": "string" - } - }, - "type": "object" - }, - "FastLaunchSnapshotConfiguration": { - "additionalProperties": false, - "description": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.", - "properties": { - "TargetResourceCount": { - "description": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.", - "type": "integer" - } - }, - "type": "object" - }, - "LaunchPermissionConfiguration": { - "additionalProperties": false, - "description": "Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.", - "properties": { - "OrganizationArns": { - "description": "The ARN for an Amazon Web Services Organization that you want to share your AMI with.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "OrganizationalUnitArns": { - "description": "The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "UserGroups": { - "description": "The name of the group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "UserIds": { - "description": "The AWS account ID.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "LaunchTemplateConfiguration": { - "additionalProperties": false, - "description": "launchTemplateConfiguration settings that apply to image distribution.", - "properties": { - "AccountId": { - "description": "The account ID that this configuration applies to.", - "type": "string" - }, - "LaunchTemplateId": { - "description": "Identifies the EC2 launch template to use.", - "type": "string" - }, - "SetDefaultVersion": { - "description": "Set the specified EC2 launch template as the default launch template for the specified account.", - "type": "boolean" - } - }, - "type": "object" - }, - "LicenseConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the License Manager configuration.", - "type": "string" - }, - "TargetContainerRepository": { - "additionalProperties": false, - "description": "The destination repository for the container image.", - "properties": { - "RepositoryName": { - "description": "The repository name of target container repository.", - "type": "string" - }, - "Service": { - "description": "The service of target container repository.", - "enum": [ - "ECR" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::ImageBuilder::DistributionConfiguration", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "ec2:DescribeLaunchTemplates", - "ec2:CreateLaunchTemplateVersion", - "ec2:ModifyLaunchTemplate", - "imagebuilder:TagResource", - "imagebuilder:GetDistributionConfiguration", - "imagebuilder:CreateDistributionConfiguration" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:GetDistributionConfiguration", - "imagebuilder:UnTagResource", - "imagebuilder:DeleteDistributionConfiguration" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListDistributionConfigurations" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetDistributionConfiguration" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeLaunchTemplates", - "ec2:CreateLaunchTemplateVersion", - "ec2:ModifyLaunchTemplate", - "imagebuilder:GetDistributionConfiguration", - "imagebuilder:UpdateDistributionConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the distribution configuration.", - "type": "string" - }, - "Description": { - "description": "The description of the distribution configuration.", - "type": "string" - }, - "Distributions": { - "description": "The distributions of the distribution configuration.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Distribution" - }, - "type": "array" - }, - "Name": { - "description": "The name of the distribution configuration.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the component.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Distributions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::DistributionConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AmiDistributionConfiguration": { + "additionalProperties": false, + "description": "The specific AMI settings (for example, launch permissions, AMI tags).", + "properties": { + "AmiTags": { + "additionalProperties": false, + "description": "The tags to apply to AMIs distributed to this Region.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Description": { + "description": "The description of the AMI distribution configuration.", + "type": "string" + }, + "KmsKeyId": { + "description": "The KMS key identifier used to encrypt the distributed image.", + "type": "string" + }, + "LaunchPermissionConfiguration": { + "$ref": "#/definitions/LaunchPermissionConfiguration" + }, + "Name": { + "description": "The name of the AMI distribution configuration.", + "type": "string" + }, + "TargetAccountIds": { + "description": "The ID of accounts to which you want to distribute an image.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContainerDistributionConfiguration": { + "additionalProperties": false, + "description": "Container distribution settings for encryption, licensing, and sharing in a specific Region.", + "properties": { + "ContainerTags": { + "description": "Tags that are attached to the container distribution configuration.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Description": { + "description": "The description of the container distribution configuration.", + "type": "string" + }, + "TargetRepository": { + "$ref": "#/definitions/TargetContainerRepository", + "description": "The destination repository for the container distribution configuration." + } + }, + "type": "object" + }, + "Distribution": { + "additionalProperties": false, + "description": "The distributions of the distribution configuration.", + "properties": { + "AmiDistributionConfiguration": { + "$ref": "#/definitions/AmiDistributionConfiguration" + }, + "ContainerDistributionConfiguration": { + "$ref": "#/definitions/ContainerDistributionConfiguration" + }, + "FastLaunchConfigurations": { + "description": "The Windows faster-launching configurations to use for AMI distribution.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/FastLaunchConfiguration" + }, + "type": "array" + }, + "LaunchTemplateConfigurations": { + "description": "A group of launchTemplateConfiguration settings that apply to image distribution.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LaunchTemplateConfiguration" + }, + "type": "array" + }, + "LicenseConfigurationArns": { + "description": "The License Manager Configuration to associate with the AMI in the specified Region.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LicenseConfigurationArn" + }, + "type": "array" + }, + "Region": { + "description": "region", + "type": "string" + } + }, + "required": [ + "Region" + ], + "type": "object" + }, + "FastLaunchConfiguration": { + "additionalProperties": false, + "description": "The Windows faster-launching configuration to use for AMI distribution.", + "properties": { + "AccountId": { + "description": "The owner account ID for the fast-launch enabled Windows AMI.", + "type": "string" + }, + "Enabled": { + "description": "A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.", + "type": "boolean" + }, + "LaunchTemplate": { + "$ref": "#/definitions/FastLaunchLaunchTemplateSpecification", + "description": "The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots." + }, + "MaxParallelLaunches": { + "description": "The maximum number of parallel instances that are launched for creating resources.", + "type": "integer" + }, + "SnapshotConfiguration": { + "$ref": "#/definitions/FastLaunchSnapshotConfiguration", + "description": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled." + } + }, + "type": "object" + }, + "FastLaunchLaunchTemplateSpecification": { + "additionalProperties": false, + "description": "The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.", + "properties": { + "LaunchTemplateId": { + "description": "The ID of the launch template to use for faster launching for a Windows AMI.", + "type": "string" + }, + "LaunchTemplateName": { + "description": "The name of the launch template to use for faster launching for a Windows AMI.", + "type": "string" + }, + "LaunchTemplateVersion": { + "description": "The version of the launch template to use for faster launching for a Windows AMI.", + "type": "string" + } + }, + "type": "object" + }, + "FastLaunchSnapshotConfiguration": { + "additionalProperties": false, + "description": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.", + "properties": { + "TargetResourceCount": { + "description": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.", + "type": "integer" + } + }, + "type": "object" + }, + "LaunchPermissionConfiguration": { + "additionalProperties": false, + "description": "Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.", + "properties": { + "OrganizationArns": { + "description": "The ARN for an Amazon Web Services Organization that you want to share your AMI with.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "OrganizationalUnitArns": { + "description": "The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "UserGroups": { + "description": "The name of the group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "UserIds": { + "description": "The AWS account ID.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LaunchTemplateConfiguration": { + "additionalProperties": false, + "description": "launchTemplateConfiguration settings that apply to image distribution.", + "properties": { + "AccountId": { + "description": "The account ID that this configuration applies to.", + "type": "string" + }, + "LaunchTemplateId": { + "description": "Identifies the EC2 launch template to use.", + "type": "string" + }, + "SetDefaultVersion": { + "description": "Set the specified EC2 launch template as the default launch template for the specified account.", + "type": "boolean" + } + }, + "type": "object" + }, + "LicenseConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the License Manager configuration.", + "type": "string" + }, + "TargetContainerRepository": { + "additionalProperties": false, + "description": "The destination repository for the container image.", + "properties": { + "RepositoryName": { + "description": "The repository name of target container repository.", + "type": "string" + }, + "Service": { + "description": "The service of target container repository.", + "enum": [ + "ECR" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::ImageBuilder::DistributionConfiguration", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "ec2:DescribeLaunchTemplates", + "ec2:CreateLaunchTemplateVersion", + "ec2:ModifyLaunchTemplate", + "imagebuilder:TagResource", + "imagebuilder:GetDistributionConfiguration", + "imagebuilder:CreateDistributionConfiguration" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:GetDistributionConfiguration", + "imagebuilder:UnTagResource", + "imagebuilder:DeleteDistributionConfiguration" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListDistributionConfigurations" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetDistributionConfiguration" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeLaunchTemplates", + "ec2:CreateLaunchTemplateVersion", + "ec2:ModifyLaunchTemplate", + "imagebuilder:GetDistributionConfiguration", + "imagebuilder:UpdateDistributionConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the distribution configuration.", + "type": "string" + }, + "Description": { + "description": "The description of the distribution configuration.", + "type": "string" + }, + "Distributions": { + "description": "The distributions of the distribution configuration.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Distribution" + }, + "type": "array" + }, + "Name": { + "description": "The name of the distribution configuration.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the component.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Distributions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::DistributionConfiguration" +} diff --git a/schema/aws-imagebuilder-image.json b/schema/aws-imagebuilder-image.json index ceaf7e9..fbb958c 100644 --- a/schema/aws-imagebuilder-image.json +++ b/schema/aws-imagebuilder-image.json @@ -1,263 +1,263 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ImageRecipeArn", - "/properties/ContainerRecipeArn", - "/properties/InfrastructureConfigurationArn", - "/properties/Workflows", - "/properties/DistributionConfigurationArn", - "/properties/ImageTestsConfiguration", - "/properties/ImageScanningConfiguration", - "/properties/EnhancedImageMetadataEnabled", - "/properties/Tags" - ], - "definitions": { - "EcrConfiguration": { - "additionalProperties": false, - "description": "Settings for Image Builder to configure the ECR repository and output container images that are scanned.", - "properties": { - "ContainerTags": { - "description": "Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "RepositoryName": { - "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don\u2019t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.", - "type": "string" - } - }, - "type": "object" - }, - "ImageScanningConfiguration": { - "additionalProperties": false, - "description": "Contains settings for Image Builder image resource and container image scans.", - "properties": { - "EcrConfiguration": { - "$ref": "#/definitions/EcrConfiguration", - "description": "Contains ECR settings for vulnerability scans." - }, - "ImageScanningEnabled": { - "description": "This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.", - "type": "boolean" - } - }, - "type": "object" - }, - "ImageTestsConfiguration": { - "additionalProperties": false, - "description": "The image tests configuration used when creating this image.", - "properties": { - "ImageTestsEnabled": { - "description": "ImageTestsEnabled", - "type": "boolean" - }, - "TimeoutMinutes": { - "description": "TimeoutMinutes", - "maximum": 1440, - "minimum": 60, - "type": "integer" - } - }, - "type": "object" - }, - "WorkflowConfiguration": { - "additionalProperties": false, - "description": "The workflow configuration of the image", - "properties": { - "OnFailure": { - "description": "Define execution decision in case of workflow failure", - "enum": [ - "CONTINUE", - "ABORT" - ], - "type": "string" - }, - "ParallelGroup": { - "description": "The parallel group name", - "type": "string" - }, - "Parameters": { - "description": "The parameters associated with the workflow", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WorkflowParameter" - }, - "type": "array" - }, - "WorkflowArn": { - "description": "The Amazon Resource Name (ARN) of the workflow", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowParameter": { - "additionalProperties": false, - "description": "A parameter associated with the workflow", - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowParameterValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "WorkflowParameterValue": { - "description": "The value associated with the workflow parameter", - "type": "string" - } - }, - "description": "Resource schema for AWS::ImageBuilder::Image", - "handlers": { - "create": { - "permissions": [ - "ecr:BatchGetRepositoryScanningConfiguration", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "imagebuilder:GetImageRecipe", - "imagebuilder:GetInfrastructureConfiguration", - "imagebuilder:GetDistributionConfiguration", - "imagebuilder:GetWorkflow", - "imagebuilder:GetImage", - "imagebuilder:CreateImage", - "imagebuilder:TagResource", - "inspector2:BatchGetAccountStatus" - ], - "timeoutInMinutes": 720 - }, - "delete": { - "permissions": [ - "imagebuilder:GetImage", - "imagebuilder:DeleteImage", - "imagebuilder:UnTagResource", - "imagebuilder:CancelImageCreation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/Arn" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "imagebuilder:ListImages" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetImage" - ] - } - }, - "oneOf": [ - { - "required": [ - "ContainerRecipeArn", - "InfrastructureConfigurationArn" - ] - }, - { - "required": [ - "ImageRecipeArn", - "InfrastructureConfigurationArn" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the image.", - "type": "string" - }, - "ContainerRecipeArn": { - "description": "The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.", - "type": "string" - }, - "DistributionConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the distribution configuration.", - "type": "string" - }, - "EnhancedImageMetadataEnabled": { - "description": "Collects additional information about the image being created, including the operating system (OS) version and package list.", - "type": "boolean" - }, - "ExecutionRole": { - "description": "The execution role name/ARN for the image build, if provided", - "type": "string" - }, - "ImageId": { - "description": "The AMI ID of the EC2 AMI in current region.", - "type": "string" - }, - "ImageRecipeArn": { - "description": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.", - "type": "string" - }, - "ImageScanningConfiguration": { - "$ref": "#/definitions/ImageScanningConfiguration", - "description": "Contains settings for vulnerability scans." - }, - "ImageTestsConfiguration": { - "$ref": "#/definitions/ImageTestsConfiguration", - "description": "The image tests configuration used when creating this image." - }, - "ImageUri": { - "description": "URI for containers created in current Region with default ECR image tag", - "type": "string" - }, - "InfrastructureConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the infrastructure configuration.", - "type": "string" - }, - "Name": { - "description": "The name of the image.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the image.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Workflows": { - "description": "Workflows to define the image build process", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowConfiguration" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Name", - "/properties/ImageId", - "/properties/ImageUri" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::Image" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ImageRecipeArn", + "/properties/ContainerRecipeArn", + "/properties/InfrastructureConfigurationArn", + "/properties/Workflows", + "/properties/DistributionConfigurationArn", + "/properties/ImageTestsConfiguration", + "/properties/ImageScanningConfiguration", + "/properties/EnhancedImageMetadataEnabled", + "/properties/Tags" + ], + "definitions": { + "EcrConfiguration": { + "additionalProperties": false, + "description": "Settings for Image Builder to configure the ECR repository and output container images that are scanned.", + "properties": { + "ContainerTags": { + "description": "Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "RepositoryName": { + "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don\u2019t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.", + "type": "string" + } + }, + "type": "object" + }, + "ImageScanningConfiguration": { + "additionalProperties": false, + "description": "Contains settings for Image Builder image resource and container image scans.", + "properties": { + "EcrConfiguration": { + "$ref": "#/definitions/EcrConfiguration", + "description": "Contains ECR settings for vulnerability scans." + }, + "ImageScanningEnabled": { + "description": "This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.", + "type": "boolean" + } + }, + "type": "object" + }, + "ImageTestsConfiguration": { + "additionalProperties": false, + "description": "The image tests configuration used when creating this image.", + "properties": { + "ImageTestsEnabled": { + "description": "ImageTestsEnabled", + "type": "boolean" + }, + "TimeoutMinutes": { + "description": "TimeoutMinutes", + "maximum": 1440, + "minimum": 60, + "type": "integer" + } + }, + "type": "object" + }, + "WorkflowConfiguration": { + "additionalProperties": false, + "description": "The workflow configuration of the image", + "properties": { + "OnFailure": { + "description": "Define execution decision in case of workflow failure", + "enum": [ + "CONTINUE", + "ABORT" + ], + "type": "string" + }, + "ParallelGroup": { + "description": "The parallel group name", + "type": "string" + }, + "Parameters": { + "description": "The parameters associated with the workflow", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WorkflowParameter" + }, + "type": "array" + }, + "WorkflowArn": { + "description": "The Amazon Resource Name (ARN) of the workflow", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowParameter": { + "additionalProperties": false, + "description": "A parameter associated with the workflow", + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowParameterValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "WorkflowParameterValue": { + "description": "The value associated with the workflow parameter", + "type": "string" + } + }, + "description": "Resource schema for AWS::ImageBuilder::Image", + "handlers": { + "create": { + "permissions": [ + "ecr:BatchGetRepositoryScanningConfiguration", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "imagebuilder:GetImageRecipe", + "imagebuilder:GetInfrastructureConfiguration", + "imagebuilder:GetDistributionConfiguration", + "imagebuilder:GetWorkflow", + "imagebuilder:GetImage", + "imagebuilder:CreateImage", + "imagebuilder:TagResource", + "inspector2:BatchGetAccountStatus" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "imagebuilder:GetImage", + "imagebuilder:DeleteImage", + "imagebuilder:UnTagResource", + "imagebuilder:CancelImageCreation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Arn" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "imagebuilder:ListImages" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetImage" + ] + } + }, + "oneOf": [ + { + "required": [ + "ContainerRecipeArn", + "InfrastructureConfigurationArn" + ] + }, + { + "required": [ + "ImageRecipeArn", + "InfrastructureConfigurationArn" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the image.", + "type": "string" + }, + "ContainerRecipeArn": { + "description": "The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.", + "type": "string" + }, + "DistributionConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the distribution configuration.", + "type": "string" + }, + "EnhancedImageMetadataEnabled": { + "description": "Collects additional information about the image being created, including the operating system (OS) version and package list.", + "type": "boolean" + }, + "ExecutionRole": { + "description": "The execution role name/ARN for the image build, if provided", + "type": "string" + }, + "ImageId": { + "description": "The AMI ID of the EC2 AMI in current region.", + "type": "string" + }, + "ImageRecipeArn": { + "description": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.", + "type": "string" + }, + "ImageScanningConfiguration": { + "$ref": "#/definitions/ImageScanningConfiguration", + "description": "Contains settings for vulnerability scans." + }, + "ImageTestsConfiguration": { + "$ref": "#/definitions/ImageTestsConfiguration", + "description": "The image tests configuration used when creating this image." + }, + "ImageUri": { + "description": "URI for containers created in current Region with default ECR image tag", + "type": "string" + }, + "InfrastructureConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the infrastructure configuration.", + "type": "string" + }, + "Name": { + "description": "The name of the image.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the image.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Workflows": { + "description": "Workflows to define the image build process", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowConfiguration" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Name", + "/properties/ImageId", + "/properties/ImageUri" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::Image" +} diff --git a/schema/aws-imagebuilder-imagepipeline.json b/schema/aws-imagebuilder-imagepipeline.json index 22df985..679d890 100644 --- a/schema/aws-imagebuilder-imagepipeline.json +++ b/schema/aws-imagebuilder-imagepipeline.json @@ -1,277 +1,277 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "EcrConfiguration": { - "additionalProperties": false, - "description": "Settings for Image Builder to configure the ECR repository and output container images that are scanned.", - "properties": { - "ContainerTags": { - "description": "Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "RepositoryName": { - "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.", - "type": "string" - } - }, - "type": "object" - }, - "ImageScanningConfiguration": { - "additionalProperties": false, - "description": "Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.", - "properties": { - "EcrConfiguration": { - "$ref": "#/definitions/EcrConfiguration", - "description": "Contains ECR settings for vulnerability scans." - }, - "ImageScanningEnabled": { - "description": "This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.", - "type": "boolean" - } - }, - "type": "object" - }, - "ImageTestsConfiguration": { - "additionalProperties": false, - "description": "Image tests configuration.", - "properties": { - "ImageTestsEnabled": { - "description": "Defines if tests should be executed when building this image.", - "type": "boolean" - }, - "TimeoutMinutes": { - "description": "The maximum time in minutes that tests are permitted to run.", - "maximum": 1440, - "minimum": 60, - "type": "integer" - } - }, - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "description": "The schedule of the image pipeline.", - "properties": { - "PipelineExecutionStartCondition": { - "description": "The condition configures when the pipeline should trigger a new image build.", - "enum": [ - "EXPRESSION_MATCH_ONLY", - "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" - ], - "type": "string" - }, - "ScheduleExpression": { - "description": "The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowConfiguration": { - "additionalProperties": false, - "description": "The workflow configuration of the image", - "properties": { - "OnFailure": { - "description": "Define execution decision in case of workflow failure", - "enum": [ - "CONTINUE", - "ABORT" - ], - "type": "string" - }, - "ParallelGroup": { - "description": "The parallel group name", - "type": "string" - }, - "Parameters": { - "description": "The parameters associated with the workflow", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WorkflowParameter" - }, - "type": "array" - }, - "WorkflowArn": { - "description": "The Amazon Resource Name (ARN) of the workflow", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowParameter": { - "additionalProperties": false, - "description": "A parameter associated with the workflow", - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowParameterValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "WorkflowParameterValue": { - "description": "The value associated with the workflow parameter", - "type": "string" - } - }, - "description": "Resource schema for AWS::ImageBuilder::ImagePipeline", - "handlers": { - "create": { - "permissions": [ - "ecr:BatchGetRepositoryScanningConfiguration", - "iam:GetRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "imagebuilder:TagResource", - "imagebuilder:GetImagePipeline", - "imagebuilder:GetImageRecipe", - "imagebuilder:GetInfrastructureConfiguration", - "imagebuilder:GetDistributionConfiguration", - "imagebuilder:CreateImagePipeline", - "imagebuilder:GetWorkflow", - "inspector2:BatchGetAccountStatus" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:UnTagResource", - "imagebuilder:GetImagePipeline", - "imagebuilder:DeleteImagePipeline" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListImagePipelines" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetImagePipeline" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "imagebuilder:GetImagePipeline", - "imagebuilder:UpdateImagePipeline", - "imagebuilder:GetWorkflow" - ] - } - }, - "oneOf": [ - { - "required": [ - "Name", - "ContainerRecipeArn", - "InfrastructureConfigurationArn" - ] - }, - { - "required": [ - "Name", - "ImageRecipeArn", - "InfrastructureConfigurationArn" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the image pipeline.", - "type": "string" - }, - "ContainerRecipeArn": { - "description": "The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.", - "type": "string" - }, - "Description": { - "description": "The description of the image pipeline.", - "type": "string" - }, - "DistributionConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.", - "type": "string" - }, - "EnhancedImageMetadataEnabled": { - "description": "Collects additional information about the image being created, including the operating system (OS) version and package list.", - "type": "boolean" - }, - "ExecutionRole": { - "description": "The execution role name/ARN for the image build, if provided", - "type": "string" - }, - "ImageRecipeArn": { - "description": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.", - "type": "string" - }, - "ImageScanningConfiguration": { - "$ref": "#/definitions/ImageScanningConfiguration", - "description": "Contains settings for vulnerability scans." - }, - "ImageTestsConfiguration": { - "$ref": "#/definitions/ImageTestsConfiguration", - "description": "The image tests configuration of the image pipeline." - }, - "InfrastructureConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.", - "type": "string" - }, - "Name": { - "description": "The name of the image pipeline.", - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/Schedule", - "description": "The schedule of the image pipeline." - }, - "Status": { - "description": "The status of the image pipeline.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags of this image pipeline.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Workflows": { - "description": "Workflows to define the image build process", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowConfiguration" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::ImagePipeline" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "EcrConfiguration": { + "additionalProperties": false, + "description": "Settings for Image Builder to configure the ECR repository and output container images that are scanned.", + "properties": { + "ContainerTags": { + "description": "Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "RepositoryName": { + "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.", + "type": "string" + } + }, + "type": "object" + }, + "ImageScanningConfiguration": { + "additionalProperties": false, + "description": "Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.", + "properties": { + "EcrConfiguration": { + "$ref": "#/definitions/EcrConfiguration", + "description": "Contains ECR settings for vulnerability scans." + }, + "ImageScanningEnabled": { + "description": "This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.", + "type": "boolean" + } + }, + "type": "object" + }, + "ImageTestsConfiguration": { + "additionalProperties": false, + "description": "Image tests configuration.", + "properties": { + "ImageTestsEnabled": { + "description": "Defines if tests should be executed when building this image.", + "type": "boolean" + }, + "TimeoutMinutes": { + "description": "The maximum time in minutes that tests are permitted to run.", + "maximum": 1440, + "minimum": 60, + "type": "integer" + } + }, + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "description": "The schedule of the image pipeline.", + "properties": { + "PipelineExecutionStartCondition": { + "description": "The condition configures when the pipeline should trigger a new image build.", + "enum": [ + "EXPRESSION_MATCH_ONLY", + "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + ], + "type": "string" + }, + "ScheduleExpression": { + "description": "The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowConfiguration": { + "additionalProperties": false, + "description": "The workflow configuration of the image", + "properties": { + "OnFailure": { + "description": "Define execution decision in case of workflow failure", + "enum": [ + "CONTINUE", + "ABORT" + ], + "type": "string" + }, + "ParallelGroup": { + "description": "The parallel group name", + "type": "string" + }, + "Parameters": { + "description": "The parameters associated with the workflow", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WorkflowParameter" + }, + "type": "array" + }, + "WorkflowArn": { + "description": "The Amazon Resource Name (ARN) of the workflow", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowParameter": { + "additionalProperties": false, + "description": "A parameter associated with the workflow", + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowParameterValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "WorkflowParameterValue": { + "description": "The value associated with the workflow parameter", + "type": "string" + } + }, + "description": "Resource schema for AWS::ImageBuilder::ImagePipeline", + "handlers": { + "create": { + "permissions": [ + "ecr:BatchGetRepositoryScanningConfiguration", + "iam:GetRole", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "imagebuilder:TagResource", + "imagebuilder:GetImagePipeline", + "imagebuilder:GetImageRecipe", + "imagebuilder:GetInfrastructureConfiguration", + "imagebuilder:GetDistributionConfiguration", + "imagebuilder:CreateImagePipeline", + "imagebuilder:GetWorkflow", + "inspector2:BatchGetAccountStatus" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:UnTagResource", + "imagebuilder:GetImagePipeline", + "imagebuilder:DeleteImagePipeline" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListImagePipelines" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetImagePipeline" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "imagebuilder:GetImagePipeline", + "imagebuilder:UpdateImagePipeline", + "imagebuilder:GetWorkflow" + ] + } + }, + "oneOf": [ + { + "required": [ + "Name", + "ContainerRecipeArn", + "InfrastructureConfigurationArn" + ] + }, + { + "required": [ + "Name", + "ImageRecipeArn", + "InfrastructureConfigurationArn" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the image pipeline.", + "type": "string" + }, + "ContainerRecipeArn": { + "description": "The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.", + "type": "string" + }, + "Description": { + "description": "The description of the image pipeline.", + "type": "string" + }, + "DistributionConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.", + "type": "string" + }, + "EnhancedImageMetadataEnabled": { + "description": "Collects additional information about the image being created, including the operating system (OS) version and package list.", + "type": "boolean" + }, + "ExecutionRole": { + "description": "The execution role name/ARN for the image build, if provided", + "type": "string" + }, + "ImageRecipeArn": { + "description": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.", + "type": "string" + }, + "ImageScanningConfiguration": { + "$ref": "#/definitions/ImageScanningConfiguration", + "description": "Contains settings for vulnerability scans." + }, + "ImageTestsConfiguration": { + "$ref": "#/definitions/ImageTestsConfiguration", + "description": "The image tests configuration of the image pipeline." + }, + "InfrastructureConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.", + "type": "string" + }, + "Name": { + "description": "The name of the image pipeline.", + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/Schedule", + "description": "The schedule of the image pipeline." + }, + "Status": { + "description": "The status of the image pipeline.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags of this image pipeline.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Workflows": { + "description": "Workflows to define the image build process", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowConfiguration" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::ImagePipeline" +} diff --git a/schema/aws-imagebuilder-imagerecipe.json b/schema/aws-imagebuilder-imagerecipe.json index 78f995c..0f74126 100644 --- a/schema/aws-imagebuilder-imagerecipe.json +++ b/schema/aws-imagebuilder-imagerecipe.json @@ -1,262 +1,262 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Version", - "/properties/Components", - "/properties/ParentImage", - "/properties/Description", - "/properties/BlockDeviceMappings", - "/properties/WorkingDirectory", - "/properties/Tags" - ], - "definitions": { - "AdditionalInstanceConfiguration": { - "additionalProperties": false, - "description": "Specify additional settings and launch scripts for your build instances.", - "properties": { - "SystemsManagerAgent": { - "$ref": "#/definitions/SystemsManagerAgent", - "description": "Contains settings for the SSM agent on your build instance." - }, - "UserDataOverride": { - "description": "Use this property to provide commands or a command script to run when you launch your build instance.", - "type": "string" - } - }, - "type": "object" - }, - "ComponentConfiguration": { - "additionalProperties": false, - "description": "Configuration details of the component.", - "properties": { - "ComponentArn": { - "description": "The Amazon Resource Name (ARN) of the component.", - "type": "string" - }, - "Parameters": { - "description": "A group of parameter settings that are used to configure the component for a specific recipe.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ComponentParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "ComponentParameter": { - "additionalProperties": false, - "description": "Contains a key/value pair that sets the named component parameter.", - "properties": { - "Name": { - "description": "The name of the component parameter to set.", - "type": "string" - }, - "Value": { - "description": "Sets the value for the named component parameter.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "EbsInstanceBlockDeviceSpecification": { - "additionalProperties": false, - "description": "Amazon EBS-specific block device mapping specifications. ", - "properties": { - "DeleteOnTermination": { - "description": "Use to configure delete on termination of the associated device.", - "type": "boolean" - }, - "Encrypted": { - "description": "Use to configure device encryption.", - "type": "boolean" - }, - "Iops": { - "description": "Use to configure device IOPS.", - "type": "integer" - }, - "KmsKeyId": { - "description": "Use to configure the KMS key to use when encrypting the device.", - "type": "string" - }, - "SnapshotId": { - "description": "The snapshot that defines the device contents.", - "type": "string" - }, - "Throughput": { - "description": "For GP3 volumes only - The throughput in MiB/s that the volume supports.", - "type": "integer" - }, - "VolumeSize": { - "description": "Use to override the device's volume size.", - "type": "integer" - }, - "VolumeType": { - "description": "Use to override the device's volume type.", - "enum": [ - "standard", - "io1", - "io2", - "gp2", - "gp3", - "sc1", - "st1" - ], - "type": "string" - } - }, - "type": "object" - }, - "InstanceBlockDeviceMapping": { - "additionalProperties": false, - "description": "Defines block device mappings for the instance used to configure your image. ", - "properties": { - "DeviceName": { - "description": "The device to which these mappings apply.", - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/EbsInstanceBlockDeviceSpecification", - "description": "Use to manage Amazon EBS-specific configuration for this mapping." - }, - "NoDevice": { - "description": "Use to remove a mapping from the parent image.", - "type": "string" - }, - "VirtualName": { - "description": "Use to manage instance ephemeral devices.", - "type": "string" - } - }, - "type": "object" - }, - "SystemsManagerAgent": { - "additionalProperties": false, - "description": "Contains settings for the SSM agent on your build instance.", - "properties": { - "UninstallAfterBuild": { - "description": "Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.", - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::ImageBuilder::ImageRecipe", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "imagebuilder:GetComponent", - "imagebuilder:GetImage", - "imagebuilder:TagResource", - "imagebuilder:GetImageRecipe", - "imagebuilder:CreateImageRecipe", - "ec2:DescribeImages" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:UnTagResource", - "imagebuilder:GetImageRecipe", - "imagebuilder:DeleteImageRecipe" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListImageRecipes" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetImageRecipe" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AdditionalInstanceConfiguration": { - "$ref": "#/definitions/AdditionalInstanceConfiguration", - "description": "Specify additional settings and launch scripts for your build instances." - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the image recipe.", - "type": "string" - }, - "BlockDeviceMappings": { - "description": "The block device mappings to apply when creating images from this recipe.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InstanceBlockDeviceMapping" - }, - "type": "array" - }, - "Components": { - "description": "The components of the image recipe.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ComponentConfiguration" - }, - "type": "array" - }, - "Description": { - "description": "The description of the image recipe.", - "type": "string" - }, - "Name": { - "description": "The name of the image recipe.", - "type": "string" - }, - "ParentImage": { - "description": "The parent image of the image recipe.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags of the image recipe.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Version": { - "description": "The version of the image recipe.", - "type": "string" - }, - "WorkingDirectory": { - "description": "The working directory to be used during build and test workflows.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/BlockDeviceMappings/*/Ebs/VolumeType": "$uppercase(VolumeType)" - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Version", - "Components", - "ParentImage" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::ImageRecipe" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Version", + "/properties/Components", + "/properties/ParentImage", + "/properties/Description", + "/properties/BlockDeviceMappings", + "/properties/WorkingDirectory", + "/properties/Tags" + ], + "definitions": { + "AdditionalInstanceConfiguration": { + "additionalProperties": false, + "description": "Specify additional settings and launch scripts for your build instances.", + "properties": { + "SystemsManagerAgent": { + "$ref": "#/definitions/SystemsManagerAgent", + "description": "Contains settings for the SSM agent on your build instance." + }, + "UserDataOverride": { + "description": "Use this property to provide commands or a command script to run when you launch your build instance.", + "type": "string" + } + }, + "type": "object" + }, + "ComponentConfiguration": { + "additionalProperties": false, + "description": "Configuration details of the component.", + "properties": { + "ComponentArn": { + "description": "The Amazon Resource Name (ARN) of the component.", + "type": "string" + }, + "Parameters": { + "description": "A group of parameter settings that are used to configure the component for a specific recipe.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ComponentParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComponentParameter": { + "additionalProperties": false, + "description": "Contains a key/value pair that sets the named component parameter.", + "properties": { + "Name": { + "description": "The name of the component parameter to set.", + "type": "string" + }, + "Value": { + "description": "Sets the value for the named component parameter.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "EbsInstanceBlockDeviceSpecification": { + "additionalProperties": false, + "description": "Amazon EBS-specific block device mapping specifications. ", + "properties": { + "DeleteOnTermination": { + "description": "Use to configure delete on termination of the associated device.", + "type": "boolean" + }, + "Encrypted": { + "description": "Use to configure device encryption.", + "type": "boolean" + }, + "Iops": { + "description": "Use to configure device IOPS.", + "type": "integer" + }, + "KmsKeyId": { + "description": "Use to configure the KMS key to use when encrypting the device.", + "type": "string" + }, + "SnapshotId": { + "description": "The snapshot that defines the device contents.", + "type": "string" + }, + "Throughput": { + "description": "For GP3 volumes only - The throughput in MiB/s that the volume supports.", + "type": "integer" + }, + "VolumeSize": { + "description": "Use to override the device's volume size.", + "type": "integer" + }, + "VolumeType": { + "description": "Use to override the device's volume type.", + "enum": [ + "standard", + "io1", + "io2", + "gp2", + "gp3", + "sc1", + "st1" + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceBlockDeviceMapping": { + "additionalProperties": false, + "description": "Defines block device mappings for the instance used to configure your image. ", + "properties": { + "DeviceName": { + "description": "The device to which these mappings apply.", + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/EbsInstanceBlockDeviceSpecification", + "description": "Use to manage Amazon EBS-specific configuration for this mapping." + }, + "NoDevice": { + "description": "Use to remove a mapping from the parent image.", + "type": "string" + }, + "VirtualName": { + "description": "Use to manage instance ephemeral devices.", + "type": "string" + } + }, + "type": "object" + }, + "SystemsManagerAgent": { + "additionalProperties": false, + "description": "Contains settings for the SSM agent on your build instance.", + "properties": { + "UninstallAfterBuild": { + "description": "Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::ImageBuilder::ImageRecipe", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "imagebuilder:GetComponent", + "imagebuilder:GetImage", + "imagebuilder:TagResource", + "imagebuilder:GetImageRecipe", + "imagebuilder:CreateImageRecipe", + "ec2:DescribeImages" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:UnTagResource", + "imagebuilder:GetImageRecipe", + "imagebuilder:DeleteImageRecipe" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListImageRecipes" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetImageRecipe" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AdditionalInstanceConfiguration": { + "$ref": "#/definitions/AdditionalInstanceConfiguration", + "description": "Specify additional settings and launch scripts for your build instances." + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the image recipe.", + "type": "string" + }, + "BlockDeviceMappings": { + "description": "The block device mappings to apply when creating images from this recipe.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InstanceBlockDeviceMapping" + }, + "type": "array" + }, + "Components": { + "description": "The components of the image recipe.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ComponentConfiguration" + }, + "type": "array" + }, + "Description": { + "description": "The description of the image recipe.", + "type": "string" + }, + "Name": { + "description": "The name of the image recipe.", + "type": "string" + }, + "ParentImage": { + "description": "The parent image of the image recipe.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags of the image recipe.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Version": { + "description": "The version of the image recipe.", + "type": "string" + }, + "WorkingDirectory": { + "description": "The working directory to be used during build and test workflows.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/BlockDeviceMappings/*/Ebs/VolumeType": "$uppercase(VolumeType)" + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Version", + "Components", + "ParentImage" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::ImageRecipe" +} diff --git a/schema/aws-imagebuilder-infrastructureconfiguration.json b/schema/aws-imagebuilder-infrastructureconfiguration.json index fb8de31..3ed0f5b 100644 --- a/schema/aws-imagebuilder-infrastructureconfiguration.json +++ b/schema/aws-imagebuilder-infrastructureconfiguration.json @@ -1,204 +1,204 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "InstanceMetadataOptions": { - "additionalProperties": false, - "description": "The instance metadata option settings for the infrastructure configuration.", - "properties": { - "HttpPutResponseHopLimit": { - "description": "Limit the number of hops that an instance metadata request can traverse to reach its destination.", - "type": "integer" - }, - "HttpTokens": { - "description": "Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: ", - "enum": [ - "required", - "optional" - ], - "type": "string" - } - }, - "type": "object" - }, - "Logging": { - "additionalProperties": false, - "description": "The logging configuration of the infrastructure configuration.", - "properties": { - "S3Logs": { - "$ref": "#/definitions/S3Logs" - } - }, - "type": "object" - }, - "S3Logs": { - "additionalProperties": false, - "description": "The S3 path in which to store the logs.", - "properties": { - "S3BucketName": { - "description": "S3BucketName", - "type": "string" - }, - "S3KeyPrefix": { - "description": "S3KeyPrefix", - "type": "string" - } - }, - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "description": "TagMap", - "properties": { - "TagKey": { - "description": "TagKey", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "TagValue": { - "description": "TagValue", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::ImageBuilder::InfrastructureConfiguration", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iam:GetRole", - "iam:GetInstanceProfile", - "iam:CreateServiceLinkedRole", - "sns:Publish", - "imagebuilder:TagResource", - "imagebuilder:GetInfrastructureConfiguration", - "imagebuilder:CreateInfrastructureConfiguration" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:UnTagResource", - "imagebuilder:GetInfrastructureConfiguration", - "imagebuilder:DeleteInfrastructureConfiguration" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListInfrastructureConfigurations" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetInfrastructureConfiguration" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "sns:Publish", - "imagebuilder:GetInfrastructureConfiguration", - "imagebuilder:UpdateInfrastructureConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the infrastructure configuration.", - "type": "string" - }, - "Description": { - "description": "The description of the infrastructure configuration.", - "type": "string" - }, - "InstanceMetadataOptions": { - "$ref": "#/definitions/InstanceMetadataOptions", - "description": "The instance metadata option settings for the infrastructure configuration." - }, - "InstanceProfileName": { - "description": "The instance profile of the infrastructure configuration.", - "type": "string" - }, - "InstanceTypes": { - "description": "The instance types of the infrastructure configuration.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "KeyPair": { - "description": "The EC2 key pair of the infrastructure configuration..", - "type": "string" - }, - "Logging": { - "$ref": "#/definitions/Logging", - "description": "The logging configuration of the infrastructure configuration." - }, - "Name": { - "description": "The name of the infrastructure configuration.", - "type": "string" - }, - "ResourceTags": { - "additionalProperties": false, - "description": "The tags attached to the resource created by Image Builder.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "SecurityGroupIds": { - "description": "The security group IDs of the infrastructure configuration.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "SnsTopicArn": { - "description": "The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.", - "type": "string" - }, - "SubnetId": { - "description": "The subnet ID of the infrastructure configuration.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the component.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "TerminateInstanceOnFailure": { - "description": "The terminate instance on failure configuration of the infrastructure configuration.", - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "InstanceProfileName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::InfrastructureConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "InstanceMetadataOptions": { + "additionalProperties": false, + "description": "The instance metadata option settings for the infrastructure configuration.", + "properties": { + "HttpPutResponseHopLimit": { + "description": "Limit the number of hops that an instance metadata request can traverse to reach its destination.", + "type": "integer" + }, + "HttpTokens": { + "description": "Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: ", + "enum": [ + "required", + "optional" + ], + "type": "string" + } + }, + "type": "object" + }, + "Logging": { + "additionalProperties": false, + "description": "The logging configuration of the infrastructure configuration.", + "properties": { + "S3Logs": { + "$ref": "#/definitions/S3Logs" + } + }, + "type": "object" + }, + "S3Logs": { + "additionalProperties": false, + "description": "The S3 path in which to store the logs.", + "properties": { + "S3BucketName": { + "description": "S3BucketName", + "type": "string" + }, + "S3KeyPrefix": { + "description": "S3KeyPrefix", + "type": "string" + } + }, + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "description": "TagMap", + "properties": { + "TagKey": { + "description": "TagKey", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "TagValue": { + "description": "TagValue", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::ImageBuilder::InfrastructureConfiguration", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iam:GetRole", + "iam:GetInstanceProfile", + "iam:CreateServiceLinkedRole", + "sns:Publish", + "imagebuilder:TagResource", + "imagebuilder:GetInfrastructureConfiguration", + "imagebuilder:CreateInfrastructureConfiguration" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:UnTagResource", + "imagebuilder:GetInfrastructureConfiguration", + "imagebuilder:DeleteInfrastructureConfiguration" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListInfrastructureConfigurations" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetInfrastructureConfiguration" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "sns:Publish", + "imagebuilder:GetInfrastructureConfiguration", + "imagebuilder:UpdateInfrastructureConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the infrastructure configuration.", + "type": "string" + }, + "Description": { + "description": "The description of the infrastructure configuration.", + "type": "string" + }, + "InstanceMetadataOptions": { + "$ref": "#/definitions/InstanceMetadataOptions", + "description": "The instance metadata option settings for the infrastructure configuration." + }, + "InstanceProfileName": { + "description": "The instance profile of the infrastructure configuration.", + "type": "string" + }, + "InstanceTypes": { + "description": "The instance types of the infrastructure configuration.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "KeyPair": { + "description": "The EC2 key pair of the infrastructure configuration..", + "type": "string" + }, + "Logging": { + "$ref": "#/definitions/Logging", + "description": "The logging configuration of the infrastructure configuration." + }, + "Name": { + "description": "The name of the infrastructure configuration.", + "type": "string" + }, + "ResourceTags": { + "additionalProperties": false, + "description": "The tags attached to the resource created by Image Builder.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "SecurityGroupIds": { + "description": "The security group IDs of the infrastructure configuration.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "SnsTopicArn": { + "description": "The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.", + "type": "string" + }, + "SubnetId": { + "description": "The subnet ID of the infrastructure configuration.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the component.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "TerminateInstanceOnFailure": { + "description": "The terminate instance on failure configuration of the infrastructure configuration.", + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "InstanceProfileName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::InfrastructureConfiguration" +} diff --git a/schema/aws-imagebuilder-lifecyclepolicy.json b/schema/aws-imagebuilder-lifecyclepolicy.json index c98431e..c339c6f 100644 --- a/schema/aws-imagebuilder-lifecyclepolicy.json +++ b/schema/aws-imagebuilder-lifecyclepolicy.json @@ -1,343 +1,343 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "The action of the policy detail.", - "properties": { - "IncludeResources": { - "$ref": "#/definitions/IncludeResources" - }, - "Type": { - "description": "The action type of the policy detail.", - "enum": [ - "DELETE", - "DEPRECATE", - "DISABLE" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AmiExclusionRules": { - "additionalProperties": false, - "description": "The AMI exclusion rules for the policy detail.", - "properties": { - "IsPublic": { - "description": "Use to apply lifecycle policy actions on whether the AMI is public.", - "type": "boolean" - }, - "LastLaunched": { - "$ref": "#/definitions/LastLaunched", - "description": "Use to apply lifecycle policy actions on AMIs launched before a certain time." - }, - "Regions": { - "description": "Use to apply lifecycle policy actions on AMIs distributed to a set of regions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "SharedAccounts": { - "description": "Use to apply lifecycle policy actions on AMIs shared with a set of regions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "TagMap": { - "additionalProperties": false, - "description": "The AMIs to select by tag.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ExclusionRules": { - "additionalProperties": false, - "description": "The exclusion rules to apply of the policy detail.", - "properties": { - "Amis": { - "$ref": "#/definitions/AmiExclusionRules" - }, - "TagMap": { - "additionalProperties": false, - "description": "The Image Builder tags to filter on.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "description": "The filters to apply of the policy detail.", - "properties": { - "RetainAtLeast": { - "description": "The minimum number of Image Builder resources to retain.", - "type": "integer" - }, - "Type": { - "description": "The filter type.", - "enum": [ - "AGE", - "COUNT" - ], - "type": "string" - }, - "Unit": { - "$ref": "#/definitions/TimeUnit", - "description": "The value's time unit." - }, - "Value": { - "description": "The filter value.", - "type": "integer" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "IncludeResources": { - "additionalProperties": false, - "description": "The included resources of the policy detail.", - "properties": { - "Amis": { - "description": "Use to configure lifecycle actions on AMIs.", - "type": "boolean" - }, - "Containers": { - "description": "Use to configure lifecycle actions on containers.", - "type": "boolean" - }, - "Snapshots": { - "description": "Use to configure lifecycle actions on snapshots.", - "type": "boolean" - } - }, - "type": "object" - }, - "LastLaunched": { - "additionalProperties": false, - "description": "The last launched time of a resource.", - "properties": { - "Unit": { - "$ref": "#/definitions/TimeUnit", - "description": "The value's time unit." - }, - "Value": { - "description": "The last launched value.", - "type": "integer" - } - }, - "required": [ - "Value", - "Unit" - ], - "type": "object" - }, - "PolicyDetail": { - "additionalProperties": false, - "description": "The policy detail of the lifecycle policy.", - "properties": { - "Action": { - "$ref": "#/definitions/Action" - }, - "ExclusionRules": { - "$ref": "#/definitions/ExclusionRules" - }, - "Filter": { - "$ref": "#/definitions/Filter" - } - }, - "required": [ - "Action", - "Filter" - ], - "type": "object" - }, - "RecipeSelection": { - "additionalProperties": false, - "description": "The recipe to apply the lifecycle policy for.", - "properties": { - "Name": { - "description": "The recipe name.", - "type": "string" - }, - "SemanticVersion": { - "description": "The recipe version.", - "type": "string" - } - }, - "required": [ - "Name", - "SemanticVersion" - ], - "type": "object" - }, - "ResourceSelection": { - "additionalProperties": false, - "description": "The resource selection for the lifecycle policy.", - "properties": { - "Recipes": { - "description": "The recipes to select.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RecipeSelection" - }, - "type": "array" - }, - "TagMap": { - "additionalProperties": false, - "description": "The Image Builder resources to select by tag.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "TimeUnit": { - "description": "A time unit.", - "enum": [ - "DAYS", - "WEEKS", - "MONTHS", - "YEARS" - ], - "type": "string" - } - }, - "description": "Resource schema for AWS::ImageBuilder::LifecyclePolicy", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "imagebuilder:CreateLifecyclePolicy", - "imagebuilder:GetLifecyclePolicy", - "imagebuilder:TagResource" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:GetLifecyclePolicy", - "imagebuilder:DeleteLifecyclePolicy", - "imagebuilder:UnTagResource" - ] - }, - "list": { - "permissions": [ - "imagebuilder:ListLifecyclePolicies" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetLifecyclePolicy" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "imagebuilder:GetLifecyclePolicy", - "imagebuilder:UpdateLifecyclePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the lifecycle policy.", - "type": "string" - }, - "Description": { - "description": "The description of the lifecycle policy.", - "type": "string" - }, - "ExecutionRole": { - "description": "The execution role of the lifecycle policy.", - "type": "string" - }, - "Name": { - "description": "The name of the lifecycle policy.", - "type": "string" - }, - "PolicyDetails": { - "description": "The policy details of the lifecycle policy.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PolicyDetail" - }, - "type": "array" - }, - "ResourceSelection": { - "$ref": "#/definitions/ResourceSelection", - "description": "The resource selection of the lifecycle policy." - }, - "ResourceType": { - "description": "The resource type of the lifecycle policy.", - "enum": [ - "AMI_IMAGE", - "CONTAINER_IMAGE" - ], - "type": "string" - }, - "Status": { - "description": "The status of the lifecycle policy.", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the lifecycle policy.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "ExecutionRole", - "ResourceType", - "PolicyDetails", - "ResourceSelection" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::LifecyclePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "The action of the policy detail.", + "properties": { + "IncludeResources": { + "$ref": "#/definitions/IncludeResources" + }, + "Type": { + "description": "The action type of the policy detail.", + "enum": [ + "DELETE", + "DEPRECATE", + "DISABLE" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "AmiExclusionRules": { + "additionalProperties": false, + "description": "The AMI exclusion rules for the policy detail.", + "properties": { + "IsPublic": { + "description": "Use to apply lifecycle policy actions on whether the AMI is public.", + "type": "boolean" + }, + "LastLaunched": { + "$ref": "#/definitions/LastLaunched", + "description": "Use to apply lifecycle policy actions on AMIs launched before a certain time." + }, + "Regions": { + "description": "Use to apply lifecycle policy actions on AMIs distributed to a set of regions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "SharedAccounts": { + "description": "Use to apply lifecycle policy actions on AMIs shared with a set of regions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "TagMap": { + "additionalProperties": false, + "description": "The AMIs to select by tag.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ExclusionRules": { + "additionalProperties": false, + "description": "The exclusion rules to apply of the policy detail.", + "properties": { + "Amis": { + "$ref": "#/definitions/AmiExclusionRules" + }, + "TagMap": { + "additionalProperties": false, + "description": "The Image Builder tags to filter on.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "description": "The filters to apply of the policy detail.", + "properties": { + "RetainAtLeast": { + "description": "The minimum number of Image Builder resources to retain.", + "type": "integer" + }, + "Type": { + "description": "The filter type.", + "enum": [ + "AGE", + "COUNT" + ], + "type": "string" + }, + "Unit": { + "$ref": "#/definitions/TimeUnit", + "description": "The value's time unit." + }, + "Value": { + "description": "The filter value.", + "type": "integer" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "IncludeResources": { + "additionalProperties": false, + "description": "The included resources of the policy detail.", + "properties": { + "Amis": { + "description": "Use to configure lifecycle actions on AMIs.", + "type": "boolean" + }, + "Containers": { + "description": "Use to configure lifecycle actions on containers.", + "type": "boolean" + }, + "Snapshots": { + "description": "Use to configure lifecycle actions on snapshots.", + "type": "boolean" + } + }, + "type": "object" + }, + "LastLaunched": { + "additionalProperties": false, + "description": "The last launched time of a resource.", + "properties": { + "Unit": { + "$ref": "#/definitions/TimeUnit", + "description": "The value's time unit." + }, + "Value": { + "description": "The last launched value.", + "type": "integer" + } + }, + "required": [ + "Value", + "Unit" + ], + "type": "object" + }, + "PolicyDetail": { + "additionalProperties": false, + "description": "The policy detail of the lifecycle policy.", + "properties": { + "Action": { + "$ref": "#/definitions/Action" + }, + "ExclusionRules": { + "$ref": "#/definitions/ExclusionRules" + }, + "Filter": { + "$ref": "#/definitions/Filter" + } + }, + "required": [ + "Action", + "Filter" + ], + "type": "object" + }, + "RecipeSelection": { + "additionalProperties": false, + "description": "The recipe to apply the lifecycle policy for.", + "properties": { + "Name": { + "description": "The recipe name.", + "type": "string" + }, + "SemanticVersion": { + "description": "The recipe version.", + "type": "string" + } + }, + "required": [ + "Name", + "SemanticVersion" + ], + "type": "object" + }, + "ResourceSelection": { + "additionalProperties": false, + "description": "The resource selection for the lifecycle policy.", + "properties": { + "Recipes": { + "description": "The recipes to select.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RecipeSelection" + }, + "type": "array" + }, + "TagMap": { + "additionalProperties": false, + "description": "The Image Builder resources to select by tag.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TimeUnit": { + "description": "A time unit.", + "enum": [ + "DAYS", + "WEEKS", + "MONTHS", + "YEARS" + ], + "type": "string" + } + }, + "description": "Resource schema for AWS::ImageBuilder::LifecyclePolicy", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "imagebuilder:CreateLifecyclePolicy", + "imagebuilder:GetLifecyclePolicy", + "imagebuilder:TagResource" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:GetLifecyclePolicy", + "imagebuilder:DeleteLifecyclePolicy", + "imagebuilder:UnTagResource" + ] + }, + "list": { + "permissions": [ + "imagebuilder:ListLifecyclePolicies" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetLifecyclePolicy" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "imagebuilder:GetLifecyclePolicy", + "imagebuilder:UpdateLifecyclePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the lifecycle policy.", + "type": "string" + }, + "Description": { + "description": "The description of the lifecycle policy.", + "type": "string" + }, + "ExecutionRole": { + "description": "The execution role of the lifecycle policy.", + "type": "string" + }, + "Name": { + "description": "The name of the lifecycle policy.", + "type": "string" + }, + "PolicyDetails": { + "description": "The policy details of the lifecycle policy.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PolicyDetail" + }, + "type": "array" + }, + "ResourceSelection": { + "$ref": "#/definitions/ResourceSelection", + "description": "The resource selection of the lifecycle policy." + }, + "ResourceType": { + "description": "The resource type of the lifecycle policy.", + "enum": [ + "AMI_IMAGE", + "CONTAINER_IMAGE" + ], + "type": "string" + }, + "Status": { + "description": "The status of the lifecycle policy.", + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the lifecycle policy.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "ExecutionRole", + "ResourceType", + "PolicyDetails", + "ResourceSelection" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::LifecyclePolicy" +} diff --git a/schema/aws-imagebuilder-workflow.json b/schema/aws-imagebuilder-workflow.json index a27c5c8..5875874 100644 --- a/schema/aws-imagebuilder-workflow.json +++ b/schema/aws-imagebuilder-workflow.json @@ -1,148 +1,148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Version", - "/properties/ChangeDescription", - "/properties/Description", - "/properties/Data", - "/properties/Uri", - "/properties/Type", - "/properties/KmsKeyId", - "/properties/Tags" - ], - "description": "Resource schema for AWS::ImageBuilder::Workflow", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext", - "kms:Encrypt", - "kms:Decrypt", - "s3:GetObject", - "s3:HeadBucket", - "s3:GetBucketLocation", - "imagebuilder:TagResource", - "imagebuilder:GetWorkflow", - "imagebuilder:CreateWorkflow" - ] - }, - "delete": { - "permissions": [ - "imagebuilder:GetWorkflow", - "imagebuilder:UnTagResource", - "imagebuilder:DeleteWorkflow" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/Arn" - } - }, - "required": [ - "Arn" - ] - }, - "permissions": [ - "imagebuilder:ListWorkflows" - ] - }, - "read": { - "permissions": [ - "imagebuilder:GetWorkflow" - ] - } - }, - "oneOf": [ - { - "required": [ - "Data" - ] - }, - { - "required": [ - "Uri" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the workflow.", - "type": "string" - }, - "ChangeDescription": { - "description": "The change description of the workflow.", - "type": "string" - }, - "Data": { - "description": "The data of the workflow.", - "maxLength": 16000, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The description of the workflow.", - "type": "string" - }, - "KmsKeyId": { - "description": "The KMS key identifier used to encrypt the workflow.", - "type": "string" - }, - "Name": { - "description": "The name of the workflow.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "The tags associated with the workflow.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "description": "The type of the workflow denotes whether the workflow is used to build, test, or distribute.", - "enum": [ - "BUILD", - "TEST", - "DISTRIBUTION" - ], - "type": "string" - }, - "Uri": { - "description": "The uri of the workflow.", - "type": "string" - }, - "Version": { - "description": "The version of the workflow.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Type", - "Version" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", - "tagging": { - "taggable": false - }, - "typeName": "AWS::ImageBuilder::Workflow", - "writeOnlyProperties": [ - "/properties/Data", - "/properties/Uri" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Version", + "/properties/ChangeDescription", + "/properties/Description", + "/properties/Data", + "/properties/Uri", + "/properties/Type", + "/properties/KmsKeyId", + "/properties/Tags" + ], + "description": "Resource schema for AWS::ImageBuilder::Workflow", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext", + "kms:Encrypt", + "kms:Decrypt", + "s3:GetObject", + "s3:HeadBucket", + "s3:GetBucketLocation", + "imagebuilder:TagResource", + "imagebuilder:GetWorkflow", + "imagebuilder:CreateWorkflow" + ] + }, + "delete": { + "permissions": [ + "imagebuilder:GetWorkflow", + "imagebuilder:UnTagResource", + "imagebuilder:DeleteWorkflow" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Arn" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "imagebuilder:ListWorkflows" + ] + }, + "read": { + "permissions": [ + "imagebuilder:GetWorkflow" + ] + } + }, + "oneOf": [ + { + "required": [ + "Data" + ] + }, + { + "required": [ + "Uri" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the workflow.", + "type": "string" + }, + "ChangeDescription": { + "description": "The change description of the workflow.", + "type": "string" + }, + "Data": { + "description": "The data of the workflow.", + "maxLength": 16000, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The description of the workflow.", + "type": "string" + }, + "KmsKeyId": { + "description": "The KMS key identifier used to encrypt the workflow.", + "type": "string" + }, + "Name": { + "description": "The name of the workflow.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "The tags associated with the workflow.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "description": "The type of the workflow denotes whether the workflow is used to build, test, or distribute.", + "enum": [ + "BUILD", + "TEST", + "DISTRIBUTION" + ], + "type": "string" + }, + "Uri": { + "description": "The uri of the workflow.", + "type": "string" + }, + "Version": { + "description": "The version of the workflow.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Type", + "Version" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ImageBuilder::Workflow", + "writeOnlyProperties": [ + "/properties/Data", + "/properties/Uri" + ] +} diff --git a/schema/aws-inspector-assessmenttarget.json b/schema/aws-inspector-assessmenttarget.json index cd3013e..af7a720 100644 --- a/schema/aws-inspector-assessmenttarget.json +++ b/schema/aws-inspector-assessmenttarget.json @@ -1,56 +1,56 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AssessmentTargetName" - ], - "description": "Resource Type definition for AWS::Inspector::AssessmentTarget", - "handlers": { - "create": { - "permissions": [ - "inspector:CreateAssessmentTarget", - "inspector:ListAssessmentTargets", - "inspector:DescribeAssessmentTargets" - ] - }, - "delete": { - "permissions": [ - "inspector:DeleteAssessmentTarget" - ] - }, - "list": { - "permissions": [ - "inspector:ListAssessmentTargets" - ] - }, - "read": { - "permissions": [ - "inspector:DescribeAssessmentTargets" - ] - }, - "update": { - "permissions": [ - "inspector:DescribeAssessmentTargets", - "inspector:UpdateAssessmentTarget" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AssessmentTargetName": { - "type": "string" - }, - "ResourceGroupArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "taggable": false, - "typeName": "AWS::Inspector::AssessmentTarget" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AssessmentTargetName" + ], + "description": "Resource Type definition for AWS::Inspector::AssessmentTarget", + "handlers": { + "create": { + "permissions": [ + "inspector:CreateAssessmentTarget", + "inspector:ListAssessmentTargets", + "inspector:DescribeAssessmentTargets" + ] + }, + "delete": { + "permissions": [ + "inspector:DeleteAssessmentTarget" + ] + }, + "list": { + "permissions": [ + "inspector:ListAssessmentTargets" + ] + }, + "read": { + "permissions": [ + "inspector:DescribeAssessmentTargets" + ] + }, + "update": { + "permissions": [ + "inspector:DescribeAssessmentTargets", + "inspector:UpdateAssessmentTarget" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AssessmentTargetName": { + "type": "string" + }, + "ResourceGroupArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "taggable": false, + "typeName": "AWS::Inspector::AssessmentTarget" +} diff --git a/schema/aws-inspector-assessmenttemplate.json b/schema/aws-inspector-assessmenttemplate.json index 111f523..1222405 100644 --- a/schema/aws-inspector-assessmenttemplate.json +++ b/schema/aws-inspector-assessmenttemplate.json @@ -1,94 +1,94 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DurationInSeconds", - "/properties/AssessmentTemplateName", - "/properties/UserAttributesForFindings", - "/properties/AssessmentTargetArn", - "/properties/RulesPackageArns" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Inspector::AssessmentTemplate", - "handlers": { - "create": { - "permissions": [ - "inspector:CreateAssessmentTemplate", - "inspector:ListAssessmentTemplates", - "inspector:DescribeAssessmentTemplates" - ] - }, - "delete": { - "permissions": [ - "inspector:DeleteAssessmentTemplate" - ] - }, - "list": { - "permissions": [ - "inspector:ListAssessmentTemplates" - ] - }, - "read": { - "permissions": [ - "inspector:DescribeAssessmentTemplates" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AssessmentTargetArn": { - "type": "string" - }, - "AssessmentTemplateName": { - "type": "string" - }, - "DurationInSeconds": { - "type": "integer" - }, - "RulesPackageArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "UserAttributesForFindings": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AssessmentTargetArn", - "DurationInSeconds", - "RulesPackageArns" - ], - "taggable": false, - "typeName": "AWS::Inspector::AssessmentTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DurationInSeconds", + "/properties/AssessmentTemplateName", + "/properties/UserAttributesForFindings", + "/properties/AssessmentTargetArn", + "/properties/RulesPackageArns" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Inspector::AssessmentTemplate", + "handlers": { + "create": { + "permissions": [ + "inspector:CreateAssessmentTemplate", + "inspector:ListAssessmentTemplates", + "inspector:DescribeAssessmentTemplates" + ] + }, + "delete": { + "permissions": [ + "inspector:DeleteAssessmentTemplate" + ] + }, + "list": { + "permissions": [ + "inspector:ListAssessmentTemplates" + ] + }, + "read": { + "permissions": [ + "inspector:DescribeAssessmentTemplates" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AssessmentTargetArn": { + "type": "string" + }, + "AssessmentTemplateName": { + "type": "string" + }, + "DurationInSeconds": { + "type": "integer" + }, + "RulesPackageArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "UserAttributesForFindings": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AssessmentTargetArn", + "DurationInSeconds", + "RulesPackageArns" + ], + "taggable": false, + "typeName": "AWS::Inspector::AssessmentTemplate" +} diff --git a/schema/aws-inspector-resourcegroup.json b/schema/aws-inspector-resourcegroup.json index 533628b..37d5ba5 100644 --- a/schema/aws-inspector-resourcegroup.json +++ b/schema/aws-inspector-resourcegroup.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceGroupTags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Inspector::ResourceGroup", - "handlers": { - "create": { - "permissions": [ - "inspector:CreateResourceGroup" - ] - }, - "delete": { - "permissions": [ - "inspector:CreateResourceGroup" - ] - }, - "read": { - "permissions": [ - "inspector:CreateResourceGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ResourceGroupTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ResourceGroupTags" - ], - "taggable": false, - "typeName": "AWS::Inspector::ResourceGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceGroupTags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Inspector::ResourceGroup", + "handlers": { + "create": { + "permissions": [ + "inspector:CreateResourceGroup" + ] + }, + "delete": { + "permissions": [ + "inspector:CreateResourceGroup" + ] + }, + "read": { + "permissions": [ + "inspector:CreateResourceGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ResourceGroupTags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ResourceGroupTags" + ], + "taggable": false, + "typeName": "AWS::Inspector::ResourceGroup" +} diff --git a/schema/aws-inspectorv2-cisscanconfiguration.json b/schema/aws-inspectorv2-cisscanconfiguration.json index 6a6d252..1897fe2 100644 --- a/schema/aws-inspectorv2-cisscanconfiguration.json +++ b/schema/aws-inspectorv2-cisscanconfiguration.json @@ -1,239 +1,245 @@ -{ - "additionalProperties": false, - "definitions": { - "CisSecurityLevel": { - "enum": [ - "LEVEL_1", - "LEVEL_2" - ], - "type": "string" - }, - "CisTagMap": { - "additionalProperties": false, - "patternProperties": { - "^.{2,127}$": { - "pattern": "^.{1,255}$", - "type": "string" - } - }, - "type": "object" - }, - "CisTargets": { - "additionalProperties": false, - "properties": { - "AccountIds": { - "items": { - "pattern": "^\\d{12}|ALL_MEMBERS|SELF$", - "type": "string" - }, - "maxItems": 10000, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TargetResourceTags": { - "$ref": "#/definitions/TargetResourceTags" - } - }, - "required": [ - "AccountIds" - ] - }, - "DailySchedule": { - "additionalProperties": false, - "properties": { - "StartTime": { - "$ref": "#/definitions/Time" - } - }, - "required": [ - "StartTime" - ], - "type": "object" - }, - "Day": { - "enum": [ - "MON", - "TUE", - "WED", - "THU", - "FRI", - "SAT", - "SUN" - ], - "type": "string" - }, - "DaysList": { - "items": { - "$ref": "#/definitions/Day" - }, - "maxItems": 7, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "MonthlySchedule": { - "additionalProperties": false, - "properties": { - "Day": { - "$ref": "#/definitions/Day" - }, - "StartTime": { - "$ref": "#/definitions/Time" - } - }, - "required": [ - "StartTime", - "Day" - ], - "type": "object" - }, - "OneTimeSchedule": { - "type": "object" - }, - "Schedule": { - "description": "Choose a Schedule cadence", - "properties": { - "Daily": { - "$ref": "#/definitions/DailySchedule" - }, - "Monthly": { - "$ref": "#/definitions/MonthlySchedule" - }, - "OneTime": { - "$ref": "#/definitions/OneTimeSchedule" - }, - "Weekly": { - "$ref": "#/definitions/WeeklySchedule" - } - } - }, - "TagValueList": { - "items": { - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TargetResourceTags": { - "additionalProperties": false, - "maxProperties": 5, - "patternProperties": { - "^.+$": { - "$ref": "#/definitions/TagValueList" - } - } - }, - "Time": { - "additionalProperties": false, - "properties": { - "TimeOfDay": { - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - }, - "TimeZone": { - "type": "string" - } - }, - "required": [ - "TimeOfDay", - "TimeZone" - ], - "type": "object" - }, - "WeeklySchedule": { - "additionalProperties": false, - "properties": { - "Days": { - "$ref": "#/definitions/DaysList" - }, - "StartTime": { - "$ref": "#/definitions/Time" - } - }, - "required": [ - "StartTime", - "Days" - ], - "type": "object" - } - }, - "description": "CIS Scan Configuration resource schema", - "handlers": { - "create": { - "permissions": [ - "inspector2:CreateCisScanConfiguration", - "inspector2:ListCisScanConfigurations", - "inspector2:TagResource" - ] - }, - "delete": { - "permissions": [ - "inspector2:ListCisScanConfigurations", - "inspector2:DeleteCisScanConfiguration", - "inspector2:UntagResource" - ] - }, - "list": { - "permissions": [ - "inspector2:ListCisScanConfigurations", - "inspector2:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "inspector2:ListCisScanConfigurations", - "inspector2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "inspector2:ListCisScanConfigurations", - "inspector2:UpdateCisScanConfiguration", - "inspector2:TagResource", - "inspector2:UntagResource", - "inspector2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "CIS Scan configuration unique identifier", - "type": "string" - }, - "ScanName": { - "description": "Name of the scan", - "minLength": 1, - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "SecurityLevel": { - "$ref": "#/definitions/CisSecurityLevel" - }, - "Tags": { - "$ref": "#/definitions/CisTagMap" - }, - "Targets": { - "$ref": "#/definitions/CisTargets" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::InspectorV2::CisScanConfiguration" -} +{ + "additionalProperties": false, + "definitions": { + "CisSecurityLevel": { + "enum": [ + "LEVEL_1", + "LEVEL_2" + ], + "type": "string" + }, + "CisTagMap": { + "additionalProperties": false, + "patternProperties": { + "^.{2,127}$": { + "pattern": "^.{1,255}$", + "type": "string" + } + }, + "type": "object" + }, + "CisTargets": { + "additionalProperties": false, + "properties": { + "AccountIds": { + "items": { + "pattern": "^\\d{12}|ALL_MEMBERS|SELF$", + "type": "string" + }, + "maxItems": 10000, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TargetResourceTags": { + "$ref": "#/definitions/TargetResourceTags" + } + }, + "required": [ + "AccountIds" + ] + }, + "DailySchedule": { + "additionalProperties": false, + "properties": { + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime" + ], + "type": "object" + }, + "Day": { + "enum": [ + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "SUN" + ], + "type": "string" + }, + "DaysList": { + "items": { + "$ref": "#/definitions/Day" + }, + "maxItems": 7, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MonthlySchedule": { + "additionalProperties": false, + "properties": { + "Day": { + "$ref": "#/definitions/Day" + }, + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime", + "Day" + ], + "type": "object" + }, + "OneTimeSchedule": { + "type": "object" + }, + "Schedule": { + "description": "Choose a Schedule cadence", + "properties": { + "Daily": { + "$ref": "#/definitions/DailySchedule" + }, + "Monthly": { + "$ref": "#/definitions/MonthlySchedule" + }, + "OneTime": { + "$ref": "#/definitions/OneTimeSchedule" + }, + "Weekly": { + "$ref": "#/definitions/WeeklySchedule" + } + } + }, + "TagValueList": { + "items": { + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TargetResourceTags": { + "additionalProperties": false, + "maxProperties": 5, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/TagValueList" + } + } + }, + "Time": { + "additionalProperties": false, + "properties": { + "TimeOfDay": { + "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + }, + "TimeZone": { + "type": "string" + } + }, + "required": [ + "TimeOfDay", + "TimeZone" + ], + "type": "object" + }, + "WeeklySchedule": { + "additionalProperties": false, + "properties": { + "Days": { + "$ref": "#/definitions/DaysList" + }, + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime", + "Days" + ], + "type": "object" + } + }, + "description": "CIS Scan Configuration resource schema", + "handlers": { + "create": { + "permissions": [ + "inspector2:CreateCisScanConfiguration", + "inspector2:ListCisScanConfigurations", + "inspector2:TagResource" + ] + }, + "delete": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:DeleteCisScanConfiguration", + "inspector2:UntagResource" + ] + }, + "list": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:UpdateCisScanConfiguration", + "inspector2:TagResource", + "inspector2:UntagResource", + "inspector2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "CIS Scan configuration unique identifier", + "type": "string" + }, + "ScanName": { + "description": "Name of the scan", + "minLength": 1, + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "SecurityLevel": { + "$ref": "#/definitions/CisSecurityLevel" + }, + "Tags": { + "$ref": "#/definitions/CisTagMap" + }, + "Targets": { + "$ref": "#/definitions/CisTargets" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ScanName", + "SecurityLevel", + "Schedule", + "Targets" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::InspectorV2::CisScanConfiguration" +} diff --git a/schema/aws-inspectorv2-filter.json b/schema/aws-inspectorv2-filter.json index 850d66d..f5f3225 100644 --- a/schema/aws-inspectorv2-filter.json +++ b/schema/aws-inspectorv2-filter.json @@ -1,372 +1,372 @@ -{ - "additionalProperties": false, - "definitions": { - "DateFilter": { - "additionalProperties": false, - "properties": { - "EndInclusive": { - "$ref": "#/definitions/Timestamp" - }, - "StartInclusive": { - "$ref": "#/definitions/Timestamp" - } - }, - "type": "object" - }, - "DateFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "FilterAction": { - "enum": [ - "NONE", - "SUPPRESS" - ], - "type": "string" - }, - "FilterCriteria": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "$ref": "#/definitions/StringFilterList" - }, - "ComponentId": { - "$ref": "#/definitions/StringFilterList" - }, - "ComponentType": { - "$ref": "#/definitions/StringFilterList" - }, - "Ec2InstanceImageId": { - "$ref": "#/definitions/StringFilterList" - }, - "Ec2InstanceSubnetId": { - "$ref": "#/definitions/StringFilterList" - }, - "Ec2InstanceVpcId": { - "$ref": "#/definitions/StringFilterList" - }, - "EcrImageArchitecture": { - "$ref": "#/definitions/StringFilterList" - }, - "EcrImageHash": { - "$ref": "#/definitions/StringFilterList" - }, - "EcrImagePushedAt": { - "$ref": "#/definitions/DateFilterList" - }, - "EcrImageRegistry": { - "$ref": "#/definitions/StringFilterList" - }, - "EcrImageRepositoryName": { - "$ref": "#/definitions/StringFilterList" - }, - "EcrImageTags": { - "$ref": "#/definitions/StringFilterList" - }, - "FindingArn": { - "$ref": "#/definitions/StringFilterList" - }, - "FindingStatus": { - "$ref": "#/definitions/StringFilterList" - }, - "FindingType": { - "$ref": "#/definitions/StringFilterList" - }, - "FirstObservedAt": { - "$ref": "#/definitions/DateFilterList" - }, - "InspectorScore": { - "$ref": "#/definitions/NumberFilterList" - }, - "LastObservedAt": { - "$ref": "#/definitions/DateFilterList" - }, - "NetworkProtocol": { - "$ref": "#/definitions/StringFilterList" - }, - "PortRange": { - "$ref": "#/definitions/PortRangeFilterList" - }, - "RelatedVulnerabilities": { - "$ref": "#/definitions/StringFilterList" - }, - "ResourceId": { - "$ref": "#/definitions/StringFilterList" - }, - "ResourceTags": { - "$ref": "#/definitions/MapFilterList" - }, - "ResourceType": { - "$ref": "#/definitions/StringFilterList" - }, - "Severity": { - "$ref": "#/definitions/StringFilterList" - }, - "Title": { - "$ref": "#/definitions/StringFilterList" - }, - "UpdatedAt": { - "$ref": "#/definitions/DateFilterList" - }, - "VendorSeverity": { - "$ref": "#/definitions/StringFilterList" - }, - "VulnerabilityId": { - "$ref": "#/definitions/StringFilterList" - }, - "VulnerabilitySource": { - "$ref": "#/definitions/StringFilterList" - }, - "VulnerablePackages": { - "$ref": "#/definitions/PackageFilterList" - } - }, - "type": "object" - }, - "MapComparison": { - "enum": [ - "EQUALS" - ], - "type": "string" - }, - "MapFilter": { - "additionalProperties": false, - "properties": { - "Comparison": { - "$ref": "#/definitions/MapComparison" - }, - "Key": { - "$ref": "#/definitions/MapKey" - }, - "Value": { - "$ref": "#/definitions/MapValue" - } - }, - "required": [ - "Comparison" - ], - "type": "object" - }, - "MapFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "MapKey": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "MapValue": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "NumberFilter": { - "additionalProperties": false, - "properties": { - "LowerInclusive": { - "type": "number" - }, - "UpperInclusive": { - "type": "number" - } - }, - "type": "object" - }, - "NumberFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "PackageFilter": { - "additionalProperties": false, - "properties": { - "Architecture": { - "$ref": "#/definitions/StringFilter" - }, - "Epoch": { - "$ref": "#/definitions/NumberFilter" - }, - "Name": { - "$ref": "#/definitions/StringFilter" - }, - "Release": { - "$ref": "#/definitions/StringFilter" - }, - "SourceLayerHash": { - "$ref": "#/definitions/StringFilter" - }, - "Version": { - "$ref": "#/definitions/StringFilter" - } - }, - "type": "object" - }, - "PackageFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PackageFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "Port": { - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "PortRangeFilter": { - "additionalProperties": false, - "properties": { - "BeginInclusive": { - "$ref": "#/definitions/Port" - }, - "EndInclusive": { - "$ref": "#/definitions/Port" - } - }, - "type": "object" - }, - "PortRangeFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PortRangeFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "StringComparison": { - "enum": [ - "EQUALS", - "PREFIX", - "NOT_EQUALS" - ], - "type": "string" - }, - "StringFilter": { - "additionalProperties": false, - "properties": { - "Comparison": { - "$ref": "#/definitions/StringComparison" - }, - "Value": { - "$ref": "#/definitions/StringInput" - } - }, - "required": [ - "Comparison", - "Value" - ], - "type": "object" - }, - "StringFilterList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "StringInput": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Timestamp": { - "format": "int64", - "type": "integer" - } - }, - "description": "Inspector Filter resource schema", - "handlers": { - "create": { - "permissions": [ - "inspector2:CreateFilter", - "inspector2:ListFilters" - ] - }, - "delete": { - "permissions": [ - "inspector2:DeleteFilter", - "inspector2:ListFilters" - ] - }, - "list": { - "permissions": [ - "inspector2:ListFilters" - ] - }, - "read": { - "permissions": [ - "inspector2:ListFilters" - ] - }, - "update": { - "permissions": [ - "inspector2:ListFilters", - "inspector2:UpdateFilter" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Findings filter ARN.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "Findings filter description.", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FilterAction": { - "$ref": "#/definitions/FilterAction", - "description": "Findings filter action." - }, - "FilterCriteria": { - "$ref": "#/definitions/FilterCriteria", - "description": "Findings filter criteria." - }, - "Name": { - "description": "Findings filter name.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "FilterCriteria", - "FilterAction" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::InspectorV2::Filter" -} +{ + "additionalProperties": false, + "definitions": { + "DateFilter": { + "additionalProperties": false, + "properties": { + "EndInclusive": { + "$ref": "#/definitions/Timestamp" + }, + "StartInclusive": { + "$ref": "#/definitions/Timestamp" + } + }, + "type": "object" + }, + "DateFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "FilterAction": { + "enum": [ + "NONE", + "SUPPRESS" + ], + "type": "string" + }, + "FilterCriteria": { + "additionalProperties": false, + "properties": { + "AwsAccountId": { + "$ref": "#/definitions/StringFilterList" + }, + "ComponentId": { + "$ref": "#/definitions/StringFilterList" + }, + "ComponentType": { + "$ref": "#/definitions/StringFilterList" + }, + "Ec2InstanceImageId": { + "$ref": "#/definitions/StringFilterList" + }, + "Ec2InstanceSubnetId": { + "$ref": "#/definitions/StringFilterList" + }, + "Ec2InstanceVpcId": { + "$ref": "#/definitions/StringFilterList" + }, + "EcrImageArchitecture": { + "$ref": "#/definitions/StringFilterList" + }, + "EcrImageHash": { + "$ref": "#/definitions/StringFilterList" + }, + "EcrImagePushedAt": { + "$ref": "#/definitions/DateFilterList" + }, + "EcrImageRegistry": { + "$ref": "#/definitions/StringFilterList" + }, + "EcrImageRepositoryName": { + "$ref": "#/definitions/StringFilterList" + }, + "EcrImageTags": { + "$ref": "#/definitions/StringFilterList" + }, + "FindingArn": { + "$ref": "#/definitions/StringFilterList" + }, + "FindingStatus": { + "$ref": "#/definitions/StringFilterList" + }, + "FindingType": { + "$ref": "#/definitions/StringFilterList" + }, + "FirstObservedAt": { + "$ref": "#/definitions/DateFilterList" + }, + "InspectorScore": { + "$ref": "#/definitions/NumberFilterList" + }, + "LastObservedAt": { + "$ref": "#/definitions/DateFilterList" + }, + "NetworkProtocol": { + "$ref": "#/definitions/StringFilterList" + }, + "PortRange": { + "$ref": "#/definitions/PortRangeFilterList" + }, + "RelatedVulnerabilities": { + "$ref": "#/definitions/StringFilterList" + }, + "ResourceId": { + "$ref": "#/definitions/StringFilterList" + }, + "ResourceTags": { + "$ref": "#/definitions/MapFilterList" + }, + "ResourceType": { + "$ref": "#/definitions/StringFilterList" + }, + "Severity": { + "$ref": "#/definitions/StringFilterList" + }, + "Title": { + "$ref": "#/definitions/StringFilterList" + }, + "UpdatedAt": { + "$ref": "#/definitions/DateFilterList" + }, + "VendorSeverity": { + "$ref": "#/definitions/StringFilterList" + }, + "VulnerabilityId": { + "$ref": "#/definitions/StringFilterList" + }, + "VulnerabilitySource": { + "$ref": "#/definitions/StringFilterList" + }, + "VulnerablePackages": { + "$ref": "#/definitions/PackageFilterList" + } + }, + "type": "object" + }, + "MapComparison": { + "enum": [ + "EQUALS" + ], + "type": "string" + }, + "MapFilter": { + "additionalProperties": false, + "properties": { + "Comparison": { + "$ref": "#/definitions/MapComparison" + }, + "Key": { + "$ref": "#/definitions/MapKey" + }, + "Value": { + "$ref": "#/definitions/MapValue" + } + }, + "required": [ + "Comparison" + ], + "type": "object" + }, + "MapFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "MapKey": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "MapValue": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "NumberFilter": { + "additionalProperties": false, + "properties": { + "LowerInclusive": { + "type": "number" + }, + "UpperInclusive": { + "type": "number" + } + }, + "type": "object" + }, + "NumberFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "PackageFilter": { + "additionalProperties": false, + "properties": { + "Architecture": { + "$ref": "#/definitions/StringFilter" + }, + "Epoch": { + "$ref": "#/definitions/NumberFilter" + }, + "Name": { + "$ref": "#/definitions/StringFilter" + }, + "Release": { + "$ref": "#/definitions/StringFilter" + }, + "SourceLayerHash": { + "$ref": "#/definitions/StringFilter" + }, + "Version": { + "$ref": "#/definitions/StringFilter" + } + }, + "type": "object" + }, + "PackageFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PackageFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Port": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "PortRangeFilter": { + "additionalProperties": false, + "properties": { + "BeginInclusive": { + "$ref": "#/definitions/Port" + }, + "EndInclusive": { + "$ref": "#/definitions/Port" + } + }, + "type": "object" + }, + "PortRangeFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PortRangeFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "StringComparison": { + "enum": [ + "EQUALS", + "PREFIX", + "NOT_EQUALS" + ], + "type": "string" + }, + "StringFilter": { + "additionalProperties": false, + "properties": { + "Comparison": { + "$ref": "#/definitions/StringComparison" + }, + "Value": { + "$ref": "#/definitions/StringInput" + } + }, + "required": [ + "Comparison", + "Value" + ], + "type": "object" + }, + "StringFilterList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "StringInput": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Timestamp": { + "format": "int64", + "type": "integer" + } + }, + "description": "Inspector Filter resource schema", + "handlers": { + "create": { + "permissions": [ + "inspector2:CreateFilter", + "inspector2:ListFilters" + ] + }, + "delete": { + "permissions": [ + "inspector2:DeleteFilter", + "inspector2:ListFilters" + ] + }, + "list": { + "permissions": [ + "inspector2:ListFilters" + ] + }, + "read": { + "permissions": [ + "inspector2:ListFilters" + ] + }, + "update": { + "permissions": [ + "inspector2:ListFilters", + "inspector2:UpdateFilter" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Findings filter ARN.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "Findings filter description.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FilterAction": { + "$ref": "#/definitions/FilterAction", + "description": "Findings filter action." + }, + "FilterCriteria": { + "$ref": "#/definitions/FilterCriteria", + "description": "Findings filter criteria." + }, + "Name": { + "description": "Findings filter name.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "FilterCriteria", + "FilterAction" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::InspectorV2::Filter" +} diff --git a/schema/aws-internetmonitor-monitor.json b/schema/aws-internetmonitor-monitor.json index 57a5211..f254645 100644 --- a/schema/aws-internetmonitor-monitor.json +++ b/schema/aws-internetmonitor-monitor.json @@ -1,293 +1,293 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MonitorName" - ], - "definitions": { - "HealthEventsConfig": { - "additionalProperties": false, - "properties": { - "AvailabilityLocalHealthEventsConfig": { - "$ref": "#/definitions/LocalHealthEventsConfig" - }, - "AvailabilityScoreThreshold": { - "maximum": 100.0, - "minimum": 0.0, - "type": "number" - }, - "PerformanceLocalHealthEventsConfig": { - "$ref": "#/definitions/LocalHealthEventsConfig" - }, - "PerformanceScoreThreshold": { - "maximum": 100.0, - "minimum": 0.0, - "type": "number" - } - }, - "type": "object" - }, - "InternetMeasurementsLogDelivery": { - "additionalProperties": false, - "properties": { - "S3Config": { - "$ref": "#/definitions/S3Config" - } - }, - "type": "object" - }, - "LocalHealthEventsConfig": { - "additionalProperties": false, - "properties": { - "HealthScoreThreshold": { - "maximum": 100.0, - "minimum": 0.0, - "type": "number" - }, - "MinTrafficImpact": { - "maximum": 100.0, - "minimum": 0.0, - "type": "number" - }, - "Status": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "MonitorConfigState": { - "enum": [ - "PENDING", - "ACTIVE", - "INACTIVE", - "ERROR" - ], - "type": "string" - }, - "MonitorProcessingStatusCode": { - "enum": [ - "OK", - "INACTIVE", - "COLLECTING_DATA", - "INSUFFICIENT_DATA", - "FAULT_SERVICE", - "FAULT_ACCESS_CLOUDWATCH" - ], - "type": "string" - }, - "S3Config": { - "additionalProperties": false, - "properties": { - "BucketName": { - "minLength": 3, - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "LogDeliveryStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Represents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application", - "handlers": { - "create": { - "permissions": [ - "internetmonitor:CreateMonitor", - "internetmonitor:GetMonitor", - "internetmonitor:TagResource", - "internetmonitor:UntagResource", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "s3:ListBucket", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "internetmonitor:UpdateMonitor", - "internetmonitor:DeleteMonitor", - "internetmonitor:GetMonitor", - "logs:DeleteLogDelivery" - ] - }, - "list": { - "permissions": [ - "internetmonitor:ListMonitors", - "internetmonitor:GetMonitor", - "logs:GetLogDelivery" - ] - }, - "read": { - "permissions": [ - "internetmonitor:GetMonitor", - "internetmonitor:ListTagsForResource", - "logs:GetLogDelivery" - ] - }, - "update": { - "permissions": [ - "internetmonitor:CreateMonitor", - "internetmonitor:GetMonitor", - "internetmonitor:UpdateMonitor", - "internetmonitor:TagResource", - "internetmonitor:UntagResource", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "s3:ListBucket", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/MonitorName" - ], - "properties": { - "CreatedAt": { - "$ref": "#/definitions/iso8601UTC" - }, - "HealthEventsConfig": { - "$ref": "#/definitions/HealthEventsConfig" - }, - "IncludeLinkedAccounts": { - "type": "boolean" - }, - "InternetMeasurementsLogDelivery": { - "$ref": "#/definitions/InternetMeasurementsLogDelivery" - }, - "LinkedAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^(\\d{12})$", - "type": "string" - }, - "MaxCityNetworksToMonitor": { - "maximum": 500000, - "minimum": 1, - "type": "integer" - }, - "ModifiedAt": { - "$ref": "#/definitions/iso8601UTC" - }, - "MonitorArn": { - "maxLength": 512, - "minLength": 20, - "pattern": "^arn:.*", - "type": "string" - }, - "MonitorName": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "ProcessingStatus": { - "$ref": "#/definitions/MonitorProcessingStatusCode" - }, - "ProcessingStatusInfo": { - "type": "string" - }, - "Resources": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:.*", - "type": "string" - }, - "type": "array" - }, - "ResourcesToAdd": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "type": "array" - }, - "ResourcesToRemove": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/MonitorConfigState" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TrafficPercentageToMonitor": { - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/ModifiedAt", - "/properties/MonitorArn", - "/properties/ProcessingStatus", - "/properties/ProcessingStatusInfo" - ], - "required": [ - "MonitorName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::InternetMonitor::Monitor", - "writeOnlyProperties": [ - "/properties/ResourcesToAdd", - "/properties/ResourcesToRemove", - "/properties/LinkedAccountId", - "/properties/IncludeLinkedAccounts" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MonitorName" + ], + "definitions": { + "HealthEventsConfig": { + "additionalProperties": false, + "properties": { + "AvailabilityLocalHealthEventsConfig": { + "$ref": "#/definitions/LocalHealthEventsConfig" + }, + "AvailabilityScoreThreshold": { + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + }, + "PerformanceLocalHealthEventsConfig": { + "$ref": "#/definitions/LocalHealthEventsConfig" + }, + "PerformanceScoreThreshold": { + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + } + }, + "type": "object" + }, + "InternetMeasurementsLogDelivery": { + "additionalProperties": false, + "properties": { + "S3Config": { + "$ref": "#/definitions/S3Config" + } + }, + "type": "object" + }, + "LocalHealthEventsConfig": { + "additionalProperties": false, + "properties": { + "HealthScoreThreshold": { + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + }, + "MinTrafficImpact": { + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "MonitorConfigState": { + "enum": [ + "PENDING", + "ACTIVE", + "INACTIVE", + "ERROR" + ], + "type": "string" + }, + "MonitorProcessingStatusCode": { + "enum": [ + "OK", + "INACTIVE", + "COLLECTING_DATA", + "INSUFFICIENT_DATA", + "FAULT_SERVICE", + "FAULT_ACCESS_CLOUDWATCH" + ], + "type": "string" + }, + "S3Config": { + "additionalProperties": false, + "properties": { + "BucketName": { + "minLength": 3, + "type": "string" + }, + "BucketPrefix": { + "type": "string" + }, + "LogDeliveryStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Represents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application", + "handlers": { + "create": { + "permissions": [ + "internetmonitor:CreateMonitor", + "internetmonitor:GetMonitor", + "internetmonitor:TagResource", + "internetmonitor:UntagResource", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:ListBucket", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "internetmonitor:UpdateMonitor", + "internetmonitor:DeleteMonitor", + "internetmonitor:GetMonitor", + "logs:DeleteLogDelivery" + ] + }, + "list": { + "permissions": [ + "internetmonitor:ListMonitors", + "internetmonitor:GetMonitor", + "logs:GetLogDelivery" + ] + }, + "read": { + "permissions": [ + "internetmonitor:GetMonitor", + "internetmonitor:ListTagsForResource", + "logs:GetLogDelivery" + ] + }, + "update": { + "permissions": [ + "internetmonitor:CreateMonitor", + "internetmonitor:GetMonitor", + "internetmonitor:UpdateMonitor", + "internetmonitor:TagResource", + "internetmonitor:UntagResource", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:ListBucket", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/MonitorName" + ], + "properties": { + "CreatedAt": { + "$ref": "#/definitions/iso8601UTC" + }, + "HealthEventsConfig": { + "$ref": "#/definitions/HealthEventsConfig" + }, + "IncludeLinkedAccounts": { + "type": "boolean" + }, + "InternetMeasurementsLogDelivery": { + "$ref": "#/definitions/InternetMeasurementsLogDelivery" + }, + "LinkedAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^(\\d{12})$", + "type": "string" + }, + "MaxCityNetworksToMonitor": { + "maximum": 500000, + "minimum": 1, + "type": "integer" + }, + "ModifiedAt": { + "$ref": "#/definitions/iso8601UTC" + }, + "MonitorArn": { + "maxLength": 512, + "minLength": 20, + "pattern": "^arn:.*", + "type": "string" + }, + "MonitorName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "ProcessingStatus": { + "$ref": "#/definitions/MonitorProcessingStatusCode" + }, + "ProcessingStatusInfo": { + "type": "string" + }, + "Resources": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:.*", + "type": "string" + }, + "type": "array" + }, + "ResourcesToAdd": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "type": "array" + }, + "ResourcesToRemove": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/MonitorConfigState" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TrafficPercentageToMonitor": { + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/ModifiedAt", + "/properties/MonitorArn", + "/properties/ProcessingStatus", + "/properties/ProcessingStatusInfo" + ], + "required": [ + "MonitorName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::InternetMonitor::Monitor", + "writeOnlyProperties": [ + "/properties/ResourcesToAdd", + "/properties/ResourcesToRemove", + "/properties/LinkedAccountId", + "/properties/IncludeLinkedAccounts" + ] +} diff --git a/schema/aws-iot-accountauditconfiguration.json b/schema/aws-iot-accountauditconfiguration.json index 83f82f7..c7056bc 100644 --- a/schema/aws-iot-accountauditconfiguration.json +++ b/schema/aws-iot-accountauditconfiguration.json @@ -1,171 +1,171 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AccountId" - ], - "definitions": { - "AuditCheckConfiguration": { - "additionalProperties": false, - "description": "The configuration for a specific audit check.", - "properties": { - "Enabled": { - "description": "True if the check is enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "AuditCheckConfigurations": { - "additionalProperties": false, - "description": "Specifies which audit checks are enabled and disabled for this account.", - "properties": { - "AuthenticatedCognitoRoleOverlyPermissiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "CaCertificateExpiringCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "CaCertificateKeyQualityCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "ConflictingClientIdsCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "DeviceCertificateExpiringCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "DeviceCertificateKeyQualityCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "DeviceCertificateSharedCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "IoTPolicyPotentialMisConfigurationCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "IotPolicyOverlyPermissiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "IotRoleAliasAllowsAccessToUnusedServicesCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "IotRoleAliasOverlyPermissiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "LoggingDisabledCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "RevokedCaCertificateStillActiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "RevokedDeviceCertificateStillActiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - }, - "UnauthenticatedCognitoRoleOverlyPermissiveCheck": { - "$ref": "#/definitions/AuditCheckConfiguration" - } - }, - "type": "object" - }, - "AuditNotificationTarget": { - "additionalProperties": false, - "properties": { - "Enabled": { - "description": "True if notifications to the target are enabled.", - "type": "boolean" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to send notifications to the target.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "TargetArn": { - "description": "The ARN of the target (SNS topic) to which audit notifications are sent.", - "maxLength": 2048, - "type": "string" - } - }, - "type": "object" - }, - "AuditNotificationTargetConfigurations": { - "additionalProperties": false, - "description": "Information about the targets to which audit notifications are sent.", - "properties": { - "Sns": { - "$ref": "#/definitions/AuditNotificationTarget" - } - }, - "type": "object" - } - }, - "description": "Configures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.", - "handlers": { - "create": { - "permissions": [ - "iot:UpdateAccountAuditConfiguration", - "iot:DescribeAccountAuditConfiguration", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeAccountAuditConfiguration", - "iot:DeleteAccountAuditConfiguration" - ] - }, - "list": { - "permissions": [ - "iot:DescribeAccountAuditConfiguration" - ] - }, - "read": { - "permissions": [ - "iot:DescribeAccountAuditConfiguration" - ] - }, - "update": { - "permissions": [ - "iot:UpdateAccountAuditConfiguration", - "iot:DescribeAccountAuditConfiguration", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).", - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "AuditCheckConfigurations": { - "$ref": "#/definitions/AuditCheckConfigurations" - }, - "AuditNotificationTargetConfigurations": { - "$ref": "#/definitions/AuditNotificationTargetConfigurations" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "AccountId", - "AuditCheckConfigurations", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::IoT::AccountAuditConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AccountId" + ], + "definitions": { + "AuditCheckConfiguration": { + "additionalProperties": false, + "description": "The configuration for a specific audit check.", + "properties": { + "Enabled": { + "description": "True if the check is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "AuditCheckConfigurations": { + "additionalProperties": false, + "description": "Specifies which audit checks are enabled and disabled for this account.", + "properties": { + "AuthenticatedCognitoRoleOverlyPermissiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "CaCertificateExpiringCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "CaCertificateKeyQualityCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "ConflictingClientIdsCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "DeviceCertificateExpiringCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "DeviceCertificateKeyQualityCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "DeviceCertificateSharedCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "IoTPolicyPotentialMisConfigurationCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "IotPolicyOverlyPermissiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "IotRoleAliasAllowsAccessToUnusedServicesCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "IotRoleAliasOverlyPermissiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "LoggingDisabledCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "RevokedCaCertificateStillActiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "RevokedDeviceCertificateStillActiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + }, + "UnauthenticatedCognitoRoleOverlyPermissiveCheck": { + "$ref": "#/definitions/AuditCheckConfiguration" + } + }, + "type": "object" + }, + "AuditNotificationTarget": { + "additionalProperties": false, + "properties": { + "Enabled": { + "description": "True if notifications to the target are enabled.", + "type": "boolean" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to send notifications to the target.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "TargetArn": { + "description": "The ARN of the target (SNS topic) to which audit notifications are sent.", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + }, + "AuditNotificationTargetConfigurations": { + "additionalProperties": false, + "description": "Information about the targets to which audit notifications are sent.", + "properties": { + "Sns": { + "$ref": "#/definitions/AuditNotificationTarget" + } + }, + "type": "object" + } + }, + "description": "Configures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.", + "handlers": { + "create": { + "permissions": [ + "iot:UpdateAccountAuditConfiguration", + "iot:DescribeAccountAuditConfiguration", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeAccountAuditConfiguration", + "iot:DeleteAccountAuditConfiguration" + ] + }, + "list": { + "permissions": [ + "iot:DescribeAccountAuditConfiguration" + ] + }, + "read": { + "permissions": [ + "iot:DescribeAccountAuditConfiguration" + ] + }, + "update": { + "permissions": [ + "iot:UpdateAccountAuditConfiguration", + "iot:DescribeAccountAuditConfiguration", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).", + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "AuditCheckConfigurations": { + "$ref": "#/definitions/AuditCheckConfigurations" + }, + "AuditNotificationTargetConfigurations": { + "$ref": "#/definitions/AuditNotificationTargetConfigurations" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "AccountId", + "AuditCheckConfigurations", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::IoT::AccountAuditConfiguration" +} diff --git a/schema/aws-iot-authorizer.json b/schema/aws-iot-authorizer.json index c4d564c..48a9526 100644 --- a/schema/aws-iot-authorizer.json +++ b/schema/aws-iot-authorizer.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SigningDisabled", - "/properties/AuthorizerName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates an authorizer.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateAuthorizer", - "iot:DescribeAuthorizer", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:UpdateAuthorizer", - "iot:DeleteAuthorizer", - "iot:DescribeAuthorizer" - ] - }, - "list": { - "permissions": [ - "iot:ListAuthorizers" - ] - }, - "read": { - "permissions": [ - "iot:DescribeAuthorizer", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateAuthorizer", - "iot:DescribeAuthorizer", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AuthorizerName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AuthorizerFunctionArn": { - "type": "string" - }, - "AuthorizerName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w=,@-]+", - "type": "string" - }, - "EnableCachingForHttp": { - "type": "boolean" - }, - "SigningDisabled": { - "type": "boolean" - }, - "Status": { - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TokenKeyName": { - "type": "string" - }, - "TokenSigningPublicKeys": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9:_-]+": { - "maxLength": 5120, - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AuthorizerFunctionArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::Authorizer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SigningDisabled", + "/properties/AuthorizerName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates an authorizer.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateAuthorizer", + "iot:DescribeAuthorizer", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:UpdateAuthorizer", + "iot:DeleteAuthorizer", + "iot:DescribeAuthorizer" + ] + }, + "list": { + "permissions": [ + "iot:ListAuthorizers" + ] + }, + "read": { + "permissions": [ + "iot:DescribeAuthorizer", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateAuthorizer", + "iot:DescribeAuthorizer", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AuthorizerName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AuthorizerFunctionArn": { + "type": "string" + }, + "AuthorizerName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w=,@-]+", + "type": "string" + }, + "EnableCachingForHttp": { + "type": "boolean" + }, + "SigningDisabled": { + "type": "boolean" + }, + "Status": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TokenKeyName": { + "type": "string" + }, + "TokenSigningPublicKeys": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9:_-]+": { + "maxLength": 5120, + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AuthorizerFunctionArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::Authorizer" +} diff --git a/schema/aws-iot-billinggroup.json b/schema/aws-iot-billinggroup.json index 08802a5..e3927fb 100644 --- a/schema/aws-iot-billinggroup.json +++ b/schema/aws-iot-billinggroup.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BillingGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::BillingGroup", - "handlers": { - "create": { - "permissions": [ - "iot:DescribeBillingGroup", - "iot:ListTagsForResource", - "iot:CreateBillingGroup", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeBillingGroup", - "iot:DeleteBillingGroup" - ] - }, - "list": { - "permissions": [ - "iot:ListBillingGroups", - "iot:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iot:DescribeBillingGroup", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:DescribeBillingGroup", - "iot:UpdateBillingGroup", - "iot:ListTagsForResource", - "iot:TagResource", - "iot:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/BillingGroupName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "BillingGroupName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "BillingGroupProperties": { - "additionalProperties": false, - "properties": { - "BillingGroupDescription": { - "maxLength": 2028, - "pattern": "[\\p{Graph}\\x20]*", - "type": "string" - } - }, - "type": "object" - }, - "Id": { - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::BillingGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BillingGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::BillingGroup", + "handlers": { + "create": { + "permissions": [ + "iot:DescribeBillingGroup", + "iot:ListTagsForResource", + "iot:CreateBillingGroup", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeBillingGroup", + "iot:DeleteBillingGroup" + ] + }, + "list": { + "permissions": [ + "iot:ListBillingGroups", + "iot:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iot:DescribeBillingGroup", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:DescribeBillingGroup", + "iot:UpdateBillingGroup", + "iot:ListTagsForResource", + "iot:TagResource", + "iot:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/BillingGroupName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "BillingGroupName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "BillingGroupProperties": { + "additionalProperties": false, + "properties": { + "BillingGroupDescription": { + "maxLength": 2028, + "pattern": "[\\p{Graph}\\x20]*", + "type": "string" + } + }, + "type": "object" + }, + "Id": { + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::BillingGroup" +} diff --git a/schema/aws-iot-cacertificate.json b/schema/aws-iot-cacertificate.json index 9e7673b..bb86fcc 100644 --- a/schema/aws-iot-cacertificate.json +++ b/schema/aws-iot-cacertificate.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VerificationCertificatePem", - "/properties/CertificateMode", - "/properties/CACertificatePem" - ], - "definitions": { - "RegistrationConfig": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", - "type": "string" - }, - "TemplateBody": { - "maxLength": 10240, - "minLength": 0, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "TemplateName": { - "maxLength": 36, - "minLength": 1, - "pattern": "^[0-9A-Za-z_-]+$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Registers a CA Certificate in IoT.", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:RegisterCACertificate", - "iot:DescribeCACertificate", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:UpdateCACertificate", - "iot:DeleteCACertificate", - "iot:DescribeCACertificate" - ] - }, - "list": { - "permissions": [ - "iot:ListCACertificates" - ] - }, - "read": { - "permissions": [ - "iot:DescribeCACertificate", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:UpdateCACertificate", - "iot:DescribeCACertificate", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AutoRegistrationStatus": { - "enum": [ - "ENABLE", - "DISABLE" - ], - "type": "string" - }, - "CACertificatePem": { - "maxLength": 65536, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "CertificateMode": { - "enum": [ - "DEFAULT", - "SNI_ONLY" - ], - "type": "string" - }, - "Id": { - "type": "string" - }, - "RegistrationConfig": { - "$ref": "#/definitions/RegistrationConfig" - }, - "RemoveAutoRegistration": { - "type": "boolean" - }, - "Status": { - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VerificationCertificatePem": { - "description": "The private key verification certificate.", - "maxLength": 65536, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "CACertificatePem", - "Status" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::CACertificate", - "writeOnlyProperties": [ - "/properties/VerificationCertificatePem", - "/properties/RemoveAutoRegistration" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VerificationCertificatePem", + "/properties/CertificateMode", + "/properties/CACertificatePem" + ], + "definitions": { + "RegistrationConfig": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", + "type": "string" + }, + "TemplateBody": { + "maxLength": 10240, + "minLength": 0, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "TemplateName": { + "maxLength": 36, + "minLength": 1, + "pattern": "^[0-9A-Za-z_-]+$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Registers a CA Certificate in IoT.", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:RegisterCACertificate", + "iot:DescribeCACertificate", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:UpdateCACertificate", + "iot:DeleteCACertificate", + "iot:DescribeCACertificate" + ] + }, + "list": { + "permissions": [ + "iot:ListCACertificates" + ] + }, + "read": { + "permissions": [ + "iot:DescribeCACertificate", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:UpdateCACertificate", + "iot:DescribeCACertificate", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AutoRegistrationStatus": { + "enum": [ + "ENABLE", + "DISABLE" + ], + "type": "string" + }, + "CACertificatePem": { + "maxLength": 65536, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "CertificateMode": { + "enum": [ + "DEFAULT", + "SNI_ONLY" + ], + "type": "string" + }, + "Id": { + "type": "string" + }, + "RegistrationConfig": { + "$ref": "#/definitions/RegistrationConfig" + }, + "RemoveAutoRegistration": { + "type": "boolean" + }, + "Status": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VerificationCertificatePem": { + "description": "The private key verification certificate.", + "maxLength": 65536, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "CACertificatePem", + "Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::CACertificate", + "writeOnlyProperties": [ + "/properties/VerificationCertificatePem", + "/properties/RemoveAutoRegistration" + ] +} diff --git a/schema/aws-iot-certificate.json b/schema/aws-iot-certificate.json index e668226..d601b85 100644 --- a/schema/aws-iot-certificate.json +++ b/schema/aws-iot-certificate.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateSigningRequest", - "/properties/CACertificatePem", - "/properties/CertificatePem", - "/properties/CertificateMode" - ], - "definitions": {}, - "description": "Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateCertificateFromCsr", - "iot:RegisterCertificate", - "iot:RegisterCertificateWithoutCA", - "iot:DescribeCertificate" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteCertificate", - "iot:UpdateCertificate", - "iot:DescribeCertificate" - ] - }, - "list": { - "permissions": [ - "iot:ListCertificates" - ] - }, - "read": { - "permissions": [ - "iot:DescribeCertificate" - ] - }, - "update": { - "permissions": [ - "iot:UpdateCertificate", - "iot:DescribeCertificate" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CACertificatePem": { - "maxLength": 65536, - "minLength": 1, - "type": "string" - }, - "CertificateMode": { - "enum": [ - "DEFAULT", - "SNI_ONLY" - ], - "type": "string" - }, - "CertificatePem": { - "maxLength": 65536, - "minLength": 1, - "type": "string" - }, - "CertificateSigningRequest": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Status": { - "enum": [ - "ACTIVE", - "INACTIVE", - "REVOKED", - "PENDING_TRANSFER", - "PENDING_ACTIVATION" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Status" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IoT::Certificate", - "writeOnlyProperties": [ - "/properties/CertificateSigningRequest", - "/properties/CACertificatePem" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateSigningRequest", + "/properties/CACertificatePem", + "/properties/CertificatePem", + "/properties/CertificateMode" + ], + "definitions": {}, + "description": "Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateCertificateFromCsr", + "iot:RegisterCertificate", + "iot:RegisterCertificateWithoutCA", + "iot:DescribeCertificate" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteCertificate", + "iot:UpdateCertificate", + "iot:DescribeCertificate" + ] + }, + "list": { + "permissions": [ + "iot:ListCertificates" + ] + }, + "read": { + "permissions": [ + "iot:DescribeCertificate" + ] + }, + "update": { + "permissions": [ + "iot:UpdateCertificate", + "iot:DescribeCertificate" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CACertificatePem": { + "maxLength": 65536, + "minLength": 1, + "type": "string" + }, + "CertificateMode": { + "enum": [ + "DEFAULT", + "SNI_ONLY" + ], + "type": "string" + }, + "CertificatePem": { + "maxLength": 65536, + "minLength": 1, + "type": "string" + }, + "CertificateSigningRequest": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Status": { + "enum": [ + "ACTIVE", + "INACTIVE", + "REVOKED", + "PENDING_TRANSFER", + "PENDING_ACTIVATION" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IoT::Certificate", + "writeOnlyProperties": [ + "/properties/CertificateSigningRequest", + "/properties/CACertificatePem" + ] +} diff --git a/schema/aws-iot-certificateprovider.json b/schema/aws-iot-certificateprovider.json index 05e5d0b..25978ab 100644 --- a/schema/aws-iot-certificateprovider.json +++ b/schema/aws-iot-certificateprovider.json @@ -1,130 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateProviderName" - ], - "definitions": { - "CertificateProviderOperation": { - "enum": [ - "CreateCertificateFromCsr" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Use the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateCertificateProvider", - "iot:DescribeCertificateProvider", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteCertificateProvider", - "iot:DescribeCertificateProvider" - ] - }, - "list": { - "permissions": [ - "iot:ListCertificateProviders" - ] - }, - "read": { - "permissions": [ - "iot:DescribeCertificateProvider", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateCertificateProvider", - "iot:DescribeCertificateProvider", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateProviderName" - ], - "properties": { - "AccountDefaultForOperations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CertificateProviderOperation" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "type": "string" - }, - "CertificateProviderName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w=,@-]+", - "type": "string" - }, - "LambdaFunctionArn": { - "maxLength": 170, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "LambdaFunctionArn", - "AccountDefaultForOperations" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::CertificateProvider" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateProviderName" + ], + "definitions": { + "CertificateProviderOperation": { + "enum": [ + "CreateCertificateFromCsr" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Use the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateCertificateProvider", + "iot:DescribeCertificateProvider", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteCertificateProvider", + "iot:DescribeCertificateProvider" + ] + }, + "list": { + "permissions": [ + "iot:ListCertificateProviders" + ] + }, + "read": { + "permissions": [ + "iot:DescribeCertificateProvider", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateCertificateProvider", + "iot:DescribeCertificateProvider", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateProviderName" + ], + "properties": { + "AccountDefaultForOperations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CertificateProviderOperation" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "type": "string" + }, + "CertificateProviderName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w=,@-]+", + "type": "string" + }, + "LambdaFunctionArn": { + "maxLength": 170, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "LambdaFunctionArn", + "AccountDefaultForOperations" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::CertificateProvider" +} diff --git a/schema/aws-iot-custommetric.json b/schema/aws-iot-custommetric.json index ba1cfef..cc653ac 100644 --- a/schema/aws-iot-custommetric.json +++ b/schema/aws-iot-custommetric.json @@ -1,117 +1,117 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/MetricType" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "A custom metric published by your devices to Device Defender.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateCustomMetric", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeCustomMetric", - "iot:DeleteCustomMetric" - ] - }, - "list": { - "permissions": [ - "iot:ListCustomMetrics" - ] - }, - "read": { - "permissions": [ - "iot:DescribeCustomMetric", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateCustomMetric", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/MetricName" - ], - "properties": { - "DisplayName": { - "description": "Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.", - "maxLength": 128, - "type": "string" - }, - "MetricArn": { - "description": "The Amazon Resource Number (ARN) of the custom metric.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "MetricName": { - "description": "The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "MetricType": { - "description": "The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.", - "enum": [ - "string-list", - "ip-address-list", - "number-list", - "number" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/MetricArn" - ], - "required": [ - "MetricType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "typeName": "AWS::IoT::CustomMetric" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/MetricType" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "A custom metric published by your devices to Device Defender.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateCustomMetric", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeCustomMetric", + "iot:DeleteCustomMetric" + ] + }, + "list": { + "permissions": [ + "iot:ListCustomMetrics" + ] + }, + "read": { + "permissions": [ + "iot:DescribeCustomMetric", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateCustomMetric", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/MetricName" + ], + "properties": { + "DisplayName": { + "description": "Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.", + "maxLength": 128, + "type": "string" + }, + "MetricArn": { + "description": "The Amazon Resource Number (ARN) of the custom metric.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "MetricName": { + "description": "The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "MetricType": { + "description": "The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.", + "enum": [ + "string-list", + "ip-address-list", + "number-list", + "number" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/MetricArn" + ], + "required": [ + "MetricType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "typeName": "AWS::IoT::CustomMetric" +} diff --git a/schema/aws-iot-dimension.json b/schema/aws-iot-dimension.json index 198da11..3488419 100644 --- a/schema/aws-iot-dimension.json +++ b/schema/aws-iot-dimension.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "A dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateDimension", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeDimension", - "iot:DeleteDimension" - ] - }, - "list": { - "permissions": [ - "iot:ListDimensions" - ] - }, - "read": { - "permissions": [ - "iot:DescribeDimension", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateDimension", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The ARN (Amazon resource name) of the created dimension.", - "type": "string" - }, - "Name": { - "description": "A unique identifier for the dimension.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "StringValues": { - "description": "Specifies the value or list of values for the dimension.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "Metadata that can be used to manage the dimension.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "Specifies the type of the dimension.", - "enum": [ - "TOPIC_FILTER" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Type", - "StringValues" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "typeName": "AWS::IoT::Dimension" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "A dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateDimension", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeDimension", + "iot:DeleteDimension" + ] + }, + "list": { + "permissions": [ + "iot:ListDimensions" + ] + }, + "read": { + "permissions": [ + "iot:DescribeDimension", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateDimension", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The ARN (Amazon resource name) of the created dimension.", + "type": "string" + }, + "Name": { + "description": "A unique identifier for the dimension.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "StringValues": { + "description": "Specifies the value or list of values for the dimension.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "Metadata that can be used to manage the dimension.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "Specifies the type of the dimension.", + "enum": [ + "TOPIC_FILTER" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Type", + "StringValues" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "typeName": "AWS::IoT::Dimension" +} diff --git a/schema/aws-iot-domainconfiguration.json b/schema/aws-iot-domainconfiguration.json index ae552c8..87ad14e 100644 --- a/schema/aws-iot-domainconfiguration.json +++ b/schema/aws-iot-domainconfiguration.json @@ -1,225 +1,225 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DomainConfigurationName", - "/properties/DomainName", - "/properties/ServiceType", - "/properties/ValidationCertificateArn", - "/properties/ServerCertificateArns" - ], - "definitions": { - "AuthorizerConfig": { - "additionalProperties": false, - "properties": { - "AllowAuthorizerOverride": { - "type": "boolean" - }, - "DefaultAuthorizerName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\w=,@-]+$", - "type": "string" - } - }, - "type": "object" - }, - "ServerCertificateConfig": { - "additionalProperties": false, - "properties": { - "EnableOCSPCheck": { - "type": "boolean" - } - }, - "type": "object" - }, - "ServerCertificateSummary": { - "additionalProperties": false, - "properties": { - "ServerCertificateArn": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", - "type": "string" - }, - "ServerCertificateStatus": { - "enum": [ - "INVALID", - "VALID" - ], - "type": "string" - }, - "ServerCertificateStatusDetail": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TlsConfig": { - "additionalProperties": false, - "properties": { - "SecurityPolicy": { - "maxLength": 128, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage a Domain Configuration", - "handlers": { - "create": { - "permissions": [ - "iot:CreateDomainConfiguration", - "iot:UpdateDomainConfiguration", - "iot:DescribeDomainConfiguration", - "iot:TagResource", - "iot:ListTagsForResource", - "acm:GetCertificate" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeDomainConfiguration", - "iot:DeleteDomainConfiguration", - "iot:UpdateDomainConfiguration" - ] - }, - "list": { - "permissions": [ - "iot:ListDomainConfigurations" - ] - }, - "read": { - "permissions": [ - "iot:DescribeDomainConfiguration", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateDomainConfiguration", - "iot:DescribeDomainConfiguration", - "iot:ListTagsForResource", - "iot:TagResource", - "iot:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainConfigurationName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AuthorizerConfig": { - "$ref": "#/definitions/AuthorizerConfig" - }, - "DomainConfigurationName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\w.-]+$", - "type": "string" - }, - "DomainConfigurationStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "DomainName": { - "maxLength": 253, - "minLength": 1, - "type": "string" - }, - "DomainType": { - "enum": [ - "ENDPOINT", - "AWS_MANAGED", - "CUSTOMER_MANAGED" - ], - "type": "string" - }, - "ServerCertificateArns": { - "insertionOrder": true, - "items": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", - "type": "string" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "ServerCertificateConfig": { - "$ref": "#/definitions/ServerCertificateConfig" - }, - "ServerCertificates": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ServerCertificateSummary" - }, - "type": "array" - }, - "ServiceType": { - "enum": [ - "DATA", - "CREDENTIAL_PROVIDER", - "JOBS" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TlsConfig": { - "$ref": "#/definitions/TlsConfig" - }, - "ValidationCertificateArn": { - "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DomainType", - "/properties/ServerCertificates" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::DomainConfiguration", - "writeOnlyProperties": [ - "/properties/ValidationCertificateArn", - "/properties/ServerCertificateArns" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainConfigurationName", + "/properties/DomainName", + "/properties/ServiceType", + "/properties/ValidationCertificateArn", + "/properties/ServerCertificateArns" + ], + "definitions": { + "AuthorizerConfig": { + "additionalProperties": false, + "properties": { + "AllowAuthorizerOverride": { + "type": "boolean" + }, + "DefaultAuthorizerName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w=,@-]+$", + "type": "string" + } + }, + "type": "object" + }, + "ServerCertificateConfig": { + "additionalProperties": false, + "properties": { + "EnableOCSPCheck": { + "type": "boolean" + } + }, + "type": "object" + }, + "ServerCertificateSummary": { + "additionalProperties": false, + "properties": { + "ServerCertificateArn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", + "type": "string" + }, + "ServerCertificateStatus": { + "enum": [ + "INVALID", + "VALID" + ], + "type": "string" + }, + "ServerCertificateStatusDetail": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TlsConfig": { + "additionalProperties": false, + "properties": { + "SecurityPolicy": { + "maxLength": 128, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage a Domain Configuration", + "handlers": { + "create": { + "permissions": [ + "iot:CreateDomainConfiguration", + "iot:UpdateDomainConfiguration", + "iot:DescribeDomainConfiguration", + "iot:TagResource", + "iot:ListTagsForResource", + "acm:GetCertificate" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeDomainConfiguration", + "iot:DeleteDomainConfiguration", + "iot:UpdateDomainConfiguration" + ] + }, + "list": { + "permissions": [ + "iot:ListDomainConfigurations" + ] + }, + "read": { + "permissions": [ + "iot:DescribeDomainConfiguration", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateDomainConfiguration", + "iot:DescribeDomainConfiguration", + "iot:ListTagsForResource", + "iot:TagResource", + "iot:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainConfigurationName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AuthorizerConfig": { + "$ref": "#/definitions/AuthorizerConfig" + }, + "DomainConfigurationName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w.-]+$", + "type": "string" + }, + "DomainConfigurationStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "DomainName": { + "maxLength": 253, + "minLength": 1, + "type": "string" + }, + "DomainType": { + "enum": [ + "ENDPOINT", + "AWS_MANAGED", + "CUSTOMER_MANAGED" + ], + "type": "string" + }, + "ServerCertificateArns": { + "insertionOrder": true, + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "ServerCertificateConfig": { + "$ref": "#/definitions/ServerCertificateConfig" + }, + "ServerCertificates": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ServerCertificateSummary" + }, + "type": "array" + }, + "ServiceType": { + "enum": [ + "DATA", + "CREDENTIAL_PROVIDER", + "JOBS" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TlsConfig": { + "$ref": "#/definitions/TlsConfig" + }, + "ValidationCertificateArn": { + "pattern": "^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DomainType", + "/properties/ServerCertificates" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::DomainConfiguration", + "writeOnlyProperties": [ + "/properties/ValidationCertificateArn", + "/properties/ServerCertificateArns" + ] +} diff --git a/schema/aws-iot-fleetmetric.json b/schema/aws-iot-fleetmetric.json index e098d20..94c9198 100644 --- a/schema/aws-iot-fleetmetric.json +++ b/schema/aws-iot-fleetmetric.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName" - ], - "definitions": { - "AggregationType": { - "additionalProperties": false, - "description": "Aggregation types supported by Fleet Indexing", - "properties": { - "Name": { - "description": "Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality", - "type": "string" - }, - "Values": { - "description": "Fleet Indexing aggregation type values", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource", - "properties": { - "Key": { - "description": "The tag's key", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "An aggregated metric of certain devices in your fleet", - "handlers": { - "create": { - "permissions": [ - "iot:CreateFleetMetric", - "iot:DescribeFleetMetric", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteFleetMetric", - "iot:DescribeFleetMetric" - ] - }, - "list": { - "permissions": [ - "iot:ListFleetMetrics" - ] - }, - "read": { - "permissions": [ - "iot:DescribeFleetMetric", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateFleetMetric", - "iot:DescribeFleetMetric", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/MetricName" - ], - "properties": { - "AggregationField": { - "description": "The aggregation field to perform aggregation and metric emission", - "type": "string" - }, - "AggregationType": { - "$ref": "#/definitions/AggregationType" - }, - "CreationDate": { - "$ref": "#/definitions/iso8601UTC", - "description": "The creation date of a fleet metric" - }, - "Description": { - "description": "The description of a fleet metric", - "type": "string" - }, - "IndexName": { - "description": "The index name of a fleet metric", - "type": "string" - }, - "LastModifiedDate": { - "$ref": "#/definitions/iso8601UTC", - "description": "The last modified date of a fleet metric" - }, - "MetricArn": { - "description": "The Amazon Resource Number (ARN) of a fleet metric metric", - "type": "string" - }, - "MetricName": { - "description": "The name of the fleet metric", - "type": "string" - }, - "Period": { - "description": "The period of metric emission in seconds", - "type": "integer" - }, - "QueryString": { - "description": "The Fleet Indexing query used by a fleet metric", - "type": "string" - }, - "QueryVersion": { - "description": "The version of a Fleet Indexing query used by a fleet metric", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Unit": { - "description": "The unit of data points emitted by a fleet metric", - "type": "string" - }, - "Version": { - "description": "The version of a fleet metric", - "type": "number" - } - }, - "readOnlyProperties": [ - "/properties/MetricArn", - "/properties/CreationDate", - "/properties/LastModifiedDate", - "/properties/Version" - ], - "required": [ - "MetricName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "taggable": true, - "typeName": "AWS::IoT::FleetMetric" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName" + ], + "definitions": { + "AggregationType": { + "additionalProperties": false, + "description": "Aggregation types supported by Fleet Indexing", + "properties": { + "Name": { + "description": "Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality", + "type": "string" + }, + "Values": { + "description": "Fleet Indexing aggregation type values", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource", + "properties": { + "Key": { + "description": "The tag's key", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "An aggregated metric of certain devices in your fleet", + "handlers": { + "create": { + "permissions": [ + "iot:CreateFleetMetric", + "iot:DescribeFleetMetric", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteFleetMetric", + "iot:DescribeFleetMetric" + ] + }, + "list": { + "permissions": [ + "iot:ListFleetMetrics" + ] + }, + "read": { + "permissions": [ + "iot:DescribeFleetMetric", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateFleetMetric", + "iot:DescribeFleetMetric", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/MetricName" + ], + "properties": { + "AggregationField": { + "description": "The aggregation field to perform aggregation and metric emission", + "type": "string" + }, + "AggregationType": { + "$ref": "#/definitions/AggregationType" + }, + "CreationDate": { + "$ref": "#/definitions/iso8601UTC", + "description": "The creation date of a fleet metric" + }, + "Description": { + "description": "The description of a fleet metric", + "type": "string" + }, + "IndexName": { + "description": "The index name of a fleet metric", + "type": "string" + }, + "LastModifiedDate": { + "$ref": "#/definitions/iso8601UTC", + "description": "The last modified date of a fleet metric" + }, + "MetricArn": { + "description": "The Amazon Resource Number (ARN) of a fleet metric metric", + "type": "string" + }, + "MetricName": { + "description": "The name of the fleet metric", + "type": "string" + }, + "Period": { + "description": "The period of metric emission in seconds", + "type": "integer" + }, + "QueryString": { + "description": "The Fleet Indexing query used by a fleet metric", + "type": "string" + }, + "QueryVersion": { + "description": "The version of a Fleet Indexing query used by a fleet metric", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Unit": { + "description": "The unit of data points emitted by a fleet metric", + "type": "string" + }, + "Version": { + "description": "The version of a fleet metric", + "type": "number" + } + }, + "readOnlyProperties": [ + "/properties/MetricArn", + "/properties/CreationDate", + "/properties/LastModifiedDate", + "/properties/Version" + ], + "required": [ + "MetricName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "taggable": true, + "typeName": "AWS::IoT::FleetMetric" +} diff --git a/schema/aws-iot-jobtemplate.json b/schema/aws-iot-jobtemplate.json index bab4480..d2eeb74 100644 --- a/schema/aws-iot-jobtemplate.json +++ b/schema/aws-iot-jobtemplate.json @@ -1,403 +1,403 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobTemplateId", - "/properties/JobArn", - "/properties/Description", - "/properties/Document", - "/properties/DocumentSource", - "/properties/TimeoutConfig", - "/properties/JobExecutionsRolloutConfig", - "/properties/AbortConfig", - "/properties/PresignedUrlConfig", - "/properties/Tags", - "/properties/DestinationPackageVersions", - "/properties/JobExecutionsRetryConfig", - "/properties/MaintenanceWindows" - ], - "definitions": { - "AbortCriteria": { - "additionalProperties": false, - "description": "The criteria that determine when and how a job abort takes place.", - "properties": { - "Action": { - "$ref": "#/definitions/Action", - "description": "The type of job action to take to initiate the job abort." - }, - "FailureType": { - "$ref": "#/definitions/FailureType", - "description": "The type of job execution failures that can initiate a job abort." - }, - "MinNumberOfExecutedThings": { - "$ref": "#/definitions/MinNumberOfExecutedThings", - "description": "The minimum number of things which must receive job execution notifications before the job can be aborted." - }, - "ThresholdPercentage": { - "$ref": "#/definitions/ThresholdPercentage", - "description": "The minimum percentage of job execution failures that must occur to initiate the job abort." - } - }, - "required": [ - "Action", - "FailureType", - "MinNumberOfExecutedThings", - "ThresholdPercentage" - ], - "type": "object" - }, - "Action": { - "enum": [ - "CANCEL" - ], - "type": "string" - }, - "BaseRatePerMinute": { - "minimum": 1, - "type": "integer" - }, - "DestinationPackageVersion": { - "description": "Specifies target package version ARNs for a software update job.", - "maxLength": 1600, - "minLength": 1, - "type": "string" - }, - "ExpiresInSec": { - "description": "How number (in seconds) pre-signed URLs are valid.", - "maximum": 3600, - "minimum": 60, - "type": "integer" - }, - "ExponentialRolloutRate": { - "additionalProperties": false, - "description": "Allows you to create an exponential rate of rollout for a job.", - "properties": { - "BaseRatePerMinute": { - "$ref": "#/definitions/BaseRatePerMinute", - "description": "The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout." - }, - "IncrementFactor": { - "$ref": "#/definitions/IncrementFactor", - "description": "The exponential factor to increase the rate of rollout for a job." - }, - "RateIncreaseCriteria": { - "$ref": "#/definitions/RateIncreaseCriteria", - "description": "The criteria to initiate the increase in rate of rollout for a job.", - "type": "object" - } - }, - "required": [ - "BaseRatePerMinute", - "IncrementFactor", - "RateIncreaseCriteria" - ], - "type": "object" - }, - "FailureType": { - "enum": [ - "FAILED", - "REJECTED", - "TIMED_OUT", - "ALL" - ], - "type": "string" - }, - "InProgressTimeoutInMinutes": { - "description": "Specifies the amount of time, in minutes, this device has to finish execution of this job.", - "maximum": 10080, - "minimum": 1, - "type": "integer" - }, - "IncrementFactor": { - "maximum": 5, - "minimum": 1, - "type": "number" - }, - "JobRetryFailureType": { - "enum": [ - "FAILED", - "TIMED_OUT", - "ALL" - ], - "type": "string" - }, - "MaintenanceWindow": { - "additionalProperties": false, - "description": "Specifies a start time and duration for a scheduled Job.", - "properties": { - "DurationInMinutes": { - "maximum": 1430, - "minimum": 1, - "type": "integer" - }, - "StartTime": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "MaximumPerMinute": { - "minimum": 1, - "type": "integer" - }, - "MinNumberOfExecutedThings": { - "minimum": 1, - "type": "integer" - }, - "NumberOfNotifiedThings": { - "minimum": 1, - "type": "integer" - }, - "NumberOfSucceededThings": { - "minimum": 1, - "type": "integer" - }, - "RateIncreaseCriteria": { - "additionalProperties": false, - "properties": { - "NumberOfNotifiedThings": { - "$ref": "#/definitions/NumberOfNotifiedThings" - }, - "NumberOfSucceededThings": { - "$ref": "#/definitions/NumberOfSucceededThings" - } - }, - "type": "object" - }, - "RetryCriteria": { - "additionalProperties": false, - "description": "Specifies how many times a failure type should be retried.", - "properties": { - "FailureType": { - "$ref": "#/definitions/JobRetryFailureType" - }, - "NumberOfRetries": { - "maximum": 10, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "RoleArn": { - "description": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ThresholdPercentage": { - "maximum": 100, - "type": "number" - } - }, - "description": "Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.", - "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html", - "handlers": { - "create": { - "permissions": [ - "iot:CreateJobTemplate", - "iam:PassRole", - "s3:GetObject", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteJobTemplate" - ] - }, - "list": { - "permissions": [ - "iot:ListJobTemplates" - ] - }, - "read": { - "permissions": [ - "iot:DescribeJobTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobTemplateId" - ], - "properties": { - "AbortConfig": { - "additionalProperties": false, - "description": "The criteria that determine when and how a job abort takes place.", - "properties": { - "CriteriaList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AbortCriteria" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "CriteriaList" - ], - "type": "object" - }, - "Arn": { - "type": "string" - }, - "Description": { - "description": "A description of the Job Template.", - "maxLength": 2028, - "pattern": "[^\\p{C}]+", - "type": "string" - }, - "DestinationPackageVersions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DestinationPackageVersion" - }, - "type": "array" - }, - "Document": { - "description": "The job document. Required if you don't specify a value for documentSource.", - "maxLength": 32768, - "type": "string" - }, - "DocumentSource": { - "description": "An S3 link to the job document to use in the template. Required if you don't specify a value for document.", - "maxLength": 1350, - "minLength": 1, - "type": "string" - }, - "JobArn": { - "description": "Optional for copying a JobTemplate from a pre-existing Job configuration.", - "type": "string" - }, - "JobExecutionsRetryConfig": { - "additionalProperties": false, - "properties": { - "RetryCriteriaList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RetryCriteria" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "JobExecutionsRolloutConfig": { - "additionalProperties": false, - "description": "Allows you to create a staged rollout of a job.", - "properties": { - "ExponentialRolloutRate": { - "$ref": "#/definitions/ExponentialRolloutRate", - "description": "The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout." - }, - "MaximumPerMinute": { - "$ref": "#/definitions/MaximumPerMinute", - "description": "The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout." - } - }, - "type": "object" - }, - "JobTemplateId": { - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_-]+", - "type": "string" - }, - "MaintenanceWindows": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MaintenanceWindow" - }, - "type": "array" - }, - "PresignedUrlConfig": { - "additionalProperties": false, - "description": "Configuration for pre-signed S3 URLs.", - "properties": { - "ExpiresInSec": { - "$ref": "#/definitions/ExpiresInSec" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Tags": { - "description": "Metadata that can be used to manage the JobTemplate.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TimeoutConfig": { - "additionalProperties": false, - "description": "Specifies the amount of time each device has to finish its execution of the job.", - "properties": { - "InProgressTimeoutInMinutes": { - "$ref": "#/definitions/InProgressTimeoutInMinutes" - } - }, - "required": [ - "InProgressTimeoutInMinutes" - ], - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "JobTemplateId", - "Description" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "taggable": true, - "typeName": "AWS::IoT::JobTemplate", - "writeOnlyProperties": [ - "/properties/JobArn", - "/properties/Tags", - "/properties/Document", - "/properties/DocumentSource", - "/properties/TimeoutConfig", - "/properties/JobExecutionsRolloutConfig", - "/properties/AbortConfig", - "/properties/PresignedUrlConfig", - "/properties/DestinationPackageVersions", - "/properties/JobExecutionsRetryConfig", - "/properties/MaintenanceWindows" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/JobTemplateId", + "/properties/JobArn", + "/properties/Description", + "/properties/Document", + "/properties/DocumentSource", + "/properties/TimeoutConfig", + "/properties/JobExecutionsRolloutConfig", + "/properties/AbortConfig", + "/properties/PresignedUrlConfig", + "/properties/Tags", + "/properties/DestinationPackageVersions", + "/properties/JobExecutionsRetryConfig", + "/properties/MaintenanceWindows" + ], + "definitions": { + "AbortCriteria": { + "additionalProperties": false, + "description": "The criteria that determine when and how a job abort takes place.", + "properties": { + "Action": { + "$ref": "#/definitions/Action", + "description": "The type of job action to take to initiate the job abort." + }, + "FailureType": { + "$ref": "#/definitions/FailureType", + "description": "The type of job execution failures that can initiate a job abort." + }, + "MinNumberOfExecutedThings": { + "$ref": "#/definitions/MinNumberOfExecutedThings", + "description": "The minimum number of things which must receive job execution notifications before the job can be aborted." + }, + "ThresholdPercentage": { + "$ref": "#/definitions/ThresholdPercentage", + "description": "The minimum percentage of job execution failures that must occur to initiate the job abort." + } + }, + "required": [ + "Action", + "FailureType", + "MinNumberOfExecutedThings", + "ThresholdPercentage" + ], + "type": "object" + }, + "Action": { + "enum": [ + "CANCEL" + ], + "type": "string" + }, + "BaseRatePerMinute": { + "minimum": 1, + "type": "integer" + }, + "DestinationPackageVersion": { + "description": "Specifies target package version ARNs for a software update job.", + "maxLength": 1600, + "minLength": 1, + "type": "string" + }, + "ExpiresInSec": { + "description": "How number (in seconds) pre-signed URLs are valid.", + "maximum": 3600, + "minimum": 60, + "type": "integer" + }, + "ExponentialRolloutRate": { + "additionalProperties": false, + "description": "Allows you to create an exponential rate of rollout for a job.", + "properties": { + "BaseRatePerMinute": { + "$ref": "#/definitions/BaseRatePerMinute", + "description": "The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout." + }, + "IncrementFactor": { + "$ref": "#/definitions/IncrementFactor", + "description": "The exponential factor to increase the rate of rollout for a job." + }, + "RateIncreaseCriteria": { + "$ref": "#/definitions/RateIncreaseCriteria", + "description": "The criteria to initiate the increase in rate of rollout for a job.", + "type": "object" + } + }, + "required": [ + "BaseRatePerMinute", + "IncrementFactor", + "RateIncreaseCriteria" + ], + "type": "object" + }, + "FailureType": { + "enum": [ + "FAILED", + "REJECTED", + "TIMED_OUT", + "ALL" + ], + "type": "string" + }, + "InProgressTimeoutInMinutes": { + "description": "Specifies the amount of time, in minutes, this device has to finish execution of this job.", + "maximum": 10080, + "minimum": 1, + "type": "integer" + }, + "IncrementFactor": { + "maximum": 5, + "minimum": 1, + "type": "number" + }, + "JobRetryFailureType": { + "enum": [ + "FAILED", + "TIMED_OUT", + "ALL" + ], + "type": "string" + }, + "MaintenanceWindow": { + "additionalProperties": false, + "description": "Specifies a start time and duration for a scheduled Job.", + "properties": { + "DurationInMinutes": { + "maximum": 1430, + "minimum": 1, + "type": "integer" + }, + "StartTime": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "MaximumPerMinute": { + "minimum": 1, + "type": "integer" + }, + "MinNumberOfExecutedThings": { + "minimum": 1, + "type": "integer" + }, + "NumberOfNotifiedThings": { + "minimum": 1, + "type": "integer" + }, + "NumberOfSucceededThings": { + "minimum": 1, + "type": "integer" + }, + "RateIncreaseCriteria": { + "additionalProperties": false, + "properties": { + "NumberOfNotifiedThings": { + "$ref": "#/definitions/NumberOfNotifiedThings" + }, + "NumberOfSucceededThings": { + "$ref": "#/definitions/NumberOfSucceededThings" + } + }, + "type": "object" + }, + "RetryCriteria": { + "additionalProperties": false, + "description": "Specifies how many times a failure type should be retried.", + "properties": { + "FailureType": { + "$ref": "#/definitions/JobRetryFailureType" + }, + "NumberOfRetries": { + "maximum": 10, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "RoleArn": { + "description": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ThresholdPercentage": { + "maximum": 100, + "type": "number" + } + }, + "description": "Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.", + "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html", + "handlers": { + "create": { + "permissions": [ + "iot:CreateJobTemplate", + "iam:PassRole", + "s3:GetObject", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteJobTemplate" + ] + }, + "list": { + "permissions": [ + "iot:ListJobTemplates" + ] + }, + "read": { + "permissions": [ + "iot:DescribeJobTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/JobTemplateId" + ], + "properties": { + "AbortConfig": { + "additionalProperties": false, + "description": "The criteria that determine when and how a job abort takes place.", + "properties": { + "CriteriaList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AbortCriteria" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "CriteriaList" + ], + "type": "object" + }, + "Arn": { + "type": "string" + }, + "Description": { + "description": "A description of the Job Template.", + "maxLength": 2028, + "pattern": "[^\\p{C}]+", + "type": "string" + }, + "DestinationPackageVersions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DestinationPackageVersion" + }, + "type": "array" + }, + "Document": { + "description": "The job document. Required if you don't specify a value for documentSource.", + "maxLength": 32768, + "type": "string" + }, + "DocumentSource": { + "description": "An S3 link to the job document to use in the template. Required if you don't specify a value for document.", + "maxLength": 1350, + "minLength": 1, + "type": "string" + }, + "JobArn": { + "description": "Optional for copying a JobTemplate from a pre-existing Job configuration.", + "type": "string" + }, + "JobExecutionsRetryConfig": { + "additionalProperties": false, + "properties": { + "RetryCriteriaList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RetryCriteria" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "JobExecutionsRolloutConfig": { + "additionalProperties": false, + "description": "Allows you to create a staged rollout of a job.", + "properties": { + "ExponentialRolloutRate": { + "$ref": "#/definitions/ExponentialRolloutRate", + "description": "The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout." + }, + "MaximumPerMinute": { + "$ref": "#/definitions/MaximumPerMinute", + "description": "The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout." + } + }, + "type": "object" + }, + "JobTemplateId": { + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_-]+", + "type": "string" + }, + "MaintenanceWindows": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MaintenanceWindow" + }, + "type": "array" + }, + "PresignedUrlConfig": { + "additionalProperties": false, + "description": "Configuration for pre-signed S3 URLs.", + "properties": { + "ExpiresInSec": { + "$ref": "#/definitions/ExpiresInSec" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "Tags": { + "description": "Metadata that can be used to manage the JobTemplate.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TimeoutConfig": { + "additionalProperties": false, + "description": "Specifies the amount of time each device has to finish its execution of the job.", + "properties": { + "InProgressTimeoutInMinutes": { + "$ref": "#/definitions/InProgressTimeoutInMinutes" + } + }, + "required": [ + "InProgressTimeoutInMinutes" + ], + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "JobTemplateId", + "Description" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "taggable": true, + "typeName": "AWS::IoT::JobTemplate", + "writeOnlyProperties": [ + "/properties/JobArn", + "/properties/Tags", + "/properties/Document", + "/properties/DocumentSource", + "/properties/TimeoutConfig", + "/properties/JobExecutionsRolloutConfig", + "/properties/AbortConfig", + "/properties/PresignedUrlConfig", + "/properties/DestinationPackageVersions", + "/properties/JobExecutionsRetryConfig", + "/properties/MaintenanceWindows" + ] +} diff --git a/schema/aws-iot-logging.json b/schema/aws-iot-logging.json index eaa5765..e89b83f 100644 --- a/schema/aws-iot-logging.json +++ b/schema/aws-iot-logging.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AccountId" - ], - "definitions": {}, - "description": "Logging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.", - "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html", - "handlers": { - "create": { - "permissions": [ - "iot:SetV2LoggingOptions", - "iot:GetV2LoggingOptions", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iot:SetV2LoggingOptions", - "iot:GetV2LoggingOptions" - ] - }, - "list": { - "permissions": [ - "iot:GetV2LoggingOptions" - ] - }, - "read": { - "permissions": [ - "iot:GetV2LoggingOptions" - ] - }, - "update": { - "permissions": [ - "iot:SetV2LoggingOptions", - "iot:GetV2LoggingOptions", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).", - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "DefaultLogLevel": { - "description": "The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.", - "enum": [ - "ERROR", - "WARN", - "INFO", - "DEBUG", - "DISABLED" - ], - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that allows IoT to write to Cloudwatch logs.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "AccountId", - "RoleArn", - "DefaultLogLevel" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "taggable": false, - "typeName": "AWS::IoT::Logging" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AccountId" + ], + "definitions": {}, + "description": "Logging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.", + "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html", + "handlers": { + "create": { + "permissions": [ + "iot:SetV2LoggingOptions", + "iot:GetV2LoggingOptions", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iot:SetV2LoggingOptions", + "iot:GetV2LoggingOptions" + ] + }, + "list": { + "permissions": [ + "iot:GetV2LoggingOptions" + ] + }, + "read": { + "permissions": [ + "iot:GetV2LoggingOptions" + ] + }, + "update": { + "permissions": [ + "iot:SetV2LoggingOptions", + "iot:GetV2LoggingOptions", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource).", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DefaultLogLevel": { + "description": "The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.", + "enum": [ + "ERROR", + "WARN", + "INFO", + "DEBUG", + "DISABLED" + ], + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that allows IoT to write to Cloudwatch logs.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "AccountId", + "RoleArn", + "DefaultLogLevel" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "taggable": false, + "typeName": "AWS::IoT::Logging" +} diff --git a/schema/aws-iot-mitigationaction.json b/schema/aws-iot-mitigationaction.json index 20d6a70..906b573 100644 --- a/schema/aws-iot-mitigationaction.json +++ b/schema/aws-iot-mitigationaction.json @@ -1,259 +1,259 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ActionName" - ], - "definitions": { - "ActionParams": { - "additionalProperties": false, - "description": "The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).", - "properties": { - "AddThingsToThingGroupParams": { - "$ref": "#/definitions/AddThingsToThingGroupParams" - }, - "EnableIoTLoggingParams": { - "$ref": "#/definitions/EnableIoTLoggingParams" - }, - "PublishFindingToSnsParams": { - "$ref": "#/definitions/PublishFindingToSnsParams" - }, - "ReplaceDefaultPolicyVersionParams": { - "$ref": "#/definitions/ReplaceDefaultPolicyVersionParams" - }, - "UpdateCACertificateParams": { - "$ref": "#/definitions/UpdateCACertificateParams" - }, - "UpdateDeviceCertificateParams": { - "$ref": "#/definitions/UpdateDeviceCertificateParams" - } - }, - "type": "object" - }, - "AddThingsToThingGroupParams": { - "additionalProperties": false, - "description": "Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.", - "properties": { - "OverrideDynamicGroups": { - "description": "Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.", - "type": "boolean" - }, - "ThingGroupNames": { - "description": "The list of groups to which you want to add the things that triggered the mitigation action.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ThingGroupNames" - ], - "type": "object" - }, - "EnableIoTLoggingParams": { - "additionalProperties": false, - "description": "Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.", - "properties": { - "LogLevel": { - "description": " Specifies which types of information are logged.", - "enum": [ - "DEBUG", - "INFO", - "ERROR", - "WARN", - "UNSET_VALUE" - ], - "type": "string" - }, - "RoleArnForLogging": { - "description": " The ARN of the IAM role used for logging.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "LogLevel", - "RoleArnForLogging" - ], - "type": "object" - }, - "PublishFindingToSnsParams": { - "additionalProperties": false, - "description": "Parameters, to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.", - "properties": { - "TopicArn": { - "description": "The ARN of the topic to which you want to publish the findings.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "TopicArn" - ], - "type": "object" - }, - "ReplaceDefaultPolicyVersionParams": { - "additionalProperties": false, - "description": "Parameters to define a mitigation action that adds a blank policy to restrict permissions.", - "properties": { - "TemplateName": { - "enum": [ - "BLANK_POLICY", - "UNSET_VALUE" - ], - "type": "string" - } - }, - "required": [ - "TemplateName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "UpdateCACertificateParams": { - "additionalProperties": false, - "description": "Parameters to define a mitigation action that changes the state of the CA certificate to inactive.", - "properties": { - "Action": { - "enum": [ - "DEACTIVATE", - "UNSET_VALUE" - ], - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "UpdateDeviceCertificateParams": { - "additionalProperties": false, - "description": "Parameters to define a mitigation action that changes the state of the device certificate to inactive.", - "properties": { - "Action": { - "enum": [ - "DEACTIVATE", - "UNSET_VALUE" - ], - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - } - }, - "description": "Mitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateMitigationAction", - "iot:DescribeMitigationAction", - "iot:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeMitigationAction", - "iot:DeleteMitigationAction" - ] - }, - "list": { - "permissions": [ - "iot:ListMitigationActions" - ] - }, - "read": { - "permissions": [ - "iot:DescribeMitigationAction", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateMitigationAction", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ActionName" - ], - "properties": { - "ActionName": { - "description": "A unique identifier for the mitigation action.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "ActionParams": { - "$ref": "#/definitions/ActionParams" - }, - "MitigationActionArn": { - "type": "string" - }, - "MitigationActionId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/MitigationActionArn", - "/properties/MitigationActionId" - ], - "required": [ - "RoleArn", - "ActionParams" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "typeName": "AWS::IoT::MitigationAction" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ActionName" + ], + "definitions": { + "ActionParams": { + "additionalProperties": false, + "description": "The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).", + "properties": { + "AddThingsToThingGroupParams": { + "$ref": "#/definitions/AddThingsToThingGroupParams" + }, + "EnableIoTLoggingParams": { + "$ref": "#/definitions/EnableIoTLoggingParams" + }, + "PublishFindingToSnsParams": { + "$ref": "#/definitions/PublishFindingToSnsParams" + }, + "ReplaceDefaultPolicyVersionParams": { + "$ref": "#/definitions/ReplaceDefaultPolicyVersionParams" + }, + "UpdateCACertificateParams": { + "$ref": "#/definitions/UpdateCACertificateParams" + }, + "UpdateDeviceCertificateParams": { + "$ref": "#/definitions/UpdateDeviceCertificateParams" + } + }, + "type": "object" + }, + "AddThingsToThingGroupParams": { + "additionalProperties": false, + "description": "Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.", + "properties": { + "OverrideDynamicGroups": { + "description": "Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups.", + "type": "boolean" + }, + "ThingGroupNames": { + "description": "The list of groups to which you want to add the things that triggered the mitigation action.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ThingGroupNames" + ], + "type": "object" + }, + "EnableIoTLoggingParams": { + "additionalProperties": false, + "description": "Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.", + "properties": { + "LogLevel": { + "description": " Specifies which types of information are logged.", + "enum": [ + "DEBUG", + "INFO", + "ERROR", + "WARN", + "UNSET_VALUE" + ], + "type": "string" + }, + "RoleArnForLogging": { + "description": " The ARN of the IAM role used for logging.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "LogLevel", + "RoleArnForLogging" + ], + "type": "object" + }, + "PublishFindingToSnsParams": { + "additionalProperties": false, + "description": "Parameters, to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.", + "properties": { + "TopicArn": { + "description": "The ARN of the topic to which you want to publish the findings.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "TopicArn" + ], + "type": "object" + }, + "ReplaceDefaultPolicyVersionParams": { + "additionalProperties": false, + "description": "Parameters to define a mitigation action that adds a blank policy to restrict permissions.", + "properties": { + "TemplateName": { + "enum": [ + "BLANK_POLICY", + "UNSET_VALUE" + ], + "type": "string" + } + }, + "required": [ + "TemplateName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "UpdateCACertificateParams": { + "additionalProperties": false, + "description": "Parameters to define a mitigation action that changes the state of the CA certificate to inactive.", + "properties": { + "Action": { + "enum": [ + "DEACTIVATE", + "UNSET_VALUE" + ], + "type": "string" + } + }, + "required": [ + "Action" + ], + "type": "object" + }, + "UpdateDeviceCertificateParams": { + "additionalProperties": false, + "description": "Parameters to define a mitigation action that changes the state of the device certificate to inactive.", + "properties": { + "Action": { + "enum": [ + "DEACTIVATE", + "UNSET_VALUE" + ], + "type": "string" + } + }, + "required": [ + "Action" + ], + "type": "object" + } + }, + "description": "Mitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateMitigationAction", + "iot:DescribeMitigationAction", + "iot:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeMitigationAction", + "iot:DeleteMitigationAction" + ] + }, + "list": { + "permissions": [ + "iot:ListMitigationActions" + ] + }, + "read": { + "permissions": [ + "iot:DescribeMitigationAction", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateMitigationAction", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ActionName" + ], + "properties": { + "ActionName": { + "description": "A unique identifier for the mitigation action.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "ActionParams": { + "$ref": "#/definitions/ActionParams" + }, + "MitigationActionArn": { + "type": "string" + }, + "MitigationActionId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/MitigationActionArn", + "/properties/MitigationActionId" + ], + "required": [ + "RoleArn", + "ActionParams" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "typeName": "AWS::IoT::MitigationAction" +} diff --git a/schema/aws-iot-policy.json b/schema/aws-iot-policy.json index f664d45..abffbdb 100644 --- a/schema/aws-iot-policy.json +++ b/schema/aws-iot-policy.json @@ -1,111 +1,111 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::Policy", - "handlers": { - "create": { - "permissions": [ - "iot:CreatePolicy", - "iot:GetPolicy", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeletePolicy", - "iot:GetPolicy", - "iot:ListPolicyVersions", - "iot:DeletePolicyVersion" - ] - }, - "list": { - "permissions": [ - "iot:ListPolicies" - ] - }, - "read": { - "permissions": [ - "iot:GetPolicy", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:GetPolicy", - "iot:ListPolicyVersions", - "iot:CreatePolicyVersion", - "iot:DeletePolicyVersion", - "iot:SetDefaultPolicyVersion", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PolicyDocument": { - "maxLength": 404600, - "minLength": 1, - "type": [ - "object", - "string" - ] - }, - "PolicyName": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "PolicyDocument" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::Policy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::Policy", + "handlers": { + "create": { + "permissions": [ + "iot:CreatePolicy", + "iot:GetPolicy", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeletePolicy", + "iot:GetPolicy", + "iot:ListPolicyVersions", + "iot:DeletePolicyVersion" + ] + }, + "list": { + "permissions": [ + "iot:ListPolicies" + ] + }, + "read": { + "permissions": [ + "iot:GetPolicy", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:GetPolicy", + "iot:ListPolicyVersions", + "iot:CreatePolicyVersion", + "iot:DeletePolicyVersion", + "iot:SetDefaultPolicyVersion", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PolicyDocument": { + "maxLength": 404600, + "minLength": 1, + "type": [ + "object", + "string" + ] + }, + "PolicyName": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "PolicyDocument" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::Policy" +} diff --git a/schema/aws-iot-policyprincipalattachment.json b/schema/aws-iot-policyprincipalattachment.json index a1c309d..4a6d173 100644 --- a/schema/aws-iot-policyprincipalattachment.json +++ b/schema/aws-iot-policyprincipalattachment.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/Principal" - ], - "description": "Resource Type definition for AWS::IoT::PolicyPrincipalAttachment", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "PolicyName": { - "type": "string" - }, - "Principal": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Principal", - "PolicyName" - ], - "typeName": "AWS::IoT::PolicyPrincipalAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/Principal" + ], + "description": "Resource Type definition for AWS::IoT::PolicyPrincipalAttachment", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "PolicyName": { + "type": "string" + }, + "Principal": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Principal", + "PolicyName" + ], + "typeName": "AWS::IoT::PolicyPrincipalAttachment" +} diff --git a/schema/aws-iot-provisioningtemplate.json b/schema/aws-iot-provisioningtemplate.json index be5e514..ae6458c 100644 --- a/schema/aws-iot-provisioningtemplate.json +++ b/schema/aws-iot-provisioningtemplate.json @@ -1,142 +1,142 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TemplateName", - "/properties/TemplateType" - ], - "definitions": { - "ProvisioningHook": { - "additionalProperties": false, - "properties": { - "PayloadVersion": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Creates a fleet provisioning template.", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:CreateProvisioningTemplate", - "iot:DescribeProvisioningTemplate", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteProvisioningTemplate", - "iot:DescribeProvisioningTemplate" - ] - }, - "list": { - "permissions": [ - "iot:ListProvisioningTemplates" - ] - }, - "read": { - "permissions": [ - "iot:DescribeProvisioningTemplate", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:UpdateProvisioningTemplate", - "iot:CreateProvisioningTemplateVersion", - "iot:ListProvisioningTemplateVersions", - "iot:DeleteProvisioningTemplateVersion", - "iot:DescribeProvisioningTemplate", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/TemplateName" - ], - "properties": { - "Description": { - "maxLength": 500, - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PreProvisioningHook": { - "$ref": "#/definitions/ProvisioningHook" - }, - "ProvisioningRoleArn": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TemplateArn": { - "type": "string" - }, - "TemplateBody": { - "type": "string" - }, - "TemplateName": { - "maxLength": 36, - "minLength": 1, - "pattern": "^[0-9A-Za-z_-]+$", - "type": "string" - }, - "TemplateType": { - "enum": [ - "FLEET_PROVISIONING", - "JITP" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TemplateArn" - ], - "required": [ - "ProvisioningRoleArn", - "TemplateBody" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::ProvisioningTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TemplateName", + "/properties/TemplateType" + ], + "definitions": { + "ProvisioningHook": { + "additionalProperties": false, + "properties": { + "PayloadVersion": { + "type": "string" + }, + "TargetArn": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Creates a fleet provisioning template.", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:CreateProvisioningTemplate", + "iot:DescribeProvisioningTemplate", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteProvisioningTemplate", + "iot:DescribeProvisioningTemplate" + ] + }, + "list": { + "permissions": [ + "iot:ListProvisioningTemplates" + ] + }, + "read": { + "permissions": [ + "iot:DescribeProvisioningTemplate", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:UpdateProvisioningTemplate", + "iot:CreateProvisioningTemplateVersion", + "iot:ListProvisioningTemplateVersions", + "iot:DeleteProvisioningTemplateVersion", + "iot:DescribeProvisioningTemplate", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TemplateName" + ], + "properties": { + "Description": { + "maxLength": 500, + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "PreProvisioningHook": { + "$ref": "#/definitions/ProvisioningHook" + }, + "ProvisioningRoleArn": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TemplateArn": { + "type": "string" + }, + "TemplateBody": { + "type": "string" + }, + "TemplateName": { + "maxLength": 36, + "minLength": 1, + "pattern": "^[0-9A-Za-z_-]+$", + "type": "string" + }, + "TemplateType": { + "enum": [ + "FLEET_PROVISIONING", + "JITP" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TemplateArn" + ], + "required": [ + "ProvisioningRoleArn", + "TemplateBody" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::ProvisioningTemplate" +} diff --git a/schema/aws-iot-resourcespecificlogging.json b/schema/aws-iot-resourcespecificlogging.json index cee5c7c..8453682 100644 --- a/schema/aws-iot-resourcespecificlogging.json +++ b/schema/aws-iot-resourcespecificlogging.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetName", - "/properties/TargetType" - ], - "definitions": {}, - "description": "Resource-specific logging allows you to specify a logging level for a specific thing group.", - "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html", - "handlers": { - "create": { - "permissions": [ - "iot:ListV2LoggingLevels", - "iot:SetV2LoggingLevel" - ] - }, - "delete": { - "permissions": [ - "iot:ListV2LoggingLevels", - "iot:DeleteV2LoggingLevel" - ] - }, - "list": { - "permissions": [ - "iot:ListV2LoggingLevels" - ] - }, - "read": { - "permissions": [ - "iot:ListV2LoggingLevels" - ] - }, - "update": { - "permissions": [ - "iot:ListV2LoggingLevels", - "iot:SetV2LoggingLevel" - ] - } - }, - "primaryIdentifier": [ - "/properties/TargetId" - ], - "properties": { - "LogLevel": { - "description": "The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.", - "enum": [ - "ERROR", - "WARN", - "INFO", - "DEBUG", - "DISABLED" - ], - "type": "string" - }, - "TargetId": { - "description": "Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.", - "maxLength": 140, - "minLength": 13, - "pattern": "[a-zA-Z0-9.:\\s_\\-]+", - "type": "string" - }, - "TargetName": { - "description": "The target name.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9.:\\s_\\-]+", - "type": "string" - }, - "TargetType": { - "description": "The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.", - "enum": [ - "THING_GROUP", - "CLIENT_ID", - "SOURCE_IP", - "PRINCIPAL_ID", - "EVENT_TYPE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TargetId" - ], - "required": [ - "TargetName", - "TargetType", - "LogLevel" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "taggable": false, - "typeName": "AWS::IoT::ResourceSpecificLogging" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetName", + "/properties/TargetType" + ], + "definitions": {}, + "description": "Resource-specific logging allows you to specify a logging level for a specific thing group.", + "documentationUrl": "https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html", + "handlers": { + "create": { + "permissions": [ + "iot:ListV2LoggingLevels", + "iot:SetV2LoggingLevel" + ] + }, + "delete": { + "permissions": [ + "iot:ListV2LoggingLevels", + "iot:DeleteV2LoggingLevel" + ] + }, + "list": { + "permissions": [ + "iot:ListV2LoggingLevels" + ] + }, + "read": { + "permissions": [ + "iot:ListV2LoggingLevels" + ] + }, + "update": { + "permissions": [ + "iot:ListV2LoggingLevels", + "iot:SetV2LoggingLevel" + ] + } + }, + "primaryIdentifier": [ + "/properties/TargetId" + ], + "properties": { + "LogLevel": { + "description": "The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.", + "enum": [ + "ERROR", + "WARN", + "INFO", + "DEBUG", + "DISABLED" + ], + "type": "string" + }, + "TargetId": { + "description": "Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.", + "maxLength": 140, + "minLength": 13, + "pattern": "[a-zA-Z0-9.:\\s_\\-]+", + "type": "string" + }, + "TargetName": { + "description": "The target name.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9.:\\s_\\-]+", + "type": "string" + }, + "TargetType": { + "description": "The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.", + "enum": [ + "THING_GROUP", + "CLIENT_ID", + "SOURCE_IP", + "PRINCIPAL_ID", + "EVENT_TYPE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TargetId" + ], + "required": [ + "TargetName", + "TargetType", + "LogLevel" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "taggable": false, + "typeName": "AWS::IoT::ResourceSpecificLogging" +} diff --git a/schema/aws-iot-rolealias.json b/schema/aws-iot-rolealias.json index 82bd793..c86a8b2 100644 --- a/schema/aws-iot-rolealias.json +++ b/schema/aws-iot-rolealias.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RoleAlias" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Use the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:CreateRoleAlias", - "iot:DescribeRoleAlias", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteRoleAlias", - "iot:DescribeRoleAlias" - ] - }, - "list": { - "permissions": [ - "iot:ListRoleAliases" - ] - }, - "read": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:DescribeRoleAlias", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:PassRole", - "iot:UpdateRoleAlias", - "iot:DescribeRoleAlias", - "iot:TagResource", - "iot:UntagResource", - "iot:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RoleAlias" - ], - "properties": { - "CredentialDurationSeconds": { - "default": 3600, - "maximum": 43200, - "minimum": 900, - "type": "integer" - }, - "RoleAlias": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w=,@-]+", - "type": "string" - }, - "RoleAliasArn": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w=,@-]+", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/RoleAliasArn" - ], - "required": [ - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::RoleAlias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RoleAlias" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Use the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:CreateRoleAlias", + "iot:DescribeRoleAlias", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteRoleAlias", + "iot:DescribeRoleAlias" + ] + }, + "list": { + "permissions": [ + "iot:ListRoleAliases" + ] + }, + "read": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:DescribeRoleAlias", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "iot:UpdateRoleAlias", + "iot:DescribeRoleAlias", + "iot:TagResource", + "iot:UntagResource", + "iot:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RoleAlias" + ], + "properties": { + "CredentialDurationSeconds": { + "default": 3600, + "maximum": 43200, + "minimum": 900, + "type": "integer" + }, + "RoleAlias": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w=,@-]+", + "type": "string" + }, + "RoleAliasArn": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w=,@-]+", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/RoleAliasArn" + ], + "required": [ + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::RoleAlias" +} diff --git a/schema/aws-iot-scheduledaudit.json b/schema/aws-iot-scheduledaudit.json index 161b3a1..739aa62 100644 --- a/schema/aws-iot-scheduledaudit.json +++ b/schema/aws-iot-scheduledaudit.json @@ -1,141 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ScheduledAuditName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Scheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateScheduledAudit", - "iot:DescribeScheduledAudit", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeScheduledAudit", - "iot:DeleteScheduledAudit" - ] - }, - "list": { - "permissions": [ - "iot:ListScheduledAudits" - ] - }, - "read": { - "permissions": [ - "iot:DescribeScheduledAudit", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdateScheduledAudit", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ScheduledAuditName" - ], - "properties": { - "DayOfMonth": { - "description": "The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.", - "pattern": "^([1-9]|[12][0-9]|3[01])$|^LAST$|^UNSET_VALUE$", - "type": "string" - }, - "DayOfWeek": { - "description": "The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.", - "enum": [ - "SUN", - "MON", - "TUE", - "WED", - "THU", - "FRI", - "SAT", - "UNSET_VALUE" - ], - "type": "string" - }, - "Frequency": { - "description": "How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.", - "enum": [ - "DAILY", - "WEEKLY", - "BIWEEKLY", - "MONTHLY" - ], - "type": "string" - }, - "ScheduledAuditArn": { - "description": "The ARN (Amazon resource name) of the scheduled audit.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ScheduledAuditName": { - "description": "The name you want to give to the scheduled audit.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TargetCheckNames": { - "description": "Which checks are performed during the scheduled audit. Checks must be enabled for your account.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ScheduledAuditArn" - ], - "required": [ - "Frequency", - "TargetCheckNames" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "typeName": "AWS::IoT::ScheduledAudit" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ScheduledAuditName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Scheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateScheduledAudit", + "iot:DescribeScheduledAudit", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeScheduledAudit", + "iot:DeleteScheduledAudit" + ] + }, + "list": { + "permissions": [ + "iot:ListScheduledAudits" + ] + }, + "read": { + "permissions": [ + "iot:DescribeScheduledAudit", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdateScheduledAudit", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ScheduledAuditName" + ], + "properties": { + "DayOfMonth": { + "description": "The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.", + "pattern": "^([1-9]|[12][0-9]|3[01])$|^LAST$|^UNSET_VALUE$", + "type": "string" + }, + "DayOfWeek": { + "description": "The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.", + "enum": [ + "SUN", + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "UNSET_VALUE" + ], + "type": "string" + }, + "Frequency": { + "description": "How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.", + "enum": [ + "DAILY", + "WEEKLY", + "BIWEEKLY", + "MONTHLY" + ], + "type": "string" + }, + "ScheduledAuditArn": { + "description": "The ARN (Amazon resource name) of the scheduled audit.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ScheduledAuditName": { + "description": "The name you want to give to the scheduled audit.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TargetCheckNames": { + "description": "Which checks are performed during the scheduled audit. Checks must be enabled for your account.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ScheduledAuditArn" + ], + "required": [ + "Frequency", + "TargetCheckNames" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "typeName": "AWS::IoT::ScheduledAudit" +} diff --git a/schema/aws-iot-securityprofile.json b/schema/aws-iot-securityprofile.json index 2fc7b48..f19babd 100644 --- a/schema/aws-iot-securityprofile.json +++ b/schema/aws-iot-securityprofile.json @@ -1,427 +1,427 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SecurityProfileName" - ], - "definitions": { - "AlertTarget": { - "additionalProperties": false, - "description": "A structure containing the alert target ARN and the role ARN.", - "properties": { - "AlertTargetArn": { - "description": "The ARN of the notification target to which alerts are sent.", - "maxLength": 2048, - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to send alerts to the notification target.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "AlertTargetArn", - "RoleArn" - ], - "type": "object" - }, - "Behavior": { - "additionalProperties": false, - "description": "A security profile behavior.", - "properties": { - "Criteria": { - "$ref": "#/definitions/BehaviorCriteria" - }, - "ExportMetric": { - "$ref": "#/definitions/ExportMetric" - }, - "Metric": { - "description": "What is measured by the behavior.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "MetricDimension": { - "$ref": "#/definitions/MetricDimension" - }, - "Name": { - "description": "The name for the behavior.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "SuppressAlerts": { - "description": "Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.", - "type": "boolean" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "BehaviorCriteria": { - "additionalProperties": false, - "description": "The criteria by which the behavior is determined to be normal.", - "properties": { - "ComparisonOperator": { - "description": "The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).", - "enum": [ - "less-than", - "less-than-equals", - "greater-than", - "greater-than-equals", - "in-cidr-set", - "not-in-cidr-set", - "in-port-set", - "not-in-port-set", - "in-set", - "not-in-set" - ], - "type": "string" - }, - "ConsecutiveDatapointsToAlarm": { - "description": "If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.", - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "ConsecutiveDatapointsToClear": { - "description": "If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.", - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "DurationSeconds": { - "description": "Use this to specify the time duration over which the behavior is evaluated.", - "type": "integer" - }, - "MlDetectionConfig": { - "$ref": "#/definitions/MachineLearningDetectionConfig" - }, - "StatisticalThreshold": { - "$ref": "#/definitions/StatisticalThreshold" - }, - "Value": { - "$ref": "#/definitions/MetricValue" - } - }, - "type": "object" - }, - "ExportMetric": { - "description": "Flag to enable/disable metrics export for metric to be retained.", - "type": "boolean" - }, - "MachineLearningDetectionConfig": { - "additionalProperties": false, - "description": "The configuration of an ML Detect Security Profile.", - "properties": { - "ConfidenceLevel": { - "description": "The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "type": "object" - }, - "MetricDimension": { - "additionalProperties": false, - "description": "The dimension of a metric.", - "properties": { - "DimensionName": { - "description": "A unique identifier for the dimension.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "Operator": { - "description": "Defines how the dimensionValues of a dimension are interpreted.", - "enum": [ - "IN", - "NOT_IN" - ], - "type": "string" - } - }, - "required": [ - "DimensionName" - ], - "type": "object" - }, - "MetricToRetain": { - "additionalProperties": false, - "description": "The metric you want to retain. Dimensions are optional.", - "properties": { - "ExportMetric": { - "$ref": "#/definitions/ExportMetric" - }, - "Metric": { - "description": "What is measured by the behavior.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "MetricDimension": { - "$ref": "#/definitions/MetricDimension" - } - }, - "required": [ - "Metric" - ], - "type": "object" - }, - "MetricValue": { - "additionalProperties": false, - "description": "The value to be compared with the metric.", - "properties": { - "Cidrs": { - "description": "If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Count": { - "description": "If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.", - "minimum": 0, - "type": "string" - }, - "Number": { - "description": "The numeral value of a metric.", - "type": "number" - }, - "Numbers": { - "description": "The numeral values of a metric.", - "insertionOrder": false, - "items": { - "type": "number" - }, - "type": "array", - "uniqueItems": true - }, - "Ports": { - "description": "If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.", - "insertionOrder": false, - "items": { - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "type": "array", - "uniqueItems": true - }, - "Strings": { - "description": "The string values of a metric.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "StatisticalThreshold": { - "additionalProperties": false, - "description": "A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.", - "properties": { - "Statistic": { - "description": "The percentile which resolves to a threshold value by which compliance with a behavior is determined", - "enum": [ - "Average", - "p0", - "p0.1", - "p0.01", - "p1", - "p10", - "p50", - "p90", - "p99", - "p99.9", - "p99.99", - "p100" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "A security profile defines a set of expected behaviors for devices in your account.", - "handlers": { - "create": { - "permissions": [ - "iot:CreateSecurityProfile", - "iot:AttachSecurityProfile", - "iot:DescribeSecurityProfile", - "iot:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeSecurityProfile", - "iot:DeleteSecurityProfile" - ] - }, - "list": { - "permissions": [ - "iot:ListSecurityProfiles" - ] - }, - "read": { - "permissions": [ - "iot:DescribeSecurityProfile", - "iot:ListTagsForResource", - "iot:ListTargetsForSecurityProfile" - ] - }, - "update": { - "permissions": [ - "iot:UpdateSecurityProfile", - "iot:ListTargetsForSecurityProfile", - "iot:AttachSecurityProfile", - "iot:DetachSecurityProfile", - "iot:ListTagsForResource", - "iot:UntagResource", - "iot:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/SecurityProfileName" - ], - "properties": { - "AdditionalMetricsToRetainV2": { - "description": "A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricToRetain" - }, - "type": "array", - "uniqueItems": true - }, - "AlertTargets": { - "additionalProperties": false, - "description": "Specifies the destinations to which alerts are sent.", - "patternProperties": { - "[a-zA-Z0-9:_-]+": { - "$ref": "#/definitions/AlertTarget" - } - }, - "type": "object" - }, - "Behaviors": { - "description": "Specifies the behaviors that, when violated by a device (thing), cause an alert.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Behavior" - }, - "maxLength": 100, - "type": "array", - "uniqueItems": true - }, - "MetricsExportConfig": { - "additionalProperties": false, - "description": "A structure containing the mqtt topic for metrics export.", - "properties": { - "MqttTopic": { - "description": "The topic for metrics export.", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to publish to mqtt topic.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "MqttTopic", - "RoleArn" - ], - "type": "object" - }, - "SecurityProfileArn": { - "description": "The ARN (Amazon resource name) of the created security profile.", - "type": "string" - }, - "SecurityProfileDescription": { - "description": "A description of the security profile.", - "maxLength": 1000, - "type": "string" - }, - "SecurityProfileName": { - "description": "A unique identifier for the security profile.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "Tags": { - "description": "Metadata that can be used to manage the security profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TargetArns": { - "description": "A set of target ARNs that the security profile is attached to.", - "insertionOrder": false, - "items": { - "description": "The ARN of the target to which the security profile is attached.", - "maxLength": 2048, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/SecurityProfileArn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", - "typeName": "AWS::IoT::SecurityProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SecurityProfileName" + ], + "definitions": { + "AlertTarget": { + "additionalProperties": false, + "description": "A structure containing the alert target ARN and the role ARN.", + "properties": { + "AlertTargetArn": { + "description": "The ARN of the notification target to which alerts are sent.", + "maxLength": 2048, + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to send alerts to the notification target.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "AlertTargetArn", + "RoleArn" + ], + "type": "object" + }, + "Behavior": { + "additionalProperties": false, + "description": "A security profile behavior.", + "properties": { + "Criteria": { + "$ref": "#/definitions/BehaviorCriteria" + }, + "ExportMetric": { + "$ref": "#/definitions/ExportMetric" + }, + "Metric": { + "description": "What is measured by the behavior.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "MetricDimension": { + "$ref": "#/definitions/MetricDimension" + }, + "Name": { + "description": "The name for the behavior.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "SuppressAlerts": { + "description": "Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.", + "type": "boolean" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "BehaviorCriteria": { + "additionalProperties": false, + "description": "The criteria by which the behavior is determined to be normal.", + "properties": { + "ComparisonOperator": { + "description": "The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).", + "enum": [ + "less-than", + "less-than-equals", + "greater-than", + "greater-than-equals", + "in-cidr-set", + "not-in-cidr-set", + "in-port-set", + "not-in-port-set", + "in-set", + "not-in-set" + ], + "type": "string" + }, + "ConsecutiveDatapointsToAlarm": { + "description": "If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "ConsecutiveDatapointsToClear": { + "description": "If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "DurationSeconds": { + "description": "Use this to specify the time duration over which the behavior is evaluated.", + "type": "integer" + }, + "MlDetectionConfig": { + "$ref": "#/definitions/MachineLearningDetectionConfig" + }, + "StatisticalThreshold": { + "$ref": "#/definitions/StatisticalThreshold" + }, + "Value": { + "$ref": "#/definitions/MetricValue" + } + }, + "type": "object" + }, + "ExportMetric": { + "description": "Flag to enable/disable metrics export for metric to be retained.", + "type": "boolean" + }, + "MachineLearningDetectionConfig": { + "additionalProperties": false, + "description": "The configuration of an ML Detect Security Profile.", + "properties": { + "ConfidenceLevel": { + "description": "The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + } + }, + "type": "object" + }, + "MetricDimension": { + "additionalProperties": false, + "description": "The dimension of a metric.", + "properties": { + "DimensionName": { + "description": "A unique identifier for the dimension.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "Operator": { + "description": "Defines how the dimensionValues of a dimension are interpreted.", + "enum": [ + "IN", + "NOT_IN" + ], + "type": "string" + } + }, + "required": [ + "DimensionName" + ], + "type": "object" + }, + "MetricToRetain": { + "additionalProperties": false, + "description": "The metric you want to retain. Dimensions are optional.", + "properties": { + "ExportMetric": { + "$ref": "#/definitions/ExportMetric" + }, + "Metric": { + "description": "What is measured by the behavior.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "MetricDimension": { + "$ref": "#/definitions/MetricDimension" + } + }, + "required": [ + "Metric" + ], + "type": "object" + }, + "MetricValue": { + "additionalProperties": false, + "description": "The value to be compared with the metric.", + "properties": { + "Cidrs": { + "description": "If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Count": { + "description": "If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.", + "minimum": 0, + "type": "string" + }, + "Number": { + "description": "The numeral value of a metric.", + "type": "number" + }, + "Numbers": { + "description": "The numeral values of a metric.", + "insertionOrder": false, + "items": { + "type": "number" + }, + "type": "array", + "uniqueItems": true + }, + "Ports": { + "description": "If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.", + "insertionOrder": false, + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "type": "array", + "uniqueItems": true + }, + "Strings": { + "description": "The string values of a metric.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "StatisticalThreshold": { + "additionalProperties": false, + "description": "A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.", + "properties": { + "Statistic": { + "description": "The percentile which resolves to a threshold value by which compliance with a behavior is determined", + "enum": [ + "Average", + "p0", + "p0.1", + "p0.01", + "p1", + "p10", + "p50", + "p90", + "p99", + "p99.9", + "p99.99", + "p100" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "A security profile defines a set of expected behaviors for devices in your account.", + "handlers": { + "create": { + "permissions": [ + "iot:CreateSecurityProfile", + "iot:AttachSecurityProfile", + "iot:DescribeSecurityProfile", + "iot:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeSecurityProfile", + "iot:DeleteSecurityProfile" + ] + }, + "list": { + "permissions": [ + "iot:ListSecurityProfiles" + ] + }, + "read": { + "permissions": [ + "iot:DescribeSecurityProfile", + "iot:ListTagsForResource", + "iot:ListTargetsForSecurityProfile" + ] + }, + "update": { + "permissions": [ + "iot:UpdateSecurityProfile", + "iot:ListTargetsForSecurityProfile", + "iot:AttachSecurityProfile", + "iot:DetachSecurityProfile", + "iot:ListTagsForResource", + "iot:UntagResource", + "iot:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/SecurityProfileName" + ], + "properties": { + "AdditionalMetricsToRetainV2": { + "description": "A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricToRetain" + }, + "type": "array", + "uniqueItems": true + }, + "AlertTargets": { + "additionalProperties": false, + "description": "Specifies the destinations to which alerts are sent.", + "patternProperties": { + "[a-zA-Z0-9:_-]+": { + "$ref": "#/definitions/AlertTarget" + } + }, + "type": "object" + }, + "Behaviors": { + "description": "Specifies the behaviors that, when violated by a device (thing), cause an alert.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Behavior" + }, + "maxLength": 100, + "type": "array", + "uniqueItems": true + }, + "MetricsExportConfig": { + "additionalProperties": false, + "description": "A structure containing the mqtt topic for metrics export.", + "properties": { + "MqttTopic": { + "description": "The topic for metrics export.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to publish to mqtt topic.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "MqttTopic", + "RoleArn" + ], + "type": "object" + }, + "SecurityProfileArn": { + "description": "The ARN (Amazon resource name) of the created security profile.", + "type": "string" + }, + "SecurityProfileDescription": { + "description": "A description of the security profile.", + "maxLength": 1000, + "type": "string" + }, + "SecurityProfileName": { + "description": "A unique identifier for the security profile.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "Tags": { + "description": "Metadata that can be used to manage the security profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TargetArns": { + "description": "A set of target ARNs that the security profile is attached to.", + "insertionOrder": false, + "items": { + "description": "The ARN of the target to which the security profile is attached.", + "maxLength": 2048, + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/SecurityProfileArn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git", + "typeName": "AWS::IoT::SecurityProfile" +} diff --git a/schema/aws-iot-softwarepackage.json b/schema/aws-iot-softwarepackage.json index 3a69777..e897cb4 100644 --- a/schema/aws-iot-softwarepackage.json +++ b/schema/aws-iot-softwarepackage.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PackageName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "resource definition", - "handlers": { - "create": { - "permissions": [ - "iot:CreatePackage", - "iot:GetPackage", - "iot:TagResource", - "iot:GetIndexingConfiguration" - ] - }, - "delete": { - "permissions": [ - "iot:DeletePackage", - "iot:DeletePackageVersion", - "iot:GetPackage", - "iot:GetPackageVersion", - "iot:UpdatePackage", - "iot:UpdatePackageVersion", - "iot:GetIndexingConfiguration", - "iot:ListPackageVersions" - ] - }, - "list": { - "permissions": [ - "iot:ListPackages" - ] - }, - "read": { - "permissions": [ - "iot:GetPackage", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:CreatePackage", - "iot:UpdatePackage", - "iot:GetPackage", - "iot:ListTagsForResource", - "iot:TagResource", - "iot:UntagResource", - "iot:GetIndexingConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/PackageName" - ], - "properties": { - "Description": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[^\\p{C}]+$", - "type": "string" - }, - "PackageArn": { - "type": "string" - }, - "PackageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_.]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/PackageArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::SoftwarePackage" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PackageName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "resource definition", + "handlers": { + "create": { + "permissions": [ + "iot:CreatePackage", + "iot:GetPackage", + "iot:TagResource", + "iot:GetIndexingConfiguration" + ] + }, + "delete": { + "permissions": [ + "iot:DeletePackage", + "iot:DeletePackageVersion", + "iot:GetPackage", + "iot:GetPackageVersion", + "iot:UpdatePackage", + "iot:UpdatePackageVersion", + "iot:GetIndexingConfiguration", + "iot:ListPackageVersions" + ] + }, + "list": { + "permissions": [ + "iot:ListPackages" + ] + }, + "read": { + "permissions": [ + "iot:GetPackage", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:CreatePackage", + "iot:UpdatePackage", + "iot:GetPackage", + "iot:ListTagsForResource", + "iot:TagResource", + "iot:UntagResource", + "iot:GetIndexingConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/PackageName" + ], + "properties": { + "Description": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\p{C}]+$", + "type": "string" + }, + "PackageArn": { + "type": "string" + }, + "PackageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_.]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/PackageArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::SoftwarePackage" +} diff --git a/schema/aws-iot-softwarepackageversion.json b/schema/aws-iot-softwarepackageversion.json index dc40c29..eb17ac8 100644 --- a/schema/aws-iot-softwarepackageversion.json +++ b/schema/aws-iot-softwarepackageversion.json @@ -1,154 +1,154 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PackageName", - "/properties/VersionName" - ], - "definitions": { - "PackageVersionStatus": { - "enum": [ - "DRAFT", - "PUBLISHED", - "DEPRECATED" - ], - "type": "string" - }, - "ResourceAttributes": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9:_-]+$": { - "minLength": 1, - "pattern": "^[^\\p{C}]+$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "resource definition", - "handlers": { - "create": { - "permissions": [ - "iot:CreatePackageVersion", - "iot:GetPackageVersion", - "iot:TagResource", - "iot:GetIndexingConfiguration" - ] - }, - "delete": { - "permissions": [ - "iot:DeletePackageVersion", - "iot:UpdatePackageVersion", - "iot:GetPackageVersion", - "iot:GetIndexingConfiguration" - ] - }, - "list": { - "permissions": [ - "iot:ListPackageVersions" - ] - }, - "read": { - "permissions": [ - "iot:GetPackageVersion", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:UpdatePackageVersion", - "iot:GetPackageVersion", - "iot:ListTagsForResource", - "iot:TagResource", - "iot:UntagResource", - "iot:GetIndexingConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/PackageName", - "/properties/VersionName" - ], - "properties": { - "Attributes": { - "$ref": "#/definitions/ResourceAttributes" - }, - "Description": { - "maxLength": 1024, - "minLength": 0, - "pattern": "^[^\\p{C}]+$", - "type": "string" - }, - "ErrorReason": { - "type": "string" - }, - "PackageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_.]+$", - "type": "string" - }, - "PackageVersionArn": { - "type": "string" - }, - "Status": { - "$ref": "#/definitions/PackageVersionStatus" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "VersionName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_.]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ErrorReason", - "/properties/PackageVersionArn", - "/properties/Status" - ], - "required": [ - "PackageName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::SoftwarePackageVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PackageName", + "/properties/VersionName" + ], + "definitions": { + "PackageVersionStatus": { + "enum": [ + "DRAFT", + "PUBLISHED", + "DEPRECATED" + ], + "type": "string" + }, + "ResourceAttributes": { + "additionalProperties": false, + "patternProperties": { + "^[a-zA-Z0-9:_-]+$": { + "minLength": 1, + "pattern": "^[^\\p{C}]+$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "resource definition", + "handlers": { + "create": { + "permissions": [ + "iot:CreatePackageVersion", + "iot:GetPackageVersion", + "iot:TagResource", + "iot:GetIndexingConfiguration" + ] + }, + "delete": { + "permissions": [ + "iot:DeletePackageVersion", + "iot:UpdatePackageVersion", + "iot:GetPackageVersion", + "iot:GetIndexingConfiguration" + ] + }, + "list": { + "permissions": [ + "iot:ListPackageVersions" + ] + }, + "read": { + "permissions": [ + "iot:GetPackageVersion", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:UpdatePackageVersion", + "iot:GetPackageVersion", + "iot:ListTagsForResource", + "iot:TagResource", + "iot:UntagResource", + "iot:GetIndexingConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/PackageName", + "/properties/VersionName" + ], + "properties": { + "Attributes": { + "$ref": "#/definitions/ResourceAttributes" + }, + "Description": { + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\p{C}]+$", + "type": "string" + }, + "ErrorReason": { + "type": "string" + }, + "PackageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_.]+$", + "type": "string" + }, + "PackageVersionArn": { + "type": "string" + }, + "Status": { + "$ref": "#/definitions/PackageVersionStatus" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VersionName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_.]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ErrorReason", + "/properties/PackageVersionArn", + "/properties/Status" + ], + "required": [ + "PackageName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::SoftwarePackageVersion" +} diff --git a/schema/aws-iot-thing.json b/schema/aws-iot-thing.json index 26745c1..3470660 100644 --- a/schema/aws-iot-thing.json +++ b/schema/aws-iot-thing.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ThingName" - ], - "definitions": { - "AttributePayload": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9_.,@/:#-]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::Thing", - "handlers": { - "create": { - "permissions": [ - "iot:CreateThing", - "iot:DescribeThing" - ] - }, - "delete": { - "permissions": [ - "iot:DeleteThing", - "iot:DescribeThing" - ] - }, - "list": { - "permissions": [ - "iot:ListThings" - ] - }, - "read": { - "permissions": [ - "iot:DescribeThing" - ] - }, - "update": { - "permissions": [ - "iot:UpdateThing", - "iot:DescribeThing" - ] - } - }, - "primaryIdentifier": [ - "/properties/ThingName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AttributePayload": { - "$ref": "#/definitions/AttributePayload" - }, - "Id": { - "type": "string" - }, - "ThingName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IoT::Thing" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ThingName" + ], + "definitions": { + "AttributePayload": { + "additionalProperties": false, + "properties": { + "Attributes": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9_.,@/:#-]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::Thing", + "handlers": { + "create": { + "permissions": [ + "iot:CreateThing", + "iot:DescribeThing" + ] + }, + "delete": { + "permissions": [ + "iot:DeleteThing", + "iot:DescribeThing" + ] + }, + "list": { + "permissions": [ + "iot:ListThings" + ] + }, + "read": { + "permissions": [ + "iot:DescribeThing" + ] + }, + "update": { + "permissions": [ + "iot:UpdateThing", + "iot:DescribeThing" + ] + } + }, + "primaryIdentifier": [ + "/properties/ThingName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AttributePayload": { + "$ref": "#/definitions/AttributePayload" + }, + "Id": { + "type": "string" + }, + "ThingName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IoT::Thing" +} diff --git a/schema/aws-iot-thinggroup.json b/schema/aws-iot-thinggroup.json index 5d1b609..f6ffd96 100644 --- a/schema/aws-iot-thinggroup.json +++ b/schema/aws-iot-thinggroup.json @@ -1,153 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ThingGroupName", - "/properties/ParentGroupName" - ], - "definitions": { - "AttributePayload": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9_.,@/:#-]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::ThingGroup", - "handlers": { - "create": { - "permissions": [ - "iot:DescribeThingGroup", - "iot:ListTagsForResource", - "iot:CreateThingGroup", - "iot:CreateDynamicThingGroup", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeThingGroup", - "iot:DeleteThingGroup", - "iot:DeleteDynamicThingGroup" - ] - }, - "list": { - "permissions": [ - "iot:ListThingGroups", - "iot:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iot:DescribeThingGroup", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:ListTagsForResource", - "iot:DescribeThingGroup", - "iot:UpdateThingGroup", - "iot:UpdateDynamicThingGroup", - "iot:TagResource", - "iot:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ThingGroupName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ParentGroupName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "QueryString": { - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "ThingGroupName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "ThingGroupProperties": { - "additionalProperties": false, - "properties": { - "AttributePayload": { - "$ref": "#/definitions/AttributePayload" - }, - "ThingGroupDescription": { - "maxLength": 2028, - "pattern": "[\\p{Graph}\\x20]*", - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::ThingGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ThingGroupName", + "/properties/ParentGroupName" + ], + "definitions": { + "AttributePayload": { + "additionalProperties": false, + "properties": { + "Attributes": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9_.,@/:#-]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::ThingGroup", + "handlers": { + "create": { + "permissions": [ + "iot:DescribeThingGroup", + "iot:ListTagsForResource", + "iot:CreateThingGroup", + "iot:CreateDynamicThingGroup", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeThingGroup", + "iot:DeleteThingGroup", + "iot:DeleteDynamicThingGroup" + ] + }, + "list": { + "permissions": [ + "iot:ListThingGroups", + "iot:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iot:DescribeThingGroup", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:ListTagsForResource", + "iot:DescribeThingGroup", + "iot:UpdateThingGroup", + "iot:UpdateDynamicThingGroup", + "iot:TagResource", + "iot:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ThingGroupName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ParentGroupName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "QueryString": { + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "ThingGroupName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "ThingGroupProperties": { + "additionalProperties": false, + "properties": { + "AttributePayload": { + "$ref": "#/definitions/AttributePayload" + }, + "ThingGroupDescription": { + "maxLength": 2028, + "pattern": "[\\p{Graph}\\x20]*", + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::ThingGroup" +} diff --git a/schema/aws-iot-thingprincipalattachment.json b/schema/aws-iot-thingprincipalattachment.json index 3447379..bbecd56 100644 --- a/schema/aws-iot-thingprincipalattachment.json +++ b/schema/aws-iot-thingprincipalattachment.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ThingName", - "/properties/Principal" - ], - "description": "Resource Type definition for AWS::IoT::ThingPrincipalAttachment", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "ThingName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Principal", - "ThingName" - ], - "typeName": "AWS::IoT::ThingPrincipalAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ThingName", + "/properties/Principal" + ], + "description": "Resource Type definition for AWS::IoT::ThingPrincipalAttachment", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Principal": { + "type": "string" + }, + "ThingName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Principal", + "ThingName" + ], + "typeName": "AWS::IoT::ThingPrincipalAttachment" +} diff --git a/schema/aws-iot-thingtype.json b/schema/aws-iot-thingtype.json index 58a0edf..dab147f 100644 --- a/schema/aws-iot-thingtype.json +++ b/schema/aws-iot-thingtype.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ThingTypeName", - "/properties/ThingTypeProperties" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::ThingType", - "handlers": { - "create": { - "permissions": [ - "iot:DescribeThingType", - "iot:ListTagsForResource", - "iot:CreateThingType", - "iot:DeprecateThingType", - "iot:TagResource" - ] - }, - "delete": { - "permissions": [ - "iot:DescribeThingType", - "iot:DeleteThingType", - "iot:DeprecateThingType" - ] - }, - "list": { - "permissions": [ - "iot:ListThingTypes", - "iot:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iot:DescribeThingType", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iot:DescribeThingType", - "iot:UpdateThingType", - "iot:ListTagsForResource", - "iot:TagResource", - "iot:UntagResource", - "iot:DeprecateThingType" - ] - } - }, - "primaryIdentifier": [ - "/properties/ThingTypeName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DeprecateThingType": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "ThingTypeName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "ThingTypeProperties": { - "additionalProperties": false, - "properties": { - "SearchableAttributes": { - "insertionOrder": true, - "items": { - "maxLength": 128, - "pattern": "[a-zA-Z0-9_.,@/:#-]+", - "type": "string" - }, - "maxItems": 3, - "type": "array", - "uniqueItems": true - }, - "ThingTypeDescription": { - "maxLength": 2028, - "pattern": "[\\p{Graph}\\x20]*", - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::ThingType" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ThingTypeName", + "/properties/ThingTypeProperties" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::ThingType", + "handlers": { + "create": { + "permissions": [ + "iot:DescribeThingType", + "iot:ListTagsForResource", + "iot:CreateThingType", + "iot:DeprecateThingType", + "iot:TagResource" + ] + }, + "delete": { + "permissions": [ + "iot:DescribeThingType", + "iot:DeleteThingType", + "iot:DeprecateThingType" + ] + }, + "list": { + "permissions": [ + "iot:ListThingTypes", + "iot:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iot:DescribeThingType", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iot:DescribeThingType", + "iot:UpdateThingType", + "iot:ListTagsForResource", + "iot:TagResource", + "iot:UntagResource", + "iot:DeprecateThingType" + ] + } + }, + "primaryIdentifier": [ + "/properties/ThingTypeName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DeprecateThingType": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "ThingTypeName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "ThingTypeProperties": { + "additionalProperties": false, + "properties": { + "SearchableAttributes": { + "insertionOrder": true, + "items": { + "maxLength": 128, + "pattern": "[a-zA-Z0-9_.,@/:#-]+", + "type": "string" + }, + "maxItems": 3, + "type": "array", + "uniqueItems": true + }, + "ThingTypeDescription": { + "maxLength": 2028, + "pattern": "[\\p{Graph}\\x20]*", + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::ThingType" +} diff --git a/schema/aws-iot-topicrule.json b/schema/aws-iot-topicrule.json index fb07f70..238df78 100644 --- a/schema/aws-iot-topicrule.json +++ b/schema/aws-iot-topicrule.json @@ -1,1005 +1,1005 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RuleName" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "CloudwatchAlarm": { - "$ref": "#/definitions/CloudwatchAlarmAction" - }, - "CloudwatchLogs": { - "$ref": "#/definitions/CloudwatchLogsAction" - }, - "CloudwatchMetric": { - "$ref": "#/definitions/CloudwatchMetricAction" - }, - "DynamoDB": { - "$ref": "#/definitions/DynamoDBAction" - }, - "DynamoDBv2": { - "$ref": "#/definitions/DynamoDBv2Action" - }, - "Elasticsearch": { - "$ref": "#/definitions/ElasticsearchAction" - }, - "Firehose": { - "$ref": "#/definitions/FirehoseAction" - }, - "Http": { - "$ref": "#/definitions/HttpAction" - }, - "IotAnalytics": { - "$ref": "#/definitions/IotAnalyticsAction" - }, - "IotEvents": { - "$ref": "#/definitions/IotEventsAction" - }, - "IotSiteWise": { - "$ref": "#/definitions/IotSiteWiseAction" - }, - "Kafka": { - "$ref": "#/definitions/KafkaAction" - }, - "Kinesis": { - "$ref": "#/definitions/KinesisAction" - }, - "Lambda": { - "$ref": "#/definitions/LambdaAction" - }, - "Location": { - "$ref": "#/definitions/LocationAction" - }, - "OpenSearch": { - "$ref": "#/definitions/OpenSearchAction" - }, - "Republish": { - "$ref": "#/definitions/RepublishAction" - }, - "S3": { - "$ref": "#/definitions/S3Action" - }, - "Sns": { - "$ref": "#/definitions/SnsAction" - }, - "Sqs": { - "$ref": "#/definitions/SqsAction" - }, - "StepFunctions": { - "$ref": "#/definitions/StepFunctionsAction" - }, - "Timestream": { - "$ref": "#/definitions/TimestreamAction" - } - }, - "type": "object" - }, - "AssetPropertyTimestamp": { - "additionalProperties": false, - "properties": { - "OffsetInNanos": { - "type": "string" - }, - "TimeInSeconds": { - "type": "string" - } - }, - "required": [ - "TimeInSeconds" - ], - "type": "object" - }, - "AssetPropertyValue": { - "additionalProperties": false, - "properties": { - "Quality": { - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/AssetPropertyTimestamp" - }, - "Value": { - "$ref": "#/definitions/AssetPropertyVariant" - } - }, - "required": [ - "Value", - "Timestamp" - ], - "type": "object" - }, - "AssetPropertyVariant": { - "additionalProperties": false, - "properties": { - "BooleanValue": { - "type": "string" - }, - "DoubleValue": { - "type": "string" - }, - "IntegerValue": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "type": "object" - }, - "CannedAccessControlList": { - "enum": [ - "private", - "public-read", - "public-read-write", - "aws-exec-read", - "authenticated-read", - "bucket-owner-read", - "bucket-owner-full-control", - "log-delivery-write" - ], - "type": "string" - }, - "CloudwatchAlarmAction": { - "additionalProperties": false, - "properties": { - "AlarmName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StateReason": { - "type": "string" - }, - "StateValue": { - "type": "string" - } - }, - "required": [ - "AlarmName", - "StateReason", - "StateValue", - "RoleArn" - ], - "type": "object" - }, - "CloudwatchLogsAction": { - "additionalProperties": false, - "properties": { - "BatchMode": { - "type": "boolean" - }, - "LogGroupName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "LogGroupName", - "RoleArn" - ], - "type": "object" - }, - "CloudwatchMetricAction": { - "additionalProperties": false, - "properties": { - "MetricName": { - "type": "string" - }, - "MetricNamespace": { - "type": "string" - }, - "MetricTimestamp": { - "type": "string" - }, - "MetricUnit": { - "type": "string" - }, - "MetricValue": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "MetricName", - "MetricValue", - "MetricNamespace", - "MetricUnit", - "RoleArn" - ], - "type": "object" - }, - "DynamoDBAction": { - "additionalProperties": false, - "properties": { - "HashKeyField": { - "type": "string" - }, - "HashKeyType": { - "type": "string" - }, - "HashKeyValue": { - "type": "string" - }, - "PayloadField": { - "type": "string" - }, - "RangeKeyField": { - "type": "string" - }, - "RangeKeyType": { - "type": "string" - }, - "RangeKeyValue": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "TableName", - "HashKeyField", - "HashKeyValue", - "RoleArn" - ], - "type": "object" - }, - "DynamoDBv2Action": { - "additionalProperties": false, - "properties": { - "PutItem": { - "$ref": "#/definitions/PutItemInput" - }, - "RoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "ElasticsearchAction": { - "additionalProperties": false, - "properties": { - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Index": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Endpoint", - "Index", - "Id", - "RoleArn" - ], - "type": "object" - }, - "FirehoseAction": { - "additionalProperties": false, - "properties": { - "BatchMode": { - "type": "boolean" - }, - "DeliveryStreamName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Separator": { - "type": "string" - } - }, - "required": [ - "DeliveryStreamName", - "RoleArn" - ], - "type": "object" - }, - "HttpAction": { - "additionalProperties": false, - "properties": { - "Auth": { - "$ref": "#/definitions/HttpAuthorization" - }, - "ConfirmationUrl": { - "type": "string" - }, - "Headers": { - "items": { - "$ref": "#/definitions/HttpActionHeader" - }, - "type": "array", - "uniqueItems": true - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Url" - ], - "type": "object" - }, - "HttpActionHeader": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "HttpAuthorization": { - "additionalProperties": false, - "properties": { - "Sigv4": { - "$ref": "#/definitions/SigV4Authorization" - } - }, - "type": "object" - }, - "IotAnalyticsAction": { - "additionalProperties": false, - "properties": { - "BatchMode": { - "type": "boolean" - }, - "ChannelName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "ChannelName", - "RoleArn" - ], - "type": "object" - }, - "IotEventsAction": { - "additionalProperties": false, - "properties": { - "BatchMode": { - "type": "boolean" - }, - "InputName": { - "type": "string" - }, - "MessageId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "InputName", - "RoleArn" - ], - "type": "object" - }, - "IotSiteWiseAction": { - "additionalProperties": false, - "properties": { - "PutAssetPropertyValueEntries": { - "items": { - "$ref": "#/definitions/PutAssetPropertyValueEntry" - }, - "type": "array", - "uniqueItems": true - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "PutAssetPropertyValueEntries", - "RoleArn" - ], - "type": "object" - }, - "KafkaAction": { - "additionalProperties": false, - "properties": { - "ClientProperties": { - "additionalProperties": false, - "minProperties": 1, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "DestinationArn": { - "type": "string" - }, - "Headers": { - "items": { - "$ref": "#/definitions/KafkaActionHeader" - }, - "type": "array", - "uniqueItems": true - }, - "Key": { - "type": "string" - }, - "Partition": { - "type": "string" - }, - "Topic": { - "type": "string" - } - }, - "required": [ - "DestinationArn", - "Topic", - "ClientProperties" - ], - "type": "object" - }, - "KafkaActionHeader": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "KinesisAction": { - "additionalProperties": false, - "properties": { - "PartitionKey": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StreamName": { - "type": "string" - } - }, - "required": [ - "StreamName", - "RoleArn" - ], - "type": "object" - }, - "LambdaAction": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - } - }, - "type": "object" - }, - "LocationAction": { - "additionalProperties": false, - "properties": { - "DeviceId": { - "type": "string" - }, - "Latitude": { - "type": "string" - }, - "Longitude": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/Timestamp" - }, - "TrackerName": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "TrackerName", - "DeviceId", - "Latitude", - "Longitude" - ], - "type": "object" - }, - "OpenSearchAction": { - "additionalProperties": false, - "properties": { - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Index": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Endpoint", - "Index", - "Id", - "RoleArn" - ], - "type": "object" - }, - "PutAssetPropertyValueEntry": { - "additionalProperties": false, - "properties": { - "AssetId": { - "type": "string" - }, - "EntryId": { - "type": "string" - }, - "PropertyAlias": { - "type": "string" - }, - "PropertyId": { - "type": "string" - }, - "PropertyValues": { - "items": { - "$ref": "#/definitions/AssetPropertyValue" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "PropertyValues" - ], - "type": "object" - }, - "PutItemInput": { - "additionalProperties": false, - "properties": { - "TableName": { - "type": "string" - } - }, - "required": [ - "TableName" - ], - "type": "object" - }, - "RepublishAction": { - "additionalProperties": false, - "properties": { - "Headers": { - "$ref": "#/definitions/RepublishActionHeaders" - }, - "Qos": { - "type": "integer" - }, - "RoleArn": { - "type": "string" - }, - "Topic": { - "type": "string" - } - }, - "required": [ - "Topic", - "RoleArn" - ], - "type": "object" - }, - "RepublishActionHeaders": { - "additionalProperties": false, - "properties": { - "ContentType": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "CorrelationData": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "MessageExpiry": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "PayloadFormatIndicator": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ResponseTopic": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "UserProperties": { - "$ref": "#/definitions/UserProperties" - } - }, - "type": "object" - }, - "RoleArn": { - "type": "string" - }, - "S3Action": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "CannedAcl": { - "$ref": "#/definitions/CannedAccessControlList" - }, - "Key": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "BucketName", - "Key", - "RoleArn" - ], - "type": "object" - }, - "SigV4Authorization": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "ServiceName": { - "type": "string" - }, - "SigningRegion": { - "type": "string" - } - }, - "required": [ - "ServiceName", - "SigningRegion", - "RoleArn" - ], - "type": "object" - }, - "SnsAction": { - "additionalProperties": false, - "properties": { - "MessageFormat": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "required": [ - "TargetArn", - "RoleArn" - ], - "type": "object" - }, - "SqsAction": { - "additionalProperties": false, - "properties": { - "QueueUrl": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UseBase64": { - "type": "boolean" - } - }, - "required": [ - "RoleArn", - "QueueUrl" - ], - "type": "object" - }, - "StepFunctionsAction": { - "additionalProperties": false, - "properties": { - "ExecutionNamePrefix": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StateMachineName": { - "type": "string" - } - }, - "required": [ - "StateMachineName", - "RoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Timestamp": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "TimestreamAction": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "Dimensions": { - "$ref": "#/definitions/TimestreamDimensionsList" - }, - "RoleArn": { - "type": "string" - }, - "TableName": { - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/TimestreamTimestamp" - } - }, - "required": [ - "RoleArn", - "DatabaseName", - "TableName", - "Dimensions" - ], - "type": "object" - }, - "TimestreamDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "TimestreamDimensionsList": { - "items": { - "$ref": "#/definitions/TimestreamDimension" - }, - "maxItems": 128, - "minItems": 1, - "type": "array" - }, - "TimestreamTimestamp": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Unit" - ], - "type": "object" - }, - "TopicRulePayload": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array" - }, - "AwsIotSqlVersion": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ErrorAction": { - "$ref": "#/definitions/Action" - }, - "RuleDisabled": { - "type": "boolean" - }, - "Sql": { - "type": "string" - } - }, - "required": [ - "Actions", - "Sql" - ], - "type": "object" - }, - "UserProperties": { - "items": { - "$ref": "#/definitions/UserProperty" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "UserProperty": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Value": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::TopicRule", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iot:CreateTopicRule", - "iot:GetTopicRule", - "iot:TagResource", - "iot:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iot:GetTopicRule", - "iot:DeleteTopicRule" - ] - }, - "list": { - "permissions": [ - "iot:ListTopicRules" - ] - }, - "read": { - "permissions": [ - "iot:GetTopicRule", - "iot:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iot:GetTopicRule", - "iot:ListTagsForResource", - "iot:ReplaceTopicRule", - "iot:TagResource", - "iot:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "RuleName": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TopicRulePayload": { - "$ref": "#/definitions/TopicRulePayload" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "TopicRulePayload" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoT::TopicRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RuleName" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "CloudwatchAlarm": { + "$ref": "#/definitions/CloudwatchAlarmAction" + }, + "CloudwatchLogs": { + "$ref": "#/definitions/CloudwatchLogsAction" + }, + "CloudwatchMetric": { + "$ref": "#/definitions/CloudwatchMetricAction" + }, + "DynamoDB": { + "$ref": "#/definitions/DynamoDBAction" + }, + "DynamoDBv2": { + "$ref": "#/definitions/DynamoDBv2Action" + }, + "Elasticsearch": { + "$ref": "#/definitions/ElasticsearchAction" + }, + "Firehose": { + "$ref": "#/definitions/FirehoseAction" + }, + "Http": { + "$ref": "#/definitions/HttpAction" + }, + "IotAnalytics": { + "$ref": "#/definitions/IotAnalyticsAction" + }, + "IotEvents": { + "$ref": "#/definitions/IotEventsAction" + }, + "IotSiteWise": { + "$ref": "#/definitions/IotSiteWiseAction" + }, + "Kafka": { + "$ref": "#/definitions/KafkaAction" + }, + "Kinesis": { + "$ref": "#/definitions/KinesisAction" + }, + "Lambda": { + "$ref": "#/definitions/LambdaAction" + }, + "Location": { + "$ref": "#/definitions/LocationAction" + }, + "OpenSearch": { + "$ref": "#/definitions/OpenSearchAction" + }, + "Republish": { + "$ref": "#/definitions/RepublishAction" + }, + "S3": { + "$ref": "#/definitions/S3Action" + }, + "Sns": { + "$ref": "#/definitions/SnsAction" + }, + "Sqs": { + "$ref": "#/definitions/SqsAction" + }, + "StepFunctions": { + "$ref": "#/definitions/StepFunctionsAction" + }, + "Timestream": { + "$ref": "#/definitions/TimestreamAction" + } + }, + "type": "object" + }, + "AssetPropertyTimestamp": { + "additionalProperties": false, + "properties": { + "OffsetInNanos": { + "type": "string" + }, + "TimeInSeconds": { + "type": "string" + } + }, + "required": [ + "TimeInSeconds" + ], + "type": "object" + }, + "AssetPropertyValue": { + "additionalProperties": false, + "properties": { + "Quality": { + "type": "string" + }, + "Timestamp": { + "$ref": "#/definitions/AssetPropertyTimestamp" + }, + "Value": { + "$ref": "#/definitions/AssetPropertyVariant" + } + }, + "required": [ + "Value", + "Timestamp" + ], + "type": "object" + }, + "AssetPropertyVariant": { + "additionalProperties": false, + "properties": { + "BooleanValue": { + "type": "string" + }, + "DoubleValue": { + "type": "string" + }, + "IntegerValue": { + "type": "string" + }, + "StringValue": { + "type": "string" + } + }, + "type": "object" + }, + "CannedAccessControlList": { + "enum": [ + "private", + "public-read", + "public-read-write", + "aws-exec-read", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control", + "log-delivery-write" + ], + "type": "string" + }, + "CloudwatchAlarmAction": { + "additionalProperties": false, + "properties": { + "AlarmName": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "StateReason": { + "type": "string" + }, + "StateValue": { + "type": "string" + } + }, + "required": [ + "AlarmName", + "StateReason", + "StateValue", + "RoleArn" + ], + "type": "object" + }, + "CloudwatchLogsAction": { + "additionalProperties": false, + "properties": { + "BatchMode": { + "type": "boolean" + }, + "LogGroupName": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "LogGroupName", + "RoleArn" + ], + "type": "object" + }, + "CloudwatchMetricAction": { + "additionalProperties": false, + "properties": { + "MetricName": { + "type": "string" + }, + "MetricNamespace": { + "type": "string" + }, + "MetricTimestamp": { + "type": "string" + }, + "MetricUnit": { + "type": "string" + }, + "MetricValue": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "MetricName", + "MetricValue", + "MetricNamespace", + "MetricUnit", + "RoleArn" + ], + "type": "object" + }, + "DynamoDBAction": { + "additionalProperties": false, + "properties": { + "HashKeyField": { + "type": "string" + }, + "HashKeyType": { + "type": "string" + }, + "HashKeyValue": { + "type": "string" + }, + "PayloadField": { + "type": "string" + }, + "RangeKeyField": { + "type": "string" + }, + "RangeKeyType": { + "type": "string" + }, + "RangeKeyValue": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "TableName": { + "type": "string" + } + }, + "required": [ + "TableName", + "HashKeyField", + "HashKeyValue", + "RoleArn" + ], + "type": "object" + }, + "DynamoDBv2Action": { + "additionalProperties": false, + "properties": { + "PutItem": { + "$ref": "#/definitions/PutItemInput" + }, + "RoleArn": { + "type": "string" + } + }, + "type": "object" + }, + "ElasticsearchAction": { + "additionalProperties": false, + "properties": { + "Endpoint": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Index": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Endpoint", + "Index", + "Id", + "RoleArn" + ], + "type": "object" + }, + "FirehoseAction": { + "additionalProperties": false, + "properties": { + "BatchMode": { + "type": "boolean" + }, + "DeliveryStreamName": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Separator": { + "type": "string" + } + }, + "required": [ + "DeliveryStreamName", + "RoleArn" + ], + "type": "object" + }, + "HttpAction": { + "additionalProperties": false, + "properties": { + "Auth": { + "$ref": "#/definitions/HttpAuthorization" + }, + "ConfirmationUrl": { + "type": "string" + }, + "Headers": { + "items": { + "$ref": "#/definitions/HttpActionHeader" + }, + "type": "array", + "uniqueItems": true + }, + "Url": { + "type": "string" + } + }, + "required": [ + "Url" + ], + "type": "object" + }, + "HttpActionHeader": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "HttpAuthorization": { + "additionalProperties": false, + "properties": { + "Sigv4": { + "$ref": "#/definitions/SigV4Authorization" + } + }, + "type": "object" + }, + "IotAnalyticsAction": { + "additionalProperties": false, + "properties": { + "BatchMode": { + "type": "boolean" + }, + "ChannelName": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "ChannelName", + "RoleArn" + ], + "type": "object" + }, + "IotEventsAction": { + "additionalProperties": false, + "properties": { + "BatchMode": { + "type": "boolean" + }, + "InputName": { + "type": "string" + }, + "MessageId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "InputName", + "RoleArn" + ], + "type": "object" + }, + "IotSiteWiseAction": { + "additionalProperties": false, + "properties": { + "PutAssetPropertyValueEntries": { + "items": { + "$ref": "#/definitions/PutAssetPropertyValueEntry" + }, + "type": "array", + "uniqueItems": true + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "PutAssetPropertyValueEntries", + "RoleArn" + ], + "type": "object" + }, + "KafkaAction": { + "additionalProperties": false, + "properties": { + "ClientProperties": { + "additionalProperties": false, + "minProperties": 1, + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "DestinationArn": { + "type": "string" + }, + "Headers": { + "items": { + "$ref": "#/definitions/KafkaActionHeader" + }, + "type": "array", + "uniqueItems": true + }, + "Key": { + "type": "string" + }, + "Partition": { + "type": "string" + }, + "Topic": { + "type": "string" + } + }, + "required": [ + "DestinationArn", + "Topic", + "ClientProperties" + ], + "type": "object" + }, + "KafkaActionHeader": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "KinesisAction": { + "additionalProperties": false, + "properties": { + "PartitionKey": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "StreamName": { + "type": "string" + } + }, + "required": [ + "StreamName", + "RoleArn" + ], + "type": "object" + }, + "LambdaAction": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "type": "string" + } + }, + "type": "object" + }, + "LocationAction": { + "additionalProperties": false, + "properties": { + "DeviceId": { + "type": "string" + }, + "Latitude": { + "type": "string" + }, + "Longitude": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Timestamp": { + "$ref": "#/definitions/Timestamp" + }, + "TrackerName": { + "type": "string" + } + }, + "required": [ + "RoleArn", + "TrackerName", + "DeviceId", + "Latitude", + "Longitude" + ], + "type": "object" + }, + "OpenSearchAction": { + "additionalProperties": false, + "properties": { + "Endpoint": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Index": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Endpoint", + "Index", + "Id", + "RoleArn" + ], + "type": "object" + }, + "PutAssetPropertyValueEntry": { + "additionalProperties": false, + "properties": { + "AssetId": { + "type": "string" + }, + "EntryId": { + "type": "string" + }, + "PropertyAlias": { + "type": "string" + }, + "PropertyId": { + "type": "string" + }, + "PropertyValues": { + "items": { + "$ref": "#/definitions/AssetPropertyValue" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "PropertyValues" + ], + "type": "object" + }, + "PutItemInput": { + "additionalProperties": false, + "properties": { + "TableName": { + "type": "string" + } + }, + "required": [ + "TableName" + ], + "type": "object" + }, + "RepublishAction": { + "additionalProperties": false, + "properties": { + "Headers": { + "$ref": "#/definitions/RepublishActionHeaders" + }, + "Qos": { + "type": "integer" + }, + "RoleArn": { + "type": "string" + }, + "Topic": { + "type": "string" + } + }, + "required": [ + "Topic", + "RoleArn" + ], + "type": "object" + }, + "RepublishActionHeaders": { + "additionalProperties": false, + "properties": { + "ContentType": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "CorrelationData": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "MessageExpiry": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "PayloadFormatIndicator": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ResponseTopic": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "UserProperties": { + "$ref": "#/definitions/UserProperties" + } + }, + "type": "object" + }, + "RoleArn": { + "type": "string" + }, + "S3Action": { + "additionalProperties": false, + "properties": { + "BucketName": { + "type": "string" + }, + "CannedAcl": { + "$ref": "#/definitions/CannedAccessControlList" + }, + "Key": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "required": [ + "BucketName", + "Key", + "RoleArn" + ], + "type": "object" + }, + "SigV4Authorization": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "type": "string" + }, + "ServiceName": { + "type": "string" + }, + "SigningRegion": { + "type": "string" + } + }, + "required": [ + "ServiceName", + "SigningRegion", + "RoleArn" + ], + "type": "object" + }, + "SnsAction": { + "additionalProperties": false, + "properties": { + "MessageFormat": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "TargetArn": { + "type": "string" + } + }, + "required": [ + "TargetArn", + "RoleArn" + ], + "type": "object" + }, + "SqsAction": { + "additionalProperties": false, + "properties": { + "QueueUrl": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "UseBase64": { + "type": "boolean" + } + }, + "required": [ + "RoleArn", + "QueueUrl" + ], + "type": "object" + }, + "StepFunctionsAction": { + "additionalProperties": false, + "properties": { + "ExecutionNamePrefix": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "StateMachineName": { + "type": "string" + } + }, + "required": [ + "StateMachineName", + "RoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Timestamp": { + "additionalProperties": false, + "properties": { + "Unit": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "TimestreamAction": { + "additionalProperties": false, + "properties": { + "DatabaseName": { + "type": "string" + }, + "Dimensions": { + "$ref": "#/definitions/TimestreamDimensionsList" + }, + "RoleArn": { + "type": "string" + }, + "TableName": { + "type": "string" + }, + "Timestamp": { + "$ref": "#/definitions/TimestreamTimestamp" + } + }, + "required": [ + "RoleArn", + "DatabaseName", + "TableName", + "Dimensions" + ], + "type": "object" + }, + "TimestreamDimension": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "TimestreamDimensionsList": { + "items": { + "$ref": "#/definitions/TimestreamDimension" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + }, + "TimestreamTimestamp": { + "additionalProperties": false, + "properties": { + "Unit": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Unit" + ], + "type": "object" + }, + "TopicRulePayload": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array" + }, + "AwsIotSqlVersion": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ErrorAction": { + "$ref": "#/definitions/Action" + }, + "RuleDisabled": { + "type": "boolean" + }, + "Sql": { + "type": "string" + } + }, + "required": [ + "Actions", + "Sql" + ], + "type": "object" + }, + "UserProperties": { + "items": { + "$ref": "#/definitions/UserProperty" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "UserProperty": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Value": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::TopicRule", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iot:CreateTopicRule", + "iot:GetTopicRule", + "iot:TagResource", + "iot:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iot:GetTopicRule", + "iot:DeleteTopicRule" + ] + }, + "list": { + "permissions": [ + "iot:ListTopicRules" + ] + }, + "read": { + "permissions": [ + "iot:GetTopicRule", + "iot:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iot:GetTopicRule", + "iot:ListTagsForResource", + "iot:ReplaceTopicRule", + "iot:TagResource", + "iot:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "RuleName": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TopicRulePayload": { + "$ref": "#/definitions/TopicRulePayload" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "TopicRulePayload" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoT::TopicRule" +} diff --git a/schema/aws-iot-topicruledestination.json b/schema/aws-iot-topicruledestination.json index 991fda8..23b11c9 100644 --- a/schema/aws-iot-topicruledestination.json +++ b/schema/aws-iot-topicruledestination.json @@ -1,123 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HttpUrlProperties", - "/properties/VpcProperties" - ], - "definitions": { - "HttpUrlDestinationSummary": { - "additionalProperties": false, - "properties": { - "ConfirmationUrl": { - "type": "string" - } - }, - "type": "object" - }, - "TopicRuleDestinationStatus": { - "enum": [ - "ENABLED", - "IN_PROGRESS", - "DISABLED" - ], - "type": "string" - }, - "VpcDestinationProperties": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT::TopicRuleDestination", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iot:CreateTopicRuleDestination", - "iot:GetTopicRuleDestination", - "iot:UpdateTopicRuleDestination" - ] - }, - "delete": { - "permissions": [ - "iot:GetTopicRuleDestination", - "iot:DeleteTopicRuleDestination" - ] - }, - "list": { - "permissions": [ - "iot:ListTopicRuleDestinations" - ] - }, - "read": { - "permissions": [ - "iot:GetTopicRuleDestination" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iot:GetTopicRuleDestination", - "iot:UpdateTopicRuleDestination" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Amazon Resource Name (ARN).", - "type": "string" - }, - "HttpUrlProperties": { - "$ref": "#/definitions/HttpUrlDestinationSummary", - "description": "HTTP URL destination properties." - }, - "Status": { - "$ref": "#/definitions/TopicRuleDestinationStatus", - "description": "The status of the TopicRuleDestination." - }, - "StatusReason": { - "description": "The reasoning for the current status of the TopicRuleDestination.", - "type": "string" - }, - "VpcProperties": { - "$ref": "#/definitions/VpcDestinationProperties", - "description": "VPC destination properties." - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/StatusReason" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::IoT::TopicRuleDestination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HttpUrlProperties", + "/properties/VpcProperties" + ], + "definitions": { + "HttpUrlDestinationSummary": { + "additionalProperties": false, + "properties": { + "ConfirmationUrl": { + "type": "string" + } + }, + "type": "object" + }, + "TopicRuleDestinationStatus": { + "enum": [ + "ENABLED", + "IN_PROGRESS", + "DISABLED" + ], + "type": "string" + }, + "VpcDestinationProperties": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "type": "string" + }, + "SecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT::TopicRuleDestination", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iot:CreateTopicRuleDestination", + "iot:GetTopicRuleDestination", + "iot:UpdateTopicRuleDestination" + ] + }, + "delete": { + "permissions": [ + "iot:GetTopicRuleDestination", + "iot:DeleteTopicRuleDestination" + ] + }, + "list": { + "permissions": [ + "iot:ListTopicRuleDestinations" + ] + }, + "read": { + "permissions": [ + "iot:GetTopicRuleDestination" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iot:GetTopicRuleDestination", + "iot:UpdateTopicRuleDestination" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Amazon Resource Name (ARN).", + "type": "string" + }, + "HttpUrlProperties": { + "$ref": "#/definitions/HttpUrlDestinationSummary", + "description": "HTTP URL destination properties." + }, + "Status": { + "$ref": "#/definitions/TopicRuleDestinationStatus", + "description": "The status of the TopicRuleDestination." + }, + "StatusReason": { + "description": "The reasoning for the current status of the TopicRuleDestination.", + "type": "string" + }, + "VpcProperties": { + "$ref": "#/definitions/VpcDestinationProperties", + "description": "VPC destination properties." + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/StatusReason" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::IoT::TopicRuleDestination" +} diff --git a/schema/aws-iot1click-device.json b/schema/aws-iot1click-device.json index 25134be..d13297a 100644 --- a/schema/aws-iot1click-device.json +++ b/schema/aws-iot1click-device.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeviceId" - ], - "description": "Resource Type definition for AWS::IoT1Click::Device", - "primaryIdentifier": [ - "/properties/DeviceId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DeviceId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DeviceId" - ], - "required": [ - "Enabled", - "DeviceId" - ], - "typeName": "AWS::IoT1Click::Device" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeviceId" + ], + "description": "Resource Type definition for AWS::IoT1Click::Device", + "primaryIdentifier": [ + "/properties/DeviceId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DeviceId": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DeviceId" + ], + "required": [ + "Enabled", + "DeviceId" + ], + "typeName": "AWS::IoT1Click::Device" +} diff --git a/schema/aws-iot1click-placement.json b/schema/aws-iot1click-placement.json index a107467..897a534 100644 --- a/schema/aws-iot1click-placement.json +++ b/schema/aws-iot1click-placement.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PlacementName", - "/properties/AssociatedDevices", - "/properties/ProjectName" - ], - "description": "Resource Type definition for AWS::IoT1Click::Placement", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AssociatedDevices": { - "type": "object" - }, - "Attributes": { - "type": "object" - }, - "Id": { - "type": "string" - }, - "PlacementName": { - "type": "string" - }, - "ProjectName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ProjectName" - ], - "typeName": "AWS::IoT1Click::Placement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PlacementName", + "/properties/AssociatedDevices", + "/properties/ProjectName" + ], + "description": "Resource Type definition for AWS::IoT1Click::Placement", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AssociatedDevices": { + "type": "object" + }, + "Attributes": { + "type": "object" + }, + "Id": { + "type": "string" + }, + "PlacementName": { + "type": "string" + }, + "ProjectName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ProjectName" + ], + "typeName": "AWS::IoT1Click::Placement" +} diff --git a/schema/aws-iot1click-project.json b/schema/aws-iot1click-project.json index bb81672..e5fba55 100644 --- a/schema/aws-iot1click-project.json +++ b/schema/aws-iot1click-project.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProjectName" - ], - "definitions": { - "PlacementTemplate": { - "additionalProperties": false, - "properties": { - "DefaultAttributes": { - "type": "object" - }, - "DeviceTemplates": { - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoT1Click::Project", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PlacementTemplate": { - "$ref": "#/definitions/PlacementTemplate" - }, - "ProjectName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "PlacementTemplate" - ], - "typeName": "AWS::IoT1Click::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProjectName" + ], + "definitions": { + "PlacementTemplate": { + "additionalProperties": false, + "properties": { + "DefaultAttributes": { + "type": "object" + }, + "DeviceTemplates": { + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoT1Click::Project", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PlacementTemplate": { + "$ref": "#/definitions/PlacementTemplate" + }, + "ProjectName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "PlacementTemplate" + ], + "typeName": "AWS::IoT1Click::Project" +} diff --git a/schema/aws-iotanalytics-channel.json b/schema/aws-iotanalytics-channel.json index e321053..6b4c8bc 100644 --- a/schema/aws-iotanalytics-channel.json +++ b/schema/aws-iotanalytics-channel.json @@ -1,151 +1,151 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelName" - ], - "definitions": { - "ChannelStorage": { - "additionalProperties": false, - "properties": { - "CustomerManagedS3": { - "$ref": "#/definitions/CustomerManagedS3" - }, - "ServiceManagedS3": { - "$ref": "#/definitions/ServiceManagedS3" - } - }, - "type": "object" - }, - "CustomerManagedS3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 255, - "minLength": 3, - "pattern": "^[a-zA-Z0-9.\\-_]*$", - "type": "string" - }, - "KeyPrefix": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9!_.*'()/{}:-]*/$", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "Bucket", - "RoleArn" - ], - "type": "object" - }, - "RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "ServiceManagedS3": { - "additionalProperties": false, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoTAnalytics::Channel", - "handlers": { - "create": { - "permissions": [ - "iotanalytics:CreateChannel" - ] - }, - "delete": { - "permissions": [ - "iotanalytics:DeleteChannel" - ] - }, - "list": { - "permissions": [ - "iotanalytics:ListChannels" - ] - }, - "read": { - "permissions": [ - "iotanalytics:DescribeChannel", - "iotanalytics:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotanalytics:UpdateChannel", - "iotanalytics:TagResource", - "iotanalytics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelName" - ], - "properties": { - "ChannelName": { - "maxLength": 128, - "minLength": 1, - "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", - "type": "string" - }, - "ChannelStorage": { - "$ref": "#/definitions/ChannelStorage" - }, - "Id": { - "type": "string" - }, - "RetentionPeriod": { - "$ref": "#/definitions/RetentionPeriod" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "taggable": true, - "typeName": "AWS::IoTAnalytics::Channel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelName" + ], + "definitions": { + "ChannelStorage": { + "additionalProperties": false, + "properties": { + "CustomerManagedS3": { + "$ref": "#/definitions/CustomerManagedS3" + }, + "ServiceManagedS3": { + "$ref": "#/definitions/ServiceManagedS3" + } + }, + "type": "object" + }, + "CustomerManagedS3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 255, + "minLength": 3, + "pattern": "^[a-zA-Z0-9.\\-_]*$", + "type": "string" + }, + "KeyPrefix": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9!_.*'()/{}:-]*/$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "Bucket", + "RoleArn" + ], + "type": "object" + }, + "RetentionPeriod": { + "additionalProperties": false, + "properties": { + "NumberOfDays": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "Unlimited": { + "type": "boolean" + } + }, + "type": "object" + }, + "ServiceManagedS3": { + "additionalProperties": false, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoTAnalytics::Channel", + "handlers": { + "create": { + "permissions": [ + "iotanalytics:CreateChannel" + ] + }, + "delete": { + "permissions": [ + "iotanalytics:DeleteChannel" + ] + }, + "list": { + "permissions": [ + "iotanalytics:ListChannels" + ] + }, + "read": { + "permissions": [ + "iotanalytics:DescribeChannel", + "iotanalytics:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotanalytics:UpdateChannel", + "iotanalytics:TagResource", + "iotanalytics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelName" + ], + "properties": { + "ChannelName": { + "maxLength": 128, + "minLength": 1, + "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", + "type": "string" + }, + "ChannelStorage": { + "$ref": "#/definitions/ChannelStorage" + }, + "Id": { + "type": "string" + }, + "RetentionPeriod": { + "$ref": "#/definitions/RetentionPeriod" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "taggable": true, + "typeName": "AWS::IoTAnalytics::Channel" +} diff --git a/schema/aws-iotanalytics-dataset.json b/schema/aws-iotanalytics-dataset.json index 1f1ed34..23afc24 100644 --- a/schema/aws-iotanalytics-dataset.json +++ b/schema/aws-iotanalytics-dataset.json @@ -1,523 +1,523 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatasetName" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "ActionName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_]+$", - "type": "string" - }, - "ContainerAction": { - "$ref": "#/definitions/ContainerAction" - }, - "QueryAction": { - "$ref": "#/definitions/QueryAction" - } - }, - "required": [ - "ActionName" - ], - "type": "object" - }, - "ContainerAction": { - "additionalProperties": false, - "properties": { - "ExecutionRoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "Image": { - "maxLength": 255, - "type": "string" - }, - "ResourceConfiguration": { - "$ref": "#/definitions/ResourceConfiguration" - }, - "Variables": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Variable" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ExecutionRoleArn", - "Image", - "ResourceConfiguration" - ], - "type": "object" - }, - "DatasetContentDeliveryRule": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/DatasetContentDeliveryRuleDestination" - }, - "EntryName": { - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "DatasetContentDeliveryRuleDestination": { - "additionalProperties": false, - "properties": { - "IotEventsDestinationConfiguration": { - "$ref": "#/definitions/IotEventsDestinationConfiguration" - }, - "S3DestinationConfiguration": { - "$ref": "#/definitions/S3DestinationConfiguration" - } - }, - "type": "object" - }, - "DatasetContentVersionValue": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "maxLength": 128, - "minLength": 1, - "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", - "type": "string" - } - }, - "required": [ - "DatasetName" - ], - "type": "object" - }, - "DeltaTime": { - "additionalProperties": false, - "properties": { - "OffsetSeconds": { - "type": "integer" - }, - "TimeExpression": { - "type": "string" - } - }, - "required": [ - "TimeExpression", - "OffsetSeconds" - ], - "type": "object" - }, - "DeltaTimeSessionWindowConfiguration": { - "additionalProperties": false, - "properties": { - "TimeoutInMinutes": { - "maximum": 60, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "TimeoutInMinutes" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "DeltaTime": { - "$ref": "#/definitions/DeltaTime" - } - }, - "type": "object" - }, - "GlueConfiguration": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "maxLength": 150, - "minLength": 1, - "type": "string" - }, - "TableName": { - "maxLength": 150, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TableName", - "DatabaseName" - ], - "type": "object" - }, - "IotEventsDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "InputName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "InputName", - "RoleArn" - ], - "type": "object" - }, - "LateDataRule": { - "additionalProperties": false, - "properties": { - "RuleConfiguration": { - "$ref": "#/definitions/LateDataRuleConfiguration" - }, - "RuleName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_]+$", - "type": "string" - } - }, - "required": [ - "RuleConfiguration" - ], - "type": "object" - }, - "LateDataRuleConfiguration": { - "additionalProperties": false, - "properties": { - "DeltaTimeSessionWindowConfiguration": { - "$ref": "#/definitions/DeltaTimeSessionWindowConfiguration" - } - }, - "type": "object" - }, - "OutputFileUriValue": { - "additionalProperties": false, - "properties": { - "FileName": { - "pattern": "^[\\w\\.-]{1,255}$", - "type": "string" - } - }, - "required": [ - "FileName" - ], - "type": "object" - }, - "QueryAction": { - "additionalProperties": false, - "properties": { - "Filters": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 1, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "SqlQuery": { - "type": "string" - } - }, - "required": [ - "SqlQuery" - ], - "type": "object" - }, - "ResourceConfiguration": { - "additionalProperties": false, - "properties": { - "ComputeType": { - "enum": [ - "ACU_1", - "ACU_2" - ], - "type": "string" - }, - "VolumeSizeInGB": { - "maximum": 50, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "VolumeSizeInGB", - "ComputeType" - ], - "type": "object" - }, - "RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "S3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 255, - "minLength": 3, - "pattern": "^[a-zA-Z0-9.\\-_]*$", - "type": "string" - }, - "GlueConfiguration": { - "$ref": "#/definitions/GlueConfiguration" - }, - "Key": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9!_.*'()/{}:-]*$", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Trigger": { - "additionalProperties": false, - "properties": { - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "TriggeringDataset": { - "$ref": "#/definitions/TriggeringDataset" - } - }, - "type": "object" - }, - "TriggeringDataset": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "maxLength": 128, - "minLength": 1, - "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", - "type": "string" - } - }, - "required": [ - "DatasetName" - ], - "type": "object" - }, - "Variable": { - "additionalProperties": false, - "properties": { - "DatasetContentVersionValue": { - "$ref": "#/definitions/DatasetContentVersionValue" - }, - "DoubleValue": { - "type": "number" - }, - "OutputFileUriValue": { - "$ref": "#/definitions/OutputFileUriValue" - }, - "StringValue": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "VariableName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "VariableName" - ], - "type": "object" - }, - "VersioningConfiguration": { - "additionalProperties": false, - "properties": { - "MaxVersions": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoTAnalytics::Dataset", - "handlers": { - "create": { - "permissions": [ - "iotanalytics:CreateDataset" - ] - }, - "delete": { - "permissions": [ - "iotanalytics:DeleteDataset" - ] - }, - "list": { - "permissions": [ - "iotanalytics:ListDatasets" - ] - }, - "read": { - "permissions": [ - "iotanalytics:DescribeDataset", - "iotanalytics:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotanalytics:UpdateDataset", - "iotanalytics:TagResource", - "iotanalytics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatasetName" - ], - "properties": { - "Actions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "ContentDeliveryRules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DatasetContentDeliveryRule" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "DatasetName": { - "maxLength": 128, - "minLength": 1, - "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", - "type": "string" - }, - "Id": { - "type": "string" - }, - "LateDataRules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LateDataRule" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "RetentionPeriod": { - "$ref": "#/definitions/RetentionPeriod" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Triggers": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Trigger" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "VersioningConfiguration": { - "$ref": "#/definitions/VersioningConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Actions" - ], - "taggable": true, - "typeName": "AWS::IoTAnalytics::Dataset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatasetName" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "ActionName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_]+$", + "type": "string" + }, + "ContainerAction": { + "$ref": "#/definitions/ContainerAction" + }, + "QueryAction": { + "$ref": "#/definitions/QueryAction" + } + }, + "required": [ + "ActionName" + ], + "type": "object" + }, + "ContainerAction": { + "additionalProperties": false, + "properties": { + "ExecutionRoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "Image": { + "maxLength": 255, + "type": "string" + }, + "ResourceConfiguration": { + "$ref": "#/definitions/ResourceConfiguration" + }, + "Variables": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Variable" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ExecutionRoleArn", + "Image", + "ResourceConfiguration" + ], + "type": "object" + }, + "DatasetContentDeliveryRule": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/DatasetContentDeliveryRuleDestination" + }, + "EntryName": { + "type": "string" + } + }, + "required": [ + "Destination" + ], + "type": "object" + }, + "DatasetContentDeliveryRuleDestination": { + "additionalProperties": false, + "properties": { + "IotEventsDestinationConfiguration": { + "$ref": "#/definitions/IotEventsDestinationConfiguration" + }, + "S3DestinationConfiguration": { + "$ref": "#/definitions/S3DestinationConfiguration" + } + }, + "type": "object" + }, + "DatasetContentVersionValue": { + "additionalProperties": false, + "properties": { + "DatasetName": { + "maxLength": 128, + "minLength": 1, + "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", + "type": "string" + } + }, + "required": [ + "DatasetName" + ], + "type": "object" + }, + "DeltaTime": { + "additionalProperties": false, + "properties": { + "OffsetSeconds": { + "type": "integer" + }, + "TimeExpression": { + "type": "string" + } + }, + "required": [ + "TimeExpression", + "OffsetSeconds" + ], + "type": "object" + }, + "DeltaTimeSessionWindowConfiguration": { + "additionalProperties": false, + "properties": { + "TimeoutInMinutes": { + "maximum": 60, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "TimeoutInMinutes" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "DeltaTime": { + "$ref": "#/definitions/DeltaTime" + } + }, + "type": "object" + }, + "GlueConfiguration": { + "additionalProperties": false, + "properties": { + "DatabaseName": { + "maxLength": 150, + "minLength": 1, + "type": "string" + }, + "TableName": { + "maxLength": 150, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TableName", + "DatabaseName" + ], + "type": "object" + }, + "IotEventsDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "InputName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "InputName", + "RoleArn" + ], + "type": "object" + }, + "LateDataRule": { + "additionalProperties": false, + "properties": { + "RuleConfiguration": { + "$ref": "#/definitions/LateDataRuleConfiguration" + }, + "RuleName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_]+$", + "type": "string" + } + }, + "required": [ + "RuleConfiguration" + ], + "type": "object" + }, + "LateDataRuleConfiguration": { + "additionalProperties": false, + "properties": { + "DeltaTimeSessionWindowConfiguration": { + "$ref": "#/definitions/DeltaTimeSessionWindowConfiguration" + } + }, + "type": "object" + }, + "OutputFileUriValue": { + "additionalProperties": false, + "properties": { + "FileName": { + "pattern": "^[\\w\\.-]{1,255}$", + "type": "string" + } + }, + "required": [ + "FileName" + ], + "type": "object" + }, + "QueryAction": { + "additionalProperties": false, + "properties": { + "Filters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "SqlQuery": { + "type": "string" + } + }, + "required": [ + "SqlQuery" + ], + "type": "object" + }, + "ResourceConfiguration": { + "additionalProperties": false, + "properties": { + "ComputeType": { + "enum": [ + "ACU_1", + "ACU_2" + ], + "type": "string" + }, + "VolumeSizeInGB": { + "maximum": 50, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "VolumeSizeInGB", + "ComputeType" + ], + "type": "object" + }, + "RetentionPeriod": { + "additionalProperties": false, + "properties": { + "NumberOfDays": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "Unlimited": { + "type": "boolean" + } + }, + "type": "object" + }, + "S3DestinationConfiguration": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 255, + "minLength": 3, + "pattern": "^[a-zA-Z0-9.\\-_]*$", + "type": "string" + }, + "GlueConfiguration": { + "$ref": "#/definitions/GlueConfiguration" + }, + "Key": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9!_.*'()/{}:-]*$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key", + "RoleArn" + ], + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "properties": { + "ScheduleExpression": { + "type": "string" + } + }, + "required": [ + "ScheduleExpression" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Trigger": { + "additionalProperties": false, + "properties": { + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "TriggeringDataset": { + "$ref": "#/definitions/TriggeringDataset" + } + }, + "type": "object" + }, + "TriggeringDataset": { + "additionalProperties": false, + "properties": { + "DatasetName": { + "maxLength": 128, + "minLength": 1, + "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", + "type": "string" + } + }, + "required": [ + "DatasetName" + ], + "type": "object" + }, + "Variable": { + "additionalProperties": false, + "properties": { + "DatasetContentVersionValue": { + "$ref": "#/definitions/DatasetContentVersionValue" + }, + "DoubleValue": { + "type": "number" + }, + "OutputFileUriValue": { + "$ref": "#/definitions/OutputFileUriValue" + }, + "StringValue": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "VariableName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "VariableName" + ], + "type": "object" + }, + "VersioningConfiguration": { + "additionalProperties": false, + "properties": { + "MaxVersions": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "Unlimited": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoTAnalytics::Dataset", + "handlers": { + "create": { + "permissions": [ + "iotanalytics:CreateDataset" + ] + }, + "delete": { + "permissions": [ + "iotanalytics:DeleteDataset" + ] + }, + "list": { + "permissions": [ + "iotanalytics:ListDatasets" + ] + }, + "read": { + "permissions": [ + "iotanalytics:DescribeDataset", + "iotanalytics:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotanalytics:UpdateDataset", + "iotanalytics:TagResource", + "iotanalytics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatasetName" + ], + "properties": { + "Actions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "ContentDeliveryRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DatasetContentDeliveryRule" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DatasetName": { + "maxLength": 128, + "minLength": 1, + "pattern": "(^(?!_{2}))(^[a-zA-Z0-9_]+$)", + "type": "string" + }, + "Id": { + "type": "string" + }, + "LateDataRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LateDataRule" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "RetentionPeriod": { + "$ref": "#/definitions/RetentionPeriod" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Triggers": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Trigger" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "VersioningConfiguration": { + "$ref": "#/definitions/VersioningConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Actions" + ], + "taggable": true, + "typeName": "AWS::IoTAnalytics::Dataset" +} diff --git a/schema/aws-iotanalytics-datastore.json b/schema/aws-iotanalytics-datastore.json index faa6d38..9ce8cc3 100644 --- a/schema/aws-iotanalytics-datastore.json +++ b/schema/aws-iotanalytics-datastore.json @@ -1,305 +1,305 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatastoreName" - ], - "definitions": { - "Column": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Name" - ], - "type": "object" - }, - "CustomerManagedS3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 255, - "minLength": 3, - "pattern": "[a-zA-Z0-9.\\-_]*", - "type": "string" - }, - "KeyPrefix": { - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9!_.*'()/{}:-]*/", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "Bucket", - "RoleArn" - ], - "type": "object" - }, - "CustomerManagedS3Storage": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 255, - "minLength": 3, - "pattern": "[a-zA-Z0-9.\\-_]*", - "type": "string" - }, - "KeyPrefix": { - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9!_.*'()/{}:-]*/", - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "DatastorePartition": { - "additionalProperties": false, - "properties": { - "Partition": { - "$ref": "#/definitions/Partition" - }, - "TimestampPartition": { - "$ref": "#/definitions/TimestampPartition" - } - }, - "type": "object" - }, - "DatastorePartitions": { - "additionalProperties": false, - "properties": { - "Partitions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DatastorePartition" - }, - "maxItems": 25, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DatastoreStorage": { - "additionalProperties": false, - "properties": { - "CustomerManagedS3": { - "$ref": "#/definitions/CustomerManagedS3" - }, - "IotSiteWiseMultiLayerStorage": { - "$ref": "#/definitions/IotSiteWiseMultiLayerStorage" - }, - "ServiceManagedS3": { - "$ref": "#/definitions/ServiceManagedS3" - } - }, - "type": "object" - }, - "FileFormatConfiguration": { - "additionalProperties": false, - "properties": { - "JsonConfiguration": { - "$ref": "#/definitions/JsonConfiguration" - }, - "ParquetConfiguration": { - "$ref": "#/definitions/ParquetConfiguration" - } - }, - "type": "object" - }, - "IotSiteWiseMultiLayerStorage": { - "additionalProperties": false, - "properties": { - "CustomerManagedS3Storage": { - "$ref": "#/definitions/CustomerManagedS3Storage" - } - }, - "type": "object" - }, - "JsonConfiguration": { - "additionalProperties": false, - "type": "object" - }, - "ParquetConfiguration": { - "additionalProperties": false, - "properties": { - "SchemaDefinition": { - "$ref": "#/definitions/SchemaDefinition" - } - }, - "type": "object" - }, - "Partition": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - } - }, - "required": [ - "AttributeName" - ], - "type": "object" - }, - "RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "SchemaDefinition": { - "additionalProperties": false, - "properties": { - "Columns": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Column" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "ServiceManagedS3": { - "additionalProperties": false, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TimestampPartition": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "TimestampFormat": { - "pattern": "[a-zA-Z0-9\\s\\[\\]_,.'/:-]*", - "type": "string" - } - }, - "required": [ - "AttributeName" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoTAnalytics::Datastore", - "handlers": { - "create": { - "permissions": [ - "iotanalytics:CreateDatastore" - ] - }, - "delete": { - "permissions": [ - "iotanalytics:DeleteDatastore" - ] - }, - "list": { - "permissions": [ - "iotanalytics:ListDatastores" - ] - }, - "read": { - "permissions": [ - "iotanalytics:DescribeDatastore", - "iotanalytics:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotanalytics:UpdateDatastore", - "iotanalytics:TagResource", - "iotanalytics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatastoreName" - ], - "properties": { - "DatastoreName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "DatastorePartitions": { - "$ref": "#/definitions/DatastorePartitions" - }, - "DatastoreStorage": { - "$ref": "#/definitions/DatastoreStorage" - }, - "FileFormatConfiguration": { - "$ref": "#/definitions/FileFormatConfiguration" - }, - "Id": { - "type": "string" - }, - "RetentionPeriod": { - "$ref": "#/definitions/RetentionPeriod" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "taggable": true, - "typeName": "AWS::IoTAnalytics::Datastore" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatastoreName" + ], + "definitions": { + "Column": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Name" + ], + "type": "object" + }, + "CustomerManagedS3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 255, + "minLength": 3, + "pattern": "[a-zA-Z0-9.\\-_]*", + "type": "string" + }, + "KeyPrefix": { + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9!_.*'()/{}:-]*/", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "Bucket", + "RoleArn" + ], + "type": "object" + }, + "CustomerManagedS3Storage": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 255, + "minLength": 3, + "pattern": "[a-zA-Z0-9.\\-_]*", + "type": "string" + }, + "KeyPrefix": { + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9!_.*'()/{}:-]*/", + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "DatastorePartition": { + "additionalProperties": false, + "properties": { + "Partition": { + "$ref": "#/definitions/Partition" + }, + "TimestampPartition": { + "$ref": "#/definitions/TimestampPartition" + } + }, + "type": "object" + }, + "DatastorePartitions": { + "additionalProperties": false, + "properties": { + "Partitions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DatastorePartition" + }, + "maxItems": 25, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DatastoreStorage": { + "additionalProperties": false, + "properties": { + "CustomerManagedS3": { + "$ref": "#/definitions/CustomerManagedS3" + }, + "IotSiteWiseMultiLayerStorage": { + "$ref": "#/definitions/IotSiteWiseMultiLayerStorage" + }, + "ServiceManagedS3": { + "$ref": "#/definitions/ServiceManagedS3" + } + }, + "type": "object" + }, + "FileFormatConfiguration": { + "additionalProperties": false, + "properties": { + "JsonConfiguration": { + "$ref": "#/definitions/JsonConfiguration" + }, + "ParquetConfiguration": { + "$ref": "#/definitions/ParquetConfiguration" + } + }, + "type": "object" + }, + "IotSiteWiseMultiLayerStorage": { + "additionalProperties": false, + "properties": { + "CustomerManagedS3Storage": { + "$ref": "#/definitions/CustomerManagedS3Storage" + } + }, + "type": "object" + }, + "JsonConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "ParquetConfiguration": { + "additionalProperties": false, + "properties": { + "SchemaDefinition": { + "$ref": "#/definitions/SchemaDefinition" + } + }, + "type": "object" + }, + "Partition": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + } + }, + "required": [ + "AttributeName" + ], + "type": "object" + }, + "RetentionPeriod": { + "additionalProperties": false, + "properties": { + "NumberOfDays": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "Unlimited": { + "type": "boolean" + } + }, + "type": "object" + }, + "SchemaDefinition": { + "additionalProperties": false, + "properties": { + "Columns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Column" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "ServiceManagedS3": { + "additionalProperties": false, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TimestampPartition": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "TimestampFormat": { + "pattern": "[a-zA-Z0-9\\s\\[\\]_,.'/:-]*", + "type": "string" + } + }, + "required": [ + "AttributeName" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoTAnalytics::Datastore", + "handlers": { + "create": { + "permissions": [ + "iotanalytics:CreateDatastore" + ] + }, + "delete": { + "permissions": [ + "iotanalytics:DeleteDatastore" + ] + }, + "list": { + "permissions": [ + "iotanalytics:ListDatastores" + ] + }, + "read": { + "permissions": [ + "iotanalytics:DescribeDatastore", + "iotanalytics:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotanalytics:UpdateDatastore", + "iotanalytics:TagResource", + "iotanalytics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatastoreName" + ], + "properties": { + "DatastoreName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "DatastorePartitions": { + "$ref": "#/definitions/DatastorePartitions" + }, + "DatastoreStorage": { + "$ref": "#/definitions/DatastoreStorage" + }, + "FileFormatConfiguration": { + "$ref": "#/definitions/FileFormatConfiguration" + }, + "Id": { + "type": "string" + }, + "RetentionPeriod": { + "$ref": "#/definitions/RetentionPeriod" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "taggable": true, + "typeName": "AWS::IoTAnalytics::Datastore" +} diff --git a/schema/aws-iotanalytics-pipeline.json b/schema/aws-iotanalytics-pipeline.json index c675dde..89b3306 100644 --- a/schema/aws-iotanalytics-pipeline.json +++ b/schema/aws-iotanalytics-pipeline.json @@ -1,443 +1,443 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PipelineName" - ], - "definitions": { - "Activity": { - "additionalProperties": false, - "properties": { - "AddAttributes": { - "$ref": "#/definitions/AddAttributes" - }, - "Channel": { - "$ref": "#/definitions/Channel" - }, - "Datastore": { - "$ref": "#/definitions/Datastore" - }, - "DeviceRegistryEnrich": { - "$ref": "#/definitions/DeviceRegistryEnrich" - }, - "DeviceShadowEnrich": { - "$ref": "#/definitions/DeviceShadowEnrich" - }, - "Filter": { - "$ref": "#/definitions/Filter" - }, - "Lambda": { - "$ref": "#/definitions/Lambda" - }, - "Math": { - "$ref": "#/definitions/Math" - }, - "RemoveAttributes": { - "$ref": "#/definitions/RemoveAttributes" - }, - "SelectAttributes": { - "$ref": "#/definitions/SelectAttributes" - } - }, - "type": "object" - }, - "AddAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": false, - "maxProperties": 50, - "minProperties": 1, - "patternProperties": { - "^.*$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Attributes", - "Name" - ], - "type": "object" - }, - "Channel": { - "additionalProperties": false, - "properties": { - "ChannelName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ChannelName", - "Name" - ], - "type": "object" - }, - "Datastore": { - "additionalProperties": false, - "properties": { - "DatastoreName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DatastoreName", - "Name" - ], - "type": "object" - }, - "DeviceRegistryEnrich": { - "additionalProperties": false, - "properties": { - "Attribute": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ThingName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Attribute", - "ThingName", - "RoleArn", - "Name" - ], - "type": "object" - }, - "DeviceShadowEnrich": { - "additionalProperties": false, - "properties": { - "Attribute": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ThingName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Attribute", - "ThingName", - "RoleArn", - "Name" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "Filter": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Filter", - "Name" - ], - "type": "object" - }, - "Lambda": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "LambdaName": { - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_-]+", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "LambdaName", - "Name", - "BatchSize" - ], - "type": "object" - }, - "Math": { - "additionalProperties": false, - "properties": { - "Attribute": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Math": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Attribute", - "Math", - "Name" - ], - "type": "object" - }, - "RemoveAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Attributes", - "Name" - ], - "type": "object" - }, - "SelectAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Next": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name", - "Attributes" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoTAnalytics::Pipeline", - "handlers": { - "create": { - "permissions": [ - "iotanalytics:CreatePipeline" - ] - }, - "delete": { - "permissions": [ - "iotanalytics:DeletePipeline" - ] - }, - "list": { - "permissions": [ - "iotanalytics:ListPipelines" - ] - }, - "read": { - "permissions": [ - "iotanalytics:DescribePipeline", - "iotanalytics:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotanalytics:UpdatePipeline", - "iotanalytics:TagResource", - "iotanalytics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PipelineName" - ], - "properties": { - "Id": { - "type": "string" - }, - "PipelineActivities": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Activity" - }, - "maxItems": 25, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "PipelineName": { - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PipelineActivities" - ], - "taggable": true, - "typeName": "AWS::IoTAnalytics::Pipeline" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PipelineName" + ], + "definitions": { + "Activity": { + "additionalProperties": false, + "properties": { + "AddAttributes": { + "$ref": "#/definitions/AddAttributes" + }, + "Channel": { + "$ref": "#/definitions/Channel" + }, + "Datastore": { + "$ref": "#/definitions/Datastore" + }, + "DeviceRegistryEnrich": { + "$ref": "#/definitions/DeviceRegistryEnrich" + }, + "DeviceShadowEnrich": { + "$ref": "#/definitions/DeviceShadowEnrich" + }, + "Filter": { + "$ref": "#/definitions/Filter" + }, + "Lambda": { + "$ref": "#/definitions/Lambda" + }, + "Math": { + "$ref": "#/definitions/Math" + }, + "RemoveAttributes": { + "$ref": "#/definitions/RemoveAttributes" + }, + "SelectAttributes": { + "$ref": "#/definitions/SelectAttributes" + } + }, + "type": "object" + }, + "AddAttributes": { + "additionalProperties": false, + "properties": { + "Attributes": { + "additionalProperties": false, + "maxProperties": 50, + "minProperties": 1, + "patternProperties": { + "^.*$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Attributes", + "Name" + ], + "type": "object" + }, + "Channel": { + "additionalProperties": false, + "properties": { + "ChannelName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ChannelName", + "Name" + ], + "type": "object" + }, + "Datastore": { + "additionalProperties": false, + "properties": { + "DatastoreName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DatastoreName", + "Name" + ], + "type": "object" + }, + "DeviceRegistryEnrich": { + "additionalProperties": false, + "properties": { + "Attribute": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ThingName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Attribute", + "ThingName", + "RoleArn", + "Name" + ], + "type": "object" + }, + "DeviceShadowEnrich": { + "additionalProperties": false, + "properties": { + "Attribute": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ThingName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Attribute", + "ThingName", + "RoleArn", + "Name" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "Filter": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Filter", + "Name" + ], + "type": "object" + }, + "Lambda": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "LambdaName": { + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_-]+", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "LambdaName", + "Name", + "BatchSize" + ], + "type": "object" + }, + "Math": { + "additionalProperties": false, + "properties": { + "Attribute": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Math": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Attribute", + "Math", + "Name" + ], + "type": "object" + }, + "RemoveAttributes": { + "additionalProperties": false, + "properties": { + "Attributes": { + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Attributes", + "Name" + ], + "type": "object" + }, + "SelectAttributes": { + "additionalProperties": false, + "properties": { + "Attributes": { + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Next": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name", + "Attributes" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoTAnalytics::Pipeline", + "handlers": { + "create": { + "permissions": [ + "iotanalytics:CreatePipeline" + ] + }, + "delete": { + "permissions": [ + "iotanalytics:DeletePipeline" + ] + }, + "list": { + "permissions": [ + "iotanalytics:ListPipelines" + ] + }, + "read": { + "permissions": [ + "iotanalytics:DescribePipeline", + "iotanalytics:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotanalytics:UpdatePipeline", + "iotanalytics:TagResource", + "iotanalytics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PipelineName" + ], + "properties": { + "Id": { + "type": "string" + }, + "PipelineActivities": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Activity" + }, + "maxItems": 25, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "PipelineName": { + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PipelineActivities" + ], + "taggable": true, + "typeName": "AWS::IoTAnalytics::Pipeline" +} diff --git a/schema/aws-iotcoredeviceadvisor-suitedefinition.json b/schema/aws-iotcoredeviceadvisor-suitedefinition.json index d1755fc..e76e16c 100644 --- a/schema/aws-iotcoredeviceadvisor-suitedefinition.json +++ b/schema/aws-iotcoredeviceadvisor-suitedefinition.json @@ -1,196 +1,196 @@ -{ - "additionalProperties": false, - "definitions": { - "DevicePermissionRoleArn": { - "description": "The device permission role arn of the test suite.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "DeviceUnderTest": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ThingArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "type": "object" - }, - "Devices": { - "description": "The devices being tested in the test suite", - "items": { - "$ref": "#/definitions/DeviceUnderTest" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "IntendedForQualification": { - "description": "Whether the tests are intended for qualification in a suite.", - "type": "boolean" - }, - "RootGroup": { - "description": "The root group of the test suite.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "SuiteDefinitionName": { - "description": "The Name of the suite definition.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "iot:DescribeCertificate", - "iot:DescribeThing", - "iot:GetPolicy", - "iot:ListAttachedPolicies", - "iot:ListCertificates", - "iot:ListPrincipalPolicies", - "iot:ListTagsForResource", - "iot:ListThingPrincipals", - "iot:ListThings", - "iotdeviceadvisor:CreateSuiteDefinition", - "iotdeviceadvisor:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotdeviceadvisor:GetSuiteDefinition", - "iotdeviceadvisor:DeleteSuiteDefinition" - ] - }, - "list": { - "permissions": [ - "iotdeviceadvisor:ListSuiteDefinitions" - ] - }, - "read": { - "permissions": [ - "iotdeviceadvisor:GetSuiteDefinition", - "iotdeviceadvisor:TagResource" - ] - }, - "update": { - "permissions": [ - "iot:DescribeCertificate", - "iot:DescribeThing", - "iot:GetPolicy", - "iot:ListAttachedPolicies", - "iot:ListCertificates", - "iot:ListPrincipalPolicies", - "iot:ListTagsForResource", - "iot:ListThingPrincipals", - "iot:ListThings", - "iotdeviceadvisor:UpdateSuiteDefinition", - "iotdeviceadvisor:GetSuiteDefinition", - "iotdeviceadvisor:UntagResource", - "iotdeviceadvisor:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/SuiteDefinitionId" - ], - "properties": { - "SuiteDefinitionArn": { - "description": "The Amazon Resource name for the suite definition.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "SuiteDefinitionConfiguration": { - "additionalProperties": false, - "properties": { - "DevicePermissionRoleArn": { - "$ref": "#/definitions/DevicePermissionRoleArn" - }, - "Devices": { - "$ref": "#/definitions/Devices" - }, - "IntendedForQualification": { - "$ref": "#/definitions/IntendedForQualification" - }, - "RootGroup": { - "$ref": "#/definitions/RootGroup" - }, - "SuiteDefinitionName": { - "$ref": "#/definitions/SuiteDefinitionName" - } - }, - "required": [ - "DevicePermissionRoleArn", - "RootGroup" - ], - "type": "object" - }, - "SuiteDefinitionId": { - "description": "The unique identifier for the suite definition.", - "maxLength": 36, - "minLength": 12, - "type": "string" - }, - "SuiteDefinitionVersion": { - "description": "The suite definition version of a test suite.", - "maxLength": 255, - "minLength": 2, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/SuiteDefinitionId", - "/properties/SuiteDefinitionArn", - "/properties/SuiteDefinitionVersion" - ], - "required": [ - "SuiteDefinitionConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-device-advisor.git", - "typeName": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition" -} +{ + "additionalProperties": false, + "definitions": { + "DevicePermissionRoleArn": { + "description": "The device permission role arn of the test suite.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "DeviceUnderTest": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ThingArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "type": "object" + }, + "Devices": { + "description": "The devices being tested in the test suite", + "items": { + "$ref": "#/definitions/DeviceUnderTest" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "IntendedForQualification": { + "description": "Whether the tests are intended for qualification in a suite.", + "type": "boolean" + }, + "RootGroup": { + "description": "The root group of the test suite.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "SuiteDefinitionName": { + "description": "The Name of the suite definition.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "iot:DescribeCertificate", + "iot:DescribeThing", + "iot:GetPolicy", + "iot:ListAttachedPolicies", + "iot:ListCertificates", + "iot:ListPrincipalPolicies", + "iot:ListTagsForResource", + "iot:ListThingPrincipals", + "iot:ListThings", + "iotdeviceadvisor:CreateSuiteDefinition", + "iotdeviceadvisor:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotdeviceadvisor:GetSuiteDefinition", + "iotdeviceadvisor:DeleteSuiteDefinition" + ] + }, + "list": { + "permissions": [ + "iotdeviceadvisor:ListSuiteDefinitions" + ] + }, + "read": { + "permissions": [ + "iotdeviceadvisor:GetSuiteDefinition", + "iotdeviceadvisor:TagResource" + ] + }, + "update": { + "permissions": [ + "iot:DescribeCertificate", + "iot:DescribeThing", + "iot:GetPolicy", + "iot:ListAttachedPolicies", + "iot:ListCertificates", + "iot:ListPrincipalPolicies", + "iot:ListTagsForResource", + "iot:ListThingPrincipals", + "iot:ListThings", + "iotdeviceadvisor:UpdateSuiteDefinition", + "iotdeviceadvisor:GetSuiteDefinition", + "iotdeviceadvisor:UntagResource", + "iotdeviceadvisor:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/SuiteDefinitionId" + ], + "properties": { + "SuiteDefinitionArn": { + "description": "The Amazon Resource name for the suite definition.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "SuiteDefinitionConfiguration": { + "additionalProperties": false, + "properties": { + "DevicePermissionRoleArn": { + "$ref": "#/definitions/DevicePermissionRoleArn" + }, + "Devices": { + "$ref": "#/definitions/Devices" + }, + "IntendedForQualification": { + "$ref": "#/definitions/IntendedForQualification" + }, + "RootGroup": { + "$ref": "#/definitions/RootGroup" + }, + "SuiteDefinitionName": { + "$ref": "#/definitions/SuiteDefinitionName" + } + }, + "required": [ + "DevicePermissionRoleArn", + "RootGroup" + ], + "type": "object" + }, + "SuiteDefinitionId": { + "description": "The unique identifier for the suite definition.", + "maxLength": 36, + "minLength": 12, + "type": "string" + }, + "SuiteDefinitionVersion": { + "description": "The suite definition version of a test suite.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/SuiteDefinitionId", + "/properties/SuiteDefinitionArn", + "/properties/SuiteDefinitionVersion" + ], + "required": [ + "SuiteDefinitionConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-device-advisor.git", + "typeName": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition" +} diff --git a/schema/aws-iotevents-alarmmodel.json b/schema/aws-iotevents-alarmmodel.json index 6b7874d..dc571f9 100644 --- a/schema/aws-iotevents-alarmmodel.json +++ b/schema/aws-iotevents-alarmmodel.json @@ -1,561 +1,561 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AlarmModelName", - "/properties/Key" - ], - "definitions": { - "AcknowledgeFlow": { - "additionalProperties": false, - "description": "Specifies whether to get notified for alarm state changes.", - "properties": { - "Enabled": { - "default": "true", - "description": "The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.", - "type": "boolean" - } - }, - "type": "object" - }, - "AlarmAction": { - "additionalProperties": false, - "description": "The actions to be performed.", - "properties": { - "DynamoDB": { - "$ref": "#/definitions/DynamoDB" - }, - "DynamoDBv2": { - "$ref": "#/definitions/DynamoDBv2" - }, - "Firehose": { - "$ref": "#/definitions/Firehose" - }, - "IotEvents": { - "$ref": "#/definitions/IotEvents" - }, - "IotSiteWise": { - "$ref": "#/definitions/IotSiteWise" - }, - "IotTopicPublish": { - "$ref": "#/definitions/IotTopicPublish" - }, - "Lambda": { - "$ref": "#/definitions/Lambda" - }, - "Sns": { - "$ref": "#/definitions/Sns" - }, - "Sqs": { - "$ref": "#/definitions/Sqs" - } - }, - "type": "object" - }, - "AlarmActions": { - "description": "Specifies one or more supported actions to receive notifications when the alarm state changes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AlarmAction" - }, - "type": "array", - "uniqueItems": false - }, - "AlarmCapabilities": { - "additionalProperties": false, - "description": "Contains the configuration information of alarm state changes", - "properties": { - "AcknowledgeFlow": { - "$ref": "#/definitions/AcknowledgeFlow" - }, - "InitializationConfiguration": { - "$ref": "#/definitions/InitializationConfiguration" - } - }, - "type": "object" - }, - "AlarmEventActions": { - "additionalProperties": false, - "description": "Contains information about one or more alarm actions.", - "properties": { - "AlarmActions": { - "$ref": "#/definitions/AlarmActions" - } - }, - "type": "object" - }, - "AlarmRule": { - "additionalProperties": false, - "description": "Defines when your alarm is invoked.", - "properties": { - "SimpleRule": { - "$ref": "#/definitions/SimpleRule" - } - }, - "type": "object" - }, - "AssetPropertyTimestamp": { - "additionalProperties": false, - "description": "A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "OffsetInNanos": { - "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression.", - "type": "string" - }, - "TimeInSeconds": { - "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression.", - "type": "string" - } - }, - "required": [ - "TimeInSeconds" - ], - "type": "object" - }, - "AssetPropertyValue": { - "additionalProperties": false, - "description": "A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "Quality": { - "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression.", - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/AssetPropertyTimestamp" - }, - "Value": { - "$ref": "#/definitions/AssetPropertyVariant" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "AssetPropertyVariant": { - "additionalProperties": false, - "description": "A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "BooleanValue": { - "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.", - "type": "string" - }, - "DoubleValue": { - "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.", - "type": "string" - }, - "IntegerValue": { - "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.", - "type": "string" - }, - "StringValue": { - "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.", - "type": "string" - } - }, - "type": "object" - }, - "DynamoDB": { - "additionalProperties": false, - "description": "Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*.", - "properties": { - "HashKeyField": { - "description": "The name of the hash key (also called the partition key).", - "type": "string" - }, - "HashKeyType": { - "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`.", - "type": "string" - }, - "HashKeyValue": { - "description": "The value of the hash key (also called the partition key).", - "type": "string" - }, - "Operation": { - "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - }, - "PayloadField": { - "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`.", - "type": "string" - }, - "RangeKeyField": { - "description": "The name of the range key (also called the sort key).", - "type": "string" - }, - "RangeKeyType": { - "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`.", - "type": "string" - }, - "RangeKeyValue": { - "description": "The value of the range key (also called the sort key).", - "type": "string" - }, - "TableName": { - "description": "The name of the DynamoDB table.", - "type": "string" - } - }, - "required": [ - "HashKeyField", - "HashKeyValue", - "TableName" - ], - "type": "object" - }, - "DynamoDBv2": { - "additionalProperties": false, - "description": "Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n\nYou can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.", - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "TableName": { - "description": "The name of the DynamoDB table.", - "type": "string" - } - }, - "required": [ - "TableName" - ], - "type": "object" - }, - "Firehose": { - "additionalProperties": false, - "description": "Sends information about the alarm model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.", - "properties": { - "DeliveryStreamName": { - "description": "The name of the Kinesis Data Firehose delivery stream where the data is written.", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - }, - "Separator": { - "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).", - "pattern": "([\\n\\t])|(\\r\\n)|(,)", - "type": "string" - } - }, - "required": [ - "DeliveryStreamName" - ], - "type": "object" - }, - "InitializationConfiguration": { - "additionalProperties": false, - "description": "Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.", - "properties": { - "DisabledOnInitialization": { - "default": "true", - "description": "The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE.", - "type": "boolean" - } - }, - "required": [ - "DisabledOnInitialization" - ], - "type": "object" - }, - "IotEvents": { - "additionalProperties": false, - "description": "Sends an AWS IoT Events input, passing in information about the alarm model instance and the event that triggered the action.", - "properties": { - "InputName": { - "description": "The name of the AWS IoT Events input where the data is sent.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "InputName" - ], - "type": "object" - }, - "IotSiteWise": { - "additionalProperties": false, - "description": "Sends information about the alarm model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.", - "properties": { - "AssetId": { - "description": "The ID of the asset that has the specified property. You can specify an expression.", - "type": "string" - }, - "EntryId": { - "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.", - "type": "string" - }, - "PropertyAlias": { - "description": "The alias of the asset property. You can also specify an expression.", - "type": "string" - }, - "PropertyId": { - "description": "The ID of the asset property. You can specify an expression.", - "type": "string" - }, - "PropertyValue": { - "$ref": "#/definitions/AssetPropertyValue" - } - }, - "type": "object" - }, - "IotTopicPublish": { - "additionalProperties": false, - "description": "Information required to publish the MQTT message through the AWS IoT message broker.", - "properties": { - "MqttTopic": { - "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "MqttTopic" - ], - "type": "object" - }, - "Lambda": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "description": "The ARN of the Lambda function that is executed.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "FunctionArn" - ], - "type": "object" - }, - "Payload": { - "additionalProperties": false, - "description": "Information needed to configure the payload.\n\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.", - "properties": { - "ContentExpression": { - "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB.", - "minLength": 1, - "type": "string" - }, - "Type": { - "description": "The value of the payload type can be either `STRING` or `JSON`.", - "type": "string" - } - }, - "required": [ - "ContentExpression", - "Type" - ], - "type": "object" - }, - "SimpleRule": { - "additionalProperties": false, - "description": "A rule that compares an input property value to a threshold value with a comparison operator.", - "properties": { - "ComparisonOperator": { - "description": "The comparison operator.", - "enum": [ - "GREATER", - "GREATER_OR_EQUAL", - "LESS", - "LESS_OR_EQUAL", - "EQUAL", - "NOT_EQUAL" - ], - "type": "string" - }, - "InputProperty": { - "description": "The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Threshold": { - "description": "The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.", - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "InputProperty", - "ComparisonOperator", - "Threshold" - ], - "type": "object" - }, - "Sns": { - "additionalProperties": false, - "description": "Information required to publish the Amazon SNS message.", - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "TargetArn": { - "description": "The ARN of the Amazon SNS target where the message is sent.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TargetArn" - ], - "type": "object" - }, - "Sqs": { - "additionalProperties": false, - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "QueueUrl": { - "description": "The URL of the SQS queue where the data is written.", - "type": "string" - }, - "UseBase64": { - "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`.", - "type": "boolean" - } - }, - "required": [ - "QueueUrl" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Tags to be applied to Input.", - "properties": { - "Key": { - "description": "Key of the Tag.", - "type": "string" - }, - "Value": { - "description": "Value of the Tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.\n\nAlarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.", - "handlers": { - "create": { - "permissions": [ - "iotevents:CreateAlarmModel", - "iotevents:UpdateInputRouting", - "iotevents:DescribeAlarmModel", - "iotevents:ListTagsForResource", - "iotevents:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotevents:DeleteAlarmModel", - "iotevents:DescribeAlarmModel" - ] - }, - "list": { - "permissions": [ - "iotevents:ListAlarmModels" - ] - }, - "read": { - "permissions": [ - "iotevents:DescribeAlarmModel", - "iotevents:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotevents:UpdateAlarmModel", - "iotevents:UpdateInputRouting", - "iotevents:DescribeAlarmModel", - "iotevents:ListTagsForResource", - "iotevents:UntagResource", - "iotevents:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AlarmModelName" - ], - "properties": { - "AlarmCapabilities": { - "$ref": "#/definitions/AlarmCapabilities" - }, - "AlarmEventActions": { - "$ref": "#/definitions/AlarmEventActions" - }, - "AlarmModelDescription": { - "description": "A brief description of the alarm model.", - "maxLength": 1024, - "type": "string" - }, - "AlarmModelName": { - "description": "The name of the alarm model.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "AlarmRule": { - "$ref": "#/definitions/AlarmRule" - }, - "Key": { - "description": "The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.", - "maxLength": 128, - "minLength": 1, - "pattern": "^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w\\- ]+`)|([\\w\\-]+)))*$", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Severity": { - "description": "A non-negative integer that reflects the severity level of the alarm.\n\n", - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "RoleArn", - "AlarmRule" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::IoTEvents::AlarmModel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AlarmModelName", + "/properties/Key" + ], + "definitions": { + "AcknowledgeFlow": { + "additionalProperties": false, + "description": "Specifies whether to get notified for alarm state changes.", + "properties": { + "Enabled": { + "default": "true", + "description": "The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.", + "type": "boolean" + } + }, + "type": "object" + }, + "AlarmAction": { + "additionalProperties": false, + "description": "The actions to be performed.", + "properties": { + "DynamoDB": { + "$ref": "#/definitions/DynamoDB" + }, + "DynamoDBv2": { + "$ref": "#/definitions/DynamoDBv2" + }, + "Firehose": { + "$ref": "#/definitions/Firehose" + }, + "IotEvents": { + "$ref": "#/definitions/IotEvents" + }, + "IotSiteWise": { + "$ref": "#/definitions/IotSiteWise" + }, + "IotTopicPublish": { + "$ref": "#/definitions/IotTopicPublish" + }, + "Lambda": { + "$ref": "#/definitions/Lambda" + }, + "Sns": { + "$ref": "#/definitions/Sns" + }, + "Sqs": { + "$ref": "#/definitions/Sqs" + } + }, + "type": "object" + }, + "AlarmActions": { + "description": "Specifies one or more supported actions to receive notifications when the alarm state changes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AlarmAction" + }, + "type": "array", + "uniqueItems": false + }, + "AlarmCapabilities": { + "additionalProperties": false, + "description": "Contains the configuration information of alarm state changes", + "properties": { + "AcknowledgeFlow": { + "$ref": "#/definitions/AcknowledgeFlow" + }, + "InitializationConfiguration": { + "$ref": "#/definitions/InitializationConfiguration" + } + }, + "type": "object" + }, + "AlarmEventActions": { + "additionalProperties": false, + "description": "Contains information about one or more alarm actions.", + "properties": { + "AlarmActions": { + "$ref": "#/definitions/AlarmActions" + } + }, + "type": "object" + }, + "AlarmRule": { + "additionalProperties": false, + "description": "Defines when your alarm is invoked.", + "properties": { + "SimpleRule": { + "$ref": "#/definitions/SimpleRule" + } + }, + "type": "object" + }, + "AssetPropertyTimestamp": { + "additionalProperties": false, + "description": "A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "OffsetInNanos": { + "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression.", + "type": "string" + }, + "TimeInSeconds": { + "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression.", + "type": "string" + } + }, + "required": [ + "TimeInSeconds" + ], + "type": "object" + }, + "AssetPropertyValue": { + "additionalProperties": false, + "description": "A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "Quality": { + "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression.", + "type": "string" + }, + "Timestamp": { + "$ref": "#/definitions/AssetPropertyTimestamp" + }, + "Value": { + "$ref": "#/definitions/AssetPropertyVariant" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "AssetPropertyVariant": { + "additionalProperties": false, + "description": "A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "BooleanValue": { + "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.", + "type": "string" + }, + "DoubleValue": { + "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.", + "type": "string" + }, + "IntegerValue": { + "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.", + "type": "string" + }, + "StringValue": { + "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.", + "type": "string" + } + }, + "type": "object" + }, + "DynamoDB": { + "additionalProperties": false, + "description": "Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*.", + "properties": { + "HashKeyField": { + "description": "The name of the hash key (also called the partition key).", + "type": "string" + }, + "HashKeyType": { + "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`.", + "type": "string" + }, + "HashKeyValue": { + "description": "The value of the hash key (also called the partition key).", + "type": "string" + }, + "Operation": { + "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + }, + "PayloadField": { + "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`.", + "type": "string" + }, + "RangeKeyField": { + "description": "The name of the range key (also called the sort key).", + "type": "string" + }, + "RangeKeyType": { + "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`.", + "type": "string" + }, + "RangeKeyValue": { + "description": "The value of the range key (also called the sort key).", + "type": "string" + }, + "TableName": { + "description": "The name of the DynamoDB table.", + "type": "string" + } + }, + "required": [ + "HashKeyField", + "HashKeyValue", + "TableName" + ], + "type": "object" + }, + "DynamoDBv2": { + "additionalProperties": false, + "description": "Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n\nYou can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.", + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "TableName": { + "description": "The name of the DynamoDB table.", + "type": "string" + } + }, + "required": [ + "TableName" + ], + "type": "object" + }, + "Firehose": { + "additionalProperties": false, + "description": "Sends information about the alarm model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.", + "properties": { + "DeliveryStreamName": { + "description": "The name of the Kinesis Data Firehose delivery stream where the data is written.", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + }, + "Separator": { + "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).", + "pattern": "([\\n\\t])|(\\r\\n)|(,)", + "type": "string" + } + }, + "required": [ + "DeliveryStreamName" + ], + "type": "object" + }, + "InitializationConfiguration": { + "additionalProperties": false, + "description": "Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.", + "properties": { + "DisabledOnInitialization": { + "default": "true", + "description": "The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE.", + "type": "boolean" + } + }, + "required": [ + "DisabledOnInitialization" + ], + "type": "object" + }, + "IotEvents": { + "additionalProperties": false, + "description": "Sends an AWS IoT Events input, passing in information about the alarm model instance and the event that triggered the action.", + "properties": { + "InputName": { + "description": "The name of the AWS IoT Events input where the data is sent.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "InputName" + ], + "type": "object" + }, + "IotSiteWise": { + "additionalProperties": false, + "description": "Sends information about the alarm model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.", + "properties": { + "AssetId": { + "description": "The ID of the asset that has the specified property. You can specify an expression.", + "type": "string" + }, + "EntryId": { + "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.", + "type": "string" + }, + "PropertyAlias": { + "description": "The alias of the asset property. You can also specify an expression.", + "type": "string" + }, + "PropertyId": { + "description": "The ID of the asset property. You can specify an expression.", + "type": "string" + }, + "PropertyValue": { + "$ref": "#/definitions/AssetPropertyValue" + } + }, + "type": "object" + }, + "IotTopicPublish": { + "additionalProperties": false, + "description": "Information required to publish the MQTT message through the AWS IoT message broker.", + "properties": { + "MqttTopic": { + "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "MqttTopic" + ], + "type": "object" + }, + "Lambda": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "description": "The ARN of the Lambda function that is executed.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "FunctionArn" + ], + "type": "object" + }, + "Payload": { + "additionalProperties": false, + "description": "Information needed to configure the payload.\n\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.", + "properties": { + "ContentExpression": { + "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB.", + "minLength": 1, + "type": "string" + }, + "Type": { + "description": "The value of the payload type can be either `STRING` or `JSON`.", + "type": "string" + } + }, + "required": [ + "ContentExpression", + "Type" + ], + "type": "object" + }, + "SimpleRule": { + "additionalProperties": false, + "description": "A rule that compares an input property value to a threshold value with a comparison operator.", + "properties": { + "ComparisonOperator": { + "description": "The comparison operator.", + "enum": [ + "GREATER", + "GREATER_OR_EQUAL", + "LESS", + "LESS_OR_EQUAL", + "EQUAL", + "NOT_EQUAL" + ], + "type": "string" + }, + "InputProperty": { + "description": "The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Threshold": { + "description": "The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.", + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "InputProperty", + "ComparisonOperator", + "Threshold" + ], + "type": "object" + }, + "Sns": { + "additionalProperties": false, + "description": "Information required to publish the Amazon SNS message.", + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "TargetArn": { + "description": "The ARN of the Amazon SNS target where the message is sent.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TargetArn" + ], + "type": "object" + }, + "Sqs": { + "additionalProperties": false, + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "QueueUrl": { + "description": "The URL of the SQS queue where the data is written.", + "type": "string" + }, + "UseBase64": { + "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`.", + "type": "boolean" + } + }, + "required": [ + "QueueUrl" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tags to be applied to Input.", + "properties": { + "Key": { + "description": "Key of the Tag.", + "type": "string" + }, + "Value": { + "description": "Value of the Tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.\n\nAlarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.", + "handlers": { + "create": { + "permissions": [ + "iotevents:CreateAlarmModel", + "iotevents:UpdateInputRouting", + "iotevents:DescribeAlarmModel", + "iotevents:ListTagsForResource", + "iotevents:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotevents:DeleteAlarmModel", + "iotevents:DescribeAlarmModel" + ] + }, + "list": { + "permissions": [ + "iotevents:ListAlarmModels" + ] + }, + "read": { + "permissions": [ + "iotevents:DescribeAlarmModel", + "iotevents:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotevents:UpdateAlarmModel", + "iotevents:UpdateInputRouting", + "iotevents:DescribeAlarmModel", + "iotevents:ListTagsForResource", + "iotevents:UntagResource", + "iotevents:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AlarmModelName" + ], + "properties": { + "AlarmCapabilities": { + "$ref": "#/definitions/AlarmCapabilities" + }, + "AlarmEventActions": { + "$ref": "#/definitions/AlarmEventActions" + }, + "AlarmModelDescription": { + "description": "A brief description of the alarm model.", + "maxLength": 1024, + "type": "string" + }, + "AlarmModelName": { + "description": "The name of the alarm model.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "AlarmRule": { + "$ref": "#/definitions/AlarmRule" + }, + "Key": { + "description": "The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.", + "maxLength": 128, + "minLength": 1, + "pattern": "^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w\\- ]+`)|([\\w\\-]+)))*$", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Severity": { + "description": "A non-negative integer that reflects the severity level of the alarm.\n\n", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "RoleArn", + "AlarmRule" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::IoTEvents::AlarmModel" +} diff --git a/schema/aws-iotevents-detectormodel.json b/schema/aws-iotevents-detectormodel.json index 395c083..fe331a6 100644 --- a/schema/aws-iotevents-detectormodel.json +++ b/schema/aws-iotevents-detectormodel.json @@ -1,727 +1,727 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DetectorModelName", - "/properties/Key" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "The actions to be performed.", - "properties": { - "ClearTimer": { - "$ref": "#/definitions/ClearTimer" - }, - "DynamoDB": { - "$ref": "#/definitions/DynamoDB" - }, - "DynamoDBv2": { - "$ref": "#/definitions/DynamoDBv2" - }, - "Firehose": { - "$ref": "#/definitions/Firehose" - }, - "IotEvents": { - "$ref": "#/definitions/IotEvents" - }, - "IotSiteWise": { - "$ref": "#/definitions/IotSiteWise" - }, - "IotTopicPublish": { - "$ref": "#/definitions/IotTopicPublish" - }, - "Lambda": { - "$ref": "#/definitions/Lambda" - }, - "ResetTimer": { - "$ref": "#/definitions/ResetTimer" - }, - "SetTimer": { - "$ref": "#/definitions/SetTimer" - }, - "SetVariable": { - "$ref": "#/definitions/SetVariable" - }, - "Sns": { - "$ref": "#/definitions/Sns" - }, - "Sqs": { - "$ref": "#/definitions/Sqs" - } - }, - "type": "object" - }, - "AssetPropertyTimestamp": { - "additionalProperties": false, - "description": "A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "OffsetInNanos": { - "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression.", - "type": "string" - }, - "TimeInSeconds": { - "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression.", - "type": "string" - } - }, - "required": [ - "TimeInSeconds" - ], - "type": "object" - }, - "AssetPropertyValue": { - "additionalProperties": false, - "description": "A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "Quality": { - "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression.", - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/AssetPropertyTimestamp" - }, - "Value": { - "$ref": "#/definitions/AssetPropertyVariant" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "AssetPropertyVariant": { - "additionalProperties": false, - "description": "A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*.", - "properties": { - "BooleanValue": { - "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.", - "type": "string" - }, - "DoubleValue": { - "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.", - "type": "string" - }, - "IntegerValue": { - "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.", - "type": "string" - }, - "StringValue": { - "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.", - "type": "string" - } - }, - "type": "object" - }, - "ClearTimer": { - "additionalProperties": false, - "description": "Information needed to clear the timer.", - "properties": { - "TimerName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TimerName" - ], - "type": "object" - }, - "DetectorModelDefinition": { - "additionalProperties": false, - "description": "Information that defines how a detector operates.", - "properties": { - "InitialStateName": { - "description": "The state that is entered at the creation of each detector (instance).", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "States": { - "description": "Information about the states of the detector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/State" - }, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "States", - "InitialStateName" - ], - "type": "object" - }, - "DynamoDB": { - "additionalProperties": false, - "description": "Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*.", - "properties": { - "HashKeyField": { - "description": "The name of the hash key (also called the partition key).", - "type": "string" - }, - "HashKeyType": { - "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`.", - "type": "string" - }, - "HashKeyValue": { - "description": "The value of the hash key (also called the partition key).", - "type": "string" - }, - "Operation": { - "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - }, - "PayloadField": { - "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`.", - "type": "string" - }, - "RangeKeyField": { - "description": "The name of the range key (also called the sort key).", - "type": "string" - }, - "RangeKeyType": { - "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`.", - "type": "string" - }, - "RangeKeyValue": { - "description": "The value of the range key (also called the sort key).", - "type": "string" - }, - "TableName": { - "description": "The name of the DynamoDB table.", - "type": "string" - } - }, - "required": [ - "HashKeyField", - "HashKeyValue", - "TableName" - ], - "type": "object" - }, - "DynamoDBv2": { - "additionalProperties": false, - "description": "Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n\nYou can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.", - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "TableName": { - "description": "The name of the DynamoDB table.", - "type": "string" - } - }, - "required": [ - "TableName" - ], - "type": "object" - }, - "Event": { - "additionalProperties": false, - "description": "Specifies the `actions` to be performed when the `condition` evaluates to `TRUE`.", - "properties": { - "Actions": { - "description": "The actions to be performed.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": false - }, - "Condition": { - "description": "The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`).", - "maxLength": 512, - "type": "string" - }, - "EventName": { - "description": "The name of the event.", - "maxLength": 128, - "type": "string" - } - }, - "required": [ - "EventName" - ], - "type": "object" - }, - "Firehose": { - "additionalProperties": false, - "description": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.", - "properties": { - "DeliveryStreamName": { - "description": "The name of the Kinesis Data Firehose delivery stream where the data is written.", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - }, - "Separator": { - "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).", - "pattern": "([\\n\\t])|(\\r\\n)|(,)", - "type": "string" - } - }, - "required": [ - "DeliveryStreamName" - ], - "type": "object" - }, - "IotEvents": { - "additionalProperties": false, - "description": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.", - "properties": { - "InputName": { - "description": "The name of the AWS IoT Events input where the data is sent.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "InputName" - ], - "type": "object" - }, - "IotSiteWise": { - "additionalProperties": false, - "description": "Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.", - "properties": { - "AssetId": { - "description": "The ID of the asset that has the specified property. You can specify an expression.", - "type": "string" - }, - "EntryId": { - "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.", - "type": "string" - }, - "PropertyAlias": { - "description": "The alias of the asset property. You can also specify an expression.", - "type": "string" - }, - "PropertyId": { - "description": "The ID of the asset property. You can specify an expression.", - "type": "string" - }, - "PropertyValue": { - "$ref": "#/definitions/AssetPropertyValue" - } - }, - "required": [ - "PropertyValue" - ], - "type": "object" - }, - "IotTopicPublish": { - "additionalProperties": false, - "description": "Information required to publish the MQTT message through the AWS IoT message broker.", - "properties": { - "MqttTopic": { - "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "MqttTopic" - ], - "type": "object" - }, - "Lambda": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "description": "The ARN of the Lambda function that is executed.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/Payload" - } - }, - "required": [ - "FunctionArn" - ], - "type": "object" - }, - "OnEnter": { - "additionalProperties": false, - "description": "When entering this state, perform these `actions` if the `condition` is `TRUE`.", - "properties": { - "Events": { - "description": "Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Event" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OnExit": { - "additionalProperties": false, - "description": "When exiting this state, perform these `actions` if the specified `condition` is `TRUE`.", - "properties": { - "Events": { - "description": "Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Event" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OnInput": { - "additionalProperties": false, - "description": "When an input is received and the `condition` is `TRUE`, perform the specified `actions`.", - "properties": { - "Events": { - "description": "Specifies the `actions` performed when the `condition` evaluates to `TRUE`.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Event" - }, - "type": "array", - "uniqueItems": false - }, - "TransitionEvents": { - "description": "Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TransitionEvent" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Payload": { - "additionalProperties": false, - "description": "Information needed to configure the payload.\n\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.", - "properties": { - "ContentExpression": { - "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB.", - "minLength": 1, - "type": "string" - }, - "Type": { - "description": "The value of the payload type can be either `STRING` or `JSON`.", - "type": "string" - } - }, - "required": [ - "ContentExpression", - "Type" - ], - "type": "object" - }, - "ResetTimer": { - "additionalProperties": false, - "description": "Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.", - "properties": { - "TimerName": { - "description": "The name of the timer to reset.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TimerName" - ], - "type": "object" - }, - "SetTimer": { - "additionalProperties": false, - "description": "Information needed to set the timer.", - "properties": { - "DurationExpression": { - "description": "The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (`$variable.`), and input values (`$input..`) as the duration. The range of the duration is `1-31622400` seconds. To ensure accuracy, the minimum duration is `60` seconds. The evaluated result of the duration is rounded down to the nearest whole number.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Seconds": { - "description": "The number of seconds until the timer expires. The minimum value is `60` seconds to ensure accuracy. The maximum value is `31622400` seconds.", - "maximum": 31622400, - "minimum": 60, - "type": "integer" - }, - "TimerName": { - "description": "The name of the timer.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TimerName" - ], - "type": "object" - }, - "SetVariable": { - "additionalProperties": false, - "description": "Information about the variable and its new value.", - "properties": { - "Value": { - "description": "The new value of the variable.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "VariableName": { - "description": "The name of the variable.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - } - }, - "required": [ - "Value", - "VariableName" - ], - "type": "object" - }, - "Sns": { - "additionalProperties": false, - "description": "Information required to publish the Amazon SNS message.", - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "TargetArn": { - "description": "The ARN of the Amazon SNS target where the message is sent.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "TargetArn" - ], - "type": "object" - }, - "Sqs": { - "additionalProperties": false, - "properties": { - "Payload": { - "$ref": "#/definitions/Payload" - }, - "QueueUrl": { - "description": "The URL of the SQS queue where the data is written.", - "type": "string" - }, - "UseBase64": { - "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`.", - "type": "boolean" - } - }, - "required": [ - "QueueUrl" - ], - "type": "object" - }, - "State": { - "additionalProperties": false, - "description": "Information that defines a state of a detector.", - "properties": { - "OnEnter": { - "$ref": "#/definitions/OnEnter" - }, - "OnExit": { - "$ref": "#/definitions/OnExit" - }, - "OnInput": { - "$ref": "#/definitions/OnInput" - }, - "StateName": { - "description": "The name of the state.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "StateName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Tags to be applied to Input.", - "properties": { - "Key": { - "description": "Key of the Tag.", - "type": "string" - }, - "Value": { - "description": "Value of the Tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TransitionEvent": { - "additionalProperties": false, - "description": "Specifies the `actions `performed and the next `state` entered when a `condition` evaluates to `TRUE`.", - "properties": { - "Actions": { - "description": "The actions to be performed.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": false - }, - "Condition": { - "description": "A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered.", - "maxLength": 512, - "type": "string" - }, - "EventName": { - "description": "The name of the event.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NextState": { - "description": "The next state to enter.", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Condition", - "EventName", - "NextState" - ], - "type": "object" - } - }, - "description": "The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "iotevents:CreateDetectorModel", - "iotevents:UpdateInputRouting", - "iotevents:DescribeDetectorModel", - "iotevents:ListTagsForResource", - "iotevents:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotevents:DeleteDetectorModel", - "iotevents:DescribeDetectorModel" - ] - }, - "list": { - "permissions": [ - "iotevents:ListDetectorModels" - ] - }, - "read": { - "permissions": [ - "iotevents:DescribeDetectorModel", - "iotevents:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotevents:UpdateDetectorModel", - "iotevents:UpdateInputRouting", - "iotevents:DescribeDetectorModel", - "iotevents:ListTagsForResource", - "iotevents:UntagResource", - "iotevents:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DetectorModelName" - ], - "properties": { - "DetectorModelDefinition": { - "$ref": "#/definitions/DetectorModelDefinition" - }, - "DetectorModelDescription": { - "description": "A brief description of the detector model.", - "maxLength": 1024, - "type": "string" - }, - "DetectorModelName": { - "description": "The name of the detector model.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "EvaluationMethod": { - "description": "Information about the order in which events are evaluated and how actions are executed.", - "enum": [ - "BATCH", - "SERIAL" - ], - "type": "string" - }, - "Key": { - "description": "The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.", - "maxLength": 128, - "minLength": 1, - "pattern": "^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w\\- ]+`)|([\\w\\-]+)))*$", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "DetectorModelDefinition", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTEvents::DetectorModel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorModelName", + "/properties/Key" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "The actions to be performed.", + "properties": { + "ClearTimer": { + "$ref": "#/definitions/ClearTimer" + }, + "DynamoDB": { + "$ref": "#/definitions/DynamoDB" + }, + "DynamoDBv2": { + "$ref": "#/definitions/DynamoDBv2" + }, + "Firehose": { + "$ref": "#/definitions/Firehose" + }, + "IotEvents": { + "$ref": "#/definitions/IotEvents" + }, + "IotSiteWise": { + "$ref": "#/definitions/IotSiteWise" + }, + "IotTopicPublish": { + "$ref": "#/definitions/IotTopicPublish" + }, + "Lambda": { + "$ref": "#/definitions/Lambda" + }, + "ResetTimer": { + "$ref": "#/definitions/ResetTimer" + }, + "SetTimer": { + "$ref": "#/definitions/SetTimer" + }, + "SetVariable": { + "$ref": "#/definitions/SetVariable" + }, + "Sns": { + "$ref": "#/definitions/Sns" + }, + "Sqs": { + "$ref": "#/definitions/Sqs" + } + }, + "type": "object" + }, + "AssetPropertyTimestamp": { + "additionalProperties": false, + "description": "A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "OffsetInNanos": { + "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression.", + "type": "string" + }, + "TimeInSeconds": { + "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression.", + "type": "string" + } + }, + "required": [ + "TimeInSeconds" + ], + "type": "object" + }, + "AssetPropertyValue": { + "additionalProperties": false, + "description": "A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "Quality": { + "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression.", + "type": "string" + }, + "Timestamp": { + "$ref": "#/definitions/AssetPropertyTimestamp" + }, + "Value": { + "$ref": "#/definitions/AssetPropertyVariant" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "AssetPropertyVariant": { + "additionalProperties": false, + "description": "A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*.", + "properties": { + "BooleanValue": { + "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.", + "type": "string" + }, + "DoubleValue": { + "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.", + "type": "string" + }, + "IntegerValue": { + "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.", + "type": "string" + }, + "StringValue": { + "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.", + "type": "string" + } + }, + "type": "object" + }, + "ClearTimer": { + "additionalProperties": false, + "description": "Information needed to clear the timer.", + "properties": { + "TimerName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TimerName" + ], + "type": "object" + }, + "DetectorModelDefinition": { + "additionalProperties": false, + "description": "Information that defines how a detector operates.", + "properties": { + "InitialStateName": { + "description": "The state that is entered at the creation of each detector (instance).", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "States": { + "description": "Information about the states of the detector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/State" + }, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "States", + "InitialStateName" + ], + "type": "object" + }, + "DynamoDB": { + "additionalProperties": false, + "description": "Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*.", + "properties": { + "HashKeyField": { + "description": "The name of the hash key (also called the partition key).", + "type": "string" + }, + "HashKeyType": { + "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`.", + "type": "string" + }, + "HashKeyValue": { + "description": "The value of the hash key (also called the partition key).", + "type": "string" + }, + "Operation": { + "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + }, + "PayloadField": { + "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`.", + "type": "string" + }, + "RangeKeyField": { + "description": "The name of the range key (also called the sort key).", + "type": "string" + }, + "RangeKeyType": { + "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`.", + "type": "string" + }, + "RangeKeyValue": { + "description": "The value of the range key (also called the sort key).", + "type": "string" + }, + "TableName": { + "description": "The name of the DynamoDB table.", + "type": "string" + } + }, + "required": [ + "HashKeyField", + "HashKeyValue", + "TableName" + ], + "type": "object" + }, + "DynamoDBv2": { + "additionalProperties": false, + "description": "Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n\nYou can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.", + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "TableName": { + "description": "The name of the DynamoDB table.", + "type": "string" + } + }, + "required": [ + "TableName" + ], + "type": "object" + }, + "Event": { + "additionalProperties": false, + "description": "Specifies the `actions` to be performed when the `condition` evaluates to `TRUE`.", + "properties": { + "Actions": { + "description": "The actions to be performed.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": false + }, + "Condition": { + "description": "The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`).", + "maxLength": 512, + "type": "string" + }, + "EventName": { + "description": "The name of the event.", + "maxLength": 128, + "type": "string" + } + }, + "required": [ + "EventName" + ], + "type": "object" + }, + "Firehose": { + "additionalProperties": false, + "description": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.", + "properties": { + "DeliveryStreamName": { + "description": "The name of the Kinesis Data Firehose delivery stream where the data is written.", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + }, + "Separator": { + "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).", + "pattern": "([\\n\\t])|(\\r\\n)|(,)", + "type": "string" + } + }, + "required": [ + "DeliveryStreamName" + ], + "type": "object" + }, + "IotEvents": { + "additionalProperties": false, + "description": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.", + "properties": { + "InputName": { + "description": "The name of the AWS IoT Events input where the data is sent.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "InputName" + ], + "type": "object" + }, + "IotSiteWise": { + "additionalProperties": false, + "description": "Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.", + "properties": { + "AssetId": { + "description": "The ID of the asset that has the specified property. You can specify an expression.", + "type": "string" + }, + "EntryId": { + "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.", + "type": "string" + }, + "PropertyAlias": { + "description": "The alias of the asset property. You can also specify an expression.", + "type": "string" + }, + "PropertyId": { + "description": "The ID of the asset property. You can specify an expression.", + "type": "string" + }, + "PropertyValue": { + "$ref": "#/definitions/AssetPropertyValue" + } + }, + "required": [ + "PropertyValue" + ], + "type": "object" + }, + "IotTopicPublish": { + "additionalProperties": false, + "description": "Information required to publish the MQTT message through the AWS IoT message broker.", + "properties": { + "MqttTopic": { + "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "MqttTopic" + ], + "type": "object" + }, + "Lambda": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "description": "The ARN of the Lambda function that is executed.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Payload": { + "$ref": "#/definitions/Payload" + } + }, + "required": [ + "FunctionArn" + ], + "type": "object" + }, + "OnEnter": { + "additionalProperties": false, + "description": "When entering this state, perform these `actions` if the `condition` is `TRUE`.", + "properties": { + "Events": { + "description": "Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Event" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OnExit": { + "additionalProperties": false, + "description": "When exiting this state, perform these `actions` if the specified `condition` is `TRUE`.", + "properties": { + "Events": { + "description": "Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Event" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OnInput": { + "additionalProperties": false, + "description": "When an input is received and the `condition` is `TRUE`, perform the specified `actions`.", + "properties": { + "Events": { + "description": "Specifies the `actions` performed when the `condition` evaluates to `TRUE`.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Event" + }, + "type": "array", + "uniqueItems": false + }, + "TransitionEvents": { + "description": "Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TransitionEvent" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Payload": { + "additionalProperties": false, + "description": "Information needed to configure the payload.\n\nBy default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.", + "properties": { + "ContentExpression": { + "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB.", + "minLength": 1, + "type": "string" + }, + "Type": { + "description": "The value of the payload type can be either `STRING` or `JSON`.", + "type": "string" + } + }, + "required": [ + "ContentExpression", + "Type" + ], + "type": "object" + }, + "ResetTimer": { + "additionalProperties": false, + "description": "Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.", + "properties": { + "TimerName": { + "description": "The name of the timer to reset.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TimerName" + ], + "type": "object" + }, + "SetTimer": { + "additionalProperties": false, + "description": "Information needed to set the timer.", + "properties": { + "DurationExpression": { + "description": "The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (`$variable.`), and input values (`$input..`) as the duration. The range of the duration is `1-31622400` seconds. To ensure accuracy, the minimum duration is `60` seconds. The evaluated result of the duration is rounded down to the nearest whole number.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Seconds": { + "description": "The number of seconds until the timer expires. The minimum value is `60` seconds to ensure accuracy. The maximum value is `31622400` seconds.", + "maximum": 31622400, + "minimum": 60, + "type": "integer" + }, + "TimerName": { + "description": "The name of the timer.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TimerName" + ], + "type": "object" + }, + "SetVariable": { + "additionalProperties": false, + "description": "Information about the variable and its new value.", + "properties": { + "Value": { + "description": "The new value of the variable.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "VariableName": { + "description": "The name of the variable.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + } + }, + "required": [ + "Value", + "VariableName" + ], + "type": "object" + }, + "Sns": { + "additionalProperties": false, + "description": "Information required to publish the Amazon SNS message.", + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "TargetArn": { + "description": "The ARN of the Amazon SNS target where the message is sent.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "TargetArn" + ], + "type": "object" + }, + "Sqs": { + "additionalProperties": false, + "properties": { + "Payload": { + "$ref": "#/definitions/Payload" + }, + "QueueUrl": { + "description": "The URL of the SQS queue where the data is written.", + "type": "string" + }, + "UseBase64": { + "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`.", + "type": "boolean" + } + }, + "required": [ + "QueueUrl" + ], + "type": "object" + }, + "State": { + "additionalProperties": false, + "description": "Information that defines a state of a detector.", + "properties": { + "OnEnter": { + "$ref": "#/definitions/OnEnter" + }, + "OnExit": { + "$ref": "#/definitions/OnExit" + }, + "OnInput": { + "$ref": "#/definitions/OnInput" + }, + "StateName": { + "description": "The name of the state.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "StateName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tags to be applied to Input.", + "properties": { + "Key": { + "description": "Key of the Tag.", + "type": "string" + }, + "Value": { + "description": "Value of the Tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TransitionEvent": { + "additionalProperties": false, + "description": "Specifies the `actions `performed and the next `state` entered when a `condition` evaluates to `TRUE`.", + "properties": { + "Actions": { + "description": "The actions to be performed.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": false + }, + "Condition": { + "description": "A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered.", + "maxLength": 512, + "type": "string" + }, + "EventName": { + "description": "The name of the event.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NextState": { + "description": "The next state to enter.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Condition", + "EventName", + "NextState" + ], + "type": "object" + } + }, + "description": "The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "iotevents:CreateDetectorModel", + "iotevents:UpdateInputRouting", + "iotevents:DescribeDetectorModel", + "iotevents:ListTagsForResource", + "iotevents:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotevents:DeleteDetectorModel", + "iotevents:DescribeDetectorModel" + ] + }, + "list": { + "permissions": [ + "iotevents:ListDetectorModels" + ] + }, + "read": { + "permissions": [ + "iotevents:DescribeDetectorModel", + "iotevents:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotevents:UpdateDetectorModel", + "iotevents:UpdateInputRouting", + "iotevents:DescribeDetectorModel", + "iotevents:ListTagsForResource", + "iotevents:UntagResource", + "iotevents:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorModelName" + ], + "properties": { + "DetectorModelDefinition": { + "$ref": "#/definitions/DetectorModelDefinition" + }, + "DetectorModelDescription": { + "description": "A brief description of the detector model.", + "maxLength": 1024, + "type": "string" + }, + "DetectorModelName": { + "description": "The name of the detector model.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "EvaluationMethod": { + "description": "Information about the order in which events are evaluated and how actions are executed.", + "enum": [ + "BATCH", + "SERIAL" + ], + "type": "string" + }, + "Key": { + "description": "The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.", + "maxLength": 128, + "minLength": 1, + "pattern": "^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w\\- ]+`)|([\\w\\-]+)))*$", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "DetectorModelDefinition", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTEvents::DetectorModel" +} diff --git a/schema/aws-iotevents-input.json b/schema/aws-iotevents-input.json index d8c618e..7bb3952 100644 --- a/schema/aws-iotevents-input.json +++ b/schema/aws-iotevents-input.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InputName" - ], - "definitions": { - "Attribute": { - "additionalProperties": false, - "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input.", - "properties": { - "JsonPath": { - "description": "An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors.\n\n_Syntax_: `....`", - "maxLength": 128, - "minLength": 1, - "pattern": "^((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+))(\\.((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+)))*$", - "type": "string" - } - }, - "required": [ - "JsonPath" - ], - "type": "object" - }, - "InputDefinition": { - "additionalProperties": false, - "description": "The definition of the input.", - "properties": { - "Attributes": { - "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Attribute" - }, - "maxItems": 200, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Attributes" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Tags to be applied to Input.", - "properties": { - "Key": { - "description": "Key of the Tag.", - "type": "string" - }, - "Value": { - "description": "Value of the Tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "iotevents:CreateInput", - "iotevents:TagResource", - "iotevents:DescribeInput", - "iotevents:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotevents:DeleteInput", - "iotevents:DescribeInput" - ] - }, - "list": { - "permissions": [ - "iotevents:ListInputs" - ] - }, - "read": { - "permissions": [ - "iotevents:DescribeInput", - "iotevents:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotevents:UpdateInput", - "iotevents:DescribeInput", - "iotevents:ListTagsForResource", - "iotevents:UntagResource", - "iotevents:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/InputName" - ], - "properties": { - "InputDefinition": { - "$ref": "#/definitions/InputDefinition" - }, - "InputDescription": { - "description": "A brief description of the input.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "InputName": { - "description": "The name of the input.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "InputDefinition" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotevents.git", - "taggable": true, - "typeName": "AWS::IoTEvents::Input" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InputName" + ], + "definitions": { + "Attribute": { + "additionalProperties": false, + "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input.", + "properties": { + "JsonPath": { + "description": "An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors.\n\n_Syntax_: `....`", + "maxLength": 128, + "minLength": 1, + "pattern": "^((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+))(\\.((`[a-zA-Z0-9_\\- ]+`)|([a-zA-Z0-9_\\-]+)))*$", + "type": "string" + } + }, + "required": [ + "JsonPath" + ], + "type": "object" + }, + "InputDefinition": { + "additionalProperties": false, + "description": "The definition of the input.", + "properties": { + "Attributes": { + "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Attribute" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Attributes" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tags to be applied to Input.", + "properties": { + "Key": { + "description": "Key of the Tag.", + "type": "string" + }, + "Value": { + "description": "Value of the Tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "iotevents:CreateInput", + "iotevents:TagResource", + "iotevents:DescribeInput", + "iotevents:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotevents:DeleteInput", + "iotevents:DescribeInput" + ] + }, + "list": { + "permissions": [ + "iotevents:ListInputs" + ] + }, + "read": { + "permissions": [ + "iotevents:DescribeInput", + "iotevents:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotevents:UpdateInput", + "iotevents:DescribeInput", + "iotevents:ListTagsForResource", + "iotevents:UntagResource", + "iotevents:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/InputName" + ], + "properties": { + "InputDefinition": { + "$ref": "#/definitions/InputDefinition" + }, + "InputDescription": { + "description": "A brief description of the input.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "InputName": { + "description": "The name of the input.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "InputDefinition" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotevents.git", + "taggable": true, + "typeName": "AWS::IoTEvents::Input" +} diff --git a/schema/aws-iotfleethub-application.json b/schema/aws-iotfleethub-application.json index 5ab0af1..786d6ce 100644 --- a/schema/aws-iotfleethub-application.json +++ b/schema/aws-iotfleethub-application.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTFleetHub::Application", - "handlers": { - "create": { - "permissions": [ - "iotfleethub:CreateApplication", - "iotfleethub:TagResource", - "iam:PassRole", - "sso:CreateManagedApplicationInstance", - "sso:DescribeRegisteredRegions" - ] - }, - "delete": { - "permissions": [ - "iotfleethub:DeleteApplication", - "iotfleethub:DescribeApplication", - "sso:DeleteManagedApplicationInstance" - ] - }, - "list": { - "permissions": [ - "iotfleethub:ListApplications" - ] - }, - "read": { - "permissions": [ - "iotfleethub:DescribeApplication" - ] - }, - "update": { - "permissions": [ - "iotfleethub:UpdateApplication", - "iotfleethub:DescribeApplication", - "iotfleethub:TagResource", - "iotfleethub:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId" - ], - "properties": { - "ApplicationArn": { - "description": "The ARN of the application.", - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:[!-~]+$", - "type": "string" - }, - "ApplicationCreationDate": { - "description": "When the Application was created", - "type": "integer" - }, - "ApplicationDescription": { - "description": "Application Description, should be between 1 and 2048 characters.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[ -~]*$", - "type": "string" - }, - "ApplicationId": { - "description": "The ID of the application.", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "ApplicationLastUpdateDate": { - "description": "When the Application was last updated", - "type": "integer" - }, - "ApplicationName": { - "description": "Application Name, should be between 1 and 256 characters.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[ -~]*$", - "type": "string" - }, - "ApplicationState": { - "description": "The current state of the application.", - "type": "string" - }, - "ApplicationUrl": { - "description": "The URL of the application.", - "type": "string" - }, - "ErrorMessage": { - "description": "A message indicating why Create or Delete Application failed.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax", - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:[!-~]+$", - "type": "string" - }, - "SsoClientId": { - "description": "The AWS SSO application generated client ID (used with AWS SSO APIs).", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/ApplicationId", - "/properties/ApplicationUrl", - "/properties/ApplicationState", - "/properties/ApplicationCreationDate", - "/properties/ApplicationLastUpdateDate", - "/properties/SsoClientId", - "/properties/ErrorMessage" - ], - "required": [ - "ApplicationName", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotfleethub.git", - "typeName": "AWS::IoTFleetHub::Application" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTFleetHub::Application", + "handlers": { + "create": { + "permissions": [ + "iotfleethub:CreateApplication", + "iotfleethub:TagResource", + "iam:PassRole", + "sso:CreateManagedApplicationInstance", + "sso:DescribeRegisteredRegions" + ] + }, + "delete": { + "permissions": [ + "iotfleethub:DeleteApplication", + "iotfleethub:DescribeApplication", + "sso:DeleteManagedApplicationInstance" + ] + }, + "list": { + "permissions": [ + "iotfleethub:ListApplications" + ] + }, + "read": { + "permissions": [ + "iotfleethub:DescribeApplication" + ] + }, + "update": { + "permissions": [ + "iotfleethub:UpdateApplication", + "iotfleethub:DescribeApplication", + "iotfleethub:TagResource", + "iotfleethub:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId" + ], + "properties": { + "ApplicationArn": { + "description": "The ARN of the application.", + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:[!-~]+$", + "type": "string" + }, + "ApplicationCreationDate": { + "description": "When the Application was created", + "type": "integer" + }, + "ApplicationDescription": { + "description": "Application Description, should be between 1 and 2048 characters.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[ -~]*$", + "type": "string" + }, + "ApplicationId": { + "description": "The ID of the application.", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "ApplicationLastUpdateDate": { + "description": "When the Application was last updated", + "type": "integer" + }, + "ApplicationName": { + "description": "Application Name, should be between 1 and 256 characters.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[ -~]*$", + "type": "string" + }, + "ApplicationState": { + "description": "The current state of the application.", + "type": "string" + }, + "ApplicationUrl": { + "description": "The URL of the application.", + "type": "string" + }, + "ErrorMessage": { + "description": "A message indicating why Create or Delete Application failed.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax", + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:[!-~]+$", + "type": "string" + }, + "SsoClientId": { + "description": "The AWS SSO application generated client ID (used with AWS SSO APIs).", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/ApplicationId", + "/properties/ApplicationUrl", + "/properties/ApplicationState", + "/properties/ApplicationCreationDate", + "/properties/ApplicationLastUpdateDate", + "/properties/SsoClientId", + "/properties/ErrorMessage" + ], + "required": [ + "ApplicationName", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotfleethub.git", + "typeName": "AWS::IoTFleetHub::Application" +} diff --git a/schema/aws-iotfleetwise-campaign.json b/schema/aws-iotfleetwise-campaign.json index 4809c8b..d9974fb 100644 --- a/schema/aws-iotfleetwise-campaign.json +++ b/schema/aws-iotfleetwise-campaign.json @@ -1,453 +1,623 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/TargetArn", - "/properties/SignalCatalogArn", - "/properties/PostTriggerCollectionDuration", - "/properties/DiagnosticsMode", - "/properties/SpoolingMode", - "/properties/CollectionScheme", - "/properties/Priority", - "/properties/Compression", - "/properties/StartTime", - "/properties/ExpiryTime" - ], - "definitions": { - "CampaignStatus": { - "enum": [ - "CREATING", - "WAITING_FOR_APPROVAL", - "RUNNING", - "SUSPENDED" - ], - "type": "string" - }, - "CollectionScheme": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "TimeBasedCollectionScheme": { - "$ref": "#/definitions/TimeBasedCollectionScheme" - } - }, - "required": [ - "TimeBasedCollectionScheme" - ], - "title": "TimeBasedCollectionScheme", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ConditionBasedCollectionScheme": { - "$ref": "#/definitions/ConditionBasedCollectionScheme" - } - }, - "required": [ - "ConditionBasedCollectionScheme" - ], - "title": "ConditionBasedCollectionScheme", - "type": "object" - } - ] - }, - "Compression": { - "default": "OFF", - "enum": [ - "OFF", - "SNAPPY" - ], - "type": "string" - }, - "ConditionBasedCollectionScheme": { - "additionalProperties": false, - "properties": { - "ConditionLanguageVersion": { - "minimum": 1, - "type": "integer" - }, - "Expression": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "MinimumTriggerIntervalMs": { - "maximum": 4294967295, - "minimum": 0, - "type": "number" - }, - "TriggerMode": { - "$ref": "#/definitions/TriggerMode" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "DataDestinationConfig": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "S3Config": { - "$ref": "#/definitions/S3Config" - } - }, - "required": [ - "S3Config" - ], - "title": "S3Config", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TimestreamConfig": { - "$ref": "#/definitions/TimestreamConfig" - } - }, - "required": [ - "TimestreamConfig" - ], - "title": "TimestreamConfig", - "type": "object" - } - ] - }, - "DataFormat": { - "enum": [ - "JSON", - "PARQUET" - ], - "type": "string" - }, - "DiagnosticsMode": { - "default": "OFF", - "enum": [ - "OFF", - "SEND_ACTIVE_DTCS" - ], - "type": "string" - }, - "S3Config": { - "additionalProperties": false, - "properties": { - "BucketArn": { - "maxLength": 100, - "minLength": 16, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):s3:::.+$", - "type": "string" - }, - "DataFormat": { - "$ref": "#/definitions/DataFormat" - }, - "Prefix": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_:./!*'()]+$", - "type": "string" - }, - "StorageCompressionFormat": { - "$ref": "#/definitions/StorageCompressionFormat" - } - }, - "required": [ - "BucketArn" - ], - "type": "object" - }, - "SignalInformation": { - "additionalProperties": false, - "properties": { - "MaxSampleCount": { - "maximum": 4294967295, - "minimum": 1, - "type": "number" - }, - "MinimumSamplingIntervalMs": { - "maximum": 4294967295, - "minimum": 0, - "type": "number" - }, - "Name": { - "maxLength": 150, - "minLength": 1, - "pattern": "^[\\w|*|-]+(\\.[\\w|*|-]+)*$", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SpoolingMode": { - "default": "OFF", - "enum": [ - "OFF", - "TO_DISK" - ], - "type": "string" - }, - "StorageCompressionFormat": { - "enum": [ - "NONE", - "GZIP" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TimeBasedCollectionScheme": { - "additionalProperties": false, - "properties": { - "PeriodMs": { - "maximum": 60000, - "minimum": 10000, - "type": "number" - } - }, - "required": [ - "PeriodMs" - ], - "type": "object" - }, - "TimestreamConfig": { - "additionalProperties": false, - "properties": { - "ExecutionRoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$", - "type": "string" - }, - "TimestreamTableArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):timestream:[a-zA-Z0-9-]+:[0-9]{12}:database\\/[a-zA-Z0-9_.-]+\\/table\\/[a-zA-Z0-9_.-]+$", - "type": "string" - } - }, - "required": [ - "TimestreamTableArn", - "ExecutionRoleArn" - ], - "type": "object" - }, - "TriggerMode": { - "enum": [ - "ALWAYS", - "RISING_EDGE" - ], - "type": "string" - }, - "UpdateCampaignAction": { - "enum": [ - "APPROVE", - "SUSPEND", - "RESUME", - "UPDATE" - ], - "type": "string" - } - }, - "description": "Definition of AWS::IoTFleetWise::Campaign Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:CreateCampaign", - "iotfleetwise:GetCampaign", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iam:PassRole", - "timestream:DescribeEndpoints", - "timestream:DescribeTable" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:DeleteCampaign", - "iotfleetwise:GetCampaign" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListCampaigns", - "iotfleetwise:GetCampaign" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetCampaign", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:GetCampaign", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:UpdateCampaign", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Action": { - "$ref": "#/definitions/UpdateCampaignAction" - }, - "Arn": { - "type": "string" - }, - "CollectionScheme": { - "$ref": "#/definitions/CollectionScheme" - }, - "Compression": { - "$ref": "#/definitions/Compression" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "DataDestinationConfigs": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataDestinationConfig" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "DataExtraDimensions": { - "insertionOrder": false, - "items": { - "maxLength": 150, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "DiagnosticsMode": { - "$ref": "#/definitions/DiagnosticsMode" - }, - "ExpiryTime": { - "default": "253402214400", - "format": "date-time", - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z\\d\\-_:]+$", - "type": "string" - }, - "PostTriggerCollectionDuration": { - "default": 0, - "maximum": 4294967295, - "minimum": 0, - "type": "number" - }, - "Priority": { - "default": 0, - "minimum": 0, - "type": "integer" - }, - "SignalCatalogArn": { - "type": "string" - }, - "SignalsToCollect": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SignalInformation" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array" - }, - "SpoolingMode": { - "$ref": "#/definitions/SpoolingMode" - }, - "StartTime": { - "default": "0", - "format": "date-time", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/CampaignStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "TargetArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Status", - "/properties/CreationTime", - "/properties/LastModificationTime" - ], - "required": [ - "Name", - "Action", - "CollectionScheme", - "SignalCatalogArn", - "TargetArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::Campaign", - "writeOnlyProperties": [ - "/properties/Action" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/TargetArn", + "/properties/SignalCatalogArn", + "/properties/PostTriggerCollectionDuration", + "/properties/DiagnosticsMode", + "/properties/SpoolingMode", + "/properties/CollectionScheme", + "/properties/Priority", + "/properties/Compression", + "/properties/StartTime", + "/properties/ExpiryTime" + ], + "definitions": { + "CampaignStatus": { + "enum": [ + "CREATING", + "WAITING_FOR_APPROVAL", + "RUNNING", + "SUSPENDED" + ], + "type": "string" + }, + "CollectionScheme": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "TimeBasedCollectionScheme": { + "$ref": "#/definitions/TimeBasedCollectionScheme" + } + }, + "required": [ + "TimeBasedCollectionScheme" + ], + "title": "TimeBasedCollectionScheme", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ConditionBasedCollectionScheme": { + "$ref": "#/definitions/ConditionBasedCollectionScheme" + } + }, + "required": [ + "ConditionBasedCollectionScheme" + ], + "title": "ConditionBasedCollectionScheme", + "type": "object" + } + ] + }, + "Compression": { + "default": "OFF", + "enum": [ + "OFF", + "SNAPPY" + ], + "type": "string" + }, + "ConditionBasedCollectionScheme": { + "additionalProperties": false, + "properties": { + "ConditionLanguageVersion": { + "minimum": 1, + "type": "integer" + }, + "Expression": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MinimumTriggerIntervalMs": { + "maximum": 4294967295, + "minimum": 0, + "type": "number" + }, + "TriggerMode": { + "$ref": "#/definitions/TriggerMode" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ConditionBasedSignalFetchConfig": { + "additionalProperties": false, + "properties": { + "ConditionExpression": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "TriggerMode": { + "$ref": "#/definitions/TriggerMode" + } + }, + "required": [ + "ConditionExpression", + "TriggerMode" + ], + "type": "object" + }, + "DataDestinationConfig": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3Config": { + "$ref": "#/definitions/S3Config" + } + }, + "required": [ + "S3Config" + ], + "title": "S3Config", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TimestreamConfig": { + "$ref": "#/definitions/TimestreamConfig" + } + }, + "required": [ + "TimestreamConfig" + ], + "title": "TimestreamConfig", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "MqttTopicConfig": { + "$ref": "#/definitions/MqttTopicConfig" + } + }, + "required": [ + "MqttTopicConfig" + ], + "title": "MqttTopicConfig", + "type": "object" + } + ] + }, + "DataFormat": { + "enum": [ + "JSON", + "PARQUET" + ], + "type": "string" + }, + "DiagnosticsMode": { + "default": "OFF", + "enum": [ + "OFF", + "SEND_ACTIVE_DTCS" + ], + "type": "string" + }, + "MqttTopicConfig": { + "additionalProperties": false, + "properties": { + "ExecutionRoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$", + "type": "string" + }, + "MqttTopicArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:.*", + "type": "string" + } + }, + "required": [ + "ExecutionRoleArn", + "MqttTopicArn" + ], + "type": "object" + }, + "S3Config": { + "additionalProperties": false, + "properties": { + "BucketArn": { + "maxLength": 100, + "minLength": 16, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):s3:::.+$", + "type": "string" + }, + "DataFormat": { + "$ref": "#/definitions/DataFormat" + }, + "Prefix": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_:./!*'()]+$", + "type": "string" + }, + "StorageCompressionFormat": { + "$ref": "#/definitions/StorageCompressionFormat" + } + }, + "required": [ + "BucketArn" + ], + "type": "object" + }, + "SignalFetchConfig": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "TimeBased": { + "$ref": "#/definitions/TimeBasedSignalFetchConfig" + } + }, + "required": [ + "TimeBased" + ], + "title": "TimeBased", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ConditionBased": { + "$ref": "#/definitions/ConditionBasedSignalFetchConfig" + } + }, + "required": [ + "ConditionBased" + ], + "title": "ConditionBased", + "type": "object" + } + ] + }, + "SignalFetchInformation": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "ConditionLanguageVersion": { + "maximum": 1, + "minimum": 1, + "type": "number" + }, + "FullyQualifiedName": { + "maxLength": 150, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.]+$", + "type": "string" + }, + "SignalFetchConfig": { + "$ref": "#/definitions/SignalFetchConfig" + } + }, + "required": [ + "Actions", + "FullyQualifiedName", + "SignalFetchConfig" + ], + "type": "object" + }, + "SignalInformation": { + "additionalProperties": false, + "properties": { + "MaxSampleCount": { + "maximum": 4294967295, + "minimum": 1, + "type": "number" + }, + "MinimumSamplingIntervalMs": { + "maximum": 4294967295, + "minimum": 0, + "type": "number" + }, + "Name": { + "maxLength": 150, + "minLength": 1, + "pattern": "^[\\w|*|-]+(\\.[\\w|*|-]+)*$", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SpoolingMode": { + "default": "OFF", + "enum": [ + "OFF", + "TO_DISK" + ], + "type": "string" + }, + "StorageCompressionFormat": { + "enum": [ + "NONE", + "GZIP" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TimeBasedCollectionScheme": { + "additionalProperties": false, + "properties": { + "PeriodMs": { + "maximum": 86400000, + "minimum": 10000, + "type": "number" + } + }, + "required": [ + "PeriodMs" + ], + "type": "object" + }, + "TimeBasedSignalFetchConfig": { + "additionalProperties": false, + "properties": { + "ExecutionFrequencyMs": { + "minimum": 1, + "type": "number" + } + }, + "required": [ + "ExecutionFrequencyMs" + ], + "type": "object" + }, + "TimePeriod": { + "additionalProperties": false, + "properties": { + "Unit": { + "$ref": "#/definitions/TimeUnit" + }, + "Value": { + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Unit", + "Value" + ], + "type": "object" + }, + "TimeUnit": { + "enum": [ + "MILLISECOND", + "SECOND", + "MINUTE", + "HOUR" + ], + "type": "string" + }, + "TimestreamConfig": { + "additionalProperties": false, + "properties": { + "ExecutionRoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$", + "type": "string" + }, + "TimestreamTableArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):timestream:[a-zA-Z0-9-]+:[0-9]{12}:database\\/[a-zA-Z0-9_.-]+\\/table\\/[a-zA-Z0-9_.-]+$", + "type": "string" + } + }, + "required": [ + "TimestreamTableArn", + "ExecutionRoleArn" + ], + "type": "object" + }, + "TriggerMode": { + "enum": [ + "ALWAYS", + "RISING_EDGE" + ], + "type": "string" + }, + "UpdateCampaignAction": { + "enum": [ + "APPROVE", + "SUSPEND", + "RESUME", + "UPDATE" + ], + "type": "string" + } + }, + "description": "Definition of AWS::IoTFleetWise::Campaign Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:CreateCampaign", + "iotfleetwise:GetCampaign", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iam:PassRole", + "timestream:DescribeEndpoints", + "timestream:DescribeTable" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:DeleteCampaign", + "iotfleetwise:GetCampaign" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListCampaigns", + "iotfleetwise:GetCampaign" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetCampaign", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:GetCampaign", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:UpdateCampaign", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Action": { + "$ref": "#/definitions/UpdateCampaignAction" + }, + "Arn": { + "type": "string" + }, + "CollectionScheme": { + "$ref": "#/definitions/CollectionScheme" + }, + "Compression": { + "$ref": "#/definitions/Compression" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "DataDestinationConfigs": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataDestinationConfig" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "DataExtraDimensions": { + "insertionOrder": false, + "items": { + "maxLength": 150, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "DiagnosticsMode": { + "$ref": "#/definitions/DiagnosticsMode" + }, + "ExpiryTime": { + "default": "253402214400", + "format": "date-time", + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z\\d\\-_:]+$", + "type": "string" + }, + "PostTriggerCollectionDuration": { + "default": 0, + "maximum": 4294967295, + "minimum": 0, + "type": "number" + }, + "Priority": { + "default": 0, + "minimum": 0, + "type": "integer" + }, + "SignalCatalogArn": { + "type": "string" + }, + "SignalsToCollect": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SignalInformation" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "SignalsToFetch": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SignalFetchInformation" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "SpoolingMode": { + "$ref": "#/definitions/SpoolingMode" + }, + "StartTime": { + "default": "0", + "format": "date-time", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/CampaignStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "TargetArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Status", + "/properties/CreationTime", + "/properties/LastModificationTime" + ], + "required": [ + "Name", + "CollectionScheme", + "SignalCatalogArn", + "TargetArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "iotfleetwise:UntagResource", + "iotfleetwise:TagResource", + "iotfleetwise:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::Campaign", + "writeOnlyProperties": [ + "/properties/Action" + ] +} diff --git a/schema/aws-iotfleetwise-decodermanifest.json b/schema/aws-iotfleetwise-decodermanifest.json index 476946f..a63636c 100644 --- a/schema/aws-iotfleetwise-decodermanifest.json +++ b/schema/aws-iotfleetwise-decodermanifest.json @@ -1,491 +1,496 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/ModelManifestArn" - ], - "definitions": { - "CanInterface": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ProtocolName": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ProtocolVersion": { - "maxLength": 50, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "CanNetworkInterface": { - "additionalProperties": false, - "properties": { - "CanInterface": { - "$ref": "#/definitions/CanInterface" - }, - "InterfaceId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Type": { - "enum": [ - "CAN_INTERFACE" - ], - "type": "string" - } - }, - "required": [ - "InterfaceId", - "Type", - "CanInterface" - ], - "type": "object" - }, - "CanSignal": { - "additionalProperties": false, - "properties": { - "Factor": { - "type": [ - "number", - "string" - ] - }, - "IsBigEndian": { - "type": [ - "boolean", - "string" - ] - }, - "IsSigned": { - "type": [ - "boolean", - "string" - ] - }, - "Length": { - "type": [ - "integer", - "string" - ] - }, - "MessageId": { - "type": [ - "integer", - "string" - ] - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Offset": { - "type": [ - "number", - "string" - ] - }, - "StartBit": { - "type": [ - "integer", - "string" - ] - } - }, - "required": [ - "Factor", - "IsBigEndian", - "IsSigned", - "Length", - "MessageId", - "Offset", - "StartBit" - ], - "type": "object" - }, - "CanSignalDecoder": { - "additionalProperties": false, - "properties": { - "CanSignal": { - "$ref": "#/definitions/CanSignal" - }, - "FullyQualifiedName": { - "maxLength": 150, - "minLength": 1, - "type": "string" - }, - "InterfaceId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Type": { - "enum": [ - "CAN_SIGNAL" - ], - "type": "string" - } - }, - "required": [ - "FullyQualifiedName", - "InterfaceId", - "Type", - "CanSignal" - ], - "type": "object" - }, - "ManifestStatus": { - "default": "DRAFT", - "enum": [ - "ACTIVE", - "DRAFT" - ], - "type": "string" - }, - "ObdInterface": { - "additionalProperties": false, - "properties": { - "DtcRequestIntervalSeconds": { - "type": [ - "integer", - "string" - ] - }, - "HasTransmissionEcu": { - "type": [ - "boolean", - "string" - ] - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ObdStandard": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "PidRequestIntervalSeconds": { - "type": [ - "integer", - "string" - ] - }, - "RequestMessageId": { - "type": [ - "integer", - "string" - ] - }, - "UseExtendedIds": { - "type": [ - "boolean", - "string" - ] - } - }, - "required": [ - "Name", - "RequestMessageId" - ], - "type": "object" - }, - "ObdNetworkInterface": { - "additionalProperties": false, - "properties": { - "InterfaceId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ObdInterface": { - "$ref": "#/definitions/ObdInterface" - }, - "Type": { - "enum": [ - "OBD_INTERFACE" - ], - "type": "string" - } - }, - "required": [ - "InterfaceId", - "Type", - "ObdInterface" - ], - "type": "object" - }, - "ObdSignal": { - "additionalProperties": false, - "properties": { - "BitMaskLength": { - "type": [ - "integer", - "string" - ] - }, - "BitRightShift": { - "type": [ - "integer", - "string" - ] - }, - "ByteLength": { - "type": [ - "integer", - "string" - ] - }, - "Offset": { - "type": [ - "number", - "string" - ] - }, - "Pid": { - "type": [ - "integer", - "string" - ] - }, - "PidResponseLength": { - "type": [ - "integer", - "string" - ] - }, - "Scaling": { - "type": [ - "number", - "string" - ] - }, - "ServiceMode": { - "type": [ - "integer", - "string" - ] - }, - "StartByte": { - "type": [ - "integer", - "string" - ] - } - }, - "required": [ - "ByteLength", - "Offset", - "Pid", - "PidResponseLength", - "Scaling", - "ServiceMode", - "StartByte" - ], - "type": "object" - }, - "ObdSignalDecoder": { - "additionalProperties": false, - "properties": { - "FullyQualifiedName": { - "maxLength": 150, - "minLength": 1, - "type": "string" - }, - "InterfaceId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ObdSignal": { - "$ref": "#/definitions/ObdSignal" - }, - "Type": { - "enum": [ - "OBD_SIGNAL" - ], - "type": "string" - } - }, - "required": [ - "FullyQualifiedName", - "InterfaceId", - "Type", - "ObdSignal" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::IoTFleetWise::DecoderManifest Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:CreateDecoderManifest", - "iotfleetwise:GetDecoderManifest", - "iotfleetwise:UpdateDecoderManifest", - "iotfleetwise:ListDecoderManifestSignals", - "iotfleetwise:ListDecoderManifestNetworkInterfaces", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:DeleteDecoderManifest", - "iotfleetwise:GetDecoderManifest" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListDecoderManifests" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetDecoderManifest", - "iotfleetwise:ListDecoderManifestSignals", - "iotfleetwise:ListDecoderManifestNetworkInterfaces", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:UpdateDecoderManifest", - "iotfleetwise:GetDecoderManifest", - "iotfleetwise:ListDecoderManifestSignals", - "iotfleetwise:ListDecoderManifestNetworkInterfaces", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "ModelManifestArn": { - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z\\d\\-_:]+$", - "type": "string" - }, - "NetworkInterfaces": { - "insertionOrder": false, - "items": { - "oneOf": [ - { - "$ref": "#/definitions/CanNetworkInterface" - }, - { - "$ref": "#/definitions/ObdNetworkInterface" - } - ] - }, - "maxItems": 500, - "minItems": 1, - "type": "array" - }, - "SignalDecoders": { - "insertionOrder": false, - "items": { - "oneOf": [ - { - "$ref": "#/definitions/CanSignalDecoder" - }, - { - "$ref": "#/definitions/ObdSignalDecoder" - } - ] - }, - "maxItems": 500, - "minItems": 1, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/ManifestStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModificationTime" - ], - "required": [ - "Name", - "ModelManifestArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::DecoderManifest" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ModelManifestArn" + ], + "definitions": { + "CanInterface": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ProtocolName": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ProtocolVersion": { + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "CanNetworkInterface": { + "additionalProperties": false, + "properties": { + "CanInterface": { + "$ref": "#/definitions/CanInterface" + }, + "InterfaceId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Type": { + "enum": [ + "CAN_INTERFACE" + ], + "type": "string" + } + }, + "required": [ + "InterfaceId", + "Type", + "CanInterface" + ], + "type": "object" + }, + "CanSignal": { + "additionalProperties": false, + "properties": { + "Factor": { + "type": [ + "number", + "string" + ] + }, + "IsBigEndian": { + "type": [ + "boolean", + "string" + ] + }, + "IsSigned": { + "type": [ + "boolean", + "string" + ] + }, + "Length": { + "type": [ + "integer", + "string" + ] + }, + "MessageId": { + "type": [ + "integer", + "string" + ] + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Offset": { + "type": [ + "number", + "string" + ] + }, + "StartBit": { + "type": [ + "integer", + "string" + ] + } + }, + "required": [ + "Factor", + "IsBigEndian", + "IsSigned", + "Length", + "MessageId", + "Offset", + "StartBit" + ], + "type": "object" + }, + "CanSignalDecoder": { + "additionalProperties": false, + "properties": { + "CanSignal": { + "$ref": "#/definitions/CanSignal" + }, + "FullyQualifiedName": { + "maxLength": 150, + "minLength": 1, + "type": "string" + }, + "InterfaceId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Type": { + "enum": [ + "CAN_SIGNAL" + ], + "type": "string" + } + }, + "required": [ + "FullyQualifiedName", + "InterfaceId", + "Type", + "CanSignal" + ], + "type": "object" + }, + "ManifestStatus": { + "default": "DRAFT", + "enum": [ + "ACTIVE", + "DRAFT" + ], + "type": "string" + }, + "ObdInterface": { + "additionalProperties": false, + "properties": { + "DtcRequestIntervalSeconds": { + "type": [ + "integer", + "string" + ] + }, + "HasTransmissionEcu": { + "type": [ + "boolean", + "string" + ] + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ObdStandard": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "PidRequestIntervalSeconds": { + "type": [ + "integer", + "string" + ] + }, + "RequestMessageId": { + "type": [ + "integer", + "string" + ] + }, + "UseExtendedIds": { + "type": [ + "boolean", + "string" + ] + } + }, + "required": [ + "Name", + "RequestMessageId" + ], + "type": "object" + }, + "ObdNetworkInterface": { + "additionalProperties": false, + "properties": { + "InterfaceId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ObdInterface": { + "$ref": "#/definitions/ObdInterface" + }, + "Type": { + "enum": [ + "OBD_INTERFACE" + ], + "type": "string" + } + }, + "required": [ + "InterfaceId", + "Type", + "ObdInterface" + ], + "type": "object" + }, + "ObdSignal": { + "additionalProperties": false, + "properties": { + "BitMaskLength": { + "type": [ + "integer", + "string" + ] + }, + "BitRightShift": { + "type": [ + "integer", + "string" + ] + }, + "ByteLength": { + "type": [ + "integer", + "string" + ] + }, + "Offset": { + "type": [ + "number", + "string" + ] + }, + "Pid": { + "type": [ + "integer", + "string" + ] + }, + "PidResponseLength": { + "type": [ + "integer", + "string" + ] + }, + "Scaling": { + "type": [ + "number", + "string" + ] + }, + "ServiceMode": { + "type": [ + "integer", + "string" + ] + }, + "StartByte": { + "type": [ + "integer", + "string" + ] + } + }, + "required": [ + "ByteLength", + "Offset", + "Pid", + "PidResponseLength", + "Scaling", + "ServiceMode", + "StartByte" + ], + "type": "object" + }, + "ObdSignalDecoder": { + "additionalProperties": false, + "properties": { + "FullyQualifiedName": { + "maxLength": 150, + "minLength": 1, + "type": "string" + }, + "InterfaceId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ObdSignal": { + "$ref": "#/definitions/ObdSignal" + }, + "Type": { + "enum": [ + "OBD_SIGNAL" + ], + "type": "string" + } + }, + "required": [ + "FullyQualifiedName", + "InterfaceId", + "Type", + "ObdSignal" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::IoTFleetWise::DecoderManifest Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:CreateDecoderManifest", + "iotfleetwise:GetDecoderManifest", + "iotfleetwise:UpdateDecoderManifest", + "iotfleetwise:ListDecoderManifestSignals", + "iotfleetwise:ListDecoderManifestNetworkInterfaces", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:DeleteDecoderManifest", + "iotfleetwise:GetDecoderManifest" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListDecoderManifests" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetDecoderManifest", + "iotfleetwise:ListDecoderManifestSignals", + "iotfleetwise:ListDecoderManifestNetworkInterfaces", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:UpdateDecoderManifest", + "iotfleetwise:GetDecoderManifest", + "iotfleetwise:ListDecoderManifestSignals", + "iotfleetwise:ListDecoderManifestNetworkInterfaces", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "ModelManifestArn": { + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z\\d\\-_:]+$", + "type": "string" + }, + "NetworkInterfaces": { + "insertionOrder": false, + "items": { + "oneOf": [ + { + "$ref": "#/definitions/CanNetworkInterface" + }, + { + "$ref": "#/definitions/ObdNetworkInterface" + } + ] + }, + "maxItems": 5000, + "minItems": 1, + "type": "array" + }, + "SignalDecoders": { + "insertionOrder": false, + "items": { + "oneOf": [ + { + "$ref": "#/definitions/CanSignalDecoder" + }, + { + "$ref": "#/definitions/ObdSignalDecoder" + } + ] + }, + "maxItems": 5000, + "minItems": 1, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/ManifestStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModificationTime" + ], + "required": [ + "Name", + "ModelManifestArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "iotfleetwise:UntagResource", + "iotfleetwise:TagResource", + "iotfleetwise:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::DecoderManifest" +} diff --git a/schema/aws-iotfleetwise-fleet.json b/schema/aws-iotfleetwise-fleet.json index 8570e62..e8fb934 100644 --- a/schema/aws-iotfleetwise-fleet.json +++ b/schema/aws-iotfleetwise-fleet.json @@ -1,125 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Id", - "/properties/SignalCatalogArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::IoTFleetWise::Fleet Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:GetFleet", - "iotfleetwise:CreateFleet", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:ListVehiclesInFleet", - "iotfleetwise:TagResource" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:GetFleet", - "iotfleetwise:DeleteFleet" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListFleets" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetFleet", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:GetFleet", - "iotfleetwise:UpdateFleet", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "Id": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9:_-]+$", - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "SignalCatalogArn": { - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModificationTime" - ], - "required": [ - "Id", - "SignalCatalogArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::Fleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Id", + "/properties/SignalCatalogArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::IoTFleetWise::Fleet Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:GetFleet", + "iotfleetwise:CreateFleet", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:ListVehiclesInFleet", + "iotfleetwise:TagResource" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:GetFleet", + "iotfleetwise:DeleteFleet" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListFleets" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetFleet", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:GetFleet", + "iotfleetwise:UpdateFleet", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "Id": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9:_-]+$", + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "SignalCatalogArn": { + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModificationTime" + ], + "required": [ + "Id", + "SignalCatalogArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "iotfleetwise:UntagResource", + "iotfleetwise:TagResource", + "iotfleetwise:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::Fleet" +} diff --git a/schema/aws-iotfleetwise-modelmanifest.json b/schema/aws-iotfleetwise-modelmanifest.json index 163dbb3..8e1c110 100644 --- a/schema/aws-iotfleetwise-modelmanifest.json +++ b/schema/aws-iotfleetwise-modelmanifest.json @@ -1,147 +1,152 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ManifestStatus": { - "default": "DRAFT", - "enum": [ - "ACTIVE", - "DRAFT" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::IoTFleetWise::ModelManifest Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:CreateModelManifest", - "iotfleetwise:GetModelManifest", - "iotfleetwise:UpdateModelManifest", - "iotfleetwise:ListModelManifestNodes", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:DeleteModelManifest", - "iotfleetwise:GetModelManifest" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListModelManifests" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetModelManifest", - "iotfleetwise:ListModelManifestNodes", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:UpdateModelManifest", - "iotfleetwise:GetModelManifest", - "iotfleetwise:ListModelManifestNodes", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z\\d\\-_:]+$", - "type": "string" - }, - "Nodes": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SignalCatalogArn": { - "type": "string" - }, - "Status": { - "$ref": "#/definitions/ManifestStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModificationTime" - ], - "required": [ - "SignalCatalogArn", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::ModelManifest" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ManifestStatus": { + "default": "DRAFT", + "enum": [ + "ACTIVE", + "DRAFT" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::IoTFleetWise::ModelManifest Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:CreateModelManifest", + "iotfleetwise:GetModelManifest", + "iotfleetwise:UpdateModelManifest", + "iotfleetwise:ListModelManifestNodes", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:DeleteModelManifest", + "iotfleetwise:GetModelManifest" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListModelManifests" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetModelManifest", + "iotfleetwise:ListModelManifestNodes", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:UpdateModelManifest", + "iotfleetwise:GetModelManifest", + "iotfleetwise:ListModelManifestNodes", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z\\d\\-_:]+$", + "type": "string" + }, + "Nodes": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SignalCatalogArn": { + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ManifestStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModificationTime" + ], + "required": [ + "SignalCatalogArn", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "iotfleetwise:UntagResource", + "iotfleetwise:TagResource", + "iotfleetwise:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::ModelManifest" +} diff --git a/schema/aws-iotfleetwise-signalcatalog.json b/schema/aws-iotfleetwise-signalcatalog.json index a6d2767..26faa2a 100644 --- a/schema/aws-iotfleetwise-signalcatalog.json +++ b/schema/aws-iotfleetwise-signalcatalog.json @@ -1,371 +1,371 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Actuator": { - "additionalProperties": false, - "properties": { - "AllowedValues": { - "$ref": "#/definitions/AllowedValues" - }, - "AssignedValue": { - "type": "string" - }, - "DataType": { - "$ref": "#/definitions/NodeDataType" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "FullyQualifiedName": { - "type": "string" - }, - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "DataType", - "FullyQualifiedName" - ], - "type": "object" - }, - "AllowedValues": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "Attribute": { - "additionalProperties": false, - "properties": { - "AllowedValues": { - "$ref": "#/definitions/AllowedValues" - }, - "AssignedValue": { - "type": "string" - }, - "DataType": { - "$ref": "#/definitions/NodeDataType" - }, - "DefaultValue": { - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "FullyQualifiedName": { - "type": "string" - }, - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "DataType", - "FullyQualifiedName" - ], - "type": "object" - }, - "Branch": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "FullyQualifiedName": { - "type": "string" - } - }, - "required": [ - "FullyQualifiedName" - ], - "type": "object" - }, - "Node": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Branch": { - "$ref": "#/definitions/Branch" - } - }, - "title": "Branch", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Sensor": { - "$ref": "#/definitions/Sensor" - } - }, - "title": "Sensor", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Actuator": { - "$ref": "#/definitions/Actuator" - } - }, - "title": "Actuator", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/Attribute" - } - }, - "title": "Attribute", - "type": "object" - } - ] - }, - "NodeCounts": { - "additionalProperties": false, - "properties": { - "TotalActuators": { - "type": "number" - }, - "TotalAttributes": { - "type": "number" - }, - "TotalBranches": { - "type": "number" - }, - "TotalNodes": { - "type": "number" - }, - "TotalSensors": { - "type": "number" - } - }, - "type": "object" - }, - "NodeDataType": { - "enum": [ - "INT8", - "UINT8", - "INT16", - "UINT16", - "INT32", - "UINT32", - "INT64", - "UINT64", - "BOOLEAN", - "FLOAT", - "DOUBLE", - "STRING", - "UNIX_TIMESTAMP", - "INT8_ARRAY", - "UINT8_ARRAY", - "INT16_ARRAY", - "UINT16_ARRAY", - "INT32_ARRAY", - "UINT32_ARRAY", - "INT64_ARRAY", - "UINT64_ARRAY", - "BOOLEAN_ARRAY", - "FLOAT_ARRAY", - "DOUBLE_ARRAY", - "STRING_ARRAY", - "UNIX_TIMESTAMP_ARRAY", - "UNKNOWN" - ], - "type": "string" - }, - "Sensor": { - "additionalProperties": false, - "properties": { - "AllowedValues": { - "$ref": "#/definitions/AllowedValues" - }, - "DataType": { - "$ref": "#/definitions/NodeDataType" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "FullyQualifiedName": { - "type": "string" - }, - "Max": { - "type": "number" - }, - "Min": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "DataType", - "FullyQualifiedName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::IoTFleetWise::SignalCatalog Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:GetSignalCatalog", - "iotfleetwise:CreateSignalCatalog", - "iotfleetwise:ListSignalCatalogNodes", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:GetSignalCatalog", - "iotfleetwise:DeleteSignalCatalog" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListSignalCatalogs" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetSignalCatalog", - "iotfleetwise:ListSignalCatalogNodes", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:GetSignalCatalog", - "iotfleetwise:UpdateSignalCatalog", - "iotfleetwise:ListSignalCatalogNodes", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[^\\u0000-\\u001F\\u007F]+$", - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z\\d\\-_:]+$", - "type": "string" - }, - "NodeCounts": { - "$ref": "#/definitions/NodeCounts" - }, - "Nodes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Node" - }, - "maxItems": 500, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModificationTime", - "/properties/NodeCounts/TotalNodes", - "/properties/NodeCounts/TotalBranches", - "/properties/NodeCounts/TotalSensors", - "/properties/NodeCounts/TotalAttributes", - "/properties/NodeCounts/TotalActuators" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::SignalCatalog" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Actuator": { + "additionalProperties": false, + "properties": { + "AllowedValues": { + "$ref": "#/definitions/AllowedValues" + }, + "AssignedValue": { + "type": "string" + }, + "DataType": { + "$ref": "#/definitions/NodeDataType" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "FullyQualifiedName": { + "type": "string" + }, + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "DataType", + "FullyQualifiedName" + ], + "type": "object" + }, + "AllowedValues": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "Attribute": { + "additionalProperties": false, + "properties": { + "AllowedValues": { + "$ref": "#/definitions/AllowedValues" + }, + "AssignedValue": { + "type": "string" + }, + "DataType": { + "$ref": "#/definitions/NodeDataType" + }, + "DefaultValue": { + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "FullyQualifiedName": { + "type": "string" + }, + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "DataType", + "FullyQualifiedName" + ], + "type": "object" + }, + "Branch": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "FullyQualifiedName": { + "type": "string" + } + }, + "required": [ + "FullyQualifiedName" + ], + "type": "object" + }, + "Node": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Branch": { + "$ref": "#/definitions/Branch" + } + }, + "title": "Branch", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Sensor": { + "$ref": "#/definitions/Sensor" + } + }, + "title": "Sensor", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Actuator": { + "$ref": "#/definitions/Actuator" + } + }, + "title": "Actuator", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/Attribute" + } + }, + "title": "Attribute", + "type": "object" + } + ] + }, + "NodeCounts": { + "additionalProperties": false, + "properties": { + "TotalActuators": { + "type": "number" + }, + "TotalAttributes": { + "type": "number" + }, + "TotalBranches": { + "type": "number" + }, + "TotalNodes": { + "type": "number" + }, + "TotalSensors": { + "type": "number" + } + }, + "type": "object" + }, + "NodeDataType": { + "enum": [ + "INT8", + "UINT8", + "INT16", + "UINT16", + "INT32", + "UINT32", + "INT64", + "UINT64", + "BOOLEAN", + "FLOAT", + "DOUBLE", + "STRING", + "UNIX_TIMESTAMP", + "INT8_ARRAY", + "UINT8_ARRAY", + "INT16_ARRAY", + "UINT16_ARRAY", + "INT32_ARRAY", + "UINT32_ARRAY", + "INT64_ARRAY", + "UINT64_ARRAY", + "BOOLEAN_ARRAY", + "FLOAT_ARRAY", + "DOUBLE_ARRAY", + "STRING_ARRAY", + "UNIX_TIMESTAMP_ARRAY", + "UNKNOWN" + ], + "type": "string" + }, + "Sensor": { + "additionalProperties": false, + "properties": { + "AllowedValues": { + "$ref": "#/definitions/AllowedValues" + }, + "DataType": { + "$ref": "#/definitions/NodeDataType" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "FullyQualifiedName": { + "type": "string" + }, + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "DataType", + "FullyQualifiedName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::IoTFleetWise::SignalCatalog Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:GetSignalCatalog", + "iotfleetwise:CreateSignalCatalog", + "iotfleetwise:ListSignalCatalogNodes", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:GetSignalCatalog", + "iotfleetwise:DeleteSignalCatalog" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListSignalCatalogs" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetSignalCatalog", + "iotfleetwise:ListSignalCatalogNodes", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:GetSignalCatalog", + "iotfleetwise:UpdateSignalCatalog", + "iotfleetwise:ListSignalCatalogNodes", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[^\\u0000-\\u001F\\u007F]+$", + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z\\d\\-_:]+$", + "type": "string" + }, + "NodeCounts": { + "$ref": "#/definitions/NodeCounts" + }, + "Nodes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Node" + }, + "maxItems": 5000, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModificationTime", + "/properties/NodeCounts/TotalNodes", + "/properties/NodeCounts/TotalBranches", + "/properties/NodeCounts/TotalSensors", + "/properties/NodeCounts/TotalAttributes", + "/properties/NodeCounts/TotalActuators" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::SignalCatalog" +} diff --git a/schema/aws-iotfleetwise-vehicle.json b/schema/aws-iotfleetwise-vehicle.json index b9dc4ed..3b07afd 100644 --- a/schema/aws-iotfleetwise-vehicle.json +++ b/schema/aws-iotfleetwise-vehicle.json @@ -1,150 +1,155 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VehicleAssociationBehavior": { - "enum": [ - "CreateIotThing", - "ValidateIotThingExists" - ], - "type": "string" - }, - "attributesMap": { - "additionalProperties": false, - "minProperties": 1, - "patternProperties": { - "^[a-zA-Z0-9_.-]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::IoTFleetWise::Vehicle Resource Type", - "handlers": { - "create": { - "permissions": [ - "iotfleetwise:GetVehicle", - "iotfleetwise:CreateVehicle", - "iot:CreateThing", - "iot:DescribeThing", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:ListVehicles", - "iotfleetwise:TagResource" - ] - }, - "delete": { - "permissions": [ - "iotfleetwise:GetVehicle", - "iotfleetwise:DeleteVehicle" - ] - }, - "list": { - "permissions": [ - "iotfleetwise:ListVehicles" - ] - }, - "read": { - "permissions": [ - "iotfleetwise:GetVehicle", - "iotfleetwise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotfleetwise:GetVehicle", - "iotfleetwise:UpdateVehicle", - "iotfleetwise:ListTagsForResource", - "iotfleetwise:TagResource", - "iotfleetwise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AssociationBehavior": { - "$ref": "#/definitions/VehicleAssociationBehavior" - }, - "Attributes": { - "$ref": "#/definitions/attributesMap" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "DecoderManifestArn": { - "type": "string" - }, - "LastModificationTime": { - "format": "date-time", - "type": "string" - }, - "ModelManifestArn": { - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z\\d\\-_:]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModificationTime" - ], - "required": [ - "Name", - "DecoderManifestArn", - "ModelManifestArn" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTFleetWise::Vehicle", - "writeOnlyProperties": [ - "/properties/AssociationBehavior" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VehicleAssociationBehavior": { + "enum": [ + "CreateIotThing", + "ValidateIotThingExists" + ], + "type": "string" + }, + "attributesMap": { + "additionalProperties": false, + "minProperties": 1, + "patternProperties": { + "^[a-zA-Z0-9_.-]+$": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::IoTFleetWise::Vehicle Resource Type", + "handlers": { + "create": { + "permissions": [ + "iotfleetwise:GetVehicle", + "iotfleetwise:CreateVehicle", + "iot:CreateThing", + "iot:DescribeThing", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:ListVehicles", + "iotfleetwise:TagResource" + ] + }, + "delete": { + "permissions": [ + "iotfleetwise:GetVehicle", + "iotfleetwise:DeleteVehicle" + ] + }, + "list": { + "permissions": [ + "iotfleetwise:ListVehicles" + ] + }, + "read": { + "permissions": [ + "iotfleetwise:GetVehicle", + "iotfleetwise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotfleetwise:GetVehicle", + "iotfleetwise:UpdateVehicle", + "iotfleetwise:ListTagsForResource", + "iotfleetwise:TagResource", + "iotfleetwise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AssociationBehavior": { + "$ref": "#/definitions/VehicleAssociationBehavior" + }, + "Attributes": { + "$ref": "#/definitions/attributesMap" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "DecoderManifestArn": { + "type": "string" + }, + "LastModificationTime": { + "format": "date-time", + "type": "string" + }, + "ModelManifestArn": { + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z\\d\\-_:]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModificationTime" + ], + "required": [ + "Name", + "DecoderManifestArn", + "ModelManifestArn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "iotfleetwise:UntagResource", + "iotfleetwise:TagResource", + "iotfleetwise:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTFleetWise::Vehicle", + "writeOnlyProperties": [ + "/properties/AssociationBehavior" + ] +} diff --git a/schema/aws-iotsitewise-accesspolicy.json b/schema/aws-iotsitewise-accesspolicy.json index 484902f..befee36 100644 --- a/schema/aws-iotsitewise-accesspolicy.json +++ b/schema/aws-iotsitewise-accesspolicy.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "definitions": { - "AccessPolicyIdentity": { - "additionalProperties": false, - "description": "The identity for this access policy. Choose either an SSO user or group or an IAM user or role.", - "properties": { - "IamRole": { - "$ref": "#/definitions/IamRole" - }, - "IamUser": { - "$ref": "#/definitions/IamUser" - }, - "User": { - "$ref": "#/definitions/User" - } - }, - "type": "object" - }, - "AccessPolicyResource": { - "additionalProperties": false, - "description": "The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.", - "properties": { - "Portal": { - "$ref": "#/definitions/Portal" - }, - "Project": { - "$ref": "#/definitions/Project" - } - }, - "type": "object" - }, - "IamRole": { - "additionalProperties": false, - "description": "Contains information for an IAM role identity in an access policy.", - "properties": { - "arn": { - "description": "The ARN of the IAM role.", - "type": "string" - } - }, - "type": "object" - }, - "IamUser": { - "additionalProperties": false, - "description": "Contains information for an IAM user identity in an access policy.", - "properties": { - "arn": { - "description": "The ARN of the IAM user.", - "type": "string" - } - }, - "type": "object" - }, - "Portal": { - "additionalProperties": false, - "description": "A portal resource.", - "properties": { - "id": { - "description": "The ID of the portal.", - "type": "string" - } - }, - "type": "object" - }, - "Project": { - "additionalProperties": false, - "description": "A project resource.", - "properties": { - "id": { - "description": "The ID of the project.", - "type": "string" - } - }, - "type": "object" - }, - "User": { - "additionalProperties": false, - "description": "Contains information for a user identity in an access policy.", - "properties": { - "id": { - "description": "The AWS SSO ID of the user.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::AccessPolicy", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreateAccessPolicy" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribeAccessPolicy", - "iotsitewise:DeleteAccessPolicy" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListAccessPolicies" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeAccessPolicy" - ] - }, - "update": { - "permissions": [ - "iotsitewise:DescribeAccessPolicy", - "iotsitewise:UpdateAccessPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccessPolicyId" - ], - "properties": { - "AccessPolicyArn": { - "description": "The ARN of the access policy.", - "type": "string" - }, - "AccessPolicyId": { - "description": "The ID of the access policy.", - "type": "string" - }, - "AccessPolicyIdentity": { - "$ref": "#/definitions/AccessPolicyIdentity", - "description": "The identity for this access policy. Choose either a user or a group but not both." - }, - "AccessPolicyPermission": { - "description": "The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.", - "type": "string" - }, - "AccessPolicyResource": { - "$ref": "#/definitions/AccessPolicyResource", - "description": "The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both." - } - }, - "readOnlyProperties": [ - "/properties/AccessPolicyArn", - "/properties/AccessPolicyId" - ], - "required": [ - "AccessPolicyIdentity", - "AccessPolicyPermission", - "AccessPolicyResource" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", - "taggable": false, - "typeName": "AWS::IoTSiteWise::AccessPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "AccessPolicyIdentity": { + "additionalProperties": false, + "description": "The identity for this access policy. Choose either an SSO user or group or an IAM user or role.", + "properties": { + "IamRole": { + "$ref": "#/definitions/IamRole" + }, + "IamUser": { + "$ref": "#/definitions/IamUser" + }, + "User": { + "$ref": "#/definitions/User" + } + }, + "type": "object" + }, + "AccessPolicyResource": { + "additionalProperties": false, + "description": "The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.", + "properties": { + "Portal": { + "$ref": "#/definitions/Portal" + }, + "Project": { + "$ref": "#/definitions/Project" + } + }, + "type": "object" + }, + "IamRole": { + "additionalProperties": false, + "description": "Contains information for an IAM role identity in an access policy.", + "properties": { + "arn": { + "description": "The ARN of the IAM role.", + "type": "string" + } + }, + "type": "object" + }, + "IamUser": { + "additionalProperties": false, + "description": "Contains information for an IAM user identity in an access policy.", + "properties": { + "arn": { + "description": "The ARN of the IAM user.", + "type": "string" + } + }, + "type": "object" + }, + "Portal": { + "additionalProperties": false, + "description": "A portal resource.", + "properties": { + "id": { + "description": "The ID of the portal.", + "type": "string" + } + }, + "type": "object" + }, + "Project": { + "additionalProperties": false, + "description": "A project resource.", + "properties": { + "id": { + "description": "The ID of the project.", + "type": "string" + } + }, + "type": "object" + }, + "User": { + "additionalProperties": false, + "description": "Contains information for a user identity in an access policy.", + "properties": { + "id": { + "description": "The AWS SSO ID of the user.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::AccessPolicy", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreateAccessPolicy" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribeAccessPolicy", + "iotsitewise:DeleteAccessPolicy" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListAccessPolicies" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeAccessPolicy" + ] + }, + "update": { + "permissions": [ + "iotsitewise:DescribeAccessPolicy", + "iotsitewise:UpdateAccessPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccessPolicyId" + ], + "properties": { + "AccessPolicyArn": { + "description": "The ARN of the access policy.", + "type": "string" + }, + "AccessPolicyId": { + "description": "The ID of the access policy.", + "type": "string" + }, + "AccessPolicyIdentity": { + "$ref": "#/definitions/AccessPolicyIdentity", + "description": "The identity for this access policy. Choose either a user or a group but not both." + }, + "AccessPolicyPermission": { + "description": "The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.", + "type": "string" + }, + "AccessPolicyResource": { + "$ref": "#/definitions/AccessPolicyResource", + "description": "The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both." + } + }, + "readOnlyProperties": [ + "/properties/AccessPolicyArn", + "/properties/AccessPolicyId" + ], + "required": [ + "AccessPolicyIdentity", + "AccessPolicyPermission", + "AccessPolicyResource" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "taggable": false, + "typeName": "AWS::IoTSiteWise::AccessPolicy" +} diff --git a/schema/aws-iotsitewise-asset.json b/schema/aws-iotsitewise-asset.json index a76b6c7..3ca8be2 100644 --- a/schema/aws-iotsitewise-asset.json +++ b/schema/aws-iotsitewise-asset.json @@ -1,237 +1,237 @@ -{ - "additionalProperties": false, - "definitions": { - "AssetHierarchy": { - "additionalProperties": false, - "description": "A hierarchy specifies allowed parent/child asset relationships.", - "properties": { - "ChildAssetId": { - "description": "The ID of the child asset to be associated.", - "type": "string" - }, - "ExternalId": { - "description": "String-friendly customer provided external ID", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Id": { - "description": "Customer provided actual UUID for property", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "LogicalId": { - "description": "The LogicalID of a hierarchy in the parent asset's model.", - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - } - }, - "required": [ - "ChildAssetId" - ], - "type": "object" - }, - "AssetProperty": { - "additionalProperties": false, - "description": "The asset property's definition, alias, unit, and notification state.", - "properties": { - "Alias": { - "description": "The property alias that identifies the property.", - "type": "string" - }, - "ExternalId": { - "description": "String-friendly customer provided external ID", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Id": { - "description": "Customer provided actual UUID for property", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "LogicalId": { - "description": "Customer provided ID for property.", - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - }, - "NotificationState": { - "description": "The MQTT notification state (ENABLED or DISABLED) for this asset property.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Unit": { - "description": "The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::Asset", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:AssociateAssets", - "iotsitewise:CreateAsset", - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssociatedAssets", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetProperties", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:UpdateAssetProperty" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DeleteAsset", - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:DisassociateAssets", - "iotsitewise:ListAssociatedAssets", - "iotsitewise:ListAssetProperties", - "iotsitewise:ListTagsForResource", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetProperties" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListAssetModels", - "iotsitewise:ListAssets" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssociatedAssets", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:ListAssetProperties", - "iotsitewise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotsitewise:AssociateAssets", - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:DisassociateAssets", - "iotsitewise:ListAssociatedAssets", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:UpdateAsset", - "iotsitewise:UpdateAssetProperty", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetProperties", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssetId" - ], - "properties": { - "AssetArn": { - "description": "The ARN of the asset", - "type": "string" - }, - "AssetDescription": { - "description": "A description for the asset", - "type": "string" - }, - "AssetExternalId": { - "description": "The External ID of the asset", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "AssetHierarchies": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetHierarchy" - }, - "type": "array" - }, - "AssetId": { - "description": "The ID of the asset", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "AssetModelId": { - "description": "The ID of the asset model from which to create the asset.", - "type": "string" - }, - "AssetName": { - "description": "A unique, friendly name for the asset.", - "type": "string" - }, - "AssetProperties": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetProperty" - }, - "type": "array" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/AssetArn", - "/properties/AssetId", - "/properties/AssetProperties/*/Id", - "/properties/AssetHierarchies/*/Id" - ], - "required": [ - "AssetName", - "AssetModelId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::Asset" -} +{ + "additionalProperties": false, + "definitions": { + "AssetHierarchy": { + "additionalProperties": false, + "description": "A hierarchy specifies allowed parent/child asset relationships.", + "properties": { + "ChildAssetId": { + "description": "The ID of the child asset to be associated.", + "type": "string" + }, + "ExternalId": { + "description": "String-friendly customer provided external ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual UUID for property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "LogicalId": { + "description": "The LogicalID of a hierarchy in the parent asset's model.", + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + } + }, + "required": [ + "ChildAssetId" + ], + "type": "object" + }, + "AssetProperty": { + "additionalProperties": false, + "description": "The asset property's definition, alias, unit, and notification state.", + "properties": { + "Alias": { + "description": "The property alias that identifies the property.", + "type": "string" + }, + "ExternalId": { + "description": "String-friendly customer provided external ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual UUID for property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "LogicalId": { + "description": "Customer provided ID for property.", + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + }, + "NotificationState": { + "description": "The MQTT notification state (ENABLED or DISABLED) for this asset property.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Unit": { + "description": "The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::Asset", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:AssociateAssets", + "iotsitewise:CreateAsset", + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssociatedAssets", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:UpdateAssetProperty" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DeleteAsset", + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:DisassociateAssets", + "iotsitewise:ListAssociatedAssets", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListTagsForResource", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListAssetModels", + "iotsitewise:ListAssets" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssociatedAssets", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotsitewise:AssociateAssets", + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:DisassociateAssets", + "iotsitewise:ListAssociatedAssets", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:UpdateAsset", + "iotsitewise:UpdateAssetProperty", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssetId" + ], + "properties": { + "AssetArn": { + "description": "The ARN of the asset", + "type": "string" + }, + "AssetDescription": { + "description": "A description for the asset", + "type": "string" + }, + "AssetExternalId": { + "description": "The External ID of the asset", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "AssetHierarchies": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetHierarchy" + }, + "type": "array" + }, + "AssetId": { + "description": "The ID of the asset", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "AssetModelId": { + "description": "The ID of the asset model from which to create the asset.", + "type": "string" + }, + "AssetName": { + "description": "A unique, friendly name for the asset.", + "type": "string" + }, + "AssetProperties": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetProperty" + }, + "type": "array" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/AssetArn", + "/properties/AssetId", + "/properties/AssetProperties/*/Id", + "/properties/AssetHierarchies/*/Id" + ], + "required": [ + "AssetName", + "AssetModelId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::Asset" +} diff --git a/schema/aws-iotsitewise-assetmodel.json b/schema/aws-iotsitewise-assetmodel.json index e2ff16f..f78432d 100644 --- a/schema/aws-iotsitewise-assetmodel.json +++ b/schema/aws-iotsitewise-assetmodel.json @@ -1,566 +1,566 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AssetModelType" - ], - "definitions": { - "AssetModelCompositeModel": { - "additionalProperties": false, - "description": "Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.", - "properties": { - "ComposedAssetModelId": { - "description": "The component model ID for which the composite model is composed of", - "type": "string" - }, - "CompositeModelProperties": { - "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetModelProperty" - }, - "type": "array" - }, - "Description": { - "description": "A description for the asset composite model.", - "type": "string" - }, - "ExternalId": { - "description": "The External ID of the composite model", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Id": { - "description": "The Actual ID of the composite model", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "Name": { - "description": "A unique, friendly name for the asset composite model.", - "type": "string" - }, - "ParentAssetModelCompositeModelExternalId": { - "description": "The parent composite model External ID", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Path": { - "description": "The path of the composite model. This is only for derived composite models", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "Type": { - "description": "The type of the composite model. For alarm composite models, this type is AWS/ALARM", - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AssetModelHierarchy": { - "additionalProperties": false, - "description": "Contains information about an asset model hierarchy.", - "properties": { - "ChildAssetModelId": { - "description": "The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.", - "type": "string" - }, - "ExternalId": { - "description": "Customer provided external ID for hierarchy", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Id": { - "description": "Customer provided actual ID for hierarchy", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "LogicalId": { - "description": "Customer provided logical ID for hierarchy.", - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - }, - "Name": { - "description": "The name of the asset model hierarchy.", - "type": "string" - } - }, - "required": [ - "Name", - "ChildAssetModelId" - ], - "type": "object" - }, - "AssetModelProperty": { - "additionalProperties": false, - "description": "Contains information about an asset model property.", - "properties": { - "DataType": { - "$ref": "#/definitions/DataType", - "description": "The data type of the asset model property." - }, - "DataTypeSpec": { - "$ref": "#/definitions/DataTypeSpec", - "description": "The data type of the structure for this property." - }, - "ExternalId": { - "description": "The External ID of the Asset Model Property", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "Id": { - "description": "The ID of the Asset Model Property", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "LogicalId": { - "description": "Customer provided Logical ID for property.", - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - }, - "Name": { - "description": "The name of the asset model property.", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/PropertyType", - "description": "The property type" - }, - "Unit": { - "description": "The unit of the asset model property, such as Newtons or RPM.", - "type": "string" - } - }, - "required": [ - "Name", - "DataType", - "Type" - ], - "type": "object" - }, - "Attribute": { - "additionalProperties": false, - "properties": { - "DefaultValue": { - "type": "string" - } - }, - "type": "object" - }, - "DataType": { - "enum": [ - "STRING", - "INTEGER", - "DOUBLE", - "BOOLEAN", - "STRUCT" - ], - "type": "string" - }, - "DataTypeSpec": { - "enum": [ - "AWS/ALARM_STATE" - ], - "type": "string" - }, - "ExpressionVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "description": "The friendly name of the variable to be used in the expression.", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/VariableValue", - "description": "The variable that identifies an asset property from which to use values." - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "Interval": { - "description": "The time interval for the tumbling window.", - "type": "string" - }, - "Metric": { - "additionalProperties": false, - "properties": { - "Expression": { - "description": "The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.", - "type": "string" - }, - "Variables": { - "description": "The list of variables used in the expression.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ExpressionVariable" - }, - "type": "array" - }, - "Window": { - "$ref": "#/definitions/MetricWindow", - "description": "The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression" - } - }, - "required": [ - "Expression", - "Variables", - "Window" - ], - "type": "object" - }, - "MetricWindow": { - "additionalProperties": false, - "description": "Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).", - "properties": { - "Tumbling": { - "$ref": "#/definitions/TumblingWindow" - } - }, - "type": "object" - }, - "Offset": { - "description": "The shift or reference point on timeline for the contiguous time intervals.", - "type": "string" - }, - "PropertyPathDefinition": { - "additionalProperties": false, - "description": "The definition for property path which is used to reference properties in transforms/metrics", - "properties": { - "Name": { - "description": "The name of the property", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "PropertyType": { - "additionalProperties": false, - "description": "Contains a property type, which can be one of attribute, measurement, metric, or transform.", - "properties": { - "Attribute": { - "$ref": "#/definitions/Attribute" - }, - "Metric": { - "$ref": "#/definitions/Metric" - }, - "Transform": { - "$ref": "#/definitions/Transform" - }, - "TypeName": { - "$ref": "#/definitions/TypeName" - } - }, - "required": [ - "TypeName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Transform": { - "additionalProperties": false, - "properties": { - "Expression": { - "description": "The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.", - "type": "string" - }, - "Variables": { - "description": "The list of variables used in the expression.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ExpressionVariable" - }, - "type": "array" - } - }, - "required": [ - "Expression", - "Variables" - ], - "type": "object" - }, - "TumblingWindow": { - "additionalProperties": false, - "description": "Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.", - "properties": { - "Interval": { - "$ref": "#/definitions/Interval" - }, - "Offset": { - "$ref": "#/definitions/Offset" - } - }, - "required": [ - "Interval" - ], - "type": "object" - }, - "TypeName": { - "enum": [ - "Measurement", - "Attribute", - "Transform", - "Metric" - ], - "type": "string" - }, - "VariableValue": { - "additionalProperties": false, - "properties": { - "HierarchyExternalId": { - "description": "The External ID of the hierarchy that is trying to be referenced", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "HierarchyId": { - "description": "The ID of the hierarchy that is trying to be referenced", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "HierarchyLogicalId": { - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - }, - "PropertyExternalId": { - "description": "The External ID of the property that is trying to be referenced", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "PropertyId": { - "description": "The ID of the property that is trying to be referenced", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "PropertyLogicalId": { - "maxLength": 256, - "minLength": 1, - "pattern": "[^\\u0000-\\u001F\\u007F]+", - "type": "string" - }, - "PropertyPath": { - "description": "The path of the property that is trying to be referenced", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PropertyPathDefinition" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::AssetModel", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreateAssetModel", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:DescribeAssetModel", - "iotsitewise:UpdateAssetModel", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:UpdateAssetModelCompositeModel", - "iotsitewise:DescribeAssetModelCompositeModel", - "iotsitewise:CreateAssetModelCompositeModel" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribeAssetModel", - "iotsitewise:DeleteAssetModel", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels" - ] - }, - "list": { - "permissions": [ - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssetModels", - "iotsitewise:ListTagsForResource", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:DescribeAssetModelCompositeModel", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:UntagResource", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels", - "iotsitewise:CreateAssetModelCompositeModel", - "iotsitewise:UpdateAssetModelCompositeModel", - "iotsitewise:DeleteAssetModelCompositeModel", - "iotsitewise:DescribeAssetModelCompositeModel", - "iotsitewise:UpdateAssetModel" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssetModelId" - ], - "properties": { - "AssetModelArn": { - "description": "The ARN of the asset model, which has the following format.", - "type": "string" - }, - "AssetModelCompositeModels": { - "description": "The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetModelCompositeModel" - }, - "type": "array" - }, - "AssetModelDescription": { - "description": "A description for the asset model.", - "type": "string" - }, - "AssetModelExternalId": { - "description": "The external ID of the asset model.", - "maxLength": 128, - "minLength": 2, - "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", - "type": "string" - }, - "AssetModelHierarchies": { - "description": "The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetModelHierarchy" - }, - "type": "array" - }, - "AssetModelId": { - "description": "The ID of the asset model.", - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "AssetModelName": { - "description": "A unique, friendly name for the asset model.", - "type": "string" - }, - "AssetModelProperties": { - "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AssetModelProperty" - }, - "type": "array" - }, - "AssetModelType": { - "description": "The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AssetModelArn", - "/properties/AssetModelId", - "/properties/AssetModelProperties/*/Id", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", - "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyId", - "/properties/AssetModelHierarchies/*/Id", - "/properties/AssetModelCompositeModels/*/Id", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Id", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyId" - ], - "required": [ - "AssetModelName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::AssetModel", - "writeOnlyProperties": [ - "/properties/AssetModelProperties/*/DataTypeSpec", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", - "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", - "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", - "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/DataTypeSpec" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AssetModelType" + ], + "definitions": { + "AssetModelCompositeModel": { + "additionalProperties": false, + "description": "Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.", + "properties": { + "ComposedAssetModelId": { + "description": "The component model ID for which the composite model is composed of", + "type": "string" + }, + "CompositeModelProperties": { + "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetModelProperty" + }, + "type": "array" + }, + "Description": { + "description": "A description for the asset composite model.", + "type": "string" + }, + "ExternalId": { + "description": "The External ID of the composite model", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "The Actual ID of the composite model", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "Name": { + "description": "A unique, friendly name for the asset composite model.", + "type": "string" + }, + "ParentAssetModelCompositeModelExternalId": { + "description": "The parent composite model External ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Path": { + "description": "The path of the composite model. This is only for derived composite models", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "description": "The type of the composite model. For alarm composite models, this type is AWS/ALARM", + "type": "string" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "AssetModelHierarchy": { + "additionalProperties": false, + "description": "Contains information about an asset model hierarchy.", + "properties": { + "ChildAssetModelId": { + "description": "The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.", + "type": "string" + }, + "ExternalId": { + "description": "Customer provided external ID for hierarchy", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual ID for hierarchy", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "LogicalId": { + "description": "Customer provided logical ID for hierarchy.", + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + }, + "Name": { + "description": "The name of the asset model hierarchy.", + "type": "string" + } + }, + "required": [ + "Name", + "ChildAssetModelId" + ], + "type": "object" + }, + "AssetModelProperty": { + "additionalProperties": false, + "description": "Contains information about an asset model property.", + "properties": { + "DataType": { + "$ref": "#/definitions/DataType", + "description": "The data type of the asset model property." + }, + "DataTypeSpec": { + "$ref": "#/definitions/DataTypeSpec", + "description": "The data type of the structure for this property." + }, + "ExternalId": { + "description": "The External ID of the Asset Model Property", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "The ID of the Asset Model Property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "LogicalId": { + "description": "Customer provided Logical ID for property.", + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + }, + "Name": { + "description": "The name of the asset model property.", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/PropertyType", + "description": "The property type" + }, + "Unit": { + "description": "The unit of the asset model property, such as Newtons or RPM.", + "type": "string" + } + }, + "required": [ + "Name", + "DataType", + "Type" + ], + "type": "object" + }, + "Attribute": { + "additionalProperties": false, + "properties": { + "DefaultValue": { + "type": "string" + } + }, + "type": "object" + }, + "DataType": { + "enum": [ + "STRING", + "INTEGER", + "DOUBLE", + "BOOLEAN", + "STRUCT" + ], + "type": "string" + }, + "DataTypeSpec": { + "enum": [ + "AWS/ALARM_STATE" + ], + "type": "string" + }, + "ExpressionVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "description": "The friendly name of the variable to be used in the expression.", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/VariableValue", + "description": "The variable that identifies an asset property from which to use values." + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "Interval": { + "description": "The time interval for the tumbling window.", + "type": "string" + }, + "Metric": { + "additionalProperties": false, + "properties": { + "Expression": { + "description": "The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.", + "type": "string" + }, + "Variables": { + "description": "The list of variables used in the expression.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ExpressionVariable" + }, + "type": "array" + }, + "Window": { + "$ref": "#/definitions/MetricWindow", + "description": "The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression" + } + }, + "required": [ + "Expression", + "Variables", + "Window" + ], + "type": "object" + }, + "MetricWindow": { + "additionalProperties": false, + "description": "Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).", + "properties": { + "Tumbling": { + "$ref": "#/definitions/TumblingWindow" + } + }, + "type": "object" + }, + "Offset": { + "description": "The shift or reference point on timeline for the contiguous time intervals.", + "type": "string" + }, + "PropertyPathDefinition": { + "additionalProperties": false, + "description": "The definition for property path which is used to reference properties in transforms/metrics", + "properties": { + "Name": { + "description": "The name of the property", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "PropertyType": { + "additionalProperties": false, + "description": "Contains a property type, which can be one of attribute, measurement, metric, or transform.", + "properties": { + "Attribute": { + "$ref": "#/definitions/Attribute" + }, + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Transform": { + "$ref": "#/definitions/Transform" + }, + "TypeName": { + "$ref": "#/definitions/TypeName" + } + }, + "required": [ + "TypeName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Transform": { + "additionalProperties": false, + "properties": { + "Expression": { + "description": "The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.", + "type": "string" + }, + "Variables": { + "description": "The list of variables used in the expression.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ExpressionVariable" + }, + "type": "array" + } + }, + "required": [ + "Expression", + "Variables" + ], + "type": "object" + }, + "TumblingWindow": { + "additionalProperties": false, + "description": "Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.", + "properties": { + "Interval": { + "$ref": "#/definitions/Interval" + }, + "Offset": { + "$ref": "#/definitions/Offset" + } + }, + "required": [ + "Interval" + ], + "type": "object" + }, + "TypeName": { + "enum": [ + "Measurement", + "Attribute", + "Transform", + "Metric" + ], + "type": "string" + }, + "VariableValue": { + "additionalProperties": false, + "properties": { + "HierarchyExternalId": { + "description": "The External ID of the hierarchy that is trying to be referenced", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "HierarchyId": { + "description": "The ID of the hierarchy that is trying to be referenced", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "HierarchyLogicalId": { + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + }, + "PropertyExternalId": { + "description": "The External ID of the property that is trying to be referenced", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "PropertyId": { + "description": "The ID of the property that is trying to be referenced", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "PropertyLogicalId": { + "maxLength": 256, + "minLength": 1, + "pattern": "[^\\u0000-\\u001F\\u007F]+", + "type": "string" + }, + "PropertyPath": { + "description": "The path of the property that is trying to be referenced", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PropertyPathDefinition" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::AssetModel", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreateAssetModel", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:DescribeAssetModel", + "iotsitewise:UpdateAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:UpdateAssetModelCompositeModel", + "iotsitewise:DescribeAssetModelCompositeModel", + "iotsitewise:CreateAssetModelCompositeModel" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribeAssetModel", + "iotsitewise:DeleteAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" + ] + }, + "list": { + "permissions": [ + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModels", + "iotsitewise:ListTagsForResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:DescribeAssetModelCompositeModel", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:UntagResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:CreateAssetModelCompositeModel", + "iotsitewise:UpdateAssetModelCompositeModel", + "iotsitewise:DeleteAssetModelCompositeModel", + "iotsitewise:DescribeAssetModelCompositeModel", + "iotsitewise:UpdateAssetModel" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssetModelId" + ], + "properties": { + "AssetModelArn": { + "description": "The ARN of the asset model, which has the following format.", + "type": "string" + }, + "AssetModelCompositeModels": { + "description": "The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetModelCompositeModel" + }, + "type": "array" + }, + "AssetModelDescription": { + "description": "A description for the asset model.", + "type": "string" + }, + "AssetModelExternalId": { + "description": "The external ID of the asset model.", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "AssetModelHierarchies": { + "description": "The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetModelHierarchy" + }, + "type": "array" + }, + "AssetModelId": { + "description": "The ID of the asset model.", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "AssetModelName": { + "description": "A unique, friendly name for the asset model.", + "type": "string" + }, + "AssetModelProperties": { + "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AssetModelProperty" + }, + "type": "array" + }, + "AssetModelType": { + "description": "The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AssetModelArn", + "/properties/AssetModelId", + "/properties/AssetModelProperties/*/Id", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyId", + "/properties/AssetModelHierarchies/*/Id", + "/properties/AssetModelCompositeModels/*/Id", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Id", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyId" + ], + "required": [ + "AssetModelName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::AssetModel", + "writeOnlyProperties": [ + "/properties/AssetModelProperties/*/DataTypeSpec", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/DataTypeSpec" + ] +} diff --git a/schema/aws-iotsitewise-dashboard.json b/schema/aws-iotsitewise-dashboard.json index ada6843..95d26cb 100644 --- a/schema/aws-iotsitewise-dashboard.json +++ b/schema/aws-iotsitewise-dashboard.json @@ -1,125 +1,125 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DashboardArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProjectId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::Dashboard", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreateDashboard", - "iotsitewise:DescribeDashboard", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribeDashboard", - "iotsitewise:DeleteDashboard" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListDashboards" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeDashboard", - "iotsitewise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotsitewise:DescribeDashboard", - "iotsitewise:UpdateDashboard", - "iotsitewise:TagResource", - "iotsitewise:UntagResource", - "iotsitewise:ListTagsForResource", - "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel", - "iotsitewise:ListAssetModelProperties", - "iotsitewise:ListAssetModelCompositeModels" - ] - } - }, - "primaryIdentifier": [ - "/properties/DashboardId" - ], - "properties": { - "DashboardArn": { - "description": "The ARN of the dashboard.", - "type": "string" - }, - "DashboardDefinition": { - "description": "The dashboard definition specified in a JSON literal.", - "type": "string" - }, - "DashboardDescription": { - "description": "A description for the dashboard.", - "type": "string" - }, - "DashboardId": { - "description": "The ID of the dashboard.", - "type": "string" - }, - "DashboardName": { - "description": "A friendly name for the dashboard.", - "type": "string" - }, - "ProjectId": { - "description": "The ID of the project in which to create the dashboard.", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the dashboard.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/DashboardArn", - "/properties/DashboardId" - ], - "required": [ - "DashboardDefinition", - "DashboardDescription", - "DashboardName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotsitewise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::Dashboard" -} +{ + "additionalIdentifiers": [ + [ + "/properties/DashboardArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProjectId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::Dashboard", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreateDashboard", + "iotsitewise:DescribeDashboard", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribeDashboard", + "iotsitewise:DeleteDashboard" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListDashboards" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeDashboard", + "iotsitewise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotsitewise:DescribeDashboard", + "iotsitewise:UpdateDashboard", + "iotsitewise:TagResource", + "iotsitewise:UntagResource", + "iotsitewise:ListTagsForResource", + "iotsitewise:DescribeAsset", + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" + ] + } + }, + "primaryIdentifier": [ + "/properties/DashboardId" + ], + "properties": { + "DashboardArn": { + "description": "The ARN of the dashboard.", + "type": "string" + }, + "DashboardDefinition": { + "description": "The dashboard definition specified in a JSON literal.", + "type": "string" + }, + "DashboardDescription": { + "description": "A description for the dashboard.", + "type": "string" + }, + "DashboardId": { + "description": "The ID of the dashboard.", + "type": "string" + }, + "DashboardName": { + "description": "A friendly name for the dashboard.", + "type": "string" + }, + "ProjectId": { + "description": "The ID of the project in which to create the dashboard.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the dashboard.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/DashboardArn", + "/properties/DashboardId" + ], + "required": [ + "DashboardDefinition", + "DashboardDescription", + "DashboardName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotsitewise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::Dashboard" +} diff --git a/schema/aws-iotsitewise-gateway.json b/schema/aws-iotsitewise-gateway.json index 20942d1..da9e83e 100644 --- a/schema/aws-iotsitewise-gateway.json +++ b/schema/aws-iotsitewise-gateway.json @@ -1,219 +1,219 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GatewayPlatform" - ], - "definitions": { - "CapabilityConfiguration": { - "description": "The JSON document that defines the gateway capability's configuration.", - "type": "string" - }, - "CapabilityNamespace": { - "description": "The namespace of the capability configuration.", - "type": "string" - }, - "GatewayCapabilitySummary": { - "additionalProperties": false, - "description": "Contains a summary of a gateway capability configuration.", - "properties": { - "CapabilityConfiguration": { - "$ref": "#/definitions/CapabilityConfiguration" - }, - "CapabilityNamespace": { - "$ref": "#/definitions/CapabilityNamespace" - } - }, - "required": [ - "CapabilityNamespace" - ], - "type": "object" - }, - "GatewayPlatform": { - "additionalProperties": false, - "description": "Contains a gateway's platform information.", - "oneOf": [ - { - "required": [ - "Greengrass" - ] - }, - { - "required": [ - "GreengrassV2" - ] - }, - { - "required": [ - "SiemensIE" - ] - } - ], - "properties": { - "Greengrass": { - "$ref": "#/definitions/Greengrass", - "description": "A gateway that runs on AWS IoT Greengrass V1." - }, - "GreengrassV2": { - "$ref": "#/definitions/GreengrassV2", - "description": "A gateway that runs on AWS IoT Greengrass V2." - }, - "SiemensIE": { - "$ref": "#/definitions/SiemensIE", - "description": "A gateway that runs on Siemens Industrial Edge." - } - }, - "type": "object" - }, - "Greengrass": { - "additionalProperties": false, - "description": "Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.", - "properties": { - "GroupArn": { - "description": "The ARN of the Greengrass group.", - "type": "string" - } - }, - "required": [ - "GroupArn" - ], - "type": "object" - }, - "GreengrassV2": { - "additionalProperties": false, - "description": "Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.", - "properties": { - "CoreDeviceThingName": { - "description": "The name of the CoreDevice in GreenGrass V2.", - "type": "string" - } - }, - "required": [ - "CoreDeviceThingName" - ], - "type": "object" - }, - "SiemensIE": { - "additionalProperties": false, - "description": "Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.", - "properties": { - "IotCoreThingName": { - "description": "The name of the IoT Core Thing.", - "type": "string" - } - }, - "required": [ - "IotCoreThingName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::Gateway", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreateGateway", - "iotsitewise:DescribeGateway", - "iotsitewise:DescribeGatewayCapabilityConfiguration", - "iotsitewise:UpdateGatewayCapabilityConfiguration", - "iam:PassRole", - "iam:GetRole", - "greengrass:GetCoreDevice", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iot:DescribeThing" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribeGateway", - "iotsitewise:DescribeGatewayCapabilityConfiguration", - "iotsitewise:DeleteGateway" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListGateways" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeGateway", - "iotsitewise:DescribeGatewayCapabilityConfiguration", - "iotsitewise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotsitewise:UpdateGateway", - "iotsitewise:UpdateGatewayCapabilityConfiguration", - "iotsitewise:TagResource", - "iotsitewise:UntagResource", - "iotsitewise:DescribeGateway", - "iotsitewise:DescribeGatewayCapabilityConfiguration", - "iotsitewise:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/GatewayId" - ], - "properties": { - "GatewayCapabilitySummaries": { - "description": "A list of gateway capability summaries that each contain a namespace and status.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/GatewayCapabilitySummary" - }, - "type": "array", - "uniqueItems": true - }, - "GatewayId": { - "description": "The ID of the gateway device.", - "type": "string" - }, - "GatewayName": { - "description": "A unique, friendly name for the gateway.", - "type": "string" - }, - "GatewayPlatform": { - "$ref": "#/definitions/GatewayPlatform", - "description": "The gateway's platform. You can only specify one platform in a gateway." - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/GatewayId" - ], - "required": [ - "GatewayName", - "GatewayPlatform" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::Gateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GatewayPlatform" + ], + "definitions": { + "CapabilityConfiguration": { + "description": "The JSON document that defines the gateway capability's configuration.", + "type": "string" + }, + "CapabilityNamespace": { + "description": "The namespace of the capability configuration.", + "type": "string" + }, + "GatewayCapabilitySummary": { + "additionalProperties": false, + "description": "Contains a summary of a gateway capability configuration.", + "properties": { + "CapabilityConfiguration": { + "$ref": "#/definitions/CapabilityConfiguration" + }, + "CapabilityNamespace": { + "$ref": "#/definitions/CapabilityNamespace" + } + }, + "required": [ + "CapabilityNamespace" + ], + "type": "object" + }, + "GatewayPlatform": { + "additionalProperties": false, + "description": "Contains a gateway's platform information.", + "oneOf": [ + { + "required": [ + "Greengrass" + ] + }, + { + "required": [ + "GreengrassV2" + ] + }, + { + "required": [ + "SiemensIE" + ] + } + ], + "properties": { + "Greengrass": { + "$ref": "#/definitions/Greengrass", + "description": "A gateway that runs on AWS IoT Greengrass V1." + }, + "GreengrassV2": { + "$ref": "#/definitions/GreengrassV2", + "description": "A gateway that runs on AWS IoT Greengrass V2." + }, + "SiemensIE": { + "$ref": "#/definitions/SiemensIE", + "description": "A gateway that runs on Siemens Industrial Edge." + } + }, + "type": "object" + }, + "Greengrass": { + "additionalProperties": false, + "description": "Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.", + "properties": { + "GroupArn": { + "description": "The ARN of the Greengrass group.", + "type": "string" + } + }, + "required": [ + "GroupArn" + ], + "type": "object" + }, + "GreengrassV2": { + "additionalProperties": false, + "description": "Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.", + "properties": { + "CoreDeviceThingName": { + "description": "The name of the CoreDevice in GreenGrass V2.", + "type": "string" + } + }, + "required": [ + "CoreDeviceThingName" + ], + "type": "object" + }, + "SiemensIE": { + "additionalProperties": false, + "description": "Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.", + "properties": { + "IotCoreThingName": { + "description": "The name of the IoT Core Thing.", + "type": "string" + } + }, + "required": [ + "IotCoreThingName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::Gateway", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreateGateway", + "iotsitewise:DescribeGateway", + "iotsitewise:DescribeGatewayCapabilityConfiguration", + "iotsitewise:UpdateGatewayCapabilityConfiguration", + "iam:PassRole", + "iam:GetRole", + "greengrass:GetCoreDevice", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iot:DescribeThing" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribeGateway", + "iotsitewise:DescribeGatewayCapabilityConfiguration", + "iotsitewise:DeleteGateway" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListGateways" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeGateway", + "iotsitewise:DescribeGatewayCapabilityConfiguration", + "iotsitewise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotsitewise:UpdateGateway", + "iotsitewise:UpdateGatewayCapabilityConfiguration", + "iotsitewise:TagResource", + "iotsitewise:UntagResource", + "iotsitewise:DescribeGateway", + "iotsitewise:DescribeGatewayCapabilityConfiguration", + "iotsitewise:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/GatewayId" + ], + "properties": { + "GatewayCapabilitySummaries": { + "description": "A list of gateway capability summaries that each contain a namespace and status.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/GatewayCapabilitySummary" + }, + "type": "array", + "uniqueItems": true + }, + "GatewayId": { + "description": "The ID of the gateway device.", + "type": "string" + }, + "GatewayName": { + "description": "A unique, friendly name for the gateway.", + "type": "string" + }, + "GatewayPlatform": { + "$ref": "#/definitions/GatewayPlatform", + "description": "The gateway's platform. You can only specify one platform in a gateway." + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/GatewayId" + ], + "required": [ + "GatewayName", + "GatewayPlatform" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::Gateway" +} diff --git a/schema/aws-iotsitewise-portal.json b/schema/aws-iotsitewise-portal.json index 17cd080..5ba6fe0 100644 --- a/schema/aws-iotsitewise-portal.json +++ b/schema/aws-iotsitewise-portal.json @@ -1,160 +1,160 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/PortalArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortalAuthMode" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::Portal", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreatePortal", - "iotsitewise:DescribePortal", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iam:PassRole", - "sso:CreateManagedApplicationInstance", - "sso:DescribeRegisteredRegions" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribePortal", - "iotsitewise:DeletePortal", - "sso:DeleteManagedApplicationInstance" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListPortals" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribePortal", - "iotsitewise:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotsitewise:DescribePortal", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:UpdatePortal", - "iotsitewise:UntagResource", - "iam:PassRole", - "sso:GetManagedApplicationInstance", - "sso:UpdateApplicationInstanceDisplayData" - ] - } - }, - "primaryIdentifier": [ - "/properties/PortalId" - ], - "properties": { - "Alarms": { - "additionalProperties": false, - "description": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.", - "properties": { - "AlarmRoleArn": { - "description": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.", - "type": "string" - }, - "NotificationLambdaArn": { - "description": "The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.", - "type": "string" - } - }, - "type": "object" - }, - "NotificationSenderEmail": { - "description": "The email address that sends alarm notifications.", - "type": "string" - }, - "PortalArn": { - "description": "The ARN of the portal, which has the following format.", - "type": "string" - }, - "PortalAuthMode": { - "description": "The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.", - "type": "string" - }, - "PortalClientId": { - "description": "The AWS SSO application generated client ID (used with AWS SSO APIs).", - "type": "string" - }, - "PortalContactEmail": { - "description": "The AWS administrator's contact email address.", - "type": "string" - }, - "PortalDescription": { - "description": "A description for the portal.", - "type": "string" - }, - "PortalId": { - "description": "The ID of the portal.", - "type": "string" - }, - "PortalName": { - "description": "A friendly name for the portal.", - "type": "string" - }, - "PortalStartUrl": { - "description": "The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the portal.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/PortalArn", - "/properties/PortalClientId", - "/properties/PortalId", - "/properties/PortalStartUrl" - ], - "required": [ - "PortalContactEmail", - "PortalName", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotsitewise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::Portal", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/PortalArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortalAuthMode" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::Portal", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreatePortal", + "iotsitewise:DescribePortal", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iam:PassRole", + "sso:CreateManagedApplicationInstance", + "sso:DescribeRegisteredRegions" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribePortal", + "iotsitewise:DeletePortal", + "sso:DeleteManagedApplicationInstance" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListPortals" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribePortal", + "iotsitewise:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotsitewise:DescribePortal", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:UpdatePortal", + "iotsitewise:UntagResource", + "iam:PassRole", + "sso:GetManagedApplicationInstance", + "sso:UpdateApplicationInstanceDisplayData" + ] + } + }, + "primaryIdentifier": [ + "/properties/PortalId" + ], + "properties": { + "Alarms": { + "additionalProperties": false, + "description": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.", + "properties": { + "AlarmRoleArn": { + "description": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.", + "type": "string" + }, + "NotificationLambdaArn": { + "description": "The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.", + "type": "string" + } + }, + "type": "object" + }, + "NotificationSenderEmail": { + "description": "The email address that sends alarm notifications.", + "type": "string" + }, + "PortalArn": { + "description": "The ARN of the portal, which has the following format.", + "type": "string" + }, + "PortalAuthMode": { + "description": "The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.", + "type": "string" + }, + "PortalClientId": { + "description": "The AWS SSO application generated client ID (used with AWS SSO APIs).", + "type": "string" + }, + "PortalContactEmail": { + "description": "The AWS administrator's contact email address.", + "type": "string" + }, + "PortalDescription": { + "description": "A description for the portal.", + "type": "string" + }, + "PortalId": { + "description": "The ID of the portal.", + "type": "string" + }, + "PortalName": { + "description": "A friendly name for the portal.", + "type": "string" + }, + "PortalStartUrl": { + "description": "The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the portal.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/PortalArn", + "/properties/PortalClientId", + "/properties/PortalId", + "/properties/PortalStartUrl" + ], + "required": [ + "PortalContactEmail", + "PortalName", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotsitewise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::Portal", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-iotsitewise-project.json b/schema/aws-iotsitewise-project.json index 7f48c13..e10731f 100644 --- a/schema/aws-iotsitewise-project.json +++ b/schema/aws-iotsitewise-project.json @@ -1,125 +1,125 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortalId" - ], - "definitions": { - "AssetId": { - "description": "The ID of the asset", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTSiteWise::Project", - "handlers": { - "create": { - "permissions": [ - "iotsitewise:CreateProject", - "iotsitewise:DescribeProject", - "iotsitewise:ListProjectAssets", - "iotsitewise:ListTagsForResource", - "iotsitewise:TagResource", - "iotsitewise:BatchAssociateProjectAssets" - ] - }, - "delete": { - "permissions": [ - "iotsitewise:DescribeProject", - "iotsitewise:DeleteProject" - ] - }, - "list": { - "permissions": [ - "iotsitewise:ListProjects" - ] - }, - "read": { - "permissions": [ - "iotsitewise:DescribeProject", - "iotsitewise:ListTagsForResource", - "iotsitewise:ListProjectAssets" - ] - }, - "update": { - "permissions": [ - "iotsitewise:DescribeProject", - "iotsitewise:UpdateProject", - "iotsitewise:BatchAssociateProjectAssets", - "iotsitewise:BatchDisAssociateProjectAssets", - "iotsitewise:ListProjectAssets", - "iotsitewise:TagResource", - "iotsitewise:UntagResource", - "iotsitewise:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProjectId" - ], - "properties": { - "AssetIds": { - "description": "The IDs of the assets to be associated to the project.", - "items": { - "$ref": "#/definitions/AssetId" - }, - "type": "array", - "uniqueItems": true - }, - "PortalId": { - "description": "The ID of the portal in which to create the project.", - "type": "string" - }, - "ProjectArn": { - "description": "The ARN of the project.", - "type": "string" - }, - "ProjectDescription": { - "description": "A description for the project.", - "type": "string" - }, - "ProjectId": { - "description": "The ID of the project.", - "type": "string" - }, - "ProjectName": { - "description": "A friendly name for the project.", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the project.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ProjectId", - "/properties/ProjectArn" - ], - "required": [ - "PortalId", - "ProjectName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", - "taggable": true, - "typeName": "AWS::IoTSiteWise::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortalId" + ], + "definitions": { + "AssetId": { + "description": "The ID of the asset", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTSiteWise::Project", + "handlers": { + "create": { + "permissions": [ + "iotsitewise:CreateProject", + "iotsitewise:DescribeProject", + "iotsitewise:ListProjectAssets", + "iotsitewise:ListTagsForResource", + "iotsitewise:TagResource", + "iotsitewise:BatchAssociateProjectAssets" + ] + }, + "delete": { + "permissions": [ + "iotsitewise:DescribeProject", + "iotsitewise:DeleteProject" + ] + }, + "list": { + "permissions": [ + "iotsitewise:ListProjects" + ] + }, + "read": { + "permissions": [ + "iotsitewise:DescribeProject", + "iotsitewise:ListTagsForResource", + "iotsitewise:ListProjectAssets" + ] + }, + "update": { + "permissions": [ + "iotsitewise:DescribeProject", + "iotsitewise:UpdateProject", + "iotsitewise:BatchAssociateProjectAssets", + "iotsitewise:BatchDisAssociateProjectAssets", + "iotsitewise:ListProjectAssets", + "iotsitewise:TagResource", + "iotsitewise:UntagResource", + "iotsitewise:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProjectId" + ], + "properties": { + "AssetIds": { + "description": "The IDs of the assets to be associated to the project.", + "items": { + "$ref": "#/definitions/AssetId" + }, + "type": "array", + "uniqueItems": true + }, + "PortalId": { + "description": "The ID of the portal in which to create the project.", + "type": "string" + }, + "ProjectArn": { + "description": "The ARN of the project.", + "type": "string" + }, + "ProjectDescription": { + "description": "A description for the project.", + "type": "string" + }, + "ProjectId": { + "description": "The ID of the project.", + "type": "string" + }, + "ProjectName": { + "description": "A friendly name for the project.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the project.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ProjectId", + "/properties/ProjectArn" + ], + "required": [ + "PortalId", + "ProjectName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "taggable": true, + "typeName": "AWS::IoTSiteWise::Project" +} diff --git a/schema/aws-iotthingsgraph-flowtemplate.json b/schema/aws-iotthingsgraph-flowtemplate.json index e645059..bea39ac 100644 --- a/schema/aws-iotthingsgraph-flowtemplate.json +++ b/schema/aws-iotthingsgraph-flowtemplate.json @@ -1,43 +1,43 @@ -{ - "additionalProperties": false, - "definitions": { - "DefinitionDocument": { - "additionalProperties": false, - "properties": { - "Language": { - "type": "string" - }, - "Text": { - "type": "string" - } - }, - "required": [ - "Language", - "Text" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IoTThingsGraph::FlowTemplate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CompatibleNamespaceVersion": { - "type": "number" - }, - "Definition": { - "$ref": "#/definitions/DefinitionDocument" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Definition" - ], - "typeName": "AWS::IoTThingsGraph::FlowTemplate" -} +{ + "additionalProperties": false, + "definitions": { + "DefinitionDocument": { + "additionalProperties": false, + "properties": { + "Language": { + "type": "string" + }, + "Text": { + "type": "string" + } + }, + "required": [ + "Language", + "Text" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IoTThingsGraph::FlowTemplate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CompatibleNamespaceVersion": { + "type": "number" + }, + "Definition": { + "$ref": "#/definitions/DefinitionDocument" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Definition" + ], + "typeName": "AWS::IoTThingsGraph::FlowTemplate" +} diff --git a/schema/aws-iottwinmaker-componenttype.json b/schema/aws-iottwinmaker-componenttype.json index df21879..6df1c9c 100644 --- a/schema/aws-iottwinmaker-componenttype.json +++ b/schema/aws-iottwinmaker-componenttype.json @@ -1,558 +1,558 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkspaceId", - "/properties/ComponentTypeId" - ], - "definitions": { - "CompositeComponentType": { - "additionalProperties": false, - "description": "An object that sets information about a composite component type.", - "properties": { - "ComponentTypeId": { - "description": "The id of the composite component type.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\.\\-0-9:]+", - "type": "string" - } - }, - "type": "object" - }, - "DataConnector": { - "additionalProperties": false, - "description": "The data connector.", - "properties": { - "IsNative": { - "description": "A Boolean value that specifies whether the data connector is native to IoT TwinMaker.", - "type": "boolean" - }, - "Lambda": { - "$ref": "#/definitions/LambdaFunction", - "description": "The Lambda function associated with this data connector." - } - }, - "type": "object" - }, - "DataType": { - "additionalProperties": false, - "description": "An object that specifies the data type of a property.", - "properties": { - "AllowedValues": { - "description": "The allowed values for this data type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataValue" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "NestedType": { - "$ref": "#/definitions/DataType", - "description": "The nested type in the data type." - }, - "Relationship": { - "$ref": "#/definitions/Relationship", - "description": "A relationship that associates a component with another component." - }, - "Type": { - "description": "The underlying type of the data type.", - "enum": [ - "RELATIONSHIP", - "STRING", - "LONG", - "BOOLEAN", - "INTEGER", - "DOUBLE", - "LIST", - "MAP" - ], - "type": "string" - }, - "UnitOfMeasure": { - "description": "The unit of measure used in this data type.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "DataValue": { - "additionalProperties": false, - "description": "An object that specifies a value for a property.", - "properties": { - "BooleanValue": { - "description": "A Boolean value.", - "type": "boolean" - }, - "DoubleValue": { - "description": "A double value.", - "type": "number" - }, - "Expression": { - "description": "An expression that produces the value.", - "maxLength": 316, - "minLength": 1, - "pattern": "(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)", - "type": "string" - }, - "IntegerValue": { - "description": "An integer value.", - "type": "integer" - }, - "ListValue": { - "description": "A list of multiple values.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataValue" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "LongValue": { - "description": "A long value.", - "type": "number" - }, - "MapValue": { - "additionalProperties": false, - "description": "An object that maps strings to multiple DataValue objects. \n\n", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/DataValue" - } - }, - "type": "object" - }, - "RelationshipValue": { - "additionalProperties": false, - "description": "A value that relates a component to another component.", - "properties": { - "TargetComponentName": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "TargetEntityId": { - "maxLength": 128, - "minLength": 1, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "type": "object" - }, - "StringValue": { - "description": "A string value.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "DateTimeFormat": { - "format": "date-time", - "type": "string" - }, - "Function": { - "additionalProperties": false, - "description": "The function of component type.", - "properties": { - "ImplementedBy": { - "$ref": "#/definitions/DataConnector", - "description": "The data connector." - }, - "RequiredProperties": { - "description": "The required properties of the function.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RequiredProperty" - }, - "maxItems": 256, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Scope": { - "description": "The scope of the function.", - "enum": [ - "ENTITY", - "WORKSPACE" - ], - "type": "string" - } - }, - "type": "object" - }, - "LambdaFunction": { - "additionalProperties": false, - "properties": { - "Arn": { - "maxLength": 128, - "minLength": 1, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\\/a-zA-Z0-9_-]+", - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "ParentComponentType": { - "pattern": "[a-zA-Z_\\.\\-0-9:]+", - "type": "string" - }, - "PropertyDefinition": { - "additionalProperties": false, - "description": "An object that sets information about a property.", - "properties": { - "Configurations": { - "additionalProperties": false, - "description": "An object that specifies information about a property.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - } - }, - "type": "object" - }, - "DataType": { - "$ref": "#/definitions/DataType", - "description": "An object that contains information about the data type." - }, - "DefaultValue": { - "$ref": "#/definitions/DataValue", - "description": "An object that contains the default value." - }, - "IsExternalId": { - "description": "A Boolean value that specifies whether the property ID comes from an external data store.", - "type": "boolean" - }, - "IsRequiredInEntity": { - "description": "A Boolean value that specifies whether the property is required.", - "type": "boolean" - }, - "IsStoredExternally": { - "description": "A Boolean value that specifies whether the property is stored externally.", - "type": "boolean" - }, - "IsTimeSeries": { - "description": "A Boolean value that specifies whether the property consists of time series data.", - "type": "boolean" - } - }, - "type": "object" - }, - "PropertyGroup": { - "additionalProperties": false, - "description": "An object that sets information about a property group.", - "properties": { - "GroupType": { - "description": "The type of property group.", - "enum": [ - "TABULAR" - ], - "type": "string" - }, - "PropertyNames": { - "description": "The list of property names in the property group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PropertyName" - }, - "maxItems": 256, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "PropertyName": { - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "Relationship": { - "additionalProperties": false, - "description": "The type of the relationship.", - "properties": { - "RelationshipType": { - "description": "The type of the relationship.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "TargetComponentTypeId": { - "description": "The ID of the target component type associated with this relationship.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\.\\-0-9:]+", - "type": "string" - } - }, - "type": "object" - }, - "RequiredProperty": { - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "Status": { - "additionalProperties": false, - "properties": { - "Error": { - "anyOf": [ - { - "additionalProperties": false, - "description": "Empty Error object.", - "type": "object" - }, - { - "additionalProperties": false, - "description": "Error object with Message and Code.", - "properties": { - "Code": { - "enum": [ - "VALIDATION_ERROR", - "INTERNAL_FAILURE" - ], - "type": "string" - }, - "Message": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - ], - "type": "object" - }, - "State": { - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "ERROR" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTTwinMaker::ComponentType", - "handlers": { - "create": { - "permissions": [ - "iottwinmaker:CreateComponentType", - "iottwinmaker:GetComponentType", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource" - ] - }, - "delete": { - "permissions": [ - "iottwinmaker:DeleteComponentType", - "iottwinmaker:GetComponentType", - "iottwinmaker:GetWorkspace" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "WorkspaceId": { - "$ref": "resource-schema.json#/properties/WorkspaceId", - "type": "string" - } - }, - "required": [ - "WorkspaceId" - ] - }, - "permissions": [ - "iottwinmaker:GetComponentType", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListComponentTypes", - "iottwinmaker:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iottwinmaker:GetComponentType", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iottwinmaker:GetComponentType", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource", - "iottwinmaker:UntagResource", - "iottwinmaker:UpdateComponentType" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkspaceId", - "/properties/ComponentTypeId" - ], - "properties": { - "Arn": { - "description": "The ARN of the component type.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", - "type": "string" - }, - "ComponentTypeId": { - "description": "The ID of the component type.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\.\\-0-9:]+", - "type": "string" - }, - "CompositeComponentTypes": { - "additionalProperties": false, - "description": "An map of the composite component types in the component type. Each composite component type's key must be unique to this map.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/CompositeComponentType" - } - }, - "type": "object" - }, - "CreationDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the component type was created." - }, - "Description": { - "description": "The description of the component type.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "ExtendsFrom": { - "description": "Specifies the parent component type to extend.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ParentComponentType" - }, - "maxItems": 256, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Functions": { - "additionalProperties": false, - "description": "a Map of functions in the component type. Each function's key must be unique to this map.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/Function" - } - }, - "type": "object" - }, - "IsAbstract": { - "description": "A Boolean value that specifies whether the component type is abstract.", - "type": "boolean" - }, - "IsSchemaInitialized": { - "description": "A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.", - "type": "boolean" - }, - "IsSingleton": { - "description": "A Boolean value that specifies whether an entity can have more than one component of this type.", - "type": "boolean" - }, - "PropertyDefinitions": { - "additionalProperties": false, - "description": "An map of the property definitions in the component type. Each property definition's key must be unique to this map.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - "type": "object" - }, - "PropertyGroups": { - "additionalProperties": false, - "description": "An map of the property groups in the component type. Each property group's key must be unique to this map.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/PropertyGroup" - } - }, - "type": "object" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "The current status of the component type." - }, - "Tags": { - "additionalProperties": false, - "description": "A map of key-value pairs to associate with a resource.", - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The last date and time when the component type was updated." - }, - "WorkspaceId": { - "description": "The ID of the workspace that contains the component type.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDateTime", - "/properties/UpdateDateTime", - "/properties/Status", - "/properties/IsAbstract", - "/properties/IsSchemaInitialized" - ], - "required": [ - "WorkspaceId", - "ComponentTypeId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTTwinMaker::ComponentType" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkspaceId", + "/properties/ComponentTypeId" + ], + "definitions": { + "CompositeComponentType": { + "additionalProperties": false, + "description": "An object that sets information about a composite component type.", + "properties": { + "ComponentTypeId": { + "description": "The id of the composite component type.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\.\\-0-9:]+", + "type": "string" + } + }, + "type": "object" + }, + "DataConnector": { + "additionalProperties": false, + "description": "The data connector.", + "properties": { + "IsNative": { + "description": "A Boolean value that specifies whether the data connector is native to IoT TwinMaker.", + "type": "boolean" + }, + "Lambda": { + "$ref": "#/definitions/LambdaFunction", + "description": "The Lambda function associated with this data connector." + } + }, + "type": "object" + }, + "DataType": { + "additionalProperties": false, + "description": "An object that specifies the data type of a property.", + "properties": { + "AllowedValues": { + "description": "The allowed values for this data type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataValue" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "NestedType": { + "$ref": "#/definitions/DataType", + "description": "The nested type in the data type." + }, + "Relationship": { + "$ref": "#/definitions/Relationship", + "description": "A relationship that associates a component with another component." + }, + "Type": { + "description": "The underlying type of the data type.", + "enum": [ + "RELATIONSHIP", + "STRING", + "LONG", + "BOOLEAN", + "INTEGER", + "DOUBLE", + "LIST", + "MAP" + ], + "type": "string" + }, + "UnitOfMeasure": { + "description": "The unit of measure used in this data type.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "DataValue": { + "additionalProperties": false, + "description": "An object that specifies a value for a property.", + "properties": { + "BooleanValue": { + "description": "A Boolean value.", + "type": "boolean" + }, + "DoubleValue": { + "description": "A double value.", + "type": "number" + }, + "Expression": { + "description": "An expression that produces the value.", + "maxLength": 316, + "minLength": 1, + "pattern": "(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)", + "type": "string" + }, + "IntegerValue": { + "description": "An integer value.", + "type": "integer" + }, + "ListValue": { + "description": "A list of multiple values.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataValue" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "LongValue": { + "description": "A long value.", + "type": "number" + }, + "MapValue": { + "additionalProperties": false, + "description": "An object that maps strings to multiple DataValue objects. \n\n", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/DataValue" + } + }, + "type": "object" + }, + "RelationshipValue": { + "additionalProperties": false, + "description": "A value that relates a component to another component.", + "properties": { + "TargetComponentName": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "TargetEntityId": { + "maxLength": 128, + "minLength": 1, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "type": "object" + }, + "StringValue": { + "description": "A string value.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "DateTimeFormat": { + "format": "date-time", + "type": "string" + }, + "Function": { + "additionalProperties": false, + "description": "The function of component type.", + "properties": { + "ImplementedBy": { + "$ref": "#/definitions/DataConnector", + "description": "The data connector." + }, + "RequiredProperties": { + "description": "The required properties of the function.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RequiredProperty" + }, + "maxItems": 256, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Scope": { + "description": "The scope of the function.", + "enum": [ + "ENTITY", + "WORKSPACE" + ], + "type": "string" + } + }, + "type": "object" + }, + "LambdaFunction": { + "additionalProperties": false, + "properties": { + "Arn": { + "maxLength": 128, + "minLength": 1, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\\/a-zA-Z0-9_-]+", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "ParentComponentType": { + "pattern": "[a-zA-Z_\\.\\-0-9:]+", + "type": "string" + }, + "PropertyDefinition": { + "additionalProperties": false, + "description": "An object that sets information about a property.", + "properties": { + "Configurations": { + "additionalProperties": false, + "description": "An object that specifies information about a property.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + } + }, + "type": "object" + }, + "DataType": { + "$ref": "#/definitions/DataType", + "description": "An object that contains information about the data type." + }, + "DefaultValue": { + "$ref": "#/definitions/DataValue", + "description": "An object that contains the default value." + }, + "IsExternalId": { + "description": "A Boolean value that specifies whether the property ID comes from an external data store.", + "type": "boolean" + }, + "IsRequiredInEntity": { + "description": "A Boolean value that specifies whether the property is required.", + "type": "boolean" + }, + "IsStoredExternally": { + "description": "A Boolean value that specifies whether the property is stored externally.", + "type": "boolean" + }, + "IsTimeSeries": { + "description": "A Boolean value that specifies whether the property consists of time series data.", + "type": "boolean" + } + }, + "type": "object" + }, + "PropertyGroup": { + "additionalProperties": false, + "description": "An object that sets information about a property group.", + "properties": { + "GroupType": { + "description": "The type of property group.", + "enum": [ + "TABULAR" + ], + "type": "string" + }, + "PropertyNames": { + "description": "The list of property names in the property group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PropertyName" + }, + "maxItems": 256, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "PropertyName": { + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "Relationship": { + "additionalProperties": false, + "description": "The type of the relationship.", + "properties": { + "RelationshipType": { + "description": "The type of the relationship.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "TargetComponentTypeId": { + "description": "The ID of the target component type associated with this relationship.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\.\\-0-9:]+", + "type": "string" + } + }, + "type": "object" + }, + "RequiredProperty": { + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "Status": { + "additionalProperties": false, + "properties": { + "Error": { + "anyOf": [ + { + "additionalProperties": false, + "description": "Empty Error object.", + "type": "object" + }, + { + "additionalProperties": false, + "description": "Error object with Message and Code.", + "properties": { + "Code": { + "enum": [ + "VALIDATION_ERROR", + "INTERNAL_FAILURE" + ], + "type": "string" + }, + "Message": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "State": { + "enum": [ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTTwinMaker::ComponentType", + "handlers": { + "create": { + "permissions": [ + "iottwinmaker:CreateComponentType", + "iottwinmaker:GetComponentType", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource" + ] + }, + "delete": { + "permissions": [ + "iottwinmaker:DeleteComponentType", + "iottwinmaker:GetComponentType", + "iottwinmaker:GetWorkspace" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "WorkspaceId": { + "$ref": "resource-schema.json#/properties/WorkspaceId", + "type": "string" + } + }, + "required": [ + "WorkspaceId" + ] + }, + "permissions": [ + "iottwinmaker:GetComponentType", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListComponentTypes", + "iottwinmaker:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iottwinmaker:GetComponentType", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iottwinmaker:GetComponentType", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource", + "iottwinmaker:UntagResource", + "iottwinmaker:UpdateComponentType" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkspaceId", + "/properties/ComponentTypeId" + ], + "properties": { + "Arn": { + "description": "The ARN of the component type.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", + "type": "string" + }, + "ComponentTypeId": { + "description": "The ID of the component type.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\.\\-0-9:]+", + "type": "string" + }, + "CompositeComponentTypes": { + "additionalProperties": false, + "description": "An map of the composite component types in the component type. Each composite component type's key must be unique to this map.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/CompositeComponentType" + } + }, + "type": "object" + }, + "CreationDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the component type was created." + }, + "Description": { + "description": "The description of the component type.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "ExtendsFrom": { + "description": "Specifies the parent component type to extend.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ParentComponentType" + }, + "maxItems": 256, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Functions": { + "additionalProperties": false, + "description": "a Map of functions in the component type. Each function's key must be unique to this map.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/Function" + } + }, + "type": "object" + }, + "IsAbstract": { + "description": "A Boolean value that specifies whether the component type is abstract.", + "type": "boolean" + }, + "IsSchemaInitialized": { + "description": "A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.", + "type": "boolean" + }, + "IsSingleton": { + "description": "A Boolean value that specifies whether an entity can have more than one component of this type.", + "type": "boolean" + }, + "PropertyDefinitions": { + "additionalProperties": false, + "description": "An map of the property definitions in the component type. Each property definition's key must be unique to this map.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/PropertyDefinition" + } + }, + "type": "object" + }, + "PropertyGroups": { + "additionalProperties": false, + "description": "An map of the property groups in the component type. Each property group's key must be unique to this map.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/PropertyGroup" + } + }, + "type": "object" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "The current status of the component type." + }, + "Tags": { + "additionalProperties": false, + "description": "A map of key-value pairs to associate with a resource.", + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The last date and time when the component type was updated." + }, + "WorkspaceId": { + "description": "The ID of the workspace that contains the component type.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDateTime", + "/properties/UpdateDateTime", + "/properties/Status", + "/properties/IsAbstract", + "/properties/IsSchemaInitialized" + ], + "required": [ + "WorkspaceId", + "ComponentTypeId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTTwinMaker::ComponentType" +} diff --git a/schema/aws-iottwinmaker-entity.json b/schema/aws-iottwinmaker-entity.json index c3e9fc3..500dc37 100644 --- a/schema/aws-iottwinmaker-entity.json +++ b/schema/aws-iottwinmaker-entity.json @@ -1,600 +1,600 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkspaceId", - "/properties/EntityId" - ], - "definitions": { - "Component": { - "additionalProperties": false, - "properties": { - "ComponentName": { - "description": "The name of the component.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "ComponentTypeId": { - "description": "The ID of the component type.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "DefinedIn": { - "description": "The name of the property definition set in the component.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "The description of the component.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "Properties": { - "additionalProperties": false, - "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/Property" - } - }, - "type": "object" - }, - "PropertyGroups": { - "additionalProperties": false, - "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/PropertyGroup" - } - }, - "type": "object" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "The current status of the entity." - } - }, - "type": "object" - }, - "CompositeComponent": { - "additionalProperties": false, - "properties": { - "ComponentName": { - "description": "The name of the component.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "ComponentPath": { - "description": "The path of the component.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9/]+", - "type": "string" - }, - "ComponentTypeId": { - "description": "The ID of the component type.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "Description": { - "description": "The description of the component.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "Properties": { - "additionalProperties": false, - "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/Property" - } - }, - "type": "object" - }, - "PropertyGroups": { - "additionalProperties": false, - "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/PropertyGroup" - } - }, - "type": "object" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "The current status of the component." - } - }, - "type": "object" - }, - "DataType": { - "additionalProperties": false, - "description": "An object that specifies the data type of a property.", - "properties": { - "AllowedValues": { - "description": "The allowed values for this data type.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataValue" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "NestedType": { - "$ref": "#/definitions/DataType", - "description": "The nested type in the data type." - }, - "Relationship": { - "$ref": "#/definitions/Relationship", - "description": "A relationship that associates a component with another component." - }, - "Type": { - "description": "The underlying type of the data type.", - "enum": [ - "RELATIONSHIP", - "STRING", - "LONG", - "BOOLEAN", - "INTEGER", - "DOUBLE", - "LIST", - "MAP" - ], - "type": "string" - }, - "UnitOfMeasure": { - "description": "The unit of measure used in this data type.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "DataValue": { - "additionalProperties": false, - "description": "An object that specifies a value for a property.", - "properties": { - "BooleanValue": { - "description": "A Boolean value.", - "type": "boolean" - }, - "DoubleValue": { - "description": "A double value.", - "type": "number" - }, - "Expression": { - "description": "An expression that produces the value.", - "maxLength": 316, - "minLength": 1, - "pattern": "(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)", - "type": "string" - }, - "IntegerValue": { - "description": "An integer value.", - "type": "integer" - }, - "ListValue": { - "description": "A list of multiple values.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataValue" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "LongValue": { - "description": "A long value.", - "type": "number" - }, - "MapValue": { - "additionalProperties": false, - "description": "An object that maps strings to multiple DataValue objects.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/DataValue" - } - }, - "type": "object" - }, - "RelationshipValue": { - "additionalProperties": false, - "description": "A value that relates a component to another component.", - "properties": { - "TargetComponentName": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "TargetEntityId": { - "maxLength": 128, - "minLength": 1, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "type": "object" - }, - "StringValue": { - "description": "A string value.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "DateTimeFormat": { - "format": "date-time", - "type": "string" - }, - "Definition": { - "additionalProperties": false, - "description": "An object that specifies information about a property definition.", - "properties": { - "Configuration": { - "$ref": "#/definitions/PropertyDefinitionConfiguration", - "description": "An object that specifies information about a property configuration." - }, - "DataType": { - "$ref": "#/definitions/DataType", - "description": "An object that contains information about the data type." - }, - "DefaultValue": { - "$ref": "#/definitions/DataValue", - "description": "An object that contains the default value." - }, - "IsExternalId": { - "description": "A Boolean value that specifies whether the property ID comes from an external data store.", - "type": "boolean" - }, - "IsFinal": { - "description": "A Boolean value that specifies whether the property definition can be updated.", - "type": "boolean" - }, - "IsImported": { - "description": "A Boolean value that specifies whether the property definition is imported from an external data store.", - "type": "boolean" - }, - "IsInherited": { - "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity.", - "type": "boolean" - }, - "IsRequiredInEntity": { - "description": "A Boolean value that specifies whether the property is required.", - "type": "boolean" - }, - "IsStoredExternally": { - "description": "A Boolean value that specifies whether the property is stored externally.", - "type": "boolean" - }, - "IsTimeSeries": { - "description": "A Boolean value that specifies whether the property consists of time series data.", - "type": "boolean" - } - }, - "type": "object" - }, - "Property": { - "additionalProperties": false, - "description": "An object that specifies information about a property.", - "properties": { - "Definition": { - "$ref": "#/definitions/Definition", - "description": "The definition of the property." - }, - "Value": { - "$ref": "#/definitions/DataValue", - "description": "The value of the property." - } - }, - "type": "object" - }, - "PropertyDefinitionConfiguration": { - "additionalProperties": false, - "description": "An object that specifies information about a property configuration.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - } - }, - "type": "object" - }, - "PropertyGroup": { - "additionalProperties": false, - "description": "An object that specifies information about a property group.", - "properties": { - "GroupType": { - "description": "The type of property group.", - "enum": [ - "TABULAR" - ], - "type": "string" - }, - "PropertyNames": { - "description": "The list of property names in the property group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PropertyName" - }, - "maxItems": 256, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "PropertyName": { - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "Relationship": { - "additionalProperties": false, - "description": "The type of the relationship.", - "properties": { - "RelationshipType": { - "description": "The type of the relationship.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "TargetComponentTypeId": { - "description": "The ID of the target component type associated with this relationship.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_\\.\\-0-9:]+", - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "additionalProperties": false, - "properties": { - "Error": { - "anyOf": [ - { - "additionalProperties": false, - "description": "Empty Error object.", - "type": "object" - }, - { - "additionalProperties": false, - "description": "Error object with Message and Code.", - "properties": { - "Code": { - "enum": [ - "VALIDATION_ERROR", - "INTERNAL_FAILURE" - ], - "type": "string" - }, - "Message": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - ], - "type": "object" - }, - "State": { - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "ERROR" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::IoTTwinMaker::Entity", - "handlers": { - "create": { - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:CreateEntity", - "iottwinmaker:GetEntity", - "iottwinmaker:ListComponents", - "iottwinmaker:ListProperties", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource" - ] - }, - "delete": { - "permissions": [ - "iottwinmaker:GetEntity", - "iottwinmaker:GetWorkspace", - "iottwinmaker:DeleteEntity" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "WorkspaceId": { - "$ref": "resource-schema.json#/properties/WorkspaceId", - "type": "string" - } - }, - "required": [ - "WorkspaceId" - ] - }, - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:GetEntity", - "iottwinmaker:ListEntities" - ] - }, - "read": { - "permissions": [ - "iottwinmaker:GetComponentType", - "iottwinmaker:GetEntity", - "iottwinmaker:ListComponents", - "iottwinmaker:ListProperties", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListEntities", - "iottwinmaker:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iottwinmaker:GetComponentType", - "iottwinmaker:GetEntity", - "iottwinmaker:ListComponents", - "iottwinmaker:ListProperties", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource", - "iottwinmaker:UntagResource", - "iottwinmaker:UpdateEntity", - "iottwinmaker:UpdateComponentType" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkspaceId", - "/properties/EntityId" - ], - "properties": { - "Arn": { - "description": "The ARN of the entity.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", - "type": "string" - }, - "Components": { - "additionalProperties": false, - "description": "A map that sets information about a component type.", - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "$ref": "#/definitions/Component" - } - }, - "type": "object" - }, - "CompositeComponents": { - "additionalProperties": false, - "description": "A map that sets information about a composite component.", - "patternProperties": { - "[a-zA-Z_\\-0-9/]+": { - "$ref": "#/definitions/CompositeComponent" - } - }, - "type": "object" - }, - "CreationDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the entity was created." - }, - "Description": { - "description": "The description of the entity.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "EntityId": { - "description": "The ID of the entity.", - "maxLength": 128, - "minLength": 1, - "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", - "type": "string" - }, - "EntityName": { - "description": "The name of the entity.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+", - "type": "string" - }, - "HasChildEntities": { - "description": "A Boolean value that specifies whether the entity has child entities or not.", - "type": "boolean" - }, - "ParentEntityId": { - "description": "The ID of the parent entity.", - "maxLength": 128, - "minLength": 1, - "pattern": "\\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "The current status of the entity." - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The last date and time when the entity was updated." - }, - "WorkspaceId": { - "description": "The ID of the workspace.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDateTime", - "/properties/UpdateDateTime", - "/properties/Status", - "/properties/HasChildEntities" - ], - "required": [ - "WorkspaceId", - "EntityName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTTwinMaker::Entity" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkspaceId", + "/properties/EntityId" + ], + "definitions": { + "Component": { + "additionalProperties": false, + "properties": { + "ComponentName": { + "description": "The name of the component.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "ComponentTypeId": { + "description": "The ID of the component type.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "DefinedIn": { + "description": "The name of the property definition set in the component.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "The description of the component.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "Properties": { + "additionalProperties": false, + "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/Property" + } + }, + "type": "object" + }, + "PropertyGroups": { + "additionalProperties": false, + "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/PropertyGroup" + } + }, + "type": "object" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "The current status of the entity." + } + }, + "type": "object" + }, + "CompositeComponent": { + "additionalProperties": false, + "properties": { + "ComponentName": { + "description": "The name of the component.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "ComponentPath": { + "description": "The path of the component.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9/]+", + "type": "string" + }, + "ComponentTypeId": { + "description": "The ID of the component type.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "Description": { + "description": "The description of the component.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "Properties": { + "additionalProperties": false, + "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/Property" + } + }, + "type": "object" + }, + "PropertyGroups": { + "additionalProperties": false, + "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/PropertyGroup" + } + }, + "type": "object" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "The current status of the component." + } + }, + "type": "object" + }, + "DataType": { + "additionalProperties": false, + "description": "An object that specifies the data type of a property.", + "properties": { + "AllowedValues": { + "description": "The allowed values for this data type.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataValue" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "NestedType": { + "$ref": "#/definitions/DataType", + "description": "The nested type in the data type." + }, + "Relationship": { + "$ref": "#/definitions/Relationship", + "description": "A relationship that associates a component with another component." + }, + "Type": { + "description": "The underlying type of the data type.", + "enum": [ + "RELATIONSHIP", + "STRING", + "LONG", + "BOOLEAN", + "INTEGER", + "DOUBLE", + "LIST", + "MAP" + ], + "type": "string" + }, + "UnitOfMeasure": { + "description": "The unit of measure used in this data type.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "DataValue": { + "additionalProperties": false, + "description": "An object that specifies a value for a property.", + "properties": { + "BooleanValue": { + "description": "A Boolean value.", + "type": "boolean" + }, + "DoubleValue": { + "description": "A double value.", + "type": "number" + }, + "Expression": { + "description": "An expression that produces the value.", + "maxLength": 316, + "minLength": 1, + "pattern": "(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)", + "type": "string" + }, + "IntegerValue": { + "description": "An integer value.", + "type": "integer" + }, + "ListValue": { + "description": "A list of multiple values.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataValue" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "LongValue": { + "description": "A long value.", + "type": "number" + }, + "MapValue": { + "additionalProperties": false, + "description": "An object that maps strings to multiple DataValue objects.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/DataValue" + } + }, + "type": "object" + }, + "RelationshipValue": { + "additionalProperties": false, + "description": "A value that relates a component to another component.", + "properties": { + "TargetComponentName": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "TargetEntityId": { + "maxLength": 128, + "minLength": 1, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "type": "object" + }, + "StringValue": { + "description": "A string value.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "DateTimeFormat": { + "format": "date-time", + "type": "string" + }, + "Definition": { + "additionalProperties": false, + "description": "An object that specifies information about a property definition.", + "properties": { + "Configuration": { + "$ref": "#/definitions/PropertyDefinitionConfiguration", + "description": "An object that specifies information about a property configuration." + }, + "DataType": { + "$ref": "#/definitions/DataType", + "description": "An object that contains information about the data type." + }, + "DefaultValue": { + "$ref": "#/definitions/DataValue", + "description": "An object that contains the default value." + }, + "IsExternalId": { + "description": "A Boolean value that specifies whether the property ID comes from an external data store.", + "type": "boolean" + }, + "IsFinal": { + "description": "A Boolean value that specifies whether the property definition can be updated.", + "type": "boolean" + }, + "IsImported": { + "description": "A Boolean value that specifies whether the property definition is imported from an external data store.", + "type": "boolean" + }, + "IsInherited": { + "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity.", + "type": "boolean" + }, + "IsRequiredInEntity": { + "description": "A Boolean value that specifies whether the property is required.", + "type": "boolean" + }, + "IsStoredExternally": { + "description": "A Boolean value that specifies whether the property is stored externally.", + "type": "boolean" + }, + "IsTimeSeries": { + "description": "A Boolean value that specifies whether the property consists of time series data.", + "type": "boolean" + } + }, + "type": "object" + }, + "Property": { + "additionalProperties": false, + "description": "An object that specifies information about a property.", + "properties": { + "Definition": { + "$ref": "#/definitions/Definition", + "description": "The definition of the property." + }, + "Value": { + "$ref": "#/definitions/DataValue", + "description": "The value of the property." + } + }, + "type": "object" + }, + "PropertyDefinitionConfiguration": { + "additionalProperties": false, + "description": "An object that specifies information about a property configuration.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + } + }, + "type": "object" + }, + "PropertyGroup": { + "additionalProperties": false, + "description": "An object that specifies information about a property group.", + "properties": { + "GroupType": { + "description": "The type of property group.", + "enum": [ + "TABULAR" + ], + "type": "string" + }, + "PropertyNames": { + "description": "The list of property names in the property group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PropertyName" + }, + "maxItems": 256, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "PropertyName": { + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "Relationship": { + "additionalProperties": false, + "description": "The type of the relationship.", + "properties": { + "RelationshipType": { + "description": "The type of the relationship.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "TargetComponentTypeId": { + "description": "The ID of the target component type associated with this relationship.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_\\.\\-0-9:]+", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "additionalProperties": false, + "properties": { + "Error": { + "anyOf": [ + { + "additionalProperties": false, + "description": "Empty Error object.", + "type": "object" + }, + { + "additionalProperties": false, + "description": "Error object with Message and Code.", + "properties": { + "Code": { + "enum": [ + "VALIDATION_ERROR", + "INTERNAL_FAILURE" + ], + "type": "string" + }, + "Message": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "State": { + "enum": [ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::IoTTwinMaker::Entity", + "handlers": { + "create": { + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:CreateEntity", + "iottwinmaker:GetEntity", + "iottwinmaker:ListComponents", + "iottwinmaker:ListProperties", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource" + ] + }, + "delete": { + "permissions": [ + "iottwinmaker:GetEntity", + "iottwinmaker:GetWorkspace", + "iottwinmaker:DeleteEntity" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "WorkspaceId": { + "$ref": "resource-schema.json#/properties/WorkspaceId", + "type": "string" + } + }, + "required": [ + "WorkspaceId" + ] + }, + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:GetEntity", + "iottwinmaker:ListEntities" + ] + }, + "read": { + "permissions": [ + "iottwinmaker:GetComponentType", + "iottwinmaker:GetEntity", + "iottwinmaker:ListComponents", + "iottwinmaker:ListProperties", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListEntities", + "iottwinmaker:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iottwinmaker:GetComponentType", + "iottwinmaker:GetEntity", + "iottwinmaker:ListComponents", + "iottwinmaker:ListProperties", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource", + "iottwinmaker:UntagResource", + "iottwinmaker:UpdateEntity", + "iottwinmaker:UpdateComponentType" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkspaceId", + "/properties/EntityId" + ], + "properties": { + "Arn": { + "description": "The ARN of the entity.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", + "type": "string" + }, + "Components": { + "additionalProperties": false, + "description": "A map that sets information about a component type.", + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "$ref": "#/definitions/Component" + } + }, + "type": "object" + }, + "CompositeComponents": { + "additionalProperties": false, + "description": "A map that sets information about a composite component.", + "patternProperties": { + "[a-zA-Z_\\-0-9/]+": { + "$ref": "#/definitions/CompositeComponent" + } + }, + "type": "object" + }, + "CreationDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the entity was created." + }, + "Description": { + "description": "The description of the entity.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "EntityId": { + "description": "The ID of the entity.", + "maxLength": 128, + "minLength": 1, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", + "type": "string" + }, + "EntityName": { + "description": "The name of the entity.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+", + "type": "string" + }, + "HasChildEntities": { + "description": "A Boolean value that specifies whether the entity has child entities or not.", + "type": "boolean" + }, + "ParentEntityId": { + "description": "The ID of the parent entity.", + "maxLength": 128, + "minLength": 1, + "pattern": "\\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "The current status of the entity." + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The last date and time when the entity was updated." + }, + "WorkspaceId": { + "description": "The ID of the workspace.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDateTime", + "/properties/UpdateDateTime", + "/properties/Status", + "/properties/HasChildEntities" + ], + "required": [ + "WorkspaceId", + "EntityName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTTwinMaker::Entity" +} diff --git a/schema/aws-iottwinmaker-scene.json b/schema/aws-iottwinmaker-scene.json index 8eae43c..596fa9f 100644 --- a/schema/aws-iottwinmaker-scene.json +++ b/schema/aws-iottwinmaker-scene.json @@ -1,189 +1,189 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SceneId", - "/properties/WorkspaceId" - ], - "definitions": { - "DateTimeFormat": { - "format": "date-time", - "type": "string" - } - }, - "description": "Resource schema for AWS::IoTTwinMaker::Scene", - "handlers": { - "create": { - "permissions": [ - "iottwinmaker:CreateScene", - "iottwinmaker:GetScene", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource" - ] - }, - "delete": { - "permissions": [ - "iottwinmaker:DeleteScene", - "iottwinmaker:GetScene", - "iottwinmaker:GetWorkspace" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "WorkspaceId": { - "$ref": "resource-schema.json#/properties/WorkspaceId", - "type": "string" - } - }, - "required": [ - "WorkspaceId" - ] - }, - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:ListScenes" - ] - }, - "read": { - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:GetScene", - "iottwinmaker:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iottwinmaker:GetScene", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource", - "iottwinmaker:UntagResource", - "iottwinmaker:UpdateScene" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkspaceId", - "/properties/SceneId" - ], - "properties": { - "Arn": { - "description": "The ARN of the scene.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", - "type": "string" - }, - "Capabilities": { - "description": "A list of capabilities that the scene uses to render.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 0, - "pattern": ".*", - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "ContentLocation": { - "description": "The relative path that specifies the location of the content definition file.", - "maxLength": 256, - "minLength": 0, - "pattern": "[sS]3://[A-Za-z0-9._/-]+", - "type": "string" - }, - "CreationDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the scene was created." - }, - "Description": { - "description": "The description of the scene.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "GeneratedSceneMetadata": { - "additionalProperties": false, - "description": "A key-value pair of generated scene metadata for the scene.", - "maxLength": 50, - "minLength": 0, - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "SceneId": { - "description": "The ID of the scene.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - }, - "SceneMetadata": { - "additionalProperties": false, - "description": "A key-value pair of scene metadata for the scene.", - "maxLength": 50, - "minLength": 0, - "patternProperties": { - "[a-zA-Z_\\-0-9]+": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time of the current update." - }, - "WorkspaceId": { - "description": "The ID of the scene.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDateTime", - "/properties/UpdateDateTime", - "/properties/GeneratedSceneMetadata" - ], - "required": [ - "WorkspaceId", - "SceneId", - "ContentLocation" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTTwinMaker::Scene" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SceneId", + "/properties/WorkspaceId" + ], + "definitions": { + "DateTimeFormat": { + "format": "date-time", + "type": "string" + } + }, + "description": "Resource schema for AWS::IoTTwinMaker::Scene", + "handlers": { + "create": { + "permissions": [ + "iottwinmaker:CreateScene", + "iottwinmaker:GetScene", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource" + ] + }, + "delete": { + "permissions": [ + "iottwinmaker:DeleteScene", + "iottwinmaker:GetScene", + "iottwinmaker:GetWorkspace" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "WorkspaceId": { + "$ref": "resource-schema.json#/properties/WorkspaceId", + "type": "string" + } + }, + "required": [ + "WorkspaceId" + ] + }, + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:ListScenes" + ] + }, + "read": { + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:GetScene", + "iottwinmaker:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iottwinmaker:GetScene", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource", + "iottwinmaker:UntagResource", + "iottwinmaker:UpdateScene" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkspaceId", + "/properties/SceneId" + ], + "properties": { + "Arn": { + "description": "The ARN of the scene.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", + "type": "string" + }, + "Capabilities": { + "description": "A list of capabilities that the scene uses to render.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 0, + "pattern": ".*", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ContentLocation": { + "description": "The relative path that specifies the location of the content definition file.", + "maxLength": 256, + "minLength": 0, + "pattern": "[sS]3://[A-Za-z0-9._/-]+", + "type": "string" + }, + "CreationDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the scene was created." + }, + "Description": { + "description": "The description of the scene.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "GeneratedSceneMetadata": { + "additionalProperties": false, + "description": "A key-value pair of generated scene metadata for the scene.", + "maxLength": 50, + "minLength": 0, + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "SceneId": { + "description": "The ID of the scene.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + }, + "SceneMetadata": { + "additionalProperties": false, + "description": "A key-value pair of scene metadata for the scene.", + "maxLength": 50, + "minLength": 0, + "patternProperties": { + "[a-zA-Z_\\-0-9]+": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time of the current update." + }, + "WorkspaceId": { + "description": "The ID of the scene.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDateTime", + "/properties/UpdateDateTime", + "/properties/GeneratedSceneMetadata" + ], + "required": [ + "WorkspaceId", + "SceneId", + "ContentLocation" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTTwinMaker::Scene" +} diff --git a/schema/aws-iottwinmaker-syncjob.json b/schema/aws-iottwinmaker-syncjob.json index 1210f8b..0ecf996 100644 --- a/schema/aws-iottwinmaker-syncjob.json +++ b/schema/aws-iottwinmaker-syncjob.json @@ -1,141 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkspaceId", - "/properties/SyncSource", - "/properties/SyncRole", - "/properties/Tags" - ], - "definitions": { - "DateTimeFormat": { - "format": "date-time", - "type": "string" - } - }, - "description": "Resource schema for AWS::IoTTwinMaker::SyncJob", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iottwinmaker:CreateSyncJob", - "iottwinmaker:GetSyncJob", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource" - ] - }, - "delete": { - "permissions": [ - "iottwinmaker:DeleteSyncJob", - "iottwinmaker:GetSyncJob", - "iottwinmaker:GetWorkspace" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "WorkspaceId": { - "$ref": "resource-schema.json#/properties/WorkspaceId", - "type": "string" - } - }, - "required": [ - "WorkspaceId" - ] - }, - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListSyncJobs", - "iottwinmaker:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iottwinmaker:GetSyncJob", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkspaceId", - "/properties/SyncSource" - ], - "properties": { - "Arn": { - "description": "The ARN of the SyncJob.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", - "type": "string" - }, - "CreationDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the sync job was created." - }, - "State": { - "description": "The state of SyncJob.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_\\-0-9]+", - "type": "string" - }, - "SyncRole": { - "description": "The IAM Role that execute SyncJob.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*", - "type": "string" - }, - "SyncSource": { - "description": "The source of the SyncJob.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the sync job was updated." - }, - "WorkspaceId": { - "description": "The ID of the workspace.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDateTime", - "/properties/UpdateDateTime", - "/properties/State" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "WorkspaceId", - "SyncSource", - "SyncRole" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::IoTTwinMaker::SyncJob" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkspaceId", + "/properties/SyncSource", + "/properties/SyncRole", + "/properties/Tags" + ], + "definitions": { + "DateTimeFormat": { + "format": "date-time", + "type": "string" + } + }, + "description": "Resource schema for AWS::IoTTwinMaker::SyncJob", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iottwinmaker:CreateSyncJob", + "iottwinmaker:GetSyncJob", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource" + ] + }, + "delete": { + "permissions": [ + "iottwinmaker:DeleteSyncJob", + "iottwinmaker:GetSyncJob", + "iottwinmaker:GetWorkspace" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "WorkspaceId": { + "$ref": "resource-schema.json#/properties/WorkspaceId", + "type": "string" + } + }, + "required": [ + "WorkspaceId" + ] + }, + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListSyncJobs", + "iottwinmaker:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iottwinmaker:GetSyncJob", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkspaceId", + "/properties/SyncSource" + ], + "properties": { + "Arn": { + "description": "The ARN of the SyncJob.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", + "type": "string" + }, + "CreationDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the sync job was created." + }, + "State": { + "description": "The state of SyncJob.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_\\-0-9]+", + "type": "string" + }, + "SyncRole": { + "description": "The IAM Role that execute SyncJob.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*", + "type": "string" + }, + "SyncSource": { + "description": "The source of the SyncJob.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the sync job was updated." + }, + "WorkspaceId": { + "description": "The ID of the workspace.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDateTime", + "/properties/UpdateDateTime", + "/properties/State" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "WorkspaceId", + "SyncSource", + "SyncRole" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iottwinmaker", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::IoTTwinMaker::SyncJob" +} diff --git a/schema/aws-iottwinmaker-workspace.json b/schema/aws-iottwinmaker-workspace.json index 7f90b26..b52f854 100644 --- a/schema/aws-iottwinmaker-workspace.json +++ b/schema/aws-iottwinmaker-workspace.json @@ -1,127 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkspaceId" - ], - "definitions": { - "DateTimeFormat": { - "format": "date-time", - "type": "string" - } - }, - "description": "Resource schema for AWS::IoTTwinMaker::Workspace", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iottwinmaker:CreateWorkspace", - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource" - ] - }, - "delete": { - "permissions": [ - "iottwinmaker:DeleteWorkspace", - "iottwinmaker:GetWorkspace" - ] - }, - "list": { - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:ListWorkspaces" - ] - }, - "read": { - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iottwinmaker:GetWorkspace", - "iottwinmaker:ListTagsForResource", - "iottwinmaker:TagResource", - "iottwinmaker:UntagResource", - "iottwinmaker:UpdateWorkspace" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkspaceId" - ], - "properties": { - "Arn": { - "description": "The ARN of the workspace.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", - "type": "string" - }, - "CreationDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time when the workspace was created." - }, - "Description": { - "description": "The description of the workspace.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "Role": { - "description": "The ARN of the execution role associated with the workspace.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*", - "type": "string" - }, - "S3Location": { - "description": "The ARN of the S3 bucket where resources associated with the workspace are stored.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A map of key-value pairs to associate with a resource.", - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateDateTime": { - "$ref": "#/definitions/DateTimeFormat", - "description": "The date and time of the current update." - }, - "WorkspaceId": { - "description": "The ID of the workspace.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationDateTime", - "/properties/UpdateDateTime" - ], - "required": [ - "WorkspaceId", - "Role", - "S3Location" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IoTTwinMaker::Workspace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkspaceId" + ], + "definitions": { + "DateTimeFormat": { + "format": "date-time", + "type": "string" + } + }, + "description": "Resource schema for AWS::IoTTwinMaker::Workspace", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iottwinmaker:CreateWorkspace", + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource" + ] + }, + "delete": { + "permissions": [ + "iottwinmaker:DeleteWorkspace", + "iottwinmaker:GetWorkspace" + ] + }, + "list": { + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:ListWorkspaces" + ] + }, + "read": { + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iottwinmaker:GetWorkspace", + "iottwinmaker:ListTagsForResource", + "iottwinmaker:TagResource", + "iottwinmaker:UntagResource", + "iottwinmaker:UpdateWorkspace" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkspaceId" + ], + "properties": { + "Arn": { + "description": "The ARN of the workspace.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+", + "type": "string" + }, + "CreationDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time when the workspace was created." + }, + "Description": { + "description": "The description of the workspace.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "Role": { + "description": "The ARN of the execution role associated with the workspace.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*", + "type": "string" + }, + "S3Location": { + "description": "The ARN of the S3 bucket where resources associated with the workspace are stored.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A map of key-value pairs to associate with a resource.", + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateDateTime": { + "$ref": "#/definitions/DateTimeFormat", + "description": "The date and time of the current update." + }, + "WorkspaceId": { + "description": "The ID of the workspace.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationDateTime", + "/properties/UpdateDateTime" + ], + "required": [ + "WorkspaceId", + "Role", + "S3Location" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IoTTwinMaker::Workspace" +} diff --git a/schema/aws-iotwireless-destination.json b/schema/aws-iotwireless-destination.json index 539aa6a..de01224 100644 --- a/schema/aws-iotwireless-destination.json +++ b/schema/aws-iotwireless-destination.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Destination's resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iotwireless:CreateDestination", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteDestination" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListDestinations", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetDestination", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iotwireless:UpdateDestination", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "Destination arn. Returned after successful create.", - "type": "string" - }, - "Description": { - "description": "Destination description", - "maxLength": 2048, - "type": "string" - }, - "Expression": { - "description": "Destination expression", - "type": "string" - }, - "ExpressionType": { - "description": "Must be RuleName", - "enum": [ - "RuleName", - "MqttTopic", - "SnsTopic" - ], - "type": "string" - }, - "Name": { - "description": "Unique name of destination", - "maxLength": 128, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "RoleArn": { - "description": "AWS role ARN that grants access", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the destination.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "Expression", - "ExpressionType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::Destination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Destination's resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iotwireless:CreateDestination", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteDestination" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListDestinations", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetDestination", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iotwireless:UpdateDestination", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "Destination arn. Returned after successful create.", + "type": "string" + }, + "Description": { + "description": "Destination description", + "maxLength": 2048, + "type": "string" + }, + "Expression": { + "description": "Destination expression", + "type": "string" + }, + "ExpressionType": { + "description": "Must be RuleName", + "enum": [ + "RuleName", + "MqttTopic", + "SnsTopic" + ], + "type": "string" + }, + "Name": { + "description": "Unique name of destination", + "maxLength": 128, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "RoleArn": { + "description": "AWS role ARN that grants access", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the destination.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "Expression", + "ExpressionType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::Destination" +} diff --git a/schema/aws-iotwireless-deviceprofile.json b/schema/aws-iotwireless-deviceprofile.json index efa6551..fd6e8b2 100644 --- a/schema/aws-iotwireless-deviceprofile.json +++ b/schema/aws-iotwireless-deviceprofile.json @@ -1,186 +1,186 @@ -{ - "additionalProperties": false, - "definitions": { - "FactoryPresetFreq": { - "maximum": 16700000, - "minimum": 1000000, - "type": "integer" - }, - "LoRaWANDeviceProfile": { - "additionalProperties": false, - "properties": { - "ClassBTimeout": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - }, - "ClassCTimeout": { - "maximum": 1000, - "minimum": 0, - "type": "integer" - }, - "FactoryPresetFreqsList": { - "items": { - "$ref": "#/definitions/FactoryPresetFreq" - }, - "maxItems": 20, - "type": "array" - }, - "MacVersion": { - "maxLength": 64, - "type": "string" - }, - "MaxDutyCycle": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "MaxEirp": { - "maximum": 15, - "minimum": 0, - "type": "integer" - }, - "PingSlotDr": { - "maximum": 15, - "minimum": 0, - "type": "integer" - }, - "PingSlotFreq": { - "maximum": 16700000, - "minimum": 1000000, - "type": "integer" - }, - "PingSlotPeriod": { - "maximum": 4096, - "minimum": 128, - "type": "integer" - }, - "RegParamsRevision": { - "maxLength": 64, - "type": "string" - }, - "RfRegion": { - "maxLength": 64, - "type": "string" - }, - "RxDataRate2": { - "maximum": 15, - "minimum": 0, - "type": "integer" - }, - "RxDelay1": { - "maximum": 15, - "minimum": 0, - "type": "integer" - }, - "RxDrOffset1": { - "maximum": 7, - "minimum": 0, - "type": "integer" - }, - "RxFreq2": { - "maximum": 16700000, - "minimum": 1000000, - "type": "integer" - }, - "Supports32BitFCnt": { - "type": "boolean" - }, - "SupportsClassB": { - "type": "boolean" - }, - "SupportsClassC": { - "type": "boolean" - }, - "SupportsJoin": { - "type": "boolean" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Device Profile's resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateDeviceProfile", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteDeviceProfile" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListDeviceProfiles", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetDeviceProfile", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Service profile Arn. Returned after successful create.", - "type": "string" - }, - "Id": { - "description": "Service profile Id. Returned after successful create.", - "maxLength": 256, - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWANDeviceProfile", - "description": "LoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation" - }, - "Name": { - "description": "Name of service profile", - "maxLength": 256, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the device profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::DeviceProfile" -} +{ + "additionalProperties": false, + "definitions": { + "FactoryPresetFreq": { + "maximum": 16700000, + "minimum": 1000000, + "type": "integer" + }, + "LoRaWANDeviceProfile": { + "additionalProperties": false, + "properties": { + "ClassBTimeout": { + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "ClassCTimeout": { + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "FactoryPresetFreqsList": { + "items": { + "$ref": "#/definitions/FactoryPresetFreq" + }, + "maxItems": 20, + "type": "array" + }, + "MacVersion": { + "maxLength": 64, + "type": "string" + }, + "MaxDutyCycle": { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "MaxEirp": { + "maximum": 15, + "minimum": 0, + "type": "integer" + }, + "PingSlotDr": { + "maximum": 15, + "minimum": 0, + "type": "integer" + }, + "PingSlotFreq": { + "maximum": 16700000, + "minimum": 1000000, + "type": "integer" + }, + "PingSlotPeriod": { + "maximum": 4096, + "minimum": 128, + "type": "integer" + }, + "RegParamsRevision": { + "maxLength": 64, + "type": "string" + }, + "RfRegion": { + "maxLength": 64, + "type": "string" + }, + "RxDataRate2": { + "maximum": 15, + "minimum": 0, + "type": "integer" + }, + "RxDelay1": { + "maximum": 15, + "minimum": 0, + "type": "integer" + }, + "RxDrOffset1": { + "maximum": 7, + "minimum": 0, + "type": "integer" + }, + "RxFreq2": { + "maximum": 16700000, + "minimum": 1000000, + "type": "integer" + }, + "Supports32BitFCnt": { + "type": "boolean" + }, + "SupportsClassB": { + "type": "boolean" + }, + "SupportsClassC": { + "type": "boolean" + }, + "SupportsJoin": { + "type": "boolean" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Device Profile's resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateDeviceProfile", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteDeviceProfile" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListDeviceProfiles", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetDeviceProfile", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Service profile Arn. Returned after successful create.", + "type": "string" + }, + "Id": { + "description": "Service profile Id. Returned after successful create.", + "maxLength": 256, + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWANDeviceProfile", + "description": "LoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation" + }, + "Name": { + "description": "Name of service profile", + "maxLength": 256, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the device profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::DeviceProfile" +} diff --git a/schema/aws-iotwireless-fuotatask.json b/schema/aws-iotwireless-fuotatask.json index 73d26da..394b4d7 100644 --- a/schema/aws-iotwireless-fuotatask.json +++ b/schema/aws-iotwireless-fuotatask.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "definitions": { - "LoRaWAN": { - "additionalProperties": false, - "properties": { - "RfRegion": { - "description": "FUOTA task LoRaWAN RF region", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "StartTime": { - "description": "FUOTA task LoRaWAN start time", - "maxLength": 64, - "type": "string" - } - }, - "required": [ - "RfRegion" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage FUOTA tasks.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateFuotaTask", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteFuotaTask" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListFuotaTasks", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetFuotaTask", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "iotwireless:UpdateFuotaTask", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource", - "iotwireless:AssociateMulticastGroupWithFuotaTask", - "iotwireless:DisassociateMulticastGroupFromFuotaTask", - "iotwireless:AssociateWirelessDeviceWithFuotaTask", - "iotwireless:DisassociateWirelessDeviceFromFuotaTask" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "FUOTA task arn. Returned after successful create.", - "type": "string" - }, - "AssociateMulticastGroup": { - "description": "Multicast group to associate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "AssociateWirelessDevice": { - "description": "Wireless device to associate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "Description": { - "description": "FUOTA task description", - "maxLength": 2048, - "type": "string" - }, - "DisassociateMulticastGroup": { - "description": "Multicast group to disassociate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "DisassociateWirelessDevice": { - "description": "Wireless device to disassociate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "FirmwareUpdateImage": { - "description": "FUOTA task firmware update image binary S3 link", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FirmwareUpdateRole": { - "description": "FUOTA task firmware IAM role for reading S3", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "FuotaTaskStatus": { - "description": "FUOTA task status. Returned after successful read.", - "type": "string" - }, - "Id": { - "description": "FUOTA task id. Returned after successful create.", - "maxLength": 256, - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWAN", - "description": "FUOTA task LoRaWAN" - }, - "Name": { - "description": "Name of FUOTA task", - "maxLength": 256, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the FUOTA task.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/FuotaTaskStatus", - "/properties/LoRaWAN/StartTime" - ], - "required": [ - "LoRaWAN", - "FirmwareUpdateImage", - "FirmwareUpdateRole" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::FuotaTask" -} +{ + "additionalProperties": false, + "definitions": { + "LoRaWAN": { + "additionalProperties": false, + "properties": { + "RfRegion": { + "description": "FUOTA task LoRaWAN RF region", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "StartTime": { + "description": "FUOTA task LoRaWAN start time", + "maxLength": 64, + "type": "string" + } + }, + "required": [ + "RfRegion" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage FUOTA tasks.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateFuotaTask", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteFuotaTask" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListFuotaTasks", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetFuotaTask", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "iotwireless:UpdateFuotaTask", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource", + "iotwireless:AssociateMulticastGroupWithFuotaTask", + "iotwireless:DisassociateMulticastGroupFromFuotaTask", + "iotwireless:AssociateWirelessDeviceWithFuotaTask", + "iotwireless:DisassociateWirelessDeviceFromFuotaTask" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "FUOTA task arn. Returned after successful create.", + "type": "string" + }, + "AssociateMulticastGroup": { + "description": "Multicast group to associate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "AssociateWirelessDevice": { + "description": "Wireless device to associate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "Description": { + "description": "FUOTA task description", + "maxLength": 2048, + "type": "string" + }, + "DisassociateMulticastGroup": { + "description": "Multicast group to disassociate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "DisassociateWirelessDevice": { + "description": "Wireless device to disassociate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "FirmwareUpdateImage": { + "description": "FUOTA task firmware update image binary S3 link", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FirmwareUpdateRole": { + "description": "FUOTA task firmware IAM role for reading S3", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "FuotaTaskStatus": { + "description": "FUOTA task status. Returned after successful read.", + "type": "string" + }, + "Id": { + "description": "FUOTA task id. Returned after successful create.", + "maxLength": 256, + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWAN", + "description": "FUOTA task LoRaWAN" + }, + "Name": { + "description": "Name of FUOTA task", + "maxLength": 256, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the FUOTA task.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/FuotaTaskStatus", + "/properties/LoRaWAN/StartTime" + ], + "required": [ + "LoRaWAN", + "FirmwareUpdateImage", + "FirmwareUpdateRole" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::FuotaTask" +} diff --git a/schema/aws-iotwireless-multicastgroup.json b/schema/aws-iotwireless-multicastgroup.json index 758ea7d..ba7c525 100644 --- a/schema/aws-iotwireless-multicastgroup.json +++ b/schema/aws-iotwireless-multicastgroup.json @@ -1,152 +1,152 @@ -{ - "additionalProperties": false, - "definitions": { - "LoRaWAN": { - "additionalProperties": false, - "properties": { - "DlClass": { - "description": "Multicast group LoRaWAN DL Class", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "NumberOfDevicesInGroup": { - "description": "Multicast group number of devices in group. Returned after successful read.", - "type": "integer" - }, - "NumberOfDevicesRequested": { - "description": "Multicast group number of devices requested. Returned after successful read.", - "type": "integer" - }, - "RfRegion": { - "description": "Multicast group LoRaWAN RF region", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "RfRegion", - "DlClass" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage Multicast groups.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateMulticastGroup", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteMulticastGroup" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListMulticastGroups", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetMulticastGroup", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdateMulticastGroup", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource", - "iotwireless:AssociateWirelessDeviceWithMulticastGroup", - "iotwireless:DisassociateWirelessDeviceFromMulticastGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Multicast group arn. Returned after successful create.", - "type": "string" - }, - "AssociateWirelessDevice": { - "description": "Wireless device to associate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "Description": { - "description": "Multicast group description", - "maxLength": 2048, - "type": "string" - }, - "DisassociateWirelessDevice": { - "description": "Wireless device to disassociate. Only for update request.", - "maxLength": 256, - "type": "string" - }, - "Id": { - "description": "Multicast group id. Returned after successful create.", - "maxLength": 256, - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWAN", - "description": "Multicast group LoRaWAN" - }, - "Name": { - "description": "Name of Multicast group", - "maxLength": 256, - "type": "string" - }, - "Status": { - "description": "Multicast group status. Returned after successful read.", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the Multicast group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/Status", - "/properties/LoRaWAN/NumberOfDevicesRequested", - "/properties/LoRaWAN/NumberOfDevicesInGroup" - ], - "required": [ - "LoRaWAN" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::MulticastGroup" -} +{ + "additionalProperties": false, + "definitions": { + "LoRaWAN": { + "additionalProperties": false, + "properties": { + "DlClass": { + "description": "Multicast group LoRaWAN DL Class", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "NumberOfDevicesInGroup": { + "description": "Multicast group number of devices in group. Returned after successful read.", + "type": "integer" + }, + "NumberOfDevicesRequested": { + "description": "Multicast group number of devices requested. Returned after successful read.", + "type": "integer" + }, + "RfRegion": { + "description": "Multicast group LoRaWAN RF region", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "RfRegion", + "DlClass" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage Multicast groups.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateMulticastGroup", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteMulticastGroup" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListMulticastGroups", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetMulticastGroup", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdateMulticastGroup", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource", + "iotwireless:AssociateWirelessDeviceWithMulticastGroup", + "iotwireless:DisassociateWirelessDeviceFromMulticastGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Multicast group arn. Returned after successful create.", + "type": "string" + }, + "AssociateWirelessDevice": { + "description": "Wireless device to associate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "Description": { + "description": "Multicast group description", + "maxLength": 2048, + "type": "string" + }, + "DisassociateWirelessDevice": { + "description": "Wireless device to disassociate. Only for update request.", + "maxLength": 256, + "type": "string" + }, + "Id": { + "description": "Multicast group id. Returned after successful create.", + "maxLength": 256, + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWAN", + "description": "Multicast group LoRaWAN" + }, + "Name": { + "description": "Name of Multicast group", + "maxLength": 256, + "type": "string" + }, + "Status": { + "description": "Multicast group status. Returned after successful read.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the Multicast group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/Status", + "/properties/LoRaWAN/NumberOfDevicesRequested", + "/properties/LoRaWAN/NumberOfDevicesInGroup" + ], + "required": [ + "LoRaWAN" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::MulticastGroup" +} diff --git a/schema/aws-iotwireless-networkanalyzerconfiguration.json b/schema/aws-iotwireless-networkanalyzerconfiguration.json index fb57c96..26cfb66 100644 --- a/schema/aws-iotwireless-networkanalyzerconfiguration.json +++ b/schema/aws-iotwireless-networkanalyzerconfiguration.json @@ -1,157 +1,157 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "LogLevel": { - "enum": [ - "INFO", - "ERROR", - "DISABLED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WirelessDeviceFrameInfo": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "description": "Create and manage NetworkAnalyzerConfiguration resource.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateNetworkAnalyzerConfiguration", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteNetworkAnalyzerConfiguration" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListNetworkAnalyzerConfigurations", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetNetworkAnalyzerConfiguration", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdateNetworkAnalyzerConfiguration", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "Arn for network analyzer configuration, Returned upon successful create.", - "type": "string" - }, - "Description": { - "description": "The description of the new resource", - "maxLength": 2048, - "type": "string" - }, - "Name": { - "description": "Name of the network analyzer configuration", - "maxLength": 1024, - "pattern": "^[a-zA-Z0-9-_]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "TraceContent": { - "additionalProperties": false, - "description": "Trace content for your wireless gateway and wireless device resources", - "properties": { - "LogLevel": { - "$ref": "#/definitions/LogLevel" - }, - "WirelessDeviceFrameInfo": { - "$ref": "#/definitions/WirelessDeviceFrameInfo" - } - }, - "type": "object" - }, - "WirelessDevices": { - "description": "List of wireless gateway resources that have been added to the network analyzer configuration", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 250, - "type": "array" - }, - "WirelessGateways": { - "description": "List of wireless gateway resources that have been added to the network analyzer configuration", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 250, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::IoTWireless::NetworkAnalyzerConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "LogLevel": { + "enum": [ + "INFO", + "ERROR", + "DISABLED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WirelessDeviceFrameInfo": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "description": "Create and manage NetworkAnalyzerConfiguration resource.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateNetworkAnalyzerConfiguration", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteNetworkAnalyzerConfiguration" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListNetworkAnalyzerConfigurations", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetNetworkAnalyzerConfiguration", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdateNetworkAnalyzerConfiguration", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "Arn for network analyzer configuration, Returned upon successful create.", + "type": "string" + }, + "Description": { + "description": "The description of the new resource", + "maxLength": 2048, + "type": "string" + }, + "Name": { + "description": "Name of the network analyzer configuration", + "maxLength": 1024, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "TraceContent": { + "additionalProperties": false, + "description": "Trace content for your wireless gateway and wireless device resources", + "properties": { + "LogLevel": { + "$ref": "#/definitions/LogLevel" + }, + "WirelessDeviceFrameInfo": { + "$ref": "#/definitions/WirelessDeviceFrameInfo" + } + }, + "type": "object" + }, + "WirelessDevices": { + "description": "List of wireless gateway resources that have been added to the network analyzer configuration", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 250, + "type": "array" + }, + "WirelessGateways": { + "description": "List of wireless gateway resources that have been added to the network analyzer configuration", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 250, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::IoTWireless::NetworkAnalyzerConfiguration" +} diff --git a/schema/aws-iotwireless-partneraccount.json b/schema/aws-iotwireless-partneraccount.json index 6c47315..3f1cd15 100644 --- a/schema/aws-iotwireless-partneraccount.json +++ b/schema/aws-iotwireless-partneraccount.json @@ -1,166 +1,166 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PartnerAccountId" - ], - "definitions": { - "SidewalkAccountInfo": { - "additionalProperties": false, - "properties": { - "AppServerPrivateKey": { - "maxLength": 4096, - "minLength": 1, - "pattern": "[a-fA-F0-9]{64}", - "type": "string" - } - }, - "required": [ - "AppServerPrivateKey" - ], - "type": "object" - }, - "SidewalkAccountInfoWithFingerprint": { - "additionalProperties": false, - "properties": { - "AmazonId": { - "maxLength": 2048, - "type": "string" - }, - "Arn": { - "type": "string" - }, - "Fingerprint": { - "maxLength": 64, - "minLength": 64, - "pattern": "[a-fA-F0-9]{64}", - "type": "string" - } - }, - "type": "object" - }, - "SidewalkUpdateAccount": { - "additionalProperties": false, - "properties": { - "AppServerPrivateKey": { - "maxLength": 4096, - "minLength": 1, - "pattern": "[a-fA-F0-9]{64}", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage partner account", - "handlers": { - "create": { - "permissions": [ - "iotwireless:AssociateAwsAccountWithPartnerAccount", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DisassociateAwsAccountFromPartnerAccount" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListPartnerAccounts", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetPartnerAccount", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdatePartnerAccount", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PartnerAccountId" - ], - "properties": { - "AccountLinked": { - "description": "Whether the partner account is linked to the AWS account.", - "type": "boolean" - }, - "Arn": { - "description": "PartnerAccount arn. Returned after successful create.", - "type": "string" - }, - "Fingerprint": { - "description": "The fingerprint of the Sidewalk application server private key.", - "type": "string" - }, - "PartnerAccountId": { - "description": "The partner account ID to disassociate from the AWS account", - "maxLength": 256, - "type": "string" - }, - "PartnerType": { - "description": "The partner type", - "enum": [ - "Sidewalk" - ], - "type": "string" - }, - "Sidewalk": { - "$ref": "#/definitions/SidewalkAccountInfo", - "description": "The Sidewalk account credentials." - }, - "SidewalkResponse": { - "$ref": "#/definitions/SidewalkAccountInfoWithFingerprint", - "description": "The Sidewalk account credentials." - }, - "SidewalkUpdate": { - "$ref": "#/definitions/SidewalkUpdateAccount", - "description": "The Sidewalk account credentials." - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the destination.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Fingerprint" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::PartnerAccount", - "writeOnlyProperties": [ - "/properties/SidewalkUpdate", - "/properties/Sidewalk" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PartnerAccountId" + ], + "definitions": { + "SidewalkAccountInfo": { + "additionalProperties": false, + "properties": { + "AppServerPrivateKey": { + "maxLength": 4096, + "minLength": 1, + "pattern": "[a-fA-F0-9]{64}", + "type": "string" + } + }, + "required": [ + "AppServerPrivateKey" + ], + "type": "object" + }, + "SidewalkAccountInfoWithFingerprint": { + "additionalProperties": false, + "properties": { + "AmazonId": { + "maxLength": 2048, + "type": "string" + }, + "Arn": { + "type": "string" + }, + "Fingerprint": { + "maxLength": 64, + "minLength": 64, + "pattern": "[a-fA-F0-9]{64}", + "type": "string" + } + }, + "type": "object" + }, + "SidewalkUpdateAccount": { + "additionalProperties": false, + "properties": { + "AppServerPrivateKey": { + "maxLength": 4096, + "minLength": 1, + "pattern": "[a-fA-F0-9]{64}", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage partner account", + "handlers": { + "create": { + "permissions": [ + "iotwireless:AssociateAwsAccountWithPartnerAccount", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DisassociateAwsAccountFromPartnerAccount" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListPartnerAccounts", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetPartnerAccount", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdatePartnerAccount", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PartnerAccountId" + ], + "properties": { + "AccountLinked": { + "description": "Whether the partner account is linked to the AWS account.", + "type": "boolean" + }, + "Arn": { + "description": "PartnerAccount arn. Returned after successful create.", + "type": "string" + }, + "Fingerprint": { + "description": "The fingerprint of the Sidewalk application server private key.", + "type": "string" + }, + "PartnerAccountId": { + "description": "The partner account ID to disassociate from the AWS account", + "maxLength": 256, + "type": "string" + }, + "PartnerType": { + "description": "The partner type", + "enum": [ + "Sidewalk" + ], + "type": "string" + }, + "Sidewalk": { + "$ref": "#/definitions/SidewalkAccountInfo", + "description": "The Sidewalk account credentials." + }, + "SidewalkResponse": { + "$ref": "#/definitions/SidewalkAccountInfoWithFingerprint", + "description": "The Sidewalk account credentials." + }, + "SidewalkUpdate": { + "$ref": "#/definitions/SidewalkUpdateAccount", + "description": "The Sidewalk account credentials." + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the destination.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Fingerprint" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::PartnerAccount", + "writeOnlyProperties": [ + "/properties/SidewalkUpdate", + "/properties/Sidewalk" + ] +} diff --git a/schema/aws-iotwireless-serviceprofile.json b/schema/aws-iotwireless-serviceprofile.json index c602788..f6a91fa 100644 --- a/schema/aws-iotwireless-serviceprofile.json +++ b/schema/aws-iotwireless-serviceprofile.json @@ -1,168 +1,168 @@ -{ - "additionalProperties": false, - "definitions": { - "LoRaWANServiceProfile": { - "additionalProperties": false, - "properties": { - "AddGwMetadata": { - "type": "boolean" - }, - "ChannelMask": { - "type": "string" - }, - "DevStatusReqFreq": { - "type": "integer" - }, - "DlBucketSize": { - "type": "integer" - }, - "DlRate": { - "type": "integer" - }, - "DlRatePolicy": { - "type": "string" - }, - "DrMax": { - "type": "integer" - }, - "DrMin": { - "type": "integer" - }, - "HrAllowed": { - "type": "boolean" - }, - "MinGwDiversity": { - "type": "integer" - }, - "NwkGeoLoc": { - "type": "boolean" - }, - "PrAllowed": { - "type": "boolean" - }, - "RaAllowed": { - "type": "boolean" - }, - "ReportDevStatusBattery": { - "type": "boolean" - }, - "ReportDevStatusMargin": { - "type": "boolean" - }, - "TargetPer": { - "type": "integer" - }, - "UlBucketSize": { - "type": "integer" - }, - "UlRate": { - "type": "integer" - }, - "UlRatePolicy": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateServiceProfile", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteServiceProfile" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListServiceProfiles", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetServiceProfile", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Service profile Arn. Returned after successful create.", - "type": "string" - }, - "Id": { - "description": "Service profile Id. Returned after successful create.", - "maxLength": 256, - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWANServiceProfile", - "description": "LoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation" - }, - "Name": { - "description": "Name of service profile", - "maxLength": 256, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the service profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/LoRaWAN/UlRate", - "/properties/LoRaWAN/UlBucketSize", - "/properties/LoRaWAN/UlRatePolicy", - "/properties/LoRaWAN/DlRate", - "/properties/LoRaWAN/DlBucketSize", - "/properties/LoRaWAN/DlRatePolicy", - "/properties/LoRaWAN/DevStatusReqFreq", - "/properties/LoRaWAN/ReportDevStatusBattery", - "/properties/LoRaWAN/ReportDevStatusMargin", - "/properties/LoRaWAN/DrMin", - "/properties/LoRaWAN/DrMax", - "/properties/LoRaWAN/ChannelMask", - "/properties/LoRaWAN/HrAllowed", - "/properties/LoRaWAN/NwkGeoLoc", - "/properties/LoRaWAN/TargetPer", - "/properties/LoRaWAN/MinGwDiversity" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::ServiceProfile" -} +{ + "additionalProperties": false, + "definitions": { + "LoRaWANServiceProfile": { + "additionalProperties": false, + "properties": { + "AddGwMetadata": { + "type": "boolean" + }, + "ChannelMask": { + "type": "string" + }, + "DevStatusReqFreq": { + "type": "integer" + }, + "DlBucketSize": { + "type": "integer" + }, + "DlRate": { + "type": "integer" + }, + "DlRatePolicy": { + "type": "string" + }, + "DrMax": { + "type": "integer" + }, + "DrMin": { + "type": "integer" + }, + "HrAllowed": { + "type": "boolean" + }, + "MinGwDiversity": { + "type": "integer" + }, + "NwkGeoLoc": { + "type": "boolean" + }, + "PrAllowed": { + "type": "boolean" + }, + "RaAllowed": { + "type": "boolean" + }, + "ReportDevStatusBattery": { + "type": "boolean" + }, + "ReportDevStatusMargin": { + "type": "boolean" + }, + "TargetPer": { + "type": "integer" + }, + "UlBucketSize": { + "type": "integer" + }, + "UlRate": { + "type": "integer" + }, + "UlRatePolicy": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateServiceProfile", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteServiceProfile" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListServiceProfiles", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetServiceProfile", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Service profile Arn. Returned after successful create.", + "type": "string" + }, + "Id": { + "description": "Service profile Id. Returned after successful create.", + "maxLength": 256, + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWANServiceProfile", + "description": "LoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation" + }, + "Name": { + "description": "Name of service profile", + "maxLength": 256, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the service profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/LoRaWAN/UlRate", + "/properties/LoRaWAN/UlBucketSize", + "/properties/LoRaWAN/UlRatePolicy", + "/properties/LoRaWAN/DlRate", + "/properties/LoRaWAN/DlBucketSize", + "/properties/LoRaWAN/DlRatePolicy", + "/properties/LoRaWAN/DevStatusReqFreq", + "/properties/LoRaWAN/ReportDevStatusBattery", + "/properties/LoRaWAN/ReportDevStatusMargin", + "/properties/LoRaWAN/DrMin", + "/properties/LoRaWAN/DrMax", + "/properties/LoRaWAN/ChannelMask", + "/properties/LoRaWAN/HrAllowed", + "/properties/LoRaWAN/NwkGeoLoc", + "/properties/LoRaWAN/TargetPer", + "/properties/LoRaWAN/MinGwDiversity" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::ServiceProfile" +} diff --git a/schema/aws-iotwireless-taskdefinition.json b/schema/aws-iotwireless-taskdefinition.json index 0f039f7..c1cb1a4 100644 --- a/schema/aws-iotwireless-taskdefinition.json +++ b/schema/aws-iotwireless-taskdefinition.json @@ -1,182 +1,182 @@ -{ - "additionalProperties": false, - "definitions": { - "LoRaWANGatewayVersion": { - "additionalProperties": false, - "properties": { - "Model": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "PackageVersion": { - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "Station": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "LoRaWANUpdateGatewayTaskCreate": { - "additionalProperties": false, - "properties": { - "CurrentVersion": { - "$ref": "#/definitions/LoRaWANGatewayVersion" - }, - "SigKeyCrc": { - "format": "int64", - "type": "integer" - }, - "UpdateSignature": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "UpdateVersion": { - "$ref": "#/definitions/LoRaWANGatewayVersion" - } - }, - "type": "object" - }, - "LoRaWANUpdateGatewayTaskEntry": { - "additionalProperties": false, - "properties": { - "CurrentVersion": { - "$ref": "#/definitions/LoRaWANGatewayVersion" - }, - "UpdateVersion": { - "$ref": "#/definitions/LoRaWANGatewayVersion" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "UpdateWirelessGatewayTaskCreate": { - "additionalProperties": false, - "properties": { - "LoRaWAN": { - "$ref": "#/definitions/LoRaWANUpdateGatewayTaskCreate" - }, - "UpdateDataRole": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "UpdateDataSource": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Creates a gateway task definition.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateWirelessGatewayTaskDefinition", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteWirelessGatewayTaskDefinition" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListWirelessGatewayTaskDefinitions", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetWirelessGatewayTaskDefinition", - "iotwireless:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "TaskDefinition arn. Returned after successful create.", - "type": "string" - }, - "AutoCreateTasks": { - "description": "Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.", - "type": "boolean" - }, - "Id": { - "description": "The ID of the new wireless gateway task definition", - "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", - "type": "string" - }, - "LoRaWANUpdateGatewayTaskEntry": { - "$ref": "#/definitions/LoRaWANUpdateGatewayTaskEntry", - "description": "The list of task definitions." - }, - "Name": { - "description": "The name of the new resource.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the destination.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "TaskDefinitionType": { - "description": "A filter to list only the wireless gateway task definitions that use this task definition type", - "enum": [ - "UPDATE" - ], - "type": "string" - }, - "Update": { - "$ref": "#/definitions/UpdateWirelessGatewayTaskCreate", - "description": "Information about the gateways to update." - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "AutoCreateTasks" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::TaskDefinition" -} +{ + "additionalProperties": false, + "definitions": { + "LoRaWANGatewayVersion": { + "additionalProperties": false, + "properties": { + "Model": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "PackageVersion": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "Station": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "LoRaWANUpdateGatewayTaskCreate": { + "additionalProperties": false, + "properties": { + "CurrentVersion": { + "$ref": "#/definitions/LoRaWANGatewayVersion" + }, + "SigKeyCrc": { + "format": "int64", + "type": "integer" + }, + "UpdateSignature": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "UpdateVersion": { + "$ref": "#/definitions/LoRaWANGatewayVersion" + } + }, + "type": "object" + }, + "LoRaWANUpdateGatewayTaskEntry": { + "additionalProperties": false, + "properties": { + "CurrentVersion": { + "$ref": "#/definitions/LoRaWANGatewayVersion" + }, + "UpdateVersion": { + "$ref": "#/definitions/LoRaWANGatewayVersion" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "UpdateWirelessGatewayTaskCreate": { + "additionalProperties": false, + "properties": { + "LoRaWAN": { + "$ref": "#/definitions/LoRaWANUpdateGatewayTaskCreate" + }, + "UpdateDataRole": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "UpdateDataSource": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Creates a gateway task definition.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateWirelessGatewayTaskDefinition", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteWirelessGatewayTaskDefinition" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListWirelessGatewayTaskDefinitions", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetWirelessGatewayTaskDefinition", + "iotwireless:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "TaskDefinition arn. Returned after successful create.", + "type": "string" + }, + "AutoCreateTasks": { + "description": "Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.", + "type": "boolean" + }, + "Id": { + "description": "The ID of the new wireless gateway task definition", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "LoRaWANUpdateGatewayTaskEntry": { + "$ref": "#/definitions/LoRaWANUpdateGatewayTaskEntry", + "description": "The list of task definitions." + }, + "Name": { + "description": "The name of the new resource.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the destination.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "TaskDefinitionType": { + "description": "A filter to list only the wireless gateway task definitions that use this task definition type", + "enum": [ + "UPDATE" + ], + "type": "string" + }, + "Update": { + "$ref": "#/definitions/UpdateWirelessGatewayTaskCreate", + "description": "Information about the gateways to update." + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "AutoCreateTasks" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::TaskDefinition" +} diff --git a/schema/aws-iotwireless-wirelessdevice.json b/schema/aws-iotwireless-wirelessdevice.json index b934665..8693011 100644 --- a/schema/aws-iotwireless-wirelessdevice.json +++ b/schema/aws-iotwireless-wirelessdevice.json @@ -1,357 +1,360 @@ -{ - "additionalProperties": false, - "definitions": { - "AbpV10x": { - "additionalProperties": false, - "properties": { - "DevAddr": { - "pattern": "[a-fA-F0-9]{8}", - "type": "string" - }, - "SessionKeys": { - "$ref": "#/definitions/SessionKeysAbpV10x" - } - }, - "required": [ - "DevAddr", - "SessionKeys" - ], - "type": "object" - }, - "AbpV11": { - "additionalProperties": false, - "properties": { - "DevAddr": { - "pattern": "[a-fA-F0-9]{8}", - "type": "string" - }, - "SessionKeys": { - "$ref": "#/definitions/SessionKeysAbpV11" - } - }, - "required": [ - "DevAddr", - "SessionKeys" - ], - "type": "object" - }, - "Application": { - "additionalProperties": false, - "description": "LoRaWAN application configuration, which can be used to perform geolocation.", - "properties": { - "DestinationName": { - "description": "The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.", - "maxLength": 128, - "pattern": "[a-zA-Z0-9-_]+", - "type": "string" - }, - "FPort": { - "description": "The Fport value.", - "maximum": 223, - "minimum": 1, - "type": "integer" - }, - "Type": { - "description": "Application type, which can be specified to obtain real-time position information of your LoRaWAN device.", - "enum": [ - "SemtechGeolocation" - ], - "type": "string" - } - }, - "type": "object" - }, - "FPorts": { - "additionalProperties": false, - "properties": { - "Applications": { - "description": "A list of optional LoRaWAN application information, which can be used for geolocation.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Application" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "LoRaWANDevice": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "OtaaV11" - ] - }, - { - "required": [ - "OtaaV10x" - ] - }, - { - "required": [ - "AbpV11" - ] - }, - { - "required": [ - "AbpV10x" - ] - } - ], - "properties": { - "AbpV10x": { - "$ref": "#/definitions/AbpV10x" - }, - "AbpV11": { - "$ref": "#/definitions/AbpV11" - }, - "DevEui": { - "pattern": "[a-f0-9]{16}", - "type": "string" - }, - "DeviceProfileId": { - "maxLength": 256, - "type": "string" - }, - "FPorts": { - "$ref": "#/definitions/FPorts" - }, - "OtaaV10x": { - "$ref": "#/definitions/OtaaV10x" - }, - "OtaaV11": { - "$ref": "#/definitions/OtaaV11" - }, - "ServiceProfileId": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "OtaaV10x": { - "additionalProperties": false, - "properties": { - "AppEui": { - "pattern": "[a-fA-F0-9]{16}", - "type": "string" - }, - "AppKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - } - }, - "required": [ - "AppKey", - "AppEui" - ], - "type": "object" - }, - "OtaaV11": { - "additionalProperties": false, - "properties": { - "AppKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - }, - "JoinEui": { - "pattern": "[a-fA-F0-9]{16}", - "type": "string" - }, - "NwkKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - } - }, - "required": [ - "AppKey", - "NwkKey", - "JoinEui" - ], - "type": "object" - }, - "SessionKeysAbpV10x": { - "additionalProperties": false, - "properties": { - "AppSKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - }, - "NwkSKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - } - }, - "required": [ - "NwkSKey", - "AppSKey" - ], - "type": "object" - }, - "SessionKeysAbpV11": { - "additionalProperties": false, - "properties": { - "AppSKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - }, - "FNwkSIntKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - }, - "NwkSEncKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - }, - "SNwkSIntKey": { - "pattern": "[a-fA-F0-9]{32}", - "type": "string" - } - }, - "required": [ - "FNwkSIntKey", - "SNwkSIntKey", - "NwkSEncKey", - "AppSKey" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage wireless gateways, including LoRa gateways.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateWirelessDevice", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteWirelessDevice", - "iotwireless:DisassociateWirelessDeviceFromThing" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListWirelessDevices", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetWirelessDevice", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdateWirelessDevice", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource", - "iotwireless:AssociateWirelessDeviceWithThing" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Wireless device arn. Returned after successful create.", - "type": "string" - }, - "Description": { - "description": "Wireless device description", - "maxLength": 2048, - "type": "string" - }, - "DestinationName": { - "description": "Wireless device destination name", - "maxLength": 128, - "type": "string" - }, - "Id": { - "description": "Wireless device Id. Returned after successful create.", - "maxLength": 256, - "type": "string" - }, - "LastUplinkReceivedAt": { - "description": "The date and time when the most recent uplink was received.", - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWANDevice", - "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device." - }, - "Name": { - "description": "Wireless device name", - "maxLength": 256, - "type": "string" - }, - "Positioning": { - "description": "FPort values for the GNSS, stream, and ClockSync functions of the positioning information.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "ThingArn": { - "description": "Thing arn. Passed into update to associate Thing with Wireless device.", - "type": "string" - }, - "ThingName": { - "description": "Thing Arn. If there is a Thing created, this can be returned with a Get call.", - "type": "string" - }, - "Type": { - "description": "Wireless device type, currently only Sidewalk and LoRa", - "enum": [ - "Sidewalk", - "LoRaWAN" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ThingName", - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Type", - "DestinationName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::WirelessDevice" -} +{ + "additionalProperties": false, + "definitions": { + "AbpV10x": { + "additionalProperties": false, + "properties": { + "DevAddr": { + "pattern": "[a-fA-F0-9]{8}", + "type": "string" + }, + "SessionKeys": { + "$ref": "#/definitions/SessionKeysAbpV10x" + } + }, + "required": [ + "DevAddr", + "SessionKeys" + ], + "type": "object" + }, + "AbpV11": { + "additionalProperties": false, + "properties": { + "DevAddr": { + "pattern": "[a-fA-F0-9]{8}", + "type": "string" + }, + "SessionKeys": { + "$ref": "#/definitions/SessionKeysAbpV11" + } + }, + "required": [ + "DevAddr", + "SessionKeys" + ], + "type": "object" + }, + "Application": { + "additionalProperties": false, + "description": "LoRaWAN application configuration, which can be used to perform geolocation.", + "properties": { + "DestinationName": { + "description": "The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.", + "maxLength": 128, + "pattern": "[a-zA-Z0-9-_]+", + "type": "string" + }, + "FPort": { + "description": "The Fport value.", + "maximum": 223, + "minimum": 1, + "type": "integer" + }, + "Type": { + "description": "Application type, which can be specified to obtain real-time position information of your LoRaWAN device.", + "enum": [ + "SemtechGeolocation", + "SemtechGNSS", + "SemtechGNSSNG", + "SemtechWiFi" + ], + "type": "string" + } + }, + "type": "object" + }, + "FPorts": { + "additionalProperties": false, + "properties": { + "Applications": { + "description": "A list of optional LoRaWAN application information, which can be used for geolocation.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Application" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "LoRaWANDevice": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "OtaaV11" + ] + }, + { + "required": [ + "OtaaV10x" + ] + }, + { + "required": [ + "AbpV11" + ] + }, + { + "required": [ + "AbpV10x" + ] + } + ], + "properties": { + "AbpV10x": { + "$ref": "#/definitions/AbpV10x" + }, + "AbpV11": { + "$ref": "#/definitions/AbpV11" + }, + "DevEui": { + "pattern": "[a-f0-9]{16}", + "type": "string" + }, + "DeviceProfileId": { + "maxLength": 256, + "type": "string" + }, + "FPorts": { + "$ref": "#/definitions/FPorts" + }, + "OtaaV10x": { + "$ref": "#/definitions/OtaaV10x" + }, + "OtaaV11": { + "$ref": "#/definitions/OtaaV11" + }, + "ServiceProfileId": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "OtaaV10x": { + "additionalProperties": false, + "properties": { + "AppEui": { + "pattern": "[a-fA-F0-9]{16}", + "type": "string" + }, + "AppKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + } + }, + "required": [ + "AppKey", + "AppEui" + ], + "type": "object" + }, + "OtaaV11": { + "additionalProperties": false, + "properties": { + "AppKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + }, + "JoinEui": { + "pattern": "[a-fA-F0-9]{16}", + "type": "string" + }, + "NwkKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + } + }, + "required": [ + "AppKey", + "NwkKey", + "JoinEui" + ], + "type": "object" + }, + "SessionKeysAbpV10x": { + "additionalProperties": false, + "properties": { + "AppSKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + }, + "NwkSKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + } + }, + "required": [ + "NwkSKey", + "AppSKey" + ], + "type": "object" + }, + "SessionKeysAbpV11": { + "additionalProperties": false, + "properties": { + "AppSKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + }, + "FNwkSIntKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + }, + "NwkSEncKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + }, + "SNwkSIntKey": { + "pattern": "[a-fA-F0-9]{32}", + "type": "string" + } + }, + "required": [ + "FNwkSIntKey", + "SNwkSIntKey", + "NwkSEncKey", + "AppSKey" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage wireless gateways, including LoRa gateways.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateWirelessDevice", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteWirelessDevice", + "iotwireless:DisassociateWirelessDeviceFromThing" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListWirelessDevices", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetWirelessDevice", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdateWirelessDevice", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource", + "iotwireless:AssociateWirelessDeviceWithThing" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Wireless device arn. Returned after successful create.", + "type": "string" + }, + "Description": { + "description": "Wireless device description", + "maxLength": 2048, + "type": "string" + }, + "DestinationName": { + "description": "Wireless device destination name", + "maxLength": 128, + "type": "string" + }, + "Id": { + "description": "Wireless device Id. Returned after successful create.", + "maxLength": 256, + "type": "string" + }, + "LastUplinkReceivedAt": { + "description": "The date and time when the most recent uplink was received.", + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWANDevice", + "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device." + }, + "Name": { + "description": "Wireless device name", + "maxLength": 256, + "type": "string" + }, + "Positioning": { + "description": "FPort values for the GNSS, stream, and ClockSync functions of the positioning information.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "ThingArn": { + "description": "Thing arn. Passed into update to associate Thing with Wireless device.", + "type": "string" + }, + "ThingName": { + "description": "Thing Arn. If there is a Thing created, this can be returned with a Get call.", + "type": "string" + }, + "Type": { + "description": "Wireless device type, currently only Sidewalk and LoRa", + "enum": [ + "Sidewalk", + "LoRaWAN" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ThingName", + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Type", + "DestinationName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::WirelessDevice" +} diff --git a/schema/aws-iotwireless-wirelessdeviceimporttask.json b/schema/aws-iotwireless-wirelessdeviceimporttask.json index c50c8be..b6b496f 100644 --- a/schema/aws-iotwireless-wirelessdeviceimporttask.json +++ b/schema/aws-iotwireless-wirelessdeviceimporttask.json @@ -1,215 +1,215 @@ -{ - "additionalProperties": false, - "definitions": { - "DeviceCreationFileList": { - "description": "sidewalk create device's file path", - "items": { - "maxLength": 1024, - "type": "string" - }, - "type": "array" - }, - "Role": { - "description": "sidewalk role", - "maxLength": 2048, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Wireless Device Import Tasks", - "handlers": { - "create": { - "permissions": [ - "iotwireless:StartWirelessDeviceImportTask", - "iotwireless:StartSingleWirelessDeviceImportTask", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteWirelessDeviceImportTask" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListWirelessDeviceImportTasks", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetWirelessDeviceImportTask", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdateWirelessDeviceImportTask", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn for Wireless Device Import Task, Returned upon successful start.", - "maxLength": 128, - "type": "string" - }, - "CreationDate": { - "description": "CreationDate for import task", - "type": "string" - }, - "DestinationName": { - "description": "Destination Name for import task", - "maxLength": 128, - "pattern": "[a-zA-Z0-9-_]+", - "type": "string" - }, - "FailedImportedDevicesCount": { - "description": "Failed Imported Devices Count", - "type": "integer" - }, - "Id": { - "description": "Id for Wireless Device Import Task, Returned upon successful start.", - "maxLength": 256, - "type": "string" - }, - "InitializedImportedDevicesCount": { - "description": "Initialized Imported Devices Count", - "type": "integer" - }, - "OnboardedImportedDevicesCount": { - "description": "Onboarded Imported Devices Count", - "type": "integer" - }, - "PendingImportedDevicesCount": { - "description": "Pending Imported Devices Count", - "type": "integer" - }, - "Sidewalk": { - "additionalProperties": false, - "description": "sidewalk contain file for created device and role", - "oneOf": [ - { - "allOf": [ - { - "required": [ - "DeviceCreationFile" - ] - }, - { - "required": [ - "Role" - ] - } - ] - }, - { - "required": [ - "SidewalkManufacturingSn" - ] - } - ], - "properties": { - "DeviceCreationFile": { - "maxLength": 1024, - "type": "string" - }, - "DeviceCreationFileList": { - "$ref": "#/definitions/DeviceCreationFileList" - }, - "Role": { - "$ref": "#/definitions/Role" - }, - "SidewalkManufacturingSn": { - "maxLength": 64, - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "Status for import task", - "enum": [ - "INITIALIZING", - "INITIALIZED", - "PENDING", - "COMPLETE", - "FAILED", - "DELETING" - ], - "type": "string" - }, - "StatusReason": { - "description": "StatusReason for import task", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/CreationDate", - "/properties/Status", - "/properties/StatusReason", - "/properties/InitializedImportedDevicesCount", - "/properties/PendingImportedDevicesCount", - "/properties/OnboardedImportedDevicesCount", - "/properties/FailedImportedDevicesCount", - "/properties/Sidewalk/DeviceCreationFileList" - ], - "required": [ - "DestinationName", - "Sidewalk" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::IoTWireless::WirelessDeviceImportTask", - "writeOnlyProperties": [ - "/properties/Sidewalk/DeviceCreationFile", - "/properties/Sidewalk/SidewalkManufacturingSn" - ] -} +{ + "additionalProperties": false, + "definitions": { + "DeviceCreationFileList": { + "description": "sidewalk create device's file path", + "items": { + "maxLength": 1024, + "type": "string" + }, + "type": "array" + }, + "Role": { + "description": "sidewalk role", + "maxLength": 2048, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Wireless Device Import Tasks", + "handlers": { + "create": { + "permissions": [ + "iotwireless:StartWirelessDeviceImportTask", + "iotwireless:StartSingleWirelessDeviceImportTask", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteWirelessDeviceImportTask" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListWirelessDeviceImportTasks", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetWirelessDeviceImportTask", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdateWirelessDeviceImportTask", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn for Wireless Device Import Task, Returned upon successful start.", + "maxLength": 128, + "type": "string" + }, + "CreationDate": { + "description": "CreationDate for import task", + "type": "string" + }, + "DestinationName": { + "description": "Destination Name for import task", + "maxLength": 128, + "pattern": "[a-zA-Z0-9-_]+", + "type": "string" + }, + "FailedImportedDevicesCount": { + "description": "Failed Imported Devices Count", + "type": "integer" + }, + "Id": { + "description": "Id for Wireless Device Import Task, Returned upon successful start.", + "maxLength": 256, + "type": "string" + }, + "InitializedImportedDevicesCount": { + "description": "Initialized Imported Devices Count", + "type": "integer" + }, + "OnboardedImportedDevicesCount": { + "description": "Onboarded Imported Devices Count", + "type": "integer" + }, + "PendingImportedDevicesCount": { + "description": "Pending Imported Devices Count", + "type": "integer" + }, + "Sidewalk": { + "additionalProperties": false, + "description": "sidewalk contain file for created device and role", + "oneOf": [ + { + "allOf": [ + { + "required": [ + "DeviceCreationFile" + ] + }, + { + "required": [ + "Role" + ] + } + ] + }, + { + "required": [ + "SidewalkManufacturingSn" + ] + } + ], + "properties": { + "DeviceCreationFile": { + "maxLength": 1024, + "type": "string" + }, + "DeviceCreationFileList": { + "$ref": "#/definitions/DeviceCreationFileList" + }, + "Role": { + "$ref": "#/definitions/Role" + }, + "SidewalkManufacturingSn": { + "maxLength": 64, + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "Status for import task", + "enum": [ + "INITIALIZING", + "INITIALIZED", + "PENDING", + "COMPLETE", + "FAILED", + "DELETING" + ], + "type": "string" + }, + "StatusReason": { + "description": "StatusReason for import task", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/CreationDate", + "/properties/Status", + "/properties/StatusReason", + "/properties/InitializedImportedDevicesCount", + "/properties/PendingImportedDevicesCount", + "/properties/OnboardedImportedDevicesCount", + "/properties/FailedImportedDevicesCount", + "/properties/Sidewalk/DeviceCreationFileList" + ], + "required": [ + "DestinationName", + "Sidewalk" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::IoTWireless::WirelessDeviceImportTask", + "writeOnlyProperties": [ + "/properties/Sidewalk/DeviceCreationFile", + "/properties/Sidewalk/SidewalkManufacturingSn" + ] +} diff --git a/schema/aws-iotwireless-wirelessgateway.json b/schema/aws-iotwireless-wirelessgateway.json index 1ae0c9d..6ff0da4 100644 --- a/schema/aws-iotwireless-wirelessgateway.json +++ b/schema/aws-iotwireless-wirelessgateway.json @@ -1,135 +1,135 @@ -{ - "additionalProperties": false, - "definitions": { - "LoRaWANGateway": { - "additionalProperties": false, - "properties": { - "GatewayEui": { - "pattern": "^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$", - "type": "string" - }, - "RfRegion": { - "maxLength": 64, - "type": "string" - } - }, - "required": [ - "GatewayEui", - "RfRegion" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Create and manage wireless gateways, including LoRa gateways.", - "handlers": { - "create": { - "permissions": [ - "iotwireless:CreateWirelessGateway", - "iotwireless:TagResource", - "iotwireless:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "iotwireless:DeleteWirelessGateway", - "iotwireless:DisassociateWirelessGatewayFromThing" - ] - }, - "list": { - "permissions": [ - "iotwireless:ListWirelessGateways", - "iotwireless:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "iotwireless:GetWirelessGateway", - "iotwireless:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iotwireless:UpdateWirelessGateway", - "iotwireless:UntagResource", - "iotwireless:ListTagsForResource", - "iotwireless:AssociateWirelessGatewayWithThing" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn for Wireless Gateway. Returned upon successful create.", - "type": "string" - }, - "Description": { - "description": "Description of Wireless Gateway.", - "maxLength": 2048, - "type": "string" - }, - "Id": { - "description": "Id for Wireless Gateway. Returned upon successful create.", - "maxLength": 256, - "type": "string" - }, - "LastUplinkReceivedAt": { - "description": "The date and time when the most recent uplink was received.", - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/LoRaWANGateway", - "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway." - }, - "Name": { - "description": "Name of Wireless Gateway.", - "maxLength": 256, - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the gateway.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "ThingArn": { - "description": "Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway.", - "type": "string" - }, - "ThingName": { - "description": "Thing Name. If there is a Thing created, this can be returned with a Get call.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "LoRaWAN" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::IoTWireless::WirelessGateway" -} +{ + "additionalProperties": false, + "definitions": { + "LoRaWANGateway": { + "additionalProperties": false, + "properties": { + "GatewayEui": { + "pattern": "^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$", + "type": "string" + }, + "RfRegion": { + "maxLength": 64, + "type": "string" + } + }, + "required": [ + "GatewayEui", + "RfRegion" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Create and manage wireless gateways, including LoRa gateways.", + "handlers": { + "create": { + "permissions": [ + "iotwireless:CreateWirelessGateway", + "iotwireless:TagResource", + "iotwireless:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "iotwireless:DeleteWirelessGateway", + "iotwireless:DisassociateWirelessGatewayFromThing" + ] + }, + "list": { + "permissions": [ + "iotwireless:ListWirelessGateways", + "iotwireless:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "iotwireless:GetWirelessGateway", + "iotwireless:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iotwireless:UpdateWirelessGateway", + "iotwireless:UntagResource", + "iotwireless:ListTagsForResource", + "iotwireless:AssociateWirelessGatewayWithThing" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn for Wireless Gateway. Returned upon successful create.", + "type": "string" + }, + "Description": { + "description": "Description of Wireless Gateway.", + "maxLength": 2048, + "type": "string" + }, + "Id": { + "description": "Id for Wireless Gateway. Returned upon successful create.", + "maxLength": 256, + "type": "string" + }, + "LastUplinkReceivedAt": { + "description": "The date and time when the most recent uplink was received.", + "type": "string" + }, + "LoRaWAN": { + "$ref": "#/definitions/LoRaWANGateway", + "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway." + }, + "Name": { + "description": "Name of Wireless Gateway.", + "maxLength": 256, + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the gateway.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "ThingArn": { + "description": "Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway.", + "type": "string" + }, + "ThingName": { + "description": "Thing Name. If there is a Thing created, this can be returned with a Get call.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "LoRaWAN" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::IoTWireless::WirelessGateway" +} diff --git a/schema/aws-ivs-channel.json b/schema/aws-ivs-channel.json index 7061a51..42c1795 100644 --- a/schema/aws-ivs-channel.json +++ b/schema/aws-ivs-channel.json @@ -1,160 +1,166 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::Channel", - "handlers": { - "create": { - "permissions": [ - "ivs:CreateChannel", - "ivs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteChannel", - "ivs:UnTagResource" - ] - }, - "list": { - "permissions": [ - "ivs:ListChannels", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetChannel", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetChannel", - "ivs:UpdateChannel", - "ivs:TagResource", - "ivs:UnTagResource", - "ivs:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Channel ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Authorized": { - "default": false, - "description": "Whether the channel is authorized.", - "type": "boolean" - }, - "IngestEndpoint": { - "description": "Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.", - "type": "string" - }, - "InsecureIngest": { - "default": false, - "description": "Whether the channel allows insecure ingest.", - "type": "boolean" - }, - "LatencyMode": { - "default": "LOW", - "description": "Channel latency mode.", - "enum": [ - "NORMAL", - "LOW" - ], - "type": "string" - }, - "Name": { - "default": "-", - "description": "Channel", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "PlaybackUrl": { - "description": "Channel Playback URL.", - "type": "string" - }, - "Preset": { - "description": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").", - "enum": [ - "HIGHER_BANDWIDTH_DELIVERY", - "CONSTRAINED_BANDWIDTH_DELIVERY" - ], - "type": "string" - }, - "RecordingConfigurationArn": { - "default": "", - "description": "Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (recording is disabled).", - "maxLength": 128, - "minLength": 0, - "pattern": "^$|arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "default": "STANDARD", - "description": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.", - "enum": [ - "STANDARD", - "BASIC", - "ADVANCED_SD", - "ADVANCED_HD" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/PlaybackUrl", - "/properties/IngestEndpoint" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::Channel" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::Channel", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateChannel", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteChannel", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListChannels", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetChannel", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetChannel", + "ivs:UpdateChannel", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Channel ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Authorized": { + "default": false, + "description": "Whether the channel is authorized.", + "type": "boolean" + }, + "IngestEndpoint": { + "description": "Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.", + "type": "string" + }, + "InsecureIngest": { + "default": false, + "description": "Whether the channel allows insecure ingest.", + "type": "boolean" + }, + "LatencyMode": { + "default": "LOW", + "description": "Channel latency mode.", + "enum": [ + "NORMAL", + "LOW" + ], + "type": "string" + }, + "Name": { + "default": "-", + "description": "Channel", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "PlaybackUrl": { + "description": "Channel Playback URL.", + "type": "string" + }, + "Preset": { + "description": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").", + "enum": [ + "", + "HIGHER_BANDWIDTH_DELIVERY", + "CONSTRAINED_BANDWIDTH_DELIVERY" + ], + "type": "string" + }, + "RecordingConfigurationArn": { + "default": "", + "description": "Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (recording is disabled).", + "maxLength": 128, + "minLength": 0, + "pattern": "^$|arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "default": "STANDARD", + "description": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.", + "enum": [ + "STANDARD", + "BASIC", + "ADVANCED_SD", + "ADVANCED_HD" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/PlaybackUrl", + "/properties/IngestEndpoint" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::Channel" +} diff --git a/schema/aws-ivs-encoderconfiguration.json b/schema/aws-ivs-encoderconfiguration.json index 39abc7f..d3d943c 100644 --- a/schema/aws-ivs-encoderconfiguration.json +++ b/schema/aws-ivs-encoderconfiguration.json @@ -1,148 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Video", - "/properties/Video/Bitrate", - "/properties/Video/Framerate", - "/properties/Video/Height", - "/properties/Video/Width" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::EncoderConfiguration.", - "handlers": { - "create": { - "permissions": [ - "ivs:CreateEncoderConfiguration", - "ivs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteEncoderConfiguration", - "ivs:UntagResource" - ] - }, - "list": { - "permissions": [ - "ivs:ListEncoderConfigurations", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetEncoderConfiguration", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetEncoderConfiguration", - "ivs:ListTagsForResource", - "ivs:UntagResource", - "ivs:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Encoder configuration identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "Encoder configuration name.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Video": { - "additionalProperties": false, - "description": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps", - "properties": { - "Bitrate": { - "default": 2500000, - "description": "Bitrate for generated output, in bps. Default: 2500000.", - "maximum": 8500000, - "minimum": 1, - "type": "integer" - }, - "Framerate": { - "default": 30, - "description": "Video frame rate, in fps. Default: 30.", - "maximum": 60, - "minimum": 1, - "type": "number" - }, - "Height": { - "default": 720, - "description": "Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.", - "maximum": 1920, - "minimum": 1, - "type": "integer" - }, - "Width": { - "default": 1280, - "description": "Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.", - "maximum": 1920, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::EncoderConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Video", + "/properties/Video/Bitrate", + "/properties/Video/Framerate", + "/properties/Video/Height", + "/properties/Video/Width" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::EncoderConfiguration.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateEncoderConfiguration", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteEncoderConfiguration", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListEncoderConfigurations", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetEncoderConfiguration", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetEncoderConfiguration", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Encoder configuration identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "Encoder configuration name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Video": { + "additionalProperties": false, + "description": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps", + "properties": { + "Bitrate": { + "default": 2500000, + "description": "Bitrate for generated output, in bps. Default: 2500000.", + "maximum": 8500000, + "minimum": 1, + "type": "integer" + }, + "Framerate": { + "default": 30, + "description": "Video frame rate, in fps. Default: 30.", + "maximum": 60, + "minimum": 1, + "type": "number" + }, + "Height": { + "default": 720, + "description": "Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.", + "maximum": 1920, + "minimum": 1, + "type": "integer" + }, + "Width": { + "default": 1280, + "description": "Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.", + "maximum": 1920, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::EncoderConfiguration" +} diff --git a/schema/aws-ivs-playbackkeypair.json b/schema/aws-ivs-playbackkeypair.json index fda6285..4519efb 100644 --- a/schema/aws-ivs-playbackkeypair.json +++ b/schema/aws-ivs-playbackkeypair.json @@ -1,116 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PublicKeyMaterial", - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::PlaybackKeyPair", - "handlers": { - "create": { - "permissions": [ - "ivs:ImportPlaybackKeyPair", - "ivs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivs:DeletePlaybackKeyPair", - "ivs:UntagResource" - ] - }, - "list": { - "permissions": [ - "ivs:ListPlaybackKeyPairs", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetPlaybackKeyPair" - ] - }, - "update": { - "permissions": [ - "ivs:GetPlaybackKeyPair", - "ivs:ListTagsForResource", - "ivs:UntagResource", - "ivs:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Key-pair identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Fingerprint": { - "description": "Key-pair identifier.", - "type": "string" - }, - "Name": { - "description": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "PublicKeyMaterial": { - "description": "The public portion of a customer-generated key pair.", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Fingerprint" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::PlaybackKeyPair", - "writeOnlyProperties": [ - "/properties/PublicKeyMaterial" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PublicKeyMaterial", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::PlaybackKeyPair", + "handlers": { + "create": { + "permissions": [ + "ivs:ImportPlaybackKeyPair", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeletePlaybackKeyPair", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListPlaybackKeyPairs", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetPlaybackKeyPair" + ] + }, + "update": { + "permissions": [ + "ivs:GetPlaybackKeyPair", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Key-pair identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Fingerprint": { + "description": "Key-pair identifier.", + "type": "string" + }, + "Name": { + "description": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "PublicKeyMaterial": { + "description": "The public portion of a customer-generated key pair.", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Fingerprint" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::PlaybackKeyPair", + "writeOnlyProperties": [ + "/properties/PublicKeyMaterial" + ] +} diff --git a/schema/aws-ivs-playbackrestrictionpolicy.json b/schema/aws-ivs-playbackrestrictionpolicy.json index 52b9c8d..e9c129d 100644 --- a/schema/aws-ivs-playbackrestrictionpolicy.json +++ b/schema/aws-ivs-playbackrestrictionpolicy.json @@ -1,133 +1,138 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::PlaybackRestrictionPolicy.", - "handlers": { - "create": { - "permissions": [ - "ivs:CreatePlaybackRestrictionPolicy", - "ivs:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivs:DeletePlaybackRestrictionPolicy", - "ivs:UntagResource" - ] - }, - "list": { - "permissions": [ - "ivs:ListPlaybackRestrictionPolicies", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetPlaybackRestrictionPolicy", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetPlaybackRestrictionPolicy", - "ivs:UpdatePlaybackRestrictionPolicy", - "ivs:ListTagsForResource", - "ivs:UntagResource", - "ivs:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AllowedCountries": { - "default": [], - "description": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AllowedOrigins": { - "default": [], - "description": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Arn": { - "description": "Playback-restriction-policy identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$", - "type": "string" - }, - "EnableStrictOriginEnforcement": { - "default": false, - "description": "Whether channel playback is constrained by origin site.", - "type": "boolean" - }, - "Name": { - "description": "Playback-restriction-policy name.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AllowedCountries", - "AllowedOrigins" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::PlaybackRestrictionPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::PlaybackRestrictionPolicy.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreatePlaybackRestrictionPolicy", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeletePlaybackRestrictionPolicy", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListPlaybackRestrictionPolicies", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetPlaybackRestrictionPolicy", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetPlaybackRestrictionPolicy", + "ivs:UpdatePlaybackRestrictionPolicy", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AllowedCountries": { + "default": [], + "description": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AllowedOrigins": { + "default": [], + "description": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Arn": { + "description": "Playback-restriction-policy identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$", + "type": "string" + }, + "EnableStrictOriginEnforcement": { + "default": false, + "description": "Whether channel playback is constrained by origin site.", + "type": "boolean" + }, + "Name": { + "description": "Playback-restriction-policy name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AllowedCountries", + "AllowedOrigins" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::PlaybackRestrictionPolicy" +} diff --git a/schema/aws-ivs-publickey.json b/schema/aws-ivs-publickey.json new file mode 100644 index 0000000..db2d455 --- /dev/null +++ b/schema/aws-ivs-publickey.json @@ -0,0 +1,119 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PublicKeyMaterial", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::PublicKey", + "handlers": { + "create": { + "permissions": [ + "ivs:ImportPublicKey", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeletePublicKey", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListPublicKeys", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetPublicKey" + ] + }, + "update": { + "permissions": [ + "ivs:GetPublicKey", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Key-pair identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Fingerprint": { + "description": "Key-pair identifier.", + "type": "string" + }, + "Name": { + "description": "Name of the public key to be imported. The value does not need to be unique.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "PublicKeyMaterial": { + "description": "The public portion of a customer-generated key pair.", + "pattern": "-----BEGIN PUBLIC KEY-----\\r?\\n([a-zA-Z0-9+/=\\r\\n]+)\\r?\\n-----END PUBLIC KEY-----(\\r?\\n)?", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Fingerprint" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::PublicKey" +} diff --git a/schema/aws-ivs-recordingconfiguration.json b/schema/aws-ivs-recordingconfiguration.json index 41b531a..0645d0d 100644 --- a/schema/aws-ivs-recordingconfiguration.json +++ b/schema/aws-ivs-recordingconfiguration.json @@ -1,271 +1,276 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/DestinationConfiguration", - "/properties/DestinationConfiguration/S3", - "/properties/DestinationConfiguration/S3/BucketName", - "/properties/RecordingReconnectWindowSeconds", - "/properties/ThumbnailConfiguration", - "/properties/ThumbnailConfiguration/RecordingMode", - "/properties/ThumbnailConfiguration/TargetIntervalSeconds", - "/properties/ThumbnailConfiguration/Storage", - "/properties/ThumbnailConfiguration/Resolution", - "/properties/RenditionConfiguration", - "/properties/RenditionConfiguration/RenditionSelection", - "/properties/RenditionConfiguration/Renditions" - ], - "definitions": { - "DestinationConfiguration": { - "additionalProperties": false, - "description": "Recording Destination Configuration.", - "properties": { - "S3": { - "$ref": "#/definitions/S3DestinationConfiguration" - } - }, - "required": [], - "type": "object" - }, - "RenditionConfiguration": { - "additionalProperties": false, - "description": "Rendition Configuration describes which renditions should be recorded for a stream.", - "properties": { - "RenditionSelection": { - "default": "ALL", - "description": "Resolution Selection indicates which set of renditions are recorded for a stream.", - "enum": [ - "ALL", - "NONE", - "CUSTOM" - ], - "type": "string" - }, - "Renditions": { - "description": "Renditions indicates which renditions are recorded for a stream.", - "insertionOrder": false, - "items": { - "enum": [ - "FULL_HD", - "HD", - "SD", - "LOWEST_RESOLUTION" - ], - "type": "string" - }, - "maxItems": 4, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "required": [], - "type": "object" - }, - "S3DestinationConfiguration": { - "additionalProperties": false, - "description": "Recording S3 Destination Configuration.", - "properties": { - "BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9-.]+$", - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ThumbnailConfiguration": { - "additionalProperties": false, - "description": "Recording Thumbnail Configuration.", - "properties": { - "RecordingMode": { - "default": "INTERVAL", - "description": "Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.", - "enum": [ - "INTERVAL", - "DISABLED" - ], - "type": "string" - }, - "Resolution": { - "description": "Resolution indicates the desired resolution of recorded thumbnails.", - "enum": [ - "FULL_HD", - "HD", - "SD", - "LOWEST_RESOLUTION" - ], - "type": "string" - }, - "Storage": { - "description": "Storage indicates the format in which thumbnails are recorded.", - "insertionOrder": false, - "items": { - "enum": [ - "SEQUENTIAL", - "LATEST" - ], - "type": "string" - }, - "maxItems": 2, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "TargetIntervalSeconds": { - "default": 60, - "description": "Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.", - "maximum": 60, - "minimum": 1, - "type": "integer" - } - }, - "required": [], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::RecordingConfiguration", - "handlers": { - "create": { - "permissions": [ - "ivs:CreateRecordingConfiguration", - "ivs:GetRecordingConfiguration", - "ivs:TagResource", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "iam:AttachRolePolicy", - "s3:ListBucket", - "s3:GetBucketLocation", - "cloudformation:ListExports" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteRecordingConfiguration", - "ivs:UntagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "list": { - "permissions": [ - "ivs:ListRecordingConfigurations", - "s3:GetBucketLocation", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetRecordingConfiguration", - "s3:GetBucketLocation", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetRecordingConfiguration", - "sts:AssumeRole", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "iam:AttachRolePolicy", - "s3:ListBucket", - "ivs:TagResource", - "ivs:UntagResource", - "ivs:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 0, - "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "DestinationConfiguration": { - "$ref": "#/definitions/DestinationConfiguration" - }, - "Name": { - "description": "Recording Configuration Name.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "RecordingReconnectWindowSeconds": { - "default": 0, - "description": "Recording Reconnect Window Seconds. (0 means disabled)", - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "RenditionConfiguration": { - "$ref": "#/definitions/RenditionConfiguration" - }, - "State": { - "description": "Recording Configuration State.", - "enum": [ - "CREATING", - "CREATE_FAILED", - "ACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "ThumbnailConfiguration": { - "$ref": "#/definitions/ThumbnailConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/State" - ], - "required": [ - "DestinationConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::RecordingConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/DestinationConfiguration", + "/properties/DestinationConfiguration/S3", + "/properties/DestinationConfiguration/S3/BucketName", + "/properties/RecordingReconnectWindowSeconds", + "/properties/ThumbnailConfiguration", + "/properties/ThumbnailConfiguration/RecordingMode", + "/properties/ThumbnailConfiguration/TargetIntervalSeconds", + "/properties/ThumbnailConfiguration/Storage", + "/properties/ThumbnailConfiguration/Resolution", + "/properties/RenditionConfiguration", + "/properties/RenditionConfiguration/RenditionSelection", + "/properties/RenditionConfiguration/Renditions" + ], + "definitions": { + "DestinationConfiguration": { + "additionalProperties": false, + "description": "Recording Destination Configuration.", + "properties": { + "S3": { + "$ref": "#/definitions/S3DestinationConfiguration" + } + }, + "required": [], + "type": "object" + }, + "RenditionConfiguration": { + "additionalProperties": false, + "description": "Rendition Configuration describes which renditions should be recorded for a stream.", + "properties": { + "RenditionSelection": { + "default": "ALL", + "description": "Resolution Selection indicates which set of renditions are recorded for a stream.", + "enum": [ + "ALL", + "NONE", + "CUSTOM" + ], + "type": "string" + }, + "Renditions": { + "description": "Renditions indicates which renditions are recorded for a stream.", + "insertionOrder": false, + "items": { + "enum": [ + "FULL_HD", + "HD", + "SD", + "LOWEST_RESOLUTION" + ], + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [], + "type": "object" + }, + "S3DestinationConfiguration": { + "additionalProperties": false, + "description": "Recording S3 Destination Configuration.", + "properties": { + "BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9-.]+$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ThumbnailConfiguration": { + "additionalProperties": false, + "description": "Recording Thumbnail Configuration.", + "properties": { + "RecordingMode": { + "default": "INTERVAL", + "description": "Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.", + "enum": [ + "INTERVAL", + "DISABLED" + ], + "type": "string" + }, + "Resolution": { + "description": "Resolution indicates the desired resolution of recorded thumbnails.", + "enum": [ + "FULL_HD", + "HD", + "SD", + "LOWEST_RESOLUTION" + ], + "type": "string" + }, + "Storage": { + "description": "Storage indicates the format in which thumbnails are recorded.", + "insertionOrder": false, + "items": { + "enum": [ + "SEQUENTIAL", + "LATEST" + ], + "type": "string" + }, + "maxItems": 2, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "TargetIntervalSeconds": { + "default": 60, + "description": "Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.", + "maximum": 60, + "minimum": 1, + "type": "integer" + } + }, + "required": [], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::RecordingConfiguration", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateRecordingConfiguration", + "ivs:GetRecordingConfiguration", + "ivs:TagResource", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:AttachRolePolicy", + "s3:ListBucket", + "s3:GetBucketLocation", + "cloudformation:ListExports" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteRecordingConfiguration", + "ivs:UntagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "list": { + "permissions": [ + "ivs:ListRecordingConfigurations", + "s3:GetBucketLocation", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetRecordingConfiguration", + "s3:GetBucketLocation", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetRecordingConfiguration", + "sts:AssumeRole", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:AttachRolePolicy", + "s3:ListBucket", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "DestinationConfiguration": { + "$ref": "#/definitions/DestinationConfiguration" + }, + "Name": { + "description": "Recording Configuration Name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "RecordingReconnectWindowSeconds": { + "default": 0, + "description": "Recording Reconnect Window Seconds. (0 means disabled)", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "RenditionConfiguration": { + "$ref": "#/definitions/RenditionConfiguration" + }, + "State": { + "description": "Recording Configuration State.", + "enum": [ + "CREATING", + "CREATE_FAILED", + "ACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "ThumbnailConfiguration": { + "$ref": "#/definitions/ThumbnailConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/State" + ], + "required": [ + "DestinationConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::RecordingConfiguration" +} diff --git a/schema/aws-ivs-stage.json b/schema/aws-ivs-stage.json index 22aac3b..535cb6d 100644 --- a/schema/aws-ivs-stage.json +++ b/schema/aws-ivs-stage.json @@ -1,111 +1,154 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Definition for type AWS::IVS::Stage.", - "handlers": { - "create": { - "permissions": [ - "ivs:CreateStage", - "ivs:GetStage", - "ivs:TagResource", - "ivs:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteStage", - "ivs:UnTagResource" - ] - }, - "list": { - "permissions": [ - "ivs:ListStages", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetStage", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetStage", - "ivs:UpdateStage", - "ivs:TagResource", - "ivs:UnTagResource", - "ivs:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "ActiveSessionId": { - "default": "", - "description": "ID of the active session within the stage.", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "Arn": { - "description": "Stage ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 0, - "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "Stage name", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ActiveSessionId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::Stage" -} +{ + "additionalProperties": false, + "definitions": { + "AutoParticipantRecordingConfiguration": { + "additionalProperties": false, + "description": "Configuration object for individual participant recording, to attach to the new stage.", + "properties": { + "MediaTypes": { + "default": [ + "AUDIO_VIDEO" + ], + "description": "Types of media to be recorded. Default: AUDIO_VIDEO.", + "insertionOrder": false, + "items": { + "enum": [ + "AUDIO_VIDEO", + "AUDIO_ONLY" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "StorageConfigurationArn": { + "description": "ARN of the StorageConfiguration resource to use for individual participant recording.", + "maxLength": 128, + "minLength": 0, + "pattern": "^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$", + "type": "string" + } + }, + "required": [ + "StorageConfigurationArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Definition for type AWS::IVS::Stage.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateStage", + "ivs:GetStage", + "ivs:TagResource", + "ivs:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteStage", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListStages", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetStage", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetStage", + "ivs:UpdateStage", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "ActiveSessionId": { + "default": "", + "description": "ID of the active session within the stage.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Arn": { + "description": "Stage ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$", + "type": "string" + }, + "AutoParticipantRecordingConfiguration": { + "$ref": "#/definitions/AutoParticipantRecordingConfiguration" + }, + "Name": { + "description": "Stage name", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ActiveSessionId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::Stage" +} diff --git a/schema/aws-ivs-storageconfiguration.json b/schema/aws-ivs-storageconfiguration.json index 179accb..16ecc7a 100644 --- a/schema/aws-ivs-storageconfiguration.json +++ b/schema/aws-ivs-storageconfiguration.json @@ -1,138 +1,143 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/S3", - "/properties/S3/BucketName" - ], - "definitions": { - "S3StorageConfiguration": { - "additionalProperties": false, - "description": "A complex type that describes an S3 location where recorded videos will be stored.", - "properties": { - "BucketName": { - "description": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9-.]+$", - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::StorageConfiguration", - "handlers": { - "create": { - "permissions": [ - "ivs:CreateStorageConfiguration", - "ivs:GetStorageConfiguration", - "ivs:TagResource", - "s3:GetBucketLocation", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteStorageConfiguration", - "ivs:UntagResource", - "s3:GetBucketPolicy", - "s3:DeleteBucketPolicy", - "s3:PutBucketPolicy" - ] - }, - "list": { - "permissions": [ - "ivs:ListStorageConfigurations", - "s3:GetBucketLocation", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetStorageConfiguration", - "ivs:ListTagsForResource", - "s3:GetBucketLocation" - ] - }, - "update": { - "permissions": [ - "ivs:GetStorageConfiguration", - "ivs:TagResource", - "ivs:UntagResource", - "ivs:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 0, - "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "Storage Configuration Name.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "S3": { - "$ref": "#/definitions/S3StorageConfiguration" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "S3" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::StorageConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/S3", + "/properties/S3/BucketName" + ], + "definitions": { + "S3StorageConfiguration": { + "additionalProperties": false, + "description": "A complex type that describes an S3 location where recorded videos will be stored.", + "properties": { + "BucketName": { + "description": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9-.]+$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::StorageConfiguration", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateStorageConfiguration", + "ivs:GetStorageConfiguration", + "ivs:TagResource", + "s3:GetBucketLocation", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteStorageConfiguration", + "ivs:UntagResource", + "s3:GetBucketPolicy", + "s3:DeleteBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "list": { + "permissions": [ + "ivs:ListStorageConfigurations", + "s3:GetBucketLocation", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetStorageConfiguration", + "ivs:ListTagsForResource", + "s3:GetBucketLocation" + ] + }, + "update": { + "permissions": [ + "ivs:GetStorageConfiguration", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "Storage Configuration Name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "S3": { + "$ref": "#/definitions/S3StorageConfiguration" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "S3" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::StorageConfiguration" +} diff --git a/schema/aws-ivs-streamkey.json b/schema/aws-ivs-streamkey.json index cf0a4ef..d84213f 100644 --- a/schema/aws-ivs-streamkey.json +++ b/schema/aws-ivs-streamkey.json @@ -1,122 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::IVS::StreamKey", - "handlers": { - "create": { - "permissions": [ - "ivs:TagResource", - "ivs:UntagResource", - "ivs:CreateStreamKey" - ] - }, - "delete": { - "permissions": [ - "ivs:DeleteStreamKey", - "ivs:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ChannelArn": { - "$ref": "resource-schema.json#/properties/ChannelArn" - } - }, - "required": [ - "ChannelArn" - ] - }, - "permissions": [ - "ivs:ListStreamKeys", - "ivs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivs:GetStreamKey", - "ivs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivs:GetStreamKey", - "ivs:TagResource", - "ivs:UntagResource", - "ivs:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Stream Key ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$", - "type": "string" - }, - "ChannelArn": { - "description": "Channel ARN for the stream.", - "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "description": "A list of key-value pairs that contain metadata for the asset model.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Value": { - "description": "Stream-key value.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Value" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "ChannelArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVS::StreamKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::StreamKey", + "handlers": { + "create": { + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:CreateStreamKey" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteStreamKey", + "ivs:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ChannelArn": { + "$ref": "resource-schema.json#/properties/ChannelArn" + } + }, + "required": [ + "ChannelArn" + ] + }, + "permissions": [ + "ivs:ListStreamKeys", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetStreamKey", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetStreamKey", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Stream Key ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$", + "type": "string" + }, + "ChannelArn": { + "description": "Channel ARN for the stream.", + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Value": { + "description": "Stream-key value.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Value" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "ChannelArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::StreamKey" +} diff --git a/schema/aws-ivschat-loggingconfiguration.json b/schema/aws-ivschat-loggingconfiguration.json index 48d2a35..13ea952 100644 --- a/schema/aws-ivschat-loggingconfiguration.json +++ b/schema/aws-ivschat-loggingconfiguration.json @@ -1,225 +1,225 @@ -{ - "additionalProperties": false, - "definitions": { - "CloudWatchLogsDestinationConfiguration": { - "additionalProperties": false, - "description": "CloudWatch destination configuration for IVS Chat logging.", - "properties": { - "LogGroupName": { - "description": "Name of the Amazon CloudWatch Logs log group where chat activity will be logged.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", - "type": "string" - } - }, - "required": [ - "LogGroupName" - ], - "type": "object" - }, - "DestinationConfiguration": { - "additionalProperties": false, - "description": "Destination configuration for IVS Chat logging.", - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/CloudWatchLogsDestinationConfiguration" - }, - "Firehose": { - "$ref": "#/definitions/FirehoseDestinationConfiguration" - }, - "S3": { - "$ref": "#/definitions/S3DestinationConfiguration" - } - }, - "required": [], - "type": "object" - }, - "FirehoseDestinationConfiguration": { - "additionalProperties": false, - "description": "Kinesis Firehose destination configuration for IVS Chat logging.", - "properties": { - "DeliveryStreamName": { - "description": "Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - } - }, - "required": [ - "DeliveryStreamName" - ], - "type": "object" - }, - "S3DestinationConfiguration": { - "additionalProperties": false, - "description": "S3 destination configuration for IVS Chat logging.", - "properties": { - "BucketName": { - "description": "Name of the Amazon S3 bucket where chat activity will be logged.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9-.]+$", - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::IVSChat::LoggingConfiguration.", - "handlers": { - "create": { - "permissions": [ - "ivschat:CreateLoggingConfiguration", - "ivschat:GetLoggingConfiguration", - "logs:CreateLogDelivery", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "iam:CreateServiceLinkedRole", - "firehose:TagDeliveryStream", - "ivschat:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivschat:DeleteLoggingConfiguration", - "ivschat:GetLoggingConfiguration", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "ivschat:UntagResource", - "logs:GetLogDelivery" - ] - }, - "list": { - "permissions": [ - "ivschat:ListLoggingConfigurations", - "ivschat:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivschat:GetLoggingConfiguration", - "ivschat:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivschat:UpdateLoggingConfiguration", - "ivschat:GetLoggingConfiguration", - "ivschat:TagResource", - "ivschat:UntagResource", - "ivschat:ListTagsForResource", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "iam:CreateServiceLinkedRole", - "firehose:TagDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "DestinationConfiguration": { - "$ref": "#/definitions/DestinationConfiguration" - }, - "Id": { - "description": "The system-generated ID of the logging configuration.", - "maxLength": 12, - "minLength": 12, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Name": { - "description": "The name of the logging configuration. The value does not need to be unique.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "State": { - "description": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.", - "enum": [ - "CREATING", - "CREATE_FAILED", - "DELETING", - "DELETE_FAILED", - "UPDATING", - "UPDATING_FAILED", - "ACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/State" - ], - "required": [ - "DestinationConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ivschat.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVSChat::LoggingConfiguration" -} +{ + "additionalProperties": false, + "definitions": { + "CloudWatchLogsDestinationConfiguration": { + "additionalProperties": false, + "description": "CloudWatch destination configuration for IVS Chat logging.", + "properties": { + "LogGroupName": { + "description": "Name of the Amazon CloudWatch Logs log group where chat activity will be logged.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + } + }, + "required": [ + "LogGroupName" + ], + "type": "object" + }, + "DestinationConfiguration": { + "additionalProperties": false, + "description": "Destination configuration for IVS Chat logging.", + "properties": { + "CloudWatchLogs": { + "$ref": "#/definitions/CloudWatchLogsDestinationConfiguration" + }, + "Firehose": { + "$ref": "#/definitions/FirehoseDestinationConfiguration" + }, + "S3": { + "$ref": "#/definitions/S3DestinationConfiguration" + } + }, + "required": [], + "type": "object" + }, + "FirehoseDestinationConfiguration": { + "additionalProperties": false, + "description": "Kinesis Firehose destination configuration for IVS Chat logging.", + "properties": { + "DeliveryStreamName": { + "description": "Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + } + }, + "required": [ + "DeliveryStreamName" + ], + "type": "object" + }, + "S3DestinationConfiguration": { + "additionalProperties": false, + "description": "S3 destination configuration for IVS Chat logging.", + "properties": { + "BucketName": { + "description": "Name of the Amazon S3 bucket where chat activity will be logged.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9-.]+$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::IVSChat::LoggingConfiguration.", + "handlers": { + "create": { + "permissions": [ + "ivschat:CreateLoggingConfiguration", + "ivschat:GetLoggingConfiguration", + "logs:CreateLogDelivery", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream", + "ivschat:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivschat:DeleteLoggingConfiguration", + "ivschat:GetLoggingConfiguration", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "ivschat:UntagResource", + "logs:GetLogDelivery" + ] + }, + "list": { + "permissions": [ + "ivschat:ListLoggingConfigurations", + "ivschat:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivschat:GetLoggingConfiguration", + "ivschat:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivschat:UpdateLoggingConfiguration", + "ivschat:GetLoggingConfiguration", + "ivschat:TagResource", + "ivschat:UntagResource", + "ivschat:ListTagsForResource", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "DestinationConfiguration": { + "$ref": "#/definitions/DestinationConfiguration" + }, + "Id": { + "description": "The system-generated ID of the logging configuration.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Name": { + "description": "The name of the logging configuration. The value does not need to be unique.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "State": { + "description": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.", + "enum": [ + "CREATING", + "CREATE_FAILED", + "DELETING", + "DELETE_FAILED", + "UPDATING", + "UPDATING_FAILED", + "ACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/State" + ], + "required": [ + "DestinationConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ivschat.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVSChat::LoggingConfiguration" +} diff --git a/schema/aws-ivschat-room.json b/schema/aws-ivschat-room.json index 8501e15..5a31f9b 100644 --- a/schema/aws-ivschat-room.json +++ b/schema/aws-ivschat-room.json @@ -1,167 +1,172 @@ -{ - "additionalProperties": false, - "definitions": { - "MessageReviewHandler": { - "additionalProperties": false, - "description": "Configuration information for optional review of messages.", - "properties": { - "FallbackResult": { - "default": "ALLOW", - "description": "Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.", - "enum": [ - "ALLOW", - "DENY" - ], - "type": "string" - }, - "Uri": { - "description": "Identifier of the message review handler.", - "maxLength": 170, - "minLength": 0, - "pattern": "^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+", - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::IVSChat::Room.", - "handlers": { - "create": { - "permissions": [ - "ivschat:CreateRoom", - "ivschat:TagResource" - ] - }, - "delete": { - "permissions": [ - "ivschat:DeleteRoom", - "ivschat:UntagResource" - ] - }, - "list": { - "permissions": [ - "ivschat:ListRooms", - "ivschat:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ivschat:GetRoom", - "ivschat:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ivschat:UpdateRoom", - "ivschat:TagResource", - "ivschat:UntagResource", - "ivschat:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "Room ARN is automatically generated on creation and assigned as the unique identifier.", - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Id": { - "description": "The system-generated ID of the room.", - "maxLength": 12, - "minLength": 12, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "LoggingConfigurationIdentifiers": { - "description": "Array of logging configuration identifiers attached to the room.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "MaximumMessageLength": { - "default": 500, - "description": "The maximum number of characters in a single message.", - "maximum": 500, - "minimum": 1, - "type": "integer" - }, - "MaximumMessageRatePerSecond": { - "default": 10, - "description": "The maximum number of messages per second that can be sent to the room.", - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "MessageReviewHandler": { - "$ref": "#/definitions/MessageReviewHandler" - }, - "Name": { - "description": "The name of the room. The value does not need to be unique.", - "maxLength": 128, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ivschat.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::IVSChat::Room" -} +{ + "additionalProperties": false, + "definitions": { + "MessageReviewHandler": { + "additionalProperties": false, + "description": "Configuration information for optional review of messages.", + "properties": { + "FallbackResult": { + "default": "ALLOW", + "description": "Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.", + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "Uri": { + "description": "Identifier of the message review handler.", + "maxLength": 170, + "minLength": 0, + "pattern": "^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::IVSChat::Room.", + "handlers": { + "create": { + "permissions": [ + "ivschat:CreateRoom", + "ivschat:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivschat:DeleteRoom", + "ivschat:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivschat:ListRooms", + "ivschat:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivschat:GetRoom", + "ivschat:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivschat:UpdateRoom", + "ivschat:TagResource", + "ivschat:UntagResource", + "ivschat:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Room ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Id": { + "description": "The system-generated ID of the room.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "LoggingConfigurationIdentifiers": { + "description": "Array of logging configuration identifiers attached to the room.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "MaximumMessageLength": { + "default": 500, + "description": "The maximum number of characters in a single message.", + "maximum": 500, + "minimum": 1, + "type": "integer" + }, + "MaximumMessageRatePerSecond": { + "default": 10, + "description": "The maximum number of messages per second that can be sent to the room.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "MessageReviewHandler": { + "$ref": "#/definitions/MessageReviewHandler" + }, + "Name": { + "description": "The name of the room. The value does not need to be unique.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ivschat.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ivschat:TagResource", + "ivschat:ListTagsForResource", + "ivschat:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVSChat::Room" +} diff --git a/schema/aws-kafkaconnect-connector.json b/schema/aws-kafkaconnect-connector.json index 141dc5b..435f87f 100644 --- a/schema/aws-kafkaconnect-connector.json +++ b/schema/aws-kafkaconnect-connector.json @@ -1,574 +1,574 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ConnectorName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorConfiguration", - "/properties/ConnectorDescription", - "/properties/ConnectorName", - "/properties/KafkaCluster", - "/properties/KafkaClusterClientAuthentication", - "/properties/KafkaClusterEncryptionInTransit", - "/properties/KafkaConnectVersion", - "/properties/LogDelivery", - "/properties/Plugins", - "/properties/ServiceExecutionRoleArn", - "/properties/WorkerConfiguration" - ], - "definitions": { - "ApacheKafkaCluster": { - "additionalProperties": false, - "description": "Details of how to connect to an Apache Kafka cluster.", - "properties": { - "BootstrapServers": { - "description": "The bootstrap servers string of the Apache Kafka cluster.", - "type": "string" - }, - "Vpc": { - "$ref": "#/definitions/Vpc" - } - }, - "required": [ - "BootstrapServers", - "Vpc" - ], - "type": "object" - }, - "AutoScaling": { - "additionalProperties": false, - "description": "Details about auto scaling of a connector.", - "properties": { - "MaxWorkerCount": { - "description": "The maximum number of workers for a connector.", - "type": "integer" - }, - "McuCount": { - "description": "Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.", - "enum": [ - 1, - 2, - 4, - 8 - ], - "type": "integer" - }, - "MinWorkerCount": { - "description": "The minimum number of workers for a connector.", - "type": "integer" - }, - "ScaleInPolicy": { - "$ref": "#/definitions/ScaleInPolicy" - }, - "ScaleOutPolicy": { - "$ref": "#/definitions/ScaleOutPolicy" - } - }, - "required": [ - "MaxWorkerCount", - "MinWorkerCount", - "ScaleInPolicy", - "ScaleOutPolicy", - "McuCount" - ], - "type": "object" - }, - "Capacity": { - "additionalProperties": false, - "description": "Information about the capacity allocated to the connector.", - "oneOf": [ - { - "required": [ - "AutoScaling" - ] - }, - { - "required": [ - "ProvisionedCapacity" - ] - } - ], - "properties": { - "AutoScaling": { - "$ref": "#/definitions/AutoScaling" - }, - "ProvisionedCapacity": { - "$ref": "#/definitions/ProvisionedCapacity" - } - }, - "type": "object" - }, - "CloudWatchLogsLogDelivery": { - "additionalProperties": false, - "description": "Details about delivering logs to Amazon CloudWatch Logs.", - "properties": { - "Enabled": { - "description": "Specifies whether the logs get sent to the specified CloudWatch Logs destination.", - "type": "boolean" - }, - "LogGroup": { - "description": "The CloudWatch log group that is the destination for log delivery.", - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "CustomPlugin": { - "additionalProperties": false, - "description": "Details about a custom plugin.", - "properties": { - "CustomPluginArn": { - "description": "The Amazon Resource Name (ARN) of the custom plugin to use.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", - "type": "string" - }, - "Revision": { - "description": "The revision of the custom plugin to use.", - "format": "int64", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "CustomPluginArn", - "Revision" - ], - "type": "object" - }, - "FirehoseLogDelivery": { - "additionalProperties": false, - "description": "Details about delivering logs to Amazon Kinesis Data Firehose.", - "properties": { - "DeliveryStream": { - "description": "The Kinesis Data Firehose delivery stream that is the destination for log delivery.", - "type": "string" - }, - "Enabled": { - "description": "Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "KafkaCluster": { - "additionalProperties": false, - "description": "Details of how to connect to the Kafka cluster.", - "properties": { - "ApacheKafkaCluster": { - "$ref": "#/definitions/ApacheKafkaCluster" - } - }, - "required": [ - "ApacheKafkaCluster" - ], - "type": "object" - }, - "KafkaClusterClientAuthentication": { - "additionalProperties": false, - "description": "Details of the client authentication used by the Kafka cluster.", - "properties": { - "AuthenticationType": { - "$ref": "#/definitions/KafkaClusterClientAuthenticationType" - } - }, - "required": [ - "AuthenticationType" - ], - "type": "object" - }, - "KafkaClusterClientAuthenticationType": { - "description": "The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.", - "enum": [ - "NONE", - "IAM" - ], - "type": "string" - }, - "KafkaClusterEncryptionInTransit": { - "additionalProperties": false, - "description": "Details of encryption in transit to the Kafka cluster.", - "properties": { - "EncryptionType": { - "$ref": "#/definitions/KafkaClusterEncryptionInTransitType" - } - }, - "required": [ - "EncryptionType" - ], - "type": "object" - }, - "KafkaClusterEncryptionInTransitType": { - "description": "The type of encryption in transit to the Kafka cluster.", - "enum": [ - "PLAINTEXT", - "TLS" - ], - "type": "string" - }, - "LogDelivery": { - "additionalProperties": false, - "description": "Details of what logs are delivered and where they are delivered.", - "properties": { - "WorkerLogDelivery": { - "$ref": "#/definitions/WorkerLogDelivery" - } - }, - "required": [ - "WorkerLogDelivery" - ], - "type": "object" - }, - "Plugin": { - "additionalProperties": false, - "description": "Details about a Kafka Connect plugin which will be used with the connector.", - "properties": { - "CustomPlugin": { - "$ref": "#/definitions/CustomPlugin" - } - }, - "required": [ - "CustomPlugin" - ], - "type": "object" - }, - "ProvisionedCapacity": { - "additionalProperties": false, - "description": "Details about a fixed capacity allocated to a connector.", - "properties": { - "McuCount": { - "description": "Specifies how many MSK Connect Units (MCU) are allocated to the connector.", - "enum": [ - 1, - 2, - 4, - 8 - ], - "type": "integer" - }, - "WorkerCount": { - "description": "Number of workers for a connector.", - "type": "integer" - } - }, - "required": [ - "WorkerCount" - ], - "type": "object" - }, - "S3LogDelivery": { - "additionalProperties": false, - "description": "Details about delivering logs to Amazon S3.", - "properties": { - "Bucket": { - "description": "The name of the S3 bucket that is the destination for log delivery.", - "type": "string" - }, - "Enabled": { - "description": "Specifies whether the logs get sent to the specified Amazon S3 destination.", - "type": "boolean" - }, - "Prefix": { - "description": "The S3 prefix that is the destination for log delivery.", - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ScaleInPolicy": { - "additionalProperties": false, - "description": "Information about the scale in policy of the connector.", - "properties": { - "CpuUtilizationPercentage": { - "description": "Specifies the CPU utilization percentage threshold at which connector scale in should trigger.", - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "CpuUtilizationPercentage" - ], - "type": "object" - }, - "ScaleOutPolicy": { - "additionalProperties": false, - "description": "Information about the scale out policy of the connector.", - "properties": { - "CpuUtilizationPercentage": { - "description": "Specifies the CPU utilization percentage threshold at which connector scale out should trigger.", - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "CpuUtilizationPercentage" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Vpc": { - "additionalProperties": false, - "description": "Information about a VPC used with the connector.", - "properties": { - "SecurityGroups": { - "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Subnets": { - "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SecurityGroups", - "Subnets" - ], - "type": "object" - }, - "WorkerConfiguration": { - "additionalProperties": false, - "description": "Specifies the worker configuration to use with the connector.", - "properties": { - "Revision": { - "description": "The revision of the worker configuration to use.", - "format": "int64", - "minimum": 1, - "type": "integer" - }, - "WorkerConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the worker configuration to use.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", - "type": "string" - } - }, - "required": [ - "Revision", - "WorkerConfigurationArn" - ], - "type": "object" - }, - "WorkerLogDelivery": { - "additionalProperties": false, - "description": "Specifies where worker logs are delivered.", - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/CloudWatchLogsLogDelivery" - }, - "Firehose": { - "$ref": "#/definitions/FirehoseLogDelivery" - }, - "S3": { - "$ref": "#/definitions/S3LogDelivery" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KafkaConnect::Connector", - "handlers": { - "create": { - "permissions": [ - "kafkaconnect:CreateConnector", - "kafkaconnect:DescribeConnector", - "kafkaconnect:TagResource", - "kafkaconnect:ListTagsForResource", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "ec2:CreateNetworkInterface", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "firehose:TagDeliveryStream" - ] - }, - "delete": { - "permissions": [ - "kafkaconnect:DeleteConnector", - "kafkaconnect:DescribeConnector", - "logs:DeleteLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "list": { - "permissions": [ - "kafkaconnect:ListConnectors" - ] - }, - "read": { - "permissions": [ - "kafkaconnect:DescribeConnector", - "kafkaconnect:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kafkaconnect:UpdateConnector", - "kafkaconnect:DescribeConnector", - "kafkaconnect:TagResource", - "kafkaconnect:ListTagsForResource", - "kafkaconnect:UntagResource", - "iam:CreateServiceLinkedRole", - "logs:UpdateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "firehose:TagDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorArn" - ], - "properties": { - "Capacity": { - "$ref": "#/definitions/Capacity" - }, - "ConnectorArn": { - "description": "Amazon Resource Name for the created Connector.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", - "type": "string" - }, - "ConnectorConfiguration": { - "additionalProperties": false, - "description": "The configuration for the connector.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "ConnectorDescription": { - "description": "A summary description of the connector.", - "maxLength": 1024, - "type": "string" - }, - "ConnectorName": { - "description": "The name of the connector.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "KafkaCluster": { - "$ref": "#/definitions/KafkaCluster" - }, - "KafkaClusterClientAuthentication": { - "$ref": "#/definitions/KafkaClusterClientAuthentication" - }, - "KafkaClusterEncryptionInTransit": { - "$ref": "#/definitions/KafkaClusterEncryptionInTransit" - }, - "KafkaConnectVersion": { - "description": "The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.", - "type": "string" - }, - "LogDelivery": { - "$ref": "#/definitions/LogDelivery" - }, - "Plugins": { - "description": "List of plugins to use with the connector.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Plugin" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ServiceExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):iam:.*", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "WorkerConfiguration": { - "$ref": "#/definitions/WorkerConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/ConnectorArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Capacity", - "ConnectorConfiguration", - "ConnectorName", - "KafkaConnectVersion", - "KafkaCluster", - "KafkaClusterClientAuthentication", - "KafkaClusterEncryptionInTransit", - "Plugins", - "ServiceExecutionRoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KafkaConnect::Connector" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ConnectorName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorConfiguration", + "/properties/ConnectorDescription", + "/properties/ConnectorName", + "/properties/KafkaCluster", + "/properties/KafkaClusterClientAuthentication", + "/properties/KafkaClusterEncryptionInTransit", + "/properties/KafkaConnectVersion", + "/properties/LogDelivery", + "/properties/Plugins", + "/properties/ServiceExecutionRoleArn", + "/properties/WorkerConfiguration" + ], + "definitions": { + "ApacheKafkaCluster": { + "additionalProperties": false, + "description": "Details of how to connect to an Apache Kafka cluster.", + "properties": { + "BootstrapServers": { + "description": "The bootstrap servers string of the Apache Kafka cluster.", + "type": "string" + }, + "Vpc": { + "$ref": "#/definitions/Vpc" + } + }, + "required": [ + "BootstrapServers", + "Vpc" + ], + "type": "object" + }, + "AutoScaling": { + "additionalProperties": false, + "description": "Details about auto scaling of a connector.", + "properties": { + "MaxWorkerCount": { + "description": "The maximum number of workers for a connector.", + "type": "integer" + }, + "McuCount": { + "description": "Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.", + "enum": [ + 1, + 2, + 4, + 8 + ], + "type": "integer" + }, + "MinWorkerCount": { + "description": "The minimum number of workers for a connector.", + "type": "integer" + }, + "ScaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy" + }, + "ScaleOutPolicy": { + "$ref": "#/definitions/ScaleOutPolicy" + } + }, + "required": [ + "MaxWorkerCount", + "MinWorkerCount", + "ScaleInPolicy", + "ScaleOutPolicy", + "McuCount" + ], + "type": "object" + }, + "Capacity": { + "additionalProperties": false, + "description": "Information about the capacity allocated to the connector.", + "oneOf": [ + { + "required": [ + "AutoScaling" + ] + }, + { + "required": [ + "ProvisionedCapacity" + ] + } + ], + "properties": { + "AutoScaling": { + "$ref": "#/definitions/AutoScaling" + }, + "ProvisionedCapacity": { + "$ref": "#/definitions/ProvisionedCapacity" + } + }, + "type": "object" + }, + "CloudWatchLogsLogDelivery": { + "additionalProperties": false, + "description": "Details about delivering logs to Amazon CloudWatch Logs.", + "properties": { + "Enabled": { + "description": "Specifies whether the logs get sent to the specified CloudWatch Logs destination.", + "type": "boolean" + }, + "LogGroup": { + "description": "The CloudWatch log group that is the destination for log delivery.", + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "CustomPlugin": { + "additionalProperties": false, + "description": "Details about a custom plugin.", + "properties": { + "CustomPluginArn": { + "description": "The Amazon Resource Name (ARN) of the custom plugin to use.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + }, + "Revision": { + "description": "The revision of the custom plugin to use.", + "format": "int64", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "CustomPluginArn", + "Revision" + ], + "type": "object" + }, + "FirehoseLogDelivery": { + "additionalProperties": false, + "description": "Details about delivering logs to Amazon Kinesis Data Firehose.", + "properties": { + "DeliveryStream": { + "description": "The Kinesis Data Firehose delivery stream that is the destination for log delivery.", + "type": "string" + }, + "Enabled": { + "description": "Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "KafkaCluster": { + "additionalProperties": false, + "description": "Details of how to connect to the Kafka cluster.", + "properties": { + "ApacheKafkaCluster": { + "$ref": "#/definitions/ApacheKafkaCluster" + } + }, + "required": [ + "ApacheKafkaCluster" + ], + "type": "object" + }, + "KafkaClusterClientAuthentication": { + "additionalProperties": false, + "description": "Details of the client authentication used by the Kafka cluster.", + "properties": { + "AuthenticationType": { + "$ref": "#/definitions/KafkaClusterClientAuthenticationType" + } + }, + "required": [ + "AuthenticationType" + ], + "type": "object" + }, + "KafkaClusterClientAuthenticationType": { + "description": "The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.", + "enum": [ + "NONE", + "IAM" + ], + "type": "string" + }, + "KafkaClusterEncryptionInTransit": { + "additionalProperties": false, + "description": "Details of encryption in transit to the Kafka cluster.", + "properties": { + "EncryptionType": { + "$ref": "#/definitions/KafkaClusterEncryptionInTransitType" + } + }, + "required": [ + "EncryptionType" + ], + "type": "object" + }, + "KafkaClusterEncryptionInTransitType": { + "description": "The type of encryption in transit to the Kafka cluster.", + "enum": [ + "PLAINTEXT", + "TLS" + ], + "type": "string" + }, + "LogDelivery": { + "additionalProperties": false, + "description": "Details of what logs are delivered and where they are delivered.", + "properties": { + "WorkerLogDelivery": { + "$ref": "#/definitions/WorkerLogDelivery" + } + }, + "required": [ + "WorkerLogDelivery" + ], + "type": "object" + }, + "Plugin": { + "additionalProperties": false, + "description": "Details about a Kafka Connect plugin which will be used with the connector.", + "properties": { + "CustomPlugin": { + "$ref": "#/definitions/CustomPlugin" + } + }, + "required": [ + "CustomPlugin" + ], + "type": "object" + }, + "ProvisionedCapacity": { + "additionalProperties": false, + "description": "Details about a fixed capacity allocated to a connector.", + "properties": { + "McuCount": { + "description": "Specifies how many MSK Connect Units (MCU) are allocated to the connector.", + "enum": [ + 1, + 2, + 4, + 8 + ], + "type": "integer" + }, + "WorkerCount": { + "description": "Number of workers for a connector.", + "type": "integer" + } + }, + "required": [ + "WorkerCount" + ], + "type": "object" + }, + "S3LogDelivery": { + "additionalProperties": false, + "description": "Details about delivering logs to Amazon S3.", + "properties": { + "Bucket": { + "description": "The name of the S3 bucket that is the destination for log delivery.", + "type": "string" + }, + "Enabled": { + "description": "Specifies whether the logs get sent to the specified Amazon S3 destination.", + "type": "boolean" + }, + "Prefix": { + "description": "The S3 prefix that is the destination for log delivery.", + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ScaleInPolicy": { + "additionalProperties": false, + "description": "Information about the scale in policy of the connector.", + "properties": { + "CpuUtilizationPercentage": { + "description": "Specifies the CPU utilization percentage threshold at which connector scale in should trigger.", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "CpuUtilizationPercentage" + ], + "type": "object" + }, + "ScaleOutPolicy": { + "additionalProperties": false, + "description": "Information about the scale out policy of the connector.", + "properties": { + "CpuUtilizationPercentage": { + "description": "Specifies the CPU utilization percentage threshold at which connector scale out should trigger.", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "CpuUtilizationPercentage" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Vpc": { + "additionalProperties": false, + "description": "Information about a VPC used with the connector.", + "properties": { + "SecurityGroups": { + "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Subnets": { + "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SecurityGroups", + "Subnets" + ], + "type": "object" + }, + "WorkerConfiguration": { + "additionalProperties": false, + "description": "Specifies the worker configuration to use with the connector.", + "properties": { + "Revision": { + "description": "The revision of the worker configuration to use.", + "format": "int64", + "minimum": 1, + "type": "integer" + }, + "WorkerConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the worker configuration to use.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + } + }, + "required": [ + "Revision", + "WorkerConfigurationArn" + ], + "type": "object" + }, + "WorkerLogDelivery": { + "additionalProperties": false, + "description": "Specifies where worker logs are delivered.", + "properties": { + "CloudWatchLogs": { + "$ref": "#/definitions/CloudWatchLogsLogDelivery" + }, + "Firehose": { + "$ref": "#/definitions/FirehoseLogDelivery" + }, + "S3": { + "$ref": "#/definitions/S3LogDelivery" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KafkaConnect::Connector", + "handlers": { + "create": { + "permissions": [ + "kafkaconnect:CreateConnector", + "kafkaconnect:DescribeConnector", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "ec2:CreateNetworkInterface", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "firehose:TagDeliveryStream" + ] + }, + "delete": { + "permissions": [ + "kafkaconnect:DeleteConnector", + "kafkaconnect:DescribeConnector", + "logs:DeleteLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries" + ] + }, + "list": { + "permissions": [ + "kafkaconnect:ListConnectors" + ] + }, + "read": { + "permissions": [ + "kafkaconnect:DescribeConnector", + "kafkaconnect:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafkaconnect:UpdateConnector", + "kafkaconnect:DescribeConnector", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:UntagResource", + "iam:CreateServiceLinkedRole", + "logs:UpdateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "firehose:TagDeliveryStream" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorArn" + ], + "properties": { + "Capacity": { + "$ref": "#/definitions/Capacity" + }, + "ConnectorArn": { + "description": "Amazon Resource Name for the created Connector.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + }, + "ConnectorConfiguration": { + "additionalProperties": false, + "description": "The configuration for the connector.", + "patternProperties": { + ".*": { + "type": "string" + } + }, + "type": "object" + }, + "ConnectorDescription": { + "description": "A summary description of the connector.", + "maxLength": 1024, + "type": "string" + }, + "ConnectorName": { + "description": "The name of the connector.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "KafkaCluster": { + "$ref": "#/definitions/KafkaCluster" + }, + "KafkaClusterClientAuthentication": { + "$ref": "#/definitions/KafkaClusterClientAuthentication" + }, + "KafkaClusterEncryptionInTransit": { + "$ref": "#/definitions/KafkaClusterEncryptionInTransit" + }, + "KafkaConnectVersion": { + "description": "The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.", + "type": "string" + }, + "LogDelivery": { + "$ref": "#/definitions/LogDelivery" + }, + "Plugins": { + "description": "List of plugins to use with the connector.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Plugin" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ServiceExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):iam:.*", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WorkerConfiguration": { + "$ref": "#/definitions/WorkerConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/ConnectorArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Capacity", + "ConnectorConfiguration", + "ConnectorName", + "KafkaConnectVersion", + "KafkaCluster", + "KafkaClusterClientAuthentication", + "KafkaClusterEncryptionInTransit", + "Plugins", + "ServiceExecutionRoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KafkaConnect::Connector" +} diff --git a/schema/aws-kafkaconnect-customplugin.json b/schema/aws-kafkaconnect-customplugin.json index fdeda7d..ea3ea1c 100644 --- a/schema/aws-kafkaconnect-customplugin.json +++ b/schema/aws-kafkaconnect-customplugin.json @@ -1,199 +1,199 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Description", - "/properties/ContentType", - "/properties/Location" - ], - "definitions": { - "CustomPluginFileDescription": { - "additionalProperties": false, - "description": "Details about the custom plugin file.", - "properties": { - "FileMd5": { - "description": "The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.", - "type": "string" - }, - "FileSize": { - "description": "The size in bytes of the custom plugin file. You can use it to validate the file.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "CustomPluginLocation": { - "additionalProperties": false, - "description": "Information about the location of a custom plugin.", - "properties": { - "S3Location": { - "$ref": "#/definitions/S3Location" - } - }, - "required": [ - "S3Location" - ], - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "description": "The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.", - "properties": { - "BucketArn": { - "description": "The Amazon Resource Name (ARN) of an S3 bucket.", - "type": "string" - }, - "FileKey": { - "description": "The file key for an object in an S3 bucket.", - "type": "string" - }, - "ObjectVersion": { - "description": "The version of an object in an S3 bucket.", - "type": "string" - } - }, - "required": [ - "BucketArn", - "FileKey" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "kafkaconnect:DescribeCustomPlugin", - "kafkaconnect:ListTagsForResource", - "kafkaconnect:CreateCustomPlugin", - "kafkaconnect:TagResource", - "s3:GetObject", - "s3:GetObjectVersion", - "s3:GetObjectAttributes", - "s3:GetObjectVersionAttributes" - ] - }, - "delete": { - "permissions": [ - "kafkaconnect:DeleteCustomPlugin", - "kafkaconnect:DescribeCustomPlugin" - ] - }, - "list": { - "permissions": [ - "kafkaconnect:ListCustomPlugins" - ] - }, - "read": { - "permissions": [ - "kafkaconnect:DescribeCustomPlugin", - "kafkaconnect:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kafkaconnect:DescribeCustomPlugin", - "kafkaconnect:ListTagsForResource", - "kafkaconnect:TagResource", - "kafkaconnect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CustomPluginArn" - ], - "properties": { - "ContentType": { - "description": "The type of the plugin file.", - "enum": [ - "JAR", - "ZIP" - ], - "type": "string" - }, - "CustomPluginArn": { - "description": "The Amazon Resource Name (ARN) of the custom plugin to use.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", - "type": "string" - }, - "Description": { - "description": "A summary description of the custom plugin.", - "maxLength": 1024, - "type": "string" - }, - "FileDescription": { - "$ref": "#/definitions/CustomPluginFileDescription" - }, - "Location": { - "$ref": "#/definitions/CustomPluginLocation" - }, - "Name": { - "description": "The name of the custom plugin.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Revision": { - "description": "The revision of the custom plugin.", - "format": "int64", - "type": "integer" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/CustomPluginArn", - "/properties/Revision", - "/properties/FileDescription" - ], - "required": [ - "Name", - "ContentType", - "Location" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KafkaConnect::CustomPlugin" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/ContentType", + "/properties/Location" + ], + "definitions": { + "CustomPluginFileDescription": { + "additionalProperties": false, + "description": "Details about the custom plugin file.", + "properties": { + "FileMd5": { + "description": "The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.", + "type": "string" + }, + "FileSize": { + "description": "The size in bytes of the custom plugin file. You can use it to validate the file.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CustomPluginLocation": { + "additionalProperties": false, + "description": "Information about the location of a custom plugin.", + "properties": { + "S3Location": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "S3Location" + ], + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.", + "properties": { + "BucketArn": { + "description": "The Amazon Resource Name (ARN) of an S3 bucket.", + "type": "string" + }, + "FileKey": { + "description": "The file key for an object in an S3 bucket.", + "type": "string" + }, + "ObjectVersion": { + "description": "The version of an object in an S3 bucket.", + "type": "string" + } + }, + "required": [ + "BucketArn", + "FileKey" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:CreateCustomPlugin", + "kafkaconnect:TagResource", + "s3:GetObject", + "s3:GetObjectVersion", + "s3:GetObjectAttributes", + "s3:GetObjectVersionAttributes" + ] + }, + "delete": { + "permissions": [ + "kafkaconnect:DeleteCustomPlugin", + "kafkaconnect:DescribeCustomPlugin" + ] + }, + "list": { + "permissions": [ + "kafkaconnect:ListCustomPlugins" + ] + }, + "read": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:TagResource", + "kafkaconnect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CustomPluginArn" + ], + "properties": { + "ContentType": { + "description": "The type of the plugin file.", + "enum": [ + "JAR", + "ZIP" + ], + "type": "string" + }, + "CustomPluginArn": { + "description": "The Amazon Resource Name (ARN) of the custom plugin to use.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + }, + "Description": { + "description": "A summary description of the custom plugin.", + "maxLength": 1024, + "type": "string" + }, + "FileDescription": { + "$ref": "#/definitions/CustomPluginFileDescription" + }, + "Location": { + "$ref": "#/definitions/CustomPluginLocation" + }, + "Name": { + "description": "The name of the custom plugin.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Revision": { + "description": "The revision of the custom plugin.", + "format": "int64", + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/CustomPluginArn", + "/properties/Revision", + "/properties/FileDescription" + ], + "required": [ + "Name", + "ContentType", + "Location" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KafkaConnect::CustomPlugin" +} diff --git a/schema/aws-kafkaconnect-workerconfiguration.json b/schema/aws-kafkaconnect-workerconfiguration.json index 142e4ca..5fded3a 100644 --- a/schema/aws-kafkaconnect-workerconfiguration.json +++ b/schema/aws-kafkaconnect-workerconfiguration.json @@ -1,126 +1,126 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Description", - "/properties/PropertiesFileContent" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The configuration of the workers, which are the processes that run the connector logic.", - "handlers": { - "create": { - "permissions": [ - "kafkaconnect:DescribeWorkerConfiguration", - "kafkaconnect:CreateWorkerConfiguration", - "kafkaconnect:TagResource", - "kafkaconnect:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "kafkaconnect:DescribeWorkerConfiguration", - "kafkaconnect:DeleteWorkerConfiguration" - ] - }, - "list": { - "permissions": [ - "kafkaconnect:ListWorkerConfigurations" - ] - }, - "read": { - "permissions": [ - "kafkaconnect:DescribeWorkerConfiguration", - "kafkaconnect:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kafkaconnect:DescribeWorkerConfiguration", - "kafkaconnect:ListTagsForResource", - "kafkaconnect:TagResource", - "kafkaconnect:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkerConfigurationArn" - ], - "properties": { - "Description": { - "description": "A summary description of the worker configuration.", - "maxLength": 1024, - "type": "string" - }, - "Name": { - "description": "The name of the worker configuration.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "PropertiesFileContent": { - "description": "Base64 encoded contents of connect-distributed.properties file.", - "type": "string" - }, - "Revision": { - "description": "The description of a revision of the worker configuration.", - "format": "int64", - "type": "integer" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "WorkerConfigurationArn": { - "description": "The Amazon Resource Name (ARN) of the custom configuration.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/WorkerConfigurationArn", - "/properties/Revision" - ], - "required": [ - "Name", - "PropertiesFileContent" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KafkaConnect::WorkerConfiguration" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/PropertiesFileContent" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The configuration of the workers, which are the processes that run the connector logic.", + "handlers": { + "create": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:CreateWorkerConfiguration", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:DeleteWorkerConfiguration" + ] + }, + "list": { + "permissions": [ + "kafkaconnect:ListWorkerConfigurations" + ] + }, + "read": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:TagResource", + "kafkaconnect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkerConfigurationArn" + ], + "properties": { + "Description": { + "description": "A summary description of the worker configuration.", + "maxLength": 1024, + "type": "string" + }, + "Name": { + "description": "The name of the worker configuration.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "PropertiesFileContent": { + "description": "Base64 encoded contents of connect-distributed.properties file.", + "type": "string" + }, + "Revision": { + "description": "The description of a revision of the worker configuration.", + "format": "int64", + "type": "integer" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WorkerConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the custom configuration.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/WorkerConfigurationArn", + "/properties/Revision" + ], + "required": [ + "Name", + "PropertiesFileContent" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KafkaConnect::WorkerConfiguration" +} diff --git a/schema/aws-kendra-datasource.json b/schema/aws-kendra-datasource.json index 726f749..5c32098 100644 --- a/schema/aws-kendra-datasource.json +++ b/schema/aws-kendra-datasource.json @@ -1,1783 +1,1783 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type" - ], - "definitions": { - "AccessControlListConfiguration": { - "additionalProperties": false, - "properties": { - "KeyPath": { - "$ref": "#/definitions/S3ObjectKey" - } - }, - "type": "object" - }, - "AclConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedGroupsColumnName": { - "$ref": "#/definitions/ColumnName" - } - }, - "required": [ - "AllowedGroupsColumnName" - ], - "type": "object" - }, - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "ChangeDetectingColumns": { - "items": { - "$ref": "#/definitions/ColumnName" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "ColumnConfiguration": { - "additionalProperties": false, - "properties": { - "ChangeDetectingColumns": { - "$ref": "#/definitions/ChangeDetectingColumns" - }, - "DocumentDataColumnName": { - "$ref": "#/definitions/ColumnName" - }, - "DocumentIdColumnName": { - "$ref": "#/definitions/ColumnName" - }, - "DocumentTitleColumnName": { - "$ref": "#/definitions/ColumnName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - } - }, - "required": [ - "DocumentIdColumnName", - "DocumentDataColumnName", - "ChangeDetectingColumns" - ], - "type": "object" - }, - "ColumnName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ConditionOperator": { - "enum": [ - "GreaterThan", - "GreaterThanOrEquals", - "LessThan", - "LessThanOrEquals", - "Equals", - "NotEquals", - "Contains", - "NotContains", - "Exists", - "NotExists", - "BeginsWith" - ], - "type": "string" - }, - "ConfluenceAttachmentConfiguration": { - "additionalProperties": false, - "properties": { - "AttachmentFieldMappings": { - "$ref": "#/definitions/ConfluenceAttachmentFieldMappingsList" - }, - "CrawlAttachments": { - "type": "boolean" - } - }, - "type": "object" - }, - "ConfluenceAttachmentFieldMappingsList": { - "items": { - "$ref": "#/definitions/ConfluenceAttachmentToIndexFieldMapping" - }, - "maxItems": 11, - "minItems": 1, - "type": "array" - }, - "ConfluenceAttachmentFieldName": { - "enum": [ - "AUTHOR", - "CONTENT_TYPE", - "CREATED_DATE", - "DISPLAY_URL", - "FILE_SIZE", - "ITEM_TYPE", - "PARENT_ID", - "SPACE_KEY", - "SPACE_NAME", - "URL", - "VERSION" - ], - "type": "string" - }, - "ConfluenceAttachmentToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "$ref": "#/definitions/ConfluenceAttachmentFieldName" - }, - "DateFieldFormat": { - "$ref": "#/definitions/DateFieldFormat" - }, - "IndexFieldName": { - "$ref": "#/definitions/IndexFieldName" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "ConfluenceBlogConfiguration": { - "additionalProperties": false, - "properties": { - "BlogFieldMappings": { - "$ref": "#/definitions/ConfluenceBlogFieldMappingsList" - } - }, - "type": "object" - }, - "ConfluenceBlogFieldMappingsList": { - "items": { - "$ref": "#/definitions/ConfluenceBlogToIndexFieldMapping" - }, - "maxItems": 9, - "minItems": 1, - "type": "array" - }, - "ConfluenceBlogFieldName": { - "enum": [ - "AUTHOR", - "DISPLAY_URL", - "ITEM_TYPE", - "LABELS", - "PUBLISH_DATE", - "SPACE_KEY", - "SPACE_NAME", - "URL", - "VERSION" - ], - "type": "string" - }, - "ConfluenceBlogToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "$ref": "#/definitions/ConfluenceBlogFieldName" - }, - "DateFieldFormat": { - "$ref": "#/definitions/DateFieldFormat" - }, - "IndexFieldName": { - "$ref": "#/definitions/IndexFieldName" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "ConfluenceConfiguration": { - "additionalProperties": false, - "properties": { - "AttachmentConfiguration": { - "$ref": "#/definitions/ConfluenceAttachmentConfiguration" - }, - "BlogConfiguration": { - "$ref": "#/definitions/ConfluenceBlogConfiguration" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "PageConfiguration": { - "$ref": "#/definitions/ConfluencePageConfiguration" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "ServerUrl": { - "$ref": "#/definitions/Url" - }, - "SpaceConfiguration": { - "$ref": "#/definitions/ConfluenceSpaceConfiguration" - }, - "Version": { - "$ref": "#/definitions/ConfluenceVersion" - }, - "VpcConfiguration": { - "$ref": "#/definitions/DataSourceVpcConfiguration" - } - }, - "required": [ - "ServerUrl", - "SecretArn", - "Version" - ], - "type": "object" - }, - "ConfluencePageConfiguration": { - "additionalProperties": false, - "properties": { - "PageFieldMappings": { - "$ref": "#/definitions/ConfluencePageFieldMappingsList" - } - }, - "type": "object" - }, - "ConfluencePageFieldMappingsList": { - "items": { - "$ref": "#/definitions/ConfluencePageToIndexFieldMapping" - }, - "maxItems": 12, - "minItems": 1, - "type": "array" - }, - "ConfluencePageFieldName": { - "enum": [ - "AUTHOR", - "CONTENT_STATUS", - "CREATED_DATE", - "DISPLAY_URL", - "ITEM_TYPE", - "LABELS", - "MODIFIED_DATE", - "PARENT_ID", - "SPACE_KEY", - "SPACE_NAME", - "URL", - "VERSION" - ], - "type": "string" - }, - "ConfluencePageToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "$ref": "#/definitions/ConfluencePageFieldName" - }, - "DateFieldFormat": { - "$ref": "#/definitions/DateFieldFormat" - }, - "IndexFieldName": { - "$ref": "#/definitions/IndexFieldName" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "ConfluenceSpaceConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlArchivedSpaces": { - "type": "boolean" - }, - "CrawlPersonalSpaces": { - "type": "boolean" - }, - "ExcludeSpaces": { - "$ref": "#/definitions/ConfluenceSpaceList" - }, - "IncludeSpaces": { - "$ref": "#/definitions/ConfluenceSpaceList" - }, - "SpaceFieldMappings": { - "$ref": "#/definitions/ConfluenceSpaceFieldMappingsList" - } - }, - "type": "object" - }, - "ConfluenceSpaceFieldMappingsList": { - "items": { - "$ref": "#/definitions/ConfluenceSpaceToIndexFieldMapping" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "ConfluenceSpaceFieldName": { - "enum": [ - "DISPLAY_URL", - "ITEM_TYPE", - "SPACE_KEY", - "URL" - ], - "type": "string" - }, - "ConfluenceSpaceIdentifier": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "ConfluenceSpaceList": { - "items": { - "$ref": "#/definitions/ConfluenceSpaceIdentifier" - }, - "minItems": 1, - "type": "array" - }, - "ConfluenceSpaceToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "$ref": "#/definitions/ConfluenceSpaceFieldName" - }, - "DateFieldFormat": { - "$ref": "#/definitions/DateFieldFormat" - }, - "IndexFieldName": { - "$ref": "#/definitions/IndexFieldName" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "ConfluenceVersion": { - "enum": [ - "CLOUD", - "SERVER" - ], - "type": "string" - }, - "ConnectionConfiguration": { - "additionalProperties": false, - "properties": { - "DatabaseHost": { - "$ref": "#/definitions/DatabaseHost" - }, - "DatabaseName": { - "$ref": "#/definitions/DatabaseName" - }, - "DatabasePort": { - "$ref": "#/definitions/DatabasePort" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "TableName": { - "$ref": "#/definitions/TableName" - } - }, - "required": [ - "DatabaseHost", - "DatabasePort", - "DatabaseName", - "TableName", - "SecretArn" - ], - "type": "object" - }, - "CustomDocumentEnrichmentConfiguration": { - "additionalProperties": false, - "properties": { - "InlineConfigurations": { - "$ref": "#/definitions/InlineConfigurations" - }, - "PostExtractionHookConfiguration": { - "$ref": "#/definitions/HookConfiguration" - }, - "PreExtractionHookConfiguration": { - "$ref": "#/definitions/HookConfiguration" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - } - }, - "type": "object" - }, - "DataSourceConfiguration": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "S3Configuration" - ] - }, - { - "required": [ - "SharePointConfiguration" - ] - }, - { - "required": [ - "SalesforceConfiguration" - ] - }, - { - "required": [ - "OneDriveConfiguration" - ] - }, - { - "required": [ - "ServiceNowConfiguration" - ] - }, - { - "required": [ - "DatabaseConfiguration" - ] - }, - { - "required": [ - "ConfluenceConfiguration" - ] - }, - { - "required": [ - "GoogleDriveConfiguration" - ] - }, - { - "required": [ - "WebCrawlerConfiguration" - ] - }, - { - "required": [ - "WorkDocsConfiguration" - ] - } - ], - "properties": { - "ConfluenceConfiguration": { - "$ref": "#/definitions/ConfluenceConfiguration" - }, - "DatabaseConfiguration": { - "$ref": "#/definitions/DatabaseConfiguration" - }, - "GoogleDriveConfiguration": { - "$ref": "#/definitions/GoogleDriveConfiguration" - }, - "OneDriveConfiguration": { - "$ref": "#/definitions/OneDriveConfiguration" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DataSourceConfiguration" - }, - "SalesforceConfiguration": { - "$ref": "#/definitions/SalesforceConfiguration" - }, - "ServiceNowConfiguration": { - "$ref": "#/definitions/ServiceNowConfiguration" - }, - "SharePointConfiguration": { - "$ref": "#/definitions/SharePointConfiguration" - }, - "WebCrawlerConfiguration": { - "$ref": "#/definitions/WebCrawlerConfiguration" - }, - "WorkDocsConfiguration": { - "$ref": "#/definitions/WorkDocsConfiguration" - } - }, - "type": "object" - }, - "DataSourceFieldName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "DataSourceInclusionsExclusionsStrings": { - "items": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "type": "array" - }, - "DataSourceToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DateFieldFormat": { - "$ref": "#/definitions/DateFieldFormat" - }, - "IndexFieldName": { - "$ref": "#/definitions/IndexFieldName" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "DataSourceToIndexFieldMappingList": { - "items": { - "$ref": "#/definitions/DataSourceToIndexFieldMapping" - }, - "maxItems": 100, - "type": "array" - }, - "DataSourceVpcConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "maxLength": 200, - "minLength": 1, - "pattern": "[\\-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 10, - "type": "array" - }, - "SubnetIds": { - "items": { - "maxLength": 200, - "minLength": 1, - "pattern": "[\\-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 6, - "type": "array" - } - }, - "required": [ - "SubnetIds", - "SecurityGroupIds" - ], - "type": "object" - }, - "DatabaseConfiguration": { - "additionalProperties": false, - "properties": { - "AclConfiguration": { - "$ref": "#/definitions/AclConfiguration" - }, - "ColumnConfiguration": { - "$ref": "#/definitions/ColumnConfiguration" - }, - "ConnectionConfiguration": { - "$ref": "#/definitions/ConnectionConfiguration" - }, - "DatabaseEngineType": { - "$ref": "#/definitions/DatabaseEngineType" - }, - "SqlConfiguration": { - "$ref": "#/definitions/SqlConfiguration" - }, - "VpcConfiguration": { - "$ref": "#/definitions/DataSourceVpcConfiguration" - } - }, - "required": [ - "ConnectionConfiguration", - "ColumnConfiguration", - "DatabaseEngineType" - ], - "type": "object" - }, - "DatabaseEngineType": { - "enum": [ - "RDS_AURORA_MYSQL", - "RDS_AURORA_POSTGRESQL", - "RDS_MYSQL", - "RDS_POSTGRESQL" - ], - "type": "string" - }, - "DatabaseHost": { - "maxLength": 253, - "minLength": 1, - "type": "string" - }, - "DatabaseName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "DatabasePort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "DateFieldFormat": { - "maxLength": 40, - "minLength": 4, - "type": "string" - }, - "Description": { - "description": "Description of data source", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "DisableLocalGroups": { - "type": "boolean" - }, - "DocumentAttributeCondition": { - "additionalProperties": false, - "properties": { - "ConditionDocumentAttributeKey": { - "$ref": "#/definitions/DocumentAttributeKey" - }, - "ConditionOnValue": { - "$ref": "#/definitions/DocumentAttributeValue" - }, - "Operator": { - "$ref": "#/definitions/ConditionOperator" - } - }, - "required": [ - "ConditionDocumentAttributeKey", - "Operator" - ], - "type": "object" - }, - "DocumentAttributeKey": { - "maxLength": 200, - "minLength": 1, - "pattern": "[a-zA-Z0-9_][a-zA-Z0-9_-]*", - "type": "string" - }, - "DocumentAttributeTarget": { - "additionalProperties": false, - "properties": { - "TargetDocumentAttributeKey": { - "$ref": "#/definitions/DocumentAttributeKey" - }, - "TargetDocumentAttributeValue": { - "$ref": "#/definitions/DocumentAttributeValue" - }, - "TargetDocumentAttributeValueDeletion": { - "type": "boolean" - } - }, - "required": [ - "TargetDocumentAttributeKey" - ], - "type": "object" - }, - "DocumentAttributeValue": { - "additionalProperties": false, - "properties": { - "DateValue": { - "$ref": "#/definitions/Timestamp" - }, - "LongValue": { - "$ref": "#/definitions/Long" - }, - "StringListValue": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StringValue": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DocumentsMetadataConfiguration": { - "additionalProperties": false, - "properties": { - "S3Prefix": { - "$ref": "#/definitions/S3ObjectKey" - } - }, - "type": "object" - }, - "ExcludeMimeTypesList": { - "items": { - "$ref": "#/definitions/MimeType" - }, - "maxItems": 30, - "minItems": 0, - "type": "array" - }, - "ExcludeSharedDrivesList": { - "items": { - "$ref": "#/definitions/SharedDriveId" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ExcludeUserAccountsList": { - "items": { - "$ref": "#/definitions/UserAccount" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "GoogleDriveConfiguration": { - "additionalProperties": false, - "properties": { - "ExcludeMimeTypes": { - "$ref": "#/definitions/ExcludeMimeTypesList" - }, - "ExcludeSharedDrives": { - "$ref": "#/definitions/ExcludeSharedDrivesList" - }, - "ExcludeUserAccounts": { - "$ref": "#/definitions/ExcludeUserAccountsList" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - } - }, - "required": [ - "SecretArn" - ], - "type": "object" - }, - "HookConfiguration": { - "additionalProperties": false, - "properties": { - "InvocationCondition": { - "$ref": "#/definitions/DocumentAttributeCondition" - }, - "LambdaArn": { - "$ref": "#/definitions/LambdaArn" - }, - "S3Bucket": { - "$ref": "#/definitions/S3BucketName" - } - }, - "required": [ - "LambdaArn", - "S3Bucket" - ], - "type": "object" - }, - "Id": { - "description": "ID of data source", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "IndexFieldName": { - "maxLength": 30, - "minLength": 1, - "type": "string" - }, - "IndexId": { - "description": "ID of Index", - "maxLength": 36, - "minLength": 36, - "type": "string" - }, - "InlineConfigurations": { - "description": "List of InlineCustomDocumentEnrichmentConfigurations", - "items": { - "$ref": "#/definitions/InlineCustomDocumentEnrichmentConfiguration" - }, - "maxItems": 100, - "type": "array" - }, - "InlineCustomDocumentEnrichmentConfiguration": { - "additionalProperties": false, - "properties": { - "Condition": { - "$ref": "#/definitions/DocumentAttributeCondition" - }, - "DocumentContentDeletion": { - "type": "boolean" - }, - "Target": { - "$ref": "#/definitions/DocumentAttributeTarget" - } - }, - "type": "object" - }, - "LambdaArn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "LanguageCode": { - "description": "The code for a language.", - "maxLength": 10, - "minLength": 2, - "pattern": "[a-zA-Z-]*", - "type": "string" - }, - "Long": { - "format": "int64", - "type": "integer" - }, - "MimeType": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of data source", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "OneDriveConfiguration": { - "additionalProperties": false, - "properties": { - "DisableLocalGroups": { - "$ref": "#/definitions/DisableLocalGroups" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "OneDriveUsers": { - "$ref": "#/definitions/OneDriveUsers" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "TenantDomain": { - "$ref": "#/definitions/TenantDomain" - } - }, - "required": [ - "TenantDomain", - "SecretArn", - "OneDriveUsers" - ], - "type": "object" - }, - "OneDriveUser": { - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!\\s).+@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$", - "type": "string" - }, - "OneDriveUserList": { - "items": { - "$ref": "#/definitions/OneDriveUser" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "OneDriveUsers": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "OneDriveUserList" - ] - }, - { - "required": [ - "OneDriveUserS3Path" - ] - } - ], - "properties": { - "OneDriveUserList": { - "$ref": "#/definitions/OneDriveUserList" - }, - "OneDriveUserS3Path": { - "$ref": "#/definitions/S3Path" - } - }, - "type": "object" - }, - "ProxyConfiguration": { - "additionalProperties": false, - "properties": { - "Credentials": { - "$ref": "#/definitions/SecretArn" - }, - "Host": { - "maxLength": 253, - "minLength": 1, - "pattern": "([^\\s]*)", - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "Host", - "Port" - ], - "type": "object" - }, - "QueryIdentifiersEnclosingOption": { - "enum": [ - "DOUBLE_QUOTES", - "NONE" - ], - "type": "string" - }, - "RoleArn": { - "description": "Role ARN", - "maxLength": 1284, - "minLength": 1, - "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", - "type": "string" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", - "type": "string" - }, - "S3DataSourceConfiguration": { - "additionalProperties": false, - "description": "S3 data source configuration", - "properties": { - "AccessControlListConfiguration": { - "$ref": "#/definitions/AccessControlListConfiguration" - }, - "BucketName": { - "$ref": "#/definitions/S3BucketName" - }, - "DocumentsMetadataConfiguration": { - "$ref": "#/definitions/DocumentsMetadataConfiguration" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "InclusionPrefixes": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "S3ObjectKey": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "S3Path": { - "additionalProperties": false, - "properties": { - "Bucket": { - "$ref": "#/definitions/S3BucketName" - }, - "Key": { - "$ref": "#/definitions/S3ObjectKey" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "SalesforceChatterFeedConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "IncludeFilterTypes": { - "$ref": "#/definitions/SalesforceChatterFeedIncludeFilterTypes" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "SalesforceChatterFeedIncludeFilterType": { - "enum": [ - "ACTIVE_USER", - "STANDARD_USER" - ], - "type": "string" - }, - "SalesforceChatterFeedIncludeFilterTypes": { - "items": { - "$ref": "#/definitions/SalesforceChatterFeedIncludeFilterType" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - }, - "SalesforceConfiguration": { - "additionalProperties": false, - "properties": { - "ChatterFeedConfiguration": { - "$ref": "#/definitions/SalesforceChatterFeedConfiguration" - }, - "CrawlAttachments": { - "type": "boolean" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "KnowledgeArticleConfiguration": { - "$ref": "#/definitions/SalesforceKnowledgeArticleConfiguration" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "ServerUrl": { - "$ref": "#/definitions/Url" - }, - "StandardObjectAttachmentConfiguration": { - "$ref": "#/definitions/SalesforceStandardObjectAttachmentConfiguration" - }, - "StandardObjectConfigurations": { - "$ref": "#/definitions/SalesforceStandardObjectConfigurationList" - } - }, - "required": [ - "ServerUrl", - "SecretArn" - ], - "type": "object" - }, - "SalesforceCustomKnowledgeArticleTypeConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "Name": { - "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeName" - } - }, - "required": [ - "Name", - "DocumentDataFieldName" - ], - "type": "object" - }, - "SalesforceCustomKnowledgeArticleTypeConfigurationList": { - "items": { - "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeConfiguration" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "SalesforceCustomKnowledgeArticleTypeName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "SalesforceKnowledgeArticleConfiguration": { - "additionalProperties": false, - "properties": { - "CustomKnowledgeArticleTypeConfigurations": { - "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeConfigurationList" - }, - "IncludedStates": { - "$ref": "#/definitions/SalesforceKnowledgeArticleStateList" - }, - "StandardKnowledgeArticleTypeConfiguration": { - "$ref": "#/definitions/SalesforceStandardKnowledgeArticleTypeConfiguration" - } - }, - "required": [ - "IncludedStates" - ], - "type": "object" - }, - "SalesforceKnowledgeArticleState": { - "enum": [ - "DRAFT", - "PUBLISHED", - "ARCHIVED" - ], - "type": "string" - }, - "SalesforceKnowledgeArticleStateList": { - "items": { - "$ref": "#/definitions/SalesforceKnowledgeArticleState" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - }, - "SalesforceStandardKnowledgeArticleTypeConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "SalesforceStandardObjectAttachmentConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - } - }, - "type": "object" - }, - "SalesforceStandardObjectConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "Name": { - "$ref": "#/definitions/SalesforceStandardObjectName" - } - }, - "required": [ - "Name", - "DocumentDataFieldName" - ], - "type": "object" - }, - "SalesforceStandardObjectConfigurationList": { - "items": { - "$ref": "#/definitions/SalesforceStandardObjectConfiguration" - }, - "maxItems": 17, - "minItems": 1, - "type": "array" - }, - "SalesforceStandardObjectName": { - "enum": [ - "ACCOUNT", - "CAMPAIGN", - "CASE", - "CONTACT", - "CONTRACT", - "DOCUMENT", - "GROUP", - "IDEA", - "LEAD", - "OPPORTUNITY", - "PARTNER", - "PRICEBOOK", - "PRODUCT", - "PROFILE", - "SOLUTION", - "TASK", - "USER" - ], - "type": "string" - }, - "Schedule": { - "description": "Schedule", - "maxLength": 1000, - "type": "string" - }, - "SecretArn": { - "maxLength": 1284, - "minLength": 1, - "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", - "type": "string" - }, - "ServiceNowAuthenticationType": { - "enum": [ - "HTTP_BASIC", - "OAUTH2" - ], - "type": "string" - }, - "ServiceNowBuildVersionType": { - "enum": [ - "LONDON", - "OTHERS" - ], - "type": "string" - }, - "ServiceNowConfiguration": { - "additionalProperties": false, - "properties": { - "AuthenticationType": { - "$ref": "#/definitions/ServiceNowAuthenticationType" - }, - "HostUrl": { - "$ref": "#/definitions/ServiceNowHostUrl" - }, - "KnowledgeArticleConfiguration": { - "$ref": "#/definitions/ServiceNowKnowledgeArticleConfiguration" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "ServiceCatalogConfiguration": { - "$ref": "#/definitions/ServiceNowServiceCatalogConfiguration" - }, - "ServiceNowBuildVersion": { - "$ref": "#/definitions/ServiceNowBuildVersionType" - } - }, - "required": [ - "HostUrl", - "SecretArn", - "ServiceNowBuildVersion" - ], - "type": "object" - }, - "ServiceNowHostUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(?!(^(https?|ftp|file):\\/\\/))[a-z0-9-]+(\\.service-now\\.com)$", - "type": "string" - }, - "ServiceNowKnowledgeArticleConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "FilterQuery": { - "$ref": "#/definitions/ServiceNowKnowledgeArticleFilterQuery" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "ServiceNowKnowledgeArticleFilterQuery": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ServiceNowServiceCatalogConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DocumentDataFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "SharePointConfiguration": { - "additionalProperties": false, - "description": "SharePoint configuration", - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DisableLocalGroups": { - "$ref": "#/definitions/DisableLocalGroups" - }, - "DocumentTitleFieldName": { - "$ref": "#/definitions/DataSourceFieldName" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "SecretArn": { - "$ref": "#/definitions/SecretArn" - }, - "SharePointVersion": { - "enum": [ - "SHAREPOINT_ONLINE", - "SHAREPOINT_2013", - "SHAREPOINT_2016" - ], - "type": "string" - }, - "SslCertificateS3Path": { - "$ref": "#/definitions/S3Path" - }, - "Urls": { - "items": { - "$ref": "#/definitions/Url" - }, - "maxItems": 100, - "type": "array" - }, - "UseChangeLog": { - "type": "boolean" - }, - "VpcConfiguration": { - "$ref": "#/definitions/DataSourceVpcConfiguration" - } - }, - "required": [ - "Urls", - "SecretArn", - "SharePointVersion" - ], - "type": "object" - }, - "SharedDriveId": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "SqlConfiguration": { - "additionalProperties": false, - "properties": { - "QueryIdentifiersEnclosingOption": { - "$ref": "#/definitions/QueryIdentifiersEnclosingOption" - } - }, - "type": "object" - }, - "TableName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Kendra resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "description": "List of tags", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - }, - "TenantDomain": { - "maxLength": 256, - "minLength": 1, - "pattern": "^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-z]{2,}$", - "type": "string" - }, - "Timestamp": { - "type": "string" - }, - "Type": { - "description": "Data source type", - "enum": [ - "S3", - "SHAREPOINT", - "SALESFORCE", - "ONEDRIVE", - "SERVICENOW", - "DATABASE", - "CUSTOM", - "CONFLUENCE", - "GOOGLEDRIVE", - "WEBCRAWLER", - "WORKDOCS" - ], - "type": "string" - }, - "Url": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?|ftp|file)://([^\\s]*)", - "type": "string" - }, - "UserAccount": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "WebCrawlerAuthenticationConfiguration": { - "additionalProperties": false, - "properties": { - "BasicAuthentication": { - "$ref": "#/definitions/WebCrawlerBasicAuthenticationList" - } - }, - "type": "object" - }, - "WebCrawlerBasicAuthentication": { - "additionalProperties": false, - "properties": { - "Credentials": { - "$ref": "#/definitions/SecretArn" - }, - "Host": { - "maxLength": 253, - "minLength": 1, - "pattern": "([^\\s]*)", - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "Host", - "Port", - "Credentials" - ], - "type": "object" - }, - "WebCrawlerBasicAuthenticationList": { - "items": { - "$ref": "#/definitions/WebCrawlerBasicAuthentication" - }, - "maxItems": 10, - "type": "array" - }, - "WebCrawlerConfiguration": { - "additionalProperties": false, - "properties": { - "AuthenticationConfiguration": { - "$ref": "#/definitions/WebCrawlerAuthenticationConfiguration" - }, - "CrawlDepth": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "MaxContentSizePerPageInMegaBytes": { - "maximum": 50, - "minimum": 0, - "type": "number" - }, - "MaxLinksPerPage": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "MaxUrlsPerMinuteCrawlRate": { - "maximum": 300, - "minimum": 1, - "type": "integer" - }, - "ProxyConfiguration": { - "$ref": "#/definitions/ProxyConfiguration" - }, - "UrlExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "UrlInclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "Urls": { - "$ref": "#/definitions/WebCrawlerUrls" - } - }, - "required": [ - "Urls" - ], - "type": "object" - }, - "WebCrawlerSeedUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?)://([^\\s]*)", - "type": "string" - }, - "WebCrawlerSeedUrlConfiguration": { - "additionalProperties": false, - "properties": { - "SeedUrls": { - "$ref": "#/definitions/WebCrawlerSeedUrlList" - }, - "WebCrawlerMode": { - "enum": [ - "HOST_ONLY", - "SUBDOMAINS", - "EVERYTHING" - ], - "type": "string" - } - }, - "required": [ - "SeedUrls" - ], - "type": "object" - }, - "WebCrawlerSeedUrlList": { - "items": { - "$ref": "#/definitions/WebCrawlerSeedUrl" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "WebCrawlerSiteMap": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?):\\/\\/([^\\s]*)", - "type": "string" - }, - "WebCrawlerSiteMaps": { - "items": { - "$ref": "#/definitions/WebCrawlerSiteMap" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "WebCrawlerSiteMapsConfiguration": { - "additionalProperties": false, - "properties": { - "SiteMaps": { - "$ref": "#/definitions/WebCrawlerSiteMaps" - } - }, - "required": [ - "SiteMaps" - ], - "type": "object" - }, - "WebCrawlerUrls": { - "additionalProperties": false, - "properties": { - "SeedUrlConfiguration": { - "$ref": "#/definitions/WebCrawlerSeedUrlConfiguration" - }, - "SiteMapsConfiguration": { - "$ref": "#/definitions/WebCrawlerSiteMapsConfiguration" - } - }, - "type": "object" - }, - "WorkDocsConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlComments": { - "type": "boolean" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" - }, - "OrganizationId": { - "maxLength": 12, - "minLength": 12, - "pattern": "d-[0-9a-fA-F]{10}", - "type": "string" - }, - "UseChangeLog": { - "type": "boolean" - } - }, - "required": [ - "OrganizationId" - ], - "type": "object" - } - }, - "description": "Kendra DataSource", - "handlers": { - "create": { - "permissions": [ - "kendra:CreateDataSource", - "kendra:DescribeDataSource", - "kendra:ListTagsForResource", - "iam:PassRole", - "kendra:TagResource" - ] - }, - "delete": { - "permissions": [ - "kendra:DescribeDataSource", - "kendra:DeleteDataSource" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "kendra:ListDataSources" - ] - }, - "read": { - "permissions": [ - "kendra:DescribeDataSource", - "kendra:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kendra:DescribeDataSource", - "kendra:UpdateDataSource", - "kendra:ListTagsForResource", - "kendra:TagResource", - "kendra:UntagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/IndexId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CustomDocumentEnrichmentConfiguration": { - "$ref": "#/definitions/CustomDocumentEnrichmentConfiguration" - }, - "DataSourceConfiguration": { - "$ref": "#/definitions/DataSourceConfiguration" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "IndexId": { - "$ref": "#/definitions/IndexId" - }, - "LanguageCode": { - "$ref": "#/definitions/LanguageCode" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "Tags": { - "$ref": "#/definitions/TagList", - "description": "Tags for labeling the data source" - }, - "Type": { - "$ref": "#/definitions/Type" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "IndexId", - "Type" - ], - "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-data-source.html", - "typeName": "AWS::Kendra::DataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type" + ], + "definitions": { + "AccessControlListConfiguration": { + "additionalProperties": false, + "properties": { + "KeyPath": { + "$ref": "#/definitions/S3ObjectKey" + } + }, + "type": "object" + }, + "AclConfiguration": { + "additionalProperties": false, + "properties": { + "AllowedGroupsColumnName": { + "$ref": "#/definitions/ColumnName" + } + }, + "required": [ + "AllowedGroupsColumnName" + ], + "type": "object" + }, + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "ChangeDetectingColumns": { + "items": { + "$ref": "#/definitions/ColumnName" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "ColumnConfiguration": { + "additionalProperties": false, + "properties": { + "ChangeDetectingColumns": { + "$ref": "#/definitions/ChangeDetectingColumns" + }, + "DocumentDataColumnName": { + "$ref": "#/definitions/ColumnName" + }, + "DocumentIdColumnName": { + "$ref": "#/definitions/ColumnName" + }, + "DocumentTitleColumnName": { + "$ref": "#/definitions/ColumnName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + } + }, + "required": [ + "DocumentIdColumnName", + "DocumentDataColumnName", + "ChangeDetectingColumns" + ], + "type": "object" + }, + "ColumnName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ConditionOperator": { + "enum": [ + "GreaterThan", + "GreaterThanOrEquals", + "LessThan", + "LessThanOrEquals", + "Equals", + "NotEquals", + "Contains", + "NotContains", + "Exists", + "NotExists", + "BeginsWith" + ], + "type": "string" + }, + "ConfluenceAttachmentConfiguration": { + "additionalProperties": false, + "properties": { + "AttachmentFieldMappings": { + "$ref": "#/definitions/ConfluenceAttachmentFieldMappingsList" + }, + "CrawlAttachments": { + "type": "boolean" + } + }, + "type": "object" + }, + "ConfluenceAttachmentFieldMappingsList": { + "items": { + "$ref": "#/definitions/ConfluenceAttachmentToIndexFieldMapping" + }, + "maxItems": 11, + "minItems": 1, + "type": "array" + }, + "ConfluenceAttachmentFieldName": { + "enum": [ + "AUTHOR", + "CONTENT_TYPE", + "CREATED_DATE", + "DISPLAY_URL", + "FILE_SIZE", + "ITEM_TYPE", + "PARENT_ID", + "SPACE_KEY", + "SPACE_NAME", + "URL", + "VERSION" + ], + "type": "string" + }, + "ConfluenceAttachmentToIndexFieldMapping": { + "additionalProperties": false, + "properties": { + "DataSourceFieldName": { + "$ref": "#/definitions/ConfluenceAttachmentFieldName" + }, + "DateFieldFormat": { + "$ref": "#/definitions/DateFieldFormat" + }, + "IndexFieldName": { + "$ref": "#/definitions/IndexFieldName" + } + }, + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "type": "object" + }, + "ConfluenceBlogConfiguration": { + "additionalProperties": false, + "properties": { + "BlogFieldMappings": { + "$ref": "#/definitions/ConfluenceBlogFieldMappingsList" + } + }, + "type": "object" + }, + "ConfluenceBlogFieldMappingsList": { + "items": { + "$ref": "#/definitions/ConfluenceBlogToIndexFieldMapping" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "ConfluenceBlogFieldName": { + "enum": [ + "AUTHOR", + "DISPLAY_URL", + "ITEM_TYPE", + "LABELS", + "PUBLISH_DATE", + "SPACE_KEY", + "SPACE_NAME", + "URL", + "VERSION" + ], + "type": "string" + }, + "ConfluenceBlogToIndexFieldMapping": { + "additionalProperties": false, + "properties": { + "DataSourceFieldName": { + "$ref": "#/definitions/ConfluenceBlogFieldName" + }, + "DateFieldFormat": { + "$ref": "#/definitions/DateFieldFormat" + }, + "IndexFieldName": { + "$ref": "#/definitions/IndexFieldName" + } + }, + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "type": "object" + }, + "ConfluenceConfiguration": { + "additionalProperties": false, + "properties": { + "AttachmentConfiguration": { + "$ref": "#/definitions/ConfluenceAttachmentConfiguration" + }, + "BlogConfiguration": { + "$ref": "#/definitions/ConfluenceBlogConfiguration" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "PageConfiguration": { + "$ref": "#/definitions/ConfluencePageConfiguration" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "ServerUrl": { + "$ref": "#/definitions/Url" + }, + "SpaceConfiguration": { + "$ref": "#/definitions/ConfluenceSpaceConfiguration" + }, + "Version": { + "$ref": "#/definitions/ConfluenceVersion" + }, + "VpcConfiguration": { + "$ref": "#/definitions/DataSourceVpcConfiguration" + } + }, + "required": [ + "ServerUrl", + "SecretArn", + "Version" + ], + "type": "object" + }, + "ConfluencePageConfiguration": { + "additionalProperties": false, + "properties": { + "PageFieldMappings": { + "$ref": "#/definitions/ConfluencePageFieldMappingsList" + } + }, + "type": "object" + }, + "ConfluencePageFieldMappingsList": { + "items": { + "$ref": "#/definitions/ConfluencePageToIndexFieldMapping" + }, + "maxItems": 12, + "minItems": 1, + "type": "array" + }, + "ConfluencePageFieldName": { + "enum": [ + "AUTHOR", + "CONTENT_STATUS", + "CREATED_DATE", + "DISPLAY_URL", + "ITEM_TYPE", + "LABELS", + "MODIFIED_DATE", + "PARENT_ID", + "SPACE_KEY", + "SPACE_NAME", + "URL", + "VERSION" + ], + "type": "string" + }, + "ConfluencePageToIndexFieldMapping": { + "additionalProperties": false, + "properties": { + "DataSourceFieldName": { + "$ref": "#/definitions/ConfluencePageFieldName" + }, + "DateFieldFormat": { + "$ref": "#/definitions/DateFieldFormat" + }, + "IndexFieldName": { + "$ref": "#/definitions/IndexFieldName" + } + }, + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "type": "object" + }, + "ConfluenceSpaceConfiguration": { + "additionalProperties": false, + "properties": { + "CrawlArchivedSpaces": { + "type": "boolean" + }, + "CrawlPersonalSpaces": { + "type": "boolean" + }, + "ExcludeSpaces": { + "$ref": "#/definitions/ConfluenceSpaceList" + }, + "IncludeSpaces": { + "$ref": "#/definitions/ConfluenceSpaceList" + }, + "SpaceFieldMappings": { + "$ref": "#/definitions/ConfluenceSpaceFieldMappingsList" + } + }, + "type": "object" + }, + "ConfluenceSpaceFieldMappingsList": { + "items": { + "$ref": "#/definitions/ConfluenceSpaceToIndexFieldMapping" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "ConfluenceSpaceFieldName": { + "enum": [ + "DISPLAY_URL", + "ITEM_TYPE", + "SPACE_KEY", + "URL" + ], + "type": "string" + }, + "ConfluenceSpaceIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ConfluenceSpaceList": { + "items": { + "$ref": "#/definitions/ConfluenceSpaceIdentifier" + }, + "minItems": 1, + "type": "array" + }, + "ConfluenceSpaceToIndexFieldMapping": { + "additionalProperties": false, + "properties": { + "DataSourceFieldName": { + "$ref": "#/definitions/ConfluenceSpaceFieldName" + }, + "DateFieldFormat": { + "$ref": "#/definitions/DateFieldFormat" + }, + "IndexFieldName": { + "$ref": "#/definitions/IndexFieldName" + } + }, + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "type": "object" + }, + "ConfluenceVersion": { + "enum": [ + "CLOUD", + "SERVER" + ], + "type": "string" + }, + "ConnectionConfiguration": { + "additionalProperties": false, + "properties": { + "DatabaseHost": { + "$ref": "#/definitions/DatabaseHost" + }, + "DatabaseName": { + "$ref": "#/definitions/DatabaseName" + }, + "DatabasePort": { + "$ref": "#/definitions/DatabasePort" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "TableName": { + "$ref": "#/definitions/TableName" + } + }, + "required": [ + "DatabaseHost", + "DatabasePort", + "DatabaseName", + "TableName", + "SecretArn" + ], + "type": "object" + }, + "CustomDocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "InlineConfigurations": { + "$ref": "#/definitions/InlineConfigurations" + }, + "PostExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + }, + "PreExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + } + }, + "type": "object" + }, + "DataSourceConfiguration": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "S3Configuration" + ] + }, + { + "required": [ + "SharePointConfiguration" + ] + }, + { + "required": [ + "SalesforceConfiguration" + ] + }, + { + "required": [ + "OneDriveConfiguration" + ] + }, + { + "required": [ + "ServiceNowConfiguration" + ] + }, + { + "required": [ + "DatabaseConfiguration" + ] + }, + { + "required": [ + "ConfluenceConfiguration" + ] + }, + { + "required": [ + "GoogleDriveConfiguration" + ] + }, + { + "required": [ + "WebCrawlerConfiguration" + ] + }, + { + "required": [ + "WorkDocsConfiguration" + ] + } + ], + "properties": { + "ConfluenceConfiguration": { + "$ref": "#/definitions/ConfluenceConfiguration" + }, + "DatabaseConfiguration": { + "$ref": "#/definitions/DatabaseConfiguration" + }, + "GoogleDriveConfiguration": { + "$ref": "#/definitions/GoogleDriveConfiguration" + }, + "OneDriveConfiguration": { + "$ref": "#/definitions/OneDriveConfiguration" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DataSourceConfiguration" + }, + "SalesforceConfiguration": { + "$ref": "#/definitions/SalesforceConfiguration" + }, + "ServiceNowConfiguration": { + "$ref": "#/definitions/ServiceNowConfiguration" + }, + "SharePointConfiguration": { + "$ref": "#/definitions/SharePointConfiguration" + }, + "WebCrawlerConfiguration": { + "$ref": "#/definitions/WebCrawlerConfiguration" + }, + "WorkDocsConfiguration": { + "$ref": "#/definitions/WorkDocsConfiguration" + } + }, + "type": "object" + }, + "DataSourceFieldName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "DataSourceInclusionsExclusionsStrings": { + "items": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "DataSourceToIndexFieldMapping": { + "additionalProperties": false, + "properties": { + "DataSourceFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DateFieldFormat": { + "$ref": "#/definitions/DateFieldFormat" + }, + "IndexFieldName": { + "$ref": "#/definitions/IndexFieldName" + } + }, + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "type": "object" + }, + "DataSourceToIndexFieldMappingList": { + "items": { + "$ref": "#/definitions/DataSourceToIndexFieldMapping" + }, + "maxItems": 100, + "type": "array" + }, + "DataSourceVpcConfiguration": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "[\\-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 10, + "type": "array" + }, + "SubnetIds": { + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "[\\-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 6, + "type": "array" + } + }, + "required": [ + "SubnetIds", + "SecurityGroupIds" + ], + "type": "object" + }, + "DatabaseConfiguration": { + "additionalProperties": false, + "properties": { + "AclConfiguration": { + "$ref": "#/definitions/AclConfiguration" + }, + "ColumnConfiguration": { + "$ref": "#/definitions/ColumnConfiguration" + }, + "ConnectionConfiguration": { + "$ref": "#/definitions/ConnectionConfiguration" + }, + "DatabaseEngineType": { + "$ref": "#/definitions/DatabaseEngineType" + }, + "SqlConfiguration": { + "$ref": "#/definitions/SqlConfiguration" + }, + "VpcConfiguration": { + "$ref": "#/definitions/DataSourceVpcConfiguration" + } + }, + "required": [ + "ConnectionConfiguration", + "ColumnConfiguration", + "DatabaseEngineType" + ], + "type": "object" + }, + "DatabaseEngineType": { + "enum": [ + "RDS_AURORA_MYSQL", + "RDS_AURORA_POSTGRESQL", + "RDS_MYSQL", + "RDS_POSTGRESQL" + ], + "type": "string" + }, + "DatabaseHost": { + "maxLength": 253, + "minLength": 1, + "type": "string" + }, + "DatabaseName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "DatabasePort": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "DateFieldFormat": { + "maxLength": 40, + "minLength": 4, + "type": "string" + }, + "Description": { + "description": "Description of data source", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "DisableLocalGroups": { + "type": "boolean" + }, + "DocumentAttributeCondition": { + "additionalProperties": false, + "properties": { + "ConditionDocumentAttributeKey": { + "$ref": "#/definitions/DocumentAttributeKey" + }, + "ConditionOnValue": { + "$ref": "#/definitions/DocumentAttributeValue" + }, + "Operator": { + "$ref": "#/definitions/ConditionOperator" + } + }, + "required": [ + "ConditionDocumentAttributeKey", + "Operator" + ], + "type": "object" + }, + "DocumentAttributeKey": { + "maxLength": 200, + "minLength": 1, + "pattern": "[a-zA-Z0-9_][a-zA-Z0-9_-]*", + "type": "string" + }, + "DocumentAttributeTarget": { + "additionalProperties": false, + "properties": { + "TargetDocumentAttributeKey": { + "$ref": "#/definitions/DocumentAttributeKey" + }, + "TargetDocumentAttributeValue": { + "$ref": "#/definitions/DocumentAttributeValue" + }, + "TargetDocumentAttributeValueDeletion": { + "type": "boolean" + } + }, + "required": [ + "TargetDocumentAttributeKey" + ], + "type": "object" + }, + "DocumentAttributeValue": { + "additionalProperties": false, + "properties": { + "DateValue": { + "$ref": "#/definitions/Timestamp" + }, + "LongValue": { + "$ref": "#/definitions/Long" + }, + "StringListValue": { + "items": { + "type": "string" + }, + "type": "array" + }, + "StringValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DocumentsMetadataConfiguration": { + "additionalProperties": false, + "properties": { + "S3Prefix": { + "$ref": "#/definitions/S3ObjectKey" + } + }, + "type": "object" + }, + "ExcludeMimeTypesList": { + "items": { + "$ref": "#/definitions/MimeType" + }, + "maxItems": 30, + "minItems": 0, + "type": "array" + }, + "ExcludeSharedDrivesList": { + "items": { + "$ref": "#/definitions/SharedDriveId" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ExcludeUserAccountsList": { + "items": { + "$ref": "#/definitions/UserAccount" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "GoogleDriveConfiguration": { + "additionalProperties": false, + "properties": { + "ExcludeMimeTypes": { + "$ref": "#/definitions/ExcludeMimeTypesList" + }, + "ExcludeSharedDrives": { + "$ref": "#/definitions/ExcludeSharedDrivesList" + }, + "ExcludeUserAccounts": { + "$ref": "#/definitions/ExcludeUserAccountsList" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + } + }, + "required": [ + "SecretArn" + ], + "type": "object" + }, + "HookConfiguration": { + "additionalProperties": false, + "properties": { + "InvocationCondition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "LambdaArn": { + "$ref": "#/definitions/LambdaArn" + }, + "S3Bucket": { + "$ref": "#/definitions/S3BucketName" + } + }, + "required": [ + "LambdaArn", + "S3Bucket" + ], + "type": "object" + }, + "Id": { + "description": "ID of data source", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "IndexFieldName": { + "maxLength": 30, + "minLength": 1, + "type": "string" + }, + "IndexId": { + "description": "ID of Index", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "InlineConfigurations": { + "description": "List of InlineCustomDocumentEnrichmentConfigurations", + "items": { + "$ref": "#/definitions/InlineCustomDocumentEnrichmentConfiguration" + }, + "maxItems": 100, + "type": "array" + }, + "InlineCustomDocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "Condition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "DocumentContentDeletion": { + "type": "boolean" + }, + "Target": { + "$ref": "#/definitions/DocumentAttributeTarget" + } + }, + "type": "object" + }, + "LambdaArn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "LanguageCode": { + "description": "The code for a language.", + "maxLength": 10, + "minLength": 2, + "pattern": "[a-zA-Z-]*", + "type": "string" + }, + "Long": { + "format": "int64", + "type": "integer" + }, + "MimeType": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of data source", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "OneDriveConfiguration": { + "additionalProperties": false, + "properties": { + "DisableLocalGroups": { + "$ref": "#/definitions/DisableLocalGroups" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "OneDriveUsers": { + "$ref": "#/definitions/OneDriveUsers" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "TenantDomain": { + "$ref": "#/definitions/TenantDomain" + } + }, + "required": [ + "TenantDomain", + "SecretArn", + "OneDriveUsers" + ], + "type": "object" + }, + "OneDriveUser": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s).+@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$", + "type": "string" + }, + "OneDriveUserList": { + "items": { + "$ref": "#/definitions/OneDriveUser" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "OneDriveUsers": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "OneDriveUserList" + ] + }, + { + "required": [ + "OneDriveUserS3Path" + ] + } + ], + "properties": { + "OneDriveUserList": { + "$ref": "#/definitions/OneDriveUserList" + }, + "OneDriveUserS3Path": { + "$ref": "#/definitions/S3Path" + } + }, + "type": "object" + }, + "ProxyConfiguration": { + "additionalProperties": false, + "properties": { + "Credentials": { + "$ref": "#/definitions/SecretArn" + }, + "Host": { + "maxLength": 253, + "minLength": 1, + "pattern": "([^\\s]*)", + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Host", + "Port" + ], + "type": "object" + }, + "QueryIdentifiersEnclosingOption": { + "enum": [ + "DOUBLE_QUOTES", + "NONE" + ], + "type": "string" + }, + "RoleArn": { + "description": "Role ARN", + "maxLength": 1284, + "minLength": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", + "type": "string" + }, + "S3DataSourceConfiguration": { + "additionalProperties": false, + "description": "S3 data source configuration", + "properties": { + "AccessControlListConfiguration": { + "$ref": "#/definitions/AccessControlListConfiguration" + }, + "BucketName": { + "$ref": "#/definitions/S3BucketName" + }, + "DocumentsMetadataConfiguration": { + "$ref": "#/definitions/DocumentsMetadataConfiguration" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "InclusionPrefixes": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "S3ObjectKey": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "S3Path": { + "additionalProperties": false, + "properties": { + "Bucket": { + "$ref": "#/definitions/S3BucketName" + }, + "Key": { + "$ref": "#/definitions/S3ObjectKey" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "SalesforceChatterFeedConfiguration": { + "additionalProperties": false, + "properties": { + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "IncludeFilterTypes": { + "$ref": "#/definitions/SalesforceChatterFeedIncludeFilterTypes" + } + }, + "required": [ + "DocumentDataFieldName" + ], + "type": "object" + }, + "SalesforceChatterFeedIncludeFilterType": { + "enum": [ + "ACTIVE_USER", + "STANDARD_USER" + ], + "type": "string" + }, + "SalesforceChatterFeedIncludeFilterTypes": { + "items": { + "$ref": "#/definitions/SalesforceChatterFeedIncludeFilterType" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "SalesforceConfiguration": { + "additionalProperties": false, + "properties": { + "ChatterFeedConfiguration": { + "$ref": "#/definitions/SalesforceChatterFeedConfiguration" + }, + "CrawlAttachments": { + "type": "boolean" + }, + "ExcludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "IncludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "KnowledgeArticleConfiguration": { + "$ref": "#/definitions/SalesforceKnowledgeArticleConfiguration" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "ServerUrl": { + "$ref": "#/definitions/Url" + }, + "StandardObjectAttachmentConfiguration": { + "$ref": "#/definitions/SalesforceStandardObjectAttachmentConfiguration" + }, + "StandardObjectConfigurations": { + "$ref": "#/definitions/SalesforceStandardObjectConfigurationList" + } + }, + "required": [ + "ServerUrl", + "SecretArn" + ], + "type": "object" + }, + "SalesforceCustomKnowledgeArticleTypeConfiguration": { + "additionalProperties": false, + "properties": { + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "Name": { + "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeName" + } + }, + "required": [ + "Name", + "DocumentDataFieldName" + ], + "type": "object" + }, + "SalesforceCustomKnowledgeArticleTypeConfigurationList": { + "items": { + "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeConfiguration" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "SalesforceCustomKnowledgeArticleTypeName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "SalesforceKnowledgeArticleConfiguration": { + "additionalProperties": false, + "properties": { + "CustomKnowledgeArticleTypeConfigurations": { + "$ref": "#/definitions/SalesforceCustomKnowledgeArticleTypeConfigurationList" + }, + "IncludedStates": { + "$ref": "#/definitions/SalesforceKnowledgeArticleStateList" + }, + "StandardKnowledgeArticleTypeConfiguration": { + "$ref": "#/definitions/SalesforceStandardKnowledgeArticleTypeConfiguration" + } + }, + "required": [ + "IncludedStates" + ], + "type": "object" + }, + "SalesforceKnowledgeArticleState": { + "enum": [ + "DRAFT", + "PUBLISHED", + "ARCHIVED" + ], + "type": "string" + }, + "SalesforceKnowledgeArticleStateList": { + "items": { + "$ref": "#/definitions/SalesforceKnowledgeArticleState" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + }, + "SalesforceStandardKnowledgeArticleTypeConfiguration": { + "additionalProperties": false, + "properties": { + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + } + }, + "required": [ + "DocumentDataFieldName" + ], + "type": "object" + }, + "SalesforceStandardObjectAttachmentConfiguration": { + "additionalProperties": false, + "properties": { + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + } + }, + "type": "object" + }, + "SalesforceStandardObjectConfiguration": { + "additionalProperties": false, + "properties": { + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "Name": { + "$ref": "#/definitions/SalesforceStandardObjectName" + } + }, + "required": [ + "Name", + "DocumentDataFieldName" + ], + "type": "object" + }, + "SalesforceStandardObjectConfigurationList": { + "items": { + "$ref": "#/definitions/SalesforceStandardObjectConfiguration" + }, + "maxItems": 17, + "minItems": 1, + "type": "array" + }, + "SalesforceStandardObjectName": { + "enum": [ + "ACCOUNT", + "CAMPAIGN", + "CASE", + "CONTACT", + "CONTRACT", + "DOCUMENT", + "GROUP", + "IDEA", + "LEAD", + "OPPORTUNITY", + "PARTNER", + "PRICEBOOK", + "PRODUCT", + "PROFILE", + "SOLUTION", + "TASK", + "USER" + ], + "type": "string" + }, + "Schedule": { + "description": "Schedule", + "maxLength": 1000, + "type": "string" + }, + "SecretArn": { + "maxLength": 1284, + "minLength": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", + "type": "string" + }, + "ServiceNowAuthenticationType": { + "enum": [ + "HTTP_BASIC", + "OAUTH2" + ], + "type": "string" + }, + "ServiceNowBuildVersionType": { + "enum": [ + "LONDON", + "OTHERS" + ], + "type": "string" + }, + "ServiceNowConfiguration": { + "additionalProperties": false, + "properties": { + "AuthenticationType": { + "$ref": "#/definitions/ServiceNowAuthenticationType" + }, + "HostUrl": { + "$ref": "#/definitions/ServiceNowHostUrl" + }, + "KnowledgeArticleConfiguration": { + "$ref": "#/definitions/ServiceNowKnowledgeArticleConfiguration" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "ServiceCatalogConfiguration": { + "$ref": "#/definitions/ServiceNowServiceCatalogConfiguration" + }, + "ServiceNowBuildVersion": { + "$ref": "#/definitions/ServiceNowBuildVersionType" + } + }, + "required": [ + "HostUrl", + "SecretArn", + "ServiceNowBuildVersion" + ], + "type": "object" + }, + "ServiceNowHostUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(?!(^(https?|ftp|file):\\/\\/))[a-z0-9-]+(\\.service-now\\.com)$", + "type": "string" + }, + "ServiceNowKnowledgeArticleConfiguration": { + "additionalProperties": false, + "properties": { + "CrawlAttachments": { + "type": "boolean" + }, + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "ExcludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "FilterQuery": { + "$ref": "#/definitions/ServiceNowKnowledgeArticleFilterQuery" + }, + "IncludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + } + }, + "required": [ + "DocumentDataFieldName" + ], + "type": "object" + }, + "ServiceNowKnowledgeArticleFilterQuery": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ServiceNowServiceCatalogConfiguration": { + "additionalProperties": false, + "properties": { + "CrawlAttachments": { + "type": "boolean" + }, + "DocumentDataFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "ExcludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "IncludeAttachmentFilePatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + } + }, + "required": [ + "DocumentDataFieldName" + ], + "type": "object" + }, + "SharePointConfiguration": { + "additionalProperties": false, + "description": "SharePoint configuration", + "properties": { + "CrawlAttachments": { + "type": "boolean" + }, + "DisableLocalGroups": { + "$ref": "#/definitions/DisableLocalGroups" + }, + "DocumentTitleFieldName": { + "$ref": "#/definitions/DataSourceFieldName" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "SecretArn": { + "$ref": "#/definitions/SecretArn" + }, + "SharePointVersion": { + "enum": [ + "SHAREPOINT_ONLINE", + "SHAREPOINT_2013", + "SHAREPOINT_2016" + ], + "type": "string" + }, + "SslCertificateS3Path": { + "$ref": "#/definitions/S3Path" + }, + "Urls": { + "items": { + "$ref": "#/definitions/Url" + }, + "maxItems": 100, + "type": "array" + }, + "UseChangeLog": { + "type": "boolean" + }, + "VpcConfiguration": { + "$ref": "#/definitions/DataSourceVpcConfiguration" + } + }, + "required": [ + "Urls", + "SecretArn", + "SharePointVersion" + ], + "type": "object" + }, + "SharedDriveId": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "SqlConfiguration": { + "additionalProperties": false, + "properties": { + "QueryIdentifiersEnclosingOption": { + "$ref": "#/definitions/QueryIdentifiersEnclosingOption" + } + }, + "type": "object" + }, + "TableName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Kendra resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "description": "List of tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + }, + "TenantDomain": { + "maxLength": 256, + "minLength": 1, + "pattern": "^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-z]{2,}$", + "type": "string" + }, + "Timestamp": { + "type": "string" + }, + "Type": { + "description": "Data source type", + "enum": [ + "S3", + "SHAREPOINT", + "SALESFORCE", + "ONEDRIVE", + "SERVICENOW", + "DATABASE", + "CUSTOM", + "CONFLUENCE", + "GOOGLEDRIVE", + "WEBCRAWLER", + "WORKDOCS" + ], + "type": "string" + }, + "Url": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file)://([^\\s]*)", + "type": "string" + }, + "UserAccount": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "WebCrawlerAuthenticationConfiguration": { + "additionalProperties": false, + "properties": { + "BasicAuthentication": { + "$ref": "#/definitions/WebCrawlerBasicAuthenticationList" + } + }, + "type": "object" + }, + "WebCrawlerBasicAuthentication": { + "additionalProperties": false, + "properties": { + "Credentials": { + "$ref": "#/definitions/SecretArn" + }, + "Host": { + "maxLength": 253, + "minLength": 1, + "pattern": "([^\\s]*)", + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Host", + "Port", + "Credentials" + ], + "type": "object" + }, + "WebCrawlerBasicAuthenticationList": { + "items": { + "$ref": "#/definitions/WebCrawlerBasicAuthentication" + }, + "maxItems": 10, + "type": "array" + }, + "WebCrawlerConfiguration": { + "additionalProperties": false, + "properties": { + "AuthenticationConfiguration": { + "$ref": "#/definitions/WebCrawlerAuthenticationConfiguration" + }, + "CrawlDepth": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "MaxContentSizePerPageInMegaBytes": { + "maximum": 50, + "minimum": 0, + "type": "number" + }, + "MaxLinksPerPage": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "MaxUrlsPerMinuteCrawlRate": { + "maximum": 300, + "minimum": 1, + "type": "integer" + }, + "ProxyConfiguration": { + "$ref": "#/definitions/ProxyConfiguration" + }, + "UrlExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "UrlInclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "Urls": { + "$ref": "#/definitions/WebCrawlerUrls" + } + }, + "required": [ + "Urls" + ], + "type": "object" + }, + "WebCrawlerSeedUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?)://([^\\s]*)", + "type": "string" + }, + "WebCrawlerSeedUrlConfiguration": { + "additionalProperties": false, + "properties": { + "SeedUrls": { + "$ref": "#/definitions/WebCrawlerSeedUrlList" + }, + "WebCrawlerMode": { + "enum": [ + "HOST_ONLY", + "SUBDOMAINS", + "EVERYTHING" + ], + "type": "string" + } + }, + "required": [ + "SeedUrls" + ], + "type": "object" + }, + "WebCrawlerSeedUrlList": { + "items": { + "$ref": "#/definitions/WebCrawlerSeedUrl" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "WebCrawlerSiteMap": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?):\\/\\/([^\\s]*)", + "type": "string" + }, + "WebCrawlerSiteMaps": { + "items": { + "$ref": "#/definitions/WebCrawlerSiteMap" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "WebCrawlerSiteMapsConfiguration": { + "additionalProperties": false, + "properties": { + "SiteMaps": { + "$ref": "#/definitions/WebCrawlerSiteMaps" + } + }, + "required": [ + "SiteMaps" + ], + "type": "object" + }, + "WebCrawlerUrls": { + "additionalProperties": false, + "properties": { + "SeedUrlConfiguration": { + "$ref": "#/definitions/WebCrawlerSeedUrlConfiguration" + }, + "SiteMapsConfiguration": { + "$ref": "#/definitions/WebCrawlerSiteMapsConfiguration" + } + }, + "type": "object" + }, + "WorkDocsConfiguration": { + "additionalProperties": false, + "properties": { + "CrawlComments": { + "type": "boolean" + }, + "ExclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "FieldMappings": { + "$ref": "#/definitions/DataSourceToIndexFieldMappingList" + }, + "InclusionPatterns": { + "$ref": "#/definitions/DataSourceInclusionsExclusionsStrings" + }, + "OrganizationId": { + "maxLength": 12, + "minLength": 12, + "pattern": "d-[0-9a-fA-F]{10}", + "type": "string" + }, + "UseChangeLog": { + "type": "boolean" + } + }, + "required": [ + "OrganizationId" + ], + "type": "object" + } + }, + "description": "Kendra DataSource", + "handlers": { + "create": { + "permissions": [ + "kendra:CreateDataSource", + "kendra:DescribeDataSource", + "kendra:ListTagsForResource", + "iam:PassRole", + "kendra:TagResource" + ] + }, + "delete": { + "permissions": [ + "kendra:DescribeDataSource", + "kendra:DeleteDataSource" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "kendra:ListDataSources" + ] + }, + "read": { + "permissions": [ + "kendra:DescribeDataSource", + "kendra:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kendra:DescribeDataSource", + "kendra:UpdateDataSource", + "kendra:ListTagsForResource", + "kendra:TagResource", + "kendra:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/IndexId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CustomDocumentEnrichmentConfiguration": { + "$ref": "#/definitions/CustomDocumentEnrichmentConfiguration" + }, + "DataSourceConfiguration": { + "$ref": "#/definitions/DataSourceConfiguration" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "IndexId": { + "$ref": "#/definitions/IndexId" + }, + "LanguageCode": { + "$ref": "#/definitions/LanguageCode" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "Tags": { + "$ref": "#/definitions/TagList", + "description": "Tags for labeling the data source" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "IndexId", + "Type" + ], + "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-data-source.html", + "typeName": "AWS::Kendra::DataSource" +} diff --git a/schema/aws-kendra-faq.json b/schema/aws-kendra-faq.json index a273faf..17bfc2f 100644 --- a/schema/aws-kendra-faq.json +++ b/schema/aws-kendra-faq.json @@ -1,208 +1,208 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IndexId", - "/properties/Name", - "/properties/S3Path", - "/properties/RoleArn", - "/properties/Description", - "/properties/FileFormat" - ], - "definitions": { - "Description": { - "description": "Description of the FAQ", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "FaqName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "FileFormat": { - "description": "Format of the input file", - "enum": [ - "CSV", - "CSV_WITH_HEADER", - "JSON" - ], - "type": "string" - }, - "Id": { - "description": "Unique ID of the FAQ", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "IndexId": { - "description": "Unique ID of Index", - "maxLength": 36, - "minLength": 36, - "type": "string" - }, - "LanguageCode": { - "description": "The code for a language.", - "maxLength": 10, - "minLength": 2, - "pattern": "[a-zA-Z-]*", - "type": "string" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 1, - "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", - "type": "string" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", - "type": "string" - }, - "S3ObjectKey": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "S3Path": { - "additionalProperties": false, - "properties": { - "Bucket": { - "$ref": "#/definitions/S3BucketName" - }, - "Key": { - "$ref": "#/definitions/S3ObjectKey" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Kendra resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "description": "List of tags", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "description": "A Kendra FAQ resource", - "handlers": { - "create": { - "permissions": [ - "kendra:CreateFaq", - "kendra:DescribeFaq", - "iam:PassRole", - "kendra:ListTagsForResource", - "kendra:TagResource" - ] - }, - "delete": { - "permissions": [ - "kendra:DeleteFaq", - "kendra:DescribeFaq" - ] - }, - "list": { - "permissions": [ - "kendra:ListFaqs" - ] - }, - "read": { - "permissions": [ - "kendra:DescribeFaq", - "kendra:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kendra:ListTagsForResource", - "kendra:UntagResource", - "kendra:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id", - "/properties/IndexId" - ], - "properties": { - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "FAQ description" - }, - "FileFormat": { - "$ref": "#/definitions/FileFormat", - "description": "FAQ file format" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "IndexId": { - "$ref": "#/definitions/IndexId", - "description": "Index ID" - }, - "LanguageCode": { - "$ref": "#/definitions/LanguageCode" - }, - "Name": { - "$ref": "#/definitions/FaqName", - "description": "FAQ name" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn", - "description": "FAQ role ARN" - }, - "S3Path": { - "$ref": "#/definitions/S3Path", - "description": "FAQ S3 path" - }, - "Tags": { - "$ref": "#/definitions/TagList", - "description": "Tags for labeling the FAQ" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "IndexId", - "Name", - "S3Path", - "RoleArn" - ], - "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html", - "typeName": "AWS::Kendra::Faq" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IndexId", + "/properties/Name", + "/properties/S3Path", + "/properties/RoleArn", + "/properties/Description", + "/properties/FileFormat" + ], + "definitions": { + "Description": { + "description": "Description of the FAQ", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "FaqName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FileFormat": { + "description": "Format of the input file", + "enum": [ + "CSV", + "CSV_WITH_HEADER", + "JSON" + ], + "type": "string" + }, + "Id": { + "description": "Unique ID of the FAQ", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "IndexId": { + "description": "Unique ID of Index", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "LanguageCode": { + "description": "The code for a language.", + "maxLength": 10, + "minLength": 2, + "pattern": "[a-zA-Z-]*", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", + "type": "string" + }, + "S3ObjectKey": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "S3Path": { + "additionalProperties": false, + "properties": { + "Bucket": { + "$ref": "#/definitions/S3BucketName" + }, + "Key": { + "$ref": "#/definitions/S3ObjectKey" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Kendra resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "description": "List of tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "description": "A Kendra FAQ resource", + "handlers": { + "create": { + "permissions": [ + "kendra:CreateFaq", + "kendra:DescribeFaq", + "iam:PassRole", + "kendra:ListTagsForResource", + "kendra:TagResource" + ] + }, + "delete": { + "permissions": [ + "kendra:DeleteFaq", + "kendra:DescribeFaq" + ] + }, + "list": { + "permissions": [ + "kendra:ListFaqs" + ] + }, + "read": { + "permissions": [ + "kendra:DescribeFaq", + "kendra:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kendra:ListTagsForResource", + "kendra:UntagResource", + "kendra:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/IndexId" + ], + "properties": { + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "FAQ description" + }, + "FileFormat": { + "$ref": "#/definitions/FileFormat", + "description": "FAQ file format" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "IndexId": { + "$ref": "#/definitions/IndexId", + "description": "Index ID" + }, + "LanguageCode": { + "$ref": "#/definitions/LanguageCode" + }, + "Name": { + "$ref": "#/definitions/FaqName", + "description": "FAQ name" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn", + "description": "FAQ role ARN" + }, + "S3Path": { + "$ref": "#/definitions/S3Path", + "description": "FAQ S3 path" + }, + "Tags": { + "$ref": "#/definitions/TagList", + "description": "Tags for labeling the FAQ" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "IndexId", + "Name", + "S3Path", + "RoleArn" + ], + "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html", + "typeName": "AWS::Kendra::Faq" +} diff --git a/schema/aws-kendra-index.json b/schema/aws-kendra-index.json index 85da059..30cfb67 100644 --- a/schema/aws-kendra-index.json +++ b/schema/aws-kendra-index.json @@ -1,444 +1,444 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Edition", - "/properties/ServerSideEncryptionConfiguration" - ], - "definitions": { - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "CapacityUnitsConfiguration": { - "additionalProperties": false, - "properties": { - "QueryCapacityUnits": { - "$ref": "#/definitions/QueryCapacityUnits" - }, - "StorageCapacityUnits": { - "$ref": "#/definitions/StorageCapacityUnits" - } - }, - "required": [ - "StorageCapacityUnits", - "QueryCapacityUnits" - ], - "type": "object" - }, - "ClaimRegex": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Description": { - "maxLength": 1000, - "type": "string" - }, - "DocumentAttributeValueType": { - "enum": [ - "STRING_VALUE", - "STRING_LIST_VALUE", - "LONG_VALUE", - "DATE_VALUE" - ], - "type": "string" - }, - "DocumentMetadataConfiguration": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/DocumentMetadataConfigurationName" - }, - "Relevance": { - "$ref": "#/definitions/Relevance" - }, - "Search": { - "$ref": "#/definitions/Search" - }, - "Type": { - "$ref": "#/definitions/DocumentAttributeValueType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "DocumentMetadataConfigurationList": { - "items": { - "$ref": "#/definitions/DocumentMetadataConfiguration" - }, - "maxItems": 500, - "type": "array" - }, - "DocumentMetadataConfigurationName": { - "maxLength": 30, - "minLength": 1, - "type": "string" - }, - "Duration": { - "maxLength": 10, - "minLength": 1, - "pattern": "[0-9]+[s]", - "type": "string" - }, - "Edition": { - "description": "Edition of index", - "enum": [ - "DEVELOPER_EDITION", - "ENTERPRISE_EDITION" - ], - "type": "string" - }, - "Freshness": { - "type": "boolean" - }, - "GroupAttributeField": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "Unique ID of index", - "maxLength": 36, - "minLength": 36, - "type": "string" - }, - "Importance": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "Issuer": { - "maxLength": 65, - "minLength": 1, - "type": "string" - }, - "JsonTokenTypeConfiguration": { - "additionalProperties": false, - "properties": { - "GroupAttributeField": { - "$ref": "#/definitions/GroupAttributeField" - }, - "UserNameAttributeField": { - "$ref": "#/definitions/UserNameAttributeField" - } - }, - "required": [ - "UserNameAttributeField", - "GroupAttributeField" - ], - "type": "object" - }, - "JwtTokenTypeConfiguration": { - "additionalProperties": false, - "properties": { - "ClaimRegex": { - "$ref": "#/definitions/ClaimRegex" - }, - "GroupAttributeField": { - "$ref": "#/definitions/GroupAttributeField" - }, - "Issuer": { - "$ref": "#/definitions/Issuer" - }, - "KeyLocation": { - "$ref": "#/definitions/KeyLocation" - }, - "SecretManagerArn": { - "$ref": "#/definitions/RoleArn" - }, - "URL": { - "$ref": "#/definitions/Url" - }, - "UserNameAttributeField": { - "$ref": "#/definitions/UserNameAttributeField" - } - }, - "required": [ - "KeyLocation" - ], - "type": "object" - }, - "KeyLocation": { - "enum": [ - "URL", - "SECRET_MANAGER" - ], - "type": "string" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "Name of index", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Order": { - "enum": [ - "ASCENDING", - "DESCENDING" - ], - "type": "string" - }, - "QueryCapacityUnits": { - "minimum": 0, - "type": "integer" - }, - "Relevance": { - "additionalProperties": false, - "properties": { - "Duration": { - "$ref": "#/definitions/Duration" - }, - "Freshness": { - "$ref": "#/definitions/Freshness" - }, - "Importance": { - "$ref": "#/definitions/Importance" - }, - "RankOrder": { - "$ref": "#/definitions/Order" - }, - "ValueImportanceItems": { - "$ref": "#/definitions/ValueImportanceItems" - } - }, - "type": "object" - }, - "RoleArn": { - "description": "Role Arn", - "maxLength": 1284, - "minLength": 1, - "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", - "type": "string" - }, - "Search": { - "additionalProperties": false, - "properties": { - "Displayable": { - "type": "boolean" - }, - "Facetable": { - "type": "boolean" - }, - "Searchable": { - "type": "boolean" - }, - "Sortable": { - "type": "boolean" - } - }, - "type": "object" - }, - "ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - } - }, - "type": "object" - }, - "StorageCapacityUnits": { - "minimum": 0, - "type": "integer" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Kendra resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "description": "List of tags", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - }, - "Url": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?|ftp|file):\\/\\/([^\\s]*)", - "type": "string" - }, - "UserContextPolicy": { - "enum": [ - "ATTRIBUTE_FILTER", - "USER_TOKEN" - ], - "type": "string" - }, - "UserNameAttributeField": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "UserTokenConfiguration": { - "additionalProperties": false, - "properties": { - "JsonTokenTypeConfiguration": { - "$ref": "#/definitions/JsonTokenTypeConfiguration" - }, - "JwtTokenTypeConfiguration": { - "$ref": "#/definitions/JwtTokenTypeConfiguration" - } - }, - "type": "object" - }, - "UserTokenConfigurationList": { - "items": { - "$ref": "#/definitions/UserTokenConfiguration" - }, - "maxItems": 1, - "type": "array" - }, - "ValueImportanceItem": { - "additionalProperties": false, - "properties": { - "Key": { - "$ref": "#/definitions/ValueImportanceItemKey" - }, - "Value": { - "$ref": "#/definitions/Importance" - } - }, - "type": "object" - }, - "ValueImportanceItemKey": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ValueImportanceItems": { - "items": { - "$ref": "#/definitions/ValueImportanceItem" - }, - "type": "array" - } - }, - "description": "A Kendra index", - "handlers": { - "create": { - "permissions": [ - "kendra:CreateIndex", - "kendra:DescribeIndex", - "kendra:UpdateIndex", - "kendra:ListTagsForResource", - "iam:PassRole", - "kendra:TagResource" - ], - "timeoutInMinutes": 240 - }, - "delete": { - "permissions": [ - "kendra:DescribeIndex", - "kendra:DeleteIndex" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "kendra:ListIndices" - ] - }, - "read": { - "permissions": [ - "kendra:DescribeIndex", - "kendra:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kendra:DescribeIndex", - "kendra:UpdateIndex", - "kendra:ListTagsForResource", - "kendra:TagResource", - "kendra:UntagResource", - "iam:PassRole" - ], - "timeoutInMinutes": 240 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CapacityUnits": { - "$ref": "#/definitions/CapacityUnitsConfiguration", - "description": "Capacity units" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "A description for the index" - }, - "DocumentMetadataConfigurations": { - "$ref": "#/definitions/DocumentMetadataConfigurationList", - "description": "Document metadata configurations" - }, - "Edition": { - "$ref": "#/definitions/Edition" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/ServerSideEncryptionConfiguration", - "description": "Server side encryption configuration" - }, - "Tags": { - "$ref": "#/definitions/TagList", - "description": "Tags for labeling the index" - }, - "UserContextPolicy": { - "$ref": "#/definitions/UserContextPolicy" - }, - "UserTokenConfigurations": { - "$ref": "#/definitions/UserTokenConfigurationList" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "RoleArn", - "Edition" - ], - "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html", - "typeName": "AWS::Kendra::Index" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Edition", + "/properties/ServerSideEncryptionConfiguration" + ], + "definitions": { + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "CapacityUnitsConfiguration": { + "additionalProperties": false, + "properties": { + "QueryCapacityUnits": { + "$ref": "#/definitions/QueryCapacityUnits" + }, + "StorageCapacityUnits": { + "$ref": "#/definitions/StorageCapacityUnits" + } + }, + "required": [ + "StorageCapacityUnits", + "QueryCapacityUnits" + ], + "type": "object" + }, + "ClaimRegex": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Description": { + "maxLength": 1000, + "type": "string" + }, + "DocumentAttributeValueType": { + "enum": [ + "STRING_VALUE", + "STRING_LIST_VALUE", + "LONG_VALUE", + "DATE_VALUE" + ], + "type": "string" + }, + "DocumentMetadataConfiguration": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/DocumentMetadataConfigurationName" + }, + "Relevance": { + "$ref": "#/definitions/Relevance" + }, + "Search": { + "$ref": "#/definitions/Search" + }, + "Type": { + "$ref": "#/definitions/DocumentAttributeValueType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "DocumentMetadataConfigurationList": { + "items": { + "$ref": "#/definitions/DocumentMetadataConfiguration" + }, + "maxItems": 500, + "type": "array" + }, + "DocumentMetadataConfigurationName": { + "maxLength": 30, + "minLength": 1, + "type": "string" + }, + "Duration": { + "maxLength": 10, + "minLength": 1, + "pattern": "[0-9]+[s]", + "type": "string" + }, + "Edition": { + "description": "Edition of index", + "enum": [ + "DEVELOPER_EDITION", + "ENTERPRISE_EDITION" + ], + "type": "string" + }, + "Freshness": { + "type": "boolean" + }, + "GroupAttributeField": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "Unique ID of index", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "Importance": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "Issuer": { + "maxLength": 65, + "minLength": 1, + "type": "string" + }, + "JsonTokenTypeConfiguration": { + "additionalProperties": false, + "properties": { + "GroupAttributeField": { + "$ref": "#/definitions/GroupAttributeField" + }, + "UserNameAttributeField": { + "$ref": "#/definitions/UserNameAttributeField" + } + }, + "required": [ + "UserNameAttributeField", + "GroupAttributeField" + ], + "type": "object" + }, + "JwtTokenTypeConfiguration": { + "additionalProperties": false, + "properties": { + "ClaimRegex": { + "$ref": "#/definitions/ClaimRegex" + }, + "GroupAttributeField": { + "$ref": "#/definitions/GroupAttributeField" + }, + "Issuer": { + "$ref": "#/definitions/Issuer" + }, + "KeyLocation": { + "$ref": "#/definitions/KeyLocation" + }, + "SecretManagerArn": { + "$ref": "#/definitions/RoleArn" + }, + "URL": { + "$ref": "#/definitions/Url" + }, + "UserNameAttributeField": { + "$ref": "#/definitions/UserNameAttributeField" + } + }, + "required": [ + "KeyLocation" + ], + "type": "object" + }, + "KeyLocation": { + "enum": [ + "URL", + "SECRET_MANAGER" + ], + "type": "string" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name of index", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Order": { + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "type": "string" + }, + "QueryCapacityUnits": { + "minimum": 0, + "type": "integer" + }, + "Relevance": { + "additionalProperties": false, + "properties": { + "Duration": { + "$ref": "#/definitions/Duration" + }, + "Freshness": { + "$ref": "#/definitions/Freshness" + }, + "Importance": { + "$ref": "#/definitions/Importance" + }, + "RankOrder": { + "$ref": "#/definitions/Order" + }, + "ValueImportanceItems": { + "$ref": "#/definitions/ValueImportanceItems" + } + }, + "type": "object" + }, + "RoleArn": { + "description": "Role Arn", + "maxLength": 1284, + "minLength": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", + "type": "string" + }, + "Search": { + "additionalProperties": false, + "properties": { + "Displayable": { + "type": "boolean" + }, + "Facetable": { + "type": "boolean" + }, + "Searchable": { + "type": "boolean" + }, + "Sortable": { + "type": "boolean" + } + }, + "type": "object" + }, + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + } + }, + "type": "object" + }, + "StorageCapacityUnits": { + "minimum": 0, + "type": "integer" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Kendra resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "description": "List of tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + }, + "Url": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file):\\/\\/([^\\s]*)", + "type": "string" + }, + "UserContextPolicy": { + "enum": [ + "ATTRIBUTE_FILTER", + "USER_TOKEN" + ], + "type": "string" + }, + "UserNameAttributeField": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "UserTokenConfiguration": { + "additionalProperties": false, + "properties": { + "JsonTokenTypeConfiguration": { + "$ref": "#/definitions/JsonTokenTypeConfiguration" + }, + "JwtTokenTypeConfiguration": { + "$ref": "#/definitions/JwtTokenTypeConfiguration" + } + }, + "type": "object" + }, + "UserTokenConfigurationList": { + "items": { + "$ref": "#/definitions/UserTokenConfiguration" + }, + "maxItems": 1, + "type": "array" + }, + "ValueImportanceItem": { + "additionalProperties": false, + "properties": { + "Key": { + "$ref": "#/definitions/ValueImportanceItemKey" + }, + "Value": { + "$ref": "#/definitions/Importance" + } + }, + "type": "object" + }, + "ValueImportanceItemKey": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ValueImportanceItems": { + "items": { + "$ref": "#/definitions/ValueImportanceItem" + }, + "type": "array" + } + }, + "description": "A Kendra index", + "handlers": { + "create": { + "permissions": [ + "kendra:CreateIndex", + "kendra:DescribeIndex", + "kendra:UpdateIndex", + "kendra:ListTagsForResource", + "iam:PassRole", + "kendra:TagResource" + ], + "timeoutInMinutes": 240 + }, + "delete": { + "permissions": [ + "kendra:DescribeIndex", + "kendra:DeleteIndex" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "kendra:ListIndices" + ] + }, + "read": { + "permissions": [ + "kendra:DescribeIndex", + "kendra:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kendra:DescribeIndex", + "kendra:UpdateIndex", + "kendra:ListTagsForResource", + "kendra:TagResource", + "kendra:UntagResource", + "iam:PassRole" + ], + "timeoutInMinutes": 240 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CapacityUnits": { + "$ref": "#/definitions/CapacityUnitsConfiguration", + "description": "Capacity units" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "A description for the index" + }, + "DocumentMetadataConfigurations": { + "$ref": "#/definitions/DocumentMetadataConfigurationList", + "description": "Document metadata configurations" + }, + "Edition": { + "$ref": "#/definitions/Edition" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration", + "description": "Server side encryption configuration" + }, + "Tags": { + "$ref": "#/definitions/TagList", + "description": "Tags for labeling the index" + }, + "UserContextPolicy": { + "$ref": "#/definitions/UserContextPolicy" + }, + "UserTokenConfigurations": { + "$ref": "#/definitions/UserTokenConfigurationList" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "RoleArn", + "Edition" + ], + "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html", + "typeName": "AWS::Kendra::Index" +} diff --git a/schema/aws-kendraranking-executionplan.json b/schema/aws-kendraranking-executionplan.json index 6d3f56b..39f25c7 100644 --- a/schema/aws-kendraranking-executionplan.json +++ b/schema/aws-kendraranking-executionplan.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "definitions": { - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "CapacityUnitsConfiguration": { - "additionalProperties": false, - "properties": { - "RescoreCapacityUnits": { - "$ref": "#/definitions/RescoreCapacityUnits" - } - }, - "required": [ - "RescoreCapacityUnits" - ], - "type": "object" - }, - "Description": { - "maxLength": 1000, - "type": "string" - }, - "Id": { - "description": "Unique ID of rescore execution plan", - "maxLength": 36, - "minLength": 36, - "type": "string" - }, - "Name": { - "description": "Name of kendra ranking rescore execution plan", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "RescoreCapacityUnits": { - "minimum": 0, - "type": "integer" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging KendraRanking resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "List of tags", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "description": "A KendraRanking Rescore execution plan", - "handlers": { - "create": { - "permissions": [ - "kendra-ranking:CreateRescoreExecutionPlan", - "kendra-ranking:DescribeRescoreExecutionPlan", - "kendra-ranking:UpdateRescoreExecutionPlan", - "kendra-ranking:ListTagsForResource", - "kendra-ranking:TagResource" - ], - "timeoutInMinutes": 240 - }, - "delete": { - "permissions": [ - "kendra-ranking:DescribeRescoreExecutionPlan", - "kendra-ranking:DeleteRescoreExecutionPlan" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "kendra-ranking:ListRescoreExecutionPlans" - ] - }, - "read": { - "permissions": [ - "kendra-ranking:DescribeRescoreExecutionPlan", - "kendra-ranking:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kendra-ranking:DescribeRescoreExecutionPlan", - "kendra-ranking:UpdateRescoreExecutionPlan", - "kendra-ranking:ListTagsForResource", - "kendra-ranking:TagResource", - "kendra-ranking:UntagResource" - ], - "timeoutInMinutes": 240 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CapacityUnits": { - "$ref": "#/definitions/CapacityUnitsConfiguration", - "description": "Capacity units" - }, - "Description": { - "$ref": "#/definitions/Description", - "description": "A description for the execution plan" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "Tags for labeling the execution plan" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::KendraRanking::ExecutionPlan" -} +{ + "additionalProperties": false, + "definitions": { + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "CapacityUnitsConfiguration": { + "additionalProperties": false, + "properties": { + "RescoreCapacityUnits": { + "$ref": "#/definitions/RescoreCapacityUnits" + } + }, + "required": [ + "RescoreCapacityUnits" + ], + "type": "object" + }, + "Description": { + "maxLength": 1000, + "type": "string" + }, + "Id": { + "description": "Unique ID of rescore execution plan", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "Name": { + "description": "Name of kendra ranking rescore execution plan", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "RescoreCapacityUnits": { + "minimum": 0, + "type": "integer" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging KendraRanking resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "List of tags", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "description": "A KendraRanking Rescore execution plan", + "handlers": { + "create": { + "permissions": [ + "kendra-ranking:CreateRescoreExecutionPlan", + "kendra-ranking:DescribeRescoreExecutionPlan", + "kendra-ranking:UpdateRescoreExecutionPlan", + "kendra-ranking:ListTagsForResource", + "kendra-ranking:TagResource" + ], + "timeoutInMinutes": 240 + }, + "delete": { + "permissions": [ + "kendra-ranking:DescribeRescoreExecutionPlan", + "kendra-ranking:DeleteRescoreExecutionPlan" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "kendra-ranking:ListRescoreExecutionPlans" + ] + }, + "read": { + "permissions": [ + "kendra-ranking:DescribeRescoreExecutionPlan", + "kendra-ranking:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kendra-ranking:DescribeRescoreExecutionPlan", + "kendra-ranking:UpdateRescoreExecutionPlan", + "kendra-ranking:ListTagsForResource", + "kendra-ranking:TagResource", + "kendra-ranking:UntagResource" + ], + "timeoutInMinutes": 240 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CapacityUnits": { + "$ref": "#/definitions/CapacityUnitsConfiguration", + "description": "Capacity units" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "A description for the execution plan" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "Tags for labeling the execution plan" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::KendraRanking::ExecutionPlan" +} diff --git a/schema/aws-kinesis-stream.json b/schema/aws-kinesis-stream.json index 75a721c..5773af3 100644 --- a/schema/aws-kinesis-stream.json +++ b/schema/aws-kinesis-stream.json @@ -1,195 +1,195 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "StreamEncryption": { - "additionalProperties": false, - "description": "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.", - "properties": { - "EncryptionType": { - "description": "The encryption type to use. The only valid value is KMS. ", - "enum": [ - "KMS" - ], - "type": "string" - }, - "KeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - } - ], - "description": "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "EncryptionType", - "KeyId" - ], - "type": "object" - }, - "StreamModeDetails": { - "additionalProperties": false, - "description": "When specified, enables or updates the mode of stream. Default is PROVISIONED.", - "properties": { - "StreamMode": { - "description": "The mode of the stream", - "enum": [ - "ON_DEMAND", - "PROVISIONED" - ], - "type": "string" - } - }, - "required": [ - "StreamMode" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Kinesis::Stream", - "handlers": { - "create": { - "permissions": [ - "kinesis:EnableEnhancedMonitoring", - "kinesis:DescribeStreamSummary", - "kinesis:CreateStream", - "kinesis:IncreaseStreamRetentionPeriod", - "kinesis:StartStreamEncryption", - "kinesis:AddTagsToStream", - "kinesis:ListTagsForStream" - ] - }, - "delete": { - "permissions": [ - "kinesis:DescribeStreamSummary", - "kinesis:DeleteStream", - "kinesis:RemoveTagsFromStream" - ] - }, - "list": { - "permissions": [ - "kinesis:ListStreams" - ] - }, - "read": { - "permissions": [ - "kinesis:DescribeStreamSummary", - "kinesis:ListTagsForStream" - ] - }, - "update": { - "permissions": [ - "kinesis:EnableEnhancedMonitoring", - "kinesis:DisableEnhancedMonitoring", - "kinesis:DescribeStreamSummary", - "kinesis:UpdateShardCount", - "kinesis:UpdateStreamMode", - "kinesis:IncreaseStreamRetentionPeriod", - "kinesis:DecreaseStreamRetentionPeriod", - "kinesis:StartStreamEncryption", - "kinesis:StopStreamEncryption", - "kinesis:AddTagsToStream", - "kinesis:RemoveTagsFromStream", - "kinesis:ListTagsForStream" - ], - "timeoutInMinutes": 240 - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon resource name (ARN) of the Kinesis stream", - "type": "string" - }, - "Name": { - "description": "The name of the Kinesis stream.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "RetentionPeriodHours": { - "description": "The number of hours for the data records that are stored in shards to remain accessible.", - "minimum": 24, - "type": "integer" - }, - "ShardCount": { - "description": "The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.", - "minimum": 1, - "type": "integer" - }, - "StreamEncryption": { - "$ref": "#/definitions/StreamEncryption", - "description": "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream." - }, - "StreamModeDetails": { - "$ref": "#/definitions/StreamModeDetails", - "default": { - "StreamMode": "PROVISIONED" - }, - "description": "The mode in which the stream is running." - }, - "Tags": { - "description": "An arbitrary set of tags (key\u2013value pairs) to associate with the Kinesis stream.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesis.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Kinesis::Stream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "StreamEncryption": { + "additionalProperties": false, + "description": "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.", + "properties": { + "EncryptionType": { + "description": "The encryption type to use. The only valid value is KMS. ", + "enum": [ + "KMS" + ], + "type": "string" + }, + "KeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], + "description": "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "EncryptionType", + "KeyId" + ], + "type": "object" + }, + "StreamModeDetails": { + "additionalProperties": false, + "description": "When specified, enables or updates the mode of stream. Default is PROVISIONED.", + "properties": { + "StreamMode": { + "description": "The mode of the stream", + "enum": [ + "ON_DEMAND", + "PROVISIONED" + ], + "type": "string" + } + }, + "required": [ + "StreamMode" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Kinesis::Stream", + "handlers": { + "create": { + "permissions": [ + "kinesis:EnableEnhancedMonitoring", + "kinesis:DescribeStreamSummary", + "kinesis:CreateStream", + "kinesis:IncreaseStreamRetentionPeriod", + "kinesis:StartStreamEncryption", + "kinesis:AddTagsToStream", + "kinesis:ListTagsForStream" + ] + }, + "delete": { + "permissions": [ + "kinesis:DescribeStreamSummary", + "kinesis:DeleteStream", + "kinesis:RemoveTagsFromStream" + ] + }, + "list": { + "permissions": [ + "kinesis:ListStreams" + ] + }, + "read": { + "permissions": [ + "kinesis:DescribeStreamSummary", + "kinesis:ListTagsForStream" + ] + }, + "update": { + "permissions": [ + "kinesis:EnableEnhancedMonitoring", + "kinesis:DisableEnhancedMonitoring", + "kinesis:DescribeStreamSummary", + "kinesis:UpdateShardCount", + "kinesis:UpdateStreamMode", + "kinesis:IncreaseStreamRetentionPeriod", + "kinesis:DecreaseStreamRetentionPeriod", + "kinesis:StartStreamEncryption", + "kinesis:StopStreamEncryption", + "kinesis:AddTagsToStream", + "kinesis:RemoveTagsFromStream", + "kinesis:ListTagsForStream" + ], + "timeoutInMinutes": 240 + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon resource name (ARN) of the Kinesis stream", + "type": "string" + }, + "Name": { + "description": "The name of the Kinesis stream.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "RetentionPeriodHours": { + "description": "The number of hours for the data records that are stored in shards to remain accessible.", + "minimum": 24, + "type": "integer" + }, + "ShardCount": { + "description": "The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.", + "minimum": 1, + "type": "integer" + }, + "StreamEncryption": { + "$ref": "#/definitions/StreamEncryption", + "description": "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream." + }, + "StreamModeDetails": { + "$ref": "#/definitions/StreamModeDetails", + "default": { + "StreamMode": "PROVISIONED" + }, + "description": "The mode in which the stream is running." + }, + "Tags": { + "description": "An arbitrary set of tags (key\u2013value pairs) to associate with the Kinesis stream.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesis.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Kinesis::Stream" +} diff --git a/schema/aws-kinesis-streamconsumer.json b/schema/aws-kinesis-streamconsumer.json index 486b1b0..233b8e8 100644 --- a/schema/aws-kinesis-streamconsumer.json +++ b/schema/aws-kinesis-streamconsumer.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConsumerName", - "/properties/StreamARN" - ], - "description": "Resource Type definition for AWS::Kinesis::StreamConsumer", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConsumerARN": { - "type": "string" - }, - "ConsumerCreationTimestamp": { - "type": "string" - }, - "ConsumerName": { - "type": "string" - }, - "ConsumerStatus": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "StreamARN": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ConsumerStatus", - "/properties/ConsumerARN", - "/properties/ConsumerCreationTimestamp", - "/properties/Id" - ], - "required": [ - "ConsumerName", - "StreamARN" - ], - "typeName": "AWS::Kinesis::StreamConsumer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConsumerName", + "/properties/StreamARN" + ], + "description": "Resource Type definition for AWS::Kinesis::StreamConsumer", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConsumerARN": { + "type": "string" + }, + "ConsumerCreationTimestamp": { + "type": "string" + }, + "ConsumerName": { + "type": "string" + }, + "ConsumerStatus": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "StreamARN": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ConsumerStatus", + "/properties/ConsumerARN", + "/properties/ConsumerCreationTimestamp", + "/properties/Id" + ], + "required": [ + "ConsumerName", + "StreamARN" + ], + "typeName": "AWS::Kinesis::StreamConsumer" +} diff --git a/schema/aws-kinesisanalytics-application.json b/schema/aws-kinesisanalytics-application.json index 9a5cd6d..3b61938 100644 --- a/schema/aws-kinesisanalytics-application.json +++ b/schema/aws-kinesisanalytics-application.json @@ -1,231 +1,231 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "Input": { - "additionalProperties": false, - "properties": { - "InputParallelism": { - "$ref": "#/definitions/InputParallelism" - }, - "InputProcessingConfiguration": { - "$ref": "#/definitions/InputProcessingConfiguration" - }, - "InputSchema": { - "$ref": "#/definitions/InputSchema" - }, - "KinesisFirehoseInput": { - "$ref": "#/definitions/KinesisFirehoseInput" - }, - "KinesisStreamsInput": { - "$ref": "#/definitions/KinesisStreamsInput" - }, - "NamePrefix": { - "type": "string" - } - }, - "required": [ - "NamePrefix", - "InputSchema" - ], - "type": "object" - }, - "InputLambdaProcessor": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "InputParallelism": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "integer" - } - }, - "type": "object" - }, - "InputProcessingConfiguration": { - "additionalProperties": false, - "properties": { - "InputLambdaProcessor": { - "$ref": "#/definitions/InputLambdaProcessor" - } - }, - "type": "object" - }, - "InputSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/RecordColumn" - }, - "type": "array", - "uniqueItems": false - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "KinesisFirehoseInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "KinesisStreamsInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/JSONMappingParameters" - } - }, - "type": "object" - }, - "RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "SqlType", - "Name" - ], - "type": "object" - }, - "RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalytics::Application", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationCode": { - "type": "string" - }, - "ApplicationDescription": { - "type": "string" - }, - "ApplicationName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Inputs": { - "items": { - "$ref": "#/definitions/Input" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Inputs" - ], - "typeName": "AWS::KinesisAnalytics::Application" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "CSVMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordColumnDelimiter": { + "type": "string" + }, + "RecordRowDelimiter": { + "type": "string" + } + }, + "required": [ + "RecordColumnDelimiter", + "RecordRowDelimiter" + ], + "type": "object" + }, + "Input": { + "additionalProperties": false, + "properties": { + "InputParallelism": { + "$ref": "#/definitions/InputParallelism" + }, + "InputProcessingConfiguration": { + "$ref": "#/definitions/InputProcessingConfiguration" + }, + "InputSchema": { + "$ref": "#/definitions/InputSchema" + }, + "KinesisFirehoseInput": { + "$ref": "#/definitions/KinesisFirehoseInput" + }, + "KinesisStreamsInput": { + "$ref": "#/definitions/KinesisStreamsInput" + }, + "NamePrefix": { + "type": "string" + } + }, + "required": [ + "NamePrefix", + "InputSchema" + ], + "type": "object" + }, + "InputLambdaProcessor": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "InputParallelism": { + "additionalProperties": false, + "properties": { + "Count": { + "type": "integer" + } + }, + "type": "object" + }, + "InputProcessingConfiguration": { + "additionalProperties": false, + "properties": { + "InputLambdaProcessor": { + "$ref": "#/definitions/InputLambdaProcessor" + } + }, + "type": "object" + }, + "InputSchema": { + "additionalProperties": false, + "properties": { + "RecordColumns": { + "items": { + "$ref": "#/definitions/RecordColumn" + }, + "type": "array", + "uniqueItems": false + }, + "RecordEncoding": { + "type": "string" + }, + "RecordFormat": { + "$ref": "#/definitions/RecordFormat" + } + }, + "required": [ + "RecordColumns", + "RecordFormat" + ], + "type": "object" + }, + "JSONMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordRowPath": { + "type": "string" + } + }, + "required": [ + "RecordRowPath" + ], + "type": "object" + }, + "KinesisFirehoseInput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "KinesisStreamsInput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "MappingParameters": { + "additionalProperties": false, + "properties": { + "CSVMappingParameters": { + "$ref": "#/definitions/CSVMappingParameters" + }, + "JSONMappingParameters": { + "$ref": "#/definitions/JSONMappingParameters" + } + }, + "type": "object" + }, + "RecordColumn": { + "additionalProperties": false, + "properties": { + "Mapping": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SqlType": { + "type": "string" + } + }, + "required": [ + "SqlType", + "Name" + ], + "type": "object" + }, + "RecordFormat": { + "additionalProperties": false, + "properties": { + "MappingParameters": { + "$ref": "#/definitions/MappingParameters" + }, + "RecordFormatType": { + "type": "string" + } + }, + "required": [ + "RecordFormatType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalytics::Application", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationCode": { + "type": "string" + }, + "ApplicationDescription": { + "type": "string" + }, + "ApplicationName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Inputs": { + "items": { + "$ref": "#/definitions/Input" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Inputs" + ], + "typeName": "AWS::KinesisAnalytics::Application" +} diff --git a/schema/aws-kinesisanalytics-applicationoutput.json b/schema/aws-kinesisanalytics-applicationoutput.json index 94e264d..67d1840 100644 --- a/schema/aws-kinesisanalytics-applicationoutput.json +++ b/schema/aws-kinesisanalytics-applicationoutput.json @@ -1,112 +1,112 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "DestinationSchema": { - "additionalProperties": false, - "properties": { - "RecordFormatType": { - "type": "string" - } - }, - "type": "object" - }, - "KinesisFirehoseOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "KinesisStreamsOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "LambdaOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "Output": { - "additionalProperties": false, - "properties": { - "DestinationSchema": { - "$ref": "#/definitions/DestinationSchema" - }, - "KinesisFirehoseOutput": { - "$ref": "#/definitions/KinesisFirehoseOutput" - }, - "KinesisStreamsOutput": { - "$ref": "#/definitions/KinesisStreamsOutput" - }, - "LambdaOutput": { - "$ref": "#/definitions/LambdaOutput" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DestinationSchema" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalytics::ApplicationOutput", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Output": { - "$ref": "#/definitions/Output" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationName", - "Output" - ], - "typeName": "AWS::KinesisAnalytics::ApplicationOutput" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "DestinationSchema": { + "additionalProperties": false, + "properties": { + "RecordFormatType": { + "type": "string" + } + }, + "type": "object" + }, + "KinesisFirehoseOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "KinesisStreamsOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "LambdaOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + }, + "RoleARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN", + "RoleARN" + ], + "type": "object" + }, + "Output": { + "additionalProperties": false, + "properties": { + "DestinationSchema": { + "$ref": "#/definitions/DestinationSchema" + }, + "KinesisFirehoseOutput": { + "$ref": "#/definitions/KinesisFirehoseOutput" + }, + "KinesisStreamsOutput": { + "$ref": "#/definitions/KinesisStreamsOutput" + }, + "LambdaOutput": { + "$ref": "#/definitions/LambdaOutput" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "DestinationSchema" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalytics::ApplicationOutput", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Output": { + "$ref": "#/definitions/Output" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationName", + "Output" + ], + "typeName": "AWS::KinesisAnalytics::ApplicationOutput" +} diff --git a/schema/aws-kinesisanalytics-applicationreferencedatasource.json b/schema/aws-kinesisanalytics-applicationreferencedatasource.json index fa31204..f90c25a 100644 --- a/schema/aws-kinesisanalytics-applicationreferencedatasource.json +++ b/schema/aws-kinesisanalytics-applicationreferencedatasource.json @@ -1,166 +1,166 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/JSONMappingParameters" - } - }, - "type": "object" - }, - "RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "SqlType", - "Name" - ], - "type": "object" - }, - "RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "ReferenceSchema": { - "$ref": "#/definitions/ReferenceSchema" - }, - "S3ReferenceDataSource": { - "$ref": "#/definitions/S3ReferenceDataSource" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "ReferenceSchema" - ], - "type": "object" - }, - "ReferenceSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/RecordColumn" - }, - "type": "array", - "uniqueItems": false - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "S3ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "FileKey": { - "type": "string" - }, - "ReferenceRoleARN": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "FileKey", - "ReferenceRoleARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalytics::ApplicationReferenceDataSource", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ReferenceDataSource": { - "$ref": "#/definitions/ReferenceDataSource" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ReferenceDataSource", - "ApplicationName" - ], - "typeName": "AWS::KinesisAnalytics::ApplicationReferenceDataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "CSVMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordColumnDelimiter": { + "type": "string" + }, + "RecordRowDelimiter": { + "type": "string" + } + }, + "required": [ + "RecordColumnDelimiter", + "RecordRowDelimiter" + ], + "type": "object" + }, + "JSONMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordRowPath": { + "type": "string" + } + }, + "required": [ + "RecordRowPath" + ], + "type": "object" + }, + "MappingParameters": { + "additionalProperties": false, + "properties": { + "CSVMappingParameters": { + "$ref": "#/definitions/CSVMappingParameters" + }, + "JSONMappingParameters": { + "$ref": "#/definitions/JSONMappingParameters" + } + }, + "type": "object" + }, + "RecordColumn": { + "additionalProperties": false, + "properties": { + "Mapping": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SqlType": { + "type": "string" + } + }, + "required": [ + "SqlType", + "Name" + ], + "type": "object" + }, + "RecordFormat": { + "additionalProperties": false, + "properties": { + "MappingParameters": { + "$ref": "#/definitions/MappingParameters" + }, + "RecordFormatType": { + "type": "string" + } + }, + "required": [ + "RecordFormatType" + ], + "type": "object" + }, + "ReferenceDataSource": { + "additionalProperties": false, + "properties": { + "ReferenceSchema": { + "$ref": "#/definitions/ReferenceSchema" + }, + "S3ReferenceDataSource": { + "$ref": "#/definitions/S3ReferenceDataSource" + }, + "TableName": { + "type": "string" + } + }, + "required": [ + "ReferenceSchema" + ], + "type": "object" + }, + "ReferenceSchema": { + "additionalProperties": false, + "properties": { + "RecordColumns": { + "items": { + "$ref": "#/definitions/RecordColumn" + }, + "type": "array", + "uniqueItems": false + }, + "RecordEncoding": { + "type": "string" + }, + "RecordFormat": { + "$ref": "#/definitions/RecordFormat" + } + }, + "required": [ + "RecordColumns", + "RecordFormat" + ], + "type": "object" + }, + "S3ReferenceDataSource": { + "additionalProperties": false, + "properties": { + "BucketARN": { + "type": "string" + }, + "FileKey": { + "type": "string" + }, + "ReferenceRoleARN": { + "type": "string" + } + }, + "required": [ + "BucketARN", + "FileKey", + "ReferenceRoleARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalytics::ApplicationReferenceDataSource", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ReferenceDataSource": { + "$ref": "#/definitions/ReferenceDataSource" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ReferenceDataSource", + "ApplicationName" + ], + "typeName": "AWS::KinesisAnalytics::ApplicationReferenceDataSource" +} diff --git a/schema/aws-kinesisanalyticsv2-application.json b/schema/aws-kinesisanalyticsv2-application.json index 559c2fa..f881421 100644 --- a/schema/aws-kinesisanalyticsv2-application.json +++ b/schema/aws-kinesisanalyticsv2-application.json @@ -1,1001 +1,1001 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName", - "/properties/ApplicationMode" - ], - "definitions": { - "ApplicationCodeConfiguration": { - "additionalProperties": false, - "description": "Describes code configuration for an application.", - "properties": { - "CodeContent": { - "$ref": "#/definitions/CodeContent", - "description": "The location and type of the application code." - }, - "CodeContentType": { - "description": "Specifies whether the code content is in text or zip format.", - "enum": [ - "PLAINTEXT", - "ZIPFILE" - ], - "type": "string" - } - }, - "required": [ - "CodeContentType", - "CodeContent" - ], - "type": "object" - }, - "ApplicationConfiguration": { - "additionalProperties": false, - "description": "Specifies the creation parameters for a Kinesis Data Analytics application.", - "properties": { - "ApplicationCodeConfiguration": { - "$ref": "#/definitions/ApplicationCodeConfiguration", - "description": "The code location and type parameters for a Flink-based Kinesis Data Analytics application." - }, - "ApplicationSnapshotConfiguration": { - "$ref": "#/definitions/ApplicationSnapshotConfiguration", - "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." - }, - "ApplicationSystemRollbackConfiguration": { - "$ref": "#/definitions/ApplicationSystemRollbackConfiguration", - "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." - }, - "EnvironmentProperties": { - "$ref": "#/definitions/EnvironmentProperties", - "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." - }, - "FlinkApplicationConfiguration": { - "$ref": "#/definitions/FlinkApplicationConfiguration", - "description": "The creation and update parameters for a Flink-based Kinesis Data Analytics application." - }, - "SqlApplicationConfiguration": { - "$ref": "#/definitions/SqlApplicationConfiguration", - "description": "The creation and update parameters for a SQL-based Kinesis Data Analytics application." - }, - "VpcConfigurations": { - "$ref": "#/definitions/VpcConfigurations", - "description": "The array of descriptions of VPC configurations available to the application." - }, - "ZeppelinApplicationConfiguration": { - "$ref": "#/definitions/ZeppelinApplicationConfiguration", - "description": "The configuration parameters for a Kinesis Data Analytics Studio notebook." - } - }, - "type": "object" - }, - "ApplicationMaintenanceConfiguration": { - "additionalProperties": false, - "description": "Describes the maintenance configuration for the application.", - "properties": { - "ApplicationMaintenanceWindowStartTime": { - "description": "The start time for the maintenance window.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - } - }, - "required": [ - "ApplicationMaintenanceWindowStartTime" - ], - "type": "object" - }, - "ApplicationRestoreConfiguration": { - "additionalProperties": false, - "description": "Describes the restore behavior of a restarting application.", - "properties": { - "ApplicationRestoreType": { - "description": "Specifies how the application should be restored.", - "enum": [ - "SKIP_RESTORE_FROM_SNAPSHOT", - "RESTORE_FROM_LATEST_SNAPSHOT", - "RESTORE_FROM_CUSTOM_SNAPSHOT" - ], - "type": "string" - }, - "SnapshotName": { - "description": "The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - } - }, - "required": [ - "ApplicationRestoreType" - ], - "type": "object" - }, - "ApplicationSnapshotConfiguration": { - "additionalProperties": false, - "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.", - "properties": { - "SnapshotsEnabled": { - "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.", - "type": "boolean" - } - }, - "required": [ - "SnapshotsEnabled" - ], - "type": "object" - }, - "ApplicationSystemRollbackConfiguration": { - "additionalProperties": false, - "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", - "properties": { - "RollbackEnabled": { - "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", - "type": "boolean" - } - }, - "required": [ - "RollbackEnabled" - ], - "type": "object" - }, - "Arn": { - "description": "The Amazon Resource Name", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:.*$", - "type": "string" - }, - "CSVMappingParameters": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`", - "properties": { - "RecordColumnDelimiter": { - "description": "The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "RecordRowDelimiter": { - "description": "The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "RecordRowDelimiter", - "RecordColumnDelimiter" - ], - "type": "object" - }, - "CatalogConfiguration": { - "additionalProperties": false, - "description": "The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.", - "properties": { - "GlueDataCatalogConfiguration": { - "$ref": "#/definitions/GlueDataCatalogConfiguration", - "description": "The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook." - } - }, - "type": "object" - }, - "CheckpointConfiguration": { - "additionalProperties": false, - "description": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.", - "properties": { - "CheckpointInterval": { - "description": "Describes the interval in milliseconds between checkpoint operations.", - "format": "int64", - "maximum": 9223372036854775807, - "minimum": 1, - "type": "integer" - }, - "CheckpointingEnabled": { - "description": "Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.", - "type": "boolean" - }, - "ConfigurationType": { - "description": "Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters.", - "enum": [ - "DEFAULT", - "CUSTOM" - ], - "type": "string" - }, - "MinPauseBetweenCheckpoints": { - "description": "Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.", - "format": "int64", - "maximum": 9223372036854775807, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "CodeContent": { - "additionalProperties": false, - "description": "Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.", - "properties": { - "S3ContentLocation": { - "$ref": "#/definitions/S3ContentLocation", - "description": "Information about the Amazon S3 bucket that contains the application code." - }, - "TextContent": { - "description": "The text-format code for a Flink-based Kinesis Data Analytics application.", - "maxLength": 102400, - "minLength": 1, - "type": "string" - }, - "ZipFileContent": { - "description": "The zip-format code for a Flink-based Kinesis Data Analytics application.", - "type": "string" - } - }, - "type": "object" - }, - "CustomArtifactConfiguration": { - "additionalProperties": false, - "description": "The configuration of connectors and user-defined functions.", - "properties": { - "ArtifactType": { - "description": "Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket.", - "enum": [ - "DEPENDENCY_JAR", - "UDF" - ], - "type": "string" - }, - "MavenReference": { - "$ref": "#/definitions/MavenReference", - "description": "The parameters required to fully specify a Maven reference." - }, - "S3ContentLocation": { - "$ref": "#/definitions/S3ContentLocation", - "description": "The location of the custom artifacts." - } - }, - "required": [ - "ArtifactType" - ], - "type": "object" - }, - "CustomArtifactsConfiguration": { - "description": "A list of CustomArtifactConfiguration objects.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomArtifactConfiguration", - "description": "The configuration of connectors and user-defined functions." - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "DeployAsApplicationConfiguration": { - "additionalProperties": false, - "description": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.", - "properties": { - "S3ContentLocation": { - "$ref": "#/definitions/S3ContentBaseLocation", - "description": "The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data." - } - }, - "required": [ - "S3ContentLocation" - ], - "type": "object" - }, - "EnvironmentProperties": { - "additionalProperties": false, - "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application.", - "properties": { - "PropertyGroups": { - "description": "Describes the execution property groups.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PropertyGroup" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "FlinkApplicationConfiguration": { - "additionalProperties": false, - "description": "Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.", - "properties": { - "CheckpointConfiguration": { - "$ref": "#/definitions/CheckpointConfiguration", - "description": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation." - }, - "MonitoringConfiguration": { - "$ref": "#/definitions/MonitoringConfiguration", - "description": "Describes configuration parameters for Amazon CloudWatch logging for an application." - }, - "ParallelismConfiguration": { - "$ref": "#/definitions/ParallelismConfiguration", - "description": "Describes parameters for how an application executes multiple tasks simultaneously." - } - }, - "type": "object" - }, - "FlinkRunConfiguration": { - "additionalProperties": false, - "description": "Describes the starting parameters for a Flink-based Kinesis Data Analytics application.", - "properties": { - "AllowNonRestoredState": { - "description": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.", - "type": "boolean" - } - }, - "type": "object" - }, - "GlueDataCatalogConfiguration": { - "additionalProperties": false, - "description": "The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.", - "properties": { - "DatabaseARN": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the database." - } - }, - "type": "object" - }, - "Input": { - "additionalProperties": false, - "description": "When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.", - "properties": { - "InputParallelism": { - "$ref": "#/definitions/InputParallelism", - "description": "Describes the number of in-application streams to create." - }, - "InputProcessingConfiguration": { - "$ref": "#/definitions/InputProcessingConfiguration", - "description": "The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor." - }, - "InputSchema": { - "$ref": "#/definitions/InputSchema", - "description": "Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created." - }, - "KinesisFirehoseInput": { - "$ref": "#/definitions/KinesisFirehoseInput", - "description": "If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN." - }, - "KinesisStreamsInput": { - "$ref": "#/definitions/KinesisStreamsInput", - "description": "If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN)." - }, - "NamePrefix": { - "description": "The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `\"MyInApplicationStream\"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `\"MyInApplicationStream_001\"`, `\"MyInApplicationStream_002\"`, and so on.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[^-\\s<>&]*$", - "type": "string" - } - }, - "required": [ - "NamePrefix", - "InputSchema" - ], - "type": "object" - }, - "InputLambdaProcessor": { - "additionalProperties": false, - "description": "An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.", - "properties": { - "ResourceARN": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the Amazon Lambda function that operates on records in the stream." - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "InputParallelism": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.", - "properties": { - "Count": { - "description": "The number of in-application streams to create.", - "maximum": 64, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "InputProcessingConfiguration": { - "additionalProperties": false, - "description": "For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.", - "properties": { - "InputLambdaProcessor": { - "$ref": "#/definitions/InputLambdaProcessor", - "description": "The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code." - } - }, - "type": "object" - }, - "InputSchema": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.", - "properties": { - "RecordColumns": { - "description": "A list of `RecordColumn` objects.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RecordColumn" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": false - }, - "RecordEncoding": { - "description": "Specifies the encoding of the records in the streaming source. For example, UTF-8.", - "enum": [ - "UTF-8" - ], - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/RecordFormat", - "description": "Specifies the format of the records on the streaming source." - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "JSONMappingParameters": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.", - "properties": { - "RecordRowPath": { - "description": "The path to the top-level parent that contains the records.", - "maxLength": 65535, - "minLength": 1, - "pattern": "^(?=^\\$)(?=^\\S+$).*$", - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "KinesisFirehoseInput": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).", - "properties": { - "ResourceARN": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the delivery stream." - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "KinesisStreamsInput": { - "additionalProperties": false, - "description": "Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).", - "properties": { - "ResourceARN": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the input Kinesis data stream to read." - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "MappingParameters": { - "additionalProperties": false, - "description": "When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.", - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/CSVMappingParameters", - "description": "Provides additional mapping information when the record format uses delimiters (for example, CSV)." - }, - "JSONMappingParameters": { - "$ref": "#/definitions/JSONMappingParameters", - "description": "Provides additional mapping information when JSON is the record format on the streaming source." - } - }, - "type": "object" - }, - "MavenReference": { - "additionalProperties": false, - "description": "The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.", - "properties": { - "ArtifactId": { - "description": "The artifact ID of the Maven reference.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "GroupId": { - "description": "The group ID of the Maven reference.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "Version": { - "description": "The version of the Maven reference.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - } - }, - "required": [ - "ArtifactId", - "GroupId", - "Version" - ], - "type": "object" - }, - "MonitoringConfiguration": { - "additionalProperties": false, - "description": "Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.", - "properties": { - "ConfigurationType": { - "description": "Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.", - "enum": [ - "DEFAULT", - "CUSTOM" - ], - "type": "string" - }, - "LogLevel": { - "description": "Describes the verbosity of the CloudWatch Logs for an application.", - "enum": [ - "DEBUG", - "INFO", - "WARN", - "ERROR" - ], - "type": "string" - }, - "MetricsLevel": { - "description": "Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.", - "enum": [ - "APPLICATION", - "OPERATOR", - "PARALLELISM", - "TASK" - ], - "type": "string" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "ParallelismConfiguration": { - "additionalProperties": false, - "description": "Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation", - "properties": { - "AutoScalingEnabled": { - "description": "Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.", - "type": "boolean" - }, - "ConfigurationType": { - "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties.", - "enum": [ - "CUSTOM", - "DEFAULT" - ], - "type": "string" - }, - "Parallelism": { - "description": "Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.", - "minimum": 1, - "type": "integer" - }, - "ParallelismPerKPU": { - "description": "Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "PropertyGroup": { - "additionalProperties": false, - "description": "Property key-value pairs passed into an application.", - "properties": { - "PropertyGroupId": { - "description": "Describes the key of an application execution property key-value pair.", - "maxLength": 50, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "PropertyMap": { - "additionalProperties": false, - "description": "Describes the value of an application execution property key-value pair.", - "maxProperties": 50, - "patternProperties": { - "^.{1,2048}$": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "RecordColumn": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.\nAlso used to describe the format of the reference data source.", - "properties": { - "Mapping": { - "description": "A reference to the data element in the streaming input or the reference data source.", - "maxLength": 65535, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name of the column that is created in the in-application input stream or reference table.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[^-\\s<>&]*$", - "type": "string" - }, - "SqlType": { - "description": "The type of column created in the in-application input stream or reference table.", - "maxLength": 100, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "SqlType", - "Name" - ], - "type": "object" - }, - "RecordFormat": { - "additionalProperties": false, - "description": "For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.", - "properties": { - "MappingParameters": { - "$ref": "#/definitions/MappingParameters", - "description": "When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source." - }, - "RecordFormatType": { - "description": "The type of record format.", - "enum": [ - "CSV", - "JSON" - ], - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "RunConfiguration": { - "additionalProperties": false, - "description": "Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. This section is evaluated only on stack updates for applications in running RUNNING state and has no effect during manual application start.", - "properties": { - "ApplicationRestoreConfiguration": { - "$ref": "#/definitions/ApplicationRestoreConfiguration", - "description": "Describes the restore behavior of a restarting application." - }, - "FlinkRunConfiguration": { - "$ref": "#/definitions/FlinkRunConfiguration", - "description": "Describes the starting parameters for a Flink-based Kinesis Data Analytics application." - } - }, - "type": "object" - }, - "S3ContentBaseLocation": { - "additionalProperties": false, - "description": "The base location of the Amazon Data Analytics application.", - "properties": { - "BasePath": { - "description": "The base path for the S3 bucket.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/!-_.*'()]+$", - "type": "string" - }, - "BucketARN": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the S3 bucket." - } - }, - "required": [ - "BucketARN" - ], - "type": "object" - }, - "S3ContentLocation": { - "additionalProperties": false, - "description": "The location of an application or a custom artifact.", - "properties": { - "BucketARN": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) for the S3 bucket containing the application code." - }, - "FileKey": { - "description": "The file key for the object containing the application code.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "ObjectVersion": { - "description": "The version of the object containing the application code.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "BucketARN", - "FileKey" - ], - "type": "object" - }, - "SqlApplicationConfiguration": { - "additionalProperties": false, - "description": "Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.", - "properties": { - "Inputs": { - "description": "The array of Input objects describing the input streams used by the application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Input" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair that identifies an application.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that's 0 to 256 characters in length.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfiguration": { - "additionalProperties": false, - "description": "Describes the parameters of a VPC used by the application.", - "properties": { - "SecurityGroupIds": { - "description": "The array of SecurityGroup IDs used by the VPC configuration.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "description": "The array of Subnet IDs used by the VPC configuration.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "VpcConfigurations": { - "description": "The array of descriptions of VPC configurations available to the application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcConfiguration", - "description": "Describes the parameters of a VPC used by the application." - }, - "maxItems": 1, - "type": "array", - "uniqueItems": false - }, - "ZeppelinApplicationConfiguration": { - "additionalProperties": false, - "description": "The configuration of a Kinesis Data Analytics Studio notebook.", - "properties": { - "CatalogConfiguration": { - "$ref": "#/definitions/CatalogConfiguration", - "description": "The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook." - }, - "CustomArtifactsConfiguration": { - "$ref": "#/definitions/CustomArtifactsConfiguration", - "description": "A list of CustomArtifactConfiguration objects." - }, - "DeployAsApplicationConfiguration": { - "$ref": "#/definitions/DeployAsApplicationConfiguration", - "description": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state." - }, - "MonitoringConfiguration": { - "$ref": "#/definitions/ZeppelinMonitoringConfiguration", - "description": "The monitoring configuration of a Kinesis Data Analytics Studio notebook." - } - }, - "type": "object" - }, - "ZeppelinMonitoringConfiguration": { - "additionalProperties": false, - "description": "Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.", - "properties": { - "LogLevel": { - "description": "The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`.", - "enum": [ - "DEBUG", - "INFO", - "WARN", - "ERROR" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "kinesisanalytics:CreateApplication", - "kinesisanalytics:DescribeApplication", - "kinesisanalytics:ListTagsForResource", - "kinesisanalytics:UpdateApplicationMaintenanceConfiguration" - ] - }, - "delete": { - "permissions": [ - "kinesisanalytics:DescribeApplication", - "kinesisanalytics:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "kinesisanalytics:ListApplications" - ] - }, - "read": { - "permissions": [ - "kinesisanalytics:DescribeApplication", - "kinesisanalytics:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kinesisanalytics:UpdateApplication", - "kinesisanalytics:DescribeApplication", - "kinesisanalytics:TagResource", - "kinesisanalytics:UntagResource", - "kinesisanalytics:AddApplicationVpcConfiguration", - "kinesisanalytics:DeleteApplicationVpcConfiguration", - "kinesisanalytics:UpdateApplicationMaintenanceConfiguration", - "kinesisanalytics:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationName" - ], - "properties": { - "ApplicationConfiguration": { - "$ref": "#/definitions/ApplicationConfiguration", - "description": "Use this parameter to configure the application." - }, - "ApplicationDescription": { - "default": "", - "description": "The description of the application.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ApplicationMaintenanceConfiguration": { - "$ref": "#/definitions/ApplicationMaintenanceConfiguration", - "description": "Used to configure start of maintenance window." - }, - "ApplicationMode": { - "description": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.", - "enum": [ - "INTERACTIVE", - "STREAMING" - ], - "type": "string" - }, - "ApplicationName": { - "description": "The name of the application.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "RunConfiguration": { - "$ref": "#/definitions/RunConfiguration", - "description": "Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only." - }, - "RuntimeEnvironment": { - "description": "The runtime environment for the application.", - "type": "string" - }, - "ServiceExecutionRole": { - "$ref": "#/definitions/Arn", - "description": "Specifies the IAM role that the application uses to access external resources." - }, - "Tags": { - "description": "A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "RuntimeEnvironment", - "ServiceExecutionRole" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisanalyticsv2.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KinesisAnalyticsV2::Application", - "writeOnlyProperties": [ - "/properties/RunConfiguration", - "/properties/ApplicationConfiguration/EnvironmentProperties", - "/properties/ApplicationConfiguration/ApplicationCodeConfiguration/CodeContent/ZipFileContent" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName", + "/properties/ApplicationMode" + ], + "definitions": { + "ApplicationCodeConfiguration": { + "additionalProperties": false, + "description": "Describes code configuration for an application.", + "properties": { + "CodeContent": { + "$ref": "#/definitions/CodeContent", + "description": "The location and type of the application code." + }, + "CodeContentType": { + "description": "Specifies whether the code content is in text or zip format.", + "enum": [ + "PLAINTEXT", + "ZIPFILE" + ], + "type": "string" + } + }, + "required": [ + "CodeContentType", + "CodeContent" + ], + "type": "object" + }, + "ApplicationConfiguration": { + "additionalProperties": false, + "description": "Specifies the creation parameters for a Kinesis Data Analytics application.", + "properties": { + "ApplicationCodeConfiguration": { + "$ref": "#/definitions/ApplicationCodeConfiguration", + "description": "The code location and type parameters for a Flink-based Kinesis Data Analytics application." + }, + "ApplicationSnapshotConfiguration": { + "$ref": "#/definitions/ApplicationSnapshotConfiguration", + "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." + }, + "ApplicationSystemRollbackConfiguration": { + "$ref": "#/definitions/ApplicationSystemRollbackConfiguration", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + }, + "EnvironmentProperties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." + }, + "FlinkApplicationConfiguration": { + "$ref": "#/definitions/FlinkApplicationConfiguration", + "description": "The creation and update parameters for a Flink-based Kinesis Data Analytics application." + }, + "SqlApplicationConfiguration": { + "$ref": "#/definitions/SqlApplicationConfiguration", + "description": "The creation and update parameters for a SQL-based Kinesis Data Analytics application." + }, + "VpcConfigurations": { + "$ref": "#/definitions/VpcConfigurations", + "description": "The array of descriptions of VPC configurations available to the application." + }, + "ZeppelinApplicationConfiguration": { + "$ref": "#/definitions/ZeppelinApplicationConfiguration", + "description": "The configuration parameters for a Kinesis Data Analytics Studio notebook." + } + }, + "type": "object" + }, + "ApplicationMaintenanceConfiguration": { + "additionalProperties": false, + "description": "Describes the maintenance configuration for the application.", + "properties": { + "ApplicationMaintenanceWindowStartTime": { + "description": "The start time for the maintenance window.", + "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + } + }, + "required": [ + "ApplicationMaintenanceWindowStartTime" + ], + "type": "object" + }, + "ApplicationRestoreConfiguration": { + "additionalProperties": false, + "description": "Describes the restore behavior of a restarting application.", + "properties": { + "ApplicationRestoreType": { + "description": "Specifies how the application should be restored.", + "enum": [ + "SKIP_RESTORE_FROM_SNAPSHOT", + "RESTORE_FROM_LATEST_SNAPSHOT", + "RESTORE_FROM_CUSTOM_SNAPSHOT" + ], + "type": "string" + }, + "SnapshotName": { + "description": "The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + } + }, + "required": [ + "ApplicationRestoreType" + ], + "type": "object" + }, + "ApplicationSnapshotConfiguration": { + "additionalProperties": false, + "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.", + "properties": { + "SnapshotsEnabled": { + "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.", + "type": "boolean" + } + }, + "required": [ + "SnapshotsEnabled" + ], + "type": "object" + }, + "ApplicationSystemRollbackConfiguration": { + "additionalProperties": false, + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "properties": { + "RollbackEnabled": { + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "type": "boolean" + } + }, + "required": [ + "RollbackEnabled" + ], + "type": "object" + }, + "Arn": { + "description": "The Amazon Resource Name", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:.*$", + "type": "string" + }, + "CSVMappingParameters": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`", + "properties": { + "RecordColumnDelimiter": { + "description": "The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "RecordRowDelimiter": { + "description": "The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "RecordRowDelimiter", + "RecordColumnDelimiter" + ], + "type": "object" + }, + "CatalogConfiguration": { + "additionalProperties": false, + "description": "The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.", + "properties": { + "GlueDataCatalogConfiguration": { + "$ref": "#/definitions/GlueDataCatalogConfiguration", + "description": "The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook." + } + }, + "type": "object" + }, + "CheckpointConfiguration": { + "additionalProperties": false, + "description": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.", + "properties": { + "CheckpointInterval": { + "description": "Describes the interval in milliseconds between checkpoint operations.", + "format": "int64", + "maximum": 9223372036854775807, + "minimum": 1, + "type": "integer" + }, + "CheckpointingEnabled": { + "description": "Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.", + "type": "boolean" + }, + "ConfigurationType": { + "description": "Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters.", + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + }, + "MinPauseBetweenCheckpoints": { + "description": "Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.", + "format": "int64", + "maximum": 9223372036854775807, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "ConfigurationType" + ], + "type": "object" + }, + "CodeContent": { + "additionalProperties": false, + "description": "Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.", + "properties": { + "S3ContentLocation": { + "$ref": "#/definitions/S3ContentLocation", + "description": "Information about the Amazon S3 bucket that contains the application code." + }, + "TextContent": { + "description": "The text-format code for a Flink-based Kinesis Data Analytics application.", + "maxLength": 102400, + "minLength": 1, + "type": "string" + }, + "ZipFileContent": { + "description": "The zip-format code for a Flink-based Kinesis Data Analytics application.", + "type": "string" + } + }, + "type": "object" + }, + "CustomArtifactConfiguration": { + "additionalProperties": false, + "description": "The configuration of connectors and user-defined functions.", + "properties": { + "ArtifactType": { + "description": "Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket.", + "enum": [ + "DEPENDENCY_JAR", + "UDF" + ], + "type": "string" + }, + "MavenReference": { + "$ref": "#/definitions/MavenReference", + "description": "The parameters required to fully specify a Maven reference." + }, + "S3ContentLocation": { + "$ref": "#/definitions/S3ContentLocation", + "description": "The location of the custom artifacts." + } + }, + "required": [ + "ArtifactType" + ], + "type": "object" + }, + "CustomArtifactsConfiguration": { + "description": "A list of CustomArtifactConfiguration objects.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomArtifactConfiguration", + "description": "The configuration of connectors and user-defined functions." + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "DeployAsApplicationConfiguration": { + "additionalProperties": false, + "description": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.", + "properties": { + "S3ContentLocation": { + "$ref": "#/definitions/S3ContentBaseLocation", + "description": "The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data." + } + }, + "required": [ + "S3ContentLocation" + ], + "type": "object" + }, + "EnvironmentProperties": { + "additionalProperties": false, + "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application.", + "properties": { + "PropertyGroups": { + "description": "Describes the execution property groups.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PropertyGroup" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "FlinkApplicationConfiguration": { + "additionalProperties": false, + "description": "Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.", + "properties": { + "CheckpointConfiguration": { + "$ref": "#/definitions/CheckpointConfiguration", + "description": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation." + }, + "MonitoringConfiguration": { + "$ref": "#/definitions/MonitoringConfiguration", + "description": "Describes configuration parameters for Amazon CloudWatch logging for an application." + }, + "ParallelismConfiguration": { + "$ref": "#/definitions/ParallelismConfiguration", + "description": "Describes parameters for how an application executes multiple tasks simultaneously." + } + }, + "type": "object" + }, + "FlinkRunConfiguration": { + "additionalProperties": false, + "description": "Describes the starting parameters for a Flink-based Kinesis Data Analytics application.", + "properties": { + "AllowNonRestoredState": { + "description": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.", + "type": "boolean" + } + }, + "type": "object" + }, + "GlueDataCatalogConfiguration": { + "additionalProperties": false, + "description": "The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.", + "properties": { + "DatabaseARN": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the database." + } + }, + "type": "object" + }, + "Input": { + "additionalProperties": false, + "description": "When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.", + "properties": { + "InputParallelism": { + "$ref": "#/definitions/InputParallelism", + "description": "Describes the number of in-application streams to create." + }, + "InputProcessingConfiguration": { + "$ref": "#/definitions/InputProcessingConfiguration", + "description": "The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor." + }, + "InputSchema": { + "$ref": "#/definitions/InputSchema", + "description": "Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created." + }, + "KinesisFirehoseInput": { + "$ref": "#/definitions/KinesisFirehoseInput", + "description": "If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN." + }, + "KinesisStreamsInput": { + "$ref": "#/definitions/KinesisStreamsInput", + "description": "If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN)." + }, + "NamePrefix": { + "description": "The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `\"MyInApplicationStream\"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `\"MyInApplicationStream_001\"`, `\"MyInApplicationStream_002\"`, and so on.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^-\\s<>&]*$", + "type": "string" + } + }, + "required": [ + "NamePrefix", + "InputSchema" + ], + "type": "object" + }, + "InputLambdaProcessor": { + "additionalProperties": false, + "description": "An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.", + "properties": { + "ResourceARN": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the Amazon Lambda function that operates on records in the stream." + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "InputParallelism": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.", + "properties": { + "Count": { + "description": "The number of in-application streams to create.", + "maximum": 64, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "InputProcessingConfiguration": { + "additionalProperties": false, + "description": "For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.", + "properties": { + "InputLambdaProcessor": { + "$ref": "#/definitions/InputLambdaProcessor", + "description": "The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code." + } + }, + "type": "object" + }, + "InputSchema": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.", + "properties": { + "RecordColumns": { + "description": "A list of `RecordColumn` objects.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RecordColumn" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": false + }, + "RecordEncoding": { + "description": "Specifies the encoding of the records in the streaming source. For example, UTF-8.", + "enum": [ + "UTF-8" + ], + "type": "string" + }, + "RecordFormat": { + "$ref": "#/definitions/RecordFormat", + "description": "Specifies the format of the records on the streaming source." + } + }, + "required": [ + "RecordColumns", + "RecordFormat" + ], + "type": "object" + }, + "JSONMappingParameters": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.", + "properties": { + "RecordRowPath": { + "description": "The path to the top-level parent that contains the records.", + "maxLength": 65535, + "minLength": 1, + "pattern": "^(?=^\\$)(?=^\\S+$).*$", + "type": "string" + } + }, + "required": [ + "RecordRowPath" + ], + "type": "object" + }, + "KinesisFirehoseInput": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).", + "properties": { + "ResourceARN": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the delivery stream." + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "KinesisStreamsInput": { + "additionalProperties": false, + "description": "Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).", + "properties": { + "ResourceARN": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the input Kinesis data stream to read." + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "MappingParameters": { + "additionalProperties": false, + "description": "When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.", + "properties": { + "CSVMappingParameters": { + "$ref": "#/definitions/CSVMappingParameters", + "description": "Provides additional mapping information when the record format uses delimiters (for example, CSV)." + }, + "JSONMappingParameters": { + "$ref": "#/definitions/JSONMappingParameters", + "description": "Provides additional mapping information when JSON is the record format on the streaming source." + } + }, + "type": "object" + }, + "MavenReference": { + "additionalProperties": false, + "description": "The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.", + "properties": { + "ArtifactId": { + "description": "The artifact ID of the Maven reference.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "GroupId": { + "description": "The group ID of the Maven reference.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "Version": { + "description": "The version of the Maven reference.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + } + }, + "required": [ + "ArtifactId", + "GroupId", + "Version" + ], + "type": "object" + }, + "MonitoringConfiguration": { + "additionalProperties": false, + "description": "Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.", + "properties": { + "ConfigurationType": { + "description": "Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.", + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + }, + "LogLevel": { + "description": "Describes the verbosity of the CloudWatch Logs for an application.", + "enum": [ + "DEBUG", + "INFO", + "WARN", + "ERROR" + ], + "type": "string" + }, + "MetricsLevel": { + "description": "Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.", + "enum": [ + "APPLICATION", + "OPERATOR", + "PARALLELISM", + "TASK" + ], + "type": "string" + } + }, + "required": [ + "ConfigurationType" + ], + "type": "object" + }, + "ParallelismConfiguration": { + "additionalProperties": false, + "description": "Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation", + "properties": { + "AutoScalingEnabled": { + "description": "Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.", + "type": "boolean" + }, + "ConfigurationType": { + "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties.", + "enum": [ + "CUSTOM", + "DEFAULT" + ], + "type": "string" + }, + "Parallelism": { + "description": "Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.", + "minimum": 1, + "type": "integer" + }, + "ParallelismPerKPU": { + "description": "Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "ConfigurationType" + ], + "type": "object" + }, + "PropertyGroup": { + "additionalProperties": false, + "description": "Property key-value pairs passed into an application.", + "properties": { + "PropertyGroupId": { + "description": "Describes the key of an application execution property key-value pair.", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "PropertyMap": { + "additionalProperties": false, + "description": "Describes the value of an application execution property key-value pair.", + "maxProperties": 50, + "patternProperties": { + "^.{1,2048}$": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RecordColumn": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.\nAlso used to describe the format of the reference data source.", + "properties": { + "Mapping": { + "description": "A reference to the data element in the streaming input or the reference data source.", + "maxLength": 65535, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name of the column that is created in the in-application input stream or reference table.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[^-\\s<>&]*$", + "type": "string" + }, + "SqlType": { + "description": "The type of column created in the in-application input stream or reference table.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "SqlType", + "Name" + ], + "type": "object" + }, + "RecordFormat": { + "additionalProperties": false, + "description": "For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.", + "properties": { + "MappingParameters": { + "$ref": "#/definitions/MappingParameters", + "description": "When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source." + }, + "RecordFormatType": { + "description": "The type of record format.", + "enum": [ + "CSV", + "JSON" + ], + "type": "string" + } + }, + "required": [ + "RecordFormatType" + ], + "type": "object" + }, + "RunConfiguration": { + "additionalProperties": false, + "description": "Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. This section is evaluated only on stack updates for applications in running RUNNING state and has no effect during manual application start.", + "properties": { + "ApplicationRestoreConfiguration": { + "$ref": "#/definitions/ApplicationRestoreConfiguration", + "description": "Describes the restore behavior of a restarting application." + }, + "FlinkRunConfiguration": { + "$ref": "#/definitions/FlinkRunConfiguration", + "description": "Describes the starting parameters for a Flink-based Kinesis Data Analytics application." + } + }, + "type": "object" + }, + "S3ContentBaseLocation": { + "additionalProperties": false, + "description": "The base location of the Amazon Data Analytics application.", + "properties": { + "BasePath": { + "description": "The base path for the S3 bucket.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/!-_.*'()]+$", + "type": "string" + }, + "BucketARN": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the S3 bucket." + } + }, + "required": [ + "BucketARN" + ], + "type": "object" + }, + "S3ContentLocation": { + "additionalProperties": false, + "description": "The location of an application or a custom artifact.", + "properties": { + "BucketARN": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) for the S3 bucket containing the application code." + }, + "FileKey": { + "description": "The file key for the object containing the application code.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "ObjectVersion": { + "description": "The version of the object containing the application code.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "BucketARN", + "FileKey" + ], + "type": "object" + }, + "SqlApplicationConfiguration": { + "additionalProperties": false, + "description": "Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.", + "properties": { + "Inputs": { + "description": "The array of Input objects describing the input streams used by the application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Input" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair that identifies an application.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that's 0 to 256 characters in length.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfiguration": { + "additionalProperties": false, + "description": "Describes the parameters of a VPC used by the application.", + "properties": { + "SecurityGroupIds": { + "description": "The array of SecurityGroup IDs used by the VPC configuration.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "description": "The array of Subnet IDs used by the VPC configuration.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "SecurityGroupIds", + "SubnetIds" + ], + "type": "object" + }, + "VpcConfigurations": { + "description": "The array of descriptions of VPC configurations available to the application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcConfiguration", + "description": "Describes the parameters of a VPC used by the application." + }, + "maxItems": 1, + "type": "array", + "uniqueItems": false + }, + "ZeppelinApplicationConfiguration": { + "additionalProperties": false, + "description": "The configuration of a Kinesis Data Analytics Studio notebook.", + "properties": { + "CatalogConfiguration": { + "$ref": "#/definitions/CatalogConfiguration", + "description": "The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook." + }, + "CustomArtifactsConfiguration": { + "$ref": "#/definitions/CustomArtifactsConfiguration", + "description": "A list of CustomArtifactConfiguration objects." + }, + "DeployAsApplicationConfiguration": { + "$ref": "#/definitions/DeployAsApplicationConfiguration", + "description": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state." + }, + "MonitoringConfiguration": { + "$ref": "#/definitions/ZeppelinMonitoringConfiguration", + "description": "The monitoring configuration of a Kinesis Data Analytics Studio notebook." + } + }, + "type": "object" + }, + "ZeppelinMonitoringConfiguration": { + "additionalProperties": false, + "description": "Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.", + "properties": { + "LogLevel": { + "description": "The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`.", + "enum": [ + "DEBUG", + "INFO", + "WARN", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "kinesisanalytics:CreateApplication", + "kinesisanalytics:DescribeApplication", + "kinesisanalytics:ListTagsForResource", + "kinesisanalytics:UpdateApplicationMaintenanceConfiguration" + ] + }, + "delete": { + "permissions": [ + "kinesisanalytics:DescribeApplication", + "kinesisanalytics:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "kinesisanalytics:ListApplications" + ] + }, + "read": { + "permissions": [ + "kinesisanalytics:DescribeApplication", + "kinesisanalytics:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kinesisanalytics:UpdateApplication", + "kinesisanalytics:DescribeApplication", + "kinesisanalytics:TagResource", + "kinesisanalytics:UntagResource", + "kinesisanalytics:AddApplicationVpcConfiguration", + "kinesisanalytics:DeleteApplicationVpcConfiguration", + "kinesisanalytics:UpdateApplicationMaintenanceConfiguration", + "kinesisanalytics:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationName" + ], + "properties": { + "ApplicationConfiguration": { + "$ref": "#/definitions/ApplicationConfiguration", + "description": "Use this parameter to configure the application." + }, + "ApplicationDescription": { + "default": "", + "description": "The description of the application.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ApplicationMaintenanceConfiguration": { + "$ref": "#/definitions/ApplicationMaintenanceConfiguration", + "description": "Used to configure start of maintenance window." + }, + "ApplicationMode": { + "description": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.", + "enum": [ + "INTERACTIVE", + "STREAMING" + ], + "type": "string" + }, + "ApplicationName": { + "description": "The name of the application.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "RunConfiguration": { + "$ref": "#/definitions/RunConfiguration", + "description": "Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only." + }, + "RuntimeEnvironment": { + "description": "The runtime environment for the application.", + "type": "string" + }, + "ServiceExecutionRole": { + "$ref": "#/definitions/Arn", + "description": "Specifies the IAM role that the application uses to access external resources." + }, + "Tags": { + "description": "A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "RuntimeEnvironment", + "ServiceExecutionRole" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisanalyticsv2.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KinesisAnalyticsV2::Application", + "writeOnlyProperties": [ + "/properties/RunConfiguration", + "/properties/ApplicationConfiguration/EnvironmentProperties", + "/properties/ApplicationConfiguration/ApplicationCodeConfiguration/CodeContent/ZipFileContent" + ] +} diff --git a/schema/aws-kinesisanalyticsv2-applicationcloudwatchloggingoption.json b/schema/aws-kinesisanalyticsv2-applicationcloudwatchloggingoption.json index fddb8d0..e0fdb7f 100644 --- a/schema/aws-kinesisanalyticsv2-applicationcloudwatchloggingoption.json +++ b/schema/aws-kinesisanalyticsv2-applicationcloudwatchloggingoption.json @@ -1,43 +1,43 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "CloudWatchLoggingOption": { - "additionalProperties": false, - "properties": { - "LogStreamARN": { - "type": "string" - } - }, - "required": [ - "LogStreamARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "CloudWatchLoggingOption": { - "$ref": "#/definitions/CloudWatchLoggingOption" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "CloudWatchLoggingOption", - "ApplicationName" - ], - "typeName": "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "CloudWatchLoggingOption": { + "additionalProperties": false, + "properties": { + "LogStreamARN": { + "type": "string" + } + }, + "required": [ + "LogStreamARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "CloudWatchLoggingOption": { + "$ref": "#/definitions/CloudWatchLoggingOption" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "CloudWatchLoggingOption", + "ApplicationName" + ], + "typeName": "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption" +} diff --git a/schema/aws-kinesisanalyticsv2-applicationoutput.json b/schema/aws-kinesisanalyticsv2-applicationoutput.json index 907e466..157f00c 100644 --- a/schema/aws-kinesisanalyticsv2-applicationoutput.json +++ b/schema/aws-kinesisanalyticsv2-applicationoutput.json @@ -1,100 +1,100 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "DestinationSchema": { - "additionalProperties": false, - "properties": { - "RecordFormatType": { - "type": "string" - } - }, - "type": "object" - }, - "KinesisFirehoseOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "KinesisStreamsOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "LambdaOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "Output": { - "additionalProperties": false, - "properties": { - "DestinationSchema": { - "$ref": "#/definitions/DestinationSchema" - }, - "KinesisFirehoseOutput": { - "$ref": "#/definitions/KinesisFirehoseOutput" - }, - "KinesisStreamsOutput": { - "$ref": "#/definitions/KinesisStreamsOutput" - }, - "LambdaOutput": { - "$ref": "#/definitions/LambdaOutput" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DestinationSchema" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationOutput", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Output": { - "$ref": "#/definitions/Output" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationName", - "Output" - ], - "typeName": "AWS::KinesisAnalyticsV2::ApplicationOutput" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "DestinationSchema": { + "additionalProperties": false, + "properties": { + "RecordFormatType": { + "type": "string" + } + }, + "type": "object" + }, + "KinesisFirehoseOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "KinesisStreamsOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "LambdaOutput": { + "additionalProperties": false, + "properties": { + "ResourceARN": { + "type": "string" + } + }, + "required": [ + "ResourceARN" + ], + "type": "object" + }, + "Output": { + "additionalProperties": false, + "properties": { + "DestinationSchema": { + "$ref": "#/definitions/DestinationSchema" + }, + "KinesisFirehoseOutput": { + "$ref": "#/definitions/KinesisFirehoseOutput" + }, + "KinesisStreamsOutput": { + "$ref": "#/definitions/KinesisStreamsOutput" + }, + "LambdaOutput": { + "$ref": "#/definitions/LambdaOutput" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "DestinationSchema" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationOutput", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Output": { + "$ref": "#/definitions/Output" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationName", + "Output" + ], + "typeName": "AWS::KinesisAnalyticsV2::ApplicationOutput" +} diff --git a/schema/aws-kinesisanalyticsv2-applicationreferencedatasource.json b/schema/aws-kinesisanalyticsv2-applicationreferencedatasource.json index a38fc2f..b75330f 100644 --- a/schema/aws-kinesisanalyticsv2-applicationreferencedatasource.json +++ b/schema/aws-kinesisanalyticsv2-applicationreferencedatasource.json @@ -1,162 +1,162 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationName" - ], - "definitions": { - "CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/JSONMappingParameters" - } - }, - "type": "object" - }, - "RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "SqlType", - "Name" - ], - "type": "object" - }, - "RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "ReferenceSchema": { - "$ref": "#/definitions/ReferenceSchema" - }, - "S3ReferenceDataSource": { - "$ref": "#/definitions/S3ReferenceDataSource" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "ReferenceSchema" - ], - "type": "object" - }, - "ReferenceSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/RecordColumn" - }, - "type": "array", - "uniqueItems": false - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "S3ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "FileKey": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "FileKey" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "ReferenceDataSource": { - "$ref": "#/definitions/ReferenceDataSource" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ReferenceDataSource", - "ApplicationName" - ], - "typeName": "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationName" + ], + "definitions": { + "CSVMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordColumnDelimiter": { + "type": "string" + }, + "RecordRowDelimiter": { + "type": "string" + } + }, + "required": [ + "RecordColumnDelimiter", + "RecordRowDelimiter" + ], + "type": "object" + }, + "JSONMappingParameters": { + "additionalProperties": false, + "properties": { + "RecordRowPath": { + "type": "string" + } + }, + "required": [ + "RecordRowPath" + ], + "type": "object" + }, + "MappingParameters": { + "additionalProperties": false, + "properties": { + "CSVMappingParameters": { + "$ref": "#/definitions/CSVMappingParameters" + }, + "JSONMappingParameters": { + "$ref": "#/definitions/JSONMappingParameters" + } + }, + "type": "object" + }, + "RecordColumn": { + "additionalProperties": false, + "properties": { + "Mapping": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SqlType": { + "type": "string" + } + }, + "required": [ + "SqlType", + "Name" + ], + "type": "object" + }, + "RecordFormat": { + "additionalProperties": false, + "properties": { + "MappingParameters": { + "$ref": "#/definitions/MappingParameters" + }, + "RecordFormatType": { + "type": "string" + } + }, + "required": [ + "RecordFormatType" + ], + "type": "object" + }, + "ReferenceDataSource": { + "additionalProperties": false, + "properties": { + "ReferenceSchema": { + "$ref": "#/definitions/ReferenceSchema" + }, + "S3ReferenceDataSource": { + "$ref": "#/definitions/S3ReferenceDataSource" + }, + "TableName": { + "type": "string" + } + }, + "required": [ + "ReferenceSchema" + ], + "type": "object" + }, + "ReferenceSchema": { + "additionalProperties": false, + "properties": { + "RecordColumns": { + "items": { + "$ref": "#/definitions/RecordColumn" + }, + "type": "array", + "uniqueItems": false + }, + "RecordEncoding": { + "type": "string" + }, + "RecordFormat": { + "$ref": "#/definitions/RecordFormat" + } + }, + "required": [ + "RecordColumns", + "RecordFormat" + ], + "type": "object" + }, + "S3ReferenceDataSource": { + "additionalProperties": false, + "properties": { + "BucketARN": { + "type": "string" + }, + "FileKey": { + "type": "string" + } + }, + "required": [ + "BucketARN", + "FileKey" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "ReferenceDataSource": { + "$ref": "#/definitions/ReferenceDataSource" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ReferenceDataSource", + "ApplicationName" + ], + "typeName": "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource" +} diff --git a/schema/aws-kinesisfirehose-deliverystream.json b/schema/aws-kinesisfirehose-deliverystream.json index 6cbd114..5c9042b 100644 --- a/schema/aws-kinesisfirehose-deliverystream.json +++ b/schema/aws-kinesisfirehose-deliverystream.json @@ -1,1732 +1,1732 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeliveryStreamName", - "/properties/DeliveryStreamType", - "/properties/ElasticsearchDestinationConfiguration/VpcConfiguration", - "/properties/AmazonopensearchserviceDestinationConfiguration/VpcConfiguration", - "/properties/AmazonOpenSearchServerlessDestinationConfiguration/VpcConfiguration", - "/properties/KinesisStreamSourceConfiguration", - "/properties/MSKSourceConfiguration", - "/properties/IcebergDestinationConfiguration", - "/properties/SnowflakeDestinationConfiguration/SnowflakeVpcConfiguration" - ], - "definitions": { - "AmazonOpenSearchServerlessBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "AmazonOpenSearchServerlessDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/AmazonOpenSearchServerlessBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "CollectionEndpoint": { - "maxLength": 512, - "minLength": 1, - "pattern": "https:.*", - "relationshipRef": { - "propertyPath": "/properties/CollectionEndpoint", - "typeName": "AWS::OpenSearchServerless::Collection" - }, - "type": "string" - }, - "IndexName": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AmazonOpenSearchServerlessRetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupMode": { - "enum": [ - "FailedDocumentsOnly", - "AllDocuments" - ], - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "required": [ - "IndexName", - "S3Configuration", - "RoleARN" - ], - "type": "object" - }, - "AmazonOpenSearchServerlessRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "AmazonopensearchserviceBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "AmazonopensearchserviceDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/AmazonopensearchserviceBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "ClusterEndpoint": { - "maxLength": 512, - "minLength": 1, - "pattern": "https:.*", - "type": "string" - }, - "DocumentIdOptions": { - "$ref": "#/definitions/DocumentIdOptions" - }, - "DomainARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "type": "string" - }, - "IndexName": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "IndexRotationPeriod": { - "enum": [ - "NoRotation", - "OneHour", - "OneDay", - "OneWeek", - "OneMonth" - ], - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AmazonopensearchserviceRetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupMode": { - "enum": [ - "FailedDocumentsOnly", - "AllDocuments" - ], - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "TypeName": { - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "required": [ - "IndexName", - "S3Configuration", - "RoleARN" - ], - "type": "object" - }, - "AmazonopensearchserviceRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "AuthenticationConfiguration": { - "additionalProperties": false, - "properties": { - "Connectivity": { - "enum": [ - "PUBLIC", - "PRIVATE" - ], - "type": "string" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - } - }, - "required": [ - "RoleARN", - "Connectivity" - ], - "type": "object" - }, - "BufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "CatalogConfiguration": { - "additionalProperties": false, - "properties": { - "CatalogArn": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "type": "string" - } - }, - "type": "object" - }, - "CloudWatchLoggingOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LogGroupName": { - "relationshipRef": { - "propertyPath": "/properties/LogGroupName", - "typeName": "AWS::Logs::LogGroup" - }, - "type": "string" - }, - "LogStreamName": { - "relationshipRef": { - "propertyPath": "/properties/LogStreamName", - "typeName": "AWS::Logs::LogStream" - }, - "type": "string" - } - }, - "type": "object" - }, - "CopyCommand": { - "additionalProperties": false, - "properties": { - "CopyOptions": { - "maxLength": 204800, - "minLength": 0, - "type": "string" - }, - "DataTableColumns": { - "maxLength": 204800, - "minLength": 0, - "type": "string" - }, - "DataTableName": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataTableName" - ], - "type": "object" - }, - "DataFormatConversionConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "InputFormatConfiguration": { - "$ref": "#/definitions/InputFormatConfiguration" - }, - "OutputFormatConfiguration": { - "$ref": "#/definitions/OutputFormatConfiguration" - }, - "SchemaConfiguration": { - "$ref": "#/definitions/SchemaConfiguration" - } - }, - "type": "object" - }, - "DeliveryStreamEncryptionConfigurationInput": { - "additionalProperties": false, - "properties": { - "KeyARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - }, - "type": "string" - }, - "KeyType": { - "enum": [ - "AWS_OWNED_CMK", - "CUSTOMER_MANAGED_CMK" - ], - "type": "string" - } - }, - "required": [ - "KeyType" - ], - "type": "object" - }, - "Deserializer": { - "additionalProperties": false, - "properties": { - "HiveJsonSerDe": { - "$ref": "#/definitions/HiveJsonSerDe" - }, - "OpenXJsonSerDe": { - "$ref": "#/definitions/OpenXJsonSerDe" - } - }, - "type": "object" - }, - "DestinationTableConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationDatabaseName": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "DestinationTableName": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "S3ErrorOutputPrefix": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "UniqueKeys": { - "items": { - "$ref": "#/definitions/UniqueKey" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "DestinationDatabaseName", - "DestinationTableName" - ], - "type": "object" - }, - "DestinationTableConfigurationList": { - "items": { - "$ref": "#/definitions/DestinationTableConfiguration" - }, - "type": "array" - }, - "DocumentIdOptions": { - "additionalProperties": false, - "properties": { - "DefaultDocumentIdFormat": { - "enum": [ - "FIREHOSE_DEFAULT", - "NO_DOCUMENT_ID" - ], - "type": "string" - } - }, - "required": [ - "DefaultDocumentIdFormat" - ], - "type": "object" - }, - "DynamicPartitioningConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "RetryOptions": { - "$ref": "#/definitions/RetryOptions" - } - }, - "type": "object" - }, - "ElasticsearchBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "ElasticsearchDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/ElasticsearchBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "ClusterEndpoint": { - "maxLength": 512, - "minLength": 1, - "pattern": "https:.*", - "type": "string" - }, - "DocumentIdOptions": { - "$ref": "#/definitions/DocumentIdOptions" - }, - "DomainARN": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Elasticsearch::Domain" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::OpenSearchService::Domain" - } - } - ], - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "type": "string" - }, - "IndexName": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "IndexRotationPeriod": { - "enum": [ - "NoRotation", - "OneHour", - "OneDay", - "OneWeek", - "OneMonth" - ], - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/ElasticsearchRetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupMode": { - "enum": [ - "FailedDocumentsOnly", - "AllDocuments" - ], - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "TypeName": { - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "required": [ - "IndexName", - "S3Configuration", - "RoleARN" - ], - "type": "object" - }, - "ElasticsearchRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KMSEncryptionConfig": { - "$ref": "#/definitions/KMSEncryptionConfig" - }, - "NoEncryptionConfig": { - "enum": [ - "NoEncryption" - ], - "type": "string" - } - }, - "type": "object" - }, - "ExtendedS3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "maxLength": 2048, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "BufferingHints": { - "$ref": "#/definitions/BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "CompressionFormat": { - "enum": [ - "UNCOMPRESSED", - "GZIP", - "ZIP", - "Snappy", - "HADOOP_SNAPPY" - ], - "type": "string" - }, - "CustomTimeZone": { - "maxLength": 50, - "minLength": 0, - "type": "string" - }, - "DataFormatConversionConfiguration": { - "$ref": "#/definitions/DataFormatConversionConfiguration" - }, - "DynamicPartitioningConfiguration": { - "$ref": "#/definitions/DynamicPartitioningConfiguration" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "ErrorOutputPrefix": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "FileExtension": { - "maxLength": 128, - "minLength": 0, - "pattern": "^$|\\.[0-9a-z!\\-_.*'()]+", - "type": "string" - }, - "Prefix": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupConfiguration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "S3BackupMode": { - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - } - }, - "required": [ - "BucketARN", - "RoleARN" - ], - "type": "object" - }, - "HiveJsonSerDe": { - "additionalProperties": false, - "properties": { - "TimestampFormats": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "HttpEndpointCommonAttribute": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "AttributeValue": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "AttributeName", - "AttributeValue" - ], - "type": "object" - }, - "HttpEndpointConfiguration": { - "additionalProperties": false, - "properties": { - "AccessKey": { - "maxLength": 4096, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Url": { - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Url" - ], - "type": "object" - }, - "HttpEndpointDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/HttpEndpointConfiguration" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RequestConfiguration": { - "$ref": "#/definitions/HttpEndpointRequestConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/RetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "SecretsManagerConfiguration": { - "$ref": "#/definitions/SecretsManagerConfiguration" - } - }, - "required": [ - "EndpointConfiguration", - "S3Configuration" - ], - "type": "object" - }, - "HttpEndpointRequestConfiguration": { - "additionalProperties": false, - "properties": { - "CommonAttributes": { - "items": { - "$ref": "#/definitions/HttpEndpointCommonAttribute" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "ContentEncoding": { - "enum": [ - "NONE", - "GZIP" - ], - "type": "string" - } - }, - "type": "object" - }, - "IcebergDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/BufferingHints" - }, - "CatalogConfiguration": { - "$ref": "#/definitions/CatalogConfiguration" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "DestinationTableConfigurationList": { - "$ref": "#/definitions/DestinationTableConfigurationList" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/RetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "s3BackupMode": { - "enum": [ - "AllData", - "FailedDataOnly" - ], - "type": "string" - } - }, - "required": [ - "RoleARN", - "CatalogConfiguration", - "S3Configuration" - ], - "type": "object" - }, - "InputFormatConfiguration": { - "additionalProperties": false, - "properties": { - "Deserializer": { - "$ref": "#/definitions/Deserializer" - } - }, - "type": "object" - }, - "KMSEncryptionConfig": { - "additionalProperties": false, - "properties": { - "AWSKMSKeyARN": { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - }, - "type": "string" - } - }, - "required": [ - "AWSKMSKeyARN" - ], - "type": "object" - }, - "KinesisStreamSourceConfiguration": { - "additionalProperties": false, - "properties": { - "KinesisStreamARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Kinesis::Stream" - }, - "type": "string" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - } - }, - "required": [ - "RoleARN", - "KinesisStreamARN" - ], - "type": "object" - }, - "MSKSourceConfiguration": { - "additionalProperties": false, - "properties": { - "AuthenticationConfiguration": { - "$ref": "#/definitions/AuthenticationConfiguration" - }, - "MSKClusterARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::MSK::Cluster" - }, - "type": "string" - }, - "ReadFromTimestamp": { - "type": "string" - }, - "TopicName": { - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\._\\-]+", - "type": "string" - } - }, - "required": [ - "MSKClusterARN", - "TopicName", - "AuthenticationConfiguration" - ], - "type": "object" - }, - "OpenXJsonSerDe": { - "additionalProperties": false, - "properties": { - "CaseInsensitive": { - "type": "boolean" - }, - "ColumnToJsonKeyMappings": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ConvertDotsInJsonKeysToUnderscores": { - "type": "boolean" - } - }, - "type": "object" - }, - "OrcSerDe": { - "additionalProperties": false, - "properties": { - "BlockSizeBytes": { - "type": "integer" - }, - "BloomFilterColumns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "BloomFilterFalsePositiveProbability": { - "type": "number" - }, - "Compression": { - "type": "string" - }, - "DictionaryKeyThreshold": { - "type": "number" - }, - "EnablePadding": { - "type": "boolean" - }, - "FormatVersion": { - "type": "string" - }, - "PaddingTolerance": { - "type": "number" - }, - "RowIndexStride": { - "type": "integer" - }, - "StripeSizeBytes": { - "type": "integer" - } - }, - "type": "object" - }, - "OutputFormatConfiguration": { - "additionalProperties": false, - "properties": { - "Serializer": { - "$ref": "#/definitions/Serializer" - } - }, - "type": "object" - }, - "ParquetSerDe": { - "additionalProperties": false, - "properties": { - "BlockSizeBytes": { - "type": "integer" - }, - "Compression": { - "type": "string" - }, - "EnableDictionaryCompression": { - "type": "boolean" - }, - "MaxPaddingBytes": { - "type": "integer" - }, - "PageSizeBytes": { - "type": "integer" - }, - "WriterVersion": { - "type": "string" - } - }, - "type": "object" - }, - "ProcessingConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Processors": { - "items": { - "$ref": "#/definitions/Processor" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Processor": { - "additionalProperties": false, - "properties": { - "Parameters": { - "items": { - "$ref": "#/definitions/ProcessorParameter" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "enum": [ - "RecordDeAggregation", - "Decompression", - "CloudWatchLogProcessing", - "Lambda", - "MetadataExtraction", - "AppendDelimiterToRecord" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "ProcessorParameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Lambda::Function" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::Lambda::Alias" - } - } - ], - "type": "string" - } - }, - "required": [ - "ParameterValue", - "ParameterName" - ], - "type": "object" - }, - "RedshiftDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "ClusterJDBCURL": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "CopyCommand": { - "$ref": "#/definitions/CopyCommand" - }, - "Password": { - "maxLength": 512, - "minLength": 6, - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/RedshiftRetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupConfiguration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "S3BackupMode": { - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "SecretsManagerConfiguration": { - "$ref": "#/definitions/SecretsManagerConfiguration" - }, - "Username": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "S3Configuration", - "ClusterJDBCURL", - "CopyCommand", - "RoleARN" - ], - "type": "object" - }, - "RedshiftRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "RetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "S3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "maxLength": 2048, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "BufferingHints": { - "$ref": "#/definitions/BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "CompressionFormat": { - "enum": [ - "UNCOMPRESSED", - "GZIP", - "ZIP", - "Snappy", - "HADOOP_SNAPPY" - ], - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "ErrorOutputPrefix": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Prefix": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - } - }, - "required": [ - "BucketARN", - "RoleARN" - ], - "type": "object" - }, - "SchemaConfiguration": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::Glue::Database" - }, - "type": "string" - }, - "Region": { - "type": "string" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "TableName": { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::Glue::Table" - }, - "type": "string" - }, - "VersionId": { - "type": "string" - } - }, - "type": "object" - }, - "SecretsManagerConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "SecretARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::SecretsManager::Secret" - }, - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "Serializer": { - "additionalProperties": false, - "properties": { - "OrcSerDe": { - "$ref": "#/definitions/OrcSerDe" - }, - "ParquetSerDe": { - "$ref": "#/definitions/ParquetSerDe" - } - }, - "type": "object" - }, - "SnowflakeBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "SnowflakeDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "AccountUrl": { - "maxLength": 2048, - "minLength": 24, - "pattern": ".+?\\.snowflakecomputing\\.com", - "type": "string" - }, - "BufferingHints": { - "$ref": "#/definitions/SnowflakeBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "ContentColumnName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DataLoadingOption": { - "enum": [ - "JSON_MAPPING", - "VARIANT_CONTENT_MAPPING", - "VARIANT_CONTENT_AND_METADATA_MAPPING" - ], - "type": "string" - }, - "Database": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "KeyPassphrase": { - "maxLength": 255, - "minLength": 7, - "type": "string" - }, - "MetaDataColumnName": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "PrivateKey": { - "maxLength": 4096, - "minLength": 256, - "pattern": "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$", - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/SnowflakeRetryOptions" - }, - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "S3BackupMode": { - "enum": [ - "FailedDataOnly", - "AllData" - ], - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "Schema": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "SecretsManagerConfiguration": { - "$ref": "#/definitions/SecretsManagerConfiguration" - }, - "SnowflakeRoleConfiguration": { - "$ref": "#/definitions/SnowflakeRoleConfiguration" - }, - "SnowflakeVpcConfiguration": { - "$ref": "#/definitions/SnowflakeVpcConfiguration" - }, - "Table": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "User": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "AccountUrl", - "Database", - "Schema", - "Table", - "RoleARN", - "S3Configuration" - ], - "type": "object" - }, - "SnowflakeRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "SnowflakeRoleConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "SnowflakeRole": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SnowflakeVpcConfiguration": { - "additionalProperties": false, - "properties": { - "PrivateLinkVpceId": { - "maxLength": 255, - "minLength": 47, - "pattern": "([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$", - "type": "string" - } - }, - "required": [ - "PrivateLinkVpceId" - ], - "type": "object" - }, - "SplunkBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "integer" - }, - "SizeInMBs": { - "type": "integer" - } - }, - "type": "object" - }, - "SplunkDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/SplunkBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/CloudWatchLoggingOptions" - }, - "HECAcknowledgmentTimeoutInSeconds": { - "maximum": 600, - "minimum": 180, - "type": "integer" - }, - "HECEndpoint": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "HECEndpointType": { - "enum": [ - "Raw", - "Event" - ], - "type": "string" - }, - "HECToken": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/SplunkRetryOptions" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "SecretsManagerConfiguration": { - "$ref": "#/definitions/SecretsManagerConfiguration" - } - }, - "required": [ - "HECEndpoint", - "S3Configuration", - "HECEndpointType" - ], - "type": "object" - }, - "SplunkRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "UniqueKey": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "VpcConfiguration": { - "additionalProperties": false, - "properties": { - "RoleARN": { - "maxLength": 512, - "minLength": 1, - "pattern": "arn:.*", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "maxLength": 1024, - "minLength": 1, - "relationshipRef": { - "propertyPath": "/properties/GroupId", - "typeName": "AWS::EC2::SecurityGroup" - }, - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "items": { - "maxLength": 1024, - "minLength": 1, - "relationshipRef": { - "propertyPath": "/properties/SubnetId", - "typeName": "AWS::EC2::Subnet" - }, - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "RoleARN", - "SubnetIds", - "SecurityGroupIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::KinesisFirehose::DeliveryStream", - "handlers": { - "create": { - "permissions": [ - "firehose:CreateDeliveryStream", - "firehose:DescribeDeliveryStream", - "iam:GetRole", - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "firehose:DeleteDeliveryStream", - "firehose:DescribeDeliveryStream", - "kms:RevokeGrant", - "kms:DescribeKey" - ] - }, - "list": { - "permissions": [ - "firehose:ListDeliveryStreams" - ] - }, - "read": { - "permissions": [ - "firehose:DescribeDeliveryStream", - "firehose:ListTagsForDeliveryStream" - ] - }, - "update": { - "permissions": [ - "firehose:UpdateDestination", - "firehose:DescribeDeliveryStream", - "firehose:StartDeliveryStreamEncryption", - "firehose:StopDeliveryStreamEncryption", - "firehose:ListTagsForDeliveryStream", - "firehose:TagDeliveryStream", - "firehose:UntagDeliveryStream", - "kms:CreateGrant", - "kms:RevokeGrant", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeliveryStreamName" - ], - "properties": { - "AmazonOpenSearchServerlessDestinationConfiguration": { - "$ref": "#/definitions/AmazonOpenSearchServerlessDestinationConfiguration" - }, - "AmazonopensearchserviceDestinationConfiguration": { - "$ref": "#/definitions/AmazonopensearchserviceDestinationConfiguration" - }, - "Arn": { - "type": "string" - }, - "DeliveryStreamEncryptionConfigurationInput": { - "$ref": "#/definitions/DeliveryStreamEncryptionConfigurationInput" - }, - "DeliveryStreamName": { - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9._-]+", - "type": "string" - }, - "DeliveryStreamType": { - "enum": [ - "DirectPut", - "KinesisStreamAsSource", - "MSKAsSource" - ], - "type": "string" - }, - "ElasticsearchDestinationConfiguration": { - "$ref": "#/definitions/ElasticsearchDestinationConfiguration" - }, - "ExtendedS3DestinationConfiguration": { - "$ref": "#/definitions/ExtendedS3DestinationConfiguration" - }, - "HttpEndpointDestinationConfiguration": { - "$ref": "#/definitions/HttpEndpointDestinationConfiguration" - }, - "IcebergDestinationConfiguration": { - "$ref": "#/definitions/IcebergDestinationConfiguration" - }, - "KinesisStreamSourceConfiguration": { - "$ref": "#/definitions/KinesisStreamSourceConfiguration" - }, - "MSKSourceConfiguration": { - "$ref": "#/definitions/MSKSourceConfiguration" - }, - "RedshiftDestinationConfiguration": { - "$ref": "#/definitions/RedshiftDestinationConfiguration" - }, - "S3DestinationConfiguration": { - "$ref": "#/definitions/S3DestinationConfiguration" - }, - "SnowflakeDestinationConfiguration": { - "$ref": "#/definitions/SnowflakeDestinationConfiguration" - }, - "SplunkDestinationConfiguration": { - "$ref": "#/definitions/SplunkDestinationConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "typeName": "AWS::KinesisFirehose::DeliveryStream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeliveryStreamName", + "/properties/DeliveryStreamType", + "/properties/ElasticsearchDestinationConfiguration/VpcConfiguration", + "/properties/AmazonopensearchserviceDestinationConfiguration/VpcConfiguration", + "/properties/AmazonOpenSearchServerlessDestinationConfiguration/VpcConfiguration", + "/properties/KinesisStreamSourceConfiguration", + "/properties/MSKSourceConfiguration", + "/properties/IcebergDestinationConfiguration", + "/properties/SnowflakeDestinationConfiguration/SnowflakeVpcConfiguration" + ], + "definitions": { + "AmazonOpenSearchServerlessBufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "AmazonOpenSearchServerlessDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/AmazonOpenSearchServerlessBufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "CollectionEndpoint": { + "maxLength": 512, + "minLength": 1, + "pattern": "https:.*", + "relationshipRef": { + "propertyPath": "/properties/CollectionEndpoint", + "typeName": "AWS::OpenSearchServerless::Collection" + }, + "type": "string" + }, + "IndexName": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/AmazonOpenSearchServerlessRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "enum": [ + "FailedDocumentsOnly", + "AllDocuments" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "required": [ + "IndexName", + "S3Configuration", + "RoleARN" + ], + "type": "object" + }, + "AmazonOpenSearchServerlessRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "AmazonopensearchserviceBufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "AmazonopensearchserviceDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/AmazonopensearchserviceBufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "ClusterEndpoint": { + "maxLength": 512, + "minLength": 1, + "pattern": "https:.*", + "type": "string" + }, + "DocumentIdOptions": { + "$ref": "#/definitions/DocumentIdOptions" + }, + "DomainARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "type": "string" + }, + "IndexName": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "IndexRotationPeriod": { + "enum": [ + "NoRotation", + "OneHour", + "OneDay", + "OneWeek", + "OneMonth" + ], + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/AmazonopensearchserviceRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "enum": [ + "FailedDocumentsOnly", + "AllDocuments" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "TypeName": { + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "required": [ + "IndexName", + "S3Configuration", + "RoleARN" + ], + "type": "object" + }, + "AmazonopensearchserviceRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "AuthenticationConfiguration": { + "additionalProperties": false, + "properties": { + "Connectivity": { + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "type": "string" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + } + }, + "required": [ + "RoleARN", + "Connectivity" + ], + "type": "object" + }, + "BufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "CatalogConfiguration": { + "additionalProperties": false, + "properties": { + "CatalogArn": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "type": "string" + } + }, + "type": "object" + }, + "CloudWatchLoggingOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "LogGroupName": { + "relationshipRef": { + "propertyPath": "/properties/LogGroupName", + "typeName": "AWS::Logs::LogGroup" + }, + "type": "string" + }, + "LogStreamName": { + "relationshipRef": { + "propertyPath": "/properties/LogStreamName", + "typeName": "AWS::Logs::LogStream" + }, + "type": "string" + } + }, + "type": "object" + }, + "CopyCommand": { + "additionalProperties": false, + "properties": { + "CopyOptions": { + "maxLength": 204800, + "minLength": 0, + "type": "string" + }, + "DataTableColumns": { + "maxLength": 204800, + "minLength": 0, + "type": "string" + }, + "DataTableName": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataTableName" + ], + "type": "object" + }, + "DataFormatConversionConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "InputFormatConfiguration": { + "$ref": "#/definitions/InputFormatConfiguration" + }, + "OutputFormatConfiguration": { + "$ref": "#/definitions/OutputFormatConfiguration" + }, + "SchemaConfiguration": { + "$ref": "#/definitions/SchemaConfiguration" + } + }, + "type": "object" + }, + "DeliveryStreamEncryptionConfigurationInput": { + "additionalProperties": false, + "properties": { + "KeyARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, + "type": "string" + }, + "KeyType": { + "enum": [ + "AWS_OWNED_CMK", + "CUSTOMER_MANAGED_CMK" + ], + "type": "string" + } + }, + "required": [ + "KeyType" + ], + "type": "object" + }, + "Deserializer": { + "additionalProperties": false, + "properties": { + "HiveJsonSerDe": { + "$ref": "#/definitions/HiveJsonSerDe" + }, + "OpenXJsonSerDe": { + "$ref": "#/definitions/OpenXJsonSerDe" + } + }, + "type": "object" + }, + "DestinationTableConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationDatabaseName": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "DestinationTableName": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "S3ErrorOutputPrefix": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "UniqueKeys": { + "items": { + "$ref": "#/definitions/UniqueKey" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "DestinationDatabaseName", + "DestinationTableName" + ], + "type": "object" + }, + "DestinationTableConfigurationList": { + "items": { + "$ref": "#/definitions/DestinationTableConfiguration" + }, + "type": "array" + }, + "DocumentIdOptions": { + "additionalProperties": false, + "properties": { + "DefaultDocumentIdFormat": { + "enum": [ + "FIREHOSE_DEFAULT", + "NO_DOCUMENT_ID" + ], + "type": "string" + } + }, + "required": [ + "DefaultDocumentIdFormat" + ], + "type": "object" + }, + "DynamicPartitioningConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "RetryOptions": { + "$ref": "#/definitions/RetryOptions" + } + }, + "type": "object" + }, + "ElasticsearchBufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "ElasticsearchDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/ElasticsearchBufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "ClusterEndpoint": { + "maxLength": 512, + "minLength": 1, + "pattern": "https:.*", + "type": "string" + }, + "DocumentIdOptions": { + "$ref": "#/definitions/DocumentIdOptions" + }, + "DomainARN": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Elasticsearch::Domain" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::OpenSearchService::Domain" + } + } + ], + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "type": "string" + }, + "IndexName": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "IndexRotationPeriod": { + "enum": [ + "NoRotation", + "OneHour", + "OneDay", + "OneWeek", + "OneMonth" + ], + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/ElasticsearchRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "enum": [ + "FailedDocumentsOnly", + "AllDocuments" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "TypeName": { + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "required": [ + "IndexName", + "S3Configuration", + "RoleARN" + ], + "type": "object" + }, + "ElasticsearchRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KMSEncryptionConfig": { + "$ref": "#/definitions/KMSEncryptionConfig" + }, + "NoEncryptionConfig": { + "enum": [ + "NoEncryption" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExtendedS3DestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BucketARN": { + "maxLength": 2048, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "BufferingHints": { + "$ref": "#/definitions/BufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "CompressionFormat": { + "enum": [ + "UNCOMPRESSED", + "GZIP", + "ZIP", + "Snappy", + "HADOOP_SNAPPY" + ], + "type": "string" + }, + "CustomTimeZone": { + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "DataFormatConversionConfiguration": { + "$ref": "#/definitions/DataFormatConversionConfiguration" + }, + "DynamicPartitioningConfiguration": { + "$ref": "#/definitions/DynamicPartitioningConfiguration" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ErrorOutputPrefix": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "FileExtension": { + "maxLength": 128, + "minLength": 0, + "pattern": "^$|\\.[0-9a-z!\\-_.*'()]+", + "type": "string" + }, + "Prefix": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupConfiguration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "S3BackupMode": { + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + } + }, + "required": [ + "BucketARN", + "RoleARN" + ], + "type": "object" + }, + "HiveJsonSerDe": { + "additionalProperties": false, + "properties": { + "TimestampFormats": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "HttpEndpointCommonAttribute": { + "additionalProperties": false, + "properties": { + "AttributeName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "AttributeValue": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "AttributeName", + "AttributeValue" + ], + "type": "object" + }, + "HttpEndpointConfiguration": { + "additionalProperties": false, + "properties": { + "AccessKey": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Url": { + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Url" + ], + "type": "object" + }, + "HttpEndpointDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/BufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "EndpointConfiguration": { + "$ref": "#/definitions/HttpEndpointConfiguration" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RequestConfiguration": { + "$ref": "#/definitions/HttpEndpointRequestConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/RetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + } + }, + "required": [ + "EndpointConfiguration", + "S3Configuration" + ], + "type": "object" + }, + "HttpEndpointRequestConfiguration": { + "additionalProperties": false, + "properties": { + "CommonAttributes": { + "items": { + "$ref": "#/definitions/HttpEndpointCommonAttribute" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ContentEncoding": { + "enum": [ + "NONE", + "GZIP" + ], + "type": "string" + } + }, + "type": "object" + }, + "IcebergDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/BufferingHints" + }, + "CatalogConfiguration": { + "$ref": "#/definitions/CatalogConfiguration" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "DestinationTableConfigurationList": { + "$ref": "#/definitions/DestinationTableConfigurationList" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/RetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "s3BackupMode": { + "enum": [ + "AllData", + "FailedDataOnly" + ], + "type": "string" + } + }, + "required": [ + "RoleARN", + "CatalogConfiguration", + "S3Configuration" + ], + "type": "object" + }, + "InputFormatConfiguration": { + "additionalProperties": false, + "properties": { + "Deserializer": { + "$ref": "#/definitions/Deserializer" + } + }, + "type": "object" + }, + "KMSEncryptionConfig": { + "additionalProperties": false, + "properties": { + "AWSKMSKeyARN": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, + "type": "string" + } + }, + "required": [ + "AWSKMSKeyARN" + ], + "type": "object" + }, + "KinesisStreamSourceConfiguration": { + "additionalProperties": false, + "properties": { + "KinesisStreamARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, + "type": "string" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + } + }, + "required": [ + "RoleARN", + "KinesisStreamARN" + ], + "type": "object" + }, + "MSKSourceConfiguration": { + "additionalProperties": false, + "properties": { + "AuthenticationConfiguration": { + "$ref": "#/definitions/AuthenticationConfiguration" + }, + "MSKClusterARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::MSK::Cluster" + }, + "type": "string" + }, + "ReadFromTimestamp": { + "type": "string" + }, + "TopicName": { + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\._\\-]+", + "type": "string" + } + }, + "required": [ + "MSKClusterARN", + "TopicName", + "AuthenticationConfiguration" + ], + "type": "object" + }, + "OpenXJsonSerDe": { + "additionalProperties": false, + "properties": { + "CaseInsensitive": { + "type": "boolean" + }, + "ColumnToJsonKeyMappings": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ConvertDotsInJsonKeysToUnderscores": { + "type": "boolean" + } + }, + "type": "object" + }, + "OrcSerDe": { + "additionalProperties": false, + "properties": { + "BlockSizeBytes": { + "type": "integer" + }, + "BloomFilterColumns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "BloomFilterFalsePositiveProbability": { + "type": "number" + }, + "Compression": { + "type": "string" + }, + "DictionaryKeyThreshold": { + "type": "number" + }, + "EnablePadding": { + "type": "boolean" + }, + "FormatVersion": { + "type": "string" + }, + "PaddingTolerance": { + "type": "number" + }, + "RowIndexStride": { + "type": "integer" + }, + "StripeSizeBytes": { + "type": "integer" + } + }, + "type": "object" + }, + "OutputFormatConfiguration": { + "additionalProperties": false, + "properties": { + "Serializer": { + "$ref": "#/definitions/Serializer" + } + }, + "type": "object" + }, + "ParquetSerDe": { + "additionalProperties": false, + "properties": { + "BlockSizeBytes": { + "type": "integer" + }, + "Compression": { + "type": "string" + }, + "EnableDictionaryCompression": { + "type": "boolean" + }, + "MaxPaddingBytes": { + "type": "integer" + }, + "PageSizeBytes": { + "type": "integer" + }, + "WriterVersion": { + "type": "string" + } + }, + "type": "object" + }, + "ProcessingConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "Processors": { + "items": { + "$ref": "#/definitions/Processor" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Processor": { + "additionalProperties": false, + "properties": { + "Parameters": { + "items": { + "$ref": "#/definitions/ProcessorParameter" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "enum": [ + "RecordDeAggregation", + "Decompression", + "CloudWatchLogProcessing", + "Lambda", + "MetadataExtraction", + "AppendDelimiterToRecord" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ProcessorParameter": { + "additionalProperties": false, + "properties": { + "ParameterName": { + "type": "string" + }, + "ParameterValue": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Lambda::Function" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Lambda::Alias" + } + } + ], + "type": "string" + } + }, + "required": [ + "ParameterValue", + "ParameterName" + ], + "type": "object" + }, + "RedshiftDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "ClusterJDBCURL": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "CopyCommand": { + "$ref": "#/definitions/CopyCommand" + }, + "Password": { + "maxLength": 512, + "minLength": 6, + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/RedshiftRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupConfiguration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "S3BackupMode": { + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + }, + "Username": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "S3Configuration", + "ClusterJDBCURL", + "CopyCommand", + "RoleARN" + ], + "type": "object" + }, + "RedshiftRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "RetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "S3DestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BucketARN": { + "maxLength": 2048, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "BufferingHints": { + "$ref": "#/definitions/BufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "CompressionFormat": { + "enum": [ + "UNCOMPRESSED", + "GZIP", + "ZIP", + "Snappy", + "HADOOP_SNAPPY" + ], + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ErrorOutputPrefix": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Prefix": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + } + }, + "required": [ + "BucketARN", + "RoleARN" + ], + "type": "object" + }, + "SchemaConfiguration": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Glue::Database" + }, + "type": "string" + }, + "Region": { + "type": "string" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "TableName": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Glue::Table" + }, + "type": "string" + }, + "VersionId": { + "type": "string" + } + }, + "type": "object" + }, + "SecretsManagerConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "SecretARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::SecretsManager::Secret" + }, + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "Serializer": { + "additionalProperties": false, + "properties": { + "OrcSerDe": { + "$ref": "#/definitions/OrcSerDe" + }, + "ParquetSerDe": { + "$ref": "#/definitions/ParquetSerDe" + } + }, + "type": "object" + }, + "SnowflakeBufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "SnowflakeDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "AccountUrl": { + "maxLength": 2048, + "minLength": 24, + "pattern": ".+?\\.snowflakecomputing\\.com", + "type": "string" + }, + "BufferingHints": { + "$ref": "#/definitions/SnowflakeBufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "ContentColumnName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DataLoadingOption": { + "enum": [ + "JSON_MAPPING", + "VARIANT_CONTENT_MAPPING", + "VARIANT_CONTENT_AND_METADATA_MAPPING" + ], + "type": "string" + }, + "Database": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "KeyPassphrase": { + "maxLength": 255, + "minLength": 7, + "type": "string" + }, + "MetaDataColumnName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PrivateKey": { + "maxLength": 4096, + "minLength": 256, + "pattern": "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$", + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/SnowflakeRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "enum": [ + "FailedDataOnly", + "AllData" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "Schema": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + }, + "SnowflakeRoleConfiguration": { + "$ref": "#/definitions/SnowflakeRoleConfiguration" + }, + "SnowflakeVpcConfiguration": { + "$ref": "#/definitions/SnowflakeVpcConfiguration" + }, + "Table": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "User": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "AccountUrl", + "Database", + "Schema", + "Table", + "RoleARN", + "S3Configuration" + ], + "type": "object" + }, + "SnowflakeRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "SnowflakeRoleConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "SnowflakeRole": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SnowflakeVpcConfiguration": { + "additionalProperties": false, + "properties": { + "PrivateLinkVpceId": { + "maxLength": 255, + "minLength": 47, + "pattern": "([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$", + "type": "string" + } + }, + "required": [ + "PrivateLinkVpceId" + ], + "type": "object" + }, + "SplunkBufferingHints": { + "additionalProperties": false, + "properties": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + }, + "type": "object" + }, + "SplunkDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "BufferingHints": { + "$ref": "#/definitions/SplunkBufferingHints" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "HECAcknowledgmentTimeoutInSeconds": { + "maximum": 600, + "minimum": 180, + "type": "integer" + }, + "HECEndpoint": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "HECEndpointType": { + "enum": [ + "Raw", + "Event" + ], + "type": "string" + }, + "HECToken": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/SplunkRetryOptions" + }, + "S3BackupMode": { + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + } + }, + "required": [ + "HECEndpoint", + "S3Configuration", + "HECEndpointType" + ], + "type": "object" + }, + "SplunkRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "UniqueKey": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "VpcConfiguration": { + "additionalProperties": false, + "properties": { + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "maxLength": 1024, + "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/GroupId", + "typeName": "AWS::EC2::SecurityGroup" + }, + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "items": { + "maxLength": 1024, + "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "RoleARN", + "SubnetIds", + "SecurityGroupIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::KinesisFirehose::DeliveryStream", + "handlers": { + "create": { + "permissions": [ + "firehose:CreateDeliveryStream", + "firehose:DescribeDeliveryStream", + "iam:GetRole", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "firehose:DeleteDeliveryStream", + "firehose:DescribeDeliveryStream", + "kms:RevokeGrant", + "kms:DescribeKey" + ] + }, + "list": { + "permissions": [ + "firehose:ListDeliveryStreams" + ] + }, + "read": { + "permissions": [ + "firehose:DescribeDeliveryStream", + "firehose:ListTagsForDeliveryStream" + ] + }, + "update": { + "permissions": [ + "firehose:UpdateDestination", + "firehose:DescribeDeliveryStream", + "firehose:StartDeliveryStreamEncryption", + "firehose:StopDeliveryStreamEncryption", + "firehose:ListTagsForDeliveryStream", + "firehose:TagDeliveryStream", + "firehose:UntagDeliveryStream", + "kms:CreateGrant", + "kms:RevokeGrant", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeliveryStreamName" + ], + "properties": { + "AmazonOpenSearchServerlessDestinationConfiguration": { + "$ref": "#/definitions/AmazonOpenSearchServerlessDestinationConfiguration" + }, + "AmazonopensearchserviceDestinationConfiguration": { + "$ref": "#/definitions/AmazonopensearchserviceDestinationConfiguration" + }, + "Arn": { + "type": "string" + }, + "DeliveryStreamEncryptionConfigurationInput": { + "$ref": "#/definitions/DeliveryStreamEncryptionConfigurationInput" + }, + "DeliveryStreamName": { + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9._-]+", + "type": "string" + }, + "DeliveryStreamType": { + "enum": [ + "DirectPut", + "KinesisStreamAsSource", + "MSKAsSource" + ], + "type": "string" + }, + "ElasticsearchDestinationConfiguration": { + "$ref": "#/definitions/ElasticsearchDestinationConfiguration" + }, + "ExtendedS3DestinationConfiguration": { + "$ref": "#/definitions/ExtendedS3DestinationConfiguration" + }, + "HttpEndpointDestinationConfiguration": { + "$ref": "#/definitions/HttpEndpointDestinationConfiguration" + }, + "IcebergDestinationConfiguration": { + "$ref": "#/definitions/IcebergDestinationConfiguration" + }, + "KinesisStreamSourceConfiguration": { + "$ref": "#/definitions/KinesisStreamSourceConfiguration" + }, + "MSKSourceConfiguration": { + "$ref": "#/definitions/MSKSourceConfiguration" + }, + "RedshiftDestinationConfiguration": { + "$ref": "#/definitions/RedshiftDestinationConfiguration" + }, + "S3DestinationConfiguration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SnowflakeDestinationConfiguration": { + "$ref": "#/definitions/SnowflakeDestinationConfiguration" + }, + "SplunkDestinationConfiguration": { + "$ref": "#/definitions/SplunkDestinationConfiguration" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "typeName": "AWS::KinesisFirehose::DeliveryStream" +} diff --git a/schema/aws-kinesisvideo-signalingchannel.json b/schema/aws-kinesisvideo-signalingchannel.json index 259219b..b5224c4 100644 --- a/schema/aws-kinesisvideo-signalingchannel.json +++ b/schema/aws-kinesisvideo-signalingchannel.json @@ -1,103 +1,103 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type Definition for AWS::KinesisVideo::SignalingChannel", - "handlers": { - "create": { - "permissions": [ - "kinesisvideo:CreateSignalingChannel", - "kinesisvideo:DescribeSignalingChannel" - ] - }, - "delete": { - "permissions": [ - "kinesisvideo:DeleteSignalingChannel", - "kinesisvideo:DescribeSignalingChannel" - ] - }, - "read": { - "permissions": [ - "kinesisvideo:DescribeSignalingChannel" - ] - }, - "update": { - "permissions": [ - "kinesisvideo:UpdateSignalingChannel", - "kinesisvideo:DescribeSignalingChannel" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.", - "type": "string" - }, - "MessageTtlSeconds": { - "description": "The period of time a signaling channel retains undelivered messages before they are discarded.", - "maximum": 120, - "minimum": 5, - "type": "integer" - }, - "Name": { - "description": "The name of the Kinesis Video Signaling Channel.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.-]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Type": { - "description": "The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.", - "enum": [ - "SINGLE_MASTER" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisvideo.git", - "typeName": "AWS::KinesisVideo::SignalingChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type Definition for AWS::KinesisVideo::SignalingChannel", + "handlers": { + "create": { + "permissions": [ + "kinesisvideo:CreateSignalingChannel", + "kinesisvideo:DescribeSignalingChannel" + ] + }, + "delete": { + "permissions": [ + "kinesisvideo:DeleteSignalingChannel", + "kinesisvideo:DescribeSignalingChannel" + ] + }, + "read": { + "permissions": [ + "kinesisvideo:DescribeSignalingChannel" + ] + }, + "update": { + "permissions": [ + "kinesisvideo:UpdateSignalingChannel", + "kinesisvideo:DescribeSignalingChannel" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.", + "type": "string" + }, + "MessageTtlSeconds": { + "description": "The period of time a signaling channel retains undelivered messages before they are discarded.", + "maximum": 120, + "minimum": 5, + "type": "integer" + }, + "Name": { + "description": "The name of the Kinesis Video Signaling Channel.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.-]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Type": { + "description": "The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.", + "enum": [ + "SINGLE_MASTER" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisvideo.git", + "typeName": "AWS::KinesisVideo::SignalingChannel" +} diff --git a/schema/aws-kinesisvideo-stream.json b/schema/aws-kinesisvideo-stream.json index e547f48..87707fb 100644 --- a/schema/aws-kinesisvideo-stream.json +++ b/schema/aws-kinesisvideo-stream.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associated with the Kinesis Video Stream.", - "properties": { - "Key": { - "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type Definition for AWS::KinesisVideo::Stream", - "handlers": { - "create": { - "permissions": [ - "kinesisvideo:DescribeStream", - "kinesisvideo:CreateStream" - ] - }, - "delete": { - "permissions": [ - "kinesisvideo:DescribeStream", - "kinesisvideo:DeleteStream" - ] - }, - "read": { - "permissions": [ - "kinesisvideo:DescribeStream" - ] - }, - "update": { - "permissions": [ - "kinesisvideo:DescribeStream", - "kinesisvideo:UpdateStream", - "kinesisvideo:UpdateDataRetention" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the Kinesis Video stream.", - "type": "string" - }, - "DataRetentionInHours": { - "description": "The number of hours till which Kinesis Video will retain the data in the stream", - "maximum": 87600, - "minimum": 0, - "type": "integer" - }, - "DeviceName": { - "description": "The name of the device that is writing to the stream.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.-]+", - "type": "string" - }, - "KmsKeyId": { - "description": "AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.", - "maxLength": 2048, - "minLength": 1, - "pattern": ".+", - "type": "string" - }, - "MediaType": { - "description": "The media type of the stream. Consumers of the stream can use this information when processing the stream.", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*", - "type": "string" - }, - "Name": { - "description": "The name of the Kinesis Video stream.", - "maxLength": 256, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.-]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs associated with the Kinesis Video Stream.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisvideo.git", - "typeName": "AWS::KinesisVideo::Stream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associated with the Kinesis Video Stream.", + "properties": { + "Key": { + "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type Definition for AWS::KinesisVideo::Stream", + "handlers": { + "create": { + "permissions": [ + "kinesisvideo:DescribeStream", + "kinesisvideo:CreateStream" + ] + }, + "delete": { + "permissions": [ + "kinesisvideo:DescribeStream", + "kinesisvideo:DeleteStream" + ] + }, + "read": { + "permissions": [ + "kinesisvideo:DescribeStream" + ] + }, + "update": { + "permissions": [ + "kinesisvideo:DescribeStream", + "kinesisvideo:UpdateStream", + "kinesisvideo:UpdateDataRetention" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the Kinesis Video stream.", + "type": "string" + }, + "DataRetentionInHours": { + "description": "The number of hours till which Kinesis Video will retain the data in the stream", + "maximum": 87600, + "minimum": 0, + "type": "integer" + }, + "DeviceName": { + "description": "The name of the device that is writing to the stream.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.-]+", + "type": "string" + }, + "KmsKeyId": { + "description": "AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.", + "maxLength": 2048, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "MediaType": { + "description": "The media type of the stream. Consumers of the stream can use this information when processing the stream.", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*", + "type": "string" + }, + "Name": { + "description": "The name of the Kinesis Video stream.", + "maxLength": 256, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.-]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs associated with the Kinesis Video Stream.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisvideo.git", + "typeName": "AWS::KinesisVideo::Stream" +} diff --git a/schema/aws-kms-alias.json b/schema/aws-kms-alias.json index c56a6ad..2085919 100644 --- a/schema/aws-kms-alias.json +++ b/schema/aws-kms-alias.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AliasName" - ], - "description": "The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).\n Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.\n When specifying an alias, observe the following rules.\n + Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.\n + The alias and its associated KMS key must be in the same AWS-account and Region.\n + The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an ``alias/projectKey`` in multiple Regions, each of which is associated with a KMS key in its Region.\n + Each alias name must begin with ``alias/`` followed by a name, such as ``alias/exampleKey``. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with ``alias/aws/``. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\n \n *Regions* \n KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported.", - "handlers": { - "create": { - "permissions": [ - "kms:CreateAlias" - ] - }, - "delete": { - "permissions": [ - "kms:DeleteAlias" - ] - }, - "list": { - "permissions": [ - "kms:ListAliases" - ] - }, - "read": { - "permissions": [ - "kms:ListAliases" - ] - }, - "update": { - "permissions": [ - "kms:UpdateAlias" - ] - } - }, - "primaryIdentifier": [ - "/properties/AliasName" - ], - "properties": { - "AliasName": { - "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. \n If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).", - "maxLength": 256, - "minLength": 1, - "pattern": "^(alias/)[a-zA-Z0-9:/_-]+$", - "type": "string" - }, - "TargetKeyId": { - "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.\n A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n For 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) in the *Developer Guide*.\n Specify the key ID or the key ARN of the KMS key.\n For example:\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n \n To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "AliasName", - "TargetKeyId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::KMS::Alias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AliasName" + ], + "description": "The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).\n Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.\n When specifying an alias, observe the following rules.\n + Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.\n + The alias and its associated KMS key must be in the same AWS-account and Region.\n + The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an ``alias/projectKey`` in multiple Regions, each of which is associated with a KMS key in its Region.\n + Each alias name must begin with ``alias/`` followed by a name, such as ``alias/exampleKey``. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with ``alias/aws/``. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\n \n *Regions* \n KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported.", + "handlers": { + "create": { + "permissions": [ + "kms:CreateAlias" + ] + }, + "delete": { + "permissions": [ + "kms:DeleteAlias" + ] + }, + "list": { + "permissions": [ + "kms:ListAliases" + ] + }, + "read": { + "permissions": [ + "kms:ListAliases" + ] + }, + "update": { + "permissions": [ + "kms:UpdateAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/AliasName" + ], + "properties": { + "AliasName": { + "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. \n If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).", + "maxLength": 256, + "minLength": 1, + "pattern": "^(alias/)[a-zA-Z0-9:/_-]+$", + "type": "string" + }, + "TargetKeyId": { + "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.\n A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n For 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) in the *Developer Guide*.\n Specify the key ID or the key ARN of the KMS key.\n For example:\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n \n To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "AliasName", + "TargetKeyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::KMS::Alias" +} diff --git a/schema/aws-kms-key.json b/schema/aws-kms-key.json index 14345f5..704bfe4 100644 --- a/schema/aws-kms-key.json +++ b/schema/aws-kms-key.json @@ -1,199 +1,199 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.\n Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.\n For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the *Billing and Cost Management User Guide*.", - "properties": { - "Key": { - "description": "", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.\n If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.\n KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.\n You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.\n You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.\n You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.\n You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).\n *Regions* \n KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region.", - "handlers": { - "create": { - "permissions": [ - "kms:CreateKey", - "kms:EnableKeyRotation", - "kms:DisableKey", - "kms:TagResource", - "kms:PutKeyPolicy" - ] - }, - "delete": { - "permissions": [ - "kms:DescribeKey", - "kms:ScheduleKeyDeletion" - ] - }, - "list": { - "permissions": [ - "kms:ListKeys", - "kms:DescribeKey" - ] - }, - "read": { - "permissions": [ - "kms:DescribeKey", - "kms:GetKeyPolicy", - "kms:GetKeyRotationStatus", - "kms:ListResourceTags" - ] - }, - "update": { - "permissions": [ - "kms:DescribeKey", - "kms:DisableKey", - "kms:DisableKeyRotation", - "kms:EnableKey", - "kms:EnableKeyRotation", - "kms:PutKeyPolicy", - "kms:TagResource", - "kms:UntagResource", - "kms:UpdateKeyDescription", - "kms:ListResourceTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyId" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "BypassPolicyLockoutSafetyCheck": { - "default": false, - "description": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.\n Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.\n For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.\n Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.", - "type": "boolean" - }, - "Description": { - "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.", - "maxLength": 8192, - "minLength": 0, - "type": "string" - }, - "EnableKeyRotation": { - "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.\n KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.\n To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.\n When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", - "type": "boolean" - }, - "Enabled": { - "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.\n When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.\n The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.", - "type": "boolean" - }, - "KeyId": { - "description": "", - "type": "string" - }, - "KeyPolicy": { - "default": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"key-default\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn::iam:::root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n }\n ]\n}", - "description": "The key policy to attach to the KMS key.\n If you provide a key policy, it must meet the following criteria:\n + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)\n + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.\n \n If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.\n A key policy document can include only the following characters:\n + Printable ASCII characters\n + Printable characters in the Basic Latin and Latin-1 Supplement character set\n + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters\n \n *Minimum*: ``1`` \n *Maximum*: ``32768``", - "type": [ - "object", - "string" - ] - }, - "KeySpec": { - "default": "SYMMETRIC_DEFAULT", - "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.\n The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.\n If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.\n KMS supports the following key specs for KMS keys:\n + Symmetric encryption key (default)\n + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)\n \n + HMAC keys (symmetric)\n + ``HMAC_224`` \n + ``HMAC_256`` \n + ``HMAC_384`` \n + ``HMAC_512`` \n \n + Asymmetric RSA key pairs\n + ``RSA_2048`` \n + ``RSA_3072`` \n + ``RSA_4096`` \n \n + Asymmetric NIST-recommended elliptic curve key pairs\n + ``ECC_NIST_P256`` (secp256r1)\n + ``ECC_NIST_P384`` (secp384r1)\n + ``ECC_NIST_P521`` (secp521r1)\n \n + Other asymmetric elliptic curve key pairs\n + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.\n \n + SM2 key pairs (China Regions only)\n + ``SM2``", - "enum": [ - "SYMMETRIC_DEFAULT", - "RSA_2048", - "RSA_3072", - "RSA_4096", - "ECC_NIST_P256", - "ECC_NIST_P384", - "ECC_NIST_P521", - "ECC_SECG_P256K1", - "HMAC_224", - "HMAC_256", - "HMAC_384", - "HMAC_512", - "SM2" - ], - "type": "string" - }, - "KeyUsage": { - "default": "ENCRYPT_DECRYPT", - "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.\n If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n Select only one valid value.\n + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.\n + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``.\n + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", - "enum": [ - "ENCRYPT_DECRYPT", - "SIGN_VERIFY", - "GENERATE_VERIFY_MAC", - "KEY_AGREEMENT" - ], - "type": "string" - }, - "MultiRegion": { - "default": false, - "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created.\n For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.\n If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.\n *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.", - "type": "boolean" - }, - "Origin": { - "default": "AWS_KMS", - "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.\n To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.\n You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. \n CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", - "enum": [ - "AWS_KMS", - "EXTERNAL" - ], - "type": "string" - }, - "PendingWindowInDays": { - "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.\n KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.\n You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.", - "maximum": 30, - "minimum": 7, - "type": "integer" - }, - "RotationPeriodInDays": { - "default": 365, - "description": "Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.\n The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.\n You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter.\n For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", - "maximum": 2560, - "minimum": 90, - "type": "integer" - }, - "Tags": { - "description": "Assigns one or more tags to the replica key.\n Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/KeyId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kms", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KMS::Key", - "writeOnlyProperties": [ - "/properties/PendingWindowInDays", - "/properties/BypassPolicyLockoutSafetyCheck", - "/properties/RotationPeriodInDays" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.\n Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.\n For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the *Billing and Cost Management User Guide*.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with ``aws:``. digits, whitespace, ``_``, ``.``, ``:``, ``/``, ``=``, ``+``, ``@``, ``-``, and ``\"``.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, ``_``, ``.``, ``/``, ``=``, ``+``, and ``-``.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.\n If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.\n KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.\n You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.\n You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.\n You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.\n You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).\n *Regions* \n KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region.", + "handlers": { + "create": { + "permissions": [ + "kms:CreateKey", + "kms:EnableKeyRotation", + "kms:DisableKey", + "kms:TagResource", + "kms:PutKeyPolicy" + ] + }, + "delete": { + "permissions": [ + "kms:DescribeKey", + "kms:ScheduleKeyDeletion" + ] + }, + "list": { + "permissions": [ + "kms:ListKeys", + "kms:DescribeKey" + ] + }, + "read": { + "permissions": [ + "kms:DescribeKey", + "kms:GetKeyPolicy", + "kms:GetKeyRotationStatus", + "kms:ListResourceTags" + ] + }, + "update": { + "permissions": [ + "kms:DescribeKey", + "kms:DisableKey", + "kms:DisableKeyRotation", + "kms:EnableKey", + "kms:EnableKeyRotation", + "kms:PutKeyPolicy", + "kms:TagResource", + "kms:UntagResource", + "kms:UpdateKeyDescription", + "kms:ListResourceTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyId" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "BypassPolicyLockoutSafetyCheck": { + "default": false, + "description": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.\n Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.\n For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.\n Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.", + "type": "boolean" + }, + "Description": { + "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "EnableKeyRotation": { + "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.\n KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.\n To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.\n When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", + "type": "boolean" + }, + "Enabled": { + "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.\n When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.\n The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.", + "type": "boolean" + }, + "KeyId": { + "description": "", + "type": "string" + }, + "KeyPolicy": { + "default": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"key-default\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn::iam:::root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n }\n ]\n}", + "description": "The key policy to attach to the KMS key.\n If you provide a key policy, it must meet the following criteria:\n + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)\n + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.\n \n If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.\n A key policy document can include only the following characters:\n + Printable ASCII characters\n + Printable characters in the Basic Latin and Latin-1 Supplement character set\n + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters\n \n *Minimum*: ``1`` \n *Maximum*: ``32768``", + "type": [ + "object", + "string" + ] + }, + "KeySpec": { + "default": "SYMMETRIC_DEFAULT", + "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.\n The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.\n If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.\n KMS supports the following key specs for KMS keys:\n + Symmetric encryption key (default)\n + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)\n \n + HMAC keys (symmetric)\n + ``HMAC_224`` \n + ``HMAC_256`` \n + ``HMAC_384`` \n + ``HMAC_512`` \n \n + Asymmetric RSA key pairs (encryption and decryption *or* signing and verification)\n + ``RSA_2048`` \n + ``RSA_3072`` \n + ``RSA_4096`` \n \n + Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets)\n + ``ECC_NIST_P256`` (secp256r1)\n + ``ECC_NIST_P384`` (secp384r1)\n + ``ECC_NIST_P521`` (secp521r1)\n \n + Other asymmetric elliptic curve key pairs (signing and verification)\n + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.\n \n + SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets)\n + ``SM2`` (China Regions only)", + "enum": [ + "SYMMETRIC_DEFAULT", + "RSA_2048", + "RSA_3072", + "RSA_4096", + "ECC_NIST_P256", + "ECC_NIST_P384", + "ECC_NIST_P521", + "ECC_SECG_P256K1", + "HMAC_224", + "HMAC_256", + "HMAC_384", + "HMAC_512", + "SM2" + ], + "type": "string" + }, + "KeyUsage": { + "default": "ENCRYPT_DECRYPT", + "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.\n If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n Select only one valid value.\n + For symmetric encryption KMS keys, omit the parameter or specify ``ENCRYPT_DECRYPT``.\n + For HMAC KMS keys (symmetric), specify ``GENERATE_VERIFY_MAC``.\n + For asymmetric KMS keys with RSA key pairs, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify ``SIGN_VERIFY`` or ``KEY_AGREEMENT``.\n + For asymmetric KMS keys with ``ECC_SECG_P256K1`` key pairs specify ``SIGN_VERIFY``.\n + For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ``ENCRYPT_DECRYPT``, ``SIGN_VERIFY``, or ``KEY_AGREEMENT``.", + "enum": [ + "ENCRYPT_DECRYPT", + "SIGN_VERIFY", + "GENERATE_VERIFY_MAC", + "KEY_AGREEMENT" + ], + "type": "string" + }, + "MultiRegion": { + "default": false, + "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created.\n For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.\n If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.\n *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.", + "type": "boolean" + }, + "Origin": { + "default": "AWS_KMS", + "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.\n To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.\n You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. \n CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", + "enum": [ + "AWS_KMS", + "EXTERNAL" + ], + "type": "string" + }, + "PendingWindowInDays": { + "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.\n KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.\n You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.", + "maximum": 30, + "minimum": 7, + "type": "integer" + }, + "RotationPeriodInDays": { + "default": 365, + "description": "Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.\n The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.\n You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter.\n For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", + "maximum": 2560, + "minimum": 90, + "type": "integer" + }, + "Tags": { + "description": "Assigns one or more tags to the replica key.\n Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/KeyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kms", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KMS::Key", + "writeOnlyProperties": [ + "/properties/PendingWindowInDays", + "/properties/BypassPolicyLockoutSafetyCheck", + "/properties/RotationPeriodInDays" + ] +} diff --git a/schema/aws-kms-replicakey.json b/schema/aws-kms-replicakey.json index 1c6a47b..e4efd63 100644 --- a/schema/aws-kms-replicakey.json +++ b/schema/aws-kms-replicakey.json @@ -1,141 +1,142 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PrimaryKeyArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).", - "handlers": { - "create": { - "permissions": [ - "kms:ReplicateKey", - "kms:CreateKey", - "kms:DescribeKey", - "kms:DisableKey", - "kms:TagResource" - ] - }, - "delete": { - "permissions": [ - "kms:DescribeKey", - "kms:ScheduleKeyDeletion" - ] - }, - "list": { - "permissions": [ - "kms:ListKeys", - "kms:DescribeKey" - ] - }, - "read": { - "permissions": [ - "kms:DescribeKey", - "kms:GetKeyPolicy", - "kms:ListResourceTags" - ] - }, - "update": { - "permissions": [ - "kms:DescribeKey", - "kms:DisableKey", - "kms:EnableKey", - "kms:PutKeyPolicy", - "kms:TagResource", - "kms:UntagResource", - "kms:UpdateKeyDescription" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "description": "A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.", - "maxLength": 8192, - "minLength": 0, - "type": "string" - }, - "Enabled": { - "description": "Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.", - "type": "boolean" - }, - "KeyId": { - "type": "string" - }, - "KeyPolicy": { - "description": "The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.", - "type": [ - "object", - "string" - ] - }, - "PendingWindowInDays": { - "description": "Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.", - "maximum": 30, - "minimum": 7, - "type": "integer" - }, - "PrimaryKeyArn": { - "description": "Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/KeyId" - ], - "required": [ - "PrimaryKeyArn", - "KeyPolicy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kms", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::KMS::ReplicaKey", - "writeOnlyProperties": [ - "/properties/PendingWindowInDays" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PrimaryKeyArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).", + "handlers": { + "create": { + "permissions": [ + "kms:ReplicateKey", + "kms:CreateKey", + "kms:DescribeKey", + "kms:DisableKey", + "kms:TagResource" + ] + }, + "delete": { + "permissions": [ + "kms:DescribeKey", + "kms:ScheduleKeyDeletion" + ] + }, + "list": { + "permissions": [ + "kms:ListKeys", + "kms:DescribeKey" + ] + }, + "read": { + "permissions": [ + "kms:DescribeKey", + "kms:GetKeyPolicy", + "kms:ListResourceTags" + ] + }, + "update": { + "permissions": [ + "kms:DescribeKey", + "kms:DisableKey", + "kms:EnableKey", + "kms:PutKeyPolicy", + "kms:TagResource", + "kms:UntagResource", + "kms:UpdateKeyDescription" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "description": "A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "Enabled": { + "description": "Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.", + "type": "boolean" + }, + "KeyId": { + "type": "string" + }, + "KeyPolicy": { + "description": "The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.", + "type": [ + "object", + "string" + ] + }, + "PendingWindowInDays": { + "description": "Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.", + "maximum": 30, + "minimum": 7, + "type": "integer" + }, + "PrimaryKeyArn": { + "description": "Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/KeyId" + ], + "required": [ + "PrimaryKeyArn", + "KeyPolicy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kms", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KMS::ReplicaKey", + "writeOnlyProperties": [ + "/properties/PendingWindowInDays" + ] +} diff --git a/schema/aws-lakeformation-datacellsfilter.json b/schema/aws-lakeformation-datacellsfilter.json index eb7e791..582f82c 100644 --- a/schema/aws-lakeformation-datacellsfilter.json +++ b/schema/aws-lakeformation-datacellsfilter.json @@ -1,133 +1,133 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TableCatalogId", - "/properties/DatabaseName", - "/properties/TableName", - "/properties/Name", - "/properties/RowFilter", - "/properties/ColumnNames", - "/properties/ColumnWildcard" - ], - "definitions": { - "CatalogIdString": { - "description": "A string representing the Catalog Id.", - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "ColumnNames": { - "description": "A list of column names.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NameString" - }, - "type": "array" - }, - "ColumnWildcard": { - "additionalProperties": false, - "description": "An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required.", - "properties": { - "ExcludedColumnNames": { - "$ref": "#/definitions/ColumnNames", - "description": "A list of column names to be excluded from the Data Cells Filter." - } - }, - "type": "object" - }, - "NameString": { - "description": "A string representing a resource's name.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RowFilter": { - "additionalProperties": false, - "description": "An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required.", - "properties": { - "AllRowsWildcard": { - "additionalProperties": false, - "description": "An empty object representing a row wildcard.", - "type": "object" - }, - "FilterExpression": { - "description": "A PartiQL predicate.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "A resource schema representing a Lake Formation Data Cells Filter.", - "handlers": { - "create": { - "permissions": [ - "lakeformation:CreateDataCellsFilter", - "glue:GetTable" - ] - }, - "delete": { - "permissions": [ - "lakeformation:DeleteDataCellsFilter" - ] - }, - "list": { - "permissions": [ - "lakeformation:ListDataCellsFilter" - ] - }, - "read": { - "permissions": [ - "lakeformation:ListDataCellsFilter" - ] - } - }, - "primaryIdentifier": [ - "/properties/TableCatalogId", - "/properties/DatabaseName", - "/properties/TableName", - "/properties/Name" - ], - "properties": { - "ColumnNames": { - "$ref": "#/definitions/ColumnNames", - "description": "A list of columns to be included in this Data Cells Filter." - }, - "ColumnWildcard": { - "$ref": "#/definitions/ColumnWildcard", - "description": "An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required" - }, - "DatabaseName": { - "$ref": "#/definitions/NameString", - "description": "The name of the Database that the Table resides in." - }, - "Name": { - "$ref": "#/definitions/NameString", - "description": "The desired name of the Data Cells Filter." - }, - "RowFilter": { - "$ref": "#/definitions/RowFilter", - "description": "An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required" - }, - "TableCatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The Catalog Id of the Table on which to create a Data Cells Filter." - }, - "TableName": { - "$ref": "#/definitions/NameString", - "description": "The name of the Table to create a Data Cells Filter for." - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "TableCatalogId", - "DatabaseName", - "TableName", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::LakeFormation::DataCellsFilter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TableCatalogId", + "/properties/DatabaseName", + "/properties/TableName", + "/properties/Name", + "/properties/RowFilter", + "/properties/ColumnNames", + "/properties/ColumnWildcard" + ], + "definitions": { + "CatalogIdString": { + "description": "A string representing the Catalog Id.", + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "ColumnNames": { + "description": "A list of column names.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NameString" + }, + "type": "array" + }, + "ColumnWildcard": { + "additionalProperties": false, + "description": "An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required.", + "properties": { + "ExcludedColumnNames": { + "$ref": "#/definitions/ColumnNames", + "description": "A list of column names to be excluded from the Data Cells Filter." + } + }, + "type": "object" + }, + "NameString": { + "description": "A string representing a resource's name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RowFilter": { + "additionalProperties": false, + "description": "An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required.", + "properties": { + "AllRowsWildcard": { + "additionalProperties": false, + "description": "An empty object representing a row wildcard.", + "type": "object" + }, + "FilterExpression": { + "description": "A PartiQL predicate.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "A resource schema representing a Lake Formation Data Cells Filter.", + "handlers": { + "create": { + "permissions": [ + "lakeformation:CreateDataCellsFilter", + "glue:GetTable" + ] + }, + "delete": { + "permissions": [ + "lakeformation:DeleteDataCellsFilter" + ] + }, + "list": { + "permissions": [ + "lakeformation:ListDataCellsFilter" + ] + }, + "read": { + "permissions": [ + "lakeformation:ListDataCellsFilter" + ] + } + }, + "primaryIdentifier": [ + "/properties/TableCatalogId", + "/properties/DatabaseName", + "/properties/TableName", + "/properties/Name" + ], + "properties": { + "ColumnNames": { + "$ref": "#/definitions/ColumnNames", + "description": "A list of columns to be included in this Data Cells Filter." + }, + "ColumnWildcard": { + "$ref": "#/definitions/ColumnWildcard", + "description": "An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required" + }, + "DatabaseName": { + "$ref": "#/definitions/NameString", + "description": "The name of the Database that the Table resides in." + }, + "Name": { + "$ref": "#/definitions/NameString", + "description": "The desired name of the Data Cells Filter." + }, + "RowFilter": { + "$ref": "#/definitions/RowFilter", + "description": "An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required" + }, + "TableCatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The Catalog Id of the Table on which to create a Data Cells Filter." + }, + "TableName": { + "$ref": "#/definitions/NameString", + "description": "The name of the Table to create a Data Cells Filter for." + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "TableCatalogId", + "DatabaseName", + "TableName", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::LakeFormation::DataCellsFilter" +} diff --git a/schema/aws-lakeformation-datalakesettings.json b/schema/aws-lakeformation-datalakesettings.json index 183183a..b7cdf31 100644 --- a/schema/aws-lakeformation-datalakesettings.json +++ b/schema/aws-lakeformation-datalakesettings.json @@ -1,72 +1,72 @@ -{ - "additionalProperties": false, - "definitions": { - "Admins": { - "additionalProperties": false, - "type": "object" - }, - "CreateDatabaseDefaultPermissions": { - "additionalProperties": false, - "type": "object" - }, - "CreateTableDefaultPermissions": { - "additionalProperties": false, - "type": "object" - }, - "ExternalDataFilteringAllowList": { - "additionalProperties": false, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::LakeFormation::DataLakeSettings", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Admins": { - "$ref": "#/definitions/Admins" - }, - "AllowExternalDataFiltering": { - "type": "boolean" - }, - "AllowFullTableExternalDataAccess": { - "type": "boolean" - }, - "AuthorizedSessionTagValueList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CreateDatabaseDefaultPermissions": { - "$ref": "#/definitions/CreateDatabaseDefaultPermissions" - }, - "CreateTableDefaultPermissions": { - "$ref": "#/definitions/CreateTableDefaultPermissions" - }, - "ExternalDataFilteringAllowList": { - "$ref": "#/definitions/ExternalDataFilteringAllowList" - }, - "Id": { - "type": "string" - }, - "MutationType": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "TrustedResourceOwners": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::LakeFormation::DataLakeSettings" -} +{ + "additionalProperties": false, + "definitions": { + "Admins": { + "additionalProperties": false, + "type": "object" + }, + "CreateDatabaseDefaultPermissions": { + "additionalProperties": false, + "type": "object" + }, + "CreateTableDefaultPermissions": { + "additionalProperties": false, + "type": "object" + }, + "ExternalDataFilteringAllowList": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::LakeFormation::DataLakeSettings", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Admins": { + "$ref": "#/definitions/Admins" + }, + "AllowExternalDataFiltering": { + "type": "boolean" + }, + "AllowFullTableExternalDataAccess": { + "type": "boolean" + }, + "AuthorizedSessionTagValueList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CreateDatabaseDefaultPermissions": { + "$ref": "#/definitions/CreateDatabaseDefaultPermissions" + }, + "CreateTableDefaultPermissions": { + "$ref": "#/definitions/CreateTableDefaultPermissions" + }, + "ExternalDataFilteringAllowList": { + "$ref": "#/definitions/ExternalDataFilteringAllowList" + }, + "Id": { + "type": "string" + }, + "MutationType": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "TrustedResourceOwners": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::LakeFormation::DataLakeSettings" +} diff --git a/schema/aws-lakeformation-permissions.json b/schema/aws-lakeformation-permissions.json index b03214f..fcf7017 100644 --- a/schema/aws-lakeformation-permissions.json +++ b/schema/aws-lakeformation-permissions.json @@ -1,157 +1,157 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataLakePrincipal", - "/properties/Resource" - ], - "definitions": { - "ColumnWildcard": { - "additionalProperties": false, - "properties": { - "ExcludedColumnNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DataLakePrincipal": { - "additionalProperties": false, - "properties": { - "DataLakePrincipalIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "DataLocationResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "S3Resource": { - "type": "string" - } - }, - "type": "object" - }, - "DatabaseResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "Resource": { - "additionalProperties": false, - "properties": { - "DataLocationResource": { - "$ref": "#/definitions/DataLocationResource" - }, - "DatabaseResource": { - "$ref": "#/definitions/DatabaseResource" - }, - "TableResource": { - "$ref": "#/definitions/TableResource" - }, - "TableWithColumnsResource": { - "$ref": "#/definitions/TableWithColumnsResource" - } - }, - "type": "object" - }, - "TableResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "TableWildcard": { - "$ref": "#/definitions/TableWildcard" - } - }, - "type": "object" - }, - "TableWildcard": { - "additionalProperties": false, - "type": "object" - }, - "TableWithColumnsResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "ColumnNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ColumnWildcard": { - "$ref": "#/definitions/ColumnWildcard" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::LakeFormation::Permissions", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DataLakePrincipal": { - "$ref": "#/definitions/DataLakePrincipal" - }, - "Id": { - "type": "string" - }, - "Permissions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PermissionsWithGrantOption": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Resource": { - "$ref": "#/definitions/Resource" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DataLakePrincipal", - "Resource" - ], - "typeName": "AWS::LakeFormation::Permissions" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataLakePrincipal", + "/properties/Resource" + ], + "definitions": { + "ColumnWildcard": { + "additionalProperties": false, + "properties": { + "ExcludedColumnNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DataLakePrincipal": { + "additionalProperties": false, + "properties": { + "DataLakePrincipalIdentifier": { + "type": "string" + } + }, + "type": "object" + }, + "DataLocationResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "S3Resource": { + "type": "string" + } + }, + "type": "object" + }, + "DatabaseResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "Resource": { + "additionalProperties": false, + "properties": { + "DataLocationResource": { + "$ref": "#/definitions/DataLocationResource" + }, + "DatabaseResource": { + "$ref": "#/definitions/DatabaseResource" + }, + "TableResource": { + "$ref": "#/definitions/TableResource" + }, + "TableWithColumnsResource": { + "$ref": "#/definitions/TableWithColumnsResource" + } + }, + "type": "object" + }, + "TableResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "TableWildcard": { + "$ref": "#/definitions/TableWildcard" + } + }, + "type": "object" + }, + "TableWildcard": { + "additionalProperties": false, + "type": "object" + }, + "TableWithColumnsResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "type": "string" + }, + "ColumnNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ColumnWildcard": { + "$ref": "#/definitions/ColumnWildcard" + }, + "DatabaseName": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::LakeFormation::Permissions", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DataLakePrincipal": { + "$ref": "#/definitions/DataLakePrincipal" + }, + "Id": { + "type": "string" + }, + "Permissions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PermissionsWithGrantOption": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Resource": { + "$ref": "#/definitions/Resource" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DataLakePrincipal", + "Resource" + ], + "typeName": "AWS::LakeFormation::Permissions" +} diff --git a/schema/aws-lakeformation-principalpermissions.json b/schema/aws-lakeformation-principalpermissions.json index 7cea2b4..b2cecc2 100644 --- a/schema/aws-lakeformation-principalpermissions.json +++ b/schema/aws-lakeformation-principalpermissions.json @@ -1,518 +1,518 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Catalog", - "/properties/Principal", - "/properties/Resource", - "/properties/Permissions", - "/properties/PermissionsWithGrantOption" - ], - "definitions": { - "CatalogIdString": { - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "CatalogResource": { - "additionalProperties": false, - "type": "object" - }, - "ColumnNames": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NameString" - }, - "type": "array" - }, - "ColumnWildcard": { - "additionalProperties": false, - "description": "A wildcard object, consisting of an optional list of excluded column names or indexes.", - "properties": { - "ExcludedColumnNames": { - "$ref": "#/definitions/ColumnNames", - "description": "Excludes column names. Any column with this name will be excluded." - } - }, - "type": "object" - }, - "DataCellsFilterResource": { - "additionalProperties": false, - "description": "A structure that describes certain columns on certain rows.", - "properties": { - "DatabaseName": { - "$ref": "#/definitions/NameString", - "description": "A database in the GLUDC." - }, - "Name": { - "$ref": "#/definitions/NameString", - "description": "The name given by the user to the data filter cell." - }, - "TableCatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The ID of the catalog to which the table belongs." - }, - "TableName": { - "$ref": "#/definitions/NameString", - "description": "The name of the table." - } - }, - "required": [ - "TableCatalogId", - "DatabaseName", - "TableName", - "Name" - ], - "type": "object" - }, - "DataLakePrincipal": { - "additionalProperties": false, - "description": "The LFlong principal.", - "properties": { - "DataLakePrincipalIdentifier": { - "$ref": "#/definitions/DataLakePrincipalString", - "description": "An identifier for the LFlong principal." - } - }, - "type": "object" - }, - "DataLakePrincipalList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DataLakePrincipal" - }, - "type": "array" - }, - "DataLakePrincipalString": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DataLocationResource": { - "additionalProperties": false, - "description": "A structure for a data location object where permissions are granted or revoked.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the GLUDC where the location is registered with LFlong." - }, - "ResourceArn": { - "$ref": "#/definitions/ResourceArnString", - "description": "The Amazon Resource Name (ARN) that uniquely identifies the data location resource." - } - }, - "required": [ - "CatalogId", - "ResourceArn" - ], - "type": "object" - }, - "DatabaseResource": { - "additionalProperties": false, - "description": "A structure for the database object.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the Data Catalog. By default, it is the account ID of the caller." - }, - "Name": { - "$ref": "#/definitions/NameString", - "description": "The name of the database resource. Unique to the Data Catalog." - } - }, - "required": [ - "CatalogId", - "Name" - ], - "type": "object" - }, - "Expression": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTag" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "IAMRoleArn": { - "pattern": "arn:*:iam::[0-9]*:role/.*", - "type": "string" - }, - "LFTag": { - "additionalProperties": false, - "description": "The LF-tag key and values attached to a resource.", - "properties": { - "TagKey": { - "$ref": "#/definitions/LFTagKey", - "description": "The key-name for the LF-tag." - }, - "TagValues": { - "$ref": "#/definitions/TagValueList", - "description": "A list of possible values of the corresponding ``TagKey`` of an LF-tag key-value pair." - } - }, - "type": "object" - }, - "LFTagKey": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LFTagKeyResource": { - "additionalProperties": false, - "description": "A structure containing an LF-tag key and values for a resource.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the GLUDC where the location is registered with GLUDC." - }, - "TagKey": { - "$ref": "#/definitions/NameString", - "description": "The key-name for the LF-tag." - }, - "TagValues": { - "$ref": "#/definitions/TagValueList", - "description": "A list of possible values for the corresponding ``TagKey`` of an LF-tag key-value pair." - } - }, - "required": [ - "CatalogId", - "TagKey", - "TagValues" - ], - "type": "object" - }, - "LFTagPair": { - "additionalProperties": false, - "description": "", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString" - }, - "TagKey": { - "$ref": "#/definitions/LFTagKey" - }, - "TagValues": { - "$ref": "#/definitions/TagValueList" - } - }, - "required": [ - "TagKey", - "TagValues" - ], - "type": "object" - }, - "LFTagPolicyResource": { - "additionalProperties": false, - "description": "A list of LF-tag conditions that define a resource's LF-tag policy.\n A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the GLUDC. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment." - }, - "Expression": { - "$ref": "#/definitions/Expression", - "description": "A list of LF-tag conditions that apply to the resource's LF-tag policy." - }, - "ResourceType": { - "$ref": "#/definitions/ResourceType", - "description": "The resource type for which the LF-tag policy applies." - } - }, - "required": [ - "CatalogId", - "ResourceType", - "Expression" - ], - "type": "object" - }, - "LFTagValue": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "LFTagsList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTagPair" - }, - "type": "array" - }, - "NameString": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "NullableBoolean": { - "type": [ - "boolean", - "null" - ] - }, - "PathString": { - "type": "string" - }, - "Permission": { - "enum": [ - "ALL", - "SELECT", - "ALTER", - "DROP", - "DELETE", - "INSERT", - "DESCRIBE", - "CREATE_DATABASE", - "CREATE_TABLE", - "DATA_LOCATION_ACCESS", - "CREATE_TAG", - "ASSOCIATE" - ], - "type": "string" - }, - "PermissionList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Permission" - }, - "type": "array" - }, - "PrincipalPermissions": { - "additionalProperties": false, - "description": "", - "properties": { - "DataLakePrincipal": { - "$ref": "#/definitions/DataLakePrincipal" - }, - "PermissionList": { - "$ref": "#/definitions/PermissionList" - } - }, - "type": "object" - }, - "PrincipalPermissionsList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PrincipalPermissions" - }, - "type": "array" - }, - "PrincipalResourcePair": { - "additionalProperties": false, - "description": "", - "properties": { - "Principal": { - "$ref": "#/definitions/DataLakePrincipal" - }, - "Resource": { - "$ref": "#/definitions/Resource" - } - }, - "required": [ - "Principal", - "Resource" - ], - "type": "object" - }, - "Resource": { - "additionalProperties": false, - "description": "A structure for the resource.", - "properties": { - "Catalog": { - "$ref": "#/definitions/CatalogResource", - "description": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment." - }, - "DataCellsFilter": { - "$ref": "#/definitions/DataCellsFilterResource", - "description": "A data cell filter." - }, - "DataLocation": { - "$ref": "#/definitions/DataLocationResource", - "description": "The location of an Amazon S3 path where permissions are granted or revoked." - }, - "Database": { - "$ref": "#/definitions/DatabaseResource", - "description": "The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal." - }, - "LFTag": { - "$ref": "#/definitions/LFTagKeyResource", - "description": "The LF-tag key and values attached to a resource." - }, - "LFTagPolicy": { - "$ref": "#/definitions/LFTagPolicyResource", - "description": "A list of LF-tag conditions that define a resource's LF-tag policy." - }, - "Table": { - "$ref": "#/definitions/TableResource", - "description": "The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal." - }, - "TableWithColumns": { - "$ref": "#/definitions/TableWithColumnsResource", - "description": "The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3." - } - }, - "type": "object" - }, - "ResourceArnString": { - "type": "string" - }, - "ResourceType": { - "enum": [ - "DATABASE", - "TABLE" - ], - "type": "string" - }, - "TableResource": { - "additionalProperties": false, - "description": "A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the Data Catalog. By default, it is the account ID of the caller." - }, - "DatabaseName": { - "$ref": "#/definitions/NameString", - "description": "The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal." - }, - "Name": { - "$ref": "#/definitions/NameString", - "description": "The name of the table." - }, - "TableWildcard": { - "$ref": "#/definitions/TableWildcard", - "description": "A wildcard object representing every table under a database.\n At least one of ``TableResource$Name`` or ``TableResource$TableWildcard`` is required." - } - }, - "required": [ - "CatalogId", - "DatabaseName" - ], - "type": "object" - }, - "TableWildcard": { - "additionalProperties": false, - "type": "object" - }, - "TableWithColumnsResource": { - "additionalProperties": false, - "description": "A structure for a table with columns object. This object is only used when granting a SELECT permission.\n This object must take a value for at least one of ``ColumnsNames``, ``ColumnsIndexes``, or ``ColumnsWildcard``.", - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the GLUDC where the location is registered with LFlong." - }, - "ColumnNames": { - "$ref": "#/definitions/ColumnNames", - "description": "The list of column names for the table. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required." - }, - "ColumnWildcard": { - "$ref": "#/definitions/ColumnWildcard", - "description": "A wildcard specified by a ``ColumnWildcard`` object. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required." - }, - "DatabaseName": { - "$ref": "#/definitions/NameString", - "description": "The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal." - }, - "Name": { - "$ref": "#/definitions/NameString", - "description": "The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal." - } - }, - "required": [ - "CatalogId", - "DatabaseName", - "Name" - ], - "type": "object" - }, - "TagValueList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTagValue" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "description": "The ``AWS::LakeFormation::PrincipalPermissions`` resource represents the permissions that a principal has on a GLUDC resource (such as GLUlong databases or GLUlong tables). When you create a ``PrincipalPermissions`` resource, the permissions are granted via the LFlong ``GrantPermissions`` API operation. When you delete a ``PrincipalPermissions`` resource, the permissions on principal-resource pair are revoked via the LFlong ``RevokePermissions`` API operation.", - "handlers": { - "create": { - "permissions": [ - "lakeformation:GrantPermissions", - "lakeformation:ListPermissions", - "glue:GetTable", - "glue:GetDatabase" - ] - }, - "delete": { - "permissions": [ - "lakeformation:RevokePermissions", - "lakeformation:ListPermissions", - "glue:GetTable", - "glue:GetDatabase" - ] - }, - "read": { - "permissions": [ - "lakeformation:ListPermissions", - "glue:GetTable", - "glue:GetDatabase" - ] - } - }, - "primaryIdentifier": [ - "/properties/PrincipalIdentifier", - "/properties/ResourceIdentifier" - ], - "properties": { - "Catalog": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment." - }, - "Permissions": { - "$ref": "#/definitions/PermissionList", - "description": "The permissions granted or revoked." - }, - "PermissionsWithGrantOption": { - "$ref": "#/definitions/PermissionList", - "description": "Indicates the ability to grant permissions (as a subset of permissions granted)." - }, - "Principal": { - "$ref": "#/definitions/DataLakePrincipal", - "description": "The principal to be granted a permission." - }, - "PrincipalIdentifier": { - "description": "", - "type": "string" - }, - "Resource": { - "$ref": "#/definitions/Resource", - "description": "The resource to be granted or revoked permissions." - }, - "ResourceIdentifier": { - "description": "", - "type": "string" - } - }, - "propertyTransform": { - "/properties/Permissions": "Permissions=[] ? null : Permissions", - "/properties/PermissionsWithGrantOption": "PermissionsWithGrantOption=[] ? null : PermissionsWithGrantOption" - }, - "readOnlyProperties": [ - "/properties/PrincipalIdentifier", - "/properties/ResourceIdentifier" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Principal", - "Resource", - "Permissions", - "PermissionsWithGrantOption" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::LakeFormation::PrincipalPermissions" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Catalog", + "/properties/Principal", + "/properties/Resource", + "/properties/Permissions", + "/properties/PermissionsWithGrantOption" + ], + "definitions": { + "CatalogIdString": { + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "CatalogResource": { + "additionalProperties": false, + "type": "object" + }, + "ColumnNames": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NameString" + }, + "type": "array" + }, + "ColumnWildcard": { + "additionalProperties": false, + "description": "A wildcard object, consisting of an optional list of excluded column names or indexes.", + "properties": { + "ExcludedColumnNames": { + "$ref": "#/definitions/ColumnNames", + "description": "Excludes column names. Any column with this name will be excluded." + } + }, + "type": "object" + }, + "DataCellsFilterResource": { + "additionalProperties": false, + "description": "A structure that describes certain columns on certain rows.", + "properties": { + "DatabaseName": { + "$ref": "#/definitions/NameString", + "description": "A database in the GLUDC." + }, + "Name": { + "$ref": "#/definitions/NameString", + "description": "The name given by the user to the data filter cell." + }, + "TableCatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The ID of the catalog to which the table belongs." + }, + "TableName": { + "$ref": "#/definitions/NameString", + "description": "The name of the table." + } + }, + "required": [ + "TableCatalogId", + "DatabaseName", + "TableName", + "Name" + ], + "type": "object" + }, + "DataLakePrincipal": { + "additionalProperties": false, + "description": "The LFlong principal.", + "properties": { + "DataLakePrincipalIdentifier": { + "$ref": "#/definitions/DataLakePrincipalString", + "description": "An identifier for the LFlong principal." + } + }, + "type": "object" + }, + "DataLakePrincipalList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DataLakePrincipal" + }, + "type": "array" + }, + "DataLakePrincipalString": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DataLocationResource": { + "additionalProperties": false, + "description": "A structure for a data location object where permissions are granted or revoked.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the GLUDC where the location is registered with LFlong." + }, + "ResourceArn": { + "$ref": "#/definitions/ResourceArnString", + "description": "The Amazon Resource Name (ARN) that uniquely identifies the data location resource." + } + }, + "required": [ + "CatalogId", + "ResourceArn" + ], + "type": "object" + }, + "DatabaseResource": { + "additionalProperties": false, + "description": "A structure for the database object.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the Data Catalog. By default, it is the account ID of the caller." + }, + "Name": { + "$ref": "#/definitions/NameString", + "description": "The name of the database resource. Unique to the Data Catalog." + } + }, + "required": [ + "CatalogId", + "Name" + ], + "type": "object" + }, + "Expression": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTag" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "IAMRoleArn": { + "pattern": "arn:*:iam::[0-9]*:role/.*", + "type": "string" + }, + "LFTag": { + "additionalProperties": false, + "description": "The LF-tag key and values attached to a resource.", + "properties": { + "TagKey": { + "$ref": "#/definitions/LFTagKey", + "description": "The key-name for the LF-tag." + }, + "TagValues": { + "$ref": "#/definitions/TagValueList", + "description": "A list of possible values of the corresponding ``TagKey`` of an LF-tag key-value pair." + } + }, + "type": "object" + }, + "LFTagKey": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LFTagKeyResource": { + "additionalProperties": false, + "description": "A structure containing an LF-tag key and values for a resource.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the GLUDC where the location is registered with GLUDC." + }, + "TagKey": { + "$ref": "#/definitions/NameString", + "description": "The key-name for the LF-tag." + }, + "TagValues": { + "$ref": "#/definitions/TagValueList", + "description": "A list of possible values for the corresponding ``TagKey`` of an LF-tag key-value pair." + } + }, + "required": [ + "CatalogId", + "TagKey", + "TagValues" + ], + "type": "object" + }, + "LFTagPair": { + "additionalProperties": false, + "description": "", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString" + }, + "TagKey": { + "$ref": "#/definitions/LFTagKey" + }, + "TagValues": { + "$ref": "#/definitions/TagValueList" + } + }, + "required": [ + "TagKey", + "TagValues" + ], + "type": "object" + }, + "LFTagPolicyResource": { + "additionalProperties": false, + "description": "A list of LF-tag conditions that define a resource's LF-tag policy.\n A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the GLUDC. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment." + }, + "Expression": { + "$ref": "#/definitions/Expression", + "description": "A list of LF-tag conditions that apply to the resource's LF-tag policy." + }, + "ResourceType": { + "$ref": "#/definitions/ResourceType", + "description": "The resource type for which the LF-tag policy applies." + } + }, + "required": [ + "CatalogId", + "ResourceType", + "Expression" + ], + "type": "object" + }, + "LFTagValue": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "LFTagsList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTagPair" + }, + "type": "array" + }, + "NameString": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "NullableBoolean": { + "type": [ + "boolean", + "null" + ] + }, + "PathString": { + "type": "string" + }, + "Permission": { + "enum": [ + "ALL", + "SELECT", + "ALTER", + "DROP", + "DELETE", + "INSERT", + "DESCRIBE", + "CREATE_DATABASE", + "CREATE_TABLE", + "DATA_LOCATION_ACCESS", + "CREATE_TAG", + "ASSOCIATE" + ], + "type": "string" + }, + "PermissionList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Permission" + }, + "type": "array" + }, + "PrincipalPermissions": { + "additionalProperties": false, + "description": "", + "properties": { + "DataLakePrincipal": { + "$ref": "#/definitions/DataLakePrincipal" + }, + "PermissionList": { + "$ref": "#/definitions/PermissionList" + } + }, + "type": "object" + }, + "PrincipalPermissionsList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PrincipalPermissions" + }, + "type": "array" + }, + "PrincipalResourcePair": { + "additionalProperties": false, + "description": "", + "properties": { + "Principal": { + "$ref": "#/definitions/DataLakePrincipal" + }, + "Resource": { + "$ref": "#/definitions/Resource" + } + }, + "required": [ + "Principal", + "Resource" + ], + "type": "object" + }, + "Resource": { + "additionalProperties": false, + "description": "A structure for the resource.", + "properties": { + "Catalog": { + "$ref": "#/definitions/CatalogResource", + "description": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment." + }, + "DataCellsFilter": { + "$ref": "#/definitions/DataCellsFilterResource", + "description": "A data cell filter." + }, + "DataLocation": { + "$ref": "#/definitions/DataLocationResource", + "description": "The location of an Amazon S3 path where permissions are granted or revoked." + }, + "Database": { + "$ref": "#/definitions/DatabaseResource", + "description": "The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal." + }, + "LFTag": { + "$ref": "#/definitions/LFTagKeyResource", + "description": "The LF-tag key and values attached to a resource." + }, + "LFTagPolicy": { + "$ref": "#/definitions/LFTagPolicyResource", + "description": "A list of LF-tag conditions that define a resource's LF-tag policy." + }, + "Table": { + "$ref": "#/definitions/TableResource", + "description": "The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal." + }, + "TableWithColumns": { + "$ref": "#/definitions/TableWithColumnsResource", + "description": "The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3." + } + }, + "type": "object" + }, + "ResourceArnString": { + "type": "string" + }, + "ResourceType": { + "enum": [ + "DATABASE", + "TABLE" + ], + "type": "string" + }, + "TableResource": { + "additionalProperties": false, + "description": "A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the Data Catalog. By default, it is the account ID of the caller." + }, + "DatabaseName": { + "$ref": "#/definitions/NameString", + "description": "The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal." + }, + "Name": { + "$ref": "#/definitions/NameString", + "description": "The name of the table." + }, + "TableWildcard": { + "$ref": "#/definitions/TableWildcard", + "description": "A wildcard object representing every table under a database.\n At least one of ``TableResource$Name`` or ``TableResource$TableWildcard`` is required." + } + }, + "required": [ + "CatalogId", + "DatabaseName" + ], + "type": "object" + }, + "TableWildcard": { + "additionalProperties": false, + "type": "object" + }, + "TableWithColumnsResource": { + "additionalProperties": false, + "description": "A structure for a table with columns object. This object is only used when granting a SELECT permission.\n This object must take a value for at least one of ``ColumnsNames``, ``ColumnsIndexes``, or ``ColumnsWildcard``.", + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the GLUDC where the location is registered with LFlong." + }, + "ColumnNames": { + "$ref": "#/definitions/ColumnNames", + "description": "The list of column names for the table. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required." + }, + "ColumnWildcard": { + "$ref": "#/definitions/ColumnWildcard", + "description": "A wildcard specified by a ``ColumnWildcard`` object. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required." + }, + "DatabaseName": { + "$ref": "#/definitions/NameString", + "description": "The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal." + }, + "Name": { + "$ref": "#/definitions/NameString", + "description": "The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal." + } + }, + "required": [ + "CatalogId", + "DatabaseName", + "Name" + ], + "type": "object" + }, + "TagValueList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTagValue" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "description": "The ``AWS::LakeFormation::PrincipalPermissions`` resource represents the permissions that a principal has on a GLUDC resource (such as GLUlong databases or GLUlong tables). When you create a ``PrincipalPermissions`` resource, the permissions are granted via the LFlong ``GrantPermissions`` API operation. When you delete a ``PrincipalPermissions`` resource, the permissions on principal-resource pair are revoked via the LFlong ``RevokePermissions`` API operation.", + "handlers": { + "create": { + "permissions": [ + "lakeformation:GrantPermissions", + "lakeformation:ListPermissions", + "glue:GetTable", + "glue:GetDatabase" + ] + }, + "delete": { + "permissions": [ + "lakeformation:RevokePermissions", + "lakeformation:ListPermissions", + "glue:GetTable", + "glue:GetDatabase" + ] + }, + "read": { + "permissions": [ + "lakeformation:ListPermissions", + "glue:GetTable", + "glue:GetDatabase" + ] + } + }, + "primaryIdentifier": [ + "/properties/PrincipalIdentifier", + "/properties/ResourceIdentifier" + ], + "properties": { + "Catalog": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment." + }, + "Permissions": { + "$ref": "#/definitions/PermissionList", + "description": "The permissions granted or revoked." + }, + "PermissionsWithGrantOption": { + "$ref": "#/definitions/PermissionList", + "description": "Indicates the ability to grant permissions (as a subset of permissions granted)." + }, + "Principal": { + "$ref": "#/definitions/DataLakePrincipal", + "description": "The principal to be granted a permission." + }, + "PrincipalIdentifier": { + "description": "", + "type": "string" + }, + "Resource": { + "$ref": "#/definitions/Resource", + "description": "The resource to be granted or revoked permissions." + }, + "ResourceIdentifier": { + "description": "", + "type": "string" + } + }, + "propertyTransform": { + "/properties/Permissions": "Permissions=[] ? null : Permissions", + "/properties/PermissionsWithGrantOption": "PermissionsWithGrantOption=[] ? null : PermissionsWithGrantOption" + }, + "readOnlyProperties": [ + "/properties/PrincipalIdentifier", + "/properties/ResourceIdentifier" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Principal", + "Resource", + "Permissions", + "PermissionsWithGrantOption" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::LakeFormation::PrincipalPermissions" +} diff --git a/schema/aws-lakeformation-resource.json b/schema/aws-lakeformation-resource.json index 5ae298f..4614a41 100644 --- a/schema/aws-lakeformation-resource.json +++ b/schema/aws-lakeformation-resource.json @@ -1,38 +1,38 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn" - ], - "description": "Resource Type definition for AWS::LakeFormation::Resource", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "HybridAccessEnabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "ResourceArn": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UseServiceLinkedRole": { - "type": "boolean" - }, - "WithFederation": { - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResourceArn", - "UseServiceLinkedRole" - ], - "typeName": "AWS::LakeFormation::Resource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn" + ], + "description": "Resource Type definition for AWS::LakeFormation::Resource", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "HybridAccessEnabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "ResourceArn": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "UseServiceLinkedRole": { + "type": "boolean" + }, + "WithFederation": { + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceArn", + "UseServiceLinkedRole" + ], + "typeName": "AWS::LakeFormation::Resource" +} diff --git a/schema/aws-lakeformation-tag.json b/schema/aws-lakeformation-tag.json index 4a45cd1..d14dead 100644 --- a/schema/aws-lakeformation-tag.json +++ b/schema/aws-lakeformation-tag.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CatalogId", - "/properties/TagKey" - ], - "definitions": { - "CatalogIdString": { - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "LFTagKey": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([{a-zA-Z}{\\s}{0-9}_.:\\/=+\\-@%]*)$", - "type": "string" - }, - "LFTagValue": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([{a-zA-Z}{\\s}{0-9}_.:\\*\\/=+\\-@%]*)$", - "type": "string" - }, - "TagValueList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTagValue" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "description": "A resource schema representing a Lake Formation Tag.", - "handlers": { - "create": { - "permissions": [ - "lakeformation:CreateLFTag" - ] - }, - "delete": { - "permissions": [ - "lakeformation:DeleteLFTag" - ] - }, - "list": { - "permissions": [ - "lakeformation:ListLFTags" - ] - }, - "read": { - "permissions": [ - "lakeformation:GetLFTag" - ] - }, - "update": { - "permissions": [ - "lakeformation:UpdateLFTag" - ] - } - }, - "primaryIdentifier": [ - "/properties/TagKey" - ], - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString", - "description": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment." - }, - "TagKey": { - "$ref": "#/definitions/LFTagKey", - "description": "The key-name for the LF-tag." - }, - "TagValues": { - "$ref": "#/definitions/TagValueList", - "description": "A list of possible values an attribute can take." - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "TagKey", - "TagValues" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::LakeFormation::Tag" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CatalogId", + "/properties/TagKey" + ], + "definitions": { + "CatalogIdString": { + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "LFTagKey": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([{a-zA-Z}{\\s}{0-9}_.:\\/=+\\-@%]*)$", + "type": "string" + }, + "LFTagValue": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([{a-zA-Z}{\\s}{0-9}_.:\\*\\/=+\\-@%]*)$", + "type": "string" + }, + "TagValueList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTagValue" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "description": "A resource schema representing a Lake Formation Tag.", + "handlers": { + "create": { + "permissions": [ + "lakeformation:CreateLFTag" + ] + }, + "delete": { + "permissions": [ + "lakeformation:DeleteLFTag" + ] + }, + "list": { + "permissions": [ + "lakeformation:ListLFTags" + ] + }, + "read": { + "permissions": [ + "lakeformation:GetLFTag" + ] + }, + "update": { + "permissions": [ + "lakeformation:UpdateLFTag" + ] + } + }, + "primaryIdentifier": [ + "/properties/TagKey" + ], + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString", + "description": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment." + }, + "TagKey": { + "$ref": "#/definitions/LFTagKey", + "description": "The key-name for the LF-tag." + }, + "TagValues": { + "$ref": "#/definitions/TagValueList", + "description": "A list of possible values an attribute can take." + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "TagKey", + "TagValues" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::LakeFormation::Tag" +} diff --git a/schema/aws-lakeformation-tagassociation.json b/schema/aws-lakeformation-tagassociation.json index 897c9d1..6f5aab9 100644 --- a/schema/aws-lakeformation-tagassociation.json +++ b/schema/aws-lakeformation-tagassociation.json @@ -1,241 +1,241 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Resource", - "/properties/LFTags" - ], - "definitions": { - "CatalogIdString": { - "maxLength": 12, - "minLength": 12, - "type": "string" - }, - "CatalogResource": { - "additionalProperties": false, - "type": "object" - }, - "ColumnNames": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NameString" - }, - "type": "array" - }, - "DataLakePrincipal": { - "additionalProperties": false, - "properties": { - "DataLakePrincipalIdentifier": { - "$ref": "#/definitions/DataLakePrincipalString" - } - }, - "type": "object" - }, - "DataLakePrincipalString": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DatabaseResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString" - }, - "Name": { - "$ref": "#/definitions/NameString" - } - }, - "required": [ - "CatalogId", - "Name" - ], - "type": "object" - }, - "LFTagKey": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LFTagPair": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString" - }, - "TagKey": { - "$ref": "#/definitions/LFTagKey" - }, - "TagValues": { - "$ref": "#/definitions/TagValueList" - } - }, - "required": [ - "CatalogId", - "TagKey", - "TagValues" - ], - "type": "object" - }, - "LFTagValue": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "LFTagsList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTagPair" - }, - "type": "array" - }, - "NameString": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Resource": { - "additionalProperties": false, - "properties": { - "Catalog": { - "$ref": "#/definitions/CatalogResource" - }, - "Database": { - "$ref": "#/definitions/DatabaseResource" - }, - "Table": { - "$ref": "#/definitions/TableResource" - }, - "TableWithColumns": { - "$ref": "#/definitions/TableWithColumnsResource" - } - }, - "type": "object" - }, - "ResourceType": { - "enum": [ - "DATABASE", - "TABLE" - ], - "type": "string" - }, - "TableResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString" - }, - "DatabaseName": { - "$ref": "#/definitions/NameString" - }, - "Name": { - "$ref": "#/definitions/NameString" - }, - "TableWildcard": { - "$ref": "#/definitions/TableWildcard" - } - }, - "required": [ - "CatalogId", - "DatabaseName" - ], - "type": "object" - }, - "TableWildcard": { - "additionalProperties": false, - "type": "object" - }, - "TableWithColumnsResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "$ref": "#/definitions/CatalogIdString" - }, - "ColumnNames": { - "$ref": "#/definitions/ColumnNames" - }, - "DatabaseName": { - "$ref": "#/definitions/NameString" - }, - "Name": { - "$ref": "#/definitions/NameString" - } - }, - "required": [ - "CatalogId", - "DatabaseName", - "Name", - "ColumnNames" - ], - "type": "object" - }, - "TagValueList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LFTagValue" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "description": "A resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities.", - "handlers": { - "create": { - "permissions": [ - "lakeformation:AddLFTagsToResource", - "glue:GetDatabase", - "glue:GetTable" - ] - }, - "delete": { - "permissions": [ - "lakeformation:RemoveLFTagsFromResource", - "glue:GetDatabase", - "glue:GetTable" - ] - }, - "read": { - "permissions": [ - "lakeformation:GetResourceLFTags", - "glue:GetDatabase", - "glue:GetTable" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceIdentifier", - "/properties/TagsIdentifier" - ], - "properties": { - "LFTags": { - "$ref": "#/definitions/LFTagsList", - "description": "List of Lake Formation Tags to associate with the Lake Formation Resource" - }, - "Resource": { - "$ref": "#/definitions/Resource", - "description": "Resource to tag with the Lake Formation Tags" - }, - "ResourceIdentifier": { - "description": "Unique string identifying the resource. Used as primary identifier, which ideally should be a string", - "type": "string" - }, - "TagsIdentifier": { - "description": "Unique string identifying the resource's tags. Used as primary identifier, which ideally should be a string", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResourceIdentifier", - "/properties/TagsIdentifier" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Resource", - "LFTags" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::LakeFormation::TagAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Resource", + "/properties/LFTags" + ], + "definitions": { + "CatalogIdString": { + "maxLength": 12, + "minLength": 12, + "type": "string" + }, + "CatalogResource": { + "additionalProperties": false, + "type": "object" + }, + "ColumnNames": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NameString" + }, + "type": "array" + }, + "DataLakePrincipal": { + "additionalProperties": false, + "properties": { + "DataLakePrincipalIdentifier": { + "$ref": "#/definitions/DataLakePrincipalString" + } + }, + "type": "object" + }, + "DataLakePrincipalString": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DatabaseResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString" + }, + "Name": { + "$ref": "#/definitions/NameString" + } + }, + "required": [ + "CatalogId", + "Name" + ], + "type": "object" + }, + "LFTagKey": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LFTagPair": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString" + }, + "TagKey": { + "$ref": "#/definitions/LFTagKey" + }, + "TagValues": { + "$ref": "#/definitions/TagValueList" + } + }, + "required": [ + "CatalogId", + "TagKey", + "TagValues" + ], + "type": "object" + }, + "LFTagValue": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "LFTagsList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTagPair" + }, + "type": "array" + }, + "NameString": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Resource": { + "additionalProperties": false, + "properties": { + "Catalog": { + "$ref": "#/definitions/CatalogResource" + }, + "Database": { + "$ref": "#/definitions/DatabaseResource" + }, + "Table": { + "$ref": "#/definitions/TableResource" + }, + "TableWithColumns": { + "$ref": "#/definitions/TableWithColumnsResource" + } + }, + "type": "object" + }, + "ResourceType": { + "enum": [ + "DATABASE", + "TABLE" + ], + "type": "string" + }, + "TableResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString" + }, + "DatabaseName": { + "$ref": "#/definitions/NameString" + }, + "Name": { + "$ref": "#/definitions/NameString" + }, + "TableWildcard": { + "$ref": "#/definitions/TableWildcard" + } + }, + "required": [ + "CatalogId", + "DatabaseName" + ], + "type": "object" + }, + "TableWildcard": { + "additionalProperties": false, + "type": "object" + }, + "TableWithColumnsResource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "$ref": "#/definitions/CatalogIdString" + }, + "ColumnNames": { + "$ref": "#/definitions/ColumnNames" + }, + "DatabaseName": { + "$ref": "#/definitions/NameString" + }, + "Name": { + "$ref": "#/definitions/NameString" + } + }, + "required": [ + "CatalogId", + "DatabaseName", + "Name", + "ColumnNames" + ], + "type": "object" + }, + "TagValueList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LFTagValue" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "description": "A resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities.", + "handlers": { + "create": { + "permissions": [ + "lakeformation:AddLFTagsToResource", + "glue:GetDatabase", + "glue:GetTable" + ] + }, + "delete": { + "permissions": [ + "lakeformation:RemoveLFTagsFromResource", + "glue:GetDatabase", + "glue:GetTable" + ] + }, + "read": { + "permissions": [ + "lakeformation:GetResourceLFTags", + "glue:GetDatabase", + "glue:GetTable" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceIdentifier", + "/properties/TagsIdentifier" + ], + "properties": { + "LFTags": { + "$ref": "#/definitions/LFTagsList", + "description": "List of Lake Formation Tags to associate with the Lake Formation Resource" + }, + "Resource": { + "$ref": "#/definitions/Resource", + "description": "Resource to tag with the Lake Formation Tags" + }, + "ResourceIdentifier": { + "description": "Unique string identifying the resource. Used as primary identifier, which ideally should be a string", + "type": "string" + }, + "TagsIdentifier": { + "description": "Unique string identifying the resource's tags. Used as primary identifier, which ideally should be a string", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResourceIdentifier", + "/properties/TagsIdentifier" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Resource", + "LFTags" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::LakeFormation::TagAssociation" +} diff --git a/schema/aws-lambda-alias.json b/schema/aws-lambda-alias.json index 9412fb6..6a1271e 100644 --- a/schema/aws-lambda-alias.json +++ b/schema/aws-lambda-alias.json @@ -1,160 +1,160 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/FunctionName" - ], - "definitions": { - "AliasRoutingConfiguration": { - "additionalProperties": false, - "description": "The traffic-shifting configuration of a Lambda function alias.", - "properties": { - "AdditionalVersionWeights": { - "description": "The second version, and the percentage of traffic that's routed to it.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VersionWeight" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ProvisionedConcurrencyConfiguration": { - "additionalProperties": false, - "description": "A provisioned concurrency configuration for a function's alias.", - "properties": { - "ProvisionedConcurrentExecutions": { - "description": "The amount of provisioned concurrency to allocate for the alias.", - "type": "integer" - } - }, - "required": [ - "ProvisionedConcurrentExecutions" - ], - "type": "object" - }, - "VersionWeight": { - "additionalProperties": false, - "description": "The traffic-shifting configuration of a Lambda function alias.", - "properties": { - "FunctionVersion": { - "description": "The qualifier of the second version.", - "type": "string" - }, - "FunctionWeight": { - "description": "The percentage of traffic that the alias routes to the second version.", - "type": "number" - } - }, - "required": [ - "FunctionVersion", - "FunctionWeight" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lambda::Alias", - "handlers": { - "create": { - "permissions": [ - "lambda:CreateAlias", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:GetProvisionedConcurrencyConfig" - ], - "timeoutInMinutes": 45 - }, - "delete": { - "permissions": [ - "lambda:DeleteAlias", - "lambda:GetAlias" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FunctionName": { - "$ref": "resource-schema.json#/properties/FunctionName" - } - }, - "required": [ - "FunctionName" - ] - }, - "permissions": [ - "lambda:ListAliases" - ] - }, - "read": { - "permissions": [ - "lambda:GetAlias", - "lambda:GetProvisionedConcurrencyConfig" - ] - }, - "update": { - "permissions": [ - "lambda:UpdateAlias", - "lambda:GetAlias", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:DeleteProvisionedConcurrencyConfig", - "lambda:GetProvisionedConcurrencyConfig", - "codedeploy:CreateDeployment", - "codedeploy:GetDeployment", - "codedeploy:GetDeploymentGroup", - "codedeploy:GetDeploymentConfig", - "codedeploy:StopDeployment" - ], - "timeoutInMinutes": 120 - } - }, - "primaryIdentifier": [ - "/properties/AliasArn" - ], - "properties": { - "AliasArn": { - "description": "Lambda Alias ARN generated by the service.", - "type": "string" - }, - "Description": { - "description": "A description of the alias.", - "type": "string" - }, - "FunctionName": { - "description": "The name of the Lambda function.", - "type": "string" - }, - "FunctionVersion": { - "description": "The function version that the alias invokes.", - "type": "string" - }, - "Name": { - "description": "The name of the alias.", - "type": "string" - }, - "ProvisionedConcurrencyConfig": { - "$ref": "#/definitions/ProvisionedConcurrencyConfiguration", - "description": "Specifies a provisioned concurrency configuration for a function's alias." - }, - "RoutingConfig": { - "$ref": "#/definitions/AliasRoutingConfiguration", - "description": "The routing configuration of the alias." - } - }, - "propertyTransform": { - "/properties/FunctionName": "$split(FunctionName, \":\")[-1] $OR FunctionName" - }, - "readOnlyProperties": [ - "/properties/AliasArn" - ], - "required": [ - "FunctionName", - "FunctionVersion", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Lambda::Alias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/FunctionName" + ], + "definitions": { + "AliasRoutingConfiguration": { + "additionalProperties": false, + "description": "The traffic-shifting configuration of a Lambda function alias.", + "properties": { + "AdditionalVersionWeights": { + "description": "The second version, and the percentage of traffic that's routed to it.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VersionWeight" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ProvisionedConcurrencyConfiguration": { + "additionalProperties": false, + "description": "A provisioned concurrency configuration for a function's alias.", + "properties": { + "ProvisionedConcurrentExecutions": { + "description": "The amount of provisioned concurrency to allocate for the alias.", + "type": "integer" + } + }, + "required": [ + "ProvisionedConcurrentExecutions" + ], + "type": "object" + }, + "VersionWeight": { + "additionalProperties": false, + "description": "The traffic-shifting configuration of a Lambda function alias.", + "properties": { + "FunctionVersion": { + "description": "The qualifier of the second version.", + "type": "string" + }, + "FunctionWeight": { + "description": "The percentage of traffic that the alias routes to the second version.", + "type": "number" + } + }, + "required": [ + "FunctionVersion", + "FunctionWeight" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lambda::Alias", + "handlers": { + "create": { + "permissions": [ + "lambda:CreateAlias", + "lambda:PutProvisionedConcurrencyConfig", + "lambda:GetProvisionedConcurrencyConfig" + ], + "timeoutInMinutes": 45 + }, + "delete": { + "permissions": [ + "lambda:DeleteAlias", + "lambda:GetAlias" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FunctionName": { + "$ref": "resource-schema.json#/properties/FunctionName" + } + }, + "required": [ + "FunctionName" + ] + }, + "permissions": [ + "lambda:ListAliases" + ] + }, + "read": { + "permissions": [ + "lambda:GetAlias", + "lambda:GetProvisionedConcurrencyConfig" + ] + }, + "update": { + "permissions": [ + "lambda:UpdateAlias", + "lambda:GetAlias", + "lambda:PutProvisionedConcurrencyConfig", + "lambda:DeleteProvisionedConcurrencyConfig", + "lambda:GetProvisionedConcurrencyConfig", + "codedeploy:CreateDeployment", + "codedeploy:GetDeployment", + "codedeploy:GetDeploymentGroup", + "codedeploy:GetDeploymentConfig", + "codedeploy:StopDeployment" + ], + "timeoutInMinutes": 120 + } + }, + "primaryIdentifier": [ + "/properties/AliasArn" + ], + "properties": { + "AliasArn": { + "description": "Lambda Alias ARN generated by the service.", + "type": "string" + }, + "Description": { + "description": "A description of the alias.", + "type": "string" + }, + "FunctionName": { + "description": "The name of the Lambda function.", + "type": "string" + }, + "FunctionVersion": { + "description": "The function version that the alias invokes.", + "type": "string" + }, + "Name": { + "description": "The name of the alias.", + "type": "string" + }, + "ProvisionedConcurrencyConfig": { + "$ref": "#/definitions/ProvisionedConcurrencyConfiguration", + "description": "Specifies a provisioned concurrency configuration for a function's alias." + }, + "RoutingConfig": { + "$ref": "#/definitions/AliasRoutingConfiguration", + "description": "The routing configuration of the alias." + } + }, + "propertyTransform": { + "/properties/FunctionName": "$split(FunctionName, \":\")[-1] $OR FunctionName" + }, + "readOnlyProperties": [ + "/properties/AliasArn" + ], + "required": [ + "FunctionName", + "FunctionVersion", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Lambda::Alias" +} diff --git a/schema/aws-lambda-codesigningconfig.json b/schema/aws-lambda-codesigningconfig.json index fce9c2d..d7e8e51 100644 --- a/schema/aws-lambda-codesigningconfig.json +++ b/schema/aws-lambda-codesigningconfig.json @@ -1,111 +1,153 @@ -{ - "additionalProperties": false, - "definitions": { - "AllowedPublishers": { - "additionalProperties": false, - "description": "When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list", - "properties": { - "SigningProfileVersionArns": { - "description": "List of Signing profile version Arns", - "items": { - "maxLength": 1024, - "minLength": 12, - "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SigningProfileVersionArns" - ], - "type": "object" - }, - "CodeSigningPolicies": { - "additionalProperties": false, - "description": "Policies to control how to act if a signature is invalid", - "properties": { - "UntrustedArtifactOnDeployment": { - "default": "Warn", - "description": "Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided", - "enum": [ - "Warn", - "Enforce" - ], - "type": "string" - } - }, - "required": [ - "UntrustedArtifactOnDeployment" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lambda::CodeSigningConfig.", - "handlers": { - "create": { - "permissions": [ - "lambda:CreateCodeSigningConfig" - ] - }, - "delete": { - "permissions": [ - "lambda:DeleteCodeSigningConfig" - ] - }, - "list": { - "permissions": [ - "lambda:ListCodeSigningConfigs" - ] - }, - "read": { - "permissions": [ - "lambda:GetCodeSigningConfig" - ] - }, - "update": { - "permissions": [ - "lambda:UpdateCodeSigningConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/CodeSigningConfigArn" - ], - "properties": { - "AllowedPublishers": { - "$ref": "#/definitions/AllowedPublishers", - "description": "When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list" - }, - "CodeSigningConfigArn": { - "description": "A unique Arn for CodeSigningConfig resource", - "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}", - "type": "string" - }, - "CodeSigningConfigId": { - "description": "A unique identifier for CodeSigningConfig resource", - "pattern": "csc-[a-zA-Z0-9-_\\.]{17}", - "type": "string" - }, - "CodeSigningPolicies": { - "$ref": "#/definitions/CodeSigningPolicies", - "description": "Policies to control how to act if a signature is invalid" - }, - "Description": { - "description": "A description of the CodeSigningConfig", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CodeSigningConfigId", - "/properties/CodeSigningConfigArn" - ], - "required": [ - "AllowedPublishers" - ], - "typeName": "AWS::Lambda::CodeSigningConfig" -} +{ + "additionalProperties": false, + "definitions": { + "AllowedPublishers": { + "additionalProperties": false, + "description": "When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list", + "properties": { + "SigningProfileVersionArns": { + "description": "List of Signing profile version Arns", + "items": { + "maxLength": 1024, + "minLength": 12, + "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SigningProfileVersionArns" + ], + "type": "object" + }, + "CodeSigningPolicies": { + "additionalProperties": false, + "description": "Policies to control how to act if a signature is invalid", + "properties": { + "UntrustedArtifactOnDeployment": { + "default": "Warn", + "description": "Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided", + "enum": [ + "Warn", + "Enforce" + ], + "type": "string" + } + }, + "required": [ + "UntrustedArtifactOnDeployment" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lambda::CodeSigningConfig.", + "handlers": { + "create": { + "permissions": [ + "lambda:CreateCodeSigningConfig", + "lambda:TagResource" + ] + }, + "delete": { + "permissions": [ + "lambda:DeleteCodeSigningConfig" + ] + }, + "list": { + "permissions": [ + "lambda:ListCodeSigningConfigs" + ] + }, + "read": { + "permissions": [ + "lambda:GetCodeSigningConfig", + "lambda:ListTags" + ] + }, + "update": { + "permissions": [ + "lambda:UpdateCodeSigningConfig", + "lambda:ListTags", + "lambda:TagResource", + "lambda:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CodeSigningConfigArn" + ], + "properties": { + "AllowedPublishers": { + "$ref": "#/definitions/AllowedPublishers", + "description": "When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list" + }, + "CodeSigningConfigArn": { + "description": "A unique Arn for CodeSigningConfig resource", + "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}", + "type": "string" + }, + "CodeSigningConfigId": { + "description": "A unique identifier for CodeSigningConfig resource", + "pattern": "csc-[a-zA-Z0-9-_\\.]{17}", + "type": "string" + }, + "CodeSigningPolicies": { + "$ref": "#/definitions/CodeSigningPolicies", + "description": "Policies to control how to act if a signature is invalid" + }, + "Description": { + "description": "A description of the CodeSigningConfig", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Tags": { + "description": "A list of tags to apply to CodeSigningConfig resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/CodeSigningConfigId", + "/properties/CodeSigningConfigArn" + ], + "required": [ + "AllowedPublishers" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Lambda::CodeSigningConfig" +} diff --git a/schema/aws-lambda-eventinvokeconfig.json b/schema/aws-lambda-eventinvokeconfig.json index 62496fe..b0f86aa 100644 --- a/schema/aws-lambda-eventinvokeconfig.json +++ b/schema/aws-lambda-eventinvokeconfig.json @@ -1,137 +1,137 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FunctionName", - "/properties/Qualifier" - ], - "definitions": { - "DestinationConfig": { - "additionalProperties": false, - "description": "A destination for events after they have been sent to a function for processing.", - "properties": { - "OnFailure": { - "$ref": "#/definitions/OnFailure" - }, - "OnSuccess": { - "$ref": "#/definitions/OnSuccess" - } - }, - "type": "object" - }, - "OnFailure": { - "additionalProperties": false, - "description": "The destination configuration for failed invocations.", - "properties": { - "Destination": { - "description": "The Amazon Resource Name (ARN) of the destination resource.", - "maxLength": 350, - "minLength": 0, - "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "OnSuccess": { - "additionalProperties": false, - "description": "The destination configuration for successful invocations.", - "properties": { - "Destination": { - "description": "The Amazon Resource Name (ARN) of the destination resource.", - "maxLength": 350, - "minLength": 0, - "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - } - }, - "description": "The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.", - "handlers": { - "create": { - "permissions": [ - "lambda:PutFunctionEventInvokeConfig" - ] - }, - "delete": { - "permissions": [ - "lambda:DeleteFunctionEventInvokeConfig" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FunctionName": { - "$ref": "resource-schema.json#/properties/FunctionName" - } - }, - "required": [ - "FunctionName" - ] - }, - "permissions": [ - "lambda:ListFunctionEventInvokeConfigs" - ] - }, - "read": { - "permissions": [ - "lambda:GetFunctionEventInvokeConfig" - ] - }, - "update": { - "permissions": [ - "lambda:UpdateFunctionEventInvokeConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionName", - "/properties/Qualifier" - ], - "properties": { - "DestinationConfig": { - "$ref": "#/definitions/DestinationConfig" - }, - "FunctionName": { - "description": "The name of the Lambda function.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - }, - "MaximumEventAgeInSeconds": { - "description": "The maximum age of a request that Lambda sends to a function for processing.", - "maximum": 21600, - "minimum": 60, - "type": "integer" - }, - "MaximumRetryAttempts": { - "description": "The maximum number of times to retry when the function returns an error.", - "maximum": 2, - "minimum": 0, - "type": "integer" - }, - "Qualifier": { - "description": "The identifier of a version or alias.", - "pattern": "^(|[a-zA-Z0-9$_-]{1,129})$", - "type": "string" - } - }, - "required": [ - "FunctionName", - "Qualifier" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::EventInvokeConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FunctionName", + "/properties/Qualifier" + ], + "definitions": { + "DestinationConfig": { + "additionalProperties": false, + "description": "A destination for events after they have been sent to a function for processing.", + "properties": { + "OnFailure": { + "$ref": "#/definitions/OnFailure" + }, + "OnSuccess": { + "$ref": "#/definitions/OnSuccess" + } + }, + "type": "object" + }, + "OnFailure": { + "additionalProperties": false, + "description": "The destination configuration for failed invocations.", + "properties": { + "Destination": { + "description": "The Amazon Resource Name (ARN) of the destination resource.", + "maxLength": 350, + "minLength": 0, + "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "type": "string" + } + }, + "required": [ + "Destination" + ], + "type": "object" + }, + "OnSuccess": { + "additionalProperties": false, + "description": "The destination configuration for successful invocations.", + "properties": { + "Destination": { + "description": "The Amazon Resource Name (ARN) of the destination resource.", + "maxLength": 350, + "minLength": 0, + "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "type": "string" + } + }, + "required": [ + "Destination" + ], + "type": "object" + } + }, + "description": "The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.", + "handlers": { + "create": { + "permissions": [ + "lambda:PutFunctionEventInvokeConfig" + ] + }, + "delete": { + "permissions": [ + "lambda:DeleteFunctionEventInvokeConfig" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FunctionName": { + "$ref": "resource-schema.json#/properties/FunctionName" + } + }, + "required": [ + "FunctionName" + ] + }, + "permissions": [ + "lambda:ListFunctionEventInvokeConfigs" + ] + }, + "read": { + "permissions": [ + "lambda:GetFunctionEventInvokeConfig" + ] + }, + "update": { + "permissions": [ + "lambda:UpdateFunctionEventInvokeConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionName", + "/properties/Qualifier" + ], + "properties": { + "DestinationConfig": { + "$ref": "#/definitions/DestinationConfig" + }, + "FunctionName": { + "description": "The name of the Lambda function.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + }, + "MaximumEventAgeInSeconds": { + "description": "The maximum age of a request that Lambda sends to a function for processing.", + "maximum": 21600, + "minimum": 60, + "type": "integer" + }, + "MaximumRetryAttempts": { + "description": "The maximum number of times to retry when the function returns an error.", + "maximum": 2, + "minimum": 0, + "type": "integer" + }, + "Qualifier": { + "description": "The identifier of a version or alias.", + "pattern": "^(|[a-zA-Z0-9$_-]{1,129})$", + "type": "string" + } + }, + "required": [ + "FunctionName", + "Qualifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Lambda::EventInvokeConfig" +} diff --git a/schema/aws-lambda-eventsourcemapping.json b/schema/aws-lambda-eventsourcemapping.json index 3c7e6ad..5315b75 100644 --- a/schema/aws-lambda-eventsourcemapping.json +++ b/schema/aws-lambda-eventsourcemapping.json @@ -1,407 +1,467 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EventSourceArn", - "/properties/StartingPosition", - "/properties/StartingPositionTimestamp", - "/properties/SelfManagedEventSource", - "/properties/AmazonManagedKafkaEventSourceConfig", - "/properties/SelfManagedKafkaEventSourceConfig" - ], - "definitions": { - "AmazonManagedKafkaEventSourceConfig": { - "additionalProperties": false, - "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.", - "properties": { - "ConsumerGroupId": { - "$ref": "#/definitions/ConsumerGroupId", - "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)." - } - }, - "type": "object" - }, - "ConsumerGroupId": { - "description": "The identifier for the Kafka Consumer Group to join.", - "maxLength": 200, - "minLength": 1, - "pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*", - "type": "string" - }, - "DestinationConfig": { - "additionalProperties": false, - "description": "A configuration object that specifies the destination of an event after Lambda processes it.", - "properties": { - "OnFailure": { - "$ref": "#/definitions/OnFailure", - "description": "The destination configuration for failed invocations." - } - }, - "type": "object" - }, - "DocumentDBEventSourceConfig": { - "additionalProperties": false, - "description": "Specific configuration settings for a DocumentDB event source.", - "properties": { - "CollectionName": { - "description": "The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.", - "maxLength": 57, - "minLength": 1, - "type": "string" - }, - "DatabaseName": { - "description": "The name of the database to consume within the DocumentDB cluster.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "FullDocument": { - "description": "Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.", - "enum": [ - "UpdateLookup", - "Default" - ], - "type": "string" - } - }, - "type": "object" - }, - "Endpoints": { - "additionalProperties": false, - "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", - "properties": { - "KafkaBootstrapServers": { - "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", - "items": { - "description": "The URL of a Kafka server.", - "maxLength": 300, - "minLength": 1, - "pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "description": "A structure within a ``FilterCriteria`` object that defines an event filtering pattern.", - "properties": { - "Pattern": { - "description": "A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax).", - "maxLength": 4096, - "minLength": 0, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "FilterCriteria": { - "additionalProperties": false, - "description": "An object that contains the filters for an event source.", - "properties": { - "Filters": { - "description": "A list of filters.", - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "MaximumConcurrency": { - "description": "The maximum number of concurrent functions that an event source can invoke.", - "maximum": 1000, - "minimum": 2, - "type": "integer" - }, - "OnFailure": { - "additionalProperties": false, - "description": "A destination for events that failed processing.", - "properties": { - "Destination": { - "description": "The Amazon Resource Name (ARN) of the destination resource.\n To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.\n To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination.\n To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.", - "maxLength": 1024, - "minLength": 12, - "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", - "type": "string" - } - }, - "type": "object" - }, - "ScalingConfig": { - "additionalProperties": false, - "description": "(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.", - "properties": { - "MaximumConcurrency": { - "$ref": "#/definitions/MaximumConcurrency", - "description": "Limits the number of concurrent instances that the SQS event source can invoke." - } - }, - "type": "object" - }, - "SelfManagedEventSource": { - "additionalProperties": false, - "description": "The self-managed Apache Kafka cluster for your event source.", - "properties": { - "Endpoints": { - "$ref": "#/definitions/Endpoints", - "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``." - } - }, - "type": "object" - }, - "SelfManagedKafkaEventSourceConfig": { - "additionalProperties": false, - "description": "Specific configuration settings for a self-managed Apache Kafka event source.", - "properties": { - "ConsumerGroupId": { - "$ref": "#/definitions/ConsumerGroupId", - "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)." - } - }, - "type": "object" - }, - "SourceAccessConfiguration": { - "additionalProperties": false, - "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", - "properties": { - "Type": { - "description": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n + ``BASIC_AUTH`` \u2013 (Amazon MQ) The ASMlong secret that stores your broker credentials.\n + ``BASIC_AUTH`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n + ``VPC_SUBNET`` \u2013 (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n + ``VPC_SECURITY_GROUP`` \u2013 (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_256_AUTH`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_512_AUTH`` \u2013 (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n + ``VIRTUAL_HOST`` \u2013- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n + ``CLIENT_CERTIFICATE_TLS_AUTH`` \u2013 (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n + ``SERVER_ROOT_CA_CERTIFICATE`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.", - "enum": [ - "BASIC_AUTH", - "VPC_SUBNET", - "VPC_SECURITY_GROUP", - "SASL_SCRAM_512_AUTH", - "SASL_SCRAM_256_AUTH", - "VIRTUAL_HOST", - "CLIENT_CERTIFICATE_TLS_AUTH", - "SERVER_ROOT_CA_CERTIFICATE" - ], - "type": "string" - }, - "URI": { - "description": "The value for your chosen configuration in ``Type``. For example: ``\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"``.", - "maxLength": 200, - "minLength": 1, - "pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.\n For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. \n + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) \n + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) \n + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) \n + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) \n + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) \n + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) \n + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)", - "handlers": { - "create": { - "permissions": [ - "lambda:CreateEventSourceMapping", - "lambda:GetEventSourceMapping" - ] - }, - "delete": { - "permissions": [ - "lambda:DeleteEventSourceMapping", - "lambda:GetEventSourceMapping" - ] - }, - "list": { - "permissions": [ - "lambda:ListEventSourceMappings" - ] - }, - "read": { - "permissions": [ - "lambda:GetEventSourceMapping" - ] - }, - "update": { - "permissions": [ - "lambda:UpdateEventSourceMapping", - "lambda:GetEventSourceMapping" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AmazonManagedKafkaEventSourceConfig": { - "$ref": "#/definitions/AmazonManagedKafkaEventSourceConfig", - "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source." - }, - "BatchSize": { - "description": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).\n + *Amazon Kinesis* \u2013 Default 100. Max 10,000.\n + *Amazon DynamoDB Streams* \u2013 Default 100. Max 10,000.\n + *Amazon Simple Queue Service* \u2013 Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n + *Amazon Managed Streaming for Apache Kafka* \u2013 Default 100. Max 10,000.\n + *Self-managed Apache Kafka* \u2013 Default 100. Max 10,000.\n + *Amazon MQ (ActiveMQ and RabbitMQ)* \u2013 Default 100. Max 10,000.\n + *DocumentDB* \u2013 Default 100. Max 10,000.", - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "BisectBatchOnFunctionError": { - "description": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.", - "type": "boolean" - }, - "DestinationConfig": { - "$ref": "#/definitions/DestinationConfig", - "description": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it." - }, - "DocumentDBEventSourceConfig": { - "$ref": "#/definitions/DocumentDBEventSourceConfig", - "description": "Specific configuration settings for a DocumentDB event source." - }, - "Enabled": { - "description": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.\n Default: True", - "type": "boolean" - }, - "EventSourceArn": { - "description": "The Amazon Resource Name (ARN) of the event source.\n + *Amazon Kinesis* \u2013 The ARN of the data stream or a stream consumer.\n + *Amazon DynamoDB Streams* \u2013 The ARN of the stream.\n + *Amazon Simple Queue Service* \u2013 The ARN of the queue.\n + *Amazon Managed Streaming for Apache Kafka* \u2013 The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).\n + *Amazon MQ* \u2013 The ARN of the broker.\n + *Amazon DocumentDB* \u2013 The ARN of the DocumentDB change stream.", - "maxLength": 1024, - "minLength": 12, - "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", - "type": "string" - }, - "FilterCriteria": { - "$ref": "#/definitions/FilterCriteria", - "description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)." - }, - "FunctionName": { - "description": "The name or ARN of the Lambda function.\n **Name formats**\n + *Function name* \u2013 ``MyFunction``.\n + *Function ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.\n + *Version or Alias ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.\n + *Partial ARN* \u2013 ``123456789012:function:MyFunction``.\n \n The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.", - "maxLength": 140, - "minLength": 1, - "pattern": "(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?", - "type": "string" - }, - "FunctionResponseTypes": { - "description": "(Streams and SQS) A list of current response type enums applied to the event source mapping.\n Valid Values: ``ReportBatchItemFailures``", - "items": { - "enum": [ - "ReportBatchItemFailures" - ], - "type": "string" - }, - "maxLength": 1, - "minLength": 0, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "", - "maxLength": 36, - "minLength": 36, - "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", - "type": "string" - }, - "MaximumBatchingWindowInSeconds": { - "description": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n *Default (, , event sources)*: 0\n *Default (, Kafka, , event sources)*: 500 ms\n *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.", - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "MaximumRecordAgeInSeconds": { - "description": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.\n The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed", - "maximum": 604800, - "minimum": -1, - "type": "integer" - }, - "MaximumRetryAttempts": { - "description": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.", - "maximum": 10000, - "minimum": -1, - "type": "integer" - }, - "ParallelizationFactor": { - "description": "(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.", - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "Queues": { - "description": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.", - "items": { - "maxLength": 1000, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ScalingConfig": { - "$ref": "#/definitions/ScalingConfig", - "description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency)." - }, - "SelfManagedEventSource": { - "$ref": "#/definitions/SelfManagedEventSource", - "description": "The self-managed Apache Kafka cluster for your event source." - }, - "SelfManagedKafkaEventSourceConfig": { - "$ref": "#/definitions/SelfManagedKafkaEventSourceConfig", - "description": "Specific configuration settings for a self-managed Apache Kafka event source." - }, - "SourceAccessConfigurations": { - "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", - "items": { - "$ref": "#/definitions/SourceAccessConfiguration" - }, - "maxItems": 22, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "StartingPosition": { - "description": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.\n + *LATEST* - Read only new records.\n + *TRIM_HORIZON* - Process all available records.\n + *AT_TIMESTAMP* - Specify a time from which to start reading records.", - "maxLength": 12, - "minLength": 6, - "pattern": "(LATEST|TRIM_HORIZON|AT_TIMESTAMP)+", - "type": "string" - }, - "StartingPositionTimestamp": { - "description": "With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.", - "type": "number" - }, - "Topics": { - "description": "The name of the Kafka topic.", - "items": { - "maxLength": 249, - "minLength": 1, - "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)", - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TumblingWindowInSeconds": { - "description": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.", - "maximum": 900, - "minimum": 0, - "type": "integer" - } - }, - "propertyTransform": { - "/properties/StartingPositionTimestamp": "StartingPositionTimestamp * 1000" - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FunctionName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::EventSourceMapping" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EventSourceArn", + "/properties/StartingPosition", + "/properties/StartingPositionTimestamp", + "/properties/SelfManagedEventSource", + "/properties/AmazonManagedKafkaEventSourceConfig", + "/properties/SelfManagedKafkaEventSourceConfig" + ], + "definitions": { + "AmazonManagedKafkaEventSourceConfig": { + "additionalProperties": false, + "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.", + "properties": { + "ConsumerGroupId": { + "$ref": "#/definitions/ConsumerGroupId", + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)." + } + }, + "type": "object" + }, + "ConsumerGroupId": { + "description": "The identifier for the Kafka Consumer Group to join.", + "maxLength": 200, + "minLength": 1, + "pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*", + "type": "string" + }, + "DestinationConfig": { + "additionalProperties": false, + "description": "A configuration object that specifies the destination of an event after Lambda processes it.", + "properties": { + "OnFailure": { + "$ref": "#/definitions/OnFailure", + "description": "The destination configuration for failed invocations." + } + }, + "type": "object" + }, + "DocumentDBEventSourceConfig": { + "additionalProperties": false, + "description": "Specific configuration settings for a DocumentDB event source.", + "properties": { + "CollectionName": { + "description": "The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.", + "maxLength": 57, + "minLength": 1, + "type": "string" + }, + "DatabaseName": { + "description": "The name of the database to consume within the DocumentDB cluster.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "FullDocument": { + "description": "Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.", + "enum": [ + "UpdateLookup", + "Default" + ], + "type": "string" + } + }, + "type": "object" + }, + "Endpoints": { + "additionalProperties": false, + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", + "properties": { + "KafkaBootstrapServers": { + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", + "items": { + "description": "The URL of a Kafka server.", + "maxLength": 300, + "minLength": 1, + "pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "description": "A structure within a ``FilterCriteria`` object that defines an event filtering pattern.", + "properties": { + "Pattern": { + "description": "A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax).", + "maxLength": 4096, + "minLength": 0, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "FilterCriteria": { + "additionalProperties": false, + "description": "An object that contains the filters for an event source.", + "properties": { + "Filters": { + "description": "A list of filters.", + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "MaximumConcurrency": { + "description": "The maximum number of concurrent functions that an event source can invoke.", + "maximum": 1000, + "minimum": 2, + "type": "integer" + }, + "OnFailure": { + "additionalProperties": false, + "description": "A destination for events that failed processing.", + "properties": { + "Destination": { + "description": "The Amazon Resource Name (ARN) of the destination resource.\n To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.\n To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination.\n To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.", + "maxLength": 1024, + "minLength": 12, + "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "type": "string" + } + }, + "type": "object" + }, + "ScalingConfig": { + "additionalProperties": false, + "description": "(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.", + "properties": { + "MaximumConcurrency": { + "$ref": "#/definitions/MaximumConcurrency", + "description": "Limits the number of concurrent instances that the SQS event source can invoke." + } + }, + "type": "object" + }, + "SelfManagedEventSource": { + "additionalProperties": false, + "description": "The self-managed Apache Kafka cluster for your event source.", + "properties": { + "Endpoints": { + "$ref": "#/definitions/Endpoints", + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``." + } + }, + "type": "object" + }, + "SelfManagedKafkaEventSourceConfig": { + "additionalProperties": false, + "description": "Specific configuration settings for a self-managed Apache Kafka event source.", + "properties": { + "ConsumerGroupId": { + "$ref": "#/definitions/ConsumerGroupId", + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)." + } + }, + "type": "object" + }, + "SourceAccessConfiguration": { + "additionalProperties": false, + "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", + "properties": { + "Type": { + "description": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n + ``BASIC_AUTH`` \u2013 (Amazon MQ) The ASMlong secret that stores your broker credentials.\n + ``BASIC_AUTH`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n + ``VPC_SUBNET`` \u2013 (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n + ``VPC_SECURITY_GROUP`` \u2013 (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_256_AUTH`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_512_AUTH`` \u2013 (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n + ``VIRTUAL_HOST`` \u2013- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n + ``CLIENT_CERTIFICATE_TLS_AUTH`` \u2013 (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n + ``SERVER_ROOT_CA_CERTIFICATE`` \u2013 (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.", + "enum": [ + "BASIC_AUTH", + "VPC_SUBNET", + "VPC_SECURITY_GROUP", + "SASL_SCRAM_512_AUTH", + "SASL_SCRAM_256_AUTH", + "VIRTUAL_HOST", + "CLIENT_CERTIFICATE_TLS_AUTH", + "SERVER_ROOT_CA_CERTIFICATE" + ], + "type": "string" + }, + "URI": { + "description": "The value for your chosen configuration in ``Type``. For example: ``\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"``.", + "maxLength": 200, + "minLength": 1, + "pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.\n For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. \n + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) \n + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) \n + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) \n + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) \n + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) \n + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) \n + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)", + "handlers": { + "create": { + "permissions": [ + "lambda:CreateEventSourceMapping", + "lambda:GetEventSourceMapping", + "lambda:TagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "lambda:DeleteEventSourceMapping", + "lambda:GetEventSourceMapping", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "lambda:ListEventSourceMappings" + ] + }, + "read": { + "permissions": [ + "lambda:GetEventSourceMapping", + "lambda:ListTags", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "lambda:UpdateEventSourceMapping", + "lambda:GetEventSourceMapping", + "lambda:ListTags", + "lambda:TagResource", + "lambda:UntagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AmazonManagedKafkaEventSourceConfig": { + "$ref": "#/definitions/AmazonManagedKafkaEventSourceConfig", + "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source." + }, + "BatchSize": { + "description": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).\n + *Amazon Kinesis* \u2013 Default 100. Max 10,000.\n + *Amazon DynamoDB Streams* \u2013 Default 100. Max 10,000.\n + *Amazon Simple Queue Service* \u2013 Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n + *Amazon Managed Streaming for Apache Kafka* \u2013 Default 100. Max 10,000.\n + *Self-managed Apache Kafka* \u2013 Default 100. Max 10,000.\n + *Amazon MQ (ActiveMQ and RabbitMQ)* \u2013 Default 100. Max 10,000.\n + *DocumentDB* \u2013 Default 100. Max 10,000.", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "BisectBatchOnFunctionError": { + "description": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.", + "type": "boolean" + }, + "DestinationConfig": { + "$ref": "#/definitions/DestinationConfig", + "description": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it." + }, + "DocumentDBEventSourceConfig": { + "$ref": "#/definitions/DocumentDBEventSourceConfig", + "description": "Specific configuration settings for a DocumentDB event source." + }, + "Enabled": { + "description": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.\n Default: True", + "type": "boolean" + }, + "EventSourceArn": { + "description": "The Amazon Resource Name (ARN) of the event source.\n + *Amazon Kinesis* \u2013 The ARN of the data stream or a stream consumer.\n + *Amazon DynamoDB Streams* \u2013 The ARN of the stream.\n + *Amazon Simple Queue Service* \u2013 The ARN of the queue.\n + *Amazon Managed Streaming for Apache Kafka* \u2013 The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).\n + *Amazon MQ* \u2013 The ARN of the broker.\n + *Amazon DocumentDB* \u2013 The ARN of the DocumentDB change stream.", + "maxLength": 1024, + "minLength": 12, + "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "type": "string" + }, + "EventSourceMappingArn": { + "description": "", + "maxLength": 120, + "minLength": 85, + "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "type": "string" + }, + "FilterCriteria": { + "$ref": "#/definitions/FilterCriteria", + "description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)." + }, + "FunctionName": { + "description": "The name or ARN of the Lambda function.\n **Name formats**\n + *Function name* \u2013 ``MyFunction``.\n + *Function ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.\n + *Version or Alias ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.\n + *Partial ARN* \u2013 ``123456789012:function:MyFunction``.\n \n The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.", + "maxLength": 140, + "minLength": 1, + "pattern": "(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?", + "type": "string" + }, + "FunctionResponseTypes": { + "description": "(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.\n Valid Values: ``ReportBatchItemFailures``", + "items": { + "enum": [ + "ReportBatchItemFailures" + ], + "type": "string" + }, + "maxLength": 1, + "minLength": 0, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "", + "maxLength": 36, + "minLength": 36, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "KmsKeyArn": { + "description": "The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics).", + "maxLength": 2048, + "minLength": 12, + "pattern": "(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()", + "type": "string" + }, + "MaximumBatchingWindowInSeconds": { + "description": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n *Default (, , event sources)*: 0\n *Default (, Kafka, , event sources)*: 500 ms\n *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "MaximumRecordAgeInSeconds": { + "description": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.\n The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed", + "maximum": 604800, + "minimum": -1, + "type": "integer" + }, + "MaximumRetryAttempts": { + "description": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.", + "maximum": 10000, + "minimum": -1, + "type": "integer" + }, + "ParallelizationFactor": { + "description": "(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "Queues": { + "description": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.", + "items": { + "maxLength": 1000, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ScalingConfig": { + "$ref": "#/definitions/ScalingConfig", + "description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency)." + }, + "SelfManagedEventSource": { + "$ref": "#/definitions/SelfManagedEventSource", + "description": "The self-managed Apache Kafka cluster for your event source." + }, + "SelfManagedKafkaEventSourceConfig": { + "$ref": "#/definitions/SelfManagedKafkaEventSourceConfig", + "description": "Specific configuration settings for a self-managed Apache Kafka event source." + }, + "SourceAccessConfigurations": { + "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", + "items": { + "$ref": "#/definitions/SourceAccessConfiguration" + }, + "maxItems": 22, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "StartingPosition": { + "description": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.\n + *LATEST* - Read only new records.\n + *TRIM_HORIZON* - Process all available records.\n + *AT_TIMESTAMP* - Specify a time from which to start reading records.", + "maxLength": 12, + "minLength": 6, + "pattern": "(LATEST|TRIM_HORIZON|AT_TIMESTAMP)+", + "type": "string" + }, + "StartingPositionTimestamp": { + "description": "With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.", + "type": "number" + }, + "Tags": { + "description": "", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Topics": { + "description": "The name of the Kafka topic.", + "items": { + "maxLength": 249, + "minLength": 1, + "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)", + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TumblingWindowInSeconds": { + "description": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.", + "maximum": 900, + "minimum": 0, + "type": "integer" + } + }, + "propertyTransform": { + "/properties/StartingPositionTimestamp": "StartingPositionTimestamp * 1000" + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/EventSourceMappingArn" + ], + "required": [ + "FunctionName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Lambda::EventSourceMapping" +} diff --git a/schema/aws-lambda-function.json b/schema/aws-lambda-function.json index 0ea64fb..9ed7028 100644 --- a/schema/aws-lambda-function.json +++ b/schema/aws-lambda-function.json @@ -1,562 +1,584 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FunctionName" - ], - "definitions": { - "Code": { - "additionalProperties": false, - "description": "The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.\n Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.", - "properties": { - "ImageUri": { - "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry.", - "type": "string" - }, - "S3Bucket": { - "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[0-9A-Za-z\\.\\-_]*(?``. To use a different log group, enter an existing log group or enter a new log group name.", - "maxLength": 512, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - }, - "SystemLogLevel": { - "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.", - "enum": [ - "DEBUG", - "INFO", - "WARN" - ], - "type": "string" - } - }, - "type": "object" - }, - "RuntimeManagementConfig": { - "additionalProperties": false, - "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).", - "properties": { - "RuntimeVersionArn": { - "description": "The ARN of the runtime version you want the function to use.\n This is only required if you're using the *Manual* runtime update mode.", - "type": "string" - }, - "UpdateRuntimeOn": { - "description": "Specify the runtime update mode.\n + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates.\n + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.\n + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``", - "enum": [ - "Auto", - "FunctionUpdate", - "Manual" - ], - "type": "string" - } - }, - "required": [ - "UpdateRuntimeOn" - ], - "type": "object" - }, - "SnapStart": { - "additionalProperties": false, - "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", - "properties": { - "ApplyOn": { - "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.", - "enum": [ - "PublishedVersions", - "None" - ], - "type": "string" - } - }, - "required": [ - "ApplyOn" - ], - "type": "object" - }, - "SnapStartResponse": { - "additionalProperties": false, - "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", - "properties": { - "ApplyOn": { - "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version.", - "enum": [ - "PublishedVersions", - "None" - ], - "type": "string" - }, - "OptimizationStatus": { - "description": "When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version.", - "enum": [ - "On", - "Off" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "TracingConfig": { - "additionalProperties": false, - "description": "The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``.", - "properties": { - "Mode": { - "description": "The tracing mode.", - "enum": [ - "Active", - "PassThrough" - ], - "type": "string" - } - }, - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "description": "The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources.\n To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.", - "properties": { - "Ipv6AllowedForDualStack": { - "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.", - "type": "boolean" - }, - "SecurityGroupIds": { - "description": "A list of VPC security group IDs.", - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "description": "A list of VPC subnet IDs.", - "items": { - "type": "string" - }, - "maxItems": 16, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "The ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.\n You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. \n You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).\n You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.\n Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.\n For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*", - "handlers": { - "create": { - "permissions": [ - "lambda:CreateFunction", - "lambda:GetFunction", - "lambda:PutFunctionConcurrency", - "iam:PassRole", - "s3:GetObject", - "s3:GetObjectVersion", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "elasticfilesystem:DescribeMountTargets", - "kms:CreateGrant", - "kms:Decrypt", - "kms:Encrypt", - "kms:GenerateDataKey", - "lambda:GetCodeSigningConfig", - "lambda:GetFunctionCodeSigningConfig", - "lambda:GetLayerVersion", - "lambda:GetRuntimeManagementConfig", - "lambda:PutRuntimeManagementConfig", - "lambda:TagResource" - ] - }, - "delete": { - "permissions": [ - "lambda:DeleteFunction", - "lambda:GetFunction", - "ec2:DescribeNetworkInterfaces" - ] - }, - "list": { - "permissions": [ - "lambda:ListFunctions" - ] - }, - "read": { - "permissions": [ - "lambda:GetFunction", - "lambda:GetFunctionCodeSigningConfig" - ] - }, - "update": { - "permissions": [ - "lambda:DeleteFunctionConcurrency", - "lambda:GetFunction", - "lambda:PutFunctionConcurrency", - "lambda:ListTags", - "lambda:TagResource", - "lambda:UntagResource", - "lambda:UpdateFunctionConfiguration", - "lambda:UpdateFunctionCode", - "iam:PassRole", - "s3:GetObject", - "s3:GetObjectVersion", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "elasticfilesystem:DescribeMountTargets", - "kms:CreateGrant", - "kms:Decrypt", - "kms:GenerateDataKey", - "lambda:GetRuntimeManagementConfig", - "lambda:PutRuntimeManagementConfig", - "lambda:PutFunctionCodeSigningConfig", - "lambda:DeleteFunctionCodeSigningConfig", - "lambda:GetCodeSigningConfig", - "lambda:GetFunctionCodeSigningConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionName" - ], - "properties": { - "Architectures": { - "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.", - "items": { - "enum": [ - "x86_64", - "arm64" - ], - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "description": "", - "type": "string" - }, - "Code": { - "$ref": "#/definitions/Code", - "description": "The code for the function." - }, - "CodeSigningConfigArn": { - "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.", - "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}", - "type": "string" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/DeadLetterConfig", - "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)." - }, - "Description": { - "description": "A description of the function.", - "maxLength": 256, - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/Environment", - "description": "Environment variables that are accessible from function code during execution." - }, - "EphemeralStorage": { - "$ref": "#/definitions/EphemeralStorage", - "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." - }, - "FileSystemConfigs": { - "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.\n For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).", - "items": { - "$ref": "#/definitions/FileSystemConfig" - }, - "maxItems": 1, - "type": "array" - }, - "FunctionName": { - "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "minLength": 1, - "type": "string" - }, - "Handler": { - "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).", - "maxLength": 128, - "pattern": "^[^\\s]+$", - "type": "string" - }, - "ImageConfig": { - "$ref": "#/definitions/ImageConfig", - "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." - }, - "KmsKeyArn": { - "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", - "type": "string" - }, - "Layers": { - "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LoggingConfig": { - "$ref": "#/definitions/LoggingConfig", - "description": "The function's Amazon CloudWatch Logs configuration settings." - }, - "MemorySize": { - "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.", - "type": "integer" - }, - "PackageType": { - "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.", - "enum": [ - "Image", - "Zip" - ], - "type": "string" - }, - "ReservedConcurrentExecutions": { - "description": "The number of simultaneous executions to reserve for the function.", - "minimum": 0, - "type": "integer" - }, - "Role": { - "description": "The Amazon Resource Name (ARN) of the function's execution role.", - "pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Runtime": { - "description": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.\n The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).\n For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).", - "type": "string" - }, - "RuntimeManagementConfig": { - "$ref": "#/definitions/RuntimeManagementConfig", - "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." - }, - "SnapStart": { - "$ref": "#/definitions/SnapStart", - "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." - }, - "SnapStartResponse": { - "$ref": "#/definitions/SnapStartResponse", - "description": "" - }, - "Tags": { - "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Timeout": { - "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).", - "minimum": 1, - "type": "integer" - }, - "TracingConfig": { - "$ref": "#/definitions/TracingConfig", - "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)." - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig", - "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)." - } - }, - "readOnlyProperties": [ - "/properties/SnapStartResponse", - "/properties/SnapStartResponse/ApplyOn", - "/properties/SnapStartResponse/OptimizationStatus", - "/properties/Arn" - ], - "required": [ - "Code", - "Role" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Lambda::Function", - "writeOnlyProperties": [ - "/properties/SnapStart", - "/properties/SnapStart/ApplyOn", - "/properties/Code", - "/properties/Code/ImageUri", - "/properties/Code/S3Bucket", - "/properties/Code/S3Key", - "/properties/Code/S3ObjectVersion", - "/properties/Code/ZipFile" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FunctionName" + ], + "definitions": { + "Code": { + "additionalProperties": false, + "description": "The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.\n Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.", + "properties": { + "ImageUri": { + "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry.", + "type": "string" + }, + "S3Bucket": { + "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[0-9A-Za-z\\.\\-_]*(?``. To use a different log group, enter an existing log group or enter a new log group name.", + "maxLength": 512, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + }, + "SystemLogLevel": { + "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.", + "enum": [ + "DEBUG", + "INFO", + "WARN" + ], + "type": "string" + } + }, + "type": "object" + }, + "RecursiveLoop": { + "description": "The function recursion configuration.", + "enum": [ + "Allow", + "Terminate" + ], + "type": "string" + }, + "RuntimeManagementConfig": { + "additionalProperties": false, + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).", + "properties": { + "RuntimeVersionArn": { + "description": "The ARN of the runtime version you want the function to use.\n This is only required if you're using the *Manual* runtime update mode.", + "type": "string" + }, + "UpdateRuntimeOn": { + "description": "Specify the runtime update mode.\n + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates.\n + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.\n + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``", + "enum": [ + "Auto", + "FunctionUpdate", + "Manual" + ], + "type": "string" + } + }, + "required": [ + "UpdateRuntimeOn" + ], + "type": "object" + }, + "SnapStart": { + "additionalProperties": false, + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", + "properties": { + "ApplyOn": { + "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.", + "enum": [ + "PublishedVersions", + "None" + ], + "type": "string" + } + }, + "required": [ + "ApplyOn" + ], + "type": "object" + }, + "SnapStartResponse": { + "additionalProperties": false, + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", + "properties": { + "ApplyOn": { + "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version.", + "enum": [ + "PublishedVersions", + "None" + ], + "type": "string" + }, + "OptimizationStatus": { + "description": "When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version.", + "enum": [ + "On", + "Off" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "TracingConfig": { + "additionalProperties": false, + "description": "The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``.", + "properties": { + "Mode": { + "description": "The tracing mode.", + "enum": [ + "Active", + "PassThrough" + ], + "type": "string" + } + }, + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "description": "The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources.\n To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.", + "properties": { + "Ipv6AllowedForDualStack": { + "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.", + "type": "boolean" + }, + "SecurityGroupIds": { + "description": "A list of VPC security group IDs.", + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "description": "A list of VPC subnet IDs.", + "items": { + "type": "string" + }, + "maxItems": 16, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "The ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.\n You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. \n You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).\n You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.\n Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.\n For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*", + "handlers": { + "create": { + "permissions": [ + "lambda:CreateFunction", + "lambda:GetFunction", + "lambda:PutFunctionConcurrency", + "iam:PassRole", + "s3:GetObject", + "s3:GetObjectVersion", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "elasticfilesystem:DescribeMountTargets", + "kms:CreateGrant", + "kms:Decrypt", + "kms:Encrypt", + "kms:GenerateDataKey", + "lambda:GetCodeSigningConfig", + "lambda:GetFunctionCodeSigningConfig", + "lambda:GetLayerVersion", + "lambda:GetRuntimeManagementConfig", + "lambda:PutRuntimeManagementConfig", + "lambda:TagResource", + "lambda:PutFunctionRecursionConfig", + "lambda:GetFunctionRecursionConfig" + ] + }, + "delete": { + "permissions": [ + "lambda:DeleteFunction", + "lambda:GetFunction", + "ec2:DescribeNetworkInterfaces" + ] + }, + "list": { + "permissions": [ + "lambda:ListFunctions" + ] + }, + "read": { + "permissions": [ + "lambda:GetFunction", + "lambda:GetFunctionCodeSigningConfig", + "lambda:GetFunctionRecursionConfig" + ] + }, + "update": { + "permissions": [ + "lambda:DeleteFunctionConcurrency", + "lambda:GetFunction", + "lambda:PutFunctionConcurrency", + "lambda:ListTags", + "lambda:TagResource", + "lambda:UntagResource", + "lambda:UpdateFunctionConfiguration", + "lambda:UpdateFunctionCode", + "iam:PassRole", + "s3:GetObject", + "s3:GetObjectVersion", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "elasticfilesystem:DescribeMountTargets", + "kms:CreateGrant", + "kms:Decrypt", + "kms:GenerateDataKey", + "lambda:GetRuntimeManagementConfig", + "lambda:PutRuntimeManagementConfig", + "lambda:PutFunctionCodeSigningConfig", + "lambda:DeleteFunctionCodeSigningConfig", + "lambda:GetCodeSigningConfig", + "lambda:GetFunctionCodeSigningConfig", + "lambda:PutFunctionRecursionConfig", + "lambda:GetFunctionRecursionConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionName" + ], + "properties": { + "Architectures": { + "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.", + "items": { + "enum": [ + "x86_64", + "arm64" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "description": "", + "type": "string" + }, + "Code": { + "$ref": "#/definitions/Code", + "description": "The code for the function." + }, + "CodeSigningConfigArn": { + "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.", + "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}", + "type": "string" + }, + "DeadLetterConfig": { + "$ref": "#/definitions/DeadLetterConfig", + "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)." + }, + "Description": { + "description": "A description of the function.", + "maxLength": 256, + "type": "string" + }, + "Environment": { + "$ref": "#/definitions/Environment", + "description": "Environment variables that are accessible from function code during execution." + }, + "EphemeralStorage": { + "$ref": "#/definitions/EphemeralStorage", + "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." + }, + "FileSystemConfigs": { + "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.\n For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).", + "items": { + "$ref": "#/definitions/FileSystemConfig" + }, + "maxItems": 1, + "type": "array" + }, + "FunctionName": { + "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "minLength": 1, + "type": "string" + }, + "Handler": { + "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).", + "maxLength": 128, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "ImageConfig": { + "$ref": "#/definitions/ImageConfig", + "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." + }, + "KmsKeyArn": { + "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "type": "string" + }, + "Layers": { + "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LoggingConfig": { + "$ref": "#/definitions/LoggingConfig", + "description": "The function's Amazon CloudWatch Logs configuration settings." + }, + "MemorySize": { + "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.", + "type": "integer" + }, + "PackageType": { + "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.", + "enum": [ + "Image", + "Zip" + ], + "type": "string" + }, + "RecursiveLoop": { + "$ref": "#/definitions/RecursiveLoop", + "description": "" + }, + "ReservedConcurrentExecutions": { + "description": "The number of simultaneous executions to reserve for the function.", + "minimum": 0, + "type": "integer" + }, + "Role": { + "description": "The Amazon Resource Name (ARN) of the function's execution role.", + "pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Runtime": { + "description": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.\n The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).\n For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).", + "type": "string" + }, + "RuntimeManagementConfig": { + "$ref": "#/definitions/RuntimeManagementConfig", + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." + }, + "SnapStart": { + "$ref": "#/definitions/SnapStart", + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." + }, + "SnapStartResponse": { + "$ref": "#/definitions/SnapStartResponse", + "description": "" + }, + "Tags": { + "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Timeout": { + "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).", + "minimum": 1, + "type": "integer" + }, + "TracingConfig": { + "$ref": "#/definitions/TracingConfig", + "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)." + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig", + "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)." + } + }, + "readOnlyProperties": [ + "/properties/SnapStartResponse", + "/properties/SnapStartResponse/ApplyOn", + "/properties/SnapStartResponse/OptimizationStatus", + "/properties/Arn" + ], + "required": [ + "Code", + "Role" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Lambda::Function", + "writeOnlyProperties": [ + "/properties/SnapStart", + "/properties/SnapStart/ApplyOn", + "/properties/Code", + "/properties/Code/ImageUri", + "/properties/Code/S3Bucket", + "/properties/Code/S3Key", + "/properties/Code/S3ObjectVersion", + "/properties/Code/ZipFile" + ] +} diff --git a/schema/aws-lambda-layerversion.json b/schema/aws-lambda-layerversion.json index 8cbace9..bad498d 100644 --- a/schema/aws-lambda-layerversion.json +++ b/schema/aws-lambda-layerversion.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CompatibleRuntimes", - "/properties/LicenseInfo", - "/properties/CompatibleArchitectures", - "/properties/LayerName", - "/properties/Description", - "/properties/Content" - ], - "definitions": { - "Content": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "description": "The Amazon S3 bucket of the layer archive.", - "type": "string" - }, - "S3Key": { - "description": "The Amazon S3 key of the layer archive.", - "type": "string" - }, - "S3ObjectVersion": { - "description": "For versioned objects, the version of the layer archive object to use.", - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lambda::LayerVersion", - "handlers": { - "create": { - "permissions": [ - "lambda:PublishLayerVersion", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "lambda:GetLayerVersion", - "lambda:DeleteLayerVersion" - ] - }, - "list": { - "permissions": [ - "lambda:ListLayerVersions" - ] - }, - "read": { - "permissions": [ - "lambda:GetLayerVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/LayerVersionArn" - ], - "properties": { - "CompatibleArchitectures": { - "description": "A list of compatible instruction set architectures.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CompatibleRuntimes": { - "description": "A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Content": { - "$ref": "#/definitions/Content", - "description": "The function layer archive." - }, - "Description": { - "description": "The description of the version.", - "type": "string" - }, - "LayerName": { - "description": "The name or Amazon Resource Name (ARN) of the layer.", - "type": "string" - }, - "LayerVersionArn": { - "type": "string" - }, - "LicenseInfo": { - "description": "The layer's software license.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LayerVersionArn" - ], - "required": [ - "Content" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::LayerVersion", - "writeOnlyProperties": [ - "/properties/Content" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CompatibleRuntimes", + "/properties/LicenseInfo", + "/properties/CompatibleArchitectures", + "/properties/LayerName", + "/properties/Description", + "/properties/Content" + ], + "definitions": { + "Content": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "description": "The Amazon S3 bucket of the layer archive.", + "type": "string" + }, + "S3Key": { + "description": "The Amazon S3 key of the layer archive.", + "type": "string" + }, + "S3ObjectVersion": { + "description": "For versioned objects, the version of the layer archive object to use.", + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lambda::LayerVersion", + "handlers": { + "create": { + "permissions": [ + "lambda:PublishLayerVersion", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "lambda:GetLayerVersion", + "lambda:DeleteLayerVersion" + ] + }, + "list": { + "permissions": [ + "lambda:ListLayerVersions" + ] + }, + "read": { + "permissions": [ + "lambda:GetLayerVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/LayerVersionArn" + ], + "properties": { + "CompatibleArchitectures": { + "description": "A list of compatible instruction set architectures.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CompatibleRuntimes": { + "description": "A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Content": { + "$ref": "#/definitions/Content", + "description": "The function layer archive." + }, + "Description": { + "description": "The description of the version.", + "type": "string" + }, + "LayerName": { + "description": "The name or Amazon Resource Name (ARN) of the layer.", + "type": "string" + }, + "LayerVersionArn": { + "type": "string" + }, + "LicenseInfo": { + "description": "The layer's software license.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LayerVersionArn" + ], + "required": [ + "Content" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Lambda::LayerVersion", + "writeOnlyProperties": [ + "/properties/Content" + ] +} diff --git a/schema/aws-lambda-layerversionpermission.json b/schema/aws-lambda-layerversionpermission.json index 39bb332..e4b9169 100644 --- a/schema/aws-lambda-layerversionpermission.json +++ b/schema/aws-lambda-layerversionpermission.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OrganizationId", - "/properties/Principal", - "/properties/Action", - "/properties/LayerVersionArn" - ], - "description": "Schema for Lambda LayerVersionPermission", - "handlers": { - "create": { - "permissions": [ - "lambda:AddLayerVersionPermission" - ] - }, - "delete": { - "permissions": [ - "lambda:GetLayerVersionPolicy", - "lambda:RemoveLayerVersionPermission" - ] - }, - "list": { - "permissions": [ - "lambda:GetLayerVersionPolicy" - ] - }, - "read": { - "permissions": [ - "lambda:GetLayerVersionPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Action": { - "description": "The API action that grants access to the layer.", - "type": "string" - }, - "Id": { - "description": "ID generated by service", - "type": "string" - }, - "LayerVersionArn": { - "description": "The name or Amazon Resource Name (ARN) of the layer.", - "type": "string" - }, - "OrganizationId": { - "description": "With the principal set to *, grant permission to all accounts in the specified organization.", - "type": "string" - }, - "Principal": { - "description": "An account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "LayerVersionArn", - "Action", - "Principal" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::LayerVersionPermission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OrganizationId", + "/properties/Principal", + "/properties/Action", + "/properties/LayerVersionArn" + ], + "description": "Schema for Lambda LayerVersionPermission", + "handlers": { + "create": { + "permissions": [ + "lambda:AddLayerVersionPermission" + ] + }, + "delete": { + "permissions": [ + "lambda:GetLayerVersionPolicy", + "lambda:RemoveLayerVersionPermission" + ] + }, + "list": { + "permissions": [ + "lambda:GetLayerVersionPolicy" + ] + }, + "read": { + "permissions": [ + "lambda:GetLayerVersionPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Action": { + "description": "The API action that grants access to the layer.", + "type": "string" + }, + "Id": { + "description": "ID generated by service", + "type": "string" + }, + "LayerVersionArn": { + "description": "The name or Amazon Resource Name (ARN) of the layer.", + "type": "string" + }, + "OrganizationId": { + "description": "With the principal set to *, grant permission to all accounts in the specified organization.", + "type": "string" + }, + "Principal": { + "description": "An account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "LayerVersionArn", + "Action", + "Principal" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lambda.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Lambda::LayerVersionPermission" +} diff --git a/schema/aws-lambda-permission.json b/schema/aws-lambda-permission.json index c5e99f8..aaaa18d 100644 --- a/schema/aws-lambda-permission.json +++ b/schema/aws-lambda-permission.json @@ -1,138 +1,138 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FunctionName", - "/properties/FunctionUrlAuthType", - "/properties/SourceAccount", - "/properties/SourceArn", - "/properties/Principal", - "/properties/PrincipalOrgID", - "/properties/Action", - "/properties/EventSourceToken" - ], - "description": "The ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.\n To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.\n If your function has a function URL, you can specify the ``FunctionUrlAuthType`` parameter. This adds a condition to your permission that only applies when your function URL's ``AuthType`` matches the specified ``FunctionUrlAuthType``. For more information about the ``AuthType`` parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\n This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).", - "handlers": { - "create": { - "permissions": [ - "lambda:AddPermission" - ] - }, - "delete": { - "permissions": [ - "lambda:RemovePermission" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FunctionName": { - "description": "The name of the Lambda function, version, or alias.", - "maxLength": 140, - "minLength": 1, - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "FunctionName" - ] - }, - "permissions": [ - "lambda:GetPolicy" - ] - }, - "read": { - "permissions": [ - "lambda:GetPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionName", - "/properties/Id" - ], - "properties": { - "Action": { - "description": "The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(lambda:[*]|lambda:[a-zA-Z]+|[*])$", - "type": "string" - }, - "EventSourceToken": { - "description": "For Alexa Smart Home functions, a token that the invoker must supply.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9._\\-]+$", - "type": "string" - }, - "FunctionName": { - "description": "The name or ARN of the Lambda function, version, or alias.\n **Name formats**\n + *Function name* \u2013 ``my-function`` (name-only), ``my-function:v1`` (with alias).\n + *Function ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.\n + *Partial ARN* \u2013 ``123456789012:function:my-function``.\n \n You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.", - "maxLength": 140, - "minLength": 1, - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - }, - "FunctionUrlAuthType": { - "description": "The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).", - "enum": [ - "AWS_IAM", - "NONE" - ], - "type": "string" - }, - "Id": { - "description": "", - "maxLength": 256, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Principal": { - "description": "The AWS-service or AWS-account that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.", - "maxLength": 256, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "PrincipalOrgID": { - "description": "The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.", - "maxLength": 34, - "minLength": 12, - "pattern": "^o-[a-z0-9]{10,32}$", - "type": "string" - }, - "SourceAccount": { - "description": "For AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.", - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d{12}$", - "type": "string" - }, - "SourceArn": { - "description": "For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.\n Note that Lambda configures the comparison using the ``StringLike`` operator.", - "maxLength": 1024, - "minLength": 12, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$", - "type": "string" - } - }, - "propertyTransform": { - "/properties/Principal": "$join([\"^arn:aws[a-zA-Z-]*:iam::\",Principal,\":[a-zA-Z-]*\"]) $OR Principal" - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FunctionName", - "Action", - "Principal" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::Permission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FunctionName", + "/properties/FunctionUrlAuthType", + "/properties/SourceAccount", + "/properties/SourceArn", + "/properties/Principal", + "/properties/PrincipalOrgID", + "/properties/Action", + "/properties/EventSourceToken" + ], + "description": "The ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.\n To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.\n If your function has a function URL, you can specify the ``FunctionUrlAuthType`` parameter. This adds a condition to your permission that only applies when your function URL's ``AuthType`` matches the specified ``FunctionUrlAuthType``. For more information about the ``AuthType`` parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\n This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).", + "handlers": { + "create": { + "permissions": [ + "lambda:AddPermission" + ] + }, + "delete": { + "permissions": [ + "lambda:RemovePermission" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FunctionName": { + "description": "The name of the Lambda function, version, or alias.", + "maxLength": 140, + "minLength": 1, + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "FunctionName" + ] + }, + "permissions": [ + "lambda:GetPolicy" + ] + }, + "read": { + "permissions": [ + "lambda:GetPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionName", + "/properties/Id" + ], + "properties": { + "Action": { + "description": "The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(lambda:[*]|lambda:[a-zA-Z]+|[*])$", + "type": "string" + }, + "EventSourceToken": { + "description": "For Alexa Smart Home functions, a token that the invoker must supply.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9._\\-]+$", + "type": "string" + }, + "FunctionName": { + "description": "The name or ARN of the Lambda function, version, or alias.\n **Name formats**\n + *Function name* \u2013 ``my-function`` (name-only), ``my-function:v1`` (with alias).\n + *Function ARN* \u2013 ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.\n + *Partial ARN* \u2013 ``123456789012:function:my-function``.\n \n You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.", + "maxLength": 140, + "minLength": 1, + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + }, + "FunctionUrlAuthType": { + "description": "The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).", + "enum": [ + "AWS_IAM", + "NONE" + ], + "type": "string" + }, + "Id": { + "description": "", + "maxLength": 256, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Principal": { + "description": "The AWS-service or AWS-account that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.", + "maxLength": 256, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "PrincipalOrgID": { + "description": "The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.", + "maxLength": 34, + "minLength": 12, + "pattern": "^o-[a-z0-9]{10,32}$", + "type": "string" + }, + "SourceAccount": { + "description": "For AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.", + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d{12}$", + "type": "string" + }, + "SourceArn": { + "description": "For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.\n Note that Lambda configures the comparison using the ``StringLike`` operator.", + "maxLength": 1024, + "minLength": 12, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$", + "type": "string" + } + }, + "propertyTransform": { + "/properties/Principal": "$join([\"^arn:aws[a-zA-Z-]*:iam::\",Principal,\":[a-zA-Z-]*\"]) $OR Principal" + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FunctionName", + "Action", + "Principal" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Lambda::Permission" +} diff --git a/schema/aws-lambda-url.json b/schema/aws-lambda-url.json index c04c1e4..ecb7808 100644 --- a/schema/aws-lambda-url.json +++ b/schema/aws-lambda-url.json @@ -1,191 +1,191 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetFunctionArn", - "/properties/Qualifier" - ], - "definitions": { - "AllowHeaders": { - "insertionOrder": true, - "items": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "AllowMethods": { - "insertionOrder": true, - "items": { - "enum": [ - "GET", - "PUT", - "HEAD", - "POST", - "PATCH", - "DELETE", - "*" - ], - "type": "string" - }, - "maxItems": 6, - "minItems": 1, - "type": "array" - }, - "AllowOrigins": { - "insertionOrder": true, - "items": { - "maxLength": 253, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "Cors": { - "additionalProperties": false, - "properties": { - "AllowCredentials": { - "description": "Specifies whether credentials are included in the CORS request.", - "type": "boolean" - }, - "AllowHeaders": { - "$ref": "#/definitions/AllowHeaders", - "description": "Represents a collection of allowed headers." - }, - "AllowMethods": { - "$ref": "#/definitions/AllowMethods", - "description": "Represents a collection of allowed HTTP methods." - }, - "AllowOrigins": { - "$ref": "#/definitions/AllowOrigins", - "description": "Represents a collection of allowed origins." - }, - "ExposeHeaders": { - "$ref": "#/definitions/ExposeHeaders", - "description": "Represents a collection of exposed headers." - }, - "MaxAge": { - "maximum": 86400, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "ExposeHeaders": { - "insertionOrder": true, - "items": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "description": "Resource Type definition for AWS::Lambda::Url", - "handlers": { - "create": { - "permissions": [ - "lambda:CreateFunctionUrlConfig" - ] - }, - "delete": { - "permissions": [ - "lambda:DeleteFunctionUrlConfig" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TargetFunctionArn": { - "description": "The Amazon Resource Name (ARN) of the function associated with the Function URL.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", - "type": "string" - } - }, - "required": [ - "TargetFunctionArn" - ] - }, - "permissions": [ - "lambda:ListFunctionUrlConfigs" - ] - }, - "read": { - "permissions": [ - "lambda:GetFunctionUrlConfig" - ] - }, - "update": { - "permissions": [ - "lambda:UpdateFunctionUrlConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionArn" - ], - "properties": { - "AuthType": { - "description": "Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.", - "enum": [ - "AWS_IAM", - "NONE" - ], - "type": "string" - }, - "Cors": { - "$ref": "#/definitions/Cors" - }, - "FunctionArn": { - "description": "The full Amazon Resource Name (ARN) of the function associated with the Function URL.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", - "type": "string" - }, - "FunctionUrl": { - "description": "The generated url for this resource.", - "type": "string" - }, - "InvokeMode": { - "description": "The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.", - "enum": [ - "BUFFERED", - "RESPONSE_STREAM" - ], - "type": "string" - }, - "Qualifier": { - "description": "The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.", - "maxLength": 128, - "minLength": 1, - "pattern": "((?!^[0-9]+$)([a-zA-Z0-9-_]+))", - "type": "string" - }, - "TargetFunctionArn": { - "description": "The Amazon Resource Name (ARN) of the function associated with the Function URL.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", - "type": "string" - } - }, - "propertyTransform": { - "/properties/TargetFunctionArn": "$lookup($match(TargetFunctionArn,/(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:)?([0-9]{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?![0-9]+)[0-9a-zA-Z-_]+))?/)['groups'], 'groups')[6]" - }, - "readOnlyProperties": [ - "/properties/FunctionUrl", - "/properties/FunctionArn" - ], - "required": [ - "TargetFunctionArn", - "AuthType" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Lambda::Url" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetFunctionArn", + "/properties/Qualifier" + ], + "definitions": { + "AllowHeaders": { + "insertionOrder": true, + "items": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "AllowMethods": { + "insertionOrder": true, + "items": { + "enum": [ + "GET", + "PUT", + "HEAD", + "POST", + "PATCH", + "DELETE", + "*" + ], + "type": "string" + }, + "maxItems": 6, + "minItems": 1, + "type": "array" + }, + "AllowOrigins": { + "insertionOrder": true, + "items": { + "maxLength": 253, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "Cors": { + "additionalProperties": false, + "properties": { + "AllowCredentials": { + "description": "Specifies whether credentials are included in the CORS request.", + "type": "boolean" + }, + "AllowHeaders": { + "$ref": "#/definitions/AllowHeaders", + "description": "Represents a collection of allowed headers." + }, + "AllowMethods": { + "$ref": "#/definitions/AllowMethods", + "description": "Represents a collection of allowed HTTP methods." + }, + "AllowOrigins": { + "$ref": "#/definitions/AllowOrigins", + "description": "Represents a collection of allowed origins." + }, + "ExposeHeaders": { + "$ref": "#/definitions/ExposeHeaders", + "description": "Represents a collection of exposed headers." + }, + "MaxAge": { + "maximum": 86400, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ExposeHeaders": { + "insertionOrder": true, + "items": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "description": "Resource Type definition for AWS::Lambda::Url", + "handlers": { + "create": { + "permissions": [ + "lambda:CreateFunctionUrlConfig" + ] + }, + "delete": { + "permissions": [ + "lambda:DeleteFunctionUrlConfig" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TargetFunctionArn": { + "description": "The Amazon Resource Name (ARN) of the function associated with the Function URL.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", + "type": "string" + } + }, + "required": [ + "TargetFunctionArn" + ] + }, + "permissions": [ + "lambda:ListFunctionUrlConfigs" + ] + }, + "read": { + "permissions": [ + "lambda:GetFunctionUrlConfig" + ] + }, + "update": { + "permissions": [ + "lambda:UpdateFunctionUrlConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionArn" + ], + "properties": { + "AuthType": { + "description": "Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.", + "enum": [ + "AWS_IAM", + "NONE" + ], + "type": "string" + }, + "Cors": { + "$ref": "#/definitions/Cors" + }, + "FunctionArn": { + "description": "The full Amazon Resource Name (ARN) of the function associated with the Function URL.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", + "type": "string" + }, + "FunctionUrl": { + "description": "The generated url for this resource.", + "type": "string" + }, + "InvokeMode": { + "description": "The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.", + "enum": [ + "BUFFERED", + "RESPONSE_STREAM" + ], + "type": "string" + }, + "Qualifier": { + "description": "The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.", + "maxLength": 128, + "minLength": 1, + "pattern": "((?!^[0-9]+$)([a-zA-Z0-9-_]+))", + "type": "string" + }, + "TargetFunctionArn": { + "description": "The Amazon Resource Name (ARN) of the function associated with the Function URL.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\\d+)[0-9a-zA-Z-_]+))?$", + "type": "string" + } + }, + "propertyTransform": { + "/properties/TargetFunctionArn": "$lookup($match(TargetFunctionArn,/(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:)?([0-9]{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?![0-9]+)[0-9a-zA-Z-_]+))?/)['groups'], 'groups')[6]" + }, + "readOnlyProperties": [ + "/properties/FunctionUrl", + "/properties/FunctionArn" + ], + "required": [ + "TargetFunctionArn", + "AuthType" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Lambda::Url" +} diff --git a/schema/aws-lambda-version.json b/schema/aws-lambda-version.json index b7f0a28..bdfed00 100644 --- a/schema/aws-lambda-version.json +++ b/schema/aws-lambda-version.json @@ -1,167 +1,167 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FunctionName", - "/properties/Description", - "/properties/CodeSha256", - "/properties/ProvisionedConcurrencyConfig", - "/properties/RuntimePolicy" - ], - "definitions": { - "ProvisionedConcurrencyConfiguration": { - "additionalProperties": false, - "description": "A provisioned concurrency configuration for a function's version.", - "properties": { - "ProvisionedConcurrentExecutions": { - "description": "The amount of provisioned concurrency to allocate for the version.", - "type": "integer" - } - }, - "required": [ - "ProvisionedConcurrentExecutions" - ], - "type": "object" - }, - "RuntimePolicy": { - "additionalProperties": false, - "description": "Runtime Management Config of a function.", - "properties": { - "RuntimeVersionArn": { - "description": "The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.", - "maxLength": 2048, - "minLength": 26, - "pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}::runtime:.+$", - "type": "string" - }, - "UpdateRuntimeOn": { - "description": "The runtime update mode.", - "type": "string" - } - }, - "required": [ - "UpdateRuntimeOn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lambda::Version", - "handlers": { - "create": { - "permissions": [ - "lambda:PublishVersion", - "lambda:GetFunctionConfiguration", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:PutRuntimeManagementConfig", - "lambda:GetRuntimeManagementConfig" - ], - "timeoutInMinutes": 180 - }, - "delete": { - "permissions": [ - "lambda:GetFunctionConfiguration", - "lambda:DeleteFunction" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FunctionName": { - "description": "The name of the Lambda function, version, or alias.", - "maxLength": 140, - "minLength": 1, - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "FunctionName" - ] - }, - "permissions": [ - "lambda:ListVersionsByFunction" - ] - }, - "read": { - "permissions": [ - "lambda:GetFunctionConfiguration", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:GetRuntimeManagementConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/FunctionArn" - ], - "properties": { - "CodeSha256": { - "description": "Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.", - "type": "string" - }, - "Description": { - "description": "A description for the version to override the description in the function configuration. Updates are not supported for this property.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "FunctionArn": { - "description": "The ARN of the version.", - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - }, - "FunctionName": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/FunctionName", - "typeName": "AWS::Lambda::Function" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Lambda::Function" - } - } - ], - "description": "The name of the Lambda function.", - "maxLength": 140, - "minLength": 1, - "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - }, - "Policy": { - "description": "The resource policy of your function", - "type": "object" - }, - "ProvisionedConcurrencyConfig": { - "$ref": "#/definitions/ProvisionedConcurrencyConfiguration", - "description": "Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property." - }, - "RuntimePolicy": { - "$ref": "#/definitions/RuntimePolicy", - "description": "Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual." - }, - "Version": { - "description": "The version number.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/FunctionName": "$split(FunctionName, \":\")[-1] $OR FunctionName" - }, - "readOnlyProperties": [ - "/properties/Version", - "/properties/FunctionArn" - ], - "required": [ - "FunctionName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::Version" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FunctionName", + "/properties/Description", + "/properties/CodeSha256", + "/properties/ProvisionedConcurrencyConfig", + "/properties/RuntimePolicy" + ], + "definitions": { + "ProvisionedConcurrencyConfiguration": { + "additionalProperties": false, + "description": "A provisioned concurrency configuration for a function's version.", + "properties": { + "ProvisionedConcurrentExecutions": { + "description": "The amount of provisioned concurrency to allocate for the version.", + "type": "integer" + } + }, + "required": [ + "ProvisionedConcurrentExecutions" + ], + "type": "object" + }, + "RuntimePolicy": { + "additionalProperties": false, + "description": "Runtime Management Config of a function.", + "properties": { + "RuntimeVersionArn": { + "description": "The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.", + "maxLength": 2048, + "minLength": 26, + "pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}::runtime:.+$", + "type": "string" + }, + "UpdateRuntimeOn": { + "description": "The runtime update mode.", + "type": "string" + } + }, + "required": [ + "UpdateRuntimeOn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lambda::Version", + "handlers": { + "create": { + "permissions": [ + "lambda:PublishVersion", + "lambda:GetFunctionConfiguration", + "lambda:PutProvisionedConcurrencyConfig", + "lambda:GetProvisionedConcurrencyConfig", + "lambda:PutRuntimeManagementConfig", + "lambda:GetRuntimeManagementConfig" + ], + "timeoutInMinutes": 180 + }, + "delete": { + "permissions": [ + "lambda:GetFunctionConfiguration", + "lambda:DeleteFunction" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FunctionName": { + "description": "The name of the Lambda function, version, or alias.", + "maxLength": 140, + "minLength": 1, + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "FunctionName" + ] + }, + "permissions": [ + "lambda:ListVersionsByFunction" + ] + }, + "read": { + "permissions": [ + "lambda:GetFunctionConfiguration", + "lambda:GetProvisionedConcurrencyConfig", + "lambda:GetRuntimeManagementConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/FunctionArn" + ], + "properties": { + "CodeSha256": { + "description": "Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.", + "type": "string" + }, + "Description": { + "description": "A description for the version to override the description in the function configuration. Updates are not supported for this property.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "FunctionArn": { + "description": "The ARN of the version.", + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + }, + "FunctionName": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/FunctionName", + "typeName": "AWS::Lambda::Function" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Lambda::Function" + } + } + ], + "description": "The name of the Lambda function.", + "maxLength": 140, + "minLength": 1, + "pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + }, + "Policy": { + "description": "The resource policy of your function", + "type": "object" + }, + "ProvisionedConcurrencyConfig": { + "$ref": "#/definitions/ProvisionedConcurrencyConfiguration", + "description": "Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property." + }, + "RuntimePolicy": { + "$ref": "#/definitions/RuntimePolicy", + "description": "Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual." + }, + "Version": { + "description": "The version number.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/FunctionName": "$split(FunctionName, \":\")[-1] $OR FunctionName" + }, + "readOnlyProperties": [ + "/properties/Version", + "/properties/FunctionArn" + ], + "required": [ + "FunctionName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Lambda::Version" +} diff --git a/schema/aws-launchwizard-deployment.json b/schema/aws-launchwizard-deployment.json index a5ec5f8..1619263 100644 --- a/schema/aws-launchwizard-deployment.json +++ b/schema/aws-launchwizard-deployment.json @@ -1,249 +1,249 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeploymentPatternName", - "/properties/Name", - "/properties/WorkloadName" - ], - "definitions": { - "DeploymentSpecifications": { - "additionalProperties": false, - "maxProperties": 100, - "minProperties": 1, - "patternProperties": { - "^[a-zA-Z0-9-:]{3,256}$": { - "maxLength": 1500, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DeploymentStatus": { - "enum": [ - "COMPLETED", - "CREATING", - "DELETE_IN_PROGRESS", - "DELETE_INITIATING", - "DELETE_FAILED", - "DELETED", - "FAILED", - "IN_PROGRESS", - "VALIDATING" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Definition of AWS::LaunchWizard::Deployment Resource Type", - "handlers": { - "create": { - "permissions": [ - "launchwizard:CreateDeployment", - "launchwizard:GetDeployment", - "launchwizard:ListDeploymentEvents", - "launchwizard:ListTagsForResource", - "launchwizard:TagResource", - "ssm:GetParameter", - "ssm:PutParameter", - "ssm:DescribeParameters", - "ssm:AddTagsToResource", - "ssm:DeleteParameter", - "secretsmanager:DescribeSecret", - "secretsmanager:PutSecretValue", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource", - "secretsmanager:UpdateSecret", - "resource-groups:CreateGroup", - "resource-groups:DeleteGroup", - "cloudformation:DeleteStack", - "cloudformation:DescribeStackResources", - "cloudformation:DescribeStackResource", - "cloudformation:DescribeStacks", - "cloudformation:DescribeStackEvents", - "cloudformation:CreateStack", - "cloudformation:TagResource", - "s3:PutObject", - "s3:GetObject", - "s3:CreateBucket", - "sns:ListSubscriptionsByTopic", - "sns:Publish", - "sns:ListSubscriptions", - "sns:ListTopics", - "sns:CreateTopic", - "sns:Subscribe", - "sns:Unsubscribe", - "sqs:TagQueue", - "sqs:GetQueueUrl", - "sqs:AddPermission", - "sqs:ListQueues", - "sqs:GetQueueAttributes", - "sqs:ListQueueTags", - "sqs:CreateQueue", - "sqs:SetQueueAttributes" - ], - "timeoutInMinutes": 370 - }, - "delete": { - "permissions": [ - "launchwizard:GetDeployment", - "launchwizard:DeleteDeployment", - "launchwizard:UntagResource", - "ssm:DeleteParameter", - "secretsmanager:DeleteSecret", - "resource-groups:DeleteGroup", - "cloudformation:DeleteStack", - "cloudformation:DescribeStacks", - "ssm:GetParameter", - "sns:ListSubscriptionsByTopic", - "sns:Publish", - "sns:ListSubscriptions", - "sns:ListTopics", - "sns:CreateTopic", - "sns:DeleteTopic", - "sns:Subscribe", - "sns:Unsubscribe", - "sqs:GetQueueUrl", - "sqs:ListQueues", - "sqs:DeleteQueue", - "sqs:GetQueueAttributes", - "sqs:ListQueueTags" - ] - }, - "list": { - "permissions": [ - "launchwizard:ListDeployments", - "launchwizard:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "launchwizard:GetDeployment", - "launchwizard:ListDeploymentEvents", - "launchwizard:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "launchwizard:GetDeployment", - "launchwizard:ListTagsForResource", - "launchwizard:TagResource", - "launchwizard:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "ARN of the LaunchWizard deployment", - "pattern": "^arn:aws(-cn|-us-gov)?:launchwizard:[a-z0-9-]+:[0-9]{12}:deployment/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$", - "type": "string" - }, - "CreatedAt": { - "description": "Timestamp of LaunchWizard deployment creation", - "format": "date-time", - "type": "string" - }, - "DeletedAt": { - "description": "Timestamp of LaunchWizard deployment deletion", - "format": "date-time", - "type": "string" - }, - "DeploymentId": { - "description": "Deployment ID of the LaunchWizard deployment", - "maxLength": 128, - "minLength": 2, - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "DeploymentPatternName": { - "description": "Workload deployment pattern name", - "maxLength": 256, - "minLength": 1, - "pattern": "^[A-Za-z0-9][a-zA-Z0-9-]*$", - "type": "string" - }, - "Name": { - "description": "Name of LaunchWizard deployment", - "maxLength": 50, - "minLength": 1, - "pattern": "^[A-Za-z0-9_\\s\\.-]+$", - "type": "string" - }, - "ResourceGroup": { - "description": "Resource Group Name created for LaunchWizard deployment", - "type": "string" - }, - "Specifications": { - "$ref": "#/definitions/DeploymentSpecifications", - "description": "LaunchWizard deployment specifications" - }, - "Status": { - "$ref": "#/definitions/DeploymentStatus", - "description": "Status of LaunchWizard deployment" - }, - "Tags": { - "description": "Tags for LaunchWizard deployment", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array" - }, - "WorkloadName": { - "description": "Workload Name for LaunchWizard deployment", - "maxLength": 100, - "minLength": 1, - "pattern": "^[A-Za-z][a-zA-Z0-9-_]*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/DeletedAt", - "/properties/DeploymentId", - "/properties/ResourceGroup", - "/properties/Status" - ], - "required": [ - "DeploymentPatternName", - "Name", - "Specifications", - "WorkloadName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::LaunchWizard::Deployment", - "writeOnlyProperties": [ - "/properties/Specifications" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeploymentPatternName", + "/properties/Name", + "/properties/WorkloadName" + ], + "definitions": { + "DeploymentSpecifications": { + "additionalProperties": false, + "maxProperties": 100, + "minProperties": 1, + "patternProperties": { + "^[a-zA-Z0-9-:]{3,256}$": { + "maxLength": 1500, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DeploymentStatus": { + "enum": [ + "COMPLETED", + "CREATING", + "DELETE_IN_PROGRESS", + "DELETE_INITIATING", + "DELETE_FAILED", + "DELETED", + "FAILED", + "IN_PROGRESS", + "VALIDATING" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Definition of AWS::LaunchWizard::Deployment Resource Type", + "handlers": { + "create": { + "permissions": [ + "launchwizard:CreateDeployment", + "launchwizard:GetDeployment", + "launchwizard:ListDeploymentEvents", + "launchwizard:ListTagsForResource", + "launchwizard:TagResource", + "ssm:GetParameter", + "ssm:PutParameter", + "ssm:DescribeParameters", + "ssm:AddTagsToResource", + "ssm:DeleteParameter", + "secretsmanager:DescribeSecret", + "secretsmanager:PutSecretValue", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:UpdateSecret", + "resource-groups:CreateGroup", + "resource-groups:DeleteGroup", + "cloudformation:DeleteStack", + "cloudformation:DescribeStackResources", + "cloudformation:DescribeStackResource", + "cloudformation:DescribeStacks", + "cloudformation:DescribeStackEvents", + "cloudformation:CreateStack", + "cloudformation:TagResource", + "s3:PutObject", + "s3:GetObject", + "s3:CreateBucket", + "sns:ListSubscriptionsByTopic", + "sns:Publish", + "sns:ListSubscriptions", + "sns:ListTopics", + "sns:CreateTopic", + "sns:Subscribe", + "sns:Unsubscribe", + "sqs:TagQueue", + "sqs:GetQueueUrl", + "sqs:AddPermission", + "sqs:ListQueues", + "sqs:GetQueueAttributes", + "sqs:ListQueueTags", + "sqs:CreateQueue", + "sqs:SetQueueAttributes" + ], + "timeoutInMinutes": 370 + }, + "delete": { + "permissions": [ + "launchwizard:GetDeployment", + "launchwizard:DeleteDeployment", + "launchwizard:UntagResource", + "ssm:DeleteParameter", + "secretsmanager:DeleteSecret", + "resource-groups:DeleteGroup", + "cloudformation:DeleteStack", + "cloudformation:DescribeStacks", + "ssm:GetParameter", + "sns:ListSubscriptionsByTopic", + "sns:Publish", + "sns:ListSubscriptions", + "sns:ListTopics", + "sns:CreateTopic", + "sns:DeleteTopic", + "sns:Subscribe", + "sns:Unsubscribe", + "sqs:GetQueueUrl", + "sqs:ListQueues", + "sqs:DeleteQueue", + "sqs:GetQueueAttributes", + "sqs:ListQueueTags" + ] + }, + "list": { + "permissions": [ + "launchwizard:ListDeployments", + "launchwizard:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "launchwizard:GetDeployment", + "launchwizard:ListDeploymentEvents", + "launchwizard:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "launchwizard:GetDeployment", + "launchwizard:ListTagsForResource", + "launchwizard:TagResource", + "launchwizard:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "ARN of the LaunchWizard deployment", + "pattern": "^arn:aws(-cn|-us-gov)?:launchwizard:[a-z0-9-]+:[0-9]{12}:deployment/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$", + "type": "string" + }, + "CreatedAt": { + "description": "Timestamp of LaunchWizard deployment creation", + "format": "date-time", + "type": "string" + }, + "DeletedAt": { + "description": "Timestamp of LaunchWizard deployment deletion", + "format": "date-time", + "type": "string" + }, + "DeploymentId": { + "description": "Deployment ID of the LaunchWizard deployment", + "maxLength": 128, + "minLength": 2, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "DeploymentPatternName": { + "description": "Workload deployment pattern name", + "maxLength": 256, + "minLength": 1, + "pattern": "^[A-Za-z0-9][a-zA-Z0-9-]*$", + "type": "string" + }, + "Name": { + "description": "Name of LaunchWizard deployment", + "maxLength": 50, + "minLength": 1, + "pattern": "^[A-Za-z0-9_\\s\\.-]+$", + "type": "string" + }, + "ResourceGroup": { + "description": "Resource Group Name created for LaunchWizard deployment", + "type": "string" + }, + "Specifications": { + "$ref": "#/definitions/DeploymentSpecifications", + "description": "LaunchWizard deployment specifications" + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Status of LaunchWizard deployment" + }, + "Tags": { + "description": "Tags for LaunchWizard deployment", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + }, + "WorkloadName": { + "description": "Workload Name for LaunchWizard deployment", + "maxLength": 100, + "minLength": 1, + "pattern": "^[A-Za-z][a-zA-Z0-9-_]*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/DeletedAt", + "/properties/DeploymentId", + "/properties/ResourceGroup", + "/properties/Status" + ], + "required": [ + "DeploymentPatternName", + "Name", + "Specifications", + "WorkloadName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::LaunchWizard::Deployment", + "writeOnlyProperties": [ + "/properties/Specifications" + ] +} diff --git a/schema/aws-lex-bot.json b/schema/aws-lex-bot.json index e3f78c7..ef06e9e 100644 --- a/schema/aws-lex-bot.json +++ b/schema/aws-lex-bot.json @@ -1,2339 +1,2339 @@ -{ - "additionalProperties": false, - "definitions": { - "AdvancedRecognitionSetting": { - "additionalProperties": false, - "description": "Provides settings that enable advanced recognition settings for slot values.", - "properties": { - "AudioRecognitionStrategy": { - "$ref": "#/definitions/AudioRecognitionStrategy" - } - }, - "type": "object" - }, - "AllowedInputTypes": { - "additionalProperties": false, - "description": "Specifies the allowed input types.", - "properties": { - "AllowAudioInput": { - "description": "Indicates whether audio input is allowed.", - "type": "boolean" - }, - "AllowDTMFInput": { - "description": "Indicates whether DTMF input is allowed.", - "type": "boolean" - } - }, - "required": [ - "AllowAudioInput", - "AllowDTMFInput" - ], - "type": "object" - }, - "AttachmentTitle": { - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "AttachmentUrl": { - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "AudioAndDTMFInputSpecification": { - "additionalProperties": false, - "description": "Specifies the audio and DTMF input specification.", - "properties": { - "AudioSpecification": { - "$ref": "#/definitions/AudioSpecification" - }, - "DTMFSpecification": { - "$ref": "#/definitions/DTMFSpecification" - }, - "StartTimeoutMs": { - "description": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "StartTimeoutMs" - ], - "type": "object" - }, - "AudioLogDestination": { - "additionalProperties": false, - "description": "The location of audio log files collected when conversation logging is enabled for a bot.", - "properties": { - "S3Bucket": { - "$ref": "#/definitions/S3BucketLogDestination" - } - }, - "required": [ - "S3Bucket" - ], - "type": "object" - }, - "AudioLogSetting": { - "additionalProperties": false, - "description": "Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.", - "properties": { - "Destination": { - "$ref": "#/definitions/AudioLogDestination" - }, - "Enabled": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "Destination", - "Enabled" - ], - "type": "object" - }, - "AudioLogSettings": { - "description": "List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AudioLogSetting" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "AudioRecognitionStrategy": { - "description": "Enables using slot values as a custom vocabulary when recognizing user utterances.", - "enum": [ - "UseSlotValuesAsCustomVocabulary" - ], - "type": "string" - }, - "AudioSpecification": { - "additionalProperties": false, - "description": "Specifies the audio input specifications.", - "properties": { - "EndTimeoutMs": { - "description": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished.", - "minimum": 1, - "type": "integer" - }, - "MaxLengthMs": { - "description": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "EndTimeoutMs", - "MaxLengthMs" - ], - "type": "object" - }, - "BotAliasLocaleSettings": { - "additionalProperties": false, - "description": "You can use this parameter to specify a specific Lambda function to run different functions in different locales.", - "properties": { - "CodeHookSpecification": { - "$ref": "#/definitions/CodeHookSpecification" - }, - "Enabled": { - "description": "Whether the Lambda code hook is enabled", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "BotAliasLocaleSettingsItem": { - "additionalProperties": false, - "description": "A locale setting in alias", - "properties": { - "BotAliasLocaleSetting": { - "$ref": "#/definitions/BotAliasLocaleSettings" - }, - "LocaleId": { - "description": "A string used to identify the locale", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "LocaleId", - "BotAliasLocaleSetting" - ], - "type": "object" - }, - "BotAliasLocaleSettingsList": { - "description": "A list of bot alias locale settings to add to the bot alias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BotAliasLocaleSettingsItem" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "BotArn": { - "maxLength": 1011, - "minLength": 1, - "pattern": "^arn:aws[a-zA-Z-]*:lex:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:bot/[0-9a-zA-Z]+$", - "type": "string" - }, - "BotLocale": { - "additionalProperties": false, - "description": "A locale in the bot, which contains the intents and slot types that the bot uses in conversations with users in the specified language and locale.", - "properties": { - "CustomVocabulary": { - "$ref": "#/definitions/CustomVocabulary" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "Intents": { - "description": "List of intents", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Intent" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "LocaleId": { - "$ref": "#/definitions/LocaleId" - }, - "NluConfidenceThreshold": { - "$ref": "#/definitions/ConfidenceThreshold" - }, - "SlotTypes": { - "description": "List of SlotTypes", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SlotType" - }, - "maxItems": 250, - "type": "array", - "uniqueItems": true - }, - "VoiceSettings": { - "$ref": "#/definitions/VoiceSettings" - } - }, - "required": [ - "LocaleId", - "NluConfidenceThreshold" - ], - "type": "object" - }, - "Button": { - "additionalProperties": false, - "description": "A button to use on a response card used to gather slot values from a user.", - "properties": { - "Text": { - "description": "The text that appears on the button.", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value returned to Amazon Lex when the user chooses this button.", - "maxLength": 50, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Text", - "Value" - ], - "type": "object" - }, - "CloudWatchLogGroupLogDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchLogGroupArn": { - "description": "A string used to identify the groupArn for the Cloudwatch Log Group", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "LogPrefix": { - "description": "A string containing the value for the Log Prefix", - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "CloudWatchLogGroupArn", - "LogPrefix" - ], - "type": "object" - }, - "CodeHookSpecification": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "LambdaCodeHook": { - "$ref": "#/definitions/LambdaCodeHook" - } - }, - "required": [ - "LambdaCodeHook" - ], - "type": "object" - }, - "Condition": { - "additionalProperties": false, - "description": "Provides an expression that evaluates to true or false.", - "properties": { - "ExpressionString": { - "$ref": "#/definitions/ConditionExpression", - "description": "The expression string that is evaluated." - } - }, - "required": [ - "ExpressionString" - ], - "type": "object" - }, - "ConditionExpression": { - "description": "Expression that is evaluated to true or false at runtime.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Conditional": { - "additionalProperties": false, - "description": "Contains conditional branches to fork the conversation flow.", - "properties": { - "ConditionalBranches": { - "$ref": "#/definitions/ConditionalBranches" - }, - "IsActive": { - "type": "boolean" - } - }, - "required": [ - "IsActive", - "ConditionalBranches" - ], - "type": "object" - }, - "ConditionalBranch": { - "additionalProperties": false, - "description": "A set of actions that Amazon Lex should run if the condition is matched.", - "properties": { - "Condition": { - "$ref": "#/definitions/Condition", - "description": "Contains the expression to evaluate. If the condition is true, the branch's actions are taken." - }, - "Name": { - "$ref": "#/definitions/Name", - "description": "The name of the branch." - }, - "NextStep": { - "$ref": "#/definitions/DialogState", - "description": "The next step in the conversation." - }, - "Response": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - } - }, - "required": [ - "Name", - "Condition", - "NextStep" - ], - "type": "object" - }, - "ConditionalBranches": { - "description": "A list of 1 to 4 conditional branches to fork the conversation flow.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ConditionalBranch" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "ConditionalSpecification": { - "additionalProperties": false, - "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.", - "properties": { - "ConditionalBranches": { - "$ref": "#/definitions/ConditionalBranches", - "description": "A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true." - }, - "DefaultBranch": { - "$ref": "#/definitions/DefaultConditionalBranch", - "description": "The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step." - }, - "IsActive": { - "description": "Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.", - "type": "boolean" - } - }, - "required": [ - "IsActive", - "ConditionalBranches", - "DefaultBranch" - ], - "type": "object" - }, - "ConfidenceThreshold": { - "description": "The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "ContextTimeToLiveInSeconds": { - "description": "The amount of time, in seconds, that the output context should remain active.", - "maximum": 86400, - "minimum": 5, - "type": "integer" - }, - "ContextTurnsToLive": { - "description": "The number of conversation turns that the output context should remain active.", - "maximum": 20, - "minimum": 1, - "type": "integer" - }, - "ConversationLogSettings": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "AudioLogSettings": { - "$ref": "#/definitions/AudioLogSettings" - }, - "TextLogSettings": { - "$ref": "#/definitions/TextLogSettings" - } - }, - "type": "object" - }, - "CustomPayload": { - "additionalProperties": false, - "description": "A message in a custom format defined by the client application.", - "properties": { - "Value": { - "description": "The string that is sent to your application.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "CustomVocabulary": { - "additionalProperties": false, - "description": "A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input.", - "properties": { - "CustomVocabularyItems": { - "$ref": "#/definitions/CustomVocabularyItems" - } - }, - "required": [ - "CustomVocabularyItems" - ], - "type": "object" - }, - "CustomVocabularyItem": { - "additionalProperties": false, - "description": "A custom vocabulary item that contains the phrase to recognize and a weight to give the boost.", - "properties": { - "DisplayAs": { - "description": "Defines how you want your phrase to look in your transcription output.", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Phrase": { - "description": "Phrase that should be recognized.", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Weight": { - "description": "The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field.", - "maximum": 3, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Phrase" - ], - "type": "object" - }, - "CustomVocabularyItems": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomVocabularyItem" - }, - "maxItems": 500, - "type": "array", - "uniqueItems": true - }, - "DTMFSpecification": { - "additionalProperties": false, - "description": "Specifies the settings on DTMF input.", - "properties": { - "DeletionCharacter": { - "description": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input.", - "pattern": "^[A-D0-9#*]{1}$", - "type": "string" - }, - "EndCharacter": { - "description": "The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.", - "pattern": "^[A-D0-9#*]{1}$", - "type": "string" - }, - "EndTimeoutMs": { - "description": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded.", - "minimum": 1, - "type": "integer" - }, - "MaxLength": { - "description": "The maximum number of DTMF digits allowed in an utterance.", - "maximum": 1024, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "DeletionCharacter", - "EndCharacter", - "EndTimeoutMs", - "MaxLength" - ], - "type": "object" - }, - "DataPrivacy": { - "additionalProperties": false, - "description": "Provides information on additional privacy protections Amazon Lex should use with the bot's data.", - "properties": { - "ChildDirected": { - "description": "Specify whether your use of Amazon Lex is related to application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA).", - "type": "boolean" - } - }, - "required": [ - "ChildDirected" - ], - "type": "object" - }, - "DefaultConditionalBranch": { - "additionalProperties": false, - "description": "A set of actions that Amazon Lex should run if none of the other conditions are met.", - "properties": { - "NextStep": { - "$ref": "#/definitions/DialogState", - "description": "The next step in the conversation." - }, - "Response": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - } - }, - "type": "object" - }, - "Description": { - "description": "A description of the resource", - "maxLength": 200, - "type": "string" - }, - "DialogAction": { - "additionalProperties": false, - "description": "Defines the action that the bot executes at runtime when the conversation reaches this step.", - "properties": { - "SlotToElicit": { - "$ref": "#/definitions/Name", - "description": "If the dialog action is ElicitSlot, defines the slot to elicit from the user." - }, - "SuppressNextMessage": { - "description": "When true the next message for the intent is not used.", - "type": "boolean" - }, - "Type": { - "$ref": "#/definitions/DialogActionType", - "description": "The action that the bot should execute." - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "DialogActionType": { - "description": "The possible values of actions that the conversation can take.", - "enum": [ - "CloseIntent", - "ConfirmIntent", - "ElicitIntent", - "ElicitSlot", - "StartIntent", - "FulfillIntent", - "EndConversation", - "EvaluateConditional", - "InvokeDialogCodeHook" - ], - "type": "string" - }, - "DialogCodeHookInvocationSetting": { - "additionalProperties": false, - "description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.", - "properties": { - "EnableCodeHookInvocation": { - "description": "Indicates whether a Lambda function should be invoked for the dialog.", - "type": "boolean" - }, - "InvocationLabel": { - "$ref": "#/definitions/Name", - "description": "A label that indicates the dialog step from which the dialog code hook is happening." - }, - "IsActive": { - "description": "Determines whether a dialog code hook is used when the intent is activated.", - "type": "boolean" - }, - "PostCodeHookSpecification": { - "$ref": "#/definitions/PostDialogCodeHookInvocationSpecification", - "description": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete." - } - }, - "required": [ - "IsActive", - "EnableCodeHookInvocation", - "PostCodeHookSpecification" - ], - "type": "object" - }, - "DialogCodeHookSetting": { - "additionalProperties": false, - "description": "Settings that determine the Lambda function that Amazon Lex uses for processing user responses.", - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "DialogState": { - "additionalProperties": false, - "description": "The current state of the conversation with the user.", - "properties": { - "DialogAction": { - "$ref": "#/definitions/DialogAction", - "description": "Defines the action that the bot executes at runtime when the conversation reaches this step." - }, - "Intent": { - "$ref": "#/definitions/IntentOverride", - "description": "Override settings to configure the intent state." - }, - "SessionAttributes": { - "description": "List of session attributes to be applied when the conversation reaches this step.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SessionAttribute" - }, - "type": "array" - } - }, - "type": "object" - }, - "ElicitationCodeHookInvocationSetting": { - "additionalProperties": false, - "description": "Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.", - "properties": { - "EnableCodeHookInvocation": { - "description": "Indicates whether a Lambda function should be invoked for the dialog.", - "type": "boolean" - }, - "InvocationLabel": { - "$ref": "#/definitions/Name", - "description": "A label that indicates the dialog step from which the dialog code hook is happening." - } - }, - "required": [ - "EnableCodeHookInvocation" - ], - "type": "object" - }, - "ExternalSourceSetting": { - "additionalProperties": false, - "description": "Provides information about the external source of the slot type's definition.", - "properties": { - "GrammarSlotTypeSetting": { - "$ref": "#/definitions/GrammarSlotTypeSetting" - } - }, - "type": "object" - }, - "FulfillmentCodeHookSetting": { - "additionalProperties": false, - "description": "Settings that determine if a Lambda function should be invoked to fulfill a specific intent.", - "properties": { - "Enabled": { - "type": "boolean" - }, - "FulfillmentUpdatesSpecification": { - "$ref": "#/definitions/FulfillmentUpdatesSpecification" - }, - "IsActive": { - "description": "Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.", - "type": "boolean" - }, - "PostFulfillmentStatusSpecification": { - "$ref": "#/definitions/PostFulfillmentStatusSpecification" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "FulfillmentStartResponseSpecification": { - "additionalProperties": false, - "description": "Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.", - "properties": { - "AllowInterrupt": { - "description": "Determines whether the user can interrupt the start message while it is playing.", - "type": "boolean" - }, - "DelayInSeconds": { - "description": "The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.", - "maximum": 900, - "minimum": 1, - "type": "integer" - }, - "MessageGroups": { - "$ref": "#/definitions/MessageGroupsList" - } - }, - "required": [ - "DelayInSeconds", - "MessageGroups" - ], - "type": "object" - }, - "FulfillmentUpdateResponseSpecification": { - "additionalProperties": false, - "description": "Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.", - "properties": { - "AllowInterrupt": { - "description": "Determines whether the user can interrupt an update message while it is playing.", - "type": "boolean" - }, - "FrequencyInSeconds": { - "description": "The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.", - "maximum": 900, - "minimum": 1, - "type": "integer" - }, - "MessageGroups": { - "$ref": "#/definitions/MessageGroupsList" - } - }, - "required": [ - "FrequencyInSeconds", - "MessageGroups" - ], - "type": "object" - }, - "FulfillmentUpdatesSpecification": { - "additionalProperties": false, - "description": "Provides information for updating the user on the progress of fulfilling an intent.", - "properties": { - "Active": { - "description": "Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.", - "type": "boolean" - }, - "StartResponse": { - "$ref": "#/definitions/FulfillmentStartResponseSpecification" - }, - "TimeoutInSeconds": { - "description": "The length of time that the fulfillment Lambda function should run before it times out.", - "maximum": 900, - "minimum": 1, - "type": "integer" - }, - "UpdateResponse": { - "$ref": "#/definitions/FulfillmentUpdateResponseSpecification" - } - }, - "required": [ - "Active" - ], - "type": "object" - }, - "GrammarSlotTypeSetting": { - "additionalProperties": false, - "description": "Settings required for a slot type based on a grammar that you provide.", - "properties": { - "Source": { - "$ref": "#/definitions/GrammarSlotTypeSource" - } - }, - "type": "object" - }, - "GrammarSlotTypeSource": { - "additionalProperties": false, - "description": "Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.", - "properties": { - "KmsKeyArn": { - "description": "The Amazon KMS key required to decrypt the contents of the grammar, if any.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", - "type": "string" - }, - "S3BucketName": { - "$ref": "#/definitions/S3BucketName", - "description": "The name of the S3 bucket that contains the grammar source." - }, - "S3ObjectKey": { - "$ref": "#/definitions/S3ObjectKey", - "description": "The path to the grammar in the S3 bucket." - } - }, - "required": [ - "S3BucketName", - "S3ObjectKey" - ], - "type": "object" - }, - "Id": { - "description": "Unique ID of resource", - "maxLength": 10, - "minLength": 10, - "pattern": "^[0-9a-zA-Z]+$", - "type": "string" - }, - "IdleSessionTTLInSeconds": { - "description": "The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.", - "maximum": 86400, - "minimum": 60, - "type": "integer" - }, - "ImageResponseCard": { - "additionalProperties": false, - "description": "A message that defines a response card that the client application can show to the user.", - "properties": { - "Buttons": { - "description": "A list of buttons that should be displayed on the response card.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Button" - }, - "maxItems": 5, - "type": "array" - }, - "ImageUrl": { - "$ref": "#/definitions/AttachmentUrl", - "description": "The URL of an image to display on the response card." - }, - "Subtitle": { - "$ref": "#/definitions/AttachmentTitle", - "description": "The subtitle to display on the response card." - }, - "Title": { - "$ref": "#/definitions/AttachmentTitle", - "description": "The title to display on the response card." - } - }, - "required": [ - "Title" - ], - "type": "object" - }, - "InitialResponseSetting": { - "additionalProperties": false, - "description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.", - "properties": { - "CodeHook": { - "$ref": "#/definitions/DialogCodeHookInvocationSetting", - "description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation." - }, - "Conditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." - }, - "InitialResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "NextStep": { - "$ref": "#/definitions/DialogState", - "description": "The next step in the conversation." - } - }, - "type": "object" - }, - "InputContext": { - "additionalProperties": false, - "description": "InputContext specified for the intent.", - "properties": { - "Name": { - "$ref": "#/definitions/Name", - "description": "The name of the context." - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "InputContextsList": { - "description": "The list of input contexts specified for the intent.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InputContext" - }, - "maxItems": 5, - "type": "array" - }, - "Intent": { - "additionalProperties": false, - "description": "Represents an action that the user wants to perform.", - "properties": { - "Description": { - "$ref": "#/definitions/Description", - "description": "Description of thr intent." - }, - "DialogCodeHook": { - "$ref": "#/definitions/DialogCodeHookSetting" - }, - "FulfillmentCodeHook": { - "$ref": "#/definitions/FulfillmentCodeHookSetting" - }, - "InitialResponseSetting": { - "$ref": "#/definitions/InitialResponseSetting", - "description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots." - }, - "InputContexts": { - "$ref": "#/definitions/InputContextsList" - }, - "IntentClosingSetting": { - "$ref": "#/definitions/IntentClosingSetting" - }, - "IntentConfirmationSetting": { - "$ref": "#/definitions/IntentConfirmationSetting" - }, - "KendraConfiguration": { - "$ref": "#/definitions/KendraConfiguration" - }, - "Name": { - "$ref": "#/definitions/Name", - "description": "The name of the intent." - }, - "OutputContexts": { - "$ref": "#/definitions/OutputContextsList" - }, - "ParentIntentSignature": { - "$ref": "#/definitions/ParentIntentSignature" - }, - "SampleUtterances": { - "$ref": "#/definitions/SampleUtterancesList", - "description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt." - }, - "SlotPriorities": { - "$ref": "#/definitions/SlotPrioritiesList" - }, - "Slots": { - "description": "List of slots", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Slot" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "IntentClosingSetting": { - "additionalProperties": false, - "description": "Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.", - "properties": { - "ClosingResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "The response that Amazon Lex sends to the user when the intent is complete." - }, - "Conditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional." - }, - "IsActive": { - "description": "Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.", - "type": "boolean" - }, - "NextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot executes after playing the intent's closing response." - } - }, - "type": "object" - }, - "IntentConfirmationSetting": { - "additionalProperties": false, - "description": "Provides a prompt for making sure that the user is ready for the intent to be fulfilled.", - "properties": { - "CodeHook": { - "$ref": "#/definitions/DialogCodeHookInvocationSetting", - "description": "The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook." - }, - "ConfirmationConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the intent is closed." - }, - "ConfirmationNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot executes when the customer confirms the intent." - }, - "ConfirmationResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "DeclinationConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the intent is declined." - }, - "DeclinationNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot executes when the customer declines the intent." - }, - "DeclinationResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "When the user answers \"no\" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled." - }, - "ElicitationCodeHook": { - "$ref": "#/definitions/ElicitationCodeHookInvocationSetting", - "description": "The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries." - }, - "FailureConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." - }, - "FailureNextStep": { - "$ref": "#/definitions/DialogState", - "description": "The next step to take in the conversation if the confirmation step fails." - }, - "FailureResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "IsActive": { - "description": "Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.", - "type": "boolean" - }, - "PromptSpecification": { - "$ref": "#/definitions/PromptSpecification", - "description": "Prompts the user to confirm the intent. This question should have a yes or no answer." - } - }, - "required": [ - "PromptSpecification" - ], - "type": "object" - }, - "IntentOverride": { - "additionalProperties": false, - "description": "Override settings to configure the intent state.", - "properties": { - "Name": { - "$ref": "#/definitions/Name", - "description": "The name of the intent. Only required when you're switching intents." - }, - "Slots": { - "description": "A map of all of the slot value overrides for the intent.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SlotValueOverrideMap" - }, - "type": "array" - } - }, - "type": "object" - }, - "KendraConfiguration": { - "additionalProperties": false, - "description": "Configuration for searching a Amazon Kendra index specified for the intent.", - "properties": { - "KendraIndex": { - "$ref": "#/definitions/KendraIndexArn" - }, - "QueryFilterString": { - "$ref": "#/definitions/QueryFilterString" - }, - "QueryFilterStringEnabled": { - "description": "Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.", - "type": "boolean" - } - }, - "required": [ - "KendraIndex" - ], - "type": "object" - }, - "KendraIndexArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.", - "maxLength": 2048, - "minLength": 32, - "pattern": "^arn:aws[a-zA-Z-]*:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index/[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "LambdaCodeHook": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "CodeHookInterfaceVersion": { - "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.", - "maxLength": 5, - "minLength": 1, - "type": "string" - }, - "LambdaArn": { - "description": "The Amazon Resource Name (ARN) of the Lambda function.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "CodeHookInterfaceVersion", - "LambdaArn" - ], - "type": "object" - }, - "LocaleId": { - "description": "The identifier of the language and locale that the bot will be used in.", - "type": "string" - }, - "Message": { - "additionalProperties": false, - "description": "The primary message that Amazon Lex should send to the user.", - "properties": { - "CustomPayload": { - "$ref": "#/definitions/CustomPayload" - }, - "ImageResponseCard": { - "$ref": "#/definitions/ImageResponseCard" - }, - "PlainTextMessage": { - "$ref": "#/definitions/PlainTextMessage" - }, - "SSMLMessage": { - "$ref": "#/definitions/SSMLMessage" - } - }, - "required": [], - "type": "object" - }, - "MessageGroup": { - "additionalProperties": false, - "description": "One or more messages that Amazon Lex can send to the user.", - "properties": { - "Message": { - "$ref": "#/definitions/Message" - }, - "Variations": { - "description": "Message variations to send to the user.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Message" - }, - "maxItems": 2, - "type": "array" - } - }, - "required": [ - "Message" - ], - "type": "object" - }, - "MessageGroupsList": { - "description": "One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MessageGroup" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "MessageSelectionStrategy": { - "description": "Indicates how a message is selected from a message group among retries.", - "enum": [ - "Random", - "Ordered" - ], - "type": "string" - }, - "MultipleValuesSetting": { - "additionalProperties": false, - "description": "Indicates whether a slot can return multiple values.", - "properties": { - "AllowMultipleValues": { - "type": "boolean" - } - }, - "required": [], - "type": "object" - }, - "Name": { - "description": "Unique name for a resource.", - "maxLength": 100, - "minLength": 1, - "pattern": "^([0-9a-zA-Z][_-]?)+$", - "type": "string" - }, - "ObfuscationSetting": { - "additionalProperties": false, - "description": "Determines whether Amazon Lex obscures slot values in conversation logs.", - "properties": { - "ObfuscationSettingType": { - "description": "Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.", - "enum": [ - "None", - "DefaultObfuscation" - ], - "type": "string" - } - }, - "required": [ - "ObfuscationSettingType" - ], - "type": "object" - }, - "OutputContext": { - "additionalProperties": false, - "description": "A session context that is activated when an intent is fulfilled.", - "properties": { - "Name": { - "$ref": "#/definitions/Name" - }, - "TimeToLiveInSeconds": { - "$ref": "#/definitions/ContextTimeToLiveInSeconds" - }, - "TurnsToLive": { - "$ref": "#/definitions/ContextTurnsToLive" - } - }, - "required": [ - "Name", - "TimeToLiveInSeconds", - "TurnsToLive" - ], - "type": "object" - }, - "OutputContextsList": { - "description": "A list of contexts that the intent activates when it is fulfilled.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OutputContext" - }, - "maxItems": 10, - "type": "array" - }, - "ParentIntentSignature": { - "description": "A unique identifier for the built-in intent to base this intent on.", - "type": "string" - }, - "ParentSlotTypeSignature": { - "description": "The built-in slot type used as a parent of this slot type.", - "type": "string" - }, - "PlainTextMessage": { - "additionalProperties": false, - "description": "A message in plain text format.", - "properties": { - "Value": { - "description": "The message to send to the user.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "PostDialogCodeHookInvocationSpecification": { - "additionalProperties": false, - "description": "Specifies next steps to run after the dialog code hook finishes.", - "properties": { - "FailureConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." - }, - "FailureNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." - }, - "FailureResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "SuccessConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the dialog code hook finishes successfully." - }, - "SuccessNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifics the next step the bot runs after the dialog code hook finishes successfully." - }, - "SuccessResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "TimeoutConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate if the code hook times out." - }, - "TimeoutNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot runs when the code hook times out." - }, - "TimeoutResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - } - }, - "type": "object" - }, - "PostFulfillmentStatusSpecification": { - "additionalProperties": false, - "description": "Provides a setting that determines whether the post-fulfillment response is sent to the user.", - "properties": { - "FailureConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." - }, - "FailureNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." - }, - "FailureResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "SuccessConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully." - }, - "SuccessNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully." - }, - "SuccessResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "TimeoutConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate if the fulfillment code hook times out." - }, - "TimeoutNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot runs when the fulfillment code hook times out." - }, - "TimeoutResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - } - }, - "required": [], - "type": "object" - }, - "PriorityValue": { - "description": "The priority that a slot should be elicited.", - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "PromptAttemptSpecification": { - "additionalProperties": false, - "description": "Specifies the settings on a prompt attempt.", - "properties": { - "AllowInterrupt": { - "description": "Indicates whether the user can interrupt a speech prompt attempt from the bot.", - "type": "boolean" - }, - "AllowedInputTypes": { - "$ref": "#/definitions/AllowedInputTypes" - }, - "AudioAndDTMFInputSpecification": { - "$ref": "#/definitions/AudioAndDTMFInputSpecification" - }, - "TextInputSpecification": { - "$ref": "#/definitions/TextInputSpecification" - } - }, - "required": [ - "AllowedInputTypes" - ], - "type": "object" - }, - "PromptMaxRetries": { - "description": "The maximum number of times the bot tries to elicit a response from the user using this prompt.", - "maximum": 5, - "minimum": 0, - "type": "integer" - }, - "PromptSpecification": { - "additionalProperties": false, - "description": "Prompts the user to confirm the intent.", - "properties": { - "AllowInterrupt": { - "description": "Indicates whether the user can interrupt a speech prompt from the bot.", - "type": "boolean" - }, - "MaxRetries": { - "$ref": "#/definitions/PromptMaxRetries" - }, - "MessageGroupsList": { - "$ref": "#/definitions/MessageGroupsList" - }, - "MessageSelectionStrategy": { - "$ref": "#/definitions/MessageSelectionStrategy" - }, - "PromptAttemptsSpecification": { - "additionalProperties": false, - "description": "Specifies the advanced settings on each attempt of the prompt.", - "patternProperties": { - "^(Initial|Retry1|Retry2|Retry3|Retry4|Retry5)$": { - "$ref": "#/definitions/PromptAttemptSpecification" - } - }, - "type": "object" - } - }, - "required": [ - "MessageGroupsList", - "MaxRetries" - ], - "type": "object" - }, - "QueryFilterString": { - "description": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.", - "maxLength": 5000, - "minLength": 1, - "type": "string" - }, - "ResponseSpecification": { - "additionalProperties": false, - "description": "A list of message groups that Amazon Lex uses to respond the user input.", - "properties": { - "AllowInterrupt": { - "description": "Indicates whether the user can interrupt a speech prompt from the bot.", - "type": "boolean" - }, - "MessageGroupsList": { - "$ref": "#/definitions/MessageGroupsList" - } - }, - "required": [ - "MessageGroupsList" - ], - "type": "object" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.", - "maxLength": 2048, - "minLength": 32, - "pattern": "^arn:aws[a-zA-Z-]*:iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "S3BucketLogDestination": { - "additionalProperties": false, - "description": "Specifies an Amazon S3 bucket for logging audio conversations", - "properties": { - "KmsKeyArn": { - "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", - "type": "string" - }, - "LogPrefix": { - "description": "The Amazon S3 key of the deployment package.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "S3BucketArn": { - "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - } - }, - "required": [ - "LogPrefix", - "S3BucketArn" - ], - "type": "object" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "S3Location": { - "additionalProperties": false, - "description": "S3 location of bot definitions zip file, if it's not defined inline in CloudFormation.", - "properties": { - "S3Bucket": { - "$ref": "#/definitions/S3BucketName", - "description": "An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account." - }, - "S3ObjectKey": { - "$ref": "#/definitions/S3ObjectKey", - "description": "The Amazon S3 key of the deployment package." - }, - "S3ObjectVersion": { - "description": "For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3ObjectKey" - ], - "type": "object" - }, - "S3ObjectKey": { - "maxLength": 1024, - "minLength": 1, - "pattern": "[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$", - "type": "string" - }, - "SSMLMessage": { - "additionalProperties": false, - "description": "A message in Speech Synthesis Markup Language (SSML).", - "properties": { - "Value": { - "description": "The SSML text that defines the prompt.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "SampleUtterance": { - "additionalProperties": false, - "description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt.", - "properties": { - "Utterance": { - "$ref": "#/definitions/Utterance" - } - }, - "required": [ - "Utterance" - ], - "type": "object" - }, - "SampleUtterancesList": { - "description": "An array of sample utterances", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SampleUtterance" - }, - "type": "array" - }, - "SampleValue": { - "additionalProperties": false, - "description": "Defines one of the values for a slot type.", - "properties": { - "Value": { - "description": "The value that can be used for a slot type.", - "maxLength": 140, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "SessionAttribute": { - "additionalProperties": false, - "description": "Key/value pair representing session-specific context information. It contains application information passed between Amazon Lex and a client application.", - "properties": { - "Key": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "Slot": { - "additionalProperties": false, - "description": "A slot is a variable needed to fulfill an intent, where an intent can require zero or more slots.", - "properties": { - "Description": { - "$ref": "#/definitions/Description" - }, - "MultipleValuesSetting": { - "$ref": "#/definitions/MultipleValuesSetting" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "ObfuscationSetting": { - "$ref": "#/definitions/ObfuscationSetting" - }, - "SlotTypeName": { - "$ref": "#/definitions/SlotTypeName" - }, - "ValueElicitationSetting": { - "$ref": "#/definitions/SlotValueElicitationSetting" - } - }, - "required": [ - "Name", - "SlotTypeName", - "ValueElicitationSetting" - ], - "type": "object" - }, - "SlotCaptureSetting": { - "additionalProperties": false, - "description": "Settings used when Amazon Lex successfully captures a slot value from a user.", - "properties": { - "CaptureConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate after the slot value is captured." - }, - "CaptureNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out." - }, - "CaptureResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - }, - "CodeHook": { - "$ref": "#/definitions/DialogCodeHookInvocationSetting", - "description": "Code hook called after Amazon Lex successfully captures a slot value." - }, - "ElicitationCodeHook": { - "$ref": "#/definitions/ElicitationCodeHookInvocationSetting", - "description": "Code hook called when Amazon Lex doesn't capture a slot value." - }, - "FailureConditional": { - "$ref": "#/definitions/ConditionalSpecification", - "description": "A list of conditional branches to evaluate when the slot value isn't captured." - }, - "FailureNextStep": { - "$ref": "#/definitions/DialogState", - "description": "Specifies the next step that the bot runs when the slot value code is not recognized." - }, - "FailureResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." - } - }, - "type": "object" - }, - "SlotConstraint": { - "enum": [ - "Required", - "Optional" - ], - "type": "string" - }, - "SlotDefaultValue": { - "additionalProperties": false, - "description": "The default value to use when a user doesn't provide a value for a slot.", - "properties": { - "DefaultValue": { - "description": "The default value to use when a user doesn't provide a value for a slot.", - "maxLength": 202, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DefaultValue" - ], - "type": "object" - }, - "SlotDefaultValueSpecification": { - "additionalProperties": false, - "description": "A list of values that Amazon Lex should use as the default value for a slot.", - "properties": { - "DefaultValueList": { - "description": "A list of slot default values", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SlotDefaultValue" - }, - "maxItems": 10, - "type": "array" - } - }, - "required": [ - "DefaultValueList" - ], - "type": "object" - }, - "SlotPrioritiesList": { - "description": "List for slot priorities", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SlotPriority" - }, - "type": "array" - }, - "SlotPriority": { - "additionalProperties": false, - "description": "The priority that Amazon Lex should use when eliciting slot values from a user.", - "properties": { - "Priority": { - "$ref": "#/definitions/PriorityValue" - }, - "SlotName": { - "$ref": "#/definitions/Name", - "description": "The name of the slot." - } - }, - "required": [ - "SlotName", - "Priority" - ], - "type": "object" - }, - "SlotShape": { - "description": "The different shapes that a slot can be in during a conversation.", - "enum": [ - "Scalar", - "List" - ], - "type": "string" - }, - "SlotType": { - "additionalProperties": false, - "description": "A custom, extended built-in or a grammar slot type.", - "properties": { - "Description": { - "$ref": "#/definitions/Description" - }, - "ExternalSourceSetting": { - "$ref": "#/definitions/ExternalSourceSetting" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "ParentSlotTypeSignature": { - "$ref": "#/definitions/ParentSlotTypeSignature" - }, - "SlotTypeValues": { - "$ref": "#/definitions/SlotTypeValues" - }, - "ValueSelectionSetting": { - "$ref": "#/definitions/SlotValueSelectionSetting" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SlotTypeName": { - "description": "The slot type name that is used in the slot. Allows for custom and built-in slot type names", - "type": "string" - }, - "SlotTypeValue": { - "additionalProperties": false, - "description": "Value that the slot type can take.", - "properties": { - "SampleValue": { - "$ref": "#/definitions/SampleValue" - }, - "Synonyms": { - "$ref": "#/definitions/SynonymList" - } - }, - "required": [ - "SampleValue" - ], - "type": "object" - }, - "SlotTypeValues": { - "description": "A List of slot type values", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SlotTypeValue" - }, - "maxItems": 10000, - "type": "array" - }, - "SlotValue": { - "additionalProperties": false, - "description": "The value to set in a slot.", - "properties": { - "InterpretedValue": { - "description": "The value that Amazon Lex determines for the slot.", - "maxLength": 202, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SlotValueElicitationSetting": { - "additionalProperties": false, - "description": "Settings that you can use for eliciting a slot value.", - "properties": { - "DefaultValueSpecification": { - "$ref": "#/definitions/SlotDefaultValueSpecification", - "description": "A list of default values for a slot." - }, - "PromptSpecification": { - "$ref": "#/definitions/PromptSpecification", - "description": "The prompt that Amazon Lex uses to elicit the slot value from the user." - }, - "SampleUtterances": { - "$ref": "#/definitions/SampleUtterancesList", - "description": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy." - }, - "SlotCaptureSetting": { - "$ref": "#/definitions/SlotCaptureSetting", - "description": "Specifies the next stage in the conversation after capturing the slot." - }, - "SlotConstraint": { - "$ref": "#/definitions/SlotConstraint", - "description": "Specifies whether the slot is required or optional." - }, - "WaitAndContinueSpecification": { - "$ref": "#/definitions/WaitAndContinueSpecification", - "description": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input." - } - }, - "required": [ - "SlotConstraint" - ], - "type": "object" - }, - "SlotValueOverride": { - "additionalProperties": false, - "description": "The slot values that Amazon Lex uses when it sets slot values in a dialog step.", - "properties": { - "Shape": { - "$ref": "#/definitions/SlotShape", - "description": "When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value." - }, - "Value": { - "$ref": "#/definitions/SlotValue", - "description": "The current value of the slot." - }, - "Values": { - "$ref": "#/definitions/SlotValues", - "description": "A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\"" - } - }, - "type": "object" - }, - "SlotValueOverrideMap": { - "additionalProperties": false, - "description": "A map of slot names and their overridden values.", - "properties": { - "SlotName": { - "$ref": "#/definitions/Name" - }, - "SlotValueOverride": { - "$ref": "#/definitions/SlotValueOverride" - } - }, - "type": "object" - }, - "SlotValueRegexFilter": { - "additionalProperties": false, - "description": "A regular expression used to validate the value of a slot.", - "properties": { - "Pattern": { - "description": "Regex pattern", - "maxLength": 300, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Pattern" - ], - "type": "object" - }, - "SlotValueResolutionStrategy": { - "enum": [ - "ORIGINAL_VALUE", - "TOP_RESOLUTION" - ], - "type": "string" - }, - "SlotValueSelectionSetting": { - "additionalProperties": false, - "description": "Contains settings used by Amazon Lex to select a slot value.", - "properties": { - "AdvancedRecognitionSetting": { - "$ref": "#/definitions/AdvancedRecognitionSetting" - }, - "RegexFilter": { - "$ref": "#/definitions/SlotValueRegexFilter" - }, - "ResolutionStrategy": { - "$ref": "#/definitions/SlotValueResolutionStrategy" - } - }, - "required": [ - "ResolutionStrategy" - ], - "type": "object" - }, - "SlotValues": { - "description": "An array of values that slots should be set to", - "items": { - "$ref": "#/definitions/SlotValueOverride" - }, - "type": "array" - }, - "StillWaitingResponseFrequency": { - "description": "How often a message should be sent to the user in seconds.", - "maximum": 300, - "minimum": 1, - "type": "integer" - }, - "StillWaitingResponseSpecification": { - "additionalProperties": false, - "description": "StillWaitingResponseSpecification.", - "properties": { - "AllowInterrupt": { - "description": "Indicates whether the user can interrupt a speech prompt from the bot.", - "type": "boolean" - }, - "FrequencyInSeconds": { - "$ref": "#/definitions/StillWaitingResponseFrequency" - }, - "MessageGroupsList": { - "$ref": "#/definitions/MessageGroupsList" - }, - "TimeoutInSeconds": { - "$ref": "#/definitions/StillWaitingResponseTimeout" - } - }, - "required": [ - "MessageGroupsList", - "FrequencyInSeconds", - "TimeoutInSeconds" - ], - "type": "object" - }, - "StillWaitingResponseTimeout": { - "description": "If Amazon Lex waits longer than this length of time in seconds for a response, it will stop sending messages.", - "maximum": 900, - "minimum": 1, - "type": "integer" - }, - "SynonymList": { - "description": "Additional values related to the slot type entry.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SampleValue" - }, - "maxItems": 10000, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair for tagging Lex resources", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TestBotAliasSettings": { - "additionalProperties": false, - "description": "Configuring the test bot alias settings for a given bot", - "properties": { - "BotAliasLocaleSettings": { - "$ref": "#/definitions/BotAliasLocaleSettingsList" - }, - "ConversationLogSettings": { - "$ref": "#/definitions/ConversationLogSettings" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "SentimentAnalysisSettings": { - "additionalProperties": false, - "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.", - "properties": { - "DetectSentiment": { - "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex", - "type": "boolean" - } - }, - "required": [ - "DetectSentiment" - ], - "type": "object" - } - }, - "type": "object" - }, - "TextInputSpecification": { - "additionalProperties": false, - "description": "Specifies the text input specifications.", - "properties": { - "StartTimeoutMs": { - "description": "Time for which a bot waits before re-prompting a customer for text input.", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "StartTimeoutMs" - ], - "type": "object" - }, - "TextLogDestination": { - "additionalProperties": false, - "description": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.", - "properties": { - "CloudWatch": { - "$ref": "#/definitions/CloudWatchLogGroupLogDestination" - } - }, - "required": [ - "CloudWatch" - ], - "type": "object" - }, - "TextLogSetting": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "Destination": { - "$ref": "#/definitions/TextLogDestination" - }, - "Enabled": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "Destination", - "Enabled" - ], - "type": "object" - }, - "TextLogSettings": { - "description": "List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TextLogSetting" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "Utterance": { - "description": "The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents/slots.", - "type": "string" - }, - "VoiceSettings": { - "additionalProperties": false, - "description": "Settings for using an Amazon Polly voice to communicate with a user.", - "properties": { - "Engine": { - "description": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.", - "enum": [ - "standard", - "neural" - ], - "type": "string" - }, - "VoiceId": { - "description": "The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.", - "type": "string" - } - }, - "required": [ - "VoiceId" - ], - "type": "object" - }, - "WaitAndContinueSpecification": { - "additionalProperties": false, - "description": "The prompts that Amazon Lex uses while a bot is waiting for customer input.", - "properties": { - "ContinueResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation." - }, - "IsActive": { - "description": "Specifies whether the bot will wait for a user to respond.", - "type": "boolean" - }, - "StillWaitingResponse": { - "$ref": "#/definitions/StillWaitingResponseSpecification", - "description": "The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user." - }, - "WaitingResponse": { - "$ref": "#/definitions/ResponseSpecification", - "description": "The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue." - } - }, - "required": [ - "WaitingResponse", - "ContinueResponse" - ], - "type": "object" - } - }, - "description": "Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "lex:DescribeBot", - "lex:CreateUploadUrl", - "lex:StartImport", - "lex:DescribeImport", - "lex:ListTagsForResource", - "lex:TagResource", - "lex:CreateBot", - "lex:CreateBotLocale", - "lex:CreateIntent", - "lex:CreateSlot", - "lex:CreateSlotType", - "lex:UpdateBot", - "lex:UpdateBotLocale", - "lex:UpdateIntent", - "lex:UpdateSlot", - "lex:UpdateSlotType", - "lex:DeleteBotLocale", - "lex:DeleteIntent", - "lex:DeleteSlot", - "lex:DeleteSlotType", - "lex:DescribeBotLocale", - "lex:BuildBotLocale", - "lex:ListBots", - "lex:ListBotLocales", - "lex:CreateCustomVocabulary", - "lex:UpdateCustomVocabulary", - "lex:DeleteCustomVocabulary", - "s3:GetObject", - "lex:UpdateBotAlias" - ] - }, - "delete": { - "permissions": [ - "lex:DeleteBot", - "lex:DescribeBot", - "lex:DeleteBotLocale", - "lex:DeleteIntent", - "lex:DeleteSlotType", - "lex:DeleteSlot", - "lex:DeleteBotVersion", - "lex:DeleteBotChannel", - "lex:DeleteBotAlias", - "lex:DeleteCustomVocabulary" - ] - }, - "list": { - "permissions": [ - "lex:ListBots" - ] - }, - "read": { - "permissions": [ - "lex:DescribeBot", - "lex:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "lex:DescribeBot", - "lex:CreateUploadUrl", - "lex:StartImport", - "lex:DescribeImport", - "lex:ListTagsForResource", - "lex:TagResource", - "lex:UntagResource", - "lex:CreateBot", - "lex:CreateBotLocale", - "lex:CreateIntent", - "lex:CreateSlot", - "lex:CreateSlotType", - "lex:UpdateBot", - "lex:UpdateBotLocale", - "lex:UpdateIntent", - "lex:UpdateSlot", - "lex:UpdateSlotType", - "lex:DeleteBotLocale", - "lex:DeleteIntent", - "lex:DeleteSlot", - "lex:DeleteSlotType", - "lex:DescribeBotLocale", - "lex:BuildBotLocale", - "lex:ListBots", - "lex:ListBotLocales", - "lex:CreateCustomVocabulary", - "lex:UpdateCustomVocabulary", - "lex:DeleteCustomVocabulary", - "s3:GetObject", - "lex:UpdateBotAlias" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/BotArn" - }, - "AutoBuildBotLocales": { - "description": "Specifies whether to build the bot locales after bot creation completes.", - "type": "boolean" - }, - "BotFileS3Location": { - "$ref": "#/definitions/S3Location" - }, - "BotLocales": { - "description": "List of bot locales", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BotLocale" - }, - "type": "array", - "uniqueItems": true - }, - "BotTags": { - "description": "A list of tags to add to the bot, which can only be added at bot creation.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "DataPrivacy": { - "additionalProperties": false, - "description": "Data privacy setting of the Bot.", - "properties": { - "ChildDirected": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "ChildDirected" - ], - "type": "object" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "IdleSessionTTLInSeconds": { - "description": "IdleSessionTTLInSeconds of the resource", - "maximum": 86400, - "minimum": 60, - "type": "integer" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "TestBotAliasSettings": { - "$ref": "#/definitions/TestBotAliasSettings" - }, - "TestBotAliasTags": { - "description": "A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "RoleArn", - "DataPrivacy", - "IdleSessionTTLInSeconds" - ], - "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/build-create.html", - "taggable": true, - "typeName": "AWS::Lex::Bot", - "writeOnlyProperties": [ - "/properties/BotLocales", - "/properties/BotFileS3Location", - "/properties/AutoBuildBotLocales", - "/properties/BotTags", - "/properties/TestBotAliasTags" - ] -} +{ + "additionalProperties": false, + "definitions": { + "AdvancedRecognitionSetting": { + "additionalProperties": false, + "description": "Provides settings that enable advanced recognition settings for slot values.", + "properties": { + "AudioRecognitionStrategy": { + "$ref": "#/definitions/AudioRecognitionStrategy" + } + }, + "type": "object" + }, + "AllowedInputTypes": { + "additionalProperties": false, + "description": "Specifies the allowed input types.", + "properties": { + "AllowAudioInput": { + "description": "Indicates whether audio input is allowed.", + "type": "boolean" + }, + "AllowDTMFInput": { + "description": "Indicates whether DTMF input is allowed.", + "type": "boolean" + } + }, + "required": [ + "AllowAudioInput", + "AllowDTMFInput" + ], + "type": "object" + }, + "AttachmentTitle": { + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "AttachmentUrl": { + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "AudioAndDTMFInputSpecification": { + "additionalProperties": false, + "description": "Specifies the audio and DTMF input specification.", + "properties": { + "AudioSpecification": { + "$ref": "#/definitions/AudioSpecification" + }, + "DTMFSpecification": { + "$ref": "#/definitions/DTMFSpecification" + }, + "StartTimeoutMs": { + "description": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "StartTimeoutMs" + ], + "type": "object" + }, + "AudioLogDestination": { + "additionalProperties": false, + "description": "The location of audio log files collected when conversation logging is enabled for a bot.", + "properties": { + "S3Bucket": { + "$ref": "#/definitions/S3BucketLogDestination" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "AudioLogSetting": { + "additionalProperties": false, + "description": "Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.", + "properties": { + "Destination": { + "$ref": "#/definitions/AudioLogDestination" + }, + "Enabled": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "Destination", + "Enabled" + ], + "type": "object" + }, + "AudioLogSettings": { + "description": "List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AudioLogSetting" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "AudioRecognitionStrategy": { + "description": "Enables using slot values as a custom vocabulary when recognizing user utterances.", + "enum": [ + "UseSlotValuesAsCustomVocabulary" + ], + "type": "string" + }, + "AudioSpecification": { + "additionalProperties": false, + "description": "Specifies the audio input specifications.", + "properties": { + "EndTimeoutMs": { + "description": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished.", + "minimum": 1, + "type": "integer" + }, + "MaxLengthMs": { + "description": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "EndTimeoutMs", + "MaxLengthMs" + ], + "type": "object" + }, + "BotAliasLocaleSettings": { + "additionalProperties": false, + "description": "You can use this parameter to specify a specific Lambda function to run different functions in different locales.", + "properties": { + "CodeHookSpecification": { + "$ref": "#/definitions/CodeHookSpecification" + }, + "Enabled": { + "description": "Whether the Lambda code hook is enabled", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "BotAliasLocaleSettingsItem": { + "additionalProperties": false, + "description": "A locale setting in alias", + "properties": { + "BotAliasLocaleSetting": { + "$ref": "#/definitions/BotAliasLocaleSettings" + }, + "LocaleId": { + "description": "A string used to identify the locale", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "LocaleId", + "BotAliasLocaleSetting" + ], + "type": "object" + }, + "BotAliasLocaleSettingsList": { + "description": "A list of bot alias locale settings to add to the bot alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BotAliasLocaleSettingsItem" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "BotArn": { + "maxLength": 1011, + "minLength": 1, + "pattern": "^arn:aws[a-zA-Z-]*:lex:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:bot/[0-9a-zA-Z]+$", + "type": "string" + }, + "BotLocale": { + "additionalProperties": false, + "description": "A locale in the bot, which contains the intents and slot types that the bot uses in conversations with users in the specified language and locale.", + "properties": { + "CustomVocabulary": { + "$ref": "#/definitions/CustomVocabulary" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "Intents": { + "description": "List of intents", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Intent" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "LocaleId": { + "$ref": "#/definitions/LocaleId" + }, + "NluConfidenceThreshold": { + "$ref": "#/definitions/ConfidenceThreshold" + }, + "SlotTypes": { + "description": "List of SlotTypes", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SlotType" + }, + "maxItems": 250, + "type": "array", + "uniqueItems": true + }, + "VoiceSettings": { + "$ref": "#/definitions/VoiceSettings" + } + }, + "required": [ + "LocaleId", + "NluConfidenceThreshold" + ], + "type": "object" + }, + "Button": { + "additionalProperties": false, + "description": "A button to use on a response card used to gather slot values from a user.", + "properties": { + "Text": { + "description": "The text that appears on the button.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value returned to Amazon Lex when the user chooses this button.", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text", + "Value" + ], + "type": "object" + }, + "CloudWatchLogGroupLogDestination": { + "additionalProperties": false, + "properties": { + "CloudWatchLogGroupArn": { + "description": "A string used to identify the groupArn for the Cloudwatch Log Group", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "LogPrefix": { + "description": "A string containing the value for the Log Prefix", + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "CloudWatchLogGroupArn", + "LogPrefix" + ], + "type": "object" + }, + "CodeHookSpecification": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "LambdaCodeHook": { + "$ref": "#/definitions/LambdaCodeHook" + } + }, + "required": [ + "LambdaCodeHook" + ], + "type": "object" + }, + "Condition": { + "additionalProperties": false, + "description": "Provides an expression that evaluates to true or false.", + "properties": { + "ExpressionString": { + "$ref": "#/definitions/ConditionExpression", + "description": "The expression string that is evaluated." + } + }, + "required": [ + "ExpressionString" + ], + "type": "object" + }, + "ConditionExpression": { + "description": "Expression that is evaluated to true or false at runtime.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Conditional": { + "additionalProperties": false, + "description": "Contains conditional branches to fork the conversation flow.", + "properties": { + "ConditionalBranches": { + "$ref": "#/definitions/ConditionalBranches" + }, + "IsActive": { + "type": "boolean" + } + }, + "required": [ + "IsActive", + "ConditionalBranches" + ], + "type": "object" + }, + "ConditionalBranch": { + "additionalProperties": false, + "description": "A set of actions that Amazon Lex should run if the condition is matched.", + "properties": { + "Condition": { + "$ref": "#/definitions/Condition", + "description": "Contains the expression to evaluate. If the condition is true, the branch's actions are taken." + }, + "Name": { + "$ref": "#/definitions/Name", + "description": "The name of the branch." + }, + "NextStep": { + "$ref": "#/definitions/DialogState", + "description": "The next step in the conversation." + }, + "Response": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + }, + "required": [ + "Name", + "Condition", + "NextStep" + ], + "type": "object" + }, + "ConditionalBranches": { + "description": "A list of 1 to 4 conditional branches to fork the conversation flow.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ConditionalBranch" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "ConditionalSpecification": { + "additionalProperties": false, + "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.", + "properties": { + "ConditionalBranches": { + "$ref": "#/definitions/ConditionalBranches", + "description": "A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true." + }, + "DefaultBranch": { + "$ref": "#/definitions/DefaultConditionalBranch", + "description": "The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step." + }, + "IsActive": { + "description": "Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.", + "type": "boolean" + } + }, + "required": [ + "IsActive", + "ConditionalBranches", + "DefaultBranch" + ], + "type": "object" + }, + "ConfidenceThreshold": { + "description": "The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "ContextTimeToLiveInSeconds": { + "description": "The amount of time, in seconds, that the output context should remain active.", + "maximum": 86400, + "minimum": 5, + "type": "integer" + }, + "ContextTurnsToLive": { + "description": "The number of conversation turns that the output context should remain active.", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "ConversationLogSettings": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "AudioLogSettings": { + "$ref": "#/definitions/AudioLogSettings" + }, + "TextLogSettings": { + "$ref": "#/definitions/TextLogSettings" + } + }, + "type": "object" + }, + "CustomPayload": { + "additionalProperties": false, + "description": "A message in a custom format defined by the client application.", + "properties": { + "Value": { + "description": "The string that is sent to your application.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "CustomVocabulary": { + "additionalProperties": false, + "description": "A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input.", + "properties": { + "CustomVocabularyItems": { + "$ref": "#/definitions/CustomVocabularyItems" + } + }, + "required": [ + "CustomVocabularyItems" + ], + "type": "object" + }, + "CustomVocabularyItem": { + "additionalProperties": false, + "description": "A custom vocabulary item that contains the phrase to recognize and a weight to give the boost.", + "properties": { + "DisplayAs": { + "description": "Defines how you want your phrase to look in your transcription output.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Phrase": { + "description": "Phrase that should be recognized.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Weight": { + "description": "The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field.", + "maximum": 3, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Phrase" + ], + "type": "object" + }, + "CustomVocabularyItems": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomVocabularyItem" + }, + "maxItems": 500, + "type": "array", + "uniqueItems": true + }, + "DTMFSpecification": { + "additionalProperties": false, + "description": "Specifies the settings on DTMF input.", + "properties": { + "DeletionCharacter": { + "description": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input.", + "pattern": "^[A-D0-9#*]{1}$", + "type": "string" + }, + "EndCharacter": { + "description": "The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.", + "pattern": "^[A-D0-9#*]{1}$", + "type": "string" + }, + "EndTimeoutMs": { + "description": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded.", + "minimum": 1, + "type": "integer" + }, + "MaxLength": { + "description": "The maximum number of DTMF digits allowed in an utterance.", + "maximum": 1024, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "DeletionCharacter", + "EndCharacter", + "EndTimeoutMs", + "MaxLength" + ], + "type": "object" + }, + "DataPrivacy": { + "additionalProperties": false, + "description": "Provides information on additional privacy protections Amazon Lex should use with the bot's data.", + "properties": { + "ChildDirected": { + "description": "Specify whether your use of Amazon Lex is related to application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA).", + "type": "boolean" + } + }, + "required": [ + "ChildDirected" + ], + "type": "object" + }, + "DefaultConditionalBranch": { + "additionalProperties": false, + "description": "A set of actions that Amazon Lex should run if none of the other conditions are met.", + "properties": { + "NextStep": { + "$ref": "#/definitions/DialogState", + "description": "The next step in the conversation." + }, + "Response": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + }, + "type": "object" + }, + "Description": { + "description": "A description of the resource", + "maxLength": 200, + "type": "string" + }, + "DialogAction": { + "additionalProperties": false, + "description": "Defines the action that the bot executes at runtime when the conversation reaches this step.", + "properties": { + "SlotToElicit": { + "$ref": "#/definitions/Name", + "description": "If the dialog action is ElicitSlot, defines the slot to elicit from the user." + }, + "SuppressNextMessage": { + "description": "When true the next message for the intent is not used.", + "type": "boolean" + }, + "Type": { + "$ref": "#/definitions/DialogActionType", + "description": "The action that the bot should execute." + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "DialogActionType": { + "description": "The possible values of actions that the conversation can take.", + "enum": [ + "CloseIntent", + "ConfirmIntent", + "ElicitIntent", + "ElicitSlot", + "StartIntent", + "FulfillIntent", + "EndConversation", + "EvaluateConditional", + "InvokeDialogCodeHook" + ], + "type": "string" + }, + "DialogCodeHookInvocationSetting": { + "additionalProperties": false, + "description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.", + "properties": { + "EnableCodeHookInvocation": { + "description": "Indicates whether a Lambda function should be invoked for the dialog.", + "type": "boolean" + }, + "InvocationLabel": { + "$ref": "#/definitions/Name", + "description": "A label that indicates the dialog step from which the dialog code hook is happening." + }, + "IsActive": { + "description": "Determines whether a dialog code hook is used when the intent is activated.", + "type": "boolean" + }, + "PostCodeHookSpecification": { + "$ref": "#/definitions/PostDialogCodeHookInvocationSpecification", + "description": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete." + } + }, + "required": [ + "IsActive", + "EnableCodeHookInvocation", + "PostCodeHookSpecification" + ], + "type": "object" + }, + "DialogCodeHookSetting": { + "additionalProperties": false, + "description": "Settings that determine the Lambda function that Amazon Lex uses for processing user responses.", + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "DialogState": { + "additionalProperties": false, + "description": "The current state of the conversation with the user.", + "properties": { + "DialogAction": { + "$ref": "#/definitions/DialogAction", + "description": "Defines the action that the bot executes at runtime when the conversation reaches this step." + }, + "Intent": { + "$ref": "#/definitions/IntentOverride", + "description": "Override settings to configure the intent state." + }, + "SessionAttributes": { + "description": "List of session attributes to be applied when the conversation reaches this step.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SessionAttribute" + }, + "type": "array" + } + }, + "type": "object" + }, + "ElicitationCodeHookInvocationSetting": { + "additionalProperties": false, + "description": "Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.", + "properties": { + "EnableCodeHookInvocation": { + "description": "Indicates whether a Lambda function should be invoked for the dialog.", + "type": "boolean" + }, + "InvocationLabel": { + "$ref": "#/definitions/Name", + "description": "A label that indicates the dialog step from which the dialog code hook is happening." + } + }, + "required": [ + "EnableCodeHookInvocation" + ], + "type": "object" + }, + "ExternalSourceSetting": { + "additionalProperties": false, + "description": "Provides information about the external source of the slot type's definition.", + "properties": { + "GrammarSlotTypeSetting": { + "$ref": "#/definitions/GrammarSlotTypeSetting" + } + }, + "type": "object" + }, + "FulfillmentCodeHookSetting": { + "additionalProperties": false, + "description": "Settings that determine if a Lambda function should be invoked to fulfill a specific intent.", + "properties": { + "Enabled": { + "type": "boolean" + }, + "FulfillmentUpdatesSpecification": { + "$ref": "#/definitions/FulfillmentUpdatesSpecification" + }, + "IsActive": { + "description": "Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.", + "type": "boolean" + }, + "PostFulfillmentStatusSpecification": { + "$ref": "#/definitions/PostFulfillmentStatusSpecification" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "FulfillmentStartResponseSpecification": { + "additionalProperties": false, + "description": "Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.", + "properties": { + "AllowInterrupt": { + "description": "Determines whether the user can interrupt the start message while it is playing.", + "type": "boolean" + }, + "DelayInSeconds": { + "description": "The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.", + "maximum": 900, + "minimum": 1, + "type": "integer" + }, + "MessageGroups": { + "$ref": "#/definitions/MessageGroupsList" + } + }, + "required": [ + "DelayInSeconds", + "MessageGroups" + ], + "type": "object" + }, + "FulfillmentUpdateResponseSpecification": { + "additionalProperties": false, + "description": "Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.", + "properties": { + "AllowInterrupt": { + "description": "Determines whether the user can interrupt an update message while it is playing.", + "type": "boolean" + }, + "FrequencyInSeconds": { + "description": "The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.", + "maximum": 900, + "minimum": 1, + "type": "integer" + }, + "MessageGroups": { + "$ref": "#/definitions/MessageGroupsList" + } + }, + "required": [ + "FrequencyInSeconds", + "MessageGroups" + ], + "type": "object" + }, + "FulfillmentUpdatesSpecification": { + "additionalProperties": false, + "description": "Provides information for updating the user on the progress of fulfilling an intent.", + "properties": { + "Active": { + "description": "Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.", + "type": "boolean" + }, + "StartResponse": { + "$ref": "#/definitions/FulfillmentStartResponseSpecification" + }, + "TimeoutInSeconds": { + "description": "The length of time that the fulfillment Lambda function should run before it times out.", + "maximum": 900, + "minimum": 1, + "type": "integer" + }, + "UpdateResponse": { + "$ref": "#/definitions/FulfillmentUpdateResponseSpecification" + } + }, + "required": [ + "Active" + ], + "type": "object" + }, + "GrammarSlotTypeSetting": { + "additionalProperties": false, + "description": "Settings required for a slot type based on a grammar that you provide.", + "properties": { + "Source": { + "$ref": "#/definitions/GrammarSlotTypeSource" + } + }, + "type": "object" + }, + "GrammarSlotTypeSource": { + "additionalProperties": false, + "description": "Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.", + "properties": { + "KmsKeyArn": { + "description": "The Amazon KMS key required to decrypt the contents of the grammar, if any.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", + "type": "string" + }, + "S3BucketName": { + "$ref": "#/definitions/S3BucketName", + "description": "The name of the S3 bucket that contains the grammar source." + }, + "S3ObjectKey": { + "$ref": "#/definitions/S3ObjectKey", + "description": "The path to the grammar in the S3 bucket." + } + }, + "required": [ + "S3BucketName", + "S3ObjectKey" + ], + "type": "object" + }, + "Id": { + "description": "Unique ID of resource", + "maxLength": 10, + "minLength": 10, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "IdleSessionTTLInSeconds": { + "description": "The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "ImageResponseCard": { + "additionalProperties": false, + "description": "A message that defines a response card that the client application can show to the user.", + "properties": { + "Buttons": { + "description": "A list of buttons that should be displayed on the response card.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Button" + }, + "maxItems": 5, + "type": "array" + }, + "ImageUrl": { + "$ref": "#/definitions/AttachmentUrl", + "description": "The URL of an image to display on the response card." + }, + "Subtitle": { + "$ref": "#/definitions/AttachmentTitle", + "description": "The subtitle to display on the response card." + }, + "Title": { + "$ref": "#/definitions/AttachmentTitle", + "description": "The title to display on the response card." + } + }, + "required": [ + "Title" + ], + "type": "object" + }, + "InitialResponseSetting": { + "additionalProperties": false, + "description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.", + "properties": { + "CodeHook": { + "$ref": "#/definitions/DialogCodeHookInvocationSetting", + "description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation." + }, + "Conditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." + }, + "InitialResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "NextStep": { + "$ref": "#/definitions/DialogState", + "description": "The next step in the conversation." + } + }, + "type": "object" + }, + "InputContext": { + "additionalProperties": false, + "description": "InputContext specified for the intent.", + "properties": { + "Name": { + "$ref": "#/definitions/Name", + "description": "The name of the context." + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "InputContextsList": { + "description": "The list of input contexts specified for the intent.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InputContext" + }, + "maxItems": 5, + "type": "array" + }, + "Intent": { + "additionalProperties": false, + "description": "Represents an action that the user wants to perform.", + "properties": { + "Description": { + "$ref": "#/definitions/Description", + "description": "Description of thr intent." + }, + "DialogCodeHook": { + "$ref": "#/definitions/DialogCodeHookSetting" + }, + "FulfillmentCodeHook": { + "$ref": "#/definitions/FulfillmentCodeHookSetting" + }, + "InitialResponseSetting": { + "$ref": "#/definitions/InitialResponseSetting", + "description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots." + }, + "InputContexts": { + "$ref": "#/definitions/InputContextsList" + }, + "IntentClosingSetting": { + "$ref": "#/definitions/IntentClosingSetting" + }, + "IntentConfirmationSetting": { + "$ref": "#/definitions/IntentConfirmationSetting" + }, + "KendraConfiguration": { + "$ref": "#/definitions/KendraConfiguration" + }, + "Name": { + "$ref": "#/definitions/Name", + "description": "The name of the intent." + }, + "OutputContexts": { + "$ref": "#/definitions/OutputContextsList" + }, + "ParentIntentSignature": { + "$ref": "#/definitions/ParentIntentSignature" + }, + "SampleUtterances": { + "$ref": "#/definitions/SampleUtterancesList", + "description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt." + }, + "SlotPriorities": { + "$ref": "#/definitions/SlotPrioritiesList" + }, + "Slots": { + "description": "List of slots", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Slot" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "IntentClosingSetting": { + "additionalProperties": false, + "description": "Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.", + "properties": { + "ClosingResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "The response that Amazon Lex sends to the user when the intent is complete." + }, + "Conditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional." + }, + "IsActive": { + "description": "Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.", + "type": "boolean" + }, + "NextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot executes after playing the intent's closing response." + } + }, + "type": "object" + }, + "IntentConfirmationSetting": { + "additionalProperties": false, + "description": "Provides a prompt for making sure that the user is ready for the intent to be fulfilled.", + "properties": { + "CodeHook": { + "$ref": "#/definitions/DialogCodeHookInvocationSetting", + "description": "The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook." + }, + "ConfirmationConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the intent is closed." + }, + "ConfirmationNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot executes when the customer confirms the intent." + }, + "ConfirmationResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "DeclinationConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the intent is declined." + }, + "DeclinationNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot executes when the customer declines the intent." + }, + "DeclinationResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "When the user answers \"no\" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled." + }, + "ElicitationCodeHook": { + "$ref": "#/definitions/ElicitationCodeHookInvocationSetting", + "description": "The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries." + }, + "FailureConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." + }, + "FailureNextStep": { + "$ref": "#/definitions/DialogState", + "description": "The next step to take in the conversation if the confirmation step fails." + }, + "FailureResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "IsActive": { + "description": "Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.", + "type": "boolean" + }, + "PromptSpecification": { + "$ref": "#/definitions/PromptSpecification", + "description": "Prompts the user to confirm the intent. This question should have a yes or no answer." + } + }, + "required": [ + "PromptSpecification" + ], + "type": "object" + }, + "IntentOverride": { + "additionalProperties": false, + "description": "Override settings to configure the intent state.", + "properties": { + "Name": { + "$ref": "#/definitions/Name", + "description": "The name of the intent. Only required when you're switching intents." + }, + "Slots": { + "description": "A map of all of the slot value overrides for the intent.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SlotValueOverrideMap" + }, + "type": "array" + } + }, + "type": "object" + }, + "KendraConfiguration": { + "additionalProperties": false, + "description": "Configuration for searching a Amazon Kendra index specified for the intent.", + "properties": { + "KendraIndex": { + "$ref": "#/definitions/KendraIndexArn" + }, + "QueryFilterString": { + "$ref": "#/definitions/QueryFilterString" + }, + "QueryFilterStringEnabled": { + "description": "Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.", + "type": "boolean" + } + }, + "required": [ + "KendraIndex" + ], + "type": "object" + }, + "KendraIndexArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.", + "maxLength": 2048, + "minLength": 32, + "pattern": "^arn:aws[a-zA-Z-]*:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index/[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "LambdaCodeHook": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "CodeHookInterfaceVersion": { + "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.", + "maxLength": 5, + "minLength": 1, + "type": "string" + }, + "LambdaArn": { + "description": "The Amazon Resource Name (ARN) of the Lambda function.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "CodeHookInterfaceVersion", + "LambdaArn" + ], + "type": "object" + }, + "LocaleId": { + "description": "The identifier of the language and locale that the bot will be used in.", + "type": "string" + }, + "Message": { + "additionalProperties": false, + "description": "The primary message that Amazon Lex should send to the user.", + "properties": { + "CustomPayload": { + "$ref": "#/definitions/CustomPayload" + }, + "ImageResponseCard": { + "$ref": "#/definitions/ImageResponseCard" + }, + "PlainTextMessage": { + "$ref": "#/definitions/PlainTextMessage" + }, + "SSMLMessage": { + "$ref": "#/definitions/SSMLMessage" + } + }, + "required": [], + "type": "object" + }, + "MessageGroup": { + "additionalProperties": false, + "description": "One or more messages that Amazon Lex can send to the user.", + "properties": { + "Message": { + "$ref": "#/definitions/Message" + }, + "Variations": { + "description": "Message variations to send to the user.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Message" + }, + "maxItems": 2, + "type": "array" + } + }, + "required": [ + "Message" + ], + "type": "object" + }, + "MessageGroupsList": { + "description": "One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MessageGroup" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "MessageSelectionStrategy": { + "description": "Indicates how a message is selected from a message group among retries.", + "enum": [ + "Random", + "Ordered" + ], + "type": "string" + }, + "MultipleValuesSetting": { + "additionalProperties": false, + "description": "Indicates whether a slot can return multiple values.", + "properties": { + "AllowMultipleValues": { + "type": "boolean" + } + }, + "required": [], + "type": "object" + }, + "Name": { + "description": "Unique name for a resource.", + "maxLength": 100, + "minLength": 1, + "pattern": "^([0-9a-zA-Z][_-]?)+$", + "type": "string" + }, + "ObfuscationSetting": { + "additionalProperties": false, + "description": "Determines whether Amazon Lex obscures slot values in conversation logs.", + "properties": { + "ObfuscationSettingType": { + "description": "Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.", + "enum": [ + "None", + "DefaultObfuscation" + ], + "type": "string" + } + }, + "required": [ + "ObfuscationSettingType" + ], + "type": "object" + }, + "OutputContext": { + "additionalProperties": false, + "description": "A session context that is activated when an intent is fulfilled.", + "properties": { + "Name": { + "$ref": "#/definitions/Name" + }, + "TimeToLiveInSeconds": { + "$ref": "#/definitions/ContextTimeToLiveInSeconds" + }, + "TurnsToLive": { + "$ref": "#/definitions/ContextTurnsToLive" + } + }, + "required": [ + "Name", + "TimeToLiveInSeconds", + "TurnsToLive" + ], + "type": "object" + }, + "OutputContextsList": { + "description": "A list of contexts that the intent activates when it is fulfilled.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OutputContext" + }, + "maxItems": 10, + "type": "array" + }, + "ParentIntentSignature": { + "description": "A unique identifier for the built-in intent to base this intent on.", + "type": "string" + }, + "ParentSlotTypeSignature": { + "description": "The built-in slot type used as a parent of this slot type.", + "type": "string" + }, + "PlainTextMessage": { + "additionalProperties": false, + "description": "A message in plain text format.", + "properties": { + "Value": { + "description": "The message to send to the user.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "PostDialogCodeHookInvocationSpecification": { + "additionalProperties": false, + "description": "Specifies next steps to run after the dialog code hook finishes.", + "properties": { + "FailureConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "SuccessConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the dialog code hook finishes successfully." + }, + "SuccessNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifics the next step the bot runs after the dialog code hook finishes successfully." + }, + "SuccessResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "TimeoutConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate if the code hook times out." + }, + "TimeoutNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot runs when the code hook times out." + }, + "TimeoutResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + }, + "type": "object" + }, + "PostFulfillmentStatusSpecification": { + "additionalProperties": false, + "description": "Provides a setting that determines whether the post-fulfillment response is sent to the user.", + "properties": { + "FailureConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "SuccessConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully." + }, + "SuccessNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully." + }, + "SuccessResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "TimeoutConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate if the fulfillment code hook times out." + }, + "TimeoutNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot runs when the fulfillment code hook times out." + }, + "TimeoutResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + }, + "required": [], + "type": "object" + }, + "PriorityValue": { + "description": "The priority that a slot should be elicited.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "PromptAttemptSpecification": { + "additionalProperties": false, + "description": "Specifies the settings on a prompt attempt.", + "properties": { + "AllowInterrupt": { + "description": "Indicates whether the user can interrupt a speech prompt attempt from the bot.", + "type": "boolean" + }, + "AllowedInputTypes": { + "$ref": "#/definitions/AllowedInputTypes" + }, + "AudioAndDTMFInputSpecification": { + "$ref": "#/definitions/AudioAndDTMFInputSpecification" + }, + "TextInputSpecification": { + "$ref": "#/definitions/TextInputSpecification" + } + }, + "required": [ + "AllowedInputTypes" + ], + "type": "object" + }, + "PromptMaxRetries": { + "description": "The maximum number of times the bot tries to elicit a response from the user using this prompt.", + "maximum": 5, + "minimum": 0, + "type": "integer" + }, + "PromptSpecification": { + "additionalProperties": false, + "description": "Prompts the user to confirm the intent.", + "properties": { + "AllowInterrupt": { + "description": "Indicates whether the user can interrupt a speech prompt from the bot.", + "type": "boolean" + }, + "MaxRetries": { + "$ref": "#/definitions/PromptMaxRetries" + }, + "MessageGroupsList": { + "$ref": "#/definitions/MessageGroupsList" + }, + "MessageSelectionStrategy": { + "$ref": "#/definitions/MessageSelectionStrategy" + }, + "PromptAttemptsSpecification": { + "additionalProperties": false, + "description": "Specifies the advanced settings on each attempt of the prompt.", + "patternProperties": { + "^(Initial|Retry1|Retry2|Retry3|Retry4|Retry5)$": { + "$ref": "#/definitions/PromptAttemptSpecification" + } + }, + "type": "object" + } + }, + "required": [ + "MessageGroupsList", + "MaxRetries" + ], + "type": "object" + }, + "QueryFilterString": { + "description": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.", + "maxLength": 5000, + "minLength": 1, + "type": "string" + }, + "ResponseSpecification": { + "additionalProperties": false, + "description": "A list of message groups that Amazon Lex uses to respond the user input.", + "properties": { + "AllowInterrupt": { + "description": "Indicates whether the user can interrupt a speech prompt from the bot.", + "type": "boolean" + }, + "MessageGroupsList": { + "$ref": "#/definitions/MessageGroupsList" + } + }, + "required": [ + "MessageGroupsList" + ], + "type": "object" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.", + "maxLength": 2048, + "minLength": 32, + "pattern": "^arn:aws[a-zA-Z-]*:iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "S3BucketLogDestination": { + "additionalProperties": false, + "description": "Specifies an Amazon S3 bucket for logging audio conversations", + "properties": { + "KmsKeyArn": { + "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", + "type": "string" + }, + "LogPrefix": { + "description": "The Amazon S3 key of the deployment package.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "S3BucketArn": { + "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "LogPrefix", + "S3BucketArn" + ], + "type": "object" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "S3Location": { + "additionalProperties": false, + "description": "S3 location of bot definitions zip file, if it's not defined inline in CloudFormation.", + "properties": { + "S3Bucket": { + "$ref": "#/definitions/S3BucketName", + "description": "An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account." + }, + "S3ObjectKey": { + "$ref": "#/definitions/S3ObjectKey", + "description": "The Amazon S3 key of the deployment package." + }, + "S3ObjectVersion": { + "description": "For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3ObjectKey" + ], + "type": "object" + }, + "S3ObjectKey": { + "maxLength": 1024, + "minLength": 1, + "pattern": "[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$", + "type": "string" + }, + "SSMLMessage": { + "additionalProperties": false, + "description": "A message in Speech Synthesis Markup Language (SSML).", + "properties": { + "Value": { + "description": "The SSML text that defines the prompt.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "SampleUtterance": { + "additionalProperties": false, + "description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt.", + "properties": { + "Utterance": { + "$ref": "#/definitions/Utterance" + } + }, + "required": [ + "Utterance" + ], + "type": "object" + }, + "SampleUtterancesList": { + "description": "An array of sample utterances", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SampleUtterance" + }, + "type": "array" + }, + "SampleValue": { + "additionalProperties": false, + "description": "Defines one of the values for a slot type.", + "properties": { + "Value": { + "description": "The value that can be used for a slot type.", + "maxLength": 140, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "SessionAttribute": { + "additionalProperties": false, + "description": "Key/value pair representing session-specific context information. It contains application information passed between Amazon Lex and a client application.", + "properties": { + "Key": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Slot": { + "additionalProperties": false, + "description": "A slot is a variable needed to fulfill an intent, where an intent can require zero or more slots.", + "properties": { + "Description": { + "$ref": "#/definitions/Description" + }, + "MultipleValuesSetting": { + "$ref": "#/definitions/MultipleValuesSetting" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "ObfuscationSetting": { + "$ref": "#/definitions/ObfuscationSetting" + }, + "SlotTypeName": { + "$ref": "#/definitions/SlotTypeName" + }, + "ValueElicitationSetting": { + "$ref": "#/definitions/SlotValueElicitationSetting" + } + }, + "required": [ + "Name", + "SlotTypeName", + "ValueElicitationSetting" + ], + "type": "object" + }, + "SlotCaptureSetting": { + "additionalProperties": false, + "description": "Settings used when Amazon Lex successfully captures a slot value from a user.", + "properties": { + "CaptureConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate after the slot value is captured." + }, + "CaptureNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out." + }, + "CaptureResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "CodeHook": { + "$ref": "#/definitions/DialogCodeHookInvocationSetting", + "description": "Code hook called after Amazon Lex successfully captures a slot value." + }, + "ElicitationCodeHook": { + "$ref": "#/definitions/ElicitationCodeHookInvocationSetting", + "description": "Code hook called when Amazon Lex doesn't capture a slot value." + }, + "FailureConditional": { + "$ref": "#/definitions/ConditionalSpecification", + "description": "A list of conditional branches to evaluate when the slot value isn't captured." + }, + "FailureNextStep": { + "$ref": "#/definitions/DialogState", + "description": "Specifies the next step that the bot runs when the slot value code is not recognized." + }, + "FailureResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + }, + "type": "object" + }, + "SlotConstraint": { + "enum": [ + "Required", + "Optional" + ], + "type": "string" + }, + "SlotDefaultValue": { + "additionalProperties": false, + "description": "The default value to use when a user doesn't provide a value for a slot.", + "properties": { + "DefaultValue": { + "description": "The default value to use when a user doesn't provide a value for a slot.", + "maxLength": 202, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DefaultValue" + ], + "type": "object" + }, + "SlotDefaultValueSpecification": { + "additionalProperties": false, + "description": "A list of values that Amazon Lex should use as the default value for a slot.", + "properties": { + "DefaultValueList": { + "description": "A list of slot default values", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SlotDefaultValue" + }, + "maxItems": 10, + "type": "array" + } + }, + "required": [ + "DefaultValueList" + ], + "type": "object" + }, + "SlotPrioritiesList": { + "description": "List for slot priorities", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SlotPriority" + }, + "type": "array" + }, + "SlotPriority": { + "additionalProperties": false, + "description": "The priority that Amazon Lex should use when eliciting slot values from a user.", + "properties": { + "Priority": { + "$ref": "#/definitions/PriorityValue" + }, + "SlotName": { + "$ref": "#/definitions/Name", + "description": "The name of the slot." + } + }, + "required": [ + "SlotName", + "Priority" + ], + "type": "object" + }, + "SlotShape": { + "description": "The different shapes that a slot can be in during a conversation.", + "enum": [ + "Scalar", + "List" + ], + "type": "string" + }, + "SlotType": { + "additionalProperties": false, + "description": "A custom, extended built-in or a grammar slot type.", + "properties": { + "Description": { + "$ref": "#/definitions/Description" + }, + "ExternalSourceSetting": { + "$ref": "#/definitions/ExternalSourceSetting" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "ParentSlotTypeSignature": { + "$ref": "#/definitions/ParentSlotTypeSignature" + }, + "SlotTypeValues": { + "$ref": "#/definitions/SlotTypeValues" + }, + "ValueSelectionSetting": { + "$ref": "#/definitions/SlotValueSelectionSetting" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SlotTypeName": { + "description": "The slot type name that is used in the slot. Allows for custom and built-in slot type names", + "type": "string" + }, + "SlotTypeValue": { + "additionalProperties": false, + "description": "Value that the slot type can take.", + "properties": { + "SampleValue": { + "$ref": "#/definitions/SampleValue" + }, + "Synonyms": { + "$ref": "#/definitions/SynonymList" + } + }, + "required": [ + "SampleValue" + ], + "type": "object" + }, + "SlotTypeValues": { + "description": "A List of slot type values", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SlotTypeValue" + }, + "maxItems": 10000, + "type": "array" + }, + "SlotValue": { + "additionalProperties": false, + "description": "The value to set in a slot.", + "properties": { + "InterpretedValue": { + "description": "The value that Amazon Lex determines for the slot.", + "maxLength": 202, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SlotValueElicitationSetting": { + "additionalProperties": false, + "description": "Settings that you can use for eliciting a slot value.", + "properties": { + "DefaultValueSpecification": { + "$ref": "#/definitions/SlotDefaultValueSpecification", + "description": "A list of default values for a slot." + }, + "PromptSpecification": { + "$ref": "#/definitions/PromptSpecification", + "description": "The prompt that Amazon Lex uses to elicit the slot value from the user." + }, + "SampleUtterances": { + "$ref": "#/definitions/SampleUtterancesList", + "description": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy." + }, + "SlotCaptureSetting": { + "$ref": "#/definitions/SlotCaptureSetting", + "description": "Specifies the next stage in the conversation after capturing the slot." + }, + "SlotConstraint": { + "$ref": "#/definitions/SlotConstraint", + "description": "Specifies whether the slot is required or optional." + }, + "WaitAndContinueSpecification": { + "$ref": "#/definitions/WaitAndContinueSpecification", + "description": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input." + } + }, + "required": [ + "SlotConstraint" + ], + "type": "object" + }, + "SlotValueOverride": { + "additionalProperties": false, + "description": "The slot values that Amazon Lex uses when it sets slot values in a dialog step.", + "properties": { + "Shape": { + "$ref": "#/definitions/SlotShape", + "description": "When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value." + }, + "Value": { + "$ref": "#/definitions/SlotValue", + "description": "The current value of the slot." + }, + "Values": { + "$ref": "#/definitions/SlotValues", + "description": "A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\"" + } + }, + "type": "object" + }, + "SlotValueOverrideMap": { + "additionalProperties": false, + "description": "A map of slot names and their overridden values.", + "properties": { + "SlotName": { + "$ref": "#/definitions/Name" + }, + "SlotValueOverride": { + "$ref": "#/definitions/SlotValueOverride" + } + }, + "type": "object" + }, + "SlotValueRegexFilter": { + "additionalProperties": false, + "description": "A regular expression used to validate the value of a slot.", + "properties": { + "Pattern": { + "description": "Regex pattern", + "maxLength": 300, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Pattern" + ], + "type": "object" + }, + "SlotValueResolutionStrategy": { + "enum": [ + "ORIGINAL_VALUE", + "TOP_RESOLUTION" + ], + "type": "string" + }, + "SlotValueSelectionSetting": { + "additionalProperties": false, + "description": "Contains settings used by Amazon Lex to select a slot value.", + "properties": { + "AdvancedRecognitionSetting": { + "$ref": "#/definitions/AdvancedRecognitionSetting" + }, + "RegexFilter": { + "$ref": "#/definitions/SlotValueRegexFilter" + }, + "ResolutionStrategy": { + "$ref": "#/definitions/SlotValueResolutionStrategy" + } + }, + "required": [ + "ResolutionStrategy" + ], + "type": "object" + }, + "SlotValues": { + "description": "An array of values that slots should be set to", + "items": { + "$ref": "#/definitions/SlotValueOverride" + }, + "type": "array" + }, + "StillWaitingResponseFrequency": { + "description": "How often a message should be sent to the user in seconds.", + "maximum": 300, + "minimum": 1, + "type": "integer" + }, + "StillWaitingResponseSpecification": { + "additionalProperties": false, + "description": "StillWaitingResponseSpecification.", + "properties": { + "AllowInterrupt": { + "description": "Indicates whether the user can interrupt a speech prompt from the bot.", + "type": "boolean" + }, + "FrequencyInSeconds": { + "$ref": "#/definitions/StillWaitingResponseFrequency" + }, + "MessageGroupsList": { + "$ref": "#/definitions/MessageGroupsList" + }, + "TimeoutInSeconds": { + "$ref": "#/definitions/StillWaitingResponseTimeout" + } + }, + "required": [ + "MessageGroupsList", + "FrequencyInSeconds", + "TimeoutInSeconds" + ], + "type": "object" + }, + "StillWaitingResponseTimeout": { + "description": "If Amazon Lex waits longer than this length of time in seconds for a response, it will stop sending messages.", + "maximum": 900, + "minimum": 1, + "type": "integer" + }, + "SynonymList": { + "description": "Additional values related to the slot type entry.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SampleValue" + }, + "maxItems": 10000, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair for tagging Lex resources", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TestBotAliasSettings": { + "additionalProperties": false, + "description": "Configuring the test bot alias settings for a given bot", + "properties": { + "BotAliasLocaleSettings": { + "$ref": "#/definitions/BotAliasLocaleSettingsList" + }, + "ConversationLogSettings": { + "$ref": "#/definitions/ConversationLogSettings" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "SentimentAnalysisSettings": { + "additionalProperties": false, + "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.", + "properties": { + "DetectSentiment": { + "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex", + "type": "boolean" + } + }, + "required": [ + "DetectSentiment" + ], + "type": "object" + } + }, + "type": "object" + }, + "TextInputSpecification": { + "additionalProperties": false, + "description": "Specifies the text input specifications.", + "properties": { + "StartTimeoutMs": { + "description": "Time for which a bot waits before re-prompting a customer for text input.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "StartTimeoutMs" + ], + "type": "object" + }, + "TextLogDestination": { + "additionalProperties": false, + "description": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.", + "properties": { + "CloudWatch": { + "$ref": "#/definitions/CloudWatchLogGroupLogDestination" + } + }, + "required": [ + "CloudWatch" + ], + "type": "object" + }, + "TextLogSetting": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "Destination": { + "$ref": "#/definitions/TextLogDestination" + }, + "Enabled": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "Destination", + "Enabled" + ], + "type": "object" + }, + "TextLogSettings": { + "description": "List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TextLogSetting" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "Utterance": { + "description": "The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents/slots.", + "type": "string" + }, + "VoiceSettings": { + "additionalProperties": false, + "description": "Settings for using an Amazon Polly voice to communicate with a user.", + "properties": { + "Engine": { + "description": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.", + "enum": [ + "standard", + "neural" + ], + "type": "string" + }, + "VoiceId": { + "description": "The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.", + "type": "string" + } + }, + "required": [ + "VoiceId" + ], + "type": "object" + }, + "WaitAndContinueSpecification": { + "additionalProperties": false, + "description": "The prompts that Amazon Lex uses while a bot is waiting for customer input.", + "properties": { + "ContinueResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation." + }, + "IsActive": { + "description": "Specifies whether the bot will wait for a user to respond.", + "type": "boolean" + }, + "StillWaitingResponse": { + "$ref": "#/definitions/StillWaitingResponseSpecification", + "description": "The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user." + }, + "WaitingResponse": { + "$ref": "#/definitions/ResponseSpecification", + "description": "The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue." + } + }, + "required": [ + "WaitingResponse", + "ContinueResponse" + ], + "type": "object" + } + }, + "description": "Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "lex:DescribeBot", + "lex:CreateUploadUrl", + "lex:StartImport", + "lex:DescribeImport", + "lex:ListTagsForResource", + "lex:TagResource", + "lex:CreateBot", + "lex:CreateBotLocale", + "lex:CreateIntent", + "lex:CreateSlot", + "lex:CreateSlotType", + "lex:UpdateBot", + "lex:UpdateBotLocale", + "lex:UpdateIntent", + "lex:UpdateSlot", + "lex:UpdateSlotType", + "lex:DeleteBotLocale", + "lex:DeleteIntent", + "lex:DeleteSlot", + "lex:DeleteSlotType", + "lex:DescribeBotLocale", + "lex:BuildBotLocale", + "lex:ListBots", + "lex:ListBotLocales", + "lex:CreateCustomVocabulary", + "lex:UpdateCustomVocabulary", + "lex:DeleteCustomVocabulary", + "s3:GetObject", + "lex:UpdateBotAlias" + ] + }, + "delete": { + "permissions": [ + "lex:DeleteBot", + "lex:DescribeBot", + "lex:DeleteBotLocale", + "lex:DeleteIntent", + "lex:DeleteSlotType", + "lex:DeleteSlot", + "lex:DeleteBotVersion", + "lex:DeleteBotChannel", + "lex:DeleteBotAlias", + "lex:DeleteCustomVocabulary" + ] + }, + "list": { + "permissions": [ + "lex:ListBots" + ] + }, + "read": { + "permissions": [ + "lex:DescribeBot", + "lex:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "lex:DescribeBot", + "lex:CreateUploadUrl", + "lex:StartImport", + "lex:DescribeImport", + "lex:ListTagsForResource", + "lex:TagResource", + "lex:UntagResource", + "lex:CreateBot", + "lex:CreateBotLocale", + "lex:CreateIntent", + "lex:CreateSlot", + "lex:CreateSlotType", + "lex:UpdateBot", + "lex:UpdateBotLocale", + "lex:UpdateIntent", + "lex:UpdateSlot", + "lex:UpdateSlotType", + "lex:DeleteBotLocale", + "lex:DeleteIntent", + "lex:DeleteSlot", + "lex:DeleteSlotType", + "lex:DescribeBotLocale", + "lex:BuildBotLocale", + "lex:ListBots", + "lex:ListBotLocales", + "lex:CreateCustomVocabulary", + "lex:UpdateCustomVocabulary", + "lex:DeleteCustomVocabulary", + "s3:GetObject", + "lex:UpdateBotAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/BotArn" + }, + "AutoBuildBotLocales": { + "description": "Specifies whether to build the bot locales after bot creation completes.", + "type": "boolean" + }, + "BotFileS3Location": { + "$ref": "#/definitions/S3Location" + }, + "BotLocales": { + "description": "List of bot locales", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BotLocale" + }, + "type": "array", + "uniqueItems": true + }, + "BotTags": { + "description": "A list of tags to add to the bot, which can only be added at bot creation.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "DataPrivacy": { + "additionalProperties": false, + "description": "Data privacy setting of the Bot.", + "properties": { + "ChildDirected": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "ChildDirected" + ], + "type": "object" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "IdleSessionTTLInSeconds": { + "description": "IdleSessionTTLInSeconds of the resource", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "TestBotAliasSettings": { + "$ref": "#/definitions/TestBotAliasSettings" + }, + "TestBotAliasTags": { + "description": "A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "RoleArn", + "DataPrivacy", + "IdleSessionTTLInSeconds" + ], + "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/build-create.html", + "taggable": true, + "typeName": "AWS::Lex::Bot", + "writeOnlyProperties": [ + "/properties/BotLocales", + "/properties/BotFileS3Location", + "/properties/AutoBuildBotLocales", + "/properties/BotTags", + "/properties/TestBotAliasTags" + ] +} diff --git a/schema/aws-lex-botalias.json b/schema/aws-lex-botalias.json index 366c828..a869b0b 100644 --- a/schema/aws-lex-botalias.json +++ b/schema/aws-lex-botalias.json @@ -1,410 +1,410 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BotId" - ], - "definitions": { - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "AudioLogDestination": { - "additionalProperties": false, - "description": "The location of audio log files collected when conversation logging is enabled for a bot.", - "properties": { - "S3Bucket": { - "$ref": "#/definitions/S3BucketLogDestination" - } - }, - "required": [ - "S3Bucket" - ], - "type": "object" - }, - "AudioLogSetting": { - "additionalProperties": false, - "description": "Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.", - "properties": { - "Destination": { - "$ref": "#/definitions/AudioLogDestination" - }, - "Enabled": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "Destination", - "Enabled" - ], - "type": "object" - }, - "AudioLogSettings": { - "description": "List of audio log settings", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AudioLogSetting" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "BotAliasLocaleSettings": { - "additionalProperties": false, - "description": "You can use this parameter to specify a specific Lambda function to run different functions in different locales.", - "properties": { - "CodeHookSpecification": { - "$ref": "#/definitions/CodeHookSpecification" - }, - "Enabled": { - "description": "Whether the Lambda code hook is enabled", - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "BotAliasLocaleSettingsItem": { - "additionalProperties": false, - "description": "A locale setting in alias", - "properties": { - "BotAliasLocaleSetting": { - "$ref": "#/definitions/BotAliasLocaleSettings" - }, - "LocaleId": { - "description": "A string used to identify the locale", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "LocaleId", - "BotAliasLocaleSetting" - ], - "type": "object" - }, - "BotAliasLocaleSettingsList": { - "description": "A list of bot alias locale settings to add to the bot alias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BotAliasLocaleSettingsItem" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "BotAliasStatus": { - "enum": [ - "Creating", - "Available", - "Deleting", - "Failed" - ], - "type": "string" - }, - "BotVersion": { - "description": "The version of a bot.", - "maxLength": 5, - "minLength": 1, - "pattern": "^(DRAFT|[0-9]+)$", - "type": "string" - }, - "CloudWatchLogGroupLogDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchLogGroupArn": { - "description": "A string used to identify the groupArn for the Cloudwatch Log Group", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "LogPrefix": { - "description": "A string containing the value for the Log Prefix", - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "CloudWatchLogGroupArn", - "LogPrefix" - ], - "type": "object" - }, - "CodeHookSpecification": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "LambdaCodeHook": { - "$ref": "#/definitions/LambdaCodeHook" - } - }, - "required": [ - "LambdaCodeHook" - ], - "type": "object" - }, - "ConversationLogSettings": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "AudioLogSettings": { - "$ref": "#/definitions/AudioLogSettings" - }, - "TextLogSettings": { - "$ref": "#/definitions/TextLogSettings" - } - }, - "type": "object" - }, - "Description": { - "description": "A description of the bot alias. Use the description to help identify the bot alias in lists.", - "maxLength": 200, - "type": "string" - }, - "Id": { - "description": "Unique ID of resource", - "maxLength": 10, - "minLength": 10, - "pattern": "^[0-9a-zA-Z]+$", - "type": "string" - }, - "LambdaCodeHook": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "CodeHookInterfaceVersion": { - "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.", - "maxLength": 5, - "minLength": 1, - "type": "string" - }, - "LambdaArn": { - "description": "The Amazon Resource Name (ARN) of the Lambda function.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "CodeHookInterfaceVersion", - "LambdaArn" - ], - "type": "object" - }, - "LocaleId": { - "description": "The identifier of the language and locale that the bot alias will be configured in.", - "type": "string" - }, - "Name": { - "description": "A unique identifier for a resource.", - "maxLength": 100, - "minLength": 1, - "pattern": "^([0-9a-zA-Z][_-]?)+$", - "type": "string" - }, - "S3BucketLogDestination": { - "additionalProperties": false, - "description": "Specifies an Amazon S3 bucket for logging audio conversations", - "properties": { - "KmsKeyArn": { - "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", - "type": "string" - }, - "LogPrefix": { - "description": "The Amazon S3 key of the deployment package.", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "S3BucketArn": { - "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - } - }, - "required": [ - "LogPrefix", - "S3BucketArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Lex resources", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TextLogDestination": { - "additionalProperties": false, - "description": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.", - "properties": { - "CloudWatch": { - "$ref": "#/definitions/CloudWatchLogGroupLogDestination" - } - }, - "required": [ - "CloudWatch" - ], - "type": "object" - }, - "TextLogSetting": { - "additionalProperties": false, - "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", - "properties": { - "Destination": { - "$ref": "#/definitions/TextLogDestination" - }, - "Enabled": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "Destination", - "Enabled" - ], - "type": "object" - }, - "TextLogSettings": { - "description": "List of text log settings", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TextLogSetting" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "description": "A Bot Alias enables you to change the version of a bot without updating applications that use the bot", - "handlers": { - "create": { - "permissions": [ - "lex:CreateBotAlias", - "lex:DescribeBot" - ] - }, - "delete": { - "permissions": [ - "lex:DeleteBotAlias" - ] - }, - "list": { - "permissions": [ - "lex:ListBotAliases" - ] - }, - "read": { - "permissions": [ - "lex:DescribeBotAlias" - ] - }, - "update": { - "permissions": [ - "lex:UpdateBotAlias", - "lex:DescribeBotAlias", - "lex:ListTagsForResource", - "lex:TagResource", - "lex:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/BotAliasId", - "/properties/BotId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "BotAliasId": { - "$ref": "#/definitions/Id" - }, - "BotAliasLocaleSettings": { - "$ref": "#/definitions/BotAliasLocaleSettingsList" - }, - "BotAliasName": { - "$ref": "#/definitions/Name" - }, - "BotAliasStatus": { - "$ref": "#/definitions/BotAliasStatus" - }, - "BotAliasTags": { - "description": "A list of tags to add to the bot alias.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "BotId": { - "$ref": "#/definitions/Id" - }, - "BotVersion": { - "$ref": "#/definitions/BotVersion" - }, - "ConversationLogSettings": { - "$ref": "#/definitions/ConversationLogSettings" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "SentimentAnalysisSettings": { - "additionalProperties": false, - "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.", - "properties": { - "DetectSentiment": { - "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex", - "type": "boolean" - } - }, - "required": [ - "DetectSentiment" - ], - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/BotAliasId", - "/properties/Arn", - "/properties/BotAliasStatus" - ], - "required": [ - "BotId", - "BotAliasName" - ], - "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBotAlias.html", - "taggable": false, - "typeName": "AWS::Lex::BotAlias", - "writeOnlyProperties": [ - "/properties/BotAliasTags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BotId" + ], + "definitions": { + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "AudioLogDestination": { + "additionalProperties": false, + "description": "The location of audio log files collected when conversation logging is enabled for a bot.", + "properties": { + "S3Bucket": { + "$ref": "#/definitions/S3BucketLogDestination" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "AudioLogSetting": { + "additionalProperties": false, + "description": "Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.", + "properties": { + "Destination": { + "$ref": "#/definitions/AudioLogDestination" + }, + "Enabled": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "Destination", + "Enabled" + ], + "type": "object" + }, + "AudioLogSettings": { + "description": "List of audio log settings", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AudioLogSetting" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "BotAliasLocaleSettings": { + "additionalProperties": false, + "description": "You can use this parameter to specify a specific Lambda function to run different functions in different locales.", + "properties": { + "CodeHookSpecification": { + "$ref": "#/definitions/CodeHookSpecification" + }, + "Enabled": { + "description": "Whether the Lambda code hook is enabled", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "BotAliasLocaleSettingsItem": { + "additionalProperties": false, + "description": "A locale setting in alias", + "properties": { + "BotAliasLocaleSetting": { + "$ref": "#/definitions/BotAliasLocaleSettings" + }, + "LocaleId": { + "description": "A string used to identify the locale", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "LocaleId", + "BotAliasLocaleSetting" + ], + "type": "object" + }, + "BotAliasLocaleSettingsList": { + "description": "A list of bot alias locale settings to add to the bot alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BotAliasLocaleSettingsItem" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "BotAliasStatus": { + "enum": [ + "Creating", + "Available", + "Deleting", + "Failed" + ], + "type": "string" + }, + "BotVersion": { + "description": "The version of a bot.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]+)$", + "type": "string" + }, + "CloudWatchLogGroupLogDestination": { + "additionalProperties": false, + "properties": { + "CloudWatchLogGroupArn": { + "description": "A string used to identify the groupArn for the Cloudwatch Log Group", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "LogPrefix": { + "description": "A string containing the value for the Log Prefix", + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "CloudWatchLogGroupArn", + "LogPrefix" + ], + "type": "object" + }, + "CodeHookSpecification": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "LambdaCodeHook": { + "$ref": "#/definitions/LambdaCodeHook" + } + }, + "required": [ + "LambdaCodeHook" + ], + "type": "object" + }, + "ConversationLogSettings": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "AudioLogSettings": { + "$ref": "#/definitions/AudioLogSettings" + }, + "TextLogSettings": { + "$ref": "#/definitions/TextLogSettings" + } + }, + "type": "object" + }, + "Description": { + "description": "A description of the bot alias. Use the description to help identify the bot alias in lists.", + "maxLength": 200, + "type": "string" + }, + "Id": { + "description": "Unique ID of resource", + "maxLength": 10, + "minLength": 10, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "LambdaCodeHook": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "CodeHookInterfaceVersion": { + "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.", + "maxLength": 5, + "minLength": 1, + "type": "string" + }, + "LambdaArn": { + "description": "The Amazon Resource Name (ARN) of the Lambda function.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "CodeHookInterfaceVersion", + "LambdaArn" + ], + "type": "object" + }, + "LocaleId": { + "description": "The identifier of the language and locale that the bot alias will be configured in.", + "type": "string" + }, + "Name": { + "description": "A unique identifier for a resource.", + "maxLength": 100, + "minLength": 1, + "pattern": "^([0-9a-zA-Z][_-]?)+$", + "type": "string" + }, + "S3BucketLogDestination": { + "additionalProperties": false, + "description": "Specifies an Amazon S3 bucket for logging audio conversations", + "properties": { + "KmsKeyArn": { + "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$", + "type": "string" + }, + "LogPrefix": { + "description": "The Amazon S3 key of the deployment package.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "S3BucketArn": { + "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "required": [ + "LogPrefix", + "S3BucketArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Lex resources", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TextLogDestination": { + "additionalProperties": false, + "description": "Defines the Amazon CloudWatch Logs destination log group for conversation text logs.", + "properties": { + "CloudWatch": { + "$ref": "#/definitions/CloudWatchLogGroupLogDestination" + } + }, + "required": [ + "CloudWatch" + ], + "type": "object" + }, + "TextLogSetting": { + "additionalProperties": false, + "description": "Contains information about code hooks that Amazon Lex calls during a conversation.", + "properties": { + "Destination": { + "$ref": "#/definitions/TextLogDestination" + }, + "Enabled": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "Destination", + "Enabled" + ], + "type": "object" + }, + "TextLogSettings": { + "description": "List of text log settings", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TextLogSetting" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "description": "A Bot Alias enables you to change the version of a bot without updating applications that use the bot", + "handlers": { + "create": { + "permissions": [ + "lex:CreateBotAlias", + "lex:DescribeBot" + ] + }, + "delete": { + "permissions": [ + "lex:DeleteBotAlias" + ] + }, + "list": { + "permissions": [ + "lex:ListBotAliases" + ] + }, + "read": { + "permissions": [ + "lex:DescribeBotAlias" + ] + }, + "update": { + "permissions": [ + "lex:UpdateBotAlias", + "lex:DescribeBotAlias", + "lex:ListTagsForResource", + "lex:TagResource", + "lex:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/BotAliasId", + "/properties/BotId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "BotAliasId": { + "$ref": "#/definitions/Id" + }, + "BotAliasLocaleSettings": { + "$ref": "#/definitions/BotAliasLocaleSettingsList" + }, + "BotAliasName": { + "$ref": "#/definitions/Name" + }, + "BotAliasStatus": { + "$ref": "#/definitions/BotAliasStatus" + }, + "BotAliasTags": { + "description": "A list of tags to add to the bot alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "BotId": { + "$ref": "#/definitions/Id" + }, + "BotVersion": { + "$ref": "#/definitions/BotVersion" + }, + "ConversationLogSettings": { + "$ref": "#/definitions/ConversationLogSettings" + }, + "Description": { + "$ref": "#/definitions/Description" + }, + "SentimentAnalysisSettings": { + "additionalProperties": false, + "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.", + "properties": { + "DetectSentiment": { + "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex", + "type": "boolean" + } + }, + "required": [ + "DetectSentiment" + ], + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/BotAliasId", + "/properties/Arn", + "/properties/BotAliasStatus" + ], + "required": [ + "BotId", + "BotAliasName" + ], + "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBotAlias.html", + "taggable": false, + "typeName": "AWS::Lex::BotAlias", + "writeOnlyProperties": [ + "/properties/BotAliasTags" + ] +} diff --git a/schema/aws-lex-botversion.json b/schema/aws-lex-botversion.json index 0239c3d..b343c77 100644 --- a/schema/aws-lex-botversion.json +++ b/schema/aws-lex-botversion.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BotId" - ], - "definitions": { - "BotVersion": { - "description": "The version of a bot.", - "maxLength": 5, - "minLength": 1, - "pattern": "^(DRAFT|[0-9]+)$", - "type": "string" - }, - "BotVersionLocaleDetails": { - "additionalProperties": false, - "description": "The version of a bot used for a bot locale.", - "properties": { - "SourceBotVersion": { - "$ref": "#/definitions/BotVersion" - } - }, - "required": [ - "SourceBotVersion" - ], - "type": "object" - }, - "BotVersionLocaleSpecification": { - "additionalProperties": false, - "properties": { - "BotVersionLocaleDetails": { - "$ref": "#/definitions/BotVersionLocaleDetails" - }, - "LocaleId": { - "$ref": "#/definitions/LocaleId" - } - }, - "required": [ - "LocaleId", - "BotVersionLocaleDetails" - ], - "type": "object" - }, - "BotVersionLocaleSpecificationList": { - "description": "Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BotVersionLocaleSpecification" - }, - "minItems": 1, - "type": "array" - }, - "Description": { - "description": "A description of the version. Use the description to help identify the version in lists.", - "maxLength": 200, - "type": "string" - }, - "Id": { - "description": "Unique ID of resource", - "maxLength": 10, - "minLength": 10, - "pattern": "^[0-9a-zA-Z]+$", - "type": "string" - }, - "LocaleId": { - "description": "The identifier of the language and locale that the bot will be used in.", - "type": "string" - } - }, - "description": "A version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.", - "handlers": { - "create": { - "permissions": [ - "lex:CreateBotVersion", - "lex:DescribeBotVersion", - "lex:DescribeBot", - "lex:DescribeBotLocale", - "lex:BuildBotLocale" - ] - }, - "delete": { - "permissions": [ - "lex:DeleteBotVersion", - "lex:DescribeBotVersion" - ] - }, - "list": { - "permissions": [ - "lex:ListBotVersions" - ] - }, - "read": { - "permissions": [ - "lex:DescribeBotVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/BotId", - "/properties/BotVersion" - ], - "properties": { - "BotId": { - "$ref": "#/definitions/Id" - }, - "BotVersion": { - "$ref": "#/definitions/BotVersion" - }, - "BotVersionLocaleSpecification": { - "$ref": "#/definitions/BotVersionLocaleSpecificationList" - }, - "Description": { - "$ref": "#/definitions/Description" - } - }, - "readOnlyProperties": [ - "/properties/BotVersion" - ], - "required": [ - "BotId", - "BotVersionLocaleSpecification" - ], - "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBotVersion.html", - "taggable": false, - "typeName": "AWS::Lex::BotVersion", - "writeOnlyProperties": [ - "/properties/BotVersionLocaleSpecification" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BotId" + ], + "definitions": { + "BotVersion": { + "description": "The version of a bot.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]+)$", + "type": "string" + }, + "BotVersionLocaleDetails": { + "additionalProperties": false, + "description": "The version of a bot used for a bot locale.", + "properties": { + "SourceBotVersion": { + "$ref": "#/definitions/BotVersion" + } + }, + "required": [ + "SourceBotVersion" + ], + "type": "object" + }, + "BotVersionLocaleSpecification": { + "additionalProperties": false, + "properties": { + "BotVersionLocaleDetails": { + "$ref": "#/definitions/BotVersionLocaleDetails" + }, + "LocaleId": { + "$ref": "#/definitions/LocaleId" + } + }, + "required": [ + "LocaleId", + "BotVersionLocaleDetails" + ], + "type": "object" + }, + "BotVersionLocaleSpecificationList": { + "description": "Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BotVersionLocaleSpecification" + }, + "minItems": 1, + "type": "array" + }, + "Description": { + "description": "A description of the version. Use the description to help identify the version in lists.", + "maxLength": 200, + "type": "string" + }, + "Id": { + "description": "Unique ID of resource", + "maxLength": 10, + "minLength": 10, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "LocaleId": { + "description": "The identifier of the language and locale that the bot will be used in.", + "type": "string" + } + }, + "description": "A version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.", + "handlers": { + "create": { + "permissions": [ + "lex:CreateBotVersion", + "lex:DescribeBotVersion", + "lex:DescribeBot", + "lex:DescribeBotLocale", + "lex:BuildBotLocale" + ] + }, + "delete": { + "permissions": [ + "lex:DeleteBotVersion", + "lex:DescribeBotVersion" + ] + }, + "list": { + "permissions": [ + "lex:ListBotVersions" + ] + }, + "read": { + "permissions": [ + "lex:DescribeBotVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/BotId", + "/properties/BotVersion" + ], + "properties": { + "BotId": { + "$ref": "#/definitions/Id" + }, + "BotVersion": { + "$ref": "#/definitions/BotVersion" + }, + "BotVersionLocaleSpecification": { + "$ref": "#/definitions/BotVersionLocaleSpecificationList" + }, + "Description": { + "$ref": "#/definitions/Description" + } + }, + "readOnlyProperties": [ + "/properties/BotVersion" + ], + "required": [ + "BotId", + "BotVersionLocaleSpecification" + ], + "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBotVersion.html", + "taggable": false, + "typeName": "AWS::Lex::BotVersion", + "writeOnlyProperties": [ + "/properties/BotVersionLocaleSpecification" + ] +} diff --git a/schema/aws-lex-resourcepolicy.json b/schema/aws-lex-resourcepolicy.json index 6d38cc8..b1b7be4 100644 --- a/schema/aws-lex-resourcepolicy.json +++ b/schema/aws-lex-resourcepolicy.json @@ -1,90 +1,90 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ResourceArn" - ] - ], - "additionalProperties": false, - "definitions": { - "PhysicalId": { - "description": "The Physical ID of the resource policy.", - "type": "string" - }, - "Policy": { - "description": "A resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.", - "type": "object" - }, - "ResourceArn": { - "description": "The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.", - "maxLength": 1011, - "minLength": 1, - "type": "string" - }, - "RevisionId": { - "description": "The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.", - "maxLength": 5, - "minLength": 1, - "pattern": "^[0-9]+$", - "type": "string" - } - }, - "description": "A resource policy with specified policy statements that attaches to a Lex bot or bot alias.", - "handlers": { - "create": { - "permissions": [ - "lex:CreateResourcePolicy", - "lex:DescribeResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "lex:DeleteResourcePolicy", - "lex:DescribeResourcePolicy" - ] - }, - "list": { - "permissions": [ - "lex:DescribeResourcePolicy" - ] - }, - "read": { - "permissions": [ - "lex:DescribeResourcePolicy" - ] - }, - "update": { - "permissions": [ - "lex:UpdateResourcePolicy", - "lex:DescribeResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "$ref": "#/definitions/PhysicalId" - }, - "Policy": { - "$ref": "#/definitions/Policy" - }, - "ResourceArn": { - "$ref": "#/definitions/ResourceArn" - }, - "RevisionId": { - "$ref": "#/definitions/RevisionId" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/RevisionId" - ], - "required": [ - "ResourceArn", - "Policy" - ], - "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies", - "taggable": false, - "typeName": "AWS::Lex::ResourcePolicy" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ResourceArn" + ] + ], + "additionalProperties": false, + "definitions": { + "PhysicalId": { + "description": "The Physical ID of the resource policy.", + "type": "string" + }, + "Policy": { + "description": "A resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.", + "type": "object" + }, + "ResourceArn": { + "description": "The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.", + "maxLength": 1011, + "minLength": 1, + "type": "string" + }, + "RevisionId": { + "description": "The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.", + "maxLength": 5, + "minLength": 1, + "pattern": "^[0-9]+$", + "type": "string" + } + }, + "description": "A resource policy with specified policy statements that attaches to a Lex bot or bot alias.", + "handlers": { + "create": { + "permissions": [ + "lex:CreateResourcePolicy", + "lex:DescribeResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "lex:DeleteResourcePolicy", + "lex:DescribeResourcePolicy" + ] + }, + "list": { + "permissions": [ + "lex:DescribeResourcePolicy" + ] + }, + "read": { + "permissions": [ + "lex:DescribeResourcePolicy" + ] + }, + "update": { + "permissions": [ + "lex:UpdateResourcePolicy", + "lex:DescribeResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "$ref": "#/definitions/PhysicalId" + }, + "Policy": { + "$ref": "#/definitions/Policy" + }, + "ResourceArn": { + "$ref": "#/definitions/ResourceArn" + }, + "RevisionId": { + "$ref": "#/definitions/RevisionId" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/RevisionId" + ], + "required": [ + "ResourceArn", + "Policy" + ], + "sourceUrl": "https://docs.aws.amazon.com/lexv2/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies", + "taggable": false, + "typeName": "AWS::Lex::ResourcePolicy" +} diff --git a/schema/aws-licensemanager-grant.json b/schema/aws-licensemanager-grant.json index 9cd9abc..dac9230 100644 --- a/schema/aws-licensemanager-grant.json +++ b/schema/aws-licensemanager-grant.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "definitions": { - "Arn": { - "maxLength": 2048, - "type": "string" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "license-manager:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "license-manager:DeleteGrant" - ] - }, - "list": { - "permissions": [ - "license-manager:ListDistributedGrants" - ] - }, - "read": { - "permissions": [ - "license-manager:GetGrant" - ] - }, - "update": { - "permissions": [ - "license-manager:CreateGrantVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/GrantArn" - ], - "properties": { - "AllowedOperations": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "GrantArn": { - "$ref": "#/definitions/Arn", - "description": "Arn of the grant." - }, - "GrantName": { - "description": "Name for the created Grant.", - "type": "string" - }, - "HomeRegion": { - "description": "Home region for the created grant.", - "type": "string" - }, - "LicenseArn": { - "$ref": "#/definitions/Arn", - "description": "License Arn for the grant." - }, - "Principals": { - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array", - "uniqueItems": true - }, - "Status": { - "type": "string" - }, - "Version": { - "description": "The version of the grant.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/GrantArn", - "/properties/Version" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::LicenseManager::Grant", - "writeOnlyProperties": [ - "/properties/Principals", - "/properties/AllowedOperations", - "/properties/Status" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Arn": { + "maxLength": 2048, + "type": "string" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "license-manager:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "license-manager:DeleteGrant" + ] + }, + "list": { + "permissions": [ + "license-manager:ListDistributedGrants" + ] + }, + "read": { + "permissions": [ + "license-manager:GetGrant" + ] + }, + "update": { + "permissions": [ + "license-manager:CreateGrantVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/GrantArn" + ], + "properties": { + "AllowedOperations": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "GrantArn": { + "$ref": "#/definitions/Arn", + "description": "Arn of the grant." + }, + "GrantName": { + "description": "Name for the created Grant.", + "type": "string" + }, + "HomeRegion": { + "description": "Home region for the created grant.", + "type": "string" + }, + "LicenseArn": { + "$ref": "#/definitions/Arn", + "description": "License Arn for the grant." + }, + "Principals": { + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array", + "uniqueItems": true + }, + "Status": { + "type": "string" + }, + "Version": { + "description": "The version of the grant.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/GrantArn", + "/properties/Version" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::LicenseManager::Grant", + "writeOnlyProperties": [ + "/properties/Principals", + "/properties/AllowedOperations", + "/properties/Status" + ] +} diff --git a/schema/aws-licensemanager-license.json b/schema/aws-licensemanager-license.json index a4f9d4b..13c209b 100644 --- a/schema/aws-licensemanager-license.json +++ b/schema/aws-licensemanager-license.json @@ -1,241 +1,241 @@ -{ - "additionalProperties": false, - "definitions": { - "Arn": { - "maxLength": 2048, - "type": "string" - }, - "BorrowConfiguration": { - "additionalProperties": false, - "properties": { - "AllowEarlyCheckIn": { - "type": "boolean" - }, - "MaxTimeToLiveInMinutes": { - "type": "integer" - } - }, - "required": [ - "MaxTimeToLiveInMinutes", - "AllowEarlyCheckIn" - ], - "type": "object" - }, - "ConsumptionConfiguration": { - "additionalProperties": false, - "properties": { - "BorrowConfiguration": { - "$ref": "#/definitions/BorrowConfiguration" - }, - "ProvisionalConfiguration": { - "$ref": "#/definitions/ProvisionalConfiguration" - }, - "RenewType": { - "type": "string" - } - }, - "type": "object" - }, - "Entitlement": { - "additionalProperties": false, - "properties": { - "AllowCheckIn": { - "type": "boolean" - }, - "MaxCount": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "Overage": { - "type": "boolean" - }, - "Unit": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Unit" - ], - "type": "object" - }, - "IssuerData": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SignKey": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "LicenseStatus": { - "type": "string" - }, - "Metadata": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "ProvisionalConfiguration": { - "additionalProperties": false, - "properties": { - "MaxTimeToLiveInMinutes": { - "type": "integer" - } - }, - "required": [ - "MaxTimeToLiveInMinutes" - ], - "type": "object" - }, - "ValidityDateFormat": { - "additionalProperties": false, - "properties": { - "Begin": { - "description": "Validity begin date for the license.", - "format": "date-time", - "type": "string" - }, - "End": { - "description": "Validity begin date for the license.", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "Begin", - "End" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::LicenseManager::License", - "handlers": { - "create": { - "permissions": [ - "license-manager:CreateLicense" - ] - }, - "delete": { - "permissions": [ - "license-manager:DeleteLicense" - ] - }, - "list": { - "permissions": [ - "license-manager:ListLicenses" - ] - }, - "read": { - "permissions": [ - "license-manager:GetLicense" - ] - }, - "update": { - "permissions": [ - "license-manager:CreateLicenseVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/LicenseArn" - ], - "properties": { - "Beneficiary": { - "description": "Beneficiary of the license.", - "type": "string" - }, - "ConsumptionConfiguration": { - "$ref": "#/definitions/ConsumptionConfiguration" - }, - "Entitlements": { - "items": { - "$ref": "#/definitions/Entitlement" - }, - "type": "array", - "uniqueItems": true - }, - "HomeRegion": { - "description": "Home region for the created license.", - "type": "string" - }, - "Issuer": { - "$ref": "#/definitions/IssuerData" - }, - "LicenseArn": { - "$ref": "#/definitions/Arn", - "description": "Amazon Resource Name is a unique name for each resource." - }, - "LicenseMetadata": { - "items": { - "$ref": "#/definitions/Metadata" - }, - "type": "array", - "uniqueItems": true - }, - "LicenseName": { - "description": "Name for the created license.", - "type": "string" - }, - "ProductName": { - "description": "Product name for the created license.", - "type": "string" - }, - "ProductSKU": { - "description": "ProductSKU of the license.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/LicenseStatus" - }, - "Validity": { - "$ref": "#/definitions/ValidityDateFormat" - }, - "Version": { - "description": "The version of the license.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LicenseArn", - "/properties/Version" - ], - "required": [ - "LicenseName", - "ProductName", - "Issuer", - "HomeRegion", - "Validity", - "ConsumptionConfiguration", - "Entitlements" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-licensemanager.git", - "typeName": "AWS::LicenseManager::License", - "writeOnlyProperties": [ - "/properties/Status" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Arn": { + "maxLength": 2048, + "type": "string" + }, + "BorrowConfiguration": { + "additionalProperties": false, + "properties": { + "AllowEarlyCheckIn": { + "type": "boolean" + }, + "MaxTimeToLiveInMinutes": { + "type": "integer" + } + }, + "required": [ + "MaxTimeToLiveInMinutes", + "AllowEarlyCheckIn" + ], + "type": "object" + }, + "ConsumptionConfiguration": { + "additionalProperties": false, + "properties": { + "BorrowConfiguration": { + "$ref": "#/definitions/BorrowConfiguration" + }, + "ProvisionalConfiguration": { + "$ref": "#/definitions/ProvisionalConfiguration" + }, + "RenewType": { + "type": "string" + } + }, + "type": "object" + }, + "Entitlement": { + "additionalProperties": false, + "properties": { + "AllowCheckIn": { + "type": "boolean" + }, + "MaxCount": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "Overage": { + "type": "boolean" + }, + "Unit": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Name", + "Unit" + ], + "type": "object" + }, + "IssuerData": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "SignKey": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LicenseStatus": { + "type": "string" + }, + "Metadata": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "ProvisionalConfiguration": { + "additionalProperties": false, + "properties": { + "MaxTimeToLiveInMinutes": { + "type": "integer" + } + }, + "required": [ + "MaxTimeToLiveInMinutes" + ], + "type": "object" + }, + "ValidityDateFormat": { + "additionalProperties": false, + "properties": { + "Begin": { + "description": "Validity begin date for the license.", + "format": "date-time", + "type": "string" + }, + "End": { + "description": "Validity begin date for the license.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "Begin", + "End" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::LicenseManager::License", + "handlers": { + "create": { + "permissions": [ + "license-manager:CreateLicense" + ] + }, + "delete": { + "permissions": [ + "license-manager:DeleteLicense" + ] + }, + "list": { + "permissions": [ + "license-manager:ListLicenses" + ] + }, + "read": { + "permissions": [ + "license-manager:GetLicense" + ] + }, + "update": { + "permissions": [ + "license-manager:CreateLicenseVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/LicenseArn" + ], + "properties": { + "Beneficiary": { + "description": "Beneficiary of the license.", + "type": "string" + }, + "ConsumptionConfiguration": { + "$ref": "#/definitions/ConsumptionConfiguration" + }, + "Entitlements": { + "items": { + "$ref": "#/definitions/Entitlement" + }, + "type": "array", + "uniqueItems": true + }, + "HomeRegion": { + "description": "Home region for the created license.", + "type": "string" + }, + "Issuer": { + "$ref": "#/definitions/IssuerData" + }, + "LicenseArn": { + "$ref": "#/definitions/Arn", + "description": "Amazon Resource Name is a unique name for each resource." + }, + "LicenseMetadata": { + "items": { + "$ref": "#/definitions/Metadata" + }, + "type": "array", + "uniqueItems": true + }, + "LicenseName": { + "description": "Name for the created license.", + "type": "string" + }, + "ProductName": { + "description": "Product name for the created license.", + "type": "string" + }, + "ProductSKU": { + "description": "ProductSKU of the license.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/LicenseStatus" + }, + "Validity": { + "$ref": "#/definitions/ValidityDateFormat" + }, + "Version": { + "description": "The version of the license.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LicenseArn", + "/properties/Version" + ], + "required": [ + "LicenseName", + "ProductName", + "Issuer", + "HomeRegion", + "Validity", + "ConsumptionConfiguration", + "Entitlements" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-licensemanager.git", + "typeName": "AWS::LicenseManager::License", + "writeOnlyProperties": [ + "/properties/Status" + ] +} diff --git a/schema/aws-lightsail-alarm.json b/schema/aws-lightsail-alarm.json index 8efe9dc..203733c 100644 --- a/schema/aws-lightsail-alarm.json +++ b/schema/aws-lightsail-alarm.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AlarmName", - "/properties/MonitoredResourceName", - "/properties/MetricName" - ], - "description": "Resource Type definition for AWS::Lightsail::Alarm", - "handlers": { - "create": { - "permissions": [ - "lightsail:PutAlarm", - "lightsail:GetAlarms" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteAlarm", - "lightsail:GetAlarms" - ] - }, - "list": { - "permissions": [ - "lightsail:GetAlarms" - ] - }, - "read": { - "permissions": [ - "lightsail:GetAlarms" - ] - }, - "update": { - "permissions": [ - "lightsail:PutAlarm", - "lightsail:GetAlarms" - ] - } - }, - "primaryIdentifier": [ - "/properties/AlarmName" - ], - "properties": { - "AlarmArn": { - "type": "string" - }, - "AlarmName": { - "description": "The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.", - "pattern": "\\w[\\w\\-]*\\w", - "type": "string" - }, - "ComparisonOperator": { - "description": "The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.", - "type": "string" - }, - "ContactProtocols": { - "description": "The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "DatapointsToAlarm": { - "description": "The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm) is the M.", - "type": "integer" - }, - "EvaluationPeriods": { - "description": "The number of most recent periods over which data is compared to the specified threshold. If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the N.", - "type": "integer" - }, - "MetricName": { - "description": "The name of the metric to associate with the alarm.", - "type": "string" - }, - "MonitoredResourceName": { - "description": "The name of the Lightsail resource that the alarm monitors.", - "type": "string" - }, - "NotificationEnabled": { - "description": "Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.", - "type": "boolean" - }, - "NotificationTriggers": { - "description": "The alarm states that trigger a notification.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "State": { - "description": "The current state of the alarm.", - "type": "string" - }, - "Threshold": { - "description": "The value against which the specified statistic is compared.", - "type": "number" - }, - "TreatMissingData": { - "description": "Sets how this alarm will handle missing data points.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AlarmArn", - "/properties/State" - ], - "required": [ - "AlarmName", - "MonitoredResourceName", - "MetricName", - "ComparisonOperator", - "EvaluationPeriods", - "Threshold" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Alarm" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AlarmName", + "/properties/MonitoredResourceName", + "/properties/MetricName" + ], + "description": "Resource Type definition for AWS::Lightsail::Alarm", + "handlers": { + "create": { + "permissions": [ + "lightsail:PutAlarm", + "lightsail:GetAlarms" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteAlarm", + "lightsail:GetAlarms" + ] + }, + "list": { + "permissions": [ + "lightsail:GetAlarms" + ] + }, + "read": { + "permissions": [ + "lightsail:GetAlarms" + ] + }, + "update": { + "permissions": [ + "lightsail:PutAlarm", + "lightsail:GetAlarms" + ] + } + }, + "primaryIdentifier": [ + "/properties/AlarmName" + ], + "properties": { + "AlarmArn": { + "type": "string" + }, + "AlarmName": { + "description": "The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.", + "pattern": "\\w[\\w\\-]*\\w", + "type": "string" + }, + "ComparisonOperator": { + "description": "The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.", + "type": "string" + }, + "ContactProtocols": { + "description": "The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "DatapointsToAlarm": { + "description": "The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm) is the M.", + "type": "integer" + }, + "EvaluationPeriods": { + "description": "The number of most recent periods over which data is compared to the specified threshold. If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the N.", + "type": "integer" + }, + "MetricName": { + "description": "The name of the metric to associate with the alarm.", + "type": "string" + }, + "MonitoredResourceName": { + "description": "The name of the Lightsail resource that the alarm monitors.", + "type": "string" + }, + "NotificationEnabled": { + "description": "Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.", + "type": "boolean" + }, + "NotificationTriggers": { + "description": "The alarm states that trigger a notification.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "State": { + "description": "The current state of the alarm.", + "type": "string" + }, + "Threshold": { + "description": "The value against which the specified statistic is compared.", + "type": "number" + }, + "TreatMissingData": { + "description": "Sets how this alarm will handle missing data points.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AlarmArn", + "/properties/State" + ], + "required": [ + "AlarmName", + "MonitoredResourceName", + "MetricName", + "ComparisonOperator", + "EvaluationPeriods", + "Threshold" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::Alarm" +} diff --git a/schema/aws-lightsail-bucket.json b/schema/aws-lightsail-bucket.json index 9931011..9b3a9f4 100644 --- a/schema/aws-lightsail-bucket.json +++ b/schema/aws-lightsail-bucket.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BucketName" - ], - "definitions": { - "AccessRules": { - "additionalProperties": false, - "description": "An object that sets the public accessibility of objects in the specified bucket.", - "properties": { - "AllowPublicOverrides": { - "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.", - "type": "boolean" - }, - "GetObject": { - "description": "Specifies the anonymous access to all objects in a bucket.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Bucket", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateBucket", - "lightsail:GetBuckets", - "lightsail:GetInstance", - "lightsail:UpdateBucket", - "lightsail:UpdateBucketBundle", - "lightsail:SetResourceAccessForBucket", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteBucket", - "lightsail:GetBuckets" - ] - }, - "list": { - "permissions": [ - "lightsail:GetBuckets" - ] - }, - "read": { - "permissions": [ - "lightsail:GetBuckets" - ] - }, - "update": { - "permissions": [ - "lightsail:GetBuckets", - "lightsail:GetInstance", - "lightsail:UpdateBucket", - "lightsail:UpdateBucketBundle", - "lightsail:SetResourceAccessForBucket", - "lightsail:TagResource", - "lightsail:UntagResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/BucketName" - ], - "properties": { - "AbleToUpdateBundle": { - "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.", - "type": "boolean" - }, - "AccessRules": { - "$ref": "#/definitions/AccessRules" - }, - "BucketArn": { - "type": "string" - }, - "BucketName": { - "description": "The name for the bucket.", - "maxLength": 54, - "minLength": 3, - "pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$", - "type": "string" - }, - "BundleId": { - "description": "The ID of the bundle to use for the bucket.", - "type": "string" - }, - "ObjectVersioning": { - "description": "Specifies whether to enable or disable versioning of objects in the bucket.", - "type": "boolean" - }, - "ReadOnlyAccessAccounts": { - "description": "An array of strings to specify the AWS account IDs that can access the bucket.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ResourcesReceivingAccess": { - "description": "The names of the Lightsail resources for which to set bucket access.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Url": { - "description": "The URL of the bucket.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/BucketArn", - "/properties/Url", - "/properties/AbleToUpdateBundle" - ], - "required": [ - "BucketName", - "BundleId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Bucket" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BucketName" + ], + "definitions": { + "AccessRules": { + "additionalProperties": false, + "description": "An object that sets the public accessibility of objects in the specified bucket.", + "properties": { + "AllowPublicOverrides": { + "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.", + "type": "boolean" + }, + "GetObject": { + "description": "Specifies the anonymous access to all objects in a bucket.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Bucket", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateBucket", + "lightsail:GetBuckets", + "lightsail:GetInstance", + "lightsail:UpdateBucket", + "lightsail:UpdateBucketBundle", + "lightsail:SetResourceAccessForBucket", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteBucket", + "lightsail:GetBuckets" + ] + }, + "list": { + "permissions": [ + "lightsail:GetBuckets" + ] + }, + "read": { + "permissions": [ + "lightsail:GetBuckets" + ] + }, + "update": { + "permissions": [ + "lightsail:GetBuckets", + "lightsail:GetInstance", + "lightsail:UpdateBucket", + "lightsail:UpdateBucketBundle", + "lightsail:SetResourceAccessForBucket", + "lightsail:TagResource", + "lightsail:UntagResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/BucketName" + ], + "properties": { + "AbleToUpdateBundle": { + "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.", + "type": "boolean" + }, + "AccessRules": { + "$ref": "#/definitions/AccessRules" + }, + "BucketArn": { + "type": "string" + }, + "BucketName": { + "description": "The name for the bucket.", + "maxLength": 54, + "minLength": 3, + "pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$", + "type": "string" + }, + "BundleId": { + "description": "The ID of the bundle to use for the bucket.", + "type": "string" + }, + "ObjectVersioning": { + "description": "Specifies whether to enable or disable versioning of objects in the bucket.", + "type": "boolean" + }, + "ReadOnlyAccessAccounts": { + "description": "An array of strings to specify the AWS account IDs that can access the bucket.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ResourcesReceivingAccess": { + "description": "The names of the Lightsail resources for which to set bucket access.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Url": { + "description": "The URL of the bucket.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BucketArn", + "/properties/Url", + "/properties/AbleToUpdateBundle" + ], + "required": [ + "BucketName", + "BundleId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::Bucket" +} diff --git a/schema/aws-lightsail-certificate.json b/schema/aws-lightsail-certificate.json index 65ea904..7d537a5 100644 --- a/schema/aws-lightsail-certificate.json +++ b/schema/aws-lightsail-certificate.json @@ -1,115 +1,115 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateName", - "/properties/DomainName", - "/properties/SubjectAlternativeNames" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Certificate.", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateCertificate", - "lightsail:GetCertificates", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteCertificate", - "lightsail:GetCertificates" - ] - }, - "list": { - "permissions": [ - "lightsail:GetCertificates" - ] - }, - "read": { - "permissions": [ - "lightsail:GetCertificates" - ] - }, - "update": { - "permissions": [ - "lightsail:GetCertificates", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateName" - ], - "properties": { - "CertificateArn": { - "type": "string" - }, - "CertificateName": { - "description": "The name for the certificate.", - "type": "string" - }, - "DomainName": { - "description": "The domain name (e.g., example.com ) for the certificate.", - "type": "string" - }, - "Status": { - "description": "The validation status of the certificate.", - "type": "string" - }, - "SubjectAlternativeNames": { - "description": "An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/CertificateArn", - "/properties/Status" - ], - "required": [ - "CertificateName", - "DomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::Lightsail::Certificate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateName", + "/properties/DomainName", + "/properties/SubjectAlternativeNames" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Certificate.", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateCertificate", + "lightsail:GetCertificates", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteCertificate", + "lightsail:GetCertificates" + ] + }, + "list": { + "permissions": [ + "lightsail:GetCertificates" + ] + }, + "read": { + "permissions": [ + "lightsail:GetCertificates" + ] + }, + "update": { + "permissions": [ + "lightsail:GetCertificates", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateName" + ], + "properties": { + "CertificateArn": { + "type": "string" + }, + "CertificateName": { + "description": "The name for the certificate.", + "type": "string" + }, + "DomainName": { + "description": "The domain name (e.g., example.com ) for the certificate.", + "type": "string" + }, + "Status": { + "description": "The validation status of the certificate.", + "type": "string" + }, + "SubjectAlternativeNames": { + "description": "An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/CertificateArn", + "/properties/Status" + ], + "required": [ + "CertificateName", + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::Lightsail::Certificate" +} diff --git a/schema/aws-lightsail-container.json b/schema/aws-lightsail-container.json index 3f70d58..3458904 100644 --- a/schema/aws-lightsail-container.json +++ b/schema/aws-lightsail-container.json @@ -1,323 +1,323 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceName" - ], - "definitions": { - "Container": { - "additionalProperties": false, - "description": "Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.", - "properties": { - "Command": { - "description": "The launch command for the container.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ContainerName": { - "description": "The name of the container.", - "type": "string" - }, - "Environment": { - "description": "The environment variables of the container.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": true - }, - "Image": { - "description": "The name of the image used for the container.", - "type": "string" - }, - "Ports": { - "description": "The open firewall ports of the container.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PortInfo" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ContainerServiceDeployment": { - "additionalProperties": false, - "description": "Describes a container deployment configuration of an Amazon Lightsail container service.", - "properties": { - "Containers": { - "description": "An object that describes the configuration for the containers of the deployment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Container" - }, - "type": "array", - "uniqueItems": true - }, - "PublicEndpoint": { - "$ref": "#/definitions/PublicEndpoint", - "description": "An object that describes the endpoint of the deployment." - } - }, - "type": "object" - }, - "EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - }, - "Variable": { - "type": "string" - } - }, - "type": "object" - }, - "HealthCheckConfig": { - "additionalProperties": false, - "description": "Describes the health check configuration of an Amazon Lightsail container service.", - "properties": { - "HealthyThreshold": { - "description": "The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.", - "type": "integer" - }, - "IntervalSeconds": { - "description": "The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.", - "type": "integer" - }, - "Path": { - "description": "The path on the container on which to perform the health check. The default value is /.", - "type": "string" - }, - "SuccessCodes": { - "description": "The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).", - "type": "string" - }, - "TimeoutSeconds": { - "description": "The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.", - "type": "integer" - }, - "UnhealthyThreshold": { - "description": "The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.", - "type": "integer" - } - }, - "type": "object" - }, - "PortInfo": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "string" - }, - "Protocol": { - "type": "string" - } - }, - "type": "object" - }, - "PrivateRegistryAccess": { - "additionalProperties": false, - "description": "An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.", - "properties": { - "EcrImagePullerRole": { - "additionalProperties": false, - "description": "An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.", - "properties": { - "IsActive": { - "description": "A Boolean value that indicates whether to activate the role.", - "type": "boolean" - }, - "PrincipalArn": { - "description": "The Amazon Resource Name (ARN) of the role, if it is activated.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "PublicDomainName": { - "additionalProperties": false, - "description": "The public domain name to use with the container service, such as example.com and www.example.com.", - "properties": { - "CertificateName": { - "type": "string" - }, - "DomainNames": { - "description": "An object that describes the configuration for the containers of the deployment.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "PublicEndpoint": { - "additionalProperties": false, - "description": "Describes the settings of a public endpoint for an Amazon Lightsail container service.", - "properties": { - "ContainerName": { - "description": "The name of the container for the endpoint.", - "type": "string" - }, - "ContainerPort": { - "description": "The port of the container to which traffic is forwarded to.", - "type": "integer" - }, - "HealthCheckConfig": { - "$ref": "#/definitions/HealthCheckConfig", - "description": "An object that describes the health check configuration of the container." - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Container", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateContainerService", - "lightsail:CreateContainerServiceDeployment", - "lightsail:GetContainerServices", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateContainerService" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteContainerService", - "lightsail:GetContainerServices" - ] - }, - "list": { - "permissions": [ - "lightsail:GetContainerServices" - ] - }, - "read": { - "permissions": [ - "lightsail:GetContainerServices" - ] - }, - "update": { - "permissions": [ - "lightsail:CreateContainerServiceDeployment", - "lightsail:GetContainerServices", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateContainerService" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/ServiceName" - ], - "properties": { - "ContainerArn": { - "type": "string" - }, - "ContainerServiceDeployment": { - "$ref": "#/definitions/ContainerServiceDeployment", - "description": "Describes a container deployment configuration of an Amazon Lightsail container service." - }, - "IsDisabled": { - "description": "A Boolean value to indicate whether the container service is disabled.", - "type": "boolean" - }, - "Power": { - "description": "The power specification for the container service.", - "type": "string" - }, - "PrincipalArn": { - "description": "The principal ARN of the container service.", - "type": "string" - }, - "PrivateRegistryAccess": { - "$ref": "#/definitions/PrivateRegistryAccess", - "description": "A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories." - }, - "PublicDomainNames": { - "description": "The public domain names to use with the container service, such as example.com and www.example.com.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/PublicDomainName" - }, - "type": "array", - "uniqueItems": true - }, - "Scale": { - "description": "The scale specification for the container service.", - "maximum": 20, - "minimum": 1, - "type": "integer" - }, - "ServiceName": { - "description": "The name for the container service.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Url": { - "description": "The publicly accessible URL of the container service.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ContainerArn", - "/properties/Url", - "/properties/PrincipalArn", - "/properties/PrivateRegistryAccess/EcrImagePullerRole/PrincipalArn" - ], - "required": [ - "ServiceName", - "Power", - "Scale" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Container" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceName" + ], + "definitions": { + "Container": { + "additionalProperties": false, + "description": "Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.", + "properties": { + "Command": { + "description": "The launch command for the container.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ContainerName": { + "description": "The name of the container.", + "type": "string" + }, + "Environment": { + "description": "The environment variables of the container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": true + }, + "Image": { + "description": "The name of the image used for the container.", + "type": "string" + }, + "Ports": { + "description": "The open firewall ports of the container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PortInfo" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ContainerServiceDeployment": { + "additionalProperties": false, + "description": "Describes a container deployment configuration of an Amazon Lightsail container service.", + "properties": { + "Containers": { + "description": "An object that describes the configuration for the containers of the deployment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Container" + }, + "type": "array", + "uniqueItems": true + }, + "PublicEndpoint": { + "$ref": "#/definitions/PublicEndpoint", + "description": "An object that describes the endpoint of the deployment." + } + }, + "type": "object" + }, + "EnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Value": { + "type": "string" + }, + "Variable": { + "type": "string" + } + }, + "type": "object" + }, + "HealthCheckConfig": { + "additionalProperties": false, + "description": "Describes the health check configuration of an Amazon Lightsail container service.", + "properties": { + "HealthyThreshold": { + "description": "The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.", + "type": "integer" + }, + "IntervalSeconds": { + "description": "The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.", + "type": "integer" + }, + "Path": { + "description": "The path on the container on which to perform the health check. The default value is /.", + "type": "string" + }, + "SuccessCodes": { + "description": "The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).", + "type": "string" + }, + "TimeoutSeconds": { + "description": "The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.", + "type": "integer" + }, + "UnhealthyThreshold": { + "description": "The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.", + "type": "integer" + } + }, + "type": "object" + }, + "PortInfo": { + "additionalProperties": false, + "properties": { + "Port": { + "type": "string" + }, + "Protocol": { + "type": "string" + } + }, + "type": "object" + }, + "PrivateRegistryAccess": { + "additionalProperties": false, + "description": "An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.", + "properties": { + "EcrImagePullerRole": { + "additionalProperties": false, + "description": "An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.", + "properties": { + "IsActive": { + "description": "A Boolean value that indicates whether to activate the role.", + "type": "boolean" + }, + "PrincipalArn": { + "description": "The Amazon Resource Name (ARN) of the role, if it is activated.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "PublicDomainName": { + "additionalProperties": false, + "description": "The public domain name to use with the container service, such as example.com and www.example.com.", + "properties": { + "CertificateName": { + "type": "string" + }, + "DomainNames": { + "description": "An object that describes the configuration for the containers of the deployment.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "PublicEndpoint": { + "additionalProperties": false, + "description": "Describes the settings of a public endpoint for an Amazon Lightsail container service.", + "properties": { + "ContainerName": { + "description": "The name of the container for the endpoint.", + "type": "string" + }, + "ContainerPort": { + "description": "The port of the container to which traffic is forwarded to.", + "type": "integer" + }, + "HealthCheckConfig": { + "$ref": "#/definitions/HealthCheckConfig", + "description": "An object that describes the health check configuration of the container." + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Container", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateContainerService", + "lightsail:CreateContainerServiceDeployment", + "lightsail:GetContainerServices", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateContainerService" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteContainerService", + "lightsail:GetContainerServices" + ] + }, + "list": { + "permissions": [ + "lightsail:GetContainerServices" + ] + }, + "read": { + "permissions": [ + "lightsail:GetContainerServices" + ] + }, + "update": { + "permissions": [ + "lightsail:CreateContainerServiceDeployment", + "lightsail:GetContainerServices", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateContainerService" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/ServiceName" + ], + "properties": { + "ContainerArn": { + "type": "string" + }, + "ContainerServiceDeployment": { + "$ref": "#/definitions/ContainerServiceDeployment", + "description": "Describes a container deployment configuration of an Amazon Lightsail container service." + }, + "IsDisabled": { + "description": "A Boolean value to indicate whether the container service is disabled.", + "type": "boolean" + }, + "Power": { + "description": "The power specification for the container service.", + "type": "string" + }, + "PrincipalArn": { + "description": "The principal ARN of the container service.", + "type": "string" + }, + "PrivateRegistryAccess": { + "$ref": "#/definitions/PrivateRegistryAccess", + "description": "A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories." + }, + "PublicDomainNames": { + "description": "The public domain names to use with the container service, such as example.com and www.example.com.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PublicDomainName" + }, + "type": "array", + "uniqueItems": true + }, + "Scale": { + "description": "The scale specification for the container service.", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "ServiceName": { + "description": "The name for the container service.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Url": { + "description": "The publicly accessible URL of the container service.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ContainerArn", + "/properties/Url", + "/properties/PrincipalArn", + "/properties/PrivateRegistryAccess/EcrImagePullerRole/PrincipalArn" + ], + "required": [ + "ServiceName", + "Power", + "Scale" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::Container" +} diff --git a/schema/aws-lightsail-database.json b/schema/aws-lightsail-database.json index a6595a0..873a715 100644 --- a/schema/aws-lightsail-database.json +++ b/schema/aws-lightsail-database.json @@ -1,231 +1,231 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RelationalDatabaseName", - "/properties/AvailabilityZone", - "/properties/RelationalDatabaseBlueprintId", - "/properties/RelationalDatabaseBundleId", - "/properties/MasterDatabaseName", - "/properties/MasterUsername" - ], - "definitions": { - "RelationalDatabaseParameter": { - "additionalProperties": false, - "description": "Describes the parameters of the database.", - "properties": { - "AllowedValues": { - "description": "Specifies the valid range of values for the parameter.", - "type": "string" - }, - "ApplyMethod": { - "description": "Indicates when parameter updates are applied. Can be immediate or pending-reboot.", - "type": "string" - }, - "ApplyType": { - "description": "Specifies the engine-specific parameter type.", - "type": "string" - }, - "DataType": { - "description": "Specifies the valid data type for the parameter.", - "type": "string" - }, - "Description": { - "description": "Provides a description of the parameter.", - "type": "string" - }, - "IsModifiable": { - "description": "A Boolean value indicating whether the parameter can be modified.", - "type": "boolean" - }, - "ParameterName": { - "description": "Specifies the name of the parameter.", - "type": "string" - }, - "ParameterValue": { - "description": "Specifies the value of the parameter.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Database", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateRelationalDatabase", - "lightsail:GetRelationalDatabase", - "lightsail:GetRelationalDatabases", - "lightsail:GetRegions", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateRelationalDatabase", - "lightsail:UpdateRelationalDatabaseParameters" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteRelationalDatabase", - "lightsail:GetRelationalDatabase", - "lightsail:GetRelationalDatabases" - ] - }, - "list": { - "permissions": [ - "lightsail:GetRelationalDatabases" - ] - }, - "read": { - "permissions": [ - "lightsail:GetRelationalDatabase", - "lightsail:GetRelationalDatabases" - ] - }, - "update": { - "permissions": [ - "lightsail:GetRelationalDatabase", - "lightsail:GetRelationalDatabases", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateRelationalDatabase", - "lightsail:UpdateRelationalDatabaseParameters" - ] - } - }, - "primaryIdentifier": [ - "/properties/RelationalDatabaseName" - ], - "properties": { - "AvailabilityZone": { - "description": "The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "BackupRetention": { - "description": "When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.", - "type": "boolean" - }, - "CaCertificateIdentifier": { - "description": "Indicates the certificate that needs to be associated with the database.", - "type": "string" - }, - "DatabaseArn": { - "type": "string" - }, - "MasterDatabaseName": { - "description": "The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "MasterUserPassword": { - "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\". It cannot contain spaces.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "MasterUsername": { - "description": "The name for the master user.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "PreferredBackupWindow": { - "description": "The daily time range during which automated backups are created for your new database if automated backups are enabled.", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "description": "The weekly time range during which system maintenance can occur on your new database.", - "type": "string" - }, - "PubliclyAccessible": { - "description": "Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.", - "type": "boolean" - }, - "RelationalDatabaseBlueprintId": { - "description": "The blueprint ID for your new database. A blueprint describes the major engine version of a database.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RelationalDatabaseBundleId": { - "description": "The bundle ID for your new database. A bundle describes the performance specifications for your database.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RelationalDatabaseName": { - "description": "The name to use for your new Lightsail database resource.", - "maxLength": 255, - "minLength": 2, - "pattern": "\\w[\\w\\-]*\\w", - "type": "string" - }, - "RelationalDatabaseParameters": { - "description": "Update one or more parameters of the relational database.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RelationalDatabaseParameter" - }, - "type": "array", - "uniqueItems": true - }, - "RotateMasterUserPassword": { - "description": "When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.", - "type": "boolean" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)" - }, - "readOnlyProperties": [ - "/properties/DatabaseArn" - ], - "required": [ - "RelationalDatabaseName", - "RelationalDatabaseBlueprintId", - "RelationalDatabaseBundleId", - "MasterDatabaseName", - "MasterUsername" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Database", - "writeOnlyProperties": [ - "/properties/MasterUserPassword", - "/properties/RelationalDatabaseParameters", - "/properties/RotateMasterUserPassword" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RelationalDatabaseName", + "/properties/AvailabilityZone", + "/properties/RelationalDatabaseBlueprintId", + "/properties/RelationalDatabaseBundleId", + "/properties/MasterDatabaseName", + "/properties/MasterUsername" + ], + "definitions": { + "RelationalDatabaseParameter": { + "additionalProperties": false, + "description": "Describes the parameters of the database.", + "properties": { + "AllowedValues": { + "description": "Specifies the valid range of values for the parameter.", + "type": "string" + }, + "ApplyMethod": { + "description": "Indicates when parameter updates are applied. Can be immediate or pending-reboot.", + "type": "string" + }, + "ApplyType": { + "description": "Specifies the engine-specific parameter type.", + "type": "string" + }, + "DataType": { + "description": "Specifies the valid data type for the parameter.", + "type": "string" + }, + "Description": { + "description": "Provides a description of the parameter.", + "type": "string" + }, + "IsModifiable": { + "description": "A Boolean value indicating whether the parameter can be modified.", + "type": "boolean" + }, + "ParameterName": { + "description": "Specifies the name of the parameter.", + "type": "string" + }, + "ParameterValue": { + "description": "Specifies the value of the parameter.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Database", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateRelationalDatabase", + "lightsail:GetRelationalDatabase", + "lightsail:GetRelationalDatabases", + "lightsail:GetRegions", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateRelationalDatabase", + "lightsail:UpdateRelationalDatabaseParameters" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteRelationalDatabase", + "lightsail:GetRelationalDatabase", + "lightsail:GetRelationalDatabases" + ] + }, + "list": { + "permissions": [ + "lightsail:GetRelationalDatabases" + ] + }, + "read": { + "permissions": [ + "lightsail:GetRelationalDatabase", + "lightsail:GetRelationalDatabases" + ] + }, + "update": { + "permissions": [ + "lightsail:GetRelationalDatabase", + "lightsail:GetRelationalDatabases", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateRelationalDatabase", + "lightsail:UpdateRelationalDatabaseParameters" + ] + } + }, + "primaryIdentifier": [ + "/properties/RelationalDatabaseName" + ], + "properties": { + "AvailabilityZone": { + "description": "The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "BackupRetention": { + "description": "When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.", + "type": "boolean" + }, + "CaCertificateIdentifier": { + "description": "Indicates the certificate that needs to be associated with the database.", + "type": "string" + }, + "DatabaseArn": { + "type": "string" + }, + "MasterDatabaseName": { + "description": "The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "MasterUserPassword": { + "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\". It cannot contain spaces.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "MasterUsername": { + "description": "The name for the master user.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "PreferredBackupWindow": { + "description": "The daily time range during which automated backups are created for your new database if automated backups are enabled.", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "description": "The weekly time range during which system maintenance can occur on your new database.", + "type": "string" + }, + "PubliclyAccessible": { + "description": "Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.", + "type": "boolean" + }, + "RelationalDatabaseBlueprintId": { + "description": "The blueprint ID for your new database. A blueprint describes the major engine version of a database.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RelationalDatabaseBundleId": { + "description": "The bundle ID for your new database. A bundle describes the performance specifications for your database.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RelationalDatabaseName": { + "description": "The name to use for your new Lightsail database resource.", + "maxLength": 255, + "minLength": 2, + "pattern": "\\w[\\w\\-]*\\w", + "type": "string" + }, + "RelationalDatabaseParameters": { + "description": "Update one or more parameters of the relational database.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RelationalDatabaseParameter" + }, + "type": "array", + "uniqueItems": true + }, + "RotateMasterUserPassword": { + "description": "When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.", + "type": "boolean" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)" + }, + "readOnlyProperties": [ + "/properties/DatabaseArn" + ], + "required": [ + "RelationalDatabaseName", + "RelationalDatabaseBlueprintId", + "RelationalDatabaseBundleId", + "MasterDatabaseName", + "MasterUsername" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::Database", + "writeOnlyProperties": [ + "/properties/MasterUserPassword", + "/properties/RelationalDatabaseParameters", + "/properties/RotateMasterUserPassword" + ] +} diff --git a/schema/aws-lightsail-disk.json b/schema/aws-lightsail-disk.json index 20d2d53..3539b93 100644 --- a/schema/aws-lightsail-disk.json +++ b/schema/aws-lightsail-disk.json @@ -1,232 +1,232 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DiskName", - "/properties/AvailabilityZone", - "/properties/SizeInGb" - ], - "definitions": { - "AddOn": { - "additionalProperties": false, - "description": "A addon associate with a resource.", - "properties": { - "AddOnType": { - "description": "The add-on type", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "AutoSnapshotAddOnRequest": { - "$ref": "#/definitions/AutoSnapshotAddOn" - }, - "Status": { - "description": "Status of the Addon", - "enum": [ - "Enabling", - "Disabling", - "Enabled", - "Terminating", - "Terminated", - "Disabled", - "Failed" - ], - "type": "string" - } - }, - "required": [ - "AddOnType" - ], - "type": "object" - }, - "AutoSnapshotAddOn": { - "additionalProperties": false, - "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on", - "properties": { - "SnapshotTimeOfDay": { - "description": "The daily time when an automatic snapshot will be created.", - "pattern": "^[0-9]{2}:00$", - "type": "string" - } - }, - "type": "object" - }, - "Location": { - "additionalProperties": false, - "description": "Location of a resource.", - "properties": { - "AvailabilityZone": { - "description": "The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", - "type": "string" - }, - "RegionName": { - "description": "The Region Name in which to create your disk.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Disk", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateDisk", - "lightsail:EnableAddOn", - "lightsail:DisableAddOn", - "lightsail:GetDisk", - "lightsail:GetDisks", - "lightsail:GetRegions", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - }, - "delete": { - "permissions": [ - "lightsail:GetDisk", - "lightsail:GetDisks", - "lightsail:DeleteDisk" - ] - }, - "list": { - "permissions": [ - "lightsail:GetDisks" - ] - }, - "read": { - "permissions": [ - "lightsail:GetDisk", - "lightsail:GetDisks" - ] - }, - "update": { - "permissions": [ - "lightsail:GetDisk", - "lightsail:GetDisks", - "lightsail:EnableAddOn", - "lightsail:DisableAddOn", - "lightsail:TagResource", - "lightsail:UntagResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DiskName" - ], - "properties": { - "AddOns": { - "description": "An array of objects representing the add-ons to enable for the new instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AddOn" - }, - "type": "array" - }, - "AttachedTo": { - "description": "Name of the attached Lightsail Instance", - "type": "string" - }, - "AttachmentState": { - "description": "Attachment State of the Lightsail disk", - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DiskArn": { - "type": "string" - }, - "DiskName": { - "description": "The names to use for your new Lightsail disk.", - "maxLength": 254, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", - "type": "string" - }, - "Iops": { - "description": "Iops of the Lightsail disk", - "type": "integer" - }, - "IsAttached": { - "description": "Check is Disk is attached state", - "type": "boolean" - }, - "Location": { - "$ref": "#/definitions/Location" - }, - "Path": { - "description": "Path of the attached Disk", - "type": "string" - }, - "ResourceType": { - "description": "Resource type of Lightsail instance.", - "type": "string" - }, - "SizeInGb": { - "description": "Size of the Lightsail disk", - "type": "integer" - }, - "State": { - "description": "State of the Lightsail disk", - "type": "string" - }, - "SupportCode": { - "description": "Support code to help identify any issues", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AttachedTo", - "/properties/Path", - "/properties/IsAttached", - "/properties/Iops", - "/properties/AttachmentState", - "/properties/State", - "/properties/ResourceType", - "/properties/Location/AvailabilityZone", - "/properties/Location/RegionName", - "/properties/SupportCode", - "/properties/DiskArn" - ], - "required": [ - "DiskName", - "SizeInGb" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Disk" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DiskName", + "/properties/AvailabilityZone", + "/properties/SizeInGb" + ], + "definitions": { + "AddOn": { + "additionalProperties": false, + "description": "A addon associate with a resource.", + "properties": { + "AddOnType": { + "description": "The add-on type", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "AutoSnapshotAddOnRequest": { + "$ref": "#/definitions/AutoSnapshotAddOn" + }, + "Status": { + "description": "Status of the Addon", + "enum": [ + "Enabling", + "Disabling", + "Enabled", + "Terminating", + "Terminated", + "Disabled", + "Failed" + ], + "type": "string" + } + }, + "required": [ + "AddOnType" + ], + "type": "object" + }, + "AutoSnapshotAddOn": { + "additionalProperties": false, + "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on", + "properties": { + "SnapshotTimeOfDay": { + "description": "The daily time when an automatic snapshot will be created.", + "pattern": "^[0-9]{2}:00$", + "type": "string" + } + }, + "type": "object" + }, + "Location": { + "additionalProperties": false, + "description": "Location of a resource.", + "properties": { + "AvailabilityZone": { + "description": "The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", + "type": "string" + }, + "RegionName": { + "description": "The Region Name in which to create your disk.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Disk", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateDisk", + "lightsail:EnableAddOn", + "lightsail:DisableAddOn", + "lightsail:GetDisk", + "lightsail:GetDisks", + "lightsail:GetRegions", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + }, + "delete": { + "permissions": [ + "lightsail:GetDisk", + "lightsail:GetDisks", + "lightsail:DeleteDisk" + ] + }, + "list": { + "permissions": [ + "lightsail:GetDisks" + ] + }, + "read": { + "permissions": [ + "lightsail:GetDisk", + "lightsail:GetDisks" + ] + }, + "update": { + "permissions": [ + "lightsail:GetDisk", + "lightsail:GetDisks", + "lightsail:EnableAddOn", + "lightsail:DisableAddOn", + "lightsail:TagResource", + "lightsail:UntagResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DiskName" + ], + "properties": { + "AddOns": { + "description": "An array of objects representing the add-ons to enable for the new instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AddOn" + }, + "type": "array" + }, + "AttachedTo": { + "description": "Name of the attached Lightsail Instance", + "type": "string" + }, + "AttachmentState": { + "description": "Attachment State of the Lightsail disk", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DiskArn": { + "type": "string" + }, + "DiskName": { + "description": "The names to use for your new Lightsail disk.", + "maxLength": 254, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", + "type": "string" + }, + "Iops": { + "description": "Iops of the Lightsail disk", + "type": "integer" + }, + "IsAttached": { + "description": "Check is Disk is attached state", + "type": "boolean" + }, + "Location": { + "$ref": "#/definitions/Location" + }, + "Path": { + "description": "Path of the attached Disk", + "type": "string" + }, + "ResourceType": { + "description": "Resource type of Lightsail instance.", + "type": "string" + }, + "SizeInGb": { + "description": "Size of the Lightsail disk", + "type": "integer" + }, + "State": { + "description": "State of the Lightsail disk", + "type": "string" + }, + "SupportCode": { + "description": "Support code to help identify any issues", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AttachedTo", + "/properties/Path", + "/properties/IsAttached", + "/properties/Iops", + "/properties/AttachmentState", + "/properties/State", + "/properties/ResourceType", + "/properties/Location/AvailabilityZone", + "/properties/Location/RegionName", + "/properties/SupportCode", + "/properties/DiskArn" + ], + "required": [ + "DiskName", + "SizeInGb" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::Disk" +} diff --git a/schema/aws-lightsail-distribution.json b/schema/aws-lightsail-distribution.json index 77ef52d..c9fb563 100644 --- a/schema/aws-lightsail-distribution.json +++ b/schema/aws-lightsail-distribution.json @@ -1,305 +1,315 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DistributionName", - "/properties/IpAddressType" - ], - "definitions": { - "CacheBehavior": { - "additionalProperties": false, - "description": "Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.", - "properties": { - "Behavior": { - "description": "The cache behavior of the distribution.", - "type": "string" - } - }, - "type": "object" - }, - "CacheBehaviorPerPath": { - "additionalProperties": false, - "description": "Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.", - "properties": { - "Behavior": { - "description": "The cache behavior for the specified path.", - "type": "string" - }, - "Path": { - "description": "The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.", - "type": "string" - } - }, - "type": "object" - }, - "CacheSettings": { - "additionalProperties": false, - "description": "Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.", - "properties": { - "AllowedHTTPMethods": { - "description": "The HTTP methods that are processed and forwarded to the distribution's origin.", - "type": "string" - }, - "CachedHTTPMethods": { - "description": "The HTTP method responses that are cached by your distribution.", - "type": "string" - }, - "DefaultTTL": { - "description": "The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.", - "format": "int64", - "type": "integer" - }, - "ForwardedCookies": { - "$ref": "#/definitions/CookieObject", - "description": "An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded." - }, - "ForwardedHeaders": { - "$ref": "#/definitions/HeaderObject", - "description": "An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded." - }, - "ForwardedQueryStrings": { - "$ref": "#/definitions/QueryStringObject", - "description": "An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded." - }, - "MaximumTTL": { - "description": "The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.", - "format": "int64", - "type": "integer" - }, - "MinimumTTL": { - "description": "The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "CookieObject": { - "additionalProperties": false, - "description": "Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.", - "properties": { - "CookiesAllowList": { - "description": "The specific cookies to forward to your distribution's origin.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Option": { - "description": "Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.", - "type": "string" - } - }, - "type": "object" - }, - "HeaderObject": { - "additionalProperties": false, - "description": "Describes the request headers that a Lightsail distribution bases caching on.", - "properties": { - "HeadersAllowList": { - "description": "The specific headers to forward to your distribution's origin.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Option": { - "description": "The headers that you want your distribution to forward to your origin and base caching on.", - "type": "string" - } - }, - "type": "object" - }, - "InputOrigin": { - "additionalProperties": false, - "description": "Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.", - "properties": { - "Name": { - "description": "The name of the origin resource.", - "type": "string" - }, - "ProtocolPolicy": { - "description": "The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.", - "type": "string" - }, - "RegionName": { - "description": "The AWS Region name of the origin resource.", - "type": "string" - } - }, - "type": "object" - }, - "QueryStringObject": { - "additionalProperties": false, - "description": "Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.", - "properties": { - "Option": { - "description": "Indicates whether the distribution forwards and caches based on query strings.", - "type": "boolean" - }, - "QueryStringsAllowList": { - "description": "The specific query strings that the distribution forwards to the origin.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Distribution", - "handlers": { - "create": { - "permissions": [ - "lightsail:AttachCertificateToDistribution", - "lightsail:CreateDistribution", - "lightsail:DetachCertificateFromDistribution", - "lightsail:GetCertificates", - "lightsail:GetCertificateDetails", - "lightsail:GetDistributions", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateDistribution", - "lightsail:UpdateDistributionBundle" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteDistribution", - "lightsail:GetDistributions" - ] - }, - "list": { - "permissions": [ - "lightsail:GetDistributions" - ] - }, - "read": { - "permissions": [ - "lightsail:GetDistributions" - ] - }, - "update": { - "permissions": [ - "lightsail:AttachCertificateToDistribution", - "lightsail:DetachCertificateFromDistribution", - "lightsail:GetCertificates", - "lightsail:GetCertificateDetails", - "lightsail:GetDistributions", - "lightsail:TagResource", - "lightsail:UntagResource", - "lightsail:UpdateDistribution", - "lightsail:UpdateDistributionBundle" - ] - } - }, - "primaryIdentifier": [ - "/properties/DistributionName" - ], - "properties": { - "AbleToUpdateBundle": { - "description": "Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.", - "type": "boolean" - }, - "BundleId": { - "description": "The bundle ID to use for the distribution.", - "type": "string" - }, - "CacheBehaviorSettings": { - "$ref": "#/definitions/CacheSettings", - "description": "An object that describes the cache behavior settings for the distribution." - }, - "CacheBehaviors": { - "description": "An array of objects that describe the per-path cache behavior for the distribution.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CacheBehaviorPerPath" - }, - "type": "array", - "uniqueItems": true - }, - "CertificateName": { - "description": "The certificate attached to the Distribution.", - "type": "string" - }, - "DefaultCacheBehavior": { - "$ref": "#/definitions/CacheBehavior", - "description": "An object that describes the default cache behavior for the distribution." - }, - "DistributionArn": { - "type": "string" - }, - "DistributionName": { - "description": "The name for the distribution.", - "pattern": "\\w[\\w\\-]*\\w", - "type": "string" - }, - "IpAddressType": { - "description": "The IP address type for the distribution.", - "type": "string" - }, - "IsEnabled": { - "description": "Indicates whether the distribution is enabled.", - "type": "boolean" - }, - "Origin": { - "$ref": "#/definitions/InputOrigin", - "description": "An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer." - }, - "Status": { - "description": "The status of the distribution.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/DistributionArn", - "/properties/Status", - "/properties/AbleToUpdateBundle" - ], - "required": [ - "DistributionName", - "BundleId", - "DefaultCacheBehavior", - "Origin" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Distribution" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DistributionName", + "/properties/IpAddressType" + ], + "definitions": { + "CacheBehavior": { + "additionalProperties": false, + "description": "Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.", + "properties": { + "Behavior": { + "description": "The cache behavior of the distribution.", + "type": "string" + } + }, + "type": "object" + }, + "CacheBehaviorPerPath": { + "additionalProperties": false, + "description": "Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.", + "properties": { + "Behavior": { + "description": "The cache behavior for the specified path.", + "type": "string" + }, + "Path": { + "description": "The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.", + "type": "string" + } + }, + "type": "object" + }, + "CacheSettings": { + "additionalProperties": false, + "description": "Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.", + "properties": { + "AllowedHTTPMethods": { + "description": "The HTTP methods that are processed and forwarded to the distribution's origin.", + "type": "string" + }, + "CachedHTTPMethods": { + "description": "The HTTP method responses that are cached by your distribution.", + "type": "string" + }, + "DefaultTTL": { + "description": "The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.", + "format": "int64", + "type": "integer" + }, + "ForwardedCookies": { + "$ref": "#/definitions/CookieObject", + "description": "An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded." + }, + "ForwardedHeaders": { + "$ref": "#/definitions/HeaderObject", + "description": "An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded." + }, + "ForwardedQueryStrings": { + "$ref": "#/definitions/QueryStringObject", + "description": "An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded." + }, + "MaximumTTL": { + "description": "The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.", + "format": "int64", + "type": "integer" + }, + "MinimumTTL": { + "description": "The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CookieObject": { + "additionalProperties": false, + "description": "Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.", + "properties": { + "CookiesAllowList": { + "description": "The specific cookies to forward to your distribution's origin.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Option": { + "description": "Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.", + "type": "string" + } + }, + "type": "object" + }, + "HeaderObject": { + "additionalProperties": false, + "description": "Describes the request headers that a Lightsail distribution bases caching on.", + "properties": { + "HeadersAllowList": { + "description": "The specific headers to forward to your distribution's origin.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Option": { + "description": "The headers that you want your distribution to forward to your origin and base caching on.", + "type": "string" + } + }, + "type": "object" + }, + "InputOrigin": { + "additionalProperties": false, + "description": "Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.", + "properties": { + "Name": { + "description": "The name of the origin resource.", + "type": "string" + }, + "ProtocolPolicy": { + "description": "The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.", + "type": "string" + }, + "RegionName": { + "description": "The AWS Region name of the origin resource.", + "type": "string" + } + }, + "type": "object" + }, + "QueryStringObject": { + "additionalProperties": false, + "description": "Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.", + "properties": { + "Option": { + "description": "Indicates whether the distribution forwards and caches based on query strings.", + "type": "boolean" + }, + "QueryStringsAllowList": { + "description": "The specific query strings that the distribution forwards to the origin.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Distribution", + "handlers": { + "create": { + "permissions": [ + "lightsail:AttachCertificateToDistribution", + "lightsail:CreateDistribution", + "lightsail:DetachCertificateFromDistribution", + "lightsail:GetCertificates", + "lightsail:GetCertificateDetails", + "lightsail:GetDistributions", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateDistribution", + "lightsail:UpdateDistributionBundle" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteDistribution", + "lightsail:GetDistributions" + ] + }, + "list": { + "permissions": [ + "lightsail:GetDistributions" + ] + }, + "read": { + "permissions": [ + "lightsail:GetDistributions" + ] + }, + "update": { + "permissions": [ + "lightsail:AttachCertificateToDistribution", + "lightsail:DetachCertificateFromDistribution", + "lightsail:GetCertificates", + "lightsail:GetCertificateDetails", + "lightsail:GetDistributions", + "lightsail:TagResource", + "lightsail:UntagResource", + "lightsail:UpdateDistribution", + "lightsail:UpdateDistributionBundle" + ] + } + }, + "primaryIdentifier": [ + "/properties/DistributionName" + ], + "properties": { + "AbleToUpdateBundle": { + "description": "Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.", + "type": "boolean" + }, + "BundleId": { + "description": "The bundle ID to use for the distribution.", + "type": "string" + }, + "CacheBehaviorSettings": { + "$ref": "#/definitions/CacheSettings", + "description": "An object that describes the cache behavior settings for the distribution." + }, + "CacheBehaviors": { + "description": "An array of objects that describe the per-path cache behavior for the distribution.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CacheBehaviorPerPath" + }, + "type": "array", + "uniqueItems": true + }, + "CertificateName": { + "description": "The certificate attached to the Distribution.", + "type": "string" + }, + "DefaultCacheBehavior": { + "$ref": "#/definitions/CacheBehavior", + "description": "An object that describes the default cache behavior for the distribution." + }, + "DistributionArn": { + "type": "string" + }, + "DistributionName": { + "description": "The name for the distribution.", + "pattern": "\\w[\\w\\-]*\\w", + "type": "string" + }, + "IpAddressType": { + "description": "The IP address type for the distribution.", + "type": "string" + }, + "IsEnabled": { + "description": "Indicates whether the distribution is enabled.", + "type": "boolean" + }, + "Origin": { + "$ref": "#/definitions/InputOrigin", + "description": "An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer." + }, + "Status": { + "description": "The status of the distribution.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/DistributionArn", + "/properties/Status", + "/properties/AbleToUpdateBundle" + ], + "required": [ + "DistributionName", + "BundleId", + "DefaultCacheBehavior", + "Origin" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "lightsail:TagResource", + "lightsail:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Lightsail::Distribution" +} diff --git a/schema/aws-lightsail-instance.json b/schema/aws-lightsail-instance.json index b43f0c3..37abde3 100644 --- a/schema/aws-lightsail-instance.json +++ b/schema/aws-lightsail-instance.json @@ -1,466 +1,476 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceName", - "/properties/BlueprintId", - "/properties/BundleId", - "/properties/AvailabilityZone" - ], - "definitions": { - "AddOn": { - "additionalProperties": false, - "description": "A addon associate with a resource.", - "properties": { - "AddOnType": { - "description": "The add-on type", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "AutoSnapshotAddOnRequest": { - "$ref": "#/definitions/AutoSnapshotAddOn" - }, - "Status": { - "description": "Status of the Addon", - "enum": [ - "Enabling", - "Disabling", - "Enabled", - "Terminating", - "Terminated", - "Disabled", - "Failed" - ], - "type": "string" - } - }, - "required": [ - "AddOnType" - ], - "type": "object" - }, - "AutoSnapshotAddOn": { - "additionalProperties": false, - "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on", - "properties": { - "SnapshotTimeOfDay": { - "description": "The daily time when an automatic snapshot will be created.", - "pattern": "^[0-9]{2}:00$", - "type": "string" - } - }, - "type": "object" - }, - "Disk": { - "additionalProperties": false, - "description": "Disk associated with the Instance.", - "properties": { - "AttachedTo": { - "description": "Instance attached to the disk.", - "type": "string" - }, - "AttachmentState": { - "description": "Attachment state of the disk.", - "type": "string" - }, - "DiskName": { - "description": "The names to use for your new Lightsail disk.", - "maxLength": 254, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", - "type": "string" - }, - "IOPS": { - "description": "IOPS of disk.", - "type": "integer" - }, - "IsSystemDisk": { - "description": "Is the Attached disk is the system disk of the Instance.", - "type": "boolean" - }, - "Path": { - "description": "Path of the disk attached to the instance.", - "type": "string" - }, - "SizeInGb": { - "description": "Size of the disk attached to the Instance.", - "type": "string" - } - }, - "required": [ - "DiskName", - "Path" - ], - "type": "object" - }, - "Hardware": { - "additionalProperties": false, - "description": "Hardware of the Instance.", - "properties": { - "CpuCount": { - "description": "CPU count of the Instance.", - "type": "integer" - }, - "Disks": { - "description": "Disks attached to the Instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Disk" - }, - "type": "array", - "uniqueItems": true - }, - "RamSizeInGb": { - "description": "RAM Size of the Instance.", - "type": "integer" - } - }, - "type": "object" - }, - "Location": { - "additionalProperties": false, - "description": "Location of a resource.", - "properties": { - "AvailabilityZone": { - "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", - "type": "string" - }, - "RegionName": { - "description": "The Region Name in which to create your instance.", - "type": "string" - } - }, - "type": "object" - }, - "MonthlyTransfer": { - "additionalProperties": false, - "description": "Monthly Transfer of the Instance.", - "properties": { - "GbPerMonthAllocated": { - "description": "GbPerMonthAllocated of the Instance.", - "type": "string" - } - }, - "type": "object" - }, - "Networking": { - "additionalProperties": false, - "description": "Networking of the Instance.", - "properties": { - "MonthlyTransfer": { - "$ref": "#/definitions/MonthlyTransfer" - }, - "Ports": { - "description": "Ports to the Instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Port" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Ports" - ], - "type": "object" - }, - "Port": { - "additionalProperties": false, - "description": "Port of the Instance.", - "properties": { - "AccessDirection": { - "description": "Access Direction for Protocol of the Instance(inbound/outbound).", - "type": "string" - }, - "AccessFrom": { - "description": "Access From Protocol of the Instance.", - "type": "string" - }, - "AccessType": { - "description": "Access Type Protocol of the Instance.", - "type": "string" - }, - "CidrListAliases": { - "$ref": "#/definitions/cidrListAliases" - }, - "Cidrs": { - "$ref": "#/definitions/cidrs" - }, - "CommonName": { - "description": "CommonName for Protocol of the Instance.", - "type": "string" - }, - "FromPort": { - "description": "From Port of the Instance.", - "type": "integer" - }, - "Ipv6Cidrs": { - "$ref": "#/definitions/ipv6Cidrs" - }, - "Protocol": { - "description": "Port Protocol of the Instance.", - "type": "string" - }, - "ToPort": { - "description": "To Port of the Instance.", - "type": "integer" - } - }, - "type": "object" - }, - "State": { - "additionalProperties": false, - "description": "Current State of the Instance.", - "properties": { - "Code": { - "description": "Status code of the Instance.", - "type": "integer" - }, - "Name": { - "description": "Status code of the Instance.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "cidrListAliases": { - "description": "cidr List Aliases", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "cidrs": { - "description": "cidrs", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "ipv6Cidrs": { - "description": "IPv6 Cidrs", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "description": "Resource Type definition for AWS::Lightsail::Instance", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateInstances", - "lightsail:GetInstances", - "lightsail:EnableAddOn", - "lightsail:GetInstance", - "lightsail:DisableAddOn", - "lightsail:PutInstancePublicPorts", - "lightsail:AttachDisk", - "lightsail:DetachDisk", - "lightsail:StartInstance", - "lightsail:StopInstance", - "lightsail:GetDisk", - "lightsail:GetRegions", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - }, - "delete": { - "permissions": [ - "lightsail:GetInstances", - "lightsail:GetInstance", - "lightsail:DeleteInstance" - ] - }, - "list": { - "permissions": [ - "lightsail:GetInstances" - ] - }, - "read": { - "permissions": [ - "lightsail:GetInstances", - "lightsail:GetInstance" - ] - }, - "update": { - "permissions": [ - "lightsail:GetInstances", - "lightsail:GetInstance", - "lightsail:DeleteInstance", - "lightsail:EnableAddOn", - "lightsail:DisableAddOn", - "lightsail:PutInstancePublicPorts", - "lightsail:AttachDisk", - "lightsail:DetachDisk", - "lightsail:StartInstance", - "lightsail:StopInstance", - "lightsail:GetDisk", - "lightsail:TagResource", - "lightsail:UntagResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/InstanceName" - ], - "properties": { - "AddOns": { - "description": "An array of objects representing the add-ons to enable for the new instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AddOn" - }, - "type": "array" - }, - "AvailabilityZone": { - "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "BlueprintId": { - "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "BundleId": { - "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Hardware": { - "$ref": "#/definitions/Hardware" - }, - "InstanceArn": { - "type": "string" - }, - "InstanceName": { - "description": "The names to use for your new Lightsail instance.", - "maxLength": 254, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", - "type": "string" - }, - "Ipv6Addresses": { - "description": "IPv6 addresses of the instance", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "IsStaticIp": { - "description": "Is the IP Address of the Instance is the static IP", - "type": "boolean" - }, - "KeyPairName": { - "description": "The name of your key pair.", - "type": "string" - }, - "Location": { - "$ref": "#/definitions/Location" - }, - "Networking": { - "$ref": "#/definitions/Networking" - }, - "PrivateIpAddress": { - "description": "Private IP Address of the Instance", - "type": "string" - }, - "PublicIpAddress": { - "description": "Public IP Address of the Instance", - "type": "string" - }, - "ResourceType": { - "description": "Resource type of Lightsail instance.", - "type": "string" - }, - "SshKeyName": { - "description": "SSH Key Name of the Lightsail instance.", - "type": "string" - }, - "State": { - "$ref": "#/definitions/State" - }, - "SupportCode": { - "description": "Support code to help identify any issues", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "UserData": { - "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.", - "type": "string" - }, - "UserName": { - "description": "Username of the Lightsail instance.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/InstanceArn", - "/properties/SshKeyName", - "/properties/SupportCode", - "/properties/ResourceType", - "/properties/IsStaticIp", - "/properties/PrivateIpAddress", - "/properties/PublicIpAddress", - "/properties/Ipv6Addresses", - "/properties/Location/AvailabilityZone", - "/properties/Location/RegionName", - "/properties/Hardware/CpuCount", - "/properties/Hardware/RamSizeInGb", - "/properties/State/Code", - "/properties/State/Name", - "/properties/UserName", - "/properties/Networking/MonthlyTransfer/GbPerMonthAllocated" - ], - "required": [ - "InstanceName", - "BlueprintId", - "BundleId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::Instance", - "writeOnlyProperties": [ - "/properties/UserData" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceName", + "/properties/BlueprintId", + "/properties/BundleId", + "/properties/AvailabilityZone" + ], + "definitions": { + "AddOn": { + "additionalProperties": false, + "description": "A addon associate with a resource.", + "properties": { + "AddOnType": { + "description": "The add-on type", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "AutoSnapshotAddOnRequest": { + "$ref": "#/definitions/AutoSnapshotAddOn" + }, + "Status": { + "description": "Status of the Addon", + "enum": [ + "Enabling", + "Disabling", + "Enabled", + "Terminating", + "Terminated", + "Disabled", + "Failed" + ], + "type": "string" + } + }, + "required": [ + "AddOnType" + ], + "type": "object" + }, + "AutoSnapshotAddOn": { + "additionalProperties": false, + "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on", + "properties": { + "SnapshotTimeOfDay": { + "description": "The daily time when an automatic snapshot will be created.", + "pattern": "^[0-9]{2}:00$", + "type": "string" + } + }, + "type": "object" + }, + "Disk": { + "additionalProperties": false, + "description": "Disk associated with the Instance.", + "properties": { + "AttachedTo": { + "description": "Instance attached to the disk.", + "type": "string" + }, + "AttachmentState": { + "description": "Attachment state of the disk.", + "type": "string" + }, + "DiskName": { + "description": "The names to use for your new Lightsail disk.", + "maxLength": 254, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", + "type": "string" + }, + "IOPS": { + "description": "IOPS of disk.", + "type": "integer" + }, + "IsSystemDisk": { + "description": "Is the Attached disk is the system disk of the Instance.", + "type": "boolean" + }, + "Path": { + "description": "Path of the disk attached to the instance.", + "type": "string" + }, + "SizeInGb": { + "description": "Size of the disk attached to the Instance.", + "type": "string" + } + }, + "required": [ + "DiskName", + "Path" + ], + "type": "object" + }, + "Hardware": { + "additionalProperties": false, + "description": "Hardware of the Instance.", + "properties": { + "CpuCount": { + "description": "CPU count of the Instance.", + "type": "integer" + }, + "Disks": { + "description": "Disks attached to the Instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Disk" + }, + "type": "array", + "uniqueItems": true + }, + "RamSizeInGb": { + "description": "RAM Size of the Instance.", + "type": "integer" + } + }, + "type": "object" + }, + "Location": { + "additionalProperties": false, + "description": "Location of a resource.", + "properties": { + "AvailabilityZone": { + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", + "type": "string" + }, + "RegionName": { + "description": "The Region Name in which to create your instance.", + "type": "string" + } + }, + "type": "object" + }, + "MonthlyTransfer": { + "additionalProperties": false, + "description": "Monthly Transfer of the Instance.", + "properties": { + "GbPerMonthAllocated": { + "description": "GbPerMonthAllocated of the Instance.", + "type": "string" + } + }, + "type": "object" + }, + "Networking": { + "additionalProperties": false, + "description": "Networking of the Instance.", + "properties": { + "MonthlyTransfer": { + "$ref": "#/definitions/MonthlyTransfer" + }, + "Ports": { + "description": "Ports to the Instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Port" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Ports" + ], + "type": "object" + }, + "Port": { + "additionalProperties": false, + "description": "Port of the Instance.", + "properties": { + "AccessDirection": { + "description": "Access Direction for Protocol of the Instance(inbound/outbound).", + "type": "string" + }, + "AccessFrom": { + "description": "Access From Protocol of the Instance.", + "type": "string" + }, + "AccessType": { + "description": "Access Type Protocol of the Instance.", + "type": "string" + }, + "CidrListAliases": { + "$ref": "#/definitions/cidrListAliases" + }, + "Cidrs": { + "$ref": "#/definitions/cidrs" + }, + "CommonName": { + "description": "CommonName for Protocol of the Instance.", + "type": "string" + }, + "FromPort": { + "description": "From Port of the Instance.", + "type": "integer" + }, + "Ipv6Cidrs": { + "$ref": "#/definitions/ipv6Cidrs" + }, + "Protocol": { + "description": "Port Protocol of the Instance.", + "type": "string" + }, + "ToPort": { + "description": "To Port of the Instance.", + "type": "integer" + } + }, + "type": "object" + }, + "State": { + "additionalProperties": false, + "description": "Current State of the Instance.", + "properties": { + "Code": { + "description": "Status code of the Instance.", + "type": "integer" + }, + "Name": { + "description": "Status code of the Instance.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "cidrListAliases": { + "description": "cidr List Aliases", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "cidrs": { + "description": "cidrs", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "ipv6Cidrs": { + "description": "IPv6 Cidrs", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "description": "Resource Type definition for AWS::Lightsail::Instance", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateInstances", + "lightsail:GetInstances", + "lightsail:EnableAddOn", + "lightsail:GetInstance", + "lightsail:DisableAddOn", + "lightsail:PutInstancePublicPorts", + "lightsail:AttachDisk", + "lightsail:DetachDisk", + "lightsail:StartInstance", + "lightsail:StopInstance", + "lightsail:GetDisk", + "lightsail:GetRegions", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + }, + "delete": { + "permissions": [ + "lightsail:GetInstances", + "lightsail:GetInstance", + "lightsail:DeleteInstance" + ] + }, + "list": { + "permissions": [ + "lightsail:GetInstances" + ] + }, + "read": { + "permissions": [ + "lightsail:GetInstances", + "lightsail:GetInstance" + ] + }, + "update": { + "permissions": [ + "lightsail:GetInstances", + "lightsail:GetInstance", + "lightsail:DeleteInstance", + "lightsail:EnableAddOn", + "lightsail:DisableAddOn", + "lightsail:PutInstancePublicPorts", + "lightsail:AttachDisk", + "lightsail:DetachDisk", + "lightsail:StartInstance", + "lightsail:StopInstance", + "lightsail:GetDisk", + "lightsail:TagResource", + "lightsail:UntagResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/InstanceName" + ], + "properties": { + "AddOns": { + "description": "An array of objects representing the add-ons to enable for the new instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AddOn" + }, + "type": "array" + }, + "AvailabilityZone": { + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "BlueprintId": { + "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "BundleId": { + "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Hardware": { + "$ref": "#/definitions/Hardware" + }, + "InstanceArn": { + "type": "string" + }, + "InstanceName": { + "description": "The names to use for your new Lightsail instance.", + "maxLength": 254, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", + "type": "string" + }, + "Ipv6Addresses": { + "description": "IPv6 addresses of the instance", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "IsStaticIp": { + "description": "Is the IP Address of the Instance is the static IP", + "type": "boolean" + }, + "KeyPairName": { + "description": "The name of your key pair.", + "type": "string" + }, + "Location": { + "$ref": "#/definitions/Location" + }, + "Networking": { + "$ref": "#/definitions/Networking" + }, + "PrivateIpAddress": { + "description": "Private IP Address of the Instance", + "type": "string" + }, + "PublicIpAddress": { + "description": "Public IP Address of the Instance", + "type": "string" + }, + "ResourceType": { + "description": "Resource type of Lightsail instance.", + "type": "string" + }, + "SshKeyName": { + "description": "SSH Key Name of the Lightsail instance.", + "type": "string" + }, + "State": { + "$ref": "#/definitions/State" + }, + "SupportCode": { + "description": "Support code to help identify any issues", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "UserData": { + "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.", + "type": "string" + }, + "UserName": { + "description": "Username of the Lightsail instance.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/InstanceArn", + "/properties/SshKeyName", + "/properties/SupportCode", + "/properties/ResourceType", + "/properties/IsStaticIp", + "/properties/PrivateIpAddress", + "/properties/PublicIpAddress", + "/properties/Ipv6Addresses", + "/properties/Location/AvailabilityZone", + "/properties/Location/RegionName", + "/properties/Hardware/CpuCount", + "/properties/Hardware/RamSizeInGb", + "/properties/State/Code", + "/properties/State/Name", + "/properties/UserName", + "/properties/Networking/MonthlyTransfer/GbPerMonthAllocated" + ], + "required": [ + "InstanceName", + "BlueprintId", + "BundleId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "lightsail:TagResource", + "lightsail:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Lightsail::Instance", + "writeOnlyProperties": [ + "/properties/UserData" + ] +} diff --git a/schema/aws-lightsail-loadbalancer.json b/schema/aws-lightsail-loadbalancer.json index d2dc05d..81af267 100644 --- a/schema/aws-lightsail-loadbalancer.json +++ b/schema/aws-lightsail-loadbalancer.json @@ -1,143 +1,143 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoadBalancerName", - "/properties/InstancePort", - "/properties/IpAddressType" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lightsail::LoadBalancer", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateLoadBalancer", - "lightsail:GetLoadBalancer", - "lightsail:GetLoadBalancers", - "lightsail:GetInstance", - "lightsail:AttachInstancesToLoadBalancer", - "lightsail:DetachInstancesFromLoadBalancer", - "lightsail:UpdateLoadBalancerAttribute", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteLoadBalancer", - "lightsail:GetLoadBalancer", - "lightsail:GetLoadBalancers" - ] - }, - "list": { - "permissions": [ - "lightsail:GetLoadBalancers" - ] - }, - "read": { - "permissions": [ - "lightsail:GetLoadBalancer", - "lightsail:GetLoadBalancers" - ] - }, - "update": { - "permissions": [ - "lightsail:GetLoadBalancer", - "lightsail:GetLoadBalancers", - "lightsail:GetInstance", - "lightsail:AttachInstancesToLoadBalancer", - "lightsail:DetachInstancesFromLoadBalancer", - "lightsail:UpdateLoadBalancerAttribute", - "lightsail:TagResource", - "lightsail:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LoadBalancerName" - ], - "properties": { - "AttachedInstances": { - "description": "The names of the instances attached to the load balancer.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "HealthCheckPath": { - "description": "The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").", - "type": "string" - }, - "InstancePort": { - "description": "The instance port where you're creating your load balancer.", - "type": "integer" - }, - "IpAddressType": { - "description": "The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.", - "type": "string" - }, - "LoadBalancerArn": { - "type": "string" - }, - "LoadBalancerName": { - "description": "The name of your load balancer.", - "pattern": "\\w[\\w\\-]*\\w", - "type": "string" - }, - "SessionStickinessEnabled": { - "description": "Configuration option to enable session stickiness.", - "type": "boolean" - }, - "SessionStickinessLBCookieDurationSeconds": { - "description": "Configuration option to adjust session stickiness cookie duration parameter.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TlsPolicyName": { - "description": "The name of the TLS policy to apply to the load balancer.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LoadBalancerArn" - ], - "required": [ - "LoadBalancerName", - "InstancePort" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::LoadBalancer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoadBalancerName", + "/properties/InstancePort", + "/properties/IpAddressType" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Lightsail::LoadBalancer", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateLoadBalancer", + "lightsail:GetLoadBalancer", + "lightsail:GetLoadBalancers", + "lightsail:GetInstance", + "lightsail:AttachInstancesToLoadBalancer", + "lightsail:DetachInstancesFromLoadBalancer", + "lightsail:UpdateLoadBalancerAttribute", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteLoadBalancer", + "lightsail:GetLoadBalancer", + "lightsail:GetLoadBalancers" + ] + }, + "list": { + "permissions": [ + "lightsail:GetLoadBalancers" + ] + }, + "read": { + "permissions": [ + "lightsail:GetLoadBalancer", + "lightsail:GetLoadBalancers" + ] + }, + "update": { + "permissions": [ + "lightsail:GetLoadBalancer", + "lightsail:GetLoadBalancers", + "lightsail:GetInstance", + "lightsail:AttachInstancesToLoadBalancer", + "lightsail:DetachInstancesFromLoadBalancer", + "lightsail:UpdateLoadBalancerAttribute", + "lightsail:TagResource", + "lightsail:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LoadBalancerName" + ], + "properties": { + "AttachedInstances": { + "description": "The names of the instances attached to the load balancer.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "HealthCheckPath": { + "description": "The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").", + "type": "string" + }, + "InstancePort": { + "description": "The instance port where you're creating your load balancer.", + "type": "integer" + }, + "IpAddressType": { + "description": "The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.", + "type": "string" + }, + "LoadBalancerArn": { + "type": "string" + }, + "LoadBalancerName": { + "description": "The name of your load balancer.", + "pattern": "\\w[\\w\\-]*\\w", + "type": "string" + }, + "SessionStickinessEnabled": { + "description": "Configuration option to enable session stickiness.", + "type": "boolean" + }, + "SessionStickinessLBCookieDurationSeconds": { + "description": "Configuration option to adjust session stickiness cookie duration parameter.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TlsPolicyName": { + "description": "The name of the TLS policy to apply to the load balancer.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LoadBalancerArn" + ], + "required": [ + "LoadBalancerName", + "InstancePort" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::LoadBalancer" +} diff --git a/schema/aws-lightsail-loadbalancertlscertificate.json b/schema/aws-lightsail-loadbalancertlscertificate.json index 09d7861..1fe574b 100644 --- a/schema/aws-lightsail-loadbalancertlscertificate.json +++ b/schema/aws-lightsail-loadbalancertlscertificate.json @@ -1,103 +1,103 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LoadBalancerName", - "/properties/CertificateName", - "/properties/CertificateDomainName", - "/properties/CertificateAlternativeNames" - ], - "description": "Resource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate", - "handlers": { - "create": { - "permissions": [ - "lightsail:CreateLoadBalancerTlsCertificate", - "lightsail:GetLoadBalancerTlsCertificates", - "lightsail:GetLoadBalancer", - "lightsail:AttachLoadBalancerTlsCertificate", - "lightsail:UpdateLoadBalancerAttribute" - ] - }, - "delete": { - "permissions": [ - "lightsail:DeleteLoadBalancerTlsCertificate", - "lightsail:GetLoadBalancerTlsCertificates", - "lightsail:GetLoadBalancer" - ] - }, - "list": { - "permissions": [ - "lightsail:GetLoadBalancerTlsCertificates", - "lightsail:GetLoadBalancer" - ] - }, - "read": { - "permissions": [ - "lightsail:GetLoadBalancerTlsCertificates", - "lightsail:GetLoadBalancer" - ] - }, - "update": { - "permissions": [ - "lightsail:AttachLoadBalancerTlsCertificate", - "lightsail:GetLoadBalancerTlsCertificates", - "lightsail:GetLoadBalancer", - "lightsail:UpdateLoadBalancerAttribute" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateName", - "/properties/LoadBalancerName" - ], - "properties": { - "CertificateAlternativeNames": { - "description": "An array of strings listing alternative domains and subdomains for your SSL/TLS certificate.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CertificateDomainName": { - "description": "The domain name (e.g., example.com ) for your SSL/TLS certificate.", - "type": "string" - }, - "CertificateName": { - "description": "The SSL/TLS certificate name.", - "type": "string" - }, - "HttpsRedirectionEnabled": { - "description": "A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.", - "type": "boolean" - }, - "IsAttached": { - "description": "When true, the SSL/TLS certificate is attached to the Lightsail load balancer.", - "type": "boolean" - }, - "LoadBalancerName": { - "description": "The name of your load balancer.", - "pattern": "\\w[\\w\\-]*\\w", - "type": "string" - }, - "LoadBalancerTlsCertificateArn": { - "type": "string" - }, - "Status": { - "description": "The validation status of the SSL/TLS certificate.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LoadBalancerTlsCertificateArn", - "/properties/Status" - ], - "required": [ - "LoadBalancerName", - "CertificateName", - "CertificateDomainName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::LoadBalancerTlsCertificate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LoadBalancerName", + "/properties/CertificateName", + "/properties/CertificateDomainName", + "/properties/CertificateAlternativeNames" + ], + "description": "Resource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate", + "handlers": { + "create": { + "permissions": [ + "lightsail:CreateLoadBalancerTlsCertificate", + "lightsail:GetLoadBalancerTlsCertificates", + "lightsail:GetLoadBalancer", + "lightsail:AttachLoadBalancerTlsCertificate", + "lightsail:UpdateLoadBalancerAttribute" + ] + }, + "delete": { + "permissions": [ + "lightsail:DeleteLoadBalancerTlsCertificate", + "lightsail:GetLoadBalancerTlsCertificates", + "lightsail:GetLoadBalancer" + ] + }, + "list": { + "permissions": [ + "lightsail:GetLoadBalancerTlsCertificates", + "lightsail:GetLoadBalancer" + ] + }, + "read": { + "permissions": [ + "lightsail:GetLoadBalancerTlsCertificates", + "lightsail:GetLoadBalancer" + ] + }, + "update": { + "permissions": [ + "lightsail:AttachLoadBalancerTlsCertificate", + "lightsail:GetLoadBalancerTlsCertificates", + "lightsail:GetLoadBalancer", + "lightsail:UpdateLoadBalancerAttribute" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateName", + "/properties/LoadBalancerName" + ], + "properties": { + "CertificateAlternativeNames": { + "description": "An array of strings listing alternative domains and subdomains for your SSL/TLS certificate.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CertificateDomainName": { + "description": "The domain name (e.g., example.com ) for your SSL/TLS certificate.", + "type": "string" + }, + "CertificateName": { + "description": "The SSL/TLS certificate name.", + "type": "string" + }, + "HttpsRedirectionEnabled": { + "description": "A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.", + "type": "boolean" + }, + "IsAttached": { + "description": "When true, the SSL/TLS certificate is attached to the Lightsail load balancer.", + "type": "boolean" + }, + "LoadBalancerName": { + "description": "The name of your load balancer.", + "pattern": "\\w[\\w\\-]*\\w", + "type": "string" + }, + "LoadBalancerTlsCertificateArn": { + "type": "string" + }, + "Status": { + "description": "The validation status of the SSL/TLS certificate.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LoadBalancerTlsCertificateArn", + "/properties/Status" + ], + "required": [ + "LoadBalancerName", + "CertificateName", + "CertificateDomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::LoadBalancerTlsCertificate" +} diff --git a/schema/aws-lightsail-staticip.json b/schema/aws-lightsail-staticip.json index 07315e2..1d31771 100644 --- a/schema/aws-lightsail-staticip.json +++ b/schema/aws-lightsail-staticip.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StaticIpName" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::Lightsail::StaticIp", - "handlers": { - "create": { - "permissions": [ - "lightsail:AllocateStaticIp", - "lightsail:AttachStaticIp", - "lightsail:DetachStaticIp", - "lightsail:GetInstance", - "lightsail:GetStaticIp", - "lightsail:GetStaticIps" - ] - }, - "delete": { - "permissions": [ - "lightsail:GetStaticIp", - "lightsail:GetStaticIps", - "lightsail:ReleaseStaticIp" - ] - }, - "list": { - "permissions": [ - "lightsail:GetStaticIps" - ] - }, - "read": { - "permissions": [ - "lightsail:GetStaticIp", - "lightsail:GetStaticIps" - ] - }, - "update": { - "permissions": [ - "lightsail:AttachStaticIp", - "lightsail:DetachStaticIp", - "lightsail:GetInstance", - "lightsail:GetStaticIp", - "lightsail:GetStaticIps" - ] - } - }, - "primaryIdentifier": [ - "/properties/StaticIpName" - ], - "properties": { - "AttachedTo": { - "description": "The instance where the static IP is attached.", - "type": "string" - }, - "IpAddress": { - "description": "The static IP address.", - "type": "string" - }, - "IsAttached": { - "description": "A Boolean value indicating whether the static IP is attached.", - "type": "boolean" - }, - "StaticIpArn": { - "type": "string" - }, - "StaticIpName": { - "description": "The name of the static IP address.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/StaticIpArn", - "/properties/IsAttached", - "/properties/IpAddress" - ], - "required": [ - "StaticIpName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", - "taggable": true, - "typeName": "AWS::Lightsail::StaticIp" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StaticIpName" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::Lightsail::StaticIp", + "handlers": { + "create": { + "permissions": [ + "lightsail:AllocateStaticIp", + "lightsail:AttachStaticIp", + "lightsail:DetachStaticIp", + "lightsail:GetInstance", + "lightsail:GetStaticIp", + "lightsail:GetStaticIps" + ] + }, + "delete": { + "permissions": [ + "lightsail:GetStaticIp", + "lightsail:GetStaticIps", + "lightsail:ReleaseStaticIp" + ] + }, + "list": { + "permissions": [ + "lightsail:GetStaticIps" + ] + }, + "read": { + "permissions": [ + "lightsail:GetStaticIp", + "lightsail:GetStaticIps" + ] + }, + "update": { + "permissions": [ + "lightsail:AttachStaticIp", + "lightsail:DetachStaticIp", + "lightsail:GetInstance", + "lightsail:GetStaticIp", + "lightsail:GetStaticIps" + ] + } + }, + "primaryIdentifier": [ + "/properties/StaticIpName" + ], + "properties": { + "AttachedTo": { + "description": "The instance where the static IP is attached.", + "type": "string" + }, + "IpAddress": { + "description": "The static IP address.", + "type": "string" + }, + "IsAttached": { + "description": "A Boolean value indicating whether the static IP is attached.", + "type": "boolean" + }, + "StaticIpArn": { + "type": "string" + }, + "StaticIpName": { + "description": "The name of the static IP address.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StaticIpArn", + "/properties/IsAttached", + "/properties/IpAddress" + ], + "required": [ + "StaticIpName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git", + "taggable": true, + "typeName": "AWS::Lightsail::StaticIp" +} diff --git a/schema/aws-location-apikey.json b/schema/aws-location-apikey.json index b8e7adc..5ea5f54 100644 --- a/schema/aws-location-apikey.json +++ b/schema/aws-location-apikey.json @@ -1,232 +1,236 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KeyName" - ], - "definitions": { - "ApiKeyRestrictions": { - "additionalProperties": false, - "properties": { - "AllowActions": { - "insertionOrder": false, - "items": { - "maxLength": 200, - "minLength": 5, - "pattern": "^geo:\\w*\\*?$", - "type": "string" - }, - "maxItems": 7, - "minItems": 1, - "type": "array" - }, - "AllowReferers": { - "insertionOrder": false, - "items": { - "maxLength": 253, - "pattern": "^([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "AllowResources": { - "insertionOrder": false, - "items": { - "maxLength": 1600, - "pattern": "(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$)", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AllowActions", - "AllowResources" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Definition of AWS::Location::APIKey Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreateKey", - "geo:DescribeKey", - "geo:TagResource", - "geo:UntagResource", - "geo:GetMapTile", - "geo:GetMapStyleDescriptor", - "geo:GetMapSprites", - "geo:GetMapGlyphs", - "geo:SearchPlaceIndexForText", - "geo:SearchPlaceIndexForPosition", - "geo:SearchPlaceIndexForSuggestions", - "geo:GetPlace", - "geo:CalculateRoute", - "geo:CalculateRouteMatrix" - ] - }, - "delete": { - "permissions": [ - "geo:DeleteKey", - "geo:DescribeKey" - ] - }, - "list": { - "permissions": [ - "geo:ListKeys" - ] - }, - "read": { - "permissions": [ - "geo:DescribeKey" - ] - }, - "update": { - "permissions": [ - "geo:CreateKey", - "geo:DescribeKey", - "geo:TagResource", - "geo:UntagResource", - "geo:GetMapTile", - "geo:GetMapStyleDescriptor", - "geo:GetMapSprites", - "geo:GetMapGlyphs", - "geo:SearchPlaceIndexForText", - "geo:SearchPlaceIndexForPosition", - "geo:SearchPlaceIndexForSuggestions", - "geo:GetPlace", - "geo:CalculateRoute", - "geo:CalculateRouteMatrix", - "geo:UpdateKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "ExpireTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "ForceDelete": { - "type": "boolean" - }, - "ForceUpdate": { - "type": "boolean" - }, - "KeyArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "KeyName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "NoExpiry": { - "type": "boolean" - }, - "Restrictions": { - "$ref": "#/definitions/ApiKeyRestrictions" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CreateTime", - "/properties/Arn", - "/properties/KeyArn", - "/properties/UpdateTime" - ], - "required": [ - "KeyName", - "Restrictions" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::APIKey", - "writeOnlyProperties": [ - "/properties/ForceUpdate", - "/properties/ForceDelete", - "/properties/NoExpiry" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KeyName" + ], + "definitions": { + "ApiKeyRestrictions": { + "additionalProperties": false, + "properties": { + "AllowActions": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 5, + "pattern": "^geo:\\w*\\*?$", + "type": "string" + }, + "maxItems": 24, + "minItems": 1, + "type": "array" + }, + "AllowReferers": { + "insertionOrder": false, + "items": { + "maxLength": 253, + "pattern": "^([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "AllowResources": { + "insertionOrder": false, + "items": { + "maxLength": 1600, + "pattern": "(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$)", + "type": "string" + }, + "maxItems": 8, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AllowActions", + "AllowResources" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Definition of AWS::Location::APIKey Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreateKey", + "geo:DescribeKey", + "geo:TagResource", + "geo:UntagResource", + "geo:GetMapTile", + "geo:GetMapStyleDescriptor", + "geo:GetMapSprites", + "geo:GetMapGlyphs", + "geo:SearchPlaceIndexForText", + "geo:SearchPlaceIndexForPosition", + "geo:SearchPlaceIndexForSuggestions", + "geo:GetPlace", + "geo:CalculateRoute", + "geo:CalculateRouteMatrix" + ] + }, + "delete": { + "permissions": [ + "geo:DeleteKey", + "geo:DescribeKey" + ] + }, + "list": { + "permissions": [ + "geo:ListKeys" + ] + }, + "read": { + "permissions": [ + "geo:DescribeKey" + ] + }, + "update": { + "permissions": [ + "geo:CreateKey", + "geo:DescribeKey", + "geo:TagResource", + "geo:UntagResource", + "geo:GetMapTile", + "geo:GetMapStyleDescriptor", + "geo:GetMapSprites", + "geo:GetMapGlyphs", + "geo:SearchPlaceIndexForText", + "geo:SearchPlaceIndexForPosition", + "geo:SearchPlaceIndexForSuggestions", + "geo:GetPlace", + "geo:CalculateRoute", + "geo:CalculateRouteMatrix", + "geo:UpdateKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "ExpireTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "ForceDelete": { + "type": "boolean" + }, + "ForceUpdate": { + "type": "boolean" + }, + "KeyArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "KeyName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "NoExpiry": { + "type": "boolean" + }, + "Restrictions": { + "$ref": "#/definitions/ApiKeyRestrictions" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CreateTime", + "/properties/Arn", + "/properties/KeyArn", + "/properties/UpdateTime" + ], + "required": [ + "KeyName", + "Restrictions" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "geo:TagResource", + "geo:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::APIKey", + "writeOnlyProperties": [ + "/properties/ForceUpdate", + "/properties/ForceDelete", + "/properties/NoExpiry" + ] +} diff --git a/schema/aws-location-geofencecollection.json b/schema/aws-location-geofencecollection.json index 17f9a7a..20a5005 100644 --- a/schema/aws-location-geofencecollection.json +++ b/schema/aws-location-geofencecollection.json @@ -1,175 +1,179 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CollectionName", - "/properties/KmsKeyId" - ], - "definitions": { - "PricingPlan": { - "enum": [ - "RequestBasedUsage" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "deprecatedProperties": [ - "/properties/PricingPlan", - "/properties/PricingPlanDataSource" - ], - "description": "Definition of AWS::Location::GeofenceCollection Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreateGeofenceCollection", - "geo:DescribeGeofenceCollection", - "geo:TagResource", - "geo:UntagResource", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "geo:DeleteGeofenceCollection", - "geo:DescribeGeofenceCollection" - ] - }, - "list": { - "permissions": [ - "geo:ListGeofenceCollections" - ] - }, - "read": { - "permissions": [ - "geo:DescribeGeofenceCollection", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "geo:CreateGeofenceCollection", - "geo:DescribeGeofenceCollection", - "geo:TagResource", - "geo:UntagResource", - "kms:DescribeKey", - "kms:CreateGrant", - "geo:UpdateGeofenceCollection" - ] - } - }, - "primaryIdentifier": [ - "/properties/CollectionName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CollectionArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CollectionName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "PricingPlan": { - "$ref": "#/definitions/PricingPlan" - }, - "PricingPlanDataSource": { - "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CollectionArn", - "/properties/Arn", - "/properties/CreateTime", - "/properties/UpdateTime" - ], - "required": [ - "CollectionName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::GeofenceCollection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CollectionName", + "/properties/KmsKeyId" + ], + "definitions": { + "PricingPlan": { + "enum": [ + "RequestBasedUsage" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "deprecatedProperties": [ + "/properties/PricingPlan", + "/properties/PricingPlanDataSource" + ], + "description": "Definition of AWS::Location::GeofenceCollection Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreateGeofenceCollection", + "geo:DescribeGeofenceCollection", + "geo:TagResource", + "geo:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "geo:DeleteGeofenceCollection", + "geo:DescribeGeofenceCollection" + ] + }, + "list": { + "permissions": [ + "geo:ListGeofenceCollections" + ] + }, + "read": { + "permissions": [ + "geo:DescribeGeofenceCollection", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "geo:CreateGeofenceCollection", + "geo:DescribeGeofenceCollection", + "geo:TagResource", + "geo:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "geo:UpdateGeofenceCollection" + ] + } + }, + "primaryIdentifier": [ + "/properties/CollectionName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CollectionArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CollectionName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "PricingPlan": { + "$ref": "#/definitions/PricingPlan" + }, + "PricingPlanDataSource": { + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CollectionArn", + "/properties/Arn", + "/properties/CreateTime", + "/properties/UpdateTime" + ], + "required": [ + "CollectionName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "geo:TagResource", + "geo:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::GeofenceCollection" +} diff --git a/schema/aws-location-map.json b/schema/aws-location-map.json index 851636a..5b2ad1a 100644 --- a/schema/aws-location-map.json +++ b/schema/aws-location-map.json @@ -1,192 +1,196 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Configuration", - "/properties/MapName" - ], - "definitions": { - "MapConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLayers": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "maxItems": 10, - "type": "array" - }, - "PoliticalView": { - "maxLength": 3, - "minLength": 3, - "pattern": "^[A-Z]{3}$", - "type": "string" - }, - "Style": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - } - }, - "required": [ - "Style" - ], - "type": "object" - }, - "PricingPlan": { - "enum": [ - "RequestBasedUsage" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Definition of AWS::Location::Map Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreateMap", - "geo:DescribeMap", - "geo:TagResource", - "geo:UntagResource" - ] - }, - "delete": { - "permissions": [ - "geo:DeleteMap", - "geo:DescribeMap" - ] - }, - "list": { - "permissions": [ - "geo:ListMaps" - ] - }, - "read": { - "permissions": [ - "geo:DescribeMap" - ] - }, - "update": { - "permissions": [ - "geo:CreateMap", - "geo:DescribeMap", - "geo:TagResource", - "geo:UntagResource", - "geo:UpdateMap" - ] - } - }, - "primaryIdentifier": [ - "/properties/MapName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/MapConfiguration" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "MapArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", - "type": "string" - }, - "MapName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "PricingPlan": { - "$ref": "#/definitions/PricingPlan" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CreateTime", - "/properties/Arn", - "/properties/MapArn", - "/properties/UpdateTime" - ], - "required": [ - "Configuration", - "MapName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::Map" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Configuration", + "/properties/MapName" + ], + "definitions": { + "MapConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLayers": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "maxItems": 10, + "type": "array" + }, + "PoliticalView": { + "maxLength": 3, + "minLength": 3, + "pattern": "^[A-Z]{3}$", + "type": "string" + }, + "Style": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + } + }, + "required": [ + "Style" + ], + "type": "object" + }, + "PricingPlan": { + "enum": [ + "RequestBasedUsage" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Definition of AWS::Location::Map Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreateMap", + "geo:DescribeMap", + "geo:TagResource", + "geo:UntagResource" + ] + }, + "delete": { + "permissions": [ + "geo:DeleteMap", + "geo:DescribeMap" + ] + }, + "list": { + "permissions": [ + "geo:ListMaps" + ] + }, + "read": { + "permissions": [ + "geo:DescribeMap" + ] + }, + "update": { + "permissions": [ + "geo:CreateMap", + "geo:DescribeMap", + "geo:TagResource", + "geo:UntagResource", + "geo:UpdateMap" + ] + } + }, + "primaryIdentifier": [ + "/properties/MapName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/MapConfiguration" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "MapArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", + "type": "string" + }, + "MapName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "PricingPlan": { + "$ref": "#/definitions/PricingPlan" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CreateTime", + "/properties/Arn", + "/properties/MapArn", + "/properties/UpdateTime" + ], + "required": [ + "Configuration", + "MapName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "geo:TagResource", + "geo:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::Map" +} diff --git a/schema/aws-location-placeindex.json b/schema/aws-location-placeindex.json index 808ee0b..5c76caf 100644 --- a/schema/aws-location-placeindex.json +++ b/schema/aws-location-placeindex.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataSource", - "/properties/IndexName" - ], - "definitions": { - "DataSourceConfiguration": { - "additionalProperties": false, - "properties": { - "IntendedUse": { - "$ref": "#/definitions/IntendedUse" - } - }, - "type": "object" - }, - "IntendedUse": { - "enum": [ - "SingleUse", - "Storage" - ], - "type": "string" - }, - "PricingPlan": { - "enum": [ - "RequestBasedUsage" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Definition of AWS::Location::PlaceIndex Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreatePlaceIndex", - "geo:DescribePlaceIndex", - "geo:TagResource", - "geo:UntagResource" - ] - }, - "delete": { - "permissions": [ - "geo:DeletePlaceIndex", - "geo:DescribePlaceIndex" - ] - }, - "list": { - "permissions": [ - "geo:ListPlaceIndexes" - ] - }, - "read": { - "permissions": [ - "geo:DescribePlaceIndex" - ] - }, - "update": { - "permissions": [ - "geo:CreatePlaceIndex", - "geo:DescribePlaceIndex", - "geo:TagResource", - "geo:UntagResource", - "geo:UpdatePlaceIndex" - ] - } - }, - "primaryIdentifier": [ - "/properties/IndexName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "DataSource": { - "type": "string" - }, - "DataSourceConfiguration": { - "$ref": "#/definitions/DataSourceConfiguration" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "IndexArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", - "type": "string" - }, - "IndexName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "PricingPlan": { - "$ref": "#/definitions/PricingPlan" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CreateTime", - "/properties/Arn", - "/properties/IndexArn", - "/properties/UpdateTime" - ], - "required": [ - "DataSource", - "IndexName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::PlaceIndex" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataSource", + "/properties/IndexName" + ], + "definitions": { + "DataSourceConfiguration": { + "additionalProperties": false, + "properties": { + "IntendedUse": { + "$ref": "#/definitions/IntendedUse" + } + }, + "type": "object" + }, + "IntendedUse": { + "enum": [ + "SingleUse", + "Storage" + ], + "type": "string" + }, + "PricingPlan": { + "enum": [ + "RequestBasedUsage" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Definition of AWS::Location::PlaceIndex Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreatePlaceIndex", + "geo:DescribePlaceIndex", + "geo:TagResource", + "geo:UntagResource" + ] + }, + "delete": { + "permissions": [ + "geo:DeletePlaceIndex", + "geo:DescribePlaceIndex" + ] + }, + "list": { + "permissions": [ + "geo:ListPlaceIndexes" + ] + }, + "read": { + "permissions": [ + "geo:DescribePlaceIndex" + ] + }, + "update": { + "permissions": [ + "geo:CreatePlaceIndex", + "geo:DescribePlaceIndex", + "geo:TagResource", + "geo:UntagResource", + "geo:UpdatePlaceIndex" + ] + } + }, + "primaryIdentifier": [ + "/properties/IndexName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "DataSource": { + "type": "string" + }, + "DataSourceConfiguration": { + "$ref": "#/definitions/DataSourceConfiguration" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "IndexArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", + "type": "string" + }, + "IndexName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "PricingPlan": { + "$ref": "#/definitions/PricingPlan" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CreateTime", + "/properties/Arn", + "/properties/IndexArn", + "/properties/UpdateTime" + ], + "required": [ + "DataSource", + "IndexName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::PlaceIndex" +} diff --git a/schema/aws-location-routecalculator.json b/schema/aws-location-routecalculator.json index f56c886..b782ccb 100644 --- a/schema/aws-location-routecalculator.json +++ b/schema/aws-location-routecalculator.json @@ -1,161 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CalculatorName", - "/properties/DataSource" - ], - "definitions": { - "PricingPlan": { - "enum": [ - "RequestBasedUsage" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Definition of AWS::Location::RouteCalculator Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreateRouteCalculator", - "geo:DescribeRouteCalculator", - "geo:TagResource", - "geo:UntagResource" - ] - }, - "delete": { - "permissions": [ - "geo:DeleteRouteCalculator", - "geo:DescribeRouteCalculator" - ] - }, - "list": { - "permissions": [ - "geo:ListRouteCalculators" - ] - }, - "read": { - "permissions": [ - "geo:DescribeRouteCalculator" - ] - }, - "update": { - "permissions": [ - "geo:CreateRouteCalculator", - "geo:DescribeRouteCalculator", - "geo:TagResource", - "geo:UntagResource", - "geo:UpdateRouteCalculator" - ] - } - }, - "primaryIdentifier": [ - "/properties/CalculatorName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CalculatorArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", - "type": "string" - }, - "CalculatorName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "DataSource": { - "type": "string" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "PricingPlan": { - "$ref": "#/definitions/PricingPlan" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CalculatorArn", - "/properties/Arn", - "/properties/CreateTime", - "/properties/UpdateTime" - ], - "required": [ - "DataSource", - "CalculatorName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::RouteCalculator" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CalculatorName", + "/properties/DataSource" + ], + "definitions": { + "PricingPlan": { + "enum": [ + "RequestBasedUsage" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Definition of AWS::Location::RouteCalculator Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreateRouteCalculator", + "geo:DescribeRouteCalculator", + "geo:TagResource", + "geo:UntagResource" + ] + }, + "delete": { + "permissions": [ + "geo:DeleteRouteCalculator", + "geo:DescribeRouteCalculator" + ] + }, + "list": { + "permissions": [ + "geo:ListRouteCalculators" + ] + }, + "read": { + "permissions": [ + "geo:DescribeRouteCalculator" + ] + }, + "update": { + "permissions": [ + "geo:CreateRouteCalculator", + "geo:DescribeRouteCalculator", + "geo:TagResource", + "geo:UntagResource", + "geo:UpdateRouteCalculator" + ] + } + }, + "primaryIdentifier": [ + "/properties/CalculatorName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CalculatorArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", + "type": "string" + }, + "CalculatorName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "DataSource": { + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "PricingPlan": { + "$ref": "#/definitions/PricingPlan" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CalculatorArn", + "/properties/Arn", + "/properties/CreateTime", + "/properties/UpdateTime" + ], + "required": [ + "DataSource", + "CalculatorName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "geo:TagResource", + "geo:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::RouteCalculator" +} diff --git a/schema/aws-location-tracker.json b/schema/aws-location-tracker.json index 20e03c2..468969a 100644 --- a/schema/aws-location-tracker.json +++ b/schema/aws-location-tracker.json @@ -1,192 +1,196 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/TrackerName" - ], - "definitions": { - "PositionFiltering": { - "enum": [ - "TimeBased", - "DistanceBased", - "AccuracyBased" - ], - "type": "string" - }, - "PricingPlan": { - "enum": [ - "RequestBasedUsage" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "deprecatedProperties": [ - "/properties/PricingPlan", - "/properties/PricingPlanDataSource" - ], - "description": "Definition of AWS::Location::Tracker Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:CreateTracker", - "geo:DescribeTracker", - "geo:TagResource", - "geo:UntagResource", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "geo:DeleteTracker", - "geo:DescribeTracker" - ] - }, - "list": { - "permissions": [ - "geo:ListTrackers" - ] - }, - "read": { - "permissions": [ - "geo:DescribeTracker", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "geo:CreateTracker", - "geo:DescribeTracker", - "geo:TagResource", - "geo:UntagResource", - "kms:DescribeKey", - "kms:CreateGrant", - "geo:UpdateTracker" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrackerName" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "CreateTime": { - "$ref": "#/definitions/iso8601UTC" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "EventBridgeEnabled": { - "type": "boolean" - }, - "KmsKeyEnableGeospatialQueries": { - "type": "boolean" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "PositionFiltering": { - "$ref": "#/definitions/PositionFiltering" - }, - "PricingPlan": { - "$ref": "#/definitions/PricingPlan" - }, - "PricingPlanDataSource": { - "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "TrackerArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "TrackerName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - }, - "UpdateTime": { - "$ref": "#/definitions/iso8601UTC" - } - }, - "readOnlyProperties": [ - "/properties/CreateTime", - "/properties/Arn", - "/properties/TrackerArn", - "/properties/UpdateTime" - ], - "required": [ - "TrackerName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Location::Tracker" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/TrackerName" + ], + "definitions": { + "PositionFiltering": { + "enum": [ + "TimeBased", + "DistanceBased", + "AccuracyBased" + ], + "type": "string" + }, + "PricingPlan": { + "enum": [ + "RequestBasedUsage" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "deprecatedProperties": [ + "/properties/PricingPlan", + "/properties/PricingPlanDataSource" + ], + "description": "Definition of AWS::Location::Tracker Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:CreateTracker", + "geo:DescribeTracker", + "geo:TagResource", + "geo:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "geo:DeleteTracker", + "geo:DescribeTracker" + ] + }, + "list": { + "permissions": [ + "geo:ListTrackers" + ] + }, + "read": { + "permissions": [ + "geo:DescribeTracker", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "geo:CreateTracker", + "geo:DescribeTracker", + "geo:TagResource", + "geo:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "geo:UpdateTracker" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrackerName" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "CreateTime": { + "$ref": "#/definitions/iso8601UTC" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "EventBridgeEnabled": { + "type": "boolean" + }, + "KmsKeyEnableGeospatialQueries": { + "type": "boolean" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "PositionFiltering": { + "$ref": "#/definitions/PositionFiltering" + }, + "PricingPlan": { + "$ref": "#/definitions/PricingPlan" + }, + "PricingPlanDataSource": { + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "TrackerArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "TrackerName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "UpdateTime": { + "$ref": "#/definitions/iso8601UTC" + } + }, + "readOnlyProperties": [ + "/properties/CreateTime", + "/properties/Arn", + "/properties/TrackerArn", + "/properties/UpdateTime" + ], + "required": [ + "TrackerName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "geo:TagResource", + "geo:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Location::Tracker" +} diff --git a/schema/aws-location-trackerconsumer.json b/schema/aws-location-trackerconsumer.json index 8046910..abec2a7 100644 --- a/schema/aws-location-trackerconsumer.json +++ b/schema/aws-location-trackerconsumer.json @@ -1,60 +1,60 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TrackerName", - "/properties/ConsumerArn" - ], - "description": "Definition of AWS::Location::TrackerConsumer Resource Type", - "handlers": { - "create": { - "permissions": [ - "geo:AssociateTrackerConsumer", - "geo:ListTrackerConsumers" - ] - }, - "delete": { - "permissions": [ - "geo:DisassociateTrackerConsumer", - "geo:ListTrackerConsumers" - ] - }, - "list": { - "permissions": [ - "geo:ListTrackerConsumers" - ] - }, - "read": { - "permissions": [ - "geo:ListTrackerConsumers" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrackerName", - "/properties/ConsumerArn" - ], - "properties": { - "ConsumerArn": { - "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "TrackerName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[-._\\w]+$", - "type": "string" - } - }, - "required": [ - "ConsumerArn", - "TrackerName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Location::TrackerConsumer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TrackerName", + "/properties/ConsumerArn" + ], + "description": "Definition of AWS::Location::TrackerConsumer Resource Type", + "handlers": { + "create": { + "permissions": [ + "geo:AssociateTrackerConsumer", + "geo:ListTrackerConsumers" + ] + }, + "delete": { + "permissions": [ + "geo:DisassociateTrackerConsumer", + "geo:ListTrackerConsumers" + ] + }, + "list": { + "permissions": [ + "geo:ListTrackerConsumers" + ] + }, + "read": { + "permissions": [ + "geo:ListTrackerConsumers" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrackerName", + "/properties/ConsumerArn" + ], + "properties": { + "ConsumerArn": { + "maxLength": 1600, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "TrackerName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + } + }, + "required": [ + "ConsumerArn", + "TrackerName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Location::TrackerConsumer" +} diff --git a/schema/aws-logs-accountpolicy.json b/schema/aws-logs-accountpolicy.json index 7fc78f4..98288f1 100644 --- a/schema/aws-logs-accountpolicy.json +++ b/schema/aws-logs-accountpolicy.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName", - "/properties/PolicyType" - ], - "description": "The AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.", - "handlers": { - "create": { - "permissions": [ - "logs:PutAccountPolicy", - "logs:PutDataProtectionPolicy", - "logs:DescribeAccountPolicies", - "logs:CreateLogDelivery", - "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream", - "logs:PutSubscriptionFilter", - "logs:DeleteSubscriptionFilter", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteAccountPolicy", - "logs:DeleteDataProtectionPolicy", - "logs:DescribeAccountPolicies", - "logs:DeleteSubscriptionFilter", - "iam:PassRole" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PolicyType": { - "$ref": "resource-schema.json#/properties/PolicyType" - } - }, - "required": [ - "PolicyType" - ] - }, - "permissions": [ - "logs:DescribeAccountPolicies" - ] - }, - "read": { - "permissions": [ - "logs:DescribeAccountPolicies" - ] - }, - "update": { - "permissions": [ - "logs:PutAccountPolicy", - "logs:PutDataProtectionPolicy", - "logs:DescribeAccountPolicies", - "logs:DeleteAccountPolicy", - "logs:DeleteDataProtectionPolicy", - "logs:CreateLogDelivery", - "logs:PutSubscriptionFilter", - "logs:DeleteSubscriptionFilter", - "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId", - "/properties/PolicyType", - "/properties/PolicyName" - ], - "properties": { - "AccountId": { - "description": "User account id", - "pattern": "^\\d{12}$", - "type": "string" - }, - "PolicyDocument": { - "description": "The body of the policy document you want to use for this topic.\n\nYou can only add one policy per PolicyType.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720", - "maxLength": 30720, - "minLength": 1, - "type": "string" - }, - "PolicyName": { - "description": "The name of the account policy", - "maxLength": 256, - "minLength": 1, - "pattern": "^[^:*]{1,256}$", - "type": "string" - }, - "PolicyType": { - "description": "Type of the policy.", - "enum": [ - "DATA_PROTECTION_POLICY", - "SUBSCRIPTION_FILTER_POLICY" - ], - "type": "string" - }, - "Scope": { - "description": "Scope for policy application", - "enum": [ - "ALL" - ], - "type": "string" - }, - "SelectionCriteria": { - "description": "Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "PolicyName", - "PolicyType", - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Logs::AccountPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName", + "/properties/PolicyType" + ], + "description": "The AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.", + "handlers": { + "create": { + "permissions": [ + "logs:PutAccountPolicy", + "logs:PutDataProtectionPolicy", + "logs:DescribeAccountPolicies", + "logs:CreateLogDelivery", + "s3:REST.PUT.OBJECT", + "firehose:TagDeliveryStream", + "logs:PutSubscriptionFilter", + "logs:DeleteSubscriptionFilter", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteAccountPolicy", + "logs:DeleteDataProtectionPolicy", + "logs:DescribeAccountPolicies", + "logs:DeleteSubscriptionFilter", + "iam:PassRole" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PolicyType": { + "$ref": "resource-schema.json#/properties/PolicyType" + } + }, + "required": [ + "PolicyType" + ] + }, + "permissions": [ + "logs:DescribeAccountPolicies" + ] + }, + "read": { + "permissions": [ + "logs:DescribeAccountPolicies" + ] + }, + "update": { + "permissions": [ + "logs:PutAccountPolicy", + "logs:PutDataProtectionPolicy", + "logs:DescribeAccountPolicies", + "logs:DeleteAccountPolicy", + "logs:DeleteDataProtectionPolicy", + "logs:CreateLogDelivery", + "logs:PutSubscriptionFilter", + "logs:DeleteSubscriptionFilter", + "s3:REST.PUT.OBJECT", + "firehose:TagDeliveryStream", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId", + "/properties/PolicyType", + "/properties/PolicyName" + ], + "properties": { + "AccountId": { + "description": "User account id", + "pattern": "^\\d{12}$", + "type": "string" + }, + "PolicyDocument": { + "description": "The body of the policy document you want to use for this topic.\n\nYou can only add one policy per PolicyType.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720", + "maxLength": 30720, + "minLength": 1, + "type": "string" + }, + "PolicyName": { + "description": "The name of the account policy", + "maxLength": 256, + "minLength": 1, + "pattern": "^[^:*]{1,256}$", + "type": "string" + }, + "PolicyType": { + "description": "Type of the policy.", + "enum": [ + "DATA_PROTECTION_POLICY", + "SUBSCRIPTION_FILTER_POLICY" + ], + "type": "string" + }, + "Scope": { + "description": "Scope for policy application", + "enum": [ + "ALL" + ], + "type": "string" + }, + "SelectionCriteria": { + "description": "Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "PolicyName", + "PolicyType", + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Logs::AccountPolicy" +} diff --git a/schema/aws-logs-delivery.json b/schema/aws-logs-delivery.json index d1b0556..36c3f57 100644 --- a/schema/aws-logs-delivery.json +++ b/schema/aws-logs-delivery.json @@ -1,141 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeliverySourceName", - "/properties/DeliveryDestinationArn" - ], - "definitions": { - "Arn": { - "description": "Amazon Resource Name (ARN) that uniquely identify AWS resource.", - "maxLength": 2048, - "minLength": 16, - "pattern": "[\\w#+=/:,.@-]*\\*?", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "This structure contains information about one delivery in your account.\n\nA delivery is a connection between a logical delivery source and a logical delivery destination.\n\nFor more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).", - "handlers": { - "create": { - "permissions": [ - "logs:CreateDelivery", - "logs:GetDelivery", - "logs:DescribeDeliveries", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:GetDeliverySource", - "logs:GetDeliveryDestination" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteDelivery", - "logs:ListTagsForResource", - "logs:UntagResource" - ] - }, - "list": { - "permissions": [ - "logs:DescribeDeliveries", - "logs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "logs:GetDelivery", - "logs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "logs:GetDelivery", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeliveryId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery." - }, - "DeliveryDestinationArn": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the delivery destination that is associated with this delivery." - }, - "DeliveryDestinationType": { - "description": "Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.", - "maxLength": 12, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+$", - "type": "string" - }, - "DeliveryId": { - "description": "The unique ID that identifies this delivery in your account.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+$", - "type": "string" - }, - "DeliverySourceName": { - "description": "The name of the delivery source that is associated with this delivery.", - "maxLength": 60, - "minLength": 1, - "pattern": "[\\w-]*$", - "type": "string" - }, - "Tags": { - "description": "The tags that have been assigned to this delivery.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/DeliveryId", - "/properties/Arn", - "/properties/DeliveryDestinationType" - ], - "required": [ - "DeliverySourceName", - "DeliveryDestinationArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Logs::Delivery" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeliverySourceName", + "/properties/DeliveryDestinationArn" + ], + "definitions": { + "Arn": { + "description": "Amazon Resource Name (ARN) that uniquely identify AWS resource.", + "maxLength": 2048, + "minLength": 16, + "pattern": "[\\w#+=/:,.@-]*\\*?", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "This structure contains information about one delivery in your account.\n\nA delivery is a connection between a logical delivery source and a logical delivery destination.\n\nFor more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).", + "handlers": { + "create": { + "permissions": [ + "logs:CreateDelivery", + "logs:GetDelivery", + "logs:DescribeDeliveries", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:GetDeliverySource", + "logs:GetDeliveryDestination" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteDelivery", + "logs:ListTagsForResource", + "logs:UntagResource" + ] + }, + "list": { + "permissions": [ + "logs:DescribeDeliveries", + "logs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "logs:GetDelivery", + "logs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "logs:GetDelivery", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeliveryId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery." + }, + "DeliveryDestinationArn": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the delivery destination that is associated with this delivery." + }, + "DeliveryDestinationType": { + "description": "Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.", + "maxLength": 12, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+$", + "type": "string" + }, + "DeliveryId": { + "description": "The unique ID that identifies this delivery in your account.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+$", + "type": "string" + }, + "DeliverySourceName": { + "description": "The name of the delivery source that is associated with this delivery.", + "maxLength": 60, + "minLength": 1, + "pattern": "[\\w-]*$", + "type": "string" + }, + "Tags": { + "description": "The tags that have been assigned to this delivery.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/DeliveryId", + "/properties/Arn", + "/properties/DeliveryDestinationType" + ], + "required": [ + "DeliverySourceName", + "DeliveryDestinationArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Logs::Delivery" +} diff --git a/schema/aws-logs-deliverydestination.json b/schema/aws-logs-deliverydestination.json index 30699eb..51c680b 100644 --- a/schema/aws-logs-deliverydestination.json +++ b/schema/aws-logs-deliverydestination.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/DestinationResourceArn" - ], - "definitions": { - "Arn": { - "description": "The Amazon Resource Name (ARN) that uniquely identifies a resource.", - "maxLength": 2048, - "minLength": 16, - "pattern": "[\\w#+=/:,.@-]*\\*?", - "type": "string" - }, - "DestinationPolicy": { - "additionalProperties": false, - "properties": { - "DeliveryDestinationName": { - "description": "The name of the delivery destination to assign this policy to", - "maxLength": 60, - "minLength": 1, - "type": "string" - }, - "DeliveryDestinationPolicy": { - "description": "The contents of the policy attached to the delivery destination", - "maxLength": 51200, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DeliveryDestinationName", - "DeliveryDestinationPolicy" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "This structure contains information about one delivery destination in your account.\n\nA delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.", - "handlers": { - "create": { - "permissions": [ - "logs:PutDeliveryDestination", - "logs:GetDeliveryDestination", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:UntagResource", - "logs:PutDeliveryDestinationPolicy", - "logs:GetDeliveryDestinationPolicy" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteDeliveryDestination", - "logs:DeleteDeliveryDestinationPolicy" - ] - }, - "list": { - "permissions": [ - "logs:DescribeDeliveryDestinations", - "logs:GetDeliveryDestinationPolicy" - ] - }, - "read": { - "permissions": [ - "logs:GetDeliveryDestination", - "logs:ListTagsForResource", - "logs:GetDeliveryDestinationPolicy" - ] - }, - "update": { - "permissions": [ - "logs:PutDeliveryDestination", - "logs:GetDeliveryDestination", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:UntagResource", - "logs:DeleteDeliveryDestinationPolicy", - "logs:PutDeliveryDestinationPolicy", - "logs:GetDeliveryDestinationPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery destination." - }, - "DeliveryDestinationPolicy": { - "description": "IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 51200", - "items": { - "$ref": "#/definitions/DestinationPolicy" - }, - "type": "object" - }, - "DeliveryDestinationType": { - "description": "Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.", - "maxLength": 12, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+$", - "type": "string" - }, - "DestinationResourceArn": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the AWS resource that will receive the logs." - }, - "Name": { - "description": "The name of this delivery destination.", - "maxLength": 60, - "minLength": 1, - "pattern": "[\\w-]*$", - "type": "string" - }, - "Tags": { - "description": "The tags that have been assigned to this delivery destination.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DeliveryDestinationType" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Logs::DeliveryDestination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/DestinationResourceArn" + ], + "definitions": { + "Arn": { + "description": "The Amazon Resource Name (ARN) that uniquely identifies a resource.", + "maxLength": 2048, + "minLength": 16, + "pattern": "[\\w#+=/:,.@-]*\\*?", + "type": "string" + }, + "DestinationPolicy": { + "additionalProperties": false, + "properties": { + "DeliveryDestinationName": { + "description": "The name of the delivery destination to assign this policy to", + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "DeliveryDestinationPolicy": { + "description": "The contents of the policy attached to the delivery destination", + "maxLength": 51200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DeliveryDestinationName", + "DeliveryDestinationPolicy" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "This structure contains information about one delivery destination in your account.\n\nA delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.", + "handlers": { + "create": { + "permissions": [ + "logs:PutDeliveryDestination", + "logs:GetDeliveryDestination", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:UntagResource", + "logs:PutDeliveryDestinationPolicy", + "logs:GetDeliveryDestinationPolicy" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteDeliveryDestination", + "logs:DeleteDeliveryDestinationPolicy" + ] + }, + "list": { + "permissions": [ + "logs:DescribeDeliveryDestinations", + "logs:GetDeliveryDestinationPolicy" + ] + }, + "read": { + "permissions": [ + "logs:GetDeliveryDestination", + "logs:ListTagsForResource", + "logs:GetDeliveryDestinationPolicy" + ] + }, + "update": { + "permissions": [ + "logs:PutDeliveryDestination", + "logs:GetDeliveryDestination", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:UntagResource", + "logs:DeleteDeliveryDestinationPolicy", + "logs:PutDeliveryDestinationPolicy", + "logs:GetDeliveryDestinationPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery destination." + }, + "DeliveryDestinationPolicy": { + "description": "IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 51200", + "items": { + "$ref": "#/definitions/DestinationPolicy" + }, + "type": "object" + }, + "DeliveryDestinationType": { + "description": "Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.", + "maxLength": 12, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+$", + "type": "string" + }, + "DestinationResourceArn": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose." + }, + "Name": { + "description": "The name of this delivery destination.", + "maxLength": 60, + "minLength": 1, + "pattern": "[\\w-]*$", + "type": "string" + }, + "Tags": { + "description": "The tags that have been assigned to this delivery destination.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DeliveryDestinationType" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Logs::DeliveryDestination" +} diff --git a/schema/aws-logs-deliverysource.json b/schema/aws-logs-deliverysource.json index 5a42cfe..335ca84 100644 --- a/schema/aws-logs-deliverysource.json +++ b/schema/aws-logs-deliverysource.json @@ -1,150 +1,150 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Arn": { - "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source.", - "maxLength": 2048, - "minLength": 16, - "pattern": "[\\w#+=/:,.@-]*\\*?", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": " A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.\n\nOnly some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).", - "handlers": { - "create": { - "permissions": [ - "logs:PutDeliverySource", - "logs:GetDeliverySource", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:AllowVendedLogDeliveryForResource", - "codewhisperer:AllowVendedLogDeliveryForResource", - "autoloop:AllowVendedLogDeliveryForResource", - "workmail:AllowVendedLogDeliveryForResource" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteDeliverySource" - ] - }, - "list": { - "permissions": [ - "logs:DescribeDeliverySources" - ] - }, - "read": { - "permissions": [ - "logs:GetDeliverySource", - "logs:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "logs:PutDeliverySource", - "logs:GetDeliverySource", - "logs:ListTagsForResource", - "logs:TagResource", - "logs:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source." - }, - "LogType": { - "description": "The type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.", - "maxLength": 255, - "minLength": 1, - "pattern": "[\\w-]*$", - "type": "string" - }, - "Name": { - "description": "The unique name of the Log source.", - "maxLength": 60, - "minLength": 1, - "pattern": "[\\w-]*$", - "type": "string" - }, - "ResourceArn": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the resource that will be sending the logs." - }, - "ResourceArns": { - "description": "This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array", - "uniqueItems": true - }, - "Service": { - "description": "The AWS service that is sending logs.", - "maxLength": 255, - "minLength": 1, - "pattern": "[\\w-]*$", - "type": "string" - }, - "Tags": { - "description": "The tags that have been assigned to this delivery source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Service", - "/properties/ResourceArns", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Logs::DeliverySource", - "writeOnlyProperties": [ - "/properties/ResourceArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Arn": { + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source.", + "maxLength": 2048, + "minLength": 16, + "pattern": "[\\w#+=/:,.@-]*\\*?", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": " A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.\n\nOnly some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).", + "handlers": { + "create": { + "permissions": [ + "logs:PutDeliverySource", + "logs:GetDeliverySource", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:AllowVendedLogDeliveryForResource", + "codewhisperer:AllowVendedLogDeliveryForResource", + "autoloop:AllowVendedLogDeliveryForResource", + "workmail:AllowVendedLogDeliveryForResource" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteDeliverySource" + ] + }, + "list": { + "permissions": [ + "logs:DescribeDeliverySources" + ] + }, + "read": { + "permissions": [ + "logs:GetDeliverySource", + "logs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "logs:PutDeliverySource", + "logs:GetDeliverySource", + "logs:ListTagsForResource", + "logs:TagResource", + "logs:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source." + }, + "LogType": { + "description": "The type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.", + "maxLength": 255, + "minLength": 1, + "pattern": "[\\w-]*$", + "type": "string" + }, + "Name": { + "description": "The unique name of the Log source.", + "maxLength": 60, + "minLength": 1, + "pattern": "[\\w-]*$", + "type": "string" + }, + "ResourceArn": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the resource that will be sending the logs." + }, + "ResourceArns": { + "description": "This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array", + "uniqueItems": true + }, + "Service": { + "description": "The AWS service that is sending logs.", + "maxLength": 255, + "minLength": 1, + "pattern": "[\\w-]*$", + "type": "string" + }, + "Tags": { + "description": "The tags that have been assigned to this delivery source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Service", + "/properties/ResourceArns", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Logs::DeliverySource", + "writeOnlyProperties": [ + "/properties/ResourceArn" + ] +} diff --git a/schema/aws-logs-destination.json b/schema/aws-logs-destination.json index 72368b8..a1ff482 100644 --- a/schema/aws-logs-destination.json +++ b/schema/aws-logs-destination.json @@ -1,83 +1,83 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DestinationName" - ], - "description": "The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.", - "handlers": { - "create": { - "permissions": [ - "logs:PutDestination", - "logs:PutDestinationPolicy", - "logs:DescribeDestinations", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteDestination" - ] - }, - "list": { - "permissions": [ - "logs:DescribeDestinations" - ] - }, - "read": { - "permissions": [ - "logs:DescribeDestinations" - ] - }, - "update": { - "permissions": [ - "logs:PutDestination", - "logs:PutDestinationPolicy", - "logs:DescribeDestinations", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DestinationName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DestinationName": { - "description": "The name of the destination resource", - "maxLength": 512, - "minLength": 1, - "pattern": "^[^:*]{1,512}$", - "type": "string" - }, - "DestinationPolicy": { - "description": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination.", - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource", - "minLength": 1, - "type": "string" - }, - "TargetArn": { - "description": "The ARN of the physical target where the log events are delivered (for example, a Kinesis stream)", - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "DestinationName", - "TargetArn", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::Destination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DestinationName" + ], + "description": "The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.", + "handlers": { + "create": { + "permissions": [ + "logs:PutDestination", + "logs:PutDestinationPolicy", + "logs:DescribeDestinations", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteDestination" + ] + }, + "list": { + "permissions": [ + "logs:DescribeDestinations" + ] + }, + "read": { + "permissions": [ + "logs:DescribeDestinations" + ] + }, + "update": { + "permissions": [ + "logs:PutDestination", + "logs:PutDestinationPolicy", + "logs:DescribeDestinations", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DestinationName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DestinationName": { + "description": "The name of the destination resource", + "maxLength": 512, + "minLength": 1, + "pattern": "^[^:*]{1,512}$", + "type": "string" + }, + "DestinationPolicy": { + "description": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination.", + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource", + "minLength": 1, + "type": "string" + }, + "TargetArn": { + "description": "The ARN of the physical target where the log events are delivered (for example, a Kinesis stream)", + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "DestinationName", + "TargetArn", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::Destination" +} diff --git a/schema/aws-logs-loganomalydetector.json b/schema/aws-logs-loganomalydetector.json index 40d8206..46288a0 100644 --- a/schema/aws-logs-loganomalydetector.json +++ b/schema/aws-logs-loganomalydetector.json @@ -1,111 +1,111 @@ -{ - "additionalProperties": false, - "description": "The AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.", - "handlers": { - "create": { - "permissions": [ - "logs:CreateLogAnomalyDetector" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteLogAnomalyDetector" - ] - }, - "list": { - "permissions": [ - "logs:ListLogAnomalyDetectors" - ] - }, - "read": { - "permissions": [ - "logs:GetLogAnomalyDetector" - ] - }, - "update": { - "permissions": [ - "logs:UpdateLogAnomalyDetector" - ] - } - }, - "primaryIdentifier": [ - "/properties/AnomalyDetectorArn" - ], - "properties": { - "AccountId": { - "description": "Account ID for owner of detector", - "type": "string" - }, - "AnomalyDetectorArn": { - "description": "ARN of LogAnomalyDetector", - "type": "string" - }, - "AnomalyDetectorStatus": { - "description": "Current status of detector.", - "type": "string" - }, - "AnomalyVisibilityTime": { - "description": "", - "type": "number" - }, - "CreationTimeStamp": { - "description": "When detector was created.", - "type": "number" - }, - "DetectorName": { - "description": "Name of detector", - "type": "string" - }, - "EvaluationFrequency": { - "description": "How often log group is evaluated", - "enum": [ - "FIVE_MIN", - "TEN_MIN", - "FIFTEEN_MIN", - "THIRTY_MIN", - "ONE_HOUR" - ], - "type": "string" - }, - "FilterPattern": { - "description": "", - "pattern": "", - "type": "string" - }, - "KmsKeyId": { - "description": "The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.", - "maxLength": 256, - "type": "string" - }, - "LastModifiedTimeStamp": { - "description": "When detector was lsat modified.", - "type": "number" - }, - "LogGroupArnList": { - "description": "List of Arns for the given log group", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AnomalyDetectorArn", - "/properties/CreationTimeStamp", - "/properties/LastModifiedTimeStamp", - "/properties/AnomalyDetectorStatus" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::LogAnomalyDetector", - "writeOnlyProperties": [ - "/properties/AccountId" - ] -} +{ + "additionalProperties": false, + "description": "The AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.", + "handlers": { + "create": { + "permissions": [ + "logs:CreateLogAnomalyDetector" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteLogAnomalyDetector" + ] + }, + "list": { + "permissions": [ + "logs:ListLogAnomalyDetectors" + ] + }, + "read": { + "permissions": [ + "logs:GetLogAnomalyDetector" + ] + }, + "update": { + "permissions": [ + "logs:UpdateLogAnomalyDetector" + ] + } + }, + "primaryIdentifier": [ + "/properties/AnomalyDetectorArn" + ], + "properties": { + "AccountId": { + "description": "Account ID for owner of detector", + "type": "string" + }, + "AnomalyDetectorArn": { + "description": "ARN of LogAnomalyDetector", + "type": "string" + }, + "AnomalyDetectorStatus": { + "description": "Current status of detector.", + "type": "string" + }, + "AnomalyVisibilityTime": { + "description": "", + "type": "number" + }, + "CreationTimeStamp": { + "description": "When detector was created.", + "type": "number" + }, + "DetectorName": { + "description": "Name of detector", + "type": "string" + }, + "EvaluationFrequency": { + "description": "How often log group is evaluated", + "enum": [ + "FIVE_MIN", + "TEN_MIN", + "FIFTEEN_MIN", + "THIRTY_MIN", + "ONE_HOUR" + ], + "type": "string" + }, + "FilterPattern": { + "description": "", + "pattern": "", + "type": "string" + }, + "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.", + "maxLength": 256, + "type": "string" + }, + "LastModifiedTimeStamp": { + "description": "When detector was lsat modified.", + "type": "number" + }, + "LogGroupArnList": { + "description": "List of Arns for the given log group", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AnomalyDetectorArn", + "/properties/CreationTimeStamp", + "/properties/LastModifiedTimeStamp", + "/properties/AnomalyDetectorStatus" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::LogAnomalyDetector", + "writeOnlyProperties": [ + "/properties/AccountId" + ] +} diff --git a/schema/aws-logs-loggroup.json b/schema/aws-logs-loggroup.json index b7c624c..67616b6 100644 --- a/schema/aws-logs-loggroup.json +++ b/schema/aws-logs-loggroup.json @@ -1,177 +1,177 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LogGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The ``AWS::Logs::LogGroup`` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.\n You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:\n + Log group names must be unique within a Region for an AWS account.\n + Log group names can be between 1 and 512 characters long.\n + Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).", - "handlers": { - "create": { - "permissions": [ - "logs:DescribeLogGroups", - "logs:CreateLogGroup", - "logs:PutRetentionPolicy", - "logs:TagResource", - "logs:GetDataProtectionPolicy", - "logs:PutDataProtectionPolicy", - "logs:CreateLogDelivery", - "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies" - ] - }, - "delete": { - "permissions": [ - "logs:DescribeLogGroups", - "logs:DeleteLogGroup", - "logs:DeleteDataProtectionPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "LogGroupName": { - "$ref": "resource-schema.json#/properties/LogGroupName" - } - }, - "required": [] - }, - "permissions": [ - "logs:DescribeLogGroups", - "logs:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "logs:DescribeLogGroups", - "logs:ListTagsForResource", - "logs:GetDataProtectionPolicy" - ] - }, - "update": { - "permissions": [ - "logs:DescribeLogGroups", - "logs:AssociateKmsKey", - "logs:DisassociateKmsKey", - "logs:PutRetentionPolicy", - "logs:DeleteRetentionPolicy", - "logs:TagResource", - "logs:UntagResource", - "logs:GetDataProtectionPolicy", - "logs:PutDataProtectionPolicy", - "logs:CreateLogDelivery", - "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/LogGroupName" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "DataProtectionPolicy": { - "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).", - "type": "object" - }, - "KmsKeyId": { - "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.\n To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested.\n If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error.\n Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)", - "maxLength": 256, - "pattern": "^arn:[a-z0-9-]+:kms:[a-z0-9-]+:\\d{12}:(key|alias)/.+\\Z", - "type": "string" - }, - "LogGroupClass": { - "default": "STANDARD", - "description": "Specifies the log group class for this log group. There are two classes:\n + The ``Standard`` log class supports all CWL features.\n + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs.\n \n For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", - "enum": [ - "STANDARD", - "INFREQUENT_ACCESS" - ], - "type": "string" - }, - "LogGroupName": { - "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}\\Z", - "type": "string" - }, - "RetentionInDays": { - "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).", - "enum": [ - 1, - 3, - 5, - 7, - 14, - 30, - 60, - 90, - 120, - 150, - 180, - 365, - 400, - 545, - 731, - 1096, - 1827, - 2192, - 2557, - 2922, - 3288, - 3653 - ], - "type": "integer" - }, - "Tags": { - "description": "An array of key-value pairs to apply to the log group.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Logs::LogGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LogGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The ``AWS::Logs::LogGroup`` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.\n You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:\n + Log group names must be unique within a Region for an AWS account.\n + Log group names can be between 1 and 512 characters long.\n + Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).", + "handlers": { + "create": { + "permissions": [ + "logs:DescribeLogGroups", + "logs:CreateLogGroup", + "logs:PutRetentionPolicy", + "logs:TagResource", + "logs:GetDataProtectionPolicy", + "logs:PutDataProtectionPolicy", + "logs:CreateLogDelivery", + "s3:REST.PUT.OBJECT", + "firehose:TagDeliveryStream", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies" + ] + }, + "delete": { + "permissions": [ + "logs:DescribeLogGroups", + "logs:DeleteLogGroup", + "logs:DeleteDataProtectionPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "LogGroupName": { + "$ref": "resource-schema.json#/properties/LogGroupName" + } + }, + "required": [] + }, + "permissions": [ + "logs:DescribeLogGroups", + "logs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "logs:DescribeLogGroups", + "logs:ListTagsForResource", + "logs:GetDataProtectionPolicy" + ] + }, + "update": { + "permissions": [ + "logs:DescribeLogGroups", + "logs:AssociateKmsKey", + "logs:DisassociateKmsKey", + "logs:PutRetentionPolicy", + "logs:DeleteRetentionPolicy", + "logs:TagResource", + "logs:UntagResource", + "logs:GetDataProtectionPolicy", + "logs:PutDataProtectionPolicy", + "logs:CreateLogDelivery", + "s3:REST.PUT.OBJECT", + "firehose:TagDeliveryStream" + ] + } + }, + "primaryIdentifier": [ + "/properties/LogGroupName" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "DataProtectionPolicy": { + "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).", + "type": "object" + }, + "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.\n To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested.\n If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error.\n Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)", + "maxLength": 256, + "pattern": "^arn:[a-z0-9-]+:kms:[a-z0-9-]+:\\d{12}:(key|alias)/.+\\Z", + "type": "string" + }, + "LogGroupClass": { + "default": "STANDARD", + "description": "Specifies the log group class for this log group. There are two classes:\n + The ``Standard`` log class supports all CWL features.\n + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs.\n \n For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", + "enum": [ + "STANDARD", + "INFREQUENT_ACCESS" + ], + "type": "string" + }, + "LogGroupName": { + "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}\\Z", + "type": "string" + }, + "RetentionInDays": { + "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).", + "enum": [ + 1, + 3, + 5, + 7, + 14, + 30, + 60, + 90, + 120, + 150, + 180, + 365, + 400, + 545, + 731, + 1096, + 1827, + 2192, + 2557, + 2922, + 3288, + 3653 + ], + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to the log group.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Logs::LogGroup" +} diff --git a/schema/aws-logs-logstream.json b/schema/aws-logs-logstream.json index 93e3ac4..665b014 100644 --- a/schema/aws-logs-logstream.json +++ b/schema/aws-logs-logstream.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LogGroupName", - "/properties/LogStreamName" - ], - "description": "Resource Type definition for AWS::Logs::LogStream", - "handlers": { - "create": { - "permissions": [ - "logs:CreateLogStream", - "logs:DescribeLogStreams" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteLogStream" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "LogGroupName": { - "$ref": "resource-schema.json#/properties/LogGroupName" - } - }, - "required": [ - "LogGroupName" - ] - }, - "permissions": [ - "logs:DescribeLogStreams" - ] - }, - "read": { - "permissions": [ - "logs:DescribeLogStreams" - ] - } - }, - "primaryIdentifier": [ - "/properties/LogGroupName", - "/properties/LogStreamName" - ], - "properties": { - "LogGroupName": { - "description": "The name of the log group where the log stream is created.", - "type": "string" - }, - "LogStreamName": { - "description": "The name of the log stream. The name must be unique wihtin the log group.", - "type": "string" - } - }, - "required": [ - "LogGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::LogStream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LogGroupName", + "/properties/LogStreamName" + ], + "description": "Resource Type definition for AWS::Logs::LogStream", + "handlers": { + "create": { + "permissions": [ + "logs:CreateLogStream", + "logs:DescribeLogStreams" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteLogStream" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "LogGroupName": { + "$ref": "resource-schema.json#/properties/LogGroupName" + } + }, + "required": [ + "LogGroupName" + ] + }, + "permissions": [ + "logs:DescribeLogStreams" + ] + }, + "read": { + "permissions": [ + "logs:DescribeLogStreams" + ] + } + }, + "primaryIdentifier": [ + "/properties/LogGroupName", + "/properties/LogStreamName" + ], + "properties": { + "LogGroupName": { + "description": "The name of the log group where the log stream is created.", + "type": "string" + }, + "LogStreamName": { + "description": "The name of the log stream. The name must be unique wihtin the log group.", + "type": "string" + } + }, + "required": [ + "LogGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::LogStream" +} diff --git a/schema/aws-logs-metricfilter.json b/schema/aws-logs-metricfilter.json index e7d5438..b64921a 100644 --- a/schema/aws-logs-metricfilter.json +++ b/schema/aws-logs-metricfilter.json @@ -1,197 +1,197 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FilterName", - "/properties/LogGroupName" - ], - "definitions": { - "Dimension": { - "additionalProperties": false, - "description": "Specifies the CW metric dimensions to publish with this metric.\n Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.\n For more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions).\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", - "properties": { - "Key": { - "description": "The name for the CW metric dimension that the metric filter creates.\n Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "MetricTransformation": { - "additionalProperties": false, - "description": "``MetricTransformation`` is a property of the ``AWS::Logs::MetricFilter`` resource that describes how to transform log streams into a CloudWatch metric.", - "properties": { - "DefaultValue": { - "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.", - "type": "number" - }, - "Dimensions": { - "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Dimension" - }, - "maxItems": 3, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "MetricName": { - "description": "The name of the CloudWatch metric.", - "maxLength": 255, - "minLength": 1, - "pattern": "^((?![:*$])[\\x00-\\x7F]){1,255}", - "type": "string" - }, - "MetricNamespace": { - "$comment": "Namespaces can be up to 256 characters long; valid characters include 0-9A-Za-z.-_/#", - "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[0-9a-zA-Z\\.\\-_\\/#]{1,256}", - "type": "string" - }, - "MetricValue": { - "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``.", - "maxLength": 100, - "minLength": 1, - "pattern": ".{1,100}", - "type": "string" - }, - "Unit": { - "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``.", - "enum": [ - "Seconds", - "Microseconds", - "Milliseconds", - "Bytes", - "Kilobytes", - "Megabytes", - "Gigabytes", - "Terabytes", - "Bits", - "Kilobits", - "Megabits", - "Gigabits", - "Terabits", - "Percent", - "Count", - "Bytes/Second", - "Kilobytes/Second", - "Megabytes/Second", - "Gigabytes/Second", - "Terabytes/Second", - "Bits/Second", - "Kilobits/Second", - "Megabits/Second", - "Gigabits/Second", - "Terabits/Second", - "Count/Second", - "None" - ], - "type": "string" - } - }, - "required": [ - "MetricName", - "MetricNamespace", - "MetricValue" - ], - "type": "object" - } - }, - "description": "The ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.\n The maximum number of metric filters that can be associated with a log group is 100.", - "handlers": { - "create": { - "permissions": [ - "logs:PutMetricFilter", - "logs:DescribeMetricFilters" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteMetricFilter" - ] - }, - "list": { - "permissions": [ - "logs:DescribeMetricFilters" - ] - }, - "read": { - "permissions": [ - "logs:DescribeMetricFilters" - ] - }, - "update": { - "permissions": [ - "logs:PutMetricFilter", - "logs:DescribeMetricFilters" - ] - } - }, - "primaryIdentifier": [ - "/properties/LogGroupName", - "/properties/FilterName" - ], - "properties": { - "FilterName": { - "description": "The name of the metric filter.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[^:*]{1,512}", - "type": "string" - }, - "FilterPattern": { - "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", - "maxLength": 1024, - "type": "string" - }, - "LogGroupName": { - "description": "The name of an existing log group that you want to associate with this metric filter.", - "maxLength": 512, - "minLength": 1, - "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}", - "type": "string" - }, - "MetricTransformations": { - "description": "The metric transformations.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricTransformation" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "FilterPattern", - "LogGroupName", - "MetricTransformations" - ], - "resourceLink": { - "mappings": { - "LogGroupName": "/LogGroupName", - "MetricName": "/MetricName" - }, - "templateUri": "/cloudwatch/home?region=${awsRegion}#logsV2:log-groups/log-group/${LogGroupName}/edit-metric-filter/${MetricName}" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::MetricFilter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FilterName", + "/properties/LogGroupName" + ], + "definitions": { + "Dimension": { + "additionalProperties": false, + "description": "Specifies the CW metric dimensions to publish with this metric.\n Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.\n For more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions).\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", + "properties": { + "Key": { + "description": "The name for the CW metric dimension that the metric filter creates.\n Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "MetricTransformation": { + "additionalProperties": false, + "description": "``MetricTransformation`` is a property of the ``AWS::Logs::MetricFilter`` resource that describes how to transform log streams into a CloudWatch metric.", + "properties": { + "DefaultValue": { + "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.", + "type": "number" + }, + "Dimensions": { + "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Dimension" + }, + "maxItems": 3, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MetricName": { + "description": "The name of the CloudWatch metric.", + "maxLength": 255, + "minLength": 1, + "pattern": "^((?![:*$])[\\x00-\\x7F]){1,255}", + "type": "string" + }, + "MetricNamespace": { + "$comment": "Namespaces can be up to 256 characters long; valid characters include 0-9A-Za-z.-_/#", + "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).", + "maxLength": 256, + "minLength": 1, + "pattern": "^[0-9a-zA-Z\\.\\-_\\/#]{1,256}", + "type": "string" + }, + "MetricValue": { + "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``.", + "maxLength": 100, + "minLength": 1, + "pattern": ".{1,100}", + "type": "string" + }, + "Unit": { + "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``.", + "enum": [ + "Seconds", + "Microseconds", + "Milliseconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ], + "type": "string" + } + }, + "required": [ + "MetricName", + "MetricNamespace", + "MetricValue" + ], + "type": "object" + } + }, + "description": "The ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.\n The maximum number of metric filters that can be associated with a log group is 100.", + "handlers": { + "create": { + "permissions": [ + "logs:PutMetricFilter", + "logs:DescribeMetricFilters" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteMetricFilter" + ] + }, + "list": { + "permissions": [ + "logs:DescribeMetricFilters" + ] + }, + "read": { + "permissions": [ + "logs:DescribeMetricFilters" + ] + }, + "update": { + "permissions": [ + "logs:PutMetricFilter", + "logs:DescribeMetricFilters" + ] + } + }, + "primaryIdentifier": [ + "/properties/LogGroupName", + "/properties/FilterName" + ], + "properties": { + "FilterName": { + "description": "The name of the metric filter.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[^:*]{1,512}", + "type": "string" + }, + "FilterPattern": { + "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", + "maxLength": 1024, + "type": "string" + }, + "LogGroupName": { + "description": "The name of an existing log group that you want to associate with this metric filter.", + "maxLength": 512, + "minLength": 1, + "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}", + "type": "string" + }, + "MetricTransformations": { + "description": "The metric transformations.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricTransformation" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "FilterPattern", + "LogGroupName", + "MetricTransformations" + ], + "resourceLink": { + "mappings": { + "LogGroupName": "/LogGroupName", + "MetricName": "/MetricName" + }, + "templateUri": "/cloudwatch/home?region=${awsRegion}#logsV2:log-groups/log-group/${LogGroupName}/edit-metric-filter/${MetricName}" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::MetricFilter" +} diff --git a/schema/aws-logs-querydefinition.json b/schema/aws-logs-querydefinition.json index b6d4a94..f90be6a 100644 --- a/schema/aws-logs-querydefinition.json +++ b/schema/aws-logs-querydefinition.json @@ -1,83 +1,83 @@ -{ - "additionalProperties": false, - "definitions": { - "LogGroup": { - "maxLength": 512, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - } - }, - "description": "The resource schema for AWSLogs QueryDefinition", - "handlers": { - "create": { - "permissions": [ - "logs:PutQueryDefinition" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteQueryDefinition" - ] - }, - "list": { - "permissions": [ - "logs:DescribeQueryDefinitions" - ] - }, - "read": { - "permissions": [ - "logs:DescribeQueryDefinitions" - ] - }, - "update": { - "permissions": [ - "logs:PutQueryDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/QueryDefinitionId" - ], - "properties": { - "LogGroupNames": { - "description": "Optionally define specific log groups as part of your query definition", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogGroup", - "description": "LogGroup name" - }, - "type": "array" - }, - "Name": { - "description": "A name for the saved query definition", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "QueryDefinitionId": { - "description": "Unique identifier of a query definition", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "QueryString": { - "description": "The query string to use for this definition", - "maxLength": 10000, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/QueryDefinitionId" - ], - "required": [ - "Name", - "QueryString" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::QueryDefinition" -} +{ + "additionalProperties": false, + "definitions": { + "LogGroup": { + "maxLength": 512, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + } + }, + "description": "The resource schema for AWSLogs QueryDefinition", + "handlers": { + "create": { + "permissions": [ + "logs:PutQueryDefinition" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteQueryDefinition" + ] + }, + "list": { + "permissions": [ + "logs:DescribeQueryDefinitions" + ] + }, + "read": { + "permissions": [ + "logs:DescribeQueryDefinitions" + ] + }, + "update": { + "permissions": [ + "logs:PutQueryDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/QueryDefinitionId" + ], + "properties": { + "LogGroupNames": { + "description": "Optionally define specific log groups as part of your query definition", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogGroup", + "description": "LogGroup name" + }, + "type": "array" + }, + "Name": { + "description": "A name for the saved query definition", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "QueryDefinitionId": { + "description": "Unique identifier of a query definition", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "QueryString": { + "description": "The query string to use for this definition", + "maxLength": 10000, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/QueryDefinitionId" + ], + "required": [ + "Name", + "QueryString" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::QueryDefinition" +} diff --git a/schema/aws-logs-resourcepolicy.json b/schema/aws-logs-resourcepolicy.json index 79fd86a..26f526f 100644 --- a/schema/aws-logs-resourcepolicy.json +++ b/schema/aws-logs-resourcepolicy.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName" - ], - "description": "The resource schema for AWSLogs ResourcePolicy", - "handlers": { - "create": { - "permissions": [ - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteResourcePolicy" - ] - }, - "list": { - "permissions": [ - "logs:DescribeResourcePolicies" - ] - }, - "read": { - "permissions": [ - "logs:DescribeResourcePolicies" - ] - }, - "update": { - "permissions": [ - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DeleteResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyName" - ], - "properties": { - "PolicyDocument": { - "description": "The policy document", - "maxLength": 5120, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "type": "string" - }, - "PolicyName": { - "description": "A name for resource policy", - "maxLength": 255, - "minLength": 1, - "pattern": "^([^:*\\/]+\\/?)*[^:*\\/]+$", - "type": "string" - } - }, - "required": [ - "PolicyName", - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Logs::ResourcePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName" + ], + "description": "The resource schema for AWSLogs ResourcePolicy", + "handlers": { + "create": { + "permissions": [ + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteResourcePolicy" + ] + }, + "list": { + "permissions": [ + "logs:DescribeResourcePolicies" + ] + }, + "read": { + "permissions": [ + "logs:DescribeResourcePolicies" + ] + }, + "update": { + "permissions": [ + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DeleteResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyName" + ], + "properties": { + "PolicyDocument": { + "description": "The policy document", + "maxLength": 5120, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "type": "string" + }, + "PolicyName": { + "description": "A name for resource policy", + "maxLength": 255, + "minLength": 1, + "pattern": "^([^:*\\/]+\\/?)*[^:*\\/]+$", + "type": "string" + } + }, + "required": [ + "PolicyName", + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Logs::ResourcePolicy" +} diff --git a/schema/aws-logs-subscriptionfilter.json b/schema/aws-logs-subscriptionfilter.json index a49dbc2..f20d90b 100644 --- a/schema/aws-logs-subscriptionfilter.json +++ b/schema/aws-logs-subscriptionfilter.json @@ -1,98 +1,98 @@ -{ - "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli/master/src/rpdk/core/data/schema/provider.definition.schema.v1.json", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FilterName", - "/properties/LogGroupName" - ], - "description": "The ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:\n + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.\n + A logical destination that belongs to a different account, for cross-account delivery.\n + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.\n + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.\n \n There can be as many as two subscription filters associated with a log group.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "logs:PutSubscriptionFilter", - "logs:DescribeSubscriptionFilters" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteSubscriptionFilter" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "LogGroupName": { - "$ref": "resource-schema.json#/properties/LogGroupName" - } - }, - "required": [ - "LogGroupName" - ] - }, - "permissions": [ - "logs:DescribeSubscriptionFilters" - ] - }, - "read": { - "permissions": [ - "logs:DescribeSubscriptionFilters" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "logs:PutSubscriptionFilter", - "logs:DescribeSubscriptionFilters" - ] - } - }, - "primaryIdentifier": [ - "/properties/FilterName", - "/properties/LogGroupName" - ], - "properties": { - "DestinationArn": { - "description": "The Amazon Resource Name (ARN) of the destination.", - "type": "string" - }, - "Distribution": { - "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream.", - "enum": [ - "Random", - "ByLogStream" - ], - "type": "string" - }, - "FilterName": { - "description": "The name of the subscription filter.", - "type": "string" - }, - "FilterPattern": { - "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", - "type": "string" - }, - "LogGroupName": { - "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.", - "type": "string" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "DestinationArn", - "FilterPattern", - "LogGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Logs::SubscriptionFilter" -} +{ + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli/master/src/rpdk/core/data/schema/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FilterName", + "/properties/LogGroupName" + ], + "description": "The ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:\n + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.\n + A logical destination that belongs to a different account, for cross-account delivery.\n + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.\n + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.\n \n There can be as many as two subscription filters associated with a log group.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "logs:PutSubscriptionFilter", + "logs:DescribeSubscriptionFilters" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteSubscriptionFilter" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "LogGroupName": { + "$ref": "resource-schema.json#/properties/LogGroupName" + } + }, + "required": [ + "LogGroupName" + ] + }, + "permissions": [ + "logs:DescribeSubscriptionFilters" + ] + }, + "read": { + "permissions": [ + "logs:DescribeSubscriptionFilters" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "logs:PutSubscriptionFilter", + "logs:DescribeSubscriptionFilters" + ] + } + }, + "primaryIdentifier": [ + "/properties/FilterName", + "/properties/LogGroupName" + ], + "properties": { + "DestinationArn": { + "description": "The Amazon Resource Name (ARN) of the destination.", + "type": "string" + }, + "Distribution": { + "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream.", + "enum": [ + "Random", + "ByLogStream" + ], + "type": "string" + }, + "FilterName": { + "description": "The name of the subscription filter.", + "type": "string" + }, + "FilterPattern": { + "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", + "type": "string" + }, + "LogGroupName": { + "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "DestinationArn", + "FilterPattern", + "LogGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Logs::SubscriptionFilter" +} diff --git a/schema/aws-lookoutequipment-inferencescheduler.json b/schema/aws-lookoutequipment-inferencescheduler.json index 8c63aba..77add62 100644 --- a/schema/aws-lookoutequipment-inferencescheduler.json +++ b/schema/aws-lookoutequipment-inferencescheduler.json @@ -1,253 +1,253 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InferenceSchedulerName", - "/properties/ModelName", - "/properties/ServerSideKmsKeyId" - ], - "definitions": { - "Bucket": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "InputNameConfiguration": { - "additionalProperties": false, - "description": "Specifies configuration information for the input data for the inference, including timestamp format and delimiter.", - "properties": { - "ComponentTimestampDelimiter": { - "description": "Indicates the delimiter character used between items in the data.", - "maxLength": 1, - "minLength": 0, - "pattern": "^(\\-|\\_|\\s)?$", - "type": "string" - }, - "TimestampFormat": { - "description": "The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).", - "pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$", - "type": "string" - } - }, - "type": "object" - }, - "Prefix": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "S3InputConfiguration": { - "additionalProperties": false, - "description": "Specifies configuration information for the input data for the inference, including input data S3 location.", - "properties": { - "Bucket": { - "$ref": "#/definitions/Bucket" - }, - "Prefix": { - "$ref": "#/definitions/Prefix" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "S3OutputConfiguration": { - "additionalProperties": false, - "description": "Specifies configuration information for the output results from the inference, including output S3 location.", - "properties": { - "Bucket": { - "$ref": "#/definitions/Bucket" - }, - "Prefix": { - "$ref": "#/definitions/Prefix" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A tag is a key-value pair that can be added to a resource as metadata.", - "properties": { - "Key": { - "description": "The key for the specified tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the specified tag.", - "maxLength": 256, - "minLength": 0, - "pattern": "[\\s\\w+-=\\.:/@]*", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for LookoutEquipment InferenceScheduler.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "lookoutequipment:CreateInferenceScheduler", - "lookoutequipment:DescribeInferenceScheduler" - ] - }, - "delete": { - "permissions": [ - "lookoutequipment:DeleteInferenceScheduler", - "lookoutequipment:StopInferenceScheduler", - "lookoutequipment:DescribeInferenceScheduler" - ] - }, - "list": { - "permissions": [ - "lookoutequipment:ListInferenceSchedulers" - ] - }, - "read": { - "permissions": [ - "lookoutequipment:DescribeInferenceScheduler" - ] - }, - "update": { - "permissions": [ - "lookoutequipment:UpdateInferenceScheduler", - "lookoutequipment:DescribeInferenceScheduler", - "lookoutequipment:StopInferenceScheduler", - "lookoutequipment:StartInferenceScheduler" - ] - } - }, - "primaryIdentifier": [ - "/properties/InferenceSchedulerName" - ], - "properties": { - "DataDelayOffsetInMinutes": { - "description": "A period of time (in minutes) by which inference on the data is delayed after the data starts.", - "maximum": 60, - "minimum": 0, - "type": "integer" - }, - "DataInputConfiguration": { - "additionalProperties": false, - "description": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.", - "properties": { - "InferenceInputNameConfiguration": { - "$ref": "#/definitions/InputNameConfiguration" - }, - "InputTimeZoneOffset": { - "description": "Indicates the difference between your time zone and Greenwich Mean Time (GMT).", - "pattern": "^(\\+|\\-)[0-9]{2}\\:[0-9]{2}$", - "type": "string" - }, - "S3InputConfiguration": { - "$ref": "#/definitions/S3InputConfiguration" - } - }, - "required": [ - "S3InputConfiguration" - ], - "type": "object" - }, - "DataOutputConfiguration": { - "additionalProperties": false, - "description": "Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.", - "properties": { - "KmsKeyId": { - "description": "The ID number for the AWS KMS key used to encrypt the inference output.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$", - "type": "string" - }, - "S3OutputConfiguration": { - "$ref": "#/definitions/S3OutputConfiguration" - } - }, - "required": [ - "S3OutputConfiguration" - ], - "type": "object" - }, - "DataUploadFrequency": { - "description": "How often data is uploaded to the source S3 bucket for the input data.", - "enum": [ - "PT5M", - "PT10M", - "PT15M", - "PT30M", - "PT1H" - ], - "type": "string" - }, - "InferenceSchedulerArn": { - "description": "The Amazon Resource Name (ARN) of the inference scheduler being created.", - "maxLength": 200, - "minLength": 1, - "pattern": "arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:inference-scheduler\\/.+", - "type": "string" - }, - "InferenceSchedulerName": { - "description": "The name of the inference scheduler being created.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[0-9a-zA-Z_-]{1,200}$", - "type": "string" - }, - "ModelName": { - "description": "The name of the previously trained ML model being used to create the inference scheduler.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[0-9a-zA-Z_-]{1,200}$", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", - "type": "string" - }, - "ServerSideKmsKeyId": { - "description": "Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$", - "type": "string" - }, - "Tags": { - "description": "Any tags associated with the inference scheduler.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/InferenceSchedulerArn" - ], - "required": [ - "DataInputConfiguration", - "DataOutputConfiguration", - "DataUploadFrequency", - "ModelName", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::LookoutEquipment::InferenceScheduler" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InferenceSchedulerName", + "/properties/ModelName", + "/properties/ServerSideKmsKeyId" + ], + "definitions": { + "Bucket": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "InputNameConfiguration": { + "additionalProperties": false, + "description": "Specifies configuration information for the input data for the inference, including timestamp format and delimiter.", + "properties": { + "ComponentTimestampDelimiter": { + "description": "Indicates the delimiter character used between items in the data.", + "maxLength": 1, + "minLength": 0, + "pattern": "^(\\-|\\_|\\s)?$", + "type": "string" + }, + "TimestampFormat": { + "description": "The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).", + "pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$", + "type": "string" + } + }, + "type": "object" + }, + "Prefix": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "S3InputConfiguration": { + "additionalProperties": false, + "description": "Specifies configuration information for the input data for the inference, including input data S3 location.", + "properties": { + "Bucket": { + "$ref": "#/definitions/Bucket" + }, + "Prefix": { + "$ref": "#/definitions/Prefix" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "S3OutputConfiguration": { + "additionalProperties": false, + "description": "Specifies configuration information for the output results from the inference, including output S3 location.", + "properties": { + "Bucket": { + "$ref": "#/definitions/Bucket" + }, + "Prefix": { + "$ref": "#/definitions/Prefix" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A tag is a key-value pair that can be added to a resource as metadata.", + "properties": { + "Key": { + "description": "The key for the specified tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the specified tag.", + "maxLength": 256, + "minLength": 0, + "pattern": "[\\s\\w+-=\\.:/@]*", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for LookoutEquipment InferenceScheduler.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "lookoutequipment:CreateInferenceScheduler", + "lookoutequipment:DescribeInferenceScheduler" + ] + }, + "delete": { + "permissions": [ + "lookoutequipment:DeleteInferenceScheduler", + "lookoutequipment:StopInferenceScheduler", + "lookoutequipment:DescribeInferenceScheduler" + ] + }, + "list": { + "permissions": [ + "lookoutequipment:ListInferenceSchedulers" + ] + }, + "read": { + "permissions": [ + "lookoutequipment:DescribeInferenceScheduler" + ] + }, + "update": { + "permissions": [ + "lookoutequipment:UpdateInferenceScheduler", + "lookoutequipment:DescribeInferenceScheduler", + "lookoutequipment:StopInferenceScheduler", + "lookoutequipment:StartInferenceScheduler" + ] + } + }, + "primaryIdentifier": [ + "/properties/InferenceSchedulerName" + ], + "properties": { + "DataDelayOffsetInMinutes": { + "description": "A period of time (in minutes) by which inference on the data is delayed after the data starts.", + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "DataInputConfiguration": { + "additionalProperties": false, + "description": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.", + "properties": { + "InferenceInputNameConfiguration": { + "$ref": "#/definitions/InputNameConfiguration" + }, + "InputTimeZoneOffset": { + "description": "Indicates the difference between your time zone and Greenwich Mean Time (GMT).", + "pattern": "^(\\+|\\-)[0-9]{2}\\:[0-9]{2}$", + "type": "string" + }, + "S3InputConfiguration": { + "$ref": "#/definitions/S3InputConfiguration" + } + }, + "required": [ + "S3InputConfiguration" + ], + "type": "object" + }, + "DataOutputConfiguration": { + "additionalProperties": false, + "description": "Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.", + "properties": { + "KmsKeyId": { + "description": "The ID number for the AWS KMS key used to encrypt the inference output.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$", + "type": "string" + }, + "S3OutputConfiguration": { + "$ref": "#/definitions/S3OutputConfiguration" + } + }, + "required": [ + "S3OutputConfiguration" + ], + "type": "object" + }, + "DataUploadFrequency": { + "description": "How often data is uploaded to the source S3 bucket for the input data.", + "enum": [ + "PT5M", + "PT10M", + "PT15M", + "PT30M", + "PT1H" + ], + "type": "string" + }, + "InferenceSchedulerArn": { + "description": "The Amazon Resource Name (ARN) of the inference scheduler being created.", + "maxLength": 200, + "minLength": 1, + "pattern": "arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:inference-scheduler\\/.+", + "type": "string" + }, + "InferenceSchedulerName": { + "description": "The name of the inference scheduler being created.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]{1,200}$", + "type": "string" + }, + "ModelName": { + "description": "The name of the previously trained ML model being used to create the inference scheduler.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]{1,200}$", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+", + "type": "string" + }, + "ServerSideKmsKeyId": { + "description": "Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$", + "type": "string" + }, + "Tags": { + "description": "Any tags associated with the inference scheduler.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/InferenceSchedulerArn" + ], + "required": [ + "DataInputConfiguration", + "DataOutputConfiguration", + "DataUploadFrequency", + "ModelName", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::LookoutEquipment::InferenceScheduler" +} diff --git a/schema/aws-lookoutmetrics-alert.json b/schema/aws-lookoutmetrics-alert.json index d23e0d7..00f426a 100644 --- a/schema/aws-lookoutmetrics-alert.json +++ b/schema/aws-lookoutmetrics-alert.json @@ -1,139 +1,139 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AlertName", - "/properties/AlertDescription", - "/properties/AnomalyDetectorArn", - "/properties/AlertSensitivityThreshold", - "/properties/Action" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "LambdaConfiguration": { - "$ref": "#/definitions/LambdaConfiguration" - }, - "SNSConfiguration": { - "$ref": "#/definitions/SNSConfiguration" - } - }, - "type": "object" - }, - "Arn": { - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", - "type": "string" - }, - "LambdaConfiguration": { - "additionalProperties": false, - "description": "Configuration options for a Lambda alert action.", - "properties": { - "LambdaArn": { - "$ref": "#/definitions/Arn", - "description": "ARN of a Lambda to send alert notifications to." - }, - "RoleArn": { - "$ref": "#/definitions/Arn", - "description": "ARN of an IAM role that LookoutMetrics should assume to access the Lambda function." - } - }, - "required": [ - "RoleArn", - "LambdaArn" - ], - "type": "object" - }, - "SNSConfiguration": { - "additionalProperties": false, - "description": "Configuration options for an SNS alert action.", - "properties": { - "RoleArn": { - "$ref": "#/definitions/Arn", - "description": "ARN of an IAM role that LookoutMetrics should assume to access the SNS topic." - }, - "SnsTopicArn": { - "$ref": "#/definitions/Arn", - "description": "ARN of an SNS topic to send alert notifications to." - } - }, - "required": [ - "RoleArn", - "SnsTopicArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::LookoutMetrics::Alert", - "handlers": { - "create": { - "permissions": [ - "lookoutmetrics:CreateAlert", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "lookoutmetrics:DeleteAlert" - ] - }, - "list": { - "permissions": [ - "lookoutmetrics:ListAlerts" - ] - }, - "read": { - "permissions": [ - "lookoutmetrics:DescribeAlert" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Action": { - "$ref": "#/definitions/Action", - "description": "The action to be taken by the alert when an anomaly is detected." - }, - "AlertDescription": { - "description": "A description for the alert.", - "maxLength": 256, - "pattern": ".*\\S.*", - "type": "string" - }, - "AlertName": { - "description": "The name of the alert. If not provided, a name is generated automatically.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "AlertSensitivityThreshold": { - "description": "A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.", - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "AnomalyDetectorArn": { - "description": "The Amazon resource name (ARN) of the Anomaly Detector to alert.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn", - "description": "ARN assigned to the alert." - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AnomalyDetectorArn", - "AlertSensitivityThreshold", - "Action" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lookout-for-metrics.git", - "typeName": "AWS::LookoutMetrics::Alert" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AlertName", + "/properties/AlertDescription", + "/properties/AnomalyDetectorArn", + "/properties/AlertSensitivityThreshold", + "/properties/Action" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "LambdaConfiguration": { + "$ref": "#/definitions/LambdaConfiguration" + }, + "SNSConfiguration": { + "$ref": "#/definitions/SNSConfiguration" + } + }, + "type": "object" + }, + "Arn": { + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", + "type": "string" + }, + "LambdaConfiguration": { + "additionalProperties": false, + "description": "Configuration options for a Lambda alert action.", + "properties": { + "LambdaArn": { + "$ref": "#/definitions/Arn", + "description": "ARN of a Lambda to send alert notifications to." + }, + "RoleArn": { + "$ref": "#/definitions/Arn", + "description": "ARN of an IAM role that LookoutMetrics should assume to access the Lambda function." + } + }, + "required": [ + "RoleArn", + "LambdaArn" + ], + "type": "object" + }, + "SNSConfiguration": { + "additionalProperties": false, + "description": "Configuration options for an SNS alert action.", + "properties": { + "RoleArn": { + "$ref": "#/definitions/Arn", + "description": "ARN of an IAM role that LookoutMetrics should assume to access the SNS topic." + }, + "SnsTopicArn": { + "$ref": "#/definitions/Arn", + "description": "ARN of an SNS topic to send alert notifications to." + } + }, + "required": [ + "RoleArn", + "SnsTopicArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::LookoutMetrics::Alert", + "handlers": { + "create": { + "permissions": [ + "lookoutmetrics:CreateAlert", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "lookoutmetrics:DeleteAlert" + ] + }, + "list": { + "permissions": [ + "lookoutmetrics:ListAlerts" + ] + }, + "read": { + "permissions": [ + "lookoutmetrics:DescribeAlert" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Action": { + "$ref": "#/definitions/Action", + "description": "The action to be taken by the alert when an anomaly is detected." + }, + "AlertDescription": { + "description": "A description for the alert.", + "maxLength": 256, + "pattern": ".*\\S.*", + "type": "string" + }, + "AlertName": { + "description": "The name of the alert. If not provided, a name is generated automatically.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "AlertSensitivityThreshold": { + "description": "A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "AnomalyDetectorArn": { + "description": "The Amazon resource name (ARN) of the Anomaly Detector to alert.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn", + "description": "ARN assigned to the alert." + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AnomalyDetectorArn", + "AlertSensitivityThreshold", + "Action" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lookout-for-metrics.git", + "typeName": "AWS::LookoutMetrics::Alert" +} diff --git a/schema/aws-lookoutmetrics-anomalydetector.json b/schema/aws-lookoutmetrics-anomalydetector.json index 9cb4462..ef0edc9 100644 --- a/schema/aws-lookoutmetrics-anomalydetector.json +++ b/schema/aws-lookoutmetrics-anomalydetector.json @@ -1,547 +1,547 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AnomalyDetectorName", - "/properties/MetricSource" - ], - "definitions": { - "AnomalyDetectorConfig": { - "additionalProperties": false, - "properties": { - "AnomalyDetectorFrequency": { - "$ref": "#/definitions/AnomalyDetectorFrequency", - "description": "Frequency of anomaly detection" - } - }, - "required": [ - "AnomalyDetectorFrequency" - ], - "type": "object" - }, - "AnomalyDetectorFrequency": { - "description": "Frequency of anomaly detection", - "enum": [ - "PT5M", - "PT10M", - "PT1H", - "P1D" - ], - "type": "string" - }, - "AppFlowConfig": { - "additionalProperties": false, - "properties": { - "FlowName": { - "maxLength": 256, - "pattern": "[a-zA-Z0-9][\\w!@#.-]+", - "type": "string" - }, - "RoleArn": { - "$ref": "#/definitions/Arn" - } - }, - "required": [ - "RoleArn", - "FlowName" - ], - "type": "object" - }, - "Arn": { - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", - "type": "string" - }, - "Charset": { - "maxLength": 63, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "CloudwatchConfig": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "$ref": "#/definitions/Arn" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "ColumnName": { - "description": "Name of a column in the data.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "CsvFormatDescriptor": { - "additionalProperties": false, - "properties": { - "Charset": { - "$ref": "#/definitions/Charset" - }, - "ContainsHeader": { - "type": "boolean" - }, - "Delimiter": { - "maxLength": 1, - "pattern": "[^\\r\\n]", - "type": "string" - }, - "FileCompression": { - "enum": [ - "NONE", - "GZIP" - ], - "type": "string" - }, - "HeaderList": { - "items": { - "$ref": "#/definitions/ColumnName" - }, - "type": "array" - }, - "QuoteSymbol": { - "maxLength": 1, - "pattern": "[^\\r\\n]|^$", - "type": "string" - } - }, - "type": "object" - }, - "DatabaseHost": { - "maxLength": 253, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "DatabasePort": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "FileFormatDescriptor": { - "additionalProperties": false, - "properties": { - "CsvFormatDescriptor": { - "$ref": "#/definitions/CsvFormatDescriptor" - }, - "JsonFormatDescriptor": { - "$ref": "#/definitions/JsonFormatDescriptor" - } - }, - "type": "object" - }, - "JsonFormatDescriptor": { - "additionalProperties": false, - "properties": { - "Charset": { - "$ref": "#/definitions/Charset" - }, - "FileCompression": { - "enum": [ - "NONE", - "GZIP" - ], - "type": "string" - } - }, - "type": "object" - }, - "Metric": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "description": "Operator used to aggregate metric values", - "enum": [ - "AVG", - "SUM" - ], - "type": "string" - }, - "MetricName": { - "$ref": "#/definitions/ColumnName" - }, - "Namespace": { - "maxLength": 255, - "minLength": 1, - "pattern": "[^:].*", - "type": "string" - } - }, - "required": [ - "MetricName", - "AggregationFunction" - ], - "type": "object" - }, - "MetricSet": { - "additionalProperties": false, - "properties": { - "DimensionList": { - "description": "Dimensions for this MetricSet.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ColumnName" - }, - "minItems": 0, - "type": "array" - }, - "MetricList": { - "description": "Metrics captured by this MetricSet.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Metric" - }, - "minItems": 1, - "type": "array" - }, - "MetricSetDescription": { - "description": "A description for the MetricSet.", - "maxLength": 256, - "pattern": ".*\\S.*", - "type": "string" - }, - "MetricSetFrequency": { - "description": "A frequency period to aggregate the data", - "enum": [ - "PT5M", - "PT10M", - "PT1H", - "P1D" - ], - "type": "string" - }, - "MetricSetName": { - "description": "The name of the MetricSet.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "MetricSource": { - "$ref": "#/definitions/MetricSource" - }, - "Offset": { - "description": "Offset, in seconds, between the frequency interval and the time at which the metrics are available.", - "maximum": 432000, - "minimum": 0, - "type": "integer" - }, - "TimestampColumn": { - "$ref": "#/definitions/TimestampColumn" - }, - "Timezone": { - "maxLength": 60, - "pattern": ".*\\S.*", - "type": "string" - } - }, - "required": [ - "MetricSetName", - "MetricList", - "MetricSource" - ], - "type": "object" - }, - "MetricSource": { - "additionalProperties": false, - "properties": { - "AppFlowConfig": { - "$ref": "#/definitions/AppFlowConfig" - }, - "CloudwatchConfig": { - "$ref": "#/definitions/CloudwatchConfig" - }, - "RDSSourceConfig": { - "$ref": "#/definitions/RDSSourceConfig" - }, - "RedshiftSourceConfig": { - "$ref": "#/definitions/RedshiftSourceConfig" - }, - "S3SourceConfig": { - "$ref": "#/definitions/S3SourceConfig" - } - }, - "type": "object" - }, - "RDSSourceConfig": { - "additionalProperties": false, - "properties": { - "DBInstanceIdentifier": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\\-]*$", - "type": "string" - }, - "DatabaseHost": { - "$ref": "#/definitions/DatabaseHost" - }, - "DatabaseName": { - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "DatabasePort": { - "$ref": "#/definitions/DatabasePort" - }, - "RoleArn": { - "$ref": "#/definitions/Arn" - }, - "SecretManagerArn": { - "$ref": "#/definitions/SecretManagerArn" - }, - "TableName": { - "$ref": "#/definitions/TableName" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "required": [ - "DBInstanceIdentifier", - "DatabaseHost", - "DatabasePort", - "SecretManagerArn", - "DatabaseName", - "TableName", - "RoleArn", - "VpcConfiguration" - ], - "type": "object" - }, - "RedshiftSourceConfig": { - "additionalProperties": false, - "properties": { - "ClusterIdentifier": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-z](?!.*--)(?!.*-$)[0-9a-z\\-]*$", - "type": "string" - }, - "DatabaseHost": { - "$ref": "#/definitions/DatabaseHost" - }, - "DatabaseName": { - "maxLength": 100, - "minLength": 1, - "pattern": "[a-z0-9]+", - "type": "string" - }, - "DatabasePort": { - "$ref": "#/definitions/DatabasePort" - }, - "RoleArn": { - "$ref": "#/definitions/Arn" - }, - "SecretManagerArn": { - "$ref": "#/definitions/SecretManagerArn" - }, - "TableName": { - "$ref": "#/definitions/TableName" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration" - } - }, - "required": [ - "ClusterIdentifier", - "DatabaseHost", - "DatabasePort", - "SecretManagerArn", - "DatabaseName", - "TableName", - "RoleArn", - "VpcConfiguration" - ], - "type": "object" - }, - "S3SourceConfig": { - "additionalProperties": false, - "properties": { - "FileFormatDescriptor": { - "$ref": "#/definitions/FileFormatDescriptor" - }, - "HistoricalDataPathList": { - "items": { - "maxLength": 1024, - "pattern": "^s3://[a-z0-9].+$", - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "RoleArn": { - "$ref": "#/definitions/Arn" - }, - "TemplatedPathList": { - "items": { - "maxLength": 1024, - "pattern": "^s3://[a-zA-Z0-9_\\-\\/ {}=]+$", - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "RoleArn", - "FileFormatDescriptor" - ], - "type": "object" - }, - "SecretManagerArn": { - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+", - "type": "string" - }, - "SecurityGroupIdList": { - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "type": "array" - }, - "SubnetIdList": { - "items": { - "maxLength": 255, - "pattern": "[\\-0-9a-zA-Z]+", - "type": "string" - }, - "type": "array" - }, - "TableName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", - "type": "string" - }, - "TimestampColumn": { - "additionalProperties": false, - "properties": { - "ColumnFormat": { - "description": "A timestamp format for the timestamps in the dataset", - "maxLength": 63, - "pattern": ".*\\S.*", - "type": "string" - }, - "ColumnName": { - "$ref": "#/definitions/ColumnName" - } - }, - "type": "object" - }, - "VpcConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIdList": { - "$ref": "#/definitions/SecurityGroupIdList" - }, - "SubnetIdList": { - "$ref": "#/definitions/SubnetIdList" - } - }, - "required": [ - "SubnetIdList", - "SecurityGroupIdList" - ], - "type": "object" - } - }, - "description": "An Amazon Lookout for Metrics Detector", - "handlers": { - "create": { - "permissions": [ - "lookoutmetrics:CreateAnomalyDetector", - "lookoutmetrics:DeleteAnomalyDetector", - "lookoutmetrics:CreateMetricSet", - "iam:PassRole" - ], - "timeoutInMinutes": 15 - }, - "delete": { - "permissions": [ - "lookoutmetrics:DescribeAnomalyDetector", - "lookoutmetrics:DeleteAnomalyDetector" - ], - "timeoutInMinutes": 15 - }, - "list": { - "permissions": [ - "lookoutmetrics:ListAnomalyDetectors" - ], - "timeoutInMinutes": 15 - }, - "read": { - "permissions": [ - "lookoutmetrics:DescribeAnomalyDetector", - "lookoutmetrics:DescribeMetricSet", - "lookoutmetrics:ListMetricSets" - ], - "timeoutInMinutes": 15 - }, - "update": { - "permissions": [ - "lookoutmetrics:UpdateAnomalyDetector", - "lookoutmetrics:UpdateMetricSet" - ], - "timeoutInMinutes": 15 - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AnomalyDetectorConfig": { - "$ref": "#/definitions/AnomalyDetectorConfig", - "description": "Configuration options for the AnomalyDetector" - }, - "AnomalyDetectorDescription": { - "description": "A description for the AnomalyDetector.", - "maxLength": 256, - "pattern": ".*\\S.*", - "type": "string" - }, - "AnomalyDetectorName": { - "description": "Name for the Amazon Lookout for Metrics Anomaly Detector", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "KmsKeyArn": { - "description": "KMS key used to encrypt the AnomalyDetector data", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/.*", - "type": "string" - }, - "MetricSetList": { - "description": "List of metric sets for anomaly detection", - "items": { - "$ref": "#/definitions/MetricSet" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "AnomalyDetectorConfig", - "MetricSetList" - ], - "sourceUrl": "https://docs.aws.amazon.com/lookoutmetrics/latest/dev/lookoutmetrics-welcome.html", - "typeName": "AWS::LookoutMetrics::AnomalyDetector" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AnomalyDetectorName", + "/properties/MetricSource" + ], + "definitions": { + "AnomalyDetectorConfig": { + "additionalProperties": false, + "properties": { + "AnomalyDetectorFrequency": { + "$ref": "#/definitions/AnomalyDetectorFrequency", + "description": "Frequency of anomaly detection" + } + }, + "required": [ + "AnomalyDetectorFrequency" + ], + "type": "object" + }, + "AnomalyDetectorFrequency": { + "description": "Frequency of anomaly detection", + "enum": [ + "PT5M", + "PT10M", + "PT1H", + "P1D" + ], + "type": "string" + }, + "AppFlowConfig": { + "additionalProperties": false, + "properties": { + "FlowName": { + "maxLength": 256, + "pattern": "[a-zA-Z0-9][\\w!@#.-]+", + "type": "string" + }, + "RoleArn": { + "$ref": "#/definitions/Arn" + } + }, + "required": [ + "RoleArn", + "FlowName" + ], + "type": "object" + }, + "Arn": { + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+", + "type": "string" + }, + "Charset": { + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "CloudwatchConfig": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "$ref": "#/definitions/Arn" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "ColumnName": { + "description": "Name of a column in the data.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "CsvFormatDescriptor": { + "additionalProperties": false, + "properties": { + "Charset": { + "$ref": "#/definitions/Charset" + }, + "ContainsHeader": { + "type": "boolean" + }, + "Delimiter": { + "maxLength": 1, + "pattern": "[^\\r\\n]", + "type": "string" + }, + "FileCompression": { + "enum": [ + "NONE", + "GZIP" + ], + "type": "string" + }, + "HeaderList": { + "items": { + "$ref": "#/definitions/ColumnName" + }, + "type": "array" + }, + "QuoteSymbol": { + "maxLength": 1, + "pattern": "[^\\r\\n]|^$", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseHost": { + "maxLength": 253, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "DatabasePort": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "FileFormatDescriptor": { + "additionalProperties": false, + "properties": { + "CsvFormatDescriptor": { + "$ref": "#/definitions/CsvFormatDescriptor" + }, + "JsonFormatDescriptor": { + "$ref": "#/definitions/JsonFormatDescriptor" + } + }, + "type": "object" + }, + "JsonFormatDescriptor": { + "additionalProperties": false, + "properties": { + "Charset": { + "$ref": "#/definitions/Charset" + }, + "FileCompression": { + "enum": [ + "NONE", + "GZIP" + ], + "type": "string" + } + }, + "type": "object" + }, + "Metric": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "description": "Operator used to aggregate metric values", + "enum": [ + "AVG", + "SUM" + ], + "type": "string" + }, + "MetricName": { + "$ref": "#/definitions/ColumnName" + }, + "Namespace": { + "maxLength": 255, + "minLength": 1, + "pattern": "[^:].*", + "type": "string" + } + }, + "required": [ + "MetricName", + "AggregationFunction" + ], + "type": "object" + }, + "MetricSet": { + "additionalProperties": false, + "properties": { + "DimensionList": { + "description": "Dimensions for this MetricSet.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ColumnName" + }, + "minItems": 0, + "type": "array" + }, + "MetricList": { + "description": "Metrics captured by this MetricSet.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Metric" + }, + "minItems": 1, + "type": "array" + }, + "MetricSetDescription": { + "description": "A description for the MetricSet.", + "maxLength": 256, + "pattern": ".*\\S.*", + "type": "string" + }, + "MetricSetFrequency": { + "description": "A frequency period to aggregate the data", + "enum": [ + "PT5M", + "PT10M", + "PT1H", + "P1D" + ], + "type": "string" + }, + "MetricSetName": { + "description": "The name of the MetricSet.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "MetricSource": { + "$ref": "#/definitions/MetricSource" + }, + "Offset": { + "description": "Offset, in seconds, between the frequency interval and the time at which the metrics are available.", + "maximum": 432000, + "minimum": 0, + "type": "integer" + }, + "TimestampColumn": { + "$ref": "#/definitions/TimestampColumn" + }, + "Timezone": { + "maxLength": 60, + "pattern": ".*\\S.*", + "type": "string" + } + }, + "required": [ + "MetricSetName", + "MetricList", + "MetricSource" + ], + "type": "object" + }, + "MetricSource": { + "additionalProperties": false, + "properties": { + "AppFlowConfig": { + "$ref": "#/definitions/AppFlowConfig" + }, + "CloudwatchConfig": { + "$ref": "#/definitions/CloudwatchConfig" + }, + "RDSSourceConfig": { + "$ref": "#/definitions/RDSSourceConfig" + }, + "RedshiftSourceConfig": { + "$ref": "#/definitions/RedshiftSourceConfig" + }, + "S3SourceConfig": { + "$ref": "#/definitions/S3SourceConfig" + } + }, + "type": "object" + }, + "RDSSourceConfig": { + "additionalProperties": false, + "properties": { + "DBInstanceIdentifier": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\\-]*$", + "type": "string" + }, + "DatabaseHost": { + "$ref": "#/definitions/DatabaseHost" + }, + "DatabaseName": { + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "DatabasePort": { + "$ref": "#/definitions/DatabasePort" + }, + "RoleArn": { + "$ref": "#/definitions/Arn" + }, + "SecretManagerArn": { + "$ref": "#/definitions/SecretManagerArn" + }, + "TableName": { + "$ref": "#/definitions/TableName" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "required": [ + "DBInstanceIdentifier", + "DatabaseHost", + "DatabasePort", + "SecretManagerArn", + "DatabaseName", + "TableName", + "RoleArn", + "VpcConfiguration" + ], + "type": "object" + }, + "RedshiftSourceConfig": { + "additionalProperties": false, + "properties": { + "ClusterIdentifier": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z](?!.*--)(?!.*-$)[0-9a-z\\-]*$", + "type": "string" + }, + "DatabaseHost": { + "$ref": "#/definitions/DatabaseHost" + }, + "DatabaseName": { + "maxLength": 100, + "minLength": 1, + "pattern": "[a-z0-9]+", + "type": "string" + }, + "DatabasePort": { + "$ref": "#/definitions/DatabasePort" + }, + "RoleArn": { + "$ref": "#/definitions/Arn" + }, + "SecretManagerArn": { + "$ref": "#/definitions/SecretManagerArn" + }, + "TableName": { + "$ref": "#/definitions/TableName" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration" + } + }, + "required": [ + "ClusterIdentifier", + "DatabaseHost", + "DatabasePort", + "SecretManagerArn", + "DatabaseName", + "TableName", + "RoleArn", + "VpcConfiguration" + ], + "type": "object" + }, + "S3SourceConfig": { + "additionalProperties": false, + "properties": { + "FileFormatDescriptor": { + "$ref": "#/definitions/FileFormatDescriptor" + }, + "HistoricalDataPathList": { + "items": { + "maxLength": 1024, + "pattern": "^s3://[a-z0-9].+$", + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "RoleArn": { + "$ref": "#/definitions/Arn" + }, + "TemplatedPathList": { + "items": { + "maxLength": 1024, + "pattern": "^s3://[a-zA-Z0-9_\\-\\/ {}=]+$", + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "RoleArn", + "FileFormatDescriptor" + ], + "type": "object" + }, + "SecretManagerArn": { + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+", + "type": "string" + }, + "SecurityGroupIdList": { + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "type": "array" + }, + "SubnetIdList": { + "items": { + "maxLength": 255, + "pattern": "[\\-0-9a-zA-Z]+", + "type": "string" + }, + "type": "array" + }, + "TableName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$", + "type": "string" + }, + "TimestampColumn": { + "additionalProperties": false, + "properties": { + "ColumnFormat": { + "description": "A timestamp format for the timestamps in the dataset", + "maxLength": 63, + "pattern": ".*\\S.*", + "type": "string" + }, + "ColumnName": { + "$ref": "#/definitions/ColumnName" + } + }, + "type": "object" + }, + "VpcConfiguration": { + "additionalProperties": false, + "properties": { + "SecurityGroupIdList": { + "$ref": "#/definitions/SecurityGroupIdList" + }, + "SubnetIdList": { + "$ref": "#/definitions/SubnetIdList" + } + }, + "required": [ + "SubnetIdList", + "SecurityGroupIdList" + ], + "type": "object" + } + }, + "description": "An Amazon Lookout for Metrics Detector", + "handlers": { + "create": { + "permissions": [ + "lookoutmetrics:CreateAnomalyDetector", + "lookoutmetrics:DeleteAnomalyDetector", + "lookoutmetrics:CreateMetricSet", + "iam:PassRole" + ], + "timeoutInMinutes": 15 + }, + "delete": { + "permissions": [ + "lookoutmetrics:DescribeAnomalyDetector", + "lookoutmetrics:DeleteAnomalyDetector" + ], + "timeoutInMinutes": 15 + }, + "list": { + "permissions": [ + "lookoutmetrics:ListAnomalyDetectors" + ], + "timeoutInMinutes": 15 + }, + "read": { + "permissions": [ + "lookoutmetrics:DescribeAnomalyDetector", + "lookoutmetrics:DescribeMetricSet", + "lookoutmetrics:ListMetricSets" + ], + "timeoutInMinutes": 15 + }, + "update": { + "permissions": [ + "lookoutmetrics:UpdateAnomalyDetector", + "lookoutmetrics:UpdateMetricSet" + ], + "timeoutInMinutes": 15 + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AnomalyDetectorConfig": { + "$ref": "#/definitions/AnomalyDetectorConfig", + "description": "Configuration options for the AnomalyDetector" + }, + "AnomalyDetectorDescription": { + "description": "A description for the AnomalyDetector.", + "maxLength": 256, + "pattern": ".*\\S.*", + "type": "string" + }, + "AnomalyDetectorName": { + "description": "Name for the Amazon Lookout for Metrics Anomaly Detector", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "KmsKeyArn": { + "description": "KMS key used to encrypt the AnomalyDetector data", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/.*", + "type": "string" + }, + "MetricSetList": { + "description": "List of metric sets for anomaly detection", + "items": { + "$ref": "#/definitions/MetricSet" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AnomalyDetectorConfig", + "MetricSetList" + ], + "sourceUrl": "https://docs.aws.amazon.com/lookoutmetrics/latest/dev/lookoutmetrics-welcome.html", + "typeName": "AWS::LookoutMetrics::AnomalyDetector" +} diff --git a/schema/aws-lookoutvision-project.json b/schema/aws-lookoutvision-project.json index 570b9ad..26769f2 100644 --- a/schema/aws-lookoutvision-project.json +++ b/schema/aws-lookoutvision-project.json @@ -1,69 +1,69 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProjectName" - ], - "definitions": { - "Arn": { - "maxLength": 1000, - "type": "string" - }, - "ProjectName": { - "description": "The name of the Amazon Lookout for Vision project", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9][a-zA-Z0-9_\\-]*", - "type": "string" - } - }, - "description": "The AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.", - "handlers": { - "create": { - "permissions": [ - "lookoutvision:CreateProject" - ], - "timeoutInMinutes": 15 - }, - "delete": { - "permissions": [ - "lookoutvision:DeleteProject" - ], - "timeoutInMinutes": 15 - }, - "list": { - "permissions": [ - "lookoutvision:ListProjects" - ], - "timeoutInMinutes": 15 - }, - "read": { - "permissions": [ - "lookoutvision:DescribeProject" - ], - "timeoutInMinutes": 15 - }, - "update": { - "permissions": [], - "timeoutInMinutes": 15 - } - }, - "primaryIdentifier": [ - "/properties/ProjectName" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "ProjectName": { - "$ref": "#/definitions/ProjectName" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ProjectName" - ], - "sourceUrl": "https://docs.aws.amazon.com/lookout-for-vision/latest/developer-guide/model-create-project.html", - "typeName": "AWS::LookoutVision::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProjectName" + ], + "definitions": { + "Arn": { + "maxLength": 1000, + "type": "string" + }, + "ProjectName": { + "description": "The name of the Amazon Lookout for Vision project", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_\\-]*", + "type": "string" + } + }, + "description": "The AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.", + "handlers": { + "create": { + "permissions": [ + "lookoutvision:CreateProject" + ], + "timeoutInMinutes": 15 + }, + "delete": { + "permissions": [ + "lookoutvision:DeleteProject" + ], + "timeoutInMinutes": 15 + }, + "list": { + "permissions": [ + "lookoutvision:ListProjects" + ], + "timeoutInMinutes": 15 + }, + "read": { + "permissions": [ + "lookoutvision:DescribeProject" + ], + "timeoutInMinutes": 15 + }, + "update": { + "permissions": [], + "timeoutInMinutes": 15 + } + }, + "primaryIdentifier": [ + "/properties/ProjectName" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "ProjectName": { + "$ref": "#/definitions/ProjectName" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ProjectName" + ], + "sourceUrl": "https://docs.aws.amazon.com/lookout-for-vision/latest/developer-guide/model-create-project.html", + "typeName": "AWS::LookoutVision::Project" +} diff --git a/schema/aws-m2-application.json b/schema/aws-m2-application.json index e394537..6e9b30c 100644 --- a/schema/aws-m2-application.json +++ b/schema/aws-m2-application.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EngineType", - "/properties/Name", - "/properties/KmsKeyId", - "/properties/RoleArn" - ], - "definitions": { - "Definition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "S3Location": { - "pattern": "^\\S{1,2000}$", - "type": "string" - } - }, - "required": [ - "S3Location" - ], - "title": "S3Location", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Content": { - "maxLength": 65000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Content" - ], - "title": "Content", - "type": "object" - } - ] - }, - "EngineType": { - "enum": [ - "microfocus", - "bluage" - ], - "type": "string" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 200, - "minProperties": 0, - "patternProperties": { - "^(?!aws:).+$": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Represents an application that runs on an AWS Mainframe Modernization Environment", - "handlers": { - "create": { - "permissions": [ - "m2:CreateApplication", - "m2:GetApplication", - "m2:ListTagsForResource", - "m2:TagResource", - "s3:GetObject", - "s3:ListBucket", - "kms:DescribeKey", - "kms:CreateGrant", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DeleteListener", - "elasticloadbalancing:DeleteTargetGroup", - "logs:DeleteLogDelivery", - "m2:GetApplication", - "m2:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "m2:ListApplications" - ] - }, - "read": { - "permissions": [ - "m2:GetApplication", - "m2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "m2:UpdateApplication", - "m2:GetApplication", - "m2:ListTagsForResource", - "m2:TagResource", - "m2:UntagResource", - "s3:GetObject", - "s3:ListBucket" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn" - ], - "properties": { - "ApplicationArn": { - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "ApplicationId": { - "pattern": "^\\S{1,80}$", - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/Definition" - }, - "Description": { - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "EngineType": { - "$ref": "#/definitions/EngineType" - }, - "KmsKeyId": { - "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.", - "maxLength": 2048, - "type": "string" - }, - "Name": { - "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "RoleArn": { - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/ApplicationId" - ], - "required": [ - "Definition", - "EngineType", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::M2::Application", - "writeOnlyProperties": [ - "/properties/Definition" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EngineType", + "/properties/Name", + "/properties/KmsKeyId", + "/properties/RoleArn" + ], + "definitions": { + "Definition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3Location": { + "pattern": "^\\S{1,2000}$", + "type": "string" + } + }, + "required": [ + "S3Location" + ], + "title": "S3Location", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Content": { + "maxLength": 65000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Content" + ], + "title": "Content", + "type": "object" + } + ] + }, + "EngineType": { + "enum": [ + "microfocus", + "bluage" + ], + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 200, + "minProperties": 0, + "patternProperties": { + "^(?!aws:).+$": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Represents an application that runs on an AWS Mainframe Modernization Environment", + "handlers": { + "create": { + "permissions": [ + "m2:CreateApplication", + "m2:GetApplication", + "m2:ListTagsForResource", + "m2:TagResource", + "s3:GetObject", + "s3:ListBucket", + "kms:DescribeKey", + "kms:CreateGrant", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DeleteListener", + "elasticloadbalancing:DeleteTargetGroup", + "logs:DeleteLogDelivery", + "m2:GetApplication", + "m2:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "m2:ListApplications" + ] + }, + "read": { + "permissions": [ + "m2:GetApplication", + "m2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "m2:UpdateApplication", + "m2:GetApplication", + "m2:ListTagsForResource", + "m2:TagResource", + "m2:UntagResource", + "s3:GetObject", + "s3:ListBucket" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "ApplicationId": { + "pattern": "^\\S{1,80}$", + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/Definition" + }, + "Description": { + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "EngineType": { + "$ref": "#/definitions/EngineType" + }, + "KmsKeyId": { + "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.", + "maxLength": 2048, + "type": "string" + }, + "Name": { + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "RoleArn": { + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/ApplicationId" + ], + "required": [ + "Definition", + "EngineType", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::M2::Application", + "writeOnlyProperties": [ + "/properties/Definition" + ] +} diff --git a/schema/aws-m2-environment.json b/schema/aws-m2-environment.json index a017ead..a7e5f10 100644 --- a/schema/aws-m2-environment.json +++ b/schema/aws-m2-environment.json @@ -1,279 +1,279 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/EngineType", - "/properties/KmsKeyId", - "/properties/Name", - "/properties/PubliclyAccessible", - "/properties/SecurityGroupIds", - "/properties/StorageConfigurations", - "/properties/SubnetIds" - ], - "definitions": { - "EfsStorageConfiguration": { - "additionalProperties": false, - "description": "Defines the storage configuration for an Amazon EFS file system.", - "properties": { - "FileSystemId": { - "description": "The file system identifier.", - "pattern": "^\\S{1,200}$", - "type": "string" - }, - "MountPoint": { - "description": "The mount point for the file system.", - "pattern": "^\\S{1,200}$", - "type": "string" - } - }, - "required": [ - "FileSystemId", - "MountPoint" - ], - "type": "object" - }, - "EngineType": { - "description": "The target platform for the environment.", - "enum": [ - "microfocus", - "bluage" - ], - "type": "string" - }, - "FsxStorageConfiguration": { - "additionalProperties": false, - "description": "Defines the storage configuration for an Amazon FSx file system.", - "properties": { - "FileSystemId": { - "description": "The file system identifier.", - "pattern": "^\\S{1,200}$", - "type": "string" - }, - "MountPoint": { - "description": "The mount point for the file system.", - "pattern": "^\\S{1,200}$", - "type": "string" - } - }, - "required": [ - "FileSystemId", - "MountPoint" - ], - "type": "object" - }, - "HighAvailabilityConfig": { - "additionalProperties": false, - "description": "Defines the details of a high availability configuration.", - "properties": { - "DesiredCapacity": { - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "DesiredCapacity" - ], - "type": "object" - }, - "StorageConfiguration": { - "description": "Defines the storage configuration for an environment.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Efs": { - "$ref": "#/definitions/EfsStorageConfiguration" - } - }, - "required": [ - "Efs" - ] - }, - { - "additionalProperties": false, - "properties": { - "Fsx": { - "$ref": "#/definitions/FsxStorageConfiguration" - } - }, - "required": [ - "Fsx" - ] - } - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "description": "Defines tags associated to an environment.", - "maxProperties": 200, - "minProperties": 0, - "patternProperties": { - "^(?!aws:).+$": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Represents a runtime environment that can run migrated mainframe applications.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkInterface", - "ec2:CreateNetworkInterfacePermission", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "ec2:ModifyNetworkInterfaceAttribute", - "elasticfilesystem:DescribeMountTargets", - "elasticloadbalancing:CreateLoadBalancer", - "elasticloadbalancing:DeleteLoadBalancer", - "elasticloadbalancing:AddTags", - "fsx:DescribeFileSystems", - "iam:CreateServiceLinkedRole", - "kms:DescribeKey", - "kms:CreateGrant", - "m2:CreateEnvironment", - "m2:GetEnvironment", - "m2:ListTagsForResource", - "m2:TagResource" - ] - }, - "delete": { - "permissions": [ - "elasticloadbalancing:DeleteLoadBalancer", - "m2:DeleteEnvironment", - "m2:GetEnvironment" - ] - }, - "list": { - "permissions": [ - "m2:ListEnvironments" - ] - }, - "read": { - "permissions": [ - "m2:ListTagsForResource", - "m2:GetEnvironment" - ] - }, - "update": { - "permissions": [ - "m2:TagResource", - "m2:UntagResource", - "m2:ListTagsForResource", - "m2:GetEnvironment", - "m2:UpdateEnvironment", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentArn" - ], - "properties": { - "Description": { - "description": "The description of the environment.", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "EngineType": { - "$ref": "#/definitions/EngineType" - }, - "EngineVersion": { - "description": "The version of the runtime engine for the environment.", - "pattern": "^\\S{1,10}$", - "type": "string" - }, - "EnvironmentArn": { - "description": "The Amazon Resource Name (ARN) of the runtime environment.", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "EnvironmentId": { - "description": "The unique identifier of the environment.", - "pattern": "^\\S{1,80}$", - "type": "string" - }, - "HighAvailabilityConfig": { - "$ref": "#/definitions/HighAvailabilityConfig" - }, - "InstanceType": { - "description": "The type of instance underlying the environment.", - "pattern": "^\\S{1,20}$", - "type": "string" - }, - "KmsKeyId": { - "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.", - "maxLength": 2048, - "type": "string" - }, - "Name": { - "description": "The name of the environment.", - "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "description": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.", - "pattern": "^\\S{1,50}$", - "type": "string" - }, - "PubliclyAccessible": { - "description": "Specifies whether the environment is publicly accessible.", - "type": "boolean" - }, - "SecurityGroupIds": { - "description": "The list of security groups for the VPC associated with this environment.", - "insertionOrder": false, - "items": { - "pattern": "^\\S{1,50}$", - "type": "string" - }, - "type": "array" - }, - "StorageConfigurations": { - "description": "The storage configurations defined for the runtime environment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StorageConfiguration" - }, - "type": "array" - }, - "SubnetIds": { - "description": "The unique identifiers of the subnets assigned to this runtime environment.", - "insertionOrder": false, - "items": { - "pattern": "^\\S{1,50}$", - "type": "string" - }, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/TagMap", - "description": "Tags associated to this environment." - } - }, - "readOnlyProperties": [ - "/properties/EnvironmentArn", - "/properties/EnvironmentId" - ], - "required": [ - "EngineType", - "InstanceType", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::M2::Environment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/EngineType", + "/properties/KmsKeyId", + "/properties/Name", + "/properties/PubliclyAccessible", + "/properties/SecurityGroupIds", + "/properties/StorageConfigurations", + "/properties/SubnetIds" + ], + "definitions": { + "EfsStorageConfiguration": { + "additionalProperties": false, + "description": "Defines the storage configuration for an Amazon EFS file system.", + "properties": { + "FileSystemId": { + "description": "The file system identifier.", + "pattern": "^\\S{1,200}$", + "type": "string" + }, + "MountPoint": { + "description": "The mount point for the file system.", + "pattern": "^\\S{1,200}$", + "type": "string" + } + }, + "required": [ + "FileSystemId", + "MountPoint" + ], + "type": "object" + }, + "EngineType": { + "description": "The target platform for the environment.", + "enum": [ + "microfocus", + "bluage" + ], + "type": "string" + }, + "FsxStorageConfiguration": { + "additionalProperties": false, + "description": "Defines the storage configuration for an Amazon FSx file system.", + "properties": { + "FileSystemId": { + "description": "The file system identifier.", + "pattern": "^\\S{1,200}$", + "type": "string" + }, + "MountPoint": { + "description": "The mount point for the file system.", + "pattern": "^\\S{1,200}$", + "type": "string" + } + }, + "required": [ + "FileSystemId", + "MountPoint" + ], + "type": "object" + }, + "HighAvailabilityConfig": { + "additionalProperties": false, + "description": "Defines the details of a high availability configuration.", + "properties": { + "DesiredCapacity": { + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "DesiredCapacity" + ], + "type": "object" + }, + "StorageConfiguration": { + "description": "Defines the storage configuration for an environment.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Efs": { + "$ref": "#/definitions/EfsStorageConfiguration" + } + }, + "required": [ + "Efs" + ] + }, + { + "additionalProperties": false, + "properties": { + "Fsx": { + "$ref": "#/definitions/FsxStorageConfiguration" + } + }, + "required": [ + "Fsx" + ] + } + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "description": "Defines tags associated to an environment.", + "maxProperties": 200, + "minProperties": 0, + "patternProperties": { + "^(?!aws:).+$": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Represents a runtime environment that can run migrated mainframe applications.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkInterface", + "ec2:CreateNetworkInterfacePermission", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "ec2:ModifyNetworkInterfaceAttribute", + "elasticfilesystem:DescribeMountTargets", + "elasticloadbalancing:CreateLoadBalancer", + "elasticloadbalancing:DeleteLoadBalancer", + "elasticloadbalancing:AddTags", + "fsx:DescribeFileSystems", + "iam:CreateServiceLinkedRole", + "kms:DescribeKey", + "kms:CreateGrant", + "m2:CreateEnvironment", + "m2:GetEnvironment", + "m2:ListTagsForResource", + "m2:TagResource" + ] + }, + "delete": { + "permissions": [ + "elasticloadbalancing:DeleteLoadBalancer", + "m2:DeleteEnvironment", + "m2:GetEnvironment" + ] + }, + "list": { + "permissions": [ + "m2:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "m2:ListTagsForResource", + "m2:GetEnvironment" + ] + }, + "update": { + "permissions": [ + "m2:TagResource", + "m2:UntagResource", + "m2:ListTagsForResource", + "m2:GetEnvironment", + "m2:UpdateEnvironment", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentArn" + ], + "properties": { + "Description": { + "description": "The description of the environment.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "EngineType": { + "$ref": "#/definitions/EngineType" + }, + "EngineVersion": { + "description": "The version of the runtime engine for the environment.", + "pattern": "^\\S{1,10}$", + "type": "string" + }, + "EnvironmentArn": { + "description": "The Amazon Resource Name (ARN) of the runtime environment.", + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "EnvironmentId": { + "description": "The unique identifier of the environment.", + "pattern": "^\\S{1,80}$", + "type": "string" + }, + "HighAvailabilityConfig": { + "$ref": "#/definitions/HighAvailabilityConfig" + }, + "InstanceType": { + "description": "The type of instance underlying the environment.", + "pattern": "^\\S{1,20}$", + "type": "string" + }, + "KmsKeyId": { + "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.", + "maxLength": 2048, + "type": "string" + }, + "Name": { + "description": "The name of the environment.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "description": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.", + "pattern": "^\\S{1,50}$", + "type": "string" + }, + "PubliclyAccessible": { + "description": "Specifies whether the environment is publicly accessible.", + "type": "boolean" + }, + "SecurityGroupIds": { + "description": "The list of security groups for the VPC associated with this environment.", + "insertionOrder": false, + "items": { + "pattern": "^\\S{1,50}$", + "type": "string" + }, + "type": "array" + }, + "StorageConfigurations": { + "description": "The storage configurations defined for the runtime environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StorageConfiguration" + }, + "type": "array" + }, + "SubnetIds": { + "description": "The unique identifiers of the subnets assigned to this runtime environment.", + "insertionOrder": false, + "items": { + "pattern": "^\\S{1,50}$", + "type": "string" + }, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagMap", + "description": "Tags associated to this environment." + } + }, + "readOnlyProperties": [ + "/properties/EnvironmentArn", + "/properties/EnvironmentId" + ], + "required": [ + "EngineType", + "InstanceType", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::M2::Environment" +} diff --git a/schema/aws-macie-allowlist.json b/schema/aws-macie-allowlist.json index 8428cf9..217ddde 100644 --- a/schema/aws-macie-allowlist.json +++ b/schema/aws-macie-allowlist.json @@ -1,180 +1,180 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "definitions": { - "Criteria": { - "description": "The regex or s3 object to use for the AllowList.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Regex": { - "description": "The S3 object key for the AllowList.", - "type": "string" - } - }, - "required": [ - "Regex" - ] - }, - { - "additionalProperties": false, - "properties": { - "S3WordsList": { - "$ref": "#/definitions/S3WordsList", - "description": "The S3 location for the AllowList." - } - }, - "required": [ - "S3WordsList" - ] - } - ], - "type": "object" - }, - "Regex": { - "type": "string" - }, - "S3WordsList": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "ObjectKey": { - "type": "string" - } - }, - "required": [ - "BucketName", - "ObjectKey" - ], - "type": "object" - }, - "Status": { - "description": "The status for the AllowList", - "enum": [ - "OK", - "S3_OBJECT_NOT_FOUND", - "S3_USER_ACCESS_DENIED", - "S3_OBJECT_ACCESS_DENIED", - "S3_THROTTLED", - "S3_OBJECT_OVERSIZE", - "S3_OBJECT_EMPTY", - "UNKNOWN_ERROR" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Macie AllowList resource schema", - "handlers": { - "create": { - "permissions": [ - "macie2:CreateAllowList", - "macie2:GetAllowList", - "macie2:TagResource" - ] - }, - "delete": { - "permissions": [ - "macie2:DeleteAllowList" - ] - }, - "list": { - "permissions": [ - "macie2:ListAllowLists" - ] - }, - "read": { - "permissions": [ - "macie2:GetAllowList" - ] - }, - "update": { - "permissions": [ - "macie2:UpdateAllowList", - "macie2:GetAllowList", - "macie2:TagResource", - "macie2:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "AllowList ARN.", - "type": "string" - }, - "Criteria": { - "$ref": "#/definitions/Criteria", - "description": "AllowList criteria." - }, - "Description": { - "description": "Description of AllowList.", - "type": "string" - }, - "Id": { - "description": "AllowList ID.", - "type": "string" - }, - "Name": { - "description": "Name of AllowList.", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "AllowList status." - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/Status" - ], - "required": [ - "Name", - "Criteria" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Macie::AllowList" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "definitions": { + "Criteria": { + "description": "The regex or s3 object to use for the AllowList.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Regex": { + "description": "The S3 object key for the AllowList.", + "type": "string" + } + }, + "required": [ + "Regex" + ] + }, + { + "additionalProperties": false, + "properties": { + "S3WordsList": { + "$ref": "#/definitions/S3WordsList", + "description": "The S3 location for the AllowList." + } + }, + "required": [ + "S3WordsList" + ] + } + ], + "type": "object" + }, + "Regex": { + "type": "string" + }, + "S3WordsList": { + "additionalProperties": false, + "properties": { + "BucketName": { + "type": "string" + }, + "ObjectKey": { + "type": "string" + } + }, + "required": [ + "BucketName", + "ObjectKey" + ], + "type": "object" + }, + "Status": { + "description": "The status for the AllowList", + "enum": [ + "OK", + "S3_OBJECT_NOT_FOUND", + "S3_USER_ACCESS_DENIED", + "S3_OBJECT_ACCESS_DENIED", + "S3_THROTTLED", + "S3_OBJECT_OVERSIZE", + "S3_OBJECT_EMPTY", + "UNKNOWN_ERROR" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Macie AllowList resource schema", + "handlers": { + "create": { + "permissions": [ + "macie2:CreateAllowList", + "macie2:GetAllowList", + "macie2:TagResource" + ] + }, + "delete": { + "permissions": [ + "macie2:DeleteAllowList" + ] + }, + "list": { + "permissions": [ + "macie2:ListAllowLists" + ] + }, + "read": { + "permissions": [ + "macie2:GetAllowList" + ] + }, + "update": { + "permissions": [ + "macie2:UpdateAllowList", + "macie2:GetAllowList", + "macie2:TagResource", + "macie2:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "AllowList ARN.", + "type": "string" + }, + "Criteria": { + "$ref": "#/definitions/Criteria", + "description": "AllowList criteria." + }, + "Description": { + "description": "Description of AllowList.", + "type": "string" + }, + "Id": { + "description": "AllowList ID.", + "type": "string" + }, + "Name": { + "description": "Name of AllowList.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "AllowList status." + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/Status" + ], + "required": [ + "Name", + "Criteria" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Macie::AllowList" +} diff --git a/schema/aws-macie-customdataidentifier.json b/schema/aws-macie-customdataidentifier.json index 6ab5a42..c5cd4b1 100644 --- a/schema/aws-macie-customdataidentifier.json +++ b/schema/aws-macie-customdataidentifier.json @@ -1,136 +1,136 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Description", - "/properties/Regex", - "/properties/MaximumMatchDistance", - "/properties/Keywords", - "/properties/IgnoreWords" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Macie CustomDataIdentifier resource schema", - "handlers": { - "create": { - "permissions": [ - "macie2:CreateCustomDataIdentifier", - "macie2:GetCustomDataIdentifier", - "macie2:TagResource" - ] - }, - "delete": { - "permissions": [ - "macie2:DeleteCustomDataIdentifier" - ] - }, - "list": { - "permissions": [ - "macie2:ListCustomDataIdentifiers" - ] - }, - "read": { - "permissions": [ - "macie2:GetCustomDataIdentifier" - ] - }, - "update": { - "permissions": [ - "macie2:TagResource", - "macie2:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Custom data identifier ARN.", - "type": "string" - }, - "Description": { - "description": "Description of custom data identifier.", - "type": "string" - }, - "Id": { - "description": "Custom data identifier ID.", - "type": "string" - }, - "IgnoreWords": { - "description": "Words to be ignored.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Keywords": { - "description": "Keywords to be matched against.", - "items": { - "type": "string" - }, - "type": "array" - }, - "MaximumMatchDistance": { - "description": "Maximum match distance.", - "type": "integer" - }, - "Name": { - "description": "Name of custom data identifier.", - "type": "string" - }, - "Regex": { - "description": "Regular expression for custom data identifier.", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "Regex" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Macie::CustomDataIdentifier" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/Regex", + "/properties/MaximumMatchDistance", + "/properties/Keywords", + "/properties/IgnoreWords" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Macie CustomDataIdentifier resource schema", + "handlers": { + "create": { + "permissions": [ + "macie2:CreateCustomDataIdentifier", + "macie2:GetCustomDataIdentifier", + "macie2:TagResource" + ] + }, + "delete": { + "permissions": [ + "macie2:DeleteCustomDataIdentifier" + ] + }, + "list": { + "permissions": [ + "macie2:ListCustomDataIdentifiers" + ] + }, + "read": { + "permissions": [ + "macie2:GetCustomDataIdentifier" + ] + }, + "update": { + "permissions": [ + "macie2:TagResource", + "macie2:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Custom data identifier ARN.", + "type": "string" + }, + "Description": { + "description": "Description of custom data identifier.", + "type": "string" + }, + "Id": { + "description": "Custom data identifier ID.", + "type": "string" + }, + "IgnoreWords": { + "description": "Words to be ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Keywords": { + "description": "Keywords to be matched against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "MaximumMatchDistance": { + "description": "Maximum match distance.", + "type": "integer" + }, + "Name": { + "description": "Name of custom data identifier.", + "type": "string" + }, + "Regex": { + "description": "Regular expression for custom data identifier.", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "Regex" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Macie::CustomDataIdentifier" +} diff --git a/schema/aws-macie-findingsfilter.json b/schema/aws-macie-findingsfilter.json index e0647af..b4a8582 100644 --- a/schema/aws-macie-findingsfilter.json +++ b/schema/aws-macie-findingsfilter.json @@ -1,195 +1,195 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ], - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "definitions": { - "Criterion": { - "additionalProperties": false, - "description": "Map of filter criteria.", - "patternProperties": { - "\\w": { - "$ref": "#/definitions/CriterionAdditionalProperties" - } - }, - "type": "object" - }, - "CriterionAdditionalProperties": { - "additionalProperties": false, - "properties": { - "eq": { - "items": { - "type": "string" - }, - "type": "array" - }, - "gt": { - "format": "int64", - "type": "integer" - }, - "gte": { - "format": "int64", - "type": "integer" - }, - "lt": { - "format": "int64", - "type": "integer" - }, - "lte": { - "format": "int64", - "type": "integer" - }, - "neq": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "FindingCriteria": { - "additionalProperties": false, - "properties": { - "Criterion": { - "$ref": "#/definitions/Criterion" - } - }, - "type": "object" - }, - "FindingFilterAction": { - "enum": [ - "ARCHIVE", - "NOOP" - ], - "type": "string" - }, - "FindingsFilterListItem": { - "description": "Returned by ListHandler representing filter name and ID.", - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag's key.", - "type": "string" - }, - "Value": { - "description": "The tag's value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Macie FindingsFilter resource schema.", - "handlers": { - "create": { - "permissions": [ - "macie2:GetFindingsFilter", - "macie2:CreateFindingsFilter", - "macie2:TagResource" - ] - }, - "delete": { - "permissions": [ - "macie2:DeleteFindingsFilter" - ] - }, - "list": { - "permissions": [ - "macie2:ListFindingsFilters" - ] - }, - "read": { - "permissions": [ - "macie2:GetFindingsFilter" - ] - }, - "update": { - "permissions": [ - "macie2:GetFindingsFilter", - "macie2:UpdateFindingsFilter", - "macie2:TagResource", - "macie2:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Action": { - "$ref": "#/definitions/FindingFilterAction", - "description": "Findings filter action." - }, - "Arn": { - "description": "Findings filter ARN.", - "type": "string" - }, - "Description": { - "description": "Findings filter description", - "type": "string" - }, - "FindingCriteria": { - "$ref": "#/definitions/FindingCriteria", - "description": "Findings filter criteria." - }, - "Id": { - "description": "Findings filter ID.", - "type": "string" - }, - "Name": { - "description": "Findings filter name", - "type": "string" - }, - "Position": { - "description": "Findings filter position.", - "type": "integer" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "FindingCriteria" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Macie::FindingsFilter" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ], + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "definitions": { + "Criterion": { + "additionalProperties": false, + "description": "Map of filter criteria.", + "patternProperties": { + "\\w": { + "$ref": "#/definitions/CriterionAdditionalProperties" + } + }, + "type": "object" + }, + "CriterionAdditionalProperties": { + "additionalProperties": false, + "properties": { + "eq": { + "items": { + "type": "string" + }, + "type": "array" + }, + "gt": { + "format": "int64", + "type": "integer" + }, + "gte": { + "format": "int64", + "type": "integer" + }, + "lt": { + "format": "int64", + "type": "integer" + }, + "lte": { + "format": "int64", + "type": "integer" + }, + "neq": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FindingCriteria": { + "additionalProperties": false, + "properties": { + "Criterion": { + "$ref": "#/definitions/Criterion" + } + }, + "type": "object" + }, + "FindingFilterAction": { + "enum": [ + "ARCHIVE", + "NOOP" + ], + "type": "string" + }, + "FindingsFilterListItem": { + "description": "Returned by ListHandler representing filter name and ID.", + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag's key.", + "type": "string" + }, + "Value": { + "description": "The tag's value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Macie FindingsFilter resource schema.", + "handlers": { + "create": { + "permissions": [ + "macie2:GetFindingsFilter", + "macie2:CreateFindingsFilter", + "macie2:TagResource" + ] + }, + "delete": { + "permissions": [ + "macie2:DeleteFindingsFilter" + ] + }, + "list": { + "permissions": [ + "macie2:ListFindingsFilters" + ] + }, + "read": { + "permissions": [ + "macie2:GetFindingsFilter" + ] + }, + "update": { + "permissions": [ + "macie2:GetFindingsFilter", + "macie2:UpdateFindingsFilter", + "macie2:TagResource", + "macie2:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Action": { + "$ref": "#/definitions/FindingFilterAction", + "description": "Findings filter action." + }, + "Arn": { + "description": "Findings filter ARN.", + "type": "string" + }, + "Description": { + "description": "Findings filter description", + "type": "string" + }, + "FindingCriteria": { + "$ref": "#/definitions/FindingCriteria", + "description": "Findings filter criteria." + }, + "Id": { + "description": "Findings filter ID.", + "type": "string" + }, + "Name": { + "description": "Findings filter name", + "type": "string" + }, + "Position": { + "description": "Findings filter position.", + "type": "integer" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "FindingCriteria" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Macie::FindingsFilter" +} diff --git a/schema/aws-macie-session.json b/schema/aws-macie-session.json index 1865aff..1a0d72f 100644 --- a/schema/aws-macie-session.json +++ b/schema/aws-macie-session.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "description": "The AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.", - "handlers": { - "create": { - "permissions": [ - "macie2:GetMacieSession", - "macie2:EnableMacie" - ] - }, - "delete": { - "permissions": [ - "macie2:DisableMacie" - ] - }, - "list": { - "permissions": [ - "macie2:GetMacieSession" - ] - }, - "read": { - "permissions": [ - "macie2:GetMacieSession" - ] - }, - "update": { - "permissions": [ - "macie2:GetMacieSession", - "macie2:UpdateMacieSession" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId" - ], - "properties": { - "AwsAccountId": { - "description": "AWS account ID of customer", - "type": "string" - }, - "FindingPublishingFrequency": { - "default": "SIX_HOURS", - "description": "A enumeration value that specifies how frequently finding updates are published.", - "enum": [ - "FIFTEEN_MINUTES", - "ONE_HOUR", - "SIX_HOURS" - ], - "type": "string" - }, - "ServiceRole": { - "description": "Service role used by Macie", - "type": "string" - }, - "Status": { - "default": "ENABLED", - "description": "A enumeration value that specifies the status of the Macie Session.", - "enum": [ - "ENABLED", - "PAUSED" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/ServiceRole" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Macie::Session" -} +{ + "additionalProperties": false, + "description": "The AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.", + "handlers": { + "create": { + "permissions": [ + "macie2:GetMacieSession", + "macie2:EnableMacie" + ] + }, + "delete": { + "permissions": [ + "macie2:DisableMacie" + ] + }, + "list": { + "permissions": [ + "macie2:GetMacieSession" + ] + }, + "read": { + "permissions": [ + "macie2:GetMacieSession" + ] + }, + "update": { + "permissions": [ + "macie2:GetMacieSession", + "macie2:UpdateMacieSession" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId" + ], + "properties": { + "AwsAccountId": { + "description": "AWS account ID of customer", + "type": "string" + }, + "FindingPublishingFrequency": { + "default": "SIX_HOURS", + "description": "A enumeration value that specifies how frequently finding updates are published.", + "enum": [ + "FIFTEEN_MINUTES", + "ONE_HOUR", + "SIX_HOURS" + ], + "type": "string" + }, + "ServiceRole": { + "description": "Service role used by Macie", + "type": "string" + }, + "Status": { + "default": "ENABLED", + "description": "A enumeration value that specifies the status of the Macie Session.", + "enum": [ + "ENABLED", + "PAUSED" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/ServiceRole" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-macie.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Macie::Session" +} diff --git a/schema/aws-managedblockchain-accessor.json b/schema/aws-managedblockchain-accessor.json index 87a8c31..5bdbb14 100644 --- a/schema/aws-managedblockchain-accessor.json +++ b/schema/aws-managedblockchain-accessor.json @@ -1,157 +1,157 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AccessorType", - "/properties/NetworkType" - ], - "definitions": { - "AccessorStatus": { - "enum": [ - "AVAILABLE", - "PENDING_DELETION", - "DELETED" - ], - "type": "string" - }, - "AccessorType": { - "enum": [ - "BILLING_TOKEN" - ], - "type": "string" - }, - "NetworkAccessorType": { - "enum": [ - "ETHEREUM_GOERLI", - "ETHEREUM_MAINNET", - "ETHEREUM_MAINNET_AND_GOERLI", - "POLYGON_MAINNET", - "POLYGON_MUMBAI" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type", - "handlers": { - "create": { - "permissions": [ - "managedblockchain:CreateAccessor", - "managedblockchain:TagResource", - "managedblockchain:GetAccessor" - ] - }, - "delete": { - "permissions": [ - "managedblockchain:DeleteAccessor" - ] - }, - "list": { - "permissions": [ - "managedblockchain:ListAccessors" - ] - }, - "read": { - "permissions": [ - "managedblockchain:GetAccessor" - ] - }, - "update": { - "permissions": [ - "managedblockchain:GetAccessor", - "managedblockchain:CreateAccessor", - "managedblockchain:TagResource", - "managedblockchain:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessorType": { - "$ref": "#/definitions/AccessorType" - }, - "Arn": { - "maxLength": 1011, - "minLength": 1, - "pattern": "^arn:.+:.+:.+:.+:.+$", - "type": "string" - }, - "BillingToken": { - "maxLength": 42, - "minLength": 42, - "type": "string" - }, - "CreationDate": { - "type": "string" - }, - "Id": { - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "NetworkType": { - "$ref": "#/definitions/NetworkAccessorType" - }, - "Status": { - "$ref": "#/definitions/AccessorStatus" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/BillingToken", - "/properties/CreationDate", - "/properties/Status" - ], - "required": [ - "AccessorType" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ManagedBlockchain::Accessor", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AccessorType", + "/properties/NetworkType" + ], + "definitions": { + "AccessorStatus": { + "enum": [ + "AVAILABLE", + "PENDING_DELETION", + "DELETED" + ], + "type": "string" + }, + "AccessorType": { + "enum": [ + "BILLING_TOKEN" + ], + "type": "string" + }, + "NetworkAccessorType": { + "enum": [ + "ETHEREUM_GOERLI", + "ETHEREUM_MAINNET", + "ETHEREUM_MAINNET_AND_GOERLI", + "POLYGON_MAINNET", + "POLYGON_MUMBAI" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type", + "handlers": { + "create": { + "permissions": [ + "managedblockchain:CreateAccessor", + "managedblockchain:TagResource", + "managedblockchain:GetAccessor" + ] + }, + "delete": { + "permissions": [ + "managedblockchain:DeleteAccessor" + ] + }, + "list": { + "permissions": [ + "managedblockchain:ListAccessors" + ] + }, + "read": { + "permissions": [ + "managedblockchain:GetAccessor" + ] + }, + "update": { + "permissions": [ + "managedblockchain:GetAccessor", + "managedblockchain:CreateAccessor", + "managedblockchain:TagResource", + "managedblockchain:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessorType": { + "$ref": "#/definitions/AccessorType" + }, + "Arn": { + "maxLength": 1011, + "minLength": 1, + "pattern": "^arn:.+:.+:.+:.+:.+$", + "type": "string" + }, + "BillingToken": { + "maxLength": 42, + "minLength": 42, + "type": "string" + }, + "CreationDate": { + "type": "string" + }, + "Id": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "NetworkType": { + "$ref": "#/definitions/NetworkAccessorType" + }, + "Status": { + "$ref": "#/definitions/AccessorStatus" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/BillingToken", + "/properties/CreationDate", + "/properties/Status" + ], + "required": [ + "AccessorType" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ManagedBlockchain::Accessor", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-managedblockchain-member.json b/schema/aws-managedblockchain-member.json index ca2d439..5cb399c 100644 --- a/schema/aws-managedblockchain-member.json +++ b/schema/aws-managedblockchain-member.json @@ -1,151 +1,151 @@ -{ - "additionalProperties": false, - "definitions": { - "ApprovalThresholdPolicy": { - "additionalProperties": false, - "properties": { - "ProposalDurationInHours": { - "type": "integer" - }, - "ThresholdComparator": { - "type": "string" - }, - "ThresholdPercentage": { - "type": "integer" - } - }, - "type": "object" - }, - "MemberConfiguration": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "MemberFrameworkConfiguration": { - "$ref": "#/definitions/MemberFrameworkConfiguration" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "MemberFabricConfiguration": { - "additionalProperties": false, - "properties": { - "AdminPassword": { - "type": "string" - }, - "AdminUsername": { - "type": "string" - } - }, - "required": [ - "AdminUsername", - "AdminPassword" - ], - "type": "object" - }, - "MemberFrameworkConfiguration": { - "additionalProperties": false, - "properties": { - "MemberFabricConfiguration": { - "$ref": "#/definitions/MemberFabricConfiguration" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Framework": { - "type": "string" - }, - "FrameworkVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NetworkFrameworkConfiguration": { - "$ref": "#/definitions/NetworkFrameworkConfiguration" - }, - "VotingPolicy": { - "$ref": "#/definitions/VotingPolicy" - } - }, - "required": [ - "VotingPolicy", - "Framework", - "FrameworkVersion", - "Name" - ], - "type": "object" - }, - "NetworkFabricConfiguration": { - "additionalProperties": false, - "properties": { - "Edition": { - "type": "string" - } - }, - "required": [ - "Edition" - ], - "type": "object" - }, - "NetworkFrameworkConfiguration": { - "additionalProperties": false, - "properties": { - "NetworkFabricConfiguration": { - "$ref": "#/definitions/NetworkFabricConfiguration" - } - }, - "type": "object" - }, - "VotingPolicy": { - "additionalProperties": false, - "properties": { - "ApprovalThresholdPolicy": { - "$ref": "#/definitions/ApprovalThresholdPolicy" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ManagedBlockchain::Member", - "primaryIdentifier": [ - "/properties/MemberId" - ], - "properties": { - "InvitationId": { - "type": "string" - }, - "MemberConfiguration": { - "$ref": "#/definitions/MemberConfiguration" - }, - "MemberId": { - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "NetworkId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/MemberId" - ], - "required": [ - "MemberConfiguration" - ], - "typeName": "AWS::ManagedBlockchain::Member" -} +{ + "additionalProperties": false, + "definitions": { + "ApprovalThresholdPolicy": { + "additionalProperties": false, + "properties": { + "ProposalDurationInHours": { + "type": "integer" + }, + "ThresholdComparator": { + "type": "string" + }, + "ThresholdPercentage": { + "type": "integer" + } + }, + "type": "object" + }, + "MemberConfiguration": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "MemberFrameworkConfiguration": { + "$ref": "#/definitions/MemberFrameworkConfiguration" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "MemberFabricConfiguration": { + "additionalProperties": false, + "properties": { + "AdminPassword": { + "type": "string" + }, + "AdminUsername": { + "type": "string" + } + }, + "required": [ + "AdminUsername", + "AdminPassword" + ], + "type": "object" + }, + "MemberFrameworkConfiguration": { + "additionalProperties": false, + "properties": { + "MemberFabricConfiguration": { + "$ref": "#/definitions/MemberFabricConfiguration" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Framework": { + "type": "string" + }, + "FrameworkVersion": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "NetworkFrameworkConfiguration": { + "$ref": "#/definitions/NetworkFrameworkConfiguration" + }, + "VotingPolicy": { + "$ref": "#/definitions/VotingPolicy" + } + }, + "required": [ + "VotingPolicy", + "Framework", + "FrameworkVersion", + "Name" + ], + "type": "object" + }, + "NetworkFabricConfiguration": { + "additionalProperties": false, + "properties": { + "Edition": { + "type": "string" + } + }, + "required": [ + "Edition" + ], + "type": "object" + }, + "NetworkFrameworkConfiguration": { + "additionalProperties": false, + "properties": { + "NetworkFabricConfiguration": { + "$ref": "#/definitions/NetworkFabricConfiguration" + } + }, + "type": "object" + }, + "VotingPolicy": { + "additionalProperties": false, + "properties": { + "ApprovalThresholdPolicy": { + "$ref": "#/definitions/ApprovalThresholdPolicy" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ManagedBlockchain::Member", + "primaryIdentifier": [ + "/properties/MemberId" + ], + "properties": { + "InvitationId": { + "type": "string" + }, + "MemberConfiguration": { + "$ref": "#/definitions/MemberConfiguration" + }, + "MemberId": { + "type": "string" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "NetworkId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/MemberId" + ], + "required": [ + "MemberConfiguration" + ], + "typeName": "AWS::ManagedBlockchain::Member" +} diff --git a/schema/aws-managedblockchain-node.json b/schema/aws-managedblockchain-node.json index a263d06..8857c6c 100644 --- a/schema/aws-managedblockchain-node.json +++ b/schema/aws-managedblockchain-node.json @@ -1,51 +1,51 @@ -{ - "additionalProperties": false, - "definitions": { - "NodeConfiguration": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceType": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone", - "InstanceType" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ManagedBlockchain::Node", - "primaryIdentifier": [ - "/properties/NodeId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "MemberId": { - "type": "string" - }, - "NetworkId": { - "type": "string" - }, - "NodeConfiguration": { - "$ref": "#/definitions/NodeConfiguration" - }, - "NodeId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NodeId", - "/properties/Arn" - ], - "required": [ - "NetworkId", - "NodeConfiguration" - ], - "typeName": "AWS::ManagedBlockchain::Node" -} +{ + "additionalProperties": false, + "definitions": { + "NodeConfiguration": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "InstanceType": { + "type": "string" + } + }, + "required": [ + "AvailabilityZone", + "InstanceType" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ManagedBlockchain::Node", + "primaryIdentifier": [ + "/properties/NodeId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "MemberId": { + "type": "string" + }, + "NetworkId": { + "type": "string" + }, + "NodeConfiguration": { + "$ref": "#/definitions/NodeConfiguration" + }, + "NodeId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NodeId", + "/properties/Arn" + ], + "required": [ + "NetworkId", + "NodeConfiguration" + ], + "typeName": "AWS::ManagedBlockchain::Node" +} diff --git a/schema/aws-mediaconnect-bridge.json b/schema/aws-mediaconnect-bridge.json index 1ad0d27..ee87059 100644 --- a/schema/aws-mediaconnect-bridge.json +++ b/schema/aws-mediaconnect-bridge.json @@ -1,331 +1,331 @@ -{ - "additionalProperties": false, - "definitions": { - "BridgeFlowSource": { - "additionalProperties": false, - "description": "The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.", - "properties": { - "FlowArn": { - "description": "The ARN of the cloud flow used as a source of this bridge.", - "type": "string" - }, - "FlowVpcInterfaceAttachment": { - "$ref": "#/definitions/VpcInterfaceAttachment", - "description": "The name of the VPC interface attachment to use for this source." - }, - "Name": { - "description": "The name of the flow source.", - "type": "string" - } - }, - "required": [ - "Name", - "FlowArn" - ], - "type": "object" - }, - "BridgeNetworkOutput": { - "additionalProperties": false, - "description": "The output of the bridge. A network output is delivered to your premises.", - "properties": { - "IpAddress": { - "description": "The network output IP Address.", - "type": "string" - }, - "Name": { - "description": "The network output name.", - "type": "string" - }, - "NetworkName": { - "description": "The network output's gateway network name.", - "type": "string" - }, - "Port": { - "description": "The network output port.", - "type": "integer" - }, - "Protocol": { - "$ref": "#/definitions/ProtocolEnum", - "description": "The network output protocol." - }, - "Ttl": { - "description": "The network output TTL.", - "type": "integer" - } - }, - "required": [ - "Name", - "Protocol", - "IpAddress", - "Port", - "NetworkName", - "Ttl" - ], - "type": "object" - }, - "BridgeNetworkSource": { - "additionalProperties": false, - "description": "The source of the bridge. A network source originates at your premises.", - "properties": { - "MulticastIp": { - "description": "The network source multicast IP.", - "type": "string" - }, - "Name": { - "description": "The name of the network source.", - "type": "string" - }, - "NetworkName": { - "description": "The network source's gateway network name.", - "type": "string" - }, - "Port": { - "description": "The network source port.", - "type": "integer" - }, - "Protocol": { - "$ref": "#/definitions/ProtocolEnum", - "description": "The network source protocol." - } - }, - "required": [ - "Name", - "Protocol", - "MulticastIp", - "Port", - "NetworkName" - ], - "type": "object" - }, - "BridgeOutput": { - "additionalProperties": false, - "description": "The output of the bridge.", - "properties": { - "NetworkOutput": { - "$ref": "#/definitions/BridgeNetworkOutput" - } - }, - "type": "object" - }, - "BridgeSource": { - "additionalProperties": false, - "description": "The bridge's source.", - "properties": { - "FlowSource": { - "$ref": "#/definitions/BridgeFlowSource" - }, - "NetworkSource": { - "$ref": "#/definitions/BridgeNetworkSource" - } - }, - "type": "object" - }, - "BridgeStateEnum": { - "enum": [ - "CREATING", - "STANDBY", - "STARTING", - "DEPLOYING", - "ACTIVE", - "STOPPING", - "DELETING", - "DELETED", - "START_FAILED", - "START_PENDING", - "UPDATING" - ], - "type": "string" - }, - "EgressGatewayBridge": { - "additionalProperties": false, - "properties": { - "MaxBitrate": { - "description": "The maximum expected bitrate of the egress bridge.", - "type": "integer" - } - }, - "required": [ - "MaxBitrate" - ], - "type": "object" - }, - "FailoverConfig": { - "additionalProperties": false, - "description": "The settings for source failover.", - "properties": { - "FailoverMode": { - "$ref": "#/definitions/FailoverModeEnum", - "description": "The type of failover you choose for this flow. FAILOVER allows switching between different streams." - }, - "SourcePriority": { - "$ref": "#/definitions/SourcePriority", - "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams." - }, - "State": { - "$ref": "#/definitions/FailoverConfigStateEnum" - } - }, - "required": [ - "FailoverMode" - ], - "type": "object" - }, - "FailoverConfigStateEnum": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "FailoverModeEnum": { - "enum": [ - "FAILOVER" - ], - "type": "string" - }, - "IngressGatewayBridge": { - "additionalProperties": false, - "properties": { - "MaxBitrate": { - "description": "The maximum expected bitrate of the ingress bridge.", - "type": "integer" - }, - "MaxOutputs": { - "description": "The maximum number of outputs on the ingress bridge.", - "type": "integer" - } - }, - "required": [ - "MaxBitrate", - "MaxOutputs" - ], - "type": "object" - }, - "ProtocolEnum": { - "enum": [ - "rtp-fec", - "rtp", - "udp" - ], - "type": "string" - }, - "SourcePriority": { - "additionalProperties": false, - "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", - "properties": { - "PrimarySource": { - "description": "The name of the source you choose as the primary source for this flow.", - "type": "string" - } - }, - "type": "object" - }, - "VpcInterfaceAttachment": { - "additionalProperties": false, - "description": "The settings for attaching a VPC interface to an resource.", - "properties": { - "VpcInterfaceName": { - "description": "The name of the VPC interface to use for this resource.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::Bridge", - "handlers": { - "create": { - "permissions": [ - "mediaconnect:CreateBridge", - "mediaconnect:DescribeBridge" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeBridge", - "mediaconnect:DeleteBridge" - ] - }, - "list": { - "permissions": [ - "mediaconnect:ListBridges" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeBridge" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeBridge", - "mediaconnect:UpdateBridge" - ] - } - }, - "primaryIdentifier": [ - "/properties/BridgeArn" - ], - "properties": { - "BridgeArn": { - "description": "The Amazon Resource Number (ARN) of the bridge.", - "type": "string" - }, - "BridgeState": { - "$ref": "#/definitions/BridgeStateEnum" - }, - "EgressGatewayBridge": { - "$ref": "#/definitions/EgressGatewayBridge", - "type": "object" - }, - "IngressGatewayBridge": { - "$ref": "#/definitions/IngressGatewayBridge", - "type": "object" - }, - "Name": { - "description": "The name of the bridge.", - "type": "string" - }, - "Outputs": { - "description": "The outputs on this bridge.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/BridgeOutput" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "PlacementArn": { - "description": "The placement Amazon Resource Number (ARN) of the bridge.", - "type": "string" - }, - "SourceFailoverConfig": { - "$ref": "#/definitions/FailoverConfig" - }, - "Sources": { - "description": "The sources on this bridge.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/BridgeSource" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/BridgeArn", - "/properties/BridgeState" - ], - "required": [ - "Name", - "PlacementArn", - "Sources" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MediaConnect::Bridge" -} +{ + "additionalProperties": false, + "definitions": { + "BridgeFlowSource": { + "additionalProperties": false, + "description": "The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.", + "properties": { + "FlowArn": { + "description": "The ARN of the cloud flow used as a source of this bridge.", + "type": "string" + }, + "FlowVpcInterfaceAttachment": { + "$ref": "#/definitions/VpcInterfaceAttachment", + "description": "The name of the VPC interface attachment to use for this source." + }, + "Name": { + "description": "The name of the flow source.", + "type": "string" + } + }, + "required": [ + "Name", + "FlowArn" + ], + "type": "object" + }, + "BridgeNetworkOutput": { + "additionalProperties": false, + "description": "The output of the bridge. A network output is delivered to your premises.", + "properties": { + "IpAddress": { + "description": "The network output IP Address.", + "type": "string" + }, + "Name": { + "description": "The network output name.", + "type": "string" + }, + "NetworkName": { + "description": "The network output's gateway network name.", + "type": "string" + }, + "Port": { + "description": "The network output port.", + "type": "integer" + }, + "Protocol": { + "$ref": "#/definitions/ProtocolEnum", + "description": "The network output protocol." + }, + "Ttl": { + "description": "The network output TTL.", + "type": "integer" + } + }, + "required": [ + "Name", + "Protocol", + "IpAddress", + "Port", + "NetworkName", + "Ttl" + ], + "type": "object" + }, + "BridgeNetworkSource": { + "additionalProperties": false, + "description": "The source of the bridge. A network source originates at your premises.", + "properties": { + "MulticastIp": { + "description": "The network source multicast IP.", + "type": "string" + }, + "Name": { + "description": "The name of the network source.", + "type": "string" + }, + "NetworkName": { + "description": "The network source's gateway network name.", + "type": "string" + }, + "Port": { + "description": "The network source port.", + "type": "integer" + }, + "Protocol": { + "$ref": "#/definitions/ProtocolEnum", + "description": "The network source protocol." + } + }, + "required": [ + "Name", + "Protocol", + "MulticastIp", + "Port", + "NetworkName" + ], + "type": "object" + }, + "BridgeOutput": { + "additionalProperties": false, + "description": "The output of the bridge.", + "properties": { + "NetworkOutput": { + "$ref": "#/definitions/BridgeNetworkOutput" + } + }, + "type": "object" + }, + "BridgeSource": { + "additionalProperties": false, + "description": "The bridge's source.", + "properties": { + "FlowSource": { + "$ref": "#/definitions/BridgeFlowSource" + }, + "NetworkSource": { + "$ref": "#/definitions/BridgeNetworkSource" + } + }, + "type": "object" + }, + "BridgeStateEnum": { + "enum": [ + "CREATING", + "STANDBY", + "STARTING", + "DEPLOYING", + "ACTIVE", + "STOPPING", + "DELETING", + "DELETED", + "START_FAILED", + "START_PENDING", + "UPDATING" + ], + "type": "string" + }, + "EgressGatewayBridge": { + "additionalProperties": false, + "properties": { + "MaxBitrate": { + "description": "The maximum expected bitrate of the egress bridge.", + "type": "integer" + } + }, + "required": [ + "MaxBitrate" + ], + "type": "object" + }, + "FailoverConfig": { + "additionalProperties": false, + "description": "The settings for source failover.", + "properties": { + "FailoverMode": { + "$ref": "#/definitions/FailoverModeEnum", + "description": "The type of failover you choose for this flow. FAILOVER allows switching between different streams." + }, + "SourcePriority": { + "$ref": "#/definitions/SourcePriority", + "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams." + }, + "State": { + "$ref": "#/definitions/FailoverConfigStateEnum" + } + }, + "required": [ + "FailoverMode" + ], + "type": "object" + }, + "FailoverConfigStateEnum": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "FailoverModeEnum": { + "enum": [ + "FAILOVER" + ], + "type": "string" + }, + "IngressGatewayBridge": { + "additionalProperties": false, + "properties": { + "MaxBitrate": { + "description": "The maximum expected bitrate of the ingress bridge.", + "type": "integer" + }, + "MaxOutputs": { + "description": "The maximum number of outputs on the ingress bridge.", + "type": "integer" + } + }, + "required": [ + "MaxBitrate", + "MaxOutputs" + ], + "type": "object" + }, + "ProtocolEnum": { + "enum": [ + "rtp-fec", + "rtp", + "udp" + ], + "type": "string" + }, + "SourcePriority": { + "additionalProperties": false, + "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", + "properties": { + "PrimarySource": { + "description": "The name of the source you choose as the primary source for this flow.", + "type": "string" + } + }, + "type": "object" + }, + "VpcInterfaceAttachment": { + "additionalProperties": false, + "description": "The settings for attaching a VPC interface to an resource.", + "properties": { + "VpcInterfaceName": { + "description": "The name of the VPC interface to use for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::Bridge", + "handlers": { + "create": { + "permissions": [ + "mediaconnect:CreateBridge", + "mediaconnect:DescribeBridge" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeBridge", + "mediaconnect:DeleteBridge" + ] + }, + "list": { + "permissions": [ + "mediaconnect:ListBridges" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeBridge" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeBridge", + "mediaconnect:UpdateBridge" + ] + } + }, + "primaryIdentifier": [ + "/properties/BridgeArn" + ], + "properties": { + "BridgeArn": { + "description": "The Amazon Resource Number (ARN) of the bridge.", + "type": "string" + }, + "BridgeState": { + "$ref": "#/definitions/BridgeStateEnum" + }, + "EgressGatewayBridge": { + "$ref": "#/definitions/EgressGatewayBridge", + "type": "object" + }, + "IngressGatewayBridge": { + "$ref": "#/definitions/IngressGatewayBridge", + "type": "object" + }, + "Name": { + "description": "The name of the bridge.", + "type": "string" + }, + "Outputs": { + "description": "The outputs on this bridge.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/BridgeOutput" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "PlacementArn": { + "description": "The placement Amazon Resource Number (ARN) of the bridge.", + "type": "string" + }, + "SourceFailoverConfig": { + "$ref": "#/definitions/FailoverConfig" + }, + "Sources": { + "description": "The sources on this bridge.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/BridgeSource" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/BridgeArn", + "/properties/BridgeState" + ], + "required": [ + "Name", + "PlacementArn", + "Sources" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MediaConnect::Bridge" +} diff --git a/schema/aws-mediaconnect-bridgeoutput.json b/schema/aws-mediaconnect-bridgeoutput.json index 6609194..c7beee2 100644 --- a/schema/aws-mediaconnect-bridgeoutput.json +++ b/schema/aws-mediaconnect-bridgeoutput.json @@ -1,104 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BridgeArn", - "/properties/Name" - ], - "definitions": { - "BridgeNetworkOutput": { - "additionalProperties": false, - "description": "The output of the bridge. A network output is delivered to your premises.", - "properties": { - "IpAddress": { - "description": "The network output IP Address.", - "type": "string" - }, - "NetworkName": { - "description": "The network output's gateway network name.", - "type": "string" - }, - "Port": { - "description": "The network output port.", - "type": "integer" - }, - "Protocol": { - "description": "The network output protocol.", - "enum": [ - "rtp-fec", - "rtp", - "udp" - ], - "type": "string" - }, - "Ttl": { - "description": "The network output TTL.", - "type": "integer" - } - }, - "required": [ - "Protocol", - "IpAddress", - "Port", - "NetworkName", - "Ttl" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::BridgeOutput", - "handlers": { - "create": { - "permissions": [ - "mediaconnect:AddBridgeOutputs", - "mediaconnect:DescribeBridge" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:RemoveBridgeOutput" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeBridge" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeBridge", - "mediaconnect:UpdateBridgeOutput" - ] - } - }, - "primaryIdentifier": [ - "/properties/BridgeArn", - "/properties/Name" - ], - "properties": { - "BridgeArn": { - "description": "The Amazon Resource Number (ARN) of the bridge.", - "type": "string" - }, - "Name": { - "description": "The network output name.", - "type": "string" - }, - "NetworkOutput": { - "$ref": "#/definitions/BridgeNetworkOutput", - "description": "The output of the bridge." - } - }, - "propertyTransform": { - "/properties/Name": "$join([\"Output:\",Name])" - }, - "required": [ - "BridgeArn", - "Name", - "NetworkOutput" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MediaConnect::BridgeOutput" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BridgeArn", + "/properties/Name" + ], + "definitions": { + "BridgeNetworkOutput": { + "additionalProperties": false, + "description": "The output of the bridge. A network output is delivered to your premises.", + "properties": { + "IpAddress": { + "description": "The network output IP Address.", + "type": "string" + }, + "NetworkName": { + "description": "The network output's gateway network name.", + "type": "string" + }, + "Port": { + "description": "The network output port.", + "type": "integer" + }, + "Protocol": { + "description": "The network output protocol.", + "enum": [ + "rtp-fec", + "rtp", + "udp" + ], + "type": "string" + }, + "Ttl": { + "description": "The network output TTL.", + "type": "integer" + } + }, + "required": [ + "Protocol", + "IpAddress", + "Port", + "NetworkName", + "Ttl" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::BridgeOutput", + "handlers": { + "create": { + "permissions": [ + "mediaconnect:AddBridgeOutputs", + "mediaconnect:DescribeBridge" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:RemoveBridgeOutput" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeBridge" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeBridge", + "mediaconnect:UpdateBridgeOutput" + ] + } + }, + "primaryIdentifier": [ + "/properties/BridgeArn", + "/properties/Name" + ], + "properties": { + "BridgeArn": { + "description": "The Amazon Resource Number (ARN) of the bridge.", + "type": "string" + }, + "Name": { + "description": "The network output name.", + "type": "string" + }, + "NetworkOutput": { + "$ref": "#/definitions/BridgeNetworkOutput", + "description": "The output of the bridge." + } + }, + "propertyTransform": { + "/properties/Name": "$join([\"Output:\",Name])" + }, + "required": [ + "BridgeArn", + "Name", + "NetworkOutput" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MediaConnect::BridgeOutput" +} diff --git a/schema/aws-mediaconnect-bridgesource.json b/schema/aws-mediaconnect-bridgesource.json index 041f8c8..091892e 100644 --- a/schema/aws-mediaconnect-bridgesource.json +++ b/schema/aws-mediaconnect-bridgesource.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BridgeArn", - "/properties/Name" - ], - "definitions": { - "BridgeFlowSource": { - "additionalProperties": false, - "description": "The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.", - "properties": { - "FlowArn": { - "description": "The ARN of the cloud flow used as a source of this bridge.", - "type": "string" - }, - "FlowVpcInterfaceAttachment": { - "$ref": "#/definitions/VpcInterfaceAttachment", - "description": "The name of the VPC interface attachment to use for this source." - } - }, - "required": [ - "FlowArn" - ], - "type": "object" - }, - "BridgeNetworkSource": { - "additionalProperties": false, - "description": "The source of the bridge. A network source originates at your premises.", - "properties": { - "MulticastIp": { - "description": "The network source multicast IP.", - "type": "string" - }, - "NetworkName": { - "description": "The network source's gateway network name.", - "type": "string" - }, - "Port": { - "description": "The network source port.", - "type": "integer" - }, - "Protocol": { - "$ref": "#/definitions/ProtocolEnum", - "description": "The network source protocol." - } - }, - "required": [ - "Protocol", - "MulticastIp", - "Port", - "NetworkName" - ], - "type": "object" - }, - "ProtocolEnum": { - "enum": [ - "rtp-fec", - "rtp", - "udp" - ], - "type": "string" - }, - "VpcInterfaceAttachment": { - "additionalProperties": false, - "description": "The settings for attaching a VPC interface to an resource.", - "properties": { - "VpcInterfaceName": { - "description": "The name of the VPC interface to use for this resource.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::BridgeSource", - "handlers": { - "create": { - "permissions": [ - "mediaconnect:AddBridgeSources", - "mediaconnect:DescribeBridge" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:RemoveBridgeSource" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeBridge" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeBridge", - "mediaconnect:UpdateBridgeSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/BridgeArn", - "/properties/Name" - ], - "properties": { - "BridgeArn": { - "description": "The Amazon Resource Number (ARN) of the bridge.", - "type": "string" - }, - "FlowSource": { - "$ref": "#/definitions/BridgeFlowSource" - }, - "Name": { - "description": "The name of the source.", - "type": "string" - }, - "NetworkSource": { - "$ref": "#/definitions/BridgeNetworkSource" - } - }, - "propertyTransform": { - "/properties/Name": "$join([\"Source:\",Name])" - }, - "required": [ - "Name", - "BridgeArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MediaConnect::BridgeSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BridgeArn", + "/properties/Name" + ], + "definitions": { + "BridgeFlowSource": { + "additionalProperties": false, + "description": "The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.", + "properties": { + "FlowArn": { + "description": "The ARN of the cloud flow used as a source of this bridge.", + "type": "string" + }, + "FlowVpcInterfaceAttachment": { + "$ref": "#/definitions/VpcInterfaceAttachment", + "description": "The name of the VPC interface attachment to use for this source." + } + }, + "required": [ + "FlowArn" + ], + "type": "object" + }, + "BridgeNetworkSource": { + "additionalProperties": false, + "description": "The source of the bridge. A network source originates at your premises.", + "properties": { + "MulticastIp": { + "description": "The network source multicast IP.", + "type": "string" + }, + "NetworkName": { + "description": "The network source's gateway network name.", + "type": "string" + }, + "Port": { + "description": "The network source port.", + "type": "integer" + }, + "Protocol": { + "$ref": "#/definitions/ProtocolEnum", + "description": "The network source protocol." + } + }, + "required": [ + "Protocol", + "MulticastIp", + "Port", + "NetworkName" + ], + "type": "object" + }, + "ProtocolEnum": { + "enum": [ + "rtp-fec", + "rtp", + "udp" + ], + "type": "string" + }, + "VpcInterfaceAttachment": { + "additionalProperties": false, + "description": "The settings for attaching a VPC interface to an resource.", + "properties": { + "VpcInterfaceName": { + "description": "The name of the VPC interface to use for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::BridgeSource", + "handlers": { + "create": { + "permissions": [ + "mediaconnect:AddBridgeSources", + "mediaconnect:DescribeBridge" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:RemoveBridgeSource" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeBridge" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeBridge", + "mediaconnect:UpdateBridgeSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/BridgeArn", + "/properties/Name" + ], + "properties": { + "BridgeArn": { + "description": "The Amazon Resource Number (ARN) of the bridge.", + "type": "string" + }, + "FlowSource": { + "$ref": "#/definitions/BridgeFlowSource" + }, + "Name": { + "description": "The name of the source.", + "type": "string" + }, + "NetworkSource": { + "$ref": "#/definitions/BridgeNetworkSource" + } + }, + "propertyTransform": { + "/properties/Name": "$join([\"Source:\",Name])" + }, + "required": [ + "Name", + "BridgeArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MediaConnect::BridgeSource" +} diff --git a/schema/aws-mediaconnect-flow.json b/schema/aws-mediaconnect-flow.json index 175484d..70f3a7a 100644 --- a/schema/aws-mediaconnect-flow.json +++ b/schema/aws-mediaconnect-flow.json @@ -1,631 +1,653 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/AvailabilityZone", - "/properties/Source/Name" - ], - "definitions": { - "Encryption": { - "additionalProperties": false, - "description": "Information about the encryption of the flow.", - "properties": { - "Algorithm": { - "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", - "enum": [ - "aes128", - "aes192", - "aes256" - ], - "type": "string" - }, - "ConstantInitializationVector": { - "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", - "type": "string" - }, - "DeviceId": { - "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "KeyType": { - "default": "static-key", - "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "enum": [ - "speke", - "static-key", - "srt-password" - ], - "type": "string" - }, - "Region": { - "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "ResourceId": { - "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", - "type": "string" - }, - "SecretArn": { - "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "type": "string" - }, - "Url": { - "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "FailoverConfig": { - "additionalProperties": false, - "description": "The settings for source failover", - "properties": { - "FailoverMode": { - "description": "The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.", - "enum": [ - "MERGE", - "FAILOVER" - ], - "type": "string" - }, - "RecoveryWindow": { - "description": "Search window time to look for dash-7 packets", - "type": "integer" - }, - "SourcePriority": { - "additionalProperties": false, - "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", - "properties": { - "PrimarySource": { - "description": "The name of the source you choose as the primary source for this flow.", - "type": "string" - } - }, - "required": [ - "PrimarySource" - ], - "type": "object" - }, - "State": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "type": "object" - }, - "Fmtp": { - "additionalProperties": false, - "description": "A set of parameters that define the media stream.", - "properties": { - "ChannelOrder": { - "description": "The format of the audio channel.", - "type": "string" - }, - "Colorimetry": { - "description": "The format used for the representation of color.", - "enum": [ - "BT601", - "BT709", - "BT2020", - "BT2100", - "ST2065-1", - "ST2065-3", - "XYZ" - ], - "type": "string" - }, - "ExactFramerate": { - "description": "The frame rate for the video stream, in frames/second. For example: 60000/1001.", - "type": "string" - }, - "Par": { - "description": "The pixel aspect ratio (PAR) of the video.", - "type": "string" - }, - "Range": { - "description": "The encoding range of the video.", - "enum": [ - "NARROW", - "FULL", - "FULLPROTECT" - ], - "type": "string" - }, - "ScanMode": { - "description": "The type of compression that was used to smooth the video's appearance.", - "enum": [ - "progressive", - "interlace", - "progressive-segmented-frame" - ], - "type": "string" - }, - "Tcs": { - "description": "The transfer characteristic system (TCS) that is used in the video.", - "enum": [ - "SDR", - "PQ", - "HLG", - "LINEAR", - "BT2100LINPQ", - "BT2100LINHLG", - "ST2065-1", - "ST428-1", - "DENSITY" - ], - "type": "string" - } - }, - "type": "object" - }, - "GatewayBridgeSource": { - "additionalProperties": false, - "description": "The source configuration for cloud flows receiving a stream from a bridge.", - "properties": { - "BridgeArn": { - "description": "The ARN of the bridge feeding this flow.", - "type": "string" - }, - "VpcInterfaceAttachment": { - "$ref": "#/definitions/VpcInterfaceAttachment", - "description": "The name of the VPC interface attachment to use for this bridge source." - } - }, - "required": [ - "BridgeArn" - ], - "type": "object" - }, - "InputConfiguration": { - "additionalProperties": false, - "description": "The transport parameters associated with an incoming media stream.", - "properties": { - "InputPort": { - "description": "The port that the flow listens on for an incoming media stream.", - "type": "integer" - }, - "Interface": { - "$ref": "#/definitions/Interface", - "description": "The VPC interface where the media stream comes in from." - } - }, - "required": [ - "InputPort", - "Interface" - ], - "type": "object" - }, - "Interface": { - "additionalProperties": false, - "description": "The VPC interface that you want to use for the media stream associated with the output.", - "properties": { - "Name": { - "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Maintenance": { - "additionalProperties": false, - "description": "The maintenance setting of a flow.", - "properties": { - "MaintenanceDay": { - "description": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "type": "string" - }, - "MaintenanceStartHour": { - "description": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", - "type": "string" - } - }, - "required": [ - "MaintenanceDay", - "MaintenanceStartHour" - ], - "type": "object" - }, - "MediaStream": { - "additionalProperties": false, - "description": "A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.", - "properties": { - "Attributes": { - "$ref": "#/definitions/MediaStreamAttributes", - "description": "Attributes that are related to the media stream." - }, - "ClockRate": { - "description": "The sample rate for the stream. This value in measured in kHz.", - "type": "integer" - }, - "Description": { - "description": "A description that can help you quickly identify what your media stream is used for.", - "type": "string" - }, - "Fmt": { - "description": "The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.", - "type": "integer" - }, - "MediaStreamId": { - "description": "A unique identifier for the media stream.", - "type": "integer" - }, - "MediaStreamName": { - "description": "A name that helps you distinguish one media stream from another.", - "type": "string" - }, - "MediaStreamType": { - "description": "The type of media stream.", - "enum": [ - "video", - "audio", - "ancillary-data" - ], - "type": "string" - }, - "VideoFormat": { - "description": "The resolution of the video.", - "enum": [ - "2160p", - "1080p", - "1080i", - "720p", - "480p" - ], - "type": "string" - } - }, - "required": [ - "MediaStreamId", - "MediaStreamType", - "MediaStreamName" - ], - "type": "object" - }, - "MediaStreamAttributes": { - "additionalProperties": false, - "description": "Attributes that are related to the media stream.", - "properties": { - "Fmtp": { - "$ref": "#/definitions/Fmtp", - "description": "A set of parameters that define the media stream." - }, - "Lang": { - "description": "The audio language, in a format that is recognized by the receiver.", - "type": "string" - } - }, - "type": "object" - }, - "MediaStreamSourceConfiguration": { - "additionalProperties": false, - "description": "The media stream that is associated with the source, and the parameters for that association.", - "properties": { - "EncodingName": { - "description": "The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.", - "enum": [ - "jxsv", - "raw", - "smpte291", - "pcm" - ], - "type": "string" - }, - "InputConfigurations": { - "description": "The media streams that you want to associate with the source.", - "items": { - "$ref": "#/definitions/InputConfiguration" - }, - "type": "array" - }, - "MediaStreamName": { - "description": "A name that helps you distinguish one media stream from another.", - "type": "string" - } - }, - "required": [ - "EncodingName", - "MediaStreamName" - ], - "type": "object" - }, - "Source": { - "additionalProperties": false, - "description": "The settings for the source of the flow.", - "properties": { - "Decryption": { - "$ref": "#/definitions/Encryption", - "description": "The type of decryption that is used on the content ingested from this source." - }, - "Description": { - "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "type": "string" - }, - "EntitlementArn": { - "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", - "type": "string" - }, - "GatewayBridgeSource": { - "$ref": "#/definitions/GatewayBridgeSource", - "description": "The source configuration for cloud flows receiving a stream from a bridge." - }, - "IngestIp": { - "description": "The IP address that the flow will be listening on for incoming content.", - "type": "string" - }, - "IngestPort": { - "description": "The port that the flow will be listening on for incoming content.", - "type": "integer" - }, - "MaxBitrate": { - "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", - "type": "integer" - }, - "MaxLatency": { - "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", - "type": "integer" - }, - "MaxSyncBuffer": { - "description": "The size of the buffer (in milliseconds) to use to sync incoming source data.", - "type": "integer" - }, - "MediaStreamSourceConfigurations": { - "description": "The media stream that is associated with the source, and the parameters for that association.", - "items": { - "$ref": "#/definitions/MediaStreamSourceConfiguration" - }, - "type": "array" - }, - "MinLatency": { - "description": "The minimum latency in milliseconds.", - "type": "integer" - }, - "Name": { - "description": "The name of the source.", - "type": "string" - }, - "Protocol": { - "description": "The protocol that is used by the source.", - "enum": [ - "zixi-push", - "rtp-fec", - "rtp", - "rist", - "fujitsu-qos", - "srt-listener", - "srt-caller", - "st2110-jpegxs", - "cdi" - ], - "type": "string" - }, - "SenderControlPort": { - "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.", - "type": "integer" - }, - "SenderIpAddress": { - "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.", - "type": "string" - }, - "SourceArn": { - "description": "The ARN of the source.", - "type": "string" - }, - "SourceIngestPort": { - "description": "The port that the flow will be listening on for incoming content.(ReadOnly)", - "type": "string" - }, - "SourceListenerAddress": { - "description": "Source IP or domain name for SRT-caller protocol.", - "type": "string" - }, - "SourceListenerPort": { - "description": "Source port for SRT-caller protocol.", - "type": "integer" - }, - "StreamId": { - "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", - "type": "string" - }, - "VpcInterfaceName": { - "description": "The name of the VPC Interface this Source is configured with.", - "type": "string" - }, - "WhitelistCidr": { - "description": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "type": "string" - } - }, - "type": "object" - }, - "VpcInterface": { - "additionalProperties": false, - "description": "The details of a VPC interface.", - "properties": { - "Name": { - "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", - "type": "string" - }, - "NetworkInterfaceIds": { - "description": "IDs of the network interfaces created in customer's account by MediaConnect.", - "items": { - "type": "string" - }, - "type": "array" - }, - "NetworkInterfaceType": { - "description": "The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA.", - "enum": [ - "ena", - "efa" - ], - "type": "string" - }, - "RoleArn": { - "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", - "type": "string" - }, - "SecurityGroupIds": { - "description": "Security Group IDs to be used on ENI.", - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "description": "Subnet must be in the AZ of the Flow", - "type": "string" - } - }, - "required": [ - "Name", - "RoleArn", - "SecurityGroupIds", - "SubnetId" - ], - "type": "object" - }, - "VpcInterfaceAttachment": { - "additionalProperties": false, - "description": "The settings for attaching a VPC interface to an resource.", - "properties": { - "VpcInterfaceName": { - "description": "The name of the VPC interface to use for this resource.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::Flow", - "handlers": { - "create": { - "permissions": [ - "mediaconnect:CreateFlow", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:DeleteFlow" - ] - }, - "list": { - "permissions": [ - "mediaconnect:ListFlows" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:UpdateFlow", - "mediaconnect:UpdateFlowSource", - "mediaconnect:UpdateFlowMediaStream", - "mediaconnect:AddFlowMediaStreams", - "mediaconnect:RemoveFlowMediaStream", - "mediaconnect:AddFlowVpcInterfaces", - "mediaconnect:RemoveFlowVpcInterface" - ] - } - }, - "primaryIdentifier": [ - "/properties/FlowArn" - ], - "properties": { - "AvailabilityZone": { - "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.", - "type": "string" - }, - "EgressIp": { - "description": "The IP address from which video will be sent to output destinations.", - "type": "string" - }, - "FlowArn": { - "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", - "type": "string" - }, - "FlowAvailabilityZone": { - "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)", - "type": "string" - }, - "Maintenance": { - "$ref": "#/definitions/Maintenance", - "description": "The maintenance settings you want to use for the flow. " - }, - "MediaStreams": { - "description": "The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.", - "items": { - "$ref": "#/definitions/MediaStream" - }, - "type": "array" - }, - "Name": { - "description": "The name of the flow.", - "type": "string" - }, - "Source": { - "$ref": "#/definitions/Source", - "description": "The source of the flow." - }, - "SourceFailoverConfig": { - "$ref": "#/definitions/FailoverConfig", - "description": "The source failover config of the flow." - }, - "VpcInterfaces": { - "description": "The VPC interfaces that you added to this flow.", - "items": { - "$ref": "#/definitions/VpcInterface" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/FlowArn", - "/properties/FlowAvailabilityZone", - "/properties/Source/SourceArn", - "/properties/Source/IngestIp", - "/properties/Source/SourceIngestPort", - "/properties/VpcInterfaces/*/NetworkInterfaceIds", - "/properties/MediaStreams/*/Fmt", - "/properties/EgressIp" - ], - "required": [ - "Name", - "Source" - ], - "resourceLink": { - "mappings": { - "flowArn": "/FlowArn" - }, - "templateUri": "/mediaconnect/home?region=${awsRegion}#/flows/${flowArn}" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "typeName": "AWS::MediaConnect::Flow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/AvailabilityZone", + "/properties/Source/Name" + ], + "definitions": { + "Encryption": { + "additionalProperties": false, + "description": "Information about the encryption of the flow.", + "properties": { + "Algorithm": { + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", + "enum": [ + "aes128", + "aes192", + "aes256" + ], + "type": "string" + }, + "ConstantInitializationVector": { + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", + "type": "string" + }, + "DeviceId": { + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "KeyType": { + "default": "static-key", + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "enum": [ + "speke", + "static-key", + "srt-password" + ], + "type": "string" + }, + "Region": { + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "ResourceId": { + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", + "type": "string" + }, + "SecretArn": { + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "type": "string" + }, + "Url": { + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "FailoverConfig": { + "additionalProperties": false, + "description": "The settings for source failover", + "properties": { + "FailoverMode": { + "description": "The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.", + "enum": [ + "MERGE", + "FAILOVER" + ], + "type": "string" + }, + "RecoveryWindow": { + "description": "Search window time to look for dash-7 packets", + "type": "integer" + }, + "SourcePriority": { + "additionalProperties": false, + "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", + "properties": { + "PrimarySource": { + "description": "The name of the source you choose as the primary source for this flow.", + "type": "string" + } + }, + "required": [ + "PrimarySource" + ], + "type": "object" + }, + "State": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "type": "object" + }, + "Fmtp": { + "additionalProperties": false, + "description": "A set of parameters that define the media stream.", + "properties": { + "ChannelOrder": { + "description": "The format of the audio channel.", + "type": "string" + }, + "Colorimetry": { + "description": "The format used for the representation of color.", + "enum": [ + "BT601", + "BT709", + "BT2020", + "BT2100", + "ST2065-1", + "ST2065-3", + "XYZ" + ], + "type": "string" + }, + "ExactFramerate": { + "description": "The frame rate for the video stream, in frames/second. For example: 60000/1001.", + "type": "string" + }, + "Par": { + "description": "The pixel aspect ratio (PAR) of the video.", + "type": "string" + }, + "Range": { + "description": "The encoding range of the video.", + "enum": [ + "NARROW", + "FULL", + "FULLPROTECT" + ], + "type": "string" + }, + "ScanMode": { + "description": "The type of compression that was used to smooth the video's appearance.", + "enum": [ + "progressive", + "interlace", + "progressive-segmented-frame" + ], + "type": "string" + }, + "Tcs": { + "description": "The transfer characteristic system (TCS) that is used in the video.", + "enum": [ + "SDR", + "PQ", + "HLG", + "LINEAR", + "BT2100LINPQ", + "BT2100LINHLG", + "ST2065-1", + "ST428-1", + "DENSITY" + ], + "type": "string" + } + }, + "type": "object" + }, + "GatewayBridgeSource": { + "additionalProperties": false, + "description": "The source configuration for cloud flows receiving a stream from a bridge.", + "properties": { + "BridgeArn": { + "description": "The ARN of the bridge feeding this flow.", + "type": "string" + }, + "VpcInterfaceAttachment": { + "$ref": "#/definitions/VpcInterfaceAttachment", + "description": "The name of the VPC interface attachment to use for this bridge source." + } + }, + "required": [ + "BridgeArn" + ], + "type": "object" + }, + "InputConfiguration": { + "additionalProperties": false, + "description": "The transport parameters associated with an incoming media stream.", + "properties": { + "InputPort": { + "description": "The port that the flow listens on for an incoming media stream.", + "type": "integer" + }, + "Interface": { + "$ref": "#/definitions/Interface", + "description": "The VPC interface where the media stream comes in from." + } + }, + "required": [ + "InputPort", + "Interface" + ], + "type": "object" + }, + "Interface": { + "additionalProperties": false, + "description": "The VPC interface that you want to use for the media stream associated with the output.", + "properties": { + "Name": { + "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Maintenance": { + "additionalProperties": false, + "description": "The maintenance setting of a flow.", + "properties": { + "MaintenanceDay": { + "description": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "MaintenanceStartHour": { + "description": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", + "type": "string" + } + }, + "required": [ + "MaintenanceDay", + "MaintenanceStartHour" + ], + "type": "object" + }, + "MediaStream": { + "additionalProperties": false, + "description": "A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.", + "properties": { + "Attributes": { + "$ref": "#/definitions/MediaStreamAttributes", + "description": "Attributes that are related to the media stream." + }, + "ClockRate": { + "description": "The sample rate for the stream. This value in measured in kHz.", + "type": "integer" + }, + "Description": { + "description": "A description that can help you quickly identify what your media stream is used for.", + "type": "string" + }, + "Fmt": { + "description": "The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.", + "type": "integer" + }, + "MediaStreamId": { + "description": "A unique identifier for the media stream.", + "type": "integer" + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + }, + "MediaStreamType": { + "description": "The type of media stream.", + "enum": [ + "video", + "audio", + "ancillary-data" + ], + "type": "string" + }, + "VideoFormat": { + "description": "The resolution of the video.", + "enum": [ + "2160p", + "1080p", + "1080i", + "720p", + "480p" + ], + "type": "string" + } + }, + "required": [ + "MediaStreamId", + "MediaStreamType", + "MediaStreamName" + ], + "type": "object" + }, + "MediaStreamAttributes": { + "additionalProperties": false, + "description": "Attributes that are related to the media stream.", + "properties": { + "Fmtp": { + "$ref": "#/definitions/Fmtp", + "description": "A set of parameters that define the media stream." + }, + "Lang": { + "description": "The audio language, in a format that is recognized by the receiver.", + "type": "string" + } + }, + "type": "object" + }, + "MediaStreamSourceConfiguration": { + "additionalProperties": false, + "description": "The media stream that is associated with the source, and the parameters for that association.", + "properties": { + "EncodingName": { + "description": "The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.", + "enum": [ + "jxsv", + "raw", + "smpte291", + "pcm" + ], + "type": "string" + }, + "InputConfigurations": { + "description": "The media streams that you want to associate with the source.", + "items": { + "$ref": "#/definitions/InputConfiguration" + }, + "type": "array" + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + } + }, + "required": [ + "EncodingName", + "MediaStreamName" + ], + "type": "object" + }, + "Source": { + "additionalProperties": false, + "description": "The settings for the source of the flow.", + "properties": { + "Decryption": { + "$ref": "#/definitions/Encryption", + "description": "The type of decryption that is used on the content ingested from this source." + }, + "Description": { + "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "type": "string" + }, + "EntitlementArn": { + "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", + "type": "string" + }, + "GatewayBridgeSource": { + "$ref": "#/definitions/GatewayBridgeSource", + "description": "The source configuration for cloud flows receiving a stream from a bridge." + }, + "IngestIp": { + "description": "The IP address that the flow will be listening on for incoming content.", + "type": "string" + }, + "IngestPort": { + "description": "The port that the flow will be listening on for incoming content.", + "type": "integer" + }, + "MaxBitrate": { + "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", + "type": "integer" + }, + "MaxLatency": { + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "type": "integer" + }, + "MaxSyncBuffer": { + "description": "The size of the buffer (in milliseconds) to use to sync incoming source data.", + "type": "integer" + }, + "MediaStreamSourceConfigurations": { + "description": "The media stream that is associated with the source, and the parameters for that association.", + "items": { + "$ref": "#/definitions/MediaStreamSourceConfiguration" + }, + "type": "array" + }, + "MinLatency": { + "description": "The minimum latency in milliseconds.", + "type": "integer" + }, + "Name": { + "description": "The name of the source.", + "type": "string" + }, + "Protocol": { + "description": "The protocol that is used by the source.", + "enum": [ + "zixi-push", + "rtp-fec", + "rtp", + "rist", + "fujitsu-qos", + "srt-listener", + "srt-caller", + "st2110-jpegxs", + "cdi" + ], + "type": "string" + }, + "SenderControlPort": { + "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.", + "type": "integer" + }, + "SenderIpAddress": { + "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.", + "type": "string" + }, + "SourceArn": { + "description": "The ARN of the source.", + "type": "string" + }, + "SourceIngestPort": { + "description": "The port that the flow will be listening on for incoming content.(ReadOnly)", + "type": "string" + }, + "SourceListenerAddress": { + "description": "Source IP or domain name for SRT-caller protocol.", + "type": "string" + }, + "SourceListenerPort": { + "description": "Source port for SRT-caller protocol.", + "type": "integer" + }, + "StreamId": { + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", + "type": "string" + }, + "VpcInterfaceName": { + "description": "The name of the VPC Interface this Source is configured with.", + "type": "string" + }, + "WhitelistCidr": { + "description": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "type": "string" + } + }, + "type": "object" + }, + "SourceMonitoringConfig": { + "additionalProperties": false, + "description": "The settings for source monitoring.", + "properties": { + "ThumbnailState": { + "description": "The state of thumbnail monitoring.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [ + "ThumbnailState" + ], + "type": "object" + }, + "VpcInterface": { + "additionalProperties": false, + "description": "The details of a VPC interface.", + "properties": { + "Name": { + "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", + "type": "string" + }, + "NetworkInterfaceIds": { + "description": "IDs of the network interfaces created in customer's account by MediaConnect.", + "items": { + "type": "string" + }, + "type": "array" + }, + "NetworkInterfaceType": { + "description": "The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA.", + "enum": [ + "ena", + "efa" + ], + "type": "string" + }, + "RoleArn": { + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "Security Group IDs to be used on ENI.", + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetId": { + "description": "Subnet must be in the AZ of the Flow", + "type": "string" + } + }, + "required": [ + "Name", + "RoleArn", + "SecurityGroupIds", + "SubnetId" + ], + "type": "object" + }, + "VpcInterfaceAttachment": { + "additionalProperties": false, + "description": "The settings for attaching a VPC interface to an resource.", + "properties": { + "VpcInterfaceName": { + "description": "The name of the VPC interface to use for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::Flow", + "handlers": { + "create": { + "permissions": [ + "mediaconnect:CreateFlow", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:DeleteFlow" + ] + }, + "list": { + "permissions": [ + "mediaconnect:ListFlows" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:UpdateFlow", + "mediaconnect:UpdateFlowSource", + "mediaconnect:UpdateFlowMediaStream", + "mediaconnect:AddFlowMediaStreams", + "mediaconnect:RemoveFlowMediaStream", + "mediaconnect:AddFlowVpcInterfaces", + "mediaconnect:RemoveFlowVpcInterface" + ] + } + }, + "primaryIdentifier": [ + "/properties/FlowArn" + ], + "properties": { + "AvailabilityZone": { + "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.", + "type": "string" + }, + "EgressIp": { + "description": "The IP address from which video will be sent to output destinations.", + "type": "string" + }, + "FlowArn": { + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", + "type": "string" + }, + "FlowAvailabilityZone": { + "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)", + "type": "string" + }, + "Maintenance": { + "$ref": "#/definitions/Maintenance", + "description": "The maintenance settings you want to use for the flow." + }, + "MediaStreams": { + "description": "The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.", + "items": { + "$ref": "#/definitions/MediaStream" + }, + "type": "array" + }, + "Name": { + "description": "The name of the flow.", + "type": "string" + }, + "Source": { + "$ref": "#/definitions/Source", + "description": "The source of the flow." + }, + "SourceFailoverConfig": { + "$ref": "#/definitions/FailoverConfig", + "description": "The source failover config of the flow." + }, + "SourceMonitoringConfig": { + "$ref": "#/definitions/SourceMonitoringConfig", + "description": "The source monitoring config of the flow." + }, + "VpcInterfaces": { + "description": "The VPC interfaces that you added to this flow.", + "items": { + "$ref": "#/definitions/VpcInterface" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/FlowArn", + "/properties/FlowAvailabilityZone", + "/properties/Source/SourceArn", + "/properties/Source/IngestIp", + "/properties/Source/SourceIngestPort", + "/properties/VpcInterfaces/*/NetworkInterfaceIds", + "/properties/MediaStreams/*/Fmt", + "/properties/EgressIp" + ], + "required": [ + "Name", + "Source" + ], + "resourceLink": { + "mappings": { + "flowArn": "/FlowArn" + }, + "templateUri": "/mediaconnect/home?region=${awsRegion}#/flows/${flowArn}" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "typeName": "AWS::MediaConnect::Flow" +} diff --git a/schema/aws-mediaconnect-flowentitlement.json b/schema/aws-mediaconnect-flowentitlement.json index 601667b..8c99e87 100644 --- a/schema/aws-mediaconnect-flowentitlement.json +++ b/schema/aws-mediaconnect-flowentitlement.json @@ -1,153 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataTransferSubscriberFeePercent", - "/properties/Name" - ], - "definitions": { - "Encryption": { - "additionalProperties": false, - "description": "Information about the encryption of the flow.", - "properties": { - "Algorithm": { - "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", - "enum": [ - "aes128", - "aes192", - "aes256" - ], - "type": "string" - }, - "ConstantInitializationVector": { - "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", - "type": "string" - }, - "DeviceId": { - "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "KeyType": { - "default": "static-key", - "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "enum": [ - "speke", - "static-key" - ], - "type": "string" - }, - "Region": { - "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "ResourceId": { - "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", - "type": "string" - }, - "SecretArn": { - "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "type": "string" - }, - "Url": { - "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - } - }, - "required": [ - "Algorithm", - "RoleArn" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::FlowEntitlement", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "mediaconnect:GrantFlowEntitlements" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:RevokeFlowEntitlement" - ] - }, - "list": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:UpdateFlowEntitlement" - ] - } - }, - "primaryIdentifier": [ - "/properties/EntitlementArn" - ], - "properties": { - "DataTransferSubscriberFeePercent": { - "default": 0, - "description": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber.", - "type": "integer" - }, - "Description": { - "description": "A description of the entitlement.", - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/Encryption", - "description": "The type of encryption that will be used on the output that is associated with this entitlement." - }, - "EntitlementArn": { - "description": "The ARN of the entitlement.", - "type": "string" - }, - "EntitlementStatus": { - "description": " An indication of whether the entitlement is enabled.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "FlowArn": { - "description": "The ARN of the flow.", - "type": "string" - }, - "Name": { - "description": "The name of the entitlement.", - "type": "string" - }, - "Subscribers": { - "description": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/EntitlementArn" - ], - "required": [ - "FlowArn", - "Name", - "Subscribers", - "Description" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "typeName": "AWS::MediaConnect::FlowEntitlement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataTransferSubscriberFeePercent", + "/properties/Name" + ], + "definitions": { + "Encryption": { + "additionalProperties": false, + "description": "Information about the encryption of the flow.", + "properties": { + "Algorithm": { + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", + "enum": [ + "aes128", + "aes192", + "aes256" + ], + "type": "string" + }, + "ConstantInitializationVector": { + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", + "type": "string" + }, + "DeviceId": { + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "KeyType": { + "default": "static-key", + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "enum": [ + "speke", + "static-key" + ], + "type": "string" + }, + "Region": { + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "ResourceId": { + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", + "type": "string" + }, + "SecretArn": { + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "type": "string" + }, + "Url": { + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + } + }, + "required": [ + "Algorithm", + "RoleArn" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::FlowEntitlement", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "mediaconnect:GrantFlowEntitlements" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:RevokeFlowEntitlement" + ] + }, + "list": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:UpdateFlowEntitlement" + ] + } + }, + "primaryIdentifier": [ + "/properties/EntitlementArn" + ], + "properties": { + "DataTransferSubscriberFeePercent": { + "default": 0, + "description": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber.", + "type": "integer" + }, + "Description": { + "description": "A description of the entitlement.", + "type": "string" + }, + "Encryption": { + "$ref": "#/definitions/Encryption", + "description": "The type of encryption that will be used on the output that is associated with this entitlement." + }, + "EntitlementArn": { + "description": "The ARN of the entitlement.", + "type": "string" + }, + "EntitlementStatus": { + "description": " An indication of whether the entitlement is enabled.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "FlowArn": { + "description": "The ARN of the flow.", + "type": "string" + }, + "Name": { + "description": "The name of the entitlement.", + "type": "string" + }, + "Subscribers": { + "description": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/EntitlementArn" + ], + "required": [ + "FlowArn", + "Name", + "Subscribers", + "Description" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "typeName": "AWS::MediaConnect::FlowEntitlement" +} diff --git a/schema/aws-mediaconnect-flowoutput.json b/schema/aws-mediaconnect-flowoutput.json index c850629..951e87e 100644 --- a/schema/aws-mediaconnect-flowoutput.json +++ b/schema/aws-mediaconnect-flowoutput.json @@ -1,287 +1,287 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "DestinationConfiguration": { - "additionalProperties": false, - "description": "The definition of a media stream that is associated with the output.", - "properties": { - "DestinationIp": { - "description": "The IP address where contents of the media stream will be sent.", - "type": "string" - }, - "DestinationPort": { - "description": "The port to use when the content of the media stream is distributed to the output.", - "type": "integer" - }, - "Interface": { - "$ref": "#/definitions/Interface", - "description": "The VPC interface that is used for the media stream associated with the output." - } - }, - "required": [ - "DestinationIp", - "DestinationPort", - "Interface" - ], - "type": "object" - }, - "EncodingParameters": { - "additionalProperties": false, - "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.", - "properties": { - "CompressionFactor": { - "description": "A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.", - "type": "number" - }, - "EncoderProfile": { - "description": "A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.", - "enum": [ - "main", - "high" - ], - "type": "string" - } - }, - "required": [ - "CompressionFactor" - ], - "type": "object" - }, - "Encryption": { - "additionalProperties": false, - "description": "Information about the encryption of the flow.", - "properties": { - "Algorithm": { - "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", - "enum": [ - "aes128", - "aes192", - "aes256" - ], - "type": "string" - }, - "KeyType": { - "default": "static-key", - "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "enum": [ - "static-key", - "srt-password" - ], - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", - "type": "string" - }, - "SecretArn": { - "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "type": "string" - } - }, - "required": [ - "RoleArn", - "SecretArn" - ], - "type": "object" - }, - "Interface": { - "additionalProperties": false, - "description": "The VPC interface that you want to use for the media stream associated with the output.", - "properties": { - "Name": { - "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "MediaStreamOutputConfiguration": { - "additionalProperties": false, - "description": "The media stream that is associated with the output, and the parameters for that association.", - "properties": { - "DestinationConfigurations": { - "description": "The media streams that you want to associate with the output.", - "items": { - "$ref": "#/definitions/DestinationConfiguration" - }, - "type": "array" - }, - "EncodingName": { - "description": "The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.", - "enum": [ - "jxsv", - "raw", - "smpte291", - "pcm" - ], - "type": "string" - }, - "EncodingParameters": { - "$ref": "#/definitions/EncodingParameters", - "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source." - }, - "MediaStreamName": { - "description": "A name that helps you distinguish one media stream from another.", - "type": "string" - } - }, - "required": [ - "EncodingName", - "MediaStreamName" - ], - "type": "object" - }, - "VpcInterfaceAttachment": { - "additionalProperties": false, - "description": "The settings for attaching a VPC interface to an output.", - "properties": { - "VpcInterfaceName": { - "description": "The name of the VPC interface to use for this output.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::FlowOutput", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "mediaconnect:AddFlowOutputs" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:RemoveFlowOutput" - ] - }, - "list": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:UpdateFlowOutput" - ] - } - }, - "primaryIdentifier": [ - "/properties/OutputArn" - ], - "properties": { - "CidrAllowList": { - "description": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Description": { - "description": "A description of the output.", - "type": "string" - }, - "Destination": { - "description": "The address where you want to send the output.", - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/Encryption", - "description": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." - }, - "FlowArn": { - "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", - "type": "string" - }, - "MaxLatency": { - "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", - "type": "integer" - }, - "MediaStreamOutputConfigurations": { - "description": "The definition for each media stream that is associated with the output.", - "items": { - "$ref": "#/definitions/MediaStreamOutputConfiguration" - }, - "type": "array" - }, - "MinLatency": { - "description": "The minimum latency in milliseconds.", - "type": "integer" - }, - "Name": { - "description": "The name of the output. This value must be unique within the current flow.", - "type": "string" - }, - "OutputArn": { - "description": "The ARN of the output.", - "type": "string" - }, - "OutputStatus": { - "description": "An indication of whether the output should transmit data or not.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Port": { - "description": "The port to use when content is distributed to this output.", - "type": "integer" - }, - "Protocol": { - "description": "The protocol that is used by the source or output.", - "enum": [ - "zixi-push", - "rtp-fec", - "rtp", - "zixi-pull", - "rist", - "fujitsu-qos", - "srt-listener", - "srt-caller", - "st2110-jpegxs", - "cdi" - ], - "type": "string" - }, - "RemoteId": { - "description": "The remote ID for the Zixi-pull stream.", - "type": "string" - }, - "SmoothingLatency": { - "description": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", - "type": "integer" - }, - "StreamId": { - "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", - "type": "string" - }, - "VpcInterfaceAttachment": { - "$ref": "#/definitions/VpcInterfaceAttachment", - "description": "The name of the VPC interface attachment to use for this output." - } - }, - "readOnlyProperties": [ - "/properties/OutputArn" - ], - "required": [ - "FlowArn", - "Protocol" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "typeName": "AWS::MediaConnect::FlowOutput" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "DestinationConfiguration": { + "additionalProperties": false, + "description": "The definition of a media stream that is associated with the output.", + "properties": { + "DestinationIp": { + "description": "The IP address where contents of the media stream will be sent.", + "type": "string" + }, + "DestinationPort": { + "description": "The port to use when the content of the media stream is distributed to the output.", + "type": "integer" + }, + "Interface": { + "$ref": "#/definitions/Interface", + "description": "The VPC interface that is used for the media stream associated with the output." + } + }, + "required": [ + "DestinationIp", + "DestinationPort", + "Interface" + ], + "type": "object" + }, + "EncodingParameters": { + "additionalProperties": false, + "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.", + "properties": { + "CompressionFactor": { + "description": "A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.", + "type": "number" + }, + "EncoderProfile": { + "description": "A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.", + "enum": [ + "main", + "high" + ], + "type": "string" + } + }, + "required": [ + "CompressionFactor" + ], + "type": "object" + }, + "Encryption": { + "additionalProperties": false, + "description": "Information about the encryption of the flow.", + "properties": { + "Algorithm": { + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", + "enum": [ + "aes128", + "aes192", + "aes256" + ], + "type": "string" + }, + "KeyType": { + "default": "static-key", + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "enum": [ + "static-key", + "srt-password" + ], + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", + "type": "string" + }, + "SecretArn": { + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SecretArn" + ], + "type": "object" + }, + "Interface": { + "additionalProperties": false, + "description": "The VPC interface that you want to use for the media stream associated with the output.", + "properties": { + "Name": { + "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "MediaStreamOutputConfiguration": { + "additionalProperties": false, + "description": "The media stream that is associated with the output, and the parameters for that association.", + "properties": { + "DestinationConfigurations": { + "description": "The media streams that you want to associate with the output.", + "items": { + "$ref": "#/definitions/DestinationConfiguration" + }, + "type": "array" + }, + "EncodingName": { + "description": "The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.", + "enum": [ + "jxsv", + "raw", + "smpte291", + "pcm" + ], + "type": "string" + }, + "EncodingParameters": { + "$ref": "#/definitions/EncodingParameters", + "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source." + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + } + }, + "required": [ + "EncodingName", + "MediaStreamName" + ], + "type": "object" + }, + "VpcInterfaceAttachment": { + "additionalProperties": false, + "description": "The settings for attaching a VPC interface to an output.", + "properties": { + "VpcInterfaceName": { + "description": "The name of the VPC interface to use for this output.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::FlowOutput", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "mediaconnect:AddFlowOutputs" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:RemoveFlowOutput" + ] + }, + "list": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:UpdateFlowOutput" + ] + } + }, + "primaryIdentifier": [ + "/properties/OutputArn" + ], + "properties": { + "CidrAllowList": { + "description": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Description": { + "description": "A description of the output.", + "type": "string" + }, + "Destination": { + "description": "The address where you want to send the output.", + "type": "string" + }, + "Encryption": { + "$ref": "#/definitions/Encryption", + "description": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "FlowArn": { + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", + "type": "string" + }, + "MaxLatency": { + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "type": "integer" + }, + "MediaStreamOutputConfigurations": { + "description": "The definition for each media stream that is associated with the output.", + "items": { + "$ref": "#/definitions/MediaStreamOutputConfiguration" + }, + "type": "array" + }, + "MinLatency": { + "description": "The minimum latency in milliseconds.", + "type": "integer" + }, + "Name": { + "description": "The name of the output. This value must be unique within the current flow.", + "type": "string" + }, + "OutputArn": { + "description": "The ARN of the output.", + "type": "string" + }, + "OutputStatus": { + "description": "An indication of whether the output should transmit data or not.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Port": { + "description": "The port to use when content is distributed to this output.", + "type": "integer" + }, + "Protocol": { + "description": "The protocol that is used by the source or output.", + "enum": [ + "zixi-push", + "rtp-fec", + "rtp", + "zixi-pull", + "rist", + "fujitsu-qos", + "srt-listener", + "srt-caller", + "st2110-jpegxs", + "cdi" + ], + "type": "string" + }, + "RemoteId": { + "description": "The remote ID for the Zixi-pull stream.", + "type": "string" + }, + "SmoothingLatency": { + "description": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", + "type": "integer" + }, + "StreamId": { + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", + "type": "string" + }, + "VpcInterfaceAttachment": { + "$ref": "#/definitions/VpcInterfaceAttachment", + "description": "The name of the VPC interface attachment to use for this output." + } + }, + "readOnlyProperties": [ + "/properties/OutputArn" + ], + "required": [ + "FlowArn", + "Protocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "typeName": "AWS::MediaConnect::FlowOutput" +} diff --git a/schema/aws-mediaconnect-flowsource.json b/schema/aws-mediaconnect-flowsource.json index bad2d09..d2c71e6 100644 --- a/schema/aws-mediaconnect-flowsource.json +++ b/schema/aws-mediaconnect-flowsource.json @@ -1,235 +1,235 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Encryption": { - "additionalProperties": false, - "description": "Information about the encryption of the flow.", - "properties": { - "Algorithm": { - "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", - "enum": [ - "aes128", - "aes192", - "aes256" - ], - "type": "string" - }, - "ConstantInitializationVector": { - "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", - "type": "string" - }, - "DeviceId": { - "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "KeyType": { - "default": "static-key", - "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "enum": [ - "speke", - "static-key", - "srt-password" - ], - "type": "string" - }, - "Region": { - "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "ResourceId": { - "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", - "type": "string" - }, - "SecretArn": { - "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "type": "string" - }, - "Url": { - "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "GatewayBridgeSource": { - "additionalProperties": false, - "description": "The source configuration for cloud flows receiving a stream from a bridge.", - "properties": { - "BridgeArn": { - "description": "The ARN of the bridge feeding this flow.", - "type": "string" - }, - "VpcInterfaceAttachment": { - "$ref": "#/definitions/VpcInterfaceAttachment", - "description": "The name of the VPC interface attachment to use for this bridge source." - } - }, - "required": [ - "BridgeArn" - ], - "type": "object" - }, - "VpcInterfaceAttachment": { - "additionalProperties": false, - "description": "The settings for attaching a VPC interface to an resource.", - "properties": { - "VpcInterfaceName": { - "description": "The name of the VPC interface to use for this resource.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::FlowSource", - "handlers": { - "create": { - "permissions": [ - "mediaconnect:CreateFlow", - "mediaconnect:DescribeFlow", - "mediaconnect:AddFlowSources", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:RemoveFlowSource" - ] - }, - "list": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:UpdateFlowSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SourceArn" - ], - "properties": { - "Decryption": { - "$ref": "#/definitions/Encryption", - "description": "The type of encryption that is used on the content ingested from this source." - }, - "Description": { - "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "type": "string" - }, - "EntitlementArn": { - "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", - "type": "string" - }, - "FlowArn": { - "description": "The ARN of the flow.", - "type": "string" - }, - "GatewayBridgeSource": { - "$ref": "#/definitions/GatewayBridgeSource", - "description": "The source configuration for cloud flows receiving a stream from a bridge." - }, - "IngestIp": { - "description": "The IP address that the flow will be listening on for incoming content.", - "type": "string" - }, - "IngestPort": { - "description": "The port that the flow will be listening on for incoming content.", - "type": "integer" - }, - "MaxBitrate": { - "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", - "type": "integer" - }, - "MaxLatency": { - "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", - "type": "integer" - }, - "MinLatency": { - "description": "The minimum latency in milliseconds.", - "type": "integer" - }, - "Name": { - "description": "The name of the source.", - "type": "string" - }, - "Protocol": { - "description": "The protocol that is used by the source.", - "enum": [ - "zixi-push", - "rtp-fec", - "rtp", - "rist", - "srt-listener", - "srt-caller" - ], - "type": "string" - }, - "SenderControlPort": { - "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.", - "type": "integer" - }, - "SenderIpAddress": { - "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.", - "type": "string" - }, - "SourceArn": { - "description": "The ARN of the source.", - "type": "string" - }, - "SourceIngestPort": { - "description": "The port that the flow will be listening on for incoming content.(ReadOnly)", - "type": "string" - }, - "SourceListenerAddress": { - "description": "Source IP or domain name for SRT-caller protocol.", - "type": "string" - }, - "SourceListenerPort": { - "description": "Source port for SRT-caller protocol.", - "type": "integer" - }, - "StreamId": { - "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", - "type": "string" - }, - "VpcInterfaceName": { - "description": "The name of the VPC Interface this Source is configured with.", - "type": "string" - }, - "WhitelistCidr": { - "description": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IngestIp", - "/properties/SourceArn", - "/properties/SourceIngestPort" - ], - "required": [ - "Name", - "Description" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "typeName": "AWS::MediaConnect::FlowSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Encryption": { + "additionalProperties": false, + "description": "Information about the encryption of the flow.", + "properties": { + "Algorithm": { + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).", + "enum": [ + "aes128", + "aes192", + "aes256" + ], + "type": "string" + }, + "ConstantInitializationVector": { + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", + "type": "string" + }, + "DeviceId": { + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "KeyType": { + "default": "static-key", + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "enum": [ + "speke", + "static-key", + "srt-password" + ], + "type": "string" + }, + "Region": { + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "ResourceId": { + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", + "type": "string" + }, + "SecretArn": { + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "type": "string" + }, + "Url": { + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "GatewayBridgeSource": { + "additionalProperties": false, + "description": "The source configuration for cloud flows receiving a stream from a bridge.", + "properties": { + "BridgeArn": { + "description": "The ARN of the bridge feeding this flow.", + "type": "string" + }, + "VpcInterfaceAttachment": { + "$ref": "#/definitions/VpcInterfaceAttachment", + "description": "The name of the VPC interface attachment to use for this bridge source." + } + }, + "required": [ + "BridgeArn" + ], + "type": "object" + }, + "VpcInterfaceAttachment": { + "additionalProperties": false, + "description": "The settings for attaching a VPC interface to an resource.", + "properties": { + "VpcInterfaceName": { + "description": "The name of the VPC interface to use for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::FlowSource", + "handlers": { + "create": { + "permissions": [ + "mediaconnect:CreateFlow", + "mediaconnect:DescribeFlow", + "mediaconnect:AddFlowSources", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:RemoveFlowSource" + ] + }, + "list": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:UpdateFlowSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SourceArn" + ], + "properties": { + "Decryption": { + "$ref": "#/definitions/Encryption", + "description": "The type of encryption that is used on the content ingested from this source." + }, + "Description": { + "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "type": "string" + }, + "EntitlementArn": { + "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", + "type": "string" + }, + "FlowArn": { + "description": "The ARN of the flow.", + "type": "string" + }, + "GatewayBridgeSource": { + "$ref": "#/definitions/GatewayBridgeSource", + "description": "The source configuration for cloud flows receiving a stream from a bridge." + }, + "IngestIp": { + "description": "The IP address that the flow will be listening on for incoming content.", + "type": "string" + }, + "IngestPort": { + "description": "The port that the flow will be listening on for incoming content.", + "type": "integer" + }, + "MaxBitrate": { + "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", + "type": "integer" + }, + "MaxLatency": { + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "type": "integer" + }, + "MinLatency": { + "description": "The minimum latency in milliseconds.", + "type": "integer" + }, + "Name": { + "description": "The name of the source.", + "type": "string" + }, + "Protocol": { + "description": "The protocol that is used by the source.", + "enum": [ + "zixi-push", + "rtp-fec", + "rtp", + "rist", + "srt-listener", + "srt-caller" + ], + "type": "string" + }, + "SenderControlPort": { + "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.", + "type": "integer" + }, + "SenderIpAddress": { + "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.", + "type": "string" + }, + "SourceArn": { + "description": "The ARN of the source.", + "type": "string" + }, + "SourceIngestPort": { + "description": "The port that the flow will be listening on for incoming content.(ReadOnly)", + "type": "string" + }, + "SourceListenerAddress": { + "description": "Source IP or domain name for SRT-caller protocol.", + "type": "string" + }, + "SourceListenerPort": { + "description": "Source port for SRT-caller protocol.", + "type": "integer" + }, + "StreamId": { + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", + "type": "string" + }, + "VpcInterfaceName": { + "description": "The name of the VPC Interface this Source is configured with.", + "type": "string" + }, + "WhitelistCidr": { + "description": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IngestIp", + "/properties/SourceArn", + "/properties/SourceIngestPort" + ], + "required": [ + "Name", + "Description" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "typeName": "AWS::MediaConnect::FlowSource" +} diff --git a/schema/aws-mediaconnect-flowvpcinterface.json b/schema/aws-mediaconnect-flowvpcinterface.json index dd67e65..a83d38c 100644 --- a/schema/aws-mediaconnect-flowvpcinterface.json +++ b/schema/aws-mediaconnect-flowvpcinterface.json @@ -1,88 +1,88 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FlowArn", - "/properties/Name" - ], - "description": "Resource schema for AWS::MediaConnect::FlowVpcInterface", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "mediaconnect:DescribeFlow", - "mediaconnect:AddFlowVpcInterfaces" - ] - }, - "delete": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:RemoveFlowVpcInterface" - ] - }, - "list": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeFlow" - ] - }, - "update": { - "permissions": [ - "mediaconnect:DescribeFlow", - "mediaconnect:AddFlowVpcInterfaces", - "mediaconnect:RemoveFlowVpcInterface" - ] - } - }, - "primaryIdentifier": [ - "/properties/FlowArn", - "/properties/Name" - ], - "properties": { - "FlowArn": { - "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", - "type": "string" - }, - "Name": { - "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", - "type": "string" - }, - "NetworkInterfaceIds": { - "description": "IDs of the network interfaces created in customer's account by MediaConnect.", - "items": { - "type": "string" - }, - "type": "array" - }, - "RoleArn": { - "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", - "type": "string" - }, - "SecurityGroupIds": { - "description": "Security Group IDs to be used on ENI.", - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "description": "Subnet must be in the AZ of the Flow", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/NetworkInterfaceIds" - ], - "required": [ - "FlowArn", - "Name", - "RoleArn", - "SubnetId", - "SecurityGroupIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "typeName": "AWS::MediaConnect::FlowVpcInterface" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FlowArn", + "/properties/Name" + ], + "description": "Resource schema for AWS::MediaConnect::FlowVpcInterface", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "mediaconnect:DescribeFlow", + "mediaconnect:AddFlowVpcInterfaces" + ] + }, + "delete": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:RemoveFlowVpcInterface" + ] + }, + "list": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeFlow" + ] + }, + "update": { + "permissions": [ + "mediaconnect:DescribeFlow", + "mediaconnect:AddFlowVpcInterfaces", + "mediaconnect:RemoveFlowVpcInterface" + ] + } + }, + "primaryIdentifier": [ + "/properties/FlowArn", + "/properties/Name" + ], + "properties": { + "FlowArn": { + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", + "type": "string" + }, + "Name": { + "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", + "type": "string" + }, + "NetworkInterfaceIds": { + "description": "IDs of the network interfaces created in customer's account by MediaConnect.", + "items": { + "type": "string" + }, + "type": "array" + }, + "RoleArn": { + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "Security Group IDs to be used on ENI.", + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetId": { + "description": "Subnet must be in the AZ of the Flow", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/NetworkInterfaceIds" + ], + "required": [ + "FlowArn", + "Name", + "RoleArn", + "SubnetId", + "SecurityGroupIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "typeName": "AWS::MediaConnect::FlowVpcInterface" +} diff --git a/schema/aws-mediaconnect-gateway.json b/schema/aws-mediaconnect-gateway.json index b102cf6..1dbceeb 100644 --- a/schema/aws-mediaconnect-gateway.json +++ b/schema/aws-mediaconnect-gateway.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/EgressCidrBlocks", - "/properties/Networks" - ], - "definitions": { - "GatewayNetwork": { - "additionalProperties": false, - "description": "The network settings for a gateway.", - "properties": { - "CidrBlock": { - "description": "A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "type": "string" - }, - "Name": { - "description": "The name of the network. This name is used to reference the network and must be unique among networks in this gateway.", - "type": "string" - } - }, - "required": [ - "Name", - "CidrBlock" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaConnect::Gateway", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "mediaconnect:CreateGateway", - "mediaconnect:DescribeGateway" - ] - }, - "delete": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "mediaconnect:DescribeGateway", - "mediaconnect:DeleteGateway" - ] - }, - "list": { - "permissions": [ - "mediaconnect:ListGateways" - ] - }, - "read": { - "permissions": [ - "mediaconnect:DescribeGateway" - ] - } - }, - "primaryIdentifier": [ - "/properties/GatewayArn" - ], - "properties": { - "EgressCidrBlocks": { - "description": "The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array" - }, - "GatewayArn": { - "description": "The Amazon Resource Name (ARN) of the gateway.", - "type": "string" - }, - "GatewayState": { - "description": "The current status of the gateway.", - "enum": [ - "CREATING", - "ACTIVE", - "UPDATING", - "ERROR", - "DELETING", - "DELETED" - ], - "type": "string" - }, - "Name": { - "description": "The name of the gateway. This name can not be modified after the gateway is created.", - "type": "string" - }, - "Networks": { - "description": "The list of networks in the gateway.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/GatewayNetwork" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/GatewayArn", - "/properties/GatewayState" - ], - "required": [ - "Name", - "EgressCidrBlocks", - "Networks" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MediaConnect::Gateway" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/EgressCidrBlocks", + "/properties/Networks" + ], + "definitions": { + "GatewayNetwork": { + "additionalProperties": false, + "description": "The network settings for a gateway.", + "properties": { + "CidrBlock": { + "description": "A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "type": "string" + }, + "Name": { + "description": "The name of the network. This name is used to reference the network and must be unique among networks in this gateway.", + "type": "string" + } + }, + "required": [ + "Name", + "CidrBlock" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaConnect::Gateway", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "mediaconnect:CreateGateway", + "mediaconnect:DescribeGateway" + ] + }, + "delete": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "mediaconnect:DescribeGateway", + "mediaconnect:DeleteGateway" + ] + }, + "list": { + "permissions": [ + "mediaconnect:ListGateways" + ] + }, + "read": { + "permissions": [ + "mediaconnect:DescribeGateway" + ] + } + }, + "primaryIdentifier": [ + "/properties/GatewayArn" + ], + "properties": { + "EgressCidrBlocks": { + "description": "The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "GatewayArn": { + "description": "The Amazon Resource Name (ARN) of the gateway.", + "type": "string" + }, + "GatewayState": { + "description": "The current status of the gateway.", + "enum": [ + "CREATING", + "ACTIVE", + "UPDATING", + "ERROR", + "DELETING", + "DELETED" + ], + "type": "string" + }, + "Name": { + "description": "The name of the gateway. This name can not be modified after the gateway is created.", + "type": "string" + }, + "Networks": { + "description": "The list of networks in the gateway.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/GatewayNetwork" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/GatewayArn", + "/properties/GatewayState" + ], + "required": [ + "Name", + "EgressCidrBlocks", + "Networks" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MediaConnect::Gateway" +} diff --git a/schema/aws-mediaconvert-jobtemplate.json b/schema/aws-mediaconvert-jobtemplate.json index c4d2a2c..5be56f7 100644 --- a/schema/aws-mediaconvert-jobtemplate.json +++ b/schema/aws-mediaconvert-jobtemplate.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AccelerationSettings": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "HopDestination": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "integer" - }, - "Queue": { - "type": "string" - }, - "WaitMinutes": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MediaConvert::JobTemplate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccelerationSettings": { - "$ref": "#/definitions/AccelerationSettings" - }, - "Arn": { - "type": "string" - }, - "Category": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "HopDestinations": { - "items": { - "$ref": "#/definitions/HopDestination" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "integer" - }, - "Queue": { - "type": "string" - }, - "SettingsJson": { - "type": "object" - }, - "StatusUpdateInterval": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "SettingsJson" - ], - "typeName": "AWS::MediaConvert::JobTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AccelerationSettings": { + "additionalProperties": false, + "properties": { + "Mode": { + "type": "string" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "HopDestination": { + "additionalProperties": false, + "properties": { + "Priority": { + "type": "integer" + }, + "Queue": { + "type": "string" + }, + "WaitMinutes": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MediaConvert::JobTemplate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccelerationSettings": { + "$ref": "#/definitions/AccelerationSettings" + }, + "Arn": { + "type": "string" + }, + "Category": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "HopDestinations": { + "items": { + "$ref": "#/definitions/HopDestination" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Priority": { + "type": "integer" + }, + "Queue": { + "type": "string" + }, + "SettingsJson": { + "type": "object" + }, + "StatusUpdateInterval": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "SettingsJson" + ], + "typeName": "AWS::MediaConvert::JobTemplate" +} diff --git a/schema/aws-mediaconvert-preset.json b/schema/aws-mediaconvert-preset.json index e57b5ce..cf9402d 100644 --- a/schema/aws-mediaconvert-preset.json +++ b/schema/aws-mediaconvert-preset.json @@ -1,41 +1,41 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::MediaConvert::Preset", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Category": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SettingsJson": { - "type": "object" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "SettingsJson" - ], - "typeName": "AWS::MediaConvert::Preset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::MediaConvert::Preset", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Category": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SettingsJson": { + "type": "object" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "SettingsJson" + ], + "typeName": "AWS::MediaConvert::Preset" +} diff --git a/schema/aws-mediaconvert-queue.json b/schema/aws-mediaconvert-queue.json index 41f979d..f14f6bc 100644 --- a/schema/aws-mediaconvert-queue.json +++ b/schema/aws-mediaconvert-queue.json @@ -1,38 +1,38 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::MediaConvert::Queue", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "PricingPlan": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "typeName": "AWS::MediaConvert::Queue" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::MediaConvert::Queue", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "PricingPlan": { + "type": "string" + }, + "Status": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "typeName": "AWS::MediaConvert::Queue" +} diff --git a/schema/aws-medialive-channel.json b/schema/aws-medialive-channel.json index 1f31bd6..bb974d5 100644 --- a/schema/aws-medialive-channel.json +++ b/schema/aws-medialive-channel.json @@ -1,3271 +1,3271 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Vpc" - ], - "definitions": { - "AacSettings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "InputType": { - "type": "string" - }, - "Profile": { - "type": "string" - }, - "RateControlMode": { - "type": "string" - }, - "RawFormat": { - "type": "string" - }, - "SampleRate": { - "type": "number" - }, - "Spec": { - "type": "string" - }, - "VbrQuality": { - "type": "string" - } - }, - "type": "object" - }, - "Ac3Settings": { - "additionalProperties": false, - "properties": { - "AttenuationControl": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BitstreamMode": { - "type": "string" - }, - "CodingMode": { - "type": "string" - }, - "Dialnorm": { - "type": "integer" - }, - "DrcProfile": { - "type": "string" - }, - "LfeFilter": { - "type": "string" - }, - "MetadataControl": { - "type": "string" - } - }, - "type": "object" - }, - "AncillarySourceSettings": { - "additionalProperties": false, - "properties": { - "SourceAncillaryChannelNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "ArchiveCdnSettings": { - "additionalProperties": false, - "properties": { - "ArchiveS3Settings": { - "$ref": "#/definitions/ArchiveS3Settings" - } - }, - "type": "object" - }, - "ArchiveContainerSettings": { - "additionalProperties": false, - "properties": { - "M2tsSettings": { - "$ref": "#/definitions/M2tsSettings" - }, - "RawSettings": { - "$ref": "#/definitions/RawSettings" - } - }, - "type": "object" - }, - "ArchiveGroupSettings": { - "additionalProperties": false, - "properties": { - "ArchiveCdnSettings": { - "$ref": "#/definitions/ArchiveCdnSettings" - }, - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "RolloverInterval": { - "type": "integer" - } - }, - "type": "object" - }, - "ArchiveOutputSettings": { - "additionalProperties": false, - "properties": { - "ContainerSettings": { - "$ref": "#/definitions/ArchiveContainerSettings" - }, - "Extension": { - "type": "string" - }, - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "ArchiveS3Settings": { - "additionalProperties": false, - "properties": { - "CannedAcl": { - "type": "string" - } - }, - "type": "object" - }, - "AribDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "AribSourceSettings": { - "additionalProperties": false, - "type": "object" - }, - "AudioChannelMapping": { - "additionalProperties": false, - "properties": { - "InputChannelLevels": { - "items": { - "$ref": "#/definitions/InputChannelLevel" - }, - "type": "array", - "uniqueItems": false - }, - "OutputChannel": { - "type": "integer" - } - }, - "type": "object" - }, - "AudioCodecSettings": { - "additionalProperties": false, - "properties": { - "AacSettings": { - "$ref": "#/definitions/AacSettings" - }, - "Ac3Settings": { - "$ref": "#/definitions/Ac3Settings" - }, - "Eac3AtmosSettings": { - "$ref": "#/definitions/Eac3AtmosSettings" - }, - "Eac3Settings": { - "$ref": "#/definitions/Eac3Settings" - }, - "Mp2Settings": { - "$ref": "#/definitions/Mp2Settings" - }, - "PassThroughSettings": { - "$ref": "#/definitions/PassThroughSettings" - }, - "WavSettings": { - "$ref": "#/definitions/WavSettings" - } - }, - "type": "object" - }, - "AudioDescription": { - "additionalProperties": false, - "properties": { - "AudioDashRoles": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AudioNormalizationSettings": { - "$ref": "#/definitions/AudioNormalizationSettings" - }, - "AudioSelectorName": { - "type": "string" - }, - "AudioType": { - "type": "string" - }, - "AudioTypeControl": { - "type": "string" - }, - "AudioWatermarkingSettings": { - "$ref": "#/definitions/AudioWatermarkSettings" - }, - "CodecSettings": { - "$ref": "#/definitions/AudioCodecSettings" - }, - "DvbDashAccessibility": { - "type": "string" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageCodeControl": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RemixSettings": { - "$ref": "#/definitions/RemixSettings" - }, - "StreamName": { - "type": "string" - } - }, - "type": "object" - }, - "AudioDolbyEDecode": { - "additionalProperties": false, - "properties": { - "ProgramSelection": { - "type": "string" - } - }, - "type": "object" - }, - "AudioHlsRenditionSelection": { - "additionalProperties": false, - "properties": { - "GroupId": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AudioLanguageSelection": { - "additionalProperties": false, - "properties": { - "LanguageCode": { - "type": "string" - }, - "LanguageSelectionPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AudioNormalizationSettings": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "AlgorithmControl": { - "type": "string" - }, - "TargetLkfs": { - "type": "number" - } - }, - "type": "object" - }, - "AudioOnlyHlsSettings": { - "additionalProperties": false, - "properties": { - "AudioGroupId": { - "type": "string" - }, - "AudioOnlyImage": { - "$ref": "#/definitions/InputLocation" - }, - "AudioTrackType": { - "type": "string" - }, - "SegmentType": { - "type": "string" - } - }, - "type": "object" - }, - "AudioPidSelection": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "integer" - } - }, - "type": "object" - }, - "AudioSelector": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/AudioSelectorSettings" - } - }, - "type": "object" - }, - "AudioSelectorSettings": { - "additionalProperties": false, - "properties": { - "AudioHlsRenditionSelection": { - "$ref": "#/definitions/AudioHlsRenditionSelection" - }, - "AudioLanguageSelection": { - "$ref": "#/definitions/AudioLanguageSelection" - }, - "AudioPidSelection": { - "$ref": "#/definitions/AudioPidSelection" - }, - "AudioTrackSelection": { - "$ref": "#/definitions/AudioTrackSelection" - } - }, - "type": "object" - }, - "AudioSilenceFailoverSettings": { - "additionalProperties": false, - "properties": { - "AudioSelectorName": { - "type": "string" - }, - "AudioSilenceThresholdMsec": { - "type": "integer" - } - }, - "type": "object" - }, - "AudioTrack": { - "additionalProperties": false, - "properties": { - "Track": { - "type": "integer" - } - }, - "type": "object" - }, - "AudioTrackSelection": { - "additionalProperties": false, - "properties": { - "DolbyEDecode": { - "$ref": "#/definitions/AudioDolbyEDecode" - }, - "Tracks": { - "items": { - "$ref": "#/definitions/AudioTrack" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "AudioWatermarkSettings": { - "additionalProperties": false, - "properties": { - "NielsenWatermarksSettings": { - "$ref": "#/definitions/NielsenWatermarksSettings" - } - }, - "type": "object" - }, - "AutomaticInputFailoverSettings": { - "additionalProperties": false, - "properties": { - "ErrorClearTimeMsec": { - "type": "integer" - }, - "FailoverConditions": { - "items": { - "$ref": "#/definitions/FailoverCondition" - }, - "type": "array", - "uniqueItems": false - }, - "InputPreference": { - "type": "string" - }, - "SecondaryInputId": { - "type": "string" - } - }, - "type": "object" - }, - "AvailBlanking": { - "additionalProperties": false, - "properties": { - "AvailBlankingImage": { - "$ref": "#/definitions/InputLocation" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "AvailConfiguration": { - "additionalProperties": false, - "properties": { - "AvailSettings": { - "$ref": "#/definitions/AvailSettings" - }, - "Scte35SegmentationScope": { - "type": "string" - } - }, - "type": "object" - }, - "AvailSettings": { - "additionalProperties": false, - "properties": { - "Esam": { - "$ref": "#/definitions/Esam" - }, - "Scte35SpliceInsert": { - "$ref": "#/definitions/Scte35SpliceInsert" - }, - "Scte35TimeSignalApos": { - "$ref": "#/definitions/Scte35TimeSignalApos" - } - }, - "type": "object" - }, - "BlackoutSlate": { - "additionalProperties": false, - "properties": { - "BlackoutSlateImage": { - "$ref": "#/definitions/InputLocation" - }, - "NetworkEndBlackout": { - "type": "string" - }, - "NetworkEndBlackoutImage": { - "$ref": "#/definitions/InputLocation" - }, - "NetworkId": { - "type": "string" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "BurnInDestinationSettings": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "BackgroundColor": { - "type": "string" - }, - "BackgroundOpacity": { - "type": "integer" - }, - "Font": { - "$ref": "#/definitions/InputLocation" - }, - "FontColor": { - "type": "string" - }, - "FontOpacity": { - "type": "integer" - }, - "FontResolution": { - "type": "integer" - }, - "FontSize": { - "type": "string" - }, - "OutlineColor": { - "type": "string" - }, - "OutlineSize": { - "type": "integer" - }, - "ShadowColor": { - "type": "string" - }, - "ShadowOpacity": { - "type": "integer" - }, - "ShadowXOffset": { - "type": "integer" - }, - "ShadowYOffset": { - "type": "integer" - }, - "TeletextGridControl": { - "type": "string" - }, - "XPosition": { - "type": "integer" - }, - "YPosition": { - "type": "integer" - } - }, - "type": "object" - }, - "CaptionDescription": { - "additionalProperties": false, - "properties": { - "Accessibility": { - "type": "string" - }, - "CaptionDashRoles": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CaptionSelectorName": { - "type": "string" - }, - "DestinationSettings": { - "$ref": "#/definitions/CaptionDestinationSettings" - }, - "DvbDashAccessibility": { - "type": "string" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageDescription": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "CaptionDestinationSettings": { - "additionalProperties": false, - "properties": { - "AribDestinationSettings": { - "$ref": "#/definitions/AribDestinationSettings" - }, - "BurnInDestinationSettings": { - "$ref": "#/definitions/BurnInDestinationSettings" - }, - "DvbSubDestinationSettings": { - "$ref": "#/definitions/DvbSubDestinationSettings" - }, - "EbuTtDDestinationSettings": { - "$ref": "#/definitions/EbuTtDDestinationSettings" - }, - "EmbeddedDestinationSettings": { - "$ref": "#/definitions/EmbeddedDestinationSettings" - }, - "EmbeddedPlusScte20DestinationSettings": { - "$ref": "#/definitions/EmbeddedPlusScte20DestinationSettings" - }, - "RtmpCaptionInfoDestinationSettings": { - "$ref": "#/definitions/RtmpCaptionInfoDestinationSettings" - }, - "Scte20PlusEmbeddedDestinationSettings": { - "$ref": "#/definitions/Scte20PlusEmbeddedDestinationSettings" - }, - "Scte27DestinationSettings": { - "$ref": "#/definitions/Scte27DestinationSettings" - }, - "SmpteTtDestinationSettings": { - "$ref": "#/definitions/SmpteTtDestinationSettings" - }, - "TeletextDestinationSettings": { - "$ref": "#/definitions/TeletextDestinationSettings" - }, - "TtmlDestinationSettings": { - "$ref": "#/definitions/TtmlDestinationSettings" - }, - "WebvttDestinationSettings": { - "$ref": "#/definitions/WebvttDestinationSettings" - } - }, - "type": "object" - }, - "CaptionLanguageMapping": { - "additionalProperties": false, - "properties": { - "CaptionChannel": { - "type": "integer" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageDescription": { - "type": "string" - } - }, - "type": "object" - }, - "CaptionRectangle": { - "additionalProperties": false, - "properties": { - "Height": { - "type": "number" - }, - "LeftOffset": { - "type": "number" - }, - "TopOffset": { - "type": "number" - }, - "Width": { - "type": "number" - } - }, - "type": "object" - }, - "CaptionSelector": { - "additionalProperties": false, - "properties": { - "LanguageCode": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/CaptionSelectorSettings" - } - }, - "type": "object" - }, - "CaptionSelectorSettings": { - "additionalProperties": false, - "properties": { - "AncillarySourceSettings": { - "$ref": "#/definitions/AncillarySourceSettings" - }, - "AribSourceSettings": { - "$ref": "#/definitions/AribSourceSettings" - }, - "DvbSubSourceSettings": { - "$ref": "#/definitions/DvbSubSourceSettings" - }, - "EmbeddedSourceSettings": { - "$ref": "#/definitions/EmbeddedSourceSettings" - }, - "Scte20SourceSettings": { - "$ref": "#/definitions/Scte20SourceSettings" - }, - "Scte27SourceSettings": { - "$ref": "#/definitions/Scte27SourceSettings" - }, - "TeletextSourceSettings": { - "$ref": "#/definitions/TeletextSourceSettings" - } - }, - "type": "object" - }, - "CdiInputSpecification": { - "additionalProperties": false, - "properties": { - "Resolution": { - "type": "string" - } - }, - "type": "object" - }, - "CmafIngestGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "Scte35Type": { - "type": "string" - }, - "SegmentLength": { - "type": "integer" - }, - "SegmentLengthUnits": { - "type": "string" - }, - "SendDelayMs": { - "type": "integer" - } - }, - "type": "object" - }, - "CmafIngestOutputSettings": { - "additionalProperties": false, - "properties": { - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "ColorCorrection": { - "additionalProperties": false, - "properties": { - "InputColorSpace": { - "type": "string" - }, - "OutputColorSpace": { - "type": "string" - }, - "Uri": { - "type": "string" - } - }, - "type": "object" - }, - "ColorCorrectionSettings": { - "additionalProperties": false, - "properties": { - "GlobalColorCorrections": { - "items": { - "$ref": "#/definitions/ColorCorrection" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "ColorSpacePassthroughSettings": { - "additionalProperties": false, - "type": "object" - }, - "DolbyVision81Settings": { - "additionalProperties": false, - "type": "object" - }, - "DvbNitSettings": { - "additionalProperties": false, - "properties": { - "NetworkId": { - "type": "integer" - }, - "NetworkName": { - "type": "string" - }, - "RepInterval": { - "type": "integer" - } - }, - "type": "object" - }, - "DvbSdtSettings": { - "additionalProperties": false, - "properties": { - "OutputSdt": { - "type": "string" - }, - "RepInterval": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - }, - "ServiceProviderName": { - "type": "string" - } - }, - "type": "object" - }, - "DvbSubDestinationSettings": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "BackgroundColor": { - "type": "string" - }, - "BackgroundOpacity": { - "type": "integer" - }, - "Font": { - "$ref": "#/definitions/InputLocation" - }, - "FontColor": { - "type": "string" - }, - "FontOpacity": { - "type": "integer" - }, - "FontResolution": { - "type": "integer" - }, - "FontSize": { - "type": "string" - }, - "OutlineColor": { - "type": "string" - }, - "OutlineSize": { - "type": "integer" - }, - "ShadowColor": { - "type": "string" - }, - "ShadowOpacity": { - "type": "integer" - }, - "ShadowXOffset": { - "type": "integer" - }, - "ShadowYOffset": { - "type": "integer" - }, - "TeletextGridControl": { - "type": "string" - }, - "XPosition": { - "type": "integer" - }, - "YPosition": { - "type": "integer" - } - }, - "type": "object" - }, - "DvbSubSourceSettings": { - "additionalProperties": false, - "properties": { - "OcrLanguage": { - "type": "string" - }, - "Pid": { - "type": "integer" - } - }, - "type": "object" - }, - "DvbTdtSettings": { - "additionalProperties": false, - "properties": { - "RepInterval": { - "type": "integer" - } - }, - "type": "object" - }, - "Eac3AtmosSettings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "Dialnorm": { - "type": "integer" - }, - "DrcLine": { - "type": "string" - }, - "DrcRf": { - "type": "string" - }, - "HeightTrim": { - "type": "number" - }, - "SurroundTrim": { - "type": "number" - } - }, - "type": "object" - }, - "Eac3Settings": { - "additionalProperties": false, - "properties": { - "AttenuationControl": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BitstreamMode": { - "type": "string" - }, - "CodingMode": { - "type": "string" - }, - "DcFilter": { - "type": "string" - }, - "Dialnorm": { - "type": "integer" - }, - "DrcLine": { - "type": "string" - }, - "DrcRf": { - "type": "string" - }, - "LfeControl": { - "type": "string" - }, - "LfeFilter": { - "type": "string" - }, - "LoRoCenterMixLevel": { - "type": "number" - }, - "LoRoSurroundMixLevel": { - "type": "number" - }, - "LtRtCenterMixLevel": { - "type": "number" - }, - "LtRtSurroundMixLevel": { - "type": "number" - }, - "MetadataControl": { - "type": "string" - }, - "PassthroughControl": { - "type": "string" - }, - "PhaseControl": { - "type": "string" - }, - "StereoDownmix": { - "type": "string" - }, - "SurroundExMode": { - "type": "string" - }, - "SurroundMode": { - "type": "string" - } - }, - "type": "object" - }, - "EbuTtDDestinationSettings": { - "additionalProperties": false, - "properties": { - "CopyrightHolder": { - "type": "string" - }, - "FillLineGap": { - "type": "string" - }, - "FontFamily": { - "type": "string" - }, - "StyleControl": { - "type": "string" - } - }, - "type": "object" - }, - "EmbeddedDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "EmbeddedPlusScte20DestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "EmbeddedSourceSettings": { - "additionalProperties": false, - "properties": { - "Convert608To708": { - "type": "string" - }, - "Scte20Detection": { - "type": "string" - }, - "Source608ChannelNumber": { - "type": "integer" - }, - "Source608TrackNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "EncoderSettings": { - "additionalProperties": false, - "properties": { - "AudioDescriptions": { - "items": { - "$ref": "#/definitions/AudioDescription" - }, - "type": "array", - "uniqueItems": false - }, - "AvailBlanking": { - "$ref": "#/definitions/AvailBlanking" - }, - "AvailConfiguration": { - "$ref": "#/definitions/AvailConfiguration" - }, - "BlackoutSlate": { - "$ref": "#/definitions/BlackoutSlate" - }, - "CaptionDescriptions": { - "items": { - "$ref": "#/definitions/CaptionDescription" - }, - "type": "array", - "uniqueItems": false - }, - "ColorCorrectionSettings": { - "$ref": "#/definitions/ColorCorrectionSettings" - }, - "FeatureActivations": { - "$ref": "#/definitions/FeatureActivations" - }, - "GlobalConfiguration": { - "$ref": "#/definitions/GlobalConfiguration" - }, - "MotionGraphicsConfiguration": { - "$ref": "#/definitions/MotionGraphicsConfiguration" - }, - "NielsenConfiguration": { - "$ref": "#/definitions/NielsenConfiguration" - }, - "OutputGroups": { - "items": { - "$ref": "#/definitions/OutputGroup" - }, - "type": "array", - "uniqueItems": false - }, - "ThumbnailConfiguration": { - "$ref": "#/definitions/ThumbnailConfiguration" - }, - "TimecodeConfig": { - "$ref": "#/definitions/TimecodeConfig" - }, - "VideoDescriptions": { - "items": { - "$ref": "#/definitions/VideoDescription" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EpochLockingSettings": { - "additionalProperties": false, - "properties": { - "CustomEpoch": { - "type": "string" - }, - "JamSyncTime": { - "type": "string" - } - }, - "type": "object" - }, - "Esam": { - "additionalProperties": false, - "properties": { - "AcquisitionPointId": { - "type": "string" - }, - "AdAvailOffset": { - "type": "integer" - }, - "PasswordParam": { - "type": "string" - }, - "PoisEndpoint": { - "type": "string" - }, - "Username": { - "type": "string" - }, - "ZoneIdentity": { - "type": "string" - } - }, - "type": "object" - }, - "FailoverCondition": { - "additionalProperties": false, - "properties": { - "FailoverConditionSettings": { - "$ref": "#/definitions/FailoverConditionSettings" - } - }, - "type": "object" - }, - "FailoverConditionSettings": { - "additionalProperties": false, - "properties": { - "AudioSilenceSettings": { - "$ref": "#/definitions/AudioSilenceFailoverSettings" - }, - "InputLossSettings": { - "$ref": "#/definitions/InputLossFailoverSettings" - }, - "VideoBlackSettings": { - "$ref": "#/definitions/VideoBlackFailoverSettings" - } - }, - "type": "object" - }, - "FeatureActivations": { - "additionalProperties": false, - "properties": { - "InputPrepareScheduleActions": { - "type": "string" - }, - "OutputStaticImageOverlayScheduleActions": { - "type": "string" - } - }, - "type": "object" - }, - "FecOutputSettings": { - "additionalProperties": false, - "properties": { - "ColumnDepth": { - "type": "integer" - }, - "IncludeFec": { - "type": "string" - }, - "RowLength": { - "type": "integer" - } - }, - "type": "object" - }, - "Fmp4HlsSettings": { - "additionalProperties": false, - "properties": { - "AudioRenditionSets": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "TimedMetadataBehavior": { - "type": "string" - } - }, - "type": "object" - }, - "FrameCaptureCdnSettings": { - "additionalProperties": false, - "properties": { - "FrameCaptureS3Settings": { - "$ref": "#/definitions/FrameCaptureS3Settings" - } - }, - "type": "object" - }, - "FrameCaptureGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "FrameCaptureCdnSettings": { - "$ref": "#/definitions/FrameCaptureCdnSettings" - } - }, - "type": "object" - }, - "FrameCaptureHlsSettings": { - "additionalProperties": false, - "type": "object" - }, - "FrameCaptureOutputSettings": { - "additionalProperties": false, - "properties": { - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "FrameCaptureS3Settings": { - "additionalProperties": false, - "properties": { - "CannedAcl": { - "type": "string" - } - }, - "type": "object" - }, - "FrameCaptureSettings": { - "additionalProperties": false, - "properties": { - "CaptureInterval": { - "type": "integer" - }, - "CaptureIntervalUnits": { - "type": "string" - }, - "TimecodeBurninSettings": { - "$ref": "#/definitions/TimecodeBurninSettings" - } - }, - "type": "object" - }, - "GlobalConfiguration": { - "additionalProperties": false, - "properties": { - "InitialAudioGain": { - "type": "integer" - }, - "InputEndAction": { - "type": "string" - }, - "InputLossBehavior": { - "$ref": "#/definitions/InputLossBehavior" - }, - "OutputLockingMode": { - "type": "string" - }, - "OutputLockingSettings": { - "$ref": "#/definitions/OutputLockingSettings" - }, - "OutputTimingSource": { - "type": "string" - }, - "SupportLowFramerateInputs": { - "type": "string" - } - }, - "type": "object" - }, - "H264ColorSpaceSettings": { - "additionalProperties": false, - "properties": { - "ColorSpacePassthroughSettings": { - "$ref": "#/definitions/ColorSpacePassthroughSettings" - }, - "Rec601Settings": { - "$ref": "#/definitions/Rec601Settings" - }, - "Rec709Settings": { - "$ref": "#/definitions/Rec709Settings" - } - }, - "type": "object" - }, - "H264FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/TemporalFilterSettings" - } - }, - "type": "object" - }, - "H264Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "Bitrate": { - "type": "integer" - }, - "BufFillPct": { - "type": "integer" - }, - "BufSize": { - "type": "integer" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpaceSettings": { - "$ref": "#/definitions/H264ColorSpaceSettings" - }, - "EntropyEncoding": { - "type": "string" - }, - "FilterSettings": { - "$ref": "#/definitions/H264FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FlickerAq": { - "type": "string" - }, - "ForceFieldPictures": { - "type": "string" - }, - "FramerateControl": { - "type": "string" - }, - "FramerateDenominator": { - "type": "integer" - }, - "FramerateNumerator": { - "type": "integer" - }, - "GopBReference": { - "type": "string" - }, - "GopClosedCadence": { - "type": "integer" - }, - "GopNumBFrames": { - "type": "integer" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "LookAheadRateControl": { - "type": "string" - }, - "MaxBitrate": { - "type": "integer" - }, - "MinIInterval": { - "type": "integer" - }, - "NumRefFrames": { - "type": "integer" - }, - "ParControl": { - "type": "string" - }, - "ParDenominator": { - "type": "integer" - }, - "ParNumerator": { - "type": "integer" - }, - "Profile": { - "type": "string" - }, - "QualityLevel": { - "type": "string" - }, - "QvbrQualityLevel": { - "type": "integer" - }, - "RateControlMode": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SceneChangeDetect": { - "type": "string" - }, - "Slices": { - "type": "integer" - }, - "Softness": { - "type": "integer" - }, - "SpatialAq": { - "type": "string" - }, - "SubgopLength": { - "type": "string" - }, - "Syntax": { - "type": "string" - }, - "TemporalAq": { - "type": "string" - }, - "TimecodeBurninSettings": { - "$ref": "#/definitions/TimecodeBurninSettings" - }, - "TimecodeInsertion": { - "type": "string" - } - }, - "type": "object" - }, - "H265ColorSpaceSettings": { - "additionalProperties": false, - "properties": { - "ColorSpacePassthroughSettings": { - "$ref": "#/definitions/ColorSpacePassthroughSettings" - }, - "DolbyVision81Settings": { - "$ref": "#/definitions/DolbyVision81Settings" - }, - "Hdr10Settings": { - "$ref": "#/definitions/Hdr10Settings" - }, - "Rec601Settings": { - "$ref": "#/definitions/Rec601Settings" - }, - "Rec709Settings": { - "$ref": "#/definitions/Rec709Settings" - } - }, - "type": "object" - }, - "H265FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/TemporalFilterSettings" - } - }, - "type": "object" - }, - "H265Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "AlternativeTransferFunction": { - "type": "string" - }, - "Bitrate": { - "type": "integer" - }, - "BufSize": { - "type": "integer" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpaceSettings": { - "$ref": "#/definitions/H265ColorSpaceSettings" - }, - "FilterSettings": { - "$ref": "#/definitions/H265FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FlickerAq": { - "type": "string" - }, - "FramerateDenominator": { - "type": "integer" - }, - "FramerateNumerator": { - "type": "integer" - }, - "GopClosedCadence": { - "type": "integer" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "LookAheadRateControl": { - "type": "string" - }, - "MaxBitrate": { - "type": "integer" - }, - "MinIInterval": { - "type": "integer" - }, - "MvOverPictureBoundaries": { - "type": "string" - }, - "MvTemporalPredictor": { - "type": "string" - }, - "ParDenominator": { - "type": "integer" - }, - "ParNumerator": { - "type": "integer" - }, - "Profile": { - "type": "string" - }, - "QvbrQualityLevel": { - "type": "integer" - }, - "RateControlMode": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SceneChangeDetect": { - "type": "string" - }, - "Slices": { - "type": "integer" - }, - "Tier": { - "type": "string" - }, - "TileHeight": { - "type": "integer" - }, - "TilePadding": { - "type": "string" - }, - "TileWidth": { - "type": "integer" - }, - "TimecodeBurninSettings": { - "$ref": "#/definitions/TimecodeBurninSettings" - }, - "TimecodeInsertion": { - "type": "string" - }, - "TreeblockSize": { - "type": "string" - } - }, - "type": "object" - }, - "Hdr10Settings": { - "additionalProperties": false, - "properties": { - "MaxCll": { - "type": "integer" - }, - "MaxFall": { - "type": "integer" - } - }, - "type": "object" - }, - "HlsAkamaiSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "integer" - }, - "FilecacheDuration": { - "type": "integer" - }, - "HttpTransferMode": { - "type": "string" - }, - "NumRetries": { - "type": "integer" - }, - "RestartDelay": { - "type": "integer" - }, - "Salt": { - "type": "string" - }, - "Token": { - "type": "string" - } - }, - "type": "object" - }, - "HlsBasicPutSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "integer" - }, - "FilecacheDuration": { - "type": "integer" - }, - "NumRetries": { - "type": "integer" - }, - "RestartDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "HlsCdnSettings": { - "additionalProperties": false, - "properties": { - "HlsAkamaiSettings": { - "$ref": "#/definitions/HlsAkamaiSettings" - }, - "HlsBasicPutSettings": { - "$ref": "#/definitions/HlsBasicPutSettings" - }, - "HlsMediaStoreSettings": { - "$ref": "#/definitions/HlsMediaStoreSettings" - }, - "HlsS3Settings": { - "$ref": "#/definitions/HlsS3Settings" - }, - "HlsWebdavSettings": { - "$ref": "#/definitions/HlsWebdavSettings" - } - }, - "type": "object" - }, - "HlsGroupSettings": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "BaseUrlContent": { - "type": "string" - }, - "BaseUrlContent1": { - "type": "string" - }, - "BaseUrlManifest": { - "type": "string" - }, - "BaseUrlManifest1": { - "type": "string" - }, - "CaptionLanguageMappings": { - "items": { - "$ref": "#/definitions/CaptionLanguageMapping" - }, - "type": "array", - "uniqueItems": false - }, - "CaptionLanguageSetting": { - "type": "string" - }, - "ClientCache": { - "type": "string" - }, - "CodecSpecification": { - "type": "string" - }, - "ConstantIv": { - "type": "string" - }, - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "DirectoryStructure": { - "type": "string" - }, - "DiscontinuityTags": { - "type": "string" - }, - "EncryptionType": { - "type": "string" - }, - "HlsCdnSettings": { - "$ref": "#/definitions/HlsCdnSettings" - }, - "HlsId3SegmentTagging": { - "type": "string" - }, - "IFrameOnlyPlaylists": { - "type": "string" - }, - "IncompleteSegmentBehavior": { - "type": "string" - }, - "IndexNSegments": { - "type": "integer" - }, - "InputLossAction": { - "type": "string" - }, - "IvInManifest": { - "type": "string" - }, - "IvSource": { - "type": "string" - }, - "KeepSegments": { - "type": "integer" - }, - "KeyFormat": { - "type": "string" - }, - "KeyFormatVersions": { - "type": "string" - }, - "KeyProviderSettings": { - "$ref": "#/definitions/KeyProviderSettings" - }, - "ManifestCompression": { - "type": "string" - }, - "ManifestDurationFormat": { - "type": "string" - }, - "MinSegmentLength": { - "type": "integer" - }, - "Mode": { - "type": "string" - }, - "OutputSelection": { - "type": "string" - }, - "ProgramDateTime": { - "type": "string" - }, - "ProgramDateTimeClock": { - "type": "string" - }, - "ProgramDateTimePeriod": { - "type": "integer" - }, - "RedundantManifest": { - "type": "string" - }, - "SegmentLength": { - "type": "integer" - }, - "SegmentationMode": { - "type": "string" - }, - "SegmentsPerSubdirectory": { - "type": "integer" - }, - "StreamInfResolution": { - "type": "string" - }, - "TimedMetadataId3Frame": { - "type": "string" - }, - "TimedMetadataId3Period": { - "type": "integer" - }, - "TimestampDeltaMilliseconds": { - "type": "integer" - }, - "TsFileMode": { - "type": "string" - } - }, - "type": "object" - }, - "HlsInputSettings": { - "additionalProperties": false, - "properties": { - "Bandwidth": { - "type": "integer" - }, - "BufferSegments": { - "type": "integer" - }, - "Retries": { - "type": "integer" - }, - "RetryInterval": { - "type": "integer" - }, - "Scte35Source": { - "type": "string" - } - }, - "type": "object" - }, - "HlsMediaStoreSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "integer" - }, - "FilecacheDuration": { - "type": "integer" - }, - "MediaStoreStorageClass": { - "type": "string" - }, - "NumRetries": { - "type": "integer" - }, - "RestartDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "HlsOutputSettings": { - "additionalProperties": false, - "properties": { - "H265PackagingType": { - "type": "string" - }, - "HlsSettings": { - "$ref": "#/definitions/HlsSettings" - }, - "NameModifier": { - "type": "string" - }, - "SegmentModifier": { - "type": "string" - } - }, - "type": "object" - }, - "HlsS3Settings": { - "additionalProperties": false, - "properties": { - "CannedAcl": { - "type": "string" - } - }, - "type": "object" - }, - "HlsSettings": { - "additionalProperties": false, - "properties": { - "AudioOnlyHlsSettings": { - "$ref": "#/definitions/AudioOnlyHlsSettings" - }, - "Fmp4HlsSettings": { - "$ref": "#/definitions/Fmp4HlsSettings" - }, - "FrameCaptureHlsSettings": { - "$ref": "#/definitions/FrameCaptureHlsSettings" - }, - "StandardHlsSettings": { - "$ref": "#/definitions/StandardHlsSettings" - } - }, - "type": "object" - }, - "HlsWebdavSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "integer" - }, - "FilecacheDuration": { - "type": "integer" - }, - "HttpTransferMode": { - "type": "string" - }, - "NumRetries": { - "type": "integer" - }, - "RestartDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "HtmlMotionGraphicsSettings": { - "additionalProperties": false, - "type": "object" - }, - "InputAttachment": { - "additionalProperties": false, - "properties": { - "AutomaticInputFailoverSettings": { - "$ref": "#/definitions/AutomaticInputFailoverSettings" - }, - "InputAttachmentName": { - "type": "string" - }, - "InputId": { - "type": "string" - }, - "InputSettings": { - "$ref": "#/definitions/InputSettings" - } - }, - "type": "object" - }, - "InputChannelLevel": { - "additionalProperties": false, - "properties": { - "Gain": { - "type": "integer" - }, - "InputChannel": { - "type": "integer" - } - }, - "type": "object" - }, - "InputLocation": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "Uri": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "InputLossBehavior": { - "additionalProperties": false, - "properties": { - "BlackFrameMsec": { - "type": "integer" - }, - "InputLossImageColor": { - "type": "string" - }, - "InputLossImageSlate": { - "$ref": "#/definitions/InputLocation" - }, - "InputLossImageType": { - "type": "string" - }, - "RepeatFrameMsec": { - "type": "integer" - } - }, - "type": "object" - }, - "InputLossFailoverSettings": { - "additionalProperties": false, - "properties": { - "InputLossThresholdMsec": { - "type": "integer" - } - }, - "type": "object" - }, - "InputSettings": { - "additionalProperties": false, - "properties": { - "AudioSelectors": { - "items": { - "$ref": "#/definitions/AudioSelector" - }, - "type": "array", - "uniqueItems": false - }, - "CaptionSelectors": { - "items": { - "$ref": "#/definitions/CaptionSelector" - }, - "type": "array", - "uniqueItems": false - }, - "DeblockFilter": { - "type": "string" - }, - "DenoiseFilter": { - "type": "string" - }, - "FilterStrength": { - "type": "integer" - }, - "InputFilter": { - "type": "string" - }, - "NetworkInputSettings": { - "$ref": "#/definitions/NetworkInputSettings" - }, - "Scte35Pid": { - "type": "integer" - }, - "Smpte2038DataPreference": { - "type": "string" - }, - "SourceEndBehavior": { - "type": "string" - }, - "VideoSelector": { - "$ref": "#/definitions/VideoSelector" - } - }, - "type": "object" - }, - "InputSpecification": { - "additionalProperties": false, - "properties": { - "Codec": { - "type": "string" - }, - "MaximumBitrate": { - "type": "string" - }, - "Resolution": { - "type": "string" - } - }, - "type": "object" - }, - "KeyProviderSettings": { - "additionalProperties": false, - "properties": { - "StaticKeySettings": { - "$ref": "#/definitions/StaticKeySettings" - } - }, - "type": "object" - }, - "M2tsSettings": { - "additionalProperties": false, - "properties": { - "AbsentInputAudioBehavior": { - "type": "string" - }, - "Arib": { - "type": "string" - }, - "AribCaptionsPid": { - "type": "string" - }, - "AribCaptionsPidControl": { - "type": "string" - }, - "AudioBufferModel": { - "type": "string" - }, - "AudioFramesPerPes": { - "type": "integer" - }, - "AudioPids": { - "type": "string" - }, - "AudioStreamType": { - "type": "string" - }, - "Bitrate": { - "type": "integer" - }, - "BufferModel": { - "type": "string" - }, - "CcDescriptor": { - "type": "string" - }, - "DvbNitSettings": { - "$ref": "#/definitions/DvbNitSettings" - }, - "DvbSdtSettings": { - "$ref": "#/definitions/DvbSdtSettings" - }, - "DvbSubPids": { - "type": "string" - }, - "DvbTdtSettings": { - "$ref": "#/definitions/DvbTdtSettings" - }, - "DvbTeletextPid": { - "type": "string" - }, - "Ebif": { - "type": "string" - }, - "EbpAudioInterval": { - "type": "string" - }, - "EbpLookaheadMs": { - "type": "integer" - }, - "EbpPlacement": { - "type": "string" - }, - "EcmPid": { - "type": "string" - }, - "EsRateInPes": { - "type": "string" - }, - "EtvPlatformPid": { - "type": "string" - }, - "EtvSignalPid": { - "type": "string" - }, - "FragmentTime": { - "type": "number" - }, - "Klv": { - "type": "string" - }, - "KlvDataPids": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "NullPacketBitrate": { - "type": "number" - }, - "PatInterval": { - "type": "integer" - }, - "PcrControl": { - "type": "string" - }, - "PcrPeriod": { - "type": "integer" - }, - "PcrPid": { - "type": "string" - }, - "PmtInterval": { - "type": "integer" - }, - "PmtPid": { - "type": "string" - }, - "ProgramNum": { - "type": "integer" - }, - "RateMode": { - "type": "string" - }, - "Scte27Pids": { - "type": "string" - }, - "Scte35Control": { - "type": "string" - }, - "Scte35Pid": { - "type": "string" - }, - "Scte35PrerollPullupMilliseconds": { - "type": "number" - }, - "SegmentationMarkers": { - "type": "string" - }, - "SegmentationStyle": { - "type": "string" - }, - "SegmentationTime": { - "type": "number" - }, - "TimedMetadataBehavior": { - "type": "string" - }, - "TimedMetadataPid": { - "type": "string" - }, - "TransportStreamId": { - "type": "integer" - }, - "VideoPid": { - "type": "string" - } - }, - "type": "object" - }, - "M3u8Settings": { - "additionalProperties": false, - "properties": { - "AudioFramesPerPes": { - "type": "integer" - }, - "AudioPids": { - "type": "string" - }, - "EcmPid": { - "type": "string" - }, - "KlvBehavior": { - "type": "string" - }, - "KlvDataPids": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "PatInterval": { - "type": "integer" - }, - "PcrControl": { - "type": "string" - }, - "PcrPeriod": { - "type": "integer" - }, - "PcrPid": { - "type": "string" - }, - "PmtInterval": { - "type": "integer" - }, - "PmtPid": { - "type": "string" - }, - "ProgramNum": { - "type": "integer" - }, - "Scte35Behavior": { - "type": "string" - }, - "Scte35Pid": { - "type": "string" - }, - "TimedMetadataBehavior": { - "type": "string" - }, - "TimedMetadataPid": { - "type": "string" - }, - "TransportStreamId": { - "type": "integer" - }, - "VideoPid": { - "type": "string" - } - }, - "type": "object" - }, - "MaintenanceCreateSettings": { - "additionalProperties": false, - "properties": { - "MaintenanceDay": { - "type": "string" - }, - "MaintenanceStartTime": { - "type": "string" - } - }, - "type": "object" - }, - "MediaPackageGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - } - }, - "type": "object" - }, - "MediaPackageOutputDestinationSettings": { - "additionalProperties": false, - "properties": { - "ChannelId": { - "type": "string" - } - }, - "type": "object" - }, - "MediaPackageOutputSettings": { - "additionalProperties": false, - "type": "object" - }, - "MotionGraphicsConfiguration": { - "additionalProperties": false, - "properties": { - "MotionGraphicsInsertion": { - "type": "string" - }, - "MotionGraphicsSettings": { - "$ref": "#/definitions/MotionGraphicsSettings" - } - }, - "type": "object" - }, - "MotionGraphicsSettings": { - "additionalProperties": false, - "properties": { - "HtmlMotionGraphicsSettings": { - "$ref": "#/definitions/HtmlMotionGraphicsSettings" - } - }, - "type": "object" - }, - "Mp2Settings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "SampleRate": { - "type": "number" - } - }, - "type": "object" - }, - "Mpeg2FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/TemporalFilterSettings" - } - }, - "type": "object" - }, - "Mpeg2Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpace": { - "type": "string" - }, - "DisplayAspectRatio": { - "type": "string" - }, - "FilterSettings": { - "$ref": "#/definitions/Mpeg2FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FramerateDenominator": { - "type": "integer" - }, - "FramerateNumerator": { - "type": "integer" - }, - "GopClosedCadence": { - "type": "integer" - }, - "GopNumBFrames": { - "type": "integer" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SubgopLength": { - "type": "string" - }, - "TimecodeBurninSettings": { - "$ref": "#/definitions/TimecodeBurninSettings" - }, - "TimecodeInsertion": { - "type": "string" - } - }, - "type": "object" - }, - "MsSmoothGroupSettings": { - "additionalProperties": false, - "properties": { - "AcquisitionPointId": { - "type": "string" - }, - "AudioOnlyTimecodeControl": { - "type": "string" - }, - "CertificateMode": { - "type": "string" - }, - "ConnectionRetryInterval": { - "type": "integer" - }, - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "EventId": { - "type": "string" - }, - "EventIdMode": { - "type": "string" - }, - "EventStopBehavior": { - "type": "string" - }, - "FilecacheDuration": { - "type": "integer" - }, - "FragmentLength": { - "type": "integer" - }, - "InputLossAction": { - "type": "string" - }, - "NumRetries": { - "type": "integer" - }, - "RestartDelay": { - "type": "integer" - }, - "SegmentationMode": { - "type": "string" - }, - "SendDelayMs": { - "type": "integer" - }, - "SparseTrackType": { - "type": "string" - }, - "StreamManifestBehavior": { - "type": "string" - }, - "TimestampOffset": { - "type": "string" - }, - "TimestampOffsetMode": { - "type": "string" - } - }, - "type": "object" - }, - "MsSmoothOutputSettings": { - "additionalProperties": false, - "properties": { - "H265PackagingType": { - "type": "string" - }, - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "MultiplexGroupSettings": { - "additionalProperties": false, - "type": "object" - }, - "MultiplexOutputSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - } - }, - "type": "object" - }, - "MultiplexProgramChannelDestinationSettings": { - "additionalProperties": false, - "properties": { - "MultiplexId": { - "type": "string" - }, - "ProgramName": { - "type": "string" - } - }, - "type": "object" - }, - "NetworkInputSettings": { - "additionalProperties": false, - "properties": { - "HlsInputSettings": { - "$ref": "#/definitions/HlsInputSettings" - }, - "ServerValidation": { - "type": "string" - } - }, - "type": "object" - }, - "NielsenCBET": { - "additionalProperties": false, - "properties": { - "CbetCheckDigitString": { - "type": "string" - }, - "CbetStepaside": { - "type": "string" - }, - "Csid": { - "type": "string" - } - }, - "type": "object" - }, - "NielsenConfiguration": { - "additionalProperties": false, - "properties": { - "DistributorId": { - "type": "string" - }, - "NielsenPcmToId3Tagging": { - "type": "string" - } - }, - "type": "object" - }, - "NielsenNaesIiNw": { - "additionalProperties": false, - "properties": { - "CheckDigitString": { - "type": "string" - }, - "Sid": { - "type": "number" - }, - "Timezone": { - "type": "string" - } - }, - "type": "object" - }, - "NielsenWatermarksSettings": { - "additionalProperties": false, - "properties": { - "NielsenCbetSettings": { - "$ref": "#/definitions/NielsenCBET" - }, - "NielsenDistributionType": { - "type": "string" - }, - "NielsenNaesIiNwSettings": { - "$ref": "#/definitions/NielsenNaesIiNw" - } - }, - "type": "object" - }, - "Output": { - "additionalProperties": false, - "properties": { - "AudioDescriptionNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "CaptionDescriptionNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "OutputName": { - "type": "string" - }, - "OutputSettings": { - "$ref": "#/definitions/OutputSettings" - }, - "VideoDescriptionName": { - "type": "string" - } - }, - "type": "object" - }, - "OutputDestination": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "MediaPackageSettings": { - "items": { - "$ref": "#/definitions/MediaPackageOutputDestinationSettings" - }, - "type": "array", - "uniqueItems": false - }, - "MultiplexSettings": { - "$ref": "#/definitions/MultiplexProgramChannelDestinationSettings" - }, - "Settings": { - "items": { - "$ref": "#/definitions/OutputDestinationSettings" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OutputDestinationSettings": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "StreamName": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "OutputGroup": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "OutputGroupSettings": { - "$ref": "#/definitions/OutputGroupSettings" - }, - "Outputs": { - "items": { - "$ref": "#/definitions/Output" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OutputGroupSettings": { - "additionalProperties": false, - "properties": { - "ArchiveGroupSettings": { - "$ref": "#/definitions/ArchiveGroupSettings" - }, - "CmafIngestGroupSettings": { - "$ref": "#/definitions/CmafIngestGroupSettings" - }, - "FrameCaptureGroupSettings": { - "$ref": "#/definitions/FrameCaptureGroupSettings" - }, - "HlsGroupSettings": { - "$ref": "#/definitions/HlsGroupSettings" - }, - "MediaPackageGroupSettings": { - "$ref": "#/definitions/MediaPackageGroupSettings" - }, - "MsSmoothGroupSettings": { - "$ref": "#/definitions/MsSmoothGroupSettings" - }, - "MultiplexGroupSettings": { - "$ref": "#/definitions/MultiplexGroupSettings" - }, - "RtmpGroupSettings": { - "$ref": "#/definitions/RtmpGroupSettings" - }, - "UdpGroupSettings": { - "$ref": "#/definitions/UdpGroupSettings" - } - }, - "type": "object" - }, - "OutputLocationRef": { - "additionalProperties": false, - "properties": { - "DestinationRefId": { - "type": "string" - } - }, - "type": "object" - }, - "OutputLockingSettings": { - "additionalProperties": false, - "properties": { - "EpochLockingSettings": { - "$ref": "#/definitions/EpochLockingSettings" - }, - "PipelineLockingSettings": { - "$ref": "#/definitions/PipelineLockingSettings" - } - }, - "type": "object" - }, - "OutputSettings": { - "additionalProperties": false, - "properties": { - "ArchiveOutputSettings": { - "$ref": "#/definitions/ArchiveOutputSettings" - }, - "CmafIngestOutputSettings": { - "$ref": "#/definitions/CmafIngestOutputSettings" - }, - "FrameCaptureOutputSettings": { - "$ref": "#/definitions/FrameCaptureOutputSettings" - }, - "HlsOutputSettings": { - "$ref": "#/definitions/HlsOutputSettings" - }, - "MediaPackageOutputSettings": { - "$ref": "#/definitions/MediaPackageOutputSettings" - }, - "MsSmoothOutputSettings": { - "$ref": "#/definitions/MsSmoothOutputSettings" - }, - "MultiplexOutputSettings": { - "$ref": "#/definitions/MultiplexOutputSettings" - }, - "RtmpOutputSettings": { - "$ref": "#/definitions/RtmpOutputSettings" - }, - "UdpOutputSettings": { - "$ref": "#/definitions/UdpOutputSettings" - } - }, - "type": "object" - }, - "PassThroughSettings": { - "additionalProperties": false, - "type": "object" - }, - "PipelineLockingSettings": { - "additionalProperties": false, - "type": "object" - }, - "RawSettings": { - "additionalProperties": false, - "type": "object" - }, - "Rec601Settings": { - "additionalProperties": false, - "type": "object" - }, - "Rec709Settings": { - "additionalProperties": false, - "type": "object" - }, - "RemixSettings": { - "additionalProperties": false, - "properties": { - "ChannelMappings": { - "items": { - "$ref": "#/definitions/AudioChannelMapping" - }, - "type": "array", - "uniqueItems": false - }, - "ChannelsIn": { - "type": "integer" - }, - "ChannelsOut": { - "type": "integer" - } - }, - "type": "object" - }, - "RtmpCaptionInfoDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "RtmpGroupSettings": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AuthenticationScheme": { - "type": "string" - }, - "CacheFullBehavior": { - "type": "string" - }, - "CacheLength": { - "type": "integer" - }, - "CaptionData": { - "type": "string" - }, - "IncludeFillerNalUnits": { - "type": "string" - }, - "InputLossAction": { - "type": "string" - }, - "RestartDelay": { - "type": "integer" - } - }, - "type": "object" - }, - "RtmpOutputSettings": { - "additionalProperties": false, - "properties": { - "CertificateMode": { - "type": "string" - }, - "ConnectionRetryInterval": { - "type": "integer" - }, - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "NumRetries": { - "type": "integer" - } - }, - "type": "object" - }, - "Scte20PlusEmbeddedDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "Scte20SourceSettings": { - "additionalProperties": false, - "properties": { - "Convert608To708": { - "type": "string" - }, - "Source608ChannelNumber": { - "type": "integer" - } - }, - "type": "object" - }, - "Scte27DestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "Scte27SourceSettings": { - "additionalProperties": false, - "properties": { - "OcrLanguage": { - "type": "string" - }, - "Pid": { - "type": "integer" - } - }, - "type": "object" - }, - "Scte35SpliceInsert": { - "additionalProperties": false, - "properties": { - "AdAvailOffset": { - "type": "integer" - }, - "NoRegionalBlackoutFlag": { - "type": "string" - }, - "WebDeliveryAllowedFlag": { - "type": "string" - } - }, - "type": "object" - }, - "Scte35TimeSignalApos": { - "additionalProperties": false, - "properties": { - "AdAvailOffset": { - "type": "integer" - }, - "NoRegionalBlackoutFlag": { - "type": "string" - }, - "WebDeliveryAllowedFlag": { - "type": "string" - } - }, - "type": "object" - }, - "SmpteTtDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "StandardHlsSettings": { - "additionalProperties": false, - "properties": { - "AudioRenditionSets": { - "type": "string" - }, - "M3u8Settings": { - "$ref": "#/definitions/M3u8Settings" - } - }, - "type": "object" - }, - "StaticKeySettings": { - "additionalProperties": false, - "properties": { - "KeyProviderServer": { - "$ref": "#/definitions/InputLocation" - }, - "StaticKeyValue": { - "type": "string" - } - }, - "type": "object" - }, - "TeletextDestinationSettings": { - "additionalProperties": false, - "type": "object" - }, - "TeletextSourceSettings": { - "additionalProperties": false, - "properties": { - "OutputRectangle": { - "$ref": "#/definitions/CaptionRectangle" - }, - "PageNumber": { - "type": "string" - } - }, - "type": "object" - }, - "TemporalFilterSettings": { - "additionalProperties": false, - "properties": { - "PostFilterSharpening": { - "type": "string" - }, - "Strength": { - "type": "string" - } - }, - "type": "object" - }, - "ThumbnailConfiguration": { - "additionalProperties": false, - "properties": { - "State": { - "type": "string" - } - }, - "type": "object" - }, - "TimecodeBurninSettings": { - "additionalProperties": false, - "properties": { - "FontSize": { - "type": "string" - }, - "Position": { - "type": "string" - }, - "Prefix": { - "type": "string" - } - }, - "type": "object" - }, - "TimecodeConfig": { - "additionalProperties": false, - "properties": { - "Source": { - "type": "string" - }, - "SyncThreshold": { - "type": "integer" - } - }, - "type": "object" - }, - "TtmlDestinationSettings": { - "additionalProperties": false, - "properties": { - "StyleControl": { - "type": "string" - } - }, - "type": "object" - }, - "UdpContainerSettings": { - "additionalProperties": false, - "properties": { - "M2tsSettings": { - "$ref": "#/definitions/M2tsSettings" - } - }, - "type": "object" - }, - "UdpGroupSettings": { - "additionalProperties": false, - "properties": { - "InputLossAction": { - "type": "string" - }, - "TimedMetadataId3Frame": { - "type": "string" - }, - "TimedMetadataId3Period": { - "type": "integer" - } - }, - "type": "object" - }, - "UdpOutputSettings": { - "additionalProperties": false, - "properties": { - "BufferMsec": { - "type": "integer" - }, - "ContainerSettings": { - "$ref": "#/definitions/UdpContainerSettings" - }, - "Destination": { - "$ref": "#/definitions/OutputLocationRef" - }, - "FecOutputSettings": { - "$ref": "#/definitions/FecOutputSettings" - } - }, - "type": "object" - }, - "VideoBlackFailoverSettings": { - "additionalProperties": false, - "properties": { - "BlackDetectThreshold": { - "type": "number" - }, - "VideoBlackThresholdMsec": { - "type": "integer" - } - }, - "type": "object" - }, - "VideoCodecSettings": { - "additionalProperties": false, - "properties": { - "FrameCaptureSettings": { - "$ref": "#/definitions/FrameCaptureSettings" - }, - "H264Settings": { - "$ref": "#/definitions/H264Settings" - }, - "H265Settings": { - "$ref": "#/definitions/H265Settings" - }, - "Mpeg2Settings": { - "$ref": "#/definitions/Mpeg2Settings" - } - }, - "type": "object" - }, - "VideoDescription": { - "additionalProperties": false, - "properties": { - "CodecSettings": { - "$ref": "#/definitions/VideoCodecSettings" - }, - "Height": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "RespondToAfd": { - "type": "string" - }, - "ScalingBehavior": { - "type": "string" - }, - "Sharpness": { - "type": "integer" - }, - "Width": { - "type": "integer" - } - }, - "type": "object" - }, - "VideoSelector": { - "additionalProperties": false, - "properties": { - "ColorSpace": { - "type": "string" - }, - "ColorSpaceSettings": { - "$ref": "#/definitions/VideoSelectorColorSpaceSettings" - }, - "ColorSpaceUsage": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/VideoSelectorSettings" - } - }, - "type": "object" - }, - "VideoSelectorColorSpaceSettings": { - "additionalProperties": false, - "properties": { - "Hdr10Settings": { - "$ref": "#/definitions/Hdr10Settings" - } - }, - "type": "object" - }, - "VideoSelectorPid": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "integer" - } - }, - "type": "object" - }, - "VideoSelectorProgramId": { - "additionalProperties": false, - "properties": { - "ProgramId": { - "type": "integer" - } - }, - "type": "object" - }, - "VideoSelectorSettings": { - "additionalProperties": false, - "properties": { - "VideoSelectorPid": { - "$ref": "#/definitions/VideoSelectorPid" - }, - "VideoSelectorProgramId": { - "$ref": "#/definitions/VideoSelectorProgramId" - } - }, - "type": "object" - }, - "VpcOutputSettings": { - "additionalProperties": false, - "properties": { - "PublicAddressAllocationIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "WavSettings": { - "additionalProperties": false, - "properties": { - "BitDepth": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "SampleRate": { - "type": "number" - } - }, - "type": "object" - }, - "WebvttDestinationSettings": { - "additionalProperties": false, - "properties": { - "StyleControl": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MediaLive::Channel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "CdiInputSpecification": { - "$ref": "#/definitions/CdiInputSpecification" - }, - "ChannelClass": { - "type": "string" - }, - "Destinations": { - "items": { - "$ref": "#/definitions/OutputDestination" - }, - "type": "array", - "uniqueItems": false - }, - "EncoderSettings": { - "$ref": "#/definitions/EncoderSettings" - }, - "Id": { - "type": "string" - }, - "InputAttachments": { - "items": { - "$ref": "#/definitions/InputAttachment" - }, - "type": "array", - "uniqueItems": false - }, - "InputSpecification": { - "$ref": "#/definitions/InputSpecification" - }, - "Inputs": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "LogLevel": { - "type": "string" - }, - "Maintenance": { - "$ref": "#/definitions/MaintenanceCreateSettings" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Vpc": { - "$ref": "#/definitions/VpcOutputSettings" - } - }, - "readOnlyProperties": [ - "/properties/Inputs", - "/properties/Id", - "/properties/Arn" - ], - "typeName": "AWS::MediaLive::Channel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Vpc" + ], + "definitions": { + "AacSettings": { + "additionalProperties": false, + "properties": { + "Bitrate": { + "type": "number" + }, + "CodingMode": { + "type": "string" + }, + "InputType": { + "type": "string" + }, + "Profile": { + "type": "string" + }, + "RateControlMode": { + "type": "string" + }, + "RawFormat": { + "type": "string" + }, + "SampleRate": { + "type": "number" + }, + "Spec": { + "type": "string" + }, + "VbrQuality": { + "type": "string" + } + }, + "type": "object" + }, + "Ac3Settings": { + "additionalProperties": false, + "properties": { + "AttenuationControl": { + "type": "string" + }, + "Bitrate": { + "type": "number" + }, + "BitstreamMode": { + "type": "string" + }, + "CodingMode": { + "type": "string" + }, + "Dialnorm": { + "type": "integer" + }, + "DrcProfile": { + "type": "string" + }, + "LfeFilter": { + "type": "string" + }, + "MetadataControl": { + "type": "string" + } + }, + "type": "object" + }, + "AncillarySourceSettings": { + "additionalProperties": false, + "properties": { + "SourceAncillaryChannelNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "ArchiveCdnSettings": { + "additionalProperties": false, + "properties": { + "ArchiveS3Settings": { + "$ref": "#/definitions/ArchiveS3Settings" + } + }, + "type": "object" + }, + "ArchiveContainerSettings": { + "additionalProperties": false, + "properties": { + "M2tsSettings": { + "$ref": "#/definitions/M2tsSettings" + }, + "RawSettings": { + "$ref": "#/definitions/RawSettings" + } + }, + "type": "object" + }, + "ArchiveGroupSettings": { + "additionalProperties": false, + "properties": { + "ArchiveCdnSettings": { + "$ref": "#/definitions/ArchiveCdnSettings" + }, + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "RolloverInterval": { + "type": "integer" + } + }, + "type": "object" + }, + "ArchiveOutputSettings": { + "additionalProperties": false, + "properties": { + "ContainerSettings": { + "$ref": "#/definitions/ArchiveContainerSettings" + }, + "Extension": { + "type": "string" + }, + "NameModifier": { + "type": "string" + } + }, + "type": "object" + }, + "ArchiveS3Settings": { + "additionalProperties": false, + "properties": { + "CannedAcl": { + "type": "string" + } + }, + "type": "object" + }, + "AribDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "AribSourceSettings": { + "additionalProperties": false, + "type": "object" + }, + "AudioChannelMapping": { + "additionalProperties": false, + "properties": { + "InputChannelLevels": { + "items": { + "$ref": "#/definitions/InputChannelLevel" + }, + "type": "array", + "uniqueItems": false + }, + "OutputChannel": { + "type": "integer" + } + }, + "type": "object" + }, + "AudioCodecSettings": { + "additionalProperties": false, + "properties": { + "AacSettings": { + "$ref": "#/definitions/AacSettings" + }, + "Ac3Settings": { + "$ref": "#/definitions/Ac3Settings" + }, + "Eac3AtmosSettings": { + "$ref": "#/definitions/Eac3AtmosSettings" + }, + "Eac3Settings": { + "$ref": "#/definitions/Eac3Settings" + }, + "Mp2Settings": { + "$ref": "#/definitions/Mp2Settings" + }, + "PassThroughSettings": { + "$ref": "#/definitions/PassThroughSettings" + }, + "WavSettings": { + "$ref": "#/definitions/WavSettings" + } + }, + "type": "object" + }, + "AudioDescription": { + "additionalProperties": false, + "properties": { + "AudioDashRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AudioNormalizationSettings": { + "$ref": "#/definitions/AudioNormalizationSettings" + }, + "AudioSelectorName": { + "type": "string" + }, + "AudioType": { + "type": "string" + }, + "AudioTypeControl": { + "type": "string" + }, + "AudioWatermarkingSettings": { + "$ref": "#/definitions/AudioWatermarkSettings" + }, + "CodecSettings": { + "$ref": "#/definitions/AudioCodecSettings" + }, + "DvbDashAccessibility": { + "type": "string" + }, + "LanguageCode": { + "type": "string" + }, + "LanguageCodeControl": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RemixSettings": { + "$ref": "#/definitions/RemixSettings" + }, + "StreamName": { + "type": "string" + } + }, + "type": "object" + }, + "AudioDolbyEDecode": { + "additionalProperties": false, + "properties": { + "ProgramSelection": { + "type": "string" + } + }, + "type": "object" + }, + "AudioHlsRenditionSelection": { + "additionalProperties": false, + "properties": { + "GroupId": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "AudioLanguageSelection": { + "additionalProperties": false, + "properties": { + "LanguageCode": { + "type": "string" + }, + "LanguageSelectionPolicy": { + "type": "string" + } + }, + "type": "object" + }, + "AudioNormalizationSettings": { + "additionalProperties": false, + "properties": { + "Algorithm": { + "type": "string" + }, + "AlgorithmControl": { + "type": "string" + }, + "TargetLkfs": { + "type": "number" + } + }, + "type": "object" + }, + "AudioOnlyHlsSettings": { + "additionalProperties": false, + "properties": { + "AudioGroupId": { + "type": "string" + }, + "AudioOnlyImage": { + "$ref": "#/definitions/InputLocation" + }, + "AudioTrackType": { + "type": "string" + }, + "SegmentType": { + "type": "string" + } + }, + "type": "object" + }, + "AudioPidSelection": { + "additionalProperties": false, + "properties": { + "Pid": { + "type": "integer" + } + }, + "type": "object" + }, + "AudioSelector": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "SelectorSettings": { + "$ref": "#/definitions/AudioSelectorSettings" + } + }, + "type": "object" + }, + "AudioSelectorSettings": { + "additionalProperties": false, + "properties": { + "AudioHlsRenditionSelection": { + "$ref": "#/definitions/AudioHlsRenditionSelection" + }, + "AudioLanguageSelection": { + "$ref": "#/definitions/AudioLanguageSelection" + }, + "AudioPidSelection": { + "$ref": "#/definitions/AudioPidSelection" + }, + "AudioTrackSelection": { + "$ref": "#/definitions/AudioTrackSelection" + } + }, + "type": "object" + }, + "AudioSilenceFailoverSettings": { + "additionalProperties": false, + "properties": { + "AudioSelectorName": { + "type": "string" + }, + "AudioSilenceThresholdMsec": { + "type": "integer" + } + }, + "type": "object" + }, + "AudioTrack": { + "additionalProperties": false, + "properties": { + "Track": { + "type": "integer" + } + }, + "type": "object" + }, + "AudioTrackSelection": { + "additionalProperties": false, + "properties": { + "DolbyEDecode": { + "$ref": "#/definitions/AudioDolbyEDecode" + }, + "Tracks": { + "items": { + "$ref": "#/definitions/AudioTrack" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "AudioWatermarkSettings": { + "additionalProperties": false, + "properties": { + "NielsenWatermarksSettings": { + "$ref": "#/definitions/NielsenWatermarksSettings" + } + }, + "type": "object" + }, + "AutomaticInputFailoverSettings": { + "additionalProperties": false, + "properties": { + "ErrorClearTimeMsec": { + "type": "integer" + }, + "FailoverConditions": { + "items": { + "$ref": "#/definitions/FailoverCondition" + }, + "type": "array", + "uniqueItems": false + }, + "InputPreference": { + "type": "string" + }, + "SecondaryInputId": { + "type": "string" + } + }, + "type": "object" + }, + "AvailBlanking": { + "additionalProperties": false, + "properties": { + "AvailBlankingImage": { + "$ref": "#/definitions/InputLocation" + }, + "State": { + "type": "string" + } + }, + "type": "object" + }, + "AvailConfiguration": { + "additionalProperties": false, + "properties": { + "AvailSettings": { + "$ref": "#/definitions/AvailSettings" + }, + "Scte35SegmentationScope": { + "type": "string" + } + }, + "type": "object" + }, + "AvailSettings": { + "additionalProperties": false, + "properties": { + "Esam": { + "$ref": "#/definitions/Esam" + }, + "Scte35SpliceInsert": { + "$ref": "#/definitions/Scte35SpliceInsert" + }, + "Scte35TimeSignalApos": { + "$ref": "#/definitions/Scte35TimeSignalApos" + } + }, + "type": "object" + }, + "BlackoutSlate": { + "additionalProperties": false, + "properties": { + "BlackoutSlateImage": { + "$ref": "#/definitions/InputLocation" + }, + "NetworkEndBlackout": { + "type": "string" + }, + "NetworkEndBlackoutImage": { + "$ref": "#/definitions/InputLocation" + }, + "NetworkId": { + "type": "string" + }, + "State": { + "type": "string" + } + }, + "type": "object" + }, + "BurnInDestinationSettings": { + "additionalProperties": false, + "properties": { + "Alignment": { + "type": "string" + }, + "BackgroundColor": { + "type": "string" + }, + "BackgroundOpacity": { + "type": "integer" + }, + "Font": { + "$ref": "#/definitions/InputLocation" + }, + "FontColor": { + "type": "string" + }, + "FontOpacity": { + "type": "integer" + }, + "FontResolution": { + "type": "integer" + }, + "FontSize": { + "type": "string" + }, + "OutlineColor": { + "type": "string" + }, + "OutlineSize": { + "type": "integer" + }, + "ShadowColor": { + "type": "string" + }, + "ShadowOpacity": { + "type": "integer" + }, + "ShadowXOffset": { + "type": "integer" + }, + "ShadowYOffset": { + "type": "integer" + }, + "TeletextGridControl": { + "type": "string" + }, + "XPosition": { + "type": "integer" + }, + "YPosition": { + "type": "integer" + } + }, + "type": "object" + }, + "CaptionDescription": { + "additionalProperties": false, + "properties": { + "Accessibility": { + "type": "string" + }, + "CaptionDashRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CaptionSelectorName": { + "type": "string" + }, + "DestinationSettings": { + "$ref": "#/definitions/CaptionDestinationSettings" + }, + "DvbDashAccessibility": { + "type": "string" + }, + "LanguageCode": { + "type": "string" + }, + "LanguageDescription": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "CaptionDestinationSettings": { + "additionalProperties": false, + "properties": { + "AribDestinationSettings": { + "$ref": "#/definitions/AribDestinationSettings" + }, + "BurnInDestinationSettings": { + "$ref": "#/definitions/BurnInDestinationSettings" + }, + "DvbSubDestinationSettings": { + "$ref": "#/definitions/DvbSubDestinationSettings" + }, + "EbuTtDDestinationSettings": { + "$ref": "#/definitions/EbuTtDDestinationSettings" + }, + "EmbeddedDestinationSettings": { + "$ref": "#/definitions/EmbeddedDestinationSettings" + }, + "EmbeddedPlusScte20DestinationSettings": { + "$ref": "#/definitions/EmbeddedPlusScte20DestinationSettings" + }, + "RtmpCaptionInfoDestinationSettings": { + "$ref": "#/definitions/RtmpCaptionInfoDestinationSettings" + }, + "Scte20PlusEmbeddedDestinationSettings": { + "$ref": "#/definitions/Scte20PlusEmbeddedDestinationSettings" + }, + "Scte27DestinationSettings": { + "$ref": "#/definitions/Scte27DestinationSettings" + }, + "SmpteTtDestinationSettings": { + "$ref": "#/definitions/SmpteTtDestinationSettings" + }, + "TeletextDestinationSettings": { + "$ref": "#/definitions/TeletextDestinationSettings" + }, + "TtmlDestinationSettings": { + "$ref": "#/definitions/TtmlDestinationSettings" + }, + "WebvttDestinationSettings": { + "$ref": "#/definitions/WebvttDestinationSettings" + } + }, + "type": "object" + }, + "CaptionLanguageMapping": { + "additionalProperties": false, + "properties": { + "CaptionChannel": { + "type": "integer" + }, + "LanguageCode": { + "type": "string" + }, + "LanguageDescription": { + "type": "string" + } + }, + "type": "object" + }, + "CaptionRectangle": { + "additionalProperties": false, + "properties": { + "Height": { + "type": "number" + }, + "LeftOffset": { + "type": "number" + }, + "TopOffset": { + "type": "number" + }, + "Width": { + "type": "number" + } + }, + "type": "object" + }, + "CaptionSelector": { + "additionalProperties": false, + "properties": { + "LanguageCode": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SelectorSettings": { + "$ref": "#/definitions/CaptionSelectorSettings" + } + }, + "type": "object" + }, + "CaptionSelectorSettings": { + "additionalProperties": false, + "properties": { + "AncillarySourceSettings": { + "$ref": "#/definitions/AncillarySourceSettings" + }, + "AribSourceSettings": { + "$ref": "#/definitions/AribSourceSettings" + }, + "DvbSubSourceSettings": { + "$ref": "#/definitions/DvbSubSourceSettings" + }, + "EmbeddedSourceSettings": { + "$ref": "#/definitions/EmbeddedSourceSettings" + }, + "Scte20SourceSettings": { + "$ref": "#/definitions/Scte20SourceSettings" + }, + "Scte27SourceSettings": { + "$ref": "#/definitions/Scte27SourceSettings" + }, + "TeletextSourceSettings": { + "$ref": "#/definitions/TeletextSourceSettings" + } + }, + "type": "object" + }, + "CdiInputSpecification": { + "additionalProperties": false, + "properties": { + "Resolution": { + "type": "string" + } + }, + "type": "object" + }, + "CmafIngestGroupSettings": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "NielsenId3Behavior": { + "type": "string" + }, + "Scte35Type": { + "type": "string" + }, + "SegmentLength": { + "type": "integer" + }, + "SegmentLengthUnits": { + "type": "string" + }, + "SendDelayMs": { + "type": "integer" + } + }, + "type": "object" + }, + "CmafIngestOutputSettings": { + "additionalProperties": false, + "properties": { + "NameModifier": { + "type": "string" + } + }, + "type": "object" + }, + "ColorCorrection": { + "additionalProperties": false, + "properties": { + "InputColorSpace": { + "type": "string" + }, + "OutputColorSpace": { + "type": "string" + }, + "Uri": { + "type": "string" + } + }, + "type": "object" + }, + "ColorCorrectionSettings": { + "additionalProperties": false, + "properties": { + "GlobalColorCorrections": { + "items": { + "$ref": "#/definitions/ColorCorrection" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "ColorSpacePassthroughSettings": { + "additionalProperties": false, + "type": "object" + }, + "DolbyVision81Settings": { + "additionalProperties": false, + "type": "object" + }, + "DvbNitSettings": { + "additionalProperties": false, + "properties": { + "NetworkId": { + "type": "integer" + }, + "NetworkName": { + "type": "string" + }, + "RepInterval": { + "type": "integer" + } + }, + "type": "object" + }, + "DvbSdtSettings": { + "additionalProperties": false, + "properties": { + "OutputSdt": { + "type": "string" + }, + "RepInterval": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + }, + "ServiceProviderName": { + "type": "string" + } + }, + "type": "object" + }, + "DvbSubDestinationSettings": { + "additionalProperties": false, + "properties": { + "Alignment": { + "type": "string" + }, + "BackgroundColor": { + "type": "string" + }, + "BackgroundOpacity": { + "type": "integer" + }, + "Font": { + "$ref": "#/definitions/InputLocation" + }, + "FontColor": { + "type": "string" + }, + "FontOpacity": { + "type": "integer" + }, + "FontResolution": { + "type": "integer" + }, + "FontSize": { + "type": "string" + }, + "OutlineColor": { + "type": "string" + }, + "OutlineSize": { + "type": "integer" + }, + "ShadowColor": { + "type": "string" + }, + "ShadowOpacity": { + "type": "integer" + }, + "ShadowXOffset": { + "type": "integer" + }, + "ShadowYOffset": { + "type": "integer" + }, + "TeletextGridControl": { + "type": "string" + }, + "XPosition": { + "type": "integer" + }, + "YPosition": { + "type": "integer" + } + }, + "type": "object" + }, + "DvbSubSourceSettings": { + "additionalProperties": false, + "properties": { + "OcrLanguage": { + "type": "string" + }, + "Pid": { + "type": "integer" + } + }, + "type": "object" + }, + "DvbTdtSettings": { + "additionalProperties": false, + "properties": { + "RepInterval": { + "type": "integer" + } + }, + "type": "object" + }, + "Eac3AtmosSettings": { + "additionalProperties": false, + "properties": { + "Bitrate": { + "type": "number" + }, + "CodingMode": { + "type": "string" + }, + "Dialnorm": { + "type": "integer" + }, + "DrcLine": { + "type": "string" + }, + "DrcRf": { + "type": "string" + }, + "HeightTrim": { + "type": "number" + }, + "SurroundTrim": { + "type": "number" + } + }, + "type": "object" + }, + "Eac3Settings": { + "additionalProperties": false, + "properties": { + "AttenuationControl": { + "type": "string" + }, + "Bitrate": { + "type": "number" + }, + "BitstreamMode": { + "type": "string" + }, + "CodingMode": { + "type": "string" + }, + "DcFilter": { + "type": "string" + }, + "Dialnorm": { + "type": "integer" + }, + "DrcLine": { + "type": "string" + }, + "DrcRf": { + "type": "string" + }, + "LfeControl": { + "type": "string" + }, + "LfeFilter": { + "type": "string" + }, + "LoRoCenterMixLevel": { + "type": "number" + }, + "LoRoSurroundMixLevel": { + "type": "number" + }, + "LtRtCenterMixLevel": { + "type": "number" + }, + "LtRtSurroundMixLevel": { + "type": "number" + }, + "MetadataControl": { + "type": "string" + }, + "PassthroughControl": { + "type": "string" + }, + "PhaseControl": { + "type": "string" + }, + "StereoDownmix": { + "type": "string" + }, + "SurroundExMode": { + "type": "string" + }, + "SurroundMode": { + "type": "string" + } + }, + "type": "object" + }, + "EbuTtDDestinationSettings": { + "additionalProperties": false, + "properties": { + "CopyrightHolder": { + "type": "string" + }, + "FillLineGap": { + "type": "string" + }, + "FontFamily": { + "type": "string" + }, + "StyleControl": { + "type": "string" + } + }, + "type": "object" + }, + "EmbeddedDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "EmbeddedPlusScte20DestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "EmbeddedSourceSettings": { + "additionalProperties": false, + "properties": { + "Convert608To708": { + "type": "string" + }, + "Scte20Detection": { + "type": "string" + }, + "Source608ChannelNumber": { + "type": "integer" + }, + "Source608TrackNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "EncoderSettings": { + "additionalProperties": false, + "properties": { + "AudioDescriptions": { + "items": { + "$ref": "#/definitions/AudioDescription" + }, + "type": "array", + "uniqueItems": false + }, + "AvailBlanking": { + "$ref": "#/definitions/AvailBlanking" + }, + "AvailConfiguration": { + "$ref": "#/definitions/AvailConfiguration" + }, + "BlackoutSlate": { + "$ref": "#/definitions/BlackoutSlate" + }, + "CaptionDescriptions": { + "items": { + "$ref": "#/definitions/CaptionDescription" + }, + "type": "array", + "uniqueItems": false + }, + "ColorCorrectionSettings": { + "$ref": "#/definitions/ColorCorrectionSettings" + }, + "FeatureActivations": { + "$ref": "#/definitions/FeatureActivations" + }, + "GlobalConfiguration": { + "$ref": "#/definitions/GlobalConfiguration" + }, + "MotionGraphicsConfiguration": { + "$ref": "#/definitions/MotionGraphicsConfiguration" + }, + "NielsenConfiguration": { + "$ref": "#/definitions/NielsenConfiguration" + }, + "OutputGroups": { + "items": { + "$ref": "#/definitions/OutputGroup" + }, + "type": "array", + "uniqueItems": false + }, + "ThumbnailConfiguration": { + "$ref": "#/definitions/ThumbnailConfiguration" + }, + "TimecodeConfig": { + "$ref": "#/definitions/TimecodeConfig" + }, + "VideoDescriptions": { + "items": { + "$ref": "#/definitions/VideoDescription" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EpochLockingSettings": { + "additionalProperties": false, + "properties": { + "CustomEpoch": { + "type": "string" + }, + "JamSyncTime": { + "type": "string" + } + }, + "type": "object" + }, + "Esam": { + "additionalProperties": false, + "properties": { + "AcquisitionPointId": { + "type": "string" + }, + "AdAvailOffset": { + "type": "integer" + }, + "PasswordParam": { + "type": "string" + }, + "PoisEndpoint": { + "type": "string" + }, + "Username": { + "type": "string" + }, + "ZoneIdentity": { + "type": "string" + } + }, + "type": "object" + }, + "FailoverCondition": { + "additionalProperties": false, + "properties": { + "FailoverConditionSettings": { + "$ref": "#/definitions/FailoverConditionSettings" + } + }, + "type": "object" + }, + "FailoverConditionSettings": { + "additionalProperties": false, + "properties": { + "AudioSilenceSettings": { + "$ref": "#/definitions/AudioSilenceFailoverSettings" + }, + "InputLossSettings": { + "$ref": "#/definitions/InputLossFailoverSettings" + }, + "VideoBlackSettings": { + "$ref": "#/definitions/VideoBlackFailoverSettings" + } + }, + "type": "object" + }, + "FeatureActivations": { + "additionalProperties": false, + "properties": { + "InputPrepareScheduleActions": { + "type": "string" + }, + "OutputStaticImageOverlayScheduleActions": { + "type": "string" + } + }, + "type": "object" + }, + "FecOutputSettings": { + "additionalProperties": false, + "properties": { + "ColumnDepth": { + "type": "integer" + }, + "IncludeFec": { + "type": "string" + }, + "RowLength": { + "type": "integer" + } + }, + "type": "object" + }, + "Fmp4HlsSettings": { + "additionalProperties": false, + "properties": { + "AudioRenditionSets": { + "type": "string" + }, + "NielsenId3Behavior": { + "type": "string" + }, + "TimedMetadataBehavior": { + "type": "string" + } + }, + "type": "object" + }, + "FrameCaptureCdnSettings": { + "additionalProperties": false, + "properties": { + "FrameCaptureS3Settings": { + "$ref": "#/definitions/FrameCaptureS3Settings" + } + }, + "type": "object" + }, + "FrameCaptureGroupSettings": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "FrameCaptureCdnSettings": { + "$ref": "#/definitions/FrameCaptureCdnSettings" + } + }, + "type": "object" + }, + "FrameCaptureHlsSettings": { + "additionalProperties": false, + "type": "object" + }, + "FrameCaptureOutputSettings": { + "additionalProperties": false, + "properties": { + "NameModifier": { + "type": "string" + } + }, + "type": "object" + }, + "FrameCaptureS3Settings": { + "additionalProperties": false, + "properties": { + "CannedAcl": { + "type": "string" + } + }, + "type": "object" + }, + "FrameCaptureSettings": { + "additionalProperties": false, + "properties": { + "CaptureInterval": { + "type": "integer" + }, + "CaptureIntervalUnits": { + "type": "string" + }, + "TimecodeBurninSettings": { + "$ref": "#/definitions/TimecodeBurninSettings" + } + }, + "type": "object" + }, + "GlobalConfiguration": { + "additionalProperties": false, + "properties": { + "InitialAudioGain": { + "type": "integer" + }, + "InputEndAction": { + "type": "string" + }, + "InputLossBehavior": { + "$ref": "#/definitions/InputLossBehavior" + }, + "OutputLockingMode": { + "type": "string" + }, + "OutputLockingSettings": { + "$ref": "#/definitions/OutputLockingSettings" + }, + "OutputTimingSource": { + "type": "string" + }, + "SupportLowFramerateInputs": { + "type": "string" + } + }, + "type": "object" + }, + "H264ColorSpaceSettings": { + "additionalProperties": false, + "properties": { + "ColorSpacePassthroughSettings": { + "$ref": "#/definitions/ColorSpacePassthroughSettings" + }, + "Rec601Settings": { + "$ref": "#/definitions/Rec601Settings" + }, + "Rec709Settings": { + "$ref": "#/definitions/Rec709Settings" + } + }, + "type": "object" + }, + "H264FilterSettings": { + "additionalProperties": false, + "properties": { + "TemporalFilterSettings": { + "$ref": "#/definitions/TemporalFilterSettings" + } + }, + "type": "object" + }, + "H264Settings": { + "additionalProperties": false, + "properties": { + "AdaptiveQuantization": { + "type": "string" + }, + "AfdSignaling": { + "type": "string" + }, + "Bitrate": { + "type": "integer" + }, + "BufFillPct": { + "type": "integer" + }, + "BufSize": { + "type": "integer" + }, + "ColorMetadata": { + "type": "string" + }, + "ColorSpaceSettings": { + "$ref": "#/definitions/H264ColorSpaceSettings" + }, + "EntropyEncoding": { + "type": "string" + }, + "FilterSettings": { + "$ref": "#/definitions/H264FilterSettings" + }, + "FixedAfd": { + "type": "string" + }, + "FlickerAq": { + "type": "string" + }, + "ForceFieldPictures": { + "type": "string" + }, + "FramerateControl": { + "type": "string" + }, + "FramerateDenominator": { + "type": "integer" + }, + "FramerateNumerator": { + "type": "integer" + }, + "GopBReference": { + "type": "string" + }, + "GopClosedCadence": { + "type": "integer" + }, + "GopNumBFrames": { + "type": "integer" + }, + "GopSize": { + "type": "number" + }, + "GopSizeUnits": { + "type": "string" + }, + "Level": { + "type": "string" + }, + "LookAheadRateControl": { + "type": "string" + }, + "MaxBitrate": { + "type": "integer" + }, + "MinIInterval": { + "type": "integer" + }, + "NumRefFrames": { + "type": "integer" + }, + "ParControl": { + "type": "string" + }, + "ParDenominator": { + "type": "integer" + }, + "ParNumerator": { + "type": "integer" + }, + "Profile": { + "type": "string" + }, + "QualityLevel": { + "type": "string" + }, + "QvbrQualityLevel": { + "type": "integer" + }, + "RateControlMode": { + "type": "string" + }, + "ScanType": { + "type": "string" + }, + "SceneChangeDetect": { + "type": "string" + }, + "Slices": { + "type": "integer" + }, + "Softness": { + "type": "integer" + }, + "SpatialAq": { + "type": "string" + }, + "SubgopLength": { + "type": "string" + }, + "Syntax": { + "type": "string" + }, + "TemporalAq": { + "type": "string" + }, + "TimecodeBurninSettings": { + "$ref": "#/definitions/TimecodeBurninSettings" + }, + "TimecodeInsertion": { + "type": "string" + } + }, + "type": "object" + }, + "H265ColorSpaceSettings": { + "additionalProperties": false, + "properties": { + "ColorSpacePassthroughSettings": { + "$ref": "#/definitions/ColorSpacePassthroughSettings" + }, + "DolbyVision81Settings": { + "$ref": "#/definitions/DolbyVision81Settings" + }, + "Hdr10Settings": { + "$ref": "#/definitions/Hdr10Settings" + }, + "Rec601Settings": { + "$ref": "#/definitions/Rec601Settings" + }, + "Rec709Settings": { + "$ref": "#/definitions/Rec709Settings" + } + }, + "type": "object" + }, + "H265FilterSettings": { + "additionalProperties": false, + "properties": { + "TemporalFilterSettings": { + "$ref": "#/definitions/TemporalFilterSettings" + } + }, + "type": "object" + }, + "H265Settings": { + "additionalProperties": false, + "properties": { + "AdaptiveQuantization": { + "type": "string" + }, + "AfdSignaling": { + "type": "string" + }, + "AlternativeTransferFunction": { + "type": "string" + }, + "Bitrate": { + "type": "integer" + }, + "BufSize": { + "type": "integer" + }, + "ColorMetadata": { + "type": "string" + }, + "ColorSpaceSettings": { + "$ref": "#/definitions/H265ColorSpaceSettings" + }, + "FilterSettings": { + "$ref": "#/definitions/H265FilterSettings" + }, + "FixedAfd": { + "type": "string" + }, + "FlickerAq": { + "type": "string" + }, + "FramerateDenominator": { + "type": "integer" + }, + "FramerateNumerator": { + "type": "integer" + }, + "GopClosedCadence": { + "type": "integer" + }, + "GopSize": { + "type": "number" + }, + "GopSizeUnits": { + "type": "string" + }, + "Level": { + "type": "string" + }, + "LookAheadRateControl": { + "type": "string" + }, + "MaxBitrate": { + "type": "integer" + }, + "MinIInterval": { + "type": "integer" + }, + "MvOverPictureBoundaries": { + "type": "string" + }, + "MvTemporalPredictor": { + "type": "string" + }, + "ParDenominator": { + "type": "integer" + }, + "ParNumerator": { + "type": "integer" + }, + "Profile": { + "type": "string" + }, + "QvbrQualityLevel": { + "type": "integer" + }, + "RateControlMode": { + "type": "string" + }, + "ScanType": { + "type": "string" + }, + "SceneChangeDetect": { + "type": "string" + }, + "Slices": { + "type": "integer" + }, + "Tier": { + "type": "string" + }, + "TileHeight": { + "type": "integer" + }, + "TilePadding": { + "type": "string" + }, + "TileWidth": { + "type": "integer" + }, + "TimecodeBurninSettings": { + "$ref": "#/definitions/TimecodeBurninSettings" + }, + "TimecodeInsertion": { + "type": "string" + }, + "TreeblockSize": { + "type": "string" + } + }, + "type": "object" + }, + "Hdr10Settings": { + "additionalProperties": false, + "properties": { + "MaxCll": { + "type": "integer" + }, + "MaxFall": { + "type": "integer" + } + }, + "type": "object" + }, + "HlsAkamaiSettings": { + "additionalProperties": false, + "properties": { + "ConnectionRetryInterval": { + "type": "integer" + }, + "FilecacheDuration": { + "type": "integer" + }, + "HttpTransferMode": { + "type": "string" + }, + "NumRetries": { + "type": "integer" + }, + "RestartDelay": { + "type": "integer" + }, + "Salt": { + "type": "string" + }, + "Token": { + "type": "string" + } + }, + "type": "object" + }, + "HlsBasicPutSettings": { + "additionalProperties": false, + "properties": { + "ConnectionRetryInterval": { + "type": "integer" + }, + "FilecacheDuration": { + "type": "integer" + }, + "NumRetries": { + "type": "integer" + }, + "RestartDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "HlsCdnSettings": { + "additionalProperties": false, + "properties": { + "HlsAkamaiSettings": { + "$ref": "#/definitions/HlsAkamaiSettings" + }, + "HlsBasicPutSettings": { + "$ref": "#/definitions/HlsBasicPutSettings" + }, + "HlsMediaStoreSettings": { + "$ref": "#/definitions/HlsMediaStoreSettings" + }, + "HlsS3Settings": { + "$ref": "#/definitions/HlsS3Settings" + }, + "HlsWebdavSettings": { + "$ref": "#/definitions/HlsWebdavSettings" + } + }, + "type": "object" + }, + "HlsGroupSettings": { + "additionalProperties": false, + "properties": { + "AdMarkers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "BaseUrlContent": { + "type": "string" + }, + "BaseUrlContent1": { + "type": "string" + }, + "BaseUrlManifest": { + "type": "string" + }, + "BaseUrlManifest1": { + "type": "string" + }, + "CaptionLanguageMappings": { + "items": { + "$ref": "#/definitions/CaptionLanguageMapping" + }, + "type": "array", + "uniqueItems": false + }, + "CaptionLanguageSetting": { + "type": "string" + }, + "ClientCache": { + "type": "string" + }, + "CodecSpecification": { + "type": "string" + }, + "ConstantIv": { + "type": "string" + }, + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "DirectoryStructure": { + "type": "string" + }, + "DiscontinuityTags": { + "type": "string" + }, + "EncryptionType": { + "type": "string" + }, + "HlsCdnSettings": { + "$ref": "#/definitions/HlsCdnSettings" + }, + "HlsId3SegmentTagging": { + "type": "string" + }, + "IFrameOnlyPlaylists": { + "type": "string" + }, + "IncompleteSegmentBehavior": { + "type": "string" + }, + "IndexNSegments": { + "type": "integer" + }, + "InputLossAction": { + "type": "string" + }, + "IvInManifest": { + "type": "string" + }, + "IvSource": { + "type": "string" + }, + "KeepSegments": { + "type": "integer" + }, + "KeyFormat": { + "type": "string" + }, + "KeyFormatVersions": { + "type": "string" + }, + "KeyProviderSettings": { + "$ref": "#/definitions/KeyProviderSettings" + }, + "ManifestCompression": { + "type": "string" + }, + "ManifestDurationFormat": { + "type": "string" + }, + "MinSegmentLength": { + "type": "integer" + }, + "Mode": { + "type": "string" + }, + "OutputSelection": { + "type": "string" + }, + "ProgramDateTime": { + "type": "string" + }, + "ProgramDateTimeClock": { + "type": "string" + }, + "ProgramDateTimePeriod": { + "type": "integer" + }, + "RedundantManifest": { + "type": "string" + }, + "SegmentLength": { + "type": "integer" + }, + "SegmentationMode": { + "type": "string" + }, + "SegmentsPerSubdirectory": { + "type": "integer" + }, + "StreamInfResolution": { + "type": "string" + }, + "TimedMetadataId3Frame": { + "type": "string" + }, + "TimedMetadataId3Period": { + "type": "integer" + }, + "TimestampDeltaMilliseconds": { + "type": "integer" + }, + "TsFileMode": { + "type": "string" + } + }, + "type": "object" + }, + "HlsInputSettings": { + "additionalProperties": false, + "properties": { + "Bandwidth": { + "type": "integer" + }, + "BufferSegments": { + "type": "integer" + }, + "Retries": { + "type": "integer" + }, + "RetryInterval": { + "type": "integer" + }, + "Scte35Source": { + "type": "string" + } + }, + "type": "object" + }, + "HlsMediaStoreSettings": { + "additionalProperties": false, + "properties": { + "ConnectionRetryInterval": { + "type": "integer" + }, + "FilecacheDuration": { + "type": "integer" + }, + "MediaStoreStorageClass": { + "type": "string" + }, + "NumRetries": { + "type": "integer" + }, + "RestartDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "HlsOutputSettings": { + "additionalProperties": false, + "properties": { + "H265PackagingType": { + "type": "string" + }, + "HlsSettings": { + "$ref": "#/definitions/HlsSettings" + }, + "NameModifier": { + "type": "string" + }, + "SegmentModifier": { + "type": "string" + } + }, + "type": "object" + }, + "HlsS3Settings": { + "additionalProperties": false, + "properties": { + "CannedAcl": { + "type": "string" + } + }, + "type": "object" + }, + "HlsSettings": { + "additionalProperties": false, + "properties": { + "AudioOnlyHlsSettings": { + "$ref": "#/definitions/AudioOnlyHlsSettings" + }, + "Fmp4HlsSettings": { + "$ref": "#/definitions/Fmp4HlsSettings" + }, + "FrameCaptureHlsSettings": { + "$ref": "#/definitions/FrameCaptureHlsSettings" + }, + "StandardHlsSettings": { + "$ref": "#/definitions/StandardHlsSettings" + } + }, + "type": "object" + }, + "HlsWebdavSettings": { + "additionalProperties": false, + "properties": { + "ConnectionRetryInterval": { + "type": "integer" + }, + "FilecacheDuration": { + "type": "integer" + }, + "HttpTransferMode": { + "type": "string" + }, + "NumRetries": { + "type": "integer" + }, + "RestartDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "HtmlMotionGraphicsSettings": { + "additionalProperties": false, + "type": "object" + }, + "InputAttachment": { + "additionalProperties": false, + "properties": { + "AutomaticInputFailoverSettings": { + "$ref": "#/definitions/AutomaticInputFailoverSettings" + }, + "InputAttachmentName": { + "type": "string" + }, + "InputId": { + "type": "string" + }, + "InputSettings": { + "$ref": "#/definitions/InputSettings" + } + }, + "type": "object" + }, + "InputChannelLevel": { + "additionalProperties": false, + "properties": { + "Gain": { + "type": "integer" + }, + "InputChannel": { + "type": "integer" + } + }, + "type": "object" + }, + "InputLocation": { + "additionalProperties": false, + "properties": { + "PasswordParam": { + "type": "string" + }, + "Uri": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "InputLossBehavior": { + "additionalProperties": false, + "properties": { + "BlackFrameMsec": { + "type": "integer" + }, + "InputLossImageColor": { + "type": "string" + }, + "InputLossImageSlate": { + "$ref": "#/definitions/InputLocation" + }, + "InputLossImageType": { + "type": "string" + }, + "RepeatFrameMsec": { + "type": "integer" + } + }, + "type": "object" + }, + "InputLossFailoverSettings": { + "additionalProperties": false, + "properties": { + "InputLossThresholdMsec": { + "type": "integer" + } + }, + "type": "object" + }, + "InputSettings": { + "additionalProperties": false, + "properties": { + "AudioSelectors": { + "items": { + "$ref": "#/definitions/AudioSelector" + }, + "type": "array", + "uniqueItems": false + }, + "CaptionSelectors": { + "items": { + "$ref": "#/definitions/CaptionSelector" + }, + "type": "array", + "uniqueItems": false + }, + "DeblockFilter": { + "type": "string" + }, + "DenoiseFilter": { + "type": "string" + }, + "FilterStrength": { + "type": "integer" + }, + "InputFilter": { + "type": "string" + }, + "NetworkInputSettings": { + "$ref": "#/definitions/NetworkInputSettings" + }, + "Scte35Pid": { + "type": "integer" + }, + "Smpte2038DataPreference": { + "type": "string" + }, + "SourceEndBehavior": { + "type": "string" + }, + "VideoSelector": { + "$ref": "#/definitions/VideoSelector" + } + }, + "type": "object" + }, + "InputSpecification": { + "additionalProperties": false, + "properties": { + "Codec": { + "type": "string" + }, + "MaximumBitrate": { + "type": "string" + }, + "Resolution": { + "type": "string" + } + }, + "type": "object" + }, + "KeyProviderSettings": { + "additionalProperties": false, + "properties": { + "StaticKeySettings": { + "$ref": "#/definitions/StaticKeySettings" + } + }, + "type": "object" + }, + "M2tsSettings": { + "additionalProperties": false, + "properties": { + "AbsentInputAudioBehavior": { + "type": "string" + }, + "Arib": { + "type": "string" + }, + "AribCaptionsPid": { + "type": "string" + }, + "AribCaptionsPidControl": { + "type": "string" + }, + "AudioBufferModel": { + "type": "string" + }, + "AudioFramesPerPes": { + "type": "integer" + }, + "AudioPids": { + "type": "string" + }, + "AudioStreamType": { + "type": "string" + }, + "Bitrate": { + "type": "integer" + }, + "BufferModel": { + "type": "string" + }, + "CcDescriptor": { + "type": "string" + }, + "DvbNitSettings": { + "$ref": "#/definitions/DvbNitSettings" + }, + "DvbSdtSettings": { + "$ref": "#/definitions/DvbSdtSettings" + }, + "DvbSubPids": { + "type": "string" + }, + "DvbTdtSettings": { + "$ref": "#/definitions/DvbTdtSettings" + }, + "DvbTeletextPid": { + "type": "string" + }, + "Ebif": { + "type": "string" + }, + "EbpAudioInterval": { + "type": "string" + }, + "EbpLookaheadMs": { + "type": "integer" + }, + "EbpPlacement": { + "type": "string" + }, + "EcmPid": { + "type": "string" + }, + "EsRateInPes": { + "type": "string" + }, + "EtvPlatformPid": { + "type": "string" + }, + "EtvSignalPid": { + "type": "string" + }, + "FragmentTime": { + "type": "number" + }, + "Klv": { + "type": "string" + }, + "KlvDataPids": { + "type": "string" + }, + "NielsenId3Behavior": { + "type": "string" + }, + "NullPacketBitrate": { + "type": "number" + }, + "PatInterval": { + "type": "integer" + }, + "PcrControl": { + "type": "string" + }, + "PcrPeriod": { + "type": "integer" + }, + "PcrPid": { + "type": "string" + }, + "PmtInterval": { + "type": "integer" + }, + "PmtPid": { + "type": "string" + }, + "ProgramNum": { + "type": "integer" + }, + "RateMode": { + "type": "string" + }, + "Scte27Pids": { + "type": "string" + }, + "Scte35Control": { + "type": "string" + }, + "Scte35Pid": { + "type": "string" + }, + "Scte35PrerollPullupMilliseconds": { + "type": "number" + }, + "SegmentationMarkers": { + "type": "string" + }, + "SegmentationStyle": { + "type": "string" + }, + "SegmentationTime": { + "type": "number" + }, + "TimedMetadataBehavior": { + "type": "string" + }, + "TimedMetadataPid": { + "type": "string" + }, + "TransportStreamId": { + "type": "integer" + }, + "VideoPid": { + "type": "string" + } + }, + "type": "object" + }, + "M3u8Settings": { + "additionalProperties": false, + "properties": { + "AudioFramesPerPes": { + "type": "integer" + }, + "AudioPids": { + "type": "string" + }, + "EcmPid": { + "type": "string" + }, + "KlvBehavior": { + "type": "string" + }, + "KlvDataPids": { + "type": "string" + }, + "NielsenId3Behavior": { + "type": "string" + }, + "PatInterval": { + "type": "integer" + }, + "PcrControl": { + "type": "string" + }, + "PcrPeriod": { + "type": "integer" + }, + "PcrPid": { + "type": "string" + }, + "PmtInterval": { + "type": "integer" + }, + "PmtPid": { + "type": "string" + }, + "ProgramNum": { + "type": "integer" + }, + "Scte35Behavior": { + "type": "string" + }, + "Scte35Pid": { + "type": "string" + }, + "TimedMetadataBehavior": { + "type": "string" + }, + "TimedMetadataPid": { + "type": "string" + }, + "TransportStreamId": { + "type": "integer" + }, + "VideoPid": { + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceCreateSettings": { + "additionalProperties": false, + "properties": { + "MaintenanceDay": { + "type": "string" + }, + "MaintenanceStartTime": { + "type": "string" + } + }, + "type": "object" + }, + "MediaPackageGroupSettings": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + } + }, + "type": "object" + }, + "MediaPackageOutputDestinationSettings": { + "additionalProperties": false, + "properties": { + "ChannelId": { + "type": "string" + } + }, + "type": "object" + }, + "MediaPackageOutputSettings": { + "additionalProperties": false, + "type": "object" + }, + "MotionGraphicsConfiguration": { + "additionalProperties": false, + "properties": { + "MotionGraphicsInsertion": { + "type": "string" + }, + "MotionGraphicsSettings": { + "$ref": "#/definitions/MotionGraphicsSettings" + } + }, + "type": "object" + }, + "MotionGraphicsSettings": { + "additionalProperties": false, + "properties": { + "HtmlMotionGraphicsSettings": { + "$ref": "#/definitions/HtmlMotionGraphicsSettings" + } + }, + "type": "object" + }, + "Mp2Settings": { + "additionalProperties": false, + "properties": { + "Bitrate": { + "type": "number" + }, + "CodingMode": { + "type": "string" + }, + "SampleRate": { + "type": "number" + } + }, + "type": "object" + }, + "Mpeg2FilterSettings": { + "additionalProperties": false, + "properties": { + "TemporalFilterSettings": { + "$ref": "#/definitions/TemporalFilterSettings" + } + }, + "type": "object" + }, + "Mpeg2Settings": { + "additionalProperties": false, + "properties": { + "AdaptiveQuantization": { + "type": "string" + }, + "AfdSignaling": { + "type": "string" + }, + "ColorMetadata": { + "type": "string" + }, + "ColorSpace": { + "type": "string" + }, + "DisplayAspectRatio": { + "type": "string" + }, + "FilterSettings": { + "$ref": "#/definitions/Mpeg2FilterSettings" + }, + "FixedAfd": { + "type": "string" + }, + "FramerateDenominator": { + "type": "integer" + }, + "FramerateNumerator": { + "type": "integer" + }, + "GopClosedCadence": { + "type": "integer" + }, + "GopNumBFrames": { + "type": "integer" + }, + "GopSize": { + "type": "number" + }, + "GopSizeUnits": { + "type": "string" + }, + "ScanType": { + "type": "string" + }, + "SubgopLength": { + "type": "string" + }, + "TimecodeBurninSettings": { + "$ref": "#/definitions/TimecodeBurninSettings" + }, + "TimecodeInsertion": { + "type": "string" + } + }, + "type": "object" + }, + "MsSmoothGroupSettings": { + "additionalProperties": false, + "properties": { + "AcquisitionPointId": { + "type": "string" + }, + "AudioOnlyTimecodeControl": { + "type": "string" + }, + "CertificateMode": { + "type": "string" + }, + "ConnectionRetryInterval": { + "type": "integer" + }, + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "EventId": { + "type": "string" + }, + "EventIdMode": { + "type": "string" + }, + "EventStopBehavior": { + "type": "string" + }, + "FilecacheDuration": { + "type": "integer" + }, + "FragmentLength": { + "type": "integer" + }, + "InputLossAction": { + "type": "string" + }, + "NumRetries": { + "type": "integer" + }, + "RestartDelay": { + "type": "integer" + }, + "SegmentationMode": { + "type": "string" + }, + "SendDelayMs": { + "type": "integer" + }, + "SparseTrackType": { + "type": "string" + }, + "StreamManifestBehavior": { + "type": "string" + }, + "TimestampOffset": { + "type": "string" + }, + "TimestampOffsetMode": { + "type": "string" + } + }, + "type": "object" + }, + "MsSmoothOutputSettings": { + "additionalProperties": false, + "properties": { + "H265PackagingType": { + "type": "string" + }, + "NameModifier": { + "type": "string" + } + }, + "type": "object" + }, + "MultiplexGroupSettings": { + "additionalProperties": false, + "type": "object" + }, + "MultiplexOutputSettings": { + "additionalProperties": false, + "properties": { + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + } + }, + "type": "object" + }, + "MultiplexProgramChannelDestinationSettings": { + "additionalProperties": false, + "properties": { + "MultiplexId": { + "type": "string" + }, + "ProgramName": { + "type": "string" + } + }, + "type": "object" + }, + "NetworkInputSettings": { + "additionalProperties": false, + "properties": { + "HlsInputSettings": { + "$ref": "#/definitions/HlsInputSettings" + }, + "ServerValidation": { + "type": "string" + } + }, + "type": "object" + }, + "NielsenCBET": { + "additionalProperties": false, + "properties": { + "CbetCheckDigitString": { + "type": "string" + }, + "CbetStepaside": { + "type": "string" + }, + "Csid": { + "type": "string" + } + }, + "type": "object" + }, + "NielsenConfiguration": { + "additionalProperties": false, + "properties": { + "DistributorId": { + "type": "string" + }, + "NielsenPcmToId3Tagging": { + "type": "string" + } + }, + "type": "object" + }, + "NielsenNaesIiNw": { + "additionalProperties": false, + "properties": { + "CheckDigitString": { + "type": "string" + }, + "Sid": { + "type": "number" + }, + "Timezone": { + "type": "string" + } + }, + "type": "object" + }, + "NielsenWatermarksSettings": { + "additionalProperties": false, + "properties": { + "NielsenCbetSettings": { + "$ref": "#/definitions/NielsenCBET" + }, + "NielsenDistributionType": { + "type": "string" + }, + "NielsenNaesIiNwSettings": { + "$ref": "#/definitions/NielsenNaesIiNw" + } + }, + "type": "object" + }, + "Output": { + "additionalProperties": false, + "properties": { + "AudioDescriptionNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "CaptionDescriptionNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "OutputName": { + "type": "string" + }, + "OutputSettings": { + "$ref": "#/definitions/OutputSettings" + }, + "VideoDescriptionName": { + "type": "string" + } + }, + "type": "object" + }, + "OutputDestination": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "MediaPackageSettings": { + "items": { + "$ref": "#/definitions/MediaPackageOutputDestinationSettings" + }, + "type": "array", + "uniqueItems": false + }, + "MultiplexSettings": { + "$ref": "#/definitions/MultiplexProgramChannelDestinationSettings" + }, + "Settings": { + "items": { + "$ref": "#/definitions/OutputDestinationSettings" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OutputDestinationSettings": { + "additionalProperties": false, + "properties": { + "PasswordParam": { + "type": "string" + }, + "StreamName": { + "type": "string" + }, + "Url": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "OutputGroup": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "OutputGroupSettings": { + "$ref": "#/definitions/OutputGroupSettings" + }, + "Outputs": { + "items": { + "$ref": "#/definitions/Output" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OutputGroupSettings": { + "additionalProperties": false, + "properties": { + "ArchiveGroupSettings": { + "$ref": "#/definitions/ArchiveGroupSettings" + }, + "CmafIngestGroupSettings": { + "$ref": "#/definitions/CmafIngestGroupSettings" + }, + "FrameCaptureGroupSettings": { + "$ref": "#/definitions/FrameCaptureGroupSettings" + }, + "HlsGroupSettings": { + "$ref": "#/definitions/HlsGroupSettings" + }, + "MediaPackageGroupSettings": { + "$ref": "#/definitions/MediaPackageGroupSettings" + }, + "MsSmoothGroupSettings": { + "$ref": "#/definitions/MsSmoothGroupSettings" + }, + "MultiplexGroupSettings": { + "$ref": "#/definitions/MultiplexGroupSettings" + }, + "RtmpGroupSettings": { + "$ref": "#/definitions/RtmpGroupSettings" + }, + "UdpGroupSettings": { + "$ref": "#/definitions/UdpGroupSettings" + } + }, + "type": "object" + }, + "OutputLocationRef": { + "additionalProperties": false, + "properties": { + "DestinationRefId": { + "type": "string" + } + }, + "type": "object" + }, + "OutputLockingSettings": { + "additionalProperties": false, + "properties": { + "EpochLockingSettings": { + "$ref": "#/definitions/EpochLockingSettings" + }, + "PipelineLockingSettings": { + "$ref": "#/definitions/PipelineLockingSettings" + } + }, + "type": "object" + }, + "OutputSettings": { + "additionalProperties": false, + "properties": { + "ArchiveOutputSettings": { + "$ref": "#/definitions/ArchiveOutputSettings" + }, + "CmafIngestOutputSettings": { + "$ref": "#/definitions/CmafIngestOutputSettings" + }, + "FrameCaptureOutputSettings": { + "$ref": "#/definitions/FrameCaptureOutputSettings" + }, + "HlsOutputSettings": { + "$ref": "#/definitions/HlsOutputSettings" + }, + "MediaPackageOutputSettings": { + "$ref": "#/definitions/MediaPackageOutputSettings" + }, + "MsSmoothOutputSettings": { + "$ref": "#/definitions/MsSmoothOutputSettings" + }, + "MultiplexOutputSettings": { + "$ref": "#/definitions/MultiplexOutputSettings" + }, + "RtmpOutputSettings": { + "$ref": "#/definitions/RtmpOutputSettings" + }, + "UdpOutputSettings": { + "$ref": "#/definitions/UdpOutputSettings" + } + }, + "type": "object" + }, + "PassThroughSettings": { + "additionalProperties": false, + "type": "object" + }, + "PipelineLockingSettings": { + "additionalProperties": false, + "type": "object" + }, + "RawSettings": { + "additionalProperties": false, + "type": "object" + }, + "Rec601Settings": { + "additionalProperties": false, + "type": "object" + }, + "Rec709Settings": { + "additionalProperties": false, + "type": "object" + }, + "RemixSettings": { + "additionalProperties": false, + "properties": { + "ChannelMappings": { + "items": { + "$ref": "#/definitions/AudioChannelMapping" + }, + "type": "array", + "uniqueItems": false + }, + "ChannelsIn": { + "type": "integer" + }, + "ChannelsOut": { + "type": "integer" + } + }, + "type": "object" + }, + "RtmpCaptionInfoDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "RtmpGroupSettings": { + "additionalProperties": false, + "properties": { + "AdMarkers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AuthenticationScheme": { + "type": "string" + }, + "CacheFullBehavior": { + "type": "string" + }, + "CacheLength": { + "type": "integer" + }, + "CaptionData": { + "type": "string" + }, + "IncludeFillerNalUnits": { + "type": "string" + }, + "InputLossAction": { + "type": "string" + }, + "RestartDelay": { + "type": "integer" + } + }, + "type": "object" + }, + "RtmpOutputSettings": { + "additionalProperties": false, + "properties": { + "CertificateMode": { + "type": "string" + }, + "ConnectionRetryInterval": { + "type": "integer" + }, + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "NumRetries": { + "type": "integer" + } + }, + "type": "object" + }, + "Scte20PlusEmbeddedDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "Scte20SourceSettings": { + "additionalProperties": false, + "properties": { + "Convert608To708": { + "type": "string" + }, + "Source608ChannelNumber": { + "type": "integer" + } + }, + "type": "object" + }, + "Scte27DestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "Scte27SourceSettings": { + "additionalProperties": false, + "properties": { + "OcrLanguage": { + "type": "string" + }, + "Pid": { + "type": "integer" + } + }, + "type": "object" + }, + "Scte35SpliceInsert": { + "additionalProperties": false, + "properties": { + "AdAvailOffset": { + "type": "integer" + }, + "NoRegionalBlackoutFlag": { + "type": "string" + }, + "WebDeliveryAllowedFlag": { + "type": "string" + } + }, + "type": "object" + }, + "Scte35TimeSignalApos": { + "additionalProperties": false, + "properties": { + "AdAvailOffset": { + "type": "integer" + }, + "NoRegionalBlackoutFlag": { + "type": "string" + }, + "WebDeliveryAllowedFlag": { + "type": "string" + } + }, + "type": "object" + }, + "SmpteTtDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "StandardHlsSettings": { + "additionalProperties": false, + "properties": { + "AudioRenditionSets": { + "type": "string" + }, + "M3u8Settings": { + "$ref": "#/definitions/M3u8Settings" + } + }, + "type": "object" + }, + "StaticKeySettings": { + "additionalProperties": false, + "properties": { + "KeyProviderServer": { + "$ref": "#/definitions/InputLocation" + }, + "StaticKeyValue": { + "type": "string" + } + }, + "type": "object" + }, + "TeletextDestinationSettings": { + "additionalProperties": false, + "type": "object" + }, + "TeletextSourceSettings": { + "additionalProperties": false, + "properties": { + "OutputRectangle": { + "$ref": "#/definitions/CaptionRectangle" + }, + "PageNumber": { + "type": "string" + } + }, + "type": "object" + }, + "TemporalFilterSettings": { + "additionalProperties": false, + "properties": { + "PostFilterSharpening": { + "type": "string" + }, + "Strength": { + "type": "string" + } + }, + "type": "object" + }, + "ThumbnailConfiguration": { + "additionalProperties": false, + "properties": { + "State": { + "type": "string" + } + }, + "type": "object" + }, + "TimecodeBurninSettings": { + "additionalProperties": false, + "properties": { + "FontSize": { + "type": "string" + }, + "Position": { + "type": "string" + }, + "Prefix": { + "type": "string" + } + }, + "type": "object" + }, + "TimecodeConfig": { + "additionalProperties": false, + "properties": { + "Source": { + "type": "string" + }, + "SyncThreshold": { + "type": "integer" + } + }, + "type": "object" + }, + "TtmlDestinationSettings": { + "additionalProperties": false, + "properties": { + "StyleControl": { + "type": "string" + } + }, + "type": "object" + }, + "UdpContainerSettings": { + "additionalProperties": false, + "properties": { + "M2tsSettings": { + "$ref": "#/definitions/M2tsSettings" + } + }, + "type": "object" + }, + "UdpGroupSettings": { + "additionalProperties": false, + "properties": { + "InputLossAction": { + "type": "string" + }, + "TimedMetadataId3Frame": { + "type": "string" + }, + "TimedMetadataId3Period": { + "type": "integer" + } + }, + "type": "object" + }, + "UdpOutputSettings": { + "additionalProperties": false, + "properties": { + "BufferMsec": { + "type": "integer" + }, + "ContainerSettings": { + "$ref": "#/definitions/UdpContainerSettings" + }, + "Destination": { + "$ref": "#/definitions/OutputLocationRef" + }, + "FecOutputSettings": { + "$ref": "#/definitions/FecOutputSettings" + } + }, + "type": "object" + }, + "VideoBlackFailoverSettings": { + "additionalProperties": false, + "properties": { + "BlackDetectThreshold": { + "type": "number" + }, + "VideoBlackThresholdMsec": { + "type": "integer" + } + }, + "type": "object" + }, + "VideoCodecSettings": { + "additionalProperties": false, + "properties": { + "FrameCaptureSettings": { + "$ref": "#/definitions/FrameCaptureSettings" + }, + "H264Settings": { + "$ref": "#/definitions/H264Settings" + }, + "H265Settings": { + "$ref": "#/definitions/H265Settings" + }, + "Mpeg2Settings": { + "$ref": "#/definitions/Mpeg2Settings" + } + }, + "type": "object" + }, + "VideoDescription": { + "additionalProperties": false, + "properties": { + "CodecSettings": { + "$ref": "#/definitions/VideoCodecSettings" + }, + "Height": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "RespondToAfd": { + "type": "string" + }, + "ScalingBehavior": { + "type": "string" + }, + "Sharpness": { + "type": "integer" + }, + "Width": { + "type": "integer" + } + }, + "type": "object" + }, + "VideoSelector": { + "additionalProperties": false, + "properties": { + "ColorSpace": { + "type": "string" + }, + "ColorSpaceSettings": { + "$ref": "#/definitions/VideoSelectorColorSpaceSettings" + }, + "ColorSpaceUsage": { + "type": "string" + }, + "SelectorSettings": { + "$ref": "#/definitions/VideoSelectorSettings" + } + }, + "type": "object" + }, + "VideoSelectorColorSpaceSettings": { + "additionalProperties": false, + "properties": { + "Hdr10Settings": { + "$ref": "#/definitions/Hdr10Settings" + } + }, + "type": "object" + }, + "VideoSelectorPid": { + "additionalProperties": false, + "properties": { + "Pid": { + "type": "integer" + } + }, + "type": "object" + }, + "VideoSelectorProgramId": { + "additionalProperties": false, + "properties": { + "ProgramId": { + "type": "integer" + } + }, + "type": "object" + }, + "VideoSelectorSettings": { + "additionalProperties": false, + "properties": { + "VideoSelectorPid": { + "$ref": "#/definitions/VideoSelectorPid" + }, + "VideoSelectorProgramId": { + "$ref": "#/definitions/VideoSelectorProgramId" + } + }, + "type": "object" + }, + "VpcOutputSettings": { + "additionalProperties": false, + "properties": { + "PublicAddressAllocationIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "WavSettings": { + "additionalProperties": false, + "properties": { + "BitDepth": { + "type": "number" + }, + "CodingMode": { + "type": "string" + }, + "SampleRate": { + "type": "number" + } + }, + "type": "object" + }, + "WebvttDestinationSettings": { + "additionalProperties": false, + "properties": { + "StyleControl": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MediaLive::Channel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "CdiInputSpecification": { + "$ref": "#/definitions/CdiInputSpecification" + }, + "ChannelClass": { + "type": "string" + }, + "Destinations": { + "items": { + "$ref": "#/definitions/OutputDestination" + }, + "type": "array", + "uniqueItems": false + }, + "EncoderSettings": { + "$ref": "#/definitions/EncoderSettings" + }, + "Id": { + "type": "string" + }, + "InputAttachments": { + "items": { + "$ref": "#/definitions/InputAttachment" + }, + "type": "array", + "uniqueItems": false + }, + "InputSpecification": { + "$ref": "#/definitions/InputSpecification" + }, + "Inputs": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "LogLevel": { + "type": "string" + }, + "Maintenance": { + "$ref": "#/definitions/MaintenanceCreateSettings" + }, + "Name": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "Vpc": { + "$ref": "#/definitions/VpcOutputSettings" + } + }, + "readOnlyProperties": [ + "/properties/Inputs", + "/properties/Id", + "/properties/Arn" + ], + "typeName": "AWS::MediaLive::Channel" +} diff --git a/schema/aws-medialive-channelplacementgroup.json b/schema/aws-medialive-channelplacementgroup.json new file mode 100644 index 0000000..0cfdc26 --- /dev/null +++ b/schema/aws-medialive-channelplacementgroup.json @@ -0,0 +1,145 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterId" + ], + "definitions": { + "ChannelPlacementGroupState": { + "description": "The current state of the ChannelPlacementGroupState", + "enum": [ + "UNASSIGNED", + "ASSIGNING", + "ASSIGNED", + "DELETING", + "DELETED", + "UNASSIGNING" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::ChannelPlacementGroup Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateChannelPlacementGroup", + "medialive:DescribeChannelPlacementGroup", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteChannelPlacementGroup", + "medialive:DescribeChannelPlacementGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterId": { + "$ref": "resource-schema.json#/properties/ClusterId" + } + }, + "required": [ + "ClusterId" + ] + }, + "permissions": [ + "medialive:ListChannelPlacementGroups" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeChannelPlacementGroup" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateChannelPlacementGroup", + "medialive:DescribeChannelPlacementGroup", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id", + "/properties/ClusterId" + ], + "properties": { + "Arn": { + "description": "The ARN of the channel placement group.", + "type": "string" + }, + "Channels": { + "description": "List of channel IDs added to the channel placement group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "ClusterId": { + "description": "The ID of the cluster the node is on.", + "type": "string" + }, + "Id": { + "description": "Unique internal identifier.", + "type": "string" + }, + "Name": { + "description": "The name of the channel placement group.", + "type": "string" + }, + "Nodes": { + "description": "List of nodes added to the channel placement group", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "State": { + "$ref": "#/definitions/ChannelPlacementGroupState" + }, + "Tags": { + "description": "A collection of key-value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Channels", + "/properties/Id", + "/properties/State" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-medialive.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaLive::ChannelPlacementGroup" +} diff --git a/schema/aws-medialive-cloudwatchalarmtemplate.json b/schema/aws-medialive-cloudwatchalarmtemplate.json new file mode 100644 index 0000000..2fdbfea --- /dev/null +++ b/schema/aws-medialive-cloudwatchalarmtemplate.json @@ -0,0 +1,229 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags" + ], + "definitions": { + "CloudWatchAlarmTemplateComparisonOperator": { + "description": "The comparison operator used to compare the specified statistic and the threshold.", + "enum": [ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ], + "type": "string" + }, + "CloudWatchAlarmTemplateStatistic": { + "description": "The statistic to apply to the alarm's metric data.", + "enum": [ + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum" + ], + "type": "string" + }, + "CloudWatchAlarmTemplateTargetResourceType": { + "description": "The resource type this template should dynamically generate cloudwatch metric alarms for.", + "enum": [ + "CLOUDFRONT_DISTRIBUTION", + "MEDIALIVE_MULTIPLEX", + "MEDIALIVE_CHANNEL", + "MEDIALIVE_INPUT_DEVICE", + "MEDIAPACKAGE_CHANNEL", + "MEDIAPACKAGE_ORIGIN_ENDPOINT", + "MEDIACONNECT_FLOW", + "S3_BUCKET" + ], + "type": "string" + }, + "CloudWatchAlarmTemplateTreatMissingData": { + "description": "Specifies how missing data points are treated when evaluating the alarm's condition.", + "enum": [ + "notBreaching", + "breaching", + "ignore", + "missing" + ], + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "description": "Represents the tags associated with a resource.", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateCloudWatchAlarmTemplate", + "medialive:GetCloudWatchAlarmTemplate", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteCloudWatchAlarmTemplate" + ] + }, + "list": { + "permissions": [ + "medialive:ListCloudWatchAlarmTemplates" + ] + }, + "read": { + "permissions": [ + "medialive:GetCloudWatchAlarmTemplate" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateCloudWatchAlarmTemplate", + "medialive:GetCloudWatchAlarmTemplate", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Identifier" + ], + "properties": { + "Arn": { + "description": "A cloudwatch alarm template's ARN (Amazon Resource Name)", + "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$", + "type": "string" + }, + "ComparisonOperator": { + "$ref": "#/definitions/CloudWatchAlarmTemplateComparisonOperator" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DatapointsToAlarm": { + "default": 0, + "description": "The number of datapoints within the evaluation period that must be breaching to trigger the alarm.", + "minimum": 1, + "type": "number" + }, + "Description": { + "description": "A resource's optional description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "EvaluationPeriods": { + "default": 0, + "description": "The number of periods over which data is compared to the specified threshold.", + "minimum": 1, + "type": "number" + }, + "GroupId": { + "description": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "GroupIdentifier": { + "description": "A cloudwatch alarm template group's identifier. Can be either be its id or current name.", + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Id": { + "description": "A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "Identifier": { + "type": "string" + }, + "MetricName": { + "description": "The name of the metric associated with the alarm. Must be compatible with targetResourceType.", + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Period": { + "default": 0, + "description": "The period, in seconds, over which the specified statistic is applied.", + "maximum": 86400, + "minimum": 10, + "type": "number" + }, + "Statistic": { + "$ref": "#/definitions/CloudWatchAlarmTemplateStatistic" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "TargetResourceType": { + "$ref": "#/definitions/CloudWatchAlarmTemplateTargetResourceType" + }, + "Threshold": { + "default": 0, + "description": "The threshold value to compare with the specified statistic.", + "type": "number" + }, + "TreatMissingData": { + "$ref": "#/definitions/CloudWatchAlarmTemplateTreatMissingData" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/GroupId", + "/properties/Identifier", + "/properties/ModifiedAt" + ], + "required": [ + "ComparisonOperator", + "EvaluationPeriods", + "GroupIdentifier", + "MetricName", + "Name", + "Period", + "Statistic", + "TargetResourceType", + "Threshold", + "TreatMissingData" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::CloudWatchAlarmTemplate", + "writeOnlyProperties": [ + "/properties/GroupIdentifier" + ] +} diff --git a/schema/aws-medialive-cloudwatchalarmtemplategroup.json b/schema/aws-medialive-cloudwatchalarmtemplategroup.json new file mode 100644 index 0000000..e7e5b91 --- /dev/null +++ b/schema/aws-medialive-cloudwatchalarmtemplategroup.json @@ -0,0 +1,118 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "TagMap": { + "additionalProperties": false, + "description": "Represents the tags associated with a resource.", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateCloudWatchAlarmTemplateGroup", + "medialive:GetCloudWatchAlarmTemplateGroup", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteCloudWatchAlarmTemplateGroup" + ] + }, + "list": { + "permissions": [ + "medialive:ListCloudWatchAlarmTemplateGroups" + ] + }, + "read": { + "permissions": [ + "medialive:GetCloudWatchAlarmTemplateGroup" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateCloudWatchAlarmTemplateGroup", + "medialive:GetCloudWatchAlarmTemplateGroup", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Identifier" + ], + "properties": { + "Arn": { + "description": "A cloudwatch alarm template group's ARN (Amazon Resource Name)", + "pattern": "^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$", + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A resource's optional description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Id": { + "description": "A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "Identifier": { + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/Identifier", + "/properties/ModifiedAt" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::CloudWatchAlarmTemplateGroup" +} diff --git a/schema/aws-medialive-cluster.json b/schema/aws-medialive-cluster.json new file mode 100644 index 0000000..ecf7489 --- /dev/null +++ b/schema/aws-medialive-cluster.json @@ -0,0 +1,198 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterType", + "/properties/InstanceRoleArn" + ], + "definitions": { + "ClusterNetworkSettings": { + "additionalProperties": false, + "description": "On premises settings which will have the interface network mappings and default Output logical interface", + "properties": { + "DefaultRoute": { + "description": "Default value if the customer does not define it in channel Output API", + "type": "string" + }, + "InterfaceMappings": { + "description": "Network mappings for the cluster", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InterfaceMapping" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClusterState": { + "description": "The current state of the Cluster.", + "enum": [ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "DELETING", + "DELETED" + ], + "type": "string" + }, + "ClusterType": { + "description": "The hardware type for the cluster.", + "enum": [ + "ON_PREMISES", + "OUTPOSTS_RACK", + "OUTPOSTS_SERVER", + "EC2" + ], + "type": "string" + }, + "InterfaceMapping": { + "additionalProperties": false, + "description": "Network mappings for the cluster", + "properties": { + "LogicalInterfaceName": { + "description": "logical interface name, unique in the list", + "type": "string" + }, + "NetworkId": { + "description": "Network Id to be associated with the logical interface name, can be duplicated in list", + "type": "string" + } + }, + "type": "object" + }, + "InterfaceNetworkMapping": { + "additionalProperties": false, + "description": "Network mappings for the cluster", + "properties": { + "LogicalInterfaceName": { + "description": "logical interface name, unique in the list", + "type": "string" + }, + "NetworkId": { + "description": "Network Id to be associated with the logical interface name, can be duplicated in list", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::Cluster Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateCluster", + "medialive:DescribeCluster", + "medialive:CreateTags", + "ecs:CreateCluster", + "ecs:RegisterTaskDefinition", + "ecs:TagResource", + "ecs:CreateService", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteCluster", + "medialive:DescribeCluster" + ] + }, + "list": { + "permissions": [ + "medialive:ListClusters" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeCluster" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateCluster", + "medialive:DescribeCluster", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the Cluster.", + "pattern": "^arn:.+:medialive:.+:cluster:.+$", + "type": "string" + }, + "ChannelIds": { + "description": "The MediaLive Channels that are currently running on Nodes in this Cluster.", + "insertionOrder": false, + "items": { + "description": "MediaLive Channel Ids", + "type": "string" + }, + "type": "array" + }, + "ClusterType": { + "$ref": "#/definitions/ClusterType" + }, + "Id": { + "description": "The unique ID of the Cluster.", + "type": "string" + }, + "InstanceRoleArn": { + "description": "The IAM role your nodes will use.", + "pattern": "^arn:.+:iam:.+:role/.+$", + "type": "string" + }, + "Name": { + "description": "The user-specified name of the Cluster to be created.", + "type": "string" + }, + "NetworkSettings": { + "$ref": "#/definitions/ClusterNetworkSettings" + }, + "State": { + "$ref": "#/definitions/ClusterState" + }, + "Tags": { + "description": "A collection of key-value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ChannelIds", + "/properties/Id", + "/properties/State" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::Cluster" +} diff --git a/schema/aws-medialive-eventbridgeruletemplate.json b/schema/aws-medialive-eventbridgeruletemplate.json new file mode 100644 index 0000000..fa1825c --- /dev/null +++ b/schema/aws-medialive-eventbridgeruletemplate.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags" + ], + "definitions": { + "EventBridgeRuleTemplateEventType": { + "description": "The type of event to match with the rule.", + "enum": [ + "MEDIALIVE_MULTIPLEX_ALERT", + "MEDIALIVE_MULTIPLEX_STATE_CHANGE", + "MEDIALIVE_CHANNEL_ALERT", + "MEDIALIVE_CHANNEL_INPUT_CHANGE", + "MEDIALIVE_CHANNEL_STATE_CHANGE", + "MEDIAPACKAGE_INPUT_NOTIFICATION", + "MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION", + "MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION", + "SIGNAL_MAP_ACTIVE_ALARM", + "MEDIACONNECT_ALERT", + "MEDIACONNECT_SOURCE_HEALTH", + "MEDIACONNECT_OUTPUT_HEALTH", + "MEDIACONNECT_FLOW_STATUS_CHANGE" + ], + "type": "string" + }, + "EventBridgeRuleTemplateTarget": { + "additionalProperties": false, + "description": "The target to which to send matching events.", + "properties": { + "Arn": { + "description": "Target ARNs must be either an SNS topic or CloudWatch log group.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn.+$", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "description": "Represents the tags associated with a resource.", + "patternProperties": { + ".+": { + "description": "Placeholder documentation for __string", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateEventBridgeRuleTemplate", + "medialive:GetEventBridgeRuleTemplate", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteEventBridgeRuleTemplate" + ] + }, + "list": { + "permissions": [ + "medialive:ListEventBridgeRuleTemplates" + ] + }, + "read": { + "permissions": [ + "medialive:GetEventBridgeRuleTemplate" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateEventBridgeRuleTemplate", + "medialive:GetEventBridgeRuleTemplate", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Identifier" + ], + "properties": { + "Arn": { + "description": "An eventbridge rule template's ARN (Amazon Resource Name)", + "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template:.+$", + "type": "string" + }, + "CreatedAt": { + "description": "Placeholder documentation for __timestampIso8601", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A resource's optional description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "EventTargets": { + "description": "Placeholder documentation for __listOfEventBridgeRuleTemplateTarget", + "items": { + "$ref": "#/definitions/EventBridgeRuleTemplateTarget" + }, + "type": "array" + }, + "EventType": { + "$ref": "#/definitions/EventBridgeRuleTemplateEventType" + }, + "GroupId": { + "description": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "GroupIdentifier": { + "description": "An eventbridge rule template group's identifier. Can be either be its id or current name.", + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Id": { + "description": "An eventbridge rule template's id. AWS provided templates have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "Identifier": { + "description": "Placeholder documentation for __string", + "type": "string" + }, + "ModifiedAt": { + "description": "Placeholder documentation for __timestampIso8601", + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/GroupId", + "/properties/Id", + "/properties/Identifier", + "/properties/ModifiedAt" + ], + "required": [ + "EventType", + "GroupIdentifier", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::EventBridgeRuleTemplate", + "writeOnlyProperties": [ + "/properties/GroupIdentifier" + ] +} diff --git a/schema/aws-medialive-eventbridgeruletemplategroup.json b/schema/aws-medialive-eventbridgeruletemplategroup.json new file mode 100644 index 0000000..658b513 --- /dev/null +++ b/schema/aws-medialive-eventbridgeruletemplategroup.json @@ -0,0 +1,118 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "TagMap": { + "additionalProperties": false, + "description": "Represents the tags associated with a resource.", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::EventBridgeRuleTemplateGroup Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateEventBridgeRuleTemplateGroup", + "medialive:GetEventBridgeRuleTemplateGroup", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteEventBridgeRuleTemplateGroup" + ] + }, + "list": { + "permissions": [ + "medialive:ListEventBridgeRuleTemplateGroups" + ] + }, + "read": { + "permissions": [ + "medialive:GetEventBridgeRuleTemplateGroup" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateEventBridgeRuleTemplateGroup", + "medialive:GetEventBridgeRuleTemplateGroup", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Identifier" + ], + "properties": { + "Arn": { + "description": "An eventbridge rule template group's ARN (Amazon Resource Name)", + "pattern": "^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$", + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A resource's optional description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Id": { + "description": "An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "Identifier": { + "type": "string" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/Identifier", + "/properties/ModifiedAt" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::EventBridgeRuleTemplateGroup" +} diff --git a/schema/aws-medialive-input.json b/schema/aws-medialive-input.json index a5d32b5..eb2441d 100644 --- a/schema/aws-medialive-input.json +++ b/schema/aws-medialive-input.json @@ -1,138 +1,187 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Vpc", - "/properties/Type" - ], - "definitions": { - "InputDestinationRequest": { - "additionalProperties": false, - "properties": { - "StreamName": { - "type": "string" - } - }, - "type": "object" - }, - "InputDeviceSettings": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - } - }, - "type": "object" - }, - "InputSourceRequest": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "InputVpcRequest": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "MediaConnectFlowRequest": { - "additionalProperties": false, - "properties": { - "FlowArn": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MediaLive::Input", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Destinations": { - "items": { - "$ref": "#/definitions/InputDestinationRequest" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "InputDevices": { - "items": { - "$ref": "#/definitions/InputDeviceSettings" - }, - "type": "array", - "uniqueItems": false - }, - "InputSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MediaConnectFlows": { - "items": { - "$ref": "#/definitions/MediaConnectFlowRequest" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Sources": { - "items": { - "$ref": "#/definitions/InputSourceRequest" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "type": "object" - }, - "Type": { - "type": "string" - }, - "Vpc": { - "$ref": "#/definitions/InputVpcRequest" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "typeName": "AWS::MediaLive::Input" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Vpc", + "/properties/Type" + ], + "definitions": { + "InputDestinationRequest": { + "additionalProperties": false, + "properties": { + "StreamName": { + "type": "string" + } + }, + "type": "object" + }, + "InputDeviceSettings": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + } + }, + "type": "object" + }, + "InputSourceRequest": { + "additionalProperties": false, + "properties": { + "PasswordParam": { + "type": "string" + }, + "Url": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "InputVpcRequest": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "MediaConnectFlowRequest": { + "additionalProperties": false, + "properties": { + "FlowArn": { + "type": "string" + } + }, + "type": "object" + }, + "SrtCallerDecryptionRequest": { + "additionalProperties": false, + "properties": { + "Algorithm": { + "type": "string" + }, + "PassphraseSecretArn": { + "type": "string" + } + }, + "type": "object" + }, + "SrtCallerSourceRequest": { + "additionalProperties": false, + "properties": { + "Decryption": { + "$ref": "#/definitions/SrtCallerDecryptionRequest" + }, + "MinimumLatency": { + "type": "integer" + }, + "SrtListenerAddress": { + "type": "string" + }, + "SrtListenerPort": { + "type": "string" + }, + "StreamId": { + "type": "string" + } + }, + "type": "object" + }, + "SrtSettingsRequest": { + "additionalProperties": false, + "properties": { + "SrtCallerSources": { + "items": { + "$ref": "#/definitions/SrtCallerSourceRequest" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MediaLive::Input", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Destinations": { + "items": { + "$ref": "#/definitions/InputDestinationRequest" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "InputDevices": { + "items": { + "$ref": "#/definitions/InputDeviceSettings" + }, + "type": "array", + "uniqueItems": false + }, + "InputSecurityGroups": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MediaConnectFlows": { + "items": { + "$ref": "#/definitions/MediaConnectFlowRequest" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "Sources": { + "items": { + "$ref": "#/definitions/InputSourceRequest" + }, + "type": "array", + "uniqueItems": false + }, + "SrtSettings": { + "$ref": "#/definitions/SrtSettingsRequest" + }, + "Tags": { + "type": "object" + }, + "Type": { + "type": "string" + }, + "Vpc": { + "$ref": "#/definitions/InputVpcRequest" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "typeName": "AWS::MediaLive::Input" +} diff --git a/schema/aws-medialive-inputsecuritygroup.json b/schema/aws-medialive-inputsecuritygroup.json index 089370b..86ac945 100644 --- a/schema/aws-medialive-inputsecuritygroup.json +++ b/schema/aws-medialive-inputsecuritygroup.json @@ -1,41 +1,41 @@ -{ - "additionalProperties": false, - "definitions": { - "InputWhitelistRuleCidr": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MediaLive::InputSecurityGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "WhitelistRules": { - "items": { - "$ref": "#/definitions/InputWhitelistRuleCidr" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "typeName": "AWS::MediaLive::InputSecurityGroup" -} +{ + "additionalProperties": false, + "definitions": { + "InputWhitelistRuleCidr": { + "additionalProperties": false, + "properties": { + "Cidr": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MediaLive::InputSecurityGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "WhitelistRules": { + "items": { + "$ref": "#/definitions/InputWhitelistRuleCidr" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "typeName": "AWS::MediaLive::InputSecurityGroup" +} diff --git a/schema/aws-medialive-multiplex.json b/schema/aws-medialive-multiplex.json index fd260d2..5d56052 100644 --- a/schema/aws-medialive-multiplex.json +++ b/schema/aws-medialive-multiplex.json @@ -1,196 +1,200 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AvailabilityZones" - ], - "definitions": { - "MultiplexOutputDestination": { - "additionalProperties": false, - "description": "Multiplex MediaConnect output destination settings.", - "properties": { - "MultiplexMediaConnectOutputDestinationSettings": { - "additionalProperties": false, - "description": "Multiplex MediaConnect output destination settings.", - "properties": { - "EntitlementArn": { - "description": "The MediaConnect entitlement ARN available as a Flow source.", - "minLength": 1, - "type": "string" - } - } - } - }, - "type": "object" - }, - "MultiplexSettings": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "MaximumVideoBufferDelayMilliseconds": { - "description": "Maximum video buffer delay in milliseconds.", - "maximum": 3000, - "minimum": 800, - "type": "integer" - }, - "TransportStreamBitrate": { - "description": "Transport stream bit rate.", - "maximum": 100000000, - "minimum": 1000000, - "type": "integer" - }, - "TransportStreamId": { - "description": "Transport stream ID.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "TransportStreamReservedBitrate": { - "description": "Transport stream reserved bit rate.", - "maximum": 100000000, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "TransportStreamBitrate", - "TransportStreamId" - ], - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaLive::Multiplex", - "handlers": { - "create": { - "permissions": [ - "medialive:CreateMultiplex", - "medialive:DescribeMultiplex", - "medialive:CreateTags" - ] - }, - "delete": { - "permissions": [ - "medialive:DeleteMultiplex", - "medialive:DescribeMultiplex" - ] - }, - "list": { - "permissions": [ - "medialive:ListMultiplexes" - ] - }, - "read": { - "permissions": [ - "medialive:DescribeMultiplex" - ] - }, - "update": { - "permissions": [ - "medialive:UpdateMultiplex", - "medialive:DescribeMultiplex", - "medialive:CreateTags", - "medialive:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The unique arn of the multiplex.", - "type": "string" - }, - "AvailabilityZones": { - "description": "A list of availability zones for the multiplex.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Destinations": { - "description": "A list of the multiplex output destinations.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MultiplexOutputDestination" - }, - "type": "array" - }, - "Id": { - "description": "The unique id of the multiplex.", - "type": "string" - }, - "MultiplexSettings": { - "$ref": "#/definitions/MultiplexSettings", - "description": "Configuration for a multiplex event." - }, - "Name": { - "description": "Name of multiplex.", - "type": "string" - }, - "PipelinesRunningCount": { - "description": "The number of currently healthy pipelines.", - "type": "integer" - }, - "ProgramCount": { - "description": "The number of programs in the multiplex.", - "type": "integer" - }, - "State": { - "enum": [ - "CREATING", - "CREATE_FAILED", - "IDLE", - "STARTING", - "RUNNING", - "RECOVERING", - "STOPPING", - "DELETING", - "DELETED" - ], - "type": "string" - }, - "Tags": { - "description": "A collection of key-value pairs.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/PipelinesRunningCount", - "/properties/ProgramCount", - "/properties/State" - ], - "required": [ - "AvailabilityZones", - "MultiplexSettings", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-medialive.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaLive::Multiplex" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AvailabilityZones" + ], + "definitions": { + "MultiplexOutputDestination": { + "additionalProperties": false, + "description": "Multiplex MediaConnect output destination settings.", + "properties": { + "MultiplexMediaConnectOutputDestinationSettings": { + "additionalProperties": false, + "description": "Multiplex MediaConnect output destination settings.", + "properties": { + "EntitlementArn": { + "description": "The MediaConnect entitlement ARN available as a Flow source.", + "minLength": 1, + "type": "string" + } + } + } + }, + "type": "object" + }, + "MultiplexSettings": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "MaximumVideoBufferDelayMilliseconds": { + "description": "Maximum video buffer delay in milliseconds.", + "maximum": 3000, + "minimum": 800, + "type": "integer" + }, + "TransportStreamBitrate": { + "description": "Transport stream bit rate.", + "maximum": 100000000, + "minimum": 1000000, + "type": "integer" + }, + "TransportStreamId": { + "description": "Transport stream ID.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "TransportStreamReservedBitrate": { + "description": "Transport stream reserved bit rate.", + "maximum": 100000000, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "TransportStreamBitrate", + "TransportStreamId" + ], + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaLive::Multiplex", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateMultiplex", + "medialive:DescribeMultiplex", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteMultiplex", + "medialive:DescribeMultiplex" + ] + }, + "list": { + "permissions": [ + "medialive:ListMultiplexes" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeMultiplex" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateMultiplex", + "medialive:DescribeMultiplex", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The unique arn of the multiplex.", + "type": "string" + }, + "AvailabilityZones": { + "description": "A list of availability zones for the multiplex.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Destinations": { + "description": "A list of the multiplex output destinations.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MultiplexOutputDestination" + }, + "type": "array" + }, + "Id": { + "description": "The unique id of the multiplex.", + "type": "string" + }, + "MultiplexSettings": { + "$ref": "#/definitions/MultiplexSettings", + "description": "Configuration for a multiplex event." + }, + "Name": { + "description": "Name of multiplex.", + "type": "string" + }, + "PipelinesRunningCount": { + "description": "The number of currently healthy pipelines.", + "type": "integer" + }, + "ProgramCount": { + "description": "The number of programs in the multiplex.", + "type": "integer" + }, + "State": { + "enum": [ + "CREATING", + "CREATE_FAILED", + "IDLE", + "STARTING", + "RUNNING", + "RECOVERING", + "STOPPING", + "DELETING", + "DELETED" + ], + "type": "string" + }, + "Tags": { + "description": "A collection of key-value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/PipelinesRunningCount", + "/properties/ProgramCount", + "/properties/State" + ], + "required": [ + "AvailabilityZones", + "MultiplexSettings", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-medialive.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::Multiplex" +} diff --git a/schema/aws-medialive-multiplexprogram.json b/schema/aws-medialive-multiplexprogram.json index aa6888f..b6370d2 100644 --- a/schema/aws-medialive-multiplexprogram.json +++ b/schema/aws-medialive-multiplexprogram.json @@ -1,292 +1,295 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProgramName", - "/properties/MultiplexId" - ], - "definitions": { - "MultiplexProgramPacketIdentifiersMap": { - "additionalProperties": false, - "description": "Packet identifiers map for a given Multiplex program.", - "properties": { - "AudioPids": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "type": "array" - }, - "DvbSubPids": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "type": "array" - }, - "DvbTeletextPid": { - "type": "integer" - }, - "EtvPlatformPid": { - "type": "integer" - }, - "EtvSignalPid": { - "type": "integer" - }, - "KlvDataPids": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "type": "array" - }, - "PcrPid": { - "type": "integer" - }, - "PmtPid": { - "type": "integer" - }, - "PrivateMetadataPid": { - "type": "integer" - }, - "Scte27Pids": { - "insertionOrder": true, - "items": { - "type": "integer" - }, - "type": "array" - }, - "Scte35Pid": { - "type": "integer" - }, - "TimedMetadataPid": { - "type": "integer" - }, - "VideoPid": { - "type": "integer" - } - }, - "type": "object" - }, - "MultiplexProgramPipelineDetail": { - "additionalProperties": false, - "description": "The current source for one of the pipelines in the multiplex.", - "properties": { - "ActiveChannelPipeline": { - "description": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.", - "type": "string" - }, - "PipelineId": { - "description": "Identifies a specific pipeline in the multiplex.", - "type": "string" - } - }, - "type": "object" - }, - "MultiplexProgramServiceDescriptor": { - "additionalProperties": false, - "description": "Transport stream service descriptor configuration for the Multiplex program.", - "properties": { - "ProviderName": { - "description": "Name of the provider.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ServiceName": { - "description": "Name of the service.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ProviderName", - "ServiceName" - ], - "type": "object" - }, - "MultiplexProgramSettings": { - "additionalProperties": false, - "description": "Multiplex Program settings configuration.", - "properties": { - "PreferredChannelPipeline": { - "$ref": "#/definitions/PreferredChannelPipeline", - "type": "string" - }, - "ProgramNumber": { - "description": "Unique program number.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "ServiceDescriptor": { - "$ref": "#/definitions/MultiplexProgramServiceDescriptor", - "description": "Transport stream service descriptor configuration for the Multiplex program." - }, - "VideoSettings": { - "$ref": "#/definitions/MultiplexVideoSettings", - "description": "Program video settings configuration." - } - }, - "required": [ - "ProgramNumber" - ], - "type": "object" - }, - "MultiplexStatmuxVideoSettings": { - "additionalProperties": false, - "description": "Statmux rate control settings", - "properties": { - "MaximumBitrate": { - "description": "Maximum statmux bitrate.", - "maximum": 100000000, - "minimum": 100000, - "type": "integer" - }, - "MinimumBitrate": { - "description": "Minimum statmux bitrate.", - "maximum": 100000000, - "minimum": 100000, - "type": "integer" - }, - "Priority": { - "description": "The purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority.", - "maximum": 5, - "minimum": -5, - "type": "integer" - } - }, - "type": "object" - }, - "MultiplexVideoSettings": { - "description": "The video configuration for each program in a multiplex.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "ConstantBitrate": { - "description": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined.", - "maximum": 100000000, - "minimum": 100000, - "type": "integer" - } - }, - "required": [ - "ConstantBitrate" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "StatmuxSettings": { - "$ref": "#/definitions/MultiplexStatmuxVideoSettings", - "description": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined." - } - }, - "required": [ - "StatmuxSettings" - ], - "type": "object" - } - ], - "type": "object" - }, - "PreferredChannelPipeline": { - "description": "Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.\n", - "enum": [ - "CURRENTLY_ACTIVE", - "PIPELINE_0", - "PIPELINE_1" - ], - "type": "string" - } - }, - "description": "Resource schema for AWS::MediaLive::Multiplexprogram", - "handlers": { - "create": { - "permissions": [ - "medialive:CreateMultiplexProgram", - "medialive:DescribeMultiplexProgram" - ] - }, - "delete": { - "permissions": [ - "medialive:DeleteMultiplexProgram", - "medialive:DescribeMultiplexProgram" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Arn": { - "$ref": "resource-schema.json#/properties/MultiplexId" - } - }, - "required": [ - "MultiplexId" - ] - }, - "permissions": [ - "medialive:ListMultiplexPrograms" - ] - }, - "read": { - "permissions": [ - "medialive:DescribeMultiplexProgram" - ] - }, - "update": { - "permissions": [ - "medialive:UpdateMultiplexProgram", - "medialive:DescribeMultiplexProgram" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProgramName", - "/properties/MultiplexId" - ], - "properties": { - "ChannelId": { - "description": "The MediaLive channel associated with the program.", - "type": "string" - }, - "MultiplexId": { - "description": "The ID of the multiplex that the program belongs to.", - "type": "string" - }, - "MultiplexProgramSettings": { - "$ref": "#/definitions/MultiplexProgramSettings", - "description": "The settings for this multiplex program." - }, - "PacketIdentifiersMap": { - "$ref": "#/definitions/MultiplexProgramPacketIdentifiersMap", - "description": "The packet identifier map for this multiplex program." - }, - "PipelineDetails": { - "description": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MultiplexProgramPipelineDetail" - }, - "type": "array" - }, - "PreferredChannelPipeline": { - "$ref": "#/definitions/PreferredChannelPipeline", - "description": "The settings for this multiplex program." - }, - "ProgramName": { - "description": "The name of the multiplex program.", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-medialiveprogram.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MediaLive::Multiplexprogram", - "writeOnlyProperties": [ - "/properties/PreferredChannelPipeline" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProgramName", + "/properties/MultiplexId" + ], + "definitions": { + "MultiplexProgramPacketIdentifiersMap": { + "additionalProperties": false, + "description": "Packet identifiers map for a given Multiplex program.", + "properties": { + "AudioPids": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "type": "array" + }, + "DvbSubPids": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "type": "array" + }, + "DvbTeletextPid": { + "type": "integer" + }, + "EtvPlatformPid": { + "type": "integer" + }, + "EtvSignalPid": { + "type": "integer" + }, + "KlvDataPids": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "type": "array" + }, + "PcrPid": { + "type": "integer" + }, + "PmtPid": { + "type": "integer" + }, + "PrivateMetadataPid": { + "type": "integer" + }, + "Scte27Pids": { + "insertionOrder": true, + "items": { + "type": "integer" + }, + "type": "array" + }, + "Scte35Pid": { + "type": "integer" + }, + "TimedMetadataPid": { + "type": "integer" + }, + "VideoPid": { + "type": "integer" + } + }, + "type": "object" + }, + "MultiplexProgramPipelineDetail": { + "additionalProperties": false, + "description": "The current source for one of the pipelines in the multiplex.", + "properties": { + "ActiveChannelPipeline": { + "description": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.", + "type": "string" + }, + "PipelineId": { + "description": "Identifies a specific pipeline in the multiplex.", + "type": "string" + } + }, + "type": "object" + }, + "MultiplexProgramServiceDescriptor": { + "additionalProperties": false, + "description": "Transport stream service descriptor configuration for the Multiplex program.", + "properties": { + "ProviderName": { + "description": "Name of the provider.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ServiceName": { + "description": "Name of the service.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ProviderName", + "ServiceName" + ], + "type": "object" + }, + "MultiplexProgramSettings": { + "additionalProperties": false, + "description": "Multiplex Program settings configuration.", + "properties": { + "PreferredChannelPipeline": { + "$ref": "#/definitions/PreferredChannelPipeline", + "type": "string" + }, + "ProgramNumber": { + "description": "Unique program number.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "ServiceDescriptor": { + "$ref": "#/definitions/MultiplexProgramServiceDescriptor", + "description": "Transport stream service descriptor configuration for the Multiplex program." + }, + "VideoSettings": { + "$ref": "#/definitions/MultiplexVideoSettings", + "description": "Program video settings configuration." + } + }, + "required": [ + "ProgramNumber" + ], + "type": "object" + }, + "MultiplexStatmuxVideoSettings": { + "additionalProperties": false, + "description": "Statmux rate control settings", + "properties": { + "MaximumBitrate": { + "description": "Maximum statmux bitrate.", + "maximum": 100000000, + "minimum": 100000, + "type": "integer" + }, + "MinimumBitrate": { + "description": "Minimum statmux bitrate.", + "maximum": 100000000, + "minimum": 100000, + "type": "integer" + }, + "Priority": { + "description": "The purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority.", + "maximum": 5, + "minimum": -5, + "type": "integer" + } + }, + "type": "object" + }, + "MultiplexVideoSettings": { + "description": "The video configuration for each program in a multiplex.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "ConstantBitrate": { + "description": "The constant bitrate configuration for the video encode.\nWhen this field is defined, StatmuxSettings must be undefined.", + "maximum": 100000000, + "minimum": 100000, + "type": "integer" + } + }, + "required": [ + "ConstantBitrate" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "StatmuxSettings": { + "$ref": "#/definitions/MultiplexStatmuxVideoSettings", + "description": "Statmux rate control settings.\nWhen this field is defined, ConstantBitrate must be undefined." + } + }, + "required": [ + "StatmuxSettings" + ], + "type": "object" + } + ], + "type": "object" + }, + "PreferredChannelPipeline": { + "description": "Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.\n", + "enum": [ + "CURRENTLY_ACTIVE", + "PIPELINE_0", + "PIPELINE_1" + ], + "type": "string" + } + }, + "description": "Resource schema for AWS::MediaLive::Multiplexprogram", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateMultiplexProgram", + "medialive:DescribeMultiplexProgram" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteMultiplexProgram", + "medialive:DescribeMultiplexProgram" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/MultiplexId" + } + }, + "required": [ + "MultiplexId" + ] + }, + "permissions": [ + "medialive:ListMultiplexPrograms" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeMultiplexProgram" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateMultiplexProgram", + "medialive:DescribeMultiplexProgram" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProgramName", + "/properties/MultiplexId" + ], + "properties": { + "ChannelId": { + "description": "The MediaLive channel associated with the program.", + "type": "string" + }, + "MultiplexId": { + "description": "The ID of the multiplex that the program belongs to.", + "type": "string" + }, + "MultiplexProgramSettings": { + "$ref": "#/definitions/MultiplexProgramSettings", + "description": "The settings for this multiplex program." + }, + "PacketIdentifiersMap": { + "$ref": "#/definitions/MultiplexProgramPacketIdentifiersMap", + "description": "The packet identifier map for this multiplex program." + }, + "PipelineDetails": { + "description": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MultiplexProgramPipelineDetail" + }, + "type": "array" + }, + "PreferredChannelPipeline": { + "$ref": "#/definitions/PreferredChannelPipeline", + "description": "The settings for this multiplex program." + }, + "ProgramName": { + "description": "The name of the multiplex program.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ChannelId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-medialiveprogram.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MediaLive::Multiplexprogram", + "writeOnlyProperties": [ + "/properties/PreferredChannelPipeline" + ] +} diff --git a/schema/aws-medialive-network.json b/schema/aws-medialive-network.json new file mode 100644 index 0000000..6b9a801 --- /dev/null +++ b/schema/aws-medialive-network.json @@ -0,0 +1,165 @@ +{ + "additionalProperties": false, + "definitions": { + "IpPool": { + "additionalProperties": false, + "description": "IP address cidr pool", + "properties": { + "Cidr": { + "description": "IP address cidr pool", + "type": "string" + } + }, + "type": "object" + }, + "NetworkState": { + "enum": [ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "DELETING", + "IDLE", + "IN_USE", + "UPDATING", + "DELETED", + "DELETE_FAILED" + ], + "type": "string" + }, + "Route": { + "additionalProperties": false, + "properties": { + "Cidr": { + "description": "Ip address cidr", + "type": "string" + }, + "Gateway": { + "description": "IP address for the route packet paths", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaLive::Network.", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateNetwork", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteNetwork", + "medialive:DescribeNetwork" + ] + }, + "list": { + "permissions": [ + "medialive:ListNetworks" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeNetwork" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateNetwork", + "medialive:CreateTags", + "medialive:DeleteTags", + "medialive:DescribeNetwork" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the Network.", + "type": "string" + }, + "AssociatedClusterIds": { + "insertionOrder": false, + "items": { + "description": "Cluster Ids which have this network ID in their Interface Network Mappings", + "type": "string" + }, + "type": "array" + }, + "Id": { + "description": "The unique ID of the Network.", + "type": "string" + }, + "IpPools": { + "description": "The list of IP address cidr pools for the network", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IpPool" + }, + "type": "array" + }, + "Name": { + "description": "The user-specified name of the Network to be created.", + "type": "string" + }, + "Routes": { + "description": "The routes for the network", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Route" + }, + "type": "array" + }, + "State": { + "$ref": "#/definitions/NetworkState", + "description": "The current state of the Network." + }, + "Tags": { + "description": "A collection of key-value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/State", + "/properties/AssociatedClusterIds" + ], + "required": [ + "Name", + "IpPools" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::Network" +} diff --git a/schema/aws-medialive-sdisource.json b/schema/aws-medialive-sdisource.json new file mode 100644 index 0000000..7537ff2 --- /dev/null +++ b/schema/aws-medialive-sdisource.json @@ -0,0 +1,140 @@ +{ + "additionalProperties": false, + "definitions": { + "SdiSourceMode": { + "description": "The current state of the SdiSource.", + "enum": [ + "QUADRANT", + "INTERLEAVE" + ], + "type": "string" + }, + "SdiSourceState": { + "description": "The current state of the SdiSource.", + "enum": [ + "IDLE", + "IN_USE", + "DELETED" + ], + "type": "string" + }, + "SdiSourceType": { + "description": "The interface mode of the SdiSource.", + "enum": [ + "SINGLE", + "QUAD" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::SdiSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateSdiSource", + "medialive:CreateTags" + ] + }, + "delete": { + "permissions": [ + "medialive:DeleteSdiSource", + "medialive:DescribeSdiSource" + ] + }, + "list": { + "permissions": [ + "medialive:ListSdiSources" + ] + }, + "read": { + "permissions": [ + "medialive:DescribeSdiSource" + ] + }, + "update": { + "permissions": [ + "medialive:UpdateSdiSource", + "medialive:DescribeSdiSource", + "medialive:CreateTags", + "medialive:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The unique arn of the SdiSource.", + "type": "string" + }, + "Id": { + "description": "The unique identifier of the SdiSource.", + "type": "string" + }, + "Inputs": { + "description": "The list of inputs currently using this SDI source.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Mode": { + "$ref": "#/definitions/SdiSourceMode" + }, + "Name": { + "description": "The name of the SdiSource.", + "type": "string" + }, + "State": { + "$ref": "#/definitions/SdiSourceState" + }, + "Tags": { + "description": "A collection of key-value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/SdiSourceType" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/State", + "/properties/Arn", + "/properties/Inputs" + ], + "required": [ + "Name", + "Type" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::SdiSource" +} diff --git a/schema/aws-medialive-signalmap.json b/schema/aws-medialive-signalmap.json new file mode 100644 index 0000000..743ae16 --- /dev/null +++ b/schema/aws-medialive-signalmap.json @@ -0,0 +1,424 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags" + ], + "definitions": { + "FailedMediaResourceMap": { + "additionalProperties": false, + "description": "A map representing an incomplete AWS media workflow as a graph.", + "patternProperties": { + ".+": { + "$ref": "#/definitions/MediaResource" + } + }, + "type": "object" + }, + "MediaResource": { + "additionalProperties": false, + "description": "An AWS resource used in media workflows.", + "properties": { + "Destinations": { + "items": { + "$ref": "#/definitions/MediaResourceNeighbor" + }, + "type": "array" + }, + "Name": { + "description": "The logical name of an AWS media resource.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Sources": { + "items": { + "$ref": "#/definitions/MediaResourceNeighbor" + }, + "type": "array" + } + }, + "type": "object" + }, + "MediaResourceMap": { + "additionalProperties": false, + "description": "A map representing an AWS media workflow as a graph.", + "patternProperties": { + ".+": { + "$ref": "#/definitions/MediaResource" + } + }, + "type": "object" + }, + "MediaResourceNeighbor": { + "additionalProperties": false, + "description": "A direct source or destination neighbor to an AWS media resource.", + "properties": { + "Arn": { + "description": "The ARN of a resource used in AWS media workflows.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn.+$", + "type": "string" + }, + "Name": { + "description": "The logical name of an AWS media resource.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "MonitorDeployment": { + "additionalProperties": false, + "description": "Represents the latest monitor deployment of a signal map.", + "properties": { + "DetailsUri": { + "description": "URI associated with a signal map's monitor deployment.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ErrorMessage": { + "description": "Error message associated with a failed monitor deployment of a signal map.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/SignalMapMonitorDeploymentStatus" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "SignalMapMonitorDeploymentStatus": { + "description": "A signal map's monitor deployment status.", + "enum": [ + "NOT_DEPLOYED", + "DRY_RUN_DEPLOYMENT_COMPLETE", + "DRY_RUN_DEPLOYMENT_FAILED", + "DRY_RUN_DEPLOYMENT_IN_PROGRESS", + "DEPLOYMENT_COMPLETE", + "DEPLOYMENT_FAILED", + "DEPLOYMENT_IN_PROGRESS", + "DELETE_COMPLETE", + "DELETE_FAILED", + "DELETE_IN_PROGRESS" + ], + "type": "string" + }, + "SignalMapStatus": { + "description": "A signal map's current status which is dependent on its lifecycle actions or associated jobs.", + "enum": [ + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "CREATE_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_COMPLETE", + "UPDATE_REVERTED", + "UPDATE_FAILED", + "READY", + "NOT_READY" + ], + "type": "string" + }, + "SuccessfulMonitorDeployment": { + "additionalProperties": false, + "description": "Represents the latest successful monitor deployment of a signal map.", + "properties": { + "DetailsUri": { + "description": "URI associated with a signal map's monitor deployment.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/SignalMapMonitorDeploymentStatus" + } + }, + "required": [ + "DetailsUri", + "Status" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "description": "Represents the tags associated with a resource.", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "Unit": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Definition of AWS::MediaLive::SignalMap Resource Type", + "handlers": { + "create": { + "permissions": [ + "medialive:CreateSignalMap", + "medialive:GetSignalMap", + "medialive:CreateTags", + "medialive:DescribeChannel", + "medialive:DescribeInput", + "medialive:DescribeInputDevice", + "medialive:DescribeInputSecurityGroup", + "medialive:DescribeMultiplex", + "medialive:DescribeMultiplexProgram", + "medialive:ListChannels", + "medialive:ListInputDevices", + "medialive:ListInputSecurityGroups", + "medialive:ListInputs", + "medialive:ListMultiplexPrograms", + "medialive:ListMultiplexes", + "medialive:ListOfferings", + "medialive:ListReservations", + "medialive:ListTagsForResource", + "cloudfront:ListDistributions", + "cloudfront:GetDistribution", + "ec2:DescribeNetworkInterfaces", + "mediaconnect:ListEntitlements", + "mediaconnect:ListFlows", + "mediaconnect:ListOfferings", + "mediaconnect:ListReservations", + "mediaconnect:DescribeFlow", + "mediapackage:ListChannels", + "mediapackage:ListOriginEndpoints", + "mediapackage:DescribeChannel", + "mediapackage:DescribeOriginEndpoint", + "mediapackagev2:ListChannelGroups", + "mediapackagev2:ListChannels", + "mediapackagev2:ListOriginEndpoints", + "mediapackagev2:GetChannelGroup", + "mediapackagev2:GetChannel", + "mediapackagev2:GetOriginEndpoint", + "tag:GetResources" + ] + }, + "delete": { + "permissions": [ + "medialive:GetSignalMap", + "medialive:DeleteSignalMap" + ] + }, + "list": { + "permissions": [ + "medialive:ListSignalMaps" + ] + }, + "read": { + "permissions": [ + "medialive:GetSignalMap", + "tag:GetResources" + ] + }, + "update": { + "permissions": [ + "medialive:StartUpdateSignalMap", + "medialive:GetSignalMap", + "medialive:CreateTags", + "medialive:DeleteTags", + "medialive:DescribeChannel", + "medialive:DescribeInput", + "medialive:DescribeInputDevice", + "medialive:DescribeInputSecurityGroup", + "medialive:DescribeMultiplex", + "medialive:DescribeMultiplexProgram", + "medialive:ListChannels", + "medialive:ListInputDevices", + "medialive:ListInputSecurityGroups", + "medialive:ListInputs", + "medialive:ListMultiplexPrograms", + "medialive:ListMultiplexes", + "medialive:ListOfferings", + "medialive:ListReservations", + "medialive:ListTagsForResource", + "cloudfront:ListDistributions", + "cloudfront:GetDistribution", + "ec2:DescribeNetworkInterfaces", + "mediaconnect:ListEntitlements", + "mediaconnect:ListFlows", + "mediaconnect:ListOfferings", + "mediaconnect:ListReservations", + "mediaconnect:DescribeFlow", + "mediapackage:ListChannels", + "mediapackage:ListOriginEndpoints", + "mediapackage:DescribeChannel", + "mediapackage:DescribeOriginEndpoint", + "mediapackagev2:ListChannelGroups", + "mediapackagev2:ListChannels", + "mediapackagev2:ListOriginEndpoints", + "mediapackagev2:GetChannelGroup", + "mediapackagev2:GetChannel", + "mediapackagev2:GetOriginEndpoint", + "tag:GetResources" + ] + } + }, + "primaryIdentifier": [ + "/properties/Identifier" + ], + "properties": { + "Arn": { + "description": "A signal map's ARN (Amazon Resource Name)", + "pattern": "^arn:.+:medialive:.+:signal-map:.+$", + "type": "string" + }, + "CloudWatchAlarmTemplateGroupIdentifiers": { + "items": { + "pattern": "^[^\\s]+$", + "type": "string" + }, + "type": "array" + }, + "CloudWatchAlarmTemplateGroupIds": { + "items": { + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "type": "array" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A resource's optional description.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "DiscoveryEntryPointArn": { + "description": "A top-level supported AWS resource ARN to discovery a signal map from.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ErrorMessage": { + "description": "Error message associated with a failed creation or failed update attempt of a signal map.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "EventBridgeRuleTemplateGroupIdentifiers": { + "items": { + "pattern": "^[^\\s]+$", + "type": "string" + }, + "type": "array" + }, + "EventBridgeRuleTemplateGroupIds": { + "items": { + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "type": "array" + }, + "FailedMediaResourceMap": { + "$ref": "#/definitions/FailedMediaResourceMap" + }, + "ForceRediscovery": { + "default": false, + "description": "If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.", + "type": "boolean" + }, + "Id": { + "description": "A signal map's id.", + "maxLength": 11, + "minLength": 7, + "pattern": "^(aws-)?[0-9]{7}$", + "type": "string" + }, + "Identifier": { + "type": "string" + }, + "LastDiscoveredAt": { + "format": "date-time", + "type": "string" + }, + "LastSuccessfulMonitorDeployment": { + "$ref": "#/definitions/SuccessfulMonitorDeployment" + }, + "MediaResourceMap": { + "$ref": "#/definitions/MediaResourceMap" + }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, + "MonitorChangesPendingDeployment": { + "default": false, + "description": "If true, there are pending monitor changes for this signal map that can be deployed.", + "type": "boolean" + }, + "MonitorDeployment": { + "$ref": "#/definitions/MonitorDeployment" + }, + "Name": { + "description": "A resource's name. Names must be unique within the scope of a resource type in a specific region.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[^\\s]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/SignalMapStatus" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CloudWatchAlarmTemplateGroupIds", + "/properties/CreatedAt", + "/properties/ErrorMessage", + "/properties/EventBridgeRuleTemplateGroupIds", + "/properties/FailedMediaResourceMap", + "/properties/Id", + "/properties/Identifier", + "/properties/LastDiscoveredAt", + "/properties/LastSuccessfulMonitorDeployment", + "/properties/MediaResourceMap", + "/properties/ModifiedAt", + "/properties/MonitorChangesPendingDeployment", + "/properties/MonitorDeployment", + "/properties/Status" + ], + "required": [ + "DiscoveryEntryPointArn", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "medialive:CreateTags", + "medialive:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaLive::SignalMap", + "writeOnlyProperties": [ + "/properties/CloudWatchAlarmTemplateGroupIdentifiers", + "/properties/EventBridgeRuleTemplateGroupIdentifiers", + "/properties/ForceRediscovery" + ] +} diff --git a/schema/aws-mediapackage-asset.json b/schema/aws-mediapackage-asset.json index e8f193c..e67f1bf 100644 --- a/schema/aws-mediapackage-asset.json +++ b/schema/aws-mediapackage-asset.json @@ -1,137 +1,137 @@ -{ - "additionalProperties": false, - "definitions": { - "EgressEndpoint": { - "additionalProperties": false, - "description": "The endpoint URL used to access an Asset using one PackagingConfiguration.", - "properties": { - "PackagingConfigurationId": { - "description": "The ID of the PackagingConfiguration being applied to the Asset.", - "type": "string" - }, - "Url": { - "description": "The URL of the parent manifest for the repackaged Asset.", - "type": "string" - } - }, - "required": [ - "PackagingConfigurationId", - "Url" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaPackage::Asset", - "handlers": { - "create": { - "permissions": [ - "mediapackage-vod:CreateAsset", - "mediapackage-vod:DescribeAsset", - "mediapackage-vod:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "mediapackage-vod:DescribeAsset", - "mediapackage-vod:DeleteAsset" - ] - }, - "list": { - "permissions": [ - "mediapackage-vod:ListAssets", - "mediapackage-vod:DescribePackagingGroup" - ] - }, - "read": { - "permissions": [ - "mediapackage-vod:DescribeAsset" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The ARN of the Asset.", - "type": "string" - }, - "CreatedAt": { - "description": "The time the Asset was initially submitted for Ingest.", - "type": "string" - }, - "EgressEndpoints": { - "description": "The list of egress endpoints available for the Asset.", - "items": { - "$ref": "#/definitions/EgressEndpoint" - }, - "type": "array" - }, - "Id": { - "description": "The unique identifier for the Asset.", - "type": "string" - }, - "PackagingGroupId": { - "description": "The ID of the PackagingGroup for the Asset.", - "type": "string" - }, - "ResourceId": { - "description": "The resource ID to include in SPEKE key requests.", - "type": "string" - }, - "SourceArn": { - "description": "ARN of the source object in S3.", - "type": "string" - }, - "SourceRoleArn": { - "description": "The IAM role_arn used to access the source S3 bucket.", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/EgressEndpoints/*/PackagingConfigurationId", - "/properties/EgressEndpoints/*/Url" - ], - "required": [ - "Id", - "PackagingGroupId", - "SourceArn", - "SourceRoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MediaPackage::Asset" -} +{ + "additionalProperties": false, + "definitions": { + "EgressEndpoint": { + "additionalProperties": false, + "description": "The endpoint URL used to access an Asset using one PackagingConfiguration.", + "properties": { + "PackagingConfigurationId": { + "description": "The ID of the PackagingConfiguration being applied to the Asset.", + "type": "string" + }, + "Url": { + "description": "The URL of the parent manifest for the repackaged Asset.", + "type": "string" + } + }, + "required": [ + "PackagingConfigurationId", + "Url" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaPackage::Asset", + "handlers": { + "create": { + "permissions": [ + "mediapackage-vod:CreateAsset", + "mediapackage-vod:DescribeAsset", + "mediapackage-vod:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "mediapackage-vod:DescribeAsset", + "mediapackage-vod:DeleteAsset" + ] + }, + "list": { + "permissions": [ + "mediapackage-vod:ListAssets", + "mediapackage-vod:DescribePackagingGroup" + ] + }, + "read": { + "permissions": [ + "mediapackage-vod:DescribeAsset" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the Asset.", + "type": "string" + }, + "CreatedAt": { + "description": "The time the Asset was initially submitted for Ingest.", + "type": "string" + }, + "EgressEndpoints": { + "description": "The list of egress endpoints available for the Asset.", + "items": { + "$ref": "#/definitions/EgressEndpoint" + }, + "type": "array" + }, + "Id": { + "description": "The unique identifier for the Asset.", + "type": "string" + }, + "PackagingGroupId": { + "description": "The ID of the PackagingGroup for the Asset.", + "type": "string" + }, + "ResourceId": { + "description": "The resource ID to include in SPEKE key requests.", + "type": "string" + }, + "SourceArn": { + "description": "ARN of the source object in S3.", + "type": "string" + }, + "SourceRoleArn": { + "description": "The IAM role_arn used to access the source S3 bucket.", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/EgressEndpoints/*/PackagingConfigurationId", + "/properties/EgressEndpoints/*/Url" + ], + "required": [ + "Id", + "PackagingGroupId", + "SourceArn", + "SourceRoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaPackage::Asset" +} diff --git a/schema/aws-mediapackage-channel.json b/schema/aws-mediapackage-channel.json index fa4e7a6..e99f0a0 100644 --- a/schema/aws-mediapackage-channel.json +++ b/schema/aws-mediapackage-channel.json @@ -1,175 +1,175 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Id", - "/properties/Tags" - ], - "definitions": { - "HlsIngest": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) ingest resource configuration.", - "properties": { - "ingestEndpoints": { - "description": "A list of endpoints to which the source stream should be sent.", - "items": { - "$ref": "#/definitions/IngestEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "IngestEndpoint": { - "additionalProperties": false, - "description": "An endpoint for ingesting source content for a Channel.", - "properties": { - "Id": { - "description": "The system generated unique identifier for the IngestEndpoint", - "type": "string" - }, - "Password": { - "description": "The system generated password for ingest authentication.", - "type": "string" - }, - "Url": { - "description": "The ingest URL to which the source stream should be sent.", - "type": "string" - }, - "Username": { - "description": "The system generated username for ingest authentication.", - "type": "string" - } - }, - "required": [ - "Id", - "Username", - "Password", - "Url" - ], - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "description": "Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\A^(\\/aws\\/MediaPackage\\/)[a-zA-Z0-9_-]+\\Z", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaPackage::Channel", - "handlers": { - "create": { - "permissions": [ - "mediapackage:CreateChannel", - "mediapackage:DescribeChannel", - "mediapackage:UpdateChannel", - "mediapackage:TagResource", - "mediapackage:ConfigureLogs", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "mediapackage:DeleteChannel" - ] - }, - "list": { - "permissions": [ - "mediapackage:ListChannels" - ] - }, - "read": { - "permissions": [ - "mediapackage:DescribeChannel" - ] - }, - "update": { - "permissions": [ - "mediapackage:UpdateChannel", - "mediapackage:ConfigureLogs", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) assigned to the Channel.", - "type": "string" - }, - "Description": { - "description": "A short text description of the Channel.", - "type": "string" - }, - "EgressAccessLogs": { - "$ref": "#/definitions/LogConfiguration", - "description": "The configuration parameters for egress access logging." - }, - "HlsIngest": { - "$ref": "#/definitions/HlsIngest", - "description": "An HTTP Live Streaming (HLS) ingest resource configuration." - }, - "Id": { - "description": "The ID of the Channel.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\A[0-9a-zA-Z-_]+\\Z", - "type": "string" - }, - "IngressAccessLogs": { - "$ref": "#/definitions/LogConfiguration", - "description": "The configuration parameters for egress access logging." - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/HlsIngest/ingestEndpoints/*/Id", - "/properties/HlsIngest/ingestEndpoints/*/Username", - "/properties/HlsIngest/ingestEndpoints/*/Password", - "/properties/HlsIngest/ingestEndpoints/*/Url" - ], - "required": [ - "Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MediaPackage::Channel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Id", + "/properties/Tags" + ], + "definitions": { + "HlsIngest": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) ingest resource configuration.", + "properties": { + "ingestEndpoints": { + "description": "A list of endpoints to which the source stream should be sent.", + "items": { + "$ref": "#/definitions/IngestEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "IngestEndpoint": { + "additionalProperties": false, + "description": "An endpoint for ingesting source content for a Channel.", + "properties": { + "Id": { + "description": "The system generated unique identifier for the IngestEndpoint", + "type": "string" + }, + "Password": { + "description": "The system generated password for ingest authentication.", + "type": "string" + }, + "Url": { + "description": "The ingest URL to which the source stream should be sent.", + "type": "string" + }, + "Username": { + "description": "The system generated username for ingest authentication.", + "type": "string" + } + }, + "required": [ + "Id", + "Username", + "Password", + "Url" + ], + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupName": { + "description": "Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\A^(\\/aws\\/MediaPackage\\/)[a-zA-Z0-9_-]+\\Z", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaPackage::Channel", + "handlers": { + "create": { + "permissions": [ + "mediapackage:CreateChannel", + "mediapackage:DescribeChannel", + "mediapackage:UpdateChannel", + "mediapackage:TagResource", + "mediapackage:ConfigureLogs", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "mediapackage:DeleteChannel" + ] + }, + "list": { + "permissions": [ + "mediapackage:ListChannels" + ] + }, + "read": { + "permissions": [ + "mediapackage:DescribeChannel" + ] + }, + "update": { + "permissions": [ + "mediapackage:UpdateChannel", + "mediapackage:ConfigureLogs", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) assigned to the Channel.", + "type": "string" + }, + "Description": { + "description": "A short text description of the Channel.", + "type": "string" + }, + "EgressAccessLogs": { + "$ref": "#/definitions/LogConfiguration", + "description": "The configuration parameters for egress access logging." + }, + "HlsIngest": { + "$ref": "#/definitions/HlsIngest", + "description": "An HTTP Live Streaming (HLS) ingest resource configuration." + }, + "Id": { + "description": "The ID of the Channel.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\A[0-9a-zA-Z-_]+\\Z", + "type": "string" + }, + "IngressAccessLogs": { + "$ref": "#/definitions/LogConfiguration", + "description": "The configuration parameters for egress access logging." + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/HlsIngest/ingestEndpoints/*/Id", + "/properties/HlsIngest/ingestEndpoints/*/Username", + "/properties/HlsIngest/ingestEndpoints/*/Password", + "/properties/HlsIngest/ingestEndpoints/*/Url" + ], + "required": [ + "Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaPackage::Channel" +} diff --git a/schema/aws-mediapackage-originendpoint.json b/schema/aws-mediapackage-originendpoint.json index 1558ac6..b741122 100644 --- a/schema/aws-mediapackage-originendpoint.json +++ b/schema/aws-mediapackage-originendpoint.json @@ -1,692 +1,692 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Id" - ], - "definitions": { - "AdsOnDeliveryRestrictions": { - "description": "This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing \"NONE\" means no SCTE-35 messages become ads. Choosing \"RESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing \"UNRESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing \"BOTH\" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.", - "enum": [ - "NONE", - "RESTRICTED", - "UNRESTRICTED", - "BOTH" - ], - "type": "string" - }, - "Authorization": { - "additionalProperties": false, - "description": "CDN Authorization credentials", - "properties": { - "CdnIdentifierSecret": { - "description": "The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.", - "type": "string" - }, - "SecretsRoleArn": { - "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", - "type": "string" - } - }, - "required": [ - "SecretsRoleArn", - "CdnIdentifierSecret" - ], - "type": "object" - }, - "CmafEncryption": { - "additionalProperties": false, - "description": "A Common Media Application Format (CMAF) encryption configuration.", - "properties": { - "ConstantInitializationVector": { - "description": "An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).", - "maxLength": 32, - "minLength": 32, - "pattern": "\\A[0-9a-fA-F]+\\Z", - "type": "string" - }, - "EncryptionMethod": { - "description": "The encryption method used", - "enum": [ - "SAMPLE_AES", - "AES_CTR" - ], - "type": "string" - }, - "KeyRotationIntervalSeconds": { - "description": "Time (in seconds) between each encryption key rotation.", - "type": "integer" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "CmafPackage": { - "additionalProperties": false, - "description": "A Common Media Application Format (CMAF) packaging configuration.", - "properties": { - "Encryption": { - "$ref": "#/definitions/CmafEncryption" - }, - "HlsManifests": { - "description": "A list of HLS manifest configurations", - "items": { - "$ref": "#/definitions/HlsManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.", - "type": "integer" - }, - "SegmentPrefix": { - "description": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - } - }, - "type": "object" - }, - "DashEncryption": { - "additionalProperties": false, - "description": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", - "properties": { - "KeyRotationIntervalSeconds": { - "description": "Time (in seconds) between each encryption key rotation.", - "type": "integer" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "DashPackage": { - "additionalProperties": false, - "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", - "properties": { - "AdTriggers": { - "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", - "items": { - "enum": [ - "SPLICE_INSERT", - "BREAK", - "PROVIDER_ADVERTISEMENT", - "DISTRIBUTOR_ADVERTISEMENT", - "PROVIDER_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", - "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" - ], - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "$ref": "#/definitions/AdsOnDeliveryRestrictions" - }, - "Encryption": { - "$ref": "#/definitions/DashEncryption" - }, - "IncludeIframeOnlyStream": { - "description": "When enabled, an I-Frame only stream will be included in the output.", - "type": "boolean" - }, - "ManifestLayout": { - "description": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", - "enum": [ - "FULL", - "COMPACT", - "DRM_TOP_LEVEL_COMPACT" - ], - "type": "string" - }, - "ManifestWindowSeconds": { - "description": "Time window (in seconds) contained in each manifest.", - "type": "integer" - }, - "MinBufferTimeSeconds": { - "description": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", - "type": "integer" - }, - "MinUpdatePeriodSeconds": { - "description": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).", - "type": "integer" - }, - "PeriodTriggers": { - "description": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Channel source contains SCTE-35 ad markers.", - "items": { - "enum": [ - "ADS" - ], - "type": "string" - }, - "type": "array" - }, - "Profile": { - "description": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", - "enum": [ - "NONE", - "HBBTV_1_5", - "HYBRIDCAST", - "DVB_DASH_2014" - ], - "type": "string" - }, - "SegmentDurationSeconds": { - "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.", - "type": "integer" - }, - "SegmentTemplateFormat": { - "description": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", - "enum": [ - "NUMBER_WITH_TIMELINE", - "TIME_WITH_TIMELINE", - "NUMBER_WITH_DURATION" - ], - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - }, - "SuggestedPresentationDelaySeconds": { - "description": "Duration (in seconds) to delay live content before presentation.", - "type": "integer" - }, - "UtcTiming": { - "description": "Determines the type of UTCTiming included in the Media Presentation Description (MPD)", - "enum": [ - "HTTP-XSDATE", - "HTTP-ISO", - "HTTP-HEAD", - "NONE" - ], - "type": "string" - }, - "UtcTimingUri": { - "description": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE", - "type": "string" - } - }, - "type": "object" - }, - "EncryptionContractConfiguration": { - "additionalProperties": false, - "description": "The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.", - "properties": { - "PresetSpeke20Audio": { - "description": "A collection of audio encryption presets.", - "enum": [ - "PRESET-AUDIO-1", - "PRESET-AUDIO-2", - "PRESET-AUDIO-3", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - }, - "PresetSpeke20Video": { - "description": "A collection of video encryption presets.", - "enum": [ - "PRESET-VIDEO-1", - "PRESET-VIDEO-2", - "PRESET-VIDEO-3", - "PRESET-VIDEO-4", - "PRESET-VIDEO-5", - "PRESET-VIDEO-6", - "PRESET-VIDEO-7", - "PRESET-VIDEO-8", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - } - }, - "required": [ - "PresetSpeke20Audio", - "PresetSpeke20Video" - ], - "type": "object" - }, - "HlsEncryption": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) encryption configuration.", - "properties": { - "ConstantInitializationVector": { - "description": "A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.", - "type": "string" - }, - "EncryptionMethod": { - "description": "The encryption method to use.", - "enum": [ - "AES_128", - "SAMPLE_AES" - ], - "type": "string" - }, - "KeyRotationIntervalSeconds": { - "description": "Interval (in seconds) between each encryption key rotation.", - "type": "integer" - }, - "RepeatExtXKey": { - "description": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", - "type": "boolean" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "HlsManifest": { - "additionalProperties": false, - "description": "A HTTP Live Streaming (HLS) manifest configuration.", - "properties": { - "AdMarkers": { - "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.", - "enum": [ - "NONE", - "SCTE35_ENHANCED", - "PASSTHROUGH", - "DATERANGE" - ], - "type": "string" - }, - "AdTriggers": { - "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", - "items": { - "enum": [ - "SPLICE_INSERT", - "BREAK", - "PROVIDER_ADVERTISEMENT", - "DISTRIBUTOR_ADVERTISEMENT", - "PROVIDER_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", - "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" - ], - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "$ref": "#/definitions/AdsOnDeliveryRestrictions" - }, - "Id": { - "description": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", - "type": "string" - }, - "IncludeIframeOnlyStream": { - "description": "When enabled, an I-Frame only stream will be included in the output.", - "type": "boolean" - }, - "ManifestName": { - "description": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", - "type": "string" - }, - "PlaylistType": { - "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.", - "enum": [ - "NONE", - "EVENT", - "VOD" - ], - "type": "string" - }, - "PlaylistWindowSeconds": { - "description": "Time window (in seconds) contained in each parent manifest.", - "type": "integer" - }, - "ProgramDateTimeIntervalSeconds": { - "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", - "type": "integer" - }, - "Url": { - "description": "The URL of the packaged OriginEndpoint for consumption.", - "type": "string" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "HlsPackage": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) packaging configuration.", - "properties": { - "AdMarkers": { - "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.", - "enum": [ - "NONE", - "SCTE35_ENHANCED", - "PASSTHROUGH", - "DATERANGE" - ], - "type": "string" - }, - "AdTriggers": { - "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", - "items": { - "enum": [ - "SPLICE_INSERT", - "BREAK", - "PROVIDER_ADVERTISEMENT", - "DISTRIBUTOR_ADVERTISEMENT", - "PROVIDER_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", - "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" - ], - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "$ref": "#/definitions/AdsOnDeliveryRestrictions" - }, - "Encryption": { - "$ref": "#/definitions/HlsEncryption" - }, - "IncludeDvbSubtitles": { - "description": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", - "type": "boolean" - }, - "IncludeIframeOnlyStream": { - "description": "When enabled, an I-Frame only stream will be included in the output.", - "type": "boolean" - }, - "PlaylistType": { - "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.", - "enum": [ - "NONE", - "EVENT", - "VOD" - ], - "type": "string" - }, - "PlaylistWindowSeconds": { - "description": "Time window (in seconds) contained in each parent manifest.", - "type": "integer" - }, - "ProgramDateTimeIntervalSeconds": { - "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", - "type": "integer" - }, - "SegmentDurationSeconds": { - "description": "Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.", - "type": "integer" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - }, - "UseAudioRenditionGroup": { - "description": "When enabled, audio streams will be placed in rendition groups in the output.", - "type": "boolean" - } - }, - "type": "object" - }, - "MssEncryption": { - "additionalProperties": false, - "description": "A Microsoft Smooth Streaming (MSS) encryption configuration.", - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "MssPackage": { - "additionalProperties": false, - "description": "A Microsoft Smooth Streaming (MSS) packaging configuration.", - "properties": { - "Encryption": { - "$ref": "#/definitions/MssEncryption" - }, - "ManifestWindowSeconds": { - "description": "The time window (in seconds) contained in each manifest.", - "type": "integer" - }, - "SegmentDurationSeconds": { - "description": "The duration (in seconds) of each segment.", - "type": "integer" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - } - }, - "type": "object" - }, - "SpekeKeyProvider": { - "additionalProperties": false, - "description": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", - "properties": { - "CertificateArn": { - "description": "An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.", - "type": "string" - }, - "EncryptionContractConfiguration": { - "$ref": "#/definitions/EncryptionContractConfiguration" - }, - "ResourceId": { - "description": "The resource ID to include in key requests.", - "type": "string" - }, - "RoleArn": { - "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.", - "type": "string" - }, - "SystemIds": { - "description": "The system IDs to include in key requests.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Url": { - "description": "The URL of the external key provider service.", - "type": "string" - } - }, - "required": [ - "ResourceId", - "SystemIds", - "Url", - "RoleArn" - ], - "type": "object" - }, - "StreamSelection": { - "additionalProperties": false, - "description": "A StreamSelection configuration.", - "properties": { - "MaxVideoBitsPerSecond": { - "description": "The maximum video bitrate (bps) to include in output.", - "type": "integer" - }, - "MinVideoBitsPerSecond": { - "description": "The minimum video bitrate (bps) to include in output.", - "type": "integer" - }, - "StreamOrder": { - "description": "A directive that determines the order of streams in the output.", - "enum": [ - "ORIGINAL", - "VIDEO_BITRATE_ASCENDING", - "VIDEO_BITRATE_DESCENDING" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", - "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", - "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", - "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", - "/properties/CmafPackage/HlsManifests/*/Url" - ], - "description": "Resource schema for AWS::MediaPackage::OriginEndpoint", - "handlers": { - "create": { - "permissions": [ - "mediapackage:CreateOriginEndpoint", - "mediapackage:DescribeOriginEndpoint", - "mediapackage:DescribeChannel", - "mediapackage:TagResource", - "iam:PassRole", - "acm:DescribeCertificate" - ] - }, - "delete": { - "permissions": [ - "mediapackage:DeleteOriginEndpoint" - ] - }, - "list": { - "permissions": [ - "mediapackage:ListOriginEndpoints" - ] - }, - "read": { - "permissions": [ - "mediapackage:DescribeOriginEndpoint" - ] - }, - "update": { - "permissions": [ - "mediapackage:UpdateOriginEndpoint", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", - "type": "string" - }, - "Authorization": { - "$ref": "#/definitions/Authorization" - }, - "ChannelId": { - "description": "The ID of the Channel the OriginEndpoint is associated with.", - "type": "string" - }, - "CmafPackage": { - "$ref": "#/definitions/CmafPackage" - }, - "DashPackage": { - "$ref": "#/definitions/DashPackage" - }, - "Description": { - "description": "A short text description of the OriginEndpoint.", - "type": "string" - }, - "HlsPackage": { - "$ref": "#/definitions/HlsPackage" - }, - "Id": { - "description": "The ID of the OriginEndpoint.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\A[0-9a-zA-Z-_]+\\Z", - "type": "string" - }, - "ManifestName": { - "description": "A short string appended to the end of the OriginEndpoint URL.", - "type": "string" - }, - "MssPackage": { - "$ref": "#/definitions/MssPackage" - }, - "Origination": { - "description": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "enum": [ - "ALLOW", - "DENY" - ], - "type": "string" - }, - "StartoverWindowSeconds": { - "description": "Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.", - "type": "integer" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TimeDelaySeconds": { - "description": "Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.", - "type": "integer" - }, - "Url": { - "description": "The URL of the packaged OriginEndpoint for consumption.", - "type": "string" - }, - "Whitelist": { - "description": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Url" - ], - "required": [ - "Id", - "ChannelId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MediaPackage::OriginEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Id" + ], + "definitions": { + "AdsOnDeliveryRestrictions": { + "description": "This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing \"NONE\" means no SCTE-35 messages become ads. Choosing \"RESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing \"UNRESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing \"BOTH\" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.", + "enum": [ + "NONE", + "RESTRICTED", + "UNRESTRICTED", + "BOTH" + ], + "type": "string" + }, + "Authorization": { + "additionalProperties": false, + "description": "CDN Authorization credentials", + "properties": { + "CdnIdentifierSecret": { + "description": "The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.", + "type": "string" + }, + "SecretsRoleArn": { + "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", + "type": "string" + } + }, + "required": [ + "SecretsRoleArn", + "CdnIdentifierSecret" + ], + "type": "object" + }, + "CmafEncryption": { + "additionalProperties": false, + "description": "A Common Media Application Format (CMAF) encryption configuration.", + "properties": { + "ConstantInitializationVector": { + "description": "An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).", + "maxLength": 32, + "minLength": 32, + "pattern": "\\A[0-9a-fA-F]+\\Z", + "type": "string" + }, + "EncryptionMethod": { + "description": "The encryption method used", + "enum": [ + "SAMPLE_AES", + "AES_CTR" + ], + "type": "string" + }, + "KeyRotationIntervalSeconds": { + "description": "Time (in seconds) between each encryption key rotation.", + "type": "integer" + }, + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "CmafPackage": { + "additionalProperties": false, + "description": "A Common Media Application Format (CMAF) packaging configuration.", + "properties": { + "Encryption": { + "$ref": "#/definitions/CmafEncryption" + }, + "HlsManifests": { + "description": "A list of HLS manifest configurations", + "items": { + "$ref": "#/definitions/HlsManifest" + }, + "type": "array" + }, + "SegmentDurationSeconds": { + "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.", + "type": "integer" + }, + "SegmentPrefix": { + "description": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", + "type": "string" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + } + }, + "type": "object" + }, + "DashEncryption": { + "additionalProperties": false, + "description": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", + "properties": { + "KeyRotationIntervalSeconds": { + "description": "Time (in seconds) between each encryption key rotation.", + "type": "integer" + }, + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "DashPackage": { + "additionalProperties": false, + "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", + "properties": { + "AdTriggers": { + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", + "items": { + "enum": [ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" + ], + "type": "string" + }, + "type": "array" + }, + "AdsOnDeliveryRestrictions": { + "$ref": "#/definitions/AdsOnDeliveryRestrictions" + }, + "Encryption": { + "$ref": "#/definitions/DashEncryption" + }, + "IncludeIframeOnlyStream": { + "description": "When enabled, an I-Frame only stream will be included in the output.", + "type": "boolean" + }, + "ManifestLayout": { + "description": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", + "enum": [ + "FULL", + "COMPACT", + "DRM_TOP_LEVEL_COMPACT" + ], + "type": "string" + }, + "ManifestWindowSeconds": { + "description": "Time window (in seconds) contained in each manifest.", + "type": "integer" + }, + "MinBufferTimeSeconds": { + "description": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", + "type": "integer" + }, + "MinUpdatePeriodSeconds": { + "description": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).", + "type": "integer" + }, + "PeriodTriggers": { + "description": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Channel source contains SCTE-35 ad markers.", + "items": { + "enum": [ + "ADS" + ], + "type": "string" + }, + "type": "array" + }, + "Profile": { + "description": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "enum": [ + "NONE", + "HBBTV_1_5", + "HYBRIDCAST", + "DVB_DASH_2014" + ], + "type": "string" + }, + "SegmentDurationSeconds": { + "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.", + "type": "integer" + }, + "SegmentTemplateFormat": { + "description": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", + "enum": [ + "NUMBER_WITH_TIMELINE", + "TIME_WITH_TIMELINE", + "NUMBER_WITH_DURATION" + ], + "type": "string" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + }, + "SuggestedPresentationDelaySeconds": { + "description": "Duration (in seconds) to delay live content before presentation.", + "type": "integer" + }, + "UtcTiming": { + "description": "Determines the type of UTCTiming included in the Media Presentation Description (MPD)", + "enum": [ + "HTTP-XSDATE", + "HTTP-ISO", + "HTTP-HEAD", + "NONE" + ], + "type": "string" + }, + "UtcTimingUri": { + "description": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE", + "type": "string" + } + }, + "type": "object" + }, + "EncryptionContractConfiguration": { + "additionalProperties": false, + "description": "The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.", + "properties": { + "PresetSpeke20Audio": { + "description": "A collection of audio encryption presets.", + "enum": [ + "PRESET-AUDIO-1", + "PRESET-AUDIO-2", + "PRESET-AUDIO-3", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + }, + "PresetSpeke20Video": { + "description": "A collection of video encryption presets.", + "enum": [ + "PRESET-VIDEO-1", + "PRESET-VIDEO-2", + "PRESET-VIDEO-3", + "PRESET-VIDEO-4", + "PRESET-VIDEO-5", + "PRESET-VIDEO-6", + "PRESET-VIDEO-7", + "PRESET-VIDEO-8", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + } + }, + "required": [ + "PresetSpeke20Audio", + "PresetSpeke20Video" + ], + "type": "object" + }, + "HlsEncryption": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) encryption configuration.", + "properties": { + "ConstantInitializationVector": { + "description": "A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.", + "type": "string" + }, + "EncryptionMethod": { + "description": "The encryption method to use.", + "enum": [ + "AES_128", + "SAMPLE_AES" + ], + "type": "string" + }, + "KeyRotationIntervalSeconds": { + "description": "Interval (in seconds) between each encryption key rotation.", + "type": "integer" + }, + "RepeatExtXKey": { + "description": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", + "type": "boolean" + }, + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "HlsManifest": { + "additionalProperties": false, + "description": "A HTTP Live Streaming (HLS) manifest configuration.", + "properties": { + "AdMarkers": { + "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.", + "enum": [ + "NONE", + "SCTE35_ENHANCED", + "PASSTHROUGH", + "DATERANGE" + ], + "type": "string" + }, + "AdTriggers": { + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", + "items": { + "enum": [ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" + ], + "type": "string" + }, + "type": "array" + }, + "AdsOnDeliveryRestrictions": { + "$ref": "#/definitions/AdsOnDeliveryRestrictions" + }, + "Id": { + "description": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", + "type": "string" + }, + "IncludeIframeOnlyStream": { + "description": "When enabled, an I-Frame only stream will be included in the output.", + "type": "boolean" + }, + "ManifestName": { + "description": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", + "type": "string" + }, + "PlaylistType": { + "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.", + "enum": [ + "NONE", + "EVENT", + "VOD" + ], + "type": "string" + }, + "PlaylistWindowSeconds": { + "description": "Time window (in seconds) contained in each parent manifest.", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", + "type": "integer" + }, + "Url": { + "description": "The URL of the packaged OriginEndpoint for consumption.", + "type": "string" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "HlsPackage": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) packaging configuration.", + "properties": { + "AdMarkers": { + "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.", + "enum": [ + "NONE", + "SCTE35_ENHANCED", + "PASSTHROUGH", + "DATERANGE" + ], + "type": "string" + }, + "AdTriggers": { + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.", + "items": { + "enum": [ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" + ], + "type": "string" + }, + "type": "array" + }, + "AdsOnDeliveryRestrictions": { + "$ref": "#/definitions/AdsOnDeliveryRestrictions" + }, + "Encryption": { + "$ref": "#/definitions/HlsEncryption" + }, + "IncludeDvbSubtitles": { + "description": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", + "type": "boolean" + }, + "IncludeIframeOnlyStream": { + "description": "When enabled, an I-Frame only stream will be included in the output.", + "type": "boolean" + }, + "PlaylistType": { + "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.", + "enum": [ + "NONE", + "EVENT", + "VOD" + ], + "type": "string" + }, + "PlaylistWindowSeconds": { + "description": "Time window (in seconds) contained in each parent manifest.", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", + "type": "integer" + }, + "SegmentDurationSeconds": { + "description": "Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.", + "type": "integer" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + }, + "UseAudioRenditionGroup": { + "description": "When enabled, audio streams will be placed in rendition groups in the output.", + "type": "boolean" + } + }, + "type": "object" + }, + "MssEncryption": { + "additionalProperties": false, + "description": "A Microsoft Smooth Streaming (MSS) encryption configuration.", + "properties": { + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "MssPackage": { + "additionalProperties": false, + "description": "A Microsoft Smooth Streaming (MSS) packaging configuration.", + "properties": { + "Encryption": { + "$ref": "#/definitions/MssEncryption" + }, + "ManifestWindowSeconds": { + "description": "The time window (in seconds) contained in each manifest.", + "type": "integer" + }, + "SegmentDurationSeconds": { + "description": "The duration (in seconds) of each segment.", + "type": "integer" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + } + }, + "type": "object" + }, + "SpekeKeyProvider": { + "additionalProperties": false, + "description": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", + "properties": { + "CertificateArn": { + "description": "An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.", + "type": "string" + }, + "EncryptionContractConfiguration": { + "$ref": "#/definitions/EncryptionContractConfiguration" + }, + "ResourceId": { + "description": "The resource ID to include in key requests.", + "type": "string" + }, + "RoleArn": { + "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.", + "type": "string" + }, + "SystemIds": { + "description": "The system IDs to include in key requests.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Url": { + "description": "The URL of the external key provider service.", + "type": "string" + } + }, + "required": [ + "ResourceId", + "SystemIds", + "Url", + "RoleArn" + ], + "type": "object" + }, + "StreamSelection": { + "additionalProperties": false, + "description": "A StreamSelection configuration.", + "properties": { + "MaxVideoBitsPerSecond": { + "description": "The maximum video bitrate (bps) to include in output.", + "type": "integer" + }, + "MinVideoBitsPerSecond": { + "description": "The minimum video bitrate (bps) to include in output.", + "type": "integer" + }, + "StreamOrder": { + "description": "A directive that determines the order of streams in the output.", + "enum": [ + "ORIGINAL", + "VIDEO_BITRATE_ASCENDING", + "VIDEO_BITRATE_DESCENDING" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", + "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", + "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", + "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", + "/properties/CmafPackage/HlsManifests/*/Url" + ], + "description": "Resource schema for AWS::MediaPackage::OriginEndpoint", + "handlers": { + "create": { + "permissions": [ + "mediapackage:CreateOriginEndpoint", + "mediapackage:DescribeOriginEndpoint", + "mediapackage:DescribeChannel", + "mediapackage:TagResource", + "iam:PassRole", + "acm:DescribeCertificate" + ] + }, + "delete": { + "permissions": [ + "mediapackage:DeleteOriginEndpoint" + ] + }, + "list": { + "permissions": [ + "mediapackage:ListOriginEndpoints" + ] + }, + "read": { + "permissions": [ + "mediapackage:DescribeOriginEndpoint" + ] + }, + "update": { + "permissions": [ + "mediapackage:UpdateOriginEndpoint", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "type": "string" + }, + "Authorization": { + "$ref": "#/definitions/Authorization" + }, + "ChannelId": { + "description": "The ID of the Channel the OriginEndpoint is associated with.", + "type": "string" + }, + "CmafPackage": { + "$ref": "#/definitions/CmafPackage" + }, + "DashPackage": { + "$ref": "#/definitions/DashPackage" + }, + "Description": { + "description": "A short text description of the OriginEndpoint.", + "type": "string" + }, + "HlsPackage": { + "$ref": "#/definitions/HlsPackage" + }, + "Id": { + "description": "The ID of the OriginEndpoint.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\A[0-9a-zA-Z-_]+\\Z", + "type": "string" + }, + "ManifestName": { + "description": "A short string appended to the end of the OriginEndpoint URL.", + "type": "string" + }, + "MssPackage": { + "$ref": "#/definitions/MssPackage" + }, + "Origination": { + "description": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "StartoverWindowSeconds": { + "description": "Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.", + "type": "integer" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TimeDelaySeconds": { + "description": "Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.", + "type": "integer" + }, + "Url": { + "description": "The URL of the packaged OriginEndpoint for consumption.", + "type": "string" + }, + "Whitelist": { + "description": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Url" + ], + "required": [ + "Id", + "ChannelId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaPackage::OriginEndpoint" +} diff --git a/schema/aws-mediapackage-packagingconfiguration.json b/schema/aws-mediapackage-packagingconfiguration.json index e6058d9..801a966 100644 --- a/schema/aws-mediapackage-packagingconfiguration.json +++ b/schema/aws-mediapackage-packagingconfiguration.json @@ -1,501 +1,501 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Id" - ], - "definitions": { - "CmafEncryption": { - "additionalProperties": false, - "description": "A CMAF encryption configuration.", - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "CmafPackage": { - "additionalProperties": false, - "description": "A CMAF packaging configuration.", - "properties": { - "Encryption": { - "$ref": "#/definitions/CmafEncryption" - }, - "HlsManifests": { - "description": "A list of HLS manifest configurations.", - "items": { - "$ref": "#/definitions/HlsManifest" - }, - "type": "array" - }, - "IncludeEncoderConfigurationInSegments": { - "description": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.", - "type": "boolean" - }, - "SegmentDurationSeconds": { - "$ref": "#/definitions/SegmentDurationSeconds" - } - }, - "required": [ - "HlsManifests" - ], - "type": "object" - }, - "DashEncryption": { - "additionalProperties": false, - "description": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "DashManifest": { - "additionalProperties": false, - "description": "A DASH manifest configuration.", - "properties": { - "ManifestLayout": { - "description": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", - "enum": [ - "FULL", - "COMPACT" - ], - "type": "string" - }, - "ManifestName": { - "$ref": "#/definitions/ManifestName" - }, - "MinBufferTimeSeconds": { - "description": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", - "type": "integer" - }, - "Profile": { - "description": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", - "enum": [ - "NONE", - "HBBTV_1_5" - ], - "type": "string" - }, - "ScteMarkersSource": { - "description": "The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.", - "enum": [ - "SEGMENTS", - "MANIFEST" - ], - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - } - }, - "type": "object" - }, - "DashPackage": { - "additionalProperties": false, - "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", - "properties": { - "DashManifests": { - "description": "A list of DASH manifest configurations.", - "items": { - "$ref": "#/definitions/DashManifest" - }, - "type": "array" - }, - "Encryption": { - "$ref": "#/definitions/DashEncryption" - }, - "IncludeEncoderConfigurationInSegments": { - "description": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.", - "type": "boolean" - }, - "IncludeIframeOnlyStream": { - "description": "When enabled, an I-Frame only stream will be included in the output.", - "type": "boolean" - }, - "PeriodTriggers": { - "description": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Asset contains SCTE-35 ad markers.", - "items": { - "enum": [ - "ADS" - ], - "type": "string" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "$ref": "#/definitions/SegmentDurationSeconds" - }, - "SegmentTemplateFormat": { - "description": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", - "enum": [ - "NUMBER_WITH_TIMELINE", - "TIME_WITH_TIMELINE", - "NUMBER_WITH_DURATION" - ], - "type": "string" - } - }, - "required": [ - "DashManifests" - ], - "type": "object" - }, - "EncryptionContractConfiguration": { - "additionalProperties": false, - "description": "The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.", - "properties": { - "PresetSpeke20Audio": { - "description": "A collection of audio encryption presets.", - "enum": [ - "PRESET-AUDIO-1", - "PRESET-AUDIO-2", - "PRESET-AUDIO-3", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - }, - "PresetSpeke20Video": { - "description": "A collection of video encryption presets.", - "enum": [ - "PRESET-VIDEO-1", - "PRESET-VIDEO-2", - "PRESET-VIDEO-3", - "PRESET-VIDEO-4", - "PRESET-VIDEO-5", - "PRESET-VIDEO-6", - "PRESET-VIDEO-7", - "PRESET-VIDEO-8", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - } - }, - "required": [ - "PresetSpeke20Audio", - "PresetSpeke20Video" - ], - "type": "object" - }, - "HlsEncryption": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) encryption configuration.", - "properties": { - "ConstantInitializationVector": { - "description": "An HTTP Live Streaming (HLS) encryption configuration.", - "type": "string" - }, - "EncryptionMethod": { - "description": "The encryption method to use.", - "enum": [ - "AES_128", - "SAMPLE_AES" - ], - "type": "string" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "HlsManifest": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) manifest configuration.", - "properties": { - "AdMarkers": { - "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source.", - "enum": [ - "NONE", - "SCTE35_ENHANCED", - "PASSTHROUGH" - ], - "type": "string" - }, - "IncludeIframeOnlyStream": { - "description": "When enabled, an I-Frame only stream will be included in the output.", - "type": "boolean" - }, - "ManifestName": { - "$ref": "#/definitions/ManifestName" - }, - "ProgramDateTimeIntervalSeconds": { - "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", - "type": "integer" - }, - "RepeatExtXKey": { - "description": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", - "type": "boolean" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - } - }, - "type": "object" - }, - "HlsPackage": { - "additionalProperties": false, - "description": "An HTTP Live Streaming (HLS) packaging configuration.", - "properties": { - "Encryption": { - "$ref": "#/definitions/HlsEncryption" - }, - "HlsManifests": { - "description": "A list of HLS manifest configurations.", - "items": { - "$ref": "#/definitions/HlsManifest" - }, - "type": "array" - }, - "IncludeDvbSubtitles": { - "description": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", - "type": "boolean" - }, - "SegmentDurationSeconds": { - "$ref": "#/definitions/SegmentDurationSeconds" - }, - "UseAudioRenditionGroup": { - "description": "When enabled, audio streams will be placed in rendition groups in the output.", - "type": "boolean" - } - }, - "required": [ - "HlsManifests" - ], - "type": "object" - }, - "ManifestName": { - "description": "An optional string to include in the name of the manifest.", - "type": "string" - }, - "MssEncryption": { - "additionalProperties": false, - "description": "A CMAF encryption configuration.", - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "MssManifest": { - "additionalProperties": false, - "description": "A Microsoft Smooth Streaming (MSS) manifest configuration.", - "properties": { - "ManifestName": { - "$ref": "#/definitions/ManifestName" - }, - "StreamSelection": { - "$ref": "#/definitions/StreamSelection" - } - }, - "type": "object" - }, - "MssPackage": { - "additionalProperties": false, - "description": "A Microsoft Smooth Streaming (MSS) PackagingConfiguration.", - "properties": { - "Encryption": { - "$ref": "#/definitions/MssEncryption" - }, - "MssManifests": { - "description": "A list of MSS manifest configurations.", - "items": { - "$ref": "#/definitions/MssManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "$ref": "#/definitions/SegmentDurationSeconds" - } - }, - "required": [ - "MssManifests" - ], - "type": "object" - }, - "RoleArn": { - "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.", - "type": "string" - }, - "SegmentDurationSeconds": { - "description": "Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.", - "type": "integer" - }, - "SpekeKeyProvider": { - "additionalProperties": false, - "description": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", - "properties": { - "EncryptionContractConfiguration": { - "$ref": "#/definitions/EncryptionContractConfiguration" - }, - "RoleArn": { - "$ref": "#/definitions/RoleArn" - }, - "SystemIds": { - "description": "The system IDs to include in key requests.", - "items": { - "type": "string" - }, - "type": "array" - }, - "Url": { - "description": "The URL of the external key provider service.", - "type": "string" - } - }, - "required": [ - "RoleArn", - "SystemIds", - "Url" - ], - "type": "object" - }, - "StreamSelection": { - "additionalProperties": false, - "description": "A StreamSelection configuration.", - "properties": { - "MaxVideoBitsPerSecond": { - "description": "The maximum video bitrate (bps) to include in output.", - "type": "integer" - }, - "MinVideoBitsPerSecond": { - "description": "The minimum video bitrate (bps) to include in output.", - "type": "integer" - }, - "StreamOrder": { - "description": "A directive that determines the order of streams in the output.", - "enum": [ - "ORIGINAL", - "VIDEO_BITRATE_ASCENDING", - "VIDEO_BITRATE_DESCENDING" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", - "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", - "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", - "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video" - ], - "description": "Resource schema for AWS::MediaPackage::PackagingConfiguration", - "handlers": { - "create": { - "permissions": [ - "mediapackage-vod:CreatePackagingConfiguration", - "mediapackage-vod:DescribePackagingConfiguration", - "mediapackage-vod:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "mediapackage-vod:DescribePackagingConfiguration", - "mediapackage-vod:DeletePackagingConfiguration" - ] - }, - "list": { - "permissions": [ - "mediapackage-vod:ListPackagingConfigurations", - "mediapackage-vod:DescribePackagingGroup" - ] - }, - "read": { - "permissions": [ - "mediapackage-vod:DescribePackagingConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The ARN of the PackagingConfiguration.", - "type": "string" - }, - "CmafPackage": { - "$ref": "#/definitions/CmafPackage", - "description": "A CMAF packaging configuration." - }, - "DashPackage": { - "$ref": "#/definitions/DashPackage", - "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration." - }, - "HlsPackage": { - "$ref": "#/definitions/HlsPackage", - "description": "An HTTP Live Streaming (HLS) packaging configuration." - }, - "Id": { - "description": "The ID of the PackagingConfiguration.", - "type": "string" - }, - "MssPackage": { - "$ref": "#/definitions/MssPackage", - "description": "A Microsoft Smooth Streaming (MSS) PackagingConfiguration." - }, - "PackagingGroupId": { - "description": "The ID of a PackagingGroup.", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "PackagingGroupId", - "Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MediaPackage::PackagingConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Id" + ], + "definitions": { + "CmafEncryption": { + "additionalProperties": false, + "description": "A CMAF encryption configuration.", + "properties": { + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "CmafPackage": { + "additionalProperties": false, + "description": "A CMAF packaging configuration.", + "properties": { + "Encryption": { + "$ref": "#/definitions/CmafEncryption" + }, + "HlsManifests": { + "description": "A list of HLS manifest configurations.", + "items": { + "$ref": "#/definitions/HlsManifest" + }, + "type": "array" + }, + "IncludeEncoderConfigurationInSegments": { + "description": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.", + "type": "boolean" + }, + "SegmentDurationSeconds": { + "$ref": "#/definitions/SegmentDurationSeconds" + } + }, + "required": [ + "HlsManifests" + ], + "type": "object" + }, + "DashEncryption": { + "additionalProperties": false, + "description": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", + "properties": { + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "DashManifest": { + "additionalProperties": false, + "description": "A DASH manifest configuration.", + "properties": { + "ManifestLayout": { + "description": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", + "enum": [ + "FULL", + "COMPACT" + ], + "type": "string" + }, + "ManifestName": { + "$ref": "#/definitions/ManifestName" + }, + "MinBufferTimeSeconds": { + "description": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", + "type": "integer" + }, + "Profile": { + "description": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "enum": [ + "NONE", + "HBBTV_1_5" + ], + "type": "string" + }, + "ScteMarkersSource": { + "description": "The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.", + "enum": [ + "SEGMENTS", + "MANIFEST" + ], + "type": "string" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + } + }, + "type": "object" + }, + "DashPackage": { + "additionalProperties": false, + "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", + "properties": { + "DashManifests": { + "description": "A list of DASH manifest configurations.", + "items": { + "$ref": "#/definitions/DashManifest" + }, + "type": "array" + }, + "Encryption": { + "$ref": "#/definitions/DashEncryption" + }, + "IncludeEncoderConfigurationInSegments": { + "description": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.", + "type": "boolean" + }, + "IncludeIframeOnlyStream": { + "description": "When enabled, an I-Frame only stream will be included in the output.", + "type": "boolean" + }, + "PeriodTriggers": { + "description": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Asset contains SCTE-35 ad markers.", + "items": { + "enum": [ + "ADS" + ], + "type": "string" + }, + "type": "array" + }, + "SegmentDurationSeconds": { + "$ref": "#/definitions/SegmentDurationSeconds" + }, + "SegmentTemplateFormat": { + "description": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", + "enum": [ + "NUMBER_WITH_TIMELINE", + "TIME_WITH_TIMELINE", + "NUMBER_WITH_DURATION" + ], + "type": "string" + } + }, + "required": [ + "DashManifests" + ], + "type": "object" + }, + "EncryptionContractConfiguration": { + "additionalProperties": false, + "description": "The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.", + "properties": { + "PresetSpeke20Audio": { + "description": "A collection of audio encryption presets.", + "enum": [ + "PRESET-AUDIO-1", + "PRESET-AUDIO-2", + "PRESET-AUDIO-3", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + }, + "PresetSpeke20Video": { + "description": "A collection of video encryption presets.", + "enum": [ + "PRESET-VIDEO-1", + "PRESET-VIDEO-2", + "PRESET-VIDEO-3", + "PRESET-VIDEO-4", + "PRESET-VIDEO-5", + "PRESET-VIDEO-6", + "PRESET-VIDEO-7", + "PRESET-VIDEO-8", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + } + }, + "required": [ + "PresetSpeke20Audio", + "PresetSpeke20Video" + ], + "type": "object" + }, + "HlsEncryption": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) encryption configuration.", + "properties": { + "ConstantInitializationVector": { + "description": "An HTTP Live Streaming (HLS) encryption configuration.", + "type": "string" + }, + "EncryptionMethod": { + "description": "The encryption method to use.", + "enum": [ + "AES_128", + "SAMPLE_AES" + ], + "type": "string" + }, + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "HlsManifest": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) manifest configuration.", + "properties": { + "AdMarkers": { + "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source.", + "enum": [ + "NONE", + "SCTE35_ENHANCED", + "PASSTHROUGH" + ], + "type": "string" + }, + "IncludeIframeOnlyStream": { + "description": "When enabled, an I-Frame only stream will be included in the output.", + "type": "boolean" + }, + "ManifestName": { + "$ref": "#/definitions/ManifestName" + }, + "ProgramDateTimeIntervalSeconds": { + "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.", + "type": "integer" + }, + "RepeatExtXKey": { + "description": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", + "type": "boolean" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + } + }, + "type": "object" + }, + "HlsPackage": { + "additionalProperties": false, + "description": "An HTTP Live Streaming (HLS) packaging configuration.", + "properties": { + "Encryption": { + "$ref": "#/definitions/HlsEncryption" + }, + "HlsManifests": { + "description": "A list of HLS manifest configurations.", + "items": { + "$ref": "#/definitions/HlsManifest" + }, + "type": "array" + }, + "IncludeDvbSubtitles": { + "description": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", + "type": "boolean" + }, + "SegmentDurationSeconds": { + "$ref": "#/definitions/SegmentDurationSeconds" + }, + "UseAudioRenditionGroup": { + "description": "When enabled, audio streams will be placed in rendition groups in the output.", + "type": "boolean" + } + }, + "required": [ + "HlsManifests" + ], + "type": "object" + }, + "ManifestName": { + "description": "An optional string to include in the name of the manifest.", + "type": "string" + }, + "MssEncryption": { + "additionalProperties": false, + "description": "A CMAF encryption configuration.", + "properties": { + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "object" + }, + "MssManifest": { + "additionalProperties": false, + "description": "A Microsoft Smooth Streaming (MSS) manifest configuration.", + "properties": { + "ManifestName": { + "$ref": "#/definitions/ManifestName" + }, + "StreamSelection": { + "$ref": "#/definitions/StreamSelection" + } + }, + "type": "object" + }, + "MssPackage": { + "additionalProperties": false, + "description": "A Microsoft Smooth Streaming (MSS) PackagingConfiguration.", + "properties": { + "Encryption": { + "$ref": "#/definitions/MssEncryption" + }, + "MssManifests": { + "description": "A list of MSS manifest configurations.", + "items": { + "$ref": "#/definitions/MssManifest" + }, + "type": "array" + }, + "SegmentDurationSeconds": { + "$ref": "#/definitions/SegmentDurationSeconds" + } + }, + "required": [ + "MssManifests" + ], + "type": "object" + }, + "RoleArn": { + "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.", + "type": "string" + }, + "SegmentDurationSeconds": { + "description": "Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.", + "type": "integer" + }, + "SpekeKeyProvider": { + "additionalProperties": false, + "description": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", + "properties": { + "EncryptionContractConfiguration": { + "$ref": "#/definitions/EncryptionContractConfiguration" + }, + "RoleArn": { + "$ref": "#/definitions/RoleArn" + }, + "SystemIds": { + "description": "The system IDs to include in key requests.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Url": { + "description": "The URL of the external key provider service.", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SystemIds", + "Url" + ], + "type": "object" + }, + "StreamSelection": { + "additionalProperties": false, + "description": "A StreamSelection configuration.", + "properties": { + "MaxVideoBitsPerSecond": { + "description": "The maximum video bitrate (bps) to include in output.", + "type": "integer" + }, + "MinVideoBitsPerSecond": { + "description": "The minimum video bitrate (bps) to include in output.", + "type": "integer" + }, + "StreamOrder": { + "description": "A directive that determines the order of streams in the output.", + "enum": [ + "ORIGINAL", + "VIDEO_BITRATE_ASCENDING", + "VIDEO_BITRATE_DESCENDING" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", + "/properties/HlsPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video", + "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Audio", + "/properties/MssPackage/Encryption/SpekeKeyProvider/EncryptionContractConfiguration/PresetSpeke20Video" + ], + "description": "Resource schema for AWS::MediaPackage::PackagingConfiguration", + "handlers": { + "create": { + "permissions": [ + "mediapackage-vod:CreatePackagingConfiguration", + "mediapackage-vod:DescribePackagingConfiguration", + "mediapackage-vod:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "mediapackage-vod:DescribePackagingConfiguration", + "mediapackage-vod:DeletePackagingConfiguration" + ] + }, + "list": { + "permissions": [ + "mediapackage-vod:ListPackagingConfigurations", + "mediapackage-vod:DescribePackagingGroup" + ] + }, + "read": { + "permissions": [ + "mediapackage-vod:DescribePackagingConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the PackagingConfiguration.", + "type": "string" + }, + "CmafPackage": { + "$ref": "#/definitions/CmafPackage", + "description": "A CMAF packaging configuration." + }, + "DashPackage": { + "$ref": "#/definitions/DashPackage", + "description": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration." + }, + "HlsPackage": { + "$ref": "#/definitions/HlsPackage", + "description": "An HTTP Live Streaming (HLS) packaging configuration." + }, + "Id": { + "description": "The ID of the PackagingConfiguration.", + "type": "string" + }, + "MssPackage": { + "$ref": "#/definitions/MssPackage", + "description": "A Microsoft Smooth Streaming (MSS) PackagingConfiguration." + }, + "PackagingGroupId": { + "description": "The ID of a PackagingGroup.", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "PackagingGroupId", + "Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaPackage::PackagingConfiguration" +} diff --git a/schema/aws-mediapackage-packaginggroup.json b/schema/aws-mediapackage-packaginggroup.json index 398a954..9ceed69 100644 --- a/schema/aws-mediapackage-packaginggroup.json +++ b/schema/aws-mediapackage-packaginggroup.json @@ -1,147 +1,147 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Id", - "/properties/Tags" - ], - "definitions": { - "Authorization": { - "additionalProperties": false, - "properties": { - "CdnIdentifierSecret": { - "description": "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.", - "type": "string" - }, - "SecretsRoleArn": { - "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", - "type": "string" - } - }, - "required": [ - "CdnIdentifierSecret", - "SecretsRoleArn" - ], - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "description": "Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs.", - "maxLength": 512, - "minLength": 1, - "pattern": "\\A\\/aws\\/MediaPackage\\/[0-9a-zA-Z-_\\/\\.#]+\\Z", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaPackage::PackagingGroup", - "handlers": { - "create": { - "permissions": [ - "mediapackage-vod:CreatePackagingGroup", - "mediapackage-vod:DescribePackagingGroup", - "mediapackage-vod:TagResource", - "mediapackage-vod:ConfigureLogs", - "iam:PassRole", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "mediapackage-vod:DescribePackagingGroup", - "mediapackage-vod:DeletePackagingGroup" - ] - }, - "list": { - "permissions": [ - "mediapackage-vod:ListPackagingGroups" - ] - }, - "read": { - "permissions": [ - "mediapackage-vod:DescribePackagingGroup" - ] - }, - "update": { - "permissions": [ - "mediapackage-vod:DescribePackagingGroup", - "mediapackage-vod:UpdatePackagingGroup", - "mediapackage-vod:ConfigureLogs", - "mediapackage-vod:TagResource", - "iam:PassRole", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The ARN of the PackagingGroup.", - "type": "string" - }, - "Authorization": { - "$ref": "#/definitions/Authorization", - "description": "CDN Authorization" - }, - "DomainName": { - "description": "The fully qualified domain name for Assets in the PackagingGroup.", - "type": "string" - }, - "EgressAccessLogs": { - "$ref": "#/definitions/LogConfiguration", - "description": "The configuration parameters for egress access logging." - }, - "Id": { - "description": "The ID of the PackagingGroup.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\A[0-9a-zA-Z-_]+\\Z", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DomainName" - ], - "required": [ - "Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackage.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MediaPackage::PackagingGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Id", + "/properties/Tags" + ], + "definitions": { + "Authorization": { + "additionalProperties": false, + "properties": { + "CdnIdentifierSecret": { + "description": "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.", + "type": "string" + }, + "SecretsRoleArn": { + "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", + "type": "string" + } + }, + "required": [ + "CdnIdentifierSecret", + "SecretsRoleArn" + ], + "type": "object" + }, + "LogConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupName": { + "description": "Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs.", + "maxLength": 512, + "minLength": 1, + "pattern": "\\A\\/aws\\/MediaPackage\\/[0-9a-zA-Z-_\\/\\.#]+\\Z", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaPackage::PackagingGroup", + "handlers": { + "create": { + "permissions": [ + "mediapackage-vod:CreatePackagingGroup", + "mediapackage-vod:DescribePackagingGroup", + "mediapackage-vod:TagResource", + "mediapackage-vod:ConfigureLogs", + "iam:PassRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "mediapackage-vod:DescribePackagingGroup", + "mediapackage-vod:DeletePackagingGroup" + ] + }, + "list": { + "permissions": [ + "mediapackage-vod:ListPackagingGroups" + ] + }, + "read": { + "permissions": [ + "mediapackage-vod:DescribePackagingGroup" + ] + }, + "update": { + "permissions": [ + "mediapackage-vod:DescribePackagingGroup", + "mediapackage-vod:UpdatePackagingGroup", + "mediapackage-vod:ConfigureLogs", + "mediapackage-vod:TagResource", + "iam:PassRole", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the PackagingGroup.", + "type": "string" + }, + "Authorization": { + "$ref": "#/definitions/Authorization", + "description": "CDN Authorization" + }, + "DomainName": { + "description": "The fully qualified domain name for Assets in the PackagingGroup.", + "type": "string" + }, + "EgressAccessLogs": { + "$ref": "#/definitions/LogConfiguration", + "description": "The configuration parameters for egress access logging." + }, + "Id": { + "description": "The ID of the PackagingGroup.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\A[0-9a-zA-Z-_]+\\Z", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DomainName" + ], + "required": [ + "Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackage.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MediaPackage::PackagingGroup" +} diff --git a/schema/aws-mediapackagev2-channel.json b/schema/aws-mediapackagev2-channel.json index c5c85ef..dfb7cac 100644 --- a/schema/aws-mediapackagev2-channel.json +++ b/schema/aws-mediapackagev2-channel.json @@ -1,173 +1,178 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ChannelGroupName", - "/properties/ChannelName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelGroupName", - "/properties/ChannelName", - "/properties/InputType" - ], - "definitions": { - "IngestEndpoint": { - "additionalProperties": false, - "description": "

The ingest domain URL where the source stream should be sent.

", - "properties": { - "Id": { - "description": "

The system-generated unique identifier for the IngestEndpoint.

", - "type": "string" - }, - "Url": { - "description": "

The ingest domain URL where the source stream should be sent.

", - "type": "string" - } - }, - "type": "object" - }, - "InputType": { - "enum": [ - "HLS", - "CMAF" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "

Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

", - "handlers": { - "create": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:CreateChannel" - ] - }, - "delete": { - "permissions": [ - "mediapackagev2:GetChannel", - "mediapackagev2:DeleteChannel" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ChannelGroupName": { - "$ref": "resource-schema.json#/properties/ChannelGroupName" - } - }, - "required": [ - "ChannelGroupName" - ] - }, - "permissions": [ - "mediapackagev2:ListChannels" - ] - }, - "read": { - "permissions": [ - "mediapackagev2:GetChannel" - ] - }, - "update": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:UntagResource", - "mediapackagev2:ListTagsForResource", - "mediapackagev2:UpdateChannel" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) associated with the resource.

", - "type": "string" - }, - "ChannelGroupName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ChannelName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "CreatedAt": { - "description": "

The date and time the channel was created.

", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "

Enter any descriptive text that helps you to identify the channel.

", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "IngestEndpointUrls": { - "items": { - "type": "string" - }, - "type": "array" - }, - "IngestEndpoints": { - "description": "

The list of ingest endpoints.

", - "items": { - "$ref": "#/definitions/IngestEndpoint" - }, - "type": "array" - }, - "InputType": { - "$ref": "#/definitions/InputType" - }, - "ModifiedAt": { - "description": "

The date and time the channel was modified.

", - "format": "date-time", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/IngestEndpoints", - "/properties/IngestEndpointUrls", - "/properties/ModifiedAt" - ], - "required": [ - "ChannelGroupName", - "ChannelName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaPackageV2::Channel" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ChannelGroupName", + "/properties/ChannelName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelGroupName", + "/properties/ChannelName", + "/properties/InputType" + ], + "definitions": { + "IngestEndpoint": { + "additionalProperties": false, + "description": "

The ingest domain URL where the source stream should be sent.

", + "properties": { + "Id": { + "description": "

The system-generated unique identifier for the IngestEndpoint.

", + "type": "string" + }, + "Url": { + "description": "

The ingest domain URL where the source stream should be sent.

", + "type": "string" + } + }, + "type": "object" + }, + "InputType": { + "enum": [ + "HLS", + "CMAF" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "

Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

", + "handlers": { + "create": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:CreateChannel" + ] + }, + "delete": { + "permissions": [ + "mediapackagev2:GetChannel", + "mediapackagev2:DeleteChannel" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ChannelGroupName": { + "$ref": "resource-schema.json#/properties/ChannelGroupName" + } + }, + "required": [ + "ChannelGroupName" + ] + }, + "permissions": [ + "mediapackagev2:ListChannels" + ] + }, + "read": { + "permissions": [ + "mediapackagev2:GetChannel" + ] + }, + "update": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource", + "mediapackagev2:UpdateChannel" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) associated with the resource.

", + "type": "string" + }, + "ChannelGroupName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ChannelName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "CreatedAt": { + "description": "

The date and time the channel was created.

", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "

Enter any descriptive text that helps you to identify the channel.

", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "IngestEndpointUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, + "IngestEndpoints": { + "description": "

The list of ingest endpoints.

", + "items": { + "$ref": "#/definitions/IngestEndpoint" + }, + "type": "array" + }, + "InputType": { + "$ref": "#/definitions/InputType" + }, + "ModifiedAt": { + "description": "

The date and time the channel was modified.

", + "format": "date-time", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/IngestEndpoints", + "/properties/IngestEndpointUrls", + "/properties/ModifiedAt" + ], + "required": [ + "ChannelGroupName", + "ChannelName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaPackageV2::Channel" +} diff --git a/schema/aws-mediapackagev2-channelgroup.json b/schema/aws-mediapackagev2-channelgroup.json index 24d9534..8a676bc 100644 --- a/schema/aws-mediapackagev2-channelgroup.json +++ b/schema/aws-mediapackagev2-channelgroup.json @@ -1,118 +1,123 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ChannelGroupName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "

Represents a channel group that facilitates the grouping of multiple channels.

", - "handlers": { - "create": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:CreateChannelGroup" - ] - }, - "delete": { - "permissions": [ - "mediapackagev2:GetChannelGroup", - "mediapackagev2:DeleteChannelGroup" - ] - }, - "list": { - "permissions": [ - "mediapackagev2:ListChannelGroups" - ] - }, - "read": { - "permissions": [ - "mediapackagev2:GetChannelGroup" - ] - }, - "update": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:UntagResource", - "mediapackagev2:ListTagsForResource", - "mediapackagev2:UpdateChannelGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) associated with the resource.

", - "type": "string" - }, - "ChannelGroupName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "CreatedAt": { - "description": "

The date and time the channel group was created.

", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "

Enter any descriptive text that helps you to identify the channel group.

", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "EgressDomain": { - "description": "

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

", - "type": "string" - }, - "ModifiedAt": { - "description": "

The date and time the channel group was modified.

", - "format": "date-time", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/EgressDomain", - "/properties/ModifiedAt" - ], - "required": [ - "ChannelGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaPackageV2::ChannelGroup" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ChannelGroupName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "

Represents a channel group that facilitates the grouping of multiple channels.

", + "handlers": { + "create": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:CreateChannelGroup" + ] + }, + "delete": { + "permissions": [ + "mediapackagev2:GetChannelGroup", + "mediapackagev2:DeleteChannelGroup" + ] + }, + "list": { + "permissions": [ + "mediapackagev2:ListChannelGroups" + ] + }, + "read": { + "permissions": [ + "mediapackagev2:GetChannelGroup" + ] + }, + "update": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource", + "mediapackagev2:UpdateChannelGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) associated with the resource.

", + "type": "string" + }, + "ChannelGroupName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "CreatedAt": { + "description": "

The date and time the channel group was created.

", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "

Enter any descriptive text that helps you to identify the channel group.

", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "EgressDomain": { + "description": "

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

", + "type": "string" + }, + "ModifiedAt": { + "description": "

The date and time the channel group was modified.

", + "format": "date-time", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/EgressDomain", + "/properties/ModifiedAt" + ], + "required": [ + "ChannelGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaPackageV2::ChannelGroup" +} diff --git a/schema/aws-mediapackagev2-channelpolicy.json b/schema/aws-mediapackagev2-channelpolicy.json index 0420402..9708c25 100644 --- a/schema/aws-mediapackagev2-channelpolicy.json +++ b/schema/aws-mediapackagev2-channelpolicy.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelGroupName", - "/properties/ChannelName" - ], - "description": "

Represents a resource-based policy that allows or denies access to a channel.

", - "handlers": { - "create": { - "permissions": [ - "mediapackagev2:GetChannelPolicy", - "mediapackagev2:PutChannelPolicy" - ] - }, - "delete": { - "permissions": [ - "mediapackagev2:GetChannelPolicy", - "mediapackagev2:DeleteChannelPolicy" - ] - }, - "read": { - "permissions": [ - "mediapackagev2:GetChannelPolicy" - ] - }, - "update": { - "permissions": [ - "mediapackagev2:GetChannelPolicy", - "mediapackagev2:PutChannelPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelGroupName", - "/properties/ChannelName" - ], - "properties": { - "ChannelGroupName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ChannelName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Policy": { - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "ChannelGroupName", - "ChannelName", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::MediaPackageV2::ChannelPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelGroupName", + "/properties/ChannelName" + ], + "description": "

Represents a resource-based policy that allows or denies access to a channel.

", + "handlers": { + "create": { + "permissions": [ + "mediapackagev2:GetChannelPolicy", + "mediapackagev2:PutChannelPolicy" + ] + }, + "delete": { + "permissions": [ + "mediapackagev2:GetChannelPolicy", + "mediapackagev2:DeleteChannelPolicy" + ] + }, + "read": { + "permissions": [ + "mediapackagev2:GetChannelPolicy" + ] + }, + "update": { + "permissions": [ + "mediapackagev2:GetChannelPolicy", + "mediapackagev2:PutChannelPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelGroupName", + "/properties/ChannelName" + ], + "properties": { + "ChannelGroupName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ChannelName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Policy": { + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "ChannelGroupName", + "ChannelName", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::MediaPackageV2::ChannelPolicy" +} diff --git a/schema/aws-mediapackagev2-originendpoint.json b/schema/aws-mediapackagev2-originendpoint.json index d91e30a..b036804 100644 --- a/schema/aws-mediapackagev2-originendpoint.json +++ b/schema/aws-mediapackagev2-originendpoint.json @@ -1,708 +1,715 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ChannelGroupName", - "/properties/ChannelName", - "/properties/OriginEndpointName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelGroupName", - "/properties/ChannelName", - "/properties/OriginEndpointName" - ], - "definitions": { - "AdMarkerDash": { - "enum": [ - "BINARY", - "XML" - ], - "type": "string" - }, - "AdMarkerHls": { - "enum": [ - "DATERANGE" - ], - "type": "string" - }, - "CmafEncryptionMethod": { - "enum": [ - "CENC", - "CBCS" - ], - "type": "string" - }, - "ContainerType": { - "enum": [ - "TS", - "CMAF" - ], - "type": "string" - }, - "DashDrmSignaling": { - "enum": [ - "INDIVIDUAL", - "REFERENCED" - ], - "type": "string" - }, - "DashManifestConfiguration": { - "additionalProperties": false, - "description": "

Retrieve the DASH manifest configuration.

", - "properties": { - "DrmSignaling": { - "$ref": "#/definitions/DashDrmSignaling" - }, - "FilterConfiguration": { - "$ref": "#/definitions/FilterConfiguration" - }, - "ManifestName": { - "description": "

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ManifestWindowSeconds": { - "description": "

The total duration (in seconds) of the manifest's content.

", - "type": "integer" - }, - "MinBufferTimeSeconds": { - "description": "

Minimum amount of content (in seconds) that a player must keep available in the buffer.

", - "type": "integer" - }, - "MinUpdatePeriodSeconds": { - "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

", - "type": "integer" - }, - "PeriodTriggers": { - "description": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

", - "items": { - "$ref": "#/definitions/DashPeriodTrigger" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ScteDash": { - "$ref": "#/definitions/ScteDash" - }, - "SegmentTemplateFormat": { - "$ref": "#/definitions/DashSegmentTemplateFormat" - }, - "SuggestedPresentationDelaySeconds": { - "description": "

The amount of time (in seconds) that the player should be from the end of the manifest.

", - "type": "integer" - }, - "UtcTiming": { - "$ref": "#/definitions/DashUtcTiming" - } - }, - "required": [ - "ManifestName" - ], - "type": "object" - }, - "DashPeriodTrigger": { - "enum": [ - "AVAILS", - "DRM_KEY_ROTATION", - "SOURCE_CHANGES", - "SOURCE_DISRUPTIONS", - "NONE" - ], - "type": "string" - }, - "DashSegmentTemplateFormat": { - "enum": [ - "NUMBER_WITH_TIMELINE" - ], - "type": "string" - }, - "DashUtcTiming": { - "additionalProperties": false, - "description": "

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

", - "properties": { - "TimingMode": { - "$ref": "#/definitions/DashUtcTimingMode" - }, - "TimingSource": { - "description": "

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DashUtcTimingMode": { - "enum": [ - "HTTP_HEAD", - "HTTP_ISO", - "HTTP_XSDATE", - "UTC_DIRECT" - ], - "type": "string" - }, - "DrmSystem": { - "enum": [ - "CLEAR_KEY_AES_128", - "FAIRPLAY", - "PLAYREADY", - "WIDEVINE" - ], - "type": "string" - }, - "Encryption": { - "additionalProperties": false, - "description": "

The parameters for encrypting content.

", - "properties": { - "ConstantInitializationVector": { - "description": "

A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

", - "maxLength": 32, - "minLength": 32, - "pattern": "^[0-9a-fA-F]+$", - "type": "string" - }, - "EncryptionMethod": { - "$ref": "#/definitions/EncryptionMethod" - }, - "KeyRotationIntervalSeconds": { - "description": "

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

\n

The following example setting causes the service to rotate keys every thirty minutes: 1800\n

", - "maximum": 31536000, - "minimum": 300, - "type": "integer" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/SpekeKeyProvider" - } - }, - "required": [ - "EncryptionMethod", - "SpekeKeyProvider" - ], - "type": "object" - }, - "EncryptionContractConfiguration": { - "additionalProperties": false, - "description": "

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

", - "properties": { - "PresetSpeke20Audio": { - "$ref": "#/definitions/PresetSpeke20Audio" - }, - "PresetSpeke20Video": { - "$ref": "#/definitions/PresetSpeke20Video" - } - }, - "required": [ - "PresetSpeke20Audio", - "PresetSpeke20Video" - ], - "type": "object" - }, - "EncryptionMethod": { - "additionalProperties": false, - "description": "

The encryption type.

", - "properties": { - "CmafEncryptionMethod": { - "$ref": "#/definitions/CmafEncryptionMethod" - }, - "TsEncryptionMethod": { - "$ref": "#/definitions/TsEncryptionMethod" - } - }, - "type": "object" - }, - "EndpointErrorCondition": { - "enum": [ - "STALE_MANIFEST", - "INCOMPLETE_MANIFEST", - "MISSING_DRM_KEY", - "SLATE_INPUT" - ], - "type": "string" - }, - "FilterConfiguration": { - "additionalProperties": false, - "description": "

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

", - "properties": { - "End": { - "description": "

Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

", - "format": "date-time", - "type": "string" - }, - "ManifestFilter": { - "description": "

Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Start": { - "description": "

Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

", - "format": "date-time", - "type": "string" - }, - "TimeDelaySeconds": { - "description": "

Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

", - "maximum": 1209600, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "ForceEndpointErrorConfiguration": { - "additionalProperties": false, - "description": "

The failover settings for the endpoint.

", - "properties": { - "EndpointErrorConditions": { - "description": "

The failover settings for the endpoint. The options are:

\n
    \n
  • \n

    \n STALE_MANIFEST - The manifest stalled and there a no new segments or parts.

    \n
    • \n
  • \n

    \n INCOMPLETE_MANIFEST - There is a gap in the manifest.

    \n
    • \n
  • \n

    \n MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

    \n
    • \n
", - "items": { - "$ref": "#/definitions/EndpointErrorCondition" - }, - "type": "array" - } - }, - "type": "object" - }, - "HlsManifestConfiguration": { - "additionalProperties": false, - "description": "

Retrieve the HTTP live streaming (HLS) manifest configuration.

", - "properties": { - "ChildManifestName": { - "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "FilterConfiguration": { - "$ref": "#/definitions/FilterConfiguration" - }, - "ManifestName": { - "description": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ManifestWindowSeconds": { - "description": "

The total duration (in seconds) of the manifest's content.

", - "type": "integer" - }, - "ProgramDateTimeIntervalSeconds": { - "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", - "type": "integer" - }, - "ScteHls": { - "$ref": "#/definitions/ScteHls" - }, - "Url": { - "description": "

The egress domain URL for stream delivery from MediaPackage.

", - "type": "string" - } - }, - "required": [ - "ManifestName" - ], - "type": "object" - }, - "LowLatencyHlsManifestConfiguration": { - "additionalProperties": false, - "description": "

Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.

", - "properties": { - "ChildManifestName": { - "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "FilterConfiguration": { - "$ref": "#/definitions/FilterConfiguration" - }, - "ManifestName": { - "description": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ManifestWindowSeconds": { - "description": "

The total duration (in seconds) of the manifest's content.

", - "type": "integer" - }, - "ProgramDateTimeIntervalSeconds": { - "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", - "type": "integer" - }, - "ScteHls": { - "$ref": "#/definitions/ScteHls" - }, - "Url": { - "description": "

The egress domain URL for stream delivery from MediaPackage.

", - "type": "string" - } - }, - "required": [ - "ManifestName" - ], - "type": "object" - }, - "PresetSpeke20Audio": { - "enum": [ - "PRESET_AUDIO_1", - "PRESET_AUDIO_2", - "PRESET_AUDIO_3", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - }, - "PresetSpeke20Video": { - "enum": [ - "PRESET_VIDEO_1", - "PRESET_VIDEO_2", - "PRESET_VIDEO_3", - "PRESET_VIDEO_4", - "PRESET_VIDEO_5", - "PRESET_VIDEO_6", - "PRESET_VIDEO_7", - "PRESET_VIDEO_8", - "SHARED", - "UNENCRYPTED" - ], - "type": "string" - }, - "Scte": { - "additionalProperties": false, - "description": "

The SCTE configuration.

", - "properties": { - "ScteFilter": { - "description": "

The SCTE-35 message types that you want to be treated as ad markers in the output.

", - "items": { - "$ref": "#/definitions/ScteFilter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScteDash": { - "additionalProperties": false, - "description": "

The SCTE configuration.

", - "properties": { - "AdMarkerDash": { - "$ref": "#/definitions/AdMarkerDash" - } - }, - "type": "object" - }, - "ScteFilter": { - "enum": [ - "SPLICE_INSERT", - "BREAK", - "PROVIDER_ADVERTISEMENT", - "DISTRIBUTOR_ADVERTISEMENT", - "PROVIDER_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", - "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", - "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", - "PROGRAM" - ], - "type": "string" - }, - "ScteHls": { - "additionalProperties": false, - "description": "

The SCTE configuration.

", - "properties": { - "AdMarkerHls": { - "$ref": "#/definitions/AdMarkerHls" - } - }, - "type": "object" - }, - "Segment": { - "additionalProperties": false, - "description": "

The segment configuration, including the segment name, duration, and other configuration values.

", - "properties": { - "Encryption": { - "$ref": "#/definitions/Encryption" - }, - "IncludeIframeOnlyStreams": { - "description": "

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

", - "type": "boolean" - }, - "Scte": { - "$ref": "#/definitions/Scte" - }, - "SegmentDurationSeconds": { - "description": "

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

", - "maximum": 30, - "minimum": 1, - "type": "integer" - }, - "SegmentName": { - "description": "

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "TsIncludeDvbSubtitles": { - "description": "

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

", - "type": "boolean" - }, - "TsUseAudioRenditionGroup": { - "description": "

When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

", - "type": "boolean" - } - }, - "type": "object" - }, - "SpekeKeyProvider": { - "additionalProperties": false, - "description": "

The parameters for the SPEKE key provider.

", - "properties": { - "DrmSystems": { - "description": "

The DRM solution provider you're using to protect your content during distribution.

", - "items": { - "$ref": "#/definitions/DrmSystem" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "EncryptionContractConfiguration": { - "$ref": "#/definitions/EncryptionContractConfiguration" - }, - "ResourceId": { - "description": "

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

\n

The following example shows a resource ID: MovieNight20171126093045\n

", - "maxLength": 256, - "minLength": 1, - "pattern": "^[0-9a-zA-Z_-]+$", - "type": "string" - }, - "RoleArn": { - "description": "

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

\n

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n

", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Url": { - "description": "

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

\n

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DrmSystems", - "EncryptionContractConfiguration", - "ResourceId", - "RoleArn", - "Url" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "TsEncryptionMethod": { - "enum": [ - "AES_128", - "SAMPLE_AES" - ], - "type": "string" - } - }, - "description": "

Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.

", - "handlers": { - "create": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:CreateOriginEndpoint", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "mediapackagev2:GetOriginEndpoint", - "mediapackagev2:DeleteOriginEndpoint" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ChannelGroupName": { - "$ref": "resource-schema.json#/properties/ChannelGroupName" - }, - "ChannelName": { - "$ref": "resource-schema.json#/properties/ChannelName" - } - }, - "required": [ - "ChannelGroupName", - "ChannelName" - ] - }, - "permissions": [ - "mediapackagev2:ListOriginEndpoints" - ] - }, - "read": { - "permissions": [ - "mediapackagev2:GetOriginEndpoint" - ] - }, - "update": { - "permissions": [ - "mediapackagev2:TagResource", - "mediapackagev2:UntagResource", - "mediapackagev2:ListTagsForResource", - "mediapackagev2:UpdateOriginEndpoint", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) associated with the resource.

", - "type": "string" - }, - "ChannelGroupName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ChannelName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ContainerType": { - "$ref": "#/definitions/ContainerType" - }, - "CreatedAt": { - "description": "

The date and time the origin endpoint was created.

", - "format": "date-time", - "type": "string" - }, - "DashManifestUrls": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DashManifests": { - "description": "

A DASH manifest configuration.

", - "items": { - "$ref": "#/definitions/DashManifestConfiguration" - }, - "type": "array" - }, - "Description": { - "description": "

Enter any descriptive text that helps you to identify the origin endpoint.

", - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "ForceEndpointErrorConfiguration": { - "$ref": "#/definitions/ForceEndpointErrorConfiguration" - }, - "HlsManifestUrls": { - "items": { - "type": "string" - }, - "type": "array" - }, - "HlsManifests": { - "description": "

An HTTP live streaming (HLS) manifest configuration.

", - "items": { - "$ref": "#/definitions/HlsManifestConfiguration" - }, - "type": "array" - }, - "LowLatencyHlsManifestUrls": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LowLatencyHlsManifests": { - "description": "

A low-latency HLS manifest configuration.

", - "items": { - "$ref": "#/definitions/LowLatencyHlsManifestConfiguration" - }, - "type": "array" - }, - "ModifiedAt": { - "description": "

The date and time the origin endpoint was modified.

", - "format": "date-time", - "type": "string" - }, - "OriginEndpointName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Segment": { - "$ref": "#/definitions/Segment" - }, - "StartoverWindowSeconds": { - "description": "

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

", - "maximum": 1209600, - "minimum": 60, - "type": "integer" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/DashManifestUrls", - "/properties/HlsManifestUrls", - "/properties/LowLatencyHlsManifestUrls", - "/properties/ModifiedAt", - "/properties/LowLatencyHlsManifests/*/Url", - "/properties/HlsManifests/*/Url" - ], - "required": [ - "ChannelGroupName", - "ChannelName", - "OriginEndpointName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaPackageV2::OriginEndpoint" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ChannelGroupName", + "/properties/ChannelName", + "/properties/OriginEndpointName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelGroupName", + "/properties/ChannelName", + "/properties/OriginEndpointName" + ], + "definitions": { + "AdMarkerDash": { + "enum": [ + "BINARY", + "XML" + ], + "type": "string" + }, + "AdMarkerHls": { + "enum": [ + "DATERANGE" + ], + "type": "string" + }, + "CmafEncryptionMethod": { + "enum": [ + "CENC", + "CBCS" + ], + "type": "string" + }, + "ContainerType": { + "enum": [ + "TS", + "CMAF" + ], + "type": "string" + }, + "DashDrmSignaling": { + "enum": [ + "INDIVIDUAL", + "REFERENCED" + ], + "type": "string" + }, + "DashManifestConfiguration": { + "additionalProperties": false, + "description": "

Retrieve the DASH manifest configuration.

", + "properties": { + "DrmSignaling": { + "$ref": "#/definitions/DashDrmSignaling" + }, + "FilterConfiguration": { + "$ref": "#/definitions/FilterConfiguration" + }, + "ManifestName": { + "description": "

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ManifestWindowSeconds": { + "description": "

The total duration (in seconds) of the manifest's content.

", + "type": "integer" + }, + "MinBufferTimeSeconds": { + "description": "

Minimum amount of content (in seconds) that a player must keep available in the buffer.

", + "type": "integer" + }, + "MinUpdatePeriodSeconds": { + "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

", + "type": "integer" + }, + "PeriodTriggers": { + "description": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

", + "items": { + "$ref": "#/definitions/DashPeriodTrigger" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ScteDash": { + "$ref": "#/definitions/ScteDash" + }, + "SegmentTemplateFormat": { + "$ref": "#/definitions/DashSegmentTemplateFormat" + }, + "SuggestedPresentationDelaySeconds": { + "description": "

The amount of time (in seconds) that the player should be from the end of the manifest.

", + "type": "integer" + }, + "UtcTiming": { + "$ref": "#/definitions/DashUtcTiming" + } + }, + "required": [ + "ManifestName" + ], + "type": "object" + }, + "DashPeriodTrigger": { + "enum": [ + "AVAILS", + "DRM_KEY_ROTATION", + "SOURCE_CHANGES", + "SOURCE_DISRUPTIONS", + "NONE" + ], + "type": "string" + }, + "DashSegmentTemplateFormat": { + "enum": [ + "NUMBER_WITH_TIMELINE" + ], + "type": "string" + }, + "DashUtcTiming": { + "additionalProperties": false, + "description": "

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

", + "properties": { + "TimingMode": { + "$ref": "#/definitions/DashUtcTimingMode" + }, + "TimingSource": { + "description": "

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DashUtcTimingMode": { + "enum": [ + "HTTP_HEAD", + "HTTP_ISO", + "HTTP_XSDATE", + "UTC_DIRECT" + ], + "type": "string" + }, + "DrmSystem": { + "enum": [ + "CLEAR_KEY_AES_128", + "FAIRPLAY", + "PLAYREADY", + "WIDEVINE", + "IRDETO" + ], + "type": "string" + }, + "Encryption": { + "additionalProperties": false, + "description": "

The parameters for encrypting content.

", + "properties": { + "ConstantInitializationVector": { + "description": "

A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

", + "maxLength": 32, + "minLength": 32, + "pattern": "^[0-9a-fA-F]+$", + "type": "string" + }, + "EncryptionMethod": { + "$ref": "#/definitions/EncryptionMethod" + }, + "KeyRotationIntervalSeconds": { + "description": "

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

\n

The following example setting causes the service to rotate keys every thirty minutes: 1800\n

", + "maximum": 31536000, + "minimum": 300, + "type": "integer" + }, + "SpekeKeyProvider": { + "$ref": "#/definitions/SpekeKeyProvider" + } + }, + "required": [ + "EncryptionMethod", + "SpekeKeyProvider" + ], + "type": "object" + }, + "EncryptionContractConfiguration": { + "additionalProperties": false, + "description": "

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

", + "properties": { + "PresetSpeke20Audio": { + "$ref": "#/definitions/PresetSpeke20Audio" + }, + "PresetSpeke20Video": { + "$ref": "#/definitions/PresetSpeke20Video" + } + }, + "required": [ + "PresetSpeke20Audio", + "PresetSpeke20Video" + ], + "type": "object" + }, + "EncryptionMethod": { + "additionalProperties": false, + "description": "

The encryption type.

", + "properties": { + "CmafEncryptionMethod": { + "$ref": "#/definitions/CmafEncryptionMethod" + }, + "TsEncryptionMethod": { + "$ref": "#/definitions/TsEncryptionMethod" + } + }, + "type": "object" + }, + "EndpointErrorCondition": { + "enum": [ + "STALE_MANIFEST", + "INCOMPLETE_MANIFEST", + "MISSING_DRM_KEY", + "SLATE_INPUT" + ], + "type": "string" + }, + "FilterConfiguration": { + "additionalProperties": false, + "description": "

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

", + "properties": { + "End": { + "description": "

Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

", + "format": "date-time", + "type": "string" + }, + "ManifestFilter": { + "description": "

Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Start": { + "description": "

Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

", + "format": "date-time", + "type": "string" + }, + "TimeDelaySeconds": { + "description": "

Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

", + "maximum": 1209600, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ForceEndpointErrorConfiguration": { + "additionalProperties": false, + "description": "

The failover settings for the endpoint.

", + "properties": { + "EndpointErrorConditions": { + "description": "

The failover settings for the endpoint. The options are:

\n
    \n
  • \n

    \n STALE_MANIFEST - The manifest stalled and there a no new segments or parts.

    \n
    • \n
  • \n

    \n INCOMPLETE_MANIFEST - There is a gap in the manifest.

    \n
    • \n
  • \n

    \n MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

    \n
    • \n
", + "items": { + "$ref": "#/definitions/EndpointErrorCondition" + }, + "type": "array" + } + }, + "type": "object" + }, + "HlsManifestConfiguration": { + "additionalProperties": false, + "description": "

Retrieve the HTTP live streaming (HLS) manifest configuration.

", + "properties": { + "ChildManifestName": { + "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "FilterConfiguration": { + "$ref": "#/definitions/FilterConfiguration" + }, + "ManifestName": { + "description": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ManifestWindowSeconds": { + "description": "

The total duration (in seconds) of the manifest's content.

", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "type": "integer" + }, + "ScteHls": { + "$ref": "#/definitions/ScteHls" + }, + "Url": { + "description": "

The egress domain URL for stream delivery from MediaPackage.

", + "type": "string" + } + }, + "required": [ + "ManifestName" + ], + "type": "object" + }, + "LowLatencyHlsManifestConfiguration": { + "additionalProperties": false, + "description": "

Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.

", + "properties": { + "ChildManifestName": { + "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "FilterConfiguration": { + "$ref": "#/definitions/FilterConfiguration" + }, + "ManifestName": { + "description": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ManifestWindowSeconds": { + "description": "

The total duration (in seconds) of the manifest's content.

", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "type": "integer" + }, + "ScteHls": { + "$ref": "#/definitions/ScteHls" + }, + "Url": { + "description": "

The egress domain URL for stream delivery from MediaPackage.

", + "type": "string" + } + }, + "required": [ + "ManifestName" + ], + "type": "object" + }, + "PresetSpeke20Audio": { + "enum": [ + "PRESET_AUDIO_1", + "PRESET_AUDIO_2", + "PRESET_AUDIO_3", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + }, + "PresetSpeke20Video": { + "enum": [ + "PRESET_VIDEO_1", + "PRESET_VIDEO_2", + "PRESET_VIDEO_3", + "PRESET_VIDEO_4", + "PRESET_VIDEO_5", + "PRESET_VIDEO_6", + "PRESET_VIDEO_7", + "PRESET_VIDEO_8", + "SHARED", + "UNENCRYPTED" + ], + "type": "string" + }, + "Scte": { + "additionalProperties": false, + "description": "

The SCTE configuration.

", + "properties": { + "ScteFilter": { + "description": "

The SCTE-35 message types that you want to be treated as ad markers in the output.

", + "items": { + "$ref": "#/definitions/ScteFilter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScteDash": { + "additionalProperties": false, + "description": "

The SCTE configuration.

", + "properties": { + "AdMarkerDash": { + "$ref": "#/definitions/AdMarkerDash" + } + }, + "type": "object" + }, + "ScteFilter": { + "enum": [ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", + "PROGRAM" + ], + "type": "string" + }, + "ScteHls": { + "additionalProperties": false, + "description": "

The SCTE configuration.

", + "properties": { + "AdMarkerHls": { + "$ref": "#/definitions/AdMarkerHls" + } + }, + "type": "object" + }, + "Segment": { + "additionalProperties": false, + "description": "

The segment configuration, including the segment name, duration, and other configuration values.

", + "properties": { + "Encryption": { + "$ref": "#/definitions/Encryption" + }, + "IncludeIframeOnlyStreams": { + "description": "

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

", + "type": "boolean" + }, + "Scte": { + "$ref": "#/definitions/Scte" + }, + "SegmentDurationSeconds": { + "description": "

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "SegmentName": { + "description": "

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "TsIncludeDvbSubtitles": { + "description": "

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

", + "type": "boolean" + }, + "TsUseAudioRenditionGroup": { + "description": "

When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

", + "type": "boolean" + } + }, + "type": "object" + }, + "SpekeKeyProvider": { + "additionalProperties": false, + "description": "

The parameters for the SPEKE key provider.

", + "properties": { + "DrmSystems": { + "description": "

The DRM solution provider you're using to protect your content during distribution.

", + "items": { + "$ref": "#/definitions/DrmSystem" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "EncryptionContractConfiguration": { + "$ref": "#/definitions/EncryptionContractConfiguration" + }, + "ResourceId": { + "description": "

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

\n

The following example shows a resource ID: MovieNight20171126093045\n

", + "maxLength": 256, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]+$", + "type": "string" + }, + "RoleArn": { + "description": "

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

\n

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n

", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Url": { + "description": "

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

\n

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DrmSystems", + "EncryptionContractConfiguration", + "ResourceId", + "RoleArn", + "Url" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "TsEncryptionMethod": { + "enum": [ + "AES_128", + "SAMPLE_AES" + ], + "type": "string" + } + }, + "description": "

Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.

", + "handlers": { + "create": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:CreateOriginEndpoint", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "mediapackagev2:GetOriginEndpoint", + "mediapackagev2:DeleteOriginEndpoint" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ChannelGroupName": { + "$ref": "resource-schema.json#/properties/ChannelGroupName" + }, + "ChannelName": { + "$ref": "resource-schema.json#/properties/ChannelName" + } + }, + "required": [ + "ChannelGroupName", + "ChannelName" + ] + }, + "permissions": [ + "mediapackagev2:ListOriginEndpoints" + ] + }, + "read": { + "permissions": [ + "mediapackagev2:GetOriginEndpoint" + ] + }, + "update": { + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource", + "mediapackagev2:UpdateOriginEndpoint", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) associated with the resource.

", + "type": "string" + }, + "ChannelGroupName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ChannelName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ContainerType": { + "$ref": "#/definitions/ContainerType" + }, + "CreatedAt": { + "description": "

The date and time the origin endpoint was created.

", + "format": "date-time", + "type": "string" + }, + "DashManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, + "DashManifests": { + "description": "

A DASH manifest configuration.

", + "items": { + "$ref": "#/definitions/DashManifestConfiguration" + }, + "type": "array" + }, + "Description": { + "description": "

Enter any descriptive text that helps you to identify the origin endpoint.

", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "ForceEndpointErrorConfiguration": { + "$ref": "#/definitions/ForceEndpointErrorConfiguration" + }, + "HlsManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, + "HlsManifests": { + "description": "

An HTTP live streaming (HLS) manifest configuration.

", + "items": { + "$ref": "#/definitions/HlsManifestConfiguration" + }, + "type": "array" + }, + "LowLatencyHlsManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, + "LowLatencyHlsManifests": { + "description": "

A low-latency HLS manifest configuration.

", + "items": { + "$ref": "#/definitions/LowLatencyHlsManifestConfiguration" + }, + "type": "array" + }, + "ModifiedAt": { + "description": "

The date and time the origin endpoint was modified.

", + "format": "date-time", + "type": "string" + }, + "OriginEndpointName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Segment": { + "$ref": "#/definitions/Segment" + }, + "StartoverWindowSeconds": { + "description": "

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

", + "maximum": 1209600, + "minimum": 60, + "type": "integer" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/DashManifestUrls", + "/properties/HlsManifestUrls", + "/properties/LowLatencyHlsManifestUrls", + "/properties/ModifiedAt", + "/properties/LowLatencyHlsManifests/*/Url", + "/properties/HlsManifests/*/Url" + ], + "required": [ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "ContainerType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "mediapackagev2:TagResource", + "mediapackagev2:UntagResource", + "mediapackagev2:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaPackageV2::OriginEndpoint" +} diff --git a/schema/aws-mediapackagev2-originendpointpolicy.json b/schema/aws-mediapackagev2-originendpointpolicy.json index decdfb3..c88cbd7 100644 --- a/schema/aws-mediapackagev2-originendpointpolicy.json +++ b/schema/aws-mediapackagev2-originendpointpolicy.json @@ -1,79 +1,79 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelGroupName", - "/properties/ChannelName", - "/properties/OriginEndpointName" - ], - "description": "

Represents a resource policy that allows or denies access to an origin endpoint.

", - "handlers": { - "create": { - "permissions": [ - "mediapackagev2:GetOriginEndpointPolicy", - "mediapackagev2:PutOriginEndpointPolicy" - ] - }, - "delete": { - "permissions": [ - "mediapackagev2:GetOriginEndpointPolicy", - "mediapackagev2:DeleteOriginEndpointPolicy" - ] - }, - "read": { - "permissions": [ - "mediapackagev2:GetOriginEndpointPolicy" - ] - }, - "update": { - "permissions": [ - "mediapackagev2:GetOriginEndpointPolicy", - "mediapackagev2:PutOriginEndpointPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelGroupName", - "/properties/ChannelName", - "/properties/OriginEndpointName" - ], - "properties": { - "ChannelGroupName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "ChannelName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "OriginEndpointName": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "Policy": { - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "ChannelGroupName", - "ChannelName", - "OriginEndpointName", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::MediaPackageV2::OriginEndpointPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelGroupName", + "/properties/ChannelName", + "/properties/OriginEndpointName" + ], + "description": "

Represents a resource policy that allows or denies access to an origin endpoint.

", + "handlers": { + "create": { + "permissions": [ + "mediapackagev2:GetOriginEndpointPolicy", + "mediapackagev2:PutOriginEndpointPolicy" + ] + }, + "delete": { + "permissions": [ + "mediapackagev2:GetOriginEndpointPolicy", + "mediapackagev2:DeleteOriginEndpointPolicy" + ] + }, + "read": { + "permissions": [ + "mediapackagev2:GetOriginEndpointPolicy" + ] + }, + "update": { + "permissions": [ + "mediapackagev2:GetOriginEndpointPolicy", + "mediapackagev2:PutOriginEndpointPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelGroupName", + "/properties/ChannelName", + "/properties/OriginEndpointName" + ], + "properties": { + "ChannelGroupName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ChannelName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "OriginEndpointName": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "Policy": { + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::MediaPackageV2::OriginEndpointPolicy" +} diff --git a/schema/aws-mediastore-container.json b/schema/aws-mediastore-container.json index 5c964da..5b6ffb2 100644 --- a/schema/aws-mediastore-container.json +++ b/schema/aws-mediastore-container.json @@ -1,145 +1,145 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContainerName" - ], - "definitions": { - "CorsRule": { - "additionalProperties": false, - "properties": { - "AllowedHeaders": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowedMethods": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AllowedOrigins": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ExposeHeaders": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MaxAgeSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "MetricPolicy": { - "additionalProperties": false, - "properties": { - "ContainerLevelMetrics": { - "type": "string" - }, - "MetricPolicyRules": { - "items": { - "$ref": "#/definitions/MetricPolicyRule" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "ContainerLevelMetrics" - ], - "type": "object" - }, - "MetricPolicyRule": { - "additionalProperties": false, - "properties": { - "ObjectGroup": { - "type": "string" - }, - "ObjectGroupName": { - "type": "string" - } - }, - "required": [ - "ObjectGroup", - "ObjectGroupName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MediaStore::Container", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AccessLoggingEnabled": { - "type": "boolean" - }, - "ContainerName": { - "type": "string" - }, - "CorsPolicy": { - "items": { - "$ref": "#/definitions/CorsRule" - }, - "type": "array", - "uniqueItems": false - }, - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LifecyclePolicy": { - "type": "string" - }, - "MetricPolicy": { - "$ref": "#/definitions/MetricPolicy" - }, - "Policy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Endpoint" - ], - "required": [ - "ContainerName" - ], - "typeName": "AWS::MediaStore::Container" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContainerName" + ], + "definitions": { + "CorsRule": { + "additionalProperties": false, + "properties": { + "AllowedHeaders": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowedMethods": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AllowedOrigins": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ExposeHeaders": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MaxAgeSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "MetricPolicy": { + "additionalProperties": false, + "properties": { + "ContainerLevelMetrics": { + "type": "string" + }, + "MetricPolicyRules": { + "items": { + "$ref": "#/definitions/MetricPolicyRule" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "ContainerLevelMetrics" + ], + "type": "object" + }, + "MetricPolicyRule": { + "additionalProperties": false, + "properties": { + "ObjectGroup": { + "type": "string" + }, + "ObjectGroupName": { + "type": "string" + } + }, + "required": [ + "ObjectGroup", + "ObjectGroupName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MediaStore::Container", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AccessLoggingEnabled": { + "type": "boolean" + }, + "ContainerName": { + "type": "string" + }, + "CorsPolicy": { + "items": { + "$ref": "#/definitions/CorsRule" + }, + "type": "array", + "uniqueItems": false + }, + "Endpoint": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LifecyclePolicy": { + "type": "string" + }, + "MetricPolicy": { + "$ref": "#/definitions/MetricPolicy" + }, + "Policy": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Endpoint" + ], + "required": [ + "ContainerName" + ], + "typeName": "AWS::MediaStore::Container" +} diff --git a/schema/aws-mediatailor-channel.json b/schema/aws-mediatailor-channel.json index f679fa2..1715263 100644 --- a/schema/aws-mediatailor-channel.json +++ b/schema/aws-mediatailor-channel.json @@ -1,271 +1,271 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelName", - "/properties/Tier" - ], - "definitions": { - "AdMarkupType": { - "enum": [ - "DATERANGE", - "SCTE35_ENHANCED" - ], - "type": "string" - }, - "DashPlaylistSettings": { - "additionalProperties": false, - "description": "

Dash manifest configuration parameters.

", - "properties": { - "ManifestWindowSeconds": { - "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

", - "type": "number" - }, - "MinBufferTimeSeconds": { - "description": "

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

", - "type": "number" - }, - "MinUpdatePeriodSeconds": { - "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

", - "type": "number" - }, - "SuggestedPresentationDelaySeconds": { - "description": "

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

", - "type": "number" - } - }, - "type": "object" - }, - "HlsPlaylistSettings": { - "additionalProperties": false, - "description": "

HLS playlist configuration parameters.

", - "properties": { - "AdMarkupType": { - "description": "

Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).

", - "items": { - "$ref": "#/definitions/AdMarkupType" - }, - "type": "array" - }, - "ManifestWindowSeconds": { - "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

", - "type": "number" - } - }, - "type": "object" - }, - "LogConfigurationForChannel": { - "additionalProperties": false, - "description": "

The log configuration for the channel.

", - "properties": { - "LogTypes": { - "description": "

The log types.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogType" - }, - "type": "array" - } - }, - "type": "object" - }, - "LogType": { - "enum": [ - "AS_RUN" - ], - "type": "string" - }, - "PlaybackMode": { - "enum": [ - "LOOP", - "LINEAR" - ], - "type": "string" - }, - "RequestOutputItem": { - "additionalProperties": false, - "description": "

The output configuration for this channel.

", - "properties": { - "DashPlaylistSettings": { - "$ref": "#/definitions/DashPlaylistSettings" - }, - "HlsPlaylistSettings": { - "$ref": "#/definitions/HlsPlaylistSettings" - }, - "ManifestName": { - "description": "

The name of the manifest for the channel. The name appears in the PlaybackUrl.

", - "type": "string" - }, - "SourceGroup": { - "description": "

A string used to match which HttpPackageConfiguration is used for each VodSource.

", - "type": "string" - } - }, - "required": [ - "ManifestName", - "SourceGroup" - ], - "type": "object" - }, - "SlateSource": { - "additionalProperties": false, - "description": "

Slate VOD source configuration.

", - "properties": { - "SourceLocationName": { - "description": "

The name of the source location where the slate VOD source is stored.

", - "type": "string" - }, - "VodSourceName": { - "description": "

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Tier": { - "enum": [ - "BASIC", - "STANDARD" - ], - "type": "string" - }, - "TimeShiftConfiguration": { - "additionalProperties": false, - "description": "

The configuration for time-shifted viewing.

", - "properties": { - "MaxTimeDelaySeconds": { - "description": "

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

", - "type": "number" - } - }, - "required": [ - "MaxTimeDelaySeconds" - ], - "type": "object" - } - }, - "description": "Definition of AWS::MediaTailor::Channel Resource Type", - "handlers": { - "create": { - "permissions": [ - "mediatailor:CreateChannel", - "mediatailor:TagResource", - "mediatailor:ConfigureLogsForChannel", - "iam:CreateServiceLinkedRole", - "mediatailor:DescribeChannel" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeleteChannel", - "mediatailor:DescribeChannel" - ] - }, - "list": { - "permissions": [ - "mediatailor:ListChannels" - ] - }, - "read": { - "permissions": [ - "mediatailor:DescribeChannel" - ] - }, - "update": { - "permissions": [ - "mediatailor:UpdateChannel", - "mediatailor:TagResource", - "mediatailor:UntagResource", - "iam:CreateServiceLinkedRole", - "mediatailor:ConfigureLogsForChannel", - "mediatailor:DescribeChannel" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelName" - ], - "properties": { - "Arn": { - "description": "

The ARN of the channel.

", - "type": "string" - }, - "Audiences": { - "description": "

The list of audiences defined in channel.

", - "items": { - "type": "string" - }, - "type": "array" - }, - "ChannelName": { - "type": "string" - }, - "FillerSlate": { - "$ref": "#/definitions/SlateSource" - }, - "LogConfiguration": { - "$ref": "#/definitions/LogConfigurationForChannel" - }, - "Outputs": { - "description": "

The channel's output properties.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RequestOutputItem" - }, - "type": "array" - }, - "PlaybackMode": { - "$ref": "#/definitions/PlaybackMode" - }, - "Tags": { - "description": "The tags to assign to the channel.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Tier": { - "$ref": "#/definitions/Tier" - }, - "TimeShiftConfiguration": { - "$ref": "#/definitions/TimeShiftConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ChannelName", - "Outputs", - "PlaybackMode" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaTailor::Channel", - "writeOnlyProperties": [ - "/properties/Outputs" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelName", + "/properties/Tier" + ], + "definitions": { + "AdMarkupType": { + "enum": [ + "DATERANGE", + "SCTE35_ENHANCED" + ], + "type": "string" + }, + "DashPlaylistSettings": { + "additionalProperties": false, + "description": "

Dash manifest configuration parameters.

", + "properties": { + "ManifestWindowSeconds": { + "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

", + "type": "number" + }, + "MinBufferTimeSeconds": { + "description": "

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

", + "type": "number" + }, + "MinUpdatePeriodSeconds": { + "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

", + "type": "number" + }, + "SuggestedPresentationDelaySeconds": { + "description": "

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

", + "type": "number" + } + }, + "type": "object" + }, + "HlsPlaylistSettings": { + "additionalProperties": false, + "description": "

HLS playlist configuration parameters.

", + "properties": { + "AdMarkupType": { + "description": "

Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).

", + "items": { + "$ref": "#/definitions/AdMarkupType" + }, + "type": "array" + }, + "ManifestWindowSeconds": { + "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

", + "type": "number" + } + }, + "type": "object" + }, + "LogConfigurationForChannel": { + "additionalProperties": false, + "description": "

The log configuration for the channel.

", + "properties": { + "LogTypes": { + "description": "

The log types.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogType" + }, + "type": "array" + } + }, + "type": "object" + }, + "LogType": { + "enum": [ + "AS_RUN" + ], + "type": "string" + }, + "PlaybackMode": { + "enum": [ + "LOOP", + "LINEAR" + ], + "type": "string" + }, + "RequestOutputItem": { + "additionalProperties": false, + "description": "

The output configuration for this channel.

", + "properties": { + "DashPlaylistSettings": { + "$ref": "#/definitions/DashPlaylistSettings" + }, + "HlsPlaylistSettings": { + "$ref": "#/definitions/HlsPlaylistSettings" + }, + "ManifestName": { + "description": "

The name of the manifest for the channel. The name appears in the PlaybackUrl.

", + "type": "string" + }, + "SourceGroup": { + "description": "

A string used to match which HttpPackageConfiguration is used for each VodSource.

", + "type": "string" + } + }, + "required": [ + "ManifestName", + "SourceGroup" + ], + "type": "object" + }, + "SlateSource": { + "additionalProperties": false, + "description": "

Slate VOD source configuration.

", + "properties": { + "SourceLocationName": { + "description": "

The name of the source location where the slate VOD source is stored.

", + "type": "string" + }, + "VodSourceName": { + "description": "

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Tier": { + "enum": [ + "BASIC", + "STANDARD" + ], + "type": "string" + }, + "TimeShiftConfiguration": { + "additionalProperties": false, + "description": "

The configuration for time-shifted viewing.

", + "properties": { + "MaxTimeDelaySeconds": { + "description": "

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

", + "type": "number" + } + }, + "required": [ + "MaxTimeDelaySeconds" + ], + "type": "object" + } + }, + "description": "Definition of AWS::MediaTailor::Channel Resource Type", + "handlers": { + "create": { + "permissions": [ + "mediatailor:CreateChannel", + "mediatailor:TagResource", + "mediatailor:ConfigureLogsForChannel", + "iam:CreateServiceLinkedRole", + "mediatailor:DescribeChannel" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeleteChannel", + "mediatailor:DescribeChannel" + ] + }, + "list": { + "permissions": [ + "mediatailor:ListChannels" + ] + }, + "read": { + "permissions": [ + "mediatailor:DescribeChannel" + ] + }, + "update": { + "permissions": [ + "mediatailor:UpdateChannel", + "mediatailor:TagResource", + "mediatailor:UntagResource", + "iam:CreateServiceLinkedRole", + "mediatailor:ConfigureLogsForChannel", + "mediatailor:DescribeChannel" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelName" + ], + "properties": { + "Arn": { + "description": "

The ARN of the channel.

", + "type": "string" + }, + "Audiences": { + "description": "

The list of audiences defined in channel.

", + "items": { + "type": "string" + }, + "type": "array" + }, + "ChannelName": { + "type": "string" + }, + "FillerSlate": { + "$ref": "#/definitions/SlateSource" + }, + "LogConfiguration": { + "$ref": "#/definitions/LogConfigurationForChannel" + }, + "Outputs": { + "description": "

The channel's output properties.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RequestOutputItem" + }, + "type": "array" + }, + "PlaybackMode": { + "$ref": "#/definitions/PlaybackMode" + }, + "Tags": { + "description": "The tags to assign to the channel.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Tier": { + "$ref": "#/definitions/Tier" + }, + "TimeShiftConfiguration": { + "$ref": "#/definitions/TimeShiftConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ChannelName", + "Outputs", + "PlaybackMode" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaTailor::Channel", + "writeOnlyProperties": [ + "/properties/Outputs" + ] +} diff --git a/schema/aws-mediatailor-channelpolicy.json b/schema/aws-mediatailor-channelpolicy.json index a596c18..2ff225d 100644 --- a/schema/aws-mediatailor-channelpolicy.json +++ b/schema/aws-mediatailor-channelpolicy.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ChannelName" - ], - "description": "Definition of AWS::MediaTailor::ChannelPolicy Resource Type", - "handlers": { - "create": { - "permissions": [ - "mediatailor:PutChannelPolicy", - "mediatailor:GetChannelPolicy" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeleteChannelPolicy", - "mediatailor:GetChannelPolicy" - ] - }, - "read": { - "permissions": [ - "mediatailor:GetChannelPolicy" - ] - }, - "update": { - "permissions": [ - "mediatailor:PutChannelPolicy", - "mediatailor:GetChannelPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ChannelName" - ], - "properties": { - "ChannelName": { - "type": "string" - }, - "Policy": { - "description": "

The IAM policy for the channel. IAM policies are used to control access to your channel.

", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "ChannelName", - "Policy" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::MediaTailor::ChannelPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ChannelName" + ], + "description": "Definition of AWS::MediaTailor::ChannelPolicy Resource Type", + "handlers": { + "create": { + "permissions": [ + "mediatailor:PutChannelPolicy", + "mediatailor:GetChannelPolicy" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeleteChannelPolicy", + "mediatailor:GetChannelPolicy" + ] + }, + "read": { + "permissions": [ + "mediatailor:GetChannelPolicy" + ] + }, + "update": { + "permissions": [ + "mediatailor:PutChannelPolicy", + "mediatailor:GetChannelPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChannelName" + ], + "properties": { + "ChannelName": { + "type": "string" + }, + "Policy": { + "description": "

The IAM policy for the channel. IAM policies are used to control access to your channel.

", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "ChannelName", + "Policy" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::MediaTailor::ChannelPolicy" +} diff --git a/schema/aws-mediatailor-livesource.json b/schema/aws-mediatailor-livesource.json index 0a615dc..1353226 100644 --- a/schema/aws-mediatailor-livesource.json +++ b/schema/aws-mediatailor-livesource.json @@ -1,148 +1,148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LiveSourceName", - "/properties/SourceLocationName" - ], - "definitions": { - "HttpPackageConfiguration": { - "additionalProperties": false, - "description": "

The HTTP package configuration properties for the requested VOD source.

", - "properties": { - "Path": { - "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

", - "type": "string" - }, - "SourceGroup": { - "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/Type" - } - }, - "required": [ - "Path", - "SourceGroup", - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Type": { - "enum": [ - "DASH", - "HLS" - ], - "type": "string" - } - }, - "description": "Definition of AWS::MediaTailor::LiveSource Resource Type", - "handlers": { - "create": { - "permissions": [ - "mediatailor:CreateLiveSource", - "mediatailor:DescribeLiveSource", - "mediatailor:TagResource" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeleteLiveSource", - "mediatailor:DescribeLiveSource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "SourceLocationName": { - "$ref": "resource-schema.json#/properties/SourceLocationName" - } - }, - "required": [ - "SourceLocationName" - ] - }, - "permissions": [ - "mediatailor:ListLiveSources" - ] - }, - "read": { - "permissions": [ - "mediatailor:DescribeLiveSource" - ] - }, - "update": { - "permissions": [ - "mediatailor:UpdateLiveSource", - "mediatailor:DescribeLiveSource", - "mediatailor:TagResource", - "mediatailor:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LiveSourceName", - "/properties/SourceLocationName" - ], - "properties": { - "Arn": { - "description": "

The ARN of the live source.

", - "type": "string" - }, - "HttpPackageConfigurations": { - "description": "

A list of HTTP package configuration parameters for this live source.

", - "items": { - "$ref": "#/definitions/HttpPackageConfiguration" - }, - "type": "array" - }, - "LiveSourceName": { - "type": "string" - }, - "SourceLocationName": { - "type": "string" - }, - "Tags": { - "description": "The tags to assign to the live source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "HttpPackageConfigurations", - "LiveSourceName", - "SourceLocationName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaTailor::LiveSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LiveSourceName", + "/properties/SourceLocationName" + ], + "definitions": { + "HttpPackageConfiguration": { + "additionalProperties": false, + "description": "

The HTTP package configuration properties for the requested VOD source.

", + "properties": { + "Path": { + "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

", + "type": "string" + }, + "SourceGroup": { + "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "required": [ + "Path", + "SourceGroup", + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Type": { + "enum": [ + "DASH", + "HLS" + ], + "type": "string" + } + }, + "description": "Definition of AWS::MediaTailor::LiveSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "mediatailor:CreateLiveSource", + "mediatailor:DescribeLiveSource", + "mediatailor:TagResource" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeleteLiveSource", + "mediatailor:DescribeLiveSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "SourceLocationName": { + "$ref": "resource-schema.json#/properties/SourceLocationName" + } + }, + "required": [ + "SourceLocationName" + ] + }, + "permissions": [ + "mediatailor:ListLiveSources" + ] + }, + "read": { + "permissions": [ + "mediatailor:DescribeLiveSource" + ] + }, + "update": { + "permissions": [ + "mediatailor:UpdateLiveSource", + "mediatailor:DescribeLiveSource", + "mediatailor:TagResource", + "mediatailor:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LiveSourceName", + "/properties/SourceLocationName" + ], + "properties": { + "Arn": { + "description": "

The ARN of the live source.

", + "type": "string" + }, + "HttpPackageConfigurations": { + "description": "

A list of HTTP package configuration parameters for this live source.

", + "items": { + "$ref": "#/definitions/HttpPackageConfiguration" + }, + "type": "array" + }, + "LiveSourceName": { + "type": "string" + }, + "SourceLocationName": { + "type": "string" + }, + "Tags": { + "description": "The tags to assign to the live source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "HttpPackageConfigurations", + "LiveSourceName", + "SourceLocationName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaTailor::LiveSource" +} diff --git a/schema/aws-mediatailor-playbackconfiguration.json b/schema/aws-mediatailor-playbackconfiguration.json index 09a3945..68d3a6e 100644 --- a/schema/aws-mediatailor-playbackconfiguration.json +++ b/schema/aws-mediatailor-playbackconfiguration.json @@ -1,300 +1,300 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AdMarkerPassthrough": { - "additionalProperties": false, - "description": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.", - "properties": { - "Enabled": { - "description": "Enables ad marker passthrough for your configuration.", - "type": "boolean" - } - }, - "type": "object" - }, - "AvailSuppression": { - "additionalProperties": false, - "description": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).", - "properties": { - "FillPolicy": { - "description": "Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL", - "enum": [ - "PARTIAL_AVAIL", - "FULL_AVAIL_ONLY" - ], - "type": "string" - }, - "Mode": { - "description": "Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.", - "enum": [ - "OFF", - "BEHIND_LIVE_EDGE", - "AFTER_LIVE_EDGE" - ], - "type": "string" - }, - "Value": { - "description": "A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.", - "type": "string" - } - }, - "type": "object" - }, - "Bumper": { - "additionalProperties": false, - "description": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).", - "properties": { - "EndUrl": { - "description": "The URL for the end bumper asset.", - "type": "string" - }, - "StartUrl": { - "description": "The URL for the start bumper asset.", - "type": "string" - } - }, - "type": "object" - }, - "CdnConfiguration": { - "additionalProperties": false, - "description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.", - "properties": { - "AdSegmentUrlPrefix": { - "description": "A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.", - "type": "string" - }, - "ContentSegmentUrlPrefix": { - "description": "A content delivery network (CDN) to cache content segments, so that content requests don't always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.", - "type": "string" - } - }, - "type": "object" - }, - "ConfigurationAliases": { - "additionalProperties": false, - "description": "The predefined aliases for dynamic variables.", - "patternProperties": { - "player_params\\.\\w+\\Z": { - "type": "object" - } - } - }, - "DashConfiguration": { - "additionalProperties": false, - "description": "The configuration for DASH PUT operations.", - "properties": { - "ManifestEndpointPrefix": { - "description": "The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting.", - "type": "string" - }, - "MpdLocation": { - "description": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.", - "type": "string" - }, - "OriginManifestType": { - "description": "The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.", - "enum": [ - "SINGLE_PERIOD", - "MULTI_PERIOD" - ], - "type": "string" - } - }, - "type": "object" - }, - "HlsConfiguration": { - "additionalProperties": false, - "properties": { - "ManifestEndpointPrefix": { - "description": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.", - "type": "string" - } - }, - "type": "object" - }, - "LivePreRollConfiguration": { - "additionalProperties": false, - "description": "The configuration for pre-roll ad insertion.", - "properties": { - "AdDecisionServerUrl": { - "description": "The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.", - "type": "string" - }, - "MaxDurationSeconds": { - "description": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.", - "type": "integer" - } - }, - "type": "object" - }, - "ManifestProcessingRules": { - "additionalProperties": false, - "description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.", - "properties": { - "AdMarkerPassthrough": { - "$ref": "#/definitions/AdMarkerPassthrough", - "description": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0." - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::MediaTailor::PlaybackConfiguration", - "handlers": { - "create": { - "permissions": [ - "mediatailor:PutPlaybackConfiguration", - "mediatailor:ConfigureLogsForPlaybackConfiguration", - "iam:CreateServiceLinkedRole", - "mediatailor:UntagResource", - "mediatailor:TagResource" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeletePlaybackConfiguration" - ] - }, - "list": { - "permissions": [ - "mediatailor:ListPlaybackConfigurations" - ] - }, - "read": { - "permissions": [ - "mediatailor:GetPlaybackConfiguration" - ] - }, - "update": { - "permissions": [ - "mediatailor:PutPlaybackConfiguration", - "mediatailor:ConfigureLogsForPlaybackConfiguration", - "iam:CreateServiceLinkedRole", - "mediatailor:UntagResource", - "mediatailor:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AdDecisionServerUrl": { - "description": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.", - "type": "string" - }, - "AvailSuppression": { - "$ref": "#/definitions/AvailSuppression", - "description": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html)." - }, - "Bumper": { - "$ref": "#/definitions/Bumper", - "description": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html)." - }, - "CdnConfiguration": { - "$ref": "#/definitions/CdnConfiguration", - "description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management." - }, - "ConfigurationAliases": { - "$ref": "#/definitions/ConfigurationAliases", - "description": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. " - }, - "DashConfiguration": { - "$ref": "#/definitions/DashConfiguration", - "description": "The configuration for DASH content." - }, - "HlsConfiguration": { - "$ref": "#/definitions/HlsConfiguration", - "description": "The configuration for HLS content." - }, - "LivePreRollConfiguration": { - "$ref": "#/definitions/LivePreRollConfiguration", - "description": "The configuration for pre-roll ad insertion." - }, - "ManifestProcessingRules": { - "$ref": "#/definitions/ManifestProcessingRules", - "description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor." - }, - "Name": { - "description": "The identifier for the playback configuration.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]+$", - "type": "string" - }, - "PersonalizationThresholdSeconds": { - "description": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).", - "type": "integer" - }, - "PlaybackConfigurationArn": { - "description": "The Amazon Resource Name (ARN) for the playback configuration.", - "type": "string" - }, - "PlaybackEndpointPrefix": { - "description": "The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.", - "type": "string" - }, - "SessionInitializationEndpointPrefix": { - "description": "The URL that the player uses to initialize a session that uses client-side reporting.", - "type": "string" - }, - "SlateAdUrl": { - "description": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.", - "type": "string" - }, - "Tags": { - "description": "The tags to assign to the playback configuration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TranscodeProfileName": { - "description": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.", - "type": "string" - }, - "VideoContentSourceUrl": { - "description": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SessionInitializationEndpointPrefix", - "/properties/HlsConfiguration/ManifestEndpointPrefix", - "/properties/DashConfiguration/ManifestEndpointPrefix", - "/properties/PlaybackConfigurationArn", - "/properties/PlaybackEndpointPrefix" - ], - "required": [ - "Name", - "VideoContentSourceUrl", - "AdDecisionServerUrl" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor.git", - "tagging": { - "cloudFormationSystemTags": false, - "taggable": true - }, - "typeName": "AWS::MediaTailor::PlaybackConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AdMarkerPassthrough": { + "additionalProperties": false, + "description": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.", + "properties": { + "Enabled": { + "description": "Enables ad marker passthrough for your configuration.", + "type": "boolean" + } + }, + "type": "object" + }, + "AvailSuppression": { + "additionalProperties": false, + "description": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).", + "properties": { + "FillPolicy": { + "description": "Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL", + "enum": [ + "PARTIAL_AVAIL", + "FULL_AVAIL_ONLY" + ], + "type": "string" + }, + "Mode": { + "description": "Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.", + "enum": [ + "OFF", + "BEHIND_LIVE_EDGE", + "AFTER_LIVE_EDGE" + ], + "type": "string" + }, + "Value": { + "description": "A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.", + "type": "string" + } + }, + "type": "object" + }, + "Bumper": { + "additionalProperties": false, + "description": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).", + "properties": { + "EndUrl": { + "description": "The URL for the end bumper asset.", + "type": "string" + }, + "StartUrl": { + "description": "The URL for the start bumper asset.", + "type": "string" + } + }, + "type": "object" + }, + "CdnConfiguration": { + "additionalProperties": false, + "description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.", + "properties": { + "AdSegmentUrlPrefix": { + "description": "A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.", + "type": "string" + }, + "ContentSegmentUrlPrefix": { + "description": "A content delivery network (CDN) to cache content segments, so that content requests don't always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigurationAliases": { + "additionalProperties": false, + "description": "The predefined aliases for dynamic variables.", + "patternProperties": { + "player_params\\.\\w+\\Z": { + "type": "object" + } + } + }, + "DashConfiguration": { + "additionalProperties": false, + "description": "The configuration for DASH PUT operations.", + "properties": { + "ManifestEndpointPrefix": { + "description": "The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting.", + "type": "string" + }, + "MpdLocation": { + "description": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.", + "type": "string" + }, + "OriginManifestType": { + "description": "The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.", + "enum": [ + "SINGLE_PERIOD", + "MULTI_PERIOD" + ], + "type": "string" + } + }, + "type": "object" + }, + "HlsConfiguration": { + "additionalProperties": false, + "properties": { + "ManifestEndpointPrefix": { + "description": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.", + "type": "string" + } + }, + "type": "object" + }, + "LivePreRollConfiguration": { + "additionalProperties": false, + "description": "The configuration for pre-roll ad insertion.", + "properties": { + "AdDecisionServerUrl": { + "description": "The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.", + "type": "string" + }, + "MaxDurationSeconds": { + "description": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.", + "type": "integer" + } + }, + "type": "object" + }, + "ManifestProcessingRules": { + "additionalProperties": false, + "description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.", + "properties": { + "AdMarkerPassthrough": { + "$ref": "#/definitions/AdMarkerPassthrough", + "description": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0." + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::MediaTailor::PlaybackConfiguration", + "handlers": { + "create": { + "permissions": [ + "mediatailor:PutPlaybackConfiguration", + "mediatailor:ConfigureLogsForPlaybackConfiguration", + "iam:CreateServiceLinkedRole", + "mediatailor:UntagResource", + "mediatailor:TagResource" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeletePlaybackConfiguration" + ] + }, + "list": { + "permissions": [ + "mediatailor:ListPlaybackConfigurations" + ] + }, + "read": { + "permissions": [ + "mediatailor:GetPlaybackConfiguration" + ] + }, + "update": { + "permissions": [ + "mediatailor:PutPlaybackConfiguration", + "mediatailor:ConfigureLogsForPlaybackConfiguration", + "iam:CreateServiceLinkedRole", + "mediatailor:UntagResource", + "mediatailor:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AdDecisionServerUrl": { + "description": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.", + "type": "string" + }, + "AvailSuppression": { + "$ref": "#/definitions/AvailSuppression", + "description": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html)." + }, + "Bumper": { + "$ref": "#/definitions/Bumper", + "description": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html)." + }, + "CdnConfiguration": { + "$ref": "#/definitions/CdnConfiguration", + "description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management." + }, + "ConfigurationAliases": { + "$ref": "#/definitions/ConfigurationAliases", + "description": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. " + }, + "DashConfiguration": { + "$ref": "#/definitions/DashConfiguration", + "description": "The configuration for DASH content." + }, + "HlsConfiguration": { + "$ref": "#/definitions/HlsConfiguration", + "description": "The configuration for HLS content." + }, + "LivePreRollConfiguration": { + "$ref": "#/definitions/LivePreRollConfiguration", + "description": "The configuration for pre-roll ad insertion." + }, + "ManifestProcessingRules": { + "$ref": "#/definitions/ManifestProcessingRules", + "description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor." + }, + "Name": { + "description": "The identifier for the playback configuration.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "PersonalizationThresholdSeconds": { + "description": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).", + "type": "integer" + }, + "PlaybackConfigurationArn": { + "description": "The Amazon Resource Name (ARN) for the playback configuration.", + "type": "string" + }, + "PlaybackEndpointPrefix": { + "description": "The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.", + "type": "string" + }, + "SessionInitializationEndpointPrefix": { + "description": "The URL that the player uses to initialize a session that uses client-side reporting.", + "type": "string" + }, + "SlateAdUrl": { + "description": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.", + "type": "string" + }, + "Tags": { + "description": "The tags to assign to the playback configuration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TranscodeProfileName": { + "description": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.", + "type": "string" + }, + "VideoContentSourceUrl": { + "description": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SessionInitializationEndpointPrefix", + "/properties/HlsConfiguration/ManifestEndpointPrefix", + "/properties/DashConfiguration/ManifestEndpointPrefix", + "/properties/PlaybackConfigurationArn", + "/properties/PlaybackEndpointPrefix" + ], + "required": [ + "Name", + "VideoContentSourceUrl", + "AdDecisionServerUrl" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor.git", + "tagging": { + "cloudFormationSystemTags": false, + "taggable": true + }, + "typeName": "AWS::MediaTailor::PlaybackConfiguration" +} diff --git a/schema/aws-mediatailor-sourcelocation.json b/schema/aws-mediatailor-sourcelocation.json index 9702703..884f225 100644 --- a/schema/aws-mediatailor-sourcelocation.json +++ b/schema/aws-mediatailor-sourcelocation.json @@ -1,197 +1,197 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceLocationName" - ], - "definitions": { - "AccessConfiguration": { - "additionalProperties": false, - "description": "

Access configuration parameters.

", - "properties": { - "AccessType": { - "$ref": "#/definitions/AccessType" - }, - "SecretsManagerAccessTokenConfiguration": { - "$ref": "#/definitions/SecretsManagerAccessTokenConfiguration" - } - }, - "type": "object" - }, - "AccessType": { - "enum": [ - "S3_SIGV4", - "SECRETS_MANAGER_ACCESS_TOKEN", - "AUTODETECT_SIGV4" - ], - "type": "string" - }, - "DefaultSegmentDeliveryConfiguration": { - "additionalProperties": false, - "description": "

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

", - "properties": { - "BaseUrl": { - "description": "

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

", - "type": "string" - } - }, - "type": "object" - }, - "HttpConfiguration": { - "additionalProperties": false, - "description": "

The HTTP configuration for the source location.

", - "properties": { - "BaseUrl": { - "description": "

The base URL for the source location host server. This string must include the protocol, such as https://.

", - "type": "string" - } - }, - "required": [ - "BaseUrl" - ], - "type": "object" - }, - "SecretsManagerAccessTokenConfiguration": { - "additionalProperties": false, - "description": "

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.

", - "properties": { - "HeaderName": { - "description": "

The name of the HTTP header used to supply the access token in requests to the source location.

", - "type": "string" - }, - "SecretArn": { - "description": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

", - "type": "string" - }, - "SecretStringKey": { - "description": "

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

", - "type": "string" - } - }, - "type": "object" - }, - "SegmentDeliveryConfiguration": { - "additionalProperties": false, - "description": "

The segment delivery configuration settings.

", - "properties": { - "BaseUrl": { - "description": "

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

", - "type": "string" - }, - "Name": { - "description": "

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Definition of AWS::MediaTailor::SourceLocation Resource Type", - "handlers": { - "create": { - "permissions": [ - "mediatailor:CreateSourceLocation", - "mediatailor:DescribeSourceLocation", - "mediatailor:TagResource", - "secretsmanager:DescribeSecret", - "secretsmanager:GetSecretValue", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeleteSourceLocation", - "mediatailor:DescribeSourceLocation" - ] - }, - "list": { - "permissions": [ - "mediatailor:ListSourceLocations" - ] - }, - "read": { - "permissions": [ - "mediatailor:DescribeSourceLocation" - ] - }, - "update": { - "permissions": [ - "mediatailor:DescribeSourceLocation", - "mediatailor:TagResource", - "mediatailor:UntagResource", - "mediatailor:UpdateSourceLocation", - "secretsmanager:DescribeSecret", - "secretsmanager:GetSecretValue", - "kms:CreateGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/SourceLocationName" - ], - "properties": { - "AccessConfiguration": { - "$ref": "#/definitions/AccessConfiguration" - }, - "Arn": { - "description": "

The ARN of the source location.

", - "type": "string" - }, - "DefaultSegmentDeliveryConfiguration": { - "$ref": "#/definitions/DefaultSegmentDeliveryConfiguration" - }, - "HttpConfiguration": { - "$ref": "#/definitions/HttpConfiguration" - }, - "SegmentDeliveryConfigurations": { - "description": "

A list of the segment delivery configurations associated with this resource.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SegmentDeliveryConfiguration" - }, - "type": "array" - }, - "SourceLocationName": { - "type": "string" - }, - "Tags": { - "description": "The tags to assign to the source location.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "HttpConfiguration", - "SourceLocationName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaTailor::SourceLocation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceLocationName" + ], + "definitions": { + "AccessConfiguration": { + "additionalProperties": false, + "description": "

Access configuration parameters.

", + "properties": { + "AccessType": { + "$ref": "#/definitions/AccessType" + }, + "SecretsManagerAccessTokenConfiguration": { + "$ref": "#/definitions/SecretsManagerAccessTokenConfiguration" + } + }, + "type": "object" + }, + "AccessType": { + "enum": [ + "S3_SIGV4", + "SECRETS_MANAGER_ACCESS_TOKEN", + "AUTODETECT_SIGV4" + ], + "type": "string" + }, + "DefaultSegmentDeliveryConfiguration": { + "additionalProperties": false, + "description": "

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

", + "properties": { + "BaseUrl": { + "description": "

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

", + "type": "string" + } + }, + "type": "object" + }, + "HttpConfiguration": { + "additionalProperties": false, + "description": "

The HTTP configuration for the source location.

", + "properties": { + "BaseUrl": { + "description": "

The base URL for the source location host server. This string must include the protocol, such as https://.

", + "type": "string" + } + }, + "required": [ + "BaseUrl" + ], + "type": "object" + }, + "SecretsManagerAccessTokenConfiguration": { + "additionalProperties": false, + "description": "

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.

", + "properties": { + "HeaderName": { + "description": "

The name of the HTTP header used to supply the access token in requests to the source location.

", + "type": "string" + }, + "SecretArn": { + "description": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

", + "type": "string" + }, + "SecretStringKey": { + "description": "

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

", + "type": "string" + } + }, + "type": "object" + }, + "SegmentDeliveryConfiguration": { + "additionalProperties": false, + "description": "

The segment delivery configuration settings.

", + "properties": { + "BaseUrl": { + "description": "

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

", + "type": "string" + }, + "Name": { + "description": "

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Definition of AWS::MediaTailor::SourceLocation Resource Type", + "handlers": { + "create": { + "permissions": [ + "mediatailor:CreateSourceLocation", + "mediatailor:DescribeSourceLocation", + "mediatailor:TagResource", + "secretsmanager:DescribeSecret", + "secretsmanager:GetSecretValue", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeleteSourceLocation", + "mediatailor:DescribeSourceLocation" + ] + }, + "list": { + "permissions": [ + "mediatailor:ListSourceLocations" + ] + }, + "read": { + "permissions": [ + "mediatailor:DescribeSourceLocation" + ] + }, + "update": { + "permissions": [ + "mediatailor:DescribeSourceLocation", + "mediatailor:TagResource", + "mediatailor:UntagResource", + "mediatailor:UpdateSourceLocation", + "secretsmanager:DescribeSecret", + "secretsmanager:GetSecretValue", + "kms:CreateGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/SourceLocationName" + ], + "properties": { + "AccessConfiguration": { + "$ref": "#/definitions/AccessConfiguration" + }, + "Arn": { + "description": "

The ARN of the source location.

", + "type": "string" + }, + "DefaultSegmentDeliveryConfiguration": { + "$ref": "#/definitions/DefaultSegmentDeliveryConfiguration" + }, + "HttpConfiguration": { + "$ref": "#/definitions/HttpConfiguration" + }, + "SegmentDeliveryConfigurations": { + "description": "

A list of the segment delivery configurations associated with this resource.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SegmentDeliveryConfiguration" + }, + "type": "array" + }, + "SourceLocationName": { + "type": "string" + }, + "Tags": { + "description": "The tags to assign to the source location.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "HttpConfiguration", + "SourceLocationName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaTailor::SourceLocation" +} diff --git a/schema/aws-mediatailor-vodsource.json b/schema/aws-mediatailor-vodsource.json index 6c1843a..7379eab 100644 --- a/schema/aws-mediatailor-vodsource.json +++ b/schema/aws-mediatailor-vodsource.json @@ -1,148 +1,148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceLocationName", - "/properties/VodSourceName" - ], - "definitions": { - "HttpPackageConfiguration": { - "additionalProperties": false, - "description": "

The HTTP package configuration properties for the requested VOD source.

", - "properties": { - "Path": { - "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

", - "type": "string" - }, - "SourceGroup": { - "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/Type" - } - }, - "required": [ - "Path", - "SourceGroup", - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Type": { - "enum": [ - "DASH", - "HLS" - ], - "type": "string" - } - }, - "description": "Definition of AWS::MediaTailor::VodSource Resource Type", - "handlers": { - "create": { - "permissions": [ - "mediatailor:CreateVodSource", - "mediatailor:DescribeVodSource", - "mediatailor:TagResource" - ] - }, - "delete": { - "permissions": [ - "mediatailor:DeleteVodSource", - "mediatailor:DescribeVodSource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "SourceLocationName": { - "$ref": "resource-schema.json#/properties/SourceLocationName" - } - }, - "required": [ - "SourceLocationName" - ] - }, - "permissions": [ - "mediatailor:ListVodSources" - ] - }, - "read": { - "permissions": [ - "mediatailor:DescribeVodSource" - ] - }, - "update": { - "permissions": [ - "mediatailor:DescribeVodSource", - "mediatailor:TagResource", - "mediatailor:UntagResource", - "mediatailor:UpdateVodSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SourceLocationName", - "/properties/VodSourceName" - ], - "properties": { - "Arn": { - "description": "

The ARN of the VOD source.

", - "type": "string" - }, - "HttpPackageConfigurations": { - "description": "

A list of HTTP package configuration parameters for this VOD source.

", - "items": { - "$ref": "#/definitions/HttpPackageConfiguration" - }, - "type": "array" - }, - "SourceLocationName": { - "type": "string" - }, - "Tags": { - "description": "The tags to assign to the VOD source.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VodSourceName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "HttpPackageConfigurations", - "SourceLocationName", - "VodSourceName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MediaTailor::VodSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceLocationName", + "/properties/VodSourceName" + ], + "definitions": { + "HttpPackageConfiguration": { + "additionalProperties": false, + "description": "

The HTTP package configuration properties for the requested VOD source.

", + "properties": { + "Path": { + "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

", + "type": "string" + }, + "SourceGroup": { + "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "required": [ + "Path", + "SourceGroup", + "Type" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Type": { + "enum": [ + "DASH", + "HLS" + ], + "type": "string" + } + }, + "description": "Definition of AWS::MediaTailor::VodSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "mediatailor:CreateVodSource", + "mediatailor:DescribeVodSource", + "mediatailor:TagResource" + ] + }, + "delete": { + "permissions": [ + "mediatailor:DeleteVodSource", + "mediatailor:DescribeVodSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "SourceLocationName": { + "$ref": "resource-schema.json#/properties/SourceLocationName" + } + }, + "required": [ + "SourceLocationName" + ] + }, + "permissions": [ + "mediatailor:ListVodSources" + ] + }, + "read": { + "permissions": [ + "mediatailor:DescribeVodSource" + ] + }, + "update": { + "permissions": [ + "mediatailor:DescribeVodSource", + "mediatailor:TagResource", + "mediatailor:UntagResource", + "mediatailor:UpdateVodSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SourceLocationName", + "/properties/VodSourceName" + ], + "properties": { + "Arn": { + "description": "

The ARN of the VOD source.

", + "type": "string" + }, + "HttpPackageConfigurations": { + "description": "

A list of HTTP package configuration parameters for this VOD source.

", + "items": { + "$ref": "#/definitions/HttpPackageConfiguration" + }, + "type": "array" + }, + "SourceLocationName": { + "type": "string" + }, + "Tags": { + "description": "The tags to assign to the VOD source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VodSourceName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "HttpPackageConfigurations", + "SourceLocationName", + "VodSourceName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediatailor", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MediaTailor::VodSource" +} diff --git a/schema/aws-memorydb-acl.json b/schema/aws-memorydb-acl.json index a9572dd..c760eb1 100644 --- a/schema/aws-memorydb-acl.json +++ b/schema/aws-memorydb-acl.json @@ -1,119 +1,119 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ACLName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MemoryDB::ACL", - "handlers": { - "create": { - "permissions": [ - "memorydb:CreateACL", - "memorydb:DescribeACLs", - "memorydb:TagResource", - "memorydb:ListTags" - ] - }, - "delete": { - "permissions": [ - "memorydb:ModifyReplicationGroup", - "memorydb:DeleteACL", - "memorydb:DescribeACLs" - ] - }, - "list": { - "permissions": [ - "memorydb:DescribeACLs", - "memorydb:ListTags" - ] - }, - "read": { - "permissions": [ - "memorydb:DescribeACLs", - "memorydb:ListTags" - ] - }, - "update": { - "permissions": [ - "memorydb:UpdateACL", - "memorydb:DescribeACLs", - "memorydb:ListTags", - "memorydb:TagResource", - "memorydb:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ACLName" - ], - "properties": { - "ACLName": { - "description": "The name of the acl.", - "pattern": "[a-z][a-z0-9\\\\-]*", - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the acl.", - "type": "string" - }, - "Status": { - "description": "Indicates acl status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserNames": { - "$comment": "List of users.", - "description": "List of users associated to this acl.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Arn" - ], - "required": [ - "ACLName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", - "taggable": true, - "typeName": "AWS::MemoryDB::ACL" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ACLName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MemoryDB::ACL", + "handlers": { + "create": { + "permissions": [ + "memorydb:CreateACL", + "memorydb:DescribeACLs", + "memorydb:TagResource", + "memorydb:ListTags" + ] + }, + "delete": { + "permissions": [ + "memorydb:ModifyReplicationGroup", + "memorydb:DeleteACL", + "memorydb:DescribeACLs" + ] + }, + "list": { + "permissions": [ + "memorydb:DescribeACLs", + "memorydb:ListTags" + ] + }, + "read": { + "permissions": [ + "memorydb:DescribeACLs", + "memorydb:ListTags" + ] + }, + "update": { + "permissions": [ + "memorydb:UpdateACL", + "memorydb:DescribeACLs", + "memorydb:ListTags", + "memorydb:TagResource", + "memorydb:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ACLName" + ], + "properties": { + "ACLName": { + "description": "The name of the acl.", + "pattern": "[a-z][a-z0-9\\\\-]*", + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the acl.", + "type": "string" + }, + "Status": { + "description": "Indicates acl status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserNames": { + "$comment": "List of users.", + "description": "List of users associated to this acl.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn" + ], + "required": [ + "ACLName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", + "taggable": true, + "typeName": "AWS::MemoryDB::ACL" +} diff --git a/schema/aws-memorydb-cluster.json b/schema/aws-memorydb-cluster.json index 4858a77..25ade4b 100644 --- a/schema/aws-memorydb-cluster.json +++ b/schema/aws-memorydb-cluster.json @@ -1,253 +1,253 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName", - "/properties/TLSEnabled", - "/properties/DataTiering", - "/properties/KmsKeyId", - "/properties/Port", - "/properties/SubnetGroupName", - "/properties/SnapshotArns", - "/properties/SnapshotName" - ], - "definitions": { - "DataTieringStatus": { - "enum": [ - "true", - "false" - ], - "type": "string" - }, - "Endpoint": { - "additionalProperties": false, - "properties": { - "Address": { - "description": "The DNS address of the primary read-write node.", - "type": "string" - }, - "Port": { - "description": "The port number that the engine is listening on. ", - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for the tag. May not be null.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", - "type": "string" - }, - "Value": { - "description": "The tag's value. May be null.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.", - "handlers": { - "create": { - "permissions": [ - "memorydb:CreateCluster", - "memorydb:DescribeClusters", - "memorydb:ListTags" - ] - }, - "delete": { - "permissions": [ - "memorydb:DeleteCluster", - "memorydb:DescribeClusters" - ] - }, - "list": { - "permissions": [ - "memorydb:DescribeClusters" - ] - }, - "read": { - "permissions": [ - "memorydb:DescribeClusters", - "memorydb:ListTags" - ] - }, - "update": { - "permissions": [ - "memorydb:UpdateCluster", - "memorydb:DescribeClusters", - "memorydb:ListTags", - "memorydb:TagResource", - "memorydb:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterName" - ], - "properties": { - "ACLName": { - "description": "The name of the Access Control List to associate with the cluster.", - "pattern": "[a-zA-Z][a-zA-Z0-9\\-]*", - "type": "string" - }, - "ARN": { - "description": "The Amazon Resource Name (ARN) of the cluster.", - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "description": "A flag that enables automatic minor version upgrade when set to true.\n\nYou cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.", - "type": "boolean" - }, - "ClusterEndpoint": { - "$ref": "#/definitions/Endpoint", - "description": "The cluster endpoint." - }, - "ClusterName": { - "description": "The name of the cluster. This value must be unique as it also serves as the cluster identifier.", - "pattern": "[a-z][a-z0-9\\-]*", - "type": "string" - }, - "DataTiering": { - "$ref": "#/definitions/DataTieringStatus", - "description": "Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.", - "type": "object" - }, - "Description": { - "description": "An optional description of the cluster.", - "type": "string" - }, - "EngineVersion": { - "description": "The Redis engine version used by the cluster.", - "type": "string" - }, - "FinalSnapshotName": { - "description": "The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.", - "type": "string" - }, - "KmsKeyId": { - "description": "The ID of the KMS key used to encrypt the cluster.", - "type": "string" - }, - "MaintenanceWindow": { - "description": "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.", - "type": "string" - }, - "NodeType": { - "description": "The compute and memory capacity of the nodes in the cluster.", - "type": "string" - }, - "NumReplicasPerShard": { - "description": "The number of replicas to apply to each shard. The limit is 5.", - "type": "integer" - }, - "NumShards": { - "description": "The number of shards the cluster will contain.", - "type": "integer" - }, - "ParameterGroupName": { - "description": "The name of the parameter group associated with the cluster.", - "type": "string" - }, - "ParameterGroupStatus": { - "description": "The status of the parameter group used by the cluster.", - "type": "string" - }, - "Port": { - "description": "The port number on which each member of the cluster accepts connections.", - "type": "integer" - }, - "SecurityGroupIds": { - "description": "One or more Amazon VPC security groups associated with this cluster.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SnapshotArns": { - "description": "A 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.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SnapshotName": { - "description": "The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.", - "type": "string" - }, - "SnapshotRetentionLimit": { - "description": "The 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.", - "type": "integer" - }, - "SnapshotWindow": { - "description": "The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.", - "type": "string" - }, - "SnsTopicArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.", - "type": "string" - }, - "SnsTopicStatus": { - "description": "The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.", - "type": "string" - }, - "Status": { - "description": "The status of the cluster. For example, Available, Updating, Creating.", - "type": "string" - }, - "SubnetGroupName": { - "description": "The name of the subnet group to be used for the cluster.", - "type": "string" - }, - "TLSEnabled": { - "description": "A flag that enables in-transit encryption when set to true.\n\nYou 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.", - "type": "boolean" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/ClusterEndpoint/Address", - "/properties/ClusterEndpoint/Port", - "/properties/ARN", - "/properties/ParameterGroupStatus" - ], - "required": [ - "ClusterName", - "NodeType", - "ACLName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", - "taggable": true, - "typeName": "AWS::MemoryDB::Cluster", - "writeOnlyProperties": [ - "/properties/SnapshotArns", - "/properties/SnapshotName", - "/properties/FinalSnapshotName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/TLSEnabled", + "/properties/DataTiering", + "/properties/KmsKeyId", + "/properties/Port", + "/properties/SubnetGroupName", + "/properties/SnapshotArns", + "/properties/SnapshotName" + ], + "definitions": { + "DataTieringStatus": { + "enum": [ + "true", + "false" + ], + "type": "string" + }, + "Endpoint": { + "additionalProperties": false, + "properties": { + "Address": { + "description": "The DNS address of the primary read-write node.", + "type": "string" + }, + "Port": { + "description": "The port number that the engine is listening on. ", + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for the tag. May not be null.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", + "type": "string" + }, + "Value": { + "description": "The tag's value. May be null.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.", + "handlers": { + "create": { + "permissions": [ + "memorydb:CreateCluster", + "memorydb:DescribeClusters", + "memorydb:ListTags" + ] + }, + "delete": { + "permissions": [ + "memorydb:DeleteCluster", + "memorydb:DescribeClusters" + ] + }, + "list": { + "permissions": [ + "memorydb:DescribeClusters" + ] + }, + "read": { + "permissions": [ + "memorydb:DescribeClusters", + "memorydb:ListTags" + ] + }, + "update": { + "permissions": [ + "memorydb:UpdateCluster", + "memorydb:DescribeClusters", + "memorydb:ListTags", + "memorydb:TagResource", + "memorydb:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterName" + ], + "properties": { + "ACLName": { + "description": "The name of the Access Control List to associate with the cluster.", + "pattern": "[a-zA-Z][a-zA-Z0-9\\-]*", + "type": "string" + }, + "ARN": { + "description": "The Amazon Resource Name (ARN) of the cluster.", + "type": "string" + }, + "AutoMinorVersionUpgrade": { + "description": "A flag that enables automatic minor version upgrade when set to true.\n\nYou cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.", + "type": "boolean" + }, + "ClusterEndpoint": { + "$ref": "#/definitions/Endpoint", + "description": "The cluster endpoint." + }, + "ClusterName": { + "description": "The name of the cluster. This value must be unique as it also serves as the cluster identifier.", + "pattern": "[a-z][a-z0-9\\-]*", + "type": "string" + }, + "DataTiering": { + "$ref": "#/definitions/DataTieringStatus", + "description": "Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.", + "type": "object" + }, + "Description": { + "description": "An optional description of the cluster.", + "type": "string" + }, + "EngineVersion": { + "description": "The Redis engine version used by the cluster.", + "type": "string" + }, + "FinalSnapshotName": { + "description": "The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.", + "type": "string" + }, + "KmsKeyId": { + "description": "The ID of the KMS key used to encrypt the cluster.", + "type": "string" + }, + "MaintenanceWindow": { + "description": "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.", + "type": "string" + }, + "NodeType": { + "description": "The compute and memory capacity of the nodes in the cluster.", + "type": "string" + }, + "NumReplicasPerShard": { + "description": "The number of replicas to apply to each shard. The limit is 5.", + "type": "integer" + }, + "NumShards": { + "description": "The number of shards the cluster will contain.", + "type": "integer" + }, + "ParameterGroupName": { + "description": "The name of the parameter group associated with the cluster.", + "type": "string" + }, + "ParameterGroupStatus": { + "description": "The status of the parameter group used by the cluster.", + "type": "string" + }, + "Port": { + "description": "The port number on which each member of the cluster accepts connections.", + "type": "integer" + }, + "SecurityGroupIds": { + "description": "One or more Amazon VPC security groups associated with this cluster.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SnapshotArns": { + "description": "A 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.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SnapshotName": { + "description": "The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.", + "type": "string" + }, + "SnapshotRetentionLimit": { + "description": "The 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.", + "type": "integer" + }, + "SnapshotWindow": { + "description": "The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.", + "type": "string" + }, + "SnsTopicArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.", + "type": "string" + }, + "SnsTopicStatus": { + "description": "The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.", + "type": "string" + }, + "Status": { + "description": "The status of the cluster. For example, Available, Updating, Creating.", + "type": "string" + }, + "SubnetGroupName": { + "description": "The name of the subnet group to be used for the cluster.", + "type": "string" + }, + "TLSEnabled": { + "description": "A flag that enables in-transit encryption when set to true.\n\nYou 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.", + "type": "boolean" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/ClusterEndpoint/Address", + "/properties/ClusterEndpoint/Port", + "/properties/ARN", + "/properties/ParameterGroupStatus" + ], + "required": [ + "ClusterName", + "NodeType", + "ACLName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", + "taggable": true, + "typeName": "AWS::MemoryDB::Cluster", + "writeOnlyProperties": [ + "/properties/SnapshotArns", + "/properties/SnapshotName", + "/properties/FinalSnapshotName" + ] +} diff --git a/schema/aws-memorydb-parametergroup.json b/schema/aws-memorydb-parametergroup.json index 1701d04..b745121 100644 --- a/schema/aws-memorydb-parametergroup.json +++ b/schema/aws-memorydb-parametergroup.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ParameterGroupName", - "/properties/Family", - "/properties/Description" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for the tag. May not be null.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", - "type": "string" - }, - "Value": { - "description": "The tag's value. May be null.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.", - "handlers": { - "create": { - "permissions": [ - "memorydb:CreateParameterGroup", - "memorydb:DescribeParameterGroups", - "memorydb:TagResource", - "memorydb:ListTags" - ] - }, - "delete": { - "permissions": [ - "memorydb:DeleteParameterGroup" - ] - }, - "list": { - "permissions": [ - "memorydb:DescribeParameterGroups" - ] - }, - "read": { - "permissions": [ - "memorydb:DescribeParameterGroups", - "memorydb:ListTags" - ] - }, - "update": { - "permissions": [ - "memorydb:UpdateParameterGroup", - "memorydb:DescribeParameterGroups", - "memorydb:DescribeParameters", - "memorydb:DescribeClusters", - "memorydb:ListTags", - "memorydb:TagResource", - "memorydb:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ParameterGroupName" - ], - "properties": { - "ARN": { - "description": "The Amazon Resource Name (ARN) of the parameter group.", - "type": "string" - }, - "Description": { - "description": "A description of the parameter group.", - "type": "string" - }, - "Family": { - "description": "The name of the parameter group family that this parameter group is compatible with.", - "type": "string" - }, - "ParameterGroupName": { - "description": "The name of the parameter group.", - "type": "string" - }, - "Parameters": { - "description": "An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.", - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this parameter group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ARN" - ], - "required": [ - "ParameterGroupName", - "Family" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", - "taggable": true, - "typeName": "AWS::MemoryDB::ParameterGroup", - "writeOnlyProperties": [ - "/properties/Parameters" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ParameterGroupName", + "/properties/Family", + "/properties/Description" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for the tag. May not be null.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", + "type": "string" + }, + "Value": { + "description": "The tag's value. May be null.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.", + "handlers": { + "create": { + "permissions": [ + "memorydb:CreateParameterGroup", + "memorydb:DescribeParameterGroups", + "memorydb:TagResource", + "memorydb:ListTags" + ] + }, + "delete": { + "permissions": [ + "memorydb:DeleteParameterGroup" + ] + }, + "list": { + "permissions": [ + "memorydb:DescribeParameterGroups" + ] + }, + "read": { + "permissions": [ + "memorydb:DescribeParameterGroups", + "memorydb:ListTags" + ] + }, + "update": { + "permissions": [ + "memorydb:UpdateParameterGroup", + "memorydb:DescribeParameterGroups", + "memorydb:DescribeParameters", + "memorydb:DescribeClusters", + "memorydb:ListTags", + "memorydb:TagResource", + "memorydb:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ParameterGroupName" + ], + "properties": { + "ARN": { + "description": "The Amazon Resource Name (ARN) of the parameter group.", + "type": "string" + }, + "Description": { + "description": "A description of the parameter group.", + "type": "string" + }, + "Family": { + "description": "The name of the parameter group family that this parameter group is compatible with.", + "type": "string" + }, + "ParameterGroupName": { + "description": "The name of the parameter group.", + "type": "string" + }, + "Parameters": { + "description": "An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.", + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this parameter group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ARN" + ], + "required": [ + "ParameterGroupName", + "Family" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", + "taggable": true, + "typeName": "AWS::MemoryDB::ParameterGroup", + "writeOnlyProperties": [ + "/properties/Parameters" + ] +} diff --git a/schema/aws-memorydb-subnetgroup.json b/schema/aws-memorydb-subnetgroup.json index bc5c638..f06d049 100644 --- a/schema/aws-memorydb-subnetgroup.json +++ b/schema/aws-memorydb-subnetgroup.json @@ -1,117 +1,117 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubnetGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key for the tag. May not be null.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", - "type": "string" - }, - "Value": { - "description": "The tag's value. May be null.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.", - "handlers": { - "create": { - "permissions": [ - "memorydb:CreateSubnetGroup", - "memorydb:DescribeSubnetGroups", - "memorydb:TagResource", - "memorydb:ListTags" - ] - }, - "delete": { - "permissions": [ - "memorydb:DeleteSubnetGroup", - "memorydb:DescribeSubnetGroups" - ] - }, - "list": { - "permissions": [ - "memorydb:DescribeSubnetGroups" - ] - }, - "read": { - "permissions": [ - "memorydb:DescribeSubnetGroups", - "memorydb:ListTags" - ] - }, - "update": { - "permissions": [ - "memorydb:UpdateSubnetGroup", - "memorydb:DescribeSubnetGroups", - "memorydb:ListTags", - "memorydb:TagResource", - "memorydb:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubnetGroupName" - ], - "properties": { - "ARN": { - "description": "The Amazon Resource Name (ARN) of the subnet group.", - "type": "string" - }, - "Description": { - "description": "An optional description of the subnet group.", - "type": "string" - }, - "SubnetGroupName": { - "description": "The name of the subnet group. This value must be unique as it also serves as the subnet group identifier.", - "pattern": "[a-z][a-z0-9\\-]*", - "type": "string" - }, - "SubnetIds": { - "description": "A list of VPC subnet IDs for the subnet group.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "An array of key-value pairs to apply to this subnet group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ARN" - ], - "required": [ - "SubnetGroupName", - "SubnetIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", - "taggable": true, - "typeName": "AWS::MemoryDB::SubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubnetGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key for the tag. May not be null.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,128}$", + "type": "string" + }, + "Value": { + "description": "The tag's value. May be null.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!aws:)(?!memorydb:)[a-zA-Z0-9 _\\.\\/=+:\\-@]{1,256}$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.", + "handlers": { + "create": { + "permissions": [ + "memorydb:CreateSubnetGroup", + "memorydb:DescribeSubnetGroups", + "memorydb:TagResource", + "memorydb:ListTags" + ] + }, + "delete": { + "permissions": [ + "memorydb:DeleteSubnetGroup", + "memorydb:DescribeSubnetGroups" + ] + }, + "list": { + "permissions": [ + "memorydb:DescribeSubnetGroups" + ] + }, + "read": { + "permissions": [ + "memorydb:DescribeSubnetGroups", + "memorydb:ListTags" + ] + }, + "update": { + "permissions": [ + "memorydb:UpdateSubnetGroup", + "memorydb:DescribeSubnetGroups", + "memorydb:ListTags", + "memorydb:TagResource", + "memorydb:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubnetGroupName" + ], + "properties": { + "ARN": { + "description": "The Amazon Resource Name (ARN) of the subnet group.", + "type": "string" + }, + "Description": { + "description": "An optional description of the subnet group.", + "type": "string" + }, + "SubnetGroupName": { + "description": "The name of the subnet group. This value must be unique as it also serves as the subnet group identifier.", + "pattern": "[a-z][a-z0-9\\-]*", + "type": "string" + }, + "SubnetIds": { + "description": "A list of VPC subnet IDs for the subnet group.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "An array of key-value pairs to apply to this subnet group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ARN" + ], + "required": [ + "SubnetGroupName", + "SubnetIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", + "taggable": true, + "typeName": "AWS::MemoryDB::SubnetGroup" +} diff --git a/schema/aws-memorydb-user.json b/schema/aws-memorydb-user.json index 5897714..81bd16f 100644 --- a/schema/aws-memorydb-user.json +++ b/schema/aws-memorydb-user.json @@ -1,142 +1,142 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MemoryDB::User", - "handlers": { - "create": { - "permissions": [ - "memorydb:CreateUser", - "memorydb:DescribeUsers", - "memorydb:TagResource", - "memorydb:ListTags" - ] - }, - "delete": { - "permissions": [ - "memorydb:DeleteUser", - "memorydb:DescribeUsers" - ] - }, - "list": { - "permissions": [ - "memorydb:DescribeUsers", - "memorydb:ListTags" - ] - }, - "read": { - "permissions": [ - "memorydb:DescribeUsers", - "memorydb:ListTags" - ] - }, - "update": { - "permissions": [ - "memorydb:UpdateUser", - "memorydb:DescribeUsers", - "memorydb:ListTags", - "memorydb:TagResource", - "memorydb:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserName" - ], - "properties": { - "AccessString": { - "description": "Access permissions string used for this user account.", - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the user account.", - "type": "string" - }, - "AuthenticationMode": { - "additionalProperties": false, - "properties": { - "Passwords": { - "$comment": "List of passwords.", - "description": "Passwords used for this user account. You can create up to two passwords for each user.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "Type of authentication strategy for this user.", - "enum": [ - "password", - "iam" - ], - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this user.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserName": { - "description": "The name of the user.", - "pattern": "[a-z][a-z0-9\\\\-]*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Arn" - ], - "required": [ - "UserName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", - "taggable": true, - "typeName": "AWS::MemoryDB::User", - "writeOnlyProperties": [ - "/properties/AuthenticationMode", - "/properties/AccessString" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9 _\\.\\/=+:\\-@]*$", + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MemoryDB::User", + "handlers": { + "create": { + "permissions": [ + "memorydb:CreateUser", + "memorydb:DescribeUsers", + "memorydb:TagResource", + "memorydb:ListTags" + ] + }, + "delete": { + "permissions": [ + "memorydb:DeleteUser", + "memorydb:DescribeUsers" + ] + }, + "list": { + "permissions": [ + "memorydb:DescribeUsers", + "memorydb:ListTags" + ] + }, + "read": { + "permissions": [ + "memorydb:DescribeUsers", + "memorydb:ListTags" + ] + }, + "update": { + "permissions": [ + "memorydb:UpdateUser", + "memorydb:DescribeUsers", + "memorydb:ListTags", + "memorydb:TagResource", + "memorydb:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserName" + ], + "properties": { + "AccessString": { + "description": "Access permissions string used for this user account.", + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the user account.", + "type": "string" + }, + "AuthenticationMode": { + "additionalProperties": false, + "properties": { + "Passwords": { + "$comment": "List of passwords.", + "description": "Passwords used for this user account. You can create up to two passwords for each user.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "Type of authentication strategy for this user.", + "enum": [ + "password", + "iam" + ], + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this user.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserName": { + "description": "The name of the user.", + "pattern": "[a-z][a-z0-9\\\\-]*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn" + ], + "required": [ + "UserName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb", + "taggable": true, + "typeName": "AWS::MemoryDB::User", + "writeOnlyProperties": [ + "/properties/AuthenticationMode", + "/properties/AccessString" + ] +} diff --git a/schema/aws-msk-batchscramsecret.json b/schema/aws-msk-batchscramsecret.json index 7619abb..c34915a 100644 --- a/schema/aws-msk-batchscramsecret.json +++ b/schema/aws-msk-batchscramsecret.json @@ -1,93 +1,93 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterArn" - ], - "definitions": { - "SecretArnList": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "description": "Resource Type definition for AWS::MSK::BatchScramSecret", - "handlers": { - "create": { - "permissions": [ - "kafka:BatchAssociateScramSecret", - "kafka:ListScramSecrets", - "kms:CreateGrant", - "kms:DescribeKey", - "secretsmanager:GetSecretValue" - ] - }, - "delete": { - "permissions": [ - "kafka:BatchDisassociateScramSecret", - "kafka:ListScramSecrets", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterArn": { - "$ref": "resource-schema.json#/properties/ClusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "permissions": [ - "kafka:ListScramSecrets", - "kms:CreateGrant", - "kms:DescribeKey", - "secretsmanager:GetSecretValue" - ] - }, - "read": { - "permissions": [ - "kafka:ListScramSecrets", - "kms:CreateGrant", - "kms:DescribeKey", - "secretsmanager:GetSecretValue" - ] - }, - "update": { - "permissions": [ - "kafka:BatchAssociateScramSecret", - "kafka:BatchDisassociateScramSecret", - "kafka:ListScramSecrets", - "kms:CreateGrant", - "kms:DescribeKey", - "secretsmanager:GetSecretValue" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterArn" - ], - "properties": { - "ClusterArn": { - "type": "string" - }, - "SecretArnList": { - "$ref": "#/definitions/SecretArnList" - } - }, - "required": [ - "ClusterArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::MSK::BatchScramSecret" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterArn" + ], + "definitions": { + "SecretArnList": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "description": "Resource Type definition for AWS::MSK::BatchScramSecret", + "handlers": { + "create": { + "permissions": [ + "kafka:BatchAssociateScramSecret", + "kafka:ListScramSecrets", + "kms:CreateGrant", + "kms:DescribeKey", + "secretsmanager:GetSecretValue" + ] + }, + "delete": { + "permissions": [ + "kafka:BatchDisassociateScramSecret", + "kafka:ListScramSecrets", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterArn": { + "$ref": "resource-schema.json#/properties/ClusterArn" + } + }, + "required": [ + "ClusterArn" + ] + }, + "permissions": [ + "kafka:ListScramSecrets", + "kms:CreateGrant", + "kms:DescribeKey", + "secretsmanager:GetSecretValue" + ] + }, + "read": { + "permissions": [ + "kafka:ListScramSecrets", + "kms:CreateGrant", + "kms:DescribeKey", + "secretsmanager:GetSecretValue" + ] + }, + "update": { + "permissions": [ + "kafka:BatchAssociateScramSecret", + "kafka:BatchDisassociateScramSecret", + "kafka:ListScramSecrets", + "kms:CreateGrant", + "kms:DescribeKey", + "secretsmanager:GetSecretValue" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterArn" + ], + "properties": { + "ClusterArn": { + "type": "string" + }, + "SecretArnList": { + "$ref": "#/definitions/SecretArnList" + } + }, + "required": [ + "ClusterArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::MSK::BatchScramSecret" +} diff --git a/schema/aws-msk-cluster.json b/schema/aws-msk-cluster.json index a04a927..35e2fa0 100644 --- a/schema/aws-msk-cluster.json +++ b/schema/aws-msk-cluster.json @@ -1,617 +1,617 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BrokerNodeGroupInfo/BrokerAZDistribution", - "/properties/BrokerNodeGroupInfo/ClientSubnets", - "/properties/BrokerNodeGroupInfo/SecurityGroups", - "/properties/EncryptionInfo/EncryptionAtRest", - "/properties/EncryptionInfo/EncryptionInTransit/InCluster", - "/properties/ClusterName" - ], - "definitions": { - "BrokerLogs": { - "additionalProperties": false, - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/CloudWatchLogs" - }, - "Firehose": { - "$ref": "#/definitions/Firehose" - }, - "S3": { - "$ref": "#/definitions/S3" - } - }, - "type": "object" - }, - "BrokerNodeGroupInfo": { - "additionalProperties": false, - "properties": { - "BrokerAZDistribution": { - "maxLength": 9, - "minLength": 6, - "type": "string" - }, - "ClientSubnets": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ConnectivityInfo": { - "$ref": "#/definitions/ConnectivityInfo" - }, - "InstanceType": { - "maxLength": 32, - "minLength": 5, - "type": "string" - }, - "SecurityGroups": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StorageInfo": { - "$ref": "#/definitions/StorageInfo" - } - }, - "required": [ - "ClientSubnets", - "InstanceType" - ], - "type": "object" - }, - "ClientAuthentication": { - "additionalProperties": false, - "properties": { - "Sasl": { - "$ref": "#/definitions/Sasl" - }, - "Tls": { - "$ref": "#/definitions/Tls" - }, - "Unauthenticated": { - "$ref": "#/definitions/Unauthenticated" - } - }, - "type": "object" - }, - "CloudWatchLogs": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LogGroup": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "ConfigurationInfo": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Revision": { - "type": "integer" - } - }, - "required": [ - "Revision", - "Arn" - ], - "type": "object" - }, - "ConnectivityInfo": { - "additionalProperties": false, - "properties": { - "PublicAccess": { - "$ref": "#/definitions/PublicAccess" - }, - "VpcConnectivity": { - "$ref": "#/definitions/VpcConnectivity" - } - }, - "type": "object" - }, - "EBSStorageInfo": { - "additionalProperties": false, - "properties": { - "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput" - }, - "VolumeSize": { - "maximum": 16384, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "EncryptionAtRest": { - "additionalProperties": false, - "properties": { - "DataVolumeKMSKeyId": { - "type": "string" - } - }, - "required": [ - "DataVolumeKMSKeyId" - ], - "type": "object" - }, - "EncryptionInTransit": { - "additionalProperties": false, - "properties": { - "ClientBroker": { - "enum": [ - "TLS", - "TLS_PLAINTEXT", - "PLAINTEXT" - ], - "type": "string" - }, - "InCluster": { - "type": "boolean" - } - }, - "type": "object" - }, - "EncryptionInfo": { - "additionalProperties": false, - "properties": { - "EncryptionAtRest": { - "$ref": "#/definitions/EncryptionAtRest" - }, - "EncryptionInTransit": { - "$ref": "#/definitions/EncryptionInTransit" - } - }, - "type": "object" - }, - "Firehose": { - "additionalProperties": false, - "properties": { - "DeliveryStream": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "Iam": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "JmxExporter": { - "additionalProperties": false, - "properties": { - "EnabledInBroker": { - "type": "boolean" - } - }, - "required": [ - "EnabledInBroker" - ], - "type": "object" - }, - "LoggingInfo": { - "additionalProperties": false, - "properties": { - "BrokerLogs": { - "$ref": "#/definitions/BrokerLogs" - } - }, - "required": [ - "BrokerLogs" - ], - "type": "object" - }, - "NodeExporter": { - "additionalProperties": false, - "properties": { - "EnabledInBroker": { - "type": "boolean" - } - }, - "required": [ - "EnabledInBroker" - ], - "type": "object" - }, - "OpenMonitoring": { - "additionalProperties": false, - "properties": { - "Prometheus": { - "$ref": "#/definitions/Prometheus" - } - }, - "required": [ - "Prometheus" - ], - "type": "object" - }, - "Prometheus": { - "additionalProperties": false, - "properties": { - "JmxExporter": { - "$ref": "#/definitions/JmxExporter" - }, - "NodeExporter": { - "$ref": "#/definitions/NodeExporter" - } - }, - "type": "object" - }, - "ProvisionedThroughput": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "VolumeThroughput": { - "type": "integer" - } - }, - "type": "object" - }, - "PublicAccess": { - "additionalProperties": false, - "properties": { - "Type": { - "maxLength": 23, - "minLength": 7, - "type": "string" - } - }, - "type": "object" - }, - "S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "Sasl": { - "additionalProperties": false, - "properties": { - "Iam": { - "$ref": "#/definitions/Iam" - }, - "Scram": { - "$ref": "#/definitions/Scram" - } - }, - "type": "object" - }, - "Scram": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "StorageInfo": { - "additionalProperties": false, - "properties": { - "EBSStorageInfo": { - "$ref": "#/definitions/EBSStorageInfo" - } - }, - "type": "object" - }, - "Tls": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArnList": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "Unauthenticated": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "VpcConnectivity": { - "additionalProperties": false, - "properties": { - "ClientAuthentication": { - "$ref": "#/definitions/VpcConnectivityClientAuthentication" - } - }, - "type": "object" - }, - "VpcConnectivityClientAuthentication": { - "additionalProperties": false, - "properties": { - "Sasl": { - "$ref": "#/definitions/VpcConnectivitySasl" - }, - "Tls": { - "$ref": "#/definitions/VpcConnectivityTls" - } - }, - "type": "object" - }, - "VpcConnectivityIam": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "VpcConnectivitySasl": { - "additionalProperties": false, - "properties": { - "Iam": { - "$ref": "#/definitions/VpcConnectivityIam" - }, - "Scram": { - "$ref": "#/definitions/VpcConnectivityScram" - } - }, - "type": "object" - }, - "VpcConnectivityScram": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "VpcConnectivityTls": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MSK::Cluster", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "iam:AttachRolePolicy", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "kms:CreateGrant", - "kms:DescribeKey", - "kafka:CreateCluster", - "kafka:DescribeCluster", - "kafka:TagResource", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "firehose:TagDeliveryStream", - "acm-pca:GetCertificateAuthorityCertificate" - ], - "timeoutInMinutes": 120 - }, - "delete": { - "permissions": [ - "kafka:DeleteCluster", - "kafka:DescribeCluster" - ], - "timeoutInMinutes": 30 - }, - "list": { - "permissions": [ - "kafka:ListClusters" - ] - }, - "read": { - "permissions": [ - "kafka:DescribeCluster" - ] - }, - "update": { - "permissions": [ - "kafka:UpdateMonitoring", - "kafka:UpdateClusterKafkaVersion", - "kafka:UpdateClusterConfiguration", - "kafka:UpdateBrokerType", - "kafka:UpdateBrokerCount", - "kafka:UpdateBrokerStorage", - "kafka:UpdateStorage", - "kafka:UpdateSecurity", - "kafka:UpdateConnectivity", - "kafka:DescribeCluster", - "kafka:DescribeClusterOperation", - "kafka:TagResource", - "kafka:UntagResource", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:DescribeSecurityGroups", - "iam:AttachRolePolicy", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "kms:DescribeKey", - "kms:CreateGrant", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "firehose:TagDeliveryStream", - "acm-pca:GetCertificateAuthorityCertificate" - ], - "timeoutInMinutes": 720 - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "BrokerNodeGroupInfo": { - "$ref": "#/definitions/BrokerNodeGroupInfo" - }, - "ClientAuthentication": { - "$ref": "#/definitions/ClientAuthentication" - }, - "ClusterName": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ConfigurationInfo": { - "$ref": "#/definitions/ConfigurationInfo" - }, - "CurrentVersion": { - "description": "The current version of the MSK cluster", - "type": "string" - }, - "EncryptionInfo": { - "$ref": "#/definitions/EncryptionInfo" - }, - "EnhancedMonitoring": { - "enum": [ - "DEFAULT", - "PER_BROKER", - "PER_TOPIC_PER_BROKER", - "PER_TOPIC_PER_PARTITION" - ], - "maxLength": 23, - "minLength": 7, - "type": "string" - }, - "KafkaVersion": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "LoggingInfo": { - "$ref": "#/definitions/LoggingInfo" - }, - "NumberOfBrokerNodes": { - "type": "integer" - }, - "OpenMonitoring": { - "$ref": "#/definitions/OpenMonitoring" - }, - "StorageMode": { - "enum": [ - "LOCAL", - "TIERED" - ], - "maxLength": 6, - "minLength": 5, - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "BrokerNodeGroupInfo", - "KafkaVersion", - "NumberOfBrokerNodes", - "ClusterName" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MSK::Cluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BrokerNodeGroupInfo/BrokerAZDistribution", + "/properties/BrokerNodeGroupInfo/ClientSubnets", + "/properties/BrokerNodeGroupInfo/SecurityGroups", + "/properties/EncryptionInfo/EncryptionAtRest", + "/properties/EncryptionInfo/EncryptionInTransit/InCluster", + "/properties/ClusterName" + ], + "definitions": { + "BrokerLogs": { + "additionalProperties": false, + "properties": { + "CloudWatchLogs": { + "$ref": "#/definitions/CloudWatchLogs" + }, + "Firehose": { + "$ref": "#/definitions/Firehose" + }, + "S3": { + "$ref": "#/definitions/S3" + } + }, + "type": "object" + }, + "BrokerNodeGroupInfo": { + "additionalProperties": false, + "properties": { + "BrokerAZDistribution": { + "maxLength": 9, + "minLength": 6, + "type": "string" + }, + "ClientSubnets": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ConnectivityInfo": { + "$ref": "#/definitions/ConnectivityInfo" + }, + "InstanceType": { + "maxLength": 32, + "minLength": 5, + "type": "string" + }, + "SecurityGroups": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StorageInfo": { + "$ref": "#/definitions/StorageInfo" + } + }, + "required": [ + "ClientSubnets", + "InstanceType" + ], + "type": "object" + }, + "ClientAuthentication": { + "additionalProperties": false, + "properties": { + "Sasl": { + "$ref": "#/definitions/Sasl" + }, + "Tls": { + "$ref": "#/definitions/Tls" + }, + "Unauthenticated": { + "$ref": "#/definitions/Unauthenticated" + } + }, + "type": "object" + }, + "CloudWatchLogs": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "LogGroup": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "ConfigurationInfo": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "Revision": { + "type": "integer" + } + }, + "required": [ + "Revision", + "Arn" + ], + "type": "object" + }, + "ConnectivityInfo": { + "additionalProperties": false, + "properties": { + "PublicAccess": { + "$ref": "#/definitions/PublicAccess" + }, + "VpcConnectivity": { + "$ref": "#/definitions/VpcConnectivity" + } + }, + "type": "object" + }, + "EBSStorageInfo": { + "additionalProperties": false, + "properties": { + "ProvisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput" + }, + "VolumeSize": { + "maximum": 16384, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "EncryptionAtRest": { + "additionalProperties": false, + "properties": { + "DataVolumeKMSKeyId": { + "type": "string" + } + }, + "required": [ + "DataVolumeKMSKeyId" + ], + "type": "object" + }, + "EncryptionInTransit": { + "additionalProperties": false, + "properties": { + "ClientBroker": { + "enum": [ + "TLS", + "TLS_PLAINTEXT", + "PLAINTEXT" + ], + "type": "string" + }, + "InCluster": { + "type": "boolean" + } + }, + "type": "object" + }, + "EncryptionInfo": { + "additionalProperties": false, + "properties": { + "EncryptionAtRest": { + "$ref": "#/definitions/EncryptionAtRest" + }, + "EncryptionInTransit": { + "$ref": "#/definitions/EncryptionInTransit" + } + }, + "type": "object" + }, + "Firehose": { + "additionalProperties": false, + "properties": { + "DeliveryStream": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "Iam": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "JmxExporter": { + "additionalProperties": false, + "properties": { + "EnabledInBroker": { + "type": "boolean" + } + }, + "required": [ + "EnabledInBroker" + ], + "type": "object" + }, + "LoggingInfo": { + "additionalProperties": false, + "properties": { + "BrokerLogs": { + "$ref": "#/definitions/BrokerLogs" + } + }, + "required": [ + "BrokerLogs" + ], + "type": "object" + }, + "NodeExporter": { + "additionalProperties": false, + "properties": { + "EnabledInBroker": { + "type": "boolean" + } + }, + "required": [ + "EnabledInBroker" + ], + "type": "object" + }, + "OpenMonitoring": { + "additionalProperties": false, + "properties": { + "Prometheus": { + "$ref": "#/definitions/Prometheus" + } + }, + "required": [ + "Prometheus" + ], + "type": "object" + }, + "Prometheus": { + "additionalProperties": false, + "properties": { + "JmxExporter": { + "$ref": "#/definitions/JmxExporter" + }, + "NodeExporter": { + "$ref": "#/definitions/NodeExporter" + } + }, + "type": "object" + }, + "ProvisionedThroughput": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "VolumeThroughput": { + "type": "integer" + } + }, + "type": "object" + }, + "PublicAccess": { + "additionalProperties": false, + "properties": { + "Type": { + "maxLength": 23, + "minLength": 7, + "type": "string" + } + }, + "type": "object" + }, + "S3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Prefix": { + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "Sasl": { + "additionalProperties": false, + "properties": { + "Iam": { + "$ref": "#/definitions/Iam" + }, + "Scram": { + "$ref": "#/definitions/Scram" + } + }, + "type": "object" + }, + "Scram": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "StorageInfo": { + "additionalProperties": false, + "properties": { + "EBSStorageInfo": { + "$ref": "#/definitions/EBSStorageInfo" + } + }, + "type": "object" + }, + "Tls": { + "additionalProperties": false, + "properties": { + "CertificateAuthorityArnList": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "Unauthenticated": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "VpcConnectivity": { + "additionalProperties": false, + "properties": { + "ClientAuthentication": { + "$ref": "#/definitions/VpcConnectivityClientAuthentication" + } + }, + "type": "object" + }, + "VpcConnectivityClientAuthentication": { + "additionalProperties": false, + "properties": { + "Sasl": { + "$ref": "#/definitions/VpcConnectivitySasl" + }, + "Tls": { + "$ref": "#/definitions/VpcConnectivityTls" + } + }, + "type": "object" + }, + "VpcConnectivityIam": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "VpcConnectivitySasl": { + "additionalProperties": false, + "properties": { + "Iam": { + "$ref": "#/definitions/VpcConnectivityIam" + }, + "Scram": { + "$ref": "#/definitions/VpcConnectivityScram" + } + }, + "type": "object" + }, + "VpcConnectivityScram": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "VpcConnectivityTls": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MSK::Cluster", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "iam:AttachRolePolicy", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "kms:CreateGrant", + "kms:DescribeKey", + "kafka:CreateCluster", + "kafka:DescribeCluster", + "kafka:TagResource", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "firehose:TagDeliveryStream", + "acm-pca:GetCertificateAuthorityCertificate" + ], + "timeoutInMinutes": 120 + }, + "delete": { + "permissions": [ + "kafka:DeleteCluster", + "kafka:DescribeCluster" + ], + "timeoutInMinutes": 30 + }, + "list": { + "permissions": [ + "kafka:ListClusters" + ] + }, + "read": { + "permissions": [ + "kafka:DescribeCluster" + ] + }, + "update": { + "permissions": [ + "kafka:UpdateMonitoring", + "kafka:UpdateClusterKafkaVersion", + "kafka:UpdateClusterConfiguration", + "kafka:UpdateBrokerType", + "kafka:UpdateBrokerCount", + "kafka:UpdateBrokerStorage", + "kafka:UpdateStorage", + "kafka:UpdateSecurity", + "kafka:UpdateConnectivity", + "kafka:DescribeCluster", + "kafka:DescribeClusterOperation", + "kafka:TagResource", + "kafka:UntagResource", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeSecurityGroups", + "iam:AttachRolePolicy", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "firehose:TagDeliveryStream", + "acm-pca:GetCertificateAuthorityCertificate" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "BrokerNodeGroupInfo": { + "$ref": "#/definitions/BrokerNodeGroupInfo" + }, + "ClientAuthentication": { + "$ref": "#/definitions/ClientAuthentication" + }, + "ClusterName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ConfigurationInfo": { + "$ref": "#/definitions/ConfigurationInfo" + }, + "CurrentVersion": { + "description": "The current version of the MSK cluster", + "type": "string" + }, + "EncryptionInfo": { + "$ref": "#/definitions/EncryptionInfo" + }, + "EnhancedMonitoring": { + "enum": [ + "DEFAULT", + "PER_BROKER", + "PER_TOPIC_PER_BROKER", + "PER_TOPIC_PER_PARTITION" + ], + "maxLength": 23, + "minLength": 7, + "type": "string" + }, + "KafkaVersion": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "LoggingInfo": { + "$ref": "#/definitions/LoggingInfo" + }, + "NumberOfBrokerNodes": { + "type": "integer" + }, + "OpenMonitoring": { + "$ref": "#/definitions/OpenMonitoring" + }, + "StorageMode": { + "enum": [ + "LOCAL", + "TIERED" + ], + "maxLength": 6, + "minLength": 5, + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "BrokerNodeGroupInfo", + "KafkaVersion", + "NumberOfBrokerNodes", + "ClusterName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MSK::Cluster" +} diff --git a/schema/aws-msk-clusterpolicy.json b/schema/aws-msk-clusterpolicy.json index 0b1e64d..174b72e 100644 --- a/schema/aws-msk-clusterpolicy.json +++ b/schema/aws-msk-clusterpolicy.json @@ -1,79 +1,79 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterArn" - ], - "definitions": {}, - "description": "Resource Type definition for AWS::MSK::ClusterPolicy", - "handlers": { - "create": { - "permissions": [ - "kafka:PutClusterPolicy", - "kafka:GetClusterPolicy" - ] - }, - "delete": { - "permissions": [ - "kafka:DeleteClusterPolicy", - "kafka:GetClusterPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ClusterArn": { - "$ref": "resource-schema.json#/properties/ClusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "permissions": [ - "kafka:GetClusterPolicy" - ] - }, - "read": { - "permissions": [ - "kafka:GetClusterPolicy" - ] - }, - "update": { - "permissions": [ - "kafka:PutClusterPolicy", - "kafka:GetClusterPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterArn" - ], - "properties": { - "ClusterArn": { - "description": "The arn of the cluster for the resource policy.", - "pattern": "^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z", - "type": "string" - }, - "CurrentVersion": { - "description": "The current version of the policy attached to the specified cluster", - "pattern": "^(K)([a-zA-Z0-9]+)\\Z", - "type": "string" - }, - "Policy": { - "description": "A policy document containing permissions to add to the specified cluster.", - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/CurrentVersion" - ], - "required": [ - "Policy", - "ClusterArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk", - "tagging": { - "taggable": false - }, - "typeName": "AWS::MSK::ClusterPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterArn" + ], + "definitions": {}, + "description": "Resource Type definition for AWS::MSK::ClusterPolicy", + "handlers": { + "create": { + "permissions": [ + "kafka:PutClusterPolicy", + "kafka:GetClusterPolicy" + ] + }, + "delete": { + "permissions": [ + "kafka:DeleteClusterPolicy", + "kafka:GetClusterPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ClusterArn": { + "$ref": "resource-schema.json#/properties/ClusterArn" + } + }, + "required": [ + "ClusterArn" + ] + }, + "permissions": [ + "kafka:GetClusterPolicy" + ] + }, + "read": { + "permissions": [ + "kafka:GetClusterPolicy" + ] + }, + "update": { + "permissions": [ + "kafka:PutClusterPolicy", + "kafka:GetClusterPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterArn" + ], + "properties": { + "ClusterArn": { + "description": "The arn of the cluster for the resource policy.", + "pattern": "^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z", + "type": "string" + }, + "CurrentVersion": { + "description": "The current version of the policy attached to the specified cluster", + "pattern": "^(K)([a-zA-Z0-9]+)\\Z", + "type": "string" + }, + "Policy": { + "description": "A policy document containing permissions to add to the specified cluster.", + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/CurrentVersion" + ], + "required": [ + "Policy", + "ClusterArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk", + "tagging": { + "taggable": false + }, + "typeName": "AWS::MSK::ClusterPolicy" +} diff --git a/schema/aws-msk-configuration.json b/schema/aws-msk-configuration.json index 59f9a1c..c50d753 100644 --- a/schema/aws-msk-configuration.json +++ b/schema/aws-msk-configuration.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KafkaVersionsList", - "/properties/Name" - ], - "definitions": { - "KafkaVersionsList": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "LatestRevision": { - "additionalProperties": false, - "properties": { - "CreationTime": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Revision": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MSK::Configuration", - "handlers": { - "create": { - "permissions": [ - "kafka:CreateConfiguration", - "Kafka:DescribeConfiguration" - ] - }, - "delete": { - "permissions": [ - "kafka:DeleteConfiguration", - "kafka:DescribeConfiguration" - ] - }, - "list": { - "permissions": [ - "kafka:ListConfigurations" - ] - }, - "read": { - "permissions": [ - "kafka:DescribeConfiguration" - ] - }, - "update": { - "permissions": [ - "kafka:UpdateConfiguration", - "kafka:DescribeConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "KafkaVersionsList": { - "$ref": "#/definitions/KafkaVersionsList" - }, - "LatestRevision": { - "$ref": "#/definitions/LatestRevision" - }, - "Name": { - "type": "string" - }, - "ServerProperties": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/LatestRevision/CreationTime", - "/properties/LatestRevision/Revision", - "/properties/LatestRevision/Description" - ], - "required": [ - "ServerProperties", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::MSK::Configuration", - "writeOnlyProperties": [ - "/properties/ServerProperties" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KafkaVersionsList", + "/properties/Name" + ], + "definitions": { + "KafkaVersionsList": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "LatestRevision": { + "additionalProperties": false, + "properties": { + "CreationTime": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Revision": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MSK::Configuration", + "handlers": { + "create": { + "permissions": [ + "kafka:CreateConfiguration", + "Kafka:DescribeConfiguration" + ] + }, + "delete": { + "permissions": [ + "kafka:DeleteConfiguration", + "kafka:DescribeConfiguration" + ] + }, + "list": { + "permissions": [ + "kafka:ListConfigurations" + ] + }, + "read": { + "permissions": [ + "kafka:DescribeConfiguration" + ] + }, + "update": { + "permissions": [ + "kafka:UpdateConfiguration", + "kafka:DescribeConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "KafkaVersionsList": { + "$ref": "#/definitions/KafkaVersionsList" + }, + "LatestRevision": { + "$ref": "#/definitions/LatestRevision" + }, + "Name": { + "type": "string" + }, + "ServerProperties": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/LatestRevision/CreationTime", + "/properties/LatestRevision/Revision", + "/properties/LatestRevision/Description" + ], + "required": [ + "ServerProperties", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::MSK::Configuration", + "writeOnlyProperties": [ + "/properties/ServerProperties" + ] +} diff --git a/schema/aws-msk-replicator.json b/schema/aws-msk-replicator.json index b12ef8e..7e81850 100644 --- a/schema/aws-msk-replicator.json +++ b/schema/aws-msk-replicator.json @@ -1,383 +1,410 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ReplicatorName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReplicatorName", - "/properties/Description", - "/properties/KafkaClusters", - "/properties/ServiceExecutionRoleArn", - "/properties/ReplicationInfoList/-/TopicReplication/StartingPosition/Type" - ], - "definitions": { - "AmazonMskCluster": { - "additionalProperties": false, - "description": "Details of an Amazon MSK cluster.", - "properties": { - "MskClusterArn": { - "description": "The ARN of an Amazon MSK cluster.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", - "type": "string" - } - }, - "required": [ - "MskClusterArn" - ], - "type": "object" - }, - "ConsumerGroupReplication": { - "additionalProperties": false, - "description": "Configuration relating to consumer group replication.", - "properties": { - "ConsumerGroupsToExclude": { - "description": "List of regular expression patterns indicating the consumer groups that should not be replicated.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ConsumerGroupsToReplicate": { - "description": "List of regular expression patterns indicating the consumer groups to copy.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "type": "string" - }, - "maxItems": 100, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "DetectAndCopyNewConsumerGroups": { - "description": "Whether to periodically check for new consumer groups.", - "type": "boolean" - }, - "SynchroniseConsumerGroupOffsets": { - "description": "Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.", - "type": "boolean" - } - }, - "required": [ - "ConsumerGroupsToReplicate" - ], - "type": "object" - }, - "KafkaCluster": { - "additionalProperties": false, - "description": "Details of a Kafka cluster for replication.", - "properties": { - "AmazonMskCluster": { - "$ref": "#/definitions/AmazonMskCluster", - "description": "Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required." - }, - "VpcConfig": { - "$ref": "#/definitions/KafkaClusterClientVpcConfig", - "description": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster." - } - }, - "required": [ - "AmazonMskCluster", - "VpcConfig" - ], - "type": "object" - }, - "KafkaClusterClientVpcConfig": { - "additionalProperties": false, - "description": "Details of an Amazon VPC which has network connectivity to the Kafka cluster.", - "properties": { - "SecurityGroupIds": { - "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 3, - "minItems": 2, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - }, - "ReplicationInfo": { - "additionalProperties": false, - "description": "Specifies configuration for replication between a source and target Kafka cluster.", - "properties": { - "ConsumerGroupReplication": { - "$ref": "#/definitions/ConsumerGroupReplication", - "description": "Configuration relating to consumer group replication." - }, - "SourceKafkaClusterArn": { - "description": "Amazon Resource Name of the source Kafka cluster.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", - "type": "string" - }, - "TargetCompressionType": { - "description": "The type of compression to use writing records to target Kafka cluster.", - "enum": [ - "NONE", - "GZIP", - "SNAPPY", - "LZ4", - "ZSTD" - ], - "type": "string" - }, - "TargetKafkaClusterArn": { - "description": "Amazon Resource Name of the target Kafka cluster.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", - "type": "string" - }, - "TopicReplication": { - "$ref": "#/definitions/TopicReplication", - "description": "Configuration relating to topic replication." - } - }, - "required": [ - "SourceKafkaClusterArn", - "TargetKafkaClusterArn", - "TopicReplication", - "ConsumerGroupReplication", - "TargetCompressionType" - ], - "type": "object" - }, - "ReplicationStartingPosition": { - "additionalProperties": false, - "description": "Configuration for specifying the position in the topics to start replicating from.", - "properties": { - "Type": { - "$ref": "#/definitions/ReplicationStartingPositionType" - } - }, - "required": [], - "type": "object" - }, - "ReplicationStartingPositionType": { - "description": "The type of replication starting position.", - "enum": [ - "LATEST", - "EARLIEST" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TopicReplication": { - "additionalProperties": false, - "properties": { - "CopyAccessControlListsForTopics": { - "description": "Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.", - "type": "boolean" - }, - "CopyTopicConfigurations": { - "description": "Whether to periodically configure remote topics to match their corresponding upstream topics.", - "type": "boolean" - }, - "DetectAndCopyNewTopics": { - "description": "Whether to periodically check for new topics and partitions.", - "type": "boolean" - }, - "StartingPosition": { - "$ref": "#/definitions/ReplicationStartingPosition", - "description": "Configuration for specifying the position in the topics to start replicating from." - }, - "TopicsToExclude": { - "description": "List of regular expression patterns indicating the topics that should not be replicated.", - "insertionOrder": false, - "items": { - "maxLength": 249, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "TopicsToReplicate": { - "description": "List of regular expression patterns indicating the topics to copy.", - "insertionOrder": false, - "items": { - "maxLength": 249, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "TopicsToReplicate" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MSK::Replicator", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateNetworkInterface", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "kafka:CreateReplicator", - "kafka:CreateReplicatorReference", - "kafka:DescribeClusterV2", - "kafka:DescribeReplicator", - "kafka:GetBootstrapBrokers", - "kafka:ListTagsForResource", - "kafka:TagResource" - ] - }, - "delete": { - "permissions": [ - "kafka:DeleteReplicator", - "kafka:DescribeReplicator", - "kafka:ListTagsForResource", - "kafka:UntagResource" - ] - }, - "list": { - "permissions": [ - "kafka:ListReplicators" - ] - }, - "read": { - "permissions": [ - "kafka:DescribeReplicator", - "kafka:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "kafka:DescribeReplicator", - "kafka:ListTagsForResource", - "kafka:TagResource", - "kafka:UntagResource", - "kafka:UpdateReplicationInfo" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReplicatorArn" - ], - "properties": { - "CurrentVersion": { - "description": "The current version of the MSK replicator.", - "type": "string" - }, - "Description": { - "description": "A summary description of the replicator.", - "maxLength": 1024, - "type": "string" - }, - "KafkaClusters": { - "description": "Specifies a list of Kafka clusters which are targets of the replicator.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/KafkaCluster" - }, - "maxItems": 2, - "minItems": 2, - "type": "array", - "uniqueItems": true - }, - "ReplicationInfoList": { - "description": "A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ReplicationInfo" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ReplicatorArn": { - "description": "Amazon Resource Name for the created replicator.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", - "type": "string" - }, - "ReplicatorName": { - "description": "The name of the replicator.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$", - "type": "string" - }, - "ServiceExecutionRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.", - "pattern": "arn:(aws|aws-us-gov|aws-cn):iam:.*", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ReplicatorArn" - ], - "required": [ - "ReplicatorName", - "ReplicationInfoList", - "KafkaClusters", - "ServiceExecutionRoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk-replicator.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MSK::Replicator" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ReplicatorName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReplicatorName", + "/properties/Description", + "/properties/KafkaClusters", + "/properties/ServiceExecutionRoleArn" + ], + "definitions": { + "AmazonMskCluster": { + "additionalProperties": false, + "description": "Details of an Amazon MSK cluster.", + "properties": { + "MskClusterArn": { + "description": "The ARN of an Amazon MSK cluster.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", + "type": "string" + } + }, + "required": [ + "MskClusterArn" + ], + "type": "object" + }, + "ConsumerGroupReplication": { + "additionalProperties": false, + "description": "Configuration relating to consumer group replication.", + "properties": { + "ConsumerGroupsToExclude": { + "description": "List of regular expression patterns indicating the consumer groups that should not be replicated.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ConsumerGroupsToReplicate": { + "description": "List of regular expression patterns indicating the consumer groups to copy.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "DetectAndCopyNewConsumerGroups": { + "description": "Whether to periodically check for new consumer groups.", + "type": "boolean" + }, + "SynchroniseConsumerGroupOffsets": { + "description": "Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.", + "type": "boolean" + } + }, + "required": [ + "ConsumerGroupsToReplicate" + ], + "type": "object" + }, + "KafkaCluster": { + "additionalProperties": false, + "description": "Details of a Kafka cluster for replication.", + "properties": { + "AmazonMskCluster": { + "$ref": "#/definitions/AmazonMskCluster", + "description": "Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required." + }, + "VpcConfig": { + "$ref": "#/definitions/KafkaClusterClientVpcConfig", + "description": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster." + } + }, + "required": [ + "AmazonMskCluster", + "VpcConfig" + ], + "type": "object" + }, + "KafkaClusterClientVpcConfig": { + "additionalProperties": false, + "description": "Details of an Amazon VPC which has network connectivity to the Kafka cluster.", + "properties": { + "SecurityGroupIds": { + "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 3, + "minItems": 2, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SubnetIds" + ], + "type": "object" + }, + "ReplicationInfo": { + "additionalProperties": false, + "description": "Specifies configuration for replication between a source and target Kafka cluster.", + "properties": { + "ConsumerGroupReplication": { + "$ref": "#/definitions/ConsumerGroupReplication", + "description": "Configuration relating to consumer group replication." + }, + "SourceKafkaClusterArn": { + "description": "Amazon Resource Name of the source Kafka cluster.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", + "type": "string" + }, + "TargetCompressionType": { + "description": "The type of compression to use writing records to target Kafka cluster.", + "enum": [ + "NONE", + "GZIP", + "SNAPPY", + "LZ4", + "ZSTD" + ], + "type": "string" + }, + "TargetKafkaClusterArn": { + "description": "Amazon Resource Name of the target Kafka cluster.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", + "type": "string" + }, + "TopicReplication": { + "$ref": "#/definitions/TopicReplication", + "description": "Configuration relating to topic replication." + } + }, + "required": [ + "SourceKafkaClusterArn", + "TargetKafkaClusterArn", + "TopicReplication", + "ConsumerGroupReplication", + "TargetCompressionType" + ], + "type": "object" + }, + "ReplicationStartingPosition": { + "additionalProperties": false, + "description": "Configuration for specifying the position in the topics to start replicating from.", + "properties": { + "Type": { + "$ref": "#/definitions/ReplicationStartingPositionType" + } + }, + "required": [], + "type": "object" + }, + "ReplicationStartingPositionType": { + "description": "The type of replication starting position.", + "enum": [ + "LATEST", + "EARLIEST" + ], + "type": "string" + }, + "ReplicationTopicNameConfiguration": { + "additionalProperties": false, + "description": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.", + "properties": { + "Type": { + "$ref": "#/definitions/ReplicationTopicNameConfigurationType" + } + }, + "required": [], + "type": "object" + }, + "ReplicationTopicNameConfigurationType": { + "description": "The type of replicated topic name.", + "enum": [ + "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS", + "IDENTICAL" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TopicReplication": { + "additionalProperties": false, + "properties": { + "CopyAccessControlListsForTopics": { + "description": "Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.", + "type": "boolean" + }, + "CopyTopicConfigurations": { + "description": "Whether to periodically configure remote topics to match their corresponding upstream topics.", + "type": "boolean" + }, + "DetectAndCopyNewTopics": { + "description": "Whether to periodically check for new topics and partitions.", + "type": "boolean" + }, + "StartingPosition": { + "$ref": "#/definitions/ReplicationStartingPosition", + "description": "Configuration for specifying the position in the topics to start replicating from." + }, + "TopicNameConfiguration": { + "$ref": "#/definitions/ReplicationTopicNameConfiguration", + "description": "Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias." + }, + "TopicsToExclude": { + "description": "List of regular expression patterns indicating the topics that should not be replicated.", + "insertionOrder": false, + "items": { + "maxLength": 249, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TopicsToReplicate": { + "description": "List of regular expression patterns indicating the topics to copy.", + "insertionOrder": false, + "items": { + "maxLength": 249, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "TopicsToReplicate" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MSK::Replicator", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateNetworkInterface", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "kafka:CreateReplicator", + "kafka:CreateReplicatorReference", + "kafka:DescribeClusterV2", + "kafka:DescribeReplicator", + "kafka:GetBootstrapBrokers", + "kafka:ListTagsForResource", + "kafka:TagResource" + ] + }, + "delete": { + "permissions": [ + "kafka:DeleteReplicator", + "kafka:DescribeReplicator", + "kafka:ListTagsForResource", + "kafka:UntagResource" + ] + }, + "list": { + "permissions": [ + "kafka:ListReplicators" + ] + }, + "read": { + "permissions": [ + "kafka:DescribeReplicator", + "kafka:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafka:DescribeReplicator", + "kafka:ListTagsForResource", + "kafka:TagResource", + "kafka:UntagResource", + "kafka:UpdateReplicationInfo" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReplicatorArn" + ], + "properties": { + "CurrentVersion": { + "description": "The current version of the MSK replicator.", + "type": "string" + }, + "Description": { + "description": "A summary description of the replicator.", + "maxLength": 1024, + "type": "string" + }, + "KafkaClusters": { + "description": "Specifies a list of Kafka clusters which are targets of the replicator.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/KafkaCluster" + }, + "maxItems": 2, + "minItems": 2, + "type": "array", + "uniqueItems": true + }, + "ReplicationInfoList": { + "description": "A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ReplicationInfo" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ReplicatorArn": { + "description": "Amazon Resource Name for the created replicator.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafka:.*", + "type": "string" + }, + "ReplicatorName": { + "description": "The name of the replicator.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$", + "type": "string" + }, + "ServiceExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):iam:.*", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ReplicatorArn" + ], + "required": [ + "ReplicatorName", + "ReplicationInfoList", + "KafkaClusters", + "ServiceExecutionRoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-msk-replicator.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "kafka:UntagResource", + "kafka:ListTagsForResource", + "kafka:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MSK::Replicator" +} diff --git a/schema/aws-msk-serverlesscluster.json b/schema/aws-msk-serverlesscluster.json index c5acdc8..3610bb2 100644 --- a/schema/aws-msk-serverlesscluster.json +++ b/schema/aws-msk-serverlesscluster.json @@ -1,158 +1,158 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterName", - "/properties/VpcConfigs", - "/properties/ClientAuthentication", - "/properties/Tags" - ], - "definitions": { - "ClientAuthentication": { - "additionalProperties": false, - "properties": { - "Sasl": { - "$ref": "#/definitions/Sasl" - } - }, - "required": [ - "Sasl" - ], - "type": "object" - }, - "Iam": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "Sasl": { - "additionalProperties": false, - "properties": { - "Iam": { - "$ref": "#/definitions/Iam" - } - }, - "required": [ - "Iam" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroups": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::MSK::ServerlessCluster", - "handlers": { - "create": { - "permissions": [ - "kafka:CreateClusterV2", - "kafka:TagResource", - "kafka:DescribeClusterV2", - "ec2:CreateVpcEndpoint", - "ec2:CreateTags", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSubnets", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeVpcs", - "ec2:DescribeSecurityGroups" - ], - "timeoutInMinutes": 120 - }, - "delete": { - "permissions": [ - "kafka:DeleteCluster", - "kafka:DescribeClusterV2", - "ec2:DeleteVpcEndpoints" - ], - "timeoutInMinutes": 75 - }, - "list": { - "permissions": [ - "kafka:ListClustersV2" - ] - }, - "read": { - "permissions": [ - "kafka:DescribeClusterV2" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "ClientAuthentication": { - "$ref": "#/definitions/ClientAuthentication" - }, - "ClusterName": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - }, - "VpcConfigs": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcConfig" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ClusterName", - "VpcConfigs", - "ClientAuthentication" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::MSK::ServerlessCluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/VpcConfigs", + "/properties/ClientAuthentication", + "/properties/Tags" + ], + "definitions": { + "ClientAuthentication": { + "additionalProperties": false, + "properties": { + "Sasl": { + "$ref": "#/definitions/Sasl" + } + }, + "required": [ + "Sasl" + ], + "type": "object" + }, + "Iam": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "Sasl": { + "additionalProperties": false, + "properties": { + "Iam": { + "$ref": "#/definitions/Iam" + } + }, + "required": [ + "Iam" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroups": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SubnetIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::MSK::ServerlessCluster", + "handlers": { + "create": { + "permissions": [ + "kafka:CreateClusterV2", + "kafka:TagResource", + "kafka:DescribeClusterV2", + "ec2:CreateVpcEndpoint", + "ec2:CreateTags", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSubnets", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeVpcs", + "ec2:DescribeSecurityGroups" + ], + "timeoutInMinutes": 120 + }, + "delete": { + "permissions": [ + "kafka:DeleteCluster", + "kafka:DescribeClusterV2", + "ec2:DeleteVpcEndpoints" + ], + "timeoutInMinutes": 75 + }, + "list": { + "permissions": [ + "kafka:ListClustersV2" + ] + }, + "read": { + "permissions": [ + "kafka:DescribeClusterV2" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "ClientAuthentication": { + "$ref": "#/definitions/ClientAuthentication" + }, + "ClusterName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + }, + "VpcConfigs": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcConfig" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ClusterName", + "VpcConfigs", + "ClientAuthentication" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::MSK::ServerlessCluster" +} diff --git a/schema/aws-msk-vpcconnection.json b/schema/aws-msk-vpcconnection.json index b3b0e0b..8c96aa5 100644 --- a/schema/aws-msk-vpcconnection.json +++ b/schema/aws-msk-vpcconnection.json @@ -1,161 +1,161 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClientSubnets", - "/properties/Authentication", - "/properties/SecurityGroups", - "/properties/TargetClusterArn", - "/properties/VpcId" - ], - "definitions": { - "Authentication": { - "description": "The type of private link authentication", - "enum": [ - "SASL_IAM", - "SASL_SCRAM", - "TLS" - ], - "maxLength": 10, - "minLength": 3, - "type": "string" - }, - "ClientSubnets": { - "insertionOrder": false, - "items": { - "pattern": "^(subnet-)([a-z0-9]+)\\Z", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroups": { - "insertionOrder": false, - "items": { - "pattern": "^(sg-)([a-z0-9]+)\\Z", - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - }, - "VpcId": { - "pattern": "^(vpc-)([a-z0-9]+)\\Z", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::MSK::VpcConnection", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpoint", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "ec2:DescribeVpcEndpoints", - "ec2:AcceptVpcEndpointConnections", - "ec2:RejectVpcEndpointConnections", - "ec2:DescribeVpcEndpointConnections", - "ec2:CreateTags", - "iam:AttachRolePolicy", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "kafka:CreateVpcConnection", - "kafka:DescribeVpcConnection", - "kafka:TagResource", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpoint", - "ec2:DeleteVpcEndpoints", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeVpcEndpointConnections", - "kafka:DeleteVpcConnection", - "kafka:DescribeVpcConnection", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "list": { - "permissions": [ - "kafka:ListVpcConnections", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "read": { - "permissions": [ - "kafka:DescribeVpcConnection", - "kms:CreateGrant", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "kafka:DescribeVpcConnection", - "kms:CreateGrant", - "kms:DescribeKey", - "kafka:TagResource", - "kafka:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Authentication": { - "$ref": "#/definitions/Authentication" - }, - "ClientSubnets": { - "$ref": "#/definitions/ClientSubnets" - }, - "SecurityGroups": { - "$ref": "#/definitions/SecurityGroups" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "TargetClusterArn": { - "description": "The Amazon Resource Name (ARN) of the target cluster", - "pattern": "^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z", - "type": "string" - }, - "VpcId": { - "$ref": "#/definitions/VpcId" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Authentication", - "ClientSubnets", - "SecurityGroups", - "TargetClusterArn", - "VpcId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::MSK::VpcConnection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientSubnets", + "/properties/Authentication", + "/properties/SecurityGroups", + "/properties/TargetClusterArn", + "/properties/VpcId" + ], + "definitions": { + "Authentication": { + "description": "The type of private link authentication", + "enum": [ + "SASL_IAM", + "SASL_SCRAM", + "TLS" + ], + "maxLength": 10, + "minLength": 3, + "type": "string" + }, + "ClientSubnets": { + "insertionOrder": false, + "items": { + "pattern": "^(subnet-)([a-z0-9]+)\\Z", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroups": { + "insertionOrder": false, + "items": { + "pattern": "^(sg-)([a-z0-9]+)\\Z", + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + }, + "VpcId": { + "pattern": "^(vpc-)([a-z0-9]+)\\Z", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::MSK::VpcConnection", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpoint", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "ec2:DescribeVpcEndpoints", + "ec2:AcceptVpcEndpointConnections", + "ec2:RejectVpcEndpointConnections", + "ec2:DescribeVpcEndpointConnections", + "ec2:CreateTags", + "iam:AttachRolePolicy", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "kafka:CreateVpcConnection", + "kafka:DescribeVpcConnection", + "kafka:TagResource", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpoint", + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeVpcEndpointConnections", + "kafka:DeleteVpcConnection", + "kafka:DescribeVpcConnection", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "list": { + "permissions": [ + "kafka:ListVpcConnections", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "read": { + "permissions": [ + "kafka:DescribeVpcConnection", + "kms:CreateGrant", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "kafka:DescribeVpcConnection", + "kms:CreateGrant", + "kms:DescribeKey", + "kafka:TagResource", + "kafka:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Authentication": { + "$ref": "#/definitions/Authentication" + }, + "ClientSubnets": { + "$ref": "#/definitions/ClientSubnets" + }, + "SecurityGroups": { + "$ref": "#/definitions/SecurityGroups" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "TargetClusterArn": { + "description": "The Amazon Resource Name (ARN) of the target cluster", + "pattern": "^arn:[\\w-]+:kafka:[\\w-]+:\\d+:cluster.*\\Z", + "type": "string" + }, + "VpcId": { + "$ref": "#/definitions/VpcId" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Authentication", + "ClientSubnets", + "SecurityGroups", + "TargetClusterArn", + "VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MSK::VpcConnection" +} diff --git a/schema/aws-mwaa-environment.json b/schema/aws-mwaa-environment.json index e74a78c..b6567f0 100644 --- a/schema/aws-mwaa-environment.json +++ b/schema/aws-mwaa-environment.json @@ -1,514 +1,524 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/KmsKey", - "/properties/NetworkConfiguration/SubnetIds", - "/properties/EndpointManagement" - ], - "definitions": { - "AirflowArn": { - "description": "", - "maxLength": 1224, - "minLength": 1, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+", - "type": "string" - }, - "AirflowVersion": { - "description": "Version of airflow to deploy to the environment.", - "maxLength": 32, - "pattern": "^[0-9a-z.]+$", - "type": "string" - }, - "CeleryExecutorQueue": { - "description": "The celery executor queue associated with the environment.", - "maxLength": 1224, - "type": "string" - }, - "CloudWatchLogGroupArn": { - "description": "", - "maxLength": 1224, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:logs:[a-z0-9\\-]+:\\d{12}:log-group:\\w+", - "type": "string" - }, - "ConfigKey": { - "description": "", - "maxLength": 64, - "pattern": "^[a-z]+([a-z._]*[a-z]+)?$", - "type": "string" - }, - "ConfigValue": { - "description": "", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "CreatedAt": { - "description": "When the environment resource was created.", - "type": "string" - }, - "DatabaseVpcEndpointService": { - "description": "The database VPC endpoint service name.", - "maxLength": 1224, - "type": "string" - }, - "EndpointManagement": { - "description": "Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.", - "enum": [ - "CUSTOMER", - "SERVICE" - ], - "type": "string" - }, - "EnvironmentArn": { - "description": "ARN for the MWAA environment.", - "maxLength": 1224, - "minLength": 1, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+", - "type": "string" - }, - "EnvironmentClass": { - "description": "Templated configuration for airflow processes and backing infrastructure.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "EnvironmentName": { - "description": "Customer-defined identifier for the environment, unique per customer region.", - "maxLength": 80, - "minLength": 1, - "pattern": "^[a-zA-Z][0-9a-zA-Z\\-_]*$", - "type": "string" - }, - "EnvironmentStatus": { - "description": "The status of the environment.", - "enum": [ - "CREATING", - "CREATE_FAILED", - "AVAILABLE", - "UPDATING", - "DELETING", - "DELETED", - "UPDATE_FAILED", - "UNAVAILABLE", - "PENDING" - ], - "type": "string" - }, - "ErrorCode": { - "description": "The error code associated with an error.", - "type": "string" - }, - "ErrorMessage": { - "description": "Error message describing a failed operation.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "ExecutionRoleArn": { - "description": "IAM role to be used by tasks.", - "maxLength": 1224, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "KmsKey": { - "description": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.\n\n You can specify the CMK using any of the following:\n\n Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.\n\n Key alias. For example, alias/ExampleAlias.\n\n Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.\n\n Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.\n\n AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.", - "maxLength": 1224, - "pattern": "^(((arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?key\\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?alias/.+)$", - "type": "string" - }, - "LastUpdate": { - "additionalProperties": false, - "description": "Details about the last update performed on the environment.", - "properties": { - "CreatedAt": { - "$ref": "#/definitions/UpdateCreatedAt" - }, - "Error": { - "$ref": "#/definitions/UpdateError" - }, - "Status": { - "$ref": "#/definitions/UpdateStatus" - } - }, - "type": "object" - }, - "LoggingConfiguration": { - "additionalProperties": false, - "description": "Logging configuration for the environment.", - "properties": { - "DagProcessingLogs": { - "$ref": "#/definitions/ModuleLoggingConfiguration" - }, - "SchedulerLogs": { - "$ref": "#/definitions/ModuleLoggingConfiguration" - }, - "TaskLogs": { - "$ref": "#/definitions/ModuleLoggingConfiguration" - }, - "WebserverLogs": { - "$ref": "#/definitions/ModuleLoggingConfiguration" - }, - "WorkerLogs": { - "$ref": "#/definitions/ModuleLoggingConfiguration" - } - }, - "type": "object" - }, - "LoggingConfigurationInput": { - "additionalProperties": false, - "description": "Configures logging for the environment.", - "properties": { - "DagProcessingLogs": { - "$ref": "#/definitions/ModuleLoggingConfigurationInput" - }, - "SchedulerLogs": { - "$ref": "#/definitions/ModuleLoggingConfigurationInput" - }, - "TaskLogs": { - "$ref": "#/definitions/ModuleLoggingConfigurationInput" - }, - "WebserverLogs": { - "$ref": "#/definitions/ModuleLoggingConfigurationInput" - }, - "WorkerLogs": { - "$ref": "#/definitions/ModuleLoggingConfigurationInput" - } - }, - "type": "object" - }, - "LoggingEnabled": { - "description": "", - "type": "boolean" - }, - "LoggingLevel": { - "description": "", - "enum": [ - "CRITICAL", - "ERROR", - "WARNING", - "INFO", - "DEBUG" - ], - "type": "string" - }, - "MaxWebservers": { - "description": "Maximum webserver compute units.", - "minimum": 2, - "type": "integer" - }, - "MaxWorkers": { - "description": "Maximum worker compute units.", - "minimum": 1, - "type": "integer" - }, - "MinWebservers": { - "description": "Minimum webserver compute units.", - "minimum": 2, - "type": "integer" - }, - "MinWorkers": { - "description": "Minimum worker compute units.", - "minimum": 1, - "type": "integer" - }, - "ModuleLoggingConfiguration": { - "additionalProperties": false, - "description": "Logging configuration for a specific airflow component.", - "properties": { - "CloudWatchLogGroupArn": { - "$ref": "#/definitions/CloudWatchLogGroupArn" - }, - "Enabled": { - "$ref": "#/definitions/LoggingEnabled" - }, - "LogLevel": { - "$ref": "#/definitions/LoggingLevel" - } - }, - "type": "object" - }, - "ModuleLoggingConfigurationInput": { - "additionalProperties": false, - "description": "Configures airflow component logging for the environment.", - "properties": { - "Enabled": { - "$ref": "#/definitions/LoggingEnabled" - }, - "LogLevel": { - "$ref": "#/definitions/LoggingLevel" - } - }, - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "description": "Configures the network resources of the environment.", - "properties": { - "SecurityGroupIds": { - "description": "A list of security groups to use for the environment.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SubnetIds": { - "description": "A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SubnetId" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - } - }, - "type": "object" - }, - "RelativePath": { - "description": "Represents an S3 prefix relative to the root of an S3 bucket.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "S3BucketArn": { - "description": "ARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.", - "maxLength": 1224, - "minLength": 1, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:s3:::[a-z0-9.\\-]+$", - "type": "string" - }, - "S3ObjectVersion": { - "description": "Represents an version ID for an S3 object.", - "maxLength": 1024, - "type": "string" - }, - "Schedulers": { - "description": "Scheduler compute units.", - "minimum": 1, - "type": "integer" - }, - "SecurityGroupId": { - "description": "", - "maxLength": 1024, - "minLength": 1, - "pattern": "^sg-[a-zA-Z0-9\\-._]+$", - "type": "string" - }, - "ServiceRoleArn": { - "description": "IAM role to be used by MWAA to perform AWS API calls on behalf of the customer.", - "maxLength": 1224, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "SubnetId": { - "description": "", - "maxLength": 1024, - "pattern": "^subnet-[a-zA-Z0-9\\-._]+$", - "type": "string" - }, - "UpdateCreatedAt": { - "description": "When the update request was created.", - "type": "string" - }, - "UpdateError": { - "additionalProperties": false, - "description": "The error associated with an update request.", - "properties": { - "ErrorCode": { - "$ref": "#/definitions/ErrorCode" - }, - "ErrorMessage": { - "$ref": "#/definitions/ErrorMessage" - } - }, - "type": "object" - }, - "UpdateStatus": { - "description": "", - "enum": [ - "SUCCESS", - "PENDING", - "FAILED" - ], - "type": "string" - }, - "WebserverAccessMode": { - "description": "Choice for mode of webserver access including over public internet or via private VPC endpoint.", - "enum": [ - "PRIVATE_ONLY", - "PUBLIC_ONLY" - ], - "type": "string" - }, - "WebserverUrl": { - "description": "Url endpoint for the environment's Airflow UI.", - "maxLength": 256, - "minLength": 1, - "pattern": "^https://.+$", - "type": "string" - }, - "WebserverVpcEndpointService": { - "description": "The webserver VPC endpoint service name, applicable if private webserver access mode selected.", - "maxLength": 1224, - "type": "string" - }, - "WeeklyMaintenanceWindowStart": { - "description": "Start time for the weekly maintenance window.", - "maxLength": 9, - "pattern": "(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30)", - "type": "string" - } - }, - "description": "Resource schema for AWS::MWAA::Environment", - "handlers": { - "create": { - "permissions": [ - "airflow:CreateEnvironment" - ], - "timeoutInMinutes": 180 - }, - "delete": { - "permissions": [ - "airflow:DeleteEnvironment" - ] - }, - "list": { - "permissions": [ - "airflow:ListEnvironments" - ] - }, - "read": { - "permissions": [ - "airflow:GetEnvironment" - ] - }, - "update": { - "permissions": [ - "airflow:UpdateEnvironment", - "airflow:TagResource", - "airflow:UntagResource" - ], - "timeoutInMinutes": 480 - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AirflowConfigurationOptions": { - "description": "Key/value pairs representing Airflow configuration variables.\n Keys are prefixed by their section:\n\n [core]\n dags_folder={AIRFLOW_HOME}/dags\n\n Would be represented as\n\n \"core.dags_folder\": \"{AIRFLOW_HOME}/dags\"", - "type": "object" - }, - "AirflowVersion": { - "$ref": "#/definitions/AirflowVersion" - }, - "Arn": { - "$ref": "#/definitions/EnvironmentArn" - }, - "CeleryExecutorQueue": { - "$ref": "#/definitions/CeleryExecutorQueue" - }, - "DagS3Path": { - "$ref": "#/definitions/RelativePath" - }, - "DatabaseVpcEndpointService": { - "$ref": "#/definitions/DatabaseVpcEndpointService" - }, - "EndpointManagement": { - "$ref": "#/definitions/EndpointManagement" - }, - "EnvironmentClass": { - "$ref": "#/definitions/EnvironmentClass" - }, - "ExecutionRoleArn": { - "$ref": "#/definitions/ExecutionRoleArn" - }, - "KmsKey": { - "$ref": "#/definitions/KmsKey" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/LoggingConfiguration" - }, - "MaxWebservers": { - "$ref": "#/definitions/MaxWebservers" - }, - "MaxWorkers": { - "$ref": "#/definitions/MaxWorkers" - }, - "MinWebservers": { - "$ref": "#/definitions/MinWebservers" - }, - "MinWorkers": { - "$ref": "#/definitions/MinWorkers" - }, - "Name": { - "$ref": "#/definitions/EnvironmentName" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "PluginsS3ObjectVersion": { - "$ref": "#/definitions/S3ObjectVersion" - }, - "PluginsS3Path": { - "$ref": "#/definitions/RelativePath" - }, - "RequirementsS3ObjectVersion": { - "$ref": "#/definitions/S3ObjectVersion" - }, - "RequirementsS3Path": { - "$ref": "#/definitions/RelativePath" - }, - "Schedulers": { - "$ref": "#/definitions/Schedulers" - }, - "SourceBucketArn": { - "$ref": "#/definitions/S3BucketArn" - }, - "StartupScriptS3ObjectVersion": { - "$ref": "#/definitions/S3ObjectVersion" - }, - "StartupScriptS3Path": { - "$ref": "#/definitions/RelativePath" - }, - "Tags": { - "description": "A map of tags for the environment.", - "type": "object" - }, - "WebserverAccessMode": { - "$ref": "#/definitions/WebserverAccessMode" - }, - "WebserverUrl": { - "$ref": "#/definitions/WebserverUrl" - }, - "WebserverVpcEndpointService": { - "$ref": "#/definitions/WebserverVpcEndpointService" - }, - "WeeklyMaintenanceWindowStart": { - "$ref": "#/definitions/WeeklyMaintenanceWindowStart" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CeleryExecutorQueue", - "/properties/DatabaseVpcEndpointService", - "/properties/WebserverVpcEndpointService", - "/properties/WebserverUrl", - "/properties/LoggingConfiguration/DagProcessingLogs/CloudWatchLogGroupArn", - "/properties/LoggingConfiguration/SchedulerLogs/CloudWatchLogGroupArn", - "/properties/LoggingConfiguration/WebserverLogs/CloudWatchLogGroupArn", - "/properties/LoggingConfiguration/WorkerLogs/CloudWatchLogGroupArn", - "/properties/LoggingConfiguration/TaskLogs/CloudWatchLogGroupArn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mwaa.git", - "taggable": true, - "typeName": "AWS::MWAA::Environment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/KmsKey", + "/properties/NetworkConfiguration/SubnetIds", + "/properties/EndpointManagement" + ], + "definitions": { + "AirflowArn": { + "description": "", + "maxLength": 1224, + "minLength": 1, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+", + "type": "string" + }, + "AirflowVersion": { + "description": "Version of airflow to deploy to the environment.", + "maxLength": 32, + "pattern": "^[0-9a-z.]+$", + "type": "string" + }, + "CeleryExecutorQueue": { + "description": "The celery executor queue associated with the environment.", + "maxLength": 1224, + "type": "string" + }, + "CloudWatchLogGroupArn": { + "description": "", + "maxLength": 1224, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:logs:[a-z0-9\\-]+:\\d{12}:log-group:\\w+", + "type": "string" + }, + "ConfigKey": { + "description": "", + "maxLength": 64, + "pattern": "^[a-z]+([a-z._]*[a-z]+)?$", + "type": "string" + }, + "ConfigValue": { + "description": "", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "CreatedAt": { + "description": "When the environment resource was created.", + "type": "string" + }, + "DatabaseVpcEndpointService": { + "description": "The database VPC endpoint service name.", + "maxLength": 1224, + "type": "string" + }, + "EndpointManagement": { + "description": "Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.", + "enum": [ + "CUSTOMER", + "SERVICE" + ], + "type": "string" + }, + "EnvironmentArn": { + "description": "ARN for the MWAA environment.", + "maxLength": 1224, + "minLength": 1, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+", + "type": "string" + }, + "EnvironmentClass": { + "description": "Templated configuration for airflow processes and backing infrastructure.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "EnvironmentName": { + "description": "Customer-defined identifier for the environment, unique per customer region.", + "maxLength": 80, + "minLength": 1, + "pattern": "^[a-zA-Z][0-9a-zA-Z\\-_]*$", + "type": "string" + }, + "EnvironmentStatus": { + "description": "The status of the environment.", + "enum": [ + "CREATING", + "CREATE_FAILED", + "AVAILABLE", + "UPDATING", + "DELETING", + "DELETED", + "UPDATE_FAILED", + "UNAVAILABLE", + "PENDING" + ], + "type": "string" + }, + "ErrorCode": { + "description": "The error code associated with an error.", + "type": "string" + }, + "ErrorMessage": { + "description": "Error message describing a failed operation.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "ExecutionRoleArn": { + "description": "IAM role to be used by tasks.", + "maxLength": 1224, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "KmsKey": { + "description": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.\n\n You can specify the CMK using any of the following:\n\n Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.\n\n Key alias. For example, alias/ExampleAlias.\n\n Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.\n\n Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.\n\n AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.", + "maxLength": 1224, + "pattern": "^(((arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?key\\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?alias/.+)$", + "type": "string" + }, + "LastUpdate": { + "additionalProperties": false, + "description": "Details about the last update performed on the environment.", + "properties": { + "CreatedAt": { + "$ref": "#/definitions/UpdateCreatedAt" + }, + "Error": { + "$ref": "#/definitions/UpdateError" + }, + "Status": { + "$ref": "#/definitions/UpdateStatus" + } + }, + "type": "object" + }, + "LoggingConfiguration": { + "additionalProperties": false, + "description": "Logging configuration for the environment.", + "properties": { + "DagProcessingLogs": { + "$ref": "#/definitions/ModuleLoggingConfiguration" + }, + "SchedulerLogs": { + "$ref": "#/definitions/ModuleLoggingConfiguration" + }, + "TaskLogs": { + "$ref": "#/definitions/ModuleLoggingConfiguration" + }, + "WebserverLogs": { + "$ref": "#/definitions/ModuleLoggingConfiguration" + }, + "WorkerLogs": { + "$ref": "#/definitions/ModuleLoggingConfiguration" + } + }, + "type": "object" + }, + "LoggingConfigurationInput": { + "additionalProperties": false, + "description": "Configures logging for the environment.", + "properties": { + "DagProcessingLogs": { + "$ref": "#/definitions/ModuleLoggingConfigurationInput" + }, + "SchedulerLogs": { + "$ref": "#/definitions/ModuleLoggingConfigurationInput" + }, + "TaskLogs": { + "$ref": "#/definitions/ModuleLoggingConfigurationInput" + }, + "WebserverLogs": { + "$ref": "#/definitions/ModuleLoggingConfigurationInput" + }, + "WorkerLogs": { + "$ref": "#/definitions/ModuleLoggingConfigurationInput" + } + }, + "type": "object" + }, + "LoggingEnabled": { + "description": "", + "type": "boolean" + }, + "LoggingLevel": { + "description": "", + "enum": [ + "CRITICAL", + "ERROR", + "WARNING", + "INFO", + "DEBUG" + ], + "type": "string" + }, + "MaxWebservers": { + "description": "Maximum webserver compute units.", + "minimum": 2, + "type": "integer" + }, + "MaxWorkers": { + "description": "Maximum worker compute units.", + "minimum": 1, + "type": "integer" + }, + "MinWebservers": { + "description": "Minimum webserver compute units.", + "minimum": 2, + "type": "integer" + }, + "MinWorkers": { + "description": "Minimum worker compute units.", + "minimum": 1, + "type": "integer" + }, + "ModuleLoggingConfiguration": { + "additionalProperties": false, + "description": "Logging configuration for a specific airflow component.", + "properties": { + "CloudWatchLogGroupArn": { + "$ref": "#/definitions/CloudWatchLogGroupArn" + }, + "Enabled": { + "$ref": "#/definitions/LoggingEnabled" + }, + "LogLevel": { + "$ref": "#/definitions/LoggingLevel" + } + }, + "type": "object" + }, + "ModuleLoggingConfigurationInput": { + "additionalProperties": false, + "description": "Configures airflow component logging for the environment.", + "properties": { + "Enabled": { + "$ref": "#/definitions/LoggingEnabled" + }, + "LogLevel": { + "$ref": "#/definitions/LoggingLevel" + } + }, + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "description": "Configures the network resources of the environment.", + "properties": { + "SecurityGroupIds": { + "description": "A list of security groups to use for the environment.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "description": "A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SubnetId" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + } + }, + "type": "object" + }, + "RelativePath": { + "description": "Represents an S3 prefix relative to the root of an S3 bucket.", + "maxLength": 1024, + "pattern": ".*", + "type": "string" + }, + "S3BucketArn": { + "description": "ARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.", + "maxLength": 1224, + "minLength": 1, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:s3:::[a-z0-9.\\-]+$", + "type": "string" + }, + "S3ObjectVersion": { + "description": "Represents an version ID for an S3 object.", + "maxLength": 1024, + "type": "string" + }, + "Schedulers": { + "description": "Scheduler compute units.", + "minimum": 1, + "type": "integer" + }, + "SecurityGroupId": { + "description": "", + "maxLength": 1024, + "minLength": 1, + "pattern": "^sg-[a-zA-Z0-9\\-._]+$", + "type": "string" + }, + "ServiceRoleArn": { + "description": "IAM role to be used by MWAA to perform AWS API calls on behalf of the customer.", + "maxLength": 1224, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b)(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "SubnetId": { + "description": "", + "maxLength": 1024, + "pattern": "^subnet-[a-zA-Z0-9\\-._]+$", + "type": "string" + }, + "UpdateCreatedAt": { + "description": "When the update request was created.", + "type": "string" + }, + "UpdateError": { + "additionalProperties": false, + "description": "The error associated with an update request.", + "properties": { + "ErrorCode": { + "$ref": "#/definitions/ErrorCode" + }, + "ErrorMessage": { + "$ref": "#/definitions/ErrorMessage" + } + }, + "type": "object" + }, + "UpdateStatus": { + "description": "", + "enum": [ + "SUCCESS", + "PENDING", + "FAILED" + ], + "type": "string" + }, + "WebserverAccessMode": { + "description": "Choice for mode of webserver access including over public internet or via private VPC endpoint.", + "enum": [ + "PRIVATE_ONLY", + "PUBLIC_ONLY" + ], + "type": "string" + }, + "WebserverUrl": { + "description": "Url endpoint for the environment's Airflow UI.", + "maxLength": 256, + "minLength": 1, + "pattern": "^https://.+$", + "type": "string" + }, + "WebserverVpcEndpointService": { + "description": "The webserver VPC endpoint service name, applicable if private webserver access mode selected.", + "maxLength": 1224, + "type": "string" + }, + "WeeklyMaintenanceWindowStart": { + "description": "Start time for the weekly maintenance window.", + "maxLength": 9, + "pattern": "(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30)", + "type": "string" + } + }, + "description": "Resource schema for AWS::MWAA::Environment", + "handlers": { + "create": { + "permissions": [ + "airflow:CreateEnvironment" + ], + "timeoutInMinutes": 180 + }, + "delete": { + "permissions": [ + "airflow:DeleteEnvironment" + ] + }, + "list": { + "permissions": [ + "airflow:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "airflow:GetEnvironment" + ] + }, + "update": { + "permissions": [ + "airflow:UpdateEnvironment", + "airflow:TagResource", + "airflow:UntagResource" + ], + "timeoutInMinutes": 480 + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AirflowConfigurationOptions": { + "description": "Key/value pairs representing Airflow configuration variables.\n Keys are prefixed by their section:\n\n [core]\n dags_folder={AIRFLOW_HOME}/dags\n\n Would be represented as\n\n \"core.dags_folder\": \"{AIRFLOW_HOME}/dags\"", + "type": "object" + }, + "AirflowVersion": { + "$ref": "#/definitions/AirflowVersion" + }, + "Arn": { + "$ref": "#/definitions/EnvironmentArn" + }, + "CeleryExecutorQueue": { + "$ref": "#/definitions/CeleryExecutorQueue" + }, + "DagS3Path": { + "$ref": "#/definitions/RelativePath" + }, + "DatabaseVpcEndpointService": { + "$ref": "#/definitions/DatabaseVpcEndpointService" + }, + "EndpointManagement": { + "$ref": "#/definitions/EndpointManagement" + }, + "EnvironmentClass": { + "$ref": "#/definitions/EnvironmentClass" + }, + "ExecutionRoleArn": { + "$ref": "#/definitions/ExecutionRoleArn" + }, + "KmsKey": { + "$ref": "#/definitions/KmsKey" + }, + "LoggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration" + }, + "MaxWebservers": { + "$ref": "#/definitions/MaxWebservers" + }, + "MaxWorkers": { + "$ref": "#/definitions/MaxWorkers" + }, + "MinWebservers": { + "$ref": "#/definitions/MinWebservers" + }, + "MinWorkers": { + "$ref": "#/definitions/MinWorkers" + }, + "Name": { + "$ref": "#/definitions/EnvironmentName" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "PluginsS3ObjectVersion": { + "$ref": "#/definitions/S3ObjectVersion" + }, + "PluginsS3Path": { + "$ref": "#/definitions/RelativePath" + }, + "RequirementsS3ObjectVersion": { + "$ref": "#/definitions/S3ObjectVersion" + }, + "RequirementsS3Path": { + "$ref": "#/definitions/RelativePath" + }, + "Schedulers": { + "$ref": "#/definitions/Schedulers" + }, + "SourceBucketArn": { + "$ref": "#/definitions/S3BucketArn" + }, + "StartupScriptS3ObjectVersion": { + "$ref": "#/definitions/S3ObjectVersion" + }, + "StartupScriptS3Path": { + "$ref": "#/definitions/RelativePath" + }, + "Tags": { + "description": "A map of tags for the environment.", + "type": "object" + }, + "WebserverAccessMode": { + "$ref": "#/definitions/WebserverAccessMode" + }, + "WebserverUrl": { + "$ref": "#/definitions/WebserverUrl" + }, + "WebserverVpcEndpointService": { + "$ref": "#/definitions/WebserverVpcEndpointService" + }, + "WeeklyMaintenanceWindowStart": { + "$ref": "#/definitions/WeeklyMaintenanceWindowStart" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CeleryExecutorQueue", + "/properties/DatabaseVpcEndpointService", + "/properties/WebserverVpcEndpointService", + "/properties/WebserverUrl", + "/properties/LoggingConfiguration/DagProcessingLogs/CloudWatchLogGroupArn", + "/properties/LoggingConfiguration/SchedulerLogs/CloudWatchLogGroupArn", + "/properties/LoggingConfiguration/WebserverLogs/CloudWatchLogGroupArn", + "/properties/LoggingConfiguration/WorkerLogs/CloudWatchLogGroupArn", + "/properties/LoggingConfiguration/TaskLogs/CloudWatchLogGroupArn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mwaa.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "airflow:UntagResource", + "airflow:TagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::MWAA::Environment" +} diff --git a/schema/aws-neptune-dbcluster.json b/schema/aws-neptune-dbcluster.json index 3acd927..ec48d56 100644 --- a/schema/aws-neptune-dbcluster.json +++ b/schema/aws-neptune-dbcluster.json @@ -1,337 +1,337 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AvailabilityZones", - "/properties/DBClusterIdentifier", - "/properties/DBSubnetGroupName", - "/properties/KmsKeyId", - "/properties/RestoreToTime", - "/properties/RestoreType", - "/properties/SnapshotIdentifier", - "/properties/SourceDBClusterIdentifier", - "/properties/StorageEncrypted", - "/properties/UseLatestRestorableTime" - ], - "definitions": { - "DBClusterRole": { - "additionalProperties": false, - "description": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", - "properties": { - "FeatureName": { - "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "ServerlessScalingConfiguration": { - "additionalProperties": false, - "description": "Contains the scaling configuration of an Neptune Serverless DB cluster.", - "properties": { - "MaxCapacity": { - "description": "The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.", - "maximum": 128, - "minimum": 2.5, - "type": "number" - }, - "MinCapacity": { - "description": "The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.", - "maximum": 128, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "MinCapacity", - "MaxCapacity" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "rds:AddRoleToDBCluster", - "rds:AddTagsToResource", - "rds:CreateDBCluster", - "rds:CreateDBInstance", - "rds:DescribeDBClusters", - "rds:ListTagsForResource", - "rds:ModifyDBCluster", - "rds:RestoreDBClusterFromSnapshot", - "rds:RestoreDBClusterToPointInTime", - "kms:CreateGrant", - "kms:DescribeKey" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "rds:DeleteDBCluster", - "rds:DeleteDBInstance", - "rds:DescribeDBClusters", - "rds:DescribeGlobalClusters", - "rds:ListTagsForResource", - "rds:RemoveFromGlobalCluster", - "rds:CreateDBClusterSnapshot", - "kms:CreateGrant", - "kms:DescribeKey" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "rds:DescribeDBClusters", - "rds:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey" - ], - "timeoutInMinutes": 2160 - }, - "read": { - "permissions": [ - "rds:DescribeDBClusters", - "rds:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey" - ], - "timeoutInMinutes": 2160 - }, - "update": { - "permissions": [ - "ec2:DescribeSecurityGroups", - "iam:PassRole", - "rds:AddRoleToDBCluster", - "rds:AddTagsToResource", - "rds:DescribeDBClusters", - "rds:DescribeDBInstances", - "rds:DescribeDBSubnetGroups", - "rds:DescribeGlobalClusters", - "rds:ListTagsForResource", - "rds:ModifyDBCluster", - "rds:ModifyDBInstance", - "rds:RemoveFromGlobalCluster", - "rds:RemoveRoleFromDBCluster", - "rds:RemoveTagsFromResource", - "kms:CreateGrant", - "kms:DescribeKey" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DBClusterIdentifier" - ], - "properties": { - "AssociatedRoles": { - "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DBClusterRole" - }, - "type": "array", - "uniqueItems": true - }, - "AvailabilityZones": { - "description": "Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "BackupRetentionPeriod": { - "default": 1, - "description": "Specifies the number of days for which automatic DB snapshots are retained.", - "minimum": 1, - "type": "integer" - }, - "ClusterResourceId": { - "description": "The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.", - "type": "string" - }, - "CopyTagsToSnapshot": { - "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.", - "type": "boolean" - }, - "DBClusterIdentifier": { - "description": "The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "DBClusterParameterGroupName": { - "description": "Provides the name of the DB cluster parameter group.", - "type": "string" - }, - "DBInstanceParameterGroupName": { - "description": "The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.", - "type": "string" - }, - "DBPort": { - "description": "The port number on which the DB instances in the DB cluster accept connections. \n\nIf not specified, the default port used is `8182`. \n\nNote: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.", - "type": "integer" - }, - "DBSubnetGroupName": { - "description": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.", - "type": "string" - }, - "DeletionProtection": { - "description": "Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.", - "type": "boolean" - }, - "EnableCloudwatchLogsExports": { - "description": "Specifies a list of log types that are enabled for export to CloudWatch Logs.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Endpoint": { - "description": "The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`", - "type": "string" - }, - "EngineVersion": { - "description": "Indicates the database engine version.", - "type": "string" - }, - "IamAuthEnabled": { - "description": "True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.", - "type": "boolean" - }, - "KmsKeyId": { - "description": "If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.", - "type": "string" - }, - "Port": { - "description": "The port number on which the DB cluster accepts connections. For example: `8182`.", - "type": "string" - }, - "PreferredBackupWindow": { - "description": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "description": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).", - "type": "string" - }, - "ReadEndpoint": { - "description": "The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`", - "type": "string" - }, - "RestoreToTime": { - "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", - "type": "string" - }, - "RestoreType": { - "default": "full-copy", - "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", - "type": "string" - }, - "ServerlessScalingConfiguration": { - "$ref": "#/definitions/ServerlessScalingConfiguration", - "description": "Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster." - }, - "SnapshotIdentifier": { - "description": "Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.\n\nAfter you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.\n\nHowever, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.", - "type": "string" - }, - "SourceDBClusterIdentifier": { - "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", - "type": "string" - }, - "StorageEncrypted": { - "description": "Indicates whether the DB cluster is encrypted.\n\nIf you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.\n\nIf you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.", - "type": "boolean" - }, - "Tags": { - "description": "The tags assigned to this cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UseLatestRestorableTime": { - "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "description": "Provides a list of VPC security groups that the DB cluster belongs to.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", - "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)", - "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", - "/properties/SnapshotIdentifier": "$lowercase(SnapshotIdentifier)", - "/properties/SourceDBClusterIdentifier": "$lowercase(SourceDBClusterIdentifier)" - }, - "readOnlyProperties": [ - "/properties/Endpoint", - "/properties/ClusterResourceId", - "/properties/Port", - "/properties/ReadEndpoint" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptune", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Neptune::DBCluster", - "writeOnlyProperties": [ - "/properties/DBInstanceParameterGroupName", - "/properties/RestoreToTime", - "/properties/RestoreType", - "/properties/SnapshotIdentifier", - "/properties/SourceDBClusterIdentifier", - "/properties/UseLatestRestorableTime" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AvailabilityZones", + "/properties/DBClusterIdentifier", + "/properties/DBSubnetGroupName", + "/properties/KmsKeyId", + "/properties/RestoreToTime", + "/properties/RestoreType", + "/properties/SnapshotIdentifier", + "/properties/SourceDBClusterIdentifier", + "/properties/StorageEncrypted", + "/properties/UseLatestRestorableTime" + ], + "definitions": { + "DBClusterRole": { + "additionalProperties": false, + "description": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", + "properties": { + "FeatureName": { + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "ServerlessScalingConfiguration": { + "additionalProperties": false, + "description": "Contains the scaling configuration of an Neptune Serverless DB cluster.", + "properties": { + "MaxCapacity": { + "description": "The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.", + "maximum": 128, + "minimum": 2.5, + "type": "number" + }, + "MinCapacity": { + "description": "The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.", + "maximum": 128, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "MinCapacity", + "MaxCapacity" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "rds:AddRoleToDBCluster", + "rds:AddTagsToResource", + "rds:CreateDBCluster", + "rds:CreateDBInstance", + "rds:DescribeDBClusters", + "rds:ListTagsForResource", + "rds:ModifyDBCluster", + "rds:RestoreDBClusterFromSnapshot", + "rds:RestoreDBClusterToPointInTime", + "kms:CreateGrant", + "kms:DescribeKey" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "rds:DeleteDBCluster", + "rds:DeleteDBInstance", + "rds:DescribeDBClusters", + "rds:DescribeGlobalClusters", + "rds:ListTagsForResource", + "rds:RemoveFromGlobalCluster", + "rds:CreateDBClusterSnapshot", + "kms:CreateGrant", + "kms:DescribeKey" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "rds:DescribeDBClusters", + "rds:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey" + ], + "timeoutInMinutes": 2160 + }, + "read": { + "permissions": [ + "rds:DescribeDBClusters", + "rds:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "iam:PassRole", + "rds:AddRoleToDBCluster", + "rds:AddTagsToResource", + "rds:DescribeDBClusters", + "rds:DescribeDBInstances", + "rds:DescribeDBSubnetGroups", + "rds:DescribeGlobalClusters", + "rds:ListTagsForResource", + "rds:ModifyDBCluster", + "rds:ModifyDBInstance", + "rds:RemoveFromGlobalCluster", + "rds:RemoveRoleFromDBCluster", + "rds:RemoveTagsFromResource", + "kms:CreateGrant", + "kms:DescribeKey" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DBClusterIdentifier" + ], + "properties": { + "AssociatedRoles": { + "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DBClusterRole" + }, + "type": "array", + "uniqueItems": true + }, + "AvailabilityZones": { + "description": "Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "BackupRetentionPeriod": { + "default": 1, + "description": "Specifies the number of days for which automatic DB snapshots are retained.", + "minimum": 1, + "type": "integer" + }, + "ClusterResourceId": { + "description": "The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.", + "type": "string" + }, + "CopyTagsToSnapshot": { + "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.", + "type": "boolean" + }, + "DBClusterIdentifier": { + "description": "The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "DBClusterParameterGroupName": { + "description": "Provides the name of the DB cluster parameter group.", + "type": "string" + }, + "DBInstanceParameterGroupName": { + "description": "The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.", + "type": "string" + }, + "DBPort": { + "description": "The port number on which the DB instances in the DB cluster accept connections. \n\nIf not specified, the default port used is `8182`. \n\nNote: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.", + "type": "integer" + }, + "DBSubnetGroupName": { + "description": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.", + "type": "string" + }, + "DeletionProtection": { + "description": "Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.", + "type": "boolean" + }, + "EnableCloudwatchLogsExports": { + "description": "Specifies a list of log types that are enabled for export to CloudWatch Logs.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Endpoint": { + "description": "The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`", + "type": "string" + }, + "EngineVersion": { + "description": "Indicates the database engine version.", + "type": "string" + }, + "IamAuthEnabled": { + "description": "True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.", + "type": "boolean" + }, + "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.", + "type": "string" + }, + "Port": { + "description": "The port number on which the DB cluster accepts connections. For example: `8182`.", + "type": "string" + }, + "PreferredBackupWindow": { + "description": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "description": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).", + "type": "string" + }, + "ReadEndpoint": { + "description": "The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`", + "type": "string" + }, + "RestoreToTime": { + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", + "type": "string" + }, + "RestoreType": { + "default": "full-copy", + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", + "type": "string" + }, + "ServerlessScalingConfiguration": { + "$ref": "#/definitions/ServerlessScalingConfiguration", + "description": "Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster." + }, + "SnapshotIdentifier": { + "description": "Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.\n\nAfter you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.\n\nHowever, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.", + "type": "string" + }, + "SourceDBClusterIdentifier": { + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", + "type": "string" + }, + "StorageEncrypted": { + "description": "Indicates whether the DB cluster is encrypted.\n\nIf you specify the KmsKeyId property, then you must enable encryption and set this property to true.\n\nIf you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster.\n\nIf you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used.\n\nIf you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.", + "type": "boolean" + }, + "Tags": { + "description": "The tags assigned to this cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UseLatestRestorableTime": { + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.", + "type": "boolean" + }, + "VpcSecurityGroupIds": { + "description": "Provides a list of VPC security groups that the DB cluster belongs to.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", + "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)", + "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", + "/properties/SnapshotIdentifier": "$lowercase(SnapshotIdentifier)", + "/properties/SourceDBClusterIdentifier": "$lowercase(SourceDBClusterIdentifier)" + }, + "readOnlyProperties": [ + "/properties/Endpoint", + "/properties/ClusterResourceId", + "/properties/Port", + "/properties/ReadEndpoint" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptune", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Neptune::DBCluster", + "writeOnlyProperties": [ + "/properties/DBInstanceParameterGroupName", + "/properties/RestoreToTime", + "/properties/RestoreType", + "/properties/SnapshotIdentifier", + "/properties/SourceDBClusterIdentifier", + "/properties/UseLatestRestorableTime" + ] +} diff --git a/schema/aws-neptune-dbclusterparametergroup.json b/schema/aws-neptune-dbclusterparametergroup.json index 93eb530..fda633a 100644 --- a/schema/aws-neptune-dbclusterparametergroup.json +++ b/schema/aws-neptune-dbclusterparametergroup.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Family", - "/properties/Description", - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Neptune::DBClusterParameterGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Family", - "Description", - "Parameters" - ], - "typeName": "AWS::Neptune::DBClusterParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Family", + "/properties/Description", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Neptune::DBClusterParameterGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Family": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Family", + "Description", + "Parameters" + ], + "typeName": "AWS::Neptune::DBClusterParameterGroup" +} diff --git a/schema/aws-neptune-dbinstance.json b/schema/aws-neptune-dbinstance.json index b064fb2..e7b626d 100644 --- a/schema/aws-neptune-dbinstance.json +++ b/schema/aws-neptune-dbinstance.json @@ -1,89 +1,89 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBClusterIdentifier", - "/properties/AvailabilityZone", - "/properties/DBInstanceIdentifier", - "/properties/DBSubnetGroupName", - "/properties/DBSnapshotIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Neptune::DBInstance", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllowMajorVersionUpgrade": { - "type": "boolean" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBInstanceClass": { - "type": "string" - }, - "DBInstanceIdentifier": { - "type": "string" - }, - "DBParameterGroupName": { - "type": "string" - }, - "DBSnapshotIdentifier": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Port": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Endpoint", - "/properties/Port", - "/properties/Id" - ], - "required": [ - "DBInstanceClass" - ], - "typeName": "AWS::Neptune::DBInstance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBClusterIdentifier", + "/properties/AvailabilityZone", + "/properties/DBInstanceIdentifier", + "/properties/DBSubnetGroupName", + "/properties/DBSnapshotIdentifier" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Neptune::DBInstance", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "AvailabilityZone": { + "type": "string" + }, + "DBClusterIdentifier": { + "type": "string" + }, + "DBInstanceClass": { + "type": "string" + }, + "DBInstanceIdentifier": { + "type": "string" + }, + "DBParameterGroupName": { + "type": "string" + }, + "DBSnapshotIdentifier": { + "type": "string" + }, + "DBSubnetGroupName": { + "type": "string" + }, + "Endpoint": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Port": { + "type": "string" + }, + "PreferredMaintenanceWindow": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Endpoint", + "/properties/Port", + "/properties/Id" + ], + "required": [ + "DBInstanceClass" + ], + "typeName": "AWS::Neptune::DBInstance" +} diff --git a/schema/aws-neptune-dbparametergroup.json b/schema/aws-neptune-dbparametergroup.json index 11f30ea..c8f61c1 100644 --- a/schema/aws-neptune-dbparametergroup.json +++ b/schema/aws-neptune-dbparametergroup.json @@ -1,63 +1,63 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Family", - "/properties/Description", - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Neptune::DBParameterGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Family", - "Description", - "Parameters" - ], - "typeName": "AWS::Neptune::DBParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Family", + "/properties/Description", + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Neptune::DBParameterGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Family": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Family", + "Description", + "Parameters" + ], + "typeName": "AWS::Neptune::DBParameterGroup" +} diff --git a/schema/aws-neptune-dbsubnetgroup.json b/schema/aws-neptune-dbsubnetgroup.json index 3f81a2a..7645e5c 100644 --- a/schema/aws-neptune-dbsubnetgroup.json +++ b/schema/aws-neptune-dbsubnetgroup.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBSubnetGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Neptune::DBSubnetGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DBSubnetGroupDescription": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "typeName": "AWS::Neptune::DBSubnetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBSubnetGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Neptune::DBSubnetGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DBSubnetGroupDescription": { + "type": "string" + }, + "DBSubnetGroupName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DBSubnetGroupDescription", + "SubnetIds" + ], + "typeName": "AWS::Neptune::DBSubnetGroup" +} diff --git a/schema/aws-neptune-eventsubscription.json b/schema/aws-neptune-eventsubscription.json index 05e0962..95e4c9a 100644 --- a/schema/aws-neptune-eventsubscription.json +++ b/schema/aws-neptune-eventsubscription.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SnsTopicArn" - ], - "description": "Resource Type definition for AWS::Neptune::EventSubscription", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Enabled": { - "type": "boolean" - }, - "EventCategories": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "SnsTopicArn": { - "type": "string" - }, - "SourceIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Neptune::EventSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SnsTopicArn" + ], + "description": "Resource Type definition for AWS::Neptune::EventSubscription", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "EventCategories": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "SnsTopicArn": { + "type": "string" + }, + "SourceIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Neptune::EventSubscription" +} diff --git a/schema/aws-neptunegraph-graph.json b/schema/aws-neptunegraph-graph.json index 019cb92..3838764 100644 --- a/schema/aws-neptunegraph-graph.json +++ b/schema/aws-neptunegraph-graph.json @@ -1,190 +1,190 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/GraphName" - ] - ], - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/ProvisionedMemory" - ], - "createOnlyProperties": [ - "/properties/GraphName", - "/properties/ReplicaCount", - "/properties/VectorSearchConfiguration" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "VectorSearchConfiguration": { - "additionalProperties": false, - "description": "The vector search configuration.", - "properties": { - "VectorSearchDimension": { - "description": "The vector search dimension", - "type": "integer" - } - }, - "required": [ - "VectorSearchDimension" - ], - "type": "object" - } - }, - "description": "The AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "neptune-graph:CreateGraph", - "neptune-graph:GetGraph", - "neptune-graph:ListTagsForResource", - "neptune-graph:TagResource", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:Decrypt", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "neptune-graph:DeleteGraph", - "neptune-graph:GetGraph", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:Decrypt" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "neptune-graph:GetGraph", - "neptune-graph:ListGraphs", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:Decrypt" - ], - "timeoutInMinutes": 2160 - }, - "read": { - "permissions": [ - "neptune-graph:GetGraph", - "neptune-graph:ListTagsForResource", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:Decrypt" - ], - "timeoutInMinutes": 2160 - }, - "update": { - "permissions": [ - "iam:PassRole", - "neptune-graph:GetGraph", - "neptune-graph:ListTagsForResource", - "neptune-graph:TagResource", - "neptune-graph:UntagResource", - "neptune-graph:UpdateGraph", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:Decrypt" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/GraphId" - ], - "properties": { - "DeletionProtection": { - "description": "Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.\n\n_Default_: If not specified, the default value is true.", - "type": "boolean" - }, - "Endpoint": { - "description": "The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`", - "type": "string" - }, - "GraphArn": { - "description": "Graph resource ARN", - "type": "string" - }, - "GraphId": { - "description": "The auto-generated id assigned by the service.", - "type": "string" - }, - "GraphName": { - "description": "Contains a user-supplied name for the Graph. \n\nIf you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.\n\n_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$", - "type": "string" - }, - "ProvisionedMemory": { - "description": "Memory for the Graph.", - "type": "integer" - }, - "PublicConnectivity": { - "description": "Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.\n\nWhen the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.\n\nWhen the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.\n\n_Default_: If not specified, the default value is false.", - "type": "boolean" - }, - "ReplicaCount": { - "description": "Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.\n\nReplica Count should always be less than or equal to 2.\n\n_Default_: If not specified, the default value is 1.", - "type": "integer" - }, - "Tags": { - "description": "The tags associated with this graph.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "VectorSearchConfiguration": { - "$ref": "#/definitions/VectorSearchConfiguration", - "description": "Vector Search Configuration" - } - }, - "propertyTransform": { - "/properties/GraphId": "$lowercase(GraphId)", - "/properties/GraphName": "$lowercase(GraphName)" - }, - "readOnlyProperties": [ - "/properties/GraphArn", - "/properties/GraphId", - "/properties/Endpoint" - ], - "required": [ - "ProvisionedMemory" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptunegraph", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NeptuneGraph::Graph" -} +{ + "additionalIdentifiers": [ + [ + "/properties/GraphName" + ] + ], + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/ProvisionedMemory" + ], + "createOnlyProperties": [ + "/properties/GraphName", + "/properties/ReplicaCount", + "/properties/VectorSearchConfiguration" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "VectorSearchConfiguration": { + "additionalProperties": false, + "description": "The vector search configuration.", + "properties": { + "VectorSearchDimension": { + "description": "The vector search dimension", + "type": "integer" + } + }, + "required": [ + "VectorSearchDimension" + ], + "type": "object" + } + }, + "description": "The AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "neptune-graph:CreateGraph", + "neptune-graph:GetGraph", + "neptune-graph:ListTagsForResource", + "neptune-graph:TagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:Decrypt", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "neptune-graph:DeleteGraph", + "neptune-graph:GetGraph", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:Decrypt" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "neptune-graph:GetGraph", + "neptune-graph:ListGraphs", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:Decrypt" + ], + "timeoutInMinutes": 2160 + }, + "read": { + "permissions": [ + "neptune-graph:GetGraph", + "neptune-graph:ListTagsForResource", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:Decrypt" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "iam:PassRole", + "neptune-graph:GetGraph", + "neptune-graph:ListTagsForResource", + "neptune-graph:TagResource", + "neptune-graph:UntagResource", + "neptune-graph:UpdateGraph", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:Decrypt" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/GraphId" + ], + "properties": { + "DeletionProtection": { + "description": "Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.\n\n_Default_: If not specified, the default value is true.", + "type": "boolean" + }, + "Endpoint": { + "description": "The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`", + "type": "string" + }, + "GraphArn": { + "description": "Graph resource ARN", + "type": "string" + }, + "GraphId": { + "description": "The auto-generated id assigned by the service.", + "type": "string" + }, + "GraphName": { + "description": "Contains a user-supplied name for the Graph. \n\nIf you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.\n\n_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$", + "type": "string" + }, + "ProvisionedMemory": { + "description": "Memory for the Graph.", + "type": "integer" + }, + "PublicConnectivity": { + "description": "Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.\n\nWhen the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.\n\nWhen the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.\n\n_Default_: If not specified, the default value is false.", + "type": "boolean" + }, + "ReplicaCount": { + "description": "Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.\n\nReplica Count should always be less than or equal to 2.\n\n_Default_: If not specified, the default value is 1.", + "type": "integer" + }, + "Tags": { + "description": "The tags associated with this graph.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VectorSearchConfiguration": { + "$ref": "#/definitions/VectorSearchConfiguration", + "description": "Vector Search Configuration" + } + }, + "propertyTransform": { + "/properties/GraphId": "$lowercase(GraphId)", + "/properties/GraphName": "$lowercase(GraphName)" + }, + "readOnlyProperties": [ + "/properties/GraphArn", + "/properties/GraphId", + "/properties/Endpoint" + ], + "required": [ + "ProvisionedMemory" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptunegraph", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NeptuneGraph::Graph" +} diff --git a/schema/aws-neptunegraph-privategraphendpoint.json b/schema/aws-neptunegraph-privategraphendpoint.json index ab50fd9..21b288b 100644 --- a/schema/aws-neptunegraph-privategraphendpoint.json +++ b/schema/aws-neptunegraph-privategraphendpoint.json @@ -1,132 +1,132 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/GraphIdentifier", - "/properties/VpcId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GraphIdentifier", - "/properties/SecurityGroupIds", - "/properties/SubnetIds", - "/properties/VpcId" - ], - "description": "The AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:DescribeVpcAttribute", - "ec2:DescribeAvailabilityZones", - "ec2:ModifyVpcEndpoint", - "route53:AssociateVPCWithHostedZone", - "iam:PassRole", - "neptune-graph:CreatePrivateGraphEndpoint", - "neptune-graph:GetPrivateGraphEndpoint", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpoints", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:DescribeVpcAttribute", - "ec2:DescribeAvailabilityZones", - "ec2:ModifyVpcEndpoint", - "route53:DisassociateVPCFromHostedZone", - "neptune-graph:DeletePrivateGraphEndpoint", - "neptune-graph:GetPrivateGraphEndpoint" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "neptune-graph:GetPrivateGraphEndpoint", - "neptune-graph:ListPrivateGraphEndpoints" - ], - "timeoutInMinutes": 2160 - }, - "read": { - "permissions": [ - "neptune-graph:GetPrivateGraphEndpoint" - ], - "timeoutInMinutes": 2160 - }, - "update": { - "permissions": [ - "iam:PassRole", - "neptune-graph:GetPrivateGraphEndpoint" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/PrivateGraphEndpointIdentifier" - ], - "properties": { - "GraphIdentifier": { - "description": "The auto-generated Graph Id assigned by the service.", - "type": "string" - }, - "PrivateGraphEndpointIdentifier": { - "description": "PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.\n\n For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`", - "type": "string" - }, - "SecurityGroupIds": { - "description": "The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "description": "The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcEndpointId": { - "description": "VPC endpoint that provides a private connection between the Graph and specified VPC.", - "type": "string" - }, - "VpcId": { - "description": "The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/GraphIdentifier": "$lowercase(GraphIdentifier)" - }, - "readOnlyProperties": [ - "/properties/PrivateGraphEndpointIdentifier", - "/properties/VpcEndpointId" - ], - "required": [ - "GraphIdentifier", - "VpcId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptunegraph", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::NeptuneGraph::PrivateGraphEndpoint", - "writeOnlyProperties": [ - "/properties/GraphIdentifier", - "/properties/SecurityGroupIds" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/GraphIdentifier", + "/properties/VpcId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GraphIdentifier", + "/properties/SecurityGroupIds", + "/properties/SubnetIds", + "/properties/VpcId" + ], + "description": "The AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeVpcAttribute", + "ec2:DescribeAvailabilityZones", + "ec2:ModifyVpcEndpoint", + "route53:AssociateVPCWithHostedZone", + "iam:PassRole", + "neptune-graph:CreatePrivateGraphEndpoint", + "neptune-graph:GetPrivateGraphEndpoint", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeVpcAttribute", + "ec2:DescribeAvailabilityZones", + "ec2:ModifyVpcEndpoint", + "route53:DisassociateVPCFromHostedZone", + "neptune-graph:DeletePrivateGraphEndpoint", + "neptune-graph:GetPrivateGraphEndpoint" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "neptune-graph:GetPrivateGraphEndpoint", + "neptune-graph:ListPrivateGraphEndpoints" + ], + "timeoutInMinutes": 2160 + }, + "read": { + "permissions": [ + "neptune-graph:GetPrivateGraphEndpoint" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "iam:PassRole", + "neptune-graph:GetPrivateGraphEndpoint" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/PrivateGraphEndpointIdentifier" + ], + "properties": { + "GraphIdentifier": { + "description": "The auto-generated Graph Id assigned by the service.", + "type": "string" + }, + "PrivateGraphEndpointIdentifier": { + "description": "PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.\n\n For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`", + "type": "string" + }, + "SecurityGroupIds": { + "description": "The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetIds": { + "description": "The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "VpcEndpointId": { + "description": "VPC endpoint that provides a private connection between the Graph and specified VPC.", + "type": "string" + }, + "VpcId": { + "description": "The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/GraphIdentifier": "$lowercase(GraphIdentifier)" + }, + "readOnlyProperties": [ + "/properties/PrivateGraphEndpointIdentifier", + "/properties/VpcEndpointId" + ], + "required": [ + "GraphIdentifier", + "VpcId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-neptunegraph", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::NeptuneGraph::PrivateGraphEndpoint", + "writeOnlyProperties": [ + "/properties/GraphIdentifier", + "/properties/SecurityGroupIds" + ] +} diff --git a/schema/aws-networkfirewall-firewall.json b/schema/aws-networkfirewall-firewall.json index 006109d..b9f7ae7 100644 --- a/schema/aws-networkfirewall-firewall.json +++ b/schema/aws-networkfirewall-firewall.json @@ -1,197 +1,206 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/VpcId", - "/properties/FirewallName" - ], - "definitions": { - "EndpointId": { - "description": "An endpoint Id.", - "type": "string" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws.*$", - "type": "string" - }, - "SubnetMapping": { - "additionalProperties": false, - "properties": { - "IPAddressType": { - "description": "A IPAddressType", - "type": "string" - }, - "SubnetId": { - "description": "A SubnetId.", - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::NetworkFirewall::Firewall", - "handlers": { - "create": { - "permissions": [ - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "network-firewall:CreateFirewall", - "network-firewall:DescribeFirewallPolicy", - "network-firewall:DescribeRuleGroup", - "network-firewall:TagResource", - "network-firewall:AssociateSubnets", - "network-firewall:AssociateFirewallPolicy", - "network-firewall:DescribeFirewall" - ] - }, - "delete": { - "permissions": [ - "ec2:DeleteVpcEndpoints", - "ec2:DescribeRouteTables", - "logs:DescribeLogGroups", - "logs:DescribeResourcePolicies", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "network-firewall:DeleteFirewall", - "network-firewall:UntagResource", - "network-firewall:DescribeFirewall" - ] - }, - "list": { - "permissions": [ - "network-firewall:ListFirewalls" - ] - }, - "read": { - "permissions": [ - "network-firewall:DescribeFirewall", - "network-firewall:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "network-firewall:AssociateSubnets", - "network-firewall:DisassociateSubnets", - "network-firewall:UpdateFirewallDescription", - "network-firewall:UpdateFirewallDeleteProtection", - "network-firewall:UpdateSubnetChangeProtection", - "network-firewall:UpdateFirewallPolicyChangeProtection", - "network-firewall:AssociateFirewallPolicy", - "network-firewall:TagResource", - "network-firewall:UntagResource", - "network-firewall:DescribeFirewall" - ] - } - }, - "primaryIdentifier": [ - "/properties/FirewallArn" - ], - "properties": { - "DeleteProtection": { - "type": "boolean" - }, - "Description": { - "maxLength": 512, - "pattern": "^.*$", - "type": "string" - }, - "EndpointIds": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EndpointId" - }, - "type": "array" - }, - "FirewallArn": { - "$ref": "#/definitions/ResourceArn" - }, - "FirewallId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", - "type": "string" - }, - "FirewallName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "FirewallPolicyArn": { - "$ref": "#/definitions/ResourceArn" - }, - "FirewallPolicyChangeProtection": { - "type": "boolean" - }, - "SubnetChangeProtection": { - "type": "boolean" - }, - "SubnetMappings": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetMapping" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "maxLength": 128, - "minLength": 1, - "pattern": "^vpc-[0-9a-f]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/FirewallArn", - "/properties/FirewallId", - "/properties/EndpointIds" - ], - "required": [ - "FirewallName", - "FirewallPolicyArn", - "VpcId", - "SubnetMappings" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::NetworkFirewall::Firewall" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/VpcId", + "/properties/FirewallName" + ], + "definitions": { + "EndpointId": { + "description": "An endpoint Id.", + "type": "string" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws.*$", + "type": "string" + }, + "SubnetMapping": { + "additionalProperties": false, + "properties": { + "IPAddressType": { + "description": "A IPAddressType", + "type": "string" + }, + "SubnetId": { + "description": "A SubnetId.", + "type": "string" + } + }, + "required": [ + "SubnetId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::NetworkFirewall::Firewall", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "network-firewall:CreateFirewall", + "network-firewall:DescribeFirewallPolicy", + "network-firewall:DescribeRuleGroup", + "network-firewall:TagResource", + "network-firewall:AssociateSubnets", + "network-firewall:AssociateFirewallPolicy", + "network-firewall:DescribeFirewall" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteVpcEndpoints", + "ec2:DescribeRouteTables", + "logs:DescribeLogGroups", + "logs:DescribeResourcePolicies", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "network-firewall:DeleteFirewall", + "network-firewall:UntagResource", + "network-firewall:DescribeFirewall" + ] + }, + "list": { + "permissions": [ + "network-firewall:ListFirewalls" + ] + }, + "read": { + "permissions": [ + "network-firewall:DescribeFirewall", + "network-firewall:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "network-firewall:AssociateSubnets", + "network-firewall:DisassociateSubnets", + "network-firewall:UpdateFirewallDescription", + "network-firewall:UpdateFirewallDeleteProtection", + "network-firewall:UpdateSubnetChangeProtection", + "network-firewall:UpdateFirewallPolicyChangeProtection", + "network-firewall:AssociateFirewallPolicy", + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:DescribeFirewall" + ] + } + }, + "primaryIdentifier": [ + "/properties/FirewallArn" + ], + "properties": { + "DeleteProtection": { + "type": "boolean" + }, + "Description": { + "maxLength": 512, + "pattern": "^.*$", + "type": "string" + }, + "EndpointIds": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EndpointId" + }, + "type": "array" + }, + "FirewallArn": { + "$ref": "#/definitions/ResourceArn" + }, + "FirewallId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", + "type": "string" + }, + "FirewallName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "FirewallPolicyArn": { + "$ref": "#/definitions/ResourceArn" + }, + "FirewallPolicyChangeProtection": { + "type": "boolean" + }, + "SubnetChangeProtection": { + "type": "boolean" + }, + "SubnetMappings": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetMapping" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "maxLength": 128, + "minLength": 1, + "pattern": "^vpc-[0-9a-f]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/FirewallArn", + "/properties/FirewallId", + "/properties/EndpointIds" + ], + "required": [ + "FirewallName", + "FirewallPolicyArn", + "VpcId", + "SubnetMappings" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkFirewall::Firewall" +} diff --git a/schema/aws-networkfirewall-firewallpolicy.json b/schema/aws-networkfirewall-firewallpolicy.json index 60eec36..101edd2 100644 --- a/schema/aws-networkfirewall-firewallpolicy.json +++ b/schema/aws-networkfirewall-firewallpolicy.json @@ -1,369 +1,378 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FirewallPolicyName" - ], - "definitions": { - "ActionDefinition": { - "additionalProperties": false, - "properties": { - "PublishMetricAction": { - "$ref": "#/definitions/PublishMetricAction" - } - }, - "type": "object" - }, - "CustomAction": { - "additionalProperties": false, - "properties": { - "ActionDefinition": { - "$ref": "#/definitions/ActionDefinition" - }, - "ActionName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "ActionName", - "ActionDefinition" - ], - "type": "object" - }, - "Dimension": { - "additionalProperties": false, - "properties": { - "Value": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_ ]+$", - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "FirewallPolicy": { - "additionalProperties": false, - "properties": { - "PolicyVariables": { - "additionalProperties": false, - "properties": { - "RuleVariables": { - "$ref": "#/definitions/RuleVariables" - } - }, - "type": "object" - }, - "StatefulDefaultActions": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StatefulEngineOptions": { - "$ref": "#/definitions/StatefulEngineOptions" - }, - "StatefulRuleGroupReferences": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StatefulRuleGroupReference" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessCustomActions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CustomAction" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessDefaultActions": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessFragmentDefaultActions": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessRuleGroupReferences": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StatelessRuleGroupReference" - }, - "type": "array", - "uniqueItems": false - }, - "TLSInspectionConfigurationArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "required": [ - "StatelessDefaultActions", - "StatelessFragmentDefaultActions" - ], - "type": "object" - }, - "IPSet": { - "additionalProperties": false, - "properties": { - "Definition": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/VariableDefinition" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "OverrideAction": { - "enum": [ - "DROP_TO_ALERT" - ], - "type": "string" - }, - "Priority": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "PublishMetricAction": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Dimensions" - ], - "type": "object" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(arn:aws.*)$", - "type": "string" - }, - "RuleOrder": { - "enum": [ - "DEFAULT_ACTION_ORDER", - "STRICT_ORDER" - ], - "type": "string" - }, - "RuleVariables": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9_]{1,32}$": { - "$ref": "#/definitions/IPSet" - } - }, - "type": "object" - }, - "StatefulEngineOptions": { - "additionalProperties": false, - "properties": { - "RuleOrder": { - "$ref": "#/definitions/RuleOrder" - }, - "StreamExceptionPolicy": { - "$ref": "#/definitions/StreamExceptionPolicy" - } - }, - "type": "object" - }, - "StatefulRuleGroupOverride": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/OverrideAction" - } - }, - "type": "object" - }, - "StatefulRuleGroupReference": { - "additionalProperties": false, - "properties": { - "Override": { - "$ref": "#/definitions/StatefulRuleGroupOverride" - }, - "Priority": { - "$ref": "#/definitions/Priority" - }, - "ResourceArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "required": [ - "ResourceArn" - ], - "type": "object" - }, - "StatelessRuleGroupReference": { - "additionalProperties": false, - "properties": { - "Priority": { - "$ref": "#/definitions/Priority" - }, - "ResourceArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "required": [ - "ResourceArn", - "Priority" - ], - "type": "object" - }, - "StreamExceptionPolicy": { - "enum": [ - "DROP", - "CONTINUE", - "REJECT" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VariableDefinition": { - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "description": "Resource type definition for AWS::NetworkFirewall::FirewallPolicy", - "handlers": { - "create": { - "permissions": [ - "network-firewall:CreateFirewallPolicy", - "network-firewall:DescribeFirewallPolicy", - "network-firewall:ListTLSInspectionConfigurations", - "network-firewall:TagResource", - "network-firewall:ListRuleGroups" - ] - }, - "delete": { - "permissions": [ - "network-firewall:DeleteFirewallPolicy", - "network-firewall:DescribeFirewallPolicy", - "network-firewall:UntagResource" - ] - }, - "list": { - "permissions": [ - "network-firewall:ListFirewallPolicies" - ] - }, - "read": { - "permissions": [ - "network-firewall:DescribeFirewallPolicy", - "network-firewall:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "network-firewall:UpdateFirewallPolicy", - "network-firewall:DescribeFirewallPolicy", - "network-firewall:TagResource", - "network-firewall:UntagResource", - "network-firewall:ListRuleGroups", - "network-firewall:ListTLSInspectionConfigurations" - ] - } - }, - "primaryIdentifier": [ - "/properties/FirewallPolicyArn" - ], - "properties": { - "Description": { - "maxLength": 512, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "FirewallPolicy": { - "$ref": "#/definitions/FirewallPolicy" - }, - "FirewallPolicyArn": { - "$ref": "#/definitions/ResourceArn" - }, - "FirewallPolicyId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", - "type": "string" - }, - "FirewallPolicyName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/FirewallPolicyArn", - "/properties/FirewallPolicyId" - ], - "required": [ - "FirewallPolicyName", - "FirewallPolicy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::NetworkFirewall::FirewallPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FirewallPolicyName" + ], + "definitions": { + "ActionDefinition": { + "additionalProperties": false, + "properties": { + "PublishMetricAction": { + "$ref": "#/definitions/PublishMetricAction" + } + }, + "type": "object" + }, + "CustomAction": { + "additionalProperties": false, + "properties": { + "ActionDefinition": { + "$ref": "#/definitions/ActionDefinition" + }, + "ActionName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "ActionName", + "ActionDefinition" + ], + "type": "object" + }, + "Dimension": { + "additionalProperties": false, + "properties": { + "Value": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_ ]+$", + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "FirewallPolicy": { + "additionalProperties": false, + "properties": { + "PolicyVariables": { + "additionalProperties": false, + "properties": { + "RuleVariables": { + "$ref": "#/definitions/RuleVariables" + } + }, + "type": "object" + }, + "StatefulDefaultActions": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StatefulEngineOptions": { + "$ref": "#/definitions/StatefulEngineOptions" + }, + "StatefulRuleGroupReferences": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StatefulRuleGroupReference" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessCustomActions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CustomAction" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessDefaultActions": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessFragmentDefaultActions": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessRuleGroupReferences": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StatelessRuleGroupReference" + }, + "type": "array", + "uniqueItems": false + }, + "TLSInspectionConfigurationArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "required": [ + "StatelessDefaultActions", + "StatelessFragmentDefaultActions" + ], + "type": "object" + }, + "IPSet": { + "additionalProperties": false, + "properties": { + "Definition": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/VariableDefinition" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "OverrideAction": { + "enum": [ + "DROP_TO_ALERT" + ], + "type": "string" + }, + "Priority": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "PublishMetricAction": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Dimensions" + ], + "type": "object" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(arn:aws.*)$", + "type": "string" + }, + "RuleOrder": { + "enum": [ + "DEFAULT_ACTION_ORDER", + "STRICT_ORDER" + ], + "type": "string" + }, + "RuleVariables": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9_]{1,32}$": { + "$ref": "#/definitions/IPSet" + } + }, + "type": "object" + }, + "StatefulEngineOptions": { + "additionalProperties": false, + "properties": { + "RuleOrder": { + "$ref": "#/definitions/RuleOrder" + }, + "StreamExceptionPolicy": { + "$ref": "#/definitions/StreamExceptionPolicy" + } + }, + "type": "object" + }, + "StatefulRuleGroupOverride": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/OverrideAction" + } + }, + "type": "object" + }, + "StatefulRuleGroupReference": { + "additionalProperties": false, + "properties": { + "Override": { + "$ref": "#/definitions/StatefulRuleGroupOverride" + }, + "Priority": { + "$ref": "#/definitions/Priority" + }, + "ResourceArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "required": [ + "ResourceArn" + ], + "type": "object" + }, + "StatelessRuleGroupReference": { + "additionalProperties": false, + "properties": { + "Priority": { + "$ref": "#/definitions/Priority" + }, + "ResourceArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "required": [ + "ResourceArn", + "Priority" + ], + "type": "object" + }, + "StreamExceptionPolicy": { + "enum": [ + "DROP", + "CONTINUE", + "REJECT" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VariableDefinition": { + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "description": "Resource type definition for AWS::NetworkFirewall::FirewallPolicy", + "handlers": { + "create": { + "permissions": [ + "network-firewall:CreateFirewallPolicy", + "network-firewall:DescribeFirewallPolicy", + "network-firewall:ListTLSInspectionConfigurations", + "network-firewall:TagResource", + "network-firewall:ListRuleGroups" + ] + }, + "delete": { + "permissions": [ + "network-firewall:DeleteFirewallPolicy", + "network-firewall:DescribeFirewallPolicy", + "network-firewall:UntagResource" + ] + }, + "list": { + "permissions": [ + "network-firewall:ListFirewallPolicies" + ] + }, + "read": { + "permissions": [ + "network-firewall:DescribeFirewallPolicy", + "network-firewall:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "network-firewall:UpdateFirewallPolicy", + "network-firewall:DescribeFirewallPolicy", + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:ListRuleGroups", + "network-firewall:ListTLSInspectionConfigurations" + ] + } + }, + "primaryIdentifier": [ + "/properties/FirewallPolicyArn" + ], + "properties": { + "Description": { + "maxLength": 512, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "FirewallPolicy": { + "$ref": "#/definitions/FirewallPolicy" + }, + "FirewallPolicyArn": { + "$ref": "#/definitions/ResourceArn" + }, + "FirewallPolicyId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", + "type": "string" + }, + "FirewallPolicyName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/FirewallPolicyArn", + "/properties/FirewallPolicyId" + ], + "required": [ + "FirewallPolicyName", + "FirewallPolicy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkFirewall::FirewallPolicy" +} diff --git a/schema/aws-networkfirewall-loggingconfiguration.json b/schema/aws-networkfirewall-loggingconfiguration.json index 5ca1113..8a7882b 100644 --- a/schema/aws-networkfirewall-loggingconfiguration.json +++ b/schema/aws-networkfirewall-loggingconfiguration.json @@ -1,151 +1,152 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FirewallName", - "/properties/FirewallArn" - ], - "definitions": { - "LogDestinationConfig": { - "additionalProperties": false, - "properties": { - "LogDestination": { - "additionalProperties": false, - "description": "A key-value pair to configure the logDestinations.", - "minProperties": 1, - "patternProperties": { - "^[0-9A-Za-z.\\-_@\\/]+$": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "LogDestinationType": { - "enum": [ - "S3", - "CloudWatchLogs", - "KinesisDataFirehose" - ], - "type": "string" - }, - "LogType": { - "enum": [ - "ALERT", - "FLOW" - ], - "type": "string" - } - }, - "required": [ - "LogType", - "LogDestinationType", - "LogDestination" - ], - "type": "object" - }, - "LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "LogDestinationConfigs": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogDestinationConfig" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "LogDestinationConfigs" - ], - "type": "object" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws.*$", - "type": "string" - } - }, - "description": "Resource type definition for AWS::NetworkFirewall::LoggingConfiguration", - "handlers": { - "create": { - "permissions": [ - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "iam:CreateServiceLinkedRole", - "firehose:TagDeliveryStream", - "network-firewall:UpdateLoggingConfiguration", - "network-firewall:DescribeLoggingConfiguration" - ] - }, - "delete": { - "permissions": [ - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:GetLogDelivery", - "network-firewall:UpdateLoggingConfiguration", - "network-firewall:DescribeLoggingConfiguration" - ] - }, - "read": { - "permissions": [ - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "network-firewall:DescribeLoggingConfiguration" - ] - }, - "update": { - "permissions": [ - "logs:CreateLogDelivery", - "logs:DeleteLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "iam:CreateServiceLinkedRole", - "firehose:TagDeliveryStream", - "network-firewall:UpdateLoggingConfiguration", - "network-firewall:DescribeLoggingConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/FirewallArn" - ], - "properties": { - "FirewallArn": { - "$ref": "#/definitions/ResourceArn" - }, - "FirewallName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/LoggingConfiguration" - } - }, - "required": [ - "FirewallArn", - "LoggingConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::NetworkFirewall::LoggingConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FirewallName", + "/properties/FirewallArn" + ], + "definitions": { + "LogDestinationConfig": { + "additionalProperties": false, + "properties": { + "LogDestination": { + "additionalProperties": false, + "description": "A key-value pair to configure the logDestinations.", + "minProperties": 1, + "patternProperties": { + "^[0-9A-Za-z.\\-_@\\/]+$": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "LogDestinationType": { + "enum": [ + "S3", + "CloudWatchLogs", + "KinesisDataFirehose" + ], + "type": "string" + }, + "LogType": { + "enum": [ + "ALERT", + "FLOW", + "TLS" + ], + "type": "string" + } + }, + "required": [ + "LogType", + "LogDestinationType", + "LogDestination" + ], + "type": "object" + }, + "LoggingConfiguration": { + "additionalProperties": false, + "properties": { + "LogDestinationConfigs": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogDestinationConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "LogDestinationConfigs" + ], + "type": "object" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws.*$", + "type": "string" + } + }, + "description": "Resource type definition for AWS::NetworkFirewall::LoggingConfiguration", + "handlers": { + "create": { + "permissions": [ + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream", + "network-firewall:UpdateLoggingConfiguration", + "network-firewall:DescribeLoggingConfiguration" + ] + }, + "delete": { + "permissions": [ + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:GetLogDelivery", + "network-firewall:UpdateLoggingConfiguration", + "network-firewall:DescribeLoggingConfiguration" + ] + }, + "read": { + "permissions": [ + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "network-firewall:DescribeLoggingConfiguration" + ] + }, + "update": { + "permissions": [ + "logs:CreateLogDelivery", + "logs:DeleteLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream", + "network-firewall:UpdateLoggingConfiguration", + "network-firewall:DescribeLoggingConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/FirewallArn" + ], + "properties": { + "FirewallArn": { + "$ref": "#/definitions/ResourceArn" + }, + "FirewallName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "LoggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration" + } + }, + "required": [ + "FirewallArn", + "LoggingConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::NetworkFirewall::LoggingConfiguration" +} diff --git a/schema/aws-networkfirewall-rulegroup.json b/schema/aws-networkfirewall-rulegroup.json index a1372f2..aff5218 100644 --- a/schema/aws-networkfirewall-rulegroup.json +++ b/schema/aws-networkfirewall-rulegroup.json @@ -1,717 +1,726 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RuleGroupName", - "/properties/Capacity", - "/properties/Type" - ], - "definitions": { - "ActionDefinition": { - "additionalProperties": false, - "properties": { - "PublishMetricAction": { - "$ref": "#/definitions/PublishMetricAction" - } - }, - "type": "object" - }, - "Address": { - "additionalProperties": false, - "properties": { - "AddressDefinition": { - "maxLength": 255, - "minLength": 1, - "pattern": "^([a-fA-F\\d:\\.]+/\\d{1,3})$", - "type": "string" - } - }, - "required": [ - "AddressDefinition" - ], - "type": "object" - }, - "CustomAction": { - "additionalProperties": false, - "properties": { - "ActionDefinition": { - "$ref": "#/definitions/ActionDefinition" - }, - "ActionName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "ActionName", - "ActionDefinition" - ], - "type": "object" - }, - "Dimension": { - "additionalProperties": false, - "properties": { - "Value": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_ ]+$", - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "GeneratedRulesType": { - "enum": [ - "ALLOWLIST", - "DENYLIST" - ], - "type": "string" - }, - "Header": { - "additionalProperties": false, - "properties": { - "Destination": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "DestinationPort": { - "$ref": "#/definitions/Port" - }, - "Direction": { - "enum": [ - "FORWARD", - "ANY" - ], - "type": "string" - }, - "Protocol": { - "enum": [ - "IP", - "TCP", - "UDP", - "ICMP", - "HTTP", - "FTP", - "TLS", - "SMB", - "DNS", - "DCERPC", - "SSH", - "SMTP", - "IMAP", - "MSN", - "KRB5", - "IKEV2", - "TFTP", - "NTP", - "DHCP" - ], - "type": "string" - }, - "Source": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "SourcePort": { - "$ref": "#/definitions/Port" - } - }, - "required": [ - "Protocol", - "Source", - "SourcePort", - "Direction", - "Destination", - "DestinationPort" - ], - "type": "object" - }, - "IPSet": { - "additionalProperties": false, - "properties": { - "Definition": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/VariableDefinition" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "IPSetReference": { - "additionalProperties": false, - "properties": { - "ReferenceArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "type": "object" - }, - "MatchAttributes": { - "additionalProperties": false, - "properties": { - "DestinationPorts": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "Destinations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array", - "uniqueItems": false - }, - "Protocols": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ProtocolNumber" - }, - "type": "array", - "uniqueItems": false - }, - "SourcePorts": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "Sources": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array", - "uniqueItems": false - }, - "TCPFlags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TCPFlagField" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Port": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "PortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "$ref": "#/definitions/PortRangeBound" - }, - "ToPort": { - "$ref": "#/definitions/PortRangeBound" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "PortRangeBound": { - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "PortSet": { - "additionalProperties": false, - "properties": { - "Definition": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/VariableDefinition" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "ProtocolNumber": { - "maximum": 255, - "minimum": 0, - "type": "integer" - }, - "PublishMetricAction": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Dimension" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Dimensions" - ], - "type": "object" - }, - "ReferenceSets": { - "additionalProperties": false, - "properties": { - "IPSetReferences": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9_]{1,32}$": { - "$ref": "#/definitions/IPSetReference" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(arn:aws.*)$", - "type": "string" - }, - "RuleDefinition": { - "additionalProperties": false, - "properties": { - "Actions": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "MatchAttributes": { - "$ref": "#/definitions/MatchAttributes" - } - }, - "required": [ - "MatchAttributes", - "Actions" - ], - "type": "object" - }, - "RuleGroup": { - "additionalProperties": false, - "properties": { - "ReferenceSets": { - "$ref": "#/definitions/ReferenceSets" - }, - "RuleVariables": { - "$ref": "#/definitions/RuleVariables" - }, - "RulesSource": { - "$ref": "#/definitions/RulesSource" - }, - "StatefulRuleOptions": { - "$ref": "#/definitions/StatefulRuleOptions" - } - }, - "required": [ - "RulesSource" - ], - "type": "object" - }, - "RuleOption": { - "additionalProperties": false, - "properties": { - "Keyword": { - "maxLength": 128, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Settings": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Setting" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Keyword" - ], - "type": "object" - }, - "RuleOrder": { - "enum": [ - "DEFAULT_ACTION_ORDER", - "STRICT_ORDER" - ], - "type": "string" - }, - "RuleVariables": { - "additionalProperties": false, - "properties": { - "IPSets": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9_]{1,32}$": { - "$ref": "#/definitions/IPSet" - } - }, - "type": "object" - }, - "PortSets": { - "additionalProperties": false, - "patternProperties": { - "^[A-Za-z0-9_]{1,32}$": { - "$ref": "#/definitions/PortSet" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "RulesSource": { - "additionalProperties": false, - "properties": { - "RulesSourceList": { - "$ref": "#/definitions/RulesSourceList" - }, - "RulesString": { - "$ref": "#/definitions/RulesString" - }, - "StatefulRules": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StatefulRule" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessRulesAndCustomActions": { - "$ref": "#/definitions/StatelessRulesAndCustomActions" - } - }, - "type": "object" - }, - "RulesSourceList": { - "additionalProperties": false, - "properties": { - "GeneratedRulesType": { - "$ref": "#/definitions/GeneratedRulesType" - }, - "TargetTypes": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TargetType" - }, - "type": "array", - "uniqueItems": false - }, - "Targets": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Targets", - "TargetTypes", - "GeneratedRulesType" - ], - "type": "object" - }, - "RulesString": { - "maxLength": 1000000, - "minLength": 0, - "type": "string" - }, - "Setting": { - "maxLength": 8192, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "StatefulRule": { - "additionalProperties": false, - "properties": { - "Action": { - "enum": [ - "PASS", - "DROP", - "ALERT", - "REJECT" - ], - "type": "string" - }, - "Header": { - "$ref": "#/definitions/Header" - }, - "RuleOptions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/RuleOption" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Action", - "Header", - "RuleOptions" - ], - "type": "object" - }, - "StatefulRuleOptions": { - "additionalProperties": false, - "properties": { - "RuleOrder": { - "$ref": "#/definitions/RuleOrder" - } - }, - "type": "object" - }, - "StatelessRule": { - "additionalProperties": false, - "properties": { - "Priority": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "RuleDefinition": { - "$ref": "#/definitions/RuleDefinition" - } - }, - "required": [ - "RuleDefinition", - "Priority" - ], - "type": "object" - }, - "StatelessRulesAndCustomActions": { - "additionalProperties": false, - "properties": { - "CustomActions": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CustomAction" - }, - "type": "array", - "uniqueItems": false - }, - "StatelessRules": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StatelessRule" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "StatelessRules" - ], - "type": "object" - }, - "TCPFlag": { - "enum": [ - "FIN", - "SYN", - "RST", - "PSH", - "ACK", - "URG", - "ECE", - "CWR" - ], - "type": "string" - }, - "TCPFlagField": { - "additionalProperties": false, - "properties": { - "Flags": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TCPFlag" - }, - "type": "array", - "uniqueItems": false - }, - "Masks": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TCPFlag" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Flags" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TargetType": { - "enum": [ - "TLS_SNI", - "HTTP_HOST" - ], - "type": "string" - }, - "VariableDefinition": { - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "description": "Resource type definition for AWS::NetworkFirewall::RuleGroup", - "handlers": { - "create": { - "permissions": [ - "network-firewall:CreateRuleGroup", - "network-firewall:DescribeRuleGroup", - "network-firewall:TagResource", - "network-firewall:ListRuleGroups", - "iam:CreateServiceLinkedRole", - "ec2:GetManagedPrefixListEntries" - ] - }, - "delete": { - "permissions": [ - "network-firewall:DeleteRuleGroup", - "network-firewall:DescribeRuleGroup", - "network-firewall:UntagResource" - ] - }, - "list": { - "permissions": [ - "network-firewall:ListRuleGroups" - ] - }, - "read": { - "permissions": [ - "network-firewall:DescribeRuleGroup", - "network-firewall:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "network-firewall:UpdateRuleGroup", - "network-firewall:DescribeRuleGroup", - "network-firewall:TagResource", - "network-firewall:UntagResource", - "iam:CreateServiceLinkedRole", - "ec2:GetManagedPrefixListEntries" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleGroupArn" - ], - "properties": { - "Capacity": { - "type": "integer" - }, - "Description": { - "maxLength": 512, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "RuleGroup": { - "$ref": "#/definitions/RuleGroup" - }, - "RuleGroupArn": { - "$ref": "#/definitions/ResourceArn" - }, - "RuleGroupId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", - "type": "string" - }, - "RuleGroupName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "enum": [ - "STATELESS", - "STATEFUL" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RuleGroupArn", - "/properties/RuleGroupId" - ], - "required": [ - "Type", - "Capacity", - "RuleGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::NetworkFirewall::RuleGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RuleGroupName", + "/properties/Capacity", + "/properties/Type" + ], + "definitions": { + "ActionDefinition": { + "additionalProperties": false, + "properties": { + "PublishMetricAction": { + "$ref": "#/definitions/PublishMetricAction" + } + }, + "type": "object" + }, + "Address": { + "additionalProperties": false, + "properties": { + "AddressDefinition": { + "maxLength": 255, + "minLength": 1, + "pattern": "^([a-fA-F\\d:\\.]+/\\d{1,3})$", + "type": "string" + } + }, + "required": [ + "AddressDefinition" + ], + "type": "object" + }, + "CustomAction": { + "additionalProperties": false, + "properties": { + "ActionDefinition": { + "$ref": "#/definitions/ActionDefinition" + }, + "ActionName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "ActionName", + "ActionDefinition" + ], + "type": "object" + }, + "Dimension": { + "additionalProperties": false, + "properties": { + "Value": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_ ]+$", + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "GeneratedRulesType": { + "enum": [ + "ALLOWLIST", + "DENYLIST" + ], + "type": "string" + }, + "Header": { + "additionalProperties": false, + "properties": { + "Destination": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "DestinationPort": { + "$ref": "#/definitions/Port" + }, + "Direction": { + "enum": [ + "FORWARD", + "ANY" + ], + "type": "string" + }, + "Protocol": { + "enum": [ + "IP", + "TCP", + "UDP", + "ICMP", + "HTTP", + "FTP", + "TLS", + "SMB", + "DNS", + "DCERPC", + "SSH", + "SMTP", + "IMAP", + "MSN", + "KRB5", + "IKEV2", + "TFTP", + "NTP", + "DHCP" + ], + "type": "string" + }, + "Source": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "SourcePort": { + "$ref": "#/definitions/Port" + } + }, + "required": [ + "Protocol", + "Source", + "SourcePort", + "Direction", + "Destination", + "DestinationPort" + ], + "type": "object" + }, + "IPSet": { + "additionalProperties": false, + "properties": { + "Definition": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/VariableDefinition" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "IPSetReference": { + "additionalProperties": false, + "properties": { + "ReferenceArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "type": "object" + }, + "MatchAttributes": { + "additionalProperties": false, + "properties": { + "DestinationPorts": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "Destinations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Address" + }, + "type": "array", + "uniqueItems": false + }, + "Protocols": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ProtocolNumber" + }, + "type": "array", + "uniqueItems": false + }, + "SourcePorts": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "Sources": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Address" + }, + "type": "array", + "uniqueItems": false + }, + "TCPFlags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TCPFlagField" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Port": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "PortRange": { + "additionalProperties": false, + "properties": { + "FromPort": { + "$ref": "#/definitions/PortRangeBound" + }, + "ToPort": { + "$ref": "#/definitions/PortRangeBound" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + }, + "PortRangeBound": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "PortSet": { + "additionalProperties": false, + "properties": { + "Definition": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/VariableDefinition" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "ProtocolNumber": { + "maximum": 255, + "minimum": 0, + "type": "integer" + }, + "PublishMetricAction": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Dimensions" + ], + "type": "object" + }, + "ReferenceSets": { + "additionalProperties": false, + "properties": { + "IPSetReferences": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9_]{1,32}$": { + "$ref": "#/definitions/IPSetReference" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(arn:aws.*)$", + "type": "string" + }, + "RuleDefinition": { + "additionalProperties": false, + "properties": { + "Actions": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "MatchAttributes": { + "$ref": "#/definitions/MatchAttributes" + } + }, + "required": [ + "MatchAttributes", + "Actions" + ], + "type": "object" + }, + "RuleGroup": { + "additionalProperties": false, + "properties": { + "ReferenceSets": { + "$ref": "#/definitions/ReferenceSets" + }, + "RuleVariables": { + "$ref": "#/definitions/RuleVariables" + }, + "RulesSource": { + "$ref": "#/definitions/RulesSource" + }, + "StatefulRuleOptions": { + "$ref": "#/definitions/StatefulRuleOptions" + } + }, + "required": [ + "RulesSource" + ], + "type": "object" + }, + "RuleOption": { + "additionalProperties": false, + "properties": { + "Keyword": { + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Settings": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Setting" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Keyword" + ], + "type": "object" + }, + "RuleOrder": { + "enum": [ + "DEFAULT_ACTION_ORDER", + "STRICT_ORDER" + ], + "type": "string" + }, + "RuleVariables": { + "additionalProperties": false, + "properties": { + "IPSets": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9_]{1,32}$": { + "$ref": "#/definitions/IPSet" + } + }, + "type": "object" + }, + "PortSets": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9_]{1,32}$": { + "$ref": "#/definitions/PortSet" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RulesSource": { + "additionalProperties": false, + "properties": { + "RulesSourceList": { + "$ref": "#/definitions/RulesSourceList" + }, + "RulesString": { + "$ref": "#/definitions/RulesString" + }, + "StatefulRules": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StatefulRule" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessRulesAndCustomActions": { + "$ref": "#/definitions/StatelessRulesAndCustomActions" + } + }, + "type": "object" + }, + "RulesSourceList": { + "additionalProperties": false, + "properties": { + "GeneratedRulesType": { + "$ref": "#/definitions/GeneratedRulesType" + }, + "TargetTypes": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TargetType" + }, + "type": "array", + "uniqueItems": false + }, + "Targets": { + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Targets", + "TargetTypes", + "GeneratedRulesType" + ], + "type": "object" + }, + "RulesString": { + "maxLength": 1000000, + "minLength": 0, + "type": "string" + }, + "Setting": { + "maxLength": 8192, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "StatefulRule": { + "additionalProperties": false, + "properties": { + "Action": { + "enum": [ + "PASS", + "DROP", + "ALERT", + "REJECT" + ], + "type": "string" + }, + "Header": { + "$ref": "#/definitions/Header" + }, + "RuleOptions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/RuleOption" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Action", + "Header", + "RuleOptions" + ], + "type": "object" + }, + "StatefulRuleOptions": { + "additionalProperties": false, + "properties": { + "RuleOrder": { + "$ref": "#/definitions/RuleOrder" + } + }, + "type": "object" + }, + "StatelessRule": { + "additionalProperties": false, + "properties": { + "Priority": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "RuleDefinition": { + "$ref": "#/definitions/RuleDefinition" + } + }, + "required": [ + "RuleDefinition", + "Priority" + ], + "type": "object" + }, + "StatelessRulesAndCustomActions": { + "additionalProperties": false, + "properties": { + "CustomActions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CustomAction" + }, + "type": "array", + "uniqueItems": false + }, + "StatelessRules": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StatelessRule" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "StatelessRules" + ], + "type": "object" + }, + "TCPFlag": { + "enum": [ + "FIN", + "SYN", + "RST", + "PSH", + "ACK", + "URG", + "ECE", + "CWR" + ], + "type": "string" + }, + "TCPFlagField": { + "additionalProperties": false, + "properties": { + "Flags": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TCPFlag" + }, + "type": "array", + "uniqueItems": false + }, + "Masks": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TCPFlag" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Flags" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TargetType": { + "enum": [ + "TLS_SNI", + "HTTP_HOST" + ], + "type": "string" + }, + "VariableDefinition": { + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "description": "Resource type definition for AWS::NetworkFirewall::RuleGroup", + "handlers": { + "create": { + "permissions": [ + "network-firewall:CreateRuleGroup", + "network-firewall:DescribeRuleGroup", + "network-firewall:TagResource", + "network-firewall:ListRuleGroups", + "iam:CreateServiceLinkedRole", + "ec2:GetManagedPrefixListEntries" + ] + }, + "delete": { + "permissions": [ + "network-firewall:DeleteRuleGroup", + "network-firewall:DescribeRuleGroup", + "network-firewall:UntagResource" + ] + }, + "list": { + "permissions": [ + "network-firewall:ListRuleGroups" + ] + }, + "read": { + "permissions": [ + "network-firewall:DescribeRuleGroup", + "network-firewall:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "network-firewall:UpdateRuleGroup", + "network-firewall:DescribeRuleGroup", + "network-firewall:TagResource", + "network-firewall:UntagResource", + "iam:CreateServiceLinkedRole", + "ec2:GetManagedPrefixListEntries" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleGroupArn" + ], + "properties": { + "Capacity": { + "type": "integer" + }, + "Description": { + "maxLength": 512, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "RuleGroup": { + "$ref": "#/definitions/RuleGroup" + }, + "RuleGroupArn": { + "$ref": "#/definitions/ResourceArn" + }, + "RuleGroupId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", + "type": "string" + }, + "RuleGroupName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "enum": [ + "STATELESS", + "STATEFUL" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RuleGroupArn", + "/properties/RuleGroupId" + ], + "required": [ + "Type", + "Capacity", + "RuleGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkFirewall::RuleGroup" +} diff --git a/schema/aws-networkfirewall-tlsinspectionconfiguration.json b/schema/aws-networkfirewall-tlsinspectionconfiguration.json index 675287d..ce3adb9 100644 --- a/schema/aws-networkfirewall-tlsinspectionconfiguration.json +++ b/schema/aws-networkfirewall-tlsinspectionconfiguration.json @@ -1,287 +1,296 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TLSInspectionConfigurationName" - ], - "definitions": { - "Address": { - "additionalProperties": false, - "properties": { - "AddressDefinition": { - "maxLength": 255, - "minLength": 1, - "pattern": "^([a-fA-F\\d:\\.]+/\\d{1,3})$", - "type": "string" - } - }, - "required": [ - "AddressDefinition" - ], - "type": "object" - }, - "PortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "$ref": "#/definitions/PortRangeBound" - }, - "ToPort": { - "$ref": "#/definitions/PortRangeBound" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "PortRangeBound": { - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "ProtocolNumber": { - "maximum": 255, - "minimum": 0, - "type": "integer" - }, - "ResourceArn": { - "description": "A resource ARN.", - "maxLength": 256, - "minLength": 1, - "pattern": "^(arn:aws.*)$", - "type": "string" - }, - "RevokedStatusAction": { - "enum": [ - "PASS", - "DROP", - "REJECT" - ], - "type": "string" - }, - "ServerCertificate": { - "additionalProperties": false, - "properties": { - "ResourceArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "type": "object" - }, - "ServerCertificateConfiguration": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArn": { - "$ref": "#/definitions/ResourceArn" - }, - "CheckCertificateRevocationStatus": { - "additionalProperties": false, - "properties": { - "RevokedStatusAction": { - "$ref": "#/definitions/RevokedStatusAction" - }, - "UnknownStatusAction": { - "$ref": "#/definitions/UnknownStatusAction" - } - }, - "type": "object" - }, - "Scopes": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ServerCertificateScope" - }, - "type": "array", - "uniqueItems": false - }, - "ServerCertificates": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ServerCertificate" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ServerCertificateScope": { - "additionalProperties": false, - "properties": { - "DestinationPorts": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "Destinations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array", - "uniqueItems": false - }, - "Protocols": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ProtocolNumber" - }, - "type": "array", - "uniqueItems": false - }, - "SourcePorts": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PortRange" - }, - "type": "array", - "uniqueItems": false - }, - "Sources": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "TLSInspectionConfiguration": { - "additionalProperties": false, - "properties": { - "ServerCertificateConfigurations": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ServerCertificateConfiguration" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UnknownStatusAction": { - "enum": [ - "PASS", - "DROP", - "REJECT" - ], - "type": "string" - } - }, - "description": "Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "network-firewall:CreateTLSInspectionConfiguration", - "network-firewall:DescribeTLSInspectionConfiguration", - "network-firewall:TagResource" - ] - }, - "delete": { - "permissions": [ - "network-firewall:DeleteTLSInspectionConfiguration", - "network-firewall:DescribeTLSInspectionConfiguration", - "network-firewall:UntagResource" - ] - }, - "list": { - "permissions": [ - "network-firewall:ListTLSInspectionConfigurations" - ] - }, - "read": { - "permissions": [ - "network-firewall:DescribeTLSInspectionConfiguration", - "network-firewall:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "network-firewall:UpdateTLSInspectionConfiguration", - "network-firewall:DescribeTLSInspectionConfiguration", - "network-firewall:TagResource", - "network-firewall:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/TLSInspectionConfigurationArn" - ], - "properties": { - "Description": { - "maxLength": 512, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "TLSInspectionConfiguration": { - "$ref": "#/definitions/TLSInspectionConfiguration" - }, - "TLSInspectionConfigurationArn": { - "$ref": "#/definitions/ResourceArn" - }, - "TLSInspectionConfigurationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", - "type": "string" - }, - "TLSInspectionConfigurationName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/TLSInspectionConfigurationArn", - "/properties/TLSInspectionConfigurationId" - ], - "required": [ - "TLSInspectionConfigurationName", - "TLSInspectionConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::NetworkFirewall::TLSInspectionConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TLSInspectionConfigurationName" + ], + "definitions": { + "Address": { + "additionalProperties": false, + "properties": { + "AddressDefinition": { + "maxLength": 255, + "minLength": 1, + "pattern": "^([a-fA-F\\d:\\.]+/\\d{1,3})$", + "type": "string" + } + }, + "required": [ + "AddressDefinition" + ], + "type": "object" + }, + "PortRange": { + "additionalProperties": false, + "properties": { + "FromPort": { + "$ref": "#/definitions/PortRangeBound" + }, + "ToPort": { + "$ref": "#/definitions/PortRangeBound" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + }, + "PortRangeBound": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "ProtocolNumber": { + "maximum": 255, + "minimum": 0, + "type": "integer" + }, + "ResourceArn": { + "description": "A resource ARN.", + "maxLength": 256, + "minLength": 1, + "pattern": "^(arn:aws.*)$", + "type": "string" + }, + "RevokedStatusAction": { + "enum": [ + "PASS", + "DROP", + "REJECT" + ], + "type": "string" + }, + "ServerCertificate": { + "additionalProperties": false, + "properties": { + "ResourceArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "type": "object" + }, + "ServerCertificateConfiguration": { + "additionalProperties": false, + "properties": { + "CertificateAuthorityArn": { + "$ref": "#/definitions/ResourceArn" + }, + "CheckCertificateRevocationStatus": { + "additionalProperties": false, + "properties": { + "RevokedStatusAction": { + "$ref": "#/definitions/RevokedStatusAction" + }, + "UnknownStatusAction": { + "$ref": "#/definitions/UnknownStatusAction" + } + }, + "type": "object" + }, + "Scopes": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ServerCertificateScope" + }, + "type": "array", + "uniqueItems": false + }, + "ServerCertificates": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ServerCertificate" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ServerCertificateScope": { + "additionalProperties": false, + "properties": { + "DestinationPorts": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "Destinations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Address" + }, + "type": "array", + "uniqueItems": false + }, + "Protocols": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ProtocolNumber" + }, + "type": "array", + "uniqueItems": false + }, + "SourcePorts": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PortRange" + }, + "type": "array", + "uniqueItems": false + }, + "Sources": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Address" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "TLSInspectionConfiguration": { + "additionalProperties": false, + "properties": { + "ServerCertificateConfigurations": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ServerCertificateConfiguration" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UnknownStatusAction": { + "enum": [ + "PASS", + "DROP", + "REJECT" + ], + "type": "string" + } + }, + "description": "Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "network-firewall:CreateTLSInspectionConfiguration", + "network-firewall:DescribeTLSInspectionConfiguration", + "network-firewall:TagResource" + ] + }, + "delete": { + "permissions": [ + "network-firewall:DeleteTLSInspectionConfiguration", + "network-firewall:DescribeTLSInspectionConfiguration", + "network-firewall:UntagResource" + ] + }, + "list": { + "permissions": [ + "network-firewall:ListTLSInspectionConfigurations" + ] + }, + "read": { + "permissions": [ + "network-firewall:DescribeTLSInspectionConfiguration", + "network-firewall:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "network-firewall:UpdateTLSInspectionConfiguration", + "network-firewall:DescribeTLSInspectionConfiguration", + "network-firewall:TagResource", + "network-firewall:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TLSInspectionConfigurationArn" + ], + "properties": { + "Description": { + "maxLength": 512, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "TLSInspectionConfiguration": { + "$ref": "#/definitions/TLSInspectionConfiguration" + }, + "TLSInspectionConfigurationArn": { + "$ref": "#/definitions/ResourceArn" + }, + "TLSInspectionConfigurationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$", + "type": "string" + }, + "TLSInspectionConfigurationName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/TLSInspectionConfigurationArn", + "/properties/TLSInspectionConfigurationId" + ], + "required": [ + "TLSInspectionConfigurationName", + "TLSInspectionConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkfirewall.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "network-firewall:TagResource", + "network-firewall:UntagResource", + "network-firewall:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkFirewall::TLSInspectionConfiguration" +} diff --git a/schema/aws-networkmanager-connectattachment.json b/schema/aws-networkmanager-connectattachment.json index ec7c61e..55afdc0 100644 --- a/schema/aws-networkmanager-connectattachment.json +++ b/schema/aws-networkmanager-connectattachment.json @@ -1,203 +1,240 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CoreNetworkId", - "/properties/EdgeLocation", - "/properties/TransportAttachmentId", - "/properties/Options" - ], - "definitions": { - "ConnectAttachmentOptions": { - "additionalProperties": false, - "description": "Connect attachment options for protocol", - "properties": { - "Protocol": { - "description": "Tunnel protocol for connect attachment", - "type": "string" - } - }, - "type": "object" - }, - "ProposedSegmentChange": { - "additionalProperties": false, - "description": "The attachment to move from one segment to another.", - "properties": { - "AttachmentPolicyRuleNumber": { - "description": "The rule number in the policy document that applies to this change.", - "type": "integer" - }, - "SegmentName": { - "description": "The name of the segment to change.", - "type": "string" - }, - "Tags": { - "description": "The list of key-value tags that changed for the segment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::NetworkManager::ConnectAttachment Resource Type Definition", - "handlers": { - "create": { - "permissions": [ - "networkmanager:GetConnectAttachment", - "networkmanager:CreateConnectAttachment", - "networkmanager:TagResource", - "ec2:DescribeRegions" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetConnectAttachment", - "networkmanager:DeleteAttachment", - "ec2:DescribeRegions" - ] - }, - "list": { - "permissions": [ - "networkmanager:ListAttachments" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetConnectAttachment" - ] - }, - "update": { - "permissions": [ - "networkmanager:GetConnectAttachment", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentId" - ], - "properties": { - "AttachmentId": { - "description": "The ID of the attachment.", - "type": "string" - }, - "AttachmentPolicyRuleNumber": { - "description": "The policy rule number associated with the attachment.", - "type": "integer" - }, - "AttachmentType": { - "description": "The type of attachment.", - "type": "string" - }, - "CoreNetworkArn": { - "description": "The ARN of a core network.", - "type": "string" - }, - "CoreNetworkId": { - "description": "ID of the CoreNetwork that the attachment will be attached to.", - "type": "string" - }, - "CreatedAt": { - "description": "Creation time of the attachment.", - "type": "string" - }, - "EdgeLocation": { - "description": "Edge location of the attachment.", - "type": "string" - }, - "Options": { - "$ref": "#/definitions/ConnectAttachmentOptions", - "description": "Protocol options for connect attachment" - }, - "OwnerAccountId": { - "description": "The ID of the attachment account owner.", - "type": "string" - }, - "ProposedSegmentChange": { - "$ref": "#/definitions/ProposedSegmentChange", - "description": "The attachment to move from one segment to another." - }, - "ResourceArn": { - "description": "The attachment resource ARN.", - "type": "string" - }, - "SegmentName": { - "description": "The name of the segment attachment.", - "type": "string" - }, - "State": { - "description": "State of the attachment.", - "type": "string" - }, - "Tags": { - "description": "Tags for the attachment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TransportAttachmentId": { - "description": "Id of transport attachment", - "type": "string" - }, - "UpdatedAt": { - "description": "Last update time of the attachment.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CoreNetworkArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/AttachmentType", - "/properties/State", - "/properties/ResourceArn", - "/properties/AttachmentId", - "/properties/OwnerAccountId", - "/properties/AttachmentPolicyRuleNumber", - "/properties/SegmentName" - ], - "required": [ - "CoreNetworkId", - "EdgeLocation", - "TransportAttachmentId", - "Options" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-connectattachment", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::ConnectAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CoreNetworkId", + "/properties/EdgeLocation", + "/properties/TransportAttachmentId", + "/properties/Options" + ], + "definitions": { + "ConnectAttachmentOptions": { + "additionalProperties": false, + "description": "Connect attachment options for protocol", + "properties": { + "Protocol": { + "description": "Tunnel protocol for connect attachment", + "type": "string" + } + }, + "type": "object" + }, + "ProposedNetworkFunctionGroupChange": { + "additionalProperties": false, + "description": "The attachment to move from one network function group to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the network function group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ProposedSegmentChange": { + "additionalProperties": false, + "description": "The attachment to move from one segment to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "SegmentName": { + "description": "The name of the segment to change.", + "type": "string" + }, + "Tags": { + "description": "The list of key-value tags that changed for the segment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::NetworkManager::ConnectAttachment Resource Type Definition", + "handlers": { + "create": { + "permissions": [ + "networkmanager:GetConnectAttachment", + "networkmanager:CreateConnectAttachment", + "networkmanager:TagResource", + "ec2:DescribeRegions" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetConnectAttachment", + "networkmanager:DeleteAttachment", + "ec2:DescribeRegions" + ] + }, + "list": { + "permissions": [ + "networkmanager:ListAttachments" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetConnectAttachment" + ] + }, + "update": { + "permissions": [ + "networkmanager:GetConnectAttachment", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentId" + ], + "properties": { + "AttachmentId": { + "description": "The ID of the attachment.", + "type": "string" + }, + "AttachmentPolicyRuleNumber": { + "description": "The policy rule number associated with the attachment.", + "type": "integer" + }, + "AttachmentType": { + "description": "The type of attachment.", + "type": "string" + }, + "CoreNetworkArn": { + "description": "The ARN of a core network.", + "type": "string" + }, + "CoreNetworkId": { + "description": "ID of the CoreNetwork that the attachment will be attached to.", + "type": "string" + }, + "CreatedAt": { + "description": "Creation time of the attachment.", + "type": "string" + }, + "EdgeLocation": { + "description": "Edge location of the attachment.", + "type": "string" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group attachment.", + "type": "string" + }, + "Options": { + "$ref": "#/definitions/ConnectAttachmentOptions", + "description": "Protocol options for connect attachment" + }, + "OwnerAccountId": { + "description": "The ID of the attachment account owner.", + "type": "string" + }, + "ProposedNetworkFunctionGroupChange": { + "$ref": "#/definitions/ProposedNetworkFunctionGroupChange", + "description": "The attachment to move from one network function group to another." + }, + "ProposedSegmentChange": { + "$ref": "#/definitions/ProposedSegmentChange", + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "description": "The attachment resource ARN.", + "type": "string" + }, + "SegmentName": { + "description": "The name of the segment attachment.", + "type": "string" + }, + "State": { + "description": "State of the attachment.", + "type": "string" + }, + "Tags": { + "description": "Tags for the attachment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TransportAttachmentId": { + "description": "Id of transport attachment", + "type": "string" + }, + "UpdatedAt": { + "description": "Last update time of the attachment.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CoreNetworkArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/AttachmentType", + "/properties/State", + "/properties/ResourceArn", + "/properties/AttachmentId", + "/properties/OwnerAccountId", + "/properties/AttachmentPolicyRuleNumber", + "/properties/SegmentName" + ], + "required": [ + "CoreNetworkId", + "EdgeLocation", + "TransportAttachmentId", + "Options" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-connectattachment", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::ConnectAttachment" +} diff --git a/schema/aws-networkmanager-connectpeer.json b/schema/aws-networkmanager-connectpeer.json index 8dcf775..1c1384c 100644 --- a/schema/aws-networkmanager-connectpeer.json +++ b/schema/aws-networkmanager-connectpeer.json @@ -1,237 +1,242 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ConnectAttachmentId", - "/properties/CoreNetworkAddress", - "/properties/InsideCidrBlocks" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PeerAddress", - "/properties/CoreNetworkAddress", - "/properties/BgpOptions", - "/properties/InsideCidrBlocks", - "/properties/ConnectAttachmentId", - "/properties/SubnetArn" - ], - "definitions": { - "BgpOptions": { - "additionalProperties": false, - "description": "Bgp options", - "properties": { - "PeerAsn": { - "type": "number" - } - }, - "type": "object" - }, - "ConnectPeerBgpConfiguration": { - "additionalProperties": false, - "description": "Bgp configuration for connect peer", - "properties": { - "CoreNetworkAddress": { - "description": "The address of a core network.", - "type": "string" - }, - "CoreNetworkAsn": { - "description": "The ASN of the Coret Network.", - "type": "number" - }, - "PeerAddress": { - "description": "The address of a core network Connect peer.", - "type": "string" - }, - "PeerAsn": { - "description": "The ASN of the Connect peer.", - "type": "number" - } - }, - "type": "object" - }, - "ConnectPeerConfiguration": { - "additionalProperties": false, - "properties": { - "BgpConfigurations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConnectPeerBgpConfiguration" - }, - "type": "array" - }, - "CoreNetworkAddress": { - "description": "The IP address of a core network.", - "type": "string" - }, - "InsideCidrBlocks": { - "description": "The inside IP addresses used for a Connect peer configuration.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "PeerAddress": { - "description": "The IP address of the Connect peer.", - "type": "string" - }, - "Protocol": { - "$ref": "#/definitions/TunnelProtocol" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TunnelProtocol": { - "description": "The protocol used for a Connect peer configuration.", - "type": "string" - } - }, - "description": "AWS::NetworkManager::ConnectPeer Resource Type Definition.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:GetConnectPeer", - "networkmanager:CreateConnectPeer", - "networkmanager:TagResource", - "ec2:DescribeRegions" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetConnectPeer", - "networkmanager:DeleteConnectPeer", - "ec2:DescribeRegions" - ] - }, - "list": { - "permissions": [ - "networkmanager:ListConnectPeers" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetConnectPeer" - ] - }, - "update": { - "permissions": [ - "networkmanager:GetConnectPeer", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectPeerId" - ], - "properties": { - "BgpOptions": { - "$ref": "#/definitions/BgpOptions", - "description": "Bgp options for connect peer." - }, - "Configuration": { - "$ref": "#/definitions/ConnectPeerConfiguration", - "description": "Configuration of the connect peer." - }, - "ConnectAttachmentId": { - "description": "The ID of the attachment to connect.", - "type": "string" - }, - "ConnectPeerId": { - "description": "The ID of the Connect peer.", - "type": "string" - }, - "CoreNetworkAddress": { - "description": "The IP address of a core network.", - "type": "string" - }, - "CoreNetworkId": { - "description": "The ID of the core network.", - "type": "string" - }, - "CreatedAt": { - "description": "Connect peer creation time.", - "type": "string" - }, - "EdgeLocation": { - "description": "The Connect peer Regions where edges are located.", - "type": "string" - }, - "InsideCidrBlocks": { - "description": "The inside IP addresses used for a Connect peer configuration.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "PeerAddress": { - "description": "The IP address of the Connect peer.", - "type": "string" - }, - "State": { - "description": "State of the connect peer.", - "type": "string" - }, - "SubnetArn": { - "description": "The subnet ARN for the connect peer.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/ConnectPeerId", - "/properties/State", - "/properties/CreatedAt", - "/properties/Configuration", - "/properties/CoreNetworkId", - "/properties/EdgeLocation" - ], - "required": [ - "ConnectAttachmentId", - "PeerAddress" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-connectpeer", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::ConnectPeer", - "writeOnlyProperties": [ - "/properties/CoreNetworkAddress", - "/properties/BgpOptions", - "/properties/SubnetArn" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ConnectAttachmentId", + "/properties/CoreNetworkAddress", + "/properties/InsideCidrBlocks" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PeerAddress", + "/properties/CoreNetworkAddress", + "/properties/BgpOptions", + "/properties/InsideCidrBlocks", + "/properties/ConnectAttachmentId", + "/properties/SubnetArn" + ], + "definitions": { + "BgpOptions": { + "additionalProperties": false, + "description": "Bgp options", + "properties": { + "PeerAsn": { + "type": "number" + } + }, + "type": "object" + }, + "ConnectPeerBgpConfiguration": { + "additionalProperties": false, + "description": "Bgp configuration for connect peer", + "properties": { + "CoreNetworkAddress": { + "description": "The address of a core network.", + "type": "string" + }, + "CoreNetworkAsn": { + "description": "The ASN of the Coret Network.", + "type": "number" + }, + "PeerAddress": { + "description": "The address of a core network Connect peer.", + "type": "string" + }, + "PeerAsn": { + "description": "The ASN of the Connect peer.", + "type": "number" + } + }, + "type": "object" + }, + "ConnectPeerConfiguration": { + "additionalProperties": false, + "properties": { + "BgpConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConnectPeerBgpConfiguration" + }, + "type": "array" + }, + "CoreNetworkAddress": { + "description": "The IP address of a core network.", + "type": "string" + }, + "InsideCidrBlocks": { + "description": "The inside IP addresses used for a Connect peer configuration.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "PeerAddress": { + "description": "The IP address of the Connect peer.", + "type": "string" + }, + "Protocol": { + "$ref": "#/definitions/TunnelProtocol" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TunnelProtocol": { + "description": "The protocol used for a Connect peer configuration.", + "type": "string" + } + }, + "description": "AWS::NetworkManager::ConnectPeer Resource Type Definition.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:GetConnectPeer", + "networkmanager:CreateConnectPeer", + "networkmanager:TagResource", + "ec2:DescribeRegions" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetConnectPeer", + "networkmanager:DeleteConnectPeer", + "ec2:DescribeRegions" + ] + }, + "list": { + "permissions": [ + "networkmanager:ListConnectPeers" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetConnectPeer" + ] + }, + "update": { + "permissions": [ + "networkmanager:GetConnectPeer", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectPeerId" + ], + "properties": { + "BgpOptions": { + "$ref": "#/definitions/BgpOptions", + "description": "Bgp options for connect peer." + }, + "Configuration": { + "$ref": "#/definitions/ConnectPeerConfiguration", + "description": "Configuration of the connect peer." + }, + "ConnectAttachmentId": { + "description": "The ID of the attachment to connect.", + "type": "string" + }, + "ConnectPeerId": { + "description": "The ID of the Connect peer.", + "type": "string" + }, + "CoreNetworkAddress": { + "description": "The IP address of a core network.", + "type": "string" + }, + "CoreNetworkId": { + "description": "The ID of the core network.", + "type": "string" + }, + "CreatedAt": { + "description": "Connect peer creation time.", + "type": "string" + }, + "EdgeLocation": { + "description": "The Connect peer Regions where edges are located.", + "type": "string" + }, + "InsideCidrBlocks": { + "description": "The inside IP addresses used for a Connect peer configuration.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "PeerAddress": { + "description": "The IP address of the Connect peer.", + "type": "string" + }, + "State": { + "description": "State of the connect peer.", + "type": "string" + }, + "SubnetArn": { + "description": "The subnet ARN for the connect peer.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ConnectPeerId", + "/properties/State", + "/properties/CreatedAt", + "/properties/Configuration", + "/properties/CoreNetworkId", + "/properties/EdgeLocation" + ], + "required": [ + "ConnectAttachmentId", + "PeerAddress" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-connectpeer", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::ConnectPeer", + "writeOnlyProperties": [ + "/properties/CoreNetworkAddress", + "/properties/BgpOptions", + "/properties/SubnetArn" + ] +} diff --git a/schema/aws-networkmanager-corenetwork.json b/schema/aws-networkmanager-corenetwork.json index f39da5c..19781e4 100644 --- a/schema/aws-networkmanager-corenetwork.json +++ b/schema/aws-networkmanager-corenetwork.json @@ -1,214 +1,268 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/CoreNetworkArn" - ], - [ - "/properties/GlobalNetworkId" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId" - ], - "definitions": { - "CoreNetworkEdge": { - "additionalProperties": false, - "properties": { - "Asn": { - "description": "The ASN of a core network edge.", - "type": "number" - }, - "EdgeLocation": { - "description": "The Region where a core network edge is located.", - "type": "string" - }, - "InsideCidrBlocks": { - "insertionOrder": false, - "items": { - "description": "The inside IP addresses used for core network edges.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CoreNetworkSegment": { - "additionalProperties": false, - "properties": { - "EdgeLocations": { - "insertionOrder": false, - "items": { - "description": "The Regions where the edges are located.", - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "Name of segment", - "type": "string" - }, - "SharedSegments": { - "insertionOrder": false, - "items": { - "description": "The shared segments of a core network.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::NetworkManager::CoreNetwork Resource Type Definition.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateCoreNetwork", - "networkmanager:GetCoreNetwork", - "networkmanager:GetCoreNetworkPolicy", - "networkmanager:TagResource", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 720 - }, - "delete": { - "permissions": [ - "networkmanager:DeleteCoreNetwork", - "networkmanager:UntagResource", - "networkmanager:GetCoreNetwork", - "networkmanager:GetCoreNetworkPolicy", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "networkmanager:ListCoreNetworks" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetCoreNetwork", - "networkmanager:GetCoreNetworkPolicy" - ] - }, - "update": { - "permissions": [ - "networkmanager:UpdateCoreNetwork", - "networkmanager:GetCoreNetwork", - "networkmanager:ListTagsForResource", - "networkmanager:PutCoreNetworkPolicy", - "networkmanager:GetCoreNetworkPolicy", - "networkmanager:ExecuteCoreNetworkChangeSet", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 720 - } - }, - "primaryIdentifier": [ - "/properties/CoreNetworkId" - ], - "properties": { - "CoreNetworkArn": { - "description": "The ARN (Amazon resource name) of core network", - "type": "string" - }, - "CoreNetworkId": { - "description": "The Id of core network", - "type": "string" - }, - "CreatedAt": { - "description": "The creation time of core network", - "type": "string" - }, - "Description": { - "description": "The description of core network", - "type": "string" - }, - "Edges": { - "description": "The edges within a core network.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CoreNetworkEdge" - }, - "type": "array" - }, - "GlobalNetworkId": { - "description": "The ID of the global network that your core network is a part of.", - "type": "string" - }, - "OwnerAccount": { - "description": "Owner of the core network", - "type": "string" - }, - "PolicyDocument": { - "description": "Live policy document for the core network, you must provide PolicyDocument in Json Format", - "type": "object" - }, - "Segments": { - "description": "The segments within a core network.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CoreNetworkSegment" - }, - "type": "array" - }, - "State": { - "description": "The state of core network", - "type": "string" - }, - "Tags": { - "description": "The tags for the global network.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/OwnerAccount", - "/properties/CoreNetworkId", - "/properties/CoreNetworkArn", - "/properties/CreatedAt", - "/properties/State", - "/properties/Segments", - "/properties/Edges" - ], - "required": [ - "GlobalNetworkId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-corenetwork", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::CoreNetwork" -} +{ + "additionalIdentifiers": [ + [ + "/properties/CoreNetworkArn" + ], + [ + "/properties/GlobalNetworkId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId" + ], + "definitions": { + "CoreNetworkEdge": { + "additionalProperties": false, + "properties": { + "Asn": { + "description": "The ASN of a core network edge.", + "type": "number" + }, + "EdgeLocation": { + "description": "The Region where a core network edge is located.", + "type": "string" + }, + "InsideCidrBlocks": { + "insertionOrder": false, + "items": { + "description": "The inside IP addresses used for core network edges.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CoreNetworkNetworkFunctionGroup": { + "additionalProperties": false, + "properties": { + "EdgeLocations": { + "insertionOrder": false, + "items": { + "description": "The Regions where the edges are located.", + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "Name of network function group", + "type": "string" + }, + "Segments": { + "additionalProperties": false, + "properties": { + "SendTo": { + "insertionOrder": false, + "items": { + "description": "The send-to segments.", + "type": "string" + }, + "type": "array" + }, + "SendVia": { + "insertionOrder": false, + "items": { + "description": "The send-via segments.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "CoreNetworkSegment": { + "additionalProperties": false, + "properties": { + "EdgeLocations": { + "insertionOrder": false, + "items": { + "description": "The Regions where the edges are located.", + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "Name of segment", + "type": "string" + }, + "SharedSegments": { + "insertionOrder": false, + "items": { + "description": "The shared segments of a core network.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::NetworkManager::CoreNetwork Resource Type Definition.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateCoreNetwork", + "networkmanager:GetCoreNetwork", + "networkmanager:GetCoreNetworkPolicy", + "networkmanager:TagResource", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "networkmanager:DeleteCoreNetwork", + "networkmanager:UntagResource", + "networkmanager:GetCoreNetwork", + "networkmanager:GetCoreNetworkPolicy", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "networkmanager:ListCoreNetworks" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetCoreNetwork", + "networkmanager:GetCoreNetworkPolicy" + ] + }, + "update": { + "permissions": [ + "networkmanager:UpdateCoreNetwork", + "networkmanager:GetCoreNetwork", + "networkmanager:ListTagsForResource", + "networkmanager:PutCoreNetworkPolicy", + "networkmanager:GetCoreNetworkPolicy", + "networkmanager:ExecuteCoreNetworkChangeSet", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/CoreNetworkId" + ], + "properties": { + "CoreNetworkArn": { + "description": "The ARN (Amazon resource name) of core network", + "type": "string" + }, + "CoreNetworkId": { + "description": "The Id of core network", + "type": "string" + }, + "CreatedAt": { + "description": "The creation time of core network", + "type": "string" + }, + "Description": { + "description": "The description of core network", + "type": "string" + }, + "Edges": { + "description": "The edges within a core network.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CoreNetworkEdge" + }, + "type": "array" + }, + "GlobalNetworkId": { + "description": "The ID of the global network that your core network is a part of.", + "type": "string" + }, + "NetworkFunctionGroups": { + "description": "The network function groups within a core network.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CoreNetworkNetworkFunctionGroup" + }, + "type": "array" + }, + "OwnerAccount": { + "description": "Owner of the core network", + "type": "string" + }, + "PolicyDocument": { + "description": "Live policy document for the core network, you must provide PolicyDocument in Json Format", + "type": "object" + }, + "Segments": { + "description": "The segments within a core network.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CoreNetworkSegment" + }, + "type": "array" + }, + "State": { + "description": "The state of core network", + "type": "string" + }, + "Tags": { + "description": "The tags for the global network.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/OwnerAccount", + "/properties/CoreNetworkId", + "/properties/CoreNetworkArn", + "/properties/CreatedAt", + "/properties/State", + "/properties/Segments", + "/properties/NetworkFunctionGroups", + "/properties/Edges" + ], + "required": [ + "GlobalNetworkId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-corenetwork", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::CoreNetwork" +} diff --git a/schema/aws-networkmanager-customergatewayassociation.json b/schema/aws-networkmanager-customergatewayassociation.json index b47cd7a..c319d16 100644 --- a/schema/aws-networkmanager-customergatewayassociation.json +++ b/schema/aws-networkmanager-customergatewayassociation.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId", - "/properties/CustomerGatewayArn", - "/properties/DeviceId", - "/properties/LinkId" - ], - "description": "The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:GetCustomerGatewayAssociations", - "networkmanager:AssociateCustomerGateway" - ] - }, - "delete": { - "permissions": [ - "networkmanager:DisassociateCustomerGateway" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetCustomerGatewayAssociations" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetCustomerGatewayAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/CustomerGatewayArn" - ], - "properties": { - "CustomerGatewayArn": { - "description": "The Amazon Resource Name (ARN) of the customer gateway.", - "type": "string" - }, - "DeviceId": { - "description": "The ID of the device", - "type": "string" - }, - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "LinkId": { - "description": "The ID of the link", - "type": "string" - } - }, - "required": [ - "GlobalNetworkId", - "CustomerGatewayArn", - "DeviceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::NetworkManager::CustomerGatewayAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId", + "/properties/CustomerGatewayArn", + "/properties/DeviceId", + "/properties/LinkId" + ], + "description": "The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:GetCustomerGatewayAssociations", + "networkmanager:AssociateCustomerGateway" + ] + }, + "delete": { + "permissions": [ + "networkmanager:DisassociateCustomerGateway" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetCustomerGatewayAssociations" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetCustomerGatewayAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/CustomerGatewayArn" + ], + "properties": { + "CustomerGatewayArn": { + "description": "The Amazon Resource Name (ARN) of the customer gateway.", + "type": "string" + }, + "DeviceId": { + "description": "The ID of the device", + "type": "string" + }, + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "LinkId": { + "description": "The ID of the link", + "type": "string" + } + }, + "required": [ + "GlobalNetworkId", + "CustomerGatewayArn", + "DeviceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::NetworkManager::CustomerGatewayAssociation" +} diff --git a/schema/aws-networkmanager-device.json b/schema/aws-networkmanager-device.json index 1387743..18d720b 100644 --- a/schema/aws-networkmanager-device.json +++ b/schema/aws-networkmanager-device.json @@ -1,196 +1,201 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/DeviceArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId" - ], - "definitions": { - "AWSLocation": { - "additionalProperties": false, - "description": "The Amazon Web Services location of the device, if applicable.", - "properties": { - "SubnetArn": { - "description": "The Amazon Resource Name (ARN) of the subnet that the device is located in.", - "type": "string" - }, - "Zone": { - "description": "The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.", - "type": "string" - } - }, - "type": "object" - }, - "Location": { - "additionalProperties": false, - "description": "The site location.", - "properties": { - "Address": { - "description": "The physical address.", - "type": "string" - }, - "Latitude": { - "description": "The latitude.", - "type": "string" - }, - "Longitude": { - "description": "The longitude.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a device resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::NetworkManager::Device type describes a device.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateDevice", - "networkmanager:GetDevices", - "networkmanager:TagResource" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetDevices", - "networkmanager:DeleteDevice" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetDevices" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetDevices" - ] - }, - "update": { - "permissions": [ - "networkmanager:UpdateDevice", - "networkmanager:ListTagsForResource", - "networkmanager:GetDevices", - "networkmanager:TagResource", - "networkmanager:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/DeviceId" - ], - "properties": { - "AWSLocation": { - "$ref": "#/definitions/AWSLocation", - "description": "The Amazon Web Services location of the device, if applicable." - }, - "CreatedAt": { - "description": "The date and time that the device was created.", - "type": "string" - }, - "Description": { - "description": "The description of the device.", - "type": "string" - }, - "DeviceArn": { - "description": "The Amazon Resource Name (ARN) of the device.", - "type": "string" - }, - "DeviceId": { - "description": "The ID of the device.", - "type": "string" - }, - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "Location": { - "$ref": "#/definitions/Location", - "description": "The site location." - }, - "Model": { - "description": "The device model", - "type": "string" - }, - "SerialNumber": { - "description": "The device serial number.", - "type": "string" - }, - "SiteId": { - "description": "The site ID.", - "type": "string" - }, - "State": { - "description": "The state of the device.", - "type": "string" - }, - "Tags": { - "description": "The tags for the device.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The device type.", - "type": "string" - }, - "Vendor": { - "description": "The device vendor.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DeviceId", - "/properties/DeviceArn", - "/properties/State", - "/properties/CreatedAt" - ], - "required": [ - "GlobalNetworkId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::Device" -} +{ + "additionalIdentifiers": [ + [ + "/properties/DeviceArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId" + ], + "definitions": { + "AWSLocation": { + "additionalProperties": false, + "description": "The Amazon Web Services location of the device, if applicable.", + "properties": { + "SubnetArn": { + "description": "The Amazon Resource Name (ARN) of the subnet that the device is located in.", + "type": "string" + }, + "Zone": { + "description": "The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.", + "type": "string" + } + }, + "type": "object" + }, + "Location": { + "additionalProperties": false, + "description": "The site location.", + "properties": { + "Address": { + "description": "The physical address.", + "type": "string" + }, + "Latitude": { + "description": "The latitude.", + "type": "string" + }, + "Longitude": { + "description": "The longitude.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a device resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::NetworkManager::Device type describes a device.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateDevice", + "networkmanager:GetDevices", + "networkmanager:TagResource" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetDevices", + "networkmanager:DeleteDevice" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetDevices" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetDevices" + ] + }, + "update": { + "permissions": [ + "networkmanager:UpdateDevice", + "networkmanager:ListTagsForResource", + "networkmanager:GetDevices", + "networkmanager:TagResource", + "networkmanager:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/DeviceId" + ], + "properties": { + "AWSLocation": { + "$ref": "#/definitions/AWSLocation", + "description": "The Amazon Web Services location of the device, if applicable." + }, + "CreatedAt": { + "description": "The date and time that the device was created.", + "type": "string" + }, + "Description": { + "description": "The description of the device.", + "type": "string" + }, + "DeviceArn": { + "description": "The Amazon Resource Name (ARN) of the device.", + "type": "string" + }, + "DeviceId": { + "description": "The ID of the device.", + "type": "string" + }, + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "Location": { + "$ref": "#/definitions/Location", + "description": "The site location." + }, + "Model": { + "description": "The device model", + "type": "string" + }, + "SerialNumber": { + "description": "The device serial number.", + "type": "string" + }, + "SiteId": { + "description": "The site ID.", + "type": "string" + }, + "State": { + "description": "The state of the device.", + "type": "string" + }, + "Tags": { + "description": "The tags for the device.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The device type.", + "type": "string" + }, + "Vendor": { + "description": "The device vendor.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DeviceId", + "/properties/DeviceArn", + "/properties/State", + "/properties/CreatedAt" + ], + "required": [ + "GlobalNetworkId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::Device" +} diff --git a/schema/aws-networkmanager-globalnetwork.json b/schema/aws-networkmanager-globalnetwork.json index 437ab0b..c961388 100644 --- a/schema/aws-networkmanager-globalnetwork.json +++ b/schema/aws-networkmanager-globalnetwork.json @@ -1,112 +1,117 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a global network resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateGlobalNetwork", - "networkmanager:DescribeGlobalNetworks", - "networkmanager:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "networkmanager:DeleteGlobalNetwork", - "networkmanager:DescribeGlobalNetworks" - ] - }, - "list": { - "permissions": [ - "networkmanager:DescribeGlobalNetworks" - ] - }, - "read": { - "permissions": [ - "networkmanager:DescribeGlobalNetworks" - ] - }, - "update": { - "permissions": [ - "networkmanager:UpdateGlobalNetwork", - "networkmanager:DescribeGlobalNetworks", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "networkmanager:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the global network.", - "type": "string" - }, - "CreatedAt": { - "description": "The date and time that the global network was created.", - "type": "string" - }, - "Description": { - "description": "The description of the global network.", - "type": "string" - }, - "Id": { - "description": "The ID of the global network.", - "type": "string" - }, - "State": { - "description": "The state of the global network.", - "type": "string" - }, - "Tags": { - "description": "The tags for the global network.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::GlobalNetwork" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a global network resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateGlobalNetwork", + "networkmanager:DescribeGlobalNetworks", + "networkmanager:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "networkmanager:DeleteGlobalNetwork", + "networkmanager:DescribeGlobalNetworks" + ] + }, + "list": { + "permissions": [ + "networkmanager:DescribeGlobalNetworks" + ] + }, + "read": { + "permissions": [ + "networkmanager:DescribeGlobalNetworks" + ] + }, + "update": { + "permissions": [ + "networkmanager:UpdateGlobalNetwork", + "networkmanager:DescribeGlobalNetworks", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the global network.", + "type": "string" + }, + "CreatedAt": { + "description": "The date and time that the global network was created.", + "type": "string" + }, + "Description": { + "description": "The description of the global network.", + "type": "string" + }, + "Id": { + "description": "The ID of the global network.", + "type": "string" + }, + "State": { + "description": "The state of the global network.", + "type": "string" + }, + "Tags": { + "description": "The tags for the global network.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::GlobalNetwork" +} diff --git a/schema/aws-networkmanager-link.json b/schema/aws-networkmanager-link.json index 2d60e13..b7eba4a 100644 --- a/schema/aws-networkmanager-link.json +++ b/schema/aws-networkmanager-link.json @@ -1,168 +1,173 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/LinkArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId", - "/properties/SiteId" - ], - "definitions": { - "Bandwidth": { - "additionalProperties": false, - "description": "The bandwidth for the link.", - "properties": { - "DownloadSpeed": { - "description": "Download speed in Mbps.", - "type": "integer" - }, - "UploadSpeed": { - "description": "Upload speed in Mbps.", - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a link resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::NetworkManager::Link type describes a link.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateLink", - "networkmanager:GetLinks", - "networkmanager:TagResource" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetLinks", - "networkmanager:DeleteLink" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetLinks" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetLinks" - ] - }, - "update": { - "permissions": [ - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:GetLinks", - "networkmanager:UntagResource", - "networkmanager:UpdateLink" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/LinkId" - ], - "properties": { - "Bandwidth": { - "$ref": "#/definitions/Bandwidth", - "description": "The Bandwidth for the link." - }, - "CreatedAt": { - "description": "The date and time that the device was created.", - "type": "string" - }, - "Description": { - "description": "The description of the link.", - "type": "string" - }, - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "LinkArn": { - "description": "The Amazon Resource Name (ARN) of the link.", - "type": "string" - }, - "LinkId": { - "description": "The ID of the link.", - "type": "string" - }, - "Provider": { - "description": "The provider of the link.", - "type": "string" - }, - "SiteId": { - "description": "The ID of the site", - "type": "string" - }, - "State": { - "description": "The state of the link.", - "type": "string" - }, - "Tags": { - "description": "The tags for the link.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of the link.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/LinkId", - "/properties/LinkArn", - "/properties/CreatedAt", - "/properties/State" - ], - "required": [ - "GlobalNetworkId", - "SiteId", - "Bandwidth" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::Link" -} +{ + "additionalIdentifiers": [ + [ + "/properties/LinkArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId", + "/properties/SiteId" + ], + "definitions": { + "Bandwidth": { + "additionalProperties": false, + "description": "The bandwidth for the link.", + "properties": { + "DownloadSpeed": { + "description": "Download speed in Mbps.", + "type": "integer" + }, + "UploadSpeed": { + "description": "Upload speed in Mbps.", + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a link resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::NetworkManager::Link type describes a link.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateLink", + "networkmanager:GetLinks", + "networkmanager:TagResource" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetLinks", + "networkmanager:DeleteLink" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetLinks" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetLinks" + ] + }, + "update": { + "permissions": [ + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:GetLinks", + "networkmanager:UntagResource", + "networkmanager:UpdateLink" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/LinkId" + ], + "properties": { + "Bandwidth": { + "$ref": "#/definitions/Bandwidth", + "description": "The Bandwidth for the link." + }, + "CreatedAt": { + "description": "The date and time that the device was created.", + "type": "string" + }, + "Description": { + "description": "The description of the link.", + "type": "string" + }, + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "LinkArn": { + "description": "The Amazon Resource Name (ARN) of the link.", + "type": "string" + }, + "LinkId": { + "description": "The ID of the link.", + "type": "string" + }, + "Provider": { + "description": "The provider of the link.", + "type": "string" + }, + "SiteId": { + "description": "The ID of the site", + "type": "string" + }, + "State": { + "description": "The state of the link.", + "type": "string" + }, + "Tags": { + "description": "The tags for the link.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of the link.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/LinkId", + "/properties/LinkArn", + "/properties/CreatedAt", + "/properties/State" + ], + "required": [ + "GlobalNetworkId", + "SiteId", + "Bandwidth" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::Link" +} diff --git a/schema/aws-networkmanager-linkassociation.json b/schema/aws-networkmanager-linkassociation.json index d47440d..8ccd27e 100644 --- a/schema/aws-networkmanager-linkassociation.json +++ b/schema/aws-networkmanager-linkassociation.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId", - "/properties/DeviceId", - "/properties/LinkId" - ], - "description": "The AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:GetLinkAssociations", - "networkmanager:AssociateLink" - ] - }, - "delete": { - "permissions": [ - "networkmanager:DisassociateLink" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetLinkAssociations" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetLinkAssociations" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/DeviceId", - "/properties/LinkId" - ], - "properties": { - "DeviceId": { - "description": "The ID of the device", - "type": "string" - }, - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "LinkId": { - "description": "The ID of the link", - "type": "string" - } - }, - "required": [ - "GlobalNetworkId", - "DeviceId", - "LinkId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::NetworkManager::LinkAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId", + "/properties/DeviceId", + "/properties/LinkId" + ], + "description": "The AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:GetLinkAssociations", + "networkmanager:AssociateLink" + ] + }, + "delete": { + "permissions": [ + "networkmanager:DisassociateLink" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetLinkAssociations" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetLinkAssociations" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/DeviceId", + "/properties/LinkId" + ], + "properties": { + "DeviceId": { + "description": "The ID of the device", + "type": "string" + }, + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "LinkId": { + "description": "The ID of the link", + "type": "string" + } + }, + "required": [ + "GlobalNetworkId", + "DeviceId", + "LinkId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::NetworkManager::LinkAssociation" +} diff --git a/schema/aws-networkmanager-site.json b/schema/aws-networkmanager-site.json index e0af347..f210ccc 100644 --- a/schema/aws-networkmanager-site.json +++ b/schema/aws-networkmanager-site.json @@ -1,157 +1,162 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/SiteArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId" - ], - "definitions": { - "Location": { - "additionalProperties": false, - "description": "The location of the site", - "properties": { - "Address": { - "description": "The physical address.", - "type": "string" - }, - "Latitude": { - "description": "The latitude.", - "type": "string" - }, - "Longitude": { - "description": "The longitude.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a site resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::NetworkManager::Site type describes a site.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateSite", - "networkmanager:GetSites", - "networkmanager:TagResource" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetSites", - "networkmanager:DeleteSite" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetSites" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetSites" - ] - }, - "update": { - "permissions": [ - "networkmanager:GetSites", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "networkmanager:UpdateSite" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/SiteId" - ], - "properties": { - "CreatedAt": { - "description": "The date and time that the device was created.", - "type": "string" - }, - "Description": { - "description": "The description of the site.", - "type": "string" - }, - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "Location": { - "$ref": "#/definitions/Location", - "description": "The location of the site." - }, - "SiteArn": { - "description": "The Amazon Resource Name (ARN) of the site.", - "type": "string" - }, - "SiteId": { - "description": "The ID of the site.", - "type": "string" - }, - "State": { - "description": "The state of the site.", - "type": "string" - }, - "Tags": { - "description": "The tags for the site.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/SiteId", - "/properties/SiteArn", - "/properties/State", - "/properties/CreatedAt" - ], - "required": [ - "GlobalNetworkId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::Site" -} +{ + "additionalIdentifiers": [ + [ + "/properties/SiteArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId" + ], + "definitions": { + "Location": { + "additionalProperties": false, + "description": "The location of the site", + "properties": { + "Address": { + "description": "The physical address.", + "type": "string" + }, + "Latitude": { + "description": "The latitude.", + "type": "string" + }, + "Longitude": { + "description": "The longitude.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a site resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::NetworkManager::Site type describes a site.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateSite", + "networkmanager:GetSites", + "networkmanager:TagResource" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetSites", + "networkmanager:DeleteSite" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetSites" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetSites" + ] + }, + "update": { + "permissions": [ + "networkmanager:GetSites", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:UpdateSite" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/SiteId" + ], + "properties": { + "CreatedAt": { + "description": "The date and time that the device was created.", + "type": "string" + }, + "Description": { + "description": "The description of the site.", + "type": "string" + }, + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "Location": { + "$ref": "#/definitions/Location", + "description": "The location of the site." + }, + "SiteArn": { + "description": "The Amazon Resource Name (ARN) of the site.", + "type": "string" + }, + "SiteId": { + "description": "The ID of the site.", + "type": "string" + }, + "State": { + "description": "The state of the site.", + "type": "string" + }, + "Tags": { + "description": "The tags for the site.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/SiteId", + "/properties/SiteArn", + "/properties/State", + "/properties/CreatedAt" + ], + "required": [ + "GlobalNetworkId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::Site" +} diff --git a/schema/aws-networkmanager-sitetositevpnattachment.json b/schema/aws-networkmanager-sitetositevpnattachment.json index fa48636..972d631 100644 --- a/schema/aws-networkmanager-sitetositevpnattachment.json +++ b/schema/aws-networkmanager-sitetositevpnattachment.json @@ -1,193 +1,230 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/CoreNetworkId", - "/properties/VpnConnectionArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CoreNetworkId", - "/properties/VpnConnectionArn" - ], - "definitions": { - "ProposedSegmentChange": { - "additionalProperties": false, - "description": "The attachment to move from one segment to another.", - "properties": { - "AttachmentPolicyRuleNumber": { - "description": "The rule number in the policy document that applies to this change.", - "type": "integer" - }, - "SegmentName": { - "description": "The name of the segment to change.", - "type": "string" - }, - "Tags": { - "description": "The key-value tags that changed for the segment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:GetSiteToSiteVpnAttachment", - "networkmanager:CreateSiteToSiteVpnAttachment", - "ec2:DescribeRegions", - "networkmanager:TagResource" - ], - "timeoutInMinutes": 40 - }, - "delete": { - "permissions": [ - "networkmanager:GetSiteToSiteVpnAttachment", - "networkmanager:DeleteAttachment", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 720 - }, - "list": { - "permissions": [ - "networkmanager:ListAttachments" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetSiteToSiteVpnAttachment" - ] - }, - "update": { - "permissions": [ - "networkmanager:GetSiteToSiteVpnAttachment", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentId" - ], - "properties": { - "AttachmentId": { - "description": "The ID of the attachment.", - "type": "string" - }, - "AttachmentPolicyRuleNumber": { - "description": "The policy rule number associated with the attachment.", - "type": "integer" - }, - "AttachmentType": { - "description": "The type of attachment.", - "type": "string" - }, - "CoreNetworkArn": { - "description": "The ARN of a core network for the VPC attachment.", - "type": "string" - }, - "CoreNetworkId": { - "description": "The ID of a core network where you're creating a site-to-site VPN attachment.", - "type": "string" - }, - "CreatedAt": { - "description": "Creation time of the attachment.", - "type": "string" - }, - "EdgeLocation": { - "description": "The Region where the edge is located.", - "type": "string" - }, - "OwnerAccountId": { - "description": "Owner account of the attachment.", - "type": "string" - }, - "ProposedSegmentChange": { - "$ref": "#/definitions/ProposedSegmentChange", - "description": "The attachment to move from one segment to another." - }, - "ResourceArn": { - "description": "The ARN of the Resource.", - "type": "string" - }, - "SegmentName": { - "description": "The name of the segment that attachment is in.", - "type": "string" - }, - "State": { - "description": "The state of the attachment.", - "type": "string" - }, - "Tags": { - "description": "Tags for the attachment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "description": "Last update time of the attachment.", - "type": "string" - }, - "VpnConnectionArn": { - "description": "The ARN of the site-to-site VPN attachment.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CoreNetworkArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/AttachmentType", - "/properties/State", - "/properties/ResourceArn", - "/properties/AttachmentId", - "/properties/OwnerAccountId", - "/properties/EdgeLocation", - "/properties/AttachmentPolicyRuleNumber", - "/properties/SegmentName" - ], - "required": [ - "CoreNetworkId", - "VpnConnectionArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-sitetositevpnattachment", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::SiteToSiteVpnAttachment" -} +{ + "additionalIdentifiers": [ + [ + "/properties/CoreNetworkId", + "/properties/VpnConnectionArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CoreNetworkId", + "/properties/VpnConnectionArn" + ], + "definitions": { + "ProposedNetworkFunctionGroupChange": { + "additionalProperties": false, + "description": "The attachment to move from one network function group to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the network function group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ProposedSegmentChange": { + "additionalProperties": false, + "description": "The attachment to move from one segment to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "SegmentName": { + "description": "The name of the segment to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the segment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:GetSiteToSiteVpnAttachment", + "networkmanager:CreateSiteToSiteVpnAttachment", + "ec2:DescribeRegions", + "networkmanager:TagResource" + ], + "timeoutInMinutes": 40 + }, + "delete": { + "permissions": [ + "networkmanager:GetSiteToSiteVpnAttachment", + "networkmanager:DeleteAttachment", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "networkmanager:ListAttachments" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetSiteToSiteVpnAttachment" + ] + }, + "update": { + "permissions": [ + "networkmanager:GetSiteToSiteVpnAttachment", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentId" + ], + "properties": { + "AttachmentId": { + "description": "The ID of the attachment.", + "type": "string" + }, + "AttachmentPolicyRuleNumber": { + "description": "The policy rule number associated with the attachment.", + "type": "integer" + }, + "AttachmentType": { + "description": "The type of attachment.", + "type": "string" + }, + "CoreNetworkArn": { + "description": "The ARN of a core network for the VPC attachment.", + "type": "string" + }, + "CoreNetworkId": { + "description": "The ID of a core network where you're creating a site-to-site VPN attachment.", + "type": "string" + }, + "CreatedAt": { + "description": "Creation time of the attachment.", + "type": "string" + }, + "EdgeLocation": { + "description": "The Region where the edge is located.", + "type": "string" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group attachment.", + "type": "string" + }, + "OwnerAccountId": { + "description": "Owner account of the attachment.", + "type": "string" + }, + "ProposedNetworkFunctionGroupChange": { + "$ref": "#/definitions/ProposedNetworkFunctionGroupChange", + "description": "The attachment to move from one network function group to another." + }, + "ProposedSegmentChange": { + "$ref": "#/definitions/ProposedSegmentChange", + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "description": "The ARN of the Resource.", + "type": "string" + }, + "SegmentName": { + "description": "The name of the segment that attachment is in.", + "type": "string" + }, + "State": { + "description": "The state of the attachment.", + "type": "string" + }, + "Tags": { + "description": "Tags for the attachment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "Last update time of the attachment.", + "type": "string" + }, + "VpnConnectionArn": { + "description": "The ARN of the site-to-site VPN attachment.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CoreNetworkArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/AttachmentType", + "/properties/State", + "/properties/ResourceArn", + "/properties/AttachmentId", + "/properties/OwnerAccountId", + "/properties/EdgeLocation", + "/properties/AttachmentPolicyRuleNumber", + "/properties/SegmentName" + ], + "required": [ + "CoreNetworkId", + "VpnConnectionArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-sitetositevpnattachment", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::SiteToSiteVpnAttachment" +} diff --git a/schema/aws-networkmanager-transitgatewaypeering.json b/schema/aws-networkmanager-transitgatewaypeering.json index 4022f42..9df421b 100644 --- a/schema/aws-networkmanager-transitgatewaypeering.json +++ b/schema/aws-networkmanager-transitgatewaypeering.json @@ -1,157 +1,162 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CoreNetworkId", - "/properties/TransitGatewayArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::NetworkManager::TransitGatewayPeering Resoruce Type.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateTransitGatewayPeering", - "networkmanager:TagResource", - "networkmanager:GetTransitGatewayPeering", - "iam:CreateServiceLinkedRole", - "ec2:CreateTransitGatewayPeeringAttachment", - "ec2:AcceptTransitGatewayPeeringAttachment", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "networkmanager:DeletePeering", - "networkmanager:GetTransitGatewayPeering", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "networkmanager:ListPeerings" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetTransitGatewayPeering", - "networkmanager:TagResource" - ] - }, - "update": { - "permissions": [ - "networkmanager:TagResource", - "networkmanager:UntagResource", - "networkmanager:ListTagsForResource", - "networkmanager:GetTransitGatewayPeering", - "ec2:DescribeRegions" - ] - } - }, - "primaryIdentifier": [ - "/properties/PeeringId" - ], - "properties": { - "CoreNetworkArn": { - "description": "The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.", - "type": "string" - }, - "CoreNetworkId": { - "description": "The Id of the core network that you want to peer a transit gateway to.", - "type": "string" - }, - "CreatedAt": { - "description": "The creation time of the transit gateway peering", - "type": "string" - }, - "EdgeLocation": { - "description": "The location of the transit gateway peering", - "type": "string" - }, - "OwnerAccountId": { - "description": "Peering owner account Id", - "type": "string" - }, - "PeeringId": { - "description": "The Id of the transit gateway peering", - "type": "string" - }, - "PeeringType": { - "description": "Peering type (TransitGatewayPeering)", - "type": "string" - }, - "ResourceArn": { - "description": "The ARN (Amazon Resource Name) of the resource that you will peer to a core network", - "type": "string" - }, - "State": { - "description": "The state of the transit gateway peering", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TransitGatewayArn": { - "description": "The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network", - "type": "string" - }, - "TransitGatewayPeeringAttachmentId": { - "description": "The ID of the TransitGatewayPeeringAttachment", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CoreNetworkArn", - "/properties/PeeringId", - "/properties/State", - "/properties/PeeringType", - "/properties/OwnerAccountId", - "/properties/EdgeLocation", - "/properties/ResourceArn", - "/properties/CreatedAt", - "/properties/TransitGatewayPeeringAttachmentId" - ], - "required": [ - "CoreNetworkId", - "TransitGatewayArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-transitgatewaypeering", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::TransitGatewayPeering" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CoreNetworkId", + "/properties/TransitGatewayArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::NetworkManager::TransitGatewayPeering Resoruce Type.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateTransitGatewayPeering", + "networkmanager:TagResource", + "networkmanager:GetTransitGatewayPeering", + "iam:CreateServiceLinkedRole", + "ec2:CreateTransitGatewayPeeringAttachment", + "ec2:AcceptTransitGatewayPeeringAttachment", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "networkmanager:DeletePeering", + "networkmanager:GetTransitGatewayPeering", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "networkmanager:ListPeerings" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetTransitGatewayPeering", + "networkmanager:TagResource" + ] + }, + "update": { + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource", + "networkmanager:GetTransitGatewayPeering", + "ec2:DescribeRegions" + ] + } + }, + "primaryIdentifier": [ + "/properties/PeeringId" + ], + "properties": { + "CoreNetworkArn": { + "description": "The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.", + "type": "string" + }, + "CoreNetworkId": { + "description": "The Id of the core network that you want to peer a transit gateway to.", + "type": "string" + }, + "CreatedAt": { + "description": "The creation time of the transit gateway peering", + "type": "string" + }, + "EdgeLocation": { + "description": "The location of the transit gateway peering", + "type": "string" + }, + "OwnerAccountId": { + "description": "Peering owner account Id", + "type": "string" + }, + "PeeringId": { + "description": "The Id of the transit gateway peering", + "type": "string" + }, + "PeeringType": { + "description": "Peering type (TransitGatewayPeering)", + "type": "string" + }, + "ResourceArn": { + "description": "The ARN (Amazon Resource Name) of the resource that you will peer to a core network", + "type": "string" + }, + "State": { + "description": "The state of the transit gateway peering", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TransitGatewayArn": { + "description": "The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network", + "type": "string" + }, + "TransitGatewayPeeringAttachmentId": { + "description": "The ID of the TransitGatewayPeeringAttachment", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CoreNetworkArn", + "/properties/PeeringId", + "/properties/State", + "/properties/PeeringType", + "/properties/OwnerAccountId", + "/properties/EdgeLocation", + "/properties/ResourceArn", + "/properties/CreatedAt", + "/properties/TransitGatewayPeeringAttachmentId" + ], + "required": [ + "CoreNetworkId", + "TransitGatewayArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-transitgatewaypeering", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::TransitGatewayPeering" +} diff --git a/schema/aws-networkmanager-transitgatewayregistration.json b/schema/aws-networkmanager-transitgatewayregistration.json index 8e67bf3..4a722e9 100644 --- a/schema/aws-networkmanager-transitgatewayregistration.json +++ b/schema/aws-networkmanager-transitgatewayregistration.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalNetworkId", - "/properties/TransitGatewayArn" - ], - "description": "The AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:RegisterTransitGateway", - "networkmanager:GetTransitGatewayRegistrations" - ], - "timeoutInMinutes": 30 - }, - "delete": { - "permissions": [ - "networkmanager:DeregisterTransitGateway", - "networkmanager:GetTransitGatewayRegistrations" - ], - "timeoutInMinutes": 30 - }, - "list": { - "handlerSchema": { - "properties": { - "GlobalNetworkId": { - "$ref": "resource-schema.json#/properties/GlobalNetworkId" - } - }, - "required": [ - "GlobalNetworkId" - ] - }, - "permissions": [ - "networkmanager:GetTransitGatewayRegistrations" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetTransitGatewayRegistrations" - ] - } - }, - "primaryIdentifier": [ - "/properties/GlobalNetworkId", - "/properties/TransitGatewayArn" - ], - "properties": { - "GlobalNetworkId": { - "description": "The ID of the global network.", - "type": "string" - }, - "TransitGatewayArn": { - "description": "The Amazon Resource Name (ARN) of the transit gateway.", - "type": "string" - } - }, - "required": [ - "GlobalNetworkId", - "TransitGatewayArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::NetworkManager::TransitGatewayRegistration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalNetworkId", + "/properties/TransitGatewayArn" + ], + "description": "The AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:RegisterTransitGateway", + "networkmanager:GetTransitGatewayRegistrations" + ], + "timeoutInMinutes": 30 + }, + "delete": { + "permissions": [ + "networkmanager:DeregisterTransitGateway", + "networkmanager:GetTransitGatewayRegistrations" + ], + "timeoutInMinutes": 30 + }, + "list": { + "handlerSchema": { + "properties": { + "GlobalNetworkId": { + "$ref": "resource-schema.json#/properties/GlobalNetworkId" + } + }, + "required": [ + "GlobalNetworkId" + ] + }, + "permissions": [ + "networkmanager:GetTransitGatewayRegistrations" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetTransitGatewayRegistrations" + ] + } + }, + "primaryIdentifier": [ + "/properties/GlobalNetworkId", + "/properties/TransitGatewayArn" + ], + "properties": { + "GlobalNetworkId": { + "description": "The ID of the global network.", + "type": "string" + }, + "TransitGatewayArn": { + "description": "The Amazon Resource Name (ARN) of the transit gateway.", + "type": "string" + } + }, + "required": [ + "GlobalNetworkId", + "TransitGatewayArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::NetworkManager::TransitGatewayRegistration" +} diff --git a/schema/aws-networkmanager-transitgatewayroutetableattachment.json b/schema/aws-networkmanager-transitgatewayroutetableattachment.json index eb2ed01..2dcce0a 100644 --- a/schema/aws-networkmanager-transitgatewayroutetableattachment.json +++ b/schema/aws-networkmanager-transitgatewayroutetableattachment.json @@ -1,192 +1,229 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PeeringId", - "/properties/TransitGatewayRouteTableArn" - ], - "definitions": { - "ProposedSegmentChange": { - "additionalProperties": false, - "description": "The attachment to move from one segment to another.", - "properties": { - "AttachmentPolicyRuleNumber": { - "description": "The rule number in the policy document that applies to this change.", - "type": "integer" - }, - "SegmentName": { - "description": "The name of the segment to change.", - "type": "string" - }, - "Tags": { - "description": "The key-value tags that changed for the segment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "insertionOrder": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "AWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateTransitGatewayRouteTableAttachment", - "networkmanager:GetTransitGatewayRouteTableAttachment", - "networkmanager:TagResource", - "iam:CreateServiceLinkedRole", - "ec2:DescribeRegions" - ] - }, - "delete": { - "permissions": [ - "networkmanager:GetTransitGatewayRouteTableAttachment", - "networkmanager:DeleteAttachment", - "ec2:DescribeRegions" - ] - }, - "list": { - "permissions": [ - "networkmanager:ListAttachments" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetTransitGatewayRouteTableAttachment" - ] - }, - "update": { - "permissions": [ - "networkmanager:GetTransitGatewayRouteTableAttachment", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ] - } - }, - "primaryIdentifier": [ - "/properties/AttachmentId" - ], - "properties": { - "AttachmentId": { - "description": "The ID of the attachment.", - "type": "string" - }, - "AttachmentPolicyRuleNumber": { - "description": "The policy rule number associated with the attachment.", - "type": "integer" - }, - "AttachmentType": { - "description": "The type of attachment.", - "type": "string" - }, - "CoreNetworkArn": { - "description": "The ARN of a core network for the VPC attachment.", - "type": "string" - }, - "CoreNetworkId": { - "description": "The ID of a core network where you're creating a site-to-site VPN attachment.", - "type": "string" - }, - "CreatedAt": { - "description": "Creation time of the attachment.", - "type": "string" - }, - "EdgeLocation": { - "description": "The Region where the edge is located.", - "type": "string" - }, - "OwnerAccountId": { - "description": "Owner account of the attachment.", - "type": "string" - }, - "PeeringId": { - "description": "The Id of peering between transit gateway and core network.", - "type": "string" - }, - "ProposedSegmentChange": { - "$ref": "#/definitions/ProposedSegmentChange", - "description": "The attachment to move from one segment to another." - }, - "ResourceArn": { - "description": "The ARN of the Resource.", - "type": "string" - }, - "SegmentName": { - "description": "The name of the segment that attachment is in.", - "type": "string" - }, - "State": { - "description": "The state of the attachment.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TransitGatewayRouteTableArn": { - "description": "The Arn of transit gateway route table.", - "type": "string" - }, - "UpdatedAt": { - "description": "Last update time of the attachment.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CoreNetworkArn", - "/properties/CoreNetworkId", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/AttachmentType", - "/properties/State", - "/properties/ResourceArn", - "/properties/AttachmentId", - "/properties/OwnerAccountId", - "/properties/EdgeLocation", - "/properties/AttachmentPolicyRuleNumber", - "/properties/SegmentName" - ], - "required": [ - "PeeringId", - "TransitGatewayRouteTableArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-transitgatewayroutetableattachment", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::TransitGatewayRouteTableAttachment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PeeringId", + "/properties/TransitGatewayRouteTableArn" + ], + "definitions": { + "ProposedNetworkFunctionGroupChange": { + "additionalProperties": false, + "description": "The attachment to move from one network function group to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the network function group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ProposedSegmentChange": { + "additionalProperties": false, + "description": "The attachment to move from one segment to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "SegmentName": { + "description": "The name of the segment to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the segment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "insertionOrder": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateTransitGatewayRouteTableAttachment", + "networkmanager:GetTransitGatewayRouteTableAttachment", + "networkmanager:TagResource", + "iam:CreateServiceLinkedRole", + "ec2:DescribeRegions" + ] + }, + "delete": { + "permissions": [ + "networkmanager:GetTransitGatewayRouteTableAttachment", + "networkmanager:DeleteAttachment", + "ec2:DescribeRegions" + ] + }, + "list": { + "permissions": [ + "networkmanager:ListAttachments" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetTransitGatewayRouteTableAttachment" + ] + }, + "update": { + "permissions": [ + "networkmanager:GetTransitGatewayRouteTableAttachment", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentId" + ], + "properties": { + "AttachmentId": { + "description": "The ID of the attachment.", + "type": "string" + }, + "AttachmentPolicyRuleNumber": { + "description": "The policy rule number associated with the attachment.", + "type": "integer" + }, + "AttachmentType": { + "description": "The type of attachment.", + "type": "string" + }, + "CoreNetworkArn": { + "description": "The ARN of a core network for the VPC attachment.", + "type": "string" + }, + "CoreNetworkId": { + "description": "The ID of a core network where you're creating a site-to-site VPN attachment.", + "type": "string" + }, + "CreatedAt": { + "description": "Creation time of the attachment.", + "type": "string" + }, + "EdgeLocation": { + "description": "The Region where the edge is located.", + "type": "string" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group attachment.", + "type": "string" + }, + "OwnerAccountId": { + "description": "Owner account of the attachment.", + "type": "string" + }, + "PeeringId": { + "description": "The Id of peering between transit gateway and core network.", + "type": "string" + }, + "ProposedNetworkFunctionGroupChange": { + "$ref": "#/definitions/ProposedNetworkFunctionGroupChange", + "description": "The attachment to move from one network function group to another." + }, + "ProposedSegmentChange": { + "$ref": "#/definitions/ProposedSegmentChange", + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "description": "The ARN of the Resource.", + "type": "string" + }, + "SegmentName": { + "description": "The name of the segment that attachment is in.", + "type": "string" + }, + "State": { + "description": "The state of the attachment.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TransitGatewayRouteTableArn": { + "description": "The Arn of transit gateway route table.", + "type": "string" + }, + "UpdatedAt": { + "description": "Last update time of the attachment.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CoreNetworkArn", + "/properties/CoreNetworkId", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/AttachmentType", + "/properties/State", + "/properties/ResourceArn", + "/properties/AttachmentId", + "/properties/OwnerAccountId", + "/properties/EdgeLocation", + "/properties/AttachmentPolicyRuleNumber", + "/properties/SegmentName" + ], + "required": [ + "PeeringId", + "TransitGatewayRouteTableArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-transitgatewayroutetableattachment", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::TransitGatewayRouteTableAttachment" +} diff --git a/schema/aws-networkmanager-vpcattachment.json b/schema/aws-networkmanager-vpcattachment.json index 8ca0cdd..ef9857b 100644 --- a/schema/aws-networkmanager-vpcattachment.json +++ b/schema/aws-networkmanager-vpcattachment.json @@ -1,227 +1,265 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/CoreNetworkId", - "/properties/VpcArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CoreNetworkId", - "/properties/VpcArn" - ], - "definitions": { - "ProposedSegmentChange": { - "additionalProperties": false, - "description": "The attachment to move from one segment to another.", - "properties": { - "AttachmentPolicyRuleNumber": { - "description": "The rule number in the policy document that applies to this change.", - "type": "integer" - }, - "SegmentName": { - "description": "The name of the segment to change.", - "type": "string" - }, - "Tags": { - "description": "The key-value tags that changed for the segment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcOptions": { - "additionalProperties": false, - "description": "Vpc options of the attachment.", - "properties": { - "ApplianceModeSupport": { - "default": false, - "description": "Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false", - "type": "boolean" - }, - "Ipv6Support": { - "default": false, - "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "AWS::NetworkManager::VpcAttachment Resoruce Type", - "handlers": { - "create": { - "permissions": [ - "networkmanager:CreateVpcAttachment", - "networkmanager:GetVpcAttachment", - "networkmanager:TagResource", - "ec2:DescribeRegions", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "networkmanager:DeleteAttachment", - "networkmanager:GetVpcAttachment", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "networkmanager:ListAttachments" - ] - }, - "read": { - "permissions": [ - "networkmanager:GetVpcAttachment" - ] - }, - "update": { - "permissions": [ - "networkmanager:UpdateVpcAttachment", - "networkmanager:GetVpcAttachment", - "networkmanager:ListTagsForResource", - "networkmanager:TagResource", - "networkmanager:UntagResource", - "ec2:DescribeRegions" - ], - "timeoutInMinutes": 60 - } - }, - "primaryIdentifier": [ - "/properties/AttachmentId" - ], - "properties": { - "AttachmentId": { - "description": "Id of the attachment.", - "type": "string" - }, - "AttachmentPolicyRuleNumber": { - "description": "The policy rule number associated with the attachment.", - "type": "integer" - }, - "AttachmentType": { - "description": "Attachment type.", - "type": "string" - }, - "CoreNetworkArn": { - "description": "The ARN of a core network for the VPC attachment.", - "type": "string" - }, - "CoreNetworkId": { - "description": "The ID of a core network for the VPC attachment.", - "type": "string" - }, - "CreatedAt": { - "description": "Creation time of the attachment.", - "type": "string" - }, - "EdgeLocation": { - "description": "The Region where the edge is located.", - "type": "string" - }, - "Options": { - "$ref": "#/definitions/VpcOptions", - "description": "Vpc options of the attachment." - }, - "OwnerAccountId": { - "description": "Owner account of the attachment.", - "type": "string" - }, - "ProposedSegmentChange": { - "$ref": "#/definitions/ProposedSegmentChange", - "description": "The attachment to move from one segment to another." - }, - "ResourceArn": { - "description": "The ARN of the Resource.", - "type": "string" - }, - "SegmentName": { - "description": "The name of the segment attachment..", - "type": "string" - }, - "State": { - "description": "State of the attachment.", - "type": "string" - }, - "SubnetArns": { - "description": "Subnet Arn list", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "description": "Tags for the attachment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "description": "Last update time of the attachment.", - "type": "string" - }, - "VpcArn": { - "description": "The ARN of the VPC.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CoreNetworkArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/AttachmentType", - "/properties/State", - "/properties/AttachmentId", - "/properties/OwnerAccountId", - "/properties/EdgeLocation", - "/properties/AttachmentPolicyRuleNumber", - "/properties/SegmentName", - "/properties/ResourceArn" - ], - "required": [ - "CoreNetworkId", - "VpcArn", - "SubnetArns" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-vpcattachment", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::NetworkManager::VpcAttachment" -} +{ + "additionalIdentifiers": [ + [ + "/properties/CoreNetworkId", + "/properties/VpcArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CoreNetworkId", + "/properties/VpcArn" + ], + "definitions": { + "ProposedNetworkFunctionGroupChange": { + "additionalProperties": false, + "description": "The attachment to move from one network function group to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the network function group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ProposedSegmentChange": { + "additionalProperties": false, + "description": "The attachment to move from one segment to another.", + "properties": { + "AttachmentPolicyRuleNumber": { + "description": "The rule number in the policy document that applies to this change.", + "type": "integer" + }, + "SegmentName": { + "description": "The name of the segment to change.", + "type": "string" + }, + "Tags": { + "description": "The key-value tags that changed for the segment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcOptions": { + "additionalProperties": false, + "description": "Vpc options of the attachment.", + "properties": { + "ApplianceModeSupport": { + "default": false, + "description": "Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false", + "type": "boolean" + }, + "Ipv6Support": { + "default": false, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable", + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "AWS::NetworkManager::VpcAttachment Resoruce Type", + "handlers": { + "create": { + "permissions": [ + "networkmanager:CreateVpcAttachment", + "networkmanager:GetVpcAttachment", + "networkmanager:TagResource", + "ec2:DescribeRegions", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "networkmanager:DeleteAttachment", + "networkmanager:GetVpcAttachment", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "networkmanager:ListAttachments" + ] + }, + "read": { + "permissions": [ + "networkmanager:GetVpcAttachment" + ] + }, + "update": { + "permissions": [ + "networkmanager:UpdateVpcAttachment", + "networkmanager:GetVpcAttachment", + "networkmanager:ListTagsForResource", + "networkmanager:TagResource", + "networkmanager:UntagResource", + "ec2:DescribeRegions" + ], + "timeoutInMinutes": 60 + } + }, + "primaryIdentifier": [ + "/properties/AttachmentId" + ], + "properties": { + "AttachmentId": { + "description": "Id of the attachment.", + "type": "string" + }, + "AttachmentPolicyRuleNumber": { + "description": "The policy rule number associated with the attachment.", + "type": "integer" + }, + "AttachmentType": { + "description": "Attachment type.", + "type": "string" + }, + "CoreNetworkArn": { + "description": "The ARN of a core network for the VPC attachment.", + "type": "string" + }, + "CoreNetworkId": { + "description": "The ID of a core network for the VPC attachment.", + "type": "string" + }, + "CreatedAt": { + "description": "Creation time of the attachment.", + "type": "string" + }, + "EdgeLocation": { + "description": "The Region where the edge is located.", + "type": "string" + }, + "NetworkFunctionGroupName": { + "description": "The name of the network function group attachment.", + "type": "string" + }, + "Options": { + "$ref": "#/definitions/VpcOptions", + "description": "Vpc options of the attachment." + }, + "OwnerAccountId": { + "description": "Owner account of the attachment.", + "type": "string" + }, + "ProposedNetworkFunctionGroupChange": { + "$ref": "#/definitions/ProposedNetworkFunctionGroupChange", + "description": "The attachment to move from one network function group to another." + }, + "ProposedSegmentChange": { + "$ref": "#/definitions/ProposedSegmentChange", + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "description": "The ARN of the Resource.", + "type": "string" + }, + "SegmentName": { + "description": "The name of the segment attachment..", + "type": "string" + }, + "State": { + "description": "State of the attachment.", + "type": "string" + }, + "SubnetArns": { + "description": "Subnet Arn list", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "description": "Tags for the attachment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "Last update time of the attachment.", + "type": "string" + }, + "VpcArn": { + "description": "The ARN of the VPC.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CoreNetworkArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/AttachmentType", + "/properties/State", + "/properties/AttachmentId", + "/properties/OwnerAccountId", + "/properties/EdgeLocation", + "/properties/AttachmentPolicyRuleNumber", + "/properties/SegmentName", + "/properties/NetworkFunctionGroupName", + "/properties/ResourceArn" + ], + "required": [ + "CoreNetworkId", + "VpcArn", + "SubnetArns" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-vpcattachment", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "networkmanager:TagResource", + "networkmanager:UntagResource", + "networkmanager:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::NetworkManager::VpcAttachment" +} diff --git a/schema/aws-nimblestudio-launchprofile.json b/schema/aws-nimblestudio-launchprofile.json index 6fbc933..b714d48 100644 --- a/schema/aws-nimblestudio-launchprofile.json +++ b/schema/aws-nimblestudio-launchprofile.json @@ -1,347 +1,347 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Ec2SubnetIds", - "/properties/StudioId", - "/properties/Tags" - ], - "definitions": { - "AutomaticTerminationMode": { - "enum": [ - "DEACTIVATED", - "ACTIVATED" - ], - "type": "string" - }, - "SessionBackupMode": { - "enum": [ - "AUTOMATIC", - "DEACTIVATED" - ], - "type": "string" - }, - "SessionPersistenceMode": { - "enum": [ - "DEACTIVATED", - "ACTIVATED" - ], - "type": "string" - }, - "StreamConfiguration": { - "additionalProperties": false, - "description": "

A configuration for a streaming session.

", - "properties": { - "AutomaticTerminationMode": { - "$ref": "#/definitions/AutomaticTerminationMode" - }, - "ClipboardMode": { - "$ref": "#/definitions/StreamingClipboardMode" - }, - "Ec2InstanceTypes": { - "description": "

The EC2 instance types that users can select from when launching a streaming session\n with this launch profile.

", - "items": { - "$ref": "#/definitions/StreamingInstanceType" - }, - "maxItems": 30, - "minItems": 1, - "type": "array" - }, - "MaxSessionLengthInMinutes": { - "default": 690, - "description": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

", - "maximum": 43200, - "minimum": 1, - "type": "number" - }, - "MaxStoppedSessionLengthInMinutes": { - "default": 0, - "description": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can\u2019t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

", - "maximum": 5760, - "minimum": 0, - "type": "number" - }, - "SessionBackup": { - "$ref": "#/definitions/StreamConfigurationSessionBackup" - }, - "SessionPersistenceMode": { - "$ref": "#/definitions/SessionPersistenceMode" - }, - "SessionStorage": { - "$ref": "#/definitions/StreamConfigurationSessionStorage" - }, - "StreamingImageIds": { - "description": "

The streaming images that users can select from when launching a streaming session\n with this launch profile.

", - "items": { - "maxLength": 22, - "minLength": 0, - "pattern": "^[a-zA-Z0-9-_]*$", - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "VolumeConfiguration": { - "$ref": "#/definitions/VolumeConfiguration" - } - }, - "required": [ - "ClipboardMode", - "Ec2InstanceTypes", - "StreamingImageIds" - ], - "type": "object" - }, - "StreamConfigurationSessionBackup": { - "additionalProperties": false, - "description": "

Configures how streaming sessions are backed up when launched from this launch\n profile.

", - "properties": { - "MaxBackupsToRetain": { - "default": 0, - "description": "

The maximum number of backups that each streaming session created from this launch\n profile can have.

", - "maximum": 10, - "minimum": 0, - "type": "number" - }, - "Mode": { - "$ref": "#/definitions/SessionBackupMode" - } - }, - "type": "object" - }, - "StreamConfigurationSessionStorage": { - "additionalProperties": false, - "description": "

The configuration for a streaming session\u2019s upload storage.

", - "properties": { - "Mode": { - "description": "

Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.

", - "items": { - "$ref": "#/definitions/StreamingSessionStorageMode" - }, - "minItems": 1, - "type": "array" - }, - "Root": { - "$ref": "#/definitions/StreamingSessionStorageRoot" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "StreamingClipboardMode": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "StreamingInstanceType": { - "enum": [ - "g4dn.xlarge", - "g4dn.2xlarge", - "g4dn.4xlarge", - "g4dn.8xlarge", - "g4dn.12xlarge", - "g4dn.16xlarge", - "g3.4xlarge", - "g3s.xlarge", - "g5.xlarge", - "g5.2xlarge", - "g5.4xlarge", - "g5.8xlarge", - "g5.16xlarge" - ], - "type": "string" - }, - "StreamingSessionStorageMode": { - "enum": [ - "UPLOAD" - ], - "type": "string" - }, - "StreamingSessionStorageRoot": { - "additionalProperties": false, - "description": "

The upload storage root location (folder) on streaming workstations where files are\n uploaded.

", - "properties": { - "Linux": { - "description": "

The folder path in Linux workstations where files are uploaded.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^(\\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$", - "type": "string" - }, - "Windows": { - "description": "

The folder path in Windows workstations where files are uploaded.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^((\\%HOMEPATH\\%)|[a-zA-Z]:)[\\\\/](?:[a-zA-Z0-9_-]+[\\\\/])*[a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "VolumeConfiguration": { - "additionalProperties": false, - "description": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

", - "properties": { - "Iops": { - "default": 3000, - "description": "

The number of I/O operations per second for the root volume that is attached to\n streaming session.

", - "maximum": 16000, - "minimum": 3000, - "type": "number" - }, - "Size": { - "default": 500, - "description": "

The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.

", - "maximum": 16000, - "minimum": 100, - "type": "number" - }, - "Throughput": { - "default": 125, - "description": "

The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.

", - "maximum": 1000, - "minimum": 125, - "type": "number" - } - }, - "type": "object" - } - }, - "description": "Represents a launch profile which delegates access to a collection of studio components to studio users", - "handlers": { - "create": { - "permissions": [ - "nimble:CreateLaunchProfile", - "nimble:GetLaunchProfile", - "nimble:TagResource", - "ec2:CreateNetworkInterface", - "ec2:CreateNetworkInterfacePermission", - "ec2:RunInstances", - "ec2:DescribeSubnets" - ] - }, - "delete": { - "permissions": [ - "nimble:DeleteLaunchProfile", - "nimble:GetLaunchProfile", - "nimble:UntagResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "StudioId": { - "$ref": "resource-schema.json#/properties/StudioId" - } - }, - "required": [ - "StudioId" - ] - }, - "permissions": [ - "nimble:ListLaunchProfiles" - ] - }, - "read": { - "permissions": [ - "nimble:GetLaunchProfile" - ] - }, - "update": { - "permissions": [ - "nimble:UpdateLaunchProfile", - "nimble:GetLaunchProfile", - "ec2:CreateNetworkInterface", - "ec2:CreateNetworkInterfacePermission", - "ec2:DescribeSubnets", - "ec2:RunInstances" - ] - } - }, - "primaryIdentifier": [ - "/properties/LaunchProfileId", - "/properties/StudioId" - ], - "properties": { - "Description": { - "description": "

The description.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Ec2SubnetIds": { - "description": "

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.\n These subnets must support the specified instance types.

", - "items": { - "type": "string" - }, - "maxItems": 6, - "minItems": 0, - "type": "array" - }, - "LaunchProfileId": { - "type": "string" - }, - "LaunchProfileProtocolVersions": { - "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", - "items": { - "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", - "maxLength": 10, - "minLength": 0, - "pattern": "^2021\\-03\\-31$", - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "

The name for the launch profile.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "StreamConfiguration": { - "$ref": "#/definitions/StreamConfiguration" - }, - "StudioComponentIds": { - "description": "

Unique identifiers for a collection of studio components that can be used with this\n launch profile.

", - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "StudioId": { - "description": "

The studio ID.

", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/LaunchProfileId" - ], - "required": [ - "StudioId", - "Name", - "StudioComponentIds", - "Ec2SubnetIds", - "StreamConfiguration", - "LaunchProfileProtocolVersions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", - "typeName": "AWS::NimbleStudio::LaunchProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Ec2SubnetIds", + "/properties/StudioId", + "/properties/Tags" + ], + "definitions": { + "AutomaticTerminationMode": { + "enum": [ + "DEACTIVATED", + "ACTIVATED" + ], + "type": "string" + }, + "SessionBackupMode": { + "enum": [ + "AUTOMATIC", + "DEACTIVATED" + ], + "type": "string" + }, + "SessionPersistenceMode": { + "enum": [ + "DEACTIVATED", + "ACTIVATED" + ], + "type": "string" + }, + "StreamConfiguration": { + "additionalProperties": false, + "description": "

A configuration for a streaming session.

", + "properties": { + "AutomaticTerminationMode": { + "$ref": "#/definitions/AutomaticTerminationMode" + }, + "ClipboardMode": { + "$ref": "#/definitions/StreamingClipboardMode" + }, + "Ec2InstanceTypes": { + "description": "

The EC2 instance types that users can select from when launching a streaming session\n with this launch profile.

", + "items": { + "$ref": "#/definitions/StreamingInstanceType" + }, + "maxItems": 30, + "minItems": 1, + "type": "array" + }, + "MaxSessionLengthInMinutes": { + "default": 690, + "description": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

", + "maximum": 43200, + "minimum": 1, + "type": "number" + }, + "MaxStoppedSessionLengthInMinutes": { + "default": 0, + "description": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can\u2019t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

", + "maximum": 5760, + "minimum": 0, + "type": "number" + }, + "SessionBackup": { + "$ref": "#/definitions/StreamConfigurationSessionBackup" + }, + "SessionPersistenceMode": { + "$ref": "#/definitions/SessionPersistenceMode" + }, + "SessionStorage": { + "$ref": "#/definitions/StreamConfigurationSessionStorage" + }, + "StreamingImageIds": { + "description": "

The streaming images that users can select from when launching a streaming session\n with this launch profile.

", + "items": { + "maxLength": 22, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "VolumeConfiguration": { + "$ref": "#/definitions/VolumeConfiguration" + } + }, + "required": [ + "ClipboardMode", + "Ec2InstanceTypes", + "StreamingImageIds" + ], + "type": "object" + }, + "StreamConfigurationSessionBackup": { + "additionalProperties": false, + "description": "

Configures how streaming sessions are backed up when launched from this launch\n profile.

", + "properties": { + "MaxBackupsToRetain": { + "default": 0, + "description": "

The maximum number of backups that each streaming session created from this launch\n profile can have.

", + "maximum": 10, + "minimum": 0, + "type": "number" + }, + "Mode": { + "$ref": "#/definitions/SessionBackupMode" + } + }, + "type": "object" + }, + "StreamConfigurationSessionStorage": { + "additionalProperties": false, + "description": "

The configuration for a streaming session\u2019s upload storage.

", + "properties": { + "Mode": { + "description": "

Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.

", + "items": { + "$ref": "#/definitions/StreamingSessionStorageMode" + }, + "minItems": 1, + "type": "array" + }, + "Root": { + "$ref": "#/definitions/StreamingSessionStorageRoot" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "StreamingClipboardMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "StreamingInstanceType": { + "enum": [ + "g4dn.xlarge", + "g4dn.2xlarge", + "g4dn.4xlarge", + "g4dn.8xlarge", + "g4dn.12xlarge", + "g4dn.16xlarge", + "g3.4xlarge", + "g3s.xlarge", + "g5.xlarge", + "g5.2xlarge", + "g5.4xlarge", + "g5.8xlarge", + "g5.16xlarge" + ], + "type": "string" + }, + "StreamingSessionStorageMode": { + "enum": [ + "UPLOAD" + ], + "type": "string" + }, + "StreamingSessionStorageRoot": { + "additionalProperties": false, + "description": "

The upload storage root location (folder) on streaming workstations where files are\n uploaded.

", + "properties": { + "Linux": { + "description": "

The folder path in Linux workstations where files are uploaded.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^(\\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$", + "type": "string" + }, + "Windows": { + "description": "

The folder path in Windows workstations where files are uploaded.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^((\\%HOMEPATH\\%)|[a-zA-Z]:)[\\\\/](?:[a-zA-Z0-9_-]+[\\\\/])*[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "VolumeConfiguration": { + "additionalProperties": false, + "description": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

", + "properties": { + "Iops": { + "default": 3000, + "description": "

The number of I/O operations per second for the root volume that is attached to\n streaming session.

", + "maximum": 16000, + "minimum": 3000, + "type": "number" + }, + "Size": { + "default": 500, + "description": "

The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.

", + "maximum": 16000, + "minimum": 100, + "type": "number" + }, + "Throughput": { + "default": 125, + "description": "

The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.

", + "maximum": 1000, + "minimum": 125, + "type": "number" + } + }, + "type": "object" + } + }, + "description": "Represents a launch profile which delegates access to a collection of studio components to studio users", + "handlers": { + "create": { + "permissions": [ + "nimble:CreateLaunchProfile", + "nimble:GetLaunchProfile", + "nimble:TagResource", + "ec2:CreateNetworkInterface", + "ec2:CreateNetworkInterfacePermission", + "ec2:RunInstances", + "ec2:DescribeSubnets" + ] + }, + "delete": { + "permissions": [ + "nimble:DeleteLaunchProfile", + "nimble:GetLaunchProfile", + "nimble:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "StudioId": { + "$ref": "resource-schema.json#/properties/StudioId" + } + }, + "required": [ + "StudioId" + ] + }, + "permissions": [ + "nimble:ListLaunchProfiles" + ] + }, + "read": { + "permissions": [ + "nimble:GetLaunchProfile" + ] + }, + "update": { + "permissions": [ + "nimble:UpdateLaunchProfile", + "nimble:GetLaunchProfile", + "ec2:CreateNetworkInterface", + "ec2:CreateNetworkInterfacePermission", + "ec2:DescribeSubnets", + "ec2:RunInstances" + ] + } + }, + "primaryIdentifier": [ + "/properties/LaunchProfileId", + "/properties/StudioId" + ], + "properties": { + "Description": { + "description": "

The description.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Ec2SubnetIds": { + "description": "

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.\n These subnets must support the specified instance types.

", + "items": { + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "LaunchProfileId": { + "type": "string" + }, + "LaunchProfileProtocolVersions": { + "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", + "items": { + "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", + "maxLength": 10, + "minLength": 0, + "pattern": "^2021\\-03\\-31$", + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "

The name for the launch profile.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "StreamConfiguration": { + "$ref": "#/definitions/StreamConfiguration" + }, + "StudioComponentIds": { + "description": "

Unique identifiers for a collection of studio components that can be used with this\n launch profile.

", + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "StudioId": { + "description": "

The studio ID.

", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/LaunchProfileId" + ], + "required": [ + "StudioId", + "Name", + "StudioComponentIds", + "Ec2SubnetIds", + "StreamConfiguration", + "LaunchProfileProtocolVersions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", + "typeName": "AWS::NimbleStudio::LaunchProfile" +} diff --git a/schema/aws-nimblestudio-streamingimage.json b/schema/aws-nimblestudio-streamingimage.json index 9eca367..fe58b0e 100644 --- a/schema/aws-nimblestudio-streamingimage.json +++ b/schema/aws-nimblestudio-streamingimage.json @@ -1,177 +1,177 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Ec2ImageId", - "/properties/StudioId", - "/properties/Tags" - ], - "definitions": { - "StreamingImageEncryptionConfiguration": { - "additionalProperties": false, - "description": "

TODO

", - "properties": { - "KeyArn": { - "description": "

The ARN for a KMS key that is used to encrypt studio data.

", - "minLength": 4, - "pattern": "^arn:.*", - "type": "string" - }, - "KeyType": { - "$ref": "#/definitions/StreamingImageEncryptionConfigurationKeyType" - } - }, - "required": [ - "KeyType" - ], - "type": "object" - }, - "StreamingImageEncryptionConfigurationKeyType": { - "description": "

", - "enum": [ - "CUSTOMER_MANAGED_KEY" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "", - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Represents a streaming session machine image that can be used to launch a streaming session", - "handlers": { - "create": { - "permissions": [ - "nimble:CreateStreamingImage", - "nimble:GetStreamingImage", - "nimble:TagResource", - "ec2:DescribeImages", - "ec2:DescribeSnapshots", - "ec2:ModifyInstanceAttribute", - "ec2:ModifySnapshotAttribute", - "ec2:ModifyImageAttribute", - "ec2:RegisterImage", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:ListGrants", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "nimble:DeleteStreamingImage", - "nimble:GetStreamingImage", - "nimble:UntagResource", - "ec2:ModifyInstanceAttribute", - "ec2:ModifySnapshotAttribute", - "ec2:DeregisterImage", - "ec2:DeleteSnapshot", - "kms:ListGrants", - "kms:RetireGrant" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "StudioId": { - "$ref": "resource-schema.json#/properties/StudioId" - } - }, - "required": [ - "StudioId" - ] - }, - "permissions": [ - "nimble:ListStreamingImages" - ] - }, - "read": { - "permissions": [ - "nimble:GetStreamingImage" - ] - }, - "update": { - "permissions": [ - "nimble:UpdateStreamingImage", - "nimble:GetStreamingImage", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:ListGrants", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/StudioId", - "/properties/StreamingImageId" - ], - "properties": { - "Description": { - "description": "

A human-readable description of the streaming image.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Ec2ImageId": { - "description": "

The ID of an EC2 machine image with which to create this streaming image.

", - "pattern": "^ami-[0-9A-z]+$", - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/StreamingImageEncryptionConfiguration" - }, - "EulaIds": { - "description": "

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

", - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "

A friendly name for a streaming image resource.

", - "maxLength": 64, - "minLength": 0, - "type": "string" - }, - "Owner": { - "description": "

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

", - "type": "string" - }, - "Platform": { - "description": "

The platform of the streaming image, either WINDOWS or LINUX.

", - "pattern": "^[a-zA-Z]*$", - "type": "string" - }, - "StreamingImageId": { - "type": "string" - }, - "StudioId": { - "description": "

The studioId.

", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/EncryptionConfiguration", - "/properties/EulaIds", - "/properties/Owner", - "/properties/Platform", - "/properties/StreamingImageId" - ], - "required": [ - "StudioId", - "Ec2ImageId", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", - "typeName": "AWS::NimbleStudio::StreamingImage" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Ec2ImageId", + "/properties/StudioId", + "/properties/Tags" + ], + "definitions": { + "StreamingImageEncryptionConfiguration": { + "additionalProperties": false, + "description": "

TODO

", + "properties": { + "KeyArn": { + "description": "

The ARN for a KMS key that is used to encrypt studio data.

", + "minLength": 4, + "pattern": "^arn:.*", + "type": "string" + }, + "KeyType": { + "$ref": "#/definitions/StreamingImageEncryptionConfigurationKeyType" + } + }, + "required": [ + "KeyType" + ], + "type": "object" + }, + "StreamingImageEncryptionConfigurationKeyType": { + "description": "

", + "enum": [ + "CUSTOMER_MANAGED_KEY" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Represents a streaming session machine image that can be used to launch a streaming session", + "handlers": { + "create": { + "permissions": [ + "nimble:CreateStreamingImage", + "nimble:GetStreamingImage", + "nimble:TagResource", + "ec2:DescribeImages", + "ec2:DescribeSnapshots", + "ec2:ModifyInstanceAttribute", + "ec2:ModifySnapshotAttribute", + "ec2:ModifyImageAttribute", + "ec2:RegisterImage", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:ListGrants", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "nimble:DeleteStreamingImage", + "nimble:GetStreamingImage", + "nimble:UntagResource", + "ec2:ModifyInstanceAttribute", + "ec2:ModifySnapshotAttribute", + "ec2:DeregisterImage", + "ec2:DeleteSnapshot", + "kms:ListGrants", + "kms:RetireGrant" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "StudioId": { + "$ref": "resource-schema.json#/properties/StudioId" + } + }, + "required": [ + "StudioId" + ] + }, + "permissions": [ + "nimble:ListStreamingImages" + ] + }, + "read": { + "permissions": [ + "nimble:GetStreamingImage" + ] + }, + "update": { + "permissions": [ + "nimble:UpdateStreamingImage", + "nimble:GetStreamingImage", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:ListGrants", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/StudioId", + "/properties/StreamingImageId" + ], + "properties": { + "Description": { + "description": "

A human-readable description of the streaming image.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Ec2ImageId": { + "description": "

The ID of an EC2 machine image with which to create this streaming image.

", + "pattern": "^ami-[0-9A-z]+$", + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/StreamingImageEncryptionConfiguration" + }, + "EulaIds": { + "description": "

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

", + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "

A friendly name for a streaming image resource.

", + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "Owner": { + "description": "

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

", + "type": "string" + }, + "Platform": { + "description": "

The platform of the streaming image, either WINDOWS or LINUX.

", + "pattern": "^[a-zA-Z]*$", + "type": "string" + }, + "StreamingImageId": { + "type": "string" + }, + "StudioId": { + "description": "

The studioId.

", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/EncryptionConfiguration", + "/properties/EulaIds", + "/properties/Owner", + "/properties/Platform", + "/properties/StreamingImageId" + ], + "required": [ + "StudioId", + "Ec2ImageId", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", + "typeName": "AWS::NimbleStudio::StreamingImage" +} diff --git a/schema/aws-nimblestudio-studio.json b/schema/aws-nimblestudio-studio.json index a2f0b83..91483cc 100644 --- a/schema/aws-nimblestudio-studio.json +++ b/schema/aws-nimblestudio-studio.json @@ -1,167 +1,167 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StudioName", - "/properties/Tags" - ], - "definitions": { - "StudioEncryptionConfiguration": { - "additionalProperties": false, - "description": "

Configuration of the encryption method that is used for the studio.

", - "properties": { - "KeyArn": { - "description": "

The ARN for a KMS key that is used to encrypt studio data.

", - "minLength": 4, - "pattern": "^arn:.*", - "type": "string" - }, - "KeyType": { - "$ref": "#/definitions/StudioEncryptionConfigurationKeyType" - } - }, - "required": [ - "KeyType" - ], - "type": "object" - }, - "StudioEncryptionConfigurationKeyType": { - "description": "

The type of KMS key that is used to encrypt studio data.

", - "enum": [ - "AWS_OWNED_KEY", - "CUSTOMER_MANAGED_KEY" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "", - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Represents a studio that contains other Nimble Studio resources", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "nimble:CreateStudio", - "nimble:GetStudio", - "nimble:TagResource", - "sso:CreateManagedApplicationInstance", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:ListGrants", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "nimble:DeleteStudio", - "nimble:GetStudio", - "nimble:UntagResource", - "kms:Encrypt", - "kms:Decrypt", - "kms:ListGrants", - "kms:RetireGrant", - "kms:GenerateDataKey", - "sso:DeleteManagedApplicationInstance", - "sso:GetManagedApplicationInstance" - ] - }, - "list": { - "permissions": [ - "nimble:ListStudios" - ] - }, - "read": { - "permissions": [ - "nimble:GetStudio", - "kms:Encrypt", - "kms:Decrypt", - "kms:ListGrants", - "kms:GenerateDataKey" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "nimble:UpdateStudio", - "nimble:GetStudio", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant", - "kms:ListGrants", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/StudioId" - ], - "properties": { - "AdminRoleArn": { - "description": "

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

", - "type": "string" - }, - "DisplayName": { - "description": "

A friendly name for the studio.

", - "maxLength": 64, - "minLength": 0, - "type": "string" - }, - "HomeRegion": { - "description": "

The Amazon Web Services Region where the studio resource is located.

", - "maxLength": 50, - "minLength": 0, - "pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]", - "type": "string" - }, - "SsoClientId": { - "description": "

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

", - "type": "string" - }, - "StudioEncryptionConfiguration": { - "$ref": "#/definitions/StudioEncryptionConfiguration" - }, - "StudioId": { - "type": "string" - }, - "StudioName": { - "description": "

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

", - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9]*$", - "type": "string" - }, - "StudioUrl": { - "description": "

The address of the web page for the studio.

", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "UserRoleArn": { - "description": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/HomeRegion", - "/properties/SsoClientId", - "/properties/StudioId", - "/properties/StudioUrl" - ], - "required": [ - "DisplayName", - "UserRoleArn", - "AdminRoleArn", - "StudioName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", - "typeName": "AWS::NimbleStudio::Studio" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StudioName", + "/properties/Tags" + ], + "definitions": { + "StudioEncryptionConfiguration": { + "additionalProperties": false, + "description": "

Configuration of the encryption method that is used for the studio.

", + "properties": { + "KeyArn": { + "description": "

The ARN for a KMS key that is used to encrypt studio data.

", + "minLength": 4, + "pattern": "^arn:.*", + "type": "string" + }, + "KeyType": { + "$ref": "#/definitions/StudioEncryptionConfigurationKeyType" + } + }, + "required": [ + "KeyType" + ], + "type": "object" + }, + "StudioEncryptionConfigurationKeyType": { + "description": "

The type of KMS key that is used to encrypt studio data.

", + "enum": [ + "AWS_OWNED_KEY", + "CUSTOMER_MANAGED_KEY" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Represents a studio that contains other Nimble Studio resources", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "nimble:CreateStudio", + "nimble:GetStudio", + "nimble:TagResource", + "sso:CreateManagedApplicationInstance", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:ListGrants", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "nimble:DeleteStudio", + "nimble:GetStudio", + "nimble:UntagResource", + "kms:Encrypt", + "kms:Decrypt", + "kms:ListGrants", + "kms:RetireGrant", + "kms:GenerateDataKey", + "sso:DeleteManagedApplicationInstance", + "sso:GetManagedApplicationInstance" + ] + }, + "list": { + "permissions": [ + "nimble:ListStudios" + ] + }, + "read": { + "permissions": [ + "nimble:GetStudio", + "kms:Encrypt", + "kms:Decrypt", + "kms:ListGrants", + "kms:GenerateDataKey" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "nimble:UpdateStudio", + "nimble:GetStudio", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:ListGrants", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/StudioId" + ], + "properties": { + "AdminRoleArn": { + "description": "

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

", + "type": "string" + }, + "DisplayName": { + "description": "

A friendly name for the studio.

", + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "HomeRegion": { + "description": "

The Amazon Web Services Region where the studio resource is located.

", + "maxLength": 50, + "minLength": 0, + "pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]", + "type": "string" + }, + "SsoClientId": { + "description": "

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

", + "type": "string" + }, + "StudioEncryptionConfiguration": { + "$ref": "#/definitions/StudioEncryptionConfiguration" + }, + "StudioId": { + "type": "string" + }, + "StudioName": { + "description": "

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9]*$", + "type": "string" + }, + "StudioUrl": { + "description": "

The address of the web page for the studio.

", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "UserRoleArn": { + "description": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/HomeRegion", + "/properties/SsoClientId", + "/properties/StudioId", + "/properties/StudioUrl" + ], + "required": [ + "DisplayName", + "UserRoleArn", + "AdminRoleArn", + "StudioName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", + "typeName": "AWS::NimbleStudio::Studio" +} diff --git a/schema/aws-nimblestudio-studiocomponent.json b/schema/aws-nimblestudio-studiocomponent.json index 0399eab..567f74a 100644 --- a/schema/aws-nimblestudio-studiocomponent.json +++ b/schema/aws-nimblestudio-studiocomponent.json @@ -1,393 +1,393 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StudioId", - "/properties/Subtype", - "/properties/Tags" - ], - "definitions": { - "ActiveDirectoryComputerAttribute": { - "additionalProperties": false, - "description": "

An LDAP attribute of an Active Directory computer account, in the form of a name:value\n pair.

", - "properties": { - "Name": { - "description": "

The name for the LDAP attribute.

", - "maxLength": 40, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

The value for the LDAP attribute.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ActiveDirectoryConfiguration": { - "additionalProperties": false, - "description": "

The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.

", - "properties": { - "ComputerAttributes": { - "description": "

A collection of custom attributes for an Active Directory computer.

", - "items": { - "$ref": "#/definitions/ActiveDirectoryComputerAttribute" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "DirectoryId": { - "description": "

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.

", - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "description": "

The distinguished name (DN) and organizational unit (OU) of an Active Directory\n computer.

", - "maxLength": 2000, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ComputeFarmConfiguration": { - "additionalProperties": false, - "description": "

The configuration for a render farm that is associated with a studio resource.

", - "properties": { - "ActiveDirectoryUser": { - "description": "

The name of an Active Directory user that is used on ComputeFarm worker\n instances.

", - "type": "string" - }, - "Endpoint": { - "description": "

The endpoint of the ComputeFarm that is accessed by the studio component\n resource.

", - "type": "string" - } - }, - "type": "object" - }, - "LaunchProfilePlatform": { - "enum": [ - "LINUX", - "WINDOWS" - ], - "type": "string" - }, - "LicenseServiceConfiguration": { - "additionalProperties": false, - "description": "

The configuration for a license service that is associated with a studio\n resource.

", - "properties": { - "Endpoint": { - "description": "

The endpoint of the license service that is accessed by the studio component\n resource.

", - "type": "string" - } - }, - "type": "object" - }, - "ScriptParameterKeyValue": { - "additionalProperties": false, - "description": "

A parameter for a studio component script, in the form of a key:value pair.

", - "properties": { - "Key": { - "description": "

A script parameter key.

", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z_][a-zA-Z0-9_]+$", - "type": "string" - }, - "Value": { - "description": "

A script parameter value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SharedFileSystemConfiguration": { - "additionalProperties": false, - "description": "

The configuration for a shared file storage system that is associated with a studio\n resource.

", - "properties": { - "Endpoint": { - "description": "

The endpoint of the shared file system that is accessed by the studio component\n resource.

", - "type": "string" - }, - "FileSystemId": { - "description": "

The unique identifier for a file system.

", - "type": "string" - }, - "LinuxMountPoint": { - "description": "

The mount location for a shared file system on a Linux virtual workstation.

", - "maxLength": 128, - "minLength": 0, - "pattern": "^(/?|(\\$HOME)?(/[^/\\n\\s\\\\]+)*)$", - "type": "string" - }, - "ShareName": { - "description": "

The name of the file share.

", - "type": "string" - }, - "WindowsMountDrive": { - "description": "

The mount location for a shared file system on a Windows virtual workstation.

", - "pattern": "^[A-Z]$", - "type": "string" - } - }, - "type": "object" - }, - "StudioComponentConfiguration": { - "description": "

The configuration of the studio component, based on component type.

", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "ActiveDirectoryConfiguration": { - "$ref": "#/definitions/ActiveDirectoryConfiguration" - } - }, - "required": [ - "ActiveDirectoryConfiguration" - ], - "title": "ActiveDirectoryConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ComputeFarmConfiguration": { - "$ref": "#/definitions/ComputeFarmConfiguration" - } - }, - "required": [ - "ComputeFarmConfiguration" - ], - "title": "ComputeFarmConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "LicenseServiceConfiguration": { - "$ref": "#/definitions/LicenseServiceConfiguration" - } - }, - "required": [ - "LicenseServiceConfiguration" - ], - "title": "LicenseServiceConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "SharedFileSystemConfiguration": { - "$ref": "#/definitions/SharedFileSystemConfiguration" - } - }, - "required": [ - "SharedFileSystemConfiguration" - ], - "title": "SharedFileSystemConfiguration", - "type": "object" - } - ] - }, - "StudioComponentInitializationScript": { - "additionalProperties": false, - "description": "

Initialization scripts for studio components.

", - "properties": { - "LaunchProfileProtocolVersion": { - "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", - "maxLength": 10, - "minLength": 0, - "pattern": "^2021\\-03\\-31$", - "type": "string" - }, - "Platform": { - "$ref": "#/definitions/LaunchProfilePlatform" - }, - "RunContext": { - "$ref": "#/definitions/StudioComponentInitializationScriptRunContext" - }, - "Script": { - "description": "

The initialization script.

", - "maxLength": 5120, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "StudioComponentInitializationScriptRunContext": { - "enum": [ - "SYSTEM_INITIALIZATION", - "USER_INITIALIZATION" - ], - "type": "string" - }, - "StudioComponentSubtype": { - "enum": [ - "AWS_MANAGED_MICROSOFT_AD", - "AMAZON_FSX_FOR_WINDOWS", - "AMAZON_FSX_FOR_LUSTRE", - "CUSTOM" - ], - "type": "string" - }, - "StudioComponentType": { - "enum": [ - "ACTIVE_DIRECTORY", - "SHARED_FILE_SYSTEM", - "COMPUTE_FARM", - "LICENSE_SERVICE", - "CUSTOM" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Represents a studio component that connects a non-Nimble Studio resource in your account to your studio", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "nimble:CreateStudioComponent", - "nimble:GetStudioComponent", - "nimble:TagResource", - "ds:AuthorizeApplication", - "ec2:DescribeSecurityGroups", - "fsx:DescribeFilesystems", - "ds:DescribeDirectories" - ] - }, - "delete": { - "permissions": [ - "nimble:DeleteStudioComponent", - "nimble:GetStudioComponent", - "nimble:UntagResource", - "ds:UnauthorizeApplication" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "StudioId": { - "$ref": "resource-schema.json#/properties/StudioId" - } - }, - "required": [ - "StudioId" - ] - }, - "permissions": [ - "nimble:ListStudioComponents" - ] - }, - "read": { - "permissions": [ - "nimble:GetStudioComponent" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "nimble:UpdateStudioComponent", - "nimble:GetStudioComponent", - "ds:AuthorizeApplication", - "ec2:DescribeSecurityGroups", - "fsx:DescribeFilesystems", - "ds:DescribeDirectories" - ] - } - }, - "primaryIdentifier": [ - "/properties/StudioComponentId", - "/properties/StudioId" - ], - "properties": { - "Configuration": { - "$ref": "#/definitions/StudioComponentConfiguration" - }, - "Description": { - "description": "

The description.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Ec2SecurityGroupIds": { - "description": "

The EC2 security groups that control access to the studio component.

", - "items": { - "type": "string" - }, - "maxItems": 30, - "minItems": 0, - "type": "array" - }, - "InitializationScripts": { - "description": "

Initialization scripts for studio components.

", - "items": { - "$ref": "#/definitions/StudioComponentInitializationScript" - }, - "type": "array" - }, - "Name": { - "description": "

The name for the studio component.

", - "maxLength": 64, - "minLength": 0, - "type": "string" - }, - "RuntimeRoleArn": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "ScriptParameters": { - "description": "

Parameters for the studio component scripts.

", - "items": { - "$ref": "#/definitions/ScriptParameterKeyValue" - }, - "maxItems": 30, - "minItems": 0, - "type": "array" - }, - "SecureInitializationRoleArn": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "StudioComponentId": { - "type": "string" - }, - "StudioId": { - "description": "

The studio ID.

", - "type": "string" - }, - "Subtype": { - "$ref": "#/definitions/StudioComponentSubtype" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "Type": { - "$ref": "#/definitions/StudioComponentType" - } - }, - "readOnlyProperties": [ - "/properties/StudioComponentId" - ], - "required": [ - "StudioId", - "Name", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", - "typeName": "AWS::NimbleStudio::StudioComponent" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StudioId", + "/properties/Subtype", + "/properties/Tags" + ], + "definitions": { + "ActiveDirectoryComputerAttribute": { + "additionalProperties": false, + "description": "

An LDAP attribute of an Active Directory computer account, in the form of a name:value\n pair.

", + "properties": { + "Name": { + "description": "

The name for the LDAP attribute.

", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

The value for the LDAP attribute.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ActiveDirectoryConfiguration": { + "additionalProperties": false, + "description": "

The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.

", + "properties": { + "ComputerAttributes": { + "description": "

A collection of custom attributes for an Active Directory computer.

", + "items": { + "$ref": "#/definitions/ActiveDirectoryComputerAttribute" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "DirectoryId": { + "description": "

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.

", + "type": "string" + }, + "OrganizationalUnitDistinguishedName": { + "description": "

The distinguished name (DN) and organizational unit (OU) of an Active Directory\n computer.

", + "maxLength": 2000, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ComputeFarmConfiguration": { + "additionalProperties": false, + "description": "

The configuration for a render farm that is associated with a studio resource.

", + "properties": { + "ActiveDirectoryUser": { + "description": "

The name of an Active Directory user that is used on ComputeFarm worker\n instances.

", + "type": "string" + }, + "Endpoint": { + "description": "

The endpoint of the ComputeFarm that is accessed by the studio component\n resource.

", + "type": "string" + } + }, + "type": "object" + }, + "LaunchProfilePlatform": { + "enum": [ + "LINUX", + "WINDOWS" + ], + "type": "string" + }, + "LicenseServiceConfiguration": { + "additionalProperties": false, + "description": "

The configuration for a license service that is associated with a studio\n resource.

", + "properties": { + "Endpoint": { + "description": "

The endpoint of the license service that is accessed by the studio component\n resource.

", + "type": "string" + } + }, + "type": "object" + }, + "ScriptParameterKeyValue": { + "additionalProperties": false, + "description": "

A parameter for a studio component script, in the form of a key:value pair.

", + "properties": { + "Key": { + "description": "

A script parameter key.

", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z_][a-zA-Z0-9_]+$", + "type": "string" + }, + "Value": { + "description": "

A script parameter value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SharedFileSystemConfiguration": { + "additionalProperties": false, + "description": "

The configuration for a shared file storage system that is associated with a studio\n resource.

", + "properties": { + "Endpoint": { + "description": "

The endpoint of the shared file system that is accessed by the studio component\n resource.

", + "type": "string" + }, + "FileSystemId": { + "description": "

The unique identifier for a file system.

", + "type": "string" + }, + "LinuxMountPoint": { + "description": "

The mount location for a shared file system on a Linux virtual workstation.

", + "maxLength": 128, + "minLength": 0, + "pattern": "^(/?|(\\$HOME)?(/[^/\\n\\s\\\\]+)*)$", + "type": "string" + }, + "ShareName": { + "description": "

The name of the file share.

", + "type": "string" + }, + "WindowsMountDrive": { + "description": "

The mount location for a shared file system on a Windows virtual workstation.

", + "pattern": "^[A-Z]$", + "type": "string" + } + }, + "type": "object" + }, + "StudioComponentConfiguration": { + "description": "

The configuration of the studio component, based on component type.

", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "ActiveDirectoryConfiguration": { + "$ref": "#/definitions/ActiveDirectoryConfiguration" + } + }, + "required": [ + "ActiveDirectoryConfiguration" + ], + "title": "ActiveDirectoryConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ComputeFarmConfiguration": { + "$ref": "#/definitions/ComputeFarmConfiguration" + } + }, + "required": [ + "ComputeFarmConfiguration" + ], + "title": "ComputeFarmConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "LicenseServiceConfiguration": { + "$ref": "#/definitions/LicenseServiceConfiguration" + } + }, + "required": [ + "LicenseServiceConfiguration" + ], + "title": "LicenseServiceConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "SharedFileSystemConfiguration": { + "$ref": "#/definitions/SharedFileSystemConfiguration" + } + }, + "required": [ + "SharedFileSystemConfiguration" + ], + "title": "SharedFileSystemConfiguration", + "type": "object" + } + ] + }, + "StudioComponentInitializationScript": { + "additionalProperties": false, + "description": "

Initialization scripts for studio components.

", + "properties": { + "LaunchProfileProtocolVersion": { + "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

", + "maxLength": 10, + "minLength": 0, + "pattern": "^2021\\-03\\-31$", + "type": "string" + }, + "Platform": { + "$ref": "#/definitions/LaunchProfilePlatform" + }, + "RunContext": { + "$ref": "#/definitions/StudioComponentInitializationScriptRunContext" + }, + "Script": { + "description": "

The initialization script.

", + "maxLength": 5120, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "StudioComponentInitializationScriptRunContext": { + "enum": [ + "SYSTEM_INITIALIZATION", + "USER_INITIALIZATION" + ], + "type": "string" + }, + "StudioComponentSubtype": { + "enum": [ + "AWS_MANAGED_MICROSOFT_AD", + "AMAZON_FSX_FOR_WINDOWS", + "AMAZON_FSX_FOR_LUSTRE", + "CUSTOM" + ], + "type": "string" + }, + "StudioComponentType": { + "enum": [ + "ACTIVE_DIRECTORY", + "SHARED_FILE_SYSTEM", + "COMPUTE_FARM", + "LICENSE_SERVICE", + "CUSTOM" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Represents a studio component that connects a non-Nimble Studio resource in your account to your studio", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "nimble:CreateStudioComponent", + "nimble:GetStudioComponent", + "nimble:TagResource", + "ds:AuthorizeApplication", + "ec2:DescribeSecurityGroups", + "fsx:DescribeFilesystems", + "ds:DescribeDirectories" + ] + }, + "delete": { + "permissions": [ + "nimble:DeleteStudioComponent", + "nimble:GetStudioComponent", + "nimble:UntagResource", + "ds:UnauthorizeApplication" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "StudioId": { + "$ref": "resource-schema.json#/properties/StudioId" + } + }, + "required": [ + "StudioId" + ] + }, + "permissions": [ + "nimble:ListStudioComponents" + ] + }, + "read": { + "permissions": [ + "nimble:GetStudioComponent" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "nimble:UpdateStudioComponent", + "nimble:GetStudioComponent", + "ds:AuthorizeApplication", + "ec2:DescribeSecurityGroups", + "fsx:DescribeFilesystems", + "ds:DescribeDirectories" + ] + } + }, + "primaryIdentifier": [ + "/properties/StudioComponentId", + "/properties/StudioId" + ], + "properties": { + "Configuration": { + "$ref": "#/definitions/StudioComponentConfiguration" + }, + "Description": { + "description": "

The description.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Ec2SecurityGroupIds": { + "description": "

The EC2 security groups that control access to the studio component.

", + "items": { + "type": "string" + }, + "maxItems": 30, + "minItems": 0, + "type": "array" + }, + "InitializationScripts": { + "description": "

Initialization scripts for studio components.

", + "items": { + "$ref": "#/definitions/StudioComponentInitializationScript" + }, + "type": "array" + }, + "Name": { + "description": "

The name for the studio component.

", + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "RuntimeRoleArn": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ScriptParameters": { + "description": "

Parameters for the studio component scripts.

", + "items": { + "$ref": "#/definitions/ScriptParameterKeyValue" + }, + "maxItems": 30, + "minItems": 0, + "type": "array" + }, + "SecureInitializationRoleArn": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "StudioComponentId": { + "type": "string" + }, + "StudioId": { + "description": "

The studio ID.

", + "type": "string" + }, + "Subtype": { + "$ref": "#/definitions/StudioComponentSubtype" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "Type": { + "$ref": "#/definitions/StudioComponentType" + } + }, + "readOnlyProperties": [ + "/properties/StudioComponentId" + ], + "required": [ + "StudioId", + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio", + "typeName": "AWS::NimbleStudio::StudioComponent" +} diff --git a/schema/aws-oam-link.json b/schema/aws-oam-link.json index 3ac4025..9e71813 100644 --- a/schema/aws-oam-link.json +++ b/schema/aws-oam-link.json @@ -1,156 +1,156 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SinkIdentifier", - "/properties/LabelTemplate" - ], - "definitions": { - "LinkConfiguration": { - "additionalProperties": false, - "properties": { - "LogGroupConfiguration": { - "$ref": "#/definitions/LinkFilter" - }, - "MetricConfiguration": { - "$ref": "#/definitions/LinkFilter" - } - }, - "type": "object" - }, - "LinkFilter": { - "additionalProperties": false, - "properties": { - "Filter": { - "maxLength": 2000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Filter" - ], - "type": "object" - }, - "ResourceType": { - "enum": [ - "AWS::CloudWatch::Metric", - "AWS::Logs::LogGroup", - "AWS::XRay::Trace", - "AWS::ApplicationInsights::Application", - "AWS::InternetMonitor::Monitor" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Oam::Link Resource Type", - "handlers": { - "create": { - "permissions": [ - "oam:CreateLink", - "oam:GetLink", - "cloudwatch:Link", - "logs:Link", - "xray:Link", - "applicationinsights:Link", - "internetmonitor:Link" - ] - }, - "delete": { - "permissions": [ - "oam:DeleteLink", - "oam:GetLink" - ] - }, - "list": { - "permissions": [ - "oam:ListLinks" - ] - }, - "read": { - "permissions": [ - "oam:GetLink" - ] - }, - "update": { - "permissions": [ - "oam:GetLink", - "oam:UpdateLink", - "cloudwatch:Link", - "logs:Link", - "xray:Link", - "applicationinsights:Link", - "internetmonitor:Link", - "oam:TagResource", - "oam:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "type": "string" - }, - "Label": { - "type": "string" - }, - "LabelTemplate": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "LinkConfiguration": { - "$ref": "#/definitions/LinkConfiguration" - }, - "ResourceTypes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceType" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SinkIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "Tags to apply to the link", - "patternProperties": { - "^(?!aws:.*).{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 256, - "minLength": 0, - "pattern": "^(?!aws:.*).{0,256}$", - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Label" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "ResourceTypes", - "SinkIdentifier" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Oam::Link", - "writeOnlyProperties": [ - "/properties/LabelTemplate" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SinkIdentifier", + "/properties/LabelTemplate" + ], + "definitions": { + "LinkConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupConfiguration": { + "$ref": "#/definitions/LinkFilter" + }, + "MetricConfiguration": { + "$ref": "#/definitions/LinkFilter" + } + }, + "type": "object" + }, + "LinkFilter": { + "additionalProperties": false, + "properties": { + "Filter": { + "maxLength": 2000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Filter" + ], + "type": "object" + }, + "ResourceType": { + "enum": [ + "AWS::CloudWatch::Metric", + "AWS::Logs::LogGroup", + "AWS::XRay::Trace", + "AWS::ApplicationInsights::Application", + "AWS::InternetMonitor::Monitor" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Oam::Link Resource Type", + "handlers": { + "create": { + "permissions": [ + "oam:CreateLink", + "oam:GetLink", + "cloudwatch:Link", + "logs:Link", + "xray:Link", + "applicationinsights:Link", + "internetmonitor:Link" + ] + }, + "delete": { + "permissions": [ + "oam:DeleteLink", + "oam:GetLink" + ] + }, + "list": { + "permissions": [ + "oam:ListLinks" + ] + }, + "read": { + "permissions": [ + "oam:GetLink" + ] + }, + "update": { + "permissions": [ + "oam:GetLink", + "oam:UpdateLink", + "cloudwatch:Link", + "logs:Link", + "xray:Link", + "applicationinsights:Link", + "internetmonitor:Link", + "oam:TagResource", + "oam:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "type": "string" + }, + "Label": { + "type": "string" + }, + "LabelTemplate": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "LinkConfiguration": { + "$ref": "#/definitions/LinkConfiguration" + }, + "ResourceTypes": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceType" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "SinkIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "Tags to apply to the link", + "patternProperties": { + "^(?!aws:.*).{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 256, + "minLength": 0, + "pattern": "^(?!aws:.*).{0,256}$", + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Label" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "ResourceTypes", + "SinkIdentifier" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Oam::Link", + "writeOnlyProperties": [ + "/properties/LabelTemplate" + ] +} diff --git a/schema/aws-oam-sink.json b/schema/aws-oam-sink.json index d3b3345..8e35f4c 100644 --- a/schema/aws-oam-sink.json +++ b/schema/aws-oam-sink.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::Oam::Sink", - "handlers": { - "create": { - "permissions": [ - "oam:CreateSink", - "oam:PutSinkPolicy", - "oam:GetSinkPolicy", - "oam:GetSink" - ] - }, - "delete": { - "permissions": [ - "oam:DeleteSink", - "oam:GetSinkPolicy", - "oam:GetSink" - ] - }, - "list": { - "permissions": [ - "oam:ListSinks" - ] - }, - "read": { - "permissions": [ - "oam:GetSinkPolicy", - "oam:GetSink" - ] - }, - "update": { - "permissions": [ - "oam:PutSinkPolicy", - "oam:GetSinkPolicy", - "oam:GetSink", - "oam:TagResource", - "oam:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon resource name (ARN) of the ObservabilityAccessManager Sink", - "maxLength": 2048, - "type": "string" - }, - "Name": { - "description": "The name of the ObservabilityAccessManager Sink.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "Policy": { - "description": "The policy of this ObservabilityAccessManager Sink.", - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "Tags to apply to the sink", - "patternProperties": { - "^(?!aws:.*).{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", - "maxLength": 256, - "minLength": 0, - "pattern": "^(?!aws:.*).{0,256}$", - "type": "string" - } - }, - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Oam::Sink" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::Oam::Sink", + "handlers": { + "create": { + "permissions": [ + "oam:CreateSink", + "oam:PutSinkPolicy", + "oam:GetSinkPolicy", + "oam:GetSink" + ] + }, + "delete": { + "permissions": [ + "oam:DeleteSink", + "oam:GetSinkPolicy", + "oam:GetSink" + ] + }, + "list": { + "permissions": [ + "oam:ListSinks" + ] + }, + "read": { + "permissions": [ + "oam:GetSinkPolicy", + "oam:GetSink" + ] + }, + "update": { + "permissions": [ + "oam:PutSinkPolicy", + "oam:GetSinkPolicy", + "oam:GetSink", + "oam:TagResource", + "oam:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon resource name (ARN) of the ObservabilityAccessManager Sink", + "maxLength": 2048, + "type": "string" + }, + "Name": { + "description": "The name of the ObservabilityAccessManager Sink.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "Policy": { + "description": "The policy of this ObservabilityAccessManager Sink.", + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "Tags to apply to the sink", + "patternProperties": { + "^(?!aws:.*).{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 256, + "minLength": 0, + "pattern": "^(?!aws:.*).{0,256}$", + "type": "string" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Oam::Sink" +} diff --git a/schema/aws-omics-annotationstore.json b/schema/aws-omics-annotationstore.json index 5351564..0cf408a 100644 --- a/schema/aws-omics-annotationstore.json +++ b/schema/aws-omics-annotationstore.json @@ -1,293 +1,293 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Reference", - "/properties/SseConfig", - "/properties/StoreFormat", - "/properties/StoreOptions", - "/properties/Tags" - ], - "definitions": { - "AnnotationType": { - "enum": [ - "GENERIC", - "CHR_POS", - "CHR_POS_REF_ALT", - "CHR_START_END_ONE_BASE", - "CHR_START_END_REF_ALT_ONE_BASE", - "CHR_START_END_ZERO_BASE", - "CHR_START_END_REF_ALT_ZERO_BASE" - ], - "type": "string" - }, - "EncryptionType": { - "enum": [ - "KMS" - ], - "type": "string" - }, - "FormatToHeader": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "FormatToHeaderKey": { - "enum": [ - "CHR", - "START", - "END", - "REF", - "ALT", - "POS" - ], - "type": "string" - }, - "ReferenceItem": { - "additionalProperties": false, - "properties": { - "ReferenceArn": { - "maxLength": 127, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - } - }, - "required": [ - "ReferenceArn" - ], - "type": "object" - }, - "SchemaItem": { - "additionalProperties": false, - "maxProperties": 1, - "minProperties": 1, - "patternProperties": { - "^[a-z0-9_]{1,255}$": { - "$ref": "#/definitions/SchemaValueType" - } - }, - "type": "object" - }, - "SchemaValueType": { - "enum": [ - "LONG", - "INT", - "STRING", - "FLOAT", - "DOUBLE", - "BOOLEAN" - ], - "type": "string" - }, - "SseConfig": { - "additionalProperties": false, - "properties": { - "KeyArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/EncryptionType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "StoreFormat": { - "enum": [ - "GFF", - "TSV", - "VCF" - ], - "type": "string" - }, - "StoreOptions": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "TsvStoreOptions": { - "$ref": "#/definitions/TsvStoreOptions" - } - }, - "required": [ - "TsvStoreOptions" - ], - "title": "TsvStoreOptions", - "type": "object" - } - ] - }, - "StoreStatus": { - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "FAILED" - ], - "type": "string" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TsvStoreOptions": { - "additionalProperties": false, - "properties": { - "AnnotationType": { - "$ref": "#/definitions/AnnotationType" - }, - "FormatToHeader": { - "$ref": "#/definitions/FormatToHeader" - }, - "Schema": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SchemaItem" - }, - "maxItems": 5000, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Omics::AnnotationStore Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateAnnotationStore", - "omics:TagResource", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:CreateGrant", - "ram:AcceptResourceShareInvitation", - "ram:GetResourceShareInvitations", - "omics:GetAnnotationStore" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteAnnotationStore", - "omics:ListAnnotationStores" - ] - }, - "list": { - "permissions": [ - "omics:ListAnnotationStores" - ] - }, - "read": { - "permissions": [ - "omics:GetAnnotationStore" - ] - }, - "update": { - "permissions": [ - "omics:UpdateAnnotationStore", - "omics:TagResource", - "omics:UntagResource", - "omics:GetAnnotationStore", - "omics:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "Id": { - "pattern": "^[a-f0-9]{12}$", - "type": "string" - }, - "Name": { - "pattern": "^([a-z]){1}([a-z0-9_]){2,254}", - "type": "string" - }, - "Reference": { - "$ref": "#/definitions/ReferenceItem" - }, - "SseConfig": { - "$ref": "#/definitions/SseConfig" - }, - "Status": { - "$ref": "#/definitions/StoreStatus" - }, - "StatusMessage": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "StoreArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$", - "type": "string" - }, - "StoreFormat": { - "$ref": "#/definitions/StoreFormat" - }, - "StoreOptions": { - "$ref": "#/definitions/StoreOptions" - }, - "StoreSizeBytes": { - "type": "number" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "UpdateTime": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/Id", - "/properties/Status", - "/properties/StatusMessage", - "/properties/StoreArn", - "/properties/StoreSizeBytes", - "/properties/UpdateTime" - ], - "required": [ - "Name", - "StoreFormat" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Omics::AnnotationStore" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Reference", + "/properties/SseConfig", + "/properties/StoreFormat", + "/properties/StoreOptions", + "/properties/Tags" + ], + "definitions": { + "AnnotationType": { + "enum": [ + "GENERIC", + "CHR_POS", + "CHR_POS_REF_ALT", + "CHR_START_END_ONE_BASE", + "CHR_START_END_REF_ALT_ONE_BASE", + "CHR_START_END_ZERO_BASE", + "CHR_START_END_REF_ALT_ZERO_BASE" + ], + "type": "string" + }, + "EncryptionType": { + "enum": [ + "KMS" + ], + "type": "string" + }, + "FormatToHeader": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "FormatToHeaderKey": { + "enum": [ + "CHR", + "START", + "END", + "REF", + "ALT", + "POS" + ], + "type": "string" + }, + "ReferenceItem": { + "additionalProperties": false, + "properties": { + "ReferenceArn": { + "maxLength": 127, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + } + }, + "required": [ + "ReferenceArn" + ], + "type": "object" + }, + "SchemaItem": { + "additionalProperties": false, + "maxProperties": 1, + "minProperties": 1, + "patternProperties": { + "^[a-z0-9_]{1,255}$": { + "$ref": "#/definitions/SchemaValueType" + } + }, + "type": "object" + }, + "SchemaValueType": { + "enum": [ + "LONG", + "INT", + "STRING", + "FLOAT", + "DOUBLE", + "BOOLEAN" + ], + "type": "string" + }, + "SseConfig": { + "additionalProperties": false, + "properties": { + "KeyArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "StoreFormat": { + "enum": [ + "GFF", + "TSV", + "VCF" + ], + "type": "string" + }, + "StoreOptions": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "TsvStoreOptions": { + "$ref": "#/definitions/TsvStoreOptions" + } + }, + "required": [ + "TsvStoreOptions" + ], + "title": "TsvStoreOptions", + "type": "object" + } + ] + }, + "StoreStatus": { + "enum": [ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ], + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TsvStoreOptions": { + "additionalProperties": false, + "properties": { + "AnnotationType": { + "$ref": "#/definitions/AnnotationType" + }, + "FormatToHeader": { + "$ref": "#/definitions/FormatToHeader" + }, + "Schema": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SchemaItem" + }, + "maxItems": 5000, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Omics::AnnotationStore Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateAnnotationStore", + "omics:TagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:CreateGrant", + "ram:AcceptResourceShareInvitation", + "ram:GetResourceShareInvitations", + "omics:GetAnnotationStore" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteAnnotationStore", + "omics:ListAnnotationStores" + ] + }, + "list": { + "permissions": [ + "omics:ListAnnotationStores" + ] + }, + "read": { + "permissions": [ + "omics:GetAnnotationStore" + ] + }, + "update": { + "permissions": [ + "omics:UpdateAnnotationStore", + "omics:TagResource", + "omics:UntagResource", + "omics:GetAnnotationStore", + "omics:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "Id": { + "pattern": "^[a-f0-9]{12}$", + "type": "string" + }, + "Name": { + "pattern": "^([a-z]){1}([a-z0-9_]){2,254}", + "type": "string" + }, + "Reference": { + "$ref": "#/definitions/ReferenceItem" + }, + "SseConfig": { + "$ref": "#/definitions/SseConfig" + }, + "Status": { + "$ref": "#/definitions/StoreStatus" + }, + "StatusMessage": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "StoreArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$", + "type": "string" + }, + "StoreFormat": { + "$ref": "#/definitions/StoreFormat" + }, + "StoreOptions": { + "$ref": "#/definitions/StoreOptions" + }, + "StoreSizeBytes": { + "type": "number" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "UpdateTime": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/Id", + "/properties/Status", + "/properties/StatusMessage", + "/properties/StoreArn", + "/properties/StoreSizeBytes", + "/properties/UpdateTime" + ], + "required": [ + "Name", + "StoreFormat" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Omics::AnnotationStore" +} diff --git a/schema/aws-omics-referencestore.json b/schema/aws-omics-referencestore.json index b7bfadd..3c87b71 100644 --- a/schema/aws-omics-referencestore.json +++ b/schema/aws-omics-referencestore.json @@ -1,134 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/SseConfig", - "/properties/Tags" - ], - "definitions": { - "EncryptionType": { - "enum": [ - "KMS" - ], - "type": "string" - }, - "SseConfig": { - "additionalProperties": false, - "description": "Server-side encryption (SSE) settings for a store.", - "properties": { - "KeyArn": { - "description": "An encryption key ARN.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/EncryptionType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Omics::ReferenceStore Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateReferenceStore", - "omics:TagResource" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteReferenceStore" - ] - }, - "list": { - "permissions": [ - "omics:ListReferenceStores" - ] - }, - "read": { - "permissions": [ - "omics:GetReferenceStore", - "omics:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReferenceStoreId" - ], - "properties": { - "Arn": { - "description": "The store's ARN.", - "maxLength": 127, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - }, - "CreationTime": { - "description": "When the store was created.", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "A description for the store.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Name": { - "description": "A name for the store.", - "maxLength": 127, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "ReferenceStoreId": { - "maxLength": 36, - "minLength": 10, - "pattern": "^[0-9]+$", - "type": "string" - }, - "SseConfig": { - "$ref": "#/definitions/SseConfig" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/ReferenceStoreId" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Omics::ReferenceStore", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/SseConfig", + "/properties/Tags" + ], + "definitions": { + "EncryptionType": { + "enum": [ + "KMS" + ], + "type": "string" + }, + "SseConfig": { + "additionalProperties": false, + "description": "Server-side encryption (SSE) settings for a store.", + "properties": { + "KeyArn": { + "description": "An encryption key ARN.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Omics::ReferenceStore Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateReferenceStore", + "omics:TagResource", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteReferenceStore" + ] + }, + "list": { + "permissions": [ + "omics:ListReferenceStores" + ] + }, + "read": { + "permissions": [ + "omics:GetReferenceStore", + "omics:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReferenceStoreId" + ], + "properties": { + "Arn": { + "description": "The store's ARN.", + "maxLength": 127, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + }, + "CreationTime": { + "description": "When the store was created.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A description for the store.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Name": { + "description": "A name for the store.", + "maxLength": 127, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "ReferenceStoreId": { + "maxLength": 36, + "minLength": 10, + "pattern": "^[0-9]+$", + "type": "string" + }, + "SseConfig": { + "$ref": "#/definitions/SseConfig" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/ReferenceStoreId" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Omics::ReferenceStore", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-omics-rungroup.json b/schema/aws-omics-rungroup.json index 9071e7b..ed06a63 100644 --- a/schema/aws-omics-rungroup.json +++ b/schema/aws-omics-rungroup.json @@ -1,114 +1,114 @@ -{ - "additionalProperties": false, - "definitions": { - "TagMap": { - "additionalProperties": false, - "description": "A map of resource tags", - "patternProperties": { - ".+": { - "description": "Resource tag value", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Omics::RunGroup Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateRunGroup", - "omics:TagResource" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteRunGroup", - "omics:GetRunGroup" - ] - }, - "list": { - "permissions": [ - "omics:ListRunGroups" - ] - }, - "read": { - "permissions": [ - "omics:GetRunGroup" - ] - }, - "update": { - "permissions": [ - "omics:UpdateRunGroup", - "omics:TagResource", - "omics:GetRunGroup", - "omics:ListTagsForResource", - "omics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Id": { - "maxLength": 18, - "minLength": 1, - "pattern": "^[0-9]+$", - "type": "string" - }, - "MaxCpus": { - "maximum": 100000, - "minimum": 1, - "type": "number" - }, - "MaxDuration": { - "maximum": 100000, - "minimum": 1, - "type": "number" - }, - "MaxGpus": { - "maximum": 100000, - "minimum": 1, - "type": "number" - }, - "MaxRuns": { - "maximum": 100000, - "minimum": 1, - "type": "number" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/Id" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Omics::RunGroup" -} +{ + "additionalProperties": false, + "definitions": { + "TagMap": { + "additionalProperties": false, + "description": "A map of resource tags", + "patternProperties": { + ".+": { + "description": "Resource tag value", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Omics::RunGroup Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateRunGroup", + "omics:TagResource" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteRunGroup", + "omics:GetRunGroup" + ] + }, + "list": { + "permissions": [ + "omics:ListRunGroups" + ] + }, + "read": { + "permissions": [ + "omics:GetRunGroup" + ] + }, + "update": { + "permissions": [ + "omics:UpdateRunGroup", + "omics:TagResource", + "omics:GetRunGroup", + "omics:ListTagsForResource", + "omics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Id": { + "maxLength": 18, + "minLength": 1, + "pattern": "^[0-9]+$", + "type": "string" + }, + "MaxCpus": { + "maximum": 100000, + "minimum": 1, + "type": "number" + }, + "MaxDuration": { + "maximum": 100000, + "minimum": 1, + "type": "number" + }, + "MaxGpus": { + "maximum": 100000, + "minimum": 1, + "type": "number" + }, + "MaxRuns": { + "maximum": 100000, + "minimum": 1, + "type": "number" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/Id" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Omics::RunGroup" +} diff --git a/schema/aws-omics-sequencestore.json b/schema/aws-omics-sequencestore.json index 54de14a..1eefc00 100644 --- a/schema/aws-omics-sequencestore.json +++ b/schema/aws-omics-sequencestore.json @@ -1,141 +1,142 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/FallbackLocation", - "/properties/SseConfig", - "/properties/Tags" - ], - "definitions": { - "EncryptionType": { - "enum": [ - "KMS" - ], - "type": "string" - }, - "SseConfig": { - "additionalProperties": false, - "description": "Server-side encryption (SSE) settings for a store.", - "properties": { - "KeyArn": { - "description": "An encryption key ARN.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/EncryptionType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Omics::SequenceStore Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateSequenceStore", - "omics:TagResource" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteSequenceStore" - ] - }, - "list": { - "permissions": [ - "omics:ListSequenceStores" - ] - }, - "read": { - "permissions": [ - "omics:GetSequenceStore", - "omics:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SequenceStoreId" - ], - "properties": { - "Arn": { - "description": "The store's ARN.", - "maxLength": 127, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - }, - "CreationTime": { - "description": "When the store was created.", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "A description for the store.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "FallbackLocation": { - "description": "An S3 URI representing the bucket and folder to store failed read set uploads.", - "minLength": 1, - "pattern": "^s3:\\/\\/([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])\\/?((.{1,1024})\\/)?$", - "type": "string" - }, - "Name": { - "description": "A name for the store.", - "maxLength": 127, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "SequenceStoreId": { - "maxLength": 36, - "minLength": 10, - "pattern": "^[0-9]+$", - "type": "string" - }, - "SseConfig": { - "$ref": "#/definitions/SseConfig" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/SequenceStoreId" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Omics::SequenceStore", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/FallbackLocation", + "/properties/SseConfig", + "/properties/Tags" + ], + "definitions": { + "EncryptionType": { + "enum": [ + "KMS" + ], + "type": "string" + }, + "SseConfig": { + "additionalProperties": false, + "description": "Server-side encryption (SSE) settings for a store.", + "properties": { + "KeyArn": { + "description": "An encryption key ARN.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Omics::SequenceStore Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateSequenceStore", + "omics:TagResource", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteSequenceStore" + ] + }, + "list": { + "permissions": [ + "omics:ListSequenceStores" + ] + }, + "read": { + "permissions": [ + "omics:GetSequenceStore", + "omics:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SequenceStoreId" + ], + "properties": { + "Arn": { + "description": "The store's ARN.", + "maxLength": 127, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + }, + "CreationTime": { + "description": "When the store was created.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "A description for the store.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "FallbackLocation": { + "description": "An S3 URI representing the bucket and folder to store failed read set uploads.", + "minLength": 1, + "pattern": "^s3:\\/\\/([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])\\/?((.{1,1024})\\/)?$", + "type": "string" + }, + "Name": { + "description": "A name for the store.", + "maxLength": 127, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "SequenceStoreId": { + "maxLength": 36, + "minLength": 10, + "pattern": "^[0-9]+$", + "type": "string" + }, + "SseConfig": { + "$ref": "#/definitions/SseConfig" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/SequenceStoreId" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Omics::SequenceStore", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-omics-variantstore.json b/schema/aws-omics-variantstore.json index f6bf53e..fddaf46 100644 --- a/schema/aws-omics-variantstore.json +++ b/schema/aws-omics-variantstore.json @@ -1,183 +1,183 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Reference", - "/properties/SseConfig", - "/properties/Tags" - ], - "definitions": { - "EncryptionType": { - "enum": [ - "KMS" - ], - "type": "string" - }, - "ReferenceItem": { - "additionalProperties": false, - "properties": { - "ReferenceArn": { - "maxLength": 127, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - } - }, - "required": [ - "ReferenceArn" - ], - "type": "object" - }, - "SseConfig": { - "additionalProperties": false, - "properties": { - "KeyArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/EncryptionType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "StoreStatus": { - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "FAILED" - ], - "type": "string" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::Omics::VariantStore Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateVariantStore", - "omics:TagResource", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:CreateGrant", - "ram:AcceptResourceShareInvitation", - "ram:GetResourceShareInvitations", - "omics:GetVariantStore" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteVariantStore", - "omics:ListVariantStores" - ] - }, - "list": { - "permissions": [ - "omics:ListVariantStores" - ] - }, - "read": { - "permissions": [ - "omics:GetVariantStore" - ] - }, - "update": { - "permissions": [ - "omics:UpdateVariantStore", - "omics:TagResource", - "omics:UntagResource", - "omics:ListTagsForResource", - "omics:GetVariantStore" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "Id": { - "pattern": "^[a-f0-9]{12}$", - "type": "string" - }, - "Name": { - "pattern": "^([a-z]){1}([a-z0-9_]){2,254}", - "type": "string" - }, - "Reference": { - "$ref": "#/definitions/ReferenceItem" - }, - "SseConfig": { - "$ref": "#/definitions/SseConfig" - }, - "Status": { - "$ref": "#/definitions/StoreStatus" - }, - "StatusMessage": { - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "StoreArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$", - "type": "string" - }, - "StoreSizeBytes": { - "type": "number" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "UpdateTime": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/Id", - "/properties/Status", - "/properties/StatusMessage", - "/properties/StoreArn", - "/properties/StoreSizeBytes", - "/properties/UpdateTime" - ], - "required": [ - "Name", - "Reference" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Omics::VariantStore" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Reference", + "/properties/SseConfig", + "/properties/Tags" + ], + "definitions": { + "EncryptionType": { + "enum": [ + "KMS" + ], + "type": "string" + }, + "ReferenceItem": { + "additionalProperties": false, + "properties": { + "ReferenceArn": { + "maxLength": 127, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + } + }, + "required": [ + "ReferenceArn" + ], + "type": "object" + }, + "SseConfig": { + "additionalProperties": false, + "properties": { + "KeyArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "StoreStatus": { + "enum": [ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ], + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Omics::VariantStore Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateVariantStore", + "omics:TagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:CreateGrant", + "ram:AcceptResourceShareInvitation", + "ram:GetResourceShareInvitations", + "omics:GetVariantStore" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteVariantStore", + "omics:ListVariantStores" + ] + }, + "list": { + "permissions": [ + "omics:ListVariantStores" + ] + }, + "read": { + "permissions": [ + "omics:GetVariantStore" + ] + }, + "update": { + "permissions": [ + "omics:UpdateVariantStore", + "omics:TagResource", + "omics:UntagResource", + "omics:ListTagsForResource", + "omics:GetVariantStore" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "Id": { + "pattern": "^[a-f0-9]{12}$", + "type": "string" + }, + "Name": { + "pattern": "^([a-z]){1}([a-z0-9_]){2,254}", + "type": "string" + }, + "Reference": { + "$ref": "#/definitions/ReferenceItem" + }, + "SseConfig": { + "$ref": "#/definitions/SseConfig" + }, + "Status": { + "$ref": "#/definitions/StoreStatus" + }, + "StatusMessage": { + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "StoreArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$", + "type": "string" + }, + "StoreSizeBytes": { + "type": "number" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "UpdateTime": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/Id", + "/properties/Status", + "/properties/StatusMessage", + "/properties/StoreArn", + "/properties/StoreSizeBytes", + "/properties/UpdateTime" + ], + "required": [ + "Name", + "Reference" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Omics::VariantStore" +} diff --git a/schema/aws-omics-workflow.json b/schema/aws-omics-workflow.json index 431c14c..f9b465d 100644 --- a/schema/aws-omics-workflow.json +++ b/schema/aws-omics-workflow.json @@ -1,220 +1,220 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DefinitionUri", - "/properties/Engine", - "/properties/Main", - "/properties/ParameterTemplate", - "/properties/StorageCapacity", - "/properties/Accelerators" - ], - "definitions": { - "Accelerators": { - "enum": [ - "GPU" - ], - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "TagMap": { - "additionalProperties": false, - "description": "A map of resource tags", - "patternProperties": { - ".+": { - "description": "Resource tag value", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "WorkflowEngine": { - "enum": [ - "WDL", - "NEXTFLOW", - "CWL" - ], - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "WorkflowParameter": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Optional": { - "type": "boolean" - } - }, - "type": "object" - }, - "WorkflowParameterTemplate": { - "additionalProperties": false, - "maxProperties": 1000, - "minProperties": 1, - "patternProperties": { - "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$": { - "$ref": "#/definitions/WorkflowParameter" - } - }, - "type": "object" - }, - "WorkflowStatus": { - "enum": [ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETED", - "FAILED" - ], - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "WorkflowType": { - "enum": [ - "PRIVATE" - ], - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "description": "Definition of AWS::Omics::Workflow Resource Type", - "handlers": { - "create": { - "permissions": [ - "omics:CreateWorkflow", - "omics:GetWorkflow", - "omics:TagResource", - "s3:PutObject", - "s3:GetObject", - "s3:GetObjectAttributes", - "s3:HeadObject", - "s3:GetEncryptionConfiguration", - "kms:Decrypt", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext" - ] - }, - "delete": { - "permissions": [ - "omics:DeleteWorkflow", - "omics:GetWorkflow" - ] - }, - "list": { - "permissions": [ - "omics:ListWorkflows" - ] - }, - "read": { - "permissions": [ - "omics:GetWorkflow" - ] - }, - "update": { - "permissions": [ - "omics:UpdateWorkflow", - "omics:GetWorkflow", - "omics:TagResource", - "omics:ListTagsForResource", - "omics:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Accelerators": { - "$ref": "#/definitions/Accelerators" - }, - "Arn": { - "maxLength": 128, - "minLength": 1, - "pattern": "^arn:.+$", - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "DefinitionUri": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Description": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Engine": { - "$ref": "#/definitions/WorkflowEngine" - }, - "Id": { - "maxLength": 18, - "minLength": 1, - "pattern": "^[0-9]+$", - "type": "string" - }, - "Main": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", - "type": "string" - }, - "ParameterTemplate": { - "$ref": "#/definitions/WorkflowParameterTemplate" - }, - "Status": { - "$ref": "#/definitions/WorkflowStatus" - }, - "StorageCapacity": { - "maximum": 100000, - "minimum": 0, - "type": "number" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "Type": { - "$ref": "#/definitions/WorkflowType" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/Id", - "/properties/Status", - "/properties/Type" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Omics::Workflow", - "writeOnlyProperties": [ - "/properties/DefinitionUri" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DefinitionUri", + "/properties/Engine", + "/properties/Main", + "/properties/ParameterTemplate", + "/properties/StorageCapacity", + "/properties/Accelerators" + ], + "definitions": { + "Accelerators": { + "enum": [ + "GPU" + ], + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "description": "A map of resource tags", + "patternProperties": { + ".+": { + "description": "Resource tag value", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "WorkflowEngine": { + "enum": [ + "WDL", + "NEXTFLOW", + "CWL" + ], + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "WorkflowParameter": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Optional": { + "type": "boolean" + } + }, + "type": "object" + }, + "WorkflowParameterTemplate": { + "additionalProperties": false, + "maxProperties": 1000, + "minProperties": 1, + "patternProperties": { + "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$": { + "$ref": "#/definitions/WorkflowParameter" + } + }, + "type": "object" + }, + "WorkflowStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETED", + "FAILED" + ], + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "WorkflowType": { + "enum": [ + "PRIVATE" + ], + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "description": "Definition of AWS::Omics::Workflow Resource Type", + "handlers": { + "create": { + "permissions": [ + "omics:CreateWorkflow", + "omics:GetWorkflow", + "omics:TagResource", + "s3:PutObject", + "s3:GetObject", + "s3:GetObjectAttributes", + "s3:HeadObject", + "s3:GetEncryptionConfiguration", + "kms:Decrypt", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext" + ] + }, + "delete": { + "permissions": [ + "omics:DeleteWorkflow", + "omics:GetWorkflow" + ] + }, + "list": { + "permissions": [ + "omics:ListWorkflows" + ] + }, + "read": { + "permissions": [ + "omics:GetWorkflow" + ] + }, + "update": { + "permissions": [ + "omics:UpdateWorkflow", + "omics:GetWorkflow", + "omics:TagResource", + "omics:ListTagsForResource", + "omics:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Accelerators": { + "$ref": "#/definitions/Accelerators" + }, + "Arn": { + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:.+$", + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "DefinitionUri": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Description": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Engine": { + "$ref": "#/definitions/WorkflowEngine" + }, + "Id": { + "maxLength": 18, + "minLength": 1, + "pattern": "^[0-9]+$", + "type": "string" + }, + "Main": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$", + "type": "string" + }, + "ParameterTemplate": { + "$ref": "#/definitions/WorkflowParameterTemplate" + }, + "Status": { + "$ref": "#/definitions/WorkflowStatus" + }, + "StorageCapacity": { + "maximum": 100000, + "minimum": 0, + "type": "number" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "Type": { + "$ref": "#/definitions/WorkflowType" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/Id", + "/properties/Status", + "/properties/Type" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Omics::Workflow", + "writeOnlyProperties": [ + "/properties/DefinitionUri" + ] +} diff --git a/schema/aws-opensearchserverless-accesspolicy.json b/schema/aws-opensearchserverless-accesspolicy.json index e3088c8..e27fadb 100644 --- a/schema/aws-opensearchserverless-accesspolicy.json +++ b/schema/aws-opensearchserverless-accesspolicy.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/Name" - ], - "definitions": { - "AccessPolicyType": { - "description": "The possible types for the access policy", - "enum": [ - "data" - ], - "type": "string" - } - }, - "description": "Amazon OpenSearchServerless access policy resource", - "handlers": { - "create": { - "permissions": [ - "aoss:CreateAccessPolicy", - "aoss:GetAccessPolicy" - ] - }, - "delete": { - "permissions": [ - "aoss:DeleteAccessPolicy", - "aoss:GetAccessPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Type": { - "$ref": "resource-schema.json#/properties/Type" - } - }, - "required": [ - "Type" - ] - }, - "permissions": [ - "aoss:ListAccessPolicies" - ] - }, - "read": { - "permissions": [ - "aoss:GetAccessPolicy" - ] - }, - "update": { - "permissions": [ - "aoss:UpdateAccessPolicy", - "aoss:GetAccessPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Type", - "/properties/Name" - ], - "properties": { - "Description": { - "description": "The description of the policy", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name of the policy", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]{2,31}$", - "type": "string" - }, - "Policy": { - "description": "The JSON policy document that is the content for the policy", - "maxLength": 20480, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/AccessPolicyType" - } - }, - "required": [ - "Type", - "Name", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::OpenSearchServerless::AccessPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/Name" + ], + "definitions": { + "AccessPolicyType": { + "description": "The possible types for the access policy", + "enum": [ + "data" + ], + "type": "string" + } + }, + "description": "Amazon OpenSearchServerless access policy resource", + "handlers": { + "create": { + "permissions": [ + "aoss:CreateAccessPolicy", + "aoss:GetAccessPolicy" + ] + }, + "delete": { + "permissions": [ + "aoss:DeleteAccessPolicy", + "aoss:GetAccessPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Type": { + "$ref": "resource-schema.json#/properties/Type" + } + }, + "required": [ + "Type" + ] + }, + "permissions": [ + "aoss:ListAccessPolicies" + ] + }, + "read": { + "permissions": [ + "aoss:GetAccessPolicy" + ] + }, + "update": { + "permissions": [ + "aoss:UpdateAccessPolicy", + "aoss:GetAccessPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Type", + "/properties/Name" + ], + "properties": { + "Description": { + "description": "The description of the policy", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name of the policy", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]{2,31}$", + "type": "string" + }, + "Policy": { + "description": "The JSON policy document that is the content for the policy", + "maxLength": 20480, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/AccessPolicyType" + } + }, + "required": [ + "Type", + "Name", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::OpenSearchServerless::AccessPolicy" +} diff --git a/schema/aws-opensearchserverless-collection.json b/schema/aws-opensearchserverless-collection.json index bee6633..f63730d 100644 --- a/schema/aws-opensearchserverless-collection.json +++ b/schema/aws-opensearchserverless-collection.json @@ -1,161 +1,161 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ], - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags", - "/properties/Type" - ], - "definitions": { - "CollectionType": { - "description": "The possible types for the collection", - "enum": [ - "SEARCH", - "TIMESERIES", - "VECTORSEARCH" - ], - "type": "string" - }, - "StandbyReplicas": { - "description": "The possible standby replicas for the collection", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair metadata associated with resource", - "properties": { - "Key": { - "description": "The key in the key-value pair", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value in the key-value pair", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Amazon OpenSearchServerless collection resource", - "handlers": { - "create": { - "permissions": [ - "aoss:CreateCollection", - "aoss:BatchGetCollection", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "aoss:DeleteCollection", - "aoss:BatchGetCollection" - ] - }, - "list": { - "permissions": [ - "aoss:ListCollections" - ] - }, - "read": { - "permissions": [ - "aoss:BatchGetCollection" - ] - }, - "update": { - "permissions": [ - "aoss:UpdateCollection", - "aoss:BatchGetCollection" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the collection.", - "type": "string" - }, - "CollectionEndpoint": { - "description": "The endpoint for the collection.", - "type": "string" - }, - "DashboardEndpoint": { - "description": "The OpenSearch Dashboards endpoint for the collection.", - "type": "string" - }, - "Description": { - "description": "The description of the collection", - "maxLength": 1000, - "type": "string" - }, - "Id": { - "description": "The identifier of the collection", - "maxLength": 40, - "minLength": 3, - "type": "string" - }, - "Name": { - "description": "The name of the collection.\n\nThe name must meet the following criteria:\nUnique to your account and AWS Region\nStarts with a lowercase letter\nContains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)\nContains between 3 and 32 characters\n", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]{2,31}$", - "type": "string" - }, - "StandbyReplicas": { - "$ref": "#/definitions/StandbyReplicas" - }, - "Tags": { - "description": "List of tags to be added to the resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/CollectionType" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/CollectionEndpoint", - "/properties/DashboardEndpoint" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::OpenSearchServerless::Collection", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ], + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags", + "/properties/Type" + ], + "definitions": { + "CollectionType": { + "description": "The possible types for the collection", + "enum": [ + "SEARCH", + "TIMESERIES", + "VECTORSEARCH" + ], + "type": "string" + }, + "StandbyReplicas": { + "description": "The possible standby replicas for the collection", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair metadata associated with resource", + "properties": { + "Key": { + "description": "The key in the key-value pair", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value in the key-value pair", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Amazon OpenSearchServerless collection resource", + "handlers": { + "create": { + "permissions": [ + "aoss:CreateCollection", + "aoss:BatchGetCollection", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "aoss:DeleteCollection", + "aoss:BatchGetCollection" + ] + }, + "list": { + "permissions": [ + "aoss:ListCollections" + ] + }, + "read": { + "permissions": [ + "aoss:BatchGetCollection" + ] + }, + "update": { + "permissions": [ + "aoss:UpdateCollection", + "aoss:BatchGetCollection" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the collection.", + "type": "string" + }, + "CollectionEndpoint": { + "description": "The endpoint for the collection.", + "type": "string" + }, + "DashboardEndpoint": { + "description": "The OpenSearch Dashboards endpoint for the collection.", + "type": "string" + }, + "Description": { + "description": "The description of the collection", + "maxLength": 1000, + "type": "string" + }, + "Id": { + "description": "The identifier of the collection", + "maxLength": 40, + "minLength": 3, + "type": "string" + }, + "Name": { + "description": "The name of the collection.\n\nThe name must meet the following criteria:\nUnique to your account and AWS Region\nStarts with a lowercase letter\nContains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)\nContains between 3 and 32 characters\n", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]{2,31}$", + "type": "string" + }, + "StandbyReplicas": { + "$ref": "#/definitions/StandbyReplicas" + }, + "Tags": { + "description": "List of tags to be added to the resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/CollectionType" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/CollectionEndpoint", + "/properties/DashboardEndpoint" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::OpenSearchServerless::Collection", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-opensearchserverless-lifecyclepolicy.json b/schema/aws-opensearchserverless-lifecyclepolicy.json index c8fe60d..1912a5d 100644 --- a/schema/aws-opensearchserverless-lifecyclepolicy.json +++ b/schema/aws-opensearchserverless-lifecyclepolicy.json @@ -1,97 +1,97 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/Name" - ], - "definitions": { - "LifecyclePolicyType": { - "description": "The type of lifecycle policy", - "enum": [ - "retention" - ], - "type": "string" - } - }, - "description": "Amazon OpenSearchServerless lifecycle policy resource", - "handlers": { - "create": { - "permissions": [ - "aoss:CreateLifecyclePolicy" - ] - }, - "delete": { - "permissions": [ - "aoss:DeleteLifecyclePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Type": { - "$ref": "resource-schema.json#/properties/Type" - } - }, - "required": [ - "Type" - ] - }, - "permissions": [ - "aoss:ListLifecyclePolicies" - ] - }, - "read": { - "permissions": [ - "aoss:BatchGetLifecyclePolicy" - ] - }, - "update": { - "permissions": [ - "aoss:UpdateLifecyclePolicy", - "aoss:BatchGetLifecyclePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Type", - "/properties/Name" - ], - "properties": { - "Description": { - "description": "The description of the policy", - "maxLength": 1000, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "The name of the policy", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]+$", - "type": "string" - }, - "Policy": { - "description": "The JSON policy document that is the content for the policy", - "maxLength": 20480, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/LifecyclePolicyType" - } - }, - "required": [ - "Type", - "Name", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::OpenSearchServerless::LifecyclePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/Name" + ], + "definitions": { + "LifecyclePolicyType": { + "description": "The type of lifecycle policy", + "enum": [ + "retention" + ], + "type": "string" + } + }, + "description": "Amazon OpenSearchServerless lifecycle policy resource", + "handlers": { + "create": { + "permissions": [ + "aoss:CreateLifecyclePolicy" + ] + }, + "delete": { + "permissions": [ + "aoss:DeleteLifecyclePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Type": { + "$ref": "resource-schema.json#/properties/Type" + } + }, + "required": [ + "Type" + ] + }, + "permissions": [ + "aoss:ListLifecyclePolicies" + ] + }, + "read": { + "permissions": [ + "aoss:BatchGetLifecyclePolicy" + ] + }, + "update": { + "permissions": [ + "aoss:UpdateLifecyclePolicy", + "aoss:BatchGetLifecyclePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Type", + "/properties/Name" + ], + "properties": { + "Description": { + "description": "The description of the policy", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "The name of the policy", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]+$", + "type": "string" + }, + "Policy": { + "description": "The JSON policy document that is the content for the policy", + "maxLength": 20480, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/LifecyclePolicyType" + } + }, + "required": [ + "Type", + "Name", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::OpenSearchServerless::LifecyclePolicy" +} diff --git a/schema/aws-opensearchserverless-securityconfig.json b/schema/aws-opensearchserverless-securityconfig.json index ca9d5fc..22c8602 100644 --- a/schema/aws-opensearchserverless-securityconfig.json +++ b/schema/aws-opensearchserverless-securityconfig.json @@ -1,139 +1,139 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/Name" - ], - "definitions": { - "SamlConfigOptions": { - "additionalProperties": false, - "description": "Describes saml options in form of key value map", - "properties": { - "GroupAttribute": { - "description": "Group attribute for this saml integration", - "maxLength": 2048, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "Metadata": { - "description": "The XML saml provider metadata document that you want to use", - "maxLength": 51200, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", - "type": "string" - }, - "SessionTimeout": { - "description": "Defines the session timeout in minutes", - "type": "integer" - }, - "UserAttribute": { - "description": "Custom attribute for this saml integration", - "maxLength": 2048, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - } - }, - "required": [ - "Metadata" - ], - "type": "object" - }, - "SecurityConfigType": { - "description": "Config type for security config", - "enum": [ - "saml" - ], - "type": "string" - } - }, - "description": "Amazon OpenSearchServerless security config resource", - "handlers": { - "create": { - "permissions": [ - "aoss:CreateSecurityConfig" - ] - }, - "delete": { - "permissions": [ - "aoss:DeleteSecurityConfig" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Type": { - "$ref": "resource-schema.json#/properties/Type" - } - }, - "required": [ - "Type" - ] - }, - "permissions": [ - "aoss:ListSecurityConfigs" - ] - }, - "read": { - "permissions": [ - "aoss:GetSecurityConfig" - ] - }, - "update": { - "permissions": [ - "aoss:GetSecurityConfig", - "aoss:UpdateSecurityConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "description": "Security config description", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "The identifier of the security config", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The friendly name of the security config", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]{2,31}$", - "type": "string" - }, - "SamlOptions": { - "$ref": "#/definitions/SamlConfigOptions" - }, - "Type": { - "$ref": "#/definitions/SecurityConfigType" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::OpenSearchServerless::SecurityConfig", - "writeOnlyProperties": [ - "/properties/Name" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/Name" + ], + "definitions": { + "SamlConfigOptions": { + "additionalProperties": false, + "description": "Describes saml options in form of key value map", + "properties": { + "GroupAttribute": { + "description": "Group attribute for this saml integration", + "maxLength": 2048, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Metadata": { + "description": "The XML saml provider metadata document that you want to use", + "maxLength": 51200, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", + "type": "string" + }, + "SessionTimeout": { + "description": "Defines the session timeout in minutes", + "type": "integer" + }, + "UserAttribute": { + "description": "Custom attribute for this saml integration", + "maxLength": 2048, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "required": [ + "Metadata" + ], + "type": "object" + }, + "SecurityConfigType": { + "description": "Config type for security config", + "enum": [ + "saml" + ], + "type": "string" + } + }, + "description": "Amazon OpenSearchServerless security config resource", + "handlers": { + "create": { + "permissions": [ + "aoss:CreateSecurityConfig" + ] + }, + "delete": { + "permissions": [ + "aoss:DeleteSecurityConfig" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Type": { + "$ref": "resource-schema.json#/properties/Type" + } + }, + "required": [ + "Type" + ] + }, + "permissions": [ + "aoss:ListSecurityConfigs" + ] + }, + "read": { + "permissions": [ + "aoss:GetSecurityConfig" + ] + }, + "update": { + "permissions": [ + "aoss:GetSecurityConfig", + "aoss:UpdateSecurityConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "description": "Security config description", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The identifier of the security config", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The friendly name of the security config", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]{2,31}$", + "type": "string" + }, + "SamlOptions": { + "$ref": "#/definitions/SamlConfigOptions" + }, + "Type": { + "$ref": "#/definitions/SecurityConfigType" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::OpenSearchServerless::SecurityConfig", + "writeOnlyProperties": [ + "/properties/Name" + ] +} diff --git a/schema/aws-opensearchserverless-securitypolicy.json b/schema/aws-opensearchserverless-securitypolicy.json index 2a8fd81..1102107 100644 --- a/schema/aws-opensearchserverless-securitypolicy.json +++ b/schema/aws-opensearchserverless-securitypolicy.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/Name" - ], - "definitions": { - "SecurityPolicyType": { - "description": "The possible types for the network policy", - "enum": [ - "encryption", - "network" - ], - "type": "string" - } - }, - "description": "Amazon OpenSearchServerless security policy resource", - "handlers": { - "create": { - "permissions": [ - "aoss:GetSecurityPolicy", - "aoss:CreateSecurityPolicy", - "kms:DescribeKey", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "aoss:GetSecurityPolicy", - "aoss:DeleteSecurityPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Type": { - "$ref": "resource-schema.json#/properties/Type" - } - }, - "required": [ - "Type" - ] - }, - "permissions": [ - "aoss:ListSecurityPolicies" - ] - }, - "read": { - "permissions": [ - "aoss:GetSecurityPolicy", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "aoss:GetSecurityPolicy", - "aoss:UpdateSecurityPolicy", - "kms:DescribeKey", - "kms:CreateGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/Type", - "/properties/Name" - ], - "properties": { - "Description": { - "description": "The description of the policy", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name of the policy", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]{2,31}$", - "type": "string" - }, - "Policy": { - "description": "The JSON policy document that is the content for the policy", - "maxLength": 20480, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SecurityPolicyType" - } - }, - "required": [ - "Type", - "Name", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::OpenSearchServerless::SecurityPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/Name" + ], + "definitions": { + "SecurityPolicyType": { + "description": "The possible types for the network policy", + "enum": [ + "encryption", + "network" + ], + "type": "string" + } + }, + "description": "Amazon OpenSearchServerless security policy resource", + "handlers": { + "create": { + "permissions": [ + "aoss:GetSecurityPolicy", + "aoss:CreateSecurityPolicy", + "kms:DescribeKey", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "aoss:GetSecurityPolicy", + "aoss:DeleteSecurityPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Type": { + "$ref": "resource-schema.json#/properties/Type" + } + }, + "required": [ + "Type" + ] + }, + "permissions": [ + "aoss:ListSecurityPolicies" + ] + }, + "read": { + "permissions": [ + "aoss:GetSecurityPolicy", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "aoss:GetSecurityPolicy", + "aoss:UpdateSecurityPolicy", + "kms:DescribeKey", + "kms:CreateGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/Type", + "/properties/Name" + ], + "properties": { + "Description": { + "description": "The description of the policy", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name of the policy", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]{2,31}$", + "type": "string" + }, + "Policy": { + "description": "The JSON policy document that is the content for the policy", + "maxLength": 20480, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SecurityPolicyType" + } + }, + "required": [ + "Type", + "Name", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-opensearchserverless", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::OpenSearchServerless::SecurityPolicy" +} diff --git a/schema/aws-opensearchserverless-vpcendpoint.json b/schema/aws-opensearchserverless-vpcendpoint.json index 429663d..75c1692 100644 --- a/schema/aws-opensearchserverless-vpcendpoint.json +++ b/schema/aws-opensearchserverless-vpcendpoint.json @@ -1,159 +1,159 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/VpcId" - ], - "description": "Amazon OpenSearchServerless vpc endpoint resource", - "handlers": { - "create": { - "permissions": [ - "aoss:BatchGetVpcEndpoint", - "aoss:CreateVpcEndpoint", - "ec2:CreateVpcEndpoint", - "ec2:DeleteVpcEndPoints", - "ec2:DescribeVpcEndpoints", - "ec2:ModifyVpcEndPoint", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:CreateTags", - "route53:ChangeResourceRecordSets", - "route53:GetChange", - "route53:GetHostedZone", - "route53:ListResourceRecordSets", - "route53:ListHostedZonesByName", - "route53:CreateHostedZone", - "route53:ListHostedZonesByVPC", - "route53:AssociateVPCWithHostedZone" - ] - }, - "delete": { - "permissions": [ - "aoss:BatchGetVpcEndpoint", - "aoss:DeleteVpcEndpoint", - "ec2:DeleteVpcEndPoints", - "ec2:DescribeVpcEndpoints", - "ec2:ModifyVpcEndPoint", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:CreateTags", - "route53:ChangeResourceRecordSets", - "route53:DeleteHostedZone", - "route53:GetChange", - "route53:GetHostedZone", - "route53:ListResourceRecordSets", - "route53:ListHostedZonesByName", - "route53:ListHostedZonesByVPC", - "route53:AssociateVPCWithHostedZone" - ] - }, - "list": { - "permissions": [ - "aoss:ListVpcEndpoints", - "ec2:DescribeVpcEndpoints" - ] - }, - "read": { - "permissions": [ - "aoss:BatchGetVpcEndpoint", - "ec2:DescribeVpcEndpoints" - ] - }, - "update": { - "permissions": [ - "aoss:BatchGetVpcEndpoint", - "aoss:UpdateVpcEndpoint", - "ec2:CreateVpcEndpoint", - "ec2:DeleteVpcEndPoints", - "ec2:DescribeVpcEndpoints", - "ec2:ModifyVpcEndPoint", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "ec2:CreateTags", - "route53:ChangeResourceRecordSets", - "route53:GetChange", - "route53:GetHostedZone", - "route53:ListResourceRecordSets", - "route53:ListHostedZonesByName", - "route53:CreateHostedZone", - "route53:ListHostedZonesByVPC", - "route53:AssociateVPCWithHostedZone" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "The identifier of the VPC Endpoint", - "maxLength": 255, - "minLength": 1, - "pattern": "^vpce-[0-9a-z]*$", - "type": "string" - }, - "Name": { - "description": "The name of the VPC Endpoint", - "maxLength": 32, - "minLength": 3, - "pattern": "^[a-z][a-z0-9-]{2,31}$", - "type": "string" - }, - "SecurityGroupIds": { - "description": "The ID of one or more security groups to associate with the endpoint network interface", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\w+\\-]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SubnetIds": { - "description": "The ID of one or more subnets in which to create an endpoint network interface", - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", - "type": "string" - }, - "maxItems": 6, - "minItems": 1, - "type": "array" - }, - "VpcId": { - "description": "The ID of the VPC in which the endpoint will be used.", - "maxLength": 255, - "minLength": 1, - "pattern": "^vpc-[0-9a-z]*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "VpcId", - "SubnetIds" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::OpenSearchServerless::VpcEndpoint" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/VpcId" + ], + "description": "Amazon OpenSearchServerless vpc endpoint resource", + "handlers": { + "create": { + "permissions": [ + "aoss:BatchGetVpcEndpoint", + "aoss:CreateVpcEndpoint", + "ec2:CreateVpcEndpoint", + "ec2:DeleteVpcEndPoints", + "ec2:DescribeVpcEndpoints", + "ec2:ModifyVpcEndPoint", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:CreateTags", + "route53:ChangeResourceRecordSets", + "route53:GetChange", + "route53:GetHostedZone", + "route53:ListResourceRecordSets", + "route53:ListHostedZonesByName", + "route53:CreateHostedZone", + "route53:ListHostedZonesByVPC", + "route53:AssociateVPCWithHostedZone" + ] + }, + "delete": { + "permissions": [ + "aoss:BatchGetVpcEndpoint", + "aoss:DeleteVpcEndpoint", + "ec2:DeleteVpcEndPoints", + "ec2:DescribeVpcEndpoints", + "ec2:ModifyVpcEndPoint", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:CreateTags", + "route53:ChangeResourceRecordSets", + "route53:DeleteHostedZone", + "route53:GetChange", + "route53:GetHostedZone", + "route53:ListResourceRecordSets", + "route53:ListHostedZonesByName", + "route53:ListHostedZonesByVPC", + "route53:AssociateVPCWithHostedZone" + ] + }, + "list": { + "permissions": [ + "aoss:ListVpcEndpoints", + "ec2:DescribeVpcEndpoints" + ] + }, + "read": { + "permissions": [ + "aoss:BatchGetVpcEndpoint", + "ec2:DescribeVpcEndpoints" + ] + }, + "update": { + "permissions": [ + "aoss:BatchGetVpcEndpoint", + "aoss:UpdateVpcEndpoint", + "ec2:CreateVpcEndpoint", + "ec2:DeleteVpcEndPoints", + "ec2:DescribeVpcEndpoints", + "ec2:ModifyVpcEndPoint", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:CreateTags", + "route53:ChangeResourceRecordSets", + "route53:GetChange", + "route53:GetHostedZone", + "route53:ListResourceRecordSets", + "route53:ListHostedZonesByName", + "route53:CreateHostedZone", + "route53:ListHostedZonesByVPC", + "route53:AssociateVPCWithHostedZone" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "The identifier of the VPC Endpoint", + "maxLength": 255, + "minLength": 1, + "pattern": "^vpce-[0-9a-z]*$", + "type": "string" + }, + "Name": { + "description": "The name of the VPC Endpoint", + "maxLength": 32, + "minLength": 3, + "pattern": "^[a-z][a-z0-9-]{2,31}$", + "type": "string" + }, + "SecurityGroupIds": { + "description": "The ID of one or more security groups to associate with the endpoint network interface", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w+\\-]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "description": "The ID of one or more subnets in which to create an endpoint network interface", + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", + "type": "string" + }, + "maxItems": 6, + "minItems": 1, + "type": "array" + }, + "VpcId": { + "description": "The ID of the VPC in which the endpoint will be used.", + "maxLength": 255, + "minLength": 1, + "pattern": "^vpc-[0-9a-z]*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name", + "VpcId", + "SubnetIds" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::OpenSearchServerless::VpcEndpoint" +} diff --git a/schema/aws-opensearchservice-domain.json b/schema/aws-opensearchservice-domain.json index 7d12e7f..8b60c24 100644 --- a/schema/aws-opensearchservice-domain.json +++ b/schema/aws-opensearchservice-domain.json @@ -1,535 +1,560 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/EncryptionAtRestOptions/properties", - "/properties/AdvancedSecurityOptions/properties/Enabled" - ], - "createOnlyProperties": [ - "/properties/DomainName" - ], - "definitions": { - "AdvancedSecurityOptionsInput": { - "additionalProperties": false, - "properties": { - "AnonymousAuthDisableDate": { - "type": "string" - }, - "AnonymousAuthEnabled": { - "type": "boolean" - }, - "Enabled": { - "type": "boolean" - }, - "InternalUserDatabaseEnabled": { - "type": "boolean" - }, - "MasterUserOptions": { - "$ref": "#/definitions/MasterUserOptions" - }, - "SAMLOptions": { - "$ref": "#/definitions/SAMLOptions" - } - }, - "type": "object" - }, - "ClusterConfig": { - "additionalProperties": false, - "properties": { - "ColdStorageOptions": { - "$ref": "#/definitions/ColdStorageOptions" - }, - "DedicatedMasterCount": { - "type": "integer" - }, - "DedicatedMasterEnabled": { - "type": "boolean" - }, - "DedicatedMasterType": { - "type": "string" - }, - "InstanceCount": { - "type": "integer" - }, - "InstanceType": { - "type": "string" - }, - "MultiAZWithStandbyEnabled": { - "type": "boolean" - }, - "WarmCount": { - "type": "integer" - }, - "WarmEnabled": { - "type": "boolean" - }, - "WarmType": { - "type": "string" - }, - "ZoneAwarenessConfig": { - "$ref": "#/definitions/ZoneAwarenessConfig" - }, - "ZoneAwarenessEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "CognitoOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "IdentityPoolId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "ColdStorageOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "DomainEndpointOptions": { - "additionalProperties": false, - "properties": { - "CustomEndpoint": { - "type": "string" - }, - "CustomEndpointCertificateArn": { - "type": "string" - }, - "CustomEndpointEnabled": { - "type": "boolean" - }, - "EnforceHTTPS": { - "type": "boolean" - }, - "TLSSecurityPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "EBSOptions": { - "additionalProperties": false, - "properties": { - "EBSEnabled": { - "type": "boolean" - }, - "Iops": { - "type": "integer" - }, - "Throughput": { - "type": "integer" - }, - "VolumeSize": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "EncryptionAtRestOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "KmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "Idp": { - "additionalProperties": false, - "properties": { - "EntityId": { - "type": "string" - }, - "MetadataContent": { - "maxLength": 1048576, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MetadataContent", - "EntityId" - ], - "type": "object" - }, - "LogPublishingOption": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "MasterUserOptions": { - "additionalProperties": false, - "properties": { - "MasterUserARN": { - "type": "string" - }, - "MasterUserName": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - } - }, - "type": "object" - }, - "NodeToNodeEncryptionOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "OffPeakWindow": { - "additionalProperties": false, - "properties": { - "WindowStartTime": { - "$ref": "#/definitions/WindowStartTime" - } - }, - "type": "object" - }, - "OffPeakWindowOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "OffPeakWindow": { - "$ref": "#/definitions/OffPeakWindow" - } - }, - "type": "object" - }, - "SAMLOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Idp": { - "$ref": "#/definitions/Idp" - }, - "MasterBackendRole": { - "type": "string" - }, - "MasterUserName": { - "type": "string" - }, - "RolesKey": { - "type": "string" - }, - "SessionTimeoutMinutes": { - "type": "integer" - }, - "SubjectKey": { - "type": "string" - } - }, - "type": "object" - }, - "ServiceSoftwareOptions": { - "additionalProperties": false, - "properties": { - "AutomatedUpdateDate": { - "type": "string" - }, - "Cancellable": { - "type": "boolean" - }, - "CurrentVersion": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "NewVersion": { - "type": "string" - }, - "OptionalDeployment": { - "type": "boolean" - }, - "UpdateAvailable": { - "type": "boolean" - }, - "UpdateStatus": { - "type": "string" - } - }, - "type": "object" - }, - "SnapshotOptions": { - "additionalProperties": false, - "properties": { - "AutomatedSnapshotStartHour": { - "type": "integer" - } - }, - "type": "object" - }, - "SoftwareUpdateOptions": { - "additionalProperties": false, - "properties": { - "AutoSoftwareUpdateEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The value of the tag.", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "Value": { - "description": "The key of the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VPCOptions": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "WindowStartTime": { - "additionalProperties": false, - "properties": { - "Hours": { - "maximum": 23, - "minimum": 0, - "type": "integer" - }, - "Minutes": { - "maximum": 59, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "Hours", - "Minutes" - ], - "type": "object" - }, - "ZoneAwarenessConfig": { - "additionalProperties": false, - "properties": { - "AvailabilityZoneCount": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "es:CreateDomain", - "es:DescribeDomain", - "es:AddTags", - "es:ListTags" - ] - }, - "delete": { - "permissions": [ - "es:DeleteDomain", - "es:DescribeDomain" - ] - }, - "read": { - "permissions": [ - "es:DescribeDomain", - "es:ListTags" - ] - }, - "update": { - "permissions": [ - "es:UpdateDomain", - "es:UpgradeDomain", - "es:DescribeDomain", - "es:AddTags", - "es:RemoveTags", - "es:ListTags", - "es:DescribeDomainChangeProgress" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DomainName" - ], - "properties": { - "AccessPolicies": { - "type": "object" - }, - "AdvancedOptions": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "AdvancedSecurityOptions": { - "$ref": "#/definitions/AdvancedSecurityOptionsInput" - }, - "Arn": { - "type": "string" - }, - "ClusterConfig": { - "$ref": "#/definitions/ClusterConfig" - }, - "CognitoOptions": { - "$ref": "#/definitions/CognitoOptions" - }, - "DomainArn": { - "type": "string" - }, - "DomainEndpoint": { - "type": "string" - }, - "DomainEndpointOptions": { - "$ref": "#/definitions/DomainEndpointOptions" - }, - "DomainEndpointV2": { - "type": "string" - }, - "DomainEndpoints": { - "additionalProperties": false, - "patternProperties": { - "^.*$": { - "type": "string" - } - }, - "type": "object" - }, - "DomainName": { - "type": "string" - }, - "EBSOptions": { - "$ref": "#/definitions/EBSOptions" - }, - "EncryptionAtRestOptions": { - "$ref": "#/definitions/EncryptionAtRestOptions" - }, - "EngineVersion": { - "type": "string" - }, - "IPAddressType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LogPublishingOptions": { - "additionalProperties": false, - "patternProperties": { - "[a-zA-Z0-9]+": { - "$ref": "#/definitions/LogPublishingOption" - } - }, - "type": "object" - }, - "NodeToNodeEncryptionOptions": { - "$ref": "#/definitions/NodeToNodeEncryptionOptions" - }, - "OffPeakWindowOptions": { - "$ref": "#/definitions/OffPeakWindowOptions" - }, - "ServiceSoftwareOptions": { - "$ref": "#/definitions/ServiceSoftwareOptions" - }, - "SnapshotOptions": { - "$ref": "#/definitions/SnapshotOptions" - }, - "SoftwareUpdateOptions": { - "$ref": "#/definitions/SoftwareUpdateOptions" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this Domain.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VPCOptions": { - "$ref": "#/definitions/VPCOptions" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/DomainArn", - "/properties/DomainEndpoint", - "/properties/DomainEndpointV2", - "/properties/DomainEndpoints", - "/properties/ServiceSoftwareOptions", - "/properties/AdvancedSecurityOptions/AnonymousAuthDisableDate" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::OpenSearchService::Domain", - "writeOnlyProperties": [ - "/properties/AdvancedSecurityOptions/MasterUserOptions", - "/properties/AdvancedSecurityOptions/SAMLOptions/MasterUserName", - "/properties/AdvancedSecurityOptions/SAMLOptions/MasterBackendRole" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/EncryptionAtRestOptions/properties", + "/properties/AdvancedSecurityOptions/properties/Enabled" + ], + "createOnlyProperties": [ + "/properties/DomainName" + ], + "definitions": { + "AdvancedSecurityOptionsInput": { + "additionalProperties": false, + "properties": { + "AnonymousAuthDisableDate": { + "type": "string" + }, + "AnonymousAuthEnabled": { + "type": "boolean" + }, + "Enabled": { + "type": "boolean" + }, + "InternalUserDatabaseEnabled": { + "type": "boolean" + }, + "JWTOptions": { + "$ref": "#/definitions/JWTOptions" + }, + "MasterUserOptions": { + "$ref": "#/definitions/MasterUserOptions" + }, + "SAMLOptions": { + "$ref": "#/definitions/SAMLOptions" + } + }, + "type": "object" + }, + "ClusterConfig": { + "additionalProperties": false, + "properties": { + "ColdStorageOptions": { + "$ref": "#/definitions/ColdStorageOptions" + }, + "DedicatedMasterCount": { + "type": "integer" + }, + "DedicatedMasterEnabled": { + "type": "boolean" + }, + "DedicatedMasterType": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceType": { + "type": "string" + }, + "MultiAZWithStandbyEnabled": { + "type": "boolean" + }, + "WarmCount": { + "type": "integer" + }, + "WarmEnabled": { + "type": "boolean" + }, + "WarmType": { + "type": "string" + }, + "ZoneAwarenessConfig": { + "$ref": "#/definitions/ZoneAwarenessConfig" + }, + "ZoneAwarenessEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "CognitoOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "IdentityPoolId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + }, + "UserPoolId": { + "type": "string" + } + }, + "type": "object" + }, + "ColdStorageOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "DomainEndpointOptions": { + "additionalProperties": false, + "properties": { + "CustomEndpoint": { + "type": "string" + }, + "CustomEndpointCertificateArn": { + "type": "string" + }, + "CustomEndpointEnabled": { + "type": "boolean" + }, + "EnforceHTTPS": { + "type": "boolean" + }, + "TLSSecurityPolicy": { + "type": "string" + } + }, + "type": "object" + }, + "EBSOptions": { + "additionalProperties": false, + "properties": { + "EBSEnabled": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "Throughput": { + "type": "integer" + }, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "type": "object" + }, + "EncryptionAtRestOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "KmsKeyId": { + "type": "string" + } + }, + "type": "object" + }, + "Idp": { + "additionalProperties": false, + "properties": { + "EntityId": { + "type": "string" + }, + "MetadataContent": { + "maxLength": 1048576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MetadataContent", + "EntityId" + ], + "type": "object" + }, + "JWTOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "PublicKey": { + "type": "string" + }, + "RolesKey": { + "type": "string" + }, + "SubjectKey": { + "type": "string" + } + }, + "type": "object" + }, + "LogPublishingOption": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsLogGroupArn": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "MasterUserOptions": { + "additionalProperties": false, + "properties": { + "MasterUserARN": { + "type": "string" + }, + "MasterUserName": { + "type": "string" + }, + "MasterUserPassword": { + "type": "string" + } + }, + "type": "object" + }, + "NodeToNodeEncryptionOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "OffPeakWindow": { + "additionalProperties": false, + "properties": { + "WindowStartTime": { + "$ref": "#/definitions/WindowStartTime" + } + }, + "type": "object" + }, + "OffPeakWindowOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "OffPeakWindow": { + "$ref": "#/definitions/OffPeakWindow" + } + }, + "type": "object" + }, + "SAMLOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "Idp": { + "$ref": "#/definitions/Idp" + }, + "MasterBackendRole": { + "type": "string" + }, + "MasterUserName": { + "type": "string" + }, + "RolesKey": { + "type": "string" + }, + "SessionTimeoutMinutes": { + "type": "integer" + }, + "SubjectKey": { + "type": "string" + } + }, + "type": "object" + }, + "ServiceSoftwareOptions": { + "additionalProperties": false, + "properties": { + "AutomatedUpdateDate": { + "type": "string" + }, + "Cancellable": { + "type": "boolean" + }, + "CurrentVersion": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "NewVersion": { + "type": "string" + }, + "OptionalDeployment": { + "type": "boolean" + }, + "UpdateAvailable": { + "type": "boolean" + }, + "UpdateStatus": { + "type": "string" + } + }, + "type": "object" + }, + "SnapshotOptions": { + "additionalProperties": false, + "properties": { + "AutomatedSnapshotStartHour": { + "type": "integer" + } + }, + "type": "object" + }, + "SoftwareUpdateOptions": { + "additionalProperties": false, + "properties": { + "AutoSoftwareUpdateEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The value of the tag.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Value": { + "description": "The key of the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VPCOptions": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "WindowStartTime": { + "additionalProperties": false, + "properties": { + "Hours": { + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "Minutes": { + "maximum": 59, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Hours", + "Minutes" + ], + "type": "object" + }, + "ZoneAwarenessConfig": { + "additionalProperties": false, + "properties": { + "AvailabilityZoneCount": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "es:CreateDomain", + "es:DescribeDomain", + "es:AddTags", + "es:ListTags" + ] + }, + "delete": { + "permissions": [ + "es:DeleteDomain", + "es:DescribeDomain" + ] + }, + "read": { + "permissions": [ + "es:DescribeDomain", + "es:ListTags" + ] + }, + "update": { + "permissions": [ + "es:UpdateDomain", + "es:UpgradeDomain", + "es:DescribeDomain", + "es:AddTags", + "es:RemoveTags", + "es:ListTags", + "es:DescribeDomainChangeProgress" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DomainName" + ], + "properties": { + "AccessPolicies": { + "type": "object" + }, + "AdvancedOptions": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "AdvancedSecurityOptions": { + "$ref": "#/definitions/AdvancedSecurityOptionsInput" + }, + "Arn": { + "type": "string" + }, + "ClusterConfig": { + "$ref": "#/definitions/ClusterConfig" + }, + "CognitoOptions": { + "$ref": "#/definitions/CognitoOptions" + }, + "DomainArn": { + "type": "string" + }, + "DomainEndpoint": { + "type": "string" + }, + "DomainEndpointOptions": { + "$ref": "#/definitions/DomainEndpointOptions" + }, + "DomainEndpointV2": { + "type": "string" + }, + "DomainEndpoints": { + "additionalProperties": false, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + }, + "DomainName": { + "type": "string" + }, + "EBSOptions": { + "$ref": "#/definitions/EBSOptions" + }, + "EncryptionAtRestOptions": { + "$ref": "#/definitions/EncryptionAtRestOptions" + }, + "EngineVersion": { + "type": "string" + }, + "IPAddressType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LogPublishingOptions": { + "additionalProperties": false, + "patternProperties": { + "[a-zA-Z0-9]+": { + "$ref": "#/definitions/LogPublishingOption" + } + }, + "type": "object" + }, + "NodeToNodeEncryptionOptions": { + "$ref": "#/definitions/NodeToNodeEncryptionOptions" + }, + "OffPeakWindowOptions": { + "$ref": "#/definitions/OffPeakWindowOptions" + }, + "ServiceSoftwareOptions": { + "$ref": "#/definitions/ServiceSoftwareOptions" + }, + "SkipShardMigrationWait": { + "type": "boolean" + }, + "SnapshotOptions": { + "$ref": "#/definitions/SnapshotOptions" + }, + "SoftwareUpdateOptions": { + "$ref": "#/definitions/SoftwareUpdateOptions" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this Domain.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VPCOptions": { + "$ref": "#/definitions/VPCOptions" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/DomainArn", + "/properties/DomainEndpoint", + "/properties/DomainEndpointV2", + "/properties/DomainEndpoints", + "/properties/ServiceSoftwareOptions", + "/properties/AdvancedSecurityOptions/AnonymousAuthDisableDate" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::OpenSearchService::Domain", + "writeOnlyProperties": [ + "/properties/AdvancedSecurityOptions/MasterUserOptions", + "/properties/AdvancedSecurityOptions/SAMLOptions/MasterUserName", + "/properties/AdvancedSecurityOptions/SAMLOptions/MasterBackendRole", + "/properties/AdvancedSecurityOptions/JWTOptions/PublicKey" + ] +} diff --git a/schema/aws-opsworks-app.json b/schema/aws-opsworks-app.json index a5c0a00..55f6553 100644 --- a/schema/aws-opsworks-app.json +++ b/schema/aws-opsworks-app.json @@ -1,153 +1,153 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Shortname", - "/properties/StackId" - ], - "definitions": { - "DataSource": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Secure": { - "type": "boolean" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "Source": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Revision": { - "type": "string" - }, - "SshKey": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "SslConfiguration": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "Chain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::OpsWorks::App", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AppSource": { - "$ref": "#/definitions/Source" - }, - "Attributes": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "DataSources": { - "items": { - "$ref": "#/definitions/DataSource" - }, - "type": "array", - "uniqueItems": true - }, - "Description": { - "type": "string" - }, - "Domains": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "EnableSsl": { - "type": "boolean" - }, - "Environment": { - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Shortname": { - "type": "string" - }, - "SslConfiguration": { - "$ref": "#/definitions/SslConfiguration" - }, - "StackId": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Type", - "Name", - "StackId" - ], - "typeName": "AWS::OpsWorks::App" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Shortname", + "/properties/StackId" + ], + "definitions": { + "DataSource": { + "additionalProperties": false, + "properties": { + "Arn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "EnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Secure": { + "type": "boolean" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "Source": { + "additionalProperties": false, + "properties": { + "Password": { + "type": "string" + }, + "Revision": { + "type": "string" + }, + "SshKey": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Url": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "SslConfiguration": { + "additionalProperties": false, + "properties": { + "Certificate": { + "type": "string" + }, + "Chain": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::OpsWorks::App", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AppSource": { + "$ref": "#/definitions/Source" + }, + "Attributes": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "DataSources": { + "items": { + "$ref": "#/definitions/DataSource" + }, + "type": "array", + "uniqueItems": true + }, + "Description": { + "type": "string" + }, + "Domains": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "EnableSsl": { + "type": "boolean" + }, + "Environment": { + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Shortname": { + "type": "string" + }, + "SslConfiguration": { + "$ref": "#/definitions/SslConfiguration" + }, + "StackId": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Type", + "Name", + "StackId" + ], + "typeName": "AWS::OpsWorks::App" +} diff --git a/schema/aws-opsworks-elasticloadbalancerattachment.json b/schema/aws-opsworks-elasticloadbalancerattachment.json index df47741..be03e75 100644 --- a/schema/aws-opsworks-elasticloadbalancerattachment.json +++ b/schema/aws-opsworks-elasticloadbalancerattachment.json @@ -1,26 +1,26 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::OpsWorks::ElasticLoadBalancerAttachment", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ElasticLoadBalancerName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LayerId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "LayerId", - "ElasticLoadBalancerName" - ], - "typeName": "AWS::OpsWorks::ElasticLoadBalancerAttachment" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::OpsWorks::ElasticLoadBalancerAttachment", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ElasticLoadBalancerName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LayerId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "LayerId", + "ElasticLoadBalancerName" + ], + "typeName": "AWS::OpsWorks::ElasticLoadBalancerAttachment" +} diff --git a/schema/aws-opsworks-instance.json b/schema/aws-opsworks-instance.json index e6ae726..f276984 100644 --- a/schema/aws-opsworks-instance.json +++ b/schema/aws-opsworks-instance.json @@ -1,231 +1,231 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tenancy", - "/properties/BlockDeviceMappings", - "/properties/VirtualizationType", - "/properties/TimeBasedAutoScaling", - "/properties/RootDeviceType", - "/properties/AutoScalingType", - "/properties/StackId", - "/properties/AvailabilityZone", - "/properties/SubnetId", - "/properties/EbsOptimized" - ], - "definitions": { - "BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/EbsBlockDevice" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "type": "object" - }, - "EbsBlockDevice": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Iops": { - "type": "integer" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "TimeBasedAutoScaling": { - "additionalProperties": false, - "properties": { - "Friday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Monday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Saturday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Sunday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Thursday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Tuesday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "Wednesday": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::OpsWorks::Instance", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AgentVersion": { - "type": "string" - }, - "AmiId": { - "type": "string" - }, - "Architecture": { - "type": "string" - }, - "AutoScalingType": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/BlockDeviceMapping" - }, - "type": "array", - "uniqueItems": true - }, - "EbsOptimized": { - "type": "boolean" - }, - "ElasticIps": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Hostname": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InstallUpdatesOnBoot": { - "type": "boolean" - }, - "InstanceType": { - "type": "string" - }, - "LayerIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Os": { - "type": "string" - }, - "PrivateDnsName": { - "type": "string" - }, - "PrivateIp": { - "type": "string" - }, - "PublicDnsName": { - "type": "string" - }, - "PublicIp": { - "type": "string" - }, - "RootDeviceType": { - "type": "string" - }, - "SshKeyName": { - "type": "string" - }, - "StackId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "Tenancy": { - "type": "string" - }, - "TimeBasedAutoScaling": { - "$ref": "#/definitions/TimeBasedAutoScaling" - }, - "VirtualizationType": { - "type": "string" - }, - "Volumes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/PublicDnsName", - "/properties/PrivateDnsName", - "/properties/PublicIp", - "/properties/PrivateIp", - "/properties/Id" - ], - "required": [ - "LayerIds", - "InstanceType", - "StackId" - ], - "typeName": "AWS::OpsWorks::Instance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tenancy", + "/properties/BlockDeviceMappings", + "/properties/VirtualizationType", + "/properties/TimeBasedAutoScaling", + "/properties/RootDeviceType", + "/properties/AutoScalingType", + "/properties/StackId", + "/properties/AvailabilityZone", + "/properties/SubnetId", + "/properties/EbsOptimized" + ], + "definitions": { + "BlockDeviceMapping": { + "additionalProperties": false, + "properties": { + "DeviceName": { + "type": "string" + }, + "Ebs": { + "$ref": "#/definitions/EbsBlockDevice" + }, + "NoDevice": { + "type": "string" + }, + "VirtualName": { + "type": "string" + } + }, + "type": "object" + }, + "EbsBlockDevice": { + "additionalProperties": false, + "properties": { + "DeleteOnTermination": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "type": "object" + }, + "TimeBasedAutoScaling": { + "additionalProperties": false, + "properties": { + "Friday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Monday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Saturday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Sunday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Thursday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Tuesday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Wednesday": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::OpsWorks::Instance", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AgentVersion": { + "type": "string" + }, + "AmiId": { + "type": "string" + }, + "Architecture": { + "type": "string" + }, + "AutoScalingType": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + }, + "BlockDeviceMappings": { + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "type": "array", + "uniqueItems": true + }, + "EbsOptimized": { + "type": "boolean" + }, + "ElasticIps": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Hostname": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "InstanceType": { + "type": "string" + }, + "LayerIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Os": { + "type": "string" + }, + "PrivateDnsName": { + "type": "string" + }, + "PrivateIp": { + "type": "string" + }, + "PublicDnsName": { + "type": "string" + }, + "PublicIp": { + "type": "string" + }, + "RootDeviceType": { + "type": "string" + }, + "SshKeyName": { + "type": "string" + }, + "StackId": { + "type": "string" + }, + "SubnetId": { + "type": "string" + }, + "Tenancy": { + "type": "string" + }, + "TimeBasedAutoScaling": { + "$ref": "#/definitions/TimeBasedAutoScaling" + }, + "VirtualizationType": { + "type": "string" + }, + "Volumes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/PublicDnsName", + "/properties/PrivateDnsName", + "/properties/PublicIp", + "/properties/PrivateIp", + "/properties/Id" + ], + "required": [ + "LayerIds", + "InstanceType", + "StackId" + ], + "typeName": "AWS::OpsWorks::Instance" +} diff --git a/schema/aws-opsworks-layer.json b/schema/aws-opsworks-layer.json index 80f81c4..0bf3560 100644 --- a/schema/aws-opsworks-layer.json +++ b/schema/aws-opsworks-layer.json @@ -1,253 +1,253 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type", - "/properties/StackId" - ], - "definitions": { - "AutoScalingThresholds": { - "additionalProperties": false, - "properties": { - "CpuThreshold": { - "type": "number" - }, - "IgnoreMetricsTime": { - "type": "integer" - }, - "InstanceCount": { - "type": "integer" - }, - "LoadThreshold": { - "type": "number" - }, - "MemoryThreshold": { - "type": "number" - }, - "ThresholdsWaitTime": { - "type": "integer" - } - }, - "type": "object" - }, - "LifecycleEventConfiguration": { - "additionalProperties": false, - "properties": { - "ShutdownEventConfiguration": { - "$ref": "#/definitions/ShutdownEventConfiguration" - } - }, - "type": "object" - }, - "LoadBasedAutoScaling": { - "additionalProperties": false, - "properties": { - "DownScaling": { - "$ref": "#/definitions/AutoScalingThresholds" - }, - "Enable": { - "type": "boolean" - }, - "UpScaling": { - "$ref": "#/definitions/AutoScalingThresholds" - } - }, - "type": "object" - }, - "Recipes": { - "additionalProperties": false, - "properties": { - "Configure": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Deploy": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Setup": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Shutdown": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Undeploy": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ShutdownEventConfiguration": { - "additionalProperties": false, - "properties": { - "DelayUntilElbConnectionsDrained": { - "type": "boolean" - }, - "ExecutionTimeout": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VolumeConfiguration": { - "additionalProperties": false, - "properties": { - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "integer" - }, - "MountPoint": { - "type": "string" - }, - "NumberOfDisks": { - "type": "integer" - }, - "RaidLevel": { - "type": "integer" - }, - "Size": { - "type": "integer" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::OpsWorks::Layer", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Attributes": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "AutoAssignElasticIps": { - "type": "boolean" - }, - "AutoAssignPublicIps": { - "type": "boolean" - }, - "CustomInstanceProfileArn": { - "type": "string" - }, - "CustomJson": { - "type": "object" - }, - "CustomRecipes": { - "$ref": "#/definitions/Recipes" - }, - "CustomSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "EnableAutoHealing": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "InstallUpdatesOnBoot": { - "type": "boolean" - }, - "LifecycleEventConfiguration": { - "$ref": "#/definitions/LifecycleEventConfiguration" - }, - "LoadBasedAutoScaling": { - "$ref": "#/definitions/LoadBasedAutoScaling" - }, - "Name": { - "type": "string" - }, - "Packages": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Shortname": { - "type": "string" - }, - "StackId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "type": "string" - }, - "UseEbsOptimizedInstances": { - "type": "boolean" - }, - "VolumeConfigurations": { - "items": { - "$ref": "#/definitions/VolumeConfiguration" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "EnableAutoHealing", - "Name", - "Type", - "AutoAssignElasticIps", - "Shortname", - "AutoAssignPublicIps", - "StackId" - ], - "typeName": "AWS::OpsWorks::Layer" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/StackId" + ], + "definitions": { + "AutoScalingThresholds": { + "additionalProperties": false, + "properties": { + "CpuThreshold": { + "type": "number" + }, + "IgnoreMetricsTime": { + "type": "integer" + }, + "InstanceCount": { + "type": "integer" + }, + "LoadThreshold": { + "type": "number" + }, + "MemoryThreshold": { + "type": "number" + }, + "ThresholdsWaitTime": { + "type": "integer" + } + }, + "type": "object" + }, + "LifecycleEventConfiguration": { + "additionalProperties": false, + "properties": { + "ShutdownEventConfiguration": { + "$ref": "#/definitions/ShutdownEventConfiguration" + } + }, + "type": "object" + }, + "LoadBasedAutoScaling": { + "additionalProperties": false, + "properties": { + "DownScaling": { + "$ref": "#/definitions/AutoScalingThresholds" + }, + "Enable": { + "type": "boolean" + }, + "UpScaling": { + "$ref": "#/definitions/AutoScalingThresholds" + } + }, + "type": "object" + }, + "Recipes": { + "additionalProperties": false, + "properties": { + "Configure": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Deploy": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Setup": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Shutdown": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Undeploy": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ShutdownEventConfiguration": { + "additionalProperties": false, + "properties": { + "DelayUntilElbConnectionsDrained": { + "type": "boolean" + }, + "ExecutionTimeout": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VolumeConfiguration": { + "additionalProperties": false, + "properties": { + "Encrypted": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "MountPoint": { + "type": "string" + }, + "NumberOfDisks": { + "type": "integer" + }, + "RaidLevel": { + "type": "integer" + }, + "Size": { + "type": "integer" + }, + "VolumeType": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::OpsWorks::Layer", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Attributes": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "CustomInstanceProfileArn": { + "type": "string" + }, + "CustomJson": { + "type": "object" + }, + "CustomRecipes": { + "$ref": "#/definitions/Recipes" + }, + "CustomSecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "LifecycleEventConfiguration": { + "$ref": "#/definitions/LifecycleEventConfiguration" + }, + "LoadBasedAutoScaling": { + "$ref": "#/definitions/LoadBasedAutoScaling" + }, + "Name": { + "type": "string" + }, + "Packages": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Shortname": { + "type": "string" + }, + "StackId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "type": "string" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + }, + "VolumeConfigurations": { + "items": { + "$ref": "#/definitions/VolumeConfiguration" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "EnableAutoHealing", + "Name", + "Type", + "AutoAssignElasticIps", + "Shortname", + "AutoAssignPublicIps", + "StackId" + ], + "typeName": "AWS::OpsWorks::Layer" +} diff --git a/schema/aws-opsworks-stack.json b/schema/aws-opsworks-stack.json index 8110087..41da6e5 100644 --- a/schema/aws-opsworks-stack.json +++ b/schema/aws-opsworks-stack.json @@ -1,225 +1,225 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceRoleArn", - "/properties/CloneAppIds", - "/properties/ClonePermissions", - "/properties/VpcId", - "/properties/SourceStackId" - ], - "definitions": { - "ChefConfiguration": { - "additionalProperties": false, - "properties": { - "BerkshelfVersion": { - "type": "string" - }, - "ManageBerkshelf": { - "type": "boolean" - } - }, - "type": "object" - }, - "ElasticIp": { - "additionalProperties": false, - "properties": { - "Ip": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Ip" - ], - "type": "object" - }, - "RdsDbInstance": { - "additionalProperties": false, - "properties": { - "DbPassword": { - "type": "string" - }, - "DbUser": { - "type": "string" - }, - "RdsDbInstanceArn": { - "type": "string" - } - }, - "required": [ - "DbPassword", - "DbUser", - "RdsDbInstanceArn" - ], - "type": "object" - }, - "Source": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Revision": { - "type": "string" - }, - "SshKey": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "StackConfigurationManager": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::OpsWorks::Stack", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AgentVersion": { - "type": "string" - }, - "Attributes": { - "patternProperties": { - "[a-zA-Z0-9]+": { - "type": "string" - } - }, - "type": "object" - }, - "ChefConfiguration": { - "$ref": "#/definitions/ChefConfiguration" - }, - "CloneAppIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ClonePermissions": { - "type": "boolean" - }, - "ConfigurationManager": { - "$ref": "#/definitions/StackConfigurationManager" - }, - "CustomCookbooksSource": { - "$ref": "#/definitions/Source" - }, - "CustomJson": { - "type": "object" - }, - "DefaultAvailabilityZone": { - "type": "string" - }, - "DefaultInstanceProfileArn": { - "type": "string" - }, - "DefaultOs": { - "type": "string" - }, - "DefaultRootDeviceType": { - "type": "string" - }, - "DefaultSshKeyName": { - "type": "string" - }, - "DefaultSubnetId": { - "type": "string" - }, - "EcsClusterArn": { - "type": "string" - }, - "ElasticIps": { - "items": { - "$ref": "#/definitions/ElasticIp" - }, - "type": "array", - "uniqueItems": true - }, - "HostnameTheme": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RdsDbInstances": { - "items": { - "$ref": "#/definitions/RdsDbInstance" - }, - "type": "array", - "uniqueItems": true - }, - "ServiceRoleArn": { - "type": "string" - }, - "SourceStackId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UseCustomCookbooks": { - "type": "boolean" - }, - "UseOpsworksSecurityGroups": { - "type": "boolean" - }, - "VpcId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DefaultInstanceProfileArn", - "ServiceRoleArn", - "Name" - ], - "typeName": "AWS::OpsWorks::Stack" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceRoleArn", + "/properties/CloneAppIds", + "/properties/ClonePermissions", + "/properties/VpcId", + "/properties/SourceStackId" + ], + "definitions": { + "ChefConfiguration": { + "additionalProperties": false, + "properties": { + "BerkshelfVersion": { + "type": "string" + }, + "ManageBerkshelf": { + "type": "boolean" + } + }, + "type": "object" + }, + "ElasticIp": { + "additionalProperties": false, + "properties": { + "Ip": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "Ip" + ], + "type": "object" + }, + "RdsDbInstance": { + "additionalProperties": false, + "properties": { + "DbPassword": { + "type": "string" + }, + "DbUser": { + "type": "string" + }, + "RdsDbInstanceArn": { + "type": "string" + } + }, + "required": [ + "DbPassword", + "DbUser", + "RdsDbInstanceArn" + ], + "type": "object" + }, + "Source": { + "additionalProperties": false, + "properties": { + "Password": { + "type": "string" + }, + "Revision": { + "type": "string" + }, + "SshKey": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Url": { + "type": "string" + }, + "Username": { + "type": "string" + } + }, + "type": "object" + }, + "StackConfigurationManager": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::OpsWorks::Stack", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AgentVersion": { + "type": "string" + }, + "Attributes": { + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ChefConfiguration": { + "$ref": "#/definitions/ChefConfiguration" + }, + "CloneAppIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ClonePermissions": { + "type": "boolean" + }, + "ConfigurationManager": { + "$ref": "#/definitions/StackConfigurationManager" + }, + "CustomCookbooksSource": { + "$ref": "#/definitions/Source" + }, + "CustomJson": { + "type": "object" + }, + "DefaultAvailabilityZone": { + "type": "string" + }, + "DefaultInstanceProfileArn": { + "type": "string" + }, + "DefaultOs": { + "type": "string" + }, + "DefaultRootDeviceType": { + "type": "string" + }, + "DefaultSshKeyName": { + "type": "string" + }, + "DefaultSubnetId": { + "type": "string" + }, + "EcsClusterArn": { + "type": "string" + }, + "ElasticIps": { + "items": { + "$ref": "#/definitions/ElasticIp" + }, + "type": "array", + "uniqueItems": true + }, + "HostnameTheme": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RdsDbInstances": { + "items": { + "$ref": "#/definitions/RdsDbInstance" + }, + "type": "array", + "uniqueItems": true + }, + "ServiceRoleArn": { + "type": "string" + }, + "SourceStackId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DefaultInstanceProfileArn", + "ServiceRoleArn", + "Name" + ], + "typeName": "AWS::OpsWorks::Stack" +} diff --git a/schema/aws-opsworks-userprofile.json b/schema/aws-opsworks-userprofile.json index 375b569..f2ff087 100644 --- a/schema/aws-opsworks-userprofile.json +++ b/schema/aws-opsworks-userprofile.json @@ -1,34 +1,34 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IamUserArn" - ], - "description": "Resource Type definition for AWS::OpsWorks::UserProfile", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllowSelfManagement": { - "type": "boolean" - }, - "IamUserArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SshPublicKey": { - "type": "string" - }, - "SshUsername": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "IamUserArn" - ], - "typeName": "AWS::OpsWorks::UserProfile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IamUserArn" + ], + "description": "Resource Type definition for AWS::OpsWorks::UserProfile", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowSelfManagement": { + "type": "boolean" + }, + "IamUserArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "SshPublicKey": { + "type": "string" + }, + "SshUsername": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IamUserArn" + ], + "typeName": "AWS::OpsWorks::UserProfile" +} diff --git a/schema/aws-opsworks-volume.json b/schema/aws-opsworks-volume.json index 1417fd3..d575f1b 100644 --- a/schema/aws-opsworks-volume.json +++ b/schema/aws-opsworks-volume.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StackId", - "/properties/Ec2VolumeId" - ], - "description": "Resource Type definition for AWS::OpsWorks::Volume", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Ec2VolumeId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MountPoint": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "StackId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Ec2VolumeId", - "StackId" - ], - "typeName": "AWS::OpsWorks::Volume" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StackId", + "/properties/Ec2VolumeId" + ], + "description": "Resource Type definition for AWS::OpsWorks::Volume", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Ec2VolumeId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MountPoint": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "StackId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Ec2VolumeId", + "StackId" + ], + "typeName": "AWS::OpsWorks::Volume" +} diff --git a/schema/aws-opsworkscm-server.json b/schema/aws-opsworkscm-server.json index 346cc32..1a9d4ae 100644 --- a/schema/aws-opsworkscm-server.json +++ b/schema/aws-opsworkscm-server.json @@ -1,236 +1,236 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KeyPair", - "/properties/CustomPrivateKey", - "/properties/ServiceRoleArn", - "/properties/InstanceType", - "/properties/CustomCertificate", - "/properties/CustomDomain", - "/properties/InstanceProfileArn", - "/properties/SecurityGroupIds", - "/properties/ServerName", - "/properties/SubnetIds", - "/properties/BackupId", - "/properties/EngineModel", - "/properties/AssociatePublicIpAddress", - "/properties/EngineVersion", - "/properties/Engine" - ], - "definitions": { - "EngineAttribute": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 10000, - "pattern": "(?s).*", - "type": "string" - }, - "Value": { - "maxLength": 10000, - "pattern": "(?s).*", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::OpsWorksCM::Server", - "handlers": { - "create": { - "permissions": [ - "opsworks-cm:CreateServer", - "opsworks-cm:DescribeServers", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "opsworks-cm:DeleteServer", - "opsworks-cm:DescribeServers" - ] - }, - "list": { - "permissions": [ - "opsworks-cm:DescribeServers", - "opsworks-cm:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "opsworks-cm:DescribeServers" - ] - }, - "update": { - "permissions": [ - "opsworks-cm:UpdateServer", - "opsworks-cm:TagResource", - "opsworks-cm:UntagResource", - "opsworks-cm:DescribeServers" - ] - } - }, - "primaryIdentifier": [ - "/properties/ServerName" - ], - "properties": { - "Arn": { - "maxLength": 10000, - "type": "string" - }, - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "BackupId": { - "maxLength": 79, - "pattern": "[a-zA-Z][a-zA-Z0-9\\-\\.\\:]*", - "type": "string" - }, - "BackupRetentionCount": { - "minLength": 1, - "type": "integer" - }, - "CustomCertificate": { - "maxLength": 2097152, - "pattern": "(?s)\\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\\s*", - "type": "string" - }, - "CustomDomain": { - "maxLength": 253, - "pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$", - "type": "string" - }, - "CustomPrivateKey": { - "maxLength": 4096, - "pattern": "(?ms)\\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\\s*", - "type": "string" - }, - "DisableAutomatedBackup": { - "type": "boolean" - }, - "Endpoint": { - "maxLength": 10000, - "type": "string" - }, - "Engine": { - "maxLength": 10000, - "type": "string" - }, - "EngineAttributes": { - "items": { - "$ref": "#/definitions/EngineAttribute" - }, - "type": "array", - "uniqueItems": false - }, - "EngineModel": { - "maxLength": 10000, - "type": "string" - }, - "EngineVersion": { - "maxLength": 10000, - "type": "string" - }, - "InstanceProfileArn": { - "maxLength": 10000, - "pattern": "arn:aws:iam::[0-9]{12}:instance-profile/.*", - "type": "string" - }, - "InstanceType": { - "maxLength": 10000, - "type": "string" - }, - "KeyPair": { - "maxLength": 10000, - "pattern": ".*", - "type": "string" - }, - "PreferredBackupWindow": { - "maxLength": 10000, - "pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "maxLength": 10000, - "pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "maxLength": 10000, - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ServerName": { - "maxLength": 40, - "minLength": 1, - "pattern": "[a-zA-Z][a-zA-Z0-9\\-]*", - "type": "string" - }, - "ServiceRoleArn": { - "maxLength": 10000, - "pattern": "arn:aws:iam::[0-9]{12}:role/.*", - "type": "string" - }, - "SubnetIds": { - "items": { - "maxLength": 10000, - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ServerName", - "/properties/Endpoint", - "/properties/Arn" - ], - "required": [ - "ServiceRoleArn", - "InstanceProfileArn", - "InstanceType" - ], - "typeName": "AWS::OpsWorksCM::Server", - "writeOnlyProperties": [ - "/properties/BackupId", - "/properties/CustomCertificate", - "/properties/CustomDomain", - "/properties/CustomPrivateKey", - "/properties/EngineAttributes", - "/properties/EngineVersion", - "/properties/KeyPair", - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KeyPair", + "/properties/CustomPrivateKey", + "/properties/ServiceRoleArn", + "/properties/InstanceType", + "/properties/CustomCertificate", + "/properties/CustomDomain", + "/properties/InstanceProfileArn", + "/properties/SecurityGroupIds", + "/properties/ServerName", + "/properties/SubnetIds", + "/properties/BackupId", + "/properties/EngineModel", + "/properties/AssociatePublicIpAddress", + "/properties/EngineVersion", + "/properties/Engine" + ], + "definitions": { + "EngineAttribute": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 10000, + "pattern": "(?s).*", + "type": "string" + }, + "Value": { + "maxLength": 10000, + "pattern": "(?s).*", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::OpsWorksCM::Server", + "handlers": { + "create": { + "permissions": [ + "opsworks-cm:CreateServer", + "opsworks-cm:DescribeServers", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "opsworks-cm:DeleteServer", + "opsworks-cm:DescribeServers" + ] + }, + "list": { + "permissions": [ + "opsworks-cm:DescribeServers", + "opsworks-cm:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "opsworks-cm:DescribeServers" + ] + }, + "update": { + "permissions": [ + "opsworks-cm:UpdateServer", + "opsworks-cm:TagResource", + "opsworks-cm:UntagResource", + "opsworks-cm:DescribeServers" + ] + } + }, + "primaryIdentifier": [ + "/properties/ServerName" + ], + "properties": { + "Arn": { + "maxLength": 10000, + "type": "string" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "BackupId": { + "maxLength": 79, + "pattern": "[a-zA-Z][a-zA-Z0-9\\-\\.\\:]*", + "type": "string" + }, + "BackupRetentionCount": { + "minLength": 1, + "type": "integer" + }, + "CustomCertificate": { + "maxLength": 2097152, + "pattern": "(?s)\\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\\s*", + "type": "string" + }, + "CustomDomain": { + "maxLength": 253, + "pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$", + "type": "string" + }, + "CustomPrivateKey": { + "maxLength": 4096, + "pattern": "(?ms)\\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\\s*", + "type": "string" + }, + "DisableAutomatedBackup": { + "type": "boolean" + }, + "Endpoint": { + "maxLength": 10000, + "type": "string" + }, + "Engine": { + "maxLength": 10000, + "type": "string" + }, + "EngineAttributes": { + "items": { + "$ref": "#/definitions/EngineAttribute" + }, + "type": "array", + "uniqueItems": false + }, + "EngineModel": { + "maxLength": 10000, + "type": "string" + }, + "EngineVersion": { + "maxLength": 10000, + "type": "string" + }, + "InstanceProfileArn": { + "maxLength": 10000, + "pattern": "arn:aws:iam::[0-9]{12}:instance-profile/.*", + "type": "string" + }, + "InstanceType": { + "maxLength": 10000, + "type": "string" + }, + "KeyPair": { + "maxLength": 10000, + "pattern": ".*", + "type": "string" + }, + "PreferredBackupWindow": { + "maxLength": 10000, + "pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "maxLength": 10000, + "pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "maxLength": 10000, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ServerName": { + "maxLength": 40, + "minLength": 1, + "pattern": "[a-zA-Z][a-zA-Z0-9\\-]*", + "type": "string" + }, + "ServiceRoleArn": { + "maxLength": 10000, + "pattern": "arn:aws:iam::[0-9]{12}:role/.*", + "type": "string" + }, + "SubnetIds": { + "items": { + "maxLength": 10000, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ServerName", + "/properties/Endpoint", + "/properties/Arn" + ], + "required": [ + "ServiceRoleArn", + "InstanceProfileArn", + "InstanceType" + ], + "typeName": "AWS::OpsWorksCM::Server", + "writeOnlyProperties": [ + "/properties/BackupId", + "/properties/CustomCertificate", + "/properties/CustomDomain", + "/properties/CustomPrivateKey", + "/properties/EngineAttributes", + "/properties/EngineVersion", + "/properties/KeyPair", + "/properties/Tags" + ] +} diff --git a/schema/aws-organizations-account.json b/schema/aws-organizations-account.json index e079ed8..ef1a864 100644 --- a/schema/aws-organizations-account.json +++ b/schema/aws-organizations-account.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A custom key-value pair associated with a resource within your organization.", - "properties": { - "Key": { - "description": "The key identifier, or name, of the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "Value": { - "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", - "maxLength": 256, - "minLength": 0, - "pattern": "[\\s\\S]*", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "You can use AWS::Organizations::Account to manage accounts in organization.", - "handlers": { - "create": { - "permissions": [ - "organizations:CreateAccount", - "organizations:DescribeCreateAccountStatus", - "organizations:MoveAccount", - "organizations:ListParents", - "organizations:TagResource", - "organizations:DescribeAccount", - "organizations:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "organizations:CloseAccount" - ] - }, - "list": { - "permissions": [ - "organizations:ListAccounts" - ] - }, - "read": { - "permissions": [ - "organizations:DescribeAccount", - "organizations:ListParents", - "organizations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "organizations:MoveAccount", - "organizations:TagResource", - "organizations:UntagResource", - "organizations:ListRoots", - "organizations:DescribeAccount", - "organizations:ListParents", - "organizations:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "description": "If the account was created successfully, the unique identifier (ID) of the new account.", - "maxLength": 12, - "pattern": "^\\d{12}$", - "type": "string" - }, - "AccountName": { - "description": "The friendly name of the member account.", - "maxLength": 50, - "minLength": 1, - "pattern": "[\\u0020-\\u007E]+", - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the account.", - "pattern": "^arn:aws.*:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}", - "type": "string" - }, - "Email": { - "description": "The email address of the owner to assign to the new member account.", - "maxLength": 64, - "minLength": 6, - "pattern": "[^\\s@]+@[^\\s@]+\\.[^\\s@]+", - "type": "string" - }, - "JoinedMethod": { - "description": "The method by which the account joined the organization.", - "enum": [ - "INVITED", - "CREATED" - ], - "type": "string" - }, - "JoinedTimestamp": { - "description": "The date the account became a part of the organization.", - "type": "string" - }, - "ParentIds": { - "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.", - "insertionOrder": false, - "items": { - "pattern": "^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "RoleName": { - "default": "OrganizationAccountAccessRole", - "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.", - "maxLength": 64, - "minLength": 1, - "pattern": "[\\w+=,.@-]{1,64}", - "type": "string" - }, - "Status": { - "description": "The status of the account in the organization.", - "enum": [ - "ACTIVE", - "SUSPENDED", - "PENDING_CLOSURE" - ], - "type": "string" - }, - "Tags": { - "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AccountId", - "/properties/Status", - "/properties/JoinedTimestamp", - "/properties/JoinedMethod", - "/properties/Arn" - ], - "required": [ - "AccountName", - "Email" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Organizations::Account", - "writeOnlyProperties": [ - "/properties/RoleName" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A custom key-value pair associated with a resource within your organization.", + "properties": { + "Key": { + "description": "The key identifier, or name, of the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "Value": { + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", + "maxLength": 256, + "minLength": 0, + "pattern": "[\\s\\S]*", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "You can use AWS::Organizations::Account to manage accounts in organization.", + "handlers": { + "create": { + "permissions": [ + "organizations:CreateAccount", + "organizations:DescribeCreateAccountStatus", + "organizations:MoveAccount", + "organizations:ListParents", + "organizations:TagResource", + "organizations:DescribeAccount", + "organizations:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "organizations:CloseAccount" + ] + }, + "list": { + "permissions": [ + "organizations:ListAccounts" + ] + }, + "read": { + "permissions": [ + "organizations:DescribeAccount", + "organizations:ListParents", + "organizations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "organizations:MoveAccount", + "organizations:TagResource", + "organizations:UntagResource", + "organizations:ListRoots", + "organizations:DescribeAccount", + "organizations:ListParents", + "organizations:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "description": "If the account was created successfully, the unique identifier (ID) of the new account.", + "maxLength": 12, + "pattern": "^\\d{12}$", + "type": "string" + }, + "AccountName": { + "description": "The friendly name of the member account.", + "maxLength": 50, + "minLength": 1, + "pattern": "[\\u0020-\\u007E]+", + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the account.", + "pattern": "^arn:aws.*:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}", + "type": "string" + }, + "Email": { + "description": "The email address of the owner to assign to the new member account.", + "maxLength": 64, + "minLength": 6, + "pattern": "[^\\s@]+@[^\\s@]+\\.[^\\s@]+", + "type": "string" + }, + "JoinedMethod": { + "description": "The method by which the account joined the organization.", + "enum": [ + "INVITED", + "CREATED" + ], + "type": "string" + }, + "JoinedTimestamp": { + "description": "The date the account became a part of the organization.", + "type": "string" + }, + "ParentIds": { + "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.", + "insertionOrder": false, + "items": { + "pattern": "^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "RoleName": { + "default": "OrganizationAccountAccessRole", + "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.", + "maxLength": 64, + "minLength": 1, + "pattern": "[\\w+=,.@-]{1,64}", + "type": "string" + }, + "Status": { + "description": "The status of the account in the organization.", + "enum": [ + "ACTIVE", + "SUSPENDED", + "PENDING_CLOSURE" + ], + "type": "string" + }, + "Tags": { + "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AccountId", + "/properties/Status", + "/properties/JoinedTimestamp", + "/properties/JoinedMethod", + "/properties/Arn" + ], + "required": [ + "AccountName", + "Email" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Organizations::Account", + "writeOnlyProperties": [ + "/properties/RoleName" + ] +} diff --git a/schema/aws-organizations-organization.json b/schema/aws-organizations-organization.json index ecdf05f..5b4da2f 100644 --- a/schema/aws-organizations-organization.json +++ b/schema/aws-organizations-organization.json @@ -1,96 +1,96 @@ -{ - "additionalProperties": false, - "description": "Resource schema for AWS::Organizations::Organization", - "handlers": { - "create": { - "permissions": [ - "organizations:CreateOrganization", - "organizations:DescribeOrganization", - "iam:CreateServiceLinkedRole", - "organizations:ListRoots" - ] - }, - "delete": { - "permissions": [ - "organizations:DeleteOrganization", - "organizations:DescribeOrganization" - ] - }, - "list": { - "permissions": [ - "organizations:DescribeOrganization" - ] - }, - "read": { - "permissions": [ - "organizations:DescribeOrganization", - "organizations:ListRoots" - ] - }, - "update": { - "permissions": [ - "organizations:DescribeOrganization" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of an organization.", - "pattern": "^arn:aws.*:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}", - "type": "string" - }, - "FeatureSet": { - "default": "ALL", - "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", - "enum": [ - "ALL", - "CONSOLIDATED_BILLING" - ], - "type": "string" - }, - "Id": { - "description": "The unique identifier (ID) of an organization.", - "pattern": "^o-[a-z0-9]{10,32}$", - "type": "string" - }, - "ManagementAccountArn": { - "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.", - "pattern": "^arn:aws.*:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}", - "type": "string" - }, - "ManagementAccountEmail": { - "description": "The email address that is associated with the AWS account that is designated as the management account for the organization.", - "maxLength": 64, - "minLength": 6, - "pattern": "[^\\s@]+@[^\\s@]+\\.[^\\s@]+", - "type": "string" - }, - "ManagementAccountId": { - "description": "The unique identifier (ID) of the management account of an organization.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "RootId": { - "description": "The unique identifier (ID) for the root.", - "maxLength": 64, - "pattern": "^r-[0-9a-z]{4,32}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/ManagementAccountArn", - "/properties/ManagementAccountId", - "/properties/ManagementAccountEmail", - "/properties/RootId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Organizations::Organization" -} +{ + "additionalProperties": false, + "description": "Resource schema for AWS::Organizations::Organization", + "handlers": { + "create": { + "permissions": [ + "organizations:CreateOrganization", + "organizations:DescribeOrganization", + "iam:CreateServiceLinkedRole", + "organizations:ListRoots" + ] + }, + "delete": { + "permissions": [ + "organizations:DeleteOrganization", + "organizations:DescribeOrganization" + ] + }, + "list": { + "permissions": [ + "organizations:DescribeOrganization" + ] + }, + "read": { + "permissions": [ + "organizations:DescribeOrganization", + "organizations:ListRoots" + ] + }, + "update": { + "permissions": [ + "organizations:DescribeOrganization" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of an organization.", + "pattern": "^arn:aws.*:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}", + "type": "string" + }, + "FeatureSet": { + "default": "ALL", + "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", + "enum": [ + "ALL", + "CONSOLIDATED_BILLING" + ], + "type": "string" + }, + "Id": { + "description": "The unique identifier (ID) of an organization.", + "pattern": "^o-[a-z0-9]{10,32}$", + "type": "string" + }, + "ManagementAccountArn": { + "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.", + "pattern": "^arn:aws.*:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}", + "type": "string" + }, + "ManagementAccountEmail": { + "description": "The email address that is associated with the AWS account that is designated as the management account for the organization.", + "maxLength": 64, + "minLength": 6, + "pattern": "[^\\s@]+@[^\\s@]+\\.[^\\s@]+", + "type": "string" + }, + "ManagementAccountId": { + "description": "The unique identifier (ID) of the management account of an organization.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "RootId": { + "description": "The unique identifier (ID) for the root.", + "maxLength": 64, + "pattern": "^r-[0-9a-z]{4,32}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/ManagementAccountArn", + "/properties/ManagementAccountId", + "/properties/ManagementAccountEmail", + "/properties/RootId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Organizations::Organization" +} diff --git a/schema/aws-organizations-organizationalunit.json b/schema/aws-organizations-organizationalunit.json index b8d9156..875f832 100644 --- a/schema/aws-organizations-organizationalunit.json +++ b/schema/aws-organizations-organizationalunit.json @@ -1,135 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ParentId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A custom key-value pair associated with a resource within your organization.", - "properties": { - "Key": { - "description": "The key identifier, or name, of the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "You can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.", - "handlers": { - "create": { - "permissions": [ - "organizations:CreateOrganizationalUnit", - "organizations:DescribeOrganizationalUnit", - "organizations:ListParents", - "organizations:ListTagsForResource", - "organizations:TagResource" - ] - }, - "delete": { - "permissions": [ - "organizations:DeleteOrganizationalUnit" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ParentId": { - "$ref": "resource-schema.json#/properties/ParentId" - } - }, - "required": [ - "ParentId" - ] - }, - "permissions": [ - "organizations:ListOrganizationalUnitsForParent" - ] - }, - "read": { - "permissions": [ - "organizations:DescribeOrganizationalUnit", - "organizations:ListParents", - "organizations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "organizations:DescribeOrganizationalUnit", - "organizations:ListParents", - "organizations:ListTagsForResource", - "organizations:TagResource", - "organizations:UntagResource", - "organizations:UpdateOrganizationalUnit" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of this OU.", - "pattern": "^arn:aws.*:organizations::\\d{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}", - "type": "string" - }, - "Id": { - "description": "The unique identifier (ID) associated with this OU.", - "maxLength": 68, - "pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$", - "type": "string" - }, - "Name": { - "description": "The friendly name of this OU.", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "ParentId": { - "description": "The unique identifier (ID) of the parent root or OU that you want to create the new OU in.", - "maxLength": 100, - "pattern": "^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", - "type": "string" - }, - "Tags": { - "description": "A list of tags that you want to attach to the newly created OU.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name", - "ParentId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Organizations::OrganizationalUnit" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ParentId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A custom key-value pair associated with a resource within your organization.", + "properties": { + "Key": { + "description": "The key identifier, or name, of the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "You can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.", + "handlers": { + "create": { + "permissions": [ + "organizations:CreateOrganizationalUnit", + "organizations:DescribeOrganizationalUnit", + "organizations:ListParents", + "organizations:ListTagsForResource", + "organizations:TagResource" + ] + }, + "delete": { + "permissions": [ + "organizations:DeleteOrganizationalUnit" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ParentId": { + "$ref": "resource-schema.json#/properties/ParentId" + } + }, + "required": [ + "ParentId" + ] + }, + "permissions": [ + "organizations:ListOrganizationalUnitsForParent" + ] + }, + "read": { + "permissions": [ + "organizations:DescribeOrganizationalUnit", + "organizations:ListParents", + "organizations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "organizations:DescribeOrganizationalUnit", + "organizations:ListParents", + "organizations:ListTagsForResource", + "organizations:TagResource", + "organizations:UntagResource", + "organizations:UpdateOrganizationalUnit" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of this OU.", + "pattern": "^arn:aws.*:organizations::\\d{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}", + "type": "string" + }, + "Id": { + "description": "The unique identifier (ID) associated with this OU.", + "maxLength": 68, + "pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$", + "type": "string" + }, + "Name": { + "description": "The friendly name of this OU.", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "ParentId": { + "description": "The unique identifier (ID) of the parent root or OU that you want to create the new OU in.", + "maxLength": 100, + "pattern": "^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", + "type": "string" + }, + "Tags": { + "description": "A list of tags that you want to attach to the newly created OU.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name", + "ParentId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Organizations::OrganizationalUnit" +} diff --git a/schema/aws-organizations-policy.json b/schema/aws-organizations-policy.json index ab8ae57..a5e433a 100644 --- a/schema/aws-organizations-policy.json +++ b/schema/aws-organizations-policy.json @@ -1,177 +1,177 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A custom key-value pair associated with a resource within your organization.", - "properties": { - "Key": { - "description": "The key identifier, or name, of the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "Value": { - "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", - "maxLength": 256, - "minLength": 0, - "pattern": "[\\s\\S]*", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.", - "handlers": { - "create": { - "permissions": [ - "organizations:CreatePolicy", - "organizations:DescribePolicy", - "organizations:AttachPolicy", - "organizations:ListTagsForResource", - "organizations:ListTargetsForPolicy", - "organizations:TagResource" - ] - }, - "delete": { - "permissions": [ - "organizations:DetachPolicy", - "organizations:DeletePolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Type": { - "$ref": "resource-schema.json#/properties/Type" - } - }, - "required": [ - "Type" - ] - }, - "permissions": [ - "organizations:ListPolicies" - ] - }, - "read": { - "permissions": [ - "organizations:DescribePolicy", - "organizations:ListTargetsForPolicy", - "organizations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "organizations:AttachPolicy", - "organizations:DetachPolicy", - "organizations:UpdatePolicy", - "organizations:ListTagsForResource", - "organizations:ListTargetsForPolicy", - "organizations:TagResource", - "organizations:UntagResource", - "organizations:DescribePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "ARN of the Policy", - "pattern": "^arn:aws.*:organizations::[0-9]{12}:policy/o-[a-z0-9]{10}/(service_control|tag|backup|aiservices_opt_out)_policy/p-[a-z0-9]{8}", - "type": "string" - }, - "AwsManaged": { - "description": "A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.", - "type": "boolean" - }, - "Content": { - "description": "The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.", - "maxLength": 1000000, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": [ - "object", - "string" - ] - }, - "Description": { - "description": "Human readable description of the policy", - "maxLength": 512, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "Id": { - "description": "Id of the Policy", - "maxLength": 130, - "pattern": "^p-[0-9a-zA-Z_]{8,128}$", - "type": "string" - }, - "Name": { - "description": "Name of the Policy", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": "string" - }, - "Tags": { - "description": "A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "TargetIds": { - "description": "List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to", - "insertionOrder": false, - "items": { - "pattern": "^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY", - "enum": [ - "SERVICE_CONTROL_POLICY", - "AISERVICES_OPT_OUT_POLICY", - "BACKUP_POLICY", - "TAG_POLICY" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/AwsManaged" - ], - "required": [ - "Name", - "Type", - "Content" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Organizations::Policy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A custom key-value pair associated with a resource within your organization.", + "properties": { + "Key": { + "description": "The key identifier, or name, of the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "Value": { + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", + "maxLength": 256, + "minLength": 0, + "pattern": "[\\s\\S]*", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.", + "handlers": { + "create": { + "permissions": [ + "organizations:CreatePolicy", + "organizations:DescribePolicy", + "organizations:AttachPolicy", + "organizations:ListTagsForResource", + "organizations:ListTargetsForPolicy", + "organizations:TagResource" + ] + }, + "delete": { + "permissions": [ + "organizations:DetachPolicy", + "organizations:DeletePolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Type": { + "$ref": "resource-schema.json#/properties/Type" + } + }, + "required": [ + "Type" + ] + }, + "permissions": [ + "organizations:ListPolicies" + ] + }, + "read": { + "permissions": [ + "organizations:DescribePolicy", + "organizations:ListTargetsForPolicy", + "organizations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:UpdatePolicy", + "organizations:ListTagsForResource", + "organizations:ListTargetsForPolicy", + "organizations:TagResource", + "organizations:UntagResource", + "organizations:DescribePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "ARN of the Policy", + "pattern": "^arn:aws.*:organizations::[0-9]{12}:policy/o-[a-z0-9]{10}/(service_control|tag|backup|aiservices_opt_out)_policy/p-[a-z0-9]{8}", + "type": "string" + }, + "AwsManaged": { + "description": "A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.", + "type": "boolean" + }, + "Content": { + "description": "The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.", + "maxLength": 1000000, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": [ + "object", + "string" + ] + }, + "Description": { + "description": "Human readable description of the policy", + "maxLength": 512, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "Id": { + "description": "Id of the Policy", + "maxLength": 130, + "pattern": "^p-[0-9a-zA-Z_]{8,128}$", + "type": "string" + }, + "Name": { + "description": "Name of the Policy", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": "string" + }, + "Tags": { + "description": "A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TargetIds": { + "description": "List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to", + "insertionOrder": false, + "items": { + "pattern": "^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY", + "enum": [ + "SERVICE_CONTROL_POLICY", + "AISERVICES_OPT_OUT_POLICY", + "BACKUP_POLICY", + "TAG_POLICY" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/AwsManaged" + ], + "required": [ + "Name", + "Type", + "Content" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Organizations::Policy" +} diff --git a/schema/aws-organizations-resourcepolicy.json b/schema/aws-organizations-resourcepolicy.json index 3cba273..f5a862d 100644 --- a/schema/aws-organizations-resourcepolicy.json +++ b/schema/aws-organizations-resourcepolicy.json @@ -1,115 +1,115 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A custom key-value pair associated with a resource within your organization.", - "properties": { - "Key": { - "description": "The key identifier, or name, of the tag.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "You can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.", - "handlers": { - "create": { - "permissions": [ - "organizations:PutResourcePolicy", - "organizations:DescribeResourcePolicy", - "organizations:ListTagsForResource", - "organizations:TagResource" - ] - }, - "delete": { - "permissions": [ - "organizations:DeleteResourcePolicy" - ] - }, - "list": { - "permissions": [ - "organizations:DescribeResourcePolicy" - ] - }, - "read": { - "permissions": [ - "organizations:DescribeResourcePolicy", - "organizations:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "organizations:DescribeResourcePolicy", - "organizations:PutResourcePolicy", - "organizations:ListTagsForResource", - "organizations:TagResource", - "organizations:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the resource policy.", - "pattern": "^arn:aws.*:organizations::\\d{12}:resourcepolicy\\/o-[a-z0-9]{10,32}\\/rp-[0-9a-zA-Z_]{4,128}", - "type": "string" - }, - "Content": { - "description": "The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.", - "maxLength": 40000, - "minLength": 1, - "pattern": "[\\s\\S]*", - "type": [ - "object", - "string" - ] - }, - "Id": { - "description": "The unique identifier (ID) associated with this resource policy.", - "maxLength": 131, - "pattern": "^rp-[0-9a-zA-Z_]{4,128}$", - "type": "string" - }, - "Tags": { - "description": "A list of tags that you want to attach to the resource policy", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Content" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Organizations::ResourcePolicy" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A custom key-value pair associated with a resource within your organization.", + "properties": { + "Key": { + "description": "The key identifier, or name, of the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "You can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.", + "handlers": { + "create": { + "permissions": [ + "organizations:PutResourcePolicy", + "organizations:DescribeResourcePolicy", + "organizations:ListTagsForResource", + "organizations:TagResource" + ] + }, + "delete": { + "permissions": [ + "organizations:DeleteResourcePolicy" + ] + }, + "list": { + "permissions": [ + "organizations:DescribeResourcePolicy" + ] + }, + "read": { + "permissions": [ + "organizations:DescribeResourcePolicy", + "organizations:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "organizations:DescribeResourcePolicy", + "organizations:PutResourcePolicy", + "organizations:ListTagsForResource", + "organizations:TagResource", + "organizations:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the resource policy.", + "pattern": "^arn:aws.*:organizations::\\d{12}:resourcepolicy\\/o-[a-z0-9]{10,32}\\/rp-[0-9a-zA-Z_]{4,128}", + "type": "string" + }, + "Content": { + "description": "The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.", + "maxLength": 40000, + "minLength": 1, + "pattern": "[\\s\\S]*", + "type": [ + "object", + "string" + ] + }, + "Id": { + "description": "The unique identifier (ID) associated with this resource policy.", + "maxLength": 131, + "pattern": "^rp-[0-9a-zA-Z_]{4,128}$", + "type": "string" + }, + "Tags": { + "description": "A list of tags that you want to attach to the resource policy", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Content" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-organizations", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Organizations::ResourcePolicy" +} diff --git a/schema/aws-osis-pipeline.json b/schema/aws-osis-pipeline.json index 2281d7e..be2dd54 100644 --- a/schema/aws-osis-pipeline.json +++ b/schema/aws-osis-pipeline.json @@ -1,297 +1,317 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PipelineName" - ], - "definitions": { - "BufferOptions": { - "additionalProperties": false, - "description": "Key-value pairs to configure buffering.", - "properties": { - "PersistentBufferEnabled": { - "description": "Whether persistent buffering should be enabled.", - "type": "boolean" - } - }, - "required": [ - "PersistentBufferEnabled" - ], - "type": "object" - }, - "EncryptionAtRestOptions": { - "additionalProperties": false, - "description": "Key-value pairs to configure encryption at rest.", - "properties": { - "KmsKeyArn": { - "description": "The KMS key to use for encrypting data. By default an AWS owned key is used", - "type": "string" - } - }, - "required": [ - "KmsKeyArn" - ], - "type": "object" - }, - "LogPublishingOptions": { - "additionalProperties": false, - "description": "Key-value pairs to configure log publishing.", - "properties": { - "CloudWatchLogDestination": { - "additionalProperties": false, - "description": "The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.", - "properties": { - "LogGroup": { - "maxLength": 512, - "minLength": 1, - "pattern": "\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - } - }, - "required": [ - "LogGroup" - ], - "type": "object" - }, - "IsLoggingEnabled": { - "description": "Whether logs should be published.", - "type": "boolean" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcEndpoint": { - "additionalProperties": false, - "description": "An OpenSearch Ingestion Service-managed VPC endpoint that will access one or more pipelines.", - "properties": { - "VpcEndpointId": { - "description": "The unique identifier of the endpoint.", - "type": "string" - }, - "VpcId": { - "description": "The ID for your VPC. AWS Privatelink generates this value when you create a VPC.", - "type": "string" - }, - "VpcOptions": { - "$ref": "#/definitions/VpcOptions" - } - }, - "type": "object" - }, - "VpcOptions": { - "additionalProperties": false, - "description": "Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.", - "properties": { - "SecurityGroupIds": { - "description": "A list of security groups associated with the VPC endpoint.", - "insertionOrder": false, - "items": { - "maxLength": 20, - "minLength": 11, - "pattern": "sg-\\w{8}(\\w{9})?", - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "description": "A list of subnet IDs associated with the VPC endpoint.", - "insertionOrder": false, - "items": { - "maxLength": 24, - "minLength": 15, - "pattern": "subnet-\\w{8}(\\w{9})?", - "type": "string" - }, - "type": "array" - }, - "VpcEndpointManagement": { - "description": "Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.", - "enum": [ - "CUSTOMER", - "SERVICE" - ], - "type": "string" - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - } - }, - "description": "An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.", - "handlers": { - "create": { - "permissions": [ - "osis:CreatePipeline", - "osis:GetPipeline", - "osis:TagResource", - "osis:ListTagsForResource", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "logs:CreateLogDelivery", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "osis:DeletePipeline", - "osis:GetPipeline", - "logs:GetLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "list": { - "permissions": [ - "osis:ListPipelines" - ] - }, - "read": { - "permissions": [ - "osis:GetPipeline", - "osis:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "osis:UpdatePipeline", - "osis:GetPipeline", - "osis:ListTagsForResource", - "osis:TagResource", - "osis:UntagResource", - "iam:PassRole", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:ListLogDeliveries", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/PipelineArn" - ], - "properties": { - "BufferOptions": { - "$ref": "#/definitions/BufferOptions" - }, - "EncryptionAtRestOptions": { - "$ref": "#/definitions/EncryptionAtRestOptions" - }, - "IngestEndpointUrls": { - "description": "A list of endpoints that can be used for ingesting data into a pipeline", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "LogPublishingOptions": { - "$ref": "#/definitions/LogPublishingOptions" - }, - "MaxUnits": { - "description": "The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", - "maximum": 384, - "minimum": 1, - "type": "integer" - }, - "MinUnits": { - "description": "The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", - "maximum": 384, - "minimum": 1, - "type": "integer" - }, - "PipelineArn": { - "description": "The Amazon Resource Name (ARN) of the pipeline.", - "maxLength": 76, - "minLength": 46, - "pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$", - "type": "string" - }, - "PipelineConfigurationBody": { - "description": "The Data Prepper pipeline configuration.", - "maxLength": 24000, - "minLength": 1, - "type": "string" - }, - "PipelineName": { - "description": "Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.", - "maxLength": 28, - "minLength": 3, - "pattern": "[a-z][a-z0-9\\-]+", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VpcEndpointService": { - "description": "The VPC endpoint service name for the pipeline.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "VpcEndpoints": { - "description": "The VPC interface endpoints that have access to the pipeline.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcEndpoint" - }, - "type": "array" - }, - "VpcOptions": { - "$ref": "#/definitions/VpcOptions" - } - }, - "readOnlyProperties": [ - "/properties/PipelineArn", - "/properties/IngestEndpointUrls", - "/properties/VpcEndpoints", - "/properties/VpcEndpointService" - ], - "required": [ - "MaxUnits", - "MinUnits", - "PipelineConfigurationBody", - "PipelineName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-osis.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::OSIS::Pipeline", - "writeOnlyProperties": [ - "/properties/VpcOptions" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PipelineName" + ], + "definitions": { + "BufferOptions": { + "additionalProperties": false, + "description": "Key-value pairs to configure buffering.", + "properties": { + "PersistentBufferEnabled": { + "description": "Whether persistent buffering should be enabled.", + "type": "boolean" + } + }, + "required": [ + "PersistentBufferEnabled" + ], + "type": "object" + }, + "EncryptionAtRestOptions": { + "additionalProperties": false, + "description": "Key-value pairs to configure encryption at rest.", + "properties": { + "KmsKeyArn": { + "description": "The KMS key to use for encrypting data. By default an AWS owned key is used", + "type": "string" + } + }, + "required": [ + "KmsKeyArn" + ], + "type": "object" + }, + "LogPublishingOptions": { + "additionalProperties": false, + "description": "Key-value pairs to configure log publishing.", + "properties": { + "CloudWatchLogDestination": { + "additionalProperties": false, + "description": "The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.", + "properties": { + "LogGroup": { + "maxLength": 512, + "minLength": 1, + "pattern": "\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + } + }, + "required": [ + "LogGroup" + ], + "type": "object" + }, + "IsLoggingEnabled": { + "description": "Whether logs should be published.", + "type": "boolean" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcEndpoint": { + "additionalProperties": false, + "description": "An OpenSearch Ingestion Service-managed VPC endpoint that will access one or more pipelines.", + "properties": { + "VpcEndpointId": { + "description": "The unique identifier of the endpoint.", + "type": "string" + }, + "VpcId": { + "description": "The ID for your VPC. AWS Privatelink generates this value when you create a VPC.", + "type": "string" + }, + "VpcOptions": { + "$ref": "#/definitions/VpcOptions" + } + }, + "type": "object" + }, + "VpcOptions": { + "additionalProperties": false, + "description": "Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.", + "properties": { + "SecurityGroupIds": { + "description": "A list of security groups associated with the VPC endpoint.", + "insertionOrder": false, + "items": { + "maxLength": 20, + "minLength": 11, + "pattern": "sg-\\w{8}(\\w{9})?", + "type": "string" + }, + "type": "array" + }, + "SubnetIds": { + "description": "A list of subnet IDs associated with the VPC endpoint.", + "insertionOrder": false, + "items": { + "maxLength": 24, + "minLength": 15, + "pattern": "subnet-\\w{8}(\\w{9})?", + "type": "string" + }, + "type": "array" + }, + "VpcAttachmentOptions": { + "additionalProperties": false, + "description": "Options for attaching a VPC to the pipeline.", + "properties": { + "AttachToVpc": { + "description": "Whether the pipeline should be attached to the provided VPC", + "type": "boolean" + }, + "CidrBlock": { + "description": "The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).", + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$", + "type": "string" + } + }, + "required": [ + "AttachToVpc", + "CidrBlock" + ], + "type": "object" + }, + "VpcEndpointManagement": { + "description": "Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.", + "enum": [ + "CUSTOMER", + "SERVICE" + ], + "type": "string" + } + }, + "required": [ + "SubnetIds" + ], + "type": "object" + } + }, + "description": "An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.", + "handlers": { + "create": { + "permissions": [ + "osis:CreatePipeline", + "osis:GetPipeline", + "osis:TagResource", + "osis:ListTagsForResource", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "logs:CreateLogDelivery", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "osis:DeletePipeline", + "osis:GetPipeline", + "logs:GetLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries" + ] + }, + "list": { + "permissions": [ + "osis:ListPipelines" + ] + }, + "read": { + "permissions": [ + "osis:GetPipeline", + "osis:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "osis:UpdatePipeline", + "osis:GetPipeline", + "osis:ListTagsForResource", + "osis:TagResource", + "osis:UntagResource", + "iam:PassRole", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:ListLogDeliveries", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/PipelineArn" + ], + "properties": { + "BufferOptions": { + "$ref": "#/definitions/BufferOptions" + }, + "EncryptionAtRestOptions": { + "$ref": "#/definitions/EncryptionAtRestOptions" + }, + "IngestEndpointUrls": { + "description": "A list of endpoints that can be used for ingesting data into a pipeline", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "LogPublishingOptions": { + "$ref": "#/definitions/LogPublishingOptions" + }, + "MaxUnits": { + "description": "The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", + "maximum": 384, + "minimum": 1, + "type": "integer" + }, + "MinUnits": { + "description": "The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", + "maximum": 384, + "minimum": 1, + "type": "integer" + }, + "PipelineArn": { + "description": "The Amazon Resource Name (ARN) of the pipeline.", + "maxLength": 76, + "minLength": 46, + "pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$", + "type": "string" + }, + "PipelineConfigurationBody": { + "description": "The Data Prepper pipeline configuration.", + "maxLength": 24000, + "minLength": 1, + "type": "string" + }, + "PipelineName": { + "description": "Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.", + "maxLength": 28, + "minLength": 3, + "pattern": "[a-z][a-z0-9\\-]+", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VpcEndpointService": { + "description": "The VPC endpoint service name for the pipeline.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "VpcEndpoints": { + "description": "The VPC interface endpoints that have access to the pipeline.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcEndpoint" + }, + "type": "array" + }, + "VpcOptions": { + "$ref": "#/definitions/VpcOptions" + } + }, + "readOnlyProperties": [ + "/properties/PipelineArn", + "/properties/IngestEndpointUrls", + "/properties/VpcEndpoints", + "/properties/VpcEndpointService" + ], + "required": [ + "MaxUnits", + "MinUnits", + "PipelineConfigurationBody", + "PipelineName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-osis.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::OSIS::Pipeline", + "writeOnlyProperties": [ + "/properties/VpcOptions" + ] +} diff --git a/schema/aws-panorama-applicationinstance.json b/schema/aws-panorama-applicationinstance.json index 77ad5f7..b1af687 100644 --- a/schema/aws-panorama-applicationinstance.json +++ b/schema/aws-panorama-applicationinstance.json @@ -1,299 +1,320 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Description", - "/properties/ManifestPayload", - "/properties/ManifestOverridesPayload", - "/properties/RuntimeRoleArn", - "/properties/DefaultRuntimeContextDevice", - "/properties/ApplicationInstanceIdToReplace" - ], - "definitions": { - "ApplicationInstanceArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "ApplicationInstanceHealthStatus": { - "enum": [ - "RUNNING", - "ERROR", - "NOT_AVAILABLE" - ], - "type": "string" - }, - "ApplicationInstanceId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "ApplicationInstanceStatus": { - "enum": [ - "DEPLOYMENT_PENDING", - "DEPLOYMENT_REQUESTED", - "DEPLOYMENT_IN_PROGRESS", - "DEPLOYMENT_ERROR", - "DEPLOYMENT_SUCCEEDED", - "REMOVAL_PENDING", - "REMOVAL_REQUESTED", - "REMOVAL_IN_PROGRESS", - "REMOVAL_FAILED", - "REMOVAL_SUCCEEDED" - ], - "type": "string" - }, - "ApplicationInstanceStatusDescription": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DefaultRuntimeContextDevice": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - }, - "DeviceId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "DeviceName": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "ManifestOverridesPayload": { - "additionalProperties": false, - "properties": { - "PayloadData": { - "$ref": "#/definitions/ManifestOverridesPayloadData" - } - }, - "type": "object" - }, - "ManifestOverridesPayloadData": { - "maxLength": 51200, - "minLength": 0, - "pattern": "^.+$", - "type": "string" - }, - "ManifestPayload": { - "additionalProperties": false, - "properties": { - "PayloadData": { - "$ref": "#/definitions/ManifestPayloadData" - } - }, - "type": "object" - }, - "ManifestPayloadData": { - "maxLength": 51200, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "RuntimeRoleArn": { - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$", - "type": "string" - }, - "StatusFilter": { - "enum": [ - "DEPLOYMENT_SUCCEEDED", - "DEPLOYMENT_ERROR", - "REMOVAL_SUCCEEDED", - "REMOVAL_FAILED", - "PROCESSING_DEPLOYMENT", - "PROCESSING_REMOVAL" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "pattern": "^.+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "description": "List of tags", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Timestamp": { - "type": "integer" - } - }, - "description": "Schema for ApplicationInstance CloudFormation Resource", - "handlers": { - "create": { - "permissions": [ - "panorama:CreateApplicationInstance", - "panorama:ListTagsForResource", - "panorama:TagResource", - "panorama:DescribeApplicationInstance", - "panorama:DescribeApplicationInstanceDetails", - "iam:PassRole", - "s3:ListBucket", - "s3:PutObject", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "panorama:RemoveApplicationInstance", - "panorama:DescribeApplicationInstance", - "panorama:DescribeApplicationInstanceDetails", - "s3:DeleteObject", - "s3:DeleteObjectVersion", - "s3:DeleteObjectVersionTagging", - "s3:ListObjects", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "list": { - "permissions": [ - "panorama:ListApplicationInstances", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "read": { - "permissions": [ - "panorama:DescribeApplicationInstance", - "panorama:DescribeApplicationInstanceDetails", - "panorama:ListTagsForResource", - "s3:ListObjects", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "update": { - "permissions": [ - "panorama:ListTagsForResource", - "panorama:TagResource", - "panorama:UntagResource", - "panorama:DescribeApplicationInstance", - "panorama:DescribeApplicationInstanceDetails", - "s3:ListObjects", - "s3:GetObject", - "s3:GetObjectVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationInstanceId" - ], - "properties": { - "ApplicationInstanceId": { - "$ref": "#/definitions/ApplicationInstanceId" - }, - "ApplicationInstanceIdToReplace": { - "$ref": "#/definitions/ApplicationInstanceId" - }, - "Arn": { - "$ref": "#/definitions/ApplicationInstanceArn" - }, - "CreatedTime": { - "$ref": "#/definitions/Timestamp" - }, - "DefaultRuntimeContextDevice": { - "$ref": "#/definitions/DefaultRuntimeContextDevice" - }, - "DefaultRuntimeContextDeviceName": { - "$ref": "#/definitions/DeviceName" - }, - "Description": { - "$ref": "#/definitions/Description" - }, - "HealthStatus": { - "$ref": "#/definitions/ApplicationInstanceHealthStatus" - }, - "LastUpdatedTime": { - "$ref": "#/definitions/Timestamp" - }, - "ManifestOverridesPayload": { - "$ref": "#/definitions/ManifestOverridesPayload" - }, - "ManifestPayload": { - "$ref": "#/definitions/ManifestPayload" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "RuntimeRoleArn": { - "$ref": "#/definitions/RuntimeRoleArn" - }, - "Status": { - "$ref": "#/definitions/ApplicationInstanceStatus" - }, - "StatusDescription": { - "$ref": "#/definitions/ApplicationInstanceStatusDescription" - }, - "Tags": { - "$ref": "#/definitions/TagList" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationInstanceId", - "/properties/Arn", - "/properties/Status", - "/properties/HealthStatus", - "/properties/StatusDescription", - "/properties/DefaultRuntimeContextDeviceName", - "/properties/CreatedTime", - "/properties/LastUpdatedTime" - ], - "required": [ - "ManifestPayload", - "DefaultRuntimeContextDevice" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::Panorama::ApplicationInstance", - "writeOnlyProperties": [ - "/properties/ApplicationInstanceIdToReplace" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/ManifestPayload", + "/properties/ManifestOverridesPayload", + "/properties/RuntimeRoleArn", + "/properties/DefaultRuntimeContextDevice", + "/properties/ApplicationInstanceIdToReplace" + ], + "definitions": { + "ApplicationInstanceArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ApplicationInstanceHealthStatus": { + "enum": [ + "RUNNING", + "ERROR", + "NOT_AVAILABLE" + ], + "type": "string" + }, + "ApplicationInstanceId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "ApplicationInstanceStatus": { + "enum": [ + "DEPLOYMENT_PENDING", + "DEPLOYMENT_REQUESTED", + "DEPLOYMENT_IN_PROGRESS", + "DEPLOYMENT_ERROR", + "DEPLOYMENT_SUCCEEDED", + "REMOVAL_PENDING", + "REMOVAL_REQUESTED", + "REMOVAL_IN_PROGRESS", + "REMOVAL_FAILED", + "REMOVAL_SUCCEEDED" + ], + "type": "string" + }, + "ApplicationInstanceStatusDescription": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DefaultRuntimeContextDevice": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + }, + "DeviceId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "DeviceName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "ManifestOverridesPayload": { + "additionalProperties": false, + "description": "Parameter overrides for an application instance. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the overrides document.", + "properties": { + "PayloadData": { + "$ref": "#/definitions/ManifestOverridesPayloadData", + "description": "The overrides document." + } + }, + "type": "object" + }, + "ManifestOverridesPayloadData": { + "maxLength": 51200, + "minLength": 0, + "pattern": "^.+$", + "type": "string" + }, + "ManifestPayload": { + "additionalProperties": false, + "description": "A application verion's manifest file. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the application manifest (``graph.json``). This file is located in the ``graphs`` folder in your application source.", + "properties": { + "PayloadData": { + "$ref": "#/definitions/ManifestPayloadData", + "description": "The application manifest." + } + }, + "type": "object" + }, + "ManifestPayloadData": { + "maxLength": 51200, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "RuntimeRoleArn": { + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$", + "type": "string" + }, + "StatusFilter": { + "enum": [ + "DEPLOYMENT_SUCCEEDED", + "DEPLOYMENT_ERROR", + "REMOVAL_SUCCEEDED", + "REMOVAL_FAILED", + "PROCESSING_DEPLOYMENT", + "PROCESSING_REMOVAL" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "", + "maxLength": 128, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "Value": { + "description": "", + "maxLength": 256, + "minLength": 0, + "pattern": "^.+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "description": "List of tags", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Timestamp": { + "type": "integer" + } + }, + "description": "Creates an application instance and deploys it to a device.", + "handlers": { + "create": { + "permissions": [ + "panorama:CreateApplicationInstance", + "panorama:ListTagsForResource", + "panorama:TagResource", + "panorama:DescribeApplicationInstance", + "panorama:DescribeApplicationInstanceDetails", + "iam:PassRole", + "s3:ListBucket", + "s3:PutObject", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "panorama:RemoveApplicationInstance", + "panorama:DescribeApplicationInstance", + "panorama:DescribeApplicationInstanceDetails", + "s3:DeleteObject", + "s3:DeleteObjectVersion", + "s3:DeleteObjectVersionTagging", + "s3:ListObjects", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "list": { + "permissions": [ + "panorama:ListApplicationInstances", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "read": { + "permissions": [ + "panorama:DescribeApplicationInstance", + "panorama:DescribeApplicationInstanceDetails", + "panorama:ListTagsForResource", + "s3:ListObjects", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "update": { + "permissions": [ + "panorama:ListTagsForResource", + "panorama:TagResource", + "panorama:UntagResource", + "panorama:DescribeApplicationInstance", + "panorama:DescribeApplicationInstanceDetails", + "s3:ListObjects", + "s3:GetObject", + "s3:GetObjectVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationInstanceId" + ], + "properties": { + "ApplicationInstanceId": { + "$ref": "#/definitions/ApplicationInstanceId", + "description": "" + }, + "ApplicationInstanceIdToReplace": { + "$ref": "#/definitions/ApplicationInstanceId", + "description": "The ID of an application instance to replace with the new instance." + }, + "Arn": { + "$ref": "#/definitions/ApplicationInstanceArn", + "description": "" + }, + "CreatedTime": { + "$ref": "#/definitions/Timestamp", + "description": "" + }, + "DefaultRuntimeContextDevice": { + "$ref": "#/definitions/DefaultRuntimeContextDevice", + "description": "The device's ID." + }, + "DefaultRuntimeContextDeviceName": { + "$ref": "#/definitions/DeviceName", + "description": "" + }, + "Description": { + "$ref": "#/definitions/Description", + "description": "A description for the application instance." + }, + "HealthStatus": { + "$ref": "#/definitions/ApplicationInstanceHealthStatus", + "description": "" + }, + "LastUpdatedTime": { + "$ref": "#/definitions/Timestamp", + "description": "" + }, + "ManifestOverridesPayload": { + "$ref": "#/definitions/ManifestOverridesPayload", + "description": "Setting overrides for the application manifest." + }, + "ManifestPayload": { + "$ref": "#/definitions/ManifestPayload", + "description": "The application's manifest document." + }, + "Name": { + "$ref": "#/definitions/Name", + "description": "A name for the application instance." + }, + "RuntimeRoleArn": { + "$ref": "#/definitions/RuntimeRoleArn", + "description": "The ARN of a runtime role for the application instance." + }, + "Status": { + "$ref": "#/definitions/ApplicationInstanceStatus", + "description": "" + }, + "StatusDescription": { + "$ref": "#/definitions/ApplicationInstanceStatusDescription", + "description": "" + }, + "Tags": { + "$ref": "#/definitions/TagList", + "description": "Tags for the application instance." + } + }, + "readOnlyProperties": [ + "/properties/ApplicationInstanceId", + "/properties/Arn", + "/properties/Status", + "/properties/HealthStatus", + "/properties/StatusDescription", + "/properties/DefaultRuntimeContextDeviceName", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "ManifestPayload", + "DefaultRuntimeContextDevice" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::Panorama::ApplicationInstance", + "writeOnlyProperties": [ + "/properties/ApplicationInstanceIdToReplace" + ] +} diff --git a/schema/aws-panorama-package.json b/schema/aws-panorama-package.json index 76a2d8a..ed2a0a3 100644 --- a/schema/aws-panorama-package.json +++ b/schema/aws-panorama-package.json @@ -1,176 +1,191 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PackageName" - ], - "definitions": { - "NodePackageArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "NodePackageId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_\\/]+$", - "type": "string" - }, - "NodePackageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "StorageLocation": { - "additionalProperties": false, - "properties": { - "BinaryPrefixLocation": { - "type": "string" - }, - "Bucket": { - "type": "string" - }, - "GeneratedPrefixLocation": { - "type": "string" - }, - "ManifestPrefixLocation": { - "type": "string" - }, - "RepoPrefixLocation": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^.+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Timestamp": { - "type": "integer" - } - }, - "description": "Schema for Package CloudFormation Resource", - "handlers": { - "create": { - "permissions": [ - "panorama:CreatePackage", - "panorama:ListTagsForResource", - "panorama:TagResource", - "panorama:DescribePackage", - "s3:ListBucket", - "s3:PutObject", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "panorama:DeletePackage", - "panorama:DescribePackage", - "s3:DeleteObject", - "s3:DeleteObjectVersion", - "s3:DeleteObjectVersionTagging", - "s3:ListObjects", - "s3:ListObjectsV2", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "list": { - "permissions": [ - "panorama:ListPackages", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "read": { - "permissions": [ - "panorama:DescribePackage", - "panorama:ListTagsForResource", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "update": { - "permissions": [ - "panorama:DescribePackage", - "panorama:ListTagsForResource", - "panorama:TagResource", - "panorama:UntagResource", - "s3:PutObject", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/PackageId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/NodePackageArn" - }, - "CreatedTime": { - "$ref": "#/definitions/Timestamp" - }, - "PackageId": { - "$ref": "#/definitions/NodePackageId" - }, - "PackageName": { - "$ref": "#/definitions/NodePackageName" - }, - "StorageLocation": { - "$ref": "#/definitions/StorageLocation" - }, - "Tags": { - "$ref": "#/definitions/TagList" - } - }, - "readOnlyProperties": [ - "/properties/PackageId", - "/properties/Arn", - "/properties/CreatedTime", - "/properties/StorageLocation/Bucket", - "/properties/StorageLocation/RepoPrefixLocation", - "/properties/StorageLocation/GeneratedPrefixLocation", - "/properties/StorageLocation/BinaryPrefixLocation", - "/properties/StorageLocation/ManifestPrefixLocation" - ], - "required": [ - "PackageName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::Panorama::Package" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PackageName" + ], + "definitions": { + "NodePackageArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "NodePackageId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_\\/]+$", + "type": "string" + }, + "NodePackageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "StorageLocation": { + "additionalProperties": false, + "description": "A storage location.", + "properties": { + "BinaryPrefixLocation": { + "description": "The location's binary prefix.", + "type": "string" + }, + "Bucket": { + "description": "The location's bucket.", + "type": "string" + }, + "GeneratedPrefixLocation": { + "description": "The location's generated prefix.", + "type": "string" + }, + "ManifestPrefixLocation": { + "description": "The location's manifest prefix.", + "type": "string" + }, + "RepoPrefixLocation": { + "description": "The location's repo prefix.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "", + "maxLength": 128, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "Value": { + "description": "", + "maxLength": 256, + "minLength": 0, + "pattern": "^.+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Timestamp": { + "type": "integer" + } + }, + "description": "Creates a package and storage location in an Amazon S3 access point.", + "handlers": { + "create": { + "permissions": [ + "panorama:CreatePackage", + "panorama:ListTagsForResource", + "panorama:TagResource", + "panorama:DescribePackage", + "s3:ListBucket", + "s3:PutObject", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "panorama:DeletePackage", + "panorama:DescribePackage", + "s3:DeleteObject", + "s3:DeleteObjectVersion", + "s3:DeleteObjectVersionTagging", + "s3:ListObjects", + "s3:ListObjectsV2", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "list": { + "permissions": [ + "panorama:ListPackages", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "read": { + "permissions": [ + "panorama:DescribePackage", + "panorama:ListTagsForResource", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "update": { + "permissions": [ + "panorama:DescribePackage", + "panorama:ListTagsForResource", + "panorama:TagResource", + "panorama:UntagResource", + "s3:PutObject", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/PackageId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/NodePackageArn", + "description": "" + }, + "CreatedTime": { + "$ref": "#/definitions/Timestamp", + "description": "" + }, + "PackageId": { + "$ref": "#/definitions/NodePackageId", + "description": "" + }, + "PackageName": { + "$ref": "#/definitions/NodePackageName", + "description": "A name for the package." + }, + "StorageLocation": { + "$ref": "#/definitions/StorageLocation", + "description": "A storage location." + }, + "Tags": { + "$ref": "#/definitions/TagList", + "description": "Tags for the package." + } + }, + "readOnlyProperties": [ + "/properties/PackageId", + "/properties/Arn", + "/properties/CreatedTime", + "/properties/StorageLocation/Bucket", + "/properties/StorageLocation/RepoPrefixLocation", + "/properties/StorageLocation/GeneratedPrefixLocation", + "/properties/StorageLocation/BinaryPrefixLocation", + "/properties/StorageLocation/ManifestPrefixLocation" + ], + "required": [ + "PackageName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::Panorama::Package" +} diff --git a/schema/aws-panorama-packageversion.json b/schema/aws-panorama-packageversion.json index 9c7db69..6dadfd6 100644 --- a/schema/aws-panorama-packageversion.json +++ b/schema/aws-panorama-packageversion.json @@ -1,168 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OwnerAccount", - "/properties/PackageId", - "/properties/PackageVersion", - "/properties/PatchVersion" - ], - "definitions": { - "NodePackageArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "NodePackageId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_\\/]+$", - "type": "string" - }, - "NodePackageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-\\_]+$", - "type": "string" - }, - "NodePackagePatchVersion": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-z0-9]+$", - "type": "string" - }, - "NodePackageVersion": { - "maxLength": 255, - "minLength": 1, - "pattern": "^([0-9]+)\\.([0-9]+)$", - "type": "string" - }, - "PackageOwnerAccount": { - "maxLength": 12, - "minLength": 1, - "pattern": "^[0-9a-z\\_]+$", - "type": "string" - }, - "PackageVersionStatus": { - "enum": [ - "REGISTER_PENDING", - "REGISTER_COMPLETED", - "FAILED", - "DELETING" - ], - "type": "string" - }, - "PackageVersionStatusDescription": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "TimeStamp": { - "type": "integer" - } - }, - "description": "Schema for PackageVersion Resource Type", - "handlers": { - "create": { - "permissions": [ - "panorama:RegisterPackageVersion", - "panorama:DescribePackageVersion", - "s3:ListBucket", - "s3:PutObject", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "delete": { - "permissions": [ - "panorama:DeregisterPackageVersion", - "panorama:DescribePackageVersion", - "s3:DeleteObject", - "s3:DeleteObjectVersion", - "s3:DeleteObjectVersionTagging", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "read": { - "permissions": [ - "panorama:DescribePackageVersion", - "s3:ListBucket", - "s3:GetObject", - "s3:GetObjectVersion" - ] - }, - "update": { - "permissions": [ - "panorama:DescribePackageVersion", - "panorama:RegisterPackageVersion", - "s3:ListBucket", - "s3:PutObject", - "s3:GetObject", - "s3:GetObjectVersion" - ] - } - }, - "primaryIdentifier": [ - "/properties/PackageId", - "/properties/PackageVersion", - "/properties/PatchVersion" - ], - "properties": { - "IsLatestPatch": { - "type": "boolean" - }, - "MarkLatest": { - "type": "boolean" - }, - "OwnerAccount": { - "$ref": "#/definitions/PackageOwnerAccount" - }, - "PackageArn": { - "$ref": "#/definitions/NodePackageArn" - }, - "PackageId": { - "$ref": "#/definitions/NodePackageId" - }, - "PackageName": { - "$ref": "#/definitions/NodePackageName" - }, - "PackageVersion": { - "$ref": "#/definitions/NodePackageVersion" - }, - "PatchVersion": { - "$ref": "#/definitions/NodePackagePatchVersion" - }, - "RegisteredTime": { - "$ref": "#/definitions/TimeStamp" - }, - "Status": { - "$ref": "#/definitions/PackageVersionStatus" - }, - "StatusDescription": { - "$ref": "#/definitions/PackageVersionStatusDescription" - }, - "UpdatedLatestPatchVersion": { - "$ref": "#/definitions/NodePackagePatchVersion" - } - }, - "readOnlyProperties": [ - "/properties/PackageName", - "/properties/PackageArn", - "/properties/Status", - "/properties/StatusDescription", - "/properties/IsLatestPatch", - "/properties/RegisteredTime" - ], - "required": [ - "PackageId", - "PackageVersion", - "PatchVersion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-panorama.git", - "taggable": false, - "typeName": "AWS::Panorama::PackageVersion", - "writeOnlyProperties": [ - "/properties/UpdatedLatestPatchVersion" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OwnerAccount", + "/properties/PackageId", + "/properties/PackageVersion", + "/properties/PatchVersion" + ], + "definitions": { + "NodePackageArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "NodePackageId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_\\/]+$", + "type": "string" + }, + "NodePackageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-\\_]+$", + "type": "string" + }, + "NodePackagePatchVersion": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-z0-9]+$", + "type": "string" + }, + "NodePackageVersion": { + "maxLength": 255, + "minLength": 1, + "pattern": "^([0-9]+)\\.([0-9]+)$", + "type": "string" + }, + "PackageOwnerAccount": { + "maxLength": 12, + "minLength": 1, + "pattern": "^[0-9a-z\\_]+$", + "type": "string" + }, + "PackageVersionStatus": { + "enum": [ + "REGISTER_PENDING", + "REGISTER_COMPLETED", + "FAILED", + "DELETING" + ], + "type": "string" + }, + "PackageVersionStatusDescription": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "TimeStamp": { + "type": "integer" + } + }, + "description": "Registers a package version.", + "handlers": { + "create": { + "permissions": [ + "panorama:RegisterPackageVersion", + "panorama:DescribePackageVersion", + "s3:ListBucket", + "s3:PutObject", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "delete": { + "permissions": [ + "panorama:DeregisterPackageVersion", + "panorama:DescribePackageVersion", + "s3:DeleteObject", + "s3:DeleteObjectVersion", + "s3:DeleteObjectVersionTagging", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "read": { + "permissions": [ + "panorama:DescribePackageVersion", + "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion" + ] + }, + "update": { + "permissions": [ + "panorama:DescribePackageVersion", + "panorama:RegisterPackageVersion", + "s3:ListBucket", + "s3:PutObject", + "s3:GetObject", + "s3:GetObjectVersion" + ] + } + }, + "primaryIdentifier": [ + "/properties/PackageId", + "/properties/PackageVersion", + "/properties/PatchVersion" + ], + "properties": { + "IsLatestPatch": { + "description": "", + "type": "boolean" + }, + "MarkLatest": { + "description": "Whether to mark the new version as the latest version.", + "type": "boolean" + }, + "OwnerAccount": { + "$ref": "#/definitions/PackageOwnerAccount", + "description": "An owner account." + }, + "PackageArn": { + "$ref": "#/definitions/NodePackageArn", + "description": "" + }, + "PackageId": { + "$ref": "#/definitions/NodePackageId", + "description": "A package ID." + }, + "PackageName": { + "$ref": "#/definitions/NodePackageName", + "description": "" + }, + "PackageVersion": { + "$ref": "#/definitions/NodePackageVersion", + "description": "A package version." + }, + "PatchVersion": { + "$ref": "#/definitions/NodePackagePatchVersion", + "description": "A patch version." + }, + "RegisteredTime": { + "$ref": "#/definitions/TimeStamp", + "description": "" + }, + "Status": { + "$ref": "#/definitions/PackageVersionStatus", + "description": "" + }, + "StatusDescription": { + "$ref": "#/definitions/PackageVersionStatusDescription", + "description": "" + }, + "UpdatedLatestPatchVersion": { + "$ref": "#/definitions/NodePackagePatchVersion", + "description": "If the version was marked latest, the new version to maker as latest." + } + }, + "readOnlyProperties": [ + "/properties/PackageName", + "/properties/PackageArn", + "/properties/Status", + "/properties/StatusDescription", + "/properties/IsLatestPatch", + "/properties/RegisteredTime" + ], + "required": [ + "PackageId", + "PackageVersion", + "PatchVersion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-panorama.git", + "taggable": false, + "typeName": "AWS::Panorama::PackageVersion", + "writeOnlyProperties": [ + "/properties/UpdatedLatestPatchVersion" + ] +} diff --git a/schema/aws-paymentcryptography-alias.json b/schema/aws-paymentcryptography-alias.json index a1bef27..0990acf 100644 --- a/schema/aws-paymentcryptography-alias.json +++ b/schema/aws-paymentcryptography-alias.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AliasName" - ], - "description": "Definition of AWS::PaymentCryptography::Alias Resource Type", - "handlers": { - "create": { - "permissions": [ - "payment-cryptography:CreateAlias" - ] - }, - "delete": { - "permissions": [ - "payment-cryptography:DeleteAlias" - ] - }, - "list": { - "permissions": [ - "payment-cryptography:ListAliases" - ] - }, - "read": { - "permissions": [ - "payment-cryptography:GetAlias" - ] - }, - "update": { - "permissions": [ - "payment-cryptography:UpdateAlias" - ] - } - }, - "primaryIdentifier": [ - "/properties/AliasName" - ], - "properties": { - "AliasName": { - "maxLength": 256, - "minLength": 7, - "pattern": "^alias/[a-zA-Z0-9/_-]+$", - "type": "string" - }, - "KeyArn": { - "maxLength": 150, - "minLength": 70, - "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$", - "type": "string" - } - }, - "required": [ - "AliasName" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::PaymentCryptography::Alias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AliasName" + ], + "description": "Definition of AWS::PaymentCryptography::Alias Resource Type", + "handlers": { + "create": { + "permissions": [ + "payment-cryptography:CreateAlias" + ] + }, + "delete": { + "permissions": [ + "payment-cryptography:DeleteAlias" + ] + }, + "list": { + "permissions": [ + "payment-cryptography:ListAliases" + ] + }, + "read": { + "permissions": [ + "payment-cryptography:GetAlias" + ] + }, + "update": { + "permissions": [ + "payment-cryptography:UpdateAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/AliasName" + ], + "properties": { + "AliasName": { + "maxLength": 256, + "minLength": 7, + "pattern": "^alias/[a-zA-Z0-9/_-]+$", + "type": "string" + }, + "KeyArn": { + "maxLength": 150, + "minLength": 70, + "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$", + "type": "string" + } + }, + "required": [ + "AliasName" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::PaymentCryptography::Alias" +} diff --git a/schema/aws-paymentcryptography-key.json b/schema/aws-paymentcryptography-key.json index c7bc660..e1d4422 100644 --- a/schema/aws-paymentcryptography-key.json +++ b/schema/aws-paymentcryptography-key.json @@ -1,257 +1,265 @@ -{ - "additionalProperties": false, - "definitions": { - "KeyAlgorithm": { - "enum": [ - "TDES_2KEY", - "TDES_3KEY", - "AES_128", - "AES_192", - "AES_256", - "RSA_2048", - "RSA_3072", - "RSA_4096" - ], - "type": "string" - }, - "KeyAttributes": { - "additionalProperties": false, - "properties": { - "KeyAlgorithm": { - "$ref": "#/definitions/KeyAlgorithm" - }, - "KeyClass": { - "$ref": "#/definitions/KeyClass" - }, - "KeyModesOfUse": { - "$ref": "#/definitions/KeyModesOfUse" - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - } - }, - "required": [ - "KeyAlgorithm", - "KeyClass", - "KeyModesOfUse", - "KeyUsage" - ], - "type": "object" - }, - "KeyCheckValueAlgorithm": { - "enum": [ - "CMAC", - "ANSI_X9_24" - ], - "type": "string" - }, - "KeyClass": { - "enum": [ - "SYMMETRIC_KEY", - "ASYMMETRIC_KEY_PAIR", - "PRIVATE_KEY", - "PUBLIC_KEY" - ], - "type": "string" - }, - "KeyModesOfUse": { - "additionalProperties": false, - "properties": { - "Decrypt": { - "default": false, - "type": "boolean" - }, - "DeriveKey": { - "default": false, - "type": "boolean" - }, - "Encrypt": { - "default": false, - "type": "boolean" - }, - "Generate": { - "default": false, - "type": "boolean" - }, - "NoRestrictions": { - "default": false, - "type": "boolean" - }, - "Sign": { - "default": false, - "type": "boolean" - }, - "Unwrap": { - "default": false, - "type": "boolean" - }, - "Verify": { - "default": false, - "type": "boolean" - }, - "Wrap": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "KeyOrigin": { - "description": "Defines the source of a key", - "enum": [ - "EXTERNAL", - "AWS_PAYMENT_CRYPTOGRAPHY" - ], - "type": "string" - }, - "KeyState": { - "description": "Defines the state of a key", - "enum": [ - "CREATE_IN_PROGRESS", - "CREATE_COMPLETE", - "DELETE_PENDING", - "DELETE_COMPLETE" - ], - "type": "string" - }, - "KeyUsage": { - "enum": [ - "TR31_B0_BASE_DERIVATION_KEY", - "TR31_C0_CARD_VERIFICATION_KEY", - "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", - "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", - "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", - "TR31_E1_EMV_MKEY_CONFIDENTIALITY", - "TR31_E2_EMV_MKEY_INTEGRITY", - "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", - "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", - "TR31_E6_EMV_MKEY_OTHER", - "TR31_K0_KEY_ENCRYPTION_KEY", - "TR31_K1_KEY_BLOCK_PROTECTION_KEY", - "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", - "TR31_M3_ISO_9797_3_MAC_KEY", - "TR31_M1_ISO_9797_1_MAC_KEY", - "TR31_M6_ISO_9797_5_CMAC_KEY", - "TR31_M7_HMAC_KEY", - "TR31_P0_PIN_ENCRYPTION_KEY", - "TR31_P1_PIN_GENERATION_KEY", - "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", - "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", - "TR31_V2_VISA_PIN_VERIFICATION_KEY", - "TR31_K2_TR34_ASYMMETRIC_KEY" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "Definition of AWS::PaymentCryptography::Key Resource Type", - "handlers": { - "create": { - "permissions": [ - "payment-cryptography:GetKey", - "payment-cryptography:CreateKey", - "payment-cryptography:TagResource" - ] - }, - "delete": { - "permissions": [ - "payment-cryptography:GetKey", - "payment-cryptography:DeleteKey" - ] - }, - "list": { - "permissions": [ - "payment-cryptography:ListKeys" - ] - }, - "read": { - "permissions": [ - "payment-cryptography:GetKey", - "payment-cryptography:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "payment-cryptography:GetKey", - "payment-cryptography:ListTagsForResource", - "payment-cryptography:TagResource", - "payment-cryptography:UntagResource", - "payment-cryptography:StartKeyUsage", - "payment-cryptography:StopKeyUsage" - ] - } - }, - "primaryIdentifier": [ - "/properties/KeyIdentifier" - ], - "properties": { - "Enabled": { - "type": "boolean" - }, - "Exportable": { - "type": "boolean" - }, - "KeyAttributes": { - "$ref": "#/definitions/KeyAttributes" - }, - "KeyCheckValueAlgorithm": { - "$ref": "#/definitions/KeyCheckValueAlgorithm" - }, - "KeyIdentifier": { - "maxLength": 322, - "minLength": 7, - "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$", - "type": "string" - }, - "KeyOrigin": { - "$ref": "#/definitions/KeyOrigin" - }, - "KeyState": { - "$ref": "#/definitions/KeyState" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/KeyIdentifier", - "/properties/KeyOrigin", - "/properties/KeyState" - ], - "required": [ - "Exportable", - "KeyAttributes" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::PaymentCryptography::Key" -} +{ + "additionalProperties": false, + "definitions": { + "KeyAlgorithm": { + "enum": [ + "TDES_2KEY", + "TDES_3KEY", + "AES_128", + "AES_192", + "AES_256", + "RSA_2048", + "RSA_3072", + "RSA_4096", + "ECC_NIST_P256", + "ECC_NIST_P384" + ], + "type": "string" + }, + "KeyAttributes": { + "additionalProperties": false, + "properties": { + "KeyAlgorithm": { + "$ref": "#/definitions/KeyAlgorithm" + }, + "KeyClass": { + "$ref": "#/definitions/KeyClass" + }, + "KeyModesOfUse": { + "$ref": "#/definitions/KeyModesOfUse" + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + } + }, + "required": [ + "KeyAlgorithm", + "KeyClass", + "KeyModesOfUse", + "KeyUsage" + ], + "type": "object" + }, + "KeyCheckValueAlgorithm": { + "enum": [ + "CMAC", + "ANSI_X9_24" + ], + "type": "string" + }, + "KeyClass": { + "enum": [ + "SYMMETRIC_KEY", + "ASYMMETRIC_KEY_PAIR", + "PRIVATE_KEY", + "PUBLIC_KEY" + ], + "type": "string" + }, + "KeyModesOfUse": { + "additionalProperties": false, + "properties": { + "Decrypt": { + "default": false, + "type": "boolean" + }, + "DeriveKey": { + "default": false, + "type": "boolean" + }, + "Encrypt": { + "default": false, + "type": "boolean" + }, + "Generate": { + "default": false, + "type": "boolean" + }, + "NoRestrictions": { + "default": false, + "type": "boolean" + }, + "Sign": { + "default": false, + "type": "boolean" + }, + "Unwrap": { + "default": false, + "type": "boolean" + }, + "Verify": { + "default": false, + "type": "boolean" + }, + "Wrap": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "KeyOrigin": { + "description": "Defines the source of a key", + "enum": [ + "EXTERNAL", + "AWS_PAYMENT_CRYPTOGRAPHY" + ], + "type": "string" + }, + "KeyState": { + "description": "Defines the state of a key", + "enum": [ + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "DELETE_PENDING", + "DELETE_COMPLETE" + ], + "type": "string" + }, + "KeyUsage": { + "enum": [ + "TR31_B0_BASE_DERIVATION_KEY", + "TR31_C0_CARD_VERIFICATION_KEY", + "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", + "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", + "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", + "TR31_E1_EMV_MKEY_CONFIDENTIALITY", + "TR31_E2_EMV_MKEY_INTEGRITY", + "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", + "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", + "TR31_E6_EMV_MKEY_OTHER", + "TR31_K0_KEY_ENCRYPTION_KEY", + "TR31_K1_KEY_BLOCK_PROTECTION_KEY", + "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", + "TR31_M3_ISO_9797_3_MAC_KEY", + "TR31_M1_ISO_9797_1_MAC_KEY", + "TR31_M6_ISO_9797_5_CMAC_KEY", + "TR31_M7_HMAC_KEY", + "TR31_P0_PIN_ENCRYPTION_KEY", + "TR31_P1_PIN_GENERATION_KEY", + "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", + "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", + "TR31_V2_VISA_PIN_VERIFICATION_KEY", + "TR31_K2_TR34_ASYMMETRIC_KEY" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::PaymentCryptography::Key Resource Type", + "handlers": { + "create": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:CreateKey", + "payment-cryptography:TagResource" + ] + }, + "delete": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:DeleteKey" + ] + }, + "list": { + "permissions": [ + "payment-cryptography:ListKeys" + ] + }, + "read": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:ListTagsForResource", + "payment-cryptography:TagResource", + "payment-cryptography:UntagResource", + "payment-cryptography:StartKeyUsage", + "payment-cryptography:StopKeyUsage" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyIdentifier" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "Exportable": { + "type": "boolean" + }, + "KeyAttributes": { + "$ref": "#/definitions/KeyAttributes" + }, + "KeyCheckValueAlgorithm": { + "$ref": "#/definitions/KeyCheckValueAlgorithm" + }, + "KeyIdentifier": { + "maxLength": 322, + "minLength": 7, + "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$", + "type": "string" + }, + "KeyOrigin": { + "$ref": "#/definitions/KeyOrigin" + }, + "KeyState": { + "$ref": "#/definitions/KeyState" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/KeyIdentifier", + "/properties/KeyOrigin", + "/properties/KeyState" + ], + "required": [ + "Exportable", + "KeyAttributes" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "payment-cryptography:ListTagsForResource", + "payment-cryptography:TagResource", + "payment-cryptography:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PaymentCryptography::Key" +} diff --git a/schema/aws-pcaconnectorad-connector.json b/schema/aws-pcaconnectorad-connector.json index 44a27b2..866165c 100644 --- a/schema/aws-pcaconnectorad-connector.json +++ b/schema/aws-pcaconnectorad-connector.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CertificateAuthorityArn", - "/properties/DirectoryId", - "/properties/VpcInformation" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "VpcInformation": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "maxLength": 20, - "minLength": 11, - "pattern": "^(?:sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SecurityGroupIds" - ], - "type": "object" - } - }, - "description": "Definition of AWS::PCAConnectorAD::Connector Resource Type", - "handlers": { - "create": { - "permissions": [ - "acm-pca:DescribeCertificateAuthority", - "acm-pca:GetCertificateAuthorityCertificate", - "acm-pca:GetCertificate", - "acm-pca:IssueCertificate", - "ds:DescribeDirectories", - "ec2:CreateTags", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "pca-connector-ad:CreateConnector", - "pca-connector-ad:GetConnector" - ] - }, - "delete": { - "permissions": [ - "pca-connector-ad:GetConnector", - "pca-connector-ad:DeleteConnector", - "ec2:DeleteVpcEndpoints", - "ec2:DescribeVpcEndpoints" - ] - }, - "list": { - "permissions": [ - "pca-connector-ad:ListConnectors" - ] - }, - "read": { - "permissions": [ - "pca-connector-ad:ListTagsForResource", - "pca-connector-ad:GetConnector" - ] - }, - "update": { - "permissions": [ - "pca-connector-ad:ListTagsForResource", - "pca-connector-ad:TagResource", - "pca-connector-ad:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorArn" - ], - "properties": { - "CertificateAuthorityArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority(\\/[\\w-]+)$", - "type": "string" - }, - "ConnectorArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)$", - "type": "string" - }, - "DirectoryId": { - "pattern": "^d-[0-9a-f]{10}$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "VpcInformation": { - "$ref": "#/definitions/VpcInformation" - } - }, - "readOnlyProperties": [ - "/properties/ConnectorArn" - ], - "required": [ - "CertificateAuthorityArn", - "DirectoryId", - "VpcInformation" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::PCAConnectorAD::Connector", - "writeOnlyProperties": [ - "/properties/CertificateAuthorityArn", - "/properties/DirectoryId", - "/properties/Tags", - "/properties/VpcInformation" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateAuthorityArn", + "/properties/DirectoryId", + "/properties/VpcInformation" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "VpcInformation": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "maxLength": 20, + "minLength": 11, + "pattern": "^(?:sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SecurityGroupIds" + ], + "type": "object" + } + }, + "description": "Definition of AWS::PCAConnectorAD::Connector Resource Type", + "handlers": { + "create": { + "permissions": [ + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificateAuthorityCertificate", + "acm-pca:GetCertificate", + "acm-pca:IssueCertificate", + "ds:DescribeDirectories", + "ec2:CreateTags", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "pca-connector-ad:CreateConnector", + "pca-connector-ad:GetConnector" + ] + }, + "delete": { + "permissions": [ + "pca-connector-ad:GetConnector", + "pca-connector-ad:DeleteConnector", + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints" + ] + }, + "list": { + "permissions": [ + "pca-connector-ad:ListConnectors" + ] + }, + "read": { + "permissions": [ + "pca-connector-ad:ListTagsForResource", + "pca-connector-ad:GetConnector" + ] + }, + "update": { + "permissions": [ + "pca-connector-ad:ListTagsForResource", + "pca-connector-ad:TagResource", + "pca-connector-ad:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorArn" + ], + "properties": { + "CertificateAuthorityArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority(\\/[\\w-]+)$", + "type": "string" + }, + "ConnectorArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)$", + "type": "string" + }, + "DirectoryId": { + "pattern": "^d-[0-9a-f]{10}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "VpcInformation": { + "$ref": "#/definitions/VpcInformation" + } + }, + "readOnlyProperties": [ + "/properties/ConnectorArn" + ], + "required": [ + "CertificateAuthorityArn", + "DirectoryId", + "VpcInformation" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PCAConnectorAD::Connector", + "writeOnlyProperties": [ + "/properties/CertificateAuthorityArn", + "/properties/DirectoryId", + "/properties/Tags", + "/properties/VpcInformation" + ] +} diff --git a/schema/aws-pcaconnectorad-directoryregistration.json b/schema/aws-pcaconnectorad-directoryregistration.json index 6161b48..173bee9 100644 --- a/schema/aws-pcaconnectorad-directoryregistration.json +++ b/schema/aws-pcaconnectorad-directoryregistration.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DirectoryId" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type", - "handlers": { - "create": { - "permissions": [ - "pca-connector-ad:GetDirectoryRegistration", - "pca-connector-ad:CreateDirectoryRegistration", - "ds:AuthorizeApplication", - "ds:DescribeDirectories" - ] - }, - "delete": { - "permissions": [ - "pca-connector-ad:GetDirectoryRegistration", - "pca-connector-ad:DeleteDirectoryRegistration", - "ds:DescribeDirectories", - "ds:UnauthorizeApplication", - "ds:UpdateAuthorizedApplication" - ] - }, - "list": { - "permissions": [ - "pca-connector-ad:ListDirectoryRegistrations" - ] - }, - "read": { - "permissions": [ - "pca-connector-ad:ListTagsForResource", - "pca-connector-ad:GetDirectoryRegistration" - ] - }, - "update": { - "permissions": [ - "pca-connector-ad:ListTagsForResource", - "pca-connector-ad:TagResource", - "pca-connector-ad:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DirectoryRegistrationArn" - ], - "properties": { - "DirectoryId": { - "pattern": "^d-[0-9a-f]{10}$", - "type": "string" - }, - "DirectoryRegistrationArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration(\\/[\\w-]+)$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/DirectoryRegistrationArn" - ], - "required": [ - "DirectoryId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::PCAConnectorAD::DirectoryRegistration", - "writeOnlyProperties": [ - "/properties/DirectoryId", - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DirectoryId" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type", + "handlers": { + "create": { + "permissions": [ + "pca-connector-ad:GetDirectoryRegistration", + "pca-connector-ad:CreateDirectoryRegistration", + "ds:AuthorizeApplication", + "ds:DescribeDirectories" + ] + }, + "delete": { + "permissions": [ + "pca-connector-ad:GetDirectoryRegistration", + "pca-connector-ad:DeleteDirectoryRegistration", + "ds:DescribeDirectories", + "ds:UnauthorizeApplication", + "ds:UpdateAuthorizedApplication" + ] + }, + "list": { + "permissions": [ + "pca-connector-ad:ListDirectoryRegistrations" + ] + }, + "read": { + "permissions": [ + "pca-connector-ad:ListTagsForResource", + "pca-connector-ad:GetDirectoryRegistration" + ] + }, + "update": { + "permissions": [ + "pca-connector-ad:ListTagsForResource", + "pca-connector-ad:TagResource", + "pca-connector-ad:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DirectoryRegistrationArn" + ], + "properties": { + "DirectoryId": { + "pattern": "^d-[0-9a-f]{10}$", + "type": "string" + }, + "DirectoryRegistrationArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration(\\/[\\w-]+)$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/DirectoryRegistrationArn" + ], + "required": [ + "DirectoryId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PCAConnectorAD::DirectoryRegistration", + "writeOnlyProperties": [ + "/properties/DirectoryId", + "/properties/Tags" + ] +} diff --git a/schema/aws-pcaconnectorad-serviceprincipalname.json b/schema/aws-pcaconnectorad-serviceprincipalname.json index 8ea9757..1963eea 100644 --- a/schema/aws-pcaconnectorad-serviceprincipalname.json +++ b/schema/aws-pcaconnectorad-serviceprincipalname.json @@ -1,70 +1,70 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorArn", - "/properties/DirectoryRegistrationArn" - ], - "description": "Definition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type", - "handlers": { - "create": { - "permissions": [ - "ds:UpdateAuthorizedApplication", - "pca-connector-ad:GetServicePrincipalName", - "pca-connector-ad:CreateServicePrincipalName" - ] - }, - "delete": { - "permissions": [ - "ds:UpdateAuthorizedApplication", - "pca-connector-ad:GetServicePrincipalName", - "pca-connector-ad:DeleteServicePrincipalName" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "DirectoryRegistrationArn": { - "$ref": "resource-schema.json#/properties/DirectoryRegistrationArn" - } - }, - "required": [ - "DirectoryRegistrationArn" - ] - }, - "permissions": [ - "pca-connector-ad:ListServicePrincipalNames" - ] - }, - "read": { - "permissions": [ - "pca-connector-ad:GetServicePrincipalName" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorArn", - "/properties/DirectoryRegistrationArn" - ], - "properties": { - "ConnectorArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)$", - "type": "string" - }, - "DirectoryRegistrationArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration(\\/[\\w-]+)$", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::PCAConnectorAD::ServicePrincipalName" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorArn", + "/properties/DirectoryRegistrationArn" + ], + "description": "Definition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type", + "handlers": { + "create": { + "permissions": [ + "ds:UpdateAuthorizedApplication", + "pca-connector-ad:GetServicePrincipalName", + "pca-connector-ad:CreateServicePrincipalName" + ] + }, + "delete": { + "permissions": [ + "ds:UpdateAuthorizedApplication", + "pca-connector-ad:GetServicePrincipalName", + "pca-connector-ad:DeleteServicePrincipalName" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DirectoryRegistrationArn": { + "$ref": "resource-schema.json#/properties/DirectoryRegistrationArn" + } + }, + "required": [ + "DirectoryRegistrationArn" + ] + }, + "permissions": [ + "pca-connector-ad:ListServicePrincipalNames" + ] + }, + "read": { + "permissions": [ + "pca-connector-ad:GetServicePrincipalName" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorArn", + "/properties/DirectoryRegistrationArn" + ], + "properties": { + "ConnectorArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)$", + "type": "string" + }, + "DirectoryRegistrationArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration(\\/[\\w-]+)$", + "type": "string" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::PCAConnectorAD::ServicePrincipalName" +} diff --git a/schema/aws-pcaconnectorad-template.json b/schema/aws-pcaconnectorad-template.json index c701a75..1bb5cf5 100644 --- a/schema/aws-pcaconnectorad-template.json +++ b/schema/aws-pcaconnectorad-template.json @@ -1,1037 +1,1037 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectorArn", - "/properties/Name" - ], - "definitions": { - "ApplicationPolicies": { - "additionalProperties": false, - "properties": { - "Critical": { - "type": "boolean" - }, - "Policies": { - "items": { - "$ref": "#/definitions/ApplicationPolicy" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Policies" - ], - "type": "object" - }, - "ApplicationPolicy": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "PolicyType": { - "$ref": "#/definitions/ApplicationPolicyType" - } - }, - "required": [ - "PolicyType" - ], - "title": "PolicyType", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "PolicyObjectIdentifier": { - "maxLength": 64, - "minLength": 1, - "pattern": "^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$", - "type": "string" - } - }, - "required": [ - "PolicyObjectIdentifier" - ], - "title": "PolicyObjectIdentifier", - "type": "object" - } - ] - }, - "ApplicationPolicyType": { - "enum": [ - "ALL_APPLICATION_POLICIES", - "ANY_PURPOSE", - "ATTESTATION_IDENTITY_KEY_CERTIFICATE", - "CERTIFICATE_REQUEST_AGENT", - "CLIENT_AUTHENTICATION", - "CODE_SIGNING", - "CTL_USAGE", - "DIGITAL_RIGHTS", - "DIRECTORY_SERVICE_EMAIL_REPLICATION", - "DISALLOWED_LIST", - "DNS_SERVER_TRUST", - "DOCUMENT_ENCRYPTION", - "DOCUMENT_SIGNING", - "DYNAMIC_CODE_GENERATOR", - "EARLY_LAUNCH_ANTIMALWARE_DRIVER", - "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", - "ENCLAVE", - "ENCRYPTING_FILE_SYSTEM", - "ENDORSEMENT_KEY_CERTIFICATE", - "FILE_RECOVERY", - "HAL_EXTENSION", - "IP_SECURITY_END_SYSTEM", - "IP_SECURITY_IKE_INTERMEDIATE", - "IP_SECURITY_TUNNEL_TERMINATION", - "IP_SECURITY_USER", - "ISOLATED_USER_MODE", - "KDC_AUTHENTICATION", - "KERNEL_MODE_CODE_SIGNING", - "KEY_PACK_LICENSES", - "KEY_RECOVERY", - "KEY_RECOVERY_AGENT", - "LICENSE_SERVER_VERIFICATION", - "LIFETIME_SIGNING", - "MICROSOFT_PUBLISHER", - "MICROSOFT_TIME_STAMPING", - "MICROSOFT_TRUST_LIST_SIGNING", - "OCSP_SIGNING", - "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", - "PLATFORM_CERTIFICATE", - "PREVIEW_BUILD_SIGNING", - "PRIVATE_KEY_ARCHIVAL", - "PROTECTED_PROCESS_LIGHT_VERIFICATION", - "PROTECTED_PROCESS_VERIFICATION", - "QUALIFIED_SUBORDINATION", - "REVOKED_LIST_SIGNER", - "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", - "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", - "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", - "ROOT_LIST_SIGNER", - "SECURE_EMAIL", - "SERVER_AUTHENTICATION", - "SMART_CARD_LOGIN", - "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", - "SPC_RELAXED_PE_MARKER_CHECK", - "TIME_STAMPING", - "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", - "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", - "WINDOWS_HARDWARE_DRIVER_VERIFICATION", - "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", - "WINDOWS_KITS_COMPONENT", - "WINDOWS_RT_VERIFICATION", - "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", - "WINDOWS_STORE", - "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", - "WINDOWS_TCB_COMPONENT", - "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", - "WINDOWS_UPDATE" - ], - "type": "string" - }, - "CertificateValidity": { - "additionalProperties": false, - "properties": { - "RenewalPeriod": { - "$ref": "#/definitions/ValidityPeriod" - }, - "ValidityPeriod": { - "$ref": "#/definitions/ValidityPeriod" - } - }, - "required": [ - "RenewalPeriod", - "ValidityPeriod" - ], - "type": "object" - }, - "ClientCompatibilityV2": { - "enum": [ - "WINDOWS_SERVER_2003", - "WINDOWS_SERVER_2008", - "WINDOWS_SERVER_2008_R2", - "WINDOWS_SERVER_2012", - "WINDOWS_SERVER_2012_R2", - "WINDOWS_SERVER_2016" - ], - "type": "string" - }, - "ClientCompatibilityV3": { - "enum": [ - "WINDOWS_SERVER_2008", - "WINDOWS_SERVER_2008_R2", - "WINDOWS_SERVER_2012", - "WINDOWS_SERVER_2012_R2", - "WINDOWS_SERVER_2016" - ], - "type": "string" - }, - "ClientCompatibilityV4": { - "enum": [ - "WINDOWS_SERVER_2012", - "WINDOWS_SERVER_2012_R2", - "WINDOWS_SERVER_2016" - ], - "type": "string" - }, - "EnrollmentFlagsV2": { - "additionalProperties": false, - "properties": { - "EnableKeyReuseOnNtTokenKeysetStorageFull": { - "type": "boolean" - }, - "IncludeSymmetricAlgorithms": { - "type": "boolean" - }, - "NoSecurityExtension": { - "type": "boolean" - }, - "RemoveInvalidCertificateFromPersonalStore": { - "type": "boolean" - }, - "UserInteractionRequired": { - "type": "boolean" - } - }, - "type": "object" - }, - "EnrollmentFlagsV3": { - "additionalProperties": false, - "properties": { - "EnableKeyReuseOnNtTokenKeysetStorageFull": { - "type": "boolean" - }, - "IncludeSymmetricAlgorithms": { - "type": "boolean" - }, - "NoSecurityExtension": { - "type": "boolean" - }, - "RemoveInvalidCertificateFromPersonalStore": { - "type": "boolean" - }, - "UserInteractionRequired": { - "type": "boolean" - } - }, - "type": "object" - }, - "EnrollmentFlagsV4": { - "additionalProperties": false, - "properties": { - "EnableKeyReuseOnNtTokenKeysetStorageFull": { - "type": "boolean" - }, - "IncludeSymmetricAlgorithms": { - "type": "boolean" - }, - "NoSecurityExtension": { - "type": "boolean" - }, - "RemoveInvalidCertificateFromPersonalStore": { - "type": "boolean" - }, - "UserInteractionRequired": { - "type": "boolean" - } - }, - "type": "object" - }, - "ExtensionsV2": { - "additionalProperties": false, - "properties": { - "ApplicationPolicies": { - "$ref": "#/definitions/ApplicationPolicies" - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - } - }, - "required": [ - "KeyUsage" - ], - "type": "object" - }, - "ExtensionsV3": { - "additionalProperties": false, - "properties": { - "ApplicationPolicies": { - "$ref": "#/definitions/ApplicationPolicies" - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - } - }, - "required": [ - "KeyUsage" - ], - "type": "object" - }, - "ExtensionsV4": { - "additionalProperties": false, - "properties": { - "ApplicationPolicies": { - "$ref": "#/definitions/ApplicationPolicies" - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - } - }, - "required": [ - "KeyUsage" - ], - "type": "object" - }, - "GeneralFlagsV2": { - "additionalProperties": false, - "properties": { - "AutoEnrollment": { - "type": "boolean" - }, - "MachineType": { - "type": "boolean" - } - }, - "type": "object" - }, - "GeneralFlagsV3": { - "additionalProperties": false, - "properties": { - "AutoEnrollment": { - "type": "boolean" - }, - "MachineType": { - "type": "boolean" - } - }, - "type": "object" - }, - "GeneralFlagsV4": { - "additionalProperties": false, - "properties": { - "AutoEnrollment": { - "type": "boolean" - }, - "MachineType": { - "type": "boolean" - } - }, - "type": "object" - }, - "HashAlgorithm": { - "enum": [ - "SHA256", - "SHA384", - "SHA512" - ], - "type": "string" - }, - "KeySpec": { - "enum": [ - "KEY_EXCHANGE", - "SIGNATURE" - ], - "type": "string" - }, - "KeyUsage": { - "additionalProperties": false, - "properties": { - "Critical": { - "type": "boolean" - }, - "UsageFlags": { - "$ref": "#/definitions/KeyUsageFlags" - } - }, - "required": [ - "UsageFlags" - ], - "type": "object" - }, - "KeyUsageFlags": { - "additionalProperties": false, - "properties": { - "DataEncipherment": { - "type": "boolean" - }, - "DigitalSignature": { - "type": "boolean" - }, - "KeyAgreement": { - "type": "boolean" - }, - "KeyEncipherment": { - "type": "boolean" - }, - "NonRepudiation": { - "type": "boolean" - } - }, - "type": "object" - }, - "KeyUsageProperty": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "PropertyType": { - "$ref": "#/definitions/KeyUsagePropertyType" - } - }, - "required": [ - "PropertyType" - ], - "title": "PropertyType", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "PropertyFlags": { - "$ref": "#/definitions/KeyUsagePropertyFlags" - } - }, - "required": [ - "PropertyFlags" - ], - "title": "PropertyFlags", - "type": "object" - } - ] - }, - "KeyUsagePropertyFlags": { - "additionalProperties": false, - "properties": { - "Decrypt": { - "type": "boolean" - }, - "KeyAgreement": { - "type": "boolean" - }, - "Sign": { - "type": "boolean" - } - }, - "type": "object" - }, - "KeyUsagePropertyType": { - "enum": [ - "ALL" - ], - "type": "string" - }, - "PrivateKeyAlgorithm": { - "enum": [ - "RSA", - "ECDH_P256", - "ECDH_P384", - "ECDH_P521" - ], - "type": "string" - }, - "PrivateKeyAttributesV2": { - "additionalProperties": false, - "properties": { - "CryptoProviders": { - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "KeySpec": { - "$ref": "#/definitions/KeySpec" - }, - "MinimalKeyLength": { - "minimum": 1, - "type": "number" - } - }, - "required": [ - "KeySpec", - "MinimalKeyLength" - ], - "type": "object" - }, - "PrivateKeyAttributesV3": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "$ref": "#/definitions/PrivateKeyAlgorithm" - }, - "CryptoProviders": { - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "KeySpec": { - "$ref": "#/definitions/KeySpec" - }, - "KeyUsageProperty": { - "$ref": "#/definitions/KeyUsageProperty" - }, - "MinimalKeyLength": { - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Algorithm", - "KeySpec", - "KeyUsageProperty", - "MinimalKeyLength" - ], - "type": "object" - }, - "PrivateKeyAttributesV4": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "$ref": "#/definitions/PrivateKeyAlgorithm" - }, - "CryptoProviders": { - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "KeySpec": { - "$ref": "#/definitions/KeySpec" - }, - "KeyUsageProperty": { - "$ref": "#/definitions/KeyUsageProperty" - }, - "MinimalKeyLength": { - "minimum": 1, - "type": "number" - } - }, - "required": [ - "KeySpec", - "MinimalKeyLength" - ], - "type": "object" - }, - "PrivateKeyFlagsV2": { - "additionalProperties": false, - "properties": { - "ClientVersion": { - "$ref": "#/definitions/ClientCompatibilityV2" - }, - "ExportableKey": { - "type": "boolean" - }, - "StrongKeyProtectionRequired": { - "type": "boolean" - } - }, - "required": [ - "ClientVersion" - ], - "type": "object" - }, - "PrivateKeyFlagsV3": { - "additionalProperties": false, - "properties": { - "ClientVersion": { - "$ref": "#/definitions/ClientCompatibilityV3" - }, - "ExportableKey": { - "type": "boolean" - }, - "RequireAlternateSignatureAlgorithm": { - "type": "boolean" - }, - "StrongKeyProtectionRequired": { - "type": "boolean" - } - }, - "required": [ - "ClientVersion" - ], - "type": "object" - }, - "PrivateKeyFlagsV4": { - "additionalProperties": false, - "properties": { - "ClientVersion": { - "$ref": "#/definitions/ClientCompatibilityV4" - }, - "ExportableKey": { - "type": "boolean" - }, - "RequireAlternateSignatureAlgorithm": { - "type": "boolean" - }, - "RequireSameKeyRenewal": { - "type": "boolean" - }, - "StrongKeyProtectionRequired": { - "type": "boolean" - }, - "UseLegacyProvider": { - "type": "boolean" - } - }, - "required": [ - "ClientVersion" - ], - "type": "object" - }, - "SubjectNameFlagsV2": { - "additionalProperties": false, - "properties": { - "RequireCommonName": { - "type": "boolean" - }, - "RequireDirectoryPath": { - "type": "boolean" - }, - "RequireDnsAsCn": { - "type": "boolean" - }, - "RequireEmail": { - "type": "boolean" - }, - "SanRequireDirectoryGuid": { - "type": "boolean" - }, - "SanRequireDns": { - "type": "boolean" - }, - "SanRequireDomainDns": { - "type": "boolean" - }, - "SanRequireEmail": { - "type": "boolean" - }, - "SanRequireSpn": { - "type": "boolean" - }, - "SanRequireUpn": { - "type": "boolean" - } - }, - "type": "object" - }, - "SubjectNameFlagsV3": { - "additionalProperties": false, - "properties": { - "RequireCommonName": { - "type": "boolean" - }, - "RequireDirectoryPath": { - "type": "boolean" - }, - "RequireDnsAsCn": { - "type": "boolean" - }, - "RequireEmail": { - "type": "boolean" - }, - "SanRequireDirectoryGuid": { - "type": "boolean" - }, - "SanRequireDns": { - "type": "boolean" - }, - "SanRequireDomainDns": { - "type": "boolean" - }, - "SanRequireEmail": { - "type": "boolean" - }, - "SanRequireSpn": { - "type": "boolean" - }, - "SanRequireUpn": { - "type": "boolean" - } - }, - "type": "object" - }, - "SubjectNameFlagsV4": { - "additionalProperties": false, - "properties": { - "RequireCommonName": { - "type": "boolean" - }, - "RequireDirectoryPath": { - "type": "boolean" - }, - "RequireDnsAsCn": { - "type": "boolean" - }, - "RequireEmail": { - "type": "boolean" - }, - "SanRequireDirectoryGuid": { - "type": "boolean" - }, - "SanRequireDns": { - "type": "boolean" - }, - "SanRequireDomainDns": { - "type": "boolean" - }, - "SanRequireEmail": { - "type": "boolean" - }, - "SanRequireSpn": { - "type": "boolean" - }, - "SanRequireUpn": { - "type": "boolean" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "TemplateDefinition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "TemplateV2": { - "$ref": "#/definitions/TemplateV2" - } - }, - "required": [ - "TemplateV2" - ], - "title": "TemplateV2", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TemplateV3": { - "$ref": "#/definitions/TemplateV3" - } - }, - "required": [ - "TemplateV3" - ], - "title": "TemplateV3", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TemplateV4": { - "$ref": "#/definitions/TemplateV4" - } - }, - "required": [ - "TemplateV4" - ], - "title": "TemplateV4", - "type": "object" - } - ] - }, - "TemplateV2": { - "additionalProperties": false, - "properties": { - "CertificateValidity": { - "$ref": "#/definitions/CertificateValidity" - }, - "EnrollmentFlags": { - "$ref": "#/definitions/EnrollmentFlagsV2" - }, - "Extensions": { - "$ref": "#/definitions/ExtensionsV2" - }, - "GeneralFlags": { - "$ref": "#/definitions/GeneralFlagsV2" - }, - "PrivateKeyAttributes": { - "$ref": "#/definitions/PrivateKeyAttributesV2" - }, - "PrivateKeyFlags": { - "$ref": "#/definitions/PrivateKeyFlagsV2" - }, - "SubjectNameFlags": { - "$ref": "#/definitions/SubjectNameFlagsV2" - }, - "SupersededTemplates": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "CertificateValidity", - "EnrollmentFlags", - "Extensions", - "GeneralFlags", - "PrivateKeyAttributes", - "PrivateKeyFlags", - "SubjectNameFlags" - ], - "type": "object" - }, - "TemplateV3": { - "additionalProperties": false, - "properties": { - "CertificateValidity": { - "$ref": "#/definitions/CertificateValidity" - }, - "EnrollmentFlags": { - "$ref": "#/definitions/EnrollmentFlagsV3" - }, - "Extensions": { - "$ref": "#/definitions/ExtensionsV3" - }, - "GeneralFlags": { - "$ref": "#/definitions/GeneralFlagsV3" - }, - "HashAlgorithm": { - "$ref": "#/definitions/HashAlgorithm" - }, - "PrivateKeyAttributes": { - "$ref": "#/definitions/PrivateKeyAttributesV3" - }, - "PrivateKeyFlags": { - "$ref": "#/definitions/PrivateKeyFlagsV3" - }, - "SubjectNameFlags": { - "$ref": "#/definitions/SubjectNameFlagsV3" - }, - "SupersededTemplates": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "CertificateValidity", - "EnrollmentFlags", - "Extensions", - "GeneralFlags", - "HashAlgorithm", - "PrivateKeyAttributes", - "PrivateKeyFlags", - "SubjectNameFlags" - ], - "type": "object" - }, - "TemplateV4": { - "additionalProperties": false, - "properties": { - "CertificateValidity": { - "$ref": "#/definitions/CertificateValidity" - }, - "EnrollmentFlags": { - "$ref": "#/definitions/EnrollmentFlagsV4" - }, - "Extensions": { - "$ref": "#/definitions/ExtensionsV4" - }, - "GeneralFlags": { - "$ref": "#/definitions/GeneralFlagsV4" - }, - "HashAlgorithm": { - "$ref": "#/definitions/HashAlgorithm" - }, - "PrivateKeyAttributes": { - "$ref": "#/definitions/PrivateKeyAttributesV4" - }, - "PrivateKeyFlags": { - "$ref": "#/definitions/PrivateKeyFlagsV4" - }, - "SubjectNameFlags": { - "$ref": "#/definitions/SubjectNameFlagsV4" - }, - "SupersededTemplates": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "CertificateValidity", - "EnrollmentFlags", - "Extensions", - "GeneralFlags", - "PrivateKeyAttributes", - "PrivateKeyFlags", - "SubjectNameFlags" - ], - "type": "object" - }, - "ValidityPeriod": { - "additionalProperties": false, - "properties": { - "Period": { - "maximum": 8766000, - "minimum": 1, - "type": "number" - }, - "PeriodType": { - "$ref": "#/definitions/ValidityPeriodType" - } - }, - "required": [ - "Period", - "PeriodType" - ], - "type": "object" - }, - "ValidityPeriodType": { - "enum": [ - "HOURS", - "DAYS", - "WEEKS", - "MONTHS", - "YEARS" - ], - "type": "string" - } - }, - "description": "Represents a template that defines certificate configurations, both for issuance and client handling", - "handlers": { - "create": { - "permissions": [ - "pca-connector-ad:CreateTemplate" - ] - }, - "delete": { - "permissions": [ - "pca-connector-ad:GetTemplate", - "pca-connector-ad:DeleteTemplate" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ConnectorArn": { - "$ref": "resource-schema.json#/properties/ConnectorArn" - } - }, - "required": [ - "ConnectorArn" - ] - }, - "permissions": [ - "pca-connector-ad:ListTemplates" - ] - }, - "read": { - "permissions": [ - "pca-connector-ad:GetTemplate", - "pca-connector-ad:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "pca-connector-ad:ListTagsForResource", - "pca-connector-ad:TagResource", - "pca-connector-ad:UntagResource", - "pca-connector-ad:UpdateTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/TemplateArn" - ], - "properties": { - "ConnectorArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/TemplateDefinition" - }, - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", - "type": "string" - }, - "ReenrollAllCertificateHolders": { - "type": "boolean" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "TemplateArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\\/template\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TemplateArn" - ], - "required": [ - "ConnectorArn", - "Definition", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::PCAConnectorAD::Template", - "writeOnlyProperties": [ - "/properties/ConnectorArn", - "/properties/Definition", - "/properties/Name", - "/properties/ReenrollAllCertificateHolders", - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorArn", + "/properties/Name" + ], + "definitions": { + "ApplicationPolicies": { + "additionalProperties": false, + "properties": { + "Critical": { + "type": "boolean" + }, + "Policies": { + "items": { + "$ref": "#/definitions/ApplicationPolicy" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Policies" + ], + "type": "object" + }, + "ApplicationPolicy": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "PolicyType": { + "$ref": "#/definitions/ApplicationPolicyType" + } + }, + "required": [ + "PolicyType" + ], + "title": "PolicyType", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "PolicyObjectIdentifier": { + "maxLength": 64, + "minLength": 1, + "pattern": "^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$", + "type": "string" + } + }, + "required": [ + "PolicyObjectIdentifier" + ], + "title": "PolicyObjectIdentifier", + "type": "object" + } + ] + }, + "ApplicationPolicyType": { + "enum": [ + "ALL_APPLICATION_POLICIES", + "ANY_PURPOSE", + "ATTESTATION_IDENTITY_KEY_CERTIFICATE", + "CERTIFICATE_REQUEST_AGENT", + "CLIENT_AUTHENTICATION", + "CODE_SIGNING", + "CTL_USAGE", + "DIGITAL_RIGHTS", + "DIRECTORY_SERVICE_EMAIL_REPLICATION", + "DISALLOWED_LIST", + "DNS_SERVER_TRUST", + "DOCUMENT_ENCRYPTION", + "DOCUMENT_SIGNING", + "DYNAMIC_CODE_GENERATOR", + "EARLY_LAUNCH_ANTIMALWARE_DRIVER", + "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", + "ENCLAVE", + "ENCRYPTING_FILE_SYSTEM", + "ENDORSEMENT_KEY_CERTIFICATE", + "FILE_RECOVERY", + "HAL_EXTENSION", + "IP_SECURITY_END_SYSTEM", + "IP_SECURITY_IKE_INTERMEDIATE", + "IP_SECURITY_TUNNEL_TERMINATION", + "IP_SECURITY_USER", + "ISOLATED_USER_MODE", + "KDC_AUTHENTICATION", + "KERNEL_MODE_CODE_SIGNING", + "KEY_PACK_LICENSES", + "KEY_RECOVERY", + "KEY_RECOVERY_AGENT", + "LICENSE_SERVER_VERIFICATION", + "LIFETIME_SIGNING", + "MICROSOFT_PUBLISHER", + "MICROSOFT_TIME_STAMPING", + "MICROSOFT_TRUST_LIST_SIGNING", + "OCSP_SIGNING", + "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", + "PLATFORM_CERTIFICATE", + "PREVIEW_BUILD_SIGNING", + "PRIVATE_KEY_ARCHIVAL", + "PROTECTED_PROCESS_LIGHT_VERIFICATION", + "PROTECTED_PROCESS_VERIFICATION", + "QUALIFIED_SUBORDINATION", + "REVOKED_LIST_SIGNER", + "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", + "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", + "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", + "ROOT_LIST_SIGNER", + "SECURE_EMAIL", + "SERVER_AUTHENTICATION", + "SMART_CARD_LOGIN", + "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", + "SPC_RELAXED_PE_MARKER_CHECK", + "TIME_STAMPING", + "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", + "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", + "WINDOWS_HARDWARE_DRIVER_VERIFICATION", + "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", + "WINDOWS_KITS_COMPONENT", + "WINDOWS_RT_VERIFICATION", + "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", + "WINDOWS_STORE", + "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", + "WINDOWS_TCB_COMPONENT", + "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", + "WINDOWS_UPDATE" + ], + "type": "string" + }, + "CertificateValidity": { + "additionalProperties": false, + "properties": { + "RenewalPeriod": { + "$ref": "#/definitions/ValidityPeriod" + }, + "ValidityPeriod": { + "$ref": "#/definitions/ValidityPeriod" + } + }, + "required": [ + "RenewalPeriod", + "ValidityPeriod" + ], + "type": "object" + }, + "ClientCompatibilityV2": { + "enum": [ + "WINDOWS_SERVER_2003", + "WINDOWS_SERVER_2008", + "WINDOWS_SERVER_2008_R2", + "WINDOWS_SERVER_2012", + "WINDOWS_SERVER_2012_R2", + "WINDOWS_SERVER_2016" + ], + "type": "string" + }, + "ClientCompatibilityV3": { + "enum": [ + "WINDOWS_SERVER_2008", + "WINDOWS_SERVER_2008_R2", + "WINDOWS_SERVER_2012", + "WINDOWS_SERVER_2012_R2", + "WINDOWS_SERVER_2016" + ], + "type": "string" + }, + "ClientCompatibilityV4": { + "enum": [ + "WINDOWS_SERVER_2012", + "WINDOWS_SERVER_2012_R2", + "WINDOWS_SERVER_2016" + ], + "type": "string" + }, + "EnrollmentFlagsV2": { + "additionalProperties": false, + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": "boolean" + }, + "IncludeSymmetricAlgorithms": { + "type": "boolean" + }, + "NoSecurityExtension": { + "type": "boolean" + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": "boolean" + }, + "UserInteractionRequired": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnrollmentFlagsV3": { + "additionalProperties": false, + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": "boolean" + }, + "IncludeSymmetricAlgorithms": { + "type": "boolean" + }, + "NoSecurityExtension": { + "type": "boolean" + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": "boolean" + }, + "UserInteractionRequired": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnrollmentFlagsV4": { + "additionalProperties": false, + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": "boolean" + }, + "IncludeSymmetricAlgorithms": { + "type": "boolean" + }, + "NoSecurityExtension": { + "type": "boolean" + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": "boolean" + }, + "UserInteractionRequired": { + "type": "boolean" + } + }, + "type": "object" + }, + "ExtensionsV2": { + "additionalProperties": false, + "properties": { + "ApplicationPolicies": { + "$ref": "#/definitions/ApplicationPolicies" + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + } + }, + "required": [ + "KeyUsage" + ], + "type": "object" + }, + "ExtensionsV3": { + "additionalProperties": false, + "properties": { + "ApplicationPolicies": { + "$ref": "#/definitions/ApplicationPolicies" + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + } + }, + "required": [ + "KeyUsage" + ], + "type": "object" + }, + "ExtensionsV4": { + "additionalProperties": false, + "properties": { + "ApplicationPolicies": { + "$ref": "#/definitions/ApplicationPolicies" + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + } + }, + "required": [ + "KeyUsage" + ], + "type": "object" + }, + "GeneralFlagsV2": { + "additionalProperties": false, + "properties": { + "AutoEnrollment": { + "type": "boolean" + }, + "MachineType": { + "type": "boolean" + } + }, + "type": "object" + }, + "GeneralFlagsV3": { + "additionalProperties": false, + "properties": { + "AutoEnrollment": { + "type": "boolean" + }, + "MachineType": { + "type": "boolean" + } + }, + "type": "object" + }, + "GeneralFlagsV4": { + "additionalProperties": false, + "properties": { + "AutoEnrollment": { + "type": "boolean" + }, + "MachineType": { + "type": "boolean" + } + }, + "type": "object" + }, + "HashAlgorithm": { + "enum": [ + "SHA256", + "SHA384", + "SHA512" + ], + "type": "string" + }, + "KeySpec": { + "enum": [ + "KEY_EXCHANGE", + "SIGNATURE" + ], + "type": "string" + }, + "KeyUsage": { + "additionalProperties": false, + "properties": { + "Critical": { + "type": "boolean" + }, + "UsageFlags": { + "$ref": "#/definitions/KeyUsageFlags" + } + }, + "required": [ + "UsageFlags" + ], + "type": "object" + }, + "KeyUsageFlags": { + "additionalProperties": false, + "properties": { + "DataEncipherment": { + "type": "boolean" + }, + "DigitalSignature": { + "type": "boolean" + }, + "KeyAgreement": { + "type": "boolean" + }, + "KeyEncipherment": { + "type": "boolean" + }, + "NonRepudiation": { + "type": "boolean" + } + }, + "type": "object" + }, + "KeyUsageProperty": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "PropertyType": { + "$ref": "#/definitions/KeyUsagePropertyType" + } + }, + "required": [ + "PropertyType" + ], + "title": "PropertyType", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "PropertyFlags": { + "$ref": "#/definitions/KeyUsagePropertyFlags" + } + }, + "required": [ + "PropertyFlags" + ], + "title": "PropertyFlags", + "type": "object" + } + ] + }, + "KeyUsagePropertyFlags": { + "additionalProperties": false, + "properties": { + "Decrypt": { + "type": "boolean" + }, + "KeyAgreement": { + "type": "boolean" + }, + "Sign": { + "type": "boolean" + } + }, + "type": "object" + }, + "KeyUsagePropertyType": { + "enum": [ + "ALL" + ], + "type": "string" + }, + "PrivateKeyAlgorithm": { + "enum": [ + "RSA", + "ECDH_P256", + "ECDH_P384", + "ECDH_P521" + ], + "type": "string" + }, + "PrivateKeyAttributesV2": { + "additionalProperties": false, + "properties": { + "CryptoProviders": { + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "KeySpec": { + "$ref": "#/definitions/KeySpec" + }, + "MinimalKeyLength": { + "minimum": 1, + "type": "number" + } + }, + "required": [ + "KeySpec", + "MinimalKeyLength" + ], + "type": "object" + }, + "PrivateKeyAttributesV3": { + "additionalProperties": false, + "properties": { + "Algorithm": { + "$ref": "#/definitions/PrivateKeyAlgorithm" + }, + "CryptoProviders": { + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "KeySpec": { + "$ref": "#/definitions/KeySpec" + }, + "KeyUsageProperty": { + "$ref": "#/definitions/KeyUsageProperty" + }, + "MinimalKeyLength": { + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Algorithm", + "KeySpec", + "KeyUsageProperty", + "MinimalKeyLength" + ], + "type": "object" + }, + "PrivateKeyAttributesV4": { + "additionalProperties": false, + "properties": { + "Algorithm": { + "$ref": "#/definitions/PrivateKeyAlgorithm" + }, + "CryptoProviders": { + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "KeySpec": { + "$ref": "#/definitions/KeySpec" + }, + "KeyUsageProperty": { + "$ref": "#/definitions/KeyUsageProperty" + }, + "MinimalKeyLength": { + "minimum": 1, + "type": "number" + } + }, + "required": [ + "KeySpec", + "MinimalKeyLength" + ], + "type": "object" + }, + "PrivateKeyFlagsV2": { + "additionalProperties": false, + "properties": { + "ClientVersion": { + "$ref": "#/definitions/ClientCompatibilityV2" + }, + "ExportableKey": { + "type": "boolean" + }, + "StrongKeyProtectionRequired": { + "type": "boolean" + } + }, + "required": [ + "ClientVersion" + ], + "type": "object" + }, + "PrivateKeyFlagsV3": { + "additionalProperties": false, + "properties": { + "ClientVersion": { + "$ref": "#/definitions/ClientCompatibilityV3" + }, + "ExportableKey": { + "type": "boolean" + }, + "RequireAlternateSignatureAlgorithm": { + "type": "boolean" + }, + "StrongKeyProtectionRequired": { + "type": "boolean" + } + }, + "required": [ + "ClientVersion" + ], + "type": "object" + }, + "PrivateKeyFlagsV4": { + "additionalProperties": false, + "properties": { + "ClientVersion": { + "$ref": "#/definitions/ClientCompatibilityV4" + }, + "ExportableKey": { + "type": "boolean" + }, + "RequireAlternateSignatureAlgorithm": { + "type": "boolean" + }, + "RequireSameKeyRenewal": { + "type": "boolean" + }, + "StrongKeyProtectionRequired": { + "type": "boolean" + }, + "UseLegacyProvider": { + "type": "boolean" + } + }, + "required": [ + "ClientVersion" + ], + "type": "object" + }, + "SubjectNameFlagsV2": { + "additionalProperties": false, + "properties": { + "RequireCommonName": { + "type": "boolean" + }, + "RequireDirectoryPath": { + "type": "boolean" + }, + "RequireDnsAsCn": { + "type": "boolean" + }, + "RequireEmail": { + "type": "boolean" + }, + "SanRequireDirectoryGuid": { + "type": "boolean" + }, + "SanRequireDns": { + "type": "boolean" + }, + "SanRequireDomainDns": { + "type": "boolean" + }, + "SanRequireEmail": { + "type": "boolean" + }, + "SanRequireSpn": { + "type": "boolean" + }, + "SanRequireUpn": { + "type": "boolean" + } + }, + "type": "object" + }, + "SubjectNameFlagsV3": { + "additionalProperties": false, + "properties": { + "RequireCommonName": { + "type": "boolean" + }, + "RequireDirectoryPath": { + "type": "boolean" + }, + "RequireDnsAsCn": { + "type": "boolean" + }, + "RequireEmail": { + "type": "boolean" + }, + "SanRequireDirectoryGuid": { + "type": "boolean" + }, + "SanRequireDns": { + "type": "boolean" + }, + "SanRequireDomainDns": { + "type": "boolean" + }, + "SanRequireEmail": { + "type": "boolean" + }, + "SanRequireSpn": { + "type": "boolean" + }, + "SanRequireUpn": { + "type": "boolean" + } + }, + "type": "object" + }, + "SubjectNameFlagsV4": { + "additionalProperties": false, + "properties": { + "RequireCommonName": { + "type": "boolean" + }, + "RequireDirectoryPath": { + "type": "boolean" + }, + "RequireDnsAsCn": { + "type": "boolean" + }, + "RequireEmail": { + "type": "boolean" + }, + "SanRequireDirectoryGuid": { + "type": "boolean" + }, + "SanRequireDns": { + "type": "boolean" + }, + "SanRequireDomainDns": { + "type": "boolean" + }, + "SanRequireEmail": { + "type": "boolean" + }, + "SanRequireSpn": { + "type": "boolean" + }, + "SanRequireUpn": { + "type": "boolean" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "TemplateDefinition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "TemplateV2": { + "$ref": "#/definitions/TemplateV2" + } + }, + "required": [ + "TemplateV2" + ], + "title": "TemplateV2", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TemplateV3": { + "$ref": "#/definitions/TemplateV3" + } + }, + "required": [ + "TemplateV3" + ], + "title": "TemplateV3", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TemplateV4": { + "$ref": "#/definitions/TemplateV4" + } + }, + "required": [ + "TemplateV4" + ], + "title": "TemplateV4", + "type": "object" + } + ] + }, + "TemplateV2": { + "additionalProperties": false, + "properties": { + "CertificateValidity": { + "$ref": "#/definitions/CertificateValidity" + }, + "EnrollmentFlags": { + "$ref": "#/definitions/EnrollmentFlagsV2" + }, + "Extensions": { + "$ref": "#/definitions/ExtensionsV2" + }, + "GeneralFlags": { + "$ref": "#/definitions/GeneralFlagsV2" + }, + "PrivateKeyAttributes": { + "$ref": "#/definitions/PrivateKeyAttributesV2" + }, + "PrivateKeyFlags": { + "$ref": "#/definitions/PrivateKeyFlagsV2" + }, + "SubjectNameFlags": { + "$ref": "#/definitions/SubjectNameFlagsV2" + }, + "SupersededTemplates": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "CertificateValidity", + "EnrollmentFlags", + "Extensions", + "GeneralFlags", + "PrivateKeyAttributes", + "PrivateKeyFlags", + "SubjectNameFlags" + ], + "type": "object" + }, + "TemplateV3": { + "additionalProperties": false, + "properties": { + "CertificateValidity": { + "$ref": "#/definitions/CertificateValidity" + }, + "EnrollmentFlags": { + "$ref": "#/definitions/EnrollmentFlagsV3" + }, + "Extensions": { + "$ref": "#/definitions/ExtensionsV3" + }, + "GeneralFlags": { + "$ref": "#/definitions/GeneralFlagsV3" + }, + "HashAlgorithm": { + "$ref": "#/definitions/HashAlgorithm" + }, + "PrivateKeyAttributes": { + "$ref": "#/definitions/PrivateKeyAttributesV3" + }, + "PrivateKeyFlags": { + "$ref": "#/definitions/PrivateKeyFlagsV3" + }, + "SubjectNameFlags": { + "$ref": "#/definitions/SubjectNameFlagsV3" + }, + "SupersededTemplates": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "CertificateValidity", + "EnrollmentFlags", + "Extensions", + "GeneralFlags", + "HashAlgorithm", + "PrivateKeyAttributes", + "PrivateKeyFlags", + "SubjectNameFlags" + ], + "type": "object" + }, + "TemplateV4": { + "additionalProperties": false, + "properties": { + "CertificateValidity": { + "$ref": "#/definitions/CertificateValidity" + }, + "EnrollmentFlags": { + "$ref": "#/definitions/EnrollmentFlagsV4" + }, + "Extensions": { + "$ref": "#/definitions/ExtensionsV4" + }, + "GeneralFlags": { + "$ref": "#/definitions/GeneralFlagsV4" + }, + "HashAlgorithm": { + "$ref": "#/definitions/HashAlgorithm" + }, + "PrivateKeyAttributes": { + "$ref": "#/definitions/PrivateKeyAttributesV4" + }, + "PrivateKeyFlags": { + "$ref": "#/definitions/PrivateKeyFlagsV4" + }, + "SubjectNameFlags": { + "$ref": "#/definitions/SubjectNameFlagsV4" + }, + "SupersededTemplates": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "CertificateValidity", + "EnrollmentFlags", + "Extensions", + "GeneralFlags", + "PrivateKeyAttributes", + "PrivateKeyFlags", + "SubjectNameFlags" + ], + "type": "object" + }, + "ValidityPeriod": { + "additionalProperties": false, + "properties": { + "Period": { + "maximum": 8766000, + "minimum": 1, + "type": "number" + }, + "PeriodType": { + "$ref": "#/definitions/ValidityPeriodType" + } + }, + "required": [ + "Period", + "PeriodType" + ], + "type": "object" + }, + "ValidityPeriodType": { + "enum": [ + "HOURS", + "DAYS", + "WEEKS", + "MONTHS", + "YEARS" + ], + "type": "string" + } + }, + "description": "Represents a template that defines certificate configurations, both for issuance and client handling", + "handlers": { + "create": { + "permissions": [ + "pca-connector-ad:CreateTemplate" + ] + }, + "delete": { + "permissions": [ + "pca-connector-ad:GetTemplate", + "pca-connector-ad:DeleteTemplate" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ConnectorArn": { + "$ref": "resource-schema.json#/properties/ConnectorArn" + } + }, + "required": [ + "ConnectorArn" + ] + }, + "permissions": [ + "pca-connector-ad:ListTemplates" + ] + }, + "read": { + "permissions": [ + "pca-connector-ad:GetTemplate", + "pca-connector-ad:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "pca-connector-ad:ListTagsForResource", + "pca-connector-ad:TagResource", + "pca-connector-ad:UntagResource", + "pca-connector-ad:UpdateTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/TemplateArn" + ], + "properties": { + "ConnectorArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/TemplateDefinition" + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$", + "type": "string" + }, + "ReenrollAllCertificateHolders": { + "type": "boolean" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "TemplateArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\\/template\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TemplateArn" + ], + "required": [ + "ConnectorArn", + "Definition", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PCAConnectorAD::Template", + "writeOnlyProperties": [ + "/properties/ConnectorArn", + "/properties/Definition", + "/properties/Name", + "/properties/ReenrollAllCertificateHolders", + "/properties/Tags" + ] +} diff --git a/schema/aws-pcaconnectorad-templategroupaccesscontrolentry.json b/schema/aws-pcaconnectorad-templategroupaccesscontrolentry.json index 4ddf3a2..97be634 100644 --- a/schema/aws-pcaconnectorad-templategroupaccesscontrolentry.json +++ b/schema/aws-pcaconnectorad-templategroupaccesscontrolentry.json @@ -1,110 +1,110 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GroupSecurityIdentifier", - "/properties/TemplateArn" - ], - "definitions": { - "AccessRight": { - "enum": [ - "ALLOW", - "DENY" - ], - "type": "string" - }, - "AccessRights": { - "additionalProperties": false, - "properties": { - "AutoEnroll": { - "$ref": "#/definitions/AccessRight" - }, - "Enroll": { - "$ref": "#/definitions/AccessRight" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type", - "handlers": { - "create": { - "permissions": [ - "pca-connector-ad:CreateTemplateGroupAccessControlEntry" - ] - }, - "delete": { - "permissions": [ - "pca-connector-ad:DeleteTemplateGroupAccessControlEntry", - "pca-connector-ad:GetTemplateGroupAccessControlEntry" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "TemplateArn": { - "$ref": "resource-schema.json#/properties/TemplateArn" - } - }, - "required": [ - "TemplateArn" - ] - }, - "permissions": [ - "pca-connector-ad:ListTemplateGroupAccessControlEntries" - ] - }, - "read": { - "permissions": [ - "pca-connector-ad:GetTemplateGroupAccessControlEntry" - ] - }, - "update": { - "permissions": [ - "pca-connector-ad:UpdateTemplateGroupAccessControlEntry" - ] - } - }, - "primaryIdentifier": [ - "/properties/GroupSecurityIdentifier", - "/properties/TemplateArn" - ], - "properties": { - "AccessRights": { - "$ref": "#/definitions/AccessRights" - }, - "GroupDisplayName": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[\\x20-\\x7E]+$", - "type": "string" - }, - "GroupSecurityIdentifier": { - "maxLength": 256, - "minLength": 7, - "pattern": "^S-[0-9]-([0-9]+-){1,14}[0-9]+$", - "type": "string" - }, - "TemplateArn": { - "maxLength": 200, - "minLength": 5, - "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)\\/template(\\/[\\w-]+)$", - "type": "string" - } - }, - "required": [ - "AccessRights", - "GroupDisplayName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry", - "writeOnlyProperties": [ - "/properties/AccessRights", - "/properties/GroupDisplayName" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupSecurityIdentifier", + "/properties/TemplateArn" + ], + "definitions": { + "AccessRight": { + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "AccessRights": { + "additionalProperties": false, + "properties": { + "AutoEnroll": { + "$ref": "#/definitions/AccessRight" + }, + "Enroll": { + "$ref": "#/definitions/AccessRight" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type", + "handlers": { + "create": { + "permissions": [ + "pca-connector-ad:CreateTemplateGroupAccessControlEntry" + ] + }, + "delete": { + "permissions": [ + "pca-connector-ad:DeleteTemplateGroupAccessControlEntry", + "pca-connector-ad:GetTemplateGroupAccessControlEntry" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "TemplateArn": { + "$ref": "resource-schema.json#/properties/TemplateArn" + } + }, + "required": [ + "TemplateArn" + ] + }, + "permissions": [ + "pca-connector-ad:ListTemplateGroupAccessControlEntries" + ] + }, + "read": { + "permissions": [ + "pca-connector-ad:GetTemplateGroupAccessControlEntry" + ] + }, + "update": { + "permissions": [ + "pca-connector-ad:UpdateTemplateGroupAccessControlEntry" + ] + } + }, + "primaryIdentifier": [ + "/properties/GroupSecurityIdentifier", + "/properties/TemplateArn" + ], + "properties": { + "AccessRights": { + "$ref": "#/definitions/AccessRights" + }, + "GroupDisplayName": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\x20-\\x7E]+$", + "type": "string" + }, + "GroupSecurityIdentifier": { + "maxLength": 256, + "minLength": 7, + "pattern": "^S-[0-9]-([0-9]+-){1,14}[0-9]+$", + "type": "string" + }, + "TemplateArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector(\\/[\\w-]+)\\/template(\\/[\\w-]+)$", + "type": "string" + } + }, + "required": [ + "AccessRights", + "GroupDisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorad", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry", + "writeOnlyProperties": [ + "/properties/AccessRights", + "/properties/GroupDisplayName" + ] +} diff --git a/schema/aws-pcaconnectorscep-challenge.json b/schema/aws-pcaconnectorscep-challenge.json new file mode 100644 index 0000000..18e0445 --- /dev/null +++ b/schema/aws-pcaconnectorscep-challenge.json @@ -0,0 +1,105 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectorArn" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "Unit": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Represents a SCEP Challenge that is used for certificate enrollment", + "handlers": { + "create": { + "permissions": [ + "pca-connector-scep:CreateChallenge", + "pca-connector-scep:TagResource" + ] + }, + "delete": { + "permissions": [ + "pca-connector-scep:GetChallengeMetadata", + "pca-connector-scep:DeleteChallenge", + "pca-connector-scep:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ConnectorArn": { + "$ref": "resource-schema.json#/properties/ConnectorArn" + } + }, + "required": [ + "ConnectorArn" + ] + }, + "permissions": [ + "pca-connector-scep:ListChallengeMetadata" + ] + }, + "read": { + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:GetChallengeMetadata" + ] + }, + "update": { + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:TagResource", + "pca-connector-scep:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ChallengeArn" + ], + "properties": { + "ChallengeArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\\/challenge\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + }, + "ConnectorArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/ChallengeArn" + ], + "required": [ + "ConnectorArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorscep", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:TagResource", + "pca-connector-scep:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PCAConnectorSCEP::Challenge" +} diff --git a/schema/aws-pcaconnectorscep-connector.json b/schema/aws-pcaconnectorscep-connector.json new file mode 100644 index 0000000..40663da --- /dev/null +++ b/schema/aws-pcaconnectorscep-connector.json @@ -0,0 +1,183 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CertificateAuthorityArn", + "/properties/MobileDeviceManagement" + ], + "definitions": { + "ConnectorType": { + "enum": [ + "GENERAL_PURPOSE", + "INTUNE" + ], + "type": "string" + }, + "IntuneConfiguration": { + "additionalProperties": false, + "properties": { + "AzureApplicationId": { + "maxLength": 100, + "minLength": 15, + "pattern": "^[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}$", + "type": "string" + }, + "Domain": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9._-]+$", + "type": "string" + } + }, + "required": [ + "AzureApplicationId", + "Domain" + ], + "type": "object" + }, + "MobileDeviceManagement": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Intune": { + "$ref": "#/definitions/IntuneConfiguration" + } + }, + "required": [ + "Intune" + ], + "title": "Intune" + } + ], + "type": "object" + }, + "OpenIdConfiguration": { + "additionalProperties": false, + "properties": { + "Audience": { + "type": "string" + }, + "Issuer": { + "type": "string" + }, + "Subject": { + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "Unit": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Represents a Connector that allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP)", + "handlers": { + "create": { + "permissions": [ + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificate", + "acm-pca:GetCertificateAuthorityCertificate", + "acm-pca:IssueCertificate", + "pca-connector-scep:GetConnector", + "pca-connector-scep:CreateConnector", + "pca-connector-scep:TagResource" + ] + }, + "delete": { + "permissions": [ + "acm-pca:DescribeCertificateAuthority", + "acm-pca:GetCertificate", + "acm-pca:GetCertificateAuthorityCertificate", + "acm-pca:IssueCertificate", + "pca-connector-scep:GetConnector", + "pca-connector-scep:DeleteConnector", + "pca-connector-scep:UntagResource" + ] + }, + "list": { + "permissions": [ + "pca-connector-scep:ListConnectors" + ] + }, + "read": { + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:GetConnector" + ] + }, + "update": { + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:TagResource", + "pca-connector-scep:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorArn" + ], + "properties": { + "CertificateAuthorityArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:aws(-[a-z]+)*:acm-pca:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + }, + "ConnectorArn": { + "maxLength": 200, + "minLength": 5, + "pattern": "^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\\d*:\\d{12}:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", + "type": "string" + }, + "Endpoint": { + "maxLength": 200, + "minLength": 5, + "type": "string" + }, + "MobileDeviceManagement": { + "$ref": "#/definitions/MobileDeviceManagement" + }, + "OpenIdConfiguration": { + "$ref": "#/definitions/OpenIdConfiguration" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "Type": { + "$ref": "#/definitions/ConnectorType" + } + }, + "readOnlyProperties": [ + "/properties/ConnectorArn", + "/properties/Endpoint", + "/properties/OpenIdConfiguration", + "/properties/Type" + ], + "required": [ + "CertificateAuthorityArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-pcaconnectorscep", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "pca-connector-scep:ListTagsForResource", + "pca-connector-scep:TagResource", + "pca-connector-scep:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PCAConnectorSCEP::Connector" +} diff --git a/schema/aws-personalize-dataset.json b/schema/aws-personalize-dataset.json index 666c406..a53010e 100644 --- a/schema/aws-personalize-dataset.json +++ b/schema/aws-personalize-dataset.json @@ -1,150 +1,150 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/DatasetType", - "/properties/DatasetGroupArn", - "/properties/SchemaArn" - ], - "definitions": { - "DatasetImportJob": { - "additionalProperties": false, - "description": "Initial DatasetImportJob for the created dataset", - "properties": { - "DataSource": { - "additionalProperties": false, - "description": "The Amazon S3 bucket that contains the training data to import.", - "properties": { - "DataLocation": { - "description": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.", - "maxLength": 256, - "pattern": "(s3|http|https)://.+", - "type": "string" - } - }, - "type": "object" - }, - "DatasetArn": { - "description": "The ARN of the dataset that receives the imported data", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "DatasetImportJobArn": { - "description": "The ARN of the dataset import job", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "JobName": { - "description": "The name for the dataset import job.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::Personalize::Dataset.", - "handlers": { - "create": { - "permissions": [ - "personalize:CreateDataset", - "personalize:DescribeDataset", - "personalize:CreateDatasetImportJob", - "personalize:DescribeDatasetImportJob", - "iam:PassRole" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "personalize:DeleteDataset", - "personalize:DescribeDataset" - ] - }, - "list": { - "permissions": [ - "personalize:ListDatasets" - ] - }, - "read": { - "permissions": [ - "personalize:DescribeDataset" - ] - }, - "update": { - "permissions": [ - "personalize:DescribeDataset", - "personalize:CreateDatasetImportJob", - "personalize:DescribeDatasetImportJob", - "iam:PassRole" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DatasetArn" - ], - "properties": { - "DatasetArn": { - "description": "The ARN of the dataset", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "DatasetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the dataset group to add the dataset to", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "DatasetImportJob": { - "$ref": "#/definitions/DatasetImportJob" - }, - "DatasetType": { - "description": "The type of dataset", - "enum": [ - "Interactions", - "Items", - "Users" - ], - "maxLength": 256, - "type": "string" - }, - "Name": { - "description": "The name for the dataset", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "SchemaArn": { - "description": "The ARN of the schema to associate with the dataset. The schema defines the dataset fields.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DatasetArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Name", - "DatasetType", - "DatasetGroupArn", - "SchemaArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", - "taggable": false, - "typeName": "AWS::Personalize::Dataset" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/DatasetType", + "/properties/DatasetGroupArn", + "/properties/SchemaArn" + ], + "definitions": { + "DatasetImportJob": { + "additionalProperties": false, + "description": "Initial DatasetImportJob for the created dataset", + "properties": { + "DataSource": { + "additionalProperties": false, + "description": "The Amazon S3 bucket that contains the training data to import.", + "properties": { + "DataLocation": { + "description": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.", + "maxLength": 256, + "pattern": "(s3|http|https)://.+", + "type": "string" + } + }, + "type": "object" + }, + "DatasetArn": { + "description": "The ARN of the dataset that receives the imported data", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "DatasetImportJobArn": { + "description": "The ARN of the dataset import job", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "JobName": { + "description": "The name for the dataset import job.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::Personalize::Dataset.", + "handlers": { + "create": { + "permissions": [ + "personalize:CreateDataset", + "personalize:DescribeDataset", + "personalize:CreateDatasetImportJob", + "personalize:DescribeDatasetImportJob", + "iam:PassRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "personalize:DeleteDataset", + "personalize:DescribeDataset" + ] + }, + "list": { + "permissions": [ + "personalize:ListDatasets" + ] + }, + "read": { + "permissions": [ + "personalize:DescribeDataset" + ] + }, + "update": { + "permissions": [ + "personalize:DescribeDataset", + "personalize:CreateDatasetImportJob", + "personalize:DescribeDatasetImportJob", + "iam:PassRole" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DatasetArn" + ], + "properties": { + "DatasetArn": { + "description": "The ARN of the dataset", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "DatasetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the dataset group to add the dataset to", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "DatasetImportJob": { + "$ref": "#/definitions/DatasetImportJob" + }, + "DatasetType": { + "description": "The type of dataset", + "enum": [ + "Interactions", + "Items", + "Users" + ], + "maxLength": 256, + "type": "string" + }, + "Name": { + "description": "The name for the dataset", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "SchemaArn": { + "description": "The ARN of the schema to associate with the dataset. The schema defines the dataset fields.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DatasetArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Name", + "DatasetType", + "DatasetGroupArn", + "SchemaArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", + "taggable": false, + "typeName": "AWS::Personalize::Dataset" +} diff --git a/schema/aws-personalize-datasetgroup.json b/schema/aws-personalize-datasetgroup.json index 1247c40..8440ed9 100644 --- a/schema/aws-personalize-datasetgroup.json +++ b/schema/aws-personalize-datasetgroup.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/RoleArn", - "/properties/KmsKeyArn", - "/properties/Domain" - ], - "description": "Resource Schema for AWS::Personalize::DatasetGroup.", - "handlers": { - "create": { - "permissions": [ - "personalize:CreateDatasetGroup", - "personalize:DescribeDatasetGroup", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "personalize:DescribeDatasetGroup", - "personalize:DeleteDatasetGroup" - ] - }, - "list": { - "permissions": [ - "personalize:ListDatasetGroups" - ] - }, - "read": { - "permissions": [ - "personalize:DescribeDatasetGroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatasetGroupArn" - ], - "properties": { - "DatasetGroupArn": { - "description": "The Amazon Resource Name (ARN) of the dataset group.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "Domain": { - "description": "The domain of a Domain dataset group.", - "enum": [ - "ECOMMERCE", - "VIDEO_ON_DEMAND" - ], - "type": "string" - }, - "KmsKeyArn": { - "description": "The Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.", - "maxLength": 2048, - "pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/.*", - "type": "string" - }, - "Name": { - "description": "The name for the new dataset group.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "RoleArn": { - "description": "The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.", - "maxLength": 256, - "minLength": 0, - "pattern": "arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DatasetGroupArn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", - "typeName": "AWS::Personalize::DatasetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/RoleArn", + "/properties/KmsKeyArn", + "/properties/Domain" + ], + "description": "Resource Schema for AWS::Personalize::DatasetGroup.", + "handlers": { + "create": { + "permissions": [ + "personalize:CreateDatasetGroup", + "personalize:DescribeDatasetGroup", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "personalize:DescribeDatasetGroup", + "personalize:DeleteDatasetGroup" + ] + }, + "list": { + "permissions": [ + "personalize:ListDatasetGroups" + ] + }, + "read": { + "permissions": [ + "personalize:DescribeDatasetGroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatasetGroupArn" + ], + "properties": { + "DatasetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the dataset group.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "Domain": { + "description": "The domain of a Domain dataset group.", + "enum": [ + "ECOMMERCE", + "VIDEO_ON_DEMAND" + ], + "type": "string" + }, + "KmsKeyArn": { + "description": "The Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.", + "maxLength": 2048, + "pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/.*", + "type": "string" + }, + "Name": { + "description": "The name for the new dataset group.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DatasetGroupArn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", + "typeName": "AWS::Personalize::DatasetGroup" +} diff --git a/schema/aws-personalize-schema.json b/schema/aws-personalize-schema.json index c8e1fc8..2385f13 100644 --- a/schema/aws-personalize-schema.json +++ b/schema/aws-personalize-schema.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Schema", - "/properties/Domain" - ], - "description": "Resource schema for AWS::Personalize::Schema.", - "handlers": { - "create": { - "permissions": [ - "personalize:CreateSchema", - "personalize:DescribeSchema" - ] - }, - "delete": { - "permissions": [ - "personalize:DeleteSchema", - "personalize:DescribeSchema" - ] - }, - "list": { - "permissions": [ - "personalize:ListSchemas" - ] - }, - "read": { - "permissions": [ - "personalize:DescribeSchema" - ] - } - }, - "primaryIdentifier": [ - "/properties/SchemaArn" - ], - "properties": { - "Domain": { - "description": "The domain of a Domain dataset group.", - "enum": [ - "ECOMMERCE", - "VIDEO_ON_DEMAND" - ], - "type": "string" - }, - "Name": { - "description": "Name for the schema.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "Schema": { - "description": "A schema in Avro JSON format.", - "maxLength": 10000, - "type": "string" - }, - "SchemaArn": { - "description": "Arn for the schema.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SchemaArn" - ], - "required": [ - "Name", - "Schema" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", - "typeName": "AWS::Personalize::Schema" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Schema", + "/properties/Domain" + ], + "description": "Resource schema for AWS::Personalize::Schema.", + "handlers": { + "create": { + "permissions": [ + "personalize:CreateSchema", + "personalize:DescribeSchema" + ] + }, + "delete": { + "permissions": [ + "personalize:DeleteSchema", + "personalize:DescribeSchema" + ] + }, + "list": { + "permissions": [ + "personalize:ListSchemas" + ] + }, + "read": { + "permissions": [ + "personalize:DescribeSchema" + ] + } + }, + "primaryIdentifier": [ + "/properties/SchemaArn" + ], + "properties": { + "Domain": { + "description": "The domain of a Domain dataset group.", + "enum": [ + "ECOMMERCE", + "VIDEO_ON_DEMAND" + ], + "type": "string" + }, + "Name": { + "description": "Name for the schema.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "Schema": { + "description": "A schema in Avro JSON format.", + "maxLength": 10000, + "type": "string" + }, + "SchemaArn": { + "description": "Arn for the schema.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SchemaArn" + ], + "required": [ + "Name", + "Schema" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", + "typeName": "AWS::Personalize::Schema" +} diff --git a/schema/aws-personalize-solution.json b/schema/aws-personalize-solution.json index ea3ae31..3b69428 100644 --- a/schema/aws-personalize-solution.json +++ b/schema/aws-personalize-solution.json @@ -1,304 +1,304 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/EventType", - "/properties/DatasetGroupArn", - "/properties/PerformAutoML", - "/properties/PerformHPO", - "/properties/RecipeArn", - "/properties/SolutionConfig" - ], - "definitions": { - "CategoricalHyperParameterRange": { - "additionalProperties": false, - "description": "Provides the name and values of a Categorical hyperparameter.", - "properties": { - "Name": { - "description": "The name of the hyperparameter.", - "maxLength": 256, - "type": "string" - }, - "Values": { - "description": "A list of the categories for the hyperparameter.", - "insertionOrder": true, - "items": { - "maxLength": 1000, - "type": "string" - }, - "maxItems": 100, - "type": "array" - } - }, - "type": "object" - }, - "ContinuousHyperParameterRange": { - "additionalProperties": false, - "description": "Provides the name and range of a continuous hyperparameter.", - "properties": { - "MaxValue": { - "description": "The maximum allowable value for the hyperparameter.", - "minimum": -1000000, - "type": "number" - }, - "MinValue": { - "description": "The minimum allowable value for the hyperparameter.", - "minimum": -1000000, - "type": "number" - }, - "Name": { - "description": "The name of the hyperparameter.", - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "IntegerHyperParameterRange": { - "additionalProperties": false, - "description": "Provides the name and range of an integer-valued hyperparameter.", - "properties": { - "MaxValue": { - "description": "The maximum allowable value for the hyperparameter.", - "maximum": 1000000, - "type": "integer" - }, - "MinValue": { - "description": "The minimum allowable value for the hyperparameter.", - "minimum": -1000000, - "type": "integer" - }, - "Name": { - "description": "The name of the hyperparameter.", - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "SolutionArn": { - "description": "The ARN of the solution", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "SolutionConfig": { - "additionalProperties": false, - "description": "The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.", - "properties": { - "AlgorithmHyperParameters": { - "additionalProperties": false, - "description": "Lists the hyperparameter names and ranges.", - "maxProperties": 100, - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "AutoMLConfig": { - "additionalProperties": false, - "description": "The AutoMLConfig object containing a list of recipes to search when AutoML is performed.", - "properties": { - "MetricName": { - "description": "The metric to optimize.", - "maxLength": 256, - "type": "string" - }, - "RecipeList": { - "description": "The list of candidate recipes.", - "insertionOrder": true, - "items": { - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "maxItems": 100, - "type": "array" - } - }, - "type": "object" - }, - "EventValueThreshold": { - "description": "Only events with a value greater than or equal to this threshold are used for training a model.", - "maxLength": 256, - "type": "string" - }, - "FeatureTransformationParameters": { - "additionalProperties": false, - "description": "Lists the feature transformation parameters.", - "maxProperties": 100, - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "HpoConfig": { - "additionalProperties": false, - "description": "Describes the properties for hyperparameter optimization (HPO)", - "properties": { - "AlgorithmHyperParameterRanges": { - "additionalProperties": false, - "description": "The hyperparameters and their allowable ranges", - "properties": { - "CategoricalHyperParameterRanges": { - "description": "The categorical hyperparameters and their ranges.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CategoricalHyperParameterRange" - }, - "maxItems": 100, - "type": "array" - }, - "ContinuousHyperParameterRanges": { - "description": "The continuous hyperparameters and their ranges.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ContinuousHyperParameterRange" - }, - "maxItems": 100, - "type": "array" - }, - "IntegerHyperParameterRanges": { - "description": "The integer hyperparameters and their ranges.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IntegerHyperParameterRange" - }, - "maxItems": 100, - "type": "array" - } - }, - "type": "object" - }, - "HpoObjective": { - "additionalProperties": false, - "description": "The metric to optimize during HPO.", - "properties": { - "MetricName": { - "description": "The name of the metric", - "maxLength": 256, - "type": "string" - }, - "MetricRegex": { - "description": "A regular expression for finding the metric in the training job logs.", - "maxLength": 256, - "type": "string" - }, - "Type": { - "description": "The type of the metric. Valid values are Maximize and Minimize.", - "enum": [ - "Maximize", - "Minimize" - ], - "type": "string" - } - }, - "type": "object" - }, - "HpoResourceConfig": { - "additionalProperties": false, - "description": "Describes the resource configuration for hyperparameter optimization (HPO).", - "properties": { - "MaxNumberOfTrainingJobs": { - "description": "The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.", - "maxLength": 256, - "type": "string" - }, - "MaxParallelTrainingJobs": { - "description": "The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.", - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::Personalize::Solution.", - "handlers": { - "create": { - "permissions": [ - "personalize:CreateSolution", - "personalize:DescribeSolution" - ] - }, - "delete": { - "permissions": [ - "personalize:DeleteSolution", - "personalize:DescribeSolution" - ] - }, - "list": { - "permissions": [ - "personalize:ListSolutions" - ] - }, - "read": { - "permissions": [ - "personalize:DescribeSolution" - ] - } - }, - "primaryIdentifier": [ - "/properties/SolutionArn" - ], - "properties": { - "DatasetGroupArn": { - "description": "The ARN of the dataset group that provides the training data.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "EventType": { - "description": "When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.", - "maxLength": 256, - "type": "string" - }, - "Name": { - "description": "The name for the solution", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", - "type": "string" - }, - "PerformAutoML": { - "description": "Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.", - "type": "boolean" - }, - "PerformHPO": { - "description": "Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.", - "type": "boolean" - }, - "RecipeArn": { - "description": "The ARN of the recipe to use for model training. Only specified when performAutoML is false.", - "maxLength": 256, - "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", - "type": "string" - }, - "SolutionArn": { - "$ref": "#/definitions/SolutionArn" - }, - "SolutionConfig": { - "$ref": "#/definitions/SolutionConfig" - } - }, - "readOnlyProperties": [ - "/properties/SolutionArn" - ], - "required": [ - "Name", - "DatasetGroupArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", - "taggable": false, - "typeName": "AWS::Personalize::Solution" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/EventType", + "/properties/DatasetGroupArn", + "/properties/PerformAutoML", + "/properties/PerformHPO", + "/properties/RecipeArn", + "/properties/SolutionConfig" + ], + "definitions": { + "CategoricalHyperParameterRange": { + "additionalProperties": false, + "description": "Provides the name and values of a Categorical hyperparameter.", + "properties": { + "Name": { + "description": "The name of the hyperparameter.", + "maxLength": 256, + "type": "string" + }, + "Values": { + "description": "A list of the categories for the hyperparameter.", + "insertionOrder": true, + "items": { + "maxLength": 1000, + "type": "string" + }, + "maxItems": 100, + "type": "array" + } + }, + "type": "object" + }, + "ContinuousHyperParameterRange": { + "additionalProperties": false, + "description": "Provides the name and range of a continuous hyperparameter.", + "properties": { + "MaxValue": { + "description": "The maximum allowable value for the hyperparameter.", + "minimum": -1000000, + "type": "number" + }, + "MinValue": { + "description": "The minimum allowable value for the hyperparameter.", + "minimum": -1000000, + "type": "number" + }, + "Name": { + "description": "The name of the hyperparameter.", + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "IntegerHyperParameterRange": { + "additionalProperties": false, + "description": "Provides the name and range of an integer-valued hyperparameter.", + "properties": { + "MaxValue": { + "description": "The maximum allowable value for the hyperparameter.", + "maximum": 1000000, + "type": "integer" + }, + "MinValue": { + "description": "The minimum allowable value for the hyperparameter.", + "minimum": -1000000, + "type": "integer" + }, + "Name": { + "description": "The name of the hyperparameter.", + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "SolutionArn": { + "description": "The ARN of the solution", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "SolutionConfig": { + "additionalProperties": false, + "description": "The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.", + "properties": { + "AlgorithmHyperParameters": { + "additionalProperties": false, + "description": "Lists the hyperparameter names and ranges.", + "maxProperties": 100, + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "AutoMLConfig": { + "additionalProperties": false, + "description": "The AutoMLConfig object containing a list of recipes to search when AutoML is performed.", + "properties": { + "MetricName": { + "description": "The metric to optimize.", + "maxLength": 256, + "type": "string" + }, + "RecipeList": { + "description": "The list of candidate recipes.", + "insertionOrder": true, + "items": { + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "maxItems": 100, + "type": "array" + } + }, + "type": "object" + }, + "EventValueThreshold": { + "description": "Only events with a value greater than or equal to this threshold are used for training a model.", + "maxLength": 256, + "type": "string" + }, + "FeatureTransformationParameters": { + "additionalProperties": false, + "description": "Lists the feature transformation parameters.", + "maxProperties": 100, + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "HpoConfig": { + "additionalProperties": false, + "description": "Describes the properties for hyperparameter optimization (HPO)", + "properties": { + "AlgorithmHyperParameterRanges": { + "additionalProperties": false, + "description": "The hyperparameters and their allowable ranges", + "properties": { + "CategoricalHyperParameterRanges": { + "description": "The categorical hyperparameters and their ranges.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CategoricalHyperParameterRange" + }, + "maxItems": 100, + "type": "array" + }, + "ContinuousHyperParameterRanges": { + "description": "The continuous hyperparameters and their ranges.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ContinuousHyperParameterRange" + }, + "maxItems": 100, + "type": "array" + }, + "IntegerHyperParameterRanges": { + "description": "The integer hyperparameters and their ranges.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IntegerHyperParameterRange" + }, + "maxItems": 100, + "type": "array" + } + }, + "type": "object" + }, + "HpoObjective": { + "additionalProperties": false, + "description": "The metric to optimize during HPO.", + "properties": { + "MetricName": { + "description": "The name of the metric", + "maxLength": 256, + "type": "string" + }, + "MetricRegex": { + "description": "A regular expression for finding the metric in the training job logs.", + "maxLength": 256, + "type": "string" + }, + "Type": { + "description": "The type of the metric. Valid values are Maximize and Minimize.", + "enum": [ + "Maximize", + "Minimize" + ], + "type": "string" + } + }, + "type": "object" + }, + "HpoResourceConfig": { + "additionalProperties": false, + "description": "Describes the resource configuration for hyperparameter optimization (HPO).", + "properties": { + "MaxNumberOfTrainingJobs": { + "description": "The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.", + "maxLength": 256, + "type": "string" + }, + "MaxParallelTrainingJobs": { + "description": "The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.", + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::Personalize::Solution.", + "handlers": { + "create": { + "permissions": [ + "personalize:CreateSolution", + "personalize:DescribeSolution" + ] + }, + "delete": { + "permissions": [ + "personalize:DeleteSolution", + "personalize:DescribeSolution" + ] + }, + "list": { + "permissions": [ + "personalize:ListSolutions" + ] + }, + "read": { + "permissions": [ + "personalize:DescribeSolution" + ] + } + }, + "primaryIdentifier": [ + "/properties/SolutionArn" + ], + "properties": { + "DatasetGroupArn": { + "description": "The ARN of the dataset group that provides the training data.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "EventType": { + "description": "When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.", + "maxLength": 256, + "type": "string" + }, + "Name": { + "description": "The name for the solution", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*", + "type": "string" + }, + "PerformAutoML": { + "description": "Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.", + "type": "boolean" + }, + "PerformHPO": { + "description": "Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.", + "type": "boolean" + }, + "RecipeArn": { + "description": "The ARN of the recipe to use for model training. Only specified when performAutoML is false.", + "maxLength": 256, + "pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+", + "type": "string" + }, + "SolutionArn": { + "$ref": "#/definitions/SolutionArn" + }, + "SolutionConfig": { + "$ref": "#/definitions/SolutionConfig" + } + }, + "readOnlyProperties": [ + "/properties/SolutionArn" + ], + "required": [ + "Name", + "DatasetGroupArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-personalize", + "taggable": false, + "typeName": "AWS::Personalize::Solution" +} diff --git a/schema/aws-pinpoint-admchannel.json b/schema/aws-pinpoint-admchannel.json index 2c54180..6afb89c 100644 --- a/schema/aws-pinpoint-admchannel.json +++ b/schema/aws-pinpoint-admchannel.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::ADMChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId", - "ClientId", - "ClientSecret" - ], - "typeName": "AWS::Pinpoint::ADMChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::ADMChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "ClientId": { + "type": "string" + }, + "ClientSecret": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId", + "ClientId", + "ClientSecret" + ], + "typeName": "AWS::Pinpoint::ADMChannel" +} diff --git a/schema/aws-pinpoint-apnschannel.json b/schema/aws-pinpoint-apnschannel.json index fc62c01..2484f5a 100644 --- a/schema/aws-pinpoint-apnschannel.json +++ b/schema/aws-pinpoint-apnschannel.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::APNSChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::APNSChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::APNSChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "BundleId": { + "type": "string" + }, + "Certificate": { + "type": "string" + }, + "DefaultAuthenticationMethod": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + }, + "TeamId": { + "type": "string" + }, + "TokenKey": { + "type": "string" + }, + "TokenKeyId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::APNSChannel" +} diff --git a/schema/aws-pinpoint-apnssandboxchannel.json b/schema/aws-pinpoint-apnssandboxchannel.json index 35dec1c..5bbd873 100644 --- a/schema/aws-pinpoint-apnssandboxchannel.json +++ b/schema/aws-pinpoint-apnssandboxchannel.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::APNSSandboxChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::APNSSandboxChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::APNSSandboxChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "BundleId": { + "type": "string" + }, + "Certificate": { + "type": "string" + }, + "DefaultAuthenticationMethod": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + }, + "TeamId": { + "type": "string" + }, + "TokenKey": { + "type": "string" + }, + "TokenKeyId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::APNSSandboxChannel" +} diff --git a/schema/aws-pinpoint-apnsvoipchannel.json b/schema/aws-pinpoint-apnsvoipchannel.json index 53d20fe..032e1b9 100644 --- a/schema/aws-pinpoint-apnsvoipchannel.json +++ b/schema/aws-pinpoint-apnsvoipchannel.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::APNSVoipChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::APNSVoipChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::APNSVoipChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "BundleId": { + "type": "string" + }, + "Certificate": { + "type": "string" + }, + "DefaultAuthenticationMethod": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + }, + "TeamId": { + "type": "string" + }, + "TokenKey": { + "type": "string" + }, + "TokenKeyId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::APNSVoipChannel" +} diff --git a/schema/aws-pinpoint-apnsvoipsandboxchannel.json b/schema/aws-pinpoint-apnsvoipsandboxchannel.json index 4dfefb2..3a21e39 100644 --- a/schema/aws-pinpoint-apnsvoipsandboxchannel.json +++ b/schema/aws-pinpoint-apnsvoipsandboxchannel.json @@ -1,49 +1,49 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::APNSVoipSandboxChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::APNSVoipSandboxChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::APNSVoipSandboxChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "BundleId": { + "type": "string" + }, + "Certificate": { + "type": "string" + }, + "DefaultAuthenticationMethod": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "PrivateKey": { + "type": "string" + }, + "TeamId": { + "type": "string" + }, + "TokenKey": { + "type": "string" + }, + "TokenKeyId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::APNSVoipSandboxChannel" +} diff --git a/schema/aws-pinpoint-app.json b/schema/aws-pinpoint-app.json index d099dc8..677fede 100644 --- a/schema/aws-pinpoint-app.json +++ b/schema/aws-pinpoint-app.json @@ -1,32 +1,32 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::Pinpoint::App", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::Pinpoint::App" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::Pinpoint::App", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::Pinpoint::App" +} diff --git a/schema/aws-pinpoint-applicationsettings.json b/schema/aws-pinpoint-applicationsettings.json index a28d464..c6ef5a0 100644 --- a/schema/aws-pinpoint-applicationsettings.json +++ b/schema/aws-pinpoint-applicationsettings.json @@ -1,88 +1,88 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "definitions": { - "CampaignHook": { - "additionalProperties": false, - "properties": { - "LambdaFunctionName": { - "type": "string" - }, - "Mode": { - "type": "string" - }, - "WebUrl": { - "type": "string" - } - }, - "type": "object" - }, - "Limits": { - "additionalProperties": false, - "properties": { - "Daily": { - "type": "integer" - }, - "MaximumDuration": { - "type": "integer" - }, - "MessagesPerSecond": { - "type": "integer" - }, - "Total": { - "type": "integer" - } - }, - "type": "object" - }, - "QuietTime": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "required": [ - "Start", - "End" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Pinpoint::ApplicationSettings", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "CampaignHook": { - "$ref": "#/definitions/CampaignHook" - }, - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "Limits": { - "$ref": "#/definitions/Limits" - }, - "QuietTime": { - "$ref": "#/definitions/QuietTime" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::ApplicationSettings" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "CampaignHook": { + "additionalProperties": false, + "properties": { + "LambdaFunctionName": { + "type": "string" + }, + "Mode": { + "type": "string" + }, + "WebUrl": { + "type": "string" + } + }, + "type": "object" + }, + "Limits": { + "additionalProperties": false, + "properties": { + "Daily": { + "type": "integer" + }, + "MaximumDuration": { + "type": "integer" + }, + "MessagesPerSecond": { + "type": "integer" + }, + "Total": { + "type": "integer" + } + }, + "type": "object" + }, + "QuietTime": { + "additionalProperties": false, + "properties": { + "End": { + "type": "string" + }, + "Start": { + "type": "string" + } + }, + "required": [ + "Start", + "End" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Pinpoint::ApplicationSettings", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "CampaignHook": { + "$ref": "#/definitions/CampaignHook" + }, + "CloudWatchMetricsEnabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "Limits": { + "$ref": "#/definitions/Limits" + }, + "QuietTime": { + "$ref": "#/definitions/QuietTime" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::ApplicationSettings" +} diff --git a/schema/aws-pinpoint-baiduchannel.json b/schema/aws-pinpoint-baiduchannel.json index e07692e..61f31fc 100644 --- a/schema/aws-pinpoint-baiduchannel.json +++ b/schema/aws-pinpoint-baiduchannel.json @@ -1,36 +1,36 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::BaiduChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiKey": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "SecretKey": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId", - "SecretKey", - "ApiKey" - ], - "typeName": "AWS::Pinpoint::BaiduChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::BaiduChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiKey": { + "type": "string" + }, + "ApplicationId": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "SecretKey": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId", + "SecretKey", + "ApiKey" + ], + "typeName": "AWS::Pinpoint::BaiduChannel" +} diff --git a/schema/aws-pinpoint-campaign.json b/schema/aws-pinpoint-campaign.json index e3d597b..d297677 100644 --- a/schema/aws-pinpoint-campaign.json +++ b/schema/aws-pinpoint-campaign.json @@ -1,537 +1,537 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "definitions": { - "CampaignCustomMessage": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignEmailMessage": { - "additionalProperties": false, - "properties": { - "Body": { - "type": "string" - }, - "FromAddress": { - "type": "string" - }, - "HtmlBody": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignEventFilter": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "$ref": "#/definitions/EventDimensions" - }, - "FilterType": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignHook": { - "additionalProperties": false, - "properties": { - "LambdaFunctionName": { - "type": "string" - }, - "Mode": { - "type": "string" - }, - "WebUrl": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignInAppMessage": { - "additionalProperties": false, - "properties": { - "Content": { - "items": { - "$ref": "#/definitions/InAppMessageContent" - }, - "type": "array", - "uniqueItems": false - }, - "CustomConfig": { - "type": "object" - }, - "Layout": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignSmsMessage": { - "additionalProperties": false, - "properties": { - "Body": { - "type": "string" - }, - "EntityId": { - "type": "string" - }, - "MessageType": { - "type": "string" - }, - "OriginationNumber": { - "type": "string" - }, - "SenderId": { - "type": "string" - }, - "TemplateId": { - "type": "string" - } - }, - "type": "object" - }, - "CustomDeliveryConfiguration": { - "additionalProperties": false, - "properties": { - "DeliveryUri": { - "type": "string" - }, - "EndpointTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DefaultButtonConfiguration": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "type": "string" - }, - "BorderRadius": { - "type": "integer" - }, - "ButtonAction": { - "type": "string" - }, - "Link": { - "type": "string" - }, - "Text": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "EventDimensions": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "EventType": { - "$ref": "#/definitions/SetDimension" - }, - "Metrics": { - "type": "object" - } - }, - "type": "object" - }, - "InAppMessageBodyConfig": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "InAppMessageButton": { - "additionalProperties": false, - "properties": { - "Android": { - "$ref": "#/definitions/OverrideButtonConfiguration" - }, - "DefaultConfig": { - "$ref": "#/definitions/DefaultButtonConfiguration" - }, - "IOS": { - "$ref": "#/definitions/OverrideButtonConfiguration" - }, - "Web": { - "$ref": "#/definitions/OverrideButtonConfiguration" - } - }, - "type": "object" - }, - "InAppMessageContent": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "type": "string" - }, - "BodyConfig": { - "$ref": "#/definitions/InAppMessageBodyConfig" - }, - "HeaderConfig": { - "$ref": "#/definitions/InAppMessageHeaderConfig" - }, - "ImageUrl": { - "type": "string" - }, - "PrimaryBtn": { - "$ref": "#/definitions/InAppMessageButton" - }, - "SecondaryBtn": { - "$ref": "#/definitions/InAppMessageButton" - } - }, - "type": "object" - }, - "InAppMessageHeaderConfig": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "Header": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "Limits": { - "additionalProperties": false, - "properties": { - "Daily": { - "type": "integer" - }, - "MaximumDuration": { - "type": "integer" - }, - "MessagesPerSecond": { - "type": "integer" - }, - "Session": { - "type": "integer" - }, - "Total": { - "type": "integer" - } - }, - "type": "object" - }, - "Message": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "ImageIconUrl": { - "type": "string" - }, - "ImageSmallIconUrl": { - "type": "string" - }, - "ImageUrl": { - "type": "string" - }, - "JsonBody": { - "type": "string" - }, - "MediaUrl": { - "type": "string" - }, - "RawContent": { - "type": "string" - }, - "SilentPush": { - "type": "boolean" - }, - "TimeToLive": { - "type": "integer" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "MessageConfiguration": { - "additionalProperties": false, - "properties": { - "ADMMessage": { - "$ref": "#/definitions/Message" - }, - "APNSMessage": { - "$ref": "#/definitions/Message" - }, - "BaiduMessage": { - "$ref": "#/definitions/Message" - }, - "CustomMessage": { - "$ref": "#/definitions/CampaignCustomMessage" - }, - "DefaultMessage": { - "$ref": "#/definitions/Message" - }, - "EmailMessage": { - "$ref": "#/definitions/CampaignEmailMessage" - }, - "GCMMessage": { - "$ref": "#/definitions/Message" - }, - "InAppMessage": { - "$ref": "#/definitions/CampaignInAppMessage" - }, - "SMSMessage": { - "$ref": "#/definitions/CampaignSmsMessage" - } - }, - "type": "object" - }, - "OverrideButtonConfiguration": { - "additionalProperties": false, - "properties": { - "ButtonAction": { - "type": "string" - }, - "Link": { - "type": "string" - } - }, - "type": "object" - }, - "QuietTime": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "required": [ - "Start", - "End" - ], - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "properties": { - "EndTime": { - "type": "string" - }, - "EventFilter": { - "$ref": "#/definitions/CampaignEventFilter" - }, - "Frequency": { - "type": "string" - }, - "IsLocalTime": { - "type": "boolean" - }, - "QuietTime": { - "$ref": "#/definitions/QuietTime" - }, - "StartTime": { - "type": "string" - }, - "TimeZone": { - "type": "string" - } - }, - "type": "object" - }, - "SetDimension": { - "additionalProperties": false, - "properties": { - "DimensionType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Template": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "TemplateConfiguration": { - "additionalProperties": false, - "properties": { - "EmailTemplate": { - "$ref": "#/definitions/Template" - }, - "PushTemplate": { - "$ref": "#/definitions/Template" - }, - "SMSTemplate": { - "$ref": "#/definitions/Template" - }, - "VoiceTemplate": { - "$ref": "#/definitions/Template" - } - }, - "type": "object" - }, - "WriteTreatmentResource": { - "additionalProperties": false, - "properties": { - "CustomDeliveryConfiguration": { - "$ref": "#/definitions/CustomDeliveryConfiguration" - }, - "MessageConfiguration": { - "$ref": "#/definitions/MessageConfiguration" - }, - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "SizePercent": { - "type": "integer" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/TemplateConfiguration" - }, - "TreatmentDescription": { - "type": "string" - }, - "TreatmentName": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Pinpoint::Campaign", - "primaryIdentifier": [ - "/properties/CampaignId" - ], - "properties": { - "AdditionalTreatments": { - "items": { - "$ref": "#/definitions/WriteTreatmentResource" - }, - "type": "array", - "uniqueItems": false - }, - "ApplicationId": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "CampaignHook": { - "$ref": "#/definitions/CampaignHook" - }, - "CampaignId": { - "type": "string" - }, - "CustomDeliveryConfiguration": { - "$ref": "#/definitions/CustomDeliveryConfiguration" - }, - "Description": { - "type": "string" - }, - "HoldoutPercent": { - "type": "integer" - }, - "IsPaused": { - "type": "boolean" - }, - "Limits": { - "$ref": "#/definitions/Limits" - }, - "MessageConfiguration": { - "$ref": "#/definitions/MessageConfiguration" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "integer" - }, - "Schedule": { - "$ref": "#/definitions/Schedule" - }, - "SegmentId": { - "type": "string" - }, - "SegmentVersion": { - "type": "integer" - }, - "Tags": { - "type": "object" - }, - "TemplateConfiguration": { - "$ref": "#/definitions/TemplateConfiguration" - }, - "TreatmentDescription": { - "type": "string" - }, - "TreatmentName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CampaignId" - ], - "required": [ - "SegmentId", - "Schedule", - "ApplicationId", - "Name" - ], - "typeName": "AWS::Pinpoint::Campaign" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "CampaignCustomMessage": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignEmailMessage": { + "additionalProperties": false, + "properties": { + "Body": { + "type": "string" + }, + "FromAddress": { + "type": "string" + }, + "HtmlBody": { + "type": "string" + }, + "Title": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignEventFilter": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "$ref": "#/definitions/EventDimensions" + }, + "FilterType": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignHook": { + "additionalProperties": false, + "properties": { + "LambdaFunctionName": { + "type": "string" + }, + "Mode": { + "type": "string" + }, + "WebUrl": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignInAppMessage": { + "additionalProperties": false, + "properties": { + "Content": { + "items": { + "$ref": "#/definitions/InAppMessageContent" + }, + "type": "array", + "uniqueItems": false + }, + "CustomConfig": { + "type": "object" + }, + "Layout": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignSmsMessage": { + "additionalProperties": false, + "properties": { + "Body": { + "type": "string" + }, + "EntityId": { + "type": "string" + }, + "MessageType": { + "type": "string" + }, + "OriginationNumber": { + "type": "string" + }, + "SenderId": { + "type": "string" + }, + "TemplateId": { + "type": "string" + } + }, + "type": "object" + }, + "CustomDeliveryConfiguration": { + "additionalProperties": false, + "properties": { + "DeliveryUri": { + "type": "string" + }, + "EndpointTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DefaultButtonConfiguration": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "type": "string" + }, + "BorderRadius": { + "type": "integer" + }, + "ButtonAction": { + "type": "string" + }, + "Link": { + "type": "string" + }, + "Text": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "EventDimensions": { + "additionalProperties": false, + "properties": { + "Attributes": { + "type": "object" + }, + "EventType": { + "$ref": "#/definitions/SetDimension" + }, + "Metrics": { + "type": "object" + } + }, + "type": "object" + }, + "InAppMessageBodyConfig": { + "additionalProperties": false, + "properties": { + "Alignment": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "InAppMessageButton": { + "additionalProperties": false, + "properties": { + "Android": { + "$ref": "#/definitions/OverrideButtonConfiguration" + }, + "DefaultConfig": { + "$ref": "#/definitions/DefaultButtonConfiguration" + }, + "IOS": { + "$ref": "#/definitions/OverrideButtonConfiguration" + }, + "Web": { + "$ref": "#/definitions/OverrideButtonConfiguration" + } + }, + "type": "object" + }, + "InAppMessageContent": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "type": "string" + }, + "BodyConfig": { + "$ref": "#/definitions/InAppMessageBodyConfig" + }, + "HeaderConfig": { + "$ref": "#/definitions/InAppMessageHeaderConfig" + }, + "ImageUrl": { + "type": "string" + }, + "PrimaryBtn": { + "$ref": "#/definitions/InAppMessageButton" + }, + "SecondaryBtn": { + "$ref": "#/definitions/InAppMessageButton" + } + }, + "type": "object" + }, + "InAppMessageHeaderConfig": { + "additionalProperties": false, + "properties": { + "Alignment": { + "type": "string" + }, + "Header": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "Limits": { + "additionalProperties": false, + "properties": { + "Daily": { + "type": "integer" + }, + "MaximumDuration": { + "type": "integer" + }, + "MessagesPerSecond": { + "type": "integer" + }, + "Session": { + "type": "integer" + }, + "Total": { + "type": "integer" + } + }, + "type": "object" + }, + "Message": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "ImageIconUrl": { + "type": "string" + }, + "ImageSmallIconUrl": { + "type": "string" + }, + "ImageUrl": { + "type": "string" + }, + "JsonBody": { + "type": "string" + }, + "MediaUrl": { + "type": "string" + }, + "RawContent": { + "type": "string" + }, + "SilentPush": { + "type": "boolean" + }, + "TimeToLive": { + "type": "integer" + }, + "Title": { + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "type": "object" + }, + "MessageConfiguration": { + "additionalProperties": false, + "properties": { + "ADMMessage": { + "$ref": "#/definitions/Message" + }, + "APNSMessage": { + "$ref": "#/definitions/Message" + }, + "BaiduMessage": { + "$ref": "#/definitions/Message" + }, + "CustomMessage": { + "$ref": "#/definitions/CampaignCustomMessage" + }, + "DefaultMessage": { + "$ref": "#/definitions/Message" + }, + "EmailMessage": { + "$ref": "#/definitions/CampaignEmailMessage" + }, + "GCMMessage": { + "$ref": "#/definitions/Message" + }, + "InAppMessage": { + "$ref": "#/definitions/CampaignInAppMessage" + }, + "SMSMessage": { + "$ref": "#/definitions/CampaignSmsMessage" + } + }, + "type": "object" + }, + "OverrideButtonConfiguration": { + "additionalProperties": false, + "properties": { + "ButtonAction": { + "type": "string" + }, + "Link": { + "type": "string" + } + }, + "type": "object" + }, + "QuietTime": { + "additionalProperties": false, + "properties": { + "End": { + "type": "string" + }, + "Start": { + "type": "string" + } + }, + "required": [ + "Start", + "End" + ], + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "properties": { + "EndTime": { + "type": "string" + }, + "EventFilter": { + "$ref": "#/definitions/CampaignEventFilter" + }, + "Frequency": { + "type": "string" + }, + "IsLocalTime": { + "type": "boolean" + }, + "QuietTime": { + "$ref": "#/definitions/QuietTime" + }, + "StartTime": { + "type": "string" + }, + "TimeZone": { + "type": "string" + } + }, + "type": "object" + }, + "SetDimension": { + "additionalProperties": false, + "properties": { + "DimensionType": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Template": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "type": "object" + }, + "TemplateConfiguration": { + "additionalProperties": false, + "properties": { + "EmailTemplate": { + "$ref": "#/definitions/Template" + }, + "PushTemplate": { + "$ref": "#/definitions/Template" + }, + "SMSTemplate": { + "$ref": "#/definitions/Template" + }, + "VoiceTemplate": { + "$ref": "#/definitions/Template" + } + }, + "type": "object" + }, + "WriteTreatmentResource": { + "additionalProperties": false, + "properties": { + "CustomDeliveryConfiguration": { + "$ref": "#/definitions/CustomDeliveryConfiguration" + }, + "MessageConfiguration": { + "$ref": "#/definitions/MessageConfiguration" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "SizePercent": { + "type": "integer" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/TemplateConfiguration" + }, + "TreatmentDescription": { + "type": "string" + }, + "TreatmentName": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Pinpoint::Campaign", + "primaryIdentifier": [ + "/properties/CampaignId" + ], + "properties": { + "AdditionalTreatments": { + "items": { + "$ref": "#/definitions/WriteTreatmentResource" + }, + "type": "array", + "uniqueItems": false + }, + "ApplicationId": { + "type": "string" + }, + "Arn": { + "type": "string" + }, + "CampaignHook": { + "$ref": "#/definitions/CampaignHook" + }, + "CampaignId": { + "type": "string" + }, + "CustomDeliveryConfiguration": { + "$ref": "#/definitions/CustomDeliveryConfiguration" + }, + "Description": { + "type": "string" + }, + "HoldoutPercent": { + "type": "integer" + }, + "IsPaused": { + "type": "boolean" + }, + "Limits": { + "$ref": "#/definitions/Limits" + }, + "MessageConfiguration": { + "$ref": "#/definitions/MessageConfiguration" + }, + "Name": { + "type": "string" + }, + "Priority": { + "type": "integer" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "SegmentId": { + "type": "string" + }, + "SegmentVersion": { + "type": "integer" + }, + "Tags": { + "type": "object" + }, + "TemplateConfiguration": { + "$ref": "#/definitions/TemplateConfiguration" + }, + "TreatmentDescription": { + "type": "string" + }, + "TreatmentName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CampaignId" + ], + "required": [ + "SegmentId", + "Schedule", + "ApplicationId", + "Name" + ], + "typeName": "AWS::Pinpoint::Campaign" +} diff --git a/schema/aws-pinpoint-emailchannel.json b/schema/aws-pinpoint-emailchannel.json index d320b19..c8d9bd1 100644 --- a/schema/aws-pinpoint-emailchannel.json +++ b/schema/aws-pinpoint-emailchannel.json @@ -1,45 +1,45 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::EmailChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "ConfigurationSet": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "FromAddress": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Identity": { - "type": "string" - }, - "OrchestrationSendingRoleArn": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "FromAddress", - "ApplicationId", - "Identity" - ], - "typeName": "AWS::Pinpoint::EmailChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::EmailChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "ConfigurationSet": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "FromAddress": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Identity": { + "type": "string" + }, + "OrchestrationSendingRoleArn": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "FromAddress", + "ApplicationId", + "Identity" + ], + "typeName": "AWS::Pinpoint::EmailChannel" +} diff --git a/schema/aws-pinpoint-emailtemplate.json b/schema/aws-pinpoint-emailtemplate.json index 76c92a7..ecf0c2e 100644 --- a/schema/aws-pinpoint-emailtemplate.json +++ b/schema/aws-pinpoint-emailtemplate.json @@ -1,48 +1,48 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TemplateName" - ], - "description": "Resource Type definition for AWS::Pinpoint::EmailTemplate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DefaultSubstitutions": { - "type": "string" - }, - "HtmlPart": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - }, - "TextPart": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "TemplateName", - "Subject" - ], - "typeName": "AWS::Pinpoint::EmailTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TemplateName" + ], + "description": "Resource Type definition for AWS::Pinpoint::EmailTemplate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DefaultSubstitutions": { + "type": "string" + }, + "HtmlPart": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Subject": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "TemplateDescription": { + "type": "string" + }, + "TemplateName": { + "type": "string" + }, + "TextPart": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "TemplateName", + "Subject" + ], + "typeName": "AWS::Pinpoint::EmailTemplate" +} diff --git a/schema/aws-pinpoint-eventstream.json b/schema/aws-pinpoint-eventstream.json index 465e651..d1acc2a 100644 --- a/schema/aws-pinpoint-eventstream.json +++ b/schema/aws-pinpoint-eventstream.json @@ -1,33 +1,33 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::EventStream", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "DestinationStreamArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId", - "DestinationStreamArn", - "RoleArn" - ], - "typeName": "AWS::Pinpoint::EventStream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::EventStream", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "DestinationStreamArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId", + "DestinationStreamArn", + "RoleArn" + ], + "typeName": "AWS::Pinpoint::EventStream" +} diff --git a/schema/aws-pinpoint-gcmchannel.json b/schema/aws-pinpoint-gcmchannel.json index 132664d..5be82fc 100644 --- a/schema/aws-pinpoint-gcmchannel.json +++ b/schema/aws-pinpoint-gcmchannel.json @@ -1,37 +1,37 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::GCMChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApiKey": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "ServiceJson": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::GCMChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::GCMChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiKey": { + "type": "string" + }, + "ApplicationId": { + "type": "string" + }, + "DefaultAuthenticationMethod": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "ServiceJson": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::GCMChannel" +} diff --git a/schema/aws-pinpoint-inapptemplate.json b/schema/aws-pinpoint-inapptemplate.json index 3b7e186..4ff09a1 100644 --- a/schema/aws-pinpoint-inapptemplate.json +++ b/schema/aws-pinpoint-inapptemplate.json @@ -1,213 +1,213 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TemplateName" - ], - "definitions": { - "Alignment": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT" - ], - "type": "string" - }, - "BodyConfig": { - "additionalProperties": false, - "properties": { - "Alignment": { - "$ref": "#/definitions/Alignment" - }, - "Body": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "ButtonAction": { - "enum": [ - "LINK", - "DEEP_LINK", - "CLOSE" - ], - "type": "string" - }, - "ButtonConfig": { - "additionalProperties": false, - "properties": { - "Android": { - "$ref": "#/definitions/OverrideButtonConfiguration" - }, - "DefaultConfig": { - "$ref": "#/definitions/DefaultButtonConfiguration" - }, - "IOS": { - "$ref": "#/definitions/OverrideButtonConfiguration" - }, - "Web": { - "$ref": "#/definitions/OverrideButtonConfiguration" - } - }, - "type": "object" - }, - "DefaultButtonConfiguration": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "type": "string" - }, - "BorderRadius": { - "type": "integer" - }, - "ButtonAction": { - "$ref": "#/definitions/ButtonAction" - }, - "Link": { - "type": "string" - }, - "Text": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "HeaderConfig": { - "additionalProperties": false, - "properties": { - "Alignment": { - "$ref": "#/definitions/Alignment" - }, - "Header": { - "type": "string" - }, - "TextColor": { - "type": "string" - } - }, - "type": "object" - }, - "InAppMessageContent": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "type": "string" - }, - "BodyConfig": { - "$ref": "#/definitions/BodyConfig" - }, - "HeaderConfig": { - "$ref": "#/definitions/HeaderConfig" - }, - "ImageUrl": { - "type": "string" - }, - "PrimaryBtn": { - "$ref": "#/definitions/ButtonConfig" - }, - "SecondaryBtn": { - "$ref": "#/definitions/ButtonConfig" - } - }, - "type": "object" - }, - "OverrideButtonConfiguration": { - "additionalProperties": false, - "properties": { - "ButtonAction": { - "$ref": "#/definitions/ButtonAction" - }, - "Link": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Pinpoint::InAppTemplate", - "handlers": { - "create": { - "permissions": [ - "mobiletargeting:CreateInAppTemplate", - "mobiletargeting:GetInAppTemplate", - "mobiletargeting:TagResource" - ] - }, - "delete": { - "permissions": [ - "mobiletargeting:DeleteInAppTemplate", - "mobiletargeting:GetInAppTemplate" - ] - }, - "list": { - "permissions": [ - "mobiletargeting:GetInAppTemplate", - "mobiletargeting:ListTemplates" - ] - }, - "read": { - "permissions": [ - "mobiletargeting:GetInAppTemplate", - "mobiletargeting:ListTemplates" - ] - }, - "update": { - "permissions": [ - "mobiletargeting:UpdateInAppTemplate", - "mobiletargeting:GetInAppTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/TemplateName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Content": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/InAppMessageContent" - }, - "type": "array" - }, - "CustomConfig": { - "type": "object" - }, - "Layout": { - "enum": [ - "BOTTOM_BANNER", - "TOP_BANNER", - "OVERLAYS", - "MOBILE_FEED", - "MIDDLE_BANNER", - "CAROUSEL" - ], - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "TemplateName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::Pinpoint::InAppTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TemplateName" + ], + "definitions": { + "Alignment": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ], + "type": "string" + }, + "BodyConfig": { + "additionalProperties": false, + "properties": { + "Alignment": { + "$ref": "#/definitions/Alignment" + }, + "Body": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "ButtonAction": { + "enum": [ + "LINK", + "DEEP_LINK", + "CLOSE" + ], + "type": "string" + }, + "ButtonConfig": { + "additionalProperties": false, + "properties": { + "Android": { + "$ref": "#/definitions/OverrideButtonConfiguration" + }, + "DefaultConfig": { + "$ref": "#/definitions/DefaultButtonConfiguration" + }, + "IOS": { + "$ref": "#/definitions/OverrideButtonConfiguration" + }, + "Web": { + "$ref": "#/definitions/OverrideButtonConfiguration" + } + }, + "type": "object" + }, + "DefaultButtonConfiguration": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "type": "string" + }, + "BorderRadius": { + "type": "integer" + }, + "ButtonAction": { + "$ref": "#/definitions/ButtonAction" + }, + "Link": { + "type": "string" + }, + "Text": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "HeaderConfig": { + "additionalProperties": false, + "properties": { + "Alignment": { + "$ref": "#/definitions/Alignment" + }, + "Header": { + "type": "string" + }, + "TextColor": { + "type": "string" + } + }, + "type": "object" + }, + "InAppMessageContent": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "type": "string" + }, + "BodyConfig": { + "$ref": "#/definitions/BodyConfig" + }, + "HeaderConfig": { + "$ref": "#/definitions/HeaderConfig" + }, + "ImageUrl": { + "type": "string" + }, + "PrimaryBtn": { + "$ref": "#/definitions/ButtonConfig" + }, + "SecondaryBtn": { + "$ref": "#/definitions/ButtonConfig" + } + }, + "type": "object" + }, + "OverrideButtonConfiguration": { + "additionalProperties": false, + "properties": { + "ButtonAction": { + "$ref": "#/definitions/ButtonAction" + }, + "Link": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Pinpoint::InAppTemplate", + "handlers": { + "create": { + "permissions": [ + "mobiletargeting:CreateInAppTemplate", + "mobiletargeting:GetInAppTemplate", + "mobiletargeting:TagResource" + ] + }, + "delete": { + "permissions": [ + "mobiletargeting:DeleteInAppTemplate", + "mobiletargeting:GetInAppTemplate" + ] + }, + "list": { + "permissions": [ + "mobiletargeting:GetInAppTemplate", + "mobiletargeting:ListTemplates" + ] + }, + "read": { + "permissions": [ + "mobiletargeting:GetInAppTemplate", + "mobiletargeting:ListTemplates" + ] + }, + "update": { + "permissions": [ + "mobiletargeting:UpdateInAppTemplate", + "mobiletargeting:GetInAppTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/TemplateName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Content": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/InAppMessageContent" + }, + "type": "array" + }, + "CustomConfig": { + "type": "object" + }, + "Layout": { + "enum": [ + "BOTTOM_BANNER", + "TOP_BANNER", + "OVERLAYS", + "MOBILE_FEED", + "MIDDLE_BANNER", + "CAROUSEL" + ], + "type": "string" + }, + "Tags": { + "type": "object" + }, + "TemplateDescription": { + "type": "string" + }, + "TemplateName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "TemplateName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": true, + "typeName": "AWS::Pinpoint::InAppTemplate" +} diff --git a/schema/aws-pinpoint-pushtemplate.json b/schema/aws-pinpoint-pushtemplate.json index a268987..89a62eb 100644 --- a/schema/aws-pinpoint-pushtemplate.json +++ b/schema/aws-pinpoint-pushtemplate.json @@ -1,130 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TemplateName" - ], - "definitions": { - "APNSPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "MediaUrl": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "AndroidPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "ImageIconUrl": { - "type": "string" - }, - "ImageUrl": { - "type": "string" - }, - "SmallImageIconUrl": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "DefaultPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Pinpoint::PushTemplate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ADM": { - "$ref": "#/definitions/AndroidPushNotificationTemplate" - }, - "APNS": { - "$ref": "#/definitions/APNSPushNotificationTemplate" - }, - "Arn": { - "type": "string" - }, - "Baidu": { - "$ref": "#/definitions/AndroidPushNotificationTemplate" - }, - "Default": { - "$ref": "#/definitions/DefaultPushNotificationTemplate" - }, - "DefaultSubstitutions": { - "type": "string" - }, - "GCM": { - "$ref": "#/definitions/AndroidPushNotificationTemplate" - }, - "Id": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "TemplateName" - ], - "typeName": "AWS::Pinpoint::PushTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TemplateName" + ], + "definitions": { + "APNSPushNotificationTemplate": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "MediaUrl": { + "type": "string" + }, + "Sound": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "type": "object" + }, + "AndroidPushNotificationTemplate": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "ImageIconUrl": { + "type": "string" + }, + "ImageUrl": { + "type": "string" + }, + "SmallImageIconUrl": { + "type": "string" + }, + "Sound": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "type": "object" + }, + "DefaultPushNotificationTemplate": { + "additionalProperties": false, + "properties": { + "Action": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "Sound": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Pinpoint::PushTemplate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ADM": { + "$ref": "#/definitions/AndroidPushNotificationTemplate" + }, + "APNS": { + "$ref": "#/definitions/APNSPushNotificationTemplate" + }, + "Arn": { + "type": "string" + }, + "Baidu": { + "$ref": "#/definitions/AndroidPushNotificationTemplate" + }, + "Default": { + "$ref": "#/definitions/DefaultPushNotificationTemplate" + }, + "DefaultSubstitutions": { + "type": "string" + }, + "GCM": { + "$ref": "#/definitions/AndroidPushNotificationTemplate" + }, + "Id": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "TemplateDescription": { + "type": "string" + }, + "TemplateName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "TemplateName" + ], + "typeName": "AWS::Pinpoint::PushTemplate" +} diff --git a/schema/aws-pinpoint-segment.json b/schema/aws-pinpoint-segment.json index 5293532..0936adc 100644 --- a/schema/aws-pinpoint-segment.json +++ b/schema/aws-pinpoint-segment.json @@ -1,234 +1,234 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "definitions": { - "Behavior": { - "additionalProperties": false, - "properties": { - "Recency": { - "$ref": "#/definitions/Recency" - } - }, - "type": "object" - }, - "Coordinates": { - "additionalProperties": false, - "properties": { - "Latitude": { - "type": "number" - }, - "Longitude": { - "type": "number" - } - }, - "required": [ - "Longitude", - "Latitude" - ], - "type": "object" - }, - "Demographic": { - "additionalProperties": false, - "properties": { - "AppVersion": { - "$ref": "#/definitions/SetDimension" - }, - "Channel": { - "$ref": "#/definitions/SetDimension" - }, - "DeviceType": { - "$ref": "#/definitions/SetDimension" - }, - "Make": { - "$ref": "#/definitions/SetDimension" - }, - "Model": { - "$ref": "#/definitions/SetDimension" - }, - "Platform": { - "$ref": "#/definitions/SetDimension" - } - }, - "type": "object" - }, - "GPSPoint": { - "additionalProperties": false, - "properties": { - "Coordinates": { - "$ref": "#/definitions/Coordinates" - }, - "RangeInKilometers": { - "type": "number" - } - }, - "required": [ - "RangeInKilometers", - "Coordinates" - ], - "type": "object" - }, - "Groups": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/SegmentDimensions" - }, - "type": "array", - "uniqueItems": false - }, - "SourceSegments": { - "items": { - "$ref": "#/definitions/SourceSegments" - }, - "type": "array", - "uniqueItems": false - }, - "SourceType": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "Location": { - "additionalProperties": false, - "properties": { - "Country": { - "$ref": "#/definitions/SetDimension" - }, - "GPSPoint": { - "$ref": "#/definitions/GPSPoint" - } - }, - "type": "object" - }, - "Recency": { - "additionalProperties": false, - "properties": { - "Duration": { - "type": "string" - }, - "RecencyType": { - "type": "string" - } - }, - "required": [ - "Duration", - "RecencyType" - ], - "type": "object" - }, - "SegmentDimensions": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "Behavior": { - "$ref": "#/definitions/Behavior" - }, - "Demographic": { - "$ref": "#/definitions/Demographic" - }, - "Location": { - "$ref": "#/definitions/Location" - }, - "Metrics": { - "type": "object" - }, - "UserAttributes": { - "type": "object" - } - }, - "type": "object" - }, - "SegmentGroups": { - "additionalProperties": false, - "properties": { - "Groups": { - "items": { - "$ref": "#/definitions/Groups" - }, - "type": "array", - "uniqueItems": false - }, - "Include": { - "type": "string" - } - }, - "type": "object" - }, - "SetDimension": { - "additionalProperties": false, - "properties": { - "DimensionType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "SourceSegments": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Version": { - "type": "integer" - } - }, - "required": [ - "Id" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Pinpoint::Segment", - "primaryIdentifier": [ - "/properties/SegmentId" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "Dimensions": { - "$ref": "#/definitions/SegmentDimensions" - }, - "Name": { - "type": "string" - }, - "SegmentGroups": { - "$ref": "#/definitions/SegmentGroups" - }, - "SegmentId": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/SegmentId", - "/properties/Arn" - ], - "required": [ - "ApplicationId", - "Name" - ], - "typeName": "AWS::Pinpoint::Segment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "Behavior": { + "additionalProperties": false, + "properties": { + "Recency": { + "$ref": "#/definitions/Recency" + } + }, + "type": "object" + }, + "Coordinates": { + "additionalProperties": false, + "properties": { + "Latitude": { + "type": "number" + }, + "Longitude": { + "type": "number" + } + }, + "required": [ + "Longitude", + "Latitude" + ], + "type": "object" + }, + "Demographic": { + "additionalProperties": false, + "properties": { + "AppVersion": { + "$ref": "#/definitions/SetDimension" + }, + "Channel": { + "$ref": "#/definitions/SetDimension" + }, + "DeviceType": { + "$ref": "#/definitions/SetDimension" + }, + "Make": { + "$ref": "#/definitions/SetDimension" + }, + "Model": { + "$ref": "#/definitions/SetDimension" + }, + "Platform": { + "$ref": "#/definitions/SetDimension" + } + }, + "type": "object" + }, + "GPSPoint": { + "additionalProperties": false, + "properties": { + "Coordinates": { + "$ref": "#/definitions/Coordinates" + }, + "RangeInKilometers": { + "type": "number" + } + }, + "required": [ + "RangeInKilometers", + "Coordinates" + ], + "type": "object" + }, + "Groups": { + "additionalProperties": false, + "properties": { + "Dimensions": { + "items": { + "$ref": "#/definitions/SegmentDimensions" + }, + "type": "array", + "uniqueItems": false + }, + "SourceSegments": { + "items": { + "$ref": "#/definitions/SourceSegments" + }, + "type": "array", + "uniqueItems": false + }, + "SourceType": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "Location": { + "additionalProperties": false, + "properties": { + "Country": { + "$ref": "#/definitions/SetDimension" + }, + "GPSPoint": { + "$ref": "#/definitions/GPSPoint" + } + }, + "type": "object" + }, + "Recency": { + "additionalProperties": false, + "properties": { + "Duration": { + "type": "string" + }, + "RecencyType": { + "type": "string" + } + }, + "required": [ + "Duration", + "RecencyType" + ], + "type": "object" + }, + "SegmentDimensions": { + "additionalProperties": false, + "properties": { + "Attributes": { + "type": "object" + }, + "Behavior": { + "$ref": "#/definitions/Behavior" + }, + "Demographic": { + "$ref": "#/definitions/Demographic" + }, + "Location": { + "$ref": "#/definitions/Location" + }, + "Metrics": { + "type": "object" + }, + "UserAttributes": { + "type": "object" + } + }, + "type": "object" + }, + "SegmentGroups": { + "additionalProperties": false, + "properties": { + "Groups": { + "items": { + "$ref": "#/definitions/Groups" + }, + "type": "array", + "uniqueItems": false + }, + "Include": { + "type": "string" + } + }, + "type": "object" + }, + "SetDimension": { + "additionalProperties": false, + "properties": { + "DimensionType": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "SourceSegments": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Version": { + "type": "integer" + } + }, + "required": [ + "Id" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Pinpoint::Segment", + "primaryIdentifier": [ + "/properties/SegmentId" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "Arn": { + "type": "string" + }, + "Dimensions": { + "$ref": "#/definitions/SegmentDimensions" + }, + "Name": { + "type": "string" + }, + "SegmentGroups": { + "$ref": "#/definitions/SegmentGroups" + }, + "SegmentId": { + "type": "string" + }, + "Tags": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/SegmentId", + "/properties/Arn" + ], + "required": [ + "ApplicationId", + "Name" + ], + "typeName": "AWS::Pinpoint::Segment" +} diff --git a/schema/aws-pinpoint-smschannel.json b/schema/aws-pinpoint-smschannel.json index d3a4722..3fe5794 100644 --- a/schema/aws-pinpoint-smschannel.json +++ b/schema/aws-pinpoint-smschannel.json @@ -1,34 +1,34 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::SMSChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "SenderId": { - "type": "string" - }, - "ShortCode": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::SMSChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::SMSChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "SenderId": { + "type": "string" + }, + "ShortCode": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::SMSChannel" +} diff --git a/schema/aws-pinpoint-smstemplate.json b/schema/aws-pinpoint-smstemplate.json index 61738a5..6d1d57a 100644 --- a/schema/aws-pinpoint-smstemplate.json +++ b/schema/aws-pinpoint-smstemplate.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TemplateName" - ], - "description": "Resource Type definition for AWS::Pinpoint::SmsTemplate", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "DefaultSubstitutions": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "TemplateName", - "Body" - ], - "typeName": "AWS::Pinpoint::SmsTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TemplateName" + ], + "description": "Resource Type definition for AWS::Pinpoint::SmsTemplate", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Body": { + "type": "string" + }, + "DefaultSubstitutions": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "type": "object" + }, + "TemplateDescription": { + "type": "string" + }, + "TemplateName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "TemplateName", + "Body" + ], + "typeName": "AWS::Pinpoint::SmsTemplate" +} diff --git a/schema/aws-pinpoint-voicechannel.json b/schema/aws-pinpoint-voicechannel.json index acce4ef..bbc63a5 100644 --- a/schema/aws-pinpoint-voicechannel.json +++ b/schema/aws-pinpoint-voicechannel.json @@ -1,28 +1,28 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "description": "Resource Type definition for AWS::Pinpoint::VoiceChannel", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ApplicationId" - ], - "typeName": "AWS::Pinpoint::VoiceChannel" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "description": "Resource Type definition for AWS::Pinpoint::VoiceChannel", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationId": { + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApplicationId" + ], + "typeName": "AWS::Pinpoint::VoiceChannel" +} diff --git a/schema/aws-pinpointemail-configurationset.json b/schema/aws-pinpointemail-configurationset.json index fa073f9..1d27edb 100644 --- a/schema/aws-pinpointemail-configurationset.json +++ b/schema/aws-pinpointemail-configurationset.json @@ -1,94 +1,94 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "DeliveryOptions": { - "additionalProperties": false, - "properties": { - "SendingPoolName": { - "type": "string" - } - }, - "type": "object" - }, - "ReputationOptions": { - "additionalProperties": false, - "properties": { - "ReputationMetricsEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "SendingOptions": { - "additionalProperties": false, - "properties": { - "SendingEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "TrackingOptions": { - "additionalProperties": false, - "properties": { - "CustomRedirectDomain": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::PinpointEmail::ConfigurationSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeliveryOptions": { - "$ref": "#/definitions/DeliveryOptions" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReputationOptions": { - "$ref": "#/definitions/ReputationOptions" - }, - "SendingOptions": { - "$ref": "#/definitions/SendingOptions" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - }, - "TrackingOptions": { - "$ref": "#/definitions/TrackingOptions" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::PinpointEmail::ConfigurationSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "DeliveryOptions": { + "additionalProperties": false, + "properties": { + "SendingPoolName": { + "type": "string" + } + }, + "type": "object" + }, + "ReputationOptions": { + "additionalProperties": false, + "properties": { + "ReputationMetricsEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "SendingOptions": { + "additionalProperties": false, + "properties": { + "SendingEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "TrackingOptions": { + "additionalProperties": false, + "properties": { + "CustomRedirectDomain": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::PinpointEmail::ConfigurationSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeliveryOptions": { + "$ref": "#/definitions/DeliveryOptions" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ReputationOptions": { + "$ref": "#/definitions/ReputationOptions" + }, + "SendingOptions": { + "$ref": "#/definitions/SendingOptions" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + }, + "TrackingOptions": { + "$ref": "#/definitions/TrackingOptions" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::PinpointEmail::ConfigurationSet" +} diff --git a/schema/aws-pinpointemail-configurationseteventdestination.json b/schema/aws-pinpointemail-configurationseteventdestination.json index 0410f37..82b6b19 100644 --- a/schema/aws-pinpointemail-configurationseteventdestination.json +++ b/schema/aws-pinpointemail-configurationseteventdestination.json @@ -1,136 +1,136 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigurationSetName", - "/properties/EventDestinationName" - ], - "definitions": { - "CloudWatchDestination": { - "additionalProperties": false, - "properties": { - "DimensionConfigurations": { - "items": { - "$ref": "#/definitions/DimensionConfiguration" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DimensionConfiguration": { - "additionalProperties": false, - "properties": { - "DefaultDimensionValue": { - "type": "string" - }, - "DimensionName": { - "type": "string" - }, - "DimensionValueSource": { - "type": "string" - } - }, - "required": [ - "DimensionValueSource", - "DefaultDimensionValue", - "DimensionName" - ], - "type": "object" - }, - "EventDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchDestination": { - "$ref": "#/definitions/CloudWatchDestination" - }, - "Enabled": { - "type": "boolean" - }, - "KinesisFirehoseDestination": { - "$ref": "#/definitions/KinesisFirehoseDestination" - }, - "MatchingEventTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PinpointDestination": { - "$ref": "#/definitions/PinpointDestination" - }, - "SnsDestination": { - "$ref": "#/definitions/SnsDestination" - } - }, - "required": [ - "MatchingEventTypes" - ], - "type": "object" - }, - "KinesisFirehoseDestination": { - "additionalProperties": false, - "properties": { - "DeliveryStreamArn": { - "type": "string" - }, - "IamRoleArn": { - "type": "string" - } - }, - "required": [ - "DeliveryStreamArn", - "IamRoleArn" - ], - "type": "object" - }, - "PinpointDestination": { - "additionalProperties": false, - "properties": { - "ApplicationArn": { - "type": "string" - } - }, - "type": "object" - }, - "SnsDestination": { - "additionalProperties": false, - "properties": { - "TopicArn": { - "type": "string" - } - }, - "required": [ - "TopicArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::PinpointEmail::ConfigurationSetEventDestination", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConfigurationSetName": { - "type": "string" - }, - "EventDestination": { - "$ref": "#/definitions/EventDestination" - }, - "EventDestinationName": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ConfigurationSetName", - "EventDestinationName" - ], - "typeName": "AWS::PinpointEmail::ConfigurationSetEventDestination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigurationSetName", + "/properties/EventDestinationName" + ], + "definitions": { + "CloudWatchDestination": { + "additionalProperties": false, + "properties": { + "DimensionConfigurations": { + "items": { + "$ref": "#/definitions/DimensionConfiguration" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DimensionConfiguration": { + "additionalProperties": false, + "properties": { + "DefaultDimensionValue": { + "type": "string" + }, + "DimensionName": { + "type": "string" + }, + "DimensionValueSource": { + "type": "string" + } + }, + "required": [ + "DimensionValueSource", + "DefaultDimensionValue", + "DimensionName" + ], + "type": "object" + }, + "EventDestination": { + "additionalProperties": false, + "properties": { + "CloudWatchDestination": { + "$ref": "#/definitions/CloudWatchDestination" + }, + "Enabled": { + "type": "boolean" + }, + "KinesisFirehoseDestination": { + "$ref": "#/definitions/KinesisFirehoseDestination" + }, + "MatchingEventTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PinpointDestination": { + "$ref": "#/definitions/PinpointDestination" + }, + "SnsDestination": { + "$ref": "#/definitions/SnsDestination" + } + }, + "required": [ + "MatchingEventTypes" + ], + "type": "object" + }, + "KinesisFirehoseDestination": { + "additionalProperties": false, + "properties": { + "DeliveryStreamArn": { + "type": "string" + }, + "IamRoleArn": { + "type": "string" + } + }, + "required": [ + "DeliveryStreamArn", + "IamRoleArn" + ], + "type": "object" + }, + "PinpointDestination": { + "additionalProperties": false, + "properties": { + "ApplicationArn": { + "type": "string" + } + }, + "type": "object" + }, + "SnsDestination": { + "additionalProperties": false, + "properties": { + "TopicArn": { + "type": "string" + } + }, + "required": [ + "TopicArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::PinpointEmail::ConfigurationSetEventDestination", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConfigurationSetName": { + "type": "string" + }, + "EventDestination": { + "$ref": "#/definitions/EventDestination" + }, + "EventDestinationName": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ConfigurationSetName", + "EventDestinationName" + ], + "typeName": "AWS::PinpointEmail::ConfigurationSetEventDestination" +} diff --git a/schema/aws-pinpointemail-dedicatedippool.json b/schema/aws-pinpointemail-dedicatedippool.json index 0ed8904..6483d93 100644 --- a/schema/aws-pinpointemail-dedicatedippool.json +++ b/schema/aws-pinpointemail-dedicatedippool.json @@ -1,43 +1,43 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PoolName" - ], - "definitions": { - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::PinpointEmail::DedicatedIpPool", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "PoolName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::PinpointEmail::DedicatedIpPool" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PoolName" + ], + "definitions": { + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::PinpointEmail::DedicatedIpPool", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "PoolName": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::PinpointEmail::DedicatedIpPool" +} diff --git a/schema/aws-pinpointemail-identity.json b/schema/aws-pinpointemail-identity.json index f0f41e7..d690496 100644 --- a/schema/aws-pinpointemail-identity.json +++ b/schema/aws-pinpointemail-identity.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "MailFromAttributes": { - "additionalProperties": false, - "properties": { - "BehaviorOnMxFailure": { - "type": "string" - }, - "MailFromDomain": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::PinpointEmail::Identity", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DkimSigningEnabled": { - "type": "boolean" - }, - "FeedbackForwardingEnabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "IdentityDNSRecordName1": { - "type": "string" - }, - "IdentityDNSRecordName2": { - "type": "string" - }, - "IdentityDNSRecordName3": { - "type": "string" - }, - "IdentityDNSRecordValue1": { - "type": "string" - }, - "IdentityDNSRecordValue2": { - "type": "string" - }, - "IdentityDNSRecordValue3": { - "type": "string" - }, - "MailFromAttributes": { - "$ref": "#/definitions/MailFromAttributes" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tags" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/IdentityDNSRecordName1", - "/properties/IdentityDNSRecordValue1", - "/properties/IdentityDNSRecordName3", - "/properties/IdentityDNSRecordValue2", - "/properties/IdentityDNSRecordName2", - "/properties/IdentityDNSRecordValue3", - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::PinpointEmail::Identity" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "MailFromAttributes": { + "additionalProperties": false, + "properties": { + "BehaviorOnMxFailure": { + "type": "string" + }, + "MailFromDomain": { + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::PinpointEmail::Identity", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DkimSigningEnabled": { + "type": "boolean" + }, + "FeedbackForwardingEnabled": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "IdentityDNSRecordName1": { + "type": "string" + }, + "IdentityDNSRecordName2": { + "type": "string" + }, + "IdentityDNSRecordName3": { + "type": "string" + }, + "IdentityDNSRecordValue1": { + "type": "string" + }, + "IdentityDNSRecordValue2": { + "type": "string" + }, + "IdentityDNSRecordValue3": { + "type": "string" + }, + "MailFromAttributes": { + "$ref": "#/definitions/MailFromAttributes" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tags" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/IdentityDNSRecordName1", + "/properties/IdentityDNSRecordValue1", + "/properties/IdentityDNSRecordName3", + "/properties/IdentityDNSRecordValue2", + "/properties/IdentityDNSRecordName2", + "/properties/IdentityDNSRecordValue3", + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::PinpointEmail::Identity" +} diff --git a/schema/aws-pipes-pipe.json b/schema/aws-pipes-pipe.json index 1a1dc6e..6c95f9f 100644 --- a/schema/aws-pipes-pipe.json +++ b/schema/aws-pipes-pipe.json @@ -1,1907 +1,1928 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Arn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Source", - "/properties/SourceParameters/DynamoDBStreamParameters/StartingPosition", - "/properties/SourceParameters/KinesisStreamParameters/StartingPosition", - "/properties/SourceParameters/KinesisStreamParameters/StartingPositionTimestamp", - "/properties/SourceParameters/ActiveMQBrokerParameters/QueueName", - "/properties/SourceParameters/RabbitMQBrokerParameters/QueueName", - "/properties/SourceParameters/RabbitMQBrokerParameters/VirtualHost", - "/properties/SourceParameters/ManagedStreamingKafkaParameters/TopicName", - "/properties/SourceParameters/ManagedStreamingKafkaParameters/StartingPosition", - "/properties/SourceParameters/ManagedStreamingKafkaParameters/ConsumerGroupID", - "/properties/SourceParameters/SelfManagedApacheKafkaParameters/TopicName", - "/properties/SourceParameters/SelfManagedApacheKafkaParameters/StartingPosition", - "/properties/SourceParameters/SelfManagedApacheKafkaParameters/AdditionalBootstrapServers", - "/properties/SourceParameters/SelfManagedApacheKafkaParameters/ConsumerGroupID" - ], - "definitions": { - "AssignPublicIp": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "AwsVpcConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "$ref": "#/definitions/AssignPublicIp" - }, - "SecurityGroups": { - "items": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^sg-[0-9a-zA-Z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Subnets": { - "items": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^subnet-[0-9a-z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "maxItems": 16, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Subnets" - ], - "type": "object" - }, - "BatchArrayProperties": { - "additionalProperties": false, - "properties": { - "Size": { - "default": 0, - "maximum": 10000, - "minimum": 2, - "type": "integer" - } - }, - "type": "object" - }, - "BatchContainerOverrides": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "items": { - "$ref": "#/definitions/BatchEnvironmentVariable" - }, - "type": "array" - }, - "InstanceType": { - "type": "string" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/BatchResourceRequirement" - }, - "type": "array" - } - }, - "type": "object" - }, - "BatchEnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "BatchJobDependency": { - "additionalProperties": false, - "properties": { - "JobId": { - "type": "string" - }, - "Type": { - "$ref": "#/definitions/BatchJobDependencyType" - } - }, - "type": "object" - }, - "BatchJobDependencyType": { - "enum": [ - "N_TO_N", - "SEQUENTIAL" - ], - "type": "string" - }, - "BatchParametersMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - }, - "BatchResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/BatchResourceRequirementType" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "BatchResourceRequirementType": { - "enum": [ - "GPU", - "MEMORY", - "VCPU" - ], - "type": "string" - }, - "BatchRetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "default": 0, - "maximum": 10, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "CapacityProviderStrategyItem": { - "additionalProperties": false, - "properties": { - "Base": { - "default": 0, - "maximum": 100000, - "minimum": 0, - "type": "integer" - }, - "CapacityProvider": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Weight": { - "default": 0, - "maximum": 1000, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "CapacityProvider" - ], - "type": "object" - }, - "CloudwatchLogsLogDestination": { - "additionalProperties": false, - "properties": { - "LogGroupArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:.+)$", - "type": "string" - } - }, - "type": "object" - }, - "DeadLetterConfig": { - "additionalProperties": false, - "properties": { - "Arn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", - "type": "string" - } - }, - "type": "object" - }, - "DimensionMapping": { - "additionalProperties": false, - "properties": { - "DimensionName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "DimensionValue": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DimensionValueType": { - "$ref": "#/definitions/DimensionValueType" - } - }, - "required": [ - "DimensionName", - "DimensionValue", - "DimensionValueType" - ], - "type": "object" - }, - "DimensionValueType": { - "enum": [ - "VARCHAR" - ], - "type": "string" - }, - "DynamoDBStreamStartPosition": { - "enum": [ - "TRIM_HORIZON", - "LATEST" - ], - "type": "string" - }, - "EcsContainerOverride": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Cpu": { - "type": "integer" - }, - "Environment": { - "items": { - "$ref": "#/definitions/EcsEnvironmentVariable" - }, - "type": "array" - }, - "EnvironmentFiles": { - "items": { - "$ref": "#/definitions/EcsEnvironmentFile" - }, - "type": "array" - }, - "Memory": { - "type": "integer" - }, - "MemoryReservation": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/EcsResourceRequirement" - }, - "type": "array" - } - }, - "type": "object" - }, - "EcsEnvironmentFile": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/EcsEnvironmentFileType" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "EcsEnvironmentFileType": { - "enum": [ - "s3" - ], - "type": "string" - }, - "EcsEnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "EcsEphemeralStorage": { - "additionalProperties": false, - "properties": { - "SizeInGiB": { - "default": 0, - "maximum": 200, - "minimum": 21, - "type": "integer" - } - }, - "required": [ - "SizeInGiB" - ], - "type": "object" - }, - "EcsInferenceAcceleratorOverride": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "DeviceType": { - "type": "string" - } - }, - "type": "object" - }, - "EcsResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/EcsResourceRequirementType" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "EcsResourceRequirementType": { - "enum": [ - "GPU", - "InferenceAccelerator" - ], - "type": "string" - }, - "EcsTaskOverride": { - "additionalProperties": false, - "properties": { - "ContainerOverrides": { - "items": { - "$ref": "#/definitions/EcsContainerOverride" - }, - "type": "array" - }, - "Cpu": { - "type": "string" - }, - "EphemeralStorage": { - "$ref": "#/definitions/EcsEphemeralStorage" - }, - "ExecutionRoleArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "InferenceAcceleratorOverrides": { - "items": { - "$ref": "#/definitions/EcsInferenceAcceleratorOverride" - }, - "type": "array" - }, - "Memory": { - "type": "string" - }, - "TaskRoleArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - } - }, - "type": "object" - }, - "EpochTimeUnit": { - "enum": [ - "MILLISECONDS", - "SECONDS", - "MICROSECONDS", - "NANOSECONDS" - ], - "type": "string" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "Pattern": { - "maxLength": 4096, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "FilterCriteria": { - "additionalProperties": false, - "properties": { - "Filters": { - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FirehoseLogDestination": { - "additionalProperties": false, - "properties": { - "DeliveryStreamArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/.+)$", - "type": "string" - } - }, - "type": "object" - }, - "HeaderParametersMap": { - "additionalProperties": false, - "patternProperties": { - "^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$": { - "maxLength": 512, - "minLength": 0, - "pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - } - }, - "type": "object" - }, - "IncludeExecutionDataOption": { - "enum": [ - "ALL" - ], - "type": "string" - }, - "KinesisStreamStartPosition": { - "enum": [ - "TRIM_HORIZON", - "LATEST", - "AT_TIMESTAMP" - ], - "type": "string" - }, - "LaunchType": { - "enum": [ - "EC2", - "FARGATE", - "EXTERNAL" - ], - "type": "string" - }, - "LogLevel": { - "enum": [ - "OFF", - "ERROR", - "INFO", - "TRACE" - ], - "type": "string" - }, - "MQBrokerAccessCredentials": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "BasicAuth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "BasicAuth" - ], - "title": "BasicAuth", - "type": "object" - } - ] - }, - "MSKAccessCredentials": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "SaslScram512Auth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "SaslScram512Auth" - ], - "title": "SaslScram512Auth", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ClientCertificateTlsAuth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "ClientCertificateTlsAuth" - ], - "title": "ClientCertificateTlsAuth", - "type": "object" - } - ] - }, - "MSKStartPosition": { - "enum": [ - "TRIM_HORIZON", - "LATEST" - ], - "type": "string" - }, - "MeasureValueType": { - "enum": [ - "DOUBLE", - "BIGINT", - "VARCHAR", - "BOOLEAN", - "TIMESTAMP" - ], - "type": "string" - }, - "MultiMeasureAttributeMapping": { - "additionalProperties": false, - "properties": { - "MeasureValue": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "MeasureValueType": { - "$ref": "#/definitions/MeasureValueType" - }, - "MultiMeasureAttributeName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MeasureValue", - "MeasureValueType", - "MultiMeasureAttributeName" - ], - "type": "object" - }, - "MultiMeasureMapping": { - "additionalProperties": false, - "properties": { - "MultiMeasureAttributeMappings": { - "items": { - "$ref": "#/definitions/MultiMeasureAttributeMapping" - }, - "maxItems": 256, - "minItems": 1, - "type": "array" - }, - "MultiMeasureName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MultiMeasureAttributeMappings", - "MultiMeasureName" - ], - "type": "object" - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AwsvpcConfiguration": { - "$ref": "#/definitions/AwsVpcConfiguration" - } - }, - "type": "object" - }, - "OnPartialBatchItemFailureStreams": { - "enum": [ - "AUTOMATIC_BISECT" - ], - "type": "string" - }, - "PipeEnrichmentHttpParameters": { - "additionalProperties": false, - "properties": { - "HeaderParameters": { - "$ref": "#/definitions/HeaderParametersMap" - }, - "PathParameterValues": { - "items": { - "pattern": "^(?!\\s*$).+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "type": "array" - }, - "QueryStringParameters": { - "$ref": "#/definitions/QueryStringParametersMap" - } - }, - "type": "object" - }, - "PipeEnrichmentParameters": { - "additionalProperties": false, - "properties": { - "HttpParameters": { - "$ref": "#/definitions/PipeEnrichmentHttpParameters" - }, - "InputTemplate": { - "maxLength": 8192, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "PipeLogConfiguration": { - "additionalProperties": false, - "properties": { - "CloudwatchLogsLogDestination": { - "$ref": "#/definitions/CloudwatchLogsLogDestination" - }, - "FirehoseLogDestination": { - "$ref": "#/definitions/FirehoseLogDestination" - }, - "IncludeExecutionData": { - "items": { - "$ref": "#/definitions/IncludeExecutionDataOption" - }, - "type": "array", - "uniqueItems": true - }, - "Level": { - "$ref": "#/definitions/LogLevel" - }, - "S3LogDestination": { - "$ref": "#/definitions/S3LogDestination" - } - }, - "type": "object" - }, - "PipeSourceActiveMQBrokerParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "Credentials": { - "$ref": "#/definitions/MQBrokerAccessCredentials" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "QueueName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "required": [ - "Credentials", - "QueueName" - ], - "type": "object" - }, - "PipeSourceDynamoDBStreamParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/DeadLetterConfig" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "MaximumRecordAgeInSeconds": { - "maximum": 604800, - "minimum": -1, - "type": "integer" - }, - "MaximumRetryAttempts": { - "maximum": 10000, - "minimum": -1, - "type": "integer" - }, - "OnPartialBatchItemFailure": { - "$ref": "#/definitions/OnPartialBatchItemFailureStreams" - }, - "ParallelizationFactor": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "StartingPosition": { - "$ref": "#/definitions/DynamoDBStreamStartPosition" - } - }, - "required": [ - "StartingPosition" - ], - "type": "object" - }, - "PipeSourceKinesisStreamParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/DeadLetterConfig" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "MaximumRecordAgeInSeconds": { - "maximum": 604800, - "minimum": -1, - "type": "integer" - }, - "MaximumRetryAttempts": { - "maximum": 10000, - "minimum": -1, - "type": "integer" - }, - "OnPartialBatchItemFailure": { - "$ref": "#/definitions/OnPartialBatchItemFailureStreams" - }, - "ParallelizationFactor": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "StartingPosition": { - "$ref": "#/definitions/KinesisStreamStartPosition" - }, - "StartingPositionTimestamp": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "StartingPosition" - ], - "type": "object" - }, - "PipeSourceManagedStreamingKafkaParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "ConsumerGroupID": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", - "type": "string" - }, - "Credentials": { - "$ref": "#/definitions/MSKAccessCredentials" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "StartingPosition": { - "$ref": "#/definitions/MSKStartPosition" - }, - "TopicName": { - "maxLength": 249, - "minLength": 1, - "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", - "type": "string" - } - }, - "required": [ - "TopicName" - ], - "type": "object" - }, - "PipeSourceParameters": { - "additionalProperties": false, - "properties": { - "ActiveMQBrokerParameters": { - "$ref": "#/definitions/PipeSourceActiveMQBrokerParameters" - }, - "DynamoDBStreamParameters": { - "$ref": "#/definitions/PipeSourceDynamoDBStreamParameters" - }, - "FilterCriteria": { - "$ref": "#/definitions/FilterCriteria" - }, - "KinesisStreamParameters": { - "$ref": "#/definitions/PipeSourceKinesisStreamParameters" - }, - "ManagedStreamingKafkaParameters": { - "$ref": "#/definitions/PipeSourceManagedStreamingKafkaParameters" - }, - "RabbitMQBrokerParameters": { - "$ref": "#/definitions/PipeSourceRabbitMQBrokerParameters" - }, - "SelfManagedKafkaParameters": { - "$ref": "#/definitions/PipeSourceSelfManagedKafkaParameters" - }, - "SqsQueueParameters": { - "$ref": "#/definitions/PipeSourceSqsQueueParameters" - } - }, - "type": "object" - }, - "PipeSourceRabbitMQBrokerParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "Credentials": { - "$ref": "#/definitions/MQBrokerAccessCredentials" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "QueueName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "VirtualHost": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", - "type": "string" - } - }, - "required": [ - "Credentials", - "QueueName" - ], - "type": "object" - }, - "PipeSourceSelfManagedKafkaParameters": { - "additionalProperties": false, - "properties": { - "AdditionalBootstrapServers": { - "items": { - "maxLength": 300, - "minLength": 1, - "pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$", - "type": "string" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "ConsumerGroupID": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", - "type": "string" - }, - "Credentials": { - "$ref": "#/definitions/SelfManagedKafkaAccessConfigurationCredentials" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "ServerRootCaCertificate": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - }, - "StartingPosition": { - "$ref": "#/definitions/SelfManagedKafkaStartPosition" - }, - "TopicName": { - "maxLength": 249, - "minLength": 1, - "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", - "type": "string" - }, - "Vpc": { - "$ref": "#/definitions/SelfManagedKafkaAccessConfigurationVpc" - } - }, - "required": [ - "TopicName" - ], - "type": "object" - }, - "PipeSourceSqsQueueParameters": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "maximum": 10000, - "minimum": 1, - "type": "integer" - }, - "MaximumBatchingWindowInSeconds": { - "maximum": 300, - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "PipeState": { - "enum": [ - "RUNNING", - "STOPPED", - "CREATING", - "UPDATING", - "DELETING", - "STARTING", - "STOPPING", - "CREATE_FAILED", - "UPDATE_FAILED", - "START_FAILED", - "STOP_FAILED", - "DELETE_FAILED", - "CREATE_ROLLBACK_FAILED", - "DELETE_ROLLBACK_FAILED", - "UPDATE_ROLLBACK_FAILED" - ], - "type": "string" - }, - "PipeTargetBatchJobParameters": { - "additionalProperties": false, - "properties": { - "ArrayProperties": { - "$ref": "#/definitions/BatchArrayProperties" - }, - "ContainerOverrides": { - "$ref": "#/definitions/BatchContainerOverrides" - }, - "DependsOn": { - "items": { - "$ref": "#/definitions/BatchJobDependency" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "JobDefinition": { - "type": "string" - }, - "JobName": { - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/BatchParametersMap" - }, - "RetryStrategy": { - "$ref": "#/definitions/BatchRetryStrategy" - } - }, - "required": [ - "JobDefinition", - "JobName" - ], - "type": "object" - }, - "PipeTargetCloudWatchLogsParameters": { - "additionalProperties": false, - "properties": { - "LogStreamName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Timestamp": { - "maxLength": 256, - "minLength": 1, - "pattern": "^\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*$", - "type": "string" - } - }, - "type": "object" - }, - "PipeTargetEcsTaskParameters": { - "additionalProperties": false, - "properties": { - "CapacityProviderStrategy": { - "items": { - "$ref": "#/definitions/CapacityProviderStrategyItem" - }, - "maxItems": 6, - "minItems": 0, - "type": "array" - }, - "EnableECSManagedTags": { - "default": false, - "type": "boolean" - }, - "EnableExecuteCommand": { - "default": false, - "type": "boolean" - }, - "Group": { - "type": "string" - }, - "LaunchType": { - "$ref": "#/definitions/LaunchType" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" - }, - "Overrides": { - "$ref": "#/definitions/EcsTaskOverride" - }, - "PlacementConstraints": { - "items": { - "$ref": "#/definitions/PlacementConstraint" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "PlacementStrategy": { - "items": { - "$ref": "#/definitions/PlacementStrategy" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "PlatformVersion": { - "type": "string" - }, - "PropagateTags": { - "$ref": "#/definitions/PropagateTags" - }, - "ReferenceId": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskCount": { - "minimum": 1, - "type": "integer" - }, - "TaskDefinitionArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - } - }, - "required": [ - "TaskDefinitionArn" - ], - "type": "object" - }, - "PipeTargetEventBridgeEventBusParameters": { - "additionalProperties": false, - "properties": { - "DetailType": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "EndpointId": { - "maxLength": 50, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$", - "type": "string" - }, - "Resources": { - "items": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Source": { - "maxLength": 256, - "minLength": 1, - "pattern": "(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", - "type": "string" - }, - "Time": { - "maxLength": 256, - "minLength": 1, - "pattern": "^\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*$", - "type": "string" - } - }, - "type": "object" - }, - "PipeTargetHttpParameters": { - "additionalProperties": false, - "properties": { - "HeaderParameters": { - "$ref": "#/definitions/HeaderParametersMap" - }, - "PathParameterValues": { - "items": { - "pattern": "^(?!\\s*$).+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "type": "array" - }, - "QueryStringParameters": { - "$ref": "#/definitions/QueryStringParametersMap" - } - }, - "type": "object" - }, - "PipeTargetInvocationType": { - "enum": [ - "REQUEST_RESPONSE", - "FIRE_AND_FORGET" - ], - "type": "string" - }, - "PipeTargetKinesisStreamParameters": { - "additionalProperties": false, - "properties": { - "PartitionKey": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "PartitionKey" - ], - "type": "object" - }, - "PipeTargetLambdaFunctionParameters": { - "additionalProperties": false, - "properties": { - "InvocationType": { - "$ref": "#/definitions/PipeTargetInvocationType" - } - }, - "type": "object" - }, - "PipeTargetParameters": { - "additionalProperties": false, - "properties": { - "BatchJobParameters": { - "$ref": "#/definitions/PipeTargetBatchJobParameters" - }, - "CloudWatchLogsParameters": { - "$ref": "#/definitions/PipeTargetCloudWatchLogsParameters" - }, - "EcsTaskParameters": { - "$ref": "#/definitions/PipeTargetEcsTaskParameters" - }, - "EventBridgeEventBusParameters": { - "$ref": "#/definitions/PipeTargetEventBridgeEventBusParameters" - }, - "HttpParameters": { - "$ref": "#/definitions/PipeTargetHttpParameters" - }, - "InputTemplate": { - "maxLength": 8192, - "minLength": 0, - "type": "string" - }, - "KinesisStreamParameters": { - "$ref": "#/definitions/PipeTargetKinesisStreamParameters" - }, - "LambdaFunctionParameters": { - "$ref": "#/definitions/PipeTargetLambdaFunctionParameters" - }, - "RedshiftDataParameters": { - "$ref": "#/definitions/PipeTargetRedshiftDataParameters" - }, - "SageMakerPipelineParameters": { - "$ref": "#/definitions/PipeTargetSageMakerPipelineParameters" - }, - "SqsQueueParameters": { - "$ref": "#/definitions/PipeTargetSqsQueueParameters" - }, - "StepFunctionStateMachineParameters": { - "$ref": "#/definitions/PipeTargetStateMachineParameters" - }, - "TimestreamParameters": { - "$ref": "#/definitions/PipeTargetTimestreamParameters" - } - }, - "type": "object" - }, - "PipeTargetRedshiftDataParameters": { - "additionalProperties": false, - "properties": { - "Database": { - "description": "Redshift Database", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "DbUser": { - "description": "Database user name", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SecretManagerArn": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "Sqls": { - "description": "A list of SQLs.", - "items": { - "description": "A single Redshift SQL", - "maxLength": 100000, - "minLength": 1, - "type": "string" - }, - "maxItems": 40, - "minItems": 1, - "type": "array" - }, - "StatementName": { - "description": "A name for Redshift DataAPI statement which can be used as filter of ListStatement.", - "maxLength": 500, - "minLength": 1, - "type": "string" - }, - "WithEvent": { - "default": false, - "type": "boolean" - } - }, - "required": [ - "Database", - "Sqls" - ], - "type": "object" - }, - "PipeTargetSageMakerPipelineParameters": { - "additionalProperties": false, - "properties": { - "PipelineParameterList": { - "items": { - "$ref": "#/definitions/SageMakerPipelineParameter" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PipeTargetSqsQueueParameters": { - "additionalProperties": false, - "properties": { - "MessageDeduplicationId": { - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "MessageGroupId": { - "maxLength": 100, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "PipeTargetStateMachineParameters": { - "additionalProperties": false, - "properties": { - "InvocationType": { - "$ref": "#/definitions/PipeTargetInvocationType" - } - }, - "type": "object" - }, - "PipeTargetTimestreamParameters": { - "additionalProperties": false, - "properties": { - "DimensionMappings": { - "items": { - "$ref": "#/definitions/DimensionMapping" - }, - "maxItems": 128, - "minItems": 1, - "type": "array" - }, - "EpochTimeUnit": { - "$ref": "#/definitions/EpochTimeUnit" - }, - "MultiMeasureMappings": { - "items": { - "$ref": "#/definitions/MultiMeasureMapping" - }, - "maxItems": 1024, - "minItems": 0, - "type": "array" - }, - "SingleMeasureMappings": { - "items": { - "$ref": "#/definitions/SingleMeasureMapping" - }, - "maxItems": 8192, - "minItems": 0, - "type": "array" - }, - "TimeFieldType": { - "$ref": "#/definitions/TimeFieldType" - }, - "TimeValue": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "TimestampFormat": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "VersionValue": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DimensionMappings", - "TimeValue", - "VersionValue" - ], - "type": "object" - }, - "PlacementConstraint": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 2000, - "minLength": 0, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/PlacementConstraintType" - } - }, - "type": "object" - }, - "PlacementConstraintType": { - "enum": [ - "distinctInstance", - "memberOf" - ], - "type": "string" - }, - "PlacementStrategy": { - "additionalProperties": false, - "properties": { - "Field": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/PlacementStrategyType" - } - }, - "type": "object" - }, - "PlacementStrategyType": { - "enum": [ - "random", - "spread", - "binpack" - ], - "type": "string" - }, - "PropagateTags": { - "enum": [ - "TASK_DEFINITION" - ], - "type": "string" - }, - "QueryStringParametersMap": { - "additionalProperties": false, - "patternProperties": { - "^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$": { - "maxLength": 512, - "minLength": 0, - "pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - } - }, - "type": "object" - }, - "RequestedPipeState": { - "enum": [ - "RUNNING", - "STOPPED" - ], - "type": "string" - }, - "S3LogDestination": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketOwner": { - "type": "string" - }, - "OutputFormat": { - "$ref": "#/definitions/S3OutputFormat" - }, - "Prefix": { - "type": "string" - } - }, - "type": "object" - }, - "S3OutputFormat": { - "enum": [ - "json", - "plain", - "w3c" - ], - "type": "string" - }, - "SageMakerPipelineParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", - "type": "string" - }, - "Value": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "SelfManagedKafkaAccessConfigurationCredentials": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "BasicAuth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "BasicAuth" - ], - "title": "BasicAuth", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "SaslScram512Auth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "SaslScram512Auth" - ], - "title": "SaslScram512Auth", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "SaslScram256Auth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "SaslScram256Auth" - ], - "title": "SaslScram256Auth", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ClientCertificateTlsAuth": { - "description": "Optional SecretManager ARN which stores the database credentials", - "maxLength": 1600, - "minLength": 1, - "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", - "type": "string" - } - }, - "required": [ - "ClientCertificateTlsAuth" - ], - "title": "ClientCertificateTlsAuth", - "type": "object" - } - ] - }, - "SelfManagedKafkaAccessConfigurationVpc": { - "additionalProperties": false, - "properties": { - "SecurityGroup": { - "description": "List of SecurityGroupId.", - "items": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^sg-[0-9a-zA-Z]*$", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "Subnets": { - "description": "List of SubnetId.", - "items": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^subnet-[0-9a-z]*$", - "type": "string" - }, - "maxItems": 16, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SelfManagedKafkaStartPosition": { - "enum": [ - "TRIM_HORIZON", - "LATEST" - ], - "type": "string" - }, - "SingleMeasureMapping": { - "additionalProperties": false, - "properties": { - "MeasureName": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "MeasureValue": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "MeasureValueType": { - "$ref": "#/definitions/MeasureValueType" - } - }, - "required": [ - "MeasureName", - "MeasureValue", - "MeasureValueType" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "maxProperties": 50, - "minProperties": 1, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TimeFieldType": { - "enum": [ - "EPOCH", - "TIMESTAMP_FORMAT" - ], - "type": "string" - } - }, - "description": "Definition of AWS::Pipes::Pipe Resource Type", - "handlers": { - "create": { - "permissions": [ - "pipes:CreatePipe", - "pipes:DescribePipe", - "pipes:TagResource", - "iam:PassRole", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "iam:CreateServiceLinkedRole", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "firehose:TagDeliveryStream" - ] - }, - "delete": { - "permissions": [ - "pipes:DeletePipe", - "pipes:DescribePipe", - "logs:CreateLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries" - ] - }, - "list": { - "permissions": [ - "pipes:ListPipes" - ] - }, - "read": { - "permissions": [ - "pipes:DescribePipe" - ] - }, - "update": { - "permissions": [ - "pipes:UpdatePipe", - "pipes:TagResource", - "pipes:UntagResource", - "pipes:DescribePipe", - "iam:PassRole", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "iam:CreateServiceLinkedRole", - "logs:CreateLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "firehose:TagDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)$", - "type": "string" - }, - "CreationTime": { - "format": "date-time", - "type": "string" - }, - "CurrentState": { - "$ref": "#/definitions/PipeState" - }, - "Description": { - "maxLength": 512, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - }, - "DesiredState": { - "$ref": "#/definitions/RequestedPipeState" - }, - "Enrichment": { - "maxLength": 1600, - "minLength": 0, - "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", - "type": "string" - }, - "EnrichmentParameters": { - "$ref": "#/definitions/PipeEnrichmentParameters" - }, - "LastModifiedTime": { - "format": "date-time", - "type": "string" - }, - "LogConfiguration": { - "$ref": "#/definitions/PipeLogConfiguration" - }, - "Name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\.\\-_A-Za-z0-9]+$", - "type": "string" - }, - "RoleArn": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Source": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", - "type": "string" - }, - "SourceParameters": { - "$ref": "#/definitions/PipeSourceParameters" - }, - "StateReason": { - "maxLength": 512, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "Target": { - "maxLength": 1600, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", - "type": "string" - }, - "TargetParameters": { - "$ref": "#/definitions/PipeTargetParameters" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/CurrentState", - "/properties/LastModifiedTime", - "/properties/StateReason" - ], - "required": [ - "RoleArn", - "Source", - "Target" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Pipes::Pipe", - "writeOnlyProperties": [ - "/properties/TargetParameters", - "/properties/SourceParameters" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Arn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Source", + "/properties/SourceParameters/DynamoDBStreamParameters/StartingPosition", + "/properties/SourceParameters/KinesisStreamParameters/StartingPosition", + "/properties/SourceParameters/KinesisStreamParameters/StartingPositionTimestamp", + "/properties/SourceParameters/ActiveMQBrokerParameters/QueueName", + "/properties/SourceParameters/RabbitMQBrokerParameters/QueueName", + "/properties/SourceParameters/RabbitMQBrokerParameters/VirtualHost", + "/properties/SourceParameters/ManagedStreamingKafkaParameters/TopicName", + "/properties/SourceParameters/ManagedStreamingKafkaParameters/StartingPosition", + "/properties/SourceParameters/ManagedStreamingKafkaParameters/ConsumerGroupID", + "/properties/SourceParameters/SelfManagedKafkaParameters/TopicName", + "/properties/SourceParameters/SelfManagedKafkaParameters/StartingPosition", + "/properties/SourceParameters/SelfManagedKafkaParameters/AdditionalBootstrapServers", + "/properties/SourceParameters/SelfManagedKafkaParameters/ConsumerGroupID" + ], + "definitions": { + "AssignPublicIp": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "AwsVpcConfiguration": { + "additionalProperties": false, + "properties": { + "AssignPublicIp": { + "$ref": "#/definitions/AssignPublicIp" + }, + "SecurityGroups": { + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^sg-[0-9a-zA-Z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Subnets": { + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "maxItems": 16, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Subnets" + ], + "type": "object" + }, + "BatchArrayProperties": { + "additionalProperties": false, + "properties": { + "Size": { + "default": 0, + "maximum": 10000, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "BatchContainerOverrides": { + "additionalProperties": false, + "properties": { + "Command": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Environment": { + "items": { + "$ref": "#/definitions/BatchEnvironmentVariable" + }, + "type": "array" + }, + "InstanceType": { + "type": "string" + }, + "ResourceRequirements": { + "items": { + "$ref": "#/definitions/BatchResourceRequirement" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchEnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "BatchJobDependency": { + "additionalProperties": false, + "properties": { + "JobId": { + "type": "string" + }, + "Type": { + "$ref": "#/definitions/BatchJobDependencyType" + } + }, + "type": "object" + }, + "BatchJobDependencyType": { + "enum": [ + "N_TO_N", + "SEQUENTIAL" + ], + "type": "string" + }, + "BatchParametersMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "BatchResourceRequirement": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/BatchResourceRequirementType" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "BatchResourceRequirementType": { + "enum": [ + "GPU", + "MEMORY", + "VCPU" + ], + "type": "string" + }, + "BatchRetryStrategy": { + "additionalProperties": false, + "properties": { + "Attempts": { + "default": 0, + "maximum": 10, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "CapacityProviderStrategyItem": { + "additionalProperties": false, + "properties": { + "Base": { + "default": 0, + "maximum": 100000, + "minimum": 0, + "type": "integer" + }, + "CapacityProvider": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Weight": { + "default": 0, + "maximum": 1000, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "CapacityProvider" + ], + "type": "object" + }, + "CloudwatchLogsLogDestination": { + "additionalProperties": false, + "properties": { + "LogGroupArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:.+)$", + "type": "string" + } + }, + "type": "object" + }, + "DeadLetterConfig": { + "additionalProperties": false, + "properties": { + "Arn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", + "type": "string" + } + }, + "type": "object" + }, + "DimensionMapping": { + "additionalProperties": false, + "properties": { + "DimensionName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DimensionValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DimensionValueType": { + "$ref": "#/definitions/DimensionValueType" + } + }, + "required": [ + "DimensionName", + "DimensionValue", + "DimensionValueType" + ], + "type": "object" + }, + "DimensionValueType": { + "enum": [ + "VARCHAR" + ], + "type": "string" + }, + "DynamoDBStreamStartPosition": { + "enum": [ + "TRIM_HORIZON", + "LATEST" + ], + "type": "string" + }, + "EcsContainerOverride": { + "additionalProperties": false, + "properties": { + "Command": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Cpu": { + "type": "integer" + }, + "Environment": { + "items": { + "$ref": "#/definitions/EcsEnvironmentVariable" + }, + "type": "array" + }, + "EnvironmentFiles": { + "items": { + "$ref": "#/definitions/EcsEnvironmentFile" + }, + "type": "array" + }, + "Memory": { + "type": "integer" + }, + "MemoryReservation": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "ResourceRequirements": { + "items": { + "$ref": "#/definitions/EcsResourceRequirement" + }, + "type": "array" + } + }, + "type": "object" + }, + "EcsEnvironmentFile": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/EcsEnvironmentFileType" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "EcsEnvironmentFileType": { + "enum": [ + "s3" + ], + "type": "string" + }, + "EcsEnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "EcsEphemeralStorage": { + "additionalProperties": false, + "properties": { + "SizeInGiB": { + "default": 0, + "maximum": 200, + "minimum": 21, + "type": "integer" + } + }, + "required": [ + "SizeInGiB" + ], + "type": "object" + }, + "EcsInferenceAcceleratorOverride": { + "additionalProperties": false, + "properties": { + "DeviceName": { + "type": "string" + }, + "DeviceType": { + "type": "string" + } + }, + "type": "object" + }, + "EcsResourceRequirement": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/EcsResourceRequirementType" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "EcsResourceRequirementType": { + "enum": [ + "GPU", + "InferenceAccelerator" + ], + "type": "string" + }, + "EcsTaskOverride": { + "additionalProperties": false, + "properties": { + "ContainerOverrides": { + "items": { + "$ref": "#/definitions/EcsContainerOverride" + }, + "type": "array" + }, + "Cpu": { + "type": "string" + }, + "EphemeralStorage": { + "$ref": "#/definitions/EcsEphemeralStorage" + }, + "ExecutionRoleArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "InferenceAcceleratorOverrides": { + "items": { + "$ref": "#/definitions/EcsInferenceAcceleratorOverride" + }, + "type": "array" + }, + "Memory": { + "type": "string" + }, + "TaskRoleArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + } + }, + "type": "object" + }, + "EpochTimeUnit": { + "enum": [ + "MILLISECONDS", + "SECONDS", + "MICROSECONDS", + "NANOSECONDS" + ], + "type": "string" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "Pattern": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "FilterCriteria": { + "additionalProperties": false, + "properties": { + "Filters": { + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FirehoseLogDestination": { + "additionalProperties": false, + "properties": { + "DeliveryStreamArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/.+)$", + "type": "string" + } + }, + "type": "object" + }, + "HeaderParametersMap": { + "additionalProperties": false, + "patternProperties": { + "^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$": { + "maxLength": 512, + "minLength": 0, + "pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + } + }, + "type": "object" + }, + "IncludeExecutionDataOption": { + "enum": [ + "ALL" + ], + "type": "string" + }, + "KinesisStreamStartPosition": { + "enum": [ + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ], + "type": "string" + }, + "LaunchType": { + "enum": [ + "EC2", + "FARGATE", + "EXTERNAL" + ], + "type": "string" + }, + "LogLevel": { + "enum": [ + "OFF", + "ERROR", + "INFO", + "TRACE" + ], + "type": "string" + }, + "MQBrokerAccessCredentials": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "BasicAuth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "BasicAuth" + ], + "title": "BasicAuth", + "type": "object" + } + ] + }, + "MSKAccessCredentials": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SaslScram512Auth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "SaslScram512Auth" + ], + "title": "SaslScram512Auth", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ClientCertificateTlsAuth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "ClientCertificateTlsAuth" + ], + "title": "ClientCertificateTlsAuth", + "type": "object" + } + ] + }, + "MSKStartPosition": { + "enum": [ + "TRIM_HORIZON", + "LATEST" + ], + "type": "string" + }, + "MeasureValueType": { + "enum": [ + "DOUBLE", + "BIGINT", + "VARCHAR", + "BOOLEAN", + "TIMESTAMP" + ], + "type": "string" + }, + "MultiMeasureAttributeMapping": { + "additionalProperties": false, + "properties": { + "MeasureValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MeasureValueType": { + "$ref": "#/definitions/MeasureValueType" + }, + "MultiMeasureAttributeName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MeasureValue", + "MeasureValueType", + "MultiMeasureAttributeName" + ], + "type": "object" + }, + "MultiMeasureMapping": { + "additionalProperties": false, + "properties": { + "MultiMeasureAttributeMappings": { + "items": { + "$ref": "#/definitions/MultiMeasureAttributeMapping" + }, + "maxItems": 256, + "minItems": 1, + "type": "array" + }, + "MultiMeasureName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MultiMeasureAttributeMappings", + "MultiMeasureName" + ], + "type": "object" + }, + "NetworkConfiguration": { + "additionalProperties": false, + "properties": { + "AwsvpcConfiguration": { + "$ref": "#/definitions/AwsVpcConfiguration" + } + }, + "type": "object" + }, + "OnPartialBatchItemFailureStreams": { + "enum": [ + "AUTOMATIC_BISECT" + ], + "type": "string" + }, + "PipeEnrichmentHttpParameters": { + "additionalProperties": false, + "properties": { + "HeaderParameters": { + "$ref": "#/definitions/HeaderParametersMap" + }, + "PathParameterValues": { + "items": { + "pattern": "^(?!\\s*$).+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "type": "array" + }, + "QueryStringParameters": { + "$ref": "#/definitions/QueryStringParametersMap" + } + }, + "type": "object" + }, + "PipeEnrichmentParameters": { + "additionalProperties": false, + "properties": { + "HttpParameters": { + "$ref": "#/definitions/PipeEnrichmentHttpParameters" + }, + "InputTemplate": { + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "PipeLogConfiguration": { + "additionalProperties": false, + "properties": { + "CloudwatchLogsLogDestination": { + "$ref": "#/definitions/CloudwatchLogsLogDestination" + }, + "FirehoseLogDestination": { + "$ref": "#/definitions/FirehoseLogDestination" + }, + "IncludeExecutionData": { + "items": { + "$ref": "#/definitions/IncludeExecutionDataOption" + }, + "type": "array", + "uniqueItems": true + }, + "Level": { + "$ref": "#/definitions/LogLevel" + }, + "S3LogDestination": { + "$ref": "#/definitions/S3LogDestination" + } + }, + "type": "object" + }, + "PipeSourceActiveMQBrokerParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "Credentials": { + "$ref": "#/definitions/MQBrokerAccessCredentials" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "QueueName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "required": [ + "Credentials", + "QueueName" + ], + "type": "object" + }, + "PipeSourceDynamoDBStreamParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "DeadLetterConfig": { + "$ref": "#/definitions/DeadLetterConfig" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "MaximumRecordAgeInSeconds": { + "maximum": 604800, + "minimum": -1, + "type": "integer" + }, + "MaximumRetryAttempts": { + "maximum": 10000, + "minimum": -1, + "type": "integer" + }, + "OnPartialBatchItemFailure": { + "$ref": "#/definitions/OnPartialBatchItemFailureStreams" + }, + "ParallelizationFactor": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "StartingPosition": { + "$ref": "#/definitions/DynamoDBStreamStartPosition" + } + }, + "required": [ + "StartingPosition" + ], + "type": "object" + }, + "PipeSourceKinesisStreamParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "DeadLetterConfig": { + "$ref": "#/definitions/DeadLetterConfig" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "MaximumRecordAgeInSeconds": { + "maximum": 604800, + "minimum": -1, + "type": "integer" + }, + "MaximumRetryAttempts": { + "maximum": 10000, + "minimum": -1, + "type": "integer" + }, + "OnPartialBatchItemFailure": { + "$ref": "#/definitions/OnPartialBatchItemFailureStreams" + }, + "ParallelizationFactor": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "StartingPosition": { + "$ref": "#/definitions/KinesisStreamStartPosition" + }, + "StartingPositionTimestamp": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "StartingPosition" + ], + "type": "object" + }, + "PipeSourceManagedStreamingKafkaParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "ConsumerGroupID": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "type": "string" + }, + "Credentials": { + "$ref": "#/definitions/MSKAccessCredentials" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "StartingPosition": { + "$ref": "#/definitions/MSKStartPosition" + }, + "TopicName": { + "maxLength": 249, + "minLength": 1, + "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", + "type": "string" + } + }, + "required": [ + "TopicName" + ], + "type": "object" + }, + "PipeSourceParameters": { + "additionalProperties": false, + "properties": { + "ActiveMQBrokerParameters": { + "$ref": "#/definitions/PipeSourceActiveMQBrokerParameters" + }, + "DynamoDBStreamParameters": { + "$ref": "#/definitions/PipeSourceDynamoDBStreamParameters" + }, + "FilterCriteria": { + "$ref": "#/definitions/FilterCriteria" + }, + "KinesisStreamParameters": { + "$ref": "#/definitions/PipeSourceKinesisStreamParameters" + }, + "ManagedStreamingKafkaParameters": { + "$ref": "#/definitions/PipeSourceManagedStreamingKafkaParameters" + }, + "RabbitMQBrokerParameters": { + "$ref": "#/definitions/PipeSourceRabbitMQBrokerParameters" + }, + "SelfManagedKafkaParameters": { + "$ref": "#/definitions/PipeSourceSelfManagedKafkaParameters" + }, + "SqsQueueParameters": { + "$ref": "#/definitions/PipeSourceSqsQueueParameters" + } + }, + "type": "object" + }, + "PipeSourceRabbitMQBrokerParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "Credentials": { + "$ref": "#/definitions/MQBrokerAccessCredentials" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "QueueName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "VirtualHost": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "type": "string" + } + }, + "required": [ + "Credentials", + "QueueName" + ], + "type": "object" + }, + "PipeSourceSelfManagedKafkaParameters": { + "additionalProperties": false, + "properties": { + "AdditionalBootstrapServers": { + "items": { + "maxLength": 300, + "minLength": 1, + "pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$", + "type": "string" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "ConsumerGroupID": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "type": "string" + }, + "Credentials": { + "$ref": "#/definitions/SelfManagedKafkaAccessConfigurationCredentials" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "ServerRootCaCertificate": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + }, + "StartingPosition": { + "$ref": "#/definitions/SelfManagedKafkaStartPosition" + }, + "TopicName": { + "maxLength": 249, + "minLength": 1, + "pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", + "type": "string" + }, + "Vpc": { + "$ref": "#/definitions/SelfManagedKafkaAccessConfigurationVpc" + } + }, + "required": [ + "TopicName" + ], + "type": "object" + }, + "PipeSourceSqsQueueParameters": { + "additionalProperties": false, + "properties": { + "BatchSize": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "MaximumBatchingWindowInSeconds": { + "maximum": 300, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "PipeState": { + "enum": [ + "RUNNING", + "STOPPED", + "CREATING", + "UPDATING", + "DELETING", + "STARTING", + "STOPPING", + "CREATE_FAILED", + "UPDATE_FAILED", + "START_FAILED", + "STOP_FAILED", + "DELETE_FAILED", + "CREATE_ROLLBACK_FAILED", + "DELETE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_FAILED" + ], + "type": "string" + }, + "PipeTargetBatchJobParameters": { + "additionalProperties": false, + "properties": { + "ArrayProperties": { + "$ref": "#/definitions/BatchArrayProperties" + }, + "ContainerOverrides": { + "$ref": "#/definitions/BatchContainerOverrides" + }, + "DependsOn": { + "items": { + "$ref": "#/definitions/BatchJobDependency" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "JobDefinition": { + "type": "string" + }, + "JobName": { + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/BatchParametersMap" + }, + "RetryStrategy": { + "$ref": "#/definitions/BatchRetryStrategy" + } + }, + "required": [ + "JobDefinition", + "JobName" + ], + "type": "object" + }, + "PipeTargetCloudWatchLogsParameters": { + "additionalProperties": false, + "properties": { + "LogStreamName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Timestamp": { + "maxLength": 256, + "minLength": 1, + "pattern": "^\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*$", + "type": "string" + } + }, + "type": "object" + }, + "PipeTargetEcsTaskParameters": { + "additionalProperties": false, + "properties": { + "CapacityProviderStrategy": { + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "EnableECSManagedTags": { + "default": false, + "type": "boolean" + }, + "EnableExecuteCommand": { + "default": false, + "type": "boolean" + }, + "Group": { + "type": "string" + }, + "LaunchType": { + "$ref": "#/definitions/LaunchType" + }, + "NetworkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration" + }, + "Overrides": { + "$ref": "#/definitions/EcsTaskOverride" + }, + "PlacementConstraints": { + "items": { + "$ref": "#/definitions/PlacementConstraint" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "PlacementStrategy": { + "items": { + "$ref": "#/definitions/PlacementStrategy" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "PlatformVersion": { + "type": "string" + }, + "PropagateTags": { + "$ref": "#/definitions/PropagateTags" + }, + "ReferenceId": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TaskCount": { + "minimum": 1, + "type": "integer" + }, + "TaskDefinitionArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + } + }, + "required": [ + "TaskDefinitionArn" + ], + "type": "object" + }, + "PipeTargetEventBridgeEventBusParameters": { + "additionalProperties": false, + "properties": { + "DetailType": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "EndpointId": { + "maxLength": 50, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+$", + "type": "string" + }, + "Resources": { + "items": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Source": { + "maxLength": 256, + "minLength": 1, + "pattern": "(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)", + "type": "string" + }, + "Time": { + "maxLength": 256, + "minLength": 1, + "pattern": "^\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*$", + "type": "string" + } + }, + "type": "object" + }, + "PipeTargetHttpParameters": { + "additionalProperties": false, + "properties": { + "HeaderParameters": { + "$ref": "#/definitions/HeaderParametersMap" + }, + "PathParameterValues": { + "items": { + "pattern": "^(?!\\s*$).+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "type": "array" + }, + "QueryStringParameters": { + "$ref": "#/definitions/QueryStringParametersMap" + } + }, + "type": "object" + }, + "PipeTargetInvocationType": { + "enum": [ + "REQUEST_RESPONSE", + "FIRE_AND_FORGET" + ], + "type": "string" + }, + "PipeTargetKinesisStreamParameters": { + "additionalProperties": false, + "properties": { + "PartitionKey": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "PartitionKey" + ], + "type": "object" + }, + "PipeTargetLambdaFunctionParameters": { + "additionalProperties": false, + "properties": { + "InvocationType": { + "$ref": "#/definitions/PipeTargetInvocationType" + } + }, + "type": "object" + }, + "PipeTargetParameters": { + "additionalProperties": false, + "properties": { + "BatchJobParameters": { + "$ref": "#/definitions/PipeTargetBatchJobParameters" + }, + "CloudWatchLogsParameters": { + "$ref": "#/definitions/PipeTargetCloudWatchLogsParameters" + }, + "EcsTaskParameters": { + "$ref": "#/definitions/PipeTargetEcsTaskParameters" + }, + "EventBridgeEventBusParameters": { + "$ref": "#/definitions/PipeTargetEventBridgeEventBusParameters" + }, + "HttpParameters": { + "$ref": "#/definitions/PipeTargetHttpParameters" + }, + "InputTemplate": { + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "KinesisStreamParameters": { + "$ref": "#/definitions/PipeTargetKinesisStreamParameters" + }, + "LambdaFunctionParameters": { + "$ref": "#/definitions/PipeTargetLambdaFunctionParameters" + }, + "RedshiftDataParameters": { + "$ref": "#/definitions/PipeTargetRedshiftDataParameters" + }, + "SageMakerPipelineParameters": { + "$ref": "#/definitions/PipeTargetSageMakerPipelineParameters" + }, + "SqsQueueParameters": { + "$ref": "#/definitions/PipeTargetSqsQueueParameters" + }, + "StepFunctionStateMachineParameters": { + "$ref": "#/definitions/PipeTargetStateMachineParameters" + }, + "TimestreamParameters": { + "$ref": "#/definitions/PipeTargetTimestreamParameters" + } + }, + "type": "object" + }, + "PipeTargetRedshiftDataParameters": { + "additionalProperties": false, + "properties": { + "Database": { + "description": "Redshift Database", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "DbUser": { + "description": "Database user name", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SecretManagerArn": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "Sqls": { + "description": "A list of SQLs.", + "items": { + "description": "A single Redshift SQL", + "maxLength": 100000, + "minLength": 1, + "type": "string" + }, + "maxItems": 40, + "minItems": 1, + "type": "array" + }, + "StatementName": { + "description": "A name for Redshift DataAPI statement which can be used as filter of ListStatement.", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "WithEvent": { + "default": false, + "type": "boolean" + } + }, + "required": [ + "Database", + "Sqls" + ], + "type": "object" + }, + "PipeTargetSageMakerPipelineParameters": { + "additionalProperties": false, + "properties": { + "PipelineParameterList": { + "items": { + "$ref": "#/definitions/SageMakerPipelineParameter" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PipeTargetSqsQueueParameters": { + "additionalProperties": false, + "properties": { + "MessageDeduplicationId": { + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "MessageGroupId": { + "maxLength": 100, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "PipeTargetStateMachineParameters": { + "additionalProperties": false, + "properties": { + "InvocationType": { + "$ref": "#/definitions/PipeTargetInvocationType" + } + }, + "type": "object" + }, + "PipeTargetTimestreamParameters": { + "additionalProperties": false, + "properties": { + "DimensionMappings": { + "items": { + "$ref": "#/definitions/DimensionMapping" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + }, + "EpochTimeUnit": { + "$ref": "#/definitions/EpochTimeUnit" + }, + "MultiMeasureMappings": { + "items": { + "$ref": "#/definitions/MultiMeasureMapping" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "SingleMeasureMappings": { + "items": { + "$ref": "#/definitions/SingleMeasureMapping" + }, + "maxItems": 8192, + "minItems": 0, + "type": "array" + }, + "TimeFieldType": { + "$ref": "#/definitions/TimeFieldType" + }, + "TimeValue": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "TimestampFormat": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "VersionValue": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DimensionMappings", + "TimeValue", + "VersionValue" + ], + "type": "object" + }, + "PlacementConstraint": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 2000, + "minLength": 0, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/PlacementConstraintType" + } + }, + "type": "object" + }, + "PlacementConstraintType": { + "enum": [ + "distinctInstance", + "memberOf" + ], + "type": "string" + }, + "PlacementStrategy": { + "additionalProperties": false, + "properties": { + "Field": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/PlacementStrategyType" + } + }, + "type": "object" + }, + "PlacementStrategyType": { + "enum": [ + "random", + "spread", + "binpack" + ], + "type": "string" + }, + "PropagateTags": { + "enum": [ + "TASK_DEFINITION" + ], + "type": "string" + }, + "QueryStringParametersMap": { + "additionalProperties": false, + "patternProperties": { + "^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$": { + "maxLength": 512, + "minLength": 0, + "pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + } + }, + "type": "object" + }, + "RequestedPipeState": { + "enum": [ + "RUNNING", + "STOPPED" + ], + "type": "string" + }, + "S3LogDestination": { + "additionalProperties": false, + "properties": { + "BucketName": { + "type": "string" + }, + "BucketOwner": { + "type": "string" + }, + "OutputFormat": { + "$ref": "#/definitions/S3OutputFormat" + }, + "Prefix": { + "type": "string" + } + }, + "type": "object" + }, + "S3OutputFormat": { + "enum": [ + "json", + "plain", + "w3c" + ], + "type": "string" + }, + "SageMakerPipelineParameter": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$", + "type": "string" + }, + "Value": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "SelfManagedKafkaAccessConfigurationCredentials": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "BasicAuth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "BasicAuth" + ], + "title": "BasicAuth", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "SaslScram512Auth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "SaslScram512Auth" + ], + "title": "SaslScram512Auth", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "SaslScram256Auth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "SaslScram256Auth" + ], + "title": "SaslScram256Auth", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ClientCertificateTlsAuth": { + "description": "Optional SecretManager ARN which stores the database credentials", + "maxLength": 1600, + "minLength": 1, + "pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$", + "type": "string" + } + }, + "required": [ + "ClientCertificateTlsAuth" + ], + "title": "ClientCertificateTlsAuth", + "type": "object" + } + ] + }, + "SelfManagedKafkaAccessConfigurationVpc": { + "additionalProperties": false, + "properties": { + "SecurityGroup": { + "description": "List of SecurityGroupId.", + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^sg-[0-9a-zA-Z]*$", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Subnets": { + "description": "List of SubnetId.", + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*$", + "type": "string" + }, + "maxItems": 16, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SelfManagedKafkaStartPosition": { + "enum": [ + "TRIM_HORIZON", + "LATEST" + ], + "type": "string" + }, + "SingleMeasureMapping": { + "additionalProperties": false, + "properties": { + "MeasureName": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "MeasureValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MeasureValueType": { + "$ref": "#/definitions/MeasureValueType" + } + }, + "required": [ + "MeasureName", + "MeasureValue", + "MeasureValueType" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "maxProperties": 50, + "minProperties": 1, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TimeFieldType": { + "enum": [ + "EPOCH", + "TIMESTAMP_FORMAT" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Pipes::Pipe Resource Type", + "handlers": { + "create": { + "permissions": [ + "pipes:CreatePipe", + "pipes:DescribePipe", + "pipes:TagResource", + "iam:PassRole", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "iam:CreateServiceLinkedRole", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "firehose:TagDeliveryStream", + "kms:DescribeKey", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "pipes:DeletePipe", + "pipes:DescribePipe", + "pipes:UntagResource", + "logs:CreateLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "kms:DescribeKey", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + }, + "list": { + "permissions": [ + "pipes:ListPipes" + ] + }, + "read": { + "permissions": [ + "pipes:DescribePipe", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "pipes:UpdatePipe", + "pipes:TagResource", + "pipes:UntagResource", + "pipes:DescribePipe", + "iam:PassRole", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "iam:CreateServiceLinkedRole", + "logs:CreateLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:GetLogDelivery", + "logs:ListLogDeliveries", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "firehose:TagDeliveryStream", + "kms:DescribeKey", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.+)$", + "type": "string" + }, + "CreationTime": { + "format": "date-time", + "type": "string" + }, + "CurrentState": { + "$ref": "#/definitions/PipeState" + }, + "Description": { + "maxLength": 512, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + }, + "DesiredState": { + "$ref": "#/definitions/RequestedPipeState" + }, + "Enrichment": { + "maxLength": 1600, + "minLength": 0, + "pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", + "type": "string" + }, + "EnrichmentParameters": { + "$ref": "#/definitions/PipeEnrichmentParameters" + }, + "KmsKeyIdentifier": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "LastModifiedTime": { + "format": "date-time", + "type": "string" + }, + "LogConfiguration": { + "$ref": "#/definitions/PipeLogConfiguration" + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\.\\-_A-Za-z0-9]+$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Source": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", + "type": "string" + }, + "SourceParameters": { + "$ref": "#/definitions/PipeSourceParameters" + }, + "StateReason": { + "maxLength": 512, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "Target": { + "maxLength": 1600, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$", + "type": "string" + }, + "TargetParameters": { + "$ref": "#/definitions/PipeTargetParameters" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/CurrentState", + "/properties/LastModifiedTime", + "/properties/StateReason" + ], + "required": [ + "RoleArn", + "Source", + "Target" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "pipes:TagResource", + "pipes:UntagResource", + "pipes:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Pipes::Pipe", + "writeOnlyProperties": [ + "/properties/TargetParameters", + "/properties/SourceParameters" + ] +} diff --git a/schema/aws-proton-environmentaccountconnection.json b/schema/aws-proton-environmentaccountconnection.json index 18855c3..52b996d 100644 --- a/schema/aws-proton-environmentaccountconnection.json +++ b/schema/aws-proton-environmentaccountconnection.json @@ -1,165 +1,165 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ] - ], - "additionalProperties": false, - "definitions": { - "Status": { - "enum": [ - "PENDING", - "CONNECTED", - "REJECTED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "

A description of a resource tag.

", - "properties": { - "Key": { - "description": "

The key of the resource tag.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

The value of the resource tag.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema describing various properties for AWS Proton Environment Account Connections resources.", - "handlers": { - "create": { - "permissions": [ - "proton:CreateEnvironmentAccountConnection", - "proton:TagResource", - "iam:PassRole", - "proton:ListTagsForResource", - "proton:GetEnvironmentAccountConnection" - ] - }, - "delete": { - "permissions": [ - "proton:DeleteEnvironmentAccountConnection", - "proton:UntagResource", - "iam:PassRole", - "proton:ListTagsForResource", - "proton:GetEnvironmentAccountConnection" - ] - }, - "list": { - "permissions": [ - "proton:ListEnvironmentAccountConnections" - ] - }, - "read": { - "permissions": [ - "proton:GetEnvironmentAccountConnection", - "proton:ListTagsForResource", - "iam:PassRole", - "proton:GetEnvironmentAccountConnection" - ] - }, - "update": { - "permissions": [ - "proton:CreateEnvironmentAccountConnection", - "proton:ListTagsForResource", - "proton:TagResource", - "proton:UntagResource", - "proton:UpdateEnvironmentAccountConnection", - "iam:PassRole", - "proton:GetEnvironmentAccountConnection" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the environment account connection.", - "type": "string" - }, - "CodebuildRoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", - "type": "string" - }, - "ComponentRoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", - "type": "string" - }, - "EnvironmentAccountId": { - "description": "The environment account that's connected to the environment account connection.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "EnvironmentName": { - "description": "The name of the AWS Proton environment that's created in the associated management account.", - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", - "type": "string" - }, - "Id": { - "description": "The ID of the environment account connection.", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "ManagementAccountId": { - "description": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/Status", - "description": "The status of the environment account connection." - }, - "Tags": { - "description": "

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/Status" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Proton::EnvironmentAccountConnection" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ] + ], + "additionalProperties": false, + "definitions": { + "Status": { + "enum": [ + "PENDING", + "CONNECTED", + "REJECTED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "

A description of a resource tag.

", + "properties": { + "Key": { + "description": "

The key of the resource tag.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

The value of the resource tag.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema describing various properties for AWS Proton Environment Account Connections resources.", + "handlers": { + "create": { + "permissions": [ + "proton:CreateEnvironmentAccountConnection", + "proton:TagResource", + "iam:PassRole", + "proton:ListTagsForResource", + "proton:GetEnvironmentAccountConnection" + ] + }, + "delete": { + "permissions": [ + "proton:DeleteEnvironmentAccountConnection", + "proton:UntagResource", + "iam:PassRole", + "proton:ListTagsForResource", + "proton:GetEnvironmentAccountConnection" + ] + }, + "list": { + "permissions": [ + "proton:ListEnvironmentAccountConnections" + ] + }, + "read": { + "permissions": [ + "proton:GetEnvironmentAccountConnection", + "proton:ListTagsForResource", + "iam:PassRole", + "proton:GetEnvironmentAccountConnection" + ] + }, + "update": { + "permissions": [ + "proton:CreateEnvironmentAccountConnection", + "proton:ListTagsForResource", + "proton:TagResource", + "proton:UntagResource", + "proton:UpdateEnvironmentAccountConnection", + "iam:PassRole", + "proton:GetEnvironmentAccountConnection" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the environment account connection.", + "type": "string" + }, + "CodebuildRoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", + "type": "string" + }, + "ComponentRoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", + "type": "string" + }, + "EnvironmentAccountId": { + "description": "The environment account that's connected to the environment account connection.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "EnvironmentName": { + "description": "The name of the AWS Proton environment that's created in the associated management account.", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", + "type": "string" + }, + "Id": { + "description": "The ID of the environment account connection.", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "ManagementAccountId": { + "description": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::\\d{12}:role/([\\w+=,.@-]{1,512}[/:])*([\\w+=,.@-]{1,64})$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/Status", + "description": "The status of the environment account connection." + }, + "Tags": { + "description": "

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Proton::EnvironmentAccountConnection" +} diff --git a/schema/aws-proton-environmenttemplate.json b/schema/aws-proton-environmenttemplate.json index 877d13f..f7e28ef 100644 --- a/schema/aws-proton-environmenttemplate.json +++ b/schema/aws-proton-environmenttemplate.json @@ -1,144 +1,144 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EncryptionKey", - "/properties/Name", - "/properties/Provisioning" - ], - "definitions": { - "Provisioning": { - "enum": [ - "CUSTOMER_MANAGED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "

A description of a resource tag.

", - "properties": { - "Key": { - "description": "

The key of the resource tag.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

The value of the resource tag.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Proton::EnvironmentTemplate Resource Type", - "handlers": { - "create": { - "permissions": [ - "proton:CreateEnvironmentTemplate", - "proton:TagResource", - "proton:GetEnvironmentTemplate", - "kms:*" - ] - }, - "delete": { - "permissions": [ - "proton:DeleteEnvironmentTemplate", - "proton:GetEnvironmentTemplate", - "kms:*" - ] - }, - "list": { - "permissions": [ - "proton:ListEnvironmentTemplates" - ] - }, - "read": { - "permissions": [ - "proton:GetEnvironmentTemplate", - "proton:ListTagsForResource", - "kms:*" - ] - }, - "update": { - "permissions": [ - "proton:CreateEnvironmentTemplate", - "proton:ListTagsForResource", - "proton:TagResource", - "proton:UntagResource", - "proton:UpdateEnvironmentTemplate", - "proton:GetEnvironmentTemplate", - "kms:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the environment template.

", - "type": "string" - }, - "Description": { - "description": "

A description of the environment template.

", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "description": "

The environment template name as displayed in the developer interface.

", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "EncryptionKey": { - "description": "

A customer provided encryption key that Proton uses to encrypt data.

", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", - "type": "string" - }, - "Provisioning": { - "$ref": "#/definitions/Provisioning" - }, - "Tags": { - "description": "

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Proton::EnvironmentTemplate" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EncryptionKey", + "/properties/Name", + "/properties/Provisioning" + ], + "definitions": { + "Provisioning": { + "enum": [ + "CUSTOMER_MANAGED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "

A description of a resource tag.

", + "properties": { + "Key": { + "description": "

The key of the resource tag.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

The value of the resource tag.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Proton::EnvironmentTemplate Resource Type", + "handlers": { + "create": { + "permissions": [ + "proton:CreateEnvironmentTemplate", + "proton:TagResource", + "proton:GetEnvironmentTemplate", + "kms:*" + ] + }, + "delete": { + "permissions": [ + "proton:DeleteEnvironmentTemplate", + "proton:GetEnvironmentTemplate", + "kms:*" + ] + }, + "list": { + "permissions": [ + "proton:ListEnvironmentTemplates" + ] + }, + "read": { + "permissions": [ + "proton:GetEnvironmentTemplate", + "proton:ListTagsForResource", + "kms:*" + ] + }, + "update": { + "permissions": [ + "proton:CreateEnvironmentTemplate", + "proton:ListTagsForResource", + "proton:TagResource", + "proton:UntagResource", + "proton:UpdateEnvironmentTemplate", + "proton:GetEnvironmentTemplate", + "kms:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the environment template.

", + "type": "string" + }, + "Description": { + "description": "

A description of the environment template.

", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "description": "

The environment template name as displayed in the developer interface.

", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "EncryptionKey": { + "description": "

A customer provided encryption key that Proton uses to encrypt data.

", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", + "type": "string" + }, + "Provisioning": { + "$ref": "#/definitions/Provisioning" + }, + "Tags": { + "description": "

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Proton::EnvironmentTemplate" +} diff --git a/schema/aws-proton-servicetemplate.json b/schema/aws-proton-servicetemplate.json index 78317c8..5fc75ba 100644 --- a/schema/aws-proton-servicetemplate.json +++ b/schema/aws-proton-servicetemplate.json @@ -1,148 +1,148 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EncryptionKey", - "/properties/Name", - "/properties/PipelineProvisioning" - ], - "definitions": { - "Provisioning": { - "enum": [ - "CUSTOMER_MANAGED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "

A description of a resource tag.

", - "properties": { - "Key": { - "description": "

The key of the resource tag.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

The value of the resource tag.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Proton::ServiceTemplate Resource Type", - "handlers": { - "create": { - "permissions": [ - "proton:CreateServiceTemplate", - "proton:TagResource", - "kms:*", - "proton:GetServiceTemplate" - ] - }, - "delete": { - "permissions": [ - "proton:DeleteServiceTemplate", - "proton:UntagResource", - "kms:*", - "proton:GetServiceTemplate" - ] - }, - "list": { - "permissions": [ - "proton:ListServiceTemplates" - ] - }, - "read": { - "permissions": [ - "proton:GetServiceTemplate", - "proton:ListTagsForResource", - "kms:*" - ] - }, - "update": { - "permissions": [ - "proton:GetServiceTemplate", - "proton:CreateServiceTemplate", - "proton:ListTagsForResource", - "proton:TagResource", - "proton:UntagResource", - "proton:UpdateServiceTemplate", - "kms:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the service template.

", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", - "type": "string" - }, - "Description": { - "description": "

A description of the service template.

", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "description": "

The name of the service template as displayed in the developer interface.

", - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "EncryptionKey": { - "description": "

A customer provided encryption key that's used to encrypt data.

", - "maxLength": 200, - "minLength": 1, - "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", - "type": "string" - }, - "Name": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", - "type": "string" - }, - "PipelineProvisioning": { - "$ref": "#/definitions/Provisioning" - }, - "Tags": { - "description": "

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Proton::ServiceTemplate" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EncryptionKey", + "/properties/Name", + "/properties/PipelineProvisioning" + ], + "definitions": { + "Provisioning": { + "enum": [ + "CUSTOMER_MANAGED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "

A description of a resource tag.

", + "properties": { + "Key": { + "description": "

The key of the resource tag.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

The value of the resource tag.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Proton::ServiceTemplate Resource Type", + "handlers": { + "create": { + "permissions": [ + "proton:CreateServiceTemplate", + "proton:TagResource", + "kms:*", + "proton:GetServiceTemplate" + ] + }, + "delete": { + "permissions": [ + "proton:DeleteServiceTemplate", + "proton:UntagResource", + "kms:*", + "proton:GetServiceTemplate" + ] + }, + "list": { + "permissions": [ + "proton:ListServiceTemplates" + ] + }, + "read": { + "permissions": [ + "proton:GetServiceTemplate", + "proton:ListTagsForResource", + "kms:*" + ] + }, + "update": { + "permissions": [ + "proton:GetServiceTemplate", + "proton:CreateServiceTemplate", + "proton:ListTagsForResource", + "proton:TagResource", + "proton:UntagResource", + "proton:UpdateServiceTemplate", + "kms:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the service template.

", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", + "type": "string" + }, + "Description": { + "description": "

A description of the service template.

", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "description": "

The name of the service template as displayed in the developer interface.

", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "EncryptionKey": { + "description": "

A customer provided encryption key that's used to encrypt data.

", + "maxLength": 200, + "minLength": 1, + "pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d{12}:([\\w+=,.@-]+[/:])*[\\w+=,.@-]+$", + "type": "string" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$", + "type": "string" + }, + "PipelineProvisioning": { + "$ref": "#/definitions/Provisioning" + }, + "Tags": { + "description": "

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-proton", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Proton::ServiceTemplate" +} diff --git a/schema/aws-qbusiness-application.json b/schema/aws-qbusiness-application.json index d72da59..27407a2 100644 --- a/schema/aws-qbusiness-application.json +++ b/schema/aws-qbusiness-application.json @@ -1,234 +1,322 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EncryptionConfiguration" - ], - "definitions": { - "ApplicationStatus": { - "enum": [ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ], - "type": "string" - }, - "AttachmentsConfiguration": { - "additionalProperties": false, - "properties": { - "AttachmentsControlMode": { - "$ref": "#/definitions/AttachmentsControlMode" - } - }, - "required": [ - "AttachmentsControlMode" - ], - "type": "object" - }, - "AttachmentsControlMode": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "QAppsConfiguration": { - "additionalProperties": false, - "properties": { - "QAppsControlMode": { - "$ref": "#/definitions/QAppsControlMode" - } - }, - "required": [ - "QAppsControlMode" - ], - "type": "object" - }, - "QAppsControlMode": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::QBusiness::Application Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey", - "qbusiness:CreateApplication", - "qbusiness:GetApplication", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "sso:CreateApplication", - "sso:DeleteApplication", - "sso:PutApplicationAccessScope", - "sso:PutApplicationAuthenticationMethod", - "sso:PutApplicationGrant" - ] - }, - "delete": { - "permissions": [ - "kms:RetireGrant", - "qbusiness:DeleteApplication", - "qbusiness:GetApplication", - "sso:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "qbusiness:ListApplications" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetApplication", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "qbusiness:GetApplication", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdateApplication", - "sso:CreateApplication", - "sso:DeleteApplication", - "sso:PutApplicationAccessScope", - "sso:PutApplicationAuthenticationMethod", - "sso:PutApplicationGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId" - ], - "properties": { - "ApplicationArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "AttachmentsConfiguration": { - "$ref": "#/definitions/AttachmentsConfiguration" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "DisplayName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "IdentityCenterApplicationArn": { - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$", - "type": "string" - }, - "IdentityCenterInstanceArn": { - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", - "type": "string" - }, - "QAppsConfiguration": { - "$ref": "#/definitions/QAppsConfiguration" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/ApplicationStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/ApplicationId", - "/properties/CreatedAt", - "/properties/IdentityCenterApplicationArn", - "/properties/Status", - "/properties/UpdatedAt" - ], - "required": [ - "DisplayName" - ], - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::Application", - "writeOnlyProperties": [ - "/properties/IdentityCenterInstanceArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClientIdsForOIDC", + "/properties/EncryptionConfiguration", + "/properties/IamIdentityProviderArn", + "/properties/IdentityType" + ], + "definitions": { + "ApplicationStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "AttachmentsConfiguration": { + "additionalProperties": false, + "properties": { + "AttachmentsControlMode": { + "$ref": "#/definitions/AttachmentsControlMode" + } + }, + "required": [ + "AttachmentsControlMode" + ], + "type": "object" + }, + "AttachmentsControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "AutoSubscriptionConfiguration": { + "additionalProperties": false, + "properties": { + "AutoSubscribe": { + "$ref": "#/definitions/AutoSubscriptionStatus" + }, + "DefaultSubscriptionType": { + "$ref": "#/definitions/SubscriptionType" + } + }, + "required": [ + "AutoSubscribe" + ], + "type": "object" + }, + "AutoSubscriptionStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "IdentityType": { + "enum": [ + "AWS_IAM_IDP_SAML", + "AWS_IAM_IDP_OIDC", + "AWS_IAM_IDC" + ], + "type": "string" + }, + "PersonalizationConfiguration": { + "additionalProperties": false, + "properties": { + "PersonalizationControlMode": { + "$ref": "#/definitions/PersonalizationControlMode" + } + }, + "required": [ + "PersonalizationControlMode" + ], + "type": "object" + }, + "PersonalizationControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "QAppsConfiguration": { + "additionalProperties": false, + "properties": { + "QAppsControlMode": { + "$ref": "#/definitions/QAppsControlMode" + } + }, + "required": [ + "QAppsControlMode" + ], + "type": "object" + }, + "QAppsControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "SubscriptionType": { + "enum": [ + "Q_LITE", + "Q_BUSINESS" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Application Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:GetSAMLProvider", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "qbusiness:CreateApplication", + "qbusiness:GetApplication", + "qbusiness:UpdateApplication", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:DescribeInstance", + "sso:PutApplicationAccessScope", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + }, + "delete": { + "permissions": [ + "kms:RetireGrant", + "qbusiness:DeleteApplication", + "qbusiness:GetApplication", + "sso:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "qbusiness:ListApplications" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetApplication", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetApplication", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateApplication", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:DescribeInstance", + "sso:PutApplicationAccessScope", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId" + ], + "properties": { + "ApplicationArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "AttachmentsConfiguration": { + "$ref": "#/definitions/AttachmentsConfiguration" + }, + "AutoSubscriptionConfiguration": { + "$ref": "#/definitions/AutoSubscriptionConfiguration" + }, + "ClientIdsForOIDC": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.:/()*?=-]*$", + "type": "string" + }, + "type": "array" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "IamIdentityProviderArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws:iam::\\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\\.\\/@\\-]+$", + "type": "string" + }, + "IdentityCenterApplicationArn": { + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$", + "type": "string" + }, + "IdentityCenterInstanceArn": { + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "IdentityType": { + "$ref": "#/definitions/IdentityType" + }, + "PersonalizationConfiguration": { + "$ref": "#/definitions/PersonalizationConfiguration" + }, + "QAppsConfiguration": { + "$ref": "#/definitions/QAppsConfiguration" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ApplicationStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/ApplicationId", + "/properties/CreatedAt", + "/properties/IdentityCenterApplicationArn", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "DisplayName" + ], + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Application", + "writeOnlyProperties": [ + "/properties/IdentityCenterInstanceArn" + ] +} diff --git a/schema/aws-qbusiness-datasource.json b/schema/aws-qbusiness-datasource.json index a2fef64..33df6f3 100644 --- a/schema/aws-qbusiness-datasource.json +++ b/schema/aws-qbusiness-datasource.json @@ -1,428 +1,428 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId", - "/properties/IndexId" - ], - "definitions": { - "AttributeValueOperator": { - "enum": [ - "DELETE" - ], - "type": "string" - }, - "DataSourceStatus": { - "enum": [ - "PENDING_CREATION", - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ], - "type": "string" - }, - "DataSourceVpcConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[-0-9a-zA-Z]+$", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[-0-9a-zA-Z]+$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "DocumentAttributeCondition": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", - "type": "string" - }, - "Operator": { - "$ref": "#/definitions/DocumentEnrichmentConditionOperator" - }, - "Value": { - "$ref": "#/definitions/DocumentAttributeValue" - } - }, - "required": [ - "Key", - "Operator" - ], - "type": "object" - }, - "DocumentAttributeTarget": { - "additionalProperties": false, - "properties": { - "AttributeValueOperator": { - "$ref": "#/definitions/AttributeValueOperator" - }, - "Key": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/DocumentAttributeValue" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "DocumentAttributeValue": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "StringValue": { - "maxLength": 2048, - "type": "string" - } - }, - "required": [ - "StringValue" - ], - "title": "StringValue", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "StringListValue": { - "insertionOrder": true, - "items": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "StringListValue" - ], - "title": "StringListValue", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "LongValue": { - "type": "number" - } - }, - "required": [ - "LongValue" - ], - "title": "LongValue", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "DateValue": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "DateValue" - ], - "title": "DateValue", - "type": "object" - } - ] - }, - "DocumentContentOperator": { - "enum": [ - "DELETE" - ], - "type": "string" - }, - "DocumentEnrichmentConditionOperator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUALS", - "LESS_THAN", - "LESS_THAN_OR_EQUALS", - "EQUALS", - "NOT_EQUALS", - "CONTAINS", - "NOT_CONTAINS", - "EXISTS", - "NOT_EXISTS", - "BEGINS_WITH" - ], - "type": "string" - }, - "DocumentEnrichmentConfiguration": { - "additionalProperties": false, - "properties": { - "InlineConfigurations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/InlineDocumentEnrichmentConfiguration" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "PostExtractionHookConfiguration": { - "$ref": "#/definitions/HookConfiguration" - }, - "PreExtractionHookConfiguration": { - "$ref": "#/definitions/HookConfiguration" - } - }, - "type": "object" - }, - "HookConfiguration": { - "additionalProperties": false, - "properties": { - "InvocationCondition": { - "$ref": "#/definitions/DocumentAttributeCondition" - }, - "LambdaArn": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$", - "type": "string" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - } - }, - "type": "object" - }, - "InlineDocumentEnrichmentConfiguration": { - "additionalProperties": false, - "properties": { - "Condition": { - "$ref": "#/definitions/DocumentAttributeCondition" - }, - "DocumentContentOperator": { - "$ref": "#/definitions/DocumentContentOperator" - }, - "Target": { - "$ref": "#/definitions/DocumentAttributeTarget" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::QBusiness::DataSource Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "qbusiness:CreateDataSource", - "qbusiness:GetDataSource", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "qbusiness:DeleteDataSource", - "qbusiness:GetDataSource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - }, - "IndexId": { - "$ref": "resource-schema.json#/properties/IndexId" - } - }, - "required": [ - "IndexId", - "ApplicationId" - ] - }, - "permissions": [ - "qbusiness:ListDataSources" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetDataSource", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "qbusiness:GetDataSource", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdateDataSource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/DataSourceId", - "/properties/IndexId" - ], - "properties": { - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "Configuration": {}, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "DataSourceArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "DataSourceId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "DisplayName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "DocumentEnrichmentConfiguration": { - "$ref": "#/definitions/DocumentEnrichmentConfiguration" - }, - "IndexId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/DataSourceStatus" - }, - "SyncSchedule": { - "maxLength": 998, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Type": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - }, - "VpcConfiguration": { - "$ref": "#/definitions/DataSourceVpcConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/DataSourceArn", - "/properties/DataSourceId", - "/properties/Status", - "/properties/Type", - "/properties/UpdatedAt" - ], - "required": [ - "ApplicationId", - "IndexId", - "Configuration", - "DisplayName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::DataSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/IndexId" + ], + "definitions": { + "AttributeValueOperator": { + "enum": [ + "DELETE" + ], + "type": "string" + }, + "DataSourceStatus": { + "enum": [ + "PENDING_CREATION", + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "DataSourceVpcConfiguration": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+$", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "SubnetIds" + ], + "type": "object" + }, + "DocumentAttributeCondition": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Operator": { + "$ref": "#/definitions/DocumentEnrichmentConditionOperator" + }, + "Value": { + "$ref": "#/definitions/DocumentAttributeValue" + } + }, + "required": [ + "Key", + "Operator" + ], + "type": "object" + }, + "DocumentAttributeTarget": { + "additionalProperties": false, + "properties": { + "AttributeValueOperator": { + "$ref": "#/definitions/AttributeValueOperator" + }, + "Key": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DocumentAttributeValue" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "DocumentAttributeValue": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "StringValue": { + "maxLength": 2048, + "type": "string" + } + }, + "required": [ + "StringValue" + ], + "title": "StringValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "StringListValue": { + "insertionOrder": true, + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "StringListValue" + ], + "title": "StringListValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "LongValue": { + "type": "number" + } + }, + "required": [ + "LongValue" + ], + "title": "LongValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "DateValue": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "DateValue" + ], + "title": "DateValue", + "type": "object" + } + ] + }, + "DocumentContentOperator": { + "enum": [ + "DELETE" + ], + "type": "string" + }, + "DocumentEnrichmentConditionOperator": { + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS", + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "EXISTS", + "NOT_EXISTS", + "BEGINS_WITH" + ], + "type": "string" + }, + "DocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "InlineConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InlineDocumentEnrichmentConfiguration" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "PostExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + }, + "PreExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + } + }, + "type": "object" + }, + "HookConfiguration": { + "additionalProperties": false, + "properties": { + "InvocationCondition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "LambdaArn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "type": "object" + }, + "InlineDocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "Condition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "DocumentContentOperator": { + "$ref": "#/definitions/DocumentContentOperator" + }, + "Target": { + "$ref": "#/definitions/DocumentAttributeTarget" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::DataSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateDataSource", + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteDataSource", + "qbusiness:GetDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + }, + "IndexId": { + "$ref": "resource-schema.json#/properties/IndexId" + } + }, + "required": [ + "IndexId", + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListDataSources" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/DataSourceId", + "/properties/IndexId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Configuration": {}, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DataSourceArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "DataSourceId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "DocumentEnrichmentConfiguration": { + "$ref": "#/definitions/DocumentEnrichmentConfiguration" + }, + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/DataSourceStatus" + }, + "SyncSchedule": { + "maxLength": 998, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + }, + "VpcConfiguration": { + "$ref": "#/definitions/DataSourceVpcConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DataSourceArn", + "/properties/DataSourceId", + "/properties/Status", + "/properties/Type", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "IndexId", + "Configuration", + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::DataSource" +} diff --git a/schema/aws-qbusiness-index.json b/schema/aws-qbusiness-index.json index bf712ab..346de40 100644 --- a/schema/aws-qbusiness-index.json +++ b/schema/aws-qbusiness-index.json @@ -1,252 +1,252 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId", - "/properties/Type" - ], - "definitions": { - "AttributeType": { - "enum": [ - "STRING", - "STRING_LIST", - "NUMBER", - "DATE" - ], - "type": "string" - }, - "DocumentAttributeConfiguration": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 30, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", - "type": "string" - }, - "Search": { - "$ref": "#/definitions/Status" - }, - "Type": { - "$ref": "#/definitions/AttributeType" - } - }, - "type": "object" - }, - "IndexCapacityConfiguration": { - "additionalProperties": false, - "properties": { - "Units": { - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "IndexStatistics": { - "additionalProperties": false, - "properties": { - "TextDocumentStatistics": { - "$ref": "#/definitions/TextDocumentStatistics" - } - }, - "type": "object" - }, - "IndexStatus": { - "enum": [ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "UPDATING" - ], - "type": "string" - }, - "IndexType": { - "enum": [ - "ENTERPRISE", - "STARTER" - ], - "type": "string" - }, - "Status": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TextDocumentStatistics": { - "additionalProperties": false, - "properties": { - "IndexedTextBytes": { - "minimum": 0, - "type": "number" - }, - "IndexedTextDocumentCount": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::QBusiness::Index Resource Type", - "handlers": { - "create": { - "permissions": [ - "qbusiness:CreateIndex", - "qbusiness:GetIndex", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UpdateIndex" - ] - }, - "delete": { - "permissions": [ - "qbusiness:DeleteIndex", - "qbusiness:GetIndex" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "qbusiness:ListIndices" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetIndex", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "qbusiness:GetIndex", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdateIndex" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/IndexId" - ], - "properties": { - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "CapacityConfiguration": { - "$ref": "#/definitions/IndexCapacityConfiguration" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "Description": { - "maxLength": 1000, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "DisplayName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "DocumentAttributeConfigurations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DocumentAttributeConfiguration" - }, - "maxItems": 500, - "minItems": 1, - "type": "array" - }, - "IndexArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "IndexId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "IndexStatistics": { - "$ref": "#/definitions/IndexStatistics" - }, - "Status": { - "$ref": "#/definitions/IndexStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/IndexType" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/IndexArn", - "/properties/IndexId", - "/properties/IndexStatistics", - "/properties/Status", - "/properties/UpdatedAt" - ], - "required": [ - "ApplicationId", - "DisplayName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::Index" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "AttributeType": { + "enum": [ + "STRING", + "STRING_LIST", + "NUMBER", + "DATE" + ], + "type": "string" + }, + "DocumentAttributeConfiguration": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 30, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Search": { + "$ref": "#/definitions/Status" + }, + "Type": { + "$ref": "#/definitions/AttributeType" + } + }, + "type": "object" + }, + "IndexCapacityConfiguration": { + "additionalProperties": false, + "properties": { + "Units": { + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "IndexStatistics": { + "additionalProperties": false, + "properties": { + "TextDocumentStatistics": { + "$ref": "#/definitions/TextDocumentStatistics" + } + }, + "type": "object" + }, + "IndexStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "IndexType": { + "enum": [ + "ENTERPRISE", + "STARTER" + ], + "type": "string" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TextDocumentStatistics": { + "additionalProperties": false, + "properties": { + "IndexedTextBytes": { + "minimum": 0, + "type": "number" + }, + "IndexedTextDocumentCount": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Index Resource Type", + "handlers": { + "create": { + "permissions": [ + "qbusiness:CreateIndex", + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UpdateIndex" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteIndex", + "qbusiness:GetIndex" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListIndices" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateIndex" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/IndexId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "CapacityConfiguration": { + "$ref": "#/definitions/IndexCapacityConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "DocumentAttributeConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DocumentAttributeConfiguration" + }, + "maxItems": 500, + "minItems": 1, + "type": "array" + }, + "IndexArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "IndexStatistics": { + "$ref": "#/definitions/IndexStatistics" + }, + "Status": { + "$ref": "#/definitions/IndexStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/IndexType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/IndexArn", + "/properties/IndexId", + "/properties/IndexStatistics", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Index" +} diff --git a/schema/aws-qbusiness-plugin.json b/schema/aws-qbusiness-plugin.json index 215c92b..2cc056c 100644 --- a/schema/aws-qbusiness-plugin.json +++ b/schema/aws-qbusiness-plugin.json @@ -1,364 +1,364 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId", - "/properties/Type" - ], - "definitions": { - "APISchema": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Payload": { - "type": "string" - } - }, - "required": [ - "Payload" - ], - "title": "Payload", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "S3": { - "$ref": "#/definitions/S3" - } - }, - "required": [ - "S3" - ], - "title": "S3", - "type": "object" - } - ] - }, - "APISchemaType": { - "enum": [ - "OPEN_API_V3" - ], - "type": "string" - }, - "BasicAuthConfiguration": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "SecretArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - } - }, - "required": [ - "RoleArn", - "SecretArn" - ], - "type": "object" - }, - "CustomPluginConfiguration": { - "additionalProperties": false, - "properties": { - "ApiSchema": { - "$ref": "#/definitions/APISchema" - }, - "ApiSchemaType": { - "$ref": "#/definitions/APISchemaType" - }, - "Description": { - "maxLength": 200, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ApiSchema", - "ApiSchemaType", - "Description" - ], - "type": "object" - }, - "NoAuthConfiguration": { - "additionalProperties": false, - "type": "object" - }, - "OAuth2ClientCredentialConfiguration": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "SecretArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - } - }, - "required": [ - "RoleArn", - "SecretArn" - ], - "type": "object" - }, - "PluginAuthConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "BasicAuthConfiguration": { - "$ref": "#/definitions/BasicAuthConfiguration" - } - }, - "required": [ - "BasicAuthConfiguration" - ], - "title": "BasicAuthConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "OAuth2ClientCredentialConfiguration": { - "$ref": "#/definitions/OAuth2ClientCredentialConfiguration" - } - }, - "required": [ - "OAuth2ClientCredentialConfiguration" - ], - "title": "OAuth2ClientCredentialConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "NoAuthConfiguration": { - "$ref": "#/definitions/NoAuthConfiguration" - } - }, - "required": [ - "NoAuthConfiguration" - ], - "title": "NoAuthConfiguration", - "type": "object" - } - ] - }, - "PluginBuildStatus": { - "enum": [ - "READY", - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_FAILED", - "DELETE_IN_PROGRESS", - "DELETE_FAILED" - ], - "type": "string" - }, - "PluginState": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "PluginType": { - "enum": [ - "SERVICE_NOW", - "SALESFORCE", - "JIRA", - "ZENDESK", - "CUSTOM" - ], - "type": "string" - }, - "S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "Key": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::QBusiness::Plugin Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "qbusiness:CreatePlugin", - "qbusiness:GetPlugin", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UpdatePlugin" - ] - }, - "delete": { - "permissions": [ - "qbusiness:DeletePlugin", - "qbusiness:GetPlugin" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "qbusiness:ListPlugins" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetPlugin", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "qbusiness:GetPlugin", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdatePlugin" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/PluginId" - ], - "properties": { - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "AuthConfiguration": { - "$ref": "#/definitions/PluginAuthConfiguration" - }, - "BuildStatus": { - "$ref": "#/definitions/PluginBuildStatus" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "CustomPluginConfiguration": { - "$ref": "#/definitions/CustomPluginConfiguration" - }, - "DisplayName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "PluginArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "PluginId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "ServerUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?|ftp|file)://([^\\s]*)$", - "type": "string" - }, - "State": { - "$ref": "#/definitions/PluginState" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/PluginType" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/BuildStatus", - "/properties/CreatedAt", - "/properties/PluginArn", - "/properties/PluginId", - "/properties/UpdatedAt" - ], - "required": [ - "ApplicationId", - "AuthConfiguration", - "DisplayName", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::Plugin" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "APISchema": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Payload": { + "type": "string" + } + }, + "required": [ + "Payload" + ], + "title": "Payload", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/S3" + } + }, + "required": [ + "S3" + ], + "title": "S3", + "type": "object" + } + ] + }, + "APISchemaType": { + "enum": [ + "OPEN_API_V3" + ], + "type": "string" + }, + "BasicAuthConfiguration": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SecretArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SecretArn" + ], + "type": "object" + }, + "CustomPluginConfiguration": { + "additionalProperties": false, + "properties": { + "ApiSchema": { + "$ref": "#/definitions/APISchema" + }, + "ApiSchemaType": { + "$ref": "#/definitions/APISchemaType" + }, + "Description": { + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ApiSchema", + "ApiSchemaType", + "Description" + ], + "type": "object" + }, + "NoAuthConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "OAuth2ClientCredentialConfiguration": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SecretArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SecretArn" + ], + "type": "object" + }, + "PluginAuthConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "BasicAuthConfiguration": { + "$ref": "#/definitions/BasicAuthConfiguration" + } + }, + "required": [ + "BasicAuthConfiguration" + ], + "title": "BasicAuthConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "OAuth2ClientCredentialConfiguration": { + "$ref": "#/definitions/OAuth2ClientCredentialConfiguration" + } + }, + "required": [ + "OAuth2ClientCredentialConfiguration" + ], + "title": "OAuth2ClientCredentialConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "NoAuthConfiguration": { + "$ref": "#/definitions/NoAuthConfiguration" + } + }, + "required": [ + "NoAuthConfiguration" + ], + "title": "NoAuthConfiguration", + "type": "object" + } + ] + }, + "PluginBuildStatus": { + "enum": [ + "READY", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" + ], + "type": "string" + }, + "PluginState": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "PluginType": { + "enum": [ + "SERVICE_NOW", + "SALESFORCE", + "JIRA", + "ZENDESK", + "CUSTOM" + ], + "type": "string" + }, + "S3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "Key": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Plugin Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreatePlugin", + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UpdatePlugin" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeletePlugin", + "qbusiness:GetPlugin" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListPlugins" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdatePlugin" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/PluginId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "AuthConfiguration": { + "$ref": "#/definitions/PluginAuthConfiguration" + }, + "BuildStatus": { + "$ref": "#/definitions/PluginBuildStatus" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "CustomPluginConfiguration": { + "$ref": "#/definitions/CustomPluginConfiguration" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "PluginArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "PluginId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "ServerUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file)://([^\\s]*)$", + "type": "string" + }, + "State": { + "$ref": "#/definitions/PluginState" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/PluginType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BuildStatus", + "/properties/CreatedAt", + "/properties/PluginArn", + "/properties/PluginId", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "AuthConfiguration", + "DisplayName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Plugin" +} diff --git a/schema/aws-qbusiness-retriever.json b/schema/aws-qbusiness-retriever.json index d2dfb5d..be293bf 100644 --- a/schema/aws-qbusiness-retriever.json +++ b/schema/aws-qbusiness-retriever.json @@ -1,233 +1,233 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId", - "/properties/Type" - ], - "definitions": { - "KendraIndexConfiguration": { - "additionalProperties": false, - "properties": { - "IndexId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - } - }, - "required": [ - "IndexId" - ], - "type": "object" - }, - "NativeIndexConfiguration": { - "additionalProperties": false, - "properties": { - "IndexId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - } - }, - "required": [ - "IndexId" - ], - "type": "object" - }, - "RetrieverConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "NativeIndexConfiguration": { - "$ref": "#/definitions/NativeIndexConfiguration" - } - }, - "required": [ - "NativeIndexConfiguration" - ], - "title": "NativeIndexConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "KendraIndexConfiguration": { - "$ref": "#/definitions/KendraIndexConfiguration" - } - }, - "required": [ - "KendraIndexConfiguration" - ], - "title": "KendraIndexConfiguration", - "type": "object" - } - ] - }, - "RetrieverStatus": { - "enum": [ - "CREATING", - "ACTIVE", - "FAILED" - ], - "type": "string" - }, - "RetrieverType": { - "enum": [ - "NATIVE_INDEX", - "KENDRA_INDEX" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::QBusiness::Retriever Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "qbusiness:CreateRetriever", - "qbusiness:GetRetriever", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "qbusiness:DeleteRetriever", - "qbusiness:GetRetriever" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "qbusiness:ListRetrievers" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetRetriever", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "qbusiness:GetRetriever", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdateRetriever" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/RetrieverId" - ], - "properties": { - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/RetrieverConfiguration" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "DisplayName": { - "maxLength": 1000, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "RetrieverArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "RetrieverId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/RetrieverStatus" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/RetrieverType" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/RetrieverArn", - "/properties/RetrieverId", - "/properties/Status", - "/properties/UpdatedAt" - ], - "required": [ - "ApplicationId", - "Configuration", - "DisplayName", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::Retriever" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "KendraIndexConfiguration": { + "additionalProperties": false, + "properties": { + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + } + }, + "required": [ + "IndexId" + ], + "type": "object" + }, + "NativeIndexConfiguration": { + "additionalProperties": false, + "properties": { + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + } + }, + "required": [ + "IndexId" + ], + "type": "object" + }, + "RetrieverConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "NativeIndexConfiguration": { + "$ref": "#/definitions/NativeIndexConfiguration" + } + }, + "required": [ + "NativeIndexConfiguration" + ], + "title": "NativeIndexConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "KendraIndexConfiguration": { + "$ref": "#/definitions/KendraIndexConfiguration" + } + }, + "required": [ + "KendraIndexConfiguration" + ], + "title": "KendraIndexConfiguration", + "type": "object" + } + ] + }, + "RetrieverStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "FAILED" + ], + "type": "string" + }, + "RetrieverType": { + "enum": [ + "NATIVE_INDEX", + "KENDRA_INDEX" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Retriever Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateRetriever", + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteRetriever", + "qbusiness:GetRetriever" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListRetrievers" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateRetriever" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/RetrieverId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/RetrieverConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "RetrieverArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "RetrieverId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/RetrieverStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/RetrieverType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/RetrieverArn", + "/properties/RetrieverId", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "Configuration", + "DisplayName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Retriever" +} diff --git a/schema/aws-qbusiness-webexperience.json b/schema/aws-qbusiness-webexperience.json index a83fe2d..cef7ece 100644 --- a/schema/aws-qbusiness-webexperience.json +++ b/schema/aws-qbusiness-webexperience.json @@ -1,190 +1,260 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WebExperienceSamplePromptsControlMode": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "WebExperienceStatus": { - "enum": [ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED", - "PENDING_AUTH_CONFIG" - ], - "type": "string" - } - }, - "description": "Definition of AWS::QBusiness::WebExperience Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "qbusiness:CreateWebExperience", - "qbusiness:GetWebExperience", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "sso:PutApplicationGrant", - "sso:UpdateApplication" - ] - }, - "delete": { - "permissions": [ - "qbusiness:DeleteWebExperience", - "qbusiness:GetWebExperience" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationId": { - "$ref": "resource-schema.json#/properties/ApplicationId" - } - }, - "required": [ - "ApplicationId" - ] - }, - "permissions": [ - "qbusiness:ListWebExperiences" - ] - }, - "read": { - "permissions": [ - "qbusiness:GetWebExperience", - "qbusiness:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "qbusiness:GetWebExperience", - "qbusiness:ListTagsForResource", - "qbusiness:TagResource", - "qbusiness:UntagResource", - "qbusiness:UpdateWebExperience", - "sso:PutApplicationGrant", - "sso:UpdateApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationId", - "/properties/WebExperienceId" - ], - "properties": { - "ApplicationId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", - "type": "string" - }, - "CreatedAt": { - "format": "date-time", - "type": "string" - }, - "DefaultEndpoint": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(https?|ftp|file)://([^\\s]*)$", - "type": "string" - }, - "RoleArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "SamplePromptsControlMode": { - "$ref": "#/definitions/WebExperienceSamplePromptsControlMode" - }, - "Status": { - "$ref": "#/definitions/WebExperienceStatus" - }, - "Subtitle": { - "maxLength": 500, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Title": { - "maxLength": 500, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - }, - "UpdatedAt": { - "format": "date-time", - "type": "string" - }, - "WebExperienceArn": { - "maxLength": 1284, - "minLength": 0, - "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", - "type": "string" - }, - "WebExperienceId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - }, - "WelcomeMessage": { - "maxLength": 300, - "minLength": 0, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedAt", - "/properties/DefaultEndpoint", - "/properties/Status", - "/properties/UpdatedAt", - "/properties/WebExperienceArn", - "/properties/WebExperienceId" - ], - "required": [ - "ApplicationId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", - "tagging": { - "taggable": true - }, - "typeName": "AWS::QBusiness::WebExperience" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "IdentityProviderConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SamlConfiguration": { + "$ref": "#/definitions/SamlProviderConfiguration" + } + }, + "required": [ + "SamlConfiguration" + ], + "title": "SamlConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "OpenIDConnectConfiguration": { + "$ref": "#/definitions/OpenIDConnectProviderConfiguration" + } + }, + "required": [ + "OpenIDConnectConfiguration" + ], + "title": "OpenIDConnectConfiguration", + "type": "object" + } + ] + }, + "OpenIDConnectProviderConfiguration": { + "additionalProperties": false, + "properties": { + "SecretsArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SecretsRole": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + } + }, + "required": [ + "SecretsArn", + "SecretsRole" + ], + "type": "object" + }, + "SamlProviderConfiguration": { + "additionalProperties": false, + "properties": { + "AuthenticationUrl": { + "maxLength": 1284, + "minLength": 1, + "pattern": "^https://.*$", + "type": "string" + } + }, + "required": [ + "AuthenticationUrl" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WebExperienceSamplePromptsControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "WebExperienceStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "PENDING_AUTH_CONFIG" + ], + "type": "string" + } + }, + "description": "Definition of AWS::QBusiness::WebExperience Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateWebExperience", + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteWebExperience", + "qbusiness:GetWebExperience" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListWebExperiences" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateWebExperience", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/WebExperienceId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DefaultEndpoint": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file)://([^\\s]*)$", + "type": "string" + }, + "IdentityProviderConfiguration": { + "$ref": "#/definitions/IdentityProviderConfiguration" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SamplePromptsControlMode": { + "$ref": "#/definitions/WebExperienceSamplePromptsControlMode" + }, + "Status": { + "$ref": "#/definitions/WebExperienceStatus" + }, + "Subtitle": { + "maxLength": 500, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Title": { + "maxLength": 500, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + }, + "WebExperienceArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "WebExperienceId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "type": "string" + }, + "WelcomeMessage": { + "maxLength": 300, + "minLength": 0, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DefaultEndpoint", + "/properties/Status", + "/properties/UpdatedAt", + "/properties/WebExperienceArn", + "/properties/WebExperienceId" + ], + "required": [ + "ApplicationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::WebExperience" +} diff --git a/schema/aws-qldb-ledger.json b/schema/aws-qldb-ledger.json index 33191a4..a447fbf 100644 --- a/schema/aws-qldb-ledger.json +++ b/schema/aws-qldb-ledger.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::QLDB::Ledger", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeletionProtection": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "KmsKey": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "PermissionsMode": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PermissionsMode" - ], - "typeName": "AWS::QLDB::Ledger" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::QLDB::Ledger", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeletionProtection": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "KmsKey": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "PermissionsMode": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PermissionsMode" + ], + "typeName": "AWS::QLDB::Ledger" +} diff --git a/schema/aws-qldb-stream.json b/schema/aws-qldb-stream.json index eff3eb4..db31095 100644 --- a/schema/aws-qldb-stream.json +++ b/schema/aws-qldb-stream.json @@ -1,151 +1,151 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/LedgerName", - "/properties/StreamName", - "/properties/RoleArn", - "/properties/KinesisConfiguration", - "/properties/InclusiveStartTime", - "/properties/ExclusiveEndTime" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - }, - "KinesisConfiguration": { - "additionalProperties": false, - "properties": { - "AggregationEnabled": { - "type": "boolean" - }, - "StreamArn": { - "$ref": "#/definitions/Arn", - "type": "object" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::QLDB::Stream.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "qldb:StreamJournalToKinesis", - "qldb:DescribeJournalKinesisStream" - ] - }, - "delete": { - "permissions": [ - "qldb:CancelJournalKinesisStream", - "qldb:DescribeJournalKinesisStream" - ] - }, - "list": { - "permissions": [ - "qldb:listJournalKinesisStreamsForLedger" - ] - }, - "read": { - "permissions": [ - "qldb:DescribeJournalKinesisStream", - "qldb:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "qldb:DescribeJournalKinesisStream", - "qldb:UntagResource", - "qldb:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/LedgerName", - "/properties/Id" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "ExclusiveEndTime": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InclusiveStartTime": { - "type": "string" - }, - "KinesisConfiguration": { - "$ref": "#/definitions/KinesisConfiguration" - }, - "LedgerName": { - "type": "string" - }, - "RoleArn": { - "$ref": "#/definitions/Arn" - }, - "StreamName": { - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "LedgerName", - "StreamName", - "RoleArn", - "KinesisConfiguration", - "InclusiveStartTime" - ], - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "qldb:TagResource", - "qldb:UntagResource", - "qldb:ListTagsForResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::QLDB::Stream" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/LedgerName", + "/properties/StreamName", + "/properties/RoleArn", + "/properties/KinesisConfiguration", + "/properties/InclusiveStartTime", + "/properties/ExclusiveEndTime" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + }, + "KinesisConfiguration": { + "additionalProperties": false, + "properties": { + "AggregationEnabled": { + "type": "boolean" + }, + "StreamArn": { + "$ref": "#/definitions/Arn", + "type": "object" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::QLDB::Stream.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qldb:StreamJournalToKinesis", + "qldb:DescribeJournalKinesisStream" + ] + }, + "delete": { + "permissions": [ + "qldb:CancelJournalKinesisStream", + "qldb:DescribeJournalKinesisStream" + ] + }, + "list": { + "permissions": [ + "qldb:listJournalKinesisStreamsForLedger" + ] + }, + "read": { + "permissions": [ + "qldb:DescribeJournalKinesisStream", + "qldb:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "qldb:DescribeJournalKinesisStream", + "qldb:UntagResource", + "qldb:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/LedgerName", + "/properties/Id" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "ExclusiveEndTime": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InclusiveStartTime": { + "type": "string" + }, + "KinesisConfiguration": { + "$ref": "#/definitions/KinesisConfiguration" + }, + "LedgerName": { + "type": "string" + }, + "RoleArn": { + "$ref": "#/definitions/Arn" + }, + "StreamName": { + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "LedgerName", + "StreamName", + "RoleArn", + "KinesisConfiguration", + "InclusiveStartTime" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "qldb:TagResource", + "qldb:UntagResource", + "qldb:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::QLDB::Stream" +} diff --git a/schema/aws-quicksight-analysis.json b/schema/aws-quicksight-analysis.json index af1cdca..3791552 100644 --- a/schema/aws-quicksight-analysis.json +++ b/schema/aws-quicksight-analysis.json @@ -1,11334 +1,11462 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AnalysisId", - "/properties/AwsAccountId" - ], - "definitions": { - "AggregationFunction": { - "additionalProperties": false, - "properties": { - "AttributeAggregationFunction": { - "$ref": "#/definitions/AttributeAggregationFunction" - }, - "CategoricalAggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "DateAggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "NumericalAggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - } - }, - "type": "object" - }, - "AggregationSortConfiguration": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SortDirection": { - "$ref": "#/definitions/SortDirection" - } - }, - "required": [ - "Column", - "SortDirection" - ], - "type": "object" - }, - "AllSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "type": "object" - }, - "AnalysisDefaults": { - "additionalProperties": false, - "properties": { - "DefaultNewSheetConfiguration": { - "$ref": "#/definitions/DefaultNewSheetConfiguration" - } - }, - "required": [ - "DefaultNewSheetConfiguration" - ], - "type": "object" - }, - "AnalysisDefinition": { - "additionalProperties": false, - "properties": { - "AnalysisDefaults": { - "$ref": "#/definitions/AnalysisDefaults" - }, - "CalculatedFields": { - "items": { - "$ref": "#/definitions/CalculatedField" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - }, - "ColumnConfigurations": { - "items": { - "$ref": "#/definitions/ColumnConfiguration" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifierDeclarations": { - "items": { - "$ref": "#/definitions/DataSetIdentifierDeclaration" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "FilterGroups": { - "items": { - "$ref": "#/definitions/FilterGroup" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "Options": { - "$ref": "#/definitions/AssetOptions" - }, - "ParameterDeclarations": { - "items": { - "$ref": "#/definitions/ParameterDeclaration" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Sheets": { - "items": { - "$ref": "#/definitions/SheetDefinition" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "DataSetIdentifierDeclarations" - ], - "type": "object" - }, - "AnalysisError": { - "additionalProperties": false, - "description": "

Analysis error.

", - "properties": { - "Message": { - "description": "

The message associated with the analysis error.

", - "pattern": "\\S", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/AnalysisErrorType" - }, - "ViolatedEntities": { - "description": "

Lists the violated entities that caused the analysis error

", - "items": { - "$ref": "#/definitions/Entity" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "AnalysisErrorType": { - "enum": [ - "ACCESS_DENIED", - "SOURCE_NOT_FOUND", - "DATA_SET_NOT_FOUND", - "INTERNAL_FAILURE", - "PARAMETER_VALUE_INCOMPATIBLE", - "PARAMETER_TYPE_INVALID", - "PARAMETER_NOT_FOUND", - "COLUMN_TYPE_MISMATCH", - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", - "COLUMN_REPLACEMENT_MISSING" - ], - "type": "string" - }, - "AnalysisSourceEntity": { - "additionalProperties": false, - "description": "

The source entity of an analysis.

", - "properties": { - "SourceTemplate": { - "$ref": "#/definitions/AnalysisSourceTemplate" - } - }, - "type": "object" - }, - "AnalysisSourceTemplate": { - "additionalProperties": false, - "description": "

The source template of an analysis.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", - "type": "string" - }, - "DataSetReferences": { - "description": "

The dataset references of the source template of an analysis.

", - "items": { - "$ref": "#/definitions/DataSetReference" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "AnchorDateConfiguration": { - "additionalProperties": false, - "properties": { - "AnchorOption": { - "$ref": "#/definitions/AnchorOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "type": "object" - }, - "AnchorOption": { - "enum": [ - "NOW" - ], - "type": "string" - }, - "ArcAxisConfiguration": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/ArcAxisDisplayRange" - }, - "ReserveRange": { - "default": 0, - "type": "number" - } - }, - "type": "object" - }, - "ArcAxisDisplayRange": { - "additionalProperties": false, - "properties": { - "Max": { - "default": null, - "type": "number" - }, - "Min": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "ArcConfiguration": { - "additionalProperties": false, - "properties": { - "ArcAngle": { - "default": null, - "type": "number" - }, - "ArcThickness": { - "$ref": "#/definitions/ArcThicknessOptions" - } - }, - "type": "object" - }, - "ArcOptions": { - "additionalProperties": false, - "properties": { - "ArcThickness": { - "$ref": "#/definitions/ArcThickness" - } - }, - "type": "object" - }, - "ArcThickness": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE", - "WHOLE" - ], - "type": "string" - }, - "ArcThicknessOptions": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "AssetOptions": { - "additionalProperties": false, - "properties": { - "Timezone": { - "type": "string" - }, - "WeekStart": { - "$ref": "#/definitions/DayOfTheWeek" - } - }, - "type": "object" - }, - "AttributeAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleAttributeAggregation": { - "$ref": "#/definitions/SimpleAttributeAggregationFunction" - }, - "ValueForMultipleValues": { - "type": "string" - } - }, - "type": "object" - }, - "AxisBinding": { - "enum": [ - "PRIMARY_YAXIS", - "SECONDARY_YAXIS" - ], - "type": "string" - }, - "AxisDataOptions": { - "additionalProperties": false, - "properties": { - "DateAxisOptions": { - "$ref": "#/definitions/DateAxisOptions" - }, - "NumericAxisOptions": { - "$ref": "#/definitions/NumericAxisOptions" - } - }, - "type": "object" - }, - "AxisDisplayDataDrivenRange": { - "additionalProperties": false, - "type": "object" - }, - "AxisDisplayMinMaxRange": { - "additionalProperties": false, - "properties": { - "Maximum": { - "default": null, - "type": "number" - }, - "Minimum": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AxisOffset": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "DataOptions": { - "$ref": "#/definitions/AxisDataOptions" - }, - "GridLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ScrollbarOptions": { - "$ref": "#/definitions/ScrollBarOptions" - }, - "TickLabelOptions": { - "$ref": "#/definitions/AxisTickLabelOptions" - } - }, - "type": "object" - }, - "AxisDisplayRange": { - "additionalProperties": false, - "properties": { - "DataDriven": { - "$ref": "#/definitions/AxisDisplayDataDrivenRange" - }, - "MinMax": { - "$ref": "#/definitions/AxisDisplayMinMaxRange" - } - }, - "type": "object" - }, - "AxisLabelOptions": { - "additionalProperties": false, - "properties": { - "ApplyTo": { - "$ref": "#/definitions/AxisLabelReferenceOptions" - }, - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "AxisLabelReferenceOptions": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "AxisLinearScale": { - "additionalProperties": false, - "properties": { - "StepCount": { - "default": null, - "type": "number" - }, - "StepSize": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisLogarithmicScale": { - "additionalProperties": false, - "properties": { - "Base": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisScale": { - "additionalProperties": false, - "properties": { - "Linear": { - "$ref": "#/definitions/AxisLinearScale" - }, - "Logarithmic": { - "$ref": "#/definitions/AxisLogarithmicScale" - } - }, - "type": "object" - }, - "AxisTickLabelOptions": { - "additionalProperties": false, - "properties": { - "LabelOptions": { - "$ref": "#/definitions/LabelOptions" - }, - "RotationAngle": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "BarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Orientation": { - "$ref": "#/definitions/BarChartOrientation" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/BarChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BarChartFieldWells": { - "additionalProperties": false, - "properties": { - "BarChartAggregatedFieldWells": { - "$ref": "#/definitions/BarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "BarChartOrientation": { - "enum": [ - "HORIZONTAL", - "VERTICAL" - ], - "type": "string" - }, - "BarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "BarsArrangement": { - "enum": [ - "CLUSTERED", - "STACKED", - "STACKED_PERCENT" - ], - "type": "string" - }, - "BaseMapStyleType": { - "enum": [ - "LIGHT_GRAY", - "DARK_GRAY", - "STREET", - "IMAGERY" - ], - "type": "string" - }, - "BinCountOptions": { - "additionalProperties": false, - "properties": { - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BinWidthOptions": { - "additionalProperties": false, - "properties": { - "BinCountLimit": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BodySectionConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/BodySectionContent" - }, - "PageBreakConfiguration": { - "$ref": "#/definitions/SectionPageBreakConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Content", - "SectionId" - ], - "type": "object" - }, - "BodySectionContent": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - } - }, - "type": "object" - }, - "BoxPlotAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BoxPlotChartConfiguration": { - "additionalProperties": false, - "properties": { - "BoxPlotOptions": { - "$ref": "#/definitions/BoxPlotOptions" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BoxPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SortConfiguration": { - "$ref": "#/definitions/BoxPlotSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BoxPlotFieldWells": { - "additionalProperties": false, - "properties": { - "BoxPlotAggregatedFieldWells": { - "$ref": "#/definitions/BoxPlotAggregatedFieldWells" - } - }, - "type": "object" - }, - "BoxPlotFillStyle": { - "enum": [ - "SOLID", - "TRANSPARENT" - ], - "type": "string" - }, - "BoxPlotOptions": { - "additionalProperties": false, - "properties": { - "AllDataPointsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "OutlierVisibility": { - "$ref": "#/definitions/Visibility" - }, - "StyleOptions": { - "$ref": "#/definitions/BoxPlotStyleOptions" - } - }, - "type": "object" - }, - "BoxPlotSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - } - }, - "type": "object" - }, - "BoxPlotStyleOptions": { - "additionalProperties": false, - "properties": { - "FillStyle": { - "$ref": "#/definitions/BoxPlotFillStyle" - } - }, - "type": "object" - }, - "BoxPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BoxPlotChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "CalculatedField": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 32000, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "Expression", - "Name" - ], - "type": "object" - }, - "CalculatedMeasureField": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression", - "FieldId" - ], - "type": "object" - }, - "CascadingControlConfiguration": { - "additionalProperties": false, - "properties": { - "SourceControls": { - "items": { - "$ref": "#/definitions/CascadingControlSource" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CascadingControlSource": { - "additionalProperties": false, - "properties": { - "ColumnToMatch": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceSheetControlId": { - "type": "string" - } - }, - "type": "object" - }, - "CategoricalAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT" - ], - "type": "string" - }, - "CategoricalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoricalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoryDrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "CategoryValues", - "Column" - ], - "type": "object" - }, - "CategoryFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Configuration": { - "$ref": "#/definitions/CategoryFilterConfiguration" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "Column", - "Configuration", - "FilterId" - ], - "type": "object" - }, - "CategoryFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CustomFilterConfiguration": { - "$ref": "#/definitions/CustomFilterConfiguration" - }, - "CustomFilterListConfiguration": { - "$ref": "#/definitions/CustomFilterListConfiguration" - }, - "FilterListConfiguration": { - "$ref": "#/definitions/FilterListConfiguration" - } - }, - "type": "object" - }, - "CategoryFilterMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL", - "CONTAINS", - "DOES_NOT_CONTAIN", - "STARTS_WITH", - "ENDS_WITH" - ], - "type": "string" - }, - "CategoryFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "ChartAxisLabelOptions": { - "additionalProperties": false, - "properties": { - "AxisLabelOptions": { - "items": { - "$ref": "#/definitions/AxisLabelOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SortIconVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ClusterMarker": { - "additionalProperties": false, - "properties": { - "SimpleClusterMarker": { - "$ref": "#/definitions/SimpleClusterMarker" - } - }, - "type": "object" - }, - "ClusterMarkerConfiguration": { - "additionalProperties": false, - "properties": { - "ClusterMarker": { - "$ref": "#/definitions/ClusterMarker" - } - }, - "type": "object" - }, - "ColorFillType": { - "enum": [ - "DISCRETE", - "GRADIENT" - ], - "type": "string" - }, - "ColorScale": { - "additionalProperties": false, - "properties": { - "ColorFillType": { - "$ref": "#/definitions/ColorFillType" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DataColor" - }, - "maxItems": 3, - "minItems": 2, - "type": "array" - }, - "NullValueColor": { - "$ref": "#/definitions/DataColor" - } - }, - "required": [ - "ColorFillType", - "Colors" - ], - "type": "object" - }, - "ColorsConfiguration": { - "additionalProperties": false, - "properties": { - "CustomColors": { - "items": { - "$ref": "#/definitions/CustomColor" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ColumnConfiguration": { - "additionalProperties": false, - "properties": { - "ColorsConfiguration": { - "$ref": "#/definitions/ColorsConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - }, - "Role": { - "$ref": "#/definitions/ColumnRole" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ColumnHierarchy": { - "additionalProperties": false, - "properties": { - "DateTimeHierarchy": { - "$ref": "#/definitions/DateTimeHierarchy" - }, - "ExplicitHierarchy": { - "$ref": "#/definitions/ExplicitHierarchy" - }, - "PredefinedHierarchy": { - "$ref": "#/definitions/PredefinedHierarchy" - } - }, - "type": "object" - }, - "ColumnIdentifier": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ColumnName", - "DataSetIdentifier" - ], - "type": "object" - }, - "ColumnRole": { - "enum": [ - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "ColumnSort": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortBy": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "Direction", - "SortBy" - ], - "type": "object" - }, - "ColumnTooltipItem": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ComboChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "BarValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "LineValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ComboChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "LineDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/ComboChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "ComboChartFieldWells": { - "additionalProperties": false, - "properties": { - "ComboChartAggregatedFieldWells": { - "$ref": "#/definitions/ComboChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "ComboChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ComboChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ComparisonConfiguration": { - "additionalProperties": false, - "properties": { - "ComparisonFormat": { - "$ref": "#/definitions/ComparisonFormatConfiguration" - }, - "ComparisonMethod": { - "$ref": "#/definitions/ComparisonMethod" - } - }, - "type": "object" - }, - "ComparisonFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "ComparisonMethod": { - "enum": [ - "DIFFERENCE", - "PERCENT_DIFFERENCE", - "PERCENT" - ], - "type": "string" - }, - "Computation": { - "additionalProperties": false, - "properties": { - "Forecast": { - "$ref": "#/definitions/ForecastComputation" - }, - "GrowthRate": { - "$ref": "#/definitions/GrowthRateComputation" - }, - "MaximumMinimum": { - "$ref": "#/definitions/MaximumMinimumComputation" - }, - "MetricComparison": { - "$ref": "#/definitions/MetricComparisonComputation" - }, - "PeriodOverPeriod": { - "$ref": "#/definitions/PeriodOverPeriodComputation" - }, - "PeriodToDate": { - "$ref": "#/definitions/PeriodToDateComputation" - }, - "TopBottomMovers": { - "$ref": "#/definitions/TopBottomMoversComputation" - }, - "TopBottomRanked": { - "$ref": "#/definitions/TopBottomRankedComputation" - }, - "TotalAggregation": { - "$ref": "#/definitions/TotalAggregationComputation" - }, - "UniqueValues": { - "$ref": "#/definitions/UniqueValuesComputation" - } - }, - "type": "object" - }, - "ConditionalFormattingColor": { - "additionalProperties": false, - "properties": { - "Gradient": { - "$ref": "#/definitions/ConditionalFormattingGradientColor" - }, - "Solid": { - "$ref": "#/definitions/ConditionalFormattingSolidColor" - } - }, - "type": "object" - }, - "ConditionalFormattingCustomIconCondition": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DisplayConfiguration": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconOptions": { - "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" - } - }, - "required": [ - "Expression", - "IconOptions" - ], - "type": "object" - }, - "ConditionalFormattingCustomIconOptions": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/Icon" - }, - "UnicodeIcon": { - "pattern": "^[^\\u0000-\\u00FF]$", - "type": "string" - } - }, - "type": "object" - }, - "ConditionalFormattingGradientColor": { - "additionalProperties": false, - "properties": { - "Color": { - "$ref": "#/definitions/GradientColor" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Color", - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIcon": { - "additionalProperties": false, - "properties": { - "CustomCondition": { - "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" - }, - "IconSet": { - "$ref": "#/definitions/ConditionalFormattingIconSet" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayConfiguration": { - "additionalProperties": false, - "properties": { - "IconDisplayOption": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayOption": { - "enum": [ - "ICON_ONLY" - ], - "type": "string" - }, - "ConditionalFormattingIconSet": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconSetType": { - "$ref": "#/definitions/ConditionalFormattingIconSetType" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIconSetType": { - "enum": [ - "PLUS_MINUS", - "CHECK_X", - "THREE_COLOR_ARROW", - "THREE_GRAY_ARROW", - "CARET_UP_MINUS_DOWN", - "THREE_SHAPE", - "THREE_CIRCLE", - "FLAGS", - "BARS", - "FOUR_COLOR_ARROW", - "FOUR_GRAY_ARROW" - ], - "type": "string" - }, - "ConditionalFormattingSolidColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ContributionAnalysisDefault": { - "additionalProperties": false, - "properties": { - "ContributorDimensions": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "MeasureFieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ContributorDimensions", - "MeasureFieldId" - ], - "type": "object" - }, - "CrossDatasetTypes": { - "enum": [ - "ALL_DATASETS", - "SINGLE_DATASET" - ], - "type": "string" - }, - "CurrencyDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Symbol": { - "pattern": "^[A-Z]{3}$", - "type": "string" - } - }, - "type": "object" - }, - "CustomActionFilterOperation": { - "additionalProperties": false, - "properties": { - "SelectedFieldsConfiguration": { - "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" - }, - "TargetVisualsConfiguration": { - "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" - } - }, - "required": [ - "SelectedFieldsConfiguration", - "TargetVisualsConfiguration" - ], - "type": "object" - }, - "CustomActionNavigationOperation": { - "additionalProperties": false, - "properties": { - "LocalNavigationConfiguration": { - "$ref": "#/definitions/LocalNavigationConfiguration" - } - }, - "type": "object" - }, - "CustomActionSetParametersOperation": { - "additionalProperties": false, - "properties": { - "ParameterValueConfigurations": { - "items": { - "$ref": "#/definitions/SetParameterValueConfiguration" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ParameterValueConfigurations" - ], - "type": "object" - }, - "CustomActionURLOperation": { - "additionalProperties": false, - "properties": { - "URLTarget": { - "$ref": "#/definitions/URLTargetConfiguration" - }, - "URLTemplate": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "URLTarget", - "URLTemplate" - ], - "type": "object" - }, - "CustomColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "SpecialValue": { - "$ref": "#/definitions/SpecialValue" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "CustomContentConfiguration": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/CustomContentType" - }, - "ContentUrl": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ImageScaling": { - "$ref": "#/definitions/CustomContentImageScalingConfiguration" - } - }, - "type": "object" - }, - "CustomContentImageScalingConfiguration": { - "enum": [ - "FIT_TO_HEIGHT", - "FIT_TO_WIDTH", - "DO_NOT_SCALE", - "SCALE_TO_VISUAL" - ], - "type": "string" - }, - "CustomContentType": { - "enum": [ - "IMAGE", - "OTHER_EMBEDDED_CONTENT" - ], - "type": "string" - }, - "CustomContentVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/CustomContentConfiguration" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "CustomFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValue": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomFilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomNarrativeOptions": { - "additionalProperties": false, - "properties": { - "Narrative": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Narrative" - ], - "type": "object" - }, - "CustomParameterValues": { - "additionalProperties": false, - "properties": { - "DateTimeValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "DecimalValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "IntegerValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "StringValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CustomValuesConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValues": { - "$ref": "#/definitions/CustomParameterValues" - }, - "IncludeNullValue": { - "type": "boolean" - } - }, - "required": [ - "CustomValues" - ], - "type": "object" - }, - "DataBarsOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "NegativeColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "DataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "DataFieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "DataLabelContent": { - "enum": [ - "VALUE", - "PERCENT", - "VALUE_AND_PERCENT" - ], - "type": "string" - }, - "DataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DataLabelTypes": { - "items": { - "$ref": "#/definitions/DataLabelType" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelContent": { - "$ref": "#/definitions/DataLabelContent" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Overlap": { - "$ref": "#/definitions/DataLabelOverlap" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataLabelOverlap": { - "enum": [ - "DISABLE_OVERLAP", - "ENABLE_OVERLAP" - ], - "type": "string" - }, - "DataLabelPosition": { - "enum": [ - "INSIDE", - "OUTSIDE", - "LEFT", - "TOP", - "BOTTOM", - "RIGHT" - ], - "type": "string" - }, - "DataLabelType": { - "additionalProperties": false, - "properties": { - "DataPathLabelType": { - "$ref": "#/definitions/DataPathLabelType" - }, - "FieldLabelType": { - "$ref": "#/definitions/FieldLabelType" - }, - "MaximumLabelType": { - "$ref": "#/definitions/MaximumLabelType" - }, - "MinimumLabelType": { - "$ref": "#/definitions/MinimumLabelType" - }, - "RangeEndsLabelType": { - "$ref": "#/definitions/RangeEndsLabelType" - } - }, - "type": "object" - }, - "DataPathColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Element": { - "$ref": "#/definitions/DataPathValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Color", - "Element" - ], - "type": "object" - }, - "DataPathLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataPathSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortPaths": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Direction", - "SortPaths" - ], - "type": "object" - }, - "DataPathType": { - "additionalProperties": false, - "properties": { - "PivotTableDataPathType": { - "$ref": "#/definitions/PivotTableDataPathType" - } - }, - "type": "object" - }, - "DataPathValue": { - "additionalProperties": false, - "properties": { - "DataPathType": { - "$ref": "#/definitions/DataPathType" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "DataSetIdentifierDeclaration": { - "additionalProperties": false, - "properties": { - "DataSetArn": { - "type": "string" - }, - "Identifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetArn", - "Identifier" - ], - "type": "object" - }, - "DataSetReference": { - "additionalProperties": false, - "description": "

Dataset reference.

", - "properties": { - "DataSetArn": { - "description": "

Dataset Amazon Resource Name (ARN).

", - "type": "string" - }, - "DataSetPlaceholder": { - "description": "

Dataset placeholder.

", - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "DateAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT", - "MIN", - "MAX" - ], - "type": "string" - }, - "DateAxisOptions": { - "additionalProperties": false, - "properties": { - "MissingDateVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DateDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DateGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateTimeDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DateTimeFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "DateTimeHierarchy": { - "additionalProperties": false, - "properties": { - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "HierarchyId" - ], - "type": "object" - }, - "DateTimeParameter": { - "additionalProperties": false, - "description": "

A date-time parameter.

", - "properties": { - "Name": { - "description": "

A display name for the date-time parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the date-time parameter.

", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "DateTimeParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DateTimeDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "DateTimePickerControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DateTimeValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "format": "date-time", - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DayOfTheWeek": { - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - }, - "DecimalDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DecimalParameter": { - "additionalProperties": false, - "description": "

A decimal parameter.

", - "properties": { - "Name": { - "description": "

A display name for the decimal parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the decimal parameter.

", - "items": { - "default": 0, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "DecimalParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DecimalDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "DecimalPlacesConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlaces": { - "maximum": 20, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "DecimalPlaces" - ], - "type": "object" - }, - "DecimalValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DefaultDateTimePickerControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "type": "object" - }, - "DefaultFilterControlConfiguration": { - "additionalProperties": false, - "properties": { - "ControlOptions": { - "$ref": "#/definitions/DefaultFilterControlOptions" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ControlOptions", - "Title" - ], - "type": "object" - }, - "DefaultFilterControlOptions": { - "additionalProperties": false, - "properties": { - "DefaultDateTimePickerOptions": { - "$ref": "#/definitions/DefaultDateTimePickerControlOptions" - }, - "DefaultDropdownOptions": { - "$ref": "#/definitions/DefaultFilterDropDownControlOptions" - }, - "DefaultListOptions": { - "$ref": "#/definitions/DefaultFilterListControlOptions" - }, - "DefaultRelativeDateTimeOptions": { - "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" - }, - "DefaultSliderOptions": { - "$ref": "#/definitions/DefaultSliderControlOptions" - }, - "DefaultTextAreaOptions": { - "$ref": "#/definitions/DefaultTextAreaControlOptions" - }, - "DefaultTextFieldOptions": { - "$ref": "#/definitions/DefaultTextFieldControlOptions" - } - }, - "type": "object" - }, - "DefaultFilterDropDownControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFilterListControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultGridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultInteractiveLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeForm": { - "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" - }, - "Grid": { - "$ref": "#/definitions/DefaultGridLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultNewSheetConfiguration": { - "additionalProperties": false, - "properties": { - "InteractiveLayoutConfiguration": { - "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" - }, - "PaginatedLayoutConfiguration": { - "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" - }, - "SheetContentType": { - "$ref": "#/definitions/SheetContentType" - } - }, - "type": "object" - }, - "DefaultPaginatedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "SectionBased": { - "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultRelativeDateTimeControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultSectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultSliderControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "StepSize" - ], - "type": "object" - }, - "DefaultTextAreaControlOptions": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultTextFieldControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - } - }, - "type": "object" - }, - "DestinationParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValuesConfiguration": { - "$ref": "#/definitions/CustomValuesConfiguration" - }, - "SelectAllValueOptions": { - "$ref": "#/definitions/SelectAllValueOptions" - }, - "SourceColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceField": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SourceParameterName": { - "type": "string" - } - }, - "type": "object" - }, - "DimensionField": { - "additionalProperties": false, - "properties": { - "CategoricalDimensionField": { - "$ref": "#/definitions/CategoricalDimensionField" - }, - "DateDimensionField": { - "$ref": "#/definitions/DateDimensionField" - }, - "NumericalDimensionField": { - "$ref": "#/definitions/NumericalDimensionField" - } - }, - "type": "object" - }, - "DonutCenterOptions": { - "additionalProperties": false, - "properties": { - "LabelVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DonutOptions": { - "additionalProperties": false, - "properties": { - "ArcOptions": { - "$ref": "#/definitions/ArcOptions" - }, - "DonutCenterOptions": { - "$ref": "#/definitions/DonutCenterOptions" - } - }, - "type": "object" - }, - "DrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryDrillDownFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityDrillDownFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeDrillDownFilter" - } - }, - "type": "object" - }, - "DropDownControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DynamicDefaultValue": { - "additionalProperties": false, - "properties": { - "DefaultValueColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "GroupNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "UserNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "DefaultValueColumn" - ], - "type": "object" - }, - "EmptyVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "Entity": { - "additionalProperties": false, - "properties": { - "Path": { - "pattern": "\\S", - "type": "string" - } - }, - "type": "object" - }, - "ExcludePeriodConfiguration": { - "additionalProperties": false, - "properties": { - "Amount": { - "default": null, - "type": "number" - }, - "Granularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "Amount", - "Granularity" - ], - "type": "object" - }, - "ExplicitHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 2, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "FieldBasedTooltip": { - "additionalProperties": false, - "properties": { - "AggregationVisibility": { - "$ref": "#/definitions/Visibility" - }, - "TooltipFields": { - "items": { - "$ref": "#/definitions/TooltipItem" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "TooltipTitleType": { - "$ref": "#/definitions/TooltipTitleType" - } - }, - "type": "object" - }, - "FieldLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "FieldSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Direction", - "FieldId" - ], - "type": "object" - }, - "FieldSortOptions": { - "additionalProperties": false, - "properties": { - "ColumnSort": { - "$ref": "#/definitions/ColumnSort" - }, - "FieldSort": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "FieldTooltipItem": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/FilledMapConditionalFormattingOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "ConditionalFormattingOptions" - ], - "type": "object" - }, - "FilledMapConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Shape": { - "$ref": "#/definitions/FilledMapShapeConditionalFormatting" - } - }, - "required": [ - "Shape" - ], - "type": "object" - }, - "FilledMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/FilledMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/FilledMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "FilledMapFieldWells": { - "additionalProperties": false, - "properties": { - "FilledMapAggregatedFieldWells": { - "$ref": "#/definitions/FilledMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "FilledMapShapeConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Format": { - "$ref": "#/definitions/ShapeConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FilledMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/FilledMapConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityFilter" - }, - "NumericRangeFilter": { - "$ref": "#/definitions/NumericRangeFilter" - }, - "RelativeDatesFilter": { - "$ref": "#/definitions/RelativeDatesFilter" - }, - "TimeEqualityFilter": { - "$ref": "#/definitions/TimeEqualityFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeFilter" - }, - "TopBottomFilter": { - "$ref": "#/definitions/TopBottomFilter" - } - }, - "type": "object" - }, - "FilterControl": { - "additionalProperties": false, - "properties": { - "CrossSheet": { - "$ref": "#/definitions/FilterCrossSheetControl" - }, - "DateTimePicker": { - "$ref": "#/definitions/FilterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/FilterDropDownControl" - }, - "List": { - "$ref": "#/definitions/FilterListControl" - }, - "RelativeDateTime": { - "$ref": "#/definitions/FilterRelativeDateTimeControl" - }, - "Slider": { - "$ref": "#/definitions/FilterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/FilterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/FilterTextFieldControl" - } - }, - "type": "object" - }, - "FilterCrossSheetControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId" - ], - "type": "object" - }, - "FilterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterGroup": { - "additionalProperties": false, - "properties": { - "CrossDataset": { - "$ref": "#/definitions/CrossDatasetTypes" - }, - "FilterGroupId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Filters": { - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "ScopeConfiguration": { - "$ref": "#/definitions/FilterScopeConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "CrossDataset", - "FilterGroupId", - "Filters", - "ScopeConfiguration" - ], - "type": "object" - }, - "FilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator" - ], - "type": "object" - }, - "FilterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterNullOption": { - "enum": [ - "ALL_VALUES", - "NULLS_ONLY", - "NON_NULLS_ONLY" - ], - "type": "string" - }, - "FilterOperationSelectedFieldsConfiguration": { - "additionalProperties": false, - "properties": { - "SelectedColumns": { - "description": "

The selected columns of a dataset.

", - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "$ref": "#/definitions/SelectedFieldOptions" - }, - "SelectedFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "FilterOperationTargetVisualsConfiguration": { - "additionalProperties": false, - "properties": { - "SameSheetTargetVisualConfiguration": { - "$ref": "#/definitions/SameSheetTargetVisualConfiguration" - } - }, - "type": "object" - }, - "FilterRelativeDateTimeControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "AllSheets": { - "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" - }, - "SelectedSheets": { - "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" - } - }, - "type": "object" - }, - "FilterSelectableValues": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "FilterControlId", - "MaximumValue", - "MinimumValue", - "SourceFilterId", - "StepSize", - "Title" - ], - "type": "object" - }, - "FilterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterVisualScope": { - "enum": [ - "ALL_VISUALS", - "SELECTED_VISUALS" - ], - "type": "string" - }, - "FontConfiguration": { - "additionalProperties": false, - "properties": { - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontDecoration": { - "$ref": "#/definitions/FontDecoration" - }, - "FontSize": { - "$ref": "#/definitions/FontSize" - }, - "FontStyle": { - "$ref": "#/definitions/FontStyle" - }, - "FontWeight": { - "$ref": "#/definitions/FontWeight" - } - }, - "type": "object" - }, - "FontDecoration": { - "enum": [ - "UNDERLINE", - "NONE" - ], - "type": "string" - }, - "FontSize": { - "additionalProperties": false, - "properties": { - "Relative": { - "$ref": "#/definitions/RelativeFontSize" - } - }, - "type": "object" - }, - "FontStyle": { - "enum": [ - "NORMAL", - "ITALIC" - ], - "type": "string" - }, - "FontWeight": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/FontWeightName" - } - }, - "type": "object" - }, - "FontWeightName": { - "enum": [ - "NORMAL", - "BOLD" - ], - "type": "string" - }, - "ForecastComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "CustomSeasonalityValue": { - "default": null, - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "LowerBoundary": { - "default": null, - "type": "number" - }, - "Name": { - "type": "string" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "$ref": "#/definitions/ForecastComputationSeasonality" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "UpperBoundary": { - "default": null, - "type": "number" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ForecastComputationSeasonality": { - "enum": [ - "AUTOMATIC", - "CUSTOM" - ], - "type": "string" - }, - "ForecastConfiguration": { - "additionalProperties": false, - "properties": { - "ForecastProperties": { - "$ref": "#/definitions/TimeBasedForecastProperties" - }, - "Scenario": { - "$ref": "#/definitions/ForecastScenario" - } - }, - "type": "object" - }, - "ForecastScenario": { - "additionalProperties": false, - "properties": { - "WhatIfPointScenario": { - "$ref": "#/definitions/WhatIfPointScenario" - }, - "WhatIfRangeScenario": { - "$ref": "#/definitions/WhatIfRangeScenario" - } - }, - "type": "object" - }, - "FormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "NumberFormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "StringFormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "type": "object" - }, - "FreeFormLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "FreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FreeFormLayoutElement": { - "additionalProperties": false, - "properties": { - "BackgroundStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" - }, - "BorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "LoadingAnimation": { - "$ref": "#/definitions/LoadingAnimation" - }, - "RenderingRules": { - "items": { - "$ref": "#/definitions/SheetElementRenderingRule" - }, - "maxItems": 10000, - "minItems": 0, - "type": "array" - }, - "SelectedBorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "XAxisLocation": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "YAxisLocation": { - "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", - "type": "string" - } - }, - "required": [ - "ElementId", - "ElementType", - "Height", - "Width", - "XAxisLocation", - "YAxisLocation" - ], - "type": "object" - }, - "FreeFormLayoutElementBackgroundStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutElementBorderStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "OptimizedViewPortWidth" - ], - "type": "object" - }, - "FreeFormSectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FunnelChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabelOptions": { - "$ref": "#/definitions/FunnelChartDataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/FunnelChartFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/FunnelChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "FunnelChartDataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureDataLabelStyle": { - "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FunnelChartFieldWells": { - "additionalProperties": false, - "properties": { - "FunnelChartAggregatedFieldWells": { - "$ref": "#/definitions/FunnelChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "FunnelChartMeasureDataLabelStyle": { - "enum": [ - "VALUE_ONLY", - "PERCENTAGE_BY_FIRST_STAGE", - "PERCENTAGE_BY_PREVIOUS_STAGE", - "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", - "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" - ], - "type": "string" - }, - "FunnelChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FunnelChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GaugeChartArcConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/GaugeChartConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/GaugeChartArcConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" - } - }, - "type": "object" - }, - "GaugeChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/GaugeChartFieldWells" - }, - "GaugeChartOptions": { - "$ref": "#/definitions/GaugeChartOptions" - }, - "TooltipOptions": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "GaugeChartFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartOptions": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/ArcConfiguration" - }, - "ArcAxis": { - "$ref": "#/definitions/ArcAxisConfiguration" - }, - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "GaugeChartPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GaugeChartConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/GaugeChartConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialCoordinateBounds": { - "additionalProperties": false, - "properties": { - "East": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - }, - "North": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "South": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "West": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - } - }, - "required": [ - "East", - "North", - "South", - "West" - ], - "type": "object" - }, - "GeospatialHeatmapColorScale": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/GeospatialHeatmapDataColor" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialHeatmapConfiguration": { - "additionalProperties": false, - "properties": { - "HeatmapColor": { - "$ref": "#/definitions/GeospatialHeatmapColorScale" - } - }, - "type": "object" - }, - "GeospatialHeatmapDataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "GeospatialMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/GeospatialMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "PointStyleOptions": { - "$ref": "#/definitions/GeospatialPointStyleOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "GeospatialMapFieldWells": { - "additionalProperties": false, - "properties": { - "GeospatialMapAggregatedFieldWells": { - "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "GeospatialMapStyleOptions": { - "additionalProperties": false, - "properties": { - "BaseMapStyle": { - "$ref": "#/definitions/BaseMapStyleType" - } - }, - "type": "object" - }, - "GeospatialMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GeospatialMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialPointStyleOptions": { - "additionalProperties": false, - "properties": { - "ClusterMarkerConfiguration": { - "$ref": "#/definitions/ClusterMarkerConfiguration" - }, - "HeatmapConfiguration": { - "$ref": "#/definitions/GeospatialHeatmapConfiguration" - }, - "SelectedPointStyle": { - "$ref": "#/definitions/GeospatialSelectedPointStyle" - } - }, - "type": "object" - }, - "GeospatialSelectedPointStyle": { - "enum": [ - "POINT", - "CLUSTER", - "HEATMAP" - ], - "type": "string" - }, - "GeospatialWindowOptions": { - "additionalProperties": false, - "properties": { - "Bounds": { - "$ref": "#/definitions/GeospatialCoordinateBounds" - }, - "MapZoomMode": { - "$ref": "#/definitions/MapZoomMode" - } - }, - "type": "object" - }, - "GlobalTableBorderOptions": { - "additionalProperties": false, - "properties": { - "SideSpecificBorder": { - "$ref": "#/definitions/TableSideBorderOptions" - }, - "UniformBorder": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "GradientColor": { - "additionalProperties": false, - "properties": { - "Stops": { - "items": { - "$ref": "#/definitions/GradientStop" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GradientStop": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - }, - "GradientOffset": { - "default": 0, - "type": "number" - } - }, - "required": [ - "GradientOffset" - ], - "type": "object" - }, - "GridLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "GridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/GridLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "GridLayoutElement": { - "additionalProperties": false, - "properties": { - "ColumnIndex": { - "maximum": 35, - "minimum": 0, - "type": "number" - }, - "ColumnSpan": { - "maximum": 36, - "minimum": 1, - "type": "number" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "RowIndex": { - "maximum": 9009, - "minimum": 0, - "type": "number" - }, - "RowSpan": { - "maximum": 21, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "ColumnSpan", - "ElementId", - "ElementType", - "RowSpan" - ], - "type": "object" - }, - "GridLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "ResizeOption": { - "$ref": "#/definitions/ResizeOption" - } - }, - "required": [ - "ResizeOption" - ], - "type": "object" - }, - "GrowthRateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodSize": { - "default": 0, - "maximum": 52, - "minimum": 2, - "type": "number" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "HeaderFooterSectionConfiguration": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Layout", - "SectionId" - ], - "type": "object" - }, - "HeatMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "ColumnLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HeatMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "RowLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/HeatMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "HeatMapFieldWells": { - "additionalProperties": false, - "properties": { - "HeatMapAggregatedFieldWells": { - "$ref": "#/definitions/HeatMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "HeatMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "HeatMapColumnItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapColumnSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "HeatMapRowItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapRowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HeatMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HistogramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HistogramBinOptions": { - "additionalProperties": false, - "properties": { - "BinCount": { - "$ref": "#/definitions/BinCountOptions" - }, - "BinWidth": { - "$ref": "#/definitions/BinWidthOptions" - }, - "SelectedBinType": { - "$ref": "#/definitions/HistogramBinType" - }, - "StartValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "HistogramBinType": { - "enum": [ - "BIN_COUNT", - "BIN_WIDTH" - ], - "type": "string" - }, - "HistogramConfiguration": { - "additionalProperties": false, - "properties": { - "BinOptions": { - "$ref": "#/definitions/HistogramBinOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HistogramFieldWells" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - } - }, - "type": "object" - }, - "HistogramFieldWells": { - "additionalProperties": false, - "properties": { - "HistogramAggregatedFieldWells": { - "$ref": "#/definitions/HistogramAggregatedFieldWells" - } - }, - "type": "object" - }, - "HistogramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HistogramConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HorizontalTextAlignment": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT", - "AUTO" - ], - "type": "string" - }, - "Icon": { - "enum": [ - "CARET_UP", - "CARET_DOWN", - "PLUS", - "MINUS", - "ARROW_UP", - "ARROW_DOWN", - "ARROW_LEFT", - "ARROW_UP_LEFT", - "ARROW_DOWN_LEFT", - "ARROW_RIGHT", - "ARROW_UP_RIGHT", - "ARROW_DOWN_RIGHT", - "FACE_UP", - "FACE_DOWN", - "FACE_FLAT", - "ONE_BAR", - "TWO_BAR", - "THREE_BAR", - "CIRCLE", - "TRIANGLE", - "SQUARE", - "FLAG", - "THUMBS_UP", - "THUMBS_DOWN", - "CHECKMARK", - "X" - ], - "type": "string" - }, - "InsightConfiguration": { - "additionalProperties": false, - "properties": { - "Computations": { - "items": { - "$ref": "#/definitions/Computation" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "CustomNarrative": { - "$ref": "#/definitions/CustomNarrativeOptions" - } - }, - "type": "object" - }, - "InsightVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "InsightConfiguration": { - "$ref": "#/definitions/InsightConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "IntegerDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "IntegerParameter": { - "additionalProperties": false, - "description": "

An integer parameter.

", - "properties": { - "Name": { - "description": "

The name of the integer parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the integer parameter.

", - "items": { - "default": 0, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "IntegerParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/IntegerDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "IntegerValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "ItemsLimitConfiguration": { - "additionalProperties": false, - "properties": { - "ItemsLimit": { - "default": null, - "type": "number" - }, - "OtherCategories": { - "$ref": "#/definitions/OtherCategories" - } - }, - "type": "object" - }, - "KPIActualValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIComparisonValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/KPIConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "ActualValue": { - "$ref": "#/definitions/KPIActualValueConditionalFormatting" - }, - "ComparisonValue": { - "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" - }, - "ProgressBar": { - "$ref": "#/definitions/KPIProgressBarConditionalFormatting" - } - }, - "type": "object" - }, - "KPIConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/KPIFieldWells" - }, - "KPIOptions": { - "$ref": "#/definitions/KPIOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/KPISortConfiguration" - } - }, - "type": "object" - }, - "KPIFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrendGroups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIOptions": { - "additionalProperties": false, - "properties": { - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "ProgressBar": { - "$ref": "#/definitions/ProgressBarOptions" - }, - "SecondaryValue": { - "$ref": "#/definitions/SecondaryValueOptions" - }, - "SecondaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Sparkline": { - "$ref": "#/definitions/KPISparklineOptions" - }, - "TrendArrows": { - "$ref": "#/definitions/TrendArrowOptions" - }, - "VisualLayoutOptions": { - "$ref": "#/definitions/KPIVisualLayoutOptions" - } - }, - "type": "object" - }, - "KPIPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIProgressBarConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPISortConfiguration": { - "additionalProperties": false, - "properties": { - "TrendGroupSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPISparklineOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Type": { - "$ref": "#/definitions/KPISparklineType" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPISparklineType": { - "enum": [ - "LINE", - "AREA" - ], - "type": "string" - }, - "KPIVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/KPIConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/KPIConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "KPIVisualLayoutOptions": { - "additionalProperties": false, - "properties": { - "StandardLayout": { - "$ref": "#/definitions/KPIVisualStandardLayout" - } - }, - "type": "object" - }, - "KPIVisualStandardLayout": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/KPIVisualStandardLayoutType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPIVisualStandardLayoutType": { - "enum": [ - "CLASSIC", - "VERTICAL" - ], - "type": "string" - }, - "LabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "Layout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/LayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "LayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormLayoutConfiguration" - }, - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - }, - "SectionBasedLayout": { - "$ref": "#/definitions/SectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "LayoutElementType": { - "enum": [ - "VISUAL", - "FILTER_CONTROL", - "PARAMETER_CONTROL", - "TEXT_BOX" - ], - "type": "string" - }, - "LegendOptions": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Position": { - "$ref": "#/definitions/LegendPosition" - }, - "Title": { - "$ref": "#/definitions/LabelOptions" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LegendPosition": { - "enum": [ - "AUTO", - "RIGHT", - "BOTTOM", - "TOP" - ], - "type": "string" - }, - "LineChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartConfiguration": { - "additionalProperties": false, - "properties": { - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DefaultSeriesSettings": { - "$ref": "#/definitions/LineChartDefaultSeriesSettings" - }, - "FieldWells": { - "$ref": "#/definitions/LineChartFieldWells" - }, - "ForecastConfigurations": { - "items": { - "$ref": "#/definitions/ForecastConfiguration" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Series": { - "items": { - "$ref": "#/definitions/SeriesItem" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/LineChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "Type": { - "$ref": "#/definitions/LineChartType" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "LineChartDefaultSeriesSettings": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartFieldWells": { - "additionalProperties": false, - "properties": { - "LineChartAggregatedFieldWells": { - "$ref": "#/definitions/LineChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "LineChartLineStyle": { - "enum": [ - "SOLID", - "DOTTED", - "DASHED" - ], - "type": "string" - }, - "LineChartLineStyleSettings": { - "additionalProperties": false, - "properties": { - "LineInterpolation": { - "$ref": "#/definitions/LineInterpolation" - }, - "LineStyle": { - "$ref": "#/definitions/LineChartLineStyle" - }, - "LineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LineWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LineChartMarkerShape": { - "enum": [ - "CIRCLE", - "TRIANGLE", - "SQUARE", - "DIAMOND", - "ROUNDED_SQUARE" - ], - "type": "string" - }, - "LineChartMarkerStyleSettings": { - "additionalProperties": false, - "properties": { - "MarkerColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "MarkerShape": { - "$ref": "#/definitions/LineChartMarkerShape" - }, - "MarkerSize": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MarkerVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LineChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartType": { - "enum": [ - "LINE", - "AREA", - "STACKED_AREA" - ], - "type": "string" - }, - "LineChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/LineChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "LineInterpolation": { - "enum": [ - "LINEAR", - "SMOOTH", - "STEPPED" - ], - "type": "string" - }, - "LineSeriesAxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "MissingDataConfigurations": { - "items": { - "$ref": "#/definitions/MissingDataConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ListControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SearchOptions": { - "$ref": "#/definitions/ListControlSearchOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "ListControlSearchOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ListControlSelectAllOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LoadingAnimation": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LocalNavigationConfiguration": { - "additionalProperties": false, - "properties": { - "TargetSheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "TargetSheetId" - ], - "type": "object" - }, - "LongFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "MapZoomMode": { - "enum": [ - "AUTO", - "MANUAL" - ], - "type": "string" - }, - "MappedDataSetParameter": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DataSetParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "DataSetParameterName" - ], - "type": "object" - }, - "MaximumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MaximumMinimumComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/MaximumMinimumComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "MaximumMinimumComputationType": { - "enum": [ - "MAXIMUM", - "MINIMUM" - ], - "type": "string" - }, - "MeasureField": { - "additionalProperties": false, - "properties": { - "CalculatedMeasureField": { - "$ref": "#/definitions/CalculatedMeasureField" - }, - "CategoricalMeasureField": { - "$ref": "#/definitions/CategoricalMeasureField" - }, - "DateMeasureField": { - "$ref": "#/definitions/DateMeasureField" - }, - "NumericalMeasureField": { - "$ref": "#/definitions/NumericalMeasureField" - } - }, - "type": "object" - }, - "MetricComparisonComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "FromValue": { - "$ref": "#/definitions/MeasureField" - }, - "Name": { - "type": "string" - }, - "TargetValue": { - "$ref": "#/definitions/MeasureField" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "MinimumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MissingDataConfiguration": { - "additionalProperties": false, - "properties": { - "TreatmentOption": { - "$ref": "#/definitions/MissingDataTreatmentOption" - } - }, - "type": "object" - }, - "MissingDataTreatmentOption": { - "enum": [ - "INTERPOLATE", - "SHOW_AS_ZERO", - "SHOW_AS_BLANK" - ], - "type": "string" - }, - "NegativeValueConfiguration": { - "additionalProperties": false, - "properties": { - "DisplayMode": { - "$ref": "#/definitions/NegativeValueDisplayMode" - } - }, - "required": [ - "DisplayMode" - ], - "type": "object" - }, - "NegativeValueDisplayMode": { - "enum": [ - "POSITIVE", - "NEGATIVE" - ], - "type": "string" - }, - "NullValueFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullString": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "NullString" - ], - "type": "object" - }, - "NumberDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "NumberFormatConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "NumberScale": { - "enum": [ - "NONE", - "AUTO", - "THOUSANDS", - "MILLIONS", - "BILLIONS", - "TRILLIONS" - ], - "type": "string" - }, - "NumericAxisOptions": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/AxisDisplayRange" - }, - "Scale": { - "$ref": "#/definitions/AxisScale" - } - }, - "type": "object" - }, - "NumericEqualityDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Column", - "Value" - ], - "type": "object" - }, - "NumericEqualityFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/NumericEqualityMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - }, - "Value": { - "default": null, - "type": "number" - } - }, - "required": [ - "Column", - "FilterId", - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "NumericEqualityMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL" - ], - "type": "string" - }, - "NumericFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "NumericFormatConfiguration": { - "additionalProperties": false, - "properties": { - "CurrencyDisplayFormatConfiguration": { - "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" - }, - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "NumericRangeFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "RangeMinimum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "NumericRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StaticValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "NumericSeparatorConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalSeparator": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "ThousandsSeparator": { - "$ref": "#/definitions/ThousandSeparatorOptions" - } - }, - "type": "object" - }, - "NumericSeparatorSymbol": { - "enum": [ - "COMMA", - "DOT", - "SPACE" - ], - "type": "string" - }, - "NumericalAggregationFunction": { - "additionalProperties": false, - "properties": { - "PercentileAggregation": { - "$ref": "#/definitions/PercentileAggregation" - }, - "SimpleNumericalAggregation": { - "$ref": "#/definitions/SimpleNumericalAggregationFunction" - } - }, - "type": "object" - }, - "NumericalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "NumericalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "OtherCategories": { - "enum": [ - "INCLUDE", - "EXCLUDE" - ], - "type": "string" - }, - "PaginationConfiguration": { - "additionalProperties": false, - "properties": { - "PageNumber": { - "minimum": 0, - "type": "number" - }, - "PageSize": { - "default": null, - "type": "number" - } - }, - "required": [ - "PageNumber", - "PageSize" - ], - "type": "object" - }, - "PanelBorderStyle": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "PanelConfiguration": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BackgroundVisibility": { - "$ref": "#/definitions/Visibility" - }, - "BorderColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BorderStyle": { - "$ref": "#/definitions/PanelBorderStyle" - }, - "BorderThickness": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "BorderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "GutterSpacing": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "GutterVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Title": { - "$ref": "#/definitions/PanelTitleOptions" - } - }, - "type": "object" - }, - "PanelTitleOptions": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PaperOrientation": { - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "PaperSize": { - "enum": [ - "US_LETTER", - "US_LEGAL", - "US_TABLOID_LEDGER", - "A0", - "A1", - "A2", - "A3", - "A4", - "A5", - "JIS_B4", - "JIS_B5" - ], - "type": "string" - }, - "ParameterControl": { - "additionalProperties": false, - "properties": { - "DateTimePicker": { - "$ref": "#/definitions/ParameterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/ParameterDropDownControl" - }, - "List": { - "$ref": "#/definitions/ParameterListControl" - }, - "Slider": { - "$ref": "#/definitions/ParameterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/ParameterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/ParameterTextFieldControl" - } - }, - "type": "object" - }, - "ParameterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DateTimeParameterDeclaration": { - "$ref": "#/definitions/DateTimeParameterDeclaration" - }, - "DecimalParameterDeclaration": { - "$ref": "#/definitions/DecimalParameterDeclaration" - }, - "IntegerParameterDeclaration": { - "$ref": "#/definitions/IntegerParameterDeclaration" - }, - "StringParameterDeclaration": { - "$ref": "#/definitions/StringParameterDeclaration" - } - }, - "type": "object" - }, - "ParameterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterSelectableValues": { - "additionalProperties": false, - "properties": { - "LinkToDataSetColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ParameterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "ParameterControlId", - "SourceParameterName", - "StepSize", - "Title" - ], - "type": "object" - }, - "ParameterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterValueType": { - "enum": [ - "MULTI_VALUED", - "SINGLE_VALUED" - ], - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "description": "

A list of Amazon QuickSight parameters and the list's override values.

", - "properties": { - "DateTimeParameters": { - "description": "

The parameters that have a data type of date-time.

", - "items": { - "$ref": "#/definitions/DateTimeParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "DecimalParameters": { - "description": "

The parameters that have a data type of decimal.

", - "items": { - "$ref": "#/definitions/DecimalParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "IntegerParameters": { - "description": "

The parameters that have a data type of integer.

", - "items": { - "$ref": "#/definitions/IntegerParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "StringParameters": { - "description": "

The parameters that have a data type of string.

", - "items": { - "$ref": "#/definitions/StringParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PercentVisibleRange": { - "additionalProperties": false, - "properties": { - "From": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "To": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PercentageDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PercentileAggregation": { - "additionalProperties": false, - "properties": { - "PercentileValue": { - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PeriodOverPeriodComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PeriodToDateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodTimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PieChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DonutOptions": { - "$ref": "#/definitions/DonutOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PieChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PieChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "PieChartFieldWells": { - "additionalProperties": false, - "properties": { - "PieChartAggregatedFieldWells": { - "$ref": "#/definitions/PieChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "PieChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PieChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotFieldSortOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SortBy": { - "$ref": "#/definitions/PivotTableSortBy" - } - }, - "required": [ - "FieldId", - "SortBy" - ], - "type": "object" - }, - "PivotTableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Scope": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "Scopes": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/PivotTableCellConditionalFormatting" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScope": { - "additionalProperties": false, - "properties": { - "Role": { - "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScopeRole": { - "enum": [ - "FIELD", - "FIELD_TOTAL", - "GRAND_TOTAL" - ], - "type": "string" - }, - "PivotTableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/PivotTableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PivotTableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/PivotTablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PivotTableSortConfiguration" - }, - "TableOptions": { - "$ref": "#/definitions/PivotTableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/PivotTableTotalOptions" - } - }, - "type": "object" - }, - "PivotTableDataPathOption": { - "additionalProperties": false, - "properties": { - "DataPathList": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "DataPathList" - ], - "type": "object" - }, - "PivotTableDataPathType": { - "enum": [ - "HIERARCHY_ROWS_LAYOUT_COLUMN", - "MULTIPLE_ROW_METRICS_COLUMN", - "EMPTY_COLUMN_HEADER", - "COUNT_METRIC_COLUMN" - ], - "type": "string" - }, - "PivotTableFieldCollapseState": { - "enum": [ - "COLLAPSED", - "EXPANDED" - ], - "type": "string" - }, - "PivotTableFieldCollapseStateOption": { - "additionalProperties": false, - "properties": { - "State": { - "$ref": "#/definitions/PivotTableFieldCollapseState" - }, - "Target": { - "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "PivotTableFieldCollapseStateTarget": { - "additionalProperties": false, - "properties": { - "FieldDataPathValues": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "FieldId": { - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableFieldOptions": { - "additionalProperties": false, - "properties": { - "CollapseStateOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldCollapseStateOption" - }, - "type": "array" - }, - "DataPathOptions": { - "items": { - "$ref": "#/definitions/PivotTableDataPathOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableFieldSubtotalOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldWells": { - "additionalProperties": false, - "properties": { - "PivotTableAggregatedFieldWells": { - "$ref": "#/definitions/PivotTableAggregatedFieldWells" - } - }, - "type": "object" - }, - "PivotTableMetricPlacement": { - "enum": [ - "ROW", - "COLUMN" - ], - "type": "string" - }, - "PivotTableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "CollapsedRowDimensionsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ColumnHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "ColumnNamesVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DefaultCellWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MetricPlacement": { - "$ref": "#/definitions/PivotTableMetricPlacement" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - }, - "RowFieldNamesStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowsLabelOptions": { - "$ref": "#/definitions/PivotTableRowsLabelOptions" - }, - "RowsLayout": { - "$ref": "#/definitions/PivotTableRowsLayout" - }, - "SingleMetricVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ToggleButtonsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLayout": { - "enum": [ - "TABULAR", - "HIERARCHY" - ], - "type": "string" - }, - "PivotTableSortBy": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnSort" - }, - "DataPath": { - "$ref": "#/definitions/DataPathSort" - }, - "Field": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "PivotTableSortConfiguration": { - "additionalProperties": false, - "properties": { - "FieldSortOptions": { - "items": { - "$ref": "#/definitions/PivotFieldSortOptions" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableSubtotalLevel": { - "enum": [ - "ALL", - "CUSTOM", - "LAST" - ], - "type": "string" - }, - "PivotTableTotalOptions": { - "additionalProperties": false, - "properties": { - "ColumnSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "ColumnTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - }, - "RowSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "RowTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - } - }, - "type": "object" - }, - "PivotTableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PivotTableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/PivotTableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotTotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "PredefinedHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "PrimaryValueDisplayType": { - "enum": [ - "HIDDEN", - "COMPARISON", - "ACTUAL" - ], - "type": "string" - }, - "ProgressBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Color": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartAreaStyleSettings": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAxesRangeScale": { - "enum": [ - "AUTO", - "INDEPENDENT", - "SHARED" - ], - "type": "string" - }, - "RadarChartConfiguration": { - "additionalProperties": false, - "properties": { - "AlternateBandColorsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AlternateBandEvenColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AlternateBandOddColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AxesRangeScale": { - "$ref": "#/definitions/RadarChartAxesRangeScale" - }, - "BaseSeriesSettings": { - "$ref": "#/definitions/RadarChartSeriesSettings" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/RadarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Shape": { - "$ref": "#/definitions/RadarChartShape" - }, - "SortConfiguration": { - "$ref": "#/definitions/RadarChartSortConfiguration" - }, - "StartAngle": { - "maximum": 360, - "minimum": -360, - "type": "number" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "RadarChartFieldWells": { - "additionalProperties": false, - "properties": { - "RadarChartAggregatedFieldWells": { - "$ref": "#/definitions/RadarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "RadarChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "AreaStyleSettings": { - "$ref": "#/definitions/RadarChartAreaStyleSettings" - } - }, - "type": "object" - }, - "RadarChartShape": { - "enum": [ - "CIRCLE", - "POLYGON" - ], - "type": "string" - }, - "RadarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/RadarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "RangeEndsLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ReferenceLine": { - "additionalProperties": false, - "properties": { - "DataConfiguration": { - "$ref": "#/definitions/ReferenceLineDataConfiguration" - }, - "LabelConfiguration": { - "$ref": "#/definitions/ReferenceLineLabelConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "StyleConfiguration": { - "$ref": "#/definitions/ReferenceLineStyleConfiguration" - } - }, - "required": [ - "DataConfiguration" - ], - "type": "object" - }, - "ReferenceLineCustomLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "CustomLabel" - ], - "type": "object" - }, - "ReferenceLineDataConfiguration": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "DynamicConfiguration": { - "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" - }, - "SeriesType": { - "$ref": "#/definitions/ReferenceLineSeriesType" - }, - "StaticConfiguration": { - "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" - } - }, - "type": "object" - }, - "ReferenceLineDynamicDataConfiguration": { - "additionalProperties": false, - "properties": { - "Calculation": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "MeasureAggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - } - }, - "required": [ - "Calculation", - "Column" - ], - "type": "object" - }, - "ReferenceLineLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" - }, - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalPosition": { - "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" - }, - "ValueLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" - }, - "VerticalPosition": { - "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" - } - }, - "type": "object" - }, - "ReferenceLineLabelHorizontalPosition": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT" - ], - "type": "string" - }, - "ReferenceLineLabelVerticalPosition": { - "enum": [ - "ABOVE", - "BELOW" - ], - "type": "string" - }, - "ReferenceLinePatternType": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "ReferenceLineSeriesType": { - "enum": [ - "BAR", - "LINE" - ], - "type": "string" - }, - "ReferenceLineStaticDataConfiguration": { - "additionalProperties": false, - "properties": { - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "ReferenceLineStyleConfiguration": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Pattern": { - "$ref": "#/definitions/ReferenceLinePatternType" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - }, - "RelativePosition": { - "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelRelativePosition": { - "enum": [ - "BEFORE_CUSTOM_LABEL", - "AFTER_CUSTOM_LABEL" - ], - "type": "string" - }, - "RelativeDateTimeControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "RelativeDateType": { - "enum": [ - "PREVIOUS", - "THIS", - "LAST", - "NOW", - "NEXT" - ], - "type": "string" - }, - "RelativeDatesFilter": { - "additionalProperties": false, - "properties": { - "AnchorDateConfiguration": { - "$ref": "#/definitions/AnchorDateConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MinimumGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RelativeDateType": { - "$ref": "#/definitions/RelativeDateType" - }, - "RelativeDateValue": { - "default": null, - "type": "number" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AnchorDateConfiguration", - "Column", - "FilterId", - "NullOption", - "RelativeDateType", - "TimeGranularity" - ], - "type": "object" - }, - "RelativeFontSize": { - "enum": [ - "EXTRA_SMALL", - "SMALL", - "MEDIUM", - "LARGE", - "EXTRA_LARGE" - ], - "type": "string" - }, - "ResizeOption": { - "enum": [ - "FIXED", - "RESPONSIVE" - ], - "type": "string" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "ResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETED" - ], - "type": "string" - }, - "RollingDateConfiguration": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "RowAlternateColorOptions": { - "additionalProperties": false, - "properties": { - "RowAlternateColors": { - "items": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "UsePrimaryBackgroundColor": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "type": "object" - }, - "SameSheetTargetVisualConfiguration": { - "additionalProperties": false, - "properties": { - "TargetVisualOptions": { - "$ref": "#/definitions/TargetVisualOptions" - }, - "TargetVisuals": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Destination": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Source": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Weight": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/SankeyDiagramFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/SankeyDiagramSortConfiguration" - } - }, - "type": "object" - }, - "SankeyDiagramFieldWells": { - "additionalProperties": false, - "properties": { - "SankeyDiagramAggregatedFieldWells": { - "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" - } - }, - "type": "object" - }, - "SankeyDiagramSortConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SourceItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "WeightSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/SankeyDiagramChartConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScatterPlotCategoricallyAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ScatterPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "YAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "ScatterPlotFieldWells": { - "additionalProperties": false, - "properties": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" - }, - "ScatterPlotUnaggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "ScatterPlotUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ScatterPlotConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScrollBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "VisibleRange": { - "$ref": "#/definitions/VisibleRangeOptions" - } - }, - "type": "object" - }, - "SecondaryValueOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SectionAfterPageBreak": { - "additionalProperties": false, - "properties": { - "Status": { - "$ref": "#/definitions/SectionPageBreakStatus" - } - }, - "type": "object" - }, - "SectionBasedLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperCanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" - } - }, - "type": "object" - }, - "SectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "BodySections": { - "items": { - "$ref": "#/definitions/BodySectionConfiguration" - }, - "maxItems": 28, - "minItems": 0, - "type": "array" - }, - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - }, - "FooterSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "HeaderSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "BodySections", - "CanvasSizeOptions", - "FooterSections", - "HeaderSections" - ], - "type": "object" - }, - "SectionBasedLayoutPaperCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperMargin": { - "$ref": "#/definitions/Spacing" - }, - "PaperOrientation": { - "$ref": "#/definitions/PaperOrientation" - }, - "PaperSize": { - "$ref": "#/definitions/PaperSize" - } - }, - "type": "object" - }, - "SectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" - } - }, - "required": [ - "FreeFormLayout" - ], - "type": "object" - }, - "SectionPageBreakConfiguration": { - "additionalProperties": false, - "properties": { - "After": { - "$ref": "#/definitions/SectionAfterPageBreak" - } - }, - "type": "object" - }, - "SectionPageBreakStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "SectionStyle": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Padding": { - "$ref": "#/definitions/Spacing" - } - }, - "type": "object" - }, - "SelectAllValueOptions": { - "enum": [ - "ALL_VALUES" - ], - "type": "string" - }, - "SelectedFieldOptions": { - "enum": [ - "ALL_FIELDS" - ], - "type": "string" - }, - "SelectedSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "SheetVisualScopingConfigurations": { - "items": { - "$ref": "#/definitions/SheetVisualScopingConfiguration" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SelectedTooltipType": { - "enum": [ - "BASIC", - "DETAILED" - ], - "type": "string" - }, - "SeriesItem": { - "additionalProperties": false, - "properties": { - "DataFieldSeriesItem": { - "$ref": "#/definitions/DataFieldSeriesItem" - }, - "FieldSeriesItem": { - "$ref": "#/definitions/FieldSeriesItem" - } - }, - "type": "object" - }, - "SetParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/DestinationParameterValueConfiguration" - } - }, - "required": [ - "DestinationParameterName", - "Value" - ], - "type": "object" - }, - "ShapeConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "required": [ - "BackgroundColor" - ], - "type": "object" - }, - "Sheet": { - "additionalProperties": false, - "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", - "properties": { - "Name": { - "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "SheetId": { - "description": "

The unique identifier associated with a sheet.

", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "type": "object" - }, - "SheetContentType": { - "enum": [ - "PAGINATED", - "INTERACTIVE" - ], - "type": "string" - }, - "SheetControlDateTimePickerType": { - "enum": [ - "SINGLE_VALUED", - "DATE_RANGE" - ], - "type": "string" - }, - "SheetControlInfoIconLabelOptions": { - "additionalProperties": false, - "properties": { - "InfoIconText": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetControlLayout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/SheetControlLayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "SheetControlLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - } - }, - "type": "object" - }, - "SheetControlListType": { - "enum": [ - "MULTI_SELECT", - "SINGLE_SELECT" - ], - "type": "string" - }, - "SheetControlSliderType": { - "enum": [ - "SINGLE_POINT", - "RANGE" - ], - "type": "string" - }, - "SheetDefinition": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/SheetContentType" - }, - "Description": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "FilterControls": { - "items": { - "$ref": "#/definitions/FilterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Layouts": { - "items": { - "$ref": "#/definitions/Layout" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ParameterControls": { - "items": { - "$ref": "#/definitions/ParameterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SheetControlLayouts": { - "items": { - "$ref": "#/definitions/SheetControlLayout" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "TextBoxes": { - "items": { - "$ref": "#/definitions/SheetTextBox" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Title": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visuals": { - "items": { - "$ref": "#/definitions/Visual" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "SheetId" - ], - "type": "object" - }, - "SheetElementConfigurationOverrides": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetElementRenderingRule": { - "additionalProperties": false, - "properties": { - "ConfigurationOverrides": { - "$ref": "#/definitions/SheetElementConfigurationOverrides" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConfigurationOverrides", - "Expression" - ], - "type": "object" - }, - "SheetTextBox": { - "additionalProperties": false, - "properties": { - "Content": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - }, - "SheetTextBoxId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "SheetTextBoxId" - ], - "type": "object" - }, - "SheetVisualScopingConfiguration": { - "additionalProperties": false, - "properties": { - "Scope": { - "$ref": "#/definitions/FilterVisualScope" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "VisualIds": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Scope", - "SheetId" - ], - "type": "object" - }, - "ShortFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SimpleAttributeAggregationFunction": { - "enum": [ - "UNIQUE_VALUE" - ], - "type": "string" - }, - "SimpleClusterMarker": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "SimpleNumericalAggregationFunction": { - "enum": [ - "SUM", - "AVERAGE", - "MIN", - "MAX", - "COUNT", - "DISTINCT_COUNT", - "VAR", - "VARP", - "STDEV", - "STDEVP", - "MEDIAN" - ], - "type": "string" - }, - "SimpleTotalAggregationFunction": { - "enum": [ - "DEFAULT", - "SUM", - "AVERAGE", - "MIN", - "MAX", - "NONE" - ], - "type": "string" - }, - "SliderControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "SmallMultiplesAxisPlacement": { - "enum": [ - "OUTSIDE", - "INSIDE" - ], - "type": "string" - }, - "SmallMultiplesAxisProperties": { - "additionalProperties": false, - "properties": { - "Placement": { - "$ref": "#/definitions/SmallMultiplesAxisPlacement" - }, - "Scale": { - "$ref": "#/definitions/SmallMultiplesAxisScale" - } - }, - "type": "object" - }, - "SmallMultiplesAxisScale": { - "enum": [ - "SHARED", - "INDEPENDENT" - ], - "type": "string" - }, - "SmallMultiplesOptions": { - "additionalProperties": false, - "properties": { - "MaxVisibleColumns": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "MaxVisibleRows": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "PanelConfiguration": { - "$ref": "#/definitions/PanelConfiguration" - }, - "XAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - }, - "YAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - } - }, - "type": "object" - }, - "SortDirection": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "Spacing": { - "additionalProperties": false, - "properties": { - "Bottom": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Left": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Right": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Top": { - "description": "String based length that is composed of value and unit", - "type": "string" - } - }, - "type": "object" - }, - "SpecialValue": { - "enum": [ - "EMPTY", - "NULL", - "OTHER" - ], - "type": "string" - }, - "StringDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "StringFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "StringParameter": { - "additionalProperties": false, - "description": "

A string parameter.

", - "properties": { - "Name": { - "description": "

A display name for a string parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values of a string parameter.

", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "StringParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/StringDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/StringValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "StringValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "StyledCellType": { - "enum": [ - "TOTAL", - "METRIC_HEADER", - "VALUE" - ], - "type": "string" - }, - "SubtotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FieldLevel": { - "$ref": "#/definitions/PivotTableSubtotalLevel" - }, - "FieldLevelOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldSubtotalOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "StyleTargets": { - "items": { - "$ref": "#/definitions/TableStyleTarget" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "TableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableBorderOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/TableBorderStyle" - }, - "Thickness": { - "maximum": 4, - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "TableBorderStyle": { - "enum": [ - "NONE", - "SOLID" - ], - "type": "string" - }, - "TableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableCellImageScalingConfiguration": { - "enum": [ - "FIT_TO_CELL_HEIGHT", - "FIT_TO_CELL_WIDTH", - "DO_NOT_SCALE" - ], - "type": "string" - }, - "TableCellImageSizingConfiguration": { - "additionalProperties": false, - "properties": { - "TableCellImageScalingConfiguration": { - "$ref": "#/definitions/TableCellImageScalingConfiguration" - } - }, - "type": "object" - }, - "TableCellStyle": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Border": { - "$ref": "#/definitions/GlobalTableBorderOptions" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Height": { - "maximum": 500, - "minimum": 8, - "type": "number" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "TextWrap": { - "$ref": "#/definitions/TextWrap" - }, - "VerticalTextAlignment": { - "$ref": "#/definitions/VerticalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/TableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/TableCellConditionalFormatting" - }, - "Row": { - "$ref": "#/definitions/TableRowConditionalFormatting" - } - }, - "type": "object" - }, - "TableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/TableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/TablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TableSortConfiguration" - }, - "TableInlineVisualizations": { - "items": { - "$ref": "#/definitions/TableInlineVisualization" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TableOptions": { - "$ref": "#/definitions/TableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/TotalOptions" - } - }, - "type": "object" - }, - "TableFieldCustomIconContent": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/TableFieldIconSetType" - } - }, - "type": "object" - }, - "TableFieldCustomTextContent": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "FontConfiguration" - ], - "type": "object" - }, - "TableFieldIconSetType": { - "enum": [ - "LINK" - ], - "type": "string" - }, - "TableFieldImageConfiguration": { - "additionalProperties": false, - "properties": { - "SizingOptions": { - "$ref": "#/definitions/TableCellImageSizingConfiguration" - } - }, - "type": "object" - }, - "TableFieldLinkConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/TableFieldLinkContentConfiguration" - }, - "Target": { - "$ref": "#/definitions/URLTargetConfiguration" - } - }, - "required": [ - "Content", - "Target" - ], - "type": "object" - }, - "TableFieldLinkContentConfiguration": { - "additionalProperties": false, - "properties": { - "CustomIconContent": { - "$ref": "#/definitions/TableFieldCustomIconContent" - }, - "CustomTextContent": { - "$ref": "#/definitions/TableFieldCustomTextContent" - } - }, - "type": "object" - }, - "TableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "URLStyling": { - "$ref": "#/definitions/TableFieldURLConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableFieldOptions": { - "additionalProperties": false, - "properties": { - "Order": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "PinnedFieldOptions": { - "$ref": "#/definitions/TablePinnedFieldOptions" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/TableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableFieldURLConfiguration": { - "additionalProperties": false, - "properties": { - "ImageConfiguration": { - "$ref": "#/definitions/TableFieldImageConfiguration" - }, - "LinkConfiguration": { - "$ref": "#/definitions/TableFieldLinkConfiguration" - } - }, - "type": "object" - }, - "TableFieldWells": { - "additionalProperties": false, - "properties": { - "TableAggregatedFieldWells": { - "$ref": "#/definitions/TableAggregatedFieldWells" - }, - "TableUnaggregatedFieldWells": { - "$ref": "#/definitions/TableUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "TableInlineVisualization": { - "additionalProperties": false, - "properties": { - "DataBars": { - "$ref": "#/definitions/DataBarsOptions" - } - }, - "type": "object" - }, - "TableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "HeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Orientation": { - "$ref": "#/definitions/TableOrientation" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - } - }, - "type": "object" - }, - "TableOrientation": { - "enum": [ - "VERTICAL", - "HORIZONTAL" - ], - "type": "string" - }, - "TablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TablePinnedFieldOptions": { - "additionalProperties": false, - "properties": { - "PinnedLeftFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 201, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableRowConditionalFormatting": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TableSideBorderOptions": { - "additionalProperties": false, - "properties": { - "Bottom": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerHorizontal": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerVertical": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Left": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Right": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Top": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "TableSortConfiguration": { - "additionalProperties": false, - "properties": { - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - }, - "RowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableStyleTarget": { - "additionalProperties": false, - "properties": { - "CellType": { - "$ref": "#/definitions/StyledCellType" - } - }, - "required": [ - "CellType" - ], - "type": "object" - }, - "TableTotalsPlacement": { - "enum": [ - "START", - "END", - "AUTO" - ], - "type": "string" - }, - "TableTotalsScrollStatus": { - "enum": [ - "PINNED", - "SCROLLED" - ], - "type": "string" - }, - "TableUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/UnaggregatedField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/TableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TargetVisualOptions": { - "enum": [ - "ALL_VISUALS" - ], - "type": "string" - }, - "TextAreaControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TextControlPlaceholderOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TextFieldControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextWrap": { - "enum": [ - "NONE", - "WRAP" - ], - "type": "string" - }, - "ThousandSeparatorOptions": { - "additionalProperties": false, - "properties": { - "Symbol": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TimeBasedForecastProperties": { - "additionalProperties": false, - "properties": { - "LowerBoundary": { - "default": null, - "type": "number" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "UpperBoundary": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "TimeEqualityFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Value": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "Column", - "FilterId" - ], - "type": "object" - }, - "TimeGranularity": { - "enum": [ - "YEAR", - "QUARTER", - "MONTH", - "WEEK", - "DAY", - "HOUR", - "MINUTE", - "SECOND", - "MILLISECOND" - ], - "type": "string" - }, - "TimeRangeDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "RangeMaximum": { - "format": "date-time", - "type": "string" - }, - "RangeMinimum": { - "format": "date-time", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "RangeMaximum", - "RangeMinimum", - "TimeGranularity" - ], - "type": "object" - }, - "TimeRangeFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "RangeMinimumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "TimeRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValue": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "TooltipItem": { - "additionalProperties": false, - "properties": { - "ColumnTooltipItem": { - "$ref": "#/definitions/ColumnTooltipItem" - }, - "FieldTooltipItem": { - "$ref": "#/definitions/FieldTooltipItem" - } - }, - "type": "object" - }, - "TooltipOptions": { - "additionalProperties": false, - "properties": { - "FieldBasedTooltip": { - "$ref": "#/definitions/FieldBasedTooltip" - }, - "SelectedTooltipType": { - "$ref": "#/definitions/SelectedTooltipType" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TooltipTitleType": { - "enum": [ - "NONE", - "PRIMARY_VALUE" - ], - "type": "string" - }, - "TopBottomComputationType": { - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "TopBottomFilter": { - "additionalProperties": false, - "properties": { - "AggregationSortConfigurations": { - "items": { - "$ref": "#/definitions/AggregationSortConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Limit": { - "default": null, - "type": "number" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AggregationSortConfigurations", - "Column", - "FilterId" - ], - "type": "object" - }, - "TopBottomMoversComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MoverSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Name": { - "type": "string" - }, - "SortOrder": { - "$ref": "#/definitions/TopBottomSortOrder" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomRankedComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResultSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomSortOrder": { - "enum": [ - "PERCENT_DIFFERENCE", - "ABSOLUTE_DIFFERENCE" - ], - "type": "string" - }, - "TotalAggregationComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "TotalAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleTotalAggregationFunction": { - "$ref": "#/definitions/SimpleTotalAggregationFunction" - } - }, - "type": "object" - }, - "TotalAggregationOption": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TotalAggregationFunction": { - "$ref": "#/definitions/TotalAggregationFunction" - } - }, - "required": [ - "FieldId", - "TotalAggregationFunction" - ], - "type": "object" - }, - "TotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TreeMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Groups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Sizes": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TreeMapFieldWells" - }, - "GroupLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SizeLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TreeMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "TreeMapFieldWells": { - "additionalProperties": false, - "properties": { - "TreeMapAggregatedFieldWells": { - "$ref": "#/definitions/TreeMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "TreeMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "TreeMapGroupItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "TreeMapSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TreeMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "TrendArrowOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "URLTargetConfiguration": { - "enum": [ - "NEW_TAB", - "NEW_WINDOW", - "SAME_TAB" - ], - "type": "string" - }, - "UnaggregatedField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "UniqueValuesComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ValidationStrategy": { - "additionalProperties": false, - "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", - "properties": { - "Mode": { - "$ref": "#/definitions/ValidationStrategyMode" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "ValidationStrategyMode": { - "enum": [ - "STRICT", - "LENIENT" - ], - "type": "string" - }, - "ValueWhenUnsetOption": { - "enum": [ - "RECOMMENDED_VALUE", - "NULL" - ], - "type": "string" - }, - "VerticalTextAlignment": { - "enum": [ - "TOP", - "MIDDLE", - "BOTTOM", - "AUTO" - ], - "type": "string" - }, - "Visibility": { - "enum": [ - "HIDDEN", - "VISIBLE" - ], - "type": "string" - }, - "VisibleRangeOptions": { - "additionalProperties": false, - "properties": { - "PercentRange": { - "$ref": "#/definitions/PercentVisibleRange" - } - }, - "type": "object" - }, - "Visual": { - "additionalProperties": false, - "properties": { - "BarChartVisual": { - "$ref": "#/definitions/BarChartVisual" - }, - "BoxPlotVisual": { - "$ref": "#/definitions/BoxPlotVisual" - }, - "ComboChartVisual": { - "$ref": "#/definitions/ComboChartVisual" - }, - "CustomContentVisual": { - "$ref": "#/definitions/CustomContentVisual" - }, - "EmptyVisual": { - "$ref": "#/definitions/EmptyVisual" - }, - "FilledMapVisual": { - "$ref": "#/definitions/FilledMapVisual" - }, - "FunnelChartVisual": { - "$ref": "#/definitions/FunnelChartVisual" - }, - "GaugeChartVisual": { - "$ref": "#/definitions/GaugeChartVisual" - }, - "GeospatialMapVisual": { - "$ref": "#/definitions/GeospatialMapVisual" - }, - "HeatMapVisual": { - "$ref": "#/definitions/HeatMapVisual" - }, - "HistogramVisual": { - "$ref": "#/definitions/HistogramVisual" - }, - "InsightVisual": { - "$ref": "#/definitions/InsightVisual" - }, - "KPIVisual": { - "$ref": "#/definitions/KPIVisual" - }, - "LineChartVisual": { - "$ref": "#/definitions/LineChartVisual" - }, - "PieChartVisual": { - "$ref": "#/definitions/PieChartVisual" - }, - "PivotTableVisual": { - "$ref": "#/definitions/PivotTableVisual" - }, - "RadarChartVisual": { - "$ref": "#/definitions/RadarChartVisual" - }, - "SankeyDiagramVisual": { - "$ref": "#/definitions/SankeyDiagramVisual" - }, - "ScatterPlotVisual": { - "$ref": "#/definitions/ScatterPlotVisual" - }, - "TableVisual": { - "$ref": "#/definitions/TableVisual" - }, - "TreeMapVisual": { - "$ref": "#/definitions/TreeMapVisual" - }, - "WaterfallVisual": { - "$ref": "#/definitions/WaterfallVisual" - }, - "WordCloudVisual": { - "$ref": "#/definitions/WordCloudVisual" - } - }, - "type": "object" - }, - "VisualCustomAction": { - "additionalProperties": false, - "properties": { - "ActionOperations": { - "items": { - "$ref": "#/definitions/VisualCustomActionOperation" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - }, - "CustomActionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "Trigger": { - "$ref": "#/definitions/VisualCustomActionTrigger" - } - }, - "required": [ - "ActionOperations", - "CustomActionId", - "Name", - "Trigger" - ], - "type": "object" - }, - "VisualCustomActionOperation": { - "additionalProperties": false, - "properties": { - "FilterOperation": { - "$ref": "#/definitions/CustomActionFilterOperation" - }, - "NavigationOperation": { - "$ref": "#/definitions/CustomActionNavigationOperation" - }, - "SetParametersOperation": { - "$ref": "#/definitions/CustomActionSetParametersOperation" - }, - "URLOperation": { - "$ref": "#/definitions/CustomActionURLOperation" - } - }, - "type": "object" - }, - "VisualCustomActionTrigger": { - "enum": [ - "DATA_POINT_CLICK", - "DATA_POINT_MENU" - ], - "type": "string" - }, - "VisualPalette": { - "additionalProperties": false, - "properties": { - "ChartColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "ColorMap": { - "items": { - "$ref": "#/definitions/DataPathColor" - }, - "maxItems": 5000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "VisualSubtitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/LongFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "VisualTitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/ShortFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "WaterfallChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Breakdowns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Categories": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallChartColorConfiguration": { - "additionalProperties": false, - "properties": { - "GroupColorConfiguration": { - "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" - } - }, - "type": "object" - }, - "WaterfallChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorConfiguration": { - "$ref": "#/definitions/WaterfallChartColorConfiguration" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WaterfallChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/WaterfallChartSortConfiguration" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WaterfallChartOptions": { - "$ref": "#/definitions/WaterfallChartOptions" - } - }, - "type": "object" - }, - "WaterfallChartFieldWells": { - "additionalProperties": false, - "properties": { - "WaterfallChartAggregatedFieldWells": { - "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "WaterfallChartGroupColorConfiguration": { - "additionalProperties": false, - "properties": { - "NegativeBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TotalBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartOptions": { - "additionalProperties": false, - "properties": { - "TotalBarLabel": { - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "BreakdownItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WaterfallChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WhatIfPointScenario": { - "additionalProperties": false, - "properties": { - "Date": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Date", - "Value" - ], - "type": "object" - }, - "WhatIfRangeScenario": { - "additionalProperties": false, - "properties": { - "EndDate": { - "format": "date-time", - "type": "string" - }, - "StartDate": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "EndDate", - "StartDate", - "Value" - ], - "type": "object" - }, - "WidgetStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "WordCloudAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WordCloudFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/WordCloudSortConfiguration" - }, - "WordCloudOptions": { - "$ref": "#/definitions/WordCloudOptions" - } - }, - "type": "object" - }, - "WordCloudCloudLayout": { - "enum": [ - "FLUID", - "NORMAL" - ], - "type": "string" - }, - "WordCloudFieldWells": { - "additionalProperties": false, - "properties": { - "WordCloudAggregatedFieldWells": { - "$ref": "#/definitions/WordCloudAggregatedFieldWells" - } - }, - "type": "object" - }, - "WordCloudOptions": { - "additionalProperties": false, - "properties": { - "CloudLayout": { - "$ref": "#/definitions/WordCloudCloudLayout" - }, - "MaximumStringLength": { - "maximum": 100, - "minimum": 1, - "type": "number" - }, - "WordCasing": { - "$ref": "#/definitions/WordCloudWordCasing" - }, - "WordOrientation": { - "$ref": "#/definitions/WordCloudWordOrientation" - }, - "WordPadding": { - "$ref": "#/definitions/WordCloudWordPadding" - }, - "WordScaling": { - "$ref": "#/definitions/WordCloudWordScaling" - } - }, - "type": "object" - }, - "WordCloudSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WordCloudChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WordCloudWordCasing": { - "enum": [ - "LOWER_CASE", - "EXISTING_CASE" - ], - "type": "string" - }, - "WordCloudWordOrientation": { - "enum": [ - "HORIZONTAL", - "HORIZONTAL_AND_VERTICAL" - ], - "type": "string" - }, - "WordCloudWordPadding": { - "enum": [ - "NONE", - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "WordCloudWordScaling": { - "enum": [ - "EMPHASIZE", - "NORMAL" - ], - "type": "string" - } - }, - "description": "Definition of the AWS::QuickSight::Analysis Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:DescribeAnalysis", - "quicksight:DescribeAnalysisPermissions", - "quicksight:CreateAnalysis", - "quicksight:DescribeTemplate", - "quicksight:DescribeTheme", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeAnalysis", - "quicksight:DeleteAnalysis" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AwsAccountId": { - "$ref": "resource-schema.json#/properties/AwsAccountId" - } - }, - "required": [ - "AwsAccountId" - ] - }, - "permissions": [ - "quicksight:ListAnalyses" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeAnalysis", - "quicksight:DescribeAnalysisPermissions", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeAnalysis", - "quicksight:DescribeAnalysisPermissions", - "quicksight:UpdateAnalysis", - "quicksight:UpdateAnalysisPermissions", - "quicksight:DescribeTemplate", - "quicksight:DescribeTheme", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AnalysisId", - "/properties/AwsAccountId" - ], - "properties": { - "AnalysisId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the analysis.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "CreatedTime": { - "description": "

The time that the analysis was created.

", - "format": "date-time", - "type": "string" - }, - "DataSetArns": { - "description": "

The ARNs of the datasets of the analysis.

", - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Definition": { - "$ref": "#/definitions/AnalysisDefinition" - }, - "Errors": { - "description": "

Errors associated with the analysis.

", - "items": { - "$ref": "#/definitions/AnalysisError" - }, - "minItems": 1, - "type": "array" - }, - "LastUpdatedTime": { - "description": "

The time that the analysis was last updated.

", - "format": "date-time", - "type": "string" - }, - "Name": { - "description": "

The descriptive name of the analysis.

", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/Parameters" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "Sheets": { - "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", - "items": { - "$ref": "#/definitions/Sheet" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/AnalysisSourceEntity" - }, - "Status": { - "$ref": "#/definitions/ResourceStatus" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "ThemeArn": { - "description": "

The ARN of the theme of the analysis.

", - "type": "string" - }, - "ValidationStrategy": { - "$ref": "#/definitions/ValidationStrategy" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/DataSetArns", - "/properties/LastUpdatedTime" - ], - "required": [ - "AwsAccountId", - "AnalysisId", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "typeName": "AWS::QuickSight::Analysis", - "writeOnlyProperties": [ - "/properties/Definition", - "/properties/Parameters", - "/properties/SourceEntity", - "/properties/Status", - "/properties/ValidationStrategy" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AnalysisId", + "/properties/AwsAccountId" + ], + "definitions": { + "AggregationFunction": { + "additionalProperties": false, + "properties": { + "AttributeAggregationFunction": { + "$ref": "#/definitions/AttributeAggregationFunction" + }, + "CategoricalAggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "DateAggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "NumericalAggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + } + }, + "type": "object" + }, + "AggregationSortConfiguration": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SortDirection": { + "$ref": "#/definitions/SortDirection" + } + }, + "required": [ + "Column", + "SortDirection" + ], + "type": "object" + }, + "AllSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "AnalysisDefaults": { + "additionalProperties": false, + "properties": { + "DefaultNewSheetConfiguration": { + "$ref": "#/definitions/DefaultNewSheetConfiguration" + } + }, + "required": [ + "DefaultNewSheetConfiguration" + ], + "type": "object" + }, + "AnalysisDefinition": { + "additionalProperties": false, + "properties": { + "AnalysisDefaults": { + "$ref": "#/definitions/AnalysisDefaults" + }, + "CalculatedFields": { + "items": { + "$ref": "#/definitions/CalculatedField" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + }, + "ColumnConfigurations": { + "items": { + "$ref": "#/definitions/ColumnConfiguration" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifierDeclarations": { + "items": { + "$ref": "#/definitions/DataSetIdentifierDeclaration" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "FilterGroups": { + "items": { + "$ref": "#/definitions/FilterGroup" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "Options": { + "$ref": "#/definitions/AssetOptions" + }, + "ParameterDeclarations": { + "items": { + "$ref": "#/definitions/ParameterDeclaration" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "QueryExecutionOptions": { + "$ref": "#/definitions/QueryExecutionOptions" + }, + "Sheets": { + "items": { + "$ref": "#/definitions/SheetDefinition" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "DataSetIdentifierDeclarations" + ], + "type": "object" + }, + "AnalysisError": { + "additionalProperties": false, + "description": "

Analysis error.

", + "properties": { + "Message": { + "description": "

The message associated with the analysis error.

", + "pattern": "\\S", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/AnalysisErrorType" + }, + "ViolatedEntities": { + "description": "

Lists the violated entities that caused the analysis error

", + "items": { + "$ref": "#/definitions/Entity" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "AnalysisErrorType": { + "enum": [ + "ACCESS_DENIED", + "SOURCE_NOT_FOUND", + "DATA_SET_NOT_FOUND", + "INTERNAL_FAILURE", + "PARAMETER_VALUE_INCOMPATIBLE", + "PARAMETER_TYPE_INVALID", + "PARAMETER_NOT_FOUND", + "COLUMN_TYPE_MISMATCH", + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", + "COLUMN_REPLACEMENT_MISSING" + ], + "type": "string" + }, + "AnalysisSourceEntity": { + "additionalProperties": false, + "description": "

The source entity of an analysis.

", + "properties": { + "SourceTemplate": { + "$ref": "#/definitions/AnalysisSourceTemplate" + } + }, + "type": "object" + }, + "AnalysisSourceTemplate": { + "additionalProperties": false, + "description": "

The source template of an analysis.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", + "type": "string" + }, + "DataSetReferences": { + "description": "

The dataset references of the source template of an analysis.

", + "items": { + "$ref": "#/definitions/DataSetReference" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Arn", + "DataSetReferences" + ], + "type": "object" + }, + "AnchorDateConfiguration": { + "additionalProperties": false, + "properties": { + "AnchorOption": { + "$ref": "#/definitions/AnchorOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "type": "object" + }, + "AnchorOption": { + "enum": [ + "NOW" + ], + "type": "string" + }, + "ArcAxisConfiguration": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/ArcAxisDisplayRange" + }, + "ReserveRange": { + "default": 0, + "type": "number" + } + }, + "type": "object" + }, + "ArcAxisDisplayRange": { + "additionalProperties": false, + "properties": { + "Max": { + "default": null, + "type": "number" + }, + "Min": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "ArcConfiguration": { + "additionalProperties": false, + "properties": { + "ArcAngle": { + "default": null, + "type": "number" + }, + "ArcThickness": { + "$ref": "#/definitions/ArcThicknessOptions" + } + }, + "type": "object" + }, + "ArcOptions": { + "additionalProperties": false, + "properties": { + "ArcThickness": { + "$ref": "#/definitions/ArcThickness" + } + }, + "type": "object" + }, + "ArcThickness": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE", + "WHOLE" + ], + "type": "string" + }, + "ArcThicknessOptions": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "AssetOptions": { + "additionalProperties": false, + "properties": { + "Timezone": { + "type": "string" + }, + "WeekStart": { + "$ref": "#/definitions/DayOfTheWeek" + } + }, + "type": "object" + }, + "AttributeAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleAttributeAggregation": { + "$ref": "#/definitions/SimpleAttributeAggregationFunction" + }, + "ValueForMultipleValues": { + "type": "string" + } + }, + "type": "object" + }, + "AxisBinding": { + "enum": [ + "PRIMARY_YAXIS", + "SECONDARY_YAXIS" + ], + "type": "string" + }, + "AxisDataOptions": { + "additionalProperties": false, + "properties": { + "DateAxisOptions": { + "$ref": "#/definitions/DateAxisOptions" + }, + "NumericAxisOptions": { + "$ref": "#/definitions/NumericAxisOptions" + } + }, + "type": "object" + }, + "AxisDisplayDataDrivenRange": { + "additionalProperties": false, + "type": "object" + }, + "AxisDisplayMinMaxRange": { + "additionalProperties": false, + "properties": { + "Maximum": { + "default": null, + "type": "number" + }, + "Minimum": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AxisOffset": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "DataOptions": { + "$ref": "#/definitions/AxisDataOptions" + }, + "GridLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ScrollbarOptions": { + "$ref": "#/definitions/ScrollBarOptions" + }, + "TickLabelOptions": { + "$ref": "#/definitions/AxisTickLabelOptions" + } + }, + "type": "object" + }, + "AxisDisplayRange": { + "additionalProperties": false, + "properties": { + "DataDriven": { + "$ref": "#/definitions/AxisDisplayDataDrivenRange" + }, + "MinMax": { + "$ref": "#/definitions/AxisDisplayMinMaxRange" + } + }, + "type": "object" + }, + "AxisLabelOptions": { + "additionalProperties": false, + "properties": { + "ApplyTo": { + "$ref": "#/definitions/AxisLabelReferenceOptions" + }, + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "AxisLabelReferenceOptions": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "AxisLinearScale": { + "additionalProperties": false, + "properties": { + "StepCount": { + "default": null, + "type": "number" + }, + "StepSize": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisLogarithmicScale": { + "additionalProperties": false, + "properties": { + "Base": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisScale": { + "additionalProperties": false, + "properties": { + "Linear": { + "$ref": "#/definitions/AxisLinearScale" + }, + "Logarithmic": { + "$ref": "#/definitions/AxisLogarithmicScale" + } + }, + "type": "object" + }, + "AxisTickLabelOptions": { + "additionalProperties": false, + "properties": { + "LabelOptions": { + "$ref": "#/definitions/LabelOptions" + }, + "RotationAngle": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "BarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Orientation": { + "$ref": "#/definitions/BarChartOrientation" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/BarChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BarChartFieldWells": { + "additionalProperties": false, + "properties": { + "BarChartAggregatedFieldWells": { + "$ref": "#/definitions/BarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "BarChartOrientation": { + "enum": [ + "HORIZONTAL", + "VERTICAL" + ], + "type": "string" + }, + "BarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "BarsArrangement": { + "enum": [ + "CLUSTERED", + "STACKED", + "STACKED_PERCENT" + ], + "type": "string" + }, + "BaseMapStyleType": { + "enum": [ + "LIGHT_GRAY", + "DARK_GRAY", + "STREET", + "IMAGERY" + ], + "type": "string" + }, + "BinCountOptions": { + "additionalProperties": false, + "properties": { + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BinWidthOptions": { + "additionalProperties": false, + "properties": { + "BinCountLimit": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BodySectionConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/BodySectionContent" + }, + "PageBreakConfiguration": { + "$ref": "#/definitions/SectionPageBreakConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Content", + "SectionId" + ], + "type": "object" + }, + "BodySectionContent": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + } + }, + "type": "object" + }, + "BoxPlotAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BoxPlotChartConfiguration": { + "additionalProperties": false, + "properties": { + "BoxPlotOptions": { + "$ref": "#/definitions/BoxPlotOptions" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BoxPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SortConfiguration": { + "$ref": "#/definitions/BoxPlotSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BoxPlotFieldWells": { + "additionalProperties": false, + "properties": { + "BoxPlotAggregatedFieldWells": { + "$ref": "#/definitions/BoxPlotAggregatedFieldWells" + } + }, + "type": "object" + }, + "BoxPlotFillStyle": { + "enum": [ + "SOLID", + "TRANSPARENT" + ], + "type": "string" + }, + "BoxPlotOptions": { + "additionalProperties": false, + "properties": { + "AllDataPointsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "OutlierVisibility": { + "$ref": "#/definitions/Visibility" + }, + "StyleOptions": { + "$ref": "#/definitions/BoxPlotStyleOptions" + } + }, + "type": "object" + }, + "BoxPlotSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + } + }, + "type": "object" + }, + "BoxPlotStyleOptions": { + "additionalProperties": false, + "properties": { + "FillStyle": { + "$ref": "#/definitions/BoxPlotFillStyle" + } + }, + "type": "object" + }, + "BoxPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BoxPlotChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "CalculatedField": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 32000, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "Expression", + "Name" + ], + "type": "object" + }, + "CalculatedMeasureField": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression", + "FieldId" + ], + "type": "object" + }, + "CascadingControlConfiguration": { + "additionalProperties": false, + "properties": { + "SourceControls": { + "items": { + "$ref": "#/definitions/CascadingControlSource" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CascadingControlSource": { + "additionalProperties": false, + "properties": { + "ColumnToMatch": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceSheetControlId": { + "type": "string" + } + }, + "type": "object" + }, + "CategoricalAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT" + ], + "type": "string" + }, + "CategoricalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoricalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoryDrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "CategoryValues", + "Column" + ], + "type": "object" + }, + "CategoryFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "Column", + "Configuration", + "FilterId" + ], + "type": "object" + }, + "CategoryFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CustomFilterConfiguration": { + "$ref": "#/definitions/CustomFilterConfiguration" + }, + "CustomFilterListConfiguration": { + "$ref": "#/definitions/CustomFilterListConfiguration" + }, + "FilterListConfiguration": { + "$ref": "#/definitions/FilterListConfiguration" + } + }, + "type": "object" + }, + "CategoryFilterMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL", + "CONTAINS", + "DOES_NOT_CONTAIN", + "STARTS_WITH", + "ENDS_WITH" + ], + "type": "string" + }, + "CategoryFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "CategoryInnerFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + } + }, + "required": [ + "Column", + "Configuration" + ], + "type": "object" + }, + "ChartAxisLabelOptions": { + "additionalProperties": false, + "properties": { + "AxisLabelOptions": { + "items": { + "$ref": "#/definitions/AxisLabelOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SortIconVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ClusterMarker": { + "additionalProperties": false, + "properties": { + "SimpleClusterMarker": { + "$ref": "#/definitions/SimpleClusterMarker" + } + }, + "type": "object" + }, + "ClusterMarkerConfiguration": { + "additionalProperties": false, + "properties": { + "ClusterMarker": { + "$ref": "#/definitions/ClusterMarker" + } + }, + "type": "object" + }, + "ColorFillType": { + "enum": [ + "DISCRETE", + "GRADIENT" + ], + "type": "string" + }, + "ColorScale": { + "additionalProperties": false, + "properties": { + "ColorFillType": { + "$ref": "#/definitions/ColorFillType" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DataColor" + }, + "maxItems": 3, + "minItems": 2, + "type": "array" + }, + "NullValueColor": { + "$ref": "#/definitions/DataColor" + } + }, + "required": [ + "ColorFillType", + "Colors" + ], + "type": "object" + }, + "ColorsConfiguration": { + "additionalProperties": false, + "properties": { + "CustomColors": { + "items": { + "$ref": "#/definitions/CustomColor" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ColumnConfiguration": { + "additionalProperties": false, + "properties": { + "ColorsConfiguration": { + "$ref": "#/definitions/ColorsConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + }, + "Role": { + "$ref": "#/definitions/ColumnRole" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ColumnHierarchy": { + "additionalProperties": false, + "properties": { + "DateTimeHierarchy": { + "$ref": "#/definitions/DateTimeHierarchy" + }, + "ExplicitHierarchy": { + "$ref": "#/definitions/ExplicitHierarchy" + }, + "PredefinedHierarchy": { + "$ref": "#/definitions/PredefinedHierarchy" + } + }, + "type": "object" + }, + "ColumnIdentifier": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ColumnName", + "DataSetIdentifier" + ], + "type": "object" + }, + "ColumnRole": { + "enum": [ + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "ColumnSort": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortBy": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "Direction", + "SortBy" + ], + "type": "object" + }, + "ColumnTooltipItem": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ComboChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "BarValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "LineValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ComboChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "LineDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/ComboChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "ComboChartFieldWells": { + "additionalProperties": false, + "properties": { + "ComboChartAggregatedFieldWells": { + "$ref": "#/definitions/ComboChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "ComboChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ComboChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ComparisonConfiguration": { + "additionalProperties": false, + "properties": { + "ComparisonFormat": { + "$ref": "#/definitions/ComparisonFormatConfiguration" + }, + "ComparisonMethod": { + "$ref": "#/definitions/ComparisonMethod" + } + }, + "type": "object" + }, + "ComparisonFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "ComparisonMethod": { + "enum": [ + "DIFFERENCE", + "PERCENT_DIFFERENCE", + "PERCENT" + ], + "type": "string" + }, + "Computation": { + "additionalProperties": false, + "properties": { + "Forecast": { + "$ref": "#/definitions/ForecastComputation" + }, + "GrowthRate": { + "$ref": "#/definitions/GrowthRateComputation" + }, + "MaximumMinimum": { + "$ref": "#/definitions/MaximumMinimumComputation" + }, + "MetricComparison": { + "$ref": "#/definitions/MetricComparisonComputation" + }, + "PeriodOverPeriod": { + "$ref": "#/definitions/PeriodOverPeriodComputation" + }, + "PeriodToDate": { + "$ref": "#/definitions/PeriodToDateComputation" + }, + "TopBottomMovers": { + "$ref": "#/definitions/TopBottomMoversComputation" + }, + "TopBottomRanked": { + "$ref": "#/definitions/TopBottomRankedComputation" + }, + "TotalAggregation": { + "$ref": "#/definitions/TotalAggregationComputation" + }, + "UniqueValues": { + "$ref": "#/definitions/UniqueValuesComputation" + } + }, + "type": "object" + }, + "ConditionalFormattingColor": { + "additionalProperties": false, + "properties": { + "Gradient": { + "$ref": "#/definitions/ConditionalFormattingGradientColor" + }, + "Solid": { + "$ref": "#/definitions/ConditionalFormattingSolidColor" + } + }, + "type": "object" + }, + "ConditionalFormattingCustomIconCondition": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DisplayConfiguration": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconOptions": { + "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" + } + }, + "required": [ + "Expression", + "IconOptions" + ], + "type": "object" + }, + "ConditionalFormattingCustomIconOptions": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/Icon" + }, + "UnicodeIcon": { + "pattern": "^[^\\u0000-\\u00FF]$", + "type": "string" + } + }, + "type": "object" + }, + "ConditionalFormattingGradientColor": { + "additionalProperties": false, + "properties": { + "Color": { + "$ref": "#/definitions/GradientColor" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Color", + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIcon": { + "additionalProperties": false, + "properties": { + "CustomCondition": { + "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" + }, + "IconSet": { + "$ref": "#/definitions/ConditionalFormattingIconSet" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayConfiguration": { + "additionalProperties": false, + "properties": { + "IconDisplayOption": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayOption": { + "enum": [ + "ICON_ONLY" + ], + "type": "string" + }, + "ConditionalFormattingIconSet": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconSetType": { + "$ref": "#/definitions/ConditionalFormattingIconSetType" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIconSetType": { + "enum": [ + "PLUS_MINUS", + "CHECK_X", + "THREE_COLOR_ARROW", + "THREE_GRAY_ARROW", + "CARET_UP_MINUS_DOWN", + "THREE_SHAPE", + "THREE_CIRCLE", + "FLAGS", + "BARS", + "FOUR_COLOR_ARROW", + "FOUR_GRAY_ARROW" + ], + "type": "string" + }, + "ConditionalFormattingSolidColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ContributionAnalysisDefault": { + "additionalProperties": false, + "properties": { + "ContributorDimensions": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "MeasureFieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ContributorDimensions", + "MeasureFieldId" + ], + "type": "object" + }, + "CrossDatasetTypes": { + "enum": [ + "ALL_DATASETS", + "SINGLE_DATASET" + ], + "type": "string" + }, + "CurrencyDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Symbol": { + "pattern": "^[A-Z]{3}$", + "type": "string" + } + }, + "type": "object" + }, + "CustomActionFilterOperation": { + "additionalProperties": false, + "properties": { + "SelectedFieldsConfiguration": { + "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" + }, + "TargetVisualsConfiguration": { + "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" + } + }, + "required": [ + "SelectedFieldsConfiguration", + "TargetVisualsConfiguration" + ], + "type": "object" + }, + "CustomActionNavigationOperation": { + "additionalProperties": false, + "properties": { + "LocalNavigationConfiguration": { + "$ref": "#/definitions/LocalNavigationConfiguration" + } + }, + "type": "object" + }, + "CustomActionSetParametersOperation": { + "additionalProperties": false, + "properties": { + "ParameterValueConfigurations": { + "items": { + "$ref": "#/definitions/SetParameterValueConfiguration" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ParameterValueConfigurations" + ], + "type": "object" + }, + "CustomActionURLOperation": { + "additionalProperties": false, + "properties": { + "URLTarget": { + "$ref": "#/definitions/URLTargetConfiguration" + }, + "URLTemplate": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "URLTarget", + "URLTemplate" + ], + "type": "object" + }, + "CustomColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "SpecialValue": { + "$ref": "#/definitions/SpecialValue" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "CustomContentConfiguration": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/CustomContentType" + }, + "ContentUrl": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ImageScaling": { + "$ref": "#/definitions/CustomContentImageScalingConfiguration" + } + }, + "type": "object" + }, + "CustomContentImageScalingConfiguration": { + "enum": [ + "FIT_TO_HEIGHT", + "FIT_TO_WIDTH", + "DO_NOT_SCALE", + "SCALE_TO_VISUAL" + ], + "type": "string" + }, + "CustomContentType": { + "enum": [ + "IMAGE", + "OTHER_EMBEDDED_CONTENT" + ], + "type": "string" + }, + "CustomContentVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/CustomContentConfiguration" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "CustomFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValue": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomFilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomNarrativeOptions": { + "additionalProperties": false, + "properties": { + "Narrative": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Narrative" + ], + "type": "object" + }, + "CustomParameterValues": { + "additionalProperties": false, + "properties": { + "DateTimeValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "DecimalValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "IntegerValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "StringValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CustomValuesConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValues": { + "$ref": "#/definitions/CustomParameterValues" + }, + "IncludeNullValue": { + "type": "boolean" + } + }, + "required": [ + "CustomValues" + ], + "type": "object" + }, + "DataBarsOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "NegativeColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "DataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "DataFieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "DataLabelContent": { + "enum": [ + "VALUE", + "PERCENT", + "VALUE_AND_PERCENT" + ], + "type": "string" + }, + "DataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DataLabelTypes": { + "items": { + "$ref": "#/definitions/DataLabelType" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelContent": { + "$ref": "#/definitions/DataLabelContent" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Overlap": { + "$ref": "#/definitions/DataLabelOverlap" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataLabelOverlap": { + "enum": [ + "DISABLE_OVERLAP", + "ENABLE_OVERLAP" + ], + "type": "string" + }, + "DataLabelPosition": { + "enum": [ + "INSIDE", + "OUTSIDE", + "LEFT", + "TOP", + "BOTTOM", + "RIGHT" + ], + "type": "string" + }, + "DataLabelType": { + "additionalProperties": false, + "properties": { + "DataPathLabelType": { + "$ref": "#/definitions/DataPathLabelType" + }, + "FieldLabelType": { + "$ref": "#/definitions/FieldLabelType" + }, + "MaximumLabelType": { + "$ref": "#/definitions/MaximumLabelType" + }, + "MinimumLabelType": { + "$ref": "#/definitions/MinimumLabelType" + }, + "RangeEndsLabelType": { + "$ref": "#/definitions/RangeEndsLabelType" + } + }, + "type": "object" + }, + "DataPathColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Element": { + "$ref": "#/definitions/DataPathValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Color", + "Element" + ], + "type": "object" + }, + "DataPathLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataPathSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortPaths": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Direction", + "SortPaths" + ], + "type": "object" + }, + "DataPathType": { + "additionalProperties": false, + "properties": { + "PivotTableDataPathType": { + "$ref": "#/definitions/PivotTableDataPathType" + } + }, + "type": "object" + }, + "DataPathValue": { + "additionalProperties": false, + "properties": { + "DataPathType": { + "$ref": "#/definitions/DataPathType" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "DataSetIdentifierDeclaration": { + "additionalProperties": false, + "properties": { + "DataSetArn": { + "type": "string" + }, + "Identifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetArn", + "Identifier" + ], + "type": "object" + }, + "DataSetReference": { + "additionalProperties": false, + "description": "

Dataset reference.

", + "properties": { + "DataSetArn": { + "description": "

Dataset Amazon Resource Name (ARN).

", + "type": "string" + }, + "DataSetPlaceholder": { + "description": "

Dataset placeholder.

", + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "DataSetArn", + "DataSetPlaceholder" + ], + "type": "object" + }, + "DateAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT", + "MIN", + "MAX" + ], + "type": "string" + }, + "DateAxisOptions": { + "additionalProperties": false, + "properties": { + "MissingDateVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DateDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DateGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateTimeDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DateTimeFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "DateTimeHierarchy": { + "additionalProperties": false, + "properties": { + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "HierarchyId" + ], + "type": "object" + }, + "DateTimeParameter": { + "additionalProperties": false, + "description": "

A date-time parameter.

", + "properties": { + "Name": { + "description": "

A display name for the date-time parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the date-time parameter.

", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "DateTimeParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DateTimeDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "DateTimePickerControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DateTimeValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "format": "date-time", + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DayOfTheWeek": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + }, + "DecimalDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DecimalParameter": { + "additionalProperties": false, + "description": "

A decimal parameter.

", + "properties": { + "Name": { + "description": "

A display name for the decimal parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the decimal parameter.

", + "items": { + "default": 0, + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "DecimalParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DecimalDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "DecimalPlacesConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlaces": { + "maximum": 20, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "DecimalPlaces" + ], + "type": "object" + }, + "DecimalValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultGridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultInteractiveLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeForm": { + "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" + }, + "Grid": { + "$ref": "#/definitions/DefaultGridLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultNewSheetConfiguration": { + "additionalProperties": false, + "properties": { + "InteractiveLayoutConfiguration": { + "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" + }, + "PaginatedLayoutConfiguration": { + "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" + }, + "SheetContentType": { + "$ref": "#/definitions/SheetContentType" + } + }, + "type": "object" + }, + "DefaultPaginatedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "SectionBased": { + "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultSectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, + "DestinationParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValuesConfiguration": { + "$ref": "#/definitions/CustomValuesConfiguration" + }, + "SelectAllValueOptions": { + "$ref": "#/definitions/SelectAllValueOptions" + }, + "SourceColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceField": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SourceParameterName": { + "type": "string" + } + }, + "type": "object" + }, + "DimensionField": { + "additionalProperties": false, + "properties": { + "CategoricalDimensionField": { + "$ref": "#/definitions/CategoricalDimensionField" + }, + "DateDimensionField": { + "$ref": "#/definitions/DateDimensionField" + }, + "NumericalDimensionField": { + "$ref": "#/definitions/NumericalDimensionField" + } + }, + "type": "object" + }, + "DonutCenterOptions": { + "additionalProperties": false, + "properties": { + "LabelVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DonutOptions": { + "additionalProperties": false, + "properties": { + "ArcOptions": { + "$ref": "#/definitions/ArcOptions" + }, + "DonutCenterOptions": { + "$ref": "#/definitions/DonutCenterOptions" + } + }, + "type": "object" + }, + "DrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryDrillDownFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityDrillDownFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeDrillDownFilter" + } + }, + "type": "object" + }, + "DropDownControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DynamicDefaultValue": { + "additionalProperties": false, + "properties": { + "DefaultValueColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "GroupNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "UserNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "DefaultValueColumn" + ], + "type": "object" + }, + "EmptyVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "Entity": { + "additionalProperties": false, + "properties": { + "Path": { + "pattern": "\\S", + "type": "string" + } + }, + "type": "object" + }, + "ExcludePeriodConfiguration": { + "additionalProperties": false, + "properties": { + "Amount": { + "default": null, + "type": "number" + }, + "Granularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "Amount", + "Granularity" + ], + "type": "object" + }, + "ExplicitHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 2, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "FieldBasedTooltip": { + "additionalProperties": false, + "properties": { + "AggregationVisibility": { + "$ref": "#/definitions/Visibility" + }, + "TooltipFields": { + "items": { + "$ref": "#/definitions/TooltipItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "TooltipTitleType": { + "$ref": "#/definitions/TooltipTitleType" + } + }, + "type": "object" + }, + "FieldLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "FieldSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Direction", + "FieldId" + ], + "type": "object" + }, + "FieldSortOptions": { + "additionalProperties": false, + "properties": { + "ColumnSort": { + "$ref": "#/definitions/ColumnSort" + }, + "FieldSort": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "FieldTooltipItem": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/FilledMapConditionalFormattingOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "ConditionalFormattingOptions" + ], + "type": "object" + }, + "FilledMapConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Shape": { + "$ref": "#/definitions/FilledMapShapeConditionalFormatting" + } + }, + "required": [ + "Shape" + ], + "type": "object" + }, + "FilledMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/FilledMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/FilledMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "FilledMapFieldWells": { + "additionalProperties": false, + "properties": { + "FilledMapAggregatedFieldWells": { + "$ref": "#/definitions/FilledMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "FilledMapShapeConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Format": { + "$ref": "#/definitions/ShapeConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FilledMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/FilledMapConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryFilter" + }, + "NestedFilter": { + "$ref": "#/definitions/NestedFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityFilter" + }, + "NumericRangeFilter": { + "$ref": "#/definitions/NumericRangeFilter" + }, + "RelativeDatesFilter": { + "$ref": "#/definitions/RelativeDatesFilter" + }, + "TimeEqualityFilter": { + "$ref": "#/definitions/TimeEqualityFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeFilter" + }, + "TopBottomFilter": { + "$ref": "#/definitions/TopBottomFilter" + } + }, + "type": "object" + }, + "FilterControl": { + "additionalProperties": false, + "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, + "DateTimePicker": { + "$ref": "#/definitions/FilterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/FilterDropDownControl" + }, + "List": { + "$ref": "#/definitions/FilterListControl" + }, + "RelativeDateTime": { + "$ref": "#/definitions/FilterRelativeDateTimeControl" + }, + "Slider": { + "$ref": "#/definitions/FilterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/FilterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/FilterTextFieldControl" + } + }, + "type": "object" + }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, + "FilterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterGroup": { + "additionalProperties": false, + "properties": { + "CrossDataset": { + "$ref": "#/definitions/CrossDatasetTypes" + }, + "FilterGroupId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Filters": { + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "ScopeConfiguration": { + "$ref": "#/definitions/FilterScopeConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "CrossDataset", + "FilterGroupId", + "Filters", + "ScopeConfiguration" + ], + "type": "object" + }, + "FilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator" + ], + "type": "object" + }, + "FilterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterNullOption": { + "enum": [ + "ALL_VALUES", + "NULLS_ONLY", + "NON_NULLS_ONLY" + ], + "type": "string" + }, + "FilterOperationSelectedFieldsConfiguration": { + "additionalProperties": false, + "properties": { + "SelectedColumns": { + "description": "

The selected columns of a dataset.

", + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "$ref": "#/definitions/SelectedFieldOptions" + }, + "SelectedFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FilterOperationTargetVisualsConfiguration": { + "additionalProperties": false, + "properties": { + "SameSheetTargetVisualConfiguration": { + "$ref": "#/definitions/SameSheetTargetVisualConfiguration" + } + }, + "type": "object" + }, + "FilterRelativeDateTimeControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "AllSheets": { + "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" + }, + "SelectedSheets": { + "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" + } + }, + "type": "object" + }, + "FilterSelectableValues": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "FilterControlId", + "MaximumValue", + "MinimumValue", + "SourceFilterId", + "StepSize", + "Title" + ], + "type": "object" + }, + "FilterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterVisualScope": { + "enum": [ + "ALL_VISUALS", + "SELECTED_VISUALS" + ], + "type": "string" + }, + "FontConfiguration": { + "additionalProperties": false, + "properties": { + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontDecoration": { + "$ref": "#/definitions/FontDecoration" + }, + "FontSize": { + "$ref": "#/definitions/FontSize" + }, + "FontStyle": { + "$ref": "#/definitions/FontStyle" + }, + "FontWeight": { + "$ref": "#/definitions/FontWeight" + } + }, + "type": "object" + }, + "FontDecoration": { + "enum": [ + "UNDERLINE", + "NONE" + ], + "type": "string" + }, + "FontSize": { + "additionalProperties": false, + "properties": { + "Relative": { + "$ref": "#/definitions/RelativeFontSize" + } + }, + "type": "object" + }, + "FontStyle": { + "enum": [ + "NORMAL", + "ITALIC" + ], + "type": "string" + }, + "FontWeight": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/FontWeightName" + } + }, + "type": "object" + }, + "FontWeightName": { + "enum": [ + "NORMAL", + "BOLD" + ], + "type": "string" + }, + "ForecastComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "CustomSeasonalityValue": { + "default": null, + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "LowerBoundary": { + "default": null, + "type": "number" + }, + "Name": { + "type": "string" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "$ref": "#/definitions/ForecastComputationSeasonality" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "UpperBoundary": { + "default": null, + "type": "number" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ForecastComputationSeasonality": { + "enum": [ + "AUTOMATIC", + "CUSTOM" + ], + "type": "string" + }, + "ForecastConfiguration": { + "additionalProperties": false, + "properties": { + "ForecastProperties": { + "$ref": "#/definitions/TimeBasedForecastProperties" + }, + "Scenario": { + "$ref": "#/definitions/ForecastScenario" + } + }, + "type": "object" + }, + "ForecastScenario": { + "additionalProperties": false, + "properties": { + "WhatIfPointScenario": { + "$ref": "#/definitions/WhatIfPointScenario" + }, + "WhatIfRangeScenario": { + "$ref": "#/definitions/WhatIfRangeScenario" + } + }, + "type": "object" + }, + "FormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "NumberFormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "StringFormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "type": "object" + }, + "FreeFormLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "FreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FreeFormLayoutElement": { + "additionalProperties": false, + "properties": { + "BackgroundStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" + }, + "BorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "LoadingAnimation": { + "$ref": "#/definitions/LoadingAnimation" + }, + "RenderingRules": { + "items": { + "$ref": "#/definitions/SheetElementRenderingRule" + }, + "maxItems": 10000, + "minItems": 0, + "type": "array" + }, + "SelectedBorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "XAxisLocation": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "YAxisLocation": { + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", + "type": "string" + } + }, + "required": [ + "ElementId", + "ElementType", + "Height", + "Width", + "XAxisLocation", + "YAxisLocation" + ], + "type": "object" + }, + "FreeFormLayoutElementBackgroundStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutElementBorderStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "OptimizedViewPortWidth" + ], + "type": "object" + }, + "FreeFormSectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FunnelChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabelOptions": { + "$ref": "#/definitions/FunnelChartDataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/FunnelChartFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/FunnelChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "FunnelChartDataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureDataLabelStyle": { + "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FunnelChartFieldWells": { + "additionalProperties": false, + "properties": { + "FunnelChartAggregatedFieldWells": { + "$ref": "#/definitions/FunnelChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "FunnelChartMeasureDataLabelStyle": { + "enum": [ + "VALUE_ONLY", + "PERCENTAGE_BY_FIRST_STAGE", + "PERCENTAGE_BY_PREVIOUS_STAGE", + "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", + "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" + ], + "type": "string" + }, + "FunnelChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FunnelChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GaugeChartArcConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/GaugeChartConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/GaugeChartArcConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" + } + }, + "type": "object" + }, + "GaugeChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/GaugeChartFieldWells" + }, + "GaugeChartOptions": { + "$ref": "#/definitions/GaugeChartOptions" + }, + "TooltipOptions": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "GaugeChartFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartOptions": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/ArcConfiguration" + }, + "ArcAxis": { + "$ref": "#/definitions/ArcAxisConfiguration" + }, + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "GaugeChartPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GaugeChartConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/GaugeChartConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialCoordinateBounds": { + "additionalProperties": false, + "properties": { + "East": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + }, + "North": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "South": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "West": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + } + }, + "required": [ + "East", + "North", + "South", + "West" + ], + "type": "object" + }, + "GeospatialHeatmapColorScale": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/GeospatialHeatmapDataColor" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialHeatmapConfiguration": { + "additionalProperties": false, + "properties": { + "HeatmapColor": { + "$ref": "#/definitions/GeospatialHeatmapColorScale" + } + }, + "type": "object" + }, + "GeospatialHeatmapDataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "GeospatialMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/GeospatialMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "PointStyleOptions": { + "$ref": "#/definitions/GeospatialPointStyleOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "GeospatialMapFieldWells": { + "additionalProperties": false, + "properties": { + "GeospatialMapAggregatedFieldWells": { + "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "GeospatialMapStyleOptions": { + "additionalProperties": false, + "properties": { + "BaseMapStyle": { + "$ref": "#/definitions/BaseMapStyleType" + } + }, + "type": "object" + }, + "GeospatialMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GeospatialMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialPointStyleOptions": { + "additionalProperties": false, + "properties": { + "ClusterMarkerConfiguration": { + "$ref": "#/definitions/ClusterMarkerConfiguration" + }, + "HeatmapConfiguration": { + "$ref": "#/definitions/GeospatialHeatmapConfiguration" + }, + "SelectedPointStyle": { + "$ref": "#/definitions/GeospatialSelectedPointStyle" + } + }, + "type": "object" + }, + "GeospatialSelectedPointStyle": { + "enum": [ + "POINT", + "CLUSTER", + "HEATMAP" + ], + "type": "string" + }, + "GeospatialWindowOptions": { + "additionalProperties": false, + "properties": { + "Bounds": { + "$ref": "#/definitions/GeospatialCoordinateBounds" + }, + "MapZoomMode": { + "$ref": "#/definitions/MapZoomMode" + } + }, + "type": "object" + }, + "GlobalTableBorderOptions": { + "additionalProperties": false, + "properties": { + "SideSpecificBorder": { + "$ref": "#/definitions/TableSideBorderOptions" + }, + "UniformBorder": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "GradientColor": { + "additionalProperties": false, + "properties": { + "Stops": { + "items": { + "$ref": "#/definitions/GradientStop" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GradientStop": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + }, + "GradientOffset": { + "default": 0, + "type": "number" + } + }, + "required": [ + "GradientOffset" + ], + "type": "object" + }, + "GridLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "GridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/GridLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "GridLayoutElement": { + "additionalProperties": false, + "properties": { + "ColumnIndex": { + "maximum": 35, + "minimum": 0, + "type": "number" + }, + "ColumnSpan": { + "maximum": 36, + "minimum": 1, + "type": "number" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "RowIndex": { + "maximum": 9009, + "minimum": 0, + "type": "number" + }, + "RowSpan": { + "maximum": 21, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "ColumnSpan", + "ElementId", + "ElementType", + "RowSpan" + ], + "type": "object" + }, + "GridLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "ResizeOption": { + "$ref": "#/definitions/ResizeOption" + } + }, + "required": [ + "ResizeOption" + ], + "type": "object" + }, + "GrowthRateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodSize": { + "default": 0, + "maximum": 52, + "minimum": 2, + "type": "number" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "HeaderFooterSectionConfiguration": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Layout", + "SectionId" + ], + "type": "object" + }, + "HeatMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "ColumnLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HeatMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "RowLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/HeatMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "HeatMapFieldWells": { + "additionalProperties": false, + "properties": { + "HeatMapAggregatedFieldWells": { + "$ref": "#/definitions/HeatMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "HeatMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapColumnSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "HeatMapRowItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapRowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HeatMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HistogramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HistogramBinOptions": { + "additionalProperties": false, + "properties": { + "BinCount": { + "$ref": "#/definitions/BinCountOptions" + }, + "BinWidth": { + "$ref": "#/definitions/BinWidthOptions" + }, + "SelectedBinType": { + "$ref": "#/definitions/HistogramBinType" + }, + "StartValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "HistogramBinType": { + "enum": [ + "BIN_COUNT", + "BIN_WIDTH" + ], + "type": "string" + }, + "HistogramConfiguration": { + "additionalProperties": false, + "properties": { + "BinOptions": { + "$ref": "#/definitions/HistogramBinOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HistogramFieldWells" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + } + }, + "type": "object" + }, + "HistogramFieldWells": { + "additionalProperties": false, + "properties": { + "HistogramAggregatedFieldWells": { + "$ref": "#/definitions/HistogramAggregatedFieldWells" + } + }, + "type": "object" + }, + "HistogramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HistogramConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HorizontalTextAlignment": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT", + "AUTO" + ], + "type": "string" + }, + "Icon": { + "enum": [ + "CARET_UP", + "CARET_DOWN", + "PLUS", + "MINUS", + "ARROW_UP", + "ARROW_DOWN", + "ARROW_LEFT", + "ARROW_UP_LEFT", + "ARROW_DOWN_LEFT", + "ARROW_RIGHT", + "ARROW_UP_RIGHT", + "ARROW_DOWN_RIGHT", + "FACE_UP", + "FACE_DOWN", + "FACE_FLAT", + "ONE_BAR", + "TWO_BAR", + "THREE_BAR", + "CIRCLE", + "TRIANGLE", + "SQUARE", + "FLAG", + "THUMBS_UP", + "THUMBS_DOWN", + "CHECKMARK", + "X" + ], + "type": "string" + }, + "InnerFilter": { + "additionalProperties": false, + "properties": { + "CategoryInnerFilter": { + "$ref": "#/definitions/CategoryInnerFilter" + } + }, + "type": "object" + }, + "InsightConfiguration": { + "additionalProperties": false, + "properties": { + "Computations": { + "items": { + "$ref": "#/definitions/Computation" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "CustomNarrative": { + "$ref": "#/definitions/CustomNarrativeOptions" + } + }, + "type": "object" + }, + "InsightVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "InsightConfiguration": { + "$ref": "#/definitions/InsightConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "IntegerDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "IntegerParameter": { + "additionalProperties": false, + "description": "

An integer parameter.

", + "properties": { + "Name": { + "description": "

The name of the integer parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the integer parameter.

", + "items": { + "default": 0, + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "IntegerParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/IntegerDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "IntegerValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "ItemsLimitConfiguration": { + "additionalProperties": false, + "properties": { + "ItemsLimit": { + "default": null, + "type": "number" + }, + "OtherCategories": { + "$ref": "#/definitions/OtherCategories" + } + }, + "type": "object" + }, + "KPIActualValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIComparisonValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/KPIConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "ActualValue": { + "$ref": "#/definitions/KPIActualValueConditionalFormatting" + }, + "ComparisonValue": { + "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" + }, + "ProgressBar": { + "$ref": "#/definitions/KPIProgressBarConditionalFormatting" + } + }, + "type": "object" + }, + "KPIConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/KPIFieldWells" + }, + "KPIOptions": { + "$ref": "#/definitions/KPIOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/KPISortConfiguration" + } + }, + "type": "object" + }, + "KPIFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrendGroups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIOptions": { + "additionalProperties": false, + "properties": { + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "ProgressBar": { + "$ref": "#/definitions/ProgressBarOptions" + }, + "SecondaryValue": { + "$ref": "#/definitions/SecondaryValueOptions" + }, + "SecondaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Sparkline": { + "$ref": "#/definitions/KPISparklineOptions" + }, + "TrendArrows": { + "$ref": "#/definitions/TrendArrowOptions" + }, + "VisualLayoutOptions": { + "$ref": "#/definitions/KPIVisualLayoutOptions" + } + }, + "type": "object" + }, + "KPIPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIProgressBarConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPISortConfiguration": { + "additionalProperties": false, + "properties": { + "TrendGroupSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPISparklineOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Type": { + "$ref": "#/definitions/KPISparklineType" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPISparklineType": { + "enum": [ + "LINE", + "AREA" + ], + "type": "string" + }, + "KPIVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/KPIConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/KPIConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "KPIVisualLayoutOptions": { + "additionalProperties": false, + "properties": { + "StandardLayout": { + "$ref": "#/definitions/KPIVisualStandardLayout" + } + }, + "type": "object" + }, + "KPIVisualStandardLayout": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/KPIVisualStandardLayoutType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPIVisualStandardLayoutType": { + "enum": [ + "CLASSIC", + "VERTICAL" + ], + "type": "string" + }, + "LabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "Layout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/LayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "LayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormLayoutConfiguration" + }, + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + }, + "SectionBasedLayout": { + "$ref": "#/definitions/SectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "LayoutElementType": { + "enum": [ + "VISUAL", + "FILTER_CONTROL", + "PARAMETER_CONTROL", + "TEXT_BOX" + ], + "type": "string" + }, + "LegendOptions": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Position": { + "$ref": "#/definitions/LegendPosition" + }, + "Title": { + "$ref": "#/definitions/LabelOptions" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LegendPosition": { + "enum": [ + "AUTO", + "RIGHT", + "BOTTOM", + "TOP" + ], + "type": "string" + }, + "LineChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartConfiguration": { + "additionalProperties": false, + "properties": { + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DefaultSeriesSettings": { + "$ref": "#/definitions/LineChartDefaultSeriesSettings" + }, + "FieldWells": { + "$ref": "#/definitions/LineChartFieldWells" + }, + "ForecastConfigurations": { + "items": { + "$ref": "#/definitions/ForecastConfiguration" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Series": { + "items": { + "$ref": "#/definitions/SeriesItem" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/LineChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "Type": { + "$ref": "#/definitions/LineChartType" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "LineChartDefaultSeriesSettings": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartFieldWells": { + "additionalProperties": false, + "properties": { + "LineChartAggregatedFieldWells": { + "$ref": "#/definitions/LineChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "LineChartLineStyle": { + "enum": [ + "SOLID", + "DOTTED", + "DASHED" + ], + "type": "string" + }, + "LineChartLineStyleSettings": { + "additionalProperties": false, + "properties": { + "LineInterpolation": { + "$ref": "#/definitions/LineInterpolation" + }, + "LineStyle": { + "$ref": "#/definitions/LineChartLineStyle" + }, + "LineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LineWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LineChartMarkerShape": { + "enum": [ + "CIRCLE", + "TRIANGLE", + "SQUARE", + "DIAMOND", + "ROUNDED_SQUARE" + ], + "type": "string" + }, + "LineChartMarkerStyleSettings": { + "additionalProperties": false, + "properties": { + "MarkerColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "MarkerShape": { + "$ref": "#/definitions/LineChartMarkerShape" + }, + "MarkerSize": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MarkerVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LineChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartType": { + "enum": [ + "LINE", + "AREA", + "STACKED_AREA" + ], + "type": "string" + }, + "LineChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/LineChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "LineInterpolation": { + "enum": [ + "LINEAR", + "SMOOTH", + "STEPPED" + ], + "type": "string" + }, + "LineSeriesAxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "MissingDataConfigurations": { + "items": { + "$ref": "#/definitions/MissingDataConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ListControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SearchOptions": { + "$ref": "#/definitions/ListControlSearchOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "ListControlSearchOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ListControlSelectAllOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LoadingAnimation": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LocalNavigationConfiguration": { + "additionalProperties": false, + "properties": { + "TargetSheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "TargetSheetId" + ], + "type": "object" + }, + "LongFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "MapZoomMode": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "MappedDataSetParameter": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DataSetParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "DataSetParameterName" + ], + "type": "object" + }, + "MaximumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MaximumMinimumComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/MaximumMinimumComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "MaximumMinimumComputationType": { + "enum": [ + "MAXIMUM", + "MINIMUM" + ], + "type": "string" + }, + "MeasureField": { + "additionalProperties": false, + "properties": { + "CalculatedMeasureField": { + "$ref": "#/definitions/CalculatedMeasureField" + }, + "CategoricalMeasureField": { + "$ref": "#/definitions/CategoricalMeasureField" + }, + "DateMeasureField": { + "$ref": "#/definitions/DateMeasureField" + }, + "NumericalMeasureField": { + "$ref": "#/definitions/NumericalMeasureField" + } + }, + "type": "object" + }, + "MetricComparisonComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "FromValue": { + "$ref": "#/definitions/MeasureField" + }, + "Name": { + "type": "string" + }, + "TargetValue": { + "$ref": "#/definitions/MeasureField" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "MinimumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MissingDataConfiguration": { + "additionalProperties": false, + "properties": { + "TreatmentOption": { + "$ref": "#/definitions/MissingDataTreatmentOption" + } + }, + "type": "object" + }, + "MissingDataTreatmentOption": { + "enum": [ + "INTERPOLATE", + "SHOW_AS_ZERO", + "SHOW_AS_BLANK" + ], + "type": "string" + }, + "NegativeValueConfiguration": { + "additionalProperties": false, + "properties": { + "DisplayMode": { + "$ref": "#/definitions/NegativeValueDisplayMode" + } + }, + "required": [ + "DisplayMode" + ], + "type": "object" + }, + "NegativeValueDisplayMode": { + "enum": [ + "POSITIVE", + "NEGATIVE" + ], + "type": "string" + }, + "NestedFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeInnerSet": { + "default": false, + "type": "boolean" + }, + "InnerFilter": { + "$ref": "#/definitions/InnerFilter" + } + }, + "required": [ + "Column", + "FilterId", + "IncludeInnerSet", + "InnerFilter" + ], + "type": "object" + }, + "NullValueFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullString": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "NullString" + ], + "type": "object" + }, + "NumberDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "NumberFormatConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "NumberScale": { + "enum": [ + "NONE", + "AUTO", + "THOUSANDS", + "MILLIONS", + "BILLIONS", + "TRILLIONS" + ], + "type": "string" + }, + "NumericAxisOptions": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/AxisDisplayRange" + }, + "Scale": { + "$ref": "#/definitions/AxisScale" + } + }, + "type": "object" + }, + "NumericEqualityDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Column", + "Value" + ], + "type": "object" + }, + "NumericEqualityFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/NumericEqualityMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + }, + "Value": { + "default": null, + "type": "number" + } + }, + "required": [ + "Column", + "FilterId", + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "NumericEqualityMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL" + ], + "type": "string" + }, + "NumericFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "NumericFormatConfiguration": { + "additionalProperties": false, + "properties": { + "CurrencyDisplayFormatConfiguration": { + "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" + }, + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "NumericRangeFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "RangeMinimum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "NumericRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StaticValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "NumericSeparatorConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalSeparator": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "ThousandsSeparator": { + "$ref": "#/definitions/ThousandSeparatorOptions" + } + }, + "type": "object" + }, + "NumericSeparatorSymbol": { + "enum": [ + "COMMA", + "DOT", + "SPACE" + ], + "type": "string" + }, + "NumericalAggregationFunction": { + "additionalProperties": false, + "properties": { + "PercentileAggregation": { + "$ref": "#/definitions/PercentileAggregation" + }, + "SimpleNumericalAggregation": { + "$ref": "#/definitions/SimpleNumericalAggregationFunction" + } + }, + "type": "object" + }, + "NumericalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "NumericalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "OtherCategories": { + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "type": "string" + }, + "PaginationConfiguration": { + "additionalProperties": false, + "properties": { + "PageNumber": { + "minimum": 0, + "type": "number" + }, + "PageSize": { + "default": null, + "type": "number" + } + }, + "required": [ + "PageNumber", + "PageSize" + ], + "type": "object" + }, + "PanelBorderStyle": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "PanelConfiguration": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BackgroundVisibility": { + "$ref": "#/definitions/Visibility" + }, + "BorderColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BorderStyle": { + "$ref": "#/definitions/PanelBorderStyle" + }, + "BorderThickness": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "BorderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "GutterSpacing": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "GutterVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Title": { + "$ref": "#/definitions/PanelTitleOptions" + } + }, + "type": "object" + }, + "PanelTitleOptions": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PaperOrientation": { + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "PaperSize": { + "enum": [ + "US_LETTER", + "US_LEGAL", + "US_TABLOID_LEDGER", + "A0", + "A1", + "A2", + "A3", + "A4", + "A5", + "JIS_B4", + "JIS_B5" + ], + "type": "string" + }, + "ParameterControl": { + "additionalProperties": false, + "properties": { + "DateTimePicker": { + "$ref": "#/definitions/ParameterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/ParameterDropDownControl" + }, + "List": { + "$ref": "#/definitions/ParameterListControl" + }, + "Slider": { + "$ref": "#/definitions/ParameterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/ParameterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/ParameterTextFieldControl" + } + }, + "type": "object" + }, + "ParameterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DateTimeParameterDeclaration": { + "$ref": "#/definitions/DateTimeParameterDeclaration" + }, + "DecimalParameterDeclaration": { + "$ref": "#/definitions/DecimalParameterDeclaration" + }, + "IntegerParameterDeclaration": { + "$ref": "#/definitions/IntegerParameterDeclaration" + }, + "StringParameterDeclaration": { + "$ref": "#/definitions/StringParameterDeclaration" + } + }, + "type": "object" + }, + "ParameterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterSelectableValues": { + "additionalProperties": false, + "properties": { + "LinkToDataSetColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ParameterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "ParameterControlId", + "SourceParameterName", + "StepSize", + "Title" + ], + "type": "object" + }, + "ParameterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterValueType": { + "enum": [ + "MULTI_VALUED", + "SINGLE_VALUED" + ], + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "description": "

A list of Amazon QuickSight parameters and the list's override values.

", + "properties": { + "DateTimeParameters": { + "description": "

The parameters that have a data type of date-time.

", + "items": { + "$ref": "#/definitions/DateTimeParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "DecimalParameters": { + "description": "

The parameters that have a data type of decimal.

", + "items": { + "$ref": "#/definitions/DecimalParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "IntegerParameters": { + "description": "

The parameters that have a data type of integer.

", + "items": { + "$ref": "#/definitions/IntegerParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "StringParameters": { + "description": "

The parameters that have a data type of string.

", + "items": { + "$ref": "#/definitions/StringParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PercentVisibleRange": { + "additionalProperties": false, + "properties": { + "From": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "To": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PercentageDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PercentileAggregation": { + "additionalProperties": false, + "properties": { + "PercentileValue": { + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PeriodOverPeriodComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PeriodToDateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodTimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PieChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DonutOptions": { + "$ref": "#/definitions/DonutOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PieChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PieChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "PieChartFieldWells": { + "additionalProperties": false, + "properties": { + "PieChartAggregatedFieldWells": { + "$ref": "#/definitions/PieChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "PieChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PieChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotFieldSortOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SortBy": { + "$ref": "#/definitions/PivotTableSortBy" + } + }, + "required": [ + "FieldId", + "SortBy" + ], + "type": "object" + }, + "PivotTableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Scope": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "Scopes": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/PivotTableCellConditionalFormatting" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScope": { + "additionalProperties": false, + "properties": { + "Role": { + "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScopeRole": { + "enum": [ + "FIELD", + "FIELD_TOTAL", + "GRAND_TOTAL" + ], + "type": "string" + }, + "PivotTableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/PivotTableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PivotTableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/PivotTablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PivotTableSortConfiguration" + }, + "TableOptions": { + "$ref": "#/definitions/PivotTableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/PivotTableTotalOptions" + } + }, + "type": "object" + }, + "PivotTableDataPathOption": { + "additionalProperties": false, + "properties": { + "DataPathList": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "DataPathList" + ], + "type": "object" + }, + "PivotTableDataPathType": { + "enum": [ + "HIERARCHY_ROWS_LAYOUT_COLUMN", + "MULTIPLE_ROW_METRICS_COLUMN", + "EMPTY_COLUMN_HEADER", + "COUNT_METRIC_COLUMN" + ], + "type": "string" + }, + "PivotTableFieldCollapseState": { + "enum": [ + "COLLAPSED", + "EXPANDED" + ], + "type": "string" + }, + "PivotTableFieldCollapseStateOption": { + "additionalProperties": false, + "properties": { + "State": { + "$ref": "#/definitions/PivotTableFieldCollapseState" + }, + "Target": { + "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" + } + }, + "required": [ + "Target" + ], + "type": "object" + }, + "PivotTableFieldCollapseStateTarget": { + "additionalProperties": false, + "properties": { + "FieldDataPathValues": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "FieldId": { + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableFieldOptions": { + "additionalProperties": false, + "properties": { + "CollapseStateOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldCollapseStateOption" + }, + "type": "array" + }, + "DataPathOptions": { + "items": { + "$ref": "#/definitions/PivotTableDataPathOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableFieldSubtotalOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldWells": { + "additionalProperties": false, + "properties": { + "PivotTableAggregatedFieldWells": { + "$ref": "#/definitions/PivotTableAggregatedFieldWells" + } + }, + "type": "object" + }, + "PivotTableMetricPlacement": { + "enum": [ + "ROW", + "COLUMN" + ], + "type": "string" + }, + "PivotTableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "CollapsedRowDimensionsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ColumnHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "ColumnNamesVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DefaultCellWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MetricPlacement": { + "$ref": "#/definitions/PivotTableMetricPlacement" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + }, + "RowFieldNamesStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowsLabelOptions": { + "$ref": "#/definitions/PivotTableRowsLabelOptions" + }, + "RowsLayout": { + "$ref": "#/definitions/PivotTableRowsLayout" + }, + "SingleMetricVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ToggleButtonsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLayout": { + "enum": [ + "TABULAR", + "HIERARCHY" + ], + "type": "string" + }, + "PivotTableSortBy": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnSort" + }, + "DataPath": { + "$ref": "#/definitions/DataPathSort" + }, + "Field": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "PivotTableSortConfiguration": { + "additionalProperties": false, + "properties": { + "FieldSortOptions": { + "items": { + "$ref": "#/definitions/PivotFieldSortOptions" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableSubtotalLevel": { + "enum": [ + "ALL", + "CUSTOM", + "LAST" + ], + "type": "string" + }, + "PivotTableTotalOptions": { + "additionalProperties": false, + "properties": { + "ColumnSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "ColumnTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + }, + "RowSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "RowTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + } + }, + "type": "object" + }, + "PivotTableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PivotTableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/PivotTableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotTotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "PredefinedHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "PrimaryValueDisplayType": { + "enum": [ + "HIDDEN", + "COMPARISON", + "ACTUAL" + ], + "type": "string" + }, + "ProgressBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "QueryExecutionMode": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "QueryExecutionOptions": { + "additionalProperties": false, + "properties": { + "QueryExecutionMode": { + "$ref": "#/definitions/QueryExecutionMode" + } + }, + "type": "object" + }, + "RadarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Color": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartAreaStyleSettings": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "RadarChartAxesRangeScale": { + "enum": [ + "AUTO", + "INDEPENDENT", + "SHARED" + ], + "type": "string" + }, + "RadarChartConfiguration": { + "additionalProperties": false, + "properties": { + "AlternateBandColorsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AlternateBandEvenColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AlternateBandOddColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AxesRangeScale": { + "$ref": "#/definitions/RadarChartAxesRangeScale" + }, + "BaseSeriesSettings": { + "$ref": "#/definitions/RadarChartSeriesSettings" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/RadarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Shape": { + "$ref": "#/definitions/RadarChartShape" + }, + "SortConfiguration": { + "$ref": "#/definitions/RadarChartSortConfiguration" + }, + "StartAngle": { + "maximum": 360, + "minimum": -360, + "type": "number" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "RadarChartFieldWells": { + "additionalProperties": false, + "properties": { + "RadarChartAggregatedFieldWells": { + "$ref": "#/definitions/RadarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "RadarChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "AreaStyleSettings": { + "$ref": "#/definitions/RadarChartAreaStyleSettings" + } + }, + "type": "object" + }, + "RadarChartShape": { + "enum": [ + "CIRCLE", + "POLYGON" + ], + "type": "string" + }, + "RadarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/RadarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "RangeEndsLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ReferenceLine": { + "additionalProperties": false, + "properties": { + "DataConfiguration": { + "$ref": "#/definitions/ReferenceLineDataConfiguration" + }, + "LabelConfiguration": { + "$ref": "#/definitions/ReferenceLineLabelConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "StyleConfiguration": { + "$ref": "#/definitions/ReferenceLineStyleConfiguration" + } + }, + "required": [ + "DataConfiguration" + ], + "type": "object" + }, + "ReferenceLineCustomLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "CustomLabel" + ], + "type": "object" + }, + "ReferenceLineDataConfiguration": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "DynamicConfiguration": { + "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" + }, + "SeriesType": { + "$ref": "#/definitions/ReferenceLineSeriesType" + }, + "StaticConfiguration": { + "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" + } + }, + "type": "object" + }, + "ReferenceLineDynamicDataConfiguration": { + "additionalProperties": false, + "properties": { + "Calculation": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "MeasureAggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + } + }, + "required": [ + "Calculation", + "Column" + ], + "type": "object" + }, + "ReferenceLineLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" + }, + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalPosition": { + "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" + }, + "ValueLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" + }, + "VerticalPosition": { + "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" + } + }, + "type": "object" + }, + "ReferenceLineLabelHorizontalPosition": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ], + "type": "string" + }, + "ReferenceLineLabelVerticalPosition": { + "enum": [ + "ABOVE", + "BELOW" + ], + "type": "string" + }, + "ReferenceLinePatternType": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "ReferenceLineSeriesType": { + "enum": [ + "BAR", + "LINE" + ], + "type": "string" + }, + "ReferenceLineStaticDataConfiguration": { + "additionalProperties": false, + "properties": { + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "ReferenceLineStyleConfiguration": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Pattern": { + "$ref": "#/definitions/ReferenceLinePatternType" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + }, + "RelativePosition": { + "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelRelativePosition": { + "enum": [ + "BEFORE_CUSTOM_LABEL", + "AFTER_CUSTOM_LABEL" + ], + "type": "string" + }, + "RelativeDateTimeControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "RelativeDateType": { + "enum": [ + "PREVIOUS", + "THIS", + "LAST", + "NOW", + "NEXT" + ], + "type": "string" + }, + "RelativeDatesFilter": { + "additionalProperties": false, + "properties": { + "AnchorDateConfiguration": { + "$ref": "#/definitions/AnchorDateConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MinimumGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RelativeDateType": { + "$ref": "#/definitions/RelativeDateType" + }, + "RelativeDateValue": { + "default": null, + "type": "number" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AnchorDateConfiguration", + "Column", + "FilterId", + "NullOption", + "RelativeDateType", + "TimeGranularity" + ], + "type": "object" + }, + "RelativeFontSize": { + "enum": [ + "EXTRA_SMALL", + "SMALL", + "MEDIUM", + "LARGE", + "EXTRA_LARGE" + ], + "type": "string" + }, + "ResizeOption": { + "enum": [ + "FIXED", + "RESPONSIVE" + ], + "type": "string" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "ResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETED" + ], + "type": "string" + }, + "RollingDateConfiguration": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "RowAlternateColorOptions": { + "additionalProperties": false, + "properties": { + "RowAlternateColors": { + "items": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "UsePrimaryBackgroundColor": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "type": "object" + }, + "SameSheetTargetVisualConfiguration": { + "additionalProperties": false, + "properties": { + "TargetVisualOptions": { + "$ref": "#/definitions/TargetVisualOptions" + }, + "TargetVisuals": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Destination": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Source": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Weight": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/SankeyDiagramFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/SankeyDiagramSortConfiguration" + } + }, + "type": "object" + }, + "SankeyDiagramFieldWells": { + "additionalProperties": false, + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" + } + }, + "type": "object" + }, + "SankeyDiagramSortConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SourceItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "WeightSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/SankeyDiagramChartConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScatterPlotCategoricallyAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ScatterPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "YAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "ScatterPlotFieldWells": { + "additionalProperties": false, + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" + }, + "ScatterPlotUnaggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "ScatterPlotUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ScatterPlotConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScrollBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "VisibleRange": { + "$ref": "#/definitions/VisibleRangeOptions" + } + }, + "type": "object" + }, + "SecondaryValueOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SectionAfterPageBreak": { + "additionalProperties": false, + "properties": { + "Status": { + "$ref": "#/definitions/SectionPageBreakStatus" + } + }, + "type": "object" + }, + "SectionBasedLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperCanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" + } + }, + "type": "object" + }, + "SectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "BodySections": { + "items": { + "$ref": "#/definitions/BodySectionConfiguration" + }, + "maxItems": 28, + "minItems": 0, + "type": "array" + }, + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + }, + "FooterSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "HeaderSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "BodySections", + "CanvasSizeOptions", + "FooterSections", + "HeaderSections" + ], + "type": "object" + }, + "SectionBasedLayoutPaperCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperMargin": { + "$ref": "#/definitions/Spacing" + }, + "PaperOrientation": { + "$ref": "#/definitions/PaperOrientation" + }, + "PaperSize": { + "$ref": "#/definitions/PaperSize" + } + }, + "type": "object" + }, + "SectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" + } + }, + "required": [ + "FreeFormLayout" + ], + "type": "object" + }, + "SectionPageBreakConfiguration": { + "additionalProperties": false, + "properties": { + "After": { + "$ref": "#/definitions/SectionAfterPageBreak" + } + }, + "type": "object" + }, + "SectionPageBreakStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "SectionStyle": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Padding": { + "$ref": "#/definitions/Spacing" + } + }, + "type": "object" + }, + "SelectAllValueOptions": { + "enum": [ + "ALL_VALUES" + ], + "type": "string" + }, + "SelectedFieldOptions": { + "enum": [ + "ALL_FIELDS" + ], + "type": "string" + }, + "SelectedSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "SheetVisualScopingConfigurations": { + "items": { + "$ref": "#/definitions/SheetVisualScopingConfiguration" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SelectedTooltipType": { + "enum": [ + "BASIC", + "DETAILED" + ], + "type": "string" + }, + "SeriesItem": { + "additionalProperties": false, + "properties": { + "DataFieldSeriesItem": { + "$ref": "#/definitions/DataFieldSeriesItem" + }, + "FieldSeriesItem": { + "$ref": "#/definitions/FieldSeriesItem" + } + }, + "type": "object" + }, + "SetParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DestinationParameterValueConfiguration" + } + }, + "required": [ + "DestinationParameterName", + "Value" + ], + "type": "object" + }, + "ShapeConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "required": [ + "BackgroundColor" + ], + "type": "object" + }, + "Sheet": { + "additionalProperties": false, + "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", + "properties": { + "Name": { + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "SheetId": { + "description": "

The unique identifier associated with a sheet.

", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "type": "object" + }, + "SheetContentType": { + "enum": [ + "PAGINATED", + "INTERACTIVE" + ], + "type": "string" + }, + "SheetControlDateTimePickerType": { + "enum": [ + "SINGLE_VALUED", + "DATE_RANGE" + ], + "type": "string" + }, + "SheetControlInfoIconLabelOptions": { + "additionalProperties": false, + "properties": { + "InfoIconText": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetControlLayout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/SheetControlLayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "SheetControlLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + } + }, + "type": "object" + }, + "SheetControlListType": { + "enum": [ + "MULTI_SELECT", + "SINGLE_SELECT" + ], + "type": "string" + }, + "SheetControlSliderType": { + "enum": [ + "SINGLE_POINT", + "RANGE" + ], + "type": "string" + }, + "SheetDefinition": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/SheetContentType" + }, + "Description": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "FilterControls": { + "items": { + "$ref": "#/definitions/FilterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Layouts": { + "items": { + "$ref": "#/definitions/Layout" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ParameterControls": { + "items": { + "$ref": "#/definitions/ParameterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SheetControlLayouts": { + "items": { + "$ref": "#/definitions/SheetControlLayout" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "TextBoxes": { + "items": { + "$ref": "#/definitions/SheetTextBox" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Title": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visuals": { + "items": { + "$ref": "#/definitions/Visual" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "SheetId" + ], + "type": "object" + }, + "SheetElementConfigurationOverrides": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetElementRenderingRule": { + "additionalProperties": false, + "properties": { + "ConfigurationOverrides": { + "$ref": "#/definitions/SheetElementConfigurationOverrides" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConfigurationOverrides", + "Expression" + ], + "type": "object" + }, + "SheetTextBox": { + "additionalProperties": false, + "properties": { + "Content": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + }, + "SheetTextBoxId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "SheetTextBoxId" + ], + "type": "object" + }, + "SheetVisualScopingConfiguration": { + "additionalProperties": false, + "properties": { + "Scope": { + "$ref": "#/definitions/FilterVisualScope" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "VisualIds": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Scope", + "SheetId" + ], + "type": "object" + }, + "ShortFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SimpleAttributeAggregationFunction": { + "enum": [ + "UNIQUE_VALUE" + ], + "type": "string" + }, + "SimpleClusterMarker": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "SimpleNumericalAggregationFunction": { + "enum": [ + "SUM", + "AVERAGE", + "MIN", + "MAX", + "COUNT", + "DISTINCT_COUNT", + "VAR", + "VARP", + "STDEV", + "STDEVP", + "MEDIAN" + ], + "type": "string" + }, + "SimpleTotalAggregationFunction": { + "enum": [ + "DEFAULT", + "SUM", + "AVERAGE", + "MIN", + "MAX", + "NONE" + ], + "type": "string" + }, + "SingleAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxisOptions": { + "$ref": "#/definitions/YAxisOptions" + } + }, + "type": "object" + }, + "SingleYAxisOption": { + "enum": [ + "PRIMARY_Y_AXIS" + ], + "type": "string" + }, + "SliderControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "SmallMultiplesAxisPlacement": { + "enum": [ + "OUTSIDE", + "INSIDE" + ], + "type": "string" + }, + "SmallMultiplesAxisProperties": { + "additionalProperties": false, + "properties": { + "Placement": { + "$ref": "#/definitions/SmallMultiplesAxisPlacement" + }, + "Scale": { + "$ref": "#/definitions/SmallMultiplesAxisScale" + } + }, + "type": "object" + }, + "SmallMultiplesAxisScale": { + "enum": [ + "SHARED", + "INDEPENDENT" + ], + "type": "string" + }, + "SmallMultiplesOptions": { + "additionalProperties": false, + "properties": { + "MaxVisibleColumns": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "MaxVisibleRows": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "PanelConfiguration": { + "$ref": "#/definitions/PanelConfiguration" + }, + "XAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + }, + "YAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + } + }, + "type": "object" + }, + "SortDirection": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "Spacing": { + "additionalProperties": false, + "properties": { + "Bottom": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Left": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Right": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Top": { + "description": "String based length that is composed of value and unit", + "type": "string" + } + }, + "type": "object" + }, + "SpecialValue": { + "enum": [ + "EMPTY", + "NULL", + "OTHER" + ], + "type": "string" + }, + "StringDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "StringFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "StringParameter": { + "additionalProperties": false, + "description": "

A string parameter.

", + "properties": { + "Name": { + "description": "

A display name for a string parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values of a string parameter.

", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "StringParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/StringDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/StringValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "StringValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "StyledCellType": { + "enum": [ + "TOTAL", + "METRIC_HEADER", + "VALUE" + ], + "type": "string" + }, + "SubtotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FieldLevel": { + "$ref": "#/definitions/PivotTableSubtotalLevel" + }, + "FieldLevelOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldSubtotalOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "StyleTargets": { + "items": { + "$ref": "#/definitions/TableStyleTarget" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "TableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableBorderOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/TableBorderStyle" + }, + "Thickness": { + "maximum": 4, + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "TableBorderStyle": { + "enum": [ + "NONE", + "SOLID" + ], + "type": "string" + }, + "TableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableCellImageScalingConfiguration": { + "enum": [ + "FIT_TO_CELL_HEIGHT", + "FIT_TO_CELL_WIDTH", + "DO_NOT_SCALE" + ], + "type": "string" + }, + "TableCellImageSizingConfiguration": { + "additionalProperties": false, + "properties": { + "TableCellImageScalingConfiguration": { + "$ref": "#/definitions/TableCellImageScalingConfiguration" + } + }, + "type": "object" + }, + "TableCellStyle": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Border": { + "$ref": "#/definitions/GlobalTableBorderOptions" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Height": { + "maximum": 500, + "minimum": 8, + "type": "number" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "TextWrap": { + "$ref": "#/definitions/TextWrap" + }, + "VerticalTextAlignment": { + "$ref": "#/definitions/VerticalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/TableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/TableCellConditionalFormatting" + }, + "Row": { + "$ref": "#/definitions/TableRowConditionalFormatting" + } + }, + "type": "object" + }, + "TableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/TableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/TablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TableSortConfiguration" + }, + "TableInlineVisualizations": { + "items": { + "$ref": "#/definitions/TableInlineVisualization" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TableOptions": { + "$ref": "#/definitions/TableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/TotalOptions" + } + }, + "type": "object" + }, + "TableFieldCustomIconContent": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/TableFieldIconSetType" + } + }, + "type": "object" + }, + "TableFieldCustomTextContent": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "FontConfiguration" + ], + "type": "object" + }, + "TableFieldIconSetType": { + "enum": [ + "LINK" + ], + "type": "string" + }, + "TableFieldImageConfiguration": { + "additionalProperties": false, + "properties": { + "SizingOptions": { + "$ref": "#/definitions/TableCellImageSizingConfiguration" + } + }, + "type": "object" + }, + "TableFieldLinkConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/TableFieldLinkContentConfiguration" + }, + "Target": { + "$ref": "#/definitions/URLTargetConfiguration" + } + }, + "required": [ + "Content", + "Target" + ], + "type": "object" + }, + "TableFieldLinkContentConfiguration": { + "additionalProperties": false, + "properties": { + "CustomIconContent": { + "$ref": "#/definitions/TableFieldCustomIconContent" + }, + "CustomTextContent": { + "$ref": "#/definitions/TableFieldCustomTextContent" + } + }, + "type": "object" + }, + "TableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "URLStyling": { + "$ref": "#/definitions/TableFieldURLConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableFieldOptions": { + "additionalProperties": false, + "properties": { + "Order": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "PinnedFieldOptions": { + "$ref": "#/definitions/TablePinnedFieldOptions" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/TableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableFieldURLConfiguration": { + "additionalProperties": false, + "properties": { + "ImageConfiguration": { + "$ref": "#/definitions/TableFieldImageConfiguration" + }, + "LinkConfiguration": { + "$ref": "#/definitions/TableFieldLinkConfiguration" + } + }, + "type": "object" + }, + "TableFieldWells": { + "additionalProperties": false, + "properties": { + "TableAggregatedFieldWells": { + "$ref": "#/definitions/TableAggregatedFieldWells" + }, + "TableUnaggregatedFieldWells": { + "$ref": "#/definitions/TableUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "TableInlineVisualization": { + "additionalProperties": false, + "properties": { + "DataBars": { + "$ref": "#/definitions/DataBarsOptions" + } + }, + "type": "object" + }, + "TableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "HeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Orientation": { + "$ref": "#/definitions/TableOrientation" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + } + }, + "type": "object" + }, + "TableOrientation": { + "enum": [ + "VERTICAL", + "HORIZONTAL" + ], + "type": "string" + }, + "TablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TablePinnedFieldOptions": { + "additionalProperties": false, + "properties": { + "PinnedLeftFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 201, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableRowConditionalFormatting": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TableSideBorderOptions": { + "additionalProperties": false, + "properties": { + "Bottom": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerHorizontal": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerVertical": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Left": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Right": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Top": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "TableSortConfiguration": { + "additionalProperties": false, + "properties": { + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + }, + "RowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableStyleTarget": { + "additionalProperties": false, + "properties": { + "CellType": { + "$ref": "#/definitions/StyledCellType" + } + }, + "required": [ + "CellType" + ], + "type": "object" + }, + "TableTotalsPlacement": { + "enum": [ + "START", + "END", + "AUTO" + ], + "type": "string" + }, + "TableTotalsScrollStatus": { + "enum": [ + "PINNED", + "SCROLLED" + ], + "type": "string" + }, + "TableUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/UnaggregatedField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/TableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TargetVisualOptions": { + "enum": [ + "ALL_VISUALS" + ], + "type": "string" + }, + "TextAreaControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TextControlPlaceholderOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TextFieldControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextWrap": { + "enum": [ + "NONE", + "WRAP" + ], + "type": "string" + }, + "ThousandSeparatorOptions": { + "additionalProperties": false, + "properties": { + "Symbol": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TimeBasedForecastProperties": { + "additionalProperties": false, + "properties": { + "LowerBoundary": { + "default": null, + "type": "number" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "UpperBoundary": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "TimeEqualityFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Value": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "Column", + "FilterId" + ], + "type": "object" + }, + "TimeGranularity": { + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND", + "MILLISECOND" + ], + "type": "string" + }, + "TimeRangeDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "RangeMaximum": { + "format": "date-time", + "type": "string" + }, + "RangeMinimum": { + "format": "date-time", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "RangeMaximum", + "RangeMinimum", + "TimeGranularity" + ], + "type": "object" + }, + "TimeRangeFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "RangeMinimumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "TimeRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValue": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "TooltipItem": { + "additionalProperties": false, + "properties": { + "ColumnTooltipItem": { + "$ref": "#/definitions/ColumnTooltipItem" + }, + "FieldTooltipItem": { + "$ref": "#/definitions/FieldTooltipItem" + } + }, + "type": "object" + }, + "TooltipOptions": { + "additionalProperties": false, + "properties": { + "FieldBasedTooltip": { + "$ref": "#/definitions/FieldBasedTooltip" + }, + "SelectedTooltipType": { + "$ref": "#/definitions/SelectedTooltipType" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TooltipTarget": { + "enum": [ + "BOTH", + "BAR", + "LINE" + ], + "type": "string" + }, + "TooltipTitleType": { + "enum": [ + "NONE", + "PRIMARY_VALUE" + ], + "type": "string" + }, + "TopBottomComputationType": { + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "TopBottomFilter": { + "additionalProperties": false, + "properties": { + "AggregationSortConfigurations": { + "items": { + "$ref": "#/definitions/AggregationSortConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Limit": { + "default": null, + "type": "number" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AggregationSortConfigurations", + "Column", + "FilterId" + ], + "type": "object" + }, + "TopBottomMoversComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MoverSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Name": { + "type": "string" + }, + "SortOrder": { + "$ref": "#/definitions/TopBottomSortOrder" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomRankedComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResultSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomSortOrder": { + "enum": [ + "PERCENT_DIFFERENCE", + "ABSOLUTE_DIFFERENCE" + ], + "type": "string" + }, + "TotalAggregationComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "TotalAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleTotalAggregationFunction": { + "$ref": "#/definitions/SimpleTotalAggregationFunction" + } + }, + "type": "object" + }, + "TotalAggregationOption": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TotalAggregationFunction": { + "$ref": "#/definitions/TotalAggregationFunction" + } + }, + "required": [ + "FieldId", + "TotalAggregationFunction" + ], + "type": "object" + }, + "TotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TreeMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Groups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Sizes": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TreeMapFieldWells" + }, + "GroupLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SizeLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TreeMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "TreeMapFieldWells": { + "additionalProperties": false, + "properties": { + "TreeMapAggregatedFieldWells": { + "$ref": "#/definitions/TreeMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "TreeMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "TreeMapSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TreeMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "TrendArrowOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "URLTargetConfiguration": { + "enum": [ + "NEW_TAB", + "NEW_WINDOW", + "SAME_TAB" + ], + "type": "string" + }, + "UnaggregatedField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "UniqueValuesComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ValidationStrategy": { + "additionalProperties": false, + "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", + "properties": { + "Mode": { + "$ref": "#/definitions/ValidationStrategyMode" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "ValidationStrategyMode": { + "enum": [ + "STRICT", + "LENIENT" + ], + "type": "string" + }, + "ValueWhenUnsetOption": { + "enum": [ + "RECOMMENDED_VALUE", + "NULL" + ], + "type": "string" + }, + "VerticalTextAlignment": { + "enum": [ + "TOP", + "MIDDLE", + "BOTTOM", + "AUTO" + ], + "type": "string" + }, + "Visibility": { + "enum": [ + "HIDDEN", + "VISIBLE" + ], + "type": "string" + }, + "VisibleRangeOptions": { + "additionalProperties": false, + "properties": { + "PercentRange": { + "$ref": "#/definitions/PercentVisibleRange" + } + }, + "type": "object" + }, + "Visual": { + "additionalProperties": false, + "properties": { + "BarChartVisual": { + "$ref": "#/definitions/BarChartVisual" + }, + "BoxPlotVisual": { + "$ref": "#/definitions/BoxPlotVisual" + }, + "ComboChartVisual": { + "$ref": "#/definitions/ComboChartVisual" + }, + "CustomContentVisual": { + "$ref": "#/definitions/CustomContentVisual" + }, + "EmptyVisual": { + "$ref": "#/definitions/EmptyVisual" + }, + "FilledMapVisual": { + "$ref": "#/definitions/FilledMapVisual" + }, + "FunnelChartVisual": { + "$ref": "#/definitions/FunnelChartVisual" + }, + "GaugeChartVisual": { + "$ref": "#/definitions/GaugeChartVisual" + }, + "GeospatialMapVisual": { + "$ref": "#/definitions/GeospatialMapVisual" + }, + "HeatMapVisual": { + "$ref": "#/definitions/HeatMapVisual" + }, + "HistogramVisual": { + "$ref": "#/definitions/HistogramVisual" + }, + "InsightVisual": { + "$ref": "#/definitions/InsightVisual" + }, + "KPIVisual": { + "$ref": "#/definitions/KPIVisual" + }, + "LineChartVisual": { + "$ref": "#/definitions/LineChartVisual" + }, + "PieChartVisual": { + "$ref": "#/definitions/PieChartVisual" + }, + "PivotTableVisual": { + "$ref": "#/definitions/PivotTableVisual" + }, + "RadarChartVisual": { + "$ref": "#/definitions/RadarChartVisual" + }, + "SankeyDiagramVisual": { + "$ref": "#/definitions/SankeyDiagramVisual" + }, + "ScatterPlotVisual": { + "$ref": "#/definitions/ScatterPlotVisual" + }, + "TableVisual": { + "$ref": "#/definitions/TableVisual" + }, + "TreeMapVisual": { + "$ref": "#/definitions/TreeMapVisual" + }, + "WaterfallVisual": { + "$ref": "#/definitions/WaterfallVisual" + }, + "WordCloudVisual": { + "$ref": "#/definitions/WordCloudVisual" + } + }, + "type": "object" + }, + "VisualCustomAction": { + "additionalProperties": false, + "properties": { + "ActionOperations": { + "items": { + "$ref": "#/definitions/VisualCustomActionOperation" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "CustomActionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "Trigger": { + "$ref": "#/definitions/VisualCustomActionTrigger" + } + }, + "required": [ + "ActionOperations", + "CustomActionId", + "Name", + "Trigger" + ], + "type": "object" + }, + "VisualCustomActionOperation": { + "additionalProperties": false, + "properties": { + "FilterOperation": { + "$ref": "#/definitions/CustomActionFilterOperation" + }, + "NavigationOperation": { + "$ref": "#/definitions/CustomActionNavigationOperation" + }, + "SetParametersOperation": { + "$ref": "#/definitions/CustomActionSetParametersOperation" + }, + "URLOperation": { + "$ref": "#/definitions/CustomActionURLOperation" + } + }, + "type": "object" + }, + "VisualCustomActionTrigger": { + "enum": [ + "DATA_POINT_CLICK", + "DATA_POINT_MENU" + ], + "type": "string" + }, + "VisualPalette": { + "additionalProperties": false, + "properties": { + "ChartColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "ColorMap": { + "items": { + "$ref": "#/definitions/DataPathColor" + }, + "maxItems": 5000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "VisualSubtitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/LongFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "VisualTitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/ShortFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "WaterfallChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Breakdowns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Categories": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, + "WaterfallChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WaterfallChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/WaterfallChartSortConfiguration" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WaterfallChartOptions": { + "$ref": "#/definitions/WaterfallChartOptions" + } + }, + "type": "object" + }, + "WaterfallChartFieldWells": { + "additionalProperties": false, + "properties": { + "WaterfallChartAggregatedFieldWells": { + "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartOptions": { + "additionalProperties": false, + "properties": { + "TotalBarLabel": { + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "BreakdownItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WaterfallChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WhatIfPointScenario": { + "additionalProperties": false, + "properties": { + "Date": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Date", + "Value" + ], + "type": "object" + }, + "WhatIfRangeScenario": { + "additionalProperties": false, + "properties": { + "EndDate": { + "format": "date-time", + "type": "string" + }, + "StartDate": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "EndDate", + "StartDate", + "Value" + ], + "type": "object" + }, + "WidgetStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "WordCloudAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WordCloudFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/WordCloudSortConfiguration" + }, + "WordCloudOptions": { + "$ref": "#/definitions/WordCloudOptions" + } + }, + "type": "object" + }, + "WordCloudCloudLayout": { + "enum": [ + "FLUID", + "NORMAL" + ], + "type": "string" + }, + "WordCloudFieldWells": { + "additionalProperties": false, + "properties": { + "WordCloudAggregatedFieldWells": { + "$ref": "#/definitions/WordCloudAggregatedFieldWells" + } + }, + "type": "object" + }, + "WordCloudOptions": { + "additionalProperties": false, + "properties": { + "CloudLayout": { + "$ref": "#/definitions/WordCloudCloudLayout" + }, + "MaximumStringLength": { + "maximum": 100, + "minimum": 1, + "type": "number" + }, + "WordCasing": { + "$ref": "#/definitions/WordCloudWordCasing" + }, + "WordOrientation": { + "$ref": "#/definitions/WordCloudWordOrientation" + }, + "WordPadding": { + "$ref": "#/definitions/WordCloudWordPadding" + }, + "WordScaling": { + "$ref": "#/definitions/WordCloudWordScaling" + } + }, + "type": "object" + }, + "WordCloudSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WordCloudChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WordCloudWordCasing": { + "enum": [ + "LOWER_CASE", + "EXISTING_CASE" + ], + "type": "string" + }, + "WordCloudWordOrientation": { + "enum": [ + "HORIZONTAL", + "HORIZONTAL_AND_VERTICAL" + ], + "type": "string" + }, + "WordCloudWordPadding": { + "enum": [ + "NONE", + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "WordCloudWordScaling": { + "enum": [ + "EMPHASIZE", + "NORMAL" + ], + "type": "string" + }, + "YAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxis": { + "$ref": "#/definitions/SingleYAxisOption" + } + }, + "required": [ + "YAxis" + ], + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::Analysis Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:DescribeAnalysis", + "quicksight:DescribeAnalysisPermissions", + "quicksight:CreateAnalysis", + "quicksight:DescribeTemplate", + "quicksight:DescribeTheme", + "quicksight:PassDataSet", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeAnalysis", + "quicksight:DeleteAnalysis" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + } + }, + "required": [ + "AwsAccountId" + ] + }, + "permissions": [ + "quicksight:ListAnalyses" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeAnalysis", + "quicksight:DescribeAnalysisPermissions", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeAnalysis", + "quicksight:DescribeAnalysisPermissions", + "quicksight:UpdateAnalysis", + "quicksight:UpdateAnalysisPermissions", + "quicksight:CreateFolderMembership", + "quicksight:DeleteFolderMembership", + "quicksight:ListFoldersForResource", + "quicksight:DescribeTemplate", + "quicksight:DescribeTheme", + "quicksight:PassDataSet", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AnalysisId", + "/properties/AwsAccountId" + ], + "properties": { + "AnalysisId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the analysis.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "CreatedTime": { + "description": "

The time that the analysis was created.

", + "format": "date-time", + "type": "string" + }, + "DataSetArns": { + "description": "

The ARNs of the datasets of the analysis.

", + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Definition": { + "$ref": "#/definitions/AnalysisDefinition" + }, + "Errors": { + "description": "

Errors associated with the analysis.

", + "items": { + "$ref": "#/definitions/AnalysisError" + }, + "minItems": 1, + "type": "array" + }, + "LastUpdatedTime": { + "description": "

The time that the analysis was last updated.

", + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "

The descriptive name of the analysis.

", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/Parameters" + }, + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "Sheets": { + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", + "items": { + "$ref": "#/definitions/Sheet" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SourceEntity": { + "$ref": "#/definitions/AnalysisSourceEntity" + }, + "Status": { + "$ref": "#/definitions/ResourceStatus" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "ThemeArn": { + "description": "

The ARN of the theme of the analysis.

", + "type": "string" + }, + "ValidationStrategy": { + "$ref": "#/definitions/ValidationStrategy" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/DataSetArns", + "/properties/LastUpdatedTime" + ], + "required": [ + "AwsAccountId", + "AnalysisId", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "typeName": "AWS::QuickSight::Analysis", + "writeOnlyProperties": [ + "/properties/Definition", + "/properties/Parameters", + "/properties/SourceEntity", + "/properties/Status", + "/properties/ValidationStrategy" + ] +} diff --git a/schema/aws-quicksight-dashboard.json b/schema/aws-quicksight-dashboard.json index cab841a..12d65fd 100644 --- a/schema/aws-quicksight-dashboard.json +++ b/schema/aws-quicksight-dashboard.json @@ -1,11589 +1,11698 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/DashboardId" - ], - "definitions": { - "AdHocFilteringOption": { - "additionalProperties": false, - "description": "

An ad hoc (one-time) filtering option.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "AggregationFunction": { - "additionalProperties": false, - "properties": { - "AttributeAggregationFunction": { - "$ref": "#/definitions/AttributeAggregationFunction" - }, - "CategoricalAggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "DateAggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "NumericalAggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - } - }, - "type": "object" - }, - "AggregationSortConfiguration": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SortDirection": { - "$ref": "#/definitions/SortDirection" - } - }, - "required": [ - "Column", - "SortDirection" - ], - "type": "object" - }, - "AllSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "type": "object" - }, - "AnalysisDefaults": { - "additionalProperties": false, - "properties": { - "DefaultNewSheetConfiguration": { - "$ref": "#/definitions/DefaultNewSheetConfiguration" - } - }, - "required": [ - "DefaultNewSheetConfiguration" - ], - "type": "object" - }, - "AnchorDateConfiguration": { - "additionalProperties": false, - "properties": { - "AnchorOption": { - "$ref": "#/definitions/AnchorOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "type": "object" - }, - "AnchorOption": { - "enum": [ - "NOW" - ], - "type": "string" - }, - "ArcAxisConfiguration": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/ArcAxisDisplayRange" - }, - "ReserveRange": { - "default": 0, - "type": "number" - } - }, - "type": "object" - }, - "ArcAxisDisplayRange": { - "additionalProperties": false, - "properties": { - "Max": { - "default": null, - "type": "number" - }, - "Min": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "ArcConfiguration": { - "additionalProperties": false, - "properties": { - "ArcAngle": { - "default": null, - "type": "number" - }, - "ArcThickness": { - "$ref": "#/definitions/ArcThicknessOptions" - } - }, - "type": "object" - }, - "ArcOptions": { - "additionalProperties": false, - "properties": { - "ArcThickness": { - "$ref": "#/definitions/ArcThickness" - } - }, - "type": "object" - }, - "ArcThickness": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE", - "WHOLE" - ], - "type": "string" - }, - "ArcThicknessOptions": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "AssetOptions": { - "additionalProperties": false, - "properties": { - "Timezone": { - "type": "string" - }, - "WeekStart": { - "$ref": "#/definitions/DayOfTheWeek" - } - }, - "type": "object" - }, - "AttributeAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleAttributeAggregation": { - "$ref": "#/definitions/SimpleAttributeAggregationFunction" - }, - "ValueForMultipleValues": { - "type": "string" - } - }, - "type": "object" - }, - "AxisBinding": { - "enum": [ - "PRIMARY_YAXIS", - "SECONDARY_YAXIS" - ], - "type": "string" - }, - "AxisDataOptions": { - "additionalProperties": false, - "properties": { - "DateAxisOptions": { - "$ref": "#/definitions/DateAxisOptions" - }, - "NumericAxisOptions": { - "$ref": "#/definitions/NumericAxisOptions" - } - }, - "type": "object" - }, - "AxisDisplayDataDrivenRange": { - "additionalProperties": false, - "type": "object" - }, - "AxisDisplayMinMaxRange": { - "additionalProperties": false, - "properties": { - "Maximum": { - "default": null, - "type": "number" - }, - "Minimum": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AxisOffset": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "DataOptions": { - "$ref": "#/definitions/AxisDataOptions" - }, - "GridLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ScrollbarOptions": { - "$ref": "#/definitions/ScrollBarOptions" - }, - "TickLabelOptions": { - "$ref": "#/definitions/AxisTickLabelOptions" - } - }, - "type": "object" - }, - "AxisDisplayRange": { - "additionalProperties": false, - "properties": { - "DataDriven": { - "$ref": "#/definitions/AxisDisplayDataDrivenRange" - }, - "MinMax": { - "$ref": "#/definitions/AxisDisplayMinMaxRange" - } - }, - "type": "object" - }, - "AxisLabelOptions": { - "additionalProperties": false, - "properties": { - "ApplyTo": { - "$ref": "#/definitions/AxisLabelReferenceOptions" - }, - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "AxisLabelReferenceOptions": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "AxisLinearScale": { - "additionalProperties": false, - "properties": { - "StepCount": { - "default": null, - "type": "number" - }, - "StepSize": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisLogarithmicScale": { - "additionalProperties": false, - "properties": { - "Base": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisScale": { - "additionalProperties": false, - "properties": { - "Linear": { - "$ref": "#/definitions/AxisLinearScale" - }, - "Logarithmic": { - "$ref": "#/definitions/AxisLogarithmicScale" - } - }, - "type": "object" - }, - "AxisTickLabelOptions": { - "additionalProperties": false, - "properties": { - "LabelOptions": { - "$ref": "#/definitions/LabelOptions" - }, - "RotationAngle": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "BarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Orientation": { - "$ref": "#/definitions/BarChartOrientation" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/BarChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BarChartFieldWells": { - "additionalProperties": false, - "properties": { - "BarChartAggregatedFieldWells": { - "$ref": "#/definitions/BarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "BarChartOrientation": { - "enum": [ - "HORIZONTAL", - "VERTICAL" - ], - "type": "string" - }, - "BarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "BarsArrangement": { - "enum": [ - "CLUSTERED", - "STACKED", - "STACKED_PERCENT" - ], - "type": "string" - }, - "BaseMapStyleType": { - "enum": [ - "LIGHT_GRAY", - "DARK_GRAY", - "STREET", - "IMAGERY" - ], - "type": "string" - }, - "BinCountOptions": { - "additionalProperties": false, - "properties": { - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BinWidthOptions": { - "additionalProperties": false, - "properties": { - "BinCountLimit": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BodySectionConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/BodySectionContent" - }, - "PageBreakConfiguration": { - "$ref": "#/definitions/SectionPageBreakConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Content", - "SectionId" - ], - "type": "object" - }, - "BodySectionContent": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - } - }, - "type": "object" - }, - "BoxPlotAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BoxPlotChartConfiguration": { - "additionalProperties": false, - "properties": { - "BoxPlotOptions": { - "$ref": "#/definitions/BoxPlotOptions" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BoxPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SortConfiguration": { - "$ref": "#/definitions/BoxPlotSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BoxPlotFieldWells": { - "additionalProperties": false, - "properties": { - "BoxPlotAggregatedFieldWells": { - "$ref": "#/definitions/BoxPlotAggregatedFieldWells" - } - }, - "type": "object" - }, - "BoxPlotFillStyle": { - "enum": [ - "SOLID", - "TRANSPARENT" - ], - "type": "string" - }, - "BoxPlotOptions": { - "additionalProperties": false, - "properties": { - "AllDataPointsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "OutlierVisibility": { - "$ref": "#/definitions/Visibility" - }, - "StyleOptions": { - "$ref": "#/definitions/BoxPlotStyleOptions" - } - }, - "type": "object" - }, - "BoxPlotSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - } - }, - "type": "object" - }, - "BoxPlotStyleOptions": { - "additionalProperties": false, - "properties": { - "FillStyle": { - "$ref": "#/definitions/BoxPlotFillStyle" - } - }, - "type": "object" - }, - "BoxPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BoxPlotChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "CalculatedField": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 32000, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "Expression", - "Name" - ], - "type": "object" - }, - "CalculatedMeasureField": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression", - "FieldId" - ], - "type": "object" - }, - "CascadingControlConfiguration": { - "additionalProperties": false, - "properties": { - "SourceControls": { - "items": { - "$ref": "#/definitions/CascadingControlSource" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CascadingControlSource": { - "additionalProperties": false, - "properties": { - "ColumnToMatch": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceSheetControlId": { - "type": "string" - } - }, - "type": "object" - }, - "CategoricalAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT" - ], - "type": "string" - }, - "CategoricalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoricalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoryDrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "CategoryValues", - "Column" - ], - "type": "object" - }, - "CategoryFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Configuration": { - "$ref": "#/definitions/CategoryFilterConfiguration" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "Column", - "Configuration", - "FilterId" - ], - "type": "object" - }, - "CategoryFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CustomFilterConfiguration": { - "$ref": "#/definitions/CustomFilterConfiguration" - }, - "CustomFilterListConfiguration": { - "$ref": "#/definitions/CustomFilterListConfiguration" - }, - "FilterListConfiguration": { - "$ref": "#/definitions/FilterListConfiguration" - } - }, - "type": "object" - }, - "CategoryFilterMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL", - "CONTAINS", - "DOES_NOT_CONTAIN", - "STARTS_WITH", - "ENDS_WITH" - ], - "type": "string" - }, - "CategoryFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "ChartAxisLabelOptions": { - "additionalProperties": false, - "properties": { - "AxisLabelOptions": { - "items": { - "$ref": "#/definitions/AxisLabelOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SortIconVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ClusterMarker": { - "additionalProperties": false, - "properties": { - "SimpleClusterMarker": { - "$ref": "#/definitions/SimpleClusterMarker" - } - }, - "type": "object" - }, - "ClusterMarkerConfiguration": { - "additionalProperties": false, - "properties": { - "ClusterMarker": { - "$ref": "#/definitions/ClusterMarker" - } - }, - "type": "object" - }, - "ColorFillType": { - "enum": [ - "DISCRETE", - "GRADIENT" - ], - "type": "string" - }, - "ColorScale": { - "additionalProperties": false, - "properties": { - "ColorFillType": { - "$ref": "#/definitions/ColorFillType" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DataColor" - }, - "maxItems": 3, - "minItems": 2, - "type": "array" - }, - "NullValueColor": { - "$ref": "#/definitions/DataColor" - } - }, - "required": [ - "ColorFillType", - "Colors" - ], - "type": "object" - }, - "ColorsConfiguration": { - "additionalProperties": false, - "properties": { - "CustomColors": { - "items": { - "$ref": "#/definitions/CustomColor" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ColumnConfiguration": { - "additionalProperties": false, - "properties": { - "ColorsConfiguration": { - "$ref": "#/definitions/ColorsConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - }, - "Role": { - "$ref": "#/definitions/ColumnRole" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ColumnHierarchy": { - "additionalProperties": false, - "properties": { - "DateTimeHierarchy": { - "$ref": "#/definitions/DateTimeHierarchy" - }, - "ExplicitHierarchy": { - "$ref": "#/definitions/ExplicitHierarchy" - }, - "PredefinedHierarchy": { - "$ref": "#/definitions/PredefinedHierarchy" - } - }, - "type": "object" - }, - "ColumnIdentifier": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ColumnName", - "DataSetIdentifier" - ], - "type": "object" - }, - "ColumnRole": { - "enum": [ - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "ColumnSort": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortBy": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "Direction", - "SortBy" - ], - "type": "object" - }, - "ColumnTooltipItem": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ComboChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "BarValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "LineValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ComboChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "LineDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/ComboChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "ComboChartFieldWells": { - "additionalProperties": false, - "properties": { - "ComboChartAggregatedFieldWells": { - "$ref": "#/definitions/ComboChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "ComboChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ComboChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ComparisonConfiguration": { - "additionalProperties": false, - "properties": { - "ComparisonFormat": { - "$ref": "#/definitions/ComparisonFormatConfiguration" - }, - "ComparisonMethod": { - "$ref": "#/definitions/ComparisonMethod" - } - }, - "type": "object" - }, - "ComparisonFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "ComparisonMethod": { - "enum": [ - "DIFFERENCE", - "PERCENT_DIFFERENCE", - "PERCENT" - ], - "type": "string" - }, - "Computation": { - "additionalProperties": false, - "properties": { - "Forecast": { - "$ref": "#/definitions/ForecastComputation" - }, - "GrowthRate": { - "$ref": "#/definitions/GrowthRateComputation" - }, - "MaximumMinimum": { - "$ref": "#/definitions/MaximumMinimumComputation" - }, - "MetricComparison": { - "$ref": "#/definitions/MetricComparisonComputation" - }, - "PeriodOverPeriod": { - "$ref": "#/definitions/PeriodOverPeriodComputation" - }, - "PeriodToDate": { - "$ref": "#/definitions/PeriodToDateComputation" - }, - "TopBottomMovers": { - "$ref": "#/definitions/TopBottomMoversComputation" - }, - "TopBottomRanked": { - "$ref": "#/definitions/TopBottomRankedComputation" - }, - "TotalAggregation": { - "$ref": "#/definitions/TotalAggregationComputation" - }, - "UniqueValues": { - "$ref": "#/definitions/UniqueValuesComputation" - } - }, - "type": "object" - }, - "ConditionalFormattingColor": { - "additionalProperties": false, - "properties": { - "Gradient": { - "$ref": "#/definitions/ConditionalFormattingGradientColor" - }, - "Solid": { - "$ref": "#/definitions/ConditionalFormattingSolidColor" - } - }, - "type": "object" - }, - "ConditionalFormattingCustomIconCondition": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DisplayConfiguration": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconOptions": { - "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" - } - }, - "required": [ - "Expression", - "IconOptions" - ], - "type": "object" - }, - "ConditionalFormattingCustomIconOptions": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/Icon" - }, - "UnicodeIcon": { - "pattern": "^[^\\u0000-\\u00FF]$", - "type": "string" - } - }, - "type": "object" - }, - "ConditionalFormattingGradientColor": { - "additionalProperties": false, - "properties": { - "Color": { - "$ref": "#/definitions/GradientColor" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Color", - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIcon": { - "additionalProperties": false, - "properties": { - "CustomCondition": { - "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" - }, - "IconSet": { - "$ref": "#/definitions/ConditionalFormattingIconSet" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayConfiguration": { - "additionalProperties": false, - "properties": { - "IconDisplayOption": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayOption": { - "enum": [ - "ICON_ONLY" - ], - "type": "string" - }, - "ConditionalFormattingIconSet": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconSetType": { - "$ref": "#/definitions/ConditionalFormattingIconSetType" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIconSetType": { - "enum": [ - "PLUS_MINUS", - "CHECK_X", - "THREE_COLOR_ARROW", - "THREE_GRAY_ARROW", - "CARET_UP_MINUS_DOWN", - "THREE_SHAPE", - "THREE_CIRCLE", - "FLAGS", - "BARS", - "FOUR_COLOR_ARROW", - "FOUR_GRAY_ARROW" - ], - "type": "string" - }, - "ConditionalFormattingSolidColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ContributionAnalysisDefault": { - "additionalProperties": false, - "properties": { - "ContributorDimensions": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "MeasureFieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ContributorDimensions", - "MeasureFieldId" - ], - "type": "object" - }, - "CrossDatasetTypes": { - "enum": [ - "ALL_DATASETS", - "SINGLE_DATASET" - ], - "type": "string" - }, - "CurrencyDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Symbol": { - "pattern": "^[A-Z]{3}$", - "type": "string" - } - }, - "type": "object" - }, - "CustomActionFilterOperation": { - "additionalProperties": false, - "properties": { - "SelectedFieldsConfiguration": { - "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" - }, - "TargetVisualsConfiguration": { - "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" - } - }, - "required": [ - "SelectedFieldsConfiguration", - "TargetVisualsConfiguration" - ], - "type": "object" - }, - "CustomActionNavigationOperation": { - "additionalProperties": false, - "properties": { - "LocalNavigationConfiguration": { - "$ref": "#/definitions/LocalNavigationConfiguration" - } - }, - "type": "object" - }, - "CustomActionSetParametersOperation": { - "additionalProperties": false, - "properties": { - "ParameterValueConfigurations": { - "items": { - "$ref": "#/definitions/SetParameterValueConfiguration" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ParameterValueConfigurations" - ], - "type": "object" - }, - "CustomActionURLOperation": { - "additionalProperties": false, - "properties": { - "URLTarget": { - "$ref": "#/definitions/URLTargetConfiguration" - }, - "URLTemplate": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "URLTarget", - "URLTemplate" - ], - "type": "object" - }, - "CustomColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "SpecialValue": { - "$ref": "#/definitions/SpecialValue" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "CustomContentConfiguration": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/CustomContentType" - }, - "ContentUrl": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ImageScaling": { - "$ref": "#/definitions/CustomContentImageScalingConfiguration" - } - }, - "type": "object" - }, - "CustomContentImageScalingConfiguration": { - "enum": [ - "FIT_TO_HEIGHT", - "FIT_TO_WIDTH", - "DO_NOT_SCALE", - "SCALE_TO_VISUAL" - ], - "type": "string" - }, - "CustomContentType": { - "enum": [ - "IMAGE", - "OTHER_EMBEDDED_CONTENT" - ], - "type": "string" - }, - "CustomContentVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/CustomContentConfiguration" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "CustomFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValue": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomFilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomNarrativeOptions": { - "additionalProperties": false, - "properties": { - "Narrative": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Narrative" - ], - "type": "object" - }, - "CustomParameterValues": { - "additionalProperties": false, - "properties": { - "DateTimeValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "DecimalValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "IntegerValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "StringValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CustomValuesConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValues": { - "$ref": "#/definitions/CustomParameterValues" - }, - "IncludeNullValue": { - "type": "boolean" - } - }, - "required": [ - "CustomValues" - ], - "type": "object" - }, - "DashboardBehavior": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "DashboardError": { - "additionalProperties": false, - "description": "

Dashboard error.

", - "properties": { - "Message": { - "description": "

Message.

", - "pattern": "\\S", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/DashboardErrorType" - }, - "ViolatedEntities": { - "description": "

Lists the violated entities that caused the dashboard error.

", - "items": { - "$ref": "#/definitions/Entity" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DashboardErrorType": { - "enum": [ - "ACCESS_DENIED", - "SOURCE_NOT_FOUND", - "DATA_SET_NOT_FOUND", - "INTERNAL_FAILURE", - "PARAMETER_VALUE_INCOMPATIBLE", - "PARAMETER_TYPE_INVALID", - "PARAMETER_NOT_FOUND", - "COLUMN_TYPE_MISMATCH", - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", - "COLUMN_REPLACEMENT_MISSING" - ], - "type": "string" - }, - "DashboardPublishOptions": { - "additionalProperties": false, - "description": "

Dashboard publish options.

", - "properties": { - "AdHocFilteringOption": { - "$ref": "#/definitions/AdHocFilteringOption" - }, - "DataPointDrillUpDownOption": { - "$ref": "#/definitions/DataPointDrillUpDownOption" - }, - "DataPointMenuLabelOption": { - "$ref": "#/definitions/DataPointMenuLabelOption" - }, - "DataPointTooltipOption": { - "$ref": "#/definitions/DataPointTooltipOption" - }, - "ExportToCSVOption": { - "$ref": "#/definitions/ExportToCSVOption" - }, - "ExportWithHiddenFieldsOption": { - "$ref": "#/definitions/ExportWithHiddenFieldsOption" - }, - "SheetControlsOption": { - "$ref": "#/definitions/SheetControlsOption" - }, - "SheetLayoutElementMaximizationOption": { - "$ref": "#/definitions/SheetLayoutElementMaximizationOption" - }, - "VisualAxisSortOption": { - "$ref": "#/definitions/VisualAxisSortOption" - }, - "VisualMenuOption": { - "$ref": "#/definitions/VisualMenuOption" - }, - "VisualPublishOptions": { - "$ref": "#/definitions/DashboardVisualPublishOptions" - } - }, - "type": "object" - }, - "DashboardSourceEntity": { - "additionalProperties": false, - "description": "

Dashboard source entity.

", - "properties": { - "SourceTemplate": { - "$ref": "#/definitions/DashboardSourceTemplate" - } - }, - "type": "object" - }, - "DashboardSourceTemplate": { - "additionalProperties": false, - "description": "

Dashboard source template.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "DataSetReferences": { - "description": "

Dataset references.

", - "items": { - "$ref": "#/definitions/DataSetReference" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "DashboardUIState": { - "enum": [ - "EXPANDED", - "COLLAPSED" - ], - "type": "string" - }, - "DashboardVersion": { - "additionalProperties": false, - "description": "

Dashboard version.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "CreatedTime": { - "description": "

The time that this dashboard version was created.

", - "format": "date-time", - "type": "string" - }, - "DataSetArns": { - "description": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

", - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Description": { - "description": "

Description.

", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Errors": { - "description": "

Errors associated with this dashboard version.

", - "items": { - "$ref": "#/definitions/DashboardError" - }, - "minItems": 1, - "type": "array" - }, - "Sheets": { - "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", - "items": { - "$ref": "#/definitions/Sheet" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SourceEntityArn": { - "description": "

Source entity ARN.

", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/ResourceStatus" - }, - "ThemeArn": { - "description": "

The ARN of the theme associated with a version of the dashboard.

", - "type": "string" - }, - "VersionNumber": { - "description": "

Version number for this version of the dashboard.

", - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "DashboardVersionDefinition": { - "additionalProperties": false, - "properties": { - "AnalysisDefaults": { - "$ref": "#/definitions/AnalysisDefaults" - }, - "CalculatedFields": { - "items": { - "$ref": "#/definitions/CalculatedField" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - }, - "ColumnConfigurations": { - "items": { - "$ref": "#/definitions/ColumnConfiguration" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifierDeclarations": { - "items": { - "$ref": "#/definitions/DataSetIdentifierDeclaration" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "FilterGroups": { - "items": { - "$ref": "#/definitions/FilterGroup" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "Options": { - "$ref": "#/definitions/AssetOptions" - }, - "ParameterDeclarations": { - "items": { - "$ref": "#/definitions/ParameterDeclaration" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Sheets": { - "items": { - "$ref": "#/definitions/SheetDefinition" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "DataSetIdentifierDeclarations" - ], - "type": "object" - }, - "DashboardVisualPublishOptions": { - "additionalProperties": false, - "description": "

The visual publish options of a visual in a dashboard

", - "properties": { - "ExportHiddenFieldsOption": { - "$ref": "#/definitions/ExportHiddenFieldsOption" - } - }, - "type": "object" - }, - "DataBarsOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "NegativeColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "DataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "DataFieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "DataLabelContent": { - "enum": [ - "VALUE", - "PERCENT", - "VALUE_AND_PERCENT" - ], - "type": "string" - }, - "DataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DataLabelTypes": { - "items": { - "$ref": "#/definitions/DataLabelType" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelContent": { - "$ref": "#/definitions/DataLabelContent" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Overlap": { - "$ref": "#/definitions/DataLabelOverlap" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataLabelOverlap": { - "enum": [ - "DISABLE_OVERLAP", - "ENABLE_OVERLAP" - ], - "type": "string" - }, - "DataLabelPosition": { - "enum": [ - "INSIDE", - "OUTSIDE", - "LEFT", - "TOP", - "BOTTOM", - "RIGHT" - ], - "type": "string" - }, - "DataLabelType": { - "additionalProperties": false, - "properties": { - "DataPathLabelType": { - "$ref": "#/definitions/DataPathLabelType" - }, - "FieldLabelType": { - "$ref": "#/definitions/FieldLabelType" - }, - "MaximumLabelType": { - "$ref": "#/definitions/MaximumLabelType" - }, - "MinimumLabelType": { - "$ref": "#/definitions/MinimumLabelType" - }, - "RangeEndsLabelType": { - "$ref": "#/definitions/RangeEndsLabelType" - } - }, - "type": "object" - }, - "DataPathColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Element": { - "$ref": "#/definitions/DataPathValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Color", - "Element" - ], - "type": "object" - }, - "DataPathLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataPathSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortPaths": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Direction", - "SortPaths" - ], - "type": "object" - }, - "DataPathType": { - "additionalProperties": false, - "properties": { - "PivotTableDataPathType": { - "$ref": "#/definitions/PivotTableDataPathType" - } - }, - "type": "object" - }, - "DataPathValue": { - "additionalProperties": false, - "properties": { - "DataPathType": { - "$ref": "#/definitions/DataPathType" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "DataPointDrillUpDownOption": { - "additionalProperties": false, - "description": "

The drill down options for data points in a dashbaord.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "DataPointMenuLabelOption": { - "additionalProperties": false, - "description": "

The data point menu options of a dashboard.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "DataPointTooltipOption": { - "additionalProperties": false, - "description": "

The data point tooltip options.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "DataSetIdentifierDeclaration": { - "additionalProperties": false, - "properties": { - "DataSetArn": { - "type": "string" - }, - "Identifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetArn", - "Identifier" - ], - "type": "object" - }, - "DataSetReference": { - "additionalProperties": false, - "description": "

Dataset reference.

", - "properties": { - "DataSetArn": { - "description": "

Dataset Amazon Resource Name (ARN).

", - "type": "string" - }, - "DataSetPlaceholder": { - "description": "

Dataset placeholder.

", - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "DateAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT", - "MIN", - "MAX" - ], - "type": "string" - }, - "DateAxisOptions": { - "additionalProperties": false, - "properties": { - "MissingDateVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DateDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DateGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateTimeDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DateTimeFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "DateTimeHierarchy": { - "additionalProperties": false, - "properties": { - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "HierarchyId" - ], - "type": "object" - }, - "DateTimeParameter": { - "additionalProperties": false, - "description": "

A date-time parameter.

", - "properties": { - "Name": { - "description": "

A display name for the date-time parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the date-time parameter.

", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "DateTimeParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DateTimeDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "DateTimePickerControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DateTimeValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "format": "date-time", - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DayOfTheWeek": { - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - }, - "DecimalDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DecimalParameter": { - "additionalProperties": false, - "description": "

A decimal parameter.

", - "properties": { - "Name": { - "description": "

A display name for the decimal parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the decimal parameter.

", - "items": { - "default": 0, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "DecimalParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DecimalDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "DecimalPlacesConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlaces": { - "maximum": 20, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "DecimalPlaces" - ], - "type": "object" - }, - "DecimalValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DefaultDateTimePickerControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "type": "object" - }, - "DefaultFilterControlConfiguration": { - "additionalProperties": false, - "properties": { - "ControlOptions": { - "$ref": "#/definitions/DefaultFilterControlOptions" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ControlOptions", - "Title" - ], - "type": "object" - }, - "DefaultFilterControlOptions": { - "additionalProperties": false, - "properties": { - "DefaultDateTimePickerOptions": { - "$ref": "#/definitions/DefaultDateTimePickerControlOptions" - }, - "DefaultDropdownOptions": { - "$ref": "#/definitions/DefaultFilterDropDownControlOptions" - }, - "DefaultListOptions": { - "$ref": "#/definitions/DefaultFilterListControlOptions" - }, - "DefaultRelativeDateTimeOptions": { - "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" - }, - "DefaultSliderOptions": { - "$ref": "#/definitions/DefaultSliderControlOptions" - }, - "DefaultTextAreaOptions": { - "$ref": "#/definitions/DefaultTextAreaControlOptions" - }, - "DefaultTextFieldOptions": { - "$ref": "#/definitions/DefaultTextFieldControlOptions" - } - }, - "type": "object" - }, - "DefaultFilterDropDownControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFilterListControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultGridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultInteractiveLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeForm": { - "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" - }, - "Grid": { - "$ref": "#/definitions/DefaultGridLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultNewSheetConfiguration": { - "additionalProperties": false, - "properties": { - "InteractiveLayoutConfiguration": { - "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" - }, - "PaginatedLayoutConfiguration": { - "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" - }, - "SheetContentType": { - "$ref": "#/definitions/SheetContentType" - } - }, - "type": "object" - }, - "DefaultPaginatedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "SectionBased": { - "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultRelativeDateTimeControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultSectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultSliderControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "StepSize" - ], - "type": "object" - }, - "DefaultTextAreaControlOptions": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultTextFieldControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - } - }, - "type": "object" - }, - "DestinationParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValuesConfiguration": { - "$ref": "#/definitions/CustomValuesConfiguration" - }, - "SelectAllValueOptions": { - "$ref": "#/definitions/SelectAllValueOptions" - }, - "SourceColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceField": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SourceParameterName": { - "type": "string" - } - }, - "type": "object" - }, - "DimensionField": { - "additionalProperties": false, - "properties": { - "CategoricalDimensionField": { - "$ref": "#/definitions/CategoricalDimensionField" - }, - "DateDimensionField": { - "$ref": "#/definitions/DateDimensionField" - }, - "NumericalDimensionField": { - "$ref": "#/definitions/NumericalDimensionField" - } - }, - "type": "object" - }, - "DonutCenterOptions": { - "additionalProperties": false, - "properties": { - "LabelVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DonutOptions": { - "additionalProperties": false, - "properties": { - "ArcOptions": { - "$ref": "#/definitions/ArcOptions" - }, - "DonutCenterOptions": { - "$ref": "#/definitions/DonutCenterOptions" - } - }, - "type": "object" - }, - "DrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryDrillDownFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityDrillDownFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeDrillDownFilter" - } - }, - "type": "object" - }, - "DropDownControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DynamicDefaultValue": { - "additionalProperties": false, - "properties": { - "DefaultValueColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "GroupNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "UserNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "DefaultValueColumn" - ], - "type": "object" - }, - "EmptyVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "Entity": { - "additionalProperties": false, - "properties": { - "Path": { - "pattern": "\\S", - "type": "string" - } - }, - "type": "object" - }, - "ExcludePeriodConfiguration": { - "additionalProperties": false, - "properties": { - "Amount": { - "default": null, - "type": "number" - }, - "Granularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "Amount", - "Granularity" - ], - "type": "object" - }, - "ExplicitHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 2, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "ExportHiddenFieldsOption": { - "additionalProperties": false, - "description": "

Determines if hidden fields are included in an exported dashboard.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "ExportToCSVOption": { - "additionalProperties": false, - "description": "

Export to .csv option.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "ExportWithHiddenFieldsOption": { - "additionalProperties": false, - "description": "

Determines whether or not hidden fields are visible on exported dashbaords.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "FieldBasedTooltip": { - "additionalProperties": false, - "properties": { - "AggregationVisibility": { - "$ref": "#/definitions/Visibility" - }, - "TooltipFields": { - "items": { - "$ref": "#/definitions/TooltipItem" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "TooltipTitleType": { - "$ref": "#/definitions/TooltipTitleType" - } - }, - "type": "object" - }, - "FieldLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "FieldSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Direction", - "FieldId" - ], - "type": "object" - }, - "FieldSortOptions": { - "additionalProperties": false, - "properties": { - "ColumnSort": { - "$ref": "#/definitions/ColumnSort" - }, - "FieldSort": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "FieldTooltipItem": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/FilledMapConditionalFormattingOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "ConditionalFormattingOptions" - ], - "type": "object" - }, - "FilledMapConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Shape": { - "$ref": "#/definitions/FilledMapShapeConditionalFormatting" - } - }, - "required": [ - "Shape" - ], - "type": "object" - }, - "FilledMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/FilledMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/FilledMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "FilledMapFieldWells": { - "additionalProperties": false, - "properties": { - "FilledMapAggregatedFieldWells": { - "$ref": "#/definitions/FilledMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "FilledMapShapeConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Format": { - "$ref": "#/definitions/ShapeConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FilledMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/FilledMapConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityFilter" - }, - "NumericRangeFilter": { - "$ref": "#/definitions/NumericRangeFilter" - }, - "RelativeDatesFilter": { - "$ref": "#/definitions/RelativeDatesFilter" - }, - "TimeEqualityFilter": { - "$ref": "#/definitions/TimeEqualityFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeFilter" - }, - "TopBottomFilter": { - "$ref": "#/definitions/TopBottomFilter" - } - }, - "type": "object" - }, - "FilterControl": { - "additionalProperties": false, - "properties": { - "CrossSheet": { - "$ref": "#/definitions/FilterCrossSheetControl" - }, - "DateTimePicker": { - "$ref": "#/definitions/FilterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/FilterDropDownControl" - }, - "List": { - "$ref": "#/definitions/FilterListControl" - }, - "RelativeDateTime": { - "$ref": "#/definitions/FilterRelativeDateTimeControl" - }, - "Slider": { - "$ref": "#/definitions/FilterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/FilterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/FilterTextFieldControl" - } - }, - "type": "object" - }, - "FilterCrossSheetControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId" - ], - "type": "object" - }, - "FilterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterGroup": { - "additionalProperties": false, - "properties": { - "CrossDataset": { - "$ref": "#/definitions/CrossDatasetTypes" - }, - "FilterGroupId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Filters": { - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "ScopeConfiguration": { - "$ref": "#/definitions/FilterScopeConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "CrossDataset", - "FilterGroupId", - "Filters", - "ScopeConfiguration" - ], - "type": "object" - }, - "FilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator" - ], - "type": "object" - }, - "FilterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterNullOption": { - "enum": [ - "ALL_VALUES", - "NULLS_ONLY", - "NON_NULLS_ONLY" - ], - "type": "string" - }, - "FilterOperationSelectedFieldsConfiguration": { - "additionalProperties": false, - "properties": { - "SelectedColumns": { - "description": "

The selected columns of a dataset.

", - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "$ref": "#/definitions/SelectedFieldOptions" - }, - "SelectedFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "FilterOperationTargetVisualsConfiguration": { - "additionalProperties": false, - "properties": { - "SameSheetTargetVisualConfiguration": { - "$ref": "#/definitions/SameSheetTargetVisualConfiguration" - } - }, - "type": "object" - }, - "FilterRelativeDateTimeControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "AllSheets": { - "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" - }, - "SelectedSheets": { - "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" - } - }, - "type": "object" - }, - "FilterSelectableValues": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "FilterControlId", - "MaximumValue", - "MinimumValue", - "SourceFilterId", - "StepSize", - "Title" - ], - "type": "object" - }, - "FilterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterVisualScope": { - "enum": [ - "ALL_VISUALS", - "SELECTED_VISUALS" - ], - "type": "string" - }, - "FontConfiguration": { - "additionalProperties": false, - "properties": { - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontDecoration": { - "$ref": "#/definitions/FontDecoration" - }, - "FontSize": { - "$ref": "#/definitions/FontSize" - }, - "FontStyle": { - "$ref": "#/definitions/FontStyle" - }, - "FontWeight": { - "$ref": "#/definitions/FontWeight" - } - }, - "type": "object" - }, - "FontDecoration": { - "enum": [ - "UNDERLINE", - "NONE" - ], - "type": "string" - }, - "FontSize": { - "additionalProperties": false, - "properties": { - "Relative": { - "$ref": "#/definitions/RelativeFontSize" - } - }, - "type": "object" - }, - "FontStyle": { - "enum": [ - "NORMAL", - "ITALIC" - ], - "type": "string" - }, - "FontWeight": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/FontWeightName" - } - }, - "type": "object" - }, - "FontWeightName": { - "enum": [ - "NORMAL", - "BOLD" - ], - "type": "string" - }, - "ForecastComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "CustomSeasonalityValue": { - "default": null, - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "LowerBoundary": { - "default": null, - "type": "number" - }, - "Name": { - "type": "string" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "$ref": "#/definitions/ForecastComputationSeasonality" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "UpperBoundary": { - "default": null, - "type": "number" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ForecastComputationSeasonality": { - "enum": [ - "AUTOMATIC", - "CUSTOM" - ], - "type": "string" - }, - "ForecastConfiguration": { - "additionalProperties": false, - "properties": { - "ForecastProperties": { - "$ref": "#/definitions/TimeBasedForecastProperties" - }, - "Scenario": { - "$ref": "#/definitions/ForecastScenario" - } - }, - "type": "object" - }, - "ForecastScenario": { - "additionalProperties": false, - "properties": { - "WhatIfPointScenario": { - "$ref": "#/definitions/WhatIfPointScenario" - }, - "WhatIfRangeScenario": { - "$ref": "#/definitions/WhatIfRangeScenario" - } - }, - "type": "object" - }, - "FormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "NumberFormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "StringFormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "type": "object" - }, - "FreeFormLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "FreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FreeFormLayoutElement": { - "additionalProperties": false, - "properties": { - "BackgroundStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" - }, - "BorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "LoadingAnimation": { - "$ref": "#/definitions/LoadingAnimation" - }, - "RenderingRules": { - "items": { - "$ref": "#/definitions/SheetElementRenderingRule" - }, - "maxItems": 10000, - "minItems": 0, - "type": "array" - }, - "SelectedBorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "XAxisLocation": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "YAxisLocation": { - "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", - "type": "string" - } - }, - "required": [ - "ElementId", - "ElementType", - "Height", - "Width", - "XAxisLocation", - "YAxisLocation" - ], - "type": "object" - }, - "FreeFormLayoutElementBackgroundStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutElementBorderStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "OptimizedViewPortWidth" - ], - "type": "object" - }, - "FreeFormSectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FunnelChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabelOptions": { - "$ref": "#/definitions/FunnelChartDataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/FunnelChartFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/FunnelChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "FunnelChartDataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureDataLabelStyle": { - "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FunnelChartFieldWells": { - "additionalProperties": false, - "properties": { - "FunnelChartAggregatedFieldWells": { - "$ref": "#/definitions/FunnelChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "FunnelChartMeasureDataLabelStyle": { - "enum": [ - "VALUE_ONLY", - "PERCENTAGE_BY_FIRST_STAGE", - "PERCENTAGE_BY_PREVIOUS_STAGE", - "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", - "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" - ], - "type": "string" - }, - "FunnelChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FunnelChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GaugeChartArcConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/GaugeChartConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/GaugeChartArcConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" - } - }, - "type": "object" - }, - "GaugeChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/GaugeChartFieldWells" - }, - "GaugeChartOptions": { - "$ref": "#/definitions/GaugeChartOptions" - }, - "TooltipOptions": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "GaugeChartFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartOptions": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/ArcConfiguration" - }, - "ArcAxis": { - "$ref": "#/definitions/ArcAxisConfiguration" - }, - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "GaugeChartPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GaugeChartConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/GaugeChartConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialCoordinateBounds": { - "additionalProperties": false, - "properties": { - "East": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - }, - "North": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "South": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "West": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - } - }, - "required": [ - "East", - "North", - "South", - "West" - ], - "type": "object" - }, - "GeospatialHeatmapColorScale": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/GeospatialHeatmapDataColor" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialHeatmapConfiguration": { - "additionalProperties": false, - "properties": { - "HeatmapColor": { - "$ref": "#/definitions/GeospatialHeatmapColorScale" - } - }, - "type": "object" - }, - "GeospatialHeatmapDataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "GeospatialMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/GeospatialMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "PointStyleOptions": { - "$ref": "#/definitions/GeospatialPointStyleOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "GeospatialMapFieldWells": { - "additionalProperties": false, - "properties": { - "GeospatialMapAggregatedFieldWells": { - "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "GeospatialMapStyleOptions": { - "additionalProperties": false, - "properties": { - "BaseMapStyle": { - "$ref": "#/definitions/BaseMapStyleType" - } - }, - "type": "object" - }, - "GeospatialMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GeospatialMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialPointStyleOptions": { - "additionalProperties": false, - "properties": { - "ClusterMarkerConfiguration": { - "$ref": "#/definitions/ClusterMarkerConfiguration" - }, - "HeatmapConfiguration": { - "$ref": "#/definitions/GeospatialHeatmapConfiguration" - }, - "SelectedPointStyle": { - "$ref": "#/definitions/GeospatialSelectedPointStyle" - } - }, - "type": "object" - }, - "GeospatialSelectedPointStyle": { - "enum": [ - "POINT", - "CLUSTER", - "HEATMAP" - ], - "type": "string" - }, - "GeospatialWindowOptions": { - "additionalProperties": false, - "properties": { - "Bounds": { - "$ref": "#/definitions/GeospatialCoordinateBounds" - }, - "MapZoomMode": { - "$ref": "#/definitions/MapZoomMode" - } - }, - "type": "object" - }, - "GlobalTableBorderOptions": { - "additionalProperties": false, - "properties": { - "SideSpecificBorder": { - "$ref": "#/definitions/TableSideBorderOptions" - }, - "UniformBorder": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "GradientColor": { - "additionalProperties": false, - "properties": { - "Stops": { - "items": { - "$ref": "#/definitions/GradientStop" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GradientStop": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - }, - "GradientOffset": { - "default": 0, - "type": "number" - } - }, - "required": [ - "GradientOffset" - ], - "type": "object" - }, - "GridLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "GridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/GridLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "GridLayoutElement": { - "additionalProperties": false, - "properties": { - "ColumnIndex": { - "maximum": 35, - "minimum": 0, - "type": "number" - }, - "ColumnSpan": { - "maximum": 36, - "minimum": 1, - "type": "number" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "RowIndex": { - "maximum": 9009, - "minimum": 0, - "type": "number" - }, - "RowSpan": { - "maximum": 21, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "ColumnSpan", - "ElementId", - "ElementType", - "RowSpan" - ], - "type": "object" - }, - "GridLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "ResizeOption": { - "$ref": "#/definitions/ResizeOption" - } - }, - "required": [ - "ResizeOption" - ], - "type": "object" - }, - "GrowthRateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodSize": { - "default": 0, - "maximum": 52, - "minimum": 2, - "type": "number" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "HeaderFooterSectionConfiguration": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Layout", - "SectionId" - ], - "type": "object" - }, - "HeatMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "ColumnLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HeatMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "RowLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/HeatMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "HeatMapFieldWells": { - "additionalProperties": false, - "properties": { - "HeatMapAggregatedFieldWells": { - "$ref": "#/definitions/HeatMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "HeatMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "HeatMapColumnItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapColumnSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "HeatMapRowItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapRowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HeatMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HistogramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HistogramBinOptions": { - "additionalProperties": false, - "properties": { - "BinCount": { - "$ref": "#/definitions/BinCountOptions" - }, - "BinWidth": { - "$ref": "#/definitions/BinWidthOptions" - }, - "SelectedBinType": { - "$ref": "#/definitions/HistogramBinType" - }, - "StartValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "HistogramBinType": { - "enum": [ - "BIN_COUNT", - "BIN_WIDTH" - ], - "type": "string" - }, - "HistogramConfiguration": { - "additionalProperties": false, - "properties": { - "BinOptions": { - "$ref": "#/definitions/HistogramBinOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HistogramFieldWells" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - } - }, - "type": "object" - }, - "HistogramFieldWells": { - "additionalProperties": false, - "properties": { - "HistogramAggregatedFieldWells": { - "$ref": "#/definitions/HistogramAggregatedFieldWells" - } - }, - "type": "object" - }, - "HistogramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HistogramConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HorizontalTextAlignment": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT", - "AUTO" - ], - "type": "string" - }, - "Icon": { - "enum": [ - "CARET_UP", - "CARET_DOWN", - "PLUS", - "MINUS", - "ARROW_UP", - "ARROW_DOWN", - "ARROW_LEFT", - "ARROW_UP_LEFT", - "ARROW_DOWN_LEFT", - "ARROW_RIGHT", - "ARROW_UP_RIGHT", - "ARROW_DOWN_RIGHT", - "FACE_UP", - "FACE_DOWN", - "FACE_FLAT", - "ONE_BAR", - "TWO_BAR", - "THREE_BAR", - "CIRCLE", - "TRIANGLE", - "SQUARE", - "FLAG", - "THUMBS_UP", - "THUMBS_DOWN", - "CHECKMARK", - "X" - ], - "type": "string" - }, - "InsightConfiguration": { - "additionalProperties": false, - "properties": { - "Computations": { - "items": { - "$ref": "#/definitions/Computation" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "CustomNarrative": { - "$ref": "#/definitions/CustomNarrativeOptions" - } - }, - "type": "object" - }, - "InsightVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "InsightConfiguration": { - "$ref": "#/definitions/InsightConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "IntegerDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "IntegerParameter": { - "additionalProperties": false, - "description": "

An integer parameter.

", - "properties": { - "Name": { - "description": "

The name of the integer parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values for the integer parameter.

", - "items": { - "default": 0, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "IntegerParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/IntegerDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "IntegerValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "ItemsLimitConfiguration": { - "additionalProperties": false, - "properties": { - "ItemsLimit": { - "default": null, - "type": "number" - }, - "OtherCategories": { - "$ref": "#/definitions/OtherCategories" - } - }, - "type": "object" - }, - "KPIActualValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIComparisonValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/KPIConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "ActualValue": { - "$ref": "#/definitions/KPIActualValueConditionalFormatting" - }, - "ComparisonValue": { - "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" - }, - "ProgressBar": { - "$ref": "#/definitions/KPIProgressBarConditionalFormatting" - } - }, - "type": "object" - }, - "KPIConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/KPIFieldWells" - }, - "KPIOptions": { - "$ref": "#/definitions/KPIOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/KPISortConfiguration" - } - }, - "type": "object" - }, - "KPIFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrendGroups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIOptions": { - "additionalProperties": false, - "properties": { - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "ProgressBar": { - "$ref": "#/definitions/ProgressBarOptions" - }, - "SecondaryValue": { - "$ref": "#/definitions/SecondaryValueOptions" - }, - "SecondaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Sparkline": { - "$ref": "#/definitions/KPISparklineOptions" - }, - "TrendArrows": { - "$ref": "#/definitions/TrendArrowOptions" - }, - "VisualLayoutOptions": { - "$ref": "#/definitions/KPIVisualLayoutOptions" - } - }, - "type": "object" - }, - "KPIPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIProgressBarConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPISortConfiguration": { - "additionalProperties": false, - "properties": { - "TrendGroupSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPISparklineOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Type": { - "$ref": "#/definitions/KPISparklineType" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPISparklineType": { - "enum": [ - "LINE", - "AREA" - ], - "type": "string" - }, - "KPIVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/KPIConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/KPIConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "KPIVisualLayoutOptions": { - "additionalProperties": false, - "properties": { - "StandardLayout": { - "$ref": "#/definitions/KPIVisualStandardLayout" - } - }, - "type": "object" - }, - "KPIVisualStandardLayout": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/KPIVisualStandardLayoutType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPIVisualStandardLayoutType": { - "enum": [ - "CLASSIC", - "VERTICAL" - ], - "type": "string" - }, - "LabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "Layout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/LayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "LayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormLayoutConfiguration" - }, - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - }, - "SectionBasedLayout": { - "$ref": "#/definitions/SectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "LayoutElementType": { - "enum": [ - "VISUAL", - "FILTER_CONTROL", - "PARAMETER_CONTROL", - "TEXT_BOX" - ], - "type": "string" - }, - "LegendOptions": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Position": { - "$ref": "#/definitions/LegendPosition" - }, - "Title": { - "$ref": "#/definitions/LabelOptions" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LegendPosition": { - "enum": [ - "AUTO", - "RIGHT", - "BOTTOM", - "TOP" - ], - "type": "string" - }, - "LineChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartConfiguration": { - "additionalProperties": false, - "properties": { - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DefaultSeriesSettings": { - "$ref": "#/definitions/LineChartDefaultSeriesSettings" - }, - "FieldWells": { - "$ref": "#/definitions/LineChartFieldWells" - }, - "ForecastConfigurations": { - "items": { - "$ref": "#/definitions/ForecastConfiguration" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Series": { - "items": { - "$ref": "#/definitions/SeriesItem" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/LineChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "Type": { - "$ref": "#/definitions/LineChartType" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "LineChartDefaultSeriesSettings": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartFieldWells": { - "additionalProperties": false, - "properties": { - "LineChartAggregatedFieldWells": { - "$ref": "#/definitions/LineChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "LineChartLineStyle": { - "enum": [ - "SOLID", - "DOTTED", - "DASHED" - ], - "type": "string" - }, - "LineChartLineStyleSettings": { - "additionalProperties": false, - "properties": { - "LineInterpolation": { - "$ref": "#/definitions/LineInterpolation" - }, - "LineStyle": { - "$ref": "#/definitions/LineChartLineStyle" - }, - "LineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LineWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LineChartMarkerShape": { - "enum": [ - "CIRCLE", - "TRIANGLE", - "SQUARE", - "DIAMOND", - "ROUNDED_SQUARE" - ], - "type": "string" - }, - "LineChartMarkerStyleSettings": { - "additionalProperties": false, - "properties": { - "MarkerColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "MarkerShape": { - "$ref": "#/definitions/LineChartMarkerShape" - }, - "MarkerSize": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MarkerVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LineChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartType": { - "enum": [ - "LINE", - "AREA", - "STACKED_AREA" - ], - "type": "string" - }, - "LineChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/LineChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "LineInterpolation": { - "enum": [ - "LINEAR", - "SMOOTH", - "STEPPED" - ], - "type": "string" - }, - "LineSeriesAxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "MissingDataConfigurations": { - "items": { - "$ref": "#/definitions/MissingDataConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LinkSharingConfiguration": { - "additionalProperties": false, - "properties": { - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "ListControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SearchOptions": { - "$ref": "#/definitions/ListControlSearchOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "ListControlSearchOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ListControlSelectAllOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LoadingAnimation": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LocalNavigationConfiguration": { - "additionalProperties": false, - "properties": { - "TargetSheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "TargetSheetId" - ], - "type": "object" - }, - "LongFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "MapZoomMode": { - "enum": [ - "AUTO", - "MANUAL" - ], - "type": "string" - }, - "MappedDataSetParameter": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DataSetParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "DataSetParameterName" - ], - "type": "object" - }, - "MaximumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MaximumMinimumComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/MaximumMinimumComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "MaximumMinimumComputationType": { - "enum": [ - "MAXIMUM", - "MINIMUM" - ], - "type": "string" - }, - "MeasureField": { - "additionalProperties": false, - "properties": { - "CalculatedMeasureField": { - "$ref": "#/definitions/CalculatedMeasureField" - }, - "CategoricalMeasureField": { - "$ref": "#/definitions/CategoricalMeasureField" - }, - "DateMeasureField": { - "$ref": "#/definitions/DateMeasureField" - }, - "NumericalMeasureField": { - "$ref": "#/definitions/NumericalMeasureField" - } - }, - "type": "object" - }, - "MetricComparisonComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "FromValue": { - "$ref": "#/definitions/MeasureField" - }, - "Name": { - "type": "string" - }, - "TargetValue": { - "$ref": "#/definitions/MeasureField" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "MinimumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MissingDataConfiguration": { - "additionalProperties": false, - "properties": { - "TreatmentOption": { - "$ref": "#/definitions/MissingDataTreatmentOption" - } - }, - "type": "object" - }, - "MissingDataTreatmentOption": { - "enum": [ - "INTERPOLATE", - "SHOW_AS_ZERO", - "SHOW_AS_BLANK" - ], - "type": "string" - }, - "NegativeValueConfiguration": { - "additionalProperties": false, - "properties": { - "DisplayMode": { - "$ref": "#/definitions/NegativeValueDisplayMode" - } - }, - "required": [ - "DisplayMode" - ], - "type": "object" - }, - "NegativeValueDisplayMode": { - "enum": [ - "POSITIVE", - "NEGATIVE" - ], - "type": "string" - }, - "NullValueFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullString": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "NullString" - ], - "type": "object" - }, - "NumberDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "NumberFormatConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "NumberScale": { - "enum": [ - "NONE", - "AUTO", - "THOUSANDS", - "MILLIONS", - "BILLIONS", - "TRILLIONS" - ], - "type": "string" - }, - "NumericAxisOptions": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/AxisDisplayRange" - }, - "Scale": { - "$ref": "#/definitions/AxisScale" - } - }, - "type": "object" - }, - "NumericEqualityDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Column", - "Value" - ], - "type": "object" - }, - "NumericEqualityFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/NumericEqualityMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - }, - "Value": { - "default": null, - "type": "number" - } - }, - "required": [ - "Column", - "FilterId", - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "NumericEqualityMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL" - ], - "type": "string" - }, - "NumericFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "NumericFormatConfiguration": { - "additionalProperties": false, - "properties": { - "CurrencyDisplayFormatConfiguration": { - "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" - }, - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "NumericRangeFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "RangeMinimum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "NumericRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StaticValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "NumericSeparatorConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalSeparator": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "ThousandsSeparator": { - "$ref": "#/definitions/ThousandSeparatorOptions" - } - }, - "type": "object" - }, - "NumericSeparatorSymbol": { - "enum": [ - "COMMA", - "DOT", - "SPACE" - ], - "type": "string" - }, - "NumericalAggregationFunction": { - "additionalProperties": false, - "properties": { - "PercentileAggregation": { - "$ref": "#/definitions/PercentileAggregation" - }, - "SimpleNumericalAggregation": { - "$ref": "#/definitions/SimpleNumericalAggregationFunction" - } - }, - "type": "object" - }, - "NumericalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "NumericalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "OtherCategories": { - "enum": [ - "INCLUDE", - "EXCLUDE" - ], - "type": "string" - }, - "PaginationConfiguration": { - "additionalProperties": false, - "properties": { - "PageNumber": { - "minimum": 0, - "type": "number" - }, - "PageSize": { - "default": null, - "type": "number" - } - }, - "required": [ - "PageNumber", - "PageSize" - ], - "type": "object" - }, - "PanelBorderStyle": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "PanelConfiguration": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BackgroundVisibility": { - "$ref": "#/definitions/Visibility" - }, - "BorderColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BorderStyle": { - "$ref": "#/definitions/PanelBorderStyle" - }, - "BorderThickness": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "BorderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "GutterSpacing": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "GutterVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Title": { - "$ref": "#/definitions/PanelTitleOptions" - } - }, - "type": "object" - }, - "PanelTitleOptions": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PaperOrientation": { - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "PaperSize": { - "enum": [ - "US_LETTER", - "US_LEGAL", - "US_TABLOID_LEDGER", - "A0", - "A1", - "A2", - "A3", - "A4", - "A5", - "JIS_B4", - "JIS_B5" - ], - "type": "string" - }, - "ParameterControl": { - "additionalProperties": false, - "properties": { - "DateTimePicker": { - "$ref": "#/definitions/ParameterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/ParameterDropDownControl" - }, - "List": { - "$ref": "#/definitions/ParameterListControl" - }, - "Slider": { - "$ref": "#/definitions/ParameterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/ParameterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/ParameterTextFieldControl" - } - }, - "type": "object" - }, - "ParameterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DateTimeParameterDeclaration": { - "$ref": "#/definitions/DateTimeParameterDeclaration" - }, - "DecimalParameterDeclaration": { - "$ref": "#/definitions/DecimalParameterDeclaration" - }, - "IntegerParameterDeclaration": { - "$ref": "#/definitions/IntegerParameterDeclaration" - }, - "StringParameterDeclaration": { - "$ref": "#/definitions/StringParameterDeclaration" - } - }, - "type": "object" - }, - "ParameterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterSelectableValues": { - "additionalProperties": false, - "properties": { - "LinkToDataSetColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ParameterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "ParameterControlId", - "SourceParameterName", - "StepSize", - "Title" - ], - "type": "object" - }, - "ParameterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterValueType": { - "enum": [ - "MULTI_VALUED", - "SINGLE_VALUED" - ], - "type": "string" - }, - "Parameters": { - "additionalProperties": false, - "description": "

A list of Amazon QuickSight parameters and the list's override values.

", - "properties": { - "DateTimeParameters": { - "description": "

The parameters that have a data type of date-time.

", - "items": { - "$ref": "#/definitions/DateTimeParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "DecimalParameters": { - "description": "

The parameters that have a data type of decimal.

", - "items": { - "$ref": "#/definitions/DecimalParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "IntegerParameters": { - "description": "

The parameters that have a data type of integer.

", - "items": { - "$ref": "#/definitions/IntegerParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "StringParameters": { - "description": "

The parameters that have a data type of string.

", - "items": { - "$ref": "#/definitions/StringParameter" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PercentVisibleRange": { - "additionalProperties": false, - "properties": { - "From": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "To": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PercentageDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PercentileAggregation": { - "additionalProperties": false, - "properties": { - "PercentileValue": { - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PeriodOverPeriodComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PeriodToDateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodTimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PieChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DonutOptions": { - "$ref": "#/definitions/DonutOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PieChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PieChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "PieChartFieldWells": { - "additionalProperties": false, - "properties": { - "PieChartAggregatedFieldWells": { - "$ref": "#/definitions/PieChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "PieChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PieChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotFieldSortOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SortBy": { - "$ref": "#/definitions/PivotTableSortBy" - } - }, - "required": [ - "FieldId", - "SortBy" - ], - "type": "object" - }, - "PivotTableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Scope": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "Scopes": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/PivotTableCellConditionalFormatting" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScope": { - "additionalProperties": false, - "properties": { - "Role": { - "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScopeRole": { - "enum": [ - "FIELD", - "FIELD_TOTAL", - "GRAND_TOTAL" - ], - "type": "string" - }, - "PivotTableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/PivotTableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PivotTableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/PivotTablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PivotTableSortConfiguration" - }, - "TableOptions": { - "$ref": "#/definitions/PivotTableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/PivotTableTotalOptions" - } - }, - "type": "object" - }, - "PivotTableDataPathOption": { - "additionalProperties": false, - "properties": { - "DataPathList": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "DataPathList" - ], - "type": "object" - }, - "PivotTableDataPathType": { - "enum": [ - "HIERARCHY_ROWS_LAYOUT_COLUMN", - "MULTIPLE_ROW_METRICS_COLUMN", - "EMPTY_COLUMN_HEADER", - "COUNT_METRIC_COLUMN" - ], - "type": "string" - }, - "PivotTableFieldCollapseState": { - "enum": [ - "COLLAPSED", - "EXPANDED" - ], - "type": "string" - }, - "PivotTableFieldCollapseStateOption": { - "additionalProperties": false, - "properties": { - "State": { - "$ref": "#/definitions/PivotTableFieldCollapseState" - }, - "Target": { - "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "PivotTableFieldCollapseStateTarget": { - "additionalProperties": false, - "properties": { - "FieldDataPathValues": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "FieldId": { - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableFieldOptions": { - "additionalProperties": false, - "properties": { - "CollapseStateOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldCollapseStateOption" - }, - "type": "array" - }, - "DataPathOptions": { - "items": { - "$ref": "#/definitions/PivotTableDataPathOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableFieldSubtotalOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldWells": { - "additionalProperties": false, - "properties": { - "PivotTableAggregatedFieldWells": { - "$ref": "#/definitions/PivotTableAggregatedFieldWells" - } - }, - "type": "object" - }, - "PivotTableMetricPlacement": { - "enum": [ - "ROW", - "COLUMN" - ], - "type": "string" - }, - "PivotTableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "CollapsedRowDimensionsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ColumnHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "ColumnNamesVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DefaultCellWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MetricPlacement": { - "$ref": "#/definitions/PivotTableMetricPlacement" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - }, - "RowFieldNamesStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowsLabelOptions": { - "$ref": "#/definitions/PivotTableRowsLabelOptions" - }, - "RowsLayout": { - "$ref": "#/definitions/PivotTableRowsLayout" - }, - "SingleMetricVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ToggleButtonsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLayout": { - "enum": [ - "TABULAR", - "HIERARCHY" - ], - "type": "string" - }, - "PivotTableSortBy": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnSort" - }, - "DataPath": { - "$ref": "#/definitions/DataPathSort" - }, - "Field": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "PivotTableSortConfiguration": { - "additionalProperties": false, - "properties": { - "FieldSortOptions": { - "items": { - "$ref": "#/definitions/PivotFieldSortOptions" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableSubtotalLevel": { - "enum": [ - "ALL", - "CUSTOM", - "LAST" - ], - "type": "string" - }, - "PivotTableTotalOptions": { - "additionalProperties": false, - "properties": { - "ColumnSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "ColumnTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - }, - "RowSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "RowTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - } - }, - "type": "object" - }, - "PivotTableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PivotTableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/PivotTableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotTotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "PredefinedHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "PrimaryValueDisplayType": { - "enum": [ - "HIDDEN", - "COMPARISON", - "ACTUAL" - ], - "type": "string" - }, - "ProgressBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Color": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartAreaStyleSettings": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAxesRangeScale": { - "enum": [ - "AUTO", - "INDEPENDENT", - "SHARED" - ], - "type": "string" - }, - "RadarChartConfiguration": { - "additionalProperties": false, - "properties": { - "AlternateBandColorsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AlternateBandEvenColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AlternateBandOddColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AxesRangeScale": { - "$ref": "#/definitions/RadarChartAxesRangeScale" - }, - "BaseSeriesSettings": { - "$ref": "#/definitions/RadarChartSeriesSettings" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/RadarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Shape": { - "$ref": "#/definitions/RadarChartShape" - }, - "SortConfiguration": { - "$ref": "#/definitions/RadarChartSortConfiguration" - }, - "StartAngle": { - "maximum": 360, - "minimum": -360, - "type": "number" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "RadarChartFieldWells": { - "additionalProperties": false, - "properties": { - "RadarChartAggregatedFieldWells": { - "$ref": "#/definitions/RadarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "RadarChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "AreaStyleSettings": { - "$ref": "#/definitions/RadarChartAreaStyleSettings" - } - }, - "type": "object" - }, - "RadarChartShape": { - "enum": [ - "CIRCLE", - "POLYGON" - ], - "type": "string" - }, - "RadarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/RadarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "RangeEndsLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ReferenceLine": { - "additionalProperties": false, - "properties": { - "DataConfiguration": { - "$ref": "#/definitions/ReferenceLineDataConfiguration" - }, - "LabelConfiguration": { - "$ref": "#/definitions/ReferenceLineLabelConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "StyleConfiguration": { - "$ref": "#/definitions/ReferenceLineStyleConfiguration" - } - }, - "required": [ - "DataConfiguration" - ], - "type": "object" - }, - "ReferenceLineCustomLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "CustomLabel" - ], - "type": "object" - }, - "ReferenceLineDataConfiguration": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "DynamicConfiguration": { - "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" - }, - "SeriesType": { - "$ref": "#/definitions/ReferenceLineSeriesType" - }, - "StaticConfiguration": { - "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" - } - }, - "type": "object" - }, - "ReferenceLineDynamicDataConfiguration": { - "additionalProperties": false, - "properties": { - "Calculation": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "MeasureAggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - } - }, - "required": [ - "Calculation", - "Column" - ], - "type": "object" - }, - "ReferenceLineLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" - }, - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalPosition": { - "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" - }, - "ValueLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" - }, - "VerticalPosition": { - "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" - } - }, - "type": "object" - }, - "ReferenceLineLabelHorizontalPosition": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT" - ], - "type": "string" - }, - "ReferenceLineLabelVerticalPosition": { - "enum": [ - "ABOVE", - "BELOW" - ], - "type": "string" - }, - "ReferenceLinePatternType": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "ReferenceLineSeriesType": { - "enum": [ - "BAR", - "LINE" - ], - "type": "string" - }, - "ReferenceLineStaticDataConfiguration": { - "additionalProperties": false, - "properties": { - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "ReferenceLineStyleConfiguration": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Pattern": { - "$ref": "#/definitions/ReferenceLinePatternType" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - }, - "RelativePosition": { - "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelRelativePosition": { - "enum": [ - "BEFORE_CUSTOM_LABEL", - "AFTER_CUSTOM_LABEL" - ], - "type": "string" - }, - "RelativeDateTimeControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "RelativeDateType": { - "enum": [ - "PREVIOUS", - "THIS", - "LAST", - "NOW", - "NEXT" - ], - "type": "string" - }, - "RelativeDatesFilter": { - "additionalProperties": false, - "properties": { - "AnchorDateConfiguration": { - "$ref": "#/definitions/AnchorDateConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MinimumGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RelativeDateType": { - "$ref": "#/definitions/RelativeDateType" - }, - "RelativeDateValue": { - "default": null, - "type": "number" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AnchorDateConfiguration", - "Column", - "FilterId", - "NullOption", - "RelativeDateType", - "TimeGranularity" - ], - "type": "object" - }, - "RelativeFontSize": { - "enum": [ - "EXTRA_SMALL", - "SMALL", - "MEDIUM", - "LARGE", - "EXTRA_LARGE" - ], - "type": "string" - }, - "ResizeOption": { - "enum": [ - "FIXED", - "RESPONSIVE" - ], - "type": "string" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "ResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETED" - ], - "type": "string" - }, - "RollingDateConfiguration": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "RowAlternateColorOptions": { - "additionalProperties": false, - "properties": { - "RowAlternateColors": { - "items": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "UsePrimaryBackgroundColor": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "type": "object" - }, - "SameSheetTargetVisualConfiguration": { - "additionalProperties": false, - "properties": { - "TargetVisualOptions": { - "$ref": "#/definitions/TargetVisualOptions" - }, - "TargetVisuals": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Destination": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Source": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Weight": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/SankeyDiagramFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/SankeyDiagramSortConfiguration" - } - }, - "type": "object" - }, - "SankeyDiagramFieldWells": { - "additionalProperties": false, - "properties": { - "SankeyDiagramAggregatedFieldWells": { - "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" - } - }, - "type": "object" - }, - "SankeyDiagramSortConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SourceItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "WeightSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/SankeyDiagramChartConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScatterPlotCategoricallyAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ScatterPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "YAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "ScatterPlotFieldWells": { - "additionalProperties": false, - "properties": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" - }, - "ScatterPlotUnaggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "ScatterPlotUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ScatterPlotConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScrollBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "VisibleRange": { - "$ref": "#/definitions/VisibleRangeOptions" - } - }, - "type": "object" - }, - "SecondaryValueOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SectionAfterPageBreak": { - "additionalProperties": false, - "properties": { - "Status": { - "$ref": "#/definitions/SectionPageBreakStatus" - } - }, - "type": "object" - }, - "SectionBasedLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperCanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" - } - }, - "type": "object" - }, - "SectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "BodySections": { - "items": { - "$ref": "#/definitions/BodySectionConfiguration" - }, - "maxItems": 28, - "minItems": 0, - "type": "array" - }, - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - }, - "FooterSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "HeaderSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "BodySections", - "CanvasSizeOptions", - "FooterSections", - "HeaderSections" - ], - "type": "object" - }, - "SectionBasedLayoutPaperCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperMargin": { - "$ref": "#/definitions/Spacing" - }, - "PaperOrientation": { - "$ref": "#/definitions/PaperOrientation" - }, - "PaperSize": { - "$ref": "#/definitions/PaperSize" - } - }, - "type": "object" - }, - "SectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" - } - }, - "required": [ - "FreeFormLayout" - ], - "type": "object" - }, - "SectionPageBreakConfiguration": { - "additionalProperties": false, - "properties": { - "After": { - "$ref": "#/definitions/SectionAfterPageBreak" - } - }, - "type": "object" - }, - "SectionPageBreakStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "SectionStyle": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Padding": { - "$ref": "#/definitions/Spacing" - } - }, - "type": "object" - }, - "SelectAllValueOptions": { - "enum": [ - "ALL_VALUES" - ], - "type": "string" - }, - "SelectedFieldOptions": { - "enum": [ - "ALL_FIELDS" - ], - "type": "string" - }, - "SelectedSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "SheetVisualScopingConfigurations": { - "items": { - "$ref": "#/definitions/SheetVisualScopingConfiguration" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SelectedTooltipType": { - "enum": [ - "BASIC", - "DETAILED" - ], - "type": "string" - }, - "SeriesItem": { - "additionalProperties": false, - "properties": { - "DataFieldSeriesItem": { - "$ref": "#/definitions/DataFieldSeriesItem" - }, - "FieldSeriesItem": { - "$ref": "#/definitions/FieldSeriesItem" - } - }, - "type": "object" - }, - "SetParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/DestinationParameterValueConfiguration" - } - }, - "required": [ - "DestinationParameterName", - "Value" - ], - "type": "object" - }, - "ShapeConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "required": [ - "BackgroundColor" - ], - "type": "object" - }, - "Sheet": { - "additionalProperties": false, - "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", - "properties": { - "Name": { - "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "SheetId": { - "description": "

The unique identifier associated with a sheet.

", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "type": "object" - }, - "SheetContentType": { - "enum": [ - "PAGINATED", - "INTERACTIVE" - ], - "type": "string" - }, - "SheetControlDateTimePickerType": { - "enum": [ - "SINGLE_VALUED", - "DATE_RANGE" - ], - "type": "string" - }, - "SheetControlInfoIconLabelOptions": { - "additionalProperties": false, - "properties": { - "InfoIconText": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetControlLayout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/SheetControlLayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "SheetControlLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - } - }, - "type": "object" - }, - "SheetControlListType": { - "enum": [ - "MULTI_SELECT", - "SINGLE_SELECT" - ], - "type": "string" - }, - "SheetControlSliderType": { - "enum": [ - "SINGLE_POINT", - "RANGE" - ], - "type": "string" - }, - "SheetControlsOption": { - "additionalProperties": false, - "description": "

Sheet controls option.

", - "properties": { - "VisibilityState": { - "$ref": "#/definitions/DashboardUIState" - } - }, - "type": "object" - }, - "SheetDefinition": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/SheetContentType" - }, - "Description": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "FilterControls": { - "items": { - "$ref": "#/definitions/FilterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Layouts": { - "items": { - "$ref": "#/definitions/Layout" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ParameterControls": { - "items": { - "$ref": "#/definitions/ParameterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SheetControlLayouts": { - "items": { - "$ref": "#/definitions/SheetControlLayout" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "TextBoxes": { - "items": { - "$ref": "#/definitions/SheetTextBox" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Title": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visuals": { - "items": { - "$ref": "#/definitions/Visual" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "SheetId" - ], - "type": "object" - }, - "SheetElementConfigurationOverrides": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetElementRenderingRule": { - "additionalProperties": false, - "properties": { - "ConfigurationOverrides": { - "$ref": "#/definitions/SheetElementConfigurationOverrides" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConfigurationOverrides", - "Expression" - ], - "type": "object" - }, - "SheetLayoutElementMaximizationOption": { - "additionalProperties": false, - "description": "

The sheet layout maximization options of a dashbaord.

", - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "SheetTextBox": { - "additionalProperties": false, - "properties": { - "Content": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - }, - "SheetTextBoxId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "SheetTextBoxId" - ], - "type": "object" - }, - "SheetVisualScopingConfiguration": { - "additionalProperties": false, - "properties": { - "Scope": { - "$ref": "#/definitions/FilterVisualScope" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "VisualIds": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Scope", - "SheetId" - ], - "type": "object" - }, - "ShortFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SimpleAttributeAggregationFunction": { - "enum": [ - "UNIQUE_VALUE" - ], - "type": "string" - }, - "SimpleClusterMarker": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "SimpleNumericalAggregationFunction": { - "enum": [ - "SUM", - "AVERAGE", - "MIN", - "MAX", - "COUNT", - "DISTINCT_COUNT", - "VAR", - "VARP", - "STDEV", - "STDEVP", - "MEDIAN" - ], - "type": "string" - }, - "SimpleTotalAggregationFunction": { - "enum": [ - "DEFAULT", - "SUM", - "AVERAGE", - "MIN", - "MAX", - "NONE" - ], - "type": "string" - }, - "SliderControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "SmallMultiplesAxisPlacement": { - "enum": [ - "OUTSIDE", - "INSIDE" - ], - "type": "string" - }, - "SmallMultiplesAxisProperties": { - "additionalProperties": false, - "properties": { - "Placement": { - "$ref": "#/definitions/SmallMultiplesAxisPlacement" - }, - "Scale": { - "$ref": "#/definitions/SmallMultiplesAxisScale" - } - }, - "type": "object" - }, - "SmallMultiplesAxisScale": { - "enum": [ - "SHARED", - "INDEPENDENT" - ], - "type": "string" - }, - "SmallMultiplesOptions": { - "additionalProperties": false, - "properties": { - "MaxVisibleColumns": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "MaxVisibleRows": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "PanelConfiguration": { - "$ref": "#/definitions/PanelConfiguration" - }, - "XAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - }, - "YAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - } - }, - "type": "object" - }, - "SortDirection": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "Spacing": { - "additionalProperties": false, - "properties": { - "Bottom": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Left": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Right": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Top": { - "description": "String based length that is composed of value and unit", - "type": "string" - } - }, - "type": "object" - }, - "SpecialValue": { - "enum": [ - "EMPTY", - "NULL", - "OTHER" - ], - "type": "string" - }, - "StringDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "StringFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "StringParameter": { - "additionalProperties": false, - "description": "

A string parameter.

", - "properties": { - "Name": { - "description": "

A display name for a string parameter.

", - "pattern": "\\S", - "type": "string" - }, - "Values": { - "description": "

The values of a string parameter.

", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "StringParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/StringDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/StringValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "StringValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "StyledCellType": { - "enum": [ - "TOTAL", - "METRIC_HEADER", - "VALUE" - ], - "type": "string" - }, - "SubtotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FieldLevel": { - "$ref": "#/definitions/PivotTableSubtotalLevel" - }, - "FieldLevelOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldSubtotalOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "StyleTargets": { - "items": { - "$ref": "#/definitions/TableStyleTarget" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "TableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableBorderOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/TableBorderStyle" - }, - "Thickness": { - "maximum": 4, - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "TableBorderStyle": { - "enum": [ - "NONE", - "SOLID" - ], - "type": "string" - }, - "TableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableCellImageScalingConfiguration": { - "enum": [ - "FIT_TO_CELL_HEIGHT", - "FIT_TO_CELL_WIDTH", - "DO_NOT_SCALE" - ], - "type": "string" - }, - "TableCellImageSizingConfiguration": { - "additionalProperties": false, - "properties": { - "TableCellImageScalingConfiguration": { - "$ref": "#/definitions/TableCellImageScalingConfiguration" - } - }, - "type": "object" - }, - "TableCellStyle": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Border": { - "$ref": "#/definitions/GlobalTableBorderOptions" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Height": { - "maximum": 500, - "minimum": 8, - "type": "number" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "TextWrap": { - "$ref": "#/definitions/TextWrap" - }, - "VerticalTextAlignment": { - "$ref": "#/definitions/VerticalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/TableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/TableCellConditionalFormatting" - }, - "Row": { - "$ref": "#/definitions/TableRowConditionalFormatting" - } - }, - "type": "object" - }, - "TableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/TableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/TablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TableSortConfiguration" - }, - "TableInlineVisualizations": { - "items": { - "$ref": "#/definitions/TableInlineVisualization" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TableOptions": { - "$ref": "#/definitions/TableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/TotalOptions" - } - }, - "type": "object" - }, - "TableFieldCustomIconContent": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/TableFieldIconSetType" - } - }, - "type": "object" - }, - "TableFieldCustomTextContent": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "FontConfiguration" - ], - "type": "object" - }, - "TableFieldIconSetType": { - "enum": [ - "LINK" - ], - "type": "string" - }, - "TableFieldImageConfiguration": { - "additionalProperties": false, - "properties": { - "SizingOptions": { - "$ref": "#/definitions/TableCellImageSizingConfiguration" - } - }, - "type": "object" - }, - "TableFieldLinkConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/TableFieldLinkContentConfiguration" - }, - "Target": { - "$ref": "#/definitions/URLTargetConfiguration" - } - }, - "required": [ - "Content", - "Target" - ], - "type": "object" - }, - "TableFieldLinkContentConfiguration": { - "additionalProperties": false, - "properties": { - "CustomIconContent": { - "$ref": "#/definitions/TableFieldCustomIconContent" - }, - "CustomTextContent": { - "$ref": "#/definitions/TableFieldCustomTextContent" - } - }, - "type": "object" - }, - "TableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "URLStyling": { - "$ref": "#/definitions/TableFieldURLConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableFieldOptions": { - "additionalProperties": false, - "properties": { - "Order": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "PinnedFieldOptions": { - "$ref": "#/definitions/TablePinnedFieldOptions" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/TableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableFieldURLConfiguration": { - "additionalProperties": false, - "properties": { - "ImageConfiguration": { - "$ref": "#/definitions/TableFieldImageConfiguration" - }, - "LinkConfiguration": { - "$ref": "#/definitions/TableFieldLinkConfiguration" - } - }, - "type": "object" - }, - "TableFieldWells": { - "additionalProperties": false, - "properties": { - "TableAggregatedFieldWells": { - "$ref": "#/definitions/TableAggregatedFieldWells" - }, - "TableUnaggregatedFieldWells": { - "$ref": "#/definitions/TableUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "TableInlineVisualization": { - "additionalProperties": false, - "properties": { - "DataBars": { - "$ref": "#/definitions/DataBarsOptions" - } - }, - "type": "object" - }, - "TableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "HeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Orientation": { - "$ref": "#/definitions/TableOrientation" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - } - }, - "type": "object" - }, - "TableOrientation": { - "enum": [ - "VERTICAL", - "HORIZONTAL" - ], - "type": "string" - }, - "TablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TablePinnedFieldOptions": { - "additionalProperties": false, - "properties": { - "PinnedLeftFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 201, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableRowConditionalFormatting": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TableSideBorderOptions": { - "additionalProperties": false, - "properties": { - "Bottom": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerHorizontal": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerVertical": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Left": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Right": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Top": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "TableSortConfiguration": { - "additionalProperties": false, - "properties": { - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - }, - "RowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableStyleTarget": { - "additionalProperties": false, - "properties": { - "CellType": { - "$ref": "#/definitions/StyledCellType" - } - }, - "required": [ - "CellType" - ], - "type": "object" - }, - "TableTotalsPlacement": { - "enum": [ - "START", - "END", - "AUTO" - ], - "type": "string" - }, - "TableTotalsScrollStatus": { - "enum": [ - "PINNED", - "SCROLLED" - ], - "type": "string" - }, - "TableUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/UnaggregatedField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/TableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TargetVisualOptions": { - "enum": [ - "ALL_VISUALS" - ], - "type": "string" - }, - "TextAreaControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TextControlPlaceholderOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TextFieldControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextWrap": { - "enum": [ - "NONE", - "WRAP" - ], - "type": "string" - }, - "ThousandSeparatorOptions": { - "additionalProperties": false, - "properties": { - "Symbol": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TimeBasedForecastProperties": { - "additionalProperties": false, - "properties": { - "LowerBoundary": { - "default": null, - "type": "number" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "UpperBoundary": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "TimeEqualityFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Value": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "Column", - "FilterId" - ], - "type": "object" - }, - "TimeGranularity": { - "enum": [ - "YEAR", - "QUARTER", - "MONTH", - "WEEK", - "DAY", - "HOUR", - "MINUTE", - "SECOND", - "MILLISECOND" - ], - "type": "string" - }, - "TimeRangeDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "RangeMaximum": { - "format": "date-time", - "type": "string" - }, - "RangeMinimum": { - "format": "date-time", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "RangeMaximum", - "RangeMinimum", - "TimeGranularity" - ], - "type": "object" - }, - "TimeRangeFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "RangeMinimumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "TimeRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValue": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "TooltipItem": { - "additionalProperties": false, - "properties": { - "ColumnTooltipItem": { - "$ref": "#/definitions/ColumnTooltipItem" - }, - "FieldTooltipItem": { - "$ref": "#/definitions/FieldTooltipItem" - } - }, - "type": "object" - }, - "TooltipOptions": { - "additionalProperties": false, - "properties": { - "FieldBasedTooltip": { - "$ref": "#/definitions/FieldBasedTooltip" - }, - "SelectedTooltipType": { - "$ref": "#/definitions/SelectedTooltipType" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TooltipTitleType": { - "enum": [ - "NONE", - "PRIMARY_VALUE" - ], - "type": "string" - }, - "TopBottomComputationType": { - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "TopBottomFilter": { - "additionalProperties": false, - "properties": { - "AggregationSortConfigurations": { - "items": { - "$ref": "#/definitions/AggregationSortConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Limit": { - "default": null, - "type": "number" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AggregationSortConfigurations", - "Column", - "FilterId" - ], - "type": "object" - }, - "TopBottomMoversComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MoverSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Name": { - "type": "string" - }, - "SortOrder": { - "$ref": "#/definitions/TopBottomSortOrder" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomRankedComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResultSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomSortOrder": { - "enum": [ - "PERCENT_DIFFERENCE", - "ABSOLUTE_DIFFERENCE" - ], - "type": "string" - }, - "TotalAggregationComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "TotalAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleTotalAggregationFunction": { - "$ref": "#/definitions/SimpleTotalAggregationFunction" - } - }, - "type": "object" - }, - "TotalAggregationOption": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TotalAggregationFunction": { - "$ref": "#/definitions/TotalAggregationFunction" - } - }, - "required": [ - "FieldId", - "TotalAggregationFunction" - ], - "type": "object" - }, - "TotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TreeMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Groups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Sizes": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TreeMapFieldWells" - }, - "GroupLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SizeLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TreeMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "TreeMapFieldWells": { - "additionalProperties": false, - "properties": { - "TreeMapAggregatedFieldWells": { - "$ref": "#/definitions/TreeMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "TreeMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "TreeMapGroupItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "TreeMapSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TreeMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "TrendArrowOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "URLTargetConfiguration": { - "enum": [ - "NEW_TAB", - "NEW_WINDOW", - "SAME_TAB" - ], - "type": "string" - }, - "UnaggregatedField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "UniqueValuesComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ValidationStrategy": { - "additionalProperties": false, - "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", - "properties": { - "Mode": { - "$ref": "#/definitions/ValidationStrategyMode" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "ValidationStrategyMode": { - "enum": [ - "STRICT", - "LENIENT" - ], - "type": "string" - }, - "ValueWhenUnsetOption": { - "enum": [ - "RECOMMENDED_VALUE", - "NULL" - ], - "type": "string" - }, - "VerticalTextAlignment": { - "enum": [ - "TOP", - "MIDDLE", - "BOTTOM", - "AUTO" - ], - "type": "string" - }, - "Visibility": { - "enum": [ - "HIDDEN", - "VISIBLE" - ], - "type": "string" - }, - "VisibleRangeOptions": { - "additionalProperties": false, - "properties": { - "PercentRange": { - "$ref": "#/definitions/PercentVisibleRange" - } - }, - "type": "object" - }, - "Visual": { - "additionalProperties": false, - "properties": { - "BarChartVisual": { - "$ref": "#/definitions/BarChartVisual" - }, - "BoxPlotVisual": { - "$ref": "#/definitions/BoxPlotVisual" - }, - "ComboChartVisual": { - "$ref": "#/definitions/ComboChartVisual" - }, - "CustomContentVisual": { - "$ref": "#/definitions/CustomContentVisual" - }, - "EmptyVisual": { - "$ref": "#/definitions/EmptyVisual" - }, - "FilledMapVisual": { - "$ref": "#/definitions/FilledMapVisual" - }, - "FunnelChartVisual": { - "$ref": "#/definitions/FunnelChartVisual" - }, - "GaugeChartVisual": { - "$ref": "#/definitions/GaugeChartVisual" - }, - "GeospatialMapVisual": { - "$ref": "#/definitions/GeospatialMapVisual" - }, - "HeatMapVisual": { - "$ref": "#/definitions/HeatMapVisual" - }, - "HistogramVisual": { - "$ref": "#/definitions/HistogramVisual" - }, - "InsightVisual": { - "$ref": "#/definitions/InsightVisual" - }, - "KPIVisual": { - "$ref": "#/definitions/KPIVisual" - }, - "LineChartVisual": { - "$ref": "#/definitions/LineChartVisual" - }, - "PieChartVisual": { - "$ref": "#/definitions/PieChartVisual" - }, - "PivotTableVisual": { - "$ref": "#/definitions/PivotTableVisual" - }, - "RadarChartVisual": { - "$ref": "#/definitions/RadarChartVisual" - }, - "SankeyDiagramVisual": { - "$ref": "#/definitions/SankeyDiagramVisual" - }, - "ScatterPlotVisual": { - "$ref": "#/definitions/ScatterPlotVisual" - }, - "TableVisual": { - "$ref": "#/definitions/TableVisual" - }, - "TreeMapVisual": { - "$ref": "#/definitions/TreeMapVisual" - }, - "WaterfallVisual": { - "$ref": "#/definitions/WaterfallVisual" - }, - "WordCloudVisual": { - "$ref": "#/definitions/WordCloudVisual" - } - }, - "type": "object" - }, - "VisualAxisSortOption": { - "additionalProperties": false, - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "VisualCustomAction": { - "additionalProperties": false, - "properties": { - "ActionOperations": { - "items": { - "$ref": "#/definitions/VisualCustomActionOperation" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - }, - "CustomActionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "Trigger": { - "$ref": "#/definitions/VisualCustomActionTrigger" - } - }, - "required": [ - "ActionOperations", - "CustomActionId", - "Name", - "Trigger" - ], - "type": "object" - }, - "VisualCustomActionOperation": { - "additionalProperties": false, - "properties": { - "FilterOperation": { - "$ref": "#/definitions/CustomActionFilterOperation" - }, - "NavigationOperation": { - "$ref": "#/definitions/CustomActionNavigationOperation" - }, - "SetParametersOperation": { - "$ref": "#/definitions/CustomActionSetParametersOperation" - }, - "URLOperation": { - "$ref": "#/definitions/CustomActionURLOperation" - } - }, - "type": "object" - }, - "VisualCustomActionTrigger": { - "enum": [ - "DATA_POINT_CLICK", - "DATA_POINT_MENU" - ], - "type": "string" - }, - "VisualMenuOption": { - "additionalProperties": false, - "properties": { - "AvailabilityStatus": { - "$ref": "#/definitions/DashboardBehavior" - } - }, - "type": "object" - }, - "VisualPalette": { - "additionalProperties": false, - "properties": { - "ChartColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "ColorMap": { - "items": { - "$ref": "#/definitions/DataPathColor" - }, - "maxItems": 5000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "VisualSubtitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/LongFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "VisualTitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/ShortFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "WaterfallChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Breakdowns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Categories": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallChartColorConfiguration": { - "additionalProperties": false, - "properties": { - "GroupColorConfiguration": { - "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" - } - }, - "type": "object" - }, - "WaterfallChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorConfiguration": { - "$ref": "#/definitions/WaterfallChartColorConfiguration" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WaterfallChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/WaterfallChartSortConfiguration" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WaterfallChartOptions": { - "$ref": "#/definitions/WaterfallChartOptions" - } - }, - "type": "object" - }, - "WaterfallChartFieldWells": { - "additionalProperties": false, - "properties": { - "WaterfallChartAggregatedFieldWells": { - "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "WaterfallChartGroupColorConfiguration": { - "additionalProperties": false, - "properties": { - "NegativeBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TotalBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartOptions": { - "additionalProperties": false, - "properties": { - "TotalBarLabel": { - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "BreakdownItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WaterfallChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WhatIfPointScenario": { - "additionalProperties": false, - "properties": { - "Date": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Date", - "Value" - ], - "type": "object" - }, - "WhatIfRangeScenario": { - "additionalProperties": false, - "properties": { - "EndDate": { - "format": "date-time", - "type": "string" - }, - "StartDate": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "EndDate", - "StartDate", - "Value" - ], - "type": "object" - }, - "WidgetStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "WordCloudAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WordCloudFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/WordCloudSortConfiguration" - }, - "WordCloudOptions": { - "$ref": "#/definitions/WordCloudOptions" - } - }, - "type": "object" - }, - "WordCloudCloudLayout": { - "enum": [ - "FLUID", - "NORMAL" - ], - "type": "string" - }, - "WordCloudFieldWells": { - "additionalProperties": false, - "properties": { - "WordCloudAggregatedFieldWells": { - "$ref": "#/definitions/WordCloudAggregatedFieldWells" - } - }, - "type": "object" - }, - "WordCloudOptions": { - "additionalProperties": false, - "properties": { - "CloudLayout": { - "$ref": "#/definitions/WordCloudCloudLayout" - }, - "MaximumStringLength": { - "maximum": 100, - "minimum": 1, - "type": "number" - }, - "WordCasing": { - "$ref": "#/definitions/WordCloudWordCasing" - }, - "WordOrientation": { - "$ref": "#/definitions/WordCloudWordOrientation" - }, - "WordPadding": { - "$ref": "#/definitions/WordCloudWordPadding" - }, - "WordScaling": { - "$ref": "#/definitions/WordCloudWordScaling" - } - }, - "type": "object" - }, - "WordCloudSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WordCloudChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WordCloudWordCasing": { - "enum": [ - "LOWER_CASE", - "EXISTING_CASE" - ], - "type": "string" - }, - "WordCloudWordOrientation": { - "enum": [ - "HORIZONTAL", - "HORIZONTAL_AND_VERTICAL" - ], - "type": "string" - }, - "WordCloudWordPadding": { - "enum": [ - "NONE", - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "WordCloudWordScaling": { - "enum": [ - "EMPHASIZE", - "NORMAL" - ], - "type": "string" - } - }, - "description": "Definition of the AWS::QuickSight::Dashboard Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:DescribeDashboard", - "quicksight:DescribeDashboardPermissions", - "quicksight:CreateDashboard", - "quicksight:DescribeTemplate", - "quicksight:DescribeTheme", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeDashboard", - "quicksight:DeleteDashboard" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AwsAccountId": { - "$ref": "resource-schema.json#/properties/AwsAccountId" - } - }, - "required": [ - "AwsAccountId" - ] - }, - "permissions": [ - "quicksight:ListDashboards" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeDashboard", - "quicksight:DescribeDashboardPermissions", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeDashboard", - "quicksight:DescribeDashboardPermissions", - "quicksight:UpdateDashboard", - "quicksight:UpdateDashboardLinks", - "quicksight:UpdateDashboardPermissions", - "quicksight:UpdateDashboardPublishedVersion", - "quicksight:DescribeTemplate", - "quicksight:DescribeTheme", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/DashboardId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "CreatedTime": { - "description": "

The time that this dashboard was created.

", - "format": "date-time", - "type": "string" - }, - "DashboardId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "DashboardPublishOptions": { - "$ref": "#/definitions/DashboardPublishOptions" - }, - "Definition": { - "$ref": "#/definitions/DashboardVersionDefinition" - }, - "LastPublishedTime": { - "description": "

The last time that this dashboard was published.

", - "format": "date-time", - "type": "string" - }, - "LastUpdatedTime": { - "description": "

The last time that this dashboard was updated.

", - "format": "date-time", - "type": "string" - }, - "LinkEntities": { - "items": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "LinkSharingConfiguration": { - "$ref": "#/definitions/LinkSharingConfiguration" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/Parameters" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/DashboardSourceEntity" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "ThemeArn": { - "type": "string" - }, - "ValidationStrategy": { - "$ref": "#/definitions/ValidationStrategy" - }, - "Version": { - "$ref": "#/definitions/DashboardVersion" - }, - "VersionDescription": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastPublishedTime", - "/properties/LastUpdatedTime", - "/properties/Version" - ], - "required": [ - "AwsAccountId", - "DashboardId", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "typeName": "AWS::QuickSight::Dashboard", - "writeOnlyProperties": [ - "/properties/DashboardPublishOptions", - "/properties/Definition", - "/properties/LinkSharingConfiguration", - "/properties/Parameters", - "/properties/SourceEntity", - "/properties/ThemeArn", - "/properties/VersionDescription", - "/properties/ValidationStrategy" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/DashboardId" + ], + "definitions": { + "AdHocFilteringOption": { + "additionalProperties": false, + "description": "

An ad hoc (one-time) filtering option.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "AggregationFunction": { + "additionalProperties": false, + "properties": { + "AttributeAggregationFunction": { + "$ref": "#/definitions/AttributeAggregationFunction" + }, + "CategoricalAggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "DateAggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "NumericalAggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + } + }, + "type": "object" + }, + "AggregationSortConfiguration": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SortDirection": { + "$ref": "#/definitions/SortDirection" + } + }, + "required": [ + "Column", + "SortDirection" + ], + "type": "object" + }, + "AllSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "AnalysisDefaults": { + "additionalProperties": false, + "properties": { + "DefaultNewSheetConfiguration": { + "$ref": "#/definitions/DefaultNewSheetConfiguration" + } + }, + "required": [ + "DefaultNewSheetConfiguration" + ], + "type": "object" + }, + "AnchorDateConfiguration": { + "additionalProperties": false, + "properties": { + "AnchorOption": { + "$ref": "#/definitions/AnchorOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "type": "object" + }, + "AnchorOption": { + "enum": [ + "NOW" + ], + "type": "string" + }, + "ArcAxisConfiguration": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/ArcAxisDisplayRange" + }, + "ReserveRange": { + "default": 0, + "type": "number" + } + }, + "type": "object" + }, + "ArcAxisDisplayRange": { + "additionalProperties": false, + "properties": { + "Max": { + "default": null, + "type": "number" + }, + "Min": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "ArcConfiguration": { + "additionalProperties": false, + "properties": { + "ArcAngle": { + "default": null, + "type": "number" + }, + "ArcThickness": { + "$ref": "#/definitions/ArcThicknessOptions" + } + }, + "type": "object" + }, + "ArcOptions": { + "additionalProperties": false, + "properties": { + "ArcThickness": { + "$ref": "#/definitions/ArcThickness" + } + }, + "type": "object" + }, + "ArcThickness": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE", + "WHOLE" + ], + "type": "string" + }, + "ArcThicknessOptions": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "AssetOptions": { + "additionalProperties": false, + "properties": { + "Timezone": { + "type": "string" + }, + "WeekStart": { + "$ref": "#/definitions/DayOfTheWeek" + } + }, + "type": "object" + }, + "AttributeAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleAttributeAggregation": { + "$ref": "#/definitions/SimpleAttributeAggregationFunction" + }, + "ValueForMultipleValues": { + "type": "string" + } + }, + "type": "object" + }, + "AxisBinding": { + "enum": [ + "PRIMARY_YAXIS", + "SECONDARY_YAXIS" + ], + "type": "string" + }, + "AxisDataOptions": { + "additionalProperties": false, + "properties": { + "DateAxisOptions": { + "$ref": "#/definitions/DateAxisOptions" + }, + "NumericAxisOptions": { + "$ref": "#/definitions/NumericAxisOptions" + } + }, + "type": "object" + }, + "AxisDisplayDataDrivenRange": { + "additionalProperties": false, + "type": "object" + }, + "AxisDisplayMinMaxRange": { + "additionalProperties": false, + "properties": { + "Maximum": { + "default": null, + "type": "number" + }, + "Minimum": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AxisOffset": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "DataOptions": { + "$ref": "#/definitions/AxisDataOptions" + }, + "GridLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ScrollbarOptions": { + "$ref": "#/definitions/ScrollBarOptions" + }, + "TickLabelOptions": { + "$ref": "#/definitions/AxisTickLabelOptions" + } + }, + "type": "object" + }, + "AxisDisplayRange": { + "additionalProperties": false, + "properties": { + "DataDriven": { + "$ref": "#/definitions/AxisDisplayDataDrivenRange" + }, + "MinMax": { + "$ref": "#/definitions/AxisDisplayMinMaxRange" + } + }, + "type": "object" + }, + "AxisLabelOptions": { + "additionalProperties": false, + "properties": { + "ApplyTo": { + "$ref": "#/definitions/AxisLabelReferenceOptions" + }, + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "AxisLabelReferenceOptions": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "AxisLinearScale": { + "additionalProperties": false, + "properties": { + "StepCount": { + "default": null, + "type": "number" + }, + "StepSize": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisLogarithmicScale": { + "additionalProperties": false, + "properties": { + "Base": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisScale": { + "additionalProperties": false, + "properties": { + "Linear": { + "$ref": "#/definitions/AxisLinearScale" + }, + "Logarithmic": { + "$ref": "#/definitions/AxisLogarithmicScale" + } + }, + "type": "object" + }, + "AxisTickLabelOptions": { + "additionalProperties": false, + "properties": { + "LabelOptions": { + "$ref": "#/definitions/LabelOptions" + }, + "RotationAngle": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "BarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Orientation": { + "$ref": "#/definitions/BarChartOrientation" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/BarChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BarChartFieldWells": { + "additionalProperties": false, + "properties": { + "BarChartAggregatedFieldWells": { + "$ref": "#/definitions/BarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "BarChartOrientation": { + "enum": [ + "HORIZONTAL", + "VERTICAL" + ], + "type": "string" + }, + "BarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "BarsArrangement": { + "enum": [ + "CLUSTERED", + "STACKED", + "STACKED_PERCENT" + ], + "type": "string" + }, + "BaseMapStyleType": { + "enum": [ + "LIGHT_GRAY", + "DARK_GRAY", + "STREET", + "IMAGERY" + ], + "type": "string" + }, + "BinCountOptions": { + "additionalProperties": false, + "properties": { + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BinWidthOptions": { + "additionalProperties": false, + "properties": { + "BinCountLimit": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BodySectionConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/BodySectionContent" + }, + "PageBreakConfiguration": { + "$ref": "#/definitions/SectionPageBreakConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Content", + "SectionId" + ], + "type": "object" + }, + "BodySectionContent": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + } + }, + "type": "object" + }, + "BoxPlotAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BoxPlotChartConfiguration": { + "additionalProperties": false, + "properties": { + "BoxPlotOptions": { + "$ref": "#/definitions/BoxPlotOptions" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BoxPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SortConfiguration": { + "$ref": "#/definitions/BoxPlotSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BoxPlotFieldWells": { + "additionalProperties": false, + "properties": { + "BoxPlotAggregatedFieldWells": { + "$ref": "#/definitions/BoxPlotAggregatedFieldWells" + } + }, + "type": "object" + }, + "BoxPlotFillStyle": { + "enum": [ + "SOLID", + "TRANSPARENT" + ], + "type": "string" + }, + "BoxPlotOptions": { + "additionalProperties": false, + "properties": { + "AllDataPointsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "OutlierVisibility": { + "$ref": "#/definitions/Visibility" + }, + "StyleOptions": { + "$ref": "#/definitions/BoxPlotStyleOptions" + } + }, + "type": "object" + }, + "BoxPlotSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + } + }, + "type": "object" + }, + "BoxPlotStyleOptions": { + "additionalProperties": false, + "properties": { + "FillStyle": { + "$ref": "#/definitions/BoxPlotFillStyle" + } + }, + "type": "object" + }, + "BoxPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BoxPlotChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "CalculatedField": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 32000, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "Expression", + "Name" + ], + "type": "object" + }, + "CalculatedMeasureField": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression", + "FieldId" + ], + "type": "object" + }, + "CascadingControlConfiguration": { + "additionalProperties": false, + "properties": { + "SourceControls": { + "items": { + "$ref": "#/definitions/CascadingControlSource" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CascadingControlSource": { + "additionalProperties": false, + "properties": { + "ColumnToMatch": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceSheetControlId": { + "type": "string" + } + }, + "type": "object" + }, + "CategoricalAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT" + ], + "type": "string" + }, + "CategoricalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoricalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoryDrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "CategoryValues", + "Column" + ], + "type": "object" + }, + "CategoryFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "Column", + "Configuration", + "FilterId" + ], + "type": "object" + }, + "CategoryFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CustomFilterConfiguration": { + "$ref": "#/definitions/CustomFilterConfiguration" + }, + "CustomFilterListConfiguration": { + "$ref": "#/definitions/CustomFilterListConfiguration" + }, + "FilterListConfiguration": { + "$ref": "#/definitions/FilterListConfiguration" + } + }, + "type": "object" + }, + "CategoryFilterMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL", + "CONTAINS", + "DOES_NOT_CONTAIN", + "STARTS_WITH", + "ENDS_WITH" + ], + "type": "string" + }, + "CategoryFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "CategoryInnerFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + } + }, + "required": [ + "Column", + "Configuration" + ], + "type": "object" + }, + "ChartAxisLabelOptions": { + "additionalProperties": false, + "properties": { + "AxisLabelOptions": { + "items": { + "$ref": "#/definitions/AxisLabelOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SortIconVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ClusterMarker": { + "additionalProperties": false, + "properties": { + "SimpleClusterMarker": { + "$ref": "#/definitions/SimpleClusterMarker" + } + }, + "type": "object" + }, + "ClusterMarkerConfiguration": { + "additionalProperties": false, + "properties": { + "ClusterMarker": { + "$ref": "#/definitions/ClusterMarker" + } + }, + "type": "object" + }, + "ColorFillType": { + "enum": [ + "DISCRETE", + "GRADIENT" + ], + "type": "string" + }, + "ColorScale": { + "additionalProperties": false, + "properties": { + "ColorFillType": { + "$ref": "#/definitions/ColorFillType" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DataColor" + }, + "maxItems": 3, + "minItems": 2, + "type": "array" + }, + "NullValueColor": { + "$ref": "#/definitions/DataColor" + } + }, + "required": [ + "ColorFillType", + "Colors" + ], + "type": "object" + }, + "ColorsConfiguration": { + "additionalProperties": false, + "properties": { + "CustomColors": { + "items": { + "$ref": "#/definitions/CustomColor" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ColumnConfiguration": { + "additionalProperties": false, + "properties": { + "ColorsConfiguration": { + "$ref": "#/definitions/ColorsConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + }, + "Role": { + "$ref": "#/definitions/ColumnRole" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ColumnHierarchy": { + "additionalProperties": false, + "properties": { + "DateTimeHierarchy": { + "$ref": "#/definitions/DateTimeHierarchy" + }, + "ExplicitHierarchy": { + "$ref": "#/definitions/ExplicitHierarchy" + }, + "PredefinedHierarchy": { + "$ref": "#/definitions/PredefinedHierarchy" + } + }, + "type": "object" + }, + "ColumnIdentifier": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ColumnName", + "DataSetIdentifier" + ], + "type": "object" + }, + "ColumnRole": { + "enum": [ + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "ColumnSort": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortBy": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "Direction", + "SortBy" + ], + "type": "object" + }, + "ColumnTooltipItem": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ComboChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "BarValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "LineValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ComboChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "LineDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/ComboChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "ComboChartFieldWells": { + "additionalProperties": false, + "properties": { + "ComboChartAggregatedFieldWells": { + "$ref": "#/definitions/ComboChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "ComboChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ComboChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ComparisonConfiguration": { + "additionalProperties": false, + "properties": { + "ComparisonFormat": { + "$ref": "#/definitions/ComparisonFormatConfiguration" + }, + "ComparisonMethod": { + "$ref": "#/definitions/ComparisonMethod" + } + }, + "type": "object" + }, + "ComparisonFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "ComparisonMethod": { + "enum": [ + "DIFFERENCE", + "PERCENT_DIFFERENCE", + "PERCENT" + ], + "type": "string" + }, + "Computation": { + "additionalProperties": false, + "properties": { + "Forecast": { + "$ref": "#/definitions/ForecastComputation" + }, + "GrowthRate": { + "$ref": "#/definitions/GrowthRateComputation" + }, + "MaximumMinimum": { + "$ref": "#/definitions/MaximumMinimumComputation" + }, + "MetricComparison": { + "$ref": "#/definitions/MetricComparisonComputation" + }, + "PeriodOverPeriod": { + "$ref": "#/definitions/PeriodOverPeriodComputation" + }, + "PeriodToDate": { + "$ref": "#/definitions/PeriodToDateComputation" + }, + "TopBottomMovers": { + "$ref": "#/definitions/TopBottomMoversComputation" + }, + "TopBottomRanked": { + "$ref": "#/definitions/TopBottomRankedComputation" + }, + "TotalAggregation": { + "$ref": "#/definitions/TotalAggregationComputation" + }, + "UniqueValues": { + "$ref": "#/definitions/UniqueValuesComputation" + } + }, + "type": "object" + }, + "ConditionalFormattingColor": { + "additionalProperties": false, + "properties": { + "Gradient": { + "$ref": "#/definitions/ConditionalFormattingGradientColor" + }, + "Solid": { + "$ref": "#/definitions/ConditionalFormattingSolidColor" + } + }, + "type": "object" + }, + "ConditionalFormattingCustomIconCondition": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DisplayConfiguration": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconOptions": { + "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" + } + }, + "required": [ + "Expression", + "IconOptions" + ], + "type": "object" + }, + "ConditionalFormattingCustomIconOptions": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/Icon" + }, + "UnicodeIcon": { + "pattern": "^[^\\u0000-\\u00FF]$", + "type": "string" + } + }, + "type": "object" + }, + "ConditionalFormattingGradientColor": { + "additionalProperties": false, + "properties": { + "Color": { + "$ref": "#/definitions/GradientColor" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Color", + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIcon": { + "additionalProperties": false, + "properties": { + "CustomCondition": { + "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" + }, + "IconSet": { + "$ref": "#/definitions/ConditionalFormattingIconSet" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayConfiguration": { + "additionalProperties": false, + "properties": { + "IconDisplayOption": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayOption": { + "enum": [ + "ICON_ONLY" + ], + "type": "string" + }, + "ConditionalFormattingIconSet": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconSetType": { + "$ref": "#/definitions/ConditionalFormattingIconSetType" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIconSetType": { + "enum": [ + "PLUS_MINUS", + "CHECK_X", + "THREE_COLOR_ARROW", + "THREE_GRAY_ARROW", + "CARET_UP_MINUS_DOWN", + "THREE_SHAPE", + "THREE_CIRCLE", + "FLAGS", + "BARS", + "FOUR_COLOR_ARROW", + "FOUR_GRAY_ARROW" + ], + "type": "string" + }, + "ConditionalFormattingSolidColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ContributionAnalysisDefault": { + "additionalProperties": false, + "properties": { + "ContributorDimensions": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "MeasureFieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ContributorDimensions", + "MeasureFieldId" + ], + "type": "object" + }, + "CrossDatasetTypes": { + "enum": [ + "ALL_DATASETS", + "SINGLE_DATASET" + ], + "type": "string" + }, + "CurrencyDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Symbol": { + "pattern": "^[A-Z]{3}$", + "type": "string" + } + }, + "type": "object" + }, + "CustomActionFilterOperation": { + "additionalProperties": false, + "properties": { + "SelectedFieldsConfiguration": { + "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" + }, + "TargetVisualsConfiguration": { + "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" + } + }, + "required": [ + "SelectedFieldsConfiguration", + "TargetVisualsConfiguration" + ], + "type": "object" + }, + "CustomActionNavigationOperation": { + "additionalProperties": false, + "properties": { + "LocalNavigationConfiguration": { + "$ref": "#/definitions/LocalNavigationConfiguration" + } + }, + "type": "object" + }, + "CustomActionSetParametersOperation": { + "additionalProperties": false, + "properties": { + "ParameterValueConfigurations": { + "items": { + "$ref": "#/definitions/SetParameterValueConfiguration" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ParameterValueConfigurations" + ], + "type": "object" + }, + "CustomActionURLOperation": { + "additionalProperties": false, + "properties": { + "URLTarget": { + "$ref": "#/definitions/URLTargetConfiguration" + }, + "URLTemplate": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "URLTarget", + "URLTemplate" + ], + "type": "object" + }, + "CustomColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "SpecialValue": { + "$ref": "#/definitions/SpecialValue" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "CustomContentConfiguration": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/CustomContentType" + }, + "ContentUrl": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ImageScaling": { + "$ref": "#/definitions/CustomContentImageScalingConfiguration" + } + }, + "type": "object" + }, + "CustomContentImageScalingConfiguration": { + "enum": [ + "FIT_TO_HEIGHT", + "FIT_TO_WIDTH", + "DO_NOT_SCALE", + "SCALE_TO_VISUAL" + ], + "type": "string" + }, + "CustomContentType": { + "enum": [ + "IMAGE", + "OTHER_EMBEDDED_CONTENT" + ], + "type": "string" + }, + "CustomContentVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/CustomContentConfiguration" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "CustomFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValue": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomFilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomNarrativeOptions": { + "additionalProperties": false, + "properties": { + "Narrative": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Narrative" + ], + "type": "object" + }, + "CustomParameterValues": { + "additionalProperties": false, + "properties": { + "DateTimeValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "DecimalValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "IntegerValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "StringValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CustomValuesConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValues": { + "$ref": "#/definitions/CustomParameterValues" + }, + "IncludeNullValue": { + "type": "boolean" + } + }, + "required": [ + "CustomValues" + ], + "type": "object" + }, + "DashboardBehavior": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "DashboardError": { + "additionalProperties": false, + "description": "

Dashboard error.

", + "properties": { + "Message": { + "description": "

Message.

", + "pattern": "\\S", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/DashboardErrorType" + }, + "ViolatedEntities": { + "description": "

Lists the violated entities that caused the dashboard error.

", + "items": { + "$ref": "#/definitions/Entity" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DashboardErrorType": { + "enum": [ + "ACCESS_DENIED", + "SOURCE_NOT_FOUND", + "DATA_SET_NOT_FOUND", + "INTERNAL_FAILURE", + "PARAMETER_VALUE_INCOMPATIBLE", + "PARAMETER_TYPE_INVALID", + "PARAMETER_NOT_FOUND", + "COLUMN_TYPE_MISMATCH", + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", + "COLUMN_REPLACEMENT_MISSING" + ], + "type": "string" + }, + "DashboardPublishOptions": { + "additionalProperties": false, + "description": "

Dashboard publish options.

", + "properties": { + "AdHocFilteringOption": { + "$ref": "#/definitions/AdHocFilteringOption" + }, + "DataPointDrillUpDownOption": { + "$ref": "#/definitions/DataPointDrillUpDownOption" + }, + "DataPointMenuLabelOption": { + "$ref": "#/definitions/DataPointMenuLabelOption" + }, + "DataPointTooltipOption": { + "$ref": "#/definitions/DataPointTooltipOption" + }, + "ExportToCSVOption": { + "$ref": "#/definitions/ExportToCSVOption" + }, + "ExportWithHiddenFieldsOption": { + "$ref": "#/definitions/ExportWithHiddenFieldsOption" + }, + "SheetControlsOption": { + "$ref": "#/definitions/SheetControlsOption" + }, + "SheetLayoutElementMaximizationOption": { + "$ref": "#/definitions/SheetLayoutElementMaximizationOption" + }, + "VisualAxisSortOption": { + "$ref": "#/definitions/VisualAxisSortOption" + }, + "VisualMenuOption": { + "$ref": "#/definitions/VisualMenuOption" + }, + "VisualPublishOptions": { + "$ref": "#/definitions/DashboardVisualPublishOptions" + } + }, + "type": "object" + }, + "DashboardSourceEntity": { + "additionalProperties": false, + "description": "

Dashboard source entity.

", + "properties": { + "SourceTemplate": { + "$ref": "#/definitions/DashboardSourceTemplate" + } + }, + "type": "object" + }, + "DashboardSourceTemplate": { + "additionalProperties": false, + "description": "

Dashboard source template.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "DataSetReferences": { + "description": "

Dataset references.

", + "items": { + "$ref": "#/definitions/DataSetReference" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Arn", + "DataSetReferences" + ], + "type": "object" + }, + "DashboardUIState": { + "enum": [ + "EXPANDED", + "COLLAPSED" + ], + "type": "string" + }, + "DashboardVersion": { + "additionalProperties": false, + "description": "

Dashboard version.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "CreatedTime": { + "description": "

The time that this dashboard version was created.

", + "format": "date-time", + "type": "string" + }, + "DataSetArns": { + "description": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

", + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Description": { + "description": "

Description.

", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Errors": { + "description": "

Errors associated with this dashboard version.

", + "items": { + "$ref": "#/definitions/DashboardError" + }, + "minItems": 1, + "type": "array" + }, + "Sheets": { + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", + "items": { + "$ref": "#/definitions/Sheet" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SourceEntityArn": { + "description": "

Source entity ARN.

", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ResourceStatus" + }, + "ThemeArn": { + "description": "

The ARN of the theme associated with a version of the dashboard.

", + "type": "string" + }, + "VersionNumber": { + "description": "

Version number for this version of the dashboard.

", + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "DashboardVersionDefinition": { + "additionalProperties": false, + "properties": { + "AnalysisDefaults": { + "$ref": "#/definitions/AnalysisDefaults" + }, + "CalculatedFields": { + "items": { + "$ref": "#/definitions/CalculatedField" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + }, + "ColumnConfigurations": { + "items": { + "$ref": "#/definitions/ColumnConfiguration" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifierDeclarations": { + "items": { + "$ref": "#/definitions/DataSetIdentifierDeclaration" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "FilterGroups": { + "items": { + "$ref": "#/definitions/FilterGroup" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "Options": { + "$ref": "#/definitions/AssetOptions" + }, + "ParameterDeclarations": { + "items": { + "$ref": "#/definitions/ParameterDeclaration" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Sheets": { + "items": { + "$ref": "#/definitions/SheetDefinition" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "DataSetIdentifierDeclarations" + ], + "type": "object" + }, + "DashboardVisualPublishOptions": { + "additionalProperties": false, + "description": "

The visual publish options of a visual in a dashboard

", + "properties": { + "ExportHiddenFieldsOption": { + "$ref": "#/definitions/ExportHiddenFieldsOption" + } + }, + "type": "object" + }, + "DataBarsOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "NegativeColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "DataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "DataFieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "DataLabelContent": { + "enum": [ + "VALUE", + "PERCENT", + "VALUE_AND_PERCENT" + ], + "type": "string" + }, + "DataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DataLabelTypes": { + "items": { + "$ref": "#/definitions/DataLabelType" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelContent": { + "$ref": "#/definitions/DataLabelContent" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Overlap": { + "$ref": "#/definitions/DataLabelOverlap" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataLabelOverlap": { + "enum": [ + "DISABLE_OVERLAP", + "ENABLE_OVERLAP" + ], + "type": "string" + }, + "DataLabelPosition": { + "enum": [ + "INSIDE", + "OUTSIDE", + "LEFT", + "TOP", + "BOTTOM", + "RIGHT" + ], + "type": "string" + }, + "DataLabelType": { + "additionalProperties": false, + "properties": { + "DataPathLabelType": { + "$ref": "#/definitions/DataPathLabelType" + }, + "FieldLabelType": { + "$ref": "#/definitions/FieldLabelType" + }, + "MaximumLabelType": { + "$ref": "#/definitions/MaximumLabelType" + }, + "MinimumLabelType": { + "$ref": "#/definitions/MinimumLabelType" + }, + "RangeEndsLabelType": { + "$ref": "#/definitions/RangeEndsLabelType" + } + }, + "type": "object" + }, + "DataPathColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Element": { + "$ref": "#/definitions/DataPathValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Color", + "Element" + ], + "type": "object" + }, + "DataPathLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataPathSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortPaths": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Direction", + "SortPaths" + ], + "type": "object" + }, + "DataPathType": { + "additionalProperties": false, + "properties": { + "PivotTableDataPathType": { + "$ref": "#/definitions/PivotTableDataPathType" + } + }, + "type": "object" + }, + "DataPathValue": { + "additionalProperties": false, + "properties": { + "DataPathType": { + "$ref": "#/definitions/DataPathType" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "DataPointDrillUpDownOption": { + "additionalProperties": false, + "description": "

The drill down options for data points in a dashbaord.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "DataPointMenuLabelOption": { + "additionalProperties": false, + "description": "

The data point menu options of a dashboard.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "DataPointTooltipOption": { + "additionalProperties": false, + "description": "

The data point tooltip options.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "DataSetIdentifierDeclaration": { + "additionalProperties": false, + "properties": { + "DataSetArn": { + "type": "string" + }, + "Identifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetArn", + "Identifier" + ], + "type": "object" + }, + "DataSetReference": { + "additionalProperties": false, + "description": "

Dataset reference.

", + "properties": { + "DataSetArn": { + "description": "

Dataset Amazon Resource Name (ARN).

", + "type": "string" + }, + "DataSetPlaceholder": { + "description": "

Dataset placeholder.

", + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "DataSetArn", + "DataSetPlaceholder" + ], + "type": "object" + }, + "DateAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT", + "MIN", + "MAX" + ], + "type": "string" + }, + "DateAxisOptions": { + "additionalProperties": false, + "properties": { + "MissingDateVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DateDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DateGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateTimeDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DateTimeFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "DateTimeHierarchy": { + "additionalProperties": false, + "properties": { + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "HierarchyId" + ], + "type": "object" + }, + "DateTimeParameter": { + "additionalProperties": false, + "description": "

A date-time parameter.

", + "properties": { + "Name": { + "description": "

A display name for the date-time parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the date-time parameter.

", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "DateTimeParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DateTimeDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "DateTimePickerControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DateTimeValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "format": "date-time", + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DayOfTheWeek": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + }, + "DecimalDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DecimalParameter": { + "additionalProperties": false, + "description": "

A decimal parameter.

", + "properties": { + "Name": { + "description": "

A display name for the decimal parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the decimal parameter.

", + "items": { + "default": 0, + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "DecimalParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DecimalDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "DecimalPlacesConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlaces": { + "maximum": 20, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "DecimalPlaces" + ], + "type": "object" + }, + "DecimalValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultGridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultInteractiveLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeForm": { + "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" + }, + "Grid": { + "$ref": "#/definitions/DefaultGridLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultNewSheetConfiguration": { + "additionalProperties": false, + "properties": { + "InteractiveLayoutConfiguration": { + "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" + }, + "PaginatedLayoutConfiguration": { + "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" + }, + "SheetContentType": { + "$ref": "#/definitions/SheetContentType" + } + }, + "type": "object" + }, + "DefaultPaginatedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "SectionBased": { + "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultSectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, + "DestinationParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValuesConfiguration": { + "$ref": "#/definitions/CustomValuesConfiguration" + }, + "SelectAllValueOptions": { + "$ref": "#/definitions/SelectAllValueOptions" + }, + "SourceColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceField": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SourceParameterName": { + "type": "string" + } + }, + "type": "object" + }, + "DimensionField": { + "additionalProperties": false, + "properties": { + "CategoricalDimensionField": { + "$ref": "#/definitions/CategoricalDimensionField" + }, + "DateDimensionField": { + "$ref": "#/definitions/DateDimensionField" + }, + "NumericalDimensionField": { + "$ref": "#/definitions/NumericalDimensionField" + } + }, + "type": "object" + }, + "DonutCenterOptions": { + "additionalProperties": false, + "properties": { + "LabelVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DonutOptions": { + "additionalProperties": false, + "properties": { + "ArcOptions": { + "$ref": "#/definitions/ArcOptions" + }, + "DonutCenterOptions": { + "$ref": "#/definitions/DonutCenterOptions" + } + }, + "type": "object" + }, + "DrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryDrillDownFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityDrillDownFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeDrillDownFilter" + } + }, + "type": "object" + }, + "DropDownControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DynamicDefaultValue": { + "additionalProperties": false, + "properties": { + "DefaultValueColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "GroupNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "UserNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "DefaultValueColumn" + ], + "type": "object" + }, + "EmptyVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "Entity": { + "additionalProperties": false, + "properties": { + "Path": { + "pattern": "\\S", + "type": "string" + } + }, + "type": "object" + }, + "ExcludePeriodConfiguration": { + "additionalProperties": false, + "properties": { + "Amount": { + "default": null, + "type": "number" + }, + "Granularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "Amount", + "Granularity" + ], + "type": "object" + }, + "ExplicitHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 2, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "ExportHiddenFieldsOption": { + "additionalProperties": false, + "description": "

Determines if hidden fields are included in an exported dashboard.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "ExportToCSVOption": { + "additionalProperties": false, + "description": "

Export to .csv option.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "ExportWithHiddenFieldsOption": { + "additionalProperties": false, + "description": "

Determines whether or not hidden fields are visible on exported dashbaords.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "FieldBasedTooltip": { + "additionalProperties": false, + "properties": { + "AggregationVisibility": { + "$ref": "#/definitions/Visibility" + }, + "TooltipFields": { + "items": { + "$ref": "#/definitions/TooltipItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "TooltipTitleType": { + "$ref": "#/definitions/TooltipTitleType" + } + }, + "type": "object" + }, + "FieldLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "FieldSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Direction", + "FieldId" + ], + "type": "object" + }, + "FieldSortOptions": { + "additionalProperties": false, + "properties": { + "ColumnSort": { + "$ref": "#/definitions/ColumnSort" + }, + "FieldSort": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "FieldTooltipItem": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/FilledMapConditionalFormattingOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "ConditionalFormattingOptions" + ], + "type": "object" + }, + "FilledMapConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Shape": { + "$ref": "#/definitions/FilledMapShapeConditionalFormatting" + } + }, + "required": [ + "Shape" + ], + "type": "object" + }, + "FilledMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/FilledMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/FilledMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "FilledMapFieldWells": { + "additionalProperties": false, + "properties": { + "FilledMapAggregatedFieldWells": { + "$ref": "#/definitions/FilledMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "FilledMapShapeConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Format": { + "$ref": "#/definitions/ShapeConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FilledMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/FilledMapConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryFilter" + }, + "NestedFilter": { + "$ref": "#/definitions/NestedFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityFilter" + }, + "NumericRangeFilter": { + "$ref": "#/definitions/NumericRangeFilter" + }, + "RelativeDatesFilter": { + "$ref": "#/definitions/RelativeDatesFilter" + }, + "TimeEqualityFilter": { + "$ref": "#/definitions/TimeEqualityFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeFilter" + }, + "TopBottomFilter": { + "$ref": "#/definitions/TopBottomFilter" + } + }, + "type": "object" + }, + "FilterControl": { + "additionalProperties": false, + "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, + "DateTimePicker": { + "$ref": "#/definitions/FilterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/FilterDropDownControl" + }, + "List": { + "$ref": "#/definitions/FilterListControl" + }, + "RelativeDateTime": { + "$ref": "#/definitions/FilterRelativeDateTimeControl" + }, + "Slider": { + "$ref": "#/definitions/FilterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/FilterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/FilterTextFieldControl" + } + }, + "type": "object" + }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, + "FilterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterGroup": { + "additionalProperties": false, + "properties": { + "CrossDataset": { + "$ref": "#/definitions/CrossDatasetTypes" + }, + "FilterGroupId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Filters": { + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "ScopeConfiguration": { + "$ref": "#/definitions/FilterScopeConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "CrossDataset", + "FilterGroupId", + "Filters", + "ScopeConfiguration" + ], + "type": "object" + }, + "FilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator" + ], + "type": "object" + }, + "FilterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterNullOption": { + "enum": [ + "ALL_VALUES", + "NULLS_ONLY", + "NON_NULLS_ONLY" + ], + "type": "string" + }, + "FilterOperationSelectedFieldsConfiguration": { + "additionalProperties": false, + "properties": { + "SelectedColumns": { + "description": "

The selected columns of a dataset.

", + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "$ref": "#/definitions/SelectedFieldOptions" + }, + "SelectedFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FilterOperationTargetVisualsConfiguration": { + "additionalProperties": false, + "properties": { + "SameSheetTargetVisualConfiguration": { + "$ref": "#/definitions/SameSheetTargetVisualConfiguration" + } + }, + "type": "object" + }, + "FilterRelativeDateTimeControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "AllSheets": { + "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" + }, + "SelectedSheets": { + "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" + } + }, + "type": "object" + }, + "FilterSelectableValues": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "FilterControlId", + "MaximumValue", + "MinimumValue", + "SourceFilterId", + "StepSize", + "Title" + ], + "type": "object" + }, + "FilterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterVisualScope": { + "enum": [ + "ALL_VISUALS", + "SELECTED_VISUALS" + ], + "type": "string" + }, + "FontConfiguration": { + "additionalProperties": false, + "properties": { + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontDecoration": { + "$ref": "#/definitions/FontDecoration" + }, + "FontSize": { + "$ref": "#/definitions/FontSize" + }, + "FontStyle": { + "$ref": "#/definitions/FontStyle" + }, + "FontWeight": { + "$ref": "#/definitions/FontWeight" + } + }, + "type": "object" + }, + "FontDecoration": { + "enum": [ + "UNDERLINE", + "NONE" + ], + "type": "string" + }, + "FontSize": { + "additionalProperties": false, + "properties": { + "Relative": { + "$ref": "#/definitions/RelativeFontSize" + } + }, + "type": "object" + }, + "FontStyle": { + "enum": [ + "NORMAL", + "ITALIC" + ], + "type": "string" + }, + "FontWeight": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/FontWeightName" + } + }, + "type": "object" + }, + "FontWeightName": { + "enum": [ + "NORMAL", + "BOLD" + ], + "type": "string" + }, + "ForecastComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "CustomSeasonalityValue": { + "default": null, + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "LowerBoundary": { + "default": null, + "type": "number" + }, + "Name": { + "type": "string" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "$ref": "#/definitions/ForecastComputationSeasonality" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "UpperBoundary": { + "default": null, + "type": "number" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ForecastComputationSeasonality": { + "enum": [ + "AUTOMATIC", + "CUSTOM" + ], + "type": "string" + }, + "ForecastConfiguration": { + "additionalProperties": false, + "properties": { + "ForecastProperties": { + "$ref": "#/definitions/TimeBasedForecastProperties" + }, + "Scenario": { + "$ref": "#/definitions/ForecastScenario" + } + }, + "type": "object" + }, + "ForecastScenario": { + "additionalProperties": false, + "properties": { + "WhatIfPointScenario": { + "$ref": "#/definitions/WhatIfPointScenario" + }, + "WhatIfRangeScenario": { + "$ref": "#/definitions/WhatIfRangeScenario" + } + }, + "type": "object" + }, + "FormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "NumberFormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "StringFormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "type": "object" + }, + "FreeFormLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "FreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FreeFormLayoutElement": { + "additionalProperties": false, + "properties": { + "BackgroundStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" + }, + "BorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "LoadingAnimation": { + "$ref": "#/definitions/LoadingAnimation" + }, + "RenderingRules": { + "items": { + "$ref": "#/definitions/SheetElementRenderingRule" + }, + "maxItems": 10000, + "minItems": 0, + "type": "array" + }, + "SelectedBorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "XAxisLocation": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "YAxisLocation": { + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", + "type": "string" + } + }, + "required": [ + "ElementId", + "ElementType", + "Height", + "Width", + "XAxisLocation", + "YAxisLocation" + ], + "type": "object" + }, + "FreeFormLayoutElementBackgroundStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutElementBorderStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "OptimizedViewPortWidth" + ], + "type": "object" + }, + "FreeFormSectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FunnelChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabelOptions": { + "$ref": "#/definitions/FunnelChartDataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/FunnelChartFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/FunnelChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "FunnelChartDataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureDataLabelStyle": { + "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FunnelChartFieldWells": { + "additionalProperties": false, + "properties": { + "FunnelChartAggregatedFieldWells": { + "$ref": "#/definitions/FunnelChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "FunnelChartMeasureDataLabelStyle": { + "enum": [ + "VALUE_ONLY", + "PERCENTAGE_BY_FIRST_STAGE", + "PERCENTAGE_BY_PREVIOUS_STAGE", + "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", + "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" + ], + "type": "string" + }, + "FunnelChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FunnelChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GaugeChartArcConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/GaugeChartConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/GaugeChartArcConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" + } + }, + "type": "object" + }, + "GaugeChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/GaugeChartFieldWells" + }, + "GaugeChartOptions": { + "$ref": "#/definitions/GaugeChartOptions" + }, + "TooltipOptions": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "GaugeChartFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartOptions": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/ArcConfiguration" + }, + "ArcAxis": { + "$ref": "#/definitions/ArcAxisConfiguration" + }, + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "GaugeChartPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GaugeChartConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/GaugeChartConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialCoordinateBounds": { + "additionalProperties": false, + "properties": { + "East": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + }, + "North": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "South": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "West": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + } + }, + "required": [ + "East", + "North", + "South", + "West" + ], + "type": "object" + }, + "GeospatialHeatmapColorScale": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/GeospatialHeatmapDataColor" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialHeatmapConfiguration": { + "additionalProperties": false, + "properties": { + "HeatmapColor": { + "$ref": "#/definitions/GeospatialHeatmapColorScale" + } + }, + "type": "object" + }, + "GeospatialHeatmapDataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "GeospatialMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/GeospatialMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "PointStyleOptions": { + "$ref": "#/definitions/GeospatialPointStyleOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "GeospatialMapFieldWells": { + "additionalProperties": false, + "properties": { + "GeospatialMapAggregatedFieldWells": { + "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "GeospatialMapStyleOptions": { + "additionalProperties": false, + "properties": { + "BaseMapStyle": { + "$ref": "#/definitions/BaseMapStyleType" + } + }, + "type": "object" + }, + "GeospatialMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GeospatialMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialPointStyleOptions": { + "additionalProperties": false, + "properties": { + "ClusterMarkerConfiguration": { + "$ref": "#/definitions/ClusterMarkerConfiguration" + }, + "HeatmapConfiguration": { + "$ref": "#/definitions/GeospatialHeatmapConfiguration" + }, + "SelectedPointStyle": { + "$ref": "#/definitions/GeospatialSelectedPointStyle" + } + }, + "type": "object" + }, + "GeospatialSelectedPointStyle": { + "enum": [ + "POINT", + "CLUSTER", + "HEATMAP" + ], + "type": "string" + }, + "GeospatialWindowOptions": { + "additionalProperties": false, + "properties": { + "Bounds": { + "$ref": "#/definitions/GeospatialCoordinateBounds" + }, + "MapZoomMode": { + "$ref": "#/definitions/MapZoomMode" + } + }, + "type": "object" + }, + "GlobalTableBorderOptions": { + "additionalProperties": false, + "properties": { + "SideSpecificBorder": { + "$ref": "#/definitions/TableSideBorderOptions" + }, + "UniformBorder": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "GradientColor": { + "additionalProperties": false, + "properties": { + "Stops": { + "items": { + "$ref": "#/definitions/GradientStop" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GradientStop": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + }, + "GradientOffset": { + "default": 0, + "type": "number" + } + }, + "required": [ + "GradientOffset" + ], + "type": "object" + }, + "GridLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "GridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/GridLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "GridLayoutElement": { + "additionalProperties": false, + "properties": { + "ColumnIndex": { + "maximum": 35, + "minimum": 0, + "type": "number" + }, + "ColumnSpan": { + "maximum": 36, + "minimum": 1, + "type": "number" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "RowIndex": { + "maximum": 9009, + "minimum": 0, + "type": "number" + }, + "RowSpan": { + "maximum": 21, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "ColumnSpan", + "ElementId", + "ElementType", + "RowSpan" + ], + "type": "object" + }, + "GridLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "ResizeOption": { + "$ref": "#/definitions/ResizeOption" + } + }, + "required": [ + "ResizeOption" + ], + "type": "object" + }, + "GrowthRateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodSize": { + "default": 0, + "maximum": 52, + "minimum": 2, + "type": "number" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "HeaderFooterSectionConfiguration": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Layout", + "SectionId" + ], + "type": "object" + }, + "HeatMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "ColumnLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HeatMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "RowLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/HeatMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "HeatMapFieldWells": { + "additionalProperties": false, + "properties": { + "HeatMapAggregatedFieldWells": { + "$ref": "#/definitions/HeatMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "HeatMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapColumnSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "HeatMapRowItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapRowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HeatMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HistogramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HistogramBinOptions": { + "additionalProperties": false, + "properties": { + "BinCount": { + "$ref": "#/definitions/BinCountOptions" + }, + "BinWidth": { + "$ref": "#/definitions/BinWidthOptions" + }, + "SelectedBinType": { + "$ref": "#/definitions/HistogramBinType" + }, + "StartValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "HistogramBinType": { + "enum": [ + "BIN_COUNT", + "BIN_WIDTH" + ], + "type": "string" + }, + "HistogramConfiguration": { + "additionalProperties": false, + "properties": { + "BinOptions": { + "$ref": "#/definitions/HistogramBinOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HistogramFieldWells" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + } + }, + "type": "object" + }, + "HistogramFieldWells": { + "additionalProperties": false, + "properties": { + "HistogramAggregatedFieldWells": { + "$ref": "#/definitions/HistogramAggregatedFieldWells" + } + }, + "type": "object" + }, + "HistogramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HistogramConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HorizontalTextAlignment": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT", + "AUTO" + ], + "type": "string" + }, + "Icon": { + "enum": [ + "CARET_UP", + "CARET_DOWN", + "PLUS", + "MINUS", + "ARROW_UP", + "ARROW_DOWN", + "ARROW_LEFT", + "ARROW_UP_LEFT", + "ARROW_DOWN_LEFT", + "ARROW_RIGHT", + "ARROW_UP_RIGHT", + "ARROW_DOWN_RIGHT", + "FACE_UP", + "FACE_DOWN", + "FACE_FLAT", + "ONE_BAR", + "TWO_BAR", + "THREE_BAR", + "CIRCLE", + "TRIANGLE", + "SQUARE", + "FLAG", + "THUMBS_UP", + "THUMBS_DOWN", + "CHECKMARK", + "X" + ], + "type": "string" + }, + "InnerFilter": { + "additionalProperties": false, + "properties": { + "CategoryInnerFilter": { + "$ref": "#/definitions/CategoryInnerFilter" + } + }, + "type": "object" + }, + "InsightConfiguration": { + "additionalProperties": false, + "properties": { + "Computations": { + "items": { + "$ref": "#/definitions/Computation" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "CustomNarrative": { + "$ref": "#/definitions/CustomNarrativeOptions" + } + }, + "type": "object" + }, + "InsightVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "InsightConfiguration": { + "$ref": "#/definitions/InsightConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "IntegerDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "IntegerParameter": { + "additionalProperties": false, + "description": "

An integer parameter.

", + "properties": { + "Name": { + "description": "

The name of the integer parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values for the integer parameter.

", + "items": { + "default": 0, + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "IntegerParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/IntegerDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "IntegerValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "ItemsLimitConfiguration": { + "additionalProperties": false, + "properties": { + "ItemsLimit": { + "default": null, + "type": "number" + }, + "OtherCategories": { + "$ref": "#/definitions/OtherCategories" + } + }, + "type": "object" + }, + "KPIActualValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIComparisonValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/KPIConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "ActualValue": { + "$ref": "#/definitions/KPIActualValueConditionalFormatting" + }, + "ComparisonValue": { + "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" + }, + "ProgressBar": { + "$ref": "#/definitions/KPIProgressBarConditionalFormatting" + } + }, + "type": "object" + }, + "KPIConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/KPIFieldWells" + }, + "KPIOptions": { + "$ref": "#/definitions/KPIOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/KPISortConfiguration" + } + }, + "type": "object" + }, + "KPIFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrendGroups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIOptions": { + "additionalProperties": false, + "properties": { + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "ProgressBar": { + "$ref": "#/definitions/ProgressBarOptions" + }, + "SecondaryValue": { + "$ref": "#/definitions/SecondaryValueOptions" + }, + "SecondaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Sparkline": { + "$ref": "#/definitions/KPISparklineOptions" + }, + "TrendArrows": { + "$ref": "#/definitions/TrendArrowOptions" + }, + "VisualLayoutOptions": { + "$ref": "#/definitions/KPIVisualLayoutOptions" + } + }, + "type": "object" + }, + "KPIPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIProgressBarConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPISortConfiguration": { + "additionalProperties": false, + "properties": { + "TrendGroupSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPISparklineOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Type": { + "$ref": "#/definitions/KPISparklineType" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPISparklineType": { + "enum": [ + "LINE", + "AREA" + ], + "type": "string" + }, + "KPIVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/KPIConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/KPIConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "KPIVisualLayoutOptions": { + "additionalProperties": false, + "properties": { + "StandardLayout": { + "$ref": "#/definitions/KPIVisualStandardLayout" + } + }, + "type": "object" + }, + "KPIVisualStandardLayout": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/KPIVisualStandardLayoutType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPIVisualStandardLayoutType": { + "enum": [ + "CLASSIC", + "VERTICAL" + ], + "type": "string" + }, + "LabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "Layout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/LayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "LayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormLayoutConfiguration" + }, + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + }, + "SectionBasedLayout": { + "$ref": "#/definitions/SectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "LayoutElementType": { + "enum": [ + "VISUAL", + "FILTER_CONTROL", + "PARAMETER_CONTROL", + "TEXT_BOX" + ], + "type": "string" + }, + "LegendOptions": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Position": { + "$ref": "#/definitions/LegendPosition" + }, + "Title": { + "$ref": "#/definitions/LabelOptions" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LegendPosition": { + "enum": [ + "AUTO", + "RIGHT", + "BOTTOM", + "TOP" + ], + "type": "string" + }, + "LineChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartConfiguration": { + "additionalProperties": false, + "properties": { + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DefaultSeriesSettings": { + "$ref": "#/definitions/LineChartDefaultSeriesSettings" + }, + "FieldWells": { + "$ref": "#/definitions/LineChartFieldWells" + }, + "ForecastConfigurations": { + "items": { + "$ref": "#/definitions/ForecastConfiguration" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Series": { + "items": { + "$ref": "#/definitions/SeriesItem" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/LineChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "Type": { + "$ref": "#/definitions/LineChartType" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "LineChartDefaultSeriesSettings": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartFieldWells": { + "additionalProperties": false, + "properties": { + "LineChartAggregatedFieldWells": { + "$ref": "#/definitions/LineChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "LineChartLineStyle": { + "enum": [ + "SOLID", + "DOTTED", + "DASHED" + ], + "type": "string" + }, + "LineChartLineStyleSettings": { + "additionalProperties": false, + "properties": { + "LineInterpolation": { + "$ref": "#/definitions/LineInterpolation" + }, + "LineStyle": { + "$ref": "#/definitions/LineChartLineStyle" + }, + "LineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LineWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LineChartMarkerShape": { + "enum": [ + "CIRCLE", + "TRIANGLE", + "SQUARE", + "DIAMOND", + "ROUNDED_SQUARE" + ], + "type": "string" + }, + "LineChartMarkerStyleSettings": { + "additionalProperties": false, + "properties": { + "MarkerColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "MarkerShape": { + "$ref": "#/definitions/LineChartMarkerShape" + }, + "MarkerSize": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MarkerVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LineChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartType": { + "enum": [ + "LINE", + "AREA", + "STACKED_AREA" + ], + "type": "string" + }, + "LineChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/LineChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "LineInterpolation": { + "enum": [ + "LINEAR", + "SMOOTH", + "STEPPED" + ], + "type": "string" + }, + "LineSeriesAxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "MissingDataConfigurations": { + "items": { + "$ref": "#/definitions/MissingDataConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LinkSharingConfiguration": { + "additionalProperties": false, + "properties": { + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ListControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SearchOptions": { + "$ref": "#/definitions/ListControlSearchOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "ListControlSearchOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ListControlSelectAllOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LoadingAnimation": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LocalNavigationConfiguration": { + "additionalProperties": false, + "properties": { + "TargetSheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "TargetSheetId" + ], + "type": "object" + }, + "LongFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "MapZoomMode": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "MappedDataSetParameter": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DataSetParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "DataSetParameterName" + ], + "type": "object" + }, + "MaximumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MaximumMinimumComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/MaximumMinimumComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "MaximumMinimumComputationType": { + "enum": [ + "MAXIMUM", + "MINIMUM" + ], + "type": "string" + }, + "MeasureField": { + "additionalProperties": false, + "properties": { + "CalculatedMeasureField": { + "$ref": "#/definitions/CalculatedMeasureField" + }, + "CategoricalMeasureField": { + "$ref": "#/definitions/CategoricalMeasureField" + }, + "DateMeasureField": { + "$ref": "#/definitions/DateMeasureField" + }, + "NumericalMeasureField": { + "$ref": "#/definitions/NumericalMeasureField" + } + }, + "type": "object" + }, + "MetricComparisonComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "FromValue": { + "$ref": "#/definitions/MeasureField" + }, + "Name": { + "type": "string" + }, + "TargetValue": { + "$ref": "#/definitions/MeasureField" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "MinimumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MissingDataConfiguration": { + "additionalProperties": false, + "properties": { + "TreatmentOption": { + "$ref": "#/definitions/MissingDataTreatmentOption" + } + }, + "type": "object" + }, + "MissingDataTreatmentOption": { + "enum": [ + "INTERPOLATE", + "SHOW_AS_ZERO", + "SHOW_AS_BLANK" + ], + "type": "string" + }, + "NegativeValueConfiguration": { + "additionalProperties": false, + "properties": { + "DisplayMode": { + "$ref": "#/definitions/NegativeValueDisplayMode" + } + }, + "required": [ + "DisplayMode" + ], + "type": "object" + }, + "NegativeValueDisplayMode": { + "enum": [ + "POSITIVE", + "NEGATIVE" + ], + "type": "string" + }, + "NestedFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeInnerSet": { + "default": false, + "type": "boolean" + }, + "InnerFilter": { + "$ref": "#/definitions/InnerFilter" + } + }, + "required": [ + "Column", + "FilterId", + "IncludeInnerSet", + "InnerFilter" + ], + "type": "object" + }, + "NullValueFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullString": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "NullString" + ], + "type": "object" + }, + "NumberDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "NumberFormatConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "NumberScale": { + "enum": [ + "NONE", + "AUTO", + "THOUSANDS", + "MILLIONS", + "BILLIONS", + "TRILLIONS" + ], + "type": "string" + }, + "NumericAxisOptions": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/AxisDisplayRange" + }, + "Scale": { + "$ref": "#/definitions/AxisScale" + } + }, + "type": "object" + }, + "NumericEqualityDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Column", + "Value" + ], + "type": "object" + }, + "NumericEqualityFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/NumericEqualityMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + }, + "Value": { + "default": null, + "type": "number" + } + }, + "required": [ + "Column", + "FilterId", + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "NumericEqualityMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL" + ], + "type": "string" + }, + "NumericFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "NumericFormatConfiguration": { + "additionalProperties": false, + "properties": { + "CurrencyDisplayFormatConfiguration": { + "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" + }, + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "NumericRangeFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "RangeMinimum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "NumericRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StaticValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "NumericSeparatorConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalSeparator": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "ThousandsSeparator": { + "$ref": "#/definitions/ThousandSeparatorOptions" + } + }, + "type": "object" + }, + "NumericSeparatorSymbol": { + "enum": [ + "COMMA", + "DOT", + "SPACE" + ], + "type": "string" + }, + "NumericalAggregationFunction": { + "additionalProperties": false, + "properties": { + "PercentileAggregation": { + "$ref": "#/definitions/PercentileAggregation" + }, + "SimpleNumericalAggregation": { + "$ref": "#/definitions/SimpleNumericalAggregationFunction" + } + }, + "type": "object" + }, + "NumericalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "NumericalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "OtherCategories": { + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "type": "string" + }, + "PaginationConfiguration": { + "additionalProperties": false, + "properties": { + "PageNumber": { + "minimum": 0, + "type": "number" + }, + "PageSize": { + "default": null, + "type": "number" + } + }, + "required": [ + "PageNumber", + "PageSize" + ], + "type": "object" + }, + "PanelBorderStyle": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "PanelConfiguration": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BackgroundVisibility": { + "$ref": "#/definitions/Visibility" + }, + "BorderColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BorderStyle": { + "$ref": "#/definitions/PanelBorderStyle" + }, + "BorderThickness": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "BorderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "GutterSpacing": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "GutterVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Title": { + "$ref": "#/definitions/PanelTitleOptions" + } + }, + "type": "object" + }, + "PanelTitleOptions": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PaperOrientation": { + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "PaperSize": { + "enum": [ + "US_LETTER", + "US_LEGAL", + "US_TABLOID_LEDGER", + "A0", + "A1", + "A2", + "A3", + "A4", + "A5", + "JIS_B4", + "JIS_B5" + ], + "type": "string" + }, + "ParameterControl": { + "additionalProperties": false, + "properties": { + "DateTimePicker": { + "$ref": "#/definitions/ParameterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/ParameterDropDownControl" + }, + "List": { + "$ref": "#/definitions/ParameterListControl" + }, + "Slider": { + "$ref": "#/definitions/ParameterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/ParameterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/ParameterTextFieldControl" + } + }, + "type": "object" + }, + "ParameterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DateTimeParameterDeclaration": { + "$ref": "#/definitions/DateTimeParameterDeclaration" + }, + "DecimalParameterDeclaration": { + "$ref": "#/definitions/DecimalParameterDeclaration" + }, + "IntegerParameterDeclaration": { + "$ref": "#/definitions/IntegerParameterDeclaration" + }, + "StringParameterDeclaration": { + "$ref": "#/definitions/StringParameterDeclaration" + } + }, + "type": "object" + }, + "ParameterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterSelectableValues": { + "additionalProperties": false, + "properties": { + "LinkToDataSetColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ParameterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "ParameterControlId", + "SourceParameterName", + "StepSize", + "Title" + ], + "type": "object" + }, + "ParameterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterValueType": { + "enum": [ + "MULTI_VALUED", + "SINGLE_VALUED" + ], + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "description": "

A list of Amazon QuickSight parameters and the list's override values.

", + "properties": { + "DateTimeParameters": { + "description": "

The parameters that have a data type of date-time.

", + "items": { + "$ref": "#/definitions/DateTimeParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "DecimalParameters": { + "description": "

The parameters that have a data type of decimal.

", + "items": { + "$ref": "#/definitions/DecimalParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "IntegerParameters": { + "description": "

The parameters that have a data type of integer.

", + "items": { + "$ref": "#/definitions/IntegerParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "StringParameters": { + "description": "

The parameters that have a data type of string.

", + "items": { + "$ref": "#/definitions/StringParameter" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PercentVisibleRange": { + "additionalProperties": false, + "properties": { + "From": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "To": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PercentageDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PercentileAggregation": { + "additionalProperties": false, + "properties": { + "PercentileValue": { + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PeriodOverPeriodComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PeriodToDateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodTimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PieChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DonutOptions": { + "$ref": "#/definitions/DonutOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PieChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PieChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "PieChartFieldWells": { + "additionalProperties": false, + "properties": { + "PieChartAggregatedFieldWells": { + "$ref": "#/definitions/PieChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "PieChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PieChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotFieldSortOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SortBy": { + "$ref": "#/definitions/PivotTableSortBy" + } + }, + "required": [ + "FieldId", + "SortBy" + ], + "type": "object" + }, + "PivotTableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Scope": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "Scopes": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/PivotTableCellConditionalFormatting" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScope": { + "additionalProperties": false, + "properties": { + "Role": { + "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScopeRole": { + "enum": [ + "FIELD", + "FIELD_TOTAL", + "GRAND_TOTAL" + ], + "type": "string" + }, + "PivotTableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/PivotTableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PivotTableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/PivotTablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PivotTableSortConfiguration" + }, + "TableOptions": { + "$ref": "#/definitions/PivotTableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/PivotTableTotalOptions" + } + }, + "type": "object" + }, + "PivotTableDataPathOption": { + "additionalProperties": false, + "properties": { + "DataPathList": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "DataPathList" + ], + "type": "object" + }, + "PivotTableDataPathType": { + "enum": [ + "HIERARCHY_ROWS_LAYOUT_COLUMN", + "MULTIPLE_ROW_METRICS_COLUMN", + "EMPTY_COLUMN_HEADER", + "COUNT_METRIC_COLUMN" + ], + "type": "string" + }, + "PivotTableFieldCollapseState": { + "enum": [ + "COLLAPSED", + "EXPANDED" + ], + "type": "string" + }, + "PivotTableFieldCollapseStateOption": { + "additionalProperties": false, + "properties": { + "State": { + "$ref": "#/definitions/PivotTableFieldCollapseState" + }, + "Target": { + "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" + } + }, + "required": [ + "Target" + ], + "type": "object" + }, + "PivotTableFieldCollapseStateTarget": { + "additionalProperties": false, + "properties": { + "FieldDataPathValues": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "FieldId": { + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableFieldOptions": { + "additionalProperties": false, + "properties": { + "CollapseStateOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldCollapseStateOption" + }, + "type": "array" + }, + "DataPathOptions": { + "items": { + "$ref": "#/definitions/PivotTableDataPathOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableFieldSubtotalOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldWells": { + "additionalProperties": false, + "properties": { + "PivotTableAggregatedFieldWells": { + "$ref": "#/definitions/PivotTableAggregatedFieldWells" + } + }, + "type": "object" + }, + "PivotTableMetricPlacement": { + "enum": [ + "ROW", + "COLUMN" + ], + "type": "string" + }, + "PivotTableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "CollapsedRowDimensionsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ColumnHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "ColumnNamesVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DefaultCellWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MetricPlacement": { + "$ref": "#/definitions/PivotTableMetricPlacement" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + }, + "RowFieldNamesStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowsLabelOptions": { + "$ref": "#/definitions/PivotTableRowsLabelOptions" + }, + "RowsLayout": { + "$ref": "#/definitions/PivotTableRowsLayout" + }, + "SingleMetricVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ToggleButtonsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLayout": { + "enum": [ + "TABULAR", + "HIERARCHY" + ], + "type": "string" + }, + "PivotTableSortBy": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnSort" + }, + "DataPath": { + "$ref": "#/definitions/DataPathSort" + }, + "Field": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "PivotTableSortConfiguration": { + "additionalProperties": false, + "properties": { + "FieldSortOptions": { + "items": { + "$ref": "#/definitions/PivotFieldSortOptions" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableSubtotalLevel": { + "enum": [ + "ALL", + "CUSTOM", + "LAST" + ], + "type": "string" + }, + "PivotTableTotalOptions": { + "additionalProperties": false, + "properties": { + "ColumnSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "ColumnTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + }, + "RowSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "RowTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + } + }, + "type": "object" + }, + "PivotTableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PivotTableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/PivotTableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotTotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "PredefinedHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "PrimaryValueDisplayType": { + "enum": [ + "HIDDEN", + "COMPARISON", + "ACTUAL" + ], + "type": "string" + }, + "ProgressBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "RadarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Color": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartAreaStyleSettings": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "RadarChartAxesRangeScale": { + "enum": [ + "AUTO", + "INDEPENDENT", + "SHARED" + ], + "type": "string" + }, + "RadarChartConfiguration": { + "additionalProperties": false, + "properties": { + "AlternateBandColorsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AlternateBandEvenColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AlternateBandOddColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AxesRangeScale": { + "$ref": "#/definitions/RadarChartAxesRangeScale" + }, + "BaseSeriesSettings": { + "$ref": "#/definitions/RadarChartSeriesSettings" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/RadarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Shape": { + "$ref": "#/definitions/RadarChartShape" + }, + "SortConfiguration": { + "$ref": "#/definitions/RadarChartSortConfiguration" + }, + "StartAngle": { + "maximum": 360, + "minimum": -360, + "type": "number" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "RadarChartFieldWells": { + "additionalProperties": false, + "properties": { + "RadarChartAggregatedFieldWells": { + "$ref": "#/definitions/RadarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "RadarChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "AreaStyleSettings": { + "$ref": "#/definitions/RadarChartAreaStyleSettings" + } + }, + "type": "object" + }, + "RadarChartShape": { + "enum": [ + "CIRCLE", + "POLYGON" + ], + "type": "string" + }, + "RadarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/RadarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "RangeEndsLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ReferenceLine": { + "additionalProperties": false, + "properties": { + "DataConfiguration": { + "$ref": "#/definitions/ReferenceLineDataConfiguration" + }, + "LabelConfiguration": { + "$ref": "#/definitions/ReferenceLineLabelConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "StyleConfiguration": { + "$ref": "#/definitions/ReferenceLineStyleConfiguration" + } + }, + "required": [ + "DataConfiguration" + ], + "type": "object" + }, + "ReferenceLineCustomLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "CustomLabel" + ], + "type": "object" + }, + "ReferenceLineDataConfiguration": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "DynamicConfiguration": { + "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" + }, + "SeriesType": { + "$ref": "#/definitions/ReferenceLineSeriesType" + }, + "StaticConfiguration": { + "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" + } + }, + "type": "object" + }, + "ReferenceLineDynamicDataConfiguration": { + "additionalProperties": false, + "properties": { + "Calculation": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "MeasureAggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + } + }, + "required": [ + "Calculation", + "Column" + ], + "type": "object" + }, + "ReferenceLineLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" + }, + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalPosition": { + "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" + }, + "ValueLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" + }, + "VerticalPosition": { + "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" + } + }, + "type": "object" + }, + "ReferenceLineLabelHorizontalPosition": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ], + "type": "string" + }, + "ReferenceLineLabelVerticalPosition": { + "enum": [ + "ABOVE", + "BELOW" + ], + "type": "string" + }, + "ReferenceLinePatternType": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "ReferenceLineSeriesType": { + "enum": [ + "BAR", + "LINE" + ], + "type": "string" + }, + "ReferenceLineStaticDataConfiguration": { + "additionalProperties": false, + "properties": { + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "ReferenceLineStyleConfiguration": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Pattern": { + "$ref": "#/definitions/ReferenceLinePatternType" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + }, + "RelativePosition": { + "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelRelativePosition": { + "enum": [ + "BEFORE_CUSTOM_LABEL", + "AFTER_CUSTOM_LABEL" + ], + "type": "string" + }, + "RelativeDateTimeControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "RelativeDateType": { + "enum": [ + "PREVIOUS", + "THIS", + "LAST", + "NOW", + "NEXT" + ], + "type": "string" + }, + "RelativeDatesFilter": { + "additionalProperties": false, + "properties": { + "AnchorDateConfiguration": { + "$ref": "#/definitions/AnchorDateConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MinimumGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RelativeDateType": { + "$ref": "#/definitions/RelativeDateType" + }, + "RelativeDateValue": { + "default": null, + "type": "number" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AnchorDateConfiguration", + "Column", + "FilterId", + "NullOption", + "RelativeDateType", + "TimeGranularity" + ], + "type": "object" + }, + "RelativeFontSize": { + "enum": [ + "EXTRA_SMALL", + "SMALL", + "MEDIUM", + "LARGE", + "EXTRA_LARGE" + ], + "type": "string" + }, + "ResizeOption": { + "enum": [ + "FIXED", + "RESPONSIVE" + ], + "type": "string" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "ResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETED" + ], + "type": "string" + }, + "RollingDateConfiguration": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "RowAlternateColorOptions": { + "additionalProperties": false, + "properties": { + "RowAlternateColors": { + "items": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "UsePrimaryBackgroundColor": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "type": "object" + }, + "SameSheetTargetVisualConfiguration": { + "additionalProperties": false, + "properties": { + "TargetVisualOptions": { + "$ref": "#/definitions/TargetVisualOptions" + }, + "TargetVisuals": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Destination": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Source": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Weight": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/SankeyDiagramFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/SankeyDiagramSortConfiguration" + } + }, + "type": "object" + }, + "SankeyDiagramFieldWells": { + "additionalProperties": false, + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" + } + }, + "type": "object" + }, + "SankeyDiagramSortConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SourceItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "WeightSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/SankeyDiagramChartConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScatterPlotCategoricallyAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ScatterPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "YAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "ScatterPlotFieldWells": { + "additionalProperties": false, + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" + }, + "ScatterPlotUnaggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "ScatterPlotUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ScatterPlotConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScrollBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "VisibleRange": { + "$ref": "#/definitions/VisibleRangeOptions" + } + }, + "type": "object" + }, + "SecondaryValueOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SectionAfterPageBreak": { + "additionalProperties": false, + "properties": { + "Status": { + "$ref": "#/definitions/SectionPageBreakStatus" + } + }, + "type": "object" + }, + "SectionBasedLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperCanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" + } + }, + "type": "object" + }, + "SectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "BodySections": { + "items": { + "$ref": "#/definitions/BodySectionConfiguration" + }, + "maxItems": 28, + "minItems": 0, + "type": "array" + }, + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + }, + "FooterSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "HeaderSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "BodySections", + "CanvasSizeOptions", + "FooterSections", + "HeaderSections" + ], + "type": "object" + }, + "SectionBasedLayoutPaperCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperMargin": { + "$ref": "#/definitions/Spacing" + }, + "PaperOrientation": { + "$ref": "#/definitions/PaperOrientation" + }, + "PaperSize": { + "$ref": "#/definitions/PaperSize" + } + }, + "type": "object" + }, + "SectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" + } + }, + "required": [ + "FreeFormLayout" + ], + "type": "object" + }, + "SectionPageBreakConfiguration": { + "additionalProperties": false, + "properties": { + "After": { + "$ref": "#/definitions/SectionAfterPageBreak" + } + }, + "type": "object" + }, + "SectionPageBreakStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "SectionStyle": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Padding": { + "$ref": "#/definitions/Spacing" + } + }, + "type": "object" + }, + "SelectAllValueOptions": { + "enum": [ + "ALL_VALUES" + ], + "type": "string" + }, + "SelectedFieldOptions": { + "enum": [ + "ALL_FIELDS" + ], + "type": "string" + }, + "SelectedSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "SheetVisualScopingConfigurations": { + "items": { + "$ref": "#/definitions/SheetVisualScopingConfiguration" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SelectedTooltipType": { + "enum": [ + "BASIC", + "DETAILED" + ], + "type": "string" + }, + "SeriesItem": { + "additionalProperties": false, + "properties": { + "DataFieldSeriesItem": { + "$ref": "#/definitions/DataFieldSeriesItem" + }, + "FieldSeriesItem": { + "$ref": "#/definitions/FieldSeriesItem" + } + }, + "type": "object" + }, + "SetParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DestinationParameterValueConfiguration" + } + }, + "required": [ + "DestinationParameterName", + "Value" + ], + "type": "object" + }, + "ShapeConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "required": [ + "BackgroundColor" + ], + "type": "object" + }, + "Sheet": { + "additionalProperties": false, + "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", + "properties": { + "Name": { + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "SheetId": { + "description": "

The unique identifier associated with a sheet.

", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "type": "object" + }, + "SheetContentType": { + "enum": [ + "PAGINATED", + "INTERACTIVE" + ], + "type": "string" + }, + "SheetControlDateTimePickerType": { + "enum": [ + "SINGLE_VALUED", + "DATE_RANGE" + ], + "type": "string" + }, + "SheetControlInfoIconLabelOptions": { + "additionalProperties": false, + "properties": { + "InfoIconText": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetControlLayout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/SheetControlLayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "SheetControlLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + } + }, + "type": "object" + }, + "SheetControlListType": { + "enum": [ + "MULTI_SELECT", + "SINGLE_SELECT" + ], + "type": "string" + }, + "SheetControlSliderType": { + "enum": [ + "SINGLE_POINT", + "RANGE" + ], + "type": "string" + }, + "SheetControlsOption": { + "additionalProperties": false, + "description": "

Sheet controls option.

", + "properties": { + "VisibilityState": { + "$ref": "#/definitions/DashboardUIState" + } + }, + "type": "object" + }, + "SheetDefinition": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/SheetContentType" + }, + "Description": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "FilterControls": { + "items": { + "$ref": "#/definitions/FilterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Layouts": { + "items": { + "$ref": "#/definitions/Layout" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ParameterControls": { + "items": { + "$ref": "#/definitions/ParameterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SheetControlLayouts": { + "items": { + "$ref": "#/definitions/SheetControlLayout" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "TextBoxes": { + "items": { + "$ref": "#/definitions/SheetTextBox" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Title": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visuals": { + "items": { + "$ref": "#/definitions/Visual" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "SheetId" + ], + "type": "object" + }, + "SheetElementConfigurationOverrides": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetElementRenderingRule": { + "additionalProperties": false, + "properties": { + "ConfigurationOverrides": { + "$ref": "#/definitions/SheetElementConfigurationOverrides" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConfigurationOverrides", + "Expression" + ], + "type": "object" + }, + "SheetLayoutElementMaximizationOption": { + "additionalProperties": false, + "description": "

The sheet layout maximization options of a dashbaord.

", + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "SheetTextBox": { + "additionalProperties": false, + "properties": { + "Content": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + }, + "SheetTextBoxId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "SheetTextBoxId" + ], + "type": "object" + }, + "SheetVisualScopingConfiguration": { + "additionalProperties": false, + "properties": { + "Scope": { + "$ref": "#/definitions/FilterVisualScope" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "VisualIds": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Scope", + "SheetId" + ], + "type": "object" + }, + "ShortFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SimpleAttributeAggregationFunction": { + "enum": [ + "UNIQUE_VALUE" + ], + "type": "string" + }, + "SimpleClusterMarker": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "SimpleNumericalAggregationFunction": { + "enum": [ + "SUM", + "AVERAGE", + "MIN", + "MAX", + "COUNT", + "DISTINCT_COUNT", + "VAR", + "VARP", + "STDEV", + "STDEVP", + "MEDIAN" + ], + "type": "string" + }, + "SimpleTotalAggregationFunction": { + "enum": [ + "DEFAULT", + "SUM", + "AVERAGE", + "MIN", + "MAX", + "NONE" + ], + "type": "string" + }, + "SingleAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxisOptions": { + "$ref": "#/definitions/YAxisOptions" + } + }, + "type": "object" + }, + "SingleYAxisOption": { + "enum": [ + "PRIMARY_Y_AXIS" + ], + "type": "string" + }, + "SliderControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "SmallMultiplesAxisPlacement": { + "enum": [ + "OUTSIDE", + "INSIDE" + ], + "type": "string" + }, + "SmallMultiplesAxisProperties": { + "additionalProperties": false, + "properties": { + "Placement": { + "$ref": "#/definitions/SmallMultiplesAxisPlacement" + }, + "Scale": { + "$ref": "#/definitions/SmallMultiplesAxisScale" + } + }, + "type": "object" + }, + "SmallMultiplesAxisScale": { + "enum": [ + "SHARED", + "INDEPENDENT" + ], + "type": "string" + }, + "SmallMultiplesOptions": { + "additionalProperties": false, + "properties": { + "MaxVisibleColumns": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "MaxVisibleRows": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "PanelConfiguration": { + "$ref": "#/definitions/PanelConfiguration" + }, + "XAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + }, + "YAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + } + }, + "type": "object" + }, + "SortDirection": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "Spacing": { + "additionalProperties": false, + "properties": { + "Bottom": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Left": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Right": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Top": { + "description": "String based length that is composed of value and unit", + "type": "string" + } + }, + "type": "object" + }, + "SpecialValue": { + "enum": [ + "EMPTY", + "NULL", + "OTHER" + ], + "type": "string" + }, + "StringDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "StringFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "StringParameter": { + "additionalProperties": false, + "description": "

A string parameter.

", + "properties": { + "Name": { + "description": "

A display name for a string parameter.

", + "pattern": "\\S", + "type": "string" + }, + "Values": { + "description": "

The values of a string parameter.

", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "StringParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/StringDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/StringValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "StringValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "StyledCellType": { + "enum": [ + "TOTAL", + "METRIC_HEADER", + "VALUE" + ], + "type": "string" + }, + "SubtotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FieldLevel": { + "$ref": "#/definitions/PivotTableSubtotalLevel" + }, + "FieldLevelOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldSubtotalOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "StyleTargets": { + "items": { + "$ref": "#/definitions/TableStyleTarget" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "TableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableBorderOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/TableBorderStyle" + }, + "Thickness": { + "maximum": 4, + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "TableBorderStyle": { + "enum": [ + "NONE", + "SOLID" + ], + "type": "string" + }, + "TableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableCellImageScalingConfiguration": { + "enum": [ + "FIT_TO_CELL_HEIGHT", + "FIT_TO_CELL_WIDTH", + "DO_NOT_SCALE" + ], + "type": "string" + }, + "TableCellImageSizingConfiguration": { + "additionalProperties": false, + "properties": { + "TableCellImageScalingConfiguration": { + "$ref": "#/definitions/TableCellImageScalingConfiguration" + } + }, + "type": "object" + }, + "TableCellStyle": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Border": { + "$ref": "#/definitions/GlobalTableBorderOptions" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Height": { + "maximum": 500, + "minimum": 8, + "type": "number" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "TextWrap": { + "$ref": "#/definitions/TextWrap" + }, + "VerticalTextAlignment": { + "$ref": "#/definitions/VerticalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/TableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/TableCellConditionalFormatting" + }, + "Row": { + "$ref": "#/definitions/TableRowConditionalFormatting" + } + }, + "type": "object" + }, + "TableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/TableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/TablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TableSortConfiguration" + }, + "TableInlineVisualizations": { + "items": { + "$ref": "#/definitions/TableInlineVisualization" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TableOptions": { + "$ref": "#/definitions/TableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/TotalOptions" + } + }, + "type": "object" + }, + "TableFieldCustomIconContent": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/TableFieldIconSetType" + } + }, + "type": "object" + }, + "TableFieldCustomTextContent": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "FontConfiguration" + ], + "type": "object" + }, + "TableFieldIconSetType": { + "enum": [ + "LINK" + ], + "type": "string" + }, + "TableFieldImageConfiguration": { + "additionalProperties": false, + "properties": { + "SizingOptions": { + "$ref": "#/definitions/TableCellImageSizingConfiguration" + } + }, + "type": "object" + }, + "TableFieldLinkConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/TableFieldLinkContentConfiguration" + }, + "Target": { + "$ref": "#/definitions/URLTargetConfiguration" + } + }, + "required": [ + "Content", + "Target" + ], + "type": "object" + }, + "TableFieldLinkContentConfiguration": { + "additionalProperties": false, + "properties": { + "CustomIconContent": { + "$ref": "#/definitions/TableFieldCustomIconContent" + }, + "CustomTextContent": { + "$ref": "#/definitions/TableFieldCustomTextContent" + } + }, + "type": "object" + }, + "TableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "URLStyling": { + "$ref": "#/definitions/TableFieldURLConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableFieldOptions": { + "additionalProperties": false, + "properties": { + "Order": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "PinnedFieldOptions": { + "$ref": "#/definitions/TablePinnedFieldOptions" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/TableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableFieldURLConfiguration": { + "additionalProperties": false, + "properties": { + "ImageConfiguration": { + "$ref": "#/definitions/TableFieldImageConfiguration" + }, + "LinkConfiguration": { + "$ref": "#/definitions/TableFieldLinkConfiguration" + } + }, + "type": "object" + }, + "TableFieldWells": { + "additionalProperties": false, + "properties": { + "TableAggregatedFieldWells": { + "$ref": "#/definitions/TableAggregatedFieldWells" + }, + "TableUnaggregatedFieldWells": { + "$ref": "#/definitions/TableUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "TableInlineVisualization": { + "additionalProperties": false, + "properties": { + "DataBars": { + "$ref": "#/definitions/DataBarsOptions" + } + }, + "type": "object" + }, + "TableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "HeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Orientation": { + "$ref": "#/definitions/TableOrientation" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + } + }, + "type": "object" + }, + "TableOrientation": { + "enum": [ + "VERTICAL", + "HORIZONTAL" + ], + "type": "string" + }, + "TablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TablePinnedFieldOptions": { + "additionalProperties": false, + "properties": { + "PinnedLeftFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 201, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableRowConditionalFormatting": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TableSideBorderOptions": { + "additionalProperties": false, + "properties": { + "Bottom": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerHorizontal": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerVertical": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Left": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Right": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Top": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "TableSortConfiguration": { + "additionalProperties": false, + "properties": { + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + }, + "RowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableStyleTarget": { + "additionalProperties": false, + "properties": { + "CellType": { + "$ref": "#/definitions/StyledCellType" + } + }, + "required": [ + "CellType" + ], + "type": "object" + }, + "TableTotalsPlacement": { + "enum": [ + "START", + "END", + "AUTO" + ], + "type": "string" + }, + "TableTotalsScrollStatus": { + "enum": [ + "PINNED", + "SCROLLED" + ], + "type": "string" + }, + "TableUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/UnaggregatedField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/TableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TargetVisualOptions": { + "enum": [ + "ALL_VISUALS" + ], + "type": "string" + }, + "TextAreaControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TextControlPlaceholderOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TextFieldControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextWrap": { + "enum": [ + "NONE", + "WRAP" + ], + "type": "string" + }, + "ThousandSeparatorOptions": { + "additionalProperties": false, + "properties": { + "Symbol": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TimeBasedForecastProperties": { + "additionalProperties": false, + "properties": { + "LowerBoundary": { + "default": null, + "type": "number" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "UpperBoundary": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "TimeEqualityFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Value": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "Column", + "FilterId" + ], + "type": "object" + }, + "TimeGranularity": { + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND", + "MILLISECOND" + ], + "type": "string" + }, + "TimeRangeDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "RangeMaximum": { + "format": "date-time", + "type": "string" + }, + "RangeMinimum": { + "format": "date-time", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "RangeMaximum", + "RangeMinimum", + "TimeGranularity" + ], + "type": "object" + }, + "TimeRangeFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "RangeMinimumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "TimeRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValue": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "TooltipItem": { + "additionalProperties": false, + "properties": { + "ColumnTooltipItem": { + "$ref": "#/definitions/ColumnTooltipItem" + }, + "FieldTooltipItem": { + "$ref": "#/definitions/FieldTooltipItem" + } + }, + "type": "object" + }, + "TooltipOptions": { + "additionalProperties": false, + "properties": { + "FieldBasedTooltip": { + "$ref": "#/definitions/FieldBasedTooltip" + }, + "SelectedTooltipType": { + "$ref": "#/definitions/SelectedTooltipType" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TooltipTarget": { + "enum": [ + "BOTH", + "BAR", + "LINE" + ], + "type": "string" + }, + "TooltipTitleType": { + "enum": [ + "NONE", + "PRIMARY_VALUE" + ], + "type": "string" + }, + "TopBottomComputationType": { + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "TopBottomFilter": { + "additionalProperties": false, + "properties": { + "AggregationSortConfigurations": { + "items": { + "$ref": "#/definitions/AggregationSortConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Limit": { + "default": null, + "type": "number" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AggregationSortConfigurations", + "Column", + "FilterId" + ], + "type": "object" + }, + "TopBottomMoversComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MoverSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Name": { + "type": "string" + }, + "SortOrder": { + "$ref": "#/definitions/TopBottomSortOrder" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomRankedComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResultSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomSortOrder": { + "enum": [ + "PERCENT_DIFFERENCE", + "ABSOLUTE_DIFFERENCE" + ], + "type": "string" + }, + "TotalAggregationComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "TotalAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleTotalAggregationFunction": { + "$ref": "#/definitions/SimpleTotalAggregationFunction" + } + }, + "type": "object" + }, + "TotalAggregationOption": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TotalAggregationFunction": { + "$ref": "#/definitions/TotalAggregationFunction" + } + }, + "required": [ + "FieldId", + "TotalAggregationFunction" + ], + "type": "object" + }, + "TotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TreeMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Groups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Sizes": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TreeMapFieldWells" + }, + "GroupLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SizeLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TreeMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "TreeMapFieldWells": { + "additionalProperties": false, + "properties": { + "TreeMapAggregatedFieldWells": { + "$ref": "#/definitions/TreeMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "TreeMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "TreeMapSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TreeMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "TrendArrowOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "URLTargetConfiguration": { + "enum": [ + "NEW_TAB", + "NEW_WINDOW", + "SAME_TAB" + ], + "type": "string" + }, + "UnaggregatedField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "UniqueValuesComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ValidationStrategy": { + "additionalProperties": false, + "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", + "properties": { + "Mode": { + "$ref": "#/definitions/ValidationStrategyMode" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "ValidationStrategyMode": { + "enum": [ + "STRICT", + "LENIENT" + ], + "type": "string" + }, + "ValueWhenUnsetOption": { + "enum": [ + "RECOMMENDED_VALUE", + "NULL" + ], + "type": "string" + }, + "VerticalTextAlignment": { + "enum": [ + "TOP", + "MIDDLE", + "BOTTOM", + "AUTO" + ], + "type": "string" + }, + "Visibility": { + "enum": [ + "HIDDEN", + "VISIBLE" + ], + "type": "string" + }, + "VisibleRangeOptions": { + "additionalProperties": false, + "properties": { + "PercentRange": { + "$ref": "#/definitions/PercentVisibleRange" + } + }, + "type": "object" + }, + "Visual": { + "additionalProperties": false, + "properties": { + "BarChartVisual": { + "$ref": "#/definitions/BarChartVisual" + }, + "BoxPlotVisual": { + "$ref": "#/definitions/BoxPlotVisual" + }, + "ComboChartVisual": { + "$ref": "#/definitions/ComboChartVisual" + }, + "CustomContentVisual": { + "$ref": "#/definitions/CustomContentVisual" + }, + "EmptyVisual": { + "$ref": "#/definitions/EmptyVisual" + }, + "FilledMapVisual": { + "$ref": "#/definitions/FilledMapVisual" + }, + "FunnelChartVisual": { + "$ref": "#/definitions/FunnelChartVisual" + }, + "GaugeChartVisual": { + "$ref": "#/definitions/GaugeChartVisual" + }, + "GeospatialMapVisual": { + "$ref": "#/definitions/GeospatialMapVisual" + }, + "HeatMapVisual": { + "$ref": "#/definitions/HeatMapVisual" + }, + "HistogramVisual": { + "$ref": "#/definitions/HistogramVisual" + }, + "InsightVisual": { + "$ref": "#/definitions/InsightVisual" + }, + "KPIVisual": { + "$ref": "#/definitions/KPIVisual" + }, + "LineChartVisual": { + "$ref": "#/definitions/LineChartVisual" + }, + "PieChartVisual": { + "$ref": "#/definitions/PieChartVisual" + }, + "PivotTableVisual": { + "$ref": "#/definitions/PivotTableVisual" + }, + "RadarChartVisual": { + "$ref": "#/definitions/RadarChartVisual" + }, + "SankeyDiagramVisual": { + "$ref": "#/definitions/SankeyDiagramVisual" + }, + "ScatterPlotVisual": { + "$ref": "#/definitions/ScatterPlotVisual" + }, + "TableVisual": { + "$ref": "#/definitions/TableVisual" + }, + "TreeMapVisual": { + "$ref": "#/definitions/TreeMapVisual" + }, + "WaterfallVisual": { + "$ref": "#/definitions/WaterfallVisual" + }, + "WordCloudVisual": { + "$ref": "#/definitions/WordCloudVisual" + } + }, + "type": "object" + }, + "VisualAxisSortOption": { + "additionalProperties": false, + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "VisualCustomAction": { + "additionalProperties": false, + "properties": { + "ActionOperations": { + "items": { + "$ref": "#/definitions/VisualCustomActionOperation" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "CustomActionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "Trigger": { + "$ref": "#/definitions/VisualCustomActionTrigger" + } + }, + "required": [ + "ActionOperations", + "CustomActionId", + "Name", + "Trigger" + ], + "type": "object" + }, + "VisualCustomActionOperation": { + "additionalProperties": false, + "properties": { + "FilterOperation": { + "$ref": "#/definitions/CustomActionFilterOperation" + }, + "NavigationOperation": { + "$ref": "#/definitions/CustomActionNavigationOperation" + }, + "SetParametersOperation": { + "$ref": "#/definitions/CustomActionSetParametersOperation" + }, + "URLOperation": { + "$ref": "#/definitions/CustomActionURLOperation" + } + }, + "type": "object" + }, + "VisualCustomActionTrigger": { + "enum": [ + "DATA_POINT_CLICK", + "DATA_POINT_MENU" + ], + "type": "string" + }, + "VisualMenuOption": { + "additionalProperties": false, + "properties": { + "AvailabilityStatus": { + "$ref": "#/definitions/DashboardBehavior" + } + }, + "type": "object" + }, + "VisualPalette": { + "additionalProperties": false, + "properties": { + "ChartColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "ColorMap": { + "items": { + "$ref": "#/definitions/DataPathColor" + }, + "maxItems": 5000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "VisualSubtitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/LongFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "VisualTitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/ShortFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "WaterfallChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Breakdowns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Categories": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, + "WaterfallChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WaterfallChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/WaterfallChartSortConfiguration" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WaterfallChartOptions": { + "$ref": "#/definitions/WaterfallChartOptions" + } + }, + "type": "object" + }, + "WaterfallChartFieldWells": { + "additionalProperties": false, + "properties": { + "WaterfallChartAggregatedFieldWells": { + "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartOptions": { + "additionalProperties": false, + "properties": { + "TotalBarLabel": { + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "BreakdownItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WaterfallChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WhatIfPointScenario": { + "additionalProperties": false, + "properties": { + "Date": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Date", + "Value" + ], + "type": "object" + }, + "WhatIfRangeScenario": { + "additionalProperties": false, + "properties": { + "EndDate": { + "format": "date-time", + "type": "string" + }, + "StartDate": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "EndDate", + "StartDate", + "Value" + ], + "type": "object" + }, + "WidgetStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "WordCloudAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WordCloudFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/WordCloudSortConfiguration" + }, + "WordCloudOptions": { + "$ref": "#/definitions/WordCloudOptions" + } + }, + "type": "object" + }, + "WordCloudCloudLayout": { + "enum": [ + "FLUID", + "NORMAL" + ], + "type": "string" + }, + "WordCloudFieldWells": { + "additionalProperties": false, + "properties": { + "WordCloudAggregatedFieldWells": { + "$ref": "#/definitions/WordCloudAggregatedFieldWells" + } + }, + "type": "object" + }, + "WordCloudOptions": { + "additionalProperties": false, + "properties": { + "CloudLayout": { + "$ref": "#/definitions/WordCloudCloudLayout" + }, + "MaximumStringLength": { + "maximum": 100, + "minimum": 1, + "type": "number" + }, + "WordCasing": { + "$ref": "#/definitions/WordCloudWordCasing" + }, + "WordOrientation": { + "$ref": "#/definitions/WordCloudWordOrientation" + }, + "WordPadding": { + "$ref": "#/definitions/WordCloudWordPadding" + }, + "WordScaling": { + "$ref": "#/definitions/WordCloudWordScaling" + } + }, + "type": "object" + }, + "WordCloudSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WordCloudChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WordCloudWordCasing": { + "enum": [ + "LOWER_CASE", + "EXISTING_CASE" + ], + "type": "string" + }, + "WordCloudWordOrientation": { + "enum": [ + "HORIZONTAL", + "HORIZONTAL_AND_VERTICAL" + ], + "type": "string" + }, + "WordCloudWordPadding": { + "enum": [ + "NONE", + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "WordCloudWordScaling": { + "enum": [ + "EMPHASIZE", + "NORMAL" + ], + "type": "string" + }, + "YAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxis": { + "$ref": "#/definitions/SingleYAxisOption" + } + }, + "required": [ + "YAxis" + ], + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::Dashboard Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:DescribeDashboard", + "quicksight:DescribeDashboardPermissions", + "quicksight:CreateDashboard", + "quicksight:DescribeTemplate", + "quicksight:DescribeTheme", + "quicksight:PassDataSet", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeDashboard", + "quicksight:DeleteDashboard" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + } + }, + "required": [ + "AwsAccountId" + ] + }, + "permissions": [ + "quicksight:ListDashboards" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeDashboard", + "quicksight:DescribeDashboardPermissions", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeDashboard", + "quicksight:DescribeDashboardPermissions", + "quicksight:UpdateDashboard", + "quicksight:UpdateDashboardLinks", + "quicksight:UpdateDashboardPermissions", + "quicksight:UpdateDashboardPublishedVersion", + "quicksight:DescribeTemplate", + "quicksight:DescribeTheme", + "quicksight:PassDataSet", + "quicksight:CreateFolderMembership", + "quicksight:DeleteFolderMembership", + "quicksight:ListFoldersForResource", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/DashboardId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "CreatedTime": { + "description": "

The time that this dashboard was created.

", + "format": "date-time", + "type": "string" + }, + "DashboardId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "DashboardPublishOptions": { + "$ref": "#/definitions/DashboardPublishOptions" + }, + "Definition": { + "$ref": "#/definitions/DashboardVersionDefinition" + }, + "LastPublishedTime": { + "description": "

The last time that this dashboard was published.

", + "format": "date-time", + "type": "string" + }, + "LastUpdatedTime": { + "description": "

The last time that this dashboard was updated.

", + "format": "date-time", + "type": "string" + }, + "LinkEntities": { + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "LinkSharingConfiguration": { + "$ref": "#/definitions/LinkSharingConfiguration" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/Parameters" + }, + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "SourceEntity": { + "$ref": "#/definitions/DashboardSourceEntity" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "ThemeArn": { + "type": "string" + }, + "ValidationStrategy": { + "$ref": "#/definitions/ValidationStrategy" + }, + "Version": { + "$ref": "#/definitions/DashboardVersion" + }, + "VersionDescription": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastPublishedTime", + "/properties/LastUpdatedTime", + "/properties/Version" + ], + "required": [ + "AwsAccountId", + "DashboardId", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "typeName": "AWS::QuickSight::Dashboard", + "writeOnlyProperties": [ + "/properties/DashboardPublishOptions", + "/properties/Definition", + "/properties/LinkSharingConfiguration", + "/properties/Parameters", + "/properties/SourceEntity", + "/properties/ThemeArn", + "/properties/VersionDescription", + "/properties/ValidationStrategy" + ] +} diff --git a/schema/aws-quicksight-dataset.json b/schema/aws-quicksight-dataset.json index 18b70a9..b76137f 100644 --- a/schema/aws-quicksight-dataset.json +++ b/schema/aws-quicksight-dataset.json @@ -1,1563 +1,1572 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/DataSetId" - ], - "definitions": { - "CalculatedColumn": { - "additionalProperties": false, - "description": "

A calculated column for a dataset.

", - "properties": { - "ColumnId": { - "description": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ColumnName": { - "description": "

Column name.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Expression": { - "description": "

An expression that defines the calculated column.

", - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ColumnId", - "ColumnName", - "Expression" - ], - "type": "object" - }, - "CastColumnTypeOperation": { - "additionalProperties": false, - "description": "

A transform operation that casts a column to a different type.

", - "properties": { - "ColumnName": { - "description": "

Column name.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Format": { - "description": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

", - "maxLength": 32, - "minLength": 0, - "type": "string" - }, - "NewColumnType": { - "$ref": "#/definitions/ColumnDataType" - }, - "SubType": { - "$ref": "#/definitions/ColumnDataSubType" - } - }, - "required": [ - "ColumnName", - "NewColumnType" - ], - "type": "object" - }, - "ColumnDataSubType": { - "enum": [ - "FLOAT", - "FIXED" - ], - "type": "string" - }, - "ColumnDataType": { - "enum": [ - "STRING", - "INTEGER", - "DECIMAL", - "DATETIME" - ], - "type": "string" - }, - "ColumnDescription": { - "additionalProperties": false, - "description": "

Metadata that contains a description for a column.

", - "properties": { - "Text": { - "description": "

The text of a description for a column.

", - "maxLength": 500, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "ColumnGroup": { - "additionalProperties": false, - "description": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

", - "properties": { - "GeoSpatialColumnGroup": { - "$ref": "#/definitions/GeoSpatialColumnGroup" - } - }, - "type": "object" - }, - "ColumnLevelPermissionRule": { - "additionalProperties": false, - "description": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

", - "properties": { - "ColumnNames": { - "description": "

An array of column names.

", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "Principals": { - "description": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

", - "items": { - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "ColumnTag": { - "additionalProperties": false, - "description": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

", - "properties": { - "ColumnDescription": { - "$ref": "#/definitions/ColumnDescription" - }, - "ColumnGeographicRole": { - "$ref": "#/definitions/GeoSpatialDataRole" - } - }, - "type": "object" - }, - "ColumnTagName": { - "enum": [ - "COLUMN_GEOGRAPHIC_ROLE", - "COLUMN_DESCRIPTION" - ], - "type": "string" - }, - "CreateColumnsOperation": { - "additionalProperties": false, - "description": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

", - "properties": { - "Columns": { - "description": "

Calculated columns to create.

", - "items": { - "$ref": "#/definitions/CalculatedColumn" - }, - "maxItems": 128, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Columns" - ], - "type": "object" - }, - "CustomSql": { - "additionalProperties": false, - "description": "

A physical table type built from the results of the custom SQL query.

", - "properties": { - "Columns": { - "description": "

The column schema from the SQL query result set.

", - "items": { - "$ref": "#/definitions/InputColumn" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - }, - "DataSourceArn": { - "description": "

The Amazon Resource Name (ARN) of the data source.

", - "type": "string" - }, - "Name": { - "description": "

A display name for the SQL query result.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SqlQuery": { - "description": "

The SQL query.

", - "maxLength": 168000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "DataSourceArn", - "Name", - "SqlQuery" - ], - "type": "object" - }, - "DataSetImportMode": { - "enum": [ - "SPICE", - "DIRECT_QUERY" - ], - "type": "string" - }, - "DataSetRefreshProperties": { - "additionalProperties": false, - "description": "

The refresh properties of a dataset.

", - "properties": { - "RefreshConfiguration": { - "$ref": "#/definitions/RefreshConfiguration" - } - }, - "required": [ - "RefreshConfiguration" - ], - "type": "object" - }, - "DataSetUsageConfiguration": { - "additionalProperties": false, - "description": "

The usage configuration to apply to child datasets that reference this dataset as a source.

", - "properties": { - "DisableUseAsDirectQuerySource": { - "default": false, - "description": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

", - "type": "boolean" - }, - "DisableUseAsImportedSource": { - "default": false, - "description": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

", - "type": "boolean" - } - }, - "type": "object" - }, - "DatasetParameter": { - "additionalProperties": false, - "description": "

A dataset parameter.

", - "properties": { - "DateTimeDatasetParameter": { - "$ref": "#/definitions/DateTimeDatasetParameter" - }, - "DecimalDatasetParameter": { - "$ref": "#/definitions/DecimalDatasetParameter" - }, - "IntegerDatasetParameter": { - "$ref": "#/definitions/IntegerDatasetParameter" - }, - "StringDatasetParameter": { - "$ref": "#/definitions/StringDatasetParameter" - } - }, - "type": "object" - }, - "DatasetParameterValueType": { - "enum": [ - "MULTI_VALUED", - "SINGLE_VALUED" - ], - "type": "string" - }, - "DateTimeDatasetParameter": { - "additionalProperties": false, - "description": "

A date time parameter for a dataset.

", - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DateTimeDatasetParameterDefaultValues" - }, - "Id": { - "description": "

An identifier for the parameter that is created in the dataset.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "

The name of the date time parameter that is created in the dataset.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "ValueType": { - "$ref": "#/definitions/DatasetParameterValueType" - } - }, - "required": [ - "Id", - "Name", - "ValueType" - ], - "type": "object" - }, - "DateTimeDatasetParameterDefaultValues": { - "additionalProperties": false, - "description": "

The default values of a date time parameter.

", - "properties": { - "StaticValues": { - "description": "

A list of static default values for a given date time parameter.

", - "items": { - "description": "

The default value for the date time parameter.

", - "type": "string" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DecimalDatasetParameter": { - "additionalProperties": false, - "description": "

A decimal parameter for a dataset.

", - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DecimalDatasetParameterDefaultValues" - }, - "Id": { - "description": "

An identifier for the decimal parameter created in the dataset.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "

The name of the decimal parameter that is created in the dataset.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ValueType": { - "$ref": "#/definitions/DatasetParameterValueType" - } - }, - "required": [ - "Id", - "Name", - "ValueType" - ], - "type": "object" - }, - "DecimalDatasetParameterDefaultValues": { - "additionalProperties": false, - "description": "

The default values of a decimal parameter.

", - "properties": { - "StaticValues": { - "description": "

A list of static default values for a given decimal parameter.

", - "items": { - "default": 0, - "description": "

The default value for the decimal parameter.

", - "type": "number" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FieldFolder": { - "additionalProperties": false, - "description": "

A FieldFolder element is a folder that contains fields and nested subfolders.

", - "properties": { - "Columns": { - "description": "

A folder has a list of columns. A column can only be in one folder.

", - "items": { - "type": "string" - }, - "maxItems": 5000, - "minItems": 0, - "type": "array" - }, - "Description": { - "description": "

The description for a field folder.

", - "maxLength": 500, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "FieldFolderMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/FieldFolder" - } - }, - "type": "object" - }, - "FileFormat": { - "enum": [ - "CSV", - "TSV", - "CLF", - "ELF", - "XLSX", - "JSON" - ], - "type": "string" - }, - "FilterOperation": { - "additionalProperties": false, - "description": "

A transform operation that filters rows based on a condition.

", - "properties": { - "ConditionExpression": { - "description": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConditionExpression" - ], - "type": "object" - }, - "GeoSpatialColumnGroup": { - "additionalProperties": false, - "description": "

Geospatial column group that denotes a hierarchy.

", - "properties": { - "Columns": { - "description": "

Columns in this hierarchy.

", - "items": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - }, - "CountryCode": { - "$ref": "#/definitions/GeoSpatialCountryCode" - }, - "Name": { - "description": "

A display name for the hierarchy.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "Name" - ], - "type": "object" - }, - "GeoSpatialCountryCode": { - "enum": [ - "US" - ], - "type": "string" - }, - "GeoSpatialDataRole": { - "enum": [ - "COUNTRY", - "STATE", - "COUNTY", - "CITY", - "POSTCODE", - "LONGITUDE", - "LATITUDE", - "POLITICAL1", - "CENSUS_TRACT", - "CENSUS_BLOCK_GROUP", - "CENSUS_BLOCK" - ], - "type": "string" - }, - "IncrementalRefresh": { - "additionalProperties": false, - "description": "

The incremental refresh configuration for a dataset.

", - "properties": { - "LookbackWindow": { - "$ref": "#/definitions/LookbackWindow" - } - }, - "required": [ - "LookbackWindow" - ], - "type": "object" - }, - "IngestionWaitPolicy": { - "additionalProperties": false, - "description": "

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

", - "properties": { - "IngestionWaitTimeInHours": { - "default": 36, - "description": "

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.\n Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

", - "maximum": 36, - "minimum": 1, - "type": "number" - }, - "WaitForSpiceIngestion": { - "default": true, - "description": "

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).\n Applicable only when DataSetImportMode mode is set to SPICE.

", - "type": "boolean" - } - }, - "type": "object" - }, - "InputColumn": { - "additionalProperties": false, - "description": "

Metadata for a column that is used as the input of a transform operation.

", - "properties": { - "Name": { - "description": "

The name of this column in the underlying data source.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "SubType": { - "$ref": "#/definitions/ColumnDataSubType" - }, - "Type": { - "$ref": "#/definitions/InputColumnDataType" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "InputColumnDataType": { - "enum": [ - "STRING", - "INTEGER", - "DECIMAL", - "DATETIME", - "BIT", - "BOOLEAN", - "JSON" - ], - "type": "string" - }, - "IntegerDatasetParameter": { - "additionalProperties": false, - "description": "

An integer parameter for a dataset.

", - "properties": { - "DefaultValues": { - "$ref": "#/definitions/IntegerDatasetParameterDefaultValues" - }, - "Id": { - "description": "

An identifier for the integer parameter created in the dataset.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "

The name of the integer parameter that is created in the dataset.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ValueType": { - "$ref": "#/definitions/DatasetParameterValueType" - } - }, - "required": [ - "Id", - "Name", - "ValueType" - ], - "type": "object" - }, - "IntegerDatasetParameterDefaultValues": { - "additionalProperties": false, - "description": "

The default values of an integer parameter.

", - "properties": { - "StaticValues": { - "description": "

A list of static default values for a given integer parameter.

", - "items": { - "default": 0, - "description": "

The default value for the integer parameter.

", - "type": "number" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "JoinInstruction": { - "additionalProperties": false, - "description": "

The instructions associated with a join.

", - "properties": { - "LeftJoinKeyProperties": { - "$ref": "#/definitions/JoinKeyProperties" - }, - "LeftOperand": { - "description": "

The operand on the left side of a join.

", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-]*$", - "type": "string" - }, - "OnClause": { - "description": "

The join instructions provided in the ON clause of a join.

", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "RightJoinKeyProperties": { - "$ref": "#/definitions/JoinKeyProperties" - }, - "RightOperand": { - "description": "

The operand on the right side of a join.

", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-]*$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/JoinType" - } - }, - "required": [ - "LeftOperand", - "OnClause", - "RightOperand", - "Type" - ], - "type": "object" - }, - "JoinKeyProperties": { - "additionalProperties": false, - "description": "

Properties associated with the columns participating in a join.

", - "properties": { - "UniqueKey": { - "description": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

", - "type": "boolean" - } - }, - "type": "object" - }, - "JoinType": { - "enum": [ - "INNER", - "OUTER", - "LEFT", - "RIGHT" - ], - "type": "string" - }, - "LogicalTable": { - "additionalProperties": false, - "description": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

", - "properties": { - "Alias": { - "description": "

A display name for the logical table.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "DataTransforms": { - "description": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

", - "items": { - "$ref": "#/definitions/TransformOperation" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - }, - "Source": { - "$ref": "#/definitions/LogicalTableSource" - } - }, - "required": [ - "Alias", - "Source" - ], - "type": "object" - }, - "LogicalTableMap": { - "additionalProperties": false, - "maxProperties": 64, - "minProperties": 1, - "patternProperties": { - "^[0-9a-zA-Z-]*$": { - "$ref": "#/definitions/LogicalTable" - } - }, - "type": "object" - }, - "LogicalTableSource": { - "additionalProperties": false, - "description": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

", - "properties": { - "DataSetArn": { - "description": "

The Amazon Resource Number (ARN) of the parent dataset.

", - "type": "string" - }, - "JoinInstruction": { - "$ref": "#/definitions/JoinInstruction" - }, - "PhysicalTableId": { - "description": "

Physical table ID.

", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9a-zA-Z-]*$", - "type": "string" - } - }, - "type": "object" - }, - "LookbackWindow": { - "additionalProperties": false, - "description": "

The lookback window setup of an incremental refresh configuration.

", - "properties": { - "ColumnName": { - "description": "

The name of the lookback window column.

", - "type": "string" - }, - "Size": { - "default": 0, - "description": "

The lookback window column size.

", - "minimum": 1, - "type": "number" - }, - "SizeUnit": { - "$ref": "#/definitions/LookbackWindowSizeUnit" - } - }, - "required": [ - "ColumnName", - "Size", - "SizeUnit" - ], - "type": "object" - }, - "LookbackWindowSizeUnit": { - "enum": [ - "HOUR", - "DAY", - "WEEK" - ], - "type": "string" - }, - "NewDefaultValues": { - "additionalProperties": false, - "description": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

", - "properties": { - "DateTimeStaticValues": { - "description": "

A list of static default values for a given date time parameter.

", - "items": { - "description": "

The default value for the date time parameter.

", - "type": "string" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - }, - "DecimalStaticValues": { - "description": "

A list of static default values for a given decimal parameter.

", - "items": { - "default": 0, - "description": "

The default value for the decimal parameter.

", - "type": "number" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - }, - "IntegerStaticValues": { - "description": "

A list of static default values for a given integer parameter.

", - "items": { - "default": 0, - "description": "

The default value for the integer parameter.

", - "type": "number" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - }, - "StringStaticValues": { - "description": "

A list of static default values for a given string parameter.

", - "items": { - "description": "

The default value for the string parameter.

", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "OutputColumn": { - "additionalProperties": false, - "description": "

Output column.

", - "properties": { - "Description": { - "description": "

A description for a column.

", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "Name": { - "description": "

The display name of the column..

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "SubType": { - "$ref": "#/definitions/ColumnDataSubType" - }, - "Type": { - "$ref": "#/definitions/ColumnDataType" - } - }, - "type": "object" - }, - "OverrideDatasetParameterOperation": { - "additionalProperties": false, - "description": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

", - "properties": { - "NewDefaultValues": { - "$ref": "#/definitions/NewDefaultValues" - }, - "NewParameterName": { - "description": "

The new name for the parameter.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterName": { - "description": "

The name of the parameter to be overridden with different values.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "ParameterName" - ], - "type": "object" - }, - "PhysicalTable": { - "additionalProperties": false, - "description": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

", - "properties": { - "CustomSql": { - "$ref": "#/definitions/CustomSql" - }, - "RelationalTable": { - "$ref": "#/definitions/RelationalTable" - }, - "S3Source": { - "$ref": "#/definitions/S3Source" - } - }, - "type": "object" - }, - "PhysicalTableMap": { - "additionalProperties": false, - "maxProperties": 32, - "minProperties": 0, - "patternProperties": { - "^[0-9a-zA-Z-]*$": { - "$ref": "#/definitions/PhysicalTable" - } - }, - "type": "object" - }, - "ProjectOperation": { - "additionalProperties": false, - "description": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

", - "properties": { - "ProjectedColumns": { - "description": "

Projected columns.

", - "items": { - "type": "string" - }, - "maxItems": 2000, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ProjectedColumns" - ], - "type": "object" - }, - "RefreshConfiguration": { - "additionalProperties": false, - "description": "

The refresh configuration of a dataset.

", - "properties": { - "IncrementalRefresh": { - "$ref": "#/definitions/IncrementalRefresh" - } - }, - "required": [ - "IncrementalRefresh" - ], - "type": "object" - }, - "RelationalTable": { - "additionalProperties": false, - "description": "

A physical table type for relational data sources.

", - "properties": { - "Catalog": { - "description": "

The catalog associated with a table.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "DataSourceArn": { - "description": "

The Amazon Resource Name (ARN) for the data source.

", - "type": "string" - }, - "InputColumns": { - "description": "

The column schema of the table.

", - "items": { - "$ref": "#/definitions/InputColumn" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - }, - "Name": { - "description": "

The name of the relational table.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Schema": { - "description": "

The schema name. This name applies to certain relational database engines.

", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "DataSourceArn", - "InputColumns", - "Name" - ], - "type": "object" - }, - "RenameColumnOperation": { - "additionalProperties": false, - "description": "

A transform operation that renames a column.

", - "properties": { - "ColumnName": { - "description": "

The name of the column to be renamed.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "NewColumnName": { - "description": "

The new name for the column.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ColumnName", - "NewColumnName" - ], - "type": "object" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "RowLevelPermissionDataSet": { - "additionalProperties": false, - "description": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", - "type": "string" - }, - "FormatVersion": { - "$ref": "#/definitions/RowLevelPermissionFormatVersion" - }, - "Namespace": { - "description": "

The namespace associated with the dataset that contains permissions for RLS.

", - "maxLength": 64, - "minLength": 0, - "pattern": "^[a-zA-Z0-9._-]*$", - "type": "string" - }, - "PermissionPolicy": { - "$ref": "#/definitions/RowLevelPermissionPolicy" - }, - "Status": { - "$ref": "#/definitions/Status" - } - }, - "required": [ - "Arn", - "PermissionPolicy" - ], - "type": "object" - }, - "RowLevelPermissionFormatVersion": { - "enum": [ - "VERSION_1", - "VERSION_2" - ], - "type": "string" - }, - "RowLevelPermissionPolicy": { - "enum": [ - "GRANT_ACCESS", - "DENY_ACCESS" - ], - "type": "string" - }, - "RowLevelPermissionTagConfiguration": { - "additionalProperties": false, - "description": "

The configuration of tags on a dataset to set row-level security.

", - "properties": { - "Status": { - "$ref": "#/definitions/Status" - }, - "TagRuleConfigurations": { - "description": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

", - "items": { - "items": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "TagRules": { - "description": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", - "items": { - "$ref": "#/definitions/RowLevelPermissionTagRule" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "TagRules" - ], - "type": "object" - }, - "RowLevelPermissionTagRule": { - "additionalProperties": false, - "description": "

A set of rules associated with a tag.

", - "properties": { - "ColumnName": { - "description": "

The column name that a tag key is assigned to.

", - "type": "string" - }, - "MatchAllValue": { - "description": "

A string that you want to use to filter by all the values in a column in the dataset and don\u2019t want to list the values one by one. For example, you can use an asterisk as your match all value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "TagKey": { - "description": "

The unique key for a tag.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "TagMultiValueDelimiter": { - "description": "

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

", - "maxLength": 10, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "ColumnName", - "TagKey" - ], - "type": "object" - }, - "S3Source": { - "additionalProperties": false, - "description": "

A physical table type for an S3 data source.

", - "properties": { - "DataSourceArn": { - "description": "

The Amazon Resource Name (ARN) for the data source.

", - "type": "string" - }, - "InputColumns": { - "description": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", - "items": { - "$ref": "#/definitions/InputColumn" - }, - "maxItems": 2048, - "minItems": 1, - "type": "array" - }, - "UploadSettings": { - "$ref": "#/definitions/UploadSettings" - } - }, - "required": [ - "DataSourceArn", - "InputColumns" - ], - "type": "object" - }, - "Status": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "StringDatasetParameter": { - "additionalProperties": false, - "description": "

A string parameter for a dataset.

", - "properties": { - "DefaultValues": { - "$ref": "#/definitions/StringDatasetParameterDefaultValues" - }, - "Id": { - "description": "

An identifier for the string parameter that is created in the dataset.

", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "Name": { - "description": "

The name of the string parameter that is created in the dataset.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ValueType": { - "$ref": "#/definitions/DatasetParameterValueType" - } - }, - "required": [ - "Id", - "Name", - "ValueType" - ], - "type": "object" - }, - "StringDatasetParameterDefaultValues": { - "additionalProperties": false, - "description": "

The default values of a string parameter.

", - "properties": { - "StaticValues": { - "description": "

A list of static default values for a given string parameter.

", - "items": { - "description": "

The default value for the string parameter.

", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagColumnOperation": { - "additionalProperties": false, - "description": "

A transform operation that tags a column with additional information.

", - "properties": { - "ColumnName": { - "description": "

The column that this operation acts on.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", - "items": { - "$ref": "#/definitions/ColumnTag" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ColumnName", - "Tags" - ], - "type": "object" - }, - "TextQualifier": { - "enum": [ - "DOUBLE_QUOTE", - "SINGLE_QUOTE" - ], - "type": "string" - }, - "TimeGranularity": { - "enum": [ - "YEAR", - "QUARTER", - "MONTH", - "WEEK", - "DAY", - "HOUR", - "MINUTE", - "SECOND", - "MILLISECOND" - ], - "type": "string" - }, - "TransformOperation": { - "additionalProperties": false, - "description": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

", - "properties": { - "CastColumnTypeOperation": { - "$ref": "#/definitions/CastColumnTypeOperation" - }, - "CreateColumnsOperation": { - "$ref": "#/definitions/CreateColumnsOperation" - }, - "FilterOperation": { - "$ref": "#/definitions/FilterOperation" - }, - "OverrideDatasetParameterOperation": { - "$ref": "#/definitions/OverrideDatasetParameterOperation" - }, - "ProjectOperation": { - "$ref": "#/definitions/ProjectOperation" - }, - "RenameColumnOperation": { - "$ref": "#/definitions/RenameColumnOperation" - }, - "TagColumnOperation": { - "$ref": "#/definitions/TagColumnOperation" - }, - "UntagColumnOperation": { - "$ref": "#/definitions/UntagColumnOperation" - } - }, - "type": "object" - }, - "UntagColumnOperation": { - "additionalProperties": false, - "description": "

A transform operation that removes tags associated with a column.

", - "properties": { - "ColumnName": { - "description": "

The column that this operation acts on.

", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "TagNames": { - "description": "

The column tags to remove from this column.

", - "items": { - "$ref": "#/definitions/ColumnTagName" - }, - "type": "array" - } - }, - "required": [ - "ColumnName", - "TagNames" - ], - "type": "object" - }, - "UploadSettings": { - "additionalProperties": false, - "description": "

Information about the format for a source file or files.

", - "properties": { - "ContainsHeader": { - "description": "

Whether the file has a header row, or the files each have a header row.

", - "type": "boolean" - }, - "Delimiter": { - "description": "

The delimiter between values in the file.

", - "maxLength": 1, - "minLength": 1, - "type": "string" - }, - "Format": { - "$ref": "#/definitions/FileFormat" - }, - "StartFromRow": { - "description": "

A row number to start reading data from.

", - "minimum": 1, - "type": "number" - }, - "TextQualifier": { - "$ref": "#/definitions/TextQualifier" - } - }, - "type": "object" - } - }, - "description": "Definition of the AWS::QuickSight::DataSet Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:DescribeDataSet", - "quicksight:DescribeDataSetPermissions", - "quicksight:DescribeIngestion", - "quicksight:ListIngestions", - "quicksight:CreateDataSet", - "quicksight:PassDataSource", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:ListTagsForResource", - "quicksight:DescribeDataSetRefreshProperties", - "quicksight:PutDataSetRefreshProperties" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeDataSet", - "quicksight:DeleteDataSet", - "quicksight:ListTagsForResource", - "quicksight:DescribeIngestion", - "quicksight:DeleteDataSetRefreshProperties", - "quicksight:DescribeDataSetRefreshProperties" - ] - }, - "list": { - "permissions": [ - "quicksight:DescribeDataSet", - "quicksight:ListDataSets" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeDataSet", - "quicksight:DescribeDataSetPermissions", - "quicksight:ListTagsForResource", - "quicksight:DescribeDataSetRefreshProperties" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeDataSet", - "quicksight:DescribeDataSetPermissions", - "quicksight:PassDataSource", - "quicksight:UpdateDataSet", - "quicksight:UpdateDataSetPermissions", - "quicksight:PassDataSet", - "quicksight:DescribeIngestion", - "quicksight:ListIngestions", - "quicksight:CancelIngestion", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource", - "quicksight:PutDataSetRefreshProperties", - "quicksight:DescribeDataSetRefreshProperties", - "quicksight:DeleteDataSetRefreshProperties" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/DataSetId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "ColumnGroups": { - "description": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

", - "items": { - "$ref": "#/definitions/ColumnGroup" - }, - "maxItems": 8, - "minItems": 1, - "type": "array" - }, - "ColumnLevelPermissionRules": { - "description": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

", - "items": { - "$ref": "#/definitions/ColumnLevelPermissionRule" - }, - "minItems": 1, - "type": "array" - }, - "ConsumedSpiceCapacityInBytes": { - "default": 0, - "description": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

", - "type": "number" - }, - "CreatedTime": { - "description": "

The time that this dataset was created.

", - "format": "string", - "type": "string" - }, - "DataSetId": { - "type": "string" - }, - "DataSetRefreshProperties": { - "$ref": "#/definitions/DataSetRefreshProperties" - }, - "DataSetUsageConfiguration": { - "$ref": "#/definitions/DataSetUsageConfiguration" - }, - "DatasetParameters": { - "description": "

The parameter declarations of the dataset.

", - "items": { - "$ref": "#/definitions/DatasetParameter" - }, - "maxItems": 32, - "minItems": 0, - "type": "array" - }, - "FieldFolders": { - "$ref": "#/definitions/FieldFolderMap" - }, - "ImportMode": { - "$ref": "#/definitions/DataSetImportMode" - }, - "IngestionWaitPolicy": { - "$ref": "#/definitions/IngestionWaitPolicy" - }, - "LastUpdatedTime": { - "description": "

The last time that this dataset was updated.

", - "format": "string", - "type": "string" - }, - "LogicalTableMap": { - "$ref": "#/definitions/LogicalTableMap" - }, - "Name": { - "description": "

The display name for the dataset.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "OutputColumns": { - "description": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

", - "items": { - "$ref": "#/definitions/OutputColumn" - }, - "type": "array" - }, - "Permissions": { - "description": "

A list of resource permissions on the dataset.

", - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "PhysicalTableMap": { - "$ref": "#/definitions/PhysicalTableMap" - }, - "RowLevelPermissionDataSet": { - "$ref": "#/definitions/RowLevelPermissionDataSet" - }, - "RowLevelPermissionTagConfiguration": { - "$ref": "#/definitions/RowLevelPermissionTagConfiguration" - }, - "Tags": { - "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ConsumedSpiceCapacityInBytes", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/OutputColumns" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::QuickSight::DataSet", - "writeOnlyProperties": [ - "/properties/FieldFolders", - "/properties/IngestionWaitPolicy" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/DataSetId" + ], + "definitions": { + "CalculatedColumn": { + "additionalProperties": false, + "description": "

A calculated column for a dataset.

", + "properties": { + "ColumnId": { + "description": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ColumnName": { + "description": "

Column name.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Expression": { + "description": "

An expression that defines the calculated column.

", + "maxLength": 250000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ColumnId", + "ColumnName", + "Expression" + ], + "type": "object" + }, + "CastColumnTypeOperation": { + "additionalProperties": false, + "description": "

A transform operation that casts a column to a different type.

", + "properties": { + "ColumnName": { + "description": "

Column name.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Format": { + "description": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "NewColumnType": { + "$ref": "#/definitions/ColumnDataType" + }, + "SubType": { + "$ref": "#/definitions/ColumnDataSubType" + } + }, + "required": [ + "ColumnName", + "NewColumnType" + ], + "type": "object" + }, + "ColumnDataSubType": { + "enum": [ + "FLOAT", + "FIXED" + ], + "type": "string" + }, + "ColumnDataType": { + "enum": [ + "STRING", + "INTEGER", + "DECIMAL", + "DATETIME" + ], + "type": "string" + }, + "ColumnDescription": { + "additionalProperties": false, + "description": "

Metadata that contains a description for a column.

", + "properties": { + "Text": { + "description": "

The text of a description for a column.

", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "ColumnGroup": { + "additionalProperties": false, + "description": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

", + "properties": { + "GeoSpatialColumnGroup": { + "$ref": "#/definitions/GeoSpatialColumnGroup" + } + }, + "type": "object" + }, + "ColumnLevelPermissionRule": { + "additionalProperties": false, + "description": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

", + "properties": { + "ColumnNames": { + "description": "

An array of column names.

", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "Principals": { + "description": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

", + "items": { + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ColumnTag": { + "additionalProperties": false, + "description": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

", + "properties": { + "ColumnDescription": { + "$ref": "#/definitions/ColumnDescription" + }, + "ColumnGeographicRole": { + "$ref": "#/definitions/GeoSpatialDataRole" + } + }, + "type": "object" + }, + "ColumnTagName": { + "enum": [ + "COLUMN_GEOGRAPHIC_ROLE", + "COLUMN_DESCRIPTION" + ], + "type": "string" + }, + "CreateColumnsOperation": { + "additionalProperties": false, + "description": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

", + "properties": { + "Columns": { + "description": "

Calculated columns to create.

", + "items": { + "$ref": "#/definitions/CalculatedColumn" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Columns" + ], + "type": "object" + }, + "CustomSql": { + "additionalProperties": false, + "description": "

A physical table type built from the results of the custom SQL query.

", + "properties": { + "Columns": { + "description": "

The column schema from the SQL query result set.

", + "items": { + "$ref": "#/definitions/InputColumn" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + }, + "DataSourceArn": { + "description": "

The Amazon Resource Name (ARN) of the data source.

", + "type": "string" + }, + "Name": { + "description": "

A display name for the SQL query result.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SqlQuery": { + "description": "

The SQL query.

", + "maxLength": 168000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "DataSourceArn", + "Name", + "SqlQuery" + ], + "type": "object" + }, + "DataSetImportMode": { + "enum": [ + "SPICE", + "DIRECT_QUERY" + ], + "type": "string" + }, + "DataSetRefreshProperties": { + "additionalProperties": false, + "description": "

The refresh properties of a dataset.

", + "properties": { + "RefreshConfiguration": { + "$ref": "#/definitions/RefreshConfiguration" + } + }, + "type": "object" + }, + "DataSetUsageConfiguration": { + "additionalProperties": false, + "description": "

The usage configuration to apply to child datasets that reference this dataset as a source.

", + "properties": { + "DisableUseAsDirectQuerySource": { + "default": false, + "description": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

", + "type": "boolean" + }, + "DisableUseAsImportedSource": { + "default": false, + "description": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

", + "type": "boolean" + } + }, + "type": "object" + }, + "DatasetParameter": { + "additionalProperties": false, + "description": "

A dataset parameter.

", + "properties": { + "DateTimeDatasetParameter": { + "$ref": "#/definitions/DateTimeDatasetParameter" + }, + "DecimalDatasetParameter": { + "$ref": "#/definitions/DecimalDatasetParameter" + }, + "IntegerDatasetParameter": { + "$ref": "#/definitions/IntegerDatasetParameter" + }, + "StringDatasetParameter": { + "$ref": "#/definitions/StringDatasetParameter" + } + }, + "type": "object" + }, + "DatasetParameterValueType": { + "enum": [ + "MULTI_VALUED", + "SINGLE_VALUED" + ], + "type": "string" + }, + "DateTimeDatasetParameter": { + "additionalProperties": false, + "description": "

A date time parameter for a dataset.

", + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DateTimeDatasetParameterDefaultValues" + }, + "Id": { + "description": "

An identifier for the parameter that is created in the dataset.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "

The name of the date time parameter that is created in the dataset.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "ValueType": { + "$ref": "#/definitions/DatasetParameterValueType" + } + }, + "required": [ + "Id", + "Name", + "ValueType" + ], + "type": "object" + }, + "DateTimeDatasetParameterDefaultValues": { + "additionalProperties": false, + "description": "

The default values of a date time parameter.

", + "properties": { + "StaticValues": { + "description": "

A list of static default values for a given date time parameter.

", + "items": { + "description": "

The default value for the date time parameter.

", + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DecimalDatasetParameter": { + "additionalProperties": false, + "description": "

A decimal parameter for a dataset.

", + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DecimalDatasetParameterDefaultValues" + }, + "Id": { + "description": "

An identifier for the decimal parameter created in the dataset.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "

The name of the decimal parameter that is created in the dataset.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ValueType": { + "$ref": "#/definitions/DatasetParameterValueType" + } + }, + "required": [ + "Id", + "Name", + "ValueType" + ], + "type": "object" + }, + "DecimalDatasetParameterDefaultValues": { + "additionalProperties": false, + "description": "

The default values of a decimal parameter.

", + "properties": { + "StaticValues": { + "description": "

A list of static default values for a given decimal parameter.

", + "items": { + "default": 0, + "description": "

The default value for the decimal parameter.

", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FieldFolder": { + "additionalProperties": false, + "description": "

A FieldFolder element is a folder that contains fields and nested subfolders.

", + "properties": { + "Columns": { + "description": "

A folder has a list of columns. A column can only be in one folder.

", + "items": { + "type": "string" + }, + "maxItems": 5000, + "minItems": 0, + "type": "array" + }, + "Description": { + "description": "

The description for a field folder.

", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "FieldFolderMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/FieldFolder" + } + }, + "type": "object" + }, + "FileFormat": { + "enum": [ + "CSV", + "TSV", + "CLF", + "ELF", + "XLSX", + "JSON" + ], + "type": "string" + }, + "FilterOperation": { + "additionalProperties": false, + "description": "

A transform operation that filters rows based on a condition.

", + "properties": { + "ConditionExpression": { + "description": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConditionExpression" + ], + "type": "object" + }, + "GeoSpatialColumnGroup": { + "additionalProperties": false, + "description": "

Geospatial column group that denotes a hierarchy.

", + "properties": { + "Columns": { + "description": "

Columns in this hierarchy.

", + "items": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + }, + "CountryCode": { + "$ref": "#/definitions/GeoSpatialCountryCode" + }, + "Name": { + "description": "

A display name for the hierarchy.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "Name" + ], + "type": "object" + }, + "GeoSpatialCountryCode": { + "enum": [ + "US" + ], + "type": "string" + }, + "GeoSpatialDataRole": { + "enum": [ + "COUNTRY", + "STATE", + "COUNTY", + "CITY", + "POSTCODE", + "LONGITUDE", + "LATITUDE", + "POLITICAL1", + "CENSUS_TRACT", + "CENSUS_BLOCK_GROUP", + "CENSUS_BLOCK" + ], + "type": "string" + }, + "IncrementalRefresh": { + "additionalProperties": false, + "description": "

The incremental refresh configuration for a dataset.

", + "properties": { + "LookbackWindow": { + "$ref": "#/definitions/LookbackWindow" + } + }, + "required": [ + "LookbackWindow" + ], + "type": "object" + }, + "IngestionWaitPolicy": { + "additionalProperties": false, + "description": "

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

", + "properties": { + "IngestionWaitTimeInHours": { + "default": 36, + "description": "

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.\n Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

", + "maximum": 36, + "minimum": 1, + "type": "number" + }, + "WaitForSpiceIngestion": { + "default": true, + "description": "

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).\n Applicable only when DataSetImportMode mode is set to SPICE.

", + "type": "boolean" + } + }, + "type": "object" + }, + "InputColumn": { + "additionalProperties": false, + "description": "

Metadata for a column that is used as the input of a transform operation.

", + "properties": { + "Name": { + "description": "

The name of this column in the underlying data source.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "SubType": { + "$ref": "#/definitions/ColumnDataSubType" + }, + "Type": { + "$ref": "#/definitions/InputColumnDataType" + } + }, + "required": [ + "Name", + "Type" + ], + "type": "object" + }, + "InputColumnDataType": { + "enum": [ + "STRING", + "INTEGER", + "DECIMAL", + "DATETIME", + "BIT", + "BOOLEAN", + "JSON" + ], + "type": "string" + }, + "IntegerDatasetParameter": { + "additionalProperties": false, + "description": "

An integer parameter for a dataset.

", + "properties": { + "DefaultValues": { + "$ref": "#/definitions/IntegerDatasetParameterDefaultValues" + }, + "Id": { + "description": "

An identifier for the integer parameter created in the dataset.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "

The name of the integer parameter that is created in the dataset.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ValueType": { + "$ref": "#/definitions/DatasetParameterValueType" + } + }, + "required": [ + "Id", + "Name", + "ValueType" + ], + "type": "object" + }, + "IntegerDatasetParameterDefaultValues": { + "additionalProperties": false, + "description": "

The default values of an integer parameter.

", + "properties": { + "StaticValues": { + "description": "

A list of static default values for a given integer parameter.

", + "items": { + "default": 0, + "description": "

The default value for the integer parameter.

", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "JoinInstruction": { + "additionalProperties": false, + "description": "

The instructions associated with a join.

", + "properties": { + "LeftJoinKeyProperties": { + "$ref": "#/definitions/JoinKeyProperties" + }, + "LeftOperand": { + "description": "

The operand on the left side of a join.

", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-]*$", + "type": "string" + }, + "OnClause": { + "description": "

The join instructions provided in the ON clause of a join.

", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "RightJoinKeyProperties": { + "$ref": "#/definitions/JoinKeyProperties" + }, + "RightOperand": { + "description": "

The operand on the right side of a join.

", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-]*$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/JoinType" + } + }, + "required": [ + "LeftOperand", + "OnClause", + "RightOperand", + "Type" + ], + "type": "object" + }, + "JoinKeyProperties": { + "additionalProperties": false, + "description": "

Properties associated with the columns participating in a join.

", + "properties": { + "UniqueKey": { + "description": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

", + "type": "boolean" + } + }, + "type": "object" + }, + "JoinType": { + "enum": [ + "INNER", + "OUTER", + "LEFT", + "RIGHT" + ], + "type": "string" + }, + "LogicalTable": { + "additionalProperties": false, + "description": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

", + "properties": { + "Alias": { + "description": "

A display name for the logical table.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "DataTransforms": { + "description": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

", + "items": { + "$ref": "#/definitions/TransformOperation" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + }, + "Source": { + "$ref": "#/definitions/LogicalTableSource" + } + }, + "required": [ + "Alias" + ], + "type": "object" + }, + "LogicalTableMap": { + "additionalProperties": false, + "maxProperties": 64, + "minProperties": 1, + "patternProperties": { + "^[0-9a-zA-Z-]*$": { + "$ref": "#/definitions/LogicalTable" + } + }, + "type": "object" + }, + "LogicalTableSource": { + "additionalProperties": false, + "description": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

", + "properties": { + "DataSetArn": { + "description": "

The Amazon Resource Number (ARN) of the parent dataset.

", + "type": "string" + }, + "JoinInstruction": { + "$ref": "#/definitions/JoinInstruction" + }, + "PhysicalTableId": { + "description": "

Physical table ID.

", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-]*$", + "type": "string" + } + }, + "type": "object" + }, + "LookbackWindow": { + "additionalProperties": false, + "description": "

The lookback window setup of an incremental refresh configuration.

", + "properties": { + "ColumnName": { + "description": "

The name of the lookback window column.

", + "type": "string" + }, + "Size": { + "default": 0, + "description": "

The lookback window column size.

", + "minimum": 1, + "type": "number" + }, + "SizeUnit": { + "$ref": "#/definitions/LookbackWindowSizeUnit" + } + }, + "required": [ + "ColumnName", + "Size", + "SizeUnit" + ], + "type": "object" + }, + "LookbackWindowSizeUnit": { + "enum": [ + "HOUR", + "DAY", + "WEEK" + ], + "type": "string" + }, + "NewDefaultValues": { + "additionalProperties": false, + "description": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

", + "properties": { + "DateTimeStaticValues": { + "description": "

A list of static default values for a given date time parameter.

", + "items": { + "description": "

The default value for the date time parameter.

", + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "DecimalStaticValues": { + "description": "

A list of static default values for a given decimal parameter.

", + "items": { + "default": 0, + "description": "

The default value for the decimal parameter.

", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "IntegerStaticValues": { + "description": "

A list of static default values for a given integer parameter.

", + "items": { + "default": 0, + "description": "

The default value for the integer parameter.

", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "StringStaticValues": { + "description": "

A list of static default values for a given string parameter.

", + "items": { + "description": "

The default value for the string parameter.

", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "OutputColumn": { + "additionalProperties": false, + "description": "

Output column.

", + "properties": { + "Description": { + "description": "

A description for a column.

", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "Name": { + "description": "

The display name of the column..

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "SubType": { + "$ref": "#/definitions/ColumnDataSubType" + }, + "Type": { + "$ref": "#/definitions/ColumnDataType" + } + }, + "type": "object" + }, + "OverrideDatasetParameterOperation": { + "additionalProperties": false, + "description": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

", + "properties": { + "NewDefaultValues": { + "$ref": "#/definitions/NewDefaultValues" + }, + "NewParameterName": { + "description": "

The new name for the parameter.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterName": { + "description": "

The name of the parameter to be overridden with different values.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "ParameterName" + ], + "type": "object" + }, + "PhysicalTable": { + "additionalProperties": false, + "description": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

", + "properties": { + "CustomSql": { + "$ref": "#/definitions/CustomSql" + }, + "RelationalTable": { + "$ref": "#/definitions/RelationalTable" + }, + "S3Source": { + "$ref": "#/definitions/S3Source" + } + }, + "type": "object" + }, + "PhysicalTableMap": { + "additionalProperties": false, + "maxProperties": 32, + "minProperties": 0, + "patternProperties": { + "^[0-9a-zA-Z-]*$": { + "$ref": "#/definitions/PhysicalTable" + } + }, + "type": "object" + }, + "ProjectOperation": { + "additionalProperties": false, + "description": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

", + "properties": { + "ProjectedColumns": { + "description": "

Projected columns.

", + "items": { + "type": "string" + }, + "maxItems": 2000, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ProjectedColumns" + ], + "type": "object" + }, + "RefreshConfiguration": { + "additionalProperties": false, + "description": "

The refresh configuration of a dataset.

", + "properties": { + "IncrementalRefresh": { + "$ref": "#/definitions/IncrementalRefresh" + } + }, + "required": [ + "IncrementalRefresh" + ], + "type": "object" + }, + "RelationalTable": { + "additionalProperties": false, + "description": "

A physical table type for relational data sources.

", + "properties": { + "Catalog": { + "description": "

The catalog associated with a table.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "DataSourceArn": { + "description": "

The Amazon Resource Name (ARN) for the data source.

", + "type": "string" + }, + "InputColumns": { + "description": "

The column schema of the table.

", + "items": { + "$ref": "#/definitions/InputColumn" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + }, + "Name": { + "description": "

The name of the relational table.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Schema": { + "description": "

The schema name. This name applies to certain relational database engines.

", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "DataSourceArn", + "InputColumns", + "Name" + ], + "type": "object" + }, + "RenameColumnOperation": { + "additionalProperties": false, + "description": "

A transform operation that renames a column.

", + "properties": { + "ColumnName": { + "description": "

The name of the column to be renamed.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "NewColumnName": { + "description": "

The new name for the column.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ColumnName", + "NewColumnName" + ], + "type": "object" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "RowLevelPermissionDataSet": { + "additionalProperties": false, + "description": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", + "type": "string" + }, + "FormatVersion": { + "$ref": "#/definitions/RowLevelPermissionFormatVersion" + }, + "Namespace": { + "description": "

The namespace associated with the dataset that contains permissions for RLS.

", + "maxLength": 64, + "minLength": 0, + "pattern": "^[a-zA-Z0-9._-]*$", + "type": "string" + }, + "PermissionPolicy": { + "$ref": "#/definitions/RowLevelPermissionPolicy" + }, + "Status": { + "$ref": "#/definitions/Status" + } + }, + "required": [ + "Arn", + "PermissionPolicy" + ], + "type": "object" + }, + "RowLevelPermissionFormatVersion": { + "enum": [ + "VERSION_1", + "VERSION_2" + ], + "type": "string" + }, + "RowLevelPermissionPolicy": { + "enum": [ + "GRANT_ACCESS", + "DENY_ACCESS" + ], + "type": "string" + }, + "RowLevelPermissionTagConfiguration": { + "additionalProperties": false, + "description": "

The configuration of tags on a dataset to set row-level security.

", + "properties": { + "Status": { + "$ref": "#/definitions/Status" + }, + "TagRuleConfigurations": { + "description": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

", + "items": { + "items": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "TagRules": { + "description": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", + "items": { + "$ref": "#/definitions/RowLevelPermissionTagRule" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "TagRules" + ], + "type": "object" + }, + "RowLevelPermissionTagRule": { + "additionalProperties": false, + "description": "

A set of rules associated with a tag.

", + "properties": { + "ColumnName": { + "description": "

The column name that a tag key is assigned to.

", + "type": "string" + }, + "MatchAllValue": { + "description": "

A string that you want to use to filter by all the values in a column in the dataset and don\u2019t want to list the values one by one. For example, you can use an asterisk as your match all value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "TagKey": { + "description": "

The unique key for a tag.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "TagMultiValueDelimiter": { + "description": "

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

", + "maxLength": 10, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "ColumnName", + "TagKey" + ], + "type": "object" + }, + "S3Source": { + "additionalProperties": false, + "description": "

A physical table type for an S3 data source.

", + "properties": { + "DataSourceArn": { + "description": "

The Amazon Resource Name (ARN) for the data source.

", + "type": "string" + }, + "InputColumns": { + "description": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", + "items": { + "$ref": "#/definitions/InputColumn" + }, + "maxItems": 2048, + "minItems": 1, + "type": "array" + }, + "UploadSettings": { + "$ref": "#/definitions/UploadSettings" + } + }, + "required": [ + "DataSourceArn", + "InputColumns" + ], + "type": "object" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "StringDatasetParameter": { + "additionalProperties": false, + "description": "

A string parameter for a dataset.

", + "properties": { + "DefaultValues": { + "$ref": "#/definitions/StringDatasetParameterDefaultValues" + }, + "Id": { + "description": "

An identifier for the string parameter that is created in the dataset.

", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "

The name of the string parameter that is created in the dataset.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ValueType": { + "$ref": "#/definitions/DatasetParameterValueType" + } + }, + "required": [ + "Id", + "Name", + "ValueType" + ], + "type": "object" + }, + "StringDatasetParameterDefaultValues": { + "additionalProperties": false, + "description": "

The default values of a string parameter.

", + "properties": { + "StaticValues": { + "description": "

A list of static default values for a given string parameter.

", + "items": { + "description": "

The default value for the string parameter.

", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagColumnOperation": { + "additionalProperties": false, + "description": "

A transform operation that tags a column with additional information.

", + "properties": { + "ColumnName": { + "description": "

The column that this operation acts on.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", + "items": { + "$ref": "#/definitions/ColumnTag" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ColumnName", + "Tags" + ], + "type": "object" + }, + "TextQualifier": { + "enum": [ + "DOUBLE_QUOTE", + "SINGLE_QUOTE" + ], + "type": "string" + }, + "TimeGranularity": { + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND", + "MILLISECOND" + ], + "type": "string" + }, + "TransformOperation": { + "additionalProperties": false, + "description": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

", + "properties": { + "CastColumnTypeOperation": { + "$ref": "#/definitions/CastColumnTypeOperation" + }, + "CreateColumnsOperation": { + "$ref": "#/definitions/CreateColumnsOperation" + }, + "FilterOperation": { + "$ref": "#/definitions/FilterOperation" + }, + "OverrideDatasetParameterOperation": { + "$ref": "#/definitions/OverrideDatasetParameterOperation" + }, + "ProjectOperation": { + "$ref": "#/definitions/ProjectOperation" + }, + "RenameColumnOperation": { + "$ref": "#/definitions/RenameColumnOperation" + }, + "TagColumnOperation": { + "$ref": "#/definitions/TagColumnOperation" + }, + "UntagColumnOperation": { + "$ref": "#/definitions/UntagColumnOperation" + } + }, + "type": "object" + }, + "UntagColumnOperation": { + "additionalProperties": false, + "description": "

A transform operation that removes tags associated with a column.

", + "properties": { + "ColumnName": { + "description": "

The column that this operation acts on.

", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "TagNames": { + "description": "

The column tags to remove from this column.

", + "items": { + "$ref": "#/definitions/ColumnTagName" + }, + "type": "array" + } + }, + "required": [ + "ColumnName", + "TagNames" + ], + "type": "object" + }, + "UploadSettings": { + "additionalProperties": false, + "description": "

Information about the format for a source file or files.

", + "properties": { + "ContainsHeader": { + "description": "

Whether the file has a header row, or the files each have a header row.

", + "type": "boolean" + }, + "Delimiter": { + "description": "

The delimiter between values in the file.

", + "maxLength": 1, + "minLength": 1, + "type": "string" + }, + "Format": { + "$ref": "#/definitions/FileFormat" + }, + "StartFromRow": { + "description": "

A row number to start reading data from.

", + "minimum": 1, + "type": "number" + }, + "TextQualifier": { + "$ref": "#/definitions/TextQualifier" + } + }, + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::DataSet Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:DescribeDataSet", + "quicksight:DescribeDataSetPermissions", + "quicksight:DescribeIngestion", + "quicksight:ListIngestions", + "quicksight:CreateDataSet", + "quicksight:PassDataSource", + "quicksight:PassDataSet", + "quicksight:TagResource", + "quicksight:ListTagsForResource", + "quicksight:DescribeDataSetRefreshProperties", + "quicksight:PutDataSetRefreshProperties" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeDataSet", + "quicksight:DeleteDataSet", + "quicksight:ListTagsForResource", + "quicksight:DescribeIngestion", + "quicksight:DeleteDataSetRefreshProperties", + "quicksight:DescribeDataSetRefreshProperties" + ] + }, + "list": { + "permissions": [ + "quicksight:DescribeDataSet", + "quicksight:ListDataSets" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeDataSet", + "quicksight:DescribeDataSetPermissions", + "quicksight:ListTagsForResource", + "quicksight:DescribeDataSetRefreshProperties" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeDataSet", + "quicksight:DescribeDataSetPermissions", + "quicksight:PassDataSource", + "quicksight:UpdateDataSet", + "quicksight:UpdateDataSetPermissions", + "quicksight:PassDataSet", + "quicksight:DescribeIngestion", + "quicksight:ListIngestions", + "quicksight:CancelIngestion", + "quicksight:CreateFolderMembership", + "quicksight:DeleteFolderMembership", + "quicksight:ListFoldersForResource", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource", + "quicksight:PutDataSetRefreshProperties", + "quicksight:DescribeDataSetRefreshProperties", + "quicksight:DeleteDataSetRefreshProperties" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/DataSetId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "ColumnGroups": { + "description": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

", + "items": { + "$ref": "#/definitions/ColumnGroup" + }, + "maxItems": 8, + "minItems": 1, + "type": "array" + }, + "ColumnLevelPermissionRules": { + "description": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

", + "items": { + "$ref": "#/definitions/ColumnLevelPermissionRule" + }, + "minItems": 1, + "type": "array" + }, + "ConsumedSpiceCapacityInBytes": { + "default": 0, + "description": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

", + "type": "number" + }, + "CreatedTime": { + "description": "

The time that this dataset was created.

", + "format": "string", + "type": "string" + }, + "DataSetId": { + "type": "string" + }, + "DataSetRefreshProperties": { + "$ref": "#/definitions/DataSetRefreshProperties" + }, + "DataSetUsageConfiguration": { + "$ref": "#/definitions/DataSetUsageConfiguration" + }, + "DatasetParameters": { + "description": "

The parameter declarations of the dataset.

", + "items": { + "$ref": "#/definitions/DatasetParameter" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "FieldFolders": { + "$ref": "#/definitions/FieldFolderMap" + }, + "FolderArns": { + "description": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

", + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ImportMode": { + "$ref": "#/definitions/DataSetImportMode" + }, + "IngestionWaitPolicy": { + "$ref": "#/definitions/IngestionWaitPolicy" + }, + "LastUpdatedTime": { + "description": "

The last time that this dataset was updated.

", + "format": "string", + "type": "string" + }, + "LogicalTableMap": { + "$ref": "#/definitions/LogicalTableMap" + }, + "Name": { + "description": "

The display name for the dataset.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "OutputColumns": { + "description": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

", + "items": { + "$ref": "#/definitions/OutputColumn" + }, + "type": "array" + }, + "Permissions": { + "description": "

A list of resource permissions on the dataset.

", + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "PhysicalTableMap": { + "$ref": "#/definitions/PhysicalTableMap" + }, + "RowLevelPermissionDataSet": { + "$ref": "#/definitions/RowLevelPermissionDataSet" + }, + "RowLevelPermissionTagConfiguration": { + "$ref": "#/definitions/RowLevelPermissionTagConfiguration" + }, + "Tags": { + "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ConsumedSpiceCapacityInBytes", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/OutputColumns" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::QuickSight::DataSet", + "writeOnlyProperties": [ + "/properties/FieldFolders", + "/properties/IngestionWaitPolicy", + "/properties/FolderArns" + ] +} diff --git a/schema/aws-quicksight-datasource.json b/schema/aws-quicksight-datasource.json index 360950e..1e5541b 100644 --- a/schema/aws-quicksight-datasource.json +++ b/schema/aws-quicksight-datasource.json @@ -1,1091 +1,1096 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/DataSourceId", - "/properties/Type" - ], - "definitions": { - "AmazonElasticsearchParameters": { - "additionalProperties": false, - "description": "

The parameters for OpenSearch.

", - "properties": { - "Domain": { - "description": "

The OpenSearch domain.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Domain" - ], - "type": "object" - }, - "AmazonOpenSearchParameters": { - "additionalProperties": false, - "description": "

The parameters for OpenSearch.

", - "properties": { - "Domain": { - "description": "

The OpenSearch domain.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Domain" - ], - "type": "object" - }, - "AthenaParameters": { - "additionalProperties": false, - "description": "

Parameters for Amazon Athena.

", - "properties": { - "RoleArn": { - "description": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "WorkGroup": { - "description": "

The workgroup that Amazon Athena uses.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "AuroraParameters": { - "additionalProperties": false, - "description": "

Parameters for Amazon Aurora.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "AuroraPostgreSqlParameters": { - "additionalProperties": false, - "description": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

", - "properties": { - "Database": { - "description": "

The Amazon Aurora PostgreSQL database to connect to.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

The port that Amazon Aurora PostgreSQL is listening on.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "AwsIotAnalyticsParameters": { - "additionalProperties": false, - "description": "

The parameters for IoT Analytics.

", - "properties": { - "DataSetName": { - "description": "

Dataset name.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetName" - ], - "type": "object" - }, - "CredentialPair": { - "additionalProperties": false, - "description": "

The combination of user name and password that are used as credentials.

", - "properties": { - "AlternateDataSourceParameters": { - "description": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

", - "items": { - "$ref": "#/definitions/DataSourceParameters" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "Password": { - "description": "

Password.

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Username": { - "description": "

User name.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "DataSourceCredentials": { - "additionalProperties": false, - "description": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", - "properties": { - "CopySourceArn": { - "description": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

", - "pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$", - "type": "string" - }, - "CredentialPair": { - "$ref": "#/definitions/CredentialPair" - }, - "SecretArn": { - "description": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$", - "type": "string" - } - }, - "type": "object" - }, - "DataSourceErrorInfo": { - "additionalProperties": false, - "description": "

Error information for the data source creation or update.

", - "properties": { - "Message": { - "description": "

Error message.

", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/DataSourceErrorInfoType" - } - }, - "type": "object" - }, - "DataSourceErrorInfoType": { - "enum": [ - "ACCESS_DENIED", - "COPY_SOURCE_NOT_FOUND", - "TIMEOUT", - "ENGINE_VERSION_NOT_SUPPORTED", - "UNKNOWN_HOST", - "GENERIC_SQL_FAILURE", - "CONFLICT", - "UNKNOWN" - ], - "type": "string" - }, - "DataSourceParameters": { - "additionalProperties": false, - "description": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

", - "properties": { - "AmazonElasticsearchParameters": { - "$ref": "#/definitions/AmazonElasticsearchParameters" - }, - "AmazonOpenSearchParameters": { - "$ref": "#/definitions/AmazonOpenSearchParameters" - }, - "AthenaParameters": { - "$ref": "#/definitions/AthenaParameters" - }, - "AuroraParameters": { - "$ref": "#/definitions/AuroraParameters" - }, - "AuroraPostgreSqlParameters": { - "$ref": "#/definitions/AuroraPostgreSqlParameters" - }, - "DatabricksParameters": { - "$ref": "#/definitions/DatabricksParameters" - }, - "MariaDbParameters": { - "$ref": "#/definitions/MariaDbParameters" - }, - "MySqlParameters": { - "$ref": "#/definitions/MySqlParameters" - }, - "OracleParameters": { - "$ref": "#/definitions/OracleParameters" - }, - "PostgreSqlParameters": { - "$ref": "#/definitions/PostgreSqlParameters" - }, - "PrestoParameters": { - "$ref": "#/definitions/PrestoParameters" - }, - "RdsParameters": { - "$ref": "#/definitions/RdsParameters" - }, - "RedshiftParameters": { - "$ref": "#/definitions/RedshiftParameters" - }, - "S3Parameters": { - "$ref": "#/definitions/S3Parameters" - }, - "SnowflakeParameters": { - "$ref": "#/definitions/SnowflakeParameters" - }, - "SparkParameters": { - "$ref": "#/definitions/SparkParameters" - }, - "SqlServerParameters": { - "$ref": "#/definitions/SqlServerParameters" - }, - "StarburstParameters": { - "$ref": "#/definitions/StarburstParameters" - }, - "TeradataParameters": { - "$ref": "#/definitions/TeradataParameters" - }, - "TrinoParameters": { - "$ref": "#/definitions/TrinoParameters" - } - }, - "type": "object" - }, - "DataSourceType": { - "enum": [ - "ADOBE_ANALYTICS", - "AMAZON_ELASTICSEARCH", - "AMAZON_OPENSEARCH", - "ATHENA", - "AURORA", - "AURORA_POSTGRESQL", - "AWS_IOT_ANALYTICS", - "DATABRICKS", - "DENODO", - "DREMIO", - "DYNAMODB", - "SAPHANA", - "DB2_AS400", - "EXASOL", - "FILE", - "GITHUB", - "JIRA", - "MARIADB", - "MYSQL", - "ORACLE", - "POSTGRESQL", - "PRESTO", - "REDSHIFT", - "S3", - "SALESFORCE", - "SERVICENOW", - "SNOWFLAKE", - "SPARK", - "SQLSERVER", - "TERADATA", - "TIMESTREAM", - "TWITTER", - "BIGQUERY", - "GOOGLE_ANALYTICS", - "TRINO", - "STARBURST", - "MONGO", - "MONGO_ATLAS", - "DOCUMENTDB", - "APPFLOW" - ], - "type": "string" - }, - "DatabricksParameters": { - "additionalProperties": false, - "description": "

The parameters that are required to connect to a Databricks data source.

", - "properties": { - "Host": { - "description": "

The host name of the Databricks data source.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

The port for the Databricks data source.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "SqlEndpointPath": { - "description": "

The HTTP path of the Databricks data source.

", - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Host", - "Port", - "SqlEndpointPath" - ], - "type": "object" - }, - "IdentityCenterConfiguration": { - "additionalProperties": false, - "description": "

The parameters for an IAM Identity Center configuration.

", - "properties": { - "EnableIdentityPropagation": { - "default": null, - "description": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

", - "type": "boolean" - } - }, - "type": "object" - }, - "ManifestFileLocation": { - "additionalProperties": false, - "description": "

Amazon S3 manifest file location.

", - "properties": { - "Bucket": { - "description": "

Amazon S3 bucket.

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Key": { - "description": "

Amazon S3 key that identifies an object.

", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "MariaDbParameters": { - "additionalProperties": false, - "description": "

The parameters for MariaDB.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "MySqlParameters": { - "additionalProperties": false, - "description": "

The parameters for MySQL.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "OracleParameters": { - "additionalProperties": false, - "description": "

The parameters for Oracle.

", - "properties": { - "Database": { - "description": "

The database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

An Oracle host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

The port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "PostgreSqlParameters": { - "additionalProperties": false, - "description": "

The parameters for PostgreSQL.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "PrestoParameters": { - "additionalProperties": false, - "description": "

The parameters for Presto.

", - "properties": { - "Catalog": { - "description": "

Catalog.

", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Catalog", - "Host", - "Port" - ], - "type": "object" - }, - "RdsParameters": { - "additionalProperties": false, - "description": "

The parameters for Amazon RDS.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InstanceId": { - "description": "

Instance ID.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Database", - "InstanceId" - ], - "type": "object" - }, - "RedshiftIAMParameters": { - "additionalProperties": false, - "description": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

", - "properties": { - "AutoCreateDatabaseUser": { - "default": false, - "description": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

", - "type": "boolean" - }, - "DatabaseGroups": { - "description": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

", - "items": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "DatabaseUser": { - "description": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "RedshiftParameters": { - "additionalProperties": false, - "description": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

", - "properties": { - "ClusterId": { - "description": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host. This field can be blank if ClusterId is provided.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "IAMParameters": { - "$ref": "#/definitions/RedshiftIAMParameters" - }, - "IdentityCenterConfiguration": { - "$ref": "#/definitions/IdentityCenterConfiguration" - }, - "Port": { - "default": 0, - "description": "

Port. This field can be blank if the ClusterId is provided.

", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "Database" - ], - "type": "object" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Resource": { - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "ResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETED" - ], - "type": "string" - }, - "S3Parameters": { - "additionalProperties": false, - "description": "

The parameters for S3.

", - "properties": { - "ManifestFileLocation": { - "$ref": "#/definitions/ManifestFileLocation" - }, - "RoleArn": { - "description": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

", - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "required": [ - "ManifestFileLocation" - ], - "type": "object" - }, - "SnowflakeParameters": { - "additionalProperties": false, - "description": "

The parameters for Snowflake.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Warehouse": { - "description": "

Warehouse.

", - "maxLength": 128, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Database", - "Host", - "Warehouse" - ], - "type": "object" - }, - "SparkParameters": { - "additionalProperties": false, - "description": "

The parameters for Spark.

", - "properties": { - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Host", - "Port" - ], - "type": "object" - }, - "SqlServerParameters": { - "additionalProperties": false, - "description": "

The parameters for SQL Server.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "SslProperties": { - "additionalProperties": false, - "description": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

", - "properties": { - "DisableSsl": { - "default": false, - "description": "

A Boolean option to control whether SSL should be disabled.

", - "type": "boolean" - } - }, - "type": "object" - }, - "StarburstParameters": { - "additionalProperties": false, - "description": "

The parameters that are required to connect to a Starburst data source.

", - "properties": { - "Catalog": { - "description": "

The catalog name for the Starburst data source.

", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "Host": { - "description": "

The host name of the Starburst data source.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

The port for the Starburst data source.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "ProductType": { - "$ref": "#/definitions/StarburstProductType" - } - }, - "required": [ - "Catalog", - "Host", - "Port" - ], - "type": "object" - }, - "StarburstProductType": { - "enum": [ - "GALAXY", - "ENTERPRISE" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TeradataParameters": { - "additionalProperties": false, - "description": "

The parameters for Teradata.

", - "properties": { - "Database": { - "description": "

Database.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Host": { - "description": "

Host.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

Port.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Database", - "Host", - "Port" - ], - "type": "object" - }, - "TrinoParameters": { - "additionalProperties": false, - "description": "

The parameters that are required to connect to a Trino data source.

", - "properties": { - "Catalog": { - "description": "

The catalog name for the Trino data source.

", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "Host": { - "description": "

The host name of the Trino data source.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Port": { - "default": 0, - "description": "

The port for the Trino data source.

", - "maximum": 65535, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Catalog", - "Host", - "Port" - ], - "type": "object" - }, - "VpcConnectionProperties": { - "additionalProperties": false, - "description": "

VPC connection properties.

", - "properties": { - "VpcConnectionArn": { - "description": "

The Amazon Resource Name (ARN) for the VPC connection.

", - "type": "string" - } - }, - "required": [ - "VpcConnectionArn" - ], - "type": "object" - } - }, - "description": "Definition of the AWS::QuickSight::DataSource Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:CreateDataSource", - "quicksight:DescribeDataSource", - "quicksight:DescribeDataSourcePermissions", - "quicksight:TagResource", - "quicksight:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeDataSource", - "quicksight:DescribeDataSourcePermissions", - "quicksight:DeleteDataSource", - "quicksight:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "quicksight:DescribeDataSource", - "quicksight:ListDataSources" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeDataSource", - "quicksight:DescribeDataSourcePermissions", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeDataSource", - "quicksight:DescribeDataSourcePermissions", - "quicksight:UpdateDataSource", - "quicksight:UpdateDataSourcePermissions", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/DataSourceId" - ], - "properties": { - "AlternateDataSourceParameters": { - "description": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

", - "items": { - "$ref": "#/definitions/DataSourceParameters" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the data source.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "CreatedTime": { - "description": "

The time that this data source was created.

", - "format": "date-time", - "type": "string" - }, - "Credentials": { - "$ref": "#/definitions/DataSourceCredentials" - }, - "DataSourceId": { - "type": "string" - }, - "DataSourceParameters": { - "$ref": "#/definitions/DataSourceParameters" - }, - "ErrorInfo": { - "$ref": "#/definitions/DataSourceErrorInfo" - }, - "LastUpdatedTime": { - "description": "

The last time that this data source was updated.

", - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "SslProperties": { - "$ref": "#/definitions/SslProperties" - }, - "Status": { - "$ref": "#/definitions/ResourceStatus" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "Type": { - "$ref": "#/definitions/DataSourceType" - }, - "VpcConnectionProperties": { - "$ref": "#/definitions/VpcConnectionProperties" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/Status" - ], - "required": [ - "Name", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "typeName": "AWS::QuickSight::DataSource", - "writeOnlyProperties": [ - "/properties/Credentials" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/DataSourceId", + "/properties/Type" + ], + "definitions": { + "AmazonElasticsearchParameters": { + "additionalProperties": false, + "description": "

The parameters for OpenSearch.

", + "properties": { + "Domain": { + "description": "

The OpenSearch domain.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Domain" + ], + "type": "object" + }, + "AmazonOpenSearchParameters": { + "additionalProperties": false, + "description": "

The parameters for OpenSearch.

", + "properties": { + "Domain": { + "description": "

The OpenSearch domain.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Domain" + ], + "type": "object" + }, + "AthenaParameters": { + "additionalProperties": false, + "description": "

Parameters for Amazon Athena.

", + "properties": { + "RoleArn": { + "description": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "WorkGroup": { + "description": "

The workgroup that Amazon Athena uses.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "AuroraParameters": { + "additionalProperties": false, + "description": "

Parameters for Amazon Aurora.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "AuroraPostgreSqlParameters": { + "additionalProperties": false, + "description": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

", + "properties": { + "Database": { + "description": "

The Amazon Aurora PostgreSQL database to connect to.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

The port that Amazon Aurora PostgreSQL is listening on.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "AwsIotAnalyticsParameters": { + "additionalProperties": false, + "description": "

The parameters for IoT Analytics.

", + "properties": { + "DataSetName": { + "description": "

Dataset name.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetName" + ], + "type": "object" + }, + "CredentialPair": { + "additionalProperties": false, + "description": "

The combination of user name and password that are used as credentials.

", + "properties": { + "AlternateDataSourceParameters": { + "description": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

", + "items": { + "$ref": "#/definitions/DataSourceParameters" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "Password": { + "description": "

Password.

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Username": { + "description": "

User name.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Password", + "Username" + ], + "type": "object" + }, + "DataSourceCredentials": { + "additionalProperties": false, + "description": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", + "properties": { + "CopySourceArn": { + "description": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

", + "pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$", + "type": "string" + }, + "CredentialPair": { + "$ref": "#/definitions/CredentialPair" + }, + "SecretArn": { + "description": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$", + "type": "string" + } + }, + "type": "object" + }, + "DataSourceErrorInfo": { + "additionalProperties": false, + "description": "

Error information for the data source creation or update.

", + "properties": { + "Message": { + "description": "

Error message.

", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/DataSourceErrorInfoType" + } + }, + "type": "object" + }, + "DataSourceErrorInfoType": { + "enum": [ + "ACCESS_DENIED", + "COPY_SOURCE_NOT_FOUND", + "TIMEOUT", + "ENGINE_VERSION_NOT_SUPPORTED", + "UNKNOWN_HOST", + "GENERIC_SQL_FAILURE", + "CONFLICT", + "UNKNOWN" + ], + "type": "string" + }, + "DataSourceParameters": { + "additionalProperties": false, + "description": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

", + "properties": { + "AmazonElasticsearchParameters": { + "$ref": "#/definitions/AmazonElasticsearchParameters" + }, + "AmazonOpenSearchParameters": { + "$ref": "#/definitions/AmazonOpenSearchParameters" + }, + "AthenaParameters": { + "$ref": "#/definitions/AthenaParameters" + }, + "AuroraParameters": { + "$ref": "#/definitions/AuroraParameters" + }, + "AuroraPostgreSqlParameters": { + "$ref": "#/definitions/AuroraPostgreSqlParameters" + }, + "DatabricksParameters": { + "$ref": "#/definitions/DatabricksParameters" + }, + "MariaDbParameters": { + "$ref": "#/definitions/MariaDbParameters" + }, + "MySqlParameters": { + "$ref": "#/definitions/MySqlParameters" + }, + "OracleParameters": { + "$ref": "#/definitions/OracleParameters" + }, + "PostgreSqlParameters": { + "$ref": "#/definitions/PostgreSqlParameters" + }, + "PrestoParameters": { + "$ref": "#/definitions/PrestoParameters" + }, + "RdsParameters": { + "$ref": "#/definitions/RdsParameters" + }, + "RedshiftParameters": { + "$ref": "#/definitions/RedshiftParameters" + }, + "S3Parameters": { + "$ref": "#/definitions/S3Parameters" + }, + "SnowflakeParameters": { + "$ref": "#/definitions/SnowflakeParameters" + }, + "SparkParameters": { + "$ref": "#/definitions/SparkParameters" + }, + "SqlServerParameters": { + "$ref": "#/definitions/SqlServerParameters" + }, + "StarburstParameters": { + "$ref": "#/definitions/StarburstParameters" + }, + "TeradataParameters": { + "$ref": "#/definitions/TeradataParameters" + }, + "TrinoParameters": { + "$ref": "#/definitions/TrinoParameters" + } + }, + "type": "object" + }, + "DataSourceType": { + "enum": [ + "ADOBE_ANALYTICS", + "AMAZON_ELASTICSEARCH", + "AMAZON_OPENSEARCH", + "ATHENA", + "AURORA", + "AURORA_POSTGRESQL", + "AWS_IOT_ANALYTICS", + "DATABRICKS", + "DENODO", + "DREMIO", + "DYNAMODB", + "SAPHANA", + "DB2_AS400", + "EXASOL", + "FILE", + "GITHUB", + "JIRA", + "MARIADB", + "MYSQL", + "ORACLE", + "POSTGRESQL", + "PRESTO", + "REDSHIFT", + "S3", + "SALESFORCE", + "SERVICENOW", + "SNOWFLAKE", + "SPARK", + "SQLSERVER", + "TERADATA", + "TIMESTREAM", + "TWITTER", + "BIGQUERY", + "GOOGLE_ANALYTICS", + "TRINO", + "STARBURST", + "MONGO", + "MONGO_ATLAS", + "DOCUMENTDB", + "APPFLOW", + "IMPALA", + "GLUE" + ], + "type": "string" + }, + "DatabricksParameters": { + "additionalProperties": false, + "description": "

The parameters that are required to connect to a Databricks data source.

", + "properties": { + "Host": { + "description": "

The host name of the Databricks data source.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

The port for the Databricks data source.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + }, + "SqlEndpointPath": { + "description": "

The HTTP path of the Databricks data source.

", + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Host", + "Port", + "SqlEndpointPath" + ], + "type": "object" + }, + "IdentityCenterConfiguration": { + "additionalProperties": false, + "description": "

The parameters for an IAM Identity Center configuration.

", + "properties": { + "EnableIdentityPropagation": { + "default": null, + "description": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

", + "type": "boolean" + } + }, + "type": "object" + }, + "ManifestFileLocation": { + "additionalProperties": false, + "description": "

Amazon S3 manifest file location.

", + "properties": { + "Bucket": { + "description": "

Amazon S3 bucket.

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Key": { + "description": "

Amazon S3 key that identifies an object.

", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "MariaDbParameters": { + "additionalProperties": false, + "description": "

The parameters for MariaDB.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "MySqlParameters": { + "additionalProperties": false, + "description": "

The parameters for MySQL.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "OracleParameters": { + "additionalProperties": false, + "description": "

The parameters for Oracle.

", + "properties": { + "Database": { + "description": "

The database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

An Oracle host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

The port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "PostgreSqlParameters": { + "additionalProperties": false, + "description": "

The parameters for PostgreSQL.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "PrestoParameters": { + "additionalProperties": false, + "description": "

The parameters for Presto.

", + "properties": { + "Catalog": { + "description": "

Catalog.

", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Catalog", + "Host", + "Port" + ], + "type": "object" + }, + "RdsParameters": { + "additionalProperties": false, + "description": "

The parameters for Amazon RDS.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InstanceId": { + "description": "

Instance ID.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Database", + "InstanceId" + ], + "type": "object" + }, + "RedshiftIAMParameters": { + "additionalProperties": false, + "description": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

", + "properties": { + "AutoCreateDatabaseUser": { + "default": false, + "description": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

", + "type": "boolean" + }, + "DatabaseGroups": { + "description": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

", + "items": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "DatabaseUser": { + "description": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "RedshiftParameters": { + "additionalProperties": false, + "description": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

", + "properties": { + "ClusterId": { + "description": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host. This field can be blank if ClusterId is provided.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "IAMParameters": { + "$ref": "#/definitions/RedshiftIAMParameters" + }, + "IdentityCenterConfiguration": { + "$ref": "#/definitions/IdentityCenterConfiguration" + }, + "Port": { + "default": 0, + "description": "

Port. This field can be blank if the ClusterId is provided.

", + "maximum": 65535, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "Database" + ], + "type": "object" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Resource": { + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "ResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETED" + ], + "type": "string" + }, + "S3Parameters": { + "additionalProperties": false, + "description": "

The parameters for S3.

", + "properties": { + "ManifestFileLocation": { + "$ref": "#/definitions/ManifestFileLocation" + }, + "RoleArn": { + "description": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "ManifestFileLocation" + ], + "type": "object" + }, + "SnowflakeParameters": { + "additionalProperties": false, + "description": "

The parameters for Snowflake.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Warehouse": { + "description": "

Warehouse.

", + "maxLength": 128, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Database", + "Host", + "Warehouse" + ], + "type": "object" + }, + "SparkParameters": { + "additionalProperties": false, + "description": "

The parameters for Spark.

", + "properties": { + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Host", + "Port" + ], + "type": "object" + }, + "SqlServerParameters": { + "additionalProperties": false, + "description": "

The parameters for SQL Server.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "SslProperties": { + "additionalProperties": false, + "description": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

", + "properties": { + "DisableSsl": { + "default": false, + "description": "

A Boolean option to control whether SSL should be disabled.

", + "type": "boolean" + } + }, + "type": "object" + }, + "StarburstParameters": { + "additionalProperties": false, + "description": "

The parameters that are required to connect to a Starburst data source.

", + "properties": { + "Catalog": { + "description": "

The catalog name for the Starburst data source.

", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Host": { + "description": "

The host name of the Starburst data source.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

The port for the Starburst data source.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + }, + "ProductType": { + "$ref": "#/definitions/StarburstProductType" + } + }, + "required": [ + "Catalog", + "Host", + "Port" + ], + "type": "object" + }, + "StarburstProductType": { + "enum": [ + "GALAXY", + "ENTERPRISE" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TeradataParameters": { + "additionalProperties": false, + "description": "

The parameters for Teradata.

", + "properties": { + "Database": { + "description": "

Database.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Host": { + "description": "

Host.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

Port.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Database", + "Host", + "Port" + ], + "type": "object" + }, + "TrinoParameters": { + "additionalProperties": false, + "description": "

The parameters that are required to connect to a Trino data source.

", + "properties": { + "Catalog": { + "description": "

The catalog name for the Trino data source.

", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Host": { + "description": "

The host name of the Trino data source.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Port": { + "default": 0, + "description": "

The port for the Trino data source.

", + "maximum": 65535, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Catalog", + "Host", + "Port" + ], + "type": "object" + }, + "VpcConnectionProperties": { + "additionalProperties": false, + "description": "

VPC connection properties.

", + "properties": { + "VpcConnectionArn": { + "description": "

The Amazon Resource Name (ARN) for the VPC connection.

", + "type": "string" + } + }, + "required": [ + "VpcConnectionArn" + ], + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::DataSource Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:CreateDataSource", + "quicksight:DescribeDataSource", + "quicksight:DescribeDataSourcePermissions", + "quicksight:TagResource", + "quicksight:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeDataSource", + "quicksight:DescribeDataSourcePermissions", + "quicksight:DeleteDataSource", + "quicksight:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "quicksight:DescribeDataSource", + "quicksight:ListDataSources" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeDataSource", + "quicksight:DescribeDataSourcePermissions", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeDataSource", + "quicksight:DescribeDataSourcePermissions", + "quicksight:UpdateDataSource", + "quicksight:UpdateDataSourcePermissions", + "quicksight:CreateFolderMembership", + "quicksight:DeleteFolderMembership", + "quicksight:ListFoldersForResource", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/DataSourceId" + ], + "properties": { + "AlternateDataSourceParameters": { + "description": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

", + "items": { + "$ref": "#/definitions/DataSourceParameters" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the data source.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "CreatedTime": { + "description": "

The time that this data source was created.

", + "format": "date-time", + "type": "string" + }, + "Credentials": { + "$ref": "#/definitions/DataSourceCredentials" + }, + "DataSourceId": { + "type": "string" + }, + "DataSourceParameters": { + "$ref": "#/definitions/DataSourceParameters" + }, + "ErrorInfo": { + "$ref": "#/definitions/DataSourceErrorInfo" + }, + "LastUpdatedTime": { + "description": "

The last time that this data source was updated.

", + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "SslProperties": { + "$ref": "#/definitions/SslProperties" + }, + "Status": { + "$ref": "#/definitions/ResourceStatus" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/DataSourceType" + }, + "VpcConnectionProperties": { + "$ref": "#/definitions/VpcConnectionProperties" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/Status" + ], + "required": [ + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "typeName": "AWS::QuickSight::DataSource", + "writeOnlyProperties": [ + "/properties/Credentials" + ] +} diff --git a/schema/aws-quicksight-refreshschedule.json b/schema/aws-quicksight-refreshschedule.json index 1137036..a90d08d 100644 --- a/schema/aws-quicksight-refreshschedule.json +++ b/schema/aws-quicksight-refreshschedule.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/DataSetId", - "/properties/Schedule/ScheduleId" - ], - "definitions": { - "RefreshScheduleMap": { - "additionalProperties": false, - "properties": { - "RefreshType": { - "enum": [ - "FULL_REFRESH", - "INCREMENTAL_REFRESH" - ], - "type": "string" - }, - "ScheduleFrequency": { - "additionalProperties": false, - "description": "

Information about the schedule frequency.

", - "properties": { - "Interval": { - "enum": [ - "MINUTE15", - "MINUTE30", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY" - ], - "type": "string" - }, - "RefreshOnDay": { - "additionalProperties": false, - "description": "

The day scheduled for refresh.

", - "properties": { - "DayOfMonth": { - "description": "

The Day Of Month for scheduled refresh.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "DayOfWeek": { - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "TimeOfTheDay": { - "description": "

The time of the day for scheduled refresh.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "TimeZone": { - "description": "

The timezone for scheduled refresh.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "ScheduleId": { - "description": "

An unique identifier for the refresh schedule.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "StartAfterDateTime": { - "description": "

The date time after which refresh is to be scheduled

", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [], - "type": "object" - } - }, - "description": "Definition of the AWS::QuickSight::RefreshSchedule Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:CreateRefreshSchedule", - "quicksight:DescribeRefreshSchedule" - ] - }, - "delete": { - "permissions": [ - "quicksight:DeleteRefreshSchedule", - "quicksight:DescribeRefreshSchedule" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AwsAccountId": { - "$ref": "resource-schema.json#/properties/AwsAccountId" - }, - "DataSetId": { - "$ref": "resource-schema.json#/properties/DataSetId" - } - }, - "required": [ - "AwsAccountId", - "DataSetId" - ] - }, - "permissions": [ - "quicksight:ListRefreshSchedules" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeRefreshSchedule" - ] - }, - "update": { - "permissions": [ - "quicksight:UpdateRefreshSchedule", - "quicksight:DescribeRefreshSchedule" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/DataSetId", - "/properties/Schedule/ScheduleId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the data source.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "DataSetId": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/RefreshScheduleMap" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::QuickSight::RefreshSchedule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/DataSetId", + "/properties/Schedule/ScheduleId" + ], + "definitions": { + "RefreshScheduleMap": { + "additionalProperties": false, + "properties": { + "RefreshType": { + "enum": [ + "FULL_REFRESH", + "INCREMENTAL_REFRESH" + ], + "type": "string" + }, + "ScheduleFrequency": { + "additionalProperties": false, + "description": "

Information about the schedule frequency.

", + "properties": { + "Interval": { + "enum": [ + "MINUTE15", + "MINUTE30", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY" + ], + "type": "string" + }, + "RefreshOnDay": { + "additionalProperties": false, + "description": "

The day scheduled for refresh.

", + "properties": { + "DayOfMonth": { + "description": "

The Day Of Month for scheduled refresh.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "DayOfWeek": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "TimeOfTheDay": { + "description": "

The time of the day for scheduled refresh.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "TimeZone": { + "description": "

The timezone for scheduled refresh.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "ScheduleId": { + "description": "

An unique identifier for the refresh schedule.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "StartAfterDateTime": { + "description": "

The date time after which refresh is to be scheduled

", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [], + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::RefreshSchedule Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:CreateRefreshSchedule", + "quicksight:DescribeRefreshSchedule" + ] + }, + "delete": { + "permissions": [ + "quicksight:DeleteRefreshSchedule", + "quicksight:DescribeRefreshSchedule" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + }, + "DataSetId": { + "$ref": "resource-schema.json#/properties/DataSetId" + } + }, + "required": [ + "AwsAccountId", + "DataSetId" + ] + }, + "permissions": [ + "quicksight:ListRefreshSchedules" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeRefreshSchedule" + ] + }, + "update": { + "permissions": [ + "quicksight:UpdateRefreshSchedule", + "quicksight:DescribeRefreshSchedule" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/DataSetId", + "/properties/Schedule/ScheduleId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the data source.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DataSetId": { + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/RefreshScheduleMap" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::QuickSight::RefreshSchedule" +} diff --git a/schema/aws-quicksight-template.json b/schema/aws-quicksight-template.json index 3e21f0f..dda9d57 100644 --- a/schema/aws-quicksight-template.json +++ b/schema/aws-quicksight-template.json @@ -1,11304 +1,11429 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/TemplateId" - ], - "definitions": { - "AggregationFunction": { - "additionalProperties": false, - "properties": { - "AttributeAggregationFunction": { - "$ref": "#/definitions/AttributeAggregationFunction" - }, - "CategoricalAggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "DateAggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "NumericalAggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - } - }, - "type": "object" - }, - "AggregationSortConfiguration": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SortDirection": { - "$ref": "#/definitions/SortDirection" - } - }, - "required": [ - "Column", - "SortDirection" - ], - "type": "object" - }, - "AllSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "type": "object" - }, - "AnalysisDefaults": { - "additionalProperties": false, - "properties": { - "DefaultNewSheetConfiguration": { - "$ref": "#/definitions/DefaultNewSheetConfiguration" - } - }, - "required": [ - "DefaultNewSheetConfiguration" - ], - "type": "object" - }, - "AnchorDateConfiguration": { - "additionalProperties": false, - "properties": { - "AnchorOption": { - "$ref": "#/definitions/AnchorOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "type": "object" - }, - "AnchorOption": { - "enum": [ - "NOW" - ], - "type": "string" - }, - "ArcAxisConfiguration": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/ArcAxisDisplayRange" - }, - "ReserveRange": { - "default": 0, - "type": "number" - } - }, - "type": "object" - }, - "ArcAxisDisplayRange": { - "additionalProperties": false, - "properties": { - "Max": { - "default": null, - "type": "number" - }, - "Min": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "ArcConfiguration": { - "additionalProperties": false, - "properties": { - "ArcAngle": { - "default": null, - "type": "number" - }, - "ArcThickness": { - "$ref": "#/definitions/ArcThicknessOptions" - } - }, - "type": "object" - }, - "ArcOptions": { - "additionalProperties": false, - "properties": { - "ArcThickness": { - "$ref": "#/definitions/ArcThickness" - } - }, - "type": "object" - }, - "ArcThickness": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE", - "WHOLE" - ], - "type": "string" - }, - "ArcThicknessOptions": { - "enum": [ - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "AssetOptions": { - "additionalProperties": false, - "properties": { - "Timezone": { - "type": "string" - }, - "WeekStart": { - "$ref": "#/definitions/DayOfTheWeek" - } - }, - "type": "object" - }, - "AttributeAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleAttributeAggregation": { - "$ref": "#/definitions/SimpleAttributeAggregationFunction" - }, - "ValueForMultipleValues": { - "type": "string" - } - }, - "type": "object" - }, - "AxisBinding": { - "enum": [ - "PRIMARY_YAXIS", - "SECONDARY_YAXIS" - ], - "type": "string" - }, - "AxisDataOptions": { - "additionalProperties": false, - "properties": { - "DateAxisOptions": { - "$ref": "#/definitions/DateAxisOptions" - }, - "NumericAxisOptions": { - "$ref": "#/definitions/NumericAxisOptions" - } - }, - "type": "object" - }, - "AxisDisplayDataDrivenRange": { - "additionalProperties": false, - "type": "object" - }, - "AxisDisplayMinMaxRange": { - "additionalProperties": false, - "properties": { - "Maximum": { - "default": null, - "type": "number" - }, - "Minimum": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AxisOffset": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "DataOptions": { - "$ref": "#/definitions/AxisDataOptions" - }, - "GridLineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ScrollbarOptions": { - "$ref": "#/definitions/ScrollBarOptions" - }, - "TickLabelOptions": { - "$ref": "#/definitions/AxisTickLabelOptions" - } - }, - "type": "object" - }, - "AxisDisplayRange": { - "additionalProperties": false, - "properties": { - "DataDriven": { - "$ref": "#/definitions/AxisDisplayDataDrivenRange" - }, - "MinMax": { - "$ref": "#/definitions/AxisDisplayMinMaxRange" - } - }, - "type": "object" - }, - "AxisLabelOptions": { - "additionalProperties": false, - "properties": { - "ApplyTo": { - "$ref": "#/definitions/AxisLabelReferenceOptions" - }, - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "AxisLabelReferenceOptions": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "AxisLinearScale": { - "additionalProperties": false, - "properties": { - "StepCount": { - "default": null, - "type": "number" - }, - "StepSize": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisLogarithmicScale": { - "additionalProperties": false, - "properties": { - "Base": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "AxisScale": { - "additionalProperties": false, - "properties": { - "Linear": { - "$ref": "#/definitions/AxisLinearScale" - }, - "Logarithmic": { - "$ref": "#/definitions/AxisLogarithmicScale" - } - }, - "type": "object" - }, - "AxisTickLabelOptions": { - "additionalProperties": false, - "properties": { - "LabelOptions": { - "$ref": "#/definitions/LabelOptions" - }, - "RotationAngle": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "BarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Orientation": { - "$ref": "#/definitions/BarChartOrientation" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/BarChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BarChartFieldWells": { - "additionalProperties": false, - "properties": { - "BarChartAggregatedFieldWells": { - "$ref": "#/definitions/BarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "BarChartOrientation": { - "enum": [ - "HORIZONTAL", - "VERTICAL" - ], - "type": "string" - }, - "BarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "BarsArrangement": { - "enum": [ - "CLUSTERED", - "STACKED", - "STACKED_PERCENT" - ], - "type": "string" - }, - "BaseMapStyleType": { - "enum": [ - "LIGHT_GRAY", - "DARK_GRAY", - "STREET", - "IMAGERY" - ], - "type": "string" - }, - "BinCountOptions": { - "additionalProperties": false, - "properties": { - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BinWidthOptions": { - "additionalProperties": false, - "properties": { - "BinCountLimit": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "Value": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "BodySectionConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/BodySectionContent" - }, - "PageBreakConfiguration": { - "$ref": "#/definitions/SectionPageBreakConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Content", - "SectionId" - ], - "type": "object" - }, - "BodySectionContent": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - } - }, - "type": "object" - }, - "BoxPlotAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "BoxPlotChartConfiguration": { - "additionalProperties": false, - "properties": { - "BoxPlotOptions": { - "$ref": "#/definitions/BoxPlotOptions" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/BoxPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SortConfiguration": { - "$ref": "#/definitions/BoxPlotSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "BoxPlotFieldWells": { - "additionalProperties": false, - "properties": { - "BoxPlotAggregatedFieldWells": { - "$ref": "#/definitions/BoxPlotAggregatedFieldWells" - } - }, - "type": "object" - }, - "BoxPlotFillStyle": { - "enum": [ - "SOLID", - "TRANSPARENT" - ], - "type": "string" - }, - "BoxPlotOptions": { - "additionalProperties": false, - "properties": { - "AllDataPointsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "OutlierVisibility": { - "$ref": "#/definitions/Visibility" - }, - "StyleOptions": { - "$ref": "#/definitions/BoxPlotStyleOptions" - } - }, - "type": "object" - }, - "BoxPlotSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - } - }, - "type": "object" - }, - "BoxPlotStyleOptions": { - "additionalProperties": false, - "properties": { - "FillStyle": { - "$ref": "#/definitions/BoxPlotFillStyle" - } - }, - "type": "object" - }, - "BoxPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/BoxPlotChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "CalculatedField": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 32000, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 127, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "Expression", - "Name" - ], - "type": "object" - }, - "CalculatedMeasureField": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression", - "FieldId" - ], - "type": "object" - }, - "CascadingControlConfiguration": { - "additionalProperties": false, - "properties": { - "SourceControls": { - "items": { - "$ref": "#/definitions/CascadingControlSource" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CascadingControlSource": { - "additionalProperties": false, - "properties": { - "ColumnToMatch": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceSheetControlId": { - "type": "string" - } - }, - "type": "object" - }, - "CategoricalAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT" - ], - "type": "string" - }, - "CategoricalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoricalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/CategoricalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "CategoryDrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "CategoryValues", - "Column" - ], - "type": "object" - }, - "CategoryFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Configuration": { - "$ref": "#/definitions/CategoryFilterConfiguration" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "Column", - "Configuration", - "FilterId" - ], - "type": "object" - }, - "CategoryFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CustomFilterConfiguration": { - "$ref": "#/definitions/CustomFilterConfiguration" - }, - "CustomFilterListConfiguration": { - "$ref": "#/definitions/CustomFilterListConfiguration" - }, - "FilterListConfiguration": { - "$ref": "#/definitions/FilterListConfiguration" - } - }, - "type": "object" - }, - "CategoryFilterMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL", - "CONTAINS", - "DOES_NOT_CONTAIN", - "STARTS_WITH", - "ENDS_WITH" - ], - "type": "string" - }, - "CategoryFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "ChartAxisLabelOptions": { - "additionalProperties": false, - "properties": { - "AxisLabelOptions": { - "items": { - "$ref": "#/definitions/AxisLabelOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SortIconVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ClusterMarker": { - "additionalProperties": false, - "properties": { - "SimpleClusterMarker": { - "$ref": "#/definitions/SimpleClusterMarker" - } - }, - "type": "object" - }, - "ClusterMarkerConfiguration": { - "additionalProperties": false, - "properties": { - "ClusterMarker": { - "$ref": "#/definitions/ClusterMarker" - } - }, - "type": "object" - }, - "ColorFillType": { - "enum": [ - "DISCRETE", - "GRADIENT" - ], - "type": "string" - }, - "ColorScale": { - "additionalProperties": false, - "properties": { - "ColorFillType": { - "$ref": "#/definitions/ColorFillType" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DataColor" - }, - "maxItems": 3, - "minItems": 2, - "type": "array" - }, - "NullValueColor": { - "$ref": "#/definitions/DataColor" - } - }, - "required": [ - "ColorFillType", - "Colors" - ], - "type": "object" - }, - "ColorsConfiguration": { - "additionalProperties": false, - "properties": { - "CustomColors": { - "items": { - "$ref": "#/definitions/CustomColor" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ColumnConfiguration": { - "additionalProperties": false, - "properties": { - "ColorsConfiguration": { - "$ref": "#/definitions/ColorsConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - }, - "Role": { - "$ref": "#/definitions/ColumnRole" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ColumnGroupColumnSchema": { - "additionalProperties": false, - "description": "

A structure describing the name, data type, and geographic role of the columns.

", - "properties": { - "Name": { - "description": "

The name of the column group's column schema.

", - "type": "string" - } - }, - "type": "object" - }, - "ColumnGroupSchema": { - "additionalProperties": false, - "description": "

The column group schema.

", - "properties": { - "ColumnGroupColumnSchemaList": { - "description": "

A structure containing the list of schemas for column group columns.

", - "items": { - "$ref": "#/definitions/ColumnGroupColumnSchema" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - }, - "Name": { - "description": "

The name of the column group schema.

", - "type": "string" - } - }, - "type": "object" - }, - "ColumnHierarchy": { - "additionalProperties": false, - "properties": { - "DateTimeHierarchy": { - "$ref": "#/definitions/DateTimeHierarchy" - }, - "ExplicitHierarchy": { - "$ref": "#/definitions/ExplicitHierarchy" - }, - "PredefinedHierarchy": { - "$ref": "#/definitions/PredefinedHierarchy" - } - }, - "type": "object" - }, - "ColumnIdentifier": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ColumnName", - "DataSetIdentifier" - ], - "type": "object" - }, - "ColumnRole": { - "enum": [ - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "ColumnSchema": { - "additionalProperties": false, - "description": "

The column schema.

", - "properties": { - "DataType": { - "description": "

The data type of the column schema.

", - "type": "string" - }, - "GeographicRole": { - "description": "

The geographic role of the column schema.

", - "type": "string" - }, - "Name": { - "description": "

The name of the column schema.

", - "type": "string" - } - }, - "type": "object" - }, - "ColumnSort": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortBy": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "Direction", - "SortBy" - ], - "type": "object" - }, - "ColumnTooltipItem": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "ComboChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "BarValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "LineValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartConfiguration": { - "additionalProperties": false, - "properties": { - "BarDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "BarsArrangement": { - "$ref": "#/definitions/BarsArrangement" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ComboChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "LineDataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/ComboChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "ComboChartFieldWells": { - "additionalProperties": false, - "properties": { - "ComboChartAggregatedFieldWells": { - "$ref": "#/definitions/ComboChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "ComboChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ComboChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ComboChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ComparisonConfiguration": { - "additionalProperties": false, - "properties": { - "ComparisonFormat": { - "$ref": "#/definitions/ComparisonFormatConfiguration" - }, - "ComparisonMethod": { - "$ref": "#/definitions/ComparisonMethod" - } - }, - "type": "object" - }, - "ComparisonFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "ComparisonMethod": { - "enum": [ - "DIFFERENCE", - "PERCENT_DIFFERENCE", - "PERCENT" - ], - "type": "string" - }, - "Computation": { - "additionalProperties": false, - "properties": { - "Forecast": { - "$ref": "#/definitions/ForecastComputation" - }, - "GrowthRate": { - "$ref": "#/definitions/GrowthRateComputation" - }, - "MaximumMinimum": { - "$ref": "#/definitions/MaximumMinimumComputation" - }, - "MetricComparison": { - "$ref": "#/definitions/MetricComparisonComputation" - }, - "PeriodOverPeriod": { - "$ref": "#/definitions/PeriodOverPeriodComputation" - }, - "PeriodToDate": { - "$ref": "#/definitions/PeriodToDateComputation" - }, - "TopBottomMovers": { - "$ref": "#/definitions/TopBottomMoversComputation" - }, - "TopBottomRanked": { - "$ref": "#/definitions/TopBottomRankedComputation" - }, - "TotalAggregation": { - "$ref": "#/definitions/TotalAggregationComputation" - }, - "UniqueValues": { - "$ref": "#/definitions/UniqueValuesComputation" - } - }, - "type": "object" - }, - "ConditionalFormattingColor": { - "additionalProperties": false, - "properties": { - "Gradient": { - "$ref": "#/definitions/ConditionalFormattingGradientColor" - }, - "Solid": { - "$ref": "#/definitions/ConditionalFormattingSolidColor" - } - }, - "type": "object" - }, - "ConditionalFormattingCustomIconCondition": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DisplayConfiguration": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconOptions": { - "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" - } - }, - "required": [ - "Expression", - "IconOptions" - ], - "type": "object" - }, - "ConditionalFormattingCustomIconOptions": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/Icon" - }, - "UnicodeIcon": { - "pattern": "^[^\\u0000-\\u00FF]$", - "type": "string" - } - }, - "type": "object" - }, - "ConditionalFormattingGradientColor": { - "additionalProperties": false, - "properties": { - "Color": { - "$ref": "#/definitions/GradientColor" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Color", - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIcon": { - "additionalProperties": false, - "properties": { - "CustomCondition": { - "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" - }, - "IconSet": { - "$ref": "#/definitions/ConditionalFormattingIconSet" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayConfiguration": { - "additionalProperties": false, - "properties": { - "IconDisplayOption": { - "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" - } - }, - "type": "object" - }, - "ConditionalFormattingIconDisplayOption": { - "enum": [ - "ICON_ONLY" - ], - "type": "string" - }, - "ConditionalFormattingIconSet": { - "additionalProperties": false, - "properties": { - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IconSetType": { - "$ref": "#/definitions/ConditionalFormattingIconSetType" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ConditionalFormattingIconSetType": { - "enum": [ - "PLUS_MINUS", - "CHECK_X", - "THREE_COLOR_ARROW", - "THREE_GRAY_ARROW", - "CARET_UP_MINUS_DOWN", - "THREE_SHAPE", - "THREE_CIRCLE", - "FLAGS", - "BARS", - "FOUR_COLOR_ARROW", - "FOUR_GRAY_ARROW" - ], - "type": "string" - }, - "ConditionalFormattingSolidColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "ContributionAnalysisDefault": { - "additionalProperties": false, - "properties": { - "ContributorDimensions": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 4, - "minItems": 1, - "type": "array" - }, - "MeasureFieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ContributorDimensions", - "MeasureFieldId" - ], - "type": "object" - }, - "CrossDatasetTypes": { - "enum": [ - "ALL_DATASETS", - "SINGLE_DATASET" - ], - "type": "string" - }, - "CurrencyDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Symbol": { - "pattern": "^[A-Z]{3}$", - "type": "string" - } - }, - "type": "object" - }, - "CustomActionFilterOperation": { - "additionalProperties": false, - "properties": { - "SelectedFieldsConfiguration": { - "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" - }, - "TargetVisualsConfiguration": { - "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" - } - }, - "required": [ - "SelectedFieldsConfiguration", - "TargetVisualsConfiguration" - ], - "type": "object" - }, - "CustomActionNavigationOperation": { - "additionalProperties": false, - "properties": { - "LocalNavigationConfiguration": { - "$ref": "#/definitions/LocalNavigationConfiguration" - } - }, - "type": "object" - }, - "CustomActionSetParametersOperation": { - "additionalProperties": false, - "properties": { - "ParameterValueConfigurations": { - "items": { - "$ref": "#/definitions/SetParameterValueConfiguration" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ParameterValueConfigurations" - ], - "type": "object" - }, - "CustomActionURLOperation": { - "additionalProperties": false, - "properties": { - "URLTarget": { - "$ref": "#/definitions/URLTargetConfiguration" - }, - "URLTemplate": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "URLTarget", - "URLTemplate" - ], - "type": "object" - }, - "CustomColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "SpecialValue": { - "$ref": "#/definitions/SpecialValue" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "CustomContentConfiguration": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/CustomContentType" - }, - "ContentUrl": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ImageScaling": { - "$ref": "#/definitions/CustomContentImageScalingConfiguration" - } - }, - "type": "object" - }, - "CustomContentImageScalingConfiguration": { - "enum": [ - "FIT_TO_HEIGHT", - "FIT_TO_WIDTH", - "DO_NOT_SCALE", - "SCALE_TO_VISUAL" - ], - "type": "string" - }, - "CustomContentType": { - "enum": [ - "IMAGE", - "OTHER_EMBEDDED_CONTENT" - ], - "type": "string" - }, - "CustomContentVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/CustomContentConfiguration" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "CustomFilterConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValue": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomFilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "CustomNarrativeOptions": { - "additionalProperties": false, - "properties": { - "Narrative": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Narrative" - ], - "type": "object" - }, - "CustomParameterValues": { - "additionalProperties": false, - "properties": { - "DateTimeValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "DecimalValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "IntegerValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - }, - "StringValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "CustomValuesConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValues": { - "$ref": "#/definitions/CustomParameterValues" - }, - "IncludeNullValue": { - "type": "boolean" - } - }, - "required": [ - "CustomValues" - ], - "type": "object" - }, - "DataBarsOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "NegativeColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "DataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "DataFieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "DataLabelContent": { - "enum": [ - "VALUE", - "PERCENT", - "VALUE_AND_PERCENT" - ], - "type": "string" - }, - "DataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DataLabelTypes": { - "items": { - "$ref": "#/definitions/DataLabelType" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelContent": { - "$ref": "#/definitions/DataLabelContent" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Overlap": { - "$ref": "#/definitions/DataLabelOverlap" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataLabelOverlap": { - "enum": [ - "DISABLE_OVERLAP", - "ENABLE_OVERLAP" - ], - "type": "string" - }, - "DataLabelPosition": { - "enum": [ - "INSIDE", - "OUTSIDE", - "LEFT", - "TOP", - "BOTTOM", - "RIGHT" - ], - "type": "string" - }, - "DataLabelType": { - "additionalProperties": false, - "properties": { - "DataPathLabelType": { - "$ref": "#/definitions/DataPathLabelType" - }, - "FieldLabelType": { - "$ref": "#/definitions/FieldLabelType" - }, - "MaximumLabelType": { - "$ref": "#/definitions/MaximumLabelType" - }, - "MinimumLabelType": { - "$ref": "#/definitions/MinimumLabelType" - }, - "RangeEndsLabelType": { - "$ref": "#/definitions/RangeEndsLabelType" - } - }, - "type": "object" - }, - "DataPathColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Element": { - "$ref": "#/definitions/DataPathValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Color", - "Element" - ], - "type": "object" - }, - "DataPathLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DataPathSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "SortPaths": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Direction", - "SortPaths" - ], - "type": "object" - }, - "DataPathType": { - "additionalProperties": false, - "properties": { - "PivotTableDataPathType": { - "$ref": "#/definitions/PivotTableDataPathType" - } - }, - "type": "object" - }, - "DataPathValue": { - "additionalProperties": false, - "properties": { - "DataPathType": { - "$ref": "#/definitions/DataPathType" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FieldValue": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "DataSetConfiguration": { - "additionalProperties": false, - "description": "

Dataset configuration.

", - "properties": { - "ColumnGroupSchemaList": { - "description": "

A structure containing the list of column group schemas.

", - "items": { - "$ref": "#/definitions/ColumnGroupSchema" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - }, - "DataSetSchema": { - "$ref": "#/definitions/DataSetSchema" - }, - "Placeholder": { - "description": "

Placeholder.

", - "type": "string" - } - }, - "type": "object" - }, - "DataSetReference": { - "additionalProperties": false, - "description": "

Dataset reference.

", - "properties": { - "DataSetArn": { - "description": "

Dataset Amazon Resource Name (ARN).

", - "type": "string" - }, - "DataSetPlaceholder": { - "description": "

Dataset placeholder.

", - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "DataSetSchema": { - "additionalProperties": false, - "description": "

Dataset schema.

", - "properties": { - "ColumnSchemaList": { - "description": "

A structure containing the list of column schemas.

", - "items": { - "$ref": "#/definitions/ColumnSchema" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DateAggregationFunction": { - "enum": [ - "COUNT", - "DISTINCT_COUNT", - "MIN", - "MAX" - ], - "type": "string" - }, - "DateAxisOptions": { - "additionalProperties": false, - "properties": { - "MissingDateVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DateDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DateGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/DateAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "DateTimeDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValues": { - "items": { - "format": "date-time", - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DateTimeFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "DateTimeHierarchy": { - "additionalProperties": false, - "properties": { - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "HierarchyId" - ], - "type": "object" - }, - "DateTimeParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DateTimeDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "DateTimePickerControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DateTimeValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "format": "date-time", - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DayOfTheWeek": { - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], - "type": "string" - }, - "DecimalDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "DecimalParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/DecimalDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "DecimalPlacesConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlaces": { - "maximum": 20, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "DecimalPlaces" - ], - "type": "object" - }, - "DecimalValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "DefaultDateTimePickerControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "type": "object" - }, - "DefaultFilterControlConfiguration": { - "additionalProperties": false, - "properties": { - "ControlOptions": { - "$ref": "#/definitions/DefaultFilterControlOptions" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ControlOptions", - "Title" - ], - "type": "object" - }, - "DefaultFilterControlOptions": { - "additionalProperties": false, - "properties": { - "DefaultDateTimePickerOptions": { - "$ref": "#/definitions/DefaultDateTimePickerControlOptions" - }, - "DefaultDropdownOptions": { - "$ref": "#/definitions/DefaultFilterDropDownControlOptions" - }, - "DefaultListOptions": { - "$ref": "#/definitions/DefaultFilterListControlOptions" - }, - "DefaultRelativeDateTimeOptions": { - "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" - }, - "DefaultSliderOptions": { - "$ref": "#/definitions/DefaultSliderControlOptions" - }, - "DefaultTextAreaOptions": { - "$ref": "#/definitions/DefaultTextAreaControlOptions" - }, - "DefaultTextFieldOptions": { - "$ref": "#/definitions/DefaultTextFieldControlOptions" - } - }, - "type": "object" - }, - "DefaultFilterDropDownControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFilterListControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "type": "object" - }, - "DefaultFreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultGridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultInteractiveLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeForm": { - "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" - }, - "Grid": { - "$ref": "#/definitions/DefaultGridLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultNewSheetConfiguration": { - "additionalProperties": false, - "properties": { - "InteractiveLayoutConfiguration": { - "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" - }, - "PaginatedLayoutConfiguration": { - "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" - }, - "SheetContentType": { - "$ref": "#/definitions/SheetContentType" - } - }, - "type": "object" - }, - "DefaultPaginatedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "SectionBased": { - "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "DefaultRelativeDateTimeControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultSectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - } - }, - "required": [ - "CanvasSizeOptions" - ], - "type": "object" - }, - "DefaultSliderControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "StepSize" - ], - "type": "object" - }, - "DefaultTextAreaControlOptions": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - } - }, - "type": "object" - }, - "DefaultTextFieldControlOptions": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - } - }, - "type": "object" - }, - "DestinationParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValuesConfiguration": { - "$ref": "#/definitions/CustomValuesConfiguration" - }, - "SelectAllValueOptions": { - "$ref": "#/definitions/SelectAllValueOptions" - }, - "SourceColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "SourceField": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SourceParameterName": { - "type": "string" - } - }, - "type": "object" - }, - "DimensionField": { - "additionalProperties": false, - "properties": { - "CategoricalDimensionField": { - "$ref": "#/definitions/CategoricalDimensionField" - }, - "DateDimensionField": { - "$ref": "#/definitions/DateDimensionField" - }, - "NumericalDimensionField": { - "$ref": "#/definitions/NumericalDimensionField" - } - }, - "type": "object" - }, - "DonutCenterOptions": { - "additionalProperties": false, - "properties": { - "LabelVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "DonutOptions": { - "additionalProperties": false, - "properties": { - "ArcOptions": { - "$ref": "#/definitions/ArcOptions" - }, - "DonutCenterOptions": { - "$ref": "#/definitions/DonutCenterOptions" - } - }, - "type": "object" - }, - "DrillDownFilter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryDrillDownFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityDrillDownFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeDrillDownFilter" - } - }, - "type": "object" - }, - "DropDownControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "DynamicDefaultValue": { - "additionalProperties": false, - "properties": { - "DefaultValueColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "GroupNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "UserNameColumn": { - "$ref": "#/definitions/ColumnIdentifier" - } - }, - "required": [ - "DefaultValueColumn" - ], - "type": "object" - }, - "EmptyVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "Entity": { - "additionalProperties": false, - "properties": { - "Path": { - "pattern": "\\S", - "type": "string" - } - }, - "type": "object" - }, - "ExcludePeriodConfiguration": { - "additionalProperties": false, - "properties": { - "Amount": { - "default": null, - "type": "number" - }, - "Granularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "Amount", - "Granularity" - ], - "type": "object" - }, - "ExplicitHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 2, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "FieldBasedTooltip": { - "additionalProperties": false, - "properties": { - "AggregationVisibility": { - "$ref": "#/definitions/Visibility" - }, - "TooltipFields": { - "items": { - "$ref": "#/definitions/TooltipItem" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "TooltipTitleType": { - "$ref": "#/definitions/TooltipTitleType" - } - }, - "type": "object" - }, - "FieldLabelType": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FieldSeriesItem": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/LineChartSeriesSettings" - } - }, - "required": [ - "AxisBinding", - "FieldId" - ], - "type": "object" - }, - "FieldSort": { - "additionalProperties": false, - "properties": { - "Direction": { - "$ref": "#/definitions/SortDirection" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Direction", - "FieldId" - ], - "type": "object" - }, - "FieldSortOptions": { - "additionalProperties": false, - "properties": { - "ColumnSort": { - "$ref": "#/definitions/ColumnSort" - }, - "FieldSort": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "FieldTooltipItem": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Label": { - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/FilledMapConditionalFormattingOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "ConditionalFormattingOptions" - ], - "type": "object" - }, - "FilledMapConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Shape": { - "$ref": "#/definitions/FilledMapShapeConditionalFormatting" - } - }, - "required": [ - "Shape" - ], - "type": "object" - }, - "FilledMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/FilledMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/FilledMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "FilledMapFieldWells": { - "additionalProperties": false, - "properties": { - "FilledMapAggregatedFieldWells": { - "$ref": "#/definitions/FilledMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "FilledMapShapeConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Format": { - "$ref": "#/definitions/ShapeConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "FilledMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilledMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FilledMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/FilledMapConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/CategoryFilter" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/NumericEqualityFilter" - }, - "NumericRangeFilter": { - "$ref": "#/definitions/NumericRangeFilter" - }, - "RelativeDatesFilter": { - "$ref": "#/definitions/RelativeDatesFilter" - }, - "TimeEqualityFilter": { - "$ref": "#/definitions/TimeEqualityFilter" - }, - "TimeRangeFilter": { - "$ref": "#/definitions/TimeRangeFilter" - }, - "TopBottomFilter": { - "$ref": "#/definitions/TopBottomFilter" - } - }, - "type": "object" - }, - "FilterControl": { - "additionalProperties": false, - "properties": { - "CrossSheet": { - "$ref": "#/definitions/FilterCrossSheetControl" - }, - "DateTimePicker": { - "$ref": "#/definitions/FilterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/FilterDropDownControl" - }, - "List": { - "$ref": "#/definitions/FilterListControl" - }, - "RelativeDateTime": { - "$ref": "#/definitions/FilterRelativeDateTimeControl" - }, - "Slider": { - "$ref": "#/definitions/FilterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/FilterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/FilterTextFieldControl" - } - }, - "type": "object" - }, - "FilterCrossSheetControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId" - ], - "type": "object" - }, - "FilterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlDateTimePickerType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterGroup": { - "additionalProperties": false, - "properties": { - "CrossDataset": { - "$ref": "#/definitions/CrossDatasetTypes" - }, - "FilterGroupId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Filters": { - "items": { - "$ref": "#/definitions/Filter" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "ScopeConfiguration": { - "$ref": "#/definitions/FilterScopeConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "required": [ - "CrossDataset", - "FilterGroupId", - "Filters", - "ScopeConfiguration" - ], - "type": "object" - }, - "FilterListConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryValues": { - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "maxItems": 100000, - "minItems": 0, - "type": "array" - }, - "MatchOperator": { - "$ref": "#/definitions/CategoryFilterMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "SelectAllOptions": { - "$ref": "#/definitions/CategoryFilterSelectAllOptions" - } - }, - "required": [ - "MatchOperator" - ], - "type": "object" - }, - "FilterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/FilterSelectableValues" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterNullOption": { - "enum": [ - "ALL_VALUES", - "NULLS_ONLY", - "NON_NULLS_ONLY" - ], - "type": "string" - }, - "FilterOperationSelectedFieldsConfiguration": { - "additionalProperties": false, - "properties": { - "SelectedColumns": { - "description": "

The selected columns of a dataset.

", - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "$ref": "#/definitions/SelectedFieldOptions" - }, - "SelectedFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "FilterOperationTargetVisualsConfiguration": { - "additionalProperties": false, - "properties": { - "SameSheetTargetVisualConfiguration": { - "$ref": "#/definitions/SameSheetTargetVisualConfiguration" - } - }, - "type": "object" - }, - "FilterRelativeDateTimeControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "AllSheets": { - "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" - }, - "SelectedSheets": { - "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" - } - }, - "type": "object" - }, - "FilterSelectableValues": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FilterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlSliderType" - } - }, - "required": [ - "FilterControlId", - "MaximumValue", - "MinimumValue", - "SourceFilterId", - "StepSize", - "Title" - ], - "type": "object" - }, - "FilterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "FilterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceFilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FilterControlId", - "SourceFilterId", - "Title" - ], - "type": "object" - }, - "FilterVisualScope": { - "enum": [ - "ALL_VISUALS", - "SELECTED_VISUALS" - ], - "type": "string" - }, - "FontConfiguration": { - "additionalProperties": false, - "properties": { - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontDecoration": { - "$ref": "#/definitions/FontDecoration" - }, - "FontSize": { - "$ref": "#/definitions/FontSize" - }, - "FontStyle": { - "$ref": "#/definitions/FontStyle" - }, - "FontWeight": { - "$ref": "#/definitions/FontWeight" - } - }, - "type": "object" - }, - "FontDecoration": { - "enum": [ - "UNDERLINE", - "NONE" - ], - "type": "string" - }, - "FontSize": { - "additionalProperties": false, - "properties": { - "Relative": { - "$ref": "#/definitions/RelativeFontSize" - } - }, - "type": "object" - }, - "FontStyle": { - "enum": [ - "NORMAL", - "ITALIC" - ], - "type": "string" - }, - "FontWeight": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/FontWeightName" - } - }, - "type": "object" - }, - "FontWeightName": { - "enum": [ - "NORMAL", - "BOLD" - ], - "type": "string" - }, - "ForecastComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "CustomSeasonalityValue": { - "default": null, - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "LowerBoundary": { - "default": null, - "type": "number" - }, - "Name": { - "type": "string" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "$ref": "#/definitions/ForecastComputationSeasonality" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "UpperBoundary": { - "default": null, - "type": "number" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ForecastComputationSeasonality": { - "enum": [ - "AUTOMATIC", - "CUSTOM" - ], - "type": "string" - }, - "ForecastConfiguration": { - "additionalProperties": false, - "properties": { - "ForecastProperties": { - "$ref": "#/definitions/TimeBasedForecastProperties" - }, - "Scenario": { - "$ref": "#/definitions/ForecastScenario" - } - }, - "type": "object" - }, - "ForecastScenario": { - "additionalProperties": false, - "properties": { - "WhatIfPointScenario": { - "$ref": "#/definitions/WhatIfPointScenario" - }, - "WhatIfRangeScenario": { - "$ref": "#/definitions/WhatIfRangeScenario" - } - }, - "type": "object" - }, - "FormatConfiguration": { - "additionalProperties": false, - "properties": { - "DateTimeFormatConfiguration": { - "$ref": "#/definitions/DateTimeFormatConfiguration" - }, - "NumberFormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "StringFormatConfiguration": { - "$ref": "#/definitions/StringFormatConfiguration" - } - }, - "type": "object" - }, - "FreeFormLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "FreeFormLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FreeFormLayoutElement": { - "additionalProperties": false, - "properties": { - "BackgroundStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" - }, - "BorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "LoadingAnimation": { - "$ref": "#/definitions/LoadingAnimation" - }, - "RenderingRules": { - "items": { - "$ref": "#/definitions/SheetElementRenderingRule" - }, - "maxItems": 10000, - "minItems": 0, - "type": "array" - }, - "SelectedBorderStyle": { - "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "XAxisLocation": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "YAxisLocation": { - "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", - "type": "string" - } - }, - "required": [ - "ElementId", - "ElementType", - "Height", - "Width", - "XAxisLocation", - "YAxisLocation" - ], - "type": "object" - }, - "FreeFormLayoutElementBackgroundStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutElementBorderStyle": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FreeFormLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "OptimizedViewPortWidth" - ], - "type": "object" - }, - "FreeFormSectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "Elements": { - "items": { - "$ref": "#/definitions/FreeFormLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "FunnelChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabelOptions": { - "$ref": "#/definitions/FunnelChartDataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/FunnelChartFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/FunnelChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "FunnelChartDataLabelOptions": { - "additionalProperties": false, - "properties": { - "CategoryLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LabelColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "LabelFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "MeasureDataLabelStyle": { - "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" - }, - "MeasureLabelVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Position": { - "$ref": "#/definitions/DataLabelPosition" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "FunnelChartFieldWells": { - "additionalProperties": false, - "properties": { - "FunnelChartAggregatedFieldWells": { - "$ref": "#/definitions/FunnelChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "FunnelChartMeasureDataLabelStyle": { - "enum": [ - "VALUE_ONLY", - "PERCENTAGE_BY_FIRST_STAGE", - "PERCENTAGE_BY_PREVIOUS_STAGE", - "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", - "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" - ], - "type": "string" - }, - "FunnelChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "FunnelChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/FunnelChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GaugeChartArcConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/GaugeChartConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/GaugeChartArcConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" - } - }, - "type": "object" - }, - "GaugeChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/GaugeChartFieldWells" - }, - "GaugeChartOptions": { - "$ref": "#/definitions/GaugeChartOptions" - }, - "TooltipOptions": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "GaugeChartFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GaugeChartOptions": { - "additionalProperties": false, - "properties": { - "Arc": { - "$ref": "#/definitions/ArcConfiguration" - }, - "ArcAxis": { - "$ref": "#/definitions/ArcAxisConfiguration" - }, - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - } - }, - "type": "object" - }, - "GaugeChartPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "GaugeChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GaugeChartConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/GaugeChartConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialCoordinateBounds": { - "additionalProperties": false, - "properties": { - "East": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - }, - "North": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "South": { - "maximum": 90, - "minimum": -90, - "type": "number" - }, - "West": { - "maximum": 1800, - "minimum": -1800, - "type": "number" - } - }, - "required": [ - "East", - "North", - "South", - "West" - ], - "type": "object" - }, - "GeospatialHeatmapColorScale": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/GeospatialHeatmapDataColor" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialHeatmapConfiguration": { - "additionalProperties": false, - "properties": { - "HeatmapColor": { - "$ref": "#/definitions/GeospatialHeatmapColorScale" - } - }, - "type": "object" - }, - "GeospatialHeatmapDataColor": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "required": [ - "Color" - ], - "type": "object" - }, - "GeospatialMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Geospatial": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GeospatialMapConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/GeospatialMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "MapStyleOptions": { - "$ref": "#/definitions/GeospatialMapStyleOptions" - }, - "PointStyleOptions": { - "$ref": "#/definitions/GeospatialPointStyleOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WindowOptions": { - "$ref": "#/definitions/GeospatialWindowOptions" - } - }, - "type": "object" - }, - "GeospatialMapFieldWells": { - "additionalProperties": false, - "properties": { - "GeospatialMapAggregatedFieldWells": { - "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "GeospatialMapStyleOptions": { - "additionalProperties": false, - "properties": { - "BaseMapStyle": { - "$ref": "#/definitions/BaseMapStyleType" - } - }, - "type": "object" - }, - "GeospatialMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/GeospatialMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "GeospatialPointStyleOptions": { - "additionalProperties": false, - "properties": { - "ClusterMarkerConfiguration": { - "$ref": "#/definitions/ClusterMarkerConfiguration" - }, - "HeatmapConfiguration": { - "$ref": "#/definitions/GeospatialHeatmapConfiguration" - }, - "SelectedPointStyle": { - "$ref": "#/definitions/GeospatialSelectedPointStyle" - } - }, - "type": "object" - }, - "GeospatialSelectedPointStyle": { - "enum": [ - "POINT", - "CLUSTER", - "HEATMAP" - ], - "type": "string" - }, - "GeospatialWindowOptions": { - "additionalProperties": false, - "properties": { - "Bounds": { - "$ref": "#/definitions/GeospatialCoordinateBounds" - }, - "MapZoomMode": { - "$ref": "#/definitions/MapZoomMode" - } - }, - "type": "object" - }, - "GlobalTableBorderOptions": { - "additionalProperties": false, - "properties": { - "SideSpecificBorder": { - "$ref": "#/definitions/TableSideBorderOptions" - }, - "UniformBorder": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "GradientColor": { - "additionalProperties": false, - "properties": { - "Stops": { - "items": { - "$ref": "#/definitions/GradientStop" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "GradientStop": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DataValue": { - "default": null, - "type": "number" - }, - "GradientOffset": { - "default": 0, - "type": "number" - } - }, - "required": [ - "GradientOffset" - ], - "type": "object" - }, - "GridLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "ScreenCanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" - } - }, - "type": "object" - }, - "GridLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "CanvasSizeOptions": { - "$ref": "#/definitions/GridLayoutCanvasSizeOptions" - }, - "Elements": { - "items": { - "$ref": "#/definitions/GridLayoutElement" - }, - "maxItems": 430, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Elements" - ], - "type": "object" - }, - "GridLayoutElement": { - "additionalProperties": false, - "properties": { - "ColumnIndex": { - "maximum": 35, - "minimum": 0, - "type": "number" - }, - "ColumnSpan": { - "maximum": 36, - "minimum": 1, - "type": "number" - }, - "ElementId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ElementType": { - "$ref": "#/definitions/LayoutElementType" - }, - "RowIndex": { - "maximum": 9009, - "minimum": 0, - "type": "number" - }, - "RowSpan": { - "maximum": 21, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "ColumnSpan", - "ElementId", - "ElementType", - "RowSpan" - ], - "type": "object" - }, - "GridLayoutScreenCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "OptimizedViewPortWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "ResizeOption": { - "$ref": "#/definitions/ResizeOption" - } - }, - "required": [ - "ResizeOption" - ], - "type": "object" - }, - "GrowthRateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodSize": { - "default": 0, - "maximum": 52, - "minimum": 2, - "type": "number" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "HeaderFooterSectionConfiguration": { - "additionalProperties": false, - "properties": { - "Layout": { - "$ref": "#/definitions/SectionLayoutConfiguration" - }, - "SectionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/SectionStyle" - } - }, - "required": [ - "Layout", - "SectionId" - ], - "type": "object" - }, - "HeatMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "ColumnLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HeatMapFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "RowLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/HeatMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "HeatMapFieldWells": { - "additionalProperties": false, - "properties": { - "HeatMapAggregatedFieldWells": { - "$ref": "#/definitions/HeatMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "HeatMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "HeatMapColumnItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapColumnSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "HeatMapRowItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "HeatMapRowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HeatMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HeatMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HistogramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "HistogramBinOptions": { - "additionalProperties": false, - "properties": { - "BinCount": { - "$ref": "#/definitions/BinCountOptions" - }, - "BinWidth": { - "$ref": "#/definitions/BinWidthOptions" - }, - "SelectedBinType": { - "$ref": "#/definitions/HistogramBinType" - }, - "StartValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "HistogramBinType": { - "enum": [ - "BIN_COUNT", - "BIN_WIDTH" - ], - "type": "string" - }, - "HistogramConfiguration": { - "additionalProperties": false, - "properties": { - "BinOptions": { - "$ref": "#/definitions/HistogramBinOptions" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/HistogramFieldWells" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - } - }, - "type": "object" - }, - "HistogramFieldWells": { - "additionalProperties": false, - "properties": { - "HistogramAggregatedFieldWells": { - "$ref": "#/definitions/HistogramAggregatedFieldWells" - } - }, - "type": "object" - }, - "HistogramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/HistogramConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "HorizontalTextAlignment": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT", - "AUTO" - ], - "type": "string" - }, - "Icon": { - "enum": [ - "CARET_UP", - "CARET_DOWN", - "PLUS", - "MINUS", - "ARROW_UP", - "ARROW_DOWN", - "ARROW_LEFT", - "ARROW_UP_LEFT", - "ARROW_DOWN_LEFT", - "ARROW_RIGHT", - "ARROW_UP_RIGHT", - "ARROW_DOWN_RIGHT", - "FACE_UP", - "FACE_DOWN", - "FACE_FLAT", - "ONE_BAR", - "TWO_BAR", - "THREE_BAR", - "CIRCLE", - "TRIANGLE", - "SQUARE", - "FLAG", - "THUMBS_UP", - "THUMBS_DOWN", - "CHECKMARK", - "X" - ], - "type": "string" - }, - "InsightConfiguration": { - "additionalProperties": false, - "properties": { - "Computations": { - "items": { - "$ref": "#/definitions/Computation" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "CustomNarrative": { - "$ref": "#/definitions/CustomNarrativeOptions" - } - }, - "type": "object" - }, - "InsightVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "InsightConfiguration": { - "$ref": "#/definitions/InsightConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "VisualId" - ], - "type": "object" - }, - "IntegerDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "number" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "IntegerParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/IntegerDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "IntegerValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "default": null, - "type": "number" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "ItemsLimitConfiguration": { - "additionalProperties": false, - "properties": { - "ItemsLimit": { - "default": null, - "type": "number" - }, - "OtherCategories": { - "$ref": "#/definitions/OtherCategories" - } - }, - "type": "object" - }, - "KPIActualValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIComparisonValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/KPIConditionalFormattingOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "ActualValue": { - "$ref": "#/definitions/KPIActualValueConditionalFormatting" - }, - "ComparisonValue": { - "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" - }, - "PrimaryValue": { - "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" - }, - "ProgressBar": { - "$ref": "#/definitions/KPIProgressBarConditionalFormatting" - } - }, - "type": "object" - }, - "KPIConfiguration": { - "additionalProperties": false, - "properties": { - "FieldWells": { - "$ref": "#/definitions/KPIFieldWells" - }, - "KPIOptions": { - "$ref": "#/definitions/KPIOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/KPISortConfiguration" - } - }, - "type": "object" - }, - "KPIFieldWells": { - "additionalProperties": false, - "properties": { - "TargetValues": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrendGroups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPIOptions": { - "additionalProperties": false, - "properties": { - "Comparison": { - "$ref": "#/definitions/ComparisonConfiguration" - }, - "PrimaryValueDisplayType": { - "$ref": "#/definitions/PrimaryValueDisplayType" - }, - "PrimaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "ProgressBar": { - "$ref": "#/definitions/ProgressBarOptions" - }, - "SecondaryValue": { - "$ref": "#/definitions/SecondaryValueOptions" - }, - "SecondaryValueFontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Sparkline": { - "$ref": "#/definitions/KPISparklineOptions" - }, - "TrendArrows": { - "$ref": "#/definitions/TrendArrowOptions" - }, - "VisualLayoutOptions": { - "$ref": "#/definitions/KPIVisualLayoutOptions" - } - }, - "type": "object" - }, - "KPIPrimaryValueConditionalFormatting": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPIProgressBarConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ForegroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "KPISortConfiguration": { - "additionalProperties": false, - "properties": { - "TrendGroupSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "KPISparklineOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Type": { - "$ref": "#/definitions/KPISparklineType" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPISparklineType": { - "enum": [ - "LINE", - "AREA" - ], - "type": "string" - }, - "KPIVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/KPIConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/KPIConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "KPIVisualLayoutOptions": { - "additionalProperties": false, - "properties": { - "StandardLayout": { - "$ref": "#/definitions/KPIVisualStandardLayout" - } - }, - "type": "object" - }, - "KPIVisualStandardLayout": { - "additionalProperties": false, - "properties": { - "Type": { - "$ref": "#/definitions/KPIVisualStandardLayoutType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "KPIVisualStandardLayoutType": { - "enum": [ - "CLASSIC", - "VERTICAL" - ], - "type": "string" - }, - "LabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "Layout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/LayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "LayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormLayoutConfiguration" - }, - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - }, - "SectionBasedLayout": { - "$ref": "#/definitions/SectionBasedLayoutConfiguration" - } - }, - "type": "object" - }, - "LayoutElementType": { - "enum": [ - "VISUAL", - "FILTER_CONTROL", - "PARAMETER_CONTROL", - "TEXT_BOX" - ], - "type": "string" - }, - "LegendOptions": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Position": { - "$ref": "#/definitions/LegendPosition" - }, - "Title": { - "$ref": "#/definitions/LabelOptions" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LegendPosition": { - "enum": [ - "AUTO", - "RIGHT", - "BOTTOM", - "TOP" - ], - "type": "string" - }, - "LineChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Colors": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartConfiguration": { - "additionalProperties": false, - "properties": { - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DefaultSeriesSettings": { - "$ref": "#/definitions/LineChartDefaultSeriesSettings" - }, - "FieldWells": { - "$ref": "#/definitions/LineChartFieldWells" - }, - "ForecastConfigurations": { - "items": { - "$ref": "#/definitions/ForecastConfiguration" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ReferenceLines": { - "items": { - "$ref": "#/definitions/ReferenceLine" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SecondaryYAxisDisplayOptions": { - "$ref": "#/definitions/LineSeriesAxisDisplayOptions" - }, - "SecondaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Series": { - "items": { - "$ref": "#/definitions/SeriesItem" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/LineChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "Type": { - "$ref": "#/definitions/LineChartType" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "LineChartDefaultSeriesSettings": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartFieldWells": { - "additionalProperties": false, - "properties": { - "LineChartAggregatedFieldWells": { - "$ref": "#/definitions/LineChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "LineChartLineStyle": { - "enum": [ - "SOLID", - "DOTTED", - "DASHED" - ], - "type": "string" - }, - "LineChartLineStyleSettings": { - "additionalProperties": false, - "properties": { - "LineInterpolation": { - "$ref": "#/definitions/LineInterpolation" - }, - "LineStyle": { - "$ref": "#/definitions/LineChartLineStyle" - }, - "LineVisibility": { - "$ref": "#/definitions/Visibility" - }, - "LineWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "type": "object" - }, - "LineChartMarkerShape": { - "enum": [ - "CIRCLE", - "TRIANGLE", - "SQUARE", - "DIAMOND", - "ROUNDED_SQUARE" - ], - "type": "string" - }, - "LineChartMarkerStyleSettings": { - "additionalProperties": false, - "properties": { - "MarkerColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "MarkerShape": { - "$ref": "#/definitions/LineChartMarkerShape" - }, - "MarkerSize": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MarkerVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LineChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "LineStyleSettings": { - "$ref": "#/definitions/LineChartLineStyleSettings" - }, - "MarkerStyleSettings": { - "$ref": "#/definitions/LineChartMarkerStyleSettings" - } - }, - "type": "object" - }, - "LineChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "LineChartType": { - "enum": [ - "LINE", - "AREA", - "STACKED_AREA" - ], - "type": "string" - }, - "LineChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/LineChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "LineInterpolation": { - "enum": [ - "LINEAR", - "SMOOTH", - "STEPPED" - ], - "type": "string" - }, - "LineSeriesAxisDisplayOptions": { - "additionalProperties": false, - "properties": { - "AxisOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "MissingDataConfigurations": { - "items": { - "$ref": "#/definitions/MissingDataConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ListControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "SearchOptions": { - "$ref": "#/definitions/ListControlSearchOptions" - }, - "SelectAllOptions": { - "$ref": "#/definitions/ListControlSelectAllOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "ListControlSearchOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ListControlSelectAllOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LoadingAnimation": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "LocalNavigationConfiguration": { - "additionalProperties": false, - "properties": { - "TargetSheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "TargetSheetId" - ], - "type": "object" - }, - "LongFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "MapZoomMode": { - "enum": [ - "AUTO", - "MANUAL" - ], - "type": "string" - }, - "MappedDataSetParameter": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DataSetParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - } - }, - "required": [ - "DataSetIdentifier", - "DataSetParameterName" - ], - "type": "object" - }, - "MaximumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MaximumMinimumComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/MaximumMinimumComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "MaximumMinimumComputationType": { - "enum": [ - "MAXIMUM", - "MINIMUM" - ], - "type": "string" - }, - "MeasureField": { - "additionalProperties": false, - "properties": { - "CalculatedMeasureField": { - "$ref": "#/definitions/CalculatedMeasureField" - }, - "CategoricalMeasureField": { - "$ref": "#/definitions/CategoricalMeasureField" - }, - "DateMeasureField": { - "$ref": "#/definitions/DateMeasureField" - }, - "NumericalMeasureField": { - "$ref": "#/definitions/NumericalMeasureField" - } - }, - "type": "object" - }, - "MetricComparisonComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "FromValue": { - "$ref": "#/definitions/MeasureField" - }, - "Name": { - "type": "string" - }, - "TargetValue": { - "$ref": "#/definitions/MeasureField" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "MinimumLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "MissingDataConfiguration": { - "additionalProperties": false, - "properties": { - "TreatmentOption": { - "$ref": "#/definitions/MissingDataTreatmentOption" - } - }, - "type": "object" - }, - "MissingDataTreatmentOption": { - "enum": [ - "INTERPOLATE", - "SHOW_AS_ZERO", - "SHOW_AS_BLANK" - ], - "type": "string" - }, - "NegativeValueConfiguration": { - "additionalProperties": false, - "properties": { - "DisplayMode": { - "$ref": "#/definitions/NegativeValueDisplayMode" - } - }, - "required": [ - "DisplayMode" - ], - "type": "object" - }, - "NegativeValueDisplayMode": { - "enum": [ - "POSITIVE", - "NEGATIVE" - ], - "type": "string" - }, - "NullValueFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullString": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "NullString" - ], - "type": "object" - }, - "NumberDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumberScale": { - "$ref": "#/definitions/NumberScale" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "NumberFormatConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "NumberScale": { - "enum": [ - "NONE", - "AUTO", - "THOUSANDS", - "MILLIONS", - "BILLIONS", - "TRILLIONS" - ], - "type": "string" - }, - "NumericAxisOptions": { - "additionalProperties": false, - "properties": { - "Range": { - "$ref": "#/definitions/AxisDisplayRange" - }, - "Scale": { - "$ref": "#/definitions/AxisScale" - } - }, - "type": "object" - }, - "NumericEqualityDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Column", - "Value" - ], - "type": "object" - }, - "NumericEqualityFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MatchOperator": { - "$ref": "#/definitions/NumericEqualityMatchOperator" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - }, - "Value": { - "default": null, - "type": "number" - } - }, - "required": [ - "Column", - "FilterId", - "MatchOperator", - "NullOption" - ], - "type": "object" - }, - "NumericEqualityMatchOperator": { - "enum": [ - "EQUALS", - "DOES_NOT_EQUAL" - ], - "type": "string" - }, - "NumericFilterSelectAllOptions": { - "enum": [ - "FILTER_ALL_VALUES" - ], - "type": "string" - }, - "NumericFormatConfiguration": { - "additionalProperties": false, - "properties": { - "CurrencyDisplayFormatConfiguration": { - "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" - }, - "NumberDisplayFormatConfiguration": { - "$ref": "#/definitions/NumberDisplayFormatConfiguration" - }, - "PercentageDisplayFormatConfiguration": { - "$ref": "#/definitions/PercentageDisplayFormatConfiguration" - } - }, - "type": "object" - }, - "NumericRangeFilter": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "RangeMinimum": { - "$ref": "#/definitions/NumericRangeFilterValue" - }, - "SelectAllOptions": { - "$ref": "#/definitions/NumericFilterSelectAllOptions" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "NumericRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StaticValue": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "NumericSeparatorConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalSeparator": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "ThousandsSeparator": { - "$ref": "#/definitions/ThousandSeparatorOptions" - } - }, - "type": "object" - }, - "NumericSeparatorSymbol": { - "enum": [ - "COMMA", - "DOT", - "SPACE" - ], - "type": "string" - }, - "NumericalAggregationFunction": { - "additionalProperties": false, - "properties": { - "PercentileAggregation": { - "$ref": "#/definitions/PercentileAggregation" - }, - "SimpleNumericalAggregation": { - "$ref": "#/definitions/SimpleNumericalAggregationFunction" - } - }, - "type": "object" - }, - "NumericalDimensionField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "NumericalMeasureField": { - "additionalProperties": false, - "properties": { - "AggregationFunction": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/NumberFormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "OtherCategories": { - "enum": [ - "INCLUDE", - "EXCLUDE" - ], - "type": "string" - }, - "PaginationConfiguration": { - "additionalProperties": false, - "properties": { - "PageNumber": { - "minimum": 0, - "type": "number" - }, - "PageSize": { - "default": null, - "type": "number" - } - }, - "required": [ - "PageNumber", - "PageSize" - ], - "type": "object" - }, - "PanelBorderStyle": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "PanelConfiguration": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BackgroundVisibility": { - "$ref": "#/definitions/Visibility" - }, - "BorderColor": { - "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", - "type": "string" - }, - "BorderStyle": { - "$ref": "#/definitions/PanelBorderStyle" - }, - "BorderThickness": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "BorderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "GutterSpacing": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "GutterVisibility": { - "$ref": "#/definitions/Visibility" - }, - "Title": { - "$ref": "#/definitions/PanelTitleOptions" - } - }, - "type": "object" - }, - "PanelTitleOptions": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PaperOrientation": { - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "PaperSize": { - "enum": [ - "US_LETTER", - "US_LEGAL", - "US_TABLOID_LEDGER", - "A0", - "A1", - "A2", - "A3", - "A4", - "A5", - "JIS_B4", - "JIS_B5" - ], - "type": "string" - }, - "ParameterControl": { - "additionalProperties": false, - "properties": { - "DateTimePicker": { - "$ref": "#/definitions/ParameterDateTimePickerControl" - }, - "Dropdown": { - "$ref": "#/definitions/ParameterDropDownControl" - }, - "List": { - "$ref": "#/definitions/ParameterListControl" - }, - "Slider": { - "$ref": "#/definitions/ParameterSliderControl" - }, - "TextArea": { - "$ref": "#/definitions/ParameterTextAreaControl" - }, - "TextField": { - "$ref": "#/definitions/ParameterTextFieldControl" - } - }, - "type": "object" - }, - "ParameterDateTimePickerControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/DateTimePickerControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DateTimeParameterDeclaration": { - "$ref": "#/definitions/DateTimeParameterDeclaration" - }, - "DecimalParameterDeclaration": { - "$ref": "#/definitions/DecimalParameterDeclaration" - }, - "IntegerParameterDeclaration": { - "$ref": "#/definitions/IntegerParameterDeclaration" - }, - "StringParameterDeclaration": { - "$ref": "#/definitions/StringParameterDeclaration" - } - }, - "type": "object" - }, - "ParameterDropDownControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/DropDownControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterListControl": { - "additionalProperties": false, - "properties": { - "CascadingControlConfiguration": { - "$ref": "#/definitions/CascadingControlConfiguration" - }, - "DisplayOptions": { - "$ref": "#/definitions/ListControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SelectableValues": { - "$ref": "#/definitions/ParameterSelectableValues" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/SheetControlListType" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterSelectableValues": { - "additionalProperties": false, - "properties": { - "LinkToDataSetColumn": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "Values": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ParameterSliderControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/SliderControlDisplayOptions" - }, - "MaximumValue": { - "default": 0, - "type": "number" - }, - "MinimumValue": { - "default": 0, - "type": "number" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "StepSize": { - "default": 0, - "type": "number" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "MaximumValue", - "MinimumValue", - "ParameterControlId", - "SourceParameterName", - "StepSize", - "Title" - ], - "type": "object" - }, - "ParameterTextAreaControl": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DisplayOptions": { - "$ref": "#/definitions/TextAreaControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterTextFieldControl": { - "additionalProperties": false, - "properties": { - "DisplayOptions": { - "$ref": "#/definitions/TextFieldControlDisplayOptions" - }, - "ParameterControlId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "SourceParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Title": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ParameterControlId", - "SourceParameterName", - "Title" - ], - "type": "object" - }, - "ParameterValueType": { - "enum": [ - "MULTI_VALUED", - "SINGLE_VALUED" - ], - "type": "string" - }, - "PercentVisibleRange": { - "additionalProperties": false, - "properties": { - "From": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "To": { - "default": null, - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PercentageDisplayFormatConfiguration": { - "additionalProperties": false, - "properties": { - "DecimalPlacesConfiguration": { - "$ref": "#/definitions/DecimalPlacesConfiguration" - }, - "NegativeValueConfiguration": { - "$ref": "#/definitions/NegativeValueConfiguration" - }, - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SeparatorConfiguration": { - "$ref": "#/definitions/NumericSeparatorConfiguration" - }, - "Suffix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PercentileAggregation": { - "additionalProperties": false, - "properties": { - "PercentileValue": { - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "PeriodOverPeriodComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PeriodToDateComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "PeriodTimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "PieChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SmallMultiples": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ContributionAnalysisDefaults": { - "items": { - "$ref": "#/definitions/ContributionAnalysisDefault" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "DonutOptions": { - "$ref": "#/definitions/DonutOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PieChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SmallMultiplesOptions": { - "$ref": "#/definitions/SmallMultiplesOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PieChartSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "ValueLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "PieChartFieldWells": { - "additionalProperties": false, - "properties": { - "PieChartAggregatedFieldWells": { - "$ref": "#/definitions/PieChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "PieChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SmallMultiplesLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SmallMultiplesSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PieChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PieChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotFieldSortOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SortBy": { - "$ref": "#/definitions/PivotTableSortBy" - } - }, - "required": [ - "FieldId", - "SortBy" - ], - "type": "object" - }, - "PivotTableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Rows": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Scope": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "Scopes": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingScope" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/PivotTableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/PivotTableCellConditionalFormatting" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScope": { - "additionalProperties": false, - "properties": { - "Role": { - "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" - } - }, - "type": "object" - }, - "PivotTableConditionalFormattingScopeRole": { - "enum": [ - "FIELD", - "FIELD_TOTAL", - "GRAND_TOTAL" - ], - "type": "string" - }, - "PivotTableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/PivotTableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/PivotTableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/PivotTablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/PivotTableSortConfiguration" - }, - "TableOptions": { - "$ref": "#/definitions/PivotTableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/PivotTableTotalOptions" - } - }, - "type": "object" - }, - "PivotTableDataPathOption": { - "additionalProperties": false, - "properties": { - "DataPathList": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "DataPathList" - ], - "type": "object" - }, - "PivotTableDataPathType": { - "enum": [ - "HIERARCHY_ROWS_LAYOUT_COLUMN", - "MULTIPLE_ROW_METRICS_COLUMN", - "EMPTY_COLUMN_HEADER", - "COUNT_METRIC_COLUMN" - ], - "type": "string" - }, - "PivotTableFieldCollapseState": { - "enum": [ - "COLLAPSED", - "EXPANDED" - ], - "type": "string" - }, - "PivotTableFieldCollapseStateOption": { - "additionalProperties": false, - "properties": { - "State": { - "$ref": "#/definitions/PivotTableFieldCollapseState" - }, - "Target": { - "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "PivotTableFieldCollapseStateTarget": { - "additionalProperties": false, - "properties": { - "FieldDataPathValues": { - "items": { - "$ref": "#/definitions/DataPathValue" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "FieldId": { - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "PivotTableFieldOptions": { - "additionalProperties": false, - "properties": { - "CollapseStateOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldCollapseStateOption" - }, - "type": "array" - }, - "DataPathOptions": { - "items": { - "$ref": "#/definitions/PivotTableDataPathOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableFieldSubtotalOptions": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "PivotTableFieldWells": { - "additionalProperties": false, - "properties": { - "PivotTableAggregatedFieldWells": { - "$ref": "#/definitions/PivotTableAggregatedFieldWells" - } - }, - "type": "object" - }, - "PivotTableMetricPlacement": { - "enum": [ - "ROW", - "COLUMN" - ], - "type": "string" - }, - "PivotTableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "CollapsedRowDimensionsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ColumnHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "ColumnNamesVisibility": { - "$ref": "#/definitions/Visibility" - }, - "DefaultCellWidth": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "MetricPlacement": { - "$ref": "#/definitions/PivotTableMetricPlacement" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - }, - "RowFieldNamesStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowHeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "RowsLabelOptions": { - "$ref": "#/definitions/PivotTableRowsLabelOptions" - }, - "RowsLayout": { - "$ref": "#/definitions/PivotTableRowsLayout" - }, - "SingleMetricVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ToggleButtonsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLabelOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "PivotTableRowsLayout": { - "enum": [ - "TABULAR", - "HIERARCHY" - ], - "type": "string" - }, - "PivotTableSortBy": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnSort" - }, - "DataPath": { - "$ref": "#/definitions/DataPathSort" - }, - "Field": { - "$ref": "#/definitions/FieldSort" - } - }, - "type": "object" - }, - "PivotTableSortConfiguration": { - "additionalProperties": false, - "properties": { - "FieldSortOptions": { - "items": { - "$ref": "#/definitions/PivotFieldSortOptions" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "PivotTableSubtotalLevel": { - "enum": [ - "ALL", - "CUSTOM", - "LAST" - ], - "type": "string" - }, - "PivotTableTotalOptions": { - "additionalProperties": false, - "properties": { - "ColumnSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "ColumnTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - }, - "RowSubtotalOptions": { - "$ref": "#/definitions/SubtotalOptions" - }, - "RowTotalOptions": { - "$ref": "#/definitions/PivotTotalOptions" - } - }, - "type": "object" - }, - "PivotTableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/PivotTableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/PivotTableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "PivotTotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "PredefinedHierarchy": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "DrillDownFilters": { - "items": { - "$ref": "#/definitions/DrillDownFilter" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "HierarchyId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Columns", - "HierarchyId" - ], - "type": "object" - }, - "PrimaryValueDisplayType": { - "enum": [ - "HIDDEN", - "COMPARISON", - "ACTUAL" - ], - "type": "string" - }, - "ProgressBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Color": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartAreaStyleSettings": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "RadarChartAxesRangeScale": { - "enum": [ - "AUTO", - "INDEPENDENT", - "SHARED" - ], - "type": "string" - }, - "RadarChartConfiguration": { - "additionalProperties": false, - "properties": { - "AlternateBandColorsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "AlternateBandEvenColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AlternateBandOddColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AxesRangeScale": { - "$ref": "#/definitions/RadarChartAxesRangeScale" - }, - "BaseSeriesSettings": { - "$ref": "#/definitions/RadarChartSeriesSettings" - }, - "CategoryAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorAxis": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/RadarChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Shape": { - "$ref": "#/definitions/RadarChartShape" - }, - "SortConfiguration": { - "$ref": "#/definitions/RadarChartSortConfiguration" - }, - "StartAngle": { - "maximum": 360, - "minimum": -360, - "type": "number" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - } - }, - "type": "object" - }, - "RadarChartFieldWells": { - "additionalProperties": false, - "properties": { - "RadarChartAggregatedFieldWells": { - "$ref": "#/definitions/RadarChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "RadarChartSeriesSettings": { - "additionalProperties": false, - "properties": { - "AreaStyleSettings": { - "$ref": "#/definitions/RadarChartAreaStyleSettings" - } - }, - "type": "object" - }, - "RadarChartShape": { - "enum": [ - "CIRCLE", - "POLYGON" - ], - "type": "string" - }, - "RadarChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "ColorItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "ColorSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "RadarChartVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/RadarChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "RangeEndsLabelType": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "ReferenceLine": { - "additionalProperties": false, - "properties": { - "DataConfiguration": { - "$ref": "#/definitions/ReferenceLineDataConfiguration" - }, - "LabelConfiguration": { - "$ref": "#/definitions/ReferenceLineLabelConfiguration" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "StyleConfiguration": { - "$ref": "#/definitions/ReferenceLineStyleConfiguration" - } - }, - "required": [ - "DataConfiguration" - ], - "type": "object" - }, - "ReferenceLineCustomLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "pattern": "\\S", - "type": "string" - } - }, - "required": [ - "CustomLabel" - ], - "type": "object" - }, - "ReferenceLineDataConfiguration": { - "additionalProperties": false, - "properties": { - "AxisBinding": { - "$ref": "#/definitions/AxisBinding" - }, - "DynamicConfiguration": { - "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" - }, - "SeriesType": { - "$ref": "#/definitions/ReferenceLineSeriesType" - }, - "StaticConfiguration": { - "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" - } - }, - "type": "object" - }, - "ReferenceLineDynamicDataConfiguration": { - "additionalProperties": false, - "properties": { - "Calculation": { - "$ref": "#/definitions/NumericalAggregationFunction" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "MeasureAggregationFunction": { - "$ref": "#/definitions/AggregationFunction" - } - }, - "required": [ - "Calculation", - "Column" - ], - "type": "object" - }, - "ReferenceLineLabelConfiguration": { - "additionalProperties": false, - "properties": { - "CustomLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" - }, - "FontColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "HorizontalPosition": { - "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" - }, - "ValueLabelConfiguration": { - "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" - }, - "VerticalPosition": { - "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" - } - }, - "type": "object" - }, - "ReferenceLineLabelHorizontalPosition": { - "enum": [ - "LEFT", - "CENTER", - "RIGHT" - ], - "type": "string" - }, - "ReferenceLineLabelVerticalPosition": { - "enum": [ - "ABOVE", - "BELOW" - ], - "type": "string" - }, - "ReferenceLinePatternType": { - "enum": [ - "SOLID", - "DASHED", - "DOTTED" - ], - "type": "string" - }, - "ReferenceLineSeriesType": { - "enum": [ - "BAR", - "LINE" - ], - "type": "string" - }, - "ReferenceLineStaticDataConfiguration": { - "additionalProperties": false, - "properties": { - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "ReferenceLineStyleConfiguration": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Pattern": { - "$ref": "#/definitions/ReferenceLinePatternType" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelConfiguration": { - "additionalProperties": false, - "properties": { - "FormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - }, - "RelativePosition": { - "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" - } - }, - "type": "object" - }, - "ReferenceLineValueLabelRelativePosition": { - "enum": [ - "BEFORE_CUSTOM_LABEL", - "AFTER_CUSTOM_LABEL" - ], - "type": "string" - }, - "RelativeDateTimeControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "DateTimeFormat": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "RelativeDateType": { - "enum": [ - "PREVIOUS", - "THIS", - "LAST", - "NOW", - "NEXT" - ], - "type": "string" - }, - "RelativeDatesFilter": { - "additionalProperties": false, - "properties": { - "AnchorDateConfiguration": { - "$ref": "#/definitions/AnchorDateConfiguration" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MinimumGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RelativeDateType": { - "$ref": "#/definitions/RelativeDateType" - }, - "RelativeDateValue": { - "default": null, - "type": "number" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AnchorDateConfiguration", - "Column", - "FilterId", - "NullOption", - "RelativeDateType", - "TimeGranularity" - ], - "type": "object" - }, - "RelativeFontSize": { - "enum": [ - "EXTRA_SMALL", - "SMALL", - "MEDIUM", - "LARGE", - "EXTRA_LARGE" - ], - "type": "string" - }, - "ResizeOption": { - "enum": [ - "FIXED", - "RESPONSIVE" - ], - "type": "string" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "ResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETED" - ], - "type": "string" - }, - "RollingDateConfiguration": { - "additionalProperties": false, - "properties": { - "DataSetIdentifier": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "RowAlternateColorOptions": { - "additionalProperties": false, - "properties": { - "RowAlternateColors": { - "items": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "UsePrimaryBackgroundColor": { - "$ref": "#/definitions/WidgetStatus" - } - }, - "type": "object" - }, - "SameSheetTargetVisualConfiguration": { - "additionalProperties": false, - "properties": { - "TargetVisualOptions": { - "$ref": "#/definitions/TargetVisualOptions" - }, - "TargetVisuals": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Destination": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Source": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Weight": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramChartConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/SankeyDiagramFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/SankeyDiagramSortConfiguration" - } - }, - "type": "object" - }, - "SankeyDiagramFieldWells": { - "additionalProperties": false, - "properties": { - "SankeyDiagramAggregatedFieldWells": { - "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" - } - }, - "type": "object" - }, - "SankeyDiagramSortConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "SourceItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "WeightSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "SankeyDiagramVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/SankeyDiagramChartConfiguration" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScatterPlotCategoricallyAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotConfiguration": { - "additionalProperties": false, - "properties": { - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/ScatterPlotFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "XAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "XAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "YAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "YAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - } - }, - "type": "object" - }, - "ScatterPlotFieldWells": { - "additionalProperties": false, - "properties": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" - }, - "ScatterPlotUnaggregatedFieldWells": { - "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "ScatterPlotUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Category": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Label": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "XAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "YAxis": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "ScatterPlotVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/ScatterPlotConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "ScrollBarOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "VisibleRange": { - "$ref": "#/definitions/VisibleRangeOptions" - } - }, - "type": "object" - }, - "SecondaryValueOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SectionAfterPageBreak": { - "additionalProperties": false, - "properties": { - "Status": { - "$ref": "#/definitions/SectionPageBreakStatus" - } - }, - "type": "object" - }, - "SectionBasedLayoutCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperCanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" - } - }, - "type": "object" - }, - "SectionBasedLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "BodySections": { - "items": { - "$ref": "#/definitions/BodySectionConfiguration" - }, - "maxItems": 28, - "minItems": 0, - "type": "array" - }, - "CanvasSizeOptions": { - "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" - }, - "FooterSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "HeaderSections": { - "items": { - "$ref": "#/definitions/HeaderFooterSectionConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "BodySections", - "CanvasSizeOptions", - "FooterSections", - "HeaderSections" - ], - "type": "object" - }, - "SectionBasedLayoutPaperCanvasSizeOptions": { - "additionalProperties": false, - "properties": { - "PaperMargin": { - "$ref": "#/definitions/Spacing" - }, - "PaperOrientation": { - "$ref": "#/definitions/PaperOrientation" - }, - "PaperSize": { - "$ref": "#/definitions/PaperSize" - } - }, - "type": "object" - }, - "SectionLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "FreeFormLayout": { - "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" - } - }, - "required": [ - "FreeFormLayout" - ], - "type": "object" - }, - "SectionPageBreakConfiguration": { - "additionalProperties": false, - "properties": { - "After": { - "$ref": "#/definitions/SectionAfterPageBreak" - } - }, - "type": "object" - }, - "SectionPageBreakStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "SectionStyle": { - "additionalProperties": false, - "properties": { - "Height": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - }, - "Padding": { - "$ref": "#/definitions/Spacing" - } - }, - "type": "object" - }, - "SelectAllValueOptions": { - "enum": [ - "ALL_VALUES" - ], - "type": "string" - }, - "SelectedFieldOptions": { - "enum": [ - "ALL_FIELDS" - ], - "type": "string" - }, - "SelectedSheetsFilterScopeConfiguration": { - "additionalProperties": false, - "properties": { - "SheetVisualScopingConfigurations": { - "items": { - "$ref": "#/definitions/SheetVisualScopingConfiguration" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "SelectedTooltipType": { - "enum": [ - "BASIC", - "DETAILED" - ], - "type": "string" - }, - "SeriesItem": { - "additionalProperties": false, - "properties": { - "DataFieldSeriesItem": { - "$ref": "#/definitions/DataFieldSeriesItem" - }, - "FieldSeriesItem": { - "$ref": "#/definitions/FieldSeriesItem" - } - }, - "type": "object" - }, - "SetParameterValueConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/DestinationParameterValueConfiguration" - } - }, - "required": [ - "DestinationParameterName", - "Value" - ], - "type": "object" - }, - "ShapeConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "required": [ - "BackgroundColor" - ], - "type": "object" - }, - "Sheet": { - "additionalProperties": false, - "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", - "properties": { - "Name": { - "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "SheetId": { - "description": "

The unique identifier associated with a sheet.

", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "type": "object" - }, - "SheetContentType": { - "enum": [ - "PAGINATED", - "INTERACTIVE" - ], - "type": "string" - }, - "SheetControlDateTimePickerType": { - "enum": [ - "SINGLE_VALUED", - "DATE_RANGE" - ], - "type": "string" - }, - "SheetControlInfoIconLabelOptions": { - "additionalProperties": false, - "properties": { - "InfoIconText": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetControlLayout": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/SheetControlLayoutConfiguration" - } - }, - "required": [ - "Configuration" - ], - "type": "object" - }, - "SheetControlLayoutConfiguration": { - "additionalProperties": false, - "properties": { - "GridLayout": { - "$ref": "#/definitions/GridLayoutConfiguration" - } - }, - "type": "object" - }, - "SheetControlListType": { - "enum": [ - "MULTI_SELECT", - "SINGLE_SELECT" - ], - "type": "string" - }, - "SheetControlSliderType": { - "enum": [ - "SINGLE_POINT", - "RANGE" - ], - "type": "string" - }, - "SheetDefinition": { - "additionalProperties": false, - "properties": { - "ContentType": { - "$ref": "#/definitions/SheetContentType" - }, - "Description": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "FilterControls": { - "items": { - "$ref": "#/definitions/FilterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Layouts": { - "items": { - "$ref": "#/definitions/Layout" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ParameterControls": { - "items": { - "$ref": "#/definitions/ParameterControl" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "SheetControlLayouts": { - "items": { - "$ref": "#/definitions/SheetControlLayout" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "TextBoxes": { - "items": { - "$ref": "#/definitions/SheetTextBox" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Title": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Visuals": { - "items": { - "$ref": "#/definitions/Visual" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "SheetId" - ], - "type": "object" - }, - "SheetElementConfigurationOverrides": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "SheetElementRenderingRule": { - "additionalProperties": false, - "properties": { - "ConfigurationOverrides": { - "$ref": "#/definitions/SheetElementConfigurationOverrides" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ConfigurationOverrides", - "Expression" - ], - "type": "object" - }, - "SheetTextBox": { - "additionalProperties": false, - "properties": { - "Content": { - "maxLength": 150000, - "minLength": 0, - "type": "string" - }, - "SheetTextBoxId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "SheetTextBoxId" - ], - "type": "object" - }, - "SheetVisualScopingConfiguration": { - "additionalProperties": false, - "properties": { - "Scope": { - "$ref": "#/definitions/FilterVisualScope" - }, - "SheetId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "VisualIds": { - "items": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Scope", - "SheetId" - ], - "type": "object" - }, - "ShortFormatText": { - "additionalProperties": false, - "properties": { - "PlainText": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "RichText": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SimpleAttributeAggregationFunction": { - "enum": [ - "UNIQUE_VALUE" - ], - "type": "string" - }, - "SimpleClusterMarker": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "SimpleNumericalAggregationFunction": { - "enum": [ - "SUM", - "AVERAGE", - "MIN", - "MAX", - "COUNT", - "DISTINCT_COUNT", - "VAR", - "VARP", - "STDEV", - "STDEVP", - "MEDIAN" - ], - "type": "string" - }, - "SimpleTotalAggregationFunction": { - "enum": [ - "DEFAULT", - "SUM", - "AVERAGE", - "MIN", - "MAX", - "NONE" - ], - "type": "string" - }, - "SliderControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "SmallMultiplesAxisPlacement": { - "enum": [ - "OUTSIDE", - "INSIDE" - ], - "type": "string" - }, - "SmallMultiplesAxisProperties": { - "additionalProperties": false, - "properties": { - "Placement": { - "$ref": "#/definitions/SmallMultiplesAxisPlacement" - }, - "Scale": { - "$ref": "#/definitions/SmallMultiplesAxisScale" - } - }, - "type": "object" - }, - "SmallMultiplesAxisScale": { - "enum": [ - "SHARED", - "INDEPENDENT" - ], - "type": "string" - }, - "SmallMultiplesOptions": { - "additionalProperties": false, - "properties": { - "MaxVisibleColumns": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "MaxVisibleRows": { - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "PanelConfiguration": { - "$ref": "#/definitions/PanelConfiguration" - }, - "XAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - }, - "YAxis": { - "$ref": "#/definitions/SmallMultiplesAxisProperties" - } - }, - "type": "object" - }, - "SortDirection": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "Spacing": { - "additionalProperties": false, - "properties": { - "Bottom": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Left": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Right": { - "description": "String based length that is composed of value and unit", - "type": "string" - }, - "Top": { - "description": "String based length that is composed of value and unit", - "type": "string" - } - }, - "type": "object" - }, - "SpecialValue": { - "enum": [ - "EMPTY", - "NULL", - "OTHER" - ], - "type": "string" - }, - "StringDefaultValues": { - "additionalProperties": false, - "properties": { - "DynamicValue": { - "$ref": "#/definitions/DynamicDefaultValue" - }, - "StaticValues": { - "items": { - "type": "string" - }, - "maxItems": 50000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "StringFormatConfiguration": { - "additionalProperties": false, - "properties": { - "NullValueFormatConfiguration": { - "$ref": "#/definitions/NullValueFormatConfiguration" - }, - "NumericFormatConfiguration": { - "$ref": "#/definitions/NumericFormatConfiguration" - } - }, - "type": "object" - }, - "StringParameterDeclaration": { - "additionalProperties": false, - "properties": { - "DefaultValues": { - "$ref": "#/definitions/StringDefaultValues" - }, - "MappedDataSetParameters": { - "items": { - "$ref": "#/definitions/MappedDataSetParameter" - }, - "maxItems": 150, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ParameterValueType": { - "$ref": "#/definitions/ParameterValueType" - }, - "ValueWhenUnset": { - "$ref": "#/definitions/StringValueWhenUnsetConfiguration" - } - }, - "required": [ - "Name", - "ParameterValueType" - ], - "type": "object" - }, - "StringValueWhenUnsetConfiguration": { - "additionalProperties": false, - "properties": { - "CustomValue": { - "type": "string" - }, - "ValueWhenUnsetOption": { - "$ref": "#/definitions/ValueWhenUnsetOption" - } - }, - "type": "object" - }, - "StyledCellType": { - "enum": [ - "TOTAL", - "METRIC_HEADER", - "VALUE" - ], - "type": "string" - }, - "SubtotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "FieldLevel": { - "$ref": "#/definitions/PivotTableSubtotalLevel" - }, - "FieldLevelOptions": { - "items": { - "$ref": "#/definitions/PivotTableFieldSubtotalOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "MetricHeaderCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "StyleTargets": { - "items": { - "$ref": "#/definitions/TableStyleTarget" - }, - "maxItems": 3, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - }, - "ValueCellStyle": { - "$ref": "#/definitions/TableCellStyle" - } - }, - "type": "object" - }, - "TableAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableBorderOptions": { - "additionalProperties": false, - "properties": { - "Color": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Style": { - "$ref": "#/definitions/TableBorderStyle" - }, - "Thickness": { - "maximum": 4, - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "TableBorderStyle": { - "enum": [ - "NONE", - "SOLID" - ], - "type": "string" - }, - "TableCellConditionalFormatting": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TextFormat": { - "$ref": "#/definitions/TextConditionalFormat" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableCellImageScalingConfiguration": { - "enum": [ - "FIT_TO_CELL_HEIGHT", - "FIT_TO_CELL_WIDTH", - "DO_NOT_SCALE" - ], - "type": "string" - }, - "TableCellImageSizingConfiguration": { - "additionalProperties": false, - "properties": { - "TableCellImageScalingConfiguration": { - "$ref": "#/definitions/TableCellImageScalingConfiguration" - } - }, - "type": "object" - }, - "TableCellStyle": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Border": { - "$ref": "#/definitions/GlobalTableBorderOptions" - }, - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Height": { - "maximum": 500, - "minimum": 8, - "type": "number" - }, - "HorizontalTextAlignment": { - "$ref": "#/definitions/HorizontalTextAlignment" - }, - "TextWrap": { - "$ref": "#/definitions/TextWrap" - }, - "VerticalTextAlignment": { - "$ref": "#/definitions/VerticalTextAlignment" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TableConditionalFormatting": { - "additionalProperties": false, - "properties": { - "ConditionalFormattingOptions": { - "items": { - "$ref": "#/definitions/TableConditionalFormattingOption" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableConditionalFormattingOption": { - "additionalProperties": false, - "properties": { - "Cell": { - "$ref": "#/definitions/TableCellConditionalFormatting" - }, - "Row": { - "$ref": "#/definitions/TableRowConditionalFormatting" - } - }, - "type": "object" - }, - "TableConfiguration": { - "additionalProperties": false, - "properties": { - "FieldOptions": { - "$ref": "#/definitions/TableFieldOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TableFieldWells" - }, - "PaginatedReportOptions": { - "$ref": "#/definitions/TablePaginatedReportOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TableSortConfiguration" - }, - "TableInlineVisualizations": { - "items": { - "$ref": "#/definitions/TableInlineVisualization" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TableOptions": { - "$ref": "#/definitions/TableOptions" - }, - "TotalOptions": { - "$ref": "#/definitions/TotalOptions" - } - }, - "type": "object" - }, - "TableFieldCustomIconContent": { - "additionalProperties": false, - "properties": { - "Icon": { - "$ref": "#/definitions/TableFieldIconSetType" - } - }, - "type": "object" - }, - "TableFieldCustomTextContent": { - "additionalProperties": false, - "properties": { - "FontConfiguration": { - "$ref": "#/definitions/FontConfiguration" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "FontConfiguration" - ], - "type": "object" - }, - "TableFieldIconSetType": { - "enum": [ - "LINK" - ], - "type": "string" - }, - "TableFieldImageConfiguration": { - "additionalProperties": false, - "properties": { - "SizingOptions": { - "$ref": "#/definitions/TableCellImageSizingConfiguration" - } - }, - "type": "object" - }, - "TableFieldLinkConfiguration": { - "additionalProperties": false, - "properties": { - "Content": { - "$ref": "#/definitions/TableFieldLinkContentConfiguration" - }, - "Target": { - "$ref": "#/definitions/URLTargetConfiguration" - } - }, - "required": [ - "Content", - "Target" - ], - "type": "object" - }, - "TableFieldLinkContentConfiguration": { - "additionalProperties": false, - "properties": { - "CustomIconContent": { - "$ref": "#/definitions/TableFieldCustomIconContent" - }, - "CustomTextContent": { - "$ref": "#/definitions/TableFieldCustomTextContent" - } - }, - "type": "object" - }, - "TableFieldOption": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "URLStyling": { - "$ref": "#/definitions/TableFieldURLConfiguration" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - }, - "Width": { - "description": "String based length that is composed of value and unit in px", - "type": "string" - } - }, - "required": [ - "FieldId" - ], - "type": "object" - }, - "TableFieldOptions": { - "additionalProperties": false, - "properties": { - "Order": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "PinnedFieldOptions": { - "$ref": "#/definitions/TablePinnedFieldOptions" - }, - "SelectedFieldOptions": { - "items": { - "$ref": "#/definitions/TableFieldOption" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableFieldURLConfiguration": { - "additionalProperties": false, - "properties": { - "ImageConfiguration": { - "$ref": "#/definitions/TableFieldImageConfiguration" - }, - "LinkConfiguration": { - "$ref": "#/definitions/TableFieldLinkConfiguration" - } - }, - "type": "object" - }, - "TableFieldWells": { - "additionalProperties": false, - "properties": { - "TableAggregatedFieldWells": { - "$ref": "#/definitions/TableAggregatedFieldWells" - }, - "TableUnaggregatedFieldWells": { - "$ref": "#/definitions/TableUnaggregatedFieldWells" - } - }, - "type": "object" - }, - "TableInlineVisualization": { - "additionalProperties": false, - "properties": { - "DataBars": { - "$ref": "#/definitions/DataBarsOptions" - } - }, - "type": "object" - }, - "TableOptions": { - "additionalProperties": false, - "properties": { - "CellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "HeaderStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "Orientation": { - "$ref": "#/definitions/TableOrientation" - }, - "RowAlternateColorOptions": { - "$ref": "#/definitions/RowAlternateColorOptions" - } - }, - "type": "object" - }, - "TableOrientation": { - "enum": [ - "VERTICAL", - "HORIZONTAL" - ], - "type": "string" - }, - "TablePaginatedReportOptions": { - "additionalProperties": false, - "properties": { - "OverflowColumnHeaderVisibility": { - "$ref": "#/definitions/Visibility" - }, - "VerticalOverflowVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TablePinnedFieldOptions": { - "additionalProperties": false, - "properties": { - "PinnedLeftFields": { - "items": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "maxItems": 201, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableRowConditionalFormatting": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TableSideBorderOptions": { - "additionalProperties": false, - "properties": { - "Bottom": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerHorizontal": { - "$ref": "#/definitions/TableBorderOptions" - }, - "InnerVertical": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Left": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Right": { - "$ref": "#/definitions/TableBorderOptions" - }, - "Top": { - "$ref": "#/definitions/TableBorderOptions" - } - }, - "type": "object" - }, - "TableSortConfiguration": { - "additionalProperties": false, - "properties": { - "PaginationConfiguration": { - "$ref": "#/definitions/PaginationConfiguration" - }, - "RowSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableStyleTarget": { - "additionalProperties": false, - "properties": { - "CellType": { - "$ref": "#/definitions/StyledCellType" - } - }, - "required": [ - "CellType" - ], - "type": "object" - }, - "TableTotalsPlacement": { - "enum": [ - "START", - "END", - "AUTO" - ], - "type": "string" - }, - "TableTotalsScrollStatus": { - "enum": [ - "PINNED", - "SCROLLED" - ], - "type": "string" - }, - "TableUnaggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/UnaggregatedField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TableVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TableConfiguration" - }, - "ConditionalFormatting": { - "$ref": "#/definitions/TableConditionalFormatting" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TargetVisualOptions": { - "enum": [ - "ALL_VISUALS" - ], - "type": "string" - }, - "TemplateError": { - "additionalProperties": false, - "description": "

List of errors that occurred when the template version creation failed.

", - "properties": { - "Message": { - "description": "

Description of the error type.

", - "pattern": "\\S", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/TemplateErrorType" - }, - "ViolatedEntities": { - "description": "

An error path that shows which entities caused the template error.

", - "items": { - "$ref": "#/definitions/Entity" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TemplateErrorType": { - "enum": [ - "SOURCE_NOT_FOUND", - "DATA_SET_NOT_FOUND", - "INTERNAL_FAILURE", - "ACCESS_DENIED" - ], - "type": "string" - }, - "TemplateSourceAnalysis": { - "additionalProperties": false, - "description": "

The source analysis of the template.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "DataSetReferences": { - "description": "

A structure containing information about the dataset references used as placeholders\n in the template.

", - "items": { - "$ref": "#/definitions/DataSetReference" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "TemplateSourceEntity": { - "additionalProperties": false, - "description": "

The source entity of the template.

", - "properties": { - "SourceAnalysis": { - "$ref": "#/definitions/TemplateSourceAnalysis" - }, - "SourceTemplate": { - "$ref": "#/definitions/TemplateSourceTemplate" - } - }, - "type": "object" - }, - "TemplateSourceTemplate": { - "additionalProperties": false, - "description": "

The source template of the template.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "TemplateVersion": { - "additionalProperties": false, - "description": "

A version of a template.

", - "properties": { - "CreatedTime": { - "description": "

The time that this template version was created.

", - "format": "date-time", - "type": "string" - }, - "DataSetConfigurations": { - "description": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

", - "items": { - "$ref": "#/definitions/DataSetConfiguration" - }, - "maxItems": 30, - "minItems": 0, - "type": "array" - }, - "Description": { - "description": "

The description of the template.

", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Errors": { - "description": "

Errors associated with this template version.

", - "items": { - "$ref": "#/definitions/TemplateError" - }, - "minItems": 1, - "type": "array" - }, - "Sheets": { - "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", - "items": { - "$ref": "#/definitions/Sheet" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "SourceEntityArn": { - "description": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/ResourceStatus" - }, - "ThemeArn": { - "description": "

The ARN of the theme associated with this version of the template.

", - "type": "string" - }, - "VersionNumber": { - "description": "

The version number of the template version.

", - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "TemplateVersionDefinition": { - "additionalProperties": false, - "properties": { - "AnalysisDefaults": { - "$ref": "#/definitions/AnalysisDefaults" - }, - "CalculatedFields": { - "items": { - "$ref": "#/definitions/CalculatedField" - }, - "maxItems": 500, - "minItems": 0, - "type": "array" - }, - "ColumnConfigurations": { - "items": { - "$ref": "#/definitions/ColumnConfiguration" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "DataSetConfigurations": { - "items": { - "$ref": "#/definitions/DataSetConfiguration" - }, - "maxItems": 30, - "minItems": 0, - "type": "array" - }, - "FilterGroups": { - "items": { - "$ref": "#/definitions/FilterGroup" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array" - }, - "Options": { - "$ref": "#/definitions/AssetOptions" - }, - "ParameterDeclarations": { - "items": { - "$ref": "#/definitions/ParameterDeclaration" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Sheets": { - "items": { - "$ref": "#/definitions/SheetDefinition" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "DataSetConfigurations" - ], - "type": "object" - }, - "TextAreaControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextConditionalFormat": { - "additionalProperties": false, - "properties": { - "BackgroundColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - }, - "Icon": { - "$ref": "#/definitions/ConditionalFormattingIcon" - }, - "TextColor": { - "$ref": "#/definitions/ConditionalFormattingColor" - } - }, - "type": "object" - }, - "TextControlPlaceholderOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TextFieldControlDisplayOptions": { - "additionalProperties": false, - "properties": { - "InfoIconLabelOptions": { - "$ref": "#/definitions/SheetControlInfoIconLabelOptions" - }, - "PlaceholderOptions": { - "$ref": "#/definitions/TextControlPlaceholderOptions" - }, - "TitleOptions": { - "$ref": "#/definitions/LabelOptions" - } - }, - "type": "object" - }, - "TextWrap": { - "enum": [ - "NONE", - "WRAP" - ], - "type": "string" - }, - "ThousandSeparatorOptions": { - "additionalProperties": false, - "properties": { - "Symbol": { - "$ref": "#/definitions/NumericSeparatorSymbol" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TimeBasedForecastProperties": { - "additionalProperties": false, - "properties": { - "LowerBoundary": { - "default": null, - "type": "number" - }, - "PeriodsBackward": { - "maximum": 1000, - "minimum": 0, - "type": "number" - }, - "PeriodsForward": { - "maximum": 1000, - "minimum": 1, - "type": "number" - }, - "PredictionInterval": { - "maximum": 95, - "minimum": 50, - "type": "number" - }, - "Seasonality": { - "maximum": 180, - "minimum": 1, - "type": "number" - }, - "UpperBoundary": { - "default": null, - "type": "number" - } - }, - "type": "object" - }, - "TimeEqualityFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - }, - "Value": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "Column", - "FilterId" - ], - "type": "object" - }, - "TimeGranularity": { - "enum": [ - "YEAR", - "QUARTER", - "MONTH", - "WEEK", - "DAY", - "HOUR", - "MINUTE", - "SECOND", - "MILLISECOND" - ], - "type": "string" - }, - "TimeRangeDrillDownFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "RangeMaximum": { - "format": "date-time", - "type": "string" - }, - "RangeMinimum": { - "format": "date-time", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "RangeMaximum", - "RangeMinimum", - "TimeGranularity" - ], - "type": "object" - }, - "TimeRangeFilter": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "ExcludePeriodConfiguration": { - "$ref": "#/definitions/ExcludePeriodConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "IncludeMaximum": { - "default": null, - "type": "boolean" - }, - "IncludeMinimum": { - "default": null, - "type": "boolean" - }, - "NullOption": { - "$ref": "#/definitions/FilterNullOption" - }, - "RangeMaximumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "RangeMinimumValue": { - "$ref": "#/definitions/TimeRangeFilterValue" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "Column", - "FilterId", - "NullOption" - ], - "type": "object" - }, - "TimeRangeFilterValue": { - "additionalProperties": false, - "properties": { - "Parameter": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "RollingDate": { - "$ref": "#/definitions/RollingDateConfiguration" - }, - "StaticValue": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "TooltipItem": { - "additionalProperties": false, - "properties": { - "ColumnTooltipItem": { - "$ref": "#/definitions/ColumnTooltipItem" - }, - "FieldTooltipItem": { - "$ref": "#/definitions/FieldTooltipItem" - } - }, - "type": "object" - }, - "TooltipOptions": { - "additionalProperties": false, - "properties": { - "FieldBasedTooltip": { - "$ref": "#/definitions/FieldBasedTooltip" - }, - "SelectedTooltipType": { - "$ref": "#/definitions/SelectedTooltipType" - }, - "TooltipVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TooltipTitleType": { - "enum": [ - "NONE", - "PRIMARY_VALUE" - ], - "type": "string" - }, - "TopBottomComputationType": { - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "TopBottomFilter": { - "additionalProperties": false, - "properties": { - "AggregationSortConfigurations": { - "items": { - "$ref": "#/definitions/AggregationSortConfiguration" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "DefaultFilterControlConfiguration": { - "$ref": "#/definitions/DefaultFilterControlConfiguration" - }, - "FilterId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Limit": { - "default": null, - "type": "number" - }, - "ParameterName": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "TimeGranularity": { - "$ref": "#/definitions/TimeGranularity" - } - }, - "required": [ - "AggregationSortConfigurations", - "Column", - "FilterId" - ], - "type": "object" - }, - "TopBottomMoversComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "MoverSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Name": { - "type": "string" - }, - "SortOrder": { - "$ref": "#/definitions/TopBottomSortOrder" - }, - "Time": { - "$ref": "#/definitions/DimensionField" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomRankedComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResultSize": { - "default": 0, - "maximum": 20, - "minimum": 1, - "type": "number" - }, - "Type": { - "$ref": "#/definitions/TopBottomComputationType" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId", - "Type" - ], - "type": "object" - }, - "TopBottomSortOrder": { - "enum": [ - "PERCENT_DIFFERENCE", - "ABSOLUTE_DIFFERENCE" - ], - "type": "string" - }, - "TotalAggregationComputation": { - "additionalProperties": false, - "properties": { - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/MeasureField" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "TotalAggregationFunction": { - "additionalProperties": false, - "properties": { - "SimpleTotalAggregationFunction": { - "$ref": "#/definitions/SimpleTotalAggregationFunction" - } - }, - "type": "object" - }, - "TotalAggregationOption": { - "additionalProperties": false, - "properties": { - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TotalAggregationFunction": { - "$ref": "#/definitions/TotalAggregationFunction" - } - }, - "required": [ - "FieldId", - "TotalAggregationFunction" - ], - "type": "object" - }, - "TotalOptions": { - "additionalProperties": false, - "properties": { - "CustomLabel": { - "type": "string" - }, - "Placement": { - "$ref": "#/definitions/TableTotalsPlacement" - }, - "ScrollStatus": { - "$ref": "#/definitions/TableTotalsScrollStatus" - }, - "TotalAggregationOptions": { - "items": { - "$ref": "#/definitions/TotalAggregationOption" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TotalCellStyle": { - "$ref": "#/definitions/TableCellStyle" - }, - "TotalsVisibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "TreeMapAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Groups": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Sizes": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapConfiguration": { - "additionalProperties": false, - "properties": { - "ColorLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorScale": { - "$ref": "#/definitions/ColorScale" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/TreeMapFieldWells" - }, - "GroupLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "SizeLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/TreeMapSortConfiguration" - }, - "Tooltip": { - "$ref": "#/definitions/TooltipOptions" - } - }, - "type": "object" - }, - "TreeMapFieldWells": { - "additionalProperties": false, - "properties": { - "TreeMapAggregatedFieldWells": { - "$ref": "#/definitions/TreeMapAggregatedFieldWells" - } - }, - "type": "object" - }, - "TreeMapSortConfiguration": { - "additionalProperties": false, - "properties": { - "TreeMapGroupItemsLimitConfiguration": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "TreeMapSort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "TreeMapVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/TreeMapConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "TrendArrowOptions": { - "additionalProperties": false, - "properties": { - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "URLTargetConfiguration": { - "enum": [ - "NEW_TAB", - "NEW_WINDOW", - "SAME_TAB" - ], - "type": "string" - }, - "UnaggregatedField": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/ColumnIdentifier" - }, - "FieldId": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "FormatConfiguration": { - "$ref": "#/definitions/FormatConfiguration" - } - }, - "required": [ - "Column", - "FieldId" - ], - "type": "object" - }, - "UniqueValuesComputation": { - "additionalProperties": false, - "properties": { - "Category": { - "$ref": "#/definitions/DimensionField" - }, - "ComputationId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ComputationId" - ], - "type": "object" - }, - "ValidationStrategy": { - "additionalProperties": false, - "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", - "properties": { - "Mode": { - "$ref": "#/definitions/ValidationStrategyMode" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "ValidationStrategyMode": { - "enum": [ - "STRICT", - "LENIENT" - ], - "type": "string" - }, - "ValueWhenUnsetOption": { - "enum": [ - "RECOMMENDED_VALUE", - "NULL" - ], - "type": "string" - }, - "VerticalTextAlignment": { - "enum": [ - "TOP", - "MIDDLE", - "BOTTOM", - "AUTO" - ], - "type": "string" - }, - "Visibility": { - "enum": [ - "HIDDEN", - "VISIBLE" - ], - "type": "string" - }, - "VisibleRangeOptions": { - "additionalProperties": false, - "properties": { - "PercentRange": { - "$ref": "#/definitions/PercentVisibleRange" - } - }, - "type": "object" - }, - "Visual": { - "additionalProperties": false, - "properties": { - "BarChartVisual": { - "$ref": "#/definitions/BarChartVisual" - }, - "BoxPlotVisual": { - "$ref": "#/definitions/BoxPlotVisual" - }, - "ComboChartVisual": { - "$ref": "#/definitions/ComboChartVisual" - }, - "CustomContentVisual": { - "$ref": "#/definitions/CustomContentVisual" - }, - "EmptyVisual": { - "$ref": "#/definitions/EmptyVisual" - }, - "FilledMapVisual": { - "$ref": "#/definitions/FilledMapVisual" - }, - "FunnelChartVisual": { - "$ref": "#/definitions/FunnelChartVisual" - }, - "GaugeChartVisual": { - "$ref": "#/definitions/GaugeChartVisual" - }, - "GeospatialMapVisual": { - "$ref": "#/definitions/GeospatialMapVisual" - }, - "HeatMapVisual": { - "$ref": "#/definitions/HeatMapVisual" - }, - "HistogramVisual": { - "$ref": "#/definitions/HistogramVisual" - }, - "InsightVisual": { - "$ref": "#/definitions/InsightVisual" - }, - "KPIVisual": { - "$ref": "#/definitions/KPIVisual" - }, - "LineChartVisual": { - "$ref": "#/definitions/LineChartVisual" - }, - "PieChartVisual": { - "$ref": "#/definitions/PieChartVisual" - }, - "PivotTableVisual": { - "$ref": "#/definitions/PivotTableVisual" - }, - "RadarChartVisual": { - "$ref": "#/definitions/RadarChartVisual" - }, - "SankeyDiagramVisual": { - "$ref": "#/definitions/SankeyDiagramVisual" - }, - "ScatterPlotVisual": { - "$ref": "#/definitions/ScatterPlotVisual" - }, - "TableVisual": { - "$ref": "#/definitions/TableVisual" - }, - "TreeMapVisual": { - "$ref": "#/definitions/TreeMapVisual" - }, - "WaterfallVisual": { - "$ref": "#/definitions/WaterfallVisual" - }, - "WordCloudVisual": { - "$ref": "#/definitions/WordCloudVisual" - } - }, - "type": "object" - }, - "VisualCustomAction": { - "additionalProperties": false, - "properties": { - "ActionOperations": { - "items": { - "$ref": "#/definitions/VisualCustomActionOperation" - }, - "maxItems": 2, - "minItems": 1, - "type": "array" - }, - "CustomActionId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/WidgetStatus" - }, - "Trigger": { - "$ref": "#/definitions/VisualCustomActionTrigger" - } - }, - "required": [ - "ActionOperations", - "CustomActionId", - "Name", - "Trigger" - ], - "type": "object" - }, - "VisualCustomActionOperation": { - "additionalProperties": false, - "properties": { - "FilterOperation": { - "$ref": "#/definitions/CustomActionFilterOperation" - }, - "NavigationOperation": { - "$ref": "#/definitions/CustomActionNavigationOperation" - }, - "SetParametersOperation": { - "$ref": "#/definitions/CustomActionSetParametersOperation" - }, - "URLOperation": { - "$ref": "#/definitions/CustomActionURLOperation" - } - }, - "type": "object" - }, - "VisualCustomActionTrigger": { - "enum": [ - "DATA_POINT_CLICK", - "DATA_POINT_MENU" - ], - "type": "string" - }, - "VisualPalette": { - "additionalProperties": false, - "properties": { - "ChartColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "ColorMap": { - "items": { - "$ref": "#/definitions/DataPathColor" - }, - "maxItems": 5000, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "VisualSubtitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/LongFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "VisualTitleLabelOptions": { - "additionalProperties": false, - "properties": { - "FormatText": { - "$ref": "#/definitions/ShortFormatText" - }, - "Visibility": { - "$ref": "#/definitions/Visibility" - } - }, - "type": "object" - }, - "WaterfallChartAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "Breakdowns": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Categories": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Values": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallChartColorConfiguration": { - "additionalProperties": false, - "properties": { - "GroupColorConfiguration": { - "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" - } - }, - "type": "object" - }, - "WaterfallChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "CategoryAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "ColorConfiguration": { - "$ref": "#/definitions/WaterfallChartColorConfiguration" - }, - "DataLabels": { - "$ref": "#/definitions/DataLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WaterfallChartFieldWells" - }, - "Legend": { - "$ref": "#/definitions/LegendOptions" - }, - "PrimaryYAxisDisplayOptions": { - "$ref": "#/definitions/AxisDisplayOptions" - }, - "PrimaryYAxisLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "SortConfiguration": { - "$ref": "#/definitions/WaterfallChartSortConfiguration" - }, - "VisualPalette": { - "$ref": "#/definitions/VisualPalette" - }, - "WaterfallChartOptions": { - "$ref": "#/definitions/WaterfallChartOptions" - } - }, - "type": "object" - }, - "WaterfallChartFieldWells": { - "additionalProperties": false, - "properties": { - "WaterfallChartAggregatedFieldWells": { - "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" - } - }, - "type": "object" - }, - "WaterfallChartGroupColorConfiguration": { - "additionalProperties": false, - "properties": { - "NegativeBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PositiveBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "TotalBarColor": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartOptions": { - "additionalProperties": false, - "properties": { - "TotalBarLabel": { - "type": "string" - } - }, - "type": "object" - }, - "WaterfallChartSortConfiguration": { - "additionalProperties": false, - "properties": { - "BreakdownItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WaterfallVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WaterfallChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WhatIfPointScenario": { - "additionalProperties": false, - "properties": { - "Date": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "Date", - "Value" - ], - "type": "object" - }, - "WhatIfRangeScenario": { - "additionalProperties": false, - "properties": { - "EndDate": { - "format": "date-time", - "type": "string" - }, - "StartDate": { - "format": "date-time", - "type": "string" - }, - "Value": { - "default": 0, - "type": "number" - } - }, - "required": [ - "EndDate", - "StartDate", - "Value" - ], - "type": "object" - }, - "WidgetStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "WordCloudAggregatedFieldWells": { - "additionalProperties": false, - "properties": { - "GroupBy": { - "items": { - "$ref": "#/definitions/DimensionField" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Size": { - "items": { - "$ref": "#/definitions/MeasureField" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudChartConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryLabelOptions": { - "$ref": "#/definitions/ChartAxisLabelOptions" - }, - "FieldWells": { - "$ref": "#/definitions/WordCloudFieldWells" - }, - "SortConfiguration": { - "$ref": "#/definitions/WordCloudSortConfiguration" - }, - "WordCloudOptions": { - "$ref": "#/definitions/WordCloudOptions" - } - }, - "type": "object" - }, - "WordCloudCloudLayout": { - "enum": [ - "FLUID", - "NORMAL" - ], - "type": "string" - }, - "WordCloudFieldWells": { - "additionalProperties": false, - "properties": { - "WordCloudAggregatedFieldWells": { - "$ref": "#/definitions/WordCloudAggregatedFieldWells" - } - }, - "type": "object" - }, - "WordCloudOptions": { - "additionalProperties": false, - "properties": { - "CloudLayout": { - "$ref": "#/definitions/WordCloudCloudLayout" - }, - "MaximumStringLength": { - "maximum": 100, - "minimum": 1, - "type": "number" - }, - "WordCasing": { - "$ref": "#/definitions/WordCloudWordCasing" - }, - "WordOrientation": { - "$ref": "#/definitions/WordCloudWordOrientation" - }, - "WordPadding": { - "$ref": "#/definitions/WordCloudWordPadding" - }, - "WordScaling": { - "$ref": "#/definitions/WordCloudWordScaling" - } - }, - "type": "object" - }, - "WordCloudSortConfiguration": { - "additionalProperties": false, - "properties": { - "CategoryItemsLimit": { - "$ref": "#/definitions/ItemsLimitConfiguration" - }, - "CategorySort": { - "items": { - "$ref": "#/definitions/FieldSortOptions" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "WordCloudVisual": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/VisualCustomAction" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "ChartConfiguration": { - "$ref": "#/definitions/WordCloudChartConfiguration" - }, - "ColumnHierarchies": { - "items": { - "$ref": "#/definitions/ColumnHierarchy" - }, - "maxItems": 2, - "minItems": 0, - "type": "array" - }, - "Subtitle": { - "$ref": "#/definitions/VisualSubtitleLabelOptions" - }, - "Title": { - "$ref": "#/definitions/VisualTitleLabelOptions" - }, - "VisualId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - } - }, - "required": [ - "VisualId" - ], - "type": "object" - }, - "WordCloudWordCasing": { - "enum": [ - "LOWER_CASE", - "EXISTING_CASE" - ], - "type": "string" - }, - "WordCloudWordOrientation": { - "enum": [ - "HORIZONTAL", - "HORIZONTAL_AND_VERTICAL" - ], - "type": "string" - }, - "WordCloudWordPadding": { - "enum": [ - "NONE", - "SMALL", - "MEDIUM", - "LARGE" - ], - "type": "string" - }, - "WordCloudWordScaling": { - "enum": [ - "EMPHASIZE", - "NORMAL" - ], - "type": "string" - } - }, - "description": "Definition of the AWS::QuickSight::Template Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:DescribeTemplate", - "quicksight:DescribeTemplatePermissions", - "quicksight:CreateTemplate", - "quicksight:DescribeAnalysis", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeTemplate", - "quicksight:DeleteTemplate" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AwsAccountId": { - "$ref": "resource-schema.json#/properties/AwsAccountId" - } - }, - "required": [ - "AwsAccountId" - ] - }, - "permissions": [ - "quicksight:ListTemplates" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeTemplate", - "quicksight:DescribeTemplatePermissions", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeTemplate", - "quicksight:DescribeTemplatePermissions", - "quicksight:UpdateTemplate", - "quicksight:UpdateTemplatePermissions", - "quicksight:PassDataSet", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/TemplateId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the template.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "CreatedTime": { - "description": "

Time when this was created.

", - "format": "date-time", - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/TemplateVersionDefinition" - }, - "LastUpdatedTime": { - "description": "

Time when this was last updated.

", - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/TemplateSourceEntity" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "TemplateId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ValidationStrategy": { - "$ref": "#/definitions/ValidationStrategy" - }, - "Version": { - "$ref": "#/definitions/TemplateVersion" - }, - "VersionDescription": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/Version" - ], - "required": [ - "AwsAccountId", - "TemplateId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "typeName": "AWS::QuickSight::Template", - "writeOnlyProperties": [ - "/properties/Definition", - "/properties/VersionDescription", - "/properties/SourceEntity", - "/properties/ValidationStrategy" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/TemplateId" + ], + "definitions": { + "AggregationFunction": { + "additionalProperties": false, + "properties": { + "AttributeAggregationFunction": { + "$ref": "#/definitions/AttributeAggregationFunction" + }, + "CategoricalAggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "DateAggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "NumericalAggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + } + }, + "type": "object" + }, + "AggregationSortConfiguration": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SortDirection": { + "$ref": "#/definitions/SortDirection" + } + }, + "required": [ + "Column", + "SortDirection" + ], + "type": "object" + }, + "AllSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "AnalysisDefaults": { + "additionalProperties": false, + "properties": { + "DefaultNewSheetConfiguration": { + "$ref": "#/definitions/DefaultNewSheetConfiguration" + } + }, + "required": [ + "DefaultNewSheetConfiguration" + ], + "type": "object" + }, + "AnchorDateConfiguration": { + "additionalProperties": false, + "properties": { + "AnchorOption": { + "$ref": "#/definitions/AnchorOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "type": "object" + }, + "AnchorOption": { + "enum": [ + "NOW" + ], + "type": "string" + }, + "ArcAxisConfiguration": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/ArcAxisDisplayRange" + }, + "ReserveRange": { + "default": 0, + "type": "number" + } + }, + "type": "object" + }, + "ArcAxisDisplayRange": { + "additionalProperties": false, + "properties": { + "Max": { + "default": null, + "type": "number" + }, + "Min": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "ArcConfiguration": { + "additionalProperties": false, + "properties": { + "ArcAngle": { + "default": null, + "type": "number" + }, + "ArcThickness": { + "$ref": "#/definitions/ArcThicknessOptions" + } + }, + "type": "object" + }, + "ArcOptions": { + "additionalProperties": false, + "properties": { + "ArcThickness": { + "$ref": "#/definitions/ArcThickness" + } + }, + "type": "object" + }, + "ArcThickness": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE", + "WHOLE" + ], + "type": "string" + }, + "ArcThicknessOptions": { + "enum": [ + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "AssetOptions": { + "additionalProperties": false, + "properties": { + "Timezone": { + "type": "string" + }, + "WeekStart": { + "$ref": "#/definitions/DayOfTheWeek" + } + }, + "type": "object" + }, + "AttributeAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleAttributeAggregation": { + "$ref": "#/definitions/SimpleAttributeAggregationFunction" + }, + "ValueForMultipleValues": { + "type": "string" + } + }, + "type": "object" + }, + "AxisBinding": { + "enum": [ + "PRIMARY_YAXIS", + "SECONDARY_YAXIS" + ], + "type": "string" + }, + "AxisDataOptions": { + "additionalProperties": false, + "properties": { + "DateAxisOptions": { + "$ref": "#/definitions/DateAxisOptions" + }, + "NumericAxisOptions": { + "$ref": "#/definitions/NumericAxisOptions" + } + }, + "type": "object" + }, + "AxisDisplayDataDrivenRange": { + "additionalProperties": false, + "type": "object" + }, + "AxisDisplayMinMaxRange": { + "additionalProperties": false, + "properties": { + "Maximum": { + "default": null, + "type": "number" + }, + "Minimum": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AxisOffset": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "DataOptions": { + "$ref": "#/definitions/AxisDataOptions" + }, + "GridLineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ScrollbarOptions": { + "$ref": "#/definitions/ScrollBarOptions" + }, + "TickLabelOptions": { + "$ref": "#/definitions/AxisTickLabelOptions" + } + }, + "type": "object" + }, + "AxisDisplayRange": { + "additionalProperties": false, + "properties": { + "DataDriven": { + "$ref": "#/definitions/AxisDisplayDataDrivenRange" + }, + "MinMax": { + "$ref": "#/definitions/AxisDisplayMinMaxRange" + } + }, + "type": "object" + }, + "AxisLabelOptions": { + "additionalProperties": false, + "properties": { + "ApplyTo": { + "$ref": "#/definitions/AxisLabelReferenceOptions" + }, + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "AxisLabelReferenceOptions": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "AxisLinearScale": { + "additionalProperties": false, + "properties": { + "StepCount": { + "default": null, + "type": "number" + }, + "StepSize": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisLogarithmicScale": { + "additionalProperties": false, + "properties": { + "Base": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "AxisScale": { + "additionalProperties": false, + "properties": { + "Linear": { + "$ref": "#/definitions/AxisLinearScale" + }, + "Logarithmic": { + "$ref": "#/definitions/AxisLogarithmicScale" + } + }, + "type": "object" + }, + "AxisTickLabelOptions": { + "additionalProperties": false, + "properties": { + "LabelOptions": { + "$ref": "#/definitions/LabelOptions" + }, + "RotationAngle": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "BarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Orientation": { + "$ref": "#/definitions/BarChartOrientation" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/BarChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BarChartFieldWells": { + "additionalProperties": false, + "properties": { + "BarChartAggregatedFieldWells": { + "$ref": "#/definitions/BarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "BarChartOrientation": { + "enum": [ + "HORIZONTAL", + "VERTICAL" + ], + "type": "string" + }, + "BarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "BarsArrangement": { + "enum": [ + "CLUSTERED", + "STACKED", + "STACKED_PERCENT" + ], + "type": "string" + }, + "BaseMapStyleType": { + "enum": [ + "LIGHT_GRAY", + "DARK_GRAY", + "STREET", + "IMAGERY" + ], + "type": "string" + }, + "BinCountOptions": { + "additionalProperties": false, + "properties": { + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BinWidthOptions": { + "additionalProperties": false, + "properties": { + "BinCountLimit": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "Value": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "BodySectionConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/BodySectionContent" + }, + "PageBreakConfiguration": { + "$ref": "#/definitions/SectionPageBreakConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Content", + "SectionId" + ], + "type": "object" + }, + "BodySectionContent": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + } + }, + "type": "object" + }, + "BoxPlotAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "BoxPlotChartConfiguration": { + "additionalProperties": false, + "properties": { + "BoxPlotOptions": { + "$ref": "#/definitions/BoxPlotOptions" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/BoxPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SortConfiguration": { + "$ref": "#/definitions/BoxPlotSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "BoxPlotFieldWells": { + "additionalProperties": false, + "properties": { + "BoxPlotAggregatedFieldWells": { + "$ref": "#/definitions/BoxPlotAggregatedFieldWells" + } + }, + "type": "object" + }, + "BoxPlotFillStyle": { + "enum": [ + "SOLID", + "TRANSPARENT" + ], + "type": "string" + }, + "BoxPlotOptions": { + "additionalProperties": false, + "properties": { + "AllDataPointsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "OutlierVisibility": { + "$ref": "#/definitions/Visibility" + }, + "StyleOptions": { + "$ref": "#/definitions/BoxPlotStyleOptions" + } + }, + "type": "object" + }, + "BoxPlotSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + } + }, + "type": "object" + }, + "BoxPlotStyleOptions": { + "additionalProperties": false, + "properties": { + "FillStyle": { + "$ref": "#/definitions/BoxPlotFillStyle" + } + }, + "type": "object" + }, + "BoxPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/BoxPlotChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "CalculatedField": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 32000, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 127, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "Expression", + "Name" + ], + "type": "object" + }, + "CalculatedMeasureField": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression", + "FieldId" + ], + "type": "object" + }, + "CascadingControlConfiguration": { + "additionalProperties": false, + "properties": { + "SourceControls": { + "items": { + "$ref": "#/definitions/CascadingControlSource" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CascadingControlSource": { + "additionalProperties": false, + "properties": { + "ColumnToMatch": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceSheetControlId": { + "type": "string" + } + }, + "type": "object" + }, + "CategoricalAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT" + ], + "type": "string" + }, + "CategoricalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoricalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/CategoricalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "CategoryDrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "CategoryValues", + "Column" + ], + "type": "object" + }, + "CategoryFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "Column", + "Configuration", + "FilterId" + ], + "type": "object" + }, + "CategoryFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CustomFilterConfiguration": { + "$ref": "#/definitions/CustomFilterConfiguration" + }, + "CustomFilterListConfiguration": { + "$ref": "#/definitions/CustomFilterListConfiguration" + }, + "FilterListConfiguration": { + "$ref": "#/definitions/FilterListConfiguration" + } + }, + "type": "object" + }, + "CategoryFilterMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL", + "CONTAINS", + "DOES_NOT_CONTAIN", + "STARTS_WITH", + "ENDS_WITH" + ], + "type": "string" + }, + "CategoryFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "CategoryInnerFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Configuration": { + "$ref": "#/definitions/CategoryFilterConfiguration" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + } + }, + "required": [ + "Column", + "Configuration" + ], + "type": "object" + }, + "ChartAxisLabelOptions": { + "additionalProperties": false, + "properties": { + "AxisLabelOptions": { + "items": { + "$ref": "#/definitions/AxisLabelOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SortIconVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ClusterMarker": { + "additionalProperties": false, + "properties": { + "SimpleClusterMarker": { + "$ref": "#/definitions/SimpleClusterMarker" + } + }, + "type": "object" + }, + "ClusterMarkerConfiguration": { + "additionalProperties": false, + "properties": { + "ClusterMarker": { + "$ref": "#/definitions/ClusterMarker" + } + }, + "type": "object" + }, + "ColorFillType": { + "enum": [ + "DISCRETE", + "GRADIENT" + ], + "type": "string" + }, + "ColorScale": { + "additionalProperties": false, + "properties": { + "ColorFillType": { + "$ref": "#/definitions/ColorFillType" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DataColor" + }, + "maxItems": 3, + "minItems": 2, + "type": "array" + }, + "NullValueColor": { + "$ref": "#/definitions/DataColor" + } + }, + "required": [ + "ColorFillType", + "Colors" + ], + "type": "object" + }, + "ColorsConfiguration": { + "additionalProperties": false, + "properties": { + "CustomColors": { + "items": { + "$ref": "#/definitions/CustomColor" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ColumnConfiguration": { + "additionalProperties": false, + "properties": { + "ColorsConfiguration": { + "$ref": "#/definitions/ColorsConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + }, + "Role": { + "$ref": "#/definitions/ColumnRole" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ColumnGroupColumnSchema": { + "additionalProperties": false, + "description": "

A structure describing the name, data type, and geographic role of the columns.

", + "properties": { + "Name": { + "description": "

The name of the column group's column schema.

", + "type": "string" + } + }, + "type": "object" + }, + "ColumnGroupSchema": { + "additionalProperties": false, + "description": "

The column group schema.

", + "properties": { + "ColumnGroupColumnSchemaList": { + "description": "

A structure containing the list of schemas for column group columns.

", + "items": { + "$ref": "#/definitions/ColumnGroupColumnSchema" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "

The name of the column group schema.

", + "type": "string" + } + }, + "type": "object" + }, + "ColumnHierarchy": { + "additionalProperties": false, + "properties": { + "DateTimeHierarchy": { + "$ref": "#/definitions/DateTimeHierarchy" + }, + "ExplicitHierarchy": { + "$ref": "#/definitions/ExplicitHierarchy" + }, + "PredefinedHierarchy": { + "$ref": "#/definitions/PredefinedHierarchy" + } + }, + "type": "object" + }, + "ColumnIdentifier": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ColumnName", + "DataSetIdentifier" + ], + "type": "object" + }, + "ColumnRole": { + "enum": [ + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "ColumnSchema": { + "additionalProperties": false, + "description": "

The column schema.

", + "properties": { + "DataType": { + "description": "

The data type of the column schema.

", + "type": "string" + }, + "GeographicRole": { + "description": "

The geographic role of the column schema.

", + "type": "string" + }, + "Name": { + "description": "

The name of the column schema.

", + "type": "string" + } + }, + "type": "object" + }, + "ColumnSort": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortBy": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "Direction", + "SortBy" + ], + "type": "object" + }, + "ColumnTooltipItem": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Column" + ], + "type": "object" + }, + "ComboChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "BarValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "LineValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartConfiguration": { + "additionalProperties": false, + "properties": { + "BarDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "BarsArrangement": { + "$ref": "#/definitions/BarsArrangement" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ComboChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "LineDataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/ComboChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "ComboChartFieldWells": { + "additionalProperties": false, + "properties": { + "ComboChartAggregatedFieldWells": { + "$ref": "#/definitions/ComboChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "ComboChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ComboChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ComboChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ComparisonConfiguration": { + "additionalProperties": false, + "properties": { + "ComparisonFormat": { + "$ref": "#/definitions/ComparisonFormatConfiguration" + }, + "ComparisonMethod": { + "$ref": "#/definitions/ComparisonMethod" + } + }, + "type": "object" + }, + "ComparisonFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "ComparisonMethod": { + "enum": [ + "DIFFERENCE", + "PERCENT_DIFFERENCE", + "PERCENT" + ], + "type": "string" + }, + "Computation": { + "additionalProperties": false, + "properties": { + "Forecast": { + "$ref": "#/definitions/ForecastComputation" + }, + "GrowthRate": { + "$ref": "#/definitions/GrowthRateComputation" + }, + "MaximumMinimum": { + "$ref": "#/definitions/MaximumMinimumComputation" + }, + "MetricComparison": { + "$ref": "#/definitions/MetricComparisonComputation" + }, + "PeriodOverPeriod": { + "$ref": "#/definitions/PeriodOverPeriodComputation" + }, + "PeriodToDate": { + "$ref": "#/definitions/PeriodToDateComputation" + }, + "TopBottomMovers": { + "$ref": "#/definitions/TopBottomMoversComputation" + }, + "TopBottomRanked": { + "$ref": "#/definitions/TopBottomRankedComputation" + }, + "TotalAggregation": { + "$ref": "#/definitions/TotalAggregationComputation" + }, + "UniqueValues": { + "$ref": "#/definitions/UniqueValuesComputation" + } + }, + "type": "object" + }, + "ConditionalFormattingColor": { + "additionalProperties": false, + "properties": { + "Gradient": { + "$ref": "#/definitions/ConditionalFormattingGradientColor" + }, + "Solid": { + "$ref": "#/definitions/ConditionalFormattingSolidColor" + } + }, + "type": "object" + }, + "ConditionalFormattingCustomIconCondition": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DisplayConfiguration": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayConfiguration" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconOptions": { + "$ref": "#/definitions/ConditionalFormattingCustomIconOptions" + } + }, + "required": [ + "Expression", + "IconOptions" + ], + "type": "object" + }, + "ConditionalFormattingCustomIconOptions": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/Icon" + }, + "UnicodeIcon": { + "pattern": "^[^\\u0000-\\u00FF]$", + "type": "string" + } + }, + "type": "object" + }, + "ConditionalFormattingGradientColor": { + "additionalProperties": false, + "properties": { + "Color": { + "$ref": "#/definitions/GradientColor" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Color", + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIcon": { + "additionalProperties": false, + "properties": { + "CustomCondition": { + "$ref": "#/definitions/ConditionalFormattingCustomIconCondition" + }, + "IconSet": { + "$ref": "#/definitions/ConditionalFormattingIconSet" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayConfiguration": { + "additionalProperties": false, + "properties": { + "IconDisplayOption": { + "$ref": "#/definitions/ConditionalFormattingIconDisplayOption" + } + }, + "type": "object" + }, + "ConditionalFormattingIconDisplayOption": { + "enum": [ + "ICON_ONLY" + ], + "type": "string" + }, + "ConditionalFormattingIconSet": { + "additionalProperties": false, + "properties": { + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IconSetType": { + "$ref": "#/definitions/ConditionalFormattingIconSetType" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ConditionalFormattingIconSetType": { + "enum": [ + "PLUS_MINUS", + "CHECK_X", + "THREE_COLOR_ARROW", + "THREE_GRAY_ARROW", + "CARET_UP_MINUS_DOWN", + "THREE_SHAPE", + "THREE_CIRCLE", + "FLAGS", + "BARS", + "FOUR_COLOR_ARROW", + "FOUR_GRAY_ARROW" + ], + "type": "string" + }, + "ConditionalFormattingSolidColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "ContributionAnalysisDefault": { + "additionalProperties": false, + "properties": { + "ContributorDimensions": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 4, + "minItems": 1, + "type": "array" + }, + "MeasureFieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ContributorDimensions", + "MeasureFieldId" + ], + "type": "object" + }, + "CrossDatasetTypes": { + "enum": [ + "ALL_DATASETS", + "SINGLE_DATASET" + ], + "type": "string" + }, + "CurrencyDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Symbol": { + "pattern": "^[A-Z]{3}$", + "type": "string" + } + }, + "type": "object" + }, + "CustomActionFilterOperation": { + "additionalProperties": false, + "properties": { + "SelectedFieldsConfiguration": { + "$ref": "#/definitions/FilterOperationSelectedFieldsConfiguration" + }, + "TargetVisualsConfiguration": { + "$ref": "#/definitions/FilterOperationTargetVisualsConfiguration" + } + }, + "required": [ + "SelectedFieldsConfiguration", + "TargetVisualsConfiguration" + ], + "type": "object" + }, + "CustomActionNavigationOperation": { + "additionalProperties": false, + "properties": { + "LocalNavigationConfiguration": { + "$ref": "#/definitions/LocalNavigationConfiguration" + } + }, + "type": "object" + }, + "CustomActionSetParametersOperation": { + "additionalProperties": false, + "properties": { + "ParameterValueConfigurations": { + "items": { + "$ref": "#/definitions/SetParameterValueConfiguration" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ParameterValueConfigurations" + ], + "type": "object" + }, + "CustomActionURLOperation": { + "additionalProperties": false, + "properties": { + "URLTarget": { + "$ref": "#/definitions/URLTargetConfiguration" + }, + "URLTemplate": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "URLTarget", + "URLTemplate" + ], + "type": "object" + }, + "CustomColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "SpecialValue": { + "$ref": "#/definitions/SpecialValue" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "CustomContentConfiguration": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/CustomContentType" + }, + "ContentUrl": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ImageScaling": { + "$ref": "#/definitions/CustomContentImageScalingConfiguration" + } + }, + "type": "object" + }, + "CustomContentImageScalingConfiguration": { + "enum": [ + "FIT_TO_HEIGHT", + "FIT_TO_WIDTH", + "DO_NOT_SCALE", + "SCALE_TO_VISUAL" + ], + "type": "string" + }, + "CustomContentType": { + "enum": [ + "IMAGE", + "OTHER_EMBEDDED_CONTENT" + ], + "type": "string" + }, + "CustomContentVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/CustomContentConfiguration" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "CustomFilterConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValue": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomFilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "CustomNarrativeOptions": { + "additionalProperties": false, + "properties": { + "Narrative": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Narrative" + ], + "type": "object" + }, + "CustomParameterValues": { + "additionalProperties": false, + "properties": { + "DateTimeValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "DecimalValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "IntegerValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + }, + "StringValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "CustomValuesConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValues": { + "$ref": "#/definitions/CustomParameterValues" + }, + "IncludeNullValue": { + "type": "boolean" + } + }, + "required": [ + "CustomValues" + ], + "type": "object" + }, + "DataBarsOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "NegativeColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "DataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "DataFieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "DataLabelContent": { + "enum": [ + "VALUE", + "PERCENT", + "VALUE_AND_PERCENT" + ], + "type": "string" + }, + "DataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DataLabelTypes": { + "items": { + "$ref": "#/definitions/DataLabelType" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelContent": { + "$ref": "#/definitions/DataLabelContent" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Overlap": { + "$ref": "#/definitions/DataLabelOverlap" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataLabelOverlap": { + "enum": [ + "DISABLE_OVERLAP", + "ENABLE_OVERLAP" + ], + "type": "string" + }, + "DataLabelPosition": { + "enum": [ + "INSIDE", + "OUTSIDE", + "LEFT", + "TOP", + "BOTTOM", + "RIGHT" + ], + "type": "string" + }, + "DataLabelType": { + "additionalProperties": false, + "properties": { + "DataPathLabelType": { + "$ref": "#/definitions/DataPathLabelType" + }, + "FieldLabelType": { + "$ref": "#/definitions/FieldLabelType" + }, + "MaximumLabelType": { + "$ref": "#/definitions/MaximumLabelType" + }, + "MinimumLabelType": { + "$ref": "#/definitions/MinimumLabelType" + }, + "RangeEndsLabelType": { + "$ref": "#/definitions/RangeEndsLabelType" + } + }, + "type": "object" + }, + "DataPathColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Element": { + "$ref": "#/definitions/DataPathValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Color", + "Element" + ], + "type": "object" + }, + "DataPathLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DataPathSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "SortPaths": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Direction", + "SortPaths" + ], + "type": "object" + }, + "DataPathType": { + "additionalProperties": false, + "properties": { + "PivotTableDataPathType": { + "$ref": "#/definitions/PivotTableDataPathType" + } + }, + "type": "object" + }, + "DataPathValue": { + "additionalProperties": false, + "properties": { + "DataPathType": { + "$ref": "#/definitions/DataPathType" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FieldValue": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "DataSetConfiguration": { + "additionalProperties": false, + "description": "

Dataset configuration.

", + "properties": { + "ColumnGroupSchemaList": { + "description": "

A structure containing the list of column group schemas.

", + "items": { + "$ref": "#/definitions/ColumnGroupSchema" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + }, + "DataSetSchema": { + "$ref": "#/definitions/DataSetSchema" + }, + "Placeholder": { + "description": "

Placeholder.

", + "type": "string" + } + }, + "type": "object" + }, + "DataSetReference": { + "additionalProperties": false, + "description": "

Dataset reference.

", + "properties": { + "DataSetArn": { + "description": "

Dataset Amazon Resource Name (ARN).

", + "type": "string" + }, + "DataSetPlaceholder": { + "description": "

Dataset placeholder.

", + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "DataSetArn", + "DataSetPlaceholder" + ], + "type": "object" + }, + "DataSetSchema": { + "additionalProperties": false, + "description": "

Dataset schema.

", + "properties": { + "ColumnSchemaList": { + "description": "

A structure containing the list of column schemas.

", + "items": { + "$ref": "#/definitions/ColumnSchema" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DateAggregationFunction": { + "enum": [ + "COUNT", + "DISTINCT_COUNT", + "MIN", + "MAX" + ], + "type": "string" + }, + "DateAxisOptions": { + "additionalProperties": false, + "properties": { + "MissingDateVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DateDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DateGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/DateAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "DateTimeDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValues": { + "items": { + "format": "date-time", + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DateTimeFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "DateTimeHierarchy": { + "additionalProperties": false, + "properties": { + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "HierarchyId" + ], + "type": "object" + }, + "DateTimeParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DateTimeDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DateTimeValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "DateTimePickerControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DateTimeValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "format": "date-time", + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DayOfTheWeek": { + "enum": [ + "SUNDAY", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY" + ], + "type": "string" + }, + "DecimalDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "DecimalParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/DecimalDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/DecimalValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "DecimalPlacesConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlaces": { + "maximum": 20, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "DecimalPlaces" + ], + "type": "object" + }, + "DecimalValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultGridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultInteractiveLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeForm": { + "$ref": "#/definitions/DefaultFreeFormLayoutConfiguration" + }, + "Grid": { + "$ref": "#/definitions/DefaultGridLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultNewSheetConfiguration": { + "additionalProperties": false, + "properties": { + "InteractiveLayoutConfiguration": { + "$ref": "#/definitions/DefaultInteractiveLayoutConfiguration" + }, + "PaginatedLayoutConfiguration": { + "$ref": "#/definitions/DefaultPaginatedLayoutConfiguration" + }, + "SheetContentType": { + "$ref": "#/definitions/SheetContentType" + } + }, + "type": "object" + }, + "DefaultPaginatedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "SectionBased": { + "$ref": "#/definitions/DefaultSectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultSectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + } + }, + "required": [ + "CanvasSizeOptions" + ], + "type": "object" + }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, + "DestinationParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValuesConfiguration": { + "$ref": "#/definitions/CustomValuesConfiguration" + }, + "SelectAllValueOptions": { + "$ref": "#/definitions/SelectAllValueOptions" + }, + "SourceColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "SourceField": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SourceParameterName": { + "type": "string" + } + }, + "type": "object" + }, + "DimensionField": { + "additionalProperties": false, + "properties": { + "CategoricalDimensionField": { + "$ref": "#/definitions/CategoricalDimensionField" + }, + "DateDimensionField": { + "$ref": "#/definitions/DateDimensionField" + }, + "NumericalDimensionField": { + "$ref": "#/definitions/NumericalDimensionField" + } + }, + "type": "object" + }, + "DonutCenterOptions": { + "additionalProperties": false, + "properties": { + "LabelVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "DonutOptions": { + "additionalProperties": false, + "properties": { + "ArcOptions": { + "$ref": "#/definitions/ArcOptions" + }, + "DonutCenterOptions": { + "$ref": "#/definitions/DonutCenterOptions" + } + }, + "type": "object" + }, + "DrillDownFilter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryDrillDownFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityDrillDownFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeDrillDownFilter" + } + }, + "type": "object" + }, + "DropDownControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "DynamicDefaultValue": { + "additionalProperties": false, + "properties": { + "DefaultValueColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "GroupNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "UserNameColumn": { + "$ref": "#/definitions/ColumnIdentifier" + } + }, + "required": [ + "DefaultValueColumn" + ], + "type": "object" + }, + "EmptyVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "Entity": { + "additionalProperties": false, + "properties": { + "Path": { + "pattern": "\\S", + "type": "string" + } + }, + "type": "object" + }, + "ExcludePeriodConfiguration": { + "additionalProperties": false, + "properties": { + "Amount": { + "default": null, + "type": "number" + }, + "Granularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "Amount", + "Granularity" + ], + "type": "object" + }, + "ExplicitHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 2, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "FieldBasedTooltip": { + "additionalProperties": false, + "properties": { + "AggregationVisibility": { + "$ref": "#/definitions/Visibility" + }, + "TooltipFields": { + "items": { + "$ref": "#/definitions/TooltipItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "TooltipTitleType": { + "$ref": "#/definitions/TooltipTitleType" + } + }, + "type": "object" + }, + "FieldLabelType": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FieldSeriesItem": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Settings": { + "$ref": "#/definitions/LineChartSeriesSettings" + } + }, + "required": [ + "AxisBinding", + "FieldId" + ], + "type": "object" + }, + "FieldSort": { + "additionalProperties": false, + "properties": { + "Direction": { + "$ref": "#/definitions/SortDirection" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Direction", + "FieldId" + ], + "type": "object" + }, + "FieldSortOptions": { + "additionalProperties": false, + "properties": { + "ColumnSort": { + "$ref": "#/definitions/ColumnSort" + }, + "FieldSort": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "FieldTooltipItem": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Label": { + "type": "string" + }, + "TooltipTarget": { + "$ref": "#/definitions/TooltipTarget" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/FilledMapConditionalFormattingOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "ConditionalFormattingOptions" + ], + "type": "object" + }, + "FilledMapConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Shape": { + "$ref": "#/definitions/FilledMapShapeConditionalFormatting" + } + }, + "required": [ + "Shape" + ], + "type": "object" + }, + "FilledMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/FilledMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/FilledMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "FilledMapFieldWells": { + "additionalProperties": false, + "properties": { + "FilledMapAggregatedFieldWells": { + "$ref": "#/definitions/FilledMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "FilledMapShapeConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Format": { + "$ref": "#/definitions/ShapeConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "FilledMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilledMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FilledMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/FilledMapConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/CategoryFilter" + }, + "NestedFilter": { + "$ref": "#/definitions/NestedFilter" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/NumericEqualityFilter" + }, + "NumericRangeFilter": { + "$ref": "#/definitions/NumericRangeFilter" + }, + "RelativeDatesFilter": { + "$ref": "#/definitions/RelativeDatesFilter" + }, + "TimeEqualityFilter": { + "$ref": "#/definitions/TimeEqualityFilter" + }, + "TimeRangeFilter": { + "$ref": "#/definitions/TimeRangeFilter" + }, + "TopBottomFilter": { + "$ref": "#/definitions/TopBottomFilter" + } + }, + "type": "object" + }, + "FilterControl": { + "additionalProperties": false, + "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, + "DateTimePicker": { + "$ref": "#/definitions/FilterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/FilterDropDownControl" + }, + "List": { + "$ref": "#/definitions/FilterListControl" + }, + "RelativeDateTime": { + "$ref": "#/definitions/FilterRelativeDateTimeControl" + }, + "Slider": { + "$ref": "#/definitions/FilterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/FilterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/FilterTextFieldControl" + } + }, + "type": "object" + }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, + "FilterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterGroup": { + "additionalProperties": false, + "properties": { + "CrossDataset": { + "$ref": "#/definitions/CrossDatasetTypes" + }, + "FilterGroupId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Filters": { + "items": { + "$ref": "#/definitions/Filter" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "ScopeConfiguration": { + "$ref": "#/definitions/FilterScopeConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "required": [ + "CrossDataset", + "FilterGroupId", + "Filters", + "ScopeConfiguration" + ], + "type": "object" + }, + "FilterListConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryValues": { + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 100000, + "minItems": 0, + "type": "array" + }, + "MatchOperator": { + "$ref": "#/definitions/CategoryFilterMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "SelectAllOptions": { + "$ref": "#/definitions/CategoryFilterSelectAllOptions" + } + }, + "required": [ + "MatchOperator" + ], + "type": "object" + }, + "FilterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterNullOption": { + "enum": [ + "ALL_VALUES", + "NULLS_ONLY", + "NON_NULLS_ONLY" + ], + "type": "string" + }, + "FilterOperationSelectedFieldsConfiguration": { + "additionalProperties": false, + "properties": { + "SelectedColumns": { + "description": "

The selected columns of a dataset.

", + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "$ref": "#/definitions/SelectedFieldOptions" + }, + "SelectedFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FilterOperationTargetVisualsConfiguration": { + "additionalProperties": false, + "properties": { + "SameSheetTargetVisualConfiguration": { + "$ref": "#/definitions/SameSheetTargetVisualConfiguration" + } + }, + "type": "object" + }, + "FilterRelativeDateTimeControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "AllSheets": { + "$ref": "#/definitions/AllSheetsFilterScopeConfiguration" + }, + "SelectedSheets": { + "$ref": "#/definitions/SelectedSheetsFilterScopeConfiguration" + } + }, + "type": "object" + }, + "FilterSelectableValues": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FilterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "FilterControlId", + "MaximumValue", + "MinimumValue", + "SourceFilterId", + "StepSize", + "Title" + ], + "type": "object" + }, + "FilterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId", + "Title" + ], + "type": "object" + }, + "FilterVisualScope": { + "enum": [ + "ALL_VISUALS", + "SELECTED_VISUALS" + ], + "type": "string" + }, + "FontConfiguration": { + "additionalProperties": false, + "properties": { + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontDecoration": { + "$ref": "#/definitions/FontDecoration" + }, + "FontSize": { + "$ref": "#/definitions/FontSize" + }, + "FontStyle": { + "$ref": "#/definitions/FontStyle" + }, + "FontWeight": { + "$ref": "#/definitions/FontWeight" + } + }, + "type": "object" + }, + "FontDecoration": { + "enum": [ + "UNDERLINE", + "NONE" + ], + "type": "string" + }, + "FontSize": { + "additionalProperties": false, + "properties": { + "Relative": { + "$ref": "#/definitions/RelativeFontSize" + } + }, + "type": "object" + }, + "FontStyle": { + "enum": [ + "NORMAL", + "ITALIC" + ], + "type": "string" + }, + "FontWeight": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/FontWeightName" + } + }, + "type": "object" + }, + "FontWeightName": { + "enum": [ + "NORMAL", + "BOLD" + ], + "type": "string" + }, + "ForecastComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "CustomSeasonalityValue": { + "default": null, + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "LowerBoundary": { + "default": null, + "type": "number" + }, + "Name": { + "type": "string" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "$ref": "#/definitions/ForecastComputationSeasonality" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "UpperBoundary": { + "default": null, + "type": "number" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ForecastComputationSeasonality": { + "enum": [ + "AUTOMATIC", + "CUSTOM" + ], + "type": "string" + }, + "ForecastConfiguration": { + "additionalProperties": false, + "properties": { + "ForecastProperties": { + "$ref": "#/definitions/TimeBasedForecastProperties" + }, + "Scenario": { + "$ref": "#/definitions/ForecastScenario" + } + }, + "type": "object" + }, + "ForecastScenario": { + "additionalProperties": false, + "properties": { + "WhatIfPointScenario": { + "$ref": "#/definitions/WhatIfPointScenario" + }, + "WhatIfRangeScenario": { + "$ref": "#/definitions/WhatIfRangeScenario" + } + }, + "type": "object" + }, + "FormatConfiguration": { + "additionalProperties": false, + "properties": { + "DateTimeFormatConfiguration": { + "$ref": "#/definitions/DateTimeFormatConfiguration" + }, + "NumberFormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "StringFormatConfiguration": { + "$ref": "#/definitions/StringFormatConfiguration" + } + }, + "type": "object" + }, + "FreeFormLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "FreeFormLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/FreeFormLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FreeFormLayoutElement": { + "additionalProperties": false, + "properties": { + "BackgroundStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBackgroundStyle" + }, + "BorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "LoadingAnimation": { + "$ref": "#/definitions/LoadingAnimation" + }, + "RenderingRules": { + "items": { + "$ref": "#/definitions/SheetElementRenderingRule" + }, + "maxItems": 10000, + "minItems": 0, + "type": "array" + }, + "SelectedBorderStyle": { + "$ref": "#/definitions/FreeFormLayoutElementBorderStyle" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "XAxisLocation": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "YAxisLocation": { + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value", + "type": "string" + } + }, + "required": [ + "ElementId", + "ElementType", + "Height", + "Width", + "XAxisLocation", + "YAxisLocation" + ], + "type": "object" + }, + "FreeFormLayoutElementBackgroundStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutElementBorderStyle": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FreeFormLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "OptimizedViewPortWidth" + ], + "type": "object" + }, + "FreeFormSectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "Elements": { + "items": { + "$ref": "#/definitions/FreeFormLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "FunnelChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabelOptions": { + "$ref": "#/definitions/FunnelChartDataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/FunnelChartFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/FunnelChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "FunnelChartDataLabelOptions": { + "additionalProperties": false, + "properties": { + "CategoryLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LabelColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "LabelFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "MeasureDataLabelStyle": { + "$ref": "#/definitions/FunnelChartMeasureDataLabelStyle" + }, + "MeasureLabelVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Position": { + "$ref": "#/definitions/DataLabelPosition" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "FunnelChartFieldWells": { + "additionalProperties": false, + "properties": { + "FunnelChartAggregatedFieldWells": { + "$ref": "#/definitions/FunnelChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "FunnelChartMeasureDataLabelStyle": { + "enum": [ + "VALUE_ONLY", + "PERCENTAGE_BY_FIRST_STAGE", + "PERCENTAGE_BY_PREVIOUS_STAGE", + "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE", + "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" + ], + "type": "string" + }, + "FunnelChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "FunnelChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/FunnelChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GaugeChartArcConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/GaugeChartConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/GaugeChartArcConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/GaugeChartPrimaryValueConditionalFormatting" + } + }, + "type": "object" + }, + "GaugeChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/GaugeChartFieldWells" + }, + "GaugeChartOptions": { + "$ref": "#/definitions/GaugeChartOptions" + }, + "TooltipOptions": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "GaugeChartFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GaugeChartOptions": { + "additionalProperties": false, + "properties": { + "Arc": { + "$ref": "#/definitions/ArcConfiguration" + }, + "ArcAxis": { + "$ref": "#/definitions/ArcAxisConfiguration" + }, + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + } + }, + "type": "object" + }, + "GaugeChartPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "GaugeChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GaugeChartConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/GaugeChartConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialCoordinateBounds": { + "additionalProperties": false, + "properties": { + "East": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + }, + "North": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "South": { + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "West": { + "maximum": 1800, + "minimum": -1800, + "type": "number" + } + }, + "required": [ + "East", + "North", + "South", + "West" + ], + "type": "object" + }, + "GeospatialHeatmapColorScale": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/GeospatialHeatmapDataColor" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialHeatmapConfiguration": { + "additionalProperties": false, + "properties": { + "HeatmapColor": { + "$ref": "#/definitions/GeospatialHeatmapColorScale" + } + }, + "type": "object" + }, + "GeospatialHeatmapDataColor": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "required": [ + "Color" + ], + "type": "object" + }, + "GeospatialMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Geospatial": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GeospatialMapConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/GeospatialMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "MapStyleOptions": { + "$ref": "#/definitions/GeospatialMapStyleOptions" + }, + "PointStyleOptions": { + "$ref": "#/definitions/GeospatialPointStyleOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WindowOptions": { + "$ref": "#/definitions/GeospatialWindowOptions" + } + }, + "type": "object" + }, + "GeospatialMapFieldWells": { + "additionalProperties": false, + "properties": { + "GeospatialMapAggregatedFieldWells": { + "$ref": "#/definitions/GeospatialMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "GeospatialMapStyleOptions": { + "additionalProperties": false, + "properties": { + "BaseMapStyle": { + "$ref": "#/definitions/BaseMapStyleType" + } + }, + "type": "object" + }, + "GeospatialMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/GeospatialMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "GeospatialPointStyleOptions": { + "additionalProperties": false, + "properties": { + "ClusterMarkerConfiguration": { + "$ref": "#/definitions/ClusterMarkerConfiguration" + }, + "HeatmapConfiguration": { + "$ref": "#/definitions/GeospatialHeatmapConfiguration" + }, + "SelectedPointStyle": { + "$ref": "#/definitions/GeospatialSelectedPointStyle" + } + }, + "type": "object" + }, + "GeospatialSelectedPointStyle": { + "enum": [ + "POINT", + "CLUSTER", + "HEATMAP" + ], + "type": "string" + }, + "GeospatialWindowOptions": { + "additionalProperties": false, + "properties": { + "Bounds": { + "$ref": "#/definitions/GeospatialCoordinateBounds" + }, + "MapZoomMode": { + "$ref": "#/definitions/MapZoomMode" + } + }, + "type": "object" + }, + "GlobalTableBorderOptions": { + "additionalProperties": false, + "properties": { + "SideSpecificBorder": { + "$ref": "#/definitions/TableSideBorderOptions" + }, + "UniformBorder": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "GradientColor": { + "additionalProperties": false, + "properties": { + "Stops": { + "items": { + "$ref": "#/definitions/GradientStop" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "GradientStop": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DataValue": { + "default": null, + "type": "number" + }, + "GradientOffset": { + "default": 0, + "type": "number" + } + }, + "required": [ + "GradientOffset" + ], + "type": "object" + }, + "GridLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "ScreenCanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutScreenCanvasSizeOptions" + } + }, + "type": "object" + }, + "GridLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "CanvasSizeOptions": { + "$ref": "#/definitions/GridLayoutCanvasSizeOptions" + }, + "Elements": { + "items": { + "$ref": "#/definitions/GridLayoutElement" + }, + "maxItems": 430, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Elements" + ], + "type": "object" + }, + "GridLayoutElement": { + "additionalProperties": false, + "properties": { + "ColumnIndex": { + "maximum": 35, + "minimum": 0, + "type": "number" + }, + "ColumnSpan": { + "maximum": 36, + "minimum": 1, + "type": "number" + }, + "ElementId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ElementType": { + "$ref": "#/definitions/LayoutElementType" + }, + "RowIndex": { + "maximum": 9009, + "minimum": 0, + "type": "number" + }, + "RowSpan": { + "maximum": 21, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "ColumnSpan", + "ElementId", + "ElementType", + "RowSpan" + ], + "type": "object" + }, + "GridLayoutScreenCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "OptimizedViewPortWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "ResizeOption": { + "$ref": "#/definitions/ResizeOption" + } + }, + "required": [ + "ResizeOption" + ], + "type": "object" + }, + "GrowthRateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodSize": { + "default": 0, + "maximum": 52, + "minimum": 2, + "type": "number" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "HeaderFooterSectionConfiguration": { + "additionalProperties": false, + "properties": { + "Layout": { + "$ref": "#/definitions/SectionLayoutConfiguration" + }, + "SectionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/SectionStyle" + } + }, + "required": [ + "Layout", + "SectionId" + ], + "type": "object" + }, + "HeatMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "ColumnLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HeatMapFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "RowLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/HeatMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "HeatMapFieldWells": { + "additionalProperties": false, + "properties": { + "HeatMapAggregatedFieldWells": { + "$ref": "#/definitions/HeatMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "HeatMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapColumnSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "HeatMapRowItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "HeatMapRowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HeatMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HeatMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HistogramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "HistogramBinOptions": { + "additionalProperties": false, + "properties": { + "BinCount": { + "$ref": "#/definitions/BinCountOptions" + }, + "BinWidth": { + "$ref": "#/definitions/BinWidthOptions" + }, + "SelectedBinType": { + "$ref": "#/definitions/HistogramBinType" + }, + "StartValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "HistogramBinType": { + "enum": [ + "BIN_COUNT", + "BIN_WIDTH" + ], + "type": "string" + }, + "HistogramConfiguration": { + "additionalProperties": false, + "properties": { + "BinOptions": { + "$ref": "#/definitions/HistogramBinOptions" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/HistogramFieldWells" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + } + }, + "type": "object" + }, + "HistogramFieldWells": { + "additionalProperties": false, + "properties": { + "HistogramAggregatedFieldWells": { + "$ref": "#/definitions/HistogramAggregatedFieldWells" + } + }, + "type": "object" + }, + "HistogramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/HistogramConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "HorizontalTextAlignment": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT", + "AUTO" + ], + "type": "string" + }, + "Icon": { + "enum": [ + "CARET_UP", + "CARET_DOWN", + "PLUS", + "MINUS", + "ARROW_UP", + "ARROW_DOWN", + "ARROW_LEFT", + "ARROW_UP_LEFT", + "ARROW_DOWN_LEFT", + "ARROW_RIGHT", + "ARROW_UP_RIGHT", + "ARROW_DOWN_RIGHT", + "FACE_UP", + "FACE_DOWN", + "FACE_FLAT", + "ONE_BAR", + "TWO_BAR", + "THREE_BAR", + "CIRCLE", + "TRIANGLE", + "SQUARE", + "FLAG", + "THUMBS_UP", + "THUMBS_DOWN", + "CHECKMARK", + "X" + ], + "type": "string" + }, + "InnerFilter": { + "additionalProperties": false, + "properties": { + "CategoryInnerFilter": { + "$ref": "#/definitions/CategoryInnerFilter" + } + }, + "type": "object" + }, + "InsightConfiguration": { + "additionalProperties": false, + "properties": { + "Computations": { + "items": { + "$ref": "#/definitions/Computation" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "CustomNarrative": { + "$ref": "#/definitions/CustomNarrativeOptions" + } + }, + "type": "object" + }, + "InsightVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "InsightConfiguration": { + "$ref": "#/definitions/InsightConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "VisualId" + ], + "type": "object" + }, + "IntegerDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "number" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "IntegerParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/IntegerDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/IntegerValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "IntegerValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "default": null, + "type": "number" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "ItemsLimitConfiguration": { + "additionalProperties": false, + "properties": { + "ItemsLimit": { + "default": null, + "type": "number" + }, + "OtherCategories": { + "$ref": "#/definitions/OtherCategories" + } + }, + "type": "object" + }, + "KPIActualValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIComparisonValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/KPIConditionalFormattingOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "ActualValue": { + "$ref": "#/definitions/KPIActualValueConditionalFormatting" + }, + "ComparisonValue": { + "$ref": "#/definitions/KPIComparisonValueConditionalFormatting" + }, + "PrimaryValue": { + "$ref": "#/definitions/KPIPrimaryValueConditionalFormatting" + }, + "ProgressBar": { + "$ref": "#/definitions/KPIProgressBarConditionalFormatting" + } + }, + "type": "object" + }, + "KPIConfiguration": { + "additionalProperties": false, + "properties": { + "FieldWells": { + "$ref": "#/definitions/KPIFieldWells" + }, + "KPIOptions": { + "$ref": "#/definitions/KPIOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/KPISortConfiguration" + } + }, + "type": "object" + }, + "KPIFieldWells": { + "additionalProperties": false, + "properties": { + "TargetValues": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrendGroups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPIOptions": { + "additionalProperties": false, + "properties": { + "Comparison": { + "$ref": "#/definitions/ComparisonConfiguration" + }, + "PrimaryValueDisplayType": { + "$ref": "#/definitions/PrimaryValueDisplayType" + }, + "PrimaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "ProgressBar": { + "$ref": "#/definitions/ProgressBarOptions" + }, + "SecondaryValue": { + "$ref": "#/definitions/SecondaryValueOptions" + }, + "SecondaryValueFontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Sparkline": { + "$ref": "#/definitions/KPISparklineOptions" + }, + "TrendArrows": { + "$ref": "#/definitions/TrendArrowOptions" + }, + "VisualLayoutOptions": { + "$ref": "#/definitions/KPIVisualLayoutOptions" + } + }, + "type": "object" + }, + "KPIPrimaryValueConditionalFormatting": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPIProgressBarConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ForegroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "KPISortConfiguration": { + "additionalProperties": false, + "properties": { + "TrendGroupSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "KPISparklineOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Type": { + "$ref": "#/definitions/KPISparklineType" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPISparklineType": { + "enum": [ + "LINE", + "AREA" + ], + "type": "string" + }, + "KPIVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/KPIConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/KPIConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "KPIVisualLayoutOptions": { + "additionalProperties": false, + "properties": { + "StandardLayout": { + "$ref": "#/definitions/KPIVisualStandardLayout" + } + }, + "type": "object" + }, + "KPIVisualStandardLayout": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/KPIVisualStandardLayoutType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "KPIVisualStandardLayoutType": { + "enum": [ + "CLASSIC", + "VERTICAL" + ], + "type": "string" + }, + "LabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "Layout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/LayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "LayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormLayoutConfiguration" + }, + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + }, + "SectionBasedLayout": { + "$ref": "#/definitions/SectionBasedLayoutConfiguration" + } + }, + "type": "object" + }, + "LayoutElementType": { + "enum": [ + "VISUAL", + "FILTER_CONTROL", + "PARAMETER_CONTROL", + "TEXT_BOX" + ], + "type": "string" + }, + "LegendOptions": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Position": { + "$ref": "#/definitions/LegendPosition" + }, + "Title": { + "$ref": "#/definitions/LabelOptions" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LegendPosition": { + "enum": [ + "AUTO", + "RIGHT", + "BOTTOM", + "TOP" + ], + "type": "string" + }, + "LineChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Colors": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartConfiguration": { + "additionalProperties": false, + "properties": { + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DefaultSeriesSettings": { + "$ref": "#/definitions/LineChartDefaultSeriesSettings" + }, + "FieldWells": { + "$ref": "#/definitions/LineChartFieldWells" + }, + "ForecastConfigurations": { + "items": { + "$ref": "#/definitions/ForecastConfiguration" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ReferenceLines": { + "items": { + "$ref": "#/definitions/ReferenceLine" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SecondaryYAxisDisplayOptions": { + "$ref": "#/definitions/LineSeriesAxisDisplayOptions" + }, + "SecondaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Series": { + "items": { + "$ref": "#/definitions/SeriesItem" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "SingleAxisOptions": { + "$ref": "#/definitions/SingleAxisOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/LineChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "Type": { + "$ref": "#/definitions/LineChartType" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "LineChartDefaultSeriesSettings": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartFieldWells": { + "additionalProperties": false, + "properties": { + "LineChartAggregatedFieldWells": { + "$ref": "#/definitions/LineChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "LineChartLineStyle": { + "enum": [ + "SOLID", + "DOTTED", + "DASHED" + ], + "type": "string" + }, + "LineChartLineStyleSettings": { + "additionalProperties": false, + "properties": { + "LineInterpolation": { + "$ref": "#/definitions/LineInterpolation" + }, + "LineStyle": { + "$ref": "#/definitions/LineChartLineStyle" + }, + "LineVisibility": { + "$ref": "#/definitions/Visibility" + }, + "LineWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "type": "object" + }, + "LineChartMarkerShape": { + "enum": [ + "CIRCLE", + "TRIANGLE", + "SQUARE", + "DIAMOND", + "ROUNDED_SQUARE" + ], + "type": "string" + }, + "LineChartMarkerStyleSettings": { + "additionalProperties": false, + "properties": { + "MarkerColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "MarkerShape": { + "$ref": "#/definitions/LineChartMarkerShape" + }, + "MarkerSize": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MarkerVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LineChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "LineStyleSettings": { + "$ref": "#/definitions/LineChartLineStyleSettings" + }, + "MarkerStyleSettings": { + "$ref": "#/definitions/LineChartMarkerStyleSettings" + } + }, + "type": "object" + }, + "LineChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "LineChartType": { + "enum": [ + "LINE", + "AREA", + "STACKED_AREA" + ], + "type": "string" + }, + "LineChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/LineChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "LineInterpolation": { + "enum": [ + "LINEAR", + "SMOOTH", + "STEPPED" + ], + "type": "string" + }, + "LineSeriesAxisDisplayOptions": { + "additionalProperties": false, + "properties": { + "AxisOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "MissingDataConfigurations": { + "items": { + "$ref": "#/definitions/MissingDataConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ListControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "SearchOptions": { + "$ref": "#/definitions/ListControlSearchOptions" + }, + "SelectAllOptions": { + "$ref": "#/definitions/ListControlSelectAllOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "ListControlSearchOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ListControlSelectAllOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LoadingAnimation": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "LocalNavigationConfiguration": { + "additionalProperties": false, + "properties": { + "TargetSheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "TargetSheetId" + ], + "type": "object" + }, + "LongFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "MapZoomMode": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "MappedDataSetParameter": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DataSetParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + } + }, + "required": [ + "DataSetIdentifier", + "DataSetParameterName" + ], + "type": "object" + }, + "MaximumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MaximumMinimumComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/MaximumMinimumComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "MaximumMinimumComputationType": { + "enum": [ + "MAXIMUM", + "MINIMUM" + ], + "type": "string" + }, + "MeasureField": { + "additionalProperties": false, + "properties": { + "CalculatedMeasureField": { + "$ref": "#/definitions/CalculatedMeasureField" + }, + "CategoricalMeasureField": { + "$ref": "#/definitions/CategoricalMeasureField" + }, + "DateMeasureField": { + "$ref": "#/definitions/DateMeasureField" + }, + "NumericalMeasureField": { + "$ref": "#/definitions/NumericalMeasureField" + } + }, + "type": "object" + }, + "MetricComparisonComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "FromValue": { + "$ref": "#/definitions/MeasureField" + }, + "Name": { + "type": "string" + }, + "TargetValue": { + "$ref": "#/definitions/MeasureField" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "MinimumLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "MissingDataConfiguration": { + "additionalProperties": false, + "properties": { + "TreatmentOption": { + "$ref": "#/definitions/MissingDataTreatmentOption" + } + }, + "type": "object" + }, + "MissingDataTreatmentOption": { + "enum": [ + "INTERPOLATE", + "SHOW_AS_ZERO", + "SHOW_AS_BLANK" + ], + "type": "string" + }, + "NegativeValueConfiguration": { + "additionalProperties": false, + "properties": { + "DisplayMode": { + "$ref": "#/definitions/NegativeValueDisplayMode" + } + }, + "required": [ + "DisplayMode" + ], + "type": "object" + }, + "NegativeValueDisplayMode": { + "enum": [ + "POSITIVE", + "NEGATIVE" + ], + "type": "string" + }, + "NestedFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeInnerSet": { + "default": false, + "type": "boolean" + }, + "InnerFilter": { + "$ref": "#/definitions/InnerFilter" + } + }, + "required": [ + "Column", + "FilterId", + "IncludeInnerSet", + "InnerFilter" + ], + "type": "object" + }, + "NullValueFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullString": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "NullString" + ], + "type": "object" + }, + "NumberDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumberScale": { + "$ref": "#/definitions/NumberScale" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "NumberFormatConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "NumberScale": { + "enum": [ + "NONE", + "AUTO", + "THOUSANDS", + "MILLIONS", + "BILLIONS", + "TRILLIONS" + ], + "type": "string" + }, + "NumericAxisOptions": { + "additionalProperties": false, + "properties": { + "Range": { + "$ref": "#/definitions/AxisDisplayRange" + }, + "Scale": { + "$ref": "#/definitions/AxisScale" + } + }, + "type": "object" + }, + "NumericEqualityDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Column", + "Value" + ], + "type": "object" + }, + "NumericEqualityFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MatchOperator": { + "$ref": "#/definitions/NumericEqualityMatchOperator" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + }, + "Value": { + "default": null, + "type": "number" + } + }, + "required": [ + "Column", + "FilterId", + "MatchOperator", + "NullOption" + ], + "type": "object" + }, + "NumericEqualityMatchOperator": { + "enum": [ + "EQUALS", + "DOES_NOT_EQUAL" + ], + "type": "string" + }, + "NumericFilterSelectAllOptions": { + "enum": [ + "FILTER_ALL_VALUES" + ], + "type": "string" + }, + "NumericFormatConfiguration": { + "additionalProperties": false, + "properties": { + "CurrencyDisplayFormatConfiguration": { + "$ref": "#/definitions/CurrencyDisplayFormatConfiguration" + }, + "NumberDisplayFormatConfiguration": { + "$ref": "#/definitions/NumberDisplayFormatConfiguration" + }, + "PercentageDisplayFormatConfiguration": { + "$ref": "#/definitions/PercentageDisplayFormatConfiguration" + } + }, + "type": "object" + }, + "NumericRangeFilter": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "RangeMinimum": { + "$ref": "#/definitions/NumericRangeFilterValue" + }, + "SelectAllOptions": { + "$ref": "#/definitions/NumericFilterSelectAllOptions" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "NumericRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StaticValue": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "NumericSeparatorConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalSeparator": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "ThousandsSeparator": { + "$ref": "#/definitions/ThousandSeparatorOptions" + } + }, + "type": "object" + }, + "NumericSeparatorSymbol": { + "enum": [ + "COMMA", + "DOT", + "SPACE" + ], + "type": "string" + }, + "NumericalAggregationFunction": { + "additionalProperties": false, + "properties": { + "PercentileAggregation": { + "$ref": "#/definitions/PercentileAggregation" + }, + "SimpleNumericalAggregation": { + "$ref": "#/definitions/SimpleNumericalAggregationFunction" + } + }, + "type": "object" + }, + "NumericalDimensionField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "NumericalMeasureField": { + "additionalProperties": false, + "properties": { + "AggregationFunction": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/NumberFormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "OtherCategories": { + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "type": "string" + }, + "PaginationConfiguration": { + "additionalProperties": false, + "properties": { + "PageNumber": { + "minimum": 0, + "type": "number" + }, + "PageSize": { + "default": null, + "type": "number" + } + }, + "required": [ + "PageNumber", + "PageSize" + ], + "type": "object" + }, + "PanelBorderStyle": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "PanelConfiguration": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BackgroundVisibility": { + "$ref": "#/definitions/Visibility" + }, + "BorderColor": { + "pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$", + "type": "string" + }, + "BorderStyle": { + "$ref": "#/definitions/PanelBorderStyle" + }, + "BorderThickness": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "BorderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "GutterSpacing": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "GutterVisibility": { + "$ref": "#/definitions/Visibility" + }, + "Title": { + "$ref": "#/definitions/PanelTitleOptions" + } + }, + "type": "object" + }, + "PanelTitleOptions": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PaperOrientation": { + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "PaperSize": { + "enum": [ + "US_LETTER", + "US_LEGAL", + "US_TABLOID_LEDGER", + "A0", + "A1", + "A2", + "A3", + "A4", + "A5", + "JIS_B4", + "JIS_B5" + ], + "type": "string" + }, + "ParameterControl": { + "additionalProperties": false, + "properties": { + "DateTimePicker": { + "$ref": "#/definitions/ParameterDateTimePickerControl" + }, + "Dropdown": { + "$ref": "#/definitions/ParameterDropDownControl" + }, + "List": { + "$ref": "#/definitions/ParameterListControl" + }, + "Slider": { + "$ref": "#/definitions/ParameterSliderControl" + }, + "TextArea": { + "$ref": "#/definitions/ParameterTextAreaControl" + }, + "TextField": { + "$ref": "#/definitions/ParameterTextFieldControl" + } + }, + "type": "object" + }, + "ParameterDateTimePickerControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DateTimeParameterDeclaration": { + "$ref": "#/definitions/DateTimeParameterDeclaration" + }, + "DecimalParameterDeclaration": { + "$ref": "#/definitions/DecimalParameterDeclaration" + }, + "IntegerParameterDeclaration": { + "$ref": "#/definitions/IntegerParameterDeclaration" + }, + "StringParameterDeclaration": { + "$ref": "#/definitions/StringParameterDeclaration" + } + }, + "type": "object" + }, + "ParameterDropDownControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterListControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SelectableValues": { + "$ref": "#/definitions/ParameterSelectableValues" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterSelectableValues": { + "additionalProperties": false, + "properties": { + "LinkToDataSetColumn": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "Values": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ParameterSliderControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "ParameterControlId", + "SourceParameterName", + "StepSize", + "Title" + ], + "type": "object" + }, + "ParameterTextAreaControl": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterTextFieldControl": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + }, + "ParameterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ParameterControlId", + "SourceParameterName", + "Title" + ], + "type": "object" + }, + "ParameterValueType": { + "enum": [ + "MULTI_VALUED", + "SINGLE_VALUED" + ], + "type": "string" + }, + "PercentVisibleRange": { + "additionalProperties": false, + "properties": { + "From": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "To": { + "default": null, + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PercentageDisplayFormatConfiguration": { + "additionalProperties": false, + "properties": { + "DecimalPlacesConfiguration": { + "$ref": "#/definitions/DecimalPlacesConfiguration" + }, + "NegativeValueConfiguration": { + "$ref": "#/definitions/NegativeValueConfiguration" + }, + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SeparatorConfiguration": { + "$ref": "#/definitions/NumericSeparatorConfiguration" + }, + "Suffix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PercentileAggregation": { + "additionalProperties": false, + "properties": { + "PercentileValue": { + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "PeriodOverPeriodComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PeriodToDateComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "PeriodTimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "PieChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SmallMultiples": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ContributionAnalysisDefaults": { + "items": { + "$ref": "#/definitions/ContributionAnalysisDefault" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "DonutOptions": { + "$ref": "#/definitions/DonutOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PieChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SmallMultiplesOptions": { + "$ref": "#/definitions/SmallMultiplesOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PieChartSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "ValueLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "PieChartFieldWells": { + "additionalProperties": false, + "properties": { + "PieChartAggregatedFieldWells": { + "$ref": "#/definitions/PieChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "PieChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SmallMultiplesLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SmallMultiplesSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PieChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PieChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotFieldSortOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SortBy": { + "$ref": "#/definitions/PivotTableSortBy" + } + }, + "required": [ + "FieldId", + "SortBy" + ], + "type": "object" + }, + "PivotTableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Rows": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Scope": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "Scopes": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingScope" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/PivotTableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/PivotTableCellConditionalFormatting" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScope": { + "additionalProperties": false, + "properties": { + "Role": { + "$ref": "#/definitions/PivotTableConditionalFormattingScopeRole" + } + }, + "type": "object" + }, + "PivotTableConditionalFormattingScopeRole": { + "enum": [ + "FIELD", + "FIELD_TOTAL", + "GRAND_TOTAL" + ], + "type": "string" + }, + "PivotTableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/PivotTableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/PivotTableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/PivotTablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/PivotTableSortConfiguration" + }, + "TableOptions": { + "$ref": "#/definitions/PivotTableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/PivotTableTotalOptions" + } + }, + "type": "object" + }, + "PivotTableDataPathOption": { + "additionalProperties": false, + "properties": { + "DataPathList": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "DataPathList" + ], + "type": "object" + }, + "PivotTableDataPathType": { + "enum": [ + "HIERARCHY_ROWS_LAYOUT_COLUMN", + "MULTIPLE_ROW_METRICS_COLUMN", + "EMPTY_COLUMN_HEADER", + "COUNT_METRIC_COLUMN" + ], + "type": "string" + }, + "PivotTableFieldCollapseState": { + "enum": [ + "COLLAPSED", + "EXPANDED" + ], + "type": "string" + }, + "PivotTableFieldCollapseStateOption": { + "additionalProperties": false, + "properties": { + "State": { + "$ref": "#/definitions/PivotTableFieldCollapseState" + }, + "Target": { + "$ref": "#/definitions/PivotTableFieldCollapseStateTarget" + } + }, + "required": [ + "Target" + ], + "type": "object" + }, + "PivotTableFieldCollapseStateTarget": { + "additionalProperties": false, + "properties": { + "FieldDataPathValues": { + "items": { + "$ref": "#/definitions/DataPathValue" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "FieldId": { + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "PivotTableFieldOptions": { + "additionalProperties": false, + "properties": { + "CollapseStateOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldCollapseStateOption" + }, + "type": "array" + }, + "DataPathOptions": { + "items": { + "$ref": "#/definitions/PivotTableDataPathOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableFieldSubtotalOptions": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "PivotTableFieldWells": { + "additionalProperties": false, + "properties": { + "PivotTableAggregatedFieldWells": { + "$ref": "#/definitions/PivotTableAggregatedFieldWells" + } + }, + "type": "object" + }, + "PivotTableMetricPlacement": { + "enum": [ + "ROW", + "COLUMN" + ], + "type": "string" + }, + "PivotTableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "CollapsedRowDimensionsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ColumnHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "ColumnNamesVisibility": { + "$ref": "#/definitions/Visibility" + }, + "DefaultCellWidth": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "MetricPlacement": { + "$ref": "#/definitions/PivotTableMetricPlacement" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + }, + "RowFieldNamesStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowHeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "RowsLabelOptions": { + "$ref": "#/definitions/PivotTableRowsLabelOptions" + }, + "RowsLayout": { + "$ref": "#/definitions/PivotTableRowsLayout" + }, + "SingleMetricVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ToggleButtonsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLabelOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "PivotTableRowsLayout": { + "enum": [ + "TABULAR", + "HIERARCHY" + ], + "type": "string" + }, + "PivotTableSortBy": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnSort" + }, + "DataPath": { + "$ref": "#/definitions/DataPathSort" + }, + "Field": { + "$ref": "#/definitions/FieldSort" + } + }, + "type": "object" + }, + "PivotTableSortConfiguration": { + "additionalProperties": false, + "properties": { + "FieldSortOptions": { + "items": { + "$ref": "#/definitions/PivotFieldSortOptions" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "PivotTableSubtotalLevel": { + "enum": [ + "ALL", + "CUSTOM", + "LAST" + ], + "type": "string" + }, + "PivotTableTotalOptions": { + "additionalProperties": false, + "properties": { + "ColumnSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "ColumnTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + }, + "RowSubtotalOptions": { + "$ref": "#/definitions/SubtotalOptions" + }, + "RowTotalOptions": { + "$ref": "#/definitions/PivotTotalOptions" + } + }, + "type": "object" + }, + "PivotTableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/PivotTableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/PivotTableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "PivotTotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "PredefinedHierarchy": { + "additionalProperties": false, + "properties": { + "Columns": { + "items": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "DrillDownFilters": { + "items": { + "$ref": "#/definitions/DrillDownFilter" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "HierarchyId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Columns", + "HierarchyId" + ], + "type": "object" + }, + "PrimaryValueDisplayType": { + "enum": [ + "HIDDEN", + "COMPARISON", + "ACTUAL" + ], + "type": "string" + }, + "ProgressBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "QueryExecutionMode": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "QueryExecutionOptions": { + "additionalProperties": false, + "properties": { + "QueryExecutionMode": { + "$ref": "#/definitions/QueryExecutionMode" + } + }, + "type": "object" + }, + "RadarChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Color": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartAreaStyleSettings": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "RadarChartAxesRangeScale": { + "enum": [ + "AUTO", + "INDEPENDENT", + "SHARED" + ], + "type": "string" + }, + "RadarChartConfiguration": { + "additionalProperties": false, + "properties": { + "AlternateBandColorsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "AlternateBandEvenColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AlternateBandOddColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AxesRangeScale": { + "$ref": "#/definitions/RadarChartAxesRangeScale" + }, + "BaseSeriesSettings": { + "$ref": "#/definitions/RadarChartSeriesSettings" + }, + "CategoryAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorAxis": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/RadarChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Shape": { + "$ref": "#/definitions/RadarChartShape" + }, + "SortConfiguration": { + "$ref": "#/definitions/RadarChartSortConfiguration" + }, + "StartAngle": { + "maximum": 360, + "minimum": -360, + "type": "number" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + } + }, + "type": "object" + }, + "RadarChartFieldWells": { + "additionalProperties": false, + "properties": { + "RadarChartAggregatedFieldWells": { + "$ref": "#/definitions/RadarChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "RadarChartSeriesSettings": { + "additionalProperties": false, + "properties": { + "AreaStyleSettings": { + "$ref": "#/definitions/RadarChartAreaStyleSettings" + } + }, + "type": "object" + }, + "RadarChartShape": { + "enum": [ + "CIRCLE", + "POLYGON" + ], + "type": "string" + }, + "RadarChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ColorItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "ColorSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "RadarChartVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/RadarChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "RangeEndsLabelType": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "ReferenceLine": { + "additionalProperties": false, + "properties": { + "DataConfiguration": { + "$ref": "#/definitions/ReferenceLineDataConfiguration" + }, + "LabelConfiguration": { + "$ref": "#/definitions/ReferenceLineLabelConfiguration" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "StyleConfiguration": { + "$ref": "#/definitions/ReferenceLineStyleConfiguration" + } + }, + "required": [ + "DataConfiguration" + ], + "type": "object" + }, + "ReferenceLineCustomLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "pattern": "\\S", + "type": "string" + } + }, + "required": [ + "CustomLabel" + ], + "type": "object" + }, + "ReferenceLineDataConfiguration": { + "additionalProperties": false, + "properties": { + "AxisBinding": { + "$ref": "#/definitions/AxisBinding" + }, + "DynamicConfiguration": { + "$ref": "#/definitions/ReferenceLineDynamicDataConfiguration" + }, + "SeriesType": { + "$ref": "#/definitions/ReferenceLineSeriesType" + }, + "StaticConfiguration": { + "$ref": "#/definitions/ReferenceLineStaticDataConfiguration" + } + }, + "type": "object" + }, + "ReferenceLineDynamicDataConfiguration": { + "additionalProperties": false, + "properties": { + "Calculation": { + "$ref": "#/definitions/NumericalAggregationFunction" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "MeasureAggregationFunction": { + "$ref": "#/definitions/AggregationFunction" + } + }, + "required": [ + "Calculation", + "Column" + ], + "type": "object" + }, + "ReferenceLineLabelConfiguration": { + "additionalProperties": false, + "properties": { + "CustomLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineCustomLabelConfiguration" + }, + "FontColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "HorizontalPosition": { + "$ref": "#/definitions/ReferenceLineLabelHorizontalPosition" + }, + "ValueLabelConfiguration": { + "$ref": "#/definitions/ReferenceLineValueLabelConfiguration" + }, + "VerticalPosition": { + "$ref": "#/definitions/ReferenceLineLabelVerticalPosition" + } + }, + "type": "object" + }, + "ReferenceLineLabelHorizontalPosition": { + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ], + "type": "string" + }, + "ReferenceLineLabelVerticalPosition": { + "enum": [ + "ABOVE", + "BELOW" + ], + "type": "string" + }, + "ReferenceLinePatternType": { + "enum": [ + "SOLID", + "DASHED", + "DOTTED" + ], + "type": "string" + }, + "ReferenceLineSeriesType": { + "enum": [ + "BAR", + "LINE" + ], + "type": "string" + }, + "ReferenceLineStaticDataConfiguration": { + "additionalProperties": false, + "properties": { + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "ReferenceLineStyleConfiguration": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Pattern": { + "$ref": "#/definitions/ReferenceLinePatternType" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelConfiguration": { + "additionalProperties": false, + "properties": { + "FormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + }, + "RelativePosition": { + "$ref": "#/definitions/ReferenceLineValueLabelRelativePosition" + } + }, + "type": "object" + }, + "ReferenceLineValueLabelRelativePosition": { + "enum": [ + "BEFORE_CUSTOM_LABEL", + "AFTER_CUSTOM_LABEL" + ], + "type": "string" + }, + "RelativeDateTimeControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "DateTimeFormat": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "RelativeDateType": { + "enum": [ + "PREVIOUS", + "THIS", + "LAST", + "NOW", + "NEXT" + ], + "type": "string" + }, + "RelativeDatesFilter": { + "additionalProperties": false, + "properties": { + "AnchorDateConfiguration": { + "$ref": "#/definitions/AnchorDateConfiguration" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MinimumGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RelativeDateType": { + "$ref": "#/definitions/RelativeDateType" + }, + "RelativeDateValue": { + "default": null, + "type": "number" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AnchorDateConfiguration", + "Column", + "FilterId", + "NullOption", + "RelativeDateType", + "TimeGranularity" + ], + "type": "object" + }, + "RelativeFontSize": { + "enum": [ + "EXTRA_SMALL", + "SMALL", + "MEDIUM", + "LARGE", + "EXTRA_LARGE" + ], + "type": "string" + }, + "ResizeOption": { + "enum": [ + "FIXED", + "RESPONSIVE" + ], + "type": "string" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "ResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETED" + ], + "type": "string" + }, + "RollingDateConfiguration": { + "additionalProperties": false, + "properties": { + "DataSetIdentifier": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "RowAlternateColorOptions": { + "additionalProperties": false, + "properties": { + "RowAlternateColors": { + "items": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "UsePrimaryBackgroundColor": { + "$ref": "#/definitions/WidgetStatus" + } + }, + "type": "object" + }, + "SameSheetTargetVisualConfiguration": { + "additionalProperties": false, + "properties": { + "TargetVisualOptions": { + "$ref": "#/definitions/TargetVisualOptions" + }, + "TargetVisuals": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Destination": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Source": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Weight": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramChartConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/SankeyDiagramFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/SankeyDiagramSortConfiguration" + } + }, + "type": "object" + }, + "SankeyDiagramFieldWells": { + "additionalProperties": false, + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "$ref": "#/definitions/SankeyDiagramAggregatedFieldWells" + } + }, + "type": "object" + }, + "SankeyDiagramSortConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "SourceItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "WeightSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "SankeyDiagramVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/SankeyDiagramChartConfiguration" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScatterPlotCategoricallyAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotConfiguration": { + "additionalProperties": false, + "properties": { + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/ScatterPlotFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "XAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "XAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "YAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "YAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + } + }, + "type": "object" + }, + "ScatterPlotFieldWells": { + "additionalProperties": false, + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotCategoricallyAggregatedFieldWells" + }, + "ScatterPlotUnaggregatedFieldWells": { + "$ref": "#/definitions/ScatterPlotUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "ScatterPlotUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Category": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Label": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "XAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "YAxis": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "ScatterPlotVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/ScatterPlotConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "ScrollBarOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "VisibleRange": { + "$ref": "#/definitions/VisibleRangeOptions" + } + }, + "type": "object" + }, + "SecondaryValueOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SectionAfterPageBreak": { + "additionalProperties": false, + "properties": { + "Status": { + "$ref": "#/definitions/SectionPageBreakStatus" + } + }, + "type": "object" + }, + "SectionBasedLayoutCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperCanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutPaperCanvasSizeOptions" + } + }, + "type": "object" + }, + "SectionBasedLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "BodySections": { + "items": { + "$ref": "#/definitions/BodySectionConfiguration" + }, + "maxItems": 28, + "minItems": 0, + "type": "array" + }, + "CanvasSizeOptions": { + "$ref": "#/definitions/SectionBasedLayoutCanvasSizeOptions" + }, + "FooterSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "HeaderSections": { + "items": { + "$ref": "#/definitions/HeaderFooterSectionConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "BodySections", + "CanvasSizeOptions", + "FooterSections", + "HeaderSections" + ], + "type": "object" + }, + "SectionBasedLayoutPaperCanvasSizeOptions": { + "additionalProperties": false, + "properties": { + "PaperMargin": { + "$ref": "#/definitions/Spacing" + }, + "PaperOrientation": { + "$ref": "#/definitions/PaperOrientation" + }, + "PaperSize": { + "$ref": "#/definitions/PaperSize" + } + }, + "type": "object" + }, + "SectionLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "FreeFormLayout": { + "$ref": "#/definitions/FreeFormSectionLayoutConfiguration" + } + }, + "required": [ + "FreeFormLayout" + ], + "type": "object" + }, + "SectionPageBreakConfiguration": { + "additionalProperties": false, + "properties": { + "After": { + "$ref": "#/definitions/SectionAfterPageBreak" + } + }, + "type": "object" + }, + "SectionPageBreakStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "SectionStyle": { + "additionalProperties": false, + "properties": { + "Height": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + }, + "Padding": { + "$ref": "#/definitions/Spacing" + } + }, + "type": "object" + }, + "SelectAllValueOptions": { + "enum": [ + "ALL_VALUES" + ], + "type": "string" + }, + "SelectedFieldOptions": { + "enum": [ + "ALL_FIELDS" + ], + "type": "string" + }, + "SelectedSheetsFilterScopeConfiguration": { + "additionalProperties": false, + "properties": { + "SheetVisualScopingConfigurations": { + "items": { + "$ref": "#/definitions/SheetVisualScopingConfiguration" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "SelectedTooltipType": { + "enum": [ + "BASIC", + "DETAILED" + ], + "type": "string" + }, + "SeriesItem": { + "additionalProperties": false, + "properties": { + "DataFieldSeriesItem": { + "$ref": "#/definitions/DataFieldSeriesItem" + }, + "FieldSeriesItem": { + "$ref": "#/definitions/FieldSeriesItem" + } + }, + "type": "object" + }, + "SetParameterValueConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DestinationParameterValueConfiguration" + } + }, + "required": [ + "DestinationParameterName", + "Value" + ], + "type": "object" + }, + "ShapeConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "required": [ + "BackgroundColor" + ], + "type": "object" + }, + "Sheet": { + "additionalProperties": false, + "description": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

", + "properties": { + "Name": { + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "SheetId": { + "description": "

The unique identifier associated with a sheet.

", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "type": "object" + }, + "SheetContentType": { + "enum": [ + "PAGINATED", + "INTERACTIVE" + ], + "type": "string" + }, + "SheetControlDateTimePickerType": { + "enum": [ + "SINGLE_VALUED", + "DATE_RANGE" + ], + "type": "string" + }, + "SheetControlInfoIconLabelOptions": { + "additionalProperties": false, + "properties": { + "InfoIconText": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetControlLayout": { + "additionalProperties": false, + "properties": { + "Configuration": { + "$ref": "#/definitions/SheetControlLayoutConfiguration" + } + }, + "required": [ + "Configuration" + ], + "type": "object" + }, + "SheetControlLayoutConfiguration": { + "additionalProperties": false, + "properties": { + "GridLayout": { + "$ref": "#/definitions/GridLayoutConfiguration" + } + }, + "type": "object" + }, + "SheetControlListType": { + "enum": [ + "MULTI_SELECT", + "SINGLE_SELECT" + ], + "type": "string" + }, + "SheetControlSliderType": { + "enum": [ + "SINGLE_POINT", + "RANGE" + ], + "type": "string" + }, + "SheetDefinition": { + "additionalProperties": false, + "properties": { + "ContentType": { + "$ref": "#/definitions/SheetContentType" + }, + "Description": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "FilterControls": { + "items": { + "$ref": "#/definitions/FilterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Layouts": { + "items": { + "$ref": "#/definitions/Layout" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ParameterControls": { + "items": { + "$ref": "#/definitions/ParameterControl" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "SheetControlLayouts": { + "items": { + "$ref": "#/definitions/SheetControlLayout" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "TextBoxes": { + "items": { + "$ref": "#/definitions/SheetTextBox" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Title": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Visuals": { + "items": { + "$ref": "#/definitions/Visual" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "SheetId" + ], + "type": "object" + }, + "SheetElementConfigurationOverrides": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "SheetElementRenderingRule": { + "additionalProperties": false, + "properties": { + "ConfigurationOverrides": { + "$ref": "#/definitions/SheetElementConfigurationOverrides" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ConfigurationOverrides", + "Expression" + ], + "type": "object" + }, + "SheetTextBox": { + "additionalProperties": false, + "properties": { + "Content": { + "maxLength": 150000, + "minLength": 0, + "type": "string" + }, + "SheetTextBoxId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "SheetTextBoxId" + ], + "type": "object" + }, + "SheetVisualScopingConfiguration": { + "additionalProperties": false, + "properties": { + "Scope": { + "$ref": "#/definitions/FilterVisualScope" + }, + "SheetId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "VisualIds": { + "items": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Scope", + "SheetId" + ], + "type": "object" + }, + "ShortFormatText": { + "additionalProperties": false, + "properties": { + "PlainText": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "RichText": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SimpleAttributeAggregationFunction": { + "enum": [ + "UNIQUE_VALUE" + ], + "type": "string" + }, + "SimpleClusterMarker": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "SimpleNumericalAggregationFunction": { + "enum": [ + "SUM", + "AVERAGE", + "MIN", + "MAX", + "COUNT", + "DISTINCT_COUNT", + "VAR", + "VARP", + "STDEV", + "STDEVP", + "MEDIAN" + ], + "type": "string" + }, + "SimpleTotalAggregationFunction": { + "enum": [ + "DEFAULT", + "SUM", + "AVERAGE", + "MIN", + "MAX", + "NONE" + ], + "type": "string" + }, + "SingleAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxisOptions": { + "$ref": "#/definitions/YAxisOptions" + } + }, + "type": "object" + }, + "SingleYAxisOption": { + "enum": [ + "PRIMARY_Y_AXIS" + ], + "type": "string" + }, + "SliderControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "SmallMultiplesAxisPlacement": { + "enum": [ + "OUTSIDE", + "INSIDE" + ], + "type": "string" + }, + "SmallMultiplesAxisProperties": { + "additionalProperties": false, + "properties": { + "Placement": { + "$ref": "#/definitions/SmallMultiplesAxisPlacement" + }, + "Scale": { + "$ref": "#/definitions/SmallMultiplesAxisScale" + } + }, + "type": "object" + }, + "SmallMultiplesAxisScale": { + "enum": [ + "SHARED", + "INDEPENDENT" + ], + "type": "string" + }, + "SmallMultiplesOptions": { + "additionalProperties": false, + "properties": { + "MaxVisibleColumns": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "MaxVisibleRows": { + "maximum": 10, + "minimum": 1, + "type": "number" + }, + "PanelConfiguration": { + "$ref": "#/definitions/PanelConfiguration" + }, + "XAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + }, + "YAxis": { + "$ref": "#/definitions/SmallMultiplesAxisProperties" + } + }, + "type": "object" + }, + "SortDirection": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "Spacing": { + "additionalProperties": false, + "properties": { + "Bottom": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Left": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Right": { + "description": "String based length that is composed of value and unit", + "type": "string" + }, + "Top": { + "description": "String based length that is composed of value and unit", + "type": "string" + } + }, + "type": "object" + }, + "SpecialValue": { + "enum": [ + "EMPTY", + "NULL", + "OTHER" + ], + "type": "string" + }, + "StringDefaultValues": { + "additionalProperties": false, + "properties": { + "DynamicValue": { + "$ref": "#/definitions/DynamicDefaultValue" + }, + "StaticValues": { + "items": { + "type": "string" + }, + "maxItems": 50000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "StringFormatConfiguration": { + "additionalProperties": false, + "properties": { + "NullValueFormatConfiguration": { + "$ref": "#/definitions/NullValueFormatConfiguration" + }, + "NumericFormatConfiguration": { + "$ref": "#/definitions/NumericFormatConfiguration" + } + }, + "type": "object" + }, + "StringParameterDeclaration": { + "additionalProperties": false, + "properties": { + "DefaultValues": { + "$ref": "#/definitions/StringDefaultValues" + }, + "MappedDataSetParameters": { + "items": { + "$ref": "#/definitions/MappedDataSetParameter" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ParameterValueType": { + "$ref": "#/definitions/ParameterValueType" + }, + "ValueWhenUnset": { + "$ref": "#/definitions/StringValueWhenUnsetConfiguration" + } + }, + "required": [ + "Name", + "ParameterValueType" + ], + "type": "object" + }, + "StringValueWhenUnsetConfiguration": { + "additionalProperties": false, + "properties": { + "CustomValue": { + "type": "string" + }, + "ValueWhenUnsetOption": { + "$ref": "#/definitions/ValueWhenUnsetOption" + } + }, + "type": "object" + }, + "StyledCellType": { + "enum": [ + "TOTAL", + "METRIC_HEADER", + "VALUE" + ], + "type": "string" + }, + "SubtotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "FieldLevel": { + "$ref": "#/definitions/PivotTableSubtotalLevel" + }, + "FieldLevelOptions": { + "items": { + "$ref": "#/definitions/PivotTableFieldSubtotalOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "MetricHeaderCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "StyleTargets": { + "items": { + "$ref": "#/definitions/TableStyleTarget" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + }, + "ValueCellStyle": { + "$ref": "#/definitions/TableCellStyle" + } + }, + "type": "object" + }, + "TableAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableBorderOptions": { + "additionalProperties": false, + "properties": { + "Color": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Style": { + "$ref": "#/definitions/TableBorderStyle" + }, + "Thickness": { + "maximum": 4, + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "TableBorderStyle": { + "enum": [ + "NONE", + "SOLID" + ], + "type": "string" + }, + "TableCellConditionalFormatting": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TextFormat": { + "$ref": "#/definitions/TextConditionalFormat" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableCellImageScalingConfiguration": { + "enum": [ + "FIT_TO_CELL_HEIGHT", + "FIT_TO_CELL_WIDTH", + "DO_NOT_SCALE" + ], + "type": "string" + }, + "TableCellImageSizingConfiguration": { + "additionalProperties": false, + "properties": { + "TableCellImageScalingConfiguration": { + "$ref": "#/definitions/TableCellImageScalingConfiguration" + } + }, + "type": "object" + }, + "TableCellStyle": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Border": { + "$ref": "#/definitions/GlobalTableBorderOptions" + }, + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Height": { + "maximum": 500, + "minimum": 8, + "type": "number" + }, + "HorizontalTextAlignment": { + "$ref": "#/definitions/HorizontalTextAlignment" + }, + "TextWrap": { + "$ref": "#/definitions/TextWrap" + }, + "VerticalTextAlignment": { + "$ref": "#/definitions/VerticalTextAlignment" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TableConditionalFormatting": { + "additionalProperties": false, + "properties": { + "ConditionalFormattingOptions": { + "items": { + "$ref": "#/definitions/TableConditionalFormattingOption" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableConditionalFormattingOption": { + "additionalProperties": false, + "properties": { + "Cell": { + "$ref": "#/definitions/TableCellConditionalFormatting" + }, + "Row": { + "$ref": "#/definitions/TableRowConditionalFormatting" + } + }, + "type": "object" + }, + "TableConfiguration": { + "additionalProperties": false, + "properties": { + "FieldOptions": { + "$ref": "#/definitions/TableFieldOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TableFieldWells" + }, + "PaginatedReportOptions": { + "$ref": "#/definitions/TablePaginatedReportOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TableSortConfiguration" + }, + "TableInlineVisualizations": { + "items": { + "$ref": "#/definitions/TableInlineVisualization" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TableOptions": { + "$ref": "#/definitions/TableOptions" + }, + "TotalOptions": { + "$ref": "#/definitions/TotalOptions" + } + }, + "type": "object" + }, + "TableFieldCustomIconContent": { + "additionalProperties": false, + "properties": { + "Icon": { + "$ref": "#/definitions/TableFieldIconSetType" + } + }, + "type": "object" + }, + "TableFieldCustomTextContent": { + "additionalProperties": false, + "properties": { + "FontConfiguration": { + "$ref": "#/definitions/FontConfiguration" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "FontConfiguration" + ], + "type": "object" + }, + "TableFieldIconSetType": { + "enum": [ + "LINK" + ], + "type": "string" + }, + "TableFieldImageConfiguration": { + "additionalProperties": false, + "properties": { + "SizingOptions": { + "$ref": "#/definitions/TableCellImageSizingConfiguration" + } + }, + "type": "object" + }, + "TableFieldLinkConfiguration": { + "additionalProperties": false, + "properties": { + "Content": { + "$ref": "#/definitions/TableFieldLinkContentConfiguration" + }, + "Target": { + "$ref": "#/definitions/URLTargetConfiguration" + } + }, + "required": [ + "Content", + "Target" + ], + "type": "object" + }, + "TableFieldLinkContentConfiguration": { + "additionalProperties": false, + "properties": { + "CustomIconContent": { + "$ref": "#/definitions/TableFieldCustomIconContent" + }, + "CustomTextContent": { + "$ref": "#/definitions/TableFieldCustomTextContent" + } + }, + "type": "object" + }, + "TableFieldOption": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "URLStyling": { + "$ref": "#/definitions/TableFieldURLConfiguration" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + }, + "Width": { + "description": "String based length that is composed of value and unit in px", + "type": "string" + } + }, + "required": [ + "FieldId" + ], + "type": "object" + }, + "TableFieldOptions": { + "additionalProperties": false, + "properties": { + "Order": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "PinnedFieldOptions": { + "$ref": "#/definitions/TablePinnedFieldOptions" + }, + "SelectedFieldOptions": { + "items": { + "$ref": "#/definitions/TableFieldOption" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableFieldURLConfiguration": { + "additionalProperties": false, + "properties": { + "ImageConfiguration": { + "$ref": "#/definitions/TableFieldImageConfiguration" + }, + "LinkConfiguration": { + "$ref": "#/definitions/TableFieldLinkConfiguration" + } + }, + "type": "object" + }, + "TableFieldWells": { + "additionalProperties": false, + "properties": { + "TableAggregatedFieldWells": { + "$ref": "#/definitions/TableAggregatedFieldWells" + }, + "TableUnaggregatedFieldWells": { + "$ref": "#/definitions/TableUnaggregatedFieldWells" + } + }, + "type": "object" + }, + "TableInlineVisualization": { + "additionalProperties": false, + "properties": { + "DataBars": { + "$ref": "#/definitions/DataBarsOptions" + } + }, + "type": "object" + }, + "TableOptions": { + "additionalProperties": false, + "properties": { + "CellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "HeaderStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "Orientation": { + "$ref": "#/definitions/TableOrientation" + }, + "RowAlternateColorOptions": { + "$ref": "#/definitions/RowAlternateColorOptions" + } + }, + "type": "object" + }, + "TableOrientation": { + "enum": [ + "VERTICAL", + "HORIZONTAL" + ], + "type": "string" + }, + "TablePaginatedReportOptions": { + "additionalProperties": false, + "properties": { + "OverflowColumnHeaderVisibility": { + "$ref": "#/definitions/Visibility" + }, + "VerticalOverflowVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TablePinnedFieldOptions": { + "additionalProperties": false, + "properties": { + "PinnedLeftFields": { + "items": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "maxItems": 201, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableRowConditionalFormatting": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TableSideBorderOptions": { + "additionalProperties": false, + "properties": { + "Bottom": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerHorizontal": { + "$ref": "#/definitions/TableBorderOptions" + }, + "InnerVertical": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Left": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Right": { + "$ref": "#/definitions/TableBorderOptions" + }, + "Top": { + "$ref": "#/definitions/TableBorderOptions" + } + }, + "type": "object" + }, + "TableSortConfiguration": { + "additionalProperties": false, + "properties": { + "PaginationConfiguration": { + "$ref": "#/definitions/PaginationConfiguration" + }, + "RowSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableStyleTarget": { + "additionalProperties": false, + "properties": { + "CellType": { + "$ref": "#/definitions/StyledCellType" + } + }, + "required": [ + "CellType" + ], + "type": "object" + }, + "TableTotalsPlacement": { + "enum": [ + "START", + "END", + "AUTO" + ], + "type": "string" + }, + "TableTotalsScrollStatus": { + "enum": [ + "PINNED", + "SCROLLED" + ], + "type": "string" + }, + "TableUnaggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Values": { + "items": { + "$ref": "#/definitions/UnaggregatedField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TableVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TableConfiguration" + }, + "ConditionalFormatting": { + "$ref": "#/definitions/TableConditionalFormatting" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TargetVisualOptions": { + "enum": [ + "ALL_VISUALS" + ], + "type": "string" + }, + "TemplateError": { + "additionalProperties": false, + "description": "

List of errors that occurred when the template version creation failed.

", + "properties": { + "Message": { + "description": "

Description of the error type.

", + "pattern": "\\S", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/TemplateErrorType" + }, + "ViolatedEntities": { + "description": "

An error path that shows which entities caused the template error.

", + "items": { + "$ref": "#/definitions/Entity" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TemplateErrorType": { + "enum": [ + "SOURCE_NOT_FOUND", + "DATA_SET_NOT_FOUND", + "INTERNAL_FAILURE", + "ACCESS_DENIED" + ], + "type": "string" + }, + "TemplateSourceAnalysis": { + "additionalProperties": false, + "description": "

The source analysis of the template.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "DataSetReferences": { + "description": "

A structure containing information about the dataset references used as placeholders\n in the template.

", + "items": { + "$ref": "#/definitions/DataSetReference" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Arn", + "DataSetReferences" + ], + "type": "object" + }, + "TemplateSourceEntity": { + "additionalProperties": false, + "description": "

The source entity of the template.

", + "properties": { + "SourceAnalysis": { + "$ref": "#/definitions/TemplateSourceAnalysis" + }, + "SourceTemplate": { + "$ref": "#/definitions/TemplateSourceTemplate" + } + }, + "type": "object" + }, + "TemplateSourceTemplate": { + "additionalProperties": false, + "description": "

The source template of the template.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "TemplateVersion": { + "additionalProperties": false, + "description": "

A version of a template.

", + "properties": { + "CreatedTime": { + "description": "

The time that this template version was created.

", + "format": "date-time", + "type": "string" + }, + "DataSetConfigurations": { + "description": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

", + "items": { + "$ref": "#/definitions/DataSetConfiguration" + }, + "maxItems": 30, + "minItems": 0, + "type": "array" + }, + "Description": { + "description": "

The description of the template.

", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Errors": { + "description": "

Errors associated with this template version.

", + "items": { + "$ref": "#/definitions/TemplateError" + }, + "minItems": 1, + "type": "array" + }, + "Sheets": { + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

", + "items": { + "$ref": "#/definitions/Sheet" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "SourceEntityArn": { + "description": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ResourceStatus" + }, + "ThemeArn": { + "description": "

The ARN of the theme associated with this version of the template.

", + "type": "string" + }, + "VersionNumber": { + "description": "

The version number of the template version.

", + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "TemplateVersionDefinition": { + "additionalProperties": false, + "properties": { + "AnalysisDefaults": { + "$ref": "#/definitions/AnalysisDefaults" + }, + "CalculatedFields": { + "items": { + "$ref": "#/definitions/CalculatedField" + }, + "maxItems": 500, + "minItems": 0, + "type": "array" + }, + "ColumnConfigurations": { + "items": { + "$ref": "#/definitions/ColumnConfiguration" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "DataSetConfigurations": { + "items": { + "$ref": "#/definitions/DataSetConfiguration" + }, + "maxItems": 30, + "minItems": 0, + "type": "array" + }, + "FilterGroups": { + "items": { + "$ref": "#/definitions/FilterGroup" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array" + }, + "Options": { + "$ref": "#/definitions/AssetOptions" + }, + "ParameterDeclarations": { + "items": { + "$ref": "#/definitions/ParameterDeclaration" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "QueryExecutionOptions": { + "$ref": "#/definitions/QueryExecutionOptions" + }, + "Sheets": { + "items": { + "$ref": "#/definitions/SheetDefinition" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "DataSetConfigurations" + ], + "type": "object" + }, + "TextAreaControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextConditionalFormat": { + "additionalProperties": false, + "properties": { + "BackgroundColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + }, + "Icon": { + "$ref": "#/definitions/ConditionalFormattingIcon" + }, + "TextColor": { + "$ref": "#/definitions/ConditionalFormattingColor" + } + }, + "type": "object" + }, + "TextControlPlaceholderOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TextFieldControlDisplayOptions": { + "additionalProperties": false, + "properties": { + "InfoIconLabelOptions": { + "$ref": "#/definitions/SheetControlInfoIconLabelOptions" + }, + "PlaceholderOptions": { + "$ref": "#/definitions/TextControlPlaceholderOptions" + }, + "TitleOptions": { + "$ref": "#/definitions/LabelOptions" + } + }, + "type": "object" + }, + "TextWrap": { + "enum": [ + "NONE", + "WRAP" + ], + "type": "string" + }, + "ThousandSeparatorOptions": { + "additionalProperties": false, + "properties": { + "Symbol": { + "$ref": "#/definitions/NumericSeparatorSymbol" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TimeBasedForecastProperties": { + "additionalProperties": false, + "properties": { + "LowerBoundary": { + "default": null, + "type": "number" + }, + "PeriodsBackward": { + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "PeriodsForward": { + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "PredictionInterval": { + "maximum": 95, + "minimum": 50, + "type": "number" + }, + "Seasonality": { + "maximum": 180, + "minimum": 1, + "type": "number" + }, + "UpperBoundary": { + "default": null, + "type": "number" + } + }, + "type": "object" + }, + "TimeEqualityFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + }, + "Value": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "Column", + "FilterId" + ], + "type": "object" + }, + "TimeGranularity": { + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND", + "MILLISECOND" + ], + "type": "string" + }, + "TimeRangeDrillDownFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "RangeMaximum": { + "format": "date-time", + "type": "string" + }, + "RangeMinimum": { + "format": "date-time", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "RangeMaximum", + "RangeMinimum", + "TimeGranularity" + ], + "type": "object" + }, + "TimeRangeFilter": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "ExcludePeriodConfiguration": { + "$ref": "#/definitions/ExcludePeriodConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "IncludeMaximum": { + "default": null, + "type": "boolean" + }, + "IncludeMinimum": { + "default": null, + "type": "boolean" + }, + "NullOption": { + "$ref": "#/definitions/FilterNullOption" + }, + "RangeMaximumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "RangeMinimumValue": { + "$ref": "#/definitions/TimeRangeFilterValue" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "Column", + "FilterId", + "NullOption" + ], + "type": "object" + }, + "TimeRangeFilterValue": { + "additionalProperties": false, + "properties": { + "Parameter": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "RollingDate": { + "$ref": "#/definitions/RollingDateConfiguration" + }, + "StaticValue": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "TooltipItem": { + "additionalProperties": false, + "properties": { + "ColumnTooltipItem": { + "$ref": "#/definitions/ColumnTooltipItem" + }, + "FieldTooltipItem": { + "$ref": "#/definitions/FieldTooltipItem" + } + }, + "type": "object" + }, + "TooltipOptions": { + "additionalProperties": false, + "properties": { + "FieldBasedTooltip": { + "$ref": "#/definitions/FieldBasedTooltip" + }, + "SelectedTooltipType": { + "$ref": "#/definitions/SelectedTooltipType" + }, + "TooltipVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TooltipTarget": { + "enum": [ + "BOTH", + "BAR", + "LINE" + ], + "type": "string" + }, + "TooltipTitleType": { + "enum": [ + "NONE", + "PRIMARY_VALUE" + ], + "type": "string" + }, + "TopBottomComputationType": { + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "TopBottomFilter": { + "additionalProperties": false, + "properties": { + "AggregationSortConfigurations": { + "items": { + "$ref": "#/definitions/AggregationSortConfiguration" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, + "FilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Limit": { + "default": null, + "type": "number" + }, + "ParameterName": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "TimeGranularity": { + "$ref": "#/definitions/TimeGranularity" + } + }, + "required": [ + "AggregationSortConfigurations", + "Column", + "FilterId" + ], + "type": "object" + }, + "TopBottomMoversComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "MoverSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Name": { + "type": "string" + }, + "SortOrder": { + "$ref": "#/definitions/TopBottomSortOrder" + }, + "Time": { + "$ref": "#/definitions/DimensionField" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomRankedComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResultSize": { + "default": 0, + "maximum": 20, + "minimum": 1, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/TopBottomComputationType" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId", + "Type" + ], + "type": "object" + }, + "TopBottomSortOrder": { + "enum": [ + "PERCENT_DIFFERENCE", + "ABSOLUTE_DIFFERENCE" + ], + "type": "string" + }, + "TotalAggregationComputation": { + "additionalProperties": false, + "properties": { + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Value": { + "$ref": "#/definitions/MeasureField" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "TotalAggregationFunction": { + "additionalProperties": false, + "properties": { + "SimpleTotalAggregationFunction": { + "$ref": "#/definitions/SimpleTotalAggregationFunction" + } + }, + "type": "object" + }, + "TotalAggregationOption": { + "additionalProperties": false, + "properties": { + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TotalAggregationFunction": { + "$ref": "#/definitions/TotalAggregationFunction" + } + }, + "required": [ + "FieldId", + "TotalAggregationFunction" + ], + "type": "object" + }, + "TotalOptions": { + "additionalProperties": false, + "properties": { + "CustomLabel": { + "type": "string" + }, + "Placement": { + "$ref": "#/definitions/TableTotalsPlacement" + }, + "ScrollStatus": { + "$ref": "#/definitions/TableTotalsScrollStatus" + }, + "TotalAggregationOptions": { + "items": { + "$ref": "#/definitions/TotalAggregationOption" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TotalCellStyle": { + "$ref": "#/definitions/TableCellStyle" + }, + "TotalsVisibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "TreeMapAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Colors": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Groups": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Sizes": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapConfiguration": { + "additionalProperties": false, + "properties": { + "ColorLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorScale": { + "$ref": "#/definitions/ColorScale" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/TreeMapFieldWells" + }, + "GroupLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "SizeLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/TreeMapSortConfiguration" + }, + "Tooltip": { + "$ref": "#/definitions/TooltipOptions" + } + }, + "type": "object" + }, + "TreeMapFieldWells": { + "additionalProperties": false, + "properties": { + "TreeMapAggregatedFieldWells": { + "$ref": "#/definitions/TreeMapAggregatedFieldWells" + } + }, + "type": "object" + }, + "TreeMapSortConfiguration": { + "additionalProperties": false, + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "TreeMapSort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "TreeMapVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/TreeMapConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "TrendArrowOptions": { + "additionalProperties": false, + "properties": { + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "URLTargetConfiguration": { + "enum": [ + "NEW_TAB", + "NEW_WINDOW", + "SAME_TAB" + ], + "type": "string" + }, + "UnaggregatedField": { + "additionalProperties": false, + "properties": { + "Column": { + "$ref": "#/definitions/ColumnIdentifier" + }, + "FieldId": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "FormatConfiguration": { + "$ref": "#/definitions/FormatConfiguration" + } + }, + "required": [ + "Column", + "FieldId" + ], + "type": "object" + }, + "UniqueValuesComputation": { + "additionalProperties": false, + "properties": { + "Category": { + "$ref": "#/definitions/DimensionField" + }, + "ComputationId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "ComputationId" + ], + "type": "object" + }, + "ValidationStrategy": { + "additionalProperties": false, + "description": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

", + "properties": { + "Mode": { + "$ref": "#/definitions/ValidationStrategyMode" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "ValidationStrategyMode": { + "enum": [ + "STRICT", + "LENIENT" + ], + "type": "string" + }, + "ValueWhenUnsetOption": { + "enum": [ + "RECOMMENDED_VALUE", + "NULL" + ], + "type": "string" + }, + "VerticalTextAlignment": { + "enum": [ + "TOP", + "MIDDLE", + "BOTTOM", + "AUTO" + ], + "type": "string" + }, + "Visibility": { + "enum": [ + "HIDDEN", + "VISIBLE" + ], + "type": "string" + }, + "VisibleRangeOptions": { + "additionalProperties": false, + "properties": { + "PercentRange": { + "$ref": "#/definitions/PercentVisibleRange" + } + }, + "type": "object" + }, + "Visual": { + "additionalProperties": false, + "properties": { + "BarChartVisual": { + "$ref": "#/definitions/BarChartVisual" + }, + "BoxPlotVisual": { + "$ref": "#/definitions/BoxPlotVisual" + }, + "ComboChartVisual": { + "$ref": "#/definitions/ComboChartVisual" + }, + "CustomContentVisual": { + "$ref": "#/definitions/CustomContentVisual" + }, + "EmptyVisual": { + "$ref": "#/definitions/EmptyVisual" + }, + "FilledMapVisual": { + "$ref": "#/definitions/FilledMapVisual" + }, + "FunnelChartVisual": { + "$ref": "#/definitions/FunnelChartVisual" + }, + "GaugeChartVisual": { + "$ref": "#/definitions/GaugeChartVisual" + }, + "GeospatialMapVisual": { + "$ref": "#/definitions/GeospatialMapVisual" + }, + "HeatMapVisual": { + "$ref": "#/definitions/HeatMapVisual" + }, + "HistogramVisual": { + "$ref": "#/definitions/HistogramVisual" + }, + "InsightVisual": { + "$ref": "#/definitions/InsightVisual" + }, + "KPIVisual": { + "$ref": "#/definitions/KPIVisual" + }, + "LineChartVisual": { + "$ref": "#/definitions/LineChartVisual" + }, + "PieChartVisual": { + "$ref": "#/definitions/PieChartVisual" + }, + "PivotTableVisual": { + "$ref": "#/definitions/PivotTableVisual" + }, + "RadarChartVisual": { + "$ref": "#/definitions/RadarChartVisual" + }, + "SankeyDiagramVisual": { + "$ref": "#/definitions/SankeyDiagramVisual" + }, + "ScatterPlotVisual": { + "$ref": "#/definitions/ScatterPlotVisual" + }, + "TableVisual": { + "$ref": "#/definitions/TableVisual" + }, + "TreeMapVisual": { + "$ref": "#/definitions/TreeMapVisual" + }, + "WaterfallVisual": { + "$ref": "#/definitions/WaterfallVisual" + }, + "WordCloudVisual": { + "$ref": "#/definitions/WordCloudVisual" + } + }, + "type": "object" + }, + "VisualCustomAction": { + "additionalProperties": false, + "properties": { + "ActionOperations": { + "items": { + "$ref": "#/definitions/VisualCustomActionOperation" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "CustomActionId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/WidgetStatus" + }, + "Trigger": { + "$ref": "#/definitions/VisualCustomActionTrigger" + } + }, + "required": [ + "ActionOperations", + "CustomActionId", + "Name", + "Trigger" + ], + "type": "object" + }, + "VisualCustomActionOperation": { + "additionalProperties": false, + "properties": { + "FilterOperation": { + "$ref": "#/definitions/CustomActionFilterOperation" + }, + "NavigationOperation": { + "$ref": "#/definitions/CustomActionNavigationOperation" + }, + "SetParametersOperation": { + "$ref": "#/definitions/CustomActionSetParametersOperation" + }, + "URLOperation": { + "$ref": "#/definitions/CustomActionURLOperation" + } + }, + "type": "object" + }, + "VisualCustomActionTrigger": { + "enum": [ + "DATA_POINT_CLICK", + "DATA_POINT_MENU" + ], + "type": "string" + }, + "VisualPalette": { + "additionalProperties": false, + "properties": { + "ChartColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "ColorMap": { + "items": { + "$ref": "#/definitions/DataPathColor" + }, + "maxItems": 5000, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "VisualSubtitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/LongFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "VisualTitleLabelOptions": { + "additionalProperties": false, + "properties": { + "FormatText": { + "$ref": "#/definitions/ShortFormatText" + }, + "Visibility": { + "$ref": "#/definitions/Visibility" + } + }, + "type": "object" + }, + "WaterfallChartAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "Breakdowns": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Categories": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Values": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, + "WaterfallChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "CategoryAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, + "DataLabels": { + "$ref": "#/definitions/DataLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WaterfallChartFieldWells" + }, + "Legend": { + "$ref": "#/definitions/LegendOptions" + }, + "PrimaryYAxisDisplayOptions": { + "$ref": "#/definitions/AxisDisplayOptions" + }, + "PrimaryYAxisLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "SortConfiguration": { + "$ref": "#/definitions/WaterfallChartSortConfiguration" + }, + "VisualPalette": { + "$ref": "#/definitions/VisualPalette" + }, + "WaterfallChartOptions": { + "$ref": "#/definitions/WaterfallChartOptions" + } + }, + "type": "object" + }, + "WaterfallChartFieldWells": { + "additionalProperties": false, + "properties": { + "WaterfallChartAggregatedFieldWells": { + "$ref": "#/definitions/WaterfallChartAggregatedFieldWells" + } + }, + "type": "object" + }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartOptions": { + "additionalProperties": false, + "properties": { + "TotalBarLabel": { + "type": "string" + } + }, + "type": "object" + }, + "WaterfallChartSortConfiguration": { + "additionalProperties": false, + "properties": { + "BreakdownItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WaterfallVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WaterfallChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WhatIfPointScenario": { + "additionalProperties": false, + "properties": { + "Date": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "Date", + "Value" + ], + "type": "object" + }, + "WhatIfRangeScenario": { + "additionalProperties": false, + "properties": { + "EndDate": { + "format": "date-time", + "type": "string" + }, + "StartDate": { + "format": "date-time", + "type": "string" + }, + "Value": { + "default": 0, + "type": "number" + } + }, + "required": [ + "EndDate", + "StartDate", + "Value" + ], + "type": "object" + }, + "WidgetStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "WordCloudAggregatedFieldWells": { + "additionalProperties": false, + "properties": { + "GroupBy": { + "items": { + "$ref": "#/definitions/DimensionField" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Size": { + "items": { + "$ref": "#/definitions/MeasureField" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudChartConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryLabelOptions": { + "$ref": "#/definitions/ChartAxisLabelOptions" + }, + "FieldWells": { + "$ref": "#/definitions/WordCloudFieldWells" + }, + "SortConfiguration": { + "$ref": "#/definitions/WordCloudSortConfiguration" + }, + "WordCloudOptions": { + "$ref": "#/definitions/WordCloudOptions" + } + }, + "type": "object" + }, + "WordCloudCloudLayout": { + "enum": [ + "FLUID", + "NORMAL" + ], + "type": "string" + }, + "WordCloudFieldWells": { + "additionalProperties": false, + "properties": { + "WordCloudAggregatedFieldWells": { + "$ref": "#/definitions/WordCloudAggregatedFieldWells" + } + }, + "type": "object" + }, + "WordCloudOptions": { + "additionalProperties": false, + "properties": { + "CloudLayout": { + "$ref": "#/definitions/WordCloudCloudLayout" + }, + "MaximumStringLength": { + "maximum": 100, + "minimum": 1, + "type": "number" + }, + "WordCasing": { + "$ref": "#/definitions/WordCloudWordCasing" + }, + "WordOrientation": { + "$ref": "#/definitions/WordCloudWordOrientation" + }, + "WordPadding": { + "$ref": "#/definitions/WordCloudWordPadding" + }, + "WordScaling": { + "$ref": "#/definitions/WordCloudWordScaling" + } + }, + "type": "object" + }, + "WordCloudSortConfiguration": { + "additionalProperties": false, + "properties": { + "CategoryItemsLimit": { + "$ref": "#/definitions/ItemsLimitConfiguration" + }, + "CategorySort": { + "items": { + "$ref": "#/definitions/FieldSortOptions" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "WordCloudVisual": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/VisualCustomAction" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "ChartConfiguration": { + "$ref": "#/definitions/WordCloudChartConfiguration" + }, + "ColumnHierarchies": { + "items": { + "$ref": "#/definitions/ColumnHierarchy" + }, + "maxItems": 2, + "minItems": 0, + "type": "array" + }, + "Subtitle": { + "$ref": "#/definitions/VisualSubtitleLabelOptions" + }, + "Title": { + "$ref": "#/definitions/VisualTitleLabelOptions" + }, + "VisualId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "VisualId" + ], + "type": "object" + }, + "WordCloudWordCasing": { + "enum": [ + "LOWER_CASE", + "EXISTING_CASE" + ], + "type": "string" + }, + "WordCloudWordOrientation": { + "enum": [ + "HORIZONTAL", + "HORIZONTAL_AND_VERTICAL" + ], + "type": "string" + }, + "WordCloudWordPadding": { + "enum": [ + "NONE", + "SMALL", + "MEDIUM", + "LARGE" + ], + "type": "string" + }, + "WordCloudWordScaling": { + "enum": [ + "EMPHASIZE", + "NORMAL" + ], + "type": "string" + }, + "YAxisOptions": { + "additionalProperties": false, + "properties": { + "YAxis": { + "$ref": "#/definitions/SingleYAxisOption" + } + }, + "required": [ + "YAxis" + ], + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::Template Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:DescribeTemplate", + "quicksight:DescribeTemplatePermissions", + "quicksight:CreateTemplate", + "quicksight:DescribeAnalysis", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeTemplate", + "quicksight:DeleteTemplate" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + } + }, + "required": [ + "AwsAccountId" + ] + }, + "permissions": [ + "quicksight:ListTemplates" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeTemplate", + "quicksight:DescribeTemplatePermissions", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeTemplate", + "quicksight:DescribeTemplatePermissions", + "quicksight:UpdateTemplate", + "quicksight:UpdateTemplatePermissions", + "quicksight:PassDataSet", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/TemplateId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the template.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "CreatedTime": { + "description": "

Time when this was created.

", + "format": "date-time", + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/TemplateVersionDefinition" + }, + "LastUpdatedTime": { + "description": "

Time when this was last updated.

", + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "SourceEntity": { + "$ref": "#/definitions/TemplateSourceEntity" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "TemplateId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ValidationStrategy": { + "$ref": "#/definitions/ValidationStrategy" + }, + "Version": { + "$ref": "#/definitions/TemplateVersion" + }, + "VersionDescription": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/Version" + ], + "required": [ + "AwsAccountId", + "TemplateId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "typeName": "AWS::QuickSight::Template", + "writeOnlyProperties": [ + "/properties/Definition", + "/properties/VersionDescription", + "/properties/SourceEntity", + "/properties/ValidationStrategy" + ] +} diff --git a/schema/aws-quicksight-theme.json b/schema/aws-quicksight-theme.json index 2df8683..69bfdc6 100644 --- a/schema/aws-quicksight-theme.json +++ b/schema/aws-quicksight-theme.json @@ -1,526 +1,526 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/ThemeId" - ], - "definitions": { - "BorderStyle": { - "additionalProperties": false, - "description": "

The display options for tile borders for visuals.

", - "properties": { - "Show": { - "default": null, - "description": "

The option to enable display of borders for visuals.

", - "type": "boolean" - } - }, - "type": "object" - }, - "DataColorPalette": { - "additionalProperties": false, - "description": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

", - "properties": { - "Colors": { - "description": "

The hexadecimal codes for the colors.

", - "items": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "EmptyFillColor": { - "description": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "MinMaxGradient": { - "description": "

The minimum and maximum hexadecimal codes that describe a color gradient.

", - "items": { - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "Font": { - "additionalProperties": false, - "properties": { - "FontFamily": { - "type": "string" - } - }, - "type": "object" - }, - "GutterStyle": { - "additionalProperties": false, - "description": "

The display options for gutter spacing between tiles on a sheet.

", - "properties": { - "Show": { - "default": null, - "description": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

", - "type": "boolean" - } - }, - "type": "object" - }, - "MarginStyle": { - "additionalProperties": false, - "description": "

The display options for margins around the outside edge of sheets.

", - "properties": { - "Show": { - "default": null, - "description": "

This Boolean value controls whether to display sheet margins.

", - "type": "boolean" - } - }, - "type": "object" - }, - "ResourcePermission": { - "additionalProperties": false, - "description": "

Permission for the resource.

", - "properties": { - "Actions": { - "description": "

The IAM action to grant or revoke permissions on.

", - "items": { - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "Principal": { - "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "ResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETED" - ], - "type": "string" - }, - "SheetStyle": { - "additionalProperties": false, - "description": "

The theme display options for sheets.

", - "properties": { - "Tile": { - "$ref": "#/definitions/TileStyle" - }, - "TileLayout": { - "$ref": "#/definitions/TileLayoutStyle" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "ThemeConfiguration": { - "additionalProperties": false, - "description": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

", - "properties": { - "DataColorPalette": { - "$ref": "#/definitions/DataColorPalette" - }, - "Sheet": { - "$ref": "#/definitions/SheetStyle" - }, - "Typography": { - "$ref": "#/definitions/Typography" - }, - "UIColorPalette": { - "$ref": "#/definitions/UIColorPalette" - } - }, - "type": "object" - }, - "ThemeError": { - "additionalProperties": false, - "description": "

Theme error.

", - "properties": { - "Message": { - "description": "

The error message.

", - "pattern": "\\S", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/ThemeErrorType" - } - }, - "type": "object" - }, - "ThemeErrorType": { - "enum": [ - "INTERNAL_FAILURE" - ], - "type": "string" - }, - "ThemeType": { - "enum": [ - "QUICKSIGHT", - "CUSTOM", - "ALL" - ], - "type": "string" - }, - "ThemeVersion": { - "additionalProperties": false, - "description": "

A version of a theme.

", - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the resource.

", - "type": "string" - }, - "BaseThemeId": { - "description": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

", - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/ThemeConfiguration" - }, - "CreatedTime": { - "description": "

The date and time that this theme version was created.

", - "format": "date-time", - "type": "string" - }, - "Description": { - "description": "

The description of the theme.

", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "Errors": { - "description": "

Errors associated with the theme.

", - "items": { - "$ref": "#/definitions/ThemeError" - }, - "minItems": 1, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/ResourceStatus" - }, - "VersionNumber": { - "description": "

The version number of the theme.

", - "minimum": 1, - "type": "number" - } - }, - "type": "object" - }, - "TileLayoutStyle": { - "additionalProperties": false, - "description": "

The display options for the layout of tiles on a sheet.

", - "properties": { - "Gutter": { - "$ref": "#/definitions/GutterStyle" - }, - "Margin": { - "$ref": "#/definitions/MarginStyle" - } - }, - "type": "object" - }, - "TileStyle": { - "additionalProperties": false, - "description": "

Display options related to tiles on a sheet.

", - "properties": { - "Border": { - "$ref": "#/definitions/BorderStyle" - } - }, - "type": "object" - }, - "Typography": { - "additionalProperties": false, - "properties": { - "FontFamilies": { - "items": { - "$ref": "#/definitions/Font" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - } - }, - "type": "object" - }, - "UIColorPalette": { - "additionalProperties": false, - "description": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

", - "properties": { - "Accent": { - "description": "

This color is that applies to selected states and buttons.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "AccentForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Danger": { - "description": "

The color that applies to error messages.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DangerForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n error color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Dimension": { - "description": "

The color that applies to the names of fields that are identified as\n dimensions.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "DimensionForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Measure": { - "description": "

The color that applies to the names of fields that are identified as measures.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "MeasureForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PrimaryBackground": { - "description": "

The background color that applies to visuals and other high emphasis UI.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "PrimaryForeground": { - "description": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "SecondaryBackground": { - "description": "

The background color that applies to the sheet background and sheet controls.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "SecondaryForeground": { - "description": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Success": { - "description": "

The color that applies to success messages, for example the check mark for a\n successful download.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "SuccessForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n success color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "Warning": { - "description": "

This color that applies to warning and informational messages.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - }, - "WarningForeground": { - "description": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

", - "pattern": "^#[A-F0-9]{6}$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of the AWS::QuickSight::Theme Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:DescribeTheme", - "quicksight:DescribeThemePermissions", - "quicksight:CreateTheme", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeTheme", - "quicksight:DeleteTheme" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AwsAccountId": { - "$ref": "resource-schema.json#/properties/AwsAccountId" - } - }, - "required": [ - "AwsAccountId" - ] - }, - "permissions": [ - "quicksight:ListThemes" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeTheme", - "quicksight:DescribeThemePermissions", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeTheme", - "quicksight:DescribeThemePermissions", - "quicksight:UpdateTheme", - "quicksight:UpdateThemePermissions", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ThemeId", - "/properties/AwsAccountId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the theme.

", - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "BaseThemeId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/ThemeConfiguration" - }, - "CreatedTime": { - "description": "

The date and time that the theme was created.

", - "format": "date-time", - "type": "string" - }, - "LastUpdatedTime": { - "description": "

The date and time that the theme was last updated.

", - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/ResourcePermission" - }, - "maxItems": 64, - "minItems": 1, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "ThemeId": { - "maxLength": 512, - "minLength": 1, - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "Type": { - "$ref": "#/definitions/ThemeType" - }, - "Version": { - "$ref": "#/definitions/ThemeVersion" - }, - "VersionDescription": { - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CreatedTime", - "/properties/Version", - "/properties/LastUpdatedTime", - "/properties/Arn", - "/properties/Type" - ], - "required": [ - "AwsAccountId", - "ThemeId", - "BaseThemeId", - "Configuration", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", - "typeName": "AWS::QuickSight::Theme", - "writeOnlyProperties": [ - "/properties/BaseThemeId", - "/properties/Configuration", - "/properties/VersionDescription" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/ThemeId" + ], + "definitions": { + "BorderStyle": { + "additionalProperties": false, + "description": "

The display options for tile borders for visuals.

", + "properties": { + "Show": { + "default": null, + "description": "

The option to enable display of borders for visuals.

", + "type": "boolean" + } + }, + "type": "object" + }, + "DataColorPalette": { + "additionalProperties": false, + "description": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

", + "properties": { + "Colors": { + "description": "

The hexadecimal codes for the colors.

", + "items": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "EmptyFillColor": { + "description": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "MinMaxGradient": { + "description": "

The minimum and maximum hexadecimal codes that describe a color gradient.

", + "items": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "Font": { + "additionalProperties": false, + "properties": { + "FontFamily": { + "type": "string" + } + }, + "type": "object" + }, + "GutterStyle": { + "additionalProperties": false, + "description": "

The display options for gutter spacing between tiles on a sheet.

", + "properties": { + "Show": { + "default": null, + "description": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

", + "type": "boolean" + } + }, + "type": "object" + }, + "MarginStyle": { + "additionalProperties": false, + "description": "

The display options for margins around the outside edge of sheets.

", + "properties": { + "Show": { + "default": null, + "description": "

This Boolean value controls whether to display sheet margins.

", + "type": "boolean" + } + }, + "type": "object" + }, + "ResourcePermission": { + "additionalProperties": false, + "description": "

Permission for the resource.

", + "properties": { + "Actions": { + "description": "

The IAM action to grant or revoke permissions on.

", + "items": { + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Principal": { + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Actions", + "Principal" + ], + "type": "object" + }, + "ResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETED" + ], + "type": "string" + }, + "SheetStyle": { + "additionalProperties": false, + "description": "

The theme display options for sheets.

", + "properties": { + "Tile": { + "$ref": "#/definitions/TileStyle" + }, + "TileLayout": { + "$ref": "#/definitions/TileLayoutStyle" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "ThemeConfiguration": { + "additionalProperties": false, + "description": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

", + "properties": { + "DataColorPalette": { + "$ref": "#/definitions/DataColorPalette" + }, + "Sheet": { + "$ref": "#/definitions/SheetStyle" + }, + "Typography": { + "$ref": "#/definitions/Typography" + }, + "UIColorPalette": { + "$ref": "#/definitions/UIColorPalette" + } + }, + "type": "object" + }, + "ThemeError": { + "additionalProperties": false, + "description": "

Theme error.

", + "properties": { + "Message": { + "description": "

The error message.

", + "pattern": "\\S", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/ThemeErrorType" + } + }, + "type": "object" + }, + "ThemeErrorType": { + "enum": [ + "INTERNAL_FAILURE" + ], + "type": "string" + }, + "ThemeType": { + "enum": [ + "QUICKSIGHT", + "CUSTOM", + "ALL" + ], + "type": "string" + }, + "ThemeVersion": { + "additionalProperties": false, + "description": "

A version of a theme.

", + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the resource.

", + "type": "string" + }, + "BaseThemeId": { + "description": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/ThemeConfiguration" + }, + "CreatedTime": { + "description": "

The date and time that this theme version was created.

", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "

The description of the theme.

", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "Errors": { + "description": "

Errors associated with the theme.

", + "items": { + "$ref": "#/definitions/ThemeError" + }, + "minItems": 1, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/ResourceStatus" + }, + "VersionNumber": { + "description": "

The version number of the theme.

", + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "TileLayoutStyle": { + "additionalProperties": false, + "description": "

The display options for the layout of tiles on a sheet.

", + "properties": { + "Gutter": { + "$ref": "#/definitions/GutterStyle" + }, + "Margin": { + "$ref": "#/definitions/MarginStyle" + } + }, + "type": "object" + }, + "TileStyle": { + "additionalProperties": false, + "description": "

Display options related to tiles on a sheet.

", + "properties": { + "Border": { + "$ref": "#/definitions/BorderStyle" + } + }, + "type": "object" + }, + "Typography": { + "additionalProperties": false, + "properties": { + "FontFamilies": { + "items": { + "$ref": "#/definitions/Font" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "UIColorPalette": { + "additionalProperties": false, + "description": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

", + "properties": { + "Accent": { + "description": "

This color is that applies to selected states and buttons.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "AccentForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Danger": { + "description": "

The color that applies to error messages.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DangerForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n error color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Dimension": { + "description": "

The color that applies to the names of fields that are identified as\n dimensions.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "DimensionForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Measure": { + "description": "

The color that applies to the names of fields that are identified as measures.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "MeasureForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PrimaryBackground": { + "description": "

The background color that applies to visuals and other high emphasis UI.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PrimaryForeground": { + "description": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "SecondaryBackground": { + "description": "

The background color that applies to the sheet background and sheet controls.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "SecondaryForeground": { + "description": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Success": { + "description": "

The color that applies to success messages, for example the check mark for a\n successful download.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "SuccessForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n success color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "Warning": { + "description": "

This color that applies to warning and informational messages.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "WarningForeground": { + "description": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

", + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of the AWS::QuickSight::Theme Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:DescribeTheme", + "quicksight:DescribeThemePermissions", + "quicksight:CreateTheme", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeTheme", + "quicksight:DeleteTheme" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + } + }, + "required": [ + "AwsAccountId" + ] + }, + "permissions": [ + "quicksight:ListThemes" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeTheme", + "quicksight:DescribeThemePermissions", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeTheme", + "quicksight:DescribeThemePermissions", + "quicksight:UpdateTheme", + "quicksight:UpdateThemePermissions", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ThemeId", + "/properties/AwsAccountId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the theme.

", + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "BaseThemeId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/ThemeConfiguration" + }, + "CreatedTime": { + "description": "

The date and time that the theme was created.

", + "format": "date-time", + "type": "string" + }, + "LastUpdatedTime": { + "description": "

The date and time that the theme was last updated.

", + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Permissions": { + "items": { + "$ref": "#/definitions/ResourcePermission" + }, + "maxItems": 64, + "minItems": 1, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "ThemeId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/ThemeType" + }, + "Version": { + "$ref": "#/definitions/ThemeVersion" + }, + "VersionDescription": { + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedTime", + "/properties/Version", + "/properties/LastUpdatedTime", + "/properties/Arn", + "/properties/Type" + ], + "required": [ + "AwsAccountId", + "ThemeId", + "BaseThemeId", + "Configuration", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", + "typeName": "AWS::QuickSight::Theme", + "writeOnlyProperties": [ + "/properties/BaseThemeId", + "/properties/Configuration", + "/properties/VersionDescription" + ] +} diff --git a/schema/aws-quicksight-topic.json b/schema/aws-quicksight-topic.json index 0f76d13..b3acd4a 100644 --- a/schema/aws-quicksight-topic.json +++ b/schema/aws-quicksight-topic.json @@ -1,1022 +1,1022 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/TopicId" - ], - "definitions": { - "AggregationFunctionParameters": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "AuthorSpecifiedAggregation": { - "enum": [ - "COUNT", - "DISTINCT_COUNT", - "MIN", - "MAX", - "MEDIAN", - "SUM", - "AVERAGE", - "STDEV", - "STDEVP", - "VAR", - "VARP", - "PERCENTILE" - ], - "type": "string" - }, - "CategoryFilterFunction": { - "enum": [ - "EXACT", - "CONTAINS" - ], - "type": "string" - }, - "CategoryFilterType": { - "enum": [ - "CUSTOM_FILTER", - "CUSTOM_FILTER_LIST", - "FILTER_LIST" - ], - "type": "string" - }, - "CellValueSynonym": { - "additionalProperties": false, - "properties": { - "CellValue": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Synonyms": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CollectiveConstant": { - "additionalProperties": false, - "properties": { - "ValueList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ColumnDataRole": { - "enum": [ - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "ColumnOrderingType": { - "enum": [ - "GREATER_IS_BETTER", - "LESSER_IS_BETTER", - "SPECIFIED" - ], - "type": "string" - }, - "ComparativeOrder": { - "additionalProperties": false, - "properties": { - "SpecifedOrder": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TreatUndefinedSpecifiedValues": { - "$ref": "#/definitions/UndefinedSpecifiedValueType" - }, - "UseOrdering": { - "$ref": "#/definitions/ColumnOrderingType" - } - }, - "type": "object" - }, - "ConstantType": { - "enum": [ - "SINGULAR", - "RANGE", - "COLLECTIVE" - ], - "type": "string" - }, - "DataAggregation": { - "additionalProperties": false, - "properties": { - "DatasetRowDateGranularity": { - "$ref": "#/definitions/TopicTimeGranularity" - }, - "DefaultDateColumnName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "DatasetMetadata": { - "additionalProperties": false, - "properties": { - "CalculatedFields": { - "items": { - "$ref": "#/definitions/TopicCalculatedField" - }, - "type": "array" - }, - "Columns": { - "items": { - "$ref": "#/definitions/TopicColumn" - }, - "type": "array" - }, - "DataAggregation": { - "$ref": "#/definitions/DataAggregation" - }, - "DatasetArn": { - "type": "string" - }, - "DatasetDescription": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "DatasetName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Filters": { - "items": { - "$ref": "#/definitions/TopicFilter" - }, - "type": "array" - }, - "NamedEntities": { - "items": { - "$ref": "#/definitions/TopicNamedEntity" - }, - "type": "array" - } - }, - "required": [ - "DatasetArn" - ], - "type": "object" - }, - "DefaultAggregation": { - "enum": [ - "SUM", - "MAX", - "MIN", - "COUNT", - "DISTINCT_COUNT", - "AVERAGE", - "MEDIAN", - "STDEV", - "STDEVP", - "VAR", - "VARP" - ], - "type": "string" - }, - "DefaultFormatting": { - "additionalProperties": false, - "properties": { - "DisplayFormat": { - "$ref": "#/definitions/DisplayFormat" - }, - "DisplayFormatOptions": { - "$ref": "#/definitions/DisplayFormatOptions" - } - }, - "type": "object" - }, - "DisplayFormat": { - "enum": [ - "AUTO", - "PERCENT", - "CURRENCY", - "NUMBER", - "DATE", - "STRING" - ], - "type": "string" - }, - "DisplayFormatOptions": { - "additionalProperties": false, - "properties": { - "BlankCellFormat": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "CurrencySymbol": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "DateFormat": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "DecimalSeparator": { - "$ref": "#/definitions/TopicNumericSeparatorSymbol" - }, - "FractionDigits": { - "default": 0, - "type": "number" - }, - "GroupingSeparator": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "NegativeFormat": { - "$ref": "#/definitions/NegativeFormat" - }, - "Prefix": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Suffix": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "UnitScaler": { - "$ref": "#/definitions/NumberScale" - }, - "UseBlankCellFormat": { - "default": false, - "type": "boolean" - }, - "UseGrouping": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "FilterClass": { - "enum": [ - "ENFORCED_VALUE_FILTER", - "CONDITIONAL_VALUE_FILTER", - "NAMED_VALUE_FILTER" - ], - "type": "string" - }, - "NamedEntityAggType": { - "enum": [ - "SUM", - "MIN", - "MAX", - "COUNT", - "AVERAGE", - "DISTINCT_COUNT", - "STDEV", - "STDEVP", - "VAR", - "VARP", - "PERCENTILE", - "MEDIAN", - "CUSTOM" - ], - "type": "string" - }, - "NamedEntityDefinition": { - "additionalProperties": false, - "properties": { - "FieldName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Metric": { - "$ref": "#/definitions/NamedEntityDefinitionMetric" - }, - "PropertyName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "PropertyRole": { - "$ref": "#/definitions/PropertyRole" - }, - "PropertyUsage": { - "$ref": "#/definitions/PropertyUsage" - } - }, - "type": "object" - }, - "NamedEntityDefinitionMetric": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/NamedEntityAggType" - }, - "AggregationFunctionParameters": { - "$ref": "#/definitions/AggregationFunctionParameters" - } - }, - "type": "object" - }, - "NamedFilterAggType": { - "enum": [ - "NO_AGGREGATION", - "SUM", - "AVERAGE", - "COUNT", - "DISTINCT_COUNT", - "MAX", - "MEDIAN", - "MIN", - "STDEV", - "STDEVP", - "VAR", - "VARP" - ], - "type": "string" - }, - "NamedFilterType": { - "enum": [ - "CATEGORY_FILTER", - "NUMERIC_EQUALITY_FILTER", - "NUMERIC_RANGE_FILTER", - "DATE_RANGE_FILTER", - "RELATIVE_DATE_FILTER" - ], - "type": "string" - }, - "NegativeFormat": { - "additionalProperties": false, - "properties": { - "Prefix": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Suffix": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "NumberScale": { - "enum": [ - "NONE", - "AUTO", - "THOUSANDS", - "MILLIONS", - "BILLIONS", - "TRILLIONS" - ], - "type": "string" - }, - "PropertyRole": { - "enum": [ - "PRIMARY", - "ID" - ], - "type": "string" - }, - "PropertyUsage": { - "enum": [ - "INHERIT", - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "RangeConstant": { - "additionalProperties": false, - "properties": { - "Maximum": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Minimum": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "SemanticEntityType": { - "additionalProperties": false, - "properties": { - "SubTypeName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "TypeName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "TypeParameters": { - "$ref": "#/definitions/TypeParameters" - } - }, - "type": "object" - }, - "SemanticType": { - "additionalProperties": false, - "properties": { - "FalseyCellValue": { - "type": "string" - }, - "FalseyCellValueSynonyms": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubTypeName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "TruthyCellValue": { - "type": "string" - }, - "TruthyCellValueSynonyms": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TypeName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "TypeParameters": { - "$ref": "#/definitions/TypeParameters" - } - }, - "type": "object" - }, - "TopicCalculatedField": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/DefaultAggregation" - }, - "AllowedAggregations": { - "items": { - "$ref": "#/definitions/AuthorSpecifiedAggregation" - }, - "type": "array" - }, - "CalculatedFieldDescription": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "CalculatedFieldName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "CalculatedFieldSynonyms": { - "items": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "CellValueSynonyms": { - "items": { - "$ref": "#/definitions/CellValueSynonym" - }, - "type": "array" - }, - "ColumnDataRole": { - "$ref": "#/definitions/ColumnDataRole" - }, - "ComparativeOrder": { - "$ref": "#/definitions/ComparativeOrder" - }, - "DefaultFormatting": { - "$ref": "#/definitions/DefaultFormatting" - }, - "DisableIndexing": { - "type": "boolean" - }, - "Expression": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "IsIncludedInTopic": { - "default": false, - "type": "boolean" - }, - "NeverAggregateInFilter": { - "default": false, - "type": "boolean" - }, - "NonAdditive": { - "default": false, - "type": "boolean" - }, - "NotAllowedAggregations": { - "items": { - "$ref": "#/definitions/AuthorSpecifiedAggregation" - }, - "type": "array" - }, - "SemanticType": { - "$ref": "#/definitions/SemanticType" - }, - "TimeGranularity": { - "$ref": "#/definitions/TopicTimeGranularity" - } - }, - "required": [ - "CalculatedFieldName", - "Expression" - ], - "type": "object" - }, - "TopicCategoryFilter": { - "additionalProperties": false, - "properties": { - "CategoryFilterFunction": { - "$ref": "#/definitions/CategoryFilterFunction" - }, - "CategoryFilterType": { - "$ref": "#/definitions/CategoryFilterType" - }, - "Constant": { - "$ref": "#/definitions/TopicCategoryFilterConstant" - }, - "Inverse": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "TopicCategoryFilterConstant": { - "additionalProperties": false, - "properties": { - "CollectiveConstant": { - "$ref": "#/definitions/CollectiveConstant" - }, - "ConstantType": { - "$ref": "#/definitions/ConstantType" - }, - "SingularConstant": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TopicColumn": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/DefaultAggregation" - }, - "AllowedAggregations": { - "items": { - "$ref": "#/definitions/AuthorSpecifiedAggregation" - }, - "type": "array" - }, - "CellValueSynonyms": { - "items": { - "$ref": "#/definitions/CellValueSynonym" - }, - "type": "array" - }, - "ColumnDataRole": { - "$ref": "#/definitions/ColumnDataRole" - }, - "ColumnDescription": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "ColumnFriendlyName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "ColumnName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "ColumnSynonyms": { - "items": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "ComparativeOrder": { - "$ref": "#/definitions/ComparativeOrder" - }, - "DefaultFormatting": { - "$ref": "#/definitions/DefaultFormatting" - }, - "DisableIndexing": { - "type": "boolean" - }, - "IsIncludedInTopic": { - "default": false, - "type": "boolean" - }, - "NeverAggregateInFilter": { - "default": false, - "type": "boolean" - }, - "NonAdditive": { - "default": false, - "type": "boolean" - }, - "NotAllowedAggregations": { - "items": { - "$ref": "#/definitions/AuthorSpecifiedAggregation" - }, - "type": "array" - }, - "SemanticType": { - "$ref": "#/definitions/SemanticType" - }, - "TimeGranularity": { - "$ref": "#/definitions/TopicTimeGranularity" - } - }, - "required": [ - "ColumnName" - ], - "type": "object" - }, - "TopicDateRangeFilter": { - "additionalProperties": false, - "properties": { - "Constant": { - "$ref": "#/definitions/TopicRangeFilterConstant" - }, - "Inclusive": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "TopicDetails": { - "additionalProperties": false, - "properties": { - "DataSets": { - "items": { - "$ref": "#/definitions/DatasetMetadata" - }, - "type": "array" - }, - "Description": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "UserExperienceVersion": { - "$ref": "#/definitions/TopicUserExperienceVersion" - } - }, - "type": "object" - }, - "TopicFilter": { - "additionalProperties": false, - "properties": { - "CategoryFilter": { - "$ref": "#/definitions/TopicCategoryFilter" - }, - "DateRangeFilter": { - "$ref": "#/definitions/TopicDateRangeFilter" - }, - "FilterClass": { - "$ref": "#/definitions/FilterClass" - }, - "FilterDescription": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "FilterName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "FilterSynonyms": { - "items": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "FilterType": { - "$ref": "#/definitions/NamedFilterType" - }, - "NumericEqualityFilter": { - "$ref": "#/definitions/TopicNumericEqualityFilter" - }, - "NumericRangeFilter": { - "$ref": "#/definitions/TopicNumericRangeFilter" - }, - "OperandFieldName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "RelativeDateFilter": { - "$ref": "#/definitions/TopicRelativeDateFilter" - } - }, - "required": [ - "FilterName", - "OperandFieldName" - ], - "type": "object" - }, - "TopicNamedEntity": { - "additionalProperties": false, - "properties": { - "Definition": { - "items": { - "$ref": "#/definitions/NamedEntityDefinition" - }, - "type": "array" - }, - "EntityDescription": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "EntityName": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "EntitySynonyms": { - "items": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "SemanticEntityType": { - "$ref": "#/definitions/SemanticEntityType" - } - }, - "required": [ - "EntityName" - ], - "type": "object" - }, - "TopicNumericEqualityFilter": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/NamedFilterAggType" - }, - "Constant": { - "$ref": "#/definitions/TopicSingularFilterConstant" - } - }, - "type": "object" - }, - "TopicNumericRangeFilter": { - "additionalProperties": false, - "properties": { - "Aggregation": { - "$ref": "#/definitions/NamedFilterAggType" - }, - "Constant": { - "$ref": "#/definitions/TopicRangeFilterConstant" - }, - "Inclusive": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "TopicNumericSeparatorSymbol": { - "enum": [ - "COMMA", - "DOT" - ], - "type": "string" - }, - "TopicRangeFilterConstant": { - "additionalProperties": false, - "properties": { - "ConstantType": { - "$ref": "#/definitions/ConstantType" - }, - "RangeConstant": { - "$ref": "#/definitions/RangeConstant" - } - }, - "type": "object" - }, - "TopicRelativeDateFilter": { - "additionalProperties": false, - "properties": { - "Constant": { - "$ref": "#/definitions/TopicSingularFilterConstant" - }, - "RelativeDateFilterFunction": { - "$ref": "#/definitions/TopicRelativeDateFilterFunction" - }, - "TimeGranularity": { - "$ref": "#/definitions/TopicTimeGranularity" - } - }, - "type": "object" - }, - "TopicRelativeDateFilterFunction": { - "enum": [ - "PREVIOUS", - "THIS", - "LAST", - "NEXT", - "NOW" - ], - "type": "string" - }, - "TopicSingularFilterConstant": { - "additionalProperties": false, - "properties": { - "ConstantType": { - "$ref": "#/definitions/ConstantType" - }, - "SingularConstant": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TopicTimeGranularity": { - "enum": [ - "SECOND", - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "TopicUserExperienceVersion": { - "enum": [ - "LEGACY", - "NEW_READER_EXPERIENCE" - ], - "type": "string" - }, - "TypeParameters": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "UndefinedSpecifiedValueType": { - "enum": [ - "LEAST", - "MOST" - ], - "type": "string" - } - }, - "description": "Definition of the AWS::QuickSight::Topic Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:CreateTopic", - "quicksight:PassDataSet", - "quicksight:DescribeTopicRefresh" - ] - }, - "delete": { - "permissions": [ - "quicksight:DeleteTopic" - ] - }, - "list": { - "permissions": [ - "quicksight:ListTopics" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeTopic" - ] - }, - "update": { - "permissions": [ - "quicksight:UpdateTopic", - "quicksight:PassDataSet", - "quicksight:DescribeTopicRefresh" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/TopicId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "DataSets": { - "items": { - "$ref": "#/definitions/DatasetMetadata" - }, - "type": "array" - }, - "Description": { - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "TopicId": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[A-Za-z0-9-_.\\\\+]*$", - "type": "string" - }, - "UserExperienceVersion": { - "$ref": "#/definitions/TopicUserExperienceVersion" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::QuickSight::Topic" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/TopicId" + ], + "definitions": { + "AggregationFunctionParameters": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "AuthorSpecifiedAggregation": { + "enum": [ + "COUNT", + "DISTINCT_COUNT", + "MIN", + "MAX", + "MEDIAN", + "SUM", + "AVERAGE", + "STDEV", + "STDEVP", + "VAR", + "VARP", + "PERCENTILE" + ], + "type": "string" + }, + "CategoryFilterFunction": { + "enum": [ + "EXACT", + "CONTAINS" + ], + "type": "string" + }, + "CategoryFilterType": { + "enum": [ + "CUSTOM_FILTER", + "CUSTOM_FILTER_LIST", + "FILTER_LIST" + ], + "type": "string" + }, + "CellValueSynonym": { + "additionalProperties": false, + "properties": { + "CellValue": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Synonyms": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CollectiveConstant": { + "additionalProperties": false, + "properties": { + "ValueList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ColumnDataRole": { + "enum": [ + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "ColumnOrderingType": { + "enum": [ + "GREATER_IS_BETTER", + "LESSER_IS_BETTER", + "SPECIFIED" + ], + "type": "string" + }, + "ComparativeOrder": { + "additionalProperties": false, + "properties": { + "SpecifedOrder": { + "items": { + "type": "string" + }, + "type": "array" + }, + "TreatUndefinedSpecifiedValues": { + "$ref": "#/definitions/UndefinedSpecifiedValueType" + }, + "UseOrdering": { + "$ref": "#/definitions/ColumnOrderingType" + } + }, + "type": "object" + }, + "ConstantType": { + "enum": [ + "SINGULAR", + "RANGE", + "COLLECTIVE" + ], + "type": "string" + }, + "DataAggregation": { + "additionalProperties": false, + "properties": { + "DatasetRowDateGranularity": { + "$ref": "#/definitions/TopicTimeGranularity" + }, + "DefaultDateColumnName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "DatasetMetadata": { + "additionalProperties": false, + "properties": { + "CalculatedFields": { + "items": { + "$ref": "#/definitions/TopicCalculatedField" + }, + "type": "array" + }, + "Columns": { + "items": { + "$ref": "#/definitions/TopicColumn" + }, + "type": "array" + }, + "DataAggregation": { + "$ref": "#/definitions/DataAggregation" + }, + "DatasetArn": { + "type": "string" + }, + "DatasetDescription": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "DatasetName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Filters": { + "items": { + "$ref": "#/definitions/TopicFilter" + }, + "type": "array" + }, + "NamedEntities": { + "items": { + "$ref": "#/definitions/TopicNamedEntity" + }, + "type": "array" + } + }, + "required": [ + "DatasetArn" + ], + "type": "object" + }, + "DefaultAggregation": { + "enum": [ + "SUM", + "MAX", + "MIN", + "COUNT", + "DISTINCT_COUNT", + "AVERAGE", + "MEDIAN", + "STDEV", + "STDEVP", + "VAR", + "VARP" + ], + "type": "string" + }, + "DefaultFormatting": { + "additionalProperties": false, + "properties": { + "DisplayFormat": { + "$ref": "#/definitions/DisplayFormat" + }, + "DisplayFormatOptions": { + "$ref": "#/definitions/DisplayFormatOptions" + } + }, + "type": "object" + }, + "DisplayFormat": { + "enum": [ + "AUTO", + "PERCENT", + "CURRENCY", + "NUMBER", + "DATE", + "STRING" + ], + "type": "string" + }, + "DisplayFormatOptions": { + "additionalProperties": false, + "properties": { + "BlankCellFormat": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "CurrencySymbol": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "DateFormat": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "DecimalSeparator": { + "$ref": "#/definitions/TopicNumericSeparatorSymbol" + }, + "FractionDigits": { + "default": 0, + "type": "number" + }, + "GroupingSeparator": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "NegativeFormat": { + "$ref": "#/definitions/NegativeFormat" + }, + "Prefix": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Suffix": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "UnitScaler": { + "$ref": "#/definitions/NumberScale" + }, + "UseBlankCellFormat": { + "default": false, + "type": "boolean" + }, + "UseGrouping": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "FilterClass": { + "enum": [ + "ENFORCED_VALUE_FILTER", + "CONDITIONAL_VALUE_FILTER", + "NAMED_VALUE_FILTER" + ], + "type": "string" + }, + "NamedEntityAggType": { + "enum": [ + "SUM", + "MIN", + "MAX", + "COUNT", + "AVERAGE", + "DISTINCT_COUNT", + "STDEV", + "STDEVP", + "VAR", + "VARP", + "PERCENTILE", + "MEDIAN", + "CUSTOM" + ], + "type": "string" + }, + "NamedEntityDefinition": { + "additionalProperties": false, + "properties": { + "FieldName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Metric": { + "$ref": "#/definitions/NamedEntityDefinitionMetric" + }, + "PropertyName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "PropertyRole": { + "$ref": "#/definitions/PropertyRole" + }, + "PropertyUsage": { + "$ref": "#/definitions/PropertyUsage" + } + }, + "type": "object" + }, + "NamedEntityDefinitionMetric": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/NamedEntityAggType" + }, + "AggregationFunctionParameters": { + "$ref": "#/definitions/AggregationFunctionParameters" + } + }, + "type": "object" + }, + "NamedFilterAggType": { + "enum": [ + "NO_AGGREGATION", + "SUM", + "AVERAGE", + "COUNT", + "DISTINCT_COUNT", + "MAX", + "MEDIAN", + "MIN", + "STDEV", + "STDEVP", + "VAR", + "VARP" + ], + "type": "string" + }, + "NamedFilterType": { + "enum": [ + "CATEGORY_FILTER", + "NUMERIC_EQUALITY_FILTER", + "NUMERIC_RANGE_FILTER", + "DATE_RANGE_FILTER", + "RELATIVE_DATE_FILTER" + ], + "type": "string" + }, + "NegativeFormat": { + "additionalProperties": false, + "properties": { + "Prefix": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Suffix": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "NumberScale": { + "enum": [ + "NONE", + "AUTO", + "THOUSANDS", + "MILLIONS", + "BILLIONS", + "TRILLIONS" + ], + "type": "string" + }, + "PropertyRole": { + "enum": [ + "PRIMARY", + "ID" + ], + "type": "string" + }, + "PropertyUsage": { + "enum": [ + "INHERIT", + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "RangeConstant": { + "additionalProperties": false, + "properties": { + "Maximum": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Minimum": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "SemanticEntityType": { + "additionalProperties": false, + "properties": { + "SubTypeName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "TypeName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "TypeParameters": { + "$ref": "#/definitions/TypeParameters" + } + }, + "type": "object" + }, + "SemanticType": { + "additionalProperties": false, + "properties": { + "FalseyCellValue": { + "type": "string" + }, + "FalseyCellValueSynonyms": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubTypeName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "TruthyCellValue": { + "type": "string" + }, + "TruthyCellValueSynonyms": { + "items": { + "type": "string" + }, + "type": "array" + }, + "TypeName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "TypeParameters": { + "$ref": "#/definitions/TypeParameters" + } + }, + "type": "object" + }, + "TopicCalculatedField": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/DefaultAggregation" + }, + "AllowedAggregations": { + "items": { + "$ref": "#/definitions/AuthorSpecifiedAggregation" + }, + "type": "array" + }, + "CalculatedFieldDescription": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "CalculatedFieldName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "CalculatedFieldSynonyms": { + "items": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "CellValueSynonyms": { + "items": { + "$ref": "#/definitions/CellValueSynonym" + }, + "type": "array" + }, + "ColumnDataRole": { + "$ref": "#/definitions/ColumnDataRole" + }, + "ComparativeOrder": { + "$ref": "#/definitions/ComparativeOrder" + }, + "DefaultFormatting": { + "$ref": "#/definitions/DefaultFormatting" + }, + "DisableIndexing": { + "type": "boolean" + }, + "Expression": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "IsIncludedInTopic": { + "default": false, + "type": "boolean" + }, + "NeverAggregateInFilter": { + "default": false, + "type": "boolean" + }, + "NonAdditive": { + "default": false, + "type": "boolean" + }, + "NotAllowedAggregations": { + "items": { + "$ref": "#/definitions/AuthorSpecifiedAggregation" + }, + "type": "array" + }, + "SemanticType": { + "$ref": "#/definitions/SemanticType" + }, + "TimeGranularity": { + "$ref": "#/definitions/TopicTimeGranularity" + } + }, + "required": [ + "CalculatedFieldName", + "Expression" + ], + "type": "object" + }, + "TopicCategoryFilter": { + "additionalProperties": false, + "properties": { + "CategoryFilterFunction": { + "$ref": "#/definitions/CategoryFilterFunction" + }, + "CategoryFilterType": { + "$ref": "#/definitions/CategoryFilterType" + }, + "Constant": { + "$ref": "#/definitions/TopicCategoryFilterConstant" + }, + "Inverse": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "TopicCategoryFilterConstant": { + "additionalProperties": false, + "properties": { + "CollectiveConstant": { + "$ref": "#/definitions/CollectiveConstant" + }, + "ConstantType": { + "$ref": "#/definitions/ConstantType" + }, + "SingularConstant": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TopicColumn": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/DefaultAggregation" + }, + "AllowedAggregations": { + "items": { + "$ref": "#/definitions/AuthorSpecifiedAggregation" + }, + "type": "array" + }, + "CellValueSynonyms": { + "items": { + "$ref": "#/definitions/CellValueSynonym" + }, + "type": "array" + }, + "ColumnDataRole": { + "$ref": "#/definitions/ColumnDataRole" + }, + "ColumnDescription": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "ColumnFriendlyName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "ColumnName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "ColumnSynonyms": { + "items": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "ComparativeOrder": { + "$ref": "#/definitions/ComparativeOrder" + }, + "DefaultFormatting": { + "$ref": "#/definitions/DefaultFormatting" + }, + "DisableIndexing": { + "type": "boolean" + }, + "IsIncludedInTopic": { + "default": false, + "type": "boolean" + }, + "NeverAggregateInFilter": { + "default": false, + "type": "boolean" + }, + "NonAdditive": { + "default": false, + "type": "boolean" + }, + "NotAllowedAggregations": { + "items": { + "$ref": "#/definitions/AuthorSpecifiedAggregation" + }, + "type": "array" + }, + "SemanticType": { + "$ref": "#/definitions/SemanticType" + }, + "TimeGranularity": { + "$ref": "#/definitions/TopicTimeGranularity" + } + }, + "required": [ + "ColumnName" + ], + "type": "object" + }, + "TopicDateRangeFilter": { + "additionalProperties": false, + "properties": { + "Constant": { + "$ref": "#/definitions/TopicRangeFilterConstant" + }, + "Inclusive": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "TopicDetails": { + "additionalProperties": false, + "properties": { + "DataSets": { + "items": { + "$ref": "#/definitions/DatasetMetadata" + }, + "type": "array" + }, + "Description": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "UserExperienceVersion": { + "$ref": "#/definitions/TopicUserExperienceVersion" + } + }, + "type": "object" + }, + "TopicFilter": { + "additionalProperties": false, + "properties": { + "CategoryFilter": { + "$ref": "#/definitions/TopicCategoryFilter" + }, + "DateRangeFilter": { + "$ref": "#/definitions/TopicDateRangeFilter" + }, + "FilterClass": { + "$ref": "#/definitions/FilterClass" + }, + "FilterDescription": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "FilterName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "FilterSynonyms": { + "items": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "FilterType": { + "$ref": "#/definitions/NamedFilterType" + }, + "NumericEqualityFilter": { + "$ref": "#/definitions/TopicNumericEqualityFilter" + }, + "NumericRangeFilter": { + "$ref": "#/definitions/TopicNumericRangeFilter" + }, + "OperandFieldName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "RelativeDateFilter": { + "$ref": "#/definitions/TopicRelativeDateFilter" + } + }, + "required": [ + "FilterName", + "OperandFieldName" + ], + "type": "object" + }, + "TopicNamedEntity": { + "additionalProperties": false, + "properties": { + "Definition": { + "items": { + "$ref": "#/definitions/NamedEntityDefinition" + }, + "type": "array" + }, + "EntityDescription": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "EntityName": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "EntitySynonyms": { + "items": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "SemanticEntityType": { + "$ref": "#/definitions/SemanticEntityType" + } + }, + "required": [ + "EntityName" + ], + "type": "object" + }, + "TopicNumericEqualityFilter": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/NamedFilterAggType" + }, + "Constant": { + "$ref": "#/definitions/TopicSingularFilterConstant" + } + }, + "type": "object" + }, + "TopicNumericRangeFilter": { + "additionalProperties": false, + "properties": { + "Aggregation": { + "$ref": "#/definitions/NamedFilterAggType" + }, + "Constant": { + "$ref": "#/definitions/TopicRangeFilterConstant" + }, + "Inclusive": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "TopicNumericSeparatorSymbol": { + "enum": [ + "COMMA", + "DOT" + ], + "type": "string" + }, + "TopicRangeFilterConstant": { + "additionalProperties": false, + "properties": { + "ConstantType": { + "$ref": "#/definitions/ConstantType" + }, + "RangeConstant": { + "$ref": "#/definitions/RangeConstant" + } + }, + "type": "object" + }, + "TopicRelativeDateFilter": { + "additionalProperties": false, + "properties": { + "Constant": { + "$ref": "#/definitions/TopicSingularFilterConstant" + }, + "RelativeDateFilterFunction": { + "$ref": "#/definitions/TopicRelativeDateFilterFunction" + }, + "TimeGranularity": { + "$ref": "#/definitions/TopicTimeGranularity" + } + }, + "type": "object" + }, + "TopicRelativeDateFilterFunction": { + "enum": [ + "PREVIOUS", + "THIS", + "LAST", + "NEXT", + "NOW" + ], + "type": "string" + }, + "TopicSingularFilterConstant": { + "additionalProperties": false, + "properties": { + "ConstantType": { + "$ref": "#/definitions/ConstantType" + }, + "SingularConstant": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TopicTimeGranularity": { + "enum": [ + "SECOND", + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, + "TopicUserExperienceVersion": { + "enum": [ + "LEGACY", + "NEW_READER_EXPERIENCE" + ], + "type": "string" + }, + "TypeParameters": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "UndefinedSpecifiedValueType": { + "enum": [ + "LEAST", + "MOST" + ], + "type": "string" + } + }, + "description": "Definition of the AWS::QuickSight::Topic Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:CreateTopic", + "quicksight:PassDataSet", + "quicksight:DescribeTopicRefresh" + ] + }, + "delete": { + "permissions": [ + "quicksight:DeleteTopic" + ] + }, + "list": { + "permissions": [ + "quicksight:ListTopics" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeTopic" + ] + }, + "update": { + "permissions": [ + "quicksight:UpdateTopic", + "quicksight:PassDataSet", + "quicksight:DescribeTopicRefresh" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/TopicId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DataSets": { + "items": { + "$ref": "#/definitions/DatasetMetadata" + }, + "type": "array" + }, + "Description": { + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "TopicId": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9-_.\\\\+]*$", + "type": "string" + }, + "UserExperienceVersion": { + "$ref": "#/definitions/TopicUserExperienceVersion" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::QuickSight::Topic" +} diff --git a/schema/aws-quicksight-vpcconnection.json b/schema/aws-quicksight-vpcconnection.json index 2e0f38b..71f006a 100644 --- a/schema/aws-quicksight-vpcconnection.json +++ b/schema/aws-quicksight-vpcconnection.json @@ -1,261 +1,261 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AwsAccountId", - "/properties/VPCConnectionId" - ], - "definitions": { - "NetworkInterface": { - "additionalProperties": false, - "description": "

The structure that contains information about a network interface.

", - "properties": { - "AvailabilityZone": { - "description": "

The availability zone that the network interface resides in.

", - "type": "string" - }, - "ErrorMessage": { - "description": "

An error message.

", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "

The network interface ID.

", - "maxLength": 255, - "minLength": 0, - "pattern": "^eni-[0-9a-z]*$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/NetworkInterfaceStatus" - }, - "SubnetId": { - "description": "

The subnet ID associated with the network interface.

", - "maxLength": 255, - "minLength": 1, - "pattern": "^subnet-[0-9a-z]*$", - "type": "string" - } - }, - "type": "object" - }, - "NetworkInterfaceStatus": { - "enum": [ - "CREATING", - "AVAILABLE", - "CREATION_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "DELETED", - "DELETION_FAILED", - "DELETION_SCHEDULED", - "ATTACHMENT_FAILED_ROLLBACK_FAILED" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", - "properties": { - "Key": { - "description": "

Tag key.

", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "

Tag value.

", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VPCConnectionAvailabilityStatus": { - "enum": [ - "AVAILABLE", - "UNAVAILABLE", - "PARTIALLY_AVAILABLE" - ], - "type": "string" - }, - "VPCConnectionResourceStatus": { - "enum": [ - "CREATION_IN_PROGRESS", - "CREATION_SUCCESSFUL", - "CREATION_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_SUCCESSFUL", - "UPDATE_FAILED", - "DELETION_IN_PROGRESS", - "DELETION_FAILED", - "DELETED" - ], - "type": "string" - } - }, - "description": "Definition of the AWS::QuickSight::VPCConnection Resource Type.", - "handlers": { - "create": { - "permissions": [ - "quicksight:CreateVPCConnection", - "quicksight:DescribeVPCConnection", - "quicksight:ListTagsForResource", - "quicksight:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "quicksight:DescribeVPCConnection", - "quicksight:DeleteVPCConnection", - "quicksight:ListTagsForResource", - "iam:PassRole" - ] - }, - "list": { - "permissions": [ - "quicksight:ListVPCConnections" - ] - }, - "read": { - "permissions": [ - "quicksight:DescribeVPCConnection", - "quicksight:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "quicksight:DescribeVPCConnection", - "quicksight:UpdateVPCConnection", - "quicksight:TagResource", - "quicksight:UntagResource", - "quicksight:ListTagsForResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AwsAccountId", - "/properties/VPCConnectionId" - ], - "properties": { - "Arn": { - "description": "

The Amazon Resource Name (ARN) of the VPC connection.

", - "type": "string" - }, - "AvailabilityStatus": { - "$ref": "#/definitions/VPCConnectionAvailabilityStatus" - }, - "AwsAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "CreatedTime": { - "description": "

The time that the VPC connection was created.

", - "format": "date-time", - "type": "string" - }, - "DnsResolvers": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "LastUpdatedTime": { - "description": "

The time that the VPC connection was last updated.

", - "format": "date-time", - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "NetworkInterfaces": { - "description": "

A list of network interfaces.

", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "maxItems": 15, - "minItems": 0, - "type": "array" - }, - "RoleArn": { - "type": "string" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^sg-[0-9a-z]*$", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/VPCConnectionResourceStatus" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^subnet-[0-9a-z]*$", - "type": "string" - }, - "maxItems": 15, - "minItems": 2, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, - "VPCConnectionId": { - "maxLength": 1000, - "minLength": 1, - "pattern": "[\\w\\-]+", - "type": "string" - }, - "VPCId": { - "description": "

The Amazon EC2 VPC ID associated with the VPC connection.

", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedTime", - "/properties/LastUpdatedTime", - "/properties/NetworkInterfaces", - "/properties/Status", - "/properties/VPCId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::QuickSight::VPCConnection", - "writeOnlyProperties": [ - "/properties/SubnetIds" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/VPCConnectionId" + ], + "definitions": { + "NetworkInterface": { + "additionalProperties": false, + "description": "

The structure that contains information about a network interface.

", + "properties": { + "AvailabilityZone": { + "description": "

The availability zone that the network interface resides in.

", + "type": "string" + }, + "ErrorMessage": { + "description": "

An error message.

", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "

The network interface ID.

", + "maxLength": 255, + "minLength": 0, + "pattern": "^eni-[0-9a-z]*$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/NetworkInterfaceStatus" + }, + "SubnetId": { + "description": "

The subnet ID associated with the network interface.

", + "maxLength": 255, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*$", + "type": "string" + } + }, + "type": "object" + }, + "NetworkInterfaceStatus": { + "enum": [ + "CREATING", + "AVAILABLE", + "CREATION_FAILED", + "UPDATING", + "UPDATE_FAILED", + "DELETING", + "DELETED", + "DELETION_FAILED", + "DELETION_SCHEDULED", + "ATTACHMENT_FAILED_ROLLBACK_FAILED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

", + "properties": { + "Key": { + "description": "

Tag key.

", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "

Tag value.

", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VPCConnectionAvailabilityStatus": { + "enum": [ + "AVAILABLE", + "UNAVAILABLE", + "PARTIALLY_AVAILABLE" + ], + "type": "string" + }, + "VPCConnectionResourceStatus": { + "enum": [ + "CREATION_IN_PROGRESS", + "CREATION_SUCCESSFUL", + "CREATION_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "DELETION_IN_PROGRESS", + "DELETION_FAILED", + "DELETED" + ], + "type": "string" + } + }, + "description": "Definition of the AWS::QuickSight::VPCConnection Resource Type.", + "handlers": { + "create": { + "permissions": [ + "quicksight:CreateVPCConnection", + "quicksight:DescribeVPCConnection", + "quicksight:ListTagsForResource", + "quicksight:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "quicksight:DescribeVPCConnection", + "quicksight:DeleteVPCConnection", + "quicksight:ListTagsForResource", + "iam:PassRole" + ] + }, + "list": { + "permissions": [ + "quicksight:ListVPCConnections" + ] + }, + "read": { + "permissions": [ + "quicksight:DescribeVPCConnection", + "quicksight:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "quicksight:DescribeVPCConnection", + "quicksight:UpdateVPCConnection", + "quicksight:TagResource", + "quicksight:UntagResource", + "quicksight:ListTagsForResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AwsAccountId", + "/properties/VPCConnectionId" + ], + "properties": { + "Arn": { + "description": "

The Amazon Resource Name (ARN) of the VPC connection.

", + "type": "string" + }, + "AvailabilityStatus": { + "$ref": "#/definitions/VPCConnectionAvailabilityStatus" + }, + "AwsAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "CreatedTime": { + "description": "

The time that the VPC connection was created.

", + "format": "date-time", + "type": "string" + }, + "DnsResolvers": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "LastUpdatedTime": { + "description": "

The time that the VPC connection was last updated.

", + "format": "date-time", + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "NetworkInterfaces": { + "description": "

A list of network interfaces.

", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "maxItems": 15, + "minItems": 0, + "type": "array" + }, + "RoleArn": { + "type": "string" + }, + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^sg-[0-9a-z]*$", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/VPCConnectionResourceStatus" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*$", + "type": "string" + }, + "maxItems": 15, + "minItems": 2, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" + }, + "VPCConnectionId": { + "maxLength": 1000, + "minLength": 1, + "pattern": "[\\w\\-]+", + "type": "string" + }, + "VPCId": { + "description": "

The Amazon EC2 VPC ID associated with the VPC connection.

", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime", + "/properties/NetworkInterfaces", + "/properties/Status", + "/properties/VPCId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::QuickSight::VPCConnection", + "writeOnlyProperties": [ + "/properties/SubnetIds" + ] +} diff --git a/schema/aws-ram-permission.json b/schema/aws-ram-permission.json index c6126c8..4b2435a 100644 --- a/schema/aws-ram-permission.json +++ b/schema/aws-ram-permission.json @@ -1,129 +1,129 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/ResourceType", - "/properties/PolicyTemplate" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::RAM::Permission", - "handlers": { - "create": { - "permissions": [ - "ram:CreatePermission", - "ram:TagResource" - ] - }, - "delete": { - "permissions": [ - "ram:DeletePermissionVersion", - "ram:DeletePermission" - ] - }, - "list": { - "permissions": [ - "ram:ListPermissions", - "ram:ListPermissionVersions" - ] - }, - "read": { - "permissions": [ - "ram:GetPermission" - ] - }, - "update": { - "permissions": [ - "ram:CreatePermissionVersion", - "ram:DeletePermissionVersion", - "ram:SetDefaultPermissionVersion", - "ram:GetPermission", - "ram:ReplacePermissionAssociations", - "ram:ListReplacePermissionAssociationsWork", - "ram:ListPermissionVersions", - "ram:UntagResource", - "ram:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "IsResourceTypeDefault": { - "description": "Set to true to use this as the default permission.", - "type": "boolean" - }, - "Name": { - "description": "The name of the permission.", - "type": "string" - }, - "PermissionType": { - "type": "string" - }, - "PolicyTemplate": { - "description": "Policy template for the permission.", - "type": "object" - }, - "ResourceType": { - "description": "The resource type this permission can be used with.", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Version": { - "description": "Version of the permission.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Version", - "/properties/IsResourceTypeDefault", - "/properties/PermissionType" - ], - "required": [ - "Name", - "ResourceType", - "PolicyTemplate" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ram", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RAM::Permission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ResourceType", + "/properties/PolicyTemplate" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::RAM::Permission", + "handlers": { + "create": { + "permissions": [ + "ram:CreatePermission", + "ram:TagResource" + ] + }, + "delete": { + "permissions": [ + "ram:DeletePermissionVersion", + "ram:DeletePermission" + ] + }, + "list": { + "permissions": [ + "ram:ListPermissions", + "ram:ListPermissionVersions" + ] + }, + "read": { + "permissions": [ + "ram:GetPermission" + ] + }, + "update": { + "permissions": [ + "ram:CreatePermissionVersion", + "ram:DeletePermissionVersion", + "ram:SetDefaultPermissionVersion", + "ram:GetPermission", + "ram:ReplacePermissionAssociations", + "ram:ListReplacePermissionAssociationsWork", + "ram:ListPermissionVersions", + "ram:UntagResource", + "ram:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "IsResourceTypeDefault": { + "description": "Set to true to use this as the default permission.", + "type": "boolean" + }, + "Name": { + "description": "The name of the permission.", + "type": "string" + }, + "PermissionType": { + "type": "string" + }, + "PolicyTemplate": { + "description": "Policy template for the permission.", + "type": "object" + }, + "ResourceType": { + "description": "The resource type this permission can be used with.", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Version": { + "description": "Version of the permission.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Version", + "/properties/IsResourceTypeDefault", + "/properties/PermissionType" + ], + "required": [ + "Name", + "ResourceType", + "PolicyTemplate" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ram", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RAM::Permission" +} diff --git a/schema/aws-ram-resourceshare.json b/schema/aws-ram-resourceshare.json index 1f3070f..bf56638 100644 --- a/schema/aws-ram-resourceshare.json +++ b/schema/aws-ram-resourceshare.json @@ -1,82 +1,82 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::RAM::ResourceShare", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllowExternalPrincipals": { - "type": "boolean" - }, - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "PermissionArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Principals": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ResourceArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Sources": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "typeName": "AWS::RAM::ResourceShare" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::RAM::ResourceShare", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowExternalPrincipals": { + "type": "boolean" + }, + "Arn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "PermissionArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Principals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ResourceArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Sources": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "typeName": "AWS::RAM::ResourceShare" +} diff --git a/schema/aws-rds-customdbengineversion.json b/schema/aws-rds-customdbengineversion.json index de618cf..10478ea 100644 --- a/schema/aws-rds-customdbengineversion.json +++ b/schema/aws-rds-customdbengineversion.json @@ -1,198 +1,198 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Engine", - "/properties/EngineVersion", - "/properties/DatabaseInstallationFilesS3BucketName", - "/properties/DatabaseInstallationFilesS3Prefix", - "/properties/ImageId", - "/properties/KMSKeyId", - "/properties/Manifest", - "/properties/SourceCustomDbEngineVersionIdentifier", - "/properties/UseAwsProvidedLatestImage" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.", - "handlers": { - "create": { - "permissions": [ - "ec2:CopySnapshot", - "ec2:DeleteSnapshot", - "ec2:DescribeSnapshots", - "kms:CreateGrant", - "kms:Decrypt", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:ReEncrypt", - "mediaimport:CreateDatabaseBinarySnapshot", - "rds:AddTagsToResource", - "rds:CreateCustomDBEngineVersion", - "rds:DescribeDBEngineVersions", - "rds:ModifyCustomDBEngineVersion", - "s3:CreateBucket", - "s3:GetObject", - "s3:GetObjectAcl", - "s3:GetObjectTagging", - "s3:ListBucket", - "s3:PutBucketObjectLockConfiguration", - "s3:PutBucketPolicy", - "s3:PutBucketVersioning" - ], - "timeoutInMinutes": 600 - }, - "delete": { - "permissions": [ - "rds:DeleteCustomDBEngineVersion", - "rds:DescribeDBEngineVersions" - ], - "timeoutInMinutes": 600 - }, - "list": { - "permissions": [ - "rds:DescribeDBEngineVersions" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBEngineVersions" - ] - }, - "update": { - "permissions": [ - "rds:AddTagsToResource", - "rds:DescribeDBEngineVersions", - "rds:ModifyCustomDBEngineVersion", - "rds:RemoveTagsFromResource" - ], - "timeoutInMinutes": 600 - } - }, - "primaryIdentifier": [ - "/properties/Engine", - "/properties/EngineVersion" - ], - "properties": { - "DBEngineVersionArn": { - "description": "The ARN of the custom engine version.", - "type": "string" - }, - "DatabaseInstallationFilesS3BucketName": { - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.", - "maxLength": 63, - "minLength": 3, - "type": "string" - }, - "DatabaseInstallationFilesS3Prefix": { - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Description": { - "description": "An optional description of your CEV.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Engine": { - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.", - "maxLength": 35, - "minLength": 1, - "type": "string" - }, - "EngineVersion": { - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.", - "maxLength": 60, - "minLength": 1, - "type": "string" - }, - "ImageId": { - "description": "The identifier of Amazon Machine Image (AMI) used for CEV.", - "type": "string" - }, - "KMSKeyId": { - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Manifest": { - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.", - "maxLength": 51000, - "minLength": 1, - "type": "string" - }, - "SourceCustomDbEngineVersionIdentifier": { - "description": "The identifier of the source custom engine version.", - "type": "string" - }, - "Status": { - "default": "available", - "description": "The availability status to be assigned to the CEV.", - "enum": [ - "available", - "inactive", - "inactive-except-restore" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UseAwsProvidedLatestImage": { - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.", - "type": "boolean" - } - }, - "propertyTransform": { - "/properties/Engine": "$lowercase(Engine)", - "/properties/EngineVersion": "$lowercase(EngineVersion)", - "/properties/KMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KMSKeyId])" - }, - "readOnlyProperties": [ - "/properties/DBEngineVersionArn" - ], - "required": [ - "Engine", - "EngineVersion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::RDS::CustomDBEngineVersion", - "writeOnlyProperties": [ - "/properties/Manifest", - "/properties/SourceCustomDbEngineVersionIdentifier", - "/properties/UseAwsProvidedLatestImage" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Engine", + "/properties/EngineVersion", + "/properties/DatabaseInstallationFilesS3BucketName", + "/properties/DatabaseInstallationFilesS3Prefix", + "/properties/ImageId", + "/properties/KMSKeyId", + "/properties/Manifest", + "/properties/SourceCustomDbEngineVersionIdentifier", + "/properties/UseAwsProvidedLatestImage" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.", + "handlers": { + "create": { + "permissions": [ + "ec2:CopySnapshot", + "ec2:DeleteSnapshot", + "ec2:DescribeSnapshots", + "kms:CreateGrant", + "kms:Decrypt", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:ReEncrypt", + "mediaimport:CreateDatabaseBinarySnapshot", + "rds:AddTagsToResource", + "rds:CreateCustomDBEngineVersion", + "rds:DescribeDBEngineVersions", + "rds:ModifyCustomDBEngineVersion", + "s3:CreateBucket", + "s3:GetObject", + "s3:GetObjectAcl", + "s3:GetObjectTagging", + "s3:ListBucket", + "s3:PutBucketObjectLockConfiguration", + "s3:PutBucketPolicy", + "s3:PutBucketVersioning" + ], + "timeoutInMinutes": 600 + }, + "delete": { + "permissions": [ + "rds:DeleteCustomDBEngineVersion", + "rds:DescribeDBEngineVersions" + ], + "timeoutInMinutes": 600 + }, + "list": { + "permissions": [ + "rds:DescribeDBEngineVersions" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBEngineVersions" + ] + }, + "update": { + "permissions": [ + "rds:AddTagsToResource", + "rds:DescribeDBEngineVersions", + "rds:ModifyCustomDBEngineVersion", + "rds:RemoveTagsFromResource" + ], + "timeoutInMinutes": 600 + } + }, + "primaryIdentifier": [ + "/properties/Engine", + "/properties/EngineVersion" + ], + "properties": { + "DBEngineVersionArn": { + "description": "The ARN of the custom engine version.", + "type": "string" + }, + "DatabaseInstallationFilesS3BucketName": { + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.", + "maxLength": 63, + "minLength": 3, + "type": "string" + }, + "DatabaseInstallationFilesS3Prefix": { + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Description": { + "description": "An optional description of your CEV.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Engine": { + "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.", + "maxLength": 35, + "minLength": 1, + "type": "string" + }, + "EngineVersion": { + "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.", + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "ImageId": { + "description": "The identifier of Amazon Machine Image (AMI) used for CEV.", + "type": "string" + }, + "KMSKeyId": { + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Manifest": { + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.", + "maxLength": 51000, + "minLength": 1, + "type": "string" + }, + "SourceCustomDbEngineVersionIdentifier": { + "description": "The identifier of the source custom engine version.", + "type": "string" + }, + "Status": { + "default": "available", + "description": "The availability status to be assigned to the CEV.", + "enum": [ + "available", + "inactive", + "inactive-except-restore" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UseAwsProvidedLatestImage": { + "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.", + "type": "boolean" + } + }, + "propertyTransform": { + "/properties/Engine": "$lowercase(Engine)", + "/properties/EngineVersion": "$lowercase(EngineVersion)", + "/properties/KMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KMSKeyId])" + }, + "readOnlyProperties": [ + "/properties/DBEngineVersionArn" + ], + "required": [ + "Engine", + "EngineVersion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": true + }, + "typeName": "AWS::RDS::CustomDBEngineVersion", + "writeOnlyProperties": [ + "/properties/Manifest", + "/properties/SourceCustomDbEngineVersionIdentifier", + "/properties/UseAwsProvidedLatestImage" + ] +} diff --git a/schema/aws-rds-dbcluster.json b/schema/aws-rds-dbcluster.json index c34277c..3c192bf 100644 --- a/schema/aws-rds-dbcluster.json +++ b/schema/aws-rds-dbcluster.json @@ -1,555 +1,552 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/Engine", - "/properties/GlobalClusterIdentifier", - "/properties/MasterUsername" - ], - "createOnlyProperties": [ - "/properties/AvailabilityZones", - "/properties/DBClusterIdentifier", - "/properties/DBSubnetGroupName", - "/properties/DBSystemId", - "/properties/DatabaseName", - "/properties/EngineMode", - "/properties/KmsKeyId", - "/properties/PubliclyAccessible", - "/properties/RestoreToTime", - "/properties/RestoreType", - "/properties/SnapshotIdentifier", - "/properties/SourceDBClusterIdentifier", - "/properties/SourceRegion", - "/properties/StorageEncrypted", - "/properties/UseLatestRestorableTime" - ], - "definitions": { - "DBClusterRole": { - "additionalProperties": false, - "description": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", - "properties": { - "FeatureName": { - "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Endpoint": { - "additionalProperties": false, - "description": "The ``Endpoint`` return value specifies the connection endpoint for the primary instance of the DB cluster.", - "properties": { - "Address": { - "description": "Specifies the connection endpoint for the primary instance of the DB cluster.", - "type": "string" - }, - "Port": { - "description": "Specifies the port that the database engine is listening on.", - "type": "string" - } - }, - "type": "object" - }, - "MasterUserSecret": { - "additionalProperties": false, - "description": "The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", - "properties": { - "KmsKeyId": { - "description": "The AWS KMS key identifier that is used to encrypt the secret.", - "type": "string" - }, - "SecretArn": { - "description": "The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values).", - "type": "string" - } - }, - "type": "object" - }, - "ReadEndpoint": { - "additionalProperties": false, - "description": "The ``ReadEndpoint`` return value specifies the reader endpoint for the DB cluster.\n The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.\n If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.\n For more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Address": { - "description": "The host address of the reader endpoint.", - "type": "string" - } - }, - "type": "object" - }, - "ScalingConfiguration": { - "additionalProperties": false, - "description": "The ``ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster. \n For more information, see [Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*.\n This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.\n Valid for: Aurora Serverless v1 DB clusters only", - "properties": { - "AutoPause": { - "description": "Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in ``serverless`` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).\n If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.", - "type": "boolean" - }, - "MaxCapacity": { - "description": "The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.\n For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.\n For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.\n The maximum capacity must be greater than or equal to the minimum capacity.", - "type": "integer" - }, - "MinCapacity": { - "description": "The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.\n For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.\n For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.\n The minimum capacity must be less than or equal to the maximum capacity.", - "type": "integer" - }, - "SecondsBeforeTimeout": { - "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.\n Specify a value between 60 and 600 seconds.", - "type": "integer" - }, - "SecondsUntilAutoPause": { - "description": "The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.\n Specify a value between 300 and 86,400 seconds.", - "type": "integer" - }, - "TimeoutAction": { - "description": "The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``.\n ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.\n ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.\n If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.\n For more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*.", - "type": "string" - } - }, - "type": "object" - }, - "ServerlessV2ScalingConfiguration": { - "additionalProperties": false, - "description": "The ``ServerlessV2ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.\n If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the ``db.serverless`` DB instance class. For more information, see [Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in the *Amazon Aurora User Guide*.\n This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the ``ScalingConfiguration`` property.\n Valid for: Aurora Serverless v2 DB clusters", - "properties": { - "MaxCapacity": { - "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.\n The maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*.\n Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ``ParameterApplyStatus`` value for the DB instance changes to ``pending-reboot``. You can update the parameter values by rebooting the DB instance after changing the capacity range.", - "type": "number" - }, - "MinCapacity": { - "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.", - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::DBCluster`` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.\n For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\n For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.\n You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.\n *Updating DB clusters* \n When properties labeled \"*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.\n We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:\n 1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.\n 1. Create a snapshot of the DB cluster. For more information, see [Creating a DB Cluster Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).\n 1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.\n After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.\n 1. Update the stack.\n \n Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: ``PreferredBackupWindow``, ``PreferredMaintenanceWindow``, and ``Port``. This limitation doesn't apply to provisioned DB clusters.\n For more information about updating other properties of this resource, see ``ModifyDBCluster``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n *Deleting DB clusters* \n The default ``DeletionPolicy`` for ``AWS::RDS::DBCluster`` resources is ``Snapshot``. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "rds:AddRoleToDBCluster", - "rds:AddTagsToResource", - "rds:CreateDBCluster", - "rds:CreateDBInstance", - "rds:DescribeDBClusters", - "rds:DescribeDBClusterSnapshots", - "rds:DescribeDBSnapshots", - "rds:DescribeEvents", - "rds:EnableHttpEndpoint", - "rds:ModifyDBCluster", - "rds:RestoreDBClusterFromSnapshot", - "rds:RestoreDBClusterToPointInTime", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "rds:AddTagsToResource", - "rds:CreateDBClusterSnapshot", - "rds:DeleteDBCluster", - "rds:DeleteDBInstance", - "rds:DescribeDBClusters", - "rds:DescribeGlobalClusters", - "rds:RemoveFromGlobalCluster" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBClusters" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBClusters" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeSecurityGroups", - "iam:PassRole", - "rds:AddRoleToDBCluster", - "rds:AddTagsToResource", - "rds:DescribeDBClusters", - "rds:DescribeDBSubnetGroups", - "rds:DescribeEvents", - "rds:DescribeGlobalClusters", - "rds:DisableHttpEndpoint", - "rds:EnableHttpEndpoint", - "rds:ModifyDBCluster", - "rds:ModifyDBInstance", - "rds:RemoveFromGlobalCluster", - "rds:RemoveRoleFromDBCluster", - "rds:RemoveTagsFromResource", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DBClusterIdentifier" - ], - "properties": { - "AllocatedStorage": { - "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only\n This setting is required to create a Multi-AZ DB cluster.", - "type": "integer" - }, - "AssociatedRoles": { - "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "items": { - "$ref": "#/definitions/DBClusterRole" - }, - "type": "array", - "uniqueItems": true - }, - "AutoMinorVersionUpgrade": { - "description": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.\n Valid for Cluster Type: Multi-AZ DB clusters only", - "type": "boolean" - }, - "AvailabilityZones": { - "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*. \n Valid for: Aurora DB clusters only", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "BacktrackWindow": { - "description": "The target backtrack window, in seconds. To disable backtracking, set this value to 0. \n Currently, Backtrack is only supported for Aurora MySQL DB clusters.\n Default: 0\n Constraints:\n + If specified, this value must be set to a number from 0 to 259,200 (72 hours).\n \n Valid for: Aurora MySQL DB clusters only", - "minimum": 0, - "type": "integer" - }, - "BackupRetentionPeriod": { - "default": 1, - "description": "The number of days for which automated backups are retained.\n Default: 1\n Constraints:\n + Must be a value from 1 to 35\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "minimum": 1, - "type": "integer" - }, - "CopyTagsToSnapshot": { - "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "boolean" - }, - "DBClusterArn": { - "description": "", - "type": "string" - }, - "DBClusterIdentifier": { - "description": "The DB cluster identifier. This parameter is stored as a lowercase string.\n Constraints:\n + Must contain from 1 to 63 letters, numbers, or hyphens.\n + First character must be a letter.\n + Can't end with a hyphen or contain two consecutive hyphens.\n \n Example: ``my-cluster1`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "DBClusterInstanceClass": { - "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ``db.m6gd.xlarge``. Not all DB instance classes are available in all AWS-Regions, or for all database engines.\n For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.\n This setting is required to create a Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only", - "type": "string" - }, - "DBClusterParameterGroupName": { - "default": "default.aurora5.6", - "description": "The name of the DB cluster parameter group to associate with this DB cluster.\n If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.\n To list all of the available DB cluster parameter group names, use the following command:\n ``aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "DBClusterResourceId": { - "description": "", - "type": "string" - }, - "DBInstanceParameterGroupName": { - "description": "The name of the DB parameter group to apply to all instances of the DB cluster.\n When you apply a parameter group using the ``DBInstanceParameterGroupName`` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.\n Valid for Cluster Type: Aurora DB clusters only\n Default: The existing name setting\n Constraints:\n + The DB parameter group must be in the same DB parameter group family as this DB cluster.\n + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.", - "type": "string" - }, - "DBSubnetGroupName": { - "description": "A DB subnet group that you want to associate with this DB cluster. \n If you are restoring a DB cluster to a point in time with ``RestoreType`` set to ``copy-on-write``, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "DBSystemId": { - "description": "Reserved for future use.", - "type": "string" - }, - "DatabaseName": { - "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "DeletionProtection": { - "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "boolean" - }, - "Domain": { - "description": "Indicates the directory ID of the Active Directory to create the DB cluster.\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.\n For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.\n Valid for: Aurora DB clusters only", - "type": "string" - }, - "DomainIAMRoleName": { - "description": "Specifies the name of the IAM role to use when making API calls to the Directory Service.\n Valid for: Aurora DB clusters only", - "type": "string" - }, - "EnableCloudwatchLogsExports": { - "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.\n *Aurora MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Aurora PostgreSQL* \n Valid values: ``postgresql`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "EnableGlobalWriteForwarding": { - "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.\n You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.\n Valid for Cluster Type: Aurora DB clusters only", - "type": "boolean" - }, - "EnableHttpEndpoint": { - "description": "Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.\n When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.\n RDS Data API is supported with the following DB clusters:\n + Aurora PostgreSQL Serverless v2 and provisioned\n + Aurora PostgreSQL and Aurora MySQL Serverless v1\n \n For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.\n Valid for Cluster Type: Aurora DB clusters only", - "type": "boolean" - }, - "EnableIAMDatabaseAuthentication": { - "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.* \n Valid for: Aurora DB clusters only", - "type": "boolean" - }, - "EnableLocalWriteForwarding": { - "description": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.\n Valid for: Aurora DB clusters only", - "type": "boolean" - }, - "Endpoint": { - "$ref": "#/definitions/Endpoint", - "description": "" - }, - "Engine": { - "description": "The name of the database engine to be used for this DB cluster.\n Valid Values:\n + ``aurora-mysql`` \n + ``aurora-postgresql`` \n + ``mysql`` \n + ``postgres`` \n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "EngineLifecycleSupport": { - "description": "The life cycle type for this DB cluster.\n By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.\n You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:\n + Amazon Aurora (PostgreSQL only) - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* \n + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* \n \n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` \n Default: ``open-source-rds-extended-support``", - "type": "string" - }, - "EngineMode": { - "description": "The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.\n The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.\n For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:\n + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) \n \n Valid for Cluster Type: Aurora DB clusters only", - "type": "string" - }, - "EngineVersion": { - "description": "The version number of the database engine to use.\n To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:\n ``aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"`` \n You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.\n To list all of the available engine versions for Aurora PostgreSQL, use the following command:\n ``aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"`` \n To list all of the available engine versions for RDS for MySQL, use the following command:\n ``aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"`` \n To list all of the available engine versions for RDS for PostgreSQL, use the following command:\n ``aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"`` \n *Aurora MySQL* \n For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.\n *Aurora PostgreSQL* \n For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.\n *MySQL* \n For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.\n *PostgreSQL* \n For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "GlobalClusterIdentifier": { - "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource. \n If you aren't configuring a global database cluster, don't specify this property. \n To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.\n For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*.\n Valid for: Aurora DB clusters only", - "maxLength": 63, - "minLength": 0, - "pattern": "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "Iops": { - "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.\n For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n This setting is required to create a Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Constraints:\n + Must be a multiple between .5 and 50 of the storage amount for the DB cluster.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the ``StorageEncrypted`` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the ``StorageEncrypted`` property to ``true``.\n If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.\n If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set ``KmsKeyId`` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "ManageMasterUserPassword": { - "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* \n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.", - "type": "boolean" - }, - "MasterUserPassword": { - "description": "The master password for the DB instance.\n If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "MasterUserSecret": { - "$ref": "#/definitions/MasterUserSecret", - "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*" - }, - "MasterUsername": { - "description": "The name of the master user for the DB cluster.\n If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "minLength": 1, - "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9_]*$", - "type": "string" - }, - "MonitoringInterval": { - "default": 0, - "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ``0``.\n If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` \n Default: ``0``", - "type": "integer" - }, - "MonitoringRoleArn": { - "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value.\n Valid for Cluster Type: Multi-AZ DB clusters only", - "type": "string" - }, - "NetworkType": { - "description": "The network type of the DB cluster.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB cluster. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* \n Valid for: Aurora DB clusters only", - "type": "string" - }, - "PerformanceInsightsEnabled": { - "description": "Specifies whether to turn on Performance Insights for the DB cluster.\n For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n Valid for Cluster Type: Multi-AZ DB clusters only", - "type": "boolean" - }, - "PerformanceInsightsKmsKeyId": { - "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you don't specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS-account. Your AWS-account has a different default KMS key for each AWS-Region.\n Valid for Cluster Type: Multi-AZ DB clusters only", - "type": "string" - }, - "PerformanceInsightsRetentionPeriod": { - "description": "The number of days to retain Performance Insights data.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error.", - "type": "integer" - }, - "Port": { - "description": "The port number on which the DB instances in the DB cluster accept connections.\n Default:\n + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL)\n + When ``EngineMode`` is ``serverless``:\n + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` \n + ``5432`` when ``Engine`` is ``aurora-postgresql`` \n \n \n The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "integer" - }, - "PreferredBackupWindow": { - "description": "The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.* \n Constraints:\n + Must be in the format ``hh24:mi-hh24:mi``.\n + Must be in Universal Coordinated Time (UTC).\n + Must not conflict with the preferred maintenance window.\n + Must be at least 30 minutes.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.* \n Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\n Constraints: Minimum 30-minute window.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "PubliclyAccessible": { - "description": "Specifies whether the DB cluster is publicly accessible.\n When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.\n When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.\n If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies:\n + If the default VPC in the target Region doesn\u2019t have an internet gateway attached to it, the DB cluster is private.\n + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.\n \n If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies:\n + If the subnets are part of a VPC that doesn\u2019t have an internet gateway attached to it, the DB cluster is private.\n + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.", - "type": "boolean" - }, - "ReadEndpoint": { - "$ref": "#/definitions/ReadEndpoint", - "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:\n + ``CreateDBInstance`` \n + ``DescribeDBInstances`` \n + ``DeleteDBInstance`` \n \n For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``." - }, - "ReplicationSourceIdentifier": { - "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.\n Valid for: Aurora DB clusters only", - "type": "string" - }, - "RestoreToTime": { - "description": "The date and time to restore the DB cluster to.\n Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n Constraints:\n + Must be before the latest restorable time for the DB instance\n + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided\n + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled\n + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` \n \n This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property.\n Example: ``2015-03-07T23:45:00Z`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "RestoreType": { - "default": "full-copy", - "description": "The type of restore to be performed. You can specify one of the following values:\n + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.\n + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.\n \n If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "ScalingConfiguration": { - "$ref": "#/definitions/ScalingConfiguration", - "description": "The scaling configuration of an Aurora Serverless v1 DB cluster.\n This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.\n Valid for: Aurora Serverless v1 DB clusters only" - }, - "ServerlessV2ScalingConfiguration": { - "$ref": "#/definitions/ServerlessV2ScalingConfiguration", - "description": "The scaling configuration of an Aurora Serverless V2 DB cluster. \n This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.\n Valid for: Aurora Serverless v2 DB clusters only" - }, - "SnapshotIdentifier": { - "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.\n You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\n After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.\n If you specify the ``SnapshotIdentifier`` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:\n + ``GlobalClusterIdentifier`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``ReplicationSourceIdentifier`` \n + ``RestoreType`` \n + ``SourceDBClusterIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``UseLatestRestorableTime`` \n \n Constraints:\n + Must match the identifier of an existing Snapshot.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "SourceDBClusterIdentifier": { - "description": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.\n Constraints:\n + Must match the identifier of an existing DBCluster.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "string" - }, - "SourceRegion": { - "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``. \n Valid for: Aurora DB clusters only", - "type": "string" - }, - "StorageEncrypted": { - "description": "Indicates whether the DB cluster is encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.\n If you specify the ``SnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to ``false``.\n If you specify both the ``StorageEncrypted`` and ``SnapshotIdentifier`` properties without specifying the ``KmsKeyId`` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "boolean" - }, - "StorageThroughput": { - "description": "", - "type": "integer" - }, - "StorageType": { - "description": "The storage type to associate with the DB cluster.\n For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).\n This setting is required to create a Multi-AZ DB cluster.\n When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.\n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Valid Values:\n + Aurora DB clusters - ``aurora | aurora-iopt1`` \n + Multi-AZ DB clusters - ``io1 | io2 | gp3`` \n \n Default:\n + Aurora DB clusters - ``aurora`` \n + Multi-AZ DB clusters - ``io1`` \n \n When you create an Aurora DB cluster with the storage type set to ``aurora-iopt1``, the storage type is returned in the response. The storage type isn't returned when you set it to ``aurora``.", - "type": "string" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this DB cluster.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UseLatestRestorableTime": { - "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "description": "A list of EC2 VPC security groups to associate with this DB cluster.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", - "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)", - "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", - "/properties/EnableHttpEndpoint": "$lowercase($string(EngineMode)) = 'serverless' ? EnableHttpEndpoint : ($lowercase($string(Engine)) = 'aurora-postgresql' ? EnableHttpEndpoint : false )", - "/properties/Engine": "$lowercase(Engine)", - "/properties/EngineVersion": "$join([$string(EngineVersion), \".*\"])", - "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", - "/properties/MasterUserSecret/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", MasterUserSecret.KmsKeyId])", - "/properties/NetworkType": "$lowercase(NetworkType)", - "/properties/PerformanceInsightsKmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", PerformanceInsightsKmsKeyId])", - "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)", - "/properties/SnapshotIdentifier": "$lowercase(SnapshotIdentifier)", - "/properties/SourceDBClusterIdentifier": "$lowercase(SourceDBClusterIdentifier)", - "/properties/StorageType": "$lowercase(StorageType)" - }, - "readOnlyProperties": [ - "/properties/DBClusterArn", - "/properties/DBClusterResourceId", - "/properties/Endpoint", - "/properties/Endpoint/Address", - "/properties/Endpoint/Port", - "/properties/ReadEndpoint/Address", - "/properties/MasterUserSecret/SecretArn", - "/properties/StorageThroughput" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RDS::DBCluster", - "writeOnlyProperties": [ - "/properties/DBInstanceParameterGroupName", - "/properties/MasterUserPassword", - "/properties/RestoreToTime", - "/properties/RestoreType", - "/properties/SnapshotIdentifier", - "/properties/SourceDBClusterIdentifier", - "/properties/SourceRegion", - "/properties/UseLatestRestorableTime" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/Engine", + "/properties/GlobalClusterIdentifier", + "/properties/MasterUsername" + ], + "createOnlyProperties": [ + "/properties/AvailabilityZones", + "/properties/DBClusterIdentifier", + "/properties/DBSubnetGroupName", + "/properties/DBSystemId", + "/properties/DatabaseName", + "/properties/EngineMode", + "/properties/KmsKeyId", + "/properties/PubliclyAccessible", + "/properties/RestoreToTime", + "/properties/RestoreType", + "/properties/SnapshotIdentifier", + "/properties/SourceDBClusterIdentifier", + "/properties/SourceRegion", + "/properties/StorageEncrypted", + "/properties/UseLatestRestorableTime" + ], + "definitions": { + "DBClusterRole": { + "additionalProperties": false, + "description": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", + "properties": { + "FeatureName": { + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "Endpoint": { + "additionalProperties": false, + "description": "The ``Endpoint`` return value specifies the connection endpoint for the primary instance of the DB cluster.", + "properties": { + "Address": { + "description": "Specifies the connection endpoint for the primary instance of the DB cluster.", + "type": "string" + }, + "Port": { + "description": "Specifies the port that the database engine is listening on.", + "type": "string" + } + }, + "type": "object" + }, + "MasterUserSecret": { + "additionalProperties": false, + "description": "The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", + "properties": { + "KmsKeyId": { + "description": "The AWS KMS key identifier that is used to encrypt the secret.", + "type": "string" + }, + "SecretArn": { + "description": "The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values).", + "type": "string" + } + }, + "type": "object" + }, + "ReadEndpoint": { + "additionalProperties": false, + "description": "The ``ReadEndpoint`` return value specifies the reader endpoint for the DB cluster.\n The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.\n If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.\n For more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Address": { + "description": "The host address of the reader endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "ScalingConfiguration": { + "additionalProperties": false, + "description": "The ``ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster. \n For more information, see [Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*.\n This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.\n Valid for: Aurora Serverless v1 DB clusters only", + "properties": { + "AutoPause": { + "description": "Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in ``serverless`` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).\n If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.", + "type": "boolean" + }, + "MaxCapacity": { + "description": "The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.\n For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.\n For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.\n The maximum capacity must be greater than or equal to the minimum capacity.", + "type": "integer" + }, + "MinCapacity": { + "description": "The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.\n For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.\n For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.\n The minimum capacity must be less than or equal to the maximum capacity.", + "type": "integer" + }, + "SecondsBeforeTimeout": { + "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.\n Specify a value between 60 and 600 seconds.", + "type": "integer" + }, + "SecondsUntilAutoPause": { + "description": "The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.\n Specify a value between 300 and 86,400 seconds.", + "type": "integer" + }, + "TimeoutAction": { + "description": "The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``.\n ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.\n ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.\n If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.\n For more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*.", + "type": "string" + } + }, + "type": "object" + }, + "ServerlessV2ScalingConfiguration": { + "additionalProperties": false, + "description": "The ``ServerlessV2ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.\n If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the ``db.serverless`` DB instance class. For more information, see [Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in the *Amazon Aurora User Guide*.\n This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the ``ScalingConfiguration`` property.\n Valid for: Aurora Serverless v2 DB clusters", + "properties": { + "MaxCapacity": { + "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.\n The maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*.\n Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ``ParameterApplyStatus`` value for the DB instance changes to ``pending-reboot``. You can update the parameter values by rebooting the DB instance after changing the capacity range.", + "type": "number" + }, + "MinCapacity": { + "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.", + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::DBCluster`` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.\n For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\n For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.\n You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.\n *Updating DB clusters* \n When properties labeled \"*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.\n We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:\n 1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.\n 1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).\n 1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.\n After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.\n 1. Update the stack.\n \n Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: ``PreferredBackupWindow``, ``PreferredMaintenanceWindow``, and ``Port``. This limitation doesn't apply to provisioned DB clusters.\n For more information about updating other properties of this resource, see ``ModifyDBCluster``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n *Deleting DB clusters* \n The default ``DeletionPolicy`` for ``AWS::RDS::DBCluster`` resources is ``Snapshot``. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "rds:AddRoleToDBCluster", + "rds:AddTagsToResource", + "rds:CreateDBCluster", + "rds:CreateDBInstance", + "rds:DescribeDBClusters", + "rds:DescribeDBClusterSnapshots", + "rds:DescribeDBSnapshots", + "rds:DescribeEvents", + "rds:EnableHttpEndpoint", + "rds:ModifyDBCluster", + "rds:RestoreDBClusterFromSnapshot", + "rds:RestoreDBClusterToPointInTime", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "rds:AddTagsToResource", + "rds:CreateDBClusterSnapshot", + "rds:DeleteDBCluster", + "rds:DeleteDBInstance", + "rds:DescribeDBClusters", + "rds:DescribeGlobalClusters", + "rds:RemoveFromGlobalCluster" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBClusters" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBClusters" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "iam:PassRole", + "rds:AddRoleToDBCluster", + "rds:AddTagsToResource", + "rds:DescribeDBClusters", + "rds:DescribeDBSubnetGroups", + "rds:DescribeEvents", + "rds:DescribeGlobalClusters", + "rds:DisableHttpEndpoint", + "rds:EnableHttpEndpoint", + "rds:ModifyDBCluster", + "rds:ModifyDBInstance", + "rds:RemoveFromGlobalCluster", + "rds:RemoveRoleFromDBCluster", + "rds:RemoveTagsFromResource", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DBClusterIdentifier" + ], + "properties": { + "AllocatedStorage": { + "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only\n This setting is required to create a Multi-AZ DB cluster.", + "type": "integer" + }, + "AssociatedRoles": { + "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "items": { + "$ref": "#/definitions/DBClusterRole" + }, + "type": "array", + "uniqueItems": true + }, + "AutoMinorVersionUpgrade": { + "description": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.\n Valid for Cluster Type: Multi-AZ DB clusters only", + "type": "boolean" + }, + "AvailabilityZones": { + "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*. \n Valid for: Aurora DB clusters only", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "BacktrackWindow": { + "description": "The target backtrack window, in seconds. To disable backtracking, set this value to ``0``.\n Valid for Cluster Type: Aurora MySQL DB clusters only\n Default: ``0`` \n Constraints:\n + If specified, this value must be set to a number from 0 to 259,200 (72 hours).", + "minimum": 0, + "type": "integer" + }, + "BackupRetentionPeriod": { + "default": 1, + "description": "The number of days for which automated backups are retained.\n Default: 1\n Constraints:\n + Must be a value from 1 to 35\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "minimum": 1, + "type": "integer" + }, + "CopyTagsToSnapshot": { + "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "boolean" + }, + "DBClusterArn": { + "description": "", + "type": "string" + }, + "DBClusterIdentifier": { + "description": "The DB cluster identifier. This parameter is stored as a lowercase string.\n Constraints:\n + Must contain from 1 to 63 letters, numbers, or hyphens.\n + First character must be a letter.\n + Can't end with a hyphen or contain two consecutive hyphens.\n \n Example: ``my-cluster1`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "DBClusterInstanceClass": { + "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ``db.m6gd.xlarge``. Not all DB instance classes are available in all AWS-Regions, or for all database engines.\n For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.\n This setting is required to create a Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only", + "type": "string" + }, + "DBClusterParameterGroupName": { + "description": "The name of the DB cluster parameter group to associate with this DB cluster.\n If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.\n To list all of the available DB cluster parameter group names, use the following command:\n ``aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "DBClusterResourceId": { + "description": "", + "type": "string" + }, + "DBInstanceParameterGroupName": { + "description": "The name of the DB parameter group to apply to all instances of the DB cluster.\n When you apply a parameter group using the ``DBInstanceParameterGroupName`` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.\n Valid for Cluster Type: Aurora DB clusters only\n Default: The existing name setting\n Constraints:\n + The DB parameter group must be in the same DB parameter group family as this DB cluster.\n + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.", + "type": "string" + }, + "DBSubnetGroupName": { + "description": "A DB subnet group that you want to associate with this DB cluster. \n If you are restoring a DB cluster to a point in time with ``RestoreType`` set to ``copy-on-write``, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "DBSystemId": { + "description": "Reserved for future use.", + "type": "string" + }, + "DatabaseName": { + "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "DeletionProtection": { + "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "boolean" + }, + "Domain": { + "description": "Indicates the directory ID of the Active Directory to create the DB cluster.\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.\n For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.\n Valid for: Aurora DB clusters only", + "type": "string" + }, + "DomainIAMRoleName": { + "description": "Specifies the name of the IAM role to use when making API calls to the Directory Service.\n Valid for: Aurora DB clusters only", + "type": "string" + }, + "EnableCloudwatchLogsExports": { + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.\n *Aurora MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Aurora PostgreSQL* \n Valid values: ``postgresql`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "EnableGlobalWriteForwarding": { + "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.\n You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.\n Valid for Cluster Type: Aurora DB clusters only", + "type": "boolean" + }, + "EnableHttpEndpoint": { + "description": "Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.\n When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.\n RDS Data API is supported with the following DB clusters:\n + Aurora PostgreSQL Serverless v2 and provisioned\n + Aurora PostgreSQL and Aurora MySQL Serverless v1\n \n For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.\n Valid for Cluster Type: Aurora DB clusters only", + "type": "boolean" + }, + "EnableIAMDatabaseAuthentication": { + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.* \n Valid for: Aurora DB clusters only", + "type": "boolean" + }, + "EnableLocalWriteForwarding": { + "description": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.\n Valid for: Aurora DB clusters only", + "type": "boolean" + }, + "Endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "" + }, + "Engine": { + "description": "The name of the database engine to be used for this DB cluster.\n Valid Values:\n + ``aurora-mysql`` \n + ``aurora-postgresql`` \n + ``mysql`` \n + ``postgres`` \n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "EngineLifecycleSupport": { + "description": "The life cycle type for this DB cluster.\n By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.\n You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:\n + Amazon Aurora (PostgreSQL only) - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* \n + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* \n \n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` \n Default: ``open-source-rds-extended-support``", + "type": "string" + }, + "EngineMode": { + "description": "The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.\n The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.\n For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:\n + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) \n \n Valid for Cluster Type: Aurora DB clusters only", + "type": "string" + }, + "EngineVersion": { + "description": "The version number of the database engine to use.\n To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:\n ``aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"`` \n You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.\n To list all of the available engine versions for Aurora PostgreSQL, use the following command:\n ``aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"`` \n To list all of the available engine versions for RDS for MySQL, use the following command:\n ``aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"`` \n To list all of the available engine versions for RDS for PostgreSQL, use the following command:\n ``aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"`` \n *Aurora MySQL* \n For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.\n *Aurora PostgreSQL* \n For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.\n *MySQL* \n For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.\n *PostgreSQL* \n For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "GlobalClusterIdentifier": { + "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource. \n If you aren't configuring a global database cluster, don't specify this property. \n To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.\n For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*.\n Valid for: Aurora DB clusters only", + "maxLength": 63, + "minLength": 0, + "pattern": "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "Iops": { + "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.\n For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n This setting is required to create a Multi-AZ DB cluster.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Constraints:\n + Must be a multiple between .5 and 50 of the storage amount for the DB cluster.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the ``StorageEncrypted`` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the ``StorageEncrypted`` property to ``true``.\n If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.\n If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set ``KmsKeyId`` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "ManageMasterUserPassword": { + "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* \n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.", + "type": "boolean" + }, + "MasterUserPassword": { + "description": "The master password for the DB instance.\n If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "MasterUserSecret": { + "$ref": "#/definitions/MasterUserSecret", + "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*" + }, + "MasterUsername": { + "description": "The name of the master user for the DB cluster.\n If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "minLength": 1, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9_]*$", + "type": "string" + }, + "MonitoringInterval": { + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ``0``.\n If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` \n Default: ``0``", + "type": "integer" + }, + "MonitoringRoleArn": { + "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value.\n Valid for Cluster Type: Multi-AZ DB clusters only", + "type": "string" + }, + "NetworkType": { + "description": "The network type of the DB cluster.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB cluster. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* \n Valid for: Aurora DB clusters only", + "type": "string" + }, + "PerformanceInsightsEnabled": { + "description": "Specifies whether to turn on Performance Insights for the DB cluster.\n For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n Valid for Cluster Type: Multi-AZ DB clusters only", + "type": "boolean" + }, + "PerformanceInsightsKmsKeyId": { + "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you don't specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS-account. Your AWS-account has a different default KMS key for each AWS-Region.\n Valid for Cluster Type: Multi-AZ DB clusters only", + "type": "string" + }, + "PerformanceInsightsRetentionPeriod": { + "description": "The number of days to retain Performance Insights data.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error.", + "type": "integer" + }, + "Port": { + "description": "The port number on which the DB instances in the DB cluster accept connections.\n Default:\n + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL)\n + When ``EngineMode`` is ``serverless``:\n + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` \n + ``5432`` when ``Engine`` is ``aurora-postgresql`` \n \n \n The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "integer" + }, + "PreferredBackupWindow": { + "description": "The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.* \n Constraints:\n + Must be in the format ``hh24:mi-hh24:mi``.\n + Must be in Universal Coordinated Time (UTC).\n + Must not conflict with the preferred maintenance window.\n + Must be at least 30 minutes.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.* \n Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\n Constraints: Minimum 30-minute window.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "PubliclyAccessible": { + "description": "Specifies whether the DB cluster is publicly accessible.\n When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.\n When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.\n Valid for Cluster Type: Multi-AZ DB clusters only\n Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.\n If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies:\n + If the default VPC in the target Region doesn\u2019t have an internet gateway attached to it, the DB cluster is private.\n + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.\n \n If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies:\n + If the subnets are part of a VPC that doesn\u2019t have an internet gateway attached to it, the DB cluster is private.\n + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.", + "type": "boolean" + }, + "ReadEndpoint": { + "$ref": "#/definitions/ReadEndpoint", + "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:\n + ``CreateDBInstance`` \n + ``DescribeDBInstances`` \n + ``DeleteDBInstance`` \n \n For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``." + }, + "ReplicationSourceIdentifier": { + "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.\n Valid for: Aurora DB clusters only", + "type": "string" + }, + "RestoreToTime": { + "description": "The date and time to restore the DB cluster to.\n Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n Constraints:\n + Must be before the latest restorable time for the DB instance\n + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided\n + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled\n + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` \n \n This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property.\n Example: ``2015-03-07T23:45:00Z`` \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "RestoreType": { + "description": "The type of restore to be performed. You can specify one of the following values:\n + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.\n + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.\n \n If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "ScalingConfiguration": { + "$ref": "#/definitions/ScalingConfiguration", + "description": "The scaling configuration of an Aurora Serverless v1 DB cluster.\n This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.\n Valid for: Aurora Serverless v1 DB clusters only" + }, + "ServerlessV2ScalingConfiguration": { + "$ref": "#/definitions/ServerlessV2ScalingConfiguration", + "description": "The scaling configuration of an Aurora Serverless V2 DB cluster. \n This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.\n Valid for: Aurora Serverless v2 DB clusters only" + }, + "SnapshotIdentifier": { + "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.\n You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\n After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.\n If you specify the ``SnapshotIdentifier`` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:\n + ``GlobalClusterIdentifier`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``ReplicationSourceIdentifier`` \n + ``RestoreType`` \n + ``SourceDBClusterIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``UseLatestRestorableTime`` \n \n Constraints:\n + Must match the identifier of an existing Snapshot.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "SourceDBClusterIdentifier": { + "description": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.\n Constraints:\n + Must match the identifier of an existing DBCluster.\n \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "string" + }, + "SourceRegion": { + "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``. \n Valid for: Aurora DB clusters only", + "type": "string" + }, + "StorageEncrypted": { + "description": "Indicates whether the DB cluster is encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.\n If you specify the ``SnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to ``false``.\n If you specify both the ``StorageEncrypted`` and ``SnapshotIdentifier`` properties without specifying the ``KmsKeyId`` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "boolean" + }, + "StorageThroughput": { + "description": "", + "type": "integer" + }, + "StorageType": { + "description": "The storage type to associate with the DB cluster.\n For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).\n This setting is required to create a Multi-AZ DB cluster.\n When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.\n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters\n Valid Values:\n + Aurora DB clusters - ``aurora | aurora-iopt1`` \n + Multi-AZ DB clusters - ``io1 | io2 | gp3`` \n \n Default:\n + Aurora DB clusters - ``aurora`` \n + Multi-AZ DB clusters - ``io1`` \n \n When you create an Aurora DB cluster with the storage type set to ``aurora-iopt1``, the storage type is returned in the response. The storage type isn't returned when you set it to ``aurora``.", + "type": "string" + }, + "Tags": { + "description": "Tags to assign to the DB cluster.\n Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UseLatestRestorableTime": { + "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "type": "boolean" + }, + "VpcSecurityGroupIds": { + "description": "A list of EC2 VPC security groups to associate with this DB cluster.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n Valid for: Aurora DB clusters and Multi-AZ DB clusters", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", + "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)", + "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", + "/properties/EnableHttpEndpoint": "$lowercase($string(EngineMode)) = 'serverless' ? EnableHttpEndpoint : ($lowercase($string(Engine)) = 'aurora-postgresql' ? EnableHttpEndpoint : false )", + "/properties/Engine": "$lowercase(Engine)", + "/properties/EngineVersion": "$join([$string(EngineVersion), \".*\"])", + "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", + "/properties/MasterUserSecret/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", MasterUserSecret.KmsKeyId])", + "/properties/NetworkType": "$lowercase(NetworkType)", + "/properties/PerformanceInsightsKmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", PerformanceInsightsKmsKeyId])", + "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)", + "/properties/SnapshotIdentifier": "$lowercase(SnapshotIdentifier)", + "/properties/SourceDBClusterIdentifier": "$lowercase(SourceDBClusterIdentifier)", + "/properties/StorageType": "$lowercase(StorageType)" + }, + "readOnlyProperties": [ + "/properties/DBClusterArn", + "/properties/DBClusterResourceId", + "/properties/Endpoint", + "/properties/Endpoint/Address", + "/properties/Endpoint/Port", + "/properties/ReadEndpoint/Address", + "/properties/MasterUserSecret/SecretArn", + "/properties/StorageThroughput" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBCluster", + "writeOnlyProperties": [ + "/properties/DBInstanceParameterGroupName", + "/properties/MasterUserPassword", + "/properties/RestoreToTime", + "/properties/RestoreType", + "/properties/SnapshotIdentifier", + "/properties/SourceDBClusterIdentifier", + "/properties/SourceRegion", + "/properties/UseLatestRestorableTime" + ] +} diff --git a/schema/aws-rds-dbclusterparametergroup.json b/schema/aws-rds-dbclusterparametergroup.json index 40031ca..826fc41 100644 --- a/schema/aws-rds-dbclusterparametergroup.json +++ b/schema/aws-rds-dbclusterparametergroup.json @@ -1,123 +1,134 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBClusterParameterGroupName", - "/properties/Description", - "/properties/Family" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.\n For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rds:AddTagsToResource", - "rds:CreateDBClusterParameterGroup", - "rds:DescribeDBClusterParameterGroups", - "rds:DescribeDBClusterParameters", - "rds:DescribeDBClusters", - "rds:DescribeEngineDefaultClusterParameters", - "rds:ListTagsForResource", - "rds:ModifyDBClusterParameterGroup", - "rds:RemoveTagsFromResource" - ], - "timeoutInMinutes": 180 - }, - "delete": { - "permissions": [ - "rds:DeleteDBClusterParameterGroup" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBClusterParameterGroups" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBClusterParameterGroups", - "rds:DescribeDBClusterParameters", - "rds:DescribeEngineDefaultClusterParameters", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:AddTagsToResource", - "rds:DescribeDBClusterParameterGroups", - "rds:DescribeDBClusterParameters", - "rds:DescribeDBClusters", - "rds:DescribeEngineDefaultClusterParameters", - "rds:ListTagsForResource", - "rds:ModifyDBClusterParameterGroup", - "rds:RemoveTagsFromResource", - "rds:ResetDBClusterParameterGroup" - ], - "timeoutInMinutes": 180 - } - }, - "primaryIdentifier": [ - "/properties/DBClusterParameterGroupName" - ], - "properties": { - "DBClusterParameterGroupName": { - "description": "The name of the DB cluster parameter group.\n Constraints:\n + Must not match the name of an existing DB cluster parameter group.\n \n If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.\n This value is stored as a lowercase string.", - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", - "type": "string" - }, - "Description": { - "description": "A friendly description for this DB cluster parameter group.", - "type": "string" - }, - "Family": { - "description": "The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.\n The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.\n To list all of the available parameter group families, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`` \n The output contains duplicates.\n For more information, see ``CreateDBClusterParameterGroup``.", - "type": "string" - }, - "Parameters": { - "description": "Provides a list of parameters for the DB cluster parameter group.", - "type": "object" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this DB cluster parameter group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "propertyTransform": { - "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)" - }, - "required": [ - "Description", - "Family", - "Parameters" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::DBClusterParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBClusterParameterGroupName", + "/properties/Description", + "/properties/Family" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.\n For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rds:AddTagsToResource", + "rds:CreateDBClusterParameterGroup", + "rds:DescribeDBClusterParameterGroups", + "rds:DescribeDBClusterParameters", + "rds:DescribeDBClusters", + "rds:DescribeEngineDefaultClusterParameters", + "rds:ListTagsForResource", + "rds:ModifyDBClusterParameterGroup", + "rds:RemoveTagsFromResource" + ], + "timeoutInMinutes": 180 + }, + "delete": { + "permissions": [ + "rds:DeleteDBClusterParameterGroup" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBClusterParameterGroups" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBClusterParameterGroups", + "rds:DescribeDBClusterParameters", + "rds:DescribeEngineDefaultClusterParameters", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:AddTagsToResource", + "rds:DescribeDBClusterParameterGroups", + "rds:DescribeDBClusterParameters", + "rds:DescribeDBClusters", + "rds:DescribeEngineDefaultClusterParameters", + "rds:ListTagsForResource", + "rds:ModifyDBClusterParameterGroup", + "rds:RemoveTagsFromResource", + "rds:ResetDBClusterParameterGroup" + ], + "timeoutInMinutes": 180 + } + }, + "primaryIdentifier": [ + "/properties/DBClusterParameterGroupName" + ], + "properties": { + "DBClusterParameterGroupName": { + "description": "The name of the DB cluster parameter group.\n Constraints:\n + Must not match the name of an existing DB cluster parameter group.\n \n This value is stored as a lowercase string.", + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", + "type": "string" + }, + "Description": { + "description": "The description for the DB cluster parameter group.", + "type": "string" + }, + "Family": { + "description": "The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.\n *Aurora MySQL* \n Example: ``aurora-mysql5.7``, ``aurora-mysql8.0`` \n *Aurora PostgreSQL* \n Example: ``aurora-postgresql14`` \n *RDS for MySQL* \n Example: ``mysql8.0`` \n *RDS for PostgreSQL* \n Example: ``postgres13`` \n To list all of the available parameter group families for a DB engine, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine `` \n For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql`` \n The output contains duplicates.\n The following are the valid DB engine values:\n + ``aurora-mysql`` \n + ``aurora-postgresql`` \n + ``mysql`` \n + ``postgres``", + "type": "string" + }, + "Parameters": { + "description": "Provides a list of parameters for the DB cluster parameter group.", + "type": "object" + }, + "Tags": { + "description": "Tags to assign to the DB cluster parameter group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "propertyTransform": { + "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)" + }, + "required": [ + "Description", + "Family", + "Parameters" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBClusterParameterGroup" +} diff --git a/schema/aws-rds-dbinstance.json b/schema/aws-rds-dbinstance.json index 28c2cf1..c2e3fc1 100644 --- a/schema/aws-rds-dbinstance.json +++ b/schema/aws-rds-dbinstance.json @@ -1,669 +1,677 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/AutoMinorVersionUpgrade", - "/properties/AvailabilityZone", - "/properties/BackupRetentionPeriod", - "/properties/DBClusterSnapshotIdentifier", - "/properties/DBParameterGroupName", - "/properties/DBSnapshotIdentifier", - "/properties/Engine", - "/properties/MultiAZ", - "/properties/PerformanceInsightsKMSKeyId", - "/properties/PreferredMaintenanceWindow", - "/properties/RestoreTime", - "/properties/SourceDBClusterIdentifier", - "/properties/SourceDBInstanceAutomatedBackupsArn", - "/properties/SourceDBInstanceIdentifier", - "/properties/SourceDbiResourceId", - "/properties/StorageType", - "/properties/UseLatestRestorableTime" - ], - "createOnlyProperties": [ - "/properties/CharacterSetName", - "/properties/CustomIAMInstanceProfile", - "/properties/DBClusterIdentifier", - "/properties/DBInstanceIdentifier", - "/properties/DBName", - "/properties/DBSubnetGroupName", - "/properties/KmsKeyId", - "/properties/MasterUsername", - "/properties/NcharCharacterSetName", - "/properties/Port", - "/properties/SourceRegion", - "/properties/StorageEncrypted", - "/properties/Timezone" - ], - "definitions": { - "CertificateDetails": { - "additionalProperties": false, - "description": "The details of the DB instance\u2019s server certificate.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.", - "properties": { - "CAIdentifier": { - "description": "The CA identifier of the CA certificate used for the DB instance's server certificate.", - "type": "string" - }, - "ValidTill": { - "description": "The expiration date of the DB instance\u2019s server certificate.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "DBInstanceRole": { - "additionalProperties": false, - "description": "Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.", - "properties": { - "FeatureName": { - "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.", - "type": "string" - } - }, - "required": [ - "FeatureName", - "RoleArn" - ], - "type": "object" - }, - "Endpoint": { - "additionalProperties": false, - "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:\n + ``CreateDBInstance`` \n + ``DescribeDBInstances`` \n + ``DeleteDBInstance`` \n \n For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.", - "properties": { - "Address": { - "description": "Specifies the DNS address of the DB instance.", - "type": "string" - }, - "HostedZoneId": { - "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.", - "type": "string" - }, - "Port": { - "description": "Specifies the port that the database engine is listening on.", - "type": "string" - } - }, - "type": "object" - }, - "MasterUserSecret": { - "additionalProperties": false, - "description": "The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", - "properties": { - "KmsKeyId": { - "description": "The AWS KMS key identifier that is used to encrypt the secret.", - "type": "string" - }, - "SecretArn": { - "description": "The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values).", - "type": "string" - } - }, - "type": "object" - }, - "ProcessorFeature": { - "additionalProperties": false, - "description": "The ``ProcessorFeature`` property type specifies the processor features of a DB instance class.", - "properties": { - "Name": { - "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.", - "enum": [ - "coreCount", - "threadsPerCore" - ], - "type": "string" - }, - "Value": { - "description": "The value of a processor feature.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/TdeCredentialArn", - "/properties/TdeCredentialPassword" - ], - "description": "The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.\n For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.\n For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\n If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).\n *Updating DB instances* \n When properties labeled \"*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:\n 1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n 1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).\n 1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the ``DBSnapshotIdentifier`` property with the ID of the DB snapshot that you want to use.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you can delete the ``DBSnapshotIdentifier`` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n 1. Update the stack.\n \n For more information about updating other properties of this resource, see ``ModifyDBInstance``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n *Deleting DB instances* \n For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the ``DBClusterIdentifier`` property:\n 1. For ``AWS::RDS::DBInstance`` resources that don't specify the ``DBClusterIdentifier`` property, AWS CloudFormation saves a snapshot of the DB instance.\n 1. For ``AWS::RDS::DBInstance`` resources that do specify the ``DBClusterIdentifier`` property, AWS CloudFormation deletes the DB instance.\n \n For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "iam:GetRole", - "iam:ListRoles", - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey", - "rds:AddRoleToDBInstance", - "rds:AddTagsToResource", - "rds:CreateDBInstance", - "rds:CreateDBInstanceReadReplica", - "rds:DescribeDBInstances", - "rds:DescribeDBClusters", - "rds:DescribeDBClusterSnapshots", - "rds:DescribeDBInstanceAutomatedBackups", - "rds:DescribeDBSnapshots", - "rds:DescribeEvents", - "rds:ModifyDBInstance", - "rds:RebootDBInstance", - "rds:RestoreDBInstanceFromDBSnapshot", - "rds:RestoreDBInstanceToPointInTime", - "rds:StartDBInstanceAutomatedBackupsReplication", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "rds:AddTagsToResource", - "rds:CreateDBSnapshot", - "rds:DeleteDBInstance", - "rds:DescribeDBInstances" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "rds:DescribeDBInstances" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "rds:DescribeDBInstances" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcAttribute", - "ec2:DescribeVpcs", - "iam:CreateServiceLinkedRole", - "iam:GetRole", - "iam:ListRoles", - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey", - "rds:AddRoleToDBInstance", - "rds:AddTagsToResource", - "rds:DescribeDBClusters", - "rds:DescribeDBEngineVersions", - "rds:DescribeDBInstances", - "rds:DescribeDBParameterGroups", - "rds:DescribeEvents", - "rds:ModifyDBInstance", - "rds:PromoteReadReplica", - "rds:RebootDBInstance", - "rds:RemoveRoleFromDBInstance", - "rds:RemoveTagsFromResource", - "rds:StartDBInstanceAutomatedBackupsReplication", - "rds:StopDBInstanceAutomatedBackupsReplication", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/DBInstanceIdentifier" - ], - "properties": { - "AllocatedStorage": { - "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.\n If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). \n *Amazon Aurora* \n Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n *Db2* \n Constraints to the amount of storage for each storage type are the following:\n + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.\n \n *MySQL* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *MariaDB* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *PostgreSQL* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *Oracle* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 10 to 3072.\n \n *SQL Server* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Provisioned IOPS storage (io1):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Magnetic storage (standard):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024.\n + Web and Express editions: Must be an integer from 20 to 1024.", - "pattern": "^[0-9]*$", - "type": "string" - }, - "AllowMajorVersionUpgrade": { - "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.", - "type": "boolean" - }, - "AssociatedRoles": { - "description": "The IAMlong (IAM) roles associated with the DB instance. \n *Amazon Aurora* \n Not applicable. The associated roles are managed by the DB cluster.", - "items": { - "$ref": "#/definitions/DBInstanceRole" - }, - "type": "array" - }, - "AutoMinorVersionUpgrade": { - "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.", - "type": "boolean" - }, - "AutomaticBackupReplicationKmsKeyId": { - "description": "The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``.", - "type": "string" - }, - "AutomaticBackupReplicationRegion": { - "description": "", - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\n For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.\n Constraints:\n + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.\n + The specified Availability Zone must be in the same AWS-Region as the current endpoint.\n \n Example: ``us-east-1d``", - "type": "string" - }, - "BackupRetentionPeriod": { - "default": 1, - "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n *Amazon Aurora* \n Not applicable. The retention period for automated backups is managed by the DB cluster.\n Default: 1\n Constraints:\n + Must be a value from 0 to 35\n + Can't be set to 0 if the DB instance is a source to read replicas", - "minimum": 0, - "type": "integer" - }, - "CACertificateIdentifier": { - "description": "The identifier of the CA certificate for this DB instance.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.", - "type": "string" - }, - "CertificateDetails": { - "$ref": "#/definitions/CertificateDetails", - "description": "The details of the DB instance's server certificate." - }, - "CertificateRotationRestart": { - "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.\n By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* \n + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.\n \n This setting doesn't apply to RDS Custom DB instances.", - "type": "boolean" - }, - "CharacterSetName": { - "description": "For supported engines, indicates that the DB instance should be associated with the specified character set.\n *Amazon Aurora* \n Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).", - "type": "string" - }, - "CopyTagsToSnapshot": { - "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\n This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.", - "type": "boolean" - }, - "CustomIAMInstanceProfile": { - "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.\n This setting is required for RDS Custom.\n Constraints:\n + The profile must exist in your account.\n + The profile must have an IAM role that Amazon EC2 has permissions to assume.\n + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.\n \n For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.", - "type": "string" - }, - "DBClusterIdentifier": { - "description": "The identifier of the DB cluster that the instance will belong to.", - "type": "string" - }, - "DBClusterSnapshotIdentifier": { - "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from.\n For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.\n Constraints:\n + Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n + Can't be specified when ``DBSnapshotIdentifier`` is specified.\n + Must be specified when ``DBSnapshotIdentifier`` isn't specified.\n + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.\n + Can't be the identifier of an Aurora DB cluster snapshot.", - "type": "string" - }, - "DBInstanceArn": { - "description": "", - "type": "string" - }, - "DBInstanceClass": { - "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.", - "type": "string" - }, - "DBInstanceIdentifier": { - "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "maxLength": 63, - "minLength": 1, - "pattern": "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "DBName": { - "description": "The meaning of this parameter differs according to the database engine you use.\n If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.\n *Amazon Aurora* \n Not applicable. The database name is managed by the DB cluster.\n *Db2* \n The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Can't be a word reserved by the specified database engine.\n \n *MySQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *MariaDB* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *PostgreSQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.\n Constraints:\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Must contain 1 to 63 characters.\n + Can't be a word reserved by the specified database engine\n \n *Oracle* \n The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. \n Default: ``ORCL`` \n Constraints:\n + Can't be longer than 8 characters\n \n *SQL Server* \n Not applicable. Must be null.", - "type": "string" - }, - "DBParameterGroupName": { - "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.\n To list all of the available DB parameter group names, use the following command:\n ``aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`` \n If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.", - "type": "string" - }, - "DBSecurityGroups": { - "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n + ``AllocatedStorage`` \n + ``AutoMinorVersionUpgrade`` \n + ``AvailabilityZone`` \n + ``BackupRetentionPeriod`` \n + ``CharacterSetName`` \n + ``DBInstanceClass`` \n + ``DBName`` \n + ``DBParameterGroupName`` \n + ``DBSecurityGroups`` \n + ``DBSubnetGroupName`` \n + ``Engine`` \n + ``EngineVersion`` \n + ``Iops`` \n + ``LicenseModel`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``MultiAZ`` \n + ``OptionGroupName`` \n + ``PreferredBackupWindow`` \n + ``PreferredMaintenanceWindow`` \n \n All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "DBSnapshotIdentifier": { - "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n + ``CharacterSetName`` \n + ``DBClusterIdentifier`` \n + ``DBName`` \n + ``DeleteAutomatedBackups`` \n + ``KmsKeyId`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``PerformanceInsightsKMSKeyId`` \n + ``PerformanceInsightsRetentionPeriod`` \n + ``PromotionTier`` \n + ``SourceDBInstanceIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``Timezone`` \n \n *Amazon Aurora* \n Not applicable. Snapshot restore is managed by the DB cluster.", - "type": "string" - }, - "DBSubnetGroupName": { - "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. \n If there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. \n *Amazon Aurora* \n Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", - "type": "string" - }, - "DBSystemId": { - "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.", - "type": "string" - }, - "DbiResourceId": { - "description": "", - "type": "string" - }, - "DedicatedLogVolume": { - "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled.", - "type": "boolean" - }, - "DeleteAutomatedBackups": { - "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n *Amazon Aurora* \n Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.", - "type": "boolean" - }, - "DeletionProtection": { - "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). \n *Amazon Aurora* \n Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.", - "type": "boolean" - }, - "Domain": { - "description": "The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.\n For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.", - "type": "string" - }, - "DomainAuthSecretArn": { - "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain.\n Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``", - "type": "string" - }, - "DomainDnsIps": { - "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.\n Constraints:\n + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.\n \n Example: ``123.124.125.126,234.235.236.237``", - "items": { - "type": "string" - }, - "type": "array" - }, - "DomainFqdn": { - "description": "The fully qualified domain name (FQDN) of an Active Directory domain.\n Constraints:\n + Can't be longer than 64 characters.\n \n Example: ``mymanagedADtest.mymanagedAD.mydomain``", - "type": "string" - }, - "DomainIAMRoleName": { - "description": "The name of the IAM role to use when making API calls to the Directory Service.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (The domain is managed by the DB cluster.)\n + RDS Custom", - "type": "string" - }, - "DomainOu": { - "description": "The Active Directory organizational unit for your DB instance to join.\n Constraints:\n + Must be in the distinguished name format.\n + Can't be longer than 64 characters.\n \n Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``", - "type": "string" - }, - "EnableCloudwatchLogsExports": { - "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.\n *Amazon Aurora* \n Not applicable. CloudWatch Logs exports are managed by the DB cluster. \n *Db2* \n Valid values: ``diag.log``, ``notify.log`` \n *MariaDB* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Microsoft SQL Server* \n Valid values: ``agent``, ``error`` \n *MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Oracle* \n Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` \n *PostgreSQL* \n Valid values: ``postgresql``, ``upgrade``", - "items": { - "type": "string" - }, - "type": "array" - }, - "EnableIAMDatabaseAuthentication": { - "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* \n *Amazon Aurora* \n Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.", - "type": "boolean" - }, - "EnablePerformanceInsights": { - "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n This setting doesn't apply to RDS Custom DB instances.", - "type": "boolean" - }, - "Endpoint": { - "$ref": "#/definitions/Endpoint", - "description": "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``." - }, - "Engine": { - "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.\n This property is required when creating a DB instance.\n You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption.\n Valid Values:\n + ``aurora-mysql`` (for Aurora MySQL DB instances)\n + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)\n + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)\n + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)\n + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)\n + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)\n + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)\n + ``db2-ae`` \n + ``db2-se`` \n + ``mariadb`` \n + ``mysql`` \n + ``oracle-ee`` \n + ``oracle-ee-cdb`` \n + ``oracle-se2`` \n + ``oracle-se2-cdb`` \n + ``postgres`` \n + ``sqlserver-ee`` \n + ``sqlserver-se`` \n + ``sqlserver-ex`` \n + ``sqlserver-web``", - "type": "string" - }, - "EngineLifecycleSupport": { - "description": "The life cycle type for this DB instance.\n By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.\n This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.\n You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.\n Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` \n Default: ``open-source-rds-extended-support``", - "type": "string" - }, - "EngineVersion": { - "description": "The version number of the database engine to use.\n For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.\n The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n *Amazon Aurora* \n Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n *Db2* \n See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *MariaDB* \n See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Microsoft SQL Server* \n See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* \n *MySQL* \n See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Oracle* \n See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* \n *PostgreSQL* \n See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*", - "type": "string" - }, - "Iops": { - "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. \n If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.\n Constraints:\n + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.\n + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.", - "type": "integer" - }, - "KmsKeyId": { - "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. \n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.\n If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.\n If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. The KMS key identifier is managed by the DB cluster.", - "type": "string" - }, - "LicenseModel": { - "description": "License model information for this DB instance.\n Valid Values:\n + Aurora MySQL - ``general-public-license`` \n + Aurora PostgreSQL - ``postgresql-license`` \n + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* \n + RDS for MariaDB - ``general-public-license`` \n + RDS for Microsoft SQL Server - ``license-included`` \n + RDS for MySQL - ``general-public-license`` \n + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` \n + RDS for PostgreSQL - ``postgresql-license`` \n \n If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.", - "type": "string" - }, - "ManageMasterUserPassword": { - "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* \n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.", - "type": "boolean" - }, - "MasterUserPassword": { - "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n *Amazon Aurora* \n Not applicable. The password for the master user is managed by the DB cluster.\n *RDS for Db2* \n Must contain from 8 to 255 characters.\n *RDS for MariaDB* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Microsoft SQL Server* \n Constraints: Must contain from 8 to 128 characters.\n *RDS for MySQL* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Oracle* \n Constraints: Must contain from 8 to 30 characters.\n *RDS for PostgreSQL* \n Constraints: Must contain from 8 to 128 characters.", - "type": "string" - }, - "MasterUserSecret": { - "$ref": "#/definitions/MasterUserSecret", - "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*" - }, - "MasterUsername": { - "description": "The master user name for the DB instance.\n If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.\n *Amazon Aurora* \n Not applicable. The name for the master user is managed by the DB cluster. \n *RDS for Db2* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MariaDB* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Microsoft SQL Server* \n Constraints:\n + Must be 1 to 128 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MySQL* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Oracle* \n Constraints:\n + Must be 1 to 30 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for PostgreSQL* \n Constraints:\n + Must be 1 to 63 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,127}$", - "type": "string" - }, - "MaxAllocatedStorage": { - "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.\n For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (Storage is managed by the DB cluster.)\n + RDS Custom", - "type": "integer" - }, - "MonitoringInterval": { - "default": 0, - "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.\n If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.\n This setting doesn't apply to RDS Custom.\n Valid Values: ``0, 1, 5, 10, 15, 30, 60``", - "type": "integer" - }, - "MonitoringRoleArn": { - "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.\n This setting doesn't apply to RDS Custom DB instances.", - "type": "string" - }, - "MultiAZ": { - "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. \n For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.", - "type": "boolean" - }, - "NcharCharacterSetName": { - "description": "The name of the NCHAR character set for the Oracle DB instance.\n This setting doesn't apply to RDS Custom DB instances.", - "type": "string" - }, - "NetworkType": { - "description": "The network type of the DB instance.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*", - "type": "string" - }, - "OptionGroupName": { - "description": "Indicates that the DB instance should be associated with the specified option group.\n Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.", - "type": "string" - }, - "PerformanceInsightsKMSKeyId": { - "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).", - "type": "string" - }, - "PerformanceInsightsRetentionPeriod": { - "description": "The number of days to retain Performance Insights data.\n This setting doesn't apply to RDS Custom DB instances.\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.", - "type": "integer" - }, - "Port": { - "description": "The port number on which the database accepts connections.\n *Amazon Aurora* \n Not applicable. The port number is managed by the DB cluster.\n *Db2* \n Default value: ``50000``", - "pattern": "^\\d*$", - "type": "string" - }, - "PreferredBackupWindow": { - "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* \n Constraints:\n + Must be in the format ``hh24:mi-hh24:mi``.\n + Must be in Universal Coordinated Time (UTC).\n + Must not conflict with the preferred maintenance window.\n + Must be at least 30 minutes.\n \n *Amazon Aurora* \n Not applicable. The daily time range for creating automated backups is managed by the DB cluster.", - "type": "string" - }, - "PreferredMaintenanceWindow": { - "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* \n This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n Constraints: Minimum 30-minute window.", - "type": "string" - }, - "ProcessorFeatures": { - "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.\n This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.", - "items": { - "$ref": "#/definitions/ProcessorFeature" - }, - "type": "array" - }, - "PromotionTier": { - "default": 1, - "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.\n This setting doesn't apply to RDS Custom DB instances.\n Default: ``1`` \n Valid Values: ``0 - 15``", - "minimum": 0, - "type": "integer" - }, - "PubliclyAccessible": { - "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. \n The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.", - "type": "boolean" - }, - "ReplicaMode": { - "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.\n This setting is only supported in RDS for Oracle.\n Default: ``open-read-only`` \n Valid Values: ``open-read-only`` or ``mounted``", - "type": "string" - }, - "RestoreTime": { - "description": "The date and time to restore from.\n Constraints:\n + Must be a time in Universal Coordinated Time (UTC) format.\n + Must be before the latest restorable time for the DB instance.\n + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.\n \n Example: ``2009-09-07T23:45:00Z``", - "format": "date-time", - "type": "string" - }, - "SourceDBClusterIdentifier": { - "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.\n Constraints:\n + Must be the identifier of an existing Multi-AZ DB cluster.\n + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.\n + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.", - "type": "string" - }, - "SourceDBInstanceAutomatedBackupsArn": { - "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.\n This setting doesn't apply to RDS Custom.", - "type": "string" - }, - "SourceDBInstanceIdentifier": { - "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.\n If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.\n + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.\n + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.\n + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.", - "type": "string" - }, - "SourceDbiResourceId": { - "description": "The resource ID of the source DB instance from which to restore.", - "type": "string" - }, - "SourceRegion": { - "description": "The ID of the region that contains the source DB instance for the read replica.", - "type": "string" - }, - "StorageEncrypted": { - "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. \n If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot.\n *Amazon Aurora* \n Not applicable. The encryption for DB instances is managed by the DB cluster.", - "type": "boolean" - }, - "StorageThroughput": { - "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. \n This setting doesn't apply to RDS Custom or Amazon Aurora.", - "type": "integer" - }, - "StorageType": { - "description": "The storage type to associate with the DB instance.\n If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.\n This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.\n Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` \n Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``.", - "type": "string" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this DB instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TdeCredentialArn": { - "description": "", - "type": "string" - }, - "TdeCredentialPassword": { - "description": "", - "type": "string" - }, - "Timezone": { - "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).", - "type": "string" - }, - "UseDefaultProcessorFeatures": { - "description": "Specifies whether the DB instance class of the DB instance uses its default processor features.\n This setting doesn't apply to RDS Custom DB instances.", - "type": "boolean" - }, - "UseLatestRestorableTime": { - "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.\n Constraints:\n + Can't be specified if the ``RestoreTime`` parameter is provided.", - "type": "boolean" - }, - "VPCSecurityGroups": { - "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n + You can't revert to using an RDS security group after you establish a VPC security group membership.\n + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n \n To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. \n *Amazon Aurora* \n Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", - "/properties/DBClusterSnapshotIdentifier": "$lowercase(DBClusterSnapshotIdentifier)", - "/properties/DBInstanceIdentifier": "$lowercase(DBInstanceIdentifier)", - "/properties/DBName": "$lowercase(DBName) $OR $uppercase(DBName)", - "/properties/DBParameterGroupName": "$lowercase(DBParameterGroupName)", - "/properties/DBSnapshotIdentifier": "$lowercase(DBSnapshotIdentifier)", - "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", - "/properties/Engine": "$lowercase(Engine)", - "/properties/EngineVersion": "$join([$string(EngineVersion), \".*\"])", - "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", - "/properties/MasterUserSecret/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", MasterUserSecret.KmsKeyId])", - "/properties/NetworkType": "$lowercase(NetworkType)", - "/properties/OptionGroupName": "$lowercase(OptionGroupName)", - "/properties/PerformanceInsightsKMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", PerformanceInsightsKMSKeyId])", - "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)", - "/properties/SourceDBInstanceAutomatedBackupsArn": "$lowercase(SourceDBInstanceAutomatedBackupsArn)", - "/properties/SourceDBInstanceIdentifier": "$lowercase(SourceDBInstanceIdentifier)", - "/properties/StorageType": "$lowercase(StorageType)" - }, - "readOnlyProperties": [ - "/properties/Endpoint/Address", - "/properties/Endpoint/Port", - "/properties/Endpoint/HostedZoneId", - "/properties/DbiResourceId", - "/properties/DBInstanceArn", - "/properties/DBSystemId", - "/properties/MasterUserSecret/SecretArn", - "/properties/CertificateDetails/CAIdentifier", - "/properties/CertificateDetails/ValidTill" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::RDS::DBInstance", - "writeOnlyProperties": [ - "/properties/AllowMajorVersionUpgrade", - "/properties/AutomaticBackupReplicationKmsKeyId", - "/properties/CertificateRotationRestart", - "/properties/DBSnapshotIdentifier", - "/properties/DeleteAutomatedBackups", - "/properties/MasterUserPassword", - "/properties/Port", - "/properties/RestoreTime", - "/properties/SourceDBInstanceAutomatedBackupsArn", - "/properties/SourceDBInstanceIdentifier", - "/properties/SourceDbiResourceId", - "/properties/SourceRegion", - "/properties/TdeCredentialPassword", - "/properties/UseDefaultProcessorFeatures", - "/properties/UseLatestRestorableTime" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/AutoMinorVersionUpgrade", + "/properties/AvailabilityZone", + "/properties/BackupRetentionPeriod", + "/properties/DBClusterSnapshotIdentifier", + "/properties/DBParameterGroupName", + "/properties/DBSnapshotIdentifier", + "/properties/Engine", + "/properties/MultiAZ", + "/properties/PerformanceInsightsKMSKeyId", + "/properties/PreferredMaintenanceWindow", + "/properties/RestoreTime", + "/properties/SourceDBClusterIdentifier", + "/properties/SourceDBInstanceAutomatedBackupsArn", + "/properties/SourceDBInstanceIdentifier", + "/properties/SourceDbiResourceId", + "/properties/StorageType", + "/properties/UseLatestRestorableTime" + ], + "createOnlyProperties": [ + "/properties/CharacterSetName", + "/properties/CustomIAMInstanceProfile", + "/properties/DBClusterIdentifier", + "/properties/DBInstanceIdentifier", + "/properties/DBName", + "/properties/DBSubnetGroupName", + "/properties/KmsKeyId", + "/properties/MasterUsername", + "/properties/NcharCharacterSetName", + "/properties/Port", + "/properties/SourceRegion", + "/properties/StorageEncrypted", + "/properties/Timezone" + ], + "definitions": { + "CertificateDetails": { + "additionalProperties": false, + "description": "The details of the DB instance\u2019s server certificate.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.", + "properties": { + "CAIdentifier": { + "description": "The CA identifier of the CA certificate used for the DB instance's server certificate.", + "type": "string" + }, + "ValidTill": { + "description": "The expiration date of the DB instance\u2019s server certificate.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "DBInstanceRole": { + "additionalProperties": false, + "description": "Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.", + "properties": { + "FeatureName": { + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.", + "type": "string" + } + }, + "required": [ + "FeatureName", + "RoleArn" + ], + "type": "object" + }, + "Endpoint": { + "additionalProperties": false, + "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:\n + ``CreateDBInstance`` \n + ``DescribeDBInstances`` \n + ``DeleteDBInstance`` \n \n For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.", + "properties": { + "Address": { + "description": "Specifies the DNS address of the DB instance.", + "type": "string" + }, + "HostedZoneId": { + "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.", + "type": "string" + }, + "Port": { + "description": "Specifies the port that the database engine is listening on.", + "type": "string" + } + }, + "type": "object" + }, + "MasterUserSecret": { + "additionalProperties": false, + "description": "The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", + "properties": { + "KmsKeyId": { + "description": "The AWS KMS key identifier that is used to encrypt the secret.", + "type": "string" + }, + "SecretArn": { + "description": "The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values).", + "type": "string" + } + }, + "type": "object" + }, + "ProcessorFeature": { + "additionalProperties": false, + "description": "The ``ProcessorFeature`` property type specifies the processor features of a DB instance class.", + "properties": { + "Name": { + "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.", + "enum": [ + "coreCount", + "threadsPerCore" + ], + "type": "string" + }, + "Value": { + "description": "The value of a processor feature.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/TdeCredentialArn", + "/properties/TdeCredentialPassword" + ], + "description": "The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.\n For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.\n For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.\n If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).\n *Updating DB instances* \n When properties labeled \"*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:\n 1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n 1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).\n 1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the ``DBSnapshotIdentifier`` property with the ID of the DB snapshot that you want to use.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you can delete the ``DBSnapshotIdentifier`` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n 1. Update the stack.\n \n For more information about updating other properties of this resource, see ``ModifyDBInstance``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n *Deleting DB instances* \n For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the ``DBClusterIdentifier`` property:\n 1. For ``AWS::RDS::DBInstance`` resources that don't specify the ``DBClusterIdentifier`` property, AWS CloudFormation saves a snapshot of the DB instance.\n 1. For ``AWS::RDS::DBInstance`` resources that do specify the ``DBClusterIdentifier`` property, AWS CloudFormation deletes the DB instance.\n \n For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "iam:ListRoles", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "rds:AddRoleToDBInstance", + "rds:AddTagsToResource", + "rds:CreateDBInstance", + "rds:CreateDBInstanceReadReplica", + "rds:DescribeDBInstances", + "rds:DescribeDBClusters", + "rds:DescribeDBClusterSnapshots", + "rds:DescribeDBInstanceAutomatedBackups", + "rds:DescribeDBSnapshots", + "rds:DescribeEvents", + "rds:ModifyDBInstance", + "rds:RebootDBInstance", + "rds:RestoreDBInstanceFromDBSnapshot", + "rds:RestoreDBInstanceToPointInTime", + "rds:StartDBInstanceAutomatedBackupsReplication", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "rds:AddTagsToResource", + "rds:CreateDBSnapshot", + "rds:DeleteDBInstance", + "rds:DescribeDBInstances" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "rds:DescribeDBInstances" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "rds:DescribeDBInstances" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcs", + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "iam:ListRoles", + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "rds:AddRoleToDBInstance", + "rds:AddTagsToResource", + "rds:DescribeDBClusters", + "rds:DescribeDBEngineVersions", + "rds:DescribeDBInstances", + "rds:DescribeDBParameterGroups", + "rds:DescribeEvents", + "rds:ModifyDBInstance", + "rds:PromoteReadReplica", + "rds:RebootDBInstance", + "rds:RemoveRoleFromDBInstance", + "rds:RemoveTagsFromResource", + "rds:StartDBInstanceAutomatedBackupsReplication", + "rds:StopDBInstanceAutomatedBackupsReplication", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/DBInstanceIdentifier" + ], + "properties": { + "AllocatedStorage": { + "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.\n If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). \n *Amazon Aurora* \n Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n *Db2* \n Constraints to the amount of storage for each storage type are the following:\n + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.\n \n *MySQL* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *MariaDB* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *PostgreSQL* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 5 to 3072.\n \n *Oracle* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n + Magnetic storage (standard): Must be an integer from 10 to 3072.\n \n *SQL Server* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Provisioned IOPS storage (io1):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Magnetic storage (standard):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024.\n + Web and Express editions: Must be an integer from 20 to 1024.", + "pattern": "^[0-9]*$", + "type": "string" + }, + "AllowMajorVersionUpgrade": { + "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.", + "type": "boolean" + }, + "AssociatedRoles": { + "description": "The IAMlong (IAM) roles associated with the DB instance. \n *Amazon Aurora* \n Not applicable. The associated roles are managed by the DB cluster.", + "items": { + "$ref": "#/definitions/DBInstanceRole" + }, + "type": "array" + }, + "AutoMinorVersionUpgrade": { + "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.", + "type": "boolean" + }, + "AutomaticBackupReplicationKmsKeyId": { + "description": "The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``.", + "type": "string" + }, + "AutomaticBackupReplicationRegion": { + "description": "The AWS-Region associated with the automated backup.", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\n For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.\n Constraints:\n + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.\n + The specified Availability Zone must be in the same AWS-Region as the current endpoint.\n \n Example: ``us-east-1d``", + "type": "string" + }, + "BackupRetentionPeriod": { + "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n *Amazon Aurora* \n Not applicable. The retention period for automated backups is managed by the DB cluster.\n Default: 1\n Constraints:\n + Must be a value from 0 to 35\n + Can't be set to 0 if the DB instance is a source to read replicas", + "minimum": 0, + "type": "integer" + }, + "CACertificateIdentifier": { + "description": "The identifier of the CA certificate for this DB instance.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.", + "type": "string" + }, + "CertificateDetails": { + "$ref": "#/definitions/CertificateDetails", + "description": "The details of the DB instance's server certificate." + }, + "CertificateRotationRestart": { + "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.\n By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* \n + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.\n \n This setting doesn't apply to RDS Custom DB instances.", + "type": "boolean" + }, + "CharacterSetName": { + "description": "For supported engines, indicates that the DB instance should be associated with the specified character set.\n *Amazon Aurora* \n Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).", + "type": "string" + }, + "CopyTagsToSnapshot": { + "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\n This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.", + "type": "boolean" + }, + "CustomIAMInstanceProfile": { + "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.\n This setting is required for RDS Custom.\n Constraints:\n + The profile must exist in your account.\n + The profile must have an IAM role that Amazon EC2 has permissions to assume.\n + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.\n \n For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.", + "type": "string" + }, + "DBClusterIdentifier": { + "description": "The identifier of the DB cluster that this DB instance will belong to.\n This setting doesn't apply to RDS Custom DB instances.", + "type": "string" + }, + "DBClusterSnapshotIdentifier": { + "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from.\n For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.\n Constraints:\n + Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n + Can't be specified when ``DBSnapshotIdentifier`` is specified.\n + Must be specified when ``DBSnapshotIdentifier`` isn't specified.\n + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.\n + Can't be the identifier of an Aurora DB cluster snapshot.", + "type": "string" + }, + "DBInstanceArn": { + "description": "", + "type": "string" + }, + "DBInstanceClass": { + "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.", + "type": "string" + }, + "DBInstanceIdentifier": { + "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "maxLength": 63, + "minLength": 1, + "pattern": "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "DBName": { + "description": "The meaning of this parameter differs according to the database engine you use.\n If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.\n *Amazon Aurora* \n Not applicable. The database name is managed by the DB cluster.\n *Db2* \n The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Can't be a word reserved by the specified database engine.\n \n *MySQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *MariaDB* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *PostgreSQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.\n Constraints:\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Must contain 1 to 63 characters.\n + Can't be a word reserved by the specified database engine\n \n *Oracle* \n The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. \n Default: ``ORCL`` \n Constraints:\n + Can't be longer than 8 characters\n \n *SQL Server* \n Not applicable. Must be null.", + "type": "string" + }, + "DBParameterGroupName": { + "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.\n To list all of the available DB parameter group names, use the following command:\n ``aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`` \n If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.", + "type": "string" + }, + "DBSecurityGroups": { + "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n + ``AllocatedStorage`` \n + ``AutoMinorVersionUpgrade`` \n + ``AvailabilityZone`` \n + ``BackupRetentionPeriod`` \n + ``CharacterSetName`` \n + ``DBInstanceClass`` \n + ``DBName`` \n + ``DBParameterGroupName`` \n + ``DBSecurityGroups`` \n + ``DBSubnetGroupName`` \n + ``Engine`` \n + ``EngineVersion`` \n + ``Iops`` \n + ``LicenseModel`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``MultiAZ`` \n + ``OptionGroupName`` \n + ``PreferredBackupWindow`` \n + ``PreferredMaintenanceWindow`` \n \n All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "DBSnapshotIdentifier": { + "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n + ``CharacterSetName`` \n + ``DBClusterIdentifier`` \n + ``DBName`` \n + ``DeleteAutomatedBackups`` \n + ``KmsKeyId`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``PerformanceInsightsKMSKeyId`` \n + ``PerformanceInsightsRetentionPeriod`` \n + ``PromotionTier`` \n + ``SourceDBInstanceIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``Timezone`` \n \n *Amazon Aurora* \n Not applicable. Snapshot restore is managed by the DB cluster.", + "type": "string" + }, + "DBSubnetGroupName": { + "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. \n If there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. \n This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", + "type": "string" + }, + "DBSystemId": { + "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.", + "type": "string" + }, + "DbiResourceId": { + "description": "", + "type": "string" + }, + "DedicatedLogVolume": { + "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled.", + "type": "boolean" + }, + "DeleteAutomatedBackups": { + "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n *Amazon Aurora* \n Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.", + "type": "boolean" + }, + "DeletionProtection": { + "description": "Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).\n This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.", + "type": "boolean" + }, + "Domain": { + "description": "The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.\n For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.", + "type": "string" + }, + "DomainAuthSecretArn": { + "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain.\n Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``", + "type": "string" + }, + "DomainDnsIps": { + "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.\n Constraints:\n + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.\n \n Example: ``123.124.125.126,234.235.236.237``", + "items": { + "type": "string" + }, + "type": "array" + }, + "DomainFqdn": { + "description": "The fully qualified domain name (FQDN) of an Active Directory domain.\n Constraints:\n + Can't be longer than 64 characters.\n \n Example: ``mymanagedADtest.mymanagedAD.mydomain``", + "type": "string" + }, + "DomainIAMRoleName": { + "description": "The name of the IAM role to use when making API calls to the Directory Service.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (The domain is managed by the DB cluster.)\n + RDS Custom", + "type": "string" + }, + "DomainOu": { + "description": "The Active Directory organizational unit for your DB instance to join.\n Constraints:\n + Must be in the distinguished name format.\n + Can't be longer than 64 characters.\n \n Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``", + "type": "string" + }, + "EnableCloudwatchLogsExports": { + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.\n *Amazon Aurora* \n Not applicable. CloudWatch Logs exports are managed by the DB cluster. \n *Db2* \n Valid values: ``diag.log``, ``notify.log`` \n *MariaDB* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Microsoft SQL Server* \n Valid values: ``agent``, ``error`` \n *MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Oracle* \n Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` \n *PostgreSQL* \n Valid values: ``postgresql``, ``upgrade``", + "items": { + "type": "string" + }, + "type": "array" + }, + "EnableIAMDatabaseAuthentication": { + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* \n *Amazon Aurora* \n Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.", + "type": "boolean" + }, + "EnablePerformanceInsights": { + "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n This setting doesn't apply to RDS Custom DB instances.", + "type": "boolean" + }, + "Endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``." + }, + "Engine": { + "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.\n This property is required when creating a DB instance.\n You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption.\n Valid Values:\n + ``aurora-mysql`` (for Aurora MySQL DB instances)\n + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)\n + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)\n + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)\n + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)\n + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)\n + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)\n + ``db2-ae`` \n + ``db2-se`` \n + ``mariadb`` \n + ``mysql`` \n + ``oracle-ee`` \n + ``oracle-ee-cdb`` \n + ``oracle-se2`` \n + ``oracle-se2-cdb`` \n + ``postgres`` \n + ``sqlserver-ee`` \n + ``sqlserver-se`` \n + ``sqlserver-ex`` \n + ``sqlserver-web``", + "type": "string" + }, + "EngineLifecycleSupport": { + "description": "The life cycle type for this DB instance.\n By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.\n This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.\n You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.\n Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` \n Default: ``open-source-rds-extended-support``", + "type": "string" + }, + "EngineVersion": { + "description": "The version number of the database engine to use.\n For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.\n The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n *Amazon Aurora* \n Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n *Db2* \n See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *MariaDB* \n See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Microsoft SQL Server* \n See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* \n *MySQL* \n See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Oracle* \n See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* \n *PostgreSQL* \n See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*", + "type": "string" + }, + "Iops": { + "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. \n If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.\n Constraints:\n + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.\n + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.", + "type": "integer" + }, + "KmsKeyId": { + "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. \n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.\n If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.\n If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. The KMS key identifier is managed by the DB cluster.", + "type": "string" + }, + "LicenseModel": { + "description": "License model information for this DB instance.\n Valid Values:\n + Aurora MySQL - ``general-public-license`` \n + Aurora PostgreSQL - ``postgresql-license`` \n + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* \n + RDS for MariaDB - ``general-public-license`` \n + RDS for Microsoft SQL Server - ``license-included`` \n + RDS for MySQL - ``general-public-license`` \n + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` \n + RDS for PostgreSQL - ``postgresql-license`` \n \n If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.", + "type": "string" + }, + "ManageMasterUserPassword": { + "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* \n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.", + "type": "boolean" + }, + "MasterUserPassword": { + "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n *Amazon Aurora* \n Not applicable. The password for the master user is managed by the DB cluster.\n *RDS for Db2* \n Must contain from 8 to 255 characters.\n *RDS for MariaDB* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Microsoft SQL Server* \n Constraints: Must contain from 8 to 128 characters.\n *RDS for MySQL* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Oracle* \n Constraints: Must contain from 8 to 30 characters.\n *RDS for PostgreSQL* \n Constraints: Must contain from 8 to 128 characters.", + "type": "string" + }, + "MasterUserSecret": { + "$ref": "#/definitions/MasterUserSecret", + "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*" + }, + "MasterUsername": { + "description": "The master user name for the DB instance.\n If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.\n *Amazon Aurora* \n Not applicable. The name for the master user is managed by the DB cluster. \n *RDS for Db2* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MariaDB* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Microsoft SQL Server* \n Constraints:\n + Must be 1 to 128 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MySQL* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Oracle* \n Constraints:\n + Must be 1 to 30 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for PostgreSQL* \n Constraints:\n + Must be 1 to 63 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,127}$", + "type": "string" + }, + "MaxAllocatedStorage": { + "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.\n For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (Storage is managed by the DB cluster.)\n + RDS Custom", + "type": "integer" + }, + "MonitoringInterval": { + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0``.\n If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``.\n This setting doesn't apply to RDS Custom DB instances.\n Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` \n Default: ``0``", + "type": "integer" + }, + "MonitoringRoleArn": { + "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.\n This setting doesn't apply to RDS Custom DB instances.", + "type": "string" + }, + "MultiAZ": { + "description": "Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)\n + RDS Custom", + "type": "boolean" + }, + "NcharCharacterSetName": { + "description": "The name of the NCHAR character set for the Oracle DB instance.\n This setting doesn't apply to RDS Custom DB instances.", + "type": "string" + }, + "NetworkType": { + "description": "The network type of the DB instance.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*", + "type": "string" + }, + "OptionGroupName": { + "description": "Indicates that the DB instance should be associated with the specified option group.\n Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.", + "type": "string" + }, + "PerformanceInsightsKMSKeyId": { + "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).", + "type": "string" + }, + "PerformanceInsightsRetentionPeriod": { + "description": "The number of days to retain Performance Insights data.\n This setting doesn't apply to RDS Custom DB instances.\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.", + "type": "integer" + }, + "Port": { + "description": "The port number on which the database accepts connections.\n This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.\n Valid Values: ``1150-65535`` \n Default:\n + RDS for Db2 - ``50000`` \n + RDS for MariaDB - ``3306`` \n + RDS for Microsoft SQL Server - ``1433`` \n + RDS for MySQL - ``3306`` \n + RDS for Oracle - ``1521`` \n + RDS for PostgreSQL - ``5432`` \n \n Constraints:\n + For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``.", + "pattern": "^\\d*$", + "type": "string" + }, + "PreferredBackupWindow": { + "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* \n Constraints:\n + Must be in the format ``hh24:mi-hh24:mi``.\n + Must be in Universal Coordinated Time (UTC).\n + Must not conflict with the preferred maintenance window.\n + Must be at least 30 minutes.\n \n *Amazon Aurora* \n Not applicable. The daily time range for creating automated backups is managed by the DB cluster.", + "type": "string" + }, + "PreferredMaintenanceWindow": { + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* \n This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n Constraints: Minimum 30-minute window.", + "type": "string" + }, + "ProcessorFeatures": { + "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.\n This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.", + "items": { + "$ref": "#/definitions/ProcessorFeature" + }, + "type": "array" + }, + "PromotionTier": { + "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.\n This setting doesn't apply to RDS Custom DB instances.\n Default: ``1`` \n Valid Values: ``0 - 15``", + "minimum": 0, + "type": "integer" + }, + "PubliclyAccessible": { + "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. \n The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.", + "type": "boolean" + }, + "ReplicaMode": { + "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.\n This setting is only supported in RDS for Oracle.\n Default: ``open-read-only`` \n Valid Values: ``open-read-only`` or ``mounted``", + "type": "string" + }, + "RestoreTime": { + "description": "The date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.\n Constraints:\n + Must be a time in Universal Coordinated Time (UTC) format.\n + Must be before the latest restorable time for the DB instance.\n + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.\n \n Example: ``2009-09-07T23:45:00Z``", + "format": "date-time", + "type": "string" + }, + "SourceDBClusterIdentifier": { + "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.\n Constraints:\n + Must be the identifier of an existing Multi-AZ DB cluster.\n + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.\n + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.", + "type": "string" + }, + "SourceDBInstanceAutomatedBackupsArn": { + "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.\n This setting doesn't apply to RDS Custom.", + "type": "string" + }, + "SourceDBInstanceIdentifier": { + "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.\n If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.\n + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.\n + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.\n + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.", + "type": "string" + }, + "SourceDbiResourceId": { + "description": "The resource ID of the source DB instance from which to restore.", + "type": "string" + }, + "SourceRegion": { + "description": "The ID of the region that contains the source DB instance for the read replica.", + "type": "string" + }, + "StorageEncrypted": { + "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. \n If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot.\n *Amazon Aurora* \n Not applicable. The encryption for DB instances is managed by the DB cluster.", + "type": "boolean" + }, + "StorageThroughput": { + "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. \n This setting doesn't apply to RDS Custom or Amazon Aurora.", + "type": "integer" + }, + "StorageType": { + "description": "The storage type to associate with the DB instance.\n If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.\n This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.\n Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` \n Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``.", + "type": "string" + }, + "Tags": { + "description": "Tags to assign to the DB instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TdeCredentialArn": { + "description": "", + "type": "string" + }, + "TdeCredentialPassword": { + "description": "", + "type": "string" + }, + "Timezone": { + "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).", + "type": "string" + }, + "UseDefaultProcessorFeatures": { + "description": "Specifies whether the DB instance class of the DB instance uses its default processor features.\n This setting doesn't apply to RDS Custom DB instances.", + "type": "boolean" + }, + "UseLatestRestorableTime": { + "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.\n Constraints:\n + Can't be specified if the ``RestoreTime`` parameter is provided.", + "type": "boolean" + }, + "VPCSecurityGroups": { + "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n + You can't revert to using an RDS security group after you establish a VPC security group membership.\n + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n \n To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. \n *Amazon Aurora* \n Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", + "/properties/DBClusterSnapshotIdentifier": "$lowercase(DBClusterSnapshotIdentifier)", + "/properties/DBInstanceIdentifier": "$lowercase(DBInstanceIdentifier)", + "/properties/DBName": "$lowercase(DBName) $OR $uppercase(DBName)", + "/properties/DBParameterGroupName": "$lowercase(DBParameterGroupName)", + "/properties/DBSnapshotIdentifier": "$lowercase(DBSnapshotIdentifier)", + "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", + "/properties/Engine": "$lowercase(Engine)", + "/properties/EngineVersion": "$join([$string(EngineVersion), \".*\"])", + "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", + "/properties/MasterUserSecret/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", MasterUserSecret.KmsKeyId])", + "/properties/NetworkType": "$lowercase(NetworkType)", + "/properties/OptionGroupName": "$lowercase(OptionGroupName)", + "/properties/PerformanceInsightsKMSKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", PerformanceInsightsKMSKeyId])", + "/properties/PreferredMaintenanceWindow": "$lowercase(PreferredMaintenanceWindow)", + "/properties/SourceDBInstanceAutomatedBackupsArn": "$lowercase(SourceDBInstanceAutomatedBackupsArn)", + "/properties/SourceDBInstanceIdentifier": "$lowercase(SourceDBInstanceIdentifier)", + "/properties/StorageType": "$lowercase(StorageType)" + }, + "readOnlyProperties": [ + "/properties/Endpoint/Address", + "/properties/Endpoint/Port", + "/properties/Endpoint/HostedZoneId", + "/properties/DbiResourceId", + "/properties/DBInstanceArn", + "/properties/DBSystemId", + "/properties/MasterUserSecret/SecretArn", + "/properties/CertificateDetails/CAIdentifier", + "/properties/CertificateDetails/ValidTill" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBInstance", + "writeOnlyProperties": [ + "/properties/AllowMajorVersionUpgrade", + "/properties/AutomaticBackupReplicationKmsKeyId", + "/properties/CertificateRotationRestart", + "/properties/DBSnapshotIdentifier", + "/properties/DeleteAutomatedBackups", + "/properties/MasterUserPassword", + "/properties/Port", + "/properties/RestoreTime", + "/properties/SourceDBInstanceAutomatedBackupsArn", + "/properties/SourceDBInstanceIdentifier", + "/properties/SourceDbiResourceId", + "/properties/SourceRegion", + "/properties/TdeCredentialPassword", + "/properties/UseDefaultProcessorFeatures", + "/properties/UseLatestRestorableTime" + ] +} diff --git a/schema/aws-rds-dbparametergroup.json b/schema/aws-rds-dbparametergroup.json index ef46611..fa46ff0 100644 --- a/schema/aws-rds-dbparametergroup.json +++ b/schema/aws-rds-dbparametergroup.json @@ -1,119 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBParameterGroupName", - "/properties/Description", - "/properties/Family" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.\n This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.\n For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rds:AddTagsToResource", - "rds:CreateDBParameterGroup", - "rds:DescribeDBParameterGroups", - "rds:DescribeDBParameters", - "rds:DescribeEngineDefaultParameters", - "rds:ListTagsForResource", - "rds:ModifyDBParameterGroup", - "rds:RemoveTagsFromResource" - ] - }, - "delete": { - "permissions": [ - "rds:DeleteDBParameterGroup" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBParameterGroups" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBParameterGroups", - "rds:DescribeDBParameters", - "rds:DescribeEngineDefaultParameters", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:AddTagsToResource", - "rds:DescribeDBParameterGroups", - "rds:DescribeDBParameters", - "rds:DescribeEngineDefaultParameters", - "rds:ListTagsForResource", - "rds:ModifyDBParameterGroup", - "rds:ResetDBParameterGroup", - "rds:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DBParameterGroupName" - ], - "properties": { - "DBParameterGroupName": { - "description": "The name of the DB parameter group.\n Constraints:\n + Must be 1 to 255 letters, numbers, or hyphens.\n + First character must be a letter\n + Can't end with a hyphen or contain two consecutive hyphens\n \n If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.\n This value is stored as a lowercase string.", - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", - "type": "string" - }, - "Description": { - "description": "Provides the customer-specified description for this DB parameter group.", - "type": "string" - }, - "Family": { - "description": "The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.\n The DB parameter group family can't be changed when updating a DB parameter group.\n To list all of the available parameter group families, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`` \n The output contains duplicates.\n For more information, see ``CreateDBParameterGroup``.", - "type": "string" - }, - "Parameters": { - "description": "An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.\n RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.\n For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.", - "type": "object" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this DB parameter group.\n Currently, this is the only property that supports drift detection.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - } - }, - "propertyTransform": { - "/properties/DBParameterGroupName": "$lowercase(DBParameterGroupName)" - }, - "required": [ - "Family", - "Description" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::DBParameterGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBParameterGroupName", + "/properties/Description", + "/properties/Family" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.\n This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.\n For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rds:AddTagsToResource", + "rds:CreateDBParameterGroup", + "rds:DescribeDBParameterGroups", + "rds:DescribeDBParameters", + "rds:DescribeEngineDefaultParameters", + "rds:ListTagsForResource", + "rds:ModifyDBParameterGroup", + "rds:RemoveTagsFromResource" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteDBParameterGroup" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBParameterGroups" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBParameterGroups", + "rds:DescribeDBParameters", + "rds:DescribeEngineDefaultParameters", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:AddTagsToResource", + "rds:DescribeDBParameterGroups", + "rds:DescribeDBParameters", + "rds:DescribeEngineDefaultParameters", + "rds:ListTagsForResource", + "rds:ModifyDBParameterGroup", + "rds:ResetDBParameterGroup", + "rds:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DBParameterGroupName" + ], + "properties": { + "DBParameterGroupName": { + "description": "The name of the DB parameter group.\n Constraints:\n + Must be 1 to 255 letters, numbers, or hyphens.\n + First character must be a letter\n + Can't end with a hyphen or contain two consecutive hyphens\n \n If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.\n This value is stored as a lowercase string.", + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", + "type": "string" + }, + "Description": { + "description": "Provides the customer-specified description for this DB parameter group.", + "type": "string" + }, + "Family": { + "description": "The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.\n To list all of the available parameter group families for a DB engine, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine `` \n For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql`` \n The output contains duplicates.\n The following are the valid DB engine values:\n + ``aurora-mysql`` \n + ``aurora-postgresql`` \n + ``db2-ae`` \n + ``db2-se`` \n + ``mysql`` \n + ``oracle-ee`` \n + ``oracle-ee-cdb`` \n + ``oracle-se2`` \n + ``oracle-se2-cdb`` \n + ``postgres`` \n + ``sqlserver-ee`` \n + ``sqlserver-se`` \n + ``sqlserver-ex`` \n + ``sqlserver-web``", + "type": "string" + }, + "Parameters": { + "description": "An array of parameter names and values for the parameter update. You must specify at least one parameter name and value.\n For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.", + "type": "object" + }, + "Tags": { + "description": "Tags to assign to the DB parameter group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + } + }, + "propertyTransform": { + "/properties/DBParameterGroupName": "$lowercase(DBParameterGroupName)" + }, + "required": [ + "Family", + "Description" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBParameterGroup" +} diff --git a/schema/aws-rds-dbproxy.json b/schema/aws-rds-dbproxy.json index be20059..9719ecd 100644 --- a/schema/aws-rds-dbproxy.json +++ b/schema/aws-rds-dbproxy.json @@ -1,204 +1,204 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBProxyName", - "/properties/EngineFamily", - "/properties/VpcSubnetIds" - ], - "definitions": { - "AuthFormat": { - "additionalProperties": false, - "properties": { - "AuthScheme": { - "description": "The type of authentication that the proxy uses for connections from the proxy to the underlying database. ", - "enum": [ - "SECRETS" - ], - "type": "string" - }, - "ClientPasswordAuthType": { - "description": "The type of authentication the proxy uses for connections from clients.", - "enum": [ - "MYSQL_NATIVE_PASSWORD", - "POSTGRES_SCRAM_SHA_256", - "POSTGRES_MD5", - "SQL_SERVER_AUTHENTICATION" - ], - "type": "string" - }, - "Description": { - "description": "A user-specified description about the authentication used by a proxy to log in as a specific database user. ", - "type": "string" - }, - "IAMAuth": { - "description": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.", - "enum": [ - "DISABLED", - "REQUIRED", - "ENABLED" - ], - "type": "string" - }, - "SecretArn": { - "description": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. ", - "type": "string" - } - }, - "type": "object" - }, - "TagFormat": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", - "type": "string" - }, - "Value": { - "maxLength": 128, - "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::RDS::DBProxy", - "handlers": { - "create": { - "permissions": [ - "rds:CreateDBProxy", - "rds:DescribeDBProxies", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "rds:DescribeDBProxies", - "rds:DeleteDBProxy" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBProxies" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBProxies" - ] - }, - "update": { - "permissions": [ - "rds:ModifyDBProxy", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DBProxyName" - ], - "properties": { - "Auth": { - "description": "The authorization mechanism that the proxy uses.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AuthFormat" - }, - "minItems": 1, - "type": "array" - }, - "DBProxyArn": { - "description": "The Amazon Resource Name (ARN) for the proxy.", - "type": "string" - }, - "DBProxyName": { - "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.", - "maxLength": 64, - "pattern": "[0-z]*", - "type": "string" - }, - "DebugLogging": { - "description": "Whether the proxy includes detailed information about SQL statements in its logs.", - "type": "boolean" - }, - "Endpoint": { - "description": "The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.", - "type": "string" - }, - "EngineFamily": { - "description": "The kinds of databases that the proxy can connect to.", - "enum": [ - "MYSQL", - "POSTGRESQL", - "SQLSERVER" - ], - "type": "string" - }, - "IdleClientTimeout": { - "description": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.", - "type": "integer" - }, - "RequireTLS": { - "description": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.", - "type": "boolean" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.", - "type": "string" - }, - "Tags": { - "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagFormat" - }, - "type": "array" - }, - "VpcId": { - "description": "VPC ID to associate with the new DB proxy.", - "type": "string" - }, - "VpcSecurityGroupIds": { - "description": "VPC security group IDs to associate with the new proxy.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "VpcSubnetIds": { - "description": "VPC subnet IDs to associate with the new proxy.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 2, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/DBProxyArn", - "/properties/Endpoint", - "/properties/VpcId" - ], - "required": [ - "Auth", - "DBProxyName", - "EngineFamily", - "RoleArn", - "VpcSubnetIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RDS::DBProxy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBProxyName", + "/properties/EngineFamily", + "/properties/VpcSubnetIds" + ], + "definitions": { + "AuthFormat": { + "additionalProperties": false, + "properties": { + "AuthScheme": { + "description": "The type of authentication that the proxy uses for connections from the proxy to the underlying database. ", + "enum": [ + "SECRETS" + ], + "type": "string" + }, + "ClientPasswordAuthType": { + "description": "The type of authentication the proxy uses for connections from clients.", + "enum": [ + "MYSQL_NATIVE_PASSWORD", + "POSTGRES_SCRAM_SHA_256", + "POSTGRES_MD5", + "SQL_SERVER_AUTHENTICATION" + ], + "type": "string" + }, + "Description": { + "description": "A user-specified description about the authentication used by a proxy to log in as a specific database user. ", + "type": "string" + }, + "IAMAuth": { + "description": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.", + "enum": [ + "DISABLED", + "REQUIRED", + "ENABLED" + ], + "type": "string" + }, + "SecretArn": { + "description": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. ", + "type": "string" + } + }, + "type": "object" + }, + "TagFormat": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", + "type": "string" + }, + "Value": { + "maxLength": 128, + "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::RDS::DBProxy", + "handlers": { + "create": { + "permissions": [ + "rds:CreateDBProxy", + "rds:DescribeDBProxies", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "rds:DescribeDBProxies", + "rds:DeleteDBProxy" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBProxies" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBProxies" + ] + }, + "update": { + "permissions": [ + "rds:ModifyDBProxy", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DBProxyName" + ], + "properties": { + "Auth": { + "description": "The authorization mechanism that the proxy uses.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AuthFormat" + }, + "minItems": 1, + "type": "array" + }, + "DBProxyArn": { + "description": "The Amazon Resource Name (ARN) for the proxy.", + "type": "string" + }, + "DBProxyName": { + "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.", + "maxLength": 64, + "pattern": "[0-z]*", + "type": "string" + }, + "DebugLogging": { + "description": "Whether the proxy includes detailed information about SQL statements in its logs.", + "type": "boolean" + }, + "Endpoint": { + "description": "The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.", + "type": "string" + }, + "EngineFamily": { + "description": "The kinds of databases that the proxy can connect to.", + "enum": [ + "MYSQL", + "POSTGRESQL", + "SQLSERVER" + ], + "type": "string" + }, + "IdleClientTimeout": { + "description": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.", + "type": "integer" + }, + "RequireTLS": { + "description": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.", + "type": "boolean" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.", + "type": "string" + }, + "Tags": { + "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagFormat" + }, + "type": "array" + }, + "VpcId": { + "description": "VPC ID to associate with the new DB proxy.", + "type": "string" + }, + "VpcSecurityGroupIds": { + "description": "VPC security group IDs to associate with the new proxy.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "VpcSubnetIds": { + "description": "VPC subnet IDs to associate with the new proxy.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 2, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/DBProxyArn", + "/properties/Endpoint", + "/properties/VpcId" + ], + "required": [ + "Auth", + "DBProxyName", + "EngineFamily", + "RoleArn", + "VpcSubnetIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBProxy" +} diff --git a/schema/aws-rds-dbproxyendpoint.json b/schema/aws-rds-dbproxyendpoint.json index 8db2f30..f58af56 100644 --- a/schema/aws-rds-dbproxyendpoint.json +++ b/schema/aws-rds-dbproxyendpoint.json @@ -1,148 +1,148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBProxyName", - "/properties/DBProxyEndpointName", - "/properties/VpcSubnetIds" - ], - "definitions": { - "TagFormat": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", - "type": "string" - }, - "Value": { - "maxLength": 128, - "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::RDS::DBProxyEndpoint.", - "handlers": { - "create": { - "permissions": [ - "rds:CreateDBProxyEndpoint", - "rds:DescribeDBProxyEndpoints" - ] - }, - "delete": { - "permissions": [ - "rds:DescribeDBProxyEndpoints", - "rds:DeleteDBProxyEndpoint" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBProxyEndpoints" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBProxyEndpoints", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:ModifyDBProxyEndpoint", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DBProxyEndpointName" - ], - "properties": { - "DBProxyEndpointArn": { - "description": "The Amazon Resource Name (ARN) for the DB proxy endpoint.", - "pattern": "arn:aws[A-Za-z0-9-]{0,64}:rds:[A-Za-z0-9-]{1,64}:[0-9]{12}:.*", - "type": "string" - }, - "DBProxyEndpointName": { - "description": "The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.", - "maxLength": 64, - "pattern": "[0-z]*", - "type": "string" - }, - "DBProxyName": { - "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.", - "maxLength": 64, - "pattern": "[0-z]*", - "type": "string" - }, - "Endpoint": { - "description": "The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.", - "maxLength": 256, - "type": "string" - }, - "IsDefault": { - "description": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.", - "type": "boolean" - }, - "Tags": { - "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagFormat" - }, - "type": "array" - }, - "TargetRole": { - "description": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.", - "enum": [ - "READ_WRITE", - "READ_ONLY" - ], - "type": "string" - }, - "VpcId": { - "description": "VPC ID to associate with the new DB proxy endpoint.", - "type": "string" - }, - "VpcSecurityGroupIds": { - "description": "VPC security group IDs to associate with the new DB proxy endpoint.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "VpcSubnetIds": { - "description": "VPC subnet IDs to associate with the new DB proxy endpoint.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "minItems": 2, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/DBProxyEndpointArn", - "/properties/Endpoint", - "/properties/VpcId", - "/properties/IsDefault" - ], - "required": [ - "DBProxyName", - "DBProxyEndpointName", - "VpcSubnetIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RDS::DBProxyEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBProxyName", + "/properties/DBProxyEndpointName", + "/properties/VpcSubnetIds" + ], + "definitions": { + "TagFormat": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", + "type": "string" + }, + "Value": { + "maxLength": 128, + "pattern": "(\\w|\\d|\\s|\\\\|-|\\.:=+-)*", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::RDS::DBProxyEndpoint.", + "handlers": { + "create": { + "permissions": [ + "rds:CreateDBProxyEndpoint", + "rds:DescribeDBProxyEndpoints" + ] + }, + "delete": { + "permissions": [ + "rds:DescribeDBProxyEndpoints", + "rds:DeleteDBProxyEndpoint" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBProxyEndpoints" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBProxyEndpoints", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:ModifyDBProxyEndpoint", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DBProxyEndpointName" + ], + "properties": { + "DBProxyEndpointArn": { + "description": "The Amazon Resource Name (ARN) for the DB proxy endpoint.", + "pattern": "arn:aws[A-Za-z0-9-]{0,64}:rds:[A-Za-z0-9-]{1,64}:[0-9]{12}:.*", + "type": "string" + }, + "DBProxyEndpointName": { + "description": "The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.", + "maxLength": 64, + "pattern": "[0-z]*", + "type": "string" + }, + "DBProxyName": { + "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.", + "maxLength": 64, + "pattern": "[0-z]*", + "type": "string" + }, + "Endpoint": { + "description": "The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.", + "maxLength": 256, + "type": "string" + }, + "IsDefault": { + "description": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.", + "type": "boolean" + }, + "Tags": { + "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagFormat" + }, + "type": "array" + }, + "TargetRole": { + "description": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.", + "enum": [ + "READ_WRITE", + "READ_ONLY" + ], + "type": "string" + }, + "VpcId": { + "description": "VPC ID to associate with the new DB proxy endpoint.", + "type": "string" + }, + "VpcSecurityGroupIds": { + "description": "VPC security group IDs to associate with the new DB proxy endpoint.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "VpcSubnetIds": { + "description": "VPC subnet IDs to associate with the new DB proxy endpoint.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "minItems": 2, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/DBProxyEndpointArn", + "/properties/Endpoint", + "/properties/VpcId", + "/properties/IsDefault" + ], + "required": [ + "DBProxyName", + "DBProxyEndpointName", + "VpcSubnetIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::DBProxyEndpoint" +} diff --git a/schema/aws-rds-dbproxytargetgroup.json b/schema/aws-rds-dbproxytargetgroup.json index d9591bc..f3dfbc7 100644 --- a/schema/aws-rds-dbproxytargetgroup.json +++ b/schema/aws-rds-dbproxytargetgroup.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBProxyName", - "/properties/TargetGroupName" - ], - "definitions": { - "ConnectionPoolConfigurationInfoFormat": { - "additionalProperties": false, - "properties": { - "ConnectionBorrowTimeout": { - "description": "The number of seconds for a proxy to wait for a connection to become available in the connection pool.", - "type": "integer" - }, - "InitQuery": { - "description": "One or more SQL statements for the proxy to run when opening each new database connection.", - "type": "string" - }, - "MaxConnectionsPercent": { - "description": "The maximum size of the connection pool for each target in a target group.", - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "MaxIdleConnectionsPercent": { - "description": "Controls how actively the proxy closes idle database connections in the connection pool.", - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "SessionPinningFilters": { - "description": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::RDS::DBProxyTargetGroup", - "handlers": { - "create": { - "permissions": [ - "rds:DescribeDBProxies", - "rds:DescribeDBProxyTargetGroups", - "rds:ModifyDBProxyTargetGroup", - "rds:RegisterDBProxyTargets" - ] - }, - "delete": { - "permissions": [ - "rds:DeregisterDBProxyTargets" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBProxyTargetGroups" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBProxyTargetGroups", - "rds:DescribeDBProxyTargets" - ] - }, - "update": { - "permissions": [ - "rds:DescribeDBProxyTargetGroups", - "rds:ModifyDBProxyTargetGroup", - "rds:RegisterDBProxyTargets", - "rds:DeregisterDBProxyTargets" - ] - } - }, - "primaryIdentifier": [ - "/properties/TargetGroupArn" - ], - "properties": { - "ConnectionPoolConfigurationInfo": { - "$ref": "#/definitions/ConnectionPoolConfigurationInfoFormat" - }, - "DBClusterIdentifiers": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "DBInstanceIdentifiers": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "DBProxyName": { - "description": "The identifier for the proxy.", - "maxLength": 64, - "pattern": "[A-z][0-z]*", - "type": "string" - }, - "TargetGroupArn": { - "description": "The Amazon Resource Name (ARN) representing the target group.", - "type": "string" - }, - "TargetGroupName": { - "description": "The identifier for the DBProxyTargetGroup", - "enum": [ - "default" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TargetGroupArn" - ], - "required": [ - "DBProxyName", - "TargetGroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds-proxy", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::RDS::DBProxyTargetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBProxyName", + "/properties/TargetGroupName" + ], + "definitions": { + "ConnectionPoolConfigurationInfoFormat": { + "additionalProperties": false, + "properties": { + "ConnectionBorrowTimeout": { + "description": "The number of seconds for a proxy to wait for a connection to become available in the connection pool.", + "type": "integer" + }, + "InitQuery": { + "description": "One or more SQL statements for the proxy to run when opening each new database connection.", + "type": "string" + }, + "MaxConnectionsPercent": { + "description": "The maximum size of the connection pool for each target in a target group.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "MaxIdleConnectionsPercent": { + "description": "Controls how actively the proxy closes idle database connections in the connection pool.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "SessionPinningFilters": { + "description": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::RDS::DBProxyTargetGroup", + "handlers": { + "create": { + "permissions": [ + "rds:DescribeDBProxies", + "rds:DescribeDBProxyTargetGroups", + "rds:ModifyDBProxyTargetGroup", + "rds:RegisterDBProxyTargets" + ] + }, + "delete": { + "permissions": [ + "rds:DeregisterDBProxyTargets" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBProxyTargetGroups" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBProxyTargetGroups", + "rds:DescribeDBProxyTargets" + ] + }, + "update": { + "permissions": [ + "rds:DescribeDBProxyTargetGroups", + "rds:ModifyDBProxyTargetGroup", + "rds:RegisterDBProxyTargets", + "rds:DeregisterDBProxyTargets" + ] + } + }, + "primaryIdentifier": [ + "/properties/TargetGroupArn" + ], + "properties": { + "ConnectionPoolConfigurationInfo": { + "$ref": "#/definitions/ConnectionPoolConfigurationInfoFormat" + }, + "DBClusterIdentifiers": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "DBInstanceIdentifiers": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "DBProxyName": { + "description": "The identifier for the proxy.", + "maxLength": 64, + "pattern": "[A-z][0-z]*", + "type": "string" + }, + "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) representing the target group.", + "type": "string" + }, + "TargetGroupName": { + "description": "The identifier for the DBProxyTargetGroup", + "enum": [ + "default" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TargetGroupArn" + ], + "required": [ + "DBProxyName", + "TargetGroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds-proxy", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::RDS::DBProxyTargetGroup" +} diff --git a/schema/aws-rds-dbsecuritygroup.json b/schema/aws-rds-dbsecuritygroup.json index a5eddf0..77c04f4 100644 --- a/schema/aws-rds-dbsecuritygroup.json +++ b/schema/aws-rds-dbsecuritygroup.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GroupDescription", - "/properties/EC2VpcId" - ], - "definitions": { - "Ingress": { - "additionalProperties": false, - "properties": { - "CIDRIP": { - "type": "string" - }, - "EC2SecurityGroupId": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::RDS::DBSecurityGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DBSecurityGroupIngress": { - "items": { - "$ref": "#/definitions/Ingress" - }, - "type": "array", - "uniqueItems": true - }, - "EC2VpcId": { - "type": "string" - }, - "GroupDescription": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "GroupDescription", - "DBSecurityGroupIngress" - ], - "typeName": "AWS::RDS::DBSecurityGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupDescription", + "/properties/EC2VpcId" + ], + "definitions": { + "Ingress": { + "additionalProperties": false, + "properties": { + "CIDRIP": { + "type": "string" + }, + "EC2SecurityGroupId": { + "type": "string" + }, + "EC2SecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupOwnerId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::RDS::DBSecurityGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DBSecurityGroupIngress": { + "items": { + "$ref": "#/definitions/Ingress" + }, + "type": "array", + "uniqueItems": true + }, + "EC2VpcId": { + "type": "string" + }, + "GroupDescription": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "GroupDescription", + "DBSecurityGroupIngress" + ], + "typeName": "AWS::RDS::DBSecurityGroup" +} diff --git a/schema/aws-rds-dbsecuritygroupingress.json b/schema/aws-rds-dbsecuritygroupingress.json index 29fea30..89055da 100644 --- a/schema/aws-rds-dbsecuritygroupingress.json +++ b/schema/aws-rds-dbsecuritygroupingress.json @@ -1,34 +1,34 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::RDS::DBSecurityGroupIngress", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CIDRIP": { - "type": "string" - }, - "DBSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupId": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DBSecurityGroupName" - ], - "typeName": "AWS::RDS::DBSecurityGroupIngress" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::RDS::DBSecurityGroupIngress", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CIDRIP": { + "type": "string" + }, + "DBSecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupId": { + "type": "string" + }, + "EC2SecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupOwnerId": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DBSecurityGroupName" + ], + "typeName": "AWS::RDS::DBSecurityGroupIngress" +} diff --git a/schema/aws-rds-dbsubnetgroup.json b/schema/aws-rds-dbsubnetgroup.json index 15efc8b..a20f73b 100644 --- a/schema/aws-rds-dbsubnetgroup.json +++ b/schema/aws-rds-dbsubnetgroup.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DBSubnetGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. \n For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rds:CreateDBSubnetGroup", - "rds:DescribeDBSubnetGroups", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource", - "rds:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "rds:DeleteDBSubnetGroup", - "rds:DescribeDBSubnetGroups", - "rds:ListTagsForResource" - ] - }, - "list": { - "permissions": [ - "rds:DescribeDBSubnetGroups" - ] - }, - "read": { - "permissions": [ - "rds:DescribeDBSubnetGroups", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:ModifyDBSubnetGroup", - "rds:DescribeDBSubnetGroups", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource", - "rds:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DBSubnetGroupName" - ], - "properties": { - "DBSubnetGroupDescription": { - "description": "The description for the DB subnet group.", - "type": "string" - }, - "DBSubnetGroupName": { - "description": "The name for the DB subnet group. This value is stored as a lowercase string.\n Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be \"Default\".\n Example: ``mysubnetgroup``", - "type": "string" - }, - "SubnetIds": { - "description": "The EC2 Subnet IDs for the DB subnet group.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this DB subnet group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - } - }, - "propertyTransform": { - "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)" - }, - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::DBSubnetGroup", - "writeOnlyProperties": [ - "/properties/SubnetIds" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DBSubnetGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. \n For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rds:CreateDBSubnetGroup", + "rds:DescribeDBSubnetGroups", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource", + "rds:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteDBSubnetGroup", + "rds:DescribeDBSubnetGroups", + "rds:ListTagsForResource" + ] + }, + "list": { + "permissions": [ + "rds:DescribeDBSubnetGroups" + ] + }, + "read": { + "permissions": [ + "rds:DescribeDBSubnetGroups", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:ModifyDBSubnetGroup", + "rds:DescribeDBSubnetGroups", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource", + "rds:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DBSubnetGroupName" + ], + "properties": { + "DBSubnetGroupDescription": { + "description": "The description for the DB subnet group.", + "type": "string" + }, + "DBSubnetGroupName": { + "description": "The name for the DB subnet group. This value is stored as a lowercase string.\n Constraints:\n + Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.\n + Must not be default.\n + First character must be a letter.\n \n Example: ``mydbsubnetgroup``", + "type": "string" + }, + "SubnetIds": { + "description": "The EC2 Subnet IDs for the DB subnet group.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "Tags to assign to the DB subnet group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + } + }, + "propertyTransform": { + "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)" + }, + "required": [ + "DBSubnetGroupDescription", + "SubnetIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "typeName": "AWS::RDS::DBSubnetGroup", + "writeOnlyProperties": [ + "/properties/SubnetIds" + ] +} diff --git a/schema/aws-rds-eventsubscription.json b/schema/aws-rds-eventsubscription.json index c70603a..5234ef7 100644 --- a/schema/aws-rds-eventsubscription.json +++ b/schema/aws-rds-eventsubscription.json @@ -1,130 +1,141 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubscriptionName", - "/properties/SnsTopicArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::EventSubscription`` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rds:CreateEventSubscription", - "rds:DescribeEventSubscriptions", - "rds:ListTagsForResource", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ] - }, - "delete": { - "permissions": [ - "rds:DeleteEventSubscription", - "rds:DescribeEventSubscriptions" - ] - }, - "list": { - "permissions": [ - "rds:DescribeEventSubscriptions" - ] - }, - "read": { - "permissions": [ - "rds:DescribeEventSubscriptions", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:ModifyEventSubscription", - "rds:AddSourceIdentifierToSubscription", - "rds:RemoveSourceIdentifierFromSubscription", - "rds:DescribeEventSubscriptions", - "rds:ListTagsForResource", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubscriptionName" - ], - "properties": { - "Enabled": { - "default": true, - "description": "Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.", - "type": "boolean" - }, - "EventCategories": { - "description": "A list of event categories for a particular source type (``SourceType``) that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the ``DescribeEventCategories`` operation.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SnsTopicArn": { - "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.\n RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.", - "type": "string" - }, - "SourceIds": { - "description": "The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.\n Constraints:\n + If a ``SourceIds`` value is supplied, ``SourceType`` must also be provided.\n + If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.\n + If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.\n + If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.\n + If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.\n + If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.\n + If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SourceType": { - "description": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance``. If this value isn't specified, all events are returned.\n Valid values: ``db-instance`` | ``db-cluster`` | ``db-parameter-group`` | ``db-security-group`` | ``db-snapshot`` | ``db-cluster-snapshot``", - "type": "string" - }, - "SubscriptionName": { - "description": "The name of the subscription.\n Constraints: The name must be less than 255 characters.", - "maxLength": 255, - "type": "string" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this subscription.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - } - }, - "propertyTransform": { - "/properties/SubscriptionName": "$lowercase(SubscriptionName)" - }, - "required": [ - "SnsTopicArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::EventSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriptionName", + "/properties/SnsTopicArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::EventSubscription`` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rds:CreateEventSubscription", + "rds:DescribeEventSubscriptions", + "rds:ListTagsForResource", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteEventSubscription", + "rds:DescribeEventSubscriptions" + ] + }, + "list": { + "permissions": [ + "rds:DescribeEventSubscriptions" + ] + }, + "read": { + "permissions": [ + "rds:DescribeEventSubscriptions", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:ModifyEventSubscription", + "rds:AddSourceIdentifierToSubscription", + "rds:RemoveSourceIdentifierFromSubscription", + "rds:DescribeEventSubscriptions", + "rds:ListTagsForResource", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriptionName" + ], + "properties": { + "Enabled": { + "default": true, + "description": "Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.", + "type": "boolean" + }, + "EventCategories": { + "description": "A list of event categories for a particular source type (``SourceType``) that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the ``DescribeEventCategories`` operation.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SnsTopicArn": { + "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.\n RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.", + "type": "string" + }, + "SourceIds": { + "description": "The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.\n Constraints:\n + If ``SourceIds`` are supplied, ``SourceType`` must also be provided.\n + If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.\n + If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.\n + If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.\n + If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.\n + If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.\n + If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.\n + If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SourceType": { + "description": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance``. For RDS Proxy events, specify ``db-proxy``. If this value isn't specified, all events are returned.\n Valid Values:``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``", + "type": "string" + }, + "SubscriptionName": { + "description": "The name of the subscription.\n Constraints: The name must be less than 255 characters.", + "maxLength": 255, + "type": "string" + }, + "Tags": { + "description": "An optional array of key-value pairs to apply to this subscription.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + } + }, + "propertyTransform": { + "/properties/SubscriptionName": "$lowercase(SubscriptionName)" + }, + "required": [ + "SnsTopicArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::EventSubscription" +} diff --git a/schema/aws-rds-globalcluster.json b/schema/aws-rds-globalcluster.json index 7e19f15..0d194e3 100644 --- a/schema/aws-rds-globalcluster.json +++ b/schema/aws-rds-globalcluster.json @@ -1,107 +1,109 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GlobalClusterIdentifier", - "/properties/SourceDBClusterIdentifier", - "/properties/StorageEncrypted", - "/properties/Engine" - ], - "description": "Resource Type definition for AWS::RDS::GlobalCluster", - "handlers": { - "create": { - "permissions": [ - "rds:CreateGlobalCluster", - "rds:DescribeDBClusters", - "rds:DescribeGlobalClusters" - ] - }, - "delete": { - "permissions": [ - "rds:DescribeGlobalClusters", - "rds:DeleteGlobalCluster", - "rds:RemoveFromGlobalCluster", - "rds:DescribeDBClusters" - ] - }, - "list": { - "permissions": [ - "rds:DescribeGlobalClusters" - ] - }, - "read": { - "permissions": [ - "rds:DescribeGlobalClusters" - ] - }, - "update": { - "permissions": [ - "rds:ModifyGlobalCluster", - "rds:DescribeGlobalClusters" - ] - } - }, - "oneOf": [ - { - "required": [ - "SourceDBClusterIdentifier" - ] - }, - { - "required": [ - "Engine" - ] - } - ], - "primaryIdentifier": [ - "/properties/GlobalClusterIdentifier" - ], - "properties": { - "DeletionProtection": { - "description": "The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.", - "type": "boolean" - }, - "Engine": { - "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", - "enum": [ - "aurora", - "aurora-mysql", - "aurora-postgresql" - ], - "type": "string" - }, - "EngineLifecycleSupport": { - "description": "The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.", - "type": "string" - }, - "EngineVersion": { - "description": "The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", - "type": "string" - }, - "GlobalClusterIdentifier": { - "description": "The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.", - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "SourceDBClusterIdentifier": { - "description": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.", - "oneOf": [ - { - "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$" - }, - { - "pattern": "^(?=.{40,128}$)arn.*" - } - ], - "type": "string" - }, - "StorageEncrypted": { - "description": " The storage encryption setting for the new global database cluster.\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", - "type": "boolean" - } - }, - "propertyTransform": { - "/properties/GlobalClusterIdentifier": "$lowercase(GlobalClusterIdentifier)" - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::GlobalCluster" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GlobalClusterIdentifier", + "/properties/SourceDBClusterIdentifier", + "/properties/StorageEncrypted", + "/properties/Engine" + ], + "description": "Resource Type definition for AWS::RDS::GlobalCluster", + "handlers": { + "create": { + "permissions": [ + "rds:CreateGlobalCluster", + "rds:DescribeDBClusters", + "rds:DescribeGlobalClusters" + ] + }, + "delete": { + "permissions": [ + "rds:DescribeGlobalClusters", + "rds:DeleteGlobalCluster", + "rds:RemoveFromGlobalCluster", + "rds:DescribeDBClusters" + ] + }, + "list": { + "permissions": [ + "rds:DescribeGlobalClusters" + ] + }, + "read": { + "permissions": [ + "rds:DescribeGlobalClusters" + ] + }, + "update": { + "permissions": [ + "rds:ModifyGlobalCluster", + "rds:DescribeGlobalClusters" + ] + } + }, + "oneOf": [ + { + "required": [ + "SourceDBClusterIdentifier" + ] + }, + { + "required": [ + "Engine" + ] + } + ], + "primaryIdentifier": [ + "/properties/GlobalClusterIdentifier" + ], + "properties": { + "DeletionProtection": { + "description": "The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.", + "type": "boolean" + }, + "Engine": { + "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", + "enum": [ + "aurora", + "aurora-mysql", + "aurora-postgresql" + ], + "type": "string" + }, + "EngineLifecycleSupport": { + "description": "The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.", + "type": "string" + }, + "EngineVersion": { + "description": "The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", + "type": "string" + }, + "GlobalClusterIdentifier": { + "description": "The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "SourceDBClusterIdentifier": { + "description": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.", + "oneOf": [ + { + "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$" + }, + { + "pattern": "^(?=.{40,128}$)arn.*" + } + ], + "type": "string" + }, + "StorageEncrypted": { + "description": " The storage encryption setting for the new global database cluster.\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", + "type": "boolean" + } + }, + "propertyTransform": { + "/properties/GlobalClusterIdentifier": "$lowercase(GlobalClusterIdentifier)" + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "typeName": "AWS::RDS::GlobalCluster" +} diff --git a/schema/aws-rds-integration.json b/schema/aws-rds-integration.json index d1af9c2..107cdfe 100644 --- a/schema/aws-rds-integration.json +++ b/schema/aws-rds-integration.json @@ -1,174 +1,174 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourceArn", - "/properties/TargetArn", - "/properties/KMSKeyId", - "/properties/AdditionalEncryptionContext" - ], - "definitions": { - "EncryptionContextMap": { - "additionalProperties": false, - "description": "An optional set of non-secret key\u2013value pairs that contains additional contextual information about the data.", - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "description": "A zero-ETL integration with Amazon Redshift.", - "handlers": { - "create": { - "permissions": [ - "rds:CreateIntegration", - "rds:DescribeIntegrations", - "rds:AddTagsToResource", - "kms:CreateGrant", - "kms:DescribeKey", - "redshift:CreateInboundIntegration" - ] - }, - "delete": { - "permissions": [ - "rds:DeleteIntegration", - "rds:DescribeIntegrations" - ] - }, - "list": { - "permissions": [ - "rds:DescribeIntegrations" - ] - }, - "read": { - "permissions": [ - "rds:DescribeIntegrations" - ] - }, - "update": { - "permissions": [ - "rds:DescribeIntegrations", - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource", - "rds:ModifyIntegration" - ] - } - }, - "primaryIdentifier": [ - "/properties/IntegrationArn" - ], - "properties": { - "AdditionalEncryptionContext": { - "$ref": "#/definitions/EncryptionContextMap", - "description": "An optional set of non-secret key\u2013value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*.\n You can only include this parameter if you specify the ``KMSKeyId`` parameter." - }, - "CreateTime": { - "description": "", - "type": "string" - }, - "DataFilter": { - "description": "Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.", - "maxLength": 25600, - "minLength": 1, - "pattern": "[a-zA-Z0-9_ \"\\\\\\-$,*.:?+\\/]*", - "type": "string" - }, - "Description": { - "description": "A description of the integration.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "IntegrationArn": { - "description": "", - "type": "string" - }, - "IntegrationName": { - "description": "The name of the integration.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "KMSKeyId": { - "description": "The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.", - "type": "string" - }, - "SourceArn": { - "description": "The Amazon Resource Name (ARN) of the database to use as the source for replication.", - "type": "string" - }, - "Tags": { - "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "TargetArn": { - "description": "The ARN of the Redshift data warehouse to use as the target for replication.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", - "/properties/SourceArn": "$lowercase(SourceArn)" - }, - "readOnlyProperties": [ - "/properties/IntegrationArn", - "/properties/CreateTime" - ], - "required": [ - "SourceArn", - "TargetArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "permissions": [ - "rds:AddTagsToResource", - "rds:RemoveTagsFromResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RDS::Integration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceArn", + "/properties/TargetArn", + "/properties/KMSKeyId", + "/properties/AdditionalEncryptionContext" + ], + "definitions": { + "EncryptionContextMap": { + "additionalProperties": false, + "description": "An optional set of non-secret key\u2013value pairs that contains additional contextual information about the data.", + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "description": "A zero-ETL integration with Amazon Redshift.", + "handlers": { + "create": { + "permissions": [ + "rds:CreateIntegration", + "rds:DescribeIntegrations", + "rds:AddTagsToResource", + "kms:CreateGrant", + "kms:DescribeKey", + "redshift:CreateInboundIntegration" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteIntegration", + "rds:DescribeIntegrations" + ] + }, + "list": { + "permissions": [ + "rds:DescribeIntegrations" + ] + }, + "read": { + "permissions": [ + "rds:DescribeIntegrations" + ] + }, + "update": { + "permissions": [ + "rds:DescribeIntegrations", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource", + "rds:ModifyIntegration" + ] + } + }, + "primaryIdentifier": [ + "/properties/IntegrationArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap", + "description": "An optional set of non-secret key\u2013value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*.\n You can only include this parameter if you specify the ``KMSKeyId`` parameter." + }, + "CreateTime": { + "description": "", + "type": "string" + }, + "DataFilter": { + "description": "Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.", + "maxLength": 25600, + "minLength": 1, + "pattern": "[a-zA-Z0-9_ \"\\\\\\-$,*.:?+\\/]*", + "type": "string" + }, + "Description": { + "description": "A description of the integration.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "IntegrationArn": { + "description": "", + "type": "string" + }, + "IntegrationName": { + "description": "The name of the integration.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "KMSKeyId": { + "description": "The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.", + "type": "string" + }, + "SourceArn": { + "description": "The Amazon Resource Name (ARN) of the database to use as the source for replication.", + "type": "string" + }, + "Tags": { + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TargetArn": { + "description": "The ARN of the Redshift data warehouse to use as the target for replication.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", + "/properties/SourceArn": "$lowercase(SourceArn)" + }, + "readOnlyProperties": [ + "/properties/IntegrationArn", + "/properties/CreateTime" + ], + "required": [ + "SourceArn", + "TargetArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::Integration" +} diff --git a/schema/aws-rds-optiongroup.json b/schema/aws-rds-optiongroup.json index 7072aeb..33efc94 100644 --- a/schema/aws-rds-optiongroup.json +++ b/schema/aws-rds-optiongroup.json @@ -1,186 +1,197 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EngineName", - "/properties/MajorEngineVersion", - "/properties/OptionGroupDescription", - "/properties/OptionGroupName" - ], - "definitions": { - "OptionConfiguration": { - "additionalProperties": false, - "description": "The ``OptionConfiguration`` property type specifies an individual option, and its settings, within an ``AWS::RDS::OptionGroup`` resource.", - "properties": { - "DBSecurityGroupMemberships": { - "description": "A list of DBSecurityGroupMembership name strings used for this option.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "OptionName": { - "description": "The configuration of options to include in a group.", - "type": "string" - }, - "OptionSettings": { - "description": "The option settings to include in an option group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OptionSetting" - }, - "type": "array" - }, - "OptionVersion": { - "description": "The version for the option.", - "type": "string" - }, - "Port": { - "description": "The optional port for the option.", - "type": "integer" - }, - "VpcSecurityGroupMemberships": { - "description": "A list of VpcSecurityGroupMembership name strings used for this option.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "OptionName" - ], - "type": "object" - }, - "OptionSetting": { - "additionalProperties": false, - "description": "The ``OptionSetting`` property type specifies the value for an option within an ``OptionSetting`` property.", - "properties": { - "Name": { - "description": "The name of the option that has settings that you can set.", - "type": "string" - }, - "Value": { - "description": "The current value of the option setting.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", - "properties": { - "Key": { - "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::RDS::OptionGroup`` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rds:AddTagsToResource", - "rds:CreateOptionGroup", - "rds:DescribeOptionGroups", - "rds:ListTagsForResource", - "rds:ModifyOptionGroup", - "rds:RemoveTagsFromResource" - ] - }, - "delete": { - "permissions": [ - "rds:DeleteOptionGroup", - "rds:DescribeOptionGroups", - "rds:ListTagsForResource", - "rds:RemoveTagsFromResource" - ] - }, - "list": { - "permissions": [ - "rds:DescribeOptionGroups" - ] - }, - "read": { - "permissions": [ - "rds:DescribeOptionGroups", - "rds:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rds:AddTagsToResource", - "rds:DescribeOptionGroups", - "rds:ListTagsForResource", - "rds:ModifyOptionGroup", - "rds:RemoveTagsFromResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/OptionGroupName" - ], - "properties": { - "EngineName": { - "description": "Specifies the name of the engine that this option group should be associated with.\n Valid Values: \n + ``mariadb`` \n + ``mysql`` \n + ``oracle-ee`` \n + ``oracle-ee-cdb`` \n + ``oracle-se2`` \n + ``oracle-se2-cdb`` \n + ``postgres`` \n + ``sqlserver-ee`` \n + ``sqlserver-se`` \n + ``sqlserver-ex`` \n + ``sqlserver-web``", - "type": "string" - }, - "MajorEngineVersion": { - "description": "Specifies the major version of the engine that this option group should be associated with.", - "type": "string" - }, - "OptionConfigurations": { - "arrayType": "AttributeList", - "description": "A list of options and the settings for each option.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/OptionConfiguration" - }, - "type": "array" - }, - "OptionGroupDescription": { - "description": "The description of the option group.", - "type": "string" - }, - "OptionGroupName": { - "description": "The name of the option group to be created.\n Constraints:\n + Must be 1 to 255 letters, numbers, or hyphens\n + First character must be a letter\n + Can't end with a hyphen or contain two consecutive hyphens\n \n Example: ``myoptiongroup`` \n If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group.\n This value is stored as a lowercase string.", - "type": "string" - }, - "Tags": { - "description": "An optional array of key-value pairs to apply to this option group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "propertyTransform": { - "/properties/OptionGroupName": "$lowercase(OptionGroupName)" - }, - "required": [ - "EngineName", - "MajorEngineVersion", - "OptionGroupDescription" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "typeName": "AWS::RDS::OptionGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EngineName", + "/properties/MajorEngineVersion", + "/properties/OptionGroupDescription", + "/properties/OptionGroupName" + ], + "definitions": { + "OptionConfiguration": { + "additionalProperties": false, + "description": "The ``OptionConfiguration`` property type specifies an individual option, and its settings, within an ``AWS::RDS::OptionGroup`` resource.", + "properties": { + "DBSecurityGroupMemberships": { + "description": "A list of DB security groups used for this option.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "OptionName": { + "description": "The configuration of options to include in a group.", + "type": "string" + }, + "OptionSettings": { + "description": "The option settings to include in an option group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OptionSetting" + }, + "type": "array" + }, + "OptionVersion": { + "description": "The version for the option.", + "type": "string" + }, + "Port": { + "description": "The optional port for the option.", + "type": "integer" + }, + "VpcSecurityGroupMemberships": { + "description": "A list of VPC security group names used for this option.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "OptionName" + ], + "type": "object" + }, + "OptionSetting": { + "additionalProperties": false, + "description": "The ``OptionSetting`` property type specifies the value for an option within an ``OptionSetting`` property.", + "properties": { + "Name": { + "description": "The name of the option that has settings that you can set.", + "type": "string" + }, + "Value": { + "description": "The current value of the option setting.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", + "properties": { + "Key": { + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::RDS::OptionGroup`` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rds:AddTagsToResource", + "rds:CreateOptionGroup", + "rds:DescribeOptionGroups", + "rds:ListTagsForResource", + "rds:ModifyOptionGroup", + "rds:RemoveTagsFromResource" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteOptionGroup", + "rds:DescribeOptionGroups", + "rds:ListTagsForResource", + "rds:RemoveTagsFromResource" + ] + }, + "list": { + "permissions": [ + "rds:DescribeOptionGroups" + ] + }, + "read": { + "permissions": [ + "rds:DescribeOptionGroups", + "rds:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rds:AddTagsToResource", + "rds:DescribeOptionGroups", + "rds:ListTagsForResource", + "rds:ModifyOptionGroup", + "rds:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/OptionGroupName" + ], + "properties": { + "EngineName": { + "description": "Specifies the name of the engine that this option group should be associated with.\n Valid Values: \n + ``mariadb`` \n + ``mysql`` \n + ``oracle-ee`` \n + ``oracle-ee-cdb`` \n + ``oracle-se2`` \n + ``oracle-se2-cdb`` \n + ``postgres`` \n + ``sqlserver-ee`` \n + ``sqlserver-se`` \n + ``sqlserver-ex`` \n + ``sqlserver-web``", + "type": "string" + }, + "MajorEngineVersion": { + "description": "Specifies the major version of the engine that this option group should be associated with.", + "type": "string" + }, + "OptionConfigurations": { + "arrayType": "AttributeList", + "description": "A list of all available options for an option group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/OptionConfiguration" + }, + "type": "array" + }, + "OptionGroupDescription": { + "description": "The description of the option group.", + "type": "string" + }, + "OptionGroupName": { + "description": "The name of the option group to be created.\n Constraints:\n + Must be 1 to 255 letters, numbers, or hyphens\n + First character must be a letter\n + Can't end with a hyphen or contain two consecutive hyphens\n \n Example: ``myoptiongroup`` \n If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group.\n This value is stored as a lowercase string.", + "type": "string" + }, + "Tags": { + "description": "Tags to assign to the option group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "propertyTransform": { + "/properties/OptionGroupName": "$lowercase(OptionGroupName)" + }, + "required": [ + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::OptionGroup" +} diff --git a/schema/aws-redshift-cluster.json b/schema/aws-redshift-cluster.json index 1e399f7..3073908 100644 --- a/schema/aws-redshift-cluster.json +++ b/schema/aws-redshift-cluster.json @@ -1,484 +1,495 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterIdentifier", - "/properties/OwnerAccount", - "/properties/SnapshotIdentifier", - "/properties/DBName", - "/properties/SnapshotClusterIdentifier", - "/properties/ClusterSubnetGroupName", - "/properties/MasterUsername" - ], - "definitions": { - "Endpoint": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Port": { - "type": "string" - } - }, - "type": "object" - }, - "LoggingProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "redshift:DescribeClusters", - "redshift:CreateCluster", - "redshift:RestoreFromClusterSnapshot", - "redshift:EnableLogging", - "redshift:DescribeLoggingStatus", - "redshift:CreateTags", - "redshift:DescribeTags", - "redshift:GetResourcePolicy", - "redshift:PutResourcePolicy", - "redshift:ModifyClusterMaintenance", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeAddresses", - "ec2:AssociateAddress", - "ec2:CreateNetworkInterface", - "ec2:ModifyNetworkInterfaceAttribute", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcEndpoints", - "ec2:ModifyVpcEndpoint", - "ec2:AllocateAddress", - "ec2:CreateSecurityGroup", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroupRules", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeNetworkAcls", - "ec2:DescribeRouteTables", - "cloudwatch:PutMetricData" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeClusters", - "redshift:DeleteCluster" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeClusters" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeClusters", - "redshift:DescribeLoggingStatus", - "redshift:DescribeSnapshotCopyGrant", - "redshift:DescribeClusterDbRevisions", - "redshift:DescribeTags", - "redshift:GetResourcePolicy" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "redshift:DescribeClusters", - "redshift:ModifyCluster", - "redshift:ModifyClusterIamRoles", - "redshift:EnableLogging", - "redshift:CreateTags", - "redshift:DeleteTags", - "redshift:DescribeTags", - "redshift:DisableLogging", - "redshift:DescribeLoggingStatus", - "redshift:RebootCluster", - "redshift:EnableSnapshotCopy", - "redshift:DisableSnapshotCopy", - "redshift:ModifySnapshotCopyRetentionPeriod", - "redshift:ModifyAquaConfiguration", - "redshift:ResizeCluster", - "redshift:ModifyClusterMaintenance", - "redshift:DescribeClusterDbRevisions", - "redshift:ModifyClusterDbRevisions", - "redshift:PauseCluster", - "redshift:ResumeCluster", - "redshift:RotateEncryptionKey", - "redshift:FailoverPrimaryCompute", - "redshift:PutResourcePolicy", - "redshift:GetResourcePolicy", - "redshift:DeleteResourcePolicy", - "cloudwatch:PutMetricData" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/ClusterIdentifier" - ], - "properties": { - "AllowVersionUpgrade": { - "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True", - "type": "boolean" - }, - "AquaConfigurationStatus": { - "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.\n\nenabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.\ndisabled - Don't use AQUA.\nauto - Amazon Redshift determines whether to use AQUA.\n", - "type": "string" - }, - "AutomatedSnapshotRetentionPeriod": { - "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1", - "type": "integer" - }, - "AvailabilityZone": { - "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint", - "type": "string" - }, - "AvailabilityZoneRelocation": { - "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.", - "type": "boolean" - }, - "AvailabilityZoneRelocationStatus": { - "description": "The availability zone relocation status of the cluster", - "type": "string" - }, - "Classic": { - "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.", - "type": "boolean" - }, - "ClusterIdentifier": { - "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account", - "maxLength": 63, - "type": "string" - }, - "ClusterNamespaceArn": { - "description": "The Amazon Resource Name (ARN) of the cluster namespace.", - "type": "string" - }, - "ClusterParameterGroupName": { - "description": "The name of the parameter group to be associated with this cluster.", - "maxLength": 255, - "type": "string" - }, - "ClusterSecurityGroups": { - "description": "A list of security groups to be associated with this cluster.", - "insertionOrder": false, - "items": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::SecurityGroup" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::Redshift::ClusterSecurityGroup" - } - } - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ClusterSubnetGroupName": { - "description": "The name of a cluster subnet group to be associated with this cluster.", - "type": "string" - }, - "ClusterType": { - "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required", - "type": "string" - }, - "ClusterVersion": { - "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.", - "type": "string" - }, - "DBName": { - "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.", - "type": "string" - }, - "DeferMaintenance": { - "description": "A boolean indicating whether to enable the deferred maintenance window.", - "type": "boolean" - }, - "DeferMaintenanceDuration": { - "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.", - "type": "integer" - }, - "DeferMaintenanceEndTime": { - "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.", - "type": "string" - }, - "DeferMaintenanceIdentifier": { - "description": "A unique identifier for the deferred maintenance window.", - "type": "string" - }, - "DeferMaintenanceStartTime": { - "description": "A timestamp indicating the start time for the deferred maintenance window.", - "type": "string" - }, - "DestinationRegion": { - "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference", - "type": "string" - }, - "ElasticIp": { - "description": "The Elastic IP (EIP) address for the cluster.", - "type": "string" - }, - "Encrypted": { - "description": "If true, the data in the cluster is encrypted at rest.", - "type": "boolean" - }, - "Endpoint": { - "$ref": "#/definitions/Endpoint" - }, - "EnhancedVpcRouting": { - "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.\n\nIf this option is true , enhanced VPC routing is enabled.\n\nDefault: false", - "type": "boolean" - }, - "HsmClientCertificateIdentifier": { - "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM", - "type": "string" - }, - "HsmConfigurationIdentifier": { - "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.", - "type": "string" - }, - "IamRoles": { - "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request", - "insertionOrder": false, - "items": { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::IAM::Role" - }, - "type": "string" - }, - "maxItems": 50, - "type": "array" - }, - "KmsKeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - } - ], - "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.", - "type": "string" - }, - "LoggingProperties": { - "$ref": "#/definitions/LoggingProperties" - }, - "MaintenanceTrackName": { - "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.", - "type": "string" - }, - "ManageMasterPassword": { - "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.", - "type": "boolean" - }, - "ManualSnapshotRetentionPeriod": { - "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.\n\nThe value must be either -1 or an integer between 1 and 3,653.", - "type": "integer" - }, - "MasterPasswordSecretArn": { - "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.", - "type": "string" - }, - "MasterPasswordSecretKmsKeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - } - ], - "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.", - "type": "string" - }, - "MasterUserPassword": { - "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.", - "maxLength": 64, - "type": "string" - }, - "MasterUsername": { - "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.", - "maxLength": 128, - "type": "string" - }, - "MultiAZ": { - "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.", - "type": "boolean" - }, - "NamespaceResourcePolicy": { - "description": "The namespace resource policy document that will be attached to a Redshift cluster.", - "type": "object" - }, - "NodeType": { - "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge", - "type": "string" - }, - "NumberOfNodes": { - "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.", - "type": "integer" - }, - "OwnerAccount": { - "type": "string" - }, - "Port": { - "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings", - "type": "integer" - }, - "PreferredMaintenanceWindow": { - "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur.", - "type": "string" - }, - "PubliclyAccessible": { - "description": "If true, the cluster can be accessed from a public network.", - "type": "boolean" - }, - "ResourceAction": { - "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs", - "type": "string" - }, - "RevisionTarget": { - "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.", - "type": "string" - }, - "RotateEncryptionKey": { - "description": "A boolean indicating if we want to rotate Encryption Keys.", - "type": "boolean" - }, - "SnapshotClusterIdentifier": { - "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.", - "type": "string" - }, - "SnapshotCopyGrantName": { - "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.", - "type": "string" - }, - "SnapshotCopyManual": { - "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.", - "type": "boolean" - }, - "SnapshotCopyRetentionPeriod": { - "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. \n\n Default is 7. \n\n Constraints: Must be at least 1 and no more than 35.", - "type": "integer" - }, - "SnapshotIdentifier": { - "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.", - "type": "string" - }, - "Tags": { - "description": "The list of tags for the cluster parameter group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "VpcSecurityGroupIds": { - "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.", - "insertionOrder": false, - "items": { - "relationshipRef": { - "propertyPath": "/properties/VpcId", - "typeName": "AWS::EC2::VPC" - }, - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/DeferMaintenanceIdentifier", - "/properties/Endpoint/Port", - "/properties/Endpoint/Address", - "/properties/ClusterNamespaceArn", - "/properties/MasterPasswordSecretArn" - ], - "required": [ - "NodeType", - "MasterUsername", - "DBName", - "ClusterType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::Redshift::Cluster", - "writeOnlyProperties": [ - "/properties/MasterUserPassword", - "/properties/Classic", - "/properties/SnapshotIdentifier", - "/properties/DeferMaintenance", - "/properties/DeferMaintenanceDuration", - "/properties/ManageMasterPassword" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterIdentifier", + "/properties/OwnerAccount", + "/properties/SnapshotIdentifier", + "/properties/DBName", + "/properties/SnapshotClusterIdentifier", + "/properties/ClusterSubnetGroupName", + "/properties/MasterUsername" + ], + "definitions": { + "Endpoint": { + "additionalProperties": false, + "properties": { + "Address": { + "type": "string" + }, + "Port": { + "type": "string" + } + }, + "type": "object" + }, + "LoggingProperties": { + "additionalProperties": false, + "properties": { + "BucketName": { + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "LogDestinationType": { + "type": "string" + }, + "LogExports": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 3, + "type": "array" + }, + "S3KeyPrefix": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "redshift:DescribeClusters", + "redshift:CreateCluster", + "redshift:RestoreFromClusterSnapshot", + "redshift:EnableLogging", + "redshift:DescribeLoggingStatus", + "redshift:CreateTags", + "redshift:DescribeTags", + "redshift:GetResourcePolicy", + "redshift:PutResourcePolicy", + "redshift:ModifyClusterMaintenance", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeAddresses", + "ec2:AssociateAddress", + "ec2:CreateNetworkInterface", + "ec2:ModifyNetworkInterfaceAttribute", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "ec2:ModifyVpcEndpoint", + "ec2:AllocateAddress", + "ec2:CreateSecurityGroup", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroupRules", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeNetworkAcls", + "ec2:DescribeRouteTables", + "cloudwatch:PutMetricData" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeClusters", + "redshift:DeleteCluster" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeClusters" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeClusters", + "redshift:DescribeLoggingStatus", + "redshift:DescribeSnapshotCopyGrant", + "redshift:DescribeClusterDbRevisions", + "redshift:DescribeTags", + "redshift:GetResourcePolicy" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "redshift:DescribeClusters", + "redshift:ModifyCluster", + "redshift:ModifyClusterIamRoles", + "redshift:EnableLogging", + "redshift:CreateTags", + "redshift:DeleteTags", + "redshift:DescribeTags", + "redshift:DisableLogging", + "redshift:DescribeLoggingStatus", + "redshift:RebootCluster", + "redshift:EnableSnapshotCopy", + "redshift:DisableSnapshotCopy", + "redshift:ModifySnapshotCopyRetentionPeriod", + "redshift:ModifyAquaConfiguration", + "redshift:ResizeCluster", + "redshift:ModifyClusterMaintenance", + "redshift:DescribeClusterDbRevisions", + "redshift:ModifyClusterDbRevisions", + "redshift:PauseCluster", + "redshift:ResumeCluster", + "redshift:RotateEncryptionKey", + "redshift:FailoverPrimaryCompute", + "redshift:PutResourcePolicy", + "redshift:GetResourcePolicy", + "redshift:DeleteResourcePolicy", + "cloudwatch:PutMetricData" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/ClusterIdentifier" + ], + "properties": { + "AllowVersionUpgrade": { + "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True", + "type": "boolean" + }, + "AquaConfigurationStatus": { + "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.\n\nenabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.\ndisabled - Don't use AQUA.\nauto - Amazon Redshift determines whether to use AQUA.\n", + "type": "string" + }, + "AutomatedSnapshotRetentionPeriod": { + "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1", + "type": "integer" + }, + "AvailabilityZone": { + "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint", + "type": "string" + }, + "AvailabilityZoneRelocation": { + "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.", + "type": "boolean" + }, + "AvailabilityZoneRelocationStatus": { + "description": "The availability zone relocation status of the cluster", + "type": "string" + }, + "Classic": { + "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.", + "type": "boolean" + }, + "ClusterIdentifier": { + "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account", + "maxLength": 63, + "type": "string" + }, + "ClusterNamespaceArn": { + "description": "The Amazon Resource Name (ARN) of the cluster namespace.", + "type": "string" + }, + "ClusterParameterGroupName": { + "description": "The name of the parameter group to be associated with this cluster.", + "maxLength": 255, + "type": "string" + }, + "ClusterSecurityGroups": { + "description": "A list of security groups to be associated with this cluster.", + "insertionOrder": false, + "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Redshift::ClusterSecurityGroup" + } + } + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ClusterSubnetGroupName": { + "description": "The name of a cluster subnet group to be associated with this cluster.", + "type": "string" + }, + "ClusterType": { + "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required", + "type": "string" + }, + "ClusterVersion": { + "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.", + "type": "string" + }, + "DBName": { + "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.", + "type": "string" + }, + "DeferMaintenance": { + "description": "A boolean indicating whether to enable the deferred maintenance window.", + "type": "boolean" + }, + "DeferMaintenanceDuration": { + "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.", + "type": "integer" + }, + "DeferMaintenanceEndTime": { + "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.", + "type": "string" + }, + "DeferMaintenanceIdentifier": { + "description": "A unique identifier for the deferred maintenance window.", + "type": "string" + }, + "DeferMaintenanceStartTime": { + "description": "A timestamp indicating the start time for the deferred maintenance window.", + "type": "string" + }, + "DestinationRegion": { + "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference", + "type": "string" + }, + "ElasticIp": { + "description": "The Elastic IP (EIP) address for the cluster.", + "type": "string" + }, + "Encrypted": { + "description": "If true, the data in the cluster is encrypted at rest.", + "type": "boolean" + }, + "Endpoint": { + "$ref": "#/definitions/Endpoint" + }, + "EnhancedVpcRouting": { + "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.\n\nIf this option is true , enhanced VPC routing is enabled.\n\nDefault: false", + "type": "boolean" + }, + "HsmClientCertificateIdentifier": { + "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM", + "type": "string" + }, + "HsmConfigurationIdentifier": { + "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.", + "type": "string" + }, + "IamRoles": { + "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request", + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "maxItems": 50, + "type": "array" + }, + "KmsKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], + "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.", + "type": "string" + }, + "LoggingProperties": { + "$ref": "#/definitions/LoggingProperties" + }, + "MaintenanceTrackName": { + "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.", + "type": "string" + }, + "ManageMasterPassword": { + "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.", + "type": "boolean" + }, + "ManualSnapshotRetentionPeriod": { + "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.\n\nThe value must be either -1 or an integer between 1 and 3,653.", + "type": "integer" + }, + "MasterPasswordSecretArn": { + "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.", + "type": "string" + }, + "MasterPasswordSecretKmsKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], + "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.", + "type": "string" + }, + "MasterUserPassword": { + "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.", + "maxLength": 64, + "type": "string" + }, + "MasterUsername": { + "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.", + "maxLength": 128, + "type": "string" + }, + "MultiAZ": { + "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.", + "type": "boolean" + }, + "NamespaceResourcePolicy": { + "description": "The namespace resource policy document that will be attached to a Redshift cluster.", + "type": "object" + }, + "NodeType": { + "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge", + "type": "string" + }, + "NumberOfNodes": { + "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.", + "type": "integer" + }, + "OwnerAccount": { + "type": "string" + }, + "Port": { + "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings", + "type": "integer" + }, + "PreferredMaintenanceWindow": { + "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur.", + "type": "string" + }, + "PubliclyAccessible": { + "description": "If true, the cluster can be accessed from a public network.", + "type": "boolean" + }, + "ResourceAction": { + "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs", + "type": "string" + }, + "RevisionTarget": { + "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.", + "type": "string" + }, + "RotateEncryptionKey": { + "description": "A boolean indicating if we want to rotate Encryption Keys.", + "type": "boolean" + }, + "SnapshotClusterIdentifier": { + "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.", + "type": "string" + }, + "SnapshotCopyGrantName": { + "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.", + "type": "string" + }, + "SnapshotCopyManual": { + "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.", + "type": "boolean" + }, + "SnapshotCopyRetentionPeriod": { + "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. \n\n Default is 7. \n\n Constraints: Must be at least 1 and no more than 35.", + "type": "integer" + }, + "SnapshotIdentifier": { + "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.", + "type": "string" + }, + "Tags": { + "description": "The list of tags for the cluster parameter group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "VpcSecurityGroupIds": { + "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.", + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/DeferMaintenanceIdentifier", + "/properties/Endpoint/Port", + "/properties/Endpoint/Address", + "/properties/ClusterNamespaceArn", + "/properties/MasterPasswordSecretArn" + ], + "required": [ + "NodeType", + "MasterUsername", + "DBName", + "ClusterType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": true + }, + "typeName": "AWS::Redshift::Cluster", + "writeOnlyProperties": [ + "/properties/MasterUserPassword", + "/properties/Classic", + "/properties/SnapshotIdentifier", + "/properties/DeferMaintenance", + "/properties/DeferMaintenanceDuration", + "/properties/ManageMasterPassword" + ] +} diff --git a/schema/aws-redshift-clusterparametergroup.json b/schema/aws-redshift-clusterparametergroup.json index 6ba4f11..c0e8243 100644 --- a/schema/aws-redshift-clusterparametergroup.json +++ b/schema/aws-redshift-clusterparametergroup.json @@ -1,158 +1,158 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ParameterGroupName", - "/properties/ParameterGroupFamily", - "/properties/Description" - ], - "definitions": { - "Parameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "description": "The name of the parameter.", - "type": "string" - }, - "ParameterValue": { - "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters.", - "type": "string" - } - }, - "required": [ - "ParameterValue", - "ParameterName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Redshift::ClusterParameterGroup", - "handlers": { - "create": { - "permissions": [ - "redshift:CreateClusterParameterGroup", - "redshift:ModifyClusterParameterGroup", - "redshift:DescribeClusterParameterGroups", - "redshift:DescribeClusterParameters", - "redshift:DescribeTags", - "redshift:CreateTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeClusterParameterGroups", - "redshift:DeleteClusterParameterGroup", - "redshift:DescribeClusterParameters", - "initech:DeleteReport" - ] - }, - "list": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeClusterParameterGroups", - "redshift:DescribeClusterParameters", - "initech:ListReports" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeClusterParameterGroups", - "initech:DescribeReport", - "redshift:DescribeClusterParameters", - "redshift:DescribeTags" - ] - }, - "update": { - "permissions": [ - "redshift:DescribeClusterParameterGroups", - "redshift:ResetClusterParameterGroup", - "redshift:ModifyClusterParameterGroup", - "redshift:DescribeClusterParameters", - "redshift:DescribeTags", - "redshift:CreateTags", - "redshift:DeleteTags", - "initech:UpdateReport" - ] - } - }, - "primaryIdentifier": [ - "/properties/ParameterGroupName" - ], - "properties": { - "Description": { - "description": "A description of the parameter group.", - "type": "string" - }, - "ParameterGroupFamily": { - "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.", - "type": "string" - }, - "ParameterGroupName": { - "description": "The name of the cluster parameter group.", - "maxLength": 255, - "type": "string" - }, - "Parameters": { - "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Parameter" - }, - "type": "array" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "ParameterGroupFamily" - ], - "tagging": { - "taggable": true - }, - "typeName": "AWS::Redshift::ClusterParameterGroup", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ParameterGroupName", + "/properties/ParameterGroupFamily", + "/properties/Description" + ], + "definitions": { + "Parameter": { + "additionalProperties": false, + "properties": { + "ParameterName": { + "description": "The name of the parameter.", + "type": "string" + }, + "ParameterValue": { + "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters.", + "type": "string" + } + }, + "required": [ + "ParameterValue", + "ParameterName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Redshift::ClusterParameterGroup", + "handlers": { + "create": { + "permissions": [ + "redshift:CreateClusterParameterGroup", + "redshift:ModifyClusterParameterGroup", + "redshift:DescribeClusterParameterGroups", + "redshift:DescribeClusterParameters", + "redshift:DescribeTags", + "redshift:CreateTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeClusterParameterGroups", + "redshift:DeleteClusterParameterGroup", + "redshift:DescribeClusterParameters", + "initech:DeleteReport" + ] + }, + "list": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeClusterParameterGroups", + "redshift:DescribeClusterParameters", + "initech:ListReports" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeClusterParameterGroups", + "initech:DescribeReport", + "redshift:DescribeClusterParameters", + "redshift:DescribeTags" + ] + }, + "update": { + "permissions": [ + "redshift:DescribeClusterParameterGroups", + "redshift:ResetClusterParameterGroup", + "redshift:ModifyClusterParameterGroup", + "redshift:DescribeClusterParameters", + "redshift:DescribeTags", + "redshift:CreateTags", + "redshift:DeleteTags", + "initech:UpdateReport" + ] + } + }, + "primaryIdentifier": [ + "/properties/ParameterGroupName" + ], + "properties": { + "Description": { + "description": "A description of the parameter group.", + "type": "string" + }, + "ParameterGroupFamily": { + "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.", + "type": "string" + }, + "ParameterGroupName": { + "description": "The name of the cluster parameter group.", + "maxLength": 255, + "type": "string" + }, + "Parameters": { + "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "Description", + "ParameterGroupFamily" + ], + "tagging": { + "taggable": true + }, + "typeName": "AWS::Redshift::ClusterParameterGroup", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-redshift-clustersecuritygroup.json b/schema/aws-redshift-clustersecuritygroup.json index 9d8e1b3..d67ecbe 100644 --- a/schema/aws-redshift-clustersecuritygroup.json +++ b/schema/aws-redshift-clustersecuritygroup.json @@ -1,50 +1,50 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Redshift::ClusterSecurityGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Description" - ], - "typeName": "AWS::Redshift::ClusterSecurityGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Redshift::ClusterSecurityGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Description" + ], + "typeName": "AWS::Redshift::ClusterSecurityGroup" +} diff --git a/schema/aws-redshift-clustersecuritygroupingress.json b/schema/aws-redshift-clustersecuritygroupingress.json index 18e9cf8..7eb16e3 100644 --- a/schema/aws-redshift-clustersecuritygroupingress.json +++ b/schema/aws-redshift-clustersecuritygroupingress.json @@ -1,37 +1,37 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterSecurityGroupName", - "/properties/CIDRIP", - "/properties/EC2SecurityGroupOwnerId", - "/properties/EC2SecurityGroupName" - ], - "description": "Resource Type definition for AWS::Redshift::ClusterSecurityGroupIngress", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CIDRIP": { - "type": "string" - }, - "ClusterSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ClusterSecurityGroupName" - ], - "typeName": "AWS::Redshift::ClusterSecurityGroupIngress" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterSecurityGroupName", + "/properties/CIDRIP", + "/properties/EC2SecurityGroupOwnerId", + "/properties/EC2SecurityGroupName" + ], + "description": "Resource Type definition for AWS::Redshift::ClusterSecurityGroupIngress", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CIDRIP": { + "type": "string" + }, + "ClusterSecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupName": { + "type": "string" + }, + "EC2SecurityGroupOwnerId": { + "type": "string" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ClusterSecurityGroupName" + ], + "typeName": "AWS::Redshift::ClusterSecurityGroupIngress" +} diff --git a/schema/aws-redshift-clustersubnetgroup.json b/schema/aws-redshift-clustersubnetgroup.json index 5aaadeb..6b8e346 100644 --- a/schema/aws-redshift-clustersubnetgroup.json +++ b/schema/aws-redshift-clustersubnetgroup.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Specifies an Amazon Redshift subnet group.", - "handlers": { - "create": { - "permissions": [ - "redshift:CreateClusterSubnetGroup", - "redshift:CreateTags", - "redshift:DescribeClusterSubnetGroups", - "redshift:DescribeTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "redshift:DeleteClusterSubnetGroup", - "redshift:DescribeClusterSubnetGroups", - "redshift:DescribeTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - }, - "list": { - "permissions": [ - "redshift:DescribeClusterSubnetGroups", - "redshift:DescribeTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeClusterSubnetGroups", - "redshift:DescribeTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - }, - "update": { - "permissions": [ - "redshift:ModifyClusterSubnetGroup", - "redshift:DescribeClusterSubnetGroups", - "redshift:DescribeTags", - "redshift:CreateTags", - "redshift:DeleteTags", - "ec2:AllocateAddress", - "ec2:AssociateAddress", - "ec2:AttachNetworkInterface", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAddresses", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInternetGateways", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterSubnetGroupName" - ], - "properties": { - "ClusterSubnetGroupName": { - "description": "This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be \"Default\". ", - "maxLength": 255, - "type": "string" - }, - "Description": { - "description": "The description of the parameter group.", - "type": "string" - }, - "SubnetIds": { - "description": "The list of VPC subnet IDs", - "insertionOrder": false, - "items": { - "relationshipRef": { - "propertyPath": "/properties/SubnetId", - "typeName": "AWS::EC2::Subnet" - }, - "type": "string" - }, - "maxItems": 20, - "type": "array" - }, - "Tags": { - "description": "The list of tags for the cluster parameter group.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ClusterSubnetGroupName" - ], - "required": [ - "Description", - "SubnetIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", - "tagging": { - "taggable": true - }, - "typeName": "AWS::Redshift::ClusterSubnetGroup", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Specifies an Amazon Redshift subnet group.", + "handlers": { + "create": { + "permissions": [ + "redshift:CreateClusterSubnetGroup", + "redshift:CreateTags", + "redshift:DescribeClusterSubnetGroups", + "redshift:DescribeTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "redshift:DeleteClusterSubnetGroup", + "redshift:DescribeClusterSubnetGroups", + "redshift:DescribeTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + }, + "list": { + "permissions": [ + "redshift:DescribeClusterSubnetGroups", + "redshift:DescribeTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeClusterSubnetGroups", + "redshift:DescribeTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + }, + "update": { + "permissions": [ + "redshift:ModifyClusterSubnetGroup", + "redshift:DescribeClusterSubnetGroups", + "redshift:DescribeTags", + "redshift:CreateTags", + "redshift:DeleteTags", + "ec2:AllocateAddress", + "ec2:AssociateAddress", + "ec2:AttachNetworkInterface", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAddresses", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInternetGateways", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterSubnetGroupName" + ], + "properties": { + "ClusterSubnetGroupName": { + "description": "This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be \"Default\". ", + "maxLength": 255, + "type": "string" + }, + "Description": { + "description": "The description of the parameter group.", + "type": "string" + }, + "SubnetIds": { + "description": "The list of VPC subnet IDs", + "insertionOrder": false, + "items": { + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, + "type": "string" + }, + "maxItems": 20, + "type": "array" + }, + "Tags": { + "description": "The list of tags for the cluster parameter group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ClusterSubnetGroupName" + ], + "required": [ + "Description", + "SubnetIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", + "tagging": { + "taggable": true + }, + "typeName": "AWS::Redshift::ClusterSubnetGroup", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-redshift-endpointaccess.json b/schema/aws-redshift-endpointaccess.json index 0bdce89..fbc7566 100644 --- a/schema/aws-redshift-endpointaccess.json +++ b/schema/aws-redshift-endpointaccess.json @@ -1,249 +1,249 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EndpointName", - "/properties/ClusterIdentifier", - "/properties/ResourceOwner", - "/properties/SubnetGroupName" - ], - "definitions": { - "NetworkInterface": { - "additionalProperties": false, - "description": "Describes a network interface.", - "properties": { - "AvailabilityZone": { - "description": "The Availability Zone.", - "type": "string" - }, - "NetworkInterfaceId": { - "description": "The network interface identifier.", - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::NetworkInterface" - }, - "type": "string" - }, - "PrivateIpAddress": { - "description": "The IPv4 address of the network interface within the subnet.", - "relationshipRef": { - "propertyPath": "/properties/PrivateIpAddress", - "typeName": "AWS::EC2::NetworkInterface" - }, - "type": "string" - }, - "SubnetId": { - "description": "The subnet identifier.", - "relationshipRef": { - "propertyPath": "/properties/SubnetId", - "typeName": "AWS::EC2::NetworkInterface" - }, - "type": "string" - } - }, - "type": "object" - }, - "VpcSecurityGroup": { - "additionalProperties": false, - "description": "Describes the members of a VPC security group.", - "properties": { - "Status": { - "description": "The status of the VPC security group.", - "type": "string" - }, - "VpcSecurityGroupId": { - "description": "The identifier of the VPC security group.", - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::SecurityGroup" - }, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource schema for a Redshift-managed VPC endpoint.", - "handlers": { - "create": { - "permissions": [ - "redshift:CreateEndpointAccess", - "redshift:DescribeEndpointAccess", - "ec2:CreateClientVpnEndpoint", - "ec2:CreateVpcEndpoint", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "redshift:DeleteEndpointAccess", - "redshift:DescribeEndpointAccess", - "ec2:DeleteClientVpnEndpoint", - "ec2:DeleteVpcEndpoint", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeVpcEndpoint" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "redshift:DescribeEndpointAccess", - "ec2:DescribeClientVpnEndpoints", - "ec2:DescribeVpcEndpoints", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeEndpointAccess", - "ec2:DescribeClientVpnEndpoints", - "ec2:DescribeVpcEndpoint", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets" - ] - }, - "update": { - "permissions": [ - "redshift:DescribeEndpointAccess", - "redshift:ModifyEndpointAccess", - "ec2:ModifyClientVpnEndpoint", - "ec2:ModifyVpcEndpoint", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets" - ], - "timeoutInMinutes": 60 - } - }, - "primaryIdentifier": [ - "/properties/EndpointName" - ], - "properties": { - "Address": { - "description": "The DNS address of the endpoint.", - "type": "string" - }, - "ClusterIdentifier": { - "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account", - "type": "string" - }, - "EndpointCreateTime": { - "description": "The time (UTC) that the endpoint was created.", - "type": "string" - }, - "EndpointName": { - "description": "The name of the endpoint.", - "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$", - "type": "string" - }, - "EndpointStatus": { - "description": "The status of the endpoint.", - "type": "string" - }, - "Port": { - "description": "The port number on which the cluster accepts incoming connections.", - "type": "integer" - }, - "ResourceOwner": { - "description": "The AWS account ID of the owner of the cluster.", - "pattern": "^\\d{12}$", - "type": "string" - }, - "SubnetGroupName": { - "description": "The subnet group name where Amazon Redshift chooses to deploy the endpoint.", - "pattern": "^(?=^[a-zA-Z0-9-]+$).{1,255}$", - "type": "string" - }, - "VpcEndpoint": { - "additionalProperties": false, - "description": "The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.", - "properties": { - "NetworkInterfaces": { - "description": "One or more network interfaces of the endpoint. Also known as an interface endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "type": "array" - }, - "VpcEndpointId": { - "description": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.", - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::VPCEndpoint" - }, - "type": "string" - }, - "VpcId": { - "description": "The VPC identifier that the endpoint is associated.", - "relationshipRef": { - "propertyPath": "/properties/VpcId", - "typeName": "AWS::EC2::VPCEndpoint" - }, - "type": "string" - } - }, - "type": "object" - }, - "VpcSecurityGroupIds": { - "description": "A list of vpc security group ids to apply to the created endpoint access.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcSecurityGroups": { - "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcSecurityGroup" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Address", - "/properties/EndpointStatus", - "/properties/EndpointCreateTime", - "/properties/Port", - "/properties/VpcSecurityGroups", - "/properties/VpcSecurityGroups/*/VpcSecurityGroupId", - "/properties/VpcSecurityGroups/*/Status", - "/properties/VpcEndpoint", - "/properties/VpcEndpoint/VpcEndpointId", - "/properties/VpcEndpoint/VpcId", - "/properties/VpcEndpoint/NetworkInterfaces/*/NetworkInterfaceId", - "/properties/VpcEndpoint/NetworkInterfaces/*/PrivateIpAddress", - "/properties/VpcEndpoint/NetworkInterfaces/*/SubnetId", - "/properties/VpcEndpoint/NetworkInterfaces/*/AvailabilityZone" - ], - "required": [ - "ClusterIdentifier", - "SubnetGroupName", - "EndpointName", - "VpcSecurityGroupIds" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Redshift::EndpointAccess" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EndpointName", + "/properties/ClusterIdentifier", + "/properties/ResourceOwner", + "/properties/SubnetGroupName" + ], + "definitions": { + "NetworkInterface": { + "additionalProperties": false, + "description": "Describes a network interface.", + "properties": { + "AvailabilityZone": { + "description": "The Availability Zone.", + "type": "string" + }, + "NetworkInterfaceId": { + "description": "The network interface identifier.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::NetworkInterface" + }, + "type": "string" + }, + "PrivateIpAddress": { + "description": "The IPv4 address of the network interface within the subnet.", + "relationshipRef": { + "propertyPath": "/properties/PrivateIpAddress", + "typeName": "AWS::EC2::NetworkInterface" + }, + "type": "string" + }, + "SubnetId": { + "description": "The subnet identifier.", + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::NetworkInterface" + }, + "type": "string" + } + }, + "type": "object" + }, + "VpcSecurityGroup": { + "additionalProperties": false, + "description": "Describes the members of a VPC security group.", + "properties": { + "Status": { + "description": "The status of the VPC security group.", + "type": "string" + }, + "VpcSecurityGroupId": { + "description": "The identifier of the VPC security group.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + }, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource schema for a Redshift-managed VPC endpoint.", + "handlers": { + "create": { + "permissions": [ + "redshift:CreateEndpointAccess", + "redshift:DescribeEndpointAccess", + "ec2:CreateClientVpnEndpoint", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "redshift:DeleteEndpointAccess", + "redshift:DescribeEndpointAccess", + "ec2:DeleteClientVpnEndpoint", + "ec2:DeleteVpcEndpoint", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeVpcEndpoint" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "redshift:DescribeEndpointAccess", + "ec2:DescribeClientVpnEndpoints", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeEndpointAccess", + "ec2:DescribeClientVpnEndpoints", + "ec2:DescribeVpcEndpoint", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets" + ] + }, + "update": { + "permissions": [ + "redshift:DescribeEndpointAccess", + "redshift:ModifyEndpointAccess", + "ec2:ModifyClientVpnEndpoint", + "ec2:ModifyVpcEndpoint", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets" + ], + "timeoutInMinutes": 60 + } + }, + "primaryIdentifier": [ + "/properties/EndpointName" + ], + "properties": { + "Address": { + "description": "The DNS address of the endpoint.", + "type": "string" + }, + "ClusterIdentifier": { + "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account", + "type": "string" + }, + "EndpointCreateTime": { + "description": "The time (UTC) that the endpoint was created.", + "type": "string" + }, + "EndpointName": { + "description": "The name of the endpoint.", + "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$", + "type": "string" + }, + "EndpointStatus": { + "description": "The status of the endpoint.", + "type": "string" + }, + "Port": { + "description": "The port number on which the cluster accepts incoming connections.", + "type": "integer" + }, + "ResourceOwner": { + "description": "The AWS account ID of the owner of the cluster.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "SubnetGroupName": { + "description": "The subnet group name where Amazon Redshift chooses to deploy the endpoint.", + "pattern": "^(?=^[a-zA-Z0-9-]+$).{1,255}$", + "type": "string" + }, + "VpcEndpoint": { + "additionalProperties": false, + "description": "The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.", + "properties": { + "NetworkInterfaces": { + "description": "One or more network interfaces of the endpoint. Also known as an interface endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "type": "array" + }, + "VpcEndpointId": { + "description": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::VPCEndpoint" + }, + "type": "string" + }, + "VpcId": { + "description": "The VPC identifier that the endpoint is associated.", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPCEndpoint" + }, + "type": "string" + } + }, + "type": "object" + }, + "VpcSecurityGroupIds": { + "description": "A list of vpc security group ids to apply to the created endpoint access.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "VpcSecurityGroups": { + "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcSecurityGroup" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Address", + "/properties/EndpointStatus", + "/properties/EndpointCreateTime", + "/properties/Port", + "/properties/VpcSecurityGroups", + "/properties/VpcSecurityGroups/*/VpcSecurityGroupId", + "/properties/VpcSecurityGroups/*/Status", + "/properties/VpcEndpoint", + "/properties/VpcEndpoint/VpcEndpointId", + "/properties/VpcEndpoint/VpcId", + "/properties/VpcEndpoint/NetworkInterfaces/*/NetworkInterfaceId", + "/properties/VpcEndpoint/NetworkInterfaces/*/PrivateIpAddress", + "/properties/VpcEndpoint/NetworkInterfaces/*/SubnetId", + "/properties/VpcEndpoint/NetworkInterfaces/*/AvailabilityZone" + ], + "required": [ + "ClusterIdentifier", + "SubnetGroupName", + "EndpointName", + "VpcSecurityGroupIds" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Redshift::EndpointAccess" +} diff --git a/schema/aws-redshift-endpointauthorization.json b/schema/aws-redshift-endpointauthorization.json index c5a1adc..81ce773 100644 --- a/schema/aws-redshift-endpointauthorization.json +++ b/schema/aws-redshift-endpointauthorization.json @@ -1,148 +1,148 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterIdentifier", - "/properties/Account" - ], - "definitions": { - "AwsAccount": { - "pattern": "^\\d{12}$", - "type": "string" - }, - "VpcId": { - "pattern": "^vpc-[A-Za-z0-9]{1,17}$", - "relationshipRef": { - "propertyPath": "/properties/VpcId", - "typeName": "AWS::EC2::VPC" - }, - "type": "string" - } - }, - "description": "Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.", - "handlers": { - "create": { - "permissions": [ - "redshift:AuthorizeEndpointAccess", - "redshift:DescribeEndpointAuthorization" - ], - "timeoutInMinutes": 60 - }, - "delete": { - "permissions": [ - "redshift:RevokeEndpointAccess", - "redshift:DeleteEndpointAccess", - "redshift:DescribeEndpointAuthorization", - "ec2:DeleteClientVpnEndpoint", - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets" - ], - "timeoutInMinutes": 60 - }, - "list": { - "permissions": [ - "redshift:DescribeEndpointAuthorization" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeEndpointAuthorization" - ] - }, - "update": { - "permissions": [ - "redshift:AuthorizeEndpointAccess", - "redshift:DescribeEndpointAuthorization", - "redshift:RevokeEndpointAccess" - ], - "timeoutInMinutes": 60 - } - }, - "primaryIdentifier": [ - "/properties/ClusterIdentifier", - "/properties/Account" - ], - "properties": { - "Account": { - "$ref": "#/definitions/AwsAccount", - "description": "The target AWS account ID to grant or revoke access for." - }, - "AllowedAllVPCs": { - "description": "Indicates whether all VPCs in the grantee account are allowed access to the cluster.", - "type": "boolean" - }, - "AllowedVPCs": { - "description": "The VPCs allowed access to the cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcId" - }, - "type": "array" - }, - "AuthorizeTime": { - "description": "The time (UTC) when the authorization was created.", - "type": "string" - }, - "ClusterIdentifier": { - "description": "The cluster identifier.", - "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$", - "type": "string" - }, - "ClusterStatus": { - "description": "The status of the cluster.", - "type": "string" - }, - "EndpointCount": { - "description": "The number of Redshift-managed VPC endpoints created for the authorization.", - "type": "integer" - }, - "Force": { - "description": " Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.", - "type": "boolean" - }, - "Grantee": { - "$ref": "#/definitions/AwsAccount", - "description": "The AWS account ID of the grantee of the cluster." - }, - "Grantor": { - "$ref": "#/definitions/AwsAccount", - "description": "The AWS account ID of the cluster owner." - }, - "Status": { - "description": "The status of the authorization action.", - "type": "string" - }, - "VpcIds": { - "description": "The virtual private cloud (VPC) identifiers to grant or revoke access to.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcId" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Grantor", - "/properties/Grantee", - "/properties/AuthorizeTime", - "/properties/ClusterStatus", - "/properties/Status", - "/properties/AllowedAllVPCs", - "/properties/AllowedVPCs", - "/properties/EndpointCount" - ], - "required": [ - "ClusterIdentifier", - "Account" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Redshift::EndpointAuthorization", - "writeOnlyProperties": [ - "/properties/Force" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterIdentifier", + "/properties/Account" + ], + "definitions": { + "AwsAccount": { + "pattern": "^\\d{12}$", + "type": "string" + }, + "VpcId": { + "pattern": "^vpc-[A-Za-z0-9]{1,17}$", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, + "type": "string" + } + }, + "description": "Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.", + "handlers": { + "create": { + "permissions": [ + "redshift:AuthorizeEndpointAccess", + "redshift:DescribeEndpointAuthorization" + ], + "timeoutInMinutes": 60 + }, + "delete": { + "permissions": [ + "redshift:RevokeEndpointAccess", + "redshift:DeleteEndpointAccess", + "redshift:DescribeEndpointAuthorization", + "ec2:DeleteClientVpnEndpoint", + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets" + ], + "timeoutInMinutes": 60 + }, + "list": { + "permissions": [ + "redshift:DescribeEndpointAuthorization" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeEndpointAuthorization" + ] + }, + "update": { + "permissions": [ + "redshift:AuthorizeEndpointAccess", + "redshift:DescribeEndpointAuthorization", + "redshift:RevokeEndpointAccess" + ], + "timeoutInMinutes": 60 + } + }, + "primaryIdentifier": [ + "/properties/ClusterIdentifier", + "/properties/Account" + ], + "properties": { + "Account": { + "$ref": "#/definitions/AwsAccount", + "description": "The target AWS account ID to grant or revoke access for." + }, + "AllowedAllVPCs": { + "description": "Indicates whether all VPCs in the grantee account are allowed access to the cluster.", + "type": "boolean" + }, + "AllowedVPCs": { + "description": "The VPCs allowed access to the cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcId" + }, + "type": "array" + }, + "AuthorizeTime": { + "description": "The time (UTC) when the authorization was created.", + "type": "string" + }, + "ClusterIdentifier": { + "description": "The cluster identifier.", + "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$", + "type": "string" + }, + "ClusterStatus": { + "description": "The status of the cluster.", + "type": "string" + }, + "EndpointCount": { + "description": "The number of Redshift-managed VPC endpoints created for the authorization.", + "type": "integer" + }, + "Force": { + "description": " Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.", + "type": "boolean" + }, + "Grantee": { + "$ref": "#/definitions/AwsAccount", + "description": "The AWS account ID of the grantee of the cluster." + }, + "Grantor": { + "$ref": "#/definitions/AwsAccount", + "description": "The AWS account ID of the cluster owner." + }, + "Status": { + "description": "The status of the authorization action.", + "type": "string" + }, + "VpcIds": { + "description": "The virtual private cloud (VPC) identifiers to grant or revoke access to.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcId" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Grantor", + "/properties/Grantee", + "/properties/AuthorizeTime", + "/properties/ClusterStatus", + "/properties/Status", + "/properties/AllowedAllVPCs", + "/properties/AllowedVPCs", + "/properties/EndpointCount" + ], + "required": [ + "ClusterIdentifier", + "Account" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Redshift::EndpointAuthorization", + "writeOnlyProperties": [ + "/properties/Force" + ] +} diff --git a/schema/aws-redshift-eventsubscription.json b/schema/aws-redshift-eventsubscription.json index 8cc1cfb..f4dd069 100644 --- a/schema/aws-redshift-eventsubscription.json +++ b/schema/aws-redshift-eventsubscription.json @@ -1,199 +1,199 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubscriptionName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.", - "handlers": { - "create": { - "permissions": [ - "redshift:CreateEventSubscription", - "redshift:CreateTags", - "redshift:DescribeTags", - "redshift:DescribeEventSubscriptions" - ] - }, - "delete": { - "permissions": [ - "redshift:DescribeEventSubscriptions", - "redshift:DeleteEventSubscription", - "redshift:DescribeTags", - "redshift:DeleteTags" - ] - }, - "list": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeEventSubscriptions" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeEventSubscriptions", - "redshift:DescribeTags" - ] - }, - "update": { - "permissions": [ - "redshift:ModifyEventSubscription", - "redshift:CreateTags", - "redshift:DescribeTags", - "redshift:DescribeEventSubscriptions", - "redshift:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubscriptionName" - ], - "properties": { - "CustSubscriptionId": { - "description": "The name of the Amazon Redshift event notification subscription.", - "type": "string" - }, - "CustomerAwsId": { - "description": "The AWS account associated with the Amazon Redshift event notification subscription.", - "type": "string" - }, - "Enabled": { - "description": "A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.", - "type": "boolean" - }, - "EventCategories": { - "description": "Specifies the Amazon Redshift event categories to be published by the event notification subscription.", - "insertionOrder": false, - "items": { - "enum": [ - "configuration", - "management", - "monitoring", - "security", - "pending" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "EventCategoriesList": { - "description": "The list of Amazon Redshift event categories specified in the event notification subscription.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Severity": { - "description": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.", - "enum": [ - "ERROR", - "INFO" - ], - "type": "string" - }, - "SnsTopicArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.", - "type": "string" - }, - "SourceIds": { - "description": "A list of one or more identifiers of Amazon Redshift source objects.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceIdsList": { - "description": "A list of the sources that publish events to the Amazon Redshift event notification subscription.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceType": { - "description": "The type of source that will be generating the events.", - "enum": [ - "cluster", - "cluster-parameter-group", - "cluster-security-group", - "cluster-snapshot", - "scheduled-action" - ], - "type": "string" - }, - "Status": { - "description": "The status of the Amazon Redshift event notification subscription.", - "enum": [ - "active", - "no-permission", - "topic-not-exist" - ], - "type": "string" - }, - "SubscriptionCreationTime": { - "description": "The date and time the Amazon Redshift event notification subscription was created.", - "type": "string" - }, - "SubscriptionName": { - "description": "The name of the Amazon Redshift event notification subscription", - "pattern": "^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CustomerAwsId", - "/properties/CustSubscriptionId", - "/properties/Status", - "/properties/SubscriptionCreationTime", - "/properties/SourceIdsList", - "/properties/EventCategoriesList" - ], - "required": [ - "SubscriptionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", - "tagging": { - "taggable": true - }, - "typeName": "AWS::Redshift::EventSubscription", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriptionName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.", + "handlers": { + "create": { + "permissions": [ + "redshift:CreateEventSubscription", + "redshift:CreateTags", + "redshift:DescribeTags", + "redshift:DescribeEventSubscriptions" + ] + }, + "delete": { + "permissions": [ + "redshift:DescribeEventSubscriptions", + "redshift:DeleteEventSubscription", + "redshift:DescribeTags", + "redshift:DeleteTags" + ] + }, + "list": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeEventSubscriptions" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeEventSubscriptions", + "redshift:DescribeTags" + ] + }, + "update": { + "permissions": [ + "redshift:ModifyEventSubscription", + "redshift:CreateTags", + "redshift:DescribeTags", + "redshift:DescribeEventSubscriptions", + "redshift:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriptionName" + ], + "properties": { + "CustSubscriptionId": { + "description": "The name of the Amazon Redshift event notification subscription.", + "type": "string" + }, + "CustomerAwsId": { + "description": "The AWS account associated with the Amazon Redshift event notification subscription.", + "type": "string" + }, + "Enabled": { + "description": "A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.", + "type": "boolean" + }, + "EventCategories": { + "description": "Specifies the Amazon Redshift event categories to be published by the event notification subscription.", + "insertionOrder": false, + "items": { + "enum": [ + "configuration", + "management", + "monitoring", + "security", + "pending" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "EventCategoriesList": { + "description": "The list of Amazon Redshift event categories specified in the event notification subscription.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Severity": { + "description": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.", + "enum": [ + "ERROR", + "INFO" + ], + "type": "string" + }, + "SnsTopicArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.", + "type": "string" + }, + "SourceIds": { + "description": "A list of one or more identifiers of Amazon Redshift source objects.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "SourceIdsList": { + "description": "A list of the sources that publish events to the Amazon Redshift event notification subscription.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "SourceType": { + "description": "The type of source that will be generating the events.", + "enum": [ + "cluster", + "cluster-parameter-group", + "cluster-security-group", + "cluster-snapshot", + "scheduled-action" + ], + "type": "string" + }, + "Status": { + "description": "The status of the Amazon Redshift event notification subscription.", + "enum": [ + "active", + "no-permission", + "topic-not-exist" + ], + "type": "string" + }, + "SubscriptionCreationTime": { + "description": "The date and time the Amazon Redshift event notification subscription was created.", + "type": "string" + }, + "SubscriptionName": { + "description": "The name of the Amazon Redshift event notification subscription", + "pattern": "^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CustomerAwsId", + "/properties/CustSubscriptionId", + "/properties/Status", + "/properties/SubscriptionCreationTime", + "/properties/SourceIdsList", + "/properties/EventCategoriesList" + ], + "required": [ + "SubscriptionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", + "tagging": { + "taggable": true + }, + "typeName": "AWS::Redshift::EventSubscription", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-redshift-scheduledaction.json b/schema/aws-redshift-scheduledaction.json index 5e6e23e..74d67b4 100644 --- a/schema/aws-redshift-scheduledaction.json +++ b/schema/aws-redshift-scheduledaction.json @@ -1,224 +1,224 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ScheduledActionName" - ], - "definitions": { - "PauseClusterMessage": { - "additionalProperties": false, - "description": "Describes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation.", - "properties": { - "ClusterIdentifier": { - "relationshipRef": { - "propertyPath": "/properties/ClusterIdentifier", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "string" - } - }, - "required": [ - "ClusterIdentifier" - ], - "type": "object" - }, - "ResizeClusterMessage": { - "additionalProperties": false, - "description": "Describes a resize cluster operation. For example, a scheduled action to run the `ResizeCluster` API operation.", - "properties": { - "Classic": { - "type": "boolean" - }, - "ClusterIdentifier": { - "relationshipRef": { - "propertyPath": "/properties/ClusterIdentifier", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "string" - }, - "ClusterType": { - "relationshipRef": { - "propertyPath": "/properties/ClusterType", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "string" - }, - "NodeType": { - "relationshipRef": { - "propertyPath": "/properties/NodeType", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "string" - }, - "NumberOfNodes": { - "relationshipRef": { - "propertyPath": "/properties/NumberOfNodes", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "integer" - } - }, - "required": [ - "ClusterIdentifier" - ], - "type": "object" - }, - "ResumeClusterMessage": { - "additionalProperties": false, - "description": "Describes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation.", - "properties": { - "ClusterIdentifier": { - "relationshipRef": { - "propertyPath": "/properties/ClusterIdentifier", - "typeName": "AWS::Redshift::Cluster" - }, - "type": "string" - } - }, - "required": [ - "ClusterIdentifier" - ], - "type": "object" - }, - "ScheduledActionType": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "ResizeCluster": { - "$ref": "#/definitions/ResizeClusterMessage" - } - } - }, - { - "additionalProperties": false, - "properties": { - "PauseCluster": { - "$ref": "#/definitions/PauseClusterMessage" - } - } - }, - { - "additionalProperties": false, - "properties": { - "ResumeCluster": { - "$ref": "#/definitions/ResumeClusterMessage" - } - } - } - ], - "type": "object" - }, - "timestamp": { - "type": "string" - } - }, - "description": "The `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.", - "handlers": { - "create": { - "permissions": [ - "redshift:CreateScheduledAction", - "redshift:DescribeScheduledActions", - "redshift:DescribeTags", - "redshift:PauseCluster", - "redshift:ResumeCluster", - "redshift:ResizeCluster", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeScheduledActions", - "redshift:DeleteScheduledAction" - ] - }, - "list": { - "permissions": [ - "redshift:DescribeTags", - "redshift:DescribeScheduledActions" - ] - }, - "read": { - "permissions": [ - "redshift:DescribeScheduledActions", - "redshift:DescribeTags" - ] - }, - "update": { - "permissions": [ - "redshift:DescribeScheduledActions", - "redshift:ModifyScheduledAction", - "redshift:PauseCluster", - "redshift:ResumeCluster", - "redshift:ResizeCluster", - "redshift:DescribeTags", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ScheduledActionName" - ], - "properties": { - "Enable": { - "description": "If true, the schedule is enabled. If false, the scheduled action does not trigger.", - "type": "boolean" - }, - "EndTime": { - "$ref": "#/definitions/timestamp", - "description": "The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger." - }, - "IamRole": { - "description": "The IAM role to assume to run the target action.", - "type": "string" - }, - "NextInvocations": { - "description": "List of times when the scheduled action will run.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/timestamp" - }, - "type": "array" - }, - "Schedule": { - "description": "The schedule in `at( )` or `cron( )` format.", - "type": "string" - }, - "ScheduledActionDescription": { - "description": "The description of the scheduled action.", - "type": "string" - }, - "ScheduledActionName": { - "description": "The name of the scheduled action. The name must be unique within an account.", - "type": "string" - }, - "StartTime": { - "$ref": "#/definitions/timestamp", - "description": "The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger." - }, - "State": { - "description": "The state of the scheduled action.", - "enum": [ - "ACTIVE", - "DISABLED" - ], - "type": "string" - }, - "TargetAction": { - "$ref": "#/definitions/ScheduledActionType", - "description": "A JSON format string of the Amazon Redshift API operation with input parameters." - } - }, - "readOnlyProperties": [ - "/properties/State", - "/properties/NextInvocations" - ], - "required": [ - "ScheduledActionName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Redshift::ScheduledAction" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ScheduledActionName" + ], + "definitions": { + "PauseClusterMessage": { + "additionalProperties": false, + "description": "Describes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation.", + "properties": { + "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "string" + } + }, + "required": [ + "ClusterIdentifier" + ], + "type": "object" + }, + "ResizeClusterMessage": { + "additionalProperties": false, + "description": "Describes a resize cluster operation. For example, a scheduled action to run the `ResizeCluster` API operation.", + "properties": { + "Classic": { + "type": "boolean" + }, + "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "string" + }, + "ClusterType": { + "relationshipRef": { + "propertyPath": "/properties/ClusterType", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "string" + }, + "NodeType": { + "relationshipRef": { + "propertyPath": "/properties/NodeType", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "string" + }, + "NumberOfNodes": { + "relationshipRef": { + "propertyPath": "/properties/NumberOfNodes", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "integer" + } + }, + "required": [ + "ClusterIdentifier" + ], + "type": "object" + }, + "ResumeClusterMessage": { + "additionalProperties": false, + "description": "Describes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation.", + "properties": { + "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, + "type": "string" + } + }, + "required": [ + "ClusterIdentifier" + ], + "type": "object" + }, + "ScheduledActionType": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "ResizeCluster": { + "$ref": "#/definitions/ResizeClusterMessage" + } + } + }, + { + "additionalProperties": false, + "properties": { + "PauseCluster": { + "$ref": "#/definitions/PauseClusterMessage" + } + } + }, + { + "additionalProperties": false, + "properties": { + "ResumeCluster": { + "$ref": "#/definitions/ResumeClusterMessage" + } + } + } + ], + "type": "object" + }, + "timestamp": { + "type": "string" + } + }, + "description": "The `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.", + "handlers": { + "create": { + "permissions": [ + "redshift:CreateScheduledAction", + "redshift:DescribeScheduledActions", + "redshift:DescribeTags", + "redshift:PauseCluster", + "redshift:ResumeCluster", + "redshift:ResizeCluster", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeScheduledActions", + "redshift:DeleteScheduledAction" + ] + }, + "list": { + "permissions": [ + "redshift:DescribeTags", + "redshift:DescribeScheduledActions" + ] + }, + "read": { + "permissions": [ + "redshift:DescribeScheduledActions", + "redshift:DescribeTags" + ] + }, + "update": { + "permissions": [ + "redshift:DescribeScheduledActions", + "redshift:ModifyScheduledAction", + "redshift:PauseCluster", + "redshift:ResumeCluster", + "redshift:ResizeCluster", + "redshift:DescribeTags", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ScheduledActionName" + ], + "properties": { + "Enable": { + "description": "If true, the schedule is enabled. If false, the scheduled action does not trigger.", + "type": "boolean" + }, + "EndTime": { + "$ref": "#/definitions/timestamp", + "description": "The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger." + }, + "IamRole": { + "description": "The IAM role to assume to run the target action.", + "type": "string" + }, + "NextInvocations": { + "description": "List of times when the scheduled action will run.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/timestamp" + }, + "type": "array" + }, + "Schedule": { + "description": "The schedule in `at( )` or `cron( )` format.", + "type": "string" + }, + "ScheduledActionDescription": { + "description": "The description of the scheduled action.", + "type": "string" + }, + "ScheduledActionName": { + "description": "The name of the scheduled action. The name must be unique within an account.", + "type": "string" + }, + "StartTime": { + "$ref": "#/definitions/timestamp", + "description": "The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger." + }, + "State": { + "description": "The state of the scheduled action.", + "enum": [ + "ACTIVE", + "DISABLED" + ], + "type": "string" + }, + "TargetAction": { + "$ref": "#/definitions/ScheduledActionType", + "description": "A JSON format string of the Amazon Redshift API operation with input parameters." + } + }, + "readOnlyProperties": [ + "/properties/State", + "/properties/NextInvocations" + ], + "required": [ + "ScheduledActionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Redshift::ScheduledAction" +} diff --git a/schema/aws-redshiftserverless-namespace.json b/schema/aws-redshiftserverless-namespace.json index 75f5f9a..1c13887 100644 --- a/schema/aws-redshiftserverless-namespace.json +++ b/schema/aws-redshiftserverless-namespace.json @@ -1,353 +1,353 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NamespaceName", - "/properties/Tags" - ], - "definitions": { - "LogExport": { - "enum": [ - "useractivitylog", - "userlog", - "connectionlog" - ], - "type": "string" - }, - "Namespace": { - "additionalProperties": false, - "properties": { - "AdminPasswordSecretArn": { - "type": "string" - }, - "AdminPasswordSecretKmsKeyId": { - "type": "string" - }, - "AdminUsername": { - "type": "string" - }, - "CreationDate": { - "type": "string" - }, - "DbName": { - "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", - "type": "string" - }, - "DefaultIamRoleArn": { - "type": "string" - }, - "IamRoles": { - "insertionOrder": false, - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "KmsKeyId": { - "type": "string" - }, - "LogExports": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogExport" - }, - "maxItems": 16, - "minItems": 0, - "type": "array" - }, - "NamespaceArn": { - "type": "string" - }, - "NamespaceId": { - "type": "string" - }, - "NamespaceName": { - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9-]+$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/NamespaceStatus" - } - }, - "type": "object" - }, - "NamespaceStatus": { - "enum": [ - "AVAILABLE", - "MODIFYING", - "DELETING" - ], - "type": "string" - }, - "SnapshotCopyConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationKmsKeyId": { - "type": "string" - }, - "DestinationRegion": { - "type": "string" - }, - "SnapshotRetentionPeriod": { - "type": "integer" - } - }, - "required": [ - "DestinationRegion" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RedshiftServerless::Namespace Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "kms:TagResource", - "kms:UntagResource", - "kms:ScheduleKeyDeletion", - "kms:CancelKeyDeletion", - "kms:Encrypt", - "kms:Decrypt", - "kms:DescribeKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKey", - "kms:CreateGrant", - "kms:ListGrants", - "kms:RevokeGrant", - "kms:RetireGrant", - "redshift-serverless:CreateNamespace", - "redshift-serverless:GetNamespace", - "redshift-serverless:ListSnapshotCopyConfigurations", - "redshift-serverless:CreateSnapshotCopyConfiguration", - "redshift:GetResourcePolicy", - "redshift:PutResourcePolicy", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource", - "secretsmanager:RotateSecret", - "secretsmanager:DescribeSecret" - ] - }, - "delete": { - "permissions": [ - "iam:PassRole", - "redshift-serverless:DeleteNamespace", - "redshift-serverless:GetNamespace", - "kms:RetireGrant", - "secretsmanager:DescribeSecret", - "secretsmanager:DeleteSecret", - "redshift:DeleteResourcePolicy" - ] - }, - "list": { - "permissions": [ - "iam:PassRole", - "redshift-serverless:ListNamespaces" - ] - }, - "read": { - "permissions": [ - "iam:PassRole", - "redshift-serverless:GetNamespace", - "redshift:GetResourcePolicy", - "redshift-serverless:ListSnapshotCopyConfigurations" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "kms:TagResource", - "kms:UntagResource", - "kms:ScheduleKeyDeletion", - "kms:CancelKeyDeletion", - "kms:Encrypt", - "kms:Decrypt", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:ListGrants", - "kms:RevokeGrant", - "kms:RetireGrant", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKey", - "redshift-serverless:UpdateNamespace", - "redshift-serverless:GetNamespace", - "redshift-serverless:ListSnapshotCopyConfigurations", - "redshift-serverless:CreateSnapshotCopyConfiguration", - "redshift-serverless:UpdateSnapshotCopyConfiguration", - "redshift-serverless:DeleteSnapshotCopyConfiguration", - "redshift:GetResourcePolicy", - "redshift:PutResourcePolicy", - "redshift:DeleteResourcePolicy", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource", - "secretsmanager:RotateSecret", - "secretsmanager:DescribeSecret", - "secretsmanager:UpdateSecret", - "secretsmanager:DeleteSecret" - ] - } - }, - "primaryIdentifier": [ - "/properties/NamespaceName" - ], - "properties": { - "AdminPasswordSecretKmsKeyId": { - "description": "The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.", - "type": "string" - }, - "AdminUserPassword": { - "description": "The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.", - "maxLength": 64, - "minLength": 8, - "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[^\\x00-\\x20\\x22\\x27\\x2f\\x40\\x5c\\x7f-\\uffff]+", - "type": "string" - }, - "AdminUsername": { - "description": "The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.", - "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", - "type": "string" - }, - "DbName": { - "description": "The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.", - "maxLength": 127, - "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", - "type": "string" - }, - "DefaultIamRoleArn": { - "description": "The default IAM role ARN for the namespace that is being created.", - "type": "string" - }, - "FinalSnapshotName": { - "description": "The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace", - "maxLength": 255, - "pattern": "[a-z][a-z0-9]*(-[a-z0-9]+)*", - "type": "string" - }, - "FinalSnapshotRetentionPeriod": { - "description": "The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.", - "type": "integer" - }, - "IamRoles": { - "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.", - "insertionOrder": false, - "items": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "type": "array" - }, - "KmsKeyId": { - "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.", - "type": "string" - }, - "LogExports": { - "description": "The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogExport" - }, - "maxItems": 16, - "minItems": 0, - "type": "array" - }, - "ManageAdminPassword": { - "description": "If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.", - "type": "boolean" - }, - "Namespace": { - "$ref": "#/definitions/Namespace", - "description": "Definition of Namespace resource." - }, - "NamespaceName": { - "description": "A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.", - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9-]+$", - "type": "string" - }, - "NamespaceResourcePolicy": { - "description": "The resource policy document that will be attached to the namespace.", - "type": "object" - }, - "RedshiftIdcApplicationArn": { - "description": "The ARN for the Redshift application that integrates with IAM Identity Center.", - "type": "string" - }, - "SnapshotCopyConfigurations": { - "description": "The snapshot copy configurations for the namespace.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SnapshotCopyConfiguration" - }, - "maxItems": 1, - "minItems": 0, - "type": "array" - }, - "Tags": { - "description": "The list of tags for the namespace.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Namespace", - "/properties/Namespace/NamespaceArn", - "/properties/Namespace/NamespaceId", - "/properties/Namespace/NamespaceName", - "/properties/Namespace/AdminUsername", - "/properties/Namespace/DbName", - "/properties/Namespace/KmsKeyId", - "/properties/Namespace/DefaultIamRoleArn", - "/properties/Namespace/IamRoles", - "/properties/Namespace/LogExports", - "/properties/Namespace/Status", - "/properties/Namespace/CreationDate" - ], - "required": [ - "NamespaceName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift-serverless", - "tagging": { - "taggable": false - }, - "typeName": "AWS::RedshiftServerless::Namespace", - "writeOnlyProperties": [ - "/properties/AdminUserPassword", - "/properties/FinalSnapshotName", - "/properties/FinalSnapshotRetentionPeriod", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value", - "/properties/ManageAdminPassword", - "/properties/RedshiftIdcApplicationArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NamespaceName", + "/properties/Tags" + ], + "definitions": { + "LogExport": { + "enum": [ + "useractivitylog", + "userlog", + "connectionlog" + ], + "type": "string" + }, + "Namespace": { + "additionalProperties": false, + "properties": { + "AdminPasswordSecretArn": { + "type": "string" + }, + "AdminPasswordSecretKmsKeyId": { + "type": "string" + }, + "AdminUsername": { + "type": "string" + }, + "CreationDate": { + "type": "string" + }, + "DbName": { + "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", + "type": "string" + }, + "DefaultIamRoleArn": { + "type": "string" + }, + "IamRoles": { + "insertionOrder": false, + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "KmsKeyId": { + "type": "string" + }, + "LogExports": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogExport" + }, + "maxItems": 16, + "minItems": 0, + "type": "array" + }, + "NamespaceArn": { + "type": "string" + }, + "NamespaceId": { + "type": "string" + }, + "NamespaceName": { + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/NamespaceStatus" + } + }, + "type": "object" + }, + "NamespaceStatus": { + "enum": [ + "AVAILABLE", + "MODIFYING", + "DELETING" + ], + "type": "string" + }, + "SnapshotCopyConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationKmsKeyId": { + "type": "string" + }, + "DestinationRegion": { + "type": "string" + }, + "SnapshotRetentionPeriod": { + "type": "integer" + } + }, + "required": [ + "DestinationRegion" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RedshiftServerless::Namespace Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "kms:TagResource", + "kms:UntagResource", + "kms:ScheduleKeyDeletion", + "kms:CancelKeyDeletion", + "kms:Encrypt", + "kms:Decrypt", + "kms:DescribeKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKey", + "kms:CreateGrant", + "kms:ListGrants", + "kms:RevokeGrant", + "kms:RetireGrant", + "redshift-serverless:CreateNamespace", + "redshift-serverless:GetNamespace", + "redshift-serverless:ListSnapshotCopyConfigurations", + "redshift-serverless:CreateSnapshotCopyConfiguration", + "redshift:GetResourcePolicy", + "redshift:PutResourcePolicy", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:RotateSecret", + "secretsmanager:DescribeSecret" + ] + }, + "delete": { + "permissions": [ + "iam:PassRole", + "redshift-serverless:DeleteNamespace", + "redshift-serverless:GetNamespace", + "kms:RetireGrant", + "secretsmanager:DescribeSecret", + "secretsmanager:DeleteSecret", + "redshift:DeleteResourcePolicy" + ] + }, + "list": { + "permissions": [ + "iam:PassRole", + "redshift-serverless:ListNamespaces" + ] + }, + "read": { + "permissions": [ + "iam:PassRole", + "redshift-serverless:GetNamespace", + "redshift:GetResourcePolicy", + "redshift-serverless:ListSnapshotCopyConfigurations" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "kms:TagResource", + "kms:UntagResource", + "kms:ScheduleKeyDeletion", + "kms:CancelKeyDeletion", + "kms:Encrypt", + "kms:Decrypt", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:ListGrants", + "kms:RevokeGrant", + "kms:RetireGrant", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKey", + "redshift-serverless:UpdateNamespace", + "redshift-serverless:GetNamespace", + "redshift-serverless:ListSnapshotCopyConfigurations", + "redshift-serverless:CreateSnapshotCopyConfiguration", + "redshift-serverless:UpdateSnapshotCopyConfiguration", + "redshift-serverless:DeleteSnapshotCopyConfiguration", + "redshift:GetResourcePolicy", + "redshift:PutResourcePolicy", + "redshift:DeleteResourcePolicy", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:RotateSecret", + "secretsmanager:DescribeSecret", + "secretsmanager:UpdateSecret", + "secretsmanager:DeleteSecret" + ] + } + }, + "primaryIdentifier": [ + "/properties/NamespaceName" + ], + "properties": { + "AdminPasswordSecretKmsKeyId": { + "description": "The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.", + "type": "string" + }, + "AdminUserPassword": { + "description": "The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.", + "maxLength": 64, + "minLength": 8, + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[^\\x00-\\x20\\x22\\x27\\x2f\\x40\\x5c\\x7f-\\uffff]+", + "type": "string" + }, + "AdminUsername": { + "description": "The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.", + "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", + "type": "string" + }, + "DbName": { + "description": "The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.", + "maxLength": 127, + "pattern": "[a-zA-Z][a-zA-Z_0-9+.@-]*", + "type": "string" + }, + "DefaultIamRoleArn": { + "description": "The default IAM role ARN for the namespace that is being created.", + "type": "string" + }, + "FinalSnapshotName": { + "description": "The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace", + "maxLength": 255, + "pattern": "[a-z][a-z0-9]*(-[a-z0-9]+)*", + "type": "string" + }, + "FinalSnapshotRetentionPeriod": { + "description": "The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.", + "type": "integer" + }, + "IamRoles": { + "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.", + "insertionOrder": false, + "items": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "KmsKeyId": { + "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.", + "type": "string" + }, + "LogExports": { + "description": "The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogExport" + }, + "maxItems": 16, + "minItems": 0, + "type": "array" + }, + "ManageAdminPassword": { + "description": "If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.", + "type": "boolean" + }, + "Namespace": { + "$ref": "#/definitions/Namespace", + "description": "Definition of Namespace resource." + }, + "NamespaceName": { + "description": "A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]+$", + "type": "string" + }, + "NamespaceResourcePolicy": { + "description": "The resource policy document that will be attached to the namespace.", + "type": "object" + }, + "RedshiftIdcApplicationArn": { + "description": "The ARN for the Redshift application that integrates with IAM Identity Center.", + "type": "string" + }, + "SnapshotCopyConfigurations": { + "description": "The snapshot copy configurations for the namespace.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SnapshotCopyConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "Tags": { + "description": "The list of tags for the namespace.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Namespace", + "/properties/Namespace/NamespaceArn", + "/properties/Namespace/NamespaceId", + "/properties/Namespace/NamespaceName", + "/properties/Namespace/AdminUsername", + "/properties/Namespace/DbName", + "/properties/Namespace/KmsKeyId", + "/properties/Namespace/DefaultIamRoleArn", + "/properties/Namespace/IamRoles", + "/properties/Namespace/LogExports", + "/properties/Namespace/Status", + "/properties/Namespace/CreationDate" + ], + "required": [ + "NamespaceName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift-serverless", + "tagging": { + "taggable": false + }, + "typeName": "AWS::RedshiftServerless::Namespace", + "writeOnlyProperties": [ + "/properties/AdminUserPassword", + "/properties/FinalSnapshotName", + "/properties/FinalSnapshotRetentionPeriod", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value", + "/properties/ManageAdminPassword", + "/properties/RedshiftIdcApplicationArn" + ] +} diff --git a/schema/aws-redshiftserverless-workgroup.json b/schema/aws-redshiftserverless-workgroup.json index e1d05c1..f751b29 100644 --- a/schema/aws-redshiftserverless-workgroup.json +++ b/schema/aws-redshiftserverless-workgroup.json @@ -1,389 +1,389 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WorkgroupName", - "/properties/NamespaceName" - ], - "definitions": { - "ConfigParameter": { - "additionalProperties": false, - "properties": { - "ParameterKey": { - "maxLength": 255, - "minLength": 0, - "type": "string" - }, - "ParameterValue": { - "maxLength": 15000, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "Endpoint": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "VpcEndpoints": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VpcEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "NetworkInterface": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddress": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcEndpoint": { - "additionalProperties": false, - "properties": { - "NetworkInterfaces": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "type": "array" - }, - "VpcEndpointId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "Workgroup": { - "additionalProperties": false, - "properties": { - "BaseCapacity": { - "type": "integer" - }, - "ConfigParameters": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigParameter" - }, - "type": "array", - "uniqueItems": true - }, - "CreationDate": { - "type": "string" - }, - "Endpoint": { - "$ref": "#/definitions/Endpoint" - }, - "EnhancedVpcRouting": { - "type": "boolean" - }, - "MaxCapacity": { - "type": "integer" - }, - "NamespaceName": { - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9-]+$", - "type": "string" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 0, - "pattern": "^sg-[0-9a-fA-F]{8,}$", - "type": "string" - }, - "type": "array" - }, - "Status": { - "$ref": "#/definitions/WorkgroupStatus" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 0, - "pattern": "^subnet-[0-9a-fA-F]{8,}$", - "type": "string" - }, - "type": "array" - }, - "WorkgroupArn": { - "type": "string" - }, - "WorkgroupId": { - "type": "string" - }, - "WorkgroupName": { - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-z0-9-]*$", - "type": "string" - } - }, - "type": "object" - }, - "WorkgroupStatus": { - "enum": [ - "CREATING", - "AVAILABLE", - "MODIFYING", - "DELETING" - ], - "type": "string" - } - }, - "description": "Definition of AWS::RedshiftServerless::Workgroup Resource Type", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "redshift-serverless:CreateNamespace", - "redshift-serverless:CreateWorkgroup", - "redshift-serverless:GetWorkgroup", - "redshift-serverless:GetNamespace" - ] - }, - "delete": { - "permissions": [ - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "redshift-serverless:GetWorkgroup", - "redshift-serverless:GetNamespace", - "redshift-serverless:DeleteWorkgroup" - ] - }, - "list": { - "permissions": [ - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "redshift-serverless:ListWorkgroups" - ] - }, - "read": { - "permissions": [ - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "redshift-serverless:GetWorkgroup" - ] - }, - "update": { - "permissions": [ - "ec2:DescribeVpcAttribute", - "ec2:DescribeSecurityGroups", - "ec2:DescribeAddresses", - "ec2:DescribeInternetGateways", - "ec2:DescribeSubnets", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "redshift-serverless:ListTagsForResource", - "redshift-serverless:TagResource", - "redshift-serverless:UntagResource", - "redshift-serverless:GetWorkgroup", - "redshift-serverless:UpdateWorkgroup" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkgroupName" - ], - "properties": { - "BaseCapacity": { - "description": "The base compute capacity of the workgroup in Redshift Processing Units (RPUs).", - "type": "integer" - }, - "ConfigParameters": { - "description": "A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ConfigParameter" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "EnhancedVpcRouting": { - "default": false, - "description": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.", - "type": "boolean" - }, - "MaxCapacity": { - "description": "The max compute capacity of the workgroup in Redshift Processing Units (RPUs).", - "type": "integer" - }, - "NamespaceName": { - "description": "The namespace the workgroup is associated with.", - "maxLength": 64, - "minLength": 3, - "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", - "type": "string" - }, - "Port": { - "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.", - "type": "integer" - }, - "PubliclyAccessible": { - "default": false, - "description": "A value that specifies whether the workgroup can be accessible from a public network.", - "type": "boolean" - }, - "SecurityGroupIds": { - "description": "A list of security group IDs to associate with the workgroup.", - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 0, - "pattern": "^sg-[0-9a-fA-F]{8,}$", - "type": "string" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, - "SubnetIds": { - "description": "A list of subnet IDs the workgroup is associated with.", - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 0, - "pattern": "^subnet-[0-9a-fA-F]{8,}$", - "type": "string" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, - "Tags": { - "description": "The map of the key-value pairs used to tag the workgroup.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "Workgroup": { - "$ref": "#/definitions/Workgroup", - "description": "Definition for workgroup resource" - }, - "WorkgroupName": { - "description": "The name of the workgroup.", - "maxLength": 64, - "minLength": 3, - "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Workgroup", - "/properties/Workgroup/WorkgroupId", - "/properties/Workgroup/WorkgroupArn", - "/properties/Workgroup/WorkgroupName", - "/properties/Workgroup/NamespaceName", - "/properties/Workgroup/BaseCapacity", - "/properties/Workgroup/MaxCapacity", - "/properties/Workgroup/EnhancedVpcRouting", - "/properties/Workgroup/ConfigParameters/*/ParameterKey", - "/properties/Workgroup/ConfigParameters/*/ParameterValue", - "/properties/Workgroup/SecurityGroupIds", - "/properties/Workgroup/SubnetIds", - "/properties/Workgroup/Status", - "/properties/Workgroup/Endpoint/Address", - "/properties/Workgroup/Endpoint/Port", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/VpcEndpointId", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/VpcId", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/NetworkInterfaceId", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/SubnetId", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/PrivateIpAddress", - "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/AvailabilityZone", - "/properties/Workgroup/PubliclyAccessible", - "/properties/Workgroup/CreationDate" - ], - "required": [ - "WorkgroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift-serverless", - "tagging": { - "taggable": true - }, - "typeName": "AWS::RedshiftServerless::Workgroup", - "writeOnlyProperties": [ - "/properties/BaseCapacity", - "/properties/MaxCapacity", - "/properties/ConfigParameters", - "/properties/SecurityGroupIds", - "/properties/SubnetIds", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WorkgroupName", + "/properties/NamespaceName" + ], + "definitions": { + "ConfigParameter": { + "additionalProperties": false, + "properties": { + "ParameterKey": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ParameterValue": { + "maxLength": 15000, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Endpoint": { + "additionalProperties": false, + "properties": { + "Address": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "VpcEndpoints": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VpcEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkInterface": { + "additionalProperties": false, + "properties": { + "AvailabilityZone": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "SubnetId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcEndpoint": { + "additionalProperties": false, + "properties": { + "NetworkInterfaces": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "type": "array" + }, + "VpcEndpointId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + }, + "Workgroup": { + "additionalProperties": false, + "properties": { + "BaseCapacity": { + "type": "integer" + }, + "ConfigParameters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigParameter" + }, + "type": "array", + "uniqueItems": true + }, + "CreationDate": { + "type": "string" + }, + "Endpoint": { + "$ref": "#/definitions/Endpoint" + }, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "MaxCapacity": { + "type": "integer" + }, + "NamespaceName": { + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]+$", + "type": "string" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 0, + "pattern": "^sg-[0-9a-fA-F]{8,}$", + "type": "string" + }, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/WorkgroupStatus" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 0, + "pattern": "^subnet-[0-9a-fA-F]{8,}$", + "type": "string" + }, + "type": "array" + }, + "WorkgroupArn": { + "type": "string" + }, + "WorkgroupId": { + "type": "string" + }, + "WorkgroupName": { + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]*$", + "type": "string" + } + }, + "type": "object" + }, + "WorkgroupStatus": { + "enum": [ + "CREATING", + "AVAILABLE", + "MODIFYING", + "DELETING" + ], + "type": "string" + } + }, + "description": "Definition of AWS::RedshiftServerless::Workgroup Resource Type", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "redshift-serverless:CreateNamespace", + "redshift-serverless:CreateWorkgroup", + "redshift-serverless:GetWorkgroup", + "redshift-serverless:GetNamespace" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "redshift-serverless:GetWorkgroup", + "redshift-serverless:GetNamespace", + "redshift-serverless:DeleteWorkgroup" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "redshift-serverless:ListWorkgroups" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "redshift-serverless:GetWorkgroup" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeVpcAttribute", + "ec2:DescribeSecurityGroups", + "ec2:DescribeAddresses", + "ec2:DescribeInternetGateways", + "ec2:DescribeSubnets", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "redshift-serverless:ListTagsForResource", + "redshift-serverless:TagResource", + "redshift-serverless:UntagResource", + "redshift-serverless:GetWorkgroup", + "redshift-serverless:UpdateWorkgroup" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkgroupName" + ], + "properties": { + "BaseCapacity": { + "description": "The base compute capacity of the workgroup in Redshift Processing Units (RPUs).", + "type": "integer" + }, + "ConfigParameters": { + "description": "A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ConfigParameter" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EnhancedVpcRouting": { + "default": false, + "description": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.", + "type": "boolean" + }, + "MaxCapacity": { + "description": "The max compute capacity of the workgroup in Redshift Processing Units (RPUs).", + "type": "integer" + }, + "NamespaceName": { + "description": "The namespace the workgroup is associated with.", + "maxLength": 64, + "minLength": 3, + "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", + "type": "string" + }, + "Port": { + "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.", + "type": "integer" + }, + "PubliclyAccessible": { + "default": false, + "description": "A value that specifies whether the workgroup can be accessible from a public network.", + "type": "boolean" + }, + "SecurityGroupIds": { + "description": "A list of security group IDs to associate with the workgroup.", + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 0, + "pattern": "^sg-[0-9a-fA-F]{8,}$", + "type": "string" + }, + "maxItems": 32, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "description": "A list of subnet IDs the workgroup is associated with.", + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 0, + "pattern": "^subnet-[0-9a-fA-F]{8,}$", + "type": "string" + }, + "maxItems": 32, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "The map of the key-value pairs used to tag the workgroup.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Workgroup": { + "$ref": "#/definitions/Workgroup", + "description": "Definition for workgroup resource" + }, + "WorkgroupName": { + "description": "The name of the workgroup.", + "maxLength": 64, + "minLength": 3, + "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Workgroup", + "/properties/Workgroup/WorkgroupId", + "/properties/Workgroup/WorkgroupArn", + "/properties/Workgroup/WorkgroupName", + "/properties/Workgroup/NamespaceName", + "/properties/Workgroup/BaseCapacity", + "/properties/Workgroup/MaxCapacity", + "/properties/Workgroup/EnhancedVpcRouting", + "/properties/Workgroup/ConfigParameters/*/ParameterKey", + "/properties/Workgroup/ConfigParameters/*/ParameterValue", + "/properties/Workgroup/SecurityGroupIds", + "/properties/Workgroup/SubnetIds", + "/properties/Workgroup/Status", + "/properties/Workgroup/Endpoint/Address", + "/properties/Workgroup/Endpoint/Port", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/VpcEndpointId", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/VpcId", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/NetworkInterfaceId", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/SubnetId", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/PrivateIpAddress", + "/properties/Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/AvailabilityZone", + "/properties/Workgroup/PubliclyAccessible", + "/properties/Workgroup/CreationDate" + ], + "required": [ + "WorkgroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-redshift-serverless", + "tagging": { + "taggable": true + }, + "typeName": "AWS::RedshiftServerless::Workgroup", + "writeOnlyProperties": [ + "/properties/BaseCapacity", + "/properties/MaxCapacity", + "/properties/ConfigParameters", + "/properties/SecurityGroupIds", + "/properties/SubnetIds", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-refactorspaces-application.json b/schema/aws-refactorspaces-application.json index 963876c..56fb2e1 100644 --- a/schema/aws-refactorspaces-application.json +++ b/schema/aws-refactorspaces-application.json @@ -1,247 +1,247 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiGatewayProxy", - "/properties/EnvironmentIdentifier", - "/properties/Name", - "/properties/ProxyType", - "/properties/VpcId" - ], - "definitions": { - "ApiGatewayEndpointType": { - "enum": [ - "REGIONAL", - "PRIVATE" - ], - "type": "string" - }, - "ApiGatewayProxyInput": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "$ref": "#/definitions/ApiGatewayEndpointType" - }, - "StageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[-a-zA-Z0-9_]*$", - "type": "string" - } - }, - "type": "object" - }, - "ProxyType": { - "enum": [ - "API_GATEWAY" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Environment resource", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).+", - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RefactorSpaces::Application Resource Type", - "handlers": { - "create": { - "permissions": [ - "refactor-spaces:GetApplication", - "refactor-spaces:CreateApplication", - "refactor-spaces:TagResource", - "ec2:CreateTags", - "ec2:CreateVpcEndpointServiceConfiguration", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:DescribeAccountAttributes", - "ec2:DescribeInternetGateways", - "ec2:ModifyVpcEndpointServicePermissions", - "apigateway:DELETE", - "apigateway:GET", - "apigateway:PATCH", - "apigateway:POST", - "apigateway:PUT", - "apigateway:UpdateRestApiPolicy", - "apigateway:Update*", - "apigateway:Delete*", - "apigateway:Get*", - "apigateway:Put*", - "elasticloadbalancing:CreateLoadBalancer", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeTags", - "elasticloadbalancing:AddTags", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "refactor-spaces:GetApplication", - "refactor-spaces:DeleteApplication", - "refactor-spaces:UntagResource", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:DeleteRoute", - "ec2:DeleteSecurityGroup", - "ec2:DeleteTransitGateway", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteVpcEndpointServiceConfigurations", - "ec2:DeleteTags", - "ec2:RevokeSecurityGroupIngress", - "elasticloadbalancing:DeleteLoadBalancer", - "apigateway:Update*", - "apigateway:Delete*", - "apigateway:Get*", - "apigateway:Put*" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "EnvironmentIdentifier": { - "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" - } - }, - "required": [ - "EnvironmentIdentifier" - ] - }, - "permissions": [ - "refactor-spaces:ListApplications", - "refactor-spaces:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "refactor-spaces:GetApplication", - "refactor-spaces:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentIdentifier", - "/properties/ApplicationIdentifier" - ], - "properties": { - "ApiGatewayId": { - "maxLength": 10, - "minLength": 10, - "pattern": "^[a-z0-9]{10}$", - "type": "string" - }, - "ApiGatewayProxy": { - "$ref": "#/definitions/ApiGatewayProxyInput" - }, - "ApplicationIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^app-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "EnvironmentIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^env-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", - "type": "string" - }, - "NlbArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*)?:elasticloadbalancing:[a-zA-Z0-9\\\\-]+:\\\\w{12}:[a-zA-Z_0-9+=,.@\\\\-_\\/]+$", - "type": "string" - }, - "NlbName": { - "maxLength": 32, - "minLength": 1, - "pattern": "^(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]$", - "type": "string" - }, - "ProxyType": { - "$ref": "#/definitions/ProxyType" - }, - "ProxyUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^http://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", - "type": "string" - }, - "StageName": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[-a-zA-Z0-9_]*$", - "type": "string" - }, - "Tags": { - "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "maxLength": 21, - "minLength": 12, - "pattern": "^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$", - "type": "string" - }, - "VpcLinkId": { - "maxLength": 10, - "minLength": 10, - "pattern": "^[a-z0-9]{10}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationIdentifier", - "/properties/Arn", - "/properties/ApiGatewayId", - "/properties/VpcLinkId", - "/properties/NlbArn", - "/properties/NlbName", - "/properties/ProxyUrl", - "/properties/StageName" - ], - "required": [ - "EnvironmentIdentifier", - "VpcId", - "Name", - "ProxyType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", - "taggable": true, - "typeName": "AWS::RefactorSpaces::Application", - "writeOnlyProperties": [ - "/properties/ApiGatewayProxy" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiGatewayProxy", + "/properties/EnvironmentIdentifier", + "/properties/Name", + "/properties/ProxyType", + "/properties/VpcId" + ], + "definitions": { + "ApiGatewayEndpointType": { + "enum": [ + "REGIONAL", + "PRIVATE" + ], + "type": "string" + }, + "ApiGatewayProxyInput": { + "additionalProperties": false, + "properties": { + "EndpointType": { + "$ref": "#/definitions/ApiGatewayEndpointType" + }, + "StageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[-a-zA-Z0-9_]*$", + "type": "string" + } + }, + "type": "object" + }, + "ProxyType": { + "enum": [ + "API_GATEWAY" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Environment resource", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).+", + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RefactorSpaces::Application Resource Type", + "handlers": { + "create": { + "permissions": [ + "refactor-spaces:GetApplication", + "refactor-spaces:CreateApplication", + "refactor-spaces:TagResource", + "ec2:CreateTags", + "ec2:CreateVpcEndpointServiceConfiguration", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:DescribeAccountAttributes", + "ec2:DescribeInternetGateways", + "ec2:ModifyVpcEndpointServicePermissions", + "apigateway:DELETE", + "apigateway:GET", + "apigateway:PATCH", + "apigateway:POST", + "apigateway:PUT", + "apigateway:UpdateRestApiPolicy", + "apigateway:Update*", + "apigateway:Delete*", + "apigateway:Get*", + "apigateway:Put*", + "elasticloadbalancing:CreateLoadBalancer", + "elasticloadbalancing:DescribeLoadBalancers", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:AddTags", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "refactor-spaces:GetApplication", + "refactor-spaces:DeleteApplication", + "refactor-spaces:UntagResource", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:DeleteRoute", + "ec2:DeleteSecurityGroup", + "ec2:DeleteTransitGateway", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteVpcEndpointServiceConfigurations", + "ec2:DeleteTags", + "ec2:RevokeSecurityGroupIngress", + "elasticloadbalancing:DeleteLoadBalancer", + "apigateway:Update*", + "apigateway:Delete*", + "apigateway:Get*", + "apigateway:Put*" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "EnvironmentIdentifier" + ] + }, + "permissions": [ + "refactor-spaces:ListApplications", + "refactor-spaces:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "refactor-spaces:GetApplication", + "refactor-spaces:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentIdentifier", + "/properties/ApplicationIdentifier" + ], + "properties": { + "ApiGatewayId": { + "maxLength": 10, + "minLength": 10, + "pattern": "^[a-z0-9]{10}$", + "type": "string" + }, + "ApiGatewayProxy": { + "$ref": "#/definitions/ApiGatewayProxyInput" + }, + "ApplicationIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^app-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "EnvironmentIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^env-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", + "type": "string" + }, + "NlbArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*)?:elasticloadbalancing:[a-zA-Z0-9\\\\-]+:\\\\w{12}:[a-zA-Z_0-9+=,.@\\\\-_\\/]+$", + "type": "string" + }, + "NlbName": { + "maxLength": 32, + "minLength": 1, + "pattern": "^(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]$", + "type": "string" + }, + "ProxyType": { + "$ref": "#/definitions/ProxyType" + }, + "ProxyUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^http://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", + "type": "string" + }, + "StageName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[-a-zA-Z0-9_]*$", + "type": "string" + }, + "Tags": { + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "VpcId": { + "maxLength": 21, + "minLength": 12, + "pattern": "^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$", + "type": "string" + }, + "VpcLinkId": { + "maxLength": 10, + "minLength": 10, + "pattern": "^[a-z0-9]{10}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationIdentifier", + "/properties/Arn", + "/properties/ApiGatewayId", + "/properties/VpcLinkId", + "/properties/NlbArn", + "/properties/NlbName", + "/properties/ProxyUrl", + "/properties/StageName" + ], + "required": [ + "EnvironmentIdentifier", + "VpcId", + "Name", + "ProxyType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", + "taggable": true, + "typeName": "AWS::RefactorSpaces::Application", + "writeOnlyProperties": [ + "/properties/ApiGatewayProxy" + ] +} diff --git a/schema/aws-refactorspaces-environment.json b/schema/aws-refactorspaces-environment.json index 53e4955..46383ec 100644 --- a/schema/aws-refactorspaces-environment.json +++ b/schema/aws-refactorspaces-environment.json @@ -1,163 +1,163 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/NetworkFabricType" - ], - "definitions": { - "NetworkFabricType": { - "enum": [ - "TRANSIT_GATEWAY", - "NONE" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Environment resource", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).+", - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RefactorSpaces::Environment Resource Type", - "handlers": { - "create": { - "permissions": [ - "refactor-spaces:CreateEnvironment", - "refactor-spaces:GetEnvironment", - "refactor-spaces:TagResource", - "ec2:CreateTransitGateway", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:CreateSecurityGroup", - "ec2:CreateTags", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeRouteTables", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:DescribeTags", - "ec2:DescribeTransitGateways", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:ModifyVpcEndpointServicePermissions", - "ec2:RevokeSecurityGroupIngress", - "ram:AssociateResourceShare", - "ram:CreateResourceShare", - "ram:GetResourceShareAssociations", - "ram:GetResourceShares", - "ram:TagResource", - "ram:GetResourceShareInvitations", - "ram:AcceptResourceShareInvitation", - "ram:DisassociateResourceShare", - "tag:GetResources", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "refactor-spaces:GetEnvironment", - "refactor-spaces:DeleteEnvironment", - "refactor-spaces:UntagResource", - "ec2:DescribeTransitGateways", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DeleteTransitGateway", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags", - "ram:GetResourceShareAssociations", - "ram:DeleteResourceShare" - ] - }, - "list": { - "permissions": [ - "refactor-spaces:ListEnvironments", - "refactor-spaces:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "refactor-spaces:GetEnvironment", - "refactor-spaces:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentIdentifier" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Description": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$", - "type": "string" - }, - "EnvironmentIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^env-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", - "type": "string" - }, - "NetworkFabricType": { - "$ref": "#/definitions/NetworkFabricType" - }, - "Tags": { - "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "maxLength": 21, - "minLength": 21, - "pattern": "^tgw-[-a-f0-9]{17}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/EnvironmentIdentifier", - "/properties/Arn", - "/properties/TransitGatewayId" - ], - "required": [ - "Name", - "NetworkFabricType" - ], - "taggable": true, - "typeName": "AWS::RefactorSpaces::Environment", - "writeOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/NetworkFabricType" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/NetworkFabricType" + ], + "definitions": { + "NetworkFabricType": { + "enum": [ + "TRANSIT_GATEWAY", + "NONE" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Environment resource", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).+", + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RefactorSpaces::Environment Resource Type", + "handlers": { + "create": { + "permissions": [ + "refactor-spaces:CreateEnvironment", + "refactor-spaces:GetEnvironment", + "refactor-spaces:TagResource", + "ec2:CreateTransitGateway", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateSecurityGroup", + "ec2:CreateTags", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeRouteTables", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeTags", + "ec2:DescribeTransitGateways", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeVpcEndpointServiceConfigurations", + "ec2:ModifyVpcEndpointServicePermissions", + "ec2:RevokeSecurityGroupIngress", + "ram:AssociateResourceShare", + "ram:CreateResourceShare", + "ram:GetResourceShareAssociations", + "ram:GetResourceShares", + "ram:TagResource", + "ram:GetResourceShareInvitations", + "ram:AcceptResourceShareInvitation", + "ram:DisassociateResourceShare", + "tag:GetResources", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "refactor-spaces:GetEnvironment", + "refactor-spaces:DeleteEnvironment", + "refactor-spaces:UntagResource", + "ec2:DescribeTransitGateways", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DeleteTransitGateway", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags", + "ram:GetResourceShareAssociations", + "ram:DeleteResourceShare" + ] + }, + "list": { + "permissions": [ + "refactor-spaces:ListEnvironments", + "refactor-spaces:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "refactor-spaces:GetEnvironment", + "refactor-spaces:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Description": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$", + "type": "string" + }, + "EnvironmentIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^env-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", + "type": "string" + }, + "NetworkFabricType": { + "$ref": "#/definitions/NetworkFabricType" + }, + "Tags": { + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TransitGatewayId": { + "maxLength": 21, + "minLength": 21, + "pattern": "^tgw-[-a-f0-9]{17}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/EnvironmentIdentifier", + "/properties/Arn", + "/properties/TransitGatewayId" + ], + "required": [ + "Name", + "NetworkFabricType" + ], + "taggable": true, + "typeName": "AWS::RefactorSpaces::Environment", + "writeOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/NetworkFabricType" + ] +} diff --git a/schema/aws-refactorspaces-route.json b/schema/aws-refactorspaces-route.json index 199c935..663d9e0 100644 --- a/schema/aws-refactorspaces-route.json +++ b/schema/aws-refactorspaces-route.json @@ -1,296 +1,310 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationIdentifier", - "/properties/EnvironmentIdentifier", - "/properties/RouteType", - "/properties/ServiceIdentifier", - "/properties/UriPathRoute/SourcePath", - "/properties/UriPathRoute/Methods", - "/properties/UriPathRoute/IncludeChildPaths", - "/properties/UriPathRoute/AppendSourcePath" - ], - "definitions": { - "DefaultRouteInput": { - "additionalProperties": false, - "properties": { - "ActivationState": { - "$ref": "#/definitions/RouteActivationState" - } - }, - "required": [ - "ActivationState" - ], - "type": "object" - }, - "Method": { - "enum": [ - "DELETE", - "GET", - "HEAD", - "OPTIONS", - "PATCH", - "POST", - "PUT" - ], - "type": "string" - }, - "RouteActivationState": { - "enum": [ - "INACTIVE", - "ACTIVE" - ], - "type": "string" - }, - "RouteType": { - "enum": [ - "DEFAULT", - "URI_PATH" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Environment resource", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).+", - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UriPathRouteInput": { - "additionalProperties": false, - "properties": { - "ActivationState": { - "$ref": "#/definitions/RouteActivationState" - }, - "AppendSourcePath": { - "type": "boolean" - }, - "IncludeChildPaths": { - "type": "boolean" - }, - "Methods": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Method" - }, - "type": "array" - }, - "SourcePath": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^(/([a-zA-Z0-9._:-]+|\\{[a-zA-Z0-9._:-]+\\}))+$", - "type": "string" - } - }, - "required": [ - "ActivationState" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RefactorSpaces::Route Resource Type", - "handlers": { - "create": { - "permissions": [ - "refactor-spaces:CreateRoute", - "refactor-spaces:GetRoute", - "refactor-spaces:TagResource", - "iam:CreateServiceLinkedRole", - "apigateway:GET", - "apigateway:PATCH", - "apigateway:POST", - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:UpdateRestApiPolicy", - "lambda:GetFunctionConfiguration", - "lambda:AddPermission", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:CreateListener", - "elasticloadbalancing:CreateTargetGroup", - "elasticloadbalancing:DescribeTags", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RegisterTargets", - "elasticloadbalancing:DescribeTargetHealth", - "ec2:DescribeSubnets", - "tag:GetResources" - ] - }, - "delete": { - "permissions": [ - "refactor-spaces:DeleteRoute", - "refactor-spaces:GetRoute", - "refactor-spaces:UntagResource", - "apigateway:GET", - "apigateway:PATCH", - "apigateway:POST", - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:UpdateRestApiPolicy", - "lambda:GetFunctionConfiguration", - "lambda:AddPermission", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:CreateListener", - "elasticloadbalancing:CreateTargetGroup", - "elasticloadbalancing:DeleteListener", - "elasticloadbalancing:DeleteTargetGroup", - "elasticloadbalancing:DescribeTags", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RegisterTargets", - "elasticloadbalancing:DescribeTargetHealth", - "ec2:DescribeSubnets", - "tag:GetResources" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationIdentifier": { - "$ref": "resource-schema.json#/properties/ApplicationIdentifier" - }, - "EnvironmentIdentifier": { - "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" - } - }, - "required": [ - "EnvironmentIdentifier", - "ApplicationIdentifier" - ] - }, - "permissions": [ - "refactor-spaces:ListRoutes", - "refactor-spaces:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "refactor-spaces:GetRoute", - "refactor-spaces:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "refactor-spaces:UpdateRoute", - "refactor-spaces:GetRoute", - "refactor-spaces:TagResource", - "iam:CreateServiceLinkedRole", - "apigateway:GET", - "apigateway:PATCH", - "apigateway:POST", - "apigateway:PUT", - "apigateway:DELETE", - "apigateway:UpdateRestApiPolicy", - "lambda:GetFunctionConfiguration", - "lambda:AddPermission", - "elasticloadbalancing:DescribeListeners", - "elasticloadbalancing:DescribeTargetGroups", - "elasticloadbalancing:CreateListener", - "elasticloadbalancing:CreateTargetGroup", - "elasticloadbalancing:DeleteListener", - "elasticloadbalancing:DeleteTargetGroup", - "elasticloadbalancing:DescribeTags", - "elasticloadbalancing:AddTags", - "elasticloadbalancing:RegisterTargets", - "elasticloadbalancing:DescribeTargetHealth", - "ec2:DescribeSubnets", - "ec2:DescribeSubnets", - "tag:GetResources" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentIdentifier", - "/properties/ApplicationIdentifier", - "/properties/RouteIdentifier" - ], - "properties": { - "ApplicationIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^app-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "DefaultRoute": { - "$ref": "#/definitions/DefaultRouteInput" - }, - "EnvironmentIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^env-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "PathResourceToId": { - "type": "string" - }, - "RouteIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^rte-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "RouteType": { - "$ref": "#/definitions/RouteType" - }, - "ServiceIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^svc-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Tags": { - "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UriPathRoute": { - "$ref": "#/definitions/UriPathRouteInput" - } - }, - "readOnlyProperties": [ - "/properties/RouteIdentifier", - "/properties/PathResourceToId", - "/properties/Arn" - ], - "required": [ - "EnvironmentIdentifier", - "ApplicationIdentifier", - "ServiceIdentifier", - "RouteType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", - "taggable": true, - "typeName": "AWS::RefactorSpaces::Route", - "writeOnlyProperties": [ - "/properties/RouteType", - "/properties/ServiceIdentifier", - "/properties/DefaultRoute", - "/properties/UriPathRoute" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationIdentifier", + "/properties/EnvironmentIdentifier", + "/properties/RouteType", + "/properties/ServiceIdentifier", + "/properties/UriPathRoute/SourcePath", + "/properties/UriPathRoute/Methods", + "/properties/UriPathRoute/IncludeChildPaths", + "/properties/UriPathRoute/AppendSourcePath" + ], + "definitions": { + "DefaultRouteInput": { + "additionalProperties": false, + "properties": { + "ActivationState": { + "$ref": "#/definitions/RouteActivationState" + } + }, + "required": [ + "ActivationState" + ], + "type": "object" + }, + "Method": { + "enum": [ + "DELETE", + "GET", + "HEAD", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "type": "string" + }, + "RouteActivationState": { + "enum": [ + "INACTIVE", + "ACTIVE" + ], + "type": "string" + }, + "RouteType": { + "enum": [ + "DEFAULT", + "URI_PATH" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Environment resource", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).+", + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UriPathRouteInput": { + "additionalProperties": false, + "properties": { + "ActivationState": { + "$ref": "#/definitions/RouteActivationState" + }, + "AppendSourcePath": { + "type": "boolean" + }, + "IncludeChildPaths": { + "type": "boolean" + }, + "Methods": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Method" + }, + "type": "array" + }, + "SourcePath": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(/([a-zA-Z0-9._:-]+|\\{[a-zA-Z0-9._:-]+\\}))+$", + "type": "string" + } + }, + "required": [ + "ActivationState" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RefactorSpaces::Route Resource Type", + "handlers": { + "create": { + "permissions": [ + "refactor-spaces:CreateRoute", + "refactor-spaces:GetRoute", + "refactor-spaces:TagResource", + "iam:CreateServiceLinkedRole", + "apigateway:GET", + "apigateway:PATCH", + "apigateway:POST", + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:UpdateRestApiPolicy", + "lambda:GetFunctionConfiguration", + "lambda:AddPermission", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:CreateListener", + "elasticloadbalancing:CreateTargetGroup", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RegisterTargets", + "elasticloadbalancing:DescribeTargetHealth", + "ec2:DescribeSubnets", + "tag:GetResources" + ] + }, + "delete": { + "permissions": [ + "refactor-spaces:DeleteRoute", + "refactor-spaces:GetRoute", + "refactor-spaces:UntagResource", + "apigateway:GET", + "apigateway:PATCH", + "apigateway:POST", + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:UpdateRestApiPolicy", + "lambda:GetFunctionConfiguration", + "lambda:AddPermission", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:CreateListener", + "elasticloadbalancing:CreateTargetGroup", + "elasticloadbalancing:DeleteListener", + "elasticloadbalancing:DeleteTargetGroup", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RegisterTargets", + "elasticloadbalancing:DescribeTargetHealth", + "ec2:DescribeSubnets", + "tag:GetResources" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationIdentifier": { + "$ref": "resource-schema.json#/properties/ApplicationIdentifier" + }, + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "EnvironmentIdentifier", + "ApplicationIdentifier" + ] + }, + "permissions": [ + "refactor-spaces:ListRoutes", + "refactor-spaces:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "refactor-spaces:GetRoute", + "refactor-spaces:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "refactor-spaces:UpdateRoute", + "refactor-spaces:GetRoute", + "refactor-spaces:TagResource", + "iam:CreateServiceLinkedRole", + "apigateway:GET", + "apigateway:PATCH", + "apigateway:POST", + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:UpdateRestApiPolicy", + "lambda:GetFunctionConfiguration", + "lambda:AddPermission", + "elasticloadbalancing:DescribeListeners", + "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:CreateListener", + "elasticloadbalancing:CreateTargetGroup", + "elasticloadbalancing:DeleteListener", + "elasticloadbalancing:DeleteTargetGroup", + "elasticloadbalancing:DescribeTags", + "elasticloadbalancing:AddTags", + "elasticloadbalancing:RegisterTargets", + "elasticloadbalancing:DescribeTargetHealth", + "ec2:DescribeSubnets", + "ec2:DescribeSubnets", + "tag:GetResources" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentIdentifier", + "/properties/ApplicationIdentifier", + "/properties/RouteIdentifier" + ], + "properties": { + "ApplicationIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^app-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "DefaultRoute": { + "$ref": "#/definitions/DefaultRouteInput" + }, + "EnvironmentIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^env-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "PathResourceToId": { + "type": "string" + }, + "RouteIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^rte-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "RouteType": { + "$ref": "#/definitions/RouteType" + }, + "ServiceIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^svc-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Tags": { + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "UriPathRoute": { + "$ref": "#/definitions/UriPathRouteInput" + } + }, + "readOnlyProperties": [ + "/properties/RouteIdentifier", + "/properties/PathResourceToId", + "/properties/Arn" + ], + "required": [ + "EnvironmentIdentifier", + "ApplicationIdentifier", + "ServiceIdentifier", + "RouteType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "refactor-spaces:ListTagsForResource", + "tag:GetResources", + "elasticloadbalancing:AddTags", + "refactor-spaces:UntagResource", + "refactor-spaces:TagResource", + "elasticloadbalancing:DescribeTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RefactorSpaces::Route", + "writeOnlyProperties": [ + "/properties/RouteType", + "/properties/ServiceIdentifier", + "/properties/DefaultRoute", + "/properties/UriPathRoute" + ] +} diff --git a/schema/aws-refactorspaces-service.json b/schema/aws-refactorspaces-service.json index a7335a3..eacf2ca 100644 --- a/schema/aws-refactorspaces-service.json +++ b/schema/aws-refactorspaces-service.json @@ -1,232 +1,232 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/EndpointType", - "/properties/EnvironmentIdentifier", - "/properties/ApplicationIdentifier", - "/properties/LambdaEndpoint", - "/properties/Name", - "/properties/UrlEndpoint", - "/properties/VpcId" - ], - "definitions": { - "LambdaEndpointInput": { - "additionalProperties": false, - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "ServiceEndpointType": { - "enum": [ - "LAMBDA", - "URL" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A label for tagging Environment resource", - "properties": { - "Key": { - "description": "A string used to identify this tag", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:).+", - "type": "string" - }, - "Value": { - "description": "A string containing the value for the tag", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UrlEndpointInput": { - "additionalProperties": false, - "properties": { - "HealthUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", - "type": "string" - }, - "Url": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", - "type": "string" - } - }, - "required": [ - "Url" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RefactorSpaces::Service Resource Type", - "handlers": { - "create": { - "permissions": [ - "refactor-spaces:CreateService", - "refactor-spaces:GetService", - "refactor-spaces:TagResource", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeRouteTables", - "ec2:CreateTags", - "ec2:CreateTransitGatewayVpcAttachment", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:CreateSecurityGroup", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:CreateRoute", - "lambda:GetFunctionConfiguration" - ] - }, - "delete": { - "permissions": [ - "refactor-spaces:DeleteService", - "refactor-spaces:GetService", - "refactor-spaces:UntagResource", - "ram:DisassociateResourceShare", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeRouteTables", - "ec2:DescribeTransitGatewayVpcAttachments", - "ec2:DescribeSecurityGroups", - "ec2:DeleteSecurityGroup", - "ec2:DeleteRoute", - "ec2:RevokeSecurityGroupIngress", - "ec2:DeleteTransitGatewayVpcAttachment", - "ec2:DeleteTags" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationIdentifier": { - "$ref": "resource-schema.json#/properties/ApplicationIdentifier" - }, - "EnvironmentIdentifier": { - "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" - } - }, - "required": [ - "EnvironmentIdentifier", - "ApplicationIdentifier" - ] - }, - "permissions": [ - "refactor-spaces:ListServices", - "refactor-spaces:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "refactor-spacess:GetService", - "refactor-spaces:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/EnvironmentIdentifier", - "/properties/ApplicationIdentifier", - "/properties/ServiceIdentifier" - ], - "properties": { - "ApplicationIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^app-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Description": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$", - "type": "string" - }, - "EndpointType": { - "$ref": "#/definitions/ServiceEndpointType" - }, - "EnvironmentIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^env-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "LambdaEndpoint": { - "$ref": "#/definitions/LambdaEndpointInput" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", - "type": "string" - }, - "ServiceIdentifier": { - "maxLength": 14, - "minLength": 14, - "pattern": "^svc-([0-9A-Za-z]{10}$)", - "type": "string" - }, - "Tags": { - "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UrlEndpoint": { - "$ref": "#/definitions/UrlEndpointInput" - }, - "VpcId": { - "maxLength": 21, - "minLength": 12, - "pattern": "^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ServiceIdentifier", - "/properties/Arn" - ], - "required": [ - "EnvironmentIdentifier", - "ApplicationIdentifier", - "EndpointType", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", - "taggable": true, - "typeName": "AWS::RefactorSpaces::Service", - "writeOnlyProperties": [ - "/properties/Description", - "/properties/EndpointType", - "/properties/LambdaEndpoint", - "/properties/Name", - "/properties/UrlEndpoint", - "/properties/VpcId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/EndpointType", + "/properties/EnvironmentIdentifier", + "/properties/ApplicationIdentifier", + "/properties/LambdaEndpoint", + "/properties/Name", + "/properties/UrlEndpoint", + "/properties/VpcId" + ], + "definitions": { + "LambdaEndpointInput": { + "additionalProperties": false, + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "ServiceEndpointType": { + "enum": [ + "LAMBDA", + "URL" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Environment resource", + "properties": { + "Key": { + "description": "A string used to identify this tag", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:).+", + "type": "string" + }, + "Value": { + "description": "A string containing the value for the tag", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UrlEndpointInput": { + "additionalProperties": false, + "properties": { + "HealthUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", + "type": "string" + }, + "Url": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$", + "type": "string" + } + }, + "required": [ + "Url" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RefactorSpaces::Service Resource Type", + "handlers": { + "create": { + "permissions": [ + "refactor-spaces:CreateService", + "refactor-spaces:GetService", + "refactor-spaces:TagResource", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables", + "ec2:CreateTags", + "ec2:CreateTransitGatewayVpcAttachment", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:CreateSecurityGroup", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateRoute", + "lambda:GetFunctionConfiguration" + ] + }, + "delete": { + "permissions": [ + "refactor-spaces:DeleteService", + "refactor-spaces:GetService", + "refactor-spaces:UntagResource", + "ram:DisassociateResourceShare", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeRouteTables", + "ec2:DescribeTransitGatewayVpcAttachments", + "ec2:DescribeSecurityGroups", + "ec2:DeleteSecurityGroup", + "ec2:DeleteRoute", + "ec2:RevokeSecurityGroupIngress", + "ec2:DeleteTransitGatewayVpcAttachment", + "ec2:DeleteTags" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationIdentifier": { + "$ref": "resource-schema.json#/properties/ApplicationIdentifier" + }, + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "EnvironmentIdentifier", + "ApplicationIdentifier" + ] + }, + "permissions": [ + "refactor-spaces:ListServices", + "refactor-spaces:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "refactor-spacess:GetService", + "refactor-spaces:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnvironmentIdentifier", + "/properties/ApplicationIdentifier", + "/properties/ServiceIdentifier" + ], + "properties": { + "ApplicationIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^app-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Description": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$", + "type": "string" + }, + "EndpointType": { + "$ref": "#/definitions/ServiceEndpointType" + }, + "EnvironmentIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^env-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "LambdaEndpoint": { + "$ref": "#/definitions/LambdaEndpointInput" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$", + "type": "string" + }, + "ServiceIdentifier": { + "maxLength": 14, + "minLength": 14, + "pattern": "^svc-([0-9A-Za-z]{10}$)", + "type": "string" + }, + "Tags": { + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "UrlEndpoint": { + "$ref": "#/definitions/UrlEndpointInput" + }, + "VpcId": { + "maxLength": 21, + "minLength": 12, + "pattern": "^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ServiceIdentifier", + "/properties/Arn" + ], + "required": [ + "EnvironmentIdentifier", + "ApplicationIdentifier", + "EndpointType", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-refactor-spaces", + "taggable": true, + "typeName": "AWS::RefactorSpaces::Service", + "writeOnlyProperties": [ + "/properties/Description", + "/properties/EndpointType", + "/properties/LambdaEndpoint", + "/properties/Name", + "/properties/UrlEndpoint", + "/properties/VpcId" + ] +} diff --git a/schema/aws-rekognition-collection.json b/schema/aws-rekognition-collection.json index c8c9c2e..bf38845 100644 --- a/schema/aws-rekognition-collection.json +++ b/schema/aws-rekognition-collection.json @@ -1,109 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CollectionId" - ], - "definitions": { - "Arn": { - "$comment": "Use the `definitions` block to provide shared resource property schemas", - "format": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:collection\\/([a-zA-Z0-9_.\\-]+){1,255})", - "maxLength": 2048, - "type": "string" - }, - "CollectionId": { - "description": "The name of the collection", - "maxLength": 255, - "pattern": "\\A[a-zA-Z0-9_\\.\\-]+$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group", - "handlers": { - "create": { - "permissions": [ - "rekognition:CreateCollection", - "rekognition:DescribeCollection", - "rekognition:ListTagsForResource", - "rekognition:TagResource" - ] - }, - "delete": { - "permissions": [ - "rekognition:DeleteCollection" - ] - }, - "list": { - "permissions": [ - "rekognition:ListCollections" - ] - }, - "read": { - "permissions": [ - "rekognition:DescribeCollection", - "rekognition:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rekognition:TagResource", - "rekognition:UntagResource", - "rekognition:DescribeCollection", - "rekognition:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CollectionId" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CollectionId": { - "$ref": "#/definitions/CollectionId" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "CollectionId" - ], - "sourceUrl": "https://docs.aws.amazon.com/rekognition/latest/dg/collections.html", - "taggable": true, - "typeName": "AWS::Rekognition::Collection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CollectionId" + ], + "definitions": { + "Arn": { + "$comment": "Use the `definitions` block to provide shared resource property schemas", + "format": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:collection\\/([a-zA-Z0-9_.\\-]+){1,255})", + "maxLength": 2048, + "type": "string" + }, + "CollectionId": { + "description": "The name of the collection", + "maxLength": 255, + "pattern": "\\A[a-zA-Z0-9_\\.\\-]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group", + "handlers": { + "create": { + "permissions": [ + "rekognition:CreateCollection", + "rekognition:DescribeCollection", + "rekognition:ListTagsForResource", + "rekognition:TagResource" + ] + }, + "delete": { + "permissions": [ + "rekognition:DeleteCollection" + ] + }, + "list": { + "permissions": [ + "rekognition:ListCollections" + ] + }, + "read": { + "permissions": [ + "rekognition:DescribeCollection", + "rekognition:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rekognition:TagResource", + "rekognition:UntagResource", + "rekognition:DescribeCollection", + "rekognition:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CollectionId" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CollectionId": { + "$ref": "#/definitions/CollectionId" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "CollectionId" + ], + "sourceUrl": "https://docs.aws.amazon.com/rekognition/latest/dg/collections.html", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "rekognition:ListTagsForResource", + "rekognition:TagResource", + "rekognition:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Rekognition::Collection" +} diff --git a/schema/aws-rekognition-project.json b/schema/aws-rekognition-project.json index a8ab1e6..2197844 100644 --- a/schema/aws-rekognition-project.json +++ b/schema/aws-rekognition-project.json @@ -1,71 +1,71 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProjectName" - ], - "definitions": { - "Arn": { - "maxLength": 2048, - "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project/[a-zA-Z0-9_.\\-]{1,255}/[0-9]+$)", - "type": "string" - }, - "ProjectName": { - "description": "The name of the project", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9][a-zA-Z0-9_\\-]*", - "type": "string" - } - }, - "description": "The AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.", - "handlers": { - "create": { - "permissions": [ - "rekognition:CreateProject" - ], - "timeoutInMinutes": 15 - }, - "delete": { - "permissions": [ - "rekognition:DescribeProjects", - "rekognition:DeleteProject" - ], - "timeoutInMinutes": 15 - }, - "list": { - "permissions": [ - "rekognition:DescribeProjects" - ], - "timeoutInMinutes": 15 - }, - "read": { - "permissions": [ - "rekognition:DescribeProjects" - ], - "timeoutInMinutes": 15 - }, - "update": { - "permissions": [], - "timeoutInMinutes": 15 - } - }, - "primaryIdentifier": [ - "/properties/ProjectName" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "ProjectName": { - "$ref": "#/definitions/ProjectName" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ProjectName" - ], - "sourceUrl": "https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/cp-manage-project.html", - "typeName": "AWS::Rekognition::Project" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProjectName" + ], + "definitions": { + "Arn": { + "maxLength": 2048, + "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project/[a-zA-Z0-9_.\\-]{1,255}/[0-9]+$)", + "type": "string" + }, + "ProjectName": { + "description": "The name of the project", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_\\-]*", + "type": "string" + } + }, + "description": "The AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.", + "handlers": { + "create": { + "permissions": [ + "rekognition:CreateProject" + ], + "timeoutInMinutes": 15 + }, + "delete": { + "permissions": [ + "rekognition:DescribeProjects", + "rekognition:DeleteProject" + ], + "timeoutInMinutes": 15 + }, + "list": { + "permissions": [ + "rekognition:DescribeProjects" + ], + "timeoutInMinutes": 15 + }, + "read": { + "permissions": [ + "rekognition:DescribeProjects" + ], + "timeoutInMinutes": 15 + }, + "update": { + "permissions": [], + "timeoutInMinutes": 15 + } + }, + "primaryIdentifier": [ + "/properties/ProjectName" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "ProjectName": { + "$ref": "#/definitions/ProjectName" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ProjectName" + ], + "sourceUrl": "https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/cp-manage-project.html", + "typeName": "AWS::Rekognition::Project" +} diff --git a/schema/aws-rekognition-streamprocessor.json b/schema/aws-rekognition-streamprocessor.json index 994c47b..64634ab 100644 --- a/schema/aws-rekognition-streamprocessor.json +++ b/schema/aws-rekognition-streamprocessor.json @@ -1,395 +1,406 @@ -{ - "$comment": "We explicitly specify the replacement strategy to be delete_then_create because we cannot create a new SP resource with the same name or same KVS input before deleting the old one", - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/KmsKeyId", - "/properties/RoleArn", - "/properties/KinesisVideoStream", - "/properties/ConnectedHomeSettings", - "/properties/FaceSearchSettings", - "/properties/KinesisDataStream", - "/properties/S3Destination", - "/properties/NotificationChannel", - "/properties/BoundingBoxRegionsOfInterest", - "/properties/PolygonRegionsOfInterest", - "/properties/DataSharingPreference" - ], - "definitions": { - "Arn": { - "description": "The ARN of the stream processor", - "maxLength": 2048, - "type": "string" - }, - "BoundingBox": { - "additionalProperties": false, - "description": "A bounding box denoting a region of interest in the frame to be analyzed.", - "properties": { - "Height": { - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "Left": { - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "Top": { - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "Width": { - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "Height", - "Width", - "Left", - "Top" - ], - "type": "object" - }, - "ConnectedHomeSettings": { - "additionalProperties": false, - "description": "Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both", - "properties": { - "Labels": { - "$ref": "#/definitions/Labels" - }, - "MinConfidence": { - "description": "Minimum object class match confidence score that must be met to return a result for a recognized object.", - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "Labels" - ], - "type": "object" - }, - "DataSharingPreference": { - "additionalProperties": false, - "description": "Indicates whether Rekognition is allowed to store the video stream data for model-training.", - "properties": { - "OptIn": { - "description": "Flag to enable data-sharing", - "type": "boolean" - } - }, - "required": [ - "OptIn" - ], - "type": "object" - }, - "FaceSearchSettings": { - "additionalProperties": false, - "description": "Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both", - "properties": { - "CollectionId": { - "description": "The ID of a collection that contains faces that you want to search for.", - "maxLength": 255, - "pattern": "\\A[a-zA-Z0-9_\\.\\-]+$", - "type": "string" - }, - "FaceMatchThreshold": { - "description": "Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.", - "maximum": 100, - "minimum": 0, - "type": "number" - } - }, - "required": [ - "CollectionId" - ], - "type": "object" - }, - "KinesisDataStream": { - "additionalProperties": false, - "description": "The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.", - "properties": { - "Arn": { - "description": "ARN of the Kinesis Data Stream stream.", - "maxLength": 2048, - "pattern": "(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)", - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "KinesisVideoStream": { - "additionalProperties": false, - "description": "The Kinesis Video Stream that streams the source video.", - "properties": { - "Arn": { - "description": "ARN of the Kinesis Video Stream that streams the source video.", - "maxLength": 2048, - "pattern": "(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)", - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "Labels": { - "description": "List of labels that need to be detected in the video stream. Current supported values are PERSON, PET, PACKAGE, ALL.", - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "NotificationChannel": { - "additionalProperties": false, - "description": "The ARN of the SNS notification channel where events of interests are published, as part of connected home feature.", - "properties": { - "Arn": { - "description": "ARN of the SNS topic.", - "maxLength": 2048, - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "Point": { - "additionalProperties": false, - "description": "An (X, Y) cartesian coordinate denoting a point on the frame", - "properties": { - "X": { - "description": "The X coordinate of the point.", - "type": "number" - }, - "Y": { - "description": "The Y coordinate of the point.", - "type": "number" - } - }, - "required": [ - "X", - "Y" - ], - "type": "object" - }, - "Polygon": { - "description": "A polygon showing a region of interest. Note that the ordering of the Point entries matter in defining the polygon", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Point" - }, - "minItems": 3, - "type": "array", - "uniqueItems": true - }, - "S3Destination": { - "additionalProperties": false, - "description": "The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.", - "properties": { - "BucketName": { - "description": "Name of the S3 bucket.", - "maxLength": 63, - "type": "string" - }, - "ObjectKeyPrefix": { - "description": "The object key prefix path where the results will be stored. Default is no prefix path", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.\n\n", - "handlers": { - "create": { - "permissions": [ - "rekognition:CreateStreamProcessor", - "iam:PassRole", - "rekognition:DescribeStreamProcessor", - "rekognition:ListTagsForResource", - "rekognition:TagResource" - ] - }, - "delete": { - "permissions": [ - "rekognition:DeleteStreamProcessor" - ] - }, - "list": { - "permissions": [ - "rekognition:ListStreamProcessors" - ] - }, - "read": { - "permissions": [ - "rekognition:DescribeStreamProcessor", - "rekognition:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rekognition:TagResource", - "rekognition:UntagResource", - "rekognition:ListTagsForResource", - "rekognition:DescribeStreamProcessor" - ] - } - }, - "oneOf": [ - { - "required": [ - "ConnectedHomeSettings", - "S3Destination", - "NotificationChannel" - ] - }, - { - "required": [ - "FaceSearchSettings", - "KinesisDataStream" - ] - } - ], - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "BoundingBoxRegionsOfInterest": { - "description": "The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/BoundingBox" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "ConnectedHomeSettings": { - "$ref": "#/definitions/ConnectedHomeSettings" - }, - "DataSharingPreference": { - "$ref": "#/definitions/DataSharingPreference" - }, - "FaceSearchSettings": { - "$ref": "#/definitions/FaceSearchSettings" - }, - "KinesisDataStream": { - "$ref": "#/definitions/KinesisDataStream" - }, - "KinesisVideoStream": { - "$ref": "#/definitions/KinesisVideoStream" - }, - "KmsKeyId": { - "description": "The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.", - "type": "string" - }, - "Name": { - "description": "Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.", - "maxLength": 128, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.\\-]+", - "type": "string" - }, - "NotificationChannel": { - "$ref": "#/definitions/NotificationChannel" - }, - "PolygonRegionsOfInterest": { - "description": "The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Polygon" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "RoleArn": { - "description": "ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.", - "maxLength": 2048, - "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", - "type": "string" - }, - "S3Destination": { - "$ref": "#/definitions/S3Destination" - }, - "Status": { - "description": "Current status of the stream processor.", - "type": "string" - }, - "StatusMessage": { - "description": "Detailed status message about the stream processor.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Status", - "/properties/StatusMessage" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "RoleArn", - "KinesisVideoStream" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, - "typeName": "AWS::Rekognition::StreamProcessor" -} +{ + "$comment": "We explicitly specify the replacement strategy to be delete_then_create because we cannot create a new SP resource with the same name or same KVS input before deleting the old one", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/KmsKeyId", + "/properties/RoleArn", + "/properties/KinesisVideoStream", + "/properties/ConnectedHomeSettings", + "/properties/FaceSearchSettings", + "/properties/KinesisDataStream", + "/properties/S3Destination", + "/properties/NotificationChannel", + "/properties/BoundingBoxRegionsOfInterest", + "/properties/PolygonRegionsOfInterest", + "/properties/DataSharingPreference" + ], + "definitions": { + "Arn": { + "description": "The ARN of the stream processor", + "maxLength": 2048, + "type": "string" + }, + "BoundingBox": { + "additionalProperties": false, + "description": "A bounding box denoting a region of interest in the frame to be analyzed.", + "properties": { + "Height": { + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "Left": { + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "Top": { + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "Width": { + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "Height", + "Width", + "Left", + "Top" + ], + "type": "object" + }, + "ConnectedHomeSettings": { + "additionalProperties": false, + "description": "Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both", + "properties": { + "Labels": { + "$ref": "#/definitions/Labels" + }, + "MinConfidence": { + "description": "Minimum object class match confidence score that must be met to return a result for a recognized object.", + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "Labels" + ], + "type": "object" + }, + "DataSharingPreference": { + "additionalProperties": false, + "description": "Indicates whether Rekognition is allowed to store the video stream data for model-training.", + "properties": { + "OptIn": { + "description": "Flag to enable data-sharing", + "type": "boolean" + } + }, + "required": [ + "OptIn" + ], + "type": "object" + }, + "FaceSearchSettings": { + "additionalProperties": false, + "description": "Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both", + "properties": { + "CollectionId": { + "description": "The ID of a collection that contains faces that you want to search for.", + "maxLength": 255, + "pattern": "\\A[a-zA-Z0-9_\\.\\-]+$", + "type": "string" + }, + "FaceMatchThreshold": { + "description": "Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.", + "maximum": 100, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "CollectionId" + ], + "type": "object" + }, + "KinesisDataStream": { + "additionalProperties": false, + "description": "The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.", + "properties": { + "Arn": { + "description": "ARN of the Kinesis Data Stream stream.", + "maxLength": 2048, + "pattern": "(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "KinesisVideoStream": { + "additionalProperties": false, + "description": "The Kinesis Video Stream that streams the source video.", + "properties": { + "Arn": { + "description": "ARN of the Kinesis Video Stream that streams the source video.", + "maxLength": 2048, + "pattern": "(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)", + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "Labels": { + "description": "List of labels that need to be detected in the video stream. Current supported values are PERSON, PET, PACKAGE, ALL.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "NotificationChannel": { + "additionalProperties": false, + "description": "The ARN of the SNS notification channel where events of interests are published, as part of connected home feature.", + "properties": { + "Arn": { + "description": "ARN of the SNS topic.", + "maxLength": 2048, + "type": "string" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "Point": { + "additionalProperties": false, + "description": "An (X, Y) cartesian coordinate denoting a point on the frame", + "properties": { + "X": { + "description": "The X coordinate of the point.", + "type": "number" + }, + "Y": { + "description": "The Y coordinate of the point.", + "type": "number" + } + }, + "required": [ + "X", + "Y" + ], + "type": "object" + }, + "Polygon": { + "description": "A polygon showing a region of interest. Note that the ordering of the Point entries matter in defining the polygon", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Point" + }, + "minItems": 3, + "type": "array", + "uniqueItems": true + }, + "S3Destination": { + "additionalProperties": false, + "description": "The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.", + "properties": { + "BucketName": { + "description": "Name of the S3 bucket.", + "maxLength": 63, + "type": "string" + }, + "ObjectKeyPrefix": { + "description": "The object key prefix path where the results will be stored. Default is no prefix path", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.\n\n", + "handlers": { + "create": { + "permissions": [ + "rekognition:CreateStreamProcessor", + "iam:PassRole", + "rekognition:DescribeStreamProcessor", + "rekognition:ListTagsForResource", + "rekognition:TagResource" + ] + }, + "delete": { + "permissions": [ + "rekognition:DeleteStreamProcessor" + ] + }, + "list": { + "permissions": [ + "rekognition:ListStreamProcessors" + ] + }, + "read": { + "permissions": [ + "rekognition:DescribeStreamProcessor", + "rekognition:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rekognition:TagResource", + "rekognition:UntagResource", + "rekognition:ListTagsForResource", + "rekognition:DescribeStreamProcessor" + ] + } + }, + "oneOf": [ + { + "required": [ + "ConnectedHomeSettings", + "S3Destination", + "NotificationChannel" + ] + }, + { + "required": [ + "FaceSearchSettings", + "KinesisDataStream" + ] + } + ], + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "BoundingBoxRegionsOfInterest": { + "description": "The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/BoundingBox" + }, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ConnectedHomeSettings": { + "$ref": "#/definitions/ConnectedHomeSettings" + }, + "DataSharingPreference": { + "$ref": "#/definitions/DataSharingPreference" + }, + "FaceSearchSettings": { + "$ref": "#/definitions/FaceSearchSettings" + }, + "KinesisDataStream": { + "$ref": "#/definitions/KinesisDataStream" + }, + "KinesisVideoStream": { + "$ref": "#/definitions/KinesisVideoStream" + }, + "KmsKeyId": { + "description": "The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.", + "type": "string" + }, + "Name": { + "description": "Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.", + "maxLength": 128, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.\\-]+", + "type": "string" + }, + "NotificationChannel": { + "$ref": "#/definitions/NotificationChannel" + }, + "PolygonRegionsOfInterest": { + "description": "The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Polygon" + }, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "RoleArn": { + "description": "ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.", + "maxLength": 2048, + "pattern": "arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*", + "type": "string" + }, + "S3Destination": { + "$ref": "#/definitions/S3Destination" + }, + "Status": { + "description": "Current status of the stream processor.", + "type": "string" + }, + "StatusMessage": { + "description": "Detailed status message about the stream processor.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Status", + "/properties/StatusMessage" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "RoleArn", + "KinesisVideoStream" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "rekognition:TagResource", + "rekognition:UntagResource", + "rekognition:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Rekognition::StreamProcessor" +} diff --git a/schema/aws-resiliencehub-app.json b/schema/aws-resiliencehub-app.json index d4105b6..789528c 100644 --- a/schema/aws-resiliencehub-app.json +++ b/schema/aws-resiliencehub-app.json @@ -1,308 +1,308 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "EventSubscription": { - "additionalProperties": false, - "description": "Indicates an event you would like to subscribe and get notification for.", - "properties": { - "EventType": { - "description": "The type of event you would like to subscribe and get notification for.", - "enum": [ - "ScheduledAssessmentFailure", - "DriftDetected" - ], - "type": "string" - }, - "Name": { - "description": "Unique name to identify an event subscription.", - "maxLength": 256, - "type": "string" - }, - "SnsTopicArn": { - "description": "Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$", - "type": "string" - } - }, - "required": [ - "Name", - "EventType" - ], - "type": "object" - }, - "IamRoleArn": { - "pattern": "arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role\\/(([\\u0021-\\u007E]+\\u002F){1,511})?[A-Za-z0-9+=,.@_/-]{1,64}$", - "type": "string" - }, - "PermissionModel": { - "additionalProperties": false, - "description": "Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.", - "properties": { - "CrossAccountRoleArns": { - "description": "Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IamRoleArn" - }, - "type": "array", - "uniqueItems": false - }, - "InvokerRoleName": { - "description": "Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.", - "pattern": "((\\u002F[\\u0021-\\u007E]+\\u002F){1,511})?[A-Za-z0-9+=,.@_/-]{1,64}", - "type": "string" - }, - "Type": { - "description": "Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user.", - "enum": [ - "LegacyIAMUser", - "RoleBased" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "PhysicalResourceId": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "AwsRegion": { - "pattern": "^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$", - "type": "string" - }, - "Identifier": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Type": { - "pattern": "Arn|Native", - "type": "string" - } - }, - "required": [ - "Identifier", - "Type" - ], - "type": "object" - }, - "ResourceMapping": { - "additionalProperties": false, - "description": "Resource mapping is used to map logical resources from template to physical resource", - "properties": { - "EksSourceName": { - "type": "string" - }, - "LogicalStackName": { - "type": "string" - }, - "MappingType": { - "pattern": "CfnStack|Resource|Terraform|EKS", - "type": "string" - }, - "PhysicalResourceId": { - "$ref": "#/definitions/PhysicalResourceId" - }, - "ResourceName": { - "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "TerraformSourceName": { - "type": "string" - } - }, - "required": [ - "MappingType", - "PhysicalResourceId" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".{1,128}": { - "$ref": "#/definitions/TagValue" - } - }, - "type": "object" - }, - "TagValue": { - "maxLength": 256, - "type": "string" - } - }, - "description": "Resource Type Definition for AWS::ResilienceHub::App.", - "handlers": { - "create": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:ListStackResources", - "s3:GetBucketLocation", - "s3:GetObject", - "s3:ListAllMyBuckets", - "autoscaling:DescribeAutoScalingGroups", - "apigateway:GET", - "ec2:Describe*", - "ecs:DescribeServices", - "eks:DescribeCluster", - "elasticfilesystem:DescribeFileSystems", - "elasticloadbalancing:DescribeLoadBalancers", - "lambda:GetFunction*", - "rds:Describe*", - "dynamodb:Describe*", - "sqs:GetQueueAttributes", - "sns:GetTopicAttributes", - "route53:List*", - "iam:PassRole", - "resiliencehub:*" - ] - }, - "delete": { - "permissions": [ - "resiliencehub:DeleteApp", - "resiliencehub:UntagResource", - "resiliencehub:ListApps" - ] - }, - "list": { - "permissions": [ - "resiliencehub:ListApps" - ] - }, - "read": { - "permissions": [ - "resiliencehub:DescribeApp", - "resiliencehub:DescribeAppVersionTemplate", - "resiliencehub:ListAppVersionResourceMappings", - "resiliencehub:ListTagsForResource", - "resiliencehub:ListAppVersions" - ] - }, - "update": { - "permissions": [ - "cloudformation:DescribeStacks", - "cloudformation:ListStackResources", - "s3:GetBucketLocation", - "s3:GetObject", - "s3:ListAllMyBuckets", - "autoscaling:DescribeAutoScalingGroups", - "apigateway:GET", - "ec2:Describe*", - "ecs:DescribeServices", - "eks:DescribeCluster", - "elasticfilesystem:DescribeFileSystems", - "elasticloadbalancing:DescribeLoadBalancers", - "lambda:GetFunction*", - "rds:Describe*", - "dynamodb:Describe*", - "sqs:GetQueueAttributes", - "sns:GetTopicAttributes", - "route53:List*", - "iam:PassRole", - "resiliencehub:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppArn" - ], - "properties": { - "AppArn": { - "description": "Amazon Resource Name (ARN) of the App.", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "AppAssessmentSchedule": { - "description": "Assessment execution schedule.", - "enum": [ - "Disabled", - "Daily" - ], - "type": "string" - }, - "AppTemplateBody": { - "description": "A string containing full ResilienceHub app template body.", - "maxLength": 409600, - "minLength": 0, - "pattern": "^[\\w\\s:,-\\.'\\/{}\\[\\]:\"]+$", - "type": "string" - }, - "Description": { - "description": "App description.", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "DriftStatus": { - "description": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.", - "enum": [ - "NotChecked", - "NotDetected", - "Detected" - ], - "type": "string" - }, - "EventSubscriptions": { - "description": "The list of events you would like to subscribe and get notification for.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EventSubscription" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "description": "Name of the app.", - "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "PermissionModel": { - "$ref": "#/definitions/PermissionModel" - }, - "ResiliencyPolicyArn": { - "description": "Amazon Resource Name (ARN) of the Resiliency Policy.", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "ResourceMappings": { - "description": "An array of ResourceMapping objects.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceMapping" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "$ref": "#/definitions/TagMap" - } - }, - "readOnlyProperties": [ - "/properties/AppArn", - "/properties/DriftStatus" - ], - "required": [ - "Name", - "AppTemplateBody", - "ResourceMappings" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-resiliencehub", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ResilienceHub::App" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "EventSubscription": { + "additionalProperties": false, + "description": "Indicates an event you would like to subscribe and get notification for.", + "properties": { + "EventType": { + "description": "The type of event you would like to subscribe and get notification for.", + "enum": [ + "ScheduledAssessmentFailure", + "DriftDetected" + ], + "type": "string" + }, + "Name": { + "description": "Unique name to identify an event subscription.", + "maxLength": 256, + "type": "string" + }, + "SnsTopicArn": { + "description": "Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.", + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$", + "type": "string" + } + }, + "required": [ + "Name", + "EventType" + ], + "type": "object" + }, + "IamRoleArn": { + "pattern": "arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role\\/(([\\u0021-\\u007E]+\\u002F){1,511})?[A-Za-z0-9+=,.@_/-]{1,64}$", + "type": "string" + }, + "PermissionModel": { + "additionalProperties": false, + "description": "Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.", + "properties": { + "CrossAccountRoleArns": { + "description": "Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IamRoleArn" + }, + "type": "array", + "uniqueItems": false + }, + "InvokerRoleName": { + "description": "Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.", + "pattern": "((\\u002F[\\u0021-\\u007E]+\\u002F){1,511})?[A-Za-z0-9+=,.@_/-]{1,64}", + "type": "string" + }, + "Type": { + "description": "Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user.", + "enum": [ + "LegacyIAMUser", + "RoleBased" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "PhysicalResourceId": { + "additionalProperties": false, + "properties": { + "AwsAccountId": { + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "AwsRegion": { + "pattern": "^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$", + "type": "string" + }, + "Identifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Type": { + "pattern": "Arn|Native", + "type": "string" + } + }, + "required": [ + "Identifier", + "Type" + ], + "type": "object" + }, + "ResourceMapping": { + "additionalProperties": false, + "description": "Resource mapping is used to map logical resources from template to physical resource", + "properties": { + "EksSourceName": { + "type": "string" + }, + "LogicalStackName": { + "type": "string" + }, + "MappingType": { + "pattern": "CfnStack|Resource|Terraform|EKS", + "type": "string" + }, + "PhysicalResourceId": { + "$ref": "#/definitions/PhysicalResourceId" + }, + "ResourceName": { + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "TerraformSourceName": { + "type": "string" + } + }, + "required": [ + "MappingType", + "PhysicalResourceId" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".{1,128}": { + "$ref": "#/definitions/TagValue" + } + }, + "type": "object" + }, + "TagValue": { + "maxLength": 256, + "type": "string" + } + }, + "description": "Resource Type Definition for AWS::ResilienceHub::App.", + "handlers": { + "create": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:ListStackResources", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListAllMyBuckets", + "autoscaling:DescribeAutoScalingGroups", + "apigateway:GET", + "ec2:Describe*", + "ecs:DescribeServices", + "eks:DescribeCluster", + "elasticfilesystem:DescribeFileSystems", + "elasticloadbalancing:DescribeLoadBalancers", + "lambda:GetFunction*", + "rds:Describe*", + "dynamodb:Describe*", + "sqs:GetQueueAttributes", + "sns:GetTopicAttributes", + "route53:List*", + "iam:PassRole", + "resiliencehub:*" + ] + }, + "delete": { + "permissions": [ + "resiliencehub:DeleteApp", + "resiliencehub:UntagResource", + "resiliencehub:ListApps" + ] + }, + "list": { + "permissions": [ + "resiliencehub:ListApps" + ] + }, + "read": { + "permissions": [ + "resiliencehub:DescribeApp", + "resiliencehub:DescribeAppVersionTemplate", + "resiliencehub:ListAppVersionResourceMappings", + "resiliencehub:ListTagsForResource", + "resiliencehub:ListAppVersions" + ] + }, + "update": { + "permissions": [ + "cloudformation:DescribeStacks", + "cloudformation:ListStackResources", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListAllMyBuckets", + "autoscaling:DescribeAutoScalingGroups", + "apigateway:GET", + "ec2:Describe*", + "ecs:DescribeServices", + "eks:DescribeCluster", + "elasticfilesystem:DescribeFileSystems", + "elasticloadbalancing:DescribeLoadBalancers", + "lambda:GetFunction*", + "rds:Describe*", + "dynamodb:Describe*", + "sqs:GetQueueAttributes", + "sns:GetTopicAttributes", + "route53:List*", + "iam:PassRole", + "resiliencehub:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppArn" + ], + "properties": { + "AppArn": { + "description": "Amazon Resource Name (ARN) of the App.", + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "AppAssessmentSchedule": { + "description": "Assessment execution schedule.", + "enum": [ + "Disabled", + "Daily" + ], + "type": "string" + }, + "AppTemplateBody": { + "description": "A string containing full ResilienceHub app template body.", + "maxLength": 409600, + "minLength": 0, + "pattern": "^[\\w\\s:,-\\.'\\/{}\\[\\]:\"]+$", + "type": "string" + }, + "Description": { + "description": "App description.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "DriftStatus": { + "description": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application.", + "enum": [ + "NotChecked", + "NotDetected", + "Detected" + ], + "type": "string" + }, + "EventSubscriptions": { + "description": "The list of events you would like to subscribe and get notification for.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EventSubscription" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "description": "Name of the app.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "PermissionModel": { + "$ref": "#/definitions/PermissionModel" + }, + "ResiliencyPolicyArn": { + "description": "Amazon Resource Name (ARN) of the Resiliency Policy.", + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "ResourceMappings": { + "description": "An array of ResourceMapping objects.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceMapping" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "$ref": "#/definitions/TagMap" + } + }, + "readOnlyProperties": [ + "/properties/AppArn", + "/properties/DriftStatus" + ], + "required": [ + "Name", + "AppTemplateBody", + "ResourceMappings" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-resiliencehub", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ResilienceHub::App" +} diff --git a/schema/aws-resiliencehub-resiliencypolicy.json b/schema/aws-resiliencehub-resiliencypolicy.json index e31a80d..aec0a4c 100644 --- a/schema/aws-resiliencehub-resiliencypolicy.json +++ b/schema/aws-resiliencehub-resiliencypolicy.json @@ -1,159 +1,159 @@ -{ - "additionalProperties": false, - "definitions": { - "FailurePolicy": { - "additionalProperties": false, - "description": "Failure Policy.", - "properties": { - "RpoInSecs": { - "description": "RPO in seconds.", - "type": "integer" - }, - "RtoInSecs": { - "description": "RTO in seconds.", - "type": "integer" - } - }, - "required": [ - "RtoInSecs", - "RpoInSecs" - ], - "type": "object" - }, - "PolicyMap": { - "additionalProperties": false, - "properties": { - "AZ": { - "$ref": "#/definitions/FailurePolicy" - }, - "Hardware": { - "$ref": "#/definitions/FailurePolicy" - }, - "Region": { - "$ref": "#/definitions/FailurePolicy" - }, - "Software": { - "$ref": "#/definitions/FailurePolicy" - } - }, - "required": [ - "AZ", - "Hardware", - "Software" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".{1,128}": { - "$ref": "#/definitions/TagValue" - } - }, - "type": "object" - }, - "TagValue": { - "maxLength": 256, - "type": "string" - } - }, - "description": "Resource Type Definition for Resiliency Policy.", - "handlers": { - "create": { - "permissions": [ - "resiliencehub:CreateResiliencyPolicy", - "resiliencehub:DescribeResiliencyPolicy", - "resiliencehub:TagResource" - ] - }, - "delete": { - "permissions": [ - "resiliencehub:DeleteResiliencyPolicy", - "resiliencehub:UntagResource" - ] - }, - "list": { - "permissions": [ - "resiliencehub:ListResiliencyPolicies" - ] - }, - "read": { - "permissions": [ - "resiliencehub:DescribeResiliencyPolicy", - "resiliencehub:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "resiliencehub:DescribeResiliencyPolicy", - "resiliencehub:UpdateResiliencyPolicy", - "resiliencehub:TagResource", - "resiliencehub:UntagResource", - "resiliencehub:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyArn" - ], - "properties": { - "DataLocationConstraint": { - "description": "Data Location Constraint of the Policy.", - "enum": [ - "AnyLocation", - "SameContinent", - "SameCountry" - ], - "type": "string" - }, - "Policy": { - "$ref": "#/definitions/PolicyMap" - }, - "PolicyArn": { - "description": "Amazon Resource Name (ARN) of the Resiliency Policy.", - "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", - "type": "string" - }, - "PolicyDescription": { - "description": "Description of Resiliency Policy.", - "maxLength": 500, - "type": "string" - }, - "PolicyName": { - "description": "Name of Resiliency Policy.", - "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "Tier": { - "description": "Resiliency Policy Tier.", - "enum": [ - "MissionCritical", - "Critical", - "Important", - "CoreServices", - "NonCritical" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PolicyArn" - ], - "required": [ - "PolicyName", - "Tier", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-resiliencehub", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ResilienceHub::ResiliencyPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "FailurePolicy": { + "additionalProperties": false, + "description": "Failure Policy.", + "properties": { + "RpoInSecs": { + "description": "RPO in seconds.", + "type": "integer" + }, + "RtoInSecs": { + "description": "RTO in seconds.", + "type": "integer" + } + }, + "required": [ + "RtoInSecs", + "RpoInSecs" + ], + "type": "object" + }, + "PolicyMap": { + "additionalProperties": false, + "properties": { + "AZ": { + "$ref": "#/definitions/FailurePolicy" + }, + "Hardware": { + "$ref": "#/definitions/FailurePolicy" + }, + "Region": { + "$ref": "#/definitions/FailurePolicy" + }, + "Software": { + "$ref": "#/definitions/FailurePolicy" + } + }, + "required": [ + "AZ", + "Hardware", + "Software" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".{1,128}": { + "$ref": "#/definitions/TagValue" + } + }, + "type": "object" + }, + "TagValue": { + "maxLength": 256, + "type": "string" + } + }, + "description": "Resource Type Definition for Resiliency Policy.", + "handlers": { + "create": { + "permissions": [ + "resiliencehub:CreateResiliencyPolicy", + "resiliencehub:DescribeResiliencyPolicy", + "resiliencehub:TagResource" + ] + }, + "delete": { + "permissions": [ + "resiliencehub:DeleteResiliencyPolicy", + "resiliencehub:UntagResource" + ] + }, + "list": { + "permissions": [ + "resiliencehub:ListResiliencyPolicies" + ] + }, + "read": { + "permissions": [ + "resiliencehub:DescribeResiliencyPolicy", + "resiliencehub:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "resiliencehub:DescribeResiliencyPolicy", + "resiliencehub:UpdateResiliencyPolicy", + "resiliencehub:TagResource", + "resiliencehub:UntagResource", + "resiliencehub:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyArn" + ], + "properties": { + "DataLocationConstraint": { + "description": "Data Location Constraint of the Policy.", + "enum": [ + "AnyLocation", + "SameContinent", + "SameCountry" + ], + "type": "string" + }, + "Policy": { + "$ref": "#/definitions/PolicyMap" + }, + "PolicyArn": { + "description": "Amazon Resource Name (ARN) of the Resiliency Policy.", + "pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$", + "type": "string" + }, + "PolicyDescription": { + "description": "Description of Resiliency Policy.", + "maxLength": 500, + "type": "string" + }, + "PolicyName": { + "description": "Name of Resiliency Policy.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "Tier": { + "description": "Resiliency Policy Tier.", + "enum": [ + "MissionCritical", + "Critical", + "Important", + "CoreServices", + "NonCritical" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PolicyArn" + ], + "required": [ + "PolicyName", + "Tier", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-resiliencehub", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ResilienceHub::ResiliencyPolicy" +} diff --git a/schema/aws-resourceexplorer2-defaultviewassociation.json b/schema/aws-resourceexplorer2-defaultviewassociation.json index 5c41a50..7163f50 100644 --- a/schema/aws-resourceexplorer2-defaultviewassociation.json +++ b/schema/aws-resourceexplorer2-defaultviewassociation.json @@ -1,52 +1,52 @@ -{ - "additionalProperties": false, - "description": "Definition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type", - "handlers": { - "create": { - "permissions": [ - "resource-explorer-2:GetDefaultView", - "resource-explorer-2:AssociateDefaultView" - ] - }, - "delete": { - "permissions": [ - "resource-explorer-2:GetDefaultView", - "resource-explorer-2:DisassociateDefaultView" - ] - }, - "read": { - "permissions": [ - "resource-explorer-2:GetDefaultView" - ] - }, - "update": { - "permissions": [ - "resource-explorer-2:GetDefaultView", - "resource-explorer-2:AssociateDefaultView" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociatedAwsPrincipal" - ], - "properties": { - "AssociatedAwsPrincipal": { - "description": "The AWS principal that the default view is associated with, used as the unique identifier for this resource.", - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "ViewArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedAwsPrincipal" - ], - "required": [ - "ViewArn" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::ResourceExplorer2::DefaultViewAssociation" -} +{ + "additionalProperties": false, + "description": "Definition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type", + "handlers": { + "create": { + "permissions": [ + "resource-explorer-2:GetDefaultView", + "resource-explorer-2:AssociateDefaultView" + ] + }, + "delete": { + "permissions": [ + "resource-explorer-2:GetDefaultView", + "resource-explorer-2:DisassociateDefaultView" + ] + }, + "read": { + "permissions": [ + "resource-explorer-2:GetDefaultView" + ] + }, + "update": { + "permissions": [ + "resource-explorer-2:GetDefaultView", + "resource-explorer-2:AssociateDefaultView" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociatedAwsPrincipal" + ], + "properties": { + "AssociatedAwsPrincipal": { + "description": "The AWS principal that the default view is associated with, used as the unique identifier for this resource.", + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "ViewArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedAwsPrincipal" + ], + "required": [ + "ViewArn" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::ResourceExplorer2::DefaultViewAssociation" +} diff --git a/schema/aws-resourceexplorer2-index.json b/schema/aws-resourceexplorer2-index.json index 99ece59..694f27c 100644 --- a/schema/aws-resourceexplorer2-index.json +++ b/schema/aws-resourceexplorer2-index.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "definitions": { - "IndexState": { - "enum": [ - "ACTIVE", - "CREATING", - "DELETING", - "DELETED", - "UPDATING" - ], - "type": "string" - }, - "IndexType": { - "enum": [ - "LOCAL", - "AGGREGATOR" - ], - "type": "string" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::ResourceExplorer2::Index Resource Type", - "handlers": { - "create": { - "permissions": [ - "resource-explorer-2:CreateIndex", - "resource-explorer-2:GetIndex", - "resource-explorer-2:TagResource", - "resource-explorer-2:UpdateIndexType", - "resource-explorer-2:DeleteIndex", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "resource-explorer-2:DeleteIndex", - "resource-explorer-2:GetIndex", - "resource-explorer-2:UntagResource" - ] - }, - "list": { - "permissions": [ - "resource-explorer-2:ListIndexes" - ] - }, - "read": { - "permissions": [ - "resource-explorer-2:GetIndex" - ] - }, - "update": { - "permissions": [ - "resource-explorer-2:GetIndex", - "resource-explorer-2:UpdateIndexType", - "resource-explorer-2:TagResource", - "resource-explorer-2:UntagResource", - "resource-explorer-2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "type": "string" - }, - "IndexState": { - "$ref": "#/definitions/IndexState" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "Type": { - "$ref": "#/definitions/IndexType" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/IndexState" - ], - "required": [ - "Type" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ResourceExplorer2::Index" -} +{ + "additionalProperties": false, + "definitions": { + "IndexState": { + "enum": [ + "ACTIVE", + "CREATING", + "DELETING", + "DELETED", + "UPDATING" + ], + "type": "string" + }, + "IndexType": { + "enum": [ + "LOCAL", + "AGGREGATOR" + ], + "type": "string" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::ResourceExplorer2::Index Resource Type", + "handlers": { + "create": { + "permissions": [ + "resource-explorer-2:CreateIndex", + "resource-explorer-2:GetIndex", + "resource-explorer-2:TagResource", + "resource-explorer-2:UpdateIndexType", + "resource-explorer-2:DeleteIndex", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "resource-explorer-2:DeleteIndex", + "resource-explorer-2:GetIndex", + "resource-explorer-2:UntagResource" + ] + }, + "list": { + "permissions": [ + "resource-explorer-2:ListIndexes" + ] + }, + "read": { + "permissions": [ + "resource-explorer-2:GetIndex" + ] + }, + "update": { + "permissions": [ + "resource-explorer-2:GetIndex", + "resource-explorer-2:UpdateIndexType", + "resource-explorer-2:TagResource", + "resource-explorer-2:UntagResource", + "resource-explorer-2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "type": "string" + }, + "IndexState": { + "$ref": "#/definitions/IndexState" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "Type": { + "$ref": "#/definitions/IndexType" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/IndexState" + ], + "required": [ + "Type" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ResourceExplorer2::Index" +} diff --git a/schema/aws-resourceexplorer2-view.json b/schema/aws-resourceexplorer2-view.json index 26e8c39..fca8a89 100644 --- a/schema/aws-resourceexplorer2-view.json +++ b/schema/aws-resourceexplorer2-view.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Scope", - "/properties/ViewName" - ], - "definitions": { - "IncludedProperty": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 1011, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SearchFilter": { - "additionalProperties": false, - "properties": { - "FilterString": { - "maxLength": 2048, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "FilterString" - ], - "type": "object" - }, - "TagMap": { - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Definition of AWS::ResourceExplorer2::View Resource Type", - "handlers": { - "create": { - "permissions": [ - "resource-explorer-2:CreateView", - "resource-explorer-2:TagResource" - ] - }, - "delete": { - "permissions": [ - "resource-explorer-2:DeleteView", - "resource-explorer-2:GetView", - "resource-explorer-2:UntagResource" - ] - }, - "list": { - "permissions": [ - "resource-explorer-2:ListViews" - ] - }, - "read": { - "permissions": [ - "resource-explorer-2:GetView" - ] - }, - "update": { - "permissions": [ - "resource-explorer-2:UpdateView", - "resource-explorer-2:TagResource", - "resource-explorer-2:UntagResource", - "resource-explorer-2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ViewArn" - ], - "properties": { - "Filters": { - "$ref": "#/definitions/SearchFilter" - }, - "IncludedProperties": { - "items": { - "$ref": "#/definitions/IncludedProperty" - }, - "type": "array" - }, - "Scope": { - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagMap" - }, - "ViewArn": { - "type": "string" - }, - "ViewName": { - "pattern": "^[a-zA-Z0-9\\-]{1,64}$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ViewArn" - ], - "required": [ - "ViewName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ResourceExplorer2::View" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Scope", + "/properties/ViewName" + ], + "definitions": { + "IncludedProperty": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 1011, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SearchFilter": { + "additionalProperties": false, + "properties": { + "FilterString": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "FilterString" + ], + "type": "object" + }, + "TagMap": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::ResourceExplorer2::View Resource Type", + "handlers": { + "create": { + "permissions": [ + "resource-explorer-2:CreateView", + "resource-explorer-2:TagResource" + ] + }, + "delete": { + "permissions": [ + "resource-explorer-2:DeleteView", + "resource-explorer-2:GetView", + "resource-explorer-2:UntagResource" + ] + }, + "list": { + "permissions": [ + "resource-explorer-2:ListViews" + ] + }, + "read": { + "permissions": [ + "resource-explorer-2:GetView" + ] + }, + "update": { + "permissions": [ + "resource-explorer-2:UpdateView", + "resource-explorer-2:TagResource", + "resource-explorer-2:UntagResource", + "resource-explorer-2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ViewArn" + ], + "properties": { + "Filters": { + "$ref": "#/definitions/SearchFilter" + }, + "IncludedProperties": { + "items": { + "$ref": "#/definitions/IncludedProperty" + }, + "type": "array" + }, + "Scope": { + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagMap" + }, + "ViewArn": { + "type": "string" + }, + "ViewName": { + "pattern": "^[a-zA-Z0-9\\-]{1,64}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ViewArn" + ], + "required": [ + "ViewName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ResourceExplorer2::View" +} diff --git a/schema/aws-resourcegroups-group.json b/schema/aws-resourcegroups-group.json index 31a7592..05b97d0 100644 --- a/schema/aws-resourcegroups-group.json +++ b/schema/aws-resourcegroups-group.json @@ -1,213 +1,213 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Configuration": { - "items": { - "$ref": "#/definitions/ConfigurationItem" - }, - "type": "array" - }, - "ConfigurationItem": { - "additionalProperties": false, - "properties": { - "Parameters": { - "items": { - "$ref": "#/definitions/ConfigurationParameter" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "ConfigurationParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Query": { - "additionalProperties": false, - "properties": { - "ResourceTypeFilters": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StackIdentifier": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "ResourceQuery": { - "additionalProperties": false, - "properties": { - "Query": { - "$ref": "#/definitions/Query" - }, - "Type": { - "enum": [ - "TAG_FILTERS_1_0", - "CLOUDFORMATION_STACK_1_0" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "pattern": "^(?!aws:).+", - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "description": "Schema for ResourceGroups::Group", - "handlers": { - "create": { - "permissions": [ - "resource-groups:CreateGroup", - "resource-groups:Tag", - "cloudformation:DescribeStacks", - "cloudformation:ListStackResources", - "resource-groups:ListGroupResources", - "resource-groups:GroupResources" - ] - }, - "delete": { - "permissions": [ - "resource-groups:DeleteGroup", - "resource-groups:UnGroupResources" - ] - }, - "list": { - "permissions": [ - "resource-groups:ListGroups" - ] - }, - "read": { - "permissions": [ - "resource-groups:GetGroup", - "resource-groups:GetGroupQuery", - "resource-groups:GetTags", - "resource-groups:GetGroupConfiguration", - "resource-groups:ListGroupResources" - ] - }, - "update": { - "permissions": [ - "resource-groups:UpdateGroup", - "resource-groups:GetTags", - "resource-groups:GetGroupQuery", - "resource-groups:UpdateGroupQuery", - "resource-groups:Tag", - "resource-groups:Untag", - "resource-groups:PutGroupConfiguration", - "resource-groups:GetGroupConfiguration", - "resource-groups:ListGroupResources", - "resource-groups:GroupResources", - "resource-groups:UnGroupResources" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Resource Group ARN.", - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/Configuration" - }, - "Description": { - "description": "The description of the resource group", - "maxLength": 512, - "type": "string" - }, - "Name": { - "description": "The name of the resource group", - "maxLength": 128, - "type": "string" - }, - "ResourceQuery": { - "$ref": "#/definitions/ResourceQuery" - }, - "Resources": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "resource-groups:Tag", - "resource-groups:Untag" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ResourceGroups::Group" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Configuration": { + "items": { + "$ref": "#/definitions/ConfigurationItem" + }, + "type": "array" + }, + "ConfigurationItem": { + "additionalProperties": false, + "properties": { + "Parameters": { + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "type": "array" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "ConfigurationParameter": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Query": { + "additionalProperties": false, + "properties": { + "ResourceTypeFilters": { + "items": { + "type": "string" + }, + "type": "array" + }, + "StackIdentifier": { + "type": "string" + }, + "TagFilters": { + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourceQuery": { + "additionalProperties": false, + "properties": { + "Query": { + "$ref": "#/definitions/Query" + }, + "Type": { + "enum": [ + "TAG_FILTERS_1_0", + "CLOUDFORMATION_STACK_1_0" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "pattern": "^(?!aws:).+", + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" + }, + "TagFilter": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Schema for ResourceGroups::Group", + "handlers": { + "create": { + "permissions": [ + "resource-groups:CreateGroup", + "resource-groups:Tag", + "cloudformation:DescribeStacks", + "cloudformation:ListStackResources", + "resource-groups:ListGroupResources", + "resource-groups:GroupResources" + ] + }, + "delete": { + "permissions": [ + "resource-groups:DeleteGroup", + "resource-groups:UnGroupResources" + ] + }, + "list": { + "permissions": [ + "resource-groups:ListGroups" + ] + }, + "read": { + "permissions": [ + "resource-groups:GetGroup", + "resource-groups:GetGroupQuery", + "resource-groups:GetTags", + "resource-groups:GetGroupConfiguration", + "resource-groups:ListGroupResources" + ] + }, + "update": { + "permissions": [ + "resource-groups:UpdateGroup", + "resource-groups:GetTags", + "resource-groups:GetGroupQuery", + "resource-groups:UpdateGroupQuery", + "resource-groups:Tag", + "resource-groups:Untag", + "resource-groups:PutGroupConfiguration", + "resource-groups:GetGroupConfiguration", + "resource-groups:ListGroupResources", + "resource-groups:GroupResources", + "resource-groups:UnGroupResources" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Resource Group ARN.", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/Configuration" + }, + "Description": { + "description": "The description of the resource group", + "maxLength": 512, + "type": "string" + }, + "Name": { + "description": "The name of the resource group", + "maxLength": 128, + "type": "string" + }, + "ResourceQuery": { + "$ref": "#/definitions/ResourceQuery" + }, + "Resources": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "resource-groups:Tag", + "resource-groups:Untag" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ResourceGroups::Group" +} diff --git a/schema/aws-robomaker-fleet.json b/schema/aws-robomaker-fleet.json index 460455f..0de35ff 100644 --- a/schema/aws-robomaker-fleet.json +++ b/schema/aws-robomaker-fleet.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateFleet" - ] - }, - "delete": { - "permissions": [ - "robomaker:DeleteFleet" - ] - }, - "list": { - "permissions": [ - "robomaker:ListFleets" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeFleet" - ] - }, - "update": { - "permissions": [ - "robomaker:TagResource", - "robomaker:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "Name": { - "description": "The name of the fleet.", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\-]{1,255}$", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-robomaker.git", - "typeName": "AWS::RoboMaker::Fleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9-]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateFleet" + ] + }, + "delete": { + "permissions": [ + "robomaker:DeleteFleet" + ] + }, + "list": { + "permissions": [ + "robomaker:ListFleets" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeFleet" + ] + }, + "update": { + "permissions": [ + "robomaker:TagResource", + "robomaker:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "Name": { + "description": "The name of the fleet.", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\-]{1,255}$", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-robomaker.git", + "typeName": "AWS::RoboMaker::Fleet" +} diff --git a/schema/aws-robomaker-robot.json b/schema/aws-robomaker-robot.json index 4ab93ec..774cc3a 100644 --- a/schema/aws-robomaker-robot.json +++ b/schema/aws-robomaker-robot.json @@ -1,107 +1,107 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/GreengrassGroupId", - "/properties/Name", - "/properties/Architecture", - "/properties/Fleet" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "AWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateRobot", - "robomaker:RegisterRobot" - ] - }, - "delete": { - "permissions": [ - "robomaker:DescribeRobot", - "robomaker:DeleteRobot", - "robomaker:DeregisterRobot" - ] - }, - "list": { - "permissions": [ - "robomaker:ListRobots" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeRobot" - ] - }, - "update": { - "permissions": [ - "robomaker:TagResource", - "robomaker:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Architecture": { - "description": "The target architecture of the robot.", - "enum": [ - "X86_64", - "ARM64", - "ARMHF" - ], - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "Fleet": { - "description": "The Amazon Resource Name (ARN) of the fleet.", - "maxLength": 1224, - "minLength": 1, - "type": "string" - }, - "GreengrassGroupId": { - "description": "The Greengrass group id.", - "maxLength": 1224, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name for the robot.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "GreengrassGroupId", - "Architecture" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-robomaker.git", - "typeName": "AWS::RoboMaker::Robot" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GreengrassGroupId", + "/properties/Name", + "/properties/Architecture", + "/properties/Fleet" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9-]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "AWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateRobot", + "robomaker:RegisterRobot" + ] + }, + "delete": { + "permissions": [ + "robomaker:DescribeRobot", + "robomaker:DeleteRobot", + "robomaker:DeregisterRobot" + ] + }, + "list": { + "permissions": [ + "robomaker:ListRobots" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeRobot" + ] + }, + "update": { + "permissions": [ + "robomaker:TagResource", + "robomaker:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Architecture": { + "description": "The target architecture of the robot.", + "enum": [ + "X86_64", + "ARM64", + "ARMHF" + ], + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "Fleet": { + "description": "The Amazon Resource Name (ARN) of the fleet.", + "maxLength": 1224, + "minLength": 1, + "type": "string" + }, + "GreengrassGroupId": { + "description": "The Greengrass group id.", + "maxLength": 1224, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name for the robot.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "GreengrassGroupId", + "Architecture" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-robomaker.git", + "typeName": "AWS::RoboMaker::Robot" +} diff --git a/schema/aws-robomaker-robotapplication.json b/schema/aws-robomaker-robotapplication.json index 4c54f84..a1af34a 100644 --- a/schema/aws-robomaker-robotapplication.json +++ b/schema/aws-robomaker-robotapplication.json @@ -1,175 +1,175 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - }, - "RobotSoftwareSuite": { - "additionalProperties": false, - "description": "The robot software suite used by the robot application.", - "properties": { - "Name": { - "description": "The name of robot software suite.", - "enum": [ - "ROS", - "ROS2", - "General" - ], - "type": "string" - }, - "Version": { - "description": "The version of robot software suite.", - "enum": [ - "Kinetic", - "Melodic", - "Dashing" - ], - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SourceConfig": { - "additionalProperties": false, - "properties": { - "Architecture": { - "description": "The architecture of robot application.", - "enum": [ - "X86_64", - "ARM64", - "ARMHF" - ], - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "S3Bucket": { - "description": "The Arn of the S3Bucket that stores the robot application source.", - "type": "string" - }, - "S3Key": { - "description": "The s3 key of robot application source.", - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key", - "Architecture" - ], - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "This schema is for testing purpose only.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateRobotApplication", - "robomaker:TagResource", - "robomaker:UntagResource", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken", - "sts:GetServiceBearerToken" - ] - }, - "delete": { - "permissions": [ - "robomaker:DescribeRobotApplication", - "robomaker:DeleteRobotApplication" - ] - }, - "list": { - "permissions": [ - "robomaker:ListRobotApplications" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeRobotApplication" - ] - }, - "update": { - "permissions": [ - "robomaker:TagResource", - "robomaker:UntagResource", - "robomaker:UpdateRobotApplication", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CurrentRevisionId": { - "description": "The revision ID of robot application.", - "maxLength": 40, - "minLength": 1, - "type": "string" - }, - "Environment": { - "description": "The URI of the Docker image for the robot application.", - "type": "string" - }, - "Name": { - "description": "The name of the robot application.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RobotSoftwareSuite": { - "$ref": "#/definitions/RobotSoftwareSuite" - }, - "Sources": { - "description": "The sources of the robot application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SourceConfig" - }, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "RobotSoftwareSuite" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::RoboMaker::RobotApplication", - "writeOnlyProperties": [ - "/properties/RobotSoftwareSuite/Version", - "/properties/Sources" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + }, + "RobotSoftwareSuite": { + "additionalProperties": false, + "description": "The robot software suite used by the robot application.", + "properties": { + "Name": { + "description": "The name of robot software suite.", + "enum": [ + "ROS", + "ROS2", + "General" + ], + "type": "string" + }, + "Version": { + "description": "The version of robot software suite.", + "enum": [ + "Kinetic", + "Melodic", + "Dashing" + ], + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SourceConfig": { + "additionalProperties": false, + "properties": { + "Architecture": { + "description": "The architecture of robot application.", + "enum": [ + "X86_64", + "ARM64", + "ARMHF" + ], + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "S3Bucket": { + "description": "The Arn of the S3Bucket that stores the robot application source.", + "type": "string" + }, + "S3Key": { + "description": "The s3 key of robot application source.", + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key", + "Architecture" + ], + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9-]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "This schema is for testing purpose only.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateRobotApplication", + "robomaker:TagResource", + "robomaker:UntagResource", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" + ] + }, + "delete": { + "permissions": [ + "robomaker:DescribeRobotApplication", + "robomaker:DeleteRobotApplication" + ] + }, + "list": { + "permissions": [ + "robomaker:ListRobotApplications" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeRobotApplication" + ] + }, + "update": { + "permissions": [ + "robomaker:TagResource", + "robomaker:UntagResource", + "robomaker:UpdateRobotApplication", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CurrentRevisionId": { + "description": "The revision ID of robot application.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "Environment": { + "description": "The URI of the Docker image for the robot application.", + "type": "string" + }, + "Name": { + "description": "The name of the robot application.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RobotSoftwareSuite": { + "$ref": "#/definitions/RobotSoftwareSuite" + }, + "Sources": { + "description": "The sources of the robot application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SourceConfig" + }, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "RobotSoftwareSuite" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::RoboMaker::RobotApplication", + "writeOnlyProperties": [ + "/properties/RobotSoftwareSuite/Version", + "/properties/Sources" + ] +} diff --git a/schema/aws-robomaker-robotapplicationversion.json b/schema/aws-robomaker-robotapplicationversion.json index dee6b54..912ff6c 100644 --- a/schema/aws-robomaker-robotapplicationversion.json +++ b/schema/aws-robomaker-robotapplicationversion.json @@ -1,69 +1,69 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Application", - "/properties/CurrentRevisionId" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - } - }, - "description": "AWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateRobotApplicationVersion", - "s3:GetObject", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken", - "sts:GetServiceBearerToken" - ] - }, - "delete": { - "permissions": [ - "robomaker:DeleteRobotApplication", - "robomaker:DescribeRobotApplication" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeRobotApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Application": { - "$ref": "#/definitions/Arn" - }, - "ApplicationVersion": { - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CurrentRevisionId": { - "description": "The revision ID of robot application.", - "maxLength": 40, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.\\-]*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationVersion", - "/properties/Arn" - ], - "required": [ - "Application" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": false, - "typeName": "AWS::RoboMaker::RobotApplicationVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Application", + "/properties/CurrentRevisionId" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + } + }, + "description": "AWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateRobotApplicationVersion", + "s3:GetObject", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" + ] + }, + "delete": { + "permissions": [ + "robomaker:DeleteRobotApplication", + "robomaker:DescribeRobotApplication" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeRobotApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Application": { + "$ref": "#/definitions/Arn" + }, + "ApplicationVersion": { + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CurrentRevisionId": { + "description": "The revision ID of robot application.", + "maxLength": 40, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.\\-]*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationVersion", + "/properties/Arn" + ], + "required": [ + "Application" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": false, + "typeName": "AWS::RoboMaker::RobotApplicationVersion" +} diff --git a/schema/aws-robomaker-simulationapplication.json b/schema/aws-robomaker-simulationapplication.json index 54771fb..8ef8043 100644 --- a/schema/aws-robomaker-simulationapplication.json +++ b/schema/aws-robomaker-simulationapplication.json @@ -1,244 +1,244 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - }, - "RenderingEngine": { - "additionalProperties": false, - "description": "Information about a rendering engine.", - "properties": { - "Name": { - "description": "The name of the rendering engine.", - "enum": [ - "OGRE" - ], - "type": "string" - }, - "Version": { - "description": "The version of the rendering engine.", - "pattern": "1.x", - "type": "string" - } - }, - "required": [ - "Name", - "Version" - ], - "type": "object" - }, - "RobotSoftwareSuite": { - "additionalProperties": false, - "description": "Information about a robot software suite.", - "properties": { - "Name": { - "description": "The name of the robot software suite.", - "enum": [ - "ROS", - "ROS2", - "General" - ], - "type": "string" - }, - "Version": { - "description": "The version of the robot software suite.", - "enum": [ - "Kinetic", - "Melodic", - "Dashing", - "Foxy" - ], - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SimulationSoftwareSuite": { - "additionalProperties": false, - "description": "Information about a simulation software suite.", - "properties": { - "Name": { - "description": "The name of the simulation software suite.", - "enum": [ - "Gazebo", - "RosbagPlay", - "SimulationRuntime" - ], - "type": "string" - }, - "Version": { - "description": "The version of the simulation software suite.", - "enum": [ - "7", - "9", - "11", - "Kinetic", - "Melodic", - "Dashing", - "Foxy" - ], - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SourceConfig": { - "additionalProperties": false, - "description": "Information about a source configuration.", - "properties": { - "Architecture": { - "description": "The target processor architecture for the application.", - "enum": [ - "X86_64", - "ARM64", - "ARMHF" - ], - "type": "string" - }, - "S3Bucket": { - "description": "The Amazon S3 bucket name.", - "pattern": "[a-z0-9][a-z0-9.\\-]*[a-z0-9]", - "type": "string" - }, - "S3Key": { - "description": "The s3 object key.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key", - "Architecture" - ], - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "This schema is for testing purpose only.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateSimulationApplication", - "robomaker:TagResource", - "robomaker:UntagResource", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken", - "sts:GetServiceBearerToken" - ] - }, - "delete": { - "permissions": [ - "robomaker:DescribeSimulationApplication", - "robomaker:DeleteSimulationApplication" - ] - }, - "list": { - "permissions": [ - "robomaker:ListSimulationApplications" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeSimulationApplication" - ] - }, - "update": { - "permissions": [ - "robomaker:TagResource", - "robomaker:UntagResource", - "robomaker:UpdateSimulationApplication", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CurrentRevisionId": { - "description": "The current revision id.", - "type": "string" - }, - "Environment": { - "description": "The URI of the Docker image for the robot application.", - "type": "string" - }, - "Name": { - "description": "The name of the simulation application.", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\-]*", - "type": "string" - }, - "RenderingEngine": { - "$ref": "#/definitions/RenderingEngine", - "description": "The rendering engine for the simulation application." - }, - "RobotSoftwareSuite": { - "$ref": "#/definitions/RobotSoftwareSuite", - "description": "The robot software suite used by the simulation application." - }, - "SimulationSoftwareSuite": { - "$ref": "#/definitions/SimulationSoftwareSuite", - "description": "The simulation software suite used by the simulation application." - }, - "Sources": { - "description": "The sources of the simulation application.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SourceConfig" - }, - "type": "array" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "RobotSoftwareSuite", - "SimulationSoftwareSuite" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::RoboMaker::SimulationApplication", - "writeOnlyProperties": [ - "/properties/RenderingEngine", - "/properties/RobotSoftwareSuite/Version", - "/properties/Sources", - "/properties/SimulationSoftwareSuite/Version" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + }, + "RenderingEngine": { + "additionalProperties": false, + "description": "Information about a rendering engine.", + "properties": { + "Name": { + "description": "The name of the rendering engine.", + "enum": [ + "OGRE" + ], + "type": "string" + }, + "Version": { + "description": "The version of the rendering engine.", + "pattern": "1.x", + "type": "string" + } + }, + "required": [ + "Name", + "Version" + ], + "type": "object" + }, + "RobotSoftwareSuite": { + "additionalProperties": false, + "description": "Information about a robot software suite.", + "properties": { + "Name": { + "description": "The name of the robot software suite.", + "enum": [ + "ROS", + "ROS2", + "General" + ], + "type": "string" + }, + "Version": { + "description": "The version of the robot software suite.", + "enum": [ + "Kinetic", + "Melodic", + "Dashing", + "Foxy" + ], + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SimulationSoftwareSuite": { + "additionalProperties": false, + "description": "Information about a simulation software suite.", + "properties": { + "Name": { + "description": "The name of the simulation software suite.", + "enum": [ + "Gazebo", + "RosbagPlay", + "SimulationRuntime" + ], + "type": "string" + }, + "Version": { + "description": "The version of the simulation software suite.", + "enum": [ + "7", + "9", + "11", + "Kinetic", + "Melodic", + "Dashing", + "Foxy" + ], + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SourceConfig": { + "additionalProperties": false, + "description": "Information about a source configuration.", + "properties": { + "Architecture": { + "description": "The target processor architecture for the application.", + "enum": [ + "X86_64", + "ARM64", + "ARMHF" + ], + "type": "string" + }, + "S3Bucket": { + "description": "The Amazon S3 bucket name.", + "pattern": "[a-z0-9][a-z0-9.\\-]*[a-z0-9]", + "type": "string" + }, + "S3Key": { + "description": "The s3 object key.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "S3Bucket", + "S3Key", + "Architecture" + ], + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9-]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "This schema is for testing purpose only.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateSimulationApplication", + "robomaker:TagResource", + "robomaker:UntagResource", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" + ] + }, + "delete": { + "permissions": [ + "robomaker:DescribeSimulationApplication", + "robomaker:DeleteSimulationApplication" + ] + }, + "list": { + "permissions": [ + "robomaker:ListSimulationApplications" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeSimulationApplication" + ] + }, + "update": { + "permissions": [ + "robomaker:TagResource", + "robomaker:UntagResource", + "robomaker:UpdateSimulationApplication", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CurrentRevisionId": { + "description": "The current revision id.", + "type": "string" + }, + "Environment": { + "description": "The URI of the Docker image for the robot application.", + "type": "string" + }, + "Name": { + "description": "The name of the simulation application.", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\-]*", + "type": "string" + }, + "RenderingEngine": { + "$ref": "#/definitions/RenderingEngine", + "description": "The rendering engine for the simulation application." + }, + "RobotSoftwareSuite": { + "$ref": "#/definitions/RobotSoftwareSuite", + "description": "The robot software suite used by the simulation application." + }, + "SimulationSoftwareSuite": { + "$ref": "#/definitions/SimulationSoftwareSuite", + "description": "The simulation software suite used by the simulation application." + }, + "Sources": { + "description": "The sources of the simulation application.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SourceConfig" + }, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "RobotSoftwareSuite", + "SimulationSoftwareSuite" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::RoboMaker::SimulationApplication", + "writeOnlyProperties": [ + "/properties/RenderingEngine", + "/properties/RobotSoftwareSuite/Version", + "/properties/Sources", + "/properties/SimulationSoftwareSuite/Version" + ] +} diff --git a/schema/aws-robomaker-simulationapplicationversion.json b/schema/aws-robomaker-simulationapplicationversion.json index 05b37cb..effe401 100644 --- a/schema/aws-robomaker-simulationapplicationversion.json +++ b/schema/aws-robomaker-simulationapplicationversion.json @@ -1,69 +1,69 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Application", - "/properties/CurrentRevisionId" - ], - "definitions": { - "Arn": { - "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", - "type": "string" - } - }, - "description": "AWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses.", - "handlers": { - "create": { - "permissions": [ - "robomaker:CreateSimulationApplicationVersion", - "s3:GetObject", - "ecr:BatchGetImage", - "ecr:GetAuthorizationToken", - "ecr:BatchCheckLayerAvailability", - "ecr-public:GetAuthorizationToken", - "sts:GetServiceBearerToken" - ] - }, - "delete": { - "permissions": [ - "robomaker:DeleteSimulationApplication", - "robomaker:DescribeSimulationApplication" - ] - }, - "read": { - "permissions": [ - "robomaker:DescribeSimulationApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Application": { - "$ref": "#/definitions/Arn" - }, - "ApplicationVersion": { - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn" - }, - "CurrentRevisionId": { - "description": "The revision ID of robot application.", - "maxLength": 40, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.\\-]*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationVersion", - "/properties/Arn" - ], - "required": [ - "Application" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": false, - "typeName": "AWS::RoboMaker::SimulationApplicationVersion" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Application", + "/properties/CurrentRevisionId" + ], + "definitions": { + "Arn": { + "pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*", + "type": "string" + } + }, + "description": "AWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses.", + "handlers": { + "create": { + "permissions": [ + "robomaker:CreateSimulationApplicationVersion", + "s3:GetObject", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" + ] + }, + "delete": { + "permissions": [ + "robomaker:DeleteSimulationApplication", + "robomaker:DescribeSimulationApplication" + ] + }, + "read": { + "permissions": [ + "robomaker:DescribeSimulationApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Application": { + "$ref": "#/definitions/Arn" + }, + "ApplicationVersion": { + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn" + }, + "CurrentRevisionId": { + "description": "The revision ID of robot application.", + "maxLength": 40, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.\\-]*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationVersion", + "/properties/Arn" + ], + "required": [ + "Application" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "taggable": false, + "typeName": "AWS::RoboMaker::SimulationApplicationVersion" +} diff --git a/schema/aws-rolesanywhere-crl.json b/schema/aws-rolesanywhere-crl.json index 153de6a..90343fe 100644 --- a/schema/aws-rolesanywhere-crl.json +++ b/schema/aws-rolesanywhere-crl.json @@ -1,107 +1,107 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RolesAnywhere::CRL Resource Type", - "handlers": { - "create": { - "permissions": [ - "rolesanywhere:ImportCrl", - "rolesanywhere:TagResource", - "rolesanywhere:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "rolesanywhere:DeleteCrl" - ] - }, - "list": { - "permissions": [ - "rolesanywhere:ListCrls", - "rolesanywhere:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "rolesanywhere:GetCrl", - "rolesanywhere:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "rolesanywhere:EnableCrl", - "rolesanywhere:DisableCrl", - "rolesanywhere:UpdateCrl", - "rolesanywhere:TagResource", - "rolesanywhere:UntagResource", - "rolesanywhere:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CrlId" - ], - "properties": { - "CrlData": { - "type": "string" - }, - "CrlId": { - "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrustAnchorArn": { - "pattern": "^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:trust-anchor.*)$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/CrlId" - ], - "required": [ - "Name", - "CrlData" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RolesAnywhere::CRL" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RolesAnywhere::CRL Resource Type", + "handlers": { + "create": { + "permissions": [ + "rolesanywhere:ImportCrl", + "rolesanywhere:TagResource", + "rolesanywhere:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "rolesanywhere:DeleteCrl" + ] + }, + "list": { + "permissions": [ + "rolesanywhere:ListCrls", + "rolesanywhere:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "rolesanywhere:GetCrl", + "rolesanywhere:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "rolesanywhere:EnableCrl", + "rolesanywhere:DisableCrl", + "rolesanywhere:UpdateCrl", + "rolesanywhere:TagResource", + "rolesanywhere:UntagResource", + "rolesanywhere:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CrlId" + ], + "properties": { + "CrlData": { + "type": "string" + }, + "CrlId": { + "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", + "type": "string" + }, + "Enabled": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrustAnchorArn": { + "pattern": "^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:trust-anchor.*)$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CrlId" + ], + "required": [ + "Name", + "CrlData" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RolesAnywhere::CRL" +} diff --git a/schema/aws-rolesanywhere-profile.json b/schema/aws-rolesanywhere-profile.json index c1ed12b..7e9379f 100644 --- a/schema/aws-rolesanywhere-profile.json +++ b/schema/aws-rolesanywhere-profile.json @@ -1,185 +1,188 @@ -{ - "additionalProperties": false, - "definitions": { - "AttributeMapping": { - "additionalProperties": false, - "properties": { - "CertificateField": { - "$ref": "#/definitions/CertificateField" - }, - "MappingRules": { - "items": { - "$ref": "#/definitions/MappingRule" - }, - "type": "array" - } - }, - "required": [ - "CertificateField", - "MappingRules" - ], - "type": "object" - }, - "CertificateField": { - "enum": [ - "x509Subject", - "x509Issuer", - "x509SAN" - ], - "type": "string" - }, - "MappingRule": { - "additionalProperties": false, - "properties": { - "Specifier": { - "type": "string" - } - }, - "required": [ - "Specifier" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::RolesAnywhere::Profile Resource Type", - "handlers": { - "create": { - "permissions": [ - "iam:GetRole", - "iam:GetPolicy", - "iam:PassRole", - "rolesanywhere:CreateProfile", - "rolesanywhere:TagResource", - "rolesanywhere:ListTagsForResource", - "rolesanywhere:PutAttributeMapping", - "rolesanywhere:DeleteAttributeMapping" - ] - }, - "delete": { - "permissions": [ - "rolesanywhere:DeleteProfile" - ] - }, - "list": { - "permissions": [ - "rolesanywhere:ListProfiles", - "rolesanywhere:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "rolesanywhere:GetProfile", - "rolesanywhere:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "iam:GetRole", - "iam:GetPolicy", - "iam:PassRole", - "rolesanywhere:GetProfile", - "rolesanywhere:UpdateProfile", - "rolesanywhere:EnableProfile", - "rolesanywhere:DisableProfile", - "rolesanywhere:TagResource", - "rolesanywhere:UntagResource", - "rolesanywhere:ListTagsForResource", - "rolesanywhere:PutAttributeMapping", - "rolesanywhere:DeleteAttributeMapping" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProfileId" - ], - "properties": { - "AttributeMappings": { - "items": { - "$ref": "#/definitions/AttributeMapping" - }, - "type": "array" - }, - "DurationSeconds": { - "maximum": 43200, - "minimum": 900, - "type": "number" - }, - "Enabled": { - "type": "boolean" - }, - "ManagedPolicyArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "ProfileArn": { - "type": "string" - }, - "ProfileId": { - "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", - "type": "string" - }, - "RequireInstanceProperties": { - "type": "boolean" - }, - "RoleArns": { - "items": { - "maxLength": 1011, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "SessionPolicy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ProfileId", - "/properties/ProfileArn" - ], - "required": [ - "Name", - "RoleArns" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RolesAnywhere::Profile" -} +{ + "additionalProperties": false, + "definitions": { + "AttributeMapping": { + "additionalProperties": false, + "properties": { + "CertificateField": { + "$ref": "#/definitions/CertificateField" + }, + "MappingRules": { + "items": { + "$ref": "#/definitions/MappingRule" + }, + "type": "array" + } + }, + "required": [ + "CertificateField", + "MappingRules" + ], + "type": "object" + }, + "CertificateField": { + "enum": [ + "x509Subject", + "x509Issuer", + "x509SAN" + ], + "type": "string" + }, + "MappingRule": { + "additionalProperties": false, + "properties": { + "Specifier": { + "type": "string" + } + }, + "required": [ + "Specifier" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::RolesAnywhere::Profile Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:GetPolicy", + "iam:PassRole", + "rolesanywhere:CreateProfile", + "rolesanywhere:TagResource", + "rolesanywhere:ListTagsForResource", + "rolesanywhere:PutAttributeMapping", + "rolesanywhere:DeleteAttributeMapping" + ] + }, + "delete": { + "permissions": [ + "rolesanywhere:DeleteProfile" + ] + }, + "list": { + "permissions": [ + "rolesanywhere:ListProfiles", + "rolesanywhere:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "rolesanywhere:GetProfile", + "rolesanywhere:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:GetPolicy", + "iam:PassRole", + "rolesanywhere:GetProfile", + "rolesanywhere:UpdateProfile", + "rolesanywhere:EnableProfile", + "rolesanywhere:DisableProfile", + "rolesanywhere:TagResource", + "rolesanywhere:UntagResource", + "rolesanywhere:ListTagsForResource", + "rolesanywhere:PutAttributeMapping", + "rolesanywhere:DeleteAttributeMapping" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProfileId" + ], + "properties": { + "AcceptRoleSessionName": { + "type": "boolean" + }, + "AttributeMappings": { + "items": { + "$ref": "#/definitions/AttributeMapping" + }, + "type": "array" + }, + "DurationSeconds": { + "maximum": 43200, + "minimum": 900, + "type": "number" + }, + "Enabled": { + "type": "boolean" + }, + "ManagedPolicyArns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "type": "string" + }, + "ProfileArn": { + "type": "string" + }, + "ProfileId": { + "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", + "type": "string" + }, + "RequireInstanceProperties": { + "type": "boolean" + }, + "RoleArns": { + "items": { + "maxLength": 1011, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "SessionPolicy": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ProfileId", + "/properties/ProfileArn" + ], + "required": [ + "Name", + "RoleArns" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RolesAnywhere::Profile" +} diff --git a/schema/aws-rolesanywhere-trustanchor.json b/schema/aws-rolesanywhere-trustanchor.json index f7480e2..9a877e9 100644 --- a/schema/aws-rolesanywhere-trustanchor.json +++ b/schema/aws-rolesanywhere-trustanchor.json @@ -1,208 +1,208 @@ -{ - "additionalProperties": false, - "definitions": { - "NotificationChannel": { - "enum": [ - "ALL" - ], - "type": "string" - }, - "NotificationEvent": { - "enum": [ - "CA_CERTIFICATE_EXPIRY", - "END_ENTITY_CERTIFICATE_EXPIRY" - ], - "type": "string" - }, - "NotificationSetting": { - "additionalProperties": false, - "properties": { - "Channel": { - "$ref": "#/definitions/NotificationChannel" - }, - "Enabled": { - "type": "boolean" - }, - "Event": { - "$ref": "#/definitions/NotificationEvent" - }, - "Threshold": { - "maximum": 360, - "minimum": 1, - "type": "number" - } - }, - "required": [ - "Enabled", - "Event" - ], - "type": "object" - }, - "Source": { - "additionalProperties": false, - "properties": { - "SourceData": { - "$ref": "#/definitions/SourceData" - }, - "SourceType": { - "$ref": "#/definitions/TrustAnchorType" - } - }, - "type": "object" - }, - "SourceData": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "X509CertificateData": { - "type": "string" - } - }, - "required": [ - "X509CertificateData" - ], - "title": "X509CertificateData", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "AcmPcaArn": { - "type": "string" - } - }, - "required": [ - "AcmPcaArn" - ], - "title": "AcmPcaArn", - "type": "object" - } - ] - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TrustAnchorType": { - "enum": [ - "AWS_ACM_PCA", - "CERTIFICATE_BUNDLE", - "SELF_SIGNED_REPOSITORY" - ], - "type": "string" - } - }, - "description": "Definition of AWS::RolesAnywhere::TrustAnchor Resource Type.", - "handlers": { - "create": { - "permissions": [ - "iam:CreateServiceLinkedRole", - "rolesanywhere:CreateTrustAnchor", - "rolesanywhere:TagResource", - "rolesanywhere:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "rolesanywhere:DeleteTrustAnchor" - ] - }, - "list": { - "permissions": [ - "rolesanywhere:ListTrustAnchors", - "rolesanywhere:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "rolesanywhere:GetTrustAnchor", - "rolesanywhere:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "acm-pca:GetCertificateAuthorityCertificate", - "rolesanywhere:ListTagsForResource", - "rolesanywhere:TagResource", - "rolesanywhere:UntagResource", - "rolesanywhere:EnableTrustAnchor", - "rolesanywhere:DisableTrustAnchor", - "rolesanywhere:UpdateTrustAnchor", - "rolesanywhere:GetTrustAnchor", - "rolesanywhere:PutNotificationSettings", - "rolesanywhere:ResetNotificationSettings" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrustAnchorId" - ], - "properties": { - "Enabled": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "NotificationSettings": { - "items": { - "$ref": "#/definitions/NotificationSetting" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "Source": { - "$ref": "#/definitions/Source" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrustAnchorArn": { - "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", - "type": "string" - }, - "TrustAnchorId": { - "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TrustAnchorId", - "/properties/TrustAnchorArn" - ], - "required": [ - "Name", - "Source" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::RolesAnywhere::TrustAnchor" -} +{ + "additionalProperties": false, + "definitions": { + "NotificationChannel": { + "enum": [ + "ALL" + ], + "type": "string" + }, + "NotificationEvent": { + "enum": [ + "CA_CERTIFICATE_EXPIRY", + "END_ENTITY_CERTIFICATE_EXPIRY" + ], + "type": "string" + }, + "NotificationSetting": { + "additionalProperties": false, + "properties": { + "Channel": { + "$ref": "#/definitions/NotificationChannel" + }, + "Enabled": { + "type": "boolean" + }, + "Event": { + "$ref": "#/definitions/NotificationEvent" + }, + "Threshold": { + "maximum": 360, + "minimum": 1, + "type": "number" + } + }, + "required": [ + "Enabled", + "Event" + ], + "type": "object" + }, + "Source": { + "additionalProperties": false, + "properties": { + "SourceData": { + "$ref": "#/definitions/SourceData" + }, + "SourceType": { + "$ref": "#/definitions/TrustAnchorType" + } + }, + "type": "object" + }, + "SourceData": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "X509CertificateData": { + "type": "string" + } + }, + "required": [ + "X509CertificateData" + ], + "title": "X509CertificateData", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "AcmPcaArn": { + "type": "string" + } + }, + "required": [ + "AcmPcaArn" + ], + "title": "AcmPcaArn", + "type": "object" + } + ] + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TrustAnchorType": { + "enum": [ + "AWS_ACM_PCA", + "CERTIFICATE_BUNDLE", + "SELF_SIGNED_REPOSITORY" + ], + "type": "string" + } + }, + "description": "Definition of AWS::RolesAnywhere::TrustAnchor Resource Type.", + "handlers": { + "create": { + "permissions": [ + "iam:CreateServiceLinkedRole", + "rolesanywhere:CreateTrustAnchor", + "rolesanywhere:TagResource", + "rolesanywhere:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "rolesanywhere:DeleteTrustAnchor" + ] + }, + "list": { + "permissions": [ + "rolesanywhere:ListTrustAnchors", + "rolesanywhere:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "rolesanywhere:GetTrustAnchor", + "rolesanywhere:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "acm-pca:GetCertificateAuthorityCertificate", + "rolesanywhere:ListTagsForResource", + "rolesanywhere:TagResource", + "rolesanywhere:UntagResource", + "rolesanywhere:EnableTrustAnchor", + "rolesanywhere:DisableTrustAnchor", + "rolesanywhere:UpdateTrustAnchor", + "rolesanywhere:GetTrustAnchor", + "rolesanywhere:PutNotificationSettings", + "rolesanywhere:ResetNotificationSettings" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrustAnchorId" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "NotificationSettings": { + "items": { + "$ref": "#/definitions/NotificationSetting" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "Source": { + "$ref": "#/definitions/Source" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrustAnchorArn": { + "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", + "type": "string" + }, + "TrustAnchorId": { + "pattern": "[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TrustAnchorId", + "/properties/TrustAnchorArn" + ], + "required": [ + "Name", + "Source" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RolesAnywhere::TrustAnchor" +} diff --git a/schema/aws-route53-cidrcollection.json b/schema/aws-route53-cidrcollection.json index becda42..23edff7 100644 --- a/schema/aws-route53-cidrcollection.json +++ b/schema/aws-route53-cidrcollection.json @@ -1,107 +1,108 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Location": { - "additionalProperties": false, - "properties": { - "CidrList": { - "description": "A list of CIDR blocks.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "LocationName": { - "description": "The name of the location that is associated with the CIDR collection.", - "maxLength": 16, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "LocationName", - "CidrList" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53::CidrCollection.", - "handlers": { - "create": { - "permissions": [ - "route53:CreateCidrCollection", - "route53:ChangeCidrCollection" - ] - }, - "delete": { - "permissions": [ - "route53:DeleteCidrCollection", - "route53:ChangeCidrCollection" - ] - }, - "list": { - "permissions": [ - "route53:ListCidrCollections", - "route53:ListCidrBlocks" - ] - }, - "read": { - "permissions": [ - "route53:ListCidrCollections", - "route53:ListCidrBlocks" - ] - }, - "update": { - "permissions": [ - "route53:ChangeCidrCollection" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon resource name (ARN) to uniquely identify the AWS resource.", - "type": "string" - }, - "Id": { - "description": "UUID of the CIDR collection.", - "type": "string" - }, - "Locations": { - "description": "A complex type that contains information about the list of CIDR locations.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Location" - }, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "A unique name for the CIDR collection.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[0-9A-Za-z_\\-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", - "tagging": { - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Route53::CidrCollection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Location": { + "additionalProperties": false, + "properties": { + "CidrList": { + "description": "A list of CIDR blocks.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "LocationName": { + "description": "The name of the location that is associated with the CIDR collection.", + "maxLength": 16, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "LocationName", + "CidrList" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53::CidrCollection.", + "handlers": { + "create": { + "permissions": [ + "route53:CreateCidrCollection", + "route53:ChangeCidrCollection" + ] + }, + "delete": { + "permissions": [ + "route53:DeleteCidrCollection", + "route53:ChangeCidrCollection", + "route53:ListCidrBlocks" + ] + }, + "list": { + "permissions": [ + "route53:ListCidrCollections", + "route53:ListCidrBlocks" + ] + }, + "read": { + "permissions": [ + "route53:ListCidrCollections", + "route53:ListCidrBlocks" + ] + }, + "update": { + "permissions": [ + "route53:ChangeCidrCollection" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon resource name (ARN) to uniquely identify the AWS resource.", + "type": "string" + }, + "Id": { + "description": "UUID of the CIDR collection.", + "type": "string" + }, + "Locations": { + "description": "A complex type that contains information about the list of CIDR locations.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Location" + }, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "A unique name for the CIDR collection.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z_\\-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", + "tagging": { + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Route53::CidrCollection" +} diff --git a/schema/aws-route53-dnssec.json b/schema/aws-route53-dnssec.json index 52295e6..fe981b5 100644 --- a/schema/aws-route53-dnssec.json +++ b/schema/aws-route53-dnssec.json @@ -1,57 +1,57 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HostedZoneId" - ], - "description": "Resource used to control (enable/disable) DNSSEC in a specific hosted zone.", - "handlers": { - "create": { - "permissions": [ - "route53:GetDNSSEC", - "route53:EnableHostedZoneDNSSEC", - "kms:DescribeKey", - "kms:GetPublicKey", - "kms:Sign", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "route53:GetDNSSEC", - "route53:DisableHostedZoneDNSSEC", - "kms:DescribeKey", - "kms:GetPublicKey", - "kms:Sign", - "kms:CreateGrant" - ] - }, - "list": { - "permissions": [ - "route53:GetDNSSEC", - "route53:ListHostedZones" - ] - }, - "read": { - "permissions": [ - "route53:GetDNSSEC" - ] - } - }, - "primaryIdentifier": [ - "/properties/HostedZoneId" - ], - "properties": { - "HostedZoneId": { - "description": "The unique string (ID) used to identify a hosted zone.", - "pattern": "^[A-Z0-9]{1,32}$", - "type": "string" - } - }, - "required": [ - "HostedZoneId" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Route53::DNSSEC" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HostedZoneId" + ], + "description": "Resource used to control (enable/disable) DNSSEC in a specific hosted zone.", + "handlers": { + "create": { + "permissions": [ + "route53:GetDNSSEC", + "route53:EnableHostedZoneDNSSEC", + "kms:DescribeKey", + "kms:GetPublicKey", + "kms:Sign", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "route53:GetDNSSEC", + "route53:DisableHostedZoneDNSSEC", + "kms:DescribeKey", + "kms:GetPublicKey", + "kms:Sign", + "kms:CreateGrant" + ] + }, + "list": { + "permissions": [ + "route53:GetDNSSEC", + "route53:ListHostedZones" + ] + }, + "read": { + "permissions": [ + "route53:GetDNSSEC" + ] + } + }, + "primaryIdentifier": [ + "/properties/HostedZoneId" + ], + "properties": { + "HostedZoneId": { + "description": "The unique string (ID) used to identify a hosted zone.", + "pattern": "^[A-Z0-9]{1,32}$", + "type": "string" + } + }, + "required": [ + "HostedZoneId" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Route53::DNSSEC" +} diff --git a/schema/aws-route53-healthcheck.json b/schema/aws-route53-healthcheck.json index 2905fd0..c4d1198 100644 --- a/schema/aws-route53-healthcheck.json +++ b/schema/aws-route53-healthcheck.json @@ -1,215 +1,215 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HealthCheckConfig/Type", - "/properties/HealthCheckConfig/MeasureLatency", - "/properties/HealthCheckConfig/RequestInterval" - ], - "definitions": { - "AlarmIdentifier": { - "additionalProperties": false, - "description": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.", - "properties": { - "Name": { - "description": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Region": { - "description": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.", - "type": "string" - } - }, - "required": [ - "Name", - "Region" - ], - "type": "object" - }, - "HealthCheckTag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag.", - "maxLength": 128, - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53::HealthCheck.", - "handlers": { - "create": { - "permissions": [ - "route53:CreateHealthCheck", - "route53:ChangeTagsForResource", - "cloudwatch:DescribeAlarms", - "route53-recovery-control-config:DescribeRoutingControl" - ] - }, - "delete": { - "permissions": [ - "route53:DeleteHealthCheck" - ] - }, - "list": { - "permissions": [ - "route53:ListHealthChecks", - "route53:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "route53:GetHealthCheck", - "route53:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53:UpdateHealthCheck", - "route53:ChangeTagsForResource", - "route53:ListTagsForResource", - "cloudwatch:DescribeAlarms" - ] - } - }, - "primaryIdentifier": [ - "/properties/HealthCheckId" - ], - "properties": { - "HealthCheckConfig": { - "additionalProperties": false, - "description": "A complex type that contains information about the health check.", - "properties": { - "AlarmIdentifier": { - "$ref": "#/definitions/AlarmIdentifier" - }, - "ChildHealthChecks": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 256, - "type": "array" - }, - "EnableSNI": { - "type": "boolean" - }, - "FailureThreshold": { - "maximum": 10, - "minimum": 1, - "type": "integer" - }, - "FullyQualifiedDomainName": { - "maxLength": 255, - "type": "string" - }, - "HealthThreshold": { - "maximum": 256, - "minimum": 0, - "type": "integer" - }, - "IPAddress": { - "maxLength": 45, - "pattern": "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$", - "type": "string" - }, - "InsufficientDataHealthStatus": { - "enum": [ - "Healthy", - "LastKnownStatus", - "Unhealthy" - ], - "type": "string" - }, - "Inverted": { - "type": "boolean" - }, - "MeasureLatency": { - "type": "boolean" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Regions": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 64, - "type": "array" - }, - "RequestInterval": { - "maximum": 30, - "minimum": 10, - "type": "integer" - }, - "ResourcePath": { - "maxLength": 255, - "type": "string" - }, - "RoutingControlArn": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "SearchString": { - "maxLength": 255, - "type": "string" - }, - "Type": { - "enum": [ - "CALCULATED", - "CLOUDWATCH_METRIC", - "HTTP", - "HTTP_STR_MATCH", - "HTTPS", - "HTTPS_STR_MATCH", - "TCP", - "RECOVERY_CONTROL" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "HealthCheckId": { - "type": "string" - }, - "HealthCheckTags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HealthCheckTag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/HealthCheckId" - ], - "required": [ - "HealthCheckConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", - "taggable": true, - "typeName": "AWS::Route53::HealthCheck" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HealthCheckConfig/Type", + "/properties/HealthCheckConfig/MeasureLatency", + "/properties/HealthCheckConfig/RequestInterval" + ], + "definitions": { + "AlarmIdentifier": { + "additionalProperties": false, + "description": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.", + "properties": { + "Name": { + "description": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Region": { + "description": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.", + "type": "string" + } + }, + "required": [ + "Name", + "Region" + ], + "type": "object" + }, + "HealthCheckTag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag.", + "maxLength": 128, + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53::HealthCheck.", + "handlers": { + "create": { + "permissions": [ + "route53:CreateHealthCheck", + "route53:ChangeTagsForResource", + "cloudwatch:DescribeAlarms", + "route53-recovery-control-config:DescribeRoutingControl" + ] + }, + "delete": { + "permissions": [ + "route53:DeleteHealthCheck" + ] + }, + "list": { + "permissions": [ + "route53:ListHealthChecks", + "route53:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53:GetHealthCheck", + "route53:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53:UpdateHealthCheck", + "route53:ChangeTagsForResource", + "route53:ListTagsForResource", + "cloudwatch:DescribeAlarms" + ] + } + }, + "primaryIdentifier": [ + "/properties/HealthCheckId" + ], + "properties": { + "HealthCheckConfig": { + "additionalProperties": false, + "description": "A complex type that contains information about the health check.", + "properties": { + "AlarmIdentifier": { + "$ref": "#/definitions/AlarmIdentifier" + }, + "ChildHealthChecks": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 256, + "type": "array" + }, + "EnableSNI": { + "type": "boolean" + }, + "FailureThreshold": { + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "FullyQualifiedDomainName": { + "maxLength": 255, + "type": "string" + }, + "HealthThreshold": { + "maximum": 256, + "minimum": 0, + "type": "integer" + }, + "IPAddress": { + "maxLength": 45, + "pattern": "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$", + "type": "string" + }, + "InsufficientDataHealthStatus": { + "enum": [ + "Healthy", + "LastKnownStatus", + "Unhealthy" + ], + "type": "string" + }, + "Inverted": { + "type": "boolean" + }, + "MeasureLatency": { + "type": "boolean" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Regions": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 64, + "type": "array" + }, + "RequestInterval": { + "maximum": 30, + "minimum": 10, + "type": "integer" + }, + "ResourcePath": { + "maxLength": 255, + "type": "string" + }, + "RoutingControlArn": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SearchString": { + "maxLength": 255, + "type": "string" + }, + "Type": { + "enum": [ + "CALCULATED", + "CLOUDWATCH_METRIC", + "HTTP", + "HTTP_STR_MATCH", + "HTTPS", + "HTTPS_STR_MATCH", + "TCP", + "RECOVERY_CONTROL" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "HealthCheckId": { + "type": "string" + }, + "HealthCheckTags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HealthCheckTag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/HealthCheckId" + ], + "required": [ + "HealthCheckConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", + "taggable": true, + "typeName": "AWS::Route53::HealthCheck" +} diff --git a/schema/aws-route53-hostedzone.json b/schema/aws-route53-hostedzone.json index 407ac7a..4f93a0a 100644 --- a/schema/aws-route53-hostedzone.json +++ b/schema/aws-route53-hostedzone.json @@ -1,189 +1,200 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "HostedZoneConfig": { - "additionalProperties": false, - "description": "A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements.", - "properties": { - "Comment": { - "description": "Any comments that you want to include about the hosted zone.", - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - }, - "HostedZoneTag": { - "additionalProperties": false, - "description": "A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.", - "properties": { - "Key": { - "description": "The value of ``Key`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag.\n + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for.\n + *Delete a key*: ``Key`` is the name of the tag you want to remove.\n + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.", - "maxLength": 128, - "type": "string" - }, - "Value": { - "description": "The value of ``Value`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag.\n + *Edit a tag*: ``Value`` is the new value that you want to assign the tag.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "QueryLoggingConfig": { - "additionalProperties": false, - "description": "A complex type that contains information about a configuration for DNS query logging.", - "properties": { - "CloudWatchLogsLogGroupArn": { - "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Logs::LogGroup" - }, - "type": "string" - } - }, - "required": [ - "CloudWatchLogsLogGroupArn" - ], - "type": "object" - }, - "VPC": { - "additionalProperties": false, - "description": "*Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. \n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", - "properties": { - "VPCId": { - "description": "*Private hosted zones only:* The ID of an Amazon VPC.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", - "relationshipRef": { - "propertyPath": "/properties/VpcId", - "typeName": "AWS::EC2::VPC" - }, - "type": "string" - }, - "VPCRegion": { - "description": "*Private hosted zones only:* The region that an Amazon VPC was created in.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", - "type": "string" - } - }, - "required": [ - "VPCId", - "VPCRegion" - ], - "type": "object" - } - }, - "description": "Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). \n You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.\n For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).\n Note the following:\n + You can't create a hosted zone for a top-level domain (TLD) such as .com.\n + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. \n \n When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.\n The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.\n When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.\n The following are the supported partitions:\n + ``aws`` - AWS-Regions \n + ``aws-cn`` - China Regions\n + ``aws-us-gov`` - govcloud-us-region \n \n For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", - "handlers": { - "create": { - "permissions": [ - "route53:CreateHostedZone", - "route53:CreateQueryLoggingConfig", - "route53:ChangeTagsForResource", - "route53:GetChange", - "route53:AssociateVPCWithHostedZone", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "route53:DeleteHostedZone", - "route53:DeleteQueryLoggingConfig", - "route53:ListQueryLoggingConfigs", - "route53:GetChange" - ] - }, - "list": { - "permissions": [ - "route53:GetHostedZone", - "route53:ListHostedZones", - "route53:ListHostedZonesByName", - "route53:ListQueryLoggingConfigs", - "route53:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "route53:GetHostedZone", - "route53:ListTagsForResource", - "route53:ListQueryLoggingConfigs" - ] - }, - "update": { - "permissions": [ - "route53:GetChange", - "route53:ListTagsForResource", - "route53:UpdateHostedZoneComment", - "route53:ChangeTagsForResource", - "route53:AssociateVPCWithHostedZone", - "route53:DisassociateVPCFromHostedZone", - "route53:CreateQueryLoggingConfig", - "route53:DeleteQueryLoggingConfig", - "ec2:DescribeVpcs" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "HostedZoneConfig": { - "$ref": "#/definitions/HostedZoneConfig", - "description": "A complex type that contains an optional comment.\n If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements." - }, - "HostedZoneTags": { - "description": "Adds, edits, or deletes tags for a health check or a hosted zone.\n For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HostedZoneTag" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "", - "type": "string" - }, - "Name": { - "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.", - "maxLength": 1024, - "type": "string" - }, - "NameServers": { - "description": "", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "QueryLoggingConfig": { - "$ref": "#/definitions/QueryLoggingConfig", - "description": "Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.\n DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:\n + Route 53 edge location that responded to the DNS query\n + Domain or subdomain that was requested\n + DNS record type, such as A or AAAA\n + DNS response code, such as ``NoError`` or ``ServFail`` \n \n + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig." - }, - "VPCs": { - "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/VPC" - }, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/Name": "Name $OR $join([Name, \".\"])" - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/NameServers" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", - "typeName": "AWS::Route53::HostedZone" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "HostedZoneConfig": { + "additionalProperties": false, + "description": "A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements.", + "properties": { + "Comment": { + "description": "Any comments that you want to include about the hosted zone.", + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + }, + "HostedZoneTag": { + "additionalProperties": false, + "description": "A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.", + "properties": { + "Key": { + "description": "The value of ``Key`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag.\n + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for.\n + *Delete a key*: ``Key`` is the name of the tag you want to remove.\n + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.", + "maxLength": 128, + "type": "string" + }, + "Value": { + "description": "The value of ``Value`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag.\n + *Edit a tag*: ``Value`` is the new value that you want to assign the tag.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "QueryLoggingConfig": { + "additionalProperties": false, + "description": "A complex type that contains information about a configuration for DNS query logging.", + "properties": { + "CloudWatchLogsLogGroupArn": { + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Logs::LogGroup" + }, + "type": "string" + } + }, + "required": [ + "CloudWatchLogsLogGroupArn" + ], + "type": "object" + }, + "VPC": { + "additionalProperties": false, + "description": "*Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. \n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "properties": { + "VPCId": { + "description": "*Private hosted zones only:* The ID of an Amazon VPC.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, + "type": "string" + }, + "VPCRegion": { + "description": "*Private hosted zones only:* The region that an Amazon VPC was created in.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "type": "string" + } + }, + "required": [ + "VPCId", + "VPCRegion" + ], + "type": "object" + } + }, + "description": "Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). \n You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.\n For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).\n Note the following:\n + You can't create a hosted zone for a top-level domain (TLD) such as .com.\n + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. \n \n When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.\n The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.\n When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.\n The following are the supported partitions:\n + ``aws`` - AWS-Regions \n + ``aws-cn`` - China Regions\n + ``aws-us-gov`` - govcloud-us-region \n \n For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "handlers": { + "create": { + "permissions": [ + "route53:CreateHostedZone", + "route53:CreateQueryLoggingConfig", + "route53:ChangeTagsForResource", + "route53:GetChange", + "route53:AssociateVPCWithHostedZone", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "route53:DeleteHostedZone", + "route53:DeleteQueryLoggingConfig", + "route53:ListQueryLoggingConfigs", + "route53:GetChange" + ] + }, + "list": { + "permissions": [ + "route53:GetHostedZone", + "route53:ListHostedZones", + "route53:ListHostedZonesByName", + "route53:ListQueryLoggingConfigs", + "route53:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53:GetHostedZone", + "route53:ListTagsForResource", + "route53:ListQueryLoggingConfigs" + ] + }, + "update": { + "permissions": [ + "route53:GetChange", + "route53:ListTagsForResource", + "route53:UpdateHostedZoneComment", + "route53:ChangeTagsForResource", + "route53:AssociateVPCWithHostedZone", + "route53:DisassociateVPCFromHostedZone", + "route53:CreateQueryLoggingConfig", + "route53:DeleteQueryLoggingConfig", + "ec2:DescribeVpcs" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "HostedZoneConfig": { + "$ref": "#/definitions/HostedZoneConfig", + "description": "A complex type that contains an optional comment.\n If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements." + }, + "HostedZoneTags": { + "description": "Adds, edits, or deletes tags for a health check or a hosted zone.\n For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HostedZoneTag" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "", + "type": "string" + }, + "Name": { + "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.", + "maxLength": 1024, + "type": "string" + }, + "NameServers": { + "description": "", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "QueryLoggingConfig": { + "$ref": "#/definitions/QueryLoggingConfig", + "description": "Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.\n DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:\n + Route 53 edge location that responded to the DNS query\n + Domain or subdomain that was requested\n + DNS record type, such as A or AAAA\n + DNS response code, such as ``NoError`` or ``ServFail`` \n \n + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig." + }, + "VPCs": { + "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/VPC" + }, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/Name": "Name $OR $join([Name, \".\"])" + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/NameServers" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "route53:ChangeTagsForResource", + "route53:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/HostedZoneTags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53::HostedZone" +} diff --git a/schema/aws-route53-keysigningkey.json b/schema/aws-route53-keysigningkey.json index 5d1457c..c956f62 100644 --- a/schema/aws-route53-keysigningkey.json +++ b/schema/aws-route53-keysigningkey.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HostedZoneId", - "/properties/Name", - "/properties/KeyManagementServiceArn" - ], - "description": "Represents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.", - "handlers": { - "create": { - "permissions": [ - "route53:CreateKeySigningKey", - "kms:DescribeKey", - "kms:GetPublicKey", - "kms:Sign", - "kms:CreateGrant" - ] - }, - "delete": { - "permissions": [ - "route53:DeactivateKeySigningKey", - "route53:DeleteKeySigningKey", - "kms:DescribeKey", - "kms:GetPublicKey", - "kms:Sign", - "kms:CreateGrant" - ] - }, - "list": { - "permissions": [ - "route53:GetDNSSEC", - "route53:ListHostedZones" - ] - }, - "read": { - "permissions": [ - "route53:GetDNSSEC" - ] - }, - "update": { - "permissions": [ - "route53:GetDNSSEC", - "route53:ActivateKeySigningKey", - "route53:DeactivateKeySigningKey", - "kms:DescribeKey", - "kms:GetPublicKey", - "kms:Sign", - "kms:CreateGrant" - ] - } - }, - "primaryIdentifier": [ - "/properties/HostedZoneId", - "/properties/Name" - ], - "properties": { - "HostedZoneId": { - "description": "The unique string (ID) used to identify a hosted zone.", - "pattern": "^[A-Z0-9]{1,32}$", - "type": "string" - }, - "KeyManagementServiceArn": { - "description": "The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.", - "pattern": "^[a-zA-Z0-9_]{3,128}$", - "type": "string" - }, - "Status": { - "description": "A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - } - }, - "required": [ - "Status", - "HostedZoneId", - "Name", - "KeyManagementServiceArn" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Route53::KeySigningKey" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HostedZoneId", + "/properties/Name", + "/properties/KeyManagementServiceArn" + ], + "description": "Represents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.", + "handlers": { + "create": { + "permissions": [ + "route53:CreateKeySigningKey", + "kms:DescribeKey", + "kms:GetPublicKey", + "kms:Sign", + "kms:CreateGrant" + ] + }, + "delete": { + "permissions": [ + "route53:DeactivateKeySigningKey", + "route53:DeleteKeySigningKey", + "kms:DescribeKey", + "kms:GetPublicKey", + "kms:Sign", + "kms:CreateGrant" + ] + }, + "list": { + "permissions": [ + "route53:GetDNSSEC", + "route53:ListHostedZones" + ] + }, + "read": { + "permissions": [ + "route53:GetDNSSEC" + ] + }, + "update": { + "permissions": [ + "route53:GetDNSSEC", + "route53:ActivateKeySigningKey", + "route53:DeactivateKeySigningKey", + "kms:DescribeKey", + "kms:GetPublicKey", + "kms:Sign", + "kms:CreateGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/HostedZoneId", + "/properties/Name" + ], + "properties": { + "HostedZoneId": { + "description": "The unique string (ID) used to identify a hosted zone.", + "pattern": "^[A-Z0-9]{1,32}$", + "type": "string" + }, + "KeyManagementServiceArn": { + "description": "The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.", + "pattern": "^[a-zA-Z0-9_]{3,128}$", + "type": "string" + }, + "Status": { + "description": "A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + } + }, + "required": [ + "Status", + "HostedZoneId", + "Name", + "KeyManagementServiceArn" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Route53::KeySigningKey" +} diff --git a/schema/aws-route53-recordset.json b/schema/aws-route53-recordset.json index 6216dc4..a492cf8 100644 --- a/schema/aws-route53-recordset.json +++ b/schema/aws-route53-recordset.json @@ -1,166 +1,166 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HostedZoneName", - "/properties/Name", - "/properties/HostedZoneId" - ], - "definitions": { - "AliasTarget": { - "additionalProperties": false, - "properties": { - "DNSName": { - "type": "string" - }, - "EvaluateTargetHealth": { - "type": "boolean" - }, - "HostedZoneId": { - "type": "string" - } - }, - "required": [ - "HostedZoneId", - "DNSName" - ], - "type": "object" - }, - "CidrRoutingConfig": { - "additionalProperties": false, - "properties": { - "CollectionId": { - "type": "string" - }, - "LocationName": { - "type": "string" - } - }, - "required": [ - "CollectionId", - "LocationName" - ], - "type": "object" - }, - "Coordinates": { - "additionalProperties": false, - "properties": { - "Latitude": { - "type": "string" - }, - "Longitude": { - "type": "string" - } - }, - "required": [ - "Latitude", - "Longitude" - ], - "type": "object" - }, - "GeoLocation": { - "additionalProperties": false, - "properties": { - "ContinentCode": { - "type": "string" - }, - "CountryCode": { - "type": "string" - }, - "SubdivisionCode": { - "type": "string" - } - }, - "type": "object" - }, - "GeoProximityLocation": { - "additionalProperties": false, - "properties": { - "AWSRegion": { - "type": "string" - }, - "Bias": { - "type": "integer" - }, - "Coordinates": { - "$ref": "#/definitions/Coordinates" - }, - "LocalZoneGroup": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53::RecordSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AliasTarget": { - "$ref": "#/definitions/AliasTarget" - }, - "CidrRoutingConfig": { - "$ref": "#/definitions/CidrRoutingConfig" - }, - "Comment": { - "type": "string" - }, - "Failover": { - "type": "string" - }, - "GeoLocation": { - "$ref": "#/definitions/GeoLocation" - }, - "GeoProximityLocation": { - "$ref": "#/definitions/GeoProximityLocation" - }, - "HealthCheckId": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "MultiValueAnswer": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceRecords": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SetIdentifier": { - "type": "string" - }, - "TTL": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Weight": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Type", - "Name" - ], - "typeName": "AWS::Route53::RecordSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HostedZoneName", + "/properties/Name", + "/properties/HostedZoneId" + ], + "definitions": { + "AliasTarget": { + "additionalProperties": false, + "properties": { + "DNSName": { + "type": "string" + }, + "EvaluateTargetHealth": { + "type": "boolean" + }, + "HostedZoneId": { + "type": "string" + } + }, + "required": [ + "HostedZoneId", + "DNSName" + ], + "type": "object" + }, + "CidrRoutingConfig": { + "additionalProperties": false, + "properties": { + "CollectionId": { + "type": "string" + }, + "LocationName": { + "type": "string" + } + }, + "required": [ + "CollectionId", + "LocationName" + ], + "type": "object" + }, + "Coordinates": { + "additionalProperties": false, + "properties": { + "Latitude": { + "type": "string" + }, + "Longitude": { + "type": "string" + } + }, + "required": [ + "Latitude", + "Longitude" + ], + "type": "object" + }, + "GeoLocation": { + "additionalProperties": false, + "properties": { + "ContinentCode": { + "type": "string" + }, + "CountryCode": { + "type": "string" + }, + "SubdivisionCode": { + "type": "string" + } + }, + "type": "object" + }, + "GeoProximityLocation": { + "additionalProperties": false, + "properties": { + "AWSRegion": { + "type": "string" + }, + "Bias": { + "type": "integer" + }, + "Coordinates": { + "$ref": "#/definitions/Coordinates" + }, + "LocalZoneGroup": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53::RecordSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AliasTarget": { + "$ref": "#/definitions/AliasTarget" + }, + "CidrRoutingConfig": { + "$ref": "#/definitions/CidrRoutingConfig" + }, + "Comment": { + "type": "string" + }, + "Failover": { + "type": "string" + }, + "GeoLocation": { + "$ref": "#/definitions/GeoLocation" + }, + "GeoProximityLocation": { + "$ref": "#/definitions/GeoProximityLocation" + }, + "HealthCheckId": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "HostedZoneName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "MultiValueAnswer": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "Region": { + "type": "string" + }, + "ResourceRecords": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SetIdentifier": { + "type": "string" + }, + "TTL": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Weight": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Type", + "Name" + ], + "typeName": "AWS::Route53::RecordSet" +} diff --git a/schema/aws-route53-recordsetgroup.json b/schema/aws-route53-recordsetgroup.json index 4c7865e..1ad1f00 100644 --- a/schema/aws-route53-recordsetgroup.json +++ b/schema/aws-route53-recordsetgroup.json @@ -1,184 +1,184 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HostedZoneName", - "/properties/HostedZoneId" - ], - "definitions": { - "AliasTarget": { - "additionalProperties": false, - "properties": { - "DNSName": { - "type": "string" - }, - "EvaluateTargetHealth": { - "type": "boolean" - }, - "HostedZoneId": { - "type": "string" - } - }, - "required": [ - "HostedZoneId", - "DNSName" - ], - "type": "object" - }, - "CidrRoutingConfig": { - "additionalProperties": false, - "properties": { - "CollectionId": { - "type": "string" - }, - "LocationName": { - "type": "string" - } - }, - "required": [ - "CollectionId", - "LocationName" - ], - "type": "object" - }, - "Coordinates": { - "additionalProperties": false, - "properties": { - "Latitude": { - "type": "string" - }, - "Longitude": { - "type": "string" - } - }, - "required": [ - "Latitude", - "Longitude" - ], - "type": "object" - }, - "GeoLocation": { - "additionalProperties": false, - "properties": { - "ContinentCode": { - "type": "string" - }, - "CountryCode": { - "type": "string" - }, - "SubdivisionCode": { - "type": "string" - } - }, - "type": "object" - }, - "GeoProximityLocation": { - "additionalProperties": false, - "properties": { - "AWSRegion": { - "type": "string" - }, - "Bias": { - "type": "integer" - }, - "Coordinates": { - "$ref": "#/definitions/Coordinates" - }, - "LocalZoneGroup": { - "type": "string" - } - }, - "type": "object" - }, - "RecordSet": { - "additionalProperties": false, - "properties": { - "AliasTarget": { - "$ref": "#/definitions/AliasTarget" - }, - "CidrRoutingConfig": { - "$ref": "#/definitions/CidrRoutingConfig" - }, - "Failover": { - "type": "string" - }, - "GeoLocation": { - "$ref": "#/definitions/GeoLocation" - }, - "GeoProximityLocation": { - "$ref": "#/definitions/GeoProximityLocation" - }, - "HealthCheckId": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "MultiValueAnswer": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceRecords": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "SetIdentifier": { - "type": "string" - }, - "TTL": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Weight": { - "type": "integer" - } - }, - "required": [ - "Type", - "Name" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53::RecordSetGroup", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Comment": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "RecordSets": { - "items": { - "$ref": "#/definitions/RecordSet" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::Route53::RecordSetGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HostedZoneName", + "/properties/HostedZoneId" + ], + "definitions": { + "AliasTarget": { + "additionalProperties": false, + "properties": { + "DNSName": { + "type": "string" + }, + "EvaluateTargetHealth": { + "type": "boolean" + }, + "HostedZoneId": { + "type": "string" + } + }, + "required": [ + "HostedZoneId", + "DNSName" + ], + "type": "object" + }, + "CidrRoutingConfig": { + "additionalProperties": false, + "properties": { + "CollectionId": { + "type": "string" + }, + "LocationName": { + "type": "string" + } + }, + "required": [ + "CollectionId", + "LocationName" + ], + "type": "object" + }, + "Coordinates": { + "additionalProperties": false, + "properties": { + "Latitude": { + "type": "string" + }, + "Longitude": { + "type": "string" + } + }, + "required": [ + "Latitude", + "Longitude" + ], + "type": "object" + }, + "GeoLocation": { + "additionalProperties": false, + "properties": { + "ContinentCode": { + "type": "string" + }, + "CountryCode": { + "type": "string" + }, + "SubdivisionCode": { + "type": "string" + } + }, + "type": "object" + }, + "GeoProximityLocation": { + "additionalProperties": false, + "properties": { + "AWSRegion": { + "type": "string" + }, + "Bias": { + "type": "integer" + }, + "Coordinates": { + "$ref": "#/definitions/Coordinates" + }, + "LocalZoneGroup": { + "type": "string" + } + }, + "type": "object" + }, + "RecordSet": { + "additionalProperties": false, + "properties": { + "AliasTarget": { + "$ref": "#/definitions/AliasTarget" + }, + "CidrRoutingConfig": { + "$ref": "#/definitions/CidrRoutingConfig" + }, + "Failover": { + "type": "string" + }, + "GeoLocation": { + "$ref": "#/definitions/GeoLocation" + }, + "GeoProximityLocation": { + "$ref": "#/definitions/GeoProximityLocation" + }, + "HealthCheckId": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "HostedZoneName": { + "type": "string" + }, + "MultiValueAnswer": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "Region": { + "type": "string" + }, + "ResourceRecords": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SetIdentifier": { + "type": "string" + }, + "TTL": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "Weight": { + "type": "integer" + } + }, + "required": [ + "Type", + "Name" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53::RecordSetGroup", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Comment": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "HostedZoneName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "RecordSets": { + "items": { + "$ref": "#/definitions/RecordSet" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::Route53::RecordSetGroup" +} diff --git a/schema/aws-route53profiles-profile.json b/schema/aws-route53profiles-profile.json index 99efd4e..ff59075 100644 --- a/schema/aws-route53profiles-profile.json +++ b/schema/aws-route53profiles-profile.json @@ -1,121 +1,121 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53Profiles::Profile", - "handlers": { - "create": { - "permissions": [ - "route53profiles:CreateProfile", - "route53profiles:GetProfile", - "route53profiles:TagResource", - "route53profiles:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "route53profiles:DeleteProfile", - "route53profiles:GetProfile", - "route53profiles:UntagResource" - ] - }, - "list": { - "permissions": [ - "route53profiles:ListProfiles", - "route53profiles:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "route53profiles:GetProfile", - "route53profiles:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53profiles:GetProfile", - "route53profiles:TagResource", - "route53profiles:UntagResource", - "route53profiles:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the resolver profile.", - "type": "string" - }, - "ClientToken": { - "description": "The id of the creator request", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "The ID of the profile.", - "type": "string" - }, - "Name": { - "description": "The name of the profile.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/ClientToken" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Profiles::Profile", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Profiles::Profile", + "handlers": { + "create": { + "permissions": [ + "route53profiles:CreateProfile", + "route53profiles:GetProfile", + "route53profiles:TagResource", + "route53profiles:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DeleteProfile", + "route53profiles:GetProfile", + "route53profiles:UntagResource" + ] + }, + "list": { + "permissions": [ + "route53profiles:ListProfiles", + "route53profiles:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfile", + "route53profiles:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53profiles:GetProfile", + "route53profiles:TagResource", + "route53profiles:UntagResource", + "route53profiles:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the resolver profile.", + "type": "string" + }, + "ClientToken": { + "description": "The id of the creator request", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The ID of the profile.", + "type": "string" + }, + "Name": { + "description": "The name of the profile.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/ClientToken" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Profiles::Profile", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-route53profiles-profileassociation.json b/schema/aws-route53profiles-profileassociation.json index ee77b8d..879f179 100644 --- a/schema/aws-route53profiles-profileassociation.json +++ b/schema/aws-route53profiles-profileassociation.json @@ -1,124 +1,124 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/ResourceId", - "/properties/ProfileId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53Profiles::ProfileAssociation", - "handlers": { - "create": { - "permissions": [ - "route53profiles:AssociateProfile", - "route53profiles:GetProfileAssociation", - "ec2:DescribeVpcs", - "route53profiles:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53profiles:DisassociateProfile", - "route53profiles:GetProfileAssociation", - "route53profiles:UntagResource" - ] - }, - "list": { - "permissions": [ - "route53profiles:ListProfileAssociations", - "route53profiles:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "route53profiles:GetProfileAssociation", - "route53profiles:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53profiles:GetProfileAssociation", - "route53profiles:TagResource", - "route53profiles:UntagResource", - "route53profiles:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the profile association.", - "type": "string" - }, - "Id": { - "description": "Primary Identifier for Profile Association", - "type": "string" - }, - "Name": { - "description": "The name of an association between a Profile and a VPC.", - "type": "string" - }, - "ProfileId": { - "description": "The ID of the profile that you associated with the resource that is specified by ResourceId.", - "type": "string" - }, - "ResourceId": { - "description": "The resource that you associated the profile with.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResourceId", - "ProfileId", - "Name" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Profiles::ProfileAssociation", - "writeOnlyProperties": [ - "/properties/Arn", - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ResourceId", + "/properties/ProfileId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Profiles::ProfileAssociation", + "handlers": { + "create": { + "permissions": [ + "route53profiles:AssociateProfile", + "route53profiles:GetProfileAssociation", + "ec2:DescribeVpcs", + "route53profiles:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DisassociateProfile", + "route53profiles:GetProfileAssociation", + "route53profiles:UntagResource" + ] + }, + "list": { + "permissions": [ + "route53profiles:ListProfileAssociations", + "route53profiles:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfileAssociation", + "route53profiles:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53profiles:GetProfileAssociation", + "route53profiles:TagResource", + "route53profiles:UntagResource", + "route53profiles:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the profile association.", + "type": "string" + }, + "Id": { + "description": "Primary Identifier for Profile Association", + "type": "string" + }, + "Name": { + "description": "The name of an association between a Profile and a VPC.", + "type": "string" + }, + "ProfileId": { + "description": "The ID of the profile that you associated with the resource that is specified by ResourceId.", + "type": "string" + }, + "ResourceId": { + "description": "The resource that you associated the profile with.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceId", + "ProfileId", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Profiles::ProfileAssociation", + "writeOnlyProperties": [ + "/properties/Arn", + "/properties/Tags" + ] +} diff --git a/schema/aws-route53profiles-profileresourceassociation.json b/schema/aws-route53profiles-profileresourceassociation.json index 99c1126..5126781 100644 --- a/schema/aws-route53profiles-profileresourceassociation.json +++ b/schema/aws-route53profiles-profileresourceassociation.json @@ -1,105 +1,105 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProfileId", - "/properties/Name", - "/properties/ResourceArn" - ], - "description": "Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation", - "handlers": { - "create": { - "permissions": [ - "route53profiles:AssociateResourceToProfile", - "route53profiles:GetProfileResourceAssociation", - "route53resolver:*", - "route53:*" - ] - }, - "delete": { - "permissions": [ - "route53profiles:DisassociateResourceFromProfile", - "route53profiles:GetProfileResourceAssociation", - "route53resolver:*", - "route53:*" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ProfileId": { - "$ref": "resource-schema.json#/properties/ProfileId" - } - }, - "required": [ - "ProfileId" - ] - }, - "permissions": [ - "route53profiles:ListProfileResourceAssociations", - "route53resolver:*", - "route53:*" - ] - }, - "read": { - "permissions": [ - "route53profiles:GetProfileResourceAssociation", - "route53resolver:*", - "route53:*" - ] - }, - "update": { - "permissions": [ - "route53profiles:UpdateProfileResourceAssociation", - "route53profiles:GetProfileResourceAssociation", - "route53resolver:*", - "route53:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "Primary Identifier for Profile Resource Association", - "type": "string" - }, - "Name": { - "description": "The name of an association between the Profile and resource.", - "type": "string" - }, - "ProfileId": { - "description": "The ID of the profile that you associated the resource to that is specified by ResourceArn.", - "type": "string" - }, - "ResourceArn": { - "description": "The arn of the resource that you associated to the Profile.", - "type": "string" - }, - "ResourceProperties": { - "description": "A JSON-formatted string with key-value pairs specifying the properties of the associated resource.", - "type": "string" - }, - "ResourceType": { - "description": "The type of the resource associated to the Profile.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ResourceType" - ], - "required": [ - "ProfileId", - "Name", - "ResourceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53profiles", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Route53Profiles::ProfileResourceAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfileId", + "/properties/Name", + "/properties/ResourceArn" + ], + "description": "Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation", + "handlers": { + "create": { + "permissions": [ + "route53profiles:AssociateResourceToProfile", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DisassociateResourceFromProfile", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ProfileId": { + "$ref": "resource-schema.json#/properties/ProfileId" + } + }, + "required": [ + "ProfileId" + ] + }, + "permissions": [ + "route53profiles:ListProfileResourceAssociations", + "route53resolver:*", + "route53:*" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "update": { + "permissions": [ + "route53profiles:UpdateProfileResourceAssociation", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "Primary Identifier for Profile Resource Association", + "type": "string" + }, + "Name": { + "description": "The name of an association between the Profile and resource.", + "type": "string" + }, + "ProfileId": { + "description": "The ID of the profile that you associated the resource to that is specified by ResourceArn.", + "type": "string" + }, + "ResourceArn": { + "description": "The arn of the resource that you associated to the Profile.", + "type": "string" + }, + "ResourceProperties": { + "description": "A JSON-formatted string with key-value pairs specifying the properties of the associated resource.", + "type": "string" + }, + "ResourceType": { + "description": "The type of the resource associated to the Profile.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceType" + ], + "required": [ + "ProfileId", + "Name", + "ResourceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53profiles", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Route53Profiles::ProfileResourceAssociation" +} diff --git a/schema/aws-route53recoverycontrol-cluster.json b/schema/aws-route53recoverycontrol-cluster.json index 791f0a1..8a3c983 100644 --- a/schema/aws-route53recoverycontrol-cluster.json +++ b/schema/aws-route53recoverycontrol-cluster.json @@ -1,136 +1,136 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Tags" - ], - "definitions": { - "ClusterEndpoint": { - "additionalProperties": false, - "properties": { - "Endpoint": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Region": { - "maxLength": 32, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "AWS Route53 Recovery Control Cluster resource schema", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-control-config:CreateCluster", - "route53-recovery-control-config:DescribeCluster", - "route53-recovery-control-config:ListTagsForResource", - "route53-recovery-control-config:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-control-config:DescribeCluster", - "route53-recovery-control-config:DeleteCluster" - ] - }, - "list": { - "permissions": [ - "route53-recovery-control-config:ListClusters" - ] - }, - "read": { - "permissions": [ - "route53-recovery-control-config:DescribeCluster", - "route53-recovery-control-config:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ClusterArn" - ], - "properties": { - "ClusterArn": { - "description": "The Amazon Resource Name (ARN) of the cluster.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "ClusterEndpoints": { - "description": "Endpoints for the cluster.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ClusterEndpoint" - }, - "type": "array" - }, - "Name": { - "description": "Name of a Cluster. You can use any non-white space character in the name", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Status": { - "description": "Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", - "enum": [ - "PENDING", - "DEPLOYED", - "PENDING_DELETION" - ], - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ClusterArn", - "/properties/ClusterEndpoints", - "/properties/Status" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::Route53RecoveryControl::Cluster", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Tags" + ], + "definitions": { + "ClusterEndpoint": { + "additionalProperties": false, + "properties": { + "Endpoint": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Region": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "AWS Route53 Recovery Control Cluster resource schema", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-control-config:CreateCluster", + "route53-recovery-control-config:DescribeCluster", + "route53-recovery-control-config:ListTagsForResource", + "route53-recovery-control-config:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-control-config:DescribeCluster", + "route53-recovery-control-config:DeleteCluster" + ] + }, + "list": { + "permissions": [ + "route53-recovery-control-config:ListClusters" + ] + }, + "read": { + "permissions": [ + "route53-recovery-control-config:DescribeCluster", + "route53-recovery-control-config:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ClusterArn" + ], + "properties": { + "ClusterArn": { + "description": "The Amazon Resource Name (ARN) of the cluster.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "ClusterEndpoints": { + "description": "Endpoints for the cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ClusterEndpoint" + }, + "type": "array" + }, + "Name": { + "description": "Name of a Cluster. You can use any non-white space character in the name", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Status": { + "description": "Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", + "enum": [ + "PENDING", + "DEPLOYED", + "PENDING_DELETION" + ], + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ClusterArn", + "/properties/ClusterEndpoints", + "/properties/Status" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::Route53RecoveryControl::Cluster", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-route53recoverycontrol-controlpanel.json b/schema/aws-route53recoverycontrol-controlpanel.json index a7a1823..619bd6e 100644 --- a/schema/aws-route53recoverycontrol-controlpanel.json +++ b/schema/aws-route53recoverycontrol-controlpanel.json @@ -1,134 +1,134 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ClusterArn", - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "AWS Route53 Recovery Control Control Panel resource schema .", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-control-config:CreateControlPanel", - "route53-recovery-control-config:DescribeCluster", - "route53-recovery-control-config:DescribeControlPanel", - "route53-recovery-control-config:ListTagsForResource", - "route53-recovery-control-config:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-control-config:DeleteControlPanel", - "route53-recovery-control-config:DescribeControlPanel" - ] - }, - "list": { - "permissions": [ - "route53-recovery-control-config:ListControlPanels" - ] - }, - "read": { - "permissions": [ - "route53-recovery-control-config:DescribeControlPanel", - "route53-recovery-control-config:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53-recovery-control-config:UpdateControlPanel", - "route53-recovery-control-config:DescribeControlPanel", - "route53-recovery-control-config:ListTagsForResource", - "route53-recovery-control-config:TagResource", - "route53-recovery-control-config:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ControlPanelArn" - ], - "properties": { - "ClusterArn": { - "description": "Cluster to associate with the Control Panel", - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "ControlPanelArn": { - "description": "The Amazon Resource Name (ARN) of the cluster.", - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "DefaultControlPanel": { - "description": "A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.", - "type": "boolean" - }, - "Name": { - "description": "The name of the control panel. You can use any non-white space character in the name.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "RoutingControlCount": { - "description": "Count of associated routing controls", - "type": "integer" - }, - "Status": { - "description": "The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", - "enum": [ - "PENDING", - "DEPLOYED", - "PENDING_DELETION" - ], - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ControlPanelArn", - "/properties/Status", - "/properties/RoutingControlCount", - "/properties/DefaultControlPanel" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53RecoveryControl::ControlPanel", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterArn", + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "AWS Route53 Recovery Control Control Panel resource schema .", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-control-config:CreateControlPanel", + "route53-recovery-control-config:DescribeCluster", + "route53-recovery-control-config:DescribeControlPanel", + "route53-recovery-control-config:ListTagsForResource", + "route53-recovery-control-config:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-control-config:DeleteControlPanel", + "route53-recovery-control-config:DescribeControlPanel" + ] + }, + "list": { + "permissions": [ + "route53-recovery-control-config:ListControlPanels" + ] + }, + "read": { + "permissions": [ + "route53-recovery-control-config:DescribeControlPanel", + "route53-recovery-control-config:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53-recovery-control-config:UpdateControlPanel", + "route53-recovery-control-config:DescribeControlPanel", + "route53-recovery-control-config:ListTagsForResource", + "route53-recovery-control-config:TagResource", + "route53-recovery-control-config:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ControlPanelArn" + ], + "properties": { + "ClusterArn": { + "description": "Cluster to associate with the Control Panel", + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "ControlPanelArn": { + "description": "The Amazon Resource Name (ARN) of the cluster.", + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "DefaultControlPanel": { + "description": "A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.", + "type": "boolean" + }, + "Name": { + "description": "The name of the control panel. You can use any non-white space character in the name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "RoutingControlCount": { + "description": "Count of associated routing controls", + "type": "integer" + }, + "Status": { + "description": "The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", + "enum": [ + "PENDING", + "DEPLOYED", + "PENDING_DELETION" + ], + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ControlPanelArn", + "/properties/Status", + "/properties/RoutingControlCount", + "/properties/DefaultControlPanel" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53RecoveryControl::ControlPanel", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-route53recoverycontrol-routingcontrol.json b/schema/aws-route53recoverycontrol-routingcontrol.json index b7107cc..1c6443c 100644 --- a/schema/aws-route53recoverycontrol-routingcontrol.json +++ b/schema/aws-route53recoverycontrol-routingcontrol.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ControlPanelArn", - "/properties/ClusterArn" - ], - "definitions": {}, - "description": "AWS Route53 Recovery Control Routing Control resource schema .", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-control-config:CreateRoutingControl", - "route53-recovery-control-config:DescribeRoutingControl", - "route53-recovery-control-config:DescribeControlPanel", - "route53-recovery-control-config:DescribeCluster" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-control-config:DescribeRoutingControl", - "route53-recovery-control-config:DeleteRoutingControl" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ControlPanelArn": { - "$ref": "resource-schema.json#/properties/ControlPanelArn" - } - }, - "required": [ - "ControlPanelArn" - ] - }, - "permissions": [ - "route53-recovery-control-config:ListRoutingControls" - ] - }, - "read": { - "permissions": [ - "route53-recovery-control-config:DescribeRoutingControl" - ] - }, - "update": { - "permissions": [ - "route53-recovery-control-config:UpdateRoutingControl", - "route53-recovery-control-config:DescribeRoutingControl", - "route53-recovery-control-config:DescribeControlPanel" - ] - } - }, - "primaryIdentifier": [ - "/properties/RoutingControlArn" - ], - "properties": { - "ClusterArn": { - "description": "Arn associated with Control Panel", - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "ControlPanelArn": { - "description": "The Amazon Resource Name (ARN) of the control panel.", - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "Name": { - "description": "The name of the routing control. You can use any non-white space character in the name.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "RoutingControlArn": { - "description": "The Amazon Resource Name (ARN) of the routing control.", - "pattern": "^[A-Za-z0-9:\\/_-]*$", - "type": "string" - }, - "Status": { - "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", - "enum": [ - "PENDING", - "DEPLOYED", - "PENDING_DELETION" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/RoutingControlArn", - "/properties/Status" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Route53RecoveryControl::RoutingControl", - "writeOnlyProperties": [ - "/properties/ClusterArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ControlPanelArn", + "/properties/ClusterArn" + ], + "definitions": {}, + "description": "AWS Route53 Recovery Control Routing Control resource schema .", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-control-config:CreateRoutingControl", + "route53-recovery-control-config:DescribeRoutingControl", + "route53-recovery-control-config:DescribeControlPanel", + "route53-recovery-control-config:DescribeCluster" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-control-config:DescribeRoutingControl", + "route53-recovery-control-config:DeleteRoutingControl" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ControlPanelArn": { + "$ref": "resource-schema.json#/properties/ControlPanelArn" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "permissions": [ + "route53-recovery-control-config:ListRoutingControls" + ] + }, + "read": { + "permissions": [ + "route53-recovery-control-config:DescribeRoutingControl" + ] + }, + "update": { + "permissions": [ + "route53-recovery-control-config:UpdateRoutingControl", + "route53-recovery-control-config:DescribeRoutingControl", + "route53-recovery-control-config:DescribeControlPanel" + ] + } + }, + "primaryIdentifier": [ + "/properties/RoutingControlArn" + ], + "properties": { + "ClusterArn": { + "description": "Arn associated with Control Panel", + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "ControlPanelArn": { + "description": "The Amazon Resource Name (ARN) of the control panel.", + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "Name": { + "description": "The name of the routing control. You can use any non-white space character in the name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "RoutingControlArn": { + "description": "The Amazon Resource Name (ARN) of the routing control.", + "pattern": "^[A-Za-z0-9:\\/_-]*$", + "type": "string" + }, + "Status": { + "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", + "enum": [ + "PENDING", + "DEPLOYED", + "PENDING_DELETION" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/RoutingControlArn", + "/properties/Status" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Route53RecoveryControl::RoutingControl", + "writeOnlyProperties": [ + "/properties/ClusterArn" + ] +} diff --git a/schema/aws-route53recoverycontrol-safetyrule.json b/schema/aws-route53recoverycontrol-safetyrule.json index 36af023..ff00444 100644 --- a/schema/aws-route53recoverycontrol-safetyrule.json +++ b/schema/aws-route53recoverycontrol-safetyrule.json @@ -1,250 +1,250 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/ControlPanelArn", - "/properties/RuleConfig", - "/properties/Tags", - "/properties/AssertionRule/AssertedControls", - "/properties/GatingRule/GatingControls", - "/properties/GatingRule/TargetControls" - ], - "definitions": { - "AssertionRule": { - "additionalProperties": false, - "description": "An assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.", - "properties": { - "AssertedControls": { - "description": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "WaitPeriodMs": { - "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.", - "type": "integer" - } - }, - "required": [ - "AssertedControls", - "WaitPeriodMs" - ], - "type": "object" - }, - "GatingRule": { - "additionalProperties": false, - "description": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.", - "properties": { - "GatingControls": { - "description": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "TargetControls": { - "description": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three AWS Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true. \nIn other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "WaitPeriodMs": { - "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.", - "type": "integer" - } - }, - "required": [ - "WaitPeriodMs", - "TargetControls", - "GatingControls" - ], - "type": "object" - }, - "RuleConfig": { - "additionalProperties": false, - "description": "The rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.", - "properties": { - "Inverted": { - "description": "Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.", - "type": "boolean" - }, - "Threshold": { - "description": "The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.", - "type": "integer" - }, - "Type": { - "$ref": "#/definitions/RuleType" - } - }, - "required": [ - "Type", - "Threshold", - "Inverted" - ], - "type": "object" - }, - "RuleType": { - "description": "A rule can be one of the following: ATLEAST, AND, or OR.", - "enum": [ - "AND", - "OR", - "ATLEAST" - ], - "type": "string" - }, - "SafetyRuleName": { - "description": "The name for the safety rule.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS Route53 Recovery Control basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-control-config:CreateSafetyRule", - "route53-recovery-control-config:DescribeSafetyRule", - "route53-recovery-control-config:DescribeControlPanel", - "route53-recovery-control-config:DescribeRoutingControl", - "route53-recovery-control-config:ListTagsForResource", - "route53-recovery-control-config:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-control-config:DescribeSafetyRule", - "route53-recovery-control-config:DeleteSafetyRule" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ControlPanelArn": { - "$ref": "resource-schema.json#/properties/ControlPanelArn" - } - }, - "required": [ - "ControlPanelArn" - ] - }, - "permissions": [ - "route53-recovery-control-config:ListSafetyRules" - ] - }, - "read": { - "permissions": [ - "route53-recovery-control-config:DescribeSafetyRule", - "route53-recovery-control-config:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53-recovery-control-config:UpdateSafetyRule", - "route53-recovery-control-config:DescribeSafetyRule", - "route53-recovery-control-config:ListTagsForResource", - "route53-recovery-control-config:TagResource", - "route53-recovery-control-config:UntagResource" - ] - } - }, - "oneOf": [ - { - "required": [ - "AssertionRule", - "Name", - "ControlPanelArn", - "RuleConfig" - ] - }, - { - "required": [ - "GatingRule", - "Name", - "ControlPanelArn", - "RuleConfig" - ] - } - ], - "primaryIdentifier": [ - "/properties/SafetyRuleArn" - ], - "properties": { - "AssertionRule": { - "$ref": "#/definitions/AssertionRule" - }, - "ControlPanelArn": { - "description": "The Amazon Resource Name (ARN) of the control panel.", - "type": "string" - }, - "GatingRule": { - "$ref": "#/definitions/GatingRule" - }, - "Name": { - "$ref": "#/definitions/SafetyRuleName" - }, - "RuleConfig": { - "$ref": "#/definitions/RuleConfig" - }, - "SafetyRuleArn": { - "description": "The Amazon Resource Name (ARN) of the safety rule.", - "type": "string" - }, - "Status": { - "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", - "enum": [ - "PENDING", - "DEPLOYED", - "PENDING_DELETION" - ], - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/SafetyRuleArn", - "/properties/Status" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53RecoveryControl::SafetyRule", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/ControlPanelArn", + "/properties/RuleConfig", + "/properties/Tags", + "/properties/AssertionRule/AssertedControls", + "/properties/GatingRule/GatingControls", + "/properties/GatingRule/TargetControls" + ], + "definitions": { + "AssertionRule": { + "additionalProperties": false, + "description": "An assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.", + "properties": { + "AssertedControls": { + "description": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "WaitPeriodMs": { + "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.", + "type": "integer" + } + }, + "required": [ + "AssertedControls", + "WaitPeriodMs" + ], + "type": "object" + }, + "GatingRule": { + "additionalProperties": false, + "description": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.", + "properties": { + "GatingControls": { + "description": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "TargetControls": { + "description": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three AWS Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true. \nIn other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "WaitPeriodMs": { + "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.", + "type": "integer" + } + }, + "required": [ + "WaitPeriodMs", + "TargetControls", + "GatingControls" + ], + "type": "object" + }, + "RuleConfig": { + "additionalProperties": false, + "description": "The rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.", + "properties": { + "Inverted": { + "description": "Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.", + "type": "boolean" + }, + "Threshold": { + "description": "The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.", + "type": "integer" + }, + "Type": { + "$ref": "#/definitions/RuleType" + } + }, + "required": [ + "Type", + "Threshold", + "Inverted" + ], + "type": "object" + }, + "RuleType": { + "description": "A rule can be one of the following: ATLEAST, AND, or OR.", + "enum": [ + "AND", + "OR", + "ATLEAST" + ], + "type": "string" + }, + "SafetyRuleName": { + "description": "The name for the safety rule.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS Route53 Recovery Control basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-control-config:CreateSafetyRule", + "route53-recovery-control-config:DescribeSafetyRule", + "route53-recovery-control-config:DescribeControlPanel", + "route53-recovery-control-config:DescribeRoutingControl", + "route53-recovery-control-config:ListTagsForResource", + "route53-recovery-control-config:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-control-config:DescribeSafetyRule", + "route53-recovery-control-config:DeleteSafetyRule" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ControlPanelArn": { + "$ref": "resource-schema.json#/properties/ControlPanelArn" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "permissions": [ + "route53-recovery-control-config:ListSafetyRules" + ] + }, + "read": { + "permissions": [ + "route53-recovery-control-config:DescribeSafetyRule", + "route53-recovery-control-config:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53-recovery-control-config:UpdateSafetyRule", + "route53-recovery-control-config:DescribeSafetyRule", + "route53-recovery-control-config:ListTagsForResource", + "route53-recovery-control-config:TagResource", + "route53-recovery-control-config:UntagResource" + ] + } + }, + "oneOf": [ + { + "required": [ + "AssertionRule", + "Name", + "ControlPanelArn", + "RuleConfig" + ] + }, + { + "required": [ + "GatingRule", + "Name", + "ControlPanelArn", + "RuleConfig" + ] + } + ], + "primaryIdentifier": [ + "/properties/SafetyRuleArn" + ], + "properties": { + "AssertionRule": { + "$ref": "#/definitions/AssertionRule" + }, + "ControlPanelArn": { + "description": "The Amazon Resource Name (ARN) of the control panel.", + "type": "string" + }, + "GatingRule": { + "$ref": "#/definitions/GatingRule" + }, + "Name": { + "$ref": "#/definitions/SafetyRuleName" + }, + "RuleConfig": { + "$ref": "#/definitions/RuleConfig" + }, + "SafetyRuleArn": { + "description": "The Amazon Resource Name (ARN) of the safety rule.", + "type": "string" + }, + "Status": { + "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.", + "enum": [ + "PENDING", + "DEPLOYED", + "PENDING_DELETION" + ], + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/SafetyRuleArn", + "/properties/Status" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53RecoveryControl::SafetyRule", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-route53recoveryreadiness-cell.json b/schema/aws-route53recoveryreadiness-cell.json index 8e2eda8..b49bf05 100644 --- a/schema/aws-route53recoveryreadiness-cell.json +++ b/schema/aws-route53recoveryreadiness-cell.json @@ -1,111 +1,111 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CellName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The API Schema for AWS Route53 Recovery Readiness Cells.", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-readiness:CreateCell", - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-readiness:DeleteCell", - "route53-recovery-readiness:GetCell" - ] - }, - "list": { - "permissions": [ - "route53-recovery-readiness:ListCells" - ] - }, - "read": { - "permissions": [ - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource", - "route53-recovery-readiness:UntagResource", - "route53-recovery-readiness:UpdateCell" - ] - } - }, - "primaryIdentifier": [ - "/properties/CellName" - ], - "properties": { - "CellArn": { - "description": "The Amazon Resource Name (ARN) of the cell.", - "maxLength": 256, - "type": "string" - }, - "CellName": { - "description": "The name of the cell to create.", - "maxLength": 64, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Cells": { - "description": "A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "ParentReadinessScopes": { - "description": "The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "Tags": { - "description": "A collection of tags associated with a resource", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CellArn", - "/properties/ParentReadinessScopes" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-reoute53-recovery-readiness.git", - "taggable": true, - "typeName": "AWS::Route53RecoveryReadiness::Cell" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CellName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The API Schema for AWS Route53 Recovery Readiness Cells.", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-readiness:CreateCell", + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-readiness:DeleteCell", + "route53-recovery-readiness:GetCell" + ] + }, + "list": { + "permissions": [ + "route53-recovery-readiness:ListCells" + ] + }, + "read": { + "permissions": [ + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource", + "route53-recovery-readiness:UntagResource", + "route53-recovery-readiness:UpdateCell" + ] + } + }, + "primaryIdentifier": [ + "/properties/CellName" + ], + "properties": { + "CellArn": { + "description": "The Amazon Resource Name (ARN) of the cell.", + "maxLength": 256, + "type": "string" + }, + "CellName": { + "description": "The name of the cell to create.", + "maxLength": 64, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Cells": { + "description": "A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "ParentReadinessScopes": { + "description": "The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CellArn", + "/properties/ParentReadinessScopes" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-reoute53-recovery-readiness.git", + "taggable": true, + "typeName": "AWS::Route53RecoveryReadiness::Cell" +} diff --git a/schema/aws-route53recoveryreadiness-readinesscheck.json b/schema/aws-route53recoveryreadiness-readinesscheck.json index 84b4fc7..8ea754a 100644 --- a/schema/aws-route53recoveryreadiness-readinesscheck.json +++ b/schema/aws-route53recoveryreadiness-readinesscheck.json @@ -1,103 +1,103 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ReadinessCheckName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Aws Route53 Recovery Readiness Check Schema and API specification.", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-readiness:CreateReadinessCheck", - "route53-recovery-readiness:GetResourceSet", - "route53-recovery-readiness:GetReadinessCheck", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-readiness:DeleteReadinessCheck", - "route53-recovery-readiness:GetReadinessCheck" - ] - }, - "list": { - "permissions": [ - "route53-recovery-readiness:ListReadinessChecks", - "route53-recovery-readiness:GetReadinessChecks" - ] - }, - "read": { - "permissions": [ - "route53-recovery-readiness:GetReadinessCheck", - "route53-recovery-readiness:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "route53-recovery-readiness:UpdateReadinessCheck", - "route53-recovery-readiness:GetResourceSet", - "route53-recovery-readiness:GetReadinessCheck", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource", - "route53-recovery-readiness:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ReadinessCheckName" - ], - "properties": { - "ReadinessCheckArn": { - "description": "The Amazon Resource Name (ARN) of the readiness check.", - "maxLength": 256, - "type": "string" - }, - "ReadinessCheckName": { - "description": "Name of the ReadinessCheck to create.", - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "ResourceSetName": { - "description": "The name of the resource set to check.", - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ReadinessCheckArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness.git", - "taggable": true, - "typeName": "AWS::Route53RecoveryReadiness::ReadinessCheck" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ReadinessCheckName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Aws Route53 Recovery Readiness Check Schema and API specification.", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-readiness:CreateReadinessCheck", + "route53-recovery-readiness:GetResourceSet", + "route53-recovery-readiness:GetReadinessCheck", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-readiness:DeleteReadinessCheck", + "route53-recovery-readiness:GetReadinessCheck" + ] + }, + "list": { + "permissions": [ + "route53-recovery-readiness:ListReadinessChecks", + "route53-recovery-readiness:GetReadinessChecks" + ] + }, + "read": { + "permissions": [ + "route53-recovery-readiness:GetReadinessCheck", + "route53-recovery-readiness:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "route53-recovery-readiness:UpdateReadinessCheck", + "route53-recovery-readiness:GetResourceSet", + "route53-recovery-readiness:GetReadinessCheck", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource", + "route53-recovery-readiness:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ReadinessCheckName" + ], + "properties": { + "ReadinessCheckArn": { + "description": "The Amazon Resource Name (ARN) of the readiness check.", + "maxLength": 256, + "type": "string" + }, + "ReadinessCheckName": { + "description": "Name of the ReadinessCheck to create.", + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "ResourceSetName": { + "description": "The name of the resource set to check.", + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ReadinessCheckArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness.git", + "taggable": true, + "typeName": "AWS::Route53RecoveryReadiness::ReadinessCheck" +} diff --git a/schema/aws-route53recoveryreadiness-recoverygroup.json b/schema/aws-route53recoveryreadiness-recoverygroup.json index 746e6ee..f0991d1 100644 --- a/schema/aws-route53recoveryreadiness-recoverygroup.json +++ b/schema/aws-route53recoveryreadiness-recoverygroup.json @@ -1,106 +1,106 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RecoveryGroupName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "AWS Route53 Recovery Readiness Recovery Group Schema and API specifications.", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-readiness:CreateRecoveryGroup", - "route53-recovery-readiness:GetRecoveryGroup", - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-readiness:DeleteRecoveryGroup", - "route53-recovery-readiness:GetRecoveryGroup" - ] - }, - "list": { - "permissions": [ - "route53-recovery-readiness:ListRecoveryGroups" - ] - }, - "read": { - "permissions": [ - "route53-recovery-readiness:GetRecoveryGroup", - "route53-recovery-readiness:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "route53-recovery-readiness:UpdateRecoveryGroup", - "route53-recovery-readiness:GetRecoveryGroup", - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource", - "route53-recovery-readiness:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RecoveryGroupName" - ], - "properties": { - "Cells": { - "description": "A list of the cell Amazon Resource Names (ARNs) in the recovery group.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 5, - "type": "array" - }, - "RecoveryGroupArn": { - "description": "A collection of tags associated with a resource.", - "maxLength": 256, - "type": "string" - }, - "RecoveryGroupName": { - "description": "The name of the recovery group to create.", - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_]+", - "type": "string" - }, - "Tags": { - "description": "A collection of tags associated with a resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RecoveryGroupArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness-readiness.git", - "taggable": true, - "typeName": "AWS::Route53RecoveryReadiness::RecoveryGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RecoveryGroupName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "AWS Route53 Recovery Readiness Recovery Group Schema and API specifications.", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-readiness:CreateRecoveryGroup", + "route53-recovery-readiness:GetRecoveryGroup", + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-readiness:DeleteRecoveryGroup", + "route53-recovery-readiness:GetRecoveryGroup" + ] + }, + "list": { + "permissions": [ + "route53-recovery-readiness:ListRecoveryGroups" + ] + }, + "read": { + "permissions": [ + "route53-recovery-readiness:GetRecoveryGroup", + "route53-recovery-readiness:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "route53-recovery-readiness:UpdateRecoveryGroup", + "route53-recovery-readiness:GetRecoveryGroup", + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource", + "route53-recovery-readiness:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RecoveryGroupName" + ], + "properties": { + "Cells": { + "description": "A list of the cell Amazon Resource Names (ARNs) in the recovery group.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 5, + "type": "array" + }, + "RecoveryGroupArn": { + "description": "A collection of tags associated with a resource.", + "maxLength": 256, + "type": "string" + }, + "RecoveryGroupName": { + "description": "The name of the recovery group to create.", + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_]+", + "type": "string" + }, + "Tags": { + "description": "A collection of tags associated with a resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RecoveryGroupArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness-readiness.git", + "taggable": true, + "typeName": "AWS::Route53RecoveryReadiness::RecoveryGroup" +} diff --git a/schema/aws-route53recoveryreadiness-resourceset.json b/schema/aws-route53recoveryreadiness-resourceset.json index 37526fa..a7d514d 100644 --- a/schema/aws-route53recoveryreadiness-resourceset.json +++ b/schema/aws-route53recoveryreadiness-resourceset.json @@ -1,218 +1,218 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceSetName", - "/properties/ResourceSetType" - ], - "definitions": { - "DNSTargetResource": { - "additionalProperties": false, - "description": "A component for DNS/routing control readiness checks.", - "properties": { - "DomainName": { - "description": "The domain name that acts as an ingress point to a portion of the customer application.", - "type": "string" - }, - "HostedZoneArn": { - "description": "The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.", - "type": "string" - }, - "RecordSetId": { - "description": "The Route 53 record set ID that will uniquely identify a DNS record, given a name and a type.", - "type": "string" - }, - "RecordType": { - "description": "The type of DNS record of the target resource.", - "type": "string" - }, - "TargetResource": { - "$ref": "#/definitions/TargetResource" - } - }, - "type": "object" - }, - "NLBResource": { - "additionalProperties": false, - "description": "The Network Load Balancer resource that a DNS target resource points to.", - "properties": { - "Arn": { - "description": "A Network Load Balancer resource Amazon Resource Name (ARN).", - "type": "string" - } - }, - "type": "object" - }, - "R53ResourceRecord": { - "additionalProperties": false, - "description": "The Route 53 resource that a DNS target resource record points to.", - "properties": { - "DomainName": { - "description": "The DNS target domain name.", - "type": "string" - }, - "RecordSetId": { - "description": "The Resource Record set id.", - "type": "string" - } - }, - "type": "object" - }, - "Resource": { - "additionalProperties": false, - "description": "The resource element of a ResourceSet", - "properties": { - "ComponentId": { - "description": "The component identifier of the resource, generated when DNS target resource is used.", - "type": "string" - }, - "DnsTargetResource": { - "$ref": "#/definitions/DNSTargetResource" - }, - "ReadinessScopes": { - "description": "A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.", - "insertionOrder": false, - "items": { - "maxItems": 5, - "type": "string" - }, - "type": "array" - }, - "ResourceArn": { - "description": "The Amazon Resource Name (ARN) of the AWS resource.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetResource": { - "additionalProperties": false, - "description": "The target resource that the Route 53 record points to.", - "oneOf": [ - { - "required": [ - "NLBResource" - ] - }, - { - "required": [ - "R53Resource" - ] - } - ], - "properties": { - "NLBResource": { - "$ref": "#/definitions/NLBResource" - }, - "R53Resource": { - "$ref": "#/definitions/R53ResourceRecord" - } - }, - "type": "object" - } - }, - "description": "Schema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.", - "handlers": { - "create": { - "permissions": [ - "route53-recovery-readiness:CreateResourceSet", - "route53-recovery-readiness:GetResourceSet", - "route53-recovery-readiness:GetRecoveryGroup", - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53-recovery-readiness:DeleteResourceSet", - "route53-recovery-readiness:GetResourceSet" - ] - }, - "list": { - "permissions": [ - "route53-recovery-readiness:ListResourceSets" - ] - }, - "read": { - "permissions": [ - "route53-recovery-readiness:GetResourceSet", - "route53-recovery-readiness:ListTagsForResources" - ] - }, - "update": { - "permissions": [ - "route53-recovery-readiness:UpdateResourceSet", - "route53-recovery-readiness:GetResourceSet", - "route53-recovery-readiness:GetRecoveryGroup", - "route53-recovery-readiness:GetCell", - "route53-recovery-readiness:ListTagsForResources", - "route53-recovery-readiness:TagResource", - "route53-recovery-readiness:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceSetName" - ], - "properties": { - "ResourceSetArn": { - "description": "The Amazon Resource Name (ARN) of the resource set.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ResourceSetName": { - "description": "The name of the resource set to create.", - "type": "string" - }, - "ResourceSetType": { - "description": "The resource type of the resources in the resource set. Enter one of the following values for resource type: \n\nAWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource", - "type": "string" - }, - "Resources": { - "description": "A list of resource objects in the resource set.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Resource" - }, - "maxItems": 6, - "minItems": 1, - "type": "array" - }, - "Tags": { - "description": "A tag to associate with the parameters for a resource set.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "maxItems": 20 - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ResourceSetArn" - ], - "required": [ - "ResourceSetType", - "Resources" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness.git", - "taggable": true, - "typeName": "AWS::Route53RecoveryReadiness::ResourceSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceSetName", + "/properties/ResourceSetType" + ], + "definitions": { + "DNSTargetResource": { + "additionalProperties": false, + "description": "A component for DNS/routing control readiness checks.", + "properties": { + "DomainName": { + "description": "The domain name that acts as an ingress point to a portion of the customer application.", + "type": "string" + }, + "HostedZoneArn": { + "description": "The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.", + "type": "string" + }, + "RecordSetId": { + "description": "The Route 53 record set ID that will uniquely identify a DNS record, given a name and a type.", + "type": "string" + }, + "RecordType": { + "description": "The type of DNS record of the target resource.", + "type": "string" + }, + "TargetResource": { + "$ref": "#/definitions/TargetResource" + } + }, + "type": "object" + }, + "NLBResource": { + "additionalProperties": false, + "description": "The Network Load Balancer resource that a DNS target resource points to.", + "properties": { + "Arn": { + "description": "A Network Load Balancer resource Amazon Resource Name (ARN).", + "type": "string" + } + }, + "type": "object" + }, + "R53ResourceRecord": { + "additionalProperties": false, + "description": "The Route 53 resource that a DNS target resource record points to.", + "properties": { + "DomainName": { + "description": "The DNS target domain name.", + "type": "string" + }, + "RecordSetId": { + "description": "The Resource Record set id.", + "type": "string" + } + }, + "type": "object" + }, + "Resource": { + "additionalProperties": false, + "description": "The resource element of a ResourceSet", + "properties": { + "ComponentId": { + "description": "The component identifier of the resource, generated when DNS target resource is used.", + "type": "string" + }, + "DnsTargetResource": { + "$ref": "#/definitions/DNSTargetResource" + }, + "ReadinessScopes": { + "description": "A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.", + "insertionOrder": false, + "items": { + "maxItems": 5, + "type": "string" + }, + "type": "array" + }, + "ResourceArn": { + "description": "The Amazon Resource Name (ARN) of the AWS resource.", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetResource": { + "additionalProperties": false, + "description": "The target resource that the Route 53 record points to.", + "oneOf": [ + { + "required": [ + "NLBResource" + ] + }, + { + "required": [ + "R53Resource" + ] + } + ], + "properties": { + "NLBResource": { + "$ref": "#/definitions/NLBResource" + }, + "R53Resource": { + "$ref": "#/definitions/R53ResourceRecord" + } + }, + "type": "object" + } + }, + "description": "Schema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.", + "handlers": { + "create": { + "permissions": [ + "route53-recovery-readiness:CreateResourceSet", + "route53-recovery-readiness:GetResourceSet", + "route53-recovery-readiness:GetRecoveryGroup", + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53-recovery-readiness:DeleteResourceSet", + "route53-recovery-readiness:GetResourceSet" + ] + }, + "list": { + "permissions": [ + "route53-recovery-readiness:ListResourceSets" + ] + }, + "read": { + "permissions": [ + "route53-recovery-readiness:GetResourceSet", + "route53-recovery-readiness:ListTagsForResources" + ] + }, + "update": { + "permissions": [ + "route53-recovery-readiness:UpdateResourceSet", + "route53-recovery-readiness:GetResourceSet", + "route53-recovery-readiness:GetRecoveryGroup", + "route53-recovery-readiness:GetCell", + "route53-recovery-readiness:ListTagsForResources", + "route53-recovery-readiness:TagResource", + "route53-recovery-readiness:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceSetName" + ], + "properties": { + "ResourceSetArn": { + "description": "The Amazon Resource Name (ARN) of the resource set.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ResourceSetName": { + "description": "The name of the resource set to create.", + "type": "string" + }, + "ResourceSetType": { + "description": "The resource type of the resources in the resource set. Enter one of the following values for resource type: \n\nAWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource", + "type": "string" + }, + "Resources": { + "description": "A list of resource objects in the resource set.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Resource" + }, + "maxItems": 6, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "A tag to associate with the parameters for a resource set.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "maxItems": 20 + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ResourceSetArn" + ], + "required": [ + "ResourceSetType", + "Resources" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-readiness.git", + "taggable": true, + "typeName": "AWS::Route53RecoveryReadiness::ResourceSet" +} diff --git a/schema/aws-route53resolver-firewalldomainlist.json b/schema/aws-route53resolver-firewalldomainlist.json index d983085..86c424b 100644 --- a/schema/aws-route53resolver-firewalldomainlist.json +++ b/schema/aws-route53resolver-firewalldomainlist.json @@ -1,205 +1,205 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Domains": { - "description": "An inline list of domains to use for this domain list.", - "items": { - "description": "FirewallDomainName", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53Resolver::FirewallDomainList.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "delete": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "list": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "read": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "update": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn", - "maxLength": 600, - "minLength": 1, - "type": "string" - }, - "CreationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "CreatorRequestId": { - "description": "The id of the creator request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DomainCount": { - "description": "Count", - "minimum": 0, - "type": "integer" - }, - "DomainFileUrl": { - "description": "S3 URL to import domains from.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Domains": { - "$ref": "#/definitions/Domains" - }, - "Id": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ManagedOwnerName": { - "description": "ServicePrincipal", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "ModificationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "Name": { - "description": "FirewallDomainListName", - "maxLength": 64, - "minLength": 1, - "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", - "type": "string" - }, - "Status": { - "description": "ResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", - "enum": [ - "COMPLETE", - "DELETING", - "UPDATING", - "COMPLETE_IMPORT_FAILED", - "IMPORTING", - "INACTIVE_OWNER_ACCOUNT_CLOSED" - ], - "type": "string" - }, - "StatusMessage": { - "description": "FirewallDomainListAssociationStatus", - "type": "string" - }, - "Tags": { - "description": "Tags", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/DomainCount", - "/properties/Status", - "/properties/StatusMessage", - "/properties/ManagedOwnerName", - "/properties/CreatorRequestId", - "/properties/CreationTime", - "/properties/ModificationTime" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Resolver::FirewallDomainList", - "writeOnlyProperties": [ - "/properties/Domains", - "/properties/DomainFileUrl" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Domains": { + "description": "An inline list of domains to use for this domain list.", + "items": { + "description": "FirewallDomainName", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53Resolver::FirewallDomainList.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "delete": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "list": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "read": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "update": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn", + "maxLength": 600, + "minLength": 1, + "type": "string" + }, + "CreationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "CreatorRequestId": { + "description": "The id of the creator request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DomainCount": { + "description": "Count", + "minimum": 0, + "type": "integer" + }, + "DomainFileUrl": { + "description": "S3 URL to import domains from.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Domains": { + "$ref": "#/definitions/Domains" + }, + "Id": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ManagedOwnerName": { + "description": "ServicePrincipal", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "ModificationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "Name": { + "description": "FirewallDomainListName", + "maxLength": 64, + "minLength": 1, + "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", + "type": "string" + }, + "Status": { + "description": "ResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", + "enum": [ + "COMPLETE", + "DELETING", + "UPDATING", + "COMPLETE_IMPORT_FAILED", + "IMPORTING", + "INACTIVE_OWNER_ACCOUNT_CLOSED" + ], + "type": "string" + }, + "StatusMessage": { + "description": "FirewallDomainListAssociationStatus", + "type": "string" + }, + "Tags": { + "description": "Tags", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/DomainCount", + "/properties/Status", + "/properties/StatusMessage", + "/properties/ManagedOwnerName", + "/properties/CreatorRequestId", + "/properties/CreationTime", + "/properties/ModificationTime" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Resolver::FirewallDomainList", + "writeOnlyProperties": [ + "/properties/Domains", + "/properties/DomainFileUrl" + ] +} diff --git a/schema/aws-route53resolver-firewallrulegroup.json b/schema/aws-route53resolver-firewallrulegroup.json index 36e7973..b309e59 100644 --- a/schema/aws-route53resolver-firewallrulegroup.json +++ b/schema/aws-route53resolver-firewallrulegroup.json @@ -1,270 +1,270 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FirewallRule": { - "additionalProperties": false, - "description": "Firewall Rule associating the Rule Group to a Domain List", - "properties": { - "Action": { - "description": "Rule Action", - "enum": [ - "ALLOW", - "BLOCK", - "ALERT" - ], - "type": "string" - }, - "BlockOverrideDnsType": { - "description": "BlockOverrideDnsType", - "enum": [ - "CNAME" - ], - "type": "string" - }, - "BlockOverrideDomain": { - "description": "BlockOverrideDomain", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "BlockOverrideTtl": { - "description": "BlockOverrideTtl", - "maximum": 604800, - "minimum": 0, - "type": "integer" - }, - "BlockResponse": { - "description": "BlockResponse", - "enum": [ - "NODATA", - "NXDOMAIN", - "OVERRIDE" - ], - "type": "string" - }, - "FirewallDomainListId": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "FirewallDomainRedirectionAction": { - "description": "FirewallDomainRedirectionAction", - "enum": [ - "INSPECT_REDIRECTION_DOMAIN", - "TRUST_REDIRECTION_DOMAIN" - ], - "type": "string" - }, - "Priority": { - "description": "Rule Priority", - "type": "integer" - }, - "Qtype": { - "description": "Qtype", - "maxLength": 16, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "FirewallDomainListId", - "Priority", - "Action" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53Resolver::FirewallRuleGroup.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "delete": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "list": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "read": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "update": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn", - "maxLength": 600, - "minLength": 1, - "type": "string" - }, - "CreationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "CreatorRequestId": { - "description": "The id of the creator request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "FirewallRules": { - "description": "FirewallRules", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ModificationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "Name": { - "description": "FirewallRuleGroupName", - "maxLength": 64, - "minLength": 1, - "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", - "type": "string" - }, - "OwnerId": { - "description": "AccountId", - "maxLength": 32, - "minLength": 12, - "type": "string" - }, - "RuleCount": { - "description": "Count", - "type": "integer" - }, - "ShareStatus": { - "description": "ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.", - "enum": [ - "NOT_SHARED", - "SHARED_WITH_ME", - "SHARED_BY_ME" - ], - "type": "string" - }, - "Status": { - "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", - "enum": [ - "COMPLETE", - "DELETING", - "UPDATING", - "INACTIVE_OWNER_ACCOUNT_CLOSED" - ], - "type": "string" - }, - "StatusMessage": { - "description": "FirewallRuleGroupStatus", - "type": "string" - }, - "Tags": { - "description": "Tags", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/RuleCount", - "/properties/Status", - "/properties/StatusMessage", - "/properties/OwnerId", - "/properties/ShareStatus", - "/properties/CreatorRequestId", - "/properties/CreationTime", - "/properties/ModificationTime" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Resolver::FirewallRuleGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FirewallRule": { + "additionalProperties": false, + "description": "Firewall Rule associating the Rule Group to a Domain List", + "properties": { + "Action": { + "description": "Rule Action", + "enum": [ + "ALLOW", + "BLOCK", + "ALERT" + ], + "type": "string" + }, + "BlockOverrideDnsType": { + "description": "BlockOverrideDnsType", + "enum": [ + "CNAME" + ], + "type": "string" + }, + "BlockOverrideDomain": { + "description": "BlockOverrideDomain", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "BlockOverrideTtl": { + "description": "BlockOverrideTtl", + "maximum": 604800, + "minimum": 0, + "type": "integer" + }, + "BlockResponse": { + "description": "BlockResponse", + "enum": [ + "NODATA", + "NXDOMAIN", + "OVERRIDE" + ], + "type": "string" + }, + "FirewallDomainListId": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "FirewallDomainRedirectionAction": { + "description": "FirewallDomainRedirectionAction", + "enum": [ + "INSPECT_REDIRECTION_DOMAIN", + "TRUST_REDIRECTION_DOMAIN" + ], + "type": "string" + }, + "Priority": { + "description": "Rule Priority", + "type": "integer" + }, + "Qtype": { + "description": "Qtype", + "maxLength": 16, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "FirewallDomainListId", + "Priority", + "Action" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53Resolver::FirewallRuleGroup.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "delete": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "list": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "read": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "update": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn", + "maxLength": 600, + "minLength": 1, + "type": "string" + }, + "CreationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "CreatorRequestId": { + "description": "The id of the creator request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "FirewallRules": { + "description": "FirewallRules", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ModificationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "Name": { + "description": "FirewallRuleGroupName", + "maxLength": 64, + "minLength": 1, + "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", + "type": "string" + }, + "OwnerId": { + "description": "AccountId", + "maxLength": 32, + "minLength": 12, + "type": "string" + }, + "RuleCount": { + "description": "Count", + "type": "integer" + }, + "ShareStatus": { + "description": "ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.", + "enum": [ + "NOT_SHARED", + "SHARED_WITH_ME", + "SHARED_BY_ME" + ], + "type": "string" + }, + "Status": { + "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", + "enum": [ + "COMPLETE", + "DELETING", + "UPDATING", + "INACTIVE_OWNER_ACCOUNT_CLOSED" + ], + "type": "string" + }, + "StatusMessage": { + "description": "FirewallRuleGroupStatus", + "type": "string" + }, + "Tags": { + "description": "Tags", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/RuleCount", + "/properties/Status", + "/properties/StatusMessage", + "/properties/OwnerId", + "/properties/ShareStatus", + "/properties/CreatorRequestId", + "/properties/CreationTime", + "/properties/ModificationTime" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Resolver::FirewallRuleGroup" +} diff --git a/schema/aws-route53resolver-firewallrulegroupassociation.json b/schema/aws-route53resolver-firewallrulegroupassociation.json index a25cd76..712e331 100644 --- a/schema/aws-route53resolver-firewallrulegroupassociation.json +++ b/schema/aws-route53resolver-firewallrulegroupassociation.json @@ -1,203 +1,203 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FirewallRuleGroupId", - "/properties/VpcId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 127, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 255, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "delete": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "list": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "read": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - }, - "update": { - "permissions": [ - "route53resolver:*", - "ec2:*", - "logs:*", - "iam:*", - "lambda:*", - "s3:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn", - "maxLength": 600, - "minLength": 1, - "type": "string" - }, - "CreationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "CreatorRequestId": { - "description": "The id of the creator request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "FirewallRuleGroupId": { - "description": "FirewallRuleGroupId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "Id", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ManagedOwnerName": { - "description": "ServicePrincipal", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "ModificationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "MutationProtection": { - "description": "MutationProtectionStatus", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Name": { - "description": "FirewallRuleGroupAssociationName", - "maxLength": 64, - "minLength": 0, - "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", - "type": "string" - }, - "Priority": { - "description": "Priority", - "type": "integer" - }, - "Status": { - "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", - "enum": [ - "COMPLETE", - "DELETING", - "UPDATING", - "INACTIVE_OWNER_ACCOUNT_CLOSED" - ], - "type": "string" - }, - "StatusMessage": { - "description": "FirewallDomainListAssociationStatus", - "type": "string" - }, - "Tags": { - "description": "Tags", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "description": "VpcId", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/ManagedOwnerName", - "/properties/Status", - "/properties/StatusMessage", - "/properties/CreatorRequestId", - "/properties/CreationTime", - "/properties/ModificationTime" - ], - "required": [ - "FirewallRuleGroupId", - "VpcId", - "Priority" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Resolver::FirewallRuleGroupAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FirewallRuleGroupId", + "/properties/VpcId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "delete": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "list": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "read": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + }, + "update": { + "permissions": [ + "route53resolver:*", + "ec2:*", + "logs:*", + "iam:*", + "lambda:*", + "s3:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn", + "maxLength": 600, + "minLength": 1, + "type": "string" + }, + "CreationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "CreatorRequestId": { + "description": "The id of the creator request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "FirewallRuleGroupId": { + "description": "FirewallRuleGroupId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "Id", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ManagedOwnerName": { + "description": "ServicePrincipal", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "ModificationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "MutationProtection": { + "description": "MutationProtectionStatus", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Name": { + "description": "FirewallRuleGroupAssociationName", + "maxLength": 64, + "minLength": 0, + "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", + "type": "string" + }, + "Priority": { + "description": "Priority", + "type": "integer" + }, + "Status": { + "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.", + "enum": [ + "COMPLETE", + "DELETING", + "UPDATING", + "INACTIVE_OWNER_ACCOUNT_CLOSED" + ], + "type": "string" + }, + "StatusMessage": { + "description": "FirewallDomainListAssociationStatus", + "type": "string" + }, + "Tags": { + "description": "Tags", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "description": "VpcId", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/ManagedOwnerName", + "/properties/Status", + "/properties/StatusMessage", + "/properties/CreatorRequestId", + "/properties/CreationTime", + "/properties/ModificationTime" + ], + "required": [ + "FirewallRuleGroupId", + "VpcId", + "Priority" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Resolver::FirewallRuleGroupAssociation" +} diff --git a/schema/aws-route53resolver-outpostresolver.json b/schema/aws-route53resolver-outpostresolver.json index c2e4703..42af6d0 100644 --- a/schema/aws-route53resolver-outpostresolver.json +++ b/schema/aws-route53resolver-outpostresolver.json @@ -1,179 +1,179 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OutpostArn" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::Route53Resolver::OutpostResolver.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:CreateOutpostResolver", - "route53resolver:GetOutpostResolver", - "route53resolver:ListTagsForResource", - "outposts:GetOutpost" - ] - }, - "delete": { - "permissions": [ - "route53resolver:DeleteOutpostResolver", - "route53resolver:GetOutpostResolver", - "route53resolver:ListOutpostResolvers", - "route53resolver:ListResolverEndpoints" - ] - }, - "list": { - "permissions": [ - "route53resolver:ListOutpostResolvers", - "route53resolver:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "route53resolver:GetOutpostResolver", - "route53resolver:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53resolver:UpdateOutpostResolver", - "route53resolver:GetOutpostResolver", - "route53resolver:UntagResource", - "route53resolver:TagResource", - "route53resolver:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "The OutpostResolver ARN.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "CreationTime": { - "description": "The OutpostResolver creation time", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "CreatorRequestId": { - "description": "The id of the creator request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "Id", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "InstanceCount": { - "description": "The number of OutpostResolvers.", - "maximum": 256, - "minimum": 4, - "type": "integer" - }, - "ModificationTime": { - "description": "The OutpostResolver last modified time", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "Name": { - "description": "The OutpostResolver name.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "OutpostArn": { - "description": "The Outpost ARN.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "PreferredInstanceType": { - "description": "The OutpostResolver instance type.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Status": { - "description": "The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.", - "enum": [ - "CREATING", - "OPERATIONAL", - "DELETING", - "UPDATING", - "ACTION_NEEDED", - "FAILED_CREATION", - "FAILED_DELETION" - ], - "type": "string" - }, - "StatusMessage": { - "description": "The OutpostResolver status message.", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/Status", - "/properties/StatusMessage", - "/properties/CreationTime", - "/properties/ModificationTime", - "/properties/CreatorRequestId" - ], - "required": [ - "OutpostArn", - "PreferredInstanceType", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Resolver::OutpostResolver" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OutpostArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::Route53Resolver::OutpostResolver.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:CreateOutpostResolver", + "route53resolver:GetOutpostResolver", + "route53resolver:ListTagsForResource", + "outposts:GetOutpost" + ] + }, + "delete": { + "permissions": [ + "route53resolver:DeleteOutpostResolver", + "route53resolver:GetOutpostResolver", + "route53resolver:ListOutpostResolvers", + "route53resolver:ListResolverEndpoints" + ] + }, + "list": { + "permissions": [ + "route53resolver:ListOutpostResolvers", + "route53resolver:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53resolver:GetOutpostResolver", + "route53resolver:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53resolver:UpdateOutpostResolver", + "route53resolver:GetOutpostResolver", + "route53resolver:UntagResource", + "route53resolver:TagResource", + "route53resolver:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The OutpostResolver ARN.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "CreationTime": { + "description": "The OutpostResolver creation time", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "CreatorRequestId": { + "description": "The id of the creator request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "Id", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "InstanceCount": { + "description": "The number of OutpostResolvers.", + "maximum": 256, + "minimum": 4, + "type": "integer" + }, + "ModificationTime": { + "description": "The OutpostResolver last modified time", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "Name": { + "description": "The OutpostResolver name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "OutpostArn": { + "description": "The Outpost ARN.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "PreferredInstanceType": { + "description": "The OutpostResolver instance type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Status": { + "description": "The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.", + "enum": [ + "CREATING", + "OPERATIONAL", + "DELETING", + "UPDATING", + "ACTION_NEEDED", + "FAILED_CREATION", + "FAILED_DELETION" + ], + "type": "string" + }, + "StatusMessage": { + "description": "The OutpostResolver status message.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/Status", + "/properties/StatusMessage", + "/properties/CreationTime", + "/properties/ModificationTime", + "/properties/CreatorRequestId" + ], + "required": [ + "OutpostArn", + "PreferredInstanceType", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Resolver::OutpostResolver" +} diff --git a/schema/aws-route53resolver-resolverconfig.json b/schema/aws-route53resolver-resolverconfig.json index 3f701d3..8f5d722 100644 --- a/schema/aws-route53resolver-resolverconfig.json +++ b/schema/aws-route53resolver-resolverconfig.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceId", - "/properties/AutodefinedReverseFlag" - ], - "description": "Resource schema for AWS::Route53Resolver::ResolverConfig.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:UpdateResolverConfig", - "route53resolver:GetResolverConfig", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "route53resolver:UpdateResolverConfig", - "route53resolver:ListResolverConfigs", - "ec2:DescribeVpcs" - ] - }, - "list": { - "permissions": [ - "route53resolver:ListResolverConfigs", - "ec2:DescribeVpcs" - ] - }, - "read": { - "permissions": [ - "route53resolver:GetResolverConfig", - "ec2:DescribeVpcs" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceId" - ], - "properties": { - "AutodefinedReverse": { - "description": "ResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.", - "enum": [ - "ENABLING", - "ENABLED", - "DISABLING", - "DISABLED" - ], - "type": "string" - }, - "AutodefinedReverseFlag": { - "description": "Represents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).", - "enum": [ - "DISABLE" - ], - "type": "string" - }, - "Id": { - "description": "Id", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "OwnerId": { - "description": "AccountId", - "maxLength": 32, - "minLength": 12, - "type": "string" - }, - "ResourceId": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "propertyTransform": { - "/properties/AutodefinedReverseFlag": "$join([AutodefinedReverseFlag, \"D\"])" - }, - "readOnlyProperties": [ - "/properties/OwnerId", - "/properties/Id", - "/properties/AutodefinedReverse" - ], - "required": [ - "ResourceId", - "AutodefinedReverseFlag" - ], - "taggable": false, - "typeName": "AWS::Route53Resolver::ResolverConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceId", + "/properties/AutodefinedReverseFlag" + ], + "description": "Resource schema for AWS::Route53Resolver::ResolverConfig.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:UpdateResolverConfig", + "route53resolver:GetResolverConfig", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "route53resolver:UpdateResolverConfig", + "route53resolver:ListResolverConfigs", + "ec2:DescribeVpcs" + ] + }, + "list": { + "permissions": [ + "route53resolver:ListResolverConfigs", + "ec2:DescribeVpcs" + ] + }, + "read": { + "permissions": [ + "route53resolver:GetResolverConfig", + "ec2:DescribeVpcs" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceId" + ], + "properties": { + "AutodefinedReverse": { + "description": "ResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.", + "enum": [ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ], + "type": "string" + }, + "AutodefinedReverseFlag": { + "description": "Represents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).", + "enum": [ + "DISABLE" + ], + "type": "string" + }, + "Id": { + "description": "Id", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "OwnerId": { + "description": "AccountId", + "maxLength": 32, + "minLength": 12, + "type": "string" + }, + "ResourceId": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "propertyTransform": { + "/properties/AutodefinedReverseFlag": "$join([AutodefinedReverseFlag, \"D\"])" + }, + "readOnlyProperties": [ + "/properties/OwnerId", + "/properties/Id", + "/properties/AutodefinedReverse" + ], + "required": [ + "ResourceId", + "AutodefinedReverseFlag" + ], + "taggable": false, + "typeName": "AWS::Route53Resolver::ResolverConfig" +} diff --git a/schema/aws-route53resolver-resolverdnssecconfig.json b/schema/aws-route53resolver-resolverdnssecconfig.json index 7214922..7a65933 100644 --- a/schema/aws-route53resolver-resolverdnssecconfig.json +++ b/schema/aws-route53resolver-resolverdnssecconfig.json @@ -1,79 +1,79 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceId" - ], - "description": "Resource schema for AWS::Route53Resolver::ResolverDNSSECConfig.", - "handlers": { - "create": { - "permissions": [ - "resolverdnssec:CreateConfig", - "route53resolver:UpdateResolverDnssecConfig", - "route53resolver:GetResolverDnssecConfig", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "resolverdnssec:DeleteConfig", - "route53resolver:UpdateResolverDnssecConfig", - "route53resolver:ListResolverDnssecConfigs", - "ec2:DescribeVpcs" - ] - }, - "list": { - "permissions": [ - "resolverdnssec:ListConfig", - "route53resolver:ListResolverDnssecConfigs" - ] - }, - "read": { - "permissions": [ - "resolverdnssec:GetConfig", - "route53resolver:ListResolverDnssecConfigs" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "Id", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "OwnerId": { - "description": "AccountId", - "maxLength": 32, - "minLength": 12, - "type": "string" - }, - "ResourceId": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ValidationStatus": { - "description": "ResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.", - "enum": [ - "ENABLING", - "ENABLED", - "DISABLING", - "DISABLED" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/OwnerId", - "/properties/Id", - "/properties/ValidationStatus" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::Route53Resolver::ResolverDNSSECConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceId" + ], + "description": "Resource schema for AWS::Route53Resolver::ResolverDNSSECConfig.", + "handlers": { + "create": { + "permissions": [ + "resolverdnssec:CreateConfig", + "route53resolver:UpdateResolverDnssecConfig", + "route53resolver:GetResolverDnssecConfig", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "resolverdnssec:DeleteConfig", + "route53resolver:UpdateResolverDnssecConfig", + "route53resolver:ListResolverDnssecConfigs", + "ec2:DescribeVpcs" + ] + }, + "list": { + "permissions": [ + "resolverdnssec:ListConfig", + "route53resolver:ListResolverDnssecConfigs" + ] + }, + "read": { + "permissions": [ + "resolverdnssec:GetConfig", + "route53resolver:ListResolverDnssecConfigs" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "Id", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "OwnerId": { + "description": "AccountId", + "maxLength": 32, + "minLength": 12, + "type": "string" + }, + "ResourceId": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ValidationStatus": { + "description": "ResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.", + "enum": [ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/OwnerId", + "/properties/Id", + "/properties/ValidationStatus" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::Route53Resolver::ResolverDNSSECConfig" +} diff --git a/schema/aws-route53resolver-resolverendpoint.json b/schema/aws-route53resolver-resolverendpoint.json index 7b78f01..d95e84b 100644 --- a/schema/aws-route53resolver-resolverendpoint.json +++ b/schema/aws-route53resolver-resolverendpoint.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OutpostArn", - "/properties/Direction", - "/properties/SecurityGroupIds", - "/properties/PreferredInstanceType" - ], - "definitions": { - "IpAddressRequest": { - "additionalProperties": false, - "properties": { - "Ip": { - "type": "string" - }, - "Ipv6": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53Resolver::ResolverEndpoint", - "primaryIdentifier": [ - "/properties/ResolverEndpointId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Direction": { - "type": "string" - }, - "HostVPCId": { - "type": "string" - }, - "IpAddressCount": { - "type": "string" - }, - "IpAddresses": { - "items": { - "$ref": "#/definitions/IpAddressRequest" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "type": "string" - }, - "OutpostArn": { - "type": "string" - }, - "PreferredInstanceType": { - "type": "string" - }, - "Protocols": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ResolverEndpointId": { - "type": "string" - }, - "ResolverEndpointType": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ResolverEndpointId", - "/properties/IpAddressCount", - "/properties/Arn", - "/properties/HostVPCId" - ], - "required": [ - "IpAddresses", - "Direction", - "SecurityGroupIds" - ], - "typeName": "AWS::Route53Resolver::ResolverEndpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OutpostArn", + "/properties/Direction", + "/properties/SecurityGroupIds", + "/properties/PreferredInstanceType" + ], + "definitions": { + "IpAddressRequest": { + "additionalProperties": false, + "properties": { + "Ip": { + "type": "string" + }, + "Ipv6": { + "type": "string" + }, + "SubnetId": { + "type": "string" + } + }, + "required": [ + "SubnetId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Resolver::ResolverEndpoint", + "primaryIdentifier": [ + "/properties/ResolverEndpointId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Direction": { + "type": "string" + }, + "HostVPCId": { + "type": "string" + }, + "IpAddressCount": { + "type": "string" + }, + "IpAddresses": { + "items": { + "$ref": "#/definitions/IpAddressRequest" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "type": "string" + }, + "OutpostArn": { + "type": "string" + }, + "PreferredInstanceType": { + "type": "string" + }, + "Protocols": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ResolverEndpointId": { + "type": "string" + }, + "ResolverEndpointType": { + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ResolverEndpointId", + "/properties/IpAddressCount", + "/properties/Arn", + "/properties/HostVPCId" + ], + "required": [ + "IpAddresses", + "Direction", + "SecurityGroupIds" + ], + "typeName": "AWS::Route53Resolver::ResolverEndpoint" +} diff --git a/schema/aws-route53resolver-resolverqueryloggingconfig.json b/schema/aws-route53resolver-resolverqueryloggingconfig.json index b6dbbc5..48495a0 100644 --- a/schema/aws-route53resolver-resolverqueryloggingconfig.json +++ b/schema/aws-route53resolver-resolverqueryloggingconfig.json @@ -1,130 +1,130 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/DestinationArn" - ], - "description": "Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.", - "handlers": { - "create": { - "permissions": [ - "resolverquerylogging:CreateConfig", - "resolverquerylogging:GetConfig", - "route53resolver:CreateResolverQueryLogConfig", - "route53resolver:GetResolverQueryLogConfig", - "logs:CreateLogDelivery", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:DeleteLogDelivery", - "logs:ListLogDeliveries", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "resolverquerylogging:DeleteConfig", - "resolverquerylogging:ListConfig", - "route53resolver:DeleteResolverQueryLogConfig", - "route53resolver:ListResolverQueryLogConfigs" - ] - }, - "list": { - "permissions": [ - "resolverquerylogging:ListConfig", - "route53resolver:ListResolverQueryLogConfigs" - ] - }, - "read": { - "permissions": [ - "resolverquerylogging:GetConfig", - "route53resolver:GetResolverQueryLogConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "description": "Arn", - "maxLength": 600, - "minLength": 1, - "type": "string" - }, - "AssociationCount": { - "description": "Count", - "type": "integer" - }, - "CreationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "CreatorRequestId": { - "description": "The id of the creator request.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "DestinationArn": { - "description": "destination arn", - "maxLength": 600, - "minLength": 1, - "type": "string" - }, - "Id": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "ResolverQueryLogConfigName", - "maxLength": 64, - "minLength": 1, - "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", - "type": "string" - }, - "OwnerId": { - "description": "AccountId", - "maxLength": 32, - "minLength": 12, - "type": "string" - }, - "ShareStatus": { - "description": "ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.", - "enum": [ - "NOT_SHARED", - "SHARED_WITH_ME", - "SHARED_BY_ME" - ], - "type": "string" - }, - "Status": { - "description": "ResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.", - "enum": [ - "CREATING", - "CREATED", - "DELETING", - "FAILED" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/OwnerId", - "/properties/Status", - "/properties/ShareStatus", - "/properties/AssociationCount", - "/properties/Arn", - "/properties/CreatorRequestId", - "/properties/CreationTime", - "/properties/Id" - ], - "taggable": false, - "typeName": "AWS::Route53Resolver::ResolverQueryLoggingConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/DestinationArn" + ], + "description": "Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.", + "handlers": { + "create": { + "permissions": [ + "resolverquerylogging:CreateConfig", + "resolverquerylogging:GetConfig", + "route53resolver:CreateResolverQueryLogConfig", + "route53resolver:GetResolverQueryLogConfig", + "logs:CreateLogDelivery", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "resolverquerylogging:DeleteConfig", + "resolverquerylogging:ListConfig", + "route53resolver:DeleteResolverQueryLogConfig", + "route53resolver:ListResolverQueryLogConfigs" + ] + }, + "list": { + "permissions": [ + "resolverquerylogging:ListConfig", + "route53resolver:ListResolverQueryLogConfigs" + ] + }, + "read": { + "permissions": [ + "resolverquerylogging:GetConfig", + "route53resolver:GetResolverQueryLogConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "Arn", + "maxLength": 600, + "minLength": 1, + "type": "string" + }, + "AssociationCount": { + "description": "Count", + "type": "integer" + }, + "CreationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "CreatorRequestId": { + "description": "The id of the creator request.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DestinationArn": { + "description": "destination arn", + "maxLength": 600, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "ResolverQueryLogConfigName", + "maxLength": 64, + "minLength": 1, + "pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)", + "type": "string" + }, + "OwnerId": { + "description": "AccountId", + "maxLength": 32, + "minLength": 12, + "type": "string" + }, + "ShareStatus": { + "description": "ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.", + "enum": [ + "NOT_SHARED", + "SHARED_WITH_ME", + "SHARED_BY_ME" + ], + "type": "string" + }, + "Status": { + "description": "ResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.", + "enum": [ + "CREATING", + "CREATED", + "DELETING", + "FAILED" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/OwnerId", + "/properties/Status", + "/properties/ShareStatus", + "/properties/AssociationCount", + "/properties/Arn", + "/properties/CreatorRequestId", + "/properties/CreationTime", + "/properties/Id" + ], + "taggable": false, + "typeName": "AWS::Route53Resolver::ResolverQueryLoggingConfig" +} diff --git a/schema/aws-route53resolver-resolverqueryloggingconfigassociation.json b/schema/aws-route53resolver-resolverqueryloggingconfigassociation.json index aac1c0e..2b54201 100644 --- a/schema/aws-route53resolver-resolverqueryloggingconfigassociation.json +++ b/schema/aws-route53resolver-resolverqueryloggingconfigassociation.json @@ -1,102 +1,102 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResolverQueryLogConfigId", - "/properties/ResourceId" - ], - "description": "Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.", - "handlers": { - "create": { - "permissions": [ - "resolverquerylogging:AssociateConfig", - "resolverquerylogging:GetConfigAssociation", - "route53resolver:AssociateResolverQueryLogConfig", - "ec2:DescribeVpcs", - "route53resolver:GetResolverQueryLogConfigAssociation" - ] - }, - "delete": { - "permissions": [ - "resolverquerylogging:DisassociateConfig", - "resolverquerylogging:ListConfigAssociation", - "route53resolver:DisassociateResolverQueryLogConfig", - "route53resolver:ListResolverQueryLogConfigAssociations", - "route53resolver:GetResolverQueryLogConfigAssociation" - ] - }, - "list": { - "permissions": [ - "resolverquerylogging:ListConfigAssociations", - "route53resolver:ListResolverQueryLogConfigAssociations" - ] - }, - "read": { - "permissions": [ - "resolverquerylogging:GetConfigAssociation", - "route53resolver:GetResolverQueryLogConfigAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CreationTime": { - "description": "Rfc3339TimeString", - "maxLength": 40, - "minLength": 20, - "type": "string" - }, - "Error": { - "description": "ResolverQueryLogConfigAssociationError", - "enum": [ - "NONE", - "DESTINATION_NOT_FOUND", - "ACCESS_DENIED" - ], - "type": "string" - }, - "ErrorMessage": { - "description": "ResolverQueryLogConfigAssociationErrorMessage", - "type": "string" - }, - "Id": { - "description": "Id", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ResolverQueryLogConfigId": { - "description": "ResolverQueryLogConfigId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ResourceId": { - "description": "ResourceId", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Status": { - "description": "ResolverQueryLogConfigAssociationStatus", - "enum": [ - "CREATING", - "ACTIVE", - "ACTION_NEEDED", - "DELETING", - "FAILED", - "OVERRIDDEN" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Error", - "/properties/ErrorMessage", - "/properties/CreationTime", - "/properties/Id" - ], - "typeName": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResolverQueryLogConfigId", + "/properties/ResourceId" + ], + "description": "Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.", + "handlers": { + "create": { + "permissions": [ + "resolverquerylogging:AssociateConfig", + "resolverquerylogging:GetConfigAssociation", + "route53resolver:AssociateResolverQueryLogConfig", + "ec2:DescribeVpcs", + "route53resolver:GetResolverQueryLogConfigAssociation" + ] + }, + "delete": { + "permissions": [ + "resolverquerylogging:DisassociateConfig", + "resolverquerylogging:ListConfigAssociation", + "route53resolver:DisassociateResolverQueryLogConfig", + "route53resolver:ListResolverQueryLogConfigAssociations", + "route53resolver:GetResolverQueryLogConfigAssociation" + ] + }, + "list": { + "permissions": [ + "resolverquerylogging:ListConfigAssociations", + "route53resolver:ListResolverQueryLogConfigAssociations" + ] + }, + "read": { + "permissions": [ + "resolverquerylogging:GetConfigAssociation", + "route53resolver:GetResolverQueryLogConfigAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CreationTime": { + "description": "Rfc3339TimeString", + "maxLength": 40, + "minLength": 20, + "type": "string" + }, + "Error": { + "description": "ResolverQueryLogConfigAssociationError", + "enum": [ + "NONE", + "DESTINATION_NOT_FOUND", + "ACCESS_DENIED" + ], + "type": "string" + }, + "ErrorMessage": { + "description": "ResolverQueryLogConfigAssociationErrorMessage", + "type": "string" + }, + "Id": { + "description": "Id", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ResolverQueryLogConfigId": { + "description": "ResolverQueryLogConfigId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ResourceId": { + "description": "ResourceId", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Status": { + "description": "ResolverQueryLogConfigAssociationStatus", + "enum": [ + "CREATING", + "ACTIVE", + "ACTION_NEEDED", + "DELETING", + "FAILED", + "OVERRIDDEN" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Error", + "/properties/ErrorMessage", + "/properties/CreationTime", + "/properties/Id" + ], + "typeName": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" +} diff --git a/schema/aws-route53resolver-resolverrule.json b/schema/aws-route53resolver-resolverrule.json index 7c23620..d32e4c7 100644 --- a/schema/aws-route53resolver-resolverrule.json +++ b/schema/aws-route53resolver-resolverrule.json @@ -1,176 +1,182 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/DomainName" - ], - "createOnlyProperties": [ - "/properties/RuleType" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetAddress": { - "additionalProperties": false, - "properties": { - "Ip": { - "description": "One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. ", - "type": "string" - }, - "Ipv6": { - "description": "One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses. ", - "type": "string" - }, - "Port": { - "description": "The port at Ip that you want to forward DNS queries to. ", - "maxLength": 65535, - "minLength": 0, - "type": "string" - }, - "Protocol": { - "description": "The protocol that you want to use to forward DNS queries. ", - "enum": [ - "Do53", - "DoH" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Route53Resolver::ResolverRule", - "handlers": { - "create": { - "permissions": [ - "route53resolver:CreateResolverRule", - "route53resolver:GetResolverRule", - "route53resolver:ListTagsForResource", - "route53resolver:TagResource" - ] - }, - "delete": { - "permissions": [ - "route53resolver:DeleteResolverRule", - "route53resolver:GetResolverRule" - ] - }, - "list": { - "permissions": [ - "route53resolver:ListResolverRules" - ] - }, - "read": { - "permissions": [ - "route53resolver:GetResolverRule", - "route53resolver:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "route53resolver:UpdateResolverRule", - "route53resolver:GetResolverRule", - "route53resolver:ListTagsForResource", - "route53resolver:TagResource", - "route53resolver:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResolverRuleId" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the resolver rule.", - "type": "string" - }, - "DomainName": { - "description": "DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name for the Resolver rule", - "maxLength": 64, - "minLength": 0, - "type": "string" - }, - "ResolverEndpointId": { - "description": "The ID of the endpoint that the rule is associated with.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "ResolverRuleId": { - "description": "The ID of the endpoint that the rule is associated with.", - "type": "string" - }, - "RuleType": { - "description": "When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.", - "enum": [ - "FORWARD", - "SYSTEM", - "RECURSIVE" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TargetIps": { - "description": "An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TargetAddress" - }, - "type": "array", - "uniqueItems": false - } - }, - "propertyTransform": { - "/properties/DomainName": "$join([DomainName, \".\"]) $OR DomainName" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ResolverRuleId" - ], - "required": [ - "DomainName", - "RuleType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53resolver.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Route53Resolver::ResolverRule" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/DomainName" + ], + "createOnlyProperties": [ + "/properties/RuleType" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetAddress": { + "additionalProperties": false, + "properties": { + "Ip": { + "description": "One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. ", + "type": "string" + }, + "Ipv6": { + "description": "One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses. ", + "type": "string" + }, + "Port": { + "description": "The port at Ip that you want to forward DNS queries to. ", + "maxLength": 65535, + "minLength": 0, + "type": "string" + }, + "Protocol": { + "description": "The protocol that you want to use to forward DNS queries. ", + "enum": [ + "Do53", + "DoH" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Resolver::ResolverRule", + "handlers": { + "create": { + "permissions": [ + "route53resolver:CreateResolverRule", + "route53resolver:GetResolverRule", + "route53resolver:ListTagsForResource", + "route53resolver:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53resolver:DeleteResolverRule", + "route53resolver:GetResolverRule" + ] + }, + "list": { + "permissions": [ + "route53resolver:ListResolverRules" + ] + }, + "read": { + "permissions": [ + "route53resolver:GetResolverRule", + "route53resolver:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53resolver:UpdateResolverRule", + "route53resolver:GetResolverRule", + "route53resolver:ListTagsForResource", + "route53resolver:TagResource", + "route53resolver:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResolverRuleId" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the resolver rule.", + "type": "string" + }, + "DelegationRecord": { + "description": "The name server domain for queries to be delegated to if a query matches the delegation record.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DomainName": { + "description": "DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name for the Resolver rule", + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "ResolverEndpointId": { + "description": "The ID of the endpoint that the rule is associated with.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "ResolverRuleId": { + "description": "The ID of the endpoint that the rule is associated with.", + "type": "string" + }, + "RuleType": { + "description": "When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.", + "enum": [ + "FORWARD", + "SYSTEM", + "RECURSIVE", + "DELEGATE" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TargetIps": { + "description": "An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetAddress" + }, + "type": "array", + "uniqueItems": false + } + }, + "propertyTransform": { + "/properties/DomainName": "$join([DomainName, \".\"]) $OR DomainName" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ResolverRuleId" + ], + "required": [ + "RuleType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53resolver.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Resolver::ResolverRule" +} diff --git a/schema/aws-route53resolver-resolverruleassociation.json b/schema/aws-route53resolver-resolverruleassociation.json index 0c26a4d..e9fe76c 100644 --- a/schema/aws-route53resolver-resolverruleassociation.json +++ b/schema/aws-route53resolver-resolverruleassociation.json @@ -1,64 +1,64 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/VPCId", - "/properties/ResolverRuleId" - ], - "description": "In the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.", - "handlers": { - "create": { - "permissions": [ - "route53resolver:AssociateResolverRule", - "route53resolver:GetResolverRuleAssociation", - "ec2:DescribeVpcs" - ] - }, - "delete": { - "permissions": [ - "route53resolver:DisassociateResolverRule", - "route53resolver:GetResolverRuleAssociation" - ] - }, - "list": { - "permissions": [ - "route53resolver:ListResolverRuleAssociations" - ] - }, - "read": { - "permissions": [ - "route53resolver:GetResolverRuleAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResolverRuleAssociationId" - ], - "properties": { - "Name": { - "description": "The name of an association between a Resolver rule and a VPC.", - "type": "string" - }, - "ResolverRuleAssociationId": { - "description": "", - "type": "string" - }, - "ResolverRuleId": { - "description": "The ID of the Resolver rule that you associated with the VPC that is specified by ``VPCId``.", - "type": "string" - }, - "VPCId": { - "description": "The ID of the VPC that you associated the Resolver rule with.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ResolverRuleAssociationId" - ], - "required": [ - "VPCId", - "ResolverRuleId" - ], - "taggable": false, - "typeName": "AWS::Route53Resolver::ResolverRuleAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/VPCId", + "/properties/ResolverRuleId" + ], + "description": "In the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.", + "handlers": { + "create": { + "permissions": [ + "route53resolver:AssociateResolverRule", + "route53resolver:GetResolverRuleAssociation", + "ec2:DescribeVpcs" + ] + }, + "delete": { + "permissions": [ + "route53resolver:DisassociateResolverRule", + "route53resolver:GetResolverRuleAssociation" + ] + }, + "list": { + "permissions": [ + "route53resolver:ListResolverRuleAssociations" + ] + }, + "read": { + "permissions": [ + "route53resolver:GetResolverRuleAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResolverRuleAssociationId" + ], + "properties": { + "Name": { + "description": "The name of an association between a Resolver rule and a VPC.", + "type": "string" + }, + "ResolverRuleAssociationId": { + "description": "", + "type": "string" + }, + "ResolverRuleId": { + "description": "The ID of the Resolver rule that you associated with the VPC that is specified by ``VPCId``.", + "type": "string" + }, + "VPCId": { + "description": "The ID of the VPC that you associated the Resolver rule with.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ResolverRuleAssociationId" + ], + "required": [ + "VPCId", + "ResolverRuleId" + ], + "taggable": false, + "typeName": "AWS::Route53Resolver::ResolverRuleAssociation" +} diff --git a/schema/aws-rum-appmonitor.json b/schema/aws-rum-appmonitor.json index 92e1dd0..3748415 100644 --- a/schema/aws-rum-appmonitor.json +++ b/schema/aws-rum-appmonitor.json @@ -1,424 +1,424 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "AppMonitorConfiguration": { - "additionalProperties": false, - "description": "AppMonitor configuration", - "properties": { - "AllowCookies": { - "description": "If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.", - "type": "boolean" - }, - "EnableXRay": { - "description": "If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.", - "type": "boolean" - }, - "ExcludedPages": { - "$ref": "#/definitions/Pages", - "description": "A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation." - }, - "FavoritePages": { - "$ref": "#/definitions/FavoritePages", - "description": "A list of pages in the RUM console that are to be displayed with a favorite icon." - }, - "GuestRoleArn": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM." - }, - "IdentityPoolId": { - "description": "The ID of the identity pool that is used to authorize the sending of data to RUM.", - "maxLength": 55, - "minLength": 1, - "pattern": "[\\w-]+:[0-9a-f-]+", - "type": "string" - }, - "IncludedPages": { - "$ref": "#/definitions/Pages", - "description": "If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation." - }, - "MetricDestinations": { - "description": "An array of structures which define the destinations and the metrics that you want to send.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDestination" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "SessionSampleRate": { - "description": "Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "Telemetries": { - "description": "An array that lists the types of telemetry data that this app monitor is to collect.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Telemetry" - }, - "type": "array" - } - }, - "type": "object" - }, - "Arn": { - "description": "Resource ARN", - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", - "type": "string" - }, - "CustomEvents": { - "additionalProperties": false, - "description": "AppMonitor custom events configuration", - "properties": { - "Status": { - "$ref": "#/definitions/CustomEventsStatus", - "description": "Indicates whether AppMonitor accepts custom events." - } - }, - "type": "object" - }, - "CustomEventsStatus": { - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "FavoritePages": { - "description": "List of favorite pages", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "MetricDefinition": { - "additionalProperties": false, - "description": "A single metric definition", - "properties": { - "DimensionKeys": { - "additionalProperties": false, - "description": "Use this field only if you are sending the metric to CloudWatch.\n\nThis field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:\n\n\"metadata.pageId\": \"PageId\"\n\n\"metadata.browserName\": \"BrowserName\"\n\n\"metadata.deviceType\": \"DeviceType\"\n\n\"metadata.osName\": \"OSName\"\n\n\"metadata.countryCode\": \"CountryCode\"\n\n\"event_details.fileType\": \"FileType\"\n\nAll dimensions listed in this field must also be included in EventPattern.", - "patternProperties": { - "^(?!:).*[^\\s].*": { - "maxLength": 255, - "minLength": 1, - "pattern": ".*[^\\s].*", - "type": "string" - } - }, - "type": "object" - }, - "EventPattern": { - "description": "The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.\n\nWhen you define extended metrics, the metric definition is not valid if EventPattern is omitted.\n\nExample event patterns:\n\n'{ \"event_type\": [\"com.amazon.rum.js_error_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Firefox\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \"<\", 2000 ] }] } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], \"countryCode\": [ \"US\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \">=\", 2000, \"<\", 8000 ] }] } }'\n\nIf the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.", - "maxLength": 4000, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name for the metric that is defined in this structure. For extended metrics, valid values are the following:\n\nPerformanceNavigationDuration\n\nPerformanceResourceDuration\n\nNavigationSatisfiedTransaction\n\nNavigationToleratedTransaction\n\nNavigationFrustratedTransaction\n\nWebVitalsCumulativeLayoutShift\n\nWebVitalsFirstInputDelay\n\nWebVitalsLargestContentfulPaint\n\nJsErrorCount\n\nHttpErrorCount\n\nSessionCount", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Namespace": { - "description": "The namespace used by CloudWatch Metrics for the metric that is defined in this structure", - "maxLength": 237, - "minLength": 1, - "pattern": "[a-zA-Z0-9-._/#:]+$", - "type": "string" - }, - "UnitLabel": { - "description": "The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ValueKey": { - "description": "The field within the event object that the metric value is sourced from.\n\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.\n\nIf this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.", - "maxLength": 256, - "minLength": 1, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "MetricDestination": { - "additionalProperties": false, - "description": "An structure which defines the destination and the metrics that you want to send.", - "properties": { - "Destination": { - "description": "Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.", - "enum": [ - "CloudWatch", - "Evidently" - ], - "type": "string" - }, - "DestinationArn": { - "description": "Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.", - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", - "type": "string" - }, - "IamRoleArn": { - "description": "This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.\n\nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.", - "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", - "type": "string" - }, - "MetricDefinitions": { - "description": "An array of structures which define the metrics that you want to send.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MetricDefinition" - }, - "maxItems": 2000, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "Pages": { - "description": "List of url pages", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Url" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagDef": { - "description": "Assigns one or more tags (key-value pairs) to the app monitor. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.You can associate as many as 50 tags with an app monitor.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Telemetry": { - "enum": [ - "errors", - "performance", - "http" - ], - "type": "string" - }, - "Url": { - "description": "Page Url", - "maxLength": 1260, - "minLength": 1, - "pattern": "https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::RUM::AppMonitor", - "handlers": { - "create": { - "permissions": [ - "rum:GetAppMonitor", - "rum:CreateAppMonitor", - "dynamodb:GetItem", - "dynamodb:PutItem", - "s3:GetObject", - "s3:PutObject", - "s3:GetObjectAcl", - "s3:DoesObjectExist", - "logs:CreateLogDelivery", - "logs:CreateLogGroup", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "logs:PutRetentionPolicy", - "rum:TagResource", - "rum:ListTagsForResource", - "cognito-identity:DescribeIdentityPool", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "rum:PutRumMetricsDestination", - "rum:BatchCreateRumMetricDefinitions", - "rum:ListRumMetricsDestinations", - "rum:BatchGetRumMetricDefinitions" - ] - }, - "delete": { - "permissions": [ - "rum:GetAppMonitor", - "rum:DeleteAppMonitor", - "dynamodb:DeleteItem", - "dynamodb:Query", - "logs:DeleteLogDelivery", - "s3:DeleteObject", - "s3:DoesObjectExist", - "rum:UntagResource", - "rum:ListTagsForResource", - "rum:DeleteRumMetricsDestination", - "rum:BatchDeleteRumMetricDefinitions", - "rum:ListRumMetricsDestinations", - "rum:BatchGetRumMetricDefinitions" - ] - }, - "list": { - "permissions": [ - "rum:ListAppMonitors", - "dynamodb:DescribeTable", - "rum:GetAppMonitor", - "dynamodb:GetItem", - "dynamodb:BatchGetItem", - "dynamodb:Query", - "s3:GetObject", - "s3:DoesObjectExist", - "s3:GetObjectAcl", - "logs:DescribeLogGroups", - "rum:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "rum:GetAppMonitor", - "dynamodb:GetItem", - "s3:GetObject", - "s3:DoesObjectExist", - "s3:GetObjectAcl", - "rum:ListTagsForResource", - "rum:ListRumMetricsDestinations", - "rum:BatchGetRumMetricDefinitions" - ] - }, - "update": { - "permissions": [ - "rum:GetAppMonitor", - "rum:UpdateAppMonitor", - "dynamodb:GetItem", - "dynamodb:PutItem", - "dynamodb:UpdateItem", - "dynamodb:Query", - "s3:GetObject", - "s3:PutObject", - "s3:GetObjectAcl", - "s3:DoesObjectExist", - "logs:CreateLogDelivery", - "logs:CreateLogGroup", - "logs:GetLogDelivery", - "logs:UpdateLogDelivery", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "logs:PutRetentionPolicy", - "rum:TagResource", - "rum:UntagResource", - "rum:ListTagsForResource", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "rum:PutRumMetricsDestination", - "rum:DeleteRumMetricsDestination", - "rum:ListRumMetricsDestinations", - "rum:BatchCreateRumMetricDefinitions", - "rum:BatchDeleteRumMetricDefinitions", - "rum:BatchGetRumMetricDefinitions", - "rum:UpdateRumMetricDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AppMonitorConfiguration": { - "$ref": "#/definitions/AppMonitorConfiguration" - }, - "CustomEvents": { - "$ref": "#/definitions/CustomEvents" - }, - "CwLogEnabled": { - "description": "Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false", - "type": "boolean" - }, - "Domain": { - "description": "The top-level internet domain name for which your application has administrative authority.", - "maxLength": 253, - "minLength": 1, - "pattern": "^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\\*\\.)(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))", - "type": "string" - }, - "Id": { - "description": "The unique ID of the new app monitor.", - "maxLength": 36, - "minLength": 36, - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "type": "string" - }, - "Name": { - "description": "A name for the app monitor", - "maxLength": 255, - "minLength": 1, - "pattern": "[\\.\\-_/#A-Za-z0-9]+", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/TagDef" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "Domain" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": true - }, - "typeName": "AWS::RUM::AppMonitor" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "AppMonitorConfiguration": { + "additionalProperties": false, + "description": "AppMonitor configuration", + "properties": { + "AllowCookies": { + "description": "If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.", + "type": "boolean" + }, + "EnableXRay": { + "description": "If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.", + "type": "boolean" + }, + "ExcludedPages": { + "$ref": "#/definitions/Pages", + "description": "A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation." + }, + "FavoritePages": { + "$ref": "#/definitions/FavoritePages", + "description": "A list of pages in the RUM console that are to be displayed with a favorite icon." + }, + "GuestRoleArn": { + "$ref": "#/definitions/Arn", + "description": "The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM." + }, + "IdentityPoolId": { + "description": "The ID of the identity pool that is used to authorize the sending of data to RUM.", + "maxLength": 55, + "minLength": 1, + "pattern": "[\\w-]+:[0-9a-f-]+", + "type": "string" + }, + "IncludedPages": { + "$ref": "#/definitions/Pages", + "description": "If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation." + }, + "MetricDestinations": { + "description": "An array of structures which define the destinations and the metrics that you want to send.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDestination" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "SessionSampleRate": { + "description": "Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "Telemetries": { + "description": "An array that lists the types of telemetry data that this app monitor is to collect.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Telemetry" + }, + "type": "array" + } + }, + "type": "object" + }, + "Arn": { + "description": "Resource ARN", + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", + "type": "string" + }, + "CustomEvents": { + "additionalProperties": false, + "description": "AppMonitor custom events configuration", + "properties": { + "Status": { + "$ref": "#/definitions/CustomEventsStatus", + "description": "Indicates whether AppMonitor accepts custom events." + } + }, + "type": "object" + }, + "CustomEventsStatus": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "FavoritePages": { + "description": "List of favorite pages", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "MetricDefinition": { + "additionalProperties": false, + "description": "A single metric definition", + "properties": { + "DimensionKeys": { + "additionalProperties": false, + "description": "Use this field only if you are sending the metric to CloudWatch.\n\nThis field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:\n\n\"metadata.pageId\": \"PageId\"\n\n\"metadata.browserName\": \"BrowserName\"\n\n\"metadata.deviceType\": \"DeviceType\"\n\n\"metadata.osName\": \"OSName\"\n\n\"metadata.countryCode\": \"CountryCode\"\n\n\"event_details.fileType\": \"FileType\"\n\nAll dimensions listed in this field must also be included in EventPattern.", + "patternProperties": { + "^(?!:).*[^\\s].*": { + "maxLength": 255, + "minLength": 1, + "pattern": ".*[^\\s].*", + "type": "string" + } + }, + "type": "object" + }, + "EventPattern": { + "description": "The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.\n\nWhen you define extended metrics, the metric definition is not valid if EventPattern is omitted.\n\nExample event patterns:\n\n'{ \"event_type\": [\"com.amazon.rum.js_error_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Firefox\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \"<\", 2000 ] }] } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], \"countryCode\": [ \"US\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \">=\", 2000, \"<\", 8000 ] }] } }'\n\nIf the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.", + "maxLength": 4000, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name for the metric that is defined in this structure. For extended metrics, valid values are the following:\n\nPerformanceNavigationDuration\n\nPerformanceResourceDuration\n\nNavigationSatisfiedTransaction\n\nNavigationToleratedTransaction\n\nNavigationFrustratedTransaction\n\nWebVitalsCumulativeLayoutShift\n\nWebVitalsFirstInputDelay\n\nWebVitalsLargestContentfulPaint\n\nJsErrorCount\n\nHttpErrorCount\n\nSessionCount", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Namespace": { + "description": "The namespace used by CloudWatch Metrics for the metric that is defined in this structure", + "maxLength": 237, + "minLength": 1, + "pattern": "[a-zA-Z0-9-._/#:]+$", + "type": "string" + }, + "UnitLabel": { + "description": "The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ValueKey": { + "description": "The field within the event object that the metric value is sourced from.\n\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.\n\nIf this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.", + "maxLength": 256, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "MetricDestination": { + "additionalProperties": false, + "description": "An structure which defines the destination and the metrics that you want to send.", + "properties": { + "Destination": { + "description": "Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.", + "enum": [ + "CloudWatch", + "Evidently" + ], + "type": "string" + }, + "DestinationArn": { + "description": "Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.", + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", + "type": "string" + }, + "IamRoleArn": { + "description": "This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.\n\nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.", + "pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*", + "type": "string" + }, + "MetricDefinitions": { + "description": "An array of structures which define the metrics that you want to send.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "maxItems": 2000, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Destination" + ], + "type": "object" + }, + "Pages": { + "description": "List of url pages", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Url" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagDef": { + "description": "Assigns one or more tags (key-value pairs) to the app monitor. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.You can associate as many as 50 tags with an app monitor.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Telemetry": { + "enum": [ + "errors", + "performance", + "http" + ], + "type": "string" + }, + "Url": { + "description": "Page Url", + "maxLength": 1260, + "minLength": 1, + "pattern": "https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::RUM::AppMonitor", + "handlers": { + "create": { + "permissions": [ + "rum:GetAppMonitor", + "rum:CreateAppMonitor", + "dynamodb:GetItem", + "dynamodb:PutItem", + "s3:GetObject", + "s3:PutObject", + "s3:GetObjectAcl", + "s3:DoesObjectExist", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "logs:PutRetentionPolicy", + "rum:TagResource", + "rum:ListTagsForResource", + "cognito-identity:DescribeIdentityPool", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "rum:PutRumMetricsDestination", + "rum:BatchCreateRumMetricDefinitions", + "rum:ListRumMetricsDestinations", + "rum:BatchGetRumMetricDefinitions" + ] + }, + "delete": { + "permissions": [ + "rum:GetAppMonitor", + "rum:DeleteAppMonitor", + "dynamodb:DeleteItem", + "dynamodb:Query", + "logs:DeleteLogDelivery", + "s3:DeleteObject", + "s3:DoesObjectExist", + "rum:UntagResource", + "rum:ListTagsForResource", + "rum:DeleteRumMetricsDestination", + "rum:BatchDeleteRumMetricDefinitions", + "rum:ListRumMetricsDestinations", + "rum:BatchGetRumMetricDefinitions" + ] + }, + "list": { + "permissions": [ + "rum:ListAppMonitors", + "dynamodb:DescribeTable", + "rum:GetAppMonitor", + "dynamodb:GetItem", + "dynamodb:BatchGetItem", + "dynamodb:Query", + "s3:GetObject", + "s3:DoesObjectExist", + "s3:GetObjectAcl", + "logs:DescribeLogGroups", + "rum:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "rum:GetAppMonitor", + "dynamodb:GetItem", + "s3:GetObject", + "s3:DoesObjectExist", + "s3:GetObjectAcl", + "rum:ListTagsForResource", + "rum:ListRumMetricsDestinations", + "rum:BatchGetRumMetricDefinitions" + ] + }, + "update": { + "permissions": [ + "rum:GetAppMonitor", + "rum:UpdateAppMonitor", + "dynamodb:GetItem", + "dynamodb:PutItem", + "dynamodb:UpdateItem", + "dynamodb:Query", + "s3:GetObject", + "s3:PutObject", + "s3:GetObjectAcl", + "s3:DoesObjectExist", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:GetLogDelivery", + "logs:UpdateLogDelivery", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "logs:PutRetentionPolicy", + "rum:TagResource", + "rum:UntagResource", + "rum:ListTagsForResource", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "rum:PutRumMetricsDestination", + "rum:DeleteRumMetricsDestination", + "rum:ListRumMetricsDestinations", + "rum:BatchCreateRumMetricDefinitions", + "rum:BatchDeleteRumMetricDefinitions", + "rum:BatchGetRumMetricDefinitions", + "rum:UpdateRumMetricDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AppMonitorConfiguration": { + "$ref": "#/definitions/AppMonitorConfiguration" + }, + "CustomEvents": { + "$ref": "#/definitions/CustomEvents" + }, + "CwLogEnabled": { + "description": "Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false", + "type": "boolean" + }, + "Domain": { + "description": "The top-level internet domain name for which your application has administrative authority.", + "maxLength": 253, + "minLength": 1, + "pattern": "^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\\*\\.)(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))", + "type": "string" + }, + "Id": { + "description": "The unique ID of the new app monitor.", + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "type": "string" + }, + "Name": { + "description": "A name for the app monitor", + "maxLength": 255, + "minLength": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/TagDef" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name", + "Domain" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": true + }, + "typeName": "AWS::RUM::AppMonitor" +} diff --git a/schema/aws-s3-accessgrant.json b/schema/aws-s3-accessgrant.json index 7c53df6..193c92c 100644 --- a/schema/aws-s3-accessgrant.json +++ b/schema/aws-s3-accessgrant.json @@ -1,182 +1,182 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/S3PrefixType", - "/properties/Tags" - ], - "definitions": { - "AccessGrantArn": { - "description": "the Amazon Resource Name (ARN) of the specified access grant.", - "type": "string" - }, - "AccessGrantsLocationConfiguration": { - "additionalProperties": false, - "properties": { - "S3SubPrefix": { - "description": "The S3 sub prefix of a registered location in your S3 Access Grants instance", - "type": "string" - } - }, - "required": [ - "S3SubPrefix" - ], - "type": "object" - }, - "Grantee": { - "additionalProperties": false, - "properties": { - "GranteeIdentifier": { - "description": "The unique identifier of the Grantee", - "type": "string" - }, - "GranteeType": { - "description": "Configures the transfer acceleration state for an Amazon S3 bucket.", - "enum": [ - "IAM", - "DIRECTORY_USER", - "DIRECTORY_GROUP" - ], - "type": "string" - } - }, - "required": [ - "GranteeType", - "GranteeIdentifier" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateAccessGrant", - "s3:TagResource" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessGrant" - ] - }, - "list": { - "permissions": [ - "s3:ListAccessGrants" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessGrant" - ] - }, - "update": { - "permissions": [ - "s3:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccessGrantId" - ], - "properties": { - "AccessGrantArn": { - "$ref": "#/definitions/AccessGrantArn", - "description": "The Amazon Resource Name (ARN) of the specified access grant.", - "examples": [ - "arn:aws:s3:us-east-2:111122223333:access-grants/default/grant/7c89cbd1-0f4e-40e3-861d-afb906952b77" - ] - }, - "AccessGrantId": { - "description": "The ID assigned to this access grant.", - "examples": [ - "7c89cbd1-0f4e-40e3-861d-afb906952b77" - ], - "type": "string" - }, - "AccessGrantsLocationConfiguration": { - "$ref": "#/definitions/AccessGrantsLocationConfiguration", - "description": "The configuration options of the grant location, which is the S3 path to the data to which you are granting access." - }, - "AccessGrantsLocationId": { - "description": "The custom S3 location to be accessed by the grantee", - "examples": [ - "125f332b-a499-4eb6-806f-8a6a1aa4cb96" - ], - "type": "string" - }, - "ApplicationArn": { - "description": "The ARN of the application grantees will use to access the location", - "type": "string" - }, - "GrantScope": { - "description": "The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.", - "type": "string" - }, - "Grantee": { - "$ref": "#/definitions/Grantee", - "description": "The principal who will be granted permission to access S3." - }, - "Permission": { - "description": "The level of access to be afforded to the grantee", - "enum": [ - "READ", - "WRITE", - "READWRITE" - ], - "type": "string" - }, - "S3PrefixType": { - "description": "The type of S3SubPrefix.", - "enum": [ - "Object" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AccessGrantId", - "/properties/AccessGrantArn", - "/properties/GrantScope" - ], - "required": [ - "Grantee", - "Permission", - "AccessGrantsLocationId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", - "tagging": { - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::AccessGrant", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/S3PrefixType" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/S3PrefixType", + "/properties/Tags" + ], + "definitions": { + "AccessGrantArn": { + "description": "the Amazon Resource Name (ARN) of the specified access grant.", + "type": "string" + }, + "AccessGrantsLocationConfiguration": { + "additionalProperties": false, + "properties": { + "S3SubPrefix": { + "description": "The S3 sub prefix of a registered location in your S3 Access Grants instance", + "type": "string" + } + }, + "required": [ + "S3SubPrefix" + ], + "type": "object" + }, + "Grantee": { + "additionalProperties": false, + "properties": { + "GranteeIdentifier": { + "description": "The unique identifier of the Grantee", + "type": "string" + }, + "GranteeType": { + "description": "Configures the transfer acceleration state for an Amazon S3 bucket.", + "enum": [ + "IAM", + "DIRECTORY_USER", + "DIRECTORY_GROUP" + ], + "type": "string" + } + }, + "required": [ + "GranteeType", + "GranteeIdentifier" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateAccessGrant", + "s3:TagResource" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessGrant" + ] + }, + "list": { + "permissions": [ + "s3:ListAccessGrants" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessGrant" + ] + }, + "update": { + "permissions": [ + "s3:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccessGrantId" + ], + "properties": { + "AccessGrantArn": { + "$ref": "#/definitions/AccessGrantArn", + "description": "The Amazon Resource Name (ARN) of the specified access grant.", + "examples": [ + "arn:aws:s3:us-east-2:111122223333:access-grants/default/grant/7c89cbd1-0f4e-40e3-861d-afb906952b77" + ] + }, + "AccessGrantId": { + "description": "The ID assigned to this access grant.", + "examples": [ + "7c89cbd1-0f4e-40e3-861d-afb906952b77" + ], + "type": "string" + }, + "AccessGrantsLocationConfiguration": { + "$ref": "#/definitions/AccessGrantsLocationConfiguration", + "description": "The configuration options of the grant location, which is the S3 path to the data to which you are granting access." + }, + "AccessGrantsLocationId": { + "description": "The custom S3 location to be accessed by the grantee", + "examples": [ + "125f332b-a499-4eb6-806f-8a6a1aa4cb96" + ], + "type": "string" + }, + "ApplicationArn": { + "description": "The ARN of the application grantees will use to access the location", + "type": "string" + }, + "GrantScope": { + "description": "The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.", + "type": "string" + }, + "Grantee": { + "$ref": "#/definitions/Grantee", + "description": "The principal who will be granted permission to access S3." + }, + "Permission": { + "description": "The level of access to be afforded to the grantee", + "enum": [ + "READ", + "WRITE", + "READWRITE" + ], + "type": "string" + }, + "S3PrefixType": { + "description": "The type of S3SubPrefix.", + "enum": [ + "Object" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AccessGrantId", + "/properties/AccessGrantArn", + "/properties/GrantScope" + ], + "required": [ + "Grantee", + "Permission", + "AccessGrantsLocationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::AccessGrant", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/S3PrefixType" + ] +} diff --git a/schema/aws-s3-accessgrantsinstance.json b/schema/aws-s3-accessgrantsinstance.json index c3b1e44..2c35317 100644 --- a/schema/aws-s3-accessgrantsinstance.json +++ b/schema/aws-s3-accessgrantsinstance.json @@ -1,108 +1,108 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags" - ], - "definitions": { - "AccessGrantsInstanceArn": { - "description": "The Amazon Resource Name (ARN) of the specified Access Grants instance.", - "type": "string" - }, - "IdentityCenterArn": { - "description": "The Amazon Resource Name (ARN) of the specified AWS Identity Center.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations", - "handlers": { - "create": { - "permissions": [ - "s3:CreateAccessGrantsInstance", - "s3:TagResource" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessGrantsInstance" - ] - }, - "list": { - "permissions": [ - "s3:ListAccessGrantsInstances" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessGrantsInstance" - ] - }, - "update": { - "permissions": [ - "s3:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccessGrantsInstanceArn" - ], - "properties": { - "AccessGrantsInstanceArn": { - "$ref": "#/definitions/AccessGrantsInstanceArn", - "description": "The Amazon Resource Name (ARN) of the specified Access Grants instance.", - "examples": [ - "arn:aws:s3:us-east-2:479290226168:access-grants/default" - ] - }, - "AccessGrantsInstanceId": { - "description": "A unique identifier for the specified access grants instance.", - "type": "string" - }, - "IdentityCenterArn": { - "$ref": "#/definitions/IdentityCenterArn", - "description": "The Amazon Resource Name (ARN) of the specified AWS Identity Center.", - "examples": [ - "arn:aws:sso:::instance/ssoins-6987e6a2fc43873b" - ] - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AccessGrantsInstanceArn", - "/properties/AccessGrantsInstanceId" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", - "tagging": { - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::AccessGrantsInstance", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags" + ], + "definitions": { + "AccessGrantsInstanceArn": { + "description": "The Amazon Resource Name (ARN) of the specified Access Grants instance.", + "type": "string" + }, + "IdentityCenterArn": { + "description": "The Amazon Resource Name (ARN) of the specified AWS Identity Center.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations", + "handlers": { + "create": { + "permissions": [ + "s3:CreateAccessGrantsInstance", + "s3:TagResource" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessGrantsInstance" + ] + }, + "list": { + "permissions": [ + "s3:ListAccessGrantsInstances" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessGrantsInstance" + ] + }, + "update": { + "permissions": [ + "s3:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccessGrantsInstanceArn" + ], + "properties": { + "AccessGrantsInstanceArn": { + "$ref": "#/definitions/AccessGrantsInstanceArn", + "description": "The Amazon Resource Name (ARN) of the specified Access Grants instance.", + "examples": [ + "arn:aws:s3:us-east-2:479290226168:access-grants/default" + ] + }, + "AccessGrantsInstanceId": { + "description": "A unique identifier for the specified access grants instance.", + "type": "string" + }, + "IdentityCenterArn": { + "$ref": "#/definitions/IdentityCenterArn", + "description": "The Amazon Resource Name (ARN) of the specified AWS Identity Center.", + "examples": [ + "arn:aws:sso:::instance/ssoins-6987e6a2fc43873b" + ] + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AccessGrantsInstanceArn", + "/properties/AccessGrantsInstanceId" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::AccessGrantsInstance", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-s3-accessgrantslocation.json b/schema/aws-s3-accessgrantslocation.json index 4caa530..e2f5290 100644 --- a/schema/aws-s3-accessgrantslocation.json +++ b/schema/aws-s3-accessgrantslocation.json @@ -1,110 +1,110 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Tags" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateAccessGrantsLocation", - "iam:PassRole", - "s3:TagResource" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessGrantsLocation" - ] - }, - "list": { - "permissions": [ - "s3:ListAccessGrantsLocations" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessGrantsLocation" - ] - }, - "update": { - "permissions": [ - "s3:UpdateAccessGrantsLocation", - "s3:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccessGrantsLocationId" - ], - "properties": { - "AccessGrantsLocationArn": { - "description": "The Amazon Resource Name (ARN) of the specified Access Grants location.", - "examples": [ - "arn:aws:s3:us-east-2:479290226168:access-grants/default/location/125f332b-a499-4eb6-806f-8a6a1aa4cb96" - ], - "type": "string" - }, - "AccessGrantsLocationId": { - "description": "The unique identifier for the specified Access Grants location.", - "type": "string" - }, - "IamRoleArn": { - "description": "The Amazon Resource Name (ARN) of the access grant location's associated IAM role.", - "examples": [ - "arn:aws:iamw::123456789012:role/rolename" - ], - "type": "string" - }, - "LocationScope": { - "description": "Descriptor for where the location actually points", - "examples": [ - "s3://test-bucket-access-grants-cmh/prefixA" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AccessGrantsLocationArn", - "/properties/AccessGrantsLocationId" - ], - "required": [], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", - "tagging": { - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::AccessGrantsLocation", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Tags" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateAccessGrantsLocation", + "iam:PassRole", + "s3:TagResource" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessGrantsLocation" + ] + }, + "list": { + "permissions": [ + "s3:ListAccessGrantsLocations" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessGrantsLocation" + ] + }, + "update": { + "permissions": [ + "s3:UpdateAccessGrantsLocation", + "s3:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccessGrantsLocationId" + ], + "properties": { + "AccessGrantsLocationArn": { + "description": "The Amazon Resource Name (ARN) of the specified Access Grants location.", + "examples": [ + "arn:aws:s3:us-east-2:479290226168:access-grants/default/location/125f332b-a499-4eb6-806f-8a6a1aa4cb96" + ], + "type": "string" + }, + "AccessGrantsLocationId": { + "description": "The unique identifier for the specified Access Grants location.", + "type": "string" + }, + "IamRoleArn": { + "description": "The Amazon Resource Name (ARN) of the access grant location's associated IAM role.", + "examples": [ + "arn:aws:iamw::123456789012:role/rolename" + ], + "type": "string" + }, + "LocationScope": { + "description": "Descriptor for where the location actually points", + "examples": [ + "s3://test-bucket-access-grants-cmh/prefixA" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AccessGrantsLocationArn", + "/properties/AccessGrantsLocationId" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::AccessGrantsLocation", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-s3-accesspoint.json b/schema/aws-s3-accesspoint.json index 9aaf316..3198939 100644 --- a/schema/aws-s3-accesspoint.json +++ b/schema/aws-s3-accesspoint.json @@ -1,152 +1,152 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Bucket", - "/properties/BucketAccountId", - "/properties/VpcConfiguration" - ], - "definitions": { - "Arn": { - "description": "the Amazon Resource Name (ARN) of the specified accesspoint.", - "type": "string" - }, - "PublicAccessBlockConfiguration": { - "properties": { - "BlockPublicAcls": { - "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", - "type": "boolean" - }, - "BlockPublicPolicy": { - "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", - "type": "boolean" - }, - "IgnorePublicAcls": { - "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", - "type": "boolean" - }, - "RestrictPublicBuckets": { - "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", - "type": "boolean" - } - }, - "type": "object" - }, - "VpcConfiguration": { - "description": "The Virtual Private Cloud (VPC) configuration for a bucket access point.", - "properties": { - "VpcId": { - "description": "If this field is specified, this access point will only allow connections from the specified VPC ID.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateAccessPoint", - "s3:PutAccessPointPolicy", - "s3:PutAccessPointPublicAccessBlock" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessPointPolicy", - "s3:DeleteAccessPoint" - ] - }, - "list": { - "permissions": [ - "s3:ListAccessPoints" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessPoint", - "s3:GetAccessPointPolicy" - ] - }, - "update": { - "permissions": [ - "s3:PutAccessPointPolicy", - "s3:PutAccessPointPublicAccessBlock", - "s3:DeleteAccessPointPolicy", - "s3:GetAccessPoint", - "s3:GetAccessPointPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Alias": { - "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", - "type": "string" - }, - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the specified accesspoint.", - "examples": [ - "arn:aws:s3:us-west-2:123456789012:accesspoint/test" - ] - }, - "Bucket": { - "description": "The name of the bucket that you want to associate this Access Point with.", - "maxLength": 255, - "minLength": 3, - "type": "string" - }, - "BucketAccountId": { - "description": "The AWS account ID associated with the S3 bucket associated with this access point.", - "maxLength": 64, - "pattern": "^\\d{12}$", - "type": "string" - }, - "Name": { - "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.", - "maxLength": 50, - "minLength": 3, - "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", - "type": "string" - }, - "NetworkOrigin": { - "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.", - "enum": [ - "Internet", - "VPC" - ], - "type": "string" - }, - "Policy": { - "description": "The Access Point Policy you want to apply to this access point.", - "type": "object" - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/PublicAccessBlockConfiguration", - "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration", - "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC)." - } - }, - "readOnlyProperties": [ - "/properties/Alias", - "/properties/NetworkOrigin", - "/properties/Arn" - ], - "required": [ - "Bucket" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", - "typeName": "AWS::S3::AccessPoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Bucket", + "/properties/BucketAccountId", + "/properties/VpcConfiguration" + ], + "definitions": { + "Arn": { + "description": "the Amazon Resource Name (ARN) of the specified accesspoint.", + "type": "string" + }, + "PublicAccessBlockConfiguration": { + "properties": { + "BlockPublicAcls": { + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", + "type": "boolean" + }, + "BlockPublicPolicy": { + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", + "type": "boolean" + }, + "IgnorePublicAcls": { + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", + "type": "boolean" + } + }, + "type": "object" + }, + "VpcConfiguration": { + "description": "The Virtual Private Cloud (VPC) configuration for a bucket access point.", + "properties": { + "VpcId": { + "description": "If this field is specified, this access point will only allow connections from the specified VPC ID.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateAccessPoint", + "s3:PutAccessPointPolicy", + "s3:PutAccessPointPublicAccessBlock" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessPointPolicy", + "s3:DeleteAccessPoint" + ] + }, + "list": { + "permissions": [ + "s3:ListAccessPoints" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessPoint", + "s3:GetAccessPointPolicy" + ] + }, + "update": { + "permissions": [ + "s3:PutAccessPointPolicy", + "s3:PutAccessPointPublicAccessBlock", + "s3:DeleteAccessPointPolicy", + "s3:GetAccessPoint", + "s3:GetAccessPointPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Alias": { + "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", + "type": "string" + }, + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the specified accesspoint.", + "examples": [ + "arn:aws:s3:us-west-2:123456789012:accesspoint/test" + ] + }, + "Bucket": { + "description": "The name of the bucket that you want to associate this Access Point with.", + "maxLength": 255, + "minLength": 3, + "type": "string" + }, + "BucketAccountId": { + "description": "The AWS account ID associated with the S3 bucket associated with this access point.", + "maxLength": 64, + "pattern": "^\\d{12}$", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", + "type": "string" + }, + "NetworkOrigin": { + "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.", + "enum": [ + "Internet", + "VPC" + ], + "type": "string" + }, + "Policy": { + "description": "The Access Point Policy you want to apply to this access point.", + "type": "object" + }, + "PublicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration", + "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC)." + } + }, + "readOnlyProperties": [ + "/properties/Alias", + "/properties/NetworkOrigin", + "/properties/Arn" + ], + "required": [ + "Bucket" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3", + "typeName": "AWS::S3::AccessPoint" +} diff --git a/schema/aws-s3-bucket.json b/schema/aws-s3-bucket.json index 398137d..14a5587 100644 --- a/schema/aws-s3-bucket.json +++ b/schema/aws-s3-bucket.json @@ -1,1795 +1,1775 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BucketName" - ], - "definitions": { - "AbortIncompleteMultipartUpload": { - "additionalProperties": false, - "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.", - "properties": { - "DaysAfterInitiation": { - "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload.", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "DaysAfterInitiation" - ], - "type": "object" - }, - "AccelerateConfiguration": { - "additionalProperties": false, - "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.", - "properties": { - "AccelerationStatus": { - "description": "Specifies the transfer acceleration status of the bucket.", - "enum": [ - "Enabled", - "Suspended" - ], - "type": "string" - } - }, - "required": [ - "AccelerationStatus" - ], - "type": "object" - }, - "AccessControlTranslation": { - "additionalProperties": false, - "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object.", - "properties": { - "Owner": { - "const": "Destination", - "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.", - "type": "string" - } - }, - "required": [ - "Owner" - ], - "type": "object" - }, - "AnalyticsConfiguration": { - "additionalProperties": false, - "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", - "properties": { - "Id": { - "description": "The ID that identifies the analytics configuration.", - "type": "string" - }, - "Prefix": { - "description": "The prefix that an object must have to be included in the analytics results.", - "type": "string" - }, - "StorageClassAnalysis": { - "$ref": "#/definitions/StorageClassAnalysis", - "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes." - }, - "TagFilters": { - "description": "The tags to use when evaluating an analytics filter.\n The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "StorageClassAnalysis", - "Id" - ], - "type": "object" - }, - "Arn": { - "description": "the Amazon Resource Name (ARN) of the specified bucket.", - "type": "string" - }, - "BucketEncryption": { - "additionalProperties": false, - "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.", - "properties": { - "ServerSideEncryptionConfiguration": { - "description": "Specifies the default server-side-encryption configuration.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ServerSideEncryptionRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "ServerSideEncryptionConfiguration" - ], - "type": "object" - }, - "CorsConfiguration": { - "additionalProperties": false, - "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.", - "properties": { - "CorsRules": { - "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/CorsRule", - "maxLength": 100 - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "CorsRules" - ], - "type": "object" - }, - "CorsRule": { - "additionalProperties": false, - "description": "Specifies a cross-origin access rule for an Amazon S3 bucket.", - "properties": { - "AllowedHeaders": { - "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AllowedMethods": { - "description": "An HTTP method that you allow the origin to run.\n *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``", - "insertionOrder": true, - "items": { - "enum": [ - "GET", - "PUT", - "HEAD", - "POST", - "DELETE" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "AllowedOrigins": { - "description": "One or more origins you want customers to be able to access the bucket from.", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ExposedHeaders": { - "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).", - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "A unique identifier for this rule. The value must be no more than 255 characters.", - "maxLength": 255, - "type": "string" - }, - "MaxAge": { - "description": "The time in seconds that your browser is to cache the preflight response for the specified resource.", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "AllowedMethods", - "AllowedOrigins" - ], - "type": "object" - }, - "DataExport": { - "additionalProperties": false, - "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.", - "properties": { - "Destination": { - "$ref": "#/definitions/Destination", - "description": "The place to store the data for an analysis." - }, - "OutputSchemaVersion": { - "const": "V_1", - "description": "The version of the output schema to use when exporting data. Must be ``V_1``.", - "type": "string" - } - }, - "required": [ - "Destination", - "OutputSchemaVersion" - ], - "type": "object" - }, - "DefaultRetention": { - "additionalProperties": false, - "description": "The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.\n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.", - "properties": { - "Days": { - "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", - "type": "integer" - }, - "Mode": { - "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", - "enum": [ - "COMPLIANCE", - "GOVERNANCE" - ], - "type": "string" - }, - "Years": { - "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", - "type": "integer" - } - }, - "type": "object" - }, - "DeleteMarkerReplication": { - "additionalProperties": false, - "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).", - "properties": { - "Status": { - "description": "Indicates whether to replicate delete markers. Disabled by default.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - } - }, - "type": "object" - }, - "Destination": { - "additionalProperties": false, - "description": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.", - "properties": { - "BucketAccountId": { - "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.", - "type": "string" - }, - "BucketArn": { - "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported.", - "type": "string" - }, - "Format": { - "description": "Specifies the file format used when exporting data to Amazon S3.\n *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``", - "enum": [ - "CSV", - "ORC", - "Parquet" - ], - "type": "string" - }, - "Prefix": { - "description": "The prefix to use when exporting data. The prefix is prepended to all results.", - "type": "string" - } - }, - "required": [ - "BucketArn", - "Format" - ], - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.", - "properties": { - "ReplicaKmsKeyID": { - "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", - "type": "string" - } - }, - "required": [ - "ReplicaKmsKeyID" - ], - "type": "object" - }, - "EventBridgeConfiguration": { - "additionalProperties": false, - "description": "Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*.\n Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*", - "properties": { - "EventBridgeEnabled": { - "default": "true", - "description": "Enables delivery of events to Amazon EventBridge.", - "type": "boolean" - } - }, - "required": [ - "EventBridgeEnabled" - ], - "type": "object" - }, - "FilterRule": { - "additionalProperties": false, - "description": "Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as ``2023-`` or ``engineering/``. Then, you can use ``FilterRule`` to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.", - "properties": { - "Name": { - "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", - "maxLength": 1024, - "type": "string" - }, - "Value": { - "description": "The value that the filter searches for in object key names.", - "type": "string" - } - }, - "required": [ - "Value", - "Name" - ], - "type": "object" - }, - "IntelligentTieringConfiguration": { - "additionalProperties": false, - "description": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\n For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).", - "properties": { - "Id": { - "description": "The ID used to identify the S3 Intelligent-Tiering configuration.", - "type": "string" - }, - "Prefix": { - "description": "An object key name prefix that identifies the subset of objects to which the rule applies.", - "type": "string" - }, - "Status": { - "description": "Specifies the status of the configuration.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - }, - "TagFilters": { - "description": "A container for a key-value pair.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - }, - "Tierings": { - "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``.\n You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tiering" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Id", - "Status", - "Tierings" - ], - "type": "object" - }, - "InventoryConfiguration": { - "additionalProperties": false, - "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", - "properties": { - "Destination": { - "$ref": "#/definitions/Destination", - "description": "Contains information about where to publish the inventory results." - }, - "Enabled": { - "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated.", - "type": "boolean" - }, - "Id": { - "description": "The ID used to identify the inventory configuration.", - "type": "string" - }, - "IncludedObjectVersions": { - "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.", - "enum": [ - "All", - "Current" - ], - "type": "string" - }, - "OptionalFields": { - "description": "Contains the optional fields that are included in the inventory results.", - "insertionOrder": true, - "items": { - "enum": [ - "Size", - "LastModifiedDate", - "StorageClass", - "ETag", - "IsMultipartUploaded", - "ReplicationStatus", - "EncryptionStatus", - "ObjectLockRetainUntilDate", - "ObjectLockMode", - "ObjectLockLegalHoldStatus", - "IntelligentTieringAccessTier", - "BucketKeyStatus", - "ChecksumAlgorithm", - "ObjectAccessControlList", - "ObjectOwner" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "Prefix": { - "description": "Specifies the inventory filter prefix.", - "type": "string" - }, - "ScheduleFrequency": { - "description": "Specifies the schedule for generating inventory results.", - "enum": [ - "Daily", - "Weekly" - ], - "type": "string" - } - }, - "required": [ - "Destination", - "Enabled", - "Id", - "IncludedObjectVersions", - "ScheduleFrequency" - ], - "type": "object" - }, - "LambdaConfiguration": { - "additionalProperties": false, - "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", - "properties": { - "Event": { - "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket." - }, - "Function": { - "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs.", - "type": "string" - } - }, - "required": [ - "Function", - "Event" - ], - "type": "object" - }, - "LifecycleConfiguration": { - "additionalProperties": false, - "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.", - "properties": { - "Rules": { - "description": "A lifecycle rule for individual objects in an Amazon S3 bucket.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "LoggingConfiguration": { - "additionalProperties": false, - "description": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*.\n To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions.", - "properties": { - "DestinationBucketName": { - "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined.", - "type": "string" - }, - "LogFilePrefix": { - "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.", - "type": "string" - }, - "TargetObjectKeyFormat": { - "$ref": "#/definitions/TargetObjectKeyFormat", - "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed." - } - }, - "type": "object" - }, - "Metrics": { - "additionalProperties": false, - "description": "A container specifying replication metrics-related settings enabling replication metrics and events.", - "properties": { - "EventThreshold": { - "$ref": "#/definitions/ReplicationTimeValue", - "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event." - }, - "Status": { - "description": "Specifies whether the replication metrics are enabled.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "MetricsConfiguration": { - "additionalProperties": false, - "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For examples, see [AWS::S3::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#aws-properties-s3-bucket--examples). For more information, see [PUT Bucket metrics](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) in the *Amazon S3 API Reference*.", - "properties": { - "AccessPointArn": { - "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.", - "type": "string" - }, - "Id": { - "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration.", - "type": "string" - }, - "Prefix": { - "description": "The prefix that an object must have to be included in the metrics results.", - "type": "string" - }, - "TagFilters": { - "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "NoncurrentVersionExpiration": { - "additionalProperties": false, - "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html).", - "properties": { - "NewerNoncurrentVersions": { - "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", - "type": "integer" - }, - "NoncurrentDays": { - "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.", - "type": "integer" - } - }, - "required": [ - "NoncurrentDays" - ], - "type": "object" - }, - "NoncurrentVersionTransition": { - "additionalProperties": false, - "description": "Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.", - "properties": { - "NewerNoncurrentVersions": { - "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", - "type": "integer" - }, - "StorageClass": { - "description": "The class of storage used to store the object.", - "enum": [ - "DEEP_ARCHIVE", - "GLACIER", - "Glacier", - "GLACIER_IR", - "INTELLIGENT_TIERING", - "ONEZONE_IA", - "STANDARD_IA" - ], - "type": "string" - }, - "TransitionInDays": { - "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.", - "type": "integer" - } - }, - "required": [ - "StorageClass", - "TransitionInDays" - ], - "type": "object" - }, - "NotificationConfiguration": { - "additionalProperties": false, - "description": "Describes the notification configuration for an Amazon S3 bucket.\n If you create the target resource and related permissions in the same template, you might have a circular dependency.\n For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency.\n To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration.\n For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3).", - "properties": { - "EventBridgeConfiguration": { - "$ref": "#/definitions/EventBridgeConfiguration", - "description": "Enables delivery of events to Amazon EventBridge." - }, - "LambdaConfigurations": { - "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/LambdaConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "QueueConfigurations": { - "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/QueueConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "TopicConfigurations": { - "description": "The topic to which notifications are sent and the events for which notifications are generated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TopicConfiguration" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "NotificationFilter": { - "additionalProperties": false, - "description": "Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.", - "properties": { - "S3Key": { - "$ref": "#/definitions/S3KeyFilter", - "description": "A container for object key name prefix and suffix filtering rules." - } - }, - "required": [ - "S3Key" - ], - "type": "object" - }, - "ObjectLockConfiguration": { - "additionalProperties": false, - "description": "Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).", - "properties": { - "ObjectLockEnabled": { - "const": "Enabled", - "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", - "type": "string" - }, - "Rule": { - "$ref": "#/definitions/ObjectLockRule", - "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." - } - }, - "type": "object" - }, - "ObjectLockRule": { - "additionalProperties": false, - "description": "Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket.", - "properties": { - "DefaultRetention": { - "$ref": "#/definitions/DefaultRetention", - "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." - } - }, - "type": "object" - }, - "OwnershipControls": { - "additionalProperties": false, - "description": "Specifies the container element for Object Ownership rules.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", - "properties": { - "Rules": { - "description": "Specifies the container element for Object Ownership rules.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/OwnershipControlsRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "OwnershipControlsRule": { - "additionalProperties": false, - "description": "Specifies an Object Ownership rule.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", - "properties": { - "ObjectOwnership": { - "description": "Specifies an object ownership rule.", - "enum": [ - "ObjectWriter", - "BucketOwnerPreferred", - "BucketOwnerEnforced" - ], - "type": "string" - } - }, - "type": "object" - }, - "PartitionedPrefix": { - "additionalProperties": false, - "description": "Amazon S3 keys for log objects are partitioned in the following format:\n ``[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`` \n PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.", - "properties": { - "PartitionDateSource": { - "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.", - "enum": [ - "EventTime", - "DeliveryTime" - ], - "type": "string" - } - }, - "type": "object" - }, - "PublicAccessBlockConfiguration": { - "additionalProperties": false, - "description": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of \"Public\"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.", - "properties": { - "BlockPublicAcls": { - "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior:\n + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.\n + PUT Object calls fail if the request includes a public ACL.\n + PUT Bucket calls fail if the request includes a public ACL.\n \n Enabling this setting doesn't affect existing policies or ACLs.", - "type": "boolean" - }, - "BlockPublicPolicy": { - "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. \n Enabling this setting doesn't affect existing bucket policies.", - "type": "boolean" - }, - "IgnorePublicAcls": { - "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\n Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", - "type": "boolean" - }, - "RestrictPublicBuckets": { - "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy.\n Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", - "type": "boolean" - } - }, - "type": "object" - }, - "QueueConfiguration": { - "additionalProperties": false, - "description": "Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.", - "properties": { - "Event": { - "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." - }, - "Queue": { - "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination.", - "type": "string" - } - }, - "required": [ - "Event", - "Queue" - ], - "type": "object" - }, - "RedirectAllRequestsTo": { - "additionalProperties": false, - "description": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.", - "properties": { - "HostName": { - "description": "Name of the host where requests are redirected.", - "type": "string" - }, - "Protocol": { - "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", - "enum": [ - "http", - "https" - ], - "type": "string" - } - }, - "required": [ - "HostName" - ], - "type": "object" - }, - "RedirectRule": { - "additionalProperties": false, - "description": "Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.", - "properties": { - "HostName": { - "description": "The host name to use in the redirect request.", - "type": "string" - }, - "HttpRedirectCode": { - "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present.", - "type": "string" - }, - "Protocol": { - "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", - "enum": [ - "http", - "https" - ], - "type": "string" - }, - "ReplaceKeyPrefixWith": { - "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", - "type": "string" - }, - "ReplaceKeyWith": { - "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", - "type": "string" - } - }, - "type": "object" - }, - "ReplicaModifications": { - "additionalProperties": false, - "description": "A filter that you can specify for selection for modifications on replicas.", - "properties": { - "Status": { - "description": "Specifies whether Amazon S3 replicates modifications on replicas.\n *Allowed values*: ``Enabled`` | ``Disabled``", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "ReplicationConfiguration": { - "additionalProperties": false, - "description": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*.", - "properties": { - "Role": { - "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.", - "type": "string" - }, - "Rules": { - "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ReplicationRule", - "maxLength": 1000, - "minLength": 1 - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Role", - "Rules" - ], - "type": "object" - }, - "ReplicationDestination": { - "additionalProperties": false, - "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).", - "properties": { - "AccessControlTranslation": { - "$ref": "#/definitions/AccessControlTranslation", - "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." - }, - "Account": { - "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.\n If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.", - "type": "string" - }, - "Bucket": { - "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.", - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration", - "description": "Specifies encryption-related information." - }, - "Metrics": { - "$ref": "#/definitions/Metrics", - "description": "A container specifying replication metrics-related settings enabling replication metrics and events." - }, - "ReplicationTime": { - "$ref": "#/definitions/ReplicationTime", - "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." - }, - "StorageClass": { - "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. \n For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.", - "enum": [ - "DEEP_ARCHIVE", - "GLACIER", - "GLACIER_IR", - "INTELLIGENT_TIERING", - "ONEZONE_IA", - "REDUCED_REDUNDANCY", - "STANDARD", - "STANDARD_IA" - ], - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "ReplicationRule": { - "additionalProperties": false, - "description": "Specifies which Amazon S3 objects to replicate and where to store the replicas.", - "properties": { - "DeleteMarkerReplication": { - "$ref": "#/definitions/DeleteMarkerReplication", - "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." - }, - "Destination": { - "$ref": "#/definitions/ReplicationDestination", - "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." - }, - "Filter": { - "$ref": "#/definitions/ReplicationRuleFilter", - "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.\n V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element." - }, - "Id": { - "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as \"ID\".", - "maxLength": 255, - "type": "string" - }, - "Prefix": { - "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", - "maxLength": 1024, - "type": "string" - }, - "Priority": { - "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. \n For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.", - "type": "integer" - }, - "SourceSelectionCriteria": { - "$ref": "#/definitions/SourceSelectionCriteria", - "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." - }, - "Status": { - "description": "Specifies whether the rule is enabled.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - } - }, - "required": [ - "Destination", - "Status" - ], - "type": "object" - }, - "ReplicationRuleAndOperator": { - "additionalProperties": false, - "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. \n For example:\n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. \n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag", - "properties": { - "Prefix": { - "description": "An object key name prefix that identifies the subset of objects to which the rule applies.", - "type": "string" - }, - "TagFilters": { - "description": "An array of tags containing key and value pairs.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "ReplicationRuleFilter": { - "additionalProperties": false, - "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element.", - "properties": { - "And": { - "$ref": "#/definitions/ReplicationRuleAndOperator", - "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: \n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.\n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag." - }, - "Prefix": { - "description": "An object key name prefix that identifies the subset of objects to which the rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", - "type": "string" - }, - "TagFilter": { - "$ref": "#/definitions/TagFilter", - "description": "A container for specifying a tag key and value. \n The rule applies only to objects that have the tag in their tag set." - } - }, - "type": "object" - }, - "ReplicationTime": { - "additionalProperties": false, - "description": "A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block.", - "properties": { - "Status": { - "description": "Specifies whether the replication time is enabled.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - }, - "Time": { - "$ref": "#/definitions/ReplicationTimeValue", - "description": "A container specifying the time by which replication should be complete for all objects and operations on objects." - } - }, - "required": [ - "Status", - "Time" - ], - "type": "object" - }, - "ReplicationTimeValue": { - "additionalProperties": false, - "description": "A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``.", - "properties": { - "Minutes": { - "description": "Contains an integer specifying time in minutes. \n Valid value: 15", - "type": "integer" - } - }, - "required": [ - "Minutes" - ], - "type": "object" - }, - "RoutingRule": { - "additionalProperties": false, - "description": "Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.", - "properties": { - "RedirectRule": { - "$ref": "#/definitions/RedirectRule", - "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return." - }, - "RoutingRuleCondition": { - "$ref": "#/definitions/RoutingRuleCondition", - "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." - } - }, - "required": [ - "RedirectRule" - ], - "type": "object" - }, - "RoutingRuleCondition": { - "additionalProperties": false, - "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.", - "properties": { - "HttpErrorCodeReturnedEquals": { - "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.\n Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.", - "type": "string" - }, - "KeyPrefixEquals": { - "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder.\n Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.", - "type": "string" - } - }, - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "description": "Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*.\n You must specify at least one of the following properties: ``AbortIncompleteMultipartUpload``, ``ExpirationDate``, ``ExpirationInDays``, ``NoncurrentVersionExpirationInDays``, ``NoncurrentVersionTransition``, ``NoncurrentVersionTransitions``, ``Transition``, or ``Transitions``.", - "properties": { - "AbortIncompleteMultipartUpload": { - "$ref": "#/definitions/AbortIncompleteMultipartUpload", - "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket." - }, - "ExpirationDate": { - "$ref": "#/definitions/iso8601UTC", - "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." - }, - "ExpirationInDays": { - "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.", - "type": "integer" - }, - "ExpiredObjectDeleteMarker": { - "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.", - "type": "boolean" - }, - "Id": { - "description": "Unique identifier for the rule. The value can't be longer than 255 characters.", - "maxLength": 255, - "type": "string" - }, - "NoncurrentVersionExpiration": { - "$ref": "#/definitions/NoncurrentVersionExpiration", - "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime." - }, - "NoncurrentVersionExpirationInDays": { - "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.", - "type": "integer" - }, - "NoncurrentVersionTransition": { - "$ref": "#/definitions/NoncurrentVersionTransition", - "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." - }, - "NoncurrentVersionTransitions": { - "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NoncurrentVersionTransition" - }, - "type": "array", - "uniqueItems": true - }, - "ObjectSizeGreaterThan": { - "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", - "maxLength": 20, - "pattern": "[0-9]+", - "type": "string" - }, - "ObjectSizeLessThan": { - "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", - "maxLength": 20, - "pattern": "[0-9]+", - "type": "string" - }, - "Prefix": { - "description": "Object key prefix that identifies one or more objects to which this rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", - "type": "string" - }, - "Status": { - "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string" - }, - "TagFilters": { - "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TagFilter" - }, - "type": "array", - "uniqueItems": true - }, - "Transition": { - "$ref": "#/definitions/Transition", - "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property." - }, - "Transitions": { - "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Transition" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "S3KeyFilter": { - "additionalProperties": false, - "description": "A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.\n The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules.", - "properties": { - "Rules": { - "description": "A list of containers for the key-value pair that defines the criteria for the filter rule.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FilterRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "ServerSideEncryptionByDefault": { - "additionalProperties": false, - "description": "Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*.", - "properties": { - "KMSMasterKeyID": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/AliasName", - "typeName": "AWS::KMS::Alias" - } - } - ], - "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``.\n You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key Alias: ``alias/alias-name`` \n \n If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. \n If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", - "type": "string" - }, - "SSEAlgorithm": { - "description": "Server-side encryption algorithm to use for the default encryption.", - "enum": [ - "aws:kms", - "AES256", - "aws:kms:dsse" - ], - "type": "string" - } - }, - "required": [ - "SSEAlgorithm" - ], - "type": "object" - }, - "ServerSideEncryptionRule": { - "additionalProperties": false, - "description": "Specifies the default server-side encryption configuration.", - "properties": { - "BucketKeyEnabled": { - "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.\n For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.", - "type": "boolean" - }, - "ServerSideEncryptionByDefault": { - "$ref": "#/definitions/ServerSideEncryptionByDefault", - "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied." - } - }, - "type": "object" - }, - "SourceSelectionCriteria": { - "additionalProperties": false, - "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.", - "properties": { - "ReplicaModifications": { - "$ref": "#/definitions/ReplicaModifications", - "description": "A filter that you can specify for selection for modifications on replicas." - }, - "SseKmsEncryptedObjects": { - "$ref": "#/definitions/SseKmsEncryptedObjects", - "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS." - } - }, - "type": "object" - }, - "SseKmsEncryptedObjects": { - "additionalProperties": false, - "description": "A container for filter information for the selection of S3 objects encrypted with AWS KMS.", - "properties": { - "Status": { - "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.", - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "StorageClassAnalysis": { - "additionalProperties": false, - "description": "Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.", - "properties": { - "DataExport": { - "$ref": "#/definitions/DataExport", - "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported." - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A container of a key value name pair.", - "properties": { - "Key": { - "description": "Name of the object key.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Value of the tag.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TagFilter": { - "additionalProperties": false, - "description": "Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.", - "properties": { - "Key": { - "description": "The tag key.", - "type": "string" - }, - "Value": { - "description": "The tag value.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TargetObjectKeyFormat": { - "description": "Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "SimplePrefix": { - "additionalProperties": false, - "description": "This format defaults the prefix to the given log file prefix for delivering server access log file.", - "type": "object" - } - }, - "required": [ - "SimplePrefix" - ] - }, - { - "additionalProperties": false, - "properties": { - "PartitionedPrefix": { - "$ref": "#/definitions/PartitionedPrefix" - } - }, - "required": [ - "PartitionedPrefix" - ] - } - ], - "type": "object" - }, - "Tiering": { - "additionalProperties": false, - "description": "The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.", - "properties": { - "AccessTier": { - "description": "S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.", - "enum": [ - "ARCHIVE_ACCESS", - "DEEP_ARCHIVE_ACCESS" - ], - "type": "string" - }, - "Days": { - "description": "The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).", - "type": "integer" - } - }, - "required": [ - "AccessTier", - "Days" - ], - "type": "object" - }, - "TopicConfiguration": { - "additionalProperties": false, - "description": "A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.", - "properties": { - "Event": { - "description": "The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket." - }, - "Topic": { - "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.", - "type": "string" - } - }, - "required": [ - "Event", - "Topic" - ], - "type": "object" - }, - "Transition": { - "additionalProperties": false, - "description": "Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.", - "properties": { - "StorageClass": { - "description": "The storage class to which you want the object to transition.", - "enum": [ - "DEEP_ARCHIVE", - "GLACIER", - "Glacier", - "GLACIER_IR", - "INTELLIGENT_TIERING", - "ONEZONE_IA", - "STANDARD_IA" - ], - "type": "string" - }, - "TransitionDate": { - "$ref": "#/definitions/iso8601UTC", - "description": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC." - }, - "TransitionInDays": { - "description": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.", - "type": "integer" - } - }, - "required": [ - "StorageClass" - ], - "type": "object" - }, - "VersioningConfiguration": { - "additionalProperties": false, - "description": "Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.", - "properties": { - "Status": { - "default": "Suspended", - "description": "The versioning state of the bucket.", - "enum": [ - "Enabled", - "Suspended" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "WebsiteConfiguration": { - "additionalProperties": false, - "description": "Specifies website configuration parameters for an Amazon S3 bucket.", - "properties": { - "ErrorDocument": { - "description": "The name of the error document for the website.", - "type": "string" - }, - "IndexDocument": { - "description": "The name of the index document for the website.", - "type": "string" - }, - "RedirectAllRequestsTo": { - "$ref": "#/definitions/RedirectAllRequestsTo", - "description": "The redirect behavior for every request to this bucket's website endpoint.\n If you specify this property, you can't specify any other property." - }, - "RoutingRules": { - "description": "Rules that define when a redirect is applied and the redirect behavior.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/RoutingRule" - }, - "type": "array" - } - }, - "type": "object" - }, - "iso8601UTC": { - "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "The ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.\n To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n You can only delete empty buckets. Deletion fails for buckets that have contents.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateBucket", - "s3:PutBucketTagging", - "s3:PutAnalyticsConfiguration", - "s3:PutEncryptionConfiguration", - "s3:PutBucketCORS", - "s3:PutInventoryConfiguration", - "s3:PutLifecycleConfiguration", - "s3:PutMetricsConfiguration", - "s3:PutBucketNotification", - "s3:PutBucketReplication", - "s3:PutBucketWebsite", - "s3:PutAccelerateConfiguration", - "s3:PutBucketPublicAccessBlock", - "s3:PutReplicationConfiguration", - "s3:PutObjectAcl", - "s3:PutBucketObjectLockConfiguration", - "s3:GetBucketAcl", - "s3:ListBucket", - "iam:PassRole", - "s3:DeleteObject", - "s3:PutBucketLogging", - "s3:PutBucketVersioning", - "s3:PutObjectLockConfiguration", - "s3:PutBucketOwnershipControls", - "s3:PutIntelligentTieringConfiguration" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteBucket", - "s3:ListBucket" - ] - }, - "list": { - "permissions": [ - "s3:ListAllMyBuckets" - ] - }, - "read": { - "permissions": [ - "s3:GetAccelerateConfiguration", - "s3:GetLifecycleConfiguration", - "s3:GetBucketPublicAccessBlock", - "s3:GetAnalyticsConfiguration", - "s3:GetBucketCORS", - "s3:GetEncryptionConfiguration", - "s3:GetInventoryConfiguration", - "s3:GetBucketLogging", - "s3:GetMetricsConfiguration", - "s3:GetBucketNotification", - "s3:GetBucketVersioning", - "s3:GetReplicationConfiguration", - "S3:GetBucketWebsite", - "s3:GetBucketPublicAccessBlock", - "s3:GetBucketObjectLockConfiguration", - "s3:GetBucketTagging", - "s3:GetBucketOwnershipControls", - "s3:GetIntelligentTieringConfiguration", - "s3:ListBucket" - ] - }, - "update": { - "permissions": [ - "s3:PutBucketAcl", - "s3:PutBucketTagging", - "s3:PutAnalyticsConfiguration", - "s3:PutEncryptionConfiguration", - "s3:PutBucketCORS", - "s3:PutInventoryConfiguration", - "s3:PutLifecycleConfiguration", - "s3:PutMetricsConfiguration", - "s3:PutBucketNotification", - "s3:PutBucketReplication", - "s3:PutBucketWebsite", - "s3:PutAccelerateConfiguration", - "s3:PutBucketPublicAccessBlock", - "s3:PutReplicationConfiguration", - "s3:PutBucketOwnershipControls", - "s3:PutIntelligentTieringConfiguration", - "s3:DeleteBucketWebsite", - "s3:PutBucketLogging", - "s3:PutBucketVersioning", - "s3:PutObjectLockConfiguration", - "s3:PutBucketObjectLockConfiguration", - "s3:DeleteBucketAnalyticsConfiguration", - "s3:DeleteBucketCors", - "s3:DeleteBucketMetricsConfiguration", - "s3:DeleteBucketEncryption", - "s3:DeleteBucketLifecycle", - "s3:DeleteBucketReplication", - "iam:PassRole", - "s3:ListBucket" - ] - } - }, - "primaryIdentifier": [ - "/properties/BucketName" - ], - "properties": { - "AccelerateConfiguration": { - "$ref": "#/definitions/AccelerateConfiguration", - "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." - }, - "AccessControl": { - "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.\n A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.\n S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.\n The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.", - "enum": [ - "AuthenticatedRead", - "AwsExecRead", - "BucketOwnerFullControl", - "BucketOwnerRead", - "LogDeliveryWrite", - "Private", - "PublicRead", - "PublicReadWrite" - ], - "type": "string" - }, - "AnalyticsConfigurations": { - "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AnalyticsConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "$ref": "#/definitions/Arn", - "description": "", - "examples": [ - "arn:aws:s3:::mybucket" - ] - }, - "BucketEncryption": { - "$ref": "#/definitions/BucketEncryption", - "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." - }, - "BucketName": { - "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.", - "type": "string" - }, - "CorsConfiguration": { - "$ref": "#/definitions/CorsConfiguration", - "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." - }, - "DomainName": { - "description": "", - "examples": [ - "mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com" - ], - "type": "string" - }, - "DualStackDomainName": { - "description": "", - "examples": [ - "mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com" - ], - "type": "string" - }, - "IntelligentTieringConfigurations": { - "description": "Defines how Amazon S3 handles Intelligent-Tiering storage.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IntelligentTieringConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "InventoryConfigurations": { - "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/InventoryConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "LifecycleConfiguration": { - "$ref": "#/definitions/LifecycleConfiguration", - "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." - }, - "LoggingConfiguration": { - "$ref": "#/definitions/LoggingConfiguration", - "description": "Settings that define where logs are stored." - }, - "MetricsConfigurations": { - "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricsConfiguration" - }, - "type": "array", - "uniqueItems": true - }, - "NotificationConfiguration": { - "$ref": "#/definitions/NotificationConfiguration", - "description": "Configuration that defines how Amazon S3 handles bucket notifications." - }, - "ObjectLockConfiguration": { - "$ref": "#/definitions/ObjectLockConfiguration", - "description": "This operation is not supported by directory buckets.\n Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). \n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.\n + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html)." - }, - "ObjectLockEnabled": { - "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", - "type": "boolean" - }, - "OwnershipControls": { - "$ref": "#/definitions/OwnershipControls", - "description": "Configuration that defines how Amazon S3 handles Object Ownership rules." - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/PublicAccessBlockConfiguration", - "description": "Configuration that defines how Amazon S3 handles public access." - }, - "RegionalDomainName": { - "description": "", - "examples": [ - "mystack-mybucket-kdwwxmddtr2g.s3.us-east-2.amazonaws.com" - ], - "type": "string" - }, - "ReplicationConfiguration": { - "$ref": "#/definitions/ReplicationConfiguration", - "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.\n Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist." - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VersioningConfiguration": { - "$ref": "#/definitions/VersioningConfiguration", - "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them." - }, - "WebsiteConfiguration": { - "$ref": "#/definitions/WebsiteConfiguration", - "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)." - }, - "WebsiteURL": { - "description": "", - "examples": [ - "Example (IPv4): http://mystack-mybucket-kdwwxmddtr2g.s3-website-us-east-2.amazonaws.com/", - "Example (IPv6): http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com/" - ], - "format": "uri", - "type": "string" - } - }, - "propertyTransform": { - "/properties/NotificationConfiguration/LambdaConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", - "/properties/NotificationConfiguration/QueueConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", - "/properties/NotificationConfiguration/TopicConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/DomainName", - "/properties/DualStackDomainName", - "/properties/RegionalDomainName", - "/properties/WebsiteURL" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::Bucket", - "writeOnlyProperties": [ - "/properties/AccessControl", - "/properties/LifecycleConfiguration/Rules/*/NoncurrentVersionExpirationInDays", - "/properties/LifecycleConfiguration/Rules/*/NoncurrentVersionTransition", - "/properties/LifecycleConfiguration/Rules/*/Transition", - "/properties/ReplicationConfiguration/Rules/*/Prefix", - "/properties/LifecycleConfiguration/Rules/*/ExpiredObjectDeleteMarker" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BucketName" + ], + "definitions": { + "AbortIncompleteMultipartUpload": { + "additionalProperties": false, + "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.", + "properties": { + "DaysAfterInitiation": { + "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "DaysAfterInitiation" + ], + "type": "object" + }, + "AccelerateConfiguration": { + "additionalProperties": false, + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.", + "properties": { + "AccelerationStatus": { + "description": "Specifies the transfer acceleration status of the bucket.", + "enum": [ + "Enabled", + "Suspended" + ], + "type": "string" + } + }, + "required": [ + "AccelerationStatus" + ], + "type": "object" + }, + "AccessControlTranslation": { + "additionalProperties": false, + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object.", + "properties": { + "Owner": { + "const": "Destination", + "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.", + "type": "string" + } + }, + "required": [ + "Owner" + ], + "type": "object" + }, + "AnalyticsConfiguration": { + "additionalProperties": false, + "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", + "properties": { + "Id": { + "description": "The ID that identifies the analytics configuration.", + "type": "string" + }, + "Prefix": { + "description": "The prefix that an object must have to be included in the analytics results.", + "type": "string" + }, + "StorageClassAnalysis": { + "$ref": "#/definitions/StorageClassAnalysis", + "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes." + }, + "TagFilters": { + "description": "The tags to use when evaluating an analytics filter.\n The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "StorageClassAnalysis", + "Id" + ], + "type": "object" + }, + "Arn": { + "description": "the Amazon Resource Name (ARN) of the specified bucket.", + "type": "string" + }, + "BucketEncryption": { + "additionalProperties": false, + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.", + "properties": { + "ServerSideEncryptionConfiguration": { + "description": "Specifies the default server-side-encryption configuration.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ServerSideEncryptionRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ServerSideEncryptionConfiguration" + ], + "type": "object" + }, + "CorsConfiguration": { + "additionalProperties": false, + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.", + "properties": { + "CorsRules": { + "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/CorsRule", + "maxLength": 100 + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "CorsRules" + ], + "type": "object" + }, + "CorsRule": { + "additionalProperties": false, + "description": "Specifies a cross-origin access rule for an Amazon S3 bucket.", + "properties": { + "AllowedHeaders": { + "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AllowedMethods": { + "description": "An HTTP method that you allow the origin to run.\n *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``", + "insertionOrder": true, + "items": { + "enum": [ + "GET", + "PUT", + "HEAD", + "POST", + "DELETE" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AllowedOrigins": { + "description": "One or more origins you want customers to be able to access the bucket from.", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ExposedHeaders": { + "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "A unique identifier for this rule. The value must be no more than 255 characters.", + "maxLength": 255, + "type": "string" + }, + "MaxAge": { + "description": "The time in seconds that your browser is to cache the preflight response for the specified resource.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "AllowedMethods", + "AllowedOrigins" + ], + "type": "object" + }, + "DataExport": { + "additionalProperties": false, + "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.", + "properties": { + "Destination": { + "$ref": "#/definitions/Destination", + "description": "The place to store the data for an analysis." + }, + "OutputSchemaVersion": { + "const": "V_1", + "description": "The version of the output schema to use when exporting data. Must be ``V_1``.", + "type": "string" + } + }, + "required": [ + "Destination", + "OutputSchemaVersion" + ], + "type": "object" + }, + "DefaultRetention": { + "additionalProperties": false, + "description": "The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.\n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.", + "properties": { + "Days": { + "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", + "type": "integer" + }, + "Mode": { + "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", + "enum": [ + "COMPLIANCE", + "GOVERNANCE" + ], + "type": "string" + }, + "Years": { + "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", + "type": "integer" + } + }, + "type": "object" + }, + "DeleteMarkerReplication": { + "additionalProperties": false, + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).", + "properties": { + "Status": { + "description": "Indicates whether to replicate delete markers. Disabled by default.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + } + }, + "type": "object" + }, + "Destination": { + "additionalProperties": false, + "description": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.", + "properties": { + "BucketAccountId": { + "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.", + "type": "string" + }, + "BucketArn": { + "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported.", + "type": "string" + }, + "Format": { + "description": "Specifies the file format used when exporting data to Amazon S3.\n *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``", + "enum": [ + "CSV", + "ORC", + "Parquet" + ], + "type": "string" + }, + "Prefix": { + "description": "The prefix to use when exporting data. The prefix is prepended to all results.", + "type": "string" + } + }, + "required": [ + "BucketArn", + "Format" + ], + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.\n If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester\u2019s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.", + "properties": { + "ReplicaKmsKeyID": { + "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", + "type": "string" + } + }, + "required": [ + "ReplicaKmsKeyID" + ], + "type": "object" + }, + "EventBridgeConfiguration": { + "additionalProperties": false, + "description": "Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*.\n Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*", + "properties": { + "EventBridgeEnabled": { + "default": "true", + "description": "Enables delivery of events to Amazon EventBridge.", + "type": "boolean" + } + }, + "required": [ + "EventBridgeEnabled" + ], + "type": "object" + }, + "FilterRule": { + "additionalProperties": false, + "description": "Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as ``2023-`` or ``engineering/``. Then, you can use ``FilterRule`` to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.", + "properties": { + "Name": { + "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", + "maxLength": 1024, + "type": "string" + }, + "Value": { + "description": "The value that the filter searches for in object key names.", + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "IntelligentTieringConfiguration": { + "additionalProperties": false, + "description": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\n For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).", + "properties": { + "Id": { + "description": "The ID used to identify the S3 Intelligent-Tiering configuration.", + "type": "string" + }, + "Prefix": { + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.", + "type": "string" + }, + "Status": { + "description": "Specifies the status of the configuration.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + }, + "TagFilters": { + "description": "A container for a key-value pair.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + }, + "Tierings": { + "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``.\n You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tiering" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Id", + "Status", + "Tierings" + ], + "type": "object" + }, + "InventoryConfiguration": { + "additionalProperties": false, + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", + "properties": { + "Destination": { + "$ref": "#/definitions/Destination", + "description": "Contains information about where to publish the inventory results." + }, + "Enabled": { + "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated.", + "type": "boolean" + }, + "Id": { + "description": "The ID used to identify the inventory configuration.", + "type": "string" + }, + "IncludedObjectVersions": { + "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.", + "enum": [ + "All", + "Current" + ], + "type": "string" + }, + "OptionalFields": { + "description": "Contains the optional fields that are included in the inventory results.", + "insertionOrder": true, + "items": { + "enum": [ + "Size", + "LastModifiedDate", + "StorageClass", + "ETag", + "IsMultipartUploaded", + "ReplicationStatus", + "EncryptionStatus", + "ObjectLockRetainUntilDate", + "ObjectLockMode", + "ObjectLockLegalHoldStatus", + "IntelligentTieringAccessTier", + "BucketKeyStatus", + "ChecksumAlgorithm", + "ObjectAccessControlList", + "ObjectOwner" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "Prefix": { + "description": "Specifies the inventory filter prefix.", + "type": "string" + }, + "ScheduleFrequency": { + "description": "Specifies the schedule for generating inventory results.", + "enum": [ + "Daily", + "Weekly" + ], + "type": "string" + } + }, + "required": [ + "Destination", + "Enabled", + "Id", + "IncludedObjectVersions", + "ScheduleFrequency" + ], + "type": "object" + }, + "LambdaConfiguration": { + "additionalProperties": false, + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", + "properties": { + "Event": { + "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", + "type": "string" + }, + "Filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket." + }, + "Function": { + "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs.", + "type": "string" + } + }, + "required": [ + "Function", + "Event" + ], + "type": "object" + }, + "LifecycleConfiguration": { + "additionalProperties": false, + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.", + "properties": { + "Rules": { + "description": "A lifecycle rule for individual objects in an Amazon S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Rules" + ], + "type": "object" + }, + "LoggingConfiguration": { + "additionalProperties": false, + "description": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*.\n To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions.", + "properties": { + "DestinationBucketName": { + "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined.", + "type": "string" + }, + "LogFilePrefix": { + "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.", + "type": "string" + }, + "TargetObjectKeyFormat": { + "$ref": "#/definitions/TargetObjectKeyFormat", + "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed." + } + }, + "type": "object" + }, + "Metrics": { + "additionalProperties": false, + "description": "A container specifying replication metrics-related settings enabling replication metrics and events.", + "properties": { + "EventThreshold": { + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event." + }, + "Status": { + "description": "Specifies whether the replication metrics are enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "MetricsConfiguration": { + "additionalProperties": false, + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For examples, see [AWS::S3::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#aws-properties-s3-bucket--examples). For more information, see [PUT Bucket metrics](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) in the *Amazon S3 API Reference*.", + "properties": { + "AccessPointArn": { + "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.", + "type": "string" + }, + "Id": { + "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration.", + "type": "string" + }, + "Prefix": { + "description": "The prefix that an object must have to be included in the metrics results.", + "type": "string" + }, + "TagFilters": { + "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "NoncurrentVersionExpiration": { + "additionalProperties": false, + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html).", + "properties": { + "NewerNoncurrentVersions": { + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", + "type": "integer" + }, + "NoncurrentDays": { + "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.", + "type": "integer" + } + }, + "required": [ + "NoncurrentDays" + ], + "type": "object" + }, + "NoncurrentVersionTransition": { + "additionalProperties": false, + "description": "Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.", + "properties": { + "NewerNoncurrentVersions": { + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", + "type": "integer" + }, + "StorageClass": { + "description": "The class of storage used to store the object.", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "Glacier", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "STANDARD_IA" + ], + "type": "string" + }, + "TransitionInDays": { + "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.", + "type": "integer" + } + }, + "required": [ + "StorageClass", + "TransitionInDays" + ], + "type": "object" + }, + "NotificationConfiguration": { + "additionalProperties": false, + "description": "Describes the notification configuration for an Amazon S3 bucket.\n If you create the target resource and related permissions in the same template, you might have a circular dependency.\n For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency.\n To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration.\n For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3).", + "properties": { + "EventBridgeConfiguration": { + "$ref": "#/definitions/EventBridgeConfiguration", + "description": "Enables delivery of events to Amazon EventBridge." + }, + "LambdaConfigurations": { + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/LambdaConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "QueueConfigurations": { + "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/QueueConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "TopicConfigurations": { + "description": "The topic to which notifications are sent and the events for which notifications are generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TopicConfiguration" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "NotificationFilter": { + "additionalProperties": false, + "description": "Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.", + "properties": { + "S3Key": { + "$ref": "#/definitions/S3KeyFilter", + "description": "A container for object key name prefix and suffix filtering rules." + } + }, + "required": [ + "S3Key" + ], + "type": "object" + }, + "ObjectLockConfiguration": { + "additionalProperties": false, + "description": "Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).", + "properties": { + "ObjectLockEnabled": { + "const": "Enabled", + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", + "type": "string" + }, + "Rule": { + "$ref": "#/definitions/ObjectLockRule", + "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." + } + }, + "type": "object" + }, + "ObjectLockRule": { + "additionalProperties": false, + "description": "Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket.", + "properties": { + "DefaultRetention": { + "$ref": "#/definitions/DefaultRetention", + "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." + } + }, + "type": "object" + }, + "OwnershipControls": { + "additionalProperties": false, + "description": "Specifies the container element for Object Ownership rules.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", + "properties": { + "Rules": { + "description": "Specifies the container element for Object Ownership rules.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/OwnershipControlsRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Rules" + ], + "type": "object" + }, + "OwnershipControlsRule": { + "additionalProperties": false, + "description": "Specifies an Object Ownership rule.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", + "properties": { + "ObjectOwnership": { + "description": "Specifies an object ownership rule.", + "enum": [ + "ObjectWriter", + "BucketOwnerPreferred", + "BucketOwnerEnforced" + ], + "type": "string" + } + }, + "type": "object" + }, + "PartitionedPrefix": { + "additionalProperties": false, + "description": "Amazon S3 keys for log objects are partitioned in the following format:\n ``[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`` \n PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.", + "properties": { + "PartitionDateSource": { + "description": "Specifies the partition date source for the partitioned prefix. ``PartitionDateSource`` can be ``EventTime`` or ``DeliveryTime``.\n For ``DeliveryTime``, the time in the log file names corresponds to the delivery time for the log files. \n For ``EventTime``, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.", + "enum": [ + "EventTime", + "DeliveryTime" + ], + "type": "string" + } + }, + "type": "object" + }, + "PublicAccessBlockConfiguration": { + "additionalProperties": false, + "description": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of \"Public\"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.", + "properties": { + "BlockPublicAcls": { + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior:\n + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.\n + PUT Object calls fail if the request includes a public ACL.\n + PUT Bucket calls fail if the request includes a public ACL.\n \n Enabling this setting doesn't affect existing policies or ACLs.", + "type": "boolean" + }, + "BlockPublicPolicy": { + "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. \n Enabling this setting doesn't affect existing bucket policies.", + "type": "boolean" + }, + "IgnorePublicAcls": { + "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\n Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy.\n Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", + "type": "boolean" + } + }, + "type": "object" + }, + "QueueConfiguration": { + "additionalProperties": false, + "description": "Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.", + "properties": { + "Event": { + "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", + "type": "string" + }, + "Filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." + }, + "Queue": { + "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination.", + "type": "string" + } + }, + "required": [ + "Event", + "Queue" + ], + "type": "object" + }, + "RedirectAllRequestsTo": { + "additionalProperties": false, + "description": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.", + "properties": { + "HostName": { + "description": "Name of the host where requests are redirected.", + "type": "string" + }, + "Protocol": { + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", + "enum": [ + "http", + "https" + ], + "type": "string" + } + }, + "required": [ + "HostName" + ], + "type": "object" + }, + "RedirectRule": { + "additionalProperties": false, + "description": "Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.", + "properties": { + "HostName": { + "description": "The host name to use in the redirect request.", + "type": "string" + }, + "HttpRedirectCode": { + "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present.", + "type": "string" + }, + "Protocol": { + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", + "enum": [ + "http", + "https" + ], + "type": "string" + }, + "ReplaceKeyPrefixWith": { + "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", + "type": "string" + }, + "ReplaceKeyWith": { + "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", + "type": "string" + } + }, + "type": "object" + }, + "ReplicaModifications": { + "additionalProperties": false, + "description": "A filter that you can specify for selection for modifications on replicas.", + "properties": { + "Status": { + "description": "Specifies whether Amazon S3 replicates modifications on replicas.\n *Allowed values*: ``Enabled`` | ``Disabled``", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "ReplicationConfiguration": { + "additionalProperties": false, + "description": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*.", + "properties": { + "Role": { + "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.", + "type": "string" + }, + "Rules": { + "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ReplicationRule", + "maxLength": 1000, + "minLength": 1 + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Role", + "Rules" + ], + "type": "object" + }, + "ReplicationDestination": { + "additionalProperties": false, + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).", + "properties": { + "AccessControlTranslation": { + "$ref": "#/definitions/AccessControlTranslation", + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." + }, + "Account": { + "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.\n If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.", + "type": "string" + }, + "Bucket": { + "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.", + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration", + "description": "Specifies encryption-related information." + }, + "Metrics": { + "$ref": "#/definitions/Metrics", + "description": "A container specifying replication metrics-related settings enabling replication metrics and events." + }, + "ReplicationTime": { + "$ref": "#/definitions/ReplicationTime", + "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." + }, + "StorageClass": { + "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. \n For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "REDUCED_REDUNDANCY", + "STANDARD", + "STANDARD_IA" + ], + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + }, + "ReplicationRule": { + "additionalProperties": false, + "description": "Specifies which Amazon S3 objects to replicate and where to store the replicas.", + "properties": { + "DeleteMarkerReplication": { + "$ref": "#/definitions/DeleteMarkerReplication", + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." + }, + "Destination": { + "$ref": "#/definitions/ReplicationDestination", + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." + }, + "Filter": { + "$ref": "#/definitions/ReplicationRuleFilter", + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.\n V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element." + }, + "Id": { + "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as \"ID\".", + "maxLength": 255, + "type": "string" + }, + "Prefix": { + "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", + "maxLength": 1024, + "type": "string" + }, + "Priority": { + "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. \n For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.", + "type": "integer" + }, + "SourceSelectionCriteria": { + "$ref": "#/definitions/SourceSelectionCriteria", + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." + }, + "Status": { + "description": "Specifies whether the rule is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + } + }, + "required": [ + "Destination", + "Status" + ], + "type": "object" + }, + "ReplicationRuleAndOperator": { + "additionalProperties": false, + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. \n For example:\n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. \n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag", + "properties": { + "Prefix": { + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.", + "type": "string" + }, + "TagFilters": { + "description": "An array of tags containing key and value pairs.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ReplicationRuleFilter": { + "additionalProperties": false, + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element.", + "properties": { + "And": { + "$ref": "#/definitions/ReplicationRuleAndOperator", + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: \n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.\n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag." + }, + "Prefix": { + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", + "type": "string" + }, + "TagFilter": { + "$ref": "#/definitions/TagFilter", + "description": "A container for specifying a tag key and value. \n The rule applies only to objects that have the tag in their tag set." + } + }, + "type": "object" + }, + "ReplicationTime": { + "additionalProperties": false, + "description": "A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block.", + "properties": { + "Status": { + "description": "Specifies whether the replication time is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + }, + "Time": { + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time by which replication should be complete for all objects and operations on objects." + } + }, + "required": [ + "Status", + "Time" + ], + "type": "object" + }, + "ReplicationTimeValue": { + "additionalProperties": false, + "description": "A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``.", + "properties": { + "Minutes": { + "description": "Contains an integer specifying time in minutes. \n Valid value: 15", + "type": "integer" + } + }, + "required": [ + "Minutes" + ], + "type": "object" + }, + "RoutingRule": { + "additionalProperties": false, + "description": "Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.", + "properties": { + "RedirectRule": { + "$ref": "#/definitions/RedirectRule", + "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return." + }, + "RoutingRuleCondition": { + "$ref": "#/definitions/RoutingRuleCondition", + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." + } + }, + "required": [ + "RedirectRule" + ], + "type": "object" + }, + "RoutingRuleCondition": { + "additionalProperties": false, + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.", + "properties": { + "HttpErrorCodeReturnedEquals": { + "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.\n Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.", + "type": "string" + }, + "KeyPrefixEquals": { + "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder.\n Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.", + "type": "string" + } + }, + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "description": "Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*.\n You must specify at least one of the following properties: ``AbortIncompleteMultipartUpload``, ``ExpirationDate``, ``ExpirationInDays``, ``NoncurrentVersionExpirationInDays``, ``NoncurrentVersionTransition``, ``NoncurrentVersionTransitions``, ``Transition``, or ``Transitions``.", + "properties": { + "AbortIncompleteMultipartUpload": { + "$ref": "#/definitions/AbortIncompleteMultipartUpload", + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket." + }, + "ExpirationDate": { + "$ref": "#/definitions/iso8601UTC", + "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." + }, + "ExpirationInDays": { + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.", + "type": "integer" + }, + "ExpiredObjectDeleteMarker": { + "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.", + "type": "boolean" + }, + "Id": { + "description": "Unique identifier for the rule. The value can't be longer than 255 characters.", + "maxLength": 255, + "type": "string" + }, + "NoncurrentVersionExpiration": { + "$ref": "#/definitions/NoncurrentVersionExpiration", + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime." + }, + "NoncurrentVersionExpirationInDays": { + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.", + "type": "integer" + }, + "NoncurrentVersionTransition": { + "$ref": "#/definitions/NoncurrentVersionTransition", + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." + }, + "NoncurrentVersionTransitions": { + "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NoncurrentVersionTransition" + }, + "type": "array", + "uniqueItems": true + }, + "ObjectSizeGreaterThan": { + "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", + "maxLength": 20, + "pattern": "[0-9]+", + "type": "string" + }, + "ObjectSizeLessThan": { + "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", + "maxLength": 20, + "pattern": "[0-9]+", + "type": "string" + }, + "Prefix": { + "description": "Object key prefix that identifies one or more objects to which this rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", + "type": "string" + }, + "Status": { + "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string" + }, + "TagFilters": { + "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TagFilter" + }, + "type": "array", + "uniqueItems": true + }, + "Transition": { + "$ref": "#/definitions/Transition", + "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property." + }, + "Transitions": { + "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Transition" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "S3KeyFilter": { + "additionalProperties": false, + "description": "A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.\n The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules.", + "properties": { + "Rules": { + "description": "A list of containers for the key-value pair that defines the criteria for the filter rule.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Rules" + ], + "type": "object" + }, + "ServerSideEncryptionByDefault": { + "additionalProperties": false, + "description": "Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*.\n If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester\u2019s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.", + "properties": { + "KMSMasterKeyID": { + "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``.\n You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key Alias: ``alias/alias-name`` \n \n If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. \n If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", + "type": "string" + }, + "SSEAlgorithm": { + "description": "Server-side encryption algorithm to use for the default encryption.", + "enum": [ + "aws:kms", + "AES256", + "aws:kms:dsse" + ], + "type": "string" + } + }, + "required": [ + "SSEAlgorithm" + ], + "type": "object" + }, + "ServerSideEncryptionRule": { + "additionalProperties": false, + "description": "Specifies the default server-side encryption configuration.\n If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester\u2019s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.", + "properties": { + "BucketKeyEnabled": { + "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.\n For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.", + "type": "boolean" + }, + "ServerSideEncryptionByDefault": { + "$ref": "#/definitions/ServerSideEncryptionByDefault", + "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied." + } + }, + "type": "object" + }, + "SourceSelectionCriteria": { + "additionalProperties": false, + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.", + "properties": { + "ReplicaModifications": { + "$ref": "#/definitions/ReplicaModifications", + "description": "A filter that you can specify for selection for modifications on replicas." + }, + "SseKmsEncryptedObjects": { + "$ref": "#/definitions/SseKmsEncryptedObjects", + "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS." + } + }, + "type": "object" + }, + "SseKmsEncryptedObjects": { + "additionalProperties": false, + "description": "A container for filter information for the selection of S3 objects encrypted with AWS KMS.", + "properties": { + "Status": { + "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "StorageClassAnalysis": { + "additionalProperties": false, + "description": "Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.", + "properties": { + "DataExport": { + "$ref": "#/definitions/DataExport", + "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported." + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A container of a key value name pair.", + "properties": { + "Key": { + "description": "Name of the object key.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Value of the tag.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TagFilter": { + "additionalProperties": false, + "description": "Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.", + "properties": { + "Key": { + "description": "The tag key.", + "type": "string" + }, + "Value": { + "description": "The tag value.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TargetObjectKeyFormat": { + "description": "Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SimplePrefix": { + "additionalProperties": false, + "description": "This format defaults the prefix to the given log file prefix for delivering server access log file.", + "type": "object" + } + }, + "required": [ + "SimplePrefix" + ] + }, + { + "additionalProperties": false, + "properties": { + "PartitionedPrefix": { + "$ref": "#/definitions/PartitionedPrefix" + } + }, + "required": [ + "PartitionedPrefix" + ] + } + ], + "type": "object" + }, + "Tiering": { + "additionalProperties": false, + "description": "The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.", + "properties": { + "AccessTier": { + "description": "S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.", + "enum": [ + "ARCHIVE_ACCESS", + "DEEP_ARCHIVE_ACCESS" + ], + "type": "string" + }, + "Days": { + "description": "The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).", + "type": "integer" + } + }, + "required": [ + "AccessTier", + "Days" + ], + "type": "object" + }, + "TopicConfiguration": { + "additionalProperties": false, + "description": "A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.", + "properties": { + "Event": { + "description": "The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", + "type": "string" + }, + "Filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket." + }, + "Topic": { + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.", + "type": "string" + } + }, + "required": [ + "Event", + "Topic" + ], + "type": "object" + }, + "Transition": { + "additionalProperties": false, + "description": "Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.", + "properties": { + "StorageClass": { + "description": "The storage class to which you want the object to transition.", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "Glacier", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "STANDARD_IA" + ], + "type": "string" + }, + "TransitionDate": { + "$ref": "#/definitions/iso8601UTC", + "description": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC." + }, + "TransitionInDays": { + "description": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.", + "type": "integer" + } + }, + "required": [ + "StorageClass" + ], + "type": "object" + }, + "VersioningConfiguration": { + "additionalProperties": false, + "description": "Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.\n When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket.", + "properties": { + "Status": { + "default": "Suspended", + "description": "The versioning state of the bucket.", + "enum": [ + "Enabled", + "Suspended" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "WebsiteConfiguration": { + "additionalProperties": false, + "description": "Specifies website configuration parameters for an Amazon S3 bucket.", + "properties": { + "ErrorDocument": { + "description": "The name of the error document for the website.", + "type": "string" + }, + "IndexDocument": { + "description": "The name of the index document for the website.", + "type": "string" + }, + "RedirectAllRequestsTo": { + "$ref": "#/definitions/RedirectAllRequestsTo", + "description": "The redirect behavior for every request to this bucket's website endpoint.\n If you specify this property, you can't specify any other property." + }, + "RoutingRules": { + "description": "Rules that define when a redirect is applied and the redirect behavior.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/RoutingRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "iso8601UTC": { + "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "The ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.\n To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).\n You can only delete empty buckets. Deletion fails for buckets that have contents.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateBucket", + "s3:PutBucketTagging", + "s3:PutAnalyticsConfiguration", + "s3:PutEncryptionConfiguration", + "s3:PutBucketCORS", + "s3:PutInventoryConfiguration", + "s3:PutLifecycleConfiguration", + "s3:PutMetricsConfiguration", + "s3:PutBucketNotification", + "s3:PutBucketReplication", + "s3:PutBucketWebsite", + "s3:PutAccelerateConfiguration", + "s3:PutBucketPublicAccessBlock", + "s3:PutReplicationConfiguration", + "s3:PutObjectAcl", + "s3:PutBucketObjectLockConfiguration", + "s3:GetBucketAcl", + "s3:ListBucket", + "iam:PassRole", + "s3:DeleteObject", + "s3:PutBucketLogging", + "s3:PutBucketVersioning", + "s3:PutObjectLockConfiguration", + "s3:PutBucketOwnershipControls", + "s3:PutIntelligentTieringConfiguration" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteBucket", + "s3:ListBucket" + ] + }, + "list": { + "permissions": [ + "s3:ListAllMyBuckets" + ] + }, + "read": { + "permissions": [ + "s3:GetAccelerateConfiguration", + "s3:GetLifecycleConfiguration", + "s3:GetBucketPublicAccessBlock", + "s3:GetAnalyticsConfiguration", + "s3:GetBucketCORS", + "s3:GetEncryptionConfiguration", + "s3:GetInventoryConfiguration", + "s3:GetBucketLogging", + "s3:GetMetricsConfiguration", + "s3:GetBucketNotification", + "s3:GetBucketVersioning", + "s3:GetReplicationConfiguration", + "S3:GetBucketWebsite", + "s3:GetBucketPublicAccessBlock", + "s3:GetBucketObjectLockConfiguration", + "s3:GetBucketTagging", + "s3:GetBucketOwnershipControls", + "s3:GetIntelligentTieringConfiguration", + "s3:ListBucket" + ] + }, + "update": { + "permissions": [ + "s3:PutBucketAcl", + "s3:PutBucketTagging", + "s3:PutAnalyticsConfiguration", + "s3:PutEncryptionConfiguration", + "s3:PutBucketCORS", + "s3:PutInventoryConfiguration", + "s3:PutLifecycleConfiguration", + "s3:PutMetricsConfiguration", + "s3:PutBucketNotification", + "s3:PutBucketReplication", + "s3:PutBucketWebsite", + "s3:PutAccelerateConfiguration", + "s3:PutBucketPublicAccessBlock", + "s3:PutReplicationConfiguration", + "s3:PutBucketOwnershipControls", + "s3:PutIntelligentTieringConfiguration", + "s3:DeleteBucketWebsite", + "s3:PutBucketLogging", + "s3:PutBucketVersioning", + "s3:PutObjectLockConfiguration", + "s3:PutBucketObjectLockConfiguration", + "s3:DeleteBucketAnalyticsConfiguration", + "s3:DeleteBucketCors", + "s3:DeleteBucketMetricsConfiguration", + "s3:DeleteBucketEncryption", + "s3:DeleteBucketLifecycle", + "s3:DeleteBucketReplication", + "iam:PassRole", + "s3:ListBucket" + ] + } + }, + "primaryIdentifier": [ + "/properties/BucketName" + ], + "properties": { + "AccelerateConfiguration": { + "$ref": "#/definitions/AccelerateConfiguration", + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." + }, + "AccessControl": { + "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.\n A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.\n S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.\n The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.", + "enum": [ + "AuthenticatedRead", + "AwsExecRead", + "BucketOwnerFullControl", + "BucketOwnerRead", + "LogDeliveryWrite", + "Private", + "PublicRead", + "PublicReadWrite" + ], + "type": "string" + }, + "AnalyticsConfigurations": { + "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AnalyticsConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "$ref": "#/definitions/Arn", + "description": "", + "examples": [ + "arn:aws:s3:::mybucket" + ] + }, + "BucketEncryption": { + "$ref": "#/definitions/BucketEncryption", + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." + }, + "BucketName": { + "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.", + "type": "string" + }, + "CorsConfiguration": { + "$ref": "#/definitions/CorsConfiguration", + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." + }, + "DomainName": { + "description": "", + "examples": [ + "mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com" + ], + "type": "string" + }, + "DualStackDomainName": { + "description": "", + "examples": [ + "mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com" + ], + "type": "string" + }, + "IntelligentTieringConfigurations": { + "description": "Defines how Amazon S3 handles Intelligent-Tiering storage.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IntelligentTieringConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "InventoryConfigurations": { + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/InventoryConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "LifecycleConfiguration": { + "$ref": "#/definitions/LifecycleConfiguration", + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." + }, + "LoggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration", + "description": "Settings that define where logs are stored." + }, + "MetricsConfigurations": { + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricsConfiguration" + }, + "type": "array", + "uniqueItems": true + }, + "NotificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration", + "description": "Configuration that defines how Amazon S3 handles bucket notifications." + }, + "ObjectLockConfiguration": { + "$ref": "#/definitions/ObjectLockConfiguration", + "description": "This operation is not supported by directory buckets.\n Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). \n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.\n + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html)." + }, + "ObjectLockEnabled": { + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", + "type": "boolean" + }, + "OwnershipControls": { + "$ref": "#/definitions/OwnershipControls", + "description": "Configuration that defines how Amazon S3 handles Object Ownership rules." + }, + "PublicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "Configuration that defines how Amazon S3 handles public access." + }, + "RegionalDomainName": { + "description": "", + "examples": [ + "mystack-mybucket-kdwwxmddtr2g.s3.us-east-2.amazonaws.com" + ], + "type": "string" + }, + "ReplicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration", + "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.\n Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist." + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "VersioningConfiguration": { + "$ref": "#/definitions/VersioningConfiguration", + "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.\n When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket." + }, + "WebsiteConfiguration": { + "$ref": "#/definitions/WebsiteConfiguration", + "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)." + }, + "WebsiteURL": { + "description": "", + "examples": [ + "Example (IPv4): http://mystack-mybucket-kdwwxmddtr2g.s3-website-us-east-2.amazonaws.com/", + "Example (IPv6): http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com/" + ], + "format": "uri", + "type": "string" + } + }, + "propertyTransform": { + "/properties/NotificationConfiguration/LambdaConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", + "/properties/NotificationConfiguration/QueueConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", + "/properties/NotificationConfiguration/TopicConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/DomainName", + "/properties/DualStackDomainName", + "/properties/RegionalDomainName", + "/properties/WebsiteURL" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::Bucket", + "writeOnlyProperties": [ + "/properties/AccessControl", + "/properties/LifecycleConfiguration/Rules/*/NoncurrentVersionExpirationInDays", + "/properties/LifecycleConfiguration/Rules/*/NoncurrentVersionTransition", + "/properties/LifecycleConfiguration/Rules/*/Transition", + "/properties/ReplicationConfiguration/Rules/*/Prefix", + "/properties/LifecycleConfiguration/Rules/*/ExpiredObjectDeleteMarker" + ] +} diff --git a/schema/aws-s3-bucketpolicy.json b/schema/aws-s3-bucketpolicy.json index c20f837..9cf2501 100644 --- a/schema/aws-s3-bucketpolicy.json +++ b/schema/aws-s3-bucketpolicy.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Bucket" - ], - "description": "Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.\n If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.\n As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. \n For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).\n The following operations are related to ``PutBucketPolicy``:\n + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) \n + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)", - "handlers": { - "create": { - "permissions": [ - "s3:GetBucketPolicy", - "s3:PutBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "s3:GetBucketPolicy", - "s3:DeleteBucketPolicy" - ] - }, - "list": { - "permissions": [ - "s3:GetBucketPolicy", - "s3:ListAllMyBuckets" - ] - }, - "read": { - "permissions": [ - "s3:GetBucketPolicy" - ] - }, - "update": { - "permissions": [ - "s3:GetBucketPolicy", - "s3:PutBucketPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Bucket" - ], - "properties": { - "Bucket": { - "description": "The name of the Amazon S3 bucket to which the policy applies.", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "Bucket", - "PolicyDocument" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3::BucketPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Bucket" + ], + "description": "Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.\n If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.\n As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. \n For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).\n The following operations are related to ``PutBucketPolicy``:\n + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) \n + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)", + "handlers": { + "create": { + "permissions": [ + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "s3:GetBucketPolicy", + "s3:DeleteBucketPolicy" + ] + }, + "list": { + "permissions": [ + "s3:GetBucketPolicy", + "s3:ListAllMyBuckets" + ] + }, + "read": { + "permissions": [ + "s3:GetBucketPolicy" + ] + }, + "update": { + "permissions": [ + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Bucket" + ], + "properties": { + "Bucket": { + "description": "The name of the Amazon S3 bucket to which the policy applies.", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "Bucket", + "PolicyDocument" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3::BucketPolicy" +} diff --git a/schema/aws-s3-multiregionaccesspoint.json b/schema/aws-s3-multiregionaccesspoint.json index 7d0d746..5da27e1 100644 --- a/schema/aws-s3-multiregionaccesspoint.json +++ b/schema/aws-s3-multiregionaccesspoint.json @@ -1,126 +1,126 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/PublicAccessBlockConfiguration", - "/properties/Regions" - ], - "definitions": { - "PublicAccessBlockConfiguration": { - "additionalProperties": false, - "properties": { - "BlockPublicAcls": { - "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", - "type": "boolean" - }, - "BlockPublicPolicy": { - "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", - "type": "boolean" - }, - "IgnorePublicAcls": { - "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", - "type": "boolean" - }, - "RestrictPublicBuckets": { - "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", - "type": "boolean" - } - }, - "type": "object" - }, - "Region": { - "additionalProperties": false, - "properties": { - "Bucket": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "BucketAccountId": { - "maxLength": 12, - "minLength": 12, - "pattern": "^[0-9]{12}$", - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - } - }, - "description": "AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateMultiRegionAccessPoint", - "s3:DescribeMultiRegionAccessPointOperation", - "s3:GetMultiRegionAccessPoint" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteMultiRegionAccessPoint", - "s3:DescribeMultiRegionAccessPointOperation", - "s3:GetMultiRegionAccessPoint" - ] - }, - "list": { - "permissions": [ - "s3:ListMultiRegionAccessPoints" - ] - }, - "read": { - "permissions": [ - "s3:GetMultiRegionAccessPoint" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Alias": { - "description": "The alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp of the when the Multi Region Access Point is created", - "type": "string" - }, - "Name": { - "description": "The name you want to assign to this Multi Region Access Point.", - "maxLength": 50, - "minLength": 3, - "pattern": "^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$", - "type": "string" - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/PublicAccessBlockConfiguration", - "description": "The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." - }, - "Regions": { - "description": "The list of buckets that you want to associate this Multi Region Access Point with.", - "items": { - "$ref": "#/definitions/Region", - "description": "The name of the bucket that represents of the region belonging to this Multi Region Access Point." - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Alias", - "/properties/CreatedAt" - ], - "required": [ - "Regions" - ], - "typeName": "AWS::S3::MultiRegionAccessPoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/PublicAccessBlockConfiguration", + "/properties/Regions" + ], + "definitions": { + "PublicAccessBlockConfiguration": { + "additionalProperties": false, + "properties": { + "BlockPublicAcls": { + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", + "type": "boolean" + }, + "BlockPublicPolicy": { + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", + "type": "boolean" + }, + "IgnorePublicAcls": { + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", + "type": "boolean" + } + }, + "type": "object" + }, + "Region": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "BucketAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + } + }, + "required": [ + "Bucket" + ], + "type": "object" + } + }, + "description": "AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateMultiRegionAccessPoint", + "s3:DescribeMultiRegionAccessPointOperation", + "s3:GetMultiRegionAccessPoint" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteMultiRegionAccessPoint", + "s3:DescribeMultiRegionAccessPointOperation", + "s3:GetMultiRegionAccessPoint" + ] + }, + "list": { + "permissions": [ + "s3:ListMultiRegionAccessPoints" + ] + }, + "read": { + "permissions": [ + "s3:GetMultiRegionAccessPoint" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Alias": { + "description": "The alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of the when the Multi Region Access Point is created", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Multi Region Access Point.", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$", + "type": "string" + }, + "PublicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + }, + "Regions": { + "description": "The list of buckets that you want to associate this Multi Region Access Point with.", + "items": { + "$ref": "#/definitions/Region", + "description": "The name of the bucket that represents of the region belonging to this Multi Region Access Point." + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Alias", + "/properties/CreatedAt" + ], + "required": [ + "Regions" + ], + "typeName": "AWS::S3::MultiRegionAccessPoint" +} diff --git a/schema/aws-s3-multiregionaccesspointpolicy.json b/schema/aws-s3-multiregionaccesspointpolicy.json index 40dbfc5..ccee2b8 100644 --- a/schema/aws-s3-multiregionaccesspointpolicy.json +++ b/schema/aws-s3-multiregionaccesspointpolicy.json @@ -1,79 +1,79 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MrapName" - ], - "description": "The policy to be attached to a Multi Region Access Point", - "handlers": { - "create": { - "permissions": [ - "s3:PutMultiRegionAccessPointPolicy", - "s3:DescribeMultiRegionAccessPointOperation" - ] - }, - "delete": { - "permissions": [ - "s3:GetMultiRegionAccessPointPolicy", - "s3:GetMultiRegionAccessPoint" - ] - }, - "list": { - "permissions": [] - }, - "read": { - "permissions": [ - "s3:GetMultiRegionAccessPointPolicy", - "s3:GetMultiRegionAccessPointPolicyStatus" - ] - }, - "update": { - "permissions": [ - "s3:PutMultiRegionAccessPointPolicy", - "s3:DescribeMultiRegionAccessPointOperation" - ] - } - }, - "primaryIdentifier": [ - "/properties/MrapName" - ], - "properties": { - "MrapName": { - "description": "The name of the Multi Region Access Point to apply policy", - "maxLength": 50, - "minLength": 3, - "pattern": "^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$", - "type": "string" - }, - "Policy": { - "description": "Policy document to apply to a Multi Region Access Point", - "type": "object" - }, - "PolicyStatus": { - "additionalProperties": false, - "description": "The Policy Status associated with this Multi Region Access Point", - "properties": { - "IsPublic": { - "description": "Specifies whether the policy is public or not.", - "enum": [ - "true", - "false" - ], - "type": "string" - } - }, - "required": [ - "IsPublic" - ], - "type": "object" - } - }, - "readOnlyProperties": [ - "/properties/PolicyStatus", - "/properties/PolicyStatus/IsPublic" - ], - "required": [ - "Policy", - "MrapName" - ], - "typeName": "AWS::S3::MultiRegionAccessPointPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MrapName" + ], + "description": "The policy to be attached to a Multi Region Access Point", + "handlers": { + "create": { + "permissions": [ + "s3:PutMultiRegionAccessPointPolicy", + "s3:DescribeMultiRegionAccessPointOperation" + ] + }, + "delete": { + "permissions": [ + "s3:GetMultiRegionAccessPointPolicy", + "s3:GetMultiRegionAccessPoint" + ] + }, + "list": { + "permissions": [] + }, + "read": { + "permissions": [ + "s3:GetMultiRegionAccessPointPolicy", + "s3:GetMultiRegionAccessPointPolicyStatus" + ] + }, + "update": { + "permissions": [ + "s3:PutMultiRegionAccessPointPolicy", + "s3:DescribeMultiRegionAccessPointOperation" + ] + } + }, + "primaryIdentifier": [ + "/properties/MrapName" + ], + "properties": { + "MrapName": { + "description": "The name of the Multi Region Access Point to apply policy", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$", + "type": "string" + }, + "Policy": { + "description": "Policy document to apply to a Multi Region Access Point", + "type": "object" + }, + "PolicyStatus": { + "additionalProperties": false, + "description": "The Policy Status associated with this Multi Region Access Point", + "properties": { + "IsPublic": { + "description": "Specifies whether the policy is public or not.", + "enum": [ + "true", + "false" + ], + "type": "string" + } + }, + "required": [ + "IsPublic" + ], + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/PolicyStatus", + "/properties/PolicyStatus/IsPublic" + ], + "required": [ + "Policy", + "MrapName" + ], + "typeName": "AWS::S3::MultiRegionAccessPointPolicy" +} diff --git a/schema/aws-s3-storagelens.json b/schema/aws-s3-storagelens.json index 38a0f48..61155ff 100644 --- a/schema/aws-s3-storagelens.json +++ b/schema/aws-s3-storagelens.json @@ -1,489 +1,489 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StorageLensConfiguration/Id" - ], - "definitions": { - "AccountLevel": { - "additionalProperties": false, - "description": "Account-level metrics configurations.", - "properties": { - "ActivityMetrics": { - "$ref": "#/definitions/ActivityMetrics" - }, - "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AdvancedCostOptimizationMetrics" - }, - "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AdvancedDataProtectionMetrics" - }, - "BucketLevel": { - "$ref": "#/definitions/BucketLevel" - }, - "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/DetailedStatusCodesMetrics" - }, - "StorageLensGroupLevel": { - "$ref": "#/definitions/StorageLensGroupLevel" - } - }, - "required": [ - "BucketLevel" - ], - "type": "object" - }, - "ActivityMetrics": { - "additionalProperties": false, - "description": "Enables activity metrics.", - "properties": { - "IsEnabled": { - "description": "Specifies whether activity metrics are enabled or disabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "AdvancedCostOptimizationMetrics": { - "additionalProperties": false, - "description": "Enables advanced cost optimization metrics.", - "properties": { - "IsEnabled": { - "description": "Specifies whether advanced cost optimization metrics are enabled or disabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "AdvancedDataProtectionMetrics": { - "additionalProperties": false, - "description": "Enables advanced data protection metrics.", - "properties": { - "IsEnabled": { - "description": "Specifies whether advanced data protection metrics are enabled or disabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the specified resource.", - "type": "string" - }, - "AwsOrg": { - "additionalProperties": false, - "description": "The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration.", - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "BucketLevel": { - "additionalProperties": false, - "description": "Bucket-level metrics configurations.", - "properties": { - "ActivityMetrics": { - "$ref": "#/definitions/ActivityMetrics" - }, - "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AdvancedCostOptimizationMetrics" - }, - "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AdvancedDataProtectionMetrics" - }, - "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/DetailedStatusCodesMetrics" - }, - "PrefixLevel": { - "$ref": "#/definitions/PrefixLevel" - } - }, - "type": "object" - }, - "BucketsAndRegions": { - "additionalProperties": false, - "description": "S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.", - "properties": { - "Buckets": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Arn" - }, - "type": "array", - "uniqueItems": true - }, - "Regions": { - "insertionOrder": false, - "items": { - "description": "An AWS Region.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "CloudWatchMetrics": { - "additionalProperties": false, - "description": "CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.", - "properties": { - "IsEnabled": { - "description": "Specifies whether CloudWatch metrics are enabled or disabled.", - "type": "boolean" - } - }, - "required": [ - "IsEnabled" - ], - "type": "object" - }, - "DataExport": { - "additionalProperties": false, - "description": "Specifies how Amazon S3 Storage Lens metrics should be exported.", - "properties": { - "CloudWatchMetrics": { - "$ref": "#/definitions/CloudWatchMetrics" - }, - "S3BucketDestination": { - "$ref": "#/definitions/S3BucketDestination" - } - }, - "type": "object" - }, - "DetailedStatusCodesMetrics": { - "additionalProperties": false, - "description": "Enables detailed status codes metrics.", - "properties": { - "IsEnabled": { - "description": "Specifies whether detailed status codes metrics are enabled or disabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "Encryption": { - "description": "Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "SSES3": { - "additionalProperties": false, - "description": "S3 default server-side encryption.", - "type": "object" - } - }, - "required": [ - "SSES3" - ] - }, - { - "additionalProperties": false, - "properties": { - "SSEKMS": { - "$ref": "#/definitions/SSEKMS" - } - }, - "required": [ - "SSEKMS" - ] - } - ], - "type": "object" - }, - "Id": { - "description": "The ID that identifies the Amazon S3 Storage Lens configuration.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-_.]+$", - "type": "string" - }, - "PrefixLevel": { - "additionalProperties": false, - "description": "Prefix-level metrics configurations.", - "properties": { - "StorageMetrics": { - "$ref": "#/definitions/PrefixLevelStorageMetrics" - } - }, - "required": [ - "StorageMetrics" - ], - "type": "object" - }, - "PrefixLevelStorageMetrics": { - "additionalProperties": false, - "properties": { - "IsEnabled": { - "description": "Specifies whether prefix-level storage metrics are enabled or disabled.", - "type": "boolean" - }, - "SelectionCriteria": { - "$ref": "#/definitions/SelectionCriteria" - } - }, - "type": "object" - }, - "S3BucketDestination": { - "additionalProperties": false, - "description": "S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.", - "properties": { - "AccountId": { - "description": "The AWS account ID that owns the destination S3 bucket.", - "type": "string" - }, - "Arn": { - "description": "The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.", - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/Encryption" - }, - "Format": { - "description": "Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.", - "enum": [ - "CSV", - "Parquet" - ], - "type": "string" - }, - "OutputSchemaVersion": { - "description": "The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.", - "enum": [ - "V_1" - ], - "type": "string" - }, - "Prefix": { - "description": "The prefix to use for Amazon S3 Storage Lens export.", - "type": "string" - } - }, - "required": [ - "OutputSchemaVersion", - "Format", - "AccountId", - "Arn" - ], - "type": "object" - }, - "SSEKMS": { - "additionalProperties": false, - "description": "AWS KMS server-side encryption.", - "properties": { - "KeyId": { - "description": "The ARN of the KMS key to use for encryption.", - "type": "string" - } - }, - "required": [ - "KeyId" - ], - "type": "object" - }, - "SelectionCriteria": { - "additionalProperties": false, - "description": "Selection criteria for prefix-level metrics.", - "properties": { - "Delimiter": { - "description": "Delimiter to divide S3 key into hierarchy of prefixes.", - "type": "string" - }, - "MaxDepth": { - "description": "Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.", - "type": "integer" - }, - "MinStorageBytesPercentage": { - "description": "The minimum storage bytes threshold for the prefixes to be included in the analysis.", - "type": "number" - } - }, - "type": "object" - }, - "StorageLensConfiguration": { - "additionalProperties": false, - "description": "Specifies the details of Amazon S3 Storage Lens configuration.", - "properties": { - "AccountLevel": { - "$ref": "#/definitions/AccountLevel" - }, - "AwsOrg": { - "$ref": "#/definitions/AwsOrg" - }, - "DataExport": { - "$ref": "#/definitions/DataExport" - }, - "Exclude": { - "$ref": "#/definitions/BucketsAndRegions" - }, - "Id": { - "$ref": "#/definitions/Id" - }, - "Include": { - "$ref": "#/definitions/BucketsAndRegions" - }, - "IsEnabled": { - "description": "Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.", - "type": "boolean" - }, - "StorageLensArn": { - "description": "The ARN for the Amazon S3 Storage Lens configuration.", - "type": "string" - } - }, - "required": [ - "Id", - "AccountLevel", - "IsEnabled" - ], - "type": "object" - }, - "StorageLensGroupArn": { - "description": "The ARN for the Amazon S3 Storage Lens Group configuration.", - "type": "string" - }, - "StorageLensGroupLevel": { - "additionalProperties": false, - "description": "Specifies the details of Amazon S3 Storage Lens Group configuration.", - "properties": { - "StorageLensGroupSelectionCriteria": { - "$ref": "#/definitions/StorageLensGroupSelectionCriteria" - } - }, - "type": "object" - }, - "StorageLensGroupSelectionCriteria": { - "additionalProperties": false, - "description": "Selection criteria for Storage Lens Group level metrics", - "properties": { - "Exclude": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StorageLensGroupArn" - }, - "type": "array", - "uniqueItems": true - }, - "Include": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/StorageLensGroupArn" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.", - "handlers": { - "create": { - "permissions": [ - "s3:PutStorageLensConfiguration", - "s3:PutStorageLensConfigurationTagging", - "s3:GetStorageLensConfiguration", - "s3:GetStorageLensConfigurationTagging", - "organizations:DescribeOrganization", - "organizations:ListAccounts", - "organizations:ListAWSServiceAccessForOrganization", - "organizations:ListDelegatedAdministrators", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteStorageLensConfiguration", - "s3:DeleteStorageLensConfigurationTagging" - ] - }, - "list": { - "permissions": [ - "s3:ListStorageLensConfigurations" - ] - }, - "read": { - "permissions": [ - "s3:GetStorageLensConfiguration", - "s3:GetStorageLensConfigurationTagging" - ] - }, - "update": { - "permissions": [ - "s3:PutStorageLensConfiguration", - "s3:PutStorageLensConfigurationTagging", - "s3:GetStorageLensConfiguration", - "s3:GetStorageLensConfigurationTagging", - "organizations:DescribeOrganization", - "organizations:ListAccounts", - "organizations:ListAWSServiceAccessForOrganization", - "organizations:ListDelegatedAdministrators", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/StorageLensConfiguration/Id" - ], - "properties": { - "StorageLensConfiguration": { - "$ref": "#/definitions/StorageLensConfiguration" - }, - "Tags": { - "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/StorageLensConfiguration/StorageLensArn" - ], - "required": [ - "StorageLensConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelens", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::StorageLens" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StorageLensConfiguration/Id" + ], + "definitions": { + "AccountLevel": { + "additionalProperties": false, + "description": "Account-level metrics configurations.", + "properties": { + "ActivityMetrics": { + "$ref": "#/definitions/ActivityMetrics" + }, + "AdvancedCostOptimizationMetrics": { + "$ref": "#/definitions/AdvancedCostOptimizationMetrics" + }, + "AdvancedDataProtectionMetrics": { + "$ref": "#/definitions/AdvancedDataProtectionMetrics" + }, + "BucketLevel": { + "$ref": "#/definitions/BucketLevel" + }, + "DetailedStatusCodesMetrics": { + "$ref": "#/definitions/DetailedStatusCodesMetrics" + }, + "StorageLensGroupLevel": { + "$ref": "#/definitions/StorageLensGroupLevel" + } + }, + "required": [ + "BucketLevel" + ], + "type": "object" + }, + "ActivityMetrics": { + "additionalProperties": false, + "description": "Enables activity metrics.", + "properties": { + "IsEnabled": { + "description": "Specifies whether activity metrics are enabled or disabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "AdvancedCostOptimizationMetrics": { + "additionalProperties": false, + "description": "Enables advanced cost optimization metrics.", + "properties": { + "IsEnabled": { + "description": "Specifies whether advanced cost optimization metrics are enabled or disabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "AdvancedDataProtectionMetrics": { + "additionalProperties": false, + "description": "Enables advanced data protection metrics.", + "properties": { + "IsEnabled": { + "description": "Specifies whether advanced data protection metrics are enabled or disabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the specified resource.", + "type": "string" + }, + "AwsOrg": { + "additionalProperties": false, + "description": "The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration.", + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "BucketLevel": { + "additionalProperties": false, + "description": "Bucket-level metrics configurations.", + "properties": { + "ActivityMetrics": { + "$ref": "#/definitions/ActivityMetrics" + }, + "AdvancedCostOptimizationMetrics": { + "$ref": "#/definitions/AdvancedCostOptimizationMetrics" + }, + "AdvancedDataProtectionMetrics": { + "$ref": "#/definitions/AdvancedDataProtectionMetrics" + }, + "DetailedStatusCodesMetrics": { + "$ref": "#/definitions/DetailedStatusCodesMetrics" + }, + "PrefixLevel": { + "$ref": "#/definitions/PrefixLevel" + } + }, + "type": "object" + }, + "BucketsAndRegions": { + "additionalProperties": false, + "description": "S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.", + "properties": { + "Buckets": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Arn" + }, + "type": "array", + "uniqueItems": true + }, + "Regions": { + "insertionOrder": false, + "items": { + "description": "An AWS Region.", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CloudWatchMetrics": { + "additionalProperties": false, + "description": "CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.", + "properties": { + "IsEnabled": { + "description": "Specifies whether CloudWatch metrics are enabled or disabled.", + "type": "boolean" + } + }, + "required": [ + "IsEnabled" + ], + "type": "object" + }, + "DataExport": { + "additionalProperties": false, + "description": "Specifies how Amazon S3 Storage Lens metrics should be exported.", + "properties": { + "CloudWatchMetrics": { + "$ref": "#/definitions/CloudWatchMetrics" + }, + "S3BucketDestination": { + "$ref": "#/definitions/S3BucketDestination" + } + }, + "type": "object" + }, + "DetailedStatusCodesMetrics": { + "additionalProperties": false, + "description": "Enables detailed status codes metrics.", + "properties": { + "IsEnabled": { + "description": "Specifies whether detailed status codes metrics are enabled or disabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "Encryption": { + "description": "Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SSES3": { + "additionalProperties": false, + "description": "S3 default server-side encryption.", + "type": "object" + } + }, + "required": [ + "SSES3" + ] + }, + { + "additionalProperties": false, + "properties": { + "SSEKMS": { + "$ref": "#/definitions/SSEKMS" + } + }, + "required": [ + "SSEKMS" + ] + } + ], + "type": "object" + }, + "Id": { + "description": "The ID that identifies the Amazon S3 Storage Lens configuration.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-_.]+$", + "type": "string" + }, + "PrefixLevel": { + "additionalProperties": false, + "description": "Prefix-level metrics configurations.", + "properties": { + "StorageMetrics": { + "$ref": "#/definitions/PrefixLevelStorageMetrics" + } + }, + "required": [ + "StorageMetrics" + ], + "type": "object" + }, + "PrefixLevelStorageMetrics": { + "additionalProperties": false, + "properties": { + "IsEnabled": { + "description": "Specifies whether prefix-level storage metrics are enabled or disabled.", + "type": "boolean" + }, + "SelectionCriteria": { + "$ref": "#/definitions/SelectionCriteria" + } + }, + "type": "object" + }, + "S3BucketDestination": { + "additionalProperties": false, + "description": "S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.", + "properties": { + "AccountId": { + "description": "The AWS account ID that owns the destination S3 bucket.", + "type": "string" + }, + "Arn": { + "description": "The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "Encryption": { + "$ref": "#/definitions/Encryption" + }, + "Format": { + "description": "Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.", + "enum": [ + "CSV", + "Parquet" + ], + "type": "string" + }, + "OutputSchemaVersion": { + "description": "The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.", + "enum": [ + "V_1" + ], + "type": "string" + }, + "Prefix": { + "description": "The prefix to use for Amazon S3 Storage Lens export.", + "type": "string" + } + }, + "required": [ + "OutputSchemaVersion", + "Format", + "AccountId", + "Arn" + ], + "type": "object" + }, + "SSEKMS": { + "additionalProperties": false, + "description": "AWS KMS server-side encryption.", + "properties": { + "KeyId": { + "description": "The ARN of the KMS key to use for encryption.", + "type": "string" + } + }, + "required": [ + "KeyId" + ], + "type": "object" + }, + "SelectionCriteria": { + "additionalProperties": false, + "description": "Selection criteria for prefix-level metrics.", + "properties": { + "Delimiter": { + "description": "Delimiter to divide S3 key into hierarchy of prefixes.", + "type": "string" + }, + "MaxDepth": { + "description": "Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.", + "type": "integer" + }, + "MinStorageBytesPercentage": { + "description": "The minimum storage bytes threshold for the prefixes to be included in the analysis.", + "type": "number" + } + }, + "type": "object" + }, + "StorageLensConfiguration": { + "additionalProperties": false, + "description": "Specifies the details of Amazon S3 Storage Lens configuration.", + "properties": { + "AccountLevel": { + "$ref": "#/definitions/AccountLevel" + }, + "AwsOrg": { + "$ref": "#/definitions/AwsOrg" + }, + "DataExport": { + "$ref": "#/definitions/DataExport" + }, + "Exclude": { + "$ref": "#/definitions/BucketsAndRegions" + }, + "Id": { + "$ref": "#/definitions/Id" + }, + "Include": { + "$ref": "#/definitions/BucketsAndRegions" + }, + "IsEnabled": { + "description": "Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.", + "type": "boolean" + }, + "StorageLensArn": { + "description": "The ARN for the Amazon S3 Storage Lens configuration.", + "type": "string" + } + }, + "required": [ + "Id", + "AccountLevel", + "IsEnabled" + ], + "type": "object" + }, + "StorageLensGroupArn": { + "description": "The ARN for the Amazon S3 Storage Lens Group configuration.", + "type": "string" + }, + "StorageLensGroupLevel": { + "additionalProperties": false, + "description": "Specifies the details of Amazon S3 Storage Lens Group configuration.", + "properties": { + "StorageLensGroupSelectionCriteria": { + "$ref": "#/definitions/StorageLensGroupSelectionCriteria" + } + }, + "type": "object" + }, + "StorageLensGroupSelectionCriteria": { + "additionalProperties": false, + "description": "Selection criteria for Storage Lens Group level metrics", + "properties": { + "Exclude": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StorageLensGroupArn" + }, + "type": "array", + "uniqueItems": true + }, + "Include": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StorageLensGroupArn" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.", + "handlers": { + "create": { + "permissions": [ + "s3:PutStorageLensConfiguration", + "s3:PutStorageLensConfigurationTagging", + "s3:GetStorageLensConfiguration", + "s3:GetStorageLensConfigurationTagging", + "organizations:DescribeOrganization", + "organizations:ListAccounts", + "organizations:ListAWSServiceAccessForOrganization", + "organizations:ListDelegatedAdministrators", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteStorageLensConfiguration", + "s3:DeleteStorageLensConfigurationTagging" + ] + }, + "list": { + "permissions": [ + "s3:ListStorageLensConfigurations" + ] + }, + "read": { + "permissions": [ + "s3:GetStorageLensConfiguration", + "s3:GetStorageLensConfigurationTagging" + ] + }, + "update": { + "permissions": [ + "s3:PutStorageLensConfiguration", + "s3:PutStorageLensConfigurationTagging", + "s3:GetStorageLensConfiguration", + "s3:GetStorageLensConfigurationTagging", + "organizations:DescribeOrganization", + "organizations:ListAccounts", + "organizations:ListAWSServiceAccessForOrganization", + "organizations:ListDelegatedAdministrators", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/StorageLensConfiguration/Id" + ], + "properties": { + "StorageLensConfiguration": { + "$ref": "#/definitions/StorageLensConfiguration" + }, + "Tags": { + "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/StorageLensConfiguration/StorageLensArn" + ], + "required": [ + "StorageLensConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelens", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::StorageLens" +} diff --git a/schema/aws-s3-storagelensgroup.json b/schema/aws-s3-storagelensgroup.json index ecb2c34..8364440 100644 --- a/schema/aws-s3-storagelensgroup.json +++ b/schema/aws-s3-storagelensgroup.json @@ -1,252 +1,252 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "And": { - "additionalProperties": false, - "description": "The Storage Lens group will include objects that match all of the specified filter values.", - "minProperties": 2, - "properties": { - "MatchAnyPrefix": { - "$ref": "#/definitions/MatchAnyPrefix" - }, - "MatchAnySuffix": { - "$ref": "#/definitions/MatchAnySuffix" - }, - "MatchAnyTag": { - "$ref": "#/definitions/MatchAnyTag" - }, - "MatchObjectAge": { - "$ref": "#/definitions/MatchObjectAge" - }, - "MatchObjectSize": { - "$ref": "#/definitions/MatchObjectSize" - } - }, - "type": "object", - "uniqueItems": true - }, - "Filter": { - "additionalProperties": false, - "description": "Sets the Storage Lens Group filter.", - "properties": { - "And": { - "$ref": "#/definitions/And" - }, - "MatchAnyPrefix": { - "$ref": "#/definitions/MatchAnyPrefix" - }, - "MatchAnySuffix": { - "$ref": "#/definitions/MatchAnySuffix" - }, - "MatchAnyTag": { - "$ref": "#/definitions/MatchAnyTag" - }, - "MatchObjectAge": { - "$ref": "#/definitions/MatchObjectAge" - }, - "MatchObjectSize": { - "$ref": "#/definitions/MatchObjectSize" - }, - "Or": { - "$ref": "#/definitions/Or" - } - }, - "type": "object" - }, - "MatchAnyPrefix": { - "description": "Filter to match any of the specified prefixes.", - "insertionOrder": false, - "items": { - "maxLength": 1024, - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "MatchAnySuffix": { - "description": "Filter to match any of the specified suffixes.", - "insertionOrder": false, - "items": { - "maxLength": 1024, - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "MatchAnyTag": { - "description": "Filter to match any of the specified object tags.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "MatchObjectAge": { - "additionalProperties": false, - "description": "Filter to match all of the specified values for the minimum and maximum object age.", - "properties": { - "DaysGreaterThan": { - "description": "Minimum object age to which the rule applies.", - "minimum": 1, - "type": "integer" - }, - "DaysLessThan": { - "description": "Maximum object age to which the rule applies.", - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "MatchObjectSize": { - "additionalProperties": false, - "description": "Filter to match all of the specified values for the minimum and maximum object size.", - "properties": { - "BytesGreaterThan": { - "description": "Minimum object size to which the rule applies.", - "format": "int64", - "minimum": 1, - "type": "integer" - }, - "BytesLessThan": { - "description": "Maximum object size to which the rule applies.", - "format": "int64", - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "Name": { - "description": "The name that identifies the Amazon S3 Storage Lens Group.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9\\-_]+$", - "type": "string" - }, - "Or": { - "additionalProperties": false, - "description": "The Storage Lens group will include objects that match any of the specified filter values.", - "minProperties": 2, - "properties": { - "MatchAnyPrefix": { - "$ref": "#/definitions/MatchAnyPrefix" - }, - "MatchAnySuffix": { - "$ref": "#/definitions/MatchAnySuffix" - }, - "MatchAnyTag": { - "$ref": "#/definitions/MatchAnyTag" - }, - "MatchObjectAge": { - "$ref": "#/definitions/MatchObjectAge" - }, - "MatchObjectSize": { - "$ref": "#/definitions/MatchObjectSize" - } - }, - "type": "object", - "uniqueItems": true - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.", - "handlers": { - "create": { - "permissions": [ - "s3:CreateStorageLensGroup", - "s3:GetStorageLensGroup", - "s3:TagResource", - "s3:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteStorageLensGroup" - ] - }, - "list": { - "permissions": [ - "s3:ListStorageLensGroups" - ] - }, - "read": { - "permissions": [ - "s3:GetStorageLensGroup", - "s3:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "s3:GetStorageLensGroup", - "s3:UpdateStorageLensGroup", - "s3:TagResource", - "s3:UntagResource", - "s3:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Filter": { - "$ref": "#/definitions/Filter" - }, - "Name": { - "$ref": "#/definitions/Name" - }, - "StorageLensGroupArn": { - "description": "The ARN for the Amazon S3 Storage Lens Group.", - "type": "string" - }, - "Tags": { - "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/StorageLensGroupArn" - ], - "required": [ - "Name", - "Filter" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelensgroup", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3::StorageLensGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "And": { + "additionalProperties": false, + "description": "The Storage Lens group will include objects that match all of the specified filter values.", + "minProperties": 2, + "properties": { + "MatchAnyPrefix": { + "$ref": "#/definitions/MatchAnyPrefix" + }, + "MatchAnySuffix": { + "$ref": "#/definitions/MatchAnySuffix" + }, + "MatchAnyTag": { + "$ref": "#/definitions/MatchAnyTag" + }, + "MatchObjectAge": { + "$ref": "#/definitions/MatchObjectAge" + }, + "MatchObjectSize": { + "$ref": "#/definitions/MatchObjectSize" + } + }, + "type": "object", + "uniqueItems": true + }, + "Filter": { + "additionalProperties": false, + "description": "Sets the Storage Lens Group filter.", + "properties": { + "And": { + "$ref": "#/definitions/And" + }, + "MatchAnyPrefix": { + "$ref": "#/definitions/MatchAnyPrefix" + }, + "MatchAnySuffix": { + "$ref": "#/definitions/MatchAnySuffix" + }, + "MatchAnyTag": { + "$ref": "#/definitions/MatchAnyTag" + }, + "MatchObjectAge": { + "$ref": "#/definitions/MatchObjectAge" + }, + "MatchObjectSize": { + "$ref": "#/definitions/MatchObjectSize" + }, + "Or": { + "$ref": "#/definitions/Or" + } + }, + "type": "object" + }, + "MatchAnyPrefix": { + "description": "Filter to match any of the specified prefixes.", + "insertionOrder": false, + "items": { + "maxLength": 1024, + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "MatchAnySuffix": { + "description": "Filter to match any of the specified suffixes.", + "insertionOrder": false, + "items": { + "maxLength": 1024, + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "MatchAnyTag": { + "description": "Filter to match any of the specified object tags.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "MatchObjectAge": { + "additionalProperties": false, + "description": "Filter to match all of the specified values for the minimum and maximum object age.", + "properties": { + "DaysGreaterThan": { + "description": "Minimum object age to which the rule applies.", + "minimum": 1, + "type": "integer" + }, + "DaysLessThan": { + "description": "Maximum object age to which the rule applies.", + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "MatchObjectSize": { + "additionalProperties": false, + "description": "Filter to match all of the specified values for the minimum and maximum object size.", + "properties": { + "BytesGreaterThan": { + "description": "Minimum object size to which the rule applies.", + "format": "int64", + "minimum": 1, + "type": "integer" + }, + "BytesLessThan": { + "description": "Maximum object size to which the rule applies.", + "format": "int64", + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "Name": { + "description": "The name that identifies the Amazon S3 Storage Lens Group.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-_]+$", + "type": "string" + }, + "Or": { + "additionalProperties": false, + "description": "The Storage Lens group will include objects that match any of the specified filter values.", + "minProperties": 2, + "properties": { + "MatchAnyPrefix": { + "$ref": "#/definitions/MatchAnyPrefix" + }, + "MatchAnySuffix": { + "$ref": "#/definitions/MatchAnySuffix" + }, + "MatchAnyTag": { + "$ref": "#/definitions/MatchAnyTag" + }, + "MatchObjectAge": { + "$ref": "#/definitions/MatchObjectAge" + }, + "MatchObjectSize": { + "$ref": "#/definitions/MatchObjectSize" + } + }, + "type": "object", + "uniqueItems": true + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.", + "handlers": { + "create": { + "permissions": [ + "s3:CreateStorageLensGroup", + "s3:GetStorageLensGroup", + "s3:TagResource", + "s3:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteStorageLensGroup" + ] + }, + "list": { + "permissions": [ + "s3:ListStorageLensGroups" + ] + }, + "read": { + "permissions": [ + "s3:GetStorageLensGroup", + "s3:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "s3:GetStorageLensGroup", + "s3:UpdateStorageLensGroup", + "s3:TagResource", + "s3:UntagResource", + "s3:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Filter": { + "$ref": "#/definitions/Filter" + }, + "Name": { + "$ref": "#/definitions/Name" + }, + "StorageLensGroupArn": { + "description": "The ARN for the Amazon S3 Storage Lens Group.", + "type": "string" + }, + "Tags": { + "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/StorageLensGroupArn" + ], + "required": [ + "Name", + "Filter" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelensgroup", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3::StorageLensGroup" +} diff --git a/schema/aws-s3express-bucketpolicy.json b/schema/aws-s3express-bucketpolicy.json index 411094b..d99a03b 100644 --- a/schema/aws-s3express-bucketpolicy.json +++ b/schema/aws-s3express-bucketpolicy.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Bucket" - ], - "description": "Resource Type definition for AWS::S3Express::BucketPolicy.", - "handlers": { - "create": { - "permissions": [ - "s3express:GetBucketPolicy", - "s3express:PutBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "s3express:GetBucketPolicy", - "s3express:DeleteBucketPolicy" - ] - }, - "list": { - "permissions": [ - "s3express:GetBucketPolicy", - "s3express:ListAllMyDirectoryBuckets" - ] - }, - "read": { - "permissions": [ - "s3express:GetBucketPolicy" - ] - }, - "update": { - "permissions": [ - "s3express:GetBucketPolicy", - "s3express:PutBucketPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Bucket" - ], - "properties": { - "Bucket": { - "description": "The name of the S3 directory bucket to which the policy applies.", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", - "type": [ - "object", - "string" - ] - } - }, - "required": [ - "Bucket", - "PolicyDocument" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3Express::BucketPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Bucket" + ], + "description": "Resource Type definition for AWS::S3Express::BucketPolicy.", + "handlers": { + "create": { + "permissions": [ + "s3express:GetBucketPolicy", + "s3express:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "s3express:GetBucketPolicy", + "s3express:DeleteBucketPolicy" + ] + }, + "list": { + "permissions": [ + "s3express:GetBucketPolicy", + "s3express:ListAllMyDirectoryBuckets" + ] + }, + "read": { + "permissions": [ + "s3express:GetBucketPolicy" + ] + }, + "update": { + "permissions": [ + "s3express:GetBucketPolicy", + "s3express:PutBucketPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Bucket" + ], + "properties": { + "Bucket": { + "description": "The name of the S3 directory bucket to which the policy applies.", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", + "type": [ + "object", + "string" + ] + } + }, + "required": [ + "Bucket", + "PolicyDocument" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3Express::BucketPolicy" +} diff --git a/schema/aws-s3express-directorybucket.json b/schema/aws-s3express-directorybucket.json index ee12099..4aed2a5 100644 --- a/schema/aws-s3express-directorybucket.json +++ b/schema/aws-s3express-directorybucket.json @@ -1,82 +1,104 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BucketName", - "/properties/LocationName", - "/properties/DataRedundancy" - ], - "definitions": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the specified bucket.", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::S3Express::DirectoryBucket.", - "handlers": { - "create": { - "permissions": [ - "s3express:CreateBucket", - "s3express:ListAllMyDirectoryBuckets" - ] - }, - "delete": { - "permissions": [ - "s3express:DeleteBucket", - "s3express:ListAllMyDirectoryBuckets" - ] - }, - "list": { - "permissions": [ - "s3express:ListAllMyDirectoryBuckets" - ] - }, - "read": { - "permissions": [ - "s3express:ListAllMyDirectoryBuckets" - ] - } - }, - "primaryIdentifier": [ - "/properties/BucketName" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "Returns the Amazon Resource Name (ARN) of the specified bucket.", - "examples": [ - "arn:aws:s3express:us-west-2:123456789123:bucket/DOC-EXAMPLE-BUCKET--usw2-az1--x-s3" - ] - }, - "BucketName": { - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", - "maxLength": 63, - "pattern": "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", - "type": "string" - }, - "DataRedundancy": { - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket.", - "enum": [ - "SingleAvailabilityZone" - ], - "type": "string" - }, - "LocationName": { - "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "LocationName", - "DataRedundancy" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3Express::DirectoryBucket" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BucketName", + "/properties/LocationName", + "/properties/DataRedundancy" + ], + "definitions": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the specified bucket.", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::S3Express::DirectoryBucket.", + "handlers": { + "create": { + "permissions": [ + "kms:GenerateDataKey", + "kms:Decrypt", + "s3express:CreateBucket", + "s3express:ListAllMyDirectoryBuckets", + "s3express:PutEncryptionConfiguration" + ] + }, + "delete": { + "permissions": [ + "s3express:DeleteBucket", + "s3express:ListAllMyDirectoryBuckets" + ] + }, + "list": { + "permissions": [ + "s3express:ListAllMyDirectoryBuckets" + ] + }, + "read": { + "permissions": [ + "s3express:ListAllMyDirectoryBuckets", + "ec2:DescribeAvailabilityZones", + "s3express:GetEncryptionConfiguration", + "s3express:ListAllMyDirectoryBuckets" + ] + }, + "update": { + "permissions": [ + "kms:GenerateDataKey", + "kms:Decrypt", + "s3express:PutEncryptionConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/BucketName" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "Returns the Amazon Resource Name (ARN) of the specified bucket.", + "examples": [ + "arn:aws:s3express:us-west-2:123456789123:bucket/DOC-EXAMPLE-BUCKET--usw2-az1--x-s3" + ] + }, + "AvailabilityZoneName": { + "description": "Returns the code for the Availability Zone where the directory bucket was created.", + "examples": [ + "us-east-1f" + ], + "type": "string" + }, + "BucketEncryption": {}, + "BucketName": { + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", + "type": "string" + }, + "DataRedundancy": { + "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket.", + "enum": [ + "SingleAvailabilityZone" + ], + "type": "string" + }, + "LocationName": { + "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/AvailabilityZoneName" + ], + "required": [ + "LocationName", + "DataRedundancy" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3Express::DirectoryBucket" +} diff --git a/schema/aws-s3objectlambda-accesspoint.json b/schema/aws-s3objectlambda-accesspoint.json index efdaeae..381d091 100644 --- a/schema/aws-s3objectlambda-accesspoint.json +++ b/schema/aws-s3objectlambda-accesspoint.json @@ -1,243 +1,243 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Action": { - "type": "string" - }, - "Alias": { - "additionalProperties": false, - "properties": { - "Status": { - "description": "The status of the Object Lambda alias.", - "pattern": "^[A-Z]*$", - "type": "string" - }, - "Value": { - "description": "The value of the Object Lambda alias.", - "pattern": "^[a-z0-9\\-]*$", - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "AwsLambda": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "FunctionPayload": { - "type": "string" - } - }, - "required": [ - "FunctionArn" - ], - "type": "object" - }, - "ObjectLambdaConfiguration": { - "additionalProperties": false, - "description": "Configuration to be applied to this Object lambda Access Point. It specifies Supporting Access Point, Transformation Configurations. Customers can also set if they like to enable Cloudwatch metrics for accesses to this Object lambda Access Point. Default setting for Cloudwatch metrics is disable.", - "properties": { - "AllowedFeatures": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "SupportingAccessPoint": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "TransformationConfigurations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TransformationConfiguration" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "SupportingAccessPoint", - "TransformationConfigurations" - ], - "type": "object" - }, - "PolicyStatus": { - "additionalProperties": false, - "properties": { - "IsPublic": { - "description": "Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default.", - "type": "boolean" - } - }, - "type": "object" - }, - "PublicAccessBlockConfiguration": { - "additionalProperties": false, - "description": "The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point. All public access to Object lambda Access Points are blocked by default, and any policy that would give public access to them will be also blocked. This behavior cannot be changed for Object lambda Access Points.", - "properties": { - "BlockPublicAcls": { - "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) to this object lambda access point. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", - "type": "boolean" - }, - "BlockPublicPolicy": { - "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", - "type": "boolean" - }, - "IgnorePublicAcls": { - "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", - "type": "boolean" - }, - "RestrictPublicBuckets": { - "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", - "type": "boolean" - } - }, - "type": "object" - }, - "TransformationConfiguration": { - "additionalProperties": false, - "description": "Configuration to define what content transformation will be applied on which S3 Action.", - "properties": { - "Actions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": true - }, - "ContentTransformation": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "AwsLambda": { - "$ref": "#/definitions/AwsLambda" - } - }, - "required": [ - "AwsLambda" - ] - } - ], - "type": "object" - } - }, - "required": [ - "Actions", - "ContentTransformation" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/PolicyStatus", - "/properties/PolicyStatus/IsPublic" - ], - "description": "The AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions", - "handlers": { - "create": { - "permissions": [ - "s3:CreateAccessPointForObjectLambda", - "s3:PutAccessPointConfigurationForObjectLambda", - "s3:GetAccessPointForObjectLambda", - "s3:GetAccessPointPolicyStatusForObjectLambda", - "s3:GetAccessPointConfigurationForObjectLambda" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessPointForObjectLambda" - ] - }, - "list": { - "permissions": [ - "s3:ListAccessPointsForObjectLambda" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessPointForObjectLambda", - "s3:GetAccessPointPolicyStatusForObjectLambda", - "s3:GetAccessPointConfigurationForObjectLambda" - ] - }, - "update": { - "permissions": [ - "s3:PutAccessPointConfigurationForObjectLambda", - "s3:GetAccessPointForObjectLambda", - "s3:GetAccessPointPolicyStatusForObjectLambda", - "s3:GetAccessPointConfigurationForObjectLambda" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Alias": { - "$ref": "#/definitions/Alias" - }, - "Arn": { - "pattern": "arn:[^:]+:s3-object-lambda:[^:]*:\\d{12}:accesspoint/.*", - "type": "string" - }, - "CreationDate": { - "description": "The date and time when the Object lambda Access Point was created.", - "type": "string" - }, - "Name": { - "description": "The name you want to assign to this Object lambda Access Point.", - "maxLength": 45, - "minLength": 3, - "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", - "type": "string" - }, - "ObjectLambdaConfiguration": { - "$ref": "#/definitions/ObjectLambdaConfiguration", - "description": "The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions" - }, - "PolicyStatus": { - "$ref": "#/definitions/PolicyStatus" - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/PublicAccessBlockConfiguration", - "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Alias", - "/properties/Alias/Value", - "/properties/Alias/Status", - "/properties/PolicyStatus", - "/properties/PolicyStatus/IsPublic", - "/properties/CreationDate", - "/properties/PublicAccessBlockConfiguration" - ], - "required": [ - "ObjectLambdaConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::S3ObjectLambda::AccessPoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Action": { + "type": "string" + }, + "Alias": { + "additionalProperties": false, + "properties": { + "Status": { + "description": "The status of the Object Lambda alias.", + "pattern": "^[A-Z]*$", + "type": "string" + }, + "Value": { + "description": "The value of the Object Lambda alias.", + "pattern": "^[a-z0-9\\-]*$", + "type": "string" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "AwsLambda": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "FunctionPayload": { + "type": "string" + } + }, + "required": [ + "FunctionArn" + ], + "type": "object" + }, + "ObjectLambdaConfiguration": { + "additionalProperties": false, + "description": "Configuration to be applied to this Object lambda Access Point. It specifies Supporting Access Point, Transformation Configurations. Customers can also set if they like to enable Cloudwatch metrics for accesses to this Object lambda Access Point. Default setting for Cloudwatch metrics is disable.", + "properties": { + "AllowedFeatures": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "CloudWatchMetricsEnabled": { + "type": "boolean" + }, + "SupportingAccessPoint": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "TransformationConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TransformationConfiguration" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "SupportingAccessPoint", + "TransformationConfigurations" + ], + "type": "object" + }, + "PolicyStatus": { + "additionalProperties": false, + "properties": { + "IsPublic": { + "description": "Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "PublicAccessBlockConfiguration": { + "additionalProperties": false, + "description": "The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point. All public access to Object lambda Access Points are blocked by default, and any policy that would give public access to them will be also blocked. This behavior cannot be changed for Object lambda Access Points.", + "properties": { + "BlockPublicAcls": { + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) to this object lambda access point. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\n. - PUT Bucket calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", + "type": "boolean" + }, + "BlockPublicPolicy": { + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.", + "type": "boolean" + }, + "IgnorePublicAcls": { + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.\nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", + "type": "boolean" + } + }, + "type": "object" + }, + "TransformationConfiguration": { + "additionalProperties": false, + "description": "Configuration to define what content transformation will be applied on which S3 Action.", + "properties": { + "Actions": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": true + }, + "ContentTransformation": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "AwsLambda": { + "$ref": "#/definitions/AwsLambda" + } + }, + "required": [ + "AwsLambda" + ] + } + ], + "type": "object" + } + }, + "required": [ + "Actions", + "ContentTransformation" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/PolicyStatus", + "/properties/PolicyStatus/IsPublic" + ], + "description": "The AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions", + "handlers": { + "create": { + "permissions": [ + "s3:CreateAccessPointForObjectLambda", + "s3:PutAccessPointConfigurationForObjectLambda", + "s3:GetAccessPointForObjectLambda", + "s3:GetAccessPointPolicyStatusForObjectLambda", + "s3:GetAccessPointConfigurationForObjectLambda" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessPointForObjectLambda" + ] + }, + "list": { + "permissions": [ + "s3:ListAccessPointsForObjectLambda" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessPointForObjectLambda", + "s3:GetAccessPointPolicyStatusForObjectLambda", + "s3:GetAccessPointConfigurationForObjectLambda" + ] + }, + "update": { + "permissions": [ + "s3:PutAccessPointConfigurationForObjectLambda", + "s3:GetAccessPointForObjectLambda", + "s3:GetAccessPointPolicyStatusForObjectLambda", + "s3:GetAccessPointConfigurationForObjectLambda" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Alias": { + "$ref": "#/definitions/Alias" + }, + "Arn": { + "pattern": "arn:[^:]+:s3-object-lambda:[^:]*:\\d{12}:accesspoint/.*", + "type": "string" + }, + "CreationDate": { + "description": "The date and time when the Object lambda Access Point was created.", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Object lambda Access Point.", + "maxLength": 45, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", + "type": "string" + }, + "ObjectLambdaConfiguration": { + "$ref": "#/definitions/ObjectLambdaConfiguration", + "description": "The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions" + }, + "PolicyStatus": { + "$ref": "#/definitions/PolicyStatus" + }, + "PublicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Alias", + "/properties/Alias/Value", + "/properties/Alias/Status", + "/properties/PolicyStatus", + "/properties/PolicyStatus/IsPublic", + "/properties/CreationDate", + "/properties/PublicAccessBlockConfiguration" + ], + "required": [ + "ObjectLambdaConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::S3ObjectLambda::AccessPoint" +} diff --git a/schema/aws-s3objectlambda-accesspointpolicy.json b/schema/aws-s3objectlambda-accesspointpolicy.json index 3fec95b..22301b4 100644 --- a/schema/aws-s3objectlambda-accesspointpolicy.json +++ b/schema/aws-s3objectlambda-accesspointpolicy.json @@ -1,57 +1,57 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ObjectLambdaAccessPoint" - ], - "description": "AWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda", - "handlers": { - "create": { - "permissions": [ - "s3:PutAccessPointPolicyForObjectLambda", - "s3:GetAccessPointPolicyForObjectLambda" - ] - }, - "delete": { - "permissions": [ - "s3:DeleteAccessPointPolicyForObjectLambda", - "s3:GetAccessPointPolicyForObjectLambda" - ] - }, - "read": { - "permissions": [ - "s3:GetAccessPointPolicyForObjectLambda" - ] - }, - "update": { - "permissions": [ - "s3:PutAccessPointPolicyForObjectLambda", - "s3:GetAccessPointPolicyForObjectLambda" - ] - } - }, - "primaryIdentifier": [ - "/properties/ObjectLambdaAccessPoint" - ], - "properties": { - "ObjectLambdaAccessPoint": { - "description": "The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.", - "maxLength": 45, - "minLength": 3, - "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. ", - "type": "object" - } - }, - "required": [ - "ObjectLambdaAccessPoint", - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::S3ObjectLambda::AccessPointPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ObjectLambdaAccessPoint" + ], + "description": "AWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda", + "handlers": { + "create": { + "permissions": [ + "s3:PutAccessPointPolicyForObjectLambda", + "s3:GetAccessPointPolicyForObjectLambda" + ] + }, + "delete": { + "permissions": [ + "s3:DeleteAccessPointPolicyForObjectLambda", + "s3:GetAccessPointPolicyForObjectLambda" + ] + }, + "read": { + "permissions": [ + "s3:GetAccessPointPolicyForObjectLambda" + ] + }, + "update": { + "permissions": [ + "s3:PutAccessPointPolicyForObjectLambda", + "s3:GetAccessPointPolicyForObjectLambda" + ] + } + }, + "primaryIdentifier": [ + "/properties/ObjectLambdaAccessPoint" + ], + "properties": { + "ObjectLambdaAccessPoint": { + "description": "The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.", + "maxLength": 45, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. ", + "type": "object" + } + }, + "required": [ + "ObjectLambdaAccessPoint", + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::S3ObjectLambda::AccessPointPolicy" +} diff --git a/schema/aws-s3outposts-accesspoint.json b/schema/aws-s3outposts-accesspoint.json index 101ae98..40e977b 100644 --- a/schema/aws-s3outposts-accesspoint.json +++ b/schema/aws-s3outposts-accesspoint.json @@ -1,108 +1,108 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Bucket", - "/properties/Name", - "/properties/VpcConfiguration" - ], - "definitions": { - "VpcConfiguration": { - "additionalProperties": false, - "properties": { - "VpcId": { - "description": "Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type Definition for AWS::S3Outposts::AccessPoint", - "handlers": { - "create": { - "permissions": [ - "s3-outposts:CreateAccessPoint", - "s3-outposts:GetAccessPoint", - "s3-outposts:PutAccessPointPolicy", - "s3-outposts:GetAccessPointPolicy" - ] - }, - "delete": { - "permissions": [ - "s3-outposts:DeleteAccessPoint", - "s3-outposts:DeleteAccessPointPolicy" - ] - }, - "list": { - "permissions": [ - "s3-outposts:ListAccessPoints" - ] - }, - "read": { - "permissions": [ - "s3-outposts:GetAccessPoint", - "s3-outposts:GetAccessPointPolicy" - ] - }, - "update": { - "permissions": [ - "s3-outposts:GetAccessPoint", - "s3-outposts:PutAccessPointPolicy", - "s3-outposts:GetAccessPointPolicy", - "s3-outposts:DeleteAccessPointPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the specified AccessPoint.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/accesspoint\\/[^:]+$", - "type": "string" - }, - "Bucket": { - "description": "The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", - "type": "string" - }, - "Name": { - "description": "A name for the AccessPoint.", - "maxLength": 50, - "minLength": 3, - "pattern": "^[a-z0-9]([a-z0-9\\\\-]*[a-z0-9])?$", - "type": "string" - }, - "Policy": { - "description": "The access point policy associated with this access point.", - "type": "object" - }, - "VpcConfiguration": { - "$ref": "#/definitions/VpcConfiguration", - "description": "Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint." - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Bucket", - "Name", - "VpcConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3Outposts::AccessPoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Bucket", + "/properties/Name", + "/properties/VpcConfiguration" + ], + "definitions": { + "VpcConfiguration": { + "additionalProperties": false, + "properties": { + "VpcId": { + "description": "Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type Definition for AWS::S3Outposts::AccessPoint", + "handlers": { + "create": { + "permissions": [ + "s3-outposts:CreateAccessPoint", + "s3-outposts:GetAccessPoint", + "s3-outposts:PutAccessPointPolicy", + "s3-outposts:GetAccessPointPolicy" + ] + }, + "delete": { + "permissions": [ + "s3-outposts:DeleteAccessPoint", + "s3-outposts:DeleteAccessPointPolicy" + ] + }, + "list": { + "permissions": [ + "s3-outposts:ListAccessPoints" + ] + }, + "read": { + "permissions": [ + "s3-outposts:GetAccessPoint", + "s3-outposts:GetAccessPointPolicy" + ] + }, + "update": { + "permissions": [ + "s3-outposts:GetAccessPoint", + "s3-outposts:PutAccessPointPolicy", + "s3-outposts:GetAccessPointPolicy", + "s3-outposts:DeleteAccessPointPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the specified AccessPoint.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/accesspoint\\/[^:]+$", + "type": "string" + }, + "Bucket": { + "description": "The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", + "type": "string" + }, + "Name": { + "description": "A name for the AccessPoint.", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9\\\\-]*[a-z0-9])?$", + "type": "string" + }, + "Policy": { + "description": "The access point policy associated with this access point.", + "type": "object" + }, + "VpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration", + "description": "Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint." + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Bucket", + "Name", + "VpcConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3Outposts::AccessPoint" +} diff --git a/schema/aws-s3outposts-bucket.json b/schema/aws-s3outposts-bucket.json index b2822ed..3d92e46 100644 --- a/schema/aws-s3outposts-bucket.json +++ b/schema/aws-s3outposts-bucket.json @@ -1,313 +1,313 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/BucketName", - "/properties/OutpostId" - ], - "definitions": { - "AbortIncompleteMultipartUpload": { - "additionalProperties": false, - "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3Outposts will wait before permanently removing all parts of the upload.", - "properties": { - "DaysAfterInitiation": { - "description": "Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "DaysAfterInitiation" - ], - "type": "object" - }, - "FilterAndOperator": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Prefix": { - "$ref": "#/definitions/FilterPrefix", - "description": "Prefix identifies one or more objects to which the rule applies." - }, - "Tags": { - "description": "All of these tags must exist in the object's tag set in order for the rule to apply.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FilterTag" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Tags" - ], - "type": "object" - } - ] - }, - "FilterPrefix": { - "description": "Prefix identifies one or more objects to which the rule applies.", - "type": "string" - }, - "FilterTag": { - "additionalProperties": false, - "description": "Tag used to identify a subset of objects for an Amazon S3Outposts bucket.", - "properties": { - "Key": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", - "type": "string" - }, - "Value": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "LifecycleConfiguration": { - "additionalProperties": false, - "properties": { - "Rules": { - "description": "A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "anyOf": [ - { - "required": [ - "Status", - "AbortIncompleteMultipartUpload" - ] - }, - { - "required": [ - "Status", - "ExpirationDate" - ] - }, - { - "required": [ - "Status", - "ExpirationInDays" - ] - } - ], - "description": "Specifies lifecycle rules for an Amazon S3Outposts bucket. You must specify at least one of the following: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays.", - "properties": { - "AbortIncompleteMultipartUpload": { - "$ref": "#/definitions/AbortIncompleteMultipartUpload", - "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket." - }, - "ExpirationDate": { - "$ref": "#/definitions/iso8601UTC", - "description": "Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC." - }, - "ExpirationInDays": { - "description": "Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.", - "minimum": 1, - "type": "integer" - }, - "Filter": { - "additionalProperties": false, - "description": "The container for the filter of the lifecycle rule.", - "oneOf": [ - { - "required": [ - "Prefix" - ] - }, - { - "required": [ - "Tag" - ] - }, - { - "required": [ - "AndOperator" - ] - } - ], - "properties": { - "AndOperator": { - "$ref": "#/definitions/FilterAndOperator", - "description": "The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags." - }, - "Prefix": { - "$ref": "#/definitions/FilterPrefix", - "description": "Object key prefix that identifies one or more objects to which this rule applies." - }, - "Tag": { - "$ref": "#/definitions/FilterTag", - "description": "Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket." - } - }, - "type": "object" - }, - "Id": { - "description": "Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.", - "maxLength": 255, - "type": "string" - }, - "Status": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^(?!aws:.*)([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", - "type": "string" - }, - "Value": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "iso8601UTC": { - "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Resource Type Definition for AWS::S3Outposts::Bucket", - "handlers": { - "create": { - "permissions": [ - "s3-outposts:CreateBucket", - "s3-outposts:PutBucketTagging", - "s3-outposts:PutLifecycleConfiguration" - ] - }, - "delete": { - "permissions": [ - "s3-outposts:DeleteBucket" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "OutpostId": { - "$ref": "resource-schema.json#/properties/OutpostId" - } - }, - "required": [ - "OutpostId" - ] - }, - "permissions": [ - "s3-outposts:ListRegionalBuckets" - ] - }, - "read": { - "permissions": [ - "s3-outposts:GetBucket", - "s3-outposts:GetBucketTagging", - "s3-outposts:GetLifecycleConfiguration" - ] - }, - "update": { - "permissions": [ - "s3-outposts:PutBucketTagging", - "s3-outposts:DeleteBucketTagging", - "s3-outposts:PutLifecycleConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the specified bucket.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", - "type": "string" - }, - "BucketName": { - "description": "A name for the bucket.", - "maxLength": 63, - "minLength": 3, - "pattern": "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)", - "type": "string" - }, - "LifecycleConfiguration": { - "$ref": "#/definitions/LifecycleConfiguration", - "description": "Rules that define how Amazon S3Outposts manages objects during their lifetime." - }, - "OutpostId": { - "description": "The id of the customer outpost on which the bucket resides.", - "pattern": "^(op-[a-f0-9]{17}|\\d{12}|ec2)$", - "type": "string" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "BucketName", - "OutpostId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "s3-outposts:DeleteBucketTagging", - "s3-outposts:PutBucketTagging", - "s3-outposts:GetBucketTagging" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::S3Outposts::Bucket" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/BucketName", + "/properties/OutpostId" + ], + "definitions": { + "AbortIncompleteMultipartUpload": { + "additionalProperties": false, + "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3Outposts will wait before permanently removing all parts of the upload.", + "properties": { + "DaysAfterInitiation": { + "description": "Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "DaysAfterInitiation" + ], + "type": "object" + }, + "FilterAndOperator": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Prefix": { + "$ref": "#/definitions/FilterPrefix", + "description": "Prefix identifies one or more objects to which the rule applies." + }, + "Tags": { + "description": "All of these tags must exist in the object's tag set in order for the rule to apply.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterTag" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Tags" + ], + "type": "object" + } + ] + }, + "FilterPrefix": { + "description": "Prefix identifies one or more objects to which the rule applies.", + "type": "string" + }, + "FilterTag": { + "additionalProperties": false, + "description": "Tag used to identify a subset of objects for an Amazon S3Outposts bucket.", + "properties": { + "Key": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", + "type": "string" + }, + "Value": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "LifecycleConfiguration": { + "additionalProperties": false, + "properties": { + "Rules": { + "description": "A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Rules" + ], + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "Status", + "AbortIncompleteMultipartUpload" + ] + }, + { + "required": [ + "Status", + "ExpirationDate" + ] + }, + { + "required": [ + "Status", + "ExpirationInDays" + ] + } + ], + "description": "Specifies lifecycle rules for an Amazon S3Outposts bucket. You must specify at least one of the following: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays.", + "properties": { + "AbortIncompleteMultipartUpload": { + "$ref": "#/definitions/AbortIncompleteMultipartUpload", + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket." + }, + "ExpirationDate": { + "$ref": "#/definitions/iso8601UTC", + "description": "Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC." + }, + "ExpirationInDays": { + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.", + "minimum": 1, + "type": "integer" + }, + "Filter": { + "additionalProperties": false, + "description": "The container for the filter of the lifecycle rule.", + "oneOf": [ + { + "required": [ + "Prefix" + ] + }, + { + "required": [ + "Tag" + ] + }, + { + "required": [ + "AndOperator" + ] + } + ], + "properties": { + "AndOperator": { + "$ref": "#/definitions/FilterAndOperator", + "description": "The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags." + }, + "Prefix": { + "$ref": "#/definitions/FilterPrefix", + "description": "Object key prefix that identifies one or more objects to which this rule applies." + }, + "Tag": { + "$ref": "#/definitions/FilterTag", + "description": "Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket." + } + }, + "type": "object" + }, + "Id": { + "description": "Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.", + "maxLength": 255, + "type": "string" + }, + "Status": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^(?!aws:.*)([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", + "type": "string" + }, + "Value": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:=+\\/\\-@%]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "iso8601UTC": { + "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Resource Type Definition for AWS::S3Outposts::Bucket", + "handlers": { + "create": { + "permissions": [ + "s3-outposts:CreateBucket", + "s3-outposts:PutBucketTagging", + "s3-outposts:PutLifecycleConfiguration" + ] + }, + "delete": { + "permissions": [ + "s3-outposts:DeleteBucket" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "OutpostId": { + "$ref": "resource-schema.json#/properties/OutpostId" + } + }, + "required": [ + "OutpostId" + ] + }, + "permissions": [ + "s3-outposts:ListRegionalBuckets" + ] + }, + "read": { + "permissions": [ + "s3-outposts:GetBucket", + "s3-outposts:GetBucketTagging", + "s3-outposts:GetLifecycleConfiguration" + ] + }, + "update": { + "permissions": [ + "s3-outposts:PutBucketTagging", + "s3-outposts:DeleteBucketTagging", + "s3-outposts:PutLifecycleConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the specified bucket.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", + "type": "string" + }, + "BucketName": { + "description": "A name for the bucket.", + "maxLength": 63, + "minLength": 3, + "pattern": "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)", + "type": "string" + }, + "LifecycleConfiguration": { + "$ref": "#/definitions/LifecycleConfiguration", + "description": "Rules that define how Amazon S3Outposts manages objects during their lifetime." + }, + "OutpostId": { + "description": "The id of the customer outpost on which the bucket resides.", + "pattern": "^(op-[a-f0-9]{17}|\\d{12}|ec2)$", + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "BucketName", + "OutpostId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "s3-outposts:DeleteBucketTagging", + "s3-outposts:PutBucketTagging", + "s3-outposts:GetBucketTagging" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::S3Outposts::Bucket" +} diff --git a/schema/aws-s3outposts-bucketpolicy.json b/schema/aws-s3outposts-bucketpolicy.json index 9c1a51b..31f7e38 100644 --- a/schema/aws-s3outposts-bucketpolicy.json +++ b/schema/aws-s3outposts-bucketpolicy.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Bucket" - ], - "definitions": {}, - "description": "Resource Type Definition for AWS::S3Outposts::BucketPolicy", - "handlers": { - "create": { - "permissions": [ - "s3-outposts:PutBucketPolicy", - "s3-outposts:GetBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "s3-outposts:DeleteBucketPolicy", - "s3-outposts:GetBucketPolicy" - ] - }, - "read": { - "permissions": [ - "s3-outposts:GetBucketPolicy" - ] - }, - "update": { - "permissions": [ - "s3-outposts:PutBucketPolicy", - "s3-outposts:GetBucketPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/Bucket" - ], - "properties": { - "Bucket": { - "description": "The Amazon Resource Name (ARN) of the specified bucket.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document containing permissions to add to the specified bucket.", - "type": "object" - } - }, - "required": [ - "Bucket", - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3Outposts::BucketPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Bucket" + ], + "definitions": {}, + "description": "Resource Type Definition for AWS::S3Outposts::BucketPolicy", + "handlers": { + "create": { + "permissions": [ + "s3-outposts:PutBucketPolicy", + "s3-outposts:GetBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "s3-outposts:DeleteBucketPolicy", + "s3-outposts:GetBucketPolicy" + ] + }, + "read": { + "permissions": [ + "s3-outposts:GetBucketPolicy" + ] + }, + "update": { + "permissions": [ + "s3-outposts:PutBucketPolicy", + "s3-outposts:GetBucketPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Bucket" + ], + "properties": { + "Bucket": { + "description": "The Amazon Resource Name (ARN) of the specified bucket.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/bucket\\/[^:]+$", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document containing permissions to add to the specified bucket.", + "type": "object" + } + }, + "required": [ + "Bucket", + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3Outposts::BucketPolicy" +} diff --git a/schema/aws-s3outposts-endpoint.json b/schema/aws-s3outposts-endpoint.json index e89bbec..657f129 100644 --- a/schema/aws-s3outposts-endpoint.json +++ b/schema/aws-s3outposts-endpoint.json @@ -1,175 +1,175 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OutpostId", - "/properties/SecurityGroupId", - "/properties/SubnetId", - "/properties/AccessType", - "/properties/CustomerOwnedIpv4Pool" - ], - "definitions": { - "FailedReason": { - "additionalProperties": false, - "properties": { - "ErrorCode": { - "description": "The failure code, if any, for a create or delete endpoint operation.", - "type": "string" - }, - "Message": { - "description": "Additional error details describing the endpoint failure and recommended action.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkInterface": { - "additionalProperties": false, - "description": "The container for the network interface.", - "properties": { - "NetworkInterfaceId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "NetworkInterfaceId" - ], - "type": "object" - }, - "iso8601UTC": { - "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", - "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", - "type": "string" - } - }, - "description": "Resource Type Definition for AWS::S3Outposts::Endpoint", - "handlers": { - "create": { - "permissions": [ - "s3-outposts:CreateEndpoint" - ] - }, - "delete": { - "permissions": [ - "s3-outposts:DeleteEndpoint" - ] - }, - "list": { - "permissions": [ - "s3-outposts:ListEndpoints" - ] - }, - "read": { - "permissions": [ - "s3-outposts:ListEndpoints" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "AccessType": { - "default": "Private", - "description": "The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.", - "enum": [ - "CustomerOwnedIp", - "Private" - ], - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the endpoint.", - "maxLength": 500, - "minLength": 5, - "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/endpoint/[a-zA-Z0-9]{19}$", - "type": "string" - }, - "CidrBlock": { - "description": "The VPC CIDR committed by this endpoint.", - "maxLength": 20, - "minLength": 1, - "type": "string" - }, - "CreationTime": { - "$ref": "#/definitions/iso8601UTC", - "description": "The time the endpoint was created." - }, - "CustomerOwnedIpv4Pool": { - "description": "The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.", - "pattern": "^ipv4pool-coip-([0-9a-f]{17})$", - "type": "string" - }, - "FailedReason": { - "$ref": "#/definitions/FailedReason", - "description": "The failure reason, if any, for a create or delete endpoint operation." - }, - "Id": { - "description": "The ID of the endpoint.", - "maxLength": 500, - "minLength": 5, - "pattern": "^[a-zA-Z0-9]{19}$", - "type": "string" - }, - "NetworkInterfaces": { - "description": "The network interfaces of the endpoint.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "type": "array", - "uniqueItems": true - }, - "OutpostId": { - "description": "The id of the customer outpost on which the bucket resides.", - "pattern": "^(op-[a-f0-9]{17}|\\d{12}|ec2)$", - "type": "string" - }, - "SecurityGroupId": { - "description": "The ID of the security group to use with the endpoint.", - "maxLength": 100, - "minLength": 1, - "pattern": "^sg-([0-9a-f]{8}|[0-9a-f]{17})$", - "type": "string" - }, - "Status": { - "enum": [ - "Available", - "Pending", - "Deleting", - "Create_Failed", - "Delete_Failed" - ], - "type": "string" - }, - "SubnetId": { - "description": "The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.", - "maxLength": 100, - "minLength": 1, - "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CidrBlock", - "/properties/CreationTime", - "/properties/Id", - "/properties/NetworkInterfaces", - "/properties/Status" - ], - "required": [ - "OutpostId", - "SecurityGroupId", - "SubnetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::S3Outposts::Endpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OutpostId", + "/properties/SecurityGroupId", + "/properties/SubnetId", + "/properties/AccessType", + "/properties/CustomerOwnedIpv4Pool" + ], + "definitions": { + "FailedReason": { + "additionalProperties": false, + "properties": { + "ErrorCode": { + "description": "The failure code, if any, for a create or delete endpoint operation.", + "type": "string" + }, + "Message": { + "description": "Additional error details describing the endpoint failure and recommended action.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkInterface": { + "additionalProperties": false, + "description": "The container for the network interface.", + "properties": { + "NetworkInterfaceId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "NetworkInterfaceId" + ], + "type": "object" + }, + "iso8601UTC": { + "description": "The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)", + "pattern": "^([0-2]\\d{3})-(0[0-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-4]):([0-5]\\d):([0-6]\\d)((\\.\\d{3})?)Z$", + "type": "string" + } + }, + "description": "Resource Type Definition for AWS::S3Outposts::Endpoint", + "handlers": { + "create": { + "permissions": [ + "s3-outposts:CreateEndpoint" + ] + }, + "delete": { + "permissions": [ + "s3-outposts:DeleteEndpoint" + ] + }, + "list": { + "permissions": [ + "s3-outposts:ListEndpoints" + ] + }, + "read": { + "permissions": [ + "s3-outposts:ListEndpoints" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AccessType": { + "default": "Private", + "description": "The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.", + "enum": [ + "CustomerOwnedIp", + "Private" + ], + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the endpoint.", + "maxLength": 500, + "minLength": 5, + "pattern": "^arn:[^:]+:s3-outposts:[a-zA-Z0-9\\-]+:\\d{12}:outpost\\/[^:]+\\/endpoint/[a-zA-Z0-9]{19}$", + "type": "string" + }, + "CidrBlock": { + "description": "The VPC CIDR committed by this endpoint.", + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "CreationTime": { + "$ref": "#/definitions/iso8601UTC", + "description": "The time the endpoint was created." + }, + "CustomerOwnedIpv4Pool": { + "description": "The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.", + "pattern": "^ipv4pool-coip-([0-9a-f]{17})$", + "type": "string" + }, + "FailedReason": { + "$ref": "#/definitions/FailedReason", + "description": "The failure reason, if any, for a create or delete endpoint operation." + }, + "Id": { + "description": "The ID of the endpoint.", + "maxLength": 500, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]{19}$", + "type": "string" + }, + "NetworkInterfaces": { + "description": "The network interfaces of the endpoint.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "type": "array", + "uniqueItems": true + }, + "OutpostId": { + "description": "The id of the customer outpost on which the bucket resides.", + "pattern": "^(op-[a-f0-9]{17}|\\d{12}|ec2)$", + "type": "string" + }, + "SecurityGroupId": { + "description": "The ID of the security group to use with the endpoint.", + "maxLength": 100, + "minLength": 1, + "pattern": "^sg-([0-9a-f]{8}|[0-9a-f]{17})$", + "type": "string" + }, + "Status": { + "enum": [ + "Available", + "Pending", + "Deleting", + "Create_Failed", + "Delete_Failed" + ], + "type": "string" + }, + "SubnetId": { + "description": "The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.", + "maxLength": 100, + "minLength": 1, + "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CidrBlock", + "/properties/CreationTime", + "/properties/Id", + "/properties/NetworkInterfaces", + "/properties/Status" + ], + "required": [ + "OutpostId", + "SecurityGroupId", + "SubnetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::S3Outposts::Endpoint" +} diff --git a/schema/aws-sagemaker-app.json b/schema/aws-sagemaker-app.json index 7b64bfc..0c4464a 100644 --- a/schema/aws-sagemaker-app.json +++ b/schema/aws-sagemaker-app.json @@ -1,227 +1,227 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppName", - "/properties/AppType", - "/properties/DomainId", - "/properties/UserProfileName", - "/properties/Tags", - "/properties/ResourceSpec" - ], - "definitions": { - "ResourceSpec": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "description": "The instance type that the image version runs on.", - "enum": [ - "system", - "ml.t3.micro", - "ml.t3.small", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.8xlarge", - "ml.m5.12xlarge", - "ml.m5.16xlarge", - "ml.m5.24xlarge", - "ml.c5.large", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.12xlarge", - "ml.c5.18xlarge", - "ml.c5.24xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.p3dn.24xlarge", - "ml.m5d.large", - "ml.m5d.xlarge", - "ml.m5d.2xlarge", - "ml.m5d.4xlarge", - "ml.m5d.8xlarge", - "ml.m5d.12xlarge", - "ml.m5d.16xlarge", - "ml.m5d.24xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.geospatial.interactive", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge" - ], - "type": "string" - }, - "LifecycleConfigArn": { - "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", - "maxLength": 256, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", - "type": "string" - }, - "SageMakerImageArn": { - "description": "The ARN of the SageMaker image that the image version belongs to.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$", - "type": "string" - }, - "SageMakerImageVersionArn": { - "description": "The ARN of the image version created on the instance.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::App", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateApp", - "sagemaker:DescribeApp" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteApp", - "sagemaker:DescribeApp" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListApps" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeApp", - "sagemaker:DescribeApp" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppName", - "/properties/AppType", - "/properties/DomainId", - "/properties/UserProfileName" - ], - "properties": { - "AppArn": { - "description": "The Amazon Resource Name (ARN) of the app.", - "maxLength": 256, - "minLength": 1, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*", - "type": "string" - }, - "AppName": { - "description": "The name of the app.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - }, - "AppType": { - "description": "The type of app.", - "enum": [ - "JupyterServer", - "KernelGateway", - "RStudioServerPro", - "RSessionGateway", - "Canvas" - ], - "type": "string" - }, - "DomainId": { - "description": "The domain ID.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "ResourceSpec": { - "$ref": "#/definitions/ResourceSpec", - "description": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance." - }, - "Tags": { - "description": "A list of tags to apply to the app.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "UserProfileName": { - "description": "The user profile name.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AppArn" - ], - "required": [ - "AppName", - "AppType", - "DomainId", - "UserProfileName" - ], - "typeName": "AWS::SageMaker::App", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppName", + "/properties/AppType", + "/properties/DomainId", + "/properties/UserProfileName", + "/properties/Tags", + "/properties/ResourceSpec" + ], + "definitions": { + "ResourceSpec": { + "additionalProperties": false, + "properties": { + "InstanceType": { + "description": "The instance type that the image version runs on.", + "enum": [ + "system", + "ml.t3.micro", + "ml.t3.small", + "ml.t3.medium", + "ml.t3.large", + "ml.t3.xlarge", + "ml.t3.2xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.8xlarge", + "ml.m5.12xlarge", + "ml.m5.16xlarge", + "ml.m5.24xlarge", + "ml.c5.large", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.12xlarge", + "ml.c5.18xlarge", + "ml.c5.24xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge", + "ml.g4dn.xlarge", + "ml.g4dn.2xlarge", + "ml.g4dn.4xlarge", + "ml.g4dn.8xlarge", + "ml.g4dn.12xlarge", + "ml.g4dn.16xlarge", + "ml.r5.large", + "ml.r5.xlarge", + "ml.r5.2xlarge", + "ml.r5.4xlarge", + "ml.r5.8xlarge", + "ml.r5.12xlarge", + "ml.r5.16xlarge", + "ml.r5.24xlarge", + "ml.p3dn.24xlarge", + "ml.m5d.large", + "ml.m5d.xlarge", + "ml.m5d.2xlarge", + "ml.m5d.4xlarge", + "ml.m5d.8xlarge", + "ml.m5d.12xlarge", + "ml.m5d.16xlarge", + "ml.m5d.24xlarge", + "ml.g5.xlarge", + "ml.g5.2xlarge", + "ml.g5.4xlarge", + "ml.g5.8xlarge", + "ml.g5.12xlarge", + "ml.g5.16xlarge", + "ml.g5.24xlarge", + "ml.g5.48xlarge", + "ml.p4d.24xlarge", + "ml.p4de.24xlarge", + "ml.geospatial.interactive", + "ml.trn1.2xlarge", + "ml.trn1.32xlarge", + "ml.trn1n.32xlarge" + ], + "type": "string" + }, + "LifecycleConfigArn": { + "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", + "maxLength": 256, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", + "type": "string" + }, + "SageMakerImageArn": { + "description": "The ARN of the SageMaker image that the image version belongs to.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$", + "type": "string" + }, + "SageMakerImageVersionArn": { + "description": "The ARN of the image version created on the instance.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::App", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateApp", + "sagemaker:DescribeApp" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteApp", + "sagemaker:DescribeApp" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListApps" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeApp", + "sagemaker:DescribeApp" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppName", + "/properties/AppType", + "/properties/DomainId", + "/properties/UserProfileName" + ], + "properties": { + "AppArn": { + "description": "The Amazon Resource Name (ARN) of the app.", + "maxLength": 256, + "minLength": 1, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*", + "type": "string" + }, + "AppName": { + "description": "The name of the app.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + }, + "AppType": { + "description": "The type of app.", + "enum": [ + "JupyterServer", + "KernelGateway", + "RStudioServerPro", + "RSessionGateway", + "Canvas" + ], + "type": "string" + }, + "DomainId": { + "description": "The domain ID.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "ResourceSpec": { + "$ref": "#/definitions/ResourceSpec", + "description": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance." + }, + "Tags": { + "description": "A list of tags to apply to the app.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "UserProfileName": { + "description": "The user profile name.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AppArn" + ], + "required": [ + "AppName", + "AppType", + "DomainId", + "UserProfileName" + ], + "typeName": "AWS::SageMaker::App", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-sagemaker-appimageconfig.json b/schema/aws-sagemaker-appimageconfig.json index febfd18..a75ab81 100644 --- a/schema/aws-sagemaker-appimageconfig.json +++ b/schema/aws-sagemaker-appimageconfig.json @@ -1,276 +1,276 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AppImageConfigName", - "/properties/Tags" - ], - "definitions": { - "CodeEditorAppImageConfig": { - "additionalProperties": false, - "description": "The configuration for the kernels in a SageMaker image running as a CodeEditor app.", - "properties": { - "ContainerConfig": { - "$ref": "#/definitions/ContainerConfig", - "description": "The container configuration for a SageMaker image." - } - }, - "type": "object" - }, - "ContainerConfig": { - "additionalProperties": false, - "description": "The container configuration for a SageMaker image.", - "properties": { - "ContainerArguments": { - "description": "A list of arguments to apply to the container.", - "items": { - "$ref": "#/definitions/CustomImageContainerArguments" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "ContainerEntrypoint": { - "description": "The custom entry point to use on container.", - "items": { - "$ref": "#/definitions/CustomImageContainerEntrypoint" - }, - "maxItems": 1, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "ContainerEnvironmentVariables": { - "description": "A list of variables to apply to the custom container.", - "items": { - "$ref": "#/definitions/CustomImageContainerEnvironmentVariable" - }, - "maxItems": 25, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "CustomImageContainerArguments": { - "description": "The container image arguments", - "maxLength": 64, - "minLength": 1, - "pattern": "^(?!\\s*$).+", - "type": "string" - }, - "CustomImageContainerEntrypoint": { - "description": "The container entry point", - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!\\s*$).+", - "type": "string" - }, - "CustomImageContainerEnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!\\s*$).+", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "pattern": "^(?!\\s*$).+", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "FileSystemConfig": { - "additionalProperties": false, - "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.", - "properties": { - "DefaultGid": { - "description": "The default POSIX group ID (GID). If not specified, defaults to 100.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "DefaultUid": { - "description": "The default POSIX user ID (UID). If not specified, defaults to 1000.", - "maximum": 65535, - "minimum": 0, - "type": "integer" - }, - "MountPath": { - "description": "The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^/.*", - "type": "string" - } - }, - "type": "object" - }, - "JupyterLabAppImageConfig": { - "additionalProperties": false, - "description": "The configuration for the kernels in a SageMaker image running as a JupyterLab app.", - "properties": { - "ContainerConfig": { - "$ref": "#/definitions/ContainerConfig", - "description": "The container configuration for a SageMaker image." - } - }, - "type": "object" - }, - "KernelGatewayImageConfig": { - "additionalProperties": false, - "description": "The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.", - "properties": { - "FileSystemConfig": { - "$ref": "#/definitions/FileSystemConfig", - "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image." - }, - "KernelSpecs": { - "description": "The specification of the Jupyter kernels in the image.", - "items": { - "$ref": "#/definitions/KernelSpec" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "KernelSpecs" - ], - "type": "object" - }, - "KernelSpec": { - "additionalProperties": false, - "properties": { - "DisplayName": { - "description": "The display name of the kernel.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The name of the kernel.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::AppImageConfig", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateAppImageConfig", - "sagemaker:DescribeAppImageConfig" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteAppImageConfig", - "sagemaker:DescribeAppImageConfig" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListAppImageConfigs" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeAppImageConfig" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateAppImageConfig", - "sagemaker:DescribeAppImageConfig" - ] - } - }, - "primaryIdentifier": [ - "/properties/AppImageConfigName" - ], - "properties": { - "AppImageConfigArn": { - "description": "The Amazon Resource Name (ARN) of the AppImageConfig.", - "maxLength": 256, - "minLength": 1, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*", - "type": "string" - }, - "AppImageConfigName": { - "description": "The Name of the AppImageConfig.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - }, - "CodeEditorAppImageConfig": { - "$ref": "#/definitions/CodeEditorAppImageConfig", - "description": "The CodeEditorAppImageConfig." - }, - "JupyterLabAppImageConfig": { - "$ref": "#/definitions/JupyterLabAppImageConfig", - "description": "The JupyterLabAppImageConfig." - }, - "KernelGatewayImageConfig": { - "$ref": "#/definitions/KernelGatewayImageConfig", - "description": "The KernelGatewayImageConfig." - }, - "Tags": { - "description": "A list of tags to apply to the AppImageConfig.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/AppImageConfigArn" - ], - "required": [ - "AppImageConfigName" - ], - "typeName": "AWS::SageMaker::AppImageConfig", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AppImageConfigName", + "/properties/Tags" + ], + "definitions": { + "CodeEditorAppImageConfig": { + "additionalProperties": false, + "description": "The configuration for the kernels in a SageMaker image running as a CodeEditor app.", + "properties": { + "ContainerConfig": { + "$ref": "#/definitions/ContainerConfig", + "description": "The container configuration for a SageMaker image." + } + }, + "type": "object" + }, + "ContainerConfig": { + "additionalProperties": false, + "description": "The container configuration for a SageMaker image.", + "properties": { + "ContainerArguments": { + "description": "A list of arguments to apply to the container.", + "items": { + "$ref": "#/definitions/CustomImageContainerArguments" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "ContainerEntrypoint": { + "description": "The custom entry point to use on container.", + "items": { + "$ref": "#/definitions/CustomImageContainerEntrypoint" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "ContainerEnvironmentVariables": { + "description": "A list of variables to apply to the custom container.", + "items": { + "$ref": "#/definitions/CustomImageContainerEnvironmentVariable" + }, + "maxItems": 25, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CustomImageContainerArguments": { + "description": "The container image arguments", + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "CustomImageContainerEntrypoint": { + "description": "The container entry point", + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "CustomImageContainerEnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "FileSystemConfig": { + "additionalProperties": false, + "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.", + "properties": { + "DefaultGid": { + "description": "The default POSIX group ID (GID). If not specified, defaults to 100.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "DefaultUid": { + "description": "The default POSIX user ID (UID). If not specified, defaults to 1000.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "MountPath": { + "description": "The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^/.*", + "type": "string" + } + }, + "type": "object" + }, + "JupyterLabAppImageConfig": { + "additionalProperties": false, + "description": "The configuration for the kernels in a SageMaker image running as a JupyterLab app.", + "properties": { + "ContainerConfig": { + "$ref": "#/definitions/ContainerConfig", + "description": "The container configuration for a SageMaker image." + } + }, + "type": "object" + }, + "KernelGatewayImageConfig": { + "additionalProperties": false, + "description": "The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.", + "properties": { + "FileSystemConfig": { + "$ref": "#/definitions/FileSystemConfig", + "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image." + }, + "KernelSpecs": { + "description": "The specification of the Jupyter kernels in the image.", + "items": { + "$ref": "#/definitions/KernelSpec" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "KernelSpecs" + ], + "type": "object" + }, + "KernelSpec": { + "additionalProperties": false, + "properties": { + "DisplayName": { + "description": "The display name of the kernel.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The name of the kernel.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::AppImageConfig", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateAppImageConfig", + "sagemaker:DescribeAppImageConfig" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteAppImageConfig", + "sagemaker:DescribeAppImageConfig" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListAppImageConfigs" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeAppImageConfig" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateAppImageConfig", + "sagemaker:DescribeAppImageConfig" + ] + } + }, + "primaryIdentifier": [ + "/properties/AppImageConfigName" + ], + "properties": { + "AppImageConfigArn": { + "description": "The Amazon Resource Name (ARN) of the AppImageConfig.", + "maxLength": 256, + "minLength": 1, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*", + "type": "string" + }, + "AppImageConfigName": { + "description": "The Name of the AppImageConfig.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + }, + "CodeEditorAppImageConfig": { + "$ref": "#/definitions/CodeEditorAppImageConfig", + "description": "The CodeEditorAppImageConfig." + }, + "JupyterLabAppImageConfig": { + "$ref": "#/definitions/JupyterLabAppImageConfig", + "description": "The JupyterLabAppImageConfig." + }, + "KernelGatewayImageConfig": { + "$ref": "#/definitions/KernelGatewayImageConfig", + "description": "The KernelGatewayImageConfig." + }, + "Tags": { + "description": "A list of tags to apply to the AppImageConfig.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/AppImageConfigArn" + ], + "required": [ + "AppImageConfigName" + ], + "typeName": "AWS::SageMaker::AppImageConfig", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-sagemaker-cluster.json b/schema/aws-sagemaker-cluster.json new file mode 100644 index 0000000..367097e --- /dev/null +++ b/schema/aws-sagemaker-cluster.json @@ -0,0 +1,401 @@ +{ + "additionalIdentifiers": [ + [ + "/properties/ClusterName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ClusterName", + "/properties/VpcConfig", + "/properties/Orchestrator", + "/properties/InstanceGroups/*/ExecutionRole", + "/properties/InstanceGroups/*/InstanceGroupName", + "/properties/InstanceGroups/*/InstanceType", + "/properties/InstanceGroups/*/ThreadsPerCore" + ], + "definitions": { + "ClusterEbsVolumeConfig": { + "additionalProperties": false, + "description": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.", + "properties": { + "VolumeSizeInGB": { + "description": "The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.", + "maximum": 16384, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "ClusterInstanceGroup": { + "additionalProperties": false, + "description": "Details of an instance group in a SageMaker HyperPod cluster.", + "properties": { + "CurrentCount": { + "description": "The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.", + "minimum": 0, + "type": "integer" + }, + "ExecutionRole": { + "$ref": "#/definitions/ExecutionRole" + }, + "InstanceCount": { + "description": "The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.", + "minimum": 1, + "type": "integer" + }, + "InstanceGroupName": { + "$ref": "#/definitions/InstanceGroupName" + }, + "InstanceStorageConfigs": { + "$ref": "#/definitions/ClusterInstanceStorageConfigs" + }, + "InstanceType": { + "$ref": "#/definitions/InstanceType" + }, + "LifeCycleConfig": { + "$ref": "#/definitions/ClusterLifeCycleConfig" + }, + "OnStartDeepHealthChecks": { + "$ref": "#/definitions/OnStartDeepHealthChecks" + }, + "ThreadsPerCore": { + "description": "The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.", + "maximum": 2, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "ExecutionRole", + "InstanceCount", + "InstanceGroupName", + "InstanceType", + "LifeCycleConfig" + ], + "type": "object" + }, + "ClusterInstanceGroupsList": { + "description": "The instance groups of the SageMaker HyperPod cluster.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ClusterInstanceGroup" + }, + "minItems": 1, + "type": "array" + }, + "ClusterInstanceStorageConfig": { + "description": "Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "EbsVolumeConfig": { + "$ref": "#/definitions/ClusterEbsVolumeConfig" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "ClusterInstanceStorageConfigs": { + "description": "The instance storage configuration for the instance group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ClusterInstanceStorageConfig" + }, + "maxItems": 1, + "type": "array" + }, + "ClusterLifeCycleConfig": { + "additionalProperties": false, + "description": "The lifecycle configuration for a SageMaker HyperPod cluster.", + "properties": { + "OnCreate": { + "description": "The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\S\\s]+$", + "type": "string" + }, + "SourceS3Uri": { + "description": "An Amazon S3 bucket path where your lifecycle scripts are stored.", + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "OnCreate", + "SourceS3Uri" + ], + "type": "object" + }, + "ClusterOrchestratorEksConfig": { + "additionalProperties": false, + "description": "Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,", + "properties": { + "ClusterArn": { + "description": "The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster", + "type": "string" + } + }, + "required": [ + "ClusterArn" + ], + "type": "object" + }, + "DeepHealthCheckType": { + "description": "The type of deep health check(s) to be performed on the instances in the SageMaker HyperPod cluster instance group.", + "enum": [ + "InstanceStress", + "InstanceConnectivity" + ], + "type": "string" + }, + "ExecutionRole": { + "description": "The execution role for the instance group to assume.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "InstanceGroupName": { + "description": "The name of the instance group of a SageMaker HyperPod cluster.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "InstanceType": { + "description": "The instance type of the instance group of a SageMaker HyperPod cluster.", + "type": "string" + }, + "OnStartDeepHealthChecks": { + "description": "Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DeepHealthCheckType" + }, + "type": "array" + }, + "Orchestrator": { + "additionalProperties": false, + "description": "Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.", + "properties": { + "Eks": { + "$ref": "#/definitions/ClusterOrchestratorEksConfig" + } + }, + "required": [ + "Eks" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "description": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC.", + "properties": { + "SecurityGroupIds": { + "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subnets": { + "description": "The ID of the subnets in the VPC to which you want to connect your training job or model.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::Cluster", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateCluster", + "sagemaker:DescribeCluster", + "sagemaker:AddTags", + "sagemaker:ListTags", + "eks:DescribeAccessEntry", + "eks:DescribeCluster", + "eks:CreateAccessEntry", + "eks:DeleteAccessEntry", + "eks:AssociateAccessPolicy", + "iam:CreateServiceLinkedRole", + "iam:PassRole" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "sagemaker:DeleteCluster", + "sagemaker:DescribeCluster", + "eks:DescribeAccessEntry", + "eks:DeleteAccessEntry" + ], + "timeoutInMinutes": 720 + }, + "list": { + "permissions": [ + "sagemaker:ListClusters" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeCluster", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateCluster", + "sagemaker:DescribeCluster", + "sagemaker:ListTags", + "sagemaker:AddTags", + "sagemaker:DeleteTags", + "eks:DescribeAccessEntry", + "eks:DescribeCluster", + "eks:CreateAccessEntry", + "eks:DeleteAccessEntry", + "iam:PassRole" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/ClusterArn" + ], + "properties": { + "ClusterArn": { + "description": "The Amazon Resource Name (ARN) of the HyperPod Cluster.", + "maxLength": 256, + "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$", + "type": "string" + }, + "ClusterName": { + "description": "The name of the HyperPod Cluster.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "ClusterStatus": { + "description": "The status of the HyperPod Cluster.", + "enum": [ + "Creating", + "Deleting", + "Failed", + "InService", + "RollingBack", + "SystemUpdating", + "Updating" + ], + "type": "string" + }, + "CreationTime": { + "description": "The time at which the HyperPod cluster was created.", + "type": "string" + }, + "FailureMessage": { + "description": "The failure message of the HyperPod Cluster.", + "type": "string" + }, + "InstanceGroups": { + "$ref": "#/definitions/ClusterInstanceGroupsList" + }, + "NodeRecovery": { + "description": "If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.", + "enum": [ + "Automatic", + "None" + ], + "type": "string" + }, + "Orchestrator": { + "$ref": "#/definitions/Orchestrator" + }, + "Tags": { + "description": "Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/ClusterArn", + "/properties/CreationTime", + "/properties/ClusterStatus", + "/properties/FailureMessage", + "/properties/InstanceGroups/*/CurrentCount" + ], + "required": [ + "InstanceGroups" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "sagemaker:AddTags", + "sagemaker:ListTags", + "sagemaker:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::Cluster" +} diff --git a/schema/aws-sagemaker-coderepository.json b/schema/aws-sagemaker-coderepository.json index 4a6443a..3fd702f 100644 --- a/schema/aws-sagemaker-coderepository.json +++ b/schema/aws-sagemaker-coderepository.json @@ -1,71 +1,71 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/CodeRepositoryName" - ], - "definitions": { - "GitConfig": { - "additionalProperties": false, - "properties": { - "Branch": { - "type": "string" - }, - "RepositoryUrl": { - "type": "string" - }, - "SecretArn": { - "type": "string" - } - }, - "required": [ - "RepositoryUrl" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::CodeRepository", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CodeRepositoryName": { - "type": "string" - }, - "GitConfig": { - "$ref": "#/definitions/GitConfig" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "GitConfig" - ], - "typeName": "AWS::SageMaker::CodeRepository" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CodeRepositoryName" + ], + "definitions": { + "GitConfig": { + "additionalProperties": false, + "properties": { + "Branch": { + "type": "string" + }, + "RepositoryUrl": { + "type": "string" + }, + "SecretArn": { + "type": "string" + } + }, + "required": [ + "RepositoryUrl" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::CodeRepository", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CodeRepositoryName": { + "type": "string" + }, + "GitConfig": { + "$ref": "#/definitions/GitConfig" + }, + "Id": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "GitConfig" + ], + "typeName": "AWS::SageMaker::CodeRepository" +} diff --git a/schema/aws-sagemaker-dataqualityjobdefinition.json b/schema/aws-sagemaker-dataqualityjobdefinition.json index b7dff15..ec555da 100644 --- a/schema/aws-sagemaker-dataqualityjobdefinition.json +++ b/schema/aws-sagemaker-dataqualityjobdefinition.json @@ -1,591 +1,591 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobDefinitionName", - "/properties/DataQualityAppSpecification", - "/properties/DataQualityBaselineConfig", - "/properties/DataQualityJobInput", - "/properties/DataQualityJobOutputConfig", - "/properties/JobResources", - "/properties/NetworkConfig", - "/properties/RoleArn", - "/properties/StoppingCondition", - "/properties/Tags", - "/properties/EndpointName" - ], - "definitions": { - "BatchTransformInput": { - "additionalProperties": false, - "description": "The batch transform input for a monitoring job.", - "properties": { - "DataCapturedDestinationS3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "DatasetFormat": { - "$ref": "#/definitions/DatasetFormat" - }, - "ExcludeFeaturesAttribute": { - "description": "Indexes or names of the features to be excluded from analysis", - "maxLength": 100, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - } - }, - "required": [ - "DataCapturedDestinationS3Uri", - "DatasetFormat", - "LocalPath" - ], - "type": "object" - }, - "ClusterConfig": { - "additionalProperties": false, - "description": "Configuration for the cluster used to run model monitoring jobs.", - "properties": { - "InstanceCount": { - "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "InstanceType": { - "description": "The ML compute instance type for the processing job.", - "type": "string" - }, - "VolumeKmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", - "maximum": 2048, - "minimum": 1, - "type": "string" - }, - "VolumeSizeInGB": { - "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", - "maximum": 16384, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "ConstraintsResource": { - "additionalProperties": false, - "description": "The baseline constraints resource for a monitoring job.", - "properties": { - "S3Uri": { - "$ref": "#/definitions/S3Uri", - "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." - } - }, - "type": "object" - }, - "Csv": { - "description": "The CSV format", - "properties": { - "Header": { - "description": "A boolean flag indicating if given CSV has header", - "type": "boolean" - } - }, - "type": "object" - }, - "DataQualityAppSpecification": { - "additionalProperties": false, - "description": "Container image configuration object for the monitoring job.", - "properties": { - "ContainerArguments": { - "description": "An array of arguments for the container used to run the monitoring job.", - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "type": "array" - }, - "ContainerEntrypoint": { - "description": "Specifies the entrypoint for a container used to run the monitoring job.", - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "type": "array" - }, - "Environment": { - "additionalProperties": false, - "description": "Sets the environment variables in the Docker container", - "patternProperties": { - "[\\S\\s]*": { - "maxLength": 256, - "type": "string" - }, - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ImageUri": { - "description": "The container image to be run by the monitoring job.", - "maxLength": 255, - "pattern": ".*", - "type": "string" - }, - "PostAnalyticsProcessorSourceUri": { - "$ref": "#/definitions/S3Uri", - "description": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers." - }, - "RecordPreprocessorSourceUri": { - "$ref": "#/definitions/S3Uri", - "description": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers" - } - }, - "required": [ - "ImageUri" - ], - "type": "object" - }, - "DataQualityBaselineConfig": { - "additionalProperties": false, - "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", - "properties": { - "BaseliningJobName": { - "$ref": "#/definitions/ProcessingJobName" - }, - "ConstraintsResource": { - "$ref": "#/definitions/ConstraintsResource" - }, - "StatisticsResource": { - "$ref": "#/definitions/StatisticsResource" - } - }, - "type": "object" - }, - "DataQualityJobInput": { - "additionalProperties": false, - "description": "The inputs for a monitoring job.", - "properties": { - "BatchTransformInput": { - "$ref": "#/definitions/BatchTransformInput" - }, - "EndpointInput": { - "$ref": "#/definitions/EndpointInput" - } - }, - "type": "object" - }, - "DatasetFormat": { - "description": "The dataset format of the data to monitor", - "properties": { - "Csv": { - "$ref": "#/definitions/Csv" - }, - "Json": { - "$ref": "#/definitions/Json" - }, - "Parquet": { - "$ref": "#/definitions/Parquet" - } - }, - "type": "object" - }, - "EndpointInput": { - "additionalProperties": false, - "description": "The endpoint for a monitoring job.", - "properties": { - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "ExcludeFeaturesAttribute": { - "description": "Indexes or names of the features to be excluded from analysis", - "maxLength": 100, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "EndpointName": { - "description": "The name of the endpoint used to run the monitoring job.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "JobDefinitionName": { - "description": "The name of the job definition.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "Json": { - "description": "The Json format", - "properties": { - "Line": { - "description": "A boolean flag indicating if it is JSON line format", - "type": "boolean" - } - }, - "type": "object" - }, - "MonitoringOutput": { - "additionalProperties": false, - "description": "The output object for a monitoring job.", - "properties": { - "S3Output": { - "$ref": "#/definitions/S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "MonitoringOutputConfig": { - "additionalProperties": false, - "description": "The output configuration for monitoring jobs.", - "properties": { - "KmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "MonitoringOutputs": { - "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", - "items": { - "$ref": "#/definitions/MonitoringOutput" - }, - "maxLength": 1, - "minLength": 1, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "MonitoringResources": { - "additionalProperties": false, - "description": "Identifies the resources to deploy for a monitoring job.", - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "NetworkConfig": { - "additionalProperties": false, - "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", - "properties": { - "EnableInterContainerTrafficEncryption": { - "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", - "type": "boolean" - }, - "EnableNetworkIsolation": { - "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "type": "object" - }, - "Parquet": { - "description": "A flag indicate if the dataset format is Parquet", - "type": "boolean" - }, - "ProcessingJobName": { - "description": "The name of a processing job", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "S3Output": { - "additionalProperties": false, - "description": "Information about where and how to store the results of a monitoring job.", - "properties": { - "LocalPath": { - "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3UploadMode": { - "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", - "enum": [ - "Continuous", - "EndOfJob" - ], - "type": "string" - }, - "S3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "S3Uri": { - "description": "The Amazon S3 URI.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "StatisticsResource": { - "additionalProperties": false, - "description": "The baseline statistics resource for a monitoring job.", - "properties": { - "S3Uri": { - "$ref": "#/definitions/S3Uri", - "description": "The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against." - } - }, - "type": "object" - }, - "StoppingCondition": { - "additionalProperties": false, - "description": "Specifies a time limit for how long the monitoring job is allowed to run.", - "properties": { - "MaxRuntimeInSeconds": { - "description": "The maximum runtime allowed in seconds.", - "maximum": 86400, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", - "properties": { - "SecurityGroupIds": { - "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Subnets": { - "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::DataQualityJobDefinition", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateDataQualityJobDefinition", - "sagemaker:DescribeDataQualityJobDefinition", - "sagemaker:AddTags", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteDataQualityJobDefinition" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListDataQualityJobDefinitions", - "sagemaker:ListTags" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeDataQualityJobDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobDefinitionArn" - ], - "properties": { - "CreationTime": { - "description": "The time at which the job definition was created.", - "type": "string" - }, - "DataQualityAppSpecification": { - "$ref": "#/definitions/DataQualityAppSpecification" - }, - "DataQualityBaselineConfig": { - "$ref": "#/definitions/DataQualityBaselineConfig" - }, - "DataQualityJobInput": { - "$ref": "#/definitions/DataQualityJobInput" - }, - "DataQualityJobOutputConfig": { - "$ref": "#/definitions/MonitoringOutputConfig" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "JobDefinitionArn": { - "description": "The Amazon Resource Name (ARN) of job definition.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "JobDefinitionName": { - "$ref": "#/definitions/JobDefinitionName" - }, - "JobResources": { - "$ref": "#/definitions/MonitoringResources" - }, - "NetworkConfig": { - "$ref": "#/definitions/NetworkConfig" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/StoppingCondition" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/JobDefinitionArn" - ], - "required": [ - "DataQualityAppSpecification", - "DataQualityJobInput", - "DataQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "typeName": "AWS::SageMaker::DataQualityJobDefinition", - "writeOnlyProperties": [ - "/properties/EndpointName", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/JobDefinitionName", + "/properties/DataQualityAppSpecification", + "/properties/DataQualityBaselineConfig", + "/properties/DataQualityJobInput", + "/properties/DataQualityJobOutputConfig", + "/properties/JobResources", + "/properties/NetworkConfig", + "/properties/RoleArn", + "/properties/StoppingCondition", + "/properties/Tags", + "/properties/EndpointName" + ], + "definitions": { + "BatchTransformInput": { + "additionalProperties": false, + "description": "The batch transform input for a monitoring job.", + "properties": { + "DataCapturedDestinationS3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "DatasetFormat": { + "$ref": "#/definitions/DatasetFormat" + }, + "ExcludeFeaturesAttribute": { + "description": "Indexes or names of the features to be excluded from analysis", + "maxLength": 100, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + } + }, + "required": [ + "DataCapturedDestinationS3Uri", + "DatasetFormat", + "LocalPath" + ], + "type": "object" + }, + "ClusterConfig": { + "additionalProperties": false, + "description": "Configuration for the cluster used to run model monitoring jobs.", + "properties": { + "InstanceCount": { + "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "InstanceType": { + "description": "The ML compute instance type for the processing job.", + "type": "string" + }, + "VolumeKmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", + "maximum": 2048, + "minimum": 1, + "type": "string" + }, + "VolumeSizeInGB": { + "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", + "maximum": 16384, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "InstanceCount", + "InstanceType", + "VolumeSizeInGB" + ], + "type": "object" + }, + "ConstraintsResource": { + "additionalProperties": false, + "description": "The baseline constraints resource for a monitoring job.", + "properties": { + "S3Uri": { + "$ref": "#/definitions/S3Uri", + "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." + } + }, + "type": "object" + }, + "Csv": { + "description": "The CSV format", + "properties": { + "Header": { + "description": "A boolean flag indicating if given CSV has header", + "type": "boolean" + } + }, + "type": "object" + }, + "DataQualityAppSpecification": { + "additionalProperties": false, + "description": "Container image configuration object for the monitoring job.", + "properties": { + "ContainerArguments": { + "description": "An array of arguments for the container used to run the monitoring job.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "type": "array" + }, + "ContainerEntrypoint": { + "description": "Specifies the entrypoint for a container used to run the monitoring job.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "Environment": { + "additionalProperties": false, + "description": "Sets the environment variables in the Docker container", + "patternProperties": { + "[\\S\\s]*": { + "maxLength": 256, + "type": "string" + }, + "[a-zA-Z_][a-zA-Z0-9_]*": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ImageUri": { + "description": "The container image to be run by the monitoring job.", + "maxLength": 255, + "pattern": ".*", + "type": "string" + }, + "PostAnalyticsProcessorSourceUri": { + "$ref": "#/definitions/S3Uri", + "description": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers." + }, + "RecordPreprocessorSourceUri": { + "$ref": "#/definitions/S3Uri", + "description": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers" + } + }, + "required": [ + "ImageUri" + ], + "type": "object" + }, + "DataQualityBaselineConfig": { + "additionalProperties": false, + "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", + "properties": { + "BaseliningJobName": { + "$ref": "#/definitions/ProcessingJobName" + }, + "ConstraintsResource": { + "$ref": "#/definitions/ConstraintsResource" + }, + "StatisticsResource": { + "$ref": "#/definitions/StatisticsResource" + } + }, + "type": "object" + }, + "DataQualityJobInput": { + "additionalProperties": false, + "description": "The inputs for a monitoring job.", + "properties": { + "BatchTransformInput": { + "$ref": "#/definitions/BatchTransformInput" + }, + "EndpointInput": { + "$ref": "#/definitions/EndpointInput" + } + }, + "type": "object" + }, + "DatasetFormat": { + "description": "The dataset format of the data to monitor", + "properties": { + "Csv": { + "$ref": "#/definitions/Csv" + }, + "Json": { + "$ref": "#/definitions/Json" + }, + "Parquet": { + "$ref": "#/definitions/Parquet" + } + }, + "type": "object" + }, + "EndpointInput": { + "additionalProperties": false, + "description": "The endpoint for a monitoring job.", + "properties": { + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "ExcludeFeaturesAttribute": { + "description": "Indexes or names of the features to be excluded from analysis", + "maxLength": 100, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + } + }, + "required": [ + "EndpointName", + "LocalPath" + ], + "type": "object" + }, + "EndpointName": { + "description": "The name of the endpoint used to run the monitoring job.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "JobDefinitionName": { + "description": "The name of the job definition.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "Json": { + "description": "The Json format", + "properties": { + "Line": { + "description": "A boolean flag indicating if it is JSON line format", + "type": "boolean" + } + }, + "type": "object" + }, + "MonitoringOutput": { + "additionalProperties": false, + "description": "The output object for a monitoring job.", + "properties": { + "S3Output": { + "$ref": "#/definitions/S3Output" + } + }, + "required": [ + "S3Output" + ], + "type": "object" + }, + "MonitoringOutputConfig": { + "additionalProperties": false, + "description": "The output configuration for monitoring jobs.", + "properties": { + "KmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "MonitoringOutputs": { + "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", + "items": { + "$ref": "#/definitions/MonitoringOutput" + }, + "maxLength": 1, + "minLength": 1, + "type": "array" + } + }, + "required": [ + "MonitoringOutputs" + ], + "type": "object" + }, + "MonitoringResources": { + "additionalProperties": false, + "description": "Identifies the resources to deploy for a monitoring job.", + "properties": { + "ClusterConfig": { + "$ref": "#/definitions/ClusterConfig" + } + }, + "required": [ + "ClusterConfig" + ], + "type": "object" + }, + "NetworkConfig": { + "additionalProperties": false, + "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", + "properties": { + "EnableInterContainerTrafficEncryption": { + "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", + "type": "boolean" + }, + "EnableNetworkIsolation": { + "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", + "type": "boolean" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "type": "object" + }, + "Parquet": { + "description": "A flag indicate if the dataset format is Parquet", + "type": "boolean" + }, + "ProcessingJobName": { + "description": "The name of a processing job", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "S3Output": { + "additionalProperties": false, + "description": "Information about where and how to store the results of a monitoring job.", + "properties": { + "LocalPath": { + "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "S3UploadMode": { + "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", + "enum": [ + "Continuous", + "EndOfJob" + ], + "type": "string" + }, + "S3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "LocalPath", + "S3Uri" + ], + "type": "object" + }, + "S3Uri": { + "description": "The Amazon S3 URI.", + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "StatisticsResource": { + "additionalProperties": false, + "description": "The baseline statistics resource for a monitoring job.", + "properties": { + "S3Uri": { + "$ref": "#/definitions/S3Uri", + "description": "The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against." + } + }, + "type": "object" + }, + "StoppingCondition": { + "additionalProperties": false, + "description": "Specifies a time limit for how long the monitoring job is allowed to run.", + "properties": { + "MaxRuntimeInSeconds": { + "description": "The maximum runtime allowed in seconds.", + "maximum": 86400, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxRuntimeInSeconds" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", + "properties": { + "SecurityGroupIds": { + "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subnets": { + "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::DataQualityJobDefinition", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateDataQualityJobDefinition", + "sagemaker:DescribeDataQualityJobDefinition", + "sagemaker:AddTags", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteDataQualityJobDefinition" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListDataQualityJobDefinitions", + "sagemaker:ListTags" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeDataQualityJobDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/JobDefinitionArn" + ], + "properties": { + "CreationTime": { + "description": "The time at which the job definition was created.", + "type": "string" + }, + "DataQualityAppSpecification": { + "$ref": "#/definitions/DataQualityAppSpecification" + }, + "DataQualityBaselineConfig": { + "$ref": "#/definitions/DataQualityBaselineConfig" + }, + "DataQualityJobInput": { + "$ref": "#/definitions/DataQualityJobInput" + }, + "DataQualityJobOutputConfig": { + "$ref": "#/definitions/MonitoringOutputConfig" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "JobDefinitionArn": { + "description": "The Amazon Resource Name (ARN) of job definition.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "JobDefinitionName": { + "$ref": "#/definitions/JobDefinitionName" + }, + "JobResources": { + "$ref": "#/definitions/MonitoringResources" + }, + "NetworkConfig": { + "$ref": "#/definitions/NetworkConfig" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "StoppingCondition": { + "$ref": "#/definitions/StoppingCondition" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/JobDefinitionArn" + ], + "required": [ + "DataQualityAppSpecification", + "DataQualityJobInput", + "DataQualityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "typeName": "AWS::SageMaker::DataQualityJobDefinition", + "writeOnlyProperties": [ + "/properties/EndpointName", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-sagemaker-device.json b/schema/aws-sagemaker-device.json index 807ae18..58510c2 100644 --- a/schema/aws-sagemaker-device.json +++ b/schema/aws-sagemaker-device.json @@ -1,113 +1,113 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Device/DeviceName" - ], - "definitions": { - "Device": { - "additionalProperties": false, - "description": "Edge device you want to create", - "properties": { - "Description": { - "description": "Description of the device", - "maxLength": 40, - "minLength": 1, - "pattern": "[\\S\\s]+", - "type": "string" - }, - "DeviceName": { - "description": "The name of the device", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "IotThingName": { - "description": "AWS Internet of Things (IoT) object name.", - "maxLength": 128, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^((?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::SageMaker::Device", - "handlers": { - "create": { - "permissions": [ - "sagemaker:RegisterDevices" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeregisterDevices" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeDevice" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateDevices" - ] - } - }, - "primaryIdentifier": [ - "/properties/Device/DeviceName" - ], - "properties": { - "Device": { - "$ref": "#/definitions/Device", - "description": "The Edge Device you want to register against a device fleet" - }, - "DeviceFleetName": { - "description": "The name of the edge device fleet", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$", - "type": "string" - }, - "Tags": { - "description": "Associate tags with the resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DeviceFleetName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker-edge.git", - "typeName": "AWS::SageMaker::Device" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Device/DeviceName" + ], + "definitions": { + "Device": { + "additionalProperties": false, + "description": "Edge device you want to create", + "properties": { + "Description": { + "description": "Description of the device", + "maxLength": 40, + "minLength": 1, + "pattern": "[\\S\\s]+", + "type": "string" + }, + "DeviceName": { + "description": "The name of the device", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "IotThingName": { + "description": "AWS Internet of Things (IoT) object name.", + "maxLength": 128, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + } + }, + "required": [ + "DeviceName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^((?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::SageMaker::Device", + "handlers": { + "create": { + "permissions": [ + "sagemaker:RegisterDevices" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeregisterDevices" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeDevice" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateDevices" + ] + } + }, + "primaryIdentifier": [ + "/properties/Device/DeviceName" + ], + "properties": { + "Device": { + "$ref": "#/definitions/Device", + "description": "The Edge Device you want to register against a device fleet" + }, + "DeviceFleetName": { + "description": "The name of the edge device fleet", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$", + "type": "string" + }, + "Tags": { + "description": "Associate tags with the resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "DeviceFleetName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker-edge.git", + "typeName": "AWS::SageMaker::Device" +} diff --git a/schema/aws-sagemaker-devicefleet.json b/schema/aws-sagemaker-devicefleet.json index b7f86e1..0139fef 100644 --- a/schema/aws-sagemaker-devicefleet.json +++ b/schema/aws-sagemaker-devicefleet.json @@ -1,124 +1,124 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DeviceFleetName" - ], - "definitions": { - "EdgeOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "description": "The KMS key id used for encryption on the S3 bucket", - "maxLength": 2048, - "minLength": 1, - "pattern": "[a-zA-Z0-9:_-]+", - "type": "string" - }, - "S3OutputLocation": { - "description": "The Amazon Simple Storage (S3) bucket URI", - "maxLength": 1024, - "pattern": "^s3://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "S3OutputLocation" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Key-value pair to associate as a tag for the resource", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^((?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::SageMaker::DeviceFleet", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateDeviceFleet", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteDeviceFleet" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeDeviceFleet" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateDeviceFleet", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DeviceFleetName" - ], - "properties": { - "Description": { - "description": "Description for the edge device fleet", - "maxLength": 800, - "minLength": 0, - "pattern": "[\\S\\s]+", - "type": "string" - }, - "DeviceFleetName": { - "description": "The name of the edge device fleet", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$", - "type": "string" - }, - "OutputConfig": { - "$ref": "#/definitions/EdgeOutputConfig", - "description": "S3 bucket and an ecryption key id (if available) to store outputs for the fleet" - }, - "RoleArn": { - "description": "Role associated with the device fleet", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Tags": { - "description": "Associate tags with the resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DeviceFleetName", - "OutputConfig", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker-edge.git", - "typeName": "AWS::SageMaker::DeviceFleet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DeviceFleetName" + ], + "definitions": { + "EdgeOutputConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "description": "The KMS key id used for encryption on the S3 bucket", + "maxLength": 2048, + "minLength": 1, + "pattern": "[a-zA-Z0-9:_-]+", + "type": "string" + }, + "S3OutputLocation": { + "description": "The Amazon Simple Storage (S3) bucket URI", + "maxLength": 1024, + "pattern": "^s3://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "S3OutputLocation" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Key-value pair to associate as a tag for the resource", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^((?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::SageMaker::DeviceFleet", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateDeviceFleet", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteDeviceFleet" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeDeviceFleet" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateDeviceFleet", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DeviceFleetName" + ], + "properties": { + "Description": { + "description": "Description for the edge device fleet", + "maxLength": 800, + "minLength": 0, + "pattern": "[\\S\\s]+", + "type": "string" + }, + "DeviceFleetName": { + "description": "The name of the edge device fleet", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$", + "type": "string" + }, + "OutputConfig": { + "$ref": "#/definitions/EdgeOutputConfig", + "description": "S3 bucket and an ecryption key id (if available) to store outputs for the fleet" + }, + "RoleArn": { + "description": "Role associated with the device fleet", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "description": "Associate tags with the resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "DeviceFleetName", + "OutputConfig", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker-edge.git", + "typeName": "AWS::SageMaker::DeviceFleet" +} diff --git a/schema/aws-sagemaker-domain.json b/schema/aws-sagemaker-domain.json index ceff779..1004e48 100644 --- a/schema/aws-sagemaker-domain.json +++ b/schema/aws-sagemaker-domain.json @@ -1,926 +1,986 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AuthMode", - "/properties/DomainName", - "/properties/DomainSettings/RStudioServerProDomainSettings/DefaultResourceSpec", - "/properties/KmsKeyId", - "/properties/VpcId", - "/properties/Tags" - ], - "definitions": { - "AppType": { - "enum": [ - "JupyterServer", - "TensorBoard", - "RStudioServerPro", - "JupyterLab", - "CodeEditor", - "DetailedProfiler", - "Canvas" - ], - "type": "string" - }, - "CodeEditorAppSettings": { - "additionalProperties": false, - "description": "The CodeEditor app settings.", - "properties": { - "CustomImages": { - "description": "A list of custom images for use for CodeEditor apps.", - "items": { - "$ref": "#/definitions/CustomImage" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec", - "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." - }, - "LifecycleConfigArns": { - "description": "A list of LifecycleConfigArns available for use with CodeEditor apps.", - "items": { - "$ref": "#/definitions/StudioLifecycleConfigArn" - }, - "maxItems": 30, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "CodeRepository": { - "additionalProperties": false, - "properties": { - "RepositoryUrl": { - "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension.", - "maxLength": 256, - "pattern": "^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$", - "type": "string" - } - }, - "required": [ - "RepositoryUrl" - ], - "type": "object" - }, - "CustomFileSystemConfig": { - "additionalProperties": false, - "properties": { - "EFSFileSystemConfig": { - "$ref": "#/definitions/EFSFileSystemConfig" - } - }, - "type": "object" - }, - "CustomImage": { - "additionalProperties": false, - "description": "A custom SageMaker image.", - "properties": { - "AppImageConfigName": { - "description": "The Name of the AppImageConfig.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - }, - "ImageName": { - "description": "The name of the CustomImage. Must be unique to your account.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "ImageVersionNumber": { - "description": "The version number of the CustomImage.", - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "AppImageConfigName", - "ImageName" - ], - "type": "object" - }, - "CustomPosixUserConfig": { - "additionalProperties": false, - "properties": { - "Gid": { - "maximum": 4000000, - "minimum": 1001, - "type": "integer" - }, - "Uid": { - "maximum": 4000000, - "minimum": 10000, - "type": "integer" - } - }, - "required": [ - "Uid", - "Gid" - ], - "type": "object" - }, - "DefaultEbsStorageSettings": { - "additionalProperties": false, - "description": "Properties related to the Amazon Elastic Block Store volume. Must be provided if storage type is Amazon EBS and must not be provided if storage type is not Amazon EBS", - "properties": { - "DefaultEbsVolumeSizeInGb": { - "$ref": "#/definitions/SpaceEbsVolumeSizeInGb", - "description": "Default size of the Amazon EBS volume in Gb" - }, - "MaximumEbsVolumeSizeInGb": { - "$ref": "#/definitions/SpaceEbsVolumeSizeInGb", - "description": "Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb." - } - }, - "required": [ - "DefaultEbsVolumeSizeInGb", - "MaximumEbsVolumeSizeInGb" - ], - "type": "object" - }, - "DefaultSpaceSettings": { - "additionalProperties": false, - "description": "A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.", - "properties": { - "CustomFileSystemConfigs": { - "items": { - "$ref": "#/definitions/CustomFileSystemConfig" - }, - "maxItems": 2, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "CustomPosixUserConfig": { - "$ref": "#/definitions/CustomPosixUserConfig", - "description": "The Jupyter lab's custom posix user configurations." - }, - "ExecutionRole": { - "description": "The execution role for the space.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "JupyterLabAppSettings": { - "$ref": "#/definitions/JupyterLabAppSettings", - "description": "The Jupyter lab's app settings." - }, - "JupyterServerAppSettings": { - "$ref": "#/definitions/JupyterServerAppSettings", - "description": "The Jupyter server's app settings." - }, - "KernelGatewayAppSettings": { - "$ref": "#/definitions/KernelGatewayAppSettings", - "description": "The kernel gateway app settings." - }, - "SecurityGroups": { - "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", - "insertionOrder": false, - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "SpaceStorageSettings": { - "$ref": "#/definitions/DefaultSpaceStorageSettings", - "description": "The Jupyter lab's space storage settings." - } - }, - "required": [ - "ExecutionRole" - ], - "type": "object" - }, - "DefaultSpaceStorageSettings": { - "additionalProperties": false, - "description": "Default storage settings for a space.", - "properties": { - "DefaultEbsStorageSettings": { - "$ref": "#/definitions/DefaultEbsStorageSettings" - } - }, - "type": "object" - }, - "DockerSettings": { - "additionalProperties": false, - "description": "A collection of settings that are required to start docker-proxy server.", - "properties": { - "EnableDockerAccess": { - "description": "The flag to enable/disable docker-proxy server", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "VpcOnlyTrustedAccounts": { - "description": "A list of account id's that would be used to pull images from in VpcOnly mode", - "insertionOrder": false, - "items": { - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d+$", - "type": "string" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DomainSettings": { - "additionalProperties": false, - "description": "A collection of Domain settings.", - "properties": { - "DockerSettings": { - "$ref": "#/definitions/DockerSettings" - }, - "RStudioServerProDomainSettings": { - "$ref": "#/definitions/RStudioServerProDomainSettings" - }, - "SecurityGroupIds": { - "description": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.", - "insertionOrder": false, - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 3, - "minItems": 1, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EFSFileSystemConfig": { - "additionalProperties": false, - "properties": { - "FileSystemId": { - "maxLength": 21, - "minLength": 11, - "pattern": "^(fs-[0-9a-f]{8,})$", - "type": "string" - }, - "FileSystemPath": { - "maxLength": 256, - "minLength": 1, - "pattern": "^\\/\\S*$", - "type": "string" - } - }, - "required": [ - "FileSystemId" - ], - "type": "object" - }, - "JupyterLabAppSettings": { - "additionalProperties": false, - "description": "The JupyterLab app settings.", - "properties": { - "CodeRepositories": { - "description": "A list of CodeRepositories available for use with JupyterLab apps.", - "items": { - "$ref": "#/definitions/CodeRepository" - }, - "maxItems": 30, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "CustomImages": { - "description": "A list of custom images for use for JupyterLab apps.", - "items": { - "$ref": "#/definitions/CustomImage" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec", - "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app." - }, - "LifecycleConfigArns": { - "description": "A list of LifecycleConfigArns available for use with JupyterLab apps.", - "items": { - "$ref": "#/definitions/StudioLifecycleConfigArn" - }, - "maxItems": 30, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "JupyterServerAppSettings": { - "additionalProperties": false, - "description": "The JupyterServer app settings.", - "properties": { - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec" - }, - "LifecycleConfigArns": { - "description": "A list of LifecycleConfigArns available for use with JupyterServer apps.", - "items": { - "$ref": "#/definitions/StudioLifecycleConfigArn" - }, - "maxItems": 30, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "KernelGatewayAppSettings": { - "additionalProperties": false, - "description": "The kernel gateway app settings.", - "properties": { - "CustomImages": { - "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomImage" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec", - "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app." - }, - "LifecycleConfigArns": { - "description": "A list of LifecycleConfigArns available for use with KernelGateway apps.", - "items": { - "$ref": "#/definitions/StudioLifecycleConfigArn" - }, - "maxItems": 30, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "MlTools": { - "enum": [ - "DataWrangler", - "FeatureStore", - "EmrClusters", - "AutoML", - "Experiments", - "Training", - "ModelEvaluation", - "Pipelines", - "Models", - "JumpStart", - "InferenceRecommender", - "Endpoints", - "Projects" - ], - "type": "string" - }, - "RSessionAppSettings": { - "additionalProperties": false, - "description": "A collection of settings that apply to an RSessionGateway app.", - "properties": { - "CustomImages": { - "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomImage" - }, - "maxItems": 200, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec" - } - }, - "type": "object" - }, - "RStudioServerProAppSettings": { - "additionalProperties": false, - "description": "A collection of settings that configure user interaction with the RStudioServerPro app.", - "properties": { - "AccessStatus": { - "description": "Indicates whether the current user has access to the RStudioServerPro app.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "UserGroup": { - "description": "The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.", - "enum": [ - "R_STUDIO_ADMIN", - "R_STUDIO_USER" - ], - "type": "string" - } - }, - "type": "object" - }, - "RStudioServerProDomainSettings": { - "additionalProperties": false, - "description": "A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.", - "properties": { - "DefaultResourceSpec": { - "$ref": "#/definitions/ResourceSpec" - }, - "DomainExecutionRoleArn": { - "description": "The ARN of the execution role for the RStudioServerPro Domain-level app.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "RStudioConnectUrl": { - "description": "A URL pointing to an RStudio Connect server.", - "pattern": "^(https:|http:|www\\.)\\S*", - "type": "string" - }, - "RStudioPackageManagerUrl": { - "description": "A URL pointing to an RStudio Package Manager server.", - "pattern": "^(https:|http:|www\\.)\\S*", - "type": "string" - } - }, - "required": [ - "DomainExecutionRoleArn" - ], - "type": "object" - }, - "ResourceSpec": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "description": "The instance type that the image version runs on.", - "enum": [ - "system", - "ml.t3.micro", - "ml.t3.small", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.8xlarge", - "ml.m5.12xlarge", - "ml.m5.16xlarge", - "ml.m5.24xlarge", - "ml.c5.large", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.12xlarge", - "ml.c5.18xlarge", - "ml.c5.24xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.p3dn.24xlarge", - "ml.m5d.large", - "ml.m5d.xlarge", - "ml.m5d.2xlarge", - "ml.m5d.4xlarge", - "ml.m5d.8xlarge", - "ml.m5d.12xlarge", - "ml.m5d.16xlarge", - "ml.m5d.24xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.geospatial.interactive", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge" - ], - "type": "string" - }, - "LifecycleConfigArn": { - "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", - "maxLength": 256, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", - "type": "string" - }, - "SageMakerImageArn": { - "description": "The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.", - "maxLength": 256, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$", - "type": "string" - }, - "SageMakerImageVersionArn": { - "description": "The Amazon Resource Name (ARN) of the image version created on the instance.", - "maxLength": 256, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$", - "type": "string" - } - }, - "type": "object" - }, - "SharingSettings": { - "additionalProperties": false, - "description": "Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.", - "properties": { - "NotebookOutputOption": { - "description": "Whether to include the notebook cell output when sharing the notebook. The default is Disabled.", - "enum": [ - "Allowed", - "Disabled" - ], - "type": "string" - }, - "S3KmsKeyId": { - "description": "When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "S3OutputPath": { - "description": "When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "type": "object" - }, - "SpaceEbsVolumeSizeInGb": { - "maximum": 16384, - "minimum": 5, - "type": "integer" - }, - "StudioLifecycleConfigArn": { - "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", - "maxLength": 256, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", - "type": "string" - }, - "StudioWebPortalSettings": { - "additionalProperties": false, - "description": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.", - "properties": { - "HiddenAppTypes": { - "description": "Applications supported in Studio that are hidden from the Studio left navigation pane.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AppType" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "HiddenMlTools": { - "description": "The machine learning tools that are hidden from the Studio left navigation pane.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MlTools" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "UserSettings": { - "additionalProperties": false, - "description": "A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.", - "properties": { - "CodeEditorAppSettings": { - "$ref": "#/definitions/CodeEditorAppSettings" - }, - "CustomFileSystemConfigs": { - "items": { - "$ref": "#/definitions/CustomFileSystemConfig" - }, - "maxItems": 2, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "CustomPosixUserConfig": { - "$ref": "#/definitions/CustomPosixUserConfig" - }, - "DefaultLandingUri": { - "description": "Defines which Amazon SageMaker application users are directed to by default.", - "maxLength": 1023, - "type": "string" - }, - "ExecutionRole": { - "description": "The execution role for the user.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "JupyterLabAppSettings": { - "$ref": "#/definitions/JupyterLabAppSettings" - }, - "JupyterServerAppSettings": { - "$ref": "#/definitions/JupyterServerAppSettings", - "description": "The Jupyter server's app settings." - }, - "KernelGatewayAppSettings": { - "$ref": "#/definitions/KernelGatewayAppSettings", - "description": "The kernel gateway app settings." - }, - "RSessionAppSettings": { - "$ref": "#/definitions/RSessionAppSettings" - }, - "RStudioServerProAppSettings": { - "$ref": "#/definitions/RStudioServerProAppSettings" - }, - "SecurityGroups": { - "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", - "insertionOrder": false, - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "SharingSettings": { - "$ref": "#/definitions/SharingSettings", - "description": "The sharing settings." - }, - "SpaceStorageSettings": { - "$ref": "#/definitions/DefaultSpaceStorageSettings" - }, - "StudioWebPortal": { - "description": "Indicates whether the Studio experience is available to users. If not, users cannot access Studio.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "StudioWebPortalSettings": { - "$ref": "#/definitions/StudioWebPortalSettings" - } - }, - "required": [ - "ExecutionRole" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::Domain", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateApp", - "sagemaker:CreateDomain", - "sagemaker:DescribeDomain", - "sagemaker:DescribeImage", - "sagemaker:DescribeImageVersion", - "iam:CreateServiceLinkedRole", - "iam:PassRole", - "efs:CreateFileSystem", - "kms:CreateGrant", - "kms:Decrypt", - "kms:DescribeKey", - "kms:GenerateDataKeyWithoutPlainText" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteApp", - "sagemaker:DeleteDomain", - "sagemaker:DescribeDomain" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListDomains" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeDomain" - ] - }, - "update": { - "permissions": [ - "sagemaker:CreateApp", - "sagemaker:UpdateDomain", - "sagemaker:DescribeDomain", - "sagemaker:DescribeImage", - "sagemaker:DescribeImageVersion", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId" - ], - "properties": { - "AppNetworkAccessType": { - "description": "Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.", - "enum": [ - "PublicInternetOnly", - "VpcOnly" - ], - "type": "string" - }, - "AppSecurityGroupManagement": { - "description": "The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.", - "enum": [ - "Service", - "Customer" - ], - "type": "string" - }, - "AuthMode": { - "description": "The mode of authentication that members use to access the domain.", - "enum": [ - "SSO", - "IAM" - ], - "type": "string" - }, - "DefaultSpaceSettings": { - "$ref": "#/definitions/DefaultSpaceSettings", - "description": "The default space settings." - }, - "DefaultUserSettings": { - "$ref": "#/definitions/UserSettings", - "description": "The default user settings." - }, - "DomainArn": { - "description": "The Amazon Resource Name (ARN) of the created domain.", - "maxLength": 256, - "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*", - "type": "string" - }, - "DomainId": { - "description": "The domain name.", - "maxLength": 63, - "pattern": "^d-(-*[a-z0-9])+", - "type": "string" - }, - "DomainName": { - "description": "A name for the domain.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - }, - "DomainSettings": { - "$ref": "#/definitions/DomainSettings" - }, - "HomeEfsFileSystemId": { - "description": "The ID of the Amazon Elastic File System (EFS) managed by this Domain.", - "maxLength": 32, - "type": "string" - }, - "KmsKeyId": { - "description": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "SecurityGroupIdForDomainBoundary": { - "description": "The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.", - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "SingleSignOnApplicationArn": { - "description": "The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.", - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+$", - "type": "string" - }, - "SingleSignOnManagedApplicationInstanceId": { - "description": "The SSO managed application instance ID.", - "maxLength": 256, - "type": "string" - }, - "SubnetIds": { - "description": "The VPC subnets that Studio uses for communication.", - "insertionOrder": false, - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "A list of tags to apply to the user profile.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "Url": { - "description": "The URL to the created domain.", - "maxLength": 1024, - "type": "string" - }, - "VpcId": { - "description": "The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DomainArn", - "/properties/Url", - "/properties/DomainId", - "/properties/HomeEfsFileSystemId", - "/properties/SecurityGroupIdForDomainBoundary", - "/properties/SingleSignOnManagedApplicationInstanceId", - "/properties/SingleSignOnApplicationArn" - ], - "required": [ - "AuthMode", - "DefaultUserSettings", - "DomainName", - "SubnetIds", - "VpcId" - ], - "typeName": "AWS::SageMaker::Domain", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AuthMode", + "/properties/DomainName", + "/properties/DomainSettings/RStudioServerProDomainSettings/DefaultResourceSpec", + "/properties/KmsKeyId", + "/properties/VpcId", + "/properties/Tags" + ], + "definitions": { + "AppLifecycleManagement": { + "additionalProperties": false, + "properties": { + "IdleSettings": { + "$ref": "#/definitions/IdleSettings" + } + }, + "type": "object" + }, + "AppType": { + "enum": [ + "JupyterServer", + "TensorBoard", + "RStudioServerPro", + "JupyterLab", + "CodeEditor", + "DetailedProfiler", + "Canvas" + ], + "type": "string" + }, + "CodeEditorAppSettings": { + "additionalProperties": false, + "description": "The CodeEditor app settings.", + "properties": { + "AppLifecycleManagement": { + "$ref": "#/definitions/AppLifecycleManagement" + }, + "CustomImages": { + "description": "A list of custom images for use for CodeEditor apps.", + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec", + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." + }, + "LifecycleConfigArns": { + "description": "A list of LifecycleConfigArns available for use with CodeEditor apps.", + "items": { + "$ref": "#/definitions/StudioLifecycleConfigArn" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CodeRepository": { + "additionalProperties": false, + "properties": { + "RepositoryUrl": { + "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension.", + "maxLength": 256, + "pattern": "^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$", + "type": "string" + } + }, + "required": [ + "RepositoryUrl" + ], + "type": "object" + }, + "CustomFileSystemConfig": { + "additionalProperties": false, + "properties": { + "EFSFileSystemConfig": { + "$ref": "#/definitions/EFSFileSystemConfig" + } + }, + "type": "object" + }, + "CustomImage": { + "additionalProperties": false, + "description": "A custom SageMaker image.", + "properties": { + "AppImageConfigName": { + "description": "The Name of the AppImageConfig.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + }, + "ImageName": { + "description": "The name of the CustomImage. Must be unique to your account.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "ImageVersionNumber": { + "description": "The version number of the CustomImage.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "AppImageConfigName", + "ImageName" + ], + "type": "object" + }, + "CustomPosixUserConfig": { + "additionalProperties": false, + "properties": { + "Gid": { + "maximum": 4000000, + "minimum": 1001, + "type": "integer" + }, + "Uid": { + "maximum": 4000000, + "minimum": 10000, + "type": "integer" + } + }, + "required": [ + "Uid", + "Gid" + ], + "type": "object" + }, + "DefaultEbsStorageSettings": { + "additionalProperties": false, + "description": "Properties related to the Amazon Elastic Block Store volume. Must be provided if storage type is Amazon EBS and must not be provided if storage type is not Amazon EBS", + "properties": { + "DefaultEbsVolumeSizeInGb": { + "$ref": "#/definitions/SpaceEbsVolumeSizeInGb", + "description": "Default size of the Amazon EBS volume in Gb" + }, + "MaximumEbsVolumeSizeInGb": { + "$ref": "#/definitions/SpaceEbsVolumeSizeInGb", + "description": "Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb." + } + }, + "required": [ + "DefaultEbsVolumeSizeInGb", + "MaximumEbsVolumeSizeInGb" + ], + "type": "object" + }, + "DefaultSpaceSettings": { + "additionalProperties": false, + "description": "A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.", + "properties": { + "CustomFileSystemConfigs": { + "items": { + "$ref": "#/definitions/CustomFileSystemConfig" + }, + "maxItems": 2, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "CustomPosixUserConfig": { + "$ref": "#/definitions/CustomPosixUserConfig", + "description": "The Jupyter lab's custom posix user configurations." + }, + "ExecutionRole": { + "description": "The execution role for the space.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "JupyterLabAppSettings": { + "$ref": "#/definitions/JupyterLabAppSettings", + "description": "The Jupyter lab's app settings." + }, + "JupyterServerAppSettings": { + "$ref": "#/definitions/JupyterServerAppSettings", + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "$ref": "#/definitions/KernelGatewayAppSettings", + "description": "The kernel gateway app settings." + }, + "SecurityGroups": { + "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "SpaceStorageSettings": { + "$ref": "#/definitions/DefaultSpaceStorageSettings", + "description": "The Jupyter lab's space storage settings." + } + }, + "required": [ + "ExecutionRole" + ], + "type": "object" + }, + "DefaultSpaceStorageSettings": { + "additionalProperties": false, + "description": "Default storage settings for a space.", + "properties": { + "DefaultEbsStorageSettings": { + "$ref": "#/definitions/DefaultEbsStorageSettings" + } + }, + "type": "object" + }, + "DockerSettings": { + "additionalProperties": false, + "description": "A collection of settings that are required to start docker-proxy server.", + "properties": { + "EnableDockerAccess": { + "description": "The flag to enable/disable docker-proxy server", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "VpcOnlyTrustedAccounts": { + "description": "A list of account id's that would be used to pull images from in VpcOnly mode", + "insertionOrder": false, + "items": { + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d+$", + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DomainSettings": { + "additionalProperties": false, + "description": "A collection of Domain settings.", + "properties": { + "DockerSettings": { + "$ref": "#/definitions/DockerSettings" + }, + "RStudioServerProDomainSettings": { + "$ref": "#/definitions/RStudioServerProDomainSettings" + }, + "SecurityGroupIds": { + "description": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "EFSFileSystemConfig": { + "additionalProperties": false, + "properties": { + "FileSystemId": { + "maxLength": 21, + "minLength": 11, + "pattern": "^(fs-[0-9a-f]{8,})$", + "type": "string" + }, + "FileSystemPath": { + "maxLength": 256, + "minLength": 1, + "pattern": "^\\/\\S*$", + "type": "string" + } + }, + "required": [ + "FileSystemId" + ], + "type": "object" + }, + "IdleSettings": { + "additionalProperties": false, + "properties": { + "IdleTimeoutInMinutes": { + "$ref": "#/definitions/IdleTimeoutInMinutes" + }, + "LifecycleManagement": { + "$ref": "#/definitions/LifecycleManagement" + }, + "MaxIdleTimeoutInMinutes": { + "$ref": "#/definitions/MaxIdleTimeoutInMinutes" + }, + "MinIdleTimeoutInMinutes": { + "$ref": "#/definitions/MinIdleTimeoutInMinutes" + } + }, + "type": "object" + }, + "IdleTimeoutInMinutes": { + "description": "The idle timeout value set in minutes", + "maximum": 525600, + "minimum": 60, + "type": "integer" + }, + "JupyterLabAppSettings": { + "additionalProperties": false, + "description": "The JupyterLab app settings.", + "properties": { + "AppLifecycleManagement": { + "$ref": "#/definitions/AppLifecycleManagement" + }, + "CodeRepositories": { + "description": "A list of CodeRepositories available for use with JupyterLab apps.", + "items": { + "$ref": "#/definitions/CodeRepository" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "CustomImages": { + "description": "A list of custom images for use for JupyterLab apps.", + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec", + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app." + }, + "LifecycleConfigArns": { + "description": "A list of LifecycleConfigArns available for use with JupyterLab apps.", + "items": { + "$ref": "#/definitions/StudioLifecycleConfigArn" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "JupyterServerAppSettings": { + "additionalProperties": false, + "description": "The JupyterServer app settings.", + "properties": { + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec" + }, + "LifecycleConfigArns": { + "description": "A list of LifecycleConfigArns available for use with JupyterServer apps.", + "items": { + "$ref": "#/definitions/StudioLifecycleConfigArn" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "KernelGatewayAppSettings": { + "additionalProperties": false, + "description": "The kernel gateway app settings.", + "properties": { + "CustomImages": { + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec", + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app." + }, + "LifecycleConfigArns": { + "description": "A list of LifecycleConfigArns available for use with KernelGateway apps.", + "items": { + "$ref": "#/definitions/StudioLifecycleConfigArn" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "LifecycleManagement": { + "description": "A flag to enable/disable AppLifecycleManagement settings", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "MaxIdleTimeoutInMinutes": { + "description": "The maximum idle timeout value set in minutes", + "maximum": 525600, + "minimum": 60, + "type": "integer" + }, + "MinIdleTimeoutInMinutes": { + "description": "The minimum idle timeout value set in minutes", + "maximum": 525600, + "minimum": 60, + "type": "integer" + }, + "MlTools": { + "enum": [ + "DataWrangler", + "FeatureStore", + "EmrClusters", + "AutoMl", + "Experiments", + "Training", + "ModelEvaluation", + "Pipelines", + "Models", + "JumpStart", + "InferenceRecommender", + "Endpoints", + "Projects", + "InferenceOptimization" + ], + "type": "string" + }, + "RSessionAppSettings": { + "additionalProperties": false, + "description": "A collection of settings that apply to an RSessionGateway app.", + "properties": { + "CustomImages": { + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec" + } + }, + "type": "object" + }, + "RStudioServerProAppSettings": { + "additionalProperties": false, + "description": "A collection of settings that configure user interaction with the RStudioServerPro app.", + "properties": { + "AccessStatus": { + "description": "Indicates whether the current user has access to the RStudioServerPro app.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "UserGroup": { + "description": "The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.", + "enum": [ + "R_STUDIO_ADMIN", + "R_STUDIO_USER" + ], + "type": "string" + } + }, + "type": "object" + }, + "RStudioServerProDomainSettings": { + "additionalProperties": false, + "description": "A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.", + "properties": { + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec" + }, + "DomainExecutionRoleArn": { + "description": "The ARN of the execution role for the RStudioServerPro Domain-level app.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "RStudioConnectUrl": { + "description": "A URL pointing to an RStudio Connect server.", + "pattern": "^(https:|http:|www\\.)\\S*", + "type": "string" + }, + "RStudioPackageManagerUrl": { + "description": "A URL pointing to an RStudio Package Manager server.", + "pattern": "^(https:|http:|www\\.)\\S*", + "type": "string" + } + }, + "required": [ + "DomainExecutionRoleArn" + ], + "type": "object" + }, + "ResourceSpec": { + "additionalProperties": false, + "properties": { + "InstanceType": { + "description": "The instance type that the image version runs on.", + "enum": [ + "system", + "ml.t3.micro", + "ml.t3.small", + "ml.t3.medium", + "ml.t3.large", + "ml.t3.xlarge", + "ml.t3.2xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.8xlarge", + "ml.m5.12xlarge", + "ml.m5.16xlarge", + "ml.m5.24xlarge", + "ml.c5.large", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.12xlarge", + "ml.c5.18xlarge", + "ml.c5.24xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge", + "ml.g4dn.xlarge", + "ml.g4dn.2xlarge", + "ml.g4dn.4xlarge", + "ml.g4dn.8xlarge", + "ml.g4dn.12xlarge", + "ml.g4dn.16xlarge", + "ml.r5.large", + "ml.r5.xlarge", + "ml.r5.2xlarge", + "ml.r5.4xlarge", + "ml.r5.8xlarge", + "ml.r5.12xlarge", + "ml.r5.16xlarge", + "ml.r5.24xlarge", + "ml.p3dn.24xlarge", + "ml.m5d.large", + "ml.m5d.xlarge", + "ml.m5d.2xlarge", + "ml.m5d.4xlarge", + "ml.m5d.8xlarge", + "ml.m5d.12xlarge", + "ml.m5d.16xlarge", + "ml.m5d.24xlarge", + "ml.g5.xlarge", + "ml.g5.2xlarge", + "ml.g5.4xlarge", + "ml.g5.8xlarge", + "ml.g5.12xlarge", + "ml.g5.16xlarge", + "ml.g5.24xlarge", + "ml.g5.48xlarge", + "ml.p4d.24xlarge", + "ml.p4de.24xlarge", + "ml.geospatial.interactive", + "ml.trn1.2xlarge", + "ml.trn1.32xlarge", + "ml.trn1n.32xlarge" + ], + "type": "string" + }, + "LifecycleConfigArn": { + "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", + "maxLength": 256, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", + "type": "string" + }, + "SageMakerImageArn": { + "description": "The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.", + "maxLength": 256, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$", + "type": "string" + }, + "SageMakerImageVersionArn": { + "description": "The Amazon Resource Name (ARN) of the image version created on the instance.", + "maxLength": 256, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$", + "type": "string" + } + }, + "type": "object" + }, + "SharingSettings": { + "additionalProperties": false, + "description": "Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.", + "properties": { + "NotebookOutputOption": { + "description": "Whether to include the notebook cell output when sharing the notebook. The default is Disabled.", + "enum": [ + "Allowed", + "Disabled" + ], + "type": "string" + }, + "S3KmsKeyId": { + "description": "When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "S3OutputPath": { + "description": "When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.", + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "type": "object" + }, + "SpaceEbsVolumeSizeInGb": { + "maximum": 16384, + "minimum": 5, + "type": "integer" + }, + "StudioLifecycleConfigArn": { + "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.", + "maxLength": 256, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*", + "type": "string" + }, + "StudioWebPortalSettings": { + "additionalProperties": false, + "description": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.", + "properties": { + "HiddenAppTypes": { + "description": "Applications supported in Studio that are hidden from the Studio left navigation pane.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AppType" + }, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "HiddenMlTools": { + "description": "The machine learning tools that are hidden from the Studio left navigation pane.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MlTools" + }, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserSettings": { + "additionalProperties": false, + "description": "A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.", + "properties": { + "CodeEditorAppSettings": { + "$ref": "#/definitions/CodeEditorAppSettings" + }, + "CustomFileSystemConfigs": { + "items": { + "$ref": "#/definitions/CustomFileSystemConfig" + }, + "maxItems": 2, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "CustomPosixUserConfig": { + "$ref": "#/definitions/CustomPosixUserConfig" + }, + "DefaultLandingUri": { + "description": "Defines which Amazon SageMaker application users are directed to by default.", + "maxLength": 1023, + "type": "string" + }, + "ExecutionRole": { + "description": "The execution role for the user.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "JupyterLabAppSettings": { + "$ref": "#/definitions/JupyterLabAppSettings" + }, + "JupyterServerAppSettings": { + "$ref": "#/definitions/JupyterServerAppSettings", + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "$ref": "#/definitions/KernelGatewayAppSettings", + "description": "The kernel gateway app settings." + }, + "RSessionAppSettings": { + "$ref": "#/definitions/RSessionAppSettings" + }, + "RStudioServerProAppSettings": { + "$ref": "#/definitions/RStudioServerProAppSettings" + }, + "SecurityGroups": { + "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "SharingSettings": { + "$ref": "#/definitions/SharingSettings", + "description": "The sharing settings." + }, + "SpaceStorageSettings": { + "$ref": "#/definitions/DefaultSpaceStorageSettings" + }, + "StudioWebPortal": { + "description": "Indicates whether the Studio experience is available to users. If not, users cannot access Studio.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "StudioWebPortalSettings": { + "$ref": "#/definitions/StudioWebPortalSettings" + } + }, + "required": [ + "ExecutionRole" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::Domain", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateApp", + "sagemaker:CreateDomain", + "sagemaker:DescribeDomain", + "sagemaker:DescribeImage", + "sagemaker:DescribeImageVersion", + "iam:CreateServiceLinkedRole", + "iam:PassRole", + "efs:CreateFileSystem", + "kms:CreateGrant", + "kms:Decrypt", + "kms:DescribeKey", + "kms:GenerateDataKeyWithoutPlainText" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteApp", + "sagemaker:DeleteDomain", + "sagemaker:DescribeDomain" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListDomains" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeDomain" + ] + }, + "update": { + "permissions": [ + "sagemaker:CreateApp", + "sagemaker:UpdateDomain", + "sagemaker:DescribeDomain", + "sagemaker:DescribeImage", + "sagemaker:DescribeImageVersion", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId" + ], + "properties": { + "AppNetworkAccessType": { + "description": "Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.", + "enum": [ + "PublicInternetOnly", + "VpcOnly" + ], + "type": "string" + }, + "AppSecurityGroupManagement": { + "description": "The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.", + "enum": [ + "Service", + "Customer" + ], + "type": "string" + }, + "AuthMode": { + "description": "The mode of authentication that members use to access the domain.", + "enum": [ + "SSO", + "IAM" + ], + "type": "string" + }, + "DefaultSpaceSettings": { + "$ref": "#/definitions/DefaultSpaceSettings", + "description": "The default space settings." + }, + "DefaultUserSettings": { + "$ref": "#/definitions/UserSettings", + "description": "The default user settings." + }, + "DomainArn": { + "description": "The Amazon Resource Name (ARN) of the created domain.", + "maxLength": 256, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*", + "type": "string" + }, + "DomainId": { + "description": "The domain name.", + "maxLength": 63, + "pattern": "^d-(-*[a-z0-9])+", + "type": "string" + }, + "DomainName": { + "description": "A name for the domain.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + }, + "DomainSettings": { + "$ref": "#/definitions/DomainSettings" + }, + "HomeEfsFileSystemId": { + "description": "The ID of the Amazon Elastic File System (EFS) managed by this Domain.", + "maxLength": 32, + "type": "string" + }, + "KmsKeyId": { + "description": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "SecurityGroupIdForDomainBoundary": { + "description": "The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.", + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "SingleSignOnApplicationArn": { + "description": "The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+$", + "type": "string" + }, + "SingleSignOnManagedApplicationInstanceId": { + "description": "The SSO managed application instance ID.", + "maxLength": 256, + "type": "string" + }, + "SubnetIds": { + "description": "The VPC subnets that Studio uses for communication.", + "insertionOrder": false, + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "A list of tags to apply to the user profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "Url": { + "description": "The URL to the created domain.", + "maxLength": 1024, + "type": "string" + }, + "VpcId": { + "description": "The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.", + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DomainArn", + "/properties/Url", + "/properties/DomainId", + "/properties/HomeEfsFileSystemId", + "/properties/SecurityGroupIdForDomainBoundary", + "/properties/SingleSignOnManagedApplicationInstanceId", + "/properties/SingleSignOnApplicationArn" + ], + "required": [ + "AuthMode", + "DefaultUserSettings", + "DomainName", + "SubnetIds", + "VpcId" + ], + "typeName": "AWS::SageMaker::Domain", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-sagemaker-endpoint.json b/schema/aws-sagemaker-endpoint.json index 9a00ce7..99c9aec 100644 --- a/schema/aws-sagemaker-endpoint.json +++ b/schema/aws-sagemaker-endpoint.json @@ -1,198 +1,198 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EndpointName" - ], - "definitions": { - "Alarm": { - "additionalProperties": false, - "properties": { - "AlarmName": { - "type": "string" - } - }, - "required": [ - "AlarmName" - ], - "type": "object" - }, - "AutoRollbackConfig": { - "additionalProperties": false, - "properties": { - "Alarms": { - "items": { - "$ref": "#/definitions/Alarm" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Alarms" - ], - "type": "object" - }, - "BlueGreenUpdatePolicy": { - "additionalProperties": false, - "properties": { - "MaximumExecutionTimeoutInSeconds": { - "type": "integer" - }, - "TerminationWaitInSeconds": { - "type": "integer" - }, - "TrafficRoutingConfiguration": { - "$ref": "#/definitions/TrafficRoutingConfig" - } - }, - "required": [ - "TrafficRoutingConfiguration" - ], - "type": "object" - }, - "CapacitySize": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "DeploymentConfig": { - "additionalProperties": false, - "properties": { - "AutoRollbackConfiguration": { - "$ref": "#/definitions/AutoRollbackConfig" - }, - "BlueGreenUpdatePolicy": { - "$ref": "#/definitions/BlueGreenUpdatePolicy" - }, - "RollingUpdatePolicy": { - "$ref": "#/definitions/RollingUpdatePolicy" - } - }, - "type": "object" - }, - "RollingUpdatePolicy": { - "additionalProperties": false, - "properties": { - "MaximumBatchSize": { - "$ref": "#/definitions/CapacitySize" - }, - "MaximumExecutionTimeoutInSeconds": { - "type": "integer" - }, - "RollbackMaximumBatchSize": { - "$ref": "#/definitions/CapacitySize" - }, - "WaitIntervalInSeconds": { - "type": "integer" - } - }, - "required": [ - "MaximumBatchSize", - "WaitIntervalInSeconds" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "TrafficRoutingConfig": { - "additionalProperties": false, - "properties": { - "CanarySize": { - "$ref": "#/definitions/CapacitySize" - }, - "LinearStepSize": { - "$ref": "#/definitions/CapacitySize" - }, - "Type": { - "type": "string" - }, - "WaitIntervalInSeconds": { - "type": "integer" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "VariantProperty": { - "additionalProperties": false, - "properties": { - "VariantPropertyType": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::Endpoint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeploymentConfig": { - "$ref": "#/definitions/DeploymentConfig" - }, - "EndpointConfigName": { - "type": "string" - }, - "EndpointName": { - "type": "string" - }, - "ExcludeRetainedVariantProperties": { - "items": { - "$ref": "#/definitions/VariantProperty" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "RetainAllVariantProperties": { - "type": "boolean" - }, - "RetainDeploymentConfig": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "EndpointConfigName" - ], - "typeName": "AWS::SageMaker::Endpoint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EndpointName" + ], + "definitions": { + "Alarm": { + "additionalProperties": false, + "properties": { + "AlarmName": { + "type": "string" + } + }, + "required": [ + "AlarmName" + ], + "type": "object" + }, + "AutoRollbackConfig": { + "additionalProperties": false, + "properties": { + "Alarms": { + "items": { + "$ref": "#/definitions/Alarm" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Alarms" + ], + "type": "object" + }, + "BlueGreenUpdatePolicy": { + "additionalProperties": false, + "properties": { + "MaximumExecutionTimeoutInSeconds": { + "type": "integer" + }, + "TerminationWaitInSeconds": { + "type": "integer" + }, + "TrafficRoutingConfiguration": { + "$ref": "#/definitions/TrafficRoutingConfig" + } + }, + "required": [ + "TrafficRoutingConfiguration" + ], + "type": "object" + }, + "CapacitySize": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "required": [ + "Type", + "Value" + ], + "type": "object" + }, + "DeploymentConfig": { + "additionalProperties": false, + "properties": { + "AutoRollbackConfiguration": { + "$ref": "#/definitions/AutoRollbackConfig" + }, + "BlueGreenUpdatePolicy": { + "$ref": "#/definitions/BlueGreenUpdatePolicy" + }, + "RollingUpdatePolicy": { + "$ref": "#/definitions/RollingUpdatePolicy" + } + }, + "type": "object" + }, + "RollingUpdatePolicy": { + "additionalProperties": false, + "properties": { + "MaximumBatchSize": { + "$ref": "#/definitions/CapacitySize" + }, + "MaximumExecutionTimeoutInSeconds": { + "type": "integer" + }, + "RollbackMaximumBatchSize": { + "$ref": "#/definitions/CapacitySize" + }, + "WaitIntervalInSeconds": { + "type": "integer" + } + }, + "required": [ + "MaximumBatchSize", + "WaitIntervalInSeconds" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TrafficRoutingConfig": { + "additionalProperties": false, + "properties": { + "CanarySize": { + "$ref": "#/definitions/CapacitySize" + }, + "LinearStepSize": { + "$ref": "#/definitions/CapacitySize" + }, + "Type": { + "type": "string" + }, + "WaitIntervalInSeconds": { + "type": "integer" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "VariantProperty": { + "additionalProperties": false, + "properties": { + "VariantPropertyType": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::Endpoint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DeploymentConfig": { + "$ref": "#/definitions/DeploymentConfig" + }, + "EndpointConfigName": { + "type": "string" + }, + "EndpointName": { + "type": "string" + }, + "ExcludeRetainedVariantProperties": { + "items": { + "$ref": "#/definitions/VariantProperty" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "RetainAllVariantProperties": { + "type": "boolean" + }, + "RetainDeploymentConfig": { + "type": "boolean" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "EndpointConfigName" + ], + "typeName": "AWS::SageMaker::Endpoint" +} diff --git a/schema/aws-sagemaker-endpointconfig.json b/schema/aws-sagemaker-endpointconfig.json index b43cce3..98baa5a 100644 --- a/schema/aws-sagemaker-endpointconfig.json +++ b/schema/aws-sagemaker-endpointconfig.json @@ -1,476 +1,476 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyId", - "/properties/AsyncInferenceConfig", - "/properties/ExecutionRoleArn", - "/properties/ShadowProductionVariants", - "/properties/EnableNetworkIsolation", - "/properties/ProductionVariants", - "/properties/DataCaptureConfig", - "/properties/ExplainerConfig", - "/properties/EndpointConfigName", - "/properties/VpcConfig" - ], - "definitions": { - "AsyncInferenceClientConfig": { - "additionalProperties": false, - "properties": { - "MaxConcurrentInvocationsPerInstance": { - "type": "integer" - } - }, - "type": "object" - }, - "AsyncInferenceConfig": { - "additionalProperties": false, - "properties": { - "ClientConfig": { - "$ref": "#/definitions/AsyncInferenceClientConfig" - }, - "OutputConfig": { - "$ref": "#/definitions/AsyncInferenceOutputConfig" - } - }, - "required": [ - "OutputConfig" - ], - "type": "object" - }, - "AsyncInferenceNotificationConfig": { - "additionalProperties": false, - "properties": { - "ErrorTopic": { - "type": "string" - }, - "IncludeInferenceResponseIn": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SuccessTopic": { - "type": "string" - } - }, - "type": "object" - }, - "AsyncInferenceOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "NotificationConfig": { - "$ref": "#/definitions/AsyncInferenceNotificationConfig" - }, - "S3FailurePath": { - "type": "string" - }, - "S3OutputPath": { - "type": "string" - } - }, - "type": "object" - }, - "CaptureContentTypeHeader": { - "additionalProperties": false, - "properties": { - "CsvContentTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "JsonContentTypes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "CaptureOption": { - "additionalProperties": false, - "properties": { - "CaptureMode": { - "type": "string" - } - }, - "required": [ - "CaptureMode" - ], - "type": "object" - }, - "ClarifyExplainerConfig": { - "additionalProperties": false, - "properties": { - "EnableExplanations": { - "type": "string" - }, - "InferenceConfig": { - "$ref": "#/definitions/ClarifyInferenceConfig" - }, - "ShapConfig": { - "$ref": "#/definitions/ClarifyShapConfig" - } - }, - "required": [ - "ShapConfig" - ], - "type": "object" - }, - "ClarifyFeatureType": { - "additionalProperties": false, - "type": "object" - }, - "ClarifyHeader": { - "additionalProperties": false, - "type": "object" - }, - "ClarifyInferenceConfig": { - "additionalProperties": false, - "properties": { - "ContentTemplate": { - "type": "string" - }, - "FeatureHeaders": { - "items": { - "$ref": "#/definitions/ClarifyHeader" - }, - "type": "array", - "uniqueItems": false - }, - "FeatureTypes": { - "items": { - "$ref": "#/definitions/ClarifyFeatureType" - }, - "type": "array", - "uniqueItems": false - }, - "FeaturesAttribute": { - "type": "string" - }, - "LabelAttribute": { - "type": "string" - }, - "LabelHeaders": { - "items": { - "$ref": "#/definitions/ClarifyHeader" - }, - "type": "array", - "uniqueItems": false - }, - "LabelIndex": { - "type": "integer" - }, - "MaxPayloadInMB": { - "type": "integer" - }, - "MaxRecordCount": { - "type": "integer" - }, - "ProbabilityAttribute": { - "type": "string" - }, - "ProbabilityIndex": { - "type": "integer" - } - }, - "type": "object" - }, - "ClarifyShapBaselineConfig": { - "additionalProperties": false, - "properties": { - "MimeType": { - "type": "string" - }, - "ShapBaseline": { - "type": "string" - }, - "ShapBaselineUri": { - "type": "string" - } - }, - "type": "object" - }, - "ClarifyShapConfig": { - "additionalProperties": false, - "properties": { - "NumberOfSamples": { - "type": "integer" - }, - "Seed": { - "type": "integer" - }, - "ShapBaselineConfig": { - "$ref": "#/definitions/ClarifyShapBaselineConfig" - }, - "TextConfig": { - "$ref": "#/definitions/ClarifyTextConfig" - }, - "UseLogit": { - "type": "boolean" - } - }, - "required": [ - "ShapBaselineConfig" - ], - "type": "object" - }, - "ClarifyTextConfig": { - "additionalProperties": false, - "properties": { - "Granularity": { - "type": "string" - }, - "Language": { - "type": "string" - } - }, - "required": [ - "Language", - "Granularity" - ], - "type": "object" - }, - "DataCaptureConfig": { - "additionalProperties": false, - "properties": { - "CaptureContentTypeHeader": { - "$ref": "#/definitions/CaptureContentTypeHeader" - }, - "CaptureOptions": { - "items": { - "$ref": "#/definitions/CaptureOption" - }, - "type": "array", - "uniqueItems": false - }, - "DestinationS3Uri": { - "type": "string" - }, - "EnableCapture": { - "type": "boolean" - }, - "InitialSamplingPercentage": { - "type": "integer" - }, - "KmsKeyId": { - "type": "string" - } - }, - "required": [ - "CaptureOptions", - "DestinationS3Uri", - "InitialSamplingPercentage" - ], - "type": "object" - }, - "ExplainerConfig": { - "additionalProperties": false, - "properties": { - "ClarifyExplainerConfig": { - "$ref": "#/definitions/ClarifyExplainerConfig" - } - }, - "type": "object" - }, - "ManagedInstanceScaling": { - "additionalProperties": false, - "properties": { - "MaxInstanceCount": { - "type": "integer" - }, - "MinInstanceCount": { - "type": "integer" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "ProductionVariant": { - "additionalProperties": false, - "properties": { - "AcceleratorType": { - "type": "string" - }, - "ContainerStartupHealthCheckTimeoutInSeconds": { - "type": "integer" - }, - "EnableSSMAccess": { - "type": "boolean" - }, - "InitialInstanceCount": { - "type": "integer" - }, - "InitialVariantWeight": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "ManagedInstanceScaling": { - "$ref": "#/definitions/ManagedInstanceScaling" - }, - "ModelDataDownloadTimeoutInSeconds": { - "type": "integer" - }, - "ModelName": { - "type": "string" - }, - "RoutingConfig": { - "$ref": "#/definitions/RoutingConfig" - }, - "ServerlessConfig": { - "$ref": "#/definitions/ServerlessConfig" - }, - "VariantName": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "integer" - } - }, - "required": [ - "VariantName" - ], - "type": "object" - }, - "RoutingConfig": { - "additionalProperties": false, - "properties": { - "RoutingStrategy": { - "type": "string" - } - }, - "type": "object" - }, - "ServerlessConfig": { - "additionalProperties": false, - "properties": { - "MaxConcurrency": { - "type": "integer" - }, - "MemorySizeInMB": { - "type": "integer" - }, - "ProvisionedConcurrency": { - "type": "integer" - } - }, - "required": [ - "MaxConcurrency", - "MemorySizeInMB" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Subnets", - "SecurityGroupIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::EndpointConfig", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AsyncInferenceConfig": { - "$ref": "#/definitions/AsyncInferenceConfig" - }, - "DataCaptureConfig": { - "$ref": "#/definitions/DataCaptureConfig" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "EndpointConfigName": { - "type": "string" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "ExplainerConfig": { - "$ref": "#/definitions/ExplainerConfig" - }, - "Id": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "ProductionVariants": { - "items": { - "$ref": "#/definitions/ProductionVariant" - }, - "type": "array", - "uniqueItems": false - }, - "ShadowProductionVariants": { - "items": { - "$ref": "#/definitions/ProductionVariant" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ProductionVariants" - ], - "typeName": "AWS::SageMaker::EndpointConfig" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyId", + "/properties/AsyncInferenceConfig", + "/properties/ExecutionRoleArn", + "/properties/ShadowProductionVariants", + "/properties/EnableNetworkIsolation", + "/properties/ProductionVariants", + "/properties/DataCaptureConfig", + "/properties/ExplainerConfig", + "/properties/EndpointConfigName", + "/properties/VpcConfig" + ], + "definitions": { + "AsyncInferenceClientConfig": { + "additionalProperties": false, + "properties": { + "MaxConcurrentInvocationsPerInstance": { + "type": "integer" + } + }, + "type": "object" + }, + "AsyncInferenceConfig": { + "additionalProperties": false, + "properties": { + "ClientConfig": { + "$ref": "#/definitions/AsyncInferenceClientConfig" + }, + "OutputConfig": { + "$ref": "#/definitions/AsyncInferenceOutputConfig" + } + }, + "required": [ + "OutputConfig" + ], + "type": "object" + }, + "AsyncInferenceNotificationConfig": { + "additionalProperties": false, + "properties": { + "ErrorTopic": { + "type": "string" + }, + "IncludeInferenceResponseIn": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SuccessTopic": { + "type": "string" + } + }, + "type": "object" + }, + "AsyncInferenceOutputConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "type": "string" + }, + "NotificationConfig": { + "$ref": "#/definitions/AsyncInferenceNotificationConfig" + }, + "S3FailurePath": { + "type": "string" + }, + "S3OutputPath": { + "type": "string" + } + }, + "type": "object" + }, + "CaptureContentTypeHeader": { + "additionalProperties": false, + "properties": { + "CsvContentTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "JsonContentTypes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CaptureOption": { + "additionalProperties": false, + "properties": { + "CaptureMode": { + "type": "string" + } + }, + "required": [ + "CaptureMode" + ], + "type": "object" + }, + "ClarifyExplainerConfig": { + "additionalProperties": false, + "properties": { + "EnableExplanations": { + "type": "string" + }, + "InferenceConfig": { + "$ref": "#/definitions/ClarifyInferenceConfig" + }, + "ShapConfig": { + "$ref": "#/definitions/ClarifyShapConfig" + } + }, + "required": [ + "ShapConfig" + ], + "type": "object" + }, + "ClarifyFeatureType": { + "additionalProperties": false, + "type": "object" + }, + "ClarifyHeader": { + "additionalProperties": false, + "type": "object" + }, + "ClarifyInferenceConfig": { + "additionalProperties": false, + "properties": { + "ContentTemplate": { + "type": "string" + }, + "FeatureHeaders": { + "items": { + "$ref": "#/definitions/ClarifyHeader" + }, + "type": "array", + "uniqueItems": false + }, + "FeatureTypes": { + "items": { + "$ref": "#/definitions/ClarifyFeatureType" + }, + "type": "array", + "uniqueItems": false + }, + "FeaturesAttribute": { + "type": "string" + }, + "LabelAttribute": { + "type": "string" + }, + "LabelHeaders": { + "items": { + "$ref": "#/definitions/ClarifyHeader" + }, + "type": "array", + "uniqueItems": false + }, + "LabelIndex": { + "type": "integer" + }, + "MaxPayloadInMB": { + "type": "integer" + }, + "MaxRecordCount": { + "type": "integer" + }, + "ProbabilityAttribute": { + "type": "string" + }, + "ProbabilityIndex": { + "type": "integer" + } + }, + "type": "object" + }, + "ClarifyShapBaselineConfig": { + "additionalProperties": false, + "properties": { + "MimeType": { + "type": "string" + }, + "ShapBaseline": { + "type": "string" + }, + "ShapBaselineUri": { + "type": "string" + } + }, + "type": "object" + }, + "ClarifyShapConfig": { + "additionalProperties": false, + "properties": { + "NumberOfSamples": { + "type": "integer" + }, + "Seed": { + "type": "integer" + }, + "ShapBaselineConfig": { + "$ref": "#/definitions/ClarifyShapBaselineConfig" + }, + "TextConfig": { + "$ref": "#/definitions/ClarifyTextConfig" + }, + "UseLogit": { + "type": "boolean" + } + }, + "required": [ + "ShapBaselineConfig" + ], + "type": "object" + }, + "ClarifyTextConfig": { + "additionalProperties": false, + "properties": { + "Granularity": { + "type": "string" + }, + "Language": { + "type": "string" + } + }, + "required": [ + "Language", + "Granularity" + ], + "type": "object" + }, + "DataCaptureConfig": { + "additionalProperties": false, + "properties": { + "CaptureContentTypeHeader": { + "$ref": "#/definitions/CaptureContentTypeHeader" + }, + "CaptureOptions": { + "items": { + "$ref": "#/definitions/CaptureOption" + }, + "type": "array", + "uniqueItems": false + }, + "DestinationS3Uri": { + "type": "string" + }, + "EnableCapture": { + "type": "boolean" + }, + "InitialSamplingPercentage": { + "type": "integer" + }, + "KmsKeyId": { + "type": "string" + } + }, + "required": [ + "CaptureOptions", + "DestinationS3Uri", + "InitialSamplingPercentage" + ], + "type": "object" + }, + "ExplainerConfig": { + "additionalProperties": false, + "properties": { + "ClarifyExplainerConfig": { + "$ref": "#/definitions/ClarifyExplainerConfig" + } + }, + "type": "object" + }, + "ManagedInstanceScaling": { + "additionalProperties": false, + "properties": { + "MaxInstanceCount": { + "type": "integer" + }, + "MinInstanceCount": { + "type": "integer" + }, + "Status": { + "type": "string" + } + }, + "type": "object" + }, + "ProductionVariant": { + "additionalProperties": false, + "properties": { + "AcceleratorType": { + "type": "string" + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "type": "integer" + }, + "EnableSSMAccess": { + "type": "boolean" + }, + "InitialInstanceCount": { + "type": "integer" + }, + "InitialVariantWeight": { + "type": "number" + }, + "InstanceType": { + "type": "string" + }, + "ManagedInstanceScaling": { + "$ref": "#/definitions/ManagedInstanceScaling" + }, + "ModelDataDownloadTimeoutInSeconds": { + "type": "integer" + }, + "ModelName": { + "type": "string" + }, + "RoutingConfig": { + "$ref": "#/definitions/RoutingConfig" + }, + "ServerlessConfig": { + "$ref": "#/definitions/ServerlessConfig" + }, + "VariantName": { + "type": "string" + }, + "VolumeSizeInGB": { + "type": "integer" + } + }, + "required": [ + "VariantName" + ], + "type": "object" + }, + "RoutingConfig": { + "additionalProperties": false, + "properties": { + "RoutingStrategy": { + "type": "string" + } + }, + "type": "object" + }, + "ServerlessConfig": { + "additionalProperties": false, + "properties": { + "MaxConcurrency": { + "type": "integer" + }, + "MemorySizeInMB": { + "type": "integer" + }, + "ProvisionedConcurrency": { + "type": "integer" + } + }, + "required": [ + "MaxConcurrency", + "MemorySizeInMB" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Subnets": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Subnets", + "SecurityGroupIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::EndpointConfig", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AsyncInferenceConfig": { + "$ref": "#/definitions/AsyncInferenceConfig" + }, + "DataCaptureConfig": { + "$ref": "#/definitions/DataCaptureConfig" + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "EndpointConfigName": { + "type": "string" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "ExplainerConfig": { + "$ref": "#/definitions/ExplainerConfig" + }, + "Id": { + "type": "string" + }, + "KmsKeyId": { + "type": "string" + }, + "ProductionVariants": { + "items": { + "$ref": "#/definitions/ProductionVariant" + }, + "type": "array", + "uniqueItems": false + }, + "ShadowProductionVariants": { + "items": { + "$ref": "#/definitions/ProductionVariant" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ProductionVariants" + ], + "typeName": "AWS::SageMaker::EndpointConfig" +} diff --git a/schema/aws-sagemaker-featuregroup.json b/schema/aws-sagemaker-featuregroup.json index 21b7596..be19975 100644 --- a/schema/aws-sagemaker-featuregroup.json +++ b/schema/aws-sagemaker-featuregroup.json @@ -1,359 +1,359 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FeatureGroupName", - "/properties/RecordIdentifierFeatureName", - "/properties/EventTimeFeatureName", - "/properties/OnlineStoreConfig/SecurityConfig", - "/properties/OnlineStoreConfig/EnableOnlineStore", - "/properties/OnlineStoreConfig/StorageType", - "/properties/OfflineStoreConfig", - "/properties/RoleArn", - "/properties/Description", - "/properties/Tags" - ], - "definitions": { - "DataCatalogConfig": { - "additionalProperties": false, - "properties": { - "Catalog": { - "maxLength": 255, - "minLength": 1, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", - "type": "string" - }, - "Database": { - "maxLength": 255, - "minLength": 1, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", - "type": "string" - }, - "TableName": { - "maxLength": 255, - "minLength": 1, - "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", - "type": "string" - } - }, - "required": [ - "TableName", - "Catalog", - "Database" - ], - "type": "object" - }, - "FeatureDefinition": { - "additionalProperties": false, - "properties": { - "FeatureName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", - "type": "string" - }, - "FeatureType": { - "enum": [ - "Integral", - "Fractional", - "String" - ], - "type": "string" - } - }, - "required": [ - "FeatureName", - "FeatureType" - ], - "type": "object" - }, - "KmsKeyId": { - "maxLength": 2048, - "type": "string" - }, - "OnlineStoreSecurityConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - } - }, - "type": "object" - }, - "S3StorageConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "S3Uri": { - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "StorageType": { - "enum": [ - "Standard", - "InMemory" - ], - "type": "string" - }, - "TableFormat": { - "description": "Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores.", - "enum": [ - "Iceberg", - "Glue" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "ThroughputConfig": { - "additionalProperties": false, - "properties": { - "ProvisionedReadCapacityUnits": { - "description": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.", - "type": "integer" - }, - "ProvisionedWriteCapacityUnits": { - "description": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.", - "type": "integer" - }, - "ThroughputMode": { - "$ref": "#/definitions/ThroughputMode" - } - }, - "required": [ - "ThroughputMode" - ], - "type": "object" - }, - "ThroughputMode": { - "description": "Throughput mode configuration of the feature group", - "enum": [ - "OnDemand", - "Provisioned" - ], - "type": "string" - }, - "TtlDuration": { - "additionalProperties": false, - "description": "TTL configuration of the feature group", - "properties": { - "Unit": { - "$ref": "#/definitions/Unit" - }, - "Value": { - "$ref": "#/definitions/Value" - } - }, - "type": "object" - }, - "Unit": { - "description": "Unit of ttl configuration", - "enum": [ - "Seconds", - "Minutes", - "Hours", - "Days", - "Weeks" - ], - "type": "string" - }, - "Value": { - "description": "Value of ttl configuration", - "type": "integer" - } - }, - "description": "Resource Type definition for AWS::SageMaker::FeatureGroup", - "handlers": { - "create": { - "permissions": [ - "iam:PassRole", - "kms:CreateGrant", - "kms:DescribeKey", - "glue:CreateTable", - "glue:GetTable", - "glue:CreateDatabase", - "glue:GetDatabase", - "sagemaker:CreateFeatureGroup", - "sagemaker:DescribeFeatureGroup", - "sagemaker:AddTags", - "sagemaker:ListTags" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteFeatureGroup", - "sagemaker:DescribeFeatureGroup" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListFeatureGroups" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeFeatureGroup", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateFeatureGroup", - "sagemaker:DescribeFeatureGroup", - "sagemaker:AddTags", - "sagemaker:ListTags", - "sagemaker:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/FeatureGroupName" - ], - "properties": { - "CreationTime": { - "description": "A timestamp of FeatureGroup creation time.", - "type": "string" - }, - "Description": { - "description": "Description about the FeatureGroup.", - "maxLength": 128, - "type": "string" - }, - "EventTimeFeatureName": { - "description": "The Event Time Feature Name.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", - "type": "string" - }, - "FeatureDefinitions": { - "description": "An Array of Feature Definition", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FeatureDefinition" - }, - "maxItems": 2500, - "minItems": 1, - "type": "array", - "uniqueItems": false - }, - "FeatureGroupName": { - "description": "The Name of the FeatureGroup.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", - "type": "string" - }, - "FeatureGroupStatus": { - "description": "The status of the feature group.", - "type": "string" - }, - "OfflineStoreConfig": { - "additionalProperties": false, - "properties": { - "DataCatalogConfig": { - "$ref": "#/definitions/DataCatalogConfig" - }, - "DisableGlueTableCreation": { - "type": "boolean" - }, - "S3StorageConfig": { - "$ref": "#/definitions/S3StorageConfig" - }, - "TableFormat": { - "$ref": "#/definitions/TableFormat" - } - }, - "required": [ - "S3StorageConfig" - ], - "type": "object" - }, - "OnlineStoreConfig": { - "additionalProperties": false, - "properties": { - "EnableOnlineStore": { - "type": "boolean" - }, - "SecurityConfig": { - "$ref": "#/definitions/OnlineStoreSecurityConfig" - }, - "StorageType": { - "$ref": "#/definitions/StorageType" - }, - "TtlDuration": { - "$ref": "#/definitions/TtlDuration" - } - }, - "type": "object" - }, - "RecordIdentifierFeatureName": { - "description": "The Record Identifier Feature Name.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", - "type": "string" - }, - "RoleArn": { - "description": "Role Arn", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pair to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": false - }, - "ThroughputConfig": { - "$ref": "#/definitions/ThroughputConfig" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/FeatureGroupStatus" - ], - "required": [ - "FeatureGroupName", - "RecordIdentifierFeatureName", - "EventTimeFeatureName", - "FeatureDefinitions" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::SageMaker::FeatureGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FeatureGroupName", + "/properties/RecordIdentifierFeatureName", + "/properties/EventTimeFeatureName", + "/properties/OnlineStoreConfig/SecurityConfig", + "/properties/OnlineStoreConfig/EnableOnlineStore", + "/properties/OnlineStoreConfig/StorageType", + "/properties/OfflineStoreConfig", + "/properties/RoleArn", + "/properties/Description", + "/properties/Tags" + ], + "definitions": { + "DataCatalogConfig": { + "additionalProperties": false, + "properties": { + "Catalog": { + "maxLength": 255, + "minLength": 1, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", + "type": "string" + }, + "Database": { + "maxLength": 255, + "minLength": 1, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", + "type": "string" + }, + "TableName": { + "maxLength": 255, + "minLength": 1, + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*", + "type": "string" + } + }, + "required": [ + "TableName", + "Catalog", + "Database" + ], + "type": "object" + }, + "FeatureDefinition": { + "additionalProperties": false, + "properties": { + "FeatureName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", + "type": "string" + }, + "FeatureType": { + "enum": [ + "Integral", + "Fractional", + "String" + ], + "type": "string" + } + }, + "required": [ + "FeatureName", + "FeatureType" + ], + "type": "object" + }, + "KmsKeyId": { + "maxLength": 2048, + "type": "string" + }, + "OnlineStoreSecurityConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + } + }, + "type": "object" + }, + "S3StorageConfig": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "S3Uri": { + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "S3Uri" + ], + "type": "object" + }, + "StorageType": { + "enum": [ + "Standard", + "InMemory" + ], + "type": "string" + }, + "TableFormat": { + "description": "Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores.", + "enum": [ + "Iceberg", + "Glue" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "ThroughputConfig": { + "additionalProperties": false, + "properties": { + "ProvisionedReadCapacityUnits": { + "description": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.", + "type": "integer" + }, + "ProvisionedWriteCapacityUnits": { + "description": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.", + "type": "integer" + }, + "ThroughputMode": { + "$ref": "#/definitions/ThroughputMode" + } + }, + "required": [ + "ThroughputMode" + ], + "type": "object" + }, + "ThroughputMode": { + "description": "Throughput mode configuration of the feature group", + "enum": [ + "OnDemand", + "Provisioned" + ], + "type": "string" + }, + "TtlDuration": { + "additionalProperties": false, + "description": "TTL configuration of the feature group", + "properties": { + "Unit": { + "$ref": "#/definitions/Unit" + }, + "Value": { + "$ref": "#/definitions/Value" + } + }, + "type": "object" + }, + "Unit": { + "description": "Unit of ttl configuration", + "enum": [ + "Seconds", + "Minutes", + "Hours", + "Days", + "Weeks" + ], + "type": "string" + }, + "Value": { + "description": "Value of ttl configuration", + "type": "integer" + } + }, + "description": "Resource Type definition for AWS::SageMaker::FeatureGroup", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "glue:CreateTable", + "glue:GetTable", + "glue:CreateDatabase", + "glue:GetDatabase", + "sagemaker:CreateFeatureGroup", + "sagemaker:DescribeFeatureGroup", + "sagemaker:AddTags", + "sagemaker:ListTags" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteFeatureGroup", + "sagemaker:DescribeFeatureGroup" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListFeatureGroups" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeFeatureGroup", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateFeatureGroup", + "sagemaker:DescribeFeatureGroup", + "sagemaker:AddTags", + "sagemaker:ListTags", + "sagemaker:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/FeatureGroupName" + ], + "properties": { + "CreationTime": { + "description": "A timestamp of FeatureGroup creation time.", + "type": "string" + }, + "Description": { + "description": "Description about the FeatureGroup.", + "maxLength": 128, + "type": "string" + }, + "EventTimeFeatureName": { + "description": "The Event Time Feature Name.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", + "type": "string" + }, + "FeatureDefinitions": { + "description": "An Array of Feature Definition", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FeatureDefinition" + }, + "maxItems": 2500, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "FeatureGroupName": { + "description": "The Name of the FeatureGroup.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", + "type": "string" + }, + "FeatureGroupStatus": { + "description": "The status of the feature group.", + "type": "string" + }, + "OfflineStoreConfig": { + "additionalProperties": false, + "properties": { + "DataCatalogConfig": { + "$ref": "#/definitions/DataCatalogConfig" + }, + "DisableGlueTableCreation": { + "type": "boolean" + }, + "S3StorageConfig": { + "$ref": "#/definitions/S3StorageConfig" + }, + "TableFormat": { + "$ref": "#/definitions/TableFormat" + } + }, + "required": [ + "S3StorageConfig" + ], + "type": "object" + }, + "OnlineStoreConfig": { + "additionalProperties": false, + "properties": { + "EnableOnlineStore": { + "type": "boolean" + }, + "SecurityConfig": { + "$ref": "#/definitions/OnlineStoreSecurityConfig" + }, + "StorageType": { + "$ref": "#/definitions/StorageType" + }, + "TtlDuration": { + "$ref": "#/definitions/TtlDuration" + } + }, + "type": "object" + }, + "RecordIdentifierFeatureName": { + "description": "The Record Identifier Feature Name.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}", + "type": "string" + }, + "RoleArn": { + "description": "Role Arn", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pair to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": false + }, + "ThroughputConfig": { + "$ref": "#/definitions/ThroughputConfig" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/FeatureGroupStatus" + ], + "required": [ + "FeatureGroupName", + "RecordIdentifierFeatureName", + "EventTimeFeatureName", + "FeatureDefinitions" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::SageMaker::FeatureGroup" +} diff --git a/schema/aws-sagemaker-image.json b/schema/aws-sagemaker-image.json index 8ce5558..2a3c9e7 100644 --- a/schema/aws-sagemaker-image.json +++ b/schema/aws-sagemaker-image.json @@ -1,152 +1,152 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ImageName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ImageName" - ], - "definitions": { - "ImageArn": { - "description": "The Amazon Resource Name (ARN) of the image.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", - "type": "string" - }, - "ImageDescription": { - "description": "A description of the image.", - "maxLength": 512, - "minLength": 1, - "pattern": ".+", - "type": "string" - }, - "ImageDisplayName": { - "description": "The display name of the image.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9 -_]+$", - "type": "string" - }, - "ImageName": { - "description": "The name of the image.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", - "type": "string" - }, - "ImageRoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::Image", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateImage", - "sagemaker:DescribeImage", - "iam:PassRole", - "sagemaker:AddTags", - "sagemaker:ListTags" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteImage", - "sagemaker:DescribeImage" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListImages" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeImage", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateImage", - "sagemaker:DescribeImage", - "sagemaker:ListTags", - "sagemaker:AddTags", - "sagemaker:DeleteTags", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ImageArn" - ], - "properties": { - "ImageArn": { - "$ref": "#/definitions/ImageArn" - }, - "ImageDescription": { - "$ref": "#/definitions/ImageDescription" - }, - "ImageDisplayName": { - "$ref": "#/definitions/ImageDisplayName" - }, - "ImageName": { - "$ref": "#/definitions/ImageName" - }, - "ImageRoleArn": { - "$ref": "#/definitions/ImageRoleArn" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ImageArn" - ], - "required": [ - "ImageName", - "ImageRoleArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SageMaker::Image" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ImageName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ImageName" + ], + "definitions": { + "ImageArn": { + "description": "The Amazon Resource Name (ARN) of the image.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", + "type": "string" + }, + "ImageDescription": { + "description": "A description of the image.", + "maxLength": 512, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "ImageDisplayName": { + "description": "The display name of the image.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9 -_]+$", + "type": "string" + }, + "ImageName": { + "description": "The name of the image.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", + "type": "string" + }, + "ImageRoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::Image", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateImage", + "sagemaker:DescribeImage", + "iam:PassRole", + "sagemaker:AddTags", + "sagemaker:ListTags" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteImage", + "sagemaker:DescribeImage" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListImages" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeImage", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateImage", + "sagemaker:DescribeImage", + "sagemaker:ListTags", + "sagemaker:AddTags", + "sagemaker:DeleteTags", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ImageArn" + ], + "properties": { + "ImageArn": { + "$ref": "#/definitions/ImageArn" + }, + "ImageDescription": { + "$ref": "#/definitions/ImageDescription" + }, + "ImageDisplayName": { + "$ref": "#/definitions/ImageDisplayName" + }, + "ImageName": { + "$ref": "#/definitions/ImageName" + }, + "ImageRoleArn": { + "$ref": "#/definitions/ImageRoleArn" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ImageArn" + ], + "required": [ + "ImageName", + "ImageRoleArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::Image" +} diff --git a/schema/aws-sagemaker-imageversion.json b/schema/aws-sagemaker-imageversion.json index 5d2ad1f..a7d54b9 100644 --- a/schema/aws-sagemaker-imageversion.json +++ b/schema/aws-sagemaker-imageversion.json @@ -1,229 +1,229 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ImageName", - "/properties/BaseImage" - ], - "definitions": { - "Alias": { - "description": "The alias of the image version.", - "maxLength": 128, - "minLength": 1, - "pattern": "(?!^[.-])^([a-zA-Z0-9-_.]+)$", - "type": "string" - }, - "Aliases": { - "description": "List of aliases for the image version.", - "items": { - "$ref": "#/definitions/Alias" - }, - "type": "array" - }, - "BaseImage": { - "description": "The registry path of the container image on which this image version is based.", - "maxLength": 255, - "minLength": 1, - "pattern": ".+", - "type": "string" - }, - "ContainerImage": { - "description": "The registry path of the container image that contains this image version.", - "maxLength": 255, - "minLength": 1, - "pattern": ".+", - "type": "string" - }, - "Horovod": { - "description": "Indicates Horovod compatibility.", - "type": "boolean" - }, - "ImageArn": { - "description": "The Amazon Resource Name (ARN) of the parent image.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", - "type": "string" - }, - "ImageName": { - "description": "The name of the image this version belongs to.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$", - "type": "string" - }, - "ImageVersionArn": { - "description": "The Amazon Resource Name (ARN) of the image version.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image-version\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*\\/[0-9]+$", - "type": "string" - }, - "JobType": { - "description": "Indicates SageMaker job type compatibility.", - "enum": [ - "TRAINING", - "INFERENCE", - "NOTEBOOK_KERNEL" - ], - "type": "string" - }, - "MLFramework": { - "description": "The machine learning framework vended in the image version.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$", - "type": "string" - }, - "Processor": { - "description": "Indicates CPU or GPU compatibility.", - "enum": [ - "CPU", - "GPU" - ], - "type": "string" - }, - "ProgrammingLang": { - "description": "The supported programming language and its version.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$", - "type": "string" - }, - "ReleaseNotes": { - "description": "The maintainer description of the image version.", - "maxLength": 255, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "VendorGuidance": { - "description": "The availability of the image version specified by the maintainer.", - "enum": [ - "NOT_PROVIDED", - "STABLE", - "TO_BE_ARCHIVED", - "ARCHIVED" - ], - "type": "string" - }, - "Version": { - "description": "The version number of the image version.", - "minimum": 1, - "type": "integer" - } - }, - "description": "Resource Type definition for AWS::SageMaker::ImageVersion", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateImageVersion", - "sagemaker:DescribeImageVersion" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteImageVersion", - "sagemaker:DescribeImageVersion" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ImageName": { - "$ref": "resource-schema.json#/properties/ImageName" - } - }, - "required": [ - "ImageName" - ] - }, - "permissions": [ - "sagemaker:ListImageVersions" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeImageVersion" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateImageVersion", - "sagemaker:DescribeImageVersion", - "sagemaker:ListAliases" - ] - } - }, - "primaryIdentifier": [ - "/properties/ImageVersionArn" - ], - "properties": { - "Alias": { - "$ref": "#/definitions/Alias" - }, - "Aliases": { - "$ref": "#/definitions/Aliases" - }, - "BaseImage": { - "$ref": "#/definitions/BaseImage" - }, - "ContainerImage": { - "$ref": "#/definitions/ContainerImage" - }, - "Horovod": { - "$ref": "#/definitions/Horovod" - }, - "ImageArn": { - "$ref": "#/definitions/ImageArn" - }, - "ImageName": { - "$ref": "#/definitions/ImageName" - }, - "ImageVersionArn": { - "$ref": "#/definitions/ImageVersionArn" - }, - "JobType": { - "$ref": "#/definitions/JobType" - }, - "MLFramework": { - "$ref": "#/definitions/MLFramework" - }, - "Processor": { - "$ref": "#/definitions/Processor" - }, - "ProgrammingLang": { - "$ref": "#/definitions/ProgrammingLang" - }, - "ReleaseNotes": { - "$ref": "#/definitions/ReleaseNotes" - }, - "VendorGuidance": { - "$ref": "#/definitions/VendorGuidance" - }, - "Version": { - "$ref": "#/definitions/Version" - } - }, - "readOnlyProperties": [ - "/properties/ImageVersionArn", - "/properties/ImageArn", - "/properties/Version", - "/properties/ContainerImage" - ], - "required": [ - "ImageName", - "BaseImage" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SageMaker::ImageVersion", - "writeOnlyProperties": [ - "/properties/Aliases", - "/properties/Alias" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ImageName", + "/properties/BaseImage" + ], + "definitions": { + "Alias": { + "description": "The alias of the image version.", + "maxLength": 128, + "minLength": 1, + "pattern": "(?!^[.-])^([a-zA-Z0-9-_.]+)$", + "type": "string" + }, + "Aliases": { + "description": "List of aliases for the image version.", + "items": { + "$ref": "#/definitions/Alias" + }, + "type": "array" + }, + "BaseImage": { + "description": "The registry path of the container image on which this image version is based.", + "maxLength": 255, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "ContainerImage": { + "description": "The registry path of the container image that contains this image version.", + "maxLength": 255, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "Horovod": { + "description": "Indicates Horovod compatibility.", + "type": "boolean" + }, + "ImageArn": { + "description": "The Amazon Resource Name (ARN) of the parent image.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$", + "type": "string" + }, + "ImageName": { + "description": "The name of the image this version belongs to.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$", + "type": "string" + }, + "ImageVersionArn": { + "description": "The Amazon Resource Name (ARN) of the image version.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws(-[\\w]+)*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:image-version\\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*\\/[0-9]+$", + "type": "string" + }, + "JobType": { + "description": "Indicates SageMaker job type compatibility.", + "enum": [ + "TRAINING", + "INFERENCE", + "NOTEBOOK_KERNEL" + ], + "type": "string" + }, + "MLFramework": { + "description": "The machine learning framework vended in the image version.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$", + "type": "string" + }, + "Processor": { + "description": "Indicates CPU or GPU compatibility.", + "enum": [ + "CPU", + "GPU" + ], + "type": "string" + }, + "ProgrammingLang": { + "description": "The supported programming language and its version.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$", + "type": "string" + }, + "ReleaseNotes": { + "description": "The maintainer description of the image version.", + "maxLength": 255, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "VendorGuidance": { + "description": "The availability of the image version specified by the maintainer.", + "enum": [ + "NOT_PROVIDED", + "STABLE", + "TO_BE_ARCHIVED", + "ARCHIVED" + ], + "type": "string" + }, + "Version": { + "description": "The version number of the image version.", + "minimum": 1, + "type": "integer" + } + }, + "description": "Resource Type definition for AWS::SageMaker::ImageVersion", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateImageVersion", + "sagemaker:DescribeImageVersion" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteImageVersion", + "sagemaker:DescribeImageVersion" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ImageName": { + "$ref": "resource-schema.json#/properties/ImageName" + } + }, + "required": [ + "ImageName" + ] + }, + "permissions": [ + "sagemaker:ListImageVersions" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeImageVersion" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateImageVersion", + "sagemaker:DescribeImageVersion", + "sagemaker:ListAliases" + ] + } + }, + "primaryIdentifier": [ + "/properties/ImageVersionArn" + ], + "properties": { + "Alias": { + "$ref": "#/definitions/Alias" + }, + "Aliases": { + "$ref": "#/definitions/Aliases" + }, + "BaseImage": { + "$ref": "#/definitions/BaseImage" + }, + "ContainerImage": { + "$ref": "#/definitions/ContainerImage" + }, + "Horovod": { + "$ref": "#/definitions/Horovod" + }, + "ImageArn": { + "$ref": "#/definitions/ImageArn" + }, + "ImageName": { + "$ref": "#/definitions/ImageName" + }, + "ImageVersionArn": { + "$ref": "#/definitions/ImageVersionArn" + }, + "JobType": { + "$ref": "#/definitions/JobType" + }, + "MLFramework": { + "$ref": "#/definitions/MLFramework" + }, + "Processor": { + "$ref": "#/definitions/Processor" + }, + "ProgrammingLang": { + "$ref": "#/definitions/ProgrammingLang" + }, + "ReleaseNotes": { + "$ref": "#/definitions/ReleaseNotes" + }, + "VendorGuidance": { + "$ref": "#/definitions/VendorGuidance" + }, + "Version": { + "$ref": "#/definitions/Version" + } + }, + "readOnlyProperties": [ + "/properties/ImageVersionArn", + "/properties/ImageArn", + "/properties/Version", + "/properties/ContainerImage" + ], + "required": [ + "ImageName", + "BaseImage" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sagemaker", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SageMaker::ImageVersion", + "writeOnlyProperties": [ + "/properties/Aliases", + "/properties/Alias" + ] +} diff --git a/schema/aws-sagemaker-inferencecomponent.json b/schema/aws-sagemaker-inferencecomponent.json index 6367c19..8838ea2 100644 --- a/schema/aws-sagemaker-inferencecomponent.json +++ b/schema/aws-sagemaker-inferencecomponent.json @@ -1,351 +1,351 @@ -{ - "additionalProperties": false, - "definitions": { - "ContainerImage": { - "description": "The image to use for the container that will be materialized for the inference component", - "maxLength": 255, - "pattern": "[\\S]+", - "type": "string" - }, - "DeployedImage": { - "additionalProperties": false, - "description": "", - "properties": { - "ResolutionTime": { - "$ref": "#/definitions/Timestamp" - }, - "ResolvedImage": { - "$ref": "#/definitions/ContainerImage" - }, - "SpecifiedImage": { - "$ref": "#/definitions/ContainerImage" - } - }, - "type": "object" - }, - "EndpointArn": { - "description": "The Amazon Resource Name (ARN) of the endpoint the inference component is associated with", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "EndpointName": { - "description": "The name of the endpoint the inference component is associated with", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "EnvironmentMap": { - "additionalProperties": false, - "description": "Environment variables to specify on the container", - "maxProperties": 16, - "patternProperties": { - "^[a-zA-Z_][a-zA-Z0-9_]{1,1024}$": { - "maxLength": 1024, - "pattern": "^[\\S\\s]*$", - "type": "string" - } - }, - "type": "object" - }, - "FailureReason": { - "description": "The failure reason if the inference component is in a failed state", - "maxLength": 63, - "type": "string" - }, - "InferenceComponentArn": { - "description": "The Amazon Resource Name (ARN) of the inference component", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "InferenceComponentComputeResourceRequirements": { - "additionalProperties": false, - "description": "", - "properties": { - "MaxMemoryRequiredInMb": { - "$ref": "#/definitions/MemoryInMb" - }, - "MinMemoryRequiredInMb": { - "$ref": "#/definitions/MemoryInMb" - }, - "NumberOfAcceleratorDevicesRequired": { - "$ref": "#/definitions/NumberOfAcceleratorDevices" - }, - "NumberOfCpuCoresRequired": { - "$ref": "#/definitions/NumberOfCpuCores" - } - }, - "type": "object" - }, - "InferenceComponentContainerSpecification": { - "additionalProperties": false, - "description": "", - "properties": { - "ArtifactUrl": { - "$ref": "#/definitions/Url" - }, - "DeployedImage": { - "$ref": "#/definitions/DeployedImage" - }, - "Environment": { - "$ref": "#/definitions/EnvironmentMap" - }, - "Image": { - "$ref": "#/definitions/ContainerImage" - } - }, - "type": "object" - }, - "InferenceComponentCopyCount": { - "description": "The number of copies for the inference component", - "minimum": 0, - "type": "integer" - }, - "InferenceComponentName": { - "description": "The name of the inference component", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "InferenceComponentRuntimeConfig": { - "additionalProperties": false, - "description": "The runtime config for the inference component", - "properties": { - "CopyCount": { - "$ref": "#/definitions/InferenceComponentCopyCount" - }, - "CurrentCopyCount": { - "$ref": "#/definitions/InferenceComponentCopyCount" - }, - "DesiredCopyCount": { - "$ref": "#/definitions/InferenceComponentCopyCount" - } - }, - "type": "object" - }, - "InferenceComponentSpecification": { - "additionalProperties": false, - "description": "The specification for the inference component", - "properties": { - "ComputeResourceRequirements": { - "$ref": "#/definitions/InferenceComponentComputeResourceRequirements" - }, - "Container": { - "$ref": "#/definitions/InferenceComponentContainerSpecification" - }, - "ModelName": { - "$ref": "#/definitions/ModelName" - }, - "StartupParameters": { - "$ref": "#/definitions/InferenceComponentStartupParameters" - } - }, - "required": [ - "ComputeResourceRequirements" - ], - "type": "object" - }, - "InferenceComponentStartupParameters": { - "additionalProperties": false, - "description": "", - "properties": { - "ContainerStartupHealthCheckTimeoutInSeconds": { - "$ref": "#/definitions/StartupParameterTimeoutInSeconds" - }, - "ModelDataDownloadTimeoutInSeconds": { - "$ref": "#/definitions/StartupParameterTimeoutInSeconds" - } - }, - "type": "object" - }, - "InferenceComponentStatus": { - "enum": [ - "InService", - "Creating", - "Updating", - "Failed", - "Deleting" - ], - "type": "string" - }, - "MemoryInMb": { - "minimum": 128, - "type": "integer" - }, - "ModelName": { - "description": "The name of the model to use with the inference component", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "NumberOfAcceleratorDevices": { - "minimum": 1, - "type": "number" - }, - "NumberOfCpuCores": { - "minimum": 0.25, - "type": "number" - }, - "StartupParameterTimeoutInSeconds": { - "maximum": 3600, - "minimum": 60, - "type": "integer" - }, - "Tag": { - "additionalProperties": false, - "description": "A tag in the form of a key-value pair to associate with the resource", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TagList": { - "description": "An array of tags to apply to the resource", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - }, - "Timestamp": { - "type": "string" - }, - "Url": { - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "VariantName": { - "description": "The name of the endpoint variant the inference component is associated with", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - } - }, - "description": "Resource Type definition for AWS::SageMaker::InferenceComponent", - "handlers": { - "create": { - "permissions": [ - "sagemaker:AddTags", - "sagemaker:ListTags", - "sagemaker:CreateInferenceComponent", - "sagemaker:DescribeInferenceComponent" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DescribeInferenceComponent", - "sagemaker:DeleteInferenceComponent", - "sagemaker:DeleteTags" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListInferenceComponents", - "sagemaker:DescribeInferenceComponent", - "sagemaker:ListTags" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeInferenceComponent", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateInferenceComponent", - "sagemaker:UpdateInferenceComponentRuntimeConfig", - "sagemaker:DescribeInferenceComponent", - "sagemaker:AddTags", - "sagemaker:ListTags", - "sagemaker:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/InferenceComponentArn" - ], - "properties": { - "CreationTime": { - "$ref": "#/definitions/Timestamp" - }, - "EndpointArn": { - "$ref": "#/definitions/EndpointArn" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason" - }, - "InferenceComponentArn": { - "$ref": "#/definitions/InferenceComponentArn" - }, - "InferenceComponentName": { - "$ref": "#/definitions/InferenceComponentName" - }, - "InferenceComponentStatus": { - "$ref": "#/definitions/InferenceComponentStatus" - }, - "LastModifiedTime": { - "$ref": "#/definitions/Timestamp" - }, - "RuntimeConfig": { - "$ref": "#/definitions/InferenceComponentRuntimeConfig" - }, - "Specification": { - "$ref": "#/definitions/InferenceComponentSpecification" - }, - "Tags": { - "$ref": "#/definitions/TagList" - }, - "VariantName": { - "$ref": "#/definitions/VariantName" - } - }, - "readOnlyProperties": [ - "/properties/InferenceComponentArn", - "/properties/Specification/Container/DeployedImage", - "/properties/RuntimeConfig/DesiredCopyCount", - "/properties/RuntimeConfig/CurrentCopyCount", - "/properties/CreationTime", - "/properties/LastModifiedTime", - "/properties/FailureReason", - "/properties/InferenceComponentStatus" - ], - "required": [ - "EndpointName", - "VariantName", - "Specification", - "RuntimeConfig" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SageMaker::InferenceComponent", - "writeOnlyProperties": [ - "/properties/Specification/Container/Image", - "/properties/RuntimeConfig/CopyCount" - ] -} +{ + "additionalProperties": false, + "definitions": { + "ContainerImage": { + "description": "The image to use for the container that will be materialized for the inference component", + "maxLength": 255, + "pattern": "[\\S]+", + "type": "string" + }, + "DeployedImage": { + "additionalProperties": false, + "description": "", + "properties": { + "ResolutionTime": { + "$ref": "#/definitions/Timestamp" + }, + "ResolvedImage": { + "$ref": "#/definitions/ContainerImage" + }, + "SpecifiedImage": { + "$ref": "#/definitions/ContainerImage" + } + }, + "type": "object" + }, + "EndpointArn": { + "description": "The Amazon Resource Name (ARN) of the endpoint the inference component is associated with", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "EndpointName": { + "description": "The name of the endpoint the inference component is associated with", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "EnvironmentMap": { + "additionalProperties": false, + "description": "Environment variables to specify on the container", + "maxProperties": 16, + "patternProperties": { + "^[a-zA-Z_][a-zA-Z0-9_]{1,1024}$": { + "maxLength": 1024, + "pattern": "^[\\S\\s]*$", + "type": "string" + } + }, + "type": "object" + }, + "FailureReason": { + "description": "The failure reason if the inference component is in a failed state", + "maxLength": 63, + "type": "string" + }, + "InferenceComponentArn": { + "description": "The Amazon Resource Name (ARN) of the inference component", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "InferenceComponentComputeResourceRequirements": { + "additionalProperties": false, + "description": "", + "properties": { + "MaxMemoryRequiredInMb": { + "$ref": "#/definitions/MemoryInMb" + }, + "MinMemoryRequiredInMb": { + "$ref": "#/definitions/MemoryInMb" + }, + "NumberOfAcceleratorDevicesRequired": { + "$ref": "#/definitions/NumberOfAcceleratorDevices" + }, + "NumberOfCpuCoresRequired": { + "$ref": "#/definitions/NumberOfCpuCores" + } + }, + "type": "object" + }, + "InferenceComponentContainerSpecification": { + "additionalProperties": false, + "description": "", + "properties": { + "ArtifactUrl": { + "$ref": "#/definitions/Url" + }, + "DeployedImage": { + "$ref": "#/definitions/DeployedImage" + }, + "Environment": { + "$ref": "#/definitions/EnvironmentMap" + }, + "Image": { + "$ref": "#/definitions/ContainerImage" + } + }, + "type": "object" + }, + "InferenceComponentCopyCount": { + "description": "The number of copies for the inference component", + "minimum": 0, + "type": "integer" + }, + "InferenceComponentName": { + "description": "The name of the inference component", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "InferenceComponentRuntimeConfig": { + "additionalProperties": false, + "description": "The runtime config for the inference component", + "properties": { + "CopyCount": { + "$ref": "#/definitions/InferenceComponentCopyCount" + }, + "CurrentCopyCount": { + "$ref": "#/definitions/InferenceComponentCopyCount" + }, + "DesiredCopyCount": { + "$ref": "#/definitions/InferenceComponentCopyCount" + } + }, + "type": "object" + }, + "InferenceComponentSpecification": { + "additionalProperties": false, + "description": "The specification for the inference component", + "properties": { + "ComputeResourceRequirements": { + "$ref": "#/definitions/InferenceComponentComputeResourceRequirements" + }, + "Container": { + "$ref": "#/definitions/InferenceComponentContainerSpecification" + }, + "ModelName": { + "$ref": "#/definitions/ModelName" + }, + "StartupParameters": { + "$ref": "#/definitions/InferenceComponentStartupParameters" + } + }, + "required": [ + "ComputeResourceRequirements" + ], + "type": "object" + }, + "InferenceComponentStartupParameters": { + "additionalProperties": false, + "description": "", + "properties": { + "ContainerStartupHealthCheckTimeoutInSeconds": { + "$ref": "#/definitions/StartupParameterTimeoutInSeconds" + }, + "ModelDataDownloadTimeoutInSeconds": { + "$ref": "#/definitions/StartupParameterTimeoutInSeconds" + } + }, + "type": "object" + }, + "InferenceComponentStatus": { + "enum": [ + "InService", + "Creating", + "Updating", + "Failed", + "Deleting" + ], + "type": "string" + }, + "MemoryInMb": { + "minimum": 128, + "type": "integer" + }, + "ModelName": { + "description": "The name of the model to use with the inference component", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "NumberOfAcceleratorDevices": { + "minimum": 1, + "type": "number" + }, + "NumberOfCpuCores": { + "minimum": 0.25, + "type": "number" + }, + "StartupParameterTimeoutInSeconds": { + "maximum": 3600, + "minimum": 60, + "type": "integer" + }, + "Tag": { + "additionalProperties": false, + "description": "A tag in the form of a key-value pair to associate with the resource", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TagList": { + "description": "An array of tags to apply to the resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + }, + "Timestamp": { + "type": "string" + }, + "Url": { + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "VariantName": { + "description": "The name of the endpoint variant the inference component is associated with", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + } + }, + "description": "Resource Type definition for AWS::SageMaker::InferenceComponent", + "handlers": { + "create": { + "permissions": [ + "sagemaker:AddTags", + "sagemaker:ListTags", + "sagemaker:CreateInferenceComponent", + "sagemaker:DescribeInferenceComponent" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DescribeInferenceComponent", + "sagemaker:DeleteInferenceComponent", + "sagemaker:DeleteTags" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListInferenceComponents", + "sagemaker:DescribeInferenceComponent", + "sagemaker:ListTags" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeInferenceComponent", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateInferenceComponent", + "sagemaker:UpdateInferenceComponentRuntimeConfig", + "sagemaker:DescribeInferenceComponent", + "sagemaker:AddTags", + "sagemaker:ListTags", + "sagemaker:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/InferenceComponentArn" + ], + "properties": { + "CreationTime": { + "$ref": "#/definitions/Timestamp" + }, + "EndpointArn": { + "$ref": "#/definitions/EndpointArn" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason" + }, + "InferenceComponentArn": { + "$ref": "#/definitions/InferenceComponentArn" + }, + "InferenceComponentName": { + "$ref": "#/definitions/InferenceComponentName" + }, + "InferenceComponentStatus": { + "$ref": "#/definitions/InferenceComponentStatus" + }, + "LastModifiedTime": { + "$ref": "#/definitions/Timestamp" + }, + "RuntimeConfig": { + "$ref": "#/definitions/InferenceComponentRuntimeConfig" + }, + "Specification": { + "$ref": "#/definitions/InferenceComponentSpecification" + }, + "Tags": { + "$ref": "#/definitions/TagList" + }, + "VariantName": { + "$ref": "#/definitions/VariantName" + } + }, + "readOnlyProperties": [ + "/properties/InferenceComponentArn", + "/properties/Specification/Container/DeployedImage", + "/properties/RuntimeConfig/DesiredCopyCount", + "/properties/RuntimeConfig/CurrentCopyCount", + "/properties/CreationTime", + "/properties/LastModifiedTime", + "/properties/FailureReason", + "/properties/InferenceComponentStatus" + ], + "required": [ + "EndpointName", + "VariantName", + "Specification", + "RuntimeConfig" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::InferenceComponent", + "writeOnlyProperties": [ + "/properties/Specification/Container/Image", + "/properties/RuntimeConfig/CopyCount" + ] +} diff --git a/schema/aws-sagemaker-inferenceexperiment.json b/schema/aws-sagemaker-inferenceexperiment.json index 732e11e..a754f97 100644 --- a/schema/aws-sagemaker-inferenceexperiment.json +++ b/schema/aws-sagemaker-inferenceexperiment.json @@ -1,440 +1,440 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type", - "/properties/RoleArn", - "/properties/EndpointName", - "/properties/KmsKey" - ], - "definitions": { - "CaptureContentTypeHeader": { - "additionalProperties": false, - "description": "Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.", - "properties": { - "CsvContentTypes": { - "description": "The list of all content type headers that SageMaker will treat as CSV and capture accordingly.", - "items": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])*", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "JsonContentTypes": { - "description": "The list of all content type headers that SageMaker will treat as JSON and capture accordingly.", - "items": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])*", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "DataStorageConfig": { - "additionalProperties": false, - "description": "The Amazon S3 location and configuration for storing inference request and response data.", - "properties": { - "ContentType": { - "$ref": "#/definitions/CaptureContentTypeHeader" - }, - "Destination": { - "description": "The Amazon S3 bucket where the inference request and response data is stored.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/])/?(.*)$", - "type": "string" - }, - "KmsKey": { - "description": "The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "EndpointMetadata": { - "additionalProperties": false, - "description": "The metadata of the endpoint on which the inference experiment ran.", - "properties": { - "EndpointConfigName": { - "description": "The name of the endpoint configuration.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "EndpointStatus": { - "description": "The status of the endpoint. For possible values of the status of an endpoint.", - "enum": [ - "Creating", - "Updating", - "SystemUpdating", - "RollingBack", - "InService", - "OutOfService", - "Deleting", - "Failed" - ], - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - } - }, - "required": [ - "EndpointName" - ], - "type": "object" - }, - "EndpointName": { - "description": "The name of the endpoint used to run the inference experiment.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "InferenceExperimentSchedule": { - "additionalProperties": false, - "description": "The duration for which you want the inference experiment to run.", - "properties": { - "EndTime": { - "description": "The timestamp at which the inference experiment ended or will end.", - "type": "string" - }, - "StartTime": { - "description": "The timestamp at which the inference experiment started or will start.", - "type": "string" - } - }, - "type": "object" - }, - "ModelInfrastructureConfig": { - "additionalProperties": false, - "description": "The configuration for the infrastructure that the model will be deployed to.", - "properties": { - "InfrastructureType": { - "description": "The type of the inference experiment that you want to run.", - "enum": [ - "RealTimeInference" - ], - "type": "string" - }, - "RealTimeInferenceConfig": { - "$ref": "#/definitions/RealTimeInferenceConfig" - } - }, - "required": [ - "InfrastructureType", - "RealTimeInferenceConfig" - ], - "type": "object" - }, - "ModelVariantConfig": { - "additionalProperties": false, - "description": "Contains information about the deployment options of a model.", - "properties": { - "InfrastructureConfig": { - "$ref": "#/definitions/ModelInfrastructureConfig" - }, - "ModelName": { - "description": "The name of the Amazon SageMaker Model entity.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "VariantName": { - "description": "The name of the variant.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", - "type": "string" - } - }, - "required": [ - "ModelName", - "VariantName", - "InfrastructureConfig" - ], - "type": "object" - }, - "RealTimeInferenceConfig": { - "additionalProperties": false, - "description": "The infrastructure configuration for deploying the model to a real-time inference endpoint.", - "properties": { - "InstanceCount": { - "description": "The number of instances of the type specified by InstanceType.", - "type": "integer" - }, - "InstanceType": { - "description": "The instance type the model is deployed to.", - "type": "string" - } - }, - "required": [ - "InstanceType", - "InstanceCount" - ], - "type": "object" - }, - "ShadowModeConfig": { - "additionalProperties": false, - "description": "The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.", - "properties": { - "ShadowModelVariants": { - "description": "List of shadow variant configurations.", - "items": { - "$ref": "#/definitions/ShadowModelVariantConfig" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "SourceModelVariantName": { - "description": "The name of the production variant, which takes all the inference requests.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", - "type": "string" - } - }, - "required": [ - "SourceModelVariantName", - "ShadowModelVariants" - ], - "type": "object" - }, - "ShadowModelVariantConfig": { - "additionalProperties": false, - "description": "The name and sampling percentage of a shadow variant.", - "properties": { - "SamplingPercentage": { - "description": "The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.", - "maximum": 100, - "type": "integer" - }, - "ShadowModelVariantName": { - "description": "The name of the shadow variant.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", - "type": "string" - } - }, - "required": [ - "ShadowModelVariantName", - "SamplingPercentage" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::InferenceExperiment", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateInferenceExperiment", - "sagemaker:DescribeInferenceExperiment", - "sagemaker:AddTags", - "sagemaker:ListTags", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteInferenceExperiment", - "sagemaker:DescribeInferenceExperiment", - "sagemaker:StopInferenceExperiment", - "sagemaker:ListTags" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListInferenceExperiments" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeInferenceExperiment", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateInferenceExperiment", - "sagemaker:StartInferenceExperiment", - "sagemaker:StopInferenceExperiment", - "sagemaker:DescribeInferenceExperiment", - "sagemaker:AddTags", - "sagemaker:DeleteTags", - "sagemaker:ListTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the inference experiment.", - "maxLength": 256, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "CreationTime": { - "description": "The timestamp at which you created the inference experiment.", - "type": "string" - }, - "DataStorageConfig": { - "$ref": "#/definitions/DataStorageConfig" - }, - "Description": { - "description": "The description of the inference experiment.", - "maxLength": 1024, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "DesiredState": { - "description": "The desired state of the experiment after starting or stopping operation.", - "enum": [ - "Running", - "Completed", - "Cancelled" - ], - "type": "string" - }, - "EndpointMetadata": { - "$ref": "#/definitions/EndpointMetadata" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "KmsKey": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "LastModifiedTime": { - "description": "The timestamp at which you last modified the inference experiment.", - "type": "string" - }, - "ModelVariants": { - "description": "An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.", - "items": { - "$ref": "#/definitions/ModelVariantConfig" - }, - "maxItems": 2, - "type": "array" - }, - "Name": { - "description": "The name for the inference experiment.", - "maxLength": 120, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/InferenceExperimentSchedule" - }, - "ShadowModeConfig": { - "$ref": "#/definitions/ShadowModeConfig" - }, - "Status": { - "description": "The status of the inference experiment.", - "enum": [ - "Creating", - "Created", - "Updating", - "Starting", - "Stopping", - "Running", - "Completed", - "Cancelled" - ], - "type": "string" - }, - "StatusReason": { - "description": "The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.", - "maxLength": 1024, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - }, - "Type": { - "description": "The type of the inference experiment that you want to run.", - "enum": [ - "ShadowMode" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreationTime", - "/properties/LastModifiedTime", - "/properties/EndpointMetadata", - "/properties/Status" - ], - "required": [ - "Name", - "Type", - "RoleArn", - "EndpointName", - "ModelVariants" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SageMaker::InferenceExperiment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type", + "/properties/RoleArn", + "/properties/EndpointName", + "/properties/KmsKey" + ], + "definitions": { + "CaptureContentTypeHeader": { + "additionalProperties": false, + "description": "Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.", + "properties": { + "CsvContentTypes": { + "description": "The list of all content type headers that SageMaker will treat as CSV and capture accordingly.", + "items": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])*", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "JsonContentTypes": { + "description": "The list of all content type headers that SageMaker will treat as JSON and capture accordingly.", + "items": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])*", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "DataStorageConfig": { + "additionalProperties": false, + "description": "The Amazon S3 location and configuration for storing inference request and response data.", + "properties": { + "ContentType": { + "$ref": "#/definitions/CaptureContentTypeHeader" + }, + "Destination": { + "description": "The Amazon S3 bucket where the inference request and response data is stored.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/])/?(.*)$", + "type": "string" + }, + "KmsKey": { + "description": "The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "Destination" + ], + "type": "object" + }, + "EndpointMetadata": { + "additionalProperties": false, + "description": "The metadata of the endpoint on which the inference experiment ran.", + "properties": { + "EndpointConfigName": { + "description": "The name of the endpoint configuration.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "EndpointStatus": { + "description": "The status of the endpoint. For possible values of the status of an endpoint.", + "enum": [ + "Creating", + "Updating", + "SystemUpdating", + "RollingBack", + "InService", + "OutOfService", + "Deleting", + "Failed" + ], + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + } + }, + "required": [ + "EndpointName" + ], + "type": "object" + }, + "EndpointName": { + "description": "The name of the endpoint used to run the inference experiment.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "InferenceExperimentSchedule": { + "additionalProperties": false, + "description": "The duration for which you want the inference experiment to run.", + "properties": { + "EndTime": { + "description": "The timestamp at which the inference experiment ended or will end.", + "type": "string" + }, + "StartTime": { + "description": "The timestamp at which the inference experiment started or will start.", + "type": "string" + } + }, + "type": "object" + }, + "ModelInfrastructureConfig": { + "additionalProperties": false, + "description": "The configuration for the infrastructure that the model will be deployed to.", + "properties": { + "InfrastructureType": { + "description": "The type of the inference experiment that you want to run.", + "enum": [ + "RealTimeInference" + ], + "type": "string" + }, + "RealTimeInferenceConfig": { + "$ref": "#/definitions/RealTimeInferenceConfig" + } + }, + "required": [ + "InfrastructureType", + "RealTimeInferenceConfig" + ], + "type": "object" + }, + "ModelVariantConfig": { + "additionalProperties": false, + "description": "Contains information about the deployment options of a model.", + "properties": { + "InfrastructureConfig": { + "$ref": "#/definitions/ModelInfrastructureConfig" + }, + "ModelName": { + "description": "The name of the Amazon SageMaker Model entity.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "VariantName": { + "description": "The name of the variant.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", + "type": "string" + } + }, + "required": [ + "ModelName", + "VariantName", + "InfrastructureConfig" + ], + "type": "object" + }, + "RealTimeInferenceConfig": { + "additionalProperties": false, + "description": "The infrastructure configuration for deploying the model to a real-time inference endpoint.", + "properties": { + "InstanceCount": { + "description": "The number of instances of the type specified by InstanceType.", + "type": "integer" + }, + "InstanceType": { + "description": "The instance type the model is deployed to.", + "type": "string" + } + }, + "required": [ + "InstanceType", + "InstanceCount" + ], + "type": "object" + }, + "ShadowModeConfig": { + "additionalProperties": false, + "description": "The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.", + "properties": { + "ShadowModelVariants": { + "description": "List of shadow variant configurations.", + "items": { + "$ref": "#/definitions/ShadowModelVariantConfig" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "SourceModelVariantName": { + "description": "The name of the production variant, which takes all the inference requests.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", + "type": "string" + } + }, + "required": [ + "SourceModelVariantName", + "ShadowModelVariants" + ], + "type": "object" + }, + "ShadowModelVariantConfig": { + "additionalProperties": false, + "description": "The name and sampling percentage of a shadow variant.", + "properties": { + "SamplingPercentage": { + "description": "The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.", + "maximum": 100, + "type": "integer" + }, + "ShadowModelVariantName": { + "description": "The name of the shadow variant.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?", + "type": "string" + } + }, + "required": [ + "ShadowModelVariantName", + "SamplingPercentage" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::InferenceExperiment", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateInferenceExperiment", + "sagemaker:DescribeInferenceExperiment", + "sagemaker:AddTags", + "sagemaker:ListTags", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteInferenceExperiment", + "sagemaker:DescribeInferenceExperiment", + "sagemaker:StopInferenceExperiment", + "sagemaker:ListTags" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListInferenceExperiments" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeInferenceExperiment", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateInferenceExperiment", + "sagemaker:StartInferenceExperiment", + "sagemaker:StopInferenceExperiment", + "sagemaker:DescribeInferenceExperiment", + "sagemaker:AddTags", + "sagemaker:DeleteTags", + "sagemaker:ListTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the inference experiment.", + "maxLength": 256, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "CreationTime": { + "description": "The timestamp at which you created the inference experiment.", + "type": "string" + }, + "DataStorageConfig": { + "$ref": "#/definitions/DataStorageConfig" + }, + "Description": { + "description": "The description of the inference experiment.", + "maxLength": 1024, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "DesiredState": { + "description": "The desired state of the experiment after starting or stopping operation.", + "enum": [ + "Running", + "Completed", + "Cancelled" + ], + "type": "string" + }, + "EndpointMetadata": { + "$ref": "#/definitions/EndpointMetadata" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "KmsKey": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "LastModifiedTime": { + "description": "The timestamp at which you last modified the inference experiment.", + "type": "string" + }, + "ModelVariants": { + "description": "An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.", + "items": { + "$ref": "#/definitions/ModelVariantConfig" + }, + "maxItems": 2, + "type": "array" + }, + "Name": { + "description": "The name for the inference experiment.", + "maxLength": 120, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/InferenceExperimentSchedule" + }, + "ShadowModeConfig": { + "$ref": "#/definitions/ShadowModeConfig" + }, + "Status": { + "description": "The status of the inference experiment.", + "enum": [ + "Creating", + "Created", + "Updating", + "Starting", + "Stopping", + "Running", + "Completed", + "Cancelled" + ], + "type": "string" + }, + "StatusReason": { + "description": "The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.", + "maxLength": 1024, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + }, + "Type": { + "description": "The type of the inference experiment that you want to run.", + "enum": [ + "ShadowMode" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreationTime", + "/properties/LastModifiedTime", + "/properties/EndpointMetadata", + "/properties/Status" + ], + "required": [ + "Name", + "Type", + "RoleArn", + "EndpointName", + "ModelVariants" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::InferenceExperiment" +} diff --git a/schema/aws-sagemaker-mlflowtrackingserver.json b/schema/aws-sagemaker-mlflowtrackingserver.json index 30696c9..32af60d 100644 --- a/schema/aws-sagemaker-mlflowtrackingserver.json +++ b/schema/aws-sagemaker-mlflowtrackingserver.json @@ -1,165 +1,165 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/MlflowVersion", - "/properties/RoleArn" - ], - "createOnlyProperties": [ - "/properties/TrackingServerName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::MlflowTrackingServer", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateMlflowTrackingServer", - "sagemaker:DescribeMlflowTrackingServer", - "sagemaker:AddTags", - "sagemaker:ListTags", - "iam:PassRole" - ], - "timeoutInMinutes": 65 - }, - "delete": { - "permissions": [ - "sagemaker:DeleteMlflowTrackingServer", - "sagemaker:DescribeMlflowTrackingServer" - ], - "timeoutInMinutes": 65 - }, - "list": { - "permissions": [ - "sagemaker:ListMlflowTrackingServers" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeMlflowTrackingServer", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateMlflowTrackingServer", - "sagemaker:DescribeMlflowTrackingServer", - "sagemaker:ListTags", - "sagemaker:AddTags", - "sagemaker:DeleteTags", - "iam:PassRole" - ], - "timeoutInMinutes": 65 - } - }, - "primaryIdentifier": [ - "/properties/TrackingServerName" - ], - "properties": { - "ArtifactStoreUri": { - "description": "The Amazon S3 URI for MLFlow Tracking Server artifacts.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^s3:\\/\\/([^\\/]+)\\/?(.*)$", - "type": "string" - }, - "AutomaticModelRegistration": { - "description": "A flag to enable Automatic SageMaker Model Registration.", - "type": "boolean" - }, - "MlflowVersion": { - "description": "The MLFlow Version used on the MLFlow Tracking Server.", - "maxLength": 32, - "minLength": 1, - "pattern": "^\\d+(\\.\\d+)+$", - "type": "string" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role\\/?[a-zA-Z_0-9+=,.@\\-_\\/]+$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, - "TrackingServerArn": { - "description": "The Amazon Resource Name (ARN) of the MLFlow Tracking Server.", - "maxLength": 2048, - "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/.*$", - "type": "string" - }, - "TrackingServerName": { - "description": "The name of the MLFlow Tracking Server.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$", - "type": "string" - }, - "TrackingServerSize": { - "description": "The size of the MLFlow Tracking Server.", - "enum": [ - "Small", - "Medium", - "Large" - ], - "type": "string" - }, - "WeeklyMaintenanceWindowStart": { - "description": "The start of the time window for maintenance of the MLFlow Tracking Server in UTC time.", - "maxLength": 9, - "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TrackingServerArn" - ], - "required": [ - "TrackingServerName", - "ArtifactStoreUri", - "RoleArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "sagemaker:AddTags", - "sagemaker:ListTags", - "sagemaker:DeleteTags" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SageMaker::MlflowTrackingServer" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/MlflowVersion", + "/properties/RoleArn" + ], + "createOnlyProperties": [ + "/properties/TrackingServerName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::MlflowTrackingServer", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateMlflowTrackingServer", + "sagemaker:DescribeMlflowTrackingServer", + "sagemaker:AddTags", + "sagemaker:ListTags", + "iam:PassRole" + ], + "timeoutInMinutes": 65 + }, + "delete": { + "permissions": [ + "sagemaker:DeleteMlflowTrackingServer", + "sagemaker:DescribeMlflowTrackingServer" + ], + "timeoutInMinutes": 65 + }, + "list": { + "permissions": [ + "sagemaker:ListMlflowTrackingServers" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeMlflowTrackingServer", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateMlflowTrackingServer", + "sagemaker:DescribeMlflowTrackingServer", + "sagemaker:ListTags", + "sagemaker:AddTags", + "sagemaker:DeleteTags", + "iam:PassRole" + ], + "timeoutInMinutes": 65 + } + }, + "primaryIdentifier": [ + "/properties/TrackingServerName" + ], + "properties": { + "ArtifactStoreUri": { + "description": "The Amazon S3 URI for MLFlow Tracking Server artifacts.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^s3:\\/\\/([^\\/]+)\\/?(.*)$", + "type": "string" + }, + "AutomaticModelRegistration": { + "description": "A flag to enable Automatic SageMaker Model Registration.", + "type": "boolean" + }, + "MlflowVersion": { + "description": "The MLFlow Version used on the MLFlow Tracking Server.", + "maxLength": 32, + "minLength": 1, + "pattern": "^\\d+(\\.\\d+)+$", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role\\/?[a-zA-Z_0-9+=,.@\\-_\\/]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "TrackingServerArn": { + "description": "The Amazon Resource Name (ARN) of the MLFlow Tracking Server.", + "maxLength": 2048, + "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/.*$", + "type": "string" + }, + "TrackingServerName": { + "description": "The name of the MLFlow Tracking Server.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$", + "type": "string" + }, + "TrackingServerSize": { + "description": "The size of the MLFlow Tracking Server.", + "enum": [ + "Small", + "Medium", + "Large" + ], + "type": "string" + }, + "WeeklyMaintenanceWindowStart": { + "description": "The start of the time window for maintenance of the MLFlow Tracking Server in UTC time.", + "maxLength": 9, + "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TrackingServerArn" + ], + "required": [ + "TrackingServerName", + "ArtifactStoreUri", + "RoleArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "sagemaker:AddTags", + "sagemaker:ListTags", + "sagemaker:DeleteTags" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::MlflowTrackingServer" +} diff --git a/schema/aws-sagemaker-model.json b/schema/aws-sagemaker-model.json index 675ec9d..00734a1 100644 --- a/schema/aws-sagemaker-model.json +++ b/schema/aws-sagemaker-model.json @@ -1,245 +1,245 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ExecutionRoleArn", - "/properties/EnableNetworkIsolation", - "/properties/InferenceExecutionConfig", - "/properties/PrimaryContainer", - "/properties/ModelName", - "/properties/VpcConfig", - "/properties/Containers" - ], - "definitions": { - "ContainerDefinition": { - "additionalProperties": false, - "properties": { - "ContainerHostname": { - "type": "string" - }, - "Environment": { - "type": "object" - }, - "Image": { - "type": "string" - }, - "ImageConfig": { - "$ref": "#/definitions/ImageConfig" - }, - "InferenceSpecificationName": { - "type": "string" - }, - "Mode": { - "type": "string" - }, - "ModelDataSource": { - "$ref": "#/definitions/ModelDataSource" - }, - "ModelDataUrl": { - "type": "string" - }, - "ModelPackageName": { - "type": "string" - }, - "MultiModelConfig": { - "$ref": "#/definitions/MultiModelConfig" - } - }, - "type": "object" - }, - "HubAccessConfig": { - "additionalProperties": false, - "properties": { - "HubContentArn": { - "type": "string" - } - }, - "required": [ - "HubContentArn" - ], - "type": "object" - }, - "ImageConfig": { - "additionalProperties": false, - "properties": { - "RepositoryAccessMode": { - "type": "string" - }, - "RepositoryAuthConfig": { - "$ref": "#/definitions/RepositoryAuthConfig" - } - }, - "required": [ - "RepositoryAccessMode" - ], - "type": "object" - }, - "InferenceExecutionConfig": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "ModelAccessConfig": { - "additionalProperties": false, - "properties": { - "AcceptEula": { - "type": "boolean" - } - }, - "required": [ - "AcceptEula" - ], - "type": "object" - }, - "ModelDataSource": { - "additionalProperties": false, - "properties": { - "S3DataSource": { - "$ref": "#/definitions/S3DataSource" - } - }, - "required": [ - "S3DataSource" - ], - "type": "object" - }, - "MultiModelConfig": { - "additionalProperties": false, - "properties": { - "ModelCacheSetting": { - "type": "string" - } - }, - "type": "object" - }, - "RepositoryAuthConfig": { - "additionalProperties": false, - "properties": { - "RepositoryCredentialsProviderArn": { - "type": "string" - } - }, - "required": [ - "RepositoryCredentialsProviderArn" - ], - "type": "object" - }, - "S3DataSource": { - "additionalProperties": false, - "properties": { - "CompressionType": { - "type": "string" - }, - "HubAccessConfig": { - "$ref": "#/definitions/HubAccessConfig" - }, - "ModelAccessConfig": { - "$ref": "#/definitions/ModelAccessConfig" - }, - "S3DataType": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "S3Uri", - "S3DataType", - "CompressionType" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Subnets", - "SecurityGroupIds" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::Model", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Containers": { - "items": { - "$ref": "#/definitions/ContainerDefinition" - }, - "type": "array", - "uniqueItems": false - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "InferenceExecutionConfig": { - "$ref": "#/definitions/InferenceExecutionConfig" - }, - "ModelName": { - "type": "string" - }, - "PrimaryContainer": { - "$ref": "#/definitions/ContainerDefinition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::SageMaker::Model" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ExecutionRoleArn", + "/properties/EnableNetworkIsolation", + "/properties/InferenceExecutionConfig", + "/properties/PrimaryContainer", + "/properties/ModelName", + "/properties/VpcConfig", + "/properties/Containers" + ], + "definitions": { + "ContainerDefinition": { + "additionalProperties": false, + "properties": { + "ContainerHostname": { + "type": "string" + }, + "Environment": { + "type": "object" + }, + "Image": { + "type": "string" + }, + "ImageConfig": { + "$ref": "#/definitions/ImageConfig" + }, + "InferenceSpecificationName": { + "type": "string" + }, + "Mode": { + "type": "string" + }, + "ModelDataSource": { + "$ref": "#/definitions/ModelDataSource" + }, + "ModelDataUrl": { + "type": "string" + }, + "ModelPackageName": { + "type": "string" + }, + "MultiModelConfig": { + "$ref": "#/definitions/MultiModelConfig" + } + }, + "type": "object" + }, + "HubAccessConfig": { + "additionalProperties": false, + "properties": { + "HubContentArn": { + "type": "string" + } + }, + "required": [ + "HubContentArn" + ], + "type": "object" + }, + "ImageConfig": { + "additionalProperties": false, + "properties": { + "RepositoryAccessMode": { + "type": "string" + }, + "RepositoryAuthConfig": { + "$ref": "#/definitions/RepositoryAuthConfig" + } + }, + "required": [ + "RepositoryAccessMode" + ], + "type": "object" + }, + "InferenceExecutionConfig": { + "additionalProperties": false, + "properties": { + "Mode": { + "type": "string" + } + }, + "required": [ + "Mode" + ], + "type": "object" + }, + "ModelAccessConfig": { + "additionalProperties": false, + "properties": { + "AcceptEula": { + "type": "boolean" + } + }, + "required": [ + "AcceptEula" + ], + "type": "object" + }, + "ModelDataSource": { + "additionalProperties": false, + "properties": { + "S3DataSource": { + "$ref": "#/definitions/S3DataSource" + } + }, + "required": [ + "S3DataSource" + ], + "type": "object" + }, + "MultiModelConfig": { + "additionalProperties": false, + "properties": { + "ModelCacheSetting": { + "type": "string" + } + }, + "type": "object" + }, + "RepositoryAuthConfig": { + "additionalProperties": false, + "properties": { + "RepositoryCredentialsProviderArn": { + "type": "string" + } + }, + "required": [ + "RepositoryCredentialsProviderArn" + ], + "type": "object" + }, + "S3DataSource": { + "additionalProperties": false, + "properties": { + "CompressionType": { + "type": "string" + }, + "HubAccessConfig": { + "$ref": "#/definitions/HubAccessConfig" + }, + "ModelAccessConfig": { + "$ref": "#/definitions/ModelAccessConfig" + }, + "S3DataType": { + "type": "string" + }, + "S3Uri": { + "type": "string" + } + }, + "required": [ + "S3Uri", + "S3DataType", + "CompressionType" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Subnets": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Subnets", + "SecurityGroupIds" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::Model", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Containers": { + "items": { + "$ref": "#/definitions/ContainerDefinition" + }, + "type": "array", + "uniqueItems": false + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "ExecutionRoleArn": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "InferenceExecutionConfig": { + "$ref": "#/definitions/InferenceExecutionConfig" + }, + "ModelName": { + "type": "string" + }, + "PrimaryContainer": { + "$ref": "#/definitions/ContainerDefinition" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::SageMaker::Model" +} diff --git a/schema/aws-sagemaker-modelbiasjobdefinition.json b/schema/aws-sagemaker-modelbiasjobdefinition.json index 64265ff..36d5bff 100644 --- a/schema/aws-sagemaker-modelbiasjobdefinition.json +++ b/schema/aws-sagemaker-modelbiasjobdefinition.json @@ -1,627 +1,627 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobDefinitionName", - "/properties/ModelBiasAppSpecification", - "/properties/ModelBiasBaselineConfig", - "/properties/ModelBiasJobInput", - "/properties/ModelBiasJobOutputConfig", - "/properties/JobResources", - "/properties/NetworkConfig", - "/properties/RoleArn", - "/properties/StoppingCondition", - "/properties/Tags", - "/properties/EndpointName" - ], - "definitions": { - "BatchTransformInput": { - "additionalProperties": false, - "description": "The batch transform input for a monitoring job.", - "properties": { - "DataCapturedDestinationS3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "DatasetFormat": { - "$ref": "#/definitions/DatasetFormat" - }, - "EndTimeOffset": { - "$ref": "#/definitions/MonitoringTimeOffsetString", - "description": "Monitoring end time offset, e.g. PT0H" - }, - "FeaturesAttribute": { - "description": "JSONpath to locate features in JSONlines dataset", - "maxLength": 256, - "type": "string" - }, - "InferenceAttribute": { - "description": "Index or JSONpath to locate predicted label(s)", - "maxLength": 256, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "ProbabilityAttribute": { - "description": "Index or JSONpath to locate probabilities", - "maxLength": 256, - "type": "string" - }, - "ProbabilityThresholdAttribute": { - "format": "double", - "type": "number" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - }, - "StartTimeOffset": { - "$ref": "#/definitions/MonitoringTimeOffsetString", - "description": "Monitoring start time offset, e.g. -PT1H" - } - }, - "required": [ - "DataCapturedDestinationS3Uri", - "DatasetFormat", - "LocalPath" - ], - "type": "object" - }, - "ClusterConfig": { - "additionalProperties": false, - "description": "Configuration for the cluster used to run model monitoring jobs.", - "properties": { - "InstanceCount": { - "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "InstanceType": { - "description": "The ML compute instance type for the processing job.", - "type": "string" - }, - "VolumeKmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", - "maximum": 2048, - "minimum": 1, - "type": "string" - }, - "VolumeSizeInGB": { - "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", - "maximum": 16384, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "ConstraintsResource": { - "additionalProperties": false, - "description": "The baseline constraints resource for a monitoring job.", - "properties": { - "S3Uri": { - "$ref": "#/definitions/S3Uri", - "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." - } - }, - "type": "object" - }, - "Csv": { - "description": "The CSV format", - "properties": { - "Header": { - "description": "A boolean flag indicating if given CSV has header", - "type": "boolean" - } - }, - "type": "object" - }, - "DatasetFormat": { - "description": "The dataset format of the data to monitor", - "properties": { - "Csv": { - "$ref": "#/definitions/Csv" - }, - "Json": { - "$ref": "#/definitions/Json" - }, - "Parquet": { - "$ref": "#/definitions/Parquet" - } - }, - "type": "object" - }, - "EndpointInput": { - "additionalProperties": false, - "description": "The endpoint for a monitoring job.", - "properties": { - "EndTimeOffset": { - "$ref": "#/definitions/MonitoringTimeOffsetString", - "description": "Monitoring end time offset, e.g. PT0H" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "FeaturesAttribute": { - "description": "JSONpath to locate features in JSONlines dataset", - "maxLength": 256, - "type": "string" - }, - "InferenceAttribute": { - "description": "Index or JSONpath to locate predicted label(s)", - "maxLength": 256, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "ProbabilityAttribute": { - "description": "Index or JSONpath to locate probabilities", - "maxLength": 256, - "type": "string" - }, - "ProbabilityThresholdAttribute": { - "format": "double", - "type": "number" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - }, - "StartTimeOffset": { - "$ref": "#/definitions/MonitoringTimeOffsetString", - "description": "Monitoring start time offset, e.g. -PT1H" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "EndpointName": { - "description": "The name of the endpoint used to run the monitoring job.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "JobDefinitionName": { - "description": "The name of the job definition.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "Json": { - "description": "The Json format", - "properties": { - "Line": { - "description": "A boolean flag indicating if it is JSON line format", - "type": "boolean" - } - }, - "type": "object" - }, - "ModelBiasAppSpecification": { - "additionalProperties": false, - "description": "Container image configuration object for the monitoring job.", - "properties": { - "ConfigUri": { - "$ref": "#/definitions/S3Uri", - "description": "The S3 URI to an analysis configuration file" - }, - "Environment": { - "additionalProperties": false, - "description": "Sets the environment variables in the Docker container", - "patternProperties": { - "[\\S\\s]*": { - "maxLength": 256, - "type": "string" - }, - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ImageUri": { - "description": "The container image to be run by the monitoring job.", - "maxLength": 255, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "ImageUri", - "ConfigUri" - ], - "type": "object" - }, - "ModelBiasBaselineConfig": { - "additionalProperties": false, - "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", - "properties": { - "BaseliningJobName": { - "$ref": "#/definitions/ProcessingJobName" - }, - "ConstraintsResource": { - "$ref": "#/definitions/ConstraintsResource" - } - }, - "type": "object" - }, - "ModelBiasJobInput": { - "additionalProperties": false, - "description": "The inputs for a monitoring job.", - "properties": { - "BatchTransformInput": { - "$ref": "#/definitions/BatchTransformInput" - }, - "EndpointInput": { - "$ref": "#/definitions/EndpointInput" - }, - "GroundTruthS3Input": { - "$ref": "#/definitions/MonitoringGroundTruthS3Input" - } - }, - "required": [ - "GroundTruthS3Input" - ], - "type": "object" - }, - "MonitoringGroundTruthS3Input": { - "additionalProperties": false, - "description": "Ground truth input provided in S3 ", - "properties": { - "S3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "MonitoringOutput": { - "additionalProperties": false, - "description": "The output object for a monitoring job.", - "properties": { - "S3Output": { - "$ref": "#/definitions/S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "MonitoringOutputConfig": { - "additionalProperties": false, - "description": "The output configuration for monitoring jobs.", - "properties": { - "KmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "MonitoringOutputs": { - "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", - "items": { - "$ref": "#/definitions/MonitoringOutput" - }, - "maxLength": 1, - "minLength": 1, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "MonitoringResources": { - "additionalProperties": false, - "description": "Identifies the resources to deploy for a monitoring job.", - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "MonitoringTimeOffsetString": { - "description": "The time offsets in ISO duration format", - "maxLength": 15, - "minLength": 1, - "pattern": "^.?P.*", - "type": "string" - }, - "NetworkConfig": { - "additionalProperties": false, - "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", - "properties": { - "EnableInterContainerTrafficEncryption": { - "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", - "type": "boolean" - }, - "EnableNetworkIsolation": { - "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "type": "object" - }, - "Parquet": { - "description": "A flag indicate if the dataset format is Parquet", - "type": "boolean" - }, - "ProcessingJobName": { - "description": "The name of a processing job", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "S3Output": { - "additionalProperties": false, - "description": "Information about where and how to store the results of a monitoring job.", - "properties": { - "LocalPath": { - "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3UploadMode": { - "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", - "enum": [ - "Continuous", - "EndOfJob" - ], - "type": "string" - }, - "S3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "S3Uri": { - "description": "The Amazon S3 URI.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "StoppingCondition": { - "additionalProperties": false, - "description": "Specifies a time limit for how long the monitoring job is allowed to run.", - "properties": { - "MaxRuntimeInSeconds": { - "description": "The maximum runtime allowed in seconds.", - "maximum": 86400, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", - "properties": { - "SecurityGroupIds": { - "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Subnets": { - "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::ModelBiasJobDefinition", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateModelBiasJobDefinition", - "sagemaker:DescribeModelBiasJobDefinition", - "iam:PassRole", - "sagemaker:AddTags" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteModelBiasJobDefinition" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListModelBiasJobDefinitions", - "sagemaker:ListTags" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeModelBiasJobDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobDefinitionArn" - ], - "properties": { - "CreationTime": { - "description": "The time at which the job definition was created.", - "type": "string" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "JobDefinitionArn": { - "description": "The Amazon Resource Name (ARN) of job definition.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "JobDefinitionName": { - "$ref": "#/definitions/JobDefinitionName" - }, - "JobResources": { - "$ref": "#/definitions/MonitoringResources" - }, - "ModelBiasAppSpecification": { - "$ref": "#/definitions/ModelBiasAppSpecification" - }, - "ModelBiasBaselineConfig": { - "$ref": "#/definitions/ModelBiasBaselineConfig" - }, - "ModelBiasJobInput": { - "$ref": "#/definitions/ModelBiasJobInput" - }, - "ModelBiasJobOutputConfig": { - "$ref": "#/definitions/MonitoringOutputConfig" - }, - "NetworkConfig": { - "$ref": "#/definitions/NetworkConfig" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/StoppingCondition" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/JobDefinitionArn" - ], - "required": [ - "ModelBiasAppSpecification", - "ModelBiasJobInput", - "ModelBiasJobOutputConfig", - "JobResources", - "RoleArn" - ], - "typeName": "AWS::SageMaker::ModelBiasJobDefinition", - "writeOnlyProperties": [ - "/properties/EndpointName", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/JobDefinitionName", + "/properties/ModelBiasAppSpecification", + "/properties/ModelBiasBaselineConfig", + "/properties/ModelBiasJobInput", + "/properties/ModelBiasJobOutputConfig", + "/properties/JobResources", + "/properties/NetworkConfig", + "/properties/RoleArn", + "/properties/StoppingCondition", + "/properties/Tags", + "/properties/EndpointName" + ], + "definitions": { + "BatchTransformInput": { + "additionalProperties": false, + "description": "The batch transform input for a monitoring job.", + "properties": { + "DataCapturedDestinationS3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "DatasetFormat": { + "$ref": "#/definitions/DatasetFormat" + }, + "EndTimeOffset": { + "$ref": "#/definitions/MonitoringTimeOffsetString", + "description": "Monitoring end time offset, e.g. PT0H" + }, + "FeaturesAttribute": { + "description": "JSONpath to locate features in JSONlines dataset", + "maxLength": 256, + "type": "string" + }, + "InferenceAttribute": { + "description": "Index or JSONpath to locate predicted label(s)", + "maxLength": 256, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "ProbabilityAttribute": { + "description": "Index or JSONpath to locate probabilities", + "maxLength": 256, + "type": "string" + }, + "ProbabilityThresholdAttribute": { + "format": "double", + "type": "number" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + }, + "StartTimeOffset": { + "$ref": "#/definitions/MonitoringTimeOffsetString", + "description": "Monitoring start time offset, e.g. -PT1H" + } + }, + "required": [ + "DataCapturedDestinationS3Uri", + "DatasetFormat", + "LocalPath" + ], + "type": "object" + }, + "ClusterConfig": { + "additionalProperties": false, + "description": "Configuration for the cluster used to run model monitoring jobs.", + "properties": { + "InstanceCount": { + "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "InstanceType": { + "description": "The ML compute instance type for the processing job.", + "type": "string" + }, + "VolumeKmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", + "maximum": 2048, + "minimum": 1, + "type": "string" + }, + "VolumeSizeInGB": { + "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", + "maximum": 16384, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "InstanceCount", + "InstanceType", + "VolumeSizeInGB" + ], + "type": "object" + }, + "ConstraintsResource": { + "additionalProperties": false, + "description": "The baseline constraints resource for a monitoring job.", + "properties": { + "S3Uri": { + "$ref": "#/definitions/S3Uri", + "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." + } + }, + "type": "object" + }, + "Csv": { + "description": "The CSV format", + "properties": { + "Header": { + "description": "A boolean flag indicating if given CSV has header", + "type": "boolean" + } + }, + "type": "object" + }, + "DatasetFormat": { + "description": "The dataset format of the data to monitor", + "properties": { + "Csv": { + "$ref": "#/definitions/Csv" + }, + "Json": { + "$ref": "#/definitions/Json" + }, + "Parquet": { + "$ref": "#/definitions/Parquet" + } + }, + "type": "object" + }, + "EndpointInput": { + "additionalProperties": false, + "description": "The endpoint for a monitoring job.", + "properties": { + "EndTimeOffset": { + "$ref": "#/definitions/MonitoringTimeOffsetString", + "description": "Monitoring end time offset, e.g. PT0H" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "FeaturesAttribute": { + "description": "JSONpath to locate features in JSONlines dataset", + "maxLength": 256, + "type": "string" + }, + "InferenceAttribute": { + "description": "Index or JSONpath to locate predicted label(s)", + "maxLength": 256, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "ProbabilityAttribute": { + "description": "Index or JSONpath to locate probabilities", + "maxLength": 256, + "type": "string" + }, + "ProbabilityThresholdAttribute": { + "format": "double", + "type": "number" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + }, + "StartTimeOffset": { + "$ref": "#/definitions/MonitoringTimeOffsetString", + "description": "Monitoring start time offset, e.g. -PT1H" + } + }, + "required": [ + "EndpointName", + "LocalPath" + ], + "type": "object" + }, + "EndpointName": { + "description": "The name of the endpoint used to run the monitoring job.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "JobDefinitionName": { + "description": "The name of the job definition.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "Json": { + "description": "The Json format", + "properties": { + "Line": { + "description": "A boolean flag indicating if it is JSON line format", + "type": "boolean" + } + }, + "type": "object" + }, + "ModelBiasAppSpecification": { + "additionalProperties": false, + "description": "Container image configuration object for the monitoring job.", + "properties": { + "ConfigUri": { + "$ref": "#/definitions/S3Uri", + "description": "The S3 URI to an analysis configuration file" + }, + "Environment": { + "additionalProperties": false, + "description": "Sets the environment variables in the Docker container", + "patternProperties": { + "[\\S\\s]*": { + "maxLength": 256, + "type": "string" + }, + "[a-zA-Z_][a-zA-Z0-9_]*": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ImageUri": { + "description": "The container image to be run by the monitoring job.", + "maxLength": 255, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "ImageUri", + "ConfigUri" + ], + "type": "object" + }, + "ModelBiasBaselineConfig": { + "additionalProperties": false, + "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", + "properties": { + "BaseliningJobName": { + "$ref": "#/definitions/ProcessingJobName" + }, + "ConstraintsResource": { + "$ref": "#/definitions/ConstraintsResource" + } + }, + "type": "object" + }, + "ModelBiasJobInput": { + "additionalProperties": false, + "description": "The inputs for a monitoring job.", + "properties": { + "BatchTransformInput": { + "$ref": "#/definitions/BatchTransformInput" + }, + "EndpointInput": { + "$ref": "#/definitions/EndpointInput" + }, + "GroundTruthS3Input": { + "$ref": "#/definitions/MonitoringGroundTruthS3Input" + } + }, + "required": [ + "GroundTruthS3Input" + ], + "type": "object" + }, + "MonitoringGroundTruthS3Input": { + "additionalProperties": false, + "description": "Ground truth input provided in S3 ", + "properties": { + "S3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "S3Uri" + ], + "type": "object" + }, + "MonitoringOutput": { + "additionalProperties": false, + "description": "The output object for a monitoring job.", + "properties": { + "S3Output": { + "$ref": "#/definitions/S3Output" + } + }, + "required": [ + "S3Output" + ], + "type": "object" + }, + "MonitoringOutputConfig": { + "additionalProperties": false, + "description": "The output configuration for monitoring jobs.", + "properties": { + "KmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "MonitoringOutputs": { + "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", + "items": { + "$ref": "#/definitions/MonitoringOutput" + }, + "maxLength": 1, + "minLength": 1, + "type": "array" + } + }, + "required": [ + "MonitoringOutputs" + ], + "type": "object" + }, + "MonitoringResources": { + "additionalProperties": false, + "description": "Identifies the resources to deploy for a monitoring job.", + "properties": { + "ClusterConfig": { + "$ref": "#/definitions/ClusterConfig" + } + }, + "required": [ + "ClusterConfig" + ], + "type": "object" + }, + "MonitoringTimeOffsetString": { + "description": "The time offsets in ISO duration format", + "maxLength": 15, + "minLength": 1, + "pattern": "^.?P.*", + "type": "string" + }, + "NetworkConfig": { + "additionalProperties": false, + "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", + "properties": { + "EnableInterContainerTrafficEncryption": { + "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", + "type": "boolean" + }, + "EnableNetworkIsolation": { + "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", + "type": "boolean" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "type": "object" + }, + "Parquet": { + "description": "A flag indicate if the dataset format is Parquet", + "type": "boolean" + }, + "ProcessingJobName": { + "description": "The name of a processing job", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "S3Output": { + "additionalProperties": false, + "description": "Information about where and how to store the results of a monitoring job.", + "properties": { + "LocalPath": { + "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "S3UploadMode": { + "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", + "enum": [ + "Continuous", + "EndOfJob" + ], + "type": "string" + }, + "S3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "LocalPath", + "S3Uri" + ], + "type": "object" + }, + "S3Uri": { + "description": "The Amazon S3 URI.", + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "StoppingCondition": { + "additionalProperties": false, + "description": "Specifies a time limit for how long the monitoring job is allowed to run.", + "properties": { + "MaxRuntimeInSeconds": { + "description": "The maximum runtime allowed in seconds.", + "maximum": 86400, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxRuntimeInSeconds" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", + "properties": { + "SecurityGroupIds": { + "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subnets": { + "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::ModelBiasJobDefinition", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateModelBiasJobDefinition", + "sagemaker:DescribeModelBiasJobDefinition", + "iam:PassRole", + "sagemaker:AddTags" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteModelBiasJobDefinition" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListModelBiasJobDefinitions", + "sagemaker:ListTags" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeModelBiasJobDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/JobDefinitionArn" + ], + "properties": { + "CreationTime": { + "description": "The time at which the job definition was created.", + "type": "string" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "JobDefinitionArn": { + "description": "The Amazon Resource Name (ARN) of job definition.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "JobDefinitionName": { + "$ref": "#/definitions/JobDefinitionName" + }, + "JobResources": { + "$ref": "#/definitions/MonitoringResources" + }, + "ModelBiasAppSpecification": { + "$ref": "#/definitions/ModelBiasAppSpecification" + }, + "ModelBiasBaselineConfig": { + "$ref": "#/definitions/ModelBiasBaselineConfig" + }, + "ModelBiasJobInput": { + "$ref": "#/definitions/ModelBiasJobInput" + }, + "ModelBiasJobOutputConfig": { + "$ref": "#/definitions/MonitoringOutputConfig" + }, + "NetworkConfig": { + "$ref": "#/definitions/NetworkConfig" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "StoppingCondition": { + "$ref": "#/definitions/StoppingCondition" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/JobDefinitionArn" + ], + "required": [ + "ModelBiasAppSpecification", + "ModelBiasJobInput", + "ModelBiasJobOutputConfig", + "JobResources", + "RoleArn" + ], + "typeName": "AWS::SageMaker::ModelBiasJobDefinition", + "writeOnlyProperties": [ + "/properties/EndpointName", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-sagemaker-modelcard.json b/schema/aws-sagemaker-modelcard.json index b3bb073..31bf1de 100644 --- a/schema/aws-sagemaker-modelcard.json +++ b/schema/aws-sagemaker-modelcard.json @@ -1,1030 +1,1030 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ModelCardName", - "/properties/SecurityConfig" - ], - "definitions": { - "AdditionalInformation": { - "additionalProperties": false, - "properties": { - "CaveatsAndRecommendations": { - "description": "Caveats and recommendations for people who might use this model in their applications.", - "maxLength": 2048, - "type": "string" - }, - "CustomDetails": { - "additionalProperties": false, - "description": "customer details.", - "patternProperties": { - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "EthicalConsiderations": { - "description": "Any ethical considerations that the author wants to provide.", - "maxLength": 2048, - "type": "string" - } - }, - "type": "object" - }, - "AxisNameArray": { - "insertionOrder": true, - "items": { - "maxLength": 63, - "type": "string" - }, - "type": "array" - }, - "AxisNameString": { - "maxLength": 63, - "type": "string" - }, - "BarChartMetric": { - "additionalProperties": false, - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - }, - "Type": { - "enum": [ - "bar_chart" - ], - "type": "string" - }, - "Value": { - "anyOf": [ - { - "insertionOrder": true, - "items": { - "type": "number" - }, - "minItems": 1, - "type": "array" - } - ] - }, - "XAxisName": { - "$ref": "#/definitions/AxisNameArray" - }, - "YAxisName": { - "$ref": "#/definitions/AxisNameString" - } - }, - "required": [ - "Name", - "Type", - "Value" - ], - "type": "object" - }, - "BusinessDetails": { - "additionalProperties": false, - "description": "Business details.", - "properties": { - "BusinessProblem": { - "description": "What business problem does the model solve?", - "maxLength": 2048, - "type": "string" - }, - "BusinessStakeholders": { - "description": "Business stakeholders.", - "maxLength": 2048, - "type": "string" - }, - "LineOfBusiness": { - "description": "Line of business.", - "maxLength": 2048, - "type": "string" - } - }, - "type": "object" - }, - "Container": { - "additionalProperties": false, - "properties": { - "Image": { - "description": "Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.", - "maxLength": 255, - "type": "string" - }, - "ModelDataUrl": { - "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored.", - "maxLength": 1024, - "type": "string" - }, - "NearestModelName": { - "description": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.", - "type": "string" - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "Content": { - "additionalProperties": false, - "description": "The content of the model card.", - "properties": { - "AdditionalInformation": { - "$ref": "#/definitions/AdditionalInformation" - }, - "BusinessDetails": { - "$ref": "#/definitions/BusinessDetails" - }, - "EvaluationDetails": { - "$ref": "#/definitions/EvaluationDetails" - }, - "IntendedUses": { - "$ref": "#/definitions/IntendedUses" - }, - "ModelOverview": { - "$ref": "#/definitions/ModelOverview" - }, - "ModelPackageDetails": { - "$ref": "#/definitions/ModelPackageDetails" - }, - "TrainingDetails": { - "$ref": "#/definitions/TrainingDetails" - } - }, - "type": "object" - }, - "EvaluationDetail": { - "additionalProperties": false, - "description": "item of evaluation details", - "properties": { - "Datasets": { - "insertionOrder": true, - "items": { - "maxLength": 1024, - "type": "string" - }, - "maxItems": 10, - "type": "array" - }, - "EvaluationJobArn": { - "maxLength": 256, - "type": "string" - }, - "EvaluationObservation": { - "maxLength": 2096, - "type": "string" - }, - "Metadata": { - "additionalProperties": false, - "description": "additional attributes associated with the evaluation results.", - "patternProperties": { - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "MetricGroups": { - "default": [], - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MetricGroup" - }, - "type": "array" - }, - "Name": { - "pattern": ".{1,63}", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "EvaluationDetails": { - "default": [], - "insertionOrder": true, - "items": { - "$ref": "#/definitions/EvaluationDetail" - }, - "type": "array" - }, - "InferenceSpecification": { - "additionalProperties": false, - "properties": { - "Containers": { - "description": "Contains inference related information which were used to create model package.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Container" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Containers" - ], - "type": "object" - }, - "IntendedUses": { - "additionalProperties": false, - "description": "Intended usage of model.", - "properties": { - "ExplanationsForRiskRating": { - "maxLength": 2048, - "type": "string" - }, - "FactorsAffectingModelEfficiency": { - "maxLength": 2048, - "type": "string" - }, - "IntendedUses": { - "description": "intended use cases.", - "maxLength": 2048, - "type": "string" - }, - "PurposeOfModel": { - "description": "Why the model was developed?", - "maxLength": 2048, - "type": "string" - }, - "RiskRating": { - "$ref": "#/definitions/RiskRating" - } - }, - "type": "object" - }, - "LinearGraphMetric": { - "additionalProperties": false, - "description": "Linear graph metric.", - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - }, - "Type": { - "enum": [ - "linear_graph" - ], - "type": "string" - }, - "Value": { - "anyOf": [ - { - "insertionOrder": true, - "items": { - "insertionOrder": true, - "items": { - "type": "number" - }, - "maxItems": 2, - "minItems": 2, - "type": "array" - }, - "minItems": 1, - "type": "array" - } - ] - }, - "XAxisName": { - "$ref": "#/definitions/AxisNameString" - }, - "YAxisName": { - "$ref": "#/definitions/AxisNameString" - } - }, - "required": [ - "Name", - "Type", - "Value" - ], - "type": "object" - }, - "MatrixMetric": { - "additionalProperties": false, - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - }, - "Type": { - "enum": [ - "matrix" - ], - "type": "string" - }, - "Value": { - "anyOf": [ - { - "insertionOrder": true, - "items": { - "insertionOrder": true, - "items": { - "type": "number" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - } - ] - }, - "XAxisName": { - "$ref": "#/definitions/AxisNameArray" - }, - "YAxisName": { - "$ref": "#/definitions/AxisNameArray" - } - }, - "required": [ - "Name", - "Type", - "Value" - ], - "type": "object" - }, - "MetricGroup": { - "additionalProperties": false, - "description": "item in metric groups", - "properties": { - "MetricData": { - "insertionOrder": true, - "items": { - "anyOf": [ - { - "$ref": "#/definitions/SimpleMetric" - }, - { - "$ref": "#/definitions/LinearGraphMetric" - }, - { - "$ref": "#/definitions/BarChartMetric" - }, - { - "$ref": "#/definitions/MatrixMetric" - } - ] - }, - "type": "array" - }, - "Name": { - "pattern": ".{1,63}", - "type": "string" - } - }, - "required": [ - "Name", - "MetricData" - ], - "type": "object" - }, - "ModelOverview": { - "additionalProperties": false, - "description": "Overview about the model.", - "properties": { - "AlgorithmType": { - "description": "Algorithm used to solve the problem.", - "maxLength": 1024, - "type": "string" - }, - "InferenceEnvironment": { - "additionalProperties": false, - "description": "Overview about the inference.", - "properties": { - "ContainerImage": { - "description": "SageMaker inference image uri.", - "insertionOrder": true, - "items": { - "maxLength": 1024, - "type": "string" - }, - "maxItems": 15, - "type": "array" - } - }, - "type": "object" - }, - "ModelArtifact": { - "description": "Location of the model artifact.", - "insertionOrder": true, - "items": { - "maxLength": 1024, - "type": "string" - }, - "maxItems": 15, - "type": "array" - }, - "ModelCreator": { - "description": "Creator of model.", - "maxLength": 1024, - "type": "string" - }, - "ModelDescription": { - "description": "description of model.", - "maxLength": 1024, - "type": "string" - }, - "ModelId": { - "description": "SageMaker Model Arn or Non SageMaker Model id.", - "maxLength": 1024, - "type": "string" - }, - "ModelName": { - "description": "Name of the model.", - "maxLength": 1024, - "type": "string" - }, - "ModelOwner": { - "description": "Owner of model.", - "maxLength": 1024, - "type": "string" - }, - "ModelVersion": { - "description": "Version of the model.", - "minimum": 1, - "type": "number" - }, - "ProblemType": { - "description": "Problem being solved with the model.", - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "ModelPackageCreator": { - "additionalProperties": false, - "properties": { - "UserProfileName": { - "description": "The name of the user's profile in Studio", - "maxLength": 63, - "type": "string" - } - }, - "type": "object" - }, - "ModelPackageDetails": { - "additionalProperties": false, - "description": "Metadata information related to model package version", - "properties": { - "ApprovalDescription": { - "description": "A description provided for the model approval", - "maxLength": 1024, - "type": "string" - }, - "CreatedBy": { - "$ref": "#/definitions/ModelPackageCreator", - "description": "Information about the user who created model package." - }, - "Domain": { - "description": "The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.", - "type": "string" - }, - "InferenceSpecification": { - "$ref": "#/definitions/InferenceSpecification", - "description": "Details about inference jobs that can be run with models based on this model package." - }, - "ModelApprovalStatus": { - "description": "Current approval status of model package", - "enum": [ - "Approved", - "Rejected", - "PendingManualApproval" - ], - "type": "string" - }, - "ModelPackageArn": { - "description": "The Amazon Resource Name (ARN) of the model package", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ModelPackageDescription": { - "description": "A brief summary of the model package", - "maxLength": 1024, - "type": "string" - }, - "ModelPackageGroupName": { - "description": "If the model is a versioned model, the name of the model group that the versioned model belongs to.", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "ModelPackageName": { - "description": "Name of the model package", - "maxLength": 63, - "minLength": 1, - "type": "string" - }, - "ModelPackageStatus": { - "description": "Current status of model package", - "enum": [ - "Pending", - "InProgress", - "Completed", - "Failed", - "Deleting" - ], - "type": "string" - }, - "ModelPackageVersion": { - "description": "Version of the model package", - "minimum": 1.0, - "type": "number" - }, - "SourceAlgorithms": { - "$ref": "#/definitions/SourceAlgorithms", - "description": "A list of algorithms that were used to create a model package." - }, - "Task": { - "description": "The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.", - "type": "string" - } - }, - "type": "object" - }, - "ObjectiveFunction": { - "additionalProperties": false, - "description": "the objective function the model will optimize for.", - "properties": { - "Function": { - "additionalProperties": false, - "description": "objective function that training job is optimized for.", - "properties": { - "Condition": { - "maxLength": 63, - "type": "string" - }, - "Facet": { - "maxLength": 63, - "type": "string" - }, - "Function": { - "enum": [ - "Maximize", - "Minimize" - ], - "type": "string" - } - }, - "type": "object" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "RiskRating": { - "description": "Risk rating of model.", - "enum": [ - "High", - "Medium", - "Low", - "Unknown" - ], - "type": "string" - }, - "SecurityConfig": { - "additionalProperties": false, - "description": "An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.\n\n", - "properties": { - "KmsKeyId": { - "description": "A Key Management Service key ID to use for encrypting a model card.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "SimpleMetric": { - "additionalProperties": false, - "description": "metric data", - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - }, - "Type": { - "enum": [ - "number", - "string", - "boolean" - ], - "type": "string" - }, - "Value": { - "anyOf": [ - { - "type": "number" - }, - { - "maxLength": 63, - "type": "string" - }, - { - "type": "boolean" - } - ] - }, - "XAxisName": { - "$ref": "#/definitions/AxisNameString" - }, - "YAxisName": { - "$ref": "#/definitions/AxisNameString" - } - }, - "required": [ - "Name", - "Type", - "Value" - ], - "type": "object" - }, - "SourceAlgorithm": { - "additionalProperties": false, - "properties": { - "AlgorithmName": { - "description": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.", - "maxLength": 170, - "type": "string" - }, - "ModelDataUrl": { - "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored.", - "maxLength": 1024, - "type": "string" - } - }, - "required": [ - "AlgorithmName" - ], - "type": "object" - }, - "SourceAlgorithms": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SourceAlgorithm" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The tag key. Tag keys must be unique per resource.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The tag value.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TrainingDetails": { - "additionalProperties": false, - "description": "Overview about the training.", - "properties": { - "ObjectiveFunction": { - "$ref": "#/definitions/ObjectiveFunction" - }, - "TrainingJobDetails": { - "additionalProperties": false, - "properties": { - "HyperParameters": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TrainingHyperParameter", - "maxItems": 100 - }, - "type": "array" - }, - "TrainingArn": { - "description": "SageMaker Training job arn.", - "maxLength": 1024, - "type": "string" - }, - "TrainingDatasets": { - "description": "Location of the model datasets.", - "insertionOrder": true, - "items": { - "maxLength": 1024, - "type": "string" - }, - "maxItems": 15, - "type": "array" - }, - "TrainingEnvironment": { - "additionalProperties": false, - "properties": { - "ContainerImage": { - "description": "SageMaker training image uri.", - "insertionOrder": true, - "items": { - "maxLength": 1024, - "type": "string" - }, - "maxItems": 15, - "type": "array" - } - }, - "type": "object" - }, - "TrainingMetrics": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TrainingMetric", - "maxItems": 50 - }, - "type": "array" - }, - "UserProvidedHyperParameters": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TrainingHyperParameter", - "maxItems": 100 - }, - "type": "array" - }, - "UserProvidedTrainingMetrics": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TrainingMetric", - "maxItems": 50 - }, - "type": "array" - } - }, - "type": "object" - }, - "TrainingObservations": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "TrainingHyperParameter": { - "additionalProperties": false, - "description": "training hyper parameter", - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Value": { - "pattern": ".{1,255}", - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "TrainingMetric": { - "additionalProperties": false, - "description": "training metric data.", - "properties": { - "Name": { - "pattern": ".{1,255}", - "type": "string" - }, - "Notes": { - "maxLength": 1024, - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "UserContext": { - "additionalProperties": false, - "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.", - "properties": { - "DomainId": { - "default": "UnsetValue", - "description": "The domain associated with the user.", - "type": "string" - }, - "UserProfileArn": { - "default": "UnsetValue", - "description": "The Amazon Resource Name (ARN) of the user's profile.", - "type": "string" - }, - "UserProfileName": { - "default": "UnsetValue", - "description": "The name of the user's profile.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::ModelCard.", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateModelCard", - "sagemaker:DescribeModel", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:CreateGrant", - "sagemaker:DescribeModelPackageGroup", - "sagemaker:DescribeModelPackage", - "sagemaker:AddTags" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DescribeModelCard", - "sagemaker:DeleteModelCard", - "sagemaker:DescribeModelPackageGroup", - "sagemaker:DescribeModelPackage", - "kms:RetireGrant", - "kms:Decrypt", - "sagemaker:ListTags", - "sagemaker:DeleteTags" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListModelCards", - "sagemaker:ListModelCardVersions" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeModelCard", - "sagemaker:DescribeModelPackageGroup", - "sagemaker:DescribeModelPackage", - "kms:Decrypt", - "sagemaker:ListTags" - ] - }, - "update": { - "permissions": [ - "sagemaker:UpdateModelCard", - "sagemaker:DescribeModelCard", - "sagemaker:DescribeModel", - "kms:GenerateDataKey", - "kms:Decrypt", - "sagemaker:DescribeModelPackageGroup", - "sagemaker:DescribeModelPackage", - "sagemaker:ListTags", - "sagemaker:AddTags", - "sagemaker:DeleteTags" - ] - } - }, - "primaryIdentifier": [ - "/properties/ModelCardName" - ], - "properties": { - "Content": { - "$ref": "#/definitions/Content" - }, - "CreatedBy": { - "$ref": "#/definitions/UserContext", - "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." - }, - "CreationTime": { - "description": "The date and time the model card was created.", - "type": "string" - }, - "LastModifiedBy": { - "$ref": "#/definitions/UserContext", - "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." - }, - "LastModifiedTime": { - "description": "The date and time the model card was last modified.", - "type": "string" - }, - "ModelCardArn": { - "description": "The Amazon Resource Name (ARN) of the successfully created model card.", - "maxLength": 256, - "minLength": 1, - "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "ModelCardName": { - "description": "The unique name of the model card.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "ModelCardProcessingStatus": { - "default": "UnsetValue", - "description": "The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.", - "enum": [ - "UnsetValue", - "DeleteInProgress", - "DeletePending", - "ContentDeleted", - "ExportJobsDeleted", - "DeleteCompleted", - "DeleteFailed" - ], - "type": "string" - }, - "ModelCardStatus": { - "description": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.", - "enum": [ - "Draft", - "PendingReview", - "Approved", - "Archived" - ], - "type": "string" - }, - "ModelCardVersion": { - "description": "A version of the model card.", - "minimum": 1, - "type": "integer" - }, - "SecurityConfig": { - "$ref": "#/definitions/SecurityConfig" - }, - "Tags": { - "description": "Key-value pairs used to manage metadata for model cards.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ModelCardArn", - "/properties/ModelCardVersion", - "/properties/CreatedBy/DomainId", - "/properties/CreatedBy/UserProfileArn", - "/properties/CreatedBy/UserProfileName", - "/properties/LastModifiedBy/DomainId", - "/properties/LastModifiedBy/UserProfileArn", - "/properties/LastModifiedBy/UserProfileName", - "/properties/CreationTime", - "/properties/LastModifiedTime", - "/properties/ModelCardProcessingStatus" - ], - "required": [ - "ModelCardName", - "Content", - "ModelCardStatus" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SageMaker::ModelCard" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ModelCardName", + "/properties/SecurityConfig" + ], + "definitions": { + "AdditionalInformation": { + "additionalProperties": false, + "properties": { + "CaveatsAndRecommendations": { + "description": "Caveats and recommendations for people who might use this model in their applications.", + "maxLength": 2048, + "type": "string" + }, + "CustomDetails": { + "additionalProperties": false, + "description": "customer details.", + "patternProperties": { + "[a-zA-Z_][a-zA-Z0-9_]*": { + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "EthicalConsiderations": { + "description": "Any ethical considerations that the author wants to provide.", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + }, + "AxisNameArray": { + "insertionOrder": true, + "items": { + "maxLength": 63, + "type": "string" + }, + "type": "array" + }, + "AxisNameString": { + "maxLength": 63, + "type": "string" + }, + "BarChartMetric": { + "additionalProperties": false, + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + }, + "Type": { + "enum": [ + "bar_chart" + ], + "type": "string" + }, + "Value": { + "anyOf": [ + { + "insertionOrder": true, + "items": { + "type": "number" + }, + "minItems": 1, + "type": "array" + } + ] + }, + "XAxisName": { + "$ref": "#/definitions/AxisNameArray" + }, + "YAxisName": { + "$ref": "#/definitions/AxisNameString" + } + }, + "required": [ + "Name", + "Type", + "Value" + ], + "type": "object" + }, + "BusinessDetails": { + "additionalProperties": false, + "description": "Business details.", + "properties": { + "BusinessProblem": { + "description": "What business problem does the model solve?", + "maxLength": 2048, + "type": "string" + }, + "BusinessStakeholders": { + "description": "Business stakeholders.", + "maxLength": 2048, + "type": "string" + }, + "LineOfBusiness": { + "description": "Line of business.", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + }, + "Container": { + "additionalProperties": false, + "properties": { + "Image": { + "description": "Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.", + "maxLength": 255, + "type": "string" + }, + "ModelDataUrl": { + "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored.", + "maxLength": 1024, + "type": "string" + }, + "NearestModelName": { + "description": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.", + "type": "string" + } + }, + "required": [ + "Image" + ], + "type": "object" + }, + "Content": { + "additionalProperties": false, + "description": "The content of the model card.", + "properties": { + "AdditionalInformation": { + "$ref": "#/definitions/AdditionalInformation" + }, + "BusinessDetails": { + "$ref": "#/definitions/BusinessDetails" + }, + "EvaluationDetails": { + "$ref": "#/definitions/EvaluationDetails" + }, + "IntendedUses": { + "$ref": "#/definitions/IntendedUses" + }, + "ModelOverview": { + "$ref": "#/definitions/ModelOverview" + }, + "ModelPackageDetails": { + "$ref": "#/definitions/ModelPackageDetails" + }, + "TrainingDetails": { + "$ref": "#/definitions/TrainingDetails" + } + }, + "type": "object" + }, + "EvaluationDetail": { + "additionalProperties": false, + "description": "item of evaluation details", + "properties": { + "Datasets": { + "insertionOrder": true, + "items": { + "maxLength": 1024, + "type": "string" + }, + "maxItems": 10, + "type": "array" + }, + "EvaluationJobArn": { + "maxLength": 256, + "type": "string" + }, + "EvaluationObservation": { + "maxLength": 2096, + "type": "string" + }, + "Metadata": { + "additionalProperties": false, + "description": "additional attributes associated with the evaluation results.", + "patternProperties": { + "[a-zA-Z_][a-zA-Z0-9_]*": { + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "MetricGroups": { + "default": [], + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricGroup" + }, + "type": "array" + }, + "Name": { + "pattern": ".{1,63}", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "EvaluationDetails": { + "default": [], + "insertionOrder": true, + "items": { + "$ref": "#/definitions/EvaluationDetail" + }, + "type": "array" + }, + "InferenceSpecification": { + "additionalProperties": false, + "properties": { + "Containers": { + "description": "Contains inference related information which were used to create model package.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Container" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Containers" + ], + "type": "object" + }, + "IntendedUses": { + "additionalProperties": false, + "description": "Intended usage of model.", + "properties": { + "ExplanationsForRiskRating": { + "maxLength": 2048, + "type": "string" + }, + "FactorsAffectingModelEfficiency": { + "maxLength": 2048, + "type": "string" + }, + "IntendedUses": { + "description": "intended use cases.", + "maxLength": 2048, + "type": "string" + }, + "PurposeOfModel": { + "description": "Why the model was developed?", + "maxLength": 2048, + "type": "string" + }, + "RiskRating": { + "$ref": "#/definitions/RiskRating" + } + }, + "type": "object" + }, + "LinearGraphMetric": { + "additionalProperties": false, + "description": "Linear graph metric.", + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + }, + "Type": { + "enum": [ + "linear_graph" + ], + "type": "string" + }, + "Value": { + "anyOf": [ + { + "insertionOrder": true, + "items": { + "insertionOrder": true, + "items": { + "type": "number" + }, + "maxItems": 2, + "minItems": 2, + "type": "array" + }, + "minItems": 1, + "type": "array" + } + ] + }, + "XAxisName": { + "$ref": "#/definitions/AxisNameString" + }, + "YAxisName": { + "$ref": "#/definitions/AxisNameString" + } + }, + "required": [ + "Name", + "Type", + "Value" + ], + "type": "object" + }, + "MatrixMetric": { + "additionalProperties": false, + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + }, + "Type": { + "enum": [ + "matrix" + ], + "type": "string" + }, + "Value": { + "anyOf": [ + { + "insertionOrder": true, + "items": { + "insertionOrder": true, + "items": { + "type": "number" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + } + ] + }, + "XAxisName": { + "$ref": "#/definitions/AxisNameArray" + }, + "YAxisName": { + "$ref": "#/definitions/AxisNameArray" + } + }, + "required": [ + "Name", + "Type", + "Value" + ], + "type": "object" + }, + "MetricGroup": { + "additionalProperties": false, + "description": "item in metric groups", + "properties": { + "MetricData": { + "insertionOrder": true, + "items": { + "anyOf": [ + { + "$ref": "#/definitions/SimpleMetric" + }, + { + "$ref": "#/definitions/LinearGraphMetric" + }, + { + "$ref": "#/definitions/BarChartMetric" + }, + { + "$ref": "#/definitions/MatrixMetric" + } + ] + }, + "type": "array" + }, + "Name": { + "pattern": ".{1,63}", + "type": "string" + } + }, + "required": [ + "Name", + "MetricData" + ], + "type": "object" + }, + "ModelOverview": { + "additionalProperties": false, + "description": "Overview about the model.", + "properties": { + "AlgorithmType": { + "description": "Algorithm used to solve the problem.", + "maxLength": 1024, + "type": "string" + }, + "InferenceEnvironment": { + "additionalProperties": false, + "description": "Overview about the inference.", + "properties": { + "ContainerImage": { + "description": "SageMaker inference image uri.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "type": "string" + }, + "maxItems": 15, + "type": "array" + } + }, + "type": "object" + }, + "ModelArtifact": { + "description": "Location of the model artifact.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "type": "string" + }, + "maxItems": 15, + "type": "array" + }, + "ModelCreator": { + "description": "Creator of model.", + "maxLength": 1024, + "type": "string" + }, + "ModelDescription": { + "description": "description of model.", + "maxLength": 1024, + "type": "string" + }, + "ModelId": { + "description": "SageMaker Model Arn or Non SageMaker Model id.", + "maxLength": 1024, + "type": "string" + }, + "ModelName": { + "description": "Name of the model.", + "maxLength": 1024, + "type": "string" + }, + "ModelOwner": { + "description": "Owner of model.", + "maxLength": 1024, + "type": "string" + }, + "ModelVersion": { + "description": "Version of the model.", + "minimum": 1, + "type": "number" + }, + "ProblemType": { + "description": "Problem being solved with the model.", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "ModelPackageCreator": { + "additionalProperties": false, + "properties": { + "UserProfileName": { + "description": "The name of the user's profile in Studio", + "maxLength": 63, + "type": "string" + } + }, + "type": "object" + }, + "ModelPackageDetails": { + "additionalProperties": false, + "description": "Metadata information related to model package version", + "properties": { + "ApprovalDescription": { + "description": "A description provided for the model approval", + "maxLength": 1024, + "type": "string" + }, + "CreatedBy": { + "$ref": "#/definitions/ModelPackageCreator", + "description": "Information about the user who created model package." + }, + "Domain": { + "description": "The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.", + "type": "string" + }, + "InferenceSpecification": { + "$ref": "#/definitions/InferenceSpecification", + "description": "Details about inference jobs that can be run with models based on this model package." + }, + "ModelApprovalStatus": { + "description": "Current approval status of model package", + "enum": [ + "Approved", + "Rejected", + "PendingManualApproval" + ], + "type": "string" + }, + "ModelPackageArn": { + "description": "The Amazon Resource Name (ARN) of the model package", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ModelPackageDescription": { + "description": "A brief summary of the model package", + "maxLength": 1024, + "type": "string" + }, + "ModelPackageGroupName": { + "description": "If the model is a versioned model, the name of the model group that the versioned model belongs to.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "ModelPackageName": { + "description": "Name of the model package", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "ModelPackageStatus": { + "description": "Current status of model package", + "enum": [ + "Pending", + "InProgress", + "Completed", + "Failed", + "Deleting" + ], + "type": "string" + }, + "ModelPackageVersion": { + "description": "Version of the model package", + "minimum": 1.0, + "type": "number" + }, + "SourceAlgorithms": { + "$ref": "#/definitions/SourceAlgorithms", + "description": "A list of algorithms that were used to create a model package." + }, + "Task": { + "description": "The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.", + "type": "string" + } + }, + "type": "object" + }, + "ObjectiveFunction": { + "additionalProperties": false, + "description": "the objective function the model will optimize for.", + "properties": { + "Function": { + "additionalProperties": false, + "description": "objective function that training job is optimized for.", + "properties": { + "Condition": { + "maxLength": 63, + "type": "string" + }, + "Facet": { + "maxLength": 63, + "type": "string" + }, + "Function": { + "enum": [ + "Maximize", + "Minimize" + ], + "type": "string" + } + }, + "type": "object" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "RiskRating": { + "description": "Risk rating of model.", + "enum": [ + "High", + "Medium", + "Low", + "Unknown" + ], + "type": "string" + }, + "SecurityConfig": { + "additionalProperties": false, + "description": "An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.\n\n", + "properties": { + "KmsKeyId": { + "description": "A Key Management Service key ID to use for encrypting a model card.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "SimpleMetric": { + "additionalProperties": false, + "description": "metric data", + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + }, + "Type": { + "enum": [ + "number", + "string", + "boolean" + ], + "type": "string" + }, + "Value": { + "anyOf": [ + { + "type": "number" + }, + { + "maxLength": 63, + "type": "string" + }, + { + "type": "boolean" + } + ] + }, + "XAxisName": { + "$ref": "#/definitions/AxisNameString" + }, + "YAxisName": { + "$ref": "#/definitions/AxisNameString" + } + }, + "required": [ + "Name", + "Type", + "Value" + ], + "type": "object" + }, + "SourceAlgorithm": { + "additionalProperties": false, + "properties": { + "AlgorithmName": { + "description": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.", + "maxLength": 170, + "type": "string" + }, + "ModelDataUrl": { + "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored.", + "maxLength": 1024, + "type": "string" + } + }, + "required": [ + "AlgorithmName" + ], + "type": "object" + }, + "SourceAlgorithms": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SourceAlgorithm" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The tag key. Tag keys must be unique per resource.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The tag value.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TrainingDetails": { + "additionalProperties": false, + "description": "Overview about the training.", + "properties": { + "ObjectiveFunction": { + "$ref": "#/definitions/ObjectiveFunction" + }, + "TrainingJobDetails": { + "additionalProperties": false, + "properties": { + "HyperParameters": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TrainingHyperParameter", + "maxItems": 100 + }, + "type": "array" + }, + "TrainingArn": { + "description": "SageMaker Training job arn.", + "maxLength": 1024, + "type": "string" + }, + "TrainingDatasets": { + "description": "Location of the model datasets.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "type": "string" + }, + "maxItems": 15, + "type": "array" + }, + "TrainingEnvironment": { + "additionalProperties": false, + "properties": { + "ContainerImage": { + "description": "SageMaker training image uri.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "type": "string" + }, + "maxItems": 15, + "type": "array" + } + }, + "type": "object" + }, + "TrainingMetrics": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TrainingMetric", + "maxItems": 50 + }, + "type": "array" + }, + "UserProvidedHyperParameters": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TrainingHyperParameter", + "maxItems": 100 + }, + "type": "array" + }, + "UserProvidedTrainingMetrics": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/TrainingMetric", + "maxItems": 50 + }, + "type": "array" + } + }, + "type": "object" + }, + "TrainingObservations": { + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "TrainingHyperParameter": { + "additionalProperties": false, + "description": "training hyper parameter", + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Value": { + "pattern": ".{1,255}", + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "TrainingMetric": { + "additionalProperties": false, + "description": "training metric data.", + "properties": { + "Name": { + "pattern": ".{1,255}", + "type": "string" + }, + "Notes": { + "maxLength": 1024, + "type": "string" + }, + "Value": { + "type": "number" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "UserContext": { + "additionalProperties": false, + "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.", + "properties": { + "DomainId": { + "default": "UnsetValue", + "description": "The domain associated with the user.", + "type": "string" + }, + "UserProfileArn": { + "default": "UnsetValue", + "description": "The Amazon Resource Name (ARN) of the user's profile.", + "type": "string" + }, + "UserProfileName": { + "default": "UnsetValue", + "description": "The name of the user's profile.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::ModelCard.", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateModelCard", + "sagemaker:DescribeModel", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:CreateGrant", + "sagemaker:DescribeModelPackageGroup", + "sagemaker:DescribeModelPackage", + "sagemaker:AddTags" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DescribeModelCard", + "sagemaker:DeleteModelCard", + "sagemaker:DescribeModelPackageGroup", + "sagemaker:DescribeModelPackage", + "kms:RetireGrant", + "kms:Decrypt", + "sagemaker:ListTags", + "sagemaker:DeleteTags" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListModelCards", + "sagemaker:ListModelCardVersions" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeModelCard", + "sagemaker:DescribeModelPackageGroup", + "sagemaker:DescribeModelPackage", + "kms:Decrypt", + "sagemaker:ListTags" + ] + }, + "update": { + "permissions": [ + "sagemaker:UpdateModelCard", + "sagemaker:DescribeModelCard", + "sagemaker:DescribeModel", + "kms:GenerateDataKey", + "kms:Decrypt", + "sagemaker:DescribeModelPackageGroup", + "sagemaker:DescribeModelPackage", + "sagemaker:ListTags", + "sagemaker:AddTags", + "sagemaker:DeleteTags" + ] + } + }, + "primaryIdentifier": [ + "/properties/ModelCardName" + ], + "properties": { + "Content": { + "$ref": "#/definitions/Content" + }, + "CreatedBy": { + "$ref": "#/definitions/UserContext", + "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." + }, + "CreationTime": { + "description": "The date and time the model card was created.", + "type": "string" + }, + "LastModifiedBy": { + "$ref": "#/definitions/UserContext", + "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." + }, + "LastModifiedTime": { + "description": "The date and time the model card was last modified.", + "type": "string" + }, + "ModelCardArn": { + "description": "The Amazon Resource Name (ARN) of the successfully created model card.", + "maxLength": 256, + "minLength": 1, + "pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "ModelCardName": { + "description": "The unique name of the model card.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", + "type": "string" + }, + "ModelCardProcessingStatus": { + "default": "UnsetValue", + "description": "The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.", + "enum": [ + "UnsetValue", + "DeleteInProgress", + "DeletePending", + "ContentDeleted", + "ExportJobsDeleted", + "DeleteCompleted", + "DeleteFailed" + ], + "type": "string" + }, + "ModelCardStatus": { + "description": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.", + "enum": [ + "Draft", + "PendingReview", + "Approved", + "Archived" + ], + "type": "string" + }, + "ModelCardVersion": { + "description": "A version of the model card.", + "minimum": 1, + "type": "integer" + }, + "SecurityConfig": { + "$ref": "#/definitions/SecurityConfig" + }, + "Tags": { + "description": "Key-value pairs used to manage metadata for model cards.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ModelCardArn", + "/properties/ModelCardVersion", + "/properties/CreatedBy/DomainId", + "/properties/CreatedBy/UserProfileArn", + "/properties/CreatedBy/UserProfileName", + "/properties/LastModifiedBy/DomainId", + "/properties/LastModifiedBy/UserProfileArn", + "/properties/LastModifiedBy/UserProfileName", + "/properties/CreationTime", + "/properties/LastModifiedTime", + "/properties/ModelCardProcessingStatus" + ], + "required": [ + "ModelCardName", + "Content", + "ModelCardStatus" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SageMaker::ModelCard" +} diff --git a/schema/aws-sagemaker-modelexplainabilityjobdefinition.json b/schema/aws-sagemaker-modelexplainabilityjobdefinition.json index 49bee37..937a54b 100644 --- a/schema/aws-sagemaker-modelexplainabilityjobdefinition.json +++ b/schema/aws-sagemaker-modelexplainabilityjobdefinition.json @@ -1,581 +1,581 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobDefinitionName", - "/properties/ModelExplainabilityAppSpecification", - "/properties/ModelExplainabilityBaselineConfig", - "/properties/ModelExplainabilityJobInput", - "/properties/ModelExplainabilityJobOutputConfig", - "/properties/JobResources", - "/properties/NetworkConfig", - "/properties/RoleArn", - "/properties/StoppingCondition", - "/properties/Tags", - "/properties/EndpointName" - ], - "definitions": { - "BatchTransformInput": { - "additionalProperties": false, - "description": "The batch transform input for a monitoring job.", - "properties": { - "DataCapturedDestinationS3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "DatasetFormat": { - "$ref": "#/definitions/DatasetFormat" - }, - "FeaturesAttribute": { - "description": "JSONpath to locate features in JSONlines dataset", - "maxLength": 256, - "type": "string" - }, - "InferenceAttribute": { - "description": "Index or JSONpath to locate predicted label(s)", - "maxLength": 256, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "ProbabilityAttribute": { - "description": "Index or JSONpath to locate probabilities", - "maxLength": 256, - "type": "string" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - } - }, - "required": [ - "DataCapturedDestinationS3Uri", - "DatasetFormat", - "LocalPath" - ], - "type": "object" - }, - "ClusterConfig": { - "additionalProperties": false, - "description": "Configuration for the cluster used to run model monitoring jobs.", - "properties": { - "InstanceCount": { - "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "InstanceType": { - "description": "The ML compute instance type for the processing job.", - "type": "string" - }, - "VolumeKmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", - "maximum": 2048, - "minimum": 1, - "type": "string" - }, - "VolumeSizeInGB": { - "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", - "maximum": 16384, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "ConstraintsResource": { - "additionalProperties": false, - "description": "The baseline constraints resource for a monitoring job.", - "properties": { - "S3Uri": { - "$ref": "#/definitions/S3Uri", - "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." - } - }, - "type": "object" - }, - "Csv": { - "description": "The CSV format", - "properties": { - "Header": { - "description": "A boolean flag indicating if given CSV has header", - "type": "boolean" - } - }, - "type": "object" - }, - "DatasetFormat": { - "description": "The dataset format of the data to monitor", - "properties": { - "Csv": { - "$ref": "#/definitions/Csv" - }, - "Json": { - "$ref": "#/definitions/Json" - }, - "Parquet": { - "$ref": "#/definitions/Parquet" - } - }, - "type": "object" - }, - "EndpointInput": { - "additionalProperties": false, - "description": "The endpoint for a monitoring job.", - "properties": { - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "FeaturesAttribute": { - "description": "JSONpath to locate features in JSONlines dataset", - "maxLength": 256, - "type": "string" - }, - "InferenceAttribute": { - "description": "Index or JSONpath to locate predicted label(s)", - "maxLength": 256, - "type": "string" - }, - "LocalPath": { - "description": "Path to the filesystem where the endpoint data is available to the container.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "ProbabilityAttribute": { - "description": "Index or JSONpath to locate probabilities", - "maxLength": 256, - "type": "string" - }, - "S3DataDistributionType": { - "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", - "enum": [ - "FullyReplicated", - "ShardedByS3Key" - ], - "type": "string" - }, - "S3InputMode": { - "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", - "enum": [ - "Pipe", - "File" - ], - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "EndpointName": { - "description": "The name of the endpoint used to run the monitoring job.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", - "type": "string" - }, - "JobDefinitionName": { - "description": "The name of the job definition.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "Json": { - "description": "The Json format", - "properties": { - "Line": { - "description": "A boolean flag indicating if it is JSON line format", - "type": "boolean" - } - }, - "type": "object" - }, - "ModelExplainabilityAppSpecification": { - "additionalProperties": false, - "description": "Container image configuration object for the monitoring job.", - "properties": { - "ConfigUri": { - "$ref": "#/definitions/S3Uri", - "description": "The S3 URI to an analysis configuration file" - }, - "Environment": { - "additionalProperties": false, - "description": "Sets the environment variables in the Docker container", - "patternProperties": { - "[\\S\\s]*": { - "maxLength": 256, - "type": "string" - }, - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ImageUri": { - "description": "The container image to be run by the monitoring job.", - "maxLength": 255, - "pattern": ".*", - "type": "string" - } - }, - "required": [ - "ImageUri", - "ConfigUri" - ], - "type": "object" - }, - "ModelExplainabilityBaselineConfig": { - "additionalProperties": false, - "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", - "properties": { - "BaseliningJobName": { - "$ref": "#/definitions/ProcessingJobName" - }, - "ConstraintsResource": { - "$ref": "#/definitions/ConstraintsResource" - } - }, - "type": "object" - }, - "ModelExplainabilityJobInput": { - "additionalProperties": false, - "description": "The inputs for a monitoring job.", - "properties": { - "BatchTransformInput": { - "$ref": "#/definitions/BatchTransformInput" - }, - "EndpointInput": { - "$ref": "#/definitions/EndpointInput" - } - }, - "type": "object" - }, - "MonitoringOutput": { - "additionalProperties": false, - "description": "The output object for a monitoring job.", - "properties": { - "S3Output": { - "$ref": "#/definitions/S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "MonitoringOutputConfig": { - "additionalProperties": false, - "description": "The output configuration for monitoring jobs.", - "properties": { - "KmsKeyId": { - "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", - "maxLength": 2048, - "pattern": ".*", - "type": "string" - }, - "MonitoringOutputs": { - "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", - "items": { - "$ref": "#/definitions/MonitoringOutput" - }, - "maxLength": 1, - "minLength": 1, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "MonitoringResources": { - "additionalProperties": false, - "description": "Identifies the resources to deploy for a monitoring job.", - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "MonitoringTimeOffsetString": { - "description": "The time offsets in ISO duration format", - "maxLength": 15, - "minLength": 1, - "pattern": "^.?P.*", - "type": "string" - }, - "NetworkConfig": { - "additionalProperties": false, - "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", - "properties": { - "EnableInterContainerTrafficEncryption": { - "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", - "type": "boolean" - }, - "EnableNetworkIsolation": { - "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/VpcConfig" - } - }, - "type": "object" - }, - "Parquet": { - "description": "A flag indicating if the dataset format is Parquet", - "type": "boolean" - }, - "ProcessingJobName": { - "description": "The name of a processing job", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", - "type": "string" - }, - "S3Output": { - "additionalProperties": false, - "description": "Information about where and how to store the results of a monitoring job.", - "properties": { - "LocalPath": { - "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3UploadMode": { - "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", - "enum": [ - "Continuous", - "EndOfJob" - ], - "type": "string" - }, - "S3Uri": { - "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", - "maxLength": 512, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "S3Uri": { - "description": "The Amazon S3 URI.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "StoppingCondition": { - "additionalProperties": false, - "description": "Specifies a time limit for how long the monitoring job is allowed to run.", - "properties": { - "MaxRuntimeInSeconds": { - "description": "The maximum runtime allowed in seconds.", - "maximum": 86400, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "VpcConfig": { - "additionalProperties": false, - "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", - "properties": { - "SecurityGroupIds": { - "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Subnets": { - "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", - "items": { - "maxLength": 32, - "pattern": "[-0-9a-zA-Z]+", - "type": "string" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition", - "handlers": { - "create": { - "permissions": [ - "sagemaker:CreateModelExplainabilityJobDefinition", - "sagemaker:DescribeModelExplainabilityJobDefinition", - "iam:PassRole", - "sagemaker:AddTags" - ] - }, - "delete": { - "permissions": [ - "sagemaker:DeleteModelExplainabilityJobDefinition" - ] - }, - "list": { - "permissions": [ - "sagemaker:ListModelExplainabilityJobDefinitions", - "sagemaker:ListTags" - ] - }, - "read": { - "permissions": [ - "sagemaker:DescribeModelExplainabilityJobDefinition" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobDefinitionArn" - ], - "properties": { - "CreationTime": { - "description": "The time at which the job definition was created.", - "type": "string" - }, - "EndpointName": { - "$ref": "#/definitions/EndpointName" - }, - "JobDefinitionArn": { - "description": "The Amazon Resource Name (ARN) of job definition.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "JobDefinitionName": { - "$ref": "#/definitions/JobDefinitionName" - }, - "JobResources": { - "$ref": "#/definitions/MonitoringResources" - }, - "ModelExplainabilityAppSpecification": { - "$ref": "#/definitions/ModelExplainabilityAppSpecification" - }, - "ModelExplainabilityBaselineConfig": { - "$ref": "#/definitions/ModelExplainabilityBaselineConfig" - }, - "ModelExplainabilityJobInput": { - "$ref": "#/definitions/ModelExplainabilityJobInput" - }, - "ModelExplainabilityJobOutputConfig": { - "$ref": "#/definitions/MonitoringOutputConfig" - }, - "NetworkConfig": { - "$ref": "#/definitions/NetworkConfig" - }, - "RoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/StoppingCondition" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/CreationTime", - "/properties/JobDefinitionArn" - ], - "required": [ - "ModelExplainabilityAppSpecification", - "ModelExplainabilityJobInput", - "ModelExplainabilityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "typeName": "AWS::SageMaker::ModelExplainabilityJobDefinition", - "writeOnlyProperties": [ - "/properties/EndpointName", - "/properties/Tags", - "/properties/Tags/*/Key", - "/properties/Tags/*/Value" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/JobDefinitionName", + "/properties/ModelExplainabilityAppSpecification", + "/properties/ModelExplainabilityBaselineConfig", + "/properties/ModelExplainabilityJobInput", + "/properties/ModelExplainabilityJobOutputConfig", + "/properties/JobResources", + "/properties/NetworkConfig", + "/properties/RoleArn", + "/properties/StoppingCondition", + "/properties/Tags", + "/properties/EndpointName" + ], + "definitions": { + "BatchTransformInput": { + "additionalProperties": false, + "description": "The batch transform input for a monitoring job.", + "properties": { + "DataCapturedDestinationS3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "DatasetFormat": { + "$ref": "#/definitions/DatasetFormat" + }, + "FeaturesAttribute": { + "description": "JSONpath to locate features in JSONlines dataset", + "maxLength": 256, + "type": "string" + }, + "InferenceAttribute": { + "description": "Index or JSONpath to locate predicted label(s)", + "maxLength": 256, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "ProbabilityAttribute": { + "description": "Index or JSONpath to locate probabilities", + "maxLength": 256, + "type": "string" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + } + }, + "required": [ + "DataCapturedDestinationS3Uri", + "DatasetFormat", + "LocalPath" + ], + "type": "object" + }, + "ClusterConfig": { + "additionalProperties": false, + "description": "Configuration for the cluster used to run model monitoring jobs.", + "properties": { + "InstanceCount": { + "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "InstanceType": { + "description": "The ML compute instance type for the processing job.", + "type": "string" + }, + "VolumeKmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.", + "maximum": 2048, + "minimum": 1, + "type": "string" + }, + "VolumeSizeInGB": { + "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.", + "maximum": 16384, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "InstanceCount", + "InstanceType", + "VolumeSizeInGB" + ], + "type": "object" + }, + "ConstraintsResource": { + "additionalProperties": false, + "description": "The baseline constraints resource for a monitoring job.", + "properties": { + "S3Uri": { + "$ref": "#/definitions/S3Uri", + "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." + } + }, + "type": "object" + }, + "Csv": { + "description": "The CSV format", + "properties": { + "Header": { + "description": "A boolean flag indicating if given CSV has header", + "type": "boolean" + } + }, + "type": "object" + }, + "DatasetFormat": { + "description": "The dataset format of the data to monitor", + "properties": { + "Csv": { + "$ref": "#/definitions/Csv" + }, + "Json": { + "$ref": "#/definitions/Json" + }, + "Parquet": { + "$ref": "#/definitions/Parquet" + } + }, + "type": "object" + }, + "EndpointInput": { + "additionalProperties": false, + "description": "The endpoint for a monitoring job.", + "properties": { + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "FeaturesAttribute": { + "description": "JSONpath to locate features in JSONlines dataset", + "maxLength": 256, + "type": "string" + }, + "InferenceAttribute": { + "description": "Index or JSONpath to locate predicted label(s)", + "maxLength": 256, + "type": "string" + }, + "LocalPath": { + "description": "Path to the filesystem where the endpoint data is available to the container.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "ProbabilityAttribute": { + "description": "Index or JSONpath to locate probabilities", + "maxLength": 256, + "type": "string" + }, + "S3DataDistributionType": { + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated", + "enum": [ + "FullyReplicated", + "ShardedByS3Key" + ], + "type": "string" + }, + "S3InputMode": { + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.", + "enum": [ + "Pipe", + "File" + ], + "type": "string" + } + }, + "required": [ + "EndpointName", + "LocalPath" + ], + "type": "object" + }, + "EndpointName": { + "description": "The name of the endpoint used to run the monitoring job.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*", + "type": "string" + }, + "JobDefinitionName": { + "description": "The name of the job definition.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "Json": { + "description": "The Json format", + "properties": { + "Line": { + "description": "A boolean flag indicating if it is JSON line format", + "type": "boolean" + } + }, + "type": "object" + }, + "ModelExplainabilityAppSpecification": { + "additionalProperties": false, + "description": "Container image configuration object for the monitoring job.", + "properties": { + "ConfigUri": { + "$ref": "#/definitions/S3Uri", + "description": "The S3 URI to an analysis configuration file" + }, + "Environment": { + "additionalProperties": false, + "description": "Sets the environment variables in the Docker container", + "patternProperties": { + "[\\S\\s]*": { + "maxLength": 256, + "type": "string" + }, + "[a-zA-Z_][a-zA-Z0-9_]*": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ImageUri": { + "description": "The container image to be run by the monitoring job.", + "maxLength": 255, + "pattern": ".*", + "type": "string" + } + }, + "required": [ + "ImageUri", + "ConfigUri" + ], + "type": "object" + }, + "ModelExplainabilityBaselineConfig": { + "additionalProperties": false, + "description": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics.", + "properties": { + "BaseliningJobName": { + "$ref": "#/definitions/ProcessingJobName" + }, + "ConstraintsResource": { + "$ref": "#/definitions/ConstraintsResource" + } + }, + "type": "object" + }, + "ModelExplainabilityJobInput": { + "additionalProperties": false, + "description": "The inputs for a monitoring job.", + "properties": { + "BatchTransformInput": { + "$ref": "#/definitions/BatchTransformInput" + }, + "EndpointInput": { + "$ref": "#/definitions/EndpointInput" + } + }, + "type": "object" + }, + "MonitoringOutput": { + "additionalProperties": false, + "description": "The output object for a monitoring job.", + "properties": { + "S3Output": { + "$ref": "#/definitions/S3Output" + } + }, + "required": [ + "S3Output" + ], + "type": "object" + }, + "MonitoringOutputConfig": { + "additionalProperties": false, + "description": "The output configuration for monitoring jobs.", + "properties": { + "KmsKeyId": { + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.", + "maxLength": 2048, + "pattern": ".*", + "type": "string" + }, + "MonitoringOutputs": { + "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.", + "items": { + "$ref": "#/definitions/MonitoringOutput" + }, + "maxLength": 1, + "minLength": 1, + "type": "array" + } + }, + "required": [ + "MonitoringOutputs" + ], + "type": "object" + }, + "MonitoringResources": { + "additionalProperties": false, + "description": "Identifies the resources to deploy for a monitoring job.", + "properties": { + "ClusterConfig": { + "$ref": "#/definitions/ClusterConfig" + } + }, + "required": [ + "ClusterConfig" + ], + "type": "object" + }, + "MonitoringTimeOffsetString": { + "description": "The time offsets in ISO duration format", + "maxLength": 15, + "minLength": 1, + "pattern": "^.?P.*", + "type": "string" + }, + "NetworkConfig": { + "additionalProperties": false, + "description": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.", + "properties": { + "EnableInterContainerTrafficEncryption": { + "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.", + "type": "boolean" + }, + "EnableNetworkIsolation": { + "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.", + "type": "boolean" + }, + "VpcConfig": { + "$ref": "#/definitions/VpcConfig" + } + }, + "type": "object" + }, + "Parquet": { + "description": "A flag indicating if the dataset format is Parquet", + "type": "boolean" + }, + "ProcessingJobName": { + "description": "The name of a processing job", + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$", + "type": "string" + }, + "S3Output": { + "additionalProperties": false, + "description": "Information about where and how to store the results of a monitoring job.", + "properties": { + "LocalPath": { + "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.", + "maxLength": 256, + "pattern": ".*", + "type": "string" + }, + "S3UploadMode": { + "description": "Whether to upload the results of the monitoring job continuously or after the job completes.", + "enum": [ + "Continuous", + "EndOfJob" + ], + "type": "string" + }, + "S3Uri": { + "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.", + "maxLength": 512, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + } + }, + "required": [ + "LocalPath", + "S3Uri" + ], + "type": "object" + }, + "S3Uri": { + "description": "The Amazon S3 URI.", + "maxLength": 1024, + "pattern": "^(https|s3)://([^/]+)/?(.*)$", + "type": "string" + }, + "StoppingCondition": { + "additionalProperties": false, + "description": "Specifies a time limit for how long the monitoring job is allowed to run.", + "properties": { + "MaxRuntimeInSeconds": { + "description": "The maximum runtime allowed in seconds.", + "maximum": 86400, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxRuntimeInSeconds" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "description": "Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.", + "properties": { + "SecurityGroupIds": { + "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Subnets": { + "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs.", + "items": { + "maxLength": 32, + "pattern": "[-0-9a-zA-Z]+", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition", + "handlers": { + "create": { + "permissions": [ + "sagemaker:CreateModelExplainabilityJobDefinition", + "sagemaker:DescribeModelExplainabilityJobDefinition", + "iam:PassRole", + "sagemaker:AddTags" + ] + }, + "delete": { + "permissions": [ + "sagemaker:DeleteModelExplainabilityJobDefinition" + ] + }, + "list": { + "permissions": [ + "sagemaker:ListModelExplainabilityJobDefinitions", + "sagemaker:ListTags" + ] + }, + "read": { + "permissions": [ + "sagemaker:DescribeModelExplainabilityJobDefinition" + ] + } + }, + "primaryIdentifier": [ + "/properties/JobDefinitionArn" + ], + "properties": { + "CreationTime": { + "description": "The time at which the job definition was created.", + "type": "string" + }, + "EndpointName": { + "$ref": "#/definitions/EndpointName" + }, + "JobDefinitionArn": { + "description": "The Amazon Resource Name (ARN) of job definition.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "JobDefinitionName": { + "$ref": "#/definitions/JobDefinitionName" + }, + "JobResources": { + "$ref": "#/definitions/MonitoringResources" + }, + "ModelExplainabilityAppSpecification": { + "$ref": "#/definitions/ModelExplainabilityAppSpecification" + }, + "ModelExplainabilityBaselineConfig": { + "$ref": "#/definitions/ModelExplainabilityBaselineConfig" + }, + "ModelExplainabilityJobInput": { + "$ref": "#/definitions/ModelExplainabilityJobInput" + }, + "ModelExplainabilityJobOutputConfig": { + "$ref": "#/definitions/MonitoringOutputConfig" + }, + "NetworkConfig": { + "$ref": "#/definitions/NetworkConfig" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "StoppingCondition": { + "$ref": "#/definitions/StoppingCondition" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreationTime", + "/properties/JobDefinitionArn" + ], + "required": [ + "ModelExplainabilityAppSpecification", + "ModelExplainabilityJobInput", + "ModelExplainabilityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "typeName": "AWS::SageMaker::ModelExplainabilityJobDefinition", + "writeOnlyProperties": [ + "/properties/EndpointName", + "/properties/Tags", + "/properties/Tags/*/Key", + "/properties/Tags/*/Value" + ] +} diff --git a/schema/aws-sagemaker-modelpackage.json b/schema/aws-sagemaker-modelpackage.json index aa63431..2cec381 100644 --- a/schema/aws-sagemaker-modelpackage.json +++ b/schema/aws-sagemaker-modelpackage.json @@ -1,1111 +1,1257 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ModelPackageGroupName", - "/properties/ModelPackageDescription", - "/properties/InferenceSpecification", - "/properties/ValidationSpecification", - "/properties/SourceAlgorithmSpecification", - "/properties/MetadataProperties", - "/properties/ModelMetrics", - "/properties/ClientToken", - "/properties/DriftCheckBaselines", - "/properties/Domain", - "/properties/Task", - "/properties/SamplePayloadUrl" - ], - "definitions": { - "AdditionalInferenceSpecificationDefinition": { - "additionalProperties": false, - "description": "Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.AdditionalInferenceSpecifications can be added to existing model packages using AdditionalInferenceSpecificationsToAdd.", - "properties": { - "Containers": { - "description": "The Amazon ECR registry path of the Docker image that contains the inference code.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ModelPackageContainerDefinition" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "Description": { - "description": "A description of the additional Inference specification.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "Name": { - "description": "A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$", - "type": "string" - }, - "SupportedContentTypes": { - "description": "The supported MIME types for the input data.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ContentType" - }, - "type": "array" - }, - "SupportedRealtimeInferenceInstanceTypes": { - "description": "A list of the instance types that are used to generate inferences in real-time", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/InferenceInstanceType" - }, - "type": "array" - }, - "SupportedResponseMIMETypes": { - "description": "The supported MIME types for the output data.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResponseMIMEType" - }, - "type": "array" - }, - "SupportedTransformInstanceTypes": { - "description": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TransformInstanceType" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Containers", - "Name" - ], - "type": "object" - }, - "AdditionalInferenceSpecifications": { - "description": "An array of additional Inference Specification objects.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AdditionalInferenceSpecificationDefinition" - }, - "maxItems": 15, - "minItems": 1, - "type": "array" - }, - "ApprovalDescription": { - "description": "A description provided for the model approval.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "Bias": { - "additionalProperties": false, - "description": "Contains bias metrics for a model.", - "properties": { - "PostTrainingReport": { - "$ref": "#/definitions/MetricsSource" - }, - "PreTrainingReport": { - "$ref": "#/definitions/MetricsSource" - }, - "Report": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "CertifyForMarketplace": { - "description": "Whether to certify the model package for listing on AWS Marketplace.", - "type": "boolean" - }, - "ClientToken": { - "description": "A unique token that guarantees that the call to this API is idempotent.", - "maxLength": 36, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "ContentType": { - "description": "The supported MIME type for the input data.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "CreationTime": { - "description": "The time at which the model package was created.", - "type": "string" - }, - "CustomerMetadataProperties": { - "additionalProperties": false, - "description": "The metadata properties associated with the model package versions.", - "maxProperties": 50, - "minProperties": 1, - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "DataSource": { - "additionalProperties": false, - "description": "Describes the input source of a transform job and the way the transform job consumes it.", - "properties": { - "S3DataSource": { - "$ref": "#/definitions/S3DataSource" - } - }, - "required": [ - "S3DataSource" - ], - "type": "object" - }, - "Domain": { - "description": "The machine learning domain of the model package you specified.", - "type": "string" - }, - "DriftCheckBaselines": { - "additionalProperties": false, - "description": "Represents the drift check baselines that can be used when the model monitor is set using the model package.", - "properties": { - "Bias": { - "$ref": "#/definitions/DriftCheckBias" - }, - "Explainability": { - "$ref": "#/definitions/DriftCheckExplainability" - }, - "ModelDataQuality": { - "$ref": "#/definitions/DriftCheckModelDataQuality" - }, - "ModelQuality": { - "$ref": "#/definitions/DriftCheckModelQuality" - } - }, - "type": "object" - }, - "DriftCheckBias": { - "additionalProperties": false, - "description": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package.", - "properties": { - "ConfigFile": { - "$ref": "#/definitions/FileSource" - }, - "PostTrainingConstraints": { - "$ref": "#/definitions/MetricsSource" - }, - "PreTrainingConstraints": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "DriftCheckExplainability": { - "additionalProperties": false, - "description": "Contains explainability metrics for a model.", - "properties": { - "ConfigFile": { - "$ref": "#/definitions/FileSource" - }, - "Constraints": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "DriftCheckModelDataQuality": { - "additionalProperties": false, - "description": "Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.", - "properties": { - "Constraints": { - "$ref": "#/definitions/MetricsSource" - }, - "Statistics": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "DriftCheckModelQuality": { - "additionalProperties": false, - "description": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.", - "properties": { - "Constraints": { - "$ref": "#/definitions/MetricsSource" - }, - "Statistics": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "description": "Sets the environment variables in the Docker container", - "maxProperties": 16, - "patternProperties": { - "[\\S\\s]*": { - "maxLength": 1024, - "type": "string" - }, - "[a-zA-Z_][a-zA-Z0-9_]*": { - "maxLength": 1024, - "type": "string" - } - }, - "type": "object" - }, - "Explainability": { - "additionalProperties": false, - "description": "Contains explainability metrics for a model.", - "properties": { - "Report": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "FileSource": { - "additionalProperties": false, - "description": "Represents a File Source Object.", - "properties": { - "ContentDigest": { - "description": "The digest of the file source.", - "maxLength": 72, - "pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$", - "type": "string" - }, - "ContentType": { - "description": "The type of content stored in the file source.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3Uri": { - "description": "The Amazon S3 URI for the file source.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "InferenceInstanceType": { - "description": "Instance type that is used to generate inferences in real-time", - "type": "string" - }, - "InferenceSpecification": { - "additionalProperties": false, - "description": "Details about inference jobs that can be run with models based on this model package.", - "properties": { - "Containers": { - "description": "The Amazon ECR registry path of the Docker image that contains the inference code.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ModelPackageContainerDefinition" - }, - "maxItems": 15, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "SupportedContentTypes": { - "description": "The supported MIME types for the input data.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ContentType" - }, - "type": "array" - }, - "SupportedRealtimeInferenceInstanceTypes": { - "description": "A list of the instance types that are used to generate inferences in real-time", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/InferenceInstanceType" - }, - "type": "array" - }, - "SupportedResponseMIMETypes": { - "description": "The supported MIME types for the output data.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/ResponseMIMEType" - }, - "type": "array" - }, - "SupportedTransformInstanceTypes": { - "description": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/TransformInstanceType" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Containers", - "SupportedContentTypes", - "SupportedResponseMIMETypes" - ], - "type": "object" - }, - "LastModifiedTime": { - "description": "The time at which the model package was last modified.", - "type": "string" - }, - "MetadataProperties": { - "additionalProperties": false, - "description": "Metadata properties of the tracking entity, trial, or trial component.", - "properties": { - "CommitId": { - "description": "The commit ID.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "GeneratedBy": { - "description": "The entity this entity was generated by.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "ProjectId": { - "description": "The project ID metadata.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - }, - "Repository": { - "description": "The repository metadata.", - "maxLength": 1024, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "MetricsSource": { - "additionalProperties": false, - "description": "Represents a Metric Source Object.", - "properties": { - "ContentDigest": { - "description": "The digest of the metric source.", - "maxLength": 72, - "pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$", - "type": "string" - }, - "ContentType": { - "description": "The type of content stored in the metric source.", - "maxLength": 256, - "pattern": ".*", - "type": "string" - }, - "S3Uri": { - "description": "The Amazon S3 URI for the metric source.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - } - }, - "required": [ - "ContentType", - "S3Uri" - ], - "type": "object" - }, - "ModelApprovalStatus": { - "description": "The approval status of the model package.", - "enum": [ - "Approved", - "Rejected", - "PendingManualApproval" - ], - "type": "string" - }, - "ModelDataQuality": { - "additionalProperties": false, - "description": "Metrics that measure the quality of the input data for a model.", - "properties": { - "Constraints": { - "$ref": "#/definitions/MetricsSource" - }, - "Statistics": { - "$ref": "#/definitions/MetricsSource" - } - }, - "type": "object" - }, - "ModelMetrics": { - "additionalProperties": false, - "description": "A structure that contains model metrics reports.", - "properties": { - "Bias": { - "$ref": "#/definitions/Bias" - }, - "Explainability": { - "$ref": "#/definitions/Explainability" - }, - "ModelDataQuality": { - "$ref": "#/definitions/ModelDataQuality" - }, - "ModelQuality": { - "$ref": "#/definitions/ModelQuality" - } - }, - "type": "object" - }, - "ModelPackageArn": { - "description": "The Amazon Resource Name (ARN) of the model package group.", - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$", - "type": "string" - }, - "ModelPackageContainerDefinition": { - "additionalProperties": false, - "description": "Describes the Docker container for the model package.", - "properties": { - "ContainerHostname": { - "description": "The DNS host name for the Docker container.", - "maxLength": 63, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/Environment" - }, - "Framework": { - "description": "The machine learning framework of the model package container image.", - "type": "string" - }, - "FrameworkVersion": { - "description": "The framework version of the Model Package Container Image.", - "maxLength": 10, - "minLength": 3, - "pattern": "[0-9]\\.[A-Za-z0-9.]+", - "type": "string" - }, - "Image": { - "description": "The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.", - "maxLength": 255, - "minLength": 1, - "pattern": "[\\S]{1,255}", - "type": "string" - }, - "ImageDigest": { - "description": "An MD5 hash of the training algorithm that identifies the Docker image used for training.", - "maxLength": 72, - "pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$", - "type": "string" - }, - "ModelDataUrl": { - "description": "A structure with Model Input details.", - "maxLength": 1024, - "pattern": "^(https|s3)://([^/]+)/?(.*)$", - "type": "string" - }, - "ModelInput": { - "additionalProperties": false, - "properties": { - "DataInputConfig": { - "description": "The input configuration object for the model.", - "maxLength": 1024, - "minLength": 1, - "pattern": "[\\S\\s]+", - "type": "string" - } - }, - "required": [ - "DataInputConfig" - ], - "type": "object" - }, - "NearestModelName": { - "description": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.", - "type": "string" - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "ModelPackageDescription": { - "description": "The description of the model package.", - "maxLength": 1024, - "pattern": "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*", - "type": "string" - }, - "ModelPackageGroupName": { - "description": "The name of the model package group.", - "maxLength": 170, - "minLength": 1, - "pattern": "(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation.", - "type": "boolean" - }, - "ExcludeUppercase": { - "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.", - "type": "boolean" - }, - "GenerateStringKey": { - "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``.", - "type": "string" - }, - "IncludeSpace": { - "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters.", - "type": "boolean" - }, - "PasswordLength": { - "description": "The length of the password. If you don't include this parameter, the default length is 32 characters.", - "type": "integer" - }, - "RequireEachIncludedType": { - "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.", - "type": "boolean" - }, - "SecretStringTemplate": { - "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created.", - "type": "string" - } - }, - "type": "object" - }, - "ReplicaRegion": { - "additionalProperties": false, - "description": "Specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", - "properties": { - "KmsKeyId": { - "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``.", - "type": "string" - }, - "Region": { - "description": "A string that represents a ``Region``, for example \"us-east-1\".", - "type": "string" - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A structure that contains information about a tag.", - "properties": { - "Key": { - "description": "The key identifier, or name, of the tag.", - "type": "string" - }, - "Value": { - "description": "The string value associated with the key of the tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.\n For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).\n To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).\n A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.\n For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).\n For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).", - "handlers": { - "create": { - "permissions": [ - "secretsmanager:DescribeSecret", - "secretsmanager:GetRandomPassword", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource", - "secretsmanager:ReplicateSecretToRegions" - ] - }, - "delete": { - "permissions": [ - "secretsmanager:DeleteSecret", - "secretsmanager:DescribeSecret", - "secretsmanager:RemoveRegionsFromReplication" - ] - }, - "list": { - "permissions": [ - "secretsmanager:ListSecrets" - ] - }, - "read": { - "permissions": [ - "secretsmanager:DescribeSecret", - "secretsmanager:GetSecretValue" - ] - }, - "update": { - "permissions": [ - "secretsmanager:UpdateSecret", - "secretsmanager:TagResource", - "secretsmanager:UntagResource", - "secretsmanager:GetRandomPassword", - "secretsmanager:GetSecretValue", - "secretsmanager:ReplicateSecretToRegions", - "secretsmanager:RemoveRegionsFromReplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "description": "The description of the secret.", - "type": "string" - }, - "GenerateSecretString": { - "$ref": "#/definitions/GenerateSecretString", - "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.\n We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support." - }, - "Id": { - "description": "", - "type": "string" - }, - "KmsKeyId": { - "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\n To use a KMS key in a different account, use the key ARN or the alias ARN.\n If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.\n If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.", - "type": "string" - }, - "Name": { - "description": "The name of the new secret.\n The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-\n Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.", - "type": "string" - }, - "ReplicaRegions": { - "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ReplicaRegion" - }, - "type": "array", - "uniqueItems": false - }, - "SecretString": { - "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.", - "type": "string" - }, - "Tags": { - "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:\n ``[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]`` \n Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".\n Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. \n If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For 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) and [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).\n For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.\n The following restrictions apply to tags:\n + Maximum number of tags per secret: 50\n + Maximum key length: 127 Unicode characters in UTF-8\n + Maximum value length: 255 Unicode characters in UTF-8\n + Tag keys and values are case sensitive.\n + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.\n + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-secretsmanager.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecretsManager::Secret", - "writeOnlyProperties": [ - "/properties/SecretString", - "/properties/GenerateSecretString" - ] -} +{ + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "GenerateSecretString": { + "additionalProperties": false, + "description": "Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.\n *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).", + "properties": { + "ExcludeCharacters": { + "description": "A string of the characters that you don't want in the password.", + "type": "string" + }, + "ExcludeLowercase": { + "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.", + "type": "boolean" + }, + "ExcludeNumbers": { + "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.", + "type": "boolean" + }, + "ExcludePunctuation": { + "description": "Specifies whether to exclude the following punctuation characters from the password: ``! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation.", + "type": "boolean" + }, + "ExcludeUppercase": { + "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.", + "type": "boolean" + }, + "GenerateStringKey": { + "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``.", + "type": "string" + }, + "IncludeSpace": { + "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters.", + "type": "boolean" + }, + "PasswordLength": { + "description": "The length of the password. If you don't include this parameter, the default length is 32 characters.", + "type": "integer" + }, + "RequireEachIncludedType": { + "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.", + "type": "boolean" + }, + "SecretStringTemplate": { + "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created.", + "type": "string" + } + }, + "type": "object" + }, + "ReplicaRegion": { + "additionalProperties": false, + "description": "Specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", + "properties": { + "KmsKeyId": { + "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``.", + "type": "string" + }, + "Region": { + "description": "A string that represents a ``Region``, for example \"us-east-1\".", + "type": "string" + } + }, + "required": [ + "Region" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A structure that contains information about a tag.", + "properties": { + "Key": { + "description": "The key identifier, or name, of the tag.", + "type": "string" + }, + "Value": { + "description": "The string value associated with the key of the tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.\n For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).\n To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).\n A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.\n For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).\n For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).", + "handlers": { + "create": { + "permissions": [ + "secretsmanager:DescribeSecret", + "secretsmanager:GetRandomPassword", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:ReplicateSecretToRegions" + ] + }, + "delete": { + "permissions": [ + "secretsmanager:DeleteSecret", + "secretsmanager:DescribeSecret", + "secretsmanager:RemoveRegionsFromReplication" + ] + }, + "list": { + "permissions": [ + "secretsmanager:ListSecrets" + ] + }, + "read": { + "permissions": [ + "secretsmanager:DescribeSecret", + "secretsmanager:GetSecretValue" + ] + }, + "update": { + "permissions": [ + "secretsmanager:UpdateSecret", + "secretsmanager:TagResource", + "secretsmanager:UntagResource", + "secretsmanager:GetRandomPassword", + "secretsmanager:GetSecretValue", + "secretsmanager:ReplicateSecretToRegions", + "secretsmanager:RemoveRegionsFromReplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "description": "The description of the secret.", + "type": "string" + }, + "GenerateSecretString": { + "$ref": "#/definitions/GenerateSecretString", + "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.\n We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support." + }, + "Id": { + "description": "", + "type": "string" + }, + "KmsKeyId": { + "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\n To use a KMS key in a different account, use the key ARN or the alias ARN.\n If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.\n If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.", + "type": "string" + }, + "Name": { + "description": "The name of the new secret.\n The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-\n Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.", + "type": "string" + }, + "ReplicaRegions": { + "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ReplicaRegion" + }, + "type": "array", + "uniqueItems": false + }, + "SecretString": { + "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.", + "type": "string" + }, + "Tags": { + "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:\n ``[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]`` \n Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".\n Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. \n If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For 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) and [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).\n For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.\n The following restrictions apply to tags:\n + Maximum number of tags per secret: 50\n + Maximum key length: 127 Unicode characters in UTF-8\n + Maximum value length: 255 Unicode characters in UTF-8\n + Tag keys and values are case sensitive.\n + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.\n + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-secretsmanager.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecretsManager::Secret", + "writeOnlyProperties": [ + "/properties/SecretString", + "/properties/GenerateSecretString" + ] +} diff --git a/schema/aws-secretsmanager-secrettargetattachment.json b/schema/aws-secretsmanager-secrettargetattachment.json index 46cfe60..7efc30e 100644 --- a/schema/aws-secretsmanager-secrettargetattachment.json +++ b/schema/aws-secretsmanager-secrettargetattachment.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "description": "Resource Type definition for AWS::SecretsManager::SecretTargetAttachment", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "SecretId": { - "type": "string" - }, - "TargetId": { - "type": "string" - }, - "TargetType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TargetType", - "TargetId", - "SecretId" - ], - "typeName": "AWS::SecretsManager::SecretTargetAttachment" -} +{ + "additionalProperties": false, + "description": "Resource Type definition for AWS::SecretsManager::SecretTargetAttachment", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "SecretId": { + "type": "string" + }, + "TargetId": { + "type": "string" + }, + "TargetType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TargetType", + "TargetId", + "SecretId" + ], + "typeName": "AWS::SecretsManager::SecretTargetAttachment" +} diff --git a/schema/aws-securityhub-automationrule.json b/schema/aws-securityhub-automationrule.json index faddc15..273deae 100644 --- a/schema/aws-securityhub-automationrule.json +++ b/schema/aws-securityhub-automationrule.json @@ -1,829 +1,836 @@ -{ - "additionalProperties": false, - "definitions": { - "AutomationRulesAction": { - "description": "", - "properties": { - "FindingFieldsUpdate": { - "$ref": "#/definitions/AutomationRulesFindingFieldsUpdate", - "description": "" - }, - "Type": { - "description": "", - "enum": [ - "FINDING_FIELDS_UPDATE" - ], - "type": "string" - } - }, - "required": [ - "Type", - "FindingFieldsUpdate" - ], - "type": "object" - }, - "AutomationRulesFindingFieldsUpdate": { - "description": "The rule action will update the ``Note`` field of a finding.", - "properties": { - "Confidence": { - "$ref": "#/definitions/int100", - "description": "" - }, - "Criticality": { - "$ref": "#/definitions/int100", - "description": "" - }, - "Note": { - "$ref": "#/definitions/NoteUpdate", - "description": "The rule action will update the ``Note`` field of a finding.", - "type": "object" - }, - "RelatedFindings": { - "description": "The rule action will update the ``RelatedFindings`` field of a finding.", - "items": { - "$ref": "#/definitions/RelatedFinding" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "Severity": { - "$ref": "#/definitions/SeverityUpdate", - "description": "The rule action will update the ``Severity`` field of a finding.", - "type": "object" - }, - "Types": { - "description": "", - "items": { - "pattern": "^([^/]+)(/[^/]+){0,2}$", - "type": "string" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UserDefinedFields": { - "$ref": "#/definitions/map", - "description": "" - }, - "VerificationState": { - "description": "", - "enum": [ - "UNKNOWN", - "TRUE_POSITIVE", - "FALSE_POSITIVE", - "BENIGN_POSITIVE" - ], - "type": "string" - }, - "Workflow": { - "$ref": "#/definitions/WorkflowUpdate", - "description": "The rule action will update the ``Workflow`` field of a finding.", - "type": "object" - } - }, - "type": "object" - }, - "AutomationRulesFindingFilters": { - "additionalProperties": false, - "description": "", - "properties": { - "AwsAccountId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 100, - "type": "array" - }, - "CompanyName": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ComplianceAssociatedStandardsId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ComplianceSecurityControlId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ComplianceStatus": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "Confidence": { - "description": "", - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array" - }, - "CreatedAt": { - "description": "", - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array" - }, - "Criticality": { - "description": "", - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array" - }, - "Description": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "FirstObservedAt": { - "description": "", - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array" - }, - "GeneratorId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 100, - "type": "array" - }, - "Id": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "LastObservedAt": { - "description": "", - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array" - }, - "NoteText": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "NoteUpdatedAt": { - "description": "", - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array" - }, - "NoteUpdatedBy": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ProductArn": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ProductName": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "RecordState": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "RelatedFindingsId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "RelatedFindingsProductArn": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ResourceDetailsOther": { - "description": "", - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ResourceId": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 100, - "type": "array" - }, - "ResourcePartition": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ResourceRegion": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ResourceTags": { - "description": "", - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array" - }, - "ResourceType": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "SeverityLabel": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "SourceUrl": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "Title": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 100, - "type": "array" - }, - "Type": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "UpdatedAt": { - "description": "", - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array" - }, - "UserDefinedFields": { - "description": "", - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array" - }, - "VerificationState": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - }, - "WorkflowStatus": { - "description": "", - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array" - } - }, - "type": "object" - }, - "BooleanFilter": { - "additionalProperties": false, - "description": "", - "properties": { - "Value": { - "description": "The value of the boolean.", - "type": "boolean" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "DateFilter": { - "additionalProperties": false, - "description": "", - "oneOf": [ - { - "required": [ - "DateRange" - ] - }, - { - "allOf": [ - { - "required": [ - "Start" - ] - }, - { - "required": [ - "End" - ] - } - ] - } - ], - "properties": { - "DateRange": { - "$ref": "#/definitions/DateRange", - "description": "" - }, - "End": { - "$ref": "#/definitions/ISO8601DateString", - "description": "" - }, - "Start": { - "$ref": "#/definitions/ISO8601DateString", - "description": "" - } - }, - "type": "object" - }, - "DateRange": { - "additionalProperties": false, - "description": "", - "properties": { - "Unit": { - "description": "", - "enum": [ - "DAYS" - ], - "type": "string" - }, - "Value": { - "description": "", - "type": "number" - } - }, - "required": [ - "Unit", - "Value" - ], - "type": "object" - }, - "ISO8601DateString": { - "description": "The date and time, in UTC and ISO 8601 format.", - "pattern": "^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$", - "type": "string" - }, - "MapFilter": { - "additionalProperties": false, - "description": "", - "properties": { - "Comparison": { - "description": "", - "enum": [ - "EQUALS", - "NOT_EQUALS", - "CONTAINS", - "NOT_CONTAINS" - ], - "type": "string" - }, - "Key": { - "description": "", - "type": "string" - }, - "Value": { - "description": "", - "type": "string" - } - }, - "required": [ - "Comparison", - "Key", - "Value" - ], - "type": "object" - }, - "NonEmptyString": { - "minLength": 1, - "type": "string" - }, - "NoteUpdate": { - "additionalProperties": false, - "description": "", - "properties": { - "Text": { - "description": "", - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "UpdatedBy": { - "$ref": "#/definitions/arnOrId", - "description": "" - } - }, - "required": [ - "Text", - "UpdatedBy" - ], - "type": "object" - }, - "NumberFilter": { - "additionalProperties": false, - "description": "", - "oneOf": [ - { - "required": [ - "Eq" - ] - }, - { - "anyOf": [ - { - "required": [ - "Gte" - ] - }, - { - "required": [ - "Lte" - ] - } - ] - } - ], - "properties": { - "Eq": { - "description": "", - "type": "number" - }, - "Gte": { - "description": "", - "type": "number" - }, - "Lte": { - "description": "", - "type": "number" - } - }, - "type": "object" - }, - "RelatedFinding": { - "additionalProperties": false, - "description": "Provides details about a list of findings that the current finding relates to.", - "properties": { - "Id": { - "$ref": "#/definitions/arnOrId", - "description": "" - }, - "ProductArn": { - "$ref": "#/definitions/arn", - "description": "The Amazon Resource Name (ARN) for the product that generated a related finding." - } - }, - "required": [ - "ProductArn", - "Id" - ], - "type": "object" - }, - "SeverityUpdate": { - "additionalProperties": false, - "description": "", - "properties": { - "Label": { - "description": "", - "enum": [ - "INFORMATIONAL", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ], - "type": "string" - }, - "Normalized": { - "$ref": "#/definitions/int100", - "description": "" - }, - "Product": { - "description": "", - "type": "number" - } - }, - "type": "object" - }, - "StringFilter": { - "additionalProperties": false, - "description": "", - "properties": { - "Comparison": { - "$ref": "#/definitions/StringFilterComparison", - "description": "" - }, - "Value": { - "description": "", - "type": "string" - } - }, - "required": [ - "Comparison", - "Value" - ], - "type": "object" - }, - "StringFilterComparison": { - "description": "The condition to apply to a string value when filtering Security Hub findings.", - "enum": [ - "EQUALS", - "PREFIX", - "NOT_EQUALS", - "PREFIX_NOT_EQUALS", - "CONTAINS", - "NOT_CONTAINS" - ], - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "WorkflowUpdate": { - "additionalProperties": false, - "description": "", - "properties": { - "Status": { - "description": "", - "enum": [ - "NEW", - "NOTIFIED", - "RESOLVED", - "SUPPRESSED" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "arn": { - "description": "The Amazon Resource Name (ARN) of the automation rule.", - "maxLength": 2048, - "minLength": 12, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso-?[a-z]{0,2}):[A-Za-z0-9]{1,63}:[a-z]+-([a-z]{1,10}-)?[a-z]+-[0-9]+:([0-9]{12})?:.+$", - "type": "string" - }, - "arnOrId": { - "anyOf": [ - { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - { - "$ref": "#/definitions/arn" - } - ], - "description": "The Amazon Resource Name (ARN) or Id of the automation rule." - }, - "int100": { - "description": "Integer from 0 to 100.", - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "map": { - "additionalProperties": false, - "description": "An object of user-defined name and value string pair added to a finding.", - "maxProperties": 50, - "minProperties": 1, - "patternProperties": { - "^[-_+=.:/@\\w\\s]{1,128}$": { - "description": "The value for the key in the map", - "maxLength": 1024, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "timestamp": { - "format": "date-time", - "pattern": "(\\d\\d\\d\\d)-[0-1](\\d)-[0-3](\\d)[Tt](?:[0-2](\\d):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?(?:[Zz]|[+-](\\d\\d)(?::?(\\d\\d))?)$", - "type": "string" - } - }, - "description": "The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "securityhub:CreateAutomationRule", - "securityhub:TagResource", - "securityhub:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "securityhub:BatchDeleteAutomationRules", - "securityhub:BatchGetAutomationRules" - ] - }, - "list": { - "permissions": [ - "securityhub:ListAutomationRules", - "securityhub:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "securityhub:ListAutomationRules", - "securityhub:BatchGetAutomationRules", - "securityhub:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "securityhub:BatchUpdateAutomationRules", - "securityhub:TagResource", - "securityhub:UntagResource", - "securityhub:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleArn" - ], - "properties": { - "Actions": { - "description": "", - "items": { - "$ref": "#/definitions/AutomationRulesAction" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "CreatedAt": { - "$ref": "#/definitions/ISO8601DateString", - "description": "" - }, - "CreatedBy": { - "description": "", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Criteria": { - "$ref": "#/definitions/AutomationRulesFindingFilters", - "description": "A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding." - }, - "Description": { - "description": "", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "IsTerminal": { - "description": "", - "type": "boolean" - }, - "RuleArn": { - "description": "", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - }, - "RuleName": { - "description": "", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "RuleOrder": { - "description": "", - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "RuleStatus": { - "description": "Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags", - "description": "" - }, - "UpdatedAt": { - "$ref": "#/definitions/ISO8601DateString", - "description": "" - } - }, - "readOnlyProperties": [ - "/properties/RuleArn", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/CreatedBy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecurityHub::AutomationRule" -} +{ + "additionalProperties": false, + "definitions": { + "AutomationRulesAction": { + "description": "One or more actions to update finding fields if a finding matches the defined criteria of the rule.", + "properties": { + "FindingFieldsUpdate": { + "$ref": "#/definitions/AutomationRulesFindingFieldsUpdate", + "description": "Specifies that the automation rule action is an update to a finding field." + }, + "Type": { + "description": "Specifies that the rule action should update the ``Types`` finding field. The ``Types`` finding field classifies findings in the format of namespace/category/classifier. For more information, see [Types taxonomy for ASFF](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) in the *User Guide*.", + "enum": [ + "FINDING_FIELDS_UPDATE" + ], + "type": "string" + } + }, + "required": [ + "Type", + "FindingFieldsUpdate" + ], + "type": "object" + }, + "AutomationRulesFindingFieldsUpdate": { + "description": "Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.", + "properties": { + "Confidence": { + "$ref": "#/definitions/int100", + "description": "The rule action updates the ``Confidence`` field of a finding." + }, + "Criticality": { + "$ref": "#/definitions/int100", + "description": "The rule action updates the ``Criticality`` field of a finding." + }, + "Note": { + "$ref": "#/definitions/NoteUpdate", + "description": "The rule action will update the ``Note`` field of a finding.", + "type": "object" + }, + "RelatedFindings": { + "description": "The rule action will update the ``RelatedFindings`` field of a finding.", + "items": { + "$ref": "#/definitions/RelatedFinding" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Severity": { + "$ref": "#/definitions/SeverityUpdate", + "description": "The rule action will update the ``Severity`` field of a finding.", + "type": "object" + }, + "Types": { + "description": "The rule action updates the ``Types`` field of a finding.", + "items": { + "pattern": "^([^/]+)(/[^/]+){0,2}$", + "type": "string" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UserDefinedFields": { + "$ref": "#/definitions/map", + "description": "The rule action updates the ``UserDefinedFields`` field of a finding." + }, + "VerificationState": { + "description": "The rule action updates the ``VerificationState`` field of a finding.", + "enum": [ + "UNKNOWN", + "TRUE_POSITIVE", + "FALSE_POSITIVE", + "BENIGN_POSITIVE" + ], + "type": "string" + }, + "Workflow": { + "$ref": "#/definitions/WorkflowUpdate", + "description": "The rule action will update the ``Workflow`` field of a finding.", + "type": "object" + } + }, + "type": "object" + }, + "AutomationRulesFindingFilters": { + "additionalProperties": false, + "description": "The criteria that determine which findings a rule applies to.", + "properties": { + "AwsAccountId": { + "description": "The AWS-account ID in which a finding was generated.\n Array Members: Minimum number of 1 item. Maximum number of 100 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 100, + "type": "array" + }, + "CompanyName": { + "description": "The name of the company for the product that generated the finding. For control-based findings, the company is AWS. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ComplianceAssociatedStandardsId": { + "description": "The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API response.\n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ComplianceSecurityControlId": { + "description": "The security control ID for which a finding was generated. Security control IDs are the same across standards.\n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ComplianceStatus": { + "description": "The result of a security check. This field is only used for findings generated from controls. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "Confidence": { + "description": "The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. ``Confidence`` is scored on a 0\u2013100 basis using a ratio scale. A value of ``0`` means 0 percent confidence, and a value of ``100`` means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see [Confidence](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence) in the *User Guide*.\n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array" + }, + "CreatedAt": { + "description": "A timestamp that indicates when this finding record was created. \n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)\n \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array" + }, + "Criticality": { + "description": "The level of importance that is assigned to the resources that are associated with a finding. ``Criticality`` is scored on a 0\u2013100 basis, using a ratio scale that supports only full integers. A score of ``0`` means that the underlying resources have no criticality, and a score of ``100`` is reserved for the most critical resources. For more information, see [Criticality](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality) in the *User Guide*.\n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array" + }, + "Description": { + "description": "A finding's description. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "FirstObservedAt": { + "description": "A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product. \n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)\n \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array" + }, + "GeneratorId": { + "description": "The identifier for the solution-specific component that generated a finding. \n Array Members: Minimum number of 1 item. Maximum number of 100 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 100, + "type": "array" + }, + "Id": { + "description": "The product-specific identifier for a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "LastObservedAt": { + "description": "A timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings product. \n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)\n \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array" + }, + "NoteText": { + "description": "The text of a user-defined note that's added to a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "NoteUpdatedAt": { + "description": "The timestamp of when the note was updated.\n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)\n \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array" + }, + "NoteUpdatedBy": { + "description": "The principal that created a note. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ProductArn": { + "description": "The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ProductName": { + "description": "Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "RecordState": { + "description": "Provides the current state of a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "RelatedFindingsId": { + "description": "The product-generated identifier for a related finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "RelatedFindingsProductArn": { + "description": "The ARN for the product that generated a related finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ResourceDetailsOther": { + "description": "Custom fields and values about the resource that a finding pertains to. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ResourceId": { + "description": "The identifier for the given resource type. For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS-service that created the resource. For non-AWS resources, this is a unique identifier that is associated with the resource. \n Array Members: Minimum number of 1 item. Maximum number of 100 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 100, + "type": "array" + }, + "ResourcePartition": { + "description": "The partition in which the resource that the finding pertains to is located. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ResourceRegion": { + "description": "The AWS-Region where the resource that a finding pertains to is located. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ResourceTags": { + "description": "A list of AWS tags associated with a resource at the time the finding was processed. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array" + }, + "ResourceType": { + "description": "A finding's title. \n Array Members: Minimum number of 1 item. Maximum number of 100 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "SeverityLabel": { + "description": "The severity value of the finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "SourceUrl": { + "description": "Provides a URL that links to a page about the current finding in the finding product. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "Title": { + "description": "A finding's title. \n Array Members: Minimum number of 1 item. Maximum number of 100 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 100, + "type": "array" + }, + "Type": { + "description": "One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see [Types taxonomy for ASFF](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) in the *User Guide*.\n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "UpdatedAt": { + "description": "A timestamp that indicates when the finding record was most recently updated. \n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)\n \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array" + }, + "UserDefinedFields": { + "description": "A list of user-defined name and value string pairs added to a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array" + }, + "VerificationState": { + "description": "Provides the veracity of a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + }, + "WorkflowStatus": { + "description": "Provides information about the status of the investigation into a finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items.", + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array" + } + }, + "type": "object" + }, + "BooleanFilter": { + "additionalProperties": false, + "description": "", + "properties": { + "Value": { + "description": "The value of the boolean.", + "type": "boolean" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "DateFilter": { + "additionalProperties": false, + "description": "A date filter for querying findings.", + "oneOf": [ + { + "required": [ + "DateRange" + ] + }, + { + "allOf": [ + { + "required": [ + "Start" + ] + }, + { + "required": [ + "End" + ] + } + ] + } + ], + "properties": { + "DateRange": { + "$ref": "#/definitions/DateRange", + "description": "A date range for the date filter." + }, + "End": { + "$ref": "#/definitions/ISO8601DateString", + "description": "A timestamp that provides the end date for the date filter.\n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)" + }, + "Start": { + "$ref": "#/definitions/ISO8601DateString", + "description": "A timestamp that provides the start date for the date filter.\n This field accepts only the specified formats. Timestamps can end with ``Z`` or ``(\"+\" / \"-\") time-hour [\":\" time-minute]``. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:\n + ``YYYY-MM-DDTHH:MM:SSZ`` (for example, ``2019-01-31T23:00:00Z``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ`` (for example, ``2019-01-31T23:00:00.123456789Z``)\n + ``YYYY-MM-DDTHH:MM:SS+HH:MM`` (for example, ``2024-01-04T15:25:10+17:59``)\n + ``YYYY-MM-DDTHH:MM:SS-HHMM`` (for example, ``2024-01-04T15:25:10-1759``)\n + ``YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM`` (for example, ``2024-01-04T15:25:10.123456789+17:59``)" + } + }, + "type": "object" + }, + "DateRange": { + "additionalProperties": false, + "description": "A date range for the date filter.", + "properties": { + "Unit": { + "description": "A date range unit for the date filter.", + "enum": [ + "DAYS" + ], + "type": "string" + }, + "Value": { + "description": "A date range value for the date filter.", + "type": "number" + } + }, + "required": [ + "Unit", + "Value" + ], + "type": "object" + }, + "ISO8601DateString": { + "description": "The date and time, in UTC and ISO 8601 format.", + "pattern": "^(\\d\\d\\d\\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\\d)|[3][0-1])[T](?:([0-1](\\d)|[2][0-3]):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?([Z]|[+-](\\d\\d)(:?(\\d\\d))?)$", + "type": "string" + }, + "MapFilter": { + "additionalProperties": false, + "description": "A map filter for filtering ASHlong findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.", + "properties": { + "Comparison": { + "description": "The condition to apply to the key value when filtering Security Hub findings with a map filter.\n To search for values that have the filter value, use one of the following comparison operators:\n + To search for values that include the filter value, use ``CONTAINS``. For example, for the ``ResourceTags`` field, the filter ``Department CONTAINS Security`` matches findings that include the value ``Security`` for the ``Department`` tag. In the same example, a finding with a value of ``Security team`` for the ``Department`` tag is a match.\n + To search for values that exactly match the filter value, use ``EQUALS``. For example, for the ``ResourceTags`` field, the filter ``Department EQUALS Security`` matches findings that have the value ``Security`` for the ``Department`` tag.\n \n ``CONTAINS`` and ``EQUALS`` filters on the same field are joined by ``OR``. A finding matches if it matches any one of those filters. For example, the filters ``Department CONTAINS Security OR Department CONTAINS Finance`` match a finding that includes either ``Security``, ``Finance``, or both values.\n To search for values that don't have the filter value, use one of the following comparison operators:\n + To search for values that exclude the filter value, use ``NOT_CONTAINS``. For example, for the ``ResourceTags`` field, the filter ``Department NOT_CONTAINS Finance`` matches findings that exclude the value ``Finance`` for the ``Department`` tag.\n + To search for values other than the filter value, use ``NOT_EQUALS``. For example, for the ``ResourceTags`` field, the filter ``Department NOT_EQUALS Finance`` matches findings that don\u2019t have the value ``Finance`` for the ``Department`` tag.\n \n ``NOT_CONTAINS`` and ``NOT_EQUALS`` filters on the same field are joined by ``AND``. A finding matches only if it matches all of those filters. For example, the filters ``Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance`` match a finding that excludes both the ``Security`` and ``Finance`` values.\n ``CONTAINS`` filters can only be used with other ``CONTAINS`` filters. ``NOT_CONTAINS`` filters can only be used with other ``NOT_CONTAINS`` filters.\n You can\u2019t have both a ``CONTAINS`` filter and a ``NOT_CONTAINS`` filter on the same field. Similarly, you can\u2019t have both an ``EQUALS`` filter and a ``NOT_EQUALS`` filter on the same field. Combining filters in this way returns an error. \n ``CONTAINS`` and ``NOT_CONTAINS`` operators can be used only with automation rules. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.", + "enum": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS" + ], + "type": "string" + }, + "Key": { + "description": "The key of the map filter. For example, for ``ResourceTags``, ``Key`` identifies the name of the tag. For ``UserDefinedFields``, ``Key`` is the name of the field.", + "type": "string" + }, + "Value": { + "description": "The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called ``Department`` might be ``Security``. If you provide ``security`` as the filter value, then there's no match.", + "type": "string" + } + }, + "required": [ + "Comparison", + "Key", + "Value" + ], + "type": "object" + }, + "NonEmptyString": { + "minLength": 1, + "type": "string" + }, + "NoteUpdate": { + "additionalProperties": false, + "description": "The updated note.", + "properties": { + "Text": { + "description": "The updated note text.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "UpdatedBy": { + "$ref": "#/definitions/arnOrId", + "description": "The principal that updated the note." + } + }, + "required": [ + "Text", + "UpdatedBy" + ], + "type": "object" + }, + "NumberFilter": { + "additionalProperties": false, + "description": "A number filter for querying findings.", + "oneOf": [ + { + "required": [ + "Eq" + ] + }, + { + "anyOf": [ + { + "required": [ + "Gte" + ] + }, + { + "required": [ + "Lte" + ] + } + ] + } + ], + "properties": { + "Eq": { + "description": "The equal-to condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Gte": { + "description": "The greater-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Lte": { + "description": "The less-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + } + }, + "type": "object" + }, + "RelatedFinding": { + "additionalProperties": false, + "description": "Provides details about a list of findings that the current finding relates to.", + "properties": { + "Id": { + "$ref": "#/definitions/arnOrId", + "description": "The product-generated identifier for a related finding. \n Array Members: Minimum number of 1 item. Maximum number of 20 items." + }, + "ProductArn": { + "$ref": "#/definitions/arn", + "description": "The Amazon Resource Name (ARN) for the product that generated a related finding." + } + }, + "required": [ + "ProductArn", + "Id" + ], + "type": "object" + }, + "SeverityUpdate": { + "additionalProperties": false, + "description": "Updates to the severity information for a finding.", + "properties": { + "Label": { + "description": "The severity value of the finding. The allowed values are the following.\n + ``INFORMATIONAL`` - No issue was found.\n + ``LOW`` - The issue does not require action on its own.\n + ``MEDIUM`` - The issue must be addressed but not urgently.\n + ``HIGH`` - The issue must be addressed as a priority.\n + ``CRITICAL`` - The issue must be remediated immediately to avoid it escalating.", + "enum": [ + "INFORMATIONAL", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ], + "type": "string" + }, + "Normalized": { + "$ref": "#/definitions/int100", + "description": "The normalized severity for the finding. This attribute is to be deprecated in favor of ``Label``.\n If you provide ``Normalized`` and do not provide ``Label``, ``Label`` is set automatically as follows.\n + 0 - ``INFORMATIONAL`` \n + 1\u201339 - ``LOW`` \n + 40\u201369 - ``MEDIUM`` \n + 70\u201389 - ``HIGH`` \n + 90\u2013100 - ``CRITICAL``" + }, + "Product": { + "description": "The native severity as defined by the AWS service or integrated partner product that generated the finding.", + "type": "number" + } + }, + "type": "object" + }, + "StringFilter": { + "additionalProperties": false, + "description": "A string filter for filtering ASHlong findings.", + "properties": { + "Comparison": { + "$ref": "#/definitions/StringFilterComparison", + "description": "The condition to apply to a string value when filtering Security Hub findings.\n To search for values that have the filter value, use one of the following comparison operators:\n + To search for values that include the filter value, use ``CONTAINS``. For example, the filter ``Title CONTAINS CloudFront`` matches findings that have a ``Title`` that includes the string CloudFront.\n + To search for values that exactly match the filter value, use ``EQUALS``. For example, the filter ``AwsAccountId EQUALS 123456789012`` only matches findings that have an account ID of ``123456789012``.\n + To search for values that start with the filter value, use ``PREFIX``. For example, the filter ``ResourceRegion PREFIX us`` matches findings that have a ``ResourceRegion`` that starts with ``us``. A ``ResourceRegion`` that starts with a different value, such as ``af``, ``ap``, or ``ca``, doesn't match.\n \n ``CONTAINS``, ``EQUALS``, and ``PREFIX`` filters on the same field are joined by ``OR``. A finding matches if it matches any one of those filters. For example, the filters ``Title CONTAINS CloudFront OR Title CONTAINS CloudWatch`` match a finding that includes either ``CloudFront``, ``CloudWatch``, or both strings in the title.\n To search for values that don\u2019t have the filter value, use one of the following comparison operators:\n + To search for values that exclude the filter value, use ``NOT_CONTAINS``. For example, the filter ``Title NOT_CONTAINS CloudFront`` matches findings that have a ``Title`` that excludes the string CloudFront.\n + To search for values other than the filter value, use ``NOT_EQUALS``. For example, the filter ``AwsAccountId NOT_EQUALS 123456789012`` only matches findings that have an account ID other than ``123456789012``.\n + To search for values that don't start with the filter value, use ``PREFIX_NOT_EQUALS``. For example, the filter ``ResourceRegion PREFIX_NOT_EQUALS us`` matches findings with a ``ResourceRegion`` that starts with a value other than ``us``.\n \n ``NOT_CONTAINS``, ``NOT_EQUALS``, and ``PREFIX_NOT_EQUALS`` filters on the same field are joined by ``AND``. A finding matches only if it matches all of those filters. For example, the filters ``Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch`` match a finding that excludes both ``CloudFront`` and ``CloudWatch`` in the title.\n You can\u2019t have both a ``CONTAINS`` filter and a ``NOT_CONTAINS`` filter on the same field. Similarly, you can't provide both an ``EQUALS`` filter and a ``NOT_EQUALS`` or ``PREFIX_NOT_EQUALS`` filter on the same field. Combining filters in this way returns an error. ``CONTAINS`` filters can only be used with other ``CONTAINS`` filters. ``NOT_CONTAINS`` filters can only be used with other ``NOT_CONTAINS`` filters. \n You can combine ``PREFIX`` filters with ``NOT_EQUALS`` or ``PREFIX_NOT_EQUALS`` filters for the same field. Security Hub first processes the ``PREFIX`` filters, and then the ``NOT_EQUALS`` or ``PREFIX_NOT_EQUALS`` filters.\n For example, for the following filters, Security Hub first identifies findings that have resource types that start with either ``AwsIam`` or ``AwsEc2``. It then excludes findings that have a resource type of ``AwsIamPolicy`` and findings that have a resource type of ``AwsEc2NetworkInterface``.\n + ``ResourceType PREFIX AwsIam`` \n + ``ResourceType PREFIX AwsEc2`` \n + ``ResourceType NOT_EQUALS AwsIamPolicy`` \n + ``ResourceType NOT_EQUALS AwsEc2NetworkInterface`` \n \n ``CONTAINS`` and ``NOT_CONTAINS`` operators can be used only with automation rules. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*." + }, + "Value": { + "description": "The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is ``Security Hub``. If you provide ``security hub`` as the filter value, there's no match.", + "type": "string" + } + }, + "required": [ + "Comparison", + "Value" + ], + "type": "object" + }, + "StringFilterComparison": { + "description": "The condition to apply to a string value when filtering Security Hub findings.", + "enum": [ + "EQUALS", + "PREFIX", + "NOT_EQUALS", + "PREFIX_NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS" + ], + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "WorkflowUpdate": { + "additionalProperties": false, + "description": "Used to update information about the investigation into the finding.", + "properties": { + "Status": { + "description": "The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to ``SUPPRESSED`` or ``RESOLVED`` does not prevent a new finding for the same issue.\n The allowed values are the following.\n + ``NEW`` - The initial state of a finding, before it is reviewed.\n Security Hub also resets ``WorkFlowStatus`` from ``NOTIFIED`` or ``RESOLVED`` to ``NEW`` in the following cases:\n + The record state changes from ``ARCHIVED`` to ``ACTIVE``.\n + The compliance status changes from ``PASSED`` to either ``WARNING``, ``FAILED``, or ``NOT_AVAILABLE``.\n \n + ``NOTIFIED`` - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.\n + ``RESOLVED`` - The finding was reviewed and remediated and is now considered resolved.\n + ``SUPPRESSED`` - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.", + "enum": [ + "NEW", + "NOTIFIED", + "RESOLVED", + "SUPPRESSED" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "arn": { + "description": "The Amazon Resource Name (ARN) of the automation rule.", + "maxLength": 2048, + "minLength": 12, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso-?[a-z]{0,2}):[A-Za-z0-9]{1,63}:[a-z]+-([a-z]{1,10}-)?[a-z]+-[0-9]+:([0-9]{12})?:.+$", + "type": "string" + }, + "arnOrId": { + "anyOf": [ + { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + { + "$ref": "#/definitions/arn" + } + ], + "description": "The Amazon Resource Name (ARN) or Id of the automation rule." + }, + "int100": { + "description": "Integer from 0 to 100.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "map": { + "additionalProperties": false, + "description": "An object of user-defined name and value string pair added to a finding.", + "maxProperties": 50, + "minProperties": 1, + "patternProperties": { + "^[-_+=.:/@\\w\\s]{1,128}$": { + "description": "The value for the key in the map", + "maxLength": 1024, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "timestamp": { + "format": "date-time", + "pattern": "(\\d\\d\\d\\d)-[0-1](\\d)-[0-3](\\d)[Tt](?:[0-2](\\d):[0-5](\\d):[0-5](\\d)|23:59:60)(?:\\.(\\d)+)?(?:[Zz]|[+-](\\d\\d)(?::?(\\d\\d))?)$", + "type": "string" + } + }, + "description": "The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateAutomationRule", + "securityhub:TagResource", + "securityhub:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "securityhub:BatchDeleteAutomationRules", + "securityhub:BatchGetAutomationRules" + ] + }, + "list": { + "permissions": [ + "securityhub:ListAutomationRules", + "securityhub:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "securityhub:ListAutomationRules", + "securityhub:BatchGetAutomationRules", + "securityhub:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securityhub:BatchUpdateAutomationRules", + "securityhub:TagResource", + "securityhub:UntagResource", + "securityhub:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleArn" + ], + "properties": { + "Actions": { + "description": "One or more actions to update finding fields if a finding matches the conditions specified in ``Criteria``.", + "items": { + "$ref": "#/definitions/AutomationRulesAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "CreatedAt": { + "$ref": "#/definitions/ISO8601DateString", + "description": "" + }, + "CreatedBy": { + "description": "", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Criteria": { + "$ref": "#/definitions/AutomationRulesFindingFilters", + "description": "A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding." + }, + "Description": { + "description": "A description of the rule.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "IsTerminal": { + "description": "Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.", + "type": "boolean" + }, + "RuleArn": { + "description": "", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "RuleName": { + "description": "The name of the rule.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "RuleOrder": { + "description": "An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.", + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "RuleStatus": { + "description": "Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags", + "description": "User-defined tags associated with an automation rule." + }, + "UpdatedAt": { + "$ref": "#/definitions/ISO8601DateString", + "description": "" + } + }, + "readOnlyProperties": [ + "/properties/RuleArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/CreatedBy" + ], + "required": [ + "RuleOrder", + "RuleName", + "Description", + "Criteria", + "Actions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityHub::AutomationRule" +} diff --git a/schema/aws-securityhub-configurationpolicy.json b/schema/aws-securityhub-configurationpolicy.json index 594598b..dfc48a3 100644 --- a/schema/aws-securityhub-configurationpolicy.json +++ b/schema/aws-securityhub-configurationpolicy.json @@ -1,300 +1,300 @@ -{ - "additionalProperties": false, - "definitions": { - "ParameterConfiguration": { - "additionalProperties": false, - "description": "An object that provides the current value of a security control parameter and identifies whether it has been customized.", - "properties": { - "Value": { - "$ref": "#/definitions/ParameterValue" - }, - "ValueType": { - "description": "Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.", - "enum": [ - "DEFAULT", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "ValueType" - ], - "type": "object" - }, - "ParameterValue": { - "additionalProperties": false, - "description": "An object that includes the data type of a security control parameter and its current value.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "Boolean": { - "description": "A control parameter that is a boolean.", - "type": "boolean" - }, - "Double": { - "description": "A control parameter that is a double.", - "type": "number" - }, - "Enum": { - "description": "A control parameter that is an enum.", - "maxLength": 2048, - "type": "string" - }, - "EnumList": { - "description": "A control parameter that is a list of enums.", - "insertionOrder": true, - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - }, - "Integer": { - "description": "A control parameter that is an integer.", - "type": "integer" - }, - "IntegerList": { - "description": "A control parameter that is a list of integers.", - "insertionOrder": true, - "items": { - "type": "integer" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - }, - "String": { - "description": "A control parameter that is a string.", - "maxLength": 2048, - "type": "string" - }, - "StringList": { - "description": "A control parameter that is a list of strings.", - "insertionOrder": true, - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 100, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Policy": { - "additionalProperties": false, - "description": "An object that defines how Security Hub is configured.", - "properties": { - "SecurityHub": { - "$ref": "#/definitions/SecurityHubPolicy" - } - }, - "type": "object" - }, - "SecurityControlCustomParameter": { - "additionalProperties": false, - "description": "An object of security control and control parameter value that are included in a configuration policy.", - "properties": { - "Parameters": { - "additionalProperties": false, - "description": "An object that specifies parameter values for a control in a configuration policy.", - "minProperties": 1, - "patternProperties": { - "^[-_+=.:/@\\w\\s]{1,128}$": { - "$ref": "#/definitions/ParameterConfiguration" - } - }, - "type": "object" - }, - "SecurityControlId": { - "description": "The ID of the security control.", - "maxLength": 2048, - "type": "string" - } - }, - "type": "object" - }, - "SecurityControlsConfiguration": { - "additionalProperties": false, - "description": "An object that defines which security controls are enabled in an AWS Security Hub configuration policy.", - "properties": { - "DisabledSecurityControlIdentifiers": { - "description": "A list of security controls that are disabled in the configuration policy", - "insertionOrder": true, - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "EnabledSecurityControlIdentifiers": { - "description": "A list of security controls that are enabled in the configuration policy.", - "insertionOrder": true, - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "SecurityControlCustomParameters": { - "description": "A list of security controls and control parameter values that are included in a configuration policy.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SecurityControlCustomParameter" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "SecurityHubPolicy": { - "additionalProperties": false, - "description": "An object that defines how AWS Security Hub is configured.", - "properties": { - "EnabledStandardIdentifiers": { - "description": "A list that defines which security standards are enabled in the configuration policy.", - "insertionOrder": true, - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 1000, - "type": "array", - "uniqueItems": true - }, - "SecurityControlsConfiguration": { - "$ref": "#/definitions/SecurityControlsConfiguration" - }, - "ServiceEnabled": { - "description": "Indicates whether Security Hub is enabled in the policy.", - "type": "boolean" - } - }, - "type": "object" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.", - "handlers": { - "create": { - "permissions": [ - "securityhub:CreateConfigurationPolicy", - "securityhub:TagResource", - "securityhub:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "securityhub:GetConfigurationPolicy", - "securityhub:DeleteConfigurationPolicy" - ] - }, - "list": { - "permissions": [ - "securityhub:ListConfigurationPolicies", - "securityhub:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "securityhub:GetConfigurationPolicy", - "securityhub:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "securityhub:UpdateConfigurationPolicy", - "securityhub:TagResource", - "securityhub:UntagResource", - "securityhub:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the configuration policy.", - "pattern": "^arn:aws\\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "ConfigurationPolicy": { - "$ref": "#/definitions/Policy" - }, - "CreatedAt": { - "description": "The date and time, in UTC and ISO 8601 format.", - "type": "string" - }, - "Description": { - "description": "The description of the configuration policy.", - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "Id": { - "description": "The universally unique identifier (UUID) of the configuration policy.", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "Name": { - "description": "The name of the configuration policy.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "ServiceEnabled": { - "description": "Indicates whether the service that the configuration policy applies to is enabled in the policy.", - "type": "boolean" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "UpdatedAt": { - "description": "The date and time, in UTC and ISO 8601 format.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/CreatedAt", - "/properties/UpdatedAt", - "/properties/ServiceEnabled" - ], - "required": [ - "ConfigurationPolicy", - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecurityHub::ConfigurationPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "ParameterConfiguration": { + "additionalProperties": false, + "description": "An object that provides the current value of a security control parameter and identifies whether it has been customized.", + "properties": { + "Value": { + "$ref": "#/definitions/ParameterValue" + }, + "ValueType": { + "description": "Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.", + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "ValueType" + ], + "type": "object" + }, + "ParameterValue": { + "additionalProperties": false, + "description": "An object that includes the data type of a security control parameter and its current value.", + "maxProperties": 1, + "minProperties": 1, + "properties": { + "Boolean": { + "description": "A control parameter that is a boolean.", + "type": "boolean" + }, + "Double": { + "description": "A control parameter that is a double.", + "type": "number" + }, + "Enum": { + "description": "A control parameter that is an enum.", + "maxLength": 2048, + "type": "string" + }, + "EnumList": { + "description": "A control parameter that is a list of enums.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "Integer": { + "description": "A control parameter that is an integer.", + "type": "integer" + }, + "IntegerList": { + "description": "A control parameter that is a list of integers.", + "insertionOrder": true, + "items": { + "type": "integer" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "String": { + "description": "A control parameter that is a string.", + "maxLength": 2048, + "type": "string" + }, + "StringList": { + "description": "A control parameter that is a list of strings.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Policy": { + "additionalProperties": false, + "description": "An object that defines how Security Hub is configured.", + "properties": { + "SecurityHub": { + "$ref": "#/definitions/SecurityHubPolicy" + } + }, + "type": "object" + }, + "SecurityControlCustomParameter": { + "additionalProperties": false, + "description": "An object of security control and control parameter value that are included in a configuration policy.", + "properties": { + "Parameters": { + "additionalProperties": false, + "description": "An object that specifies parameter values for a control in a configuration policy.", + "minProperties": 1, + "patternProperties": { + "^[-_+=.:/@\\w\\s]{1,128}$": { + "$ref": "#/definitions/ParameterConfiguration" + } + }, + "type": "object" + }, + "SecurityControlId": { + "description": "The ID of the security control.", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + }, + "SecurityControlsConfiguration": { + "additionalProperties": false, + "description": "An object that defines which security controls are enabled in an AWS Security Hub configuration policy.", + "properties": { + "DisabledSecurityControlIdentifiers": { + "description": "A list of security controls that are disabled in the configuration policy", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "EnabledSecurityControlIdentifiers": { + "description": "A list of security controls that are enabled in the configuration policy.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "SecurityControlCustomParameters": { + "description": "A list of security controls and control parameter values that are included in a configuration policy.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SecurityControlCustomParameter" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "SecurityHubPolicy": { + "additionalProperties": false, + "description": "An object that defines how AWS Security Hub is configured.", + "properties": { + "EnabledStandardIdentifiers": { + "description": "A list that defines which security standards are enabled in the configuration policy.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "SecurityControlsConfiguration": { + "$ref": "#/definitions/SecurityControlsConfiguration" + }, + "ServiceEnabled": { + "description": "Indicates whether Security Hub is enabled in the policy.", + "type": "boolean" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateConfigurationPolicy", + "securityhub:TagResource", + "securityhub:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "securityhub:GetConfigurationPolicy", + "securityhub:DeleteConfigurationPolicy" + ] + }, + "list": { + "permissions": [ + "securityhub:ListConfigurationPolicies", + "securityhub:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "securityhub:GetConfigurationPolicy", + "securityhub:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateConfigurationPolicy", + "securityhub:TagResource", + "securityhub:UntagResource", + "securityhub:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the configuration policy.", + "pattern": "^arn:aws\\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "ConfigurationPolicy": { + "$ref": "#/definitions/Policy" + }, + "CreatedAt": { + "description": "The date and time, in UTC and ISO 8601 format.", + "type": "string" + }, + "Description": { + "description": "The description of the configuration policy.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "Id": { + "description": "The universally unique identifier (UUID) of the configuration policy.", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "Name": { + "description": "The name of the configuration policy.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ServiceEnabled": { + "description": "Indicates whether the service that the configuration policy applies to is enabled in the policy.", + "type": "boolean" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "UpdatedAt": { + "description": "The date and time, in UTC and ISO 8601 format.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/ServiceEnabled" + ], + "required": [ + "ConfigurationPolicy", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityHub::ConfigurationPolicy" +} diff --git a/schema/aws-securityhub-delegatedadmin.json b/schema/aws-securityhub-delegatedadmin.json index 414efe3..9500328 100644 --- a/schema/aws-securityhub-delegatedadmin.json +++ b/schema/aws-securityhub-delegatedadmin.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdminAccountId" - ], - "description": "The AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId.", - "handlers": { - "create": { - "permissions": [ - "securityhub:EnableOrganizationAdminAccount", - "organizations:DescribeOrganization", - "organizations:EnableAWSServiceAccess", - "organizations:RegisterDelegatedAdministrator" - ] - }, - "delete": { - "permissions": [ - "securityhub:DisableOrganizationAdminAccount", - "organizations:DescribeOrganization" - ] - }, - "list": { - "permissions": [ - "securityhub:ListOrganizationAdminAccounts", - "organizations:DescribeOrganization" - ] - }, - "read": { - "permissions": [ - "securityhub:ListOrganizationAdminAccounts", - "organizations:DescribeOrganization" - ] - } - }, - "primaryIdentifier": [ - "/properties/DelegatedAdminIdentifier" - ], - "properties": { - "AdminAccountId": { - "description": "The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account", - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "DelegatedAdminIdentifier": { - "description": "The identifier of the DelegatedAdmin being created and assigned as the unique identifier", - "pattern": "^[0-9]{12}/[a-zA-Z0-9-]{1,32}$", - "type": "string" - }, - "Status": { - "description": "The current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator", - "enum": [ - "ENABLED", - "DISABLE_IN_PROGRESS" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/DelegatedAdminIdentifier", - "/properties/Status" - ], - "required": [ - "AdminAccountId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SecurityHub::DelegatedAdmin" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdminAccountId" + ], + "description": "The ``AWS::SecurityHub::DelegatedAdmin`` resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see [Designating the delegated administrator](https://docs.aws.amazon.com/securityhub/latest/userguide/designate-orgs-admin-account.html#designate-admin-instructions) in the *User Guide*.\n To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account.\n To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html).\n Tags aren't supported for this resource.", + "handlers": { + "create": { + "permissions": [ + "securityhub:EnableOrganizationAdminAccount", + "organizations:DescribeOrganization", + "organizations:EnableAWSServiceAccess", + "organizations:RegisterDelegatedAdministrator" + ] + }, + "delete": { + "permissions": [ + "securityhub:DisableOrganizationAdminAccount", + "organizations:DescribeOrganization" + ] + }, + "list": { + "permissions": [ + "securityhub:ListOrganizationAdminAccounts", + "organizations:DescribeOrganization" + ] + }, + "read": { + "permissions": [ + "securityhub:ListOrganizationAdminAccounts", + "organizations:DescribeOrganization" + ] + } + }, + "primaryIdentifier": [ + "/properties/DelegatedAdminIdentifier" + ], + "properties": { + "AdminAccountId": { + "description": "The AWS-account identifier of the account to designate as the Security Hub administrator account.", + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DelegatedAdminIdentifier": { + "description": "", + "pattern": "^[0-9]{12}/[a-zA-Z0-9-]{1,32}$", + "type": "string" + }, + "Status": { + "description": "", + "enum": [ + "ENABLED", + "DISABLE_IN_PROGRESS" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DelegatedAdminIdentifier", + "/properties/Status" + ], + "required": [ + "AdminAccountId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SecurityHub::DelegatedAdmin" +} diff --git a/schema/aws-securityhub-findingaggregator.json b/schema/aws-securityhub-findingaggregator.json index 4bacfed..f5a200f 100644 --- a/schema/aws-securityhub-findingaggregator.json +++ b/schema/aws-securityhub-findingaggregator.json @@ -1,83 +1,83 @@ -{ - "additionalProperties": false, - "definitions": { - "Region": { - "pattern": "^[a-zA-Z0-9-]{1,32}$", - "type": "string" - } - }, - "description": "The AWS::SecurityHub::FindingAggregator resource represents the AWS Security Hub Finding Aggregator in your account. One finding aggregator resource is created for each account in non opt-in region in which you configure region linking mode.", - "handlers": { - "create": { - "permissions": [ - "securityhub:CreateFindingAggregator" - ] - }, - "delete": { - "permissions": [ - "securityhub:DeleteFindingAggregator" - ] - }, - "list": { - "permissions": [ - "securityhub:ListFindingAggregators" - ] - }, - "read": { - "permissions": [ - "securityhub:GetFindingAggregator" - ] - }, - "update": { - "permissions": [ - "securityhub:UpdateFindingAggregator" - ] - } - }, - "primaryIdentifier": [ - "/properties/FindingAggregatorArn" - ], - "properties": { - "FindingAggregationRegion": { - "$ref": "#/definitions/Region", - "description": "The aggregation Region of the FindingAggregator" - }, - "FindingAggregatorArn": { - "description": "The ARN of the FindingAggregator being created and assigned as the unique identifier", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - }, - "RegionLinkingMode": { - "description": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions", - "enum": [ - "ALL_REGIONS", - "ALL_REGIONS_EXCEPT_SPECIFIED", - "SPECIFIED_REGIONS" - ], - "type": "string" - }, - "Regions": { - "description": "The list of excluded Regions or included Regions", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Region" - }, - "maxItems": 50, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/FindingAggregatorArn", - "/properties/FindingAggregationRegion" - ], - "required": [ - "RegionLinkingMode" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityHub::FindingAggregator" -} +{ + "additionalProperties": false, + "definitions": { + "Region": { + "pattern": "^[a-zA-Z0-9-]{1,32}$", + "type": "string" + } + }, + "description": "The ``AWS::SecurityHub::FindingAggregator`` resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see [Cross-Region aggregation](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the *User Guide* \n This resource must be created in the Region that you want to designate as your aggregation Region.\n Cross-Region aggregation is also a prerequisite for using [central configuration](https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html) in ASH.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateFindingAggregator" + ] + }, + "delete": { + "permissions": [ + "securityhub:DeleteFindingAggregator" + ] + }, + "list": { + "permissions": [ + "securityhub:ListFindingAggregators" + ] + }, + "read": { + "permissions": [ + "securityhub:GetFindingAggregator" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateFindingAggregator" + ] + } + }, + "primaryIdentifier": [ + "/properties/FindingAggregatorArn" + ], + "properties": { + "FindingAggregationRegion": { + "$ref": "#/definitions/Region", + "description": "" + }, + "FindingAggregatorArn": { + "description": "", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "RegionLinkingMode": { + "description": "Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.\n The selected option also determines how to use the Regions provided in the Regions list.\n The options are as follows:\n + ``ALL_REGIONS`` - Aggregates findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. \n + ``ALL_REGIONS_EXCEPT_SPECIFIED`` - Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the ``Regions`` parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. \n + ``SPECIFIED_REGIONS`` - Aggregates findings only from the Regions listed in the ``Regions`` parameter. Security Hub does not automatically aggregate findings from new Regions. \n + ``NO_REGIONS`` - Aggregates no data because no Regions are selected as linked Regions.", + "enum": [ + "ALL_REGIONS", + "ALL_REGIONS_EXCEPT_SPECIFIED", + "SPECIFIED_REGIONS" + ], + "type": "string" + }, + "Regions": { + "description": "If ``RegionLinkingMode`` is ``ALL_REGIONS_EXCEPT_SPECIFIED``, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.\n If ``RegionLinkingMode`` is ``SPECIFIED_REGIONS``, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region. \n An ``InvalidInputException`` error results if you populate this field while ``RegionLinkingMode`` is ``NO_REGIONS``.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Region" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/FindingAggregatorArn", + "/properties/FindingAggregationRegion" + ], + "required": [ + "RegionLinkingMode" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::FindingAggregator" +} diff --git a/schema/aws-securityhub-hub.json b/schema/aws-securityhub-hub.json index 8e40d42..321cd2f 100644 --- a/schema/aws-securityhub-hub.json +++ b/schema/aws-securityhub-hub.json @@ -1,101 +1,101 @@ -{ - "additionalProperties": false, - "definitions": { - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - "^[a-zA-Z0-9-_]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.\n\n", - "handlers": { - "create": { - "permissions": [ - "securityhub:EnableSecurityHub", - "securityhub:UpdateSecurityHubConfiguration", - "securityhub:TagResource", - "securityhub:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "securityhub:DisableSecurityHub" - ] - }, - "list": { - "permissions": [ - "securityhub:DescribeHub", - "securityhub:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "securityhub:DescribeHub", - "securityhub:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "securityhub:DescribeHub", - "securityhub:UpdateSecurityHubConfiguration", - "securityhub:TagResource", - "securityhub:UntagResource", - "securityhub:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ARN" - ], - "properties": { - "ARN": { - "description": "An ARN is automatically created for the customer.", - "pattern": "^arn:.*", - "type": "string" - }, - "AutoEnableControls": { - "description": "Whether to automatically enable new controls when they are added to standards that are enabled", - "type": "boolean" - }, - "ControlFindingGenerator": { - "description": "This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.", - "pattern": "^(SECURITY_CONTROL|STANDARD_CONTROL)$", - "type": "string" - }, - "EnableDefaultStandards": { - "description": "Whether to enable the security standards that Security Hub has designated as automatically enabled.", - "type": "boolean" - }, - "SubscribedAt": { - "description": "The date and time when Security Hub was enabled in the account.", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/ARN", - "/properties/SubscribedAt" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecurityHub::Hub", - "writeOnlyProperties": [ - "/properties/EnableDefaultStandards" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9-_]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.\n\n", + "handlers": { + "create": { + "permissions": [ + "securityhub:EnableSecurityHub", + "securityhub:UpdateSecurityHubConfiguration", + "securityhub:TagResource", + "securityhub:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "securityhub:DisableSecurityHub" + ] + }, + "list": { + "permissions": [ + "securityhub:DescribeHub", + "securityhub:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "securityhub:DescribeHub", + "securityhub:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securityhub:DescribeHub", + "securityhub:UpdateSecurityHubConfiguration", + "securityhub:TagResource", + "securityhub:UntagResource", + "securityhub:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ARN" + ], + "properties": { + "ARN": { + "description": "An ARN is automatically created for the customer.", + "pattern": "^arn:.*", + "type": "string" + }, + "AutoEnableControls": { + "description": "Whether to automatically enable new controls when they are added to standards that are enabled", + "type": "boolean" + }, + "ControlFindingGenerator": { + "description": "This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.", + "pattern": "^(SECURITY_CONTROL|STANDARD_CONTROL)$", + "type": "string" + }, + "EnableDefaultStandards": { + "description": "Whether to enable the security standards that Security Hub has designated as automatically enabled.", + "type": "boolean" + }, + "SubscribedAt": { + "description": "The date and time when Security Hub was enabled in the account.", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/ARN", + "/properties/SubscribedAt" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityHub::Hub", + "writeOnlyProperties": [ + "/properties/EnableDefaultStandards" + ] +} diff --git a/schema/aws-securityhub-insight.json b/schema/aws-securityhub-insight.json index d3129d3..e2ed89a 100644 --- a/schema/aws-securityhub-insight.json +++ b/schema/aws-securityhub-insight.json @@ -1,1287 +1,1287 @@ -{ - "additionalProperties": false, - "definitions": { - "AwsSecurityFindingFilters": { - "additionalProperties": false, - "description": "A collection of filters that are applied to all active findings aggregated by AWS Security Hub.", - "properties": { - "AwsAccountId": { - "description": "The AWS account ID in which a finding is generated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "AwsAccountName": { - "description": "The name of the AWS account in which a finding is generated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "CompanyName": { - "description": "The name of the findings provider (company) that owns the solution (product) that generates findings.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ComplianceAssociatedStandardsId": { - "description": "The unique identifier of a standard in which a control is enabled.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ComplianceSecurityControlId": { - "description": "The unique identifier of a control across standards.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ComplianceSecurityControlParametersName": { - "description": "The name of a security control parameter.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ComplianceSecurityControlParametersValue": { - "description": "The current value of a security control parameter.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ComplianceStatus": { - "description": "Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Confidence": { - "description": "A finding's confidence.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "CreatedAt": { - "description": "An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Criticality": { - "description": "The level of importance assigned to the resources associated with the finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Description": { - "description": "A finding's description.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsConfidence": { - "description": "The finding provider value for the finding confidence.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsCriticality": { - "description": "The finding provider value for the level of importance assigned to the resources associated with the findings.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsRelatedFindingsId": { - "description": "The finding identifier of a related finding that is identified by the finding provider.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsRelatedFindingsProductArn": { - "description": "The ARN of the solution that generated a related finding that is identified by the finding provider.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsSeverityLabel": { - "description": "The finding provider value for the severity label.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsSeverityOriginal": { - "description": "The finding provider's original value for the severity.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FindingProviderFieldsTypes": { - "description": "One or more finding types that the finding provider assigned to the finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "FirstObservedAt": { - "description": "An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "GeneratorId": { - "description": "The identifier for the solution-specific component (a discrete unit of logic) that generated a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "The security findings provider-specific identifier for a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Keyword": { - "description": "A keyword for a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/KeywordFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "LastObservedAt": { - "description": "An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "MalwareName": { - "description": "The name of the malware that was observed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "MalwarePath": { - "description": "The filesystem path of the malware that was observed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "MalwareState": { - "description": "The state of the malware that was observed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "MalwareType": { - "description": "The type of the malware that was observed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkDestinationDomain": { - "description": "The destination domain of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkDestinationIpV4": { - "description": "The destination IPv4 address of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkDestinationIpV6": { - "description": "The destination IPv6 address of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkDestinationPort": { - "description": "The destination port of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkDirection": { - "description": "Indicates the direction of network traffic associated with a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkProtocol": { - "description": "The protocol of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkSourceDomain": { - "description": "The source domain of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkSourceIpV4": { - "description": "The source IPv4 address of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkSourceIpV6": { - "description": "The source IPv6 address of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkSourceMac": { - "description": "The source media access control (MAC) address of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NetworkSourcePort": { - "description": "The source port of network-related information about a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NoteText": { - "description": "The text of a note.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NoteUpdatedAt": { - "description": "The timestamp of when the note was updated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "NoteUpdatedBy": { - "description": "The principal that created a note.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessLaunchedAt": { - "description": "A timestamp that identifies when the process was launched.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessName": { - "description": "The name of the process.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessParentPid": { - "description": "The parent process ID.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessPath": { - "description": "The path to the process executable.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessPid": { - "description": "The process ID.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProcessTerminatedAt": { - "description": "A timestamp that identifies when the process was terminated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProductArn": { - "description": "The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProductFields": { - "description": "A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ProductName": { - "description": "The name of the solution (product) that generates findings.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "RecommendationText": { - "description": "The recommendation of what to do about the issue described in a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "RecordState": { - "description": "The updated record state for the finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Region": { - "description": "The Region from which the finding was generated.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "RelatedFindingsId": { - "description": "The solution-generated identifier for a related finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "RelatedFindingsProductArn": { - "description": "The ARN of the solution that generated a related finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceApplicationArn": { - "description": "The ARN of the application that is related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceApplicationName": { - "description": "The name of the application that is related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceIamInstanceProfileArn": { - "description": "The IAM profile ARN of the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceImageId": { - "description": "The Amazon Machine Image (AMI) ID of the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceIpV4Addresses": { - "description": "The IPv4 addresses associated with the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceIpV6Addresses": { - "description": "The IPv6 addresses associated with the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/IpFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceKeyName": { - "description": "The key name associated with the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceLaunchedAt": { - "description": "The date and time the instance was launched.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceSubnetId": { - "description": "The identifier of the subnet that the instance was launched in.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceType": { - "description": "The instance type of the instance.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsEc2InstanceVpcId": { - "description": "The identifier of the VPC that the instance was launched in.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsIamAccessKeyCreatedAt": { - "description": "The creation date/time of the IAM access key related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsIamAccessKeyPrincipalName": { - "description": "The name of the principal that is associated with an IAM access key.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsIamAccessKeyStatus": { - "description": "The status of the IAM access key related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsIamAccessKeyUserName": { - "description": "The user associated with the IAM access key related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsIamUserUserName": { - "description": "The name of an IAM user.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsS3BucketOwnerId": { - "description": "The canonical user ID of the owner of the S3 bucket.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceAwsS3BucketOwnerName": { - "description": "The display name of the owner of the S3 bucket.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceContainerImageId": { - "description": "The identifier of the image related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceContainerImageName": { - "description": "The name of the image related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceContainerLaunchedAt": { - "description": "A timestamp that identifies when the container was started.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceContainerName": { - "description": "The name of the container related to a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceDetailsOther": { - "description": "The details of a resource that doesn't have a specific subfield for the resource type defined.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceId": { - "description": "The canonical identifier for the given resource type.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourcePartition": { - "description": "The canonical AWS partition name that the Region is assigned to.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceRegion": { - "description": "The canonical AWS external Region name where this resource is located.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceTags": { - "description": "A list of AWS tags associated with a resource at the time the finding was processed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ResourceType": { - "description": "Specifies the type of the resource that details are provided for.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Sample": { - "description": "Indicates whether or not sample findings are included in the filter results.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/BooleanFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "SeverityLabel": { - "description": "The label of a finding's severity.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "SeverityNormalized": { - "description": "The normalized severity of a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "SeverityProduct": { - "description": "The native severity as defined by the security findings provider's solution that generated the finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/NumberFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "SourceUrl": { - "description": "A URL that links to a page about the current finding in the security findings provider's solution.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorCategory": { - "description": "The category of a threat intelligence indicator.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorLastObservedAt": { - "description": "A timestamp that identifies the last observation of a threat intelligence indicator.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorSource": { - "description": "The source of the threat intelligence.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorSourceUrl": { - "description": "The URL for more details from the source of the threat intelligence.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorType": { - "description": "The type of a threat intelligence indicator.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "ThreatIntelIndicatorValue": { - "description": "The value of a threat intelligence indicator.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Title": { - "description": "A finding's title.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "A finding type in the format of namespace/category/classifier that classifies a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "description": "An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/DateFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "UserDefinedFields": { - "description": "A list of name/value string pairs associated with the finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/MapFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "VerificationState": { - "description": "The veracity of a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "VulnerabilitiesExploitAvailable": { - "description": "Indicates whether a software vulnerability in your environment has a known exploit.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "VulnerabilitiesFixAvailable": { - "description": "Indicates whether a vulnerability is fixed in a newer version of the affected software packages.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "WorkflowState": { - "description": "The workflow state of a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - }, - "WorkflowStatus": { - "description": "The status of the investigation into a finding.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StringFilter" - }, - "maxItems": 20, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "BooleanFilter": { - "additionalProperties": false, - "description": "Boolean filter for querying findings.", - "properties": { - "Value": { - "description": "The value of the boolean.", - "type": "boolean" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "DateFilter": { - "additionalProperties": false, - "description": "A date filter for querying findings.", - "properties": { - "DateRange": { - "$ref": "#/definitions/DateRange" - }, - "End": { - "$ref": "#/definitions/ISO8601DateString" - }, - "Start": { - "$ref": "#/definitions/ISO8601DateString" - } - }, - "type": "object" - }, - "DateRange": { - "additionalProperties": false, - "description": "A date range for the date filter.", - "properties": { - "Unit": { - "description": "A date range unit for the date filter.", - "enum": [ - "DAYS" - ], - "type": "string" - }, - "Value": { - "description": "A date range value for the date filter.", - "type": "number" - } - }, - "required": [ - "Unit", - "Value" - ], - "type": "object" - }, - "ISO8601DateString": { - "description": "The date and time, in UTC and ISO 8601 format.", - "pattern": "^([\\+-]?\\d{4}(?!\\d{2}))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([tT]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$", - "type": "string" - }, - "IpFilter": { - "additionalProperties": false, - "description": "The IP filter for querying findings.", - "properties": { - "Cidr": { - "$ref": "#/definitions/NonEmptyString", - "description": "A finding's CIDR value." - } - }, - "required": [ - "Cidr" - ], - "type": "object" - }, - "KeywordFilter": { - "additionalProperties": false, - "description": "A keyword filter for querying findings.", - "properties": { - "Value": { - "$ref": "#/definitions/NonEmptyString", - "description": "A value for the keyword." - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "MapFilter": { - "additionalProperties": false, - "description": "A map filter for filtering AWS Security Hub findings.", - "properties": { - "Comparison": { - "description": "The condition to apply to the key value when filtering Security Hub findings with a map filter.", - "enum": [ - "EQUALS", - "NOT_EQUALS" - ], - "type": "string" - }, - "Key": { - "$ref": "#/definitions/NonEmptyString" - }, - "Value": { - "$ref": "#/definitions/NonEmptyString" - } - }, - "required": [ - "Comparison", - "Key", - "Value" - ], - "type": "object" - }, - "NonEmptyString": { - "description": "Non-empty string definition.", - "minLength": 1, - "type": "string" - }, - "NumberFilter": { - "additionalProperties": false, - "description": "A number filter for querying findings.", - "properties": { - "Eq": { - "description": "The equal-to condition to be applied to a single field when querying for findings.", - "type": "number" - }, - "Gte": { - "description": "The greater-than-equal condition to be applied to a single field when querying for findings.", - "type": "number" - }, - "Lte": { - "description": "The less-than-equal condition to be applied to a single field when querying for findings.", - "type": "number" - } - }, - "type": "object" - }, - "StringFilter": { - "additionalProperties": false, - "description": "A string filter for filtering AWS Security Hub findings.", - "properties": { - "Comparison": { - "$ref": "#/definitions/StringFilterComparison" - }, - "Value": { - "$ref": "#/definitions/NonEmptyString" - } - }, - "required": [ - "Comparison", - "Value" - ], - "type": "object" - }, - "StringFilterComparison": { - "description": "The condition to apply to a string value when filtering Security Hub findings.", - "enum": [ - "EQUALS", - "PREFIX", - "NOT_EQUALS", - "PREFIX_NOT_EQUALS" - ], - "type": "string" - } - }, - "deprecatedProperties": [ - "/properties/Filters/Keyword", - "/properties/Filters/ResourceAwsIamAccessKeyUserName", - "/properties/Filters/SeverityNormalized", - "/properties/Filters/SeverityProduct" - ], - "description": "The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.", - "handlers": { - "create": { - "permissions": [ - "securityhub:CreateInsight" - ] - }, - "delete": { - "permissions": [ - "securityhub:GetInsights", - "securityhub:DeleteInsight" - ] - }, - "list": { - "permissions": [ - "securityhub:GetInsights" - ] - }, - "read": { - "permissions": [ - "securityhub:GetInsights" - ] - }, - "update": { - "permissions": [ - "securityhub:UpdateInsight" - ] - } - }, - "primaryIdentifier": [ - "/properties/InsightArn" - ], - "properties": { - "Filters": { - "$ref": "#/definitions/AwsSecurityFindingFilters", - "description": "One or more attributes used to filter the findings included in the insight", - "maxProperties": 10 - }, - "GroupByAttribute": { - "$ref": "#/definitions/NonEmptyString", - "description": "The grouping attribute for the insight's findings" - }, - "InsightArn": { - "description": "The ARN of a Security Hub insight", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - }, - "Name": { - "description": "The name of a Security Hub insight", - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/InsightArn" - ], - "required": [ - "Filters", - "Name", - "GroupByAttribute" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityHub::Insight" -} +{ + "additionalProperties": false, + "definitions": { + "AwsSecurityFindingFilters": { + "additionalProperties": false, + "description": "A collection of filters that are applied to all active findings aggregated by AWS Security Hub.", + "properties": { + "AwsAccountId": { + "description": "The AWS account ID in which a finding is generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "AwsAccountName": { + "description": "The name of the AWS account in which a finding is generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "CompanyName": { + "description": "The name of the findings provider (company) that owns the solution (product) that generates findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceAssociatedStandardsId": { + "description": "The unique identifier of a standard in which a control is enabled.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlId": { + "description": "The unique identifier of a control across standards.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlParametersName": { + "description": "The name of a security control parameter.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlParametersValue": { + "description": "The current value of a security control parameter.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceStatus": { + "description": "Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Confidence": { + "description": "A finding's confidence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "CreatedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Criticality": { + "description": "The level of importance assigned to the resources associated with the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "A finding's description.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsConfidence": { + "description": "The finding provider value for the finding confidence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsCriticality": { + "description": "The finding provider value for the level of importance assigned to the resources associated with the findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsRelatedFindingsId": { + "description": "The finding identifier of a related finding that is identified by the finding provider.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsRelatedFindingsProductArn": { + "description": "The ARN of the solution that generated a related finding that is identified by the finding provider.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsSeverityLabel": { + "description": "The finding provider value for the severity label.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsSeverityOriginal": { + "description": "The finding provider's original value for the severity.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsTypes": { + "description": "One or more finding types that the finding provider assigned to the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FirstObservedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "GeneratorId": { + "description": "The identifier for the solution-specific component (a discrete unit of logic) that generated a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "The security findings provider-specific identifier for a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Keyword": { + "description": "A keyword for a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/KeywordFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "LastObservedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareName": { + "description": "The name of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwarePath": { + "description": "The filesystem path of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareState": { + "description": "The state of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareType": { + "description": "The type of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationDomain": { + "description": "The destination domain of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationIpV4": { + "description": "The destination IPv4 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationIpV6": { + "description": "The destination IPv6 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationPort": { + "description": "The destination port of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDirection": { + "description": "Indicates the direction of network traffic associated with a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkProtocol": { + "description": "The protocol of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceDomain": { + "description": "The source domain of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceIpV4": { + "description": "The source IPv4 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceIpV6": { + "description": "The source IPv6 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceMac": { + "description": "The source media access control (MAC) address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourcePort": { + "description": "The source port of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteText": { + "description": "The text of a note.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteUpdatedAt": { + "description": "The timestamp of when the note was updated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteUpdatedBy": { + "description": "The principal that created a note.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessLaunchedAt": { + "description": "A timestamp that identifies when the process was launched.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessName": { + "description": "The name of the process.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessParentPid": { + "description": "The parent process ID.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessPath": { + "description": "The path to the process executable.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessPid": { + "description": "The process ID.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessTerminatedAt": { + "description": "A timestamp that identifies when the process was terminated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductArn": { + "description": "The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductFields": { + "description": "A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductName": { + "description": "The name of the solution (product) that generates findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RecommendationText": { + "description": "The recommendation of what to do about the issue described in a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RecordState": { + "description": "The updated record state for the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Region": { + "description": "The Region from which the finding was generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RelatedFindingsId": { + "description": "The solution-generated identifier for a related finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RelatedFindingsProductArn": { + "description": "The ARN of the solution that generated a related finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceApplicationArn": { + "description": "The ARN of the application that is related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceApplicationName": { + "description": "The name of the application that is related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn": { + "description": "The IAM profile ARN of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceImageId": { + "description": "The Amazon Machine Image (AMI) ID of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIpV4Addresses": { + "description": "The IPv4 addresses associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIpV6Addresses": { + "description": "The IPv6 addresses associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceKeyName": { + "description": "The key name associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceLaunchedAt": { + "description": "The date and time the instance was launched.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceSubnetId": { + "description": "The identifier of the subnet that the instance was launched in.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceType": { + "description": "The instance type of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceVpcId": { + "description": "The identifier of the VPC that the instance was launched in.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyCreatedAt": { + "description": "The creation date/time of the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyPrincipalName": { + "description": "The name of the principal that is associated with an IAM access key.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyStatus": { + "description": "The status of the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyUserName": { + "description": "The user associated with the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamUserUserName": { + "description": "The name of an IAM user.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsS3BucketOwnerId": { + "description": "The canonical user ID of the owner of the S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsS3BucketOwnerName": { + "description": "The display name of the owner of the S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerImageId": { + "description": "The identifier of the image related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerImageName": { + "description": "The name of the image related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerLaunchedAt": { + "description": "A timestamp that identifies when the container was started.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerName": { + "description": "The name of the container related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceDetailsOther": { + "description": "The details of a resource that doesn't have a specific subfield for the resource type defined.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceId": { + "description": "The canonical identifier for the given resource type.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourcePartition": { + "description": "The canonical AWS partition name that the Region is assigned to.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceRegion": { + "description": "The canonical AWS external Region name where this resource is located.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceTags": { + "description": "A list of AWS tags associated with a resource at the time the finding was processed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceType": { + "description": "Specifies the type of the resource that details are provided for.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Sample": { + "description": "Indicates whether or not sample findings are included in the filter results.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/BooleanFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityLabel": { + "description": "The label of a finding's severity.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityNormalized": { + "description": "The normalized severity of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityProduct": { + "description": "The native severity as defined by the security findings provider's solution that generated the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SourceUrl": { + "description": "A URL that links to a page about the current finding in the security findings provider's solution.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorCategory": { + "description": "The category of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorLastObservedAt": { + "description": "A timestamp that identifies the last observation of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorSource": { + "description": "The source of the threat intelligence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorSourceUrl": { + "description": "The URL for more details from the source of the threat intelligence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorType": { + "description": "The type of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorValue": { + "description": "The value of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Title": { + "description": "A finding's title.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "A finding type in the format of namespace/category/classifier that classifies a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "UserDefinedFields": { + "description": "A list of name/value string pairs associated with the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VerificationState": { + "description": "The veracity of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VulnerabilitiesExploitAvailable": { + "description": "Indicates whether a software vulnerability in your environment has a known exploit.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VulnerabilitiesFixAvailable": { + "description": "Indicates whether a vulnerability is fixed in a newer version of the affected software packages.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "WorkflowState": { + "description": "The workflow state of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "WorkflowStatus": { + "description": "The status of the investigation into a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "BooleanFilter": { + "additionalProperties": false, + "description": "Boolean filter for querying findings.", + "properties": { + "Value": { + "description": "The value of the boolean.", + "type": "boolean" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "DateFilter": { + "additionalProperties": false, + "description": "A date filter for querying findings.", + "properties": { + "DateRange": { + "$ref": "#/definitions/DateRange" + }, + "End": { + "$ref": "#/definitions/ISO8601DateString" + }, + "Start": { + "$ref": "#/definitions/ISO8601DateString" + } + }, + "type": "object" + }, + "DateRange": { + "additionalProperties": false, + "description": "A date range for the date filter.", + "properties": { + "Unit": { + "description": "A date range unit for the date filter.", + "enum": [ + "DAYS" + ], + "type": "string" + }, + "Value": { + "description": "A date range value for the date filter.", + "type": "number" + } + }, + "required": [ + "Unit", + "Value" + ], + "type": "object" + }, + "ISO8601DateString": { + "description": "The date and time, in UTC and ISO 8601 format.", + "pattern": "^([\\+-]?\\d{4}(?!\\d{2}))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([tT]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$", + "type": "string" + }, + "IpFilter": { + "additionalProperties": false, + "description": "The IP filter for querying findings.", + "properties": { + "Cidr": { + "$ref": "#/definitions/NonEmptyString", + "description": "A finding's CIDR value." + } + }, + "required": [ + "Cidr" + ], + "type": "object" + }, + "KeywordFilter": { + "additionalProperties": false, + "description": "A keyword filter for querying findings.", + "properties": { + "Value": { + "$ref": "#/definitions/NonEmptyString", + "description": "A value for the keyword." + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "MapFilter": { + "additionalProperties": false, + "description": "A map filter for filtering AWS Security Hub findings.", + "properties": { + "Comparison": { + "description": "The condition to apply to the key value when filtering Security Hub findings with a map filter.", + "enum": [ + "EQUALS", + "NOT_EQUALS" + ], + "type": "string" + }, + "Key": { + "$ref": "#/definitions/NonEmptyString" + }, + "Value": { + "$ref": "#/definitions/NonEmptyString" + } + }, + "required": [ + "Comparison", + "Key", + "Value" + ], + "type": "object" + }, + "NonEmptyString": { + "description": "Non-empty string definition.", + "minLength": 1, + "type": "string" + }, + "NumberFilter": { + "additionalProperties": false, + "description": "A number filter for querying findings.", + "properties": { + "Eq": { + "description": "The equal-to condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Gte": { + "description": "The greater-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Lte": { + "description": "The less-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + } + }, + "type": "object" + }, + "StringFilter": { + "additionalProperties": false, + "description": "A string filter for filtering AWS Security Hub findings.", + "properties": { + "Comparison": { + "$ref": "#/definitions/StringFilterComparison" + }, + "Value": { + "$ref": "#/definitions/NonEmptyString" + } + }, + "required": [ + "Comparison", + "Value" + ], + "type": "object" + }, + "StringFilterComparison": { + "description": "The condition to apply to a string value when filtering Security Hub findings.", + "enum": [ + "EQUALS", + "PREFIX", + "NOT_EQUALS", + "PREFIX_NOT_EQUALS" + ], + "type": "string" + } + }, + "deprecatedProperties": [ + "/properties/Filters/Keyword", + "/properties/Filters/ResourceAwsIamAccessKeyUserName", + "/properties/Filters/SeverityNormalized", + "/properties/Filters/SeverityProduct" + ], + "description": "The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateInsight" + ] + }, + "delete": { + "permissions": [ + "securityhub:GetInsights", + "securityhub:DeleteInsight" + ] + }, + "list": { + "permissions": [ + "securityhub:GetInsights" + ] + }, + "read": { + "permissions": [ + "securityhub:GetInsights" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateInsight" + ] + } + }, + "primaryIdentifier": [ + "/properties/InsightArn" + ], + "properties": { + "Filters": { + "$ref": "#/definitions/AwsSecurityFindingFilters", + "description": "One or more attributes used to filter the findings included in the insight", + "maxProperties": 10 + }, + "GroupByAttribute": { + "$ref": "#/definitions/NonEmptyString", + "description": "The grouping attribute for the insight's findings" + }, + "InsightArn": { + "description": "The ARN of a Security Hub insight", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "Name": { + "description": "The name of a Security Hub insight", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/InsightArn" + ], + "required": [ + "Filters", + "Name", + "GroupByAttribute" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::Insight" +} diff --git a/schema/aws-securityhub-organizationconfiguration.json b/schema/aws-securityhub-organizationconfiguration.json index 3a8622b..be799f2 100644 --- a/schema/aws-securityhub-organizationconfiguration.json +++ b/schema/aws-securityhub-organizationconfiguration.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "description": "The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.", - "handlers": { - "create": { - "permissions": [ - "securityhub:UpdateOrganizationConfiguration", - "securityhub:DescribeOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - }, - "delete": { - "permissions": [ - "securityhub:UpdateOrganizationConfiguration", - "securityhub:DescribeOrganizationConfiguration", - "securityhub:ListFindingAggregators", - "organizations:DescribeOrganization" - ] - }, - "list": { - "permissions": [ - "securityhub:DescribeOrganizationConfiguration" - ] - }, - "read": { - "permissions": [ - "securityhub:DescribeOrganizationConfiguration" - ] - }, - "update": { - "permissions": [ - "securityhub:UpdateOrganizationConfiguration", - "securityhub:DescribeOrganizationConfiguration", - "organizations:DescribeOrganization" - ] - } - }, - "primaryIdentifier": [ - "/properties/OrganizationConfigurationIdentifier" - ], - "properties": { - "AutoEnable": { - "description": "Whether to automatically enable Security Hub in new member accounts when they join the organization.", - "type": "boolean" - }, - "AutoEnableStandards": { - "description": "Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.", - "enum": [ - "DEFAULT", - "NONE" - ], - "type": "string" - }, - "ConfigurationType": { - "description": "Indicates whether the organization uses local or central configuration.", - "enum": [ - "CENTRAL", - "LOCAL" - ], - "type": "string" - }, - "MemberAccountLimitReached": { - "description": "Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.", - "type": "boolean" - }, - "OrganizationConfigurationIdentifier": { - "description": "The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.", - "pattern": "^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$", - "type": "string" - }, - "Status": { - "description": "Describes whether central configuration could be enabled as the ConfigurationType for the organization.", - "enum": [ - "PENDING", - "ENABLED", - "FAILED" - ], - "type": "string" - }, - "StatusMessage": { - "description": "Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/OrganizationConfigurationIdentifier", - "/properties/Status", - "/properties/StatusMessage", - "/properties/MemberAccountLimitReached" - ], - "required": [ - "AutoEnable" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityHub::OrganizationConfiguration" -} +{ + "additionalProperties": false, + "description": "The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.", + "handlers": { + "create": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + }, + "delete": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "securityhub:ListFindingAggregators", + "organizations:DescribeOrganization" + ] + }, + "list": { + "permissions": [ + "securityhub:DescribeOrganizationConfiguration" + ] + }, + "read": { + "permissions": [ + "securityhub:DescribeOrganizationConfiguration" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + } + }, + "primaryIdentifier": [ + "/properties/OrganizationConfigurationIdentifier" + ], + "properties": { + "AutoEnable": { + "description": "Whether to automatically enable Security Hub in new member accounts when they join the organization.", + "type": "boolean" + }, + "AutoEnableStandards": { + "description": "Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.", + "enum": [ + "DEFAULT", + "NONE" + ], + "type": "string" + }, + "ConfigurationType": { + "description": "Indicates whether the organization uses local or central configuration.", + "enum": [ + "CENTRAL", + "LOCAL" + ], + "type": "string" + }, + "MemberAccountLimitReached": { + "description": "Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.", + "type": "boolean" + }, + "OrganizationConfigurationIdentifier": { + "description": "The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.", + "pattern": "^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$", + "type": "string" + }, + "Status": { + "description": "Describes whether central configuration could be enabled as the ConfigurationType for the organization.", + "enum": [ + "PENDING", + "ENABLED", + "FAILED" + ], + "type": "string" + }, + "StatusMessage": { + "description": "Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/OrganizationConfigurationIdentifier", + "/properties/Status", + "/properties/StatusMessage", + "/properties/MemberAccountLimitReached" + ], + "required": [ + "AutoEnable" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::OrganizationConfiguration" +} diff --git a/schema/aws-securityhub-policyassociation.json b/schema/aws-securityhub-policyassociation.json index 4437581..6a6aec1 100644 --- a/schema/aws-securityhub-policyassociation.json +++ b/schema/aws-securityhub-policyassociation.json @@ -1,108 +1,108 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TargetId", - "/properties/TargetType" - ], - "description": "The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.", - "handlers": { - "create": { - "permissions": [ - "securityhub:StartConfigurationPolicyAssociation", - "securityhub:GetConfigurationPolicyAssociation" - ] - }, - "delete": { - "permissions": [ - "securityhub:StartConfigurationPolicyDisassociation", - "securityhub:GetConfigurationPolicyAssociation" - ] - }, - "list": { - "permissions": [ - "securityhub:ListConfigurationPolicyAssociations" - ] - }, - "read": { - "permissions": [ - "securityhub:GetConfigurationPolicyAssociation", - "securityhub:GetConfigurationPolicyAssociation" - ] - }, - "update": { - "permissions": [ - "securityhub:StartConfigurationPolicyAssociation", - "securityhub:GetConfigurationPolicyAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationIdentifier" - ], - "properties": { - "AssociationIdentifier": { - "description": "A unique identifier to indicates if the target has an association", - "type": "string" - }, - "AssociationStatus": { - "description": "The current status of the association between the specified target and the configuration", - "enum": [ - "SUCCESS", - "PENDING", - "FAILED" - ], - "type": "string" - }, - "AssociationStatusMessage": { - "description": "An explanation for a FAILED value for AssociationStatus", - "type": "string" - }, - "AssociationType": { - "description": "Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent", - "enum": [ - "APPLIED", - "INHERITED" - ], - "type": "string" - }, - "ConfigurationPolicyId": { - "description": "The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration", - "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$", - "type": "string" - }, - "TargetId": { - "description": "The identifier of the target account, organizational unit, or the root", - "type": "string" - }, - "TargetType": { - "description": "Indicates whether the target is an AWS account, organizational unit, or the organization root", - "enum": [ - "ACCOUNT", - "ORGANIZATIONAL_UNIT", - "ROOT" - ], - "type": "string" - }, - "UpdatedAt": { - "description": "The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociationStatus", - "/properties/AssociationType", - "/properties/AssociationStatusMessage", - "/properties/UpdatedAt", - "/properties/AssociationIdentifier" - ], - "required": [ - "TargetId", - "TargetType", - "ConfigurationPolicyId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityHub::PolicyAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetId", + "/properties/TargetType" + ], + "description": "The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.", + "handlers": { + "create": { + "permissions": [ + "securityhub:StartConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "delete": { + "permissions": [ + "securityhub:StartConfigurationPolicyDisassociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "list": { + "permissions": [ + "securityhub:ListConfigurationPolicyAssociations" + ] + }, + "read": { + "permissions": [ + "securityhub:GetConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "update": { + "permissions": [ + "securityhub:StartConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationIdentifier" + ], + "properties": { + "AssociationIdentifier": { + "description": "A unique identifier to indicates if the target has an association", + "type": "string" + }, + "AssociationStatus": { + "description": "The current status of the association between the specified target and the configuration", + "enum": [ + "SUCCESS", + "PENDING", + "FAILED" + ], + "type": "string" + }, + "AssociationStatusMessage": { + "description": "An explanation for a FAILED value for AssociationStatus", + "type": "string" + }, + "AssociationType": { + "description": "Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent", + "enum": [ + "APPLIED", + "INHERITED" + ], + "type": "string" + }, + "ConfigurationPolicyId": { + "description": "The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$", + "type": "string" + }, + "TargetId": { + "description": "The identifier of the target account, organizational unit, or the root", + "type": "string" + }, + "TargetType": { + "description": "Indicates whether the target is an AWS account, organizational unit, or the organization root", + "enum": [ + "ACCOUNT", + "ORGANIZATIONAL_UNIT", + "ROOT" + ], + "type": "string" + }, + "UpdatedAt": { + "description": "The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationStatus", + "/properties/AssociationType", + "/properties/AssociationStatusMessage", + "/properties/UpdatedAt", + "/properties/AssociationIdentifier" + ], + "required": [ + "TargetId", + "TargetType", + "ConfigurationPolicyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::PolicyAssociation" +} diff --git a/schema/aws-securityhub-productsubscription.json b/schema/aws-securityhub-productsubscription.json index d38bb72..c370a19 100644 --- a/schema/aws-securityhub-productsubscription.json +++ b/schema/aws-securityhub-productsubscription.json @@ -1,60 +1,60 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProductArn" - ], - "description": "The AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.", - "handlers": { - "create": { - "permissions": [ - "securityhub:EnableImportFindingsForProduct" - ] - }, - "delete": { - "permissions": [ - "securityhub:ListEnabledProductsForImport", - "securityhub:DisableImportFindingsForProduct" - ] - }, - "list": { - "permissions": [ - "securityhub:ListEnabledProductsForImport" - ] - }, - "read": { - "permissions": [ - "securityhub:ListEnabledProductsForImport" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProductSubscriptionArn" - ], - "properties": { - "ProductArn": { - "description": "The generic ARN of the product being subscribed to", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - }, - "ProductSubscriptionArn": { - "description": "The ARN of the product subscription for the account", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ProductSubscriptionArn" - ], - "required": [ - "ProductArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SecurityHub::ProductSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProductArn" + ], + "description": "The AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.", + "handlers": { + "create": { + "permissions": [ + "securityhub:EnableImportFindingsForProduct" + ] + }, + "delete": { + "permissions": [ + "securityhub:ListEnabledProductsForImport", + "securityhub:DisableImportFindingsForProduct" + ] + }, + "list": { + "permissions": [ + "securityhub:ListEnabledProductsForImport" + ] + }, + "read": { + "permissions": [ + "securityhub:ListEnabledProductsForImport" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProductSubscriptionArn" + ], + "properties": { + "ProductArn": { + "description": "The generic ARN of the product being subscribed to", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "ProductSubscriptionArn": { + "description": "The ARN of the product subscription for the account", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ProductSubscriptionArn" + ], + "required": [ + "ProductArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SecurityHub::ProductSubscription" +} diff --git a/schema/aws-securityhub-securitycontrol.json b/schema/aws-securityhub-securitycontrol.json index 0155c81..eaa6bc4 100644 --- a/schema/aws-securityhub-securitycontrol.json +++ b/schema/aws-securityhub-securitycontrol.json @@ -1,219 +1,222 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/SecurityControlArn" - ] - ], - "additionalProperties": false, - "anyOf": [ - { - "required": [ - "SecurityControlId" - ] - }, - { - "required": [ - "SecurityControlArn" - ] - } - ], - "definitions": { - "IntegerList": { - "items": { - "type": "integer" - }, - "type": "array" - }, - "NonEmptyString": { - "pattern": ".*\\S.*", - "type": "string" - }, - "NonEmptyStringList": { - "items": { - "$ref": "#/definitions/NonEmptyString" - }, - "type": "array" - }, - "ParameterConfiguration": { - "additionalProperties": false, - "properties": { - "Value": { - "$ref": "#/definitions/ParameterValue" - }, - "ValueType": { - "enum": [ - "DEFAULT", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "ValueType" - ], - "type": "object" - }, - "ParameterValue": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "Boolean" - ] - }, - { - "required": [ - "Double" - ] - }, - { - "required": [ - "Enum" - ] - }, - { - "required": [ - "EnumList" - ] - }, - { - "required": [ - "Integer" - ] - }, - { - "required": [ - "IntegerList" - ] - }, - { - "required": [ - "String" - ] - }, - { - "required": [ - "StringList" - ] - } - ], - "properties": { - "Boolean": { - "description": "A control parameter that is a boolean.", - "type": "boolean" - }, - "Double": { - "description": "A control parameter that is a double.", - "type": "number" - }, - "Enum": { - "$ref": "#/definitions/NonEmptyString", - "description": "A control parameter that is a enum." - }, - "EnumList": { - "$ref": "#/definitions/NonEmptyStringList", - "description": "A control parameter that is a list of enums." - }, - "Integer": { - "description": "A control parameter that is a integer.", - "type": "integer" - }, - "IntegerList": { - "$ref": "#/definitions/IntegerList", - "description": "A control parameter that is a list of integers." - }, - "String": { - "$ref": "#/definitions/NonEmptyString", - "description": "A control parameter that is a string." - }, - "StringList": { - "$ref": "#/definitions/NonEmptyStringList", - "description": "A control parameter that is a list of strings." - } - }, - "type": "object" - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - ".*\\S.*": { - "$ref": "#/definitions/ParameterConfiguration" - } - }, - "type": "object" - } - }, - "description": "A security control in Security Hub describes a security best practice related to a specific resource.", - "handlers": { - "create": { - "permissions": [ - "securityhub:BatchGetSecurityControls", - "securityhub:DescribeStandardsControls", - "securityhub:UpdateSecurityControl", - "securityhub:UpdateStandardsControl" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "securityhub:BatchGetSecurityControls", - "securityhub:DescribeStandardsControls", - "securityhub:UpdateSecurityControl", - "securityhub:UpdateStandardsControl" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "securityhub:BatchGetSecurityControls", - "securityhub:DescribeStandardsControls", - "securityhub:ListSecurityControlDefinitions" - ] - }, - "read": { - "permissions": [ - "securityhub:BatchGetSecurityControls", - "securityhub:DescribeStandardsControls" - ] - }, - "update": { - "permissions": [ - "securityhub:BatchGetSecurityControls", - "securityhub:DescribeStandardsControls", - "securityhub:UpdateSecurityControl", - "securityhub:UpdateStandardsControl" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/SecurityControlId" - ], - "properties": { - "LastUpdateReason": { - "description": "The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.", - "pattern": "^([^\u0000-\u007f]|[-_ a-zA-Z0-9])+$", - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/Parameters", - "description": "An object that identifies the name of a control parameter, its current value, and whether it has been customized." - }, - "SecurityControlArn": { - "$ref": "#/definitions/NonEmptyString", - "description": "The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard." - }, - "SecurityControlId": { - "$ref": "#/definitions/NonEmptyString", - "description": "The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3." - } - }, - "required": [ - "Parameters" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityHub::SecurityControl" -} +{ + "additionalIdentifiers": [ + [ + "/properties/SecurityControlArn" + ] + ], + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "SecurityControlId" + ] + }, + { + "required": [ + "SecurityControlArn" + ] + } + ], + "createOnlyProperties": [ + "/properties/SecurityControlId" + ], + "definitions": { + "IntegerList": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "NonEmptyString": { + "pattern": ".*\\S.*", + "type": "string" + }, + "NonEmptyStringList": { + "items": { + "$ref": "#/definitions/NonEmptyString" + }, + "type": "array" + }, + "ParameterConfiguration": { + "additionalProperties": false, + "properties": { + "Value": { + "$ref": "#/definitions/ParameterValue" + }, + "ValueType": { + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "ValueType" + ], + "type": "object" + }, + "ParameterValue": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "Boolean" + ] + }, + { + "required": [ + "Double" + ] + }, + { + "required": [ + "Enum" + ] + }, + { + "required": [ + "EnumList" + ] + }, + { + "required": [ + "Integer" + ] + }, + { + "required": [ + "IntegerList" + ] + }, + { + "required": [ + "String" + ] + }, + { + "required": [ + "StringList" + ] + } + ], + "properties": { + "Boolean": { + "description": "A control parameter that is a boolean.", + "type": "boolean" + }, + "Double": { + "description": "A control parameter that is a double.", + "type": "number" + }, + "Enum": { + "$ref": "#/definitions/NonEmptyString", + "description": "A control parameter that is a enum." + }, + "EnumList": { + "$ref": "#/definitions/NonEmptyStringList", + "description": "A control parameter that is a list of enums." + }, + "Integer": { + "description": "A control parameter that is a integer.", + "type": "integer" + }, + "IntegerList": { + "$ref": "#/definitions/IntegerList", + "description": "A control parameter that is a list of integers." + }, + "String": { + "$ref": "#/definitions/NonEmptyString", + "description": "A control parameter that is a string." + }, + "StringList": { + "$ref": "#/definitions/NonEmptyStringList", + "description": "A control parameter that is a list of strings." + } + }, + "type": "object" + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + ".*\\S.*": { + "$ref": "#/definitions/ParameterConfiguration" + } + }, + "type": "object" + } + }, + "description": "A security control in Security Hub describes a security best practice related to a specific resource.", + "handlers": { + "create": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:ListSecurityControlDefinitions" + ] + }, + "read": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls" + ] + }, + "update": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/SecurityControlId" + ], + "properties": { + "LastUpdateReason": { + "description": "The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.", + "pattern": "^([^\u0000-\u007f]|[-_ a-zA-Z0-9])+$", + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/Parameters", + "description": "An object that identifies the name of a control parameter, its current value, and whether it has been customized." + }, + "SecurityControlArn": { + "$ref": "#/definitions/NonEmptyString", + "description": "The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard." + }, + "SecurityControlId": { + "$ref": "#/definitions/NonEmptyString", + "description": "The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3." + } + }, + "required": [ + "Parameters" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::SecurityControl" +} diff --git a/schema/aws-securityhub-standard.json b/schema/aws-securityhub-standard.json index b434fa0..a7ceac0 100644 --- a/schema/aws-securityhub-standard.json +++ b/schema/aws-securityhub-standard.json @@ -1,106 +1,106 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/StandardsArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StandardsArn" - ], - "definitions": { - "StandardsControl": { - "additionalProperties": false, - "description": "Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*.", - "properties": { - "Reason": { - "description": "A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required.", - "type": "string" - }, - "StandardsControlArn": { - "description": "The Amazon Resource Name (ARN) of the control.", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - } - }, - "required": [ - "StandardsControlArn" - ], - "type": "object" - } - }, - "description": "The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.\n You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.\n For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "securityhub:GetEnabledStandards", - "securityhub:BatchEnableStandards", - "securityhub:UpdateStandardsControl" - ] - }, - "delete": { - "permissions": [ - "securityhub:GetEnabledStandards", - "securityhub:BatchDisableStandards" - ] - }, - "list": { - "permissions": [ - "securityhub:GetEnabledStandards" - ] - }, - "read": { - "permissions": [ - "securityhub:GetEnabledStandards", - "securityhub:DescribeStandardsControls" - ] - }, - "update": { - "permissions": [ - "securityhub:GetEnabledStandards", - "securityhub:UpdateStandardsControl" - ] - } - }, - "primaryIdentifier": [ - "/properties/StandardsSubscriptionArn" - ], - "properties": { - "DisabledStandardsControls": { - "description": "Specifies which controls are to be disabled in a standard. \n *Maximum*: ``100``", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/StandardsControl" - }, - "maxItems": 100, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "StandardsArn": { - "description": "The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.", - "pattern": "arn:aws\\S*:securityhub:\\S", - "type": "string" - }, - "StandardsSubscriptionArn": { - "description": "", - "pattern": "arn:aws\\S*:securityhub:\\S*", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/StandardsSubscriptionArn" - ], - "required": [ - "StandardsArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SecurityHub::Standard" -} +{ + "additionalIdentifiers": [ + [ + "/properties/StandardsArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StandardsArn" + ], + "definitions": { + "StandardsControl": { + "additionalProperties": false, + "description": "Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*.", + "properties": { + "Reason": { + "description": "A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required.", + "type": "string" + }, + "StandardsControlArn": { + "description": "The Amazon Resource Name (ARN) of the control.", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + } + }, + "required": [ + "StandardsControlArn" + ], + "type": "object" + } + }, + "description": "The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.\n You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.\n For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "securityhub:GetEnabledStandards", + "securityhub:BatchEnableStandards", + "securityhub:UpdateStandardsControl" + ] + }, + "delete": { + "permissions": [ + "securityhub:GetEnabledStandards", + "securityhub:BatchDisableStandards" + ] + }, + "list": { + "permissions": [ + "securityhub:GetEnabledStandards" + ] + }, + "read": { + "permissions": [ + "securityhub:GetEnabledStandards", + "securityhub:DescribeStandardsControls" + ] + }, + "update": { + "permissions": [ + "securityhub:GetEnabledStandards", + "securityhub:UpdateStandardsControl" + ] + } + }, + "primaryIdentifier": [ + "/properties/StandardsSubscriptionArn" + ], + "properties": { + "DisabledStandardsControls": { + "description": "Specifies which controls are to be disabled in a standard. \n *Maximum*: ``100``", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StandardsControl" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "StandardsArn": { + "description": "The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.", + "pattern": "arn:aws\\S*:securityhub:\\S", + "type": "string" + }, + "StandardsSubscriptionArn": { + "description": "", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StandardsSubscriptionArn" + ], + "required": [ + "StandardsArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SecurityHub::Standard" +} diff --git a/schema/aws-securitylake-awslogsource.json b/schema/aws-securitylake-awslogsource.json index 9832766..94b1605 100644 --- a/schema/aws-securitylake-awslogsource.json +++ b/schema/aws-securitylake-awslogsource.json @@ -1,96 +1,96 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataLakeArn", - "/properties/SourceName", - "/properties/SourceVersion" - ], - "description": "Resource Type definition for AWS::SecurityLake::AwsLogSource", - "handlers": { - "create": { - "permissions": [ - "glue:CreateDatabase", - "glue:CreateTable", - "glue:GetDatabase", - "glue:GetTable", - "iam:CreateServiceLinkedRole", - "kms:CreateGrant", - "kms:DescribeKey", - "securitylake:CreateDataLake", - "securitylake:CreateAwsLogSource", - "securitylake:ListLogSources" - ] - }, - "delete": { - "permissions": [ - "securitylake:DeleteAwsLogSource", - "securitylake:ListLogSources" - ] - }, - "list": { - "permissions": [ - "securitylake:ListLogSources" - ] - }, - "read": { - "permissions": [ - "securitylake:ListLogSources" - ] - }, - "update": { - "permissions": [ - "securitylake:CreateAwsLogSource", - "securitylake:DeleteAwsLogSource", - "glue:CreateDatabase", - "glue:CreateTable", - "glue:GetDatabase", - "glue:GetTable", - "iam:CreateServiceLinkedRole", - "kms:CreateGrant", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/SourceName", - "/properties/SourceVersion" - ], - "properties": { - "Accounts": { - "description": "AWS account where you want to collect logs from.", - "insertionOrder": false, - "items": { - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "DataLakeArn": { - "description": "The ARN for the data lake.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "SourceName": { - "description": "The name for a AWS source. This must be a Regionally unique value.", - "type": "string" - }, - "SourceVersion": { - "description": "The version for a AWS source. This must be a Regionally unique value.", - "pattern": "^(latest|[0-9]\\.[0-9])$", - "type": "string" - } - }, - "replacementStrategy": "delete_then_create", - "required": [ - "DataLakeArn", - "SourceVersion", - "SourceName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityLake::AwsLogSource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataLakeArn", + "/properties/SourceName", + "/properties/SourceVersion" + ], + "description": "Resource Type definition for AWS::SecurityLake::AwsLogSource", + "handlers": { + "create": { + "permissions": [ + "glue:CreateDatabase", + "glue:CreateTable", + "glue:GetDatabase", + "glue:GetTable", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:DescribeKey", + "securitylake:CreateDataLake", + "securitylake:CreateAwsLogSource", + "securitylake:ListLogSources" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteAwsLogSource", + "securitylake:ListLogSources" + ] + }, + "list": { + "permissions": [ + "securitylake:ListLogSources" + ] + }, + "read": { + "permissions": [ + "securitylake:ListLogSources" + ] + }, + "update": { + "permissions": [ + "securitylake:CreateAwsLogSource", + "securitylake:DeleteAwsLogSource", + "glue:CreateDatabase", + "glue:CreateTable", + "glue:GetDatabase", + "glue:GetTable", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/SourceName", + "/properties/SourceVersion" + ], + "properties": { + "Accounts": { + "description": "AWS account where you want to collect logs from.", + "insertionOrder": false, + "items": { + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "DataLakeArn": { + "description": "The ARN for the data lake.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "SourceName": { + "description": "The name for a AWS source. This must be a Regionally unique value.", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a AWS source. This must be a Regionally unique value.", + "pattern": "^(latest|[0-9]\\.[0-9])$", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "DataLakeArn", + "SourceVersion", + "SourceName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityLake::AwsLogSource" +} diff --git a/schema/aws-securitylake-datalake.json b/schema/aws-securitylake-datalake.json index 3e6b02d..b76d536 100644 --- a/schema/aws-securitylake-datalake.json +++ b/schema/aws-securitylake-datalake.json @@ -1,225 +1,225 @@ -{ - "additionalProperties": false, - "definitions": { - "Days": { - "description": "Number of days before data expires in the Amazon Security Lake object.", - "minimum": 1, - "type": "integer" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "description": "Provides encryption details of Amazon Security Lake object.", - "properties": { - "KmsKeyId": { - "description": "The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.", - "type": "string" - } - }, - "type": "object" - }, - "Expiration": { - "additionalProperties": false, - "description": "Provides data expiration details of Amazon Security Lake object.", - "properties": { - "Days": { - "$ref": "#/definitions/Days" - } - }, - "type": "object" - }, - "LifecycleConfiguration": { - "additionalProperties": false, - "description": "Provides lifecycle details of Amazon Security Lake object.", - "properties": { - "Expiration": { - "$ref": "#/definitions/Expiration" - }, - "Transitions": { - "description": "Provides data storage transition details of Amazon Security Lake object.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Transitions" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Regions": { - "description": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different AWS Regions or within the same Region as the source bucket.", - "insertionOrder": false, - "items": { - "pattern": "^(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ReplicationConfiguration": { - "additionalProperties": false, - "description": "Provides replication details of Amazon Security Lake object.", - "properties": { - "Regions": { - "$ref": "#/definitions/Regions" - }, - "RoleArn": { - "description": "Replication settings for the Amazon S3 buckets. This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.", - "pattern": "^arn:.*$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 characters in length.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Transitions": { - "additionalProperties": false, - "properties": { - "Days": { - "description": "Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.", - "minimum": 1, - "type": "integer" - }, - "StorageClass": { - "description": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SecurityLake::DataLake", - "handlers": { - "create": { - "permissions": [ - "events:*", - "iam:CreateServiceLinkedRole", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "iam:PutRolePolicy", - "iam:PassRole", - "glue:*", - "organizations:*", - "kms:DescribeKey", - "kms:CreateGrant", - "lakeformation:*", - "lambda:*", - "s3:*", - "securitylake:CreateDataLake", - "securitylake:TagResource", - "securitylake:List*", - "sqs:*" - ] - }, - "delete": { - "permissions": [ - "organizations:*", - "securitylake:DeleteDataLake", - "securitylake:List*" - ] - }, - "list": { - "permissions": [ - "securitylake:List*" - ] - }, - "read": { - "permissions": [ - "securitylake:List*" - ] - }, - "update": { - "permissions": [ - "events:*", - "iam:CreateServiceLinkedRole", - "iam:DeleteRolePolicy", - "iam:GetRole", - "iam:PassRole", - "iam:PutRolePolicy", - "kms:DescribeKey", - "kms:CreateGrant", - "lakeformation:*", - "lambda:*", - "organizations:*", - "s3:*", - "securitylake:List*", - "securitylake:TagResource", - "securitylake:UntagResource", - "securitylake:UpdateDataLake", - "sqs:*" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) created by you to provide to the subscriber.", - "maxLength": 1011, - "minLength": 1, - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "LifecycleConfiguration": { - "$ref": "#/definitions/LifecycleConfiguration" - }, - "MetaStoreManagerRoleArn": { - "description": "The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.", - "pattern": "^arn:.*$", - "type": "string" - }, - "ReplicationConfiguration": { - "$ref": "#/definitions/ReplicationConfiguration" - }, - "S3BucketArn": { - "description": "The ARN for the Amazon Security Lake Amazon S3 bucket.", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/S3BucketArn" - ], - "replacementStrategy": "delete_then_create", - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecurityLake::DataLake", - "writeOnlyProperties": [ - "/properties/MetaStoreManagerRoleArn" - ] -} +{ + "additionalProperties": false, + "definitions": { + "Days": { + "description": "Number of days before data expires in the Amazon Security Lake object.", + "minimum": 1, + "type": "integer" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "Provides encryption details of Amazon Security Lake object.", + "properties": { + "KmsKeyId": { + "description": "The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.", + "type": "string" + } + }, + "type": "object" + }, + "Expiration": { + "additionalProperties": false, + "description": "Provides data expiration details of Amazon Security Lake object.", + "properties": { + "Days": { + "$ref": "#/definitions/Days" + } + }, + "type": "object" + }, + "LifecycleConfiguration": { + "additionalProperties": false, + "description": "Provides lifecycle details of Amazon Security Lake object.", + "properties": { + "Expiration": { + "$ref": "#/definitions/Expiration" + }, + "Transitions": { + "description": "Provides data storage transition details of Amazon Security Lake object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Transitions" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Regions": { + "description": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different AWS Regions or within the same Region as the source bucket.", + "insertionOrder": false, + "items": { + "pattern": "^(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ReplicationConfiguration": { + "additionalProperties": false, + "description": "Provides replication details of Amazon Security Lake object.", + "properties": { + "Regions": { + "$ref": "#/definitions/Regions" + }, + "RoleArn": { + "description": "Replication settings for the Amazon S3 buckets. This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.", + "pattern": "^arn:.*$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 characters in length.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Transitions": { + "additionalProperties": false, + "properties": { + "Days": { + "description": "Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.", + "minimum": 1, + "type": "integer" + }, + "StorageClass": { + "description": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::DataLake", + "handlers": { + "create": { + "permissions": [ + "events:*", + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "iam:PutRolePolicy", + "iam:PassRole", + "glue:*", + "organizations:*", + "kms:DescribeKey", + "kms:CreateGrant", + "lakeformation:*", + "lambda:*", + "s3:*", + "securitylake:CreateDataLake", + "securitylake:TagResource", + "securitylake:List*", + "sqs:*" + ] + }, + "delete": { + "permissions": [ + "organizations:*", + "securitylake:DeleteDataLake", + "securitylake:List*" + ] + }, + "list": { + "permissions": [ + "securitylake:List*" + ] + }, + "read": { + "permissions": [ + "securitylake:List*" + ] + }, + "update": { + "permissions": [ + "events:*", + "iam:CreateServiceLinkedRole", + "iam:DeleteRolePolicy", + "iam:GetRole", + "iam:PassRole", + "iam:PutRolePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "lakeformation:*", + "lambda:*", + "organizations:*", + "s3:*", + "securitylake:List*", + "securitylake:TagResource", + "securitylake:UntagResource", + "securitylake:UpdateDataLake", + "sqs:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) created by you to provide to the subscriber.", + "maxLength": 1011, + "minLength": 1, + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "LifecycleConfiguration": { + "$ref": "#/definitions/LifecycleConfiguration" + }, + "MetaStoreManagerRoleArn": { + "description": "The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.", + "pattern": "^arn:.*$", + "type": "string" + }, + "ReplicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration" + }, + "S3BucketArn": { + "description": "The ARN for the Amazon Security Lake Amazon S3 bucket.", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/S3BucketArn" + ], + "replacementStrategy": "delete_then_create", + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityLake::DataLake", + "writeOnlyProperties": [ + "/properties/MetaStoreManagerRoleArn" + ] +} diff --git a/schema/aws-securitylake-subscriber.json b/schema/aws-securitylake-subscriber.json index 2ca401a..2aafc66 100644 --- a/schema/aws-securitylake-subscriber.json +++ b/schema/aws-securitylake-subscriber.json @@ -1,307 +1,307 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DataLakeArn" - ], - "definitions": { - "AccessTypes": { - "description": "The Amazon S3 or AWS Lake Formation access type.", - "insertionOrder": true, - "items": { - "enum": [ - "LAKEFORMATION", - "S3" - ], - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "AwsLogSource": { - "additionalProperties": false, - "description": "Amazon Security Lake supports log and event collection for natively supported AWS services.", - "properties": { - "SourceName": { - "description": "The name for a AWS source. This must be a Regionally unique value.", - "type": "string" - }, - "SourceVersion": { - "description": "The version for a AWS source. This must be a Regionally unique value.", - "pattern": "^(latest|[0-9]\\.[0-9])$", - "type": "string" - } - }, - "type": "object" - }, - "CustomLogSource": { - "additionalProperties": false, - "properties": { - "SourceName": { - "description": "The name for a third-party custom source. This must be a Regionally unique value.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\\\\\w\\-_:/.]*$", - "type": "string" - }, - "SourceVersion": { - "description": "The version for a third-party custom source. This must be a Regionally unique value.", - "maxLength": 32, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-\\.\\_]*$", - "type": "string" - } - }, - "type": "object" - }, - "Source": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "AwsLogSource" - ] - }, - { - "required": [ - "CustomLogSource" - ] - } - ], - "properties": { - "AwsLogSource": { - "$ref": "#/definitions/AwsLogSource" - }, - "CustomLogSource": { - "$ref": "#/definitions/CustomLogSource" - } - } - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The name of the tag. This is a general label that acts as a category for a more specific tag value (value).", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SecurityLake::Subscriber", - "handlers": { - "create": { - "permissions": [ - "securitylake:CreateSubscriber", - "securitylake:CreateCustomLogSource", - "securitylake:CreateDataLake", - "securitylake:TagResource", - "securitylake:GetSubscriber", - "securitylake:ListTagsForResource", - "iam:GetRole", - "iam:GetRolePolicy", - "iam:PutRolePolicy", - "iam:CreateRole", - "iam:CreateServiceLinkedRole", - "glue:GetDatabase", - "glue:GetTable", - "lakeformation:RegisterResource", - "lakeformation:GrantPermissions", - "lakeformation:RevokePermissions", - "lakeformation:ListPermissions", - "ram:GetResourceShareAssociations", - "ram:CreateResourceShare", - "ram:UpdateResourceShare", - "ram:GetResourceShares" - ] - }, - "delete": { - "permissions": [ - "securitylake:DeleteSubscriber", - "iam:GetRole", - "iam:ListRolePolicies", - "iam:DeleteRole", - "iam:DeleteRolePolicy", - "glue:GetTable", - "lakeformation:RevokePermissions", - "lakeformation:ListPermissions", - "ram:GetResourceShares", - "ram:DeleteResourceShare", - "events:DeleteApiDestination", - "events:DeleteConnection", - "events:DeleteRule", - "events:ListApiDestinations", - "events:ListTargetsByRule", - "events:DescribeRule", - "events:RemoveTargets", - "sqs:DeleteQueue", - "sqs:GetQueueUrl" - ] - }, - "list": { - "permissions": [ - "securitylake:ListSubscribers" - ] - }, - "read": { - "permissions": [ - "securitylake:GetSubscriber", - "securitylake:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "securitylake:UpdateSubscriber", - "securitylake:GetSubscriber", - "securitylake:TagResource", - "securitylake:UntagResource", - "securitylake:ListTagsForResource", - "glue:GetDatabase", - "glue:GetTable", - "lakeformation:ListPermissions", - "lakeformation:GrantPermissions", - "lakeformation:RevokePermissions", - "ram:CreateResourceShare", - "ram:GetResourceShares", - "ram:GetResourceShareAssociations", - "ram:UpdateResourceShare", - "ram:DeleteResourceShare", - "iam:CreateRole", - "iam:GetRole", - "iam:DeleteRole", - "iam:PutRolePolicy", - "iam:DeleteRolePolicy", - "iam:ListRolePolicies", - "events:CreateApiDestination", - "events:CreateConnection", - "events:ListApiDestinations", - "events:ListConnections", - "events:PutRule", - "events:UpdateApiDestination", - "events:UpdateConnection", - "events:DeleteApiDestination", - "events:DeleteConnection", - "events:DeleteRule", - "events:RemoveTargets", - "events:ListTargetsByRule", - "events:DescribeRule", - "events:PutTargets" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubscriberArn" - ], - "properties": { - "AccessTypes": { - "$ref": "#/definitions/AccessTypes" - }, - "DataLakeArn": { - "description": "The ARN for the data lake.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ResourceShareArn": { - "type": "string" - }, - "ResourceShareName": { - "type": "string" - }, - "S3BucketArn": { - "type": "string" - }, - "Sources": { - "description": "The supported AWS services from which logs and events are collected.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Source" - }, - "type": "array" - }, - "SubscriberArn": { - "type": "string" - }, - "SubscriberDescription": { - "description": "The description for your subscriber account in Security Lake.", - "type": "string" - }, - "SubscriberIdentity": { - "additionalProperties": false, - "description": "The AWS identity used to access your data.", - "properties": { - "ExternalId": { - "description": "The external ID used to establish trust relationship with the AWS identity.", - "maxLength": 1224, - "minLength": 2, - "pattern": "^[\\w+=,.@:/-]*$", - "type": "string" - }, - "Principal": { - "description": "The AWS identity principal.", - "pattern": "^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$", - "type": "string" - } - }, - "required": [ - "ExternalId", - "Principal" - ], - "type": "object" - }, - "SubscriberName": { - "description": "The name of your Security Lake subscriber account.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\\\\\w\\s\\-_:/,.@=+]*$", - "type": "string" - }, - "SubscriberRoleArn": { - "type": "string" - }, - "Tags": { - "description": "An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/SubscriberArn", - "/properties/S3BucketArn", - "/properties/SubscriberRoleArn", - "/properties/ResourceShareArn", - "/properties/ResourceShareName" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "AccessTypes", - "DataLakeArn", - "Sources", - "SubscriberIdentity", - "SubscriberName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SecurityLake::Subscriber" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataLakeArn" + ], + "definitions": { + "AccessTypes": { + "description": "The Amazon S3 or AWS Lake Formation access type.", + "insertionOrder": true, + "items": { + "enum": [ + "LAKEFORMATION", + "S3" + ], + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "AwsLogSource": { + "additionalProperties": false, + "description": "Amazon Security Lake supports log and event collection for natively supported AWS services.", + "properties": { + "SourceName": { + "description": "The name for a AWS source. This must be a Regionally unique value.", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a AWS source. This must be a Regionally unique value.", + "pattern": "^(latest|[0-9]\\.[0-9])$", + "type": "string" + } + }, + "type": "object" + }, + "CustomLogSource": { + "additionalProperties": false, + "properties": { + "SourceName": { + "description": "The name for a third-party custom source. This must be a Regionally unique value.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\\\\\w\\-_:/.]*$", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a third-party custom source. This must be a Regionally unique value.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-\\.\\_]*$", + "type": "string" + } + }, + "type": "object" + }, + "Source": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "AwsLogSource" + ] + }, + { + "required": [ + "CustomLogSource" + ] + } + ], + "properties": { + "AwsLogSource": { + "$ref": "#/definitions/AwsLogSource" + }, + "CustomLogSource": { + "$ref": "#/definitions/CustomLogSource" + } + } + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The name of the tag. This is a general label that acts as a category for a more specific tag value (value).", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::Subscriber", + "handlers": { + "create": { + "permissions": [ + "securitylake:CreateSubscriber", + "securitylake:CreateCustomLogSource", + "securitylake:CreateDataLake", + "securitylake:TagResource", + "securitylake:GetSubscriber", + "securitylake:ListTagsForResource", + "iam:GetRole", + "iam:GetRolePolicy", + "iam:PutRolePolicy", + "iam:CreateRole", + "iam:CreateServiceLinkedRole", + "glue:GetDatabase", + "glue:GetTable", + "lakeformation:RegisterResource", + "lakeformation:GrantPermissions", + "lakeformation:RevokePermissions", + "lakeformation:ListPermissions", + "ram:GetResourceShareAssociations", + "ram:CreateResourceShare", + "ram:UpdateResourceShare", + "ram:GetResourceShares" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteSubscriber", + "iam:GetRole", + "iam:ListRolePolicies", + "iam:DeleteRole", + "iam:DeleteRolePolicy", + "glue:GetTable", + "lakeformation:RevokePermissions", + "lakeformation:ListPermissions", + "ram:GetResourceShares", + "ram:DeleteResourceShare", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:ListApiDestinations", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:RemoveTargets", + "sqs:DeleteQueue", + "sqs:GetQueueUrl" + ] + }, + "list": { + "permissions": [ + "securitylake:ListSubscribers" + ] + }, + "read": { + "permissions": [ + "securitylake:GetSubscriber", + "securitylake:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securitylake:UpdateSubscriber", + "securitylake:GetSubscriber", + "securitylake:TagResource", + "securitylake:UntagResource", + "securitylake:ListTagsForResource", + "glue:GetDatabase", + "glue:GetTable", + "lakeformation:ListPermissions", + "lakeformation:GrantPermissions", + "lakeformation:RevokePermissions", + "ram:CreateResourceShare", + "ram:GetResourceShares", + "ram:GetResourceShareAssociations", + "ram:UpdateResourceShare", + "ram:DeleteResourceShare", + "iam:CreateRole", + "iam:GetRole", + "iam:DeleteRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:ListRolePolicies", + "events:CreateApiDestination", + "events:CreateConnection", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:UpdateApiDestination", + "events:UpdateConnection", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:RemoveTargets", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:PutTargets" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriberArn" + ], + "properties": { + "AccessTypes": { + "$ref": "#/definitions/AccessTypes" + }, + "DataLakeArn": { + "description": "The ARN for the data lake.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ResourceShareArn": { + "type": "string" + }, + "ResourceShareName": { + "type": "string" + }, + "S3BucketArn": { + "type": "string" + }, + "Sources": { + "description": "The supported AWS services from which logs and events are collected.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Source" + }, + "type": "array" + }, + "SubscriberArn": { + "type": "string" + }, + "SubscriberDescription": { + "description": "The description for your subscriber account in Security Lake.", + "type": "string" + }, + "SubscriberIdentity": { + "additionalProperties": false, + "description": "The AWS identity used to access your data.", + "properties": { + "ExternalId": { + "description": "The external ID used to establish trust relationship with the AWS identity.", + "maxLength": 1224, + "minLength": 2, + "pattern": "^[\\w+=,.@:/-]*$", + "type": "string" + }, + "Principal": { + "description": "The AWS identity principal.", + "pattern": "^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$", + "type": "string" + } + }, + "required": [ + "ExternalId", + "Principal" + ], + "type": "object" + }, + "SubscriberName": { + "description": "The name of your Security Lake subscriber account.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\\\\\w\\s\\-_:/,.@=+]*$", + "type": "string" + }, + "SubscriberRoleArn": { + "type": "string" + }, + "Tags": { + "description": "An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/SubscriberArn", + "/properties/S3BucketArn", + "/properties/SubscriberRoleArn", + "/properties/ResourceShareArn", + "/properties/ResourceShareName" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "AccessTypes", + "DataLakeArn", + "Sources", + "SubscriberIdentity", + "SubscriberName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityLake::Subscriber" +} diff --git a/schema/aws-securitylake-subscribernotification.json b/schema/aws-securitylake-subscribernotification.json index 430ed6a..3452eaa 100644 --- a/schema/aws-securitylake-subscribernotification.json +++ b/schema/aws-securitylake-subscribernotification.json @@ -1,206 +1,206 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SubscriberArn" - ], - "definitions": { - "HttpsNotificationConfiguration": { - "additionalProperties": false, - "description": "The configuration for HTTPS subscriber notification.", - "properties": { - "AuthorizationApiKeyName": { - "description": "The key name for the notification subscription.", - "type": "string" - }, - "AuthorizationApiKeyValue": { - "description": "The key value for the notification subscription.", - "type": "string" - }, - "Endpoint": { - "description": "The subscription endpoint in Security Lake.", - "pattern": "^https?://.+$", - "type": "string" - }, - "HttpMethod": { - "description": "The HTTPS method used for the notification subscription.", - "enum": [ - "POST", - "PUT" - ], - "type": "string" - }, - "TargetRoleArn": { - "description": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.", - "pattern": "^arn:.*$", - "type": "string" - } - }, - "required": [ - "Endpoint", - "TargetRoleArn" - ], - "type": "object" - }, - "NotificationConfiguration": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "HttpsNotificationConfiguration" - ] - }, - { - "required": [ - "SqsNotificationConfiguration" - ] - } - ], - "properties": { - "HttpsNotificationConfiguration": { - "$ref": "#/definitions/HttpsNotificationConfiguration" - }, - "SqsNotificationConfiguration": { - "$ref": "#/definitions/SqsNotificationConfiguration" - } - }, - "type": "object" - }, - "SqsNotificationConfiguration": { - "description": "The configurations for SQS subscriber notification. The members of this structure are context-dependent.", - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SecurityLake::SubscriberNotification", - "handlers": { - "create": { - "permissions": [ - "securitylake:CreateDataLake", - "securitylake:CreateSubscriber", - "securitylake:CreateSubscriberNotification", - "securitylake:GetSubscriber", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "iam:DeleteRolePolicy", - "iam:PassRole", - "s3:PutBucketNotification", - "s3:GetBucketNotification", - "events:CreateApiDestination", - "events:CreateConnection", - "events:CreateRule", - "events:UpdateConnection", - "events:DeleteConnection", - "events:UpdateApiDestination", - "events:DeleteApiDestination", - "events:ListApiDestinations", - "events:ListConnections", - "events:PutRule", - "events:DescribeRule", - "events:DeleteRule", - "events:PutTargets", - "events:RemoveTargets", - "events:ListTargetsByRule", - "secretsmanager:CreateSecret", - "sqs:CreateQueue", - "sqs:GetQueueAttributes", - "sqs:GetQueueUrl", - "sqs:SetQueueAttributes" - ] - }, - "delete": { - "permissions": [ - "securitylake:DeleteSubscriberNotification", - "securitylake:GetSubscriber", - "iam:DeleteRole", - "iam:DeleteRolePolicy", - "events:DeleteApiDestination", - "events:DeleteConnection", - "events:DeleteRule", - "events:ListTargetsByRule", - "events:DescribeRule", - "events:RemoveTargets", - "sqs:DeleteQueue" - ] - }, - "list": { - "permissions": [ - "securitylake:ListSubscribers" - ] - }, - "read": { - "permissions": [ - "securitylake:GetSubscriber" - ] - }, - "update": { - "permissions": [ - "securitylake:UpdateSubscriberNotification", - "securitylake:GetSubscriber", - "iam:CreateServiceLinkedRole", - "iam:PutRolePolicy", - "iam:DeleteRolePolicy", - "iam:PassRole", - "events:CreateApiDestination", - "events:CreateConnection", - "events:UpdateConnection", - "events:DeleteConnection", - "events:UpdateApiDestination", - "events:DeleteApiDestination", - "events:DeleteRule", - "events:ListApiDestinations", - "events:ListConnections", - "events:PutRule", - "events:DescribeRule", - "events:DeleteRule", - "events:PutTargets", - "events:RemoveTargets", - "events:ListTargetsByRule", - "secretsmanager:CreateSecret", - "s3:GetBucketNotificationConfiguration", - "s3:PutBucketNotificationConfiguration", - "s3:PutBucketNotification", - "s3:GetBucketNotification", - "sqs:CreateQueue", - "sqs:DeleteQueue", - "sqs:GetQueueAttributes", - "sqs:SetQueueAttributes" - ] - } - }, - "primaryIdentifier": [ - "/properties/SubscriberArn" - ], - "properties": { - "NotificationConfiguration": { - "$ref": "#/definitions/NotificationConfiguration" - }, - "SubscriberArn": { - "description": "The ARN for the subscriber", - "pattern": "^arn:.*$", - "type": "string" - }, - "SubscriberEndpoint": { - "description": "The endpoint the subscriber should listen to for notifications", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SubscriberEndpoint" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "SubscriberArn", - "NotificationConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SecurityLake::SubscriberNotification", - "writeOnlyProperties": [ - "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyName", - "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyValue", - "/properties/NotificationConfiguration/HttpsNotificationConfiguration/Endpoint", - "/properties/NotificationConfiguration/HttpsNotificationConfiguration/HttpMethod", - "/properties/NotificationConfiguration/HttpsNotificationConfiguration/TargetRoleArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriberArn" + ], + "definitions": { + "HttpsNotificationConfiguration": { + "additionalProperties": false, + "description": "The configuration for HTTPS subscriber notification.", + "properties": { + "AuthorizationApiKeyName": { + "description": "The key name for the notification subscription.", + "type": "string" + }, + "AuthorizationApiKeyValue": { + "description": "The key value for the notification subscription.", + "type": "string" + }, + "Endpoint": { + "description": "The subscription endpoint in Security Lake.", + "pattern": "^https?://.+$", + "type": "string" + }, + "HttpMethod": { + "description": "The HTTPS method used for the notification subscription.", + "enum": [ + "POST", + "PUT" + ], + "type": "string" + }, + "TargetRoleArn": { + "description": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.", + "pattern": "^arn:.*$", + "type": "string" + } + }, + "required": [ + "Endpoint", + "TargetRoleArn" + ], + "type": "object" + }, + "NotificationConfiguration": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "HttpsNotificationConfiguration" + ] + }, + { + "required": [ + "SqsNotificationConfiguration" + ] + } + ], + "properties": { + "HttpsNotificationConfiguration": { + "$ref": "#/definitions/HttpsNotificationConfiguration" + }, + "SqsNotificationConfiguration": { + "$ref": "#/definitions/SqsNotificationConfiguration" + } + }, + "type": "object" + }, + "SqsNotificationConfiguration": { + "description": "The configurations for SQS subscriber notification. The members of this structure are context-dependent.", + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::SubscriberNotification", + "handlers": { + "create": { + "permissions": [ + "securitylake:CreateDataLake", + "securitylake:CreateSubscriber", + "securitylake:CreateSubscriberNotification", + "securitylake:GetSubscriber", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:PassRole", + "s3:PutBucketNotification", + "s3:GetBucketNotification", + "events:CreateApiDestination", + "events:CreateConnection", + "events:CreateRule", + "events:UpdateConnection", + "events:DeleteConnection", + "events:UpdateApiDestination", + "events:DeleteApiDestination", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:DescribeRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule", + "secretsmanager:CreateSecret", + "sqs:CreateQueue", + "sqs:GetQueueAttributes", + "sqs:GetQueueUrl", + "sqs:SetQueueAttributes" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteSubscriberNotification", + "securitylake:GetSubscriber", + "iam:DeleteRole", + "iam:DeleteRolePolicy", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:RemoveTargets", + "sqs:DeleteQueue" + ] + }, + "list": { + "permissions": [ + "securitylake:ListSubscribers" + ] + }, + "read": { + "permissions": [ + "securitylake:GetSubscriber" + ] + }, + "update": { + "permissions": [ + "securitylake:UpdateSubscriberNotification", + "securitylake:GetSubscriber", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:PassRole", + "events:CreateApiDestination", + "events:CreateConnection", + "events:UpdateConnection", + "events:DeleteConnection", + "events:UpdateApiDestination", + "events:DeleteApiDestination", + "events:DeleteRule", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:DescribeRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule", + "secretsmanager:CreateSecret", + "s3:GetBucketNotificationConfiguration", + "s3:PutBucketNotificationConfiguration", + "s3:PutBucketNotification", + "s3:GetBucketNotification", + "sqs:CreateQueue", + "sqs:DeleteQueue", + "sqs:GetQueueAttributes", + "sqs:SetQueueAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriberArn" + ], + "properties": { + "NotificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration" + }, + "SubscriberArn": { + "description": "The ARN for the subscriber", + "pattern": "^arn:.*$", + "type": "string" + }, + "SubscriberEndpoint": { + "description": "The endpoint the subscriber should listen to for notifications", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SubscriberEndpoint" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "SubscriberArn", + "NotificationConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityLake::SubscriberNotification", + "writeOnlyProperties": [ + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyName", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyValue", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/Endpoint", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/HttpMethod", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/TargetRoleArn" + ] +} diff --git a/schema/aws-servicecatalog-acceptedportfolioshare.json b/schema/aws-servicecatalog-acceptedportfolioshare.json index 315bb27..d6a630f 100644 --- a/schema/aws-servicecatalog-acceptedportfolioshare.json +++ b/schema/aws-servicecatalog-acceptedportfolioshare.json @@ -1,29 +1,29 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/AcceptLanguage" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::AcceptedPortfolioShare", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PortfolioId" - ], - "typeName": "AWS::ServiceCatalog::AcceptedPortfolioShare" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/AcceptLanguage" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::AcceptedPortfolioShare", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PortfolioId" + ], + "typeName": "AWS::ServiceCatalog::AcceptedPortfolioShare" +} diff --git a/schema/aws-servicecatalog-cloudformationproduct.json b/schema/aws-servicecatalog-cloudformationproduct.json index de47290..1419814 100644 --- a/schema/aws-servicecatalog-cloudformationproduct.json +++ b/schema/aws-servicecatalog-cloudformationproduct.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "definitions": { - "CodeStarParameters": { - "additionalProperties": false, - "properties": { - "ArtifactPath": { - "type": "string" - }, - "Branch": { - "type": "string" - }, - "ConnectionArn": { - "type": "string" - }, - "Repository": { - "type": "string" - } - }, - "required": [ - "ArtifactPath", - "Repository", - "Branch", - "ConnectionArn" - ], - "type": "object" - }, - "ConnectionParameters": { - "additionalProperties": false, - "properties": { - "CodeStar": { - "$ref": "#/definitions/CodeStarParameters" - } - }, - "type": "object" - }, - "ProvisioningArtifactProperties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DisableTemplateValidation": { - "type": "boolean" - }, - "Info": { - "type": "object" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Info" - ], - "type": "object" - }, - "SourceConnection": { - "additionalProperties": false, - "properties": { - "ConnectionParameters": { - "$ref": "#/definitions/ConnectionParameters" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "ConnectionParameters" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceCatalog::CloudFormationProduct", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Distributor": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "ProductName": { - "type": "string" - }, - "ProductType": { - "type": "string" - }, - "ProvisioningArtifactIds": { - "type": "string" - }, - "ProvisioningArtifactNames": { - "type": "string" - }, - "ProvisioningArtifactParameters": { - "items": { - "$ref": "#/definitions/ProvisioningArtifactProperties" - }, - "type": "array", - "uniqueItems": false - }, - "ReplaceProvisioningArtifacts": { - "type": "boolean" - }, - "SourceConnection": { - "$ref": "#/definitions/SourceConnection" - }, - "SupportDescription": { - "type": "string" - }, - "SupportEmail": { - "type": "string" - }, - "SupportUrl": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ProvisioningArtifactIds", - "/properties/Id", - "/properties/ProvisioningArtifactNames", - "/properties/ProductName" - ], - "required": [ - "Owner", - "Name" - ], - "typeName": "AWS::ServiceCatalog::CloudFormationProduct" -} +{ + "additionalProperties": false, + "definitions": { + "CodeStarParameters": { + "additionalProperties": false, + "properties": { + "ArtifactPath": { + "type": "string" + }, + "Branch": { + "type": "string" + }, + "ConnectionArn": { + "type": "string" + }, + "Repository": { + "type": "string" + } + }, + "required": [ + "ArtifactPath", + "Repository", + "Branch", + "ConnectionArn" + ], + "type": "object" + }, + "ConnectionParameters": { + "additionalProperties": false, + "properties": { + "CodeStar": { + "$ref": "#/definitions/CodeStarParameters" + } + }, + "type": "object" + }, + "ProvisioningArtifactProperties": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "DisableTemplateValidation": { + "type": "boolean" + }, + "Info": { + "type": "object" + }, + "Name": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Info" + ], + "type": "object" + }, + "SourceConnection": { + "additionalProperties": false, + "properties": { + "ConnectionParameters": { + "$ref": "#/definitions/ConnectionParameters" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "ConnectionParameters" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceCatalog::CloudFormationProduct", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Distributor": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Owner": { + "type": "string" + }, + "ProductName": { + "type": "string" + }, + "ProductType": { + "type": "string" + }, + "ProvisioningArtifactIds": { + "type": "string" + }, + "ProvisioningArtifactNames": { + "type": "string" + }, + "ProvisioningArtifactParameters": { + "items": { + "$ref": "#/definitions/ProvisioningArtifactProperties" + }, + "type": "array", + "uniqueItems": false + }, + "ReplaceProvisioningArtifacts": { + "type": "boolean" + }, + "SourceConnection": { + "$ref": "#/definitions/SourceConnection" + }, + "SupportDescription": { + "type": "string" + }, + "SupportEmail": { + "type": "string" + }, + "SupportUrl": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ProvisioningArtifactIds", + "/properties/Id", + "/properties/ProvisioningArtifactNames", + "/properties/ProductName" + ], + "required": [ + "Owner", + "Name" + ], + "typeName": "AWS::ServiceCatalog::CloudFormationProduct" +} diff --git a/schema/aws-servicecatalog-cloudformationprovisionedproduct.json b/schema/aws-servicecatalog-cloudformationprovisionedproduct.json index e07e933..83ebaf2 100644 --- a/schema/aws-servicecatalog-cloudformationprovisionedproduct.json +++ b/schema/aws-servicecatalog-cloudformationprovisionedproduct.json @@ -1,230 +1,230 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/NotificationArns", - "/properties/ProvisionedProductName" - ], - "definitions": { - "OutputType": { - "type": "string" - }, - "ProvisioningParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 4096, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "ProvisioningPreferences": { - "additionalProperties": false, - "properties": { - "StackSetAccounts": { - "items": { - "pattern": "^[0-9]{12}$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "StackSetFailureToleranceCount": { - "minimum": 0, - "type": "integer" - }, - "StackSetFailureTolerancePercentage": { - "maximum": 100, - "minimum": 0, - "type": "integer" - }, - "StackSetMaxConcurrencyCount": { - "minimum": 1, - "type": "integer" - }, - "StackSetMaxConcurrencyPercentage": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "StackSetOperationType": { - "enum": [ - "CREATE", - "UPDATE", - "DELETE" - ], - "type": "string" - }, - "StackSetRegions": { - "items": { - "pattern": "^[a-z]{2}-([a-z]+-)+[1-9]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html", - "handlers": { - "create": { - "permissions": [ - "*" - ], - "timeoutInMinutes": 720 - }, - "delete": { - "permissions": [ - "*" - ] - }, - "read": { - "permissions": [ - "*" - ] - }, - "update": { - "permissions": [ - "*" - ], - "timeoutInMinutes": 720 - } - }, - "primaryIdentifier": [ - "/properties/ProvisionedProductId" - ], - "properties": { - "AcceptLanguage": { - "enum": [ - "en", - "jp", - "zh" - ], - "type": "string" - }, - "CloudformationStackArn": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "NotificationArns": { - "items": { - "type": "string" - }, - "maxItems": 5, - "type": "array", - "uniqueItems": true - }, - "Outputs": { - "additionalProperties": false, - "description": "List of key-value pair outputs.", - "maxProperties": 100, - "patternProperties": { - "^[A-Za-z0-9]{1,64}$": { - "$ref": "#/definitions/OutputType" - } - }, - "type": "object" - }, - "PathId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "PathName": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ProductId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ProductName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "ProvisionedProductId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "ProvisionedProductName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "ProvisioningArtifactId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "ProvisioningArtifactName": { - "type": "string" - }, - "ProvisioningParameters": { - "items": { - "$ref": "#/definitions/ProvisioningParameter" - }, - "type": "array" - }, - "ProvisioningPreferences": { - "$ref": "#/definitions/ProvisioningPreferences" - }, - "RecordId": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RecordId", - "/properties/CloudformationStackArn", - "/properties/Outputs", - "/properties/ProvisionedProductId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::ServiceCatalog::CloudFormationProvisionedProduct" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/NotificationArns", + "/properties/ProvisionedProductName" + ], + "definitions": { + "OutputType": { + "type": "string" + }, + "ProvisioningParameter": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "ProvisioningPreferences": { + "additionalProperties": false, + "properties": { + "StackSetAccounts": { + "items": { + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "StackSetFailureToleranceCount": { + "minimum": 0, + "type": "integer" + }, + "StackSetFailureTolerancePercentage": { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "StackSetMaxConcurrencyCount": { + "minimum": 1, + "type": "integer" + }, + "StackSetMaxConcurrencyPercentage": { + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "StackSetOperationType": { + "enum": [ + "CREATE", + "UPDATE", + "DELETE" + ], + "type": "string" + }, + "StackSetRegions": { + "items": { + "pattern": "^[a-z]{2}-([a-z]+-)+[1-9]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html", + "handlers": { + "create": { + "permissions": [ + "*" + ], + "timeoutInMinutes": 720 + }, + "delete": { + "permissions": [ + "*" + ] + }, + "read": { + "permissions": [ + "*" + ] + }, + "update": { + "permissions": [ + "*" + ], + "timeoutInMinutes": 720 + } + }, + "primaryIdentifier": [ + "/properties/ProvisionedProductId" + ], + "properties": { + "AcceptLanguage": { + "enum": [ + "en", + "jp", + "zh" + ], + "type": "string" + }, + "CloudformationStackArn": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "NotificationArns": { + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array", + "uniqueItems": true + }, + "Outputs": { + "additionalProperties": false, + "description": "List of key-value pair outputs.", + "maxProperties": 100, + "patternProperties": { + "^[A-Za-z0-9]{1,64}$": { + "$ref": "#/definitions/OutputType" + } + }, + "type": "object" + }, + "PathId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "PathName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ProductId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ProductName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ProvisionedProductId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "ProvisionedProductName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ProvisioningArtifactId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "ProvisioningArtifactName": { + "type": "string" + }, + "ProvisioningParameters": { + "items": { + "$ref": "#/definitions/ProvisioningParameter" + }, + "type": "array" + }, + "ProvisioningPreferences": { + "$ref": "#/definitions/ProvisioningPreferences" + }, + "RecordId": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RecordId", + "/properties/CloudformationStackArn", + "/properties/Outputs", + "/properties/ProvisionedProductId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::ServiceCatalog::CloudFormationProvisionedProduct" +} diff --git a/schema/aws-servicecatalog-launchnotificationconstraint.json b/schema/aws-servicecatalog-launchnotificationconstraint.json index 3e6ec50..a9b4ac7 100644 --- a/schema/aws-servicecatalog-launchnotificationconstraint.json +++ b/schema/aws-servicecatalog-launchnotificationconstraint.json @@ -1,44 +1,44 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::LaunchNotificationConstraint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "NotificationArns": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "NotificationArns", - "PortfolioId", - "ProductId" - ], - "typeName": "AWS::ServiceCatalog::LaunchNotificationConstraint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::LaunchNotificationConstraint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "NotificationArns": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "NotificationArns", + "PortfolioId", + "ProductId" + ], + "typeName": "AWS::ServiceCatalog::LaunchNotificationConstraint" +} diff --git a/schema/aws-servicecatalog-launchroleconstraint.json b/schema/aws-servicecatalog-launchroleconstraint.json index 5b8b8cf..6de01ee 100644 --- a/schema/aws-servicecatalog-launchroleconstraint.json +++ b/schema/aws-servicecatalog-launchroleconstraint.json @@ -1,42 +1,42 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::LaunchRoleConstraint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LocalRoleName": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PortfolioId", - "ProductId" - ], - "typeName": "AWS::ServiceCatalog::LaunchRoleConstraint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::LaunchRoleConstraint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LocalRoleName": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + }, + "RoleArn": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PortfolioId", + "ProductId" + ], + "typeName": "AWS::ServiceCatalog::LaunchRoleConstraint" +} diff --git a/schema/aws-servicecatalog-launchtemplateconstraint.json b/schema/aws-servicecatalog-launchtemplateconstraint.json index f09c678..6848eb6 100644 --- a/schema/aws-servicecatalog-launchtemplateconstraint.json +++ b/schema/aws-servicecatalog-launchtemplateconstraint.json @@ -1,40 +1,40 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::LaunchTemplateConstraint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "Rules": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PortfolioId", - "ProductId", - "Rules" - ], - "typeName": "AWS::ServiceCatalog::LaunchTemplateConstraint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::LaunchTemplateConstraint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + }, + "Rules": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PortfolioId", + "ProductId", + "Rules" + ], + "typeName": "AWS::ServiceCatalog::LaunchTemplateConstraint" +} diff --git a/schema/aws-servicecatalog-portfolio.json b/schema/aws-servicecatalog-portfolio.json index ec4017f..192ab60 100644 --- a/schema/aws-servicecatalog-portfolio.json +++ b/schema/aws-servicecatalog-portfolio.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceCatalog::Portfolio", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioName": { - "type": "string" - }, - "ProviderName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/PortfolioName", - "/properties/Id" - ], - "required": [ - "DisplayName", - "ProviderName" - ], - "typeName": "AWS::ServiceCatalog::Portfolio" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceCatalog::Portfolio", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioName": { + "type": "string" + }, + "ProviderName": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/PortfolioName", + "/properties/Id" + ], + "required": [ + "DisplayName", + "ProviderName" + ], + "typeName": "AWS::ServiceCatalog::Portfolio" +} diff --git a/schema/aws-servicecatalog-portfolioprincipalassociation.json b/schema/aws-servicecatalog-portfolioprincipalassociation.json index f6f6017..1b8f02d 100644 --- a/schema/aws-servicecatalog-portfolioprincipalassociation.json +++ b/schema/aws-servicecatalog-portfolioprincipalassociation.json @@ -1,39 +1,39 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/AcceptLanguage", - "/properties/PrincipalARN", - "/properties/PrincipalType" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioPrincipalAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "PrincipalARN": { - "type": "string" - }, - "PrincipalType": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PortfolioId", - "PrincipalType", - "PrincipalARN" - ], - "typeName": "AWS::ServiceCatalog::PortfolioPrincipalAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/AcceptLanguage", + "/properties/PrincipalARN", + "/properties/PrincipalType" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioPrincipalAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "PrincipalARN": { + "type": "string" + }, + "PrincipalType": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PortfolioId", + "PrincipalType", + "PrincipalARN" + ], + "typeName": "AWS::ServiceCatalog::PortfolioPrincipalAssociation" +} diff --git a/schema/aws-servicecatalog-portfolioproductassociation.json b/schema/aws-servicecatalog-portfolioproductassociation.json index ac46217..c39b314 100644 --- a/schema/aws-servicecatalog-portfolioproductassociation.json +++ b/schema/aws-servicecatalog-portfolioproductassociation.json @@ -1,38 +1,38 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SourcePortfolioId", - "/properties/PortfolioId", - "/properties/AcceptLanguage", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioProductAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "SourcePortfolioId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PortfolioId", - "ProductId" - ], - "typeName": "AWS::ServiceCatalog::PortfolioProductAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourcePortfolioId", + "/properties/PortfolioId", + "/properties/AcceptLanguage", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioProductAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + }, + "SourcePortfolioId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PortfolioId", + "ProductId" + ], + "typeName": "AWS::ServiceCatalog::PortfolioProductAssociation" +} diff --git a/schema/aws-servicecatalog-portfolioshare.json b/schema/aws-servicecatalog-portfolioshare.json index 20ed2e1..62d629d 100644 --- a/schema/aws-servicecatalog-portfolioshare.json +++ b/schema/aws-servicecatalog-portfolioshare.json @@ -1,37 +1,37 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AcceptLanguage", - "/properties/AccountId", - "/properties/PortfolioId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioShare", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "AccountId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ShareTagOptions": { - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "AccountId", - "PortfolioId" - ], - "typeName": "AWS::ServiceCatalog::PortfolioShare" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AcceptLanguage", + "/properties/AccountId", + "/properties/PortfolioId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::PortfolioShare", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "AccountId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ShareTagOptions": { + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "AccountId", + "PortfolioId" + ], + "typeName": "AWS::ServiceCatalog::PortfolioShare" +} diff --git a/schema/aws-servicecatalog-resourceupdateconstraint.json b/schema/aws-servicecatalog-resourceupdateconstraint.json index 678a9b0..bf91f4f 100644 --- a/schema/aws-servicecatalog-resourceupdateconstraint.json +++ b/schema/aws-servicecatalog-resourceupdateconstraint.json @@ -1,40 +1,40 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::ResourceUpdateConstraint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "TagUpdateOnProvisionedProduct": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TagUpdateOnProvisionedProduct", - "PortfolioId", - "ProductId" - ], - "typeName": "AWS::ServiceCatalog::ResourceUpdateConstraint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::ResourceUpdateConstraint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + }, + "TagUpdateOnProvisionedProduct": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TagUpdateOnProvisionedProduct", + "PortfolioId", + "ProductId" + ], + "typeName": "AWS::ServiceCatalog::ResourceUpdateConstraint" +} diff --git a/schema/aws-servicecatalog-serviceaction.json b/schema/aws-servicecatalog-serviceaction.json index ce6550f..2633564 100644 --- a/schema/aws-servicecatalog-serviceaction.json +++ b/schema/aws-servicecatalog-serviceaction.json @@ -1,108 +1,108 @@ -{ - "additionalProperties": false, - "definitions": { - "DefinitionParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 4096, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Schema for AWS::ServiceCatalog::ServiceAction", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:CreateServiceAction", - "ssm:DescribeDocument", - "iam:GetRole" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DeleteServiceAction" - ] - }, - "list": { - "permissions": [ - "servicecatalog:ListServiceActions" - ] - }, - "read": { - "permissions": [ - "servicecatalog:DescribeServiceAction" - ] - }, - "update": { - "permissions": [ - "servicecatalog:UpdateServiceAction", - "iam:GetRole", - "ssm:DescribeDocument" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "enum": [ - "en", - "jp", - "zh" - ], - "type": "string" - }, - "Definition": { - "items": { - "$ref": "#/definitions/DefinitionParameter" - }, - "type": "array" - }, - "DefinitionType": { - "enum": [ - "SSM_AUTOMATION" - ], - "type": "string" - }, - "Description": { - "maxLength": 1024, - "type": "string" - }, - "Id": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "DefinitionType", - "Definition" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::ServiceCatalog::ServiceAction", - "writeOnlyProperties": [ - "/properties/AcceptLanguage" - ] -} +{ + "additionalProperties": false, + "definitions": { + "DefinitionParameter": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Schema for AWS::ServiceCatalog::ServiceAction", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:CreateServiceAction", + "ssm:DescribeDocument", + "iam:GetRole" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DeleteServiceAction" + ] + }, + "list": { + "permissions": [ + "servicecatalog:ListServiceActions" + ] + }, + "read": { + "permissions": [ + "servicecatalog:DescribeServiceAction" + ] + }, + "update": { + "permissions": [ + "servicecatalog:UpdateServiceAction", + "iam:GetRole", + "ssm:DescribeDocument" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "enum": [ + "en", + "jp", + "zh" + ], + "type": "string" + }, + "Definition": { + "items": { + "$ref": "#/definitions/DefinitionParameter" + }, + "type": "array" + }, + "DefinitionType": { + "enum": [ + "SSM_AUTOMATION" + ], + "type": "string" + }, + "Description": { + "maxLength": 1024, + "type": "string" + }, + "Id": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name", + "DefinitionType", + "Definition" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::ServiceCatalog::ServiceAction", + "writeOnlyProperties": [ + "/properties/AcceptLanguage" + ] +} diff --git a/schema/aws-servicecatalog-serviceactionassociation.json b/schema/aws-servicecatalog-serviceactionassociation.json index 7a212e7..7487f05 100644 --- a/schema/aws-servicecatalog-serviceactionassociation.json +++ b/schema/aws-servicecatalog-serviceactionassociation.json @@ -1,79 +1,79 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProductId", - "/properties/ProvisioningArtifactId", - "/properties/ServiceActionId" - ], - "description": "Resource Schema for AWS::ServiceCatalog::ServiceActionAssociation", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:AssociateServiceActionWithProvisioningArtifact", - "servicecatalog:ListServiceActionsForProvisioningArtifact" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DisassociateServiceActionFromProvisioningArtifact", - "servicecatalog:ListServiceActionsForProvisioningArtifact" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ProductId": { - "$ref": "resource-schema.json#/properties/ProductId" - }, - "ProvisioningArtifactId": { - "$ref": "resource-schema.json#/properties/ProvisioningArtifactId" - } - }, - "required": [ - "ProductId", - "ProvisioningArtifactId" - ] - }, - "permissions": [ - "servicecatalog:ListServiceActionsForProvisioningArtifact" - ] - }, - "read": { - "permissions": [ - "servicecatalog:ListServiceActionsForProvisioningArtifact" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProductId", - "/properties/ProvisioningArtifactId", - "/properties/ServiceActionId" - ], - "properties": { - "ProductId": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", - "type": "string" - }, - "ProvisioningArtifactId": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", - "type": "string" - }, - "ServiceActionId": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", - "type": "string" - } - }, - "required": [ - "ProductId", - "ProvisioningArtifactId", - "ServiceActionId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog", - "typeName": "AWS::ServiceCatalog::ServiceActionAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProductId", + "/properties/ProvisioningArtifactId", + "/properties/ServiceActionId" + ], + "description": "Resource Schema for AWS::ServiceCatalog::ServiceActionAssociation", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:AssociateServiceActionWithProvisioningArtifact", + "servicecatalog:ListServiceActionsForProvisioningArtifact" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DisassociateServiceActionFromProvisioningArtifact", + "servicecatalog:ListServiceActionsForProvisioningArtifact" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ProductId": { + "$ref": "resource-schema.json#/properties/ProductId" + }, + "ProvisioningArtifactId": { + "$ref": "resource-schema.json#/properties/ProvisioningArtifactId" + } + }, + "required": [ + "ProductId", + "ProvisioningArtifactId" + ] + }, + "permissions": [ + "servicecatalog:ListServiceActionsForProvisioningArtifact" + ] + }, + "read": { + "permissions": [ + "servicecatalog:ListServiceActionsForProvisioningArtifact" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProductId", + "/properties/ProvisioningArtifactId", + "/properties/ServiceActionId" + ], + "properties": { + "ProductId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", + "type": "string" + }, + "ProvisioningArtifactId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", + "type": "string" + }, + "ServiceActionId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\\Z", + "type": "string" + } + }, + "required": [ + "ProductId", + "ProvisioningArtifactId", + "ServiceActionId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog", + "typeName": "AWS::ServiceCatalog::ServiceActionAssociation" +} diff --git a/schema/aws-servicecatalog-stacksetconstraint.json b/schema/aws-servicecatalog-stacksetconstraint.json index 6ad74fb..7e320ab 100644 --- a/schema/aws-servicecatalog-stacksetconstraint.json +++ b/schema/aws-servicecatalog-stacksetconstraint.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortfolioId", - "/properties/ProductId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::StackSetConstraint", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "AccountList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "AdminRole": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ExecutionRole": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "RegionList": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "StackInstanceControl": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Description", - "StackInstanceControl", - "PortfolioId", - "ProductId", - "RegionList", - "AdminRole", - "AccountList", - "ExecutionRole" - ], - "typeName": "AWS::ServiceCatalog::StackSetConstraint" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortfolioId", + "/properties/ProductId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::StackSetConstraint", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AcceptLanguage": { + "type": "string" + }, + "AccountList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "AdminRole": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ExecutionRole": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "PortfolioId": { + "type": "string" + }, + "ProductId": { + "type": "string" + }, + "RegionList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "StackInstanceControl": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Description", + "StackInstanceControl", + "PortfolioId", + "ProductId", + "RegionList", + "AdminRole", + "AccountList", + "ExecutionRole" + ], + "typeName": "AWS::ServiceCatalog::StackSetConstraint" +} diff --git a/schema/aws-servicecatalog-tagoption.json b/schema/aws-servicecatalog-tagoption.json index feaa776..d6e0bcf 100644 --- a/schema/aws-servicecatalog-tagoption.json +++ b/schema/aws-servicecatalog-tagoption.json @@ -1,33 +1,33 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Value", - "/properties/Key" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::TagOption", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Active": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Value", - "Key" - ], - "typeName": "AWS::ServiceCatalog::TagOption" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Value", + "/properties/Key" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::TagOption", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Active": { + "type": "boolean" + }, + "Id": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Value", + "Key" + ], + "typeName": "AWS::ServiceCatalog::TagOption" +} diff --git a/schema/aws-servicecatalog-tagoptionassociation.json b/schema/aws-servicecatalog-tagoptionassociation.json index 274678d..35db8d5 100644 --- a/schema/aws-servicecatalog-tagoptionassociation.json +++ b/schema/aws-servicecatalog-tagoptionassociation.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TagOptionId", - "/properties/ResourceId" - ], - "description": "Resource Type definition for AWS::ServiceCatalog::TagOptionAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "TagOptionId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TagOptionId", - "ResourceId" - ], - "typeName": "AWS::ServiceCatalog::TagOptionAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TagOptionId", + "/properties/ResourceId" + ], + "description": "Resource Type definition for AWS::ServiceCatalog::TagOptionAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "ResourceId": { + "type": "string" + }, + "TagOptionId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "TagOptionId", + "ResourceId" + ], + "typeName": "AWS::ServiceCatalog::TagOptionAssociation" +} diff --git a/schema/aws-servicecatalogappregistry-application.json b/schema/aws-servicecatalogappregistry-application.json index 44d3cb7..6b6963f 100644 --- a/schema/aws-servicecatalogappregistry-application.json +++ b/schema/aws-servicecatalogappregistry-application.json @@ -1,122 +1,122 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "definitions": { - "Tags": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::Application", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-application.html", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:CreateApplication", - "servicecatalog:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DeleteApplication" - ] - }, - "list": { - "permissions": [ - "servicecatalog:ListApplications" - ] - }, - "read": { - "permissions": [ - "servicecatalog:GetApplication" - ] - }, - "update": { - "permissions": [ - "servicecatalog:GetApplication", - "servicecatalog:ListTagsForResource", - "servicecatalog:TagResource", - "servicecatalog:UntagResource", - "servicecatalog:UpdateApplication", - "iam:CreateServiceLinkedRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApplicationName": { - "description": "The name of the application. ", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+", - "type": "string" - }, - "ApplicationTagKey": { - "description": "The key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.", - "maxLength": 128, - "pattern": "\\w+", - "type": "string" - }, - "ApplicationTagValue": { - "description": "The value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. ", - "maxLength": 256, - "pattern": "\\[a-zA-Z0-9_-:/]+", - "type": "string" - }, - "Arn": { - "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", - "type": "string" - }, - "Description": { - "description": "The description of the application. ", - "maxLength": 1024, - "type": "string" - }, - "Id": { - "pattern": "[a-z0-9]{26}", - "type": "string" - }, - "Name": { - "description": "The name of the application. ", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn", - "/properties/ApplicationName", - "/properties/ApplicationTagKey", - "/properties/ApplicationTagValue" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ServiceCatalogAppRegistry::Application" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "definitions": { + "Tags": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^[a-zA-Z+-=._:/]+$": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::Application", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-application.html", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:CreateApplication", + "servicecatalog:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "servicecatalog:ListApplications" + ] + }, + "read": { + "permissions": [ + "servicecatalog:GetApplication" + ] + }, + "update": { + "permissions": [ + "servicecatalog:GetApplication", + "servicecatalog:ListTagsForResource", + "servicecatalog:TagResource", + "servicecatalog:UntagResource", + "servicecatalog:UpdateApplication", + "iam:CreateServiceLinkedRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApplicationName": { + "description": "The name of the application. ", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+", + "type": "string" + }, + "ApplicationTagKey": { + "description": "The key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.", + "maxLength": 128, + "pattern": "\\w+", + "type": "string" + }, + "ApplicationTagValue": { + "description": "The value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. ", + "maxLength": 256, + "pattern": "\\[a-zA-Z0-9_-:/]+", + "type": "string" + }, + "Arn": { + "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", + "type": "string" + }, + "Description": { + "description": "The description of the application. ", + "maxLength": 1024, + "type": "string" + }, + "Id": { + "pattern": "[a-z0-9]{26}", + "type": "string" + }, + "Name": { + "description": "The name of the application. ", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn", + "/properties/ApplicationName", + "/properties/ApplicationTagKey", + "/properties/ApplicationTagValue" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ServiceCatalogAppRegistry::Application" +} diff --git a/schema/aws-servicecatalogappregistry-attributegroup.json b/schema/aws-servicecatalogappregistry-attributegroup.json index 5f173b9..c69e8c3 100644 --- a/schema/aws-servicecatalogappregistry-attributegroup.json +++ b/schema/aws-servicecatalogappregistry-attributegroup.json @@ -1,102 +1,102 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "definitions": { - "Tags": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { - "maxLength": 256, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroup.html", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:CreateAttributeGroup", - "servicecatalog:TagResource" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DeleteAttributeGroup" - ] - }, - "list": { - "permissions": [ - "servicecatalog:ListAttributeGroups" - ] - }, - "read": { - "permissions": [ - "servicecatalog:GetAttributeGroup" - ] - }, - "update": { - "permissions": [ - "servicecatalog:GetAttributeGroup", - "servicecatalog:UpdateAttributeGroup", - "servicecatalog:ListTagsForResource", - "servicecatalog:TagResource", - "servicecatalog:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+", - "type": "string" - }, - "Attributes": { - "type": "object" - }, - "Description": { - "description": "The description of the attribute group. ", - "maxLength": 1024, - "type": "string" - }, - "Id": { - "pattern": "[a-z0-9]{12}", - "type": "string" - }, - "Name": { - "description": "The name of the attribute group. ", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+", - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name", - "Attributes" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::ServiceCatalogAppRegistry::AttributeGroup" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "definitions": { + "Tags": { + "additionalProperties": false, + "maxProperties": 50, + "patternProperties": { + "^[a-zA-Z+-=._:/]+$": { + "maxLength": 256, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroup.html", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:CreateAttributeGroup", + "servicecatalog:TagResource" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DeleteAttributeGroup" + ] + }, + "list": { + "permissions": [ + "servicecatalog:ListAttributeGroups" + ] + }, + "read": { + "permissions": [ + "servicecatalog:GetAttributeGroup" + ] + }, + "update": { + "permissions": [ + "servicecatalog:GetAttributeGroup", + "servicecatalog:UpdateAttributeGroup", + "servicecatalog:ListTagsForResource", + "servicecatalog:TagResource", + "servicecatalog:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+", + "type": "string" + }, + "Attributes": { + "type": "object" + }, + "Description": { + "description": "The description of the attribute group. ", + "maxLength": 1024, + "type": "string" + }, + "Id": { + "pattern": "[a-z0-9]{12}", + "type": "string" + }, + "Name": { + "description": "The name of the attribute group. ", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+", + "type": "string" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name", + "Attributes" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ServiceCatalogAppRegistry::AttributeGroup" +} diff --git a/schema/aws-servicecatalogappregistry-attributegroupassociation.json b/schema/aws-servicecatalogappregistry-attributegroupassociation.json index 3a97e77..e3f670e 100644 --- a/schema/aws-servicecatalogappregistry-attributegroupassociation.json +++ b/schema/aws-servicecatalogappregistry-attributegroupassociation.json @@ -1,85 +1,85 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Application", - "/properties/AttributeGroup" - ], - "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroupassociation.html", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:AssociateAttributeGroup" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DisassociateAttributeGroup" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationArn": { - "$ref": "resource-schema.json#/properties/ApplicationArn" - } - }, - "required": [ - "ApplicationArn" - ] - }, - "permissions": [ - "servicecatalog:ListAttributeGroupsForApplication" - ] - }, - "read": { - "permissions": [ - "servicecatalog:ListAttributeGroupsForApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn", - "/properties/AttributeGroupArn" - ], - "properties": { - "Application": { - "description": "The name or the Id of the Application.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+|[a-z0-9]{12}", - "type": "string" - }, - "ApplicationArn": { - "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", - "type": "string" - }, - "AttributeGroup": { - "description": "The name or the Id of the AttributeGroup.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+|[a-z0-9]{12}", - "type": "string" - }, - "AttributeGroupArn": { - "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/AttributeGroupArn" - ], - "required": [ - "Application", - "AttributeGroup" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Application", + "/properties/AttributeGroup" + ], + "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroupassociation.html", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:AssociateAttributeGroup" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DisassociateAttributeGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationArn": { + "$ref": "resource-schema.json#/properties/ApplicationArn" + } + }, + "required": [ + "ApplicationArn" + ] + }, + "permissions": [ + "servicecatalog:ListAttributeGroupsForApplication" + ] + }, + "read": { + "permissions": [ + "servicecatalog:ListAttributeGroupsForApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn", + "/properties/AttributeGroupArn" + ], + "properties": { + "Application": { + "description": "The name or the Id of the Application.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+|[a-z0-9]{12}", + "type": "string" + }, + "ApplicationArn": { + "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", + "type": "string" + }, + "AttributeGroup": { + "description": "The name or the Id of the AttributeGroup.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+|[a-z0-9]{12}", + "type": "string" + }, + "AttributeGroupArn": { + "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/AttributeGroupArn" + ], + "required": [ + "Application", + "AttributeGroup" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" +} diff --git a/schema/aws-servicecatalogappregistry-resourceassociation.json b/schema/aws-servicecatalogappregistry-resourceassociation.json index a7d4451..5107025 100644 --- a/schema/aws-servicecatalogappregistry-resourceassociation.json +++ b/schema/aws-servicecatalogappregistry-resourceassociation.json @@ -1,94 +1,94 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Application", - "/properties/Resource", - "/properties/ResourceType" - ], - "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation", - "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-resourceassociation.html", - "handlers": { - "create": { - "permissions": [ - "servicecatalog:AssociateResource", - "cloudformation:DescribeStacks" - ] - }, - "delete": { - "permissions": [ - "servicecatalog:DisassociateResource" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationArn": { - "$ref": "resource-schema.json#/properties/ApplicationArn" - } - }, - "required": [ - "ApplicationArn" - ] - }, - "permissions": [ - "servicecatalog:ListAssociatedResources" - ] - }, - "read": { - "permissions": [ - "servicecatalog:ListAssociatedResources" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn", - "/properties/ResourceArn", - "/properties/ResourceType" - ], - "properties": { - "Application": { - "description": "The name or the Id of the Application.", - "maxLength": 256, - "minLength": 1, - "pattern": "\\w+|[a-z0-9]{12}", - "type": "string" - }, - "ApplicationArn": { - "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", - "type": "string" - }, - "Resource": { - "description": "The name or the Id of the Resource.", - "pattern": "\\w+|arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}", - "type": "string" - }, - "ResourceArn": { - "pattern": "arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}", - "type": "string" - }, - "ResourceType": { - "description": "The type of the CFN Resource for now it's enum CFN_STACK.", - "enum": [ - "CFN_STACK" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/ResourceArn" - ], - "required": [ - "Application", - "Resource", - "ResourceType" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::ServiceCatalogAppRegistry::ResourceAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Application", + "/properties/Resource", + "/properties/ResourceType" + ], + "description": "Resource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation", + "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-resourceassociation.html", + "handlers": { + "create": { + "permissions": [ + "servicecatalog:AssociateResource", + "cloudformation:DescribeStacks" + ] + }, + "delete": { + "permissions": [ + "servicecatalog:DisassociateResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationArn": { + "$ref": "resource-schema.json#/properties/ApplicationArn" + } + }, + "required": [ + "ApplicationArn" + ] + }, + "permissions": [ + "servicecatalog:ListAssociatedResources" + ] + }, + "read": { + "permissions": [ + "servicecatalog:ListAssociatedResources" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn", + "/properties/ResourceArn", + "/properties/ResourceType" + ], + "properties": { + "Application": { + "description": "The name or the Id of the Application.", + "maxLength": 256, + "minLength": 1, + "pattern": "\\w+|[a-z0-9]{12}", + "type": "string" + }, + "ApplicationArn": { + "pattern": "arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+", + "type": "string" + }, + "Resource": { + "description": "The name or the Id of the Resource.", + "pattern": "\\w+|arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}", + "type": "string" + }, + "ResourceArn": { + "pattern": "arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}", + "type": "string" + }, + "ResourceType": { + "description": "The type of the CFN Resource for now it's enum CFN_STACK.", + "enum": [ + "CFN_STACK" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/ResourceArn" + ], + "required": [ + "Application", + "Resource", + "ResourceType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-servicecatalog-appregistry", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::ServiceCatalogAppRegistry::ResourceAssociation" +} diff --git a/schema/aws-servicediscovery-httpnamespace.json b/schema/aws-servicediscovery-httpnamespace.json index d70b29a..b20fe68 100644 --- a/schema/aws-servicediscovery-httpnamespace.json +++ b/schema/aws-servicediscovery-httpnamespace.json @@ -1,57 +1,57 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceDiscovery::HttpNamespace", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "typeName": "AWS::ServiceDiscovery::HttpNamespace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceDiscovery::HttpNamespace", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "typeName": "AWS::ServiceDiscovery::HttpNamespace" +} diff --git a/schema/aws-servicediscovery-instance.json b/schema/aws-servicediscovery-instance.json index 2b0154e..0934803 100644 --- a/schema/aws-servicediscovery-instance.json +++ b/schema/aws-servicediscovery-instance.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceId", - "/properties/ServiceId" - ], - "description": "Resource Type definition for AWS::ServiceDiscovery::Instance", - "primaryIdentifier": [ - "/properties/InstanceId" - ], - "properties": { - "InstanceAttributes": { - "type": "object" - }, - "InstanceId": { - "type": "string" - }, - "ServiceId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/InstanceId" - ], - "required": [ - "InstanceAttributes", - "ServiceId" - ], - "typeName": "AWS::ServiceDiscovery::Instance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceId", + "/properties/ServiceId" + ], + "description": "Resource Type definition for AWS::ServiceDiscovery::Instance", + "primaryIdentifier": [ + "/properties/InstanceId" + ], + "properties": { + "InstanceAttributes": { + "type": "object" + }, + "InstanceId": { + "type": "string" + }, + "ServiceId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/InstanceId" + ], + "required": [ + "InstanceAttributes", + "ServiceId" + ], + "typeName": "AWS::ServiceDiscovery::Instance" +} diff --git a/schema/aws-servicediscovery-privatednsnamespace.json b/schema/aws-servicediscovery-privatednsnamespace.json index b38439c..39c7228 100644 --- a/schema/aws-servicediscovery-privatednsnamespace.json +++ b/schema/aws-servicediscovery-privatednsnamespace.json @@ -1,96 +1,96 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Vpc", - "/properties/Name" - ], - "definitions": { - "PrivateDnsPropertiesMutable": { - "additionalProperties": false, - "properties": { - "SOA": { - "$ref": "#/definitions/SOA" - } - }, - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DnsProperties": { - "$ref": "#/definitions/PrivateDnsPropertiesMutable" - } - }, - "type": "object" - }, - "SOA": { - "additionalProperties": false, - "properties": { - "TTL": { - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceDiscovery::PrivateDnsNamespace", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/Properties" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Vpc": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/HostedZoneId", - "/properties/Arn" - ], - "required": [ - "Vpc", - "Name" - ], - "typeName": "AWS::ServiceDiscovery::PrivateDnsNamespace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Vpc", + "/properties/Name" + ], + "definitions": { + "PrivateDnsPropertiesMutable": { + "additionalProperties": false, + "properties": { + "SOA": { + "$ref": "#/definitions/SOA" + } + }, + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "DnsProperties": { + "$ref": "#/definitions/PrivateDnsPropertiesMutable" + } + }, + "type": "object" + }, + "SOA": { + "additionalProperties": false, + "properties": { + "TTL": { + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceDiscovery::PrivateDnsNamespace", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/Properties" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Vpc": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/HostedZoneId", + "/properties/Arn" + ], + "required": [ + "Vpc", + "Name" + ], + "typeName": "AWS::ServiceDiscovery::PrivateDnsNamespace" +} diff --git a/schema/aws-servicediscovery-publicdnsnamespace.json b/schema/aws-servicediscovery-publicdnsnamespace.json index b47135e..dbc98fa 100644 --- a/schema/aws-servicediscovery-publicdnsnamespace.json +++ b/schema/aws-servicediscovery-publicdnsnamespace.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Properties": { - "additionalProperties": false, - "properties": { - "DnsProperties": { - "$ref": "#/definitions/PublicDnsPropertiesMutable" - } - }, - "type": "object" - }, - "PublicDnsPropertiesMutable": { - "additionalProperties": false, - "properties": { - "SOA": { - "$ref": "#/definitions/SOA" - } - }, - "type": "object" - }, - "SOA": { - "additionalProperties": false, - "properties": { - "TTL": { - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceDiscovery::PublicDnsNamespace", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Properties": { - "$ref": "#/definitions/Properties" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/HostedZoneId", - "/properties/Arn" - ], - "required": [ - "Name" - ], - "typeName": "AWS::ServiceDiscovery::PublicDnsNamespace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Properties": { + "additionalProperties": false, + "properties": { + "DnsProperties": { + "$ref": "#/definitions/PublicDnsPropertiesMutable" + } + }, + "type": "object" + }, + "PublicDnsPropertiesMutable": { + "additionalProperties": false, + "properties": { + "SOA": { + "$ref": "#/definitions/SOA" + } + }, + "type": "object" + }, + "SOA": { + "additionalProperties": false, + "properties": { + "TTL": { + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceDiscovery::PublicDnsNamespace", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/Properties" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/HostedZoneId", + "/properties/Arn" + ], + "required": [ + "Name" + ], + "typeName": "AWS::ServiceDiscovery::PublicDnsNamespace" +} diff --git a/schema/aws-servicediscovery-service.json b/schema/aws-servicediscovery-service.json index 349af03..ae198b1 100644 --- a/schema/aws-servicediscovery-service.json +++ b/schema/aws-servicediscovery-service.json @@ -1,137 +1,137 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/HealthCheckCustomConfig", - "/properties/Name", - "/properties/Type", - "/properties/NamespaceId" - ], - "definitions": { - "DnsConfig": { - "additionalProperties": false, - "properties": { - "DnsRecords": { - "items": { - "$ref": "#/definitions/DnsRecord" - }, - "type": "array", - "uniqueItems": false - }, - "NamespaceId": { - "type": "string" - }, - "RoutingPolicy": { - "type": "string" - } - }, - "required": [ - "DnsRecords" - ], - "type": "object" - }, - "DnsRecord": { - "additionalProperties": false, - "properties": { - "TTL": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "TTL" - ], - "type": "object" - }, - "HealthCheckConfig": { - "additionalProperties": false, - "properties": { - "FailureThreshold": { - "type": "number" - }, - "ResourcePath": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "HealthCheckCustomConfig": { - "additionalProperties": false, - "properties": { - "FailureThreshold": { - "type": "number" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::ServiceDiscovery::Service", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DnsConfig": { - "$ref": "#/definitions/DnsConfig" - }, - "HealthCheckConfig": { - "$ref": "#/definitions/HealthCheckConfig" - }, - "HealthCheckCustomConfig": { - "$ref": "#/definitions/HealthCheckCustomConfig" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NamespaceId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "typeName": "AWS::ServiceDiscovery::Service" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/HealthCheckCustomConfig", + "/properties/Name", + "/properties/Type", + "/properties/NamespaceId" + ], + "definitions": { + "DnsConfig": { + "additionalProperties": false, + "properties": { + "DnsRecords": { + "items": { + "$ref": "#/definitions/DnsRecord" + }, + "type": "array", + "uniqueItems": false + }, + "NamespaceId": { + "type": "string" + }, + "RoutingPolicy": { + "type": "string" + } + }, + "required": [ + "DnsRecords" + ], + "type": "object" + }, + "DnsRecord": { + "additionalProperties": false, + "properties": { + "TTL": { + "type": "number" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "TTL" + ], + "type": "object" + }, + "HealthCheckConfig": { + "additionalProperties": false, + "properties": { + "FailureThreshold": { + "type": "number" + }, + "ResourcePath": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "HealthCheckCustomConfig": { + "additionalProperties": false, + "properties": { + "FailureThreshold": { + "type": "number" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ServiceDiscovery::Service", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DnsConfig": { + "$ref": "#/definitions/DnsConfig" + }, + "HealthCheckConfig": { + "$ref": "#/definitions/HealthCheckConfig" + }, + "HealthCheckCustomConfig": { + "$ref": "#/definitions/HealthCheckCustomConfig" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "NamespaceId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "Type": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "typeName": "AWS::ServiceDiscovery::Service" +} diff --git a/schema/aws-ses-configurationset.json b/schema/aws-ses-configurationset.json index a525275..34594cf 100644 --- a/schema/aws-ses-configurationset.json +++ b/schema/aws-ses-configurationset.json @@ -1,187 +1,184 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "DashboardOptions": { - "additionalProperties": false, - "description": "Preferences regarding the Dashboard feature.", - "properties": { - "EngagementMetrics": { - "description": "Whether emails sent with this configuration set have engagement tracking enabled.", - "pattern": "ENABLED|DISABLED", - "type": "string" - } - }, - "required": [ - "EngagementMetrics" - ], - "type": "object" - }, - "DeliveryOptions": { - "additionalProperties": false, - "description": "An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.", - "properties": { - "SendingPoolName": { - "description": "The name of the dedicated IP pool to associate with the configuration set.", - "type": "string" - }, - "TlsPolicy": { - "description": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established.", - "pattern": "REQUIRE|OPTIONAL", - "type": "string" - } - }, - "type": "object" - }, - "GuardianOptions": { - "additionalProperties": false, - "description": "Preferences regarding the Guardian feature.", - "properties": { - "OptimizedSharedDelivery": { - "description": "Whether emails sent with this configuration set have optimized delivery algorithm enabled.", - "pattern": "ENABLED|DISABLED", - "type": "string" - } - }, - "required": [ - "OptimizedSharedDelivery" - ], - "type": "object" - }, - "ReputationOptions": { - "additionalProperties": false, - "description": "An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.", - "properties": { - "ReputationMetricsEnabled": { - "description": "If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.", - "pattern": "true|false", - "type": "boolean" - } - }, - "type": "object" - }, - "SendingOptions": { - "additionalProperties": false, - "description": "An object that defines whether or not Amazon SES can send email that you send using the configuration set.", - "properties": { - "SendingEnabled": { - "pattern": "true|false", - "type": "boolean" - } - }, - "type": "object" - }, - "SuppressionOptions": { - "additionalProperties": false, - "description": "An object that contains information about the suppression list preferences for your account.", - "properties": { - "SuppressedReasons": { - "description": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account.", - "insertionOrder": false, - "items": { - "description": "The reason that the address was added to the suppression list for your account", - "pattern": "BOUNCE|COMPLAINT", - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "TrackingOptions": { - "additionalProperties": false, - "description": "An object that defines the open and click tracking options for emails that you send using the configuration set.", - "properties": { - "CustomRedirectDomain": { - "description": "The domain to use for tracking open and click events.", - "type": "string" - } - }, - "required": [ - "CustomRedirectDomain" - ], - "type": "object" - }, - "VdmOptions": { - "additionalProperties": false, - "description": "An object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.", - "properties": { - "DashboardOptions": { - "$ref": "#/definitions/DashboardOptions" - }, - "GuardianOptions": { - "$ref": "#/definitions/GuardianOptions" - } - }, - "type": "object" - } - }, - "description": "Resource schema for AWS::SES::ConfigurationSet.", - "handlers": { - "create": { - "permissions": [ - "ses:CreateConfigurationSet" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteConfigurationSet" - ] - }, - "list": { - "permissions": [ - "ses:ListConfigurationSets" - ] - }, - "read": { - "permissions": [ - "ses:GetConfigurationSet", - "ses:DescribeConfigurationSet" - ] - }, - "update": { - "permissions": [ - "ses:PutConfigurationSetTrackingOptions", - "ses:PutConfigurationSetDeliveryOptions", - "ses:PutConfigurationSetReputationOptions", - "ses:PutConfigurationSetSendingOptions", - "ses:PutConfigurationSetSuppressionOptions", - "ses:PutConfigurationSetVdmOptions" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "DeliveryOptions": { - "$ref": "#/definitions/DeliveryOptions" - }, - "Name": { - "description": "The name of the configuration set.", - "pattern": "^[a-zA-Z0-9_-]{1,64}$", - "type": "string" - }, - "ReputationOptions": { - "$ref": "#/definitions/ReputationOptions" - }, - "SendingOptions": { - "$ref": "#/definitions/SendingOptions" - }, - "SuppressionOptions": { - "$ref": "#/definitions/SuppressionOptions" - }, - "TrackingOptions": { - "$ref": "#/definitions/TrackingOptions" - }, - "VdmOptions": { - "$ref": "#/definitions/VdmOptions" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "taggable": false, - "typeName": "AWS::SES::ConfigurationSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "DashboardOptions": { + "additionalProperties": false, + "description": "Preferences regarding the Dashboard feature.", + "properties": { + "EngagementMetrics": { + "description": "Whether emails sent with this configuration set have engagement tracking enabled.", + "pattern": "ENABLED|DISABLED", + "type": "string" + } + }, + "required": [ + "EngagementMetrics" + ], + "type": "object" + }, + "DeliveryOptions": { + "additionalProperties": false, + "description": "An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.", + "properties": { + "SendingPoolName": { + "description": "The name of the dedicated IP pool to associate with the configuration set.", + "type": "string" + }, + "TlsPolicy": { + "description": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established.", + "pattern": "REQUIRE|OPTIONAL", + "type": "string" + } + }, + "type": "object" + }, + "GuardianOptions": { + "additionalProperties": false, + "description": "Preferences regarding the Guardian feature.", + "properties": { + "OptimizedSharedDelivery": { + "description": "Whether emails sent with this configuration set have optimized delivery algorithm enabled.", + "pattern": "ENABLED|DISABLED", + "type": "string" + } + }, + "required": [ + "OptimizedSharedDelivery" + ], + "type": "object" + }, + "ReputationOptions": { + "additionalProperties": false, + "description": "An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.", + "properties": { + "ReputationMetricsEnabled": { + "description": "If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.", + "pattern": "true|false", + "type": "boolean" + } + }, + "type": "object" + }, + "SendingOptions": { + "additionalProperties": false, + "description": "An object that defines whether or not Amazon SES can send email that you send using the configuration set.", + "properties": { + "SendingEnabled": { + "pattern": "true|false", + "type": "boolean" + } + }, + "type": "object" + }, + "SuppressionOptions": { + "additionalProperties": false, + "description": "An object that contains information about the suppression list preferences for your account.", + "properties": { + "SuppressedReasons": { + "description": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account.", + "insertionOrder": false, + "items": { + "description": "The reason that the address was added to the suppression list for your account", + "pattern": "BOUNCE|COMPLAINT", + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "TrackingOptions": { + "additionalProperties": false, + "description": "An object that defines the open and click tracking options for emails that you send using the configuration set.", + "properties": { + "CustomRedirectDomain": { + "description": "The domain to use for tracking open and click events.", + "type": "string" + } + }, + "type": "object" + }, + "VdmOptions": { + "additionalProperties": false, + "description": "An object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.", + "properties": { + "DashboardOptions": { + "$ref": "#/definitions/DashboardOptions" + }, + "GuardianOptions": { + "$ref": "#/definitions/GuardianOptions" + } + }, + "type": "object" + } + }, + "description": "Resource schema for AWS::SES::ConfigurationSet.", + "handlers": { + "create": { + "permissions": [ + "ses:CreateConfigurationSet" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteConfigurationSet" + ] + }, + "list": { + "permissions": [ + "ses:ListConfigurationSets" + ] + }, + "read": { + "permissions": [ + "ses:GetConfigurationSet", + "ses:DescribeConfigurationSet" + ] + }, + "update": { + "permissions": [ + "ses:PutConfigurationSetTrackingOptions", + "ses:PutConfigurationSetDeliveryOptions", + "ses:PutConfigurationSetReputationOptions", + "ses:PutConfigurationSetSendingOptions", + "ses:PutConfigurationSetSuppressionOptions", + "ses:PutConfigurationSetVdmOptions" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "DeliveryOptions": { + "$ref": "#/definitions/DeliveryOptions" + }, + "Name": { + "description": "The name of the configuration set.", + "pattern": "^[a-zA-Z0-9_-]{1,64}$", + "type": "string" + }, + "ReputationOptions": { + "$ref": "#/definitions/ReputationOptions" + }, + "SendingOptions": { + "$ref": "#/definitions/SendingOptions" + }, + "SuppressionOptions": { + "$ref": "#/definitions/SuppressionOptions" + }, + "TrackingOptions": { + "$ref": "#/definitions/TrackingOptions" + }, + "VdmOptions": { + "$ref": "#/definitions/VdmOptions" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "taggable": false, + "typeName": "AWS::SES::ConfigurationSet" +} diff --git a/schema/aws-ses-configurationseteventdestination.json b/schema/aws-ses-configurationseteventdestination.json index 2c1bb66..f2e2a30 100644 --- a/schema/aws-ses-configurationseteventdestination.json +++ b/schema/aws-ses-configurationseteventdestination.json @@ -1,201 +1,201 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConfigurationSetName" - ], - "definitions": { - "CloudWatchDestination": { - "additionalProperties": false, - "description": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.", - "properties": { - "DimensionConfigurations": { - "description": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DimensionConfiguration" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "DimensionConfiguration": { - "additionalProperties": false, - "description": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.", - "properties": { - "DefaultDimensionValue": { - "description": "The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]{1,256}$", - "type": "string" - }, - "DimensionName": { - "description": "The name of an Amazon CloudWatch dimension associated with an email sending metric.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_:-]{1,256}$", - "type": "string" - }, - "DimensionValueSource": { - "description": "The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.", - "type": "string" - } - }, - "required": [ - "DimensionValueSource", - "DefaultDimensionValue", - "DimensionName" - ], - "type": "object" - }, - "EventBridgeDestination": { - "additionalProperties": false, - "description": "An object that contains Event bus ARN associated with the event bridge destination.", - "properties": { - "EventBusArn": { - "maxLength": 1024, - "minLength": 36, - "pattern": "^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\\d{12}:event-bus/[^:]+$", - "type": "string" - } - }, - "required": [ - "EventBusArn" - ], - "type": "object" - }, - "EventDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchDestination": { - "$ref": "#/definitions/CloudWatchDestination", - "description": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination." - }, - "Enabled": { - "description": "Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. ", - "type": "boolean" - }, - "EventBridgeDestination": { - "$ref": "#/definitions/EventBridgeDestination", - "description": "An object that contains Event bus ARN associated with the event bridge destination." - }, - "KinesisFirehoseDestination": { - "$ref": "#/definitions/KinesisFirehoseDestination", - "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." - }, - "MatchingEventTypes": { - "description": "The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Name": { - "description": "The name of the event destination set.", - "pattern": "^[a-zA-Z0-9_-]{0,64}$", - "type": "string" - }, - "SnsDestination": { - "$ref": "#/definitions/SnsDestination", - "description": "An object that contains SNS topic ARN associated event destination." - } - }, - "required": [ - "MatchingEventTypes" - ], - "type": "object" - }, - "KinesisFirehoseDestination": { - "additionalProperties": false, - "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.", - "properties": { - "DeliveryStreamARN": { - "description": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.", - "type": "string" - }, - "IAMRoleARN": { - "description": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.", - "type": "string" - } - }, - "required": [ - "IAMRoleARN", - "DeliveryStreamARN" - ], - "type": "object" - }, - "SnsDestination": { - "additionalProperties": false, - "description": "An object that contains SNS topic ARN associated event destination.", - "properties": { - "TopicARN": { - "maxLength": 1024, - "minLength": 36, - "pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$", - "type": "string" - } - }, - "required": [ - "TopicARN" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::ConfigurationSetEventDestination", - "handlers": { - "create": { - "permissions": [ - "ses:CreateConfigurationSetEventDestination", - "ses:GetConfigurationSetEventDestinations", - "ses:DescribeConfigurationSet" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteConfigurationSetEventDestination" - ] - }, - "read": { - "permissions": [ - "ses:GetConfigurationSetEventDestinations", - "ses:DescribeConfigurationSet" - ] - }, - "update": { - "permissions": [ - "ses:UpdateConfigurationSetEventDestination", - "ses:GetConfigurationSetEventDestinations" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ConfigurationSetName": { - "description": "The name of the configuration set that contains the event destination.", - "type": "string" - }, - "EventDestination": { - "$ref": "#/definitions/EventDestination", - "description": "The event destination object." - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ConfigurationSetName", - "EventDestination" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "taggable": false, - "typeName": "AWS::SES::ConfigurationSetEventDestination" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigurationSetName" + ], + "definitions": { + "CloudWatchDestination": { + "additionalProperties": false, + "description": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.", + "properties": { + "DimensionConfigurations": { + "description": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DimensionConfiguration" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "DimensionConfiguration": { + "additionalProperties": false, + "description": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.", + "properties": { + "DefaultDimensionValue": { + "description": "The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{1,256}$", + "type": "string" + }, + "DimensionName": { + "description": "The name of an Amazon CloudWatch dimension associated with an email sending metric.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_:-]{1,256}$", + "type": "string" + }, + "DimensionValueSource": { + "description": "The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.", + "type": "string" + } + }, + "required": [ + "DimensionValueSource", + "DefaultDimensionValue", + "DimensionName" + ], + "type": "object" + }, + "EventBridgeDestination": { + "additionalProperties": false, + "description": "An object that contains Event bus ARN associated with the event bridge destination.", + "properties": { + "EventBusArn": { + "maxLength": 1024, + "minLength": 36, + "pattern": "^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\\d{12}:event-bus/[^:]+$", + "type": "string" + } + }, + "required": [ + "EventBusArn" + ], + "type": "object" + }, + "EventDestination": { + "additionalProperties": false, + "properties": { + "CloudWatchDestination": { + "$ref": "#/definitions/CloudWatchDestination", + "description": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination." + }, + "Enabled": { + "description": "Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. ", + "type": "boolean" + }, + "EventBridgeDestination": { + "$ref": "#/definitions/EventBridgeDestination", + "description": "An object that contains Event bus ARN associated with the event bridge destination." + }, + "KinesisFirehoseDestination": { + "$ref": "#/definitions/KinesisFirehoseDestination", + "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." + }, + "MatchingEventTypes": { + "description": "The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Name": { + "description": "The name of the event destination set.", + "pattern": "^[a-zA-Z0-9_-]{0,64}$", + "type": "string" + }, + "SnsDestination": { + "$ref": "#/definitions/SnsDestination", + "description": "An object that contains SNS topic ARN associated event destination." + } + }, + "required": [ + "MatchingEventTypes" + ], + "type": "object" + }, + "KinesisFirehoseDestination": { + "additionalProperties": false, + "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.", + "properties": { + "DeliveryStreamARN": { + "description": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.", + "type": "string" + }, + "IAMRoleARN": { + "description": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.", + "type": "string" + } + }, + "required": [ + "IAMRoleARN", + "DeliveryStreamARN" + ], + "type": "object" + }, + "SnsDestination": { + "additionalProperties": false, + "description": "An object that contains SNS topic ARN associated event destination.", + "properties": { + "TopicARN": { + "maxLength": 1024, + "minLength": 36, + "pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$", + "type": "string" + } + }, + "required": [ + "TopicARN" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::ConfigurationSetEventDestination", + "handlers": { + "create": { + "permissions": [ + "ses:CreateConfigurationSetEventDestination", + "ses:GetConfigurationSetEventDestinations", + "ses:DescribeConfigurationSet" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteConfigurationSetEventDestination" + ] + }, + "read": { + "permissions": [ + "ses:GetConfigurationSetEventDestinations", + "ses:DescribeConfigurationSet" + ] + }, + "update": { + "permissions": [ + "ses:UpdateConfigurationSetEventDestination", + "ses:GetConfigurationSetEventDestinations" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ConfigurationSetName": { + "description": "The name of the configuration set that contains the event destination.", + "type": "string" + }, + "EventDestination": { + "$ref": "#/definitions/EventDestination", + "description": "The event destination object." + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ConfigurationSetName", + "EventDestination" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "taggable": false, + "typeName": "AWS::SES::ConfigurationSetEventDestination" +} diff --git a/schema/aws-ses-contactlist.json b/schema/aws-ses-contactlist.json index 2bddcb9..d66c1d4 100644 --- a/schema/aws-ses-contactlist.json +++ b/schema/aws-ses-contactlist.json @@ -1,126 +1,126 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContactListName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Topic": { - "additionalProperties": false, - "properties": { - "DefaultSubscriptionStatus": { - "type": "string" - }, - "Description": { - "description": "The description of the topic.", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "DisplayName": { - "description": "The display name of the topic.", - "maxLength": 128, - "minLength": 0, - "type": "string" - }, - "TopicName": { - "description": "The name of the topic.", - "pattern": "^[a-zA-Z0-9_-]{1,64}$", - "type": "string" - } - }, - "required": [ - "TopicName", - "DisplayName", - "DefaultSubscriptionStatus" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::SES::ContactList.", - "handlers": { - "create": { - "permissions": [ - "ses:CreateContactList" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteContactList" - ] - }, - "list": { - "permissions": [ - "ses:ListContactLists" - ] - }, - "read": { - "permissions": [ - "ses:GetContactList" - ] - }, - "update": { - "permissions": [ - "ses:UpdateContactList", - "ses:UntagResource", - "ses:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ContactListName" - ], - "properties": { - "ContactListName": { - "description": "The name of the contact list.", - "pattern": "^[a-zA-Z0-9_-]{1,64}$", - "type": "string" - }, - "Description": { - "description": "The description of the contact list.", - "maxLength": 500, - "type": "string" - }, - "Tags": { - "description": "The tags (keys and values) associated with the contact list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - }, - "Topics": { - "description": "The topics associated with the contact list.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Topic" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "typeName": "AWS::SES::ContactList" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContactListName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Topic": { + "additionalProperties": false, + "properties": { + "DefaultSubscriptionStatus": { + "type": "string" + }, + "Description": { + "description": "The description of the topic.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "description": "The display name of the topic.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "TopicName": { + "description": "The name of the topic.", + "pattern": "^[a-zA-Z0-9_-]{1,64}$", + "type": "string" + } + }, + "required": [ + "TopicName", + "DisplayName", + "DefaultSubscriptionStatus" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::SES::ContactList.", + "handlers": { + "create": { + "permissions": [ + "ses:CreateContactList" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteContactList" + ] + }, + "list": { + "permissions": [ + "ses:ListContactLists" + ] + }, + "read": { + "permissions": [ + "ses:GetContactList" + ] + }, + "update": { + "permissions": [ + "ses:UpdateContactList", + "ses:UntagResource", + "ses:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ContactListName" + ], + "properties": { + "ContactListName": { + "description": "The name of the contact list.", + "pattern": "^[a-zA-Z0-9_-]{1,64}$", + "type": "string" + }, + "Description": { + "description": "The description of the contact list.", + "maxLength": 500, + "type": "string" + }, + "Tags": { + "description": "The tags (keys and values) associated with the contact list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "Topics": { + "description": "The topics associated with the contact list.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Topic" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "typeName": "AWS::SES::ContactList" +} diff --git a/schema/aws-ses-dedicatedippool.json b/schema/aws-ses-dedicatedippool.json index 2d8559a..2647965 100644 --- a/schema/aws-ses-dedicatedippool.json +++ b/schema/aws-ses-dedicatedippool.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/ScalingMode" - ], - "createOnlyProperties": [ - "/properties/PoolName" - ], - "description": "Resource Type definition for AWS::SES::DedicatedIpPool", - "handlers": { - "create": { - "permissions": [ - "ses:CreateDedicatedIpPool", - "ses:GetDedicatedIpPool", - "ses:GetDedicatedIps" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteDedicatedIpPool" - ] - }, - "list": { - "permissions": [ - "ses:ListDedicatedIpPools" - ] - }, - "read": { - "permissions": [ - "ses:GetDedicatedIpPool", - "ses:GetDedicatedIps" - ] - }, - "update": { - "permissions": [ - "ses:PutDedicatedIpPoolScalingAttributes", - "ses:GetDedicatedIpPool" - ] - } - }, - "primaryIdentifier": [ - "/properties/PoolName" - ], - "properties": { - "PoolName": { - "description": "The name of the dedicated IP pool.", - "pattern": "^[a-z0-9_-]{0,64}$", - "type": "string" - }, - "ScalingMode": { - "description": "Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD.", - "pattern": "^(STANDARD|MANAGED)$", - "type": "string" - } - }, - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "typeName": "AWS::SES::DedicatedIpPool" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/ScalingMode" + ], + "createOnlyProperties": [ + "/properties/PoolName" + ], + "description": "Resource Type definition for AWS::SES::DedicatedIpPool", + "handlers": { + "create": { + "permissions": [ + "ses:CreateDedicatedIpPool", + "ses:GetDedicatedIpPool", + "ses:GetDedicatedIps" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteDedicatedIpPool" + ] + }, + "list": { + "permissions": [ + "ses:ListDedicatedIpPools" + ] + }, + "read": { + "permissions": [ + "ses:GetDedicatedIpPool", + "ses:GetDedicatedIps" + ] + }, + "update": { + "permissions": [ + "ses:PutDedicatedIpPoolScalingAttributes", + "ses:GetDedicatedIpPool" + ] + } + }, + "primaryIdentifier": [ + "/properties/PoolName" + ], + "properties": { + "PoolName": { + "description": "The name of the dedicated IP pool.", + "pattern": "^[a-z0-9_-]{0,64}$", + "type": "string" + }, + "ScalingMode": { + "description": "Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD.", + "pattern": "^(STANDARD|MANAGED)$", + "type": "string" + } + }, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "typeName": "AWS::SES::DedicatedIpPool" +} diff --git a/schema/aws-ses-emailidentity.json b/schema/aws-ses-emailidentity.json index 64efc95..20477c7 100644 --- a/schema/aws-ses-emailidentity.json +++ b/schema/aws-ses-emailidentity.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/EmailIdentity" - ], - "definitions": { - "ConfigurationSetAttributes": { - "additionalProperties": false, - "description": "Used to associate a configuration set with an email identity.", - "properties": { - "ConfigurationSetName": { - "description": "The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.", - "type": "string" - } - }, - "type": "object" - }, - "DkimAttributes": { - "additionalProperties": false, - "description": "Used to enable or disable DKIM authentication for an email identity.", - "properties": { - "SigningEnabled": { - "description": "Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.", - "type": "boolean" - } - }, - "type": "object" - }, - "DkimSigningAttributes": { - "additionalProperties": false, - "description": "If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.", - "properties": { - "DomainSigningPrivateKey": { - "description": "[Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.", - "type": "string" - }, - "DomainSigningSelector": { - "description": "[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.", - "type": "string" - }, - "NextSigningKeyLength": { - "description": "[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.", - "pattern": "RSA_1024_BIT|RSA_2048_BIT", - "type": "string" - } - }, - "type": "object" - }, - "FeedbackAttributes": { - "additionalProperties": false, - "description": "Used to enable or disable feedback forwarding for an identity.", - "properties": { - "EmailForwardingEnabled": { - "description": "If the value is true, you receive email notifications when bounce or complaint events occur", - "type": "boolean" - } - }, - "type": "object" - }, - "MailFromAttributes": { - "additionalProperties": false, - "description": "Used to enable or disable the custom Mail-From domain configuration for an email identity.", - "properties": { - "BehaviorOnMxFailure": { - "description": "The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.", - "pattern": "USE_DEFAULT_VALUE|REJECT_MESSAGE", - "type": "string" - }, - "MailFromDomain": { - "description": "The custom MAIL FROM domain that you want the verified identity to use", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::EmailIdentity", - "handlers": { - "create": { - "permissions": [ - "ses:CreateEmailIdentity", - "ses:PutEmailIdentityMailFromAttributes", - "ses:PutEmailIdentityFeedbackAttributes", - "ses:PutEmailIdentityDkimAttributes", - "ses:GetEmailIdentity" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteEmailIdentity" - ] - }, - "list": { - "permissions": [ - "ses:ListEmailIdentities" - ] - }, - "read": { - "permissions": [ - "ses:GetEmailIdentity" - ] - }, - "update": { - "permissions": [ - "ses:PutEmailIdentityMailFromAttributes", - "ses:PutEmailIdentityFeedbackAttributes", - "ses:PutEmailIdentityConfigurationSetAttributes", - "ses:PutEmailIdentityDkimSigningAttributes", - "ses:PutEmailIdentityDkimAttributes", - "ses:GetEmailIdentity" - ] - } - }, - "primaryIdentifier": [ - "/properties/EmailIdentity" - ], - "properties": { - "ConfigurationSetAttributes": { - "$ref": "#/definitions/ConfigurationSetAttributes" - }, - "DkimAttributes": { - "$ref": "#/definitions/DkimAttributes" - }, - "DkimDNSTokenName1": { - "type": "string" - }, - "DkimDNSTokenName2": { - "type": "string" - }, - "DkimDNSTokenName3": { - "type": "string" - }, - "DkimDNSTokenValue1": { - "type": "string" - }, - "DkimDNSTokenValue2": { - "type": "string" - }, - "DkimDNSTokenValue3": { - "type": "string" - }, - "DkimSigningAttributes": { - "$ref": "#/definitions/DkimSigningAttributes" - }, - "EmailIdentity": { - "description": "The email address or domain to verify.", - "type": "string" - }, - "FeedbackAttributes": { - "$ref": "#/definitions/FeedbackAttributes" - }, - "MailFromAttributes": { - "$ref": "#/definitions/MailFromAttributes" - } - }, - "readOnlyProperties": [ - "/properties/DkimDNSTokenName1", - "/properties/DkimDNSTokenName2", - "/properties/DkimDNSTokenName3", - "/properties/DkimDNSTokenValue1", - "/properties/DkimDNSTokenValue2", - "/properties/DkimDNSTokenValue3" - ], - "required": [ - "EmailIdentity" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "typeName": "AWS::SES::EmailIdentity", - "writeOnlyProperties": [ - "/properties/DkimSigningAttributes/DomainSigningSelector", - "/properties/DkimSigningAttributes/DomainSigningPrivateKey" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EmailIdentity" + ], + "definitions": { + "ConfigurationSetAttributes": { + "additionalProperties": false, + "description": "Used to associate a configuration set with an email identity.", + "properties": { + "ConfigurationSetName": { + "description": "The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.", + "type": "string" + } + }, + "type": "object" + }, + "DkimAttributes": { + "additionalProperties": false, + "description": "Used to enable or disable DKIM authentication for an email identity.", + "properties": { + "SigningEnabled": { + "description": "Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.", + "type": "boolean" + } + }, + "type": "object" + }, + "DkimSigningAttributes": { + "additionalProperties": false, + "description": "If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.", + "properties": { + "DomainSigningPrivateKey": { + "description": "[Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.", + "type": "string" + }, + "DomainSigningSelector": { + "description": "[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.", + "type": "string" + }, + "NextSigningKeyLength": { + "description": "[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.", + "pattern": "RSA_1024_BIT|RSA_2048_BIT", + "type": "string" + } + }, + "type": "object" + }, + "FeedbackAttributes": { + "additionalProperties": false, + "description": "Used to enable or disable feedback forwarding for an identity.", + "properties": { + "EmailForwardingEnabled": { + "description": "If the value is true, you receive email notifications when bounce or complaint events occur", + "type": "boolean" + } + }, + "type": "object" + }, + "MailFromAttributes": { + "additionalProperties": false, + "description": "Used to enable or disable the custom Mail-From domain configuration for an email identity.", + "properties": { + "BehaviorOnMxFailure": { + "description": "The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.", + "pattern": "USE_DEFAULT_VALUE|REJECT_MESSAGE", + "type": "string" + }, + "MailFromDomain": { + "description": "The custom MAIL FROM domain that you want the verified identity to use", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::EmailIdentity", + "handlers": { + "create": { + "permissions": [ + "ses:CreateEmailIdentity", + "ses:PutEmailIdentityMailFromAttributes", + "ses:PutEmailIdentityFeedbackAttributes", + "ses:PutEmailIdentityDkimAttributes", + "ses:GetEmailIdentity" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteEmailIdentity" + ] + }, + "list": { + "permissions": [ + "ses:ListEmailIdentities" + ] + }, + "read": { + "permissions": [ + "ses:GetEmailIdentity" + ] + }, + "update": { + "permissions": [ + "ses:PutEmailIdentityMailFromAttributes", + "ses:PutEmailIdentityFeedbackAttributes", + "ses:PutEmailIdentityConfigurationSetAttributes", + "ses:PutEmailIdentityDkimSigningAttributes", + "ses:PutEmailIdentityDkimAttributes", + "ses:GetEmailIdentity" + ] + } + }, + "primaryIdentifier": [ + "/properties/EmailIdentity" + ], + "properties": { + "ConfigurationSetAttributes": { + "$ref": "#/definitions/ConfigurationSetAttributes" + }, + "DkimAttributes": { + "$ref": "#/definitions/DkimAttributes" + }, + "DkimDNSTokenName1": { + "type": "string" + }, + "DkimDNSTokenName2": { + "type": "string" + }, + "DkimDNSTokenName3": { + "type": "string" + }, + "DkimDNSTokenValue1": { + "type": "string" + }, + "DkimDNSTokenValue2": { + "type": "string" + }, + "DkimDNSTokenValue3": { + "type": "string" + }, + "DkimSigningAttributes": { + "$ref": "#/definitions/DkimSigningAttributes" + }, + "EmailIdentity": { + "description": "The email address or domain to verify.", + "type": "string" + }, + "FeedbackAttributes": { + "$ref": "#/definitions/FeedbackAttributes" + }, + "MailFromAttributes": { + "$ref": "#/definitions/MailFromAttributes" + } + }, + "readOnlyProperties": [ + "/properties/DkimDNSTokenName1", + "/properties/DkimDNSTokenName2", + "/properties/DkimDNSTokenName3", + "/properties/DkimDNSTokenValue1", + "/properties/DkimDNSTokenValue2", + "/properties/DkimDNSTokenValue3" + ], + "required": [ + "EmailIdentity" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "typeName": "AWS::SES::EmailIdentity", + "writeOnlyProperties": [ + "/properties/DkimSigningAttributes/DomainSigningSelector", + "/properties/DkimSigningAttributes/DomainSigningPrivateKey" + ] +} diff --git a/schema/aws-ses-mailmanageraddoninstance.json b/schema/aws-ses-mailmanageraddoninstance.json index fa1624e..8b11952 100644 --- a/schema/aws-ses-mailmanageraddoninstance.json +++ b/schema/aws-ses-mailmanageraddoninstance.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AddonSubscriptionId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerAddonInstance Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetAddonInstance", - "ses:CreateAddonInstance" - ] - }, - "delete": { - "permissions": [ - "ses:GetAddonInstance", - "ses:DeleteAddonInstance" - ] - }, - "list": { - "permissions": [ - "ses:ListAddonInstances" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetAddonInstance" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetAddonInstance" - ] - } - }, - "primaryIdentifier": [ - "/properties/AddonInstanceId" - ], - "properties": { - "AddonInstanceArn": { - "type": "string" - }, - "AddonInstanceId": { - "maxLength": 67, - "minLength": 4, - "pattern": "^ai-[a-zA-Z0-9]{1,64}$", - "type": "string" - }, - "AddonName": { - "type": "string" - }, - "AddonSubscriptionId": { - "maxLength": 67, - "minLength": 4, - "pattern": "^as-[a-zA-Z0-9]{1,64}$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AddonInstanceArn", - "/properties/AddonInstanceId", - "/properties/AddonName" - ], - "required": [ - "AddonSubscriptionId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerAddonInstance" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AddonSubscriptionId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerAddonInstance Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetAddonInstance", + "ses:CreateAddonInstance" + ] + }, + "delete": { + "permissions": [ + "ses:GetAddonInstance", + "ses:DeleteAddonInstance" + ] + }, + "list": { + "permissions": [ + "ses:ListAddonInstances" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetAddonInstance" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetAddonInstance" + ] + } + }, + "primaryIdentifier": [ + "/properties/AddonInstanceId" + ], + "properties": { + "AddonInstanceArn": { + "type": "string" + }, + "AddonInstanceId": { + "maxLength": 67, + "minLength": 4, + "pattern": "^ai-[a-zA-Z0-9]{1,64}$", + "type": "string" + }, + "AddonName": { + "type": "string" + }, + "AddonSubscriptionId": { + "maxLength": 67, + "minLength": 4, + "pattern": "^as-[a-zA-Z0-9]{1,64}$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AddonInstanceArn", + "/properties/AddonInstanceId", + "/properties/AddonName" + ], + "required": [ + "AddonSubscriptionId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerAddonInstance" +} diff --git a/schema/aws-ses-mailmanageraddonsubscription.json b/schema/aws-ses-mailmanageraddonsubscription.json index babdb87..9c4d7b5 100644 --- a/schema/aws-ses-mailmanageraddonsubscription.json +++ b/schema/aws-ses-mailmanageraddonsubscription.json @@ -1,111 +1,111 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AddonName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerAddonSubscription Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetAddonSubscription", - "ses:CreateAddonSubscription" - ] - }, - "delete": { - "permissions": [ - "ses:GetAddonSubscription", - "ses:DeleteAddonSubscription" - ] - }, - "list": { - "permissions": [ - "ses:ListAddonSubscriptions" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetAddonSubscription" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetAddonSubscription" - ] - } - }, - "primaryIdentifier": [ - "/properties/AddonSubscriptionId" - ], - "properties": { - "AddonName": { - "type": "string" - }, - "AddonSubscriptionArn": { - "type": "string" - }, - "AddonSubscriptionId": { - "maxLength": 67, - "minLength": 4, - "pattern": "^as-[a-zA-Z0-9]{1,64}$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AddonSubscriptionArn", - "/properties/AddonSubscriptionId" - ], - "required": [ - "AddonName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerAddonSubscription" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AddonName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerAddonSubscription Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetAddonSubscription", + "ses:CreateAddonSubscription" + ] + }, + "delete": { + "permissions": [ + "ses:GetAddonSubscription", + "ses:DeleteAddonSubscription" + ] + }, + "list": { + "permissions": [ + "ses:ListAddonSubscriptions" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetAddonSubscription" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetAddonSubscription" + ] + } + }, + "primaryIdentifier": [ + "/properties/AddonSubscriptionId" + ], + "properties": { + "AddonName": { + "type": "string" + }, + "AddonSubscriptionArn": { + "type": "string" + }, + "AddonSubscriptionId": { + "maxLength": 67, + "minLength": 4, + "pattern": "^as-[a-zA-Z0-9]{1,64}$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AddonSubscriptionArn", + "/properties/AddonSubscriptionId" + ], + "required": [ + "AddonName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerAddonSubscription" +} diff --git a/schema/aws-ses-mailmanagerarchive.json b/schema/aws-ses-mailmanagerarchive.json index 5e94cfe..8f8638e 100644 --- a/schema/aws-ses-mailmanagerarchive.json +++ b/schema/aws-ses-mailmanagerarchive.json @@ -1,170 +1,170 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyArn" - ], - "definitions": { - "ArchiveRetention": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "RetentionPeriod": { - "$ref": "#/definitions/RetentionPeriod" - } - }, - "required": [ - "RetentionPeriod" - ], - "title": "RetentionPeriod", - "type": "object" - } - ] - }, - "ArchiveState": { - "enum": [ - "ACTIVE", - "PENDING_DELETION" - ], - "type": "string" - }, - "RetentionPeriod": { - "enum": [ - "THREE_MONTHS", - "SIX_MONTHS", - "NINE_MONTHS", - "ONE_YEAR", - "EIGHTEEN_MONTHS", - "TWO_YEARS", - "THIRTY_MONTHS", - "THREE_YEARS", - "FOUR_YEARS", - "FIVE_YEARS", - "SIX_YEARS", - "SEVEN_YEARS", - "EIGHT_YEARS", - "NINE_YEARS", - "TEN_YEARS", - "PERMANENT" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerArchive Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetArchive", - "ses:CreateArchive", - "kms:DescribeKey", - "kms:Decrypt", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "ses:GetArchive", - "ses:DeleteArchive" - ] - }, - "list": { - "permissions": [ - "ses:ListArchives" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetArchive" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetArchive", - "ses:UpdateArchive" - ] - } - }, - "primaryIdentifier": [ - "/properties/ArchiveId" - ], - "properties": { - "ArchiveArn": { - "type": "string" - }, - "ArchiveId": { - "maxLength": 66, - "minLength": 1, - "type": "string" - }, - "ArchiveName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$", - "type": "string" - }, - "ArchiveState": { - "$ref": "#/definitions/ArchiveState" - }, - "KmsKeyArn": { - "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$", - "type": "string" - }, - "Retention": { - "$ref": "#/definitions/ArchiveRetention" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ArchiveArn", - "/properties/ArchiveId", - "/properties/ArchiveState" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerArchive" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn" + ], + "definitions": { + "ArchiveRetention": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "RetentionPeriod": { + "$ref": "#/definitions/RetentionPeriod" + } + }, + "required": [ + "RetentionPeriod" + ], + "title": "RetentionPeriod", + "type": "object" + } + ] + }, + "ArchiveState": { + "enum": [ + "ACTIVE", + "PENDING_DELETION" + ], + "type": "string" + }, + "RetentionPeriod": { + "enum": [ + "THREE_MONTHS", + "SIX_MONTHS", + "NINE_MONTHS", + "ONE_YEAR", + "EIGHTEEN_MONTHS", + "TWO_YEARS", + "THIRTY_MONTHS", + "THREE_YEARS", + "FOUR_YEARS", + "FIVE_YEARS", + "SIX_YEARS", + "SEVEN_YEARS", + "EIGHT_YEARS", + "NINE_YEARS", + "TEN_YEARS", + "PERMANENT" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerArchive Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetArchive", + "ses:CreateArchive", + "kms:DescribeKey", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "ses:GetArchive", + "ses:DeleteArchive" + ] + }, + "list": { + "permissions": [ + "ses:ListArchives" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetArchive" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetArchive", + "ses:UpdateArchive" + ] + } + }, + "primaryIdentifier": [ + "/properties/ArchiveId" + ], + "properties": { + "ArchiveArn": { + "type": "string" + }, + "ArchiveId": { + "maxLength": 66, + "minLength": 1, + "type": "string" + }, + "ArchiveName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$", + "type": "string" + }, + "ArchiveState": { + "$ref": "#/definitions/ArchiveState" + }, + "KmsKeyArn": { + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$", + "type": "string" + }, + "Retention": { + "$ref": "#/definitions/ArchiveRetention" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ArchiveArn", + "/properties/ArchiveId", + "/properties/ArchiveState" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerArchive" +} diff --git a/schema/aws-ses-mailmanageringresspoint.json b/schema/aws-ses-mailmanageringresspoint.json index 1fbbebc..2ae891f 100644 --- a/schema/aws-ses-mailmanageringresspoint.json +++ b/schema/aws-ses-mailmanageringresspoint.json @@ -1,206 +1,206 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Type" - ], - "definitions": { - "IngressPointConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "SmtpPassword": { - "maxLength": 64, - "minLength": 8, - "pattern": "^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", - "type": "string" - } - }, - "required": [ - "SmtpPassword" - ], - "title": "SmtpPassword", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "SecretArn": { - "pattern": "^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$", - "type": "string" - } - }, - "required": [ - "SecretArn" - ], - "title": "SecretArn", - "type": "object" - } - ] - }, - "IngressPointStatus": { - "enum": [ - "PROVISIONING", - "DEPROVISIONING", - "UPDATING", - "ACTIVE", - "CLOSED", - "FAILED" - ], - "type": "string" - }, - "IngressPointStatusToUpdate": { - "enum": [ - "ACTIVE", - "CLOSED" - ], - "type": "string" - }, - "IngressPointType": { - "enum": [ - "OPEN", - "AUTH" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerIngressPoint Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetIngressPoint", - "ses:CreateIngressPoint", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "ses:GetIngressPoint", - "ses:DeleteIngressPoint" - ] - }, - "list": { - "permissions": [ - "ses:ListIngressPoints" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetIngressPoint" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetIngressPoint", - "ses:UpdateIngressPoint" - ] - } - }, - "primaryIdentifier": [ - "/properties/IngressPointId" - ], - "properties": { - "ARecord": { - "type": "string" - }, - "IngressPointArn": { - "type": "string" - }, - "IngressPointConfiguration": { - "$ref": "#/definitions/IngressPointConfiguration" - }, - "IngressPointId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "IngressPointName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[A-Za-z0-9_\\-]+$", - "type": "string" - }, - "RuleSetId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Status": { - "$ref": "#/definitions/IngressPointStatus" - }, - "StatusToUpdate": { - "$ref": "#/definitions/IngressPointStatusToUpdate" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrafficPolicyId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "Type": { - "$ref": "#/definitions/IngressPointType" - } - }, - "readOnlyProperties": [ - "/properties/IngressPointId", - "/properties/IngressPointArn", - "/properties/Status", - "/properties/ARecord" - ], - "required": [ - "Type", - "TrafficPolicyId", - "RuleSetId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerIngressPoint", - "writeOnlyProperties": [ - "/properties/IngressPointConfiguration" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type" + ], + "definitions": { + "IngressPointConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SmtpPassword": { + "maxLength": 64, + "minLength": 8, + "pattern": "^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", + "type": "string" + } + }, + "required": [ + "SmtpPassword" + ], + "title": "SmtpPassword", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "SecretArn": { + "pattern": "^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$", + "type": "string" + } + }, + "required": [ + "SecretArn" + ], + "title": "SecretArn", + "type": "object" + } + ] + }, + "IngressPointStatus": { + "enum": [ + "PROVISIONING", + "DEPROVISIONING", + "UPDATING", + "ACTIVE", + "CLOSED", + "FAILED" + ], + "type": "string" + }, + "IngressPointStatusToUpdate": { + "enum": [ + "ACTIVE", + "CLOSED" + ], + "type": "string" + }, + "IngressPointType": { + "enum": [ + "OPEN", + "AUTH" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerIngressPoint Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetIngressPoint", + "ses:CreateIngressPoint", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ses:GetIngressPoint", + "ses:DeleteIngressPoint" + ] + }, + "list": { + "permissions": [ + "ses:ListIngressPoints" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetIngressPoint" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetIngressPoint", + "ses:UpdateIngressPoint" + ] + } + }, + "primaryIdentifier": [ + "/properties/IngressPointId" + ], + "properties": { + "ARecord": { + "type": "string" + }, + "IngressPointArn": { + "type": "string" + }, + "IngressPointConfiguration": { + "$ref": "#/definitions/IngressPointConfiguration" + }, + "IngressPointId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "IngressPointName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9_\\-]+$", + "type": "string" + }, + "RuleSetId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Status": { + "$ref": "#/definitions/IngressPointStatus" + }, + "StatusToUpdate": { + "$ref": "#/definitions/IngressPointStatusToUpdate" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrafficPolicyId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/IngressPointType" + } + }, + "readOnlyProperties": [ + "/properties/IngressPointId", + "/properties/IngressPointArn", + "/properties/Status", + "/properties/ARecord" + ], + "required": [ + "Type", + "TrafficPolicyId", + "RuleSetId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerIngressPoint", + "writeOnlyProperties": [ + "/properties/IngressPointConfiguration" + ] +} diff --git a/schema/aws-ses-mailmanagerrelay.json b/schema/aws-ses-mailmanagerrelay.json index 9c6d2b7..082bcd2 100644 --- a/schema/aws-ses-mailmanagerrelay.json +++ b/schema/aws-ses-mailmanagerrelay.json @@ -1,163 +1,163 @@ -{ - "additionalProperties": false, - "definitions": { - "NoAuthentication": { - "additionalProperties": false, - "type": "object" - }, - "RelayAuthentication": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "SecretArn": { - "pattern": "^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$", - "type": "string" - } - }, - "required": [ - "SecretArn" - ], - "title": "SecretArn", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "NoAuthentication": { - "$ref": "#/definitions/NoAuthentication" - } - }, - "required": [ - "NoAuthentication" - ], - "title": "NoAuthentication", - "type": "object" - } - ] - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerRelay Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetRelay", - "ses:CreateRelay" - ] - }, - "delete": { - "permissions": [ - "ses:GetRelay", - "ses:DeleteRelay" - ] - }, - "list": { - "permissions": [ - "ses:ListRelays" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetRelay" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetRelay", - "ses:UpdateRelay" - ] - } - }, - "primaryIdentifier": [ - "/properties/RelayId" - ], - "properties": { - "Authentication": { - "$ref": "#/definitions/RelayAuthentication" - }, - "RelayArn": { - "type": "string" - }, - "RelayId": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "RelayName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_]+$", - "type": "string" - }, - "ServerName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-\\.]+$", - "type": "string" - }, - "ServerPort": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RelayArn", - "/properties/RelayId" - ], - "required": [ - "Authentication", - "ServerName", - "ServerPort" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerRelay" -} +{ + "additionalProperties": false, + "definitions": { + "NoAuthentication": { + "additionalProperties": false, + "type": "object" + }, + "RelayAuthentication": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "SecretArn": { + "pattern": "^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$", + "type": "string" + } + }, + "required": [ + "SecretArn" + ], + "title": "SecretArn", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "NoAuthentication": { + "$ref": "#/definitions/NoAuthentication" + } + }, + "required": [ + "NoAuthentication" + ], + "title": "NoAuthentication", + "type": "object" + } + ] + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerRelay Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetRelay", + "ses:CreateRelay" + ] + }, + "delete": { + "permissions": [ + "ses:GetRelay", + "ses:DeleteRelay" + ] + }, + "list": { + "permissions": [ + "ses:ListRelays" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetRelay" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetRelay", + "ses:UpdateRelay" + ] + } + }, + "primaryIdentifier": [ + "/properties/RelayId" + ], + "properties": { + "Authentication": { + "$ref": "#/definitions/RelayAuthentication" + }, + "RelayArn": { + "type": "string" + }, + "RelayId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "RelayName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string" + }, + "ServerName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-\\.]+$", + "type": "string" + }, + "ServerPort": { + "maximum": 65535, + "minimum": 1, + "type": "number" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RelayArn", + "/properties/RelayId" + ], + "required": [ + "Authentication", + "ServerName", + "ServerPort" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerRelay" +} diff --git a/schema/aws-ses-mailmanagerruleset.json b/schema/aws-ses-mailmanagerruleset.json index e2324cb..4ae3acc 100644 --- a/schema/aws-ses-mailmanagerruleset.json +++ b/schema/aws-ses-mailmanagerruleset.json @@ -1,885 +1,885 @@ -{ - "additionalProperties": false, - "definitions": { - "ActionFailurePolicy": { - "enum": [ - "CONTINUE", - "DROP" - ], - "type": "string" - }, - "AddHeaderAction": { - "additionalProperties": false, - "properties": { - "HeaderName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[xX]\\-[a-zA-Z0-9\\-]+$", - "type": "string" - }, - "HeaderValue": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "HeaderName", - "HeaderValue" - ], - "type": "object" - }, - "Analysis": { - "additionalProperties": false, - "properties": { - "Analyzer": { - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - }, - "ResultField": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[\\sa-zA-Z0-9_]+$", - "type": "string" - } - }, - "required": [ - "Analyzer", - "ResultField" - ], - "type": "object" - }, - "ArchiveAction": { - "additionalProperties": false, - "properties": { - "ActionFailurePolicy": { - "$ref": "#/definitions/ActionFailurePolicy" - }, - "TargetArchive": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - } - }, - "required": [ - "TargetArchive" - ], - "type": "object" - }, - "DeliverToMailboxAction": { - "additionalProperties": false, - "properties": { - "ActionFailurePolicy": { - "$ref": "#/definitions/ActionFailurePolicy" - }, - "MailboxArn": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - } - }, - "required": [ - "MailboxArn", - "RoleArn" - ], - "type": "object" - }, - "DropAction": { - "additionalProperties": false, - "type": "object" - }, - "MailFrom": { - "enum": [ - "REPLACE", - "PRESERVE" - ], - "type": "string" - }, - "RelayAction": { - "additionalProperties": false, - "properties": { - "ActionFailurePolicy": { - "$ref": "#/definitions/ActionFailurePolicy" - }, - "MailFrom": { - "$ref": "#/definitions/MailFrom" - }, - "Relay": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - } - }, - "required": [ - "Relay" - ], - "type": "object" - }, - "ReplaceRecipientAction": { - "additionalProperties": false, - "properties": { - "ReplaceWith": { - "items": { - "maxLength": 254, - "minLength": 0, - "pattern": "^[0-9A-Za-z@+.-]+$", - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/RuleAction" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "Conditions": { - "items": { - "$ref": "#/definitions/RuleCondition" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Name": { - "maxLength": 32, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "Unless": { - "items": { - "$ref": "#/definitions/RuleCondition" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "RuleAction": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Drop": { - "$ref": "#/definitions/DropAction" - } - }, - "required": [ - "Drop" - ], - "title": "Drop", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Relay": { - "$ref": "#/definitions/RelayAction" - } - }, - "required": [ - "Relay" - ], - "title": "Relay", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Archive": { - "$ref": "#/definitions/ArchiveAction" - } - }, - "required": [ - "Archive" - ], - "title": "Archive", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "WriteToS3": { - "$ref": "#/definitions/S3Action" - } - }, - "required": [ - "WriteToS3" - ], - "title": "WriteToS3", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Send": { - "$ref": "#/definitions/SendAction" - } - }, - "required": [ - "Send" - ], - "title": "Send", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "AddHeader": { - "$ref": "#/definitions/AddHeaderAction" - } - }, - "required": [ - "AddHeader" - ], - "title": "AddHeader", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "ReplaceRecipient": { - "$ref": "#/definitions/ReplaceRecipientAction" - } - }, - "required": [ - "ReplaceRecipient" - ], - "title": "ReplaceRecipient", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "DeliverToMailbox": { - "$ref": "#/definitions/DeliverToMailboxAction" - } - }, - "required": [ - "DeliverToMailbox" - ], - "title": "DeliverToMailbox", - "type": "object" - } - ] - }, - "RuleBooleanEmailAttribute": { - "enum": [ - "READ_RECEIPT_REQUESTED", - "TLS", - "TLS_WRAPPED" - ], - "type": "string" - }, - "RuleBooleanExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/RuleBooleanToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/RuleBooleanOperator" - } - }, - "required": [ - "Evaluate", - "Operator" - ], - "type": "object" - }, - "RuleBooleanOperator": { - "enum": [ - "IS_TRUE", - "IS_FALSE" - ], - "type": "string" - }, - "RuleBooleanToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/RuleBooleanEmailAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "RuleCondition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "BooleanExpression": { - "$ref": "#/definitions/RuleBooleanExpression" - } - }, - "required": [ - "BooleanExpression" - ], - "title": "BooleanExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "StringExpression": { - "$ref": "#/definitions/RuleStringExpression" - } - }, - "required": [ - "StringExpression" - ], - "title": "StringExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "NumberExpression": { - "$ref": "#/definitions/RuleNumberExpression" - } - }, - "required": [ - "NumberExpression" - ], - "title": "NumberExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "IpExpression": { - "$ref": "#/definitions/RuleIpExpression" - } - }, - "required": [ - "IpExpression" - ], - "title": "IpExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "VerdictExpression": { - "$ref": "#/definitions/RuleVerdictExpression" - } - }, - "required": [ - "VerdictExpression" - ], - "title": "VerdictExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "DmarcExpression": { - "$ref": "#/definitions/RuleDmarcExpression" - } - }, - "required": [ - "DmarcExpression" - ], - "title": "DmarcExpression", - "type": "object" - } - ] - }, - "RuleDmarcExpression": { - "additionalProperties": false, - "properties": { - "Operator": { - "$ref": "#/definitions/RuleDmarcOperator" - }, - "Values": { - "items": { - "$ref": "#/definitions/RuleDmarcPolicy" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Operator", - "Values" - ], - "type": "object" - }, - "RuleDmarcOperator": { - "enum": [ - "EQUALS", - "NOT_EQUALS" - ], - "type": "string" - }, - "RuleDmarcPolicy": { - "enum": [ - "NONE", - "QUARANTINE", - "REJECT" - ], - "type": "string" - }, - "RuleIpEmailAttribute": { - "enum": [ - "SOURCE_IP" - ], - "type": "string" - }, - "RuleIpExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/RuleIpToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/RuleIpOperator" - }, - "Values": { - "items": { - "maxLength": 18, - "minLength": 1, - "pattern": "^(([0-9]|.|/)*)$", - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Evaluate", - "Operator", - "Values" - ], - "type": "object" - }, - "RuleIpOperator": { - "enum": [ - "CIDR_MATCHES", - "NOT_CIDR_MATCHES" - ], - "type": "string" - }, - "RuleIpToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/RuleIpEmailAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "RuleNumberEmailAttribute": { - "enum": [ - "MESSAGE_SIZE" - ], - "type": "string" - }, - "RuleNumberExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/RuleNumberToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/RuleNumberOperator" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Evaluate", - "Operator", - "Value" - ], - "type": "object" - }, - "RuleNumberOperator": { - "enum": [ - "EQUALS", - "NOT_EQUALS", - "LESS_THAN", - "GREATER_THAN", - "LESS_THAN_OR_EQUAL", - "GREATER_THAN_OR_EQUAL" - ], - "type": "string" - }, - "RuleNumberToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/RuleNumberEmailAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "RuleStringEmailAttribute": { - "enum": [ - "MAIL_FROM", - "HELO", - "RECIPIENT", - "SENDER", - "FROM", - "SUBJECT", - "TO", - "CC" - ], - "type": "string" - }, - "RuleStringExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/RuleStringToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/RuleStringOperator" - }, - "Values": { - "items": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Evaluate", - "Operator", - "Values" - ], - "type": "object" - }, - "RuleStringOperator": { - "enum": [ - "EQUALS", - "NOT_EQUALS", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" - ], - "type": "string" - }, - "RuleStringToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/RuleStringEmailAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "RuleVerdict": { - "enum": [ - "PASS", - "FAIL", - "GRAY", - "PROCESSING_FAILED" - ], - "type": "string" - }, - "RuleVerdictAttribute": { - "enum": [ - "SPF", - "DKIM" - ], - "type": "string" - }, - "RuleVerdictExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/RuleVerdictToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/RuleVerdictOperator" - }, - "Values": { - "items": { - "$ref": "#/definitions/RuleVerdict" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Evaluate", - "Operator", - "Values" - ], - "type": "object" - }, - "RuleVerdictOperator": { - "enum": [ - "EQUALS", - "NOT_EQUALS" - ], - "type": "string" - }, - "RuleVerdictToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/RuleVerdictAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Analysis": { - "$ref": "#/definitions/Analysis" - } - }, - "required": [ - "Analysis" - ], - "title": "Analysis", - "type": "object" - } - ] - }, - "S3Action": { - "additionalProperties": false, - "properties": { - "ActionFailurePolicy": { - "$ref": "#/definitions/ActionFailurePolicy" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - }, - "S3Bucket": { - "maxLength": 62, - "minLength": 1, - "pattern": "^[a-zA-Z0-9.-]+$", - "type": "string" - }, - "S3Prefix": { - "maxLength": 62, - "minLength": 1, - "pattern": "^[a-zA-Z0-9!_.*'()/-]+$", - "type": "string" - }, - "S3SseKmsKeyId": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^[a-zA-Z0-9-:/]+$", - "type": "string" - } - }, - "required": [ - "RoleArn", - "S3Bucket" - ], - "type": "object" - }, - "SendAction": { - "additionalProperties": false, - "properties": { - "ActionFailurePolicy": { - "$ref": "#/definitions/ActionFailurePolicy" - }, - "RoleArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerRuleSet Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetRuleSet", - "ses:CreateRuleSet" - ] - }, - "delete": { - "permissions": [ - "ses:GetRuleSet", - "ses:DeleteRuleSet" - ] - }, - "list": { - "permissions": [ - "ses:ListRuleSets" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetRuleSet" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetRuleSet", - "ses:UpdateRuleSet" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleSetId" - ], - "properties": { - "RuleSetArn": { - "type": "string" - }, - "RuleSetId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "RuleSetName": { - "maxLength": 100, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_.-]+$", - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/Rule" - }, - "maxItems": 40, - "minItems": 0, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/RuleSetArn", - "/properties/RuleSetId" - ], - "required": [ - "Rules" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerRuleSet" -} +{ + "additionalProperties": false, + "definitions": { + "ActionFailurePolicy": { + "enum": [ + "CONTINUE", + "DROP" + ], + "type": "string" + }, + "AddHeaderAction": { + "additionalProperties": false, + "properties": { + "HeaderName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[xX]\\-[a-zA-Z0-9\\-]+$", + "type": "string" + }, + "HeaderValue": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "HeaderName", + "HeaderValue" + ], + "type": "object" + }, + "Analysis": { + "additionalProperties": false, + "properties": { + "Analyzer": { + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + }, + "ResultField": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[\\sa-zA-Z0-9_]+$", + "type": "string" + } + }, + "required": [ + "Analyzer", + "ResultField" + ], + "type": "object" + }, + "ArchiveAction": { + "additionalProperties": false, + "properties": { + "ActionFailurePolicy": { + "$ref": "#/definitions/ActionFailurePolicy" + }, + "TargetArchive": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + } + }, + "required": [ + "TargetArchive" + ], + "type": "object" + }, + "DeliverToMailboxAction": { + "additionalProperties": false, + "properties": { + "ActionFailurePolicy": { + "$ref": "#/definitions/ActionFailurePolicy" + }, + "MailboxArn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + } + }, + "required": [ + "MailboxArn", + "RoleArn" + ], + "type": "object" + }, + "DropAction": { + "additionalProperties": false, + "type": "object" + }, + "MailFrom": { + "enum": [ + "REPLACE", + "PRESERVE" + ], + "type": "string" + }, + "RelayAction": { + "additionalProperties": false, + "properties": { + "ActionFailurePolicy": { + "$ref": "#/definitions/ActionFailurePolicy" + }, + "MailFrom": { + "$ref": "#/definitions/MailFrom" + }, + "Relay": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + } + }, + "required": [ + "Relay" + ], + "type": "object" + }, + "ReplaceRecipientAction": { + "additionalProperties": false, + "properties": { + "ReplaceWith": { + "items": { + "maxLength": 254, + "minLength": 0, + "pattern": "^[0-9A-Za-z@+.-]+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/RuleAction" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Conditions": { + "items": { + "$ref": "#/definitions/RuleCondition" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Name": { + "maxLength": 32, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "Unless": { + "items": { + "$ref": "#/definitions/RuleCondition" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Actions" + ], + "type": "object" + }, + "RuleAction": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Drop": { + "$ref": "#/definitions/DropAction" + } + }, + "required": [ + "Drop" + ], + "title": "Drop", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Relay": { + "$ref": "#/definitions/RelayAction" + } + }, + "required": [ + "Relay" + ], + "title": "Relay", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Archive": { + "$ref": "#/definitions/ArchiveAction" + } + }, + "required": [ + "Archive" + ], + "title": "Archive", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "WriteToS3": { + "$ref": "#/definitions/S3Action" + } + }, + "required": [ + "WriteToS3" + ], + "title": "WriteToS3", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Send": { + "$ref": "#/definitions/SendAction" + } + }, + "required": [ + "Send" + ], + "title": "Send", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "AddHeader": { + "$ref": "#/definitions/AddHeaderAction" + } + }, + "required": [ + "AddHeader" + ], + "title": "AddHeader", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ReplaceRecipient": { + "$ref": "#/definitions/ReplaceRecipientAction" + } + }, + "required": [ + "ReplaceRecipient" + ], + "title": "ReplaceRecipient", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "DeliverToMailbox": { + "$ref": "#/definitions/DeliverToMailboxAction" + } + }, + "required": [ + "DeliverToMailbox" + ], + "title": "DeliverToMailbox", + "type": "object" + } + ] + }, + "RuleBooleanEmailAttribute": { + "enum": [ + "READ_RECEIPT_REQUESTED", + "TLS", + "TLS_WRAPPED" + ], + "type": "string" + }, + "RuleBooleanExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/RuleBooleanToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/RuleBooleanOperator" + } + }, + "required": [ + "Evaluate", + "Operator" + ], + "type": "object" + }, + "RuleBooleanOperator": { + "enum": [ + "IS_TRUE", + "IS_FALSE" + ], + "type": "string" + }, + "RuleBooleanToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/RuleBooleanEmailAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "RuleCondition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "BooleanExpression": { + "$ref": "#/definitions/RuleBooleanExpression" + } + }, + "required": [ + "BooleanExpression" + ], + "title": "BooleanExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "StringExpression": { + "$ref": "#/definitions/RuleStringExpression" + } + }, + "required": [ + "StringExpression" + ], + "title": "StringExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "NumberExpression": { + "$ref": "#/definitions/RuleNumberExpression" + } + }, + "required": [ + "NumberExpression" + ], + "title": "NumberExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "IpExpression": { + "$ref": "#/definitions/RuleIpExpression" + } + }, + "required": [ + "IpExpression" + ], + "title": "IpExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "VerdictExpression": { + "$ref": "#/definitions/RuleVerdictExpression" + } + }, + "required": [ + "VerdictExpression" + ], + "title": "VerdictExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "DmarcExpression": { + "$ref": "#/definitions/RuleDmarcExpression" + } + }, + "required": [ + "DmarcExpression" + ], + "title": "DmarcExpression", + "type": "object" + } + ] + }, + "RuleDmarcExpression": { + "additionalProperties": false, + "properties": { + "Operator": { + "$ref": "#/definitions/RuleDmarcOperator" + }, + "Values": { + "items": { + "$ref": "#/definitions/RuleDmarcPolicy" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Operator", + "Values" + ], + "type": "object" + }, + "RuleDmarcOperator": { + "enum": [ + "EQUALS", + "NOT_EQUALS" + ], + "type": "string" + }, + "RuleDmarcPolicy": { + "enum": [ + "NONE", + "QUARANTINE", + "REJECT" + ], + "type": "string" + }, + "RuleIpEmailAttribute": { + "enum": [ + "SOURCE_IP" + ], + "type": "string" + }, + "RuleIpExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/RuleIpToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/RuleIpOperator" + }, + "Values": { + "items": { + "maxLength": 18, + "minLength": 1, + "pattern": "^(([0-9]|.|/)*)$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Evaluate", + "Operator", + "Values" + ], + "type": "object" + }, + "RuleIpOperator": { + "enum": [ + "CIDR_MATCHES", + "NOT_CIDR_MATCHES" + ], + "type": "string" + }, + "RuleIpToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/RuleIpEmailAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "RuleNumberEmailAttribute": { + "enum": [ + "MESSAGE_SIZE" + ], + "type": "string" + }, + "RuleNumberExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/RuleNumberToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/RuleNumberOperator" + }, + "Value": { + "type": "number" + } + }, + "required": [ + "Evaluate", + "Operator", + "Value" + ], + "type": "object" + }, + "RuleNumberOperator": { + "enum": [ + "EQUALS", + "NOT_EQUALS", + "LESS_THAN", + "GREATER_THAN", + "LESS_THAN_OR_EQUAL", + "GREATER_THAN_OR_EQUAL" + ], + "type": "string" + }, + "RuleNumberToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/RuleNumberEmailAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "RuleStringEmailAttribute": { + "enum": [ + "MAIL_FROM", + "HELO", + "RECIPIENT", + "SENDER", + "FROM", + "SUBJECT", + "TO", + "CC" + ], + "type": "string" + }, + "RuleStringExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/RuleStringToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/RuleStringOperator" + }, + "Values": { + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Evaluate", + "Operator", + "Values" + ], + "type": "object" + }, + "RuleStringOperator": { + "enum": [ + "EQUALS", + "NOT_EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ], + "type": "string" + }, + "RuleStringToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/RuleStringEmailAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "RuleVerdict": { + "enum": [ + "PASS", + "FAIL", + "GRAY", + "PROCESSING_FAILED" + ], + "type": "string" + }, + "RuleVerdictAttribute": { + "enum": [ + "SPF", + "DKIM" + ], + "type": "string" + }, + "RuleVerdictExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/RuleVerdictToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/RuleVerdictOperator" + }, + "Values": { + "items": { + "$ref": "#/definitions/RuleVerdict" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Evaluate", + "Operator", + "Values" + ], + "type": "object" + }, + "RuleVerdictOperator": { + "enum": [ + "EQUALS", + "NOT_EQUALS" + ], + "type": "string" + }, + "RuleVerdictToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/RuleVerdictAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Analysis": { + "$ref": "#/definitions/Analysis" + } + }, + "required": [ + "Analysis" + ], + "title": "Analysis", + "type": "object" + } + ] + }, + "S3Action": { + "additionalProperties": false, + "properties": { + "ActionFailurePolicy": { + "$ref": "#/definitions/ActionFailurePolicy" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + }, + "S3Bucket": { + "maxLength": 62, + "minLength": 1, + "pattern": "^[a-zA-Z0-9.-]+$", + "type": "string" + }, + "S3Prefix": { + "maxLength": 62, + "minLength": 1, + "pattern": "^[a-zA-Z0-9!_.*'()/-]+$", + "type": "string" + }, + "S3SseKmsKeyId": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^[a-zA-Z0-9-:/]+$", + "type": "string" + } + }, + "required": [ + "RoleArn", + "S3Bucket" + ], + "type": "object" + }, + "SendAction": { + "additionalProperties": false, + "properties": { + "ActionFailurePolicy": { + "$ref": "#/definitions/ActionFailurePolicy" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerRuleSet Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetRuleSet", + "ses:CreateRuleSet" + ] + }, + "delete": { + "permissions": [ + "ses:GetRuleSet", + "ses:DeleteRuleSet" + ] + }, + "list": { + "permissions": [ + "ses:ListRuleSets" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetRuleSet" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetRuleSet", + "ses:UpdateRuleSet" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleSetId" + ], + "properties": { + "RuleSetArn": { + "type": "string" + }, + "RuleSetId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "RuleSetName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "Rules": { + "items": { + "$ref": "#/definitions/Rule" + }, + "maxItems": 40, + "minItems": 0, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/RuleSetArn", + "/properties/RuleSetId" + ], + "required": [ + "Rules" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerRuleSet" +} diff --git a/schema/aws-ses-mailmanagertrafficpolicy.json b/schema/aws-ses-mailmanagertrafficpolicy.json index 5179c69..5444782 100644 --- a/schema/aws-ses-mailmanagertrafficpolicy.json +++ b/schema/aws-ses-mailmanagertrafficpolicy.json @@ -1,435 +1,435 @@ -{ - "additionalProperties": false, - "definitions": { - "AcceptAction": { - "enum": [ - "ALLOW", - "DENY" - ], - "type": "string" - }, - "IngressAnalysis": { - "additionalProperties": false, - "properties": { - "Analyzer": { - "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", - "type": "string" - }, - "ResultField": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[\\sa-zA-Z0-9_]+$", - "type": "string" - } - }, - "required": [ - "Analyzer", - "ResultField" - ], - "type": "object" - }, - "IngressBooleanExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/IngressBooleanToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/IngressBooleanOperator" - } - }, - "required": [ - "Evaluate", - "Operator" - ], - "type": "object" - }, - "IngressBooleanOperator": { - "enum": [ - "IS_TRUE", - "IS_FALSE" - ], - "type": "string" - }, - "IngressBooleanToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Analysis": { - "$ref": "#/definitions/IngressAnalysis" - } - }, - "required": [ - "Analysis" - ], - "title": "Analysis", - "type": "object" - } - ] - }, - "IngressIpOperator": { - "enum": [ - "CIDR_MATCHES", - "NOT_CIDR_MATCHES" - ], - "type": "string" - }, - "IngressIpToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/IngressIpv4Attribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "IngressIpv4Attribute": { - "enum": [ - "SENDER_IP" - ], - "type": "string" - }, - "IngressIpv4Expression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/IngressIpToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/IngressIpOperator" - }, - "Values": { - "items": { - "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/([0-9]|[12][0-9]|3[0-2])$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Evaluate", - "Operator", - "Values" - ], - "type": "object" - }, - "IngressStringEmailAttribute": { - "enum": [ - "RECIPIENT" - ], - "type": "string" - }, - "IngressStringExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/IngressStringToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/IngressStringOperator" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Evaluate", - "Operator", - "Values" - ], - "type": "object" - }, - "IngressStringOperator": { - "enum": [ - "EQUALS", - "NOT_EQUALS", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" - ], - "type": "string" - }, - "IngressStringToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/IngressStringEmailAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "IngressTlsAttribute": { - "enum": [ - "TLS_PROTOCOL" - ], - "type": "string" - }, - "IngressTlsProtocolAttribute": { - "enum": [ - "TLS1_2", - "TLS1_3" - ], - "type": "string" - }, - "IngressTlsProtocolExpression": { - "additionalProperties": false, - "properties": { - "Evaluate": { - "$ref": "#/definitions/IngressTlsProtocolToEvaluate" - }, - "Operator": { - "$ref": "#/definitions/IngressTlsProtocolOperator" - }, - "Value": { - "$ref": "#/definitions/IngressTlsProtocolAttribute" - } - }, - "required": [ - "Evaluate", - "Operator", - "Value" - ], - "type": "object" - }, - "IngressTlsProtocolOperator": { - "enum": [ - "MINIMUM_TLS_VERSION", - "IS" - ], - "type": "string" - }, - "IngressTlsProtocolToEvaluate": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/IngressTlsAttribute" - } - }, - "required": [ - "Attribute" - ], - "title": "Attribute", - "type": "object" - } - ] - }, - "PolicyCondition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "StringExpression": { - "$ref": "#/definitions/IngressStringExpression" - } - }, - "required": [ - "StringExpression" - ], - "title": "StringExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "IpExpression": { - "$ref": "#/definitions/IngressIpv4Expression" - } - }, - "required": [ - "IpExpression" - ], - "title": "IpExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TlsExpression": { - "$ref": "#/definitions/IngressTlsProtocolExpression" - } - }, - "required": [ - "TlsExpression" - ], - "title": "TlsExpression", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "BooleanExpression": { - "$ref": "#/definitions/IngressBooleanExpression" - } - }, - "required": [ - "BooleanExpression" - ], - "title": "BooleanExpression", - "type": "object" - } - ] - }, - "PolicyStatement": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AcceptAction" - }, - "Conditions": { - "items": { - "$ref": "#/definitions/PolicyCondition" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Action", - "Conditions" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::SES::MailManagerTrafficPolicy Resource Type", - "handlers": { - "create": { - "permissions": [ - "ses:TagResource", - "ses:ListTagsForResource", - "ses:GetTrafficPolicy", - "ses:CreateTrafficPolicy" - ] - }, - "delete": { - "permissions": [ - "ses:GetTrafficPolicy", - "ses:DeleteTrafficPolicy" - ] - }, - "list": { - "permissions": [ - "ses:ListTrafficPolicies" - ] - }, - "read": { - "permissions": [ - "ses:ListTagsForResource", - "ses:GetTrafficPolicy" - ] - }, - "update": { - "permissions": [ - "ses:TagResource", - "ses:UntagResource", - "ses:ListTagsForResource", - "ses:GetTrafficPolicy", - "ses:UpdateTrafficPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrafficPolicyId" - ], - "properties": { - "DefaultAction": { - "$ref": "#/definitions/AcceptAction" - }, - "MaxMessageSizeBytes": { - "minimum": 1, - "type": "number" - }, - "PolicyStatements": { - "items": { - "$ref": "#/definitions/PolicyStatement" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrafficPolicyArn": { - "type": "string" - }, - "TrafficPolicyId": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "TrafficPolicyName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^[A-Za-z0-9_\\-]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TrafficPolicyArn", - "/properties/TrafficPolicyId" - ], - "required": [ - "DefaultAction", - "PolicyStatements" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", - "tagging": { - "cloudFormationSystemTags": true, - "permissions": [ - "ses:TagResource", - "ses:UntagResource" - ], - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SES::MailManagerTrafficPolicy" -} +{ + "additionalProperties": false, + "definitions": { + "AcceptAction": { + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "IngressAnalysis": { + "additionalProperties": false, + "properties": { + "Analyzer": { + "pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$", + "type": "string" + }, + "ResultField": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[\\sa-zA-Z0-9_]+$", + "type": "string" + } + }, + "required": [ + "Analyzer", + "ResultField" + ], + "type": "object" + }, + "IngressBooleanExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/IngressBooleanToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/IngressBooleanOperator" + } + }, + "required": [ + "Evaluate", + "Operator" + ], + "type": "object" + }, + "IngressBooleanOperator": { + "enum": [ + "IS_TRUE", + "IS_FALSE" + ], + "type": "string" + }, + "IngressBooleanToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Analysis": { + "$ref": "#/definitions/IngressAnalysis" + } + }, + "required": [ + "Analysis" + ], + "title": "Analysis", + "type": "object" + } + ] + }, + "IngressIpOperator": { + "enum": [ + "CIDR_MATCHES", + "NOT_CIDR_MATCHES" + ], + "type": "string" + }, + "IngressIpToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/IngressIpv4Attribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "IngressIpv4Attribute": { + "enum": [ + "SENDER_IP" + ], + "type": "string" + }, + "IngressIpv4Expression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/IngressIpToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/IngressIpOperator" + }, + "Values": { + "items": { + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/([0-9]|[12][0-9]|3[0-2])$", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Evaluate", + "Operator", + "Values" + ], + "type": "object" + }, + "IngressStringEmailAttribute": { + "enum": [ + "RECIPIENT" + ], + "type": "string" + }, + "IngressStringExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/IngressStringToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/IngressStringOperator" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Evaluate", + "Operator", + "Values" + ], + "type": "object" + }, + "IngressStringOperator": { + "enum": [ + "EQUALS", + "NOT_EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ], + "type": "string" + }, + "IngressStringToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/IngressStringEmailAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "IngressTlsAttribute": { + "enum": [ + "TLS_PROTOCOL" + ], + "type": "string" + }, + "IngressTlsProtocolAttribute": { + "enum": [ + "TLS1_2", + "TLS1_3" + ], + "type": "string" + }, + "IngressTlsProtocolExpression": { + "additionalProperties": false, + "properties": { + "Evaluate": { + "$ref": "#/definitions/IngressTlsProtocolToEvaluate" + }, + "Operator": { + "$ref": "#/definitions/IngressTlsProtocolOperator" + }, + "Value": { + "$ref": "#/definitions/IngressTlsProtocolAttribute" + } + }, + "required": [ + "Evaluate", + "Operator", + "Value" + ], + "type": "object" + }, + "IngressTlsProtocolOperator": { + "enum": [ + "MINIMUM_TLS_VERSION", + "IS" + ], + "type": "string" + }, + "IngressTlsProtocolToEvaluate": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Attribute": { + "$ref": "#/definitions/IngressTlsAttribute" + } + }, + "required": [ + "Attribute" + ], + "title": "Attribute", + "type": "object" + } + ] + }, + "PolicyCondition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "StringExpression": { + "$ref": "#/definitions/IngressStringExpression" + } + }, + "required": [ + "StringExpression" + ], + "title": "StringExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "IpExpression": { + "$ref": "#/definitions/IngressIpv4Expression" + } + }, + "required": [ + "IpExpression" + ], + "title": "IpExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TlsExpression": { + "$ref": "#/definitions/IngressTlsProtocolExpression" + } + }, + "required": [ + "TlsExpression" + ], + "title": "TlsExpression", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "BooleanExpression": { + "$ref": "#/definitions/IngressBooleanExpression" + } + }, + "required": [ + "BooleanExpression" + ], + "title": "BooleanExpression", + "type": "object" + } + ] + }, + "PolicyStatement": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/AcceptAction" + }, + "Conditions": { + "items": { + "$ref": "#/definitions/PolicyCondition" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Action", + "Conditions" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::SES::MailManagerTrafficPolicy Resource Type", + "handlers": { + "create": { + "permissions": [ + "ses:TagResource", + "ses:ListTagsForResource", + "ses:GetTrafficPolicy", + "ses:CreateTrafficPolicy" + ] + }, + "delete": { + "permissions": [ + "ses:GetTrafficPolicy", + "ses:DeleteTrafficPolicy" + ] + }, + "list": { + "permissions": [ + "ses:ListTrafficPolicies" + ] + }, + "read": { + "permissions": [ + "ses:ListTagsForResource", + "ses:GetTrafficPolicy" + ] + }, + "update": { + "permissions": [ + "ses:TagResource", + "ses:UntagResource", + "ses:ListTagsForResource", + "ses:GetTrafficPolicy", + "ses:UpdateTrafficPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrafficPolicyId" + ], + "properties": { + "DefaultAction": { + "$ref": "#/definitions/AcceptAction" + }, + "MaxMessageSizeBytes": { + "minimum": 1, + "type": "number" + }, + "PolicyStatements": { + "items": { + "$ref": "#/definitions/PolicyStatement" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrafficPolicyArn": { + "type": "string" + }, + "TrafficPolicyId": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "TrafficPolicyName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9_\\-]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TrafficPolicyArn", + "/properties/TrafficPolicyId" + ], + "required": [ + "DefaultAction", + "PolicyStatements" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses-mailmanager", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ses:TagResource", + "ses:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SES::MailManagerTrafficPolicy" +} diff --git a/schema/aws-ses-receiptfilter.json b/schema/aws-ses-receiptfilter.json index 257d50f..02d571e 100644 --- a/schema/aws-ses-receiptfilter.json +++ b/schema/aws-ses-receiptfilter.json @@ -1,58 +1,58 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Filter" - ], - "definitions": { - "Filter": { - "additionalProperties": false, - "properties": { - "IpFilter": { - "$ref": "#/definitions/IpFilter" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "IpFilter" - ], - "type": "object" - }, - "IpFilter": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Policy": { - "type": "string" - } - }, - "required": [ - "Policy", - "Cidr" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::ReceiptFilter", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Filter": { - "$ref": "#/definitions/Filter" - }, - "Id": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Filter" - ], - "typeName": "AWS::SES::ReceiptFilter" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Filter" + ], + "definitions": { + "Filter": { + "additionalProperties": false, + "properties": { + "IpFilter": { + "$ref": "#/definitions/IpFilter" + }, + "Name": { + "type": "string" + } + }, + "required": [ + "IpFilter" + ], + "type": "object" + }, + "IpFilter": { + "additionalProperties": false, + "properties": { + "Cidr": { + "type": "string" + }, + "Policy": { + "type": "string" + } + }, + "required": [ + "Policy", + "Cidr" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::ReceiptFilter", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Filter": { + "$ref": "#/definitions/Filter" + }, + "Id": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Filter" + ], + "typeName": "AWS::SES::ReceiptFilter" +} diff --git a/schema/aws-ses-receiptrule.json b/schema/aws-ses-receiptrule.json index e3b07eb..4b8b70f 100644 --- a/schema/aws-ses-receiptrule.json +++ b/schema/aws-ses-receiptrule.json @@ -1,216 +1,219 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RuleSetName" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "AddHeaderAction": { - "$ref": "#/definitions/AddHeaderAction" - }, - "BounceAction": { - "$ref": "#/definitions/BounceAction" - }, - "LambdaAction": { - "$ref": "#/definitions/LambdaAction" - }, - "S3Action": { - "$ref": "#/definitions/S3Action" - }, - "SNSAction": { - "$ref": "#/definitions/SNSAction" - }, - "StopAction": { - "$ref": "#/definitions/StopAction" - }, - "WorkmailAction": { - "$ref": "#/definitions/WorkmailAction" - } - }, - "type": "object" - }, - "AddHeaderAction": { - "additionalProperties": false, - "properties": { - "HeaderName": { - "type": "string" - }, - "HeaderValue": { - "type": "string" - } - }, - "required": [ - "HeaderName", - "HeaderValue" - ], - "type": "object" - }, - "BounceAction": { - "additionalProperties": false, - "properties": { - "Message": { - "type": "string" - }, - "Sender": { - "type": "string" - }, - "SmtpReplyCode": { - "type": "string" - }, - "StatusCode": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "Sender", - "SmtpReplyCode", - "Message" - ], - "type": "object" - }, - "LambdaAction": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "InvocationType": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "FunctionArn" - ], - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/Action" - }, - "type": "array", - "uniqueItems": false - }, - "Enabled": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Recipients": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "ScanEnabled": { - "type": "boolean" - }, - "TlsPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "S3Action": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - }, - "ObjectKeyPrefix": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "SNSAction": { - "additionalProperties": false, - "properties": { - "Encoding": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "type": "object" - }, - "StopAction": { - "additionalProperties": false, - "properties": { - "Scope": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "Scope" - ], - "type": "object" - }, - "WorkmailAction": { - "additionalProperties": false, - "properties": { - "OrganizationArn": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "OrganizationArn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::ReceiptRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "After": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Rule": { - "$ref": "#/definitions/Rule" - }, - "RuleSetName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RuleSetName", - "Rule" - ], - "typeName": "AWS::SES::ReceiptRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RuleSetName" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "AddHeaderAction": { + "$ref": "#/definitions/AddHeaderAction" + }, + "BounceAction": { + "$ref": "#/definitions/BounceAction" + }, + "LambdaAction": { + "$ref": "#/definitions/LambdaAction" + }, + "S3Action": { + "$ref": "#/definitions/S3Action" + }, + "SNSAction": { + "$ref": "#/definitions/SNSAction" + }, + "StopAction": { + "$ref": "#/definitions/StopAction" + }, + "WorkmailAction": { + "$ref": "#/definitions/WorkmailAction" + } + }, + "type": "object" + }, + "AddHeaderAction": { + "additionalProperties": false, + "properties": { + "HeaderName": { + "type": "string" + }, + "HeaderValue": { + "type": "string" + } + }, + "required": [ + "HeaderValue", + "HeaderName" + ], + "type": "object" + }, + "BounceAction": { + "additionalProperties": false, + "properties": { + "Message": { + "type": "string" + }, + "Sender": { + "type": "string" + }, + "SmtpReplyCode": { + "type": "string" + }, + "StatusCode": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "required": [ + "Sender", + "SmtpReplyCode", + "Message" + ], + "type": "object" + }, + "LambdaAction": { + "additionalProperties": false, + "properties": { + "FunctionArn": { + "type": "string" + }, + "InvocationType": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "required": [ + "FunctionArn" + ], + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "Actions": { + "items": { + "$ref": "#/definitions/Action" + }, + "type": "array", + "uniqueItems": false + }, + "Enabled": { + "type": "boolean" + }, + "Name": { + "type": "string" + }, + "Recipients": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "ScanEnabled": { + "type": "boolean" + }, + "TlsPolicy": { + "type": "string" + } + }, + "type": "object" + }, + "S3Action": { + "additionalProperties": false, + "properties": { + "BucketName": { + "type": "string" + }, + "IamRoleArn": { + "type": "string" + }, + "KmsKeyArn": { + "type": "string" + }, + "ObjectKeyPrefix": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "SNSAction": { + "additionalProperties": false, + "properties": { + "Encoding": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "type": "object" + }, + "StopAction": { + "additionalProperties": false, + "properties": { + "Scope": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "required": [ + "Scope" + ], + "type": "object" + }, + "WorkmailAction": { + "additionalProperties": false, + "properties": { + "OrganizationArn": { + "type": "string" + }, + "TopicArn": { + "type": "string" + } + }, + "required": [ + "OrganizationArn" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::ReceiptRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "After": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Rule": { + "$ref": "#/definitions/Rule" + }, + "RuleSetName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Rule", + "RuleSetName" + ], + "typeName": "AWS::SES::ReceiptRule" +} diff --git a/schema/aws-ses-receiptruleset.json b/schema/aws-ses-receiptruleset.json index 56467c6..e1b68a6 100644 --- a/schema/aws-ses-receiptruleset.json +++ b/schema/aws-ses-receiptruleset.json @@ -1,22 +1,22 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/RuleSetName" - ], - "description": "Resource Type definition for AWS::SES::ReceiptRuleSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "RuleSetName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "typeName": "AWS::SES::ReceiptRuleSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/RuleSetName" + ], + "description": "Resource Type definition for AWS::SES::ReceiptRuleSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "RuleSetName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "typeName": "AWS::SES::ReceiptRuleSet" +} diff --git a/schema/aws-ses-template.json b/schema/aws-ses-template.json index 31f86c2..74ccd17 100644 --- a/schema/aws-ses-template.json +++ b/schema/aws-ses-template.json @@ -1,90 +1,90 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Template/TemplateName" - ], - "definitions": { - "Template": { - "additionalProperties": false, - "description": "The content of the email, composed of a subject line, an HTML part, and a text-only part", - "properties": { - "HtmlPart": { - "description": "The HTML body of the email.", - "type": "string" - }, - "SubjectPart": { - "description": "The subject line of the email.", - "type": "string" - }, - "TemplateName": { - "description": "The name of the template.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]{1,64}$", - "type": "string" - }, - "TextPart": { - "description": "The email body that is visible to recipients whose email clients do not display HTML content.", - "type": "string" - } - }, - "required": [ - "SubjectPart" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::Template", - "handlers": { - "create": { - "permissions": [ - "ses:CreateEmailTemplate", - "ses:GetEmailTemplate", - "ses:CreateTemplate", - "ses:GetTemplate" - ] - }, - "delete": { - "permissions": [ - "ses:DeleteEmailTemplate", - "ses:DeleteTemplate" - ] - }, - "list": { - "permissions": [ - "ses:ListEmailTemplates", - "ses:ListTemplates" - ] - }, - "read": { - "permissions": [ - "ses:GetEmailTemplate", - "ses:GetTemplate" - ] - }, - "update": { - "permissions": [ - "ses:GetEmailTemplate", - "ses:UpdateEmailTemplate", - "ses:GetTemplate", - "ses:UpdateTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Template": { - "$ref": "#/definitions/Template" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "typeName": "AWS::SES::Template" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Template/TemplateName" + ], + "definitions": { + "Template": { + "additionalProperties": false, + "description": "The content of the email, composed of a subject line, an HTML part, and a text-only part", + "properties": { + "HtmlPart": { + "description": "The HTML body of the email.", + "type": "string" + }, + "SubjectPart": { + "description": "The subject line of the email.", + "type": "string" + }, + "TemplateName": { + "description": "The name of the template.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{1,64}$", + "type": "string" + }, + "TextPart": { + "description": "The email body that is visible to recipients whose email clients do not display HTML content.", + "type": "string" + } + }, + "required": [ + "SubjectPart" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::Template", + "handlers": { + "create": { + "permissions": [ + "ses:CreateEmailTemplate", + "ses:GetEmailTemplate", + "ses:CreateTemplate", + "ses:GetTemplate" + ] + }, + "delete": { + "permissions": [ + "ses:DeleteEmailTemplate", + "ses:DeleteTemplate" + ] + }, + "list": { + "permissions": [ + "ses:ListEmailTemplates", + "ses:ListTemplates" + ] + }, + "read": { + "permissions": [ + "ses:GetEmailTemplate", + "ses:GetTemplate" + ] + }, + "update": { + "permissions": [ + "ses:GetEmailTemplate", + "ses:UpdateEmailTemplate", + "ses:GetTemplate", + "ses:UpdateTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Template": { + "$ref": "#/definitions/Template" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "typeName": "AWS::SES::Template" +} diff --git a/schema/aws-ses-vdmattributes.json b/schema/aws-ses-vdmattributes.json index 121dc1d..2e56f8e 100644 --- a/schema/aws-ses-vdmattributes.json +++ b/schema/aws-ses-vdmattributes.json @@ -1,81 +1,81 @@ -{ - "additionalProperties": false, - "definitions": { - "DashboardAttributes": { - "additionalProperties": false, - "description": "Preferences regarding the Dashboard feature.", - "properties": { - "EngagementMetrics": { - "description": "Whether emails sent from this account have engagement tracking enabled.", - "pattern": "ENABLED|DISABLED", - "type": "string" - } - }, - "type": "object" - }, - "GuardianAttributes": { - "additionalProperties": false, - "description": "Preferences regarding the Guardian feature.", - "properties": { - "OptimizedSharedDelivery": { - "description": "Whether emails sent from this account have optimized delivery algorithm enabled.", - "pattern": "ENABLED|DISABLED", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SES::VdmAttributes", - "handlers": { - "create": { - "permissions": [ - "ses:PutAccountVdmAttributes", - "ses:GetAccount" - ] - }, - "delete": { - "permissions": [ - "ses:PutAccountVdmAttributes", - "ses:GetAccount" - ] - }, - "read": { - "permissions": [ - "ses:GetAccount" - ] - }, - "update": { - "permissions": [ - "ses:PutAccountVdmAttributes", - "ses:GetAccount" - ] - } - }, - "primaryIdentifier": [ - "/properties/VdmAttributesResourceId" - ], - "properties": { - "DashboardAttributes": { - "$ref": "#/definitions/DashboardAttributes" - }, - "GuardianAttributes": { - "$ref": "#/definitions/GuardianAttributes" - }, - "VdmAttributesResourceId": { - "description": "Unique identifier for this resource", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/VdmAttributesResourceId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SES::VdmAttributes" -} +{ + "additionalProperties": false, + "definitions": { + "DashboardAttributes": { + "additionalProperties": false, + "description": "Preferences regarding the Dashboard feature.", + "properties": { + "EngagementMetrics": { + "description": "Whether emails sent from this account have engagement tracking enabled.", + "pattern": "ENABLED|DISABLED", + "type": "string" + } + }, + "type": "object" + }, + "GuardianAttributes": { + "additionalProperties": false, + "description": "Preferences regarding the Guardian feature.", + "properties": { + "OptimizedSharedDelivery": { + "description": "Whether emails sent from this account have optimized delivery algorithm enabled.", + "pattern": "ENABLED|DISABLED", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SES::VdmAttributes", + "handlers": { + "create": { + "permissions": [ + "ses:PutAccountVdmAttributes", + "ses:GetAccount" + ] + }, + "delete": { + "permissions": [ + "ses:PutAccountVdmAttributes", + "ses:GetAccount" + ] + }, + "read": { + "permissions": [ + "ses:GetAccount" + ] + }, + "update": { + "permissions": [ + "ses:PutAccountVdmAttributes", + "ses:GetAccount" + ] + } + }, + "primaryIdentifier": [ + "/properties/VdmAttributesResourceId" + ], + "properties": { + "DashboardAttributes": { + "$ref": "#/definitions/DashboardAttributes" + }, + "GuardianAttributes": { + "$ref": "#/definitions/GuardianAttributes" + }, + "VdmAttributesResourceId": { + "description": "Unique identifier for this resource", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/VdmAttributesResourceId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SES::VdmAttributes" +} diff --git a/schema/aws-shield-drtaccess.json b/schema/aws-shield-drtaccess.json index 1c8d29c..42b159f 100644 --- a/schema/aws-shield-drtaccess.json +++ b/schema/aws-shield-drtaccess.json @@ -1,92 +1,92 @@ -{ - "additionalProperties": false, - "description": "Config the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.", - "handlers": { - "create": { - "permissions": [ - "shield:DescribeDRTAccess", - "shield:AssociateDRTLogBucket", - "shield:AssociateDRTRole", - "iam:PassRole", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy" - ] - }, - "delete": { - "permissions": [ - "shield:DescribeDRTAccess", - "shield:DisassociateDRTLogBucket", - "shield:DisassociateDRTRole", - "iam:PassRole", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "s3:DeleteBucketPolicy" - ] - }, - "list": { - "permissions": [ - "shield:DescribeDRTAccess" - ] - }, - "read": { - "permissions": [ - "shield:DescribeDRTAccess" - ] - }, - "update": { - "permissions": [ - "shield:DescribeDRTAccess", - "shield:AssociateDRTLogBucket", - "shield:AssociateDRTRole", - "shield:DisassociateDRTLogBucket", - "shield:DisassociateDRTRole", - "iam:PassRole", - "iam:GetRole", - "iam:ListAttachedRolePolicies", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "s3:DeleteBucketPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "type": "string" - }, - "LogBucketList": { - "description": "Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.", - "insertionOrder": false, - "items": { - "maxLength": 63, - "minLength": 3, - "type": "string" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "RoleArn": { - "description": "Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.", - "maxLength": 2048, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "required": [ - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Shield::DRTAccess" -} +{ + "additionalProperties": false, + "description": "Config the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.", + "handlers": { + "create": { + "permissions": [ + "shield:DescribeDRTAccess", + "shield:AssociateDRTLogBucket", + "shield:AssociateDRTRole", + "iam:PassRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "shield:DescribeDRTAccess", + "shield:DisassociateDRTLogBucket", + "shield:DisassociateDRTRole", + "iam:PassRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:DeleteBucketPolicy" + ] + }, + "list": { + "permissions": [ + "shield:DescribeDRTAccess" + ] + }, + "read": { + "permissions": [ + "shield:DescribeDRTAccess" + ] + }, + "update": { + "permissions": [ + "shield:DescribeDRTAccess", + "shield:AssociateDRTLogBucket", + "shield:AssociateDRTRole", + "shield:DisassociateDRTLogBucket", + "shield:DisassociateDRTRole", + "iam:PassRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "s3:DeleteBucketPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "type": "string" + }, + "LogBucketList": { + "description": "Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.", + "insertionOrder": false, + "items": { + "maxLength": 63, + "minLength": 3, + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "RoleArn": { + "description": "Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.", + "maxLength": 2048, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "required": [ + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Shield::DRTAccess" +} diff --git a/schema/aws-shield-proactiveengagement.json b/schema/aws-shield-proactiveengagement.json index eee5cae..26d824c 100644 --- a/schema/aws-shield-proactiveengagement.json +++ b/schema/aws-shield-proactiveengagement.json @@ -1,115 +1,115 @@ -{ - "additionalProperties": false, - "definitions": { - "EmergencyContact": { - "additionalProperties": false, - "description": "An emergency contact is used by Shield Response Team (SRT) to contact you for escalations to the SRT and to initiate proactive customer support. An emergency contact requires an email address.", - "properties": { - "ContactNotes": { - "description": "Additional notes regarding the contact.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[\\w\\s\\.\\-,:/()+@]*$", - "type": "string" - }, - "EmailAddress": { - "description": "The email address for the contact.", - "maxLength": 150, - "minLength": 1, - "pattern": "^\\S+@\\S+\\.\\S+$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number for the contact", - "maxLength": 16, - "minLength": 1, - "pattern": "^\\+[1-9]\\d{1,14}$", - "type": "string" - } - }, - "required": [ - "EmailAddress" - ], - "type": "object" - } - }, - "description": "Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.", - "handlers": { - "create": { - "permissions": [ - "shield:DescribeSubscription", - "shield:DescribeEmergencyContactSettings", - "shield:AssociateProactiveEngagementDetails", - "shield:UpdateEmergencyContactSettings", - "shield:EnableProactiveEngagement" - ] - }, - "delete": { - "permissions": [ - "shield:DescribeSubscription", - "shield:DescribeEmergencyContactSettings", - "shield:UpdateEmergencyContactSettings", - "shield:DisableProactiveEngagement" - ] - }, - "list": { - "permissions": [ - "shield:DescribeSubscription", - "shield:DescribeEmergencyContactSettings" - ] - }, - "read": { - "permissions": [ - "shield:DescribeSubscription", - "shield:DescribeEmergencyContactSettings" - ] - }, - "update": { - "permissions": [ - "shield:DescribeSubscription", - "shield:DescribeEmergencyContactSettings", - "shield:UpdateEmergencyContactSettings", - "shield:EnableProactiveEngagement", - "shield:DisableProactiveEngagement" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountId" - ], - "properties": { - "AccountId": { - "type": "string" - }, - "EmergencyContactList": { - "description": "A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.\nTo enable proactive engagement, the contact list must include at least one phone number.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EmergencyContact" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "ProactiveEngagementStatus": { - "description": "If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.\nIf `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccountId" - ], - "required": [ - "ProactiveEngagementStatus", - "EmergencyContactList" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::Shield::ProactiveEngagement" -} +{ + "additionalProperties": false, + "definitions": { + "EmergencyContact": { + "additionalProperties": false, + "description": "An emergency contact is used by Shield Response Team (SRT) to contact you for escalations to the SRT and to initiate proactive customer support. An emergency contact requires an email address.", + "properties": { + "ContactNotes": { + "description": "Additional notes regarding the contact.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\w\\s\\.\\-,:/()+@]*$", + "type": "string" + }, + "EmailAddress": { + "description": "The email address for the contact.", + "maxLength": 150, + "minLength": 1, + "pattern": "^\\S+@\\S+\\.\\S+$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number for the contact", + "maxLength": 16, + "minLength": 1, + "pattern": "^\\+[1-9]\\d{1,14}$", + "type": "string" + } + }, + "required": [ + "EmailAddress" + ], + "type": "object" + } + }, + "description": "Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.", + "handlers": { + "create": { + "permissions": [ + "shield:DescribeSubscription", + "shield:DescribeEmergencyContactSettings", + "shield:AssociateProactiveEngagementDetails", + "shield:UpdateEmergencyContactSettings", + "shield:EnableProactiveEngagement" + ] + }, + "delete": { + "permissions": [ + "shield:DescribeSubscription", + "shield:DescribeEmergencyContactSettings", + "shield:UpdateEmergencyContactSettings", + "shield:DisableProactiveEngagement" + ] + }, + "list": { + "permissions": [ + "shield:DescribeSubscription", + "shield:DescribeEmergencyContactSettings" + ] + }, + "read": { + "permissions": [ + "shield:DescribeSubscription", + "shield:DescribeEmergencyContactSettings" + ] + }, + "update": { + "permissions": [ + "shield:DescribeSubscription", + "shield:DescribeEmergencyContactSettings", + "shield:UpdateEmergencyContactSettings", + "shield:EnableProactiveEngagement", + "shield:DisableProactiveEngagement" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountId" + ], + "properties": { + "AccountId": { + "type": "string" + }, + "EmergencyContactList": { + "description": "A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.\nTo enable proactive engagement, the contact list must include at least one phone number.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EmergencyContact" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "ProactiveEngagementStatus": { + "description": "If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.\nIf `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccountId" + ], + "required": [ + "ProactiveEngagementStatus", + "EmergencyContactList" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::Shield::ProactiveEngagement" +} diff --git a/schema/aws-shield-protection.json b/schema/aws-shield-protection.json index f82bce5..6a2e0ba 100644 --- a/schema/aws-shield-protection.json +++ b/schema/aws-shield-protection.json @@ -1,200 +1,200 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/ResourceArn" - ], - "definitions": { - "ApplicationLayerAutomaticResponseConfiguration": { - "additionalProperties": false, - "description": "The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.", - "properties": { - "Action": { - "description": "Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the AWS WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.", - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Count": { - "additionalProperties": false, - "description": "Specifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF `Count` action.\nYou must specify exactly one action, either `Block` or `Count`.", - "type": "object" - } - }, - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "Block": { - "additionalProperties": false, - "description": "Specifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF `Block` action.\nYou must specify exactly one action, either `Block` or `Count`.", - "type": "object" - } - }, - "type": "object" - } - ], - "type": "object" - }, - "Status": { - "description": "Indicates whether automatic application layer DDoS mitigation is enabled for the protection.", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "required": [ - "Action", - "Status" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.", - "properties": { - "Key": { - "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.", - "handlers": { - "create": { - "permissions": [ - "shield:CreateProtection", - "shield:DeleteProtection", - "shield:DescribeProtection", - "shield:ListProtections", - "shield:EnableApplicationLayerAutomaticResponse", - "shield:AssociateHealthCheck", - "shield:TagResource", - "ec2:DescribeAddresses", - "elasticloadbalancing:DescribeLoadBalancers", - "route53:GetHealthCheck", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL" - ] - }, - "delete": { - "permissions": [ - "shield:DeleteProtection", - "shield:UntagResource" - ] - }, - "list": { - "permissions": [ - "shield:ListProtections" - ] - }, - "read": { - "permissions": [ - "shield:DescribeProtection", - "shield:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "shield:DescribeProtection", - "shield:AssociateHealthCheck", - "shield:DisassociateHealthCheck", - "shield:EnableApplicationLayerAutomaticResponse", - "shield:UpdateApplicationLayerAutomaticResponse", - "shield:DisableApplicationLayerAutomaticResponse", - "shield:ListTagsForResource", - "shield:TagResource", - "shield:UntagResource", - "route53:GetHealthCheck", - "iam:GetRole", - "iam:CreateServiceLinkedRole", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProtectionArn" - ], - "properties": { - "ApplicationLayerAutomaticResponseConfiguration": { - "$ref": "#/definitions/ApplicationLayerAutomaticResponseConfiguration" - }, - "HealthCheckArns": { - "description": "The Amazon Resource Names (ARNs) of the health check to associate with the protection.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array" - }, - "Name": { - "description": "Friendly name for the Protection.", - "maxLength": 128, - "minLength": 1, - "pattern": "[ a-zA-Z0-9_\\.\\-]*", - "type": "string" - }, - "ProtectionArn": { - "description": "The ARN (Amazon Resource Name) of the protection.", - "type": "string" - }, - "ProtectionId": { - "description": "The unique identifier (ID) of the protection.", - "type": "string" - }, - "ResourceArn": { - "description": "The ARN (Amazon Resource Name) of the resource to be protected.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "One or more tag key-value pairs for the Protection object.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ProtectionId", - "/properties/ProtectionArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Name", - "ResourceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::Shield::Protection" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ResourceArn" + ], + "definitions": { + "ApplicationLayerAutomaticResponseConfiguration": { + "additionalProperties": false, + "description": "The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.", + "properties": { + "Action": { + "description": "Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the AWS WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Count": { + "additionalProperties": false, + "description": "Specifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF `Count` action.\nYou must specify exactly one action, either `Block` or `Count`.", + "type": "object" + } + }, + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Block": { + "additionalProperties": false, + "description": "Specifies that Shield Advanced should configure its AWS WAF rules with the AWS WAF `Block` action.\nYou must specify exactly one action, either `Block` or `Count`.", + "type": "object" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "Status": { + "description": "Indicates whether automatic application layer DDoS mitigation is enabled for the protection.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [ + "Action", + "Status" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.", + "properties": { + "Key": { + "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.", + "handlers": { + "create": { + "permissions": [ + "shield:CreateProtection", + "shield:DeleteProtection", + "shield:DescribeProtection", + "shield:ListProtections", + "shield:EnableApplicationLayerAutomaticResponse", + "shield:AssociateHealthCheck", + "shield:TagResource", + "ec2:DescribeAddresses", + "elasticloadbalancing:DescribeLoadBalancers", + "route53:GetHealthCheck", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL" + ] + }, + "delete": { + "permissions": [ + "shield:DeleteProtection", + "shield:UntagResource" + ] + }, + "list": { + "permissions": [ + "shield:ListProtections" + ] + }, + "read": { + "permissions": [ + "shield:DescribeProtection", + "shield:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "shield:DescribeProtection", + "shield:AssociateHealthCheck", + "shield:DisassociateHealthCheck", + "shield:EnableApplicationLayerAutomaticResponse", + "shield:UpdateApplicationLayerAutomaticResponse", + "shield:DisableApplicationLayerAutomaticResponse", + "shield:ListTagsForResource", + "shield:TagResource", + "shield:UntagResource", + "route53:GetHealthCheck", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProtectionArn" + ], + "properties": { + "ApplicationLayerAutomaticResponseConfiguration": { + "$ref": "#/definitions/ApplicationLayerAutomaticResponseConfiguration" + }, + "HealthCheckArns": { + "description": "The Amazon Resource Names (ARNs) of the health check to associate with the protection.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "Name": { + "description": "Friendly name for the Protection.", + "maxLength": 128, + "minLength": 1, + "pattern": "[ a-zA-Z0-9_\\.\\-]*", + "type": "string" + }, + "ProtectionArn": { + "description": "The ARN (Amazon Resource Name) of the protection.", + "type": "string" + }, + "ProtectionId": { + "description": "The unique identifier (ID) of the protection.", + "type": "string" + }, + "ResourceArn": { + "description": "The ARN (Amazon Resource Name) of the resource to be protected.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "One or more tag key-value pairs for the Protection object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ProtectionId", + "/properties/ProtectionArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Name", + "ResourceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::Shield::Protection" +} diff --git a/schema/aws-shield-protectiongroup.json b/schema/aws-shield-protectiongroup.json index 507b7a7..5df52c8 100644 --- a/schema/aws-shield-protectiongroup.json +++ b/schema/aws-shield-protectiongroup.json @@ -1,152 +1,152 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProtectionGroupId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.", - "properties": { - "Key": { - "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.", - "handlers": { - "create": { - "permissions": [ - "shield:CreateProtectionGroup", - "shield:TagResource" - ] - }, - "delete": { - "permissions": [ - "shield:DeleteProtectionGroup", - "shield:UntagResource" - ] - }, - "list": { - "permissions": [ - "shield:ListProtectionGroups" - ] - }, - "read": { - "permissions": [ - "shield:DescribeProtectionGroup", - "shield:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "shield:UpdateProtectionGroup", - "shield:ListTagsForResource", - "shield:TagResource", - "shield:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProtectionGroupArn" - ], - "properties": { - "Aggregation": { - "description": "Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.\n* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.\n* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.\n* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.", - "enum": [ - "SUM", - "MEAN", - "MAX" - ], - "type": "string" - }, - "Members": { - "description": "The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.", - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "maxItems": 10000, - "type": "array" - }, - "Pattern": { - "description": "The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.", - "enum": [ - "ALL", - "ARBITRARY", - "BY_RESOURCE_TYPE" - ], - "type": "string" - }, - "ProtectionGroupArn": { - "description": "The ARN (Amazon Resource Name) of the protection group.", - "type": "string" - }, - "ProtectionGroupId": { - "description": "The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.", - "maxLength": 36, - "minLength": 1, - "pattern": "[a-zA-Z0-9\\-]*", - "type": "string" - }, - "ResourceType": { - "description": "The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.", - "enum": [ - "CLOUDFRONT_DISTRIBUTION", - "ROUTE_53_HOSTED_ZONE", - "ELASTIC_IP_ALLOCATION", - "CLASSIC_LOAD_BALANCER", - "APPLICATION_LOAD_BALANCER", - "GLOBAL_ACCELERATOR" - ], - "type": "string" - }, - "Tags": { - "description": "One or more tag key-value pairs for the Protection object.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ProtectionGroupArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Aggregation", - "Pattern", - "ProtectionGroupId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", - "tagging": { - "cloudFormationSystemTags": false, - "permissions": [ - "shield:ListTagsForResource", - "shield:UntagResource", - "shield:TagResource" - ], - "tagProperty": "/properties/Tags", - "taggable": true - }, - "typeName": "AWS::Shield::ProtectionGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProtectionGroupId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.", + "properties": { + "Key": { + "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.", + "handlers": { + "create": { + "permissions": [ + "shield:CreateProtectionGroup", + "shield:TagResource" + ] + }, + "delete": { + "permissions": [ + "shield:DeleteProtectionGroup", + "shield:UntagResource" + ] + }, + "list": { + "permissions": [ + "shield:ListProtectionGroups" + ] + }, + "read": { + "permissions": [ + "shield:DescribeProtectionGroup", + "shield:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "shield:UpdateProtectionGroup", + "shield:ListTagsForResource", + "shield:TagResource", + "shield:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProtectionGroupArn" + ], + "properties": { + "Aggregation": { + "description": "Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.\n* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.\n* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.\n* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.", + "enum": [ + "SUM", + "MEAN", + "MAX" + ], + "type": "string" + }, + "Members": { + "description": "The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.", + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "maxItems": 10000, + "type": "array" + }, + "Pattern": { + "description": "The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.", + "enum": [ + "ALL", + "ARBITRARY", + "BY_RESOURCE_TYPE" + ], + "type": "string" + }, + "ProtectionGroupArn": { + "description": "The ARN (Amazon Resource Name) of the protection group.", + "type": "string" + }, + "ProtectionGroupId": { + "description": "The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.", + "maxLength": 36, + "minLength": 1, + "pattern": "[a-zA-Z0-9\\-]*", + "type": "string" + }, + "ResourceType": { + "description": "The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.", + "enum": [ + "CLOUDFRONT_DISTRIBUTION", + "ROUTE_53_HOSTED_ZONE", + "ELASTIC_IP_ALLOCATION", + "CLASSIC_LOAD_BALANCER", + "APPLICATION_LOAD_BALANCER", + "GLOBAL_ACCELERATOR" + ], + "type": "string" + }, + "Tags": { + "description": "One or more tag key-value pairs for the Protection object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ProtectionGroupArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Aggregation", + "Pattern", + "ProtectionGroupId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-shield.git", + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "shield:ListTagsForResource", + "shield:UntagResource", + "shield:TagResource" + ], + "tagProperty": "/properties/Tags", + "taggable": true + }, + "typeName": "AWS::Shield::ProtectionGroup" +} diff --git a/schema/aws-signer-profilepermission.json b/schema/aws-signer-profilepermission.json index c100d03..4cfd577 100644 --- a/schema/aws-signer-profilepermission.json +++ b/schema/aws-signer-profilepermission.json @@ -1,77 +1,77 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProfileName", - "/properties/Action", - "/properties/Principal", - "/properties/StatementId", - "/properties/ProfileVersion" - ], - "description": "An example resource schema demonstrating some basic constructs and validation rules.", - "handlers": { - "create": { - "permissions": [ - "signer:AddProfilePermission", - "signer:ListProfilePermissions" - ] - }, - "delete": { - "permissions": [ - "signer:RemoveProfilePermission", - "signer:ListProfilePermissions" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ProfileName": { - "$ref": "resource-schema.json#/properties/ProfileName" - }, - "StatementId": { - "$ref": "resource-schema.json#/properties/StatementId" - } - } - }, - "permissions": [ - "signer:ListProfilePermissions", - "signer:GetSigningProfile" - ] - }, - "read": { - "permissions": [ - "signer:ListProfilePermissions" - ] - } - }, - "primaryIdentifier": [ - "/properties/StatementId", - "/properties/ProfileName" - ], - "properties": { - "Action": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "ProfileName": { - "pattern": "^[0-9a-zA-Z_]{2,64}$", - "type": "string" - }, - "ProfileVersion": { - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "StatementId": { - "type": "string" - } - }, - "required": [ - "ProfileName", - "Action", - "Principal", - "StatementId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::Signer::ProfilePermission" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfileName", + "/properties/Action", + "/properties/Principal", + "/properties/StatementId", + "/properties/ProfileVersion" + ], + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "signer:AddProfilePermission", + "signer:ListProfilePermissions" + ] + }, + "delete": { + "permissions": [ + "signer:RemoveProfilePermission", + "signer:ListProfilePermissions" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ProfileName": { + "$ref": "resource-schema.json#/properties/ProfileName" + }, + "StatementId": { + "$ref": "resource-schema.json#/properties/StatementId" + } + } + }, + "permissions": [ + "signer:ListProfilePermissions", + "signer:GetSigningProfile" + ] + }, + "read": { + "permissions": [ + "signer:ListProfilePermissions" + ] + } + }, + "primaryIdentifier": [ + "/properties/StatementId", + "/properties/ProfileName" + ], + "properties": { + "Action": { + "type": "string" + }, + "Principal": { + "type": "string" + }, + "ProfileName": { + "pattern": "^[0-9a-zA-Z_]{2,64}$", + "type": "string" + }, + "ProfileVersion": { + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "StatementId": { + "type": "string" + } + }, + "required": [ + "ProfileName", + "Action", + "Principal", + "StatementId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::Signer::ProfilePermission" +} diff --git a/schema/aws-signer-signingprofile.json b/schema/aws-signer-signingprofile.json index 9a374d9..5837411 100644 --- a/schema/aws-signer-signingprofile.json +++ b/schema/aws-signer-signingprofile.json @@ -1,152 +1,152 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ProfileName" - ], - [ - "/properties/ProfileVersionArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProfileName", - "/properties/PlatformId", - "/properties/SignatureValidityPeriod" - ], - "definitions": { - "Arn": { - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "PlatformId": { - "enum": [ - "AWSLambda-SHA384-ECDSA", - "Notation-OCI-SHA384-ECDSA" - ], - "type": "string" - }, - "ProfileName": { - "maxLength": 64, - "minLength": 2, - "pattern": "^[0-9a-zA-Z_]$", - "type": "string" - }, - "ProfileVersion": { - "pattern": "^[0-9a-zA-Z]{10}$", - "type": "string" - }, - "SignatureValidityPeriod": { - "additionalProperties": false, - "properties": { - "Type": { - "enum": [ - "DAYS", - "MONTHS", - "YEARS" - ], - "type": "string" - }, - "Value": { - "type": "integer" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 127, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "A signing profile is a signing template that can be used to carry out a pre-defined signing job.", - "handlers": { - "create": { - "permissions": [ - "signer:PutSigningProfile", - "signer:TagResource" - ] - }, - "delete": { - "permissions": [ - "signer:CancelSigningProfile", - "signer:GetSigningProfile" - ] - }, - "list": { - "permissions": [ - "signer:ListSigningProfiles" - ] - }, - "read": { - "permissions": [ - "signer:GetSigningProfile" - ] - }, - "update": { - "permissions": [ - "signer:TagResource", - "signer:UntagResource", - "signer:GetSigningProfile" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the specified signing profile." - }, - "PlatformId": { - "$ref": "#/definitions/PlatformId", - "description": "The ID of the target signing platform." - }, - "ProfileName": { - "$ref": "#/definitions/ProfileName", - "description": "A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " - }, - "ProfileVersion": { - "$ref": "#/definitions/ProfileVersion", - "description": "A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name." - }, - "ProfileVersionArn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the specified signing profile version." - }, - "SignatureValidityPeriod": { - "$ref": "#/definitions/SignatureValidityPeriod", - "description": "Signature validity period of the profile." - }, - "Tags": { - "description": "A list of tags associated with the signing profile.", - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/ProfileName", - "/properties/ProfileVersion", - "/properties/Arn", - "/properties/ProfileVersionArn" - ], - "required": [ - "PlatformId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::Signer::SigningProfile" -} +{ + "additionalIdentifiers": [ + [ + "/properties/ProfileName" + ], + [ + "/properties/ProfileVersionArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfileName", + "/properties/PlatformId", + "/properties/SignatureValidityPeriod" + ], + "definitions": { + "Arn": { + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "PlatformId": { + "enum": [ + "AWSLambda-SHA384-ECDSA", + "Notation-OCI-SHA384-ECDSA" + ], + "type": "string" + }, + "ProfileName": { + "maxLength": 64, + "minLength": 2, + "pattern": "^[0-9a-zA-Z_]{2,64}$", + "type": "string" + }, + "ProfileVersion": { + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "SignatureValidityPeriod": { + "additionalProperties": false, + "properties": { + "Type": { + "enum": [ + "DAYS", + "MONTHS", + "YEARS" + ], + "type": "string" + }, + "Value": { + "type": "integer" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 127, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "A signing profile is a signing template that can be used to carry out a pre-defined signing job.", + "handlers": { + "create": { + "permissions": [ + "signer:PutSigningProfile", + "signer:TagResource" + ] + }, + "delete": { + "permissions": [ + "signer:CancelSigningProfile", + "signer:GetSigningProfile" + ] + }, + "list": { + "permissions": [ + "signer:ListSigningProfiles" + ] + }, + "read": { + "permissions": [ + "signer:GetSigningProfile" + ] + }, + "update": { + "permissions": [ + "signer:TagResource", + "signer:UntagResource", + "signer:GetSigningProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the specified signing profile." + }, + "PlatformId": { + "$ref": "#/definitions/PlatformId", + "description": "The ID of the target signing platform." + }, + "ProfileName": { + "$ref": "#/definitions/ProfileName", + "description": "A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " + }, + "ProfileVersion": { + "$ref": "#/definitions/ProfileVersion", + "description": "A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name." + }, + "ProfileVersionArn": { + "$ref": "#/definitions/Arn", + "description": "The Amazon Resource Name (ARN) of the specified signing profile version." + }, + "SignatureValidityPeriod": { + "$ref": "#/definitions/SignatureValidityPeriod", + "description": "Signature validity period of the profile." + }, + "Tags": { + "description": "A list of tags associated with the signing profile.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ProfileName", + "/properties/ProfileVersion", + "/properties/Arn", + "/properties/ProfileVersionArn" + ], + "required": [ + "PlatformId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::Signer::SigningProfile" +} diff --git a/schema/aws-simspaceweaver-simulation.json b/schema/aws-simspaceweaver-simulation.json index 089e909..af42f0b 100644 --- a/schema/aws-simspaceweaver-simulation.json +++ b/schema/aws-simspaceweaver-simulation.json @@ -1,133 +1,133 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/RoleArn", - "/properties/SchemaS3Location", - "/properties/SnapshotS3Location", - "/properties/MaximumDuration" - ], - "definitions": { - "S3Location": { - "additionalProperties": false, - "properties": { - "BucketName": { - "description": "The Schema S3 bucket name.", - "maxLength": 63, - "minLength": 3, - "pattern": "[a-zA-Z0-9_\\-]{3,63}$", - "type": "string" - }, - "ObjectKey": { - "description": "This is the schema S3 object key, which includes the full path of \"folders\" from the bucket root to the schema.", - "maxLength": 255, - "minLength": 3, - "type": "string" - } - }, - "required": [ - "BucketName", - "ObjectKey" - ], - "type": "object" - } - }, - "description": "AWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.", - "handlers": { - "create": { - "permissions": [ - "simspaceweaver:StartSimulation", - "simspaceweaver:DescribeSimulation", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "simspaceweaver:StopSimulation", - "simspaceweaver:DeleteSimulation", - "simspaceweaver:DescribeSimulation" - ] - }, - "list": { - "permissions": [ - "simspaceweaver:ListSimulations" - ] - }, - "read": { - "permissions": [ - "simspaceweaver:DescribeSimulation" - ] - }, - "update": { - "permissions": [ - "simspaceweaver:StartSimulation", - "simspaceweaver:StopSimulation", - "simspaceweaver:DeleteSimulation", - "simspaceweaver:DescribeSimulation" - ] - } - }, - "oneOf": [ - { - "required": [ - "SchemaS3Location" - ] - }, - { - "required": [ - "SnapshotS3Location" - ] - } - ], - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "DescribePayload": { - "description": "Json object with all simulation details", - "type": "string" - }, - "MaximumDuration": { - "description": "The maximum running time of the simulation.", - "maxLength": 6, - "minLength": 2, - "type": "string" - }, - "Name": { - "description": "The name of the simulation.", - "maxLength": 2048, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\-]{1,2048}$", - "type": "string" - }, - "RoleArn": { - "description": "Role ARN.", - "type": "string" - }, - "SchemaS3Location": { - "$ref": "#/definitions/S3Location" - }, - "SnapshotS3Location": { - "$ref": "#/definitions/S3Location" - } - }, - "propertyTransform": { - "properties/MaximumDuration": "$uppercase(MaximumDuration)" - }, - "readOnlyProperties": [ - "/properties/DescribePayload" - ], - "required": [ - "Name", - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SimSpaceWeaver::Simulation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/RoleArn", + "/properties/SchemaS3Location", + "/properties/SnapshotS3Location", + "/properties/MaximumDuration" + ], + "definitions": { + "S3Location": { + "additionalProperties": false, + "properties": { + "BucketName": { + "description": "The Schema S3 bucket name.", + "maxLength": 63, + "minLength": 3, + "pattern": "[a-zA-Z0-9_\\-]{3,63}$", + "type": "string" + }, + "ObjectKey": { + "description": "This is the schema S3 object key, which includes the full path of \"folders\" from the bucket root to the schema.", + "maxLength": 255, + "minLength": 3, + "type": "string" + } + }, + "required": [ + "BucketName", + "ObjectKey" + ], + "type": "object" + } + }, + "description": "AWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.", + "handlers": { + "create": { + "permissions": [ + "simspaceweaver:StartSimulation", + "simspaceweaver:DescribeSimulation", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "simspaceweaver:StopSimulation", + "simspaceweaver:DeleteSimulation", + "simspaceweaver:DescribeSimulation" + ] + }, + "list": { + "permissions": [ + "simspaceweaver:ListSimulations" + ] + }, + "read": { + "permissions": [ + "simspaceweaver:DescribeSimulation" + ] + }, + "update": { + "permissions": [ + "simspaceweaver:StartSimulation", + "simspaceweaver:StopSimulation", + "simspaceweaver:DeleteSimulation", + "simspaceweaver:DescribeSimulation" + ] + } + }, + "oneOf": [ + { + "required": [ + "SchemaS3Location" + ] + }, + { + "required": [ + "SnapshotS3Location" + ] + } + ], + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "DescribePayload": { + "description": "Json object with all simulation details", + "type": "string" + }, + "MaximumDuration": { + "description": "The maximum running time of the simulation.", + "maxLength": 6, + "minLength": 2, + "type": "string" + }, + "Name": { + "description": "The name of the simulation.", + "maxLength": 2048, + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\-]{1,2048}$", + "type": "string" + }, + "RoleArn": { + "description": "Role ARN.", + "type": "string" + }, + "SchemaS3Location": { + "$ref": "#/definitions/S3Location" + }, + "SnapshotS3Location": { + "$ref": "#/definitions/S3Location" + } + }, + "propertyTransform": { + "properties/MaximumDuration": "$uppercase(MaximumDuration)" + }, + "readOnlyProperties": [ + "/properties/DescribePayload" + ], + "required": [ + "Name", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SimSpaceWeaver::Simulation" +} diff --git a/schema/aws-sns-subscription.json b/schema/aws-sns-subscription.json index d63309b..a41db41 100644 --- a/schema/aws-sns-subscription.json +++ b/schema/aws-sns-subscription.json @@ -1,58 +1,127 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Endpoint", - "/properties/Protocol", - "/properties/TopicArn" - ], - "description": "Resource Type definition for AWS::SNS::Subscription", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DeliveryPolicy": { - "type": "object" - }, - "Endpoint": { - "type": "string" - }, - "FilterPolicy": { - "type": "object" - }, - "FilterPolicyScope": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "RawMessageDelivery": { - "type": "boolean" - }, - "RedrivePolicy": { - "type": "object" - }, - "Region": { - "type": "string" - }, - "ReplayPolicy": { - "type": "object" - }, - "SubscriptionRoleArn": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "TopicArn", - "Protocol" - ], - "typeName": "AWS::SNS::Subscription" -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/Region" + ], + "createOnlyProperties": [ + "/properties/Endpoint", + "/properties/Protocol", + "/properties/TopicArn" + ], + "description": "Resource Type definition for AWS::SNS::Subscription", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "sns:Subscribe" + ] + }, + "delete": { + "permissions": [ + "sns:Unsubscribe", + "sns:GetSubscriptionAttributes" + ] + }, + "list": { + "permissions": [ + "sns:ListSubscriptions" + ] + }, + "read": { + "permissions": [ + "sns:GetSubscriptionAttributes" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:PassRole", + "sns:SetSubscriptionAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Arn of the subscription", + "type": "string" + }, + "DeliveryPolicy": { + "description": "The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic.", + "type": [ + "object", + "string" + ] + }, + "Endpoint": { + "description": "The subscription's endpoint. The endpoint value depends on the protocol that you specify. ", + "type": "string" + }, + "FilterPolicy": { + "description": "The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.", + "type": [ + "object", + "string" + ] + }, + "FilterPolicyScope": { + "description": "This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.", + "type": "string" + }, + "Protocol": { + "description": "The subscription's protocol.", + "type": "string" + }, + "RawMessageDelivery": { + "description": "When set to true, enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints.", + "type": "boolean" + }, + "RedrivePolicy": { + "description": "When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors are held in the dead-letter queue for further analysis or reprocessing.", + "type": [ + "object", + "string" + ] + }, + "Region": { + "description": "For cross-region subscriptions, the region in which the topic resides.If no region is specified, AWS CloudFormation uses the region of the caller as the default.", + "type": "string" + }, + "ReplayPolicy": { + "description": "Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.", + "type": [ + "object", + "string" + ] + }, + "SubscriptionRoleArn": { + "description": "This property applies only to Amazon Data Firehose delivery stream subscriptions.", + "type": "string" + }, + "TopicArn": { + "description": "The ARN of the topic to subscribe to.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "TopicArn", + "Protocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SNS::Subscription", + "writeOnlyProperties": [ + "/properties/Region" + ] +} diff --git a/schema/aws-sns-topic.json b/schema/aws-sns-topic.json index cf014c6..89f7301 100644 --- a/schema/aws-sns-topic.json +++ b/schema/aws-sns-topic.json @@ -1,247 +1,247 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TopicName", - "/properties/FifoTopic" - ], - "definitions": { - "LoggingConfig": { - "additionalProperties": false, - "description": "", - "properties": { - "FailureFeedbackRoleArn": { - "description": "", - "type": "string" - }, - "Protocol": { - "description": "", - "enum": [ - "http/s", - "sqs", - "lambda", - "firehose", - "application" - ], - "type": "string" - }, - "SuccessFeedbackRoleArn": { - "description": "", - "type": "string" - }, - "SuccessFeedbackSampleRate": { - "description": "", - "type": "string" - } - }, - "required": [ - "Protocol" - ], - "type": "object" - }, - "Subscription": { - "additionalProperties": false, - "description": "``Subscription`` is an embedded property that describes the subscription endpoints of an SNS topic.\n For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource.", - "properties": { - "Endpoint": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::Lambda::Function" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::SQS::Queue" - } - } - ], - "description": "The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*.", - "type": "string" - }, - "Protocol": { - "description": "The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*.", - "type": "string" - } - }, - "required": [ - "Endpoint", - "Protocol" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The list of tags to be added to the specified topic.", - "properties": { - "Key": { - "description": "The required key portion of the tag.", - "type": "string" - }, - "Value": { - "description": "The optional value portion of the tag.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.\n One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.\n The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.", - "handlers": { - "create": { - "permissions": [ - "sns:CreateTopic", - "sns:TagResource", - "sns:Subscribe", - "sns:GetTopicAttributes", - "sns:PutDataProtectionPolicy", - "iam:GetRole", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "sns:GetTopicAttributes", - "sns:DeleteTopic" - ] - }, - "list": { - "permissions": [ - "sns:ListTopics" - ] - }, - "read": { - "permissions": [ - "sns:GetTopicAttributes", - "sns:ListTagsForResource", - "sns:ListSubscriptionsByTopic", - "sns:GetDataProtectionPolicy" - ] - }, - "update": { - "permissions": [ - "sns:SetTopicAttributes", - "sns:TagResource", - "sns:UntagResource", - "sns:Subscribe", - "sns:Unsubscribe", - "sns:GetTopicAttributes", - "sns:ListTagsForResource", - "sns:ListSubscriptionsByTopic", - "sns:GetDataProtectionPolicy", - "sns:PutDataProtectionPolicy", - "iam:GetRole", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/TopicArn" - ], - "properties": { - "ArchivePolicy": { - "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.", - "type": "object" - }, - "ContentBasedDeduplication": { - "description": "Enables content-based deduplication for FIFO topics.\n + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. \n + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).\n (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.", - "type": "boolean" - }, - "DataProtectionPolicy": { - "description": "The body of the policy document you want to use for this topic.\n You can only add one policy per topic.\n The policy must be in JSON string format.\n Length Constraints: Maximum length of 30,720.", - "type": "object" - }, - "DeliveryStatusLogging": { - "description": "", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LoggingConfig" - }, - "type": "array", - "uniqueItems": true - }, - "DisplayName": { - "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.", - "type": "string" - }, - "FifoTopic": { - "description": "Set to true to create a FIFO topic.", - "type": "boolean" - }, - "KmsMasterKeyId": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Arn", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/KeyId", - "typeName": "AWS::KMS::Key" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/AliasName", - "typeName": "AWS::KMS::Alias" - } - } - ], - "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.\n This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).", - "type": "string" - }, - "SignatureVersion": { - "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.", - "type": "string" - }, - "Subscription": { - "description": "The SNS subscriptions (endpoints) for this topic.\n If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Subscription" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "The list of tags to add to a new topic.\n To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TopicArn": { - "description": "", - "type": "string" - }, - "TopicName": { - "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "TracingConfig": { - "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/TopicArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SNS::Topic" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TopicName", + "/properties/FifoTopic" + ], + "definitions": { + "LoggingConfig": { + "additionalProperties": false, + "description": "The ``LoggingConfig`` property type specifies the ``Delivery`` status logging configuration for an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html).", + "properties": { + "FailureFeedbackRoleArn": { + "description": "The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch.", + "type": "string" + }, + "Protocol": { + "description": "Indicates one of the supported protocols for the Amazon SNS topic.\n At least one of the other three ``LoggingConfig`` properties is recommend along with ``Protocol``.", + "enum": [ + "http/s", + "sqs", + "lambda", + "firehose", + "application" + ], + "type": "string" + }, + "SuccessFeedbackRoleArn": { + "description": "The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch.", + "type": "string" + }, + "SuccessFeedbackSampleRate": { + "description": "The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100.", + "type": "string" + } + }, + "required": [ + "Protocol" + ], + "type": "object" + }, + "Subscription": { + "additionalProperties": false, + "description": "``Subscription`` is an embedded property that describes the subscription endpoints of an SNS topic.\n For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource.", + "properties": { + "Endpoint": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Lambda::Function" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::SQS::Queue" + } + } + ], + "description": "The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*.", + "type": "string" + }, + "Protocol": { + "description": "The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*.", + "type": "string" + } + }, + "required": [ + "Endpoint", + "Protocol" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The list of tags to be added to the specified topic.", + "properties": { + "Key": { + "description": "The required key portion of the tag.", + "type": "string" + }, + "Value": { + "description": "The optional value portion of the tag.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.\n One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.\n The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.", + "handlers": { + "create": { + "permissions": [ + "sns:CreateTopic", + "sns:TagResource", + "sns:Subscribe", + "sns:GetTopicAttributes", + "sns:PutDataProtectionPolicy", + "iam:GetRole", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "sns:GetTopicAttributes", + "sns:DeleteTopic" + ] + }, + "list": { + "permissions": [ + "sns:ListTopics" + ] + }, + "read": { + "permissions": [ + "sns:GetTopicAttributes", + "sns:ListTagsForResource", + "sns:ListSubscriptionsByTopic", + "sns:GetDataProtectionPolicy" + ] + }, + "update": { + "permissions": [ + "sns:SetTopicAttributes", + "sns:TagResource", + "sns:UntagResource", + "sns:Subscribe", + "sns:Unsubscribe", + "sns:GetTopicAttributes", + "sns:ListTagsForResource", + "sns:ListSubscriptionsByTopic", + "sns:GetDataProtectionPolicy", + "sns:PutDataProtectionPolicy", + "iam:GetRole", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/TopicArn" + ], + "properties": { + "ArchivePolicy": { + "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.", + "type": "object" + }, + "ContentBasedDeduplication": { + "description": "Enables content-based deduplication for FIFO topics.\n + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. \n + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).\n (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.", + "type": "boolean" + }, + "DataProtectionPolicy": { + "description": "The body of the policy document you want to use for this topic.\n You can only add one policy per topic.\n The policy must be in JSON string format.\n Length Constraints: Maximum length of 30,720.", + "type": "object" + }, + "DeliveryStatusLogging": { + "description": "The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:\n + HTTP \n + Amazon Kinesis Data Firehose\n + AWS Lambda\n + Platform application endpoint\n + Amazon Simple Queue Service\n \n Once configured, log entries are sent to Amazon CloudWatch Logs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LoggingConfig" + }, + "type": "array", + "uniqueItems": true + }, + "DisplayName": { + "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.", + "type": "string" + }, + "FifoTopic": { + "description": "Set to true to create a FIFO topic.", + "type": "boolean" + }, + "KmsMasterKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.\n This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).", + "type": "string" + }, + "SignatureVersion": { + "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.", + "type": "string" + }, + "Subscription": { + "description": "The SNS subscriptions (endpoints) for this topic.\n If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Subscription" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "The list of tags to add to a new topic.\n To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TopicArn": { + "description": "", + "type": "string" + }, + "TopicName": { + "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "TracingConfig": { + "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/TopicArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SNS::Topic" +} diff --git a/schema/aws-sns-topicinlinepolicy.json b/schema/aws-sns-topicinlinepolicy.json index bc910bc..e2e72a3 100644 --- a/schema/aws-sns-topicinlinepolicy.json +++ b/schema/aws-sns-topicinlinepolicy.json @@ -1,57 +1,57 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TopicArn" - ], - "description": "Schema for AWS::SNS::TopicInlinePolicy", - "handlers": { - "create": { - "permissions": [ - "sns:SetTopicAttributes", - "sns:GetTopicAttributes" - ] - }, - "delete": { - "permissions": [ - "sns:SetTopicAttributes", - "sns:GetTopicAttributes" - ] - }, - "read": { - "permissions": [ - "sns:GetTopicAttributes" - ] - }, - "update": { - "permissions": [ - "sns:SetTopicAttributes", - "sns:GetTopicAttributes" - ] - } - }, - "primaryIdentifier": [ - "/properties/TopicArn" - ], - "properties": { - "PolicyDocument": { - "description": "A policy document that contains permissions to add to the specified SNS topics.", - "type": "object" - }, - "TopicArn": { - "description": "The Amazon Resource Name (ARN) of the topic to which you want to add the policy.", - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "TopicArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SNS::TopicInlinePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TopicArn" + ], + "description": "Schema for AWS::SNS::TopicInlinePolicy", + "handlers": { + "create": { + "permissions": [ + "sns:SetTopicAttributes", + "sns:GetTopicAttributes" + ] + }, + "delete": { + "permissions": [ + "sns:SetTopicAttributes", + "sns:GetTopicAttributes" + ] + }, + "read": { + "permissions": [ + "sns:GetTopicAttributes" + ] + }, + "update": { + "permissions": [ + "sns:SetTopicAttributes", + "sns:GetTopicAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/TopicArn" + ], + "properties": { + "PolicyDocument": { + "description": "A policy document that contains permissions to add to the specified SNS topics.", + "type": "object" + }, + "TopicArn": { + "description": "The Amazon Resource Name (ARN) of the topic to which you want to add the policy.", + "type": "string" + } + }, + "required": [ + "PolicyDocument", + "TopicArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SNS::TopicInlinePolicy" +} diff --git a/schema/aws-sns-topicpolicy.json b/schema/aws-sns-topicpolicy.json index f59180a..2b94411 100644 --- a/schema/aws-sns-topicpolicy.json +++ b/schema/aws-sns-topicpolicy.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "description": "The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "sns:SetTopicAttributes" - ] - }, - "delete": { - "permissions": [ - "sns:SetTopicAttributes" - ] - }, - "update": { - "permissions": [ - "sns:SetTopicAttributes" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document that contains permissions to add to the specified SNS topics.", - "type": [ - "object", - "string" - ] - }, - "Topics": { - "description": "The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SNS::Topic`` resource.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PolicyDocument", - "Topics" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SNS::TopicPolicy" -} +{ + "additionalProperties": false, + "description": "The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "sns:SetTopicAttributes" + ] + }, + "delete": { + "permissions": [ + "sns:SetTopicAttributes" + ] + }, + "update": { + "permissions": [ + "sns:SetTopicAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document that contains permissions to add to the specified SNS topics.", + "type": [ + "object", + "string" + ] + }, + "Topics": { + "description": "The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SNS::Topic`` resource.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PolicyDocument", + "Topics" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sns.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SNS::TopicPolicy" +} diff --git a/schema/aws-sqs-queue.json b/schema/aws-sqs-queue.json index b50ea35..1ec392a 100644 --- a/schema/aws-sqs-queue.json +++ b/schema/aws-sqs-queue.json @@ -1,167 +1,167 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FifoQueue", - "/properties/QueueName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "The ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.\n Keep the following caveats in mind:\n + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.\n You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. \n + If you don't provide a value for a property, the queue is created with the default value for the property.\n + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.\n + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.\n \n For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.", - "handlers": { - "create": { - "permissions": [ - "sqs:CreateQueue", - "sqs:GetQueueUrl", - "sqs:GetQueueAttributes", - "sqs:ListQueueTags", - "sqs:TagQueue" - ] - }, - "delete": { - "permissions": [ - "sqs:DeleteQueue", - "sqs:GetQueueAttributes" - ] - }, - "list": { - "permissions": [ - "sqs:ListQueues" - ] - }, - "read": { - "permissions": [ - "sqs:GetQueueAttributes", - "sqs:ListQueueTags" - ] - }, - "update": { - "permissions": [ - "sqs:SetQueueAttributes", - "sqs:GetQueueAttributes", - "sqs:ListQueueTags", - "sqs:TagQueue", - "sqs:UntagQueue" - ] - } - }, - "primaryIdentifier": [ - "/properties/QueueUrl" - ], - "properties": { - "Arn": { - "description": "", - "type": "string" - }, - "ContentBasedDeduplication": { - "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.", - "type": "boolean" - }, - "DeduplicationScope": { - "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.\n To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", - "type": "string" - }, - "DelaySeconds": { - "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.", - "type": "integer" - }, - "FifoQueue": { - "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.", - "type": "boolean" - }, - "FifoThroughputLimit": { - "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.\n To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", - "type": "string" - }, - "KmsDataKeyReusePeriodSeconds": { - "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.", - "type": "integer" - }, - "KmsMasterKeyId": { - "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:\n + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* \n + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* \n + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* \n + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper", - "type": "string" - }, - "MaximumMessageSize": { - "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).", - "type": "integer" - }, - "MessageRetentionPeriod": { - "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).", - "type": "integer" - }, - "QueueName": { - "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", - "type": "string" - }, - "QueueUrl": { - "description": "", - "type": "string" - }, - "ReceiveMessageWaitTimeSeconds": { - "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.", - "type": "integer" - }, - "RedriveAllowPolicy": { - "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n + ``denyAll``: No source queues can specify this queue as the dead-letter queue.\n + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.\n \n + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.", - "type": [ - "object", - "string" - ] - }, - "RedrivePolicy": { - "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:\n + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.\n + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.\n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n *JSON* \n ``{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" : Integer }`` \n *YAML* \n ``deadLetterTargetArn : String`` \n ``maxReceiveCount : Integer``", - "type": [ - "object", - "string" - ] - }, - "SqsManagedSseEnabled": { - "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.", - "type": "boolean" - }, - "Tags": { - "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VisibilityTimeout": { - "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.\n For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.", - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/QueueUrl", - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SQS::Queue" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FifoQueue", + "/properties/QueueName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.\n Keep the following caveats in mind:\n + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.\n You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. \n + If you don't provide a value for a property, the queue is created with the default value for the property.\n + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.\n + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.\n \n For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "sqs:CreateQueue", + "sqs:GetQueueUrl", + "sqs:GetQueueAttributes", + "sqs:ListQueueTags", + "sqs:TagQueue" + ] + }, + "delete": { + "permissions": [ + "sqs:DeleteQueue", + "sqs:GetQueueAttributes" + ] + }, + "list": { + "permissions": [ + "sqs:ListQueues" + ] + }, + "read": { + "permissions": [ + "sqs:GetQueueAttributes", + "sqs:ListQueueTags" + ] + }, + "update": { + "permissions": [ + "sqs:SetQueueAttributes", + "sqs:GetQueueAttributes", + "sqs:ListQueueTags", + "sqs:TagQueue", + "sqs:UntagQueue" + ] + } + }, + "primaryIdentifier": [ + "/properties/QueueUrl" + ], + "properties": { + "Arn": { + "description": "", + "type": "string" + }, + "ContentBasedDeduplication": { + "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.", + "type": "boolean" + }, + "DeduplicationScope": { + "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.\n To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", + "type": "string" + }, + "DelaySeconds": { + "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.", + "type": "integer" + }, + "FifoQueue": { + "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.", + "type": "boolean" + }, + "FifoThroughputLimit": { + "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.\n To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", + "type": "string" + }, + "KmsDataKeyReusePeriodSeconds": { + "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.", + "type": "integer" + }, + "KmsMasterKeyId": { + "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:\n + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* \n + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* \n + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* \n + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper", + "type": "string" + }, + "MaximumMessageSize": { + "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).", + "type": "integer" + }, + "MessageRetentionPeriod": { + "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).", + "type": "integer" + }, + "QueueName": { + "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", + "type": "string" + }, + "QueueUrl": { + "description": "", + "type": "string" + }, + "ReceiveMessageWaitTimeSeconds": { + "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.", + "type": "integer" + }, + "RedriveAllowPolicy": { + "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n + ``denyAll``: No source queues can specify this queue as the dead-letter queue.\n + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.\n \n + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.", + "type": [ + "object", + "string" + ] + }, + "RedrivePolicy": { + "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:\n + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.\n + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.\n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n *JSON* \n ``{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" : Integer }`` \n *YAML* \n ``deadLetterTargetArn : String`` \n ``maxReceiveCount : Integer``", + "type": [ + "object", + "string" + ] + }, + "SqsManagedSseEnabled": { + "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.", + "type": "boolean" + }, + "Tags": { + "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VisibilityTimeout": { + "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.\n For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.", + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/QueueUrl", + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SQS::Queue" +} diff --git a/schema/aws-sqs-queueinlinepolicy.json b/schema/aws-sqs-queueinlinepolicy.json index f85032e..fac7946 100644 --- a/schema/aws-sqs-queueinlinepolicy.json +++ b/schema/aws-sqs-queueinlinepolicy.json @@ -1,60 +1,60 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Queue" - ], - "description": "Schema for SQS QueueInlinePolicy", - "handlers": { - "create": { - "permissions": [ - "sqs:SetQueueAttributes", - "sqs:GetQueueAttributes", - "sqs:GetQueueUrl" - ] - }, - "delete": { - "permissions": [ - "sqs:SetQueueAttributes", - "sqs:GetQueueAttributes" - ] - }, - "read": { - "permissions": [ - "sqs:GetQueueAttributes", - "sqs:GetQueueUrl" - ] - }, - "update": { - "permissions": [ - "sqs:SetQueueAttributes", - "sqs:GetQueueAttributes", - "sqs:GetQueueUrl" - ] - } - }, - "primaryIdentifier": [ - "/properties/Queue" - ], - "properties": { - "PolicyDocument": { - "description": "A policy document that contains permissions to add to the specified SQS queue", - "type": "object" - }, - "Queue": { - "description": "The URL of the SQS queue.", - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "Queue" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SQS::QueueInlinePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Queue" + ], + "description": "Schema for SQS QueueInlinePolicy", + "handlers": { + "create": { + "permissions": [ + "sqs:SetQueueAttributes", + "sqs:GetQueueAttributes", + "sqs:GetQueueUrl" + ] + }, + "delete": { + "permissions": [ + "sqs:SetQueueAttributes", + "sqs:GetQueueAttributes" + ] + }, + "read": { + "permissions": [ + "sqs:GetQueueAttributes", + "sqs:GetQueueUrl" + ] + }, + "update": { + "permissions": [ + "sqs:SetQueueAttributes", + "sqs:GetQueueAttributes", + "sqs:GetQueueUrl" + ] + } + }, + "primaryIdentifier": [ + "/properties/Queue" + ], + "properties": { + "PolicyDocument": { + "description": "A policy document that contains permissions to add to the specified SQS queue", + "type": "object" + }, + "Queue": { + "description": "The URL of the SQS queue.", + "type": "string" + } + }, + "required": [ + "PolicyDocument", + "Queue" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SQS::QueueInlinePolicy" +} diff --git a/schema/aws-sqs-queuepolicy.json b/schema/aws-sqs-queuepolicy.json index 0ac772b..1de491a 100644 --- a/schema/aws-sqs-queuepolicy.json +++ b/schema/aws-sqs-queuepolicy.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "description": "The ``AWS::SQS::QueuePolicy`` type applies a policy to SQS queues. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *User Guide*.", - "handlers": { - "create": { - "permissions": [ - "sqs:SetQueueAttributes" - ] - }, - "delete": { - "permissions": [ - "sqs:SetQueueAttributes" - ] - }, - "update": { - "permissions": [ - "sqs:SetQueueAttributes" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "description": "", - "type": "string" - }, - "PolicyDocument": { - "description": "A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.", - "type": [ - "object", - "string" - ] - }, - "Queues": { - "description": "The URLs of the queues to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SQS::Queue`` resource.", - "insertionOrder": false, - "items": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/QueueUrl", - "typeName": "AWS::SQS::Queue" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/QueueName", - "typeName": "AWS::SQS::Queue" - } - } - ], - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "PolicyDocument", - "Queues" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SQS::QueuePolicy" -} +{ + "additionalProperties": false, + "description": "The ``AWS::SQS::QueuePolicy`` type applies a policy to SQS queues. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *User Guide*.", + "handlers": { + "create": { + "permissions": [ + "sqs:SetQueueAttributes" + ] + }, + "delete": { + "permissions": [ + "sqs:SetQueueAttributes" + ] + }, + "update": { + "permissions": [ + "sqs:SetQueueAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "PolicyDocument": { + "description": "A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*.", + "type": [ + "object", + "string" + ] + }, + "Queues": { + "description": "The URLs of the queues to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SQS::Queue`` resource.", + "insertionOrder": false, + "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/QueueUrl", + "typeName": "AWS::SQS::Queue" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/QueueName", + "typeName": "AWS::SQS::Queue" + } + } + ], + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "PolicyDocument", + "Queues" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sqs.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SQS::QueuePolicy" +} diff --git a/schema/aws-ssm-association.json b/schema/aws-ssm-association.json index a5c0e6a..d91d20b 100644 --- a/schema/aws-ssm-association.json +++ b/schema/aws-ssm-association.json @@ -1,281 +1,281 @@ -{ - "additionalProperties": false, - "definitions": { - "InstanceAssociationOutputLocation": { - "additionalProperties": false, - "properties": { - "S3Location": { - "$ref": "#/definitions/S3OutputLocation" - } - }, - "type": "object" - }, - "ParameterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "S3BucketName": { - "maxLength": 63, - "minLength": 3, - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "S3KeyPrefix": { - "maxLength": 1024, - "type": "string" - }, - "S3OutputLocation": { - "additionalProperties": false, - "properties": { - "OutputS3BucketName": { - "$ref": "#/definitions/S3BucketName" - }, - "OutputS3KeyPrefix": { - "$ref": "#/definitions/S3KeyPrefix" - }, - "OutputS3Region": { - "$ref": "#/definitions/S3Region" - } - }, - "type": "object" - }, - "S3Region": { - "maxLength": 20, - "minLength": 3, - "type": "string" - }, - "Target": { - "additionalProperties": false, - "properties": { - "Key": { - "pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]{1,128}$|resource-groups:Name", - "type": "string" - }, - "Values": { - "items": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/Id", - "typeName": "AWS::EC2::Instance" - } - } - ], - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Key", - "Values" - ], - "type": "object" - } - }, - "description": "The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.", - "handlers": { - "create": { - "permissions": [ - "ec2:DescribeInstanceStatus", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "ssm:CreateAssociation", - "ssm:DescribeAssociation", - "ssm:GetCalendarState" - ] - }, - "delete": { - "permissions": [ - "ssm:DeleteAssociation" - ] - }, - "list": { - "permissions": [ - "ssm:ListAssociations" - ] - }, - "read": { - "permissions": [ - "ssm:DescribeAssociation", - "resource-groups:GetGroupQuery", - "resource-groups:ListGroups", - "resource-groups:ListGroupResources" - ] - }, - "update": { - "permissions": [ - "iam:PassRole", - "ssm:UpdateAssociation", - "ssm:GetCalendarState" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssociationId" - ], - "properties": { - "ApplyOnlyAtCronInterval": { - "type": "boolean" - }, - "AssociationId": { - "description": "Unique identifier of the association.", - "examples": [ - "88df7b09-95e8-48c4-a3cb-08c2c20d5110", - "203dd0ec-0055-4bf0-a872-707f72ef06aa" - ], - "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "type": "string" - }, - "AssociationName": { - "description": "The name of the association.", - "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", - "type": "string" - }, - "AutomationTargetParameterName": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "CalendarNames": { - "examples": [ - [ - "calendar1", - "calendar2" - ], - [ - "calendar3" - ] - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "ComplianceSeverity": { - "enum": [ - "CRITICAL", - "HIGH", - "MEDIUM", - "LOW", - "UNSPECIFIED" - ], - "type": "string" - }, - "DocumentVersion": { - "description": "The version of the SSM document to associate with the target.", - "pattern": "([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)", - "type": "string" - }, - "InstanceId": { - "description": "The ID of the instance that the SSM document is associated with.", - "examples": [ - "i-0e60836d21cf313c4", - "mi-0532c22e49636ee13" - ], - "pattern": "(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)", - "type": "string" - }, - "MaxConcurrency": { - "examples": [ - "1%", - "10%", - "50%", - "1" - ], - "pattern": "^([1-9][0-9]{0,6}|[1-9][0-9]%|[1-9]%|100%)$", - "type": "string" - }, - "MaxErrors": { - "examples": [ - "1%", - "10%", - "50%", - "1" - ], - "pattern": "^([1-9][0-9]{0,6}|[0]|[1-9][0-9]%|[0-9]%|100%)$", - "type": "string" - }, - "Name": { - "description": "The name of the SSM document.", - "examples": [ - "AWS-GatherSoftwareInventory", - "MyCustomSSMDocument" - ], - "pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", - "type": "string" - }, - "OutputLocation": { - "$ref": "#/definitions/InstanceAssociationOutputLocation" - }, - "Parameters": { - "additionalProperties": false, - "description": "Parameter values that the SSM document uses at runtime.", - "patternProperties": { - ".{1,255}": { - "$ref": "#/definitions/ParameterValues" - } - }, - "type": "object" - }, - "ScheduleExpression": { - "description": "A Cron or Rate expression that specifies when the association is applied to the target.", - "examples": [ - "cron(0 0 */1 * * ? *)", - "cron(0 16 ? * TUE *)", - "rate(30 minutes)", - "rate(7 days)" - ], - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ScheduleOffset": { - "maximum": 6, - "minimum": 1, - "type": "integer" - }, - "SyncCompliance": { - "enum": [ - "AUTO", - "MANUAL" - ], - "type": "string" - }, - "Targets": { - "description": "The targets that the SSM document sends commands to.", - "items": { - "$ref": "#/definitions/Target" - }, - "maxItems": 5, - "minItems": 0, - "type": "array" - }, - "WaitForSuccessTimeoutSeconds": { - "maximum": 172800, - "minimum": 15, - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/AssociationId" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SSM::Association", - "writeOnlyProperties": [ - "/properties/WaitForSuccessTimeoutSeconds" - ] -} +{ + "additionalProperties": false, + "definitions": { + "InstanceAssociationOutputLocation": { + "additionalProperties": false, + "properties": { + "S3Location": { + "$ref": "#/definitions/S3OutputLocation" + } + }, + "type": "object" + }, + "ParameterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, + "type": "string" + }, + "S3KeyPrefix": { + "maxLength": 1024, + "type": "string" + }, + "S3OutputLocation": { + "additionalProperties": false, + "properties": { + "OutputS3BucketName": { + "$ref": "#/definitions/S3BucketName" + }, + "OutputS3KeyPrefix": { + "$ref": "#/definitions/S3KeyPrefix" + }, + "OutputS3Region": { + "$ref": "#/definitions/S3Region" + } + }, + "type": "object" + }, + "S3Region": { + "maxLength": 20, + "minLength": 3, + "type": "string" + }, + "Target": { + "additionalProperties": false, + "properties": { + "Key": { + "pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]{1,128}$|resource-groups:Name", + "type": "string" + }, + "Values": { + "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::Instance" + } + } + ], + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Key", + "Values" + ], + "type": "object" + } + }, + "description": "The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeInstanceStatus", + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "ssm:CreateAssociation", + "ssm:DescribeAssociation", + "ssm:GetCalendarState" + ] + }, + "delete": { + "permissions": [ + "ssm:DeleteAssociation" + ] + }, + "list": { + "permissions": [ + "ssm:ListAssociations" + ] + }, + "read": { + "permissions": [ + "ssm:DescribeAssociation", + "resource-groups:GetGroupQuery", + "resource-groups:ListGroups", + "resource-groups:ListGroupResources" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "ssm:UpdateAssociation", + "ssm:GetCalendarState" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationId" + ], + "properties": { + "ApplyOnlyAtCronInterval": { + "type": "boolean" + }, + "AssociationId": { + "description": "Unique identifier of the association.", + "examples": [ + "88df7b09-95e8-48c4-a3cb-08c2c20d5110", + "203dd0ec-0055-4bf0-a872-707f72ef06aa" + ], + "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "type": "string" + }, + "AssociationName": { + "description": "The name of the association.", + "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", + "type": "string" + }, + "AutomationTargetParameterName": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "CalendarNames": { + "examples": [ + [ + "calendar1", + "calendar2" + ], + [ + "calendar3" + ] + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "ComplianceSeverity": { + "enum": [ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW", + "UNSPECIFIED" + ], + "type": "string" + }, + "DocumentVersion": { + "description": "The version of the SSM document to associate with the target.", + "pattern": "([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)", + "type": "string" + }, + "InstanceId": { + "description": "The ID of the instance that the SSM document is associated with.", + "examples": [ + "i-0e60836d21cf313c4", + "mi-0532c22e49636ee13" + ], + "pattern": "(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)", + "type": "string" + }, + "MaxConcurrency": { + "examples": [ + "1%", + "10%", + "50%", + "1" + ], + "pattern": "^([1-9][0-9]{0,6}|[1-9][0-9]%|[1-9]%|100%)$", + "type": "string" + }, + "MaxErrors": { + "examples": [ + "1%", + "10%", + "50%", + "1" + ], + "pattern": "^([1-9][0-9]{0,6}|[0]|[1-9][0-9]%|[0-9]%|100%)$", + "type": "string" + }, + "Name": { + "description": "The name of the SSM document.", + "examples": [ + "AWS-GatherSoftwareInventory", + "MyCustomSSMDocument" + ], + "pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "type": "string" + }, + "OutputLocation": { + "$ref": "#/definitions/InstanceAssociationOutputLocation" + }, + "Parameters": { + "additionalProperties": false, + "description": "Parameter values that the SSM document uses at runtime.", + "patternProperties": { + ".{1,255}": { + "$ref": "#/definitions/ParameterValues" + } + }, + "type": "object" + }, + "ScheduleExpression": { + "description": "A Cron or Rate expression that specifies when the association is applied to the target.", + "examples": [ + "cron(0 0 */1 * * ? *)", + "cron(0 16 ? * TUE *)", + "rate(30 minutes)", + "rate(7 days)" + ], + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ScheduleOffset": { + "maximum": 6, + "minimum": 1, + "type": "integer" + }, + "SyncCompliance": { + "enum": [ + "AUTO", + "MANUAL" + ], + "type": "string" + }, + "Targets": { + "description": "The targets that the SSM document sends commands to.", + "items": { + "$ref": "#/definitions/Target" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "WaitForSuccessTimeoutSeconds": { + "maximum": 172800, + "minimum": 15, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/AssociationId" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SSM::Association", + "writeOnlyProperties": [ + "/properties/WaitForSuccessTimeoutSeconds" + ] +} diff --git a/schema/aws-ssm-document.json b/schema/aws-ssm-document.json index 729b25c..af8189b 100644 --- a/schema/aws-ssm-document.json +++ b/schema/aws-ssm-document.json @@ -1,236 +1,236 @@ -{ - "additionalProperties": false, - "conditionalCreateOnlyProperties": [ - "/properties/Content", - "/properties/Attachments", - "/properties/VersionName", - "/properties/DocumentFormat", - "/properties/TargetType", - "/properties/Requires" - ], - "createOnlyProperties": [ - "/properties/Name", - "/properties/DocumentType" - ], - "definitions": { - "AttachmentsSource": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key of a key-value pair that identifies the location of an attachment to a document.", - "enum": [ - "SourceUrl", - "S3FileUrl", - "AttachmentReference" - ], - "type": "string" - }, - "Name": { - "description": "The name of the document attachment file.", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Values": { - "description": "The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.", - "insertionOrder": false, - "items": { - "maxLength": 100000, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "DocumentRequires": { - "additionalProperties": false, - "properties": { - "Name": { - "description": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN).", - "maxLength": 200, - "pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", - "type": "string" - }, - "Version": { - "description": "The document version required by the current document.", - "maxLength": 8, - "pattern": "([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The name of the tag.", - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "description": "The value of the tag.", - "maxLength": 256, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.", - "handlers": { - "create": { - "permissions": [ - "ssm:CreateDocument", - "ssm:GetDocument", - "ssm:AddTagsToResource", - "ssm:ListTagsForResource", - "s3:GetObject", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "ssm:DeleteDocument", - "ssm:GetDocument" - ] - }, - "list": { - "permissions": [ - "ssm:ListDocuments" - ] - }, - "read": { - "permissions": [ - "ssm:GetDocument", - "ssm:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ssm:UpdateDocument", - "s3:GetObject", - "ssm:AddTagsToResource", - "ssm:RemoveTagsFromResource", - "ssm:ListTagsForResource", - "iam:PassRole", - "ssm:UpdateDocumentDefaultVersion", - "ssm:DescribeDocument" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Attachments": { - "description": "A list of key and value pairs that describe attachments to a version of a document.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AttachmentsSource" - }, - "maxItems": 20, - "minItems": 0, - "type": "array" - }, - "Content": { - "description": "The content for the Systems Manager document in JSON, YAML or String format.", - "type": [ - "object", - "string" - ] - }, - "DocumentFormat": { - "default": "JSON", - "description": "Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.", - "enum": [ - "YAML", - "JSON", - "TEXT" - ], - "type": "string" - }, - "DocumentType": { - "description": "The type of document to create.", - "enum": [ - "ApplicationConfiguration", - "ApplicationConfigurationSchema", - "Automation", - "Automation.ChangeTemplate", - "ChangeCalendar", - "CloudFormation", - "Command", - "DeploymentStrategy", - "Package", - "Policy", - "ProblemAnalysis", - "ProblemAnalysisTemplate", - "Session" - ], - "type": "string" - }, - "Name": { - "description": "A name for the Systems Manager document.", - "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", - "type": "string" - }, - "Requires": { - "description": "A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DocumentRequires" - }, - "minItems": 1, - "type": "array" - }, - "Tags": { - "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 1000, - "type": "array" - }, - "TargetType": { - "description": "Specify a target type to define the kinds of resources the document can run on.", - "pattern": "^\\/[\\w\\.\\-\\:\\/]*$", - "type": "string" - }, - "UpdateMethod": { - "default": "Replace", - "description": "Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.", - "enum": [ - "Replace", - "NewVersion" - ], - "type": "string" - }, - "VersionName": { - "description": "An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.", - "pattern": "^[a-zA-Z0-9_\\-.]{1,128}$", - "type": "string" - } - }, - "required": [ - "Content" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm", - "tagging": { - "taggable": true - }, - "typeName": "AWS::SSM::Document", - "writeOnlyProperties": [ - "/properties/UpdateMethod", - "/properties/Attachments" - ] -} +{ + "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/Content", + "/properties/Attachments", + "/properties/VersionName", + "/properties/DocumentFormat", + "/properties/TargetType", + "/properties/Requires" + ], + "createOnlyProperties": [ + "/properties/Name", + "/properties/DocumentType" + ], + "definitions": { + "AttachmentsSource": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key of a key-value pair that identifies the location of an attachment to a document.", + "enum": [ + "SourceUrl", + "S3FileUrl", + "AttachmentReference" + ], + "type": "string" + }, + "Name": { + "description": "The name of the document attachment file.", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Values": { + "description": "The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.", + "insertionOrder": false, + "items": { + "maxLength": 100000, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "DocumentRequires": { + "additionalProperties": false, + "properties": { + "Name": { + "description": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN).", + "maxLength": 200, + "pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "type": "string" + }, + "Version": { + "description": "The document version required by the current document.", + "maxLength": 8, + "pattern": "([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The name of the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "description": "The value of the tag.", + "maxLength": 256, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.", + "handlers": { + "create": { + "permissions": [ + "ssm:CreateDocument", + "ssm:GetDocument", + "ssm:AddTagsToResource", + "ssm:ListTagsForResource", + "s3:GetObject", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "ssm:DeleteDocument", + "ssm:GetDocument" + ] + }, + "list": { + "permissions": [ + "ssm:ListDocuments" + ] + }, + "read": { + "permissions": [ + "ssm:GetDocument", + "ssm:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ssm:UpdateDocument", + "s3:GetObject", + "ssm:AddTagsToResource", + "ssm:RemoveTagsFromResource", + "ssm:ListTagsForResource", + "iam:PassRole", + "ssm:UpdateDocumentDefaultVersion", + "ssm:DescribeDocument" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Attachments": { + "description": "A list of key and value pairs that describe attachments to a version of a document.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AttachmentsSource" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "Content": { + "description": "The content for the Systems Manager document in JSON, YAML or String format.", + "type": [ + "object", + "string" + ] + }, + "DocumentFormat": { + "default": "JSON", + "description": "Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.", + "enum": [ + "YAML", + "JSON", + "TEXT" + ], + "type": "string" + }, + "DocumentType": { + "description": "The type of document to create.", + "enum": [ + "ApplicationConfiguration", + "ApplicationConfigurationSchema", + "Automation", + "Automation.ChangeTemplate", + "ChangeCalendar", + "CloudFormation", + "Command", + "DeploymentStrategy", + "Package", + "Policy", + "ProblemAnalysis", + "ProblemAnalysisTemplate", + "Session" + ], + "type": "string" + }, + "Name": { + "description": "A name for the Systems Manager document.", + "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", + "type": "string" + }, + "Requires": { + "description": "A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DocumentRequires" + }, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 1000, + "type": "array" + }, + "TargetType": { + "description": "Specify a target type to define the kinds of resources the document can run on.", + "pattern": "^\\/[\\w\\.\\-\\:\\/]*$", + "type": "string" + }, + "UpdateMethod": { + "default": "Replace", + "description": "Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.", + "enum": [ + "Replace", + "NewVersion" + ], + "type": "string" + }, + "VersionName": { + "description": "An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.", + "pattern": "^[a-zA-Z0-9_\\-.]{1,128}$", + "type": "string" + } + }, + "required": [ + "Content" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm", + "tagging": { + "taggable": true + }, + "typeName": "AWS::SSM::Document", + "writeOnlyProperties": [ + "/properties/UpdateMethod", + "/properties/Attachments" + ] +} diff --git a/schema/aws-ssm-maintenancewindow.json b/schema/aws-ssm-maintenancewindow.json index 7933047..6aac3f5 100644 --- a/schema/aws-ssm-maintenancewindow.json +++ b/schema/aws-ssm-maintenancewindow.json @@ -1,78 +1,78 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSM::MaintenanceWindow", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllowUnassociatedTargets": { - "type": "boolean" - }, - "Cutoff": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "Duration": { - "type": "integer" - }, - "EndDate": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Schedule": { - "type": "string" - }, - "ScheduleOffset": { - "type": "integer" - }, - "ScheduleTimezone": { - "type": "string" - }, - "StartDate": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "AllowUnassociatedTargets", - "Cutoff", - "Schedule", - "Duration", - "Name" - ], - "typeName": "AWS::SSM::MaintenanceWindow" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSM::MaintenanceWindow", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowUnassociatedTargets": { + "type": "boolean" + }, + "Cutoff": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "Duration": { + "type": "integer" + }, + "EndDate": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Schedule": { + "type": "string" + }, + "ScheduleOffset": { + "type": "integer" + }, + "ScheduleTimezone": { + "type": "string" + }, + "StartDate": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "AllowUnassociatedTargets", + "Cutoff", + "Schedule", + "Duration", + "Name" + ], + "typeName": "AWS::SSM::MaintenanceWindow" +} diff --git a/schema/aws-ssm-maintenancewindowtarget.json b/schema/aws-ssm-maintenancewindowtarget.json index f0489e8..3707093 100644 --- a/schema/aws-ssm-maintenancewindowtarget.json +++ b/schema/aws-ssm-maintenancewindowtarget.json @@ -1,68 +1,68 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WindowId" - ], - "definitions": { - "Targets": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Values", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSM::MaintenanceWindowTarget", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OwnerInformation": { - "type": "string" - }, - "ResourceType": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/Targets" - }, - "type": "array", - "uniqueItems": false - }, - "WindowId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "WindowId", - "ResourceType", - "Targets" - ], - "typeName": "AWS::SSM::MaintenanceWindowTarget" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WindowId" + ], + "definitions": { + "Targets": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Values", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSM::MaintenanceWindowTarget", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OwnerInformation": { + "type": "string" + }, + "ResourceType": { + "type": "string" + }, + "Targets": { + "items": { + "$ref": "#/definitions/Targets" + }, + "type": "array", + "uniqueItems": false + }, + "WindowId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "WindowId", + "ResourceType", + "Targets" + ], + "typeName": "AWS::SSM::MaintenanceWindowTarget" +} diff --git a/schema/aws-ssm-maintenancewindowtask.json b/schema/aws-ssm-maintenancewindowtask.json index 91aa014..8456eba 100644 --- a/schema/aws-ssm-maintenancewindowtask.json +++ b/schema/aws-ssm-maintenancewindowtask.json @@ -1,243 +1,243 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/WindowId", - "/properties/TaskType" - ], - "definitions": { - "CloudWatchOutputConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogGroupName": { - "type": "string" - }, - "CloudWatchOutputEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "LoggingInfo": { - "additionalProperties": false, - "properties": { - "Region": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Prefix": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "Region" - ], - "type": "object" - }, - "MaintenanceWindowAutomationParameters": { - "additionalProperties": false, - "properties": { - "DocumentVersion": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "type": "object" - }, - "MaintenanceWindowLambdaParameters": { - "additionalProperties": false, - "properties": { - "ClientContext": { - "type": "string" - }, - "Payload": { - "type": "string" - }, - "Qualifier": { - "type": "string" - } - }, - "type": "object" - }, - "MaintenanceWindowRunCommandParameters": { - "additionalProperties": false, - "properties": { - "CloudWatchOutputConfig": { - "$ref": "#/definitions/CloudWatchOutputConfig" - }, - "Comment": { - "type": "string" - }, - "DocumentHash": { - "type": "string" - }, - "DocumentHashType": { - "type": "string" - }, - "DocumentVersion": { - "type": "string" - }, - "NotificationConfig": { - "$ref": "#/definitions/NotificationConfig" - }, - "OutputS3BucketName": { - "type": "string" - }, - "OutputS3KeyPrefix": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "ServiceRoleArn": { - "type": "string" - }, - "TimeoutSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "MaintenanceWindowStepFunctionsParameters": { - "additionalProperties": false, - "properties": { - "Input": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "NotificationConfig": { - "additionalProperties": false, - "properties": { - "NotificationArn": { - "type": "string" - }, - "NotificationEvents": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "NotificationType": { - "type": "string" - } - }, - "required": [ - "NotificationArn" - ], - "type": "object" - }, - "Target": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Values", - "Key" - ], - "type": "object" - }, - "TaskInvocationParameters": { - "additionalProperties": false, - "properties": { - "MaintenanceWindowAutomationParameters": { - "$ref": "#/definitions/MaintenanceWindowAutomationParameters" - }, - "MaintenanceWindowLambdaParameters": { - "$ref": "#/definitions/MaintenanceWindowLambdaParameters" - }, - "MaintenanceWindowRunCommandParameters": { - "$ref": "#/definitions/MaintenanceWindowRunCommandParameters" - }, - "MaintenanceWindowStepFunctionsParameters": { - "$ref": "#/definitions/MaintenanceWindowStepFunctionsParameters" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSM::MaintenanceWindowTask", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "CutoffBehavior": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "LoggingInfo": { - "$ref": "#/definitions/LoggingInfo" - }, - "MaxConcurrency": { - "type": "string" - }, - "MaxErrors": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "integer" - }, - "ServiceRoleArn": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/Target" - }, - "type": "array", - "uniqueItems": false - }, - "TaskArn": { - "type": "string" - }, - "TaskInvocationParameters": { - "$ref": "#/definitions/TaskInvocationParameters" - }, - "TaskParameters": { - "type": "object" - }, - "TaskType": { - "type": "string" - }, - "WindowId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "WindowId", - "Priority", - "TaskType", - "TaskArn" - ], - "typeName": "AWS::SSM::MaintenanceWindowTask" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/WindowId", + "/properties/TaskType" + ], + "definitions": { + "CloudWatchOutputConfig": { + "additionalProperties": false, + "properties": { + "CloudWatchLogGroupName": { + "type": "string" + }, + "CloudWatchOutputEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "LoggingInfo": { + "additionalProperties": false, + "properties": { + "Region": { + "type": "string" + }, + "S3Bucket": { + "type": "string" + }, + "S3Prefix": { + "type": "string" + } + }, + "required": [ + "S3Bucket", + "Region" + ], + "type": "object" + }, + "MaintenanceWindowAutomationParameters": { + "additionalProperties": false, + "properties": { + "DocumentVersion": { + "type": "string" + }, + "Parameters": { + "type": "object" + } + }, + "type": "object" + }, + "MaintenanceWindowLambdaParameters": { + "additionalProperties": false, + "properties": { + "ClientContext": { + "type": "string" + }, + "Payload": { + "type": "string" + }, + "Qualifier": { + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceWindowRunCommandParameters": { + "additionalProperties": false, + "properties": { + "CloudWatchOutputConfig": { + "$ref": "#/definitions/CloudWatchOutputConfig" + }, + "Comment": { + "type": "string" + }, + "DocumentHash": { + "type": "string" + }, + "DocumentHashType": { + "type": "string" + }, + "DocumentVersion": { + "type": "string" + }, + "NotificationConfig": { + "$ref": "#/definitions/NotificationConfig" + }, + "OutputS3BucketName": { + "type": "string" + }, + "OutputS3KeyPrefix": { + "type": "string" + }, + "Parameters": { + "type": "object" + }, + "ServiceRoleArn": { + "type": "string" + }, + "TimeoutSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "MaintenanceWindowStepFunctionsParameters": { + "additionalProperties": false, + "properties": { + "Input": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "NotificationConfig": { + "additionalProperties": false, + "properties": { + "NotificationArn": { + "type": "string" + }, + "NotificationEvents": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "NotificationType": { + "type": "string" + } + }, + "required": [ + "NotificationArn" + ], + "type": "object" + }, + "Target": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Values", + "Key" + ], + "type": "object" + }, + "TaskInvocationParameters": { + "additionalProperties": false, + "properties": { + "MaintenanceWindowAutomationParameters": { + "$ref": "#/definitions/MaintenanceWindowAutomationParameters" + }, + "MaintenanceWindowLambdaParameters": { + "$ref": "#/definitions/MaintenanceWindowLambdaParameters" + }, + "MaintenanceWindowRunCommandParameters": { + "$ref": "#/definitions/MaintenanceWindowRunCommandParameters" + }, + "MaintenanceWindowStepFunctionsParameters": { + "$ref": "#/definitions/MaintenanceWindowStepFunctionsParameters" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSM::MaintenanceWindowTask", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CutoffBehavior": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "LoggingInfo": { + "$ref": "#/definitions/LoggingInfo" + }, + "MaxConcurrency": { + "type": "string" + }, + "MaxErrors": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Priority": { + "type": "integer" + }, + "ServiceRoleArn": { + "type": "string" + }, + "Targets": { + "items": { + "$ref": "#/definitions/Target" + }, + "type": "array", + "uniqueItems": false + }, + "TaskArn": { + "type": "string" + }, + "TaskInvocationParameters": { + "$ref": "#/definitions/TaskInvocationParameters" + }, + "TaskParameters": { + "type": "object" + }, + "TaskType": { + "type": "string" + }, + "WindowId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "WindowId", + "Priority", + "TaskType", + "TaskArn" + ], + "typeName": "AWS::SSM::MaintenanceWindowTask" +} diff --git a/schema/aws-ssm-parameter.json b/schema/aws-ssm-parameter.json index 29b3669..5a5c407 100644 --- a/schema/aws-ssm-parameter.json +++ b/schema/aws-ssm-parameter.json @@ -1,120 +1,120 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.\n To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.\n To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.\n For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.", - "handlers": { - "create": { - "permissions": [ - "ssm:PutParameter", - "ssm:AddTagsToResource", - "ssm:GetParameters" - ], - "timeoutInMinutes": 5 - }, - "delete": { - "permissions": [ - "ssm:DeleteParameter" - ] - }, - "list": { - "permissions": [ - "ssm:DescribeParameters" - ] - }, - "read": { - "permissions": [ - "ssm:GetParameters" - ] - }, - "update": { - "permissions": [ - "ssm:PutParameter", - "ssm:AddTagsToResource", - "ssm:RemoveTagsFromResource", - "ssm:GetParameters" - ], - "timeoutInMinutes": 5 - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "AllowedPattern": { - "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``", - "type": "string" - }, - "DataType": { - "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.", - "enum": [ - "text", - "aws:ec2:image" - ], - "type": "string" - }, - "Description": { - "description": "Information about the parameter.", - "type": "string" - }, - "Name": { - "description": "The name of the parameter.\n The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``", - "type": "string" - }, - "Policies": { - "description": "Information about the policies assigned to a parameter.\n [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.", - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.", - "patternProperties": { - "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { - "type": "string" - } - }, - "type": "object" - }, - "Tier": { - "description": "The parameter tier.", - "enum": [ - "Standard", - "Advanced", - "Intelligent-Tiering" - ], - "type": "string" - }, - "Type": { - "description": "The type of parameter.", - "enum": [ - "String", - "StringList" - ], - "type": "string" - }, - "Value": { - "description": "The parameter value.\n If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.", - "type": "string" - } - }, - "required": [ - "Value", - "Type" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSM::Parameter", - "writeOnlyProperties": [ - "/properties/Tags", - "/properties/Description", - "/properties/Tier", - "/properties/AllowedPattern", - "/properties/Policies" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.\n To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.\n To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.\n For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.", + "handlers": { + "create": { + "permissions": [ + "ssm:PutParameter", + "ssm:AddTagsToResource", + "ssm:GetParameters" + ], + "timeoutInMinutes": 5 + }, + "delete": { + "permissions": [ + "ssm:DeleteParameter" + ] + }, + "list": { + "permissions": [ + "ssm:DescribeParameters" + ] + }, + "read": { + "permissions": [ + "ssm:GetParameters" + ] + }, + "update": { + "permissions": [ + "ssm:PutParameter", + "ssm:AddTagsToResource", + "ssm:RemoveTagsFromResource", + "ssm:GetParameters" + ], + "timeoutInMinutes": 5 + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "AllowedPattern": { + "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``", + "type": "string" + }, + "DataType": { + "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.", + "enum": [ + "text", + "aws:ec2:image" + ], + "type": "string" + }, + "Description": { + "description": "Information about the parameter.", + "type": "string" + }, + "Name": { + "description": "The name of the parameter.\n The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``", + "type": "string" + }, + "Policies": { + "description": "Information about the policies assigned to a parameter.\n [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.", + "type": "string" + }, + "Tags": { + "additionalProperties": false, + "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.", + "patternProperties": { + "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { + "type": "string" + } + }, + "type": "object" + }, + "Tier": { + "description": "The parameter tier.", + "enum": [ + "Standard", + "Advanced", + "Intelligent-Tiering" + ], + "type": "string" + }, + "Type": { + "description": "The type of parameter.", + "enum": [ + "String", + "StringList" + ], + "type": "string" + }, + "Value": { + "description": "The parameter value.\n If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.", + "type": "string" + } + }, + "required": [ + "Value", + "Type" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSM::Parameter", + "writeOnlyProperties": [ + "/properties/Tags", + "/properties/Description", + "/properties/Tier", + "/properties/AllowedPattern", + "/properties/Policies" + ] +} diff --git a/schema/aws-ssm-patchbaseline.json b/schema/aws-ssm-patchbaseline.json index 2c37050..6007dcd 100644 --- a/schema/aws-ssm-patchbaseline.json +++ b/schema/aws-ssm-patchbaseline.json @@ -1,370 +1,370 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/OperatingSystem" - ], - "definitions": { - "PatchFilter": { - "additionalProperties": false, - "description": "Defines which patches should be included in a patch baseline.", - "properties": { - "Key": { - "enum": [ - "ADVISORY_ID", - "ARCH", - "BUGZILLA_ID", - "CLASSIFICATION", - "CVE_ID", - "EPOCH", - "MSRC_SEVERITY", - "NAME", - "PATCH_ID", - "PATCH_SET", - "PRIORITY", - "PRODUCT", - "PRODUCT_FAMILY", - "RELEASE", - "REPOSITORY", - "SECTION", - "SECURITY", - "SEVERITY", - "VERSION" - ], - "type": "string" - }, - "Values": { - "items": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "PatchFilterGroup": { - "additionalProperties": false, - "description": "The patch filter group that defines the criteria for the rule.", - "properties": { - "PatchFilters": { - "items": { - "$ref": "#/definitions/PatchFilter" - }, - "maxItems": 5, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "PatchSource": { - "additionalProperties": false, - "description": "Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.", - "properties": { - "Configuration": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "Name": { - "pattern": "^[a-zA-Z0-9_\\-.]{3,50}$", - "type": "string" - }, - "Products": { - "items": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "description": "Defines an approval rule for a patch baseline.", - "insertionOrder": false, - "properties": { - "ApproveAfterDays": { - "maximum": 360, - "minimum": 0, - "type": "integer" - }, - "ApproveUntilDate": { - "maxLength": 10, - "minLength": 0, - "type": "string" - }, - "ComplianceLevel": { - "enum": [ - "CRITICAL", - "HIGH", - "INFORMATIONAL", - "LOW", - "MEDIUM", - "UNSPECIFIED" - ], - "type": "string" - }, - "EnableNonSecurity": { - "default": false, - "type": "boolean" - }, - "PatchFilterGroup": { - "$ref": "#/definitions/PatchFilterGroup" - } - }, - "type": "object" - }, - "RuleGroup": { - "additionalProperties": false, - "description": "A set of rules defining the approval rules for a patch baseline.", - "insertionOrder": false, - "properties": { - "PatchRules": { - "items": { - "$ref": "#/definitions/Rule" - }, - "maxItems": 10, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Metadata that you assign to your AWS resources.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSM::PatchBaseline", - "handlers": { - "create": { - "permissions": [ - "ssm:CreatePatchBaseline", - "ssm:RegisterPatchBaselineForPatchGroup", - "ssm:AddTagsToResource", - "ssm:RemoveTagsFromResource", - "ssm:ListTagsForResource", - "ssm:GetDefaultPatchBaseline", - "ssm:RegisterDefaultPatchBaseline" - ] - }, - "delete": { - "permissions": [ - "ssm:DeletePatchBaseline", - "ssm:GetPatchBaseline", - "ssm:DeregisterPatchBaselineForPatchGroup" - ] - }, - "list": { - "permissions": [ - "ssm:DescribePatchBaselines", - "ssm:GetDefaultPatchBaseline", - "ssm:GetPatchBaseline", - "ssm:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ssm:GetDefaultPatchBaseline", - "ssm:GetPatchBaseline", - "ssm:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ssm:UpdatePatchBaseline", - "ssm:DeregisterPatchBaselineForPatchGroup", - "ssm:AddTagsToResource", - "ssm:RemoveTagsFromResource", - "ssm:ListTagsForResource", - "ssm:GetDefaultPatchBaseline", - "ssm:RegisterDefaultPatchBaseline" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ApprovalRules": { - "$ref": "#/definitions/RuleGroup" - }, - "ApprovedPatches": { - "description": "A list of explicitly approved patches for the baseline.", - "insertionOrder": false, - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "ApprovedPatchesComplianceLevel": { - "default": "UNSPECIFIED", - "description": "Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.", - "enum": [ - "CRITICAL", - "HIGH", - "MEDIUM", - "LOW", - "INFORMATIONAL", - "UNSPECIFIED" - ], - "type": "string" - }, - "ApprovedPatchesEnableNonSecurity": { - "default": false, - "description": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.", - "type": "boolean" - }, - "DefaultBaseline": { - "default": false, - "description": "Set the baseline as default baseline. Only registering to default patch baseline is allowed.", - "type": "boolean" - }, - "Description": { - "description": "The description of the patch baseline.", - "maxLength": 1024, - "minLength": 1, - "type": "string" - }, - "GlobalFilters": { - "$ref": "#/definitions/PatchFilterGroup", - "description": "A set of global filters used to include patches in the baseline." - }, - "Id": { - "description": "The ID of the patch baseline.", - "maxLength": 128, - "minLength": 20, - "pattern": "^[a-zA-Z0-9_\\-:/]{20,128}$", - "type": "string" - }, - "Name": { - "description": "The name of the patch baseline.", - "maxLength": 128, - "minLength": 3, - "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", - "type": "string" - }, - "OperatingSystem": { - "default": "WINDOWS", - "description": "Defines the operating system the patch baseline applies to. The Default value is WINDOWS.", - "enum": [ - "WINDOWS", - "AMAZON_LINUX", - "AMAZON_LINUX_2", - "AMAZON_LINUX_2022", - "AMAZON_LINUX_2023", - "UBUNTU", - "REDHAT_ENTERPRISE_LINUX", - "SUSE", - "CENTOS", - "ORACLE_LINUX", - "DEBIAN", - "MACOS", - "RASPBIAN", - "ROCKY_LINUX", - "ALMA_LINUX" - ], - "type": "string" - }, - "PatchGroups": { - "description": "PatchGroups is used to associate instances with a specific patch baseline", - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "RejectedPatches": { - "description": "A list of explicitly rejected patches for the baseline.", - "insertionOrder": false, - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "RejectedPatchesAction": { - "default": "ALLOW_AS_DEPENDENCY", - "description": "The action for Patch Manager to take on patches included in the RejectedPackages list.", - "enum": [ - "ALLOW_AS_DEPENDENCY", - "BLOCK" - ], - "type": "string" - }, - "Sources": { - "description": "Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.", - "items": { - "$ref": "#/definitions/PatchSource" - }, - "maxItems": 20, - "minItems": 0, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.", - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSM::PatchBaseline" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/OperatingSystem" + ], + "definitions": { + "PatchFilter": { + "additionalProperties": false, + "description": "Defines which patches should be included in a patch baseline.", + "properties": { + "Key": { + "enum": [ + "ADVISORY_ID", + "ARCH", + "BUGZILLA_ID", + "CLASSIFICATION", + "CVE_ID", + "EPOCH", + "MSRC_SEVERITY", + "NAME", + "PATCH_ID", + "PATCH_SET", + "PRIORITY", + "PRODUCT", + "PRODUCT_FAMILY", + "RELEASE", + "REPOSITORY", + "SECTION", + "SECURITY", + "SEVERITY", + "VERSION" + ], + "type": "string" + }, + "Values": { + "items": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "PatchFilterGroup": { + "additionalProperties": false, + "description": "The patch filter group that defines the criteria for the rule.", + "properties": { + "PatchFilters": { + "items": { + "$ref": "#/definitions/PatchFilter" + }, + "maxItems": 5, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "PatchSource": { + "additionalProperties": false, + "description": "Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.", + "properties": { + "Configuration": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Name": { + "pattern": "^[a-zA-Z0-9_\\-.]{3,50}$", + "type": "string" + }, + "Products": { + "items": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "description": "Defines an approval rule for a patch baseline.", + "insertionOrder": false, + "properties": { + "ApproveAfterDays": { + "maximum": 360, + "minimum": 0, + "type": "integer" + }, + "ApproveUntilDate": { + "maxLength": 10, + "minLength": 0, + "type": "string" + }, + "ComplianceLevel": { + "enum": [ + "CRITICAL", + "HIGH", + "INFORMATIONAL", + "LOW", + "MEDIUM", + "UNSPECIFIED" + ], + "type": "string" + }, + "EnableNonSecurity": { + "default": false, + "type": "boolean" + }, + "PatchFilterGroup": { + "$ref": "#/definitions/PatchFilterGroup" + } + }, + "type": "object" + }, + "RuleGroup": { + "additionalProperties": false, + "description": "A set of rules defining the approval rules for a patch baseline.", + "insertionOrder": false, + "properties": { + "PatchRules": { + "items": { + "$ref": "#/definitions/Rule" + }, + "maxItems": 10, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata that you assign to your AWS resources.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSM::PatchBaseline", + "handlers": { + "create": { + "permissions": [ + "ssm:CreatePatchBaseline", + "ssm:RegisterPatchBaselineForPatchGroup", + "ssm:AddTagsToResource", + "ssm:RemoveTagsFromResource", + "ssm:ListTagsForResource", + "ssm:GetDefaultPatchBaseline", + "ssm:RegisterDefaultPatchBaseline" + ] + }, + "delete": { + "permissions": [ + "ssm:DeletePatchBaseline", + "ssm:GetPatchBaseline", + "ssm:DeregisterPatchBaselineForPatchGroup" + ] + }, + "list": { + "permissions": [ + "ssm:DescribePatchBaselines", + "ssm:GetDefaultPatchBaseline", + "ssm:GetPatchBaseline", + "ssm:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ssm:GetDefaultPatchBaseline", + "ssm:GetPatchBaseline", + "ssm:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ssm:UpdatePatchBaseline", + "ssm:DeregisterPatchBaselineForPatchGroup", + "ssm:AddTagsToResource", + "ssm:RemoveTagsFromResource", + "ssm:ListTagsForResource", + "ssm:GetDefaultPatchBaseline", + "ssm:RegisterDefaultPatchBaseline" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApprovalRules": { + "$ref": "#/definitions/RuleGroup" + }, + "ApprovedPatches": { + "description": "A list of explicitly approved patches for the baseline.", + "insertionOrder": false, + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "ApprovedPatchesComplianceLevel": { + "default": "UNSPECIFIED", + "description": "Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.", + "enum": [ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW", + "INFORMATIONAL", + "UNSPECIFIED" + ], + "type": "string" + }, + "ApprovedPatchesEnableNonSecurity": { + "default": false, + "description": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.", + "type": "boolean" + }, + "DefaultBaseline": { + "default": false, + "description": "Set the baseline as default baseline. Only registering to default patch baseline is allowed.", + "type": "boolean" + }, + "Description": { + "description": "The description of the patch baseline.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "GlobalFilters": { + "$ref": "#/definitions/PatchFilterGroup", + "description": "A set of global filters used to include patches in the baseline." + }, + "Id": { + "description": "The ID of the patch baseline.", + "maxLength": 128, + "minLength": 20, + "pattern": "^[a-zA-Z0-9_\\-:/]{20,128}$", + "type": "string" + }, + "Name": { + "description": "The name of the patch baseline.", + "maxLength": 128, + "minLength": 3, + "pattern": "^[a-zA-Z0-9_\\-.]{3,128}$", + "type": "string" + }, + "OperatingSystem": { + "default": "WINDOWS", + "description": "Defines the operating system the patch baseline applies to. The Default value is WINDOWS.", + "enum": [ + "WINDOWS", + "AMAZON_LINUX", + "AMAZON_LINUX_2", + "AMAZON_LINUX_2022", + "AMAZON_LINUX_2023", + "UBUNTU", + "REDHAT_ENTERPRISE_LINUX", + "SUSE", + "CENTOS", + "ORACLE_LINUX", + "DEBIAN", + "MACOS", + "RASPBIAN", + "ROCKY_LINUX", + "ALMA_LINUX" + ], + "type": "string" + }, + "PatchGroups": { + "description": "PatchGroups is used to associate instances with a specific patch baseline", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RejectedPatches": { + "description": "A list of explicitly rejected patches for the baseline.", + "insertionOrder": false, + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "RejectedPatchesAction": { + "default": "ALLOW_AS_DEPENDENCY", + "description": "The action for Patch Manager to take on patches included in the RejectedPackages list.", + "enum": [ + "ALLOW_AS_DEPENDENCY", + "BLOCK" + ], + "type": "string" + }, + "Sources": { + "description": "Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.", + "items": { + "$ref": "#/definitions/PatchSource" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSM::PatchBaseline" +} diff --git a/schema/aws-ssm-resourcedatasync.json b/schema/aws-ssm-resourcedatasync.json index ef71453..0f68e5c 100644 --- a/schema/aws-ssm-resourcedatasync.json +++ b/schema/aws-ssm-resourcedatasync.json @@ -1,187 +1,187 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KMSKeyArn", - "/properties/SyncFormat", - "/properties/BucketPrefix", - "/properties/SyncName", - "/properties/BucketRegion", - "/properties/BucketName", - "/properties/S3Destination", - "/properties/SyncType" - ], - "definitions": { - "AwsOrganizationsSource": { - "additionalProperties": false, - "properties": { - "OrganizationSourceType": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "OrganizationalUnits": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "OrganizationSourceType" - ], - "type": "object" - }, - "S3Destination": { - "additionalProperties": false, - "properties": { - "BucketName": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "BucketPrefix": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "BucketRegion": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "KMSKeyArn": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "SyncFormat": { - "maxLength": 1024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "BucketName", - "BucketRegion", - "SyncFormat" - ], - "type": "object" - }, - "SyncSource": { - "additionalProperties": false, - "properties": { - "AwsOrganizationsSource": { - "$ref": "#/definitions/AwsOrganizationsSource" - }, - "IncludeFutureRegions": { - "type": "boolean" - }, - "SourceRegions": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SourceType": { - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "SourceType", - "SourceRegions" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSM::ResourceDataSync", - "handlers": { - "create": { - "permissions": [ - "ssm:CreateResourceDataSync", - "ssm:ListResourceDataSync" - ] - }, - "delete": { - "permissions": [ - "ssm:ListResourceDataSync", - "ssm:DeleteResourceDataSync" - ] - }, - "list": { - "permissions": [ - "ssm:ListResourceDataSync" - ] - }, - "read": { - "permissions": [ - "ssm:ListResourceDataSync" - ] - }, - "update": { - "permissions": [ - "ssm:ListResourceDataSync", - "ssm:UpdateResourceDataSync" - ] - } - }, - "primaryIdentifier": [ - "/properties/SyncName" - ], - "properties": { - "BucketName": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "BucketPrefix": { - "maxLength": 64, - "minLength": 0, - "type": "string" - }, - "BucketRegion": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "KMSKeyArn": { - "maxLength": 512, - "minLength": 0, - "type": "string" - }, - "S3Destination": { - "$ref": "#/definitions/S3Destination" - }, - "SyncFormat": { - "maxLength": 1024, - "minLength": 0, - "type": "string" - }, - "SyncName": { - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "SyncSource": { - "$ref": "#/definitions/SyncSource" - }, - "SyncType": { - "maxLength": 64, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/SyncName" - ], - "required": [ - "SyncName" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::SSM::ResourceDataSync" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KMSKeyArn", + "/properties/SyncFormat", + "/properties/BucketPrefix", + "/properties/SyncName", + "/properties/BucketRegion", + "/properties/BucketName", + "/properties/S3Destination", + "/properties/SyncType" + ], + "definitions": { + "AwsOrganizationsSource": { + "additionalProperties": false, + "properties": { + "OrganizationSourceType": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "OrganizationalUnits": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "OrganizationSourceType" + ], + "type": "object" + }, + "S3Destination": { + "additionalProperties": false, + "properties": { + "BucketName": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "BucketPrefix": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "BucketRegion": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "KMSKeyArn": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "SyncFormat": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "BucketName", + "BucketRegion", + "SyncFormat" + ], + "type": "object" + }, + "SyncSource": { + "additionalProperties": false, + "properties": { + "AwsOrganizationsSource": { + "$ref": "#/definitions/AwsOrganizationsSource" + }, + "IncludeFutureRegions": { + "type": "boolean" + }, + "SourceRegions": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SourceType": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "SourceType", + "SourceRegions" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSM::ResourceDataSync", + "handlers": { + "create": { + "permissions": [ + "ssm:CreateResourceDataSync", + "ssm:ListResourceDataSync" + ] + }, + "delete": { + "permissions": [ + "ssm:ListResourceDataSync", + "ssm:DeleteResourceDataSync" + ] + }, + "list": { + "permissions": [ + "ssm:ListResourceDataSync" + ] + }, + "read": { + "permissions": [ + "ssm:ListResourceDataSync" + ] + }, + "update": { + "permissions": [ + "ssm:ListResourceDataSync", + "ssm:UpdateResourceDataSync" + ] + } + }, + "primaryIdentifier": [ + "/properties/SyncName" + ], + "properties": { + "BucketName": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "BucketPrefix": { + "maxLength": 64, + "minLength": 0, + "type": "string" + }, + "BucketRegion": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "KMSKeyArn": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "S3Destination": { + "$ref": "#/definitions/S3Destination" + }, + "SyncFormat": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "SyncName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "SyncSource": { + "$ref": "#/definitions/SyncSource" + }, + "SyncType": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SyncName" + ], + "required": [ + "SyncName" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::SSM::ResourceDataSync" +} diff --git a/schema/aws-ssm-resourcepolicy.json b/schema/aws-ssm-resourcepolicy.json index 717f423..5e064ec 100644 --- a/schema/aws-ssm-resourcepolicy.json +++ b/schema/aws-ssm-resourcepolicy.json @@ -1,72 +1,72 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn" - ], - "description": "Resource Type definition for AWS::SSM::ResourcePolicy", - "handlers": { - "create": { - "permissions": [ - "ssm:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "ssm:DeleteResourcePolicy" - ] - }, - "list": { - "permissions": [ - "ssm:GetResourcePolicies" - ] - }, - "read": { - "permissions": [ - "ssm:GetResourcePolicies" - ] - }, - "update": { - "permissions": [ - "ssm:PutResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyId", - "/properties/ResourceArn" - ], - "properties": { - "Policy": { - "description": "Actual policy statement.", - "type": [ - "object", - "string" - ] - }, - "PolicyHash": { - "description": "A snapshot identifier for the policy over time.", - "type": "string" - }, - "PolicyId": { - "description": "An unique identifier within the policies of a resource. ", - "type": "string" - }, - "ResourceArn": { - "description": "Arn of OpsItemGroup etc.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PolicyId", - "/properties/PolicyHash" - ], - "required": [ - "ResourceArn", - "Policy" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SSM::ResourcePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn" + ], + "description": "Resource Type definition for AWS::SSM::ResourcePolicy", + "handlers": { + "create": { + "permissions": [ + "ssm:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "ssm:DeleteResourcePolicy" + ] + }, + "list": { + "permissions": [ + "ssm:GetResourcePolicies" + ] + }, + "read": { + "permissions": [ + "ssm:GetResourcePolicies" + ] + }, + "update": { + "permissions": [ + "ssm:PutResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyId", + "/properties/ResourceArn" + ], + "properties": { + "Policy": { + "description": "Actual policy statement.", + "type": [ + "object", + "string" + ] + }, + "PolicyHash": { + "description": "A snapshot identifier for the policy over time.", + "type": "string" + }, + "PolicyId": { + "description": "An unique identifier within the policies of a resource. ", + "type": "string" + }, + "ResourceArn": { + "description": "Arn of OpsItemGroup etc.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PolicyId", + "/properties/PolicyHash" + ], + "required": [ + "ResourceArn", + "Policy" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SSM::ResourcePolicy" +} diff --git a/schema/aws-ssmcontacts-contact.json b/schema/aws-ssmcontacts-contact.json index 5bdaa14..cd14ecb 100644 --- a/schema/aws-ssmcontacts-contact.json +++ b/schema/aws-ssmcontacts-contact.json @@ -1,196 +1,196 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Alias", - "/properties/Type" - ], - "definitions": { - "ChannelTargetInfo": { - "additionalProperties": false, - "description": "Information about the contact channel that SSM Incident Manager uses to engage the contact.", - "properties": { - "ChannelId": { - "description": "The Amazon Resource Name (ARN) of the contact channel.", - "type": "string" - }, - "RetryIntervalInMinutes": { - "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails.", - "type": "integer" - } - }, - "required": [ - "ChannelId", - "RetryIntervalInMinutes" - ], - "type": "object" - }, - "ContactTargetInfo": { - "additionalProperties": false, - "description": "The contact that SSM Incident Manager is engaging during an incident.", - "properties": { - "ContactId": { - "description": "The Amazon Resource Name (ARN) of the contact.", - "type": "string" - }, - "IsEssential": { - "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.", - "type": "boolean" - } - }, - "required": [ - "ContactId", - "IsEssential" - ], - "type": "object" - }, - "Stage": { - "additionalProperties": false, - "description": "A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.", - "oneOf": [ - { - "required": [ - "DurationInMinutes" - ] - }, - { - "required": [ - "RotationIds" - ] - } - ], - "properties": { - "DurationInMinutes": { - "description": "The time to wait until beginning the next stage.", - "type": "integer" - }, - "RotationIds": { - "description": "List of Rotation Ids to associate with Contact", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Targets": { - "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", - "items": { - "$ref": "#/definitions/Targets" - }, - "type": "array" - } - }, - "type": "object" - }, - "Targets": { - "additionalProperties": false, - "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", - "oneOf": [ - { - "required": [ - "ChannelTargetInfo" - ] - }, - { - "required": [ - "ContactTargetInfo" - ] - } - ], - "properties": { - "ChannelTargetInfo": { - "$ref": "#/definitions/ChannelTargetInfo" - }, - "ContactTargetInfo": { - "$ref": "#/definitions/ContactTargetInfo" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSMContacts::Contact", - "handlers": { - "create": { - "permissions": [ - "ssm-contacts:CreateContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - }, - "delete": { - "permissions": [ - "ssm-contacts:DeleteContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - }, - "list": { - "permissions": [ - "ssm-contacts:ListContacts" - ] - }, - "read": { - "permissions": [ - "ssm-contacts:GetContact" - ] - }, - "update": { - "permissions": [ - "ssm-contacts:UpdateContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Alias": { - "description": "Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-z0-9_\\-\\.]*$", - "type": "string" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) of the contact.", - "type": "string" - }, - "DisplayName": { - "description": "Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_\\-\\s]*$", - "type": "string" - }, - "Plan": { - "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in.", - "items": { - "$ref": "#/definitions/Stage" - }, - "type": "array" - }, - "Type": { - "description": "Contact type, which specify type of contact. Currently supported values: \u201cPERSONAL\u201d, \u201cSHARED\u201d, \u201cOTHER\u201c.", - "enum": [ - "PERSONAL", - "ESCALATION", - "ONCALL_SCHEDULE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Alias", - "DisplayName", - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::SSMContacts::Contact", - "writeOnlyProperties": [ - "/properties/Plan" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Alias", + "/properties/Type" + ], + "definitions": { + "ChannelTargetInfo": { + "additionalProperties": false, + "description": "Information about the contact channel that SSM Incident Manager uses to engage the contact.", + "properties": { + "ChannelId": { + "description": "The Amazon Resource Name (ARN) of the contact channel.", + "type": "string" + }, + "RetryIntervalInMinutes": { + "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails.", + "type": "integer" + } + }, + "required": [ + "ChannelId", + "RetryIntervalInMinutes" + ], + "type": "object" + }, + "ContactTargetInfo": { + "additionalProperties": false, + "description": "The contact that SSM Incident Manager is engaging during an incident.", + "properties": { + "ContactId": { + "description": "The Amazon Resource Name (ARN) of the contact.", + "type": "string" + }, + "IsEssential": { + "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.", + "type": "boolean" + } + }, + "required": [ + "ContactId", + "IsEssential" + ], + "type": "object" + }, + "Stage": { + "additionalProperties": false, + "description": "A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.", + "oneOf": [ + { + "required": [ + "DurationInMinutes" + ] + }, + { + "required": [ + "RotationIds" + ] + } + ], + "properties": { + "DurationInMinutes": { + "description": "The time to wait until beginning the next stage.", + "type": "integer" + }, + "RotationIds": { + "description": "List of Rotation Ids to associate with Contact", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Targets": { + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", + "items": { + "$ref": "#/definitions/Targets" + }, + "type": "array" + } + }, + "type": "object" + }, + "Targets": { + "additionalProperties": false, + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", + "oneOf": [ + { + "required": [ + "ChannelTargetInfo" + ] + }, + { + "required": [ + "ContactTargetInfo" + ] + } + ], + "properties": { + "ChannelTargetInfo": { + "$ref": "#/definitions/ChannelTargetInfo" + }, + "ContactTargetInfo": { + "$ref": "#/definitions/ContactTargetInfo" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSMContacts::Contact", + "handlers": { + "create": { + "permissions": [ + "ssm-contacts:CreateContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + }, + "delete": { + "permissions": [ + "ssm-contacts:DeleteContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + }, + "list": { + "permissions": [ + "ssm-contacts:ListContacts" + ] + }, + "read": { + "permissions": [ + "ssm-contacts:GetContact" + ] + }, + "update": { + "permissions": [ + "ssm-contacts:UpdateContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Alias": { + "description": "Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-z0-9_\\-\\.]*$", + "type": "string" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) of the contact.", + "type": "string" + }, + "DisplayName": { + "description": "Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_\\-\\s]*$", + "type": "string" + }, + "Plan": { + "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in.", + "items": { + "$ref": "#/definitions/Stage" + }, + "type": "array" + }, + "Type": { + "description": "Contact type, which specify type of contact. Currently supported values: \u201cPERSONAL\u201d, \u201cSHARED\u201d, \u201cOTHER\u201c.", + "enum": [ + "PERSONAL", + "ESCALATION", + "ONCALL_SCHEDULE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Alias", + "DisplayName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::SSMContacts::Contact", + "writeOnlyProperties": [ + "/properties/Plan" + ] +} diff --git a/schema/aws-ssmcontacts-contactchannel.json b/schema/aws-ssmcontacts-contactchannel.json index 43aaff2..c620322 100644 --- a/schema/aws-ssmcontacts-contactchannel.json +++ b/schema/aws-ssmcontacts-contactchannel.json @@ -1,96 +1,96 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContactId", - "/properties/ChannelType" - ], - "description": "Resource Type definition for AWS::SSMContacts::ContactChannel", - "handlers": { - "create": { - "permissions": [ - "ssm-contacts:CreateContactChannel", - "ssm-contacts:GetContactChannel" - ] - }, - "delete": { - "permissions": [ - "ssm-contacts:DeleteContactChannel", - "ssm-contacts:GetContactChannel" - ] - }, - "list": { - "permissions": [ - "ssm-contacts:ListContactChannels" - ] - }, - "read": { - "permissions": [ - "ssm-contacts:GetContactChannel" - ] - }, - "update": { - "permissions": [ - "ssm-contacts:UpdateContactChannel", - "ssm-contacts:GetContactChannel" - ] - } - }, - "oneOf": [ - { - "required": [ - "ContactId", - "ChannelName", - "ChannelType", - "ChannelAddress" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the engagement to a contact channel.", - "type": "string" - }, - "ChannelAddress": { - "description": "The details that SSM Incident Manager uses when trying to engage the contact channel.", - "type": "string" - }, - "ChannelName": { - "description": "The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.", - "maxLength": 255, - "minLength": 1, - "pattern": "[a-zA-Z 0-9_\\-+'&\\uD83C-\\uDBFF\\uDC00-\\uDFFF\\u2000-\\u3300]+", - "type": "string" - }, - "ChannelType": { - "description": "Device type, which specify notification channel. Currently supported values: \u201cSMS\u201d, \u201cVOICE\u201d, \u201cEMAIL\u201d, \u201cCHATBOT.", - "enum": [ - "SMS", - "VOICE", - "EMAIL" - ], - "type": "string" - }, - "ContactId": { - "description": "ARN of the contact resource", - "maxLength": 2048, - "minLength": 1, - "pattern": "arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*", - "type": "string" - }, - "DeferActivation": { - "description": "If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.", - "type": "boolean" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "typeName": "AWS::SSMContacts::ContactChannel", - "writeOnlyProperties": [ - "/properties/DeferActivation" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContactId", + "/properties/ChannelType" + ], + "description": "Resource Type definition for AWS::SSMContacts::ContactChannel", + "handlers": { + "create": { + "permissions": [ + "ssm-contacts:CreateContactChannel", + "ssm-contacts:GetContactChannel" + ] + }, + "delete": { + "permissions": [ + "ssm-contacts:DeleteContactChannel", + "ssm-contacts:GetContactChannel" + ] + }, + "list": { + "permissions": [ + "ssm-contacts:ListContactChannels" + ] + }, + "read": { + "permissions": [ + "ssm-contacts:GetContactChannel" + ] + }, + "update": { + "permissions": [ + "ssm-contacts:UpdateContactChannel", + "ssm-contacts:GetContactChannel" + ] + } + }, + "oneOf": [ + { + "required": [ + "ContactId", + "ChannelName", + "ChannelType", + "ChannelAddress" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the engagement to a contact channel.", + "type": "string" + }, + "ChannelAddress": { + "description": "The details that SSM Incident Manager uses when trying to engage the contact channel.", + "type": "string" + }, + "ChannelName": { + "description": "The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.", + "maxLength": 255, + "minLength": 1, + "pattern": "[a-zA-Z 0-9_\\-+'&\\uD83C-\\uDBFF\\uDC00-\\uDFFF\\u2000-\\u3300]+", + "type": "string" + }, + "ChannelType": { + "description": "Device type, which specify notification channel. Currently supported values: \u201cSMS\u201d, \u201cVOICE\u201d, \u201cEMAIL\u201d, \u201cCHATBOT.", + "enum": [ + "SMS", + "VOICE", + "EMAIL" + ], + "type": "string" + }, + "ContactId": { + "description": "ARN of the contact resource", + "maxLength": 2048, + "minLength": 1, + "pattern": "arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*", + "type": "string" + }, + "DeferActivation": { + "description": "If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.", + "type": "boolean" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "typeName": "AWS::SSMContacts::ContactChannel", + "writeOnlyProperties": [ + "/properties/DeferActivation" + ] +} diff --git a/schema/aws-ssmcontacts-plan.json b/schema/aws-ssmcontacts-plan.json index ef28fa2..1646551 100644 --- a/schema/aws-ssmcontacts-plan.json +++ b/schema/aws-ssmcontacts-plan.json @@ -1,180 +1,180 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ContactId" - ], - "definitions": { - "ChannelTargetInfo": { - "additionalProperties": false, - "description": "Information about the contact channel that SSM Incident Manager uses to engage the contact.", - "properties": { - "ChannelId": { - "description": "The Amazon Resource Name (ARN) of the contact channel.", - "type": "string" - }, - "RetryIntervalInMinutes": { - "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails.", - "type": "integer" - } - }, - "required": [ - "ChannelId", - "RetryIntervalInMinutes" - ], - "type": "object" - }, - "ContactTargetInfo": { - "additionalProperties": false, - "description": "The contact that SSM Incident Manager is engaging during an incident.", - "properties": { - "ContactId": { - "description": "The Amazon Resource Name (ARN) of the contact.", - "type": "string" - }, - "IsEssential": { - "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.", - "type": "boolean" - } - }, - "required": [ - "ContactId", - "IsEssential" - ], - "type": "object" - }, - "Stage": { - "additionalProperties": false, - "description": "A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.", - "properties": { - "DurationInMinutes": { - "description": "The time to wait until beginning the next stage.", - "type": "integer" - }, - "Targets": { - "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Targets" - }, - "type": "array" - } - }, - "required": [ - "DurationInMinutes" - ], - "type": "object" - }, - "Targets": { - "additionalProperties": false, - "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", - "oneOf": [ - { - "required": [ - "ChannelTargetInfo" - ] - }, - { - "required": [ - "ContactTargetInfo" - ] - } - ], - "properties": { - "ChannelTargetInfo": { - "$ref": "#/definitions/ChannelTargetInfo" - }, - "ContactTargetInfo": { - "$ref": "#/definitions/ContactTargetInfo" - } - }, - "type": "object" - } - }, - "description": "Engagement Plan for a SSM Incident Manager Contact.", - "handlers": { - "create": { - "permissions": [ - "ssm-contacts:UpdateContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - }, - "delete": { - "permissions": [ - "ssm-contacts:UpdateContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - }, - "read": { - "permissions": [ - "ssm-contacts:GetContact" - ] - }, - "update": { - "permissions": [ - "ssm-contacts:UpdateContact", - "ssm-contacts:GetContact", - "ssm-contacts:AssociateContact" - ] - } - }, - "oneOf": [ - { - "required": [ - "ContactId", - "Stages" - ] - }, - { - "required": [ - "ContactId", - "RotationIds" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the contact.", - "type": "string" - }, - "ContactId": { - "description": "Contact ID for the AWS SSM Incident Manager Contact to associate the plan.", - "pattern": "arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*", - "type": "string" - }, - "RotationIds": { - "description": "Rotation Ids to associate with Oncall Contact for engagement.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Stages": { - "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Stage" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SSMContacts::Plan", - "writeOnlyProperties": [ - "/properties/RotationIds" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ContactId" + ], + "definitions": { + "ChannelTargetInfo": { + "additionalProperties": false, + "description": "Information about the contact channel that SSM Incident Manager uses to engage the contact.", + "properties": { + "ChannelId": { + "description": "The Amazon Resource Name (ARN) of the contact channel.", + "type": "string" + }, + "RetryIntervalInMinutes": { + "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails.", + "type": "integer" + } + }, + "required": [ + "ChannelId", + "RetryIntervalInMinutes" + ], + "type": "object" + }, + "ContactTargetInfo": { + "additionalProperties": false, + "description": "The contact that SSM Incident Manager is engaging during an incident.", + "properties": { + "ContactId": { + "description": "The Amazon Resource Name (ARN) of the contact.", + "type": "string" + }, + "IsEssential": { + "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.", + "type": "boolean" + } + }, + "required": [ + "ContactId", + "IsEssential" + ], + "type": "object" + }, + "Stage": { + "additionalProperties": false, + "description": "A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.", + "properties": { + "DurationInMinutes": { + "description": "The time to wait until beginning the next stage.", + "type": "integer" + }, + "Targets": { + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Targets" + }, + "type": "array" + } + }, + "required": [ + "DurationInMinutes" + ], + "type": "object" + }, + "Targets": { + "additionalProperties": false, + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging.", + "oneOf": [ + { + "required": [ + "ChannelTargetInfo" + ] + }, + { + "required": [ + "ContactTargetInfo" + ] + } + ], + "properties": { + "ChannelTargetInfo": { + "$ref": "#/definitions/ChannelTargetInfo" + }, + "ContactTargetInfo": { + "$ref": "#/definitions/ContactTargetInfo" + } + }, + "type": "object" + } + }, + "description": "Engagement Plan for a SSM Incident Manager Contact.", + "handlers": { + "create": { + "permissions": [ + "ssm-contacts:UpdateContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + }, + "delete": { + "permissions": [ + "ssm-contacts:UpdateContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + }, + "read": { + "permissions": [ + "ssm-contacts:GetContact" + ] + }, + "update": { + "permissions": [ + "ssm-contacts:UpdateContact", + "ssm-contacts:GetContact", + "ssm-contacts:AssociateContact" + ] + } + }, + "oneOf": [ + { + "required": [ + "ContactId", + "Stages" + ] + }, + { + "required": [ + "ContactId", + "RotationIds" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the contact.", + "type": "string" + }, + "ContactId": { + "description": "Contact ID for the AWS SSM Incident Manager Contact to associate the plan.", + "pattern": "arn:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]+:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*", + "type": "string" + }, + "RotationIds": { + "description": "Rotation Ids to associate with Oncall Contact for engagement.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Stages": { + "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Stage" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SSMContacts::Plan", + "writeOnlyProperties": [ + "/properties/RotationIds" + ] +} diff --git a/schema/aws-ssmcontacts-rotation.json b/schema/aws-ssmcontacts-rotation.json index 0bd5b06..5d39ff8 100644 --- a/schema/aws-ssmcontacts-rotation.json +++ b/schema/aws-ssmcontacts-rotation.json @@ -1,312 +1,312 @@ -{ - "additionalProperties": false, - "definitions": { - "CoverageTime": { - "additionalProperties": false, - "description": "StartTime and EndTime for the Shift", - "properties": { - "EndTime": { - "$ref": "#/definitions/HandOffTime" - }, - "StartTime": { - "$ref": "#/definitions/HandOffTime" - } - }, - "required": [ - "StartTime", - "EndTime" - ], - "type": "object" - }, - "DailySetting": { - "additionalProperties": false, - "description": "Handoff time for Daily Recurring Rotation.", - "properties": { - "HandOffTime": { - "$ref": "#/definitions/HandOffTime" - } - }, - "required": [ - "HandOffTime" - ], - "type": "object" - }, - "DayOfWeek": { - "description": "The day of the week when weekly recurring on-call shift rotations begin. ", - "enum": [ - "MON", - "TUE", - "WED", - "THU", - "FRI", - "SAT", - "SUN" - ], - "type": "string" - }, - "HandOffTime": { - "description": "Details about when an on-call rotation shift begins or ends. Time of the day in format HH:MM", - "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", - "type": "string" - }, - "MonthlySetting": { - "additionalProperties": false, - "description": "DayOfWeek for Month and HandOff Time for Monthly Recurring Rotation.", - "properties": { - "DayOfMonth": { - "description": "The day of the month when monthly recurring on-call rotations begin.", - "maximum": 31, - "minimum": 1, - "type": "integer" - }, - "HandOffTime": { - "$ref": "#/definitions/HandOffTime" - } - }, - "required": [ - "DayOfMonth", - "HandOffTime" - ], - "type": "object" - }, - "RecurrenceSettings": { - "additionalProperties": false, - "description": "Information about when an on-call rotation is in effect and how long the rotation period lasts.", - "oneOf": [ - { - "required": [ - "NumberOfOnCalls", - "RecurrenceMultiplier", - "WeeklySettings" - ] - }, - { - "required": [ - "NumberOfOnCalls", - "RecurrenceMultiplier", - "MonthlySettings" - ] - }, - { - "required": [ - "NumberOfOnCalls", - "RecurrenceMultiplier", - "DailySettings" - ] - } - ], - "properties": { - "DailySettings": { - "description": "Information about on-call rotations that recur daily.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HandOffTime" - }, - "type": "array" - }, - "MonthlySettings": { - "description": "Information about on-call rotations that recur monthly.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MonthlySetting" - }, - "type": "array" - }, - "NumberOfOnCalls": { - "description": "Number of Oncalls per shift.", - "minimum": 1, - "type": "integer" - }, - "RecurrenceMultiplier": { - "description": "The number of days, weeks, or months a single rotation lasts.", - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "ShiftCoverages": { - "description": "Information about the days of the week included in on-call rotation coverage.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ShiftCoverage" - }, - "type": "array" - }, - "WeeklySettings": { - "description": "Information about on-call rotations that recur weekly.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WeeklySetting" - }, - "type": "array" - } - }, - "type": "object" - }, - "ShiftCoverage": { - "additionalProperties": false, - "description": "Information about the days of the week included in on-call rotation coverage.", - "properties": { - "CoverageTimes": { - "description": "Information about when an on-call shift begins and ends.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CoverageTime" - }, - "type": "array" - }, - "DayOfWeek": { - "$ref": "#/definitions/DayOfWeek" - } - }, - "required": [ - "DayOfWeek", - "CoverageTimes" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WeeklySetting": { - "additionalProperties": false, - "description": "DayOfWeek for Rotation and HandOff Time for Weekly Recurring Rotation.", - "properties": { - "DayOfWeek": { - "$ref": "#/definitions/DayOfWeek" - }, - "HandOffTime": { - "$ref": "#/definitions/HandOffTime" - } - }, - "required": [ - "DayOfWeek", - "HandOffTime" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::SSMContacts::Rotation.", - "handlers": { - "create": { - "permissions": [ - "ssm-contacts:CreateRotation", - "ssm-contacts:GetRotation", - "ssm-contacts:TagResource", - "ssm-contacts:ListTagsForResource", - "ssm-contacts:UntagResource" - ] - }, - "delete": { - "permissions": [ - "ssm-contacts:DeleteRotation", - "ssm-contacts:GetRotation", - "ssm-contacts:ListTagsForResource", - "ssm-contacts:UntagResource" - ] - }, - "list": { - "permissions": [ - "ssm-contacts:ListRotations", - "ssm-contacts:GetRotation", - "ssm-contacts:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "ssm-contacts:GetRotation", - "ssm-contacts:TagResource", - "ssm-contacts:ListTagsForResource", - "ssm-contacts:UntagResource" - ] - }, - "update": { - "permissions": [ - "ssm-contacts:UpdateRotation", - "ssm-contacts:GetRotation", - "ssm-contacts:TagResource", - "ssm-contacts:ListTagsForResource", - "ssm-contacts:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The Amazon Resource Name (ARN) of the rotation.", - "type": "string" - }, - "ContactIds": { - "description": "Members of the rotation", - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "description": "Name of the Rotation", - "pattern": "^[a-zA-Z0-9_]*$", - "type": "string" - }, - "Recurrence": { - "$ref": "#/definitions/RecurrenceSettings" - }, - "StartTime": { - "description": "Start time of the first shift of Oncall Schedule", - "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TimeZoneId": { - "description": "TimeZone Identifier for the Oncall Schedule", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "ContactIds", - "StartTime", - "TimeZoneId", - "Recurrence" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::SSMContacts::Rotation" -} +{ + "additionalProperties": false, + "definitions": { + "CoverageTime": { + "additionalProperties": false, + "description": "StartTime and EndTime for the Shift", + "properties": { + "EndTime": { + "$ref": "#/definitions/HandOffTime" + }, + "StartTime": { + "$ref": "#/definitions/HandOffTime" + } + }, + "required": [ + "StartTime", + "EndTime" + ], + "type": "object" + }, + "DailySetting": { + "additionalProperties": false, + "description": "Handoff time for Daily Recurring Rotation.", + "properties": { + "HandOffTime": { + "$ref": "#/definitions/HandOffTime" + } + }, + "required": [ + "HandOffTime" + ], + "type": "object" + }, + "DayOfWeek": { + "description": "The day of the week when weekly recurring on-call shift rotations begin. ", + "enum": [ + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "SUN" + ], + "type": "string" + }, + "HandOffTime": { + "description": "Details about when an on-call rotation shift begins or ends. Time of the day in format HH:MM", + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + }, + "MonthlySetting": { + "additionalProperties": false, + "description": "DayOfWeek for Month and HandOff Time for Monthly Recurring Rotation.", + "properties": { + "DayOfMonth": { + "description": "The day of the month when monthly recurring on-call rotations begin.", + "maximum": 31, + "minimum": 1, + "type": "integer" + }, + "HandOffTime": { + "$ref": "#/definitions/HandOffTime" + } + }, + "required": [ + "DayOfMonth", + "HandOffTime" + ], + "type": "object" + }, + "RecurrenceSettings": { + "additionalProperties": false, + "description": "Information about when an on-call rotation is in effect and how long the rotation period lasts.", + "oneOf": [ + { + "required": [ + "NumberOfOnCalls", + "RecurrenceMultiplier", + "WeeklySettings" + ] + }, + { + "required": [ + "NumberOfOnCalls", + "RecurrenceMultiplier", + "MonthlySettings" + ] + }, + { + "required": [ + "NumberOfOnCalls", + "RecurrenceMultiplier", + "DailySettings" + ] + } + ], + "properties": { + "DailySettings": { + "description": "Information about on-call rotations that recur daily.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HandOffTime" + }, + "type": "array" + }, + "MonthlySettings": { + "description": "Information about on-call rotations that recur monthly.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MonthlySetting" + }, + "type": "array" + }, + "NumberOfOnCalls": { + "description": "Number of Oncalls per shift.", + "minimum": 1, + "type": "integer" + }, + "RecurrenceMultiplier": { + "description": "The number of days, weeks, or months a single rotation lasts.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "ShiftCoverages": { + "description": "Information about the days of the week included in on-call rotation coverage.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ShiftCoverage" + }, + "type": "array" + }, + "WeeklySettings": { + "description": "Information about on-call rotations that recur weekly.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WeeklySetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "ShiftCoverage": { + "additionalProperties": false, + "description": "Information about the days of the week included in on-call rotation coverage.", + "properties": { + "CoverageTimes": { + "description": "Information about when an on-call shift begins and ends.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CoverageTime" + }, + "type": "array" + }, + "DayOfWeek": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "required": [ + "DayOfWeek", + "CoverageTimes" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WeeklySetting": { + "additionalProperties": false, + "description": "DayOfWeek for Rotation and HandOff Time for Weekly Recurring Rotation.", + "properties": { + "DayOfWeek": { + "$ref": "#/definitions/DayOfWeek" + }, + "HandOffTime": { + "$ref": "#/definitions/HandOffTime" + } + }, + "required": [ + "DayOfWeek", + "HandOffTime" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SSMContacts::Rotation.", + "handlers": { + "create": { + "permissions": [ + "ssm-contacts:CreateRotation", + "ssm-contacts:GetRotation", + "ssm-contacts:TagResource", + "ssm-contacts:ListTagsForResource", + "ssm-contacts:UntagResource" + ] + }, + "delete": { + "permissions": [ + "ssm-contacts:DeleteRotation", + "ssm-contacts:GetRotation", + "ssm-contacts:ListTagsForResource", + "ssm-contacts:UntagResource" + ] + }, + "list": { + "permissions": [ + "ssm-contacts:ListRotations", + "ssm-contacts:GetRotation", + "ssm-contacts:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ssm-contacts:GetRotation", + "ssm-contacts:TagResource", + "ssm-contacts:ListTagsForResource", + "ssm-contacts:UntagResource" + ] + }, + "update": { + "permissions": [ + "ssm-contacts:UpdateRotation", + "ssm-contacts:GetRotation", + "ssm-contacts:TagResource", + "ssm-contacts:ListTagsForResource", + "ssm-contacts:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the rotation.", + "type": "string" + }, + "ContactIds": { + "description": "Members of the rotation", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Name": { + "description": "Name of the Rotation", + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string" + }, + "Recurrence": { + "$ref": "#/definitions/RecurrenceSettings" + }, + "StartTime": { + "description": "Start time of the first shift of Oncall Schedule", + "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TimeZoneId": { + "description": "TimeZone Identifier for the Oncall Schedule", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "ContactIds", + "StartTime", + "TimeZoneId", + "Recurrence" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::SSMContacts::Rotation" +} diff --git a/schema/aws-ssmincidents-replicationset.json b/schema/aws-ssmincidents-replicationset.json index 07a78be..0f290db 100644 --- a/schema/aws-ssmincidents-replicationset.json +++ b/schema/aws-ssmincidents-replicationset.json @@ -1,164 +1,164 @@ -{ - "additionalProperties": false, - "definitions": { - "Arn": { - "description": "The ARN of the ReplicationSet.", - "maxLength": 1000, - "pattern": "^arn:aws(-(cn|us-gov|iso(-b)?))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "DeletionProtected": { - "description": "Configures the ReplicationSet deletion protection.", - "type": "boolean" - }, - "RegionConfiguration": { - "additionalProperties": false, - "description": "The ReplicationSet regional configuration.", - "properties": { - "SseKmsKeyId": { - "$ref": "#/definitions/Arn" - } - }, - "required": [ - "SseKmsKeyId" - ], - "type": "object" - }, - "RegionList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ReplicationRegion" - }, - "maxItems": 3, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "RegionName": { - "description": "The AWS region name.", - "maxLength": 20, - "type": "string" - }, - "ReplicationRegion": { - "additionalProperties": false, - "description": "The ReplicationSet regional configuration.", - "properties": { - "RegionConfiguration": { - "$ref": "#/definitions/RegionConfiguration" - }, - "RegionName": { - "$ref": "#/definitions/RegionName" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to tag a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::SSMIncidents::ReplicationSet", - "handlers": { - "create": { - "permissions": [ - "ssm-incidents:CreateReplicationSet", - "ssm-incidents:ListReplicationSets", - "ssm-incidents:UpdateDeletionProtection", - "ssm-incidents:GetReplicationSet", - "ssm-incidents:TagResource", - "ssm-incidents:ListTagsForResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "ssm-incidents:DeleteReplicationSet", - "ssm-incidents:GetReplicationSet" - ] - }, - "list": { - "permissions": [ - "ssm-incidents:ListReplicationSets" - ] - }, - "read": { - "permissions": [ - "ssm-incidents:ListReplicationSets", - "ssm-incidents:GetReplicationSet", - "ssm-incidents:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ssm-incidents:UpdateReplicationSet", - "ssm-incidents:UpdateDeletionProtection", - "ssm-incidents:GetReplicationSet", - "ssm-incidents:TagResource", - "ssm-incidents:UntagResource", - "ssm-incidents:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn", - "additionalProperties": false, - "description": "The ARN of the ReplicationSet." - }, - "DeletionProtected": { - "$ref": "#/definitions/DeletionProtected", - "default": false - }, - "Regions": { - "$ref": "#/definitions/RegionList", - "description": "The ReplicationSet configuration." - }, - "Tags": { - "default": [], - "description": "The tags to apply to the replication set.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Regions" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSMIncidents::ReplicationSet" -} +{ + "additionalProperties": false, + "definitions": { + "Arn": { + "description": "The ARN of the ReplicationSet.", + "maxLength": 1000, + "pattern": "^arn:aws(-(cn|us-gov|iso(-b)?))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "DeletionProtected": { + "description": "Configures the ReplicationSet deletion protection.", + "type": "boolean" + }, + "RegionConfiguration": { + "additionalProperties": false, + "description": "The ReplicationSet regional configuration.", + "properties": { + "SseKmsKeyId": { + "$ref": "#/definitions/Arn" + } + }, + "required": [ + "SseKmsKeyId" + ], + "type": "object" + }, + "RegionList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ReplicationRegion" + }, + "maxItems": 3, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RegionName": { + "description": "The AWS region name.", + "maxLength": 20, + "type": "string" + }, + "ReplicationRegion": { + "additionalProperties": false, + "description": "The ReplicationSet regional configuration.", + "properties": { + "RegionConfiguration": { + "$ref": "#/definitions/RegionConfiguration" + }, + "RegionName": { + "$ref": "#/definitions/RegionName" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to tag a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::SSMIncidents::ReplicationSet", + "handlers": { + "create": { + "permissions": [ + "ssm-incidents:CreateReplicationSet", + "ssm-incidents:ListReplicationSets", + "ssm-incidents:UpdateDeletionProtection", + "ssm-incidents:GetReplicationSet", + "ssm-incidents:TagResource", + "ssm-incidents:ListTagsForResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ssm-incidents:DeleteReplicationSet", + "ssm-incidents:GetReplicationSet" + ] + }, + "list": { + "permissions": [ + "ssm-incidents:ListReplicationSets" + ] + }, + "read": { + "permissions": [ + "ssm-incidents:ListReplicationSets", + "ssm-incidents:GetReplicationSet", + "ssm-incidents:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ssm-incidents:UpdateReplicationSet", + "ssm-incidents:UpdateDeletionProtection", + "ssm-incidents:GetReplicationSet", + "ssm-incidents:TagResource", + "ssm-incidents:UntagResource", + "ssm-incidents:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn", + "additionalProperties": false, + "description": "The ARN of the ReplicationSet." + }, + "DeletionProtected": { + "$ref": "#/definitions/DeletionProtected", + "default": false + }, + "Regions": { + "$ref": "#/definitions/RegionList", + "description": "The ReplicationSet configuration." + }, + "Tags": { + "default": [], + "description": "The tags to apply to the replication set.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Regions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSMIncidents::ReplicationSet" +} diff --git a/schema/aws-ssmincidents-responseplan.json b/schema/aws-ssmincidents-responseplan.json index a7fcd6f..227ec97 100644 --- a/schema/aws-ssmincidents-responseplan.json +++ b/schema/aws-ssmincidents-responseplan.json @@ -1,461 +1,461 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "description": "The automation configuration to launch.", - "properties": { - "SsmAutomation": { - "$ref": "#/definitions/SsmAutomation" - } - }, - "type": "object" - }, - "ChatChannel": { - "additionalProperties": false, - "description": "The chat channel configuration.", - "properties": { - "ChatbotSns": { - "$ref": "#/definitions/ChatbotSns" - } - }, - "type": "object" - }, - "ChatbotSns": { - "default": [], - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SnsArn" - }, - "type": "array", - "uniqueItems": true - }, - "DynamicSsmParameter": { - "additionalProperties": false, - "description": "A parameter with a dynamic value to set when starting the SSM automation document.", - "properties": { - "Key": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Value": { - "$ref": "#/definitions/DynamicSsmParameterValue" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "DynamicSsmParameterValue": { - "additionalProperties": false, - "description": "Value of the dynamic parameter to set when starting the SSM automation document.", - "properties": { - "Variable": { - "$ref": "#/definitions/VariableType" - } - }, - "type": "object" - }, - "IncidentTemplate": { - "additionalProperties": false, - "description": "The incident template configuration.", - "properties": { - "DedupeString": { - "description": "The deduplication string.", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "Impact": { - "description": "The impact value.", - "maximum": 5, - "minimum": 1, - "type": "integer" - }, - "IncidentTags": { - "default": [], - "description": "Tags that get applied to incidents created by the StartIncident API action.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "NotificationTargets": { - "default": [], - "description": "The list of notification targets.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NotificationTargetItem" - }, - "maxItems": 10, - "type": "array" - }, - "Summary": { - "description": "The summary string.", - "maxLength": 4000, - "minLength": 1, - "type": "string" - }, - "Title": { - "description": "The title string.", - "maxLength": 200, - "type": "string" - } - }, - "required": [ - "Title", - "Impact" - ], - "type": "object" - }, - "Integration": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "PagerDutyConfiguration" - ] - } - ], - "properties": { - "PagerDutyConfiguration": { - "$ref": "#/definitions/PagerDutyConfiguration" - } - }, - "type": "object" - }, - "NotificationTargetItem": { - "additionalProperties": false, - "description": "A notification target.", - "properties": { - "SnsTopicArn": { - "$ref": "#/definitions/SnsArn" - } - }, - "type": "object" - }, - "PagerDutyConfiguration": { - "additionalProperties": false, - "description": "The pagerDuty configuration to use when starting the incident.", - "properties": { - "Name": { - "description": "The name of the pagerDuty configuration.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "PagerDutyIncidentConfiguration": { - "$ref": "#/definitions/PagerDutyIncidentConfiguration" - }, - "SecretId": { - "description": "The AWS secrets manager secretId storing the pagerDuty token.", - "maxLength": 512, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Name", - "SecretId", - "PagerDutyIncidentConfiguration" - ], - "type": "object" - }, - "PagerDutyIncidentConfiguration": { - "additionalProperties": false, - "description": "The pagerDuty incident configuration.", - "properties": { - "ServiceId": { - "description": "The pagerDuty serviceId.", - "maxLength": 200, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "ServiceId" - ], - "type": "object" - }, - "SSMContact": { - "description": "The ARN of the contact.", - "maxLength": 1000, - "pattern": "^arn:aws(-(cn|us-gov))?:ssm-contacts:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "SnsArn": { - "description": "The ARN of the Chatbot SNS topic.", - "maxLength": 1000, - "pattern": "^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "SsmAutomation": { - "additionalProperties": false, - "description": "The configuration to use when starting the SSM automation document.", - "properties": { - "DocumentName": { - "description": "The document name to use when starting the SSM automation document.", - "maxLength": 128, - "type": "string" - }, - "DocumentVersion": { - "description": "The version of the document to use when starting the SSM automation document.", - "maxLength": 128, - "type": "string" - }, - "DynamicParameters": { - "default": [], - "description": "The parameters with dynamic values to set when starting the SSM automation document.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DynamicSsmParameter" - }, - "maxItems": 200, - "type": "array", - "uniqueItems": true - }, - "Parameters": { - "default": [], - "description": "The parameters to set when starting the SSM automation document.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SsmParameter" - }, - "maxItems": 200, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "RoleArn": { - "description": "The role ARN to use when starting the SSM automation document.", - "maxLength": 1000, - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "TargetAccount": { - "description": "The account type to use when starting the SSM automation document.", - "enum": [ - "IMPACTED_ACCOUNT", - "RESPONSE_PLAN_OWNER_ACCOUNT" - ], - "type": "string" - } - }, - "required": [ - "RoleArn", - "DocumentName" - ], - "type": "object" - }, - "SsmParameter": { - "additionalProperties": false, - "description": "A parameter to set when starting the SSM automation document.", - "properties": { - "Key": { - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "Values": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/SsmParameterValue" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "Values", - "Key" - ], - "type": "object" - }, - "SsmParameterValue": { - "description": "A value of the parameter to set when starting the SSM automation document.", - "maxLength": 10000, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to tag a resource.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VariableType": { - "description": "The variable types used as dynamic parameter value when starting the SSM automation document.", - "enum": [ - "INCIDENT_RECORD_ARN", - "INVOLVED_RESOURCES" - ], - "type": "string" - } - }, - "description": "Resource type definition for AWS::SSMIncidents::ResponsePlan", - "handlers": { - "create": { - "permissions": [ - "ssm-incidents:CreateResponsePlan", - "ssm-incidents:GetResponsePlan", - "ssm-incidents:TagResource", - "ssm-incidents:ListTagsForResource", - "iam:PassRole", - "secretsmanager:GetSecretValue", - "kms:Decrypt", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext" - ] - }, - "delete": { - "permissions": [ - "ssm-incidents:DeleteResponsePlan", - "ssm-incidents:GetResponsePlan" - ] - }, - "list": { - "permissions": [ - "ssm-incidents:ListResponsePlans" - ] - }, - "read": { - "permissions": [ - "ssm-incidents:GetResponsePlan", - "ssm-incidents:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ssm-incidents:UpdateResponsePlan", - "ssm-incidents:GetResponsePlan", - "ssm-incidents:TagResource", - "ssm-incidents:UntagResource", - "ssm-incidents:ListTagsForResource", - "iam:PassRole", - "secretsmanager:GetSecretValue", - "kms:Decrypt", - "kms:GenerateDataKey", - "kms:GenerateDataKeyPair", - "kms:GenerateDataKeyPairWithoutPlaintext", - "kms:GenerateDataKeyWithoutPlaintext" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Actions": { - "default": [], - "description": "The list of actions.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Action" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "Arn": { - "description": "The ARN of the response plan.", - "maxLength": 1000, - "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", - "type": "string" - }, - "ChatChannel": { - "$ref": "#/definitions/ChatChannel" - }, - "DisplayName": { - "description": "The display name of the response plan.", - "maxLength": 200, - "minLength": 1, - "type": "string" - }, - "Engagements": { - "default": [], - "description": "The list of engagements to use.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SSMContact" - }, - "maxItems": 5, - "type": "array", - "uniqueItems": true - }, - "IncidentTemplate": { - "$ref": "#/definitions/IncidentTemplate" - }, - "Integrations": { - "default": [], - "description": "The list of integrations.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Integration" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "Name": { - "description": "The name of the response plan.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_-]*$", - "type": "string" - }, - "Tags": { - "default": [], - "description": "The tags to apply to the response plan.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name", - "IncidentTemplate" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSMIncidents::ResponsePlan" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "description": "The automation configuration to launch.", + "properties": { + "SsmAutomation": { + "$ref": "#/definitions/SsmAutomation" + } + }, + "type": "object" + }, + "ChatChannel": { + "additionalProperties": false, + "description": "The chat channel configuration.", + "properties": { + "ChatbotSns": { + "$ref": "#/definitions/ChatbotSns" + } + }, + "type": "object" + }, + "ChatbotSns": { + "default": [], + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SnsArn" + }, + "type": "array", + "uniqueItems": true + }, + "DynamicSsmParameter": { + "additionalProperties": false, + "description": "A parameter with a dynamic value to set when starting the SSM automation document.", + "properties": { + "Key": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DynamicSsmParameterValue" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "DynamicSsmParameterValue": { + "additionalProperties": false, + "description": "Value of the dynamic parameter to set when starting the SSM automation document.", + "properties": { + "Variable": { + "$ref": "#/definitions/VariableType" + } + }, + "type": "object" + }, + "IncidentTemplate": { + "additionalProperties": false, + "description": "The incident template configuration.", + "properties": { + "DedupeString": { + "description": "The deduplication string.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Impact": { + "description": "The impact value.", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, + "IncidentTags": { + "default": [], + "description": "Tags that get applied to incidents created by the StartIncident API action.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "NotificationTargets": { + "default": [], + "description": "The list of notification targets.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NotificationTargetItem" + }, + "maxItems": 10, + "type": "array" + }, + "Summary": { + "description": "The summary string.", + "maxLength": 4000, + "minLength": 1, + "type": "string" + }, + "Title": { + "description": "The title string.", + "maxLength": 200, + "type": "string" + } + }, + "required": [ + "Title", + "Impact" + ], + "type": "object" + }, + "Integration": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "PagerDutyConfiguration" + ] + } + ], + "properties": { + "PagerDutyConfiguration": { + "$ref": "#/definitions/PagerDutyConfiguration" + } + }, + "type": "object" + }, + "NotificationTargetItem": { + "additionalProperties": false, + "description": "A notification target.", + "properties": { + "SnsTopicArn": { + "$ref": "#/definitions/SnsArn" + } + }, + "type": "object" + }, + "PagerDutyConfiguration": { + "additionalProperties": false, + "description": "The pagerDuty configuration to use when starting the incident.", + "properties": { + "Name": { + "description": "The name of the pagerDuty configuration.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "PagerDutyIncidentConfiguration": { + "$ref": "#/definitions/PagerDutyIncidentConfiguration" + }, + "SecretId": { + "description": "The AWS secrets manager secretId storing the pagerDuty token.", + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Name", + "SecretId", + "PagerDutyIncidentConfiguration" + ], + "type": "object" + }, + "PagerDutyIncidentConfiguration": { + "additionalProperties": false, + "description": "The pagerDuty incident configuration.", + "properties": { + "ServiceId": { + "description": "The pagerDuty serviceId.", + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ServiceId" + ], + "type": "object" + }, + "SSMContact": { + "description": "The ARN of the contact.", + "maxLength": 1000, + "pattern": "^arn:aws(-(cn|us-gov))?:ssm-contacts:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "SnsArn": { + "description": "The ARN of the Chatbot SNS topic.", + "maxLength": 1000, + "pattern": "^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "SsmAutomation": { + "additionalProperties": false, + "description": "The configuration to use when starting the SSM automation document.", + "properties": { + "DocumentName": { + "description": "The document name to use when starting the SSM automation document.", + "maxLength": 128, + "type": "string" + }, + "DocumentVersion": { + "description": "The version of the document to use when starting the SSM automation document.", + "maxLength": 128, + "type": "string" + }, + "DynamicParameters": { + "default": [], + "description": "The parameters with dynamic values to set when starting the SSM automation document.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DynamicSsmParameter" + }, + "maxItems": 200, + "type": "array", + "uniqueItems": true + }, + "Parameters": { + "default": [], + "description": "The parameters to set when starting the SSM automation document.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SsmParameter" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RoleArn": { + "description": "The role ARN to use when starting the SSM automation document.", + "maxLength": 1000, + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "TargetAccount": { + "description": "The account type to use when starting the SSM automation document.", + "enum": [ + "IMPACTED_ACCOUNT", + "RESPONSE_PLAN_OWNER_ACCOUNT" + ], + "type": "string" + } + }, + "required": [ + "RoleArn", + "DocumentName" + ], + "type": "object" + }, + "SsmParameter": { + "additionalProperties": false, + "description": "A parameter to set when starting the SSM automation document.", + "properties": { + "Key": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "Values": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SsmParameterValue" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Values", + "Key" + ], + "type": "object" + }, + "SsmParameterValue": { + "description": "A value of the parameter to set when starting the SSM automation document.", + "maxLength": 10000, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to tag a resource.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VariableType": { + "description": "The variable types used as dynamic parameter value when starting the SSM automation document.", + "enum": [ + "INCIDENT_RECORD_ARN", + "INVOLVED_RESOURCES" + ], + "type": "string" + } + }, + "description": "Resource type definition for AWS::SSMIncidents::ResponsePlan", + "handlers": { + "create": { + "permissions": [ + "ssm-incidents:CreateResponsePlan", + "ssm-incidents:GetResponsePlan", + "ssm-incidents:TagResource", + "ssm-incidents:ListTagsForResource", + "iam:PassRole", + "secretsmanager:GetSecretValue", + "kms:Decrypt", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext" + ] + }, + "delete": { + "permissions": [ + "ssm-incidents:DeleteResponsePlan", + "ssm-incidents:GetResponsePlan" + ] + }, + "list": { + "permissions": [ + "ssm-incidents:ListResponsePlans" + ] + }, + "read": { + "permissions": [ + "ssm-incidents:GetResponsePlan", + "ssm-incidents:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ssm-incidents:UpdateResponsePlan", + "ssm-incidents:GetResponsePlan", + "ssm-incidents:TagResource", + "ssm-incidents:UntagResource", + "ssm-incidents:ListTagsForResource", + "iam:PassRole", + "secretsmanager:GetSecretValue", + "kms:Decrypt", + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Actions": { + "default": [], + "description": "The list of actions.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Action" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "description": "The ARN of the response plan.", + "maxLength": 1000, + "pattern": "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$", + "type": "string" + }, + "ChatChannel": { + "$ref": "#/definitions/ChatChannel" + }, + "DisplayName": { + "description": "The display name of the response plan.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Engagements": { + "default": [], + "description": "The list of engagements to use.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SSMContact" + }, + "maxItems": 5, + "type": "array", + "uniqueItems": true + }, + "IncidentTemplate": { + "$ref": "#/definitions/IncidentTemplate" + }, + "Integrations": { + "default": [], + "description": "The list of integrations.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Integration" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "Name": { + "description": "The name of the response plan.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + }, + "Tags": { + "default": [], + "description": "The tags to apply to the response plan.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name", + "IncidentTemplate" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSMIncidents::ResponsePlan" +} diff --git a/schema/aws-ssmquicksetup-configurationmanager.json b/schema/aws-ssmquicksetup-configurationmanager.json new file mode 100644 index 0000000..9e8ddb4 --- /dev/null +++ b/schema/aws-ssmquicksetup-configurationmanager.json @@ -0,0 +1,325 @@ +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConfigurationDefinitions/*/Type", + "/properties/ConfigurationDefinitions/*/TypeVersion" + ], + "definitions": { + "ConfigurationDefinition": { + "additionalProperties": false, + "properties": { + "LocalDeploymentAdministrationRoleArn": { + "type": "string" + }, + "LocalDeploymentExecutionRoleName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/ConfigurationParametersMap" + }, + "Type": { + "pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "type": "string" + }, + "TypeVersion": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "Parameters", + "Type" + ], + "type": "object" + }, + "ConfigurationParametersMap": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9+=@_\\/\\s-]+$": { + "maxLength": 40960, + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "enum": [ + "INITIALIZING", + "DEPLOYING", + "SUCCEEDED", + "DELETING", + "STOPPING", + "FAILED", + "STOPPED", + "DELETE_FAILED", + "STOP_FAILED", + "NONE" + ], + "type": "string" + }, + "StatusDetails": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "StatusSummary": { + "additionalProperties": false, + "properties": { + "LastUpdatedAt": { + "type": "string" + }, + "Status": { + "$ref": "#/definitions/Status" + }, + "StatusDetails": { + "$ref": "#/definitions/StatusDetails" + }, + "StatusMessage": { + "type": "string" + }, + "StatusType": { + "$ref": "#/definitions/StatusType" + } + }, + "required": [ + "LastUpdatedAt", + "StatusType" + ], + "type": "object" + }, + "StatusType": { + "enum": [ + "Deployment", + "AsyncExecutions" + ], + "type": "string" + }, + "TagsMap": { + "additionalProperties": false, + "patternProperties": { + "^[A-Za-z0-9+=@_\\/-:]+$": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[A-Za-z0-9+=@_\\/-:]+$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::SSMQuickSetup::ConfigurationManager Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "iam:PassRole", + "ssm-quicksetup:CreateConfigurationManager", + "ssm-quicksetup:GetConfigurationManager", + "ssm-quicksetup:TagResource", + "ssm-quicksetup:UntagResource", + "ssm-quicksetup:UpdateConfigurationManager", + "ssm:Describe*", + "ssm:Get*", + "ssm:List*", + "ssm:DeleteAssociation", + "ssm:CreateResourceDataSync", + "ssm:UpdateResourceDataSync", + "ssm:StartAutomationExecution", + "ssm:CreateAssociation", + "ssm:StartAssociationsOnce", + "cloudformation:List*", + "cloudformation:Describe*", + "cloudformation:CreateStack", + "cloudformation:CreateStackInstances", + "cloudformation:CreateStackSet", + "cloudformation:DeleteStack", + "cloudformation:DeleteStackInstances", + "cloudformation:DeleteStackSet", + "cloudformation:UpdateStack", + "cloudformation:UpdateStackSet", + "cloudformation:StopStackSetOperation", + "cloudformation:GetTemplate", + "cloudformation:RollbackStack", + "cloudformation:TagResource", + "cloudformation:UntagResource", + "organizations:Describe*", + "organizations:List*", + "organizations:RegisterDelegatedAdministrator", + "organizations:DeregisterDelegatedAdministrator", + "organizations:EnableAWSServiceAccess" + ] + }, + "delete": { + "permissions": [ + "ssm-quicksetup:DeleteConfigurationManager", + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "iam:PassRole", + "ssm-quicksetup:GetConfigurationManager", + "ssm-quicksetup:ListConfigurationManagers", + "ssm-quicksetup:TagResource", + "ssm-quicksetup:UntagResource", + "ssm-quicksetup:UpdateConfigurationManager", + "ssm:Describe*", + "ssm:Get*", + "ssm:List*", + "ssm:DeleteAssociation", + "ssm:CreateResourceDataSync", + "ssm:UpdateResourceDataSync", + "ssm:StartAutomationExecution", + "ssm:CreateAssociation", + "ssm:StartAssociationsOnce", + "cloudformation:List*", + "cloudformation:Describe*", + "cloudformation:CreateStack", + "cloudformation:CreateStackInstances", + "cloudformation:CreateStackSet", + "cloudformation:DeleteStack", + "cloudformation:DeleteStackInstances", + "cloudformation:DeleteStackSet", + "cloudformation:UpdateStack", + "cloudformation:UpdateStackSet", + "cloudformation:StopStackSetOperation", + "cloudformation:GetTemplate", + "cloudformation:RollbackStack", + "cloudformation:TagResource", + "cloudformation:UntagResource", + "organizations:Describe*", + "organizations:List*", + "organizations:RegisterDelegatedAdministrator", + "organizations:DeregisterDelegatedAdministrator", + "organizations:EnableAWSServiceAccess" + ] + }, + "list": { + "permissions": [ + "ssm-quicksetup:ListConfigurationManagers" + ] + }, + "read": { + "permissions": [ + "ssm-quicksetup:GetConfigurationManager", + "iam:GetRole", + "iam:PassRole", + "iam:ListRoles", + "ssm:DescribeDocument", + "ssm:GetDocument" + ] + }, + "update": { + "permissions": [ + "iam:GetRole", + "iam:CreateServiceLinkedRole", + "iam:ListRoles", + "iam:PassRole", + "ssm-quicksetup:GetConfigurationManager", + "ssm-quicksetup:TagResource", + "ssm-quicksetup:UntagResource", + "ssm-quicksetup:UpdateConfigurationManager", + "ssm-quicksetup:UpdateConfigurationDefinition", + "ssm:Describe*", + "ssm:Get*", + "ssm:List*", + "ssm:DeleteAssociation", + "ssm:CreateResourceDataSync", + "ssm:UpdateResourceDataSync", + "ssm:StartAutomationExecution", + "ssm:CreateAssociation", + "ssm:StartAssociationsOnce", + "cloudformation:List*", + "cloudformation:Describe*", + "cloudformation:CreateStack", + "cloudformation:CreateStackInstances", + "cloudformation:CreateStackSet", + "cloudformation:DeleteStack", + "cloudformation:DeleteStackInstances", + "cloudformation:DeleteStackSet", + "cloudformation:UpdateStack", + "cloudformation:UpdateStackSet", + "cloudformation:StopStackSetOperation", + "cloudformation:GetTemplate", + "cloudformation:RollbackStack", + "cloudformation:TagResource", + "cloudformation:UntagResource", + "organizations:Describe*", + "organizations:List*", + "organizations:RegisterDelegatedAdministrator", + "organizations:DeregisterDelegatedAdministrator", + "organizations:EnableAWSServiceAccess" + ] + } + }, + "primaryIdentifier": [ + "/properties/ManagerArn" + ], + "properties": { + "ConfigurationDefinitions": { + "items": { + "$ref": "#/definitions/ConfigurationDefinition" + }, + "type": "array" + }, + "CreatedAt": { + "type": "string" + }, + "Description": { + "pattern": "^.{0,512}$", + "type": "string" + }, + "LastModifiedAt": { + "type": "string" + }, + "ManagerArn": { + "type": "string" + }, + "Name": { + "pattern": "^[ A-Za-z0-9_-]{1,50}$", + "type": "string" + }, + "StatusSummaries": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/StatusSummary" + }, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/LastModifiedAt", + "/properties/ManagerArn", + "/properties/StatusSummaries", + "/properties/ConfigurationDefinitions/*/id" + ], + "required": [ + "ConfigurationDefinitions" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "ssm-quicksetup:TagResource", + "ssm-quicksetup:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSMQuickSetup::ConfigurationManager" +} diff --git a/schema/aws-sso-application.json b/schema/aws-sso-application.json index cf91eed..7bdeb2e 100644 --- a/schema/aws-sso-application.json +++ b/schema/aws-sso-application.json @@ -1,200 +1,200 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn", - "/properties/ApplicationProviderArn" - ], - "definitions": { - "PortalOptionsConfiguration": { - "additionalProperties": false, - "description": "A structure that describes the options for the access portal associated with an application", - "properties": { - "SignInOptions": { - "$ref": "#/definitions/SignInOptions", - "description": "A structure that describes the sign-in options for the access portal" - }, - "Visibility": { - "description": "Indicates whether this application is visible in the access portal", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - } - }, - "required": [], - "type": "object" - }, - "SignInOptions": { - "additionalProperties": false, - "description": "A structure that describes the sign-in options for an application portal", - "properties": { - "ApplicationUrl": { - "description": "The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION", - "maxLength": 512, - "minLength": 1, - "pattern": "^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$", - "type": "string" - }, - "Origin": { - "description": "This determines how IAM Identity Center navigates the user to the target application", - "enum": [ - "IDENTITY_CENTER", - "APPLICATION" - ], - "type": "string" - } - }, - "required": [ - "Origin" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to the Identity Center (SSO) Application to help you categorize and organize them.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\w+=,.@-]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^[\\w+=,.@-]+$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for Identity Center (SSO) Application", - "handlers": { - "create": { - "permissions": [ - "sso:CreateApplication", - "sso:DescribeApplication", - "sso:TagResource" - ] - }, - "delete": { - "permissions": [ - "sso:DeleteApplication" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "InstanceArn": { - "$ref": "resource-schema.json#/properties/InstanceArn" - } - }, - "required": [ - "InstanceArn" - ] - }, - "permissions": [ - "sso:ListApplications" - ] - }, - "read": { - "permissions": [ - "sso:DescribeApplication", - "sso:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "sso:UpdateApplication", - "sso:TagResource", - "sso:UntagResource", - "sso:ListTagsForResource", - "sso:DescribeApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn" - ], - "properties": { - "ApplicationArn": { - "description": "The Application ARN that is returned upon creation of the Identity Center (SSO) Application", - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$", - "type": "string" - }, - "ApplicationProviderArn": { - "description": "The ARN of the application provider under which the operation will run", - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$", - "type": "string" - }, - "Description": { - "description": "The description information for the Identity Center (SSO) Application", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "InstanceArn": { - "description": "The ARN of the instance of IAM Identity Center under which the operation will run", - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", - "type": "string" - }, - "Name": { - "description": "The name you want to assign to this Identity Center (SSO) Application", - "maxLength": 255, - "minLength": 0, - "pattern": "^[\\w+=,.@-]+$", - "type": "string" - }, - "PortalOptions": { - "$ref": "#/definitions/PortalOptionsConfiguration", - "description": "A structure that describes the options for the portal associated with an application" - }, - "Status": { - "description": "Specifies whether the application is enabled or disabled", - "enum": [ - "ENABLED", - "DISABLED" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag", - "description": "Specifies tags to be attached to the application" - }, - "maxItems": 75, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ApplicationArn" - ], - "required": [ - "Name", - "InstanceArn", - "ApplicationProviderArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-application", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSO::Application" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/ApplicationProviderArn" + ], + "definitions": { + "PortalOptionsConfiguration": { + "additionalProperties": false, + "description": "A structure that describes the options for the access portal associated with an application", + "properties": { + "SignInOptions": { + "$ref": "#/definitions/SignInOptions", + "description": "A structure that describes the sign-in options for the access portal" + }, + "Visibility": { + "description": "Indicates whether this application is visible in the access portal", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "SignInOptions": { + "additionalProperties": false, + "description": "A structure that describes the sign-in options for an application portal", + "properties": { + "ApplicationUrl": { + "description": "The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION", + "maxLength": 512, + "minLength": 1, + "pattern": "^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$", + "type": "string" + }, + "Origin": { + "description": "This determines how IAM Identity Center navigates the user to the target application", + "enum": [ + "IDENTITY_CENTER", + "APPLICATION" + ], + "type": "string" + } + }, + "required": [ + "Origin" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the Identity Center (SSO) Application to help you categorize and organize them.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Identity Center (SSO) Application", + "handlers": { + "create": { + "permissions": [ + "sso:CreateApplication", + "sso:DescribeApplication", + "sso:TagResource" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteApplication" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "sso:ListApplications" + ] + }, + "read": { + "permissions": [ + "sso:DescribeApplication", + "sso:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "sso:UpdateApplication", + "sso:TagResource", + "sso:UntagResource", + "sso:ListTagsForResource", + "sso:DescribeApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "description": "The Application ARN that is returned upon creation of the Identity Center (SSO) Application", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$", + "type": "string" + }, + "ApplicationProviderArn": { + "description": "The ARN of the application provider under which the operation will run", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$", + "type": "string" + }, + "Description": { + "description": "The description information for the Identity Center (SSO) Application", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InstanceArn": { + "description": "The ARN of the instance of IAM Identity Center under which the operation will run", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Identity Center (SSO) Application", + "maxLength": 255, + "minLength": 0, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "PortalOptions": { + "$ref": "#/definitions/PortalOptionsConfiguration", + "description": "A structure that describes the options for the portal associated with an application" + }, + "Status": { + "description": "Specifies whether the application is enabled or disabled", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "description": "Specifies tags to be attached to the application" + }, + "maxItems": 75, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn" + ], + "required": [ + "Name", + "InstanceArn", + "ApplicationProviderArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-application", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSO::Application" +} diff --git a/schema/aws-sso-applicationassignment.json b/schema/aws-sso-applicationassignment.json index 0520acb..123cd09 100644 --- a/schema/aws-sso-applicationassignment.json +++ b/schema/aws-sso-applicationassignment.json @@ -1,80 +1,80 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApplicationArn", - "/properties/PrincipalType", - "/properties/PrincipalId" - ], - "description": "Resource Type definition for SSO application access grant to a user or group.", - "handlers": { - "create": { - "permissions": [ - "sso:CreateApplicationAssignment", - "sso:DescribeApplicationAssignment" - ] - }, - "delete": { - "permissions": [ - "sso:DeleteApplicationAssignment" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ApplicationArn": { - "$ref": "resource-schema.json#/properties/ApplicationArn" - } - } - }, - "permissions": [ - "sso:ListApplicationAssignments" - ] - }, - "read": { - "permissions": [ - "sso:DescribeApplicationAssignment" - ] - } - }, - "primaryIdentifier": [ - "/properties/ApplicationArn", - "/properties/PrincipalType", - "/properties/PrincipalId" - ], - "properties": { - "ApplicationArn": { - "description": "The ARN of the application.", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}", - "type": "string" - }, - "PrincipalId": { - "description": "An identifier for an object in IAM Identity Center, such as a user or group", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - }, - "PrincipalType": { - "description": "The entity type for which the assignment will be created.", - "enum": [ - "USER", - "GROUP" - ], - "type": "string" - } - }, - "required": [ - "ApplicationArn", - "PrincipalType", - "PrincipalId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-application-assignment", - "tagging": { - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SSO::ApplicationAssignment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/PrincipalType", + "/properties/PrincipalId" + ], + "description": "Resource Type definition for SSO application access grant to a user or group.", + "handlers": { + "create": { + "permissions": [ + "sso:CreateApplicationAssignment", + "sso:DescribeApplicationAssignment" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteApplicationAssignment" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationArn": { + "$ref": "resource-schema.json#/properties/ApplicationArn" + } + } + }, + "permissions": [ + "sso:ListApplicationAssignments" + ] + }, + "read": { + "permissions": [ + "sso:DescribeApplicationAssignment" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn", + "/properties/PrincipalType", + "/properties/PrincipalId" + ], + "properties": { + "ApplicationArn": { + "description": "The ARN of the application.", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}", + "type": "string" + }, + "PrincipalId": { + "description": "An identifier for an object in IAM Identity Center, such as a user or group", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + }, + "PrincipalType": { + "description": "The entity type for which the assignment will be created.", + "enum": [ + "USER", + "GROUP" + ], + "type": "string" + } + }, + "required": [ + "ApplicationArn", + "PrincipalType", + "PrincipalId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-application-assignment", + "tagging": { + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SSO::ApplicationAssignment" +} diff --git a/schema/aws-sso-assignment.json b/schema/aws-sso-assignment.json index f43c1bf..531cc68 100644 --- a/schema/aws-sso-assignment.json +++ b/schema/aws-sso-assignment.json @@ -1,115 +1,115 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn", - "/properties/TargetId", - "/properties/TargetType", - "/properties/PermissionSetArn", - "/properties/PrincipalType", - "/properties/PrincipalId" - ], - "description": "Resource Type definition for SSO assignmet", - "handlers": { - "create": { - "permissions": [ - "sso:CreateAccountAssignment", - "sso:DescribeAccountAssignmentCreationStatus", - "sso:ListAccountAssignments", - "iam:GetSAMLProvider", - "iam:CreateSAMLProvider", - "iam:AttachRolePolicy", - "iam:PutRolePolicy", - "iam:CreateRole", - "iam:ListRolePolicies" - ] - }, - "delete": { - "permissions": [ - "sso:ListAccountAssignments", - "sso:DeleteAccountAssignment", - "sso:DescribeAccountAssignmentDeletionStatus", - "iam:GetSAMLProvider", - "iam:ListRolePolicies" - ] - }, - "list": { - "permissions": [ - "sso:ListAccountAssignments", - "iam:ListRolePolicies" - ] - }, - "read": { - "permissions": [ - "sso:ListAccountAssignments", - "iam:GetSAMLProvider", - "iam:ListRolePolicies" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn", - "/properties/TargetId", - "/properties/TargetType", - "/properties/PermissionSetArn", - "/properties/PrincipalType", - "/properties/PrincipalId" - ], - "properties": { - "InstanceArn": { - "description": "The sso instance that the permission set is owned.", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", - "type": "string" - }, - "PermissionSetArn": { - "description": "The permission set that the assignemt will be assigned", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}", - "type": "string" - }, - "PrincipalId": { - "description": "The assignee's identifier, user id/group id", - "maxLength": 47, - "minLength": 1, - "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", - "type": "string" - }, - "PrincipalType": { - "description": "The assignee's type, user/group", - "enum": [ - "USER", - "GROUP" - ], - "type": "string" - }, - "TargetId": { - "description": "The account id to be provisioned.", - "pattern": "\\d{12}", - "type": "string" - }, - "TargetType": { - "description": "The type of resource to be provsioned to, only aws account now", - "enum": [ - "AWS_ACCOUNT" - ], - "type": "string" - } - }, - "required": [ - "InstanceArn", - "TargetId", - "TargetType", - "PermissionSetArn", - "PrincipalType", - "PrincipalId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-assignment", - "tagging": { - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SSO::Assignment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/TargetId", + "/properties/TargetType", + "/properties/PermissionSetArn", + "/properties/PrincipalType", + "/properties/PrincipalId" + ], + "description": "Resource Type definition for SSO assignmet", + "handlers": { + "create": { + "permissions": [ + "sso:CreateAccountAssignment", + "sso:DescribeAccountAssignmentCreationStatus", + "sso:ListAccountAssignments", + "iam:GetSAMLProvider", + "iam:CreateSAMLProvider", + "iam:AttachRolePolicy", + "iam:PutRolePolicy", + "iam:CreateRole", + "iam:ListRolePolicies" + ] + }, + "delete": { + "permissions": [ + "sso:ListAccountAssignments", + "sso:DeleteAccountAssignment", + "sso:DescribeAccountAssignmentDeletionStatus", + "iam:GetSAMLProvider", + "iam:ListRolePolicies" + ] + }, + "list": { + "permissions": [ + "sso:ListAccountAssignments", + "iam:ListRolePolicies" + ] + }, + "read": { + "permissions": [ + "sso:ListAccountAssignments", + "iam:GetSAMLProvider", + "iam:ListRolePolicies" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn", + "/properties/TargetId", + "/properties/TargetType", + "/properties/PermissionSetArn", + "/properties/PrincipalType", + "/properties/PrincipalId" + ], + "properties": { + "InstanceArn": { + "description": "The sso instance that the permission set is owned.", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", + "type": "string" + }, + "PermissionSetArn": { + "description": "The permission set that the assignemt will be assigned", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}", + "type": "string" + }, + "PrincipalId": { + "description": "The assignee's identifier, user id/group id", + "maxLength": 47, + "minLength": 1, + "pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$", + "type": "string" + }, + "PrincipalType": { + "description": "The assignee's type, user/group", + "enum": [ + "USER", + "GROUP" + ], + "type": "string" + }, + "TargetId": { + "description": "The account id to be provisioned.", + "pattern": "\\d{12}", + "type": "string" + }, + "TargetType": { + "description": "The type of resource to be provsioned to, only aws account now", + "enum": [ + "AWS_ACCOUNT" + ], + "type": "string" + } + }, + "required": [ + "InstanceArn", + "TargetId", + "TargetType", + "PermissionSetArn", + "PrincipalType", + "PrincipalId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-assignment", + "tagging": { + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SSO::Assignment" +} diff --git a/schema/aws-sso-instance.json b/schema/aws-sso-instance.json index 5d977c7..6ba0595 100644 --- a/schema/aws-sso-instance.json +++ b/schema/aws-sso-instance.json @@ -1,133 +1,133 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to the Identity Center (SSO) Instance to help you categorize and organize them.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "[\\w+=,.@-]+", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for Identity Center (SSO) Instance", - "handlers": { - "create": { - "permissions": [ - "sso:CreateInstance", - "sso:DescribeInstance", - "sso:TagResource", - "iam:CreateServiceLinkedRole", - "sso:TagInstance", - "sso:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "sso:DeleteInstance" - ] - }, - "list": { - "permissions": [ - "sso:ListInstances" - ] - }, - "read": { - "permissions": [ - "sso:DescribeInstance", - "sso:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "sso:UpdateInstance", - "sso:TagResource", - "sso:UntagResource", - "sso:ListTagsForResource", - "sso:TagInstance", - "sso:DescribeInstance" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn" - ], - "properties": { - "IdentityStoreId": { - "description": "The ID of the identity store associated with the created Identity Center (SSO) Instance", - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "InstanceArn": { - "description": "The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance", - "maxLength": 1224, - "minLength": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", - "type": "string" - }, - "Name": { - "description": "The name you want to assign to this Identity Center (SSO) Instance", - "maxLength": 32, - "minLength": 1, - "pattern": "^[\\w+=,.@-]+$", - "type": "string" - }, - "OwnerAccountId": { - "description": "The AWS accountId of the owner of the Identity Center (SSO) Instance", - "maxLength": 12, - "minLength": 12, - "pattern": "^\\d{12}?$", - "type": "string" - }, - "Status": { - "description": "The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active", - "enum": [ - "CREATE_IN_PROGRESS", - "DELETE_IN_PROGRESS", - "ACTIVE" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 75, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/InstanceArn", - "/properties/OwnerAccountId", - "/properties/IdentityStoreId", - "/properties/Status" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-instance", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSO::Instance" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the Identity Center (SSO) Instance to help you categorize and organize them.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Identity Center (SSO) Instance", + "handlers": { + "create": { + "permissions": [ + "sso:CreateInstance", + "sso:DescribeInstance", + "sso:TagResource", + "iam:CreateServiceLinkedRole", + "sso:TagInstance", + "sso:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteInstance" + ] + }, + "list": { + "permissions": [ + "sso:ListInstances" + ] + }, + "read": { + "permissions": [ + "sso:DescribeInstance", + "sso:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "sso:UpdateInstance", + "sso:TagResource", + "sso:UntagResource", + "sso:ListTagsForResource", + "sso:TagInstance", + "sso:DescribeInstance" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn" + ], + "properties": { + "IdentityStoreId": { + "description": "The ID of the identity store associated with the created Identity Center (SSO) Instance", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "InstanceArn": { + "description": "The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Identity Center (SSO) Instance", + "maxLength": 32, + "minLength": 1, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "OwnerAccountId": { + "description": "The AWS accountId of the owner of the Identity Center (SSO) Instance", + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d{12}?$", + "type": "string" + }, + "Status": { + "description": "The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active", + "enum": [ + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "ACTIVE" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 75, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/InstanceArn", + "/properties/OwnerAccountId", + "/properties/IdentityStoreId", + "/properties/Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-instance", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSO::Instance" +} diff --git a/schema/aws-sso-instanceaccesscontrolattributeconfiguration.json b/schema/aws-sso-instanceaccesscontrolattributeconfiguration.json index cead50f..d28dae3 100644 --- a/schema/aws-sso-instanceaccesscontrolattributeconfiguration.json +++ b/schema/aws-sso-instanceaccesscontrolattributeconfiguration.json @@ -1,134 +1,134 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn" - ], - "definitions": { - "AccessControlAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+", - "type": "string" - }, - "Value": { - "$ref": "#/definitions/AccessControlAttributeValue" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AccessControlAttributeList": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/AccessControlAttribute" - }, - "maxItems": 50, - "type": "array" - }, - "AccessControlAttributeValue": { - "additionalProperties": false, - "properties": { - "Source": { - "$ref": "#/definitions/AccessControlAttributeValueSourceList" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "AccessControlAttributeValueSource": { - "maxLength": 256, - "minLength": 0, - "pattern": "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@\\[\\]\\{\\}\\$\\\\\"]*", - "type": "string" - }, - "AccessControlAttributeValueSourceList": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/AccessControlAttributeValueSource" - }, - "maxItems": 1, - "type": "array" - } - }, - "deprecatedProperties": [ - "/properties/InstanceAccessControlAttributeConfiguration" - ], - "description": "Resource Type definition for SSO InstanceAccessControlAttributeConfiguration", - "handlers": { - "create": { - "permissions": [ - "sso:CreateInstanceAccessControlAttributeConfiguration", - "sso:UpdateApplicationProfileForAWSAccountInstance", - "sso:DescribeInstanceAccessControlAttributeConfiguration" - ] - }, - "delete": { - "permissions": [ - "sso:DeleteInstanceAccessControlAttributeConfiguration", - "sso:DescribeInstanceAccessControlAttributeConfiguration" - ] - }, - "list": { - "permissions": [ - "sso:DescribeInstanceAccessControlAttributeConfiguration" - ] - }, - "read": { - "permissions": [ - "sso:DescribeInstanceAccessControlAttributeConfiguration" - ] - }, - "update": { - "permissions": [ - "sso:UpdateInstanceAccessControlAttributeConfiguration", - "sso:DescribeInstanceAccessControlAttributeConfiguration" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn" - ], - "properties": { - "AccessControlAttributes": { - "$ref": "#/definitions/AccessControlAttributeList" - }, - "InstanceAccessControlAttributeConfiguration": { - "additionalProperties": false, - "description": "The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.", - "properties": { - "AccessControlAttributes": { - "$ref": "#/definitions/AccessControlAttributeList" - } - }, - "required": [ - "AccessControlAttributes" - ], - "type": "object" - }, - "InstanceArn": { - "description": "The ARN of the AWS SSO instance under which the operation will be executed.", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", - "type": "string" - } - }, - "required": [ - "InstanceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-instanceaccesscontrolattributeconfiguration", - "tagging": { - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn" + ], + "definitions": { + "AccessControlAttribute": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/AccessControlAttributeValue" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "AccessControlAttributeList": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AccessControlAttribute" + }, + "maxItems": 50, + "type": "array" + }, + "AccessControlAttributeValue": { + "additionalProperties": false, + "properties": { + "Source": { + "$ref": "#/definitions/AccessControlAttributeValueSourceList" + } + }, + "required": [ + "Source" + ], + "type": "object" + }, + "AccessControlAttributeValueSource": { + "maxLength": 256, + "minLength": 0, + "pattern": "[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@\\[\\]\\{\\}\\$\\\\\"]*", + "type": "string" + }, + "AccessControlAttributeValueSourceList": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AccessControlAttributeValueSource" + }, + "maxItems": 1, + "type": "array" + } + }, + "deprecatedProperties": [ + "/properties/InstanceAccessControlAttributeConfiguration" + ], + "description": "Resource Type definition for SSO InstanceAccessControlAttributeConfiguration", + "handlers": { + "create": { + "permissions": [ + "sso:CreateInstanceAccessControlAttributeConfiguration", + "sso:UpdateApplicationProfileForAWSAccountInstance", + "sso:DescribeInstanceAccessControlAttributeConfiguration" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteInstanceAccessControlAttributeConfiguration", + "sso:DescribeInstanceAccessControlAttributeConfiguration" + ] + }, + "list": { + "permissions": [ + "sso:DescribeInstanceAccessControlAttributeConfiguration" + ] + }, + "read": { + "permissions": [ + "sso:DescribeInstanceAccessControlAttributeConfiguration" + ] + }, + "update": { + "permissions": [ + "sso:UpdateInstanceAccessControlAttributeConfiguration", + "sso:DescribeInstanceAccessControlAttributeConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn" + ], + "properties": { + "AccessControlAttributes": { + "$ref": "#/definitions/AccessControlAttributeList" + }, + "InstanceAccessControlAttributeConfiguration": { + "additionalProperties": false, + "description": "The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.", + "properties": { + "AccessControlAttributes": { + "$ref": "#/definitions/AccessControlAttributeList" + } + }, + "required": [ + "AccessControlAttributes" + ], + "type": "object" + }, + "InstanceArn": { + "description": "The ARN of the AWS SSO instance under which the operation will be executed.", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", + "type": "string" + } + }, + "required": [ + "InstanceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-instanceaccesscontrolattributeconfiguration", + "tagging": { + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" +} diff --git a/schema/aws-sso-permissionset.json b/schema/aws-sso-permissionset.json index 1ea0cb6..ad28bc9 100644 --- a/schema/aws-sso-permissionset.json +++ b/schema/aws-sso-permissionset.json @@ -1,232 +1,232 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/InstanceArn", - "/properties/Name" - ], - "definitions": { - "CustomerManagedPolicyReference": { - "additionalProperties": false, - "properties": { - "Name": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "Path": { - "maxLength": 512, - "minLength": 1, - "pattern": "((/[A-Za-z0-9\\.,\\+@=_-]+)*)/", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "ManagedPolicyArn": { - "description": "The managed policy to attach.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "PermissionsBoundary": { - "additionalProperties": false, - "properties": { - "CustomerManagedPolicyReference": { - "$ref": "#/definitions/CustomerManagedPolicyReference" - }, - "ManagedPolicyArn": { - "$ref": "#/definitions/ManagedPolicyArn" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "The metadata that you apply to the permission set to help you categorize and organize them.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "[\\w+=,.@-]+", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for SSO PermissionSet", - "handlers": { - "create": { - "permissions": [ - "sso:CreatePermissionSet", - "sso:PutInlinePolicyToPermissionSet", - "sso:AttachManagedPolicyToPermissionSet", - "sso:AttachCustomerManagedPolicyReferenceToPermissionSet", - "sso:PutPermissionsBoundaryToPermissionSet", - "sso:TagResource", - "sso:DescribePermissionSet", - "sso:ListTagsForResource", - "sso:ListManagedPoliciesInPermissionSet", - "sso:ListCustomerManagedPolicyReferencesInPermissionSet", - "sso:GetInlinePolicyForPermissionSet", - "sso:GetPermissionsBoundaryForPermissionSet" - ] - }, - "delete": { - "permissions": [ - "sso:DeletePermissionSet" - ] - }, - "list": { - "permissions": [ - "sso:DescribePermissionSet" - ] - }, - "read": { - "permissions": [ - "sso:DescribePermissionSet", - "sso:ListTagsForResource", - "sso:ListManagedPoliciesInPermissionSet", - "sso:ListCustomerManagedPolicyReferencesInPermissionSet", - "sso:GetInlinePolicyForPermissionSet", - "sso:GetPermissionsBoundaryForPermissionSet" - ] - }, - "update": { - "permissions": [ - "sso:UpdatePermissionSet", - "sso:TagResource", - "sso:UntagResource", - "sso:ListTagsForResource", - "sso:AttachManagedPolicyToPermissionSet", - "sso:AttachCustomerManagedPolicyReferenceToPermissionSet", - "sso:DetachManagedPolicyFromPermissionSet", - "sso:DetachCustomerManagedPolicyReferenceFromPermissionSet", - "sso:ListManagedPoliciesInPermissionSet", - "sso:ListCustomerManagedPolicyReferencesInPermissionSet", - "sso:PutInlinePolicyToPermissionSet", - "sso:GetPermissionsBoundaryForPermissionSet", - "sso:DeletePermissionsBoundaryFromPermissionSet", - "sso:PutPermissionsBoundaryToPermissionSet", - "sso:DeleteInlinePolicyFromPermissionSet", - "sso:ProvisionPermissionSet", - "sso:DescribePermissionSet", - "sso:GetInlinePolicyForPermissionSet", - "sso:DescribePermissionSetProvisioningStatus" - ] - } - }, - "primaryIdentifier": [ - "/properties/InstanceArn", - "/properties/PermissionSetArn" - ], - "properties": { - "CustomerManagedPolicyReferences": { - "default": [], - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CustomerManagedPolicyReference" - }, - "maxItems": 20, - "type": "array" - }, - "Description": { - "description": "The permission set description.", - "maxLength": 700, - "minLength": 1, - "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*", - "type": "string" - }, - "InlinePolicy": { - "description": "The inline policy to put in permission set.", - "type": [ - "object", - "string" - ] - }, - "InstanceArn": { - "description": "The sso instance arn that the permission set is owned.", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", - "type": "string" - }, - "ManagedPolicies": { - "default": [], - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ManagedPolicyArn" - }, - "maxItems": 20, - "type": "array" - }, - "Name": { - "description": "The name you want to assign to this permission set.", - "maxLength": 32, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - }, - "PermissionSetArn": { - "description": "The permission set that the policy will be attached to", - "maxLength": 1224, - "minLength": 10, - "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}", - "type": "string" - }, - "PermissionsBoundary": { - "$ref": "#/definitions/PermissionsBoundary" - }, - "RelayStateType": { - "description": "The relay state URL that redirect links to any service in the AWS Management Console.", - "maxLength": 240, - "minLength": 1, - "pattern": "[a-zA-Z0-9&$@#\\/%?=~\\-_'"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+", - "type": "string" - }, - "SessionDuration": { - "description": "The length of time that a user can be signed in to an AWS account.", - "maxLength": 100, - "minLength": 1, - "pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/PermissionSetArn" - ], - "required": [ - "Name", - "InstanceArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-permissionset", - "tagging": { - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SSO::PermissionSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/Name" + ], + "definitions": { + "CustomerManagedPolicyReference": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Path": { + "maxLength": 512, + "minLength": 1, + "pattern": "((/[A-Za-z0-9\\.,\\+@=_-]+)*)/", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "ManagedPolicyArn": { + "description": "The managed policy to attach.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "PermissionsBoundary": { + "additionalProperties": false, + "properties": { + "CustomerManagedPolicyReference": { + "$ref": "#/definitions/CustomerManagedPolicyReference" + }, + "ManagedPolicyArn": { + "$ref": "#/definitions/ManagedPolicyArn" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the permission set to help you categorize and organize them.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for SSO PermissionSet", + "handlers": { + "create": { + "permissions": [ + "sso:CreatePermissionSet", + "sso:PutInlinePolicyToPermissionSet", + "sso:AttachManagedPolicyToPermissionSet", + "sso:AttachCustomerManagedPolicyReferenceToPermissionSet", + "sso:PutPermissionsBoundaryToPermissionSet", + "sso:TagResource", + "sso:DescribePermissionSet", + "sso:ListTagsForResource", + "sso:ListManagedPoliciesInPermissionSet", + "sso:ListCustomerManagedPolicyReferencesInPermissionSet", + "sso:GetInlinePolicyForPermissionSet", + "sso:GetPermissionsBoundaryForPermissionSet" + ] + }, + "delete": { + "permissions": [ + "sso:DeletePermissionSet" + ] + }, + "list": { + "permissions": [ + "sso:DescribePermissionSet" + ] + }, + "read": { + "permissions": [ + "sso:DescribePermissionSet", + "sso:ListTagsForResource", + "sso:ListManagedPoliciesInPermissionSet", + "sso:ListCustomerManagedPolicyReferencesInPermissionSet", + "sso:GetInlinePolicyForPermissionSet", + "sso:GetPermissionsBoundaryForPermissionSet" + ] + }, + "update": { + "permissions": [ + "sso:UpdatePermissionSet", + "sso:TagResource", + "sso:UntagResource", + "sso:ListTagsForResource", + "sso:AttachManagedPolicyToPermissionSet", + "sso:AttachCustomerManagedPolicyReferenceToPermissionSet", + "sso:DetachManagedPolicyFromPermissionSet", + "sso:DetachCustomerManagedPolicyReferenceFromPermissionSet", + "sso:ListManagedPoliciesInPermissionSet", + "sso:ListCustomerManagedPolicyReferencesInPermissionSet", + "sso:PutInlinePolicyToPermissionSet", + "sso:GetPermissionsBoundaryForPermissionSet", + "sso:DeletePermissionsBoundaryFromPermissionSet", + "sso:PutPermissionsBoundaryToPermissionSet", + "sso:DeleteInlinePolicyFromPermissionSet", + "sso:ProvisionPermissionSet", + "sso:DescribePermissionSet", + "sso:GetInlinePolicyForPermissionSet", + "sso:DescribePermissionSetProvisioningStatus" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn", + "/properties/PermissionSetArn" + ], + "properties": { + "CustomerManagedPolicyReferences": { + "default": [], + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CustomerManagedPolicyReference" + }, + "maxItems": 20, + "type": "array" + }, + "Description": { + "description": "The permission set description.", + "maxLength": 700, + "minLength": 1, + "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*", + "type": "string" + }, + "InlinePolicy": { + "description": "The inline policy to put in permission set.", + "type": [ + "object", + "string" + ] + }, + "InstanceArn": { + "description": "The sso instance arn that the permission set is owned.", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}", + "type": "string" + }, + "ManagedPolicies": { + "default": [], + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ManagedPolicyArn" + }, + "maxItems": 20, + "type": "array" + }, + "Name": { + "description": "The name you want to assign to this permission set.", + "maxLength": 32, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "PermissionSetArn": { + "description": "The permission set that the policy will be attached to", + "maxLength": 1224, + "minLength": 10, + "pattern": "arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}", + "type": "string" + }, + "PermissionsBoundary": { + "$ref": "#/definitions/PermissionsBoundary" + }, + "RelayStateType": { + "description": "The relay state URL that redirect links to any service in the AWS Management Console.", + "maxLength": 240, + "minLength": 1, + "pattern": "[a-zA-Z0-9&$@#\\/%?=~\\-_'"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+", + "type": "string" + }, + "SessionDuration": { + "description": "The length of time that a user can be signed in to an AWS account.", + "maxLength": 100, + "minLength": 1, + "pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/PermissionSetArn" + ], + "required": [ + "Name", + "InstanceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-permissionset", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSO::PermissionSet" +} diff --git a/schema/aws-stepfunctions-activity.json b/schema/aws-stepfunctions-activity.json index bbac964..0a5c395 100644 --- a/schema/aws-stepfunctions-activity.json +++ b/schema/aws-stepfunctions-activity.json @@ -1,130 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/EncryptionConfiguration" - ], - "definitions": { - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsDataKeyReusePeriodSeconds": { - "maximum": 900, - "minimum": 60, - "type": "integer" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "enum": [ - "CUSTOMER_MANAGED_KMS_KEY", - "AWS_OWNED_KEY" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for Activity", - "handlers": { - "create": { - "permissions": [ - "states:CreateActivity", - "states:TagResource", - "kms:DescribeKey" - ] - }, - "delete": { - "permissions": [ - "states:DescribeActivity", - "states:DeleteActivity" - ] - }, - "list": { - "permissions": [ - "states:ListActivities" - ] - }, - "read": { - "permissions": [ - "states:DescribeActivity", - "states:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "states:ListTagsForResource", - "states:TagResource", - "states:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "Name": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::StepFunctions::Activity" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/EncryptionConfiguration" + ], + "definitions": { + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsDataKeyReusePeriodSeconds": { + "maximum": 900, + "minimum": 60, + "type": "integer" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "enum": [ + "CUSTOMER_MANAGED_KMS_KEY", + "AWS_OWNED_KEY" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for Activity", + "handlers": { + "create": { + "permissions": [ + "states:CreateActivity", + "states:TagResource", + "kms:DescribeKey" + ] + }, + "delete": { + "permissions": [ + "states:DescribeActivity", + "states:DeleteActivity" + ] + }, + "list": { + "permissions": [ + "states:ListActivities" + ] + }, + "read": { + "permissions": [ + "states:DescribeActivity", + "states:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "states:ListTagsForResource", + "states:TagResource", + "states:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "Name": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "states:UntagResource", + "states:TagResource", + "states:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::StepFunctions::Activity" +} diff --git a/schema/aws-stepfunctions-statemachine.json b/schema/aws-stepfunctions-statemachine.json index 7cecafc..3d22a89 100644 --- a/schema/aws-stepfunctions-statemachine.json +++ b/schema/aws-stepfunctions-statemachine.json @@ -1,291 +1,296 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/StateMachineName" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StateMachineName", - "/properties/StateMachineType" - ], - "definitions": { - "CloudWatchLogsLogGroup": { - "additionalProperties": false, - "properties": { - "LogGroupArn": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Definition": { - "minProperties": 1, - "type": "object" - }, - "DefinitionSubstitutions": { - "additionalProperties": false, - "minProperties": 1, - "patternProperties": { - ".*": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "boolean" - } - ] - } - }, - "type": "object" - }, - "EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsDataKeyReusePeriodSeconds": { - "maximum": 900, - "minimum": 60, - "type": "integer" - }, - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "enum": [ - "CUSTOMER_MANAGED_KMS_KEY", - "AWS_OWNED_KEY" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "LogDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroup": { - "$ref": "#/definitions/CloudWatchLogsLogGroup" - } - }, - "type": "object" - }, - "LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "Destinations": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/LogDestination" - }, - "minItems": 1, - "type": "array" - }, - "IncludeExecutionData": { - "type": "boolean" - }, - "Level": { - "enum": [ - "ALL", - "ERROR", - "FATAL", - "OFF" - ], - "type": "string" - } - }, - "type": "object" - }, - "S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TracingConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "description": "Resource schema for StateMachine", - "handlers": { - "create": { - "permissions": [ - "states:CreateStateMachine", - "states:DescribeStateMachine", - "states:TagResource", - "iam:PassRole", - "s3:GetObject", - "kms:DescribeKey", - "kms:GenerateDataKey" - ] - }, - "delete": { - "permissions": [ - "states:DeleteStateMachine", - "states:DescribeStateMachine" - ] - }, - "list": { - "permissions": [ - "states:ListStateMachines" - ] - }, - "read": { - "permissions": [ - "states:DescribeStateMachine", - "states:ListTagsForResource", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "states:UpdateStateMachine", - "states:TagResource", - "states:UntagResource", - "states:ListTagsForResource", - "iam:PassRole", - "kms:DescribeKey", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Definition": { - "$ref": "#/definitions/Definition" - }, - "DefinitionS3Location": { - "$ref": "#/definitions/S3Location" - }, - "DefinitionString": { - "maxLength": 1048576, - "minLength": 1, - "type": "string" - }, - "DefinitionSubstitutions": { - "$ref": "#/definitions/DefinitionSubstitutions" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/LoggingConfiguration" - }, - "Name": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "RoleArn": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "StateMachineName": { - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "StateMachineRevisionId": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "StateMachineType": { - "enum": [ - "STANDARD", - "EXPRESS" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/TagsEntry" - }, - "type": "array", - "uniqueItems": false - }, - "TracingConfiguration": { - "$ref": "#/definitions/TracingConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Name", - "/properties/StateMachineRevisionId" - ], - "required": [ - "RoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::StepFunctions::StateMachine", - "writeOnlyProperties": [ - "/properties/Definition", - "/properties/DefinitionS3Location", - "/properties/DefinitionSubstitutions" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/StateMachineName" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StateMachineName", + "/properties/StateMachineType" + ], + "definitions": { + "CloudWatchLogsLogGroup": { + "additionalProperties": false, + "properties": { + "LogGroupArn": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Definition": { + "minProperties": 1, + "type": "object" + }, + "DefinitionSubstitutions": { + "additionalProperties": false, + "minProperties": 1, + "patternProperties": { + ".*": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "boolean" + } + ] + } + }, + "type": "object" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsDataKeyReusePeriodSeconds": { + "maximum": 900, + "minimum": 60, + "type": "integer" + }, + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "enum": [ + "CUSTOMER_MANAGED_KMS_KEY", + "AWS_OWNED_KEY" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "LogDestination": { + "additionalProperties": false, + "properties": { + "CloudWatchLogsLogGroup": { + "$ref": "#/definitions/CloudWatchLogsLogGroup" + } + }, + "type": "object" + }, + "LoggingConfiguration": { + "additionalProperties": false, + "properties": { + "Destinations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/LogDestination" + }, + "minItems": 1, + "type": "array" + }, + "IncludeExecutionData": { + "type": "boolean" + }, + "Level": { + "enum": [ + "ALL", + "ERROR", + "FATAL", + "OFF" + ], + "type": "string" + } + }, + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "properties": { + "Bucket": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "Version": { + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "TagsEntry": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TracingConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "description": "Resource schema for StateMachine", + "handlers": { + "create": { + "permissions": [ + "states:CreateStateMachine", + "states:DescribeStateMachine", + "states:TagResource", + "iam:PassRole", + "s3:GetObject", + "kms:DescribeKey", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "states:DeleteStateMachine", + "states:DescribeStateMachine" + ] + }, + "list": { + "permissions": [ + "states:ListStateMachines" + ] + }, + "read": { + "permissions": [ + "states:DescribeStateMachine", + "states:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "states:UpdateStateMachine", + "states:TagResource", + "states:UntagResource", + "states:ListTagsForResource", + "iam:PassRole", + "kms:DescribeKey", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Definition": { + "$ref": "#/definitions/Definition" + }, + "DefinitionS3Location": { + "$ref": "#/definitions/S3Location" + }, + "DefinitionString": { + "maxLength": 1048576, + "minLength": 1, + "type": "string" + }, + "DefinitionSubstitutions": { + "$ref": "#/definitions/DefinitionSubstitutions" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "LoggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration" + }, + "Name": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "StateMachineName": { + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "StateMachineRevisionId": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "StateMachineType": { + "enum": [ + "STANDARD", + "EXPRESS" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TagsEntry" + }, + "type": "array", + "uniqueItems": false + }, + "TracingConfiguration": { + "$ref": "#/definitions/TracingConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Name", + "/properties/StateMachineRevisionId" + ], + "required": [ + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "states:UntagResource", + "states:TagResource", + "states:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::StepFunctions::StateMachine", + "writeOnlyProperties": [ + "/properties/Definition", + "/properties/DefinitionS3Location", + "/properties/DefinitionSubstitutions" + ] +} diff --git a/schema/aws-stepfunctions-statemachinealias.json b/schema/aws-stepfunctions-statemachinealias.json index 5310ddb..e2e5f05 100644 --- a/schema/aws-stepfunctions-statemachinealias.json +++ b/schema/aws-stepfunctions-statemachinealias.json @@ -1,186 +1,186 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "DeploymentPreference": { - "additionalProperties": false, - "description": "The settings to enable gradual state machine deployments.", - "properties": { - "Alarms": { - "description": "A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.", - "insertionOrder": false, - "items": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Interval": { - "description": "The time in minutes between each traffic shifting increment.", - "maximum": 2100, - "minimum": 1, - "type": "integer" - }, - "Percentage": { - "description": "The percentage of traffic to shift to the new version in each increment.", - "maximum": 99, - "minimum": 1, - "type": "integer" - }, - "StateMachineVersionArn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Type": { - "description": "The type of deployment to perform.", - "enum": [ - "LINEAR", - "ALL_AT_ONCE", - "CANARY" - ], - "type": "string" - } - }, - "required": [ - "StateMachineVersionArn", - "Type" - ], - "type": "object" - }, - "RoutingConfiguration": { - "description": "The routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/RoutingConfigurationVersion" - }, - "maxItems": 2, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "RoutingConfigurationVersion": { - "additionalProperties": false, - "properties": { - "StateMachineVersionArn": { - "description": "The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Weight": { - "description": "The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.", - "maximum": 100, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "StateMachineVersionArn", - "Weight" - ], - "type": "object" - } - }, - "description": "Resource schema for StateMachineAlias", - "handlers": { - "create": { - "permissions": [ - "states:CreateStateMachineAlias", - "states:DescribeStateMachineAlias" - ] - }, - "delete": { - "permissions": [ - "states:DescribeStateMachineAlias", - "states:DeleteStateMachineAlias" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "RoutingConfiguration": { - "$ref": "resource-schema.json#/properties/RoutingConfiguration" - } - }, - "required": [ - "RoutingConfiguration" - ] - }, - "permissions": [ - "states:ListStateMachineAliases" - ] - }, - "read": { - "permissions": [ - "states:DescribeStateMachineAlias" - ] - }, - "update": { - "permissions": [ - "cloudwatch:DescribeAlarms", - "states:UpdateStateMachineAlias", - "states:DescribeStateMachineAlias" - ], - "timeoutInMinutes": 2160 - } - }, - "oneOf": [ - { - "required": [ - "RoutingConfiguration" - ] - }, - { - "required": [ - "DeploymentPreference" - ] - } - ], - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "description": "The ARN of the alias.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "DeploymentPreference": { - "$ref": "#/definitions/DeploymentPreference" - }, - "Description": { - "description": "An optional description of the alias.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "Name": { - "description": "The alias name.", - "maxLength": 80, - "minLength": 1, - "type": "string" - }, - "RoutingConfiguration": { - "$ref": "#/definitions/RoutingConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::StepFunctions::StateMachineAlias", - "writeOnlyProperties": [ - "/properties/DeploymentPreference" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "DeploymentPreference": { + "additionalProperties": false, + "description": "The settings to enable gradual state machine deployments.", + "properties": { + "Alarms": { + "description": "A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Interval": { + "description": "The time in minutes between each traffic shifting increment.", + "maximum": 2100, + "minimum": 1, + "type": "integer" + }, + "Percentage": { + "description": "The percentage of traffic to shift to the new version in each increment.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "StateMachineVersionArn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "description": "The type of deployment to perform.", + "enum": [ + "LINEAR", + "ALL_AT_ONCE", + "CANARY" + ], + "type": "string" + } + }, + "required": [ + "StateMachineVersionArn", + "Type" + ], + "type": "object" + }, + "RoutingConfiguration": { + "description": "The routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RoutingConfigurationVersion" + }, + "maxItems": 2, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RoutingConfigurationVersion": { + "additionalProperties": false, + "properties": { + "StateMachineVersionArn": { + "description": "The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Weight": { + "description": "The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.", + "maximum": 100, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "StateMachineVersionArn", + "Weight" + ], + "type": "object" + } + }, + "description": "Resource schema for StateMachineAlias", + "handlers": { + "create": { + "permissions": [ + "states:CreateStateMachineAlias", + "states:DescribeStateMachineAlias" + ] + }, + "delete": { + "permissions": [ + "states:DescribeStateMachineAlias", + "states:DeleteStateMachineAlias" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RoutingConfiguration": { + "$ref": "resource-schema.json#/properties/RoutingConfiguration" + } + }, + "required": [ + "RoutingConfiguration" + ] + }, + "permissions": [ + "states:ListStateMachineAliases" + ] + }, + "read": { + "permissions": [ + "states:DescribeStateMachineAlias" + ] + }, + "update": { + "permissions": [ + "cloudwatch:DescribeAlarms", + "states:UpdateStateMachineAlias", + "states:DescribeStateMachineAlias" + ], + "timeoutInMinutes": 2160 + } + }, + "oneOf": [ + { + "required": [ + "RoutingConfiguration" + ] + }, + { + "required": [ + "DeploymentPreference" + ] + } + ], + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the alias.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DeploymentPreference": { + "$ref": "#/definitions/DeploymentPreference" + }, + "Description": { + "description": "An optional description of the alias.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The alias name.", + "maxLength": 80, + "minLength": 1, + "type": "string" + }, + "RoutingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::StepFunctions::StateMachineAlias", + "writeOnlyProperties": [ + "/properties/DeploymentPreference" + ] +} diff --git a/schema/aws-stepfunctions-statemachineversion.json b/schema/aws-stepfunctions-statemachineversion.json index 5bbc54d..5897cac 100644 --- a/schema/aws-stepfunctions-statemachineversion.json +++ b/schema/aws-stepfunctions-statemachineversion.json @@ -1,83 +1,83 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/StateMachineArn", - "/properties/StateMachineRevisionId" - ], - "definitions": {}, - "description": "Resource schema for StateMachineVersion", - "handlers": { - "create": { - "permissions": [ - "states:PublishStateMachineVersion", - "states:ListStateMachineVersions", - "states:DescribeStateMachine" - ] - }, - "delete": { - "permissions": [ - "states:DeleteStateMachineVersion", - "states:DescribeStateMachine" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "StateMachineArn": { - "$ref": "resource-schema.json#/properties/StateMachineArn" - } - }, - "required": [ - "StateMachineArn" - ] - }, - "permissions": [ - "states:ListStateMachineVersions" - ] - }, - "read": { - "permissions": [ - "states:DescribeStateMachine" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Description": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "StateMachineArn": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "StateMachineRevisionId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "StateMachineArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::StepFunctions::StateMachineVersion", - "writeOnlyProperties": [ - "/properties/StateMachineArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StateMachineArn", + "/properties/StateMachineRevisionId" + ], + "definitions": {}, + "description": "Resource schema for StateMachineVersion", + "handlers": { + "create": { + "permissions": [ + "states:PublishStateMachineVersion", + "states:ListStateMachineVersions", + "states:DescribeStateMachine" + ] + }, + "delete": { + "permissions": [ + "states:DeleteStateMachineVersion", + "states:DescribeStateMachine" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "StateMachineArn": { + "$ref": "resource-schema.json#/properties/StateMachineArn" + } + }, + "required": [ + "StateMachineArn" + ] + }, + "permissions": [ + "states:ListStateMachineVersions" + ] + }, + "read": { + "permissions": [ + "states:DescribeStateMachine" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Description": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "StateMachineArn": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "StateMachineRevisionId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "StateMachineArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::StepFunctions::StateMachineVersion", + "writeOnlyProperties": [ + "/properties/StateMachineArn" + ] +} diff --git a/schema/aws-supportapp-accountalias.json b/schema/aws-supportapp-accountalias.json index 7385ea6..a0a732e 100644 --- a/schema/aws-supportapp-accountalias.json +++ b/schema/aws-supportapp-accountalias.json @@ -1,61 +1,61 @@ -{ - "additionalProperties": false, - "description": "An AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.", - "handlers": { - "create": { - "permissions": [ - "supportapp:PutAccountAlias", - "supportapp:GetAccountAlias" - ] - }, - "delete": { - "permissions": [ - "supportapp:DeleteAccountAlias", - "supportapp:GetAccountAlias" - ] - }, - "list": { - "permissions": [ - "supportapp:GetAccountAlias" - ] - }, - "read": { - "permissions": [ - "supportapp:GetAccountAlias" - ] - }, - "update": { - "permissions": [ - "supportapp:PutAccountAlias", - "supportapp:GetAccountAlias" - ] - } - }, - "primaryIdentifier": [ - "/properties/AccountAliasResourceId" - ], - "properties": { - "AccountAlias": { - "description": "An account alias associated with a customer's account.", - "maxLength": 30, - "minLength": 1, - "pattern": "^[\\w\\- ]+$", - "type": "string" - }, - "AccountAliasResourceId": { - "description": "Unique identifier representing an alias tied to an account", - "maxLength": 29, - "minLength": 29, - "pattern": "^[\\w\\- ]+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AccountAliasResourceId" - ], - "required": [ - "AccountAlias" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", - "typeName": "AWS::SupportApp::AccountAlias" -} +{ + "additionalProperties": false, + "description": "An AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.", + "handlers": { + "create": { + "permissions": [ + "supportapp:PutAccountAlias", + "supportapp:GetAccountAlias" + ] + }, + "delete": { + "permissions": [ + "supportapp:DeleteAccountAlias", + "supportapp:GetAccountAlias" + ] + }, + "list": { + "permissions": [ + "supportapp:GetAccountAlias" + ] + }, + "read": { + "permissions": [ + "supportapp:GetAccountAlias" + ] + }, + "update": { + "permissions": [ + "supportapp:PutAccountAlias", + "supportapp:GetAccountAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/AccountAliasResourceId" + ], + "properties": { + "AccountAlias": { + "description": "An account alias associated with a customer's account.", + "maxLength": 30, + "minLength": 1, + "pattern": "^[\\w\\- ]+$", + "type": "string" + }, + "AccountAliasResourceId": { + "description": "Unique identifier representing an alias tied to an account", + "maxLength": 29, + "minLength": 29, + "pattern": "^[\\w\\- ]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AccountAliasResourceId" + ], + "required": [ + "AccountAlias" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", + "typeName": "AWS::SupportApp::AccountAlias" +} diff --git a/schema/aws-supportapp-slackchannelconfiguration.json b/schema/aws-supportapp-slackchannelconfiguration.json index 370c840..432b652 100644 --- a/schema/aws-supportapp-slackchannelconfiguration.json +++ b/schema/aws-supportapp-slackchannelconfiguration.json @@ -1,101 +1,101 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TeamId", - "/properties/ChannelId" - ], - "description": "An AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.", - "handlers": { - "create": { - "permissions": [ - "supportapp:CreateSlackChannelConfiguration", - "supportapp:ListSlackChannelConfigurations" - ] - }, - "delete": { - "permissions": [ - "supportapp:DeleteSlackChannelConfiguration", - "supportapp:ListSlackChannelConfigurations" - ] - }, - "list": { - "permissions": [ - "supportapp:ListSlackChannelConfigurations" - ] - }, - "read": { - "permissions": [ - "supportapp:ListSlackChannelConfigurations" - ] - }, - "update": { - "permissions": [ - "supportapp:UpdateSlackChannelConfiguration", - "supportapp:ListSlackChannelConfigurations" - ] - } - }, - "primaryIdentifier": [ - "/properties/TeamId", - "/properties/ChannelId" - ], - "properties": { - "ChannelId": { - "description": "The channel ID in Slack, which identifies a channel within a workspace.", - "maxLength": 256, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - }, - "ChannelName": { - "description": "The channel name in Slack.", - "maxLength": 256, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "ChannelRoleArn": { - "description": "The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.", - "maxLength": 2048, - "minLength": 31, - "pattern": "^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role\\/(.+)$", - "type": "string" - }, - "NotifyOnAddCorrespondenceToCase": { - "description": "Whether to notify when a correspondence is added to a case.", - "type": "boolean" - }, - "NotifyOnCaseSeverity": { - "description": "The severity level of a support case that a customer wants to get notified for.", - "enum": [ - "none", - "all", - "high" - ], - "type": "string" - }, - "NotifyOnCreateOrReopenCase": { - "description": "Whether to notify when a case is created or reopened.", - "type": "boolean" - }, - "NotifyOnResolveCase": { - "description": "Whether to notify when a case is resolved.", - "type": "boolean" - }, - "TeamId": { - "description": "The team ID in Slack, which uniquely identifies a workspace.", - "maxLength": 256, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - } - }, - "required": [ - "TeamId", - "ChannelId", - "NotifyOnCaseSeverity", - "ChannelRoleArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", - "typeName": "AWS::SupportApp::SlackChannelConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TeamId", + "/properties/ChannelId" + ], + "description": "An AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.", + "handlers": { + "create": { + "permissions": [ + "supportapp:CreateSlackChannelConfiguration", + "supportapp:ListSlackChannelConfigurations" + ] + }, + "delete": { + "permissions": [ + "supportapp:DeleteSlackChannelConfiguration", + "supportapp:ListSlackChannelConfigurations" + ] + }, + "list": { + "permissions": [ + "supportapp:ListSlackChannelConfigurations" + ] + }, + "read": { + "permissions": [ + "supportapp:ListSlackChannelConfigurations" + ] + }, + "update": { + "permissions": [ + "supportapp:UpdateSlackChannelConfiguration", + "supportapp:ListSlackChannelConfigurations" + ] + } + }, + "primaryIdentifier": [ + "/properties/TeamId", + "/properties/ChannelId" + ], + "properties": { + "ChannelId": { + "description": "The channel ID in Slack, which identifies a channel within a workspace.", + "maxLength": 256, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + }, + "ChannelName": { + "description": "The channel name in Slack.", + "maxLength": 256, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "ChannelRoleArn": { + "description": "The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.", + "maxLength": 2048, + "minLength": 31, + "pattern": "^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role\\/(.+)$", + "type": "string" + }, + "NotifyOnAddCorrespondenceToCase": { + "description": "Whether to notify when a correspondence is added to a case.", + "type": "boolean" + }, + "NotifyOnCaseSeverity": { + "description": "The severity level of a support case that a customer wants to get notified for.", + "enum": [ + "none", + "all", + "high" + ], + "type": "string" + }, + "NotifyOnCreateOrReopenCase": { + "description": "Whether to notify when a case is created or reopened.", + "type": "boolean" + }, + "NotifyOnResolveCase": { + "description": "Whether to notify when a case is resolved.", + "type": "boolean" + }, + "TeamId": { + "description": "The team ID in Slack, which uniquely identifies a workspace.", + "maxLength": 256, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + } + }, + "required": [ + "TeamId", + "ChannelId", + "NotifyOnCaseSeverity", + "ChannelRoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", + "typeName": "AWS::SupportApp::SlackChannelConfiguration" +} diff --git a/schema/aws-supportapp-slackworkspaceconfiguration.json b/schema/aws-supportapp-slackworkspaceconfiguration.json index d8ed251..adf72b5 100644 --- a/schema/aws-supportapp-slackworkspaceconfiguration.json +++ b/schema/aws-supportapp-slackworkspaceconfiguration.json @@ -1,67 +1,67 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/TeamId" - ], - "description": "An AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.", - "handlers": { - "create": { - "permissions": [ - "supportapp:RegisterSlackWorkspaceForOrganization", - "supportapp:ListSlackWorkspaceConfigurations" - ] - }, - "delete": { - "permissions": [ - "supportapp:ListSlackWorkspaceConfigurations", - "supportapp:DeleteSlackWorkspaceConfiguration" - ] - }, - "list": { - "permissions": [ - "supportapp:ListSlackWorkspaceConfigurations" - ] - }, - "read": { - "permissions": [ - "supportapp:ListSlackWorkspaceConfigurations" - ] - }, - "update": { - "permissions": [ - "supportapp:RegisterSlackWorkspaceForOrganization", - "supportapp:ListSlackWorkspaceConfigurations" - ] - } - }, - "primaryIdentifier": [ - "/properties/TeamId" - ], - "properties": { - "TeamId": { - "description": "The team ID in Slack, which uniquely identifies a workspace.", - "maxLength": 256, - "minLength": 1, - "pattern": "^\\S+$", - "type": "string" - }, - "VersionId": { - "description": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation.", - "maxLength": 256, - "minLength": 1, - "pattern": "^[0-9]+$", - "type": "string" - } - }, - "required": [ - "TeamId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", - "tagging": { - "taggable": false - }, - "typeName": "AWS::SupportApp::SlackWorkspaceConfiguration", - "writeOnlyProperties": [ - "/properties/VersionId" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TeamId" + ], + "description": "An AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.", + "handlers": { + "create": { + "permissions": [ + "supportapp:RegisterSlackWorkspaceForOrganization", + "supportapp:ListSlackWorkspaceConfigurations" + ] + }, + "delete": { + "permissions": [ + "supportapp:ListSlackWorkspaceConfigurations", + "supportapp:DeleteSlackWorkspaceConfiguration" + ] + }, + "list": { + "permissions": [ + "supportapp:ListSlackWorkspaceConfigurations" + ] + }, + "read": { + "permissions": [ + "supportapp:ListSlackWorkspaceConfigurations" + ] + }, + "update": { + "permissions": [ + "supportapp:RegisterSlackWorkspaceForOrganization", + "supportapp:ListSlackWorkspaceConfigurations" + ] + } + }, + "primaryIdentifier": [ + "/properties/TeamId" + ], + "properties": { + "TeamId": { + "description": "The team ID in Slack, which uniquely identifies a workspace.", + "maxLength": 256, + "minLength": 1, + "pattern": "^\\S+$", + "type": "string" + }, + "VersionId": { + "description": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[0-9]+$", + "type": "string" + } + }, + "required": [ + "TeamId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-supportapp.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SupportApp::SlackWorkspaceConfiguration", + "writeOnlyProperties": [ + "/properties/VersionId" + ] +} diff --git a/schema/aws-synthetics-canary.json b/schema/aws-synthetics-canary.json index f49f5fc..a622e4e 100644 --- a/schema/aws-synthetics-canary.json +++ b/schema/aws-synthetics-canary.json @@ -1,411 +1,405 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ArtifactConfig": { - "additionalProperties": false, - "properties": { - "S3Encryption": { - "$ref": "#/definitions/S3Encryption", - "description": "Encryption configuration for uploading artifacts to S3" - } - }, - "type": "object" - }, - "BaseScreenshot": { - "properties": { - "IgnoreCoordinates": { - "description": "List of coordinates of rectangles to be ignored during visual testing", - "items": { - "description": "Coordinates of a rectangle to be ignored during visual testing", - "type": "string" - }, - "type": "array" - }, - "ScreenshotName": { - "description": "Name of the screenshot to be used as base reference for visual testing", - "type": "string" - } - }, - "required": [ - "ScreenshotName" - ], - "type": "object" - }, - "Code": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "S3Bucket", - "S3Key" - ] - }, - { - "required": [ - "Script" - ] - } - ], - "properties": { - "Handler": { - "type": "string" - }, - "S3Bucket": { - "relationshipRef": { - "propertyPath": "/properties/BucketName", - "typeName": "AWS::S3::Bucket" - }, - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - }, - "Script": { - "type": "string" - }, - "SourceLocationArn": { - "type": "string" - } - }, - "required": [ - "Handler" - ], - "type": "object" - }, - "RunConfig": { - "additionalProperties": false, - "properties": { - "ActiveTracing": { - "description": "Enable active tracing if set to true", - "type": "boolean" - }, - "EnvironmentVariables": { - "additionalProperties": false, - "description": "Environment variable key-value pairs.", - "patternProperties": { - "[a-zA-Z][a-zA-Z0-9_]+": { - "type": "string" - } - }, - "type": "object" - }, - "MemoryInMB": { - "description": "Provide maximum memory available for canary in MB", - "type": "integer" - }, - "TimeoutInSeconds": { - "description": "Provide maximum canary timeout per run in seconds", - "type": "integer" - } - }, - "type": "object" - }, - "S3Encryption": { - "additionalProperties": false, - "properties": { - "EncryptionMode": { - "description": "Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.", - "type": "string" - }, - "KmsKeyArn": { - "description": "KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.", - "type": "string" - } - }, - "type": "object" - }, - "Schedule": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "string" - }, - "Expression": { - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "VPCConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "anyOf": [ - { - "relationshipRef": { - "propertyPath": "/properties/GroupId", - "typeName": "AWS::EC2::SecurityGroup" - } - }, - { - "relationshipRef": { - "propertyPath": "/properties/DefaultSecurityGroup", - "typeName": "AWS::EC2::VPC" - } - } - ], - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "relationshipRef": { - "propertyPath": "/properties/SubnetId", - "typeName": "AWS::EC2::Subnet" - }, - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "relationshipRef": { - "propertyPath": "/properties/VpcId", - "typeName": "AWS::EC2::VPC" - }, - "type": "string" - } - }, - "required": [ - "SubnetIds", - "SecurityGroupIds" - ], - "type": "object" - }, - "VisualReference": { - "additionalProperties": false, - "properties": { - "BaseCanaryRunId": { - "description": "Canary run id to be used as base reference for visual testing", - "type": "string" - }, - "BaseScreenshots": { - "description": "List of screenshots used as base reference for visual testing", - "items": { - "$ref": "#/definitions/BaseScreenshot" - }, - "type": "array" - } - }, - "required": [ - "BaseCanaryRunId" - ], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/DeleteLambdaResourcesOnCanaryDeletion" - ], - "description": "Resource Type definition for AWS::Synthetics::Canary", - "handlers": { - "create": { - "permissions": [ - "synthetics:CreateCanary", - "synthetics:StartCanary", - "synthetics:GetCanary", - "synthetics:TagResource", - "s3:CreateBucket", - "s3:GetObject", - "s3:GetObjectVersion", - "s3:PutBucketEncryption", - "s3:PutEncryptionConfiguration", - "s3:GetBucketLocation", - "lambda:CreateFunction", - "lambda:AddPermission", - "lambda:PublishVersion", - "lambda:UpdateFunctionConfiguration", - "lambda:GetFunctionConfiguration", - "lambda:GetLayerVersionByArn", - "lambda:GetLayerVersion", - "lambda:PublishLayerVersion", - "ec2:DescribeVpcs", - "ec2:DescribeSubnets", - "ec2:DescribeSecurityGroups", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "synthetics:DeleteCanary", - "synthetics:GetCanary" - ] - }, - "list": { - "permissions": [ - "synthetics:DescribeCanaries" - ] - }, - "read": { - "permissions": [ - "synthetics:GetCanary", - "synthetics:DescribeCanaries", - "synthetics:ListTagsForResource", - "iam:ListRoles", - "s3:ListAllMyBuckets", - "s3:GetBucketLocation" - ] - }, - "update": { - "permissions": [ - "synthetics:UpdateCanary", - "synthetics:StartCanary", - "synthetics:StopCanary", - "synthetics:GetCanary", - "synthetics:TagResource", - "synthetics:UntagResource", - "s3:GetObject", - "s3:GetObjectVersion", - "s3:PutBucketEncryption", - "s3:PutEncryptionConfiguration", - "s3:GetBucketLocation", - "lambda:AddPermission", - "lambda:PublishVersion", - "lambda:UpdateFunctionConfiguration", - "lambda:GetFunctionConfiguration", - "lambda:GetLayerVersionByArn", - "lambda:GetLayerVersion", - "lambda:PublishLayerVersion", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "ArtifactConfig": { - "$ref": "#/definitions/ArtifactConfig", - "description": "Provide artifact configuration" - }, - "ArtifactS3Location": { - "description": "Provide the s3 bucket output location for test results", - "pattern": "^(s3|S3)://", - "type": "string" - }, - "Code": { - "$ref": "#/definitions/Code", - "description": "Provide the canary script source" - }, - "DeleteLambdaResourcesOnCanaryDeletion": { - "description": "Deletes associated lambda resources created by Synthetics if set to True. Default is False", - "type": "boolean" - }, - "ExecutionRoleArn": { - "description": "Lambda Execution role used to run your canaries", - "type": "string" - }, - "FailureRetentionPeriod": { - "description": "Retention period of failed canary runs represented in number of days", - "type": "integer" - }, - "Id": { - "description": "Id of the canary", - "type": "string" - }, - "Name": { - "description": "Name of the canary.", - "pattern": "^[0-9a-z_\\-]{1,21}$", - "type": "string" - }, - "RunConfig": { - "$ref": "#/definitions/RunConfig", - "description": "Provide canary run configuration" - }, - "RuntimeVersion": { - "description": "Runtime version of Synthetics Library", - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/Schedule", - "description": "Frequency to run your canaries" - }, - "StartCanaryAfterCreation": { - "description": "Runs canary if set to True. Default is False", - "type": "boolean" - }, - "State": { - "description": "State of the canary", - "type": "string" - }, - "SuccessRetentionPeriod": { - "description": "Retention period of successful canary runs represented in number of days", - "type": "integer" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "VPCConfig": { - "$ref": "#/definitions/VPCConfig", - "description": "Provide VPC Configuration if enabled." - }, - "VisualReference": { - "$ref": "#/definitions/VisualReference", - "description": "Visual reference configuration for visual testing" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/State", - "/properties/Code/SourceLocationArn" - ], - "required": [ - "Name", - "Code", - "ArtifactS3Location", - "ExecutionRoleArn", - "Schedule", - "RuntimeVersion" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", - "tagging": { - "taggable": true - }, - "typeName": "AWS::Synthetics::Canary", - "writeOnlyProperties": [ - "/properties/Code/S3Bucket", - "/properties/Code/S3Key", - "/properties/Code/S3ObjectVersion", - "/properties/Code/Script", - "/properties/DeleteLambdaResourcesOnCanaryDeletion", - "/properties/StartCanaryAfterCreation", - "/properties/RunConfig/EnvironmentVariables", - "/properties/VisualReference" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ArtifactConfig": { + "additionalProperties": false, + "properties": { + "S3Encryption": { + "$ref": "#/definitions/S3Encryption", + "description": "Encryption configuration for uploading artifacts to S3" + } + }, + "type": "object" + }, + "BaseScreenshot": { + "properties": { + "IgnoreCoordinates": { + "description": "List of coordinates of rectangles to be ignored during visual testing", + "items": { + "description": "Coordinates of a rectangle to be ignored during visual testing", + "type": "string" + }, + "type": "array" + }, + "ScreenshotName": { + "description": "Name of the screenshot to be used as base reference for visual testing", + "type": "string" + } + }, + "required": [ + "ScreenshotName" + ], + "type": "object" + }, + "Code": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "S3Bucket", + "S3Key" + ] + }, + { + "required": [ + "Script" + ] + } + ], + "properties": { + "Handler": { + "type": "string" + }, + "S3Bucket": { + "type": "string" + }, + "S3Key": { + "type": "string" + }, + "S3ObjectVersion": { + "type": "string" + }, + "Script": { + "type": "string" + }, + "SourceLocationArn": { + "type": "string" + } + }, + "required": [ + "Handler" + ], + "type": "object" + }, + "ResourceToTag": { + "description": "Specifies which resources canary tags should be replicated to.", + "enum": [ + "lambda-function" + ], + "type": "string" + }, + "RunConfig": { + "additionalProperties": false, + "properties": { + "ActiveTracing": { + "description": "Enable active tracing if set to true", + "type": "boolean" + }, + "EnvironmentVariables": { + "additionalProperties": false, + "description": "Environment variable key-value pairs.", + "patternProperties": { + "[a-zA-Z][a-zA-Z0-9_]+": { + "type": "string" + } + }, + "type": "object" + }, + "MemoryInMB": { + "description": "Provide maximum memory available for canary in MB", + "type": "integer" + }, + "TimeoutInSeconds": { + "description": "Provide maximum canary timeout per run in seconds", + "type": "integer" + } + }, + "type": "object" + }, + "S3Encryption": { + "additionalProperties": false, + "properties": { + "EncryptionMode": { + "description": "Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.", + "type": "string" + }, + "KmsKeyArn": { + "description": "KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.", + "type": "string" + } + }, + "type": "object" + }, + "Schedule": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "string" + }, + "Expression": { + "type": "string" + } + }, + "required": [ + "Expression" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VPCConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "VpcId": { + "type": "string" + } + }, + "required": [ + "SubnetIds", + "SecurityGroupIds" + ], + "type": "object" + }, + "VisualReference": { + "additionalProperties": false, + "properties": { + "BaseCanaryRunId": { + "description": "Canary run id to be used as base reference for visual testing", + "type": "string" + }, + "BaseScreenshots": { + "description": "List of screenshots used as base reference for visual testing", + "items": { + "$ref": "#/definitions/BaseScreenshot" + }, + "type": "array" + } + }, + "required": [ + "BaseCanaryRunId" + ], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/DeleteLambdaResourcesOnCanaryDeletion" + ], + "description": "Resource Type definition for AWS::Synthetics::Canary", + "handlers": { + "create": { + "permissions": [ + "synthetics:CreateCanary", + "synthetics:StartCanary", + "synthetics:GetCanary", + "synthetics:TagResource", + "s3:CreateBucket", + "s3:GetObject", + "s3:GetObjectVersion", + "s3:PutBucketEncryption", + "s3:PutEncryptionConfiguration", + "s3:GetBucketLocation", + "lambda:CreateFunction", + "lambda:AddPermission", + "lambda:PublishVersion", + "lambda:UpdateFunctionConfiguration", + "lambda:GetFunctionConfiguration", + "lambda:GetLayerVersionByArn", + "lambda:GetLayerVersion", + "lambda:PublishLayerVersion", + "lambda:TagResource", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "synthetics:DeleteCanary", + "synthetics:GetCanary" + ] + }, + "list": { + "permissions": [ + "synthetics:DescribeCanaries" + ] + }, + "read": { + "permissions": [ + "synthetics:GetCanary", + "synthetics:DescribeCanaries", + "synthetics:ListTagsForResource", + "iam:ListRoles", + "s3:ListAllMyBuckets", + "s3:GetBucketLocation" + ] + }, + "update": { + "permissions": [ + "synthetics:UpdateCanary", + "synthetics:StartCanary", + "synthetics:StopCanary", + "synthetics:GetCanary", + "synthetics:TagResource", + "synthetics:UntagResource", + "s3:GetObject", + "s3:GetObjectVersion", + "s3:PutBucketEncryption", + "s3:PutEncryptionConfiguration", + "s3:GetBucketLocation", + "lambda:AddPermission", + "lambda:PublishVersion", + "lambda:UpdateFunctionConfiguration", + "lambda:GetFunctionConfiguration", + "lambda:GetLayerVersionByArn", + "lambda:GetLayerVersion", + "lambda:PublishLayerVersion", + "lambda:ListTags", + "lambda:TagResource", + "lambda:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "ArtifactConfig": { + "$ref": "#/definitions/ArtifactConfig", + "description": "Provide artifact configuration" + }, + "ArtifactS3Location": { + "description": "Provide the s3 bucket output location for test results", + "pattern": "^(s3|S3)://", + "type": "string" + }, + "Code": { + "$ref": "#/definitions/Code", + "description": "Provide the canary script source" + }, + "DeleteLambdaResourcesOnCanaryDeletion": { + "description": "Deletes associated lambda resources created by Synthetics if set to True. Default is False", + "type": "boolean" + }, + "ExecutionRoleArn": { + "description": "Lambda Execution role used to run your canaries", + "type": "string" + }, + "FailureRetentionPeriod": { + "description": "Retention period of failed canary runs represented in number of days", + "type": "integer" + }, + "Id": { + "description": "Id of the canary", + "type": "string" + }, + "Name": { + "description": "Name of the canary.", + "pattern": "^[0-9a-z_\\-]{1,255}$", + "type": "string" + }, + "ResourcesToReplicateTags": { + "description": "List of resources which canary tags should be replicated to.", + "items": { + "$ref": "#/definitions/ResourceToTag" + }, + "type": "array", + "uniqueItems": true + }, + "RunConfig": { + "$ref": "#/definitions/RunConfig", + "description": "Provide canary run configuration" + }, + "RuntimeVersion": { + "description": "Runtime version of Synthetics Library", + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/Schedule", + "description": "Frequency to run your canaries" + }, + "StartCanaryAfterCreation": { + "description": "Runs canary if set to True. Default is False", + "type": "boolean" + }, + "State": { + "description": "State of the canary", + "type": "string" + }, + "SuccessRetentionPeriod": { + "description": "Retention period of successful canary runs represented in number of days", + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "VPCConfig": { + "$ref": "#/definitions/VPCConfig", + "description": "Provide VPC Configuration if enabled." + }, + "VisualReference": { + "$ref": "#/definitions/VisualReference", + "description": "Visual reference configuration for visual testing" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/State", + "/properties/Code/SourceLocationArn" + ], + "required": [ + "Name", + "Code", + "ArtifactS3Location", + "ExecutionRoleArn", + "Schedule", + "RuntimeVersion" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", + "tagging": { + "taggable": true + }, + "typeName": "AWS::Synthetics::Canary", + "writeOnlyProperties": [ + "/properties/Code/S3Bucket", + "/properties/Code/S3Key", + "/properties/Code/S3ObjectVersion", + "/properties/Code/Script", + "/properties/DeleteLambdaResourcesOnCanaryDeletion", + "/properties/StartCanaryAfterCreation", + "/properties/ResourcesToReplicateTags", + "/properties/RunConfig/EnvironmentVariables", + "/properties/VisualReference" + ] +} diff --git a/schema/aws-synthetics-group.json b/schema/aws-synthetics-group.json index 20893f5..6292e27 100644 --- a/schema/aws-synthetics-group.json +++ b/schema/aws-synthetics-group.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ResourceArn": { - "description": "Provide Canary Arn associated with the group.", - "pattern": "arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)([a-zA-Z\\d\\s_.:/=+\\-@]+)$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "pattern": "^([a-zA-Z\\d\\s_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Synthetics::Group", - "handlers": { - "create": { - "permissions": [ - "synthetics:CreateGroup", - "synthetics:AssociateResource", - "synthetics:TagResource", - "synthetics:GetGroup" - ] - }, - "delete": { - "permissions": [ - "synthetics:DeleteGroup", - "synthetics:GetGroup" - ] - }, - "list": { - "permissions": [ - "synthetics:ListGroups" - ] - }, - "read": { - "permissions": [ - "synthetics:GetGroup", - "synthetics:ListTagsForResource", - "synthetics:ListGroupResources" - ] - }, - "update": { - "permissions": [ - "synthetics:AssociateResource", - "synthetics:DisassociateResource", - "synthetics:TagResource", - "synthetics:UntagResource", - "synthetics:GetGroup", - "synthetics:ListGroupResources" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name" - ], - "properties": { - "Id": { - "description": "Id of the group.", - "type": "string" - }, - "Name": { - "description": "Name of the group.", - "pattern": "^[0-9a-z_\\-]{1,64}$", - "type": "string" - }, - "ResourceArns": { - "items": { - "$ref": "#/definitions/ResourceArn" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 0, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", - "tagging": { - "taggable": true - }, - "typeName": "AWS::Synthetics::Group" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ResourceArn": { + "description": "Provide Canary Arn associated with the group.", + "pattern": "arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b|e|f?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)([a-zA-Z\\d\\s_.:/=+\\-@]+)$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "^([a-zA-Z\\d\\s_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Synthetics::Group", + "handlers": { + "create": { + "permissions": [ + "synthetics:CreateGroup", + "synthetics:AssociateResource", + "synthetics:TagResource", + "synthetics:GetGroup" + ] + }, + "delete": { + "permissions": [ + "synthetics:DeleteGroup", + "synthetics:GetGroup" + ] + }, + "list": { + "permissions": [ + "synthetics:ListGroups" + ] + }, + "read": { + "permissions": [ + "synthetics:GetGroup", + "synthetics:ListTagsForResource", + "synthetics:ListGroupResources" + ] + }, + "update": { + "permissions": [ + "synthetics:AssociateResource", + "synthetics:DisassociateResource", + "synthetics:TagResource", + "synthetics:UntagResource", + "synthetics:GetGroup", + "synthetics:ListGroupResources" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "Id": { + "description": "Id of the group.", + "type": "string" + }, + "Name": { + "description": "Name of the group.", + "pattern": "^[0-9a-z_\\-]{1,64}$", + "type": "string" + }, + "ResourceArns": { + "items": { + "$ref": "#/definitions/ResourceArn" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", + "tagging": { + "taggable": true + }, + "typeName": "AWS::Synthetics::Group" +} diff --git a/schema/aws-systemsmanagersap-application.json b/schema/aws-systemsmanagersap-application.json index 35de429..5f7d498 100644 --- a/schema/aws-systemsmanagersap-application.json +++ b/schema/aws-systemsmanagersap-application.json @@ -1,167 +1,181 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Credentials", - "/properties/Instances", - "/properties/SapInstanceNumber", - "/properties/Sid" - ], - "definitions": { - "Credential": { - "additionalProperties": false, - "properties": { - "CredentialType": { - "enum": [ - "ADMIN" - ], - "type": "string" - }, - "DatabaseName": { - "pattern": "^(?=.{1,100}$).*", - "type": "string" - }, - "SecretId": { - "pattern": "^(?=.{1,100}$).*", - "type": "string" - } - }, - "type": "object" - }, - "Instance": { - "pattern": "^i-[\\w\\d]{8}$|^i-[\\w\\d]{17}$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource schema for AWS::SystemsManagerSAP::Application", - "handlers": { - "create": { - "permissions": [ - "ssm-sap:RegisterApplication", - "ssm-sap:GetApplication", - "ssm-sap:TagResource", - "ssm-sap:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "ssm-sap:DeregisterApplication", - "ssm-sap:GetApplication" - ] - }, - "list": { - "permissions": [ - "ssm-sap:ListApplications" - ] - }, - "read": { - "permissions": [ - "ssm-sap:GetApplication", - "ssm-sap:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "ssm-sap:TagResource", - "ssm-sap:UntagResource", - "ssm-sap:ListTagsForResource", - "ssm-sap:GetApplication" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "ApplicationId": { - "pattern": "[\\w\\d]{1,50}", - "type": "string" - }, - "ApplicationType": { - "enum": [ - "HANA" - ], - "type": "string" - }, - "Arn": { - "description": "The ARN of the Helix application", - "pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$", - "type": "string" - }, - "Credentials": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Credential" - }, - "minItems": 1, - "type": "array" - }, - "Instances": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Instance" - }, - "minItems": 1, - "type": "array" - }, - "SapInstanceNumber": { - "pattern": "[0-9]{2}", - "type": "string" - }, - "Sid": { - "pattern": "[A-Z][A-Z0-9]{2}", - "type": "string" - }, - "Tags": { - "description": "The tags of a SystemsManagerSAP application.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "required": [ - "ApplicationId", - "ApplicationType" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::SystemsManagerSAP::Application", - "writeOnlyProperties": [ - "/properties/Credentials", - "/properties/Instances", - "/properties/SapInstanceNumber", - "/properties/Sid" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Credentials", + "/properties/Instances", + "/properties/SapInstanceNumber", + "/properties/Sid", + "/properties/DatabaseArn" + ], + "definitions": { + "Credential": { + "additionalProperties": false, + "properties": { + "CredentialType": { + "enum": [ + "ADMIN" + ], + "type": "string" + }, + "DatabaseName": { + "pattern": "^(?=.{1,100}$).*", + "type": "string" + }, + "SecretId": { + "pattern": "^(?=.{1,100}$).*", + "type": "string" + } + }, + "type": "object" + }, + "Instance": { + "pattern": "^i-[\\w\\d]{8}$|^i-[\\w\\d]{17}$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource schema for AWS::SystemsManagerSAP::Application", + "handlers": { + "create": { + "permissions": [ + "ssm-sap:RegisterApplication", + "ssm-sap:GetApplication", + "ssm-sap:TagResource", + "ssm-sap:ListTagsForResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "ssm-sap:DeregisterApplication", + "ssm-sap:GetApplication" + ] + }, + "list": { + "permissions": [ + "ssm-sap:ListApplications" + ] + }, + "read": { + "permissions": [ + "ssm-sap:GetApplication", + "ssm-sap:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ssm-sap:TagResource", + "ssm-sap:UntagResource", + "ssm-sap:ListTagsForResource", + "ssm-sap:GetApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "ApplicationId": { + "pattern": "[\\w\\d\\.-]{1,60}", + "type": "string" + }, + "ApplicationType": { + "enum": [ + "HANA", + "SAP_ABAP" + ], + "type": "string" + }, + "Arn": { + "description": "The ARN of the SSM-SAP application", + "pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$", + "type": "string" + }, + "Credentials": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Credential" + }, + "minItems": 1, + "type": "array" + }, + "DatabaseArn": { + "description": "The ARN of the SAP HANA database", + "pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$", + "type": "string" + }, + "Instances": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Instance" + }, + "minItems": 1, + "type": "array" + }, + "SapInstanceNumber": { + "pattern": "[0-9]{2}", + "type": "string" + }, + "Sid": { + "pattern": "[A-Z][A-Z0-9]{2}", + "type": "string" + }, + "Tags": { + "description": "The tags of a SystemsManagerSAP application.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "ApplicationId", + "ApplicationType" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "ssm-sap:UntagResource", + "ssm-sap:TagResource", + "ssm-sap:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SystemsManagerSAP::Application", + "writeOnlyProperties": [ + "/properties/Credentials", + "/properties/Instances", + "/properties/SapInstanceNumber", + "/properties/Sid", + "/properties/DatabaseArn" + ] +} diff --git a/schema/aws-timestream-database.json b/schema/aws-timestream-database.json index e47c9ed..6a9de39 100644 --- a/schema/aws-timestream-database.json +++ b/schema/aws-timestream-database.json @@ -1,99 +1,99 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatabaseName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::Timestream::Database resource creates a Timestream database.", - "handlers": { - "create": { - "permissions": [ - "timestream:CreateDatabase", - "timestream:DescribeEndpoints", - "timestream:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "timestream:DeleteDatabase", - "timestream:DescribeEndpoints" - ] - }, - "list": { - "permissions": [ - "timestream:ListDatabases", - "timestream:DescribeEndpoints" - ] - }, - "read": { - "permissions": [ - "timestream:DescribeDatabase", - "timestream:DescribeEndpoints", - "timestream:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "timestream:UpdateDatabase", - "timestream:DescribeDatabase", - "timestream:DescribeEndpoints", - "timestream:TagResource", - "timestream:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatabaseName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DatabaseName": { - "description": "The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.", - "pattern": "^[a-zA-Z0-9_.-]{3,256}$", - "type": "string" - }, - "KmsKeyId": { - "description": "The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", - "typeName": "AWS::Timestream::Database" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatabaseName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::Timestream::Database resource creates a Timestream database.", + "handlers": { + "create": { + "permissions": [ + "timestream:CreateDatabase", + "timestream:DescribeEndpoints", + "timestream:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "timestream:DeleteDatabase", + "timestream:DescribeEndpoints" + ] + }, + "list": { + "permissions": [ + "timestream:ListDatabases", + "timestream:DescribeEndpoints" + ] + }, + "read": { + "permissions": [ + "timestream:DescribeDatabase", + "timestream:DescribeEndpoints", + "timestream:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "timestream:UpdateDatabase", + "timestream:DescribeDatabase", + "timestream:DescribeEndpoints", + "timestream:TagResource", + "timestream:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatabaseName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DatabaseName": { + "description": "The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.", + "pattern": "^[a-zA-Z0-9_.-]{3,256}$", + "type": "string" + }, + "KmsKeyId": { + "description": "The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", + "typeName": "AWS::Timestream::Database" +} diff --git a/schema/aws-timestream-influxdbinstance.json b/schema/aws-timestream-influxdbinstance.json index 6571c54..b1fce7f 100644 --- a/schema/aws-timestream-influxdbinstance.json +++ b/schema/aws-timestream-influxdbinstance.json @@ -1,314 +1,314 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Username", - "/properties/Password", - "/properties/Organization", - "/properties/Bucket", - "/properties/DbInstanceType", - "/properties/VpcSubnetIds", - "/properties/VpcSecurityGroupIds", - "/properties/PubliclyAccessible", - "/properties/DbStorageType", - "/properties/AllocatedStorage", - "/properties/DeploymentType" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - } - }, - "description": "The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.", - "handlers": { - "create": { - "permissions": [ - "s3:ListBucket", - "s3:GetBucketPolicy", - "timestream-influxdb:GetDbInstance", - "timestream-influxdb:ListDbInstances", - "timestream-influxdb:CreateDbInstance", - "timestream-influxdb:TagResource", - "timestream-influxdb:ListTagsForResource", - "ec2:DescribeSubnets", - "ec2:DescribeVpcs", - "ec2:DescribeNetworkInterfaces", - "ec2:DescribeSecurityGroups", - "ec2:CreateNetworkInterface", - "iam:CreateServiceLinkedRole" - ], - "timeoutInMinutes": 2160 - }, - "delete": { - "permissions": [ - "timestream-influxdb:GetDbInstance", - "timestream-influxdb:ListDbInstances", - "timestream-influxdb:DeleteDbInstance" - ], - "timeoutInMinutes": 2160 - }, - "list": { - "permissions": [ - "timestream-influxdb:ListDbInstances" - ], - "timeoutInMinutes": 2160 - }, - "read": { - "permissions": [ - "timestream-influxdb:GetDbInstance", - "timestream-influxdb:ListTagsForResource" - ], - "timeoutInMinutes": 2160 - }, - "update": { - "permissions": [ - "s3:ListBucket", - "s3:GetBucketPolicy", - "timestream-influxdb:GetDbInstance", - "timestream-influxdb:ListDbInstances", - "timestream-influxdb:UpdateDbInstance", - "timestream-influxdb:TagResource", - "timestream-influxdb:UntagResource", - "timestream-influxdb:ListTagsForResource" - ], - "timeoutInMinutes": 2160 - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "AllocatedStorage": { - "description": "The allocated storage for the InfluxDB instance.", - "maximum": 16384, - "minimum": 20, - "type": "integer" - }, - "Arn": { - "description": "The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.", - "maxLength": 1011, - "minLength": 1, - "pattern": "^arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance)/[a-zA-Z0-9]{3,64}$", - "type": "string" - }, - "AvailabilityZone": { - "description": "The Availability Zone (AZ) where the InfluxDB instance is created.", - "type": "string" - }, - "Bucket": { - "description": "The bucket for the InfluxDB instance.", - "maxLength": 64, - "minLength": 2, - "pattern": "^[^_][^\"]*$", - "type": "string" - }, - "DbInstanceType": { - "description": "The compute instance of the InfluxDB instance.", - "enum": [ - "db.influx.medium", - "db.influx.large", - "db.influx.xlarge", - "db.influx.2xlarge", - "db.influx.4xlarge", - "db.influx.8xlarge", - "db.influx.12xlarge", - "db.influx.16xlarge" - ], - "type": "string" - }, - "DbParameterGroupIdentifier": { - "description": "The name of an existing InfluxDB parameter group.", - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "DbStorageType": { - "description": "The storage type of the InfluxDB instance.", - "enum": [ - "InfluxIOIncludedT1", - "InfluxIOIncludedT2", - "InfluxIOIncludedT3" - ], - "type": "string" - }, - "DeploymentType": { - "description": "Deployment type of the InfluxDB Instance.", - "enum": [ - "SINGLE_AZ", - "WITH_MULTIAZ_STANDBY" - ], - "type": "string" - }, - "Endpoint": { - "description": "The connection endpoint for the InfluxDB instance.", - "type": "string" - }, - "Id": { - "description": "The service generated unique identifier for InfluxDB instance.", - "maxLength": 64, - "minLength": 3, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "InfluxAuthParametersSecretArn": { - "description": "The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.", - "pattern": "^arn:[a-z]*:secretsmanager:[a-z\\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\\-]*", - "type": "string" - }, - "LogDeliveryConfiguration": { - "additionalProperties": false, - "description": "Configuration for sending logs to customer account from the InfluxDB instance.", - "properties": { - "S3Configuration": { - "additionalProperties": false, - "description": "S3 configuration for sending logs to customer account from the InfluxDB instance.", - "properties": { - "BucketName": { - "description": "The bucket name for logs to be sent from the InfluxDB instance", - "maxLength": 63, - "minLength": 3, - "pattern": "^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$", - "type": "string" - }, - "Enabled": { - "description": "Specifies whether logging to customer specified bucket is enabled.", - "type": "boolean" - } - }, - "required": [ - "Enabled", - "BucketName" - ], - "type": "object" - } - }, - "required": [ - "S3Configuration" - ], - "type": "object" - }, - "Name": { - "description": "The unique name that is associated with the InfluxDB instance.", - "maxLength": 40, - "minLength": 3, - "pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$", - "type": "string" - }, - "Organization": { - "description": "The organization for the InfluxDB instance.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "Password": { - "description": "The password for the InfluxDB instance.", - "maxLength": 64, - "minLength": 8, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "PubliclyAccessible": { - "default": false, - "description": "Attach a public IP to the customer ENI.", - "type": "boolean" - }, - "SecondaryAvailabilityZone": { - "description": "The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.", - "type": "string" - }, - "Status": { - "description": "Status of the InfluxDB Instance.", - "enum": [ - "CREATING", - "AVAILABLE", - "DELETING", - "MODIFYING", - "UPDATING", - "DELETED", - "FAILED" - ], - "type": "string" - }, - "Tags": { - "description": "An arbitrary set of tags (key-value pairs) for this DB instance.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "Username": { - "description": "The username for the InfluxDB instance.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "VpcSecurityGroupIds": { - "description": "A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "VpcSubnetIds": { - "description": "A list of EC2 subnet IDs for this InfluxDB instance.", - "insertionOrder": false, - "items": { - "type": "string" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Status", - "/properties/Arn", - "/properties/Id", - "/properties/AvailabilityZone", - "/properties/Endpoint", - "/properties/SecondaryAvailabilityZone", - "/properties/InfluxAuthParametersSecretArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Timestream::InfluxDBInstance", - "writeOnlyProperties": [ - "/properties/Username", - "/properties/Password", - "/properties/Organization", - "/properties/Bucket" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Username", + "/properties/Password", + "/properties/Organization", + "/properties/Bucket", + "/properties/DbInstanceType", + "/properties/VpcSubnetIds", + "/properties/VpcSecurityGroupIds", + "/properties/PubliclyAccessible", + "/properties/DbStorageType", + "/properties/AllocatedStorage", + "/properties/DeploymentType" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.", + "handlers": { + "create": { + "permissions": [ + "s3:ListBucket", + "s3:GetBucketPolicy", + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:CreateDbInstance", + "timestream-influxdb:TagResource", + "timestream-influxdb:ListTagsForResource", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:CreateNetworkInterface", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:DeleteDbInstance" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "timestream-influxdb:ListDbInstances" + ], + "timeoutInMinutes": 2160 + }, + "read": { + "permissions": [ + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListTagsForResource" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "s3:ListBucket", + "s3:GetBucketPolicy", + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:UpdateDbInstance", + "timestream-influxdb:TagResource", + "timestream-influxdb:UntagResource", + "timestream-influxdb:ListTagsForResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllocatedStorage": { + "description": "The allocated storage for the InfluxDB instance.", + "maximum": 16384, + "minimum": 20, + "type": "integer" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.", + "maxLength": 1011, + "minLength": 1, + "pattern": "^arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance)/[a-zA-Z0-9]{3,64}$", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone (AZ) where the InfluxDB instance is created.", + "type": "string" + }, + "Bucket": { + "description": "The bucket for the InfluxDB instance.", + "maxLength": 64, + "minLength": 2, + "pattern": "^[^_][^\"]*$", + "type": "string" + }, + "DbInstanceType": { + "description": "The compute instance of the InfluxDB instance.", + "enum": [ + "db.influx.medium", + "db.influx.large", + "db.influx.xlarge", + "db.influx.2xlarge", + "db.influx.4xlarge", + "db.influx.8xlarge", + "db.influx.12xlarge", + "db.influx.16xlarge" + ], + "type": "string" + }, + "DbParameterGroupIdentifier": { + "description": "The name of an existing InfluxDB parameter group.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "DbStorageType": { + "description": "The storage type of the InfluxDB instance.", + "enum": [ + "InfluxIOIncludedT1", + "InfluxIOIncludedT2", + "InfluxIOIncludedT3" + ], + "type": "string" + }, + "DeploymentType": { + "description": "Deployment type of the InfluxDB Instance.", + "enum": [ + "SINGLE_AZ", + "WITH_MULTIAZ_STANDBY" + ], + "type": "string" + }, + "Endpoint": { + "description": "The connection endpoint for the InfluxDB instance.", + "type": "string" + }, + "Id": { + "description": "The service generated unique identifier for InfluxDB instance.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "InfluxAuthParametersSecretArn": { + "description": "The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.", + "pattern": "^arn:[a-z]*:secretsmanager:[a-z\\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\\-]*", + "type": "string" + }, + "LogDeliveryConfiguration": { + "additionalProperties": false, + "description": "Configuration for sending logs to customer account from the InfluxDB instance.", + "properties": { + "S3Configuration": { + "additionalProperties": false, + "description": "S3 configuration for sending logs to customer account from the InfluxDB instance.", + "properties": { + "BucketName": { + "description": "The bucket name for logs to be sent from the InfluxDB instance", + "maxLength": 63, + "minLength": 3, + "pattern": "^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$", + "type": "string" + }, + "Enabled": { + "description": "Specifies whether logging to customer specified bucket is enabled.", + "type": "boolean" + } + }, + "required": [ + "Enabled", + "BucketName" + ], + "type": "object" + } + }, + "required": [ + "S3Configuration" + ], + "type": "object" + }, + "Name": { + "description": "The unique name that is associated with the InfluxDB instance.", + "maxLength": 40, + "minLength": 3, + "pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$", + "type": "string" + }, + "Organization": { + "description": "The organization for the InfluxDB instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Password": { + "description": "The password for the InfluxDB instance.", + "maxLength": 64, + "minLength": 8, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "PubliclyAccessible": { + "default": false, + "description": "Attach a public IP to the customer ENI.", + "type": "boolean" + }, + "SecondaryAvailabilityZone": { + "description": "The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.", + "type": "string" + }, + "Status": { + "description": "Status of the InfluxDB Instance.", + "enum": [ + "CREATING", + "AVAILABLE", + "DELETING", + "MODIFYING", + "UPDATING", + "DELETED", + "FAILED" + ], + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this DB instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Username": { + "description": "The username for the InfluxDB instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "VpcSecurityGroupIds": { + "description": "A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "VpcSubnetIds": { + "description": "A list of EC2 subnet IDs for this InfluxDB instance.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn", + "/properties/Id", + "/properties/AvailabilityZone", + "/properties/Endpoint", + "/properties/SecondaryAvailabilityZone", + "/properties/InfluxAuthParametersSecretArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Timestream::InfluxDBInstance", + "writeOnlyProperties": [ + "/properties/Username", + "/properties/Password", + "/properties/Organization", + "/properties/Bucket" + ] +} diff --git a/schema/aws-timestream-scheduledquery.json b/schema/aws-timestream-scheduledquery.json index 7d4a8c5..6852636 100644 --- a/schema/aws-timestream-scheduledquery.json +++ b/schema/aws-timestream-scheduledquery.json @@ -1,546 +1,546 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ScheduledQueryName", - "/properties/QueryString", - "/properties/ScheduleConfiguration", - "/properties/NotificationConfiguration", - "/properties/ClientToken", - "/properties/ScheduledQueryExecutionRoleArn", - "/properties/TargetConfiguration", - "/properties/ErrorReportConfiguration", - "/properties/KmsKeyId" - ], - "definitions": { - "Arn": { - "description": "Amazon Resource Name of the scheduled query that is generated upon creation.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "BucketName": { - "description": "Name of the S3 bucket under which error reports will be created.", - "maxLength": 63, - "minLength": 3, - "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", - "type": "string" - }, - "ClientToken": { - "description": "Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.", - "maxLength": 128, - "minLength": 32, - "type": "string" - }, - "DatabaseName": { - "description": "Name of Timestream database to which the query result will be written.", - "type": "string" - }, - "DimensionMapping": { - "additionalProperties": false, - "description": "This type is used to map column(s) from the query result to a dimension in the destination table.", - "properties": { - "DimensionValueType": { - "$ref": "#/definitions/DimensionValueType" - }, - "Name": { - "$ref": "#/definitions/DimensionMappingName" - } - }, - "required": [ - "Name", - "DimensionValueType" - ], - "type": "object" - }, - "DimensionMappingName": { - "description": "Column name from query result.", - "type": "string" - }, - "DimensionMappings": { - "description": "This is to allow mapping column(s) from the query result to the dimension in the destination table.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DimensionMapping" - }, - "type": "array" - }, - "DimensionValueType": { - "description": "Type for the dimension.", - "enum": [ - "VARCHAR" - ], - "type": "string" - }, - "EncryptionOption": { - "description": "Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.", - "enum": [ - "SSE_S3", - "SSE_KMS" - ], - "type": "string" - }, - "ErrorReportConfiguration": { - "additionalProperties": false, - "description": "Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.", - "properties": { - "S3Configuration": { - "$ref": "#/definitions/S3Configuration" - } - }, - "required": [ - "S3Configuration" - ], - "type": "object" - }, - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "KmsKeyId": { - "description": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "MeasureNameColumn": { - "description": "Name of the measure name column from the query result.", - "type": "string" - }, - "MixedMeasureMapping": { - "additionalProperties": false, - "description": "MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.", - "properties": { - "MeasureName": { - "$ref": "#/definitions/MixedMeasureMappingMeasureName" - }, - "MeasureValueType": { - "$ref": "#/definitions/MixedMeasureMappingMeasureValueType" - }, - "MultiMeasureAttributeMappings": { - "$ref": "#/definitions/MultiMeasureAttributeMappingList" - }, - "SourceColumn": { - "$ref": "#/definitions/MixedMeasureMappingSourceColumn" - }, - "TargetMeasureName": { - "$ref": "#/definitions/MixedMeasureMappingTargetMeasureName" - } - }, - "required": [ - "MeasureValueType" - ], - "type": "object" - }, - "MixedMeasureMappingMeasureName": { - "description": "Refers to the value of the measure name in a result row. This field is required if MeasureNameColumn is provided.", - "type": "string" - }, - "MixedMeasureMappingMeasureValueType": { - "description": "Type of the value that is to be read from SourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.", - "enum": [ - "BIGINT", - "BOOLEAN", - "DOUBLE", - "VARCHAR", - "MULTI" - ], - "type": "string" - }, - "MixedMeasureMappingSourceColumn": { - "description": "This field refers to the source column from which the measure value is to be read for result materialization.", - "type": "string" - }, - "MixedMeasureMappingTargetMeasureName": { - "description": "Target measure name to be used. If not provided, the target measure name by default would be MeasureName if provided, or SourceColumn otherwise.", - "type": "string" - }, - "MixedMeasureMappings": { - "description": "Specifies how to map measures to multi-measure records.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MixedMeasureMapping" - }, - "minItems": 1, - "type": "array" - }, - "MultiMeasureAttributeMapping": { - "additionalProperties": false, - "description": "An attribute mapping to be used for mapping query results to ingest data for multi-measure attributes.", - "properties": { - "MeasureValueType": { - "$ref": "#/definitions/MultiMeasureAttributeMappingMeasureValueType" - }, - "SourceColumn": { - "$ref": "#/definitions/MultiMeasureAttributeMappingSourceColumn" - }, - "TargetMultiMeasureAttributeName": { - "$ref": "#/definitions/TargetMultiMeasureAttributeName" - } - }, - "required": [ - "SourceColumn", - "MeasureValueType" - ], - "type": "object" - }, - "MultiMeasureAttributeMappingList": { - "description": "Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MultiMeasureAttributeMapping" - }, - "minItems": 1, - "type": "array" - }, - "MultiMeasureAttributeMappingMeasureValueType": { - "description": "Value type of the measure value column to be read from the query result.", - "enum": [ - "BIGINT", - "BOOLEAN", - "DOUBLE", - "VARCHAR", - "TIMESTAMP" - ], - "type": "string" - }, - "MultiMeasureAttributeMappingSourceColumn": { - "description": "Source measure value column in the query result where the attribute value is to be read.", - "type": "string" - }, - "MultiMeasureMappings": { - "additionalProperties": false, - "description": "Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.", - "properties": { - "MultiMeasureAttributeMappings": { - "$ref": "#/definitions/MultiMeasureAttributeMappingList" - }, - "TargetMultiMeasureName": { - "$ref": "#/definitions/TargetMultiMeasureName" - } - }, - "required": [ - "MultiMeasureAttributeMappings" - ], - "type": "object" - }, - "NotificationConfiguration": { - "additionalProperties": false, - "description": "Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.", - "properties": { - "SnsConfiguration": { - "$ref": "#/definitions/SnsConfiguration" - } - }, - "required": [ - "SnsConfiguration" - ], - "type": "object" - }, - "ObjectKeyPrefix": { - "description": "Prefix for error report keys.", - "maxLength": 896, - "minLength": 1, - "pattern": "[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+", - "type": "string" - }, - "QueryString": { - "description": "The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.", - "maxLength": 262144, - "minLength": 1, - "type": "string" - }, - "S3Configuration": { - "additionalProperties": false, - "description": "Details on S3 location for error reports that result from running a query.", - "properties": { - "BucketName": { - "$ref": "#/definitions/BucketName" - }, - "EncryptionOption": { - "$ref": "#/definitions/EncryptionOption" - }, - "ObjectKeyPrefix": { - "$ref": "#/definitions/ObjectKeyPrefix" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "ScheduleConfiguration": { - "additionalProperties": false, - "description": "Configuration for when the scheduled query is executed.", - "properties": { - "ScheduleExpression": { - "$ref": "#/definitions/ScheduleExpression" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "ScheduleExpression": { - "description": "An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "ScheduledQueryExecutionRoleArn": { - "description": "The ARN for the IAM role that Timestream will assume when running the scheduled query.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "ScheduledQueryName": { - "description": "The name of the scheduled query. Scheduled query names must be unique within each Region.", - "maxLength": 64, - "minLength": 1, - "pattern": "[a-zA-Z0-9_.-]+", - "type": "string" - }, - "SnsConfiguration": { - "additionalProperties": false, - "description": "SNS configuration for notification upon scheduled query execution.", - "properties": { - "TopicArn": { - "$ref": "#/definitions/TopicArn" - } - }, - "required": [ - "TopicArn" - ], - "type": "object" - }, - "TableName": { - "description": "Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to label the scheduled query.", - "properties": { - "Key": { - "$ref": "#/definitions/Key" - }, - "Value": { - "$ref": "#/definitions/Value" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "A list of key-value pairs to label the scheduled query.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - }, - "TargetConfiguration": { - "additionalProperties": false, - "description": "Configuration of target store where scheduled query results are written to.", - "properties": { - "TimestreamConfiguration": { - "$ref": "#/definitions/TimestreamConfiguration" - } - }, - "required": [ - "TimestreamConfiguration" - ], - "type": "object" - }, - "TargetMultiMeasureAttributeName": { - "description": "Custom name to be used for attribute name in derived table. If not provided, source column name would be used.", - "type": "string" - }, - "TargetMultiMeasureName": { - "description": "Name of the target multi-measure in the derived table. Required if MeasureNameColumn is not provided. If MeasureNameColumn is provided then the value from that column will be used as the multi-measure name.", - "type": "string" - }, - "TimeColumn": { - "description": "Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.", - "type": "string" - }, - "TimestreamConfiguration": { - "additionalProperties": false, - "description": "Configuration needed to write data into the Timestream database and table.", - "properties": { - "DatabaseName": { - "$ref": "#/definitions/DatabaseName" - }, - "DimensionMappings": { - "$ref": "#/definitions/DimensionMappings" - }, - "MeasureNameColumn": { - "$ref": "#/definitions/MeasureNameColumn" - }, - "MixedMeasureMappings": { - "$ref": "#/definitions/MixedMeasureMappings" - }, - "MultiMeasureMappings": { - "$ref": "#/definitions/MultiMeasureMappings" - }, - "TableName": { - "$ref": "#/definitions/TableName" - }, - "TimeColumn": { - "$ref": "#/definitions/TimeColumn" - } - }, - "required": [ - "DatabaseName", - "TableName", - "TimeColumn", - "DimensionMappings" - ], - "type": "object" - }, - "TopicArn": { - "description": "SNS topic ARN that the scheduled query status notifications will be sent to.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "description": "The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.", - "handlers": { - "create": { - "permissions": [ - "timestream:CreateScheduledQuery", - "timestream:DescribeEndpoints" - ] - }, - "delete": { - "permissions": [ - "timestream:DeleteScheduledQuery", - "timestream:DescribeEndpoints" - ] - }, - "list": { - "permissions": [ - "timestream:ListScheduledQueries", - "timestream:DescribeEndpoints" - ] - }, - "read": { - "permissions": [ - "timestream:DescribeScheduledQuery", - "timestream:ListTagsForResource", - "timestream:DescribeEndpoints" - ] - }, - "update": { - "permissions": [ - "timestream:UpdateScheduledQuery", - "timestream:TagResource", - "timestream:UntagResource", - "timestream:DescribeEndpoints" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/Arn" - }, - "ClientToken": { - "$ref": "#/definitions/ClientToken" - }, - "ErrorReportConfiguration": { - "$ref": "#/definitions/ErrorReportConfiguration" - }, - "KmsKeyId": { - "$ref": "#/definitions/KmsKeyId" - }, - "NotificationConfiguration": { - "$ref": "#/definitions/NotificationConfiguration" - }, - "QueryString": { - "$ref": "#/definitions/QueryString" - }, - "SQErrorReportConfiguration": { - "description": "Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.", - "type": "string" - }, - "SQKmsKeyId": { - "description": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.", - "type": "string" - }, - "SQName": { - "description": "The name of the scheduled query. Scheduled query names must be unique within each Region.", - "type": "string" - }, - "SQNotificationConfiguration": { - "description": "Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.", - "type": "string" - }, - "SQQueryString": { - "description": "The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.", - "type": "string" - }, - "SQScheduleConfiguration": { - "description": "Configuration for when the scheduled query is executed.", - "type": "string" - }, - "SQScheduledQueryExecutionRoleArn": { - "description": "The ARN for the IAM role that Timestream will assume when running the scheduled query.", - "type": "string" - }, - "SQTargetConfiguration": { - "description": "Configuration of target store where scheduled query results are written to.", - "type": "string" - }, - "ScheduleConfiguration": { - "$ref": "#/definitions/ScheduleConfiguration" - }, - "ScheduledQueryExecutionRoleArn": { - "$ref": "#/definitions/ScheduledQueryExecutionRoleArn" - }, - "ScheduledQueryName": { - "$ref": "#/definitions/ScheduledQueryName" - }, - "Tags": { - "$ref": "#/definitions/Tags" - }, - "TargetConfiguration": { - "$ref": "#/definitions/TargetConfiguration" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/SQName", - "/properties/SQQueryString", - "/properties/SQScheduleConfiguration", - "/properties/SQNotificationConfiguration", - "/properties/SQScheduledQueryExecutionRoleArn", - "/properties/SQTargetConfiguration", - "/properties/SQErrorReportConfiguration", - "/properties/SQKmsKeyId" - ], - "required": [ - "QueryString", - "ScheduleConfiguration", - "NotificationConfiguration", - "ScheduledQueryExecutionRoleArn", - "ErrorReportConfiguration" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", - "typeName": "AWS::Timestream::ScheduledQuery" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ScheduledQueryName", + "/properties/QueryString", + "/properties/ScheduleConfiguration", + "/properties/NotificationConfiguration", + "/properties/ClientToken", + "/properties/ScheduledQueryExecutionRoleArn", + "/properties/TargetConfiguration", + "/properties/ErrorReportConfiguration", + "/properties/KmsKeyId" + ], + "definitions": { + "Arn": { + "description": "Amazon Resource Name of the scheduled query that is generated upon creation.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "BucketName": { + "description": "Name of the S3 bucket under which error reports will be created.", + "maxLength": 63, + "minLength": 3, + "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]", + "type": "string" + }, + "ClientToken": { + "description": "Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.", + "maxLength": 128, + "minLength": 32, + "type": "string" + }, + "DatabaseName": { + "description": "Name of Timestream database to which the query result will be written.", + "type": "string" + }, + "DimensionMapping": { + "additionalProperties": false, + "description": "This type is used to map column(s) from the query result to a dimension in the destination table.", + "properties": { + "DimensionValueType": { + "$ref": "#/definitions/DimensionValueType" + }, + "Name": { + "$ref": "#/definitions/DimensionMappingName" + } + }, + "required": [ + "Name", + "DimensionValueType" + ], + "type": "object" + }, + "DimensionMappingName": { + "description": "Column name from query result.", + "type": "string" + }, + "DimensionMappings": { + "description": "This is to allow mapping column(s) from the query result to the dimension in the destination table.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DimensionMapping" + }, + "type": "array" + }, + "DimensionValueType": { + "description": "Type for the dimension.", + "enum": [ + "VARCHAR" + ], + "type": "string" + }, + "EncryptionOption": { + "description": "Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.", + "enum": [ + "SSE_S3", + "SSE_KMS" + ], + "type": "string" + }, + "ErrorReportConfiguration": { + "additionalProperties": false, + "description": "Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.", + "properties": { + "S3Configuration": { + "$ref": "#/definitions/S3Configuration" + } + }, + "required": [ + "S3Configuration" + ], + "type": "object" + }, + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "KmsKeyId": { + "description": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MeasureNameColumn": { + "description": "Name of the measure name column from the query result.", + "type": "string" + }, + "MixedMeasureMapping": { + "additionalProperties": false, + "description": "MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.", + "properties": { + "MeasureName": { + "$ref": "#/definitions/MixedMeasureMappingMeasureName" + }, + "MeasureValueType": { + "$ref": "#/definitions/MixedMeasureMappingMeasureValueType" + }, + "MultiMeasureAttributeMappings": { + "$ref": "#/definitions/MultiMeasureAttributeMappingList" + }, + "SourceColumn": { + "$ref": "#/definitions/MixedMeasureMappingSourceColumn" + }, + "TargetMeasureName": { + "$ref": "#/definitions/MixedMeasureMappingTargetMeasureName" + } + }, + "required": [ + "MeasureValueType" + ], + "type": "object" + }, + "MixedMeasureMappingMeasureName": { + "description": "Refers to the value of the measure name in a result row. This field is required if MeasureNameColumn is provided.", + "type": "string" + }, + "MixedMeasureMappingMeasureValueType": { + "description": "Type of the value that is to be read from SourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.", + "enum": [ + "BIGINT", + "BOOLEAN", + "DOUBLE", + "VARCHAR", + "MULTI" + ], + "type": "string" + }, + "MixedMeasureMappingSourceColumn": { + "description": "This field refers to the source column from which the measure value is to be read for result materialization.", + "type": "string" + }, + "MixedMeasureMappingTargetMeasureName": { + "description": "Target measure name to be used. If not provided, the target measure name by default would be MeasureName if provided, or SourceColumn otherwise.", + "type": "string" + }, + "MixedMeasureMappings": { + "description": "Specifies how to map measures to multi-measure records.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MixedMeasureMapping" + }, + "minItems": 1, + "type": "array" + }, + "MultiMeasureAttributeMapping": { + "additionalProperties": false, + "description": "An attribute mapping to be used for mapping query results to ingest data for multi-measure attributes.", + "properties": { + "MeasureValueType": { + "$ref": "#/definitions/MultiMeasureAttributeMappingMeasureValueType" + }, + "SourceColumn": { + "$ref": "#/definitions/MultiMeasureAttributeMappingSourceColumn" + }, + "TargetMultiMeasureAttributeName": { + "$ref": "#/definitions/TargetMultiMeasureAttributeName" + } + }, + "required": [ + "SourceColumn", + "MeasureValueType" + ], + "type": "object" + }, + "MultiMeasureAttributeMappingList": { + "description": "Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MultiMeasureAttributeMapping" + }, + "minItems": 1, + "type": "array" + }, + "MultiMeasureAttributeMappingMeasureValueType": { + "description": "Value type of the measure value column to be read from the query result.", + "enum": [ + "BIGINT", + "BOOLEAN", + "DOUBLE", + "VARCHAR", + "TIMESTAMP" + ], + "type": "string" + }, + "MultiMeasureAttributeMappingSourceColumn": { + "description": "Source measure value column in the query result where the attribute value is to be read.", + "type": "string" + }, + "MultiMeasureMappings": { + "additionalProperties": false, + "description": "Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.", + "properties": { + "MultiMeasureAttributeMappings": { + "$ref": "#/definitions/MultiMeasureAttributeMappingList" + }, + "TargetMultiMeasureName": { + "$ref": "#/definitions/TargetMultiMeasureName" + } + }, + "required": [ + "MultiMeasureAttributeMappings" + ], + "type": "object" + }, + "NotificationConfiguration": { + "additionalProperties": false, + "description": "Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.", + "properties": { + "SnsConfiguration": { + "$ref": "#/definitions/SnsConfiguration" + } + }, + "required": [ + "SnsConfiguration" + ], + "type": "object" + }, + "ObjectKeyPrefix": { + "description": "Prefix for error report keys.", + "maxLength": 896, + "minLength": 1, + "pattern": "[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+", + "type": "string" + }, + "QueryString": { + "description": "The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.", + "maxLength": 262144, + "minLength": 1, + "type": "string" + }, + "S3Configuration": { + "additionalProperties": false, + "description": "Details on S3 location for error reports that result from running a query.", + "properties": { + "BucketName": { + "$ref": "#/definitions/BucketName" + }, + "EncryptionOption": { + "$ref": "#/definitions/EncryptionOption" + }, + "ObjectKeyPrefix": { + "$ref": "#/definitions/ObjectKeyPrefix" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "ScheduleConfiguration": { + "additionalProperties": false, + "description": "Configuration for when the scheduled query is executed.", + "properties": { + "ScheduleExpression": { + "$ref": "#/definitions/ScheduleExpression" + } + }, + "required": [ + "ScheduleExpression" + ], + "type": "object" + }, + "ScheduleExpression": { + "description": "An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ScheduledQueryExecutionRoleArn": { + "description": "The ARN for the IAM role that Timestream will assume when running the scheduled query.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ScheduledQueryName": { + "description": "The name of the scheduled query. Scheduled query names must be unique within each Region.", + "maxLength": 64, + "minLength": 1, + "pattern": "[a-zA-Z0-9_.-]+", + "type": "string" + }, + "SnsConfiguration": { + "additionalProperties": false, + "description": "SNS configuration for notification upon scheduled query execution.", + "properties": { + "TopicArn": { + "$ref": "#/definitions/TopicArn" + } + }, + "required": [ + "TopicArn" + ], + "type": "object" + }, + "TableName": { + "description": "Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to label the scheduled query.", + "properties": { + "Key": { + "$ref": "#/definitions/Key" + }, + "Value": { + "$ref": "#/definitions/Value" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "A list of key-value pairs to label the scheduled query.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + }, + "TargetConfiguration": { + "additionalProperties": false, + "description": "Configuration of target store where scheduled query results are written to.", + "properties": { + "TimestreamConfiguration": { + "$ref": "#/definitions/TimestreamConfiguration" + } + }, + "required": [ + "TimestreamConfiguration" + ], + "type": "object" + }, + "TargetMultiMeasureAttributeName": { + "description": "Custom name to be used for attribute name in derived table. If not provided, source column name would be used.", + "type": "string" + }, + "TargetMultiMeasureName": { + "description": "Name of the target multi-measure in the derived table. Required if MeasureNameColumn is not provided. If MeasureNameColumn is provided then the value from that column will be used as the multi-measure name.", + "type": "string" + }, + "TimeColumn": { + "description": "Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.", + "type": "string" + }, + "TimestreamConfiguration": { + "additionalProperties": false, + "description": "Configuration needed to write data into the Timestream database and table.", + "properties": { + "DatabaseName": { + "$ref": "#/definitions/DatabaseName" + }, + "DimensionMappings": { + "$ref": "#/definitions/DimensionMappings" + }, + "MeasureNameColumn": { + "$ref": "#/definitions/MeasureNameColumn" + }, + "MixedMeasureMappings": { + "$ref": "#/definitions/MixedMeasureMappings" + }, + "MultiMeasureMappings": { + "$ref": "#/definitions/MultiMeasureMappings" + }, + "TableName": { + "$ref": "#/definitions/TableName" + }, + "TimeColumn": { + "$ref": "#/definitions/TimeColumn" + } + }, + "required": [ + "DatabaseName", + "TableName", + "TimeColumn", + "DimensionMappings" + ], + "type": "object" + }, + "TopicArn": { + "description": "SNS topic ARN that the scheduled query status notifications will be sent to.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "description": "The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.", + "handlers": { + "create": { + "permissions": [ + "timestream:CreateScheduledQuery", + "timestream:DescribeEndpoints" + ] + }, + "delete": { + "permissions": [ + "timestream:DeleteScheduledQuery", + "timestream:DescribeEndpoints" + ] + }, + "list": { + "permissions": [ + "timestream:ListScheduledQueries", + "timestream:DescribeEndpoints" + ] + }, + "read": { + "permissions": [ + "timestream:DescribeScheduledQuery", + "timestream:ListTagsForResource", + "timestream:DescribeEndpoints" + ] + }, + "update": { + "permissions": [ + "timestream:UpdateScheduledQuery", + "timestream:TagResource", + "timestream:UntagResource", + "timestream:DescribeEndpoints" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/Arn" + }, + "ClientToken": { + "$ref": "#/definitions/ClientToken" + }, + "ErrorReportConfiguration": { + "$ref": "#/definitions/ErrorReportConfiguration" + }, + "KmsKeyId": { + "$ref": "#/definitions/KmsKeyId" + }, + "NotificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration" + }, + "QueryString": { + "$ref": "#/definitions/QueryString" + }, + "SQErrorReportConfiguration": { + "description": "Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.", + "type": "string" + }, + "SQKmsKeyId": { + "description": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.", + "type": "string" + }, + "SQName": { + "description": "The name of the scheduled query. Scheduled query names must be unique within each Region.", + "type": "string" + }, + "SQNotificationConfiguration": { + "description": "Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.", + "type": "string" + }, + "SQQueryString": { + "description": "The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.", + "type": "string" + }, + "SQScheduleConfiguration": { + "description": "Configuration for when the scheduled query is executed.", + "type": "string" + }, + "SQScheduledQueryExecutionRoleArn": { + "description": "The ARN for the IAM role that Timestream will assume when running the scheduled query.", + "type": "string" + }, + "SQTargetConfiguration": { + "description": "Configuration of target store where scheduled query results are written to.", + "type": "string" + }, + "ScheduleConfiguration": { + "$ref": "#/definitions/ScheduleConfiguration" + }, + "ScheduledQueryExecutionRoleArn": { + "$ref": "#/definitions/ScheduledQueryExecutionRoleArn" + }, + "ScheduledQueryName": { + "$ref": "#/definitions/ScheduledQueryName" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "TargetConfiguration": { + "$ref": "#/definitions/TargetConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/SQName", + "/properties/SQQueryString", + "/properties/SQScheduleConfiguration", + "/properties/SQNotificationConfiguration", + "/properties/SQScheduledQueryExecutionRoleArn", + "/properties/SQTargetConfiguration", + "/properties/SQErrorReportConfiguration", + "/properties/SQKmsKeyId" + ], + "required": [ + "QueryString", + "ScheduleConfiguration", + "NotificationConfiguration", + "ScheduledQueryExecutionRoleArn", + "ErrorReportConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", + "typeName": "AWS::Timestream::ScheduledQuery" +} diff --git a/schema/aws-timestream-table.json b/schema/aws-timestream-table.json index 48b5c4a..8102afd 100644 --- a/schema/aws-timestream-table.json +++ b/schema/aws-timestream-table.json @@ -1,240 +1,240 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/DatabaseName", - "/properties/TableName" - ], - "definitions": { - "PartitionKey": { - "additionalProperties": false, - "description": "An attribute used in partitioning data in a table. There are two types of partition keys: dimension keys and measure keys. A dimension key partitions data on a dimension name, while a measure key partitions data on the measure name.", - "properties": { - "EnforcementInRecord": { - "$ref": "#/definitions/PartitionKeyEnforcementLevel" - }, - "Name": { - "$ref": "#/definitions/SchemaName" - }, - "Type": { - "$ref": "#/definitions/PartitionKeyType" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "PartitionKeyEnforcementLevel": { - "description": "The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).", - "enum": [ - "REQUIRED", - "OPTIONAL" - ], - "type": "string" - }, - "PartitionKeyList": { - "description": "A list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/PartitionKey" - }, - "minItems": 1, - "type": "array" - }, - "PartitionKeyType": { - "description": "The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).", - "enum": [ - "DIMENSION", - "MEASURE" - ], - "type": "string" - }, - "SchemaName": { - "description": "The name of the attribute used for a dimension key.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources.", - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "The AWS::Timestream::Table resource creates a Timestream Table.", - "handlers": { - "create": { - "permissions": [ - "timestream:CreateTable", - "timestream:DescribeEndpoints", - "timestream:TagResource", - "s3:PutObject", - "s3:GetObject", - "s3:GetBucketAcl", - "kms:GenerateDataKey*", - "kms:DescribeKey", - "kms:Encrypt" - ] - }, - "delete": { - "permissions": [ - "timestream:DeleteTable", - "timestream:DescribeEndpoints", - "timestream:DescribeTable" - ] - }, - "list": { - "permissions": [ - "timestream:ListTables", - "timestream:DescribeEndpoints" - ] - }, - "read": { - "permissions": [ - "timestream:DescribeTable", - "timestream:DescribeEndpoints", - "timestream:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "timestream:UpdateTable", - "timestream:DescribeEndpoints", - "timestream:TagResource", - "timestream:UntagResource", - "s3:PutObject", - "s3:GetObject", - "s3:GetBucketAcl", - "kms:GenerateDataKey*", - "kms:DescribeKey", - "kms:Encrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/DatabaseName", - "/properties/TableName" - ], - "properties": { - "Arn": { - "type": "string" - }, - "DatabaseName": { - "description": "The name for the database which the table to be created belongs to.", - "pattern": "^[a-zA-Z0-9_.-]{3,256}$", - "type": "string" - }, - "MagneticStoreWriteProperties": { - "additionalProperties": false, - "description": "The properties that determine whether magnetic store writes are enabled.", - "properties": { - "EnableMagneticStoreWrites": { - "description": "Boolean flag indicating whether magnetic store writes are enabled.", - "type": "boolean" - }, - "MagneticStoreRejectedDataLocation": { - "additionalProperties": false, - "description": "Location to store information about records that were asynchronously rejected during magnetic store writes.", - "properties": { - "S3Configuration": { - "additionalProperties": false, - "description": "S3 configuration for location to store rejections from magnetic store writes", - "properties": { - "BucketName": { - "description": "The bucket name used to store the data.", - "type": "string" - }, - "EncryptionOption": { - "description": "Either SSE_KMS or SSE_S3.", - "type": "string" - }, - "KmsKeyId": { - "description": "Must be provided if SSE_KMS is specified as the encryption option", - "type": "string" - }, - "ObjectKeyPrefix": { - "description": "String used to prefix all data in the bucket.", - "type": "string" - } - }, - "required": [ - "EncryptionOption", - "BucketName" - ], - "type": "object" - } - }, - "type": "object" - } - }, - "required": [ - "EnableMagneticStoreWrites" - ], - "type": "object" - }, - "Name": { - "description": "The table name exposed as a read-only attribute.", - "type": "string" - }, - "RetentionProperties": { - "additionalProperties": false, - "description": "The retention duration of the memory store and the magnetic store.", - "properties": { - "MagneticStoreRetentionPeriodInDays": { - "description": "The duration for which data must be stored in the magnetic store.", - "type": "string" - }, - "MemoryStoreRetentionPeriodInHours": { - "description": "The duration for which data must be stored in the memory store.", - "type": "string" - } - }, - "type": "object" - }, - "Schema": { - "additionalProperties": false, - "description": "A Schema specifies the expected data model of the table.", - "properties": { - "CompositePartitionKey": { - "$ref": "#/definitions/PartitionKeyList" - } - }, - "type": "object" - }, - "TableName": { - "description": "The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.", - "pattern": "^[a-zA-Z0-9_.-]{3,256}$", - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Name" - ], - "required": [ - "DatabaseName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", - "typeName": "AWS::Timestream::Table" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DatabaseName", + "/properties/TableName" + ], + "definitions": { + "PartitionKey": { + "additionalProperties": false, + "description": "An attribute used in partitioning data in a table. There are two types of partition keys: dimension keys and measure keys. A dimension key partitions data on a dimension name, while a measure key partitions data on the measure name.", + "properties": { + "EnforcementInRecord": { + "$ref": "#/definitions/PartitionKeyEnforcementLevel" + }, + "Name": { + "$ref": "#/definitions/SchemaName" + }, + "Type": { + "$ref": "#/definitions/PartitionKeyType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "PartitionKeyEnforcementLevel": { + "description": "The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).", + "enum": [ + "REQUIRED", + "OPTIONAL" + ], + "type": "string" + }, + "PartitionKeyList": { + "description": "A list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PartitionKey" + }, + "minItems": 1, + "type": "array" + }, + "PartitionKeyType": { + "description": "The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).", + "enum": [ + "DIMENSION", + "MEASURE" + ], + "type": "string" + }, + "SchemaName": { + "description": "The name of the attribute used for a dimension key.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::Timestream::Table resource creates a Timestream Table.", + "handlers": { + "create": { + "permissions": [ + "timestream:CreateTable", + "timestream:DescribeEndpoints", + "timestream:TagResource", + "s3:PutObject", + "s3:GetObject", + "s3:GetBucketAcl", + "kms:GenerateDataKey*", + "kms:DescribeKey", + "kms:Encrypt" + ] + }, + "delete": { + "permissions": [ + "timestream:DeleteTable", + "timestream:DescribeEndpoints", + "timestream:DescribeTable" + ] + }, + "list": { + "permissions": [ + "timestream:ListTables", + "timestream:DescribeEndpoints" + ] + }, + "read": { + "permissions": [ + "timestream:DescribeTable", + "timestream:DescribeEndpoints", + "timestream:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "timestream:UpdateTable", + "timestream:DescribeEndpoints", + "timestream:TagResource", + "timestream:UntagResource", + "s3:PutObject", + "s3:GetObject", + "s3:GetBucketAcl", + "kms:GenerateDataKey*", + "kms:DescribeKey", + "kms:Encrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/DatabaseName", + "/properties/TableName" + ], + "properties": { + "Arn": { + "type": "string" + }, + "DatabaseName": { + "description": "The name for the database which the table to be created belongs to.", + "pattern": "^[a-zA-Z0-9_.-]{3,256}$", + "type": "string" + }, + "MagneticStoreWriteProperties": { + "additionalProperties": false, + "description": "The properties that determine whether magnetic store writes are enabled.", + "properties": { + "EnableMagneticStoreWrites": { + "description": "Boolean flag indicating whether magnetic store writes are enabled.", + "type": "boolean" + }, + "MagneticStoreRejectedDataLocation": { + "additionalProperties": false, + "description": "Location to store information about records that were asynchronously rejected during magnetic store writes.", + "properties": { + "S3Configuration": { + "additionalProperties": false, + "description": "S3 configuration for location to store rejections from magnetic store writes", + "properties": { + "BucketName": { + "description": "The bucket name used to store the data.", + "type": "string" + }, + "EncryptionOption": { + "description": "Either SSE_KMS or SSE_S3.", + "type": "string" + }, + "KmsKeyId": { + "description": "Must be provided if SSE_KMS is specified as the encryption option", + "type": "string" + }, + "ObjectKeyPrefix": { + "description": "String used to prefix all data in the bucket.", + "type": "string" + } + }, + "required": [ + "EncryptionOption", + "BucketName" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "required": [ + "EnableMagneticStoreWrites" + ], + "type": "object" + }, + "Name": { + "description": "The table name exposed as a read-only attribute.", + "type": "string" + }, + "RetentionProperties": { + "additionalProperties": false, + "description": "The retention duration of the memory store and the magnetic store.", + "properties": { + "MagneticStoreRetentionPeriodInDays": { + "description": "The duration for which data must be stored in the magnetic store.", + "type": "string" + }, + "MemoryStoreRetentionPeriodInHours": { + "description": "The duration for which data must be stored in the memory store.", + "type": "string" + } + }, + "type": "object" + }, + "Schema": { + "additionalProperties": false, + "description": "A Schema specifies the expected data model of the table.", + "properties": { + "CompositePartitionKey": { + "$ref": "#/definitions/PartitionKeyList" + } + }, + "type": "object" + }, + "TableName": { + "description": "The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.", + "pattern": "^[a-zA-Z0-9_.-]{3,256}$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Name" + ], + "required": [ + "DatabaseName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", + "typeName": "AWS::Timestream::Table" +} diff --git a/schema/aws-transfer-agreement.json b/schema/aws-transfer-agreement.json index 9438c05..55c5ba6 100644 --- a/schema/aws-transfer-agreement.json +++ b/schema/aws-transfer-agreement.json @@ -1,173 +1,173 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerId" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "Creates a key-value pair for a specific resource.", - "properties": { - "Key": { - "description": "The name assigned to the tag that you create.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Contains one or more values that you assigned to the key name you create.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Agreement", - "handlers": { - "create": { - "permissions": [ - "transfer:CreateAgreement", - "transfer:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "transfer:DeleteAgreement" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ServerId": { - "$ref": "resource-schema.json#/properties/ServerId" - } - }, - "required": [ - "ServerId" - ] - }, - "permissions": [ - "transfer:ListAgreements" - ] - }, - "read": { - "permissions": [ - "transfer:DescribeAgreement" - ] - }, - "update": { - "permissions": [ - "transfer:UpdateAgreement", - "transfer:UnTagResource", - "transfer:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/AgreementId", - "/properties/ServerId" - ], - "properties": { - "AccessRole": { - "description": "Specifies the access role for the agreement.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:.*role/.*", - "type": "string" - }, - "AgreementId": { - "description": "A unique identifier for the agreement.", - "maxLength": 19, - "minLength": 19, - "pattern": "^a-([0-9a-f]{17})$", - "type": "string" - }, - "Arn": { - "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement.", - "maxLength": 1600, - "minLength": 20, - "pattern": "arn:.*", - "type": "string" - }, - "BaseDirectory": { - "description": "Specifies the base directory for the agreement.", - "maxLength": 1024, - "pattern": "^(|/.*)$", - "type": "string" - }, - "Description": { - "description": "A textual description for the agreement.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[\\u0021-\\u007E]+$", - "type": "string" - }, - "LocalProfileId": { - "description": "A unique identifier for the local profile.", - "maxLength": 19, - "minLength": 19, - "pattern": "^p-([0-9a-f]{17})$", - "type": "string" - }, - "PartnerProfileId": { - "description": "A unique identifier for the partner profile.", - "maxLength": 19, - "minLength": 19, - "pattern": "^p-([0-9a-f]{17})$", - "type": "string" - }, - "ServerId": { - "description": "A unique identifier for the server.", - "maxLength": 19, - "minLength": 19, - "pattern": "^s-([0-9a-f]{17})$", - "type": "string" - }, - "Status": { - "description": "Specifies the status of the agreement.", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AgreementId", - "/properties/Arn" - ], - "required": [ - "ServerId", - "LocalProfileId", - "PartnerProfileId", - "BaseDirectory", - "AccessRole" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transfer", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Transfer::Agreement" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "Creates a key-value pair for a specific resource.", + "properties": { + "Key": { + "description": "The name assigned to the tag that you create.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Contains one or more values that you assigned to the key name you create.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Agreement", + "handlers": { + "create": { + "permissions": [ + "transfer:CreateAgreement", + "transfer:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "transfer:DeleteAgreement" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ServerId": { + "$ref": "resource-schema.json#/properties/ServerId" + } + }, + "required": [ + "ServerId" + ] + }, + "permissions": [ + "transfer:ListAgreements" + ] + }, + "read": { + "permissions": [ + "transfer:DescribeAgreement" + ] + }, + "update": { + "permissions": [ + "transfer:UpdateAgreement", + "transfer:UnTagResource", + "transfer:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgreementId", + "/properties/ServerId" + ], + "properties": { + "AccessRole": { + "description": "Specifies the access role for the agreement.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:.*role/.*", + "type": "string" + }, + "AgreementId": { + "description": "A unique identifier for the agreement.", + "maxLength": 19, + "minLength": 19, + "pattern": "^a-([0-9a-f]{17})$", + "type": "string" + }, + "Arn": { + "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement.", + "maxLength": 1600, + "minLength": 20, + "pattern": "arn:.*", + "type": "string" + }, + "BaseDirectory": { + "description": "Specifies the base directory for the agreement.", + "maxLength": 1024, + "pattern": "^(|/.*)$", + "type": "string" + }, + "Description": { + "description": "A textual description for the agreement.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[\\u0021-\\u007E]+$", + "type": "string" + }, + "LocalProfileId": { + "description": "A unique identifier for the local profile.", + "maxLength": 19, + "minLength": 19, + "pattern": "^p-([0-9a-f]{17})$", + "type": "string" + }, + "PartnerProfileId": { + "description": "A unique identifier for the partner profile.", + "maxLength": 19, + "minLength": 19, + "pattern": "^p-([0-9a-f]{17})$", + "type": "string" + }, + "ServerId": { + "description": "A unique identifier for the server.", + "maxLength": 19, + "minLength": 19, + "pattern": "^s-([0-9a-f]{17})$", + "type": "string" + }, + "Status": { + "description": "Specifies the status of the agreement.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AgreementId", + "/properties/Arn" + ], + "required": [ + "ServerId", + "LocalProfileId", + "PartnerProfileId", + "BaseDirectory", + "AccessRole" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transfer", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Transfer::Agreement" +} diff --git a/schema/aws-transfer-certificate.json b/schema/aws-transfer-certificate.json index d64515c..d5821ef 100644 --- a/schema/aws-transfer-certificate.json +++ b/schema/aws-transfer-certificate.json @@ -1,194 +1,194 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Certificate", - "/properties/CertificateChain", - "/properties/PrivateKey" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Certificate", - "handlers": { - "create": { - "permissions": [ - "transfer:ImportCertificate", - "transfer:TagResource" - ] - }, - "delete": { - "permissions": [ - "transfer:DeleteCertificate" - ] - }, - "list": { - "permissions": [ - "transfer:ListCertificates" - ] - }, - "read": { - "permissions": [ - "transfer:DescribeCertificate" - ] - }, - "update": { - "permissions": [ - "transfer:UpdateCertificate", - "transfer:UnTagResource", - "transfer:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/CertificateId" - ], - "properties": { - "ActiveDate": { - "description": "Specifies the active date for the certificate.", - "type": "string" - }, - "Arn": { - "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement.", - "maxLength": 1600, - "minLength": 20, - "pattern": "arn:.*", - "type": "string" - }, - "Certificate": { - "description": "Specifies the certificate body to be imported.", - "maxLength": 16384, - "minLength": 1, - "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", - "type": "string" - }, - "CertificateChain": { - "description": "Specifies the certificate chain to be imported.", - "maxLength": 2097152, - "minLength": 1, - "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", - "type": "string" - }, - "CertificateId": { - "description": "A unique identifier for the certificate.", - "maxLength": 22, - "minLength": 22, - "pattern": "^cert-([0-9a-f]{17})$", - "type": "string" - }, - "Description": { - "description": "A textual description for the certificate.", - "maxLength": 200, - "minLength": 1, - "pattern": "^[\\u0021-\\u007E]+$", - "type": "string" - }, - "InactiveDate": { - "description": "Specifies the inactive date for the certificate.", - "type": "string" - }, - "NotAfterDate": { - "description": "Specifies the not after date for the certificate.", - "type": "string" - }, - "NotBeforeDate": { - "description": "Specifies the not before date for the certificate.", - "type": "string" - }, - "PrivateKey": { - "description": "Specifies the private key for the certificate.", - "maxLength": 16384, - "minLength": 1, - "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", - "type": "string" - }, - "Serial": { - "description": "Specifies Certificate's serial.", - "maxLength": 48, - "minLength": 0, - "pattern": "^[0-9a-fA-F{}:?]*$", - "type": "string" - }, - "Status": { - "description": "A status description for the certificate.", - "enum": [ - "ACTIVE", - "PENDING", - "INACTIVE" - ], - "type": "string" - }, - "Tags": { - "description": "Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Type": { - "description": "Describing the type of certificate. With or without a private key.", - "enum": [ - "CERTIFICATE", - "CERTIFICATE_WITH_PRIVATE_KEY" - ], - "type": "string" - }, - "Usage": { - "description": "Specifies the usage type for the certificate.", - "enum": [ - "SIGNING", - "ENCRYPTION", - "TLS" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CertificateId", - "/properties/Status", - "/properties/Type", - "/properties/Serial", - "/properties/NotAfterDate", - "/properties/NotBeforeDate" - ], - "required": [ - "Certificate", - "Usage" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Transfer::Certificate", - "writeOnlyProperties": [ - "/properties/PrivateKey" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Certificate", + "/properties/CertificateChain", + "/properties/PrivateKey" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Certificate", + "handlers": { + "create": { + "permissions": [ + "transfer:ImportCertificate", + "transfer:TagResource" + ] + }, + "delete": { + "permissions": [ + "transfer:DeleteCertificate" + ] + }, + "list": { + "permissions": [ + "transfer:ListCertificates" + ] + }, + "read": { + "permissions": [ + "transfer:DescribeCertificate" + ] + }, + "update": { + "permissions": [ + "transfer:UpdateCertificate", + "transfer:UnTagResource", + "transfer:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CertificateId" + ], + "properties": { + "ActiveDate": { + "description": "Specifies the active date for the certificate.", + "type": "string" + }, + "Arn": { + "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement.", + "maxLength": 1600, + "minLength": 20, + "pattern": "arn:.*", + "type": "string" + }, + "Certificate": { + "description": "Specifies the certificate body to be imported.", + "maxLength": 16384, + "minLength": 1, + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", + "type": "string" + }, + "CertificateChain": { + "description": "Specifies the certificate chain to be imported.", + "maxLength": 2097152, + "minLength": 1, + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", + "type": "string" + }, + "CertificateId": { + "description": "A unique identifier for the certificate.", + "maxLength": 22, + "minLength": 22, + "pattern": "^cert-([0-9a-f]{17})$", + "type": "string" + }, + "Description": { + "description": "A textual description for the certificate.", + "maxLength": 200, + "minLength": 1, + "pattern": "^[\\u0021-\\u007E]+$", + "type": "string" + }, + "InactiveDate": { + "description": "Specifies the inactive date for the certificate.", + "type": "string" + }, + "NotAfterDate": { + "description": "Specifies the not after date for the certificate.", + "type": "string" + }, + "NotBeforeDate": { + "description": "Specifies the not before date for the certificate.", + "type": "string" + }, + "PrivateKey": { + "description": "Specifies the private key for the certificate.", + "maxLength": 16384, + "minLength": 1, + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", + "type": "string" + }, + "Serial": { + "description": "Specifies Certificate's serial.", + "maxLength": 48, + "minLength": 0, + "pattern": "^[0-9a-fA-F{}:?]*$", + "type": "string" + }, + "Status": { + "description": "A status description for the certificate.", + "enum": [ + "ACTIVE", + "PENDING", + "INACTIVE" + ], + "type": "string" + }, + "Tags": { + "description": "Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "Describing the type of certificate. With or without a private key.", + "enum": [ + "CERTIFICATE", + "CERTIFICATE_WITH_PRIVATE_KEY" + ], + "type": "string" + }, + "Usage": { + "description": "Specifies the usage type for the certificate.", + "enum": [ + "SIGNING", + "ENCRYPTION", + "TLS" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CertificateId", + "/properties/Status", + "/properties/Type", + "/properties/Serial", + "/properties/NotAfterDate", + "/properties/NotBeforeDate" + ], + "required": [ + "Certificate", + "Usage" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Transfer::Certificate", + "writeOnlyProperties": [ + "/properties/PrivateKey" + ] +} diff --git a/schema/aws-transfer-connector.json b/schema/aws-transfer-connector.json index 4b720e2..285ea2e 100644 --- a/schema/aws-transfer-connector.json +++ b/schema/aws-transfer-connector.json @@ -1,254 +1,254 @@ -{ - "additionalProperties": false, - "definitions": { - "SftpConnectorTrustedHostKey": { - "description": "The public host key for the external server to which you are connecting.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "Creates a key-value pair for a specific resource.", - "properties": { - "Key": { - "description": "The name assigned to the tag that you create.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Contains one or more values that you assigned to the key name you create.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Connector", - "handlers": { - "create": { - "permissions": [ - "transfer:CreateConnector", - "transfer:TagResource", - "iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "transfer:DeleteConnector" - ] - }, - "list": { - "permissions": [ - "transfer:ListConnectors" - ] - }, - "read": { - "permissions": [ - "transfer:DescribeConnector" - ] - }, - "update": { - "permissions": [ - "transfer:UpdateConnector", - "transfer:UnTagResource", - "transfer:TagResource", - "iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/ConnectorId" - ], - "properties": { - "AccessRole": { - "description": "Specifies the access role for the connector.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:.*role/.*", - "type": "string" - }, - "Arn": { - "description": "Specifies the unique Amazon Resource Name (ARN) for the connector.", - "maxLength": 1600, - "minLength": 20, - "pattern": "arn:.*", - "type": "string" - }, - "As2Config": { - "additionalProperties": false, - "description": "Configuration for an AS2 connector.", - "properties": { - "BasicAuthSecretId": { - "description": "ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector", - "maxLength": 2048, - "minLength": 0, - "type": "string" - }, - "Compression": { - "description": "Compression setting for this AS2 connector configuration.", - "enum": [ - "ZLIB", - "DISABLED" - ], - "type": "string" - }, - "EncryptionAlgorithm": { - "description": "Encryption algorithm for this AS2 connector configuration.", - "enum": [ - "AES128_CBC", - "AES192_CBC", - "AES256_CBC", - "NONE", - "DES_EDE3_CBC" - ], - "type": "string" - }, - "LocalProfileId": { - "description": "A unique identifier for the local profile.", - "maxLength": 19, - "minLength": 19, - "pattern": "^p-([0-9a-f]{17})$", - "type": "string" - }, - "MdnResponse": { - "description": "MDN Response setting for this AS2 connector configuration.", - "enum": [ - "SYNC", - "NONE" - ], - "type": "string" - }, - "MdnSigningAlgorithm": { - "description": "MDN Signing algorithm for this AS2 connector configuration.", - "enum": [ - "SHA256", - "SHA384", - "SHA512", - "SHA1", - "NONE", - "DEFAULT" - ], - "type": "string" - }, - "MessageSubject": { - "description": "The message subject for this AS2 connector configuration.", - "maxLength": 1024, - "minLength": 1, - "pattern": "^[\\u0020-\\u007E\\t]+$", - "type": "string" - }, - "PartnerProfileId": { - "description": "A unique identifier for the partner profile.", - "maxLength": 19, - "minLength": 19, - "pattern": "^p-([0-9a-f]{17})$", - "type": "string" - }, - "SigningAlgorithm": { - "description": "Signing algorithm for this AS2 connector configuration.", - "enum": [ - "SHA256", - "SHA384", - "SHA512", - "SHA1", - "NONE" - ], - "type": "string" - } - }, - "type": "object" - }, - "ConnectorId": { - "description": "A unique identifier for the connector.", - "maxLength": 19, - "minLength": 19, - "pattern": "^c-([0-9a-f]{17})$", - "type": "string" - }, - "LoggingRole": { - "description": "Specifies the logging role for the connector.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:.*role/.*", - "type": "string" - }, - "SecurityPolicyName": { - "description": "Security policy for SFTP Connector", - "maxLength": 50, - "pattern": "TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+", - "type": "string" - }, - "ServiceManagedEgressIpAddresses": { - "description": "The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.", - "insertionOrder": false, - "items": { - "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", - "type": "string" - }, - "type": "array" - }, - "SftpConfig": { - "additionalProperties": false, - "description": "Configuration for an SFTP connector.", - "properties": { - "TrustedHostKeys": { - "description": "List of public host keys, for the external server to which you are connecting.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SftpConnectorTrustedHostKey" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": false - }, - "UserSecretId": { - "description": "ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "description": "Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Url": { - "description": "URL for Connector", - "maxLength": 255, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ConnectorId", - "/properties/ServiceManagedEgressIpAddresses" - ], - "required": [ - "AccessRole", - "Url" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Transfer::Connector" -} +{ + "additionalProperties": false, + "definitions": { + "SftpConnectorTrustedHostKey": { + "description": "The public host key for the external server to which you are connecting.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "Creates a key-value pair for a specific resource.", + "properties": { + "Key": { + "description": "The name assigned to the tag that you create.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Contains one or more values that you assigned to the key name you create.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Connector", + "handlers": { + "create": { + "permissions": [ + "transfer:CreateConnector", + "transfer:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "transfer:DeleteConnector" + ] + }, + "list": { + "permissions": [ + "transfer:ListConnectors" + ] + }, + "read": { + "permissions": [ + "transfer:DescribeConnector" + ] + }, + "update": { + "permissions": [ + "transfer:UpdateConnector", + "transfer:UnTagResource", + "transfer:TagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectorId" + ], + "properties": { + "AccessRole": { + "description": "Specifies the access role for the connector.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:.*role/.*", + "type": "string" + }, + "Arn": { + "description": "Specifies the unique Amazon Resource Name (ARN) for the connector.", + "maxLength": 1600, + "minLength": 20, + "pattern": "arn:.*", + "type": "string" + }, + "As2Config": { + "additionalProperties": false, + "description": "Configuration for an AS2 connector.", + "properties": { + "BasicAuthSecretId": { + "description": "ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "Compression": { + "description": "Compression setting for this AS2 connector configuration.", + "enum": [ + "ZLIB", + "DISABLED" + ], + "type": "string" + }, + "EncryptionAlgorithm": { + "description": "Encryption algorithm for this AS2 connector configuration.", + "enum": [ + "AES128_CBC", + "AES192_CBC", + "AES256_CBC", + "NONE", + "DES_EDE3_CBC" + ], + "type": "string" + }, + "LocalProfileId": { + "description": "A unique identifier for the local profile.", + "maxLength": 19, + "minLength": 19, + "pattern": "^p-([0-9a-f]{17})$", + "type": "string" + }, + "MdnResponse": { + "description": "MDN Response setting for this AS2 connector configuration.", + "enum": [ + "SYNC", + "NONE" + ], + "type": "string" + }, + "MdnSigningAlgorithm": { + "description": "MDN Signing algorithm for this AS2 connector configuration.", + "enum": [ + "SHA256", + "SHA384", + "SHA512", + "SHA1", + "NONE", + "DEFAULT" + ], + "type": "string" + }, + "MessageSubject": { + "description": "The message subject for this AS2 connector configuration.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\u0020-\\u007E\\t]+$", + "type": "string" + }, + "PartnerProfileId": { + "description": "A unique identifier for the partner profile.", + "maxLength": 19, + "minLength": 19, + "pattern": "^p-([0-9a-f]{17})$", + "type": "string" + }, + "SigningAlgorithm": { + "description": "Signing algorithm for this AS2 connector configuration.", + "enum": [ + "SHA256", + "SHA384", + "SHA512", + "SHA1", + "NONE" + ], + "type": "string" + } + }, + "type": "object" + }, + "ConnectorId": { + "description": "A unique identifier for the connector.", + "maxLength": 19, + "minLength": 19, + "pattern": "^c-([0-9a-f]{17})$", + "type": "string" + }, + "LoggingRole": { + "description": "Specifies the logging role for the connector.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:.*role/.*", + "type": "string" + }, + "SecurityPolicyName": { + "description": "Security policy for SFTP Connector", + "maxLength": 50, + "pattern": "TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+", + "type": "string" + }, + "ServiceManagedEgressIpAddresses": { + "description": "The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.", + "insertionOrder": false, + "items": { + "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", + "type": "string" + }, + "type": "array" + }, + "SftpConfig": { + "additionalProperties": false, + "description": "Configuration for an SFTP connector.", + "properties": { + "TrustedHostKeys": { + "description": "List of public host keys, for the external server to which you are connecting.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SftpConnectorTrustedHostKey" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": false + }, + "UserSecretId": { + "description": "ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "description": "Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Url": { + "description": "URL for Connector", + "maxLength": 255, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ConnectorId", + "/properties/ServiceManagedEgressIpAddresses" + ], + "required": [ + "AccessRole", + "Url" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Transfer::Connector" +} diff --git a/schema/aws-transfer-profile.json b/schema/aws-transfer-profile.json index f7b0b93..fcdf5cd 100644 --- a/schema/aws-transfer-profile.json +++ b/schema/aws-transfer-profile.json @@ -1,137 +1,137 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ProfileType" - ], - "definitions": { - "CertificateId": { - "description": "A unique identifier for the certificate.", - "maxLength": 22, - "minLength": 22, - "pattern": "^cert-([0-9a-f]{17})$", - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "description": "Creates a key-value pair for a specific resource.", - "properties": { - "Key": { - "description": "The name assigned to the tag that you create.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Contains one or more values that you assigned to the key name you create.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Profile", - "handlers": { - "create": { - "permissions": [ - "transfer:CreateProfile", - "transfer:TagResource" - ] - }, - "delete": { - "permissions": [ - "transfer:DeleteProfile" - ] - }, - "list": { - "permissions": [ - "transfer:ListProfiles" - ] - }, - "read": { - "permissions": [ - "transfer:DescribeProfile" - ] - }, - "update": { - "permissions": [ - "transfer:UpdateProfile", - "transfer:UnTagResource", - "transfer:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/ProfileId" - ], - "properties": { - "Arn": { - "description": "Specifies the unique Amazon Resource Name (ARN) for the profile.", - "maxLength": 1600, - "minLength": 20, - "pattern": "arn:.*", - "type": "string" - }, - "As2Id": { - "description": "AS2 identifier agreed with a trading partner.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\u0020-\\u007E\\s]*$", - "type": "string" - }, - "CertificateIds": { - "description": "List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CertificateId" - }, - "type": "array" - }, - "ProfileId": { - "description": "A unique identifier for the profile", - "maxLength": 19, - "minLength": 19, - "pattern": "^p-([0-9a-f]{17})$", - "type": "string" - }, - "ProfileType": { - "description": "Enum specifying whether the profile is local or associated with a trading partner.", - "enum": [ - "LOCAL", - "PARTNER" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/ProfileId" - ], - "required": [ - "As2Id", - "ProfileType" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Transfer::Profile" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfileType" + ], + "definitions": { + "CertificateId": { + "description": "A unique identifier for the certificate.", + "maxLength": 22, + "minLength": 22, + "pattern": "^cert-([0-9a-f]{17})$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "Creates a key-value pair for a specific resource.", + "properties": { + "Key": { + "description": "The name assigned to the tag that you create.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Contains one or more values that you assigned to the key name you create.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Profile", + "handlers": { + "create": { + "permissions": [ + "transfer:CreateProfile", + "transfer:TagResource" + ] + }, + "delete": { + "permissions": [ + "transfer:DeleteProfile" + ] + }, + "list": { + "permissions": [ + "transfer:ListProfiles" + ] + }, + "read": { + "permissions": [ + "transfer:DescribeProfile" + ] + }, + "update": { + "permissions": [ + "transfer:UpdateProfile", + "transfer:UnTagResource", + "transfer:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ProfileId" + ], + "properties": { + "Arn": { + "description": "Specifies the unique Amazon Resource Name (ARN) for the profile.", + "maxLength": 1600, + "minLength": 20, + "pattern": "arn:.*", + "type": "string" + }, + "As2Id": { + "description": "AS2 identifier agreed with a trading partner.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\u0020-\\u007E\\s]*$", + "type": "string" + }, + "CertificateIds": { + "description": "List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CertificateId" + }, + "type": "array" + }, + "ProfileId": { + "description": "A unique identifier for the profile", + "maxLength": 19, + "minLength": 19, + "pattern": "^p-([0-9a-f]{17})$", + "type": "string" + }, + "ProfileType": { + "description": "Enum specifying whether the profile is local or associated with a trading partner.", + "enum": [ + "LOCAL", + "PARTNER" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ProfileId" + ], + "required": [ + "As2Id", + "ProfileType" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Transfer::Profile" +} diff --git a/schema/aws-transfer-server.json b/schema/aws-transfer-server.json index c26dac2..d091d1c 100644 --- a/schema/aws-transfer-server.json +++ b/schema/aws-transfer-server.json @@ -1,235 +1,235 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/IdentityProviderType", - "/properties/Domain" - ], - "definitions": { - "As2Transport": { - "additionalProperties": false, - "type": "object" - }, - "EndpointDetails": { - "additionalProperties": false, - "properties": { - "AddressAllocationIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "VpcEndpointId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "IdentityProviderDetails": { - "additionalProperties": false, - "properties": { - "DirectoryId": { - "type": "string" - }, - "Function": { - "type": "string" - }, - "InvocationRole": { - "type": "string" - }, - "SftpAuthenticationMethods": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "Protocol": { - "additionalProperties": false, - "type": "object" - }, - "ProtocolDetails": { - "additionalProperties": false, - "properties": { - "As2Transports": { - "items": { - "$ref": "#/definitions/As2Transport" - }, - "type": "array", - "uniqueItems": false - }, - "PassiveIp": { - "type": "string" - }, - "SetStatOption": { - "type": "string" - }, - "TlsSessionResumptionMode": { - "type": "string" - } - }, - "type": "object" - }, - "S3StorageOptions": { - "additionalProperties": false, - "properties": { - "DirectoryListingOptimization": { - "type": "string" - } - }, - "type": "object" - }, - "StructuredLogDestination": { - "additionalProperties": false, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "WorkflowDetail": { - "additionalProperties": false, - "properties": { - "ExecutionRole": { - "type": "string" - }, - "WorkflowId": { - "type": "string" - } - }, - "required": [ - "WorkflowId", - "ExecutionRole" - ], - "type": "object" - }, - "WorkflowDetails": { - "additionalProperties": false, - "properties": { - "OnPartialUpload": { - "items": { - "$ref": "#/definitions/WorkflowDetail" - }, - "type": "array", - "uniqueItems": false - }, - "OnUpload": { - "items": { - "$ref": "#/definitions/WorkflowDetail" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Server", - "primaryIdentifier": [ - "/properties/ServerId" - ], - "properties": { - "Arn": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "Domain": { - "type": "string" - }, - "EndpointDetails": { - "$ref": "#/definitions/EndpointDetails" - }, - "EndpointType": { - "type": "string" - }, - "IdentityProviderDetails": { - "$ref": "#/definitions/IdentityProviderDetails" - }, - "IdentityProviderType": { - "type": "string" - }, - "LoggingRole": { - "type": "string" - }, - "PostAuthenticationLoginBanner": { - "type": "string" - }, - "PreAuthenticationLoginBanner": { - "type": "string" - }, - "ProtocolDetails": { - "$ref": "#/definitions/ProtocolDetails" - }, - "Protocols": { - "items": { - "$ref": "#/definitions/Protocol" - }, - "type": "array", - "uniqueItems": false - }, - "S3StorageOptions": { - "$ref": "#/definitions/S3StorageOptions" - }, - "SecurityPolicyName": { - "type": "string" - }, - "ServerId": { - "type": "string" - }, - "StructuredLogDestinations": { - "items": { - "$ref": "#/definitions/StructuredLogDestination" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "WorkflowDetails": { - "$ref": "#/definitions/WorkflowDetails" - } - }, - "readOnlyProperties": [ - "/properties/ServerId", - "/properties/Arn" - ], - "typeName": "AWS::Transfer::Server" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityProviderType", + "/properties/Domain" + ], + "definitions": { + "As2Transport": { + "additionalProperties": false, + "type": "object" + }, + "EndpointDetails": { + "additionalProperties": false, + "properties": { + "AddressAllocationIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SubnetIds": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "VpcEndpointId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + }, + "IdentityProviderDetails": { + "additionalProperties": false, + "properties": { + "DirectoryId": { + "type": "string" + }, + "Function": { + "type": "string" + }, + "InvocationRole": { + "type": "string" + }, + "SftpAuthenticationMethods": { + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "type": "object" + }, + "Protocol": { + "additionalProperties": false, + "type": "object" + }, + "ProtocolDetails": { + "additionalProperties": false, + "properties": { + "As2Transports": { + "items": { + "$ref": "#/definitions/As2Transport" + }, + "type": "array", + "uniqueItems": false + }, + "PassiveIp": { + "type": "string" + }, + "SetStatOption": { + "type": "string" + }, + "TlsSessionResumptionMode": { + "type": "string" + } + }, + "type": "object" + }, + "S3StorageOptions": { + "additionalProperties": false, + "properties": { + "DirectoryListingOptimization": { + "type": "string" + } + }, + "type": "object" + }, + "StructuredLogDestination": { + "additionalProperties": false, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "WorkflowDetail": { + "additionalProperties": false, + "properties": { + "ExecutionRole": { + "type": "string" + }, + "WorkflowId": { + "type": "string" + } + }, + "required": [ + "WorkflowId", + "ExecutionRole" + ], + "type": "object" + }, + "WorkflowDetails": { + "additionalProperties": false, + "properties": { + "OnPartialUpload": { + "items": { + "$ref": "#/definitions/WorkflowDetail" + }, + "type": "array", + "uniqueItems": false + }, + "OnUpload": { + "items": { + "$ref": "#/definitions/WorkflowDetail" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Server", + "primaryIdentifier": [ + "/properties/ServerId" + ], + "properties": { + "Arn": { + "type": "string" + }, + "Certificate": { + "type": "string" + }, + "Domain": { + "type": "string" + }, + "EndpointDetails": { + "$ref": "#/definitions/EndpointDetails" + }, + "EndpointType": { + "type": "string" + }, + "IdentityProviderDetails": { + "$ref": "#/definitions/IdentityProviderDetails" + }, + "IdentityProviderType": { + "type": "string" + }, + "LoggingRole": { + "type": "string" + }, + "PostAuthenticationLoginBanner": { + "type": "string" + }, + "PreAuthenticationLoginBanner": { + "type": "string" + }, + "ProtocolDetails": { + "$ref": "#/definitions/ProtocolDetails" + }, + "Protocols": { + "items": { + "$ref": "#/definitions/Protocol" + }, + "type": "array", + "uniqueItems": false + }, + "S3StorageOptions": { + "$ref": "#/definitions/S3StorageOptions" + }, + "SecurityPolicyName": { + "type": "string" + }, + "ServerId": { + "type": "string" + }, + "StructuredLogDestinations": { + "items": { + "$ref": "#/definitions/StructuredLogDestination" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "WorkflowDetails": { + "$ref": "#/definitions/WorkflowDetails" + } + }, + "readOnlyProperties": [ + "/properties/ServerId", + "/properties/Arn" + ], + "typeName": "AWS::Transfer::Server" +} diff --git a/schema/aws-transfer-user.json b/schema/aws-transfer-user.json index fa75668..4a9754d 100644 --- a/schema/aws-transfer-user.json +++ b/schema/aws-transfer-user.json @@ -1,135 +1,135 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServerId", - "/properties/UserName" - ], - "definitions": { - "HomeDirectoryMapEntry": { - "additionalProperties": false, - "properties": { - "Entry": { - "type": "string" - }, - "Target": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Entry", - "Target" - ], - "type": "object" - }, - "PosixProfile": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "number" - }, - "SecondaryGids": { - "items": { - "type": "number" - }, - "type": "array", - "uniqueItems": false - }, - "Uid": { - "type": "number" - } - }, - "required": [ - "Uid", - "Gid" - ], - "type": "object" - }, - "SshPublicKey": { - "additionalProperties": false, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::User", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Arn": { - "type": "string" - }, - "HomeDirectory": { - "type": "string" - }, - "HomeDirectoryMappings": { - "items": { - "$ref": "#/definitions/HomeDirectoryMapEntry" - }, - "type": "array", - "uniqueItems": false - }, - "HomeDirectoryType": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Policy": { - "type": "string" - }, - "PosixProfile": { - "$ref": "#/definitions/PosixProfile" - }, - "Role": { - "type": "string" - }, - "ServerId": { - "type": "string" - }, - "SshPublicKeys": { - "items": { - "$ref": "#/definitions/SshPublicKey" - }, - "type": "array", - "uniqueItems": false - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserName": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/Arn" - ], - "required": [ - "Role", - "ServerId", - "UserName" - ], - "typeName": "AWS::Transfer::User" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServerId", + "/properties/UserName" + ], + "definitions": { + "HomeDirectoryMapEntry": { + "additionalProperties": false, + "properties": { + "Entry": { + "type": "string" + }, + "Target": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Entry", + "Target" + ], + "type": "object" + }, + "PosixProfile": { + "additionalProperties": false, + "properties": { + "Gid": { + "type": "number" + }, + "SecondaryGids": { + "items": { + "type": "number" + }, + "type": "array", + "uniqueItems": false + }, + "Uid": { + "type": "number" + } + }, + "required": [ + "Uid", + "Gid" + ], + "type": "object" + }, + "SshPublicKey": { + "additionalProperties": false, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::User", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "type": "string" + }, + "HomeDirectory": { + "type": "string" + }, + "HomeDirectoryMappings": { + "items": { + "$ref": "#/definitions/HomeDirectoryMapEntry" + }, + "type": "array", + "uniqueItems": false + }, + "HomeDirectoryType": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Policy": { + "type": "string" + }, + "PosixProfile": { + "$ref": "#/definitions/PosixProfile" + }, + "Role": { + "type": "string" + }, + "ServerId": { + "type": "string" + }, + "SshPublicKeys": { + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "type": "array", + "uniqueItems": false + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserName": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Arn" + ], + "required": [ + "Role", + "ServerId", + "UserName" + ], + "typeName": "AWS::Transfer::User" +} diff --git a/schema/aws-transfer-workflow.json b/schema/aws-transfer-workflow.json index ae9255e..b3cb68b 100644 --- a/schema/aws-transfer-workflow.json +++ b/schema/aws-transfer-workflow.json @@ -1,400 +1,400 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Steps", - "/properties/OnExceptionSteps", - "/properties/Description" - ], - "definitions": { - "EfsInputFileLocation": { - "additionalProperties": false, - "description": "Specifies the details for an EFS file.", - "properties": { - "FileSystemId": { - "description": "Specifies the EFS filesystem that contains the file.", - "maxLength": 128, - "minLength": 0, - "pattern": "^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$", - "type": "string" - }, - "Path": { - "description": "The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.", - "maxLength": 65536, - "minLength": 1, - "pattern": "^[^\\x00]+$", - "type": "string" - } - }, - "type": "object" - }, - "InputFileLocation": { - "additionalProperties": false, - "description": "Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps.", - "properties": { - "EfsFileLocation": { - "$ref": "#/definitions/EfsInputFileLocation" - }, - "S3FileLocation": { - "$ref": "#/definitions/S3InputFileLocation" - } - }, - "type": "object" - }, - "S3FileLocation": { - "additionalProperties": false, - "description": "Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.", - "properties": { - "S3FileLocation": { - "$ref": "#/definitions/S3InputFileLocation" - } - }, - "type": "object" - }, - "S3InputFileLocation": { - "additionalProperties": false, - "description": "Specifies the details for a S3 file.", - "properties": { - "Bucket": { - "description": "Specifies the S3 bucket that contains the file.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", - "type": "string" - }, - "Key": { - "description": "The name assigned to the file when it was created in S3. You use the object key to retrieve the object.", - "maxLength": 1024, - "minLength": 0, - "pattern": ".*", - "type": "string" - } - }, - "type": "object" - }, - "S3Tag": { - "additionalProperties": false, - "description": "Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.", - "properties": { - "Key": { - "description": "The name assigned to the tag that you create.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "The value that corresponds to the key.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "description": "Creates a key-value pair for a specific resource.", - "properties": { - "Key": { - "description": "The name assigned to the tag that you create.", - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "description": "Contains one or more values that you assigned to the key name you create.", - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WorkflowStep": { - "additionalProperties": false, - "description": "The basic building block of a workflow.", - "properties": { - "CopyStepDetails": { - "additionalProperties": false, - "description": "Details for a step that performs a file copy.", - "properties": { - "DestinationFileLocation": { - "$ref": "#/definitions/S3FileLocation" - }, - "Name": { - "description": "The name of the step, used as an identifier.", - "maxLength": 30, - "minLength": 0, - "pattern": "^[\\w-]*$", - "type": "string" - }, - "OverwriteExisting": { - "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.", - "enum": [ - "TRUE", - "FALSE" - ], - "type": "string" - }, - "SourceFileLocation": { - "description": "Specifies which file to use as input to the workflow step.", - "maxLength": 256, - "minLength": 0, - "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", - "type": "string" - } - }, - "type": "object" - }, - "CustomStepDetails": { - "additionalProperties": false, - "description": "Details for a step that invokes a lambda function.", - "properties": { - "Name": { - "description": "The name of the step, used as an identifier.", - "maxLength": 30, - "minLength": 0, - "pattern": "^[\\w-]*$", - "type": "string" - }, - "SourceFileLocation": { - "description": "Specifies which file to use as input to the workflow step.", - "maxLength": 256, - "minLength": 0, - "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", - "type": "string" - }, - "Target": { - "description": "The ARN for the lambda function that is being called.", - "maxLength": 170, - "minLength": 0, - "pattern": "arn:[a-z-]+:lambda:.*$", - "type": "string" - }, - "TimeoutSeconds": { - "description": "Timeout, in seconds, for the step.", - "maximum": 1800, - "minimum": 1, - "type": "integer" - } - }, - "type": "object" - }, - "DecryptStepDetails": { - "additionalProperties": false, - "description": "Details for a step that performs a file decryption.", - "properties": { - "DestinationFileLocation": { - "$ref": "#/definitions/InputFileLocation" - }, - "Name": { - "description": "The name of the step, used as an identifier.", - "maxLength": 30, - "minLength": 0, - "pattern": "^[\\w-]*$", - "type": "string" - }, - "OverwriteExisting": { - "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.", - "enum": [ - "TRUE", - "FALSE" - ], - "type": "string" - }, - "SourceFileLocation": { - "description": "Specifies which file to use as input to the workflow step.", - "maxLength": 256, - "minLength": 0, - "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", - "type": "string" - }, - "Type": { - "description": "Specifies which encryption method to use.", - "enum": [ - "PGP" - ], - "type": "string" - } - }, - "required": [ - "DestinationFileLocation", - "Type" - ], - "type": "object" - }, - "DeleteStepDetails": { - "additionalProperties": false, - "description": "Details for a step that deletes the file.", - "properties": { - "Name": { - "description": "The name of the step, used as an identifier.", - "maxLength": 30, - "minLength": 0, - "pattern": "^[\\w-]*$", - "type": "string" - }, - "SourceFileLocation": { - "description": "Specifies which file to use as input to the workflow step.", - "maxLength": 256, - "minLength": 0, - "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", - "type": "string" - } - }, - "type": "object" - }, - "TagStepDetails": { - "additionalProperties": false, - "description": "Details for a step that creates one or more tags.", - "properties": { - "Name": { - "description": "The name of the step, used as an identifier.", - "maxLength": 30, - "minLength": 0, - "pattern": "^[\\w-]*$", - "type": "string" - }, - "SourceFileLocation": { - "description": "Specifies which file to use as input to the workflow step.", - "maxLength": 256, - "minLength": 0, - "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", - "type": "string" - }, - "Tags": { - "description": "Array that contains from 1 to 10 key/value pairs.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/S3Tag" - }, - "maxItems": 10, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "COPY", - "CUSTOM", - "DECRYPT", - "DELETE", - "TAG" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Transfer::Workflow", - "handlers": { - "create": { - "permissions": [ - "transfer:CreateWorkflow", - "transfer:TagResource" - ] - }, - "delete": { - "permissions": [ - "transfer:DeleteWorkflow" - ] - }, - "list": { - "permissions": [ - "transfer:ListWorkflows" - ] - }, - "read": { - "permissions": [ - "transfer:DescribeWorkflow" - ] - }, - "update": { - "permissions": [ - "transfer:UnTagResource", - "transfer:TagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/WorkflowId" - ], - "properties": { - "Arn": { - "description": "Specifies the unique Amazon Resource Name (ARN) for the workflow.", - "maxLength": 1600, - "minLength": 20, - "pattern": "arn:.*", - "type": "string" - }, - "Description": { - "description": "A textual description for the workflow.", - "maxLength": 256, - "minLength": 0, - "pattern": "^[\\w\\- ]*$", - "type": "string" - }, - "OnExceptionSteps": { - "description": "Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowStep" - }, - "maxItems": 8, - "type": "array", - "uniqueItems": true - }, - "Steps": { - "description": "Specifies the details for the steps that are in the specified workflow.", - "insertionOrder": true, - "items": { - "$ref": "#/definitions/WorkflowStep" - }, - "maxItems": 8, - "type": "array", - "uniqueItems": true - }, - "Tags": { - "description": "Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "WorkflowId": { - "description": "A unique identifier for the workflow.", - "maxLength": 19, - "minLength": 19, - "pattern": "^w-([a-z0-9]{17})$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/WorkflowId", - "/properties/Arn" - ], - "required": [ - "Steps" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Transfer::Workflow" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Steps", + "/properties/OnExceptionSteps", + "/properties/Description" + ], + "definitions": { + "EfsInputFileLocation": { + "additionalProperties": false, + "description": "Specifies the details for an EFS file.", + "properties": { + "FileSystemId": { + "description": "Specifies the EFS filesystem that contains the file.", + "maxLength": 128, + "minLength": 0, + "pattern": "^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$", + "type": "string" + }, + "Path": { + "description": "The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.", + "maxLength": 65536, + "minLength": 1, + "pattern": "^[^\\x00]+$", + "type": "string" + } + }, + "type": "object" + }, + "InputFileLocation": { + "additionalProperties": false, + "description": "Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps.", + "properties": { + "EfsFileLocation": { + "$ref": "#/definitions/EfsInputFileLocation" + }, + "S3FileLocation": { + "$ref": "#/definitions/S3InputFileLocation" + } + }, + "type": "object" + }, + "S3FileLocation": { + "additionalProperties": false, + "description": "Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.", + "properties": { + "S3FileLocation": { + "$ref": "#/definitions/S3InputFileLocation" + } + }, + "type": "object" + }, + "S3InputFileLocation": { + "additionalProperties": false, + "description": "Specifies the details for a S3 file.", + "properties": { + "Bucket": { + "description": "Specifies the S3 bucket that contains the file.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "Key": { + "description": "The name assigned to the file when it was created in S3. You use the object key to retrieve the object.", + "maxLength": 1024, + "minLength": 0, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "S3Tag": { + "additionalProperties": false, + "description": "Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.", + "properties": { + "Key": { + "description": "The name assigned to the tag that you create.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value that corresponds to the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Creates a key-value pair for a specific resource.", + "properties": { + "Key": { + "description": "The name assigned to the tag that you create.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Contains one or more values that you assigned to the key name you create.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WorkflowStep": { + "additionalProperties": false, + "description": "The basic building block of a workflow.", + "properties": { + "CopyStepDetails": { + "additionalProperties": false, + "description": "Details for a step that performs a file copy.", + "properties": { + "DestinationFileLocation": { + "$ref": "#/definitions/S3FileLocation" + }, + "Name": { + "description": "The name of the step, used as an identifier.", + "maxLength": 30, + "minLength": 0, + "pattern": "^[\\w-]*$", + "type": "string" + }, + "OverwriteExisting": { + "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.", + "enum": [ + "TRUE", + "FALSE" + ], + "type": "string" + }, + "SourceFileLocation": { + "description": "Specifies which file to use as input to the workflow step.", + "maxLength": 256, + "minLength": 0, + "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", + "type": "string" + } + }, + "type": "object" + }, + "CustomStepDetails": { + "additionalProperties": false, + "description": "Details for a step that invokes a lambda function.", + "properties": { + "Name": { + "description": "The name of the step, used as an identifier.", + "maxLength": 30, + "minLength": 0, + "pattern": "^[\\w-]*$", + "type": "string" + }, + "SourceFileLocation": { + "description": "Specifies which file to use as input to the workflow step.", + "maxLength": 256, + "minLength": 0, + "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", + "type": "string" + }, + "Target": { + "description": "The ARN for the lambda function that is being called.", + "maxLength": 170, + "minLength": 0, + "pattern": "arn:[a-z-]+:lambda:.*$", + "type": "string" + }, + "TimeoutSeconds": { + "description": "Timeout, in seconds, for the step.", + "maximum": 1800, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "DecryptStepDetails": { + "additionalProperties": false, + "description": "Details for a step that performs a file decryption.", + "properties": { + "DestinationFileLocation": { + "$ref": "#/definitions/InputFileLocation" + }, + "Name": { + "description": "The name of the step, used as an identifier.", + "maxLength": 30, + "minLength": 0, + "pattern": "^[\\w-]*$", + "type": "string" + }, + "OverwriteExisting": { + "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.", + "enum": [ + "TRUE", + "FALSE" + ], + "type": "string" + }, + "SourceFileLocation": { + "description": "Specifies which file to use as input to the workflow step.", + "maxLength": 256, + "minLength": 0, + "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", + "type": "string" + }, + "Type": { + "description": "Specifies which encryption method to use.", + "enum": [ + "PGP" + ], + "type": "string" + } + }, + "required": [ + "DestinationFileLocation", + "Type" + ], + "type": "object" + }, + "DeleteStepDetails": { + "additionalProperties": false, + "description": "Details for a step that deletes the file.", + "properties": { + "Name": { + "description": "The name of the step, used as an identifier.", + "maxLength": 30, + "minLength": 0, + "pattern": "^[\\w-]*$", + "type": "string" + }, + "SourceFileLocation": { + "description": "Specifies which file to use as input to the workflow step.", + "maxLength": 256, + "minLength": 0, + "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", + "type": "string" + } + }, + "type": "object" + }, + "TagStepDetails": { + "additionalProperties": false, + "description": "Details for a step that creates one or more tags.", + "properties": { + "Name": { + "description": "The name of the step, used as an identifier.", + "maxLength": 30, + "minLength": 0, + "pattern": "^[\\w-]*$", + "type": "string" + }, + "SourceFileLocation": { + "description": "Specifies which file to use as input to the workflow step.", + "maxLength": 256, + "minLength": 0, + "pattern": "^\\$\\{(\\w+.)+\\w+\\}$", + "type": "string" + }, + "Tags": { + "description": "Array that contains from 1 to 10 key/value pairs.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/S3Tag" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Type": { + "enum": [ + "COPY", + "CUSTOM", + "DECRYPT", + "DELETE", + "TAG" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Transfer::Workflow", + "handlers": { + "create": { + "permissions": [ + "transfer:CreateWorkflow", + "transfer:TagResource" + ] + }, + "delete": { + "permissions": [ + "transfer:DeleteWorkflow" + ] + }, + "list": { + "permissions": [ + "transfer:ListWorkflows" + ] + }, + "read": { + "permissions": [ + "transfer:DescribeWorkflow" + ] + }, + "update": { + "permissions": [ + "transfer:UnTagResource", + "transfer:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkflowId" + ], + "properties": { + "Arn": { + "description": "Specifies the unique Amazon Resource Name (ARN) for the workflow.", + "maxLength": 1600, + "minLength": 20, + "pattern": "arn:.*", + "type": "string" + }, + "Description": { + "description": "A textual description for the workflow.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\w\\- ]*$", + "type": "string" + }, + "OnExceptionSteps": { + "description": "Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowStep" + }, + "maxItems": 8, + "type": "array", + "uniqueItems": true + }, + "Steps": { + "description": "Specifies the details for the steps that are in the specified workflow.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/WorkflowStep" + }, + "maxItems": 8, + "type": "array", + "uniqueItems": true + }, + "Tags": { + "description": "Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "WorkflowId": { + "description": "A unique identifier for the workflow.", + "maxLength": 19, + "minLength": 19, + "pattern": "^w-([a-z0-9]{17})$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/WorkflowId", + "/properties/Arn" + ], + "required": [ + "Steps" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Transfer::Workflow" +} diff --git a/schema/aws-verifiedpermissions-identitysource.json b/schema/aws-verifiedpermissions-identitysource.json index 8f48c45..4987a45 100644 --- a/schema/aws-verifiedpermissions-identitysource.json +++ b/schema/aws-verifiedpermissions-identitysource.json @@ -1,345 +1,345 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyStoreId" - ], - "definitions": { - "CognitoGroupConfiguration": { - "additionalProperties": false, - "properties": { - "GroupEntityType": { - "maxLength": 200, - "minLength": 1, - "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", - "type": "string" - } - }, - "required": [ - "GroupEntityType" - ], - "type": "object" - }, - "CognitoUserPoolConfiguration": { - "additionalProperties": false, - "properties": { - "ClientIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array" - }, - "GroupConfiguration": { - "$ref": "#/definitions/CognitoGroupConfiguration" - }, - "UserPoolArn": { - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$", - "type": "string" - } - }, - "required": [ - "UserPoolArn" - ], - "type": "object" - }, - "IdentitySourceConfiguration": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "CognitoUserPoolConfiguration": { - "$ref": "#/definitions/CognitoUserPoolConfiguration" - } - }, - "required": [ - "CognitoUserPoolConfiguration" - ], - "title": "CognitoUserPoolConfiguration", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "OpenIdConnectConfiguration": { - "$ref": "#/definitions/OpenIdConnectConfiguration" - } - }, - "required": [ - "OpenIdConnectConfiguration" - ], - "title": "OpenIdConnectConfiguration", - "type": "object" - } - ] - }, - "IdentitySourceDetails": { - "additionalProperties": false, - "properties": { - "ClientIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array" - }, - "DiscoveryUrl": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^https://.*$", - "type": "string" - }, - "OpenIdIssuer": { - "$ref": "#/definitions/OpenIdIssuer" - }, - "UserPoolArn": { - "maxLength": 255, - "minLength": 1, - "pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$", - "type": "string" - } - }, - "type": "object" - }, - "OpenIdConnectAccessTokenConfiguration": { - "additionalProperties": false, - "properties": { - "Audiences": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 255, - "minItems": 1, - "type": "array" - }, - "PrincipalIdClaim": { - "default": "sub", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "OpenIdConnectConfiguration": { - "additionalProperties": false, - "properties": { - "EntityIdPrefix": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "GroupConfiguration": { - "$ref": "#/definitions/OpenIdConnectGroupConfiguration" - }, - "Issuer": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^https://.*$", - "type": "string" - }, - "TokenSelection": { - "$ref": "#/definitions/OpenIdConnectTokenSelection" - } - }, - "required": [ - "Issuer", - "TokenSelection" - ], - "type": "object" - }, - "OpenIdConnectGroupConfiguration": { - "additionalProperties": false, - "properties": { - "GroupClaim": { - "minLength": 1, - "type": "string" - }, - "GroupEntityType": { - "maxLength": 200, - "minLength": 1, - "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", - "type": "string" - } - }, - "required": [ - "GroupClaim", - "GroupEntityType" - ], - "type": "object" - }, - "OpenIdConnectIdentityTokenConfiguration": { - "additionalProperties": false, - "properties": { - "ClientIds": { - "insertionOrder": false, - "items": { - "maxLength": 255, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "maxItems": 1000, - "minItems": 0, - "type": "array" - }, - "PrincipalIdClaim": { - "default": "sub", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "OpenIdConnectTokenSelection": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "AccessTokenOnly": { - "$ref": "#/definitions/OpenIdConnectAccessTokenConfiguration" - } - }, - "required": [ - "AccessTokenOnly" - ], - "title": "AccessTokenOnly", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "IdentityTokenOnly": { - "$ref": "#/definitions/OpenIdConnectIdentityTokenConfiguration" - } - }, - "required": [ - "IdentityTokenOnly" - ], - "title": "IdentityTokenOnly", - "type": "object" - } - ] - }, - "OpenIdIssuer": { - "enum": [ - "COGNITO" - ], - "type": "string" - } - }, - "deprecatedProperties": [ - "/properties/Details" - ], - "description": "Definition of AWS::VerifiedPermissions::IdentitySource Resource Type", - "handlers": { - "create": { - "permissions": [ - "verifiedpermissions:CreateIdentitySource", - "verifiedpermissions:GetIdentitySource", - "cognito-idp:DescribeUserPool", - "cognito-idp:ListUserPoolClients" - ] - }, - "delete": { - "permissions": [ - "verifiedpermissions:DeleteIdentitySource", - "verifiedpermissions:GetIdentitySource", - "cognito-idp:DescribeUserPool", - "cognito-idp:ListUserPoolClients" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PolicyStoreId": { - "$ref": "resource-schema.json#/properties/PolicyStoreId" - } - }, - "required": [ - "PolicyStoreId" - ] - }, - "permissions": [ - "verifiedpermissions:ListIdentitySources", - "verifiedpermissions:GetIdentitySource", - "cognito-idp:DescribeUserPool", - "cognito-idp:ListUserPoolClients" - ] - }, - "read": { - "permissions": [ - "verifiedpermissions:GetIdentitySource", - "cognito-idp:DescribeUserPool", - "cognito-idp:ListUserPoolClients" - ] - }, - "update": { - "permissions": [ - "verifiedpermissions:UpdateIdentitySource", - "verifiedpermissions:GetIdentitySource", - "cognito-idp:DescribeUserPool", - "cognito-idp:ListUserPoolClients" - ] - } - }, - "primaryIdentifier": [ - "/properties/IdentitySourceId", - "/properties/PolicyStoreId" - ], - "properties": { - "Configuration": { - "$ref": "#/definitions/IdentitySourceConfiguration" - }, - "Details": { - "$ref": "#/definitions/IdentitySourceDetails" - }, - "IdentitySourceId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "PolicyStoreId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "PrincipalEntityType": { - "maxLength": 200, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Details", - "/properties/IdentitySourceId" - ], - "required": [ - "Configuration", - "PolicyStoreId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::VerifiedPermissions::IdentitySource" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyStoreId" + ], + "definitions": { + "CognitoGroupConfiguration": { + "additionalProperties": false, + "properties": { + "GroupEntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "GroupEntityType" + ], + "type": "object" + }, + "CognitoUserPoolConfiguration": { + "additionalProperties": false, + "properties": { + "ClientIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "GroupConfiguration": { + "$ref": "#/definitions/CognitoGroupConfiguration" + }, + "UserPoolArn": { + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$", + "type": "string" + } + }, + "required": [ + "UserPoolArn" + ], + "type": "object" + }, + "IdentitySourceConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "CognitoUserPoolConfiguration": { + "$ref": "#/definitions/CognitoUserPoolConfiguration" + } + }, + "required": [ + "CognitoUserPoolConfiguration" + ], + "title": "CognitoUserPoolConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "OpenIdConnectConfiguration": { + "$ref": "#/definitions/OpenIdConnectConfiguration" + } + }, + "required": [ + "OpenIdConnectConfiguration" + ], + "title": "OpenIdConnectConfiguration", + "type": "object" + } + ] + }, + "IdentitySourceDetails": { + "additionalProperties": false, + "properties": { + "ClientIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "DiscoveryUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^https://.*$", + "type": "string" + }, + "OpenIdIssuer": { + "$ref": "#/definitions/OpenIdIssuer" + }, + "UserPoolArn": { + "maxLength": 255, + "minLength": 1, + "pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$", + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectAccessTokenConfiguration": { + "additionalProperties": false, + "properties": { + "Audiences": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 255, + "minItems": 1, + "type": "array" + }, + "PrincipalIdClaim": { + "default": "sub", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectConfiguration": { + "additionalProperties": false, + "properties": { + "EntityIdPrefix": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "GroupConfiguration": { + "$ref": "#/definitions/OpenIdConnectGroupConfiguration" + }, + "Issuer": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^https://.*$", + "type": "string" + }, + "TokenSelection": { + "$ref": "#/definitions/OpenIdConnectTokenSelection" + } + }, + "required": [ + "Issuer", + "TokenSelection" + ], + "type": "object" + }, + "OpenIdConnectGroupConfiguration": { + "additionalProperties": false, + "properties": { + "GroupClaim": { + "minLength": 1, + "type": "string" + }, + "GroupEntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "GroupClaim", + "GroupEntityType" + ], + "type": "object" + }, + "OpenIdConnectIdentityTokenConfiguration": { + "additionalProperties": false, + "properties": { + "ClientIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "PrincipalIdClaim": { + "default": "sub", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectTokenSelection": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "AccessTokenOnly": { + "$ref": "#/definitions/OpenIdConnectAccessTokenConfiguration" + } + }, + "required": [ + "AccessTokenOnly" + ], + "title": "AccessTokenOnly", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "IdentityTokenOnly": { + "$ref": "#/definitions/OpenIdConnectIdentityTokenConfiguration" + } + }, + "required": [ + "IdentityTokenOnly" + ], + "title": "IdentityTokenOnly", + "type": "object" + } + ] + }, + "OpenIdIssuer": { + "enum": [ + "COGNITO" + ], + "type": "string" + } + }, + "deprecatedProperties": [ + "/properties/Details" + ], + "description": "Definition of AWS::VerifiedPermissions::IdentitySource Resource Type", + "handlers": { + "create": { + "permissions": [ + "verifiedpermissions:CreateIdentitySource", + "verifiedpermissions:GetIdentitySource", + "cognito-idp:DescribeUserPool", + "cognito-idp:ListUserPoolClients" + ] + }, + "delete": { + "permissions": [ + "verifiedpermissions:DeleteIdentitySource", + "verifiedpermissions:GetIdentitySource", + "cognito-idp:DescribeUserPool", + "cognito-idp:ListUserPoolClients" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PolicyStoreId": { + "$ref": "resource-schema.json#/properties/PolicyStoreId" + } + }, + "required": [ + "PolicyStoreId" + ] + }, + "permissions": [ + "verifiedpermissions:ListIdentitySources", + "verifiedpermissions:GetIdentitySource", + "cognito-idp:DescribeUserPool", + "cognito-idp:ListUserPoolClients" + ] + }, + "read": { + "permissions": [ + "verifiedpermissions:GetIdentitySource", + "cognito-idp:DescribeUserPool", + "cognito-idp:ListUserPoolClients" + ] + }, + "update": { + "permissions": [ + "verifiedpermissions:UpdateIdentitySource", + "verifiedpermissions:GetIdentitySource", + "cognito-idp:DescribeUserPool", + "cognito-idp:ListUserPoolClients" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdentitySourceId", + "/properties/PolicyStoreId" + ], + "properties": { + "Configuration": { + "$ref": "#/definitions/IdentitySourceConfiguration" + }, + "Details": { + "$ref": "#/definitions/IdentitySourceDetails" + }, + "IdentitySourceId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "PolicyStoreId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "PrincipalEntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Details", + "/properties/IdentitySourceId" + ], + "required": [ + "Configuration", + "PolicyStoreId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::VerifiedPermissions::IdentitySource" +} diff --git a/schema/aws-verifiedpermissions-policy.json b/schema/aws-verifiedpermissions-policy.json index 20aeddf..9900d68 100644 --- a/schema/aws-verifiedpermissions-policy.json +++ b/schema/aws-verifiedpermissions-policy.json @@ -1,189 +1,189 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyStoreId" - ], - "definitions": { - "EntityIdentifier": { - "additionalProperties": false, - "properties": { - "EntityId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - }, - "EntityType": { - "maxLength": 200, - "minLength": 1, - "pattern": "^.*$", - "type": "string" - } - }, - "required": [ - "EntityId", - "EntityType" - ], - "type": "object" - }, - "PolicyDefinition": { - "oneOf": [ - { - "additionalProperties": false, - "properties": { - "Static": { - "$ref": "#/definitions/StaticPolicyDefinition" - } - }, - "required": [ - "Static" - ], - "title": "Static", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "TemplateLinked": { - "$ref": "#/definitions/TemplateLinkedPolicyDefinition" - } - }, - "required": [ - "TemplateLinked" - ], - "title": "TemplateLinked", - "type": "object" - } - ] - }, - "PolicyType": { - "enum": [ - "STATIC", - "TEMPLATE_LINKED" - ], - "type": "string" - }, - "StaticPolicyDefinition": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 150, - "minLength": 0, - "type": "string" - }, - "Statement": { - "maxLength": 10000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "TemplateLinkedPolicyDefinition": { - "additionalProperties": false, - "properties": { - "PolicyTemplateId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "Principal": { - "$ref": "#/definitions/EntityIdentifier" - }, - "Resource": { - "$ref": "#/definitions/EntityIdentifier" - } - }, - "required": [ - "PolicyTemplateId" - ], - "type": "object" - } - }, - "description": "Definition of AWS::VerifiedPermissions::Policy Resource Type", - "handlers": { - "create": { - "permissions": [ - "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy" - ] - }, - "delete": { - "permissions": [ - "verifiedpermissions:DeletePolicy", - "verifiedpermissions:GetPolicy" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PolicyStoreId": { - "$ref": "resource-schema.json#/properties/PolicyStoreId" - } - }, - "required": [ - "PolicyStoreId" - ] - }, - "permissions": [ - "verifiedpermissions:ListPolicies", - "verifiedpermissions:GetPolicy" - ] - }, - "read": { - "permissions": [ - "verifiedpermissions:GetPolicy" - ] - }, - "update": { - "permissions": [ - "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:GetPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyId", - "/properties/PolicyStoreId" - ], - "properties": { - "Definition": { - "$ref": "#/definitions/PolicyDefinition" - }, - "PolicyId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "PolicyStoreId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "PolicyType": { - "$ref": "#/definitions/PolicyType" - } - }, - "readOnlyProperties": [ - "/properties/PolicyId", - "/properties/PolicyType" - ], - "required": [ - "Definition", - "PolicyStoreId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::VerifiedPermissions::Policy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyStoreId" + ], + "definitions": { + "EntityIdentifier": { + "additionalProperties": false, + "properties": { + "EntityId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "EntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "EntityId", + "EntityType" + ], + "type": "object" + }, + "PolicyDefinition": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Static": { + "$ref": "#/definitions/StaticPolicyDefinition" + } + }, + "required": [ + "Static" + ], + "title": "Static", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "TemplateLinked": { + "$ref": "#/definitions/TemplateLinkedPolicyDefinition" + } + }, + "required": [ + "TemplateLinked" + ], + "title": "TemplateLinked", + "type": "object" + } + ] + }, + "PolicyType": { + "enum": [ + "STATIC", + "TEMPLATE_LINKED" + ], + "type": "string" + }, + "StaticPolicyDefinition": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "Statement": { + "maxLength": 10000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Statement" + ], + "type": "object" + }, + "TemplateLinkedPolicyDefinition": { + "additionalProperties": false, + "properties": { + "PolicyTemplateId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "Principal": { + "$ref": "#/definitions/EntityIdentifier" + }, + "Resource": { + "$ref": "#/definitions/EntityIdentifier" + } + }, + "required": [ + "PolicyTemplateId" + ], + "type": "object" + } + }, + "description": "Definition of AWS::VerifiedPermissions::Policy Resource Type", + "handlers": { + "create": { + "permissions": [ + "verifiedpermissions:CreatePolicy", + "verifiedpermissions:GetPolicy" + ] + }, + "delete": { + "permissions": [ + "verifiedpermissions:DeletePolicy", + "verifiedpermissions:GetPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PolicyStoreId": { + "$ref": "resource-schema.json#/properties/PolicyStoreId" + } + }, + "required": [ + "PolicyStoreId" + ] + }, + "permissions": [ + "verifiedpermissions:ListPolicies", + "verifiedpermissions:GetPolicy" + ] + }, + "read": { + "permissions": [ + "verifiedpermissions:GetPolicy" + ] + }, + "update": { + "permissions": [ + "verifiedpermissions:UpdatePolicy", + "verifiedpermissions:GetPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyId", + "/properties/PolicyStoreId" + ], + "properties": { + "Definition": { + "$ref": "#/definitions/PolicyDefinition" + }, + "PolicyId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "PolicyStoreId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "PolicyType": { + "$ref": "#/definitions/PolicyType" + } + }, + "readOnlyProperties": [ + "/properties/PolicyId", + "/properties/PolicyType" + ], + "required": [ + "Definition", + "PolicyStoreId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::VerifiedPermissions::Policy" +} diff --git a/schema/aws-verifiedpermissions-policystore.json b/schema/aws-verifiedpermissions-policystore.json index 667f809..342f3f8 100644 --- a/schema/aws-verifiedpermissions-policystore.json +++ b/schema/aws-verifiedpermissions-policystore.json @@ -1,119 +1,119 @@ -{ - "additionalProperties": false, - "definitions": { - "SchemaDefinition": { - "additionalProperties": false, - "properties": { - "CedarJson": { - "$ref": "#/definitions/SchemaJson" - } - }, - "type": "object" - }, - "SchemaJson": { - "type": "string" - }, - "ValidationMode": { - "enum": [ - "OFF", - "STRICT" - ], - "type": "string" - }, - "ValidationSettings": { - "additionalProperties": false, - "properties": { - "Mode": { - "$ref": "#/definitions/ValidationMode" - } - }, - "required": [ - "Mode" - ], - "type": "object" - } - }, - "description": "Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests", - "handlers": { - "create": { - "permissions": [ - "verifiedpermissions:CreatePolicyStore", - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:PutSchema" - ] - }, - "delete": { - "permissions": [ - "verifiedpermissions:DeletePolicyStore", - "verifiedpermissions:GetPolicyStore" - ] - }, - "list": { - "permissions": [ - "verifiedpermissions:ListPolicyStores", - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:GetSchema" - ] - }, - "read": { - "permissions": [ - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:GetSchema" - ] - }, - "update": { - "permissions": [ - "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:GetSchema", - "verifiedpermissions:PutSchema" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyStoreId" - ], - "properties": { - "Arn": { - "maxLength": 2500, - "minLength": 1, - "pattern": "^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$", - "type": "string" - }, - "Description": { - "maxLength": 150, - "minLength": 0, - "type": "string" - }, - "PolicyStoreId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "Schema": { - "$ref": "#/definitions/SchemaDefinition" - }, - "ValidationSettings": { - "$ref": "#/definitions/ValidationSettings" - } - }, - "propertyTransform": { - "/properties/Schema/CedarJson": "$join([CedarJson, \"{}\"])" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/PolicyStoreId" - ], - "required": [ - "ValidationSettings" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::VerifiedPermissions::PolicyStore" -} +{ + "additionalProperties": false, + "definitions": { + "SchemaDefinition": { + "additionalProperties": false, + "properties": { + "CedarJson": { + "$ref": "#/definitions/SchemaJson" + } + }, + "type": "object" + }, + "SchemaJson": { + "type": "string" + }, + "ValidationMode": { + "enum": [ + "OFF", + "STRICT" + ], + "type": "string" + }, + "ValidationSettings": { + "additionalProperties": false, + "properties": { + "Mode": { + "$ref": "#/definitions/ValidationMode" + } + }, + "required": [ + "Mode" + ], + "type": "object" + } + }, + "description": "Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests", + "handlers": { + "create": { + "permissions": [ + "verifiedpermissions:CreatePolicyStore", + "verifiedpermissions:GetPolicyStore", + "verifiedpermissions:PutSchema" + ] + }, + "delete": { + "permissions": [ + "verifiedpermissions:DeletePolicyStore", + "verifiedpermissions:GetPolicyStore" + ] + }, + "list": { + "permissions": [ + "verifiedpermissions:ListPolicyStores", + "verifiedpermissions:GetPolicyStore", + "verifiedpermissions:GetSchema" + ] + }, + "read": { + "permissions": [ + "verifiedpermissions:GetPolicyStore", + "verifiedpermissions:GetSchema" + ] + }, + "update": { + "permissions": [ + "verifiedpermissions:UpdatePolicyStore", + "verifiedpermissions:GetPolicyStore", + "verifiedpermissions:GetSchema", + "verifiedpermissions:PutSchema" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyStoreId" + ], + "properties": { + "Arn": { + "maxLength": 2500, + "minLength": 1, + "pattern": "^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$", + "type": "string" + }, + "Description": { + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "PolicyStoreId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "Schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "ValidationSettings": { + "$ref": "#/definitions/ValidationSettings" + } + }, + "propertyTransform": { + "/properties/Schema/CedarJson": "$join([CedarJson, \"{}\"])" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/PolicyStoreId" + ], + "required": [ + "ValidationSettings" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::VerifiedPermissions::PolicyStore" +} diff --git a/schema/aws-verifiedpermissions-policytemplate.json b/schema/aws-verifiedpermissions-policytemplate.json index 86dc4cc..4d03893 100644 --- a/schema/aws-verifiedpermissions-policytemplate.json +++ b/schema/aws-verifiedpermissions-policytemplate.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyStoreId" - ], - "description": "Definition of AWS::VerifiedPermissions::PolicyTemplate Resource Type", - "handlers": { - "create": { - "permissions": [ - "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate" - ] - }, - "delete": { - "permissions": [ - "verifiedpermissions:DeletePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PolicyStoreId": { - "$ref": "resource-schema.json#/properties/PolicyStoreId" - } - }, - "required": [ - "PolicyStoreId" - ] - }, - "permissions": [ - "verifiedpermissions:ListPolicyTemplates", - "verifiedpermissions:GetPolicyTemplate" - ] - }, - "read": { - "permissions": [ - "verifiedpermissions:GetPolicyTemplate" - ] - }, - "update": { - "permissions": [ - "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyStoreId", - "/properties/PolicyTemplateId" - ], - "properties": { - "Description": { - "maxLength": 150, - "minLength": 0, - "type": "string" - }, - "PolicyStoreId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "PolicyTemplateId": { - "maxLength": 200, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]*$", - "type": "string" - }, - "Statement": { - "maxLength": 10000, - "minLength": 1, - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/PolicyTemplateId" - ], - "required": [ - "Statement", - "PolicyStoreId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::VerifiedPermissions::PolicyTemplate" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyStoreId" + ], + "description": "Definition of AWS::VerifiedPermissions::PolicyTemplate Resource Type", + "handlers": { + "create": { + "permissions": [ + "verifiedpermissions:CreatePolicyTemplate", + "verifiedpermissions:GetPolicyTemplate" + ] + }, + "delete": { + "permissions": [ + "verifiedpermissions:DeletePolicyTemplate", + "verifiedpermissions:GetPolicyTemplate" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PolicyStoreId": { + "$ref": "resource-schema.json#/properties/PolicyStoreId" + } + }, + "required": [ + "PolicyStoreId" + ] + }, + "permissions": [ + "verifiedpermissions:ListPolicyTemplates", + "verifiedpermissions:GetPolicyTemplate" + ] + }, + "read": { + "permissions": [ + "verifiedpermissions:GetPolicyTemplate" + ] + }, + "update": { + "permissions": [ + "verifiedpermissions:UpdatePolicyTemplate", + "verifiedpermissions:GetPolicyTemplate" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyStoreId", + "/properties/PolicyTemplateId" + ], + "properties": { + "Description": { + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "PolicyStoreId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "PolicyTemplateId": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "Statement": { + "maxLength": 10000, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/PolicyTemplateId" + ], + "required": [ + "Statement", + "PolicyStoreId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::VerifiedPermissions::PolicyTemplate" +} diff --git a/schema/aws-voiceid-domain.json b/schema/aws-voiceid-domain.json index 7b5a78f..6aa71e2 100644 --- a/schema/aws-voiceid-domain.json +++ b/schema/aws-voiceid-domain.json @@ -1,142 +1,142 @@ -{ - "additionalProperties": false, - "definitions": { - "ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "KmsKeyId" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "The AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.", - "handlers": { - "create": { - "permissions": [ - "voiceid:CreateDomain", - "voiceid:DescribeDomain", - "voiceid:TagResource", - "voiceid:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "voiceid:DeleteDomain", - "voiceid:DescribeDomain", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "voiceid:ListDomains", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "voiceid:DescribeDomain", - "voiceid:ListTagsForResource", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "voiceid:DescribeDomain", - "voiceid:UpdateDomain", - "voiceid:TagResource", - "voiceid:UntagResource", - "voiceid:ListTagsForResource", - "kms:CreateGrant", - "kms:Decrypt", - "kms:DescribeKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/DomainId" - ], - "properties": { - "Description": { - "maxLength": 1024, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$", - "type": "string" - }, - "DomainId": { - "maxLength": 22, - "minLength": 22, - "pattern": "^[a-zA-Z0-9]{22}$", - "type": "string" - }, - "Name": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", - "type": "string" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/ServerSideEncryptionConfiguration" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/DomainId" - ], - "required": [ - "Name", - "ServerSideEncryptionConfiguration" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "#/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VoiceID::Domain", - "writeOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/ServerSideEncryptionConfiguration" - ] -} +{ + "additionalProperties": false, + "definitions": { + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "KmsKeyId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.", + "handlers": { + "create": { + "permissions": [ + "voiceid:CreateDomain", + "voiceid:DescribeDomain", + "voiceid:TagResource", + "voiceid:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "voiceid:DeleteDomain", + "voiceid:DescribeDomain", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "voiceid:ListDomains", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "voiceid:DescribeDomain", + "voiceid:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "voiceid:DescribeDomain", + "voiceid:UpdateDomain", + "voiceid:TagResource", + "voiceid:UntagResource", + "voiceid:ListTagsForResource", + "kms:CreateGrant", + "kms:Decrypt", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId" + ], + "properties": { + "Description": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$", + "type": "string" + }, + "DomainId": { + "maxLength": 22, + "minLength": 22, + "pattern": "^[a-zA-Z0-9]{22}$", + "type": "string" + }, + "Name": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/DomainId" + ], + "required": [ + "Name", + "ServerSideEncryptionConfiguration" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "#/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VoiceID::Domain", + "writeOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/ServerSideEncryptionConfiguration" + ] +} diff --git a/schema/aws-vpclattice-accesslogsubscription.json b/schema/aws-vpclattice-accesslogsubscription.json index ac1d47a..ea565f0 100644 --- a/schema/aws-vpclattice-accesslogsubscription.json +++ b/schema/aws-vpclattice-accesslogsubscription.json @@ -1,199 +1,205 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/ResourceIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateAccessLogSubscription", - "vpc-lattice:TagResource", - "vpc-lattice:GetAccessLogSubscription", - "vpc-lattice:ListTagsForResource", - "logs:CreateLogDelivery", - "logs:CreateLogStream", - "logs:PutDestination", - "logs:PutDestinationPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "logs:GetLogDelivery", - "s3:PutBucketLogging", - "s3:GetBucketLogging", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "firehose:TagDeliveryStream", - "firehose:CreateDeliveryStream", - "firehose:DescribeDeliveryStream", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteAccessLogSubscription", - "vpc-lattice:UntagResource", - "logs:DeleteLogDelivery", - "logs:DeleteLogStream", - "logs:GetLogDelivery", - "logs:DeleteDestination", - "s3:PutBucketLogging", - "iam:GetServiceLinkedRoleDeletionStatus", - "iam:DeleteServiceLinkedRole", - "firehose:DeleteDeliveryStream", - "firehose:UntagDeliveryStream" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ResourceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [ - "ResourceIdentifier" - ] - }, - "permissions": [ - "vpc-lattice:ListAccessLogSubscriptions" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetAccessLogSubscription", - "vpc-lattice:ListTagsForResource", - "logs:GetLogDelivery" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:GetAccessLogSubscription", - "vpc-lattice:UpdateAccessLogSubscription", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "logs:UpdateLogDelivery", - "firehose:UpdateDestination", - "logs:CreateLogDelivery", - "logs:CreateLogStream", - "logs:PutDestination", - "logs:PutDestinationPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups", - "logs:GetLogDelivery", - "s3:PutBucketLogging", - "s3:GetBucketLogging", - "s3:GetBucketPolicy", - "s3:PutBucketPolicy", - "firehose:TagDeliveryStream", - "firehose:CreateDeliveryStream", - "firehose:DescribeDeliveryStream" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:accesslogsubscription/als-[0-9a-z]{17}$", - "type": "string" - }, - "DestinationArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", - "type": "string" - }, - "Id": { - "maxLength": 21, - "minLength": 21, - "pattern": "^als-[0-9a-z]{17}$", - "type": "string" - }, - "ResourceArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$", - "type": "string" - }, - "ResourceId": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((sn)|(svc))-[0-9a-z]{17}$", - "type": "string" - }, - "ResourceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/ResourceArn", - "/properties/ResourceId" - ], - "required": [ - "DestinationArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::AccessLogSubscription", - "writeOnlyProperties": [ - "/properties/ResourceIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/ResourceIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceIdentifier" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateAccessLogSubscription", + "vpc-lattice:TagResource", + "vpc-lattice:GetAccessLogSubscription", + "vpc-lattice:ListTagsForResource", + "logs:CreateLogDelivery", + "logs:CreateLogStream", + "logs:PutDestination", + "logs:PutDestinationPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "logs:GetLogDelivery", + "s3:PutBucketLogging", + "s3:GetBucketLogging", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "firehose:TagDeliveryStream", + "firehose:CreateDeliveryStream", + "firehose:DescribeDeliveryStream", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteAccessLogSubscription", + "vpc-lattice:UntagResource", + "logs:DeleteLogDelivery", + "logs:DeleteLogStream", + "logs:GetLogDelivery", + "logs:DeleteDestination", + "s3:PutBucketLogging", + "iam:GetServiceLinkedRoleDeletionStatus", + "iam:DeleteServiceLinkedRole", + "firehose:DeleteDeliveryStream", + "firehose:UntagDeliveryStream" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ResourceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [ + "ResourceIdentifier" + ] + }, + "permissions": [ + "vpc-lattice:ListAccessLogSubscriptions" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetAccessLogSubscription", + "vpc-lattice:ListTagsForResource", + "logs:GetLogDelivery" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:GetAccessLogSubscription", + "vpc-lattice:UpdateAccessLogSubscription", + "vpc-lattice:ListTagsForResource", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "logs:UpdateLogDelivery", + "firehose:UpdateDestination", + "logs:CreateLogDelivery", + "logs:CreateLogStream", + "logs:PutDestination", + "logs:PutDestinationPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups", + "logs:GetLogDelivery", + "s3:PutBucketLogging", + "s3:GetBucketLogging", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy", + "firehose:TagDeliveryStream", + "firehose:CreateDeliveryStream", + "firehose:DescribeDeliveryStream" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:accesslogsubscription/als-[0-9a-z]{17}$", + "type": "string" + }, + "DestinationArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$", + "type": "string" + }, + "Id": { + "maxLength": 21, + "minLength": 21, + "pattern": "^als-[0-9a-z]{17}$", + "type": "string" + }, + "ResourceArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$", + "type": "string" + }, + "ResourceId": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((sn)|(svc))-[0-9a-z]{17}$", + "type": "string" + }, + "ResourceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/ResourceArn", + "/properties/ResourceId" + ], + "required": [ + "DestinationArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::AccessLogSubscription", + "writeOnlyProperties": [ + "/properties/ResourceIdentifier" + ] +} diff --git a/schema/aws-vpclattice-authpolicy.json b/schema/aws-vpclattice-authpolicy.json index 9bb7a39..4310a11 100644 --- a/schema/aws-vpclattice-authpolicy.json +++ b/schema/aws-vpclattice-authpolicy.json @@ -1,64 +1,64 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceIdentifier" - ], - "description": "Creates or updates the auth policy.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:GetAuthPolicy", - "vpc-lattice:PutAuthPolicy" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:GetAuthPolicy", - "vpc-lattice:DeleteAuthPolicy" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetAuthPolicy" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:GetAuthPolicy", - "vpc-lattice:PutAuthPolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceIdentifier" - ], - "properties": { - "Policy": { - "type": "object" - }, - "ResourceIdentifier": { - "maxLength": 200, - "minLength": 21, - "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", - "type": "string" - }, - "State": { - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/State" - ], - "required": [ - "ResourceIdentifier", - "Policy" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::VpcLattice::AuthPolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceIdentifier" + ], + "description": "Creates or updates the auth policy.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:GetAuthPolicy", + "vpc-lattice:PutAuthPolicy" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:GetAuthPolicy", + "vpc-lattice:DeleteAuthPolicy" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetAuthPolicy" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:GetAuthPolicy", + "vpc-lattice:PutAuthPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceIdentifier" + ], + "properties": { + "Policy": { + "type": "object" + }, + "ResourceIdentifier": { + "maxLength": 200, + "minLength": 17, + "pattern": "^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$", + "type": "string" + }, + "State": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/State" + ], + "required": [ + "ResourceIdentifier", + "Policy" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::VpcLattice::AuthPolicy" +} diff --git a/schema/aws-vpclattice-listener.json b/schema/aws-vpclattice-listener.json index 1e1f8f7..e5f2fab 100644 --- a/schema/aws-vpclattice-listener.json +++ b/schema/aws-vpclattice-listener.json @@ -1,243 +1,248 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ServiceIdentifier", - "/properties/Name", - "/properties/Port" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceIdentifier", - "/properties/Name", - "/properties/Port", - "/properties/Protocol" - ], - "definitions": { - "DefaultAction": { - "additionalProperties": false, - "properties": { - "FixedResponse": { - "$ref": "#/definitions/FixedResponse" - }, - "Forward": { - "$ref": "#/definitions/Forward" - } - }, - "required": [], - "type": "object" - }, - "FixedResponse": { - "additionalProperties": false, - "properties": { - "StatusCode": { - "maximum": 599, - "minimum": 100, - "type": "integer" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "Forward": { - "additionalProperties": false, - "properties": { - "TargetGroups": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WeightedTargetGroup" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "TargetGroups" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WeightedTargetGroup": { - "additionalProperties": false, - "properties": { - "TargetGroupIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$", - "type": "string" - }, - "Weight": { - "maximum": 999, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "TargetGroupIdentifier" - ], - "type": "object" - } - }, - "description": "Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateListener", - "vpc-lattice:TagResource", - "vpc-lattice:GetListener", - "vpc-lattice:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteListener" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 21, - "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [ - "ServiceIdentifier" - ] - }, - "permissions": [ - "vpc-lattice:ListListeners" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetListener", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:UpdateListener", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "vpc-lattice:GetListener", - "vpc-lattice:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$", - "type": "string" - }, - "DefaultAction": { - "$ref": "#/definitions/DefaultAction" - }, - "Id": { - "maxLength": 26, - "minLength": 26, - "pattern": "^listener-[0-9a-z]{17}$", - "type": "string" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "enum": [ - "HTTP", - "HTTPS", - "TLS_PASSTHROUGH" - ], - "type": "string" - }, - "ServiceArn": { - "maxLength": 2048, - "minLength": 21, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceId": { - "maxLength": 21, - "minLength": 21, - "pattern": "^svc-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 21, - "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/DefaultAction/Forward/TargetGroups/*/TargetGroupIdentifier": "$split(TargetGroupIdentifier, \"/\")[-1]" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/ServiceArn", - "/properties/ServiceId" - ], - "required": [ - "DefaultAction", - "Protocol" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::Listener", - "writeOnlyProperties": [ - "/properties/ServiceIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ServiceIdentifier", + "/properties/Name", + "/properties/Port" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceIdentifier", + "/properties/Name", + "/properties/Port", + "/properties/Protocol" + ], + "definitions": { + "DefaultAction": { + "additionalProperties": false, + "properties": { + "FixedResponse": { + "$ref": "#/definitions/FixedResponse" + }, + "Forward": { + "$ref": "#/definitions/Forward" + } + }, + "required": [], + "type": "object" + }, + "FixedResponse": { + "additionalProperties": false, + "properties": { + "StatusCode": { + "maximum": 599, + "minimum": 100, + "type": "integer" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "Forward": { + "additionalProperties": false, + "properties": { + "TargetGroups": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WeightedTargetGroup" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "TargetGroups" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WeightedTargetGroup": { + "additionalProperties": false, + "properties": { + "TargetGroupIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$", + "type": "string" + }, + "Weight": { + "maximum": 999, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "TargetGroupIdentifier" + ], + "type": "object" + } + }, + "description": "Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateListener", + "vpc-lattice:TagResource", + "vpc-lattice:GetListener", + "vpc-lattice:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteListener" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 21, + "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [ + "ServiceIdentifier" + ] + }, + "permissions": [ + "vpc-lattice:ListListeners" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetListener", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:UpdateListener", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:GetListener", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$", + "type": "string" + }, + "DefaultAction": { + "$ref": "#/definitions/DefaultAction" + }, + "Id": { + "maxLength": 26, + "minLength": 26, + "pattern": "^listener-[0-9a-z]{17}$", + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "enum": [ + "HTTP", + "HTTPS", + "TLS_PASSTHROUGH" + ], + "type": "string" + }, + "ServiceArn": { + "maxLength": 2048, + "minLength": 21, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceId": { + "maxLength": 21, + "minLength": 21, + "pattern": "^svc-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 21, + "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/DefaultAction/Forward/TargetGroups/*/TargetGroupIdentifier": "$split(TargetGroupIdentifier, \"/\")[-1]" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/ServiceArn", + "/properties/ServiceId" + ], + "required": [ + "DefaultAction", + "Protocol" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::Listener", + "writeOnlyProperties": [ + "/properties/ServiceIdentifier" + ] +} diff --git a/schema/aws-vpclattice-resourcepolicy.json b/schema/aws-vpclattice-resourcepolicy.json index b55cbac..e695f44 100644 --- a/schema/aws-vpclattice-resourcepolicy.json +++ b/schema/aws-vpclattice-resourcepolicy.json @@ -1,54 +1,54 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn" - ], - "description": "Retrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:GetResourcePolicy", - "vpc-lattice:PutResourcePolicy" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:GetResourcePolicy", - "vpc-lattice:DeleteResourcePolicy" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetResourcePolicy" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:GetResourcePolicy", - "vpc-lattice:PutResourcePolicy" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceArn" - ], - "properties": { - "Policy": { - "type": "object" - }, - "ResourceArn": { - "maxLength": 200, - "minLength": 20, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$", - "type": "string" - } - }, - "required": [ - "ResourceArn", - "Policy" - ], - "tagging": { - "taggable": false - }, - "typeName": "AWS::VpcLattice::ResourcePolicy" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn" + ], + "description": "Retrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:GetResourcePolicy", + "vpc-lattice:PutResourcePolicy" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:GetResourcePolicy", + "vpc-lattice:DeleteResourcePolicy" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetResourcePolicy" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:GetResourcePolicy", + "vpc-lattice:PutResourcePolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceArn" + ], + "properties": { + "Policy": { + "type": "object" + }, + "ResourceArn": { + "maxLength": 200, + "minLength": 20, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$", + "type": "string" + } + }, + "required": [ + "ResourceArn", + "Policy" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::VpcLattice::ResourcePolicy" +} diff --git a/schema/aws-vpclattice-rule.json b/schema/aws-vpclattice-rule.json index c415bd0..cca1622 100644 --- a/schema/aws-vpclattice-rule.json +++ b/schema/aws-vpclattice-rule.json @@ -1,358 +1,365 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/ServiceIdentifier", - "/properties/ListenerIdentifier", - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ListenerIdentifier", - "/properties/ServiceIdentifier", - "/properties/Name" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "FixedResponse": { - "$ref": "#/definitions/FixedResponse" - }, - "Forward": { - "$ref": "#/definitions/Forward" - } - }, - "required": [], - "title": "Forward", - "type": "object" - }, - "FixedResponse": { - "additionalProperties": false, - "properties": { - "StatusCode": { - "maximum": 599, - "minimum": 100, - "type": "integer" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "Forward": { - "additionalProperties": false, - "properties": { - "TargetGroups": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/WeightedTargetGroup" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "TargetGroups" - ], - "type": "object" - }, - "HeaderMatch": { - "additionalProperties": false, - "properties": { - "CaseSensitive": { - "default": false, - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/HeaderMatchType" - }, - "Name": { - "maxLength": 40, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Match", - "Name" - ], - "type": "object" - }, - "HeaderMatchType": { - "additionalProperties": false, - "properties": { - "Contains": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Exact": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "HttpMatch": { - "additionalProperties": false, - "properties": { - "HeaderMatches": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/HeaderMatch" - }, - "maxItems": 5, - "type": "array" - }, - "Method": { - "enum": [ - "CONNECT", - "DELETE", - "GET", - "HEAD", - "OPTIONS", - "POST", - "PUT", - "TRACE" - ], - "type": "string" - }, - "PathMatch": { - "$ref": "#/definitions/PathMatch" - } - }, - "type": "object" - }, - "Match": { - "additionalProperties": false, - "properties": { - "HttpMatch": { - "$ref": "#/definitions/HttpMatch" - } - }, - "required": [ - "HttpMatch" - ], - "title": "HttpMatch", - "type": "object" - }, - "PathMatch": { - "additionalProperties": false, - "properties": { - "CaseSensitive": { - "default": false, - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/PathMatchType" - } - }, - "required": [ - "Match" - ], - "type": "object" - }, - "PathMatchType": { - "additionalProperties": false, - "properties": { - "Exact": { - "maxLength": 128, - "minLength": 1, - "pattern": "^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$", - "type": "string" - }, - "Prefix": { - "maxLength": 128, - "minLength": 1, - "pattern": "^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "WeightedTargetGroup": { - "additionalProperties": false, - "properties": { - "TargetGroupIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$", - "type": "string" - }, - "Weight": { - "maximum": 999, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "TargetGroupIdentifier" - ], - "type": "object" - } - }, - "description": "Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateRule", - "vpc-lattice:GetRule", - "vpc-lattice:ListTagsForResource", - "vpc-lattice:TagResource" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteRule" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ListenerIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$", - "type": "string" - }, - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [ - "ServiceIdentifier", - "ListenerIdentifier" - ] - }, - "permissions": [ - "vpc-lattice:ListRules" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetRule", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:UpdateRule", - "vpc-lattice:GetRule", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Action": { - "$ref": "#/definitions/Action" - }, - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/((rule-[0-9a-z]{17})|(default))$", - "type": "string" - }, - "Id": { - "maxLength": 22, - "minLength": 7, - "pattern": "^((rule-[0-9a-z]{17})|(default))$", - "type": "string" - }, - "ListenerIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$", - "type": "string" - }, - "Match": { - "$ref": "#/definitions/Match" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Priority": { - "maximum": 100, - "minimum": 1, - "type": "integer" - }, - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "propertyTransform": { - "/properties/Action/Forward/TargetGroups/*/TargetGroupIdentifier": "$split(TargetGroupIdentifier, \"/\")[-1]" - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Action", - "Match", - "Priority" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::Rule", - "writeOnlyProperties": [ - "/properties/ListenerIdentifier", - "/properties/ServiceIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/ServiceIdentifier", + "/properties/ListenerIdentifier", + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ListenerIdentifier", + "/properties/ServiceIdentifier", + "/properties/Name" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "FixedResponse": { + "$ref": "#/definitions/FixedResponse" + }, + "Forward": { + "$ref": "#/definitions/Forward" + } + }, + "required": [], + "title": "Forward", + "type": "object" + }, + "FixedResponse": { + "additionalProperties": false, + "properties": { + "StatusCode": { + "maximum": 599, + "minimum": 100, + "type": "integer" + } + }, + "required": [ + "StatusCode" + ], + "type": "object" + }, + "Forward": { + "additionalProperties": false, + "properties": { + "TargetGroups": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/WeightedTargetGroup" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "TargetGroups" + ], + "type": "object" + }, + "HeaderMatch": { + "additionalProperties": false, + "properties": { + "CaseSensitive": { + "default": false, + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/HeaderMatchType" + }, + "Name": { + "maxLength": 40, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Match", + "Name" + ], + "type": "object" + }, + "HeaderMatchType": { + "additionalProperties": false, + "properties": { + "Contains": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Exact": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "HttpMatch": { + "additionalProperties": false, + "properties": { + "HeaderMatches": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/HeaderMatch" + }, + "maxItems": 5, + "type": "array" + }, + "Method": { + "enum": [ + "CONNECT", + "DELETE", + "GET", + "HEAD", + "OPTIONS", + "POST", + "PUT", + "TRACE" + ], + "type": "string" + }, + "PathMatch": { + "$ref": "#/definitions/PathMatch" + } + }, + "type": "object" + }, + "Match": { + "additionalProperties": false, + "properties": { + "HttpMatch": { + "$ref": "#/definitions/HttpMatch" + } + }, + "required": [ + "HttpMatch" + ], + "title": "HttpMatch", + "type": "object" + }, + "PathMatch": { + "additionalProperties": false, + "properties": { + "CaseSensitive": { + "default": false, + "type": "boolean" + }, + "Match": { + "$ref": "#/definitions/PathMatchType" + } + }, + "required": [ + "Match" + ], + "type": "object" + }, + "PathMatchType": { + "additionalProperties": false, + "properties": { + "Exact": { + "maxLength": 128, + "minLength": 1, + "pattern": "^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$", + "type": "string" + }, + "Prefix": { + "maxLength": 128, + "minLength": 1, + "pattern": "^\\/[a-zA-Z0-9@:%_+.~#?&\\/=-]*$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WeightedTargetGroup": { + "additionalProperties": false, + "properties": { + "TargetGroupIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((tg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}))$", + "type": "string" + }, + "Weight": { + "maximum": 999, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "TargetGroupIdentifier" + ], + "type": "object" + } + }, + "description": "Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateRule", + "vpc-lattice:GetRule", + "vpc-lattice:ListTagsForResource", + "vpc-lattice:TagResource" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteRule", + "vpc-lattice:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ListenerIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$", + "type": "string" + }, + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [ + "ServiceIdentifier", + "ListenerIdentifier" + ] + }, + "permissions": [ + "vpc-lattice:ListRules" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetRule", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:UpdateRule", + "vpc-lattice:GetRule", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Action": { + "$ref": "#/definitions/Action" + }, + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/((rule-[0-9a-z]{17})|(default))$", + "type": "string" + }, + "Id": { + "maxLength": 22, + "minLength": 7, + "pattern": "^((rule-[0-9a-z]{17})|(default))$", + "type": "string" + }, + "ListenerIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$", + "type": "string" + }, + "Match": { + "$ref": "#/definitions/Match" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Priority": { + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "propertyTransform": { + "/properties/Action/Forward/TargetGroups/*/TargetGroupIdentifier": "$split(TargetGroupIdentifier, \"/\")[-1]" + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Action", + "Match", + "Priority" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::Rule", + "writeOnlyProperties": [ + "/properties/ListenerIdentifier", + "/properties/ServiceIdentifier" + ] +} diff --git a/schema/aws-vpclattice-service.json b/schema/aws-vpclattice-service.json index 2212ef8..5f8c47b 100644 --- a/schema/aws-vpclattice-service.json +++ b/schema/aws-vpclattice-service.json @@ -1,176 +1,182 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/CustomDomainName" - ], - "definitions": { - "DnsEntry": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateService", - "vpc-lattice:GetService", - "vpc-lattice:ListTagsForResource", - "vpc-lattice:TagResource", - "acm:DescribeCertificate", - "acm:ListCertificates", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteService", - "vpc-lattice:GetService" - ] - }, - "list": { - "permissions": [ - "vpc-lattice:ListServices" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetService", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:UpdateService", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "vpc-lattice:GetService", - "vpc-lattice:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", - "type": "string" - }, - "AuthType": { - "default": "NONE", - "enum": [ - "NONE", - "AWS_IAM" - ], - "type": "string" - }, - "CertificateArn": { - "maxLength": 2048, - "pattern": "^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$", - "type": "string" - }, - "CreatedAt": { - "type": "string" - }, - "CustomDomainName": { - "maxLength": 255, - "minLength": 3, - "type": "string" - }, - "DnsEntry": { - "$ref": "#/definitions/DnsEntry" - }, - "Id": { - "maxLength": 21, - "minLength": 21, - "pattern": "^svc-[0-9a-z]{17}$", - "type": "string" - }, - "LastUpdatedAt": { - "type": "string" - }, - "Name": { - "maxLength": 40, - "minLength": 3, - "pattern": "^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Status": { - "enum": [ - "ACTIVE", - "CREATE_IN_PROGRESS", - "DELETE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_FAILED" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/DnsEntry/DomainName", - "/properties/DnsEntry/HostedZoneId", - "/properties/Id", - "/properties/LastUpdatedAt", - "/properties/Status" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::Service" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/CustomDomainName" + ], + "definitions": { + "DnsEntry": { + "additionalProperties": false, + "properties": { + "DomainName": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateService", + "vpc-lattice:GetService", + "vpc-lattice:ListTagsForResource", + "vpc-lattice:TagResource", + "acm:DescribeCertificate", + "acm:ListCertificates", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteService", + "vpc-lattice:GetService", + "vpc-lattice:UntagResource" + ] + }, + "list": { + "permissions": [ + "vpc-lattice:ListServices" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetService", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:UpdateService", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:GetService", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", + "type": "string" + }, + "AuthType": { + "default": "NONE", + "enum": [ + "NONE", + "AWS_IAM" + ], + "type": "string" + }, + "CertificateArn": { + "maxLength": 2048, + "pattern": "^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$", + "type": "string" + }, + "CreatedAt": { + "type": "string" + }, + "CustomDomainName": { + "maxLength": 255, + "minLength": 3, + "type": "string" + }, + "DnsEntry": { + "$ref": "#/definitions/DnsEntry" + }, + "Id": { + "maxLength": 21, + "minLength": 21, + "pattern": "^svc-[0-9a-z]{17}$", + "type": "string" + }, + "LastUpdatedAt": { + "type": "string" + }, + "Name": { + "maxLength": 40, + "minLength": 3, + "pattern": "^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Status": { + "enum": [ + "ACTIVE", + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "CREATE_FAILED", + "DELETE_FAILED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/DnsEntry/DomainName", + "/properties/DnsEntry/HostedZoneId", + "/properties/Id", + "/properties/LastUpdatedAt", + "/properties/Status" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::Service" +} diff --git a/schema/aws-vpclattice-servicenetwork.json b/schema/aws-vpclattice-servicenetwork.json index c75c39a..ed412c3 100644 --- a/schema/aws-vpclattice-servicenetwork.json +++ b/schema/aws-vpclattice-servicenetwork.json @@ -1,133 +1,140 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:GetServiceNetwork", - "vpc-lattice:ListTagsForResource", - "vpc-lattice:CreateServiceNetwork", - "vpc-lattice:TagResource", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteServiceNetwork" - ] - }, - "list": { - "permissions": [ - "vpc-lattice:ListServiceNetworks" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetServiceNetwork", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:GetServiceNetwork", - "vpc-lattice:UpdateServiceNetwork", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", - "type": "string" - }, - "AuthType": { - "default": "NONE", - "enum": [ - "NONE", - "AWS_IAM" - ], - "type": "string" - }, - "CreatedAt": { - "type": "string" - }, - "Id": { - "maxLength": 20, - "minLength": 20, - "pattern": "^sn-[0-9a-z]{17}$", - "type": "string" - }, - "LastUpdatedAt": { - "type": "string" - }, - "Name": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/LastUpdatedAt" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::ServiceNetwork" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:GetServiceNetwork", + "vpc-lattice:ListTagsForResource", + "vpc-lattice:CreateServiceNetwork", + "vpc-lattice:TagResource", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteServiceNetwork", + "vpc-lattice:UntagResource" + ] + }, + "list": { + "permissions": [ + "vpc-lattice:ListServiceNetworks" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetServiceNetwork", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:GetServiceNetwork", + "vpc-lattice:UpdateServiceNetwork", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", + "type": "string" + }, + "AuthType": { + "default": "NONE", + "enum": [ + "NONE", + "AWS_IAM" + ], + "type": "string" + }, + "CreatedAt": { + "type": "string" + }, + "Id": { + "maxLength": 20, + "minLength": 20, + "pattern": "^sn-[0-9a-z]{17}$", + "type": "string" + }, + "LastUpdatedAt": { + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/LastUpdatedAt" + ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::ServiceNetwork" +} diff --git a/schema/aws-vpclattice-servicenetworkserviceassociation.json b/schema/aws-vpclattice-servicenetworkserviceassociation.json index 87a3971..2dc80bc 100644 --- a/schema/aws-vpclattice-servicenetworkserviceassociation.json +++ b/schema/aws-vpclattice-servicenetworkserviceassociation.json @@ -1,220 +1,226 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/ServiceNetworkIdentifier", - "/properties/ServiceIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceNetworkIdentifier", - "/properties/ServiceIdentifier" - ], - "definitions": { - "DnsEntry": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Associates a service with a service network.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateServiceNetworkServiceAssociation", - "vpc-lattice:GetServiceNetworkServiceAssociation", - "vpc-lattice:TagResource", - "vpc-lattice:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteServiceNetworkServiceAssociation", - "vpc-lattice:GetServiceNetworkServiceAssociation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", - "type": "string" - }, - "ServiceNetworkIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [] - }, - "permissions": [ - "vpc-lattice:ListServiceNetworkServiceAssociations" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetServiceNetworkServiceAssociation", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "vpc-lattice:GetServiceNetworkServiceAssociation", - "vpc-lattice:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$", - "type": "string" - }, - "CreatedAt": { - "type": "string" - }, - "DnsEntry": { - "$ref": "#/definitions/DnsEntry" - }, - "Id": { - "maxLength": 2048, - "minLength": 17, - "pattern": "^snsa-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceId": { - "maxLength": 21, - "minLength": 21, - "pattern": "^svc-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", - "type": "string" - }, - "ServiceName": { - "maxLength": 40, - "minLength": 3, - "pattern": "^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "ServiceNetworkArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceNetworkId": { - "maxLength": 20, - "minLength": 20, - "pattern": "^sn-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceNetworkIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", - "type": "string" - }, - "ServiceNetworkName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Status": { - "enum": [ - "CREATE_IN_PROGRESS", - "ACTIVE", - "DELETE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_FAILED" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/DnsEntry/DomainName", - "/properties/DnsEntry/HostedZoneId", - "/properties/Id", - "/properties/ServiceNetworkArn", - "/properties/ServiceNetworkId", - "/properties/ServiceNetworkName", - "/properties/ServiceArn", - "/properties/ServiceId", - "/properties/ServiceName", - "/properties/Status" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::ServiceNetworkServiceAssociation", - "writeOnlyProperties": [ - "/properties/ServiceNetworkIdentifier", - "/properties/ServiceIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/ServiceNetworkIdentifier", + "/properties/ServiceIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceNetworkIdentifier", + "/properties/ServiceIdentifier" + ], + "definitions": { + "DnsEntry": { + "additionalProperties": false, + "properties": { + "DomainName": { + "type": "string" + }, + "HostedZoneId": { + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Associates a service with a service network.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateServiceNetworkServiceAssociation", + "vpc-lattice:GetServiceNetworkServiceAssociation", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteServiceNetworkServiceAssociation", + "vpc-lattice:GetServiceNetworkServiceAssociation", + "vpc-lattice:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", + "type": "string" + }, + "ServiceNetworkIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [] + }, + "permissions": [ + "vpc-lattice:ListServiceNetworkServiceAssociations" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetServiceNetworkServiceAssociation", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:GetServiceNetworkServiceAssociation", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$", + "type": "string" + }, + "CreatedAt": { + "type": "string" + }, + "DnsEntry": { + "$ref": "#/definitions/DnsEntry" + }, + "Id": { + "maxLength": 2048, + "minLength": 17, + "pattern": "^snsa-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceId": { + "maxLength": 21, + "minLength": 21, + "pattern": "^svc-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((svc-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:service/svc-[0-9a-z]{17}))$", + "type": "string" + }, + "ServiceName": { + "maxLength": 40, + "minLength": 3, + "pattern": "^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "ServiceNetworkArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceNetworkId": { + "maxLength": 20, + "minLength": 20, + "pattern": "^sn-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceNetworkIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", + "type": "string" + }, + "ServiceNetworkName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Status": { + "enum": [ + "CREATE_IN_PROGRESS", + "ACTIVE", + "DELETE_IN_PROGRESS", + "CREATE_FAILED", + "DELETE_FAILED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/DnsEntry/DomainName", + "/properties/DnsEntry/HostedZoneId", + "/properties/Id", + "/properties/ServiceNetworkArn", + "/properties/ServiceNetworkId", + "/properties/ServiceNetworkName", + "/properties/ServiceArn", + "/properties/ServiceId", + "/properties/ServiceName", + "/properties/Status" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::ServiceNetworkServiceAssociation", + "writeOnlyProperties": [ + "/properties/ServiceNetworkIdentifier", + "/properties/ServiceIdentifier" + ] +} diff --git a/schema/aws-vpclattice-servicenetworkvpcassociation.json b/schema/aws-vpclattice-servicenetworkvpcassociation.json index fa536de..ba47b17 100644 --- a/schema/aws-vpclattice-servicenetworkvpcassociation.json +++ b/schema/aws-vpclattice-servicenetworkvpcassociation.json @@ -1,206 +1,212 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/ServiceNetworkIdentifier", - "/properties/VpcIdentifier" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ServiceNetworkIdentifier", - "/properties/VpcIdentifier" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Associates a VPC with a service network.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateServiceNetworkVpcAssociation", - "vpc-lattice:GetServiceNetworkVpcAssociation", - "vpc-lattice:ListServiceNetworkVpcAssociations", - "vpc-lattice:ListTagsForResource", - "ec2:DescribeSecurityGroups", - "ec2:DescribeVpcs", - "vpc-lattice:TagResource" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteServiceNetworkVpcAssociation", - "vpc-lattice:GetServiceNetworkVpcAssociation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "ServiceNetworkIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", - "type": "string" - }, - "VpcIdentifier": { - "maxLength": 2048, - "minLength": 5, - "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [] - }, - "permissions": [ - "vpc-lattice:ListServiceNetworkVpcAssociations" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetServiceNetworkVpcAssociation", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "vpc-lattice:GetServiceNetworkVpcAssociation", - "vpc-lattice:UpdateServiceNetworkVpcAssociation", - "ec2:DescribeSecurityGroups", - "vpc-lattice:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$", - "type": "string" - }, - "CreatedAt": { - "type": "string" - }, - "Id": { - "maxLength": 22, - "minLength": 22, - "pattern": "^snva-[0-9a-z]{17}$", - "type": "string" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 200, - "minLength": 0, - "pattern": "^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "ServiceNetworkArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceNetworkId": { - "maxLength": 20, - "minLength": 20, - "pattern": "^sn-[0-9a-z]{17}$", - "type": "string" - }, - "ServiceNetworkIdentifier": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", - "type": "string" - }, - "ServiceNetworkName": { - "maxLength": 63, - "minLength": 3, - "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Status": { - "enum": [ - "CREATE_IN_PROGRESS", - "ACTIVE", - "UPDATE_IN_PROGRESS", - "DELETE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_FAILED" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "VpcId": { - "maxLength": 2048, - "minLength": 5, - "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", - "type": "string" - }, - "VpcIdentifier": { - "maxLength": 2048, - "minLength": 5, - "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/ServiceNetworkArn", - "/properties/ServiceNetworkId", - "/properties/ServiceNetworkName", - "/properties/Status", - "/properties/VpcId" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::ServiceNetworkVpcAssociation", - "writeOnlyProperties": [ - "/properties/ServiceNetworkIdentifier", - "/properties/VpcIdentifier" - ] -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/ServiceNetworkIdentifier", + "/properties/VpcIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ServiceNetworkIdentifier", + "/properties/VpcIdentifier" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Associates a VPC with a service network.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateServiceNetworkVpcAssociation", + "vpc-lattice:GetServiceNetworkVpcAssociation", + "vpc-lattice:ListServiceNetworkVpcAssociations", + "vpc-lattice:ListTagsForResource", + "ec2:DescribeSecurityGroups", + "ec2:DescribeVpcs", + "vpc-lattice:TagResource" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteServiceNetworkVpcAssociation", + "vpc-lattice:GetServiceNetworkVpcAssociation", + "vpc-lattice:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ServiceNetworkIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", + "type": "string" + }, + "VpcIdentifier": { + "maxLength": 2048, + "minLength": 5, + "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [] + }, + "permissions": [ + "vpc-lattice:ListServiceNetworkVpcAssociations" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetServiceNetworkVpcAssociation", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:GetServiceNetworkVpcAssociation", + "vpc-lattice:UpdateServiceNetworkVpcAssociation", + "ec2:DescribeSecurityGroups", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$", + "type": "string" + }, + "CreatedAt": { + "type": "string" + }, + "Id": { + "maxLength": 22, + "minLength": 22, + "pattern": "^snva-[0-9a-z]{17}$", + "type": "string" + }, + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 0, + "pattern": "^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ServiceNetworkArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceNetworkId": { + "maxLength": 20, + "minLength": 20, + "pattern": "^sn-[0-9a-z]{17}$", + "type": "string" + }, + "ServiceNetworkIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^((sn-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetwork/sn-[0-9a-z]{17}))$", + "type": "string" + }, + "ServiceNetworkName": { + "maxLength": 63, + "minLength": 3, + "pattern": "^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Status": { + "enum": [ + "CREATE_IN_PROGRESS", + "ACTIVE", + "UPDATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "CREATE_FAILED", + "DELETE_FAILED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "maxLength": 2048, + "minLength": 5, + "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", + "type": "string" + }, + "VpcIdentifier": { + "maxLength": 2048, + "minLength": 5, + "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/ServiceNetworkArn", + "/properties/ServiceNetworkId", + "/properties/ServiceNetworkName", + "/properties/Status", + "/properties/VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::ServiceNetworkVpcAssociation", + "writeOnlyProperties": [ + "/properties/ServiceNetworkIdentifier", + "/properties/VpcIdentifier" + ] +} diff --git a/schema/aws-vpclattice-targetgroup.json b/schema/aws-vpclattice-targetgroup.json index 915f43f..9952005 100644 --- a/schema/aws-vpclattice-targetgroup.json +++ b/schema/aws-vpclattice-targetgroup.json @@ -1,337 +1,342 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/Id" - ], - [ - "/properties/Name" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Type", - "/properties/Config/Port", - "/properties/Config/IpAddressType", - "/properties/Config/Protocol", - "/properties/Config/ProtocolVersion", - "/properties/Config/VpcIdentifier", - "/properties/Config/LambdaEventStructureVersion" - ], - "definitions": { - "HealthCheckConfig": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "HealthCheckIntervalSeconds": { - "maximum": 300, - "minimum": 5, - "type": "integer" - }, - "HealthCheckTimeoutSeconds": { - "maximum": 120, - "minimum": 1, - "type": "integer" - }, - "HealthyThresholdCount": { - "maximum": 10, - "minimum": 2, - "type": "integer" - }, - "Matcher": { - "$ref": "#/definitions/Matcher" - }, - "Path": { - "maxLength": 2048, - "minLength": 0, - "pattern": "(^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))", - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "enum": [ - "HTTP", - "HTTPS" - ], - "type": "string" - }, - "ProtocolVersion": { - "enum": [ - "HTTP1", - "HTTP2" - ], - "type": "string" - }, - "UnhealthyThresholdCount": { - "maximum": 10, - "minimum": 2, - "type": "integer" - } - }, - "type": "object" - }, - "Matcher": { - "additionalProperties": false, - "properties": { - "HttpCode": { - "maxLength": 2000, - "minLength": 3, - "pattern": "^[0-9-,]+$", - "type": "string" - } - }, - "required": [ - "HttpCode" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Target": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "TargetGroupConfig": { - "additionalProperties": false, - "properties": { - "HealthCheck": { - "$ref": "#/definitions/HealthCheckConfig" - }, - "IpAddressType": { - "default": "IPV4", - "enum": [ - "IPV4", - "IPV6" - ], - "type": "string" - }, - "LambdaEventStructureVersion": { - "enum": [ - "V1", - "V2" - ], - "type": "string" - }, - "Port": { - "maximum": 65535, - "minimum": 1, - "type": "integer" - }, - "Protocol": { - "enum": [ - "HTTP", - "HTTPS", - "TCP" - ], - "type": "string" - }, - "ProtocolVersion": { - "default": "HTTP1", - "enum": [ - "HTTP1", - "HTTP2", - "GRPC" - ], - "type": "string" - }, - "VpcIdentifier": { - "maxLength": 2048, - "minLength": 5, - "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", - "type": "string" - } - }, - "required": [], - "type": "object" - } - }, - "description": "A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.", - "handlers": { - "create": { - "permissions": [ - "vpc-lattice:CreateTargetGroup", - "vpc-lattice:GetTargetGroup", - "vpc-lattice:RegisterTargets", - "vpc-lattice:ListTargets", - "vpc-lattice:ListTagsForResource", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "ec2:DescribeVpcs", - "ec2:DescribeInstances", - "ec2:DescribeSubnets", - "ec2:DescribeAvailabilityZoneMappings", - "lambda:Invoke", - "lambda:AddPermission", - "elasticloadbalancing:DescribeLoadBalancers", - "iam:CreateServiceLinkedRole" - ] - }, - "delete": { - "permissions": [ - "vpc-lattice:DeleteTargetGroup", - "vpc-lattice:GetTargetGroup", - "vpc-lattice:DeregisterTargets", - "vpc-lattice:ListTargets", - "lambda:RemovePermission" - ] - }, - "list": { - "permissions": [ - "vpc-lattice:ListTargetGroups" - ] - }, - "read": { - "permissions": [ - "vpc-lattice:GetTargetGroup", - "vpc-lattice:ListTargets", - "vpc-lattice:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "vpc-lattice:UpdateTargetGroup", - "vpc-lattice:GetTargetGroup", - "vpc-lattice:ListTargets", - "vpc-lattice:RegisterTargets", - "vpc-lattice:DeregisterTargets", - "ec2:DescribeVpcs", - "ec2:DescribeInstances", - "ec2:DescribeSubnets", - "ec2:DescribeAvailabilityZoneMappings", - "elasticloadbalancing:DescribeLoadBalancers", - "lambda:Invoke", - "lambda:RemovePermission", - "lambda:AddPermission", - "vpc-lattice:TagResource", - "vpc-lattice:UntagResource", - "vpc-lattice:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Arn" - ], - "properties": { - "Arn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}$", - "type": "string" - }, - "Config": { - "$ref": "#/definitions/TargetGroupConfig" - }, - "CreatedAt": { - "type": "string" - }, - "Id": { - "maxLength": 20, - "minLength": 20, - "pattern": "^tg-[0-9a-z]{17}$", - "type": "string" - }, - "LastUpdatedAt": { - "type": "string" - }, - "Name": { - "maxLength": 128, - "minLength": 3, - "pattern": "^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", - "type": "string" - }, - "Status": { - "enum": [ - "CREATE_IN_PROGRESS", - "ACTIVE", - "DELETE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_FAILED" - ], - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "Targets": { - "default": [], - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Target" - }, - "maxItems": 100, - "minItems": 0, - "type": "array" - }, - "Type": { - "enum": [ - "IP", - "LAMBDA", - "INSTANCE", - "ALB" - ], - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/CreatedAt", - "/properties/Id", - "/properties/LastUpdatedAt", - "/properties/Status" - ], - "required": [ - "Type" - ], - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::VpcLattice::TargetGroup" -} +{ + "additionalIdentifiers": [ + [ + "/properties/Id" + ], + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Type", + "/properties/Config/Port", + "/properties/Config/IpAddressType", + "/properties/Config/Protocol", + "/properties/Config/ProtocolVersion", + "/properties/Config/VpcIdentifier", + "/properties/Config/LambdaEventStructureVersion" + ], + "definitions": { + "HealthCheckConfig": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "HealthCheckIntervalSeconds": { + "maximum": 300, + "minimum": 5, + "type": "integer" + }, + "HealthCheckTimeoutSeconds": { + "maximum": 120, + "minimum": 1, + "type": "integer" + }, + "HealthyThresholdCount": { + "maximum": 10, + "minimum": 2, + "type": "integer" + }, + "Matcher": { + "$ref": "#/definitions/Matcher" + }, + "Path": { + "maxLength": 2048, + "minLength": 0, + "pattern": "(^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))", + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "enum": [ + "HTTP", + "HTTPS" + ], + "type": "string" + }, + "ProtocolVersion": { + "enum": [ + "HTTP1", + "HTTP2" + ], + "type": "string" + }, + "UnhealthyThresholdCount": { + "maximum": 10, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "Matcher": { + "additionalProperties": false, + "properties": { + "HttpCode": { + "maxLength": 2000, + "minLength": 3, + "pattern": "^[0-9-,]+$", + "type": "string" + } + }, + "required": [ + "HttpCode" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Target": { + "additionalProperties": false, + "properties": { + "Id": { + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "TargetGroupConfig": { + "additionalProperties": false, + "properties": { + "HealthCheck": { + "$ref": "#/definitions/HealthCheckConfig" + }, + "IpAddressType": { + "default": "IPV4", + "enum": [ + "IPV4", + "IPV6" + ], + "type": "string" + }, + "LambdaEventStructureVersion": { + "enum": [ + "V1", + "V2" + ], + "type": "string" + }, + "Port": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "enum": [ + "HTTP", + "HTTPS", + "TCP" + ], + "type": "string" + }, + "ProtocolVersion": { + "default": "HTTP1", + "enum": [ + "HTTP1", + "HTTP2", + "GRPC" + ], + "type": "string" + }, + "VpcIdentifier": { + "maxLength": 2048, + "minLength": 5, + "pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$", + "type": "string" + } + }, + "required": [], + "type": "object" + } + }, + "description": "A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.", + "handlers": { + "create": { + "permissions": [ + "vpc-lattice:CreateTargetGroup", + "vpc-lattice:GetTargetGroup", + "vpc-lattice:RegisterTargets", + "vpc-lattice:ListTargets", + "vpc-lattice:ListTagsForResource", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "ec2:DescribeVpcs", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeAvailabilityZoneMappings", + "lambda:Invoke", + "lambda:AddPermission", + "elasticloadbalancing:DescribeLoadBalancers", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "vpc-lattice:DeleteTargetGroup", + "vpc-lattice:GetTargetGroup", + "vpc-lattice:DeregisterTargets", + "vpc-lattice:ListTargets", + "lambda:RemovePermission" + ] + }, + "list": { + "permissions": [ + "vpc-lattice:ListTargetGroups" + ] + }, + "read": { + "permissions": [ + "vpc-lattice:GetTargetGroup", + "vpc-lattice:ListTargets", + "vpc-lattice:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "vpc-lattice:UpdateTargetGroup", + "vpc-lattice:GetTargetGroup", + "vpc-lattice:ListTargets", + "vpc-lattice:RegisterTargets", + "vpc-lattice:DeregisterTargets", + "ec2:DescribeVpcs", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeAvailabilityZoneMappings", + "elasticloadbalancing:DescribeLoadBalancers", + "lambda:Invoke", + "lambda:RemovePermission", + "lambda:AddPermission", + "vpc-lattice:TagResource", + "vpc-lattice:UntagResource", + "vpc-lattice:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:targetgroup/tg-[0-9a-z]{17}$", + "type": "string" + }, + "Config": { + "$ref": "#/definitions/TargetGroupConfig" + }, + "CreatedAt": { + "type": "string" + }, + "Id": { + "maxLength": 20, + "minLength": 20, + "pattern": "^tg-[0-9a-z]{17}$", + "type": "string" + }, + "LastUpdatedAt": { + "type": "string" + }, + "Name": { + "maxLength": 128, + "minLength": 3, + "pattern": "^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$", + "type": "string" + }, + "Status": { + "enum": [ + "CREATE_IN_PROGRESS", + "ACTIVE", + "DELETE_IN_PROGRESS", + "CREATE_FAILED", + "DELETE_FAILED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Targets": { + "default": [], + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Target" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "Type": { + "enum": [ + "IP", + "LAMBDA", + "INSTANCE", + "ALB" + ], + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/LastUpdatedAt", + "/properties/Status" + ], + "required": [ + "Type" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "vpc-lattice:UntagResource", + "vpc-lattice:TagResource", + "vpc-lattice:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::VpcLattice::TargetGroup" +} diff --git a/schema/aws-waf-bytematchset.json b/schema/aws-waf-bytematchset.json index d17adaa..576fd12 100644 --- a/schema/aws-waf-bytematchset.json +++ b/schema/aws-waf-bytematchset.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ByteMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "TargetString": { - "type": "string" - }, - "TargetStringBase64": { - "type": "string" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "PositionalConstraint", - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - }, - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::ByteMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ByteMatchTuples": { - "items": { - "$ref": "#/definitions/ByteMatchTuple" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAF::ByteMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ByteMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "PositionalConstraint": { + "type": "string" + }, + "TargetString": { + "type": "string" + }, + "TargetStringBase64": { + "type": "string" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "PositionalConstraint", + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + }, + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::ByteMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ByteMatchTuples": { + "items": { + "$ref": "#/definitions/ByteMatchTuple" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAF::ByteMatchSet" +} diff --git a/schema/aws-waf-ipset.json b/schema/aws-waf-ipset.json index 27fe30d..2f189d9 100644 --- a/schema/aws-waf-ipset.json +++ b/schema/aws-waf-ipset.json @@ -1,50 +1,50 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "IPSetDescriptor": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::IPSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "IPSetDescriptors": { - "items": { - "$ref": "#/definitions/IPSetDescriptor" - }, - "type": "array", - "uniqueItems": true - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAF::IPSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "IPSetDescriptor": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::IPSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "IPSetDescriptors": { + "items": { + "$ref": "#/definitions/IPSetDescriptor" + }, + "type": "array", + "uniqueItems": true + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAF::IPSet" +} diff --git a/schema/aws-waf-rule.json b/schema/aws-waf-rule.json index 57846fd..343c159 100644 --- a/schema/aws-waf-rule.json +++ b/schema/aws-waf-rule.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/Name" - ], - "definitions": { - "Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Negated", - "Type", - "DataId" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::Rule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Predicates": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "MetricName", - "Name" - ], - "typeName": "AWS::WAF::Rule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/Name" + ], + "definitions": { + "Predicate": { + "additionalProperties": false, + "properties": { + "DataId": { + "type": "string" + }, + "Negated": { + "type": "boolean" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Negated", + "Type", + "DataId" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::Rule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "MetricName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Predicates": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "MetricName", + "Name" + ], + "typeName": "AWS::WAF::Rule" +} diff --git a/schema/aws-waf-sizeconstraintset.json b/schema/aws-waf-sizeconstraintset.json index 5618ded..5c4dc0a 100644 --- a/schema/aws-waf-sizeconstraintset.json +++ b/schema/aws-waf-sizeconstraintset.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SizeConstraint": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "Size": { - "type": "integer" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "TextTransformation", - "FieldToMatch", - "Size" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::SizeConstraintSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SizeConstraints": { - "items": { - "$ref": "#/definitions/SizeConstraint" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "SizeConstraints", - "Name" - ], - "typeName": "AWS::WAF::SizeConstraintSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SizeConstraint": { + "additionalProperties": false, + "properties": { + "ComparisonOperator": { + "type": "string" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "Size": { + "type": "integer" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "ComparisonOperator", + "TextTransformation", + "FieldToMatch", + "Size" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::SizeConstraintSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SizeConstraints": { + "items": { + "$ref": "#/definitions/SizeConstraint" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "SizeConstraints", + "Name" + ], + "typeName": "AWS::WAF::SizeConstraintSet" +} diff --git a/schema/aws-waf-sqlinjectionmatchset.json b/schema/aws-waf-sqlinjectionmatchset.json index 16720d9..cc8793e 100644 --- a/schema/aws-waf-sqlinjectionmatchset.json +++ b/schema/aws-waf-sqlinjectionmatchset.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SqlInjectionMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::SqlInjectionMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlInjectionMatchTuples": { - "items": { - "$ref": "#/definitions/SqlInjectionMatchTuple" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAF::SqlInjectionMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SqlInjectionMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::SqlInjectionMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SqlInjectionMatchTuples": { + "items": { + "$ref": "#/definitions/SqlInjectionMatchTuple" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAF::SqlInjectionMatchSet" +} diff --git a/schema/aws-waf-webacl.json b/schema/aws-waf-webacl.json index b53d618..e80c10c 100644 --- a/schema/aws-waf-webacl.json +++ b/schema/aws-waf-webacl.json @@ -1,74 +1,74 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/Name" - ], - "definitions": { - "ActivatedRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/WafAction" - }, - "Priority": { - "type": "integer" - }, - "RuleId": { - "type": "string" - } - }, - "required": [ - "Priority", - "RuleId" - ], - "type": "object" - }, - "WafAction": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::WebACL", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DefaultAction": { - "$ref": "#/definitions/WafAction" - }, - "Id": { - "type": "string" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/ActivatedRule" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DefaultAction", - "MetricName", - "Name" - ], - "typeName": "AWS::WAF::WebACL" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/Name" + ], + "definitions": { + "ActivatedRule": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/WafAction" + }, + "Priority": { + "type": "integer" + }, + "RuleId": { + "type": "string" + } + }, + "required": [ + "Priority", + "RuleId" + ], + "type": "object" + }, + "WafAction": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::WebACL", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DefaultAction": { + "$ref": "#/definitions/WafAction" + }, + "Id": { + "type": "string" + }, + "MetricName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Rules": { + "items": { + "$ref": "#/definitions/ActivatedRule" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DefaultAction", + "MetricName", + "Name" + ], + "typeName": "AWS::WAF::WebACL" +} diff --git a/schema/aws-waf-xssmatchset.json b/schema/aws-waf-xssmatchset.json index b89eea6..cdcb4dc 100644 --- a/schema/aws-waf-xssmatchset.json +++ b/schema/aws-waf-xssmatchset.json @@ -1,66 +1,66 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "XssMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAF::XssMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "XssMatchTuples": { - "items": { - "$ref": "#/definitions/XssMatchTuple" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "XssMatchTuples" - ], - "typeName": "AWS::WAF::XssMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "XssMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAF::XssMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "XssMatchTuples": { + "items": { + "$ref": "#/definitions/XssMatchTuple" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name", + "XssMatchTuples" + ], + "typeName": "AWS::WAF::XssMatchSet" +} diff --git a/schema/aws-wafregional-bytematchset.json b/schema/aws-wafregional-bytematchset.json index a9f1d19..ec600bc 100644 --- a/schema/aws-wafregional-bytematchset.json +++ b/schema/aws-wafregional-bytematchset.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "ByteMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "TargetString": { - "type": "string" - }, - "TargetStringBase64": { - "type": "string" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "PositionalConstraint", - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - }, - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::ByteMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ByteMatchTuples": { - "items": { - "$ref": "#/definitions/ByteMatchTuple" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::ByteMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "ByteMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "PositionalConstraint": { + "type": "string" + }, + "TargetString": { + "type": "string" + }, + "TargetStringBase64": { + "type": "string" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "PositionalConstraint", + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + }, + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::ByteMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ByteMatchTuples": { + "items": { + "$ref": "#/definitions/ByteMatchTuple" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::ByteMatchSet" +} diff --git a/schema/aws-wafregional-geomatchset.json b/schema/aws-wafregional-geomatchset.json index b87f85f..cba8cf8 100644 --- a/schema/aws-wafregional-geomatchset.json +++ b/schema/aws-wafregional-geomatchset.json @@ -1,50 +1,50 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "GeoMatchConstraint": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::GeoMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "GeoMatchConstraints": { - "items": { - "$ref": "#/definitions/GeoMatchConstraint" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::GeoMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "GeoMatchConstraint": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::GeoMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "GeoMatchConstraints": { + "items": { + "$ref": "#/definitions/GeoMatchConstraint" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::GeoMatchSet" +} diff --git a/schema/aws-wafregional-ipset.json b/schema/aws-wafregional-ipset.json index edc283b..6202d09 100644 --- a/schema/aws-wafregional-ipset.json +++ b/schema/aws-wafregional-ipset.json @@ -1,50 +1,50 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "IPSetDescriptor": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::IPSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "IPSetDescriptors": { - "items": { - "$ref": "#/definitions/IPSetDescriptor" - }, - "type": "array", - "uniqueItems": false - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::IPSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "IPSetDescriptor": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Type" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::IPSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "IPSetDescriptors": { + "items": { + "$ref": "#/definitions/IPSetDescriptor" + }, + "type": "array", + "uniqueItems": false + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::IPSet" +} diff --git a/schema/aws-wafregional-ratebasedrule.json b/schema/aws-wafregional-ratebasedrule.json index 24991f3..c88e0a4 100644 --- a/schema/aws-wafregional-ratebasedrule.json +++ b/schema/aws-wafregional-ratebasedrule.json @@ -1,68 +1,68 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/RateKey", - "/properties/Name" - ], - "definitions": { - "Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Negated", - "DataId" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::RateBasedRule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "MatchPredicates": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array", - "uniqueItems": false - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RateKey": { - "type": "string" - }, - "RateLimit": { - "type": "integer" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "MetricName", - "RateLimit", - "RateKey", - "Name" - ], - "typeName": "AWS::WAFRegional::RateBasedRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/RateKey", + "/properties/Name" + ], + "definitions": { + "Predicate": { + "additionalProperties": false, + "properties": { + "DataId": { + "type": "string" + }, + "Negated": { + "type": "boolean" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Negated", + "DataId" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::RateBasedRule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "MatchPredicates": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RateKey": { + "type": "string" + }, + "RateLimit": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "MetricName", + "RateLimit", + "RateKey", + "Name" + ], + "typeName": "AWS::WAFRegional::RateBasedRule" +} diff --git a/schema/aws-wafregional-regexpatternset.json b/schema/aws-wafregional-regexpatternset.json index cf2aa58..70f5943 100644 --- a/schema/aws-wafregional-regexpatternset.json +++ b/schema/aws-wafregional-regexpatternset.json @@ -1,33 +1,33 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "description": "Resource Type definition for AWS::WAFRegional::RegexPatternSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RegexPatternStrings": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "RegexPatternStrings", - "Name" - ], - "typeName": "AWS::WAFRegional::RegexPatternSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "description": "Resource Type definition for AWS::WAFRegional::RegexPatternSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "RegexPatternStrings": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "RegexPatternStrings", + "Name" + ], + "typeName": "AWS::WAFRegional::RegexPatternSet" +} diff --git a/schema/aws-wafregional-rule.json b/schema/aws-wafregional-rule.json index 3b21474..35df7d2 100644 --- a/schema/aws-wafregional-rule.json +++ b/schema/aws-wafregional-rule.json @@ -1,59 +1,59 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/Name" - ], - "definitions": { - "Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type", - "Negated", - "DataId" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::Rule", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Predicates": { - "items": { - "$ref": "#/definitions/Predicate" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "MetricName", - "Name" - ], - "typeName": "AWS::WAFRegional::Rule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/Name" + ], + "definitions": { + "Predicate": { + "additionalProperties": false, + "properties": { + "DataId": { + "type": "string" + }, + "Negated": { + "type": "boolean" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type", + "Negated", + "DataId" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::Rule", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "MetricName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Predicates": { + "items": { + "$ref": "#/definitions/Predicate" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "MetricName", + "Name" + ], + "typeName": "AWS::WAFRegional::Rule" +} diff --git a/schema/aws-wafregional-sizeconstraintset.json b/schema/aws-wafregional-sizeconstraintset.json index d87ebc0..b69ac74 100644 --- a/schema/aws-wafregional-sizeconstraintset.json +++ b/schema/aws-wafregional-sizeconstraintset.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SizeConstraint": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "Size": { - "type": "integer" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "TextTransformation", - "Size", - "FieldToMatch" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::SizeConstraintSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SizeConstraints": { - "items": { - "$ref": "#/definitions/SizeConstraint" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::SizeConstraintSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SizeConstraint": { + "additionalProperties": false, + "properties": { + "ComparisonOperator": { + "type": "string" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "Size": { + "type": "integer" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "ComparisonOperator", + "TextTransformation", + "Size", + "FieldToMatch" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::SizeConstraintSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SizeConstraints": { + "items": { + "$ref": "#/definitions/SizeConstraint" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::SizeConstraintSet" +} diff --git a/schema/aws-wafregional-sqlinjectionmatchset.json b/schema/aws-wafregional-sqlinjectionmatchset.json index 5eeca2e..28d91e1 100644 --- a/schema/aws-wafregional-sqlinjectionmatchset.json +++ b/schema/aws-wafregional-sqlinjectionmatchset.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "SqlInjectionMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::SqlInjectionMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlInjectionMatchTuples": { - "items": { - "$ref": "#/definitions/SqlInjectionMatchTuple" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::SqlInjectionMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "SqlInjectionMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::SqlInjectionMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "SqlInjectionMatchTuples": { + "items": { + "$ref": "#/definitions/SqlInjectionMatchTuple" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::SqlInjectionMatchSet" +} diff --git a/schema/aws-wafregional-webacl.json b/schema/aws-wafregional-webacl.json index 0dcdc41..89d7657 100644 --- a/schema/aws-wafregional-webacl.json +++ b/schema/aws-wafregional-webacl.json @@ -1,75 +1,75 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/MetricName", - "/properties/Name" - ], - "definitions": { - "Action": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Rule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/Action" - }, - "Priority": { - "type": "integer" - }, - "RuleId": { - "type": "string" - } - }, - "required": [ - "Action", - "Priority", - "RuleId" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::WebACL", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "DefaultAction": { - "$ref": "#/definitions/Action" - }, - "Id": { - "type": "string" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "DefaultAction", - "MetricName", - "Name" - ], - "typeName": "AWS::WAFRegional::WebACL" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MetricName", + "/properties/Name" + ], + "definitions": { + "Action": { + "additionalProperties": false, + "properties": { + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Rule": { + "additionalProperties": false, + "properties": { + "Action": { + "$ref": "#/definitions/Action" + }, + "Priority": { + "type": "integer" + }, + "RuleId": { + "type": "string" + } + }, + "required": [ + "Action", + "Priority", + "RuleId" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::WebACL", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "DefaultAction": { + "$ref": "#/definitions/Action" + }, + "Id": { + "type": "string" + }, + "MetricName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Rules": { + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "DefaultAction", + "MetricName", + "Name" + ], + "typeName": "AWS::WAFRegional::WebACL" +} diff --git a/schema/aws-wafregional-webaclassociation.json b/schema/aws-wafregional-webaclassociation.json index 9136add..9bdbdba 100644 --- a/schema/aws-wafregional-webaclassociation.json +++ b/schema/aws-wafregional-webaclassociation.json @@ -1,30 +1,30 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn", - "/properties/WebACLId" - ], - "description": "Resource Type definition for AWS::WAFRegional::WebACLAssociation", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "ResourceArn": { - "type": "string" - }, - "WebACLId": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "ResourceArn", - "WebACLId" - ], - "typeName": "AWS::WAFRegional::WebACLAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn", + "/properties/WebACLId" + ], + "description": "Resource Type definition for AWS::WAFRegional::WebACLAssociation", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "ResourceArn": { + "type": "string" + }, + "WebACLId": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceArn", + "WebACLId" + ], + "typeName": "AWS::WAFRegional::WebACLAssociation" +} diff --git a/schema/aws-wafregional-xssmatchset.json b/schema/aws-wafregional-xssmatchset.json index 00791f2..aa64991 100644 --- a/schema/aws-wafregional-xssmatchset.json +++ b/schema/aws-wafregional-xssmatchset.json @@ -1,65 +1,65 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name" - ], - "definitions": { - "FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "XssMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "TextTransformation", - "FieldToMatch" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WAFRegional::XssMatchSet", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "XssMatchTuples": { - "items": { - "$ref": "#/definitions/XssMatchTuple" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name" - ], - "typeName": "AWS::WAFRegional::XssMatchSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "FieldToMatch": { + "additionalProperties": false, + "properties": { + "Data": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "XssMatchTuple": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformation": { + "type": "string" + } + }, + "required": [ + "TextTransformation", + "FieldToMatch" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WAFRegional::XssMatchSet", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "XssMatchTuples": { + "items": { + "$ref": "#/definitions/XssMatchTuple" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "Name" + ], + "typeName": "AWS::WAFRegional::XssMatchSet" +} diff --git a/schema/aws-wafv2-ipset.json b/schema/aws-wafv2-ipset.json index 08c23fe..cc5d01d 100644 --- a/schema/aws-wafv2-ipset.json +++ b/schema/aws-wafv2-ipset.json @@ -1,166 +1,166 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Scope" - ], - "definitions": { - "EntityDescription": { - "description": "Description of the entity.", - "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", - "type": "string" - }, - "EntityId": { - "description": "Id of the IPSet", - "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", - "type": "string" - }, - "EntityName": { - "description": "Name of the IPSet.", - "pattern": "^[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "IPAddress": { - "description": "IP address", - "maxLength": 50, - "minLength": 1, - "type": "string" - }, - "IPAddressVersion": { - "description": "Type of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.", - "enum": [ - "IPV4", - "IPV6" - ], - "type": "string" - }, - "ResourceArn": { - "description": "ARN of the WAF entity.", - "type": "string" - }, - "Scope": { - "description": "Use CLOUDFRONT for CloudFront IPSet, use REGIONAL for Application Load Balancer and API Gateway.", - "enum": [ - "CLOUDFRONT", - "REGIONAL" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Contains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually", - "handlers": { - "create": { - "permissions": [ - "wafv2:CreateIPSet", - "wafv2:GetIPSet", - "wafv2:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "wafv2:DeleteIPSet", - "wafv2:GetIPSet" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Scope": { - "$ref": "resource-schema.json#/properties/Scope" - } - }, - "required": [ - "Scope" - ] - }, - "permissions": [ - "wafv2:listIPSets" - ] - }, - "read": { - "permissions": [ - "wafv2:GetIPSet", - "wafv2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "wafv2:UpdateIPSet", - "wafv2:GetIPSet", - "wafv2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name", - "/properties/Id", - "/properties/Scope" - ], - "properties": { - "Addresses": { - "description": "List of IPAddresses.", - "items": { - "$ref": "#/definitions/IPAddress" - }, - "type": "array" - }, - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "Description": { - "$ref": "#/definitions/EntityDescription" - }, - "IPAddressVersion": { - "$ref": "#/definitions/IPAddressVersion" - }, - "Id": { - "$ref": "#/definitions/EntityId" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "Scope": { - "$ref": "#/definitions/Scope" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Addresses", - "IPAddressVersion", - "Scope" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::IPSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Scope" + ], + "definitions": { + "EntityDescription": { + "description": "Description of the entity.", + "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", + "type": "string" + }, + "EntityId": { + "description": "Id of the IPSet", + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "type": "string" + }, + "EntityName": { + "description": "Name of the IPSet.", + "pattern": "^[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "IPAddress": { + "description": "IP address", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "IPAddressVersion": { + "description": "Type of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.", + "enum": [ + "IPV4", + "IPV6" + ], + "type": "string" + }, + "ResourceArn": { + "description": "ARN of the WAF entity.", + "type": "string" + }, + "Scope": { + "description": "Use CLOUDFRONT for CloudFront IPSet, use REGIONAL for Application Load Balancer and API Gateway.", + "enum": [ + "CLOUDFRONT", + "REGIONAL" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Contains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually", + "handlers": { + "create": { + "permissions": [ + "wafv2:CreateIPSet", + "wafv2:GetIPSet", + "wafv2:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "wafv2:DeleteIPSet", + "wafv2:GetIPSet" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Scope": { + "$ref": "resource-schema.json#/properties/Scope" + } + }, + "required": [ + "Scope" + ] + }, + "permissions": [ + "wafv2:listIPSets" + ] + }, + "read": { + "permissions": [ + "wafv2:GetIPSet", + "wafv2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "wafv2:UpdateIPSet", + "wafv2:GetIPSet", + "wafv2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name", + "/properties/Id", + "/properties/Scope" + ], + "properties": { + "Addresses": { + "description": "List of IPAddresses.", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "type": "array" + }, + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "Description": { + "$ref": "#/definitions/EntityDescription" + }, + "IPAddressVersion": { + "$ref": "#/definitions/IPAddressVersion" + }, + "Id": { + "$ref": "#/definitions/EntityId" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "Scope": { + "$ref": "#/definitions/Scope" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Addresses", + "IPAddressVersion", + "Scope" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::IPSet" +} diff --git a/schema/aws-wafv2-loggingconfiguration.json b/schema/aws-wafv2-loggingconfiguration.json index 888ea7e..d45052e 100644 --- a/schema/aws-wafv2-loggingconfiguration.json +++ b/schema/aws-wafv2-loggingconfiguration.json @@ -1,238 +1,238 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn" - ], - "definitions": { - "Condition": { - "additionalProperties": false, - "properties": { - "ActionCondition": { - "additionalProperties": false, - "description": "A single action condition.", - "properties": { - "Action": { - "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", - "enum": [ - "ALLOW", - "BLOCK", - "COUNT", - "CAPTCHA", - "CHALLENGE", - "EXCLUDED_AS_COUNT" - ], - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "LabelNameCondition": { - "additionalProperties": false, - "description": "A single label name condition.", - "properties": { - "LabelName": { - "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. ", - "type": "string" - } - }, - "required": [ - "LabelName" - ], - "type": "object" - } - }, - "type": "object" - }, - "FieldToMatch": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Method": { - "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. ", - "type": "object" - }, - "QueryString": { - "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any. ", - "type": "object" - }, - "SingleHeader": { - "additionalProperties": false, - "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.", - "properties": { - "Name": { - "description": "The name of the query header to inspect.", - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "UriPath": { - "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ", - "type": "object" - } - }, - "type": "object" - }, - "Filter": { - "additionalProperties": false, - "properties": { - "Behavior": { - "description": "How to handle logs that satisfy the filter's conditions and requirement. ", - "enum": [ - "KEEP", - "DROP" - ], - "type": "string" - }, - "Conditions": { - "description": "Match conditions for the filter.", - "items": { - "$ref": "#/definitions/Condition" - }, - "minItems": 1, - "type": "array" - }, - "Requirement": { - "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", - "enum": [ - "MEETS_ALL", - "MEETS_ANY" - ], - "type": "string" - } - }, - "required": [ - "Behavior", - "Conditions", - "Requirement" - ], - "type": "object" - } - }, - "description": "A WAFv2 Logging Configuration Resource Provider", - "handlers": { - "create": { - "permissions": [ - "wafv2:PutLoggingConfiguration", - "wafv2:GetLoggingConfiguration", - "firehose:ListDeliveryStreams", - "iam:CreateServiceLinkedRole", - "iam:DescribeOrganization", - "logs:CreateLogDelivery", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups" - ] - }, - "delete": { - "permissions": [ - "wafv2:DeleteLoggingConfiguration", - "wafv2:GetLoggingConfiguration", - "logs:DeleteLogDelivery" - ] - }, - "list": { - "permissions": [ - "wafv2:ListLoggingConfigurations" - ] - }, - "read": { - "permissions": [ - "wafv2:GetLoggingConfiguration" - ] - }, - "update": { - "permissions": [ - "wafv2:PutLoggingConfiguration", - "wafv2:GetLoggingConfiguration", - "firehose:ListDeliveryStreams", - "iam:CreateServiceLinkedRole", - "iam:DescribeOrganization", - "logs:CreateLogDelivery", - "s3:PutBucketPolicy", - "s3:GetBucketPolicy", - "logs:PutResourcePolicy", - "logs:DescribeResourcePolicies", - "logs:DescribeLogGroups" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceArn" - ], - "properties": { - "LogDestinationConfigs": { - "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.", - "items": { - "type": "string" - }, - "type": "array" - }, - "LoggingFilter": { - "additionalProperties": false, - "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.", - "properties": { - "DefaultBehavior": { - "description": "Default handling for logs that don't match any of the specified filtering conditions.", - "enum": [ - "KEEP", - "DROP" - ], - "type": "string" - }, - "Filters": { - "description": "The filters that you want to apply to the logs.", - "items": { - "$ref": "#/definitions/Filter" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "DefaultBehavior", - "Filters" - ], - "type": "object" - }, - "ManagedByFirewallManager": { - "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.", - "type": "boolean" - }, - "RedactedFields": { - "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/FieldToMatch" - }, - "type": "array" - }, - "ResourceArn": { - "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ManagedByFirewallManager" - ], - "required": [ - "ResourceArn", - "LogDestinationConfigs" - ], - "sourceUrl": "https://github.com/advaj/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::LoggingConfiguration" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn" + ], + "definitions": { + "Condition": { + "additionalProperties": false, + "properties": { + "ActionCondition": { + "additionalProperties": false, + "description": "A single action condition.", + "properties": { + "Action": { + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", + "enum": [ + "ALLOW", + "BLOCK", + "COUNT", + "CAPTCHA", + "CHALLENGE", + "EXCLUDED_AS_COUNT" + ], + "type": "string" + } + }, + "required": [ + "Action" + ], + "type": "object" + }, + "LabelNameCondition": { + "additionalProperties": false, + "description": "A single label name condition.", + "properties": { + "LabelName": { + "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. ", + "type": "string" + } + }, + "required": [ + "LabelName" + ], + "type": "object" + } + }, + "type": "object" + }, + "FieldToMatch": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Method": { + "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. ", + "type": "object" + }, + "QueryString": { + "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any. ", + "type": "object" + }, + "SingleHeader": { + "additionalProperties": false, + "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.", + "properties": { + "Name": { + "description": "The name of the query header to inspect.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "UriPath": { + "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. ", + "type": "object" + } + }, + "type": "object" + }, + "Filter": { + "additionalProperties": false, + "properties": { + "Behavior": { + "description": "How to handle logs that satisfy the filter's conditions and requirement. ", + "enum": [ + "KEEP", + "DROP" + ], + "type": "string" + }, + "Conditions": { + "description": "Match conditions for the filter.", + "items": { + "$ref": "#/definitions/Condition" + }, + "minItems": 1, + "type": "array" + }, + "Requirement": { + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", + "enum": [ + "MEETS_ALL", + "MEETS_ANY" + ], + "type": "string" + } + }, + "required": [ + "Behavior", + "Conditions", + "Requirement" + ], + "type": "object" + } + }, + "description": "A WAFv2 Logging Configuration Resource Provider", + "handlers": { + "create": { + "permissions": [ + "wafv2:PutLoggingConfiguration", + "wafv2:GetLoggingConfiguration", + "firehose:ListDeliveryStreams", + "iam:CreateServiceLinkedRole", + "iam:DescribeOrganization", + "logs:CreateLogDelivery", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups" + ] + }, + "delete": { + "permissions": [ + "wafv2:DeleteLoggingConfiguration", + "wafv2:GetLoggingConfiguration", + "logs:DeleteLogDelivery" + ] + }, + "list": { + "permissions": [ + "wafv2:ListLoggingConfigurations" + ] + }, + "read": { + "permissions": [ + "wafv2:GetLoggingConfiguration" + ] + }, + "update": { + "permissions": [ + "wafv2:PutLoggingConfiguration", + "wafv2:GetLoggingConfiguration", + "firehose:ListDeliveryStreams", + "iam:CreateServiceLinkedRole", + "iam:DescribeOrganization", + "logs:CreateLogDelivery", + "s3:PutBucketPolicy", + "s3:GetBucketPolicy", + "logs:PutResourcePolicy", + "logs:DescribeResourcePolicies", + "logs:DescribeLogGroups" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceArn" + ], + "properties": { + "LogDestinationConfigs": { + "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.", + "items": { + "type": "string" + }, + "type": "array" + }, + "LoggingFilter": { + "additionalProperties": false, + "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.", + "properties": { + "DefaultBehavior": { + "description": "Default handling for logs that don't match any of the specified filtering conditions.", + "enum": [ + "KEEP", + "DROP" + ], + "type": "string" + }, + "Filters": { + "description": "The filters that you want to apply to the logs.", + "items": { + "$ref": "#/definitions/Filter" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "DefaultBehavior", + "Filters" + ], + "type": "object" + }, + "ManagedByFirewallManager": { + "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.", + "type": "boolean" + }, + "RedactedFields": { + "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FieldToMatch" + }, + "type": "array" + }, + "ResourceArn": { + "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ManagedByFirewallManager" + ], + "required": [ + "ResourceArn", + "LogDestinationConfigs" + ], + "sourceUrl": "https://github.com/advaj/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::LoggingConfiguration" +} diff --git a/schema/aws-wafv2-regexpatternset.json b/schema/aws-wafv2-regexpatternset.json index 11ae6b1..ae1e1e0 100644 --- a/schema/aws-wafv2-regexpatternset.json +++ b/schema/aws-wafv2-regexpatternset.json @@ -1,132 +1,132 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Scope" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Contains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .", - "handlers": { - "create": { - "permissions": [ - "wafv2:CreateRegexPatternSet", - "wafv2:GetRegexPatternSet", - "wafv2:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "wafv2:DeleteRegexPatternSet", - "wafv2:GetRegexPatternSet" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Scope": { - "$ref": "resource-schema.json#/properties/Scope" - } - }, - "required": [ - "Scope" - ] - }, - "permissions": [ - "wafv2:listRegexPatternSets" - ] - }, - "read": { - "permissions": [ - "wafv2:GetRegexPatternSet", - "wafv2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "wafv2:UpdateRegexPatternSet", - "wafv2:GetRegexPatternSet", - "wafv2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name", - "/properties/Id", - "/properties/Scope" - ], - "properties": { - "Arn": { - "description": "ARN of the WAF entity.", - "type": "string" - }, - "Description": { - "description": "Description of the entity.", - "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", - "type": "string" - }, - "Id": { - "description": "Id of the RegexPatternSet", - "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", - "type": "string" - }, - "Name": { - "description": "Name of the RegexPatternSet.", - "pattern": "^[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "RegularExpressionList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Scope": { - "description": "Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.", - "enum": [ - "CLOUDFRONT", - "REGIONAL" - ], - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 1, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id" - ], - "required": [ - "Scope", - "RegularExpressionList" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::RegexPatternSet" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Scope" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Contains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .", + "handlers": { + "create": { + "permissions": [ + "wafv2:CreateRegexPatternSet", + "wafv2:GetRegexPatternSet", + "wafv2:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "wafv2:DeleteRegexPatternSet", + "wafv2:GetRegexPatternSet" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Scope": { + "$ref": "resource-schema.json#/properties/Scope" + } + }, + "required": [ + "Scope" + ] + }, + "permissions": [ + "wafv2:listRegexPatternSets" + ] + }, + "read": { + "permissions": [ + "wafv2:GetRegexPatternSet", + "wafv2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "wafv2:UpdateRegexPatternSet", + "wafv2:GetRegexPatternSet", + "wafv2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name", + "/properties/Id", + "/properties/Scope" + ], + "properties": { + "Arn": { + "description": "ARN of the WAF entity.", + "type": "string" + }, + "Description": { + "description": "Description of the entity.", + "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", + "type": "string" + }, + "Id": { + "description": "Id of the RegexPatternSet", + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "type": "string" + }, + "Name": { + "description": "Name of the RegexPatternSet.", + "pattern": "^[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "RegularExpressionList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Scope": { + "description": "Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.", + "enum": [ + "CLOUDFRONT", + "REGIONAL" + ], + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id" + ], + "required": [ + "Scope", + "RegularExpressionList" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::RegexPatternSet" +} diff --git a/schema/aws-wafv2-rulegroup.json b/schema/aws-wafv2-rulegroup.json index fb1b37c..4f69233 100644 --- a/schema/aws-wafv2-rulegroup.json +++ b/schema/aws-wafv2-rulegroup.json @@ -1,1464 +1,1464 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Scope" - ], - "definitions": { - "AllowAction": { - "additionalProperties": false, - "description": "Allow traffic towards application.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "AndStatement": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/Statement" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "BlockAction": { - "additionalProperties": false, - "description": "Block traffic towards application.", - "properties": { - "CustomResponse": { - "$ref": "#/definitions/CustomResponse" - } - }, - "type": "object" - }, - "Body": { - "additionalProperties": false, - "description": "The body of a web request. This immediately follows the request headers.", - "properties": { - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "type": "object" - }, - "BodyParsingFallbackBehavior": { - "description": "The inspection behavior to fall back to if the JSON in the request body is invalid.", - "enum": [ - "MATCH", - "NO_MATCH", - "EVALUATE_AS_STRING" - ], - "type": "string" - }, - "ByteMatchStatement": { - "additionalProperties": false, - "description": "Byte Match statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "PositionalConstraint": { - "$ref": "#/definitions/PositionalConstraint" - }, - "SearchString": { - "$ref": "#/definitions/SearchString" - }, - "SearchStringBase64": { - "$ref": "#/definitions/SearchStringBase64" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformations" - ], - "type": "object" - }, - "CaptchaAction": { - "additionalProperties": false, - "description": "Checks valid token exists with request.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "CaptchaConfig": { - "additionalProperties": false, - "properties": { - "ImmunityTimeProperty": { - "$ref": "#/definitions/ImmunityTimeProperty" - } - }, - "type": "object" - }, - "ChallengeAction": { - "additionalProperties": false, - "description": "Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "ChallengeConfig": { - "additionalProperties": false, - "properties": { - "ImmunityTimeProperty": { - "$ref": "#/definitions/ImmunityTimeProperty" - } - }, - "type": "object" - }, - "CookieMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the request cookies.", - "properties": { - "All": { - "description": "Inspect all parts of the web request cookies.", - "type": "object" - }, - "ExcludedCookies": { - "items": { - "maxLength": 60, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - }, - "IncludedCookies": { - "items": { - "maxLength": 60, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Cookies": { - "additionalProperties": false, - "description": "Includes cookies of a web request.", - "properties": { - "MatchPattern": { - "$ref": "#/definitions/CookieMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/MapMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope", - "OversizeHandling" - ], - "type": "object" - }, - "CountAction": { - "additionalProperties": false, - "description": "Count traffic towards application.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "CustomHTTPHeader": { - "additionalProperties": false, - "description": "HTTP header.", - "properties": { - "Name": { - "$ref": "#/definitions/CustomHTTPHeaderName" - }, - "Value": { - "$ref": "#/definitions/CustomHTTPHeaderValue" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "CustomHTTPHeaderName": { - "description": "HTTP header name.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "CustomHTTPHeaderValue": { - "description": "HTTP header value.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "CustomRequestHandling": { - "additionalProperties": false, - "description": "Custom request handling.", - "properties": { - "InsertHeaders": { - "description": "Collection of HTTP headers.", - "items": { - "$ref": "#/definitions/CustomHTTPHeader" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "InsertHeaders" - ], - "type": "object" - }, - "CustomResponse": { - "additionalProperties": false, - "description": "Custom response.", - "properties": { - "CustomResponseBodyKey": { - "description": "Custom response body key.", - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ResponseCode": { - "$ref": "#/definitions/ResponseStatusCode" - }, - "ResponseHeaders": { - "description": "Collection of HTTP headers.", - "items": { - "$ref": "#/definitions/CustomHTTPHeader" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ResponseCode" - ], - "type": "object" - }, - "CustomResponseBodies": { - "additionalProperties": false, - "description": "Custom response key and body map.", - "minProperties": 1, - "patternProperties": { - "^[\\w\\-]+$": { - "$ref": "#/definitions/CustomResponseBody" - } - }, - "type": "object" - }, - "CustomResponseBody": { - "additionalProperties": false, - "description": "Custom response body.", - "properties": { - "Content": { - "$ref": "#/definitions/ResponseContent" - }, - "ContentType": { - "$ref": "#/definitions/ResponseContentType" - } - }, - "required": [ - "ContentType", - "Content" - ], - "type": "object" - }, - "EntityDescription": { - "description": "Description of the entity.", - "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", - "type": "string" - }, - "EntityId": { - "description": "Id of the RuleGroup", - "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", - "type": "string" - }, - "EntityName": { - "description": "Name of the RuleGroup.", - "pattern": "^[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "EvaluationWindowSec": { - "enum": [ - 60, - 120, - 300, - 600 - ], - "type": "integer" - }, - "FieldToMatch": { - "additionalProperties": false, - "description": "Field of the request to match.", - "properties": { - "AllQueryArguments": { - "description": "All query arguments of a web request.", - "type": "object" - }, - "Body": { - "$ref": "#/definitions/Body" - }, - "Cookies": { - "$ref": "#/definitions/Cookies" - }, - "Headers": { - "$ref": "#/definitions/Headers" - }, - "JA3Fingerprint": { - "$ref": "#/definitions/JA3Fingerprint" - }, - "JsonBody": { - "$ref": "#/definitions/JsonBody" - }, - "Method": { - "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.", - "type": "object" - }, - "QueryString": { - "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any.", - "type": "object" - }, - "SingleHeader": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SingleQueryArgument": { - "additionalProperties": false, - "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.", - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "UriPath": { - "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.", - "type": "object" - } - }, - "type": "object" - }, - "ForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "HeaderName": { - "pattern": "^[a-zA-Z0-9-]+{1,255}$", - "type": "string" - } - }, - "required": [ - "HeaderName", - "FallbackBehavior" - ], - "type": "object" - }, - "GeoMatchStatement": { - "additionalProperties": false, - "properties": { - "CountryCodes": { - "items": { - "maxLength": 2, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/ForwardedIPConfiguration" - } - }, - "type": "object" - }, - "HeaderMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the request headers.", - "properties": { - "All": { - "description": "Inspect all parts of the web request headers.", - "type": "object" - }, - "ExcludedHeaders": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - }, - "IncludedHeaders": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Headers": { - "additionalProperties": false, - "description": "Includes headers of a web request.", - "properties": { - "MatchPattern": { - "$ref": "#/definitions/HeaderMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/MapMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope", - "OversizeHandling" - ], - "type": "object" - }, - "IPSetForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "HeaderName": { - "pattern": "^[a-zA-Z0-9-]+{1,255}$", - "type": "string" - }, - "Position": { - "enum": [ - "FIRST", - "LAST", - "ANY" - ], - "type": "string" - } - }, - "required": [ - "HeaderName", - "FallbackBehavior", - "Position" - ], - "type": "object" - }, - "IPSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "IPSetForwardedIPConfig": { - "$ref": "#/definitions/IPSetForwardedIPConfiguration" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "ImmunityTimeProperty": { - "additionalProperties": false, - "properties": { - "ImmunityTime": { - "maximum": 259200, - "minimum": 60, - "type": "integer" - } - }, - "required": [ - "ImmunityTime" - ], - "type": "object" - }, - "JA3Fingerprint": { - "additionalProperties": false, - "description": "Includes the JA3 fingerprint of a web request.", - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - } - }, - "required": [ - "FallbackBehavior" - ], - "type": "object" - }, - "JsonBody": { - "additionalProperties": false, - "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", - "properties": { - "InvalidFallbackBehavior": { - "$ref": "#/definitions/BodyParsingFallbackBehavior" - }, - "MatchPattern": { - "$ref": "#/definitions/JsonMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/JsonMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope" - ], - "type": "object" - }, - "JsonMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the JSON body.", - "properties": { - "All": { - "description": "Inspect all parts of the web request's JSON body.", - "type": "object" - }, - "IncludedPaths": { - "items": { - "$ref": "#/definitions/JsonPointerPath" - }, - "type": "array" - } - }, - "type": "object" - }, - "JsonMatchScope": { - "description": "The parts of the JSON to match against using the MatchPattern.", - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "type": "string" - }, - "JsonPointerPath": { - "description": "JSON pointer path in the web request's JSON body", - "pattern": "^[\\/]+([^~]*(~[01])*)*{1,512}$", - "type": "string" - }, - "Label": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/LabelName" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "LabelMatchKey": { - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - }, - "LabelMatchScope": { - "enum": [ - "LABEL", - "NAMESPACE" - ], - "type": "string" - }, - "LabelMatchStatement": { - "additionalProperties": false, - "properties": { - "Key": { - "$ref": "#/definitions/LabelMatchKey" - }, - "Scope": { - "$ref": "#/definitions/LabelMatchScope" - } - }, - "required": [ - "Scope", - "Key" - ], - "type": "object" - }, - "LabelName": { - "description": "Name of the Label.", - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - }, - "LabelSummary": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/LabelName" - } - }, - "type": "object" - }, - "MapMatchScope": { - "description": "The parts of the request to match against using the MatchPattern.", - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "type": "string" - }, - "NotStatement": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/Statement" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "OrStatement": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/Statement" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "OversizeHandling": { - "description": "Handling of requests containing oversize fields", - "enum": [ - "CONTINUE", - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "PositionalConstraint": { - "description": "Position of the evaluation in the FieldToMatch of request.", - "enum": [ - "EXACTLY", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS", - "CONTAINS_WORD" - ], - "type": "string" - }, - "RateBasedStatement": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "enum": [ - "IP", - "FORWARDED_IP", - "CONSTANT", - "CUSTOM_KEYS" - ], - "type": "string" - }, - "CustomKeys": { - "description": "Specifies the aggregate keys to use in a rate-base rule.", - "items": { - "$ref": "#/definitions/RateBasedStatementCustomKey" - }, - "maxItems": 5, - "type": "array" - }, - "EvaluationWindowSec": { - "$ref": "#/definitions/EvaluationWindowSec" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/ForwardedIPConfiguration" - }, - "Limit": { - "$ref": "#/definitions/RateLimit" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/Statement" - } - }, - "required": [ - "Limit", - "AggregateKeyType" - ], - "type": "object" - }, - "RateBasedStatementCustomKey": { - "additionalProperties": false, - "description": "Specifies a single custom aggregate key for a rate-base rule.", - "properties": { - "Cookie": { - "$ref": "#/definitions/RateLimitCookie" - }, - "ForwardedIP": { - "$ref": "#/definitions/RateLimitForwardedIP" - }, - "HTTPMethod": { - "$ref": "#/definitions/RateLimitHTTPMethod" - }, - "Header": { - "$ref": "#/definitions/RateLimitHeader" - }, - "IP": { - "$ref": "#/definitions/RateLimitIP" - }, - "LabelNamespace": { - "$ref": "#/definitions/RateLimitLabelNamespace" - }, - "QueryArgument": { - "$ref": "#/definitions/RateLimitQueryArgument" - }, - "QueryString": { - "$ref": "#/definitions/RateLimitQueryString" - }, - "UriPath": { - "$ref": "#/definitions/RateLimitUriPath" - } - }, - "type": "object" - }, - "RateLimit": { - "maximum": 2000000000, - "minimum": 100, - "type": "integer" - }, - "RateLimitCookie": { - "additionalProperties": false, - "description": "Specifies a cookie as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the cookie to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitForwardedIP": { - "description": "Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitHTTPMethod": { - "description": "Specifies the request's HTTP method as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitHeader": { - "additionalProperties": false, - "description": "Specifies a header as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the header to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitIP": { - "description": "Specifies the IP address in the web request as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitLabelNamespace": { - "additionalProperties": false, - "description": "Specifies a label namespace to use as an aggregate key for a rate-based rule.", - "properties": { - "Namespace": { - "description": "The namespace to use for aggregation.", - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "RateLimitQueryArgument": { - "additionalProperties": false, - "description": "Specifies a query argument in the request as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the query argument to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitQueryString": { - "additionalProperties": false, - "description": "Specifies the request's query string as an aggregate key for a rate-based rule.", - "properties": { - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "TextTransformations" - ], - "type": "object" - }, - "RateLimitUriPath": { - "additionalProperties": false, - "description": "Specifies the request's URI Path as an aggregate key for a rate-based rule.", - "properties": { - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "TextTransformations" - ], - "type": "object" - }, - "RegexMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "RegexString": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "RegexString", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "RegexPatternSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "ResourceArn": { - "description": "ARN of the WAF entity.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ResponseContent": { - "description": "Response content.", - "maxLength": 10240, - "minLength": 1, - "type": "string" - }, - "ResponseContentType": { - "description": "Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.", - "enum": [ - "TEXT_PLAIN", - "TEXT_HTML", - "APPLICATION_JSON" - ], - "type": "string" - }, - "ResponseStatusCode": { - "description": "Custom response code.", - "maximum": 599, - "minimum": 200, - "type": "integer" - }, - "Rule": { - "additionalProperties": false, - "description": "Rule of RuleGroup that contains condition and action.", - "properties": { - "Action": { - "$ref": "#/definitions/RuleAction" - }, - "CaptchaConfig": { - "$ref": "#/definitions/CaptchaConfig" - }, - "ChallengeConfig": { - "$ref": "#/definitions/ChallengeConfig" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "Priority": { - "$ref": "#/definitions/RulePriority" - }, - "RuleLabels": { - "description": "Collection of Rule Labels.", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "Statement": { - "$ref": "#/definitions/Statement" - }, - "VisibilityConfig": { - "$ref": "#/definitions/VisibilityConfig" - } - }, - "required": [ - "Name", - "Priority", - "Statement", - "VisibilityConfig" - ], - "type": "object" - }, - "RuleAction": { - "additionalProperties": false, - "description": "Action taken when Rule matches its condition.", - "properties": { - "Allow": { - "$ref": "#/definitions/AllowAction" - }, - "Block": { - "$ref": "#/definitions/BlockAction" - }, - "Captcha": { - "$ref": "#/definitions/CaptchaAction" - }, - "Challenge": { - "$ref": "#/definitions/ChallengeAction" - }, - "Count": { - "$ref": "#/definitions/CountAction" - } - }, - "type": "object" - }, - "RuleGroup": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "Capacity": { - "minimum": 0, - "type": "integer" - }, - "Description": { - "$ref": "#/definitions/EntityDescription" - }, - "Id": { - "$ref": "#/definitions/EntityId" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "Rules": { - "description": "Collection of Rules.", - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array" - }, - "VisibilityConfig": { - "$ref": "#/definitions/VisibilityConfig" - } - }, - "type": "object" - }, - "RulePriority": { - "description": "Priority of the Rule, Rules get evaluated from lower to higher priority.", - "minimum": 0, - "type": "integer" - }, - "Scope": { - "description": "Use CLOUDFRONT for CloudFront RuleGroup, use REGIONAL for Application Load Balancer and API Gateway.", - "enum": [ - "CLOUDFRONT", - "REGIONAL" - ], - "type": "string" - }, - "SearchString": { - "description": "String that is searched to find a match.", - "type": "string" - }, - "SearchStringBase64": { - "description": "Base64 encoded string that is searched to find a match.", - "type": "string" - }, - "SensitivityLevel": { - "description": "Sensitivity Level current only used for sqli match statements.", - "enum": [ - "LOW", - "HIGH" - ], - "type": "string" - }, - "SizeConstraintStatement": { - "additionalProperties": false, - "description": "Size Constraint statement.", - "properties": { - "ComparisonOperator": { - "enum": [ - "EQ", - "NE", - "LE", - "LT", - "GE", - "GT" - ], - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "Size": { - "maximum": 21474836480, - "minimum": 0, - "type": "number" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "ComparisonOperator", - "Size", - "TextTransformations" - ], - "type": "object" - }, - "SqliMatchStatement": { - "additionalProperties": false, - "description": "Sqli Match Statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "SensitivityLevel": { - "$ref": "#/definitions/SensitivityLevel" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "Statement": { - "additionalProperties": false, - "description": "First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc", - "properties": { - "AndStatement": { - "$ref": "#/definitions/AndStatement" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/IPSetReferenceStatement" - }, - "LabelMatchStatement": { - "$ref": "#/definitions/LabelMatchStatement" - }, - "NotStatement": { - "$ref": "#/definitions/NotStatement" - }, - "OrStatement": { - "$ref": "#/definitions/OrStatement" - }, - "RateBasedStatement": { - "$ref": "#/definitions/RateBasedStatement" - }, - "RegexMatchStatement": { - "$ref": "#/definitions/RegexMatchStatement" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/RegexPatternSetReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/XssMatchStatement" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TextTransformation": { - "additionalProperties": false, - "description": "Text Transformation on the Search String before match.", - "properties": { - "Priority": { - "$ref": "#/definitions/TextTransformationPriority" - }, - "Type": { - "$ref": "#/definitions/TextTransformationType" - } - }, - "required": [ - "Priority", - "Type" - ], - "type": "object" - }, - "TextTransformationPriority": { - "description": "Priority of Rule being evaluated.", - "minimum": 0, - "type": "integer" - }, - "TextTransformationType": { - "description": "Type of text transformation.", - "enum": [ - "NONE", - "COMPRESS_WHITE_SPACE", - "HTML_ENTITY_DECODE", - "LOWERCASE", - "CMD_LINE", - "URL_DECODE", - "BASE64_DECODE", - "HEX_DECODE", - "MD5", - "REPLACE_COMMENTS", - "ESCAPE_SEQ_DECODE", - "SQL_HEX_DECODE", - "CSS_DECODE", - "JS_DECODE", - "NORMALIZE_PATH", - "NORMALIZE_PATH_WIN", - "REMOVE_NULLS", - "REPLACE_NULLS", - "BASE64_DECODE_EXT", - "URL_DECODE_UNI", - "UTF8_TO_UNICODE" - ], - "type": "string" - }, - "VisibilityConfig": { - "additionalProperties": false, - "description": "Visibility Metric of the RuleGroup.", - "properties": { - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "MetricName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SampledRequestsEnabled": { - "type": "boolean" - } - }, - "required": [ - "SampledRequestsEnabled", - "CloudWatchMetricsEnabled", - "MetricName" - ], - "type": "object" - }, - "XssMatchStatement": { - "additionalProperties": false, - "description": "Xss Match Statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - } - }, - "description": "Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.", - "handlers": { - "create": { - "permissions": [ - "wafv2:CreateRuleGroup", - "wafv2:GetRuleGroup", - "wafv2:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "wafv2:DeleteRuleGroup", - "wafv2:GetRuleGroup" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Scope": { - "$ref": "resource-schema.json#/properties/Scope" - } - }, - "required": [ - "Scope" - ] - }, - "permissions": [ - "wafv2:listRuleGroups" - ] - }, - "read": { - "permissions": [ - "wafv2:GetRuleGroup", - "wafv2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "wafv2:UpdateRuleGroup", - "wafv2:GetRuleGroup", - "wafv2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name", - "/properties/Id", - "/properties/Scope" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "AvailableLabels": { - "description": "Collection of Available Labels.", - "items": { - "$ref": "#/definitions/LabelSummary" - }, - "type": "array" - }, - "Capacity": { - "minimum": 0, - "type": "integer" - }, - "ConsumedLabels": { - "description": "Collection of Consumed Labels.", - "items": { - "$ref": "#/definitions/LabelSummary" - }, - "type": "array" - }, - "CustomResponseBodies": { - "$ref": "#/definitions/CustomResponseBodies" - }, - "Description": { - "$ref": "#/definitions/EntityDescription" - }, - "Id": { - "$ref": "#/definitions/EntityId" - }, - "LabelNamespace": { - "$ref": "#/definitions/LabelName" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "Rules": { - "description": "Collection of Rules.", - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array" - }, - "Scope": { - "$ref": "#/definitions/Scope" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 1, - "type": "array" - }, - "VisibilityConfig": { - "$ref": "#/definitions/VisibilityConfig" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Id", - "/properties/LabelNamespace", - "/properties/AvailableLabels/*/Name", - "/properties/ConsumedLabels/*/Name" - ], - "required": [ - "Capacity", - "Scope", - "VisibilityConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::RuleGroup" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Scope" + ], + "definitions": { + "AllowAction": { + "additionalProperties": false, + "description": "Allow traffic towards application.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "AndStatement": { + "additionalProperties": false, + "properties": { + "Statements": { + "items": { + "$ref": "#/definitions/Statement" + }, + "type": "array" + } + }, + "required": [ + "Statements" + ], + "type": "object" + }, + "BlockAction": { + "additionalProperties": false, + "description": "Block traffic towards application.", + "properties": { + "CustomResponse": { + "$ref": "#/definitions/CustomResponse" + } + }, + "type": "object" + }, + "Body": { + "additionalProperties": false, + "description": "The body of a web request. This immediately follows the request headers.", + "properties": { + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "type": "object" + }, + "BodyParsingFallbackBehavior": { + "description": "The inspection behavior to fall back to if the JSON in the request body is invalid.", + "enum": [ + "MATCH", + "NO_MATCH", + "EVALUATE_AS_STRING" + ], + "type": "string" + }, + "ByteMatchStatement": { + "additionalProperties": false, + "description": "Byte Match statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "PositionalConstraint": { + "$ref": "#/definitions/PositionalConstraint" + }, + "SearchString": { + "$ref": "#/definitions/SearchString" + }, + "SearchStringBase64": { + "$ref": "#/definitions/SearchStringBase64" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "PositionalConstraint", + "TextTransformations" + ], + "type": "object" + }, + "CaptchaAction": { + "additionalProperties": false, + "description": "Checks valid token exists with request.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "CaptchaConfig": { + "additionalProperties": false, + "properties": { + "ImmunityTimeProperty": { + "$ref": "#/definitions/ImmunityTimeProperty" + } + }, + "type": "object" + }, + "ChallengeAction": { + "additionalProperties": false, + "description": "Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "ChallengeConfig": { + "additionalProperties": false, + "properties": { + "ImmunityTimeProperty": { + "$ref": "#/definitions/ImmunityTimeProperty" + } + }, + "type": "object" + }, + "CookieMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the request cookies.", + "properties": { + "All": { + "description": "Inspect all parts of the web request cookies.", + "type": "object" + }, + "ExcludedCookies": { + "items": { + "maxLength": 60, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + }, + "IncludedCookies": { + "items": { + "maxLength": 60, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Cookies": { + "additionalProperties": false, + "description": "Includes cookies of a web request.", + "properties": { + "MatchPattern": { + "$ref": "#/definitions/CookieMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/MapMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope", + "OversizeHandling" + ], + "type": "object" + }, + "CountAction": { + "additionalProperties": false, + "description": "Count traffic towards application.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "CustomHTTPHeader": { + "additionalProperties": false, + "description": "HTTP header.", + "properties": { + "Name": { + "$ref": "#/definitions/CustomHTTPHeaderName" + }, + "Value": { + "$ref": "#/definitions/CustomHTTPHeaderValue" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "CustomHTTPHeaderName": { + "description": "HTTP header name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "CustomHTTPHeaderValue": { + "description": "HTTP header value.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "CustomRequestHandling": { + "additionalProperties": false, + "description": "Custom request handling.", + "properties": { + "InsertHeaders": { + "description": "Collection of HTTP headers.", + "items": { + "$ref": "#/definitions/CustomHTTPHeader" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "InsertHeaders" + ], + "type": "object" + }, + "CustomResponse": { + "additionalProperties": false, + "description": "Custom response.", + "properties": { + "CustomResponseBodyKey": { + "description": "Custom response body key.", + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ResponseCode": { + "$ref": "#/definitions/ResponseStatusCode" + }, + "ResponseHeaders": { + "description": "Collection of HTTP headers.", + "items": { + "$ref": "#/definitions/CustomHTTPHeader" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ResponseCode" + ], + "type": "object" + }, + "CustomResponseBodies": { + "additionalProperties": false, + "description": "Custom response key and body map.", + "minProperties": 1, + "patternProperties": { + "^[\\w\\-]+$": { + "$ref": "#/definitions/CustomResponseBody" + } + }, + "type": "object" + }, + "CustomResponseBody": { + "additionalProperties": false, + "description": "Custom response body.", + "properties": { + "Content": { + "$ref": "#/definitions/ResponseContent" + }, + "ContentType": { + "$ref": "#/definitions/ResponseContentType" + } + }, + "required": [ + "ContentType", + "Content" + ], + "type": "object" + }, + "EntityDescription": { + "description": "Description of the entity.", + "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", + "type": "string" + }, + "EntityId": { + "description": "Id of the RuleGroup", + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "type": "string" + }, + "EntityName": { + "description": "Name of the RuleGroup.", + "pattern": "^[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "EvaluationWindowSec": { + "enum": [ + 60, + 120, + 300, + 600 + ], + "type": "integer" + }, + "FieldToMatch": { + "additionalProperties": false, + "description": "Field of the request to match.", + "properties": { + "AllQueryArguments": { + "description": "All query arguments of a web request.", + "type": "object" + }, + "Body": { + "$ref": "#/definitions/Body" + }, + "Cookies": { + "$ref": "#/definitions/Cookies" + }, + "Headers": { + "$ref": "#/definitions/Headers" + }, + "JA3Fingerprint": { + "$ref": "#/definitions/JA3Fingerprint" + }, + "JsonBody": { + "$ref": "#/definitions/JsonBody" + }, + "Method": { + "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.", + "type": "object" + }, + "QueryString": { + "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any.", + "type": "object" + }, + "SingleHeader": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SingleQueryArgument": { + "additionalProperties": false, + "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.", + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "UriPath": { + "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.", + "type": "object" + } + }, + "type": "object" + }, + "ForwardedIPConfiguration": { + "additionalProperties": false, + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "HeaderName": { + "pattern": "^[a-zA-Z0-9-]+{1,255}$", + "type": "string" + } + }, + "required": [ + "HeaderName", + "FallbackBehavior" + ], + "type": "object" + }, + "GeoMatchStatement": { + "additionalProperties": false, + "properties": { + "CountryCodes": { + "items": { + "maxLength": 2, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "ForwardedIPConfig": { + "$ref": "#/definitions/ForwardedIPConfiguration" + } + }, + "type": "object" + }, + "HeaderMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the request headers.", + "properties": { + "All": { + "description": "Inspect all parts of the web request headers.", + "type": "object" + }, + "ExcludedHeaders": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + }, + "IncludedHeaders": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Headers": { + "additionalProperties": false, + "description": "Includes headers of a web request.", + "properties": { + "MatchPattern": { + "$ref": "#/definitions/HeaderMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/MapMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope", + "OversizeHandling" + ], + "type": "object" + }, + "IPSetForwardedIPConfiguration": { + "additionalProperties": false, + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "HeaderName": { + "pattern": "^[a-zA-Z0-9-]+{1,255}$", + "type": "string" + }, + "Position": { + "enum": [ + "FIRST", + "LAST", + "ANY" + ], + "type": "string" + } + }, + "required": [ + "HeaderName", + "FallbackBehavior", + "Position" + ], + "type": "object" + }, + "IPSetReferenceStatement": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "IPSetForwardedIPConfig": { + "$ref": "#/definitions/IPSetForwardedIPConfiguration" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "ImmunityTimeProperty": { + "additionalProperties": false, + "properties": { + "ImmunityTime": { + "maximum": 259200, + "minimum": 60, + "type": "integer" + } + }, + "required": [ + "ImmunityTime" + ], + "type": "object" + }, + "JA3Fingerprint": { + "additionalProperties": false, + "description": "Includes the JA3 fingerprint of a web request.", + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + } + }, + "required": [ + "FallbackBehavior" + ], + "type": "object" + }, + "JsonBody": { + "additionalProperties": false, + "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", + "properties": { + "InvalidFallbackBehavior": { + "$ref": "#/definitions/BodyParsingFallbackBehavior" + }, + "MatchPattern": { + "$ref": "#/definitions/JsonMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/JsonMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope" + ], + "type": "object" + }, + "JsonMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the JSON body.", + "properties": { + "All": { + "description": "Inspect all parts of the web request's JSON body.", + "type": "object" + }, + "IncludedPaths": { + "items": { + "$ref": "#/definitions/JsonPointerPath" + }, + "type": "array" + } + }, + "type": "object" + }, + "JsonMatchScope": { + "description": "The parts of the JSON to match against using the MatchPattern.", + "enum": [ + "ALL", + "KEY", + "VALUE" + ], + "type": "string" + }, + "JsonPointerPath": { + "description": "JSON pointer path in the web request's JSON body", + "pattern": "^[\\/]+([^~]*(~[01])*)*{1,512}$", + "type": "string" + }, + "Label": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/LabelName" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LabelMatchKey": { + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + }, + "LabelMatchScope": { + "enum": [ + "LABEL", + "NAMESPACE" + ], + "type": "string" + }, + "LabelMatchStatement": { + "additionalProperties": false, + "properties": { + "Key": { + "$ref": "#/definitions/LabelMatchKey" + }, + "Scope": { + "$ref": "#/definitions/LabelMatchScope" + } + }, + "required": [ + "Scope", + "Key" + ], + "type": "object" + }, + "LabelName": { + "description": "Name of the Label.", + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + }, + "LabelSummary": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/LabelName" + } + }, + "type": "object" + }, + "MapMatchScope": { + "description": "The parts of the request to match against using the MatchPattern.", + "enum": [ + "ALL", + "KEY", + "VALUE" + ], + "type": "string" + }, + "NotStatement": { + "additionalProperties": false, + "properties": { + "Statement": { + "$ref": "#/definitions/Statement" + } + }, + "required": [ + "Statement" + ], + "type": "object" + }, + "OrStatement": { + "additionalProperties": false, + "properties": { + "Statements": { + "items": { + "$ref": "#/definitions/Statement" + }, + "type": "array" + } + }, + "required": [ + "Statements" + ], + "type": "object" + }, + "OversizeHandling": { + "description": "Handling of requests containing oversize fields", + "enum": [ + "CONTINUE", + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "PositionalConstraint": { + "description": "Position of the evaluation in the FieldToMatch of request.", + "enum": [ + "EXACTLY", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CONTAINS_WORD" + ], + "type": "string" + }, + "RateBasedStatement": { + "additionalProperties": false, + "properties": { + "AggregateKeyType": { + "enum": [ + "IP", + "FORWARDED_IP", + "CONSTANT", + "CUSTOM_KEYS" + ], + "type": "string" + }, + "CustomKeys": { + "description": "Specifies the aggregate keys to use in a rate-base rule.", + "items": { + "$ref": "#/definitions/RateBasedStatementCustomKey" + }, + "maxItems": 5, + "type": "array" + }, + "EvaluationWindowSec": { + "$ref": "#/definitions/EvaluationWindowSec" + }, + "ForwardedIPConfig": { + "$ref": "#/definitions/ForwardedIPConfiguration" + }, + "Limit": { + "$ref": "#/definitions/RateLimit" + }, + "ScopeDownStatement": { + "$ref": "#/definitions/Statement" + } + }, + "required": [ + "Limit", + "AggregateKeyType" + ], + "type": "object" + }, + "RateBasedStatementCustomKey": { + "additionalProperties": false, + "description": "Specifies a single custom aggregate key for a rate-base rule.", + "properties": { + "Cookie": { + "$ref": "#/definitions/RateLimitCookie" + }, + "ForwardedIP": { + "$ref": "#/definitions/RateLimitForwardedIP" + }, + "HTTPMethod": { + "$ref": "#/definitions/RateLimitHTTPMethod" + }, + "Header": { + "$ref": "#/definitions/RateLimitHeader" + }, + "IP": { + "$ref": "#/definitions/RateLimitIP" + }, + "LabelNamespace": { + "$ref": "#/definitions/RateLimitLabelNamespace" + }, + "QueryArgument": { + "$ref": "#/definitions/RateLimitQueryArgument" + }, + "QueryString": { + "$ref": "#/definitions/RateLimitQueryString" + }, + "UriPath": { + "$ref": "#/definitions/RateLimitUriPath" + } + }, + "type": "object" + }, + "RateLimit": { + "maximum": 2000000000, + "minimum": 100, + "type": "integer" + }, + "RateLimitCookie": { + "additionalProperties": false, + "description": "Specifies a cookie as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the cookie to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitForwardedIP": { + "description": "Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitHTTPMethod": { + "description": "Specifies the request's HTTP method as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitHeader": { + "additionalProperties": false, + "description": "Specifies a header as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the header to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitIP": { + "description": "Specifies the IP address in the web request as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitLabelNamespace": { + "additionalProperties": false, + "description": "Specifies a label namespace to use as an aggregate key for a rate-based rule.", + "properties": { + "Namespace": { + "description": "The namespace to use for aggregation.", + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + } + }, + "required": [ + "Namespace" + ], + "type": "object" + }, + "RateLimitQueryArgument": { + "additionalProperties": false, + "description": "Specifies a query argument in the request as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the query argument to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitQueryString": { + "additionalProperties": false, + "description": "Specifies the request's query string as an aggregate key for a rate-based rule.", + "properties": { + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "TextTransformations" + ], + "type": "object" + }, + "RateLimitUriPath": { + "additionalProperties": false, + "description": "Specifies the request's URI Path as an aggregate key for a rate-based rule.", + "properties": { + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "TextTransformations" + ], + "type": "object" + }, + "RegexMatchStatement": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "RegexString": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "RegexString", + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "RegexPatternSetReferenceStatement": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Arn", + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "ResourceArn": { + "description": "ARN of the WAF entity.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ResponseContent": { + "description": "Response content.", + "maxLength": 10240, + "minLength": 1, + "type": "string" + }, + "ResponseContentType": { + "description": "Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.", + "enum": [ + "TEXT_PLAIN", + "TEXT_HTML", + "APPLICATION_JSON" + ], + "type": "string" + }, + "ResponseStatusCode": { + "description": "Custom response code.", + "maximum": 599, + "minimum": 200, + "type": "integer" + }, + "Rule": { + "additionalProperties": false, + "description": "Rule of RuleGroup that contains condition and action.", + "properties": { + "Action": { + "$ref": "#/definitions/RuleAction" + }, + "CaptchaConfig": { + "$ref": "#/definitions/CaptchaConfig" + }, + "ChallengeConfig": { + "$ref": "#/definitions/ChallengeConfig" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "Priority": { + "$ref": "#/definitions/RulePriority" + }, + "RuleLabels": { + "description": "Collection of Rule Labels.", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "Statement": { + "$ref": "#/definitions/Statement" + }, + "VisibilityConfig": { + "$ref": "#/definitions/VisibilityConfig" + } + }, + "required": [ + "Name", + "Priority", + "Statement", + "VisibilityConfig" + ], + "type": "object" + }, + "RuleAction": { + "additionalProperties": false, + "description": "Action taken when Rule matches its condition.", + "properties": { + "Allow": { + "$ref": "#/definitions/AllowAction" + }, + "Block": { + "$ref": "#/definitions/BlockAction" + }, + "Captcha": { + "$ref": "#/definitions/CaptchaAction" + }, + "Challenge": { + "$ref": "#/definitions/ChallengeAction" + }, + "Count": { + "$ref": "#/definitions/CountAction" + } + }, + "type": "object" + }, + "RuleGroup": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "Capacity": { + "minimum": 0, + "type": "integer" + }, + "Description": { + "$ref": "#/definitions/EntityDescription" + }, + "Id": { + "$ref": "#/definitions/EntityId" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "Rules": { + "description": "Collection of Rules.", + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array" + }, + "VisibilityConfig": { + "$ref": "#/definitions/VisibilityConfig" + } + }, + "type": "object" + }, + "RulePriority": { + "description": "Priority of the Rule, Rules get evaluated from lower to higher priority.", + "minimum": 0, + "type": "integer" + }, + "Scope": { + "description": "Use CLOUDFRONT for CloudFront RuleGroup, use REGIONAL for Application Load Balancer and API Gateway.", + "enum": [ + "CLOUDFRONT", + "REGIONAL" + ], + "type": "string" + }, + "SearchString": { + "description": "String that is searched to find a match.", + "type": "string" + }, + "SearchStringBase64": { + "description": "Base64 encoded string that is searched to find a match.", + "type": "string" + }, + "SensitivityLevel": { + "description": "Sensitivity Level current only used for sqli match statements.", + "enum": [ + "LOW", + "HIGH" + ], + "type": "string" + }, + "SizeConstraintStatement": { + "additionalProperties": false, + "description": "Size Constraint statement.", + "properties": { + "ComparisonOperator": { + "enum": [ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ], + "type": "string" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "Size": { + "maximum": 21474836480, + "minimum": 0, + "type": "number" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "ComparisonOperator", + "Size", + "TextTransformations" + ], + "type": "object" + }, + "SqliMatchStatement": { + "additionalProperties": false, + "description": "Sqli Match Statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "SensitivityLevel": { + "$ref": "#/definitions/SensitivityLevel" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "Statement": { + "additionalProperties": false, + "description": "First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc", + "properties": { + "AndStatement": { + "$ref": "#/definitions/AndStatement" + }, + "ByteMatchStatement": { + "$ref": "#/definitions/ByteMatchStatement" + }, + "GeoMatchStatement": { + "$ref": "#/definitions/GeoMatchStatement" + }, + "IPSetReferenceStatement": { + "$ref": "#/definitions/IPSetReferenceStatement" + }, + "LabelMatchStatement": { + "$ref": "#/definitions/LabelMatchStatement" + }, + "NotStatement": { + "$ref": "#/definitions/NotStatement" + }, + "OrStatement": { + "$ref": "#/definitions/OrStatement" + }, + "RateBasedStatement": { + "$ref": "#/definitions/RateBasedStatement" + }, + "RegexMatchStatement": { + "$ref": "#/definitions/RegexMatchStatement" + }, + "RegexPatternSetReferenceStatement": { + "$ref": "#/definitions/RegexPatternSetReferenceStatement" + }, + "SizeConstraintStatement": { + "$ref": "#/definitions/SizeConstraintStatement" + }, + "SqliMatchStatement": { + "$ref": "#/definitions/SqliMatchStatement" + }, + "XssMatchStatement": { + "$ref": "#/definitions/XssMatchStatement" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TextTransformation": { + "additionalProperties": false, + "description": "Text Transformation on the Search String before match.", + "properties": { + "Priority": { + "$ref": "#/definitions/TextTransformationPriority" + }, + "Type": { + "$ref": "#/definitions/TextTransformationType" + } + }, + "required": [ + "Priority", + "Type" + ], + "type": "object" + }, + "TextTransformationPriority": { + "description": "Priority of Rule being evaluated.", + "minimum": 0, + "type": "integer" + }, + "TextTransformationType": { + "description": "Type of text transformation.", + "enum": [ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE", + "BASE64_DECODE", + "HEX_DECODE", + "MD5", + "REPLACE_COMMENTS", + "ESCAPE_SEQ_DECODE", + "SQL_HEX_DECODE", + "CSS_DECODE", + "JS_DECODE", + "NORMALIZE_PATH", + "NORMALIZE_PATH_WIN", + "REMOVE_NULLS", + "REPLACE_NULLS", + "BASE64_DECODE_EXT", + "URL_DECODE_UNI", + "UTF8_TO_UNICODE" + ], + "type": "string" + }, + "VisibilityConfig": { + "additionalProperties": false, + "description": "Visibility Metric of the RuleGroup.", + "properties": { + "CloudWatchMetricsEnabled": { + "type": "boolean" + }, + "MetricName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SampledRequestsEnabled": { + "type": "boolean" + } + }, + "required": [ + "SampledRequestsEnabled", + "CloudWatchMetricsEnabled", + "MetricName" + ], + "type": "object" + }, + "XssMatchStatement": { + "additionalProperties": false, + "description": "Xss Match Statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + } + }, + "description": "Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.", + "handlers": { + "create": { + "permissions": [ + "wafv2:CreateRuleGroup", + "wafv2:GetRuleGroup", + "wafv2:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "wafv2:DeleteRuleGroup", + "wafv2:GetRuleGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Scope": { + "$ref": "resource-schema.json#/properties/Scope" + } + }, + "required": [ + "Scope" + ] + }, + "permissions": [ + "wafv2:listRuleGroups" + ] + }, + "read": { + "permissions": [ + "wafv2:GetRuleGroup", + "wafv2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "wafv2:UpdateRuleGroup", + "wafv2:GetRuleGroup", + "wafv2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name", + "/properties/Id", + "/properties/Scope" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "AvailableLabels": { + "description": "Collection of Available Labels.", + "items": { + "$ref": "#/definitions/LabelSummary" + }, + "type": "array" + }, + "Capacity": { + "minimum": 0, + "type": "integer" + }, + "ConsumedLabels": { + "description": "Collection of Consumed Labels.", + "items": { + "$ref": "#/definitions/LabelSummary" + }, + "type": "array" + }, + "CustomResponseBodies": { + "$ref": "#/definitions/CustomResponseBodies" + }, + "Description": { + "$ref": "#/definitions/EntityDescription" + }, + "Id": { + "$ref": "#/definitions/EntityId" + }, + "LabelNamespace": { + "$ref": "#/definitions/LabelName" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "Rules": { + "description": "Collection of Rules.", + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array" + }, + "Scope": { + "$ref": "#/definitions/Scope" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 1, + "type": "array" + }, + "VisibilityConfig": { + "$ref": "#/definitions/VisibilityConfig" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/LabelNamespace", + "/properties/AvailableLabels/*/Name", + "/properties/ConsumedLabels/*/Name" + ], + "required": [ + "Capacity", + "Scope", + "VisibilityConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::RuleGroup" +} diff --git a/schema/aws-wafv2-webacl.json b/schema/aws-wafv2-webacl.json index 1832d5e..3d2b3a9 100644 --- a/schema/aws-wafv2-webacl.json +++ b/schema/aws-wafv2-webacl.json @@ -1,2002 +1,2002 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Name", - "/properties/Scope" - ], - "definitions": { - "AWSManagedRulesACFPRuleSet": { - "additionalProperties": false, - "description": "Configures how to use the Account creation fraud prevention managed rule group in the web ACL", - "properties": { - "CreationPath": { - "type": "string" - }, - "EnableRegexInPath": { - "type": "boolean" - }, - "RegistrationPagePath": { - "type": "string" - }, - "RequestInspection": { - "$ref": "#/definitions/RequestInspectionACFP" - }, - "ResponseInspection": { - "$ref": "#/definitions/ResponseInspection" - } - }, - "required": [ - "CreationPath", - "RegistrationPagePath", - "RequestInspection" - ], - "type": "object" - }, - "AWSManagedRulesATPRuleSet": { - "additionalProperties": false, - "description": "Configures how to use the Account Takeover Prevention managed rule group in the web ACL", - "properties": { - "EnableRegexInPath": { - "type": "boolean" - }, - "LoginPath": { - "type": "string" - }, - "RequestInspection": { - "$ref": "#/definitions/RequestInspection" - }, - "ResponseInspection": { - "$ref": "#/definitions/ResponseInspection" - } - }, - "required": [ - "LoginPath" - ], - "type": "object" - }, - "AWSManagedRulesBotControlRuleSet": { - "additionalProperties": false, - "description": "Configures how to use the Bot Control managed rule group in the web ACL", - "properties": { - "EnableMachineLearning": { - "type": "boolean" - }, - "InspectionLevel": { - "enum": [ - "COMMON", - "TARGETED" - ], - "type": "string" - } - }, - "required": [ - "InspectionLevel" - ], - "type": "object" - }, - "AddressField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "AllowAction": { - "additionalProperties": false, - "description": "Allow traffic towards application.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "AndStatement": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/Statement" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AssociationConfig": { - "additionalProperties": false, - "description": "AssociationConfig for body inspection", - "properties": { - "RequestBody": { - "$ref": "#/definitions/RequestBody" - } - }, - "type": "object" - }, - "BlockAction": { - "additionalProperties": false, - "description": "Block traffic towards application.", - "properties": { - "CustomResponse": { - "$ref": "#/definitions/CustomResponse" - } - }, - "type": "object" - }, - "Body": { - "additionalProperties": false, - "description": "The body of a web request. This immediately follows the request headers.", - "properties": { - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "type": "object" - }, - "BodyParsingFallbackBehavior": { - "description": "The inspection behavior to fall back to if the JSON in the request body is invalid.", - "enum": [ - "MATCH", - "NO_MATCH", - "EVALUATE_AS_STRING" - ], - "type": "string" - }, - "ByteMatchStatement": { - "additionalProperties": false, - "description": "Byte Match statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "PositionalConstraint": { - "$ref": "#/definitions/PositionalConstraint" - }, - "SearchString": { - "$ref": "#/definitions/SearchString" - }, - "SearchStringBase64": { - "$ref": "#/definitions/SearchStringBase64" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformations" - ], - "type": "object" - }, - "CaptchaAction": { - "additionalProperties": false, - "description": "Checks valid token exists with request.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "CaptchaConfig": { - "additionalProperties": false, - "properties": { - "ImmunityTimeProperty": { - "$ref": "#/definitions/ImmunityTimeProperty" - } - }, - "type": "object" - }, - "ChallengeAction": { - "additionalProperties": false, - "description": "Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "ChallengeConfig": { - "additionalProperties": false, - "properties": { - "ImmunityTimeProperty": { - "$ref": "#/definitions/ImmunityTimeProperty" - } - }, - "type": "object" - }, - "CookieMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the request cookies.", - "properties": { - "All": { - "description": "Inspect all parts of the web request cookies.", - "type": "object" - }, - "ExcludedCookies": { - "items": { - "maxLength": 60, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - }, - "IncludedCookies": { - "items": { - "maxLength": 60, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Cookies": { - "additionalProperties": false, - "description": "Includes cookies of a web request.", - "properties": { - "MatchPattern": { - "$ref": "#/definitions/CookieMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/MapMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope", - "OversizeHandling" - ], - "type": "object" - }, - "CountAction": { - "additionalProperties": false, - "description": "Allow traffic towards application.", - "properties": { - "CustomRequestHandling": { - "$ref": "#/definitions/CustomRequestHandling" - } - }, - "type": "object" - }, - "CustomHTTPHeader": { - "additionalProperties": false, - "description": "HTTP header.", - "properties": { - "Name": { - "$ref": "#/definitions/CustomHTTPHeaderName" - }, - "Value": { - "$ref": "#/definitions/CustomHTTPHeaderValue" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "CustomHTTPHeaderName": { - "description": "HTTP header name.", - "maxLength": 64, - "minLength": 1, - "type": "string" - }, - "CustomHTTPHeaderValue": { - "description": "HTTP header value.", - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "CustomRequestHandling": { - "additionalProperties": false, - "description": "Custom request handling.", - "properties": { - "InsertHeaders": { - "description": "Collection of HTTP headers.", - "items": { - "$ref": "#/definitions/CustomHTTPHeader" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "InsertHeaders" - ], - "type": "object" - }, - "CustomResponse": { - "additionalProperties": false, - "description": "Custom response.", - "properties": { - "CustomResponseBodyKey": { - "description": "Custom response body key.", - "pattern": "^[\\w\\-]+$", - "type": "string" - }, - "ResponseCode": { - "$ref": "#/definitions/ResponseStatusCode" - }, - "ResponseHeaders": { - "description": "Collection of HTTP headers.", - "items": { - "$ref": "#/definitions/CustomHTTPHeader" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "ResponseCode" - ], - "type": "object" - }, - "CustomResponseBodies": { - "additionalProperties": false, - "description": "Custom response key and body map.", - "minProperties": 1, - "patternProperties": { - "^[\\w\\-]+$": { - "$ref": "#/definitions/CustomResponseBody" - } - }, - "type": "object" - }, - "CustomResponseBody": { - "additionalProperties": false, - "description": "Custom response body.", - "properties": { - "Content": { - "$ref": "#/definitions/ResponseContent" - }, - "ContentType": { - "$ref": "#/definitions/ResponseContentType" - } - }, - "required": [ - "ContentType", - "Content" - ], - "type": "object" - }, - "DefaultAction": { - "additionalProperties": false, - "description": "Default Action WebACL will take against ingress traffic when there is no matching Rule.", - "properties": { - "Allow": { - "$ref": "#/definitions/AllowAction" - }, - "Block": { - "$ref": "#/definitions/BlockAction" - } - }, - "type": "object" - }, - "EntityDescription": { - "description": "Description of the entity.", - "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", - "type": "string" - }, - "EntityId": { - "description": "Id of the WebACL", - "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", - "type": "string" - }, - "EntityName": { - "description": "Name of the WebACL.", - "pattern": "^[0-9A-Za-z_-]{1,128}$", - "type": "string" - }, - "EvaluationWindowSec": { - "enum": [ - 60, - 120, - 300, - 600 - ], - "type": "integer" - }, - "ExcludedRule": { - "additionalProperties": false, - "description": "Excluded Rule in the RuleGroup or ManagedRuleGroup will not be evaluated.", - "properties": { - "Name": { - "$ref": "#/definitions/EntityName" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "ExcludedRules": { - "items": { - "$ref": "#/definitions/ExcludedRule" - }, - "type": "array" - }, - "FieldIdentifier": { - "additionalProperties": false, - "properties": { - "Identifier": { - "maxLength": 512, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - } - }, - "required": [ - "Identifier" - ], - "type": "object" - }, - "FieldToMatch": { - "additionalProperties": false, - "description": "Field of the request to match.", - "properties": { - "AllQueryArguments": { - "description": "All query arguments of a web request.", - "type": "object" - }, - "Body": { - "$ref": "#/definitions/Body" - }, - "Cookies": { - "$ref": "#/definitions/Cookies" - }, - "Headers": { - "$ref": "#/definitions/Headers" - }, - "JA3Fingerprint": { - "$ref": "#/definitions/JA3Fingerprint" - }, - "JsonBody": { - "$ref": "#/definitions/JsonBody" - }, - "Method": { - "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.", - "type": "object" - }, - "QueryString": { - "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any.", - "type": "object" - }, - "SingleHeader": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "SingleQueryArgument": { - "additionalProperties": false, - "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.", - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "UriPath": { - "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.", - "type": "object" - } - }, - "type": "object" - }, - "ForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "HeaderName": { - "pattern": "^[a-zA-Z0-9-]+{1,255}$", - "type": "string" - } - }, - "required": [ - "HeaderName", - "FallbackBehavior" - ], - "type": "object" - }, - "GeoMatchStatement": { - "additionalProperties": false, - "properties": { - "CountryCodes": { - "items": { - "maxLength": 2, - "minLength": 1, - "type": "string" - }, - "type": "array" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/ForwardedIPConfiguration" - } - }, - "type": "object" - }, - "HeaderMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the request headers.", - "properties": { - "All": { - "description": "Inspect all parts of the web request headers.", - "type": "object" - }, - "ExcludedHeaders": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - }, - "IncludedHeaders": { - "items": { - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 199, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "Headers": { - "additionalProperties": false, - "description": "Includes headers of a web request.", - "properties": { - "MatchPattern": { - "$ref": "#/definitions/HeaderMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/MapMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope", - "OversizeHandling" - ], - "type": "object" - }, - "IPSetForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "HeaderName": { - "pattern": "^[a-zA-Z0-9-]+{1,255}$", - "type": "string" - }, - "Position": { - "enum": [ - "FIRST", - "LAST", - "ANY" - ], - "type": "string" - } - }, - "required": [ - "HeaderName", - "FallbackBehavior", - "Position" - ], - "type": "object" - }, - "IPSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "IPSetForwardedIPConfig": { - "$ref": "#/definitions/IPSetForwardedIPConfiguration" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "ImmunityTimeProperty": { - "additionalProperties": false, - "properties": { - "ImmunityTime": { - "maximum": 259200, - "minimum": 60, - "type": "integer" - } - }, - "required": [ - "ImmunityTime" - ], - "type": "object" - }, - "JA3Fingerprint": { - "additionalProperties": false, - "description": "Includes the JA3 fingerprint of a web request.", - "properties": { - "FallbackBehavior": { - "enum": [ - "MATCH", - "NO_MATCH" - ], - "type": "string" - } - }, - "required": [ - "FallbackBehavior" - ], - "type": "object" - }, - "JsonBody": { - "additionalProperties": false, - "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", - "properties": { - "InvalidFallbackBehavior": { - "$ref": "#/definitions/BodyParsingFallbackBehavior" - }, - "MatchPattern": { - "$ref": "#/definitions/JsonMatchPattern" - }, - "MatchScope": { - "$ref": "#/definitions/JsonMatchScope" - }, - "OversizeHandling": { - "$ref": "#/definitions/OversizeHandling" - } - }, - "required": [ - "MatchPattern", - "MatchScope" - ], - "type": "object" - }, - "JsonMatchPattern": { - "additionalProperties": false, - "description": "The pattern to look for in the JSON body.", - "properties": { - "All": { - "description": "Inspect all parts of the web request's JSON body.", - "type": "object" - }, - "IncludedPaths": { - "items": { - "$ref": "#/definitions/JsonPointerPath" - }, - "type": "array" - } - }, - "type": "object" - }, - "JsonMatchScope": { - "description": "The parts of the JSON to match against using the MatchPattern.", - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "type": "string" - }, - "JsonPointerPath": { - "description": "JSON pointer path in the web request's JSON body", - "pattern": "^[\\/]+([^~]*(~[01])*)*{1,512}$", - "type": "string" - }, - "Label": { - "additionalProperties": false, - "properties": { - "Name": { - "$ref": "#/definitions/LabelName" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "LabelMatchKey": { - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - }, - "LabelMatchScope": { - "enum": [ - "LABEL", - "NAMESPACE" - ], - "type": "string" - }, - "LabelMatchStatement": { - "additionalProperties": false, - "properties": { - "Key": { - "$ref": "#/definitions/LabelMatchKey" - }, - "Scope": { - "$ref": "#/definitions/LabelMatchScope" - } - }, - "required": [ - "Scope", - "Key" - ], - "type": "object" - }, - "LabelName": { - "description": "Name of the Label.", - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - }, - "ManagedRuleGroupConfig": { - "additionalProperties": false, - "description": "ManagedRuleGroupConfig.", - "properties": { - "AWSManagedRulesACFPRuleSet": { - "$ref": "#/definitions/AWSManagedRulesACFPRuleSet" - }, - "AWSManagedRulesATPRuleSet": { - "$ref": "#/definitions/AWSManagedRulesATPRuleSet" - }, - "AWSManagedRulesBotControlRuleSet": { - "$ref": "#/definitions/AWSManagedRulesBotControlRuleSet" - }, - "LoginPath": { - "maxLength": 256, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "PasswordField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "PayloadType": { - "enum": [ - "JSON", - "FORM_ENCODED" - ], - "type": "string" - }, - "UsernameField": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "type": "object" - }, - "ManagedRuleGroupStatement": { - "additionalProperties": false, - "properties": { - "ExcludedRules": { - "items": { - "$ref": "#/definitions/ExcludedRule" - }, - "type": "array" - }, - "ManagedRuleGroupConfigs": { - "description": "Collection of ManagedRuleGroupConfig.", - "items": { - "$ref": "#/definitions/ManagedRuleGroupConfig" - }, - "type": "array" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "RuleActionOverrides": { - "description": "Action overrides for rules in the rule group.", - "items": { - "$ref": "#/definitions/RuleActionOverride" - }, - "maxItems": 100, - "type": "array" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/Statement" - }, - "VendorName": { - "type": "string" - }, - "Version": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\w#:\\.\\-/]+$", - "type": "string" - } - }, - "required": [ - "VendorName", - "Name" - ], - "type": "object" - }, - "MapMatchScope": { - "description": "The parts of the request to match against using the MatchPattern.", - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "type": "string" - }, - "NotStatement": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/Statement" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "OrStatement": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/Statement" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "OverrideAction": { - "additionalProperties": false, - "description": "Override a RuleGroup or ManagedRuleGroup behavior. This can only be applied to Rule that has RuleGroupReferenceStatement or ManagedRuleGroupReferenceStatement.", - "properties": { - "Count": { - "description": "Count traffic towards application.", - "type": "object" - }, - "None": { - "description": "Keep the RuleGroup or ManagedRuleGroup behavior as is.", - "type": "object" - } - }, - "type": "object" - }, - "OversizeHandling": { - "description": "Handling of requests containing oversize fields", - "enum": [ - "CONTINUE", - "MATCH", - "NO_MATCH" - ], - "type": "string" - }, - "PhoneNumberField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "PositionalConstraint": { - "description": "Position of the evaluation in the FieldToMatch of request.", - "enum": [ - "EXACTLY", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS", - "CONTAINS_WORD" - ], - "type": "string" - }, - "QueryString": { - "type": "object" - }, - "RateBasedStatement": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "enum": [ - "CONSTANT", - "IP", - "FORWARDED_IP", - "CUSTOM_KEYS" - ], - "type": "string" - }, - "CustomKeys": { - "description": "Specifies the aggregate keys to use in a rate-base rule.", - "items": { - "$ref": "#/definitions/RateBasedStatementCustomKey" - }, - "maxItems": 5, - "type": "array" - }, - "EvaluationWindowSec": { - "$ref": "#/definitions/EvaluationWindowSec" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/ForwardedIPConfiguration" - }, - "Limit": { - "$ref": "#/definitions/RateLimit" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/Statement" - } - }, - "required": [ - "Limit", - "AggregateKeyType" - ], - "type": "object" - }, - "RateBasedStatementCustomKey": { - "additionalProperties": false, - "description": "Specifies a single custom aggregate key for a rate-base rule.", - "properties": { - "Cookie": { - "$ref": "#/definitions/RateLimitCookie" - }, - "ForwardedIP": { - "$ref": "#/definitions/RateLimitForwardedIP" - }, - "HTTPMethod": { - "$ref": "#/definitions/RateLimitHTTPMethod" - }, - "Header": { - "$ref": "#/definitions/RateLimitHeader" - }, - "IP": { - "$ref": "#/definitions/RateLimitIP" - }, - "LabelNamespace": { - "$ref": "#/definitions/RateLimitLabelNamespace" - }, - "QueryArgument": { - "$ref": "#/definitions/RateLimitQueryArgument" - }, - "QueryString": { - "$ref": "#/definitions/RateLimitQueryString" - }, - "UriPath": { - "$ref": "#/definitions/RateLimitUriPath" - } - }, - "type": "object" - }, - "RateLimit": { - "maximum": 2000000000, - "minimum": 100, - "type": "integer" - }, - "RateLimitCookie": { - "additionalProperties": false, - "description": "Specifies a cookie as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the cookie to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitForwardedIP": { - "description": "Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitHTTPMethod": { - "description": "Specifies the request's HTTP method as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitHeader": { - "additionalProperties": false, - "description": "Specifies a header as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the header to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitIP": { - "description": "Specifies the IP address in the web request as an aggregate key for a rate-based rule.", - "type": "object" - }, - "RateLimitLabelNamespace": { - "additionalProperties": false, - "description": "Specifies a label namespace to use as an aggregate key for a rate-based rule.", - "properties": { - "Namespace": { - "description": "The namespace to use for aggregation.", - "pattern": "^[0-9A-Za-z_:-]{1,1024}$", - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "RateLimitQueryArgument": { - "additionalProperties": false, - "description": "Specifies a query argument in the request as an aggregate key for a rate-based rule.", - "properties": { - "Name": { - "description": "The name of the query argument to use.", - "maxLength": 64, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TextTransformations" - ], - "type": "object" - }, - "RateLimitQueryString": { - "additionalProperties": false, - "description": "Specifies the request's query string as an aggregate key for a rate-based rule.", - "properties": { - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "TextTransformations" - ], - "type": "object" - }, - "RateLimitUriPath": { - "additionalProperties": false, - "description": "Specifies the request's URI Path as an aggregate key for a rate-based rule.", - "properties": { - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "TextTransformations" - ], - "type": "object" - }, - "RegexMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "RegexString": { - "maxLength": 512, - "minLength": 1, - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "RegexString", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "RegexPatternSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "RequestBody": { - "additionalProperties": false, - "description": "Map of AssociatedResourceType and RequestBodyAssociatedResourceTypeConfig", - "patternProperties": { - "^(CLOUDFRONT|API_GATEWAY|COGNITO_USER_POOL|APP_RUNNER_SERVICE|VERIFIED_ACCESS_INSTANCE)$": { - "$ref": "#/definitions/RequestBodyAssociatedResourceTypeConfig" - } - }, - "type": "object" - }, - "RequestBodyAssociatedResourceTypeConfig": { - "additionalProperties": false, - "description": "Configures the inspection size in the request body.", - "properties": { - "DefaultSizeInspectionLimit": { - "$ref": "#/definitions/SizeInspectionLimit" - } - }, - "required": [ - "DefaultSizeInspectionLimit" - ], - "type": "object" - }, - "RequestInspection": { - "additionalProperties": false, - "description": "Configures the inspection of login requests", - "properties": { - "PasswordField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "PayloadType": { - "enum": [ - "JSON", - "FORM_ENCODED" - ], - "type": "string" - }, - "UsernameField": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "PayloadType", - "UsernameField", - "PasswordField" - ], - "type": "object" - }, - "RequestInspectionACFP": { - "additionalProperties": false, - "description": "Configures the inspection of sign-up requests", - "properties": { - "AddressFields": { - "items": { - "$ref": "#/definitions/AddressField" - }, - "type": "array" - }, - "EmailField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "PasswordField": { - "$ref": "#/definitions/FieldIdentifier" - }, - "PayloadType": { - "enum": [ - "JSON", - "FORM_ENCODED" - ], - "type": "string" - }, - "PhoneNumberFields": { - "items": { - "$ref": "#/definitions/PhoneNumberField" - }, - "type": "array" - }, - "UsernameField": { - "$ref": "#/definitions/FieldIdentifier" - } - }, - "required": [ - "PayloadType" - ], - "type": "object" - }, - "ResourceArn": { - "description": "ARN of the WAF entity.", - "maxLength": 2048, - "minLength": 20, - "type": "string" - }, - "ResponseContent": { - "description": "Response content.", - "maxLength": 10240, - "minLength": 1, - "type": "string" - }, - "ResponseContentType": { - "description": "Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.", - "enum": [ - "TEXT_PLAIN", - "TEXT_HTML", - "APPLICATION_JSON" - ], - "type": "string" - }, - "ResponseInspection": { - "additionalProperties": false, - "description": "Configures the inspection of login responses", - "properties": { - "BodyContains": { - "$ref": "#/definitions/ResponseInspectionBodyContains" - }, - "Header": { - "$ref": "#/definitions/ResponseInspectionHeader" - }, - "Json": { - "$ref": "#/definitions/ResponseInspectionJson" - }, - "StatusCode": { - "$ref": "#/definitions/ResponseInspectionStatusCode" - } - }, - "type": "object" - }, - "ResponseInspectionBodyContains": { - "additionalProperties": false, - "description": "Response body contents that indicate success or failure of a login request", - "properties": { - "FailureStrings": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SuccessStrings": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SuccessStrings", - "FailureStrings" - ], - "type": "object" - }, - "ResponseInspectionHeader": { - "additionalProperties": false, - "description": "Response headers that indicate success or failure of a login request", - "properties": { - "FailureValues": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - }, - "Name": { - "maxLength": 200, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "SuccessValues": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 3, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Name", - "SuccessValues", - "FailureValues" - ], - "type": "object" - }, - "ResponseInspectionJson": { - "additionalProperties": false, - "description": "Response JSON that indicate success or failure of a login request", - "properties": { - "FailureValues": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "Identifier": { - "maxLength": 512, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "SuccessValues": { - "items": { - "maxLength": 100, - "minLength": 1, - "pattern": ".*\\S.*", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "Identifier", - "SuccessValues", - "FailureValues" - ], - "type": "object" - }, - "ResponseInspectionStatusCode": { - "additionalProperties": false, - "description": "Response status codes that indicate success or failure of a login request", - "properties": { - "FailureCodes": { - "items": { - "maxLength": 999, - "minLength": 0, - "type": "integer" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "SuccessCodes": { - "items": { - "maxLength": 999, - "minLength": 0, - "type": "integer" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "SuccessCodes", - "FailureCodes" - ], - "type": "object" - }, - "ResponseStatusCode": { - "description": "Custom response code.", - "maximum": 599, - "minimum": 200, - "type": "integer" - }, - "Rule": { - "additionalProperties": false, - "description": "Rule of WebACL that contains condition and action.", - "properties": { - "Action": { - "$ref": "#/definitions/RuleAction" - }, - "CaptchaConfig": { - "$ref": "#/definitions/CaptchaConfig" - }, - "ChallengeConfig": { - "$ref": "#/definitions/ChallengeConfig" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "OverrideAction": { - "$ref": "#/definitions/OverrideAction" - }, - "Priority": { - "$ref": "#/definitions/RulePriority" - }, - "RuleLabels": { - "description": "Collection of Rule Labels.", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "Statement": { - "$ref": "#/definitions/Statement" - }, - "VisibilityConfig": { - "$ref": "#/definitions/VisibilityConfig" - } - }, - "required": [ - "Name", - "Priority", - "Statement", - "VisibilityConfig" - ], - "type": "object" - }, - "RuleAction": { - "additionalProperties": false, - "description": "Action taken when Rule matches its condition.", - "properties": { - "Allow": { - "$ref": "#/definitions/AllowAction" - }, - "Block": { - "$ref": "#/definitions/BlockAction" - }, - "Captcha": { - "$ref": "#/definitions/CaptchaAction" - }, - "Challenge": { - "$ref": "#/definitions/ChallengeAction" - }, - "Count": { - "$ref": "#/definitions/CountAction" - } - }, - "type": "object" - }, - "RuleActionOverride": { - "additionalProperties": false, - "description": "Action override for rules in the rule group.", - "properties": { - "ActionToUse": { - "$ref": "#/definitions/RuleAction" - }, - "Name": { - "$ref": "#/definitions/EntityName" - } - }, - "required": [ - "Name", - "ActionToUse" - ], - "type": "object" - }, - "RuleGroupReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "ExcludedRules": { - "items": { - "$ref": "#/definitions/ExcludedRule" - }, - "type": "array" - }, - "RuleActionOverrides": { - "description": "Action overrides for rules in the rule group.", - "items": { - "$ref": "#/definitions/RuleActionOverride" - }, - "maxItems": 100, - "type": "array" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "RulePriority": { - "description": "Priority of the Rule, Rules get evaluated from lower to higher priority.", - "minimum": 0, - "type": "integer" - }, - "Rules": { - "description": "Collection of Rules.", - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array" - }, - "Scope": { - "description": "Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.", - "enum": [ - "CLOUDFRONT", - "REGIONAL" - ], - "type": "string" - }, - "SearchString": { - "description": "String that is searched to find a match.", - "type": "string" - }, - "SearchStringBase64": { - "description": "Base64 encoded string that is searched to find a match.", - "type": "string" - }, - "SensitivityLevel": { - "description": "Sensitivity Level current only used for sqli match statements.", - "enum": [ - "LOW", - "HIGH" - ], - "type": "string" - }, - "SingleHeader": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "SingleQueryArgument": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "SizeConstraintStatement": { - "additionalProperties": false, - "description": "Size Constraint statement.", - "properties": { - "ComparisonOperator": { - "enum": [ - "EQ", - "NE", - "LE", - "LT", - "GE", - "GT" - ], - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "Size": { - "maximum": 21474836480, - "minimum": 0, - "type": "number" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "ComparisonOperator", - "Size", - "TextTransformations" - ], - "type": "object" - }, - "SizeInspectionLimit": { - "enum": [ - "KB_16", - "KB_32", - "KB_48", - "KB_64" - ], - "type": "string" - }, - "SqliMatchStatement": { - "additionalProperties": false, - "description": "Sqli Match Statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "SensitivityLevel": { - "$ref": "#/definitions/SensitivityLevel" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "Statement": { - "additionalProperties": false, - "description": "First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc", - "properties": { - "AndStatement": { - "$ref": "#/definitions/AndStatement" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/IPSetReferenceStatement" - }, - "LabelMatchStatement": { - "$ref": "#/definitions/LabelMatchStatement" - }, - "ManagedRuleGroupStatement": { - "$ref": "#/definitions/ManagedRuleGroupStatement" - }, - "NotStatement": { - "$ref": "#/definitions/NotStatement" - }, - "OrStatement": { - "$ref": "#/definitions/OrStatement" - }, - "RateBasedStatement": { - "$ref": "#/definitions/RateBasedStatement" - }, - "RegexMatchStatement": { - "$ref": "#/definitions/RegexMatchStatement" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/RegexPatternSetReferenceStatement" - }, - "RuleGroupReferenceStatement": { - "$ref": "#/definitions/RuleGroupReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/XssMatchStatement" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "type": "string" - } - }, - "type": "object" - }, - "TextTransformation": { - "additionalProperties": false, - "description": "Text Transformation on the Search String before match.", - "properties": { - "Priority": { - "$ref": "#/definitions/TextTransformationPriority" - }, - "Type": { - "$ref": "#/definitions/TextTransformationType" - } - }, - "required": [ - "Priority", - "Type" - ], - "type": "object" - }, - "TextTransformationPriority": { - "description": "Priority of Rule being evaluated.", - "minimum": 0, - "type": "integer" - }, - "TextTransformationType": { - "description": "Type of text transformation.", - "enum": [ - "NONE", - "COMPRESS_WHITE_SPACE", - "HTML_ENTITY_DECODE", - "LOWERCASE", - "CMD_LINE", - "URL_DECODE", - "BASE64_DECODE", - "HEX_DECODE", - "MD5", - "REPLACE_COMMENTS", - "ESCAPE_SEQ_DECODE", - "SQL_HEX_DECODE", - "CSS_DECODE", - "JS_DECODE", - "NORMALIZE_PATH", - "NORMALIZE_PATH_WIN", - "REMOVE_NULLS", - "REPLACE_NULLS", - "BASE64_DECODE_EXT", - "URL_DECODE_UNI", - "UTF8_TO_UNICODE" - ], - "type": "string" - }, - "TokenDomains": { - "description": "List of domains to accept in web request tokens, in addition to the domain of the protected resource.", - "items": { - "maxLength": 253, - "minLength": 1, - "pattern": "^[\\w\\.\\-/]+$", - "type": "string" - }, - "type": "array" - }, - "UriPath": { - "type": "object" - }, - "VisibilityConfig": { - "additionalProperties": false, - "description": "Visibility Metric of the WebACL.", - "properties": { - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "MetricName": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "SampledRequestsEnabled": { - "type": "boolean" - } - }, - "required": [ - "SampledRequestsEnabled", - "CloudWatchMetricsEnabled", - "MetricName" - ], - "type": "object" - }, - "XssMatchStatement": { - "additionalProperties": false, - "description": "Xss Match Statement.", - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - } - }, - "description": "Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.", - "handlers": { - "create": { - "permissions": [ - "wafv2:CreateWebACL", - "wafv2:GetWebACL", - "wafv2:ListTagsForResource" - ] - }, - "delete": { - "permissions": [ - "wafv2:DeleteWebACL", - "wafv2:GetWebACL" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "Scope": { - "$ref": "resource-schema.json#/properties/Scope" - } - }, - "required": [ - "Scope" - ] - }, - "permissions": [ - "wafv2:listWebACLs" - ] - }, - "read": { - "permissions": [ - "wafv2:GetWebACL", - "wafv2:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "wafv2:UpdateWebACL", - "wafv2:GetWebACL", - "wafv2:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/Name", - "/properties/Id", - "/properties/Scope" - ], - "properties": { - "Arn": { - "$ref": "#/definitions/ResourceArn" - }, - "AssociationConfig": { - "$ref": "#/definitions/AssociationConfig" - }, - "Capacity": { - "minimum": 0, - "type": "integer" - }, - "CaptchaConfig": { - "$ref": "#/definitions/CaptchaConfig" - }, - "ChallengeConfig": { - "$ref": "#/definitions/ChallengeConfig" - }, - "CustomResponseBodies": { - "$ref": "#/definitions/CustomResponseBodies" - }, - "DefaultAction": { - "$ref": "#/definitions/DefaultAction" - }, - "Description": { - "$ref": "#/definitions/EntityDescription" - }, - "Id": { - "$ref": "#/definitions/EntityId" - }, - "LabelNamespace": { - "$ref": "#/definitions/LabelName" - }, - "Name": { - "$ref": "#/definitions/EntityName" - }, - "Rules": { - "description": "Collection of Rules.", - "items": { - "$ref": "#/definitions/Rule" - }, - "type": "array" - }, - "Scope": { - "$ref": "#/definitions/Scope" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "minItems": 1, - "type": "array" - }, - "TokenDomains": { - "$ref": "#/definitions/TokenDomains" - }, - "VisibilityConfig": { - "$ref": "#/definitions/VisibilityConfig" - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Capacity", - "/properties/Id", - "/properties/LabelNamespace" - ], - "required": [ - "DefaultAction", - "Scope", - "VisibilityConfig" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::WebACL" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Scope" + ], + "definitions": { + "AWSManagedRulesACFPRuleSet": { + "additionalProperties": false, + "description": "Configures how to use the Account creation fraud prevention managed rule group in the web ACL", + "properties": { + "CreationPath": { + "type": "string" + }, + "EnableRegexInPath": { + "type": "boolean" + }, + "RegistrationPagePath": { + "type": "string" + }, + "RequestInspection": { + "$ref": "#/definitions/RequestInspectionACFP" + }, + "ResponseInspection": { + "$ref": "#/definitions/ResponseInspection" + } + }, + "required": [ + "CreationPath", + "RegistrationPagePath", + "RequestInspection" + ], + "type": "object" + }, + "AWSManagedRulesATPRuleSet": { + "additionalProperties": false, + "description": "Configures how to use the Account Takeover Prevention managed rule group in the web ACL", + "properties": { + "EnableRegexInPath": { + "type": "boolean" + }, + "LoginPath": { + "type": "string" + }, + "RequestInspection": { + "$ref": "#/definitions/RequestInspection" + }, + "ResponseInspection": { + "$ref": "#/definitions/ResponseInspection" + } + }, + "required": [ + "LoginPath" + ], + "type": "object" + }, + "AWSManagedRulesBotControlRuleSet": { + "additionalProperties": false, + "description": "Configures how to use the Bot Control managed rule group in the web ACL", + "properties": { + "EnableMachineLearning": { + "type": "boolean" + }, + "InspectionLevel": { + "enum": [ + "COMMON", + "TARGETED" + ], + "type": "string" + } + }, + "required": [ + "InspectionLevel" + ], + "type": "object" + }, + "AddressField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "AllowAction": { + "additionalProperties": false, + "description": "Allow traffic towards application.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "AndStatement": { + "additionalProperties": false, + "properties": { + "Statements": { + "items": { + "$ref": "#/definitions/Statement" + }, + "type": "array" + } + }, + "required": [ + "Statements" + ], + "type": "object" + }, + "AssociationConfig": { + "additionalProperties": false, + "description": "AssociationConfig for body inspection", + "properties": { + "RequestBody": { + "$ref": "#/definitions/RequestBody" + } + }, + "type": "object" + }, + "BlockAction": { + "additionalProperties": false, + "description": "Block traffic towards application.", + "properties": { + "CustomResponse": { + "$ref": "#/definitions/CustomResponse" + } + }, + "type": "object" + }, + "Body": { + "additionalProperties": false, + "description": "The body of a web request. This immediately follows the request headers.", + "properties": { + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "type": "object" + }, + "BodyParsingFallbackBehavior": { + "description": "The inspection behavior to fall back to if the JSON in the request body is invalid.", + "enum": [ + "MATCH", + "NO_MATCH", + "EVALUATE_AS_STRING" + ], + "type": "string" + }, + "ByteMatchStatement": { + "additionalProperties": false, + "description": "Byte Match statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "PositionalConstraint": { + "$ref": "#/definitions/PositionalConstraint" + }, + "SearchString": { + "$ref": "#/definitions/SearchString" + }, + "SearchStringBase64": { + "$ref": "#/definitions/SearchStringBase64" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "PositionalConstraint", + "TextTransformations" + ], + "type": "object" + }, + "CaptchaAction": { + "additionalProperties": false, + "description": "Checks valid token exists with request.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "CaptchaConfig": { + "additionalProperties": false, + "properties": { + "ImmunityTimeProperty": { + "$ref": "#/definitions/ImmunityTimeProperty" + } + }, + "type": "object" + }, + "ChallengeAction": { + "additionalProperties": false, + "description": "Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "ChallengeConfig": { + "additionalProperties": false, + "properties": { + "ImmunityTimeProperty": { + "$ref": "#/definitions/ImmunityTimeProperty" + } + }, + "type": "object" + }, + "CookieMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the request cookies.", + "properties": { + "All": { + "description": "Inspect all parts of the web request cookies.", + "type": "object" + }, + "ExcludedCookies": { + "items": { + "maxLength": 60, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + }, + "IncludedCookies": { + "items": { + "maxLength": 60, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Cookies": { + "additionalProperties": false, + "description": "Includes cookies of a web request.", + "properties": { + "MatchPattern": { + "$ref": "#/definitions/CookieMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/MapMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope", + "OversizeHandling" + ], + "type": "object" + }, + "CountAction": { + "additionalProperties": false, + "description": "Allow traffic towards application.", + "properties": { + "CustomRequestHandling": { + "$ref": "#/definitions/CustomRequestHandling" + } + }, + "type": "object" + }, + "CustomHTTPHeader": { + "additionalProperties": false, + "description": "HTTP header.", + "properties": { + "Name": { + "$ref": "#/definitions/CustomHTTPHeaderName" + }, + "Value": { + "$ref": "#/definitions/CustomHTTPHeaderValue" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "CustomHTTPHeaderName": { + "description": "HTTP header name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "CustomHTTPHeaderValue": { + "description": "HTTP header value.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "CustomRequestHandling": { + "additionalProperties": false, + "description": "Custom request handling.", + "properties": { + "InsertHeaders": { + "description": "Collection of HTTP headers.", + "items": { + "$ref": "#/definitions/CustomHTTPHeader" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "InsertHeaders" + ], + "type": "object" + }, + "CustomResponse": { + "additionalProperties": false, + "description": "Custom response.", + "properties": { + "CustomResponseBodyKey": { + "description": "Custom response body key.", + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "ResponseCode": { + "$ref": "#/definitions/ResponseStatusCode" + }, + "ResponseHeaders": { + "description": "Collection of HTTP headers.", + "items": { + "$ref": "#/definitions/CustomHTTPHeader" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ResponseCode" + ], + "type": "object" + }, + "CustomResponseBodies": { + "additionalProperties": false, + "description": "Custom response key and body map.", + "minProperties": 1, + "patternProperties": { + "^[\\w\\-]+$": { + "$ref": "#/definitions/CustomResponseBody" + } + }, + "type": "object" + }, + "CustomResponseBody": { + "additionalProperties": false, + "description": "Custom response body.", + "properties": { + "Content": { + "$ref": "#/definitions/ResponseContent" + }, + "ContentType": { + "$ref": "#/definitions/ResponseContentType" + } + }, + "required": [ + "ContentType", + "Content" + ], + "type": "object" + }, + "DefaultAction": { + "additionalProperties": false, + "description": "Default Action WebACL will take against ingress traffic when there is no matching Rule.", + "properties": { + "Allow": { + "$ref": "#/definitions/AllowAction" + }, + "Block": { + "$ref": "#/definitions/BlockAction" + } + }, + "type": "object" + }, + "EntityDescription": { + "description": "Description of the entity.", + "pattern": "^[a-zA-Z0-9=:#@/\\-,.][a-zA-Z0-9+=:#@/\\-,.\\s]+[a-zA-Z0-9+=:#@/\\-,.]{1,256}$", + "type": "string" + }, + "EntityId": { + "description": "Id of the WebACL", + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "type": "string" + }, + "EntityName": { + "description": "Name of the WebACL.", + "pattern": "^[0-9A-Za-z_-]{1,128}$", + "type": "string" + }, + "EvaluationWindowSec": { + "enum": [ + 60, + 120, + 300, + 600 + ], + "type": "integer" + }, + "ExcludedRule": { + "additionalProperties": false, + "description": "Excluded Rule in the RuleGroup or ManagedRuleGroup will not be evaluated.", + "properties": { + "Name": { + "$ref": "#/definitions/EntityName" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "ExcludedRules": { + "items": { + "$ref": "#/definitions/ExcludedRule" + }, + "type": "array" + }, + "FieldIdentifier": { + "additionalProperties": false, + "properties": { + "Identifier": { + "maxLength": 512, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + } + }, + "required": [ + "Identifier" + ], + "type": "object" + }, + "FieldToMatch": { + "additionalProperties": false, + "description": "Field of the request to match.", + "properties": { + "AllQueryArguments": { + "description": "All query arguments of a web request.", + "type": "object" + }, + "Body": { + "$ref": "#/definitions/Body" + }, + "Cookies": { + "$ref": "#/definitions/Cookies" + }, + "Headers": { + "$ref": "#/definitions/Headers" + }, + "JA3Fingerprint": { + "$ref": "#/definitions/JA3Fingerprint" + }, + "JsonBody": { + "$ref": "#/definitions/JsonBody" + }, + "Method": { + "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.", + "type": "object" + }, + "QueryString": { + "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any.", + "type": "object" + }, + "SingleHeader": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "SingleQueryArgument": { + "additionalProperties": false, + "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.", + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "UriPath": { + "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.", + "type": "object" + } + }, + "type": "object" + }, + "ForwardedIPConfiguration": { + "additionalProperties": false, + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "HeaderName": { + "pattern": "^[a-zA-Z0-9-]+{1,255}$", + "type": "string" + } + }, + "required": [ + "HeaderName", + "FallbackBehavior" + ], + "type": "object" + }, + "GeoMatchStatement": { + "additionalProperties": false, + "properties": { + "CountryCodes": { + "items": { + "maxLength": 2, + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "ForwardedIPConfig": { + "$ref": "#/definitions/ForwardedIPConfiguration" + } + }, + "type": "object" + }, + "HeaderMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the request headers.", + "properties": { + "All": { + "description": "Inspect all parts of the web request headers.", + "type": "object" + }, + "ExcludedHeaders": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + }, + "IncludedHeaders": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 199, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Headers": { + "additionalProperties": false, + "description": "Includes headers of a web request.", + "properties": { + "MatchPattern": { + "$ref": "#/definitions/HeaderMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/MapMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope", + "OversizeHandling" + ], + "type": "object" + }, + "IPSetForwardedIPConfiguration": { + "additionalProperties": false, + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "HeaderName": { + "pattern": "^[a-zA-Z0-9-]+{1,255}$", + "type": "string" + }, + "Position": { + "enum": [ + "FIRST", + "LAST", + "ANY" + ], + "type": "string" + } + }, + "required": [ + "HeaderName", + "FallbackBehavior", + "Position" + ], + "type": "object" + }, + "IPSetReferenceStatement": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "IPSetForwardedIPConfig": { + "$ref": "#/definitions/IPSetForwardedIPConfiguration" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "ImmunityTimeProperty": { + "additionalProperties": false, + "properties": { + "ImmunityTime": { + "maximum": 259200, + "minimum": 60, + "type": "integer" + } + }, + "required": [ + "ImmunityTime" + ], + "type": "object" + }, + "JA3Fingerprint": { + "additionalProperties": false, + "description": "Includes the JA3 fingerprint of a web request.", + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + } + }, + "required": [ + "FallbackBehavior" + ], + "type": "object" + }, + "JsonBody": { + "additionalProperties": false, + "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", + "properties": { + "InvalidFallbackBehavior": { + "$ref": "#/definitions/BodyParsingFallbackBehavior" + }, + "MatchPattern": { + "$ref": "#/definitions/JsonMatchPattern" + }, + "MatchScope": { + "$ref": "#/definitions/JsonMatchScope" + }, + "OversizeHandling": { + "$ref": "#/definitions/OversizeHandling" + } + }, + "required": [ + "MatchPattern", + "MatchScope" + ], + "type": "object" + }, + "JsonMatchPattern": { + "additionalProperties": false, + "description": "The pattern to look for in the JSON body.", + "properties": { + "All": { + "description": "Inspect all parts of the web request's JSON body.", + "type": "object" + }, + "IncludedPaths": { + "items": { + "$ref": "#/definitions/JsonPointerPath" + }, + "type": "array" + } + }, + "type": "object" + }, + "JsonMatchScope": { + "description": "The parts of the JSON to match against using the MatchPattern.", + "enum": [ + "ALL", + "KEY", + "VALUE" + ], + "type": "string" + }, + "JsonPointerPath": { + "description": "JSON pointer path in the web request's JSON body", + "pattern": "^[\\/]+([^~]*(~[01])*)*{1,512}$", + "type": "string" + }, + "Label": { + "additionalProperties": false, + "properties": { + "Name": { + "$ref": "#/definitions/LabelName" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "LabelMatchKey": { + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + }, + "LabelMatchScope": { + "enum": [ + "LABEL", + "NAMESPACE" + ], + "type": "string" + }, + "LabelMatchStatement": { + "additionalProperties": false, + "properties": { + "Key": { + "$ref": "#/definitions/LabelMatchKey" + }, + "Scope": { + "$ref": "#/definitions/LabelMatchScope" + } + }, + "required": [ + "Scope", + "Key" + ], + "type": "object" + }, + "LabelName": { + "description": "Name of the Label.", + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + }, + "ManagedRuleGroupConfig": { + "additionalProperties": false, + "description": "ManagedRuleGroupConfig.", + "properties": { + "AWSManagedRulesACFPRuleSet": { + "$ref": "#/definitions/AWSManagedRulesACFPRuleSet" + }, + "AWSManagedRulesATPRuleSet": { + "$ref": "#/definitions/AWSManagedRulesATPRuleSet" + }, + "AWSManagedRulesBotControlRuleSet": { + "$ref": "#/definitions/AWSManagedRulesBotControlRuleSet" + }, + "LoginPath": { + "maxLength": 256, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "PasswordField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "PayloadType": { + "enum": [ + "JSON", + "FORM_ENCODED" + ], + "type": "string" + }, + "UsernameField": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "type": "object" + }, + "ManagedRuleGroupStatement": { + "additionalProperties": false, + "properties": { + "ExcludedRules": { + "items": { + "$ref": "#/definitions/ExcludedRule" + }, + "type": "array" + }, + "ManagedRuleGroupConfigs": { + "description": "Collection of ManagedRuleGroupConfig.", + "items": { + "$ref": "#/definitions/ManagedRuleGroupConfig" + }, + "type": "array" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "RuleActionOverrides": { + "description": "Action overrides for rules in the rule group.", + "items": { + "$ref": "#/definitions/RuleActionOverride" + }, + "maxItems": 100, + "type": "array" + }, + "ScopeDownStatement": { + "$ref": "#/definitions/Statement" + }, + "VendorName": { + "type": "string" + }, + "Version": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w#:\\.\\-/]+$", + "type": "string" + } + }, + "required": [ + "VendorName", + "Name" + ], + "type": "object" + }, + "MapMatchScope": { + "description": "The parts of the request to match against using the MatchPattern.", + "enum": [ + "ALL", + "KEY", + "VALUE" + ], + "type": "string" + }, + "NotStatement": { + "additionalProperties": false, + "properties": { + "Statement": { + "$ref": "#/definitions/Statement" + } + }, + "required": [ + "Statement" + ], + "type": "object" + }, + "OrStatement": { + "additionalProperties": false, + "properties": { + "Statements": { + "items": { + "$ref": "#/definitions/Statement" + }, + "type": "array" + } + }, + "required": [ + "Statements" + ], + "type": "object" + }, + "OverrideAction": { + "additionalProperties": false, + "description": "Override a RuleGroup or ManagedRuleGroup behavior. This can only be applied to Rule that has RuleGroupReferenceStatement or ManagedRuleGroupReferenceStatement.", + "properties": { + "Count": { + "description": "Count traffic towards application.", + "type": "object" + }, + "None": { + "description": "Keep the RuleGroup or ManagedRuleGroup behavior as is.", + "type": "object" + } + }, + "type": "object" + }, + "OversizeHandling": { + "description": "Handling of requests containing oversize fields", + "enum": [ + "CONTINUE", + "MATCH", + "NO_MATCH" + ], + "type": "string" + }, + "PhoneNumberField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "PositionalConstraint": { + "description": "Position of the evaluation in the FieldToMatch of request.", + "enum": [ + "EXACTLY", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CONTAINS_WORD" + ], + "type": "string" + }, + "QueryString": { + "type": "object" + }, + "RateBasedStatement": { + "additionalProperties": false, + "properties": { + "AggregateKeyType": { + "enum": [ + "CONSTANT", + "IP", + "FORWARDED_IP", + "CUSTOM_KEYS" + ], + "type": "string" + }, + "CustomKeys": { + "description": "Specifies the aggregate keys to use in a rate-base rule.", + "items": { + "$ref": "#/definitions/RateBasedStatementCustomKey" + }, + "maxItems": 5, + "type": "array" + }, + "EvaluationWindowSec": { + "$ref": "#/definitions/EvaluationWindowSec" + }, + "ForwardedIPConfig": { + "$ref": "#/definitions/ForwardedIPConfiguration" + }, + "Limit": { + "$ref": "#/definitions/RateLimit" + }, + "ScopeDownStatement": { + "$ref": "#/definitions/Statement" + } + }, + "required": [ + "Limit", + "AggregateKeyType" + ], + "type": "object" + }, + "RateBasedStatementCustomKey": { + "additionalProperties": false, + "description": "Specifies a single custom aggregate key for a rate-base rule.", + "properties": { + "Cookie": { + "$ref": "#/definitions/RateLimitCookie" + }, + "ForwardedIP": { + "$ref": "#/definitions/RateLimitForwardedIP" + }, + "HTTPMethod": { + "$ref": "#/definitions/RateLimitHTTPMethod" + }, + "Header": { + "$ref": "#/definitions/RateLimitHeader" + }, + "IP": { + "$ref": "#/definitions/RateLimitIP" + }, + "LabelNamespace": { + "$ref": "#/definitions/RateLimitLabelNamespace" + }, + "QueryArgument": { + "$ref": "#/definitions/RateLimitQueryArgument" + }, + "QueryString": { + "$ref": "#/definitions/RateLimitQueryString" + }, + "UriPath": { + "$ref": "#/definitions/RateLimitUriPath" + } + }, + "type": "object" + }, + "RateLimit": { + "maximum": 2000000000, + "minimum": 100, + "type": "integer" + }, + "RateLimitCookie": { + "additionalProperties": false, + "description": "Specifies a cookie as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the cookie to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitForwardedIP": { + "description": "Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitHTTPMethod": { + "description": "Specifies the request's HTTP method as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitHeader": { + "additionalProperties": false, + "description": "Specifies a header as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the header to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitIP": { + "description": "Specifies the IP address in the web request as an aggregate key for a rate-based rule.", + "type": "object" + }, + "RateLimitLabelNamespace": { + "additionalProperties": false, + "description": "Specifies a label namespace to use as an aggregate key for a rate-based rule.", + "properties": { + "Namespace": { + "description": "The namespace to use for aggregation.", + "pattern": "^[0-9A-Za-z_:-]{1,1024}$", + "type": "string" + } + }, + "required": [ + "Namespace" + ], + "type": "object" + }, + "RateLimitQueryArgument": { + "additionalProperties": false, + "description": "Specifies a query argument in the request as an aggregate key for a rate-based rule.", + "properties": { + "Name": { + "description": "The name of the query argument to use.", + "maxLength": 64, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Name", + "TextTransformations" + ], + "type": "object" + }, + "RateLimitQueryString": { + "additionalProperties": false, + "description": "Specifies the request's query string as an aggregate key for a rate-based rule.", + "properties": { + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "TextTransformations" + ], + "type": "object" + }, + "RateLimitUriPath": { + "additionalProperties": false, + "description": "Specifies the request's URI Path as an aggregate key for a rate-based rule.", + "properties": { + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "TextTransformations" + ], + "type": "object" + }, + "RegexMatchStatement": { + "additionalProperties": false, + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "RegexString": { + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "RegexString", + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "RegexPatternSetReferenceStatement": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "Arn", + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "RequestBody": { + "additionalProperties": false, + "description": "Map of AssociatedResourceType and RequestBodyAssociatedResourceTypeConfig", + "patternProperties": { + "^(CLOUDFRONT|API_GATEWAY|COGNITO_USER_POOL|APP_RUNNER_SERVICE|VERIFIED_ACCESS_INSTANCE)$": { + "$ref": "#/definitions/RequestBodyAssociatedResourceTypeConfig" + } + }, + "type": "object" + }, + "RequestBodyAssociatedResourceTypeConfig": { + "additionalProperties": false, + "description": "Configures the inspection size in the request body.", + "properties": { + "DefaultSizeInspectionLimit": { + "$ref": "#/definitions/SizeInspectionLimit" + } + }, + "required": [ + "DefaultSizeInspectionLimit" + ], + "type": "object" + }, + "RequestInspection": { + "additionalProperties": false, + "description": "Configures the inspection of login requests", + "properties": { + "PasswordField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "PayloadType": { + "enum": [ + "JSON", + "FORM_ENCODED" + ], + "type": "string" + }, + "UsernameField": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "PayloadType", + "UsernameField", + "PasswordField" + ], + "type": "object" + }, + "RequestInspectionACFP": { + "additionalProperties": false, + "description": "Configures the inspection of sign-up requests", + "properties": { + "AddressFields": { + "items": { + "$ref": "#/definitions/AddressField" + }, + "type": "array" + }, + "EmailField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "PasswordField": { + "$ref": "#/definitions/FieldIdentifier" + }, + "PayloadType": { + "enum": [ + "JSON", + "FORM_ENCODED" + ], + "type": "string" + }, + "PhoneNumberFields": { + "items": { + "$ref": "#/definitions/PhoneNumberField" + }, + "type": "array" + }, + "UsernameField": { + "$ref": "#/definitions/FieldIdentifier" + } + }, + "required": [ + "PayloadType" + ], + "type": "object" + }, + "ResourceArn": { + "description": "ARN of the WAF entity.", + "maxLength": 2048, + "minLength": 20, + "type": "string" + }, + "ResponseContent": { + "description": "Response content.", + "maxLength": 10240, + "minLength": 1, + "type": "string" + }, + "ResponseContentType": { + "description": "Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.", + "enum": [ + "TEXT_PLAIN", + "TEXT_HTML", + "APPLICATION_JSON" + ], + "type": "string" + }, + "ResponseInspection": { + "additionalProperties": false, + "description": "Configures the inspection of login responses", + "properties": { + "BodyContains": { + "$ref": "#/definitions/ResponseInspectionBodyContains" + }, + "Header": { + "$ref": "#/definitions/ResponseInspectionHeader" + }, + "Json": { + "$ref": "#/definitions/ResponseInspectionJson" + }, + "StatusCode": { + "$ref": "#/definitions/ResponseInspectionStatusCode" + } + }, + "type": "object" + }, + "ResponseInspectionBodyContains": { + "additionalProperties": false, + "description": "Response body contents that indicate success or failure of a login request", + "properties": { + "FailureStrings": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SuccessStrings": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SuccessStrings", + "FailureStrings" + ], + "type": "object" + }, + "ResponseInspectionHeader": { + "additionalProperties": false, + "description": "Response headers that indicate success or failure of a login request", + "properties": { + "FailureValues": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + }, + "Name": { + "maxLength": 200, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "SuccessValues": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Name", + "SuccessValues", + "FailureValues" + ], + "type": "object" + }, + "ResponseInspectionJson": { + "additionalProperties": false, + "description": "Response JSON that indicate success or failure of a login request", + "properties": { + "FailureValues": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "Identifier": { + "maxLength": 512, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "SuccessValues": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": ".*\\S.*", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Identifier", + "SuccessValues", + "FailureValues" + ], + "type": "object" + }, + "ResponseInspectionStatusCode": { + "additionalProperties": false, + "description": "Response status codes that indicate success or failure of a login request", + "properties": { + "FailureCodes": { + "items": { + "maxLength": 999, + "minLength": 0, + "type": "integer" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "SuccessCodes": { + "items": { + "maxLength": 999, + "minLength": 0, + "type": "integer" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "SuccessCodes", + "FailureCodes" + ], + "type": "object" + }, + "ResponseStatusCode": { + "description": "Custom response code.", + "maximum": 599, + "minimum": 200, + "type": "integer" + }, + "Rule": { + "additionalProperties": false, + "description": "Rule of WebACL that contains condition and action.", + "properties": { + "Action": { + "$ref": "#/definitions/RuleAction" + }, + "CaptchaConfig": { + "$ref": "#/definitions/CaptchaConfig" + }, + "ChallengeConfig": { + "$ref": "#/definitions/ChallengeConfig" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "OverrideAction": { + "$ref": "#/definitions/OverrideAction" + }, + "Priority": { + "$ref": "#/definitions/RulePriority" + }, + "RuleLabels": { + "description": "Collection of Rule Labels.", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "Statement": { + "$ref": "#/definitions/Statement" + }, + "VisibilityConfig": { + "$ref": "#/definitions/VisibilityConfig" + } + }, + "required": [ + "Name", + "Priority", + "Statement", + "VisibilityConfig" + ], + "type": "object" + }, + "RuleAction": { + "additionalProperties": false, + "description": "Action taken when Rule matches its condition.", + "properties": { + "Allow": { + "$ref": "#/definitions/AllowAction" + }, + "Block": { + "$ref": "#/definitions/BlockAction" + }, + "Captcha": { + "$ref": "#/definitions/CaptchaAction" + }, + "Challenge": { + "$ref": "#/definitions/ChallengeAction" + }, + "Count": { + "$ref": "#/definitions/CountAction" + } + }, + "type": "object" + }, + "RuleActionOverride": { + "additionalProperties": false, + "description": "Action override for rules in the rule group.", + "properties": { + "ActionToUse": { + "$ref": "#/definitions/RuleAction" + }, + "Name": { + "$ref": "#/definitions/EntityName" + } + }, + "required": [ + "Name", + "ActionToUse" + ], + "type": "object" + }, + "RuleGroupReferenceStatement": { + "additionalProperties": false, + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "ExcludedRules": { + "items": { + "$ref": "#/definitions/ExcludedRule" + }, + "type": "array" + }, + "RuleActionOverrides": { + "description": "Action overrides for rules in the rule group.", + "items": { + "$ref": "#/definitions/RuleActionOverride" + }, + "maxItems": 100, + "type": "array" + } + }, + "required": [ + "Arn" + ], + "type": "object" + }, + "RulePriority": { + "description": "Priority of the Rule, Rules get evaluated from lower to higher priority.", + "minimum": 0, + "type": "integer" + }, + "Rules": { + "description": "Collection of Rules.", + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array" + }, + "Scope": { + "description": "Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.", + "enum": [ + "CLOUDFRONT", + "REGIONAL" + ], + "type": "string" + }, + "SearchString": { + "description": "String that is searched to find a match.", + "type": "string" + }, + "SearchStringBase64": { + "description": "Base64 encoded string that is searched to find a match.", + "type": "string" + }, + "SensitivityLevel": { + "description": "Sensitivity Level current only used for sqli match statements.", + "enum": [ + "LOW", + "HIGH" + ], + "type": "string" + }, + "SingleHeader": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "SingleQueryArgument": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + }, + "SizeConstraintStatement": { + "additionalProperties": false, + "description": "Size Constraint statement.", + "properties": { + "ComparisonOperator": { + "enum": [ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ], + "type": "string" + }, + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "Size": { + "maximum": 21474836480, + "minimum": 0, + "type": "number" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "ComparisonOperator", + "Size", + "TextTransformations" + ], + "type": "object" + }, + "SizeInspectionLimit": { + "enum": [ + "KB_16", + "KB_32", + "KB_48", + "KB_64" + ], + "type": "string" + }, + "SqliMatchStatement": { + "additionalProperties": false, + "description": "Sqli Match Statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "SensitivityLevel": { + "$ref": "#/definitions/SensitivityLevel" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + }, + "Statement": { + "additionalProperties": false, + "description": "First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc", + "properties": { + "AndStatement": { + "$ref": "#/definitions/AndStatement" + }, + "ByteMatchStatement": { + "$ref": "#/definitions/ByteMatchStatement" + }, + "GeoMatchStatement": { + "$ref": "#/definitions/GeoMatchStatement" + }, + "IPSetReferenceStatement": { + "$ref": "#/definitions/IPSetReferenceStatement" + }, + "LabelMatchStatement": { + "$ref": "#/definitions/LabelMatchStatement" + }, + "ManagedRuleGroupStatement": { + "$ref": "#/definitions/ManagedRuleGroupStatement" + }, + "NotStatement": { + "$ref": "#/definitions/NotStatement" + }, + "OrStatement": { + "$ref": "#/definitions/OrStatement" + }, + "RateBasedStatement": { + "$ref": "#/definitions/RateBasedStatement" + }, + "RegexMatchStatement": { + "$ref": "#/definitions/RegexMatchStatement" + }, + "RegexPatternSetReferenceStatement": { + "$ref": "#/definitions/RegexPatternSetReferenceStatement" + }, + "RuleGroupReferenceStatement": { + "$ref": "#/definitions/RuleGroupReferenceStatement" + }, + "SizeConstraintStatement": { + "$ref": "#/definitions/SizeConstraintStatement" + }, + "SqliMatchStatement": { + "$ref": "#/definitions/SqliMatchStatement" + }, + "XssMatchStatement": { + "$ref": "#/definitions/XssMatchStatement" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "TextTransformation": { + "additionalProperties": false, + "description": "Text Transformation on the Search String before match.", + "properties": { + "Priority": { + "$ref": "#/definitions/TextTransformationPriority" + }, + "Type": { + "$ref": "#/definitions/TextTransformationType" + } + }, + "required": [ + "Priority", + "Type" + ], + "type": "object" + }, + "TextTransformationPriority": { + "description": "Priority of Rule being evaluated.", + "minimum": 0, + "type": "integer" + }, + "TextTransformationType": { + "description": "Type of text transformation.", + "enum": [ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE", + "BASE64_DECODE", + "HEX_DECODE", + "MD5", + "REPLACE_COMMENTS", + "ESCAPE_SEQ_DECODE", + "SQL_HEX_DECODE", + "CSS_DECODE", + "JS_DECODE", + "NORMALIZE_PATH", + "NORMALIZE_PATH_WIN", + "REMOVE_NULLS", + "REPLACE_NULLS", + "BASE64_DECODE_EXT", + "URL_DECODE_UNI", + "UTF8_TO_UNICODE" + ], + "type": "string" + }, + "TokenDomains": { + "description": "List of domains to accept in web request tokens, in addition to the domain of the protected resource.", + "items": { + "maxLength": 253, + "minLength": 1, + "pattern": "^[\\w\\.\\-/]+$", + "type": "string" + }, + "type": "array" + }, + "UriPath": { + "type": "object" + }, + "VisibilityConfig": { + "additionalProperties": false, + "description": "Visibility Metric of the WebACL.", + "properties": { + "CloudWatchMetricsEnabled": { + "type": "boolean" + }, + "MetricName": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "SampledRequestsEnabled": { + "type": "boolean" + } + }, + "required": [ + "SampledRequestsEnabled", + "CloudWatchMetricsEnabled", + "MetricName" + ], + "type": "object" + }, + "XssMatchStatement": { + "additionalProperties": false, + "description": "Xss Match Statement.", + "properties": { + "FieldToMatch": { + "$ref": "#/definitions/FieldToMatch" + }, + "TextTransformations": { + "items": { + "$ref": "#/definitions/TextTransformation" + }, + "type": "array" + } + }, + "required": [ + "FieldToMatch", + "TextTransformations" + ], + "type": "object" + } + }, + "description": "Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.", + "handlers": { + "create": { + "permissions": [ + "wafv2:CreateWebACL", + "wafv2:GetWebACL", + "wafv2:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "wafv2:DeleteWebACL", + "wafv2:GetWebACL" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Scope": { + "$ref": "resource-schema.json#/properties/Scope" + } + }, + "required": [ + "Scope" + ] + }, + "permissions": [ + "wafv2:listWebACLs" + ] + }, + "read": { + "permissions": [ + "wafv2:GetWebACL", + "wafv2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "wafv2:UpdateWebACL", + "wafv2:GetWebACL", + "wafv2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name", + "/properties/Id", + "/properties/Scope" + ], + "properties": { + "Arn": { + "$ref": "#/definitions/ResourceArn" + }, + "AssociationConfig": { + "$ref": "#/definitions/AssociationConfig" + }, + "Capacity": { + "minimum": 0, + "type": "integer" + }, + "CaptchaConfig": { + "$ref": "#/definitions/CaptchaConfig" + }, + "ChallengeConfig": { + "$ref": "#/definitions/ChallengeConfig" + }, + "CustomResponseBodies": { + "$ref": "#/definitions/CustomResponseBodies" + }, + "DefaultAction": { + "$ref": "#/definitions/DefaultAction" + }, + "Description": { + "$ref": "#/definitions/EntityDescription" + }, + "Id": { + "$ref": "#/definitions/EntityId" + }, + "LabelNamespace": { + "$ref": "#/definitions/LabelName" + }, + "Name": { + "$ref": "#/definitions/EntityName" + }, + "Rules": { + "description": "Collection of Rules.", + "items": { + "$ref": "#/definitions/Rule" + }, + "type": "array" + }, + "Scope": { + "$ref": "#/definitions/Scope" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "minItems": 1, + "type": "array" + }, + "TokenDomains": { + "$ref": "#/definitions/TokenDomains" + }, + "VisibilityConfig": { + "$ref": "#/definitions/VisibilityConfig" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Capacity", + "/properties/Id", + "/properties/LabelNamespace" + ], + "required": [ + "DefaultAction", + "Scope", + "VisibilityConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::WebACL" +} diff --git a/schema/aws-wafv2-webaclassociation.json b/schema/aws-wafv2-webaclassociation.json index bad6d96..5e4eddf 100644 --- a/schema/aws-wafv2-webaclassociation.json +++ b/schema/aws-wafv2-webaclassociation.json @@ -1,125 +1,125 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ResourceArn", - "/properties/WebACLArn" - ], - "definitions": { - "ResourceArn": { - "maxLength": 2048, - "minLength": 20, - "type": "string" - } - }, - "description": "Associates WebACL to Application Load Balancer, CloudFront or API Gateway.", - "handlers": { - "create": { - "permissions": [ - "wafv2:AssociateWebACL", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL", - "wafv2:DisassociateWebACL", - "elasticloadbalancing:SetWebACL", - "apigateway:SetWebACL", - "appsync:SetWebACL", - "cognito-idp:AssociateWebACL", - "cognito-idp:DisassociateWebACL", - "cognito-idp:GetWebACLForResource", - "apprunner:AssociateWebAcl", - "apprunner:DisassociateWebAcl", - "apprunner:DescribeWebAclForService", - "ec2:AssociateVerifiedAccessInstanceWebAcl", - "ec2:DisassociateVerifiedAccessInstanceWebAcl", - "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", - "ec2:GetVerifiedAccessInstanceWebAcl" - ] - }, - "delete": { - "permissions": [ - "wafv2:AssociateWebACL", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL", - "wafv2:DisassociateWebACL", - "elasticloadbalancing:SetWebACL", - "apigateway:SetWebACL", - "appsync:SetWebACL", - "cognito-idp:AssociateWebACL", - "cognito-idp:DisassociateWebACL", - "cognito-idp:GetWebACLForResource", - "apprunner:AssociateWebAcl", - "apprunner:DisassociateWebAcl", - "apprunner:DescribeWebAclForService", - "ec2:AssociateVerifiedAccessInstanceWebAcl", - "ec2:DisassociateVerifiedAccessInstanceWebAcl", - "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", - "ec2:GetVerifiedAccessInstanceWebAcl" - ] - }, - "read": { - "permissions": [ - "wafv2:AssociateWebACL", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL", - "wafv2:DisassociateWebACL", - "elasticloadbalancing:SetWebACL", - "apigateway:SetWebACL", - "appsync:SetWebACL", - "cognito-idp:AssociateWebACL", - "cognito-idp:DisassociateWebACL", - "cognito-idp:GetWebACLForResource", - "apprunner:AssociateWebAcl", - "apprunner:DisassociateWebAcl", - "apprunner:DescribeWebAclForService", - "ec2:AssociateVerifiedAccessInstanceWebAcl", - "ec2:DisassociateVerifiedAccessInstanceWebAcl", - "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", - "ec2:GetVerifiedAccessInstanceWebAcl" - ] - }, - "update": { - "permissions": [ - "wafv2:AssociateWebACL", - "wafv2:GetWebACLForResource", - "wafv2:GetWebACL", - "wafv2:DisassociateWebACL", - "elasticloadbalancing:SetWebACL", - "apigateway:SetWebACL", - "appsync:SetWebACL", - "cognito-idp:AssociateWebACL", - "cognito-idp:DisassociateWebACL", - "cognito-idp:GetWebACLForResource", - "apprunner:AssociateWebAcl", - "apprunner:DisassociateWebAcl", - "apprunner:DescribeWebAclForService", - "ec2:AssociateVerifiedAccessInstanceWebAcl", - "ec2:DisassociateVerifiedAccessInstanceWebAcl", - "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", - "ec2:GetVerifiedAccessInstanceWebAcl" - ] - } - }, - "primaryIdentifier": [ - "/properties/ResourceArn", - "/properties/WebACLArn" - ], - "properties": { - "ResourceArn": { - "$ref": "#/definitions/ResourceArn" - }, - "WebACLArn": { - "$ref": "#/definitions/ResourceArn" - } - }, - "required": [ - "ResourceArn", - "WebACLArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WAFv2::WebACLAssociation" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResourceArn", + "/properties/WebACLArn" + ], + "definitions": { + "ResourceArn": { + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "description": "Associates WebACL to Application Load Balancer, CloudFront or API Gateway.", + "handlers": { + "create": { + "permissions": [ + "wafv2:AssociateWebACL", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL", + "wafv2:DisassociateWebACL", + "elasticloadbalancing:SetWebACL", + "apigateway:SetWebACL", + "appsync:SetWebACL", + "cognito-idp:AssociateWebACL", + "cognito-idp:DisassociateWebACL", + "cognito-idp:GetWebACLForResource", + "apprunner:AssociateWebAcl", + "apprunner:DisassociateWebAcl", + "apprunner:DescribeWebAclForService", + "ec2:AssociateVerifiedAccessInstanceWebAcl", + "ec2:DisassociateVerifiedAccessInstanceWebAcl", + "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", + "ec2:GetVerifiedAccessInstanceWebAcl" + ] + }, + "delete": { + "permissions": [ + "wafv2:AssociateWebACL", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL", + "wafv2:DisassociateWebACL", + "elasticloadbalancing:SetWebACL", + "apigateway:SetWebACL", + "appsync:SetWebACL", + "cognito-idp:AssociateWebACL", + "cognito-idp:DisassociateWebACL", + "cognito-idp:GetWebACLForResource", + "apprunner:AssociateWebAcl", + "apprunner:DisassociateWebAcl", + "apprunner:DescribeWebAclForService", + "ec2:AssociateVerifiedAccessInstanceWebAcl", + "ec2:DisassociateVerifiedAccessInstanceWebAcl", + "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", + "ec2:GetVerifiedAccessInstanceWebAcl" + ] + }, + "read": { + "permissions": [ + "wafv2:AssociateWebACL", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL", + "wafv2:DisassociateWebACL", + "elasticloadbalancing:SetWebACL", + "apigateway:SetWebACL", + "appsync:SetWebACL", + "cognito-idp:AssociateWebACL", + "cognito-idp:DisassociateWebACL", + "cognito-idp:GetWebACLForResource", + "apprunner:AssociateWebAcl", + "apprunner:DisassociateWebAcl", + "apprunner:DescribeWebAclForService", + "ec2:AssociateVerifiedAccessInstanceWebAcl", + "ec2:DisassociateVerifiedAccessInstanceWebAcl", + "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", + "ec2:GetVerifiedAccessInstanceWebAcl" + ] + }, + "update": { + "permissions": [ + "wafv2:AssociateWebACL", + "wafv2:GetWebACLForResource", + "wafv2:GetWebACL", + "wafv2:DisassociateWebACL", + "elasticloadbalancing:SetWebACL", + "apigateway:SetWebACL", + "appsync:SetWebACL", + "cognito-idp:AssociateWebACL", + "cognito-idp:DisassociateWebACL", + "cognito-idp:GetWebACLForResource", + "apprunner:AssociateWebAcl", + "apprunner:DisassociateWebAcl", + "apprunner:DescribeWebAclForService", + "ec2:AssociateVerifiedAccessInstanceWebAcl", + "ec2:DisassociateVerifiedAccessInstanceWebAcl", + "ec2:DescribeVerifiedAccessInstanceWebAclAssociations", + "ec2:GetVerifiedAccessInstanceWebAcl" + ] + } + }, + "primaryIdentifier": [ + "/properties/ResourceArn", + "/properties/WebACLArn" + ], + "properties": { + "ResourceArn": { + "$ref": "#/definitions/ResourceArn" + }, + "WebACLArn": { + "$ref": "#/definitions/ResourceArn" + } + }, + "required": [ + "ResourceArn", + "WebACLArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WAFv2::WebACLAssociation" +} diff --git a/schema/aws-wisdom-assistant.json b/schema/aws-wisdom-assistant.json index 203eaf5..b838b26 100644 --- a/schema/aws-wisdom-assistant.json +++ b/schema/aws-wisdom-assistant.json @@ -1,134 +1,134 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/AssistantArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/Name", - "/properties/ServerSideEncryptionConfiguration", - "/properties/Tags", - "/properties/Type" - ], - "definitions": { - "AssistantType": { - "enum": [ - "AGENT" - ], - "type": "string" - }, - "ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Wisdom::Assistant Resource Type", - "handlers": { - "create": { - "permissions": [ - "kms:CreateGrant", - "kms:DescribeKey", - "wisdom:CreateAssistant", - "wisdom:TagResource" - ] - }, - "delete": { - "permissions": [ - "wisdom:DeleteAssistant" - ] - }, - "list": { - "permissions": [ - "wisdom:ListAssistants" - ] - }, - "read": { - "permissions": [ - "wisdom:GetAssistant" - ] - }, - "update": { - "permissions": [ - "wisdom:GetAssistant" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssistantId" - ], - "properties": { - "AssistantArn": { - "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", - "type": "string" - }, - "AssistantId": { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/ServerSideEncryptionConfiguration" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - }, - "Type": { - "$ref": "#/definitions/AssistantType" - } - }, - "readOnlyProperties": [ - "/properties/AssistantId", - "/properties/AssistantArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Name", - "Type" - ], - "taggable": false, - "typeName": "AWS::Wisdom::Assistant" -} +{ + "additionalIdentifiers": [ + [ + "/properties/AssistantArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/ServerSideEncryptionConfiguration", + "/properties/Tags", + "/properties/Type" + ], + "definitions": { + "AssistantType": { + "enum": [ + "AGENT" + ], + "type": "string" + }, + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Wisdom::Assistant Resource Type", + "handlers": { + "create": { + "permissions": [ + "kms:CreateGrant", + "kms:DescribeKey", + "wisdom:CreateAssistant", + "wisdom:TagResource" + ] + }, + "delete": { + "permissions": [ + "wisdom:DeleteAssistant" + ] + }, + "list": { + "permissions": [ + "wisdom:ListAssistants" + ] + }, + "read": { + "permissions": [ + "wisdom:GetAssistant" + ] + }, + "update": { + "permissions": [ + "wisdom:GetAssistant" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssistantId" + ], + "properties": { + "AssistantArn": { + "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", + "type": "string" + }, + "AssistantId": { + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "Type": { + "$ref": "#/definitions/AssistantType" + } + }, + "readOnlyProperties": [ + "/properties/AssistantId", + "/properties/AssistantArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Name", + "Type" + ], + "taggable": false, + "typeName": "AWS::Wisdom::Assistant" +} diff --git a/schema/aws-wisdom-assistantassociation.json b/schema/aws-wisdom-assistantassociation.json index 84ecafe..ed6fcef 100644 --- a/schema/aws-wisdom-assistantassociation.json +++ b/schema/aws-wisdom-assistantassociation.json @@ -1,146 +1,146 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/AssistantAssociationArn", - "/properties/AssistantArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Association", - "/properties/AssociationType", - "/properties/AssistantId", - "/properties/Tags" - ], - "definitions": { - "AssociationData": { - "additionalProperties": false, - "properties": { - "KnowledgeBaseId": { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - } - }, - "required": [ - "KnowledgeBaseId" - ], - "type": "object" - }, - "AssociationType": { - "enum": [ - "KNOWLEDGE_BASE" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Wisdom::AssistantAssociation Resource Type", - "handlers": { - "create": { - "permissions": [ - "wisdom:CreateAssistantAssociation", - "wisdom:TagResource" - ] - }, - "delete": { - "permissions": [ - "wisdom:DeleteAssistantAssociation" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "AssistantId": { - "$ref": "resource-schema.json#/properties/AssistantId" - } - }, - "required": [ - "AssistantId" - ] - }, - "permissions": [ - "wisdom:ListAssistantAssociations" - ] - }, - "read": { - "permissions": [ - "wisdom:GetAssistantAssociation" - ] - }, - "update": { - "permissions": [ - "wisdom:GetAssistantAssociation" - ] - } - }, - "primaryIdentifier": [ - "/properties/AssistantAssociationId", - "/properties/AssistantId" - ], - "properties": { - "AssistantArn": { - "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", - "type": "string" - }, - "AssistantAssociationArn": { - "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", - "type": "string" - }, - "AssistantAssociationId": { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "AssistantId": { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "Association": { - "$ref": "#/definitions/AssociationData" - }, - "AssociationType": { - "$ref": "#/definitions/AssociationType" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/AssistantAssociationId", - "/properties/AssistantAssociationArn", - "/properties/AssistantArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "Association", - "AssociationType", - "AssistantId" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk", - "taggable": false, - "typeName": "AWS::Wisdom::AssistantAssociation" -} +{ + "additionalIdentifiers": [ + [ + "/properties/AssistantAssociationArn", + "/properties/AssistantArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Association", + "/properties/AssociationType", + "/properties/AssistantId", + "/properties/Tags" + ], + "definitions": { + "AssociationData": { + "additionalProperties": false, + "properties": { + "KnowledgeBaseId": { + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + } + }, + "required": [ + "KnowledgeBaseId" + ], + "type": "object" + }, + "AssociationType": { + "enum": [ + "KNOWLEDGE_BASE" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Wisdom::AssistantAssociation Resource Type", + "handlers": { + "create": { + "permissions": [ + "wisdom:CreateAssistantAssociation", + "wisdom:TagResource" + ] + }, + "delete": { + "permissions": [ + "wisdom:DeleteAssistantAssociation" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AssistantId": { + "$ref": "resource-schema.json#/properties/AssistantId" + } + }, + "required": [ + "AssistantId" + ] + }, + "permissions": [ + "wisdom:ListAssistantAssociations" + ] + }, + "read": { + "permissions": [ + "wisdom:GetAssistantAssociation" + ] + }, + "update": { + "permissions": [ + "wisdom:GetAssistantAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssistantAssociationId", + "/properties/AssistantId" + ], + "properties": { + "AssistantArn": { + "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", + "type": "string" + }, + "AssistantAssociationArn": { + "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", + "type": "string" + }, + "AssistantAssociationId": { + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "AssistantId": { + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "Association": { + "$ref": "#/definitions/AssociationData" + }, + "AssociationType": { + "$ref": "#/definitions/AssociationType" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/AssistantAssociationId", + "/properties/AssistantAssociationArn", + "/properties/AssistantArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "Association", + "AssociationType", + "AssistantId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk", + "taggable": false, + "typeName": "AWS::Wisdom::AssistantAssociation" +} diff --git a/schema/aws-wisdom-knowledgebase.json b/schema/aws-wisdom-knowledgebase.json index 6322ad9..f5511f5 100644 --- a/schema/aws-wisdom-knowledgebase.json +++ b/schema/aws-wisdom-knowledgebase.json @@ -1,206 +1,206 @@ -{ - "additionalIdentifiers": [ - [ - "/properties/KnowledgeBaseArn" - ] - ], - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/Description", - "/properties/KnowledgeBaseType", - "/properties/Name", - "/properties/ServerSideEncryptionConfiguration", - "/properties/SourceConfiguration", - "/properties/Tags" - ], - "definitions": { - "AppIntegrationsConfiguration": { - "additionalProperties": false, - "properties": { - "AppIntegrationArn": { - "maxLength": 2048, - "minLength": 1, - "pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$", - "type": "string" - }, - "ObjectFields": { - "insertionOrder": false, - "items": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "AppIntegrationArn" - ], - "type": "object" - }, - "KnowledgeBaseType": { - "enum": [ - "EXTERNAL", - "CUSTOM" - ], - "type": "string" - }, - "RenderingConfiguration": { - "additionalProperties": false, - "properties": { - "TemplateUri": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "maxLength": 4096, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "SourceConfiguration": { - "additionalProperties": false, - "oneOf": [ - { - "required": [ - "AppIntegrations" - ] - } - ], - "properties": { - "AppIntegrations": { - "$ref": "#/definitions/AppIntegrationsConfiguration" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::Wisdom::KnowledgeBase Resource Type", - "handlers": { - "create": { - "permissions": [ - "appflow:CreateFlow", - "appflow:DeleteFlow", - "appflow:StartFlow", - "appflow:TagResource", - "appflow:UseConnectorProfile", - "app-integrations:CreateDataIntegrationAssociation", - "app-integrations:GetDataIntegration", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:ListGrants", - "wisdom:CreateKnowledgeBase", - "wisdom:TagResource" - ] - }, - "delete": { - "permissions": [ - "appflow:DeleteFlow", - "appflow:StopFlow", - "app-integrations:DeleteDataIntegrationAssociation", - "wisdom:DeleteKnowledgeBase" - ] - }, - "list": { - "permissions": [ - "wisdom:ListKnowledgeBases" - ] - }, - "read": { - "permissions": [ - "wisdom:GetKnowledgeBase" - ] - }, - "update": { - "permissions": [ - "wisdom:GetKnowledgeBase" - ] - } - }, - "primaryIdentifier": [ - "/properties/KnowledgeBaseId" - ], - "properties": { - "Description": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "KnowledgeBaseArn": { - "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", - "type": "string" - }, - "KnowledgeBaseId": { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", - "type": "string" - }, - "KnowledgeBaseType": { - "$ref": "#/definitions/KnowledgeBaseType" - }, - "Name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "RenderingConfiguration": { - "$ref": "#/definitions/RenderingConfiguration" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/ServerSideEncryptionConfiguration" - }, - "SourceConfiguration": { - "$ref": "#/definitions/SourceConfiguration" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": true - } - }, - "readOnlyProperties": [ - "/properties/KnowledgeBaseId", - "/properties/KnowledgeBaseArn" - ], - "replacementStrategy": "delete_then_create", - "required": [ - "KnowledgeBaseType", - "Name" - ], - "taggable": false, - "typeName": "AWS::Wisdom::KnowledgeBase" -} +{ + "additionalIdentifiers": [ + [ + "/properties/KnowledgeBaseArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/KnowledgeBaseType", + "/properties/Name", + "/properties/ServerSideEncryptionConfiguration", + "/properties/SourceConfiguration", + "/properties/Tags" + ], + "definitions": { + "AppIntegrationsConfiguration": { + "additionalProperties": false, + "properties": { + "AppIntegrationArn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$", + "type": "string" + }, + "ObjectFields": { + "insertionOrder": false, + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "AppIntegrationArn" + ], + "type": "object" + }, + "KnowledgeBaseType": { + "enum": [ + "EXTERNAL", + "CUSTOM" + ], + "type": "string" + }, + "RenderingConfiguration": { + "additionalProperties": false, + "properties": { + "TemplateUri": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SourceConfiguration": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "AppIntegrations" + ] + } + ], + "properties": { + "AppIntegrations": { + "$ref": "#/definitions/AppIntegrationsConfiguration" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Wisdom::KnowledgeBase Resource Type", + "handlers": { + "create": { + "permissions": [ + "appflow:CreateFlow", + "appflow:DeleteFlow", + "appflow:StartFlow", + "appflow:TagResource", + "appflow:UseConnectorProfile", + "app-integrations:CreateDataIntegrationAssociation", + "app-integrations:GetDataIntegration", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:ListGrants", + "wisdom:CreateKnowledgeBase", + "wisdom:TagResource" + ] + }, + "delete": { + "permissions": [ + "appflow:DeleteFlow", + "appflow:StopFlow", + "app-integrations:DeleteDataIntegrationAssociation", + "wisdom:DeleteKnowledgeBase" + ] + }, + "list": { + "permissions": [ + "wisdom:ListKnowledgeBases" + ] + }, + "read": { + "permissions": [ + "wisdom:GetKnowledgeBase" + ] + }, + "update": { + "permissions": [ + "wisdom:GetKnowledgeBase" + ] + } + }, + "primaryIdentifier": [ + "/properties/KnowledgeBaseId" + ], + "properties": { + "Description": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "KnowledgeBaseArn": { + "pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$", + "type": "string" + }, + "KnowledgeBaseId": { + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "KnowledgeBaseType": { + "$ref": "#/definitions/KnowledgeBaseType" + }, + "Name": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "RenderingConfiguration": { + "$ref": "#/definitions/RenderingConfiguration" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration" + }, + "SourceConfiguration": { + "$ref": "#/definitions/SourceConfiguration" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/KnowledgeBaseId", + "/properties/KnowledgeBaseArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "KnowledgeBaseType", + "Name" + ], + "taggable": false, + "typeName": "AWS::Wisdom::KnowledgeBase" +} diff --git a/schema/aws-workspaces-connectionalias.json b/schema/aws-workspaces-connectionalias.json index 51cfba8..4388bf4 100644 --- a/schema/aws-workspaces-connectionalias.json +++ b/schema/aws-workspaces-connectionalias.json @@ -1,123 +1,123 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ConnectionString", - "/properties/Tags" - ], - "definitions": { - "ConnectionAliasAssociation": { - "additionalProperties": false, - "properties": { - "AssociatedAccountId": { - "type": "string" - }, - "AssociationStatus": { - "enum": [ - "NOT_ASSOCIATED", - "PENDING_ASSOCIATION", - "ASSOCIATED_WITH_OWNER_ACCOUNT", - "ASSOCIATED_WITH_SHARED_ACCOUNT", - "PENDING_DISASSOCIATION" - ], - "type": "string" - }, - "ConnectionIdentifier": { - "maxLength": 20, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "ResourceId": { - "maxLength": 1000, - "minLength": 1, - "pattern": ".+", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WorkSpaces::ConnectionAlias", - "handlers": { - "create": { - "permissions": [ - "workspaces:CreateConnectionAlias" - ] - }, - "delete": { - "permissions": [ - "workspaces:DeleteConnectionAlias" - ] - }, - "read": { - "permissions": [ - "workspaces:DescribeConnectionAliases" - ] - } - }, - "primaryIdentifier": [ - "/properties/AliasId" - ], - "properties": { - "AliasId": { - "maxLength": 68, - "minLength": 13, - "pattern": "^wsca-[0-9a-z]{8,63}$", - "type": "string" - }, - "Associations": { - "items": { - "$ref": "#/definitions/ConnectionAliasAssociation" - }, - "maxLength": 25, - "minLength": 1, - "type": "array" - }, - "ConnectionAliasState": { - "enum": [ - "CREATING", - "CREATED", - "DELETING" - ], - "type": "string" - }, - "ConnectionString": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[.0-9a-zA-Z\\-]{1,255}$", - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - } - }, - "readOnlyProperties": [ - "/properties/ConnectionAliasState", - "/properties/AliasId", - "/properties/Associations" - ], - "required": [ - "ConnectionString" - ], - "typeName": "AWS::WorkSpaces::ConnectionAlias" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectionString", + "/properties/Tags" + ], + "definitions": { + "ConnectionAliasAssociation": { + "additionalProperties": false, + "properties": { + "AssociatedAccountId": { + "type": "string" + }, + "AssociationStatus": { + "enum": [ + "NOT_ASSOCIATED", + "PENDING_ASSOCIATION", + "ASSOCIATED_WITH_OWNER_ACCOUNT", + "ASSOCIATED_WITH_SHARED_ACCOUNT", + "PENDING_DISASSOCIATION" + ], + "type": "string" + }, + "ConnectionIdentifier": { + "maxLength": 20, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "ResourceId": { + "maxLength": 1000, + "minLength": 1, + "pattern": ".+", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WorkSpaces::ConnectionAlias", + "handlers": { + "create": { + "permissions": [ + "workspaces:CreateConnectionAlias" + ] + }, + "delete": { + "permissions": [ + "workspaces:DeleteConnectionAlias" + ] + }, + "read": { + "permissions": [ + "workspaces:DescribeConnectionAliases" + ] + } + }, + "primaryIdentifier": [ + "/properties/AliasId" + ], + "properties": { + "AliasId": { + "maxLength": 68, + "minLength": 13, + "pattern": "^wsca-[0-9a-z]{8,63}$", + "type": "string" + }, + "Associations": { + "items": { + "$ref": "#/definitions/ConnectionAliasAssociation" + }, + "maxLength": 25, + "minLength": 1, + "type": "array" + }, + "ConnectionAliasState": { + "enum": [ + "CREATING", + "CREATED", + "DELETING" + ], + "type": "string" + }, + "ConnectionString": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[.0-9a-zA-Z\\-]{1,255}$", + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ConnectionAliasState", + "/properties/AliasId", + "/properties/Associations" + ], + "required": [ + "ConnectionString" + ], + "typeName": "AWS::WorkSpaces::ConnectionAlias" +} diff --git a/schema/aws-workspaces-workspace.json b/schema/aws-workspaces-workspace.json index aa16715..b399c5f 100644 --- a/schema/aws-workspaces-workspace.json +++ b/schema/aws-workspaces-workspace.json @@ -1,91 +1,91 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/UserName" - ], - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Value", - "Key" - ], - "type": "object" - }, - "WorkspaceProperties": { - "additionalProperties": false, - "properties": { - "ComputeTypeName": { - "type": "string" - }, - "RootVolumeSizeGib": { - "type": "integer" - }, - "RunningMode": { - "type": "string" - }, - "RunningModeAutoStopTimeoutInMinutes": { - "type": "integer" - }, - "UserVolumeSizeGib": { - "type": "integer" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::WorkSpaces::Workspace", - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "BundleId": { - "type": "string" - }, - "DirectoryId": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "RootVolumeEncryptionEnabled": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "UserName": { - "type": "string" - }, - "UserVolumeEncryptionEnabled": { - "type": "boolean" - }, - "VolumeEncryptionKey": { - "type": "string" - }, - "WorkspaceProperties": { - "$ref": "#/definitions/WorkspaceProperties" - } - }, - "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "BundleId", - "DirectoryId", - "UserName" - ], - "typeName": "AWS::WorkSpaces::Workspace" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserName" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "WorkspaceProperties": { + "additionalProperties": false, + "properties": { + "ComputeTypeName": { + "type": "string" + }, + "RootVolumeSizeGib": { + "type": "integer" + }, + "RunningMode": { + "type": "string" + }, + "RunningModeAutoStopTimeoutInMinutes": { + "type": "integer" + }, + "UserVolumeSizeGib": { + "type": "integer" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::WorkSpaces::Workspace", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "BundleId": { + "type": "string" + }, + "DirectoryId": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "RootVolumeEncryptionEnabled": { + "type": "boolean" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "UserName": { + "type": "string" + }, + "UserVolumeEncryptionEnabled": { + "type": "boolean" + }, + "VolumeEncryptionKey": { + "type": "string" + }, + "WorkspaceProperties": { + "$ref": "#/definitions/WorkspaceProperties" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "BundleId", + "DirectoryId", + "UserName" + ], + "typeName": "AWS::WorkSpaces::Workspace" +} diff --git a/schema/aws-workspaces-workspacespool.json b/schema/aws-workspaces-workspacespool.json index 9bc3cf6..7369f67 100644 --- a/schema/aws-workspaces-workspacespool.json +++ b/schema/aws-workspaces-workspacespool.json @@ -1,193 +1,193 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PoolName" - ], - "definitions": { - "ApplicationSettings": { - "additionalProperties": false, - "properties": { - "SettingsGroup": { - "maxLength": 100, - "pattern": "^[A-Za-z0-9_./()!*'-]+$", - "type": "string" - }, - "Status": { - "$ref": "#/definitions/ApplicationSettingsStatus" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "ApplicationSettingsStatus": { - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "Capacity": { - "additionalProperties": false, - "properties": { - "DesiredUserSessions": { - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "DesiredUserSessions" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "TimeoutSettings": { - "additionalProperties": false, - "properties": { - "DisconnectTimeoutInSeconds": { - "maximum": 36000, - "minimum": 60, - "type": "integer" - }, - "IdleDisconnectTimeoutInSeconds": { - "maximum": 36000, - "minimum": 0, - "type": "integer" - }, - "MaxUserDurationInSeconds": { - "maximum": 432000, - "minimum": 600, - "type": "integer" - } - }, - "required": [], - "type": "object" - } - }, - "deprecatedProperties": [ - "/properties/Tags/TagKey", - "/properties/Tags/TagValue" - ], - "description": "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", - "handlers": { - "create": { - "permissions": [ - "workspaces:CreateWorkspacesPool", - "workspaces:DescribeWorkspacesPools", - "workspaces:CreateTags" - ] - }, - "delete": { - "permissions": [ - "workspaces:DescribeWorkspacesPools", - "workspaces:TerminateWorkspacesPool" - ] - }, - "list": { - "permissions": [ - "workspaces:DescribeWorkspacesPools" - ] - }, - "read": { - "permissions": [ - "workspaces:DescribeWorkspacesPools" - ] - }, - "update": { - "permissions": [ - "workspaces:UpdateWorkspacesPool" - ] - } - }, - "primaryIdentifier": [ - "/properties/PoolId" - ], - "properties": { - "ApplicationSettings": { - "$ref": "#/definitions/ApplicationSettings" - }, - "BundleId": { - "pattern": "^wsb-[0-9a-z]{8,63}$", - "type": "string" - }, - "Capacity": { - "$ref": "#/definitions/Capacity" - }, - "CreatedAt": { - "type": "string" - }, - "Description": { - "maxLength": 255, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_./() -]+$", - "type": "string" - }, - "DirectoryId": { - "maxLength": 65, - "minLength": 10, - "pattern": "^wsd-[0-9a-z]{8,63}$", - "type": "string" - }, - "PoolArn": { - "pattern": "^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$", - "type": "string" - }, - "PoolId": { - "pattern": "^wspool-[0-9a-z]{9}$", - "type": "string" - }, - "PoolName": { - "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array", - "uniqueItems": false - }, - "TimeoutSettings": { - "$ref": "#/definitions/TimeoutSettings" - } - }, - "readOnlyProperties": [ - "/properties/PoolId", - "/properties/PoolArn", - "/properties/CreatedAt" - ], - "required": [ - "PoolName", - "BundleId", - "DirectoryId", - "Capacity" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": false, - "taggable": true - }, - "typeName": "AWS::WorkSpaces::WorkspacesPool", - "writeOnlyProperties": [ - "/properties/Tags" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PoolName" + ], + "definitions": { + "ApplicationSettings": { + "additionalProperties": false, + "properties": { + "SettingsGroup": { + "maxLength": 100, + "pattern": "^[A-Za-z0-9_./()!*'-]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ApplicationSettingsStatus" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "ApplicationSettingsStatus": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "Capacity": { + "additionalProperties": false, + "properties": { + "DesiredUserSessions": { + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "DesiredUserSessions" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TimeoutSettings": { + "additionalProperties": false, + "properties": { + "DisconnectTimeoutInSeconds": { + "maximum": 36000, + "minimum": 60, + "type": "integer" + }, + "IdleDisconnectTimeoutInSeconds": { + "maximum": 36000, + "minimum": 0, + "type": "integer" + }, + "MaxUserDurationInSeconds": { + "maximum": 432000, + "minimum": 600, + "type": "integer" + } + }, + "required": [], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/Tags/TagKey", + "/properties/Tags/TagValue" + ], + "description": "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", + "handlers": { + "create": { + "permissions": [ + "workspaces:CreateWorkspacesPool", + "workspaces:DescribeWorkspacesPools", + "workspaces:CreateTags" + ] + }, + "delete": { + "permissions": [ + "workspaces:DescribeWorkspacesPools", + "workspaces:TerminateWorkspacesPool" + ] + }, + "list": { + "permissions": [ + "workspaces:DescribeWorkspacesPools" + ] + }, + "read": { + "permissions": [ + "workspaces:DescribeWorkspacesPools" + ] + }, + "update": { + "permissions": [ + "workspaces:UpdateWorkspacesPool" + ] + } + }, + "primaryIdentifier": [ + "/properties/PoolId" + ], + "properties": { + "ApplicationSettings": { + "$ref": "#/definitions/ApplicationSettings" + }, + "BundleId": { + "pattern": "^wsb-[0-9a-z]{8,63}$", + "type": "string" + }, + "Capacity": { + "$ref": "#/definitions/Capacity" + }, + "CreatedAt": { + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_./() -]+$", + "type": "string" + }, + "DirectoryId": { + "maxLength": 65, + "minLength": 10, + "pattern": "^wsd-[0-9a-z]{8,63}$", + "type": "string" + }, + "PoolArn": { + "pattern": "^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$", + "type": "string" + }, + "PoolId": { + "pattern": "^wspool-[0-9a-z]{9}$", + "type": "string" + }, + "PoolName": { + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TimeoutSettings": { + "$ref": "#/definitions/TimeoutSettings" + } + }, + "readOnlyProperties": [ + "/properties/PoolId", + "/properties/PoolArn", + "/properties/CreatedAt" + ], + "required": [ + "PoolName", + "BundleId", + "DirectoryId", + "Capacity" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::WorkSpaces::WorkspacesPool", + "writeOnlyProperties": [ + "/properties/Tags" + ] +} diff --git a/schema/aws-workspacesthinclient-environment.json b/schema/aws-workspacesthinclient-environment.json index e687949..b263e68 100644 --- a/schema/aws-workspacesthinclient-environment.json +++ b/schema/aws-workspacesthinclient-environment.json @@ -1,319 +1,319 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/KmsKeyArn", - "/properties/DesktopArn" - ], - "definitions": { - "DayOfWeek": { - "enum": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ], - "type": "string" - }, - "Hour": { - "maximum": 23, - "minimum": 0, - "type": "integer" - }, - "MaintenanceWindow": { - "additionalProperties": false, - "properties": { - "ApplyTimeOf": { - "description": "The desired time zone maintenance window.", - "enum": [ - "UTC", - "DEVICE" - ], - "type": "string" - }, - "DaysOfTheWeek": { - "description": "The date of maintenance window.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/DayOfWeek" - }, - "maxItems": 7, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "EndTimeHour": { - "$ref": "#/definitions/Hour", - "description": "The hour end time of maintenance window." - }, - "EndTimeMinute": { - "$ref": "#/definitions/Minute", - "description": "The minute end time of maintenance window." - }, - "StartTimeHour": { - "$ref": "#/definitions/Hour", - "description": "The hour start time of maintenance window." - }, - "StartTimeMinute": { - "$ref": "#/definitions/Minute", - "description": "The minute start time of maintenance window." - }, - "Type": { - "description": "The type of maintenance window.", - "enum": [ - "SYSTEM", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Minute": { - "maximum": 59, - "minimum": 0, - "type": "integer" - }, - "Tag": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "properties": { - "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 128, - "minLength": 1, - "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", - "type": "string" - }, - "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", - "maxLength": 256, - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Resource type definition for AWS::WorkSpacesThinClient::Environment.", - "handlers": { - "create": { - "permissions": [ - "thinclient:CreateEnvironment", - "thinclient:TagResource", - "thinclient:ListTagsForResource", - "appstream:DescribeStacks", - "workspaces:DescribeWorkspaceDirectories", - "workspaces-web:GetPortal", - "workspaces-web:GetUserSettings", - "kms:DescribeKey", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "thinclient:DeleteEnvironment", - "thinclient:UntagResource", - "kms:Decrypt", - "kms:RetireGrant" - ] - }, - "list": { - "permissions": [ - "thinclient:ListEnvironment", - "thinclient:ListTagsForResource", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "thinclient:GetEnvironment", - "thinclient:ListTagsForResource", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "appstream:DescribeStacks", - "workspaces:DescribeWorkspaceDirectories", - "workspaces-web:GetPortal", - "workspaces-web:GetUserSettings", - "thinclient:UpdateEnvironment", - "thinclient:ListTagsForResource", - "thinclient:TagResource", - "thinclient:UntagResource", - "kms:Decrypt", - "kms:GenerateDataKey" - ] - } - }, - "primaryIdentifier": [ - "/properties/Id" - ], - "properties": { - "ActivationCode": { - "description": "Activation code for devices associated with environment.", - "pattern": "^[a-z]{2}[a-z0-9]{6}$", - "type": "string" - }, - "Arn": { - "description": "The environment ARN.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+$", - "type": "string" - }, - "CreatedAt": { - "description": "The timestamp in unix epoch format when environment was created.", - "type": "string" - }, - "DesiredSoftwareSetId": { - "description": "The ID of the software set to apply.", - "pattern": "^[0-9]{1,9}$", - "type": "string" - }, - "DesktopArn": { - "description": "The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+$", - "type": "string" - }, - "DesktopEndpoint": { - "description": "The URL for the identity provider login (only for environments that use AppStream 2.0).", - "maxLength": 1024, - "minLength": 1, - "pattern": "^(https:\\/\\/)[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,32}(:[0-9]{1,5})?(\\/.*)?$", - "type": "string" - }, - "DesktopType": { - "description": "The type of VDI.", - "enum": [ - "workspaces", - "appstream", - "workspaces-web" - ], - "type": "string" - }, - "DeviceCreationTags": { - "description": "An array of key-value pairs to apply to the newly created devices for this environment.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "Id": { - "description": "Unique identifier of the environment.", - "pattern": "^[a-z0-9]{9}$", - "type": "string" - }, - "KmsKeyArn": { - "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.", - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[0-9]{0,12}:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "MaintenanceWindow": { - "$ref": "#/definitions/MaintenanceWindow", - "description": "A specification for a time window to apply software updates." - }, - "Name": { - "description": "The name of the environment.", - "maxLength": 64, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "PendingSoftwareSetId": { - "description": "The ID of the software set that is pending to be installed.", - "pattern": "^[0-9]{1,9}$", - "type": "string" - }, - "PendingSoftwareSetVersion": { - "description": "The version of the software set that is pending to be installed.", - "type": "string" - }, - "RegisteredDevicesCount": { - "description": "Number of devices registered to the environment.", - "minimum": 0, - "type": "integer" - }, - "SoftwareSetComplianceStatus": { - "description": "Describes if the software currently installed on all devices in the environment is a supported version.", - "enum": [ - "COMPLIANT", - "NOT_COMPLIANT", - "NO_REGISTERED_DEVICES" - ], - "type": "string" - }, - "SoftwareSetUpdateMode": { - "description": "An option to define which software updates to apply.", - "enum": [ - "USE_LATEST", - "USE_DESIRED" - ], - "type": "string" - }, - "SoftwareSetUpdateSchedule": { - "description": "An option to define if software updates should be applied within a maintenance window.", - "enum": [ - "USE_MAINTENANCE_WINDOW", - "APPLY_IMMEDIATELY" - ], - "type": "string" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 50, - "type": "array", - "uniqueItems": true - }, - "UpdatedAt": { - "description": "The timestamp in unix epoch format when environment was last updated.", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/Id", - "/properties/ActivationCode", - "/properties/Arn", - "/properties/CreatedAt", - "/properties/DesktopType", - "/properties/RegisteredDevicesCount", - "/properties/UpdatedAt", - "/properties/PendingSoftwareSetId", - "/properties/PendingSoftwareSetVersion", - "/properties/SoftwareSetComplianceStatus" - ], - "required": [ - "DesktopArn" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesThinClient::Environment" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn", + "/properties/DesktopArn" + ], + "definitions": { + "DayOfWeek": { + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "type": "string" + }, + "Hour": { + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "MaintenanceWindow": { + "additionalProperties": false, + "properties": { + "ApplyTimeOf": { + "description": "The desired time zone maintenance window.", + "enum": [ + "UTC", + "DEVICE" + ], + "type": "string" + }, + "DaysOfTheWeek": { + "description": "The date of maintenance window.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "maxItems": 7, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EndTimeHour": { + "$ref": "#/definitions/Hour", + "description": "The hour end time of maintenance window." + }, + "EndTimeMinute": { + "$ref": "#/definitions/Minute", + "description": "The minute end time of maintenance window." + }, + "StartTimeHour": { + "$ref": "#/definitions/Hour", + "description": "The hour start time of maintenance window." + }, + "StartTimeMinute": { + "$ref": "#/definitions/Minute", + "description": "The minute start time of maintenance window." + }, + "Type": { + "description": "The type of maintenance window.", + "enum": [ + "SYSTEM", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "Minute": { + "maximum": 59, + "minimum": 0, + "type": "integer" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource type definition for AWS::WorkSpacesThinClient::Environment.", + "handlers": { + "create": { + "permissions": [ + "thinclient:CreateEnvironment", + "thinclient:TagResource", + "thinclient:ListTagsForResource", + "appstream:DescribeStacks", + "workspaces:DescribeWorkspaceDirectories", + "workspaces-web:GetPortal", + "workspaces-web:GetUserSettings", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "thinclient:DeleteEnvironment", + "thinclient:UntagResource", + "kms:Decrypt", + "kms:RetireGrant" + ] + }, + "list": { + "permissions": [ + "thinclient:ListEnvironment", + "thinclient:ListTagsForResource", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "thinclient:GetEnvironment", + "thinclient:ListTagsForResource", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "appstream:DescribeStacks", + "workspaces:DescribeWorkspaceDirectories", + "workspaces-web:GetPortal", + "workspaces-web:GetUserSettings", + "thinclient:UpdateEnvironment", + "thinclient:ListTagsForResource", + "thinclient:TagResource", + "thinclient:UntagResource", + "kms:Decrypt", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ActivationCode": { + "description": "Activation code for devices associated with environment.", + "pattern": "^[a-z]{2}[a-z0-9]{6}$", + "type": "string" + }, + "Arn": { + "description": "The environment ARN.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp in unix epoch format when environment was created.", + "type": "string" + }, + "DesiredSoftwareSetId": { + "description": "The ID of the software set to apply.", + "pattern": "^[0-9]{1,9}$", + "type": "string" + }, + "DesktopArn": { + "description": "The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+$", + "type": "string" + }, + "DesktopEndpoint": { + "description": "The URL for the identity provider login (only for environments that use AppStream 2.0).", + "maxLength": 1024, + "minLength": 1, + "pattern": "^(https:\\/\\/)[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,32}(:[0-9]{1,5})?(\\/.*)?$", + "type": "string" + }, + "DesktopType": { + "description": "The type of VDI.", + "enum": [ + "workspaces", + "appstream", + "workspaces-web" + ], + "type": "string" + }, + "DeviceCreationTags": { + "description": "An array of key-value pairs to apply to the newly created devices for this environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "Unique identifier of the environment.", + "pattern": "^[a-z0-9]{9}$", + "type": "string" + }, + "KmsKeyArn": { + "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[0-9]{0,12}:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "MaintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "A specification for a time window to apply software updates." + }, + "Name": { + "description": "The name of the environment.", + "maxLength": 64, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "PendingSoftwareSetId": { + "description": "The ID of the software set that is pending to be installed.", + "pattern": "^[0-9]{1,9}$", + "type": "string" + }, + "PendingSoftwareSetVersion": { + "description": "The version of the software set that is pending to be installed.", + "type": "string" + }, + "RegisteredDevicesCount": { + "description": "Number of devices registered to the environment.", + "minimum": 0, + "type": "integer" + }, + "SoftwareSetComplianceStatus": { + "description": "Describes if the software currently installed on all devices in the environment is a supported version.", + "enum": [ + "COMPLIANT", + "NOT_COMPLIANT", + "NO_REGISTERED_DEVICES" + ], + "type": "string" + }, + "SoftwareSetUpdateMode": { + "description": "An option to define which software updates to apply.", + "enum": [ + "USE_LATEST", + "USE_DESIRED" + ], + "type": "string" + }, + "SoftwareSetUpdateSchedule": { + "description": "An option to define if software updates should be applied within a maintenance window.", + "enum": [ + "USE_MAINTENANCE_WINDOW", + "APPLY_IMMEDIATELY" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "The timestamp in unix epoch format when environment was last updated.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ActivationCode", + "/properties/Arn", + "/properties/CreatedAt", + "/properties/DesktopType", + "/properties/RegisteredDevicesCount", + "/properties/UpdatedAt", + "/properties/PendingSoftwareSetId", + "/properties/PendingSoftwareSetVersion", + "/properties/SoftwareSetComplianceStatus" + ], + "required": [ + "DesktopArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesThinClient::Environment" +} diff --git a/schema/aws-workspacesweb-browsersettings.json b/schema/aws-workspacesweb-browsersettings.json index 26a6839..ff1fff7 100644 --- a/schema/aws-workspacesweb-browsersettings.json +++ b/schema/aws-workspacesweb-browsersettings.json @@ -1,155 +1,155 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ], - "definitions": { - "EncryptionContextMap": { - "additionalProperties": false, - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::BrowserSettings Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateBrowserSettings", - "workspaces-web:GetBrowserSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetBrowserSettings", - "workspaces-web:DeleteBrowserSettings", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListBrowserSettings" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetBrowserSettings", - "workspaces-web:ListBrowserSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateBrowserSettings", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetBrowserSettings", - "workspaces-web:ListBrowserSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/BrowserSettingsArn" - ], - "properties": { - "AdditionalEncryptionContext": { - "$ref": "#/definitions/EncryptionContextMap" - }, - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "BrowserPolicy": { - "maxLength": 131072, - "minLength": 2, - "pattern": "\\{[\\S\\s]*\\}\\s*", - "type": "string" - }, - "BrowserSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "CustomerManagedKey": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/BrowserSettingsArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::BrowserSettings" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdditionalEncryptionContext", + "/properties/CustomerManagedKey" + ], + "definitions": { + "EncryptionContextMap": { + "additionalProperties": false, + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::BrowserSettings Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateBrowserSettings", + "workspaces-web:GetBrowserSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetBrowserSettings", + "workspaces-web:DeleteBrowserSettings", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListBrowserSettings" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetBrowserSettings", + "workspaces-web:ListBrowserSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateBrowserSettings", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetBrowserSettings", + "workspaces-web:ListBrowserSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/BrowserSettingsArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap" + }, + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "BrowserPolicy": { + "maxLength": 131072, + "minLength": 2, + "pattern": "\\{[\\S\\s]*\\}\\s*", + "type": "string" + }, + "BrowserSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "CustomerManagedKey": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/BrowserSettingsArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::BrowserSettings" +} diff --git a/schema/aws-workspacesweb-identityprovider.json b/schema/aws-workspacesweb-identityprovider.json index 5435466..9528e25 100644 --- a/schema/aws-workspacesweb-identityprovider.json +++ b/schema/aws-workspacesweb-identityprovider.json @@ -1,128 +1,128 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PortalArn" - ], - "definitions": { - "IdentityProviderDetails": { - "additionalProperties": false, - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "type": "object" - }, - "IdentityProviderType": { - "enum": [ - "SAML", - "Facebook", - "Google", - "LoginWithAmazon", - "SignInWithApple", - "OIDC" - ], - "type": "string" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateIdentityProvider", - "workspaces-web:GetIdentityProvider", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetIdentityProvider", - "workspaces-web:DeleteIdentityProvider" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "PortalArn": { - "$ref": "resource-schema.json#/properties/PortalArn" - } - }, - "required": [ - "PortalArn" - ] - }, - "permissions": [ - "workspaces-web:ListIdentityProviders" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetIdentityProvider", - "workspaces-web:ListIdentityProviders", - "workspaces-web:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateIdentityProvider", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetIdentityProvider", - "workspaces-web:ListIdentityProviders", - "workspaces-web:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/IdentityProviderArn" - ], - "properties": { - "IdentityProviderArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36}){2,}$", - "type": "string" - }, - "IdentityProviderDetails": { - "$ref": "#/definitions/IdentityProviderDetails" - }, - "IdentityProviderName": { - "maxLength": 32, - "minLength": 1, - "pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$", - "type": "string" - }, - "IdentityProviderType": { - "$ref": "#/definitions/IdentityProviderType" - }, - "PortalArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/IdentityProviderArn" - ], - "required": [ - "IdentityProviderDetails", - "IdentityProviderName", - "IdentityProviderType" - ], - "sourceUrl": "https://github.com/shivankgoel/aws-cloudformation-resource-providers-workspaces-web", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::WorkSpacesWeb::IdentityProvider", - "writeOnlyProperties": [ - "/properties/PortalArn" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PortalArn" + ], + "definitions": { + "IdentityProviderDetails": { + "additionalProperties": false, + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "type": "object" + }, + "IdentityProviderType": { + "enum": [ + "SAML", + "Facebook", + "Google", + "LoginWithAmazon", + "SignInWithApple", + "OIDC" + ], + "type": "string" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateIdentityProvider", + "workspaces-web:GetIdentityProvider", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetIdentityProvider", + "workspaces-web:DeleteIdentityProvider" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "PortalArn": { + "$ref": "resource-schema.json#/properties/PortalArn" + } + }, + "required": [ + "PortalArn" + ] + }, + "permissions": [ + "workspaces-web:ListIdentityProviders" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetIdentityProvider", + "workspaces-web:ListIdentityProviders", + "workspaces-web:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateIdentityProvider", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetIdentityProvider", + "workspaces-web:ListIdentityProviders", + "workspaces-web:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdentityProviderArn" + ], + "properties": { + "IdentityProviderArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36}){2,}$", + "type": "string" + }, + "IdentityProviderDetails": { + "$ref": "#/definitions/IdentityProviderDetails" + }, + "IdentityProviderName": { + "maxLength": 32, + "minLength": 1, + "pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$", + "type": "string" + }, + "IdentityProviderType": { + "$ref": "#/definitions/IdentityProviderType" + }, + "PortalArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdentityProviderArn" + ], + "required": [ + "IdentityProviderDetails", + "IdentityProviderName", + "IdentityProviderType" + ], + "sourceUrl": "https://github.com/shivankgoel/aws-cloudformation-resource-providers-workspaces-web", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::WorkSpacesWeb::IdentityProvider", + "writeOnlyProperties": [ + "/properties/PortalArn" + ] +} diff --git a/schema/aws-workspacesweb-ipaccesssettings.json b/schema/aws-workspacesweb-ipaccesssettings.json index 6073f98..cb4d1f7 100644 --- a/schema/aws-workspacesweb-ipaccesssettings.json +++ b/schema/aws-workspacesweb-ipaccesssettings.json @@ -1,200 +1,200 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ], - "definitions": { - "EncryptionContextMap": { - "additionalProperties": false, - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "type": "object" - }, - "IpRule": { - "additionalProperties": false, - "properties": { - "Description": { - "maxLength": 256, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "IpRange": { - "description": "A single IP address or an IP address range in CIDR notation", - "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(?:/([0-9]|[12][0-9]|3[0-2])|)$", - "type": "string" - } - }, - "required": [ - "IpRange" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateIpAccessSettings", - "workspaces-web:GetIpAccessSettings", - "workspaces-web:ListIpAccessSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetIpAccessSettings", - "workspaces-web:ListIpAccessSettings", - "workspaces-web:DeleteIpAccessSettings", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListIpAccessSettings" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetIpAccessSettings", - "workspaces-web:ListIpAccessSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateIpAccessSettings", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetIpAccessSettings", - "workspaces-web:ListIpAccessSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/IpAccessSettingsArn" - ], - "properties": { - "AdditionalEncryptionContext": { - "$ref": "#/definitions/EncryptionContextMap" - }, - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "CreationDate": { - "format": "date-time", - "type": "string" - }, - "CustomerManagedKey": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "Description": { - "maxLength": 256, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "DisplayName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "IpAccessSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "IpRules": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/IpRule" - }, - "maxItems": 100, - "minItems": 1, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/CreationDate", - "/properties/IpAccessSettingsArn" - ], - "required": [ - "IpRules" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::IpAccessSettings" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdditionalEncryptionContext", + "/properties/CustomerManagedKey" + ], + "definitions": { + "EncryptionContextMap": { + "additionalProperties": false, + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "type": "object" + }, + "IpRule": { + "additionalProperties": false, + "properties": { + "Description": { + "maxLength": 256, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "IpRange": { + "description": "A single IP address or an IP address range in CIDR notation", + "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(?:/([0-9]|[12][0-9]|3[0-2])|)$", + "type": "string" + } + }, + "required": [ + "IpRange" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateIpAccessSettings", + "workspaces-web:GetIpAccessSettings", + "workspaces-web:ListIpAccessSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetIpAccessSettings", + "workspaces-web:ListIpAccessSettings", + "workspaces-web:DeleteIpAccessSettings", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListIpAccessSettings" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetIpAccessSettings", + "workspaces-web:ListIpAccessSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateIpAccessSettings", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetIpAccessSettings", + "workspaces-web:ListIpAccessSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/IpAccessSettingsArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap" + }, + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "CreationDate": { + "format": "date-time", + "type": "string" + }, + "CustomerManagedKey": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Description": { + "maxLength": 256, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "DisplayName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "IpAccessSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "IpRules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IpRule" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/CreationDate", + "/properties/IpAccessSettingsArn" + ], + "required": [ + "IpRules" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::IpAccessSettings" +} diff --git a/schema/aws-workspacesweb-networksettings.json b/schema/aws-workspacesweb-networksettings.json index 950f6ea..28897de 100644 --- a/schema/aws-workspacesweb-networksettings.json +++ b/schema/aws-workspacesweb-networksettings.json @@ -1,142 +1,142 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::NetworkSettings Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateNetworkSettings", - "workspaces-web:GetNetworkSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetNetworkSettings", - "workspaces-web:DeleteNetworkSettings" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListNetworkSettings" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetNetworkSettings", - "workspaces-web:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateNetworkSettings", - "workspaces-web:UpdateResource", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetNetworkSettings", - "workspaces-web:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/NetworkSettingsArn" - ], - "properties": { - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "NetworkSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "maxLength": 128, - "minLength": 1, - "pattern": "^[\\w+\\-]+$", - "type": "string" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "maxLength": 32, - "minLength": 1, - "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", - "type": "string" - }, - "maxItems": 3, - "minItems": 2, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "VpcId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^vpc-[0-9a-z]*$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/NetworkSettingsArn" - ], - "required": [ - "SecurityGroupIds", - "SubnetIds", - "VpcId" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::NetworkSettings" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::NetworkSettings Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateNetworkSettings", + "workspaces-web:GetNetworkSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetNetworkSettings", + "workspaces-web:DeleteNetworkSettings" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListNetworkSettings" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetNetworkSettings", + "workspaces-web:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateNetworkSettings", + "workspaces-web:UpdateResource", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetNetworkSettings", + "workspaces-web:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/NetworkSettingsArn" + ], + "properties": { + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "NetworkSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w+\\-]+$", + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "maxLength": 32, + "minLength": 1, + "pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$", + "type": "string" + }, + "maxItems": 3, + "minItems": 2, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "VpcId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^vpc-[0-9a-z]*$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/NetworkSettingsArn" + ], + "required": [ + "SecurityGroupIds", + "SubnetIds", + "VpcId" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::NetworkSettings" +} diff --git a/schema/aws-workspacesweb-portal.json b/schema/aws-workspacesweb-portal.json index 7e50d3f..e29c7a6 100644 --- a/schema/aws-workspacesweb-portal.json +++ b/schema/aws-workspacesweb-portal.json @@ -1,312 +1,312 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ], - "definitions": { - "AuthenticationType": { - "enum": [ - "Standard", - "IAM_Identity_Center" - ], - "type": "string" - }, - "BrowserType": { - "enum": [ - "Chrome" - ], - "type": "string" - }, - "EncryptionContextMap": { - "additionalProperties": false, - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "type": "object" - }, - "InstanceType": { - "enum": [ - "standard.regular", - "standard.large", - "standard.xlarge" - ], - "type": "string" - }, - "PortalStatus": { - "enum": [ - "Incomplete", - "Pending", - "Active" - ], - "type": "string" - }, - "RendererType": { - "enum": [ - "AppStream" - ], - "type": "string" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::Portal Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreatePortal", - "workspaces-web:GetPortal", - "workspaces-web:GetPortalServiceProviderMetadata", - "workspaces-web:AssociateBrowserSettings", - "workspaces-web:AssociateIpAccessSettings", - "workspaces-web:AssociateNetworkSettings", - "workspaces-web:AssociateTrustStore", - "workspaces-web:AssociateUserAccessLoggingSettings", - "workspaces-web:AssociateUserSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource", - "kms:CreateGrant", - "kms:GenerateDataKey", - "kms:Decrypt", - "kms:DescribeKey", - "ec2:CreateNetworkInterface", - "ec2:CreateNetworkInterfacePermission", - "ec2:DeleteNetworkInterface", - "ec2:DeleteNetworkInterfacePermission", - "ec2:ModifyNetworkInterfaceAttribute", - "kinesis:PutRecord", - "kinesis:PutRecords", - "kinesis:DescribeStreamSummary", - "sso:CreateManagedApplicationInstance", - "sso:DescribeRegisteredRegions" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetPortal", - "workspaces-web:DeletePortal", - "workspaces-web:DisassociateBrowserSettings", - "workspaces-web:DisassociateIpAccessSettings", - "workspaces-web:DisassociateNetworkSettings", - "workspaces-web:DisassociateTrustStore", - "workspaces-web:DisassociateUserAccessLoggingSettings", - "workspaces-web:DisassociateUserSettings", - "kms:Decrypt", - "kms:DescribeKey", - "sso:DeleteManagedApplicationInstance" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListPortals", - "kms:Decrypt", - "kms:DescribeKey" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetPortal", - "workspaces-web:GetPortalServiceProviderMetadata", - "workspaces-web:ListTagsForResource", - "kms:Decrypt", - "kms:DescribeKey" - ] - }, - "update": { - "permissions": [ - "workspaces-web:GetPortal", - "workspaces-web:GetPortalServiceProviderMetadata", - "workspaces-web:UpdatePortal", - "workspaces-web:AssociateBrowserSettings", - "workspaces-web:AssociateIpAccessSettings", - "workspaces-web:AssociateNetworkSettings", - "workspaces-web:AssociateTrustStore", - "workspaces-web:AssociateUserAccessLoggingSettings", - "workspaces-web:AssociateUserSettings", - "workspaces-web:DisassociateBrowserSettings", - "workspaces-web:DisassociateIpAccessSettings", - "workspaces-web:DisassociateNetworkSettings", - "workspaces-web:DisassociateTrustStore", - "workspaces-web:DisassociateUserAccessLoggingSettings", - "workspaces-web:DisassociateUserSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "kms:CreateGrant", - "kms:Encrypt", - "kms:GenerateDataKey", - "kms:Decrypt", - "kms:DescribeKey", - "ec2:CreateNetworkInterface", - "ec2:CreateNetworkInterfacePermission", - "ec2:DeleteNetworkInterface", - "ec2:DeleteNetworkInterfacePermission", - "ec2:ModifyNetworkInterfaceAttribute", - "kinesis:PutRecord", - "kinesis:PutRecords", - "kinesis:DescribeStreamSummary", - "sso:CreateManagedApplicationInstance", - "sso:DeleteManagedApplicationInstance", - "sso:DescribeRegisteredRegions", - "sso:GetApplicationInstance", - "sso:ListApplicationInstances" - ] - } - }, - "primaryIdentifier": [ - "/properties/PortalArn" - ], - "properties": { - "AdditionalEncryptionContext": { - "$ref": "#/definitions/EncryptionContextMap" - }, - "AuthenticationType": { - "$ref": "#/definitions/AuthenticationType" - }, - "BrowserSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "BrowserType": { - "$ref": "#/definitions/BrowserType" - }, - "CreationDate": { - "format": "date-time", - "type": "string" - }, - "CustomerManagedKey": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "DisplayName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^.+$", - "type": "string" - }, - "InstanceType": { - "$ref": "#/definitions/InstanceType" - }, - "IpAccessSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "MaxConcurrentSessions": { - "maximum": 5000, - "minimum": 1, - "type": "number" - }, - "NetworkSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "PortalArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "PortalEndpoint": { - "maxLength": 253, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$", - "type": "string" - }, - "PortalStatus": { - "$ref": "#/definitions/PortalStatus" - }, - "RendererType": { - "$ref": "#/definitions/RendererType" - }, - "ServiceProviderSamlMetadata": { - "maxLength": 204800, - "minLength": 0, - "pattern": "^.*$", - "type": "string" - }, - "StatusReason": { - "maxLength": 1024, - "minLength": 1, - "pattern": ".*", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrustStoreArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "UserAccessLoggingSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "UserSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/BrowserType", - "/properties/CreationDate", - "/properties/PortalArn", - "/properties/PortalEndpoint", - "/properties/PortalStatus", - "/properties/RendererType", - "/properties/ServiceProviderSamlMetadata", - "/properties/StatusReason" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::Portal" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdditionalEncryptionContext", + "/properties/CustomerManagedKey" + ], + "definitions": { + "AuthenticationType": { + "enum": [ + "Standard", + "IAM_Identity_Center" + ], + "type": "string" + }, + "BrowserType": { + "enum": [ + "Chrome" + ], + "type": "string" + }, + "EncryptionContextMap": { + "additionalProperties": false, + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "type": "object" + }, + "InstanceType": { + "enum": [ + "standard.regular", + "standard.large", + "standard.xlarge" + ], + "type": "string" + }, + "PortalStatus": { + "enum": [ + "Incomplete", + "Pending", + "Active" + ], + "type": "string" + }, + "RendererType": { + "enum": [ + "AppStream" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::Portal Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreatePortal", + "workspaces-web:GetPortal", + "workspaces-web:GetPortalServiceProviderMetadata", + "workspaces-web:AssociateBrowserSettings", + "workspaces-web:AssociateIpAccessSettings", + "workspaces-web:AssociateNetworkSettings", + "workspaces-web:AssociateTrustStore", + "workspaces-web:AssociateUserAccessLoggingSettings", + "workspaces-web:AssociateUserSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "kms:DescribeKey", + "ec2:CreateNetworkInterface", + "ec2:CreateNetworkInterfacePermission", + "ec2:DeleteNetworkInterface", + "ec2:DeleteNetworkInterfacePermission", + "ec2:ModifyNetworkInterfaceAttribute", + "kinesis:PutRecord", + "kinesis:PutRecords", + "kinesis:DescribeStreamSummary", + "sso:CreateManagedApplicationInstance", + "sso:DescribeRegisteredRegions" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetPortal", + "workspaces-web:DeletePortal", + "workspaces-web:DisassociateBrowserSettings", + "workspaces-web:DisassociateIpAccessSettings", + "workspaces-web:DisassociateNetworkSettings", + "workspaces-web:DisassociateTrustStore", + "workspaces-web:DisassociateUserAccessLoggingSettings", + "workspaces-web:DisassociateUserSettings", + "kms:Decrypt", + "kms:DescribeKey", + "sso:DeleteManagedApplicationInstance" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListPortals", + "kms:Decrypt", + "kms:DescribeKey" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetPortal", + "workspaces-web:GetPortalServiceProviderMetadata", + "workspaces-web:ListTagsForResource", + "kms:Decrypt", + "kms:DescribeKey" + ] + }, + "update": { + "permissions": [ + "workspaces-web:GetPortal", + "workspaces-web:GetPortalServiceProviderMetadata", + "workspaces-web:UpdatePortal", + "workspaces-web:AssociateBrowserSettings", + "workspaces-web:AssociateIpAccessSettings", + "workspaces-web:AssociateNetworkSettings", + "workspaces-web:AssociateTrustStore", + "workspaces-web:AssociateUserAccessLoggingSettings", + "workspaces-web:AssociateUserSettings", + "workspaces-web:DisassociateBrowserSettings", + "workspaces-web:DisassociateIpAccessSettings", + "workspaces-web:DisassociateNetworkSettings", + "workspaces-web:DisassociateTrustStore", + "workspaces-web:DisassociateUserAccessLoggingSettings", + "workspaces-web:DisassociateUserSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "kms:CreateGrant", + "kms:Encrypt", + "kms:GenerateDataKey", + "kms:Decrypt", + "kms:DescribeKey", + "ec2:CreateNetworkInterface", + "ec2:CreateNetworkInterfacePermission", + "ec2:DeleteNetworkInterface", + "ec2:DeleteNetworkInterfacePermission", + "ec2:ModifyNetworkInterfaceAttribute", + "kinesis:PutRecord", + "kinesis:PutRecords", + "kinesis:DescribeStreamSummary", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:DescribeRegisteredRegions", + "sso:GetApplicationInstance", + "sso:ListApplicationInstances" + ] + } + }, + "primaryIdentifier": [ + "/properties/PortalArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap" + }, + "AuthenticationType": { + "$ref": "#/definitions/AuthenticationType" + }, + "BrowserSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "BrowserType": { + "$ref": "#/definitions/BrowserType" + }, + "CreationDate": { + "format": "date-time", + "type": "string" + }, + "CustomerManagedKey": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "DisplayName": { + "maxLength": 64, + "minLength": 1, + "pattern": "^.+$", + "type": "string" + }, + "InstanceType": { + "$ref": "#/definitions/InstanceType" + }, + "IpAccessSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "MaxConcurrentSessions": { + "maximum": 5000, + "minimum": 1, + "type": "number" + }, + "NetworkSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "PortalArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "PortalEndpoint": { + "maxLength": 253, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$", + "type": "string" + }, + "PortalStatus": { + "$ref": "#/definitions/PortalStatus" + }, + "RendererType": { + "$ref": "#/definitions/RendererType" + }, + "ServiceProviderSamlMetadata": { + "maxLength": 204800, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + }, + "StatusReason": { + "maxLength": 1024, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrustStoreArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "UserAccessLoggingSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "UserSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BrowserType", + "/properties/CreationDate", + "/properties/PortalArn", + "/properties/PortalEndpoint", + "/properties/PortalStatus", + "/properties/RendererType", + "/properties/ServiceProviderSamlMetadata", + "/properties/StatusReason" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::Portal" +} diff --git a/schema/aws-workspacesweb-truststore.json b/schema/aws-workspacesweb-truststore.json index 66068e6..7d6c138 100644 --- a/schema/aws-workspacesweb-truststore.json +++ b/schema/aws-workspacesweb-truststore.json @@ -1,124 +1,124 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::TrustStore Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateTrustStore", - "workspaces-web:GetTrustStore", - "workspaces-web:GetTrustStoreCertificate", - "workspaces-web:ListTrustStoreCertificates", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetTrustStore", - "workspaces-web:GetTrustStoreCertificate", - "workspaces-web:DeleteTrustStore" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListTrustStores", - "workspaces-web:ListTrustStoreCertificates" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetTrustStore", - "workspaces-web:GetTrustStoreCertificate", - "workspaces-web:ListTagsForResource", - "workspaces-web:ListTrustStoreCertificates" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateTrustStore", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetTrustStore", - "workspaces-web:GetTrustStoreCertificate", - "workspaces-web:ListTagsForResource", - "workspaces-web:ListTrustStoreCertificates" - ] - } - }, - "primaryIdentifier": [ - "/properties/TrustStoreArn" - ], - "properties": { - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "CertificateList": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "TrustStoreArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/TrustStoreArn" - ], - "required": [ - "CertificateList" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::TrustStore" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::TrustStore Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateTrustStore", + "workspaces-web:GetTrustStore", + "workspaces-web:GetTrustStoreCertificate", + "workspaces-web:ListTrustStoreCertificates", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetTrustStore", + "workspaces-web:GetTrustStoreCertificate", + "workspaces-web:DeleteTrustStore" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListTrustStores", + "workspaces-web:ListTrustStoreCertificates" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetTrustStore", + "workspaces-web:GetTrustStoreCertificate", + "workspaces-web:ListTagsForResource", + "workspaces-web:ListTrustStoreCertificates" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateTrustStore", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetTrustStore", + "workspaces-web:GetTrustStoreCertificate", + "workspaces-web:ListTagsForResource", + "workspaces-web:ListTrustStoreCertificates" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrustStoreArn" + ], + "properties": { + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "CertificateList": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TrustStoreArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/TrustStoreArn" + ], + "required": [ + "CertificateList" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::TrustStore" +} diff --git a/schema/aws-workspacesweb-useraccessloggingsettings.json b/schema/aws-workspacesweb-useraccessloggingsettings.json index d7bdf5c..eb71a18 100644 --- a/schema/aws-workspacesweb-useraccessloggingsettings.json +++ b/schema/aws-workspacesweb-useraccessloggingsettings.json @@ -1,118 +1,118 @@ -{ - "additionalProperties": false, - "definitions": { - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateUserAccessLoggingSettings", - "workspaces-web:GetUserAccessLoggingSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetUserAccessLoggingSettings", - "workspaces-web:DeleteUserAccessLoggingSettings" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListUserAccessLoggingSettings" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetUserAccessLoggingSettings", - "workspaces-web:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateUserAccessLoggingSettings", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetUserAccessLoggingSettings", - "workspaces-web:ListTagsForResource", - "kinesis:PutRecord", - "kinesis:PutRecords" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserAccessLoggingSettingsArn" - ], - "properties": { - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "KinesisStreamArn": { - "description": "Kinesis stream ARN to which log events are published.", - "maxLength": 2048, - "minLength": 20, - "pattern": "arn:[\\w+=/,.@-]+:kinesis:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:stream/.+", - "type": "string" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "UserAccessLoggingSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/UserAccessLoggingSettingsArn" - ], - "required": [ - "KinesisStreamArn" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" -} +{ + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateUserAccessLoggingSettings", + "workspaces-web:GetUserAccessLoggingSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetUserAccessLoggingSettings", + "workspaces-web:DeleteUserAccessLoggingSettings" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListUserAccessLoggingSettings" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetUserAccessLoggingSettings", + "workspaces-web:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateUserAccessLoggingSettings", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetUserAccessLoggingSettings", + "workspaces-web:ListTagsForResource", + "kinesis:PutRecord", + "kinesis:PutRecords" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserAccessLoggingSettingsArn" + ], + "properties": { + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "KinesisStreamArn": { + "description": "Kinesis stream ARN to which log events are published.", + "maxLength": 2048, + "minLength": 20, + "pattern": "arn:[\\w+=/,.@-]+:kinesis:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:stream/.+", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "UserAccessLoggingSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/UserAccessLoggingSettingsArn" + ], + "required": [ + "KinesisStreamArn" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" +} diff --git a/schema/aws-workspacesweb-usersettings.json b/schema/aws-workspacesweb-usersettings.json index 9d4be49..5bf08ed 100644 --- a/schema/aws-workspacesweb-usersettings.json +++ b/schema/aws-workspacesweb-usersettings.json @@ -1,251 +1,251 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ], - "definitions": { - "CookieSpecification": { - "additionalProperties": false, - "properties": { - "Domain": { - "maxLength": 253, - "minLength": 0, - "pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", - "type": "string" - }, - "Name": { - "maxLength": 4096, - "minLength": 0, - "type": "string" - }, - "Path": { - "maxLength": 2000, - "minLength": 0, - "pattern": "^/(\\S)*$", - "type": "string" - } - }, - "required": [ - "Domain" - ], - "type": "object" - }, - "CookieSynchronizationConfiguration": { - "additionalProperties": false, - "properties": { - "Allowlist": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CookieSpecification" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - }, - "Blocklist": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/CookieSpecification" - }, - "maxItems": 10, - "minItems": 0, - "type": "array" - } - }, - "required": [ - "Allowlist" - ], - "type": "object" - }, - "EnabledType": { - "enum": [ - "Disabled", - "Enabled" - ], - "type": "string" - }, - "EncryptionContextMap": { - "additionalProperties": false, - "patternProperties": { - "^[\\s\\S]*$": { - "maxLength": 131072, - "minLength": 0, - "pattern": "^[\\s\\S]*$", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "maxLength": 128, - "minLength": 1, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - }, - "Value": { - "maxLength": 256, - "minLength": 0, - "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "description": "Definition of AWS::WorkSpacesWeb::UserSettings Resource Type", - "handlers": { - "create": { - "permissions": [ - "workspaces-web:CreateUserSettings", - "workspaces-web:GetUserSettings", - "workspaces-web:ListTagsForResource", - "workspaces-web:TagResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "delete": { - "permissions": [ - "workspaces-web:GetUserSettings", - "workspaces-web:DeleteUserSettings", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "list": { - "permissions": [ - "workspaces-web:ListUserSettings", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "read": { - "permissions": [ - "workspaces-web:GetUserSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - }, - "update": { - "permissions": [ - "workspaces-web:UpdateUserSettings", - "workspaces-web:TagResource", - "workspaces-web:UntagResource", - "workspaces-web:GetUserSettings", - "workspaces-web:ListTagsForResource", - "kms:CreateGrant", - "kms:DescribeKey", - "kms:GenerateDataKey", - "kms:Decrypt" - ] - } - }, - "primaryIdentifier": [ - "/properties/UserSettingsArn" - ], - "properties": { - "AdditionalEncryptionContext": { - "$ref": "#/definitions/EncryptionContextMap" - }, - "AssociatedPortalArns": { - "insertionOrder": false, - "items": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - }, - "type": "array" - }, - "CookieSynchronizationConfiguration": { - "$ref": "#/definitions/CookieSynchronizationConfiguration" - }, - "CopyAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "CustomerManagedKey": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", - "type": "string" - }, - "DeepLinkAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "DisconnectTimeoutInMinutes": { - "default": null, - "maximum": 600, - "minimum": 1, - "type": "number" - }, - "DownloadAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "IdleDisconnectTimeoutInMinutes": { - "default": null, - "maximum": 60, - "minimum": 0, - "type": "number" - }, - "PasteAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "PrintAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 0, - "type": "array" - }, - "UploadAllowed": { - "$ref": "#/definitions/EnabledType" - }, - "UserSettingsArn": { - "maxLength": 2048, - "minLength": 20, - "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/AssociatedPortalArns", - "/properties/UserSettingsArn" - ], - "required": [ - "CopyAllowed", - "DownloadAllowed", - "PasteAllowed", - "PrintAllowed", - "UploadAllowed" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::WorkSpacesWeb::UserSettings" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AdditionalEncryptionContext", + "/properties/CustomerManagedKey" + ], + "definitions": { + "CookieSpecification": { + "additionalProperties": false, + "properties": { + "Domain": { + "maxLength": 253, + "minLength": 0, + "pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", + "type": "string" + }, + "Name": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "Path": { + "maxLength": 2000, + "minLength": 0, + "pattern": "^/(\\S)*$", + "type": "string" + } + }, + "required": [ + "Domain" + ], + "type": "object" + }, + "CookieSynchronizationConfiguration": { + "additionalProperties": false, + "properties": { + "Allowlist": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CookieSpecification" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Blocklist": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CookieSpecification" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "Allowlist" + ], + "type": "object" + }, + "EnabledType": { + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string" + }, + "EncryptionContextMap": { + "additionalProperties": false, + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::WorkSpacesWeb::UserSettings Resource Type", + "handlers": { + "create": { + "permissions": [ + "workspaces-web:CreateUserSettings", + "workspaces-web:GetUserSettings", + "workspaces-web:ListTagsForResource", + "workspaces-web:TagResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "delete": { + "permissions": [ + "workspaces-web:GetUserSettings", + "workspaces-web:DeleteUserSettings", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "list": { + "permissions": [ + "workspaces-web:ListUserSettings", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "read": { + "permissions": [ + "workspaces-web:GetUserSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "workspaces-web:UpdateUserSettings", + "workspaces-web:TagResource", + "workspaces-web:UntagResource", + "workspaces-web:GetUserSettings", + "workspaces-web:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/UserSettingsArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap" + }, + "AssociatedPortalArns": { + "insertionOrder": false, + "items": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + }, + "type": "array" + }, + "CookieSynchronizationConfiguration": { + "$ref": "#/definitions/CookieSynchronizationConfiguration" + }, + "CopyAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "CustomerManagedKey": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$", + "type": "string" + }, + "DeepLinkAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "DisconnectTimeoutInMinutes": { + "default": null, + "maximum": 600, + "minimum": 1, + "type": "number" + }, + "DownloadAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "IdleDisconnectTimeoutInMinutes": { + "default": null, + "maximum": 60, + "minimum": 0, + "type": "number" + }, + "PasteAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "PrintAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "UploadAllowed": { + "$ref": "#/definitions/EnabledType" + }, + "UserSettingsArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociatedPortalArns", + "/properties/UserSettingsArn" + ], + "required": [ + "CopyAllowed", + "DownloadAllowed", + "PasteAllowed", + "PrintAllowed", + "UploadAllowed" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::WorkSpacesWeb::UserSettings" +} diff --git a/schema/aws-xray-group.json b/schema/aws-xray-group.json index 6dcc099..55cccaa 100644 --- a/schema/aws-xray-group.json +++ b/schema/aws-xray-group.json @@ -1,121 +1,125 @@ -{ - "additionalProperties": false, - "definitions": { - "InsightsConfiguration": { - "additionalProperties": false, - "properties": { - "InsightsEnabled": { - "description": "Set the InsightsEnabled value to true to enable insights or false to disable insights.", - "type": "boolean" - }, - "NotificationsEnabled": { - "description": "Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.", - "type": "boolean" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag.", - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "description": "This schema provides construct and validation rules for AWS-XRay Group resource parameters.", - "handlers": { - "create": { - "permissions": [ - "xray:CreateGroup", - "xray:TagResource" - ] - }, - "delete": { - "permissions": [ - "xray:DeleteGroup" - ] - }, - "list": { - "permissions": [ - "xray:GetGroups", - "xray:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "xray:GetGroup", - "xray:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "xray:UpdateGroup", - "xray:TagResource", - "xray:UntagResource", - "xray:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/GroupARN" - ], - "properties": { - "FilterExpression": { - "description": "The filter expression defining criteria by which to group traces.", - "type": "string" - }, - "GroupARN": { - "description": "The ARN of the group that was generated on creation.", - "maxLength": 400, - "minLength": 1, - "type": "string" - }, - "GroupName": { - "description": "The case-sensitive name of the new group. Names must be unique.", - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "InsightsConfiguration": { - "$ref": "#/definitions/InsightsConfiguration" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/GroupARN" - ], - "required": [ - "GroupName" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::XRay::Group" -} +{ + "additionalProperties": false, + "definitions": { + "InsightsConfiguration": { + "additionalProperties": false, + "properties": { + "InsightsEnabled": { + "description": "Set the InsightsEnabled value to true to enable insights or false to disable insights.", + "type": "boolean" + }, + "NotificationsEnabled": { + "description": "Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.", + "type": "boolean" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag.", + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "description": "This schema provides construct and validation rules for AWS-XRay Group resource parameters.", + "handlers": { + "create": { + "permissions": [ + "xray:CreateGroup", + "xray:TagResource" + ] + }, + "delete": { + "permissions": [ + "xray:DeleteGroup" + ] + }, + "list": { + "permissions": [ + "xray:GetGroups", + "xray:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "xray:GetGroup", + "xray:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "xray:UpdateGroup", + "xray:TagResource", + "xray:UntagResource", + "xray:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/GroupARN" + ], + "properties": { + "FilterExpression": { + "description": "The filter expression defining criteria by which to group traces.", + "type": "string" + }, + "GroupARN": { + "description": "The ARN of the group that was generated on creation.", + "maxLength": 400, + "minLength": 1, + "type": "string" + }, + "GroupName": { + "description": "The case-sensitive name of the new group. Names must be unique.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "InsightsConfiguration": { + "$ref": "#/definitions/InsightsConfiguration" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/GroupARN" + ], + "required": [ + "GroupName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "xray:TagResource", + "xray:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::XRay::Group" +} diff --git a/schema/aws-xray-resourcepolicy.json b/schema/aws-xray-resourcepolicy.json index fdeda97..ba81b91 100644 --- a/schema/aws-xray-resourcepolicy.json +++ b/schema/aws-xray-resourcepolicy.json @@ -1,73 +1,73 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/PolicyName" - ], - "description": "This schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.", - "handlers": { - "create": { - "permissions": [ - "xray:PutResourcePolicy", - "xray:ListResourcePolicies" - ] - }, - "delete": { - "permissions": [ - "xray:DeleteResourcePolicy" - ] - }, - "list": { - "permissions": [ - "xray:ListResourcePolicies" - ] - }, - "read": { - "permissions": [ - "xray:ListResourcePolicies" - ] - }, - "update": { - "permissions": [ - "xray:PutResourcePolicy", - "xray:ListResourcePolicies" - ] - } - }, - "primaryIdentifier": [ - "/properties/PolicyName" - ], - "properties": { - "BypassPolicyLockoutCheck": { - "description": "A flag to indicate whether to bypass the resource policy lockout safety check", - "type": "boolean" - }, - "PolicyDocument": { - "description": "The resource policy document, which can be up to 5kb in size.", - "maxLength": 5120, - "minLength": 1, - "type": "string" - }, - "PolicyName": { - "description": "The name of the resource policy. Must be unique within a specific AWS account.", - "maxLength": 128, - "minLength": 1, - "pattern": "[\\w+=,.@-]+", - "type": "string" - } - }, - "required": [ - "PolicyName", - "PolicyDocument" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::XRay::ResourcePolicy", - "writeOnlyProperties": [ - "/properties/BypassPolicyLockoutCheck" - ] -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PolicyName" + ], + "description": "This schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.", + "handlers": { + "create": { + "permissions": [ + "xray:PutResourcePolicy", + "xray:ListResourcePolicies" + ] + }, + "delete": { + "permissions": [ + "xray:DeleteResourcePolicy" + ] + }, + "list": { + "permissions": [ + "xray:ListResourcePolicies" + ] + }, + "read": { + "permissions": [ + "xray:ListResourcePolicies" + ] + }, + "update": { + "permissions": [ + "xray:PutResourcePolicy", + "xray:ListResourcePolicies" + ] + } + }, + "primaryIdentifier": [ + "/properties/PolicyName" + ], + "properties": { + "BypassPolicyLockoutCheck": { + "description": "A flag to indicate whether to bypass the resource policy lockout safety check", + "type": "boolean" + }, + "PolicyDocument": { + "description": "The resource policy document, which can be up to 5kb in size.", + "maxLength": 5120, + "minLength": 1, + "type": "string" + }, + "PolicyName": { + "description": "The name of the resource policy. Must be unique within a specific AWS account.", + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "required": [ + "PolicyName", + "PolicyDocument" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::XRay::ResourcePolicy", + "writeOnlyProperties": [ + "/properties/BypassPolicyLockoutCheck" + ] +} diff --git a/schema/aws-xray-samplingrule.json b/schema/aws-xray-samplingrule.json index 29a9114..e57f332 100644 --- a/schema/aws-xray-samplingrule.json +++ b/schema/aws-xray-samplingrule.json @@ -1,291 +1,295 @@ -{ - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/SamplingRule/Version" - ], - "definitions": { - "RuleARN": { - "description": "The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.", - "type": "string" - }, - "RuleName": { - "description": "The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.", - "maxLength": 32, - "minLength": 1, - "type": "string" - }, - "SamplingRule": { - "additionalProperties": false, - "properties": { - "Attributes": { - "$comment": "String to string map", - "additionalProperties": false, - "description": "Matches attributes derived from the request.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "FixedRate": { - "description": "The percentage of matching requests to instrument, after the reservoir is exhausted.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "HTTPMethod": { - "description": "Matches the HTTP method from a request URL.", - "maxLength": 10, - "type": "string" - }, - "Host": { - "description": "Matches the hostname from a request URL.", - "maxLength": 64, - "type": "string" - }, - "Priority": { - "description": "The priority of the sampling rule.", - "maximum": 9999, - "minimum": 1, - "type": "integer" - }, - "ReservoirSize": { - "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.", - "minimum": 0, - "type": "integer" - }, - "ResourceARN": { - "description": "Matches the ARN of the AWS resource on which the service runs.", - "maxLength": 500, - "type": "string" - }, - "RuleARN": { - "$ref": "#/definitions/RuleARN" - }, - "RuleName": { - "$ref": "#/definitions/RuleName" - }, - "ServiceName": { - "description": "Matches the name that the service uses to identify itself in segments.", - "maxLength": 64, - "type": "string" - }, - "ServiceType": { - "description": "Matches the origin that the service uses to identify its type in segments.", - "maxLength": 64, - "type": "string" - }, - "URLPath": { - "description": "Matches the path from a request URL.", - "maxLength": 128, - "type": "string" - }, - "Version": { - "description": "The version of the sampling rule format (1)", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "FixedRate", - "Host", - "HTTPMethod", - "Priority", - "ReservoirSize", - "ResourceARN", - "ServiceName", - "ServiceType", - "URLPath" - ], - "type": "object" - }, - "SamplingRuleRecord": { - "additionalProperties": false, - "properties": { - "CreatedAt": { - "description": "When the rule was created, in Unix time seconds.", - "type": "string" - }, - "ModifiedAt": { - "description": "When the rule was modified, in Unix time seconds.", - "type": "string" - }, - "SamplingRule": { - "$ref": "#/definitions/SamplingRule" - } - }, - "type": "object" - }, - "SamplingRuleUpdate": { - "additionalProperties": false, - "properties": { - "Attributes": { - "$comment": "String to string map", - "additionalProperties": false, - "description": "Matches attributes derived from the request.", - "patternProperties": { - ".{1,}": { - "type": "string" - } - }, - "type": "object" - }, - "FixedRate": { - "description": "The percentage of matching requests to instrument, after the reservoir is exhausted.", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "HTTPMethod": { - "description": "Matches the HTTP method from a request URL.", - "maxLength": 10, - "type": "string" - }, - "Host": { - "description": "Matches the hostname from a request URL.", - "maxLength": 64, - "type": "string" - }, - "Priority": { - "description": "The priority of the sampling rule.", - "maximum": 9999, - "minimum": 1, - "type": "integer" - }, - "ReservoirSize": { - "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.", - "minimum": 0, - "type": "integer" - }, - "ResourceARN": { - "description": "Matches the ARN of the AWS resource on which the service runs.", - "maxLength": 500, - "type": "string" - }, - "RuleARN": { - "$ref": "#/definitions/RuleARN" - }, - "RuleName": { - "$ref": "#/definitions/RuleName" - }, - "ServiceName": { - "description": "Matches the name that the service uses to identify itself in segments.", - "maxLength": 64, - "type": "string" - }, - "ServiceType": { - "description": "Matches the origin that the service uses to identify its type in segments.", - "maxLength": 64, - "type": "string" - }, - "URLPath": { - "description": "Matches the path from a request URL.", - "maxLength": 128, - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "description": "The key name of the tag.", - "type": "string" - }, - "Value": { - "description": "The value for the tag.", - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Tags": { - "description": "An array of key-value pairs to apply to this resource.", - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "deprecatedProperties": [ - "/properties/RuleName", - "/properties/SamplingRuleRecord", - "/properties/SamplingRuleUpdate" - ], - "description": "This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.", - "handlers": { - "create": { - "permissions": [ - "xray:CreateSamplingRule", - "xray:TagResource" - ] - }, - "delete": { - "permissions": [ - "xray:DeleteSamplingRule" - ] - }, - "list": { - "permissions": [ - "xray:GetSamplingRules", - "xray:ListTagsForResource" - ] - }, - "read": { - "permissions": [ - "xray:GetSamplingRules", - "xray:ListTagsForResource" - ] - }, - "update": { - "permissions": [ - "xray:UpdateSamplingRule", - "xray:TagResource", - "xray:UntagResource", - "xray:ListTagsForResource" - ] - } - }, - "primaryIdentifier": [ - "/properties/RuleARN" - ], - "properties": { - "RuleARN": { - "$ref": "#/definitions/RuleARN" - }, - "RuleName": { - "$ref": "#/definitions/RuleName" - }, - "SamplingRule": { - "$ref": "#/definitions/SamplingRule" - }, - "SamplingRuleRecord": { - "$ref": "#/definitions/SamplingRuleRecord" - }, - "SamplingRuleUpdate": { - "$ref": "#/definitions/SamplingRuleUpdate" - }, - "Tags": { - "$ref": "#/definitions/Tags" - } - }, - "readOnlyProperties": [ - "/properties/RuleARN" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": true, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::XRay::SamplingRule" -} +{ + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SamplingRule/Version" + ], + "definitions": { + "RuleARN": { + "description": "The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.", + "type": "string" + }, + "RuleName": { + "description": "The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "SamplingRule": { + "additionalProperties": false, + "properties": { + "Attributes": { + "$comment": "String to string map", + "additionalProperties": false, + "description": "Matches attributes derived from the request.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "FixedRate": { + "description": "The percentage of matching requests to instrument, after the reservoir is exhausted.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "HTTPMethod": { + "description": "Matches the HTTP method from a request URL.", + "maxLength": 10, + "type": "string" + }, + "Host": { + "description": "Matches the hostname from a request URL.", + "maxLength": 64, + "type": "string" + }, + "Priority": { + "description": "The priority of the sampling rule.", + "maximum": 9999, + "minimum": 1, + "type": "integer" + }, + "ReservoirSize": { + "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.", + "minimum": 0, + "type": "integer" + }, + "ResourceARN": { + "description": "Matches the ARN of the AWS resource on which the service runs.", + "maxLength": 500, + "type": "string" + }, + "RuleARN": { + "$ref": "#/definitions/RuleARN" + }, + "RuleName": { + "$ref": "#/definitions/RuleName" + }, + "ServiceName": { + "description": "Matches the name that the service uses to identify itself in segments.", + "maxLength": 64, + "type": "string" + }, + "ServiceType": { + "description": "Matches the origin that the service uses to identify its type in segments.", + "maxLength": 64, + "type": "string" + }, + "URLPath": { + "description": "Matches the path from a request URL.", + "maxLength": 128, + "type": "string" + }, + "Version": { + "description": "The version of the sampling rule format (1)", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FixedRate", + "Host", + "HTTPMethod", + "Priority", + "ReservoirSize", + "ResourceARN", + "ServiceName", + "ServiceType", + "URLPath" + ], + "type": "object" + }, + "SamplingRuleRecord": { + "additionalProperties": false, + "properties": { + "CreatedAt": { + "description": "When the rule was created, in Unix time seconds.", + "type": "string" + }, + "ModifiedAt": { + "description": "When the rule was modified, in Unix time seconds.", + "type": "string" + }, + "SamplingRule": { + "$ref": "#/definitions/SamplingRule" + } + }, + "type": "object" + }, + "SamplingRuleUpdate": { + "additionalProperties": false, + "properties": { + "Attributes": { + "$comment": "String to string map", + "additionalProperties": false, + "description": "Matches attributes derived from the request.", + "patternProperties": { + ".{1,}": { + "type": "string" + } + }, + "type": "object" + }, + "FixedRate": { + "description": "The percentage of matching requests to instrument, after the reservoir is exhausted.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "HTTPMethod": { + "description": "Matches the HTTP method from a request URL.", + "maxLength": 10, + "type": "string" + }, + "Host": { + "description": "Matches the hostname from a request URL.", + "maxLength": 64, + "type": "string" + }, + "Priority": { + "description": "The priority of the sampling rule.", + "maximum": 9999, + "minimum": 1, + "type": "integer" + }, + "ReservoirSize": { + "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.", + "minimum": 0, + "type": "integer" + }, + "ResourceARN": { + "description": "Matches the ARN of the AWS resource on which the service runs.", + "maxLength": 500, + "type": "string" + }, + "RuleARN": { + "$ref": "#/definitions/RuleARN" + }, + "RuleName": { + "$ref": "#/definitions/RuleName" + }, + "ServiceName": { + "description": "Matches the name that the service uses to identify itself in segments.", + "maxLength": 64, + "type": "string" + }, + "ServiceType": { + "description": "Matches the origin that the service uses to identify its type in segments.", + "maxLength": 64, + "type": "string" + }, + "URLPath": { + "description": "Matches the path from a request URL.", + "maxLength": 128, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag.", + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "deprecatedProperties": [ + "/properties/RuleName", + "/properties/SamplingRuleRecord", + "/properties/SamplingRuleUpdate" + ], + "description": "This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.", + "handlers": { + "create": { + "permissions": [ + "xray:CreateSamplingRule", + "xray:TagResource" + ] + }, + "delete": { + "permissions": [ + "xray:DeleteSamplingRule" + ] + }, + "list": { + "permissions": [ + "xray:GetSamplingRules", + "xray:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "xray:GetSamplingRules", + "xray:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "xray:UpdateSamplingRule", + "xray:TagResource", + "xray:UntagResource", + "xray:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/RuleARN" + ], + "properties": { + "RuleARN": { + "$ref": "#/definitions/RuleARN" + }, + "RuleName": { + "$ref": "#/definitions/RuleName" + }, + "SamplingRule": { + "$ref": "#/definitions/SamplingRule" + }, + "SamplingRuleRecord": { + "$ref": "#/definitions/SamplingRuleRecord" + }, + "SamplingRuleUpdate": { + "$ref": "#/definitions/SamplingRuleUpdate" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/RuleARN" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "xray:TagResource", + "xray:UntagResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::XRay::SamplingRule" +} diff --git a/schema/update.ps1 b/schema/update.ps1 new file mode 100644 index 0000000..7fde07a --- /dev/null +++ b/schema/update.ps1 @@ -0,0 +1,16 @@ +Add-Type -AssemblyName System.IO.Compression.FileSystem +function Unzip +{ + param([string]$zipfile, [string]$outpath) + + [System.IO.Compression.ZipFile]::ExtractToDirectory($zipfile, $outpath) +} + +$root = "./"| Resolve-Path +$filepath = $root.Path + "\CloudformationSchema.zip" +write-host "path $filepath" +ls *.json| foreach {rm $_} + +invoke-webrequest https://schema.cloudformation.us-east-1.amazonaws.com/CloudformationSchema.zip -OutFile $filepath +Unzip $filepath $root +Remove-Item $filepath